Skip to content

Commit e679306

Browse files
quirogasfeywind
andauthored
feat(google/bigtable/v2): onboard a new library (googleapis#8857)
Co-authored-by: feywind <57276408+feywind@users.noreply.github.com>
1 parent d782cdc commit e679306

121 files changed

Lines changed: 238501 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

librarian.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -536,6 +536,16 @@ libraries:
536536
copyright_year: "2026"
537537
nodejs:
538538
default_version: v1
539+
- name: google-cloud-bigtable-api
540+
version: 0.1.0
541+
apis:
542+
- path: google/bigtable/v2
543+
- path: google/bigtable/admin/v2
544+
copyright_year: "2026"
545+
nodejs:
546+
package_name: '@google-cloud/bigtable-api'
547+
metadata_name_override: bigtable-api
548+
name_pretty_override: Bigtable API
539549
- name: google-cloud-bigquery-storage-api
540550
version: 0.1.0
541551
apis:
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
**/*.log
2+
**/node_modules
3+
/.coverage
4+
/coverage
5+
/.nyc_output
6+
/docs/
7+
/out/
8+
/build/
9+
system-test/secrets.js
10+
system-test/*key.json
11+
*.lock
12+
.DS_Store
13+
package-lock.json
14+
__pycache__
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
// Copyright 2026 Google LLC
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// https://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
//
15+
// ** This file is automatically generated by gapic-generator-typescript. **
16+
// ** https://github.com/googleapis/gapic-generator-typescript **
17+
// ** All changes to this file may be overwritten. **
18+
19+
'use strict';
20+
21+
module.exports = {
22+
opts: {
23+
readme: './README.md',
24+
package: './package.json',
25+
template: './node_modules/jsdoc-fresh',
26+
recurse: true,
27+
verbose: true,
28+
destination: './docs/'
29+
},
30+
plugins: [
31+
'plugins/markdown',
32+
'jsdoc-region-tag'
33+
],
34+
source: {
35+
excludePattern: '(^|\\/|\\\\)[._]',
36+
include: [
37+
'build/src',
38+
'protos'
39+
],
40+
includePattern: '\\.js$'
41+
},
42+
templates: {
43+
copyright: 'Copyright 2026 Google LLC',
44+
includeDate: false,
45+
sourceFiles: false,
46+
systemName: '@google-cloud/bigtable-api',
47+
theme: 'lumen',
48+
default: {
49+
outputSourceFiles: false
50+
}
51+
},
52+
markdown: {
53+
idInHeadings: true
54+
}
55+
};
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"report-dir": "./.coverage",
3+
"reporter": ["text", "lcov"],
4+
"exclude": [
5+
"**/*-test",
6+
"**/.coverage",
7+
"**/apis",
8+
"**/benchmark",
9+
"**/conformance",
10+
"**/docs",
11+
"**/samples",
12+
"**/scripts",
13+
"**/protos",
14+
"**/test",
15+
"**/*.d.ts",
16+
".jsdoc.js",
17+
"**/.jsdoc.js",
18+
"karma.conf.js",
19+
"webpack-tests.config.js",
20+
"webpack.config.js"
21+
],
22+
"exclude-after-remap": false,
23+
"all": true
24+
}
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"api_description": "API for reading and writing the contents of Bigtable tables associated with\na Google Cloud project.",
3+
"api_id": "bigtable.googleapis.com",
4+
"api_shortname": "bigtable",
5+
"client_documentation": "https://cloud.google.com/nodejs/docs/reference/bigtable-api/latest",
6+
"default_version": "v2",
7+
"distribution_name": "@google-cloud/bigtable-api",
8+
"issue_tracker": "https://issuetracker.google.com/issues/new?component=187206&template=0",
9+
"language": "nodejs",
10+
"library_type": "GAPIC_AUTO",
11+
"name": "bigtable-api",
12+
"name_pretty": "Bigtable API",
13+
"product_documentation": "https://cloud.google.com/bigtable/docs",
14+
"release_level": "preview",
15+
"repo": "googleapis/google-cloud-node"
16+
}
Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
2+
[//]: # "The comments you see below are used to generate those parts of the template in later states."
3+
<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"/>
4+
5+
# [Cloud Bigtable API: Nodejs Client][homepage]
6+
7+
> [!IMPORTANT]
8+
> **Internal API Client**: This library (`@google-cloud/bigtable-api`) is an auto-generated, lightweight GAPIC layer designed as a dependency for the official handwritten client library. End users should install and import **[@google-cloud/bigtable](https://www.npmjs.com/package/@google-cloud/bigtable)** instead.
9+
10+
[//]: # "releaseLevel"
11+
12+
[![npm version](https://img.shields.io/npm/v/@google-cloud/bigtable-api.svg)](https://www.npmjs.org/package/@google-cloud/bigtable-api)
13+
14+
Cloud Bigtable API client for Node.js
15+
16+
[//]: # "partials.introduction"
17+
18+
A comprehensive list of changes in each version may be found in
19+
[the CHANGELOG][homepage_changelog].
20+
21+
* [Cloud Bigtable API Nodejs Client API Reference](https://cloud.google.com/nodejs/docs/reference/bigtable/latest)
22+
* [Cloud Bigtable API Documentation](https://cloud.google.com/bigtable/docs/overview)
23+
24+
Read more about the client libraries for Cloud APIs, including the older
25+
Google APIs Client Libraries, in [Client Libraries Explained][explained].
26+
27+
[explained]: https://cloud.google.com/apis/docs/client-libraries-explained
28+
29+
**Table of contents:**
30+
31+
* [Quickstart](#quickstart)
32+
* [Before you begin](#before-you-begin)
33+
* [Installing the client library](#installing-the-client-library)
34+
35+
* [Versioning](#versioning)
36+
* [Contributing](#contributing)
37+
* [License](#license)
38+
39+
## Quickstart
40+
### Before you begin
41+
42+
1. [Select or create a Cloud Platform project][projects].
43+
1. [Enable billing for your project][billing].
44+
1. [Enable the Cloud Bigtable API API][enable_api].
45+
1. [Set up authentication][auth] so you can access the
46+
API from your local workstation.
47+
### Installing the client library
48+
49+
```bash
50+
npm install @google-cloud/bigtable-api
51+
```
52+
53+
[//]: # "partials.body"
54+
55+
## Samples
56+
57+
Samples are in the [`samples/`][homepage_samples] directory. Each sample's `README.md` has instructions for running its sample.
58+
59+
[//]: # "samples"
60+
61+
## Supported Node.js Versions
62+
63+
Our client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#release-schedule).
64+
Libraries are compatible with all current _active_ and _maintenance_ versions of
65+
Node.js.
66+
If you are using an end-of-life version of Node.js, we recommend that you update
67+
as soon as possible to an actively supported LTS version.
68+
69+
Google's client libraries support legacy versions of Node.js runtimes on a
70+
best-efforts basis with the following warnings:
71+
72+
* Legacy versions are not tested in continuous integration.
73+
* Some security patches and features cannot be backported.
74+
* Dependencies cannot be kept up-to-date.
75+
76+
Client libraries targeting some end-of-life versions of Node.js are available, and
77+
can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
78+
The dist-tags follow the naming convention `legacy-(version)`.
79+
For example, `npm install @google-cloud/bigtable-api@legacy-8` installs client libraries
80+
for versions compatible with Node.js 8.
81+
82+
## Versioning
83+
84+
This library follows [Semantic Versioning](http://semver.org/).
85+
86+
More Information: [Google Cloud Platform Launch Stages][launch_stages]
87+
88+
[launch_stages]: https://cloud.google.com/terms/launch-stages
89+
90+
## Contributing
91+
92+
Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md).
93+
94+
Please note that this `README.md`
95+
and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
96+
are generated from a central template.
97+
98+
## License
99+
100+
Apache Version 2.0
101+
102+
See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
103+
104+
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
105+
[projects]: https://console.cloud.google.com/project
106+
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
107+
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=bigtable.googleapis.com
108+
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
109+
[homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigtable-api/samples
110+
[homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigtable-api/CHANGELOG.md
111+
[homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-bigtable-api
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
{
2+
"name": "@google-cloud/bigtable-api",
3+
"version": "0.1.0",
4+
"description": "Cloud Bigtable API client for Node.js",
5+
"repository": {
6+
"type": "git",
7+
"directory": "packages/google-cloud-bigtable-api",
8+
"url": "https://github.com/googleapis/google-cloud-node.git"
9+
},
10+
"license": "Apache-2.0",
11+
"homepage": "https://github.com/googleapis/google-cloud-node/tree/main/packages/google-bigtable-admin",
12+
"author": "Google LLC",
13+
"main": "build/src/index.js",
14+
"files": [
15+
"build/src",
16+
"build/protos"
17+
],
18+
"keywords": [
19+
"google apis client",
20+
"google api client",
21+
"google apis",
22+
"google api",
23+
"google",
24+
"google cloud platform",
25+
"google cloud",
26+
"cloud",
27+
"google admin",
28+
"admin",
29+
"bigtable instance admin",
30+
"bigtable table admin"
31+
],
32+
"scripts": {
33+
"clean": "gts clean",
34+
"compile": "tsc -p . && cp -r protos build/ && minifyProtoJson",
35+
"compile-protos": "compileProtos src",
36+
"docs": "jsdoc -c .jsdoc.js",
37+
"fix": "gts fix",
38+
"lint": "gts check",
39+
"prepare": "npm run compile-protos && npm run compile",
40+
"system-test": "c8 mocha --config ../../.mocharc.cjs --no-parallel build/system-test",
41+
"test": "c8 mocha --config ../../.mocharc.cjs build/test"
42+
},
43+
"dependencies": {
44+
"google-gax": "^5.0.0"
45+
},
46+
"devDependencies": {
47+
"@types/mocha": "^10.0.10",
48+
"@types/node": "^22.18.12",
49+
"@types/sinon": "^20.0.0",
50+
"c8": "^10.1.3",
51+
"gapic-tools": "^1.0.3",
52+
"gts": "^6.0.2",
53+
"jsdoc": "^4.0.5",
54+
"jsdoc-fresh": "^5.0.2",
55+
"jsdoc-region-tag": "^4.0.1",
56+
"long": "^5.3.2",
57+
"mocha": "^11.7.4",
58+
"pack-n-play": "^4.2.1",
59+
"typescript": "5.8.3",
60+
"sinon": "^20.0.0"
61+
},
62+
"engines": {
63+
"node": ">=18"
64+
},
65+
"types": "build/src/index.d.ts"
66+
}

0 commit comments

Comments
 (0)