firebase-functions 6.6.0 → 7.0.0-rc.0

package/lib/common/encoding.js

@@ -1,96 +1,73 @@
-"use strict";
-// The MIT License (MIT)
-//
-// Copyright (c) 2021 Firebase
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in all
-// copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-// SOFTWARE.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertInvoker = exports.serviceAccountFromShorthand = exports.convertIfPresent = exports.copyIfPresent = exports.durationFromSeconds = void 0;
-const params_1 = require("../params");
+const require_params_types = require('../params/types.js');
+require('../params/index.js');
+
+//#region src/common/encoding.ts
 /** Get a google.protobuf.Duration for a number of seconds. */
 function durationFromSeconds(s) {
-    return `${s}s`;
+	return `${s}s`;
 }
-exports.durationFromSeconds = durationFromSeconds;
 /**
- * Utility function to help copy fields from type A to B.
- * As a safety net, catches typos or fields that aren't named the same
- * in A and B, but cannot verify that both Src and Dest have the same type for the same field.
- */
+* Utility function to help copy fields from type A to B.
+* As a safety net, catches typos or fields that aren't named the same
+* in A and B, but cannot verify that both Src and Dest have the same type for the same field.
+*/
 function copyIfPresent(dest, src, ...fields) {
-    if (!src) {
-        return;
-    }
-    for (const field of fields) {
-        if (!Object.prototype.hasOwnProperty.call(src, field)) {
-            continue;
-        }
-        dest[field] = src[field];
-    }
+	if (!src) {
+		return;
+	}
+	for (const field of fields) {
+		if (!Object.prototype.hasOwnProperty.call(src, field)) {
+			continue;
+		}
+		dest[field] = src[field];
+	}
 }
-exports.copyIfPresent = copyIfPresent;
 function convertIfPresent(dest, src, destField, srcField, converter = (from) => {
-    return from;
+	return from;
 }) {
-    if (!src) {
-        return;
-    }
-    if (!Object.prototype.hasOwnProperty.call(src, srcField)) {
-        return;
-    }
-    dest[destField] = converter(src[srcField]);
+	if (!src) {
+		return;
+	}
+	if (!Object.prototype.hasOwnProperty.call(src, srcField)) {
+		return;
+	}
+	dest[destField] = converter(src[srcField]);
 }
-exports.convertIfPresent = convertIfPresent;
 function serviceAccountFromShorthand(serviceAccount) {
-    if (serviceAccount === "default") {
-        return null;
-    }
-    else if (serviceAccount instanceof params_1.Expression) {
-        return serviceAccount;
-    }
-    else if (serviceAccount.endsWith("@")) {
-        if (!process.env.GCLOUD_PROJECT) {
-            throw new Error(`Unable to determine email for service account '${serviceAccount}' because process.env.GCLOUD_PROJECT is not set.`);
-        }
-        return `${serviceAccount}${process.env.GCLOUD_PROJECT}.iam.gserviceaccount.com`;
-    }
-    else if (serviceAccount.includes("@")) {
-        return serviceAccount;
-    }
-    else {
-        throw new Error(`Invalid option for serviceAccount: '${serviceAccount}'. Valid options are 'default', a service account email, or '{serviceAccountName}@'`);
-    }
+	if (serviceAccount === "default") {
+		return null;
+	} else if (serviceAccount instanceof require_params_types.Expression) {
+		return serviceAccount;
+	} else if (serviceAccount.endsWith("@")) {
+		if (!process.env.GCLOUD_PROJECT) {
+			throw new Error(`Unable to determine email for service account '${serviceAccount}' because process.env.GCLOUD_PROJECT is not set.`);
+		}
+		return `${serviceAccount}${process.env.GCLOUD_PROJECT}.iam.gserviceaccount.com`;
+	} else if (serviceAccount.includes("@")) {
+		return serviceAccount;
+	} else {
+		throw new Error(`Invalid option for serviceAccount: '${serviceAccount}'. Valid options are 'default', a service account email, or '{serviceAccountName}@'`);
+	}
 }
-exports.serviceAccountFromShorthand = serviceAccountFromShorthand;
 function convertInvoker(invoker) {
-    if (typeof invoker === "string") {
-        invoker = [invoker];
-    }
-    if (invoker.length === 0) {
-        throw new Error("Invalid option for invoker: Must be a non-empty array.");
-    }
-    if (invoker.find((inv) => inv.length === 0)) {
-        throw new Error("Invalid option for invoker: Must be a non-empty string.");
-    }
-    if (invoker.length > 1 && invoker.find((inv) => inv === "public" || inv === "private")) {
-        throw new Error("Invalid option for invoker: Cannot have 'public' or 'private' in an array of service accounts.");
-    }
-    return invoker;
+	if (typeof invoker === "string") {
+		invoker = [invoker];
+	}
+	if (invoker.length === 0) {
+		throw new Error("Invalid option for invoker: Must be a non-empty array.");
+	}
+	if (invoker.find((inv) => inv.length === 0)) {
+		throw new Error("Invalid option for invoker: Must be a non-empty string.");
+	}
+	if (invoker.length > 1 && invoker.find((inv) => inv === "public" || inv === "private")) {
+		throw new Error("Invalid option for invoker: Cannot have 'public' or 'private' in an array of service accounts.");
+	}
+	return invoker;
 }
+
+//#endregion
+exports.convertIfPresent = convertIfPresent;
 exports.convertInvoker = convertInvoker;
+exports.copyIfPresent = copyIfPresent;
+exports.durationFromSeconds = durationFromSeconds;
+exports.serviceAccountFromShorthand = serviceAccountFromShorthand;

package/lib/common/onInit.js

@@ -1,36 +1,34 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.withInit = exports.onInit = void 0;
-const logger = require("../logger");
+const require_logger_index = require('../logger/index.js');
+
+//#region src/common/onInit.ts
 let initCallback = null;
 let didInit = false;
 /**
- * Registers a callback that should be run when in a production environment
- * before executing any functions code.
- * Calling this function more than once leads to undefined behavior.
- * @param callback initialization callback to be run before any function executes.
- */
+* Registers a callback that should be run when in a production environment
+* before executing any functions code.
+* Calling this function more than once leads to undefined behavior.
+* @param callback initialization callback to be run before any function executes.
+*/
 function onInit(callback) {
-    if (initCallback) {
-        logger.warn("Setting onInit callback more than once. Only the most recent callback will be called");
-    }
-    initCallback = callback;
-    didInit = false;
+	if (initCallback) {
+		require_logger_index.warn("Setting onInit callback more than once. Only the most recent callback will be called");
+	}
+	initCallback = callback;
+	didInit = false;
 }
-exports.onInit = onInit;
 /** @internal */
 function withInit(func) {
-    return async (...args) => {
-        if (!didInit) {
-            if (initCallback) {
-                await initCallback();
-            }
-            didInit = true;
-        }
-        // Note: This cast is actually inaccurate because it may be a promise, but
-        // it doesn't actually matter because the async function will promisify
-        // non-promises and forward promises.
-        return func(...args);
-    };
+	return async (...args) => {
+		if (!didInit) {
+			if (initCallback) {
+				await initCallback();
+			}
+			didInit = true;
+		}
+		return func(...args);
+	};
 }
-exports.withInit = withInit;
+
+//#endregion
+exports.onInit = onInit;
+exports.withInit = withInit;

package/lib/common/options.js

@@ -1,44 +1,24 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RESET_VALUE = exports.ResetValue = void 0;
-// The MIT License (MIT)
-//
-// Copyright (c) 2022 Firebase
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in all
-// copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-// SOFTWARE.
+
+//#region src/common/options.ts
 /**
- * Special configuration type to reset configuration to platform default.
- *
- * @alpha
- */
-class ResetValue {
-    toJSON() {
-        return null;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    constructor() { }
-    static getInstance() {
-        return new ResetValue();
-    }
-}
-exports.ResetValue = ResetValue;
+* Special configuration type to reset configuration to platform default.
+*
+* @alpha
+*/
+var ResetValue = class ResetValue {
+	toJSON() {
+		return null;
+	}
+	constructor() {}
+	static getInstance() {
+		return new ResetValue();
+	}
+};
 /**
- * Special configuration value to reset configuration to platform default.
- */
-exports.RESET_VALUE = ResetValue.getInstance();
+* Special configuration value to reset configuration to platform default.
+*/
+const RESET_VALUE = ResetValue.getInstance();
+
+//#endregion
+exports.RESET_VALUE = RESET_VALUE;
+exports.ResetValue = ResetValue;

package/lib/common/params.d.ts

@@ -15,13 +15,13 @@ export type NullSafe<S extends null | undefined | string> = S extends null ? nev
  * A type that extracts parameter name enclosed in bracket as string.
  * Ignore wildcard matches
  *
- * For example, Extract<"{uid}"> is "uid".
- * For example, Extract<"{uid=*}"> is "uid".
- * For example, Extract<"{uid=**}"> is "uid".
+ * For example, VarName<"{uid}"> is "uid".
+ * For example, VarName<"{uid=*}"> is "uid".
+ * For example, VarName<"{uid=**}"> is "uid".
  */
-export type Extract<Part extends string> = Part extends `{${infer Param}=**}` ? Param : Part extends `{${infer Param}=*}` ? Param : Part extends `{${infer Param}}` ? Param : never;
+export type VarName<Part extends string> = Part extends `{${infer Param}=**}` ? Param : Part extends `{${infer Param}=*}` ? Param : Part extends `{${infer Param}}` ? Param : never;
 /**
- * A type that maps all parameter capture gropus into keys of a record.
+ * A type that maps all parameter capture groups into keys of a record.
  * For example, ParamsOf<"users/{uid}"> is { uid: string }
  * ParamsOf<"users/{uid}/logs/{log}"> is { uid: string; log: string }
  * ParamsOf<"some/static/data"> is {}
@@ -29,5 +29,5 @@ export type Extract<Part extends string> = Part extends `{${infer Param}=**}` ?
  * For flexibility reasons, ParamsOf<string> is Record<string, string>
  */
 export type ParamsOf<PathPattern extends string | Expression<string>> = PathPattern extends Expression<string> ? Record<string, string> : string extends PathPattern ? Record<string, string> : {
-    [Key in Extract<Split<NullSafe<Exclude<PathPattern, Expression<string>>>, "/">[number]>]: string;
+    [Key in VarName<Split<NullSafe<Exclude<PathPattern, Expression<string>>>, "/">[number]>]: string;
 };

package/lib/common/params.js

@@ -1,23 +0,0 @@
-"use strict";
-// The MIT License (MIT)
-//
-// Copyright (c) 2021 Firebase
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in all
-// copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-// SOFTWARE.
-Object.defineProperty(exports, "__esModule", { value: true });