feat(google/datastore/v1): onboard a new library #8856
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| **/*.log | ||
| **/node_modules | ||
| /.coverage | ||
| /coverage | ||
| /.nyc_output | ||
| /docs/ | ||
| /out/ | ||
| /build/ | ||
| system-test/secrets.js | ||
| system-test/*key.json | ||
| *.lock | ||
| .DS_Store | ||
| package-lock.json | ||
| __pycache__ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| // Copyright 2026 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
| // ** This file is automatically generated by gapic-generator-typescript. ** | ||
| // ** https://github.com/googleapis/gapic-generator-typescript ** | ||
| // ** All changes to this file may be overwritten. ** | ||
|
|
||
| 'use strict'; | ||
|
|
||
| module.exports = { | ||
| opts: { | ||
| readme: './README.md', | ||
| package: './package.json', | ||
| template: './node_modules/jsdoc-fresh', | ||
| recurse: true, | ||
| verbose: true, | ||
| destination: './docs/' | ||
| }, | ||
| plugins: [ | ||
| 'plugins/markdown', | ||
| 'jsdoc-region-tag' | ||
| ], | ||
| source: { | ||
| excludePattern: '(^|\\/|\\\\)[._]', | ||
| include: [ | ||
| 'build/src', | ||
| 'protos' | ||
| ], | ||
| includePattern: '\\.js$' | ||
| }, | ||
| templates: { | ||
| copyright: 'Copyright 2026 Google LLC', | ||
| includeDate: false, | ||
| sourceFiles: false, | ||
| systemName: '@google-cloud/datastore-api', | ||
| theme: 'lumen', | ||
| default: { | ||
| outputSourceFiles: false | ||
| } | ||
| }, | ||
| markdown: { | ||
| idInHeadings: true | ||
| } | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| { | ||
| "report-dir": "./.coverage", | ||
| "reporter": ["text", "lcov"], | ||
| "exclude": [ | ||
| "**/*-test", | ||
| "**/.coverage", | ||
| "**/apis", | ||
| "**/benchmark", | ||
| "**/conformance", | ||
| "**/docs", | ||
| "**/samples", | ||
| "**/scripts", | ||
| "**/protos", | ||
| "**/test", | ||
| "**/*.d.ts", | ||
| ".jsdoc.js", | ||
| "**/.jsdoc.js", | ||
| "karma.conf.js", | ||
| "webpack-tests.config.js", | ||
| "webpack.config.js" | ||
| ], | ||
| "exclude-after-remap": false, | ||
| "all": true | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| { | ||
| "api_description": "Accesses the schemaless NoSQL database to provide fully managed, robust,\nscalable storage for your application.", | ||
| "api_id": "datastore.googleapis.com", | ||
| "api_shortname": "datastore", | ||
| "client_documentation": "https://cloud.google.com/nodejs/docs/reference/datastore-api/latest", | ||
| "default_version": "v1", | ||
| "distribution_name": "@google-cloud/datastore-api", | ||
| "issue_tracker": "https://issuetracker.google.com/savedsearches/559768", | ||
| "language": "nodejs", | ||
| "library_type": "GAPIC_AUTO", | ||
| "name": "datastore", | ||
| "name_pretty": "Cloud Datastore", | ||
| "product_documentation": "https://cloud.google.com/datastore/docs", | ||
| "release_level": "stable", | ||
| "repo": "googleapis/google-cloud-node" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| [//]: # "This README.md file is auto-generated, all changes to this file will be lost." | ||
| [//]: # "The comments you see below are used to generate those parts of the template in later states." | ||
| <img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/> | ||
|
|
||
| # [Cloud Datastore API: Nodejs Client][homepage] | ||
|
|
||
| [//]: # "releaseLevel" | ||
|
|
||
| [](https://www.npmjs.org/package/@google-cloud/datastore-api) | ||
|
|
||
| Cloud Datastore API client for Node.js | ||
|
|
||
| [//]: # "partials.introduction" | ||
|
|
||
| A comprehensive list of changes in each version may be found in | ||
| [the CHANGELOG][homepage_changelog]. | ||
|
|
||
| * [Cloud Datastore API Nodejs Client API Reference](https://cloud.google.com/nodejs/docs/reference/admin/latest) | ||
|
|
||
|
|
||
| Read more about the client libraries for Cloud APIs, including the older | ||
| Google APIs Client Libraries, in [Client Libraries Explained][explained]. | ||
|
|
||
| [explained]: https://cloud.google.com/apis/docs/client-libraries-explained | ||
|
|
||
| **Table of contents:** | ||
|
|
||
| * [Quickstart](#quickstart) | ||
| * [Before you begin](#before-you-begin) | ||
| * [Installing the client library](#installing-the-client-library) | ||
|
|
||
| * [Versioning](#versioning) | ||
| * [Contributing](#contributing) | ||
| * [License](#license) | ||
|
|
||
| ## Quickstart | ||
| ### Before you begin | ||
|
|
||
| 1. [Select or create a Cloud Platform project][projects]. | ||
| 1. [Enable billing for your project][billing]. | ||
| 1. [Enable the Cloud Datastore API API][enable_api]. | ||
| 1. [Set up authentication][auth] so you can access the | ||
| API from your local workstation. | ||
| ### Installing the client library | ||
|
|
||
| ```bash | ||
| npm install @google-cloud/datastore-api | ||
| ``` | ||
|
|
||
| [//]: # "partials.body" | ||
|
|
||
| ## Samples | ||
|
|
||
| Samples are in the [`samples/`][homepage_samples] directory. Each sample's `README.md` has instructions for running its sample. | ||
|
|
||
| [//]: # "samples" | ||
|
|
||
| ## Supported Node.js Versions | ||
|
|
||
| Our client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#release-schedule). | ||
| Libraries are compatible with all current _active_ and _maintenance_ versions of | ||
| Node.js. | ||
| If you are using an end-of-life version of Node.js, we recommend that you update | ||
| as soon as possible to an actively supported LTS version. | ||
|
|
||
| Google's client libraries support legacy versions of Node.js runtimes on a | ||
| best-efforts basis with the following warnings: | ||
|
|
||
| * Legacy versions are not tested in continuous integration. | ||
| * Some security patches and features cannot be backported. | ||
| * Dependencies cannot be kept up-to-date. | ||
|
|
||
| Client libraries targeting some end-of-life versions of Node.js are available, and | ||
| can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag). | ||
| The dist-tags follow the naming convention `legacy-(version)`. | ||
| For example, `npm install @google-cloud/datastore-api@legacy-8` installs client libraries | ||
| for versions compatible with Node.js 8. | ||
|
|
||
| ## Versioning | ||
|
|
||
| This library follows [Semantic Versioning](http://semver.org/). | ||
|
|
||
| More Information: [Google Cloud Platform Launch Stages][launch_stages] | ||
|
|
||
| [launch_stages]: https://cloud.google.com/terms/launch-stages | ||
|
|
||
| ## Contributing | ||
|
|
||
| Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md). | ||
|
|
||
| Please note that this `README.md` | ||
| and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`) | ||
| are generated from a central template. | ||
|
|
||
| ## License | ||
|
|
||
| Apache Version 2.0 | ||
|
|
||
| See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE) | ||
|
|
||
| [shell_img]: https://gstatic.com/cloudssh/images/open-btn.png | ||
| [projects]: https://console.cloud.google.com/project | ||
| [billing]: https://support.google.com/cloud/answer/6293499#enable-billing | ||
| [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=datastore.googleapis.com | ||
| [auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local | ||
| [homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-datastore-admin/samples | ||
| [homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-datastore-admin/CHANGELOG.md | ||
| [homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-datastore-admin | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| { | ||
| "name": "@google-cloud/datastore-api", | ||
| "version": "0.1.0", | ||
| "description": "Admin client for Node.js", | ||
|
Contributor
There was a problem hiding this comment. The description 'Admin client for Node.js' is misleading for a package that is supposed to onboard the entire Datastore API (including the main 'DatastoreClient'). This is another symptom of the sequential generation overwrite issue, where the second generation run (for 'admin/v1') overwrote the 'package.json' from the first run. Please ensure the generation process merges or correctly sets the package metadata. References
|
||
| "repository": { | ||
| "type": "git", | ||
| "directory": "packages/google-cloud-datastore-api", | ||
| "url": "https://github.com/googleapis/google-cloud-node.git" | ||
| }, | ||
| "license": "Apache-2.0", | ||
| "author": "Google LLC", | ||
| "main": "build/src/index.js", | ||
| "files": [ | ||
| "build/src", | ||
| "build/protos" | ||
| ], | ||
| "keywords": [ | ||
| "google apis client", | ||
| "google api client", | ||
| "google apis", | ||
| "google api", | ||
| "google", | ||
| "google cloud platform", | ||
| "google cloud", | ||
| "cloud", | ||
| "google admin", | ||
| "admin", | ||
| "datastore admin" | ||
| ], | ||
| "scripts": { | ||
| "clean": "gts clean", | ||
| "compile": "tsc -p . && cp -r protos build/ && minifyProtoJson", | ||
| "compile-protos": "compileProtos src", | ||
| "docs": "jsdoc -c .jsdoc.js", | ||
| "fix": "gts fix", | ||
| "lint": "gts check", | ||
| "prepare": "npm run compile-protos && npm run compile", | ||
| "system-test": "c8 mocha --config ../../.mocharc.cjs --no-parallel build/system-test", | ||
| "test": "c8 mocha --config ../../.mocharc.cjs build/test" | ||
| }, | ||
| "dependencies": { | ||
| "google-gax": "^5.1.1-rc.1" | ||
| }, | ||
| "devDependencies": { | ||
| "@types/mocha": "^10.0.10", | ||
| "@types/node": "^22.18.12", | ||
| "@types/sinon": "^20.0.0", | ||
| "c8": "^10.1.3", | ||
| "gapic-tools": "^1.0.3", | ||
| "gts": "^6.0.2", | ||
| "jsdoc": "^4.0.5", | ||
| "jsdoc-fresh": "^5.0.2", | ||
| "jsdoc-region-tag": "^4.0.1", | ||
| "mocha": "^11.7.4", | ||
| "pack-n-play": "^4.2.1", | ||
| "typescript": "5.8.3", | ||
| "sinon": "^20.0.0" | ||
| }, | ||
| "engines": { | ||
| "node": ">=18" | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The generated links at the bottom of the README point to 'packages/google-datastore-admin' instead of 'packages/google-cloud-datastore-api'. This is likely because the generator used the last API path ('google/datastore/admin/v1') to construct these links during the sequential generation. Please ensure the generation orchestrator correctly uses the package directory name 'google-cloud-datastore-api' for these links.
References