@google-cloud/apikeys 0.2.2 → 1.0.1

package/build/src/v2/api_keys_client.d.ts

@@ -57,8 +57,7 @@ export declare class ApiKeysClient {
      *     API remote host.
      * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
      *     Follows the structure of {@link gapicConfig}.
-     * @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
-     *     Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
+     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
      *     For more information, please check the
      *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
      * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
@@ -66,7 +65,7 @@ export declare class ApiKeysClient {
      *     HTTP implementation. Load only fallback version and pass it to the constructor:
      *     ```
      *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
-     *     const client = new ApiKeysClient({fallback: 'rest'}, gax);
+     *     const client = new ApiKeysClient({fallback: true}, gax);
      *     ```
      */
     constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
@@ -122,9 +121,8 @@ export declare class ApiKeysClient {
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
-     *   The first element of the array is an object representing {@link google.api.apikeys.v2.Key | Key}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.api.apikeys.v2.Key|Key}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/api_keys.get_key.js</caption>
      * region_tag:apikeys_v2_generated_ApiKeys_GetKey_async
@@ -149,9 +147,8 @@ export declare class ApiKeysClient {
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
-     *   The first element of the array is an object representing {@link google.api.apikeys.v2.GetKeyStringResponse | GetKeyStringResponse}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.api.apikeys.v2.GetKeyStringResponse|GetKeyStringResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/api_keys.get_key_string.js</caption>
      * region_tag:apikeys_v2_generated_ApiKeys_GetKeyString_async
@@ -177,9 +174,8 @@ export declare class ApiKeysClient {
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
-     *   The first element of the array is an object representing {@link google.api.apikeys.v2.LookupKeyResponse | LookupKeyResponse}.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
+     *   The first element of the array is an object representing {@link protos.google.api.apikeys.v2.LookupKeyResponse|LookupKeyResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/api_keys.lookup_key.js</caption>
      * region_tag:apikeys_v2_generated_ApiKeys_LookupKey_async
@@ -221,8 +217,7 @@ export declare class ApiKeysClient {
      *   The first element of the array is an object representing
      *   a long running operation. Its `promise()` method returns a promise
      *   you can `await` for.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/api_keys.create_key.js</caption>
      * region_tag:apikeys_v2_generated_ApiKeys_CreateKey_async
@@ -240,8 +235,7 @@ export declare class ApiKeysClient {
      *   The operation name that will be passed.
      * @returns {Promise} - The promise which resolves to an object.
      *   The decoded operation object has result and metadata field to get information from.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/api_keys.create_key.js</caption>
      * region_tag:apikeys_v2_generated_ApiKeys_CreateKey_async
@@ -274,8 +268,7 @@ export declare class ApiKeysClient {
      *   The first element of the array is an object representing
      *   a long running operation. Its `promise()` method returns a promise
      *   you can `await` for.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/api_keys.update_key.js</caption>
      * region_tag:apikeys_v2_generated_ApiKeys_UpdateKey_async
@@ -293,8 +286,7 @@ export declare class ApiKeysClient {
      *   The operation name that will be passed.
      * @returns {Promise} - The promise which resolves to an object.
      *   The decoded operation object has result and metadata field to get information from.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/api_keys.update_key.js</caption>
      * region_tag:apikeys_v2_generated_ApiKeys_UpdateKey_async
@@ -320,8 +312,7 @@ export declare class ApiKeysClient {
      *   The first element of the array is an object representing
      *   a long running operation. Its `promise()` method returns a promise
      *   you can `await` for.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/api_keys.delete_key.js</caption>
      * region_tag:apikeys_v2_generated_ApiKeys_DeleteKey_async
@@ -339,8 +330,7 @@ export declare class ApiKeysClient {
      *   The operation name that will be passed.
      * @returns {Promise} - The promise which resolves to an object.
      *   The decoded operation object has result and metadata field to get information from.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/api_keys.delete_key.js</caption>
      * region_tag:apikeys_v2_generated_ApiKeys_DeleteKey_async
@@ -362,8 +352,7 @@ export declare class ApiKeysClient {
      *   The first element of the array is an object representing
      *   a long running operation. Its `promise()` method returns a promise
      *   you can `await` for.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/api_keys.undelete_key.js</caption>
      * region_tag:apikeys_v2_generated_ApiKeys_UndeleteKey_async
@@ -381,8 +370,7 @@ export declare class ApiKeysClient {
      *   The operation name that will be passed.
      * @returns {Promise} - The promise which resolves to an object.
      *   The decoded operation object has result and metadata field to get information from.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/api_keys.undelete_key.js</caption>
      * region_tag:apikeys_v2_generated_ApiKeys_UndeleteKey_async
@@ -409,14 +397,13 @@ export declare class ApiKeysClient {
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Promise} - The promise which resolves to an array.
-     *   The first element of the array is Array of {@link google.api.apikeys.v2.Key | Key}.
+     *   The first element of the array is Array of {@link protos.google.api.apikeys.v2.Key|Key}.
      *   The client library will perform auto-pagination by default: it will call the API as many
      *   times as needed and will merge results from all the pages into this array.
      *   Note that it can affect your quota.
      *   We recommend using `listKeysAsync()`
      *   method described below for async iteration which you can stop as needed.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
      */
     listKeys(request?: protos.google.api.apikeys.v2.IListKeysRequest, options?: CallOptions): Promise<[
@@ -442,13 +429,12 @@ export declare class ApiKeysClient {
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
-     *   An object stream which emits an object representing {@link google.api.apikeys.v2.Key | Key} on 'data' event.
+     *   An object stream which emits an object representing {@link protos.google.api.apikeys.v2.Key|Key} on 'data' event.
      *   The client library will perform auto-pagination by default: it will call the API as many
      *   times as needed. Note that it can affect your quota.
      *   We recommend using `listKeysAsync()`
      *   method described below for async iteration which you can stop as needed.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
      */
     listKeysStream(request?: protos.google.api.apikeys.v2.IListKeysRequest, options?: CallOptions): Transform;
@@ -470,12 +456,11 @@ export declare class ApiKeysClient {
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}
-     *   An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
+     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
      *   When you iterate the returned iterable, each element will be an object representing
-     *   {@link google.api.apikeys.v2.Key | Key}. The API will be called under the hood as needed, once per the page,
+     *   {@link protos.google.api.apikeys.v2.Key|Key}. The API will be called under the hood as needed, once per the page,
      *   so you can stop the iteration when you don't need more results.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/api_keys.list_keys.js</caption>
      * region_tag:apikeys_v2_generated_ApiKeys_ListKeys_async

package/build/src/v2/api_keys_client.js

@@ -60,8 +60,7 @@ class ApiKeysClient {
      *     API remote host.
      * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
      *     Follows the structure of {@link gapicConfig}.
-     * @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
-     *     Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
+     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
      *     For more information, please check the
      *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
      * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
@@ -69,7 +68,7 @@ class ApiKeysClient {
      *     HTTP implementation. Load only fallback version and pass it to the constructor:
      *     ```
      *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
-     *     const client = new ApiKeysClient({fallback: 'rest'}, gax);
+     *     const client = new ApiKeysClient({fallback: true}, gax);
      *     ```
      */
     constructor(opts, gaxInstance) {
@@ -126,7 +125,7 @@ class ApiKeysClient {
         if (!opts.fallback) {
             clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
         }
-        else if (opts.fallback === 'rest') {
+        else {
             clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
         }
         if (opts.libName && opts.libVersion) {
@@ -156,7 +155,7 @@ class ApiKeysClient {
             auth: this.auth,
             grpc: 'grpc' in this._gaxGrpc ? this._gaxGrpc.grpc : undefined,
         };
-        if (opts.fallback === 'rest') {
+        if (opts.fallback) {
             lroOptions.protoJson = protoFilesRoot;
             lroOptions.httpRules = [
                 {
@@ -372,8 +371,7 @@ class ApiKeysClient {
      *   The operation name that will be passed.
      * @returns {Promise} - The promise which resolves to an object.
      *   The decoded operation object has result and metadata field to get information from.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/api_keys.create_key.js</caption>
      * region_tag:apikeys_v2_generated_ApiKeys_CreateKey_async
@@ -411,8 +409,7 @@ class ApiKeysClient {
      *   The operation name that will be passed.
      * @returns {Promise} - The promise which resolves to an object.
      *   The decoded operation object has result and metadata field to get information from.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/api_keys.update_key.js</caption>
      * region_tag:apikeys_v2_generated_ApiKeys_UpdateKey_async
@@ -450,8 +447,7 @@ class ApiKeysClient {
      *   The operation name that will be passed.
      * @returns {Promise} - The promise which resolves to an object.
      *   The decoded operation object has result and metadata field to get information from.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/api_keys.delete_key.js</caption>
      * region_tag:apikeys_v2_generated_ApiKeys_DeleteKey_async
@@ -489,8 +485,7 @@ class ApiKeysClient {
      *   The operation name that will be passed.
      * @returns {Promise} - The promise which resolves to an object.
      *   The decoded operation object has result and metadata field to get information from.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/api_keys.undelete_key.js</caption>
      * region_tag:apikeys_v2_generated_ApiKeys_UndeleteKey_async
@@ -538,13 +533,12 @@ class ApiKeysClient {
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
-     *   An object stream which emits an object representing {@link google.api.apikeys.v2.Key | Key} on 'data' event.
+     *   An object stream which emits an object representing {@link protos.google.api.apikeys.v2.Key|Key} on 'data' event.
      *   The client library will perform auto-pagination by default: it will call the API as many
      *   times as needed. Note that it can affect your quota.
      *   We recommend using `listKeysAsync()`
      *   method described below for async iteration which you can stop as needed.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
      */
     listKeysStream(request, options) {
@@ -580,12 +574,11 @@ class ApiKeysClient {
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Object}
-     *   An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
+     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
      *   When you iterate the returned iterable, each element will be an object representing
-     *   {@link google.api.apikeys.v2.Key | Key}. The API will be called under the hood as needed, once per the page,
+     *   {@link protos.google.api.apikeys.v2.Key|Key}. The API will be called under the hood as needed, once per the page,
      *   so you can stop the iteration when you don't need more results.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v2/api_keys.list_keys.js</caption>
      * region_tag:apikeys_v2_generated_ApiKeys_ListKeys_async

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/apikeys",
-  "version": "0.2.2",
+  "version": "1.0.1",
   "description": "API Keys API client for Node.js",
   "repository": {
     "type": "git",
@@ -31,7 +31,7 @@
   ],
   "scripts": {
     "clean": "gts clean",
-    "compile": "tsc -p . && cp -r protos build/ && minifyProtoJson",
+    "compile": "tsc -p . && cp -r protos build/",
     "compile-protos": "compileProtos src",
     "docs": "jsdoc -c .jsdoc.js",
     "predocs-test": "npm run docs",
@@ -39,34 +39,33 @@
     "fix": "gts fix",
     "lint": "gts check",
     "prepare": "npm run compile-protos && npm run compile",
-    "system-test": "npm run compile && c8 mocha build/system-test",
-    "test": "c8 mocha build/test",
-    "samples-test": "npm run compile && cd samples/ && npm link ../ && npm i && npm test",
-    "prelint": "cd samples; npm link ../; npm i"
+    "prelint": "cd samples; npm link ../; npm i",
+    "postpack": "minifyProtoJson",
+    "samples-test": "cd samples/ && npm link ../ && npm i && npm test",
+    "system-test": "c8 mocha build/system-test",
+    "test": "c8 mocha build/test"
   },
   "dependencies": {
-    "google-gax": "^3.5.8"
+    "google-gax": "^4.0.3"
   },
   "devDependencies": {
     "@types/mocha": "^9.0.0",
-    "@types/node": "^18.0.0",
+    "@types/node": "^20.4.5",
     "@types/sinon": "^10.0.0",
-    "c8": "^7.3.5",
-    "gts": "^3.1.0",
+    "c8": "^8.0.1",
+    "gapic-tools": "^0.1.8",
+    "gts": "^5.0.0",
     "jsdoc": "^4.0.0",
-    "jsdoc-fresh": "^2.0.0",
-    "jsdoc-region-tag": "^2.0.0",
-    "linkinator": "^4.0.0",
+    "jsdoc-fresh": "^3.0.0",
+    "jsdoc-region-tag": "^3.0.0",
+    "linkinator": "4.1.2",
+    "long": "^5.2.3",
     "mocha": "^9.2.2",
-    "null-loader": "^4.0.1",
     "pack-n-play": "^1.0.0-2",
     "sinon": "^15.0.0",
-    "ts-loader": "^9.0.0",
-    "typescript": "^4.6.4",
-    "webpack": "^5.9.0",
-    "webpack-cli": "^5.0.0"
+    "typescript": "^5.1.6"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14.0.0"
   }
 }