firebase-functions 3.24.1 → 4.0.0-rc.0

package/lib/{providers → v1/providers}/database.js

@@ -22,23 +22,24 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 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");
+const app_1 = require("../../common/app");
+const config_1 = require("../../common/config");
+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");
-/** @hidden */
-exports.provider = 'google.firebase.database';
-/** @hidden */
-exports.service = 'firebaseio.com';
-const databaseURLRegex = new RegExp('^https://([^.]+).');
-const emulatorDatabaseURLRegex = new RegExp('^http://.*ns=([^&]+)');
+const path_1 = require("../../common/utilities/path");
+const utils_1 = require("../../common/utilities/utils");
+const cloud_functions_1 = require("../cloud-functions");
+/** @internal */
+exports.provider = "google.firebase.database";
+/** @internal */
+exports.service = "firebaseio.com";
+const databaseURLRegex = new RegExp("^https://([^.]+).");
+const emulatorDatabaseURLRegex = new RegExp("^http://.*ns=([^&]+)");
 /**
  * Registers a function that triggers on events from a specific
  * Firebase Realtime Database instance.
  *
+ * @remarks
  * Use this method together with `ref` to specify the instance on which to
  * watch for database events. For example: `firebase.database.instance('my-app-db-2').ref('/foo/bar')`
  *
@@ -47,7 +48,7 @@ const emulatorDatabaseURLRegex = new RegExp('^http://.*ns=([^&]+)');
  *
  * @param instance The instance name of the database instance
  *   to watch for write events.
- * @return Firebase Realtime Database instance builder interface.
+ * @returns Firebase Realtime Database instance builder interface.
  */
 function instance(instance) {
     return _instanceWithOptions(instance, {});
@@ -57,6 +58,7 @@ exports.instance = instance;
  * Registers a function that triggers on Firebase Realtime Database write
  * events.
  *
+ * @remarks
  * This method behaves very similarly to the method of the same name in the
  * client and Admin Firebase SDKs. Any change to the Database that affects the
  * data at or below the provided `path` will fire an event in Cloud Functions.
@@ -64,6 +66,7 @@ exports.instance = instance;
  * There are three important differences between listening to a Realtime
  * Database event in Cloud Functions and using the Realtime Database in the
  * client and Admin SDKs:
+ *
  * 1. Cloud Functions allows wildcards in the `path` name. Any `path` component
  *    in curly brackets (`{}`) is a wildcard that matches all strings. The value
  *    that matched a certain invocation of a Cloud Function is returned as part
@@ -72,20 +75,22 @@ exports.instance = instance;
  *    `/messages/message1` or `/messages/message2`, resulting in
  *    `event.params.messageId` being set to `"message1"` or `"message2"`,
  *    respectively.
+ *
  * 2. Cloud Functions do not fire an event for data that already existed before
  *    the Cloud Function was deployed.
+ *
  * 3. Cloud Function events have access to more information, including a
  *    snapshot of the previous event data and information about the user who
  *    triggered the Cloud Function.
  *
  * @param path The path within the Database to watch for write events.
- * @return Firebase Realtime Database builder interface.
+ * @returns Firebase Realtime Database builder interface.
  */
 function ref(path) {
     return _refWithOptions(path, {});
 }
 exports.ref = ref;
-/** @hidden */
+/** @internal */
 function _instanceWithOptions(instance, options) {
     return new InstanceBuilder(instance, options);
 }
@@ -96,30 +101,29 @@ exports._instanceWithOptions = _instanceWithOptions;
  * Access via [`database.instance()`](providers_database_.html#instance).
  */
 class InstanceBuilder {
-    /** @hidden */
     constructor(instance, options) {
         this.instance = instance;
         this.options = options;
     }
     /**
-     * @return Firebase Realtime Database reference builder interface.
+     * @returns Firebase Realtime Database reference builder interface.
      */
     ref(path) {
         const normalized = (0, path_1.normalizePath)(path);
-        return new RefBuilder((0, apps_1.apps)(), () => `projects/_/instances/${this.instance}/refs/${normalized}`, this.options);
+        return new RefBuilder(() => `projects/_/instances/${this.instance}/refs/${normalized}`, this.options);
     }
 }
 exports.InstanceBuilder = InstanceBuilder;
-/** @hidden */
+/** @internal */
 function _refWithOptions(path, options) {
     const resourceGetter = () => {
         const normalized = (0, path_1.normalizePath)(path);
         const databaseURL = (0, config_1.firebaseConfig)().databaseURL;
         if (!databaseURL) {
-            throw new Error('Missing expected firebase config value databaseURL, ' +
-                'config is actually' +
+            throw new Error("Missing expected firebase config value databaseURL, " +
+                "config is actually" +
                 JSON.stringify((0, config_1.firebaseConfig)()) +
-                '\n If you are unit testing, please set process.env.FIREBASE_CONFIG');
+                "\n If you are unit testing, please set process.env.FIREBASE_CONFIG");
         }
         let instance;
         const prodMatch = databaseURL.match(databaseURLRegex);
@@ -133,11 +137,11 @@ function _refWithOptions(path, options) {
             }
         }
         if (!instance) {
-            throw new Error('Invalid value for config firebase.databaseURL: ' + databaseURL);
+            throw new Error("Invalid value for config firebase.databaseURL: " + databaseURL);
         }
         return `projects/_/instances/${instance}/refs/${normalized}`;
     };
-    return new RefBuilder((0, apps_1.apps)(), resourceGetter, options);
+    return new RefBuilder(resourceGetter, options);
 }
 exports._refWithOptions = _refWithOptions;
 /**
@@ -146,15 +150,13 @@ exports._refWithOptions = _refWithOptions;
  * Access via [`functions.database.ref()`](functions.database#.ref).
  */
 class RefBuilder {
-    /** @hidden */
-    constructor(apps, triggerResource, options) {
-        this.apps = apps;
+    constructor(triggerResource, options) {
         this.triggerResource = triggerResource;
         this.options = options;
         this.changeConstructor = (raw) => {
             const [dbInstance, path] = extractInstanceAndPath(raw.context.resource.name, raw.context.domain);
-            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);
+            const before = new database_1.DataSnapshot(raw.data.data, path, (0, app_1.getApp)(), dbInstance);
+            const after = new database_1.DataSnapshot((0, utils_1.applyChange)(raw.data.data, raw.data.delta), path, (0, app_1.getApp)(), dbInstance);
             return {
                 before,
                 after,
@@ -167,10 +169,10 @@ class RefBuilder {
      *
      * @param handler Event handler that runs every time a Firebase Realtime Database
      *   write occurs.
-     * @return A Cloud Function that you can export and deploy.
+     * @returns A function that you can export and deploy.
      */
     onWrite(handler) {
-        return this.onOperation(handler, 'ref.write', this.changeConstructor);
+        return this.onOperation(handler, "ref.write", this.changeConstructor);
     }
     /**
      * Event handler that fires every time data is updated in
@@ -178,11 +180,10 @@ class RefBuilder {
      *
      * @param handler Event handler which is run every time a Firebase Realtime Database
      *   write occurs.
-     * @return A Cloud
-     *   Function which you can export and deploy.
+     * @returns A function which you can export and deploy.
      */
     onUpdate(handler) {
-        return this.onOperation(handler, 'ref.update', this.changeConstructor);
+        return this.onOperation(handler, "ref.update", this.changeConstructor);
     }
     /**
      * Event handler that fires every time new data is created in
@@ -190,14 +191,14 @@ class RefBuilder {
      *
      * @param handler Event handler that runs every time new data is created in
      *   Firebase Realtime Database.
-     * @return A Cloud Function that you can export and deploy.
+     * @returns A function that you can export and deploy.
      */
     onCreate(handler) {
         const dataConstructor = (raw) => {
             const [dbInstance, path] = extractInstanceAndPath(raw.context.resource.name, raw.context.domain);
-            return new database_1.DataSnapshot(raw.data.delta, path, this.apps.admin, dbInstance);
+            return new database_1.DataSnapshot(raw.data.delta, path, (0, app_1.getApp)(), dbInstance);
         };
-        return this.onOperation(handler, 'ref.create', dataConstructor);
+        return this.onOperation(handler, "ref.create", dataConstructor);
     }
     /**
      * Event handler that fires every time data is deleted from
@@ -205,14 +206,14 @@ class RefBuilder {
      *
      * @param handler Event handler that runs every time data is deleted from
      *   Firebase Realtime Database.
-     * @return A Cloud Function that you can export and deploy.
+     * @returns A function that you can export and deploy.
      */
     onDelete(handler) {
         const dataConstructor = (raw) => {
             const [dbInstance, path] = extractInstanceAndPath(raw.context.resource.name, raw.context.domain);
-            return new database_1.DataSnapshot(raw.data.data, path, this.apps.admin, dbInstance);
+            return new database_1.DataSnapshot(raw.data.data, path, (0, app_1.getApp)(), dbInstance);
         };
-        return this.onOperation(handler, 'ref.delete', dataConstructor);
+        return this.onOperation(handler, "ref.delete", dataConstructor);
     }
     onOperation(handler, eventType, dataConstructor) {
         return (0, cloud_functions_1.makeCloudFunction)({
@@ -223,8 +224,6 @@ class RefBuilder {
             legacyEventType: `providers/${exports.provider}/eventTypes/${eventType}`,
             triggerResource: this.triggerResource,
             dataConstructor,
-            before: (event) => this.apps.retain(),
-            after: (event) => this.apps.release(),
             options: this.options,
         });
     }
@@ -238,16 +237,17 @@ const resourceRegex = /^projects\/([^/]+)\/instances\/([a-zA-Z0-9-]+)\/refs(\/.+
  *    It defaults to `firebaseio.com`.
  *    Multi-region RTDB will be served from different domains.
  *    Since region is not part of the resource name, it is provided through context.
+ *
+ * @internal
  */
-/** @hidden */
-function extractInstanceAndPath(resource, domain = 'firebaseio.com') {
+function extractInstanceAndPath(resource, domain = "firebaseio.com") {
     const match = resource.match(new RegExp(resourceRegex));
     if (!match) {
         throw new Error(`Unexpected resource string for Firebase Realtime Database event: ${resource}. ` +
             'Expected string in the format of "projects/_/instances/{firebaseioSubdomain}/refs/{ref=**}"');
     }
     const [, project, dbInstanceName, path] = match;
-    if (project !== '_') {
+    if (project !== "_") {
         throw new Error(`Expect project to be '_' in a Firebase Realtime Database event`);
     }
     const emuHost = process.env.FIREBASE_DATABASE_EMULATOR_HOST;
@@ -256,7 +256,7 @@ function extractInstanceAndPath(resource, domain = 'firebaseio.com') {
         return [dbInstance, path];
     }
     else {
-        const dbInstance = 'https://' + dbInstanceName + '.' + domain;
+        const dbInstance = "https://" + dbInstanceName + "." + domain;
         return [dbInstance, path];
     }
 }

package/lib/{providers → v1/providers}/firestore.d.ts

@@ -1,15 +1,10 @@
-import * as firebase from 'firebase-admin';
-import { CloudFunction, Event, EventContext } from '../cloud-functions';
-import { Change } from '../common/change';
-import { DeploymentOptions } from '../function-configuration';
-/** @hidden */
-export declare const provider = "google.firestore";
-/** @hidden */
-export declare const service = "firestore.googleapis.com";
-/** @hidden */
-export declare const defaultDatabase = "(default)";
-export declare type DocumentSnapshot = firebase.firestore.DocumentSnapshot;
-export declare type QueryDocumentSnapshot = firebase.firestore.QueryDocumentSnapshot;
+import * as firestore from "firebase-admin/firestore";
+import { Change } from "../../common/change";
+import { ParamsOf } from "../../common/params";
+import { CloudFunction, Event, EventContext } from "../cloud-functions";
+import { DeploymentOptions } from "../function-configuration";
+export declare type DocumentSnapshot = firestore.DocumentSnapshot;
+export declare type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;
 /**
  * Select the Firestore document to listen to for events.
  * @param path Full database path to listen to. This includes the name of
@@ -17,49 +12,36 @@ export declare type QueryDocumentSnapshot = firebase.firestore.QueryDocumentSnap
  * collection is named "users" and the document is named "Ada", then the
  * path is "/users/Ada".
  */
-export declare function document(path: string): DocumentBuilder;
-/** @hidden */
+export declare function document<Path extends string>(path: Path): DocumentBuilder<Path>;
 export declare function namespace(namespace: string): NamespaceBuilder;
-/** @hidden */
 export declare function database(database: string): DatabaseBuilder;
-/** @hidden */
-export declare function _databaseWithOptions(database: string, options: DeploymentOptions): DatabaseBuilder;
-/** @hidden */
-export declare function _namespaceWithOptions(namespace: string, options: DeploymentOptions): NamespaceBuilder;
-/** @hidden */
-export declare function _documentWithOptions(path: string, options: DeploymentOptions): DocumentBuilder;
 export declare class DatabaseBuilder {
     private database;
     private options;
-    /** @hidden */
     constructor(database: string, options: DeploymentOptions);
     namespace(namespace: string): NamespaceBuilder;
-    document(path: string): DocumentBuilder;
+    document<Path extends string>(path: Path): DocumentBuilder<Path>;
 }
 export declare class NamespaceBuilder {
     private database;
     private options;
     private namespace?;
-    /** @hidden */
     constructor(database: string, options: DeploymentOptions, namespace?: string);
-    document(path: string): DocumentBuilder;
+    document<Path extends string>(path: Path): DocumentBuilder<Path>;
 }
-/** @hidden */
 export declare function snapshotConstructor(event: Event): DocumentSnapshot;
-/** @hidden */
 export declare function beforeSnapshotConstructor(event: Event): DocumentSnapshot;
-export declare class DocumentBuilder {
+export declare class DocumentBuilder<Path extends string> {
     private triggerResource;
     private options;
-    /** @hidden */
     constructor(triggerResource: () => string, options: DeploymentOptions);
     /** Respond to all document writes (creates, updates, or deletes). */
-    onWrite(handler: (change: Change<DocumentSnapshot>, context: EventContext) => PromiseLike<any> | any): CloudFunction<Change<DocumentSnapshot>>;
+    onWrite(handler: (change: Change<DocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<DocumentSnapshot>>;
     /** Respond only to document updates. */
-    onUpdate(handler: (change: Change<QueryDocumentSnapshot>, context: EventContext) => PromiseLike<any> | any): CloudFunction<Change<QueryDocumentSnapshot>>;
+    onUpdate(handler: (change: Change<QueryDocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<QueryDocumentSnapshot>>;
     /** Respond only to document creations. */
-    onCreate(handler: (snapshot: QueryDocumentSnapshot, context: EventContext) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
+    onCreate(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
     /** Respond only to document deletions. */
-    onDelete(handler: (snapshot: QueryDocumentSnapshot, context: EventContext) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
+    onDelete(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
     private onOperation;
 }

package/lib/{providers → v1/providers}/firestore.js

@@ -22,20 +22,19 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocumentBuilder = exports.beforeSnapshotConstructor = exports.snapshotConstructor = exports.NamespaceBuilder = exports.DatabaseBuilder = exports._documentWithOptions = exports._namespaceWithOptions = exports._databaseWithOptions = exports.database = exports.namespace = exports.document = exports.defaultDatabase = exports.service = exports.provider = void 0;
-const firebase = require("firebase-admin");
-const _ = require("lodash");
+const firestore = require("firebase-admin/firestore");
 const path_1 = require("path");
-const apps_1 = require("../apps");
+const app_1 = require("../../common/app");
+const change_1 = require("../../common/change");
+const encoder_1 = require("../../common/utilities/encoder");
+const logger = require("../../logger");
 const cloud_functions_1 = require("../cloud-functions");
-const change_1 = require("../common/change");
-const encoder_1 = require("../encoder");
-const logger = require("../logger");
-/** @hidden */
-exports.provider = 'google.firestore';
-/** @hidden */
-exports.service = 'firestore.googleapis.com';
-/** @hidden */
-exports.defaultDatabase = '(default)';
+/** @internal */
+exports.provider = "google.firestore";
+/** @internal */
+exports.service = "firestore.googleapis.com";
+/** @internal */
+exports.defaultDatabase = "(default)";
 let firestoreInstance;
 /**
  * Select the Firestore document to listen to for events.
@@ -48,35 +47,32 @@ function document(path) {
     return _documentWithOptions(path, {});
 }
 exports.document = document;
-/** @hidden */
 // Multiple namespaces are not yet supported by Firestore.
 function namespace(namespace) {
     return _namespaceWithOptions(namespace, {});
 }
 exports.namespace = namespace;
-/** @hidden */
 // Multiple databases are not yet supported by Firestore.
 function database(database) {
     return _databaseWithOptions(database, {});
 }
 exports.database = database;
-/** @hidden */
+/** @internal */
 function _databaseWithOptions(database = exports.defaultDatabase, options) {
     return new DatabaseBuilder(database, options);
 }
 exports._databaseWithOptions = _databaseWithOptions;
-/** @hidden */
+/** @internal */
 function _namespaceWithOptions(namespace, options) {
     return _databaseWithOptions(exports.defaultDatabase, options).namespace(namespace);
 }
 exports._namespaceWithOptions = _namespaceWithOptions;
-/** @hidden */
+/** @internal */
 function _documentWithOptions(path, options) {
     return _databaseWithOptions(exports.defaultDatabase, options).document(path);
 }
 exports._documentWithOptions = _documentWithOptions;
 class DatabaseBuilder {
-    /** @hidden */
     constructor(database, options) {
         this.database = database;
         this.options = options;
@@ -90,7 +86,6 @@ class DatabaseBuilder {
 }
 exports.DatabaseBuilder = DatabaseBuilder;
 class NamespaceBuilder {
-    /** @hidden */
     constructor(database, options, namespace) {
         this.database = database;
         this.options = options;
@@ -99,59 +94,60 @@ class NamespaceBuilder {
     document(path) {
         return new DocumentBuilder(() => {
             if (!process.env.GCLOUD_PROJECT) {
-                throw new Error('process.env.GCLOUD_PROJECT is not set.');
+                throw new Error("process.env.GCLOUD_PROJECT is not set.");
             }
-            const database = path_1.posix.join('projects', process.env.GCLOUD_PROJECT, 'databases', this.database);
-            return path_1.posix.join(database, this.namespace ? `documents@${this.namespace}` : 'documents', path);
+            const database = path_1.posix.join("projects", process.env.GCLOUD_PROJECT, "databases", this.database);
+            return path_1.posix.join(database, this.namespace ? `documents@${this.namespace}` : "documents", path);
         }, this.options);
     }
 }
 exports.NamespaceBuilder = NamespaceBuilder;
 function _getValueProto(data, resource, valueFieldName) {
-    if (_.isEmpty(_.get(data, valueFieldName))) {
+    const value = data === null || data === void 0 ? void 0 : data[valueFieldName];
+    if (typeof value === "undefined" ||
+        value === null ||
+        (typeof value === "object" && !Object.keys(value).length)) {
         // Firestore#snapshot_ takes resource string instead of proto for a non-existent snapshot
         return resource;
     }
     const proto = {
-        fields: _.get(data, [valueFieldName, 'fields'], {}),
-        createTime: (0, encoder_1.dateToTimestampProto)(_.get(data, [valueFieldName, 'createTime'])),
-        updateTime: (0, encoder_1.dateToTimestampProto)(_.get(data, [valueFieldName, 'updateTime'])),
-        name: _.get(data, [valueFieldName, 'name'], resource),
+        fields: (value === null || value === void 0 ? void 0 : value.fields) || {},
+        createTime: (0, encoder_1.dateToTimestampProto)(value === null || value === void 0 ? void 0 : value.createTime),
+        updateTime: (0, encoder_1.dateToTimestampProto)(value === null || value === void 0 ? void 0 : value.updateTime),
+        name: (value === null || value === void 0 ? void 0 : value.name) || resource,
     };
     return proto;
 }
-/** @hidden */
 function snapshotConstructor(event) {
-    var _a;
+    var _a, _b, _c, _d, _e;
     if (!firestoreInstance) {
-        firestoreInstance = firebase.firestore((0, apps_1.apps)().admin);
+        firestoreInstance = firestore.getFirestore((0, app_1.getApp)());
     }
-    const valueProto = _getValueProto(event.data, event.context.resource.name, 'value');
-    let timeString = (_a = _.get(event, 'data.value.readTime')) !== null && _a !== void 0 ? _a : _.get(event, 'data.value.updateTime');
+    const valueProto = _getValueProto(event.data, event.context.resource.name, "value");
+    let timeString = (_c = (_b = (_a = event === null || event === void 0 ? void 0 : event.data) === null || _a === void 0 ? void 0 : _a.value) === null || _b === void 0 ? void 0 : _b.readTime) !== null && _c !== void 0 ? _c : (_e = (_d = event === null || event === void 0 ? void 0 : event.data) === null || _d === void 0 ? void 0 : _d.value) === null || _e === void 0 ? void 0 : _e.updateTime;
     if (!timeString) {
-        logger.warn('Snapshot has no readTime. Using now()');
+        logger.warn("Snapshot has no readTime. Using now()");
         timeString = new Date().toISOString();
     }
     const readTime = (0, encoder_1.dateToTimestampProto)(timeString);
-    return firestoreInstance.snapshot_(valueProto, readTime, 'json');
+    return firestoreInstance.snapshot_(valueProto, readTime, "json");
 }
 exports.snapshotConstructor = snapshotConstructor;
-/** @hidden */
 // TODO remove this function when wire format changes to new format
 function beforeSnapshotConstructor(event) {
+    var _a, _b;
     if (!firestoreInstance) {
-        firestoreInstance = firebase.firestore((0, apps_1.apps)().admin);
+        firestoreInstance = firestore.getFirestore((0, app_1.getApp)());
     }
-    const oldValueProto = _getValueProto(event.data, event.context.resource.name, 'oldValue');
-    const oldReadTime = (0, encoder_1.dateToTimestampProto)(_.get(event, 'data.oldValue.readTime'));
-    return firestoreInstance.snapshot_(oldValueProto, oldReadTime, 'json');
+    const oldValueProto = _getValueProto(event.data, event.context.resource.name, "oldValue");
+    const oldReadTime = (0, encoder_1.dateToTimestampProto)((_b = (_a = event === null || event === void 0 ? void 0 : event.data) === null || _a === void 0 ? void 0 : _a.oldValue) === null || _b === void 0 ? void 0 : _b.readTime);
+    return firestoreInstance.snapshot_(oldValueProto, oldReadTime, "json");
 }
 exports.beforeSnapshotConstructor = beforeSnapshotConstructor;
 function changeConstructor(raw) {
     return change_1.Change.fromObjects(beforeSnapshotConstructor(raw), snapshotConstructor(raw));
 }
 class DocumentBuilder {
-    /** @hidden */
     constructor(triggerResource, options) {
         this.triggerResource = triggerResource;
         this.options = options;
@@ -159,19 +155,19 @@ class DocumentBuilder {
     }
     /** Respond to all document writes (creates, updates, or deletes). */
     onWrite(handler) {
-        return this.onOperation(handler, 'document.write', changeConstructor);
+        return this.onOperation(handler, "document.write", changeConstructor);
     }
     /** Respond only to document updates. */
     onUpdate(handler) {
-        return this.onOperation(handler, 'document.update', changeConstructor);
+        return this.onOperation(handler, "document.update", changeConstructor);
     }
     /** Respond only to document creations. */
     onCreate(handler) {
-        return this.onOperation(handler, 'document.create', snapshotConstructor);
+        return this.onOperation(handler, "document.create", snapshotConstructor);
     }
     /** Respond only to document deletions. */
     onDelete(handler) {
-        return this.onOperation(handler, 'document.delete', beforeSnapshotConstructor);
+        return this.onOperation(handler, "document.delete", beforeSnapshotConstructor);
     }
     onOperation(handler, eventType, dataConstructor) {
         return (0, cloud_functions_1.makeCloudFunction)({

package/lib/{providers → v1/providers}/https.d.ts

@@ -1,7 +1,6 @@
-import * as express from 'express';
-import { HttpsFunction, Runnable } from '../cloud-functions';
-import { CallableContext, FunctionsErrorCode, HttpsError, Request } from '../common/providers/https';
-import { DeploymentOptions } from '../function-configuration';
+import * as express from "express";
+import { CallableContext, FunctionsErrorCode, HttpsError, Request } from "../../common/providers/https";
+import { HttpsFunction, Runnable } from "../cloud-functions";
 export { Request, CallableContext, FunctionsErrorCode, HttpsError };
 /**
  * Handle HTTP requests.
@@ -14,7 +13,3 @@ export declare function onRequest(handler: (req: Request, resp: express.Response
  * @param handler A method that takes a data and context and returns a value.
  */
 export declare function onCall(handler: (data: any, context: CallableContext) => any | Promise<any>): HttpsFunction & Runnable<any>;
-/** @hidden */
-export declare function _onRequestWithOptions(handler: (req: Request, resp: express.Response) => void | Promise<void>, options: DeploymentOptions): HttpsFunction;
-/** @hidden */
-export declare function _onCallWithOptions(handler: (data: any, context: CallableContext) => any | Promise<any>, options: DeploymentOptions): HttpsFunction & Runnable<any>;

package/lib/{providers → v1/providers}/https.js

@@ -22,10 +22,11 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports._onCallWithOptions = exports._onRequestWithOptions = exports.onCall = exports.onRequest = exports.HttpsError = void 0;
-const cloud_functions_1 = require("../cloud-functions");
-const encoding_1 = require("../common/encoding");
-const https_1 = require("../common/providers/https");
+const encoding_1 = require("../../common/encoding");
+const https_1 = require("../../common/providers/https");
 Object.defineProperty(exports, "HttpsError", { enumerable: true, get: function () { return https_1.HttpsError; } });
+const cloud_functions_1 = require("../cloud-functions");
+const manifest_1 = require("../../runtime/manifest");
 /**
  * Handle HTTP requests.
  * @param handler A function that takes a request and response object,
@@ -43,46 +44,37 @@ function onCall(handler) {
     return _onCallWithOptions(handler, {});
 }
 exports.onCall = onCall;
-/** @hidden */
+/** @internal */
 function _onRequestWithOptions(handler, options) {
-    // lets us add __trigger without altering handler:
+    // lets us add __endpoint without altering handler:
     const cloudFunction = (req, res) => {
         return handler(req, res);
     };
-    cloudFunction.__trigger = {
-        ...(0, cloud_functions_1.optionsToTrigger)(options),
-        httpsTrigger: {},
-    };
-    (0, encoding_1.convertIfPresent)(cloudFunction.__trigger.httpsTrigger, options, 'invoker', 'invoker', encoding_1.convertInvoker);
     // TODO parse the options
     cloudFunction.__endpoint = {
-        platform: 'gcfv1',
+        platform: "gcfv1",
+        ...(0, manifest_1.initV1Endpoint)(options),
         ...(0, cloud_functions_1.optionsToEndpoint)(options),
         httpsTrigger: {},
     };
-    (0, encoding_1.convertIfPresent)(cloudFunction.__endpoint.httpsTrigger, options, 'invoker', 'invoker', encoding_1.convertInvoker);
+    (0, encoding_1.convertIfPresent)(cloudFunction.__endpoint.httpsTrigger, options, "invoker", "invoker", encoding_1.convertInvoker);
     return cloudFunction;
 }
 exports._onRequestWithOptions = _onRequestWithOptions;
-/** @hidden */
+/** @internal */
 function _onCallWithOptions(handler, options) {
     // onCallHandler sniffs the function length of the passed-in callback
     // and the user could have only tried to listen to data. Wrap their handler
     // in another handler to avoid accidentally triggering the v2 API
     const fixedLen = (data, context) => handler(data, context);
     const func = (0, https_1.onCallHandler)({
-        allowInvalidAppCheckToken: options.allowInvalidAppCheckToken,
-        cors: { origin: true, methods: 'POST' },
+        enforceAppCheck: options.enforceAppCheck,
+        cors: { origin: true, methods: "POST" },
     }, fixedLen);
-    func.__trigger = {
-        labels: {},
-        ...(0, cloud_functions_1.optionsToTrigger)(options),
-        httpsTrigger: {},
-    };
-    func.__trigger.labels['deployment-callable'] = 'true';
     func.__endpoint = {
-        platform: 'gcfv1',
+        platform: "gcfv1",
         labels: {},
+        ...(0, manifest_1.initV1Endpoint)(options),
         ...(0, cloud_functions_1.optionsToEndpoint)(options),
         callableTrigger: {},
     };