firebase-functions 3.21.2 → 3.22.0

package/lib/common/providers/identity.js

@@ -426,9 +426,13 @@ function wrapHandler(eventType, handler) {
             }
             const decodedPayload = (0, debug_1.isDebugFeatureEnabled)('skipTokenVerification')
                 ? unsafeDecodeAuthBlockingToken(req.body.data.jwt)
-                : await (0, apps_1.apps)()
-                    .admin.auth()
-                    ._verifyAuthBlockingToken(req.body.data.jwt);
+                : handler.length === 2
+                    ? await (0, apps_1.apps)()
+                        .admin.auth()
+                        ._verifyAuthBlockingToken(req.body.data.jwt)
+                    : await (0, apps_1.apps)()
+                        .admin.auth()
+                        ._verifyAuthBlockingToken(req.body.data.jwt, 'run.app');
             const authUserRecord = parseAuthUserRecord(decodedPayload.user_record);
             const authEventContext = parseAuthEventContext(decodedPayload, projectId);
             let authResponse;

package/lib/common/providers/tasks.js

@@ -33,20 +33,21 @@ function onDispatchHandler(handler) {
                 logger.error('Invalid request, unable to process.');
                 throw new https.HttpsError('invalid-argument', 'Bad Request');
             }
-            const authHeader = req.header('Authorization') || '';
-            const token = (_a = authHeader.match(/^Bearer (.*)$/)) === null || _a === void 0 ? void 0 : _a[1];
-            // Note: this should never happen since task queue functions are guarded by IAM.
-            if (!token) {
-                throw new https.HttpsError('unauthenticated', 'Unauthenticated');
-            }
-            // We skip authenticating the token since tq functions are guarded by IAM.
-            const authToken = await https.unsafeDecodeIdToken(token);
-            const context = {
-                auth: {
+            const context = {};
+            if (!process.env.FUNCTIONS_EMULATOR) {
+                const authHeader = req.header('Authorization') || '';
+                const token = (_a = authHeader.match(/^Bearer (.*)$/)) === null || _a === void 0 ? void 0 : _a[1];
+                // Note: this should never happen since task queue functions are guarded by IAM.
+                if (!token) {
+                    throw new https.HttpsError('unauthenticated', 'Unauthenticated');
+                }
+                // We skip authenticating the token since tq functions are guarded by IAM.
+                const authToken = await https.unsafeDecodeIdToken(token);
+                context.auth = {
                     uid: authToken.uid,
                     token: authToken,
-                },
-            };
+                };
+            }
             const data = https.decode(req.body.data);
             if (handler.length === 2) {
                 await handler(data, context);

package/lib/function-builder.d.ts

@@ -24,7 +24,7 @@ export declare function region(...regions: Array<typeof SUPPORTED_REGIONS[number
  * Configure runtime options for the function.
  * @param runtimeOptions Object with optional fields:
  * 1. `memory`: amount of memory to allocate to the function, possible values
- *    are: '128MB', '256MB', '512MB', '1GB', '2GB', and '4GB'.
+ *    are: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB', and '8GB'.
  * 2. `timeoutSeconds`: timeout for the function in seconds, possible values are
  *    0 to 540.
  * 3. `failurePolicy`: failure policy of the function, with boolean `true` being
@@ -55,7 +55,7 @@ export declare class FunctionBuilder {
      * Configure runtime options for the function.
      * @param runtimeOptions Object with optional fields:
      * 1. `memory`: amount of memory to allocate to the function, possible values
-     *    are: '128MB', '256MB', '512MB', '1GB', '2GB', and '4GB'.
+     *    are: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB', and '8GB'.
      * 2. `timeoutSeconds`: timeout for the function in seconds, possible values are
      *    0 to 540.
      * 3. `failurePolicy`: failure policy of the function, with boolean `true` being

package/lib/function-builder.js

@@ -164,7 +164,7 @@ exports.region = region;
  * Configure runtime options for the function.
  * @param runtimeOptions Object with optional fields:
  * 1. `memory`: amount of memory to allocate to the function, possible values
- *    are: '128MB', '256MB', '512MB', '1GB', '2GB', and '4GB'.
+ *    are: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB', and '8GB'.
  * 2. `timeoutSeconds`: timeout for the function in seconds, possible values are
  *    0 to 540.
  * 3. `failurePolicy`: failure policy of the function, with boolean `true` being
@@ -206,7 +206,7 @@ class FunctionBuilder {
      * Configure runtime options for the function.
      * @param runtimeOptions Object with optional fields:
      * 1. `memory`: amount of memory to allocate to the function, possible values
-     *    are: '128MB', '256MB', '512MB', '1GB', '2GB', and '4GB'.
+     *    are: '128MB', '256MB', '512MB', '1GB', '2GB', '4GB', and '8GB'.
      * 2. `timeoutSeconds`: timeout for the function in seconds, possible values are
      *    0 to 540.
      * 3. `failurePolicy`: failure policy of the function, with boolean `true` being

package/lib/providers/database.d.ts

@@ -1,7 +1,9 @@
-import * as firebase from 'firebase-admin';
 import { apps } from '../apps';
-import { Change, CloudFunction, EventContext } from '../cloud-functions';
+import { CloudFunction, EventContext } from '../cloud-functions';
+import { Change } from '../common/change';
+import { DataSnapshot } from '../common/providers/database';
 import { DeploymentOptions } from '../function-configuration';
+export { DataSnapshot };
 /** @hidden */
 export declare const provider = "google.firebase.database";
 /** @hidden */
@@ -130,147 +132,3 @@ export declare class RefBuilder {
  */
 /** @hidden */
 export declare function extractInstanceAndPath(resource: string, domain?: string): string[];
-/**
- * Interface representing a Firebase Realtime Database data snapshot.
- */
-export declare class DataSnapshot {
-    private app?;
-    instance: string;
-    /** @hidden */
-    private _ref;
-    /** @hidden */
-    private _path;
-    /** @hidden */
-    private _data;
-    /** @hidden */
-    private _childPath;
-    constructor(data: any, path?: string, // path will be undefined for the database root
-    app?: firebase.app.App, instance?: string);
-    /**
-     * Returns a [`Reference`](/docs/reference/admin/node/admin.database.Reference)
-     * to the Database location where the triggering write occurred. Has
-     * full read and write access.
-     */
-    get ref(): firebase.database.Reference;
-    /**
-     * The key (last part of the path) of the location of this `DataSnapshot`.
-     *
-     * The last token in a Database location is considered its key. For example,
-     * "ada" is the key for the `/users/ada/` node. Accessing the key on any
-     * `DataSnapshot` will return the key for the location that generated it.
-     * However, accessing the key on the root URL of a Database will return `null`.
-     */
-    get key(): string;
-    /**
-     * Extracts a JavaScript value from a `DataSnapshot`.
-     *
-     * Depending on the data in a `DataSnapshot`, the `val()` method may return a
-     * scalar type (string, number, or boolean), an array, or an object. It may also
-     * return `null`, indicating that the `DataSnapshot` is empty (contains no
-     * data).
-     *
-     * @return The DataSnapshot's contents as a JavaScript value (Object,
-     *   Array, string, number, boolean, or `null`).
-     */
-    val(): any;
-    /**
-     * Exports the entire contents of the `DataSnapshot` as a JavaScript object.
-     *
-     * The `exportVal()` method is similar to `val()`, except priority information
-     * is included (if available), making it suitable for backing up your data.
-     *
-     * @return The contents of the `DataSnapshot` as a JavaScript value
-     *   (Object, Array, string, number, boolean, or `null`).
-     */
-    exportVal(): any;
-    /**
-     * Gets the priority value of the data in this `DataSnapshot`.
-     *
-     * As an alternative to using priority, applications can order collections by
-     * ordinary properties. See [Sorting and filtering
-     * data](/docs/database/web/lists-of-data#sorting_and_filtering_data).
-     *
-     * @return The priority value of the data.
-     */
-    getPriority(): string | number | null;
-    /**
-     * Returns `true` if this `DataSnapshot` contains any data. It is slightly more
-     * efficient than using `snapshot.val() !== null`.
-     *
-     * @return `true` if this `DataSnapshot` contains any data; otherwise, `false`.
-     */
-    exists(): boolean;
-    /**
-     * Gets a `DataSnapshot` for the location at the specified relative path.
-     *
-     * The relative path can either be a simple child name (for example, "ada") or
-     * a deeper slash-separated path (for example, "ada/name/first").
-     *
-     * @param path A relative path from this location to the desired child
-     *   location.
-     * @return The specified child location.
-     */
-    child(childPath: string): DataSnapshot;
-    /**
-     * Enumerates the `DataSnapshot`s of the children items.
-     *
-     * Because of the way JavaScript objects work, the ordering of data in the
-     * JavaScript object returned by `val()` is not guaranteed to match the ordering
-     * on the server nor the ordering of `child_added` events. That is where
-     * `forEach()` comes in handy. It guarantees the children of a `DataSnapshot`
-     * will be iterated in their query order.
-     *
-     * If no explicit `orderBy*()` method is used, results are returned
-     * ordered by key (unless priorities are used, in which case, results are
-     * returned by priority).
-     *
-     * @param action A function that will be called for each child `DataSnapshot`.
-     *   The callback can return `true` to cancel further enumeration.
-     *
-     * @return `true` if enumeration was canceled due to your callback
-     *   returning `true`.
-     */
-    forEach(action: (a: DataSnapshot) => boolean | void): boolean;
-    /**
-     * Returns `true` if the specified child path has (non-`null`) data.
-     *
-     * @param path A relative path to the location of a potential child.
-     * @return `true` if data exists at the specified child path; otherwise,
-     *   `false`.
-     */
-    hasChild(childPath: string): boolean;
-    /**
-     * Returns whether or not the `DataSnapshot` has any non-`null` child
-     * properties.
-     *
-     * You can use `hasChildren()` to determine if a `DataSnapshot` has any
-     * children. If it does, you can enumerate them using `forEach()`. If it
-     * doesn't, then either this snapshot contains a primitive value (which can be
-     * retrieved with `val()`) or it is empty (in which case, `val()` will return
-     * `null`).
-     *
-     * @return `true` if this snapshot has any children; else `false`.
-     */
-    hasChildren(): boolean;
-    /**
-     * Returns the number of child properties of this `DataSnapshot`.
-     *
-     * @return Number of child properties of this `DataSnapshot`.
-     */
-    numChildren(): number;
-    /**
-     * Returns a JSON-serializable representation of this object.
-     *
-     * @return A JSON-serializable representation of this object.
-     */
-    toJSON(): Object;
-    /** Recursive function to check if keys are numeric & convert node object to array if they are
-     *
-     * @hidden
-     */
-    private _checkAndConvertToArray;
-    /** @hidden */
-    private _dup;
-    /** @hidden */
-    private _fullPath;
-}

package/lib/providers/database.js

@@ -21,10 +21,11 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataSnapshot = exports.extractInstanceAndPath = exports.RefBuilder = exports._refWithOptions = exports.InstanceBuilder = exports._instanceWithOptions = exports.ref = exports.instance = exports.service = exports.provider = void 0;
-const _ = require("lodash");
+exports.extractInstanceAndPath = exports.RefBuilder = exports._refWithOptions = exports.InstanceBuilder = exports._instanceWithOptions = exports.ref = exports.instance = exports.service = exports.provider = exports.DataSnapshot = void 0;
 const apps_1 = require("../apps");
 const cloud_functions_1 = require("../cloud-functions");
+const database_1 = require("../common/providers/database");
+Object.defineProperty(exports, "DataSnapshot", { enumerable: true, get: function () { return database_1.DataSnapshot; } });
 const config_1 = require("../config");
 const path_1 = require("../utilities/path");
 const utils_1 = require("../utils");
@@ -152,8 +153,8 @@ class RefBuilder {
         this.options = options;
         this.changeConstructor = (raw) => {
             const [dbInstance, path] = extractInstanceAndPath(raw.context.resource.name, raw.context.domain);
-            const before = new DataSnapshot(raw.data.data, path, this.apps.admin, dbInstance);
-            const after = new DataSnapshot((0, utils_1.applyChange)(raw.data.data, raw.data.delta), path, this.apps.admin, dbInstance);
+            const before = new database_1.DataSnapshot(raw.data.data, path, this.apps.admin, dbInstance);
+            const after = new database_1.DataSnapshot((0, utils_1.applyChange)(raw.data.data, raw.data.delta), path, this.apps.admin, dbInstance);
             return {
                 before,
                 after,
@@ -194,7 +195,7 @@ class RefBuilder {
     onCreate(handler) {
         const dataConstructor = (raw) => {
             const [dbInstance, path] = extractInstanceAndPath(raw.context.resource.name, raw.context.domain);
-            return new DataSnapshot(raw.data.delta, path, this.apps.admin, dbInstance);
+            return new database_1.DataSnapshot(raw.data.delta, path, this.apps.admin, dbInstance);
         };
         return this.onOperation(handler, 'ref.create', dataConstructor);
     }
@@ -209,7 +210,7 @@ class RefBuilder {
     onDelete(handler) {
         const dataConstructor = (raw) => {
             const [dbInstance, path] = extractInstanceAndPath(raw.context.resource.name, raw.context.domain);
-            return new DataSnapshot(raw.data.data, path, this.apps.admin, dbInstance);
+            return new database_1.DataSnapshot(raw.data.data, path, this.apps.admin, dbInstance);
         };
         return this.onOperation(handler, 'ref.delete', dataConstructor);
     }
@@ -260,248 +261,3 @@ function extractInstanceAndPath(resource, domain = 'firebaseio.com') {
     }
 }
 exports.extractInstanceAndPath = extractInstanceAndPath;
-/**
- * Interface representing a Firebase Realtime Database data snapshot.
- */
-class DataSnapshot {
-    constructor(data, path, // path will be undefined for the database root
-    app, instance) {
-        var _a, _b;
-        this.app = app;
-        if ((_b = (_a = app === null || app === void 0 ? void 0 : app.options) === null || _a === void 0 ? void 0 : _a.databaseURL) === null || _b === void 0 ? void 0 : _b.startsWith('http:')) {
-            // In this case we're dealing with an emulator
-            this.instance = app.options.databaseURL;
-        }
-        else if (instance) {
-            // SDK always supplies instance, but user's unit tests may not
-            this.instance = instance;
-        }
-        else if (app) {
-            this.instance = app.options.databaseURL;
-        }
-        else if (process.env.GCLOUD_PROJECT) {
-            this.instance =
-                'https://' + process.env.GCLOUD_PROJECT + '.firebaseio.com';
-        }
-        this._path = path;
-        this._data = data;
-    }
-    /**
-     * Returns a [`Reference`](/docs/reference/admin/node/admin.database.Reference)
-     * to the Database location where the triggering write occurred. Has
-     * full read and write access.
-     */
-    get ref() {
-        if (!this.app) {
-            // may be unpopulated in user's unit tests
-            throw new Error('Please supply a Firebase app in the constructor for DataSnapshot' +
-                ' in order to use the .ref method.');
-        }
-        if (!this._ref) {
-            this._ref = this.app.database(this.instance).ref(this._fullPath());
-        }
-        return this._ref;
-    }
-    /**
-     * The key (last part of the path) of the location of this `DataSnapshot`.
-     *
-     * The last token in a Database location is considered its key. For example,
-     * "ada" is the key for the `/users/ada/` node. Accessing the key on any
-     * `DataSnapshot` will return the key for the location that generated it.
-     * However, accessing the key on the root URL of a Database will return `null`.
-     */
-    get key() {
-        const last = _.last((0, path_1.pathParts)(this._fullPath()));
-        return !last || last === '' ? null : last;
-    }
-    /**
-     * Extracts a JavaScript value from a `DataSnapshot`.
-     *
-     * Depending on the data in a `DataSnapshot`, the `val()` method may return a
-     * scalar type (string, number, or boolean), an array, or an object. It may also
-     * return `null`, indicating that the `DataSnapshot` is empty (contains no
-     * data).
-     *
-     * @return The DataSnapshot's contents as a JavaScript value (Object,
-     *   Array, string, number, boolean, or `null`).
-     */
-    val() {
-        const parts = (0, path_1.pathParts)(this._childPath);
-        const source = this._data;
-        const node = _.cloneDeep(parts.length ? _.get(source, parts, null) : source);
-        return this._checkAndConvertToArray(node);
-    }
-    /**
-     * Exports the entire contents of the `DataSnapshot` as a JavaScript object.
-     *
-     * The `exportVal()` method is similar to `val()`, except priority information
-     * is included (if available), making it suitable for backing up your data.
-     *
-     * @return The contents of the `DataSnapshot` as a JavaScript value
-     *   (Object, Array, string, number, boolean, or `null`).
-     */
-    exportVal() {
-        return this.val();
-    }
-    /**
-     * Gets the priority value of the data in this `DataSnapshot`.
-     *
-     * As an alternative to using priority, applications can order collections by
-     * ordinary properties. See [Sorting and filtering
-     * data](/docs/database/web/lists-of-data#sorting_and_filtering_data).
-     *
-     * @return The priority value of the data.
-     */
-    getPriority() {
-        return 0;
-    }
-    /**
-     * Returns `true` if this `DataSnapshot` contains any data. It is slightly more
-     * efficient than using `snapshot.val() !== null`.
-     *
-     * @return `true` if this `DataSnapshot` contains any data; otherwise, `false`.
-     */
-    exists() {
-        return !_.isNull(this.val());
-    }
-    /**
-     * Gets a `DataSnapshot` for the location at the specified relative path.
-     *
-     * The relative path can either be a simple child name (for example, "ada") or
-     * a deeper slash-separated path (for example, "ada/name/first").
-     *
-     * @param path A relative path from this location to the desired child
-     *   location.
-     * @return The specified child location.
-     */
-    child(childPath) {
-        if (!childPath) {
-            return this;
-        }
-        return this._dup(childPath);
-    }
-    /**
-     * Enumerates the `DataSnapshot`s of the children items.
-     *
-     * Because of the way JavaScript objects work, the ordering of data in the
-     * JavaScript object returned by `val()` is not guaranteed to match the ordering
-     * on the server nor the ordering of `child_added` events. That is where
-     * `forEach()` comes in handy. It guarantees the children of a `DataSnapshot`
-     * will be iterated in their query order.
-     *
-     * If no explicit `orderBy*()` method is used, results are returned
-     * ordered by key (unless priorities are used, in which case, results are
-     * returned by priority).
-     *
-     * @param action A function that will be called for each child `DataSnapshot`.
-     *   The callback can return `true` to cancel further enumeration.
-     *
-     * @return `true` if enumeration was canceled due to your callback
-     *   returning `true`.
-     */
-    forEach(action) {
-        const val = this.val();
-        if (_.isPlainObject(val)) {
-            return _.some(val, (value, key) => action(this.child(key)) === true);
-        }
-        return false;
-    }
-    /**
-     * Returns `true` if the specified child path has (non-`null`) data.
-     *
-     * @param path A relative path to the location of a potential child.
-     * @return `true` if data exists at the specified child path; otherwise,
-     *   `false`.
-     */
-    hasChild(childPath) {
-        return this.child(childPath).exists();
-    }
-    /**
-     * Returns whether or not the `DataSnapshot` has any non-`null` child
-     * properties.
-     *
-     * You can use `hasChildren()` to determine if a `DataSnapshot` has any
-     * children. If it does, you can enumerate them using `forEach()`. If it
-     * doesn't, then either this snapshot contains a primitive value (which can be
-     * retrieved with `val()`) or it is empty (in which case, `val()` will return
-     * `null`).
-     *
-     * @return `true` if this snapshot has any children; else `false`.
-     */
-    hasChildren() {
-        const val = this.val();
-        return _.isPlainObject(val) && _.keys(val).length > 0;
-    }
-    /**
-     * Returns the number of child properties of this `DataSnapshot`.
-     *
-     * @return Number of child properties of this `DataSnapshot`.
-     */
-    numChildren() {
-        const val = this.val();
-        return _.isPlainObject(val) ? Object.keys(val).length : 0;
-    }
-    /**
-     * Returns a JSON-serializable representation of this object.
-     *
-     * @return A JSON-serializable representation of this object.
-     */
-    toJSON() {
-        return this.val();
-    }
-    /** Recursive function to check if keys are numeric & convert node object to array if they are
-     *
-     * @hidden
-     */
-    _checkAndConvertToArray(node) {
-        if (node === null || typeof node === 'undefined') {
-            return null;
-        }
-        if (typeof node !== 'object') {
-            return node;
-        }
-        const obj = {};
-        let numKeys = 0;
-        let maxKey = 0;
-        let allIntegerKeys = true;
-        for (const key in node) {
-            if (!node.hasOwnProperty(key)) {
-                continue;
-            }
-            const childNode = node[key];
-            obj[key] = this._checkAndConvertToArray(childNode);
-            numKeys++;
-            const integerRegExp = /^(0|[1-9]\d*)$/;
-            if (allIntegerKeys && integerRegExp.test(key)) {
-                maxKey = Math.max(maxKey, Number(key));
-            }
-            else {
-                allIntegerKeys = false;
-            }
-        }
-        if (allIntegerKeys && maxKey < 2 * numKeys) {
-            // convert to array.
-            const array = [];
-            _.forOwn(obj, (val, key) => {
-                array[key] = val;
-            });
-            return array;
-        }
-        return obj;
-    }
-    /** @hidden */
-    _dup(childPath) {
-        const dup = new DataSnapshot(this._data, undefined, this.app, this.instance);
-        [dup._path, dup._childPath] = [this._path, this._childPath];
-        if (childPath) {
-            dup._childPath = (0, path_1.joinPath)(dup._childPath, childPath);
-        }
-        return dup;
-    }
-    /** @hidden */
-    _fullPath() {
-        const out = (this._path || '') + '/' + (this._childPath || '');
-        return out;
-    }
-}
-exports.DataSnapshot = DataSnapshot;

package/lib/providers/firestore.d.ts

@@ -1,5 +1,6 @@
 import * as firebase from 'firebase-admin';
-import { Change, CloudFunction, Event, EventContext } from '../cloud-functions';
+import { CloudFunction, Event, EventContext } from '../cloud-functions';
+import { Change } from '../common/change';
 import { DeploymentOptions } from '../function-configuration';
 /** @hidden */
 export declare const provider = "google.firestore";

package/lib/providers/firestore.js

@@ -27,6 +27,7 @@ const _ = require("lodash");
 const path_1 = require("path");
 const apps_1 = require("../apps");
 const cloud_functions_1 = require("../cloud-functions");
+const change_1 = require("../common/change");
 const encoder_1 = require("../encoder");
 const logger = require("../logger");
 /** @hidden */
@@ -147,7 +148,7 @@ function beforeSnapshotConstructor(event) {
 }
 exports.beforeSnapshotConstructor = beforeSnapshotConstructor;
 function changeConstructor(raw) {
-    return cloud_functions_1.Change.fromObjects(beforeSnapshotConstructor(raw), snapshotConstructor(raw));
+    return change_1.Change.fromObjects(beforeSnapshotConstructor(raw), snapshotConstructor(raw));
 }
 class DocumentBuilder {
     /** @hidden */

package/lib/utilities/path-pattern.d.ts

@@ -0,0 +1 @@
+export {};