@google-cloud/storage-control 0.6.0 → 0.7.0

package/build/src/util/storage_control_utils.js

@@ -0,0 +1,31 @@
+"use strict";
+// Copyright 2025 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs");
+const proto_utils_1 = require("./proto_utils");
+const uber_client_builder_1 = require("./uber_client_builder");
+const index_fix_utils_1 = require("./index_fix_utils");
+async function main() {
+    (0, index_fix_utils_1.fixIndexFile)('src/index.ts');
+    (0, index_fix_utils_1.fixV2Index)('v2/index.ts');
+    (0, proto_utils_1.cleanObjectReferences)(proto_utils_1.filesToUpdate, proto_utils_1.replacements);
+    const finaloutput = await (0, uber_client_builder_1.buildOutput)();
+    fs.writeFile('../storage_control_client.ts', finaloutput, err => {
+        if (err)
+            throw err;
+    });
+}
+main().catch(err => console.error(err));
+//# sourceMappingURL=storage_control_utils.js.map

package/build/src/util/storage_control_utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage_control_utils.js","sourceRoot":"","sources":["../../../src/util/storage_control_utils.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;AAEjC,yBAAyB;AACzB,+CAIuB;AACvB,+DAAkD;AAClD,uDAA2D;AAE3D,KAAK,UAAU,IAAI;IACjB,IAAA,8BAAY,EAAC,cAAc,CAAC,CAAC;IAC7B,IAAA,4BAAU,EAAC,aAAa,CAAC,CAAC;IAC1B,IAAA,mCAAqB,EAAC,2BAAa,EAAE,0BAAY,CAAC,CAAC;IACnD,MAAM,WAAW,GAAG,MAAM,IAAA,iCAAW,GAAE,CAAC;IACxC,EAAE,CAAC,SAAS,CAAC,8BAA8B,EAAE,WAAW,EAAE,GAAG,CAAC,EAAE;QAC9D,IAAI,GAAG;YAAE,MAAM,GAAG,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC"}

package/build/src/util/uber_client_builder.d.ts

@@ -0,0 +1,12 @@
+export declare const CLIENTS: string[];
+export declare const FILES: string[];
+export declare const LICENSE = "\n// Copyright 2025 Google LLC\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n//     https://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n//\n// ** This file is automatically generated **\n// ** All changes to this file may be overwritten. **\n\n";
+/**
+ * This function builds the output for the uber client.
+ * It first adds the components that don't come from underlying files
+ * (imports, exported types, docstring w/ client constructor), then
+ * traverses the file inputs and adds the functions from them.
+ *
+ * @returns {Promise<string>} The formatted output.
+ */
+export declare function buildOutput(): Promise<string>;

package/build/src/util/uber_client_builder.js

@@ -0,0 +1,187 @@
+"use strict";
+// Copyright 2025 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LICENSE = exports.FILES = exports.CLIENTS = void 0;
+exports.buildOutput = buildOutput;
+const prettier = require("prettier");
+const ast_utils_1 = require("./ast_utils");
+exports.CLIENTS = ['StorageControlInternal', 'StorageClient'];
+exports.FILES = [
+    '../v2/storage_control_client.ts',
+    '../v2/storage_client.ts',
+];
+exports.LICENSE = `
+// Copyright 2025 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 **
+// ** All changes to this file may be overwritten. **
+
+`;
+/**
+ * This function creates the import statements for the uber client.
+ *
+ * @param {string[]} clients - A list of client names.
+ * @returns {string} The import statements.
+ */
+function makeImports(clients) {
+    let imports = `import {protos} from './';
+import {StorageControlClient as StorageControlInternal} from './v2/storage_control_client';
+import {StorageClient} from './v2/storage_client';`;
+    const staticImports = `
+  import type * as gax from "google-gax";
+  import {Callback, CallOptions, ClientOptions, PaginationCallback, LROperation, Descriptors} from "google-gax";
+  import {Transform} from 'stream';
+  `;
+    imports = imports.concat(`${staticImports}\n\n`);
+    return imports;
+}
+/**
+ * This function builds the option types for the uber client.
+ *
+ * @param {string[]} clients - A list of client names.
+ * @returns {string} The option types.
+ */
+function buildOptionTypes(clients) {
+    let output = '';
+    const docstring = `/**
+   * Options passed to the underlying client.
+   *
+   * @param {object} [options] - The configuration object.
+   * The options accepted by the constructor are described in detail
+   * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
+   * The common options are:
+   * @param {object} [options.credentials] - Credentials object.
+   * @param {string} [options.credentials.client_email]
+   * @param {string} [options.credentials.private_key]
+   * @param {string} [options.email] - Account email address. Required when
+   *     using a .pem or .p12 keyFilename.
+   * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
+   *     .p12 key downloaded from the Google Developers Console. If you provide
+   *     a path to a JSON file, the projectId option below is not necessary.
+   *     NOTE: .pem and .p12 require you to specify options.email as well.
+   * @param {number} [options.port] - The port on which to connect to
+   *     the remote host.
+   * @param {string} [options.projectId] - The project ID from the Google
+   *     Developer's Console, e.g. 'grape-spaceship-123'. We will also check
+   *     the environment variable GCLOUD_PROJECT for your project ID. If your
+   *     app is running in an environment which supports
+   *     {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
+   *     your project ID will be detected automatically.
+   * @param {string} [options.apiEndpoint] - The domain name of the
+   *     API remote host.
+   * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
+   *     Follows the structure of {@link gapicConfig}.
+   * @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
+   *     need to avoid loading the default gRPC version and want to use the fallback
+   *     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 StorageControlClient({fallback: true}, gax);
+   *     \`\`\`
+   */\n`;
+    output = output.concat(docstring);
+    let storageControlOptionsType = 'export interface StorageControlClientOptions extends ClientOptions {\n';
+    storageControlOptionsType = storageControlOptionsType.concat('gaxInstance?: typeof gax | typeof gax.fallback;\n');
+    for (const client in clients) {
+        let variableDecl = '';
+        const clientName = (0, ast_utils_1.parseClientName)(clients[client]);
+        variableDecl = variableDecl.concat(`\t ${clientName}?: ${clients[client]};\n`);
+        storageControlOptionsType = storageControlOptionsType.concat(variableDecl);
+    }
+    storageControlOptionsType = storageControlOptionsType.concat('}\n\n');
+    output = output.concat(storageControlOptionsType);
+    return output;
+}
+/**
+ * This function builds the client constructor for the uber client.
+ *
+ * @param {string[]} clients - A list of client names.
+ * @returns {string} The client constructor.
+ */
+function buildClientConstructor(clients) {
+    let variableDecl = '';
+    const comment = `\t/**
+  \* @param {object} [StorageControlClientOptions] - Enables user to instantiate clients separately and use those as the subclients.
+  \* To have sub-clients with different options, instantiate each client separately.
+  \*/`;
+    let constructorInitializers = `\tconstructor(options?: StorageControlClientOptions){
+    options = options || {};\n`;
+    let clientCounter = 0;
+    for (const client in clients) {
+        const clientName = (0, ast_utils_1.parseClientName)(clients[client]);
+        variableDecl = variableDecl.concat(`\t${clientName}: ${clients[client]};\n`);
+        constructorInitializers = constructorInitializers.concat(`\t\tthis.${clientName} = options?.${clientName} ?? new ${clients[client]}(options);\n`);
+        // add statement about auth only after the first subClient
+        if (clientCounter === 0) {
+            constructorInitializers =
+                constructorInitializers.concat(`\n\t\t// utilize whatever auth was created with the first client for the rest of the clients
+    // this will either be what the user passed into options.auth, or whatever was
+    // initialized by default in gax. We reuse this auth rather than instantiating a default ourselves
+    // so that we do not have to keep this code in sync with gax
+    options.auth = this.${clientName}.auth;\n\n`);
+            clientCounter++;
+        }
+    }
+    const properties = (0, ast_utils_1.getPropertyDeclarations)(exports.FILES[0]);
+    properties.forEach((property, key) => {
+        constructorInitializers = constructorInitializers.concat(`\t\tthis.${key} = this.storageControlInternal.${key};\n`);
+    });
+    constructorInitializers = constructorInitializers.concat('\t}');
+    let output = 'export class StorageControlClient{\n';
+    properties.forEach(property => {
+        variableDecl = variableDecl.concat(property);
+    });
+    output = output.concat(variableDecl, '\n', comment, '\n', constructorInitializers);
+    return output;
+}
+/**
+ * This function builds the output for the uber client.
+ * It first adds the components that don't come from underlying files
+ * (imports, exported types, docstring w/ client constructor), then
+ * traverses the file inputs and adds the functions from them.
+ *
+ * @returns {Promise<string>} The formatted output.
+ */
+async function buildOutput() {
+    console.log('Regenerating storage_control_client.ts');
+    let output = '';
+    output = exports.LICENSE.concat(makeImports(exports.CLIENTS));
+    output = output.concat(buildOptionTypes(exports.CLIENTS));
+    output = output.concat(buildClientConstructor(exports.CLIENTS));
+    output = output.concat((0, ast_utils_1.astHelper)(exports.FILES, exports.CLIENTS));
+    output = output.concat('}\n');
+    return prettier.format(output, {
+        parser: 'typescript',
+        trailingComma: 'all',
+        singleQuote: true,
+        bracketSpacing: false,
+    });
+}
+//# sourceMappingURL=uber_client_builder.js.map

package/build/src/util/uber_client_builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uber_client_builder.js","sourceRoot":"","sources":["../../../src/util/uber_client_builder.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;AAsLjC,kCAcC;AAlMD,qCAAqC;AACrC,2CAAgF;AAEnE,QAAA,OAAO,GAAG,CAAC,wBAAwB,EAAE,eAAe,CAAC,CAAC;AACtD,QAAA,KAAK,GAAG;IACnB,iCAAiC;IACjC,yBAAyB;CAC1B,CAAC;AACW,QAAA,OAAO,GAAG;;;;;;;;;;;;;;;;;;CAkBtB,CAAC;AAEF;;;;;GAKG;AACH,SAAS,WAAW,CAAC,OAAiB;IACpC,IAAI,OAAO,GAAG;;mDAEmC,CAAC;IAClD,MAAM,aAAa,GAAG;;;;GAIrB,CAAC;IAEF,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,aAAa,MAAM,CAAC,CAAC;IACjD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;GAKG;AACH,SAAS,gBAAgB,CAAC,OAAiB;IACzC,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,MAAM,SAAS,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAsCZ,CAAC;IAEP,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAElC,IAAI,yBAAyB,GAC3B,wEAAwE,CAAC;IAC3E,yBAAyB,GAAG,yBAAyB,CAAC,MAAM,CAC1D,mDAAmD,CACpD,CAAC;IACF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,YAAY,GAAG,EAAE,CAAC;QACtB,MAAM,UAAU,GAAG,IAAA,2BAAe,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QACpD,YAAY,GAAG,YAAY,CAAC,MAAM,CAChC,MAAM,UAAU,MAAM,OAAO,CAAC,MAAM,CAAC,KAAK,CAC3C,CAAC;QACF,yBAAyB,GAAG,yBAAyB,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAC7E,CAAC;IACD,yBAAyB,GAAG,yBAAyB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACtE,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC;IAClD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAS,sBAAsB,CAAC,OAAiB;IAC/C,IAAI,YAAY,GAAG,EAAE,CAAC;IACtB,MAAM,OAAO,GAAG;;;MAGZ,CAAC;IACL,IAAI,uBAAuB,GAAG;+BACD,CAAC;IAC9B,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,UAAU,GAAG,IAAA,2BAAe,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QACpD,YAAY,GAAG,YAAY,CAAC,MAAM,CAChC,KAAK,UAAU,KAAK,OAAO,CAAC,MAAM,CAAC,KAAK,CACzC,CAAC;QACF,uBAAuB,GAAG,uBAAuB,CAAC,MAAM,CACtD,YAAY,UAAU,eAAe,UAAU,WAAW,OAAO,CAAC,MAAM,CAAC,cAAc,CACxF,CAAC;QACF,0DAA0D;QAC1D,IAAI,aAAa,KAAK,CAAC,EAAE,CAAC;YACxB,uBAAuB;gBACrB,uBAAuB,CAAC,MAAM,CAAC;;;;0BAIb,UAAU,YAAY,CAAC,CAAC;YAC5C,aAAa,EAAE,CAAC;QAClB,CAAC;IACH,CAAC;IACD,MAAM,UAAU,GAAG,IAAA,mCAAuB,EAAC,aAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACrD,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE;QACnC,uBAAuB,GAAG,uBAAuB,CAAC,MAAM,CACtD,YAAY,GAAG,kCAAkC,GAAG,KAAK,CAC1D,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,uBAAuB,GAAG,uBAAuB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAChE,IAAI,MAAM,GAAG,sCAAsC,CAAC;IACpD,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QAC5B,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IACH,MAAM,GAAG,MAAM,CAAC,MAAM,CACpB,YAAY,EACZ,IAAI,EACJ,OAAO,EACP,IAAI,EACJ,uBAAuB,CACxB,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,WAAW;IAC/B,OAAO,CAAC,GAAG,CAAC,wCAAwC,CAAC,CAAC;IACtD,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,MAAM,GAAG,eAAO,CAAC,MAAM,CAAC,WAAW,CAAC,eAAO,CAAC,CAAC,CAAC;IAC9C,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,eAAO,CAAC,CAAC,CAAC;IAClD,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAAC,eAAO,CAAC,CAAC,CAAC;IACxD,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAA,qBAAS,EAAC,aAAK,EAAE,eAAO,CAAC,CAAC,CAAC;IAClD,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9B,OAAO,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE;QAC7B,MAAM,EAAE,YAAY;QACpB,aAAa,EAAE,KAAK;QACpB,WAAW,EAAE,IAAI;QACjB,cAAc,EAAE,KAAK;KACtB,CAAC,CAAC;AACL,CAAC"}

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

@@ -1 +1,2 @@
 export { StorageControlClient } from './storage_control_client';
+export { StorageClient } from './storage_client';

package/build/src/v2/index.js

@@ -17,7 +17,9 @@
 // ** https://github.com/googleapis/gapic-generator-typescript **
 // ** All changes to this file may be overwritten. **
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StorageControlClient = void 0;
+exports.StorageClient = exports.StorageControlClient = void 0;
 var storage_control_client_1 = require("./storage_control_client");
 Object.defineProperty(exports, "StorageControlClient", { enumerable: true, get: function () { return storage_control_client_1.StorageControlClient; } });
+var storage_client_1 = require("./storage_client");
+Object.defineProperty(exports, "StorageClient", { enumerable: true, get: function () { return storage_client_1.StorageClient; } });
 //# sourceMappingURL=index.js.map

package/build/src/v2/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v2/index.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,4EAA4E;AAC5E,iEAAiE;AACjE,qDAAqD;;;AAErD,mEAA8D;AAAtD,8HAAA,oBAAoB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v2/index.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,kDAAkD;AAClD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,EAAE;AACF,4EAA4E;AAC5E,iEAAiE;AACjE,qDAAqD;;;AAErD,mEAA8D;AAAtD,8HAAA,oBAAoB,OAAA;AAE5B,mDAA+C;AAAvC,+GAAA,aAAa,OAAA"}