firebase-functions 3.24.0 → 4.0.0-rc.0

package/README.md

@@ -23,15 +23,13 @@ _Please avoid double posting across multiple channels!_
 
 ```js
 // functions/index.js
-const functions = require('firebase-functions');
-const notifyUsers = require('./notify-users');
-
-exports.newPost = functions.database
-  .ref('/posts/{postId}')
-  .onCreate((snapshot, context) => {
-    functions.logger.info('Received new post with ID:', context.params.postId);
-    return notifyUsers(snapshot.val());
-  });
+const functions = require("firebase-functions");
+const notifyUsers = require("./notify-users");
+
+exports.newPost = functions.database.ref("/posts/{postId}").onCreate((snapshot, context) => {
+  functions.logger.info("Received new post with ID:", context.params.postId);
+  return notifyUsers(snapshot.val());
+});
 ```
 
 ## Contributing

package/lib/bin/firebase-functions.js

@@ -34,33 +34,31 @@ Arguments:
 `);
     process.exit(1);
 }
-let functionsDir = '.';
+let functionsDir = ".";
 const args = process.argv.slice(2);
 if (args.length > 1) {
-    if (args[0] === '-h' || args[0] === '--help') {
+    if (args[0] === "-h" || args[0] === "--help") {
         printUsageAndExit();
     }
     functionsDir = args[0];
 }
-let server;
+let server = undefined;
 const app = express();
-async function handleQuitquitquit(req, res) {
-    res.send('ok');
-    server.close(() => console.log('shutdown requested via /__/quitquitquit'));
+function handleQuitquitquit(req, res) {
+    res.send("ok");
+    server.close(() => console.log("shutdown requested via /__/quitquitquit"));
 }
-app.get('/__/quitquitquit', handleQuitquitquit);
-app.post('/__/quitquitquit', handleQuitquitquit);
-if (process.env.FUNCTIONS_CONTROL_API === 'true') {
-    app.get('/__/functions.yaml', async (req, res) => {
+app.get("/__/quitquitquit", handleQuitquitquit);
+app.post("/__/quitquitquit", handleQuitquitquit);
+if (process.env.FUNCTIONS_CONTROL_API === "true") {
+    app.get("/__/functions.yaml", async (req, res) => {
         try {
             const stack = await (0, loader_1.loadStack)(functionsDir);
-            res.setHeader('content-type', 'text/yaml');
+            res.setHeader("content-type", "text/yaml");
             res.send(JSON.stringify((0, manifest_1.stackToWire)(stack)));
         }
         catch (e) {
-            res
-                .status(400)
-                .send(`Failed to generate manifest from function source: ${e}`);
+            res.status(400).send(`Failed to generate manifest from function source: ${e}`);
         }
     });
 }
@@ -68,5 +66,5 @@ let port = 8080;
 if (process.env.PORT) {
     port = Number.parseInt(process.env.PORT);
 }
-console.log('Serving at port', port);
+console.log("Serving at port", port);
 server = app.listen(port);

package/lib/common/app.d.ts

@@ -0,0 +1,14 @@
+import { App } from "firebase-admin/app";
+export declare function getApp(): App;
+/**
+ * This function allows the Firebase Emulator Suite to override the FirebaseApp instance
+ * used by the Firebase Functions SDK. Developers should never call this function for
+ * other purposes.
+ * N.B. For clarity for use in testing this name has no mention of emulation, but
+ * it must be exported from index as app.setEmulatedAdminApp or we break the emulator.
+ * We can remove this export when:
+ * A) We complete the new emulator and no longer depend on monkeypatching
+ * B) We tweak the CLI to look for different APIs to monkeypatch depending on versions.
+ * @alpha
+ */
+export declare function setApp(app?: App): void;

package/lib/common/app.js

@@ -0,0 +1,62 @@
+"use strict";
+// The MIT License (MIT)
+//
+// Copyright (c) 2017 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.setApp = exports.getApp = void 0;
+const app_1 = require("firebase-admin/app");
+const config_1 = require("./config");
+const APP_NAME = "__FIREBASE_FUNCTIONS_SDK__";
+let cache;
+function getApp() {
+    if (typeof cache === "undefined") {
+        try {
+            cache = (0, app_1.getApp)( /* default */);
+        }
+        catch {
+            // Default app does not exist. Initialize app.
+            cache = (0, app_1.initializeApp)({
+                ...(0, config_1.firebaseConfig)(),
+                credential: (0, app_1.applicationDefault)(),
+            }, APP_NAME);
+        }
+    }
+    return cache;
+}
+exports.getApp = getApp;
+/**
+ * This function allows the Firebase Emulator Suite to override the FirebaseApp instance
+ * used by the Firebase Functions SDK. Developers should never call this function for
+ * other purposes.
+ * N.B. For clarity for use in testing this name has no mention of emulation, but
+ * it must be exported from index as app.setEmulatedAdminApp or we break the emulator.
+ * We can remove this export when:
+ * A) We complete the new emulator and no longer depend on monkeypatching
+ * B) We tweak the CLI to look for different APIs to monkeypatch depending on versions.
+ * @alpha
+ */
+function setApp(app) {
+    if ((cache === null || cache === void 0 ? void 0 : cache.name) === APP_NAME) {
+        void (0, app_1.deleteApp)(cache);
+    }
+    cache = app;
+}
+exports.setApp = setApp;

package/lib/common/change.d.ts

@@ -12,13 +12,10 @@ export interface ChangeJson {
      */
     before?: any;
     /**
-     * @hidden
      * Comma-separated string that represents names of fields that changed.
      */
     fieldMask?: string;
 }
-/** @hidden */
-export declare function applyFieldMask(sparseBefore: any, after: any, fieldMask: string): any;
 /**
  * The Functions interface for events that change state, such as
  * Realtime Database or Cloud Firestore `onWrite` and `onUpdate`.
@@ -31,13 +28,11 @@ export declare class Change<T> {
     before: T;
     after: T;
     /**
-     * @hidden
      * Factory method for creating a Change from a `before` object and an `after`
      * object.
      */
     static fromObjects<T>(before: T, after: T): Change<T>;
     /**
-     * @hidden
      * Factory method for creating a Change from a JSON and an optional customizer
      * function to be applied to both the `before` and the `after` fields.
      */

package/lib/common/change.js

@@ -22,20 +22,20 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Change = exports.applyFieldMask = void 0;
-/** @hidden */
+/** @internal */
 function applyFieldMask(sparseBefore, after, fieldMask) {
     const before = { ...after };
-    const masks = fieldMask.split(',');
+    const masks = fieldMask.split(",");
     for (const mask of masks) {
-        const parts = mask.split('.');
+        const parts = mask.split(".");
         const head = parts[0];
-        const tail = parts.slice(1).join('.');
+        const tail = parts.slice(1).join(".");
         if (parts.length > 1) {
             before[head] = applyFieldMask(sparseBefore === null || sparseBefore === void 0 ? void 0 : sparseBefore[head], after[head], tail);
             continue;
         }
         const val = sparseBefore === null || sparseBefore === void 0 ? void 0 : sparseBefore[head];
-        if (typeof val === 'undefined') {
+        if (typeof val === "undefined") {
             delete before[mask];
         }
         else {
@@ -59,7 +59,6 @@ class Change {
         this.after = after;
     }
     /**
-     * @hidden
      * Factory method for creating a Change from a `before` object and an `after`
      * object.
      */
@@ -67,7 +66,6 @@ class Change {
         return new Change(before, after);
     }
     /**
-     * @hidden
      * Factory method for creating a Change from a JSON and an optional customizer
      * function to be applied to both the `before` and the `after` fields.
      */

package/lib/common/config.d.ts

@@ -0,0 +1,6 @@
+import { AppOptions } from "firebase-admin/app";
+/**
+ * Get the fields you need to initialize a Firebase app
+ * @alpha
+ */
+export declare function firebaseConfig(): AppOptions | null;

package/lib/common/config.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.firebaseConfig = exports.resetCache = void 0;
+const fs_1 = require("fs");
+const path = require("path");
+const logger = require("../logger");
+let cache = null;
+/**
+ * @internal
+ * @alpha
+ */
+function resetCache(newCache = null) {
+    cache = newCache;
+}
+exports.resetCache = resetCache;
+/**
+ * Get the fields you need to initialize a Firebase app
+ * @alpha
+ */
+function firebaseConfig() {
+    if (cache) {
+        return cache;
+    }
+    let env = process.env.FIREBASE_CONFIG;
+    if (env) {
+        // Firebase Tools will always use a JSON blob in prod, but docs
+        // explicitly state that the user can set the env to a file:
+        // https://firebase.google.com/docs/admin/setup#initialize-without-parameters
+        if (!env.startsWith("{")) {
+            env = (0, fs_1.readFileSync)(path.join(process.env.PWD, env)).toString("utf8");
+        }
+        cache = JSON.parse(env);
+        return cache;
+    }
+    if (process.env.GCLOUD_PROJECT) {
+        logger.warn("Warning, estimating Firebase Config based on GCLOUD_PROJECT. Initializing firebase-admin may fail");
+        cache = {
+            databaseURL: process.env.DATABASE_URL || `https://${process.env.GCLOUD_PROJECT}.firebaseio.com`,
+            storageBucket: process.env.STORAGE_BUCKET_URL || `${process.env.GCLOUD_PROJECT}.appspot.com`,
+            projectId: process.env.GCLOUD_PROJECT,
+        };
+        return cache;
+    }
+    else {
+        logger.warn("Warning, FIREBASE_CONFIG and GCLOUD_PROJECT environment variables are missing. Initializing firebase-admin will fail");
+    }
+    return null;
+}
+exports.firebaseConfig = firebaseConfig;

package/lib/common/debug.js

@@ -23,14 +23,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isDebugFeatureEnabled = exports.debugFeatureValue = void 0;
 // Do NOT turn on a debug feature in production.
-const debugMode = process.env.FIREBASE_DEBUG_MODE === 'true';
+const debugMode = process.env.FIREBASE_DEBUG_MODE === "true";
 function loadDebugFeatures() {
     if (!debugMode) {
         return {};
     }
     try {
         const obj = JSON.parse(process.env.FIREBASE_DEBUG_FEATURES);
-        if (typeof obj !== 'object') {
+        if (typeof obj !== "object") {
             return {};
         }
         return obj;

package/lib/common/encoding.d.ts

@@ -1,10 +1,3 @@
-/**
- * A type alias used to annotate interfaces as using a google.protobuf.Duration.
- * This type is parsed/encoded as a string of seconds + the "s" prefix.
- */
-export declare type Duration = string;
-/** Get a google.protobuf.Duration for a number of seconds. */
-export declare function durationFromSeconds(s: number): Duration;
 /**
  * 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
@@ -12,5 +5,4 @@ export declare function durationFromSeconds(s: number): Duration;
  */
 export declare function copyIfPresent<Src, Dest>(dest: Dest, src: Src, ...fields: Array<keyof Src & keyof Dest>): void;
 export declare function convertIfPresent<Src, Dest>(dest: Dest, src: Src, destField: keyof Dest, srcField: keyof Src, converter?: (from: any) => any): void;
-export declare function serviceAccountFromShorthand(serviceAccount: string): string | null;
 export declare function convertInvoker(invoker: string | string[]): string[];

package/lib/common/encoding.js

@@ -21,12 +21,8 @@
 // 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;
-/** Get a google.protobuf.Duration for a number of seconds. */
-function durationFromSeconds(s) {
-    return `${s}s`;
-}
-exports.durationFromSeconds = durationFromSeconds;
+exports.convertInvoker = exports.convertIfPresent = exports.copyIfPresent = void 0;
+// Copied from firebase-tools/src/gcp/proto
 /**
  * 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
@@ -56,36 +52,17 @@ function convertIfPresent(dest, src, destField, srcField, converter = (from) =>
     dest[destField] = converter(src[srcField]);
 }
 exports.convertIfPresent = convertIfPresent;
-function serviceAccountFromShorthand(serviceAccount) {
-    if (serviceAccount === 'default') {
-        return null;
-    }
-    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') {
+    if (typeof invoker === "string") {
         invoker = [invoker];
     }
     if (invoker.length === 0) {
-        throw new Error('Invalid option for invoker: Must be a non-empty array.');
+        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.');
+        throw new Error("Invalid option for invoker: Must be a non-empty string.");
     }
-    if (invoker.length > 1 &&
-        invoker.find((inv) => inv === 'public' || inv === 'private')) {
+    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;

package/lib/common/options.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Special configuration type to reset configuration to platform default.
+ *
+ * @alpha
+ */
+export declare class ResetValue {
+    toJSON(): null;
+    private constructor();
+    static getInstance(): ResetValue;
+}
+/**
+ * Special configuration value to reset configuration to platform default.
+ */
+export declare const RESET_VALUE: ResetValue;

package/lib/common/options.js

@@ -0,0 +1,44 @@
+"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.
+/**
+ * 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 value to reset configuration to platform default.
+ */
+exports.RESET_VALUE = ResetValue.getInstance();

package/lib/common/params.d.ts

@@ -0,0 +1,32 @@
+/**
+ * A type that splits literal string S with delimiter D.
+ *
+ * For example Split<"a/b/c", "/"> is ['a' | "b" | "c"]
+ */
+export declare type Split<S extends string, D extends string> = string extends S ? string[] : S extends "" ? [] : S extends `${D}${infer Tail}` ? [...Split<Tail, D>] : S extends `${infer Head}${D}${infer Tail}` ? string extends Head ? [...Split<Tail, D>] : [Head, ...Split<Tail, D>] : [
+    S
+];
+/**
+ * A type that ensure that type S is not null or undefined.
+ */
+export declare type NullSafe<S extends null | undefined | string> = S extends null ? never : S extends undefined ? never : S extends string ? S : never;
+/**
+ * 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".
+ */
+export declare type Extract<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.
+ * For example, ParamsOf<"users/{uid}"> is { uid: string }
+ * ParamsOf<"users/{uid}/logs/{log}"> is { uid: string; log: string }
+ * ParamsOf<"some/static/data"> is {}
+ *
+ * For flexibility reasons, ParamsOf<string> is Record<string, string>
+ */
+export declare type ParamsOf<PathPattern extends string> = string extends PathPattern ? Record<string, string> : {
+    [Key in Extract<Split<NullSafe<PathPattern>, "/">[number]>]: string;
+};

package/lib/common/params.js

@@ -0,0 +1,23 @@
+"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 });

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

@@ -1,8 +1,9 @@
-import * as firebase from 'firebase-admin';
+import { App } from "firebase-admin/app";
+import * as database from "firebase-admin/database";
 /**
- * Interface representing a Firebase Realtime Database data snapshot.
+ * Interface representing a Firebase Realtime database data snapshot.
  */
-export declare class DataSnapshot {
+export declare class DataSnapshot implements database.DataSnapshot {
     private app?;
     instance: string;
     /** @hidden */
@@ -13,23 +14,23 @@ export declare class DataSnapshot {
     private _data;
     /** @hidden */
     private _childPath;
-    constructor(data: any, path?: string, // path will be undefined for the database root
-    app?: firebase.app.App, instance?: string);
+    constructor(data: any, path?: string, // path is undefined for the database root
+    app?: App, instance?: string);
     /**
      * 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(): firebase.database.Reference;
+    get ref(): 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,
+     * 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(): string;
+    get key(): string | null;
     /**
      * Extracts a JavaScript value from a `DataSnapshot`.
      *
@@ -38,16 +39,13 @@ export declare 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(): 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`).
      */
@@ -87,13 +85,13 @@ export declare 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
@@ -115,7 +113,7 @@ export declare 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`.
@@ -132,7 +130,7 @@ export declare class DataSnapshot {
      *
      * @return A JSON-serializable representation of this object.
      */
-    toJSON(): Object;
+    toJSON(): Record<string, unknown>;
     /** Recursive function to check if keys are numeric & convert node object to array if they are
      *
      * @hidden