firebase-functions 3.24.1 → 4.0.0-rc.0

package/lib/config.js

@@ -1,117 +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.firebaseConfig = exports.firebaseConfigCache = exports.config = void 0;
-const fs = require("fs");
-const path = require("path");
-function config() {
-    // K_CONFIGURATION is only set in GCFv2
-    if (process.env.K_CONFIGURATION) {
-        throw new Error('functions.config() is no longer available in Cloud Functions for ' +
-            'Firebase v2. Please see the latest documentation for information ' +
-            'on how to transition to using environment variables');
-    }
-    if (typeof config.singleton === 'undefined') {
-        init();
-    }
-    return config.singleton;
-}
-exports.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).
- */
-(function (config) {
-})(config = exports.config || (exports.config = {}));
-/** @hidden */
-exports.firebaseConfigCache = null;
-/** @hidden */
-function firebaseConfig() {
-    if (exports.firebaseConfigCache) {
-        return exports.firebaseConfigCache;
-    }
-    let env = process.env.FIREBASE_CONFIG;
-    if (env) {
-        // Firebase Tools will always use a JSON blob in prod, but docs
-        // explicitly state that the user can set the env to a file:
-        // https://firebase.google.com/docs/admin/setup#initialize-without-parameters
-        if (!env.startsWith('{')) {
-            env = fs.readFileSync(path.join(process.env.PWD, env)).toString('utf8');
-        }
-        exports.firebaseConfigCache = JSON.parse(env);
-        return exports.firebaseConfigCache;
-    }
-    // Could have Runtime Config with Firebase in it as an ENV value.
-    try {
-        const config = JSON.parse(process.env.CLOUD_RUNTIME_CONFIG);
-        if (config.firebase) {
-            exports.firebaseConfigCache = config.firebase;
-            return exports.firebaseConfigCache;
-        }
-    }
-    catch (e) {
-        // Do nothing
-    }
-    // Could have Runtime Config with Firebase in it as an ENV location or default.
-    try {
-        const configPath = process.env.CLOUD_RUNTIME_CONFIG ||
-            path.join(process.cwd(), '.runtimeconfig.json');
-        const contents = fs.readFileSync(configPath);
-        const config = JSON.parse(contents.toString('utf8'));
-        if (config.firebase) {
-            exports.firebaseConfigCache = config.firebase;
-            return exports.firebaseConfigCache;
-        }
-    }
-    catch (e) {
-        // Do nothing
-    }
-    return null;
-}
-exports.firebaseConfig = firebaseConfig;
-function init() {
-    try {
-        const parsed = JSON.parse(process.env.CLOUD_RUNTIME_CONFIG);
-        delete parsed.firebase;
-        config.singleton = parsed;
-        return;
-    }
-    catch (e) {
-        // Do nothing
-    }
-    try {
-        const configPath = process.env.CLOUD_RUNTIME_CONFIG ||
-            path.join(process.cwd(), '.runtimeconfig.json');
-        const contents = fs.readFileSync(configPath);
-        const parsed = JSON.parse(contents.toString('utf8'));
-        delete parsed.firebase;
-        config.singleton = parsed;
-        return;
-    }
-    catch (e) {
-        // Do nothing
-    }
-    config.singleton = {};
-}

package/lib/function-configuration.d.ts

@@ -1,108 +0,0 @@
-import { Expression } from './v2/params';
-/**
- * List of all regions supported by Cloud Functions.
- */
-export declare const SUPPORTED_REGIONS: readonly ["us-central1", "us-east1", "us-east4", "us-west2", "us-west3", "us-west4", "europe-central2", "europe-west1", "europe-west2", "europe-west3", "europe-west6", "asia-east1", "asia-east2", "asia-northeast1", "asia-northeast2", "asia-northeast3", "asia-south1", "asia-southeast1", "asia-southeast2", "northamerica-northeast1", "southamerica-east1", "australia-southeast1"];
-/**
- * Cloud Functions min timeout value.
- */
-export declare const MIN_TIMEOUT_SECONDS = 0;
-/**
- * Cloud Functions max timeout value.
- */
-export declare const MAX_TIMEOUT_SECONDS = 540;
-/**
- * List of available memory options supported by Cloud Functions.
- */
-export declare const VALID_MEMORY_OPTIONS: readonly ["128MB", "256MB", "512MB", "1GB", "2GB", "4GB", "8GB"];
-/**
- * List of available options for VpcConnectorEgressSettings.
- */
-export declare const VPC_EGRESS_SETTINGS_OPTIONS: readonly ["VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED", "PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"];
-/**
- * List of available options for IngressSettings.
- */
-export declare const INGRESS_SETTINGS_OPTIONS: readonly ["INGRESS_SETTINGS_UNSPECIFIED", "ALLOW_ALL", "ALLOW_INTERNAL_ONLY", "ALLOW_INTERNAL_AND_GCLB"];
-/**
- * Scheduler retry options. Applies only to scheduled functions.
- */
-export interface ScheduleRetryConfig {
-    retryCount?: number | Expression<number> | null;
-    maxRetryDuration?: string | Expression<string> | null;
-    minBackoffDuration?: string | Expression<string> | null;
-    maxBackoffDuration?: string | Expression<string> | null;
-    maxDoublings?: number | Expression<number> | null;
-}
-/**
- * Configuration options for scheduled functions.
- */
-export interface Schedule {
-    schedule: string;
-    timeZone?: string;
-    retryConfig?: ScheduleRetryConfig;
-}
-export interface FailurePolicy {
-    retry: {};
-}
-export declare const DEFAULT_FAILURE_POLICY: FailurePolicy;
-export declare const MAX_NUMBER_USER_LABELS = 58;
-export interface RuntimeOptions {
-    /**
-     * Which platform should host the backend. Valid options are "gcfv1"
-     * @hidden
-     */
-    platform?: 'gcfv1';
-    /**
-     * Failure policy of the function, with boolean `true` being equivalent to
-     * providing an empty retry object.
-     */
-    failurePolicy?: FailurePolicy | boolean;
-    /**
-     * Amount of memory to allocate to the function.
-     */
-    memory?: typeof VALID_MEMORY_OPTIONS[number];
-    /**
-     * Timeout for the function in seconds, possible values are 0 to 540.
-     */
-    timeoutSeconds?: number;
-    /**
-     * Min number of actual instances to be running at a given time.
-     * Instances will be billed for memory allocation and 10% of CPU allocation
-     * while idle.
-     */
-    minInstances?: number;
-    /**
-     * Max number of actual instances allowed to be running in parallel.
-     */
-    maxInstances?: number;
-    /**
-     * Connect cloud function to specified VPC connector.
-     */
-    vpcConnector?: string;
-    /**
-     * Egress settings for VPC connector.
-     */
-    vpcConnectorEgressSettings?: typeof VPC_EGRESS_SETTINGS_OPTIONS[number];
-    /**
-     * Specific service account for the function to run as.
-     */
-    serviceAccount?: 'default' | string;
-    /**
-     * Ingress settings which control where this function can be called from.
-     */
-    ingressSettings?: typeof INGRESS_SETTINGS_OPTIONS[number];
-    /**
-     * User labels to set on the function.
-     */
-    labels?: Record<string, string>;
-    /**
-     * Invoker to set access control on https functions.
-     */
-    invoker?: 'public' | 'private' | string | string[];
-    allowInvalidAppCheckToken?: boolean;
-    secrets?: string[];
-}
-export interface DeploymentOptions extends RuntimeOptions {
-    regions?: Array<typeof SUPPORTED_REGIONS[number] | string>;
-    schedule?: Schedule;
-}

package/lib/function-configuration.js

@@ -1,71 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MAX_NUMBER_USER_LABELS = exports.DEFAULT_FAILURE_POLICY = exports.INGRESS_SETTINGS_OPTIONS = exports.VPC_EGRESS_SETTINGS_OPTIONS = exports.VALID_MEMORY_OPTIONS = exports.MAX_TIMEOUT_SECONDS = exports.MIN_TIMEOUT_SECONDS = exports.SUPPORTED_REGIONS = void 0;
-/**
- * List of all regions supported by Cloud Functions.
- */
-exports.SUPPORTED_REGIONS = [
-    'us-central1',
-    'us-east1',
-    'us-east4',
-    'us-west2',
-    'us-west3',
-    'us-west4',
-    'europe-central2',
-    'europe-west1',
-    'europe-west2',
-    'europe-west3',
-    'europe-west6',
-    'asia-east1',
-    'asia-east2',
-    'asia-northeast1',
-    'asia-northeast2',
-    'asia-northeast3',
-    'asia-south1',
-    'asia-southeast1',
-    'asia-southeast2',
-    'northamerica-northeast1',
-    'southamerica-east1',
-    'australia-southeast1',
-];
-/**
- * Cloud Functions min timeout value.
- */
-exports.MIN_TIMEOUT_SECONDS = 0;
-/**
- * Cloud Functions max timeout value.
- */
-exports.MAX_TIMEOUT_SECONDS = 540;
-/**
- * List of available memory options supported by Cloud Functions.
- */
-exports.VALID_MEMORY_OPTIONS = [
-    '128MB',
-    '256MB',
-    '512MB',
-    '1GB',
-    '2GB',
-    '4GB',
-    '8GB',
-];
-/**
- * List of available options for VpcConnectorEgressSettings.
- */
-exports.VPC_EGRESS_SETTINGS_OPTIONS = [
-    'VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED',
-    'PRIVATE_RANGES_ONLY',
-    'ALL_TRAFFIC',
-];
-/**
- * List of available options for IngressSettings.
- */
-exports.INGRESS_SETTINGS_OPTIONS = [
-    'INGRESS_SETTINGS_UNSPECIFIED',
-    'ALLOW_ALL',
-    'ALLOW_INTERNAL_ONLY',
-    'ALLOW_INTERNAL_AND_GCLB',
-];
-exports.DEFAULT_FAILURE_POLICY = {
-    retry: {},
-};
-exports.MAX_NUMBER_USER_LABELS = 58;

package/lib/handler-builder.d.ts

@@ -1,256 +0,0 @@
-import * as express from 'express';
-import { CloudFunction, EventContext, HttpsFunction } from './cloud-functions';
-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';
-/**
- * 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).
- */
-export declare 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(): {
-        onRequest: (handler: (req: express.Request, resp: express.Response) => void) => HttpsFunction;
-        onCall: (handler: (data: any, context: https.CallableContext) => any | Promise<any>) => HttpsFunction;
-    };
-    /**
-     * Create a handler for tasks functions.
-     *
-     * @example
-     * ```javascript
-     * exports.myFunction = functions.handler.tasks.onDispatch((data, context) => { ... })
-     * ```
-     */
-    /** @hidden */
-    get tasks(): {
-        readonly taskQueue: {
-            onDispatch: (handler: (data: any, context: tasks.TaskContext) => void | Promise<void>) => HttpsFunction;
-        };
-    };
-    /**
-     * 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(): {
-        /** @hidden */
-        readonly instance: {
-            readonly ref: database.RefBuilder;
-        };
-        readonly ref: database.RefBuilder;
-    };
-    /**
-     * 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(): {
-        readonly document: firestore.DocumentBuilder;
-        /** @hidden */
-        readonly namespace: firestore.DocumentBuilder;
-        /** @hidden */
-        readonly database: firestore.DocumentBuilder;
-    };
-    /**
-     * 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(): {
-        onUpdate: (handler: (version: remoteConfig.TemplateVersion, context: EventContext) => PromiseLike<any> | any) => CloudFunction<remoteConfig.TemplateVersion>;
-    };
-    /**
-     * 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(): {
-        readonly event: analytics.AnalyticsEventBuilder;
-    };
-    /**
-     * 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(): {
-        readonly bucket: storage.ObjectBuilder;
-        readonly object: storage.ObjectBuilder;
-    };
-    /**
-     * 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(): {
-        readonly topic: pubsub.TopicBuilder;
-        readonly schedule: pubsub.ScheduleBuilder;
-    };
-    /**
-     * 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(): {
-        readonly user: auth.UserBuilder;
-    };
-    /**
-     * 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(): {
-        readonly testMatrix: testLab.TestMatrixBuilder;
-    };
-}
-export declare let handler: HandlerBuilder;