firebase-functions 3.24.1 → 4.0.0-rc.0

package/lib/apps.js

@@ -1,112 +0,0 @@
-"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.apps = void 0;
-const firebase = require("firebase-admin");
-const _ = require("lodash");
-const config_1 = require("./config");
-function apps() {
-    if (typeof apps.singleton === 'undefined') {
-        apps.init();
-    }
-    return apps.singleton;
-}
-exports.apps = apps;
-(function (apps) {
-    /** @hidden */
-    apps.garbageCollectionInterval = 2 * 60 * 1000;
-    /** @hidden */
-    function delay(delay) {
-        return new Promise((resolve) => {
-            setTimeout(resolve, delay);
-        });
-    }
-    apps.delay = delay;
-    apps.init = () => (apps.singleton = new Apps());
-    class Apps {
-        constructor() {
-            this._refCounter = {};
-        }
-        _appAlive(appName) {
-            try {
-                const app = firebase.app(appName);
-                return !_.get(app, 'isDeleted_');
-            }
-            catch (e) {
-                return false;
-            }
-        }
-        _destroyApp(appName) {
-            if (!this._appAlive(appName)) {
-                return;
-            }
-            firebase
-                .app(appName)
-                .delete()
-                .catch(_.noop);
-        }
-        retain() {
-            const increment = (n) => {
-                return (n || 0) + 1;
-            };
-            // Increment counter for admin because function might use event.data.ref
-            _.update(this._refCounter, '__admin__', increment);
-        }
-        release() {
-            const decrement = (n) => {
-                return n - 1;
-            };
-            return delay(apps.garbageCollectionInterval).then(() => {
-                _.update(this._refCounter, '__admin__', decrement);
-                _.forEach(this._refCounter, (count, key) => {
-                    if (count <= 0) {
-                        this._destroyApp(key);
-                    }
-                });
-            });
-        }
-        get admin() {
-            if (this._emulatedAdminApp) {
-                return this._emulatedAdminApp;
-            }
-            if (this._appAlive('__admin__')) {
-                return firebase.app('__admin__');
-            }
-            return firebase.initializeApp(this.firebaseArgs, '__admin__');
-        }
-        /**
-         * 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.
-         */
-        setEmulatedAdminApp(app) {
-            this._emulatedAdminApp = app;
-        }
-        get firebaseArgs() {
-            return _.assign({}, (0, config_1.firebaseConfig)(), {
-                credential: firebase.credential.applicationDefault(),
-            });
-        }
-    }
-    apps.Apps = Apps;
-})(apps = exports.apps || (exports.apps = {}));

package/lib/cloud-functions.d.ts

@@ -1,231 +0,0 @@
-import { Request, Response } from 'express';
-import { DeploymentOptions, FailurePolicy, Schedule } from './function-configuration';
-export { Request, Response };
-import { Duration } from './common/encoding';
-import { ManifestEndpoint, ManifestRequiredAPI } from './runtime/manifest';
-export { Change } from './common/change';
-/**
- * @hidden
- *
- * Wire format for an event.
- */
-export interface Event {
-    context: {
-        eventId: string;
-        timestamp: string;
-        eventType: string;
-        resource: Resource;
-        domain?: string;
-    };
-    data: any;
-}
-/**
- * The context in which an event occurred.
- *
- * An EventContext describes:
- * - The time an event occurred.
- * - A unique identifier of the event.
- * - The resource on which the event occurred, if applicable.
- * - Authorization of the request that triggered the event, if applicable and
- *   available.
- */
-export interface EventContext {
-    /**
-     * Authentication information for the user that triggered the function.
-     * This object contains `uid` and `token` properties for authenticated users.
-     * For more detail including token keys, see the
-     * [security rules reference](/docs/firestore/reference/security/#properties).
-     *
-     * This field is only populated for Realtime Database triggers and Callable
-     * functions. For an unauthenticated user, this field is null. For Firebase
-     * admin users and event types that do not provide user information, this field
-     * does not exist.
-     */
-    auth?: {
-        token: object;
-        uid: string;
-    };
-    /**
-     * The level of permissions for a user. Valid values are:
-     *
-     * * `ADMIN` Developer user or user authenticated via a service account.
-     * * `USER` Known user.
-     * * `UNAUTHENTICATED` Unauthenticated action
-     * * `null` For event types that do not provide user information (all except
-     *   Realtime Database).
-     */
-    authType?: 'ADMIN' | 'USER' | 'UNAUTHENTICATED';
-    /**
-     * The event’s unique identifier.
-     */
-    eventId: string;
-    /**
-     * Type of event. Possible values are:
-     *
-     * * `google.analytics.event.log`
-     * * `google.firebase.auth.user.create`
-     * * `google.firebase.auth.user.delete`
-     * * `google.firebase.database.ref.write`
-     * * `google.firebase.database.ref.create`
-     * * `google.firebase.database.ref.update`
-     * * `google.firebase.database.ref.delete`
-     * * `google.firestore.document.write`
-     * * `google.firestore.document.create`
-     * * `google.firestore.document.update`
-     * * `google.firestore.document.delete`
-     * * `google.pubsub.topic.publish`
-     * * `google.firebase.remoteconfig.update`
-     * * `google.storage.object.finalize`
-     * * `google.storage.object.archive`
-     * * `google.storage.object.delete`
-     * * `google.storage.object.metadataUpdate`
-     * * `google.testing.testMatrix.complete`
-     */
-    eventType: string;
-    /**
-     * An object containing the values of the wildcards in the `path` parameter
-     * provided to the [`ref()`](providers_database_.html#ref) method for a Realtime
-     * Database trigger. Cannot be accessed while inside the handler namespace.
-     */
-    params: {
-        [option: string]: any;
-    };
-    /**
-     * The resource that emitted the event. Valid values are:
-     *
-     * * Analytics &mdash; `projects/<projectId>/events/<analyticsEventType>`
-     * * Realtime Database &mdash;
-         `projects/_/instances/<databaseInstance>/refs/<databasePath>`
-     * * Storage &mdash;
-        `projects/_/buckets/<bucketName>/objects/<fileName>#<generation>`
-     * * Authentication &mdash; `projects/<projectId>`
-     * * Pub/Sub &mdash; `projects/<projectId>/topics/<topicName>`
-     *
-     * Because Realtime Database instances and Cloud Storage buckets are globally
-     * unique and not tied to the project, their resources start with `projects/_`.
-     * Underscore is not a valid project name.
-     */
-    resource: Resource;
-    /**
-     * Timestamp for the event as an
-     * [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) string.
-     */
-    timestamp: string;
-}
-/**
- * Resource is a standard format for defining a resource
- * (google.rpc.context.AttributeContext.Resource). In Cloud Functions, it is the
- * resource that triggered the function - such as a storage bucket.
- */
-export interface Resource {
-    service: string;
-    name: string;
-    type?: string;
-    labels?: {
-        [tag: string]: string;
-    };
-}
-/**
- * TriggerAnnotion is used internally by the firebase CLI to understand what
- * type of Cloud Function to deploy.
- */
-interface TriggerAnnotation {
-    availableMemoryMb?: number;
-    blockingTrigger?: {
-        eventType: string;
-        options?: Record<string, unknown>;
-    };
-    eventTrigger?: {
-        eventType: string;
-        resource: string;
-        service: string;
-    };
-    failurePolicy?: FailurePolicy;
-    httpsTrigger?: {
-        invoker?: string[];
-    };
-    labels?: {
-        [key: string]: string;
-    };
-    regions?: string[];
-    schedule?: Schedule;
-    timeout?: Duration;
-    vpcConnector?: string;
-    vpcConnectorEgressSettings?: string;
-    serviceAccountEmail?: string;
-    ingressSettings?: string;
-    secrets?: string[];
-}
-/**
- * A Runnable has a `run` method which directly invokes the user-defined
- * function - useful for unit testing.
- */
-export interface Runnable<T> {
-    run: (data: T, context: any) => PromiseLike<any> | any;
-}
-/**
- * The Cloud Function type for HTTPS triggers. This should be exported from your
- * JavaScript file to define a Cloud Function.
- *
- * This type is a special JavaScript function which takes Express
- * [`Request`](https://expressjs.com/en/api.html#req) and
- * [`Response`](https://expressjs.com/en/api.html#res) objects as its only
- * arguments.
- */
-export interface HttpsFunction {
-    (req: Request, resp: Response): void | Promise<void>;
-    /** @alpha */
-    __trigger: TriggerAnnotation;
-    /** @alpha */
-    __endpoint: ManifestEndpoint;
-    /** @alpha */
-    __requiredAPIs?: ManifestRequiredAPI[];
-}
-/**
- * The Cloud Function type for Blocking triggers.
- */
-export interface BlockingFunction {
-    (req: Request, resp: Response): void | Promise<void>;
-    /** @alpha */
-    __trigger: TriggerAnnotation;
-    /** @alpha */
-    __endpoint: ManifestEndpoint;
-    /** @alpha */
-    __requiredAPIs?: ManifestRequiredAPI[];
-}
-/**
- * The Cloud Function type for all non-HTTPS triggers. This should be exported
- * from your JavaScript file to define a Cloud Function.
- *
- * This type is a special JavaScript function which takes a templated
- * `Event` object as its only argument.
- */
-export interface CloudFunction<T> extends Runnable<T> {
-    (input: any, context?: any): PromiseLike<any> | any;
-    /** @alpha */
-    __trigger: TriggerAnnotation;
-    /** @alpha */
-    __endpoint: ManifestEndpoint;
-    /** @alpha */
-    __requiredAPIs?: ManifestRequiredAPI[];
-}
-/** @hidden */
-export interface MakeCloudFunctionArgs<EventData> {
-    after?: (raw: Event) => void;
-    before?: (raw: Event) => void;
-    contextOnlyHandler?: (context: EventContext) => PromiseLike<any> | any;
-    dataConstructor?: (raw: Event) => EventData;
-    eventType: string;
-    handler?: (data: EventData, context: EventContext) => PromiseLike<any> | any;
-    labels?: Record<string, string>;
-    legacyEventType?: string;
-    options?: DeploymentOptions;
-    provider: string;
-    service: string;
-    triggerResource: () => string;
-}
-/** @hidden */
-export declare function makeCloudFunction<EventData>({ after, before, contextOnlyHandler, dataConstructor, eventType, handler, labels, legacyEventType, options, provider, service, triggerResource, }: MakeCloudFunctionArgs<EventData>): CloudFunction<EventData>;
-/** @hidden */
-export declare function optionsToTrigger(options: DeploymentOptions): any;
-export declare function optionsToEndpoint(options: DeploymentOptions): ManifestEndpoint;

package/lib/cloud-functions.js

@@ -1,251 +0,0 @@
-"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.optionsToEndpoint = exports.optionsToTrigger = exports.makeCloudFunction = exports.Change = void 0;
-const _ = require("lodash");
-const function_configuration_1 = require("./function-configuration");
-const logger_1 = require("./logger");
-const encoding_1 = require("./common/encoding");
-var change_1 = require("./common/change");
-Object.defineProperty(exports, "Change", { enumerable: true, get: function () { return change_1.Change; } });
-/** @hidden */
-const WILDCARD_REGEX = new RegExp('{[^/{}]*}', 'g');
-/** @hidden */
-function makeCloudFunction({ after = () => { }, before = () => { }, contextOnlyHandler, dataConstructor = (raw) => raw.data, eventType, handler, labels = {}, legacyEventType, options = {}, provider, service, triggerResource, }) {
-    const cloudFunction = (data, context) => {
-        if (legacyEventType && context.eventType === legacyEventType) {
-            /*
-             * v1beta1 event flow has different format for context, transform them to
-             * new format.
-             */
-            context.eventType = provider + '.' + eventType;
-            context.resource = {
-                service,
-                name: context.resource,
-            };
-        }
-        const event = {
-            data,
-            context,
-        };
-        if (provider === 'google.firebase.database') {
-            context.authType = _detectAuthType(event);
-            if (context.authType !== 'ADMIN') {
-                context.auth = _makeAuth(event, context.authType);
-            }
-            else {
-                delete context.auth;
-            }
-        }
-        if (triggerResource() == null) {
-            Object.defineProperty(context, 'params', {
-                get: () => {
-                    throw new Error('context.params is not available when using the handler namespace.');
-                },
-            });
-        }
-        else {
-            context.params = context.params || _makeParams(context, triggerResource);
-        }
-        before(event);
-        let promise;
-        if (labels && labels['deployment-scheduled']) {
-            // Scheduled function do not have meaningful data, so exclude it
-            promise = contextOnlyHandler(context);
-        }
-        else {
-            const dataOrChange = dataConstructor(event);
-            promise = handler(dataOrChange, context);
-        }
-        if (typeof promise === 'undefined') {
-            (0, logger_1.warn)('Function returned undefined, expected Promise or value');
-        }
-        return Promise.resolve(promise)
-            .then((result) => {
-            after(event);
-            return result;
-        })
-            .catch((err) => {
-            after(event);
-            return Promise.reject(err);
-        });
-    };
-    Object.defineProperty(cloudFunction, '__trigger', {
-        get: () => {
-            if (triggerResource() == null) {
-                return {};
-            }
-            const trigger = _.assign(optionsToTrigger(options), {
-                eventTrigger: {
-                    resource: triggerResource(),
-                    eventType: legacyEventType || provider + '.' + eventType,
-                    service,
-                },
-            });
-            if (!_.isEmpty(labels)) {
-                trigger.labels = { ...trigger.labels, ...labels };
-            }
-            return trigger;
-        },
-    });
-    Object.defineProperty(cloudFunction, '__endpoint', {
-        get: () => {
-            if (triggerResource() == null) {
-                return undefined;
-            }
-            const endpoint = {
-                platform: 'gcfv1',
-                ...optionsToEndpoint(options),
-            };
-            if (options.schedule) {
-                endpoint.scheduleTrigger = options.schedule;
-            }
-            else {
-                endpoint.eventTrigger = {
-                    eventType: legacyEventType || provider + '.' + eventType,
-                    eventFilters: {
-                        resource: triggerResource(),
-                    },
-                    retry: !!options.failurePolicy,
-                };
-            }
-            // Note: We intentionally don't make use of labels args here.
-            // labels is used to pass SDK-defined labels to the trigger, which isn't
-            // something we will do in the container contract world.
-            endpoint.labels = { ...endpoint.labels };
-            return endpoint;
-        },
-    });
-    if (options.schedule) {
-        cloudFunction.__requiredAPIs = [
-            {
-                api: 'cloudscheduler.googleapis.com',
-                reason: 'Needed for scheduled functions.',
-            },
-        ];
-    }
-    cloudFunction.run = handler || contextOnlyHandler;
-    return cloudFunction;
-}
-exports.makeCloudFunction = makeCloudFunction;
-/** @hidden */
-function _makeParams(context, triggerResourceGetter) {
-    if (context.params) {
-        // In unit testing, user may directly provide `context.params`.
-        return context.params;
-    }
-    if (!context.resource) {
-        // In unit testing, `resource` may be unpopulated for a test event.
-        return {};
-    }
-    const triggerResource = triggerResourceGetter();
-    const wildcards = triggerResource.match(WILDCARD_REGEX);
-    const params = {};
-    if (wildcards) {
-        const triggerResourceParts = _.split(triggerResource, '/');
-        const eventResourceParts = _.split(context.resource.name, '/');
-        _.forEach(wildcards, (wildcard) => {
-            const wildcardNoBraces = wildcard.slice(1, -1);
-            const position = _.indexOf(triggerResourceParts, wildcard);
-            params[wildcardNoBraces] = eventResourceParts[position];
-        });
-    }
-    return params;
-}
-/** @hidden */
-function _makeAuth(event, authType) {
-    if (authType === 'UNAUTHENTICATED') {
-        return null;
-    }
-    return {
-        uid: _.get(event, 'context.auth.variable.uid'),
-        token: _.get(event, 'context.auth.variable.token'),
-    };
-}
-/** @hidden */
-function _detectAuthType(event) {
-    if (_.get(event, 'context.auth.admin')) {
-        return 'ADMIN';
-    }
-    if (_.has(event, 'context.auth.variable')) {
-        return 'USER';
-    }
-    return 'UNAUTHENTICATED';
-}
-/** @hidden */
-function optionsToTrigger(options) {
-    const trigger = {};
-    (0, encoding_1.copyIfPresent)(trigger, options, 'regions', 'schedule', 'minInstances', 'maxInstances', 'ingressSettings', 'vpcConnectorEgressSettings', 'vpcConnector', 'labels', 'secrets');
-    (0, encoding_1.convertIfPresent)(trigger, options, 'failurePolicy', 'failurePolicy', (policy) => {
-        if (policy === false) {
-            return undefined;
-        }
-        else if (policy === true) {
-            return function_configuration_1.DEFAULT_FAILURE_POLICY;
-        }
-        else {
-            return policy;
-        }
-    });
-    (0, encoding_1.convertIfPresent)(trigger, options, 'timeout', 'timeoutSeconds', encoding_1.durationFromSeconds);
-    (0, encoding_1.convertIfPresent)(trigger, options, 'availableMemoryMb', 'memory', (mem) => {
-        const memoryLookup = {
-            '128MB': 128,
-            '256MB': 256,
-            '512MB': 512,
-            '1GB': 1024,
-            '2GB': 2048,
-            '4GB': 4096,
-            '8GB': 8192,
-        };
-        return memoryLookup[mem];
-    });
-    (0, encoding_1.convertIfPresent)(trigger, options, 'serviceAccountEmail', 'serviceAccount', encoding_1.serviceAccountFromShorthand);
-    return trigger;
-}
-exports.optionsToTrigger = optionsToTrigger;
-function optionsToEndpoint(options) {
-    const endpoint = {};
-    (0, encoding_1.copyIfPresent)(endpoint, options, 'minInstances', 'maxInstances', 'ingressSettings', 'labels', 'timeoutSeconds');
-    (0, encoding_1.convertIfPresent)(endpoint, options, 'region', 'regions');
-    (0, encoding_1.convertIfPresent)(endpoint, options, 'serviceAccountEmail', 'serviceAccount', (sa) => sa);
-    (0, encoding_1.convertIfPresent)(endpoint, options, 'secretEnvironmentVariables', 'secrets', (secrets) => secrets.map((secret) => ({ key: secret })));
-    if (options === null || options === void 0 ? void 0 : options.vpcConnector) {
-        endpoint.vpc = { connector: options.vpcConnector };
-        (0, encoding_1.convertIfPresent)(endpoint.vpc, options, 'egressSettings', 'vpcConnectorEgressSettings');
-    }
-    (0, encoding_1.convertIfPresent)(endpoint, options, 'availableMemoryMb', 'memory', (mem) => {
-        const memoryLookup = {
-            '128MB': 128,
-            '256MB': 256,
-            '512MB': 512,
-            '1GB': 1024,
-            '2GB': 2048,
-            '4GB': 4096,
-            '8GB': 8192,
-        };
-        return memoryLookup[mem];
-    });
-    return endpoint;
-}
-exports.optionsToEndpoint = optionsToEndpoint;

package/lib/config.d.ts

@@ -1,24 +0,0 @@
-import * as firebase from 'firebase-admin';
-export declare function config(): config.Config;
-/**
- * Store and retrieve project configuration data such as third-party API
- * keys or other settings. You can set configuration values using the
- * Firebase CLI as described in
- * [Environment Configuration](/docs/functions/config-env).
- */
-export declare namespace config {
-    /**
-     * The Functions configuration interface.
-     *
-     * Access via `functions.config()`.
-     */
-    interface Config {
-        [key: string]: any;
-    }
-    /** @hidden */
-    let singleton: config.Config;
-}
-/** @hidden */
-export declare let firebaseConfigCache: firebase.AppOptions | null;
-/** @hidden */
-export declare function firebaseConfig(): firebase.AppOptions | null;