-
Notifications
You must be signed in to change notification settings - Fork 689
feat(google/bigtable/v2): onboard a new library #8857
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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__ |
| 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/bigtable-api', | ||
| theme: 'lumen', | ||
| default: { | ||
| outputSourceFiles: false | ||
| } | ||
| }, | ||
| markdown: { | ||
| idInHeadings: true | ||
| } | ||
| }; |
| 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 | ||
| } |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,16 @@ | ||||||
| { | ||||||
| "api_description": "API for reading and writing the contents of Bigtable tables associated with\na Google Cloud project.", | ||||||
| "api_id": "bigtable.googleapis.com", | ||||||
| "api_shortname": "bigtable", | ||||||
| "client_documentation": "https://cloud.google.com/nodejs/docs/reference/bigtable-api/latest", | ||||||
| "default_version": "v2", | ||||||
| "distribution_name": "@google-cloud/bigtable-api", | ||||||
| "issue_tracker": "https://issuetracker.google.com/issues/new?component=187206&template=0", | ||||||
| "language": "nodejs", | ||||||
| "library_type": "GAPIC_AUTO", | ||||||
| "name": "bigtable", | ||||||
| "name_pretty": "Cloud Bigtable", | ||||||
| "product_documentation": "https://cloud.google.com/bigtable/docs", | ||||||
| "release_level": "stable", | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The release level is set to
Suggested change
References
|
||||||
| "repo": "googleapis/google-cloud-node" | ||||||
| } | ||||||
| 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 Bigtable Admin API: Nodejs Client][homepage] | ||
|
|
||
| [//]: # "releaseLevel" | ||
|
|
||
| [](https://www.npmjs.org/package/@google-cloud/bigtable-api) | ||
|
|
||
| Cloud Bigtable Admin API client for Node.js | ||
|
|
||
| [//]: # "partials.introduction" | ||
|
|
||
| A comprehensive list of changes in each version may be found in | ||
| [the CHANGELOG][homepage_changelog]. | ||
|
|
||
| * [Cloud Bigtable Admin API Nodejs Client API Reference](https://cloud.google.com/nodejs/docs/reference/admin/latest) | ||
| * [Cloud Bigtable Admin API Documentation](https://cloud.google.com/bigtable/docs/overview) | ||
|
|
||
| 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 Bigtable Admin 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/bigtable-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/bigtable-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=bigtableadmin.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-bigtable-admin/samples | ||
| [homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-bigtable-admin/CHANGELOG.md | ||
| [homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-bigtable-admin |
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,63 @@ | ||||||||||||
| { | ||||||||||||
| "name": "@google-cloud/bigtable-api", | ||||||||||||
| "version": "0.1.0", | ||||||||||||
| "description": "Admin client for Node.js", | ||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The description of the package is currently set to
Suggested change
|
||||||||||||
| "repository": { | ||||||||||||
| "type": "git", | ||||||||||||
| "directory": "packages/google-cloud-bigtable-api", | ||||||||||||
| "url": "https://github.com/googleapis/google-cloud-node.git" | ||||||||||||
| }, | ||||||||||||
| "license": "Apache-2.0", | ||||||||||||
| "author": "Google LLC", | ||||||||||||
| "main": "build/src/index.js", | ||||||||||||
| "files": [ | ||||||||||||
|
Comment on lines
+12
to
+13
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The package is missing the
Suggested change
|
||||||||||||
| "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", | ||||||||||||
| "bigtable instance admin", | ||||||||||||
| "bigtable table 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" | ||||||||||||
| } | ||||||||||||
| } | ||||||||||||
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 library version in
librarian.yamlis set to1.0.0, which mismatches the initial version0.1.0defined inpackage.json. Please update this to0.1.0to maintain consistency.