@google-cloud/apikeys 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.1.0](https://github.com/googleapis/google-cloud-node/compare/apikeys-v1.0.1...apikeys-v1.1.0) (2024-02-09)
+
+
+### Features
+
+* Trusted Private Cloud support, use the universeDomain parameter  ([#5022](https://github.com/googleapis/google-cloud-node/issues/5022)) ([b6498d8](https://github.com/googleapis/google-cloud-node/commit/b6498d8580d056817981dedbaa0ea5d82e9dccc2))
+
+## [1.0.1](https://github.com/googleapis/google-cloud-node/compare/apikeys-v1.0.0...apikeys-v1.0.1) (2023-09-06)
+
+
+### Bug Fixes
+
+* [Many APIs] simplify logic for HTTP/1.1 REST fallback option ([#4583](https://github.com/googleapis/google-cloud-node/issues/4583)) ([c3ddba8](https://github.com/googleapis/google-cloud-node/commit/c3ddba8df9fee6185e36a4e99f7c67b0319f1242))
+
 ## [1.0.0](https://github.com/googleapis/google-cloud-node/compare/apikeys-v0.2.2...apikeys-v1.0.0) (2023-08-06)
 
 

package/README.md

@@ -129,7 +129,7 @@ also contains samples.
 
 ## Supported Node.js Versions
 
-Our client libraries follow the [Node.js release schedule](https://nodejs.org/en/about/releases/).
+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

package/build/protos/google/api/apikeys/v2/apikeys.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -22,6 +22,7 @@ import "google/api/client.proto";
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
 import "google/protobuf/field_mask.proto";
 
 option csharp_namespace = "Google.Cloud.ApiKeys.V2";

package/build/protos/google/api/apikeys/v2/resources.proto

@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -61,15 +61,18 @@ message Key {
 
   // Output only. A timestamp identifying the time this key was originally
   // created.
-  google.protobuf.Timestamp create_time = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp create_time = 4
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. A timestamp identifying the time this key was last
   // updated.
-  google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+  google.protobuf.Timestamp update_time = 6
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // Output only. A timestamp when this key was deleted. If the resource is not deleted,
-  // this must be empty.
-  google.protobuf.Timestamp delete_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+  // Output only. A timestamp when this key was deleted. If the resource is not
+  // deleted, this must be empty.
+  google.protobuf.Timestamp delete_time = 7
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Annotations is an unstructured key-value map stored with a policy that
   // may be set by external tools to store and retrieve arbitrary metadata.
@@ -79,10 +82,10 @@ message Key {
   // Key restrictions.
   Restrictions restrictions = 9;
 
-  // Output only. A checksum computed by the server based on the current value of the Key
-  // resource. This may be sent on update and delete requests to ensure the
-  // client has an up-to-date value before proceeding.
-  // See https://google.aip.dev/154.
+  // Output only. A checksum computed by the server based on the current value
+  // of the Key resource. This may be sent on update and delete requests to
+  // ensure the client has an up-to-date value before proceeding. See
+  // https://google.aip.dev/154.
   string etag = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 

package/build/protos/protos.d.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

package/build/protos/protos.js

@@ -1,4 +1,4 @@
-// Copyright 2023 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

package/build/src/index.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2023 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

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

@@ -16,6 +16,8 @@ export declare class ApiKeysClient {
     private _gaxGrpc;
     private _protos;
     private _defaults;
+    private _universeDomain;
+    private _servicePath;
     auth: gax.GoogleAuth;
     descriptors: Descriptors;
     warn: (code: string, message: string, warnType?: string) => void;
@@ -57,8 +59,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 +67,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);
@@ -86,15 +87,22 @@ export declare class ApiKeysClient {
     }>;
     /**
      * The DNS address for this API service.
+     * @deprecated Use the apiEndpoint method of the client instance.
      * @returns {string} The DNS address for this service.
      */
     static get servicePath(): string;
     /**
-     * The DNS address for this API service - same as servicePath(),
-     * exists for compatibility reasons.
+     * The DNS address for this API service - same as servicePath.
+     * @deprecated Use the apiEndpoint method of the client instance.
      * @returns {string} The DNS address for this service.
      */
     static get apiEndpoint(): string;
+    /**
+     * The DNS address for this API service.
+     * @returns {string} The DNS address for this service.
+     */
+    get apiEndpoint(): string;
+    get universeDomain(): string;
     /**
      * The port for this API service.
      * @returns {number} The default port for this service.

package/build/src/v2/api_keys_client.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2023 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -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,11 +68,11 @@ 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) {
-        var _a, _b;
+        var _a, _b, _c, _d;
         this._terminated = false;
         this.descriptors = {
             page: {},
@@ -83,16 +82,24 @@ class ApiKeysClient {
         };
         // Ensure that options include all the required fields.
         const staticMembers = this.constructor;
-        const servicePath = (opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint) || staticMembers.servicePath;
+        if ((opts === null || opts === void 0 ? void 0 : opts.universe_domain) &&
+            (opts === null || opts === void 0 ? void 0 : opts.universeDomain) &&
+            (opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== (opts === null || opts === void 0 ? void 0 : opts.universeDomain)) {
+            throw new Error('Please set either universe_domain or universeDomain, but not both.');
+        }
+        this._universeDomain =
+            (_b = (_a = opts === null || opts === void 0 ? void 0 : opts.universeDomain) !== null && _a !== void 0 ? _a : opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== null && _b !== void 0 ? _b : 'googleapis.com';
+        this._servicePath = 'apikeys.' + this._universeDomain;
+        const servicePath = (opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint) || this._servicePath;
         this._providedCustomServicePath = !!((opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint));
         const port = (opts === null || opts === void 0 ? void 0 : opts.port) || staticMembers.port;
-        const clientConfig = (_a = opts === null || opts === void 0 ? void 0 : opts.clientConfig) !== null && _a !== void 0 ? _a : {};
-        const fallback = (_b = opts === null || opts === void 0 ? void 0 : opts.fallback) !== null && _b !== void 0 ? _b : (typeof window !== 'undefined' && typeof (window === null || window === void 0 ? void 0 : window.fetch) === 'function');
+        const clientConfig = (_c = opts === null || opts === void 0 ? void 0 : opts.clientConfig) !== null && _c !== void 0 ? _c : {};
+        const fallback = (_d = opts === null || opts === void 0 ? void 0 : opts.fallback) !== null && _d !== void 0 ? _d : (typeof window !== 'undefined' && typeof (window === null || window === void 0 ? void 0 : window.fetch) === 'function');
         opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
         // Request numeric enum values if REST transport is used.
         opts.numericEnums = true;
         // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
-        if (servicePath !== staticMembers.servicePath && !('scopes' in opts)) {
+        if (servicePath !== this._servicePath && !('scopes' in opts)) {
             opts['scopes'] = staticMembers.scopes;
         }
         // Load google-gax module synchronously if needed
@@ -110,9 +117,9 @@ class ApiKeysClient {
         // Set useJWTAccessWithScope on the auth object.
         this.auth.useJWTAccessWithScope = true;
         // Set defaultServicePath on the auth object.
-        this.auth.defaultServicePath = staticMembers.servicePath;
+        this.auth.defaultServicePath = this._servicePath;
         // Set the default scopes in auth client if needed.
-        if (servicePath === staticMembers.servicePath) {
+        if (servicePath === this._servicePath) {
             this.auth.defaultScopes = staticMembers.scopes;
         }
         // Determine the client header string.
@@ -126,7 +133,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 +163,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 = [
                 {
@@ -245,19 +252,38 @@ class ApiKeysClient {
     }
     /**
      * The DNS address for this API service.
+     * @deprecated Use the apiEndpoint method of the client instance.
      * @returns {string} The DNS address for this service.
      */
     static get servicePath() {
+        if (typeof process !== undefined &&
+            typeof process.emitWarning === 'function') {
+            process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
+        }
         return 'apikeys.googleapis.com';
     }
     /**
-     * The DNS address for this API service - same as servicePath(),
-     * exists for compatibility reasons.
+     * The DNS address for this API service - same as servicePath.
+     * @deprecated Use the apiEndpoint method of the client instance.
      * @returns {string} The DNS address for this service.
      */
     static get apiEndpoint() {
+        if (typeof process !== undefined &&
+            typeof process.emitWarning === 'function') {
+            process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
+        }
         return 'apikeys.googleapis.com';
     }
+    /**
+     * The DNS address for this API service.
+     * @returns {string} The DNS address for this service.
+     */
+    get apiEndpoint() {
+        return this._servicePath;
+    }
+    get universeDomain() {
+        return this._universeDomain;
+    }
     /**
      * The port for this API service.
      * @returns {number} The default port for this service.

package/build/src/v2/index.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2023 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/apikeys",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "API Keys API client for Node.js",
   "repository": {
     "type": "git",
@@ -38,7 +38,7 @@
     "docs-test": "linkinator docs",
     "fix": "gts fix",
     "lint": "gts check",
-    "prepare": "npm run compile-protos && npm run compile",
+    "prepare": "npm run compile",
     "prelint": "cd samples; npm link ../; npm i",
     "postpack": "minifyProtoJson",
     "samples-test": "cd samples/ && npm link ../ && npm i && npm test",
@@ -51,18 +51,18 @@
   "devDependencies": {
     "@types/mocha": "^9.0.0",
     "@types/node": "^20.4.5",
-    "@types/sinon": "^10.0.0",
+    "@types/sinon": "^17.0.0",
     "c8": "^8.0.1",
-    "gapic-tools": "^0.1.8",
+    "gapic-tools": "^0.3.0",
     "gts": "^5.0.0",
     "jsdoc": "^4.0.0",
-    "jsdoc-fresh": "^2.0.0",
-    "jsdoc-region-tag": "^2.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",
-    "pack-n-play": "^1.0.0-2",
-    "sinon": "^15.0.0",
+    "pack-n-play": "^2.0.0",
+    "sinon": "^17.0.0",
     "typescript": "^5.1.6"
   },
   "engines": {