firebase-functions 3.24.0 → 4.0.0-rc.0

package/lib/{function-builder.d.ts → v1/function-builder.d.ts}

@@ -1,16 +1,16 @@
-import * as express from 'express';
-import { CloudFunction, EventContext } from './cloud-functions';
-import { DeploymentOptions, RuntimeOptions, SUPPORTED_REGIONS } from './function-configuration';
-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 express from "express";
+import { EventContext } from "./cloud-functions";
+import { DeploymentOptions, RuntimeOptions, SUPPORTED_REGIONS } from "./function-configuration";
+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";
 /**
  * Configure the regions that the function is deployed to.
  * @param regions One of more region strings.
@@ -120,7 +120,7 @@ export declare class FunctionBuilder {
          *    information about the user who triggered the Cloud Function.
          * @param ref Path of the database to listen to.
          */
-        ref: (path: string) => database.RefBuilder;
+        ref: <Ref extends string>(path: Ref) => database.RefBuilder<Ref>;
     };
     get firestore(): {
         /**
@@ -130,7 +130,7 @@ export declare class FunctionBuilder {
          * collection is named "users" and the document is named "Ada", then the
          * path is "/users/Ada".
          */
-        document: (path: string) => firestore.DocumentBuilder;
+        document: <Path extends string>(path: Path) => firestore.DocumentBuilder<Path>;
         /** @hidden */
         namespace: (namespace: string) => firestore.NamespaceBuilder;
         /** @hidden */
@@ -150,7 +150,7 @@ export declare class FunctionBuilder {
          * @param handler A function that takes the updated Remote Config template
          * version metadata as an argument.
          */
-        onUpdate: (handler: (version: remoteConfig.TemplateVersion, context: EventContext) => PromiseLike<any> | any) => CloudFunction<remoteConfig.TemplateVersion>;
+        onUpdate: (handler: (version: remoteConfig.TemplateVersion, context: EventContext) => PromiseLike<any> | any) => import("./cloud-functions").CloudFunction<remoteConfig.TemplateVersion>;
     };
     get storage(): {
         /**

package/lib/{function-builder.js → v1/function-builder.js}

@@ -22,7 +22,8 @@
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FunctionBuilder = exports.runWith = exports.region = void 0;
-const _ = require("lodash");
+const options_1 = require("../common/options");
+const types_1 = require("../params/types");
 const function_configuration_1 = require("./function-configuration");
 const analytics = require("./providers/analytics");
 const auth = require("./providers/auth");
@@ -40,37 +41,29 @@ const testLab = require("./providers/testLab");
  * @throws { Error } Memory and TimeoutSeconds values must be valid.
  */
 function assertRuntimeOptionsValid(runtimeOptions) {
-    if (runtimeOptions.memory &&
-        !_.includes(function_configuration_1.VALID_MEMORY_OPTIONS, runtimeOptions.memory)) {
-        throw new Error(`The only valid memory allocation values are: ${function_configuration_1.VALID_MEMORY_OPTIONS.join(', ')}`);
+    const mem = runtimeOptions.memory;
+    if (mem && typeof mem !== "object" && !function_configuration_1.VALID_MEMORY_OPTIONS.includes(mem)) {
+        throw new Error(`The only valid memory allocation values are: ${function_configuration_1.VALID_MEMORY_OPTIONS.join(", ")}`);
     }
-    if (runtimeOptions.timeoutSeconds > function_configuration_1.MAX_TIMEOUT_SECONDS ||
-        runtimeOptions.timeoutSeconds < 0) {
+    if (runtimeOptions.timeoutSeconds > function_configuration_1.MAX_TIMEOUT_SECONDS || runtimeOptions.timeoutSeconds < 0) {
         throw new Error(`TimeoutSeconds must be between 0 and ${function_configuration_1.MAX_TIMEOUT_SECONDS}`);
     }
     if (runtimeOptions.ingressSettings &&
-        !_.includes(function_configuration_1.INGRESS_SETTINGS_OPTIONS, runtimeOptions.ingressSettings)) {
-        throw new Error(`The only valid ingressSettings values are: ${function_configuration_1.INGRESS_SETTINGS_OPTIONS.join(',')}`);
+        !(runtimeOptions.ingressSettings instanceof options_1.ResetValue) &&
+        !function_configuration_1.INGRESS_SETTINGS_OPTIONS.includes(runtimeOptions.ingressSettings)) {
+        throw new Error(`The only valid ingressSettings values are: ${function_configuration_1.INGRESS_SETTINGS_OPTIONS.join(",")}`);
     }
     if (runtimeOptions.vpcConnectorEgressSettings &&
-        !_.includes(function_configuration_1.VPC_EGRESS_SETTINGS_OPTIONS, runtimeOptions.vpcConnectorEgressSettings)) {
-        throw new Error(`The only valid vpcConnectorEgressSettings values are: ${function_configuration_1.VPC_EGRESS_SETTINGS_OPTIONS.join(',')}`);
+        !(runtimeOptions.vpcConnectorEgressSettings instanceof options_1.ResetValue) &&
+        !function_configuration_1.VPC_EGRESS_SETTINGS_OPTIONS.includes(runtimeOptions.vpcConnectorEgressSettings)) {
+        throw new Error(`The only valid vpcConnectorEgressSettings values are: ${function_configuration_1.VPC_EGRESS_SETTINGS_OPTIONS.join(",")}`);
     }
-    if (runtimeOptions.failurePolicy !== undefined) {
-        if (_.isBoolean(runtimeOptions.failurePolicy) === false &&
-            _.isObjectLike(runtimeOptions.failurePolicy) === false) {
-            throw new Error(`failurePolicy must be a boolean or an object.`);
-        }
-        if (typeof runtimeOptions.failurePolicy === 'object') {
-            if (_.isObjectLike(runtimeOptions.failurePolicy.retry) === false ||
-                _.isEmpty(runtimeOptions.failurePolicy.retry) === false) {
-                throw new Error('failurePolicy.retry must be an empty object.');
-            }
-        }
-    }
-    if (runtimeOptions.serviceAccount &&
-        runtimeOptions.serviceAccount !== 'default' &&
-        !_.includes(runtimeOptions.serviceAccount, '@')) {
+    validateFailurePolicy(runtimeOptions.failurePolicy);
+    const serviceAccount = runtimeOptions.serviceAccount;
+    if (serviceAccount &&
+        serviceAccount !== "default" &&
+        !(serviceAccount instanceof options_1.ResetValue) &&
+        !serviceAccount.includes("@")) {
         throw new Error(`serviceAccount must be set to 'default', a service account email, or '{serviceAccountName}@'`);
     }
     if (runtimeOptions.labels) {
@@ -80,61 +73,75 @@ function assertRuntimeOptionsValid(runtimeOptions) {
             throw new Error(`A function must not have more than ${function_configuration_1.MAX_NUMBER_USER_LABELS} user-defined labels.`);
         }
         // We reserve the 'deployment' and 'firebase' namespaces for future feature development.
-        const reservedKeys = Object.keys(runtimeOptions.labels).filter((key) => key.startsWith('deployment') || key.startsWith('firebase'));
+        const reservedKeys = Object.keys(runtimeOptions.labels).filter((key) => key.startsWith("deployment") || key.startsWith("firebase"));
         if (reservedKeys.length) {
-            throw new Error(`Invalid labels: ${reservedKeys.join(', ')}. Labels may not start with reserved names 'deployment' or 'firebase'`);
+            throw new Error(`Invalid labels: ${reservedKeys.join(", ")}. Labels may not start with reserved names 'deployment' or 'firebase'`);
         }
         const invalidLengthKeys = Object.keys(runtimeOptions.labels).filter((key) => key.length < 1 || key.length > 63);
         if (invalidLengthKeys.length > 0) {
-            throw new Error(`Invalid labels: ${invalidLengthKeys.join(', ')}. Label keys must be between 1 and 63 characters in length.`);
+            throw new Error(`Invalid labels: ${invalidLengthKeys.join(", ")}. Label keys must be between 1 and 63 characters in length.`);
         }
         const invalidLengthValues = Object.values(runtimeOptions.labels).filter((value) => value.length > 63);
         if (invalidLengthValues.length > 0) {
-            throw new Error(`Invalid labels: ${invalidLengthValues.join(', ')}. Label values must be less than 64 charcters.`);
+            throw new Error(`Invalid labels: ${invalidLengthValues.join(", ")}. Label values must be less than 64 charcters.`);
         }
         // Keys can contain lowercase letters, foreign characters, numbers, _ or -. They must start with a letter.
         const validKeyPattern = /^[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}$/u;
         const invalidKeys = Object.keys(runtimeOptions.labels).filter((key) => !validKeyPattern.test(key));
         if (invalidKeys.length > 0) {
-            throw new Error(`Invalid labels: ${invalidKeys.join(', ')}. Label keys can only contain lowercase letters, international characters, numbers, _ or -, and must start with a letter.`);
+            throw new Error(`Invalid labels: ${invalidKeys.join(", ")}. Label keys can only contain lowercase letters, international characters, numbers, _ or -, and must start with a letter.`);
         }
         // Values can contain lowercase letters, foreign characters, numbers, _ or -.
         const validValuePattern = /^[\p{Ll}\p{Lo}\p{N}_-]{0,63}$/u;
         const invalidValues = Object.values(runtimeOptions.labels).filter((value) => !validValuePattern.test(value));
         if (invalidValues.length > 0) {
-            throw new Error(`Invalid labels: ${invalidValues.join(', ')}. Label values can only contain lowercase letters, international characters, numbers, _ or -.`);
+            throw new Error(`Invalid labels: ${invalidValues.join(", ")}. Label values can only contain lowercase letters, international characters, numbers, _ or -.`);
         }
     }
-    if (typeof runtimeOptions.invoker === 'string' &&
-        runtimeOptions.invoker.length === 0) {
-        throw new Error('Invalid service account for function invoker, must be a non-empty string');
+    if (typeof runtimeOptions.invoker === "string" && runtimeOptions.invoker.length === 0) {
+        throw new Error("Invalid service account for function invoker, must be a non-empty string");
     }
-    if (runtimeOptions.invoker !== undefined &&
-        Array.isArray(runtimeOptions.invoker)) {
+    if (runtimeOptions.invoker !== undefined && Array.isArray(runtimeOptions.invoker)) {
         if (runtimeOptions.invoker.length === 0) {
-            throw new Error('Invalid invoker array, must contain at least 1 service account entry');
+            throw new Error("Invalid invoker array, must contain at least 1 service account entry");
         }
         for (const serviceAccount of runtimeOptions.invoker) {
             if (serviceAccount.length === 0) {
-                throw new Error('Invalid invoker array, a service account must be a non-empty string');
+                throw new Error("Invalid invoker array, a service account must be a non-empty string");
             }
-            if (serviceAccount === 'public') {
+            if (serviceAccount === "public") {
                 throw new Error("Invalid invoker array, a service account cannot be set to the 'public' identifier");
             }
-            if (serviceAccount === 'private') {
+            if (serviceAccount === "private") {
                 throw new Error("Invalid invoker array, a service account cannot be set to the 'private' identifier");
             }
         }
     }
     if (runtimeOptions.secrets !== undefined) {
-        const invalidSecrets = runtimeOptions.secrets.filter((s) => !/^[A-Za-z\d\-_]+$/.test(s));
+        const invalidSecrets = runtimeOptions.secrets.filter((s) => !/^[A-Za-z\d\-_]+$/.test(s instanceof types_1.SecretParam ? s.name : s));
         if (invalidSecrets.length > 0) {
-            throw new Error(`Invalid secrets: ${invalidSecrets.join(',')}. ` +
-                'Secret must be configured using the resource id (e.g. API_KEY)');
+            throw new Error(`Invalid secrets: ${invalidSecrets.join(",")}. ` +
+                "Secret must be configured using the resource id (e.g. API_KEY)");
         }
     }
+    if ("allowInvalidAppCheckToken" in runtimeOptions) {
+        throw new Error('runWith option "allowInvalidAppCheckToken" has been inverted and ' +
+            'renamed "enforceAppCheck"');
+    }
     return true;
 }
+function validateFailurePolicy(policy) {
+    if (typeof policy === "boolean" || typeof policy === "undefined") {
+        return;
+    }
+    if (typeof policy !== "object") {
+        throw new Error(`failurePolicy must be a boolean or an object.`);
+    }
+    const retry = policy.retry;
+    if (typeof retry !== "object" || Object.keys(retry).length) {
+        throw new Error("failurePolicy.retry must be an empty object.");
+    }
+}
 /**
  * Assert regions specified are valid.
  * @param regions list of regions.
@@ -142,7 +149,7 @@ function assertRuntimeOptionsValid(runtimeOptions) {
  */
 function assertRegionsAreValid(regions) {
     if (!regions.length) {
-        throw new Error('You must specify at least one region');
+        throw new Error("You must specify at least one region");
     }
     return true;
 }
@@ -219,13 +226,16 @@ class FunctionBuilder {
      */
     runWith(runtimeOptions) {
         if (assertRuntimeOptionsValid(runtimeOptions)) {
-            this.options = _.assign(this.options, runtimeOptions);
+            this.options = {
+                ...this.options,
+                ...runtimeOptions,
+            };
             return this;
         }
     }
     get https() {
         if (this.options.failurePolicy !== undefined) {
-            console.warn('RuntimeOptions.failurePolicy is not supported in https functions.');
+            console.warn("RuntimeOptions.failurePolicy is not supported in https functions.");
         }
         return {
             /**

package/lib/v1/function-configuration.d.ts

@@ -0,0 +1,197 @@
+import { Expression } from "../params";
+import { ResetValue } from "../common/options";
+import { SecretParam } from "../params/types";
+export { RESET_VALUE } from "../common/options";
+/**
+ * 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 {
+    /**
+     * The number of attempts that the system will make to run a job using the exponential backoff procedure described by {@link ScheduleRetryConfig.maxDoublings}.
+     *
+     * @defaultValue 0 (infinite retry)
+     */
+    retryCount?: number | Expression<number> | ResetValue;
+    /**
+     * The time limit for retrying a failed job, measured from time when an execution was first attempted.
+     *
+     * If specified with {@link ScheduleRetryConfig.retryCount}, the job will be retried until both limits are reached.
+     *
+     * @defaultValue 0
+     */
+    maxRetryDuration?: string | Expression<string> | ResetValue;
+    /**
+     * The minimum amount of time to wait before retrying a job after it fails.
+     *
+     * @defaultValue 5 seconds
+     */
+    minBackoffDuration?: string | Expression<string> | ResetValue;
+    /**
+     * The maximum amount of time to wait before retrying a job after it fails.
+     *
+     * @defaultValue 1 hour
+     */
+    maxBackoffDuration?: string | Expression<string> | ResetValue;
+    /**
+     * The max number of backoff doubling applied at each retry.
+     *
+     * @defaultValue 5
+     */
+    maxDoublings?: number | Expression<number> | ResetValue;
+}
+/**
+ * Configuration options for scheduled functions.
+ */
+export interface Schedule {
+    /**
+     * Describes the schedule on which the job will be executed.
+     *
+     * The schedule can be either of the following types:
+     *
+     * 1. {@link https://en.wikipedia.org/wiki/Cron#Overview | Crontab}
+     *
+     * 2. English-like {@link https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules | schedule}
+     *
+     * @example
+     * ```
+     * // Crontab schedule
+     * schedule: "0 9 * * 1"` // Every Monday at 09:00 AM
+     *
+     * // English-like schedule
+     * schedule: "every 5 minutes"
+     * ```
+     */
+    schedule: string;
+    /**
+     * Specifies the time zone to be used in interpreting {@link Schedule.schedule}.
+     *
+     * The value of this field must be a time zone name from the tz database.
+     */
+    timeZone?: string | ResetValue;
+    /**
+     * Settings that determine the retry behavior.
+     */
+    retryConfig?: ScheduleRetryConfig;
+}
+/**
+ * Configuration option for failure policy on background functions.
+ */
+export interface FailurePolicy {
+    /**
+     * Retry configuration. Must be an empty object.
+     *
+     */
+    retry: Record<string, never>;
+}
+export declare const MAX_NUMBER_USER_LABELS = 58;
+/**
+ * Configuration options for a function that applicable at runtime.
+ */
+export interface RuntimeOptions {
+    /**
+     * 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] | Expression<number> | ResetValue;
+    /**
+     * Timeout for the function in seconds, possible values are 0 to 540.
+     */
+    timeoutSeconds?: number | Expression<number> | ResetValue;
+    /**
+     * Min number of actual instances to be running at a given time.
+     *
+     * @remarks
+     * Instances will be billed for memory allocation and 10% of CPU allocation
+     * while idle.
+     */
+    minInstances?: number | Expression<number> | ResetValue;
+    /**
+     * Max number of actual instances allowed to be running in parallel.
+     */
+    maxInstances?: number | Expression<number> | ResetValue;
+    /**
+     * Connect cloud function to specified VPC connector.
+     */
+    vpcConnector?: string | ResetValue;
+    /**
+     * Egress settings for VPC connector.
+     */
+    vpcConnectorEgressSettings?: typeof VPC_EGRESS_SETTINGS_OPTIONS[number] | ResetValue;
+    /**
+     * Specific service account for the function to run as.
+     */
+    serviceAccount?: "default" | string | ResetValue;
+    /**
+     * Ingress settings which control where this function can be called from.
+     */
+    ingressSettings?: typeof INGRESS_SETTINGS_OPTIONS[number] | ResetValue;
+    /**
+     * User labels to set on the function.
+     */
+    labels?: Record<string, string>;
+    /**
+     * Invoker to set access control on https functions.
+     */
+    invoker?: "public" | "private" | string | string[];
+    secrets?: (string | SecretParam)[];
+    /**
+     * Determines whether Firebase AppCheck is enforced.
+     *
+     * @remarks
+     * When true, requests with invalid tokens autorespond with a 401
+     * (Unauthorized) error.
+     * When false, requests with invalid tokens set context.app to undefiend.
+     */
+    enforceAppCheck?: boolean;
+}
+/**
+ * Configuration options for a function that applies during function deployment.
+ */
+export interface DeploymentOptions extends RuntimeOptions {
+    /**
+     * Regions where function should be deployed.
+     */
+    regions?: Array<typeof SUPPORTED_REGIONS[number] | string>;
+    /**
+     * Schedule for the scheduled function.
+     */
+    schedule?: Schedule;
+    /**
+     * Controls whether function configuration modified outside of function source is preserved. Defaults to false.
+     *
+     * @remarks
+     * When setting configuration available in the underlying platform that is not yet available in the Firebase Functions
+     * SDK, we highly recommend setting `preserveExternalChanges` to `true`. Otherwise, when the Firebase Functions SDK releases
+     * a new version of the SDK with support for the missing configuration, your function's manually configured setting
+     * may inadvertently be wiped out.
+     */
+    preserveExternalChanges?: boolean;
+}

package/lib/v1/function-configuration.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MAX_NUMBER_USER_LABELS = exports.INGRESS_SETTINGS_OPTIONS = exports.VPC_EGRESS_SETTINGS_OPTIONS = exports.VALID_MEMORY_OPTIONS = exports.MAX_TIMEOUT_SECONDS = exports.MIN_TIMEOUT_SECONDS = exports.SUPPORTED_REGIONS = exports.RESET_VALUE = void 0;
+var options_1 = require("../common/options");
+Object.defineProperty(exports, "RESET_VALUE", { enumerable: true, get: function () { return options_1.RESET_VALUE; } });
+/**
+ * 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.MAX_NUMBER_USER_LABELS = 58;

package/lib/v1/index.d.ts

@@ -0,0 +1,20 @@
+import * as logger from "../logger";
+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 { setApp as setEmulatedAdminApp } from "../common/app";
+export { analytics, auth, database, firestore, https, pubsub, remoteConfig, storage, tasks, testLab, logger, };
+export declare const app: {
+    setEmulatedAdminApp: typeof setEmulatedAdminApp;
+};
+export * from "./cloud-functions";
+export * from "./config";
+export * from "./function-builder";
+export * from "./function-configuration";

package/lib/{index.js → v1/index.js}

@@ -35,8 +35,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logger = exports.testLab = exports.tasks = exports.storage = exports.remoteConfig = exports.pubsub = exports.https = exports.handler = exports.firestore = exports.database = exports.auth = exports.app = exports.analytics = void 0;
+exports.app = exports.logger = exports.testLab = exports.tasks = exports.storage = exports.remoteConfig = exports.pubsub = exports.https = exports.firestore = exports.database = exports.auth = exports.analytics = void 0;
 // Providers:
+const logger = require("../logger");
+exports.logger = logger;
 const analytics = require("./providers/analytics");
 exports.analytics = analytics;
 const auth = require("./providers/auth");
@@ -57,17 +59,10 @@ const tasks = require("./providers/tasks");
 exports.tasks = tasks;
 const testLab = require("./providers/testLab");
 exports.testLab = testLab;
-const apps = require("./apps");
-const handler_builder_1 = require("./handler-builder");
-Object.defineProperty(exports, "handler", { enumerable: true, get: function () { return handler_builder_1.handler; } });
-const logger = require("./logger");
-exports.logger = logger;
-const setup_1 = require("./setup");
-const app = apps.apps();
-exports.app = app;
+const app_1 = require("../common/app");
+exports.app = { setEmulatedAdminApp: app_1.setApp };
 // Exported root types:
 __exportStar(require("./cloud-functions"), exports);
 __exportStar(require("./config"), exports);
 __exportStar(require("./function-builder"), exports);
 __exportStar(require("./function-configuration"), exports);
-(0, setup_1.setup)();

package/lib/{providers → v1/providers}/analytics.d.ts

@@ -1,24 +1,18 @@
-import { CloudFunction, EventContext } from '../cloud-functions';
-import { DeploymentOptions } from '../function-configuration';
-/** @hidden */
-export declare const provider = "google.analytics";
-/** @hidden */
-export declare const service = "app-measurement.com";
+import { CloudFunction, EventContext } from "../cloud-functions";
+import { DeploymentOptions } from "../function-configuration";
 /**
  * Registers a function to handle analytics events.
  *
  * @param analyticsEventType Name of the analytics event type to which
  *   this Cloud Function is scoped.
  *
- * @return Analytics event builder interface.
+ * @returns Analytics event builder interface.
  */
 export declare function event(analyticsEventType: string): AnalyticsEventBuilder;
-/** @hidden */
-export declare function _eventWithOptions(analyticsEventType: string, options: DeploymentOptions): AnalyticsEventBuilder;
 /**
  * The Firebase Analytics event builder interface.
  *
- * Access via [`functions.analytics.event()`](functions.analytics#.event).
+ * Access via `functions.analytics.event()`.
  */
 export declare class AnalyticsEventBuilder {
     private triggerResource;
@@ -31,7 +25,7 @@ export declare class AnalyticsEventBuilder {
      * @param handler Event handler that fires every time a Firebase Analytics event
      *   occurs.
      *
-     * @return A function that you can export and deploy.
+     * @returns A function that you can export and deploy.
      */
     onLog(handler: (event: AnalyticsEvent, context: EventContext) => PromiseLike<any> | any): CloudFunction<AnalyticsEvent>;
 }