firebase-functions 3.18.1 → 3.20.1

package/lib/v2/providers/https.js

@@ -21,7 +21,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.onTaskDispatched = exports.onCall = exports.onRequest = exports.HttpsError = void 0;
+exports.onCall = exports.onRequest = exports.HttpsError = void 0;
 const cors = require("cors");
 const encoding_1 = require("../../common/encoding");
 const options = require("../options");
@@ -68,7 +68,7 @@ function onRequest(optsOrHandler, handler) {
                     allowInsecure: false,
                 },
             };
-            (0, encoding_1.convertIfPresent)(trigger.httpsTrigger, opts, 'invoker', 'invoker', encoding_1.convertInvoker);
+            encoding_1.convertIfPresent(trigger.httpsTrigger, opts, 'invoker', 'invoker', encoding_1.convertInvoker);
             return trigger;
         },
     });
@@ -86,7 +86,7 @@ function onRequest(optsOrHandler, handler) {
         },
         httpsTrigger: {},
     };
-    (0, encoding_1.convertIfPresent)(endpoint.httpsTrigger, opts, 'invoker', 'invoker', encoding_1.convertInvoker);
+    encoding_1.convertIfPresent(endpoint.httpsTrigger, opts, 'invoker', 'invoker', encoding_1.convertInvoker);
     handler.__endpoint = endpoint;
     return handler;
 }
@@ -104,7 +104,7 @@ function onCall(optsOrHandler, handler) {
     // onCallHandler 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 = (0, https_1.onCallHandler)({ cors: { origin, methods: 'POST' } }, fixedLen);
+    const func = https_1.onCallHandler({ cors: { origin, methods: 'POST' } }, fixedLen);
     Object.defineProperty(func, '__trigger', {
         get: () => {
             const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());
@@ -147,42 +147,3 @@ function onCall(optsOrHandler, handler) {
     return func;
 }
 exports.onCall = onCall;
-function onTaskDispatched(optsOrHandler, handler) {
-    let opts;
-    if (arguments.length == 1) {
-        opts = {};
-        handler = optsOrHandler;
-    }
-    else {
-        opts = optsOrHandler;
-    }
-    // onEnqueueHandler 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 = (0, https_1.onDispatchHandler)(fixedLen);
-    Object.defineProperty(func, '__trigger', {
-        get: () => {
-            const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());
-            // global options calls region a scalar and https allows it to be an array,
-            // but optionsToTriggerAnnotations handles both cases.
-            const specificOpts = options.optionsToTriggerAnnotations(opts);
-            const taskQueueTrigger = {};
-            (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,
-                labels: {
-                    ...baseOpts === null || baseOpts === void 0 ? void 0 : baseOpts.labels,
-                    ...specificOpts === null || specificOpts === void 0 ? void 0 : specificOpts.labels,
-                },
-                taskQueueTrigger,
-            };
-        },
-    });
-    func.run = handler;
-    return func;
-}
-exports.onTaskDispatched = onTaskDispatched;

package/lib/v2/providers/pubsub.js

@@ -108,7 +108,7 @@ function onMessagePublished(topicOrOptions, handler) {
             retry: false,
         },
     };
-    (0, encoding_1.copyIfPresent)(endpoint.eventTrigger, opts, 'retry', 'retry');
+    encoding_1.copyIfPresent(endpoint.eventTrigger, opts, 'retry', 'retry');
     func.__endpoint = endpoint;
     return func;
 }

package/lib/v2/providers/storage.js

@@ -99,13 +99,11 @@ function onOperation(eventType, bucketOrOptsOrHandler, handler) {
                 },
                 eventTrigger: {
                     eventType,
-                    eventFilters: {
-                        bucket,
-                    },
+                    eventFilters: { bucket },
                     retry: false,
                 },
             };
-            (0, encoding_1.copyIfPresent)(endpoint.eventTrigger, opts, 'retry', 'retry');
+            encoding_1.copyIfPresent(endpoint.eventTrigger, opts, 'retry', 'retry');
             return endpoint;
         },
     });
@@ -121,7 +119,7 @@ function getOptsAndBucket(bucketOrOpts) {
         opts = {};
     }
     else {
-        bucket = bucketOrOpts.bucket || (0, config_1.firebaseConfig)().storageBucket;
+        bucket = bucketOrOpts.bucket || config_1.firebaseConfig().storageBucket;
         opts = { ...bucketOrOpts };
         delete opts.bucket;
     }

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

@@ -0,0 +1,22 @@
+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;
+    rateLimits?: RateLimits;
+    /**
+     * Who can enqueue tasks for this function.
+     * If left unspecified, only service accounts which have
+     * roles/cloudtasks.enqueuer and roles/cloudfunctions.invoker
+     * will have permissions.
+     */
+    invoker?: 'private' | string | string[];
+}
+export interface TaskQueueFunction<T = any> extends HttpsFunction {
+    run(data: Request<T>): void | Promise<void>;
+}
+/** Handle a request sent to a Cloud Tasks queue. */
+export declare function onTaskDispatched<Args = any>(handler: (request: Request<Args>) => void | Promise<void>): TaskQueueFunction<Args>;
+/** Handle a request sent to a Cloud Tasks queue. */
+export declare function onTaskDispatched<Args = any>(options: TaskQueueOptions, handler: (request: Request<Args>) => void | Promise<void>): TaskQueueFunction<Args>;

package/lib/v2/providers/tasks.js

@@ -0,0 +1,89 @@
+"use strict";
+// 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.
+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");
+function onTaskDispatched(optsOrHandler, handler) {
+    let opts;
+    if (arguments.length == 1) {
+        opts = {};
+        handler = optsOrHandler;
+    }
+    else {
+        opts = optsOrHandler;
+    }
+    // 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);
+    Object.defineProperty(func, '__trigger', {
+        get: () => {
+            const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());
+            // global options calls region a scalar and https allows it to be an array,
+            // 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);
+            return {
+                apiVersion: 2,
+                platform: 'gcfv2',
+                ...baseOpts,
+                ...specificOpts,
+                labels: {
+                    ...baseOpts === null || baseOpts === void 0 ? void 0 : baseOpts.labels,
+                    ...specificOpts === null || specificOpts === void 0 ? void 0 : specificOpts.labels,
+                },
+                taskQueueTrigger,
+            };
+        },
+    });
+    const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
+    // global options calls region a scalar and https allows it to be an array,
+    // but optionsToManifestEndpoint handles both cases.
+    const specificOpts = options.optionsToEndpoint(opts);
+    func.__endpoint = {
+        platform: 'gcfv2',
+        ...baseOpts,
+        ...specificOpts,
+        labels: {
+            ...baseOpts === null || baseOpts === void 0 ? void 0 : baseOpts.labels,
+            ...specificOpts === null || specificOpts === void 0 ? void 0 : specificOpts.labels,
+        },
+        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);
+    func.__requiredAPIs = [
+        {
+            api: 'cloudtasks.googleapis.com',
+            reason: 'Needed for task queue functions',
+        },
+    ];
+    func.run = handler;
+    return func;
+}
+exports.onTaskDispatched = onTaskDispatched;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "3.18.1",
+  "version": "3.20.1",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",
@@ -40,6 +40,7 @@
     "./lib/providers/pubsub": "./lib/providers/pubsub.js",
     "./lib/providers/remoteConfig": "./lib/providers/remoteConfig.js",
     "./lib/providers/storage": "./lib/providers/storage.js",
+    "./lib/providers/tasks": "./lib/providers/tasks.js",
     "./lib/providers/testLab": "./lib/providers/testLab.js",
     "./v1": "./lib/index.js",
     "./v1/analytics": "./lib/providers/analytics.js",
@@ -58,10 +59,12 @@
     "./v2/params": "./lib/v2/params/index.js",
     "./v2/pubsub": "./lib/v2/providers/pubsub.js",
     "./v2/storage": "./lib/v2/providers/storage.js",
+    "./v2/tasks": "./lib/v2/providers/tasks.js",
     "./v2/alerts": "./lib/v2/providers/alerts/index.js",
     "./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/alerts/crashlytics": "./lib/v2/providers/alerts/crashlytics.js",
+    "./v2/eventarc": "./lib/v2/providers/eventarc.js"
   },
   "typesVersions": {
     "*": {
@@ -98,15 +101,33 @@
       "v1/storage": [
         "lib/providers/storage"
       ],
+      "v1/tasks": [
+        "lib/providers/tasks"
+      ],
       "v1/testLab": [
         "lib/providers/testLab"
       ],
       "v2": [
         "lib/v2"
       ],
+      "v2/alerts": [
+        "lib/v2/providers/alerts"
+      ],
+      "v2/alerts/appDistribution": [
+        "lib/v2/providers/alerts/appDistribution"
+      ],
+      "v2/alerts/billing": [
+        "lib/v2/providers/alerts/billing"
+      ],
+      "v2/alerts/crashlytics": [
+        "lib/v2/providers/alerts/crashlytics"
+      ],
       "v2/base": [
         "lib/v2/base"
       ],
+      "v2/eventarc": [
+        "lib/v2/providers/eventarc"
+      ],
       "v2/options": [
         "lib/v2/options"
       ],
@@ -122,17 +143,8 @@
       "v2/storage": [
         "lib/v2/providers/storage"
       ],
-      "v2/alerts": [
-        "lib/v2/providers/alerts"
-      ],
-      "v2/alerts/appDistribution": [
-        "lib/v2/providers/alerts/appDistribution"
-      ],
-      "v2/alerts/billing": [
-        "lib/v2/providers/alerts/billing"
-      ],
-      "v2/alerts/crashlytics": [
-        "lib/v2/providers/alerts/crashlytics"
+      "v2/tasks": [
+        "lib/v2/providers/tasks"
       ]
     }
   },
@@ -149,7 +161,7 @@
     "format:fix": "prettier --write '**/*.{json,md,ts,yml,yaml}'",
     "lint": "tslint --config tslint.json --project tsconfig.json ",
     "lint:fix": "tslint --config tslint.json --fix --project tsconfig.json",
-    "test": "mocha --file ./mocha/setup.ts spec/**/*.spec.ts ",
+    "test": "mocha --file ./mocha/setup.ts \"spec/**/*.spec.ts\"",
     "test:bin": "./scripts/bin-test/run.sh"
   },
   "dependencies": {
@@ -157,7 +169,8 @@
     "@types/express": "4.17.3",
     "cors": "^2.8.5",
     "express": "^4.17.1",
-    "lodash": "^4.17.14"
+    "lodash": "^4.17.14",
+    "node-fetch": "^2.6.7"
   },
   "devDependencies": {
     "@types/chai": "^4.1.7",
@@ -168,6 +181,7 @@
     "@types/mock-require": "^2.0.0",
     "@types/nock": "^10.0.3",
     "@types/node": "^8.10.50",
+    "@types/node-fetch": "^3.0.3",
     "@types/sinon": "^7.0.13",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",