firebase-functions 3.15.6 → 3.17.1

package/lib/v2/providers/https.js

@@ -21,12 +21,12 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.onCall = exports.onRequest = exports.HttpsError = void 0;
+exports.onTaskDispatched = exports.onCall = exports.onRequest = exports.HttpsError = void 0;
 const cors = require("cors");
 const encoding_1 = require("../../common/encoding");
+const options = require("../options");
 const https_1 = require("../../common/providers/https");
 Object.defineProperty(exports, "HttpsError", { enumerable: true, get: function () { return https_1.HttpsError; } });
-const options = require("../options");
 function onRequest(optsOrHandler, handler) {
     let opts;
     if (arguments.length === 1) {
@@ -72,6 +72,22 @@ function onRequest(optsOrHandler, handler) {
             return trigger;
         },
     });
+    const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
+    // global options calls region a scalar and https allows it to be an array,
+    // but optionsToTriggerAnnotations handles both cases.
+    const specificOpts = options.optionsToEndpoint(opts);
+    const endpoint = {
+        platform: 'gcfv2',
+        ...baseOpts,
+        ...specificOpts,
+        labels: {
+            ...baseOpts === null || baseOpts === void 0 ? void 0 : baseOpts.labels,
+            ...specificOpts === null || specificOpts === void 0 ? void 0 : specificOpts.labels,
+        },
+        httpsTrigger: {},
+    };
+    (0, encoding_1.convertIfPresent)(endpoint.httpsTrigger, opts, 'invoker', 'invoker', encoding_1.convertInvoker);
+    handler.__endpoint = endpoint;
     return handler;
 }
 exports.onRequest = onRequest;
@@ -88,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)({ origin, methods: 'POST' }, fixedLen);
+    const func = (0, https_1.onCallHandler)({ cors: { origin, methods: 'POST' } }, fixedLen);
     Object.defineProperty(func, '__trigger', {
         get: () => {
             const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());
@@ -113,7 +129,60 @@ function onCall(optsOrHandler, handler) {
             };
         },
     });
+    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,
+        },
+        callableTrigger: {},
+    };
     func.run = 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.d.ts

@@ -1,5 +1,5 @@
-import { CloudEvent, CloudFunction } from '../core';
 import * as options from '../options';
+import { CloudEvent, CloudFunction } from '../core';
 /**
  * Interface representing a Google Cloud Pub/Sub message.
  *

package/lib/v2/providers/pubsub.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.onMessagePublished = exports.Message = void 0;
 const options = require("../options");
+const encoding_1 = require("../../common/encoding");
 /**
  * Interface representing a Google Cloud Pub/Sub message.
  *
@@ -69,10 +70,6 @@ function onMessagePublished(topicOrOptions, handler) {
         return handler(raw);
     };
     func.run = handler;
-    // TypeScript doesn't recongize defineProperty as adding a property and complains
-    // that __trigger doesn't exist. We can either cast to any and lose all type safety
-    // or we can just assign a meaningless value before calling defineProperty.
-    func.__trigger = 'silence the transpiler';
     Object.defineProperty(func, '__trigger', {
         get: () => {
             const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());
@@ -95,6 +92,24 @@ function onMessagePublished(topicOrOptions, handler) {
             };
         },
     });
+    const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
+    const specificOpts = options.optionsToEndpoint(opts);
+    const endpoint = {
+        platform: 'gcfv2',
+        ...baseOpts,
+        ...specificOpts,
+        labels: {
+            ...baseOpts === null || baseOpts === void 0 ? void 0 : baseOpts.labels,
+            ...specificOpts === null || specificOpts === void 0 ? void 0 : specificOpts.labels,
+        },
+        eventTrigger: {
+            eventType: 'google.cloud.pubsub.topic.v1.messagePublished',
+            eventFilters: { topic },
+            retry: false,
+        },
+    };
+    (0, encoding_1.copyIfPresent)(endpoint.eventTrigger, opts, 'retry', 'retry');
+    func.__endpoint = endpoint;
     return func;
 }
 exports.onMessagePublished = onMessagePublished;

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

@@ -0,0 +1,170 @@
+import * as options from '../options';
+import { CloudEvent, CloudFunction } from '../core';
+/**
+ * An object within Google Cloud Storage.
+ * Ref: https://github.com/googleapis/google-cloudevents-nodejs/blob/main/cloud/storage/v1/StorageObjectData.ts
+ */
+export interface StorageObjectData {
+    /**
+     * The name of the bucket containing this object.
+     */
+    bucket?: string;
+    /**
+     * Cache-Control directive for the object data, matching
+     * [https://tools.ietf.org/html/rfc7234#section-5.2"][RFC 7234 §5.2].
+     */
+    cacheControl?: string;
+    /**
+     * Number of underlying components that make up this object. Components are
+     * accumulated by compose operations.
+     * Attempting to set this field will result in an error.
+     */
+    componentCount?: number;
+    /**
+     * Content-Disposition of the object data, matching
+     * [https://tools.ietf.org/html/rfc6266][RFC 6266].
+     */
+    contentDisposition?: string;
+    /**
+     * Content-Encoding of the object data, matching
+     * [https://tools.ietf.org/html/rfc7231#section-3.1.2.2][RFC 7231 §3.1.2.2]
+     */
+    contentEncoding?: string;
+    /**
+     * Content-Language of the object data, matching
+     * [https://tools.ietf.org/html/rfc7231#section-3.1.3.2][RFC 7231 §3.1.3.2].
+     */
+    contentLanguage?: string;
+    /**
+     * Content-Type of the object data, matching
+     * [https://tools.ietf.org/html/rfc7231#section-3.1.1.5][RFC 7231 §3.1.1.5].
+     * If an object is stored without a Content-Type, it is served as
+     * `application/octet-stream`.
+     */
+    contentType?: string;
+    /**
+     * CRC32c checksum. For more information about using the CRC32c
+     * checksum, see
+     * [https://cloud.google.com/storage/docs/hashes-etags#_JSONAPI][Hashes and
+     * ETags: Best Practices].
+     */
+    crc32c?: string;
+    /**
+     * Metadata of customer-supplied encryption key, if the object is encrypted by
+     * such a key.
+     */
+    customerEncryption?: CustomerEncryption;
+    /**
+     * HTTP 1.1 Entity tag for the object. See
+     * [https://tools.ietf.org/html/rfc7232#section-2.3][RFC 7232 §2.3].
+     */
+    etag?: string;
+    /**
+     * The content generation of this object. Used for object versioning.
+     * Attempting to set this field will result in an error.
+     */
+    generation?: number;
+    /**
+     * The ID of the object, including the bucket name, object name, and
+     * generation number.
+     */
+    id?: string;
+    /**
+     * The kind of item this is. For objects, this is always "storage#object".
+     */
+    kind?: string;
+    /**
+     * MD5 hash of the data; encoded using base64 as per
+     * [https://tools.ietf.org/html/rfc4648#section-4][RFC 4648 §4]. For more
+     * information about using the MD5 hash, see
+     * [https://cloud.google.com/storage/docs/hashes-etags#_JSONAPI][Hashes and
+     * ETags: Best Practices].
+     */
+    md5Hash?: string;
+    /**
+     * Media download link.
+     */
+    mediaLink?: string;
+    /**
+     * User-provided metadata, in key/value pairs.
+     */
+    metadata?: {
+        [key: string]: string;
+    };
+    /**
+     * The version of the metadata for this object at this generation. Used for
+     * preconditions and for detecting changes in metadata. A metageneration
+     * number is only meaningful in the context of a particular generation of a
+     * particular object.
+     */
+    metageneration?: number;
+    /**
+     * The name of the object.
+     */
+    name?: string;
+    /**
+     * The link to this object.
+     */
+    selfLink?: string;
+    /**
+     * Content-Length of the object data in bytes, matching
+     * [https://tools.ietf.org/html/rfc7230#section-3.3.2][RFC 7230 §3.3.2].
+     */
+    size?: number;
+    /**
+     * Storage class of the object.
+     */
+    storageClass?: string;
+    /**
+     * The creation time of the object.
+     * Attempting to set this field will result in an error.
+     */
+    timeCreated?: Date | string;
+    /**
+     * The deletion time of the object. Will be returned if and only if this
+     * version of the object has been deleted.
+     */
+    timeDeleted?: Date | string;
+    /**
+     * The time at which the object's storage class was last changed.
+     */
+    timeStorageClassUpdated?: Date | string;
+    /**
+     * The modification time of the object metadata.
+     */
+    updated?: Date | string;
+}
+/**
+ * Metadata of customer-supplied encryption key, if the object is encrypted by
+ * such a key.
+ */
+export interface CustomerEncryption {
+    /**
+     * The encryption algorithm.
+     */
+    encryptionAlgorithm?: string;
+    /**
+     * SHA256 hash value of the encryption key.
+     */
+    keySha256?: 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>;
+/** 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>;
+/** 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>;
+/** 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>;

package/lib/v2/providers/storage.js

@@ -0,0 +1,137 @@
+"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.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");
+/** @internal */
+exports.archivedEvent = 'google.cloud.storage.object.v1.archived';
+/** @internal */
+exports.finalizedEvent = 'google.cloud.storage.object.v1.finalized';
+/** @internal */
+exports.deletedEvent = 'google.cloud.storage.object.v1.deleted';
+/** @internal */
+exports.metadataUpdatedEvent = 'google.cloud.storage.object.v1.metadataUpdated';
+function onObjectArchived(buketOrOptsOrHandler, handler) {
+    return onOperation(exports.archivedEvent, buketOrOptsOrHandler, handler);
+}
+exports.onObjectArchived = onObjectArchived;
+function onObjectFinalized(buketOrOptsOrHandler, handler) {
+    return onOperation(exports.finalizedEvent, buketOrOptsOrHandler, handler);
+}
+exports.onObjectFinalized = onObjectFinalized;
+function onObjectDeleted(buketOrOptsOrHandler, handler) {
+    return onOperation(exports.deletedEvent, buketOrOptsOrHandler, handler);
+}
+exports.onObjectDeleted = onObjectDeleted;
+function onObjectMetadataUpdated(buketOrOptsOrHandler, handler) {
+    return onOperation(exports.metadataUpdatedEvent, buketOrOptsOrHandler, handler);
+}
+exports.onObjectMetadataUpdated = onObjectMetadataUpdated;
+/** @internal */
+function onOperation(eventType, bucketOrOptsOrHandler, handler) {
+    if (typeof bucketOrOptsOrHandler === 'function') {
+        handler = bucketOrOptsOrHandler;
+        bucketOrOptsOrHandler = {};
+    }
+    const [opts, bucket] = getOptsAndBucket(bucketOrOptsOrHandler);
+    const func = (raw) => {
+        return handler(raw);
+    };
+    func.run = handler;
+    Object.defineProperty(func, '__trigger', {
+        get: () => {
+            const baseOpts = options.optionsToTriggerAnnotations(options.getGlobalOptions());
+            const specificOpts = options.optionsToTriggerAnnotations(opts);
+            return {
+                platform: 'gcfv2',
+                ...baseOpts,
+                ...specificOpts,
+                labels: {
+                    ...baseOpts === null || baseOpts === void 0 ? void 0 : baseOpts.labels,
+                    ...specificOpts === null || specificOpts === void 0 ? void 0 : specificOpts.labels,
+                },
+                eventTrigger: {
+                    eventType,
+                    resource: bucket, // TODO(colerogers): replace with 'bucket,' eventually
+                },
+            };
+        },
+    });
+    // TypeScript doesn't recognize defineProperty as adding a property and complains
+    // that __endpoint doesn't exist. We can either cast to any and lose all type safety
+    // or we can just assign a meaningless value before calling defineProperty.
+    func.__endpoint = {};
+    // SDK may attempt to read FIREBASE_CONFIG env var to fetch the default bucket name.
+    // To prevent runtime errors when FIREBASE_CONFIG env var is missing, we use getters.
+    Object.defineProperty(func, '__endpoint', {
+        get: () => {
+            const baseOpts = options.optionsToEndpoint(options.getGlobalOptions());
+            const specificOpts = options.optionsToEndpoint(opts);
+            const endpoint = {
+                platform: 'gcfv2',
+                ...baseOpts,
+                ...specificOpts,
+                labels: {
+                    ...baseOpts === null || baseOpts === void 0 ? void 0 : baseOpts.labels,
+                    ...specificOpts === null || specificOpts === void 0 ? void 0 : specificOpts.labels,
+                },
+                eventTrigger: {
+                    eventType,
+                    eventFilters: {
+                        bucket,
+                    },
+                    retry: false,
+                },
+            };
+            (0, encoding_1.copyIfPresent)(endpoint.eventTrigger, opts, 'retry', 'retry');
+            return endpoint;
+        },
+    });
+    return func;
+}
+exports.onOperation = onOperation;
+/** @internal */
+function getOptsAndBucket(bucketOrOpts) {
+    let bucket;
+    let opts;
+    if (typeof bucketOrOpts === 'string') {
+        bucket = bucketOrOpts;
+        opts = {};
+    }
+    else {
+        bucket = bucketOrOpts.bucket || (0, config_1.firebaseConfig)().storageBucket;
+        opts = { ...bucketOrOpts };
+        delete opts.bucket;
+    }
+    if (!bucket) {
+        throw new Error('Missing bucket name. If you are unit testing, please provide a bucket name' +
+            ' by providing bucket name directly in the event handler or by setting process.env.FIREBASE_CONFIG.');
+    }
+    if (!/^[a-z\d][a-z\d\\._-]{1,230}[a-z\d]$/.test(bucket)) {
+        throw new Error(`Invalid bucket name ${bucket}`);
+    }
+    return [opts, bucket];
+}
+exports.getOptsAndBucket = getOptsAndBucket;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "3.15.6",
+  "version": "3.17.1",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",
@@ -22,6 +22,9 @@
     "lib"
   ],
   "main": "lib/index.js",
+  "bin": {
+    "firebase-functions": "./lib/bin/firebase-functions.js"
+  },
   "types": "lib/index.d.ts",
   "exports": {
     ".": "./lib/index.js",
@@ -53,7 +56,12 @@
     "./v2/options": "./lib/v2/options.js",
     "./v2/https": "./lib/v2/providers/https.js",
     "./v2/params": "./lib/v2/params/index.js",
-    "./v2/pubsub": "./lib/v2/providers/pubsub.js"
+    "./v2/pubsub": "./lib/v2/providers/pubsub.js",
+    "./v2/storage": "./lib/v2/providers/storage.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"
   },
   "typesVersions": {
     "*": {
@@ -110,6 +118,21 @@
       ],
       "v2/pubsub": [
         "lib/v2/providers/pubsub"
+      ],
+      "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"
       ]
     }
   },
@@ -126,7 +149,8 @@
     "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"
+    "test": "mocha --file ./mocha/setup.ts spec/**/*.spec.ts ",
+    "test:bin": "./scripts/bin-test/run.sh"
   },
   "dependencies": {
     "@types/cors": "^2.8.5",
@@ -148,7 +172,7 @@
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
     "child-process-promise": "^2.2.1",
-    "firebase-admin": "^9.8.0",
+    "firebase-admin": "10.0.0",
     "js-yaml": "^3.13.1",
     "jsdom": "^16.2.1",
     "jsonwebtoken": "^8.5.1",
@@ -157,19 +181,22 @@
     "mock-require": "^3.0.3",
     "mz": "^2.7.0",
     "nock": "^10.0.6",
+    "node-fetch": "^2.6.7",
+    "portfinder": "^1.0.28",
     "prettier": "^1.18.2",
+    "semver": "^7.3.5",
     "sinon": "^7.3.2",
-    "ts-node": "^8.3.0",
+    "ts-node": "^10.4.0",
     "tslint": "^5.18.0",
     "tslint-config-prettier": "^1.18.0",
     "tslint-no-unused-expression-chai": "^0.1.4",
     "tslint-plugin-prettier": "^2.0.1",
-    "typedoc": "^0.21.5",
+    "typedoc": "0.21.2",
     "typescript": "^4.3.5",
     "yargs": "^15.3.1"
   },
   "peerDependencies": {
-    "firebase-admin": "^8.0.0 || ^9.0.0"
+    "firebase-admin": "^8.0.0 || ^9.0.0 || ^10.0.0"
   },
   "engines": {
     "node": "^8.13.0 || >=10.10.0"