firebase-functions 3.20.1 → 3.21.0

package/lib/v2/providers/identity.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOpts = exports.beforeOperation = exports.beforeUserSignedIn = exports.beforeUserCreated = exports.HttpsError = void 0;
+const identity_1 = require("../../common/providers/identity");
+Object.defineProperty(exports, "HttpsError", { enumerable: true, get: function () { return identity_1.HttpsError; } });
+const options = require("../options");
+function beforeUserCreated(optsOrHandler, handler) {
+    return beforeOperation('beforeCreate', optsOrHandler, handler);
+}
+exports.beforeUserCreated = beforeUserCreated;
+function beforeUserSignedIn(optsOrHandler, handler) {
+    return beforeOperation('beforeSignIn', optsOrHandler, handler);
+}
+exports.beforeUserSignedIn = beforeUserSignedIn;
+/** @internal */
+function beforeOperation(eventType, optsOrHandler, handler) {
+    if (!handler || typeof optsOrHandler === 'function') {
+        handler = optsOrHandler;
+        optsOrHandler = {};
+    }
+    const { opts, accessToken, idToken, refreshToken } = getOpts(optsOrHandler);
+    // Create our own function that just calls the provided function so we know for sure that
+    // handler takes one argument. This is something common/providers/identity depends on.
+    const wrappedHandler = (event) => handler(event);
+    const func = (0, identity_1.wrapHandler)(eventType, wrappedHandler);
+    const legacyEventType = `providers/cloud.auth/eventTypes/user.${eventType}`;
+    /** Endpoint */
+    const baseOptsEndpoint = options.optionsToEndpoint(options.getGlobalOptions());
+    const specificOptsEndpoint = options.optionsToEndpoint(opts);
+    func.__endpoint = {
+        platform: 'gcfv2',
+        ...baseOptsEndpoint,
+        ...specificOptsEndpoint,
+        labels: {
+            ...baseOptsEndpoint === null || baseOptsEndpoint === void 0 ? void 0 : baseOptsEndpoint.labels,
+            ...specificOptsEndpoint === null || specificOptsEndpoint === void 0 ? void 0 : specificOptsEndpoint.labels,
+        },
+        blockingTrigger: {
+            eventType: legacyEventType,
+            options: {
+                accessToken,
+                idToken,
+                refreshToken,
+            },
+        },
+    };
+    func.__requiredAPIs = [
+        {
+            api: 'identitytoolkit.googleapis.com',
+            reason: 'Needed for auth blocking functions',
+        },
+    ];
+    func.run = handler;
+    return func;
+}
+exports.beforeOperation = beforeOperation;
+/** @internal */
+function getOpts(blockingOptions) {
+    const accessToken = blockingOptions.accessToken || false;
+    const idToken = blockingOptions.idToken || false;
+    const refreshToken = blockingOptions.refreshToken || false;
+    const opts = { ...blockingOptions };
+    delete opts.accessToken;
+    delete opts.idToken;
+    delete opts.refreshToken;
+    return {
+        opts,
+        accessToken,
+        idToken,
+        refreshToken,
+    };
+}
+exports.getOpts = getOpts;

package/lib/v2/providers/pubsub.d.ts

@@ -1,5 +1,5 @@
-import * as options from '../options';
 import { CloudEvent, CloudFunction } from '../core';
+import * as options from '../options';
 /**
  * Interface representing a Google Cloud Pub/Sub message.
  *
@@ -52,6 +52,6 @@ export interface PubSubOptions extends options.EventHandlerOptions {
     topic: string;
 }
 /** Handle a message being published to a Pub/Sub topic. */
-export declare function onMessagePublished<T = any>(topic: string, handler: (event: CloudEvent<MessagePublishedData<T>>) => any | Promise<any>): CloudFunction<MessagePublishedData<T>>;
+export declare function onMessagePublished<T = any>(topic: string, handler: (event: CloudEvent<MessagePublishedData<T>>) => any | Promise<any>): CloudFunction<CloudEvent<MessagePublishedData<T>>>;
 /** Handle a message being published to a Pub/Sub topic. */
-export declare function onMessagePublished<T = any>(options: PubSubOptions, handler: (event: CloudEvent<MessagePublishedData<T>>) => any | Promise<any>): CloudFunction<MessagePublishedData<T>>;
+export declare function onMessagePublished<T = any>(options: PubSubOptions, handler: (event: CloudEvent<MessagePublishedData<T>>) => any | Promise<any>): CloudFunction<CloudEvent<MessagePublishedData<T>>>;

package/lib/v2/providers/pubsub.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.onMessagePublished = exports.Message = void 0;
-const options = require("../options");
 const encoding_1 = require("../../common/encoding");
+const options = require("../options");
 /**
  * Interface representing a Google Cloud Pub/Sub message.
  *
@@ -75,9 +75,6 @@ function onMessagePublished(topicOrOptions, handler) {
             const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());
             const specificOpts = options.optionsToTriggerAnnotations(opts);
             return {
-                // TODO(inlined): Remove "apiVersion" once the CLI has migrated to
-                // "platform"
-                apiVersion: 2,
                 platform: 'gcfv2',
                 ...baseOpts,
                 ...specificOpts,
@@ -108,7 +105,7 @@ function onMessagePublished(topicOrOptions, handler) {
             retry: false,
         },
     };
-    encoding_1.copyIfPresent(endpoint.eventTrigger, opts, 'retry', 'retry');
+    (0, encoding_1.copyIfPresent)(endpoint.eventTrigger, opts, 'retry', 'retry');
     func.__endpoint = endpoint;
     return func;
 }

package/lib/v2/providers/storage.d.ts

@@ -1,5 +1,5 @@
-import * as options from '../options';
 import { CloudEvent, CloudFunction } from '../core';
+import * as options from '../options';
 /**
  * An object within Google Cloud Storage.
  * Ref: https://github.com/googleapis/google-cloudevents-nodejs/blob/main/cloud/storage/v1/StorageObjectData.ts
@@ -148,23 +148,27 @@ export interface CustomerEncryption {
      */
     keySha256?: string;
 }
+export interface StorageEvent extends CloudEvent<StorageObjectData> {
+    /** The name of the bucket containing this object. */
+    bucket: string;
+}
 /** StorageOptions extend EventHandlerOptions with a bucket name  */
 export interface StorageOptions extends options.EventHandlerOptions {
     bucket?: string;
 }
 /** Handle a storage object archived */
-export declare function onObjectArchived(handler: (event: CloudEvent<StorageObjectData>) => any | Promise<any>): CloudFunction<StorageObjectData>;
-export declare function onObjectArchived(bucket: string, handler: (event: CloudEvent<StorageObjectData>) => any | Promise<any>): CloudFunction<StorageObjectData>;
-export declare function onObjectArchived(opts: StorageOptions, handler: (event: CloudEvent<StorageObjectData>) => any | Promise<any>): CloudFunction<StorageObjectData>;
+export declare function onObjectArchived(handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+export declare function onObjectArchived(bucket: string, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+export declare function onObjectArchived(opts: StorageOptions, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
 /** Handle a storage object finalized */
-export declare function onObjectFinalized(handler: (event: CloudEvent<StorageObjectData>) => any | Promise<any>): CloudFunction<StorageObjectData>;
-export declare function onObjectFinalized(bucket: string, handler: (event: CloudEvent<StorageObjectData>) => any | Promise<any>): CloudFunction<StorageObjectData>;
-export declare function onObjectFinalized(opts: StorageOptions, handler: (event: CloudEvent<StorageObjectData>) => any | Promise<any>): CloudFunction<StorageObjectData>;
+export declare function onObjectFinalized(handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+export declare function onObjectFinalized(bucket: string, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+export declare function onObjectFinalized(opts: StorageOptions, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
 /** Handle a storage object deleted */
-export declare function onObjectDeleted(handler: (event: CloudEvent<StorageObjectData>) => any | Promise<any>): CloudFunction<StorageObjectData>;
-export declare function onObjectDeleted(bucket: string, handler: (event: CloudEvent<StorageObjectData>) => any | Promise<any>): CloudFunction<StorageObjectData>;
-export declare function onObjectDeleted(opts: StorageOptions, handler: (event: CloudEvent<StorageObjectData>) => any | Promise<any>): CloudFunction<StorageObjectData>;
+export declare function onObjectDeleted(handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+export declare function onObjectDeleted(bucket: string, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+export declare function onObjectDeleted(opts: StorageOptions, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
 /** Handle a storage object metadata updated */
-export declare function onObjectMetadataUpdated(handler: (event: CloudEvent<StorageObjectData>) => any | Promise<any>): CloudFunction<StorageObjectData>;
-export declare function onObjectMetadataUpdated(bucket: string, handler: (event: CloudEvent<StorageObjectData>) => any | Promise<any>): CloudFunction<StorageObjectData>;
-export declare function onObjectMetadataUpdated(opts: StorageOptions, handler: (event: CloudEvent<StorageObjectData>) => any | Promise<any>): CloudFunction<StorageObjectData>;
+export declare function onObjectMetadataUpdated(handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+export declare function onObjectMetadataUpdated(bucket: string, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;
+export declare function onObjectMetadataUpdated(opts: StorageOptions, handler: (event: StorageEvent) => any | Promise<any>): CloudFunction<StorageEvent>;

package/lib/v2/providers/storage.js

@@ -22,9 +22,9 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getOptsAndBucket = exports.onOperation = exports.onObjectMetadataUpdated = exports.onObjectDeleted = exports.onObjectFinalized = exports.onObjectArchived = exports.metadataUpdatedEvent = exports.deletedEvent = exports.finalizedEvent = exports.archivedEvent = void 0;
-const options = require("../options");
-const config_1 = require("../../config");
 const encoding_1 = require("../../common/encoding");
+const config_1 = require("../../config");
+const options = require("../options");
 /** @internal */
 exports.archivedEvent = 'google.cloud.storage.object.v1.archived';
 /** @internal */
@@ -103,7 +103,7 @@ function onOperation(eventType, bucketOrOptsOrHandler, handler) {
                     retry: false,
                 },
             };
-            encoding_1.copyIfPresent(endpoint.eventTrigger, opts, 'retry', 'retry');
+            (0, encoding_1.copyIfPresent)(endpoint.eventTrigger, opts, 'retry', 'retry');
             return endpoint;
         },
     });
@@ -112,6 +112,7 @@ function onOperation(eventType, bucketOrOptsOrHandler, handler) {
 exports.onOperation = onOperation;
 /** @internal */
 function getOptsAndBucket(bucketOrOpts) {
+    var _a;
     let bucket;
     let opts;
     if (typeof bucketOrOpts === 'string') {
@@ -119,7 +120,7 @@ function getOptsAndBucket(bucketOrOpts) {
         opts = {};
     }
     else {
-        bucket = bucketOrOpts.bucket || config_1.firebaseConfig().storageBucket;
+        bucket = bucketOrOpts.bucket || ((_a = (0, config_1.firebaseConfig)()) === null || _a === void 0 ? void 0 : _a.storageBucket);
         opts = { ...bucketOrOpts };
         delete opts.bucket;
     }

package/lib/v2/providers/tasks.d.ts

@@ -1,6 +1,6 @@
+import { AuthData, RateLimits, Request, RetryConfig } from '../../common/providers/tasks';
 import * as options from '../options';
 import { HttpsFunction } from './https';
-import { AuthData, RateLimits, Request, RetryConfig } from '../../common/providers/tasks';
 export { AuthData, RateLimits, Request, RetryConfig as RetryPolicy };
 export interface TaskQueueOptions extends options.GlobalOptions {
     retryConfig?: RetryConfig;

package/lib/v2/providers/tasks.js

@@ -22,9 +22,9 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.onTaskDispatched = void 0;
-const options = require("../options");
 const encoding_1 = require("../../common/encoding");
 const tasks_1 = require("../../common/providers/tasks");
+const options = require("../options");
 function onTaskDispatched(optsOrHandler, handler) {
     let opts;
     if (arguments.length == 1) {
@@ -37,7 +37,7 @@ function onTaskDispatched(optsOrHandler, handler) {
     // onDispatchHandler sniffs the function length to determine which API to present.
     // fix the length to prevent api versions from being mismatched.
     const fixedLen = (req) => handler(req);
-    const func = tasks_1.onDispatchHandler(fixedLen);
+    const func = (0, tasks_1.onDispatchHandler)(fixedLen);
     Object.defineProperty(func, '__trigger', {
         get: () => {
             const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());
@@ -45,10 +45,9 @@ function onTaskDispatched(optsOrHandler, handler) {
             // but optionsToTriggerAnnotations handles both cases.
             const specificOpts = options.optionsToTriggerAnnotations(opts);
             const taskQueueTrigger = {};
-            encoding_1.copyIfPresent(taskQueueTrigger, opts, 'retryConfig', 'rateLimits');
-            encoding_1.convertIfPresent(taskQueueTrigger, opts, 'invoker', 'invoker', encoding_1.convertInvoker);
+            (0, encoding_1.copyIfPresent)(taskQueueTrigger, opts, 'retryConfig', 'rateLimits');
+            (0, encoding_1.convertIfPresent)(taskQueueTrigger, opts, 'invoker', 'invoker', encoding_1.convertInvoker);
             return {
-                apiVersion: 2,
                 platform: 'gcfv2',
                 ...baseOpts,
                 ...specificOpts,
@@ -74,9 +73,9 @@ function onTaskDispatched(optsOrHandler, handler) {
         },
         taskQueueTrigger: {},
     };
-    encoding_1.copyIfPresent(func.__endpoint.taskQueueTrigger, opts, 'retryConfig');
-    encoding_1.copyIfPresent(func.__endpoint.taskQueueTrigger, opts, 'rateLimits');
-    encoding_1.convertIfPresent(func.__endpoint.taskQueueTrigger, opts, 'invoker', 'invoker', encoding_1.convertInvoker);
+    (0, encoding_1.copyIfPresent)(func.__endpoint.taskQueueTrigger, opts, 'retryConfig');
+    (0, encoding_1.copyIfPresent)(func.__endpoint.taskQueueTrigger, opts, 'rateLimits');
+    (0, encoding_1.convertIfPresent)(func.__endpoint.taskQueueTrigger, opts, 'invoker', 'invoker', encoding_1.convertInvoker);
     func.__requiredAPIs = [
         {
             api: 'cloudtasks.googleapis.com',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "3.20.1",
+  "version": "3.21.0",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",
@@ -64,7 +64,8 @@
     "./v2/alerts/appDistribution": "./lib/v2/providers/alerts/appDistribution.js",
     "./v2/alerts/billing": "./lib/v2/providers/alerts/billing.js",
     "./v2/alerts/crashlytics": "./lib/v2/providers/alerts/crashlytics.js",
-    "./v2/eventarc": "./lib/v2/providers/eventarc.js"
+    "./v2/eventarc": "./lib/v2/providers/eventarc.js",
+    "./v2/identity": "./lib/v2/providers/identity.js"
   },
   "typesVersions": {
     "*": {
@@ -128,6 +129,9 @@
       "v2/eventarc": [
         "lib/v2/providers/eventarc"
       ],
+      "v2/identity": [
+        "lib/v2/providers/identity"
+      ],
       "v2/options": [
         "lib/v2/options"
       ],
@@ -153,6 +157,12 @@
   },
   "scripts": {
     "apidocs": "node docgen/generate-docs.js",
+    "docgen:v1:extract": "api-extractor run -c docgen/api-extractor.v1.json --local",
+    "docgen:v1:gen": "api-documenter-fire markdown -i docgen/v1 -o docgen/v1/markdown && api-documenter-fire toc -i docgen/v1 -o docgen/v1/markdown/toc -p /docs/reference/functions",
+    "docgen:v1": "npm run docgen:v1:extract && npm run docgen:v1:gen",
+    "docgen:v2:extract": "api-extractor run -c docgen/api-extractor.v2.json --local",
+    "docgen:v2:gen": "api-documenter-fire markdown -i docgen/v2 -o docgen/v2/markdown && api-documenter-fire toc -i docgen/v2 -o docgen/v2/markdown/toc -p /docs/reference/functions/v2",
+    "docgen:v2": "npm run docgen:v2:extract && npm run docgen:v2:gen",
     "build:pack": "rm -rf lib && npm install && tsc -p tsconfig.release.json && npm pack",
     "build:release": "npm ci --production && npm install --no-save typescript firebase-admin && tsc -p tsconfig.release.json",
     "build": "tsc -p tsconfig.release.json",
@@ -173,6 +183,9 @@
     "node-fetch": "^2.6.7"
   },
   "devDependencies": {
+    "@firebase/api-documenter": "^0.1.2",
+    "@microsoft/api-documenter": "^7.13.45",
+    "@microsoft/api-extractor": "^7.18.7",
     "@types/chai": "^4.1.7",
     "@types/chai-as-promised": "^7.1.0",
     "@types/jsonwebtoken": "^8.3.2",
@@ -186,7 +199,7 @@
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
     "child-process-promise": "^2.2.1",
-    "firebase-admin": "10.0.0",
+    "firebase-admin": "^10.1.0",
     "js-yaml": "^3.13.1",
     "jsdom": "^16.2.1",
     "jsonwebtoken": "^8.5.1",