firebase-functions 3.17.0 → 3.18.1

package/lib/bin/firebase-functions.js

@@ -28,21 +28,23 @@ async function handleQuitquitquit(req, res) {
 }
 app.get('/__/quitquitquit', handleQuitquitquit);
 app.post('/__/quitquitquit', handleQuitquitquit);
-app.get('/__/stack.yaml', async (req, res) => {
-    try {
-        const stack = await (0, loader_1.loadStack)(functionsDir);
-        res.setHeader('content-type', 'text/yaml');
-        res.send(JSON.stringify(stack));
-    }
-    catch (e) {
-        res
-            .status(400)
-            .send(`Failed to generate manifest from function source: ${e}`);
-    }
-});
+if (process.env.FUNCTIONS_CONTROL_API === 'true') {
+    app.get('/__/functions.yaml', async (req, res) => {
+        try {
+            const stack = await (0, loader_1.loadStack)(functionsDir);
+            res.setHeader('content-type', 'text/yaml');
+            res.send(JSON.stringify(stack));
+        }
+        catch (e) {
+            res
+                .status(400)
+                .send(`Failed to generate manifest from function source: ${e}`);
+        }
+    });
+}
 let port = 8080;
-if (process.env.STACK_CONTROL_API_PORT) {
-    port = Number.parseInt(process.env.STACK_CONTROL_API_PORT);
+if (process.env.PORT) {
+    port = Number.parseInt(process.env.PORT);
 }
 console.log('Serving at port', port);
 server = app.listen(port);

package/lib/cloud-functions.d.ts

@@ -2,7 +2,7 @@ import { Request, Response } from 'express';
 import { DeploymentOptions, FailurePolicy, Schedule } from './function-configuration';
 export { Request, Response };
 import { Duration } from './common/encoding';
-import { ManifestEndpoint, ManifestRequiredAPI } from './common/manifest';
+import { ManifestEndpoint, ManifestRequiredAPI } from './runtime/manifest';
 /**
  * @hidden
  *
@@ -199,6 +199,7 @@ export interface TriggerAnnotated {
         vpcConnectorEgressSettings?: string;
         serviceAccountEmail?: string;
         ingressSettings?: string;
+        secrets?: string[];
     };
 }
 /**

package/lib/cloud-functions.js

@@ -252,7 +252,7 @@ function _detectAuthType(event) {
 /** @hidden */
 function optionsToTrigger(options) {
     const trigger = {};
-    (0, encoding_1.copyIfPresent)(trigger, options, 'regions', 'schedule', 'minInstances', 'maxInstances', 'ingressSettings', 'vpcConnectorEgressSettings', 'vpcConnector', 'labels');
+    (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;
@@ -286,6 +286,7 @@ function optionsToEndpoint(options) {
     (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) => ({ 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');

package/lib/function-builder.js

@@ -125,6 +125,13 @@ function assertRuntimeOptionsValid(runtimeOptions) {
             }
         }
     }
+    if (runtimeOptions.secrets !== undefined) {
+        const invalidSecrets = runtimeOptions.secrets.filter((s) => !/^[A-Za-z\d\-_]+$/.test(s));
+        if (invalidSecrets.length > 0) {
+            throw new Error(`Invalid secrets: ${invalidSecrets.join(',')}. ` +
+                'Secret must be configured using the resource id (e.g. API_KEY)');
+        }
+    }
     return true;
 }
 /**

package/lib/function-configuration.d.ts

@@ -99,6 +99,7 @@ export interface RuntimeOptions {
      */
     invoker?: 'public' | 'private' | string | string[];
     allowInvalidAppCheckToken?: boolean;
+    secrets?: string[];
 }
 export interface DeploymentOptions extends RuntimeOptions {
     regions?: Array<typeof SUPPORTED_REGIONS[number] | string>;

package/lib/providers/https.d.ts

@@ -1,6 +1,6 @@
 import * as express from 'express';
 import { HttpsFunction, Runnable } from '../cloud-functions';
-import { ManifestEndpoint, ManifestRequiredAPI } from '../common/manifest';
+import { ManifestEndpoint, ManifestRequiredAPI } from '../runtime/manifest';
 import { CallableContext, FunctionsErrorCode, HttpsError, Request, TaskContext, TaskRateLimits, TaskRetryConfig } from '../common/providers/https';
 import { DeploymentOptions } from '../function-configuration';
 export { Request, CallableContext, FunctionsErrorCode, HttpsError, 

package/lib/runtime/loader.js

@@ -91,11 +91,10 @@ async function loadStack(functionsDir) {
     const requiredAPIs = [];
     const mod = await loadModule(functionsDir);
     extractStack(mod, endpoints, requiredAPIs);
-    const stack = {
+    return {
         endpoints,
         specVersion: 'v1alpha1',
         requiredAPIs: mergeRequiredAPIs(requiredAPIs),
     };
-    return stack;
 }
 exports.loadStack = loadStack;

package/lib/runtime/manifest.d.ts

@@ -1 +1,59 @@
-export {};
+/**
+ * An definition of a function as appears in the Manifest.
+ */
+export interface ManifestEndpoint {
+    entryPoint?: string;
+    region?: string[];
+    platform?: string;
+    availableMemoryMb?: number;
+    maxInstances?: number;
+    minInstances?: number;
+    concurrency?: number;
+    serviceAccountEmail?: string;
+    timeoutSeconds?: number;
+    vpc?: {
+        connector: string;
+        egressSettings?: string;
+    };
+    labels?: Record<string, string>;
+    ingressSettings?: string;
+    environmentVariables?: Record<string, string>;
+    secretEnvironmentVariables?: {
+        key: string;
+        secret?: string;
+    }[];
+    httpsTrigger?: {
+        invoker?: string[];
+    };
+    callableTrigger?: {};
+    eventTrigger?: {
+        eventFilters: Record<string, string>;
+        eventType: string;
+        retry: boolean;
+        region?: string;
+        serviceAccountEmail?: string;
+    };
+    scheduleTrigger?: {
+        schedule?: string;
+        timezone?: string;
+        retryConfig?: {
+            retryCount?: number;
+            maxRetryDuration?: string;
+            minBackoffDuration?: string;
+            maxBackoffDuration?: string;
+            maxDoublings?: number;
+        };
+    };
+}
+export interface ManifestRequiredAPI {
+    api: string;
+    reason: string;
+}
+/**
+ * An definition of a function deployment as appears in the Manifest.
+ **/
+export interface ManifestStack {
+    specVersion: 'v1alpha1';
+    requiredAPIs: ManifestRequiredAPI[];
+    endpoints: Record<string, ManifestEndpoint>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-functions",
-  "version": "3.17.0",
+  "version": "3.18.1",
   "description": "Firebase SDK for Cloud Functions",
   "keywords": [
     "firebase",

package/lib/common/manifest.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/common/manifest.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });