firebase-functions 3.24.1 → 4.0.0-rc.0

package/lib/handler-builder.js

@@ -1,349 +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.handler = exports.HandlerBuilder = void 0;
-const apps_1 = require("./apps");
-const analytics = require("./providers/analytics");
-const auth = require("./providers/auth");
-const database = require("./providers/database");
-const firestore = require("./providers/firestore");
-const https = require("./providers/https");
-const pubsub = require("./providers/pubsub");
-const remoteConfig = require("./providers/remoteConfig");
-const storage = require("./providers/storage");
-const tasks = require("./providers/tasks");
-const testLab = require("./providers/testLab");
-/**
- * The `HandlerBuilder` class facilitates the writing of functions by developers
- * building Firebase Extensions as well as developers who want to use the gcloud CLI or
- * Google Cloud Console to deploy their functions.
- *
- * **Do not use `HandlerBuilder` when writing normal functions for deployment via
- * the Firebase CLI.** For normal purposes, use
- * [`FunctionBuilder`](/docs/reference/functions/function_builder_.functionbuilder).
- */
-class HandlerBuilder {
-    constructor() { }
-    /**
-     * Create a handler for HTTPS events.
-  
-     * `onRequest` handles an HTTPS request and has the same signature as an Express app.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.https.onRequest((req, res) => { ... })
-     * ```
-     *
-     * `onCall` declares a callable function for clients to call using a Firebase SDK.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.https.onCall((data, context) => { ... })
-     * ```
-     */
-    get https() {
-        return {
-            onRequest: (handler) => {
-                const func = https._onRequestWithOptions(handler, {});
-                func.__trigger = {};
-                func.__endpoint = undefined;
-                func.__requiredAPIs = undefined;
-                return func;
-            },
-            onCall: (handler) => {
-                const func = https._onCallWithOptions(handler, {});
-                func.__trigger = {};
-                func.__endpoint = undefined;
-                func.__requiredAPIs = undefined;
-                return func;
-            },
-        };
-    }
-    /**
-     * Create a handler for tasks functions.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.tasks.onDispatch((data, context) => { ... })
-     * ```
-     */
-    /** @hidden */
-    get tasks() {
-        return {
-            get taskQueue() {
-                return {
-                    onDispatch: (handler) => {
-                        const builder = new tasks.TaskQueueBuilder();
-                        const func = builder.onDispatch(handler);
-                        func.__trigger = {};
-                        func.__endpoint = undefined;
-                        func.__requiredAPIs = undefined;
-                        return func;
-                    },
-                };
-            },
-        };
-    }
-    /**
-     * Create a handler for Firebase Realtime Database events.
-     *
-     * `ref.onCreate` handles the creation of new data.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.database.ref.onCreate((snap, context) => { ... })
-     * ```
-     *
-     * `ref.onUpdate` handles updates to existing data.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.database.ref.onUpdate((change, context) => { ... })
-     * ```
-  
-     * `ref.onDelete` handles the deletion of existing data.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.database.ref.onDelete((snap, context) => { ... })
-     * ```
-  
-     * `ref.onWrite` handles the creation, update, or deletion of data.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.database.ref.onWrite((change, context) => { ... })
-     * ```
-     */
-    get database() {
-        return {
-            /** @hidden */
-            get instance() {
-                return {
-                    get ref() {
-                        return new database.RefBuilder((0, apps_1.apps)(), () => null, {});
-                    },
-                };
-            },
-            get ref() {
-                return new database.RefBuilder((0, apps_1.apps)(), () => null, {});
-            },
-        };
-    }
-    /**
-     * Create a handler for Cloud Firestore events.
-     *
-     * `document.onCreate` handles the creation of new documents.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.firestore.document.onCreate((snap, context) => { ... })
-     * ```
-  
-     * `document.onUpdate` handles updates to existing documents.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.firestore.document.onUpdate((change, context) => { ... })
-     * ```
-  
-     * `document.onDelete` handles the deletion of existing documents.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.firestore.document.onDelete((snap, context) =>
-     * { ... })
-     * ```
-  
-     * `document.onWrite` handles the creation, update, or deletion of documents.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.firestore.document.onWrite((change, context) =>
-     * { ... })
-     * ```
-     */
-    get firestore() {
-        return {
-            get document() {
-                return new firestore.DocumentBuilder(() => null, {});
-            },
-            /** @hidden */
-            get namespace() {
-                return new firestore.DocumentBuilder(() => null, {});
-            },
-            /** @hidden */
-            get database() {
-                return new firestore.DocumentBuilder(() => null, {});
-            },
-        };
-    }
-    /**
-     * Create a handler for Firebase Remote Config events.
-  
-     * `remoteConfig.onUpdate` handles events that update a Remote Config template.
-  
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.remoteConfig.onUpdate() => { ... })
-     * ```
-     */
-    get remoteConfig() {
-        return {
-            onUpdate: (handler) => {
-                return new remoteConfig.UpdateBuilder(() => null, {}).onUpdate(handler);
-            },
-        };
-    }
-    /**
-     * Create a handler for Google Analytics events.
-  
-     * `event.onLog` handles the logging of Analytics conversion events.
-  
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.analytics.event.onLog((event) => { ... })
-     * ```
-     */
-    get analytics() {
-        return {
-            get event() {
-                return new analytics.AnalyticsEventBuilder(() => null, {});
-            },
-        };
-    }
-    /**
-     * Create a handler for Cloud Storage for Firebase events.
-     *
-     * `object.onArchive` handles the archiving of Storage objects.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.storage.object.onArchive((object) => { ... })
-     * ```
-  
-     * `object.onDelete` handles the deletion of Storage objects.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.storage.object.onDelete((object) => { ... })
-     * ```
-  
-     * `object.onFinalize` handles the creation of Storage objects.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.storage.object.onFinalize((object) =>
-     * { ... })
-     * ```
-  
-     * `object.onMetadataUpdate` handles changes to the metadata of existing Storage objects.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.storage.object.onMetadataUpdate((object) =>
-     * { ... })
-     * ```
-     */
-    get storage() {
-        return {
-            get bucket() {
-                return new storage.BucketBuilder(() => null, {}).object();
-            },
-            get object() {
-                return new storage.ObjectBuilder(() => null, {});
-            },
-        };
-    }
-    /**
-     * Create a handler for Cloud Pub/Sub events.
-     *
-     * `topic.onPublish` handles messages published to a Pub/Sub topic from SDKs, Cloud Console, or gcloud CLI.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.pubsub.topic.onPublish((message) => { ... })
-     * ```
-  
-     * `schedule.onPublish` handles messages published to a Pub/Sub topic on a schedule.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.pubsub.schedule.onPublish((message) => { ... })
-     * ```
-     */
-    get pubsub() {
-        return {
-            get topic() {
-                return new pubsub.TopicBuilder(() => null, {});
-            },
-            get schedule() {
-                return new pubsub.ScheduleBuilder(() => null, {});
-            },
-        };
-    }
-    /**
-     * Create a handler for Firebase Authentication events.
-     *
-     * `user.onCreate` handles the creation of users.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.auth.user.onCreate((user) => { ... })
-     * ```
-  
-     * `user.onDelete` handles the deletion of users.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.auth.user.onDelete((user => { ... })
-     * ```
-  
-     */
-    get auth() {
-        return {
-            get user() {
-                return new auth.UserBuilder(() => null, {}, {});
-            },
-        };
-    }
-    /**
-     * Create a handler for Firebase Test Lab events.
-  
-     * `testMatrix.onComplete` handles the completion of a test matrix.
-  
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.testLab.testMatrix.onComplete((testMatrix) => { ... })
-     * ```
-     */
-    get testLab() {
-        return {
-            get testMatrix() {
-                return new testLab.TestMatrixBuilder(() => null, {});
-            },
-        };
-    }
-}
-exports.HandlerBuilder = HandlerBuilder;
-exports.handler = new HandlerBuilder();

package/lib/index.d.ts

@@ -1,19 +0,0 @@
-import * as analytics from './providers/analytics';
-import * as auth from './providers/auth';
-import * as database from './providers/database';
-import * as firestore from './providers/firestore';
-import * as https from './providers/https';
-import * as pubsub from './providers/pubsub';
-import * as remoteConfig from './providers/remoteConfig';
-import * as storage from './providers/storage';
-import * as tasks from './providers/tasks';
-import * as testLab from './providers/testLab';
-import * as apps from './apps';
-import { handler } from './handler-builder';
-import * as logger from './logger';
-declare const app: apps.apps.Apps;
-export { analytics, app, auth, database, firestore, handler, https, pubsub, remoteConfig, storage, tasks, testLab, logger, };
-export * from './cloud-functions';
-export * from './config';
-export * from './function-builder';
-export * from './function-configuration';

package/lib/setup.d.ts

@@ -1 +0,0 @@
-export declare function setup(): void;

package/lib/setup.js

@@ -1,60 +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.setup = void 0;
-/** @hidden */
-const config_1 = require("./config");
-const logger_1 = require("./logger");
-// Set up for config and vars
-function setup() {
-    // TEMPORARY WORKAROUND (BUG 63586213):
-    // Until the Cloud Functions builder can publish FIREBASE_CONFIG, automatically provide it on import based on what
-    // we can deduce.
-    if (!process.env.FIREBASE_CONFIG) {
-        const cfg = (0, config_1.firebaseConfig)();
-        if (cfg) {
-            process.env.FIREBASE_CONFIG = JSON.stringify(cfg);
-        }
-    }
-    // WORKAROUND (BUG 134416569): GCLOUD_PROJECT missing in Node 10
-    if (!process.env.GCLOUD_PROJECT && process.env.FIREBASE_CONFIG) {
-        process.env.GCLOUD_PROJECT = JSON.parse(process.env.FIREBASE_CONFIG).projectId;
-    }
-    // If FIREBASE_CONFIG is still not found, try using GCLOUD_PROJECT to estimate
-    if (!process.env.FIREBASE_CONFIG) {
-        if (process.env.GCLOUD_PROJECT) {
-            (0, logger_1.warn)('Warning, estimating Firebase Config based on GCLOUD_PROJECT. Initializing firebase-admin may fail');
-            process.env.FIREBASE_CONFIG = JSON.stringify({
-                databaseURL: process.env.DATABASE_URL ||
-                    `https://${process.env.GCLOUD_PROJECT}.firebaseio.com`,
-                storageBucket: process.env.STORAGE_BUCKET_URL ||
-                    `${process.env.GCLOUD_PROJECT}.appspot.com`,
-                projectId: process.env.GCLOUD_PROJECT,
-            });
-        }
-        else {
-            (0, logger_1.warn)('Warning, FIREBASE_CONFIG and GCLOUD_PROJECT environment variables are missing. Initializing firebase-admin will fail');
-        }
-    }
-}
-exports.setup = setup;

package/lib/v2/params/types.d.ts

@@ -1,118 +0,0 @@
-export declare abstract class Expression<T extends string | number | boolean | string[]> {
-    value(): T;
-    toCEL(): string;
-    toJSON(): string;
-}
-/**
- * A CEL expression corresponding to a ternary operator, e.g {{ cond ? ifTrue : ifFalse }}
- */
-export declare class TernaryExpression<T extends string | number | boolean | string[]> extends Expression<T> {
-    private readonly test;
-    private readonly ifTrue;
-    private readonly ifFalse;
-    constructor(test: Expression<boolean>, ifTrue: T, ifFalse: T);
-    value(): T;
-    toString(): string;
-}
-/**
- * A CEL expression that evaluates to boolean true or false based on a comparison
- * between the value of another expression and a literal of that same type.
- */
-export declare class CompareExpression<T extends string | number | boolean | string[]> extends Expression<boolean> {
-    cmp: '==' | '>' | '>=' | '<' | '<=';
-    lhs: Expression<T>;
-    rhs: T;
-    constructor(cmp: '==' | '>' | '>=' | '<' | '<=', lhs: Expression<T>, rhs: T);
-    value(): boolean;
-    toString(): string;
-    then(ifTrue: T, ifFalse: T): TernaryExpression<T>;
-}
-/** @hidden */
-declare type ParamValueType = 'string' | 'list' | 'boolean' | 'int' | 'float' | 'secret';
-declare type ParamInput<T> = {
-    text: TextInput<T>;
-} | {
-    select: SelectInput<T>;
-} | {
-    resource: ResourceInput;
-};
-/**
- * Specifies that a Param's value should be determined by prompting the user
- * to type it in interactively at deploy-time. Input that does not match the
- * provided validationRegex, if present, will be retried.
- */
-export interface TextInput<T = unknown> {
-    example?: string;
-    validationRegex?: string;
-    validationErrorMessage?: string;
-}
-/**
- * Specifies that a Param's value should be determined by having the user
- * select from a list containing all the project's resources of a certain
- * type. Currently, only type:"storage.googleapis.com/Bucket" is supported.
- */
-export interface ResourceInput {
-    resource: {
-        type: string;
-    };
-}
-/**
- * Specifies that a Param's value should be determined by having the user select
- * from a list of pre-canned options interactively at deploy-time.
- */
-export interface SelectInput<T = unknown> {
-    options: Array<SelectOptions<T>>;
-}
-export interface SelectOptions<T = unknown> {
-    label?: string;
-    value: T;
-}
-export interface ParamSpec<T = unknown> {
-    name: string;
-    default?: T;
-    label?: string;
-    description?: string;
-    type: ParamValueType;
-    input?: ParamInput<T>;
-}
-export declare type ParamOptions<T = unknown> = Omit<ParamSpec<T>, 'name' | 'type'>;
-export declare abstract class Param<T extends string | number | boolean | string[]> extends Expression<T> {
-    readonly name: string;
-    readonly options: ParamOptions<T>;
-    static type: ParamValueType;
-    constructor(name: string, options?: ParamOptions<T>);
-    value(): T;
-    cmp(cmp: '==' | '>' | '>=' | '<' | '<=', rhs: T): CompareExpression<T>;
-    equals(rhs: T): CompareExpression<T>;
-    toString(): string;
-    toSpec(): ParamSpec<T>;
-}
-export declare class SecretParam {
-    static type: ParamValueType;
-    name: string;
-    constructor(name: string);
-    value(): string;
-    toSpec(): ParamSpec<string>;
-}
-export declare class StringParam extends Param<string> {
-    value(): string;
-}
-export declare class IntParam extends Param<number> {
-    static type: ParamValueType;
-    value(): number;
-}
-export declare class FloatParam extends Param<number> {
-    static type: ParamValueType;
-    value(): number;
-}
-export declare class BooleanParam extends Param<boolean> {
-    static type: ParamValueType;
-    value(): boolean;
-    then<T extends string | number | boolean>(ifTrue: T, ifFalse: T): TernaryExpression<T>;
-}
-export declare class ListParam extends Param<string[]> {
-    static type: ParamValueType;
-    value(): string[];
-    toSpec(): ParamSpec<string[]>;
-}
-export {};