firebase-functions 3.24.1 → 4.0.0-rc.0

package/lib/common/providers/database.js

@@ -22,17 +22,19 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DataSnapshot = void 0;
-const _ = require("lodash");
-const path_1 = require("../../utilities/path");
+const database = require("firebase-admin/database");
+const config_1 = require("../../common/config");
+const path_1 = require("../../common/utilities/path");
 /**
- * Interface representing a Firebase Realtime Database data snapshot.
+ * Interface representing a Firebase Realtime database data snapshot.
  */
 class DataSnapshot {
-    constructor(data, path, // path will be undefined for the database root
+    constructor(data, path, // path is 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:')) {
+        const config = (0, config_1.firebaseConfig)();
+        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;
         }
@@ -43,40 +45,50 @@ class DataSnapshot {
         else if (app) {
             this.instance = app.options.databaseURL;
         }
+        else if (config.databaseURL) {
+            this.instance = config.databaseURL;
+        }
         else if (process.env.GCLOUD_PROJECT) {
-            this.instance =
-                'https://' + process.env.GCLOUD_PROJECT + '.firebaseio.com';
+            this.instance = "https://" + process.env.GCLOUD_PROJECT + "-default-rtdb.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
+     * 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.');
+            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());
+            let db;
+            if (this.instance) {
+                db = database.getDatabaseWithUrl(this.instance, this.app);
+            }
+            else {
+                db = database.getDatabase(this.app);
+            }
+            this._ref = db.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,
+     * 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`.
+     * `DataSnapshot` returns the key for the location that generated it.
+     * However, accessing the key on the root URL of a database returns `null`.
      */
     get key() {
-        const last = _.last((0, path_1.pathParts)(this._fullPath()));
-        return !last || last === '' ? null : last;
+        const segments = (0, path_1.pathParts)(this._fullPath());
+        const last = segments[segments.length - 1];
+        return !last || last === "" ? null : last;
     }
     /**
      * Extracts a JavaScript value from a `DataSnapshot`.
@@ -86,21 +98,23 @@ class DataSnapshot {
      * return `null`, indicating that the `DataSnapshot` is empty (contains no
      * data).
      *
-     * @return The DataSnapshot's contents as a JavaScript value (Object,
+     * @return The snapshot'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);
+        let source = this._data;
+        if (parts.length) {
+            for (const part of parts) {
+                source = source[part];
+            }
+        }
+        const node = source !== null && source !== void 0 ? source : null;
         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`).
      */
@@ -126,7 +140,14 @@ class DataSnapshot {
      * @return `true` if this `DataSnapshot` contains any data; otherwise, `false`.
      */
     exists() {
-        return !_.isNull(this.val());
+        const val = this.val();
+        if (!val || val === null) {
+            return false;
+        }
+        if (typeof val === "object" && Object.keys(val).length === 0) {
+            return false;
+        }
+        return true;
     }
     /**
      * Gets a `DataSnapshot` for the location at the specified relative path.
@@ -151,22 +172,22 @@ class DataSnapshot {
      * 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.
+     * can 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`.
+     * @param action A function that is 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);
+        const val = this.val() || {};
+        if (typeof val === "object") {
+            return Object.keys(val).some((key) => action(this.child(key)) === true);
         }
         return false;
     }
@@ -187,14 +208,14 @@ class DataSnapshot {
      * 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
+     * retrieved with `val()`) or it is empty (in which case, `val()` returns
      * `null`).
      *
      * @return `true` if this snapshot has any children; else `false`.
      */
     hasChildren() {
         const val = this.val();
-        return _.isPlainObject(val) && _.keys(val).length > 0;
+        return val !== null && typeof val === "object" && Object.keys(val).length > 0;
     }
     /**
      * Returns the number of child properties of this `DataSnapshot`.
@@ -203,7 +224,7 @@ class DataSnapshot {
      */
     numChildren() {
         const val = this.val();
-        return _.isPlainObject(val) ? Object.keys(val).length : 0;
+        return val !== null && typeof val === "object" ? Object.keys(val).length : 0;
     }
     /**
      * Returns a JSON-serializable representation of this object.
@@ -218,10 +239,10 @@ class DataSnapshot {
      * @hidden
      */
     _checkAndConvertToArray(node) {
-        if (node === null || typeof node === 'undefined') {
+        if (node === null || typeof node === "undefined") {
             return null;
         }
-        if (typeof node !== 'object') {
+        if (typeof node !== "object") {
             return node;
         }
         const obj = {};
@@ -233,7 +254,12 @@ class DataSnapshot {
                 continue;
             }
             const childNode = node[key];
-            obj[key] = this._checkAndConvertToArray(childNode);
+            const v = this._checkAndConvertToArray(childNode);
+            if (v === null) {
+                // Empty child node
+                continue;
+            }
+            obj[key] = v;
             numKeys++;
             const integerRegExp = /^(0|[1-9]\d*)$/;
             if (allIntegerKeys && integerRegExp.test(key)) {
@@ -243,12 +269,16 @@ class DataSnapshot {
                 allIntegerKeys = false;
             }
         }
+        if (numKeys === 0) {
+            // Empty node
+            return null;
+        }
         if (allIntegerKeys && maxKey < 2 * numKeys) {
             // convert to array.
             const array = [];
-            _.forOwn(obj, (val, key) => {
-                array[key] = val;
-            });
+            for (const key of Object.keys(obj)) {
+                array[key] = obj[key];
+            }
             return array;
         }
         return obj;
@@ -264,8 +294,7 @@ class DataSnapshot {
     }
     /** @hidden */
     _fullPath() {
-        const out = (this._path || '') + '/' + (this._childPath || '');
-        return out;
+        return (this._path || "") + "/" + (this._childPath || "");
     }
 }
 exports.DataSnapshot = DataSnapshot;

package/lib/common/providers/https.d.ts

@@ -1,54 +1,13 @@
 /// <reference types="node" />
-import * as express from 'express';
-import * as firebase from 'firebase-admin';
-import { TaskContext } from './tasks';
-/** @hidden */
+import * as express from "express";
+import { DecodedAppCheckToken } from "firebase-admin/app-check";
+import { DecodedIdToken } from "firebase-admin/auth";
+import { TaskContext } from "./tasks";
+/** An express request with the wire format representation of the request body. */
 export interface Request extends express.Request {
     /** The wire format representation of the request body. */
     rawBody: Buffer;
 }
-interface DecodedAppCheckToken {
-    /**
-     * The issuer identifier for the issuer of the response.
-     *
-     * This value is a URL with the format
-     * `https://firebaseappcheck.googleapis.com/<PROJECT_NUMBER>`, where `<PROJECT_NUMBER>` is the
-     * same project number specified in the [`aud`](#aud) property.
-     */
-    iss: string;
-    /**
-     * The Firebase App ID corresponding to the app the token belonged to.
-     *
-     * As a convenience, this value is copied over to the [`app_id`](#app_id) property.
-     */
-    sub: string;
-    /**
-     * The audience for which this token is intended.
-     *
-     * This value is a JSON array of two strings, the first is the project number of your
-     * Firebase project, and the second is the project ID of the same project.
-     */
-    aud: string[];
-    /**
-     * The App Check token's expiration time, in seconds since the Unix epoch. That is, the
-     * time at which this App Check token expires and should no longer be considered valid.
-     */
-    exp: number;
-    /**
-     * The App Check token's issued-at time, in seconds since the Unix epoch. That is, the
-     * time at which this App Check token was issued and should start to be considered
-     * valid.;
-     */
-    iat: number;
-    /**
-     * The App ID corresponding to the App the App Check token belonged to.
-     *
-     * This value is not actually one of the JWT token claims. It is added as a
-     * convenience, and is set as the value of the [`sub`](#sub) property.
-     */
-    app_id: string;
-    [key: string]: any;
-}
 /**
  * The interface for AppCheck tokens verified in Callable functions
  */
@@ -61,7 +20,7 @@ export interface AppCheckData {
  */
 export interface AuthData {
     uid: string;
-    token: firebase.auth.DecodedIdToken;
+    token: DecodedIdToken;
 }
 /**
  * The interface for metadata for the API as passed to the handler.
@@ -111,9 +70,9 @@ export interface CallableRequest<T = any> {
 }
 /**
  * The set of Firebase Functions status codes. The codes are the same at the
- * ones exposed by gRPC here:
- * https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
+ * ones exposed by {@link https://github.com/grpc/grpc/blob/master/doc/statuscodes.md | gRPC}.
  *
+ * @remarks
  * Possible values:
  *
  * - `cancelled`: The operation was cancelled (typically by the caller).
@@ -164,9 +123,9 @@ export interface CallableRequest<T = any> {
  * - `unauthenticated`: The request does not have valid authentication
  *   credentials for the operation.
  */
-export declare type FunctionsErrorCode = 'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';
+export declare type FunctionsErrorCode = "ok" | "cancelled" | "unknown" | "invalid-argument" | "deadline-exceeded" | "not-found" | "already-exists" | "permission-denied" | "resource-exhausted" | "failed-precondition" | "aborted" | "out-of-range" | "unimplemented" | "internal" | "unavailable" | "data-loss" | "unauthenticated";
 /** @hidden */
-export declare type CanonicalErrorCodeName = 'OK' | 'CANCELLED' | 'UNKNOWN' | 'INVALID_ARGUMENT' | 'DEADLINE_EXCEEDED' | 'NOT_FOUND' | 'ALREADY_EXISTS' | 'PERMISSION_DENIED' | 'UNAUTHENTICATED' | 'RESOURCE_EXHAUSTED' | 'FAILED_PRECONDITION' | 'ABORTED' | 'OUT_OF_RANGE' | 'UNIMPLEMENTED' | 'INTERNAL' | 'UNAVAILABLE' | 'DATA_LOSS';
+export declare type CanonicalErrorCodeName = "OK" | "CANCELLED" | "UNKNOWN" | "INVALID_ARGUMENT" | "DEADLINE_EXCEEDED" | "NOT_FOUND" | "ALREADY_EXISTS" | "PERMISSION_DENIED" | "UNAUTHENTICATED" | "RESOURCE_EXHAUSTED" | "FAILED_PRECONDITION" | "ABORTED" | "OUT_OF_RANGE" | "UNIMPLEMENTED" | "INTERNAL" | "UNAVAILABLE" | "DATA_LOSS";
 /** @hidden */
 interface HttpErrorCode {
     canonicalName: CanonicalErrorCodeName;
@@ -232,7 +191,7 @@ export declare function decode(data: any): any;
  *
  */
 /** @hidden */
-declare type TokenStatus = 'MISSING' | 'VALID' | 'INVALID';
+declare type TokenStatus = "MISSING" | "VALID" | "INVALID";
 /** @interanl */
 export declare function checkAuthToken(req: Request, ctx: CallableContext | TaskContext): Promise<TokenStatus>;
 export {};