firebase-functions 7.0.1-rc.0 → 7.0.2-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/esm/runtime/manifest.mjs +2 -7
- package/lib/esm/v1/cloud-functions.mjs +1 -2
- package/lib/esm/v1/function-builder.mjs +2 -2
- package/lib/esm/v2/options.mjs +1 -2
- package/lib/esm/v2/providers/scheduler.mjs +1 -2
- package/lib/params/index.d.ts +1 -1
- package/lib/params/types.d.ts +5 -0
- package/lib/runtime/manifest.d.ts +0 -1
- package/lib/runtime/manifest.js +2 -7
- package/lib/v1/cloud-functions.js +1 -2
- package/lib/v1/function-builder.js +1 -1
- package/lib/v1/function-configuration.d.ts +2 -2
- package/lib/v2/options.d.ts +2 -2
- package/lib/v2/options.js +1 -2
- package/lib/v2/providers/alerts/alerts.d.ts +2 -2
- package/lib/v2/providers/alerts/appDistribution.d.ts +2 -2
- package/lib/v2/providers/alerts/crashlytics.d.ts +2 -2
- package/lib/v2/providers/database.d.ts +2 -2
- package/lib/v2/providers/eventarc.d.ts +2 -2
- package/lib/v2/providers/https.d.ts +2 -2
- package/lib/v2/providers/identity.d.ts +2 -2
- package/lib/v2/providers/pubsub.d.ts +2 -2
- package/lib/v2/providers/scheduler.d.ts +0 -6
- package/lib/v2/providers/scheduler.js +1 -2
- package/lib/v2/providers/storage.d.ts +2 -2
- package/lib/v2/providers/tasks.d.ts +2 -2
- package/package.json +1 -1
|
@@ -99,8 +99,7 @@ const RESETTABLE_V2_SCHEDULE_OPTIONS = {
|
|
|
99
99
|
maxDoublings: null,
|
|
100
100
|
maxRetrySeconds: null,
|
|
101
101
|
minBackoffSeconds: null,
|
|
102
|
-
maxBackoffSeconds: null
|
|
103
|
-
attemptDeadlineSeconds: null
|
|
102
|
+
maxBackoffSeconds: null
|
|
104
103
|
};
|
|
105
104
|
function initScheduleTrigger(resetOptions, schedule, ...opts) {
|
|
106
105
|
let scheduleTrigger = {
|
|
@@ -109,11 +108,7 @@ function initScheduleTrigger(resetOptions, schedule, ...opts) {
|
|
|
109
108
|
};
|
|
110
109
|
if (opts.every((opt) => !opt?.preserveExternalChanges)) {
|
|
111
110
|
for (const key of Object.keys(resetOptions)) {
|
|
112
|
-
|
|
113
|
-
scheduleTrigger[key] = RESET_VALUE;
|
|
114
|
-
} else {
|
|
115
|
-
scheduleTrigger.retryConfig[key] = RESET_VALUE;
|
|
116
|
-
}
|
|
111
|
+
scheduleTrigger.retryConfig[key] = RESET_VALUE;
|
|
117
112
|
}
|
|
118
113
|
scheduleTrigger = {
|
|
119
114
|
...scheduleTrigger,
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { warn } from "../logger/index.mjs";
|
|
2
|
-
import { SecretParam } from "../params/types.mjs";
|
|
3
2
|
import { RESET_VALUE, ResetValue } from "../common/options.mjs";
|
|
4
3
|
import { initV1Endpoint, initV1ScheduleTrigger } from "../runtime/manifest.mjs";
|
|
5
4
|
import { Change } from "../common/change.mjs";
|
|
@@ -177,7 +176,7 @@ function optionsToEndpoint(options) {
|
|
|
177
176
|
copyIfPresent(endpoint, options, "omit", "minInstances", "maxInstances", "ingressSettings", "labels", "timeoutSeconds");
|
|
178
177
|
convertIfPresent(endpoint, options, "region", "regions");
|
|
179
178
|
convertIfPresent(endpoint, options, "serviceAccountEmail", "serviceAccount", (sa) => sa);
|
|
180
|
-
convertIfPresent(endpoint, options, "secretEnvironmentVariables", "secrets", (secrets) => secrets.map((secret) => ({ key: secret
|
|
179
|
+
convertIfPresent(endpoint, options, "secretEnvironmentVariables", "secrets", (secrets) => secrets.map((secret) => ({ key: typeof secret === "string" ? secret : secret.name })));
|
|
181
180
|
if (options?.vpcConnector !== undefined) {
|
|
182
181
|
if (options.vpcConnector === null || options.vpcConnector instanceof ResetValue) {
|
|
183
182
|
endpoint.vpc = RESET_VALUE;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Expression
|
|
1
|
+
import { Expression } from "../params/types.mjs";
|
|
2
2
|
import { ResetValue } from "../common/options.mjs";
|
|
3
3
|
import { INGRESS_SETTINGS_OPTIONS, MAX_NUMBER_USER_LABELS, MAX_TIMEOUT_SECONDS, VALID_MEMORY_OPTIONS, VPC_EGRESS_SETTINGS_OPTIONS } from "./function-configuration.mjs";
|
|
4
4
|
import { _eventWithOptions } from "./providers/analytics.mjs";
|
|
@@ -84,7 +84,7 @@ function assertRuntimeOptionsValid(runtimeOptions) {
|
|
|
84
84
|
}
|
|
85
85
|
}
|
|
86
86
|
if (runtimeOptions.secrets !== undefined) {
|
|
87
|
-
const invalidSecrets = runtimeOptions.secrets.filter((s) => !/^[A-Za-z\d\-_]+$/.test(s
|
|
87
|
+
const invalidSecrets = runtimeOptions.secrets.filter((s) => !/^[A-Za-z\d\-_]+$/.test(typeof s === "string" ? s : s.name));
|
|
88
88
|
if (invalidSecrets.length > 0) {
|
|
89
89
|
throw new Error(`Invalid secrets: ${invalidSecrets.join(",")}. ` + "Secret must be configured using the resource id (e.g. API_KEY)");
|
|
90
90
|
}
|
package/lib/esm/v2/options.mjs
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { warn } from "../logger/index.mjs";
|
|
2
|
-
import { SecretParam } from "../params/types.mjs";
|
|
3
2
|
import { declaredParams } from "../params/index.mjs";
|
|
4
3
|
import { RESET_VALUE, ResetValue } from "../common/options.mjs";
|
|
5
4
|
import { convertIfPresent, copyIfPresent, durationFromSeconds, serviceAccountFromShorthand } from "../common/encoding.mjs";
|
|
@@ -84,7 +83,7 @@ function optionsToEndpoint(opts) {
|
|
|
84
83
|
}
|
|
85
84
|
return region;
|
|
86
85
|
});
|
|
87
|
-
convertIfPresent(endpoint, opts, "secretEnvironmentVariables", "secrets", (secrets) => secrets.map((secret) => ({ key: secret
|
|
86
|
+
convertIfPresent(endpoint, opts, "secretEnvironmentVariables", "secrets", (secrets) => secrets.map((secret) => ({ key: typeof secret === "string" ? secret : secret.name })));
|
|
88
87
|
return endpoint;
|
|
89
88
|
}
|
|
90
89
|
/**
|
|
@@ -22,7 +22,6 @@ function getOpts(args) {
|
|
|
22
22
|
return {
|
|
23
23
|
schedule: args.schedule,
|
|
24
24
|
timeZone: args.timeZone,
|
|
25
|
-
attemptDeadlineSeconds: args.attemptDeadlineSeconds,
|
|
26
25
|
retryConfig: {
|
|
27
26
|
retryCount: args.retryCount,
|
|
28
27
|
maxRetrySeconds: args.maxRetrySeconds,
|
|
@@ -71,7 +70,7 @@ function onSchedule(args, handler) {
|
|
|
71
70
|
},
|
|
72
71
|
scheduleTrigger: initV2ScheduleTrigger(separatedOpts.schedule, globalOpts, separatedOpts.opts)
|
|
73
72
|
};
|
|
74
|
-
copyIfPresent(ep.scheduleTrigger, separatedOpts, "timeZone"
|
|
73
|
+
copyIfPresent(ep.scheduleTrigger, separatedOpts, "timeZone");
|
|
75
74
|
copyIfPresent(ep.scheduleTrigger.retryConfig, separatedOpts.retryConfig, "retryCount", "maxRetrySeconds", "minBackoffSeconds", "maxBackoffSeconds", "maxDoublings");
|
|
76
75
|
func.__endpoint = ep;
|
|
77
76
|
func.__requiredAPIs = [{
|
package/lib/params/index.d.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
*/
|
|
5
5
|
import { BooleanParam, Expression, IntParam, Param, ParamOptions, SecretParam, JsonSecretParam, StringParam, ListParam } from "./types";
|
|
6
6
|
export { BUCKET_PICKER, select, multiSelect } from "./types";
|
|
7
|
-
export type { TextInput, SelectInput, SelectOptions, MultiSelectInput } from "./types";
|
|
7
|
+
export type { TextInput, SelectInput, SelectOptions, MultiSelectInput, Param, SecretParam, JsonSecretParam, StringParam, BooleanParam, IntParam, ListParam, } from "./types";
|
|
8
8
|
export { Expression };
|
|
9
9
|
export type { ParamOptions };
|
|
10
10
|
type SecretOrExpr = Param<any> | SecretParam | JsonSecretParam<any>;
|
package/lib/params/types.d.ts
CHANGED
|
@@ -203,6 +203,11 @@ export declare class JsonSecretParam<T = any> {
|
|
|
203
203
|
/** Returns the secret's parsed JSON value at runtime. Throws an error if accessed during deployment, if the secret is not set, or if the value is not valid JSON. */
|
|
204
204
|
value(): T;
|
|
205
205
|
}
|
|
206
|
+
/**
|
|
207
|
+
* A union type representing all valid secret parameter types that can be used
|
|
208
|
+
* in a function's `secrets` configuration array.
|
|
209
|
+
*/
|
|
210
|
+
export type SupportedSecretParam = string | SecretParam | JsonSecretParam<unknown>;
|
|
206
211
|
/**
|
|
207
212
|
* A parametrized value of String type that will be read from .env files
|
|
208
213
|
* if present, or prompted for by the CLI if missing.
|
|
@@ -70,7 +70,6 @@ export interface ManifestEndpoint {
|
|
|
70
70
|
scheduleTrigger?: {
|
|
71
71
|
schedule: string | Expression<string>;
|
|
72
72
|
timeZone?: string | Expression<string> | ResetValue;
|
|
73
|
-
attemptDeadlineSeconds?: number | Expression<number> | ResetValue;
|
|
74
73
|
retryConfig?: {
|
|
75
74
|
retryCount?: number | Expression<number> | ResetValue;
|
|
76
75
|
maxRetrySeconds?: string | Expression<string> | ResetValue;
|
package/lib/runtime/manifest.js
CHANGED
|
@@ -99,8 +99,7 @@ const RESETTABLE_V2_SCHEDULE_OPTIONS = {
|
|
|
99
99
|
maxDoublings: null,
|
|
100
100
|
maxRetrySeconds: null,
|
|
101
101
|
minBackoffSeconds: null,
|
|
102
|
-
maxBackoffSeconds: null
|
|
103
|
-
attemptDeadlineSeconds: null
|
|
102
|
+
maxBackoffSeconds: null
|
|
104
103
|
};
|
|
105
104
|
function initScheduleTrigger(resetOptions, schedule, ...opts) {
|
|
106
105
|
let scheduleTrigger = {
|
|
@@ -109,11 +108,7 @@ function initScheduleTrigger(resetOptions, schedule, ...opts) {
|
|
|
109
108
|
};
|
|
110
109
|
if (opts.every((opt) => !opt?.preserveExternalChanges)) {
|
|
111
110
|
for (const key of Object.keys(resetOptions)) {
|
|
112
|
-
|
|
113
|
-
scheduleTrigger[key] = require_common_options.RESET_VALUE;
|
|
114
|
-
} else {
|
|
115
|
-
scheduleTrigger.retryConfig[key] = require_common_options.RESET_VALUE;
|
|
116
|
-
}
|
|
111
|
+
scheduleTrigger.retryConfig[key] = require_common_options.RESET_VALUE;
|
|
117
112
|
}
|
|
118
113
|
scheduleTrigger = {
|
|
119
114
|
...scheduleTrigger,
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
const require_logger_index = require('../logger/index.js');
|
|
2
|
-
const require_params_types = require('../params/types.js');
|
|
3
2
|
const require_common_options = require('../common/options.js');
|
|
4
3
|
const require_runtime_manifest = require('../runtime/manifest.js');
|
|
5
4
|
const require_common_change = require('../common/change.js');
|
|
@@ -177,7 +176,7 @@ function optionsToEndpoint(options) {
|
|
|
177
176
|
require_common_encoding.copyIfPresent(endpoint, options, "omit", "minInstances", "maxInstances", "ingressSettings", "labels", "timeoutSeconds");
|
|
178
177
|
require_common_encoding.convertIfPresent(endpoint, options, "region", "regions");
|
|
179
178
|
require_common_encoding.convertIfPresent(endpoint, options, "serviceAccountEmail", "serviceAccount", (sa) => sa);
|
|
180
|
-
require_common_encoding.convertIfPresent(endpoint, options, "secretEnvironmentVariables", "secrets", (secrets) => secrets.map((secret) => ({ key: secret
|
|
179
|
+
require_common_encoding.convertIfPresent(endpoint, options, "secretEnvironmentVariables", "secrets", (secrets) => secrets.map((secret) => ({ key: typeof secret === "string" ? secret : secret.name })));
|
|
181
180
|
if (options?.vpcConnector !== undefined) {
|
|
182
181
|
if (options.vpcConnector === null || options.vpcConnector instanceof require_common_options.ResetValue) {
|
|
183
182
|
endpoint.vpc = require_common_options.RESET_VALUE;
|
|
@@ -84,7 +84,7 @@ function assertRuntimeOptionsValid(runtimeOptions) {
|
|
|
84
84
|
}
|
|
85
85
|
}
|
|
86
86
|
if (runtimeOptions.secrets !== undefined) {
|
|
87
|
-
const invalidSecrets = runtimeOptions.secrets.filter((s) => !/^[A-Za-z\d\-_]+$/.test(s
|
|
87
|
+
const invalidSecrets = runtimeOptions.secrets.filter((s) => !/^[A-Za-z\d\-_]+$/.test(typeof s === "string" ? s : s.name));
|
|
88
88
|
if (invalidSecrets.length > 0) {
|
|
89
89
|
throw new Error(`Invalid secrets: ${invalidSecrets.join(",")}. ` + "Secret must be configured using the resource id (e.g. API_KEY)");
|
|
90
90
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Expression } from "../params";
|
|
2
2
|
import { ResetValue } from "../common/options";
|
|
3
|
-
import {
|
|
3
|
+
import { SupportedSecretParam } from "../params/types";
|
|
4
4
|
export { RESET_VALUE } from "../common/options";
|
|
5
5
|
/**
|
|
6
6
|
* List of all regions supported by Cloud Functions.
|
|
@@ -162,7 +162,7 @@ export interface RuntimeOptions {
|
|
|
162
162
|
* Invoker to set access control on https functions.
|
|
163
163
|
*/
|
|
164
164
|
invoker?: "public" | "private" | string | string[];
|
|
165
|
-
secrets?:
|
|
165
|
+
secrets?: SupportedSecretParam[];
|
|
166
166
|
/**
|
|
167
167
|
* Determines whether Firebase AppCheck is enforced.
|
|
168
168
|
*
|
package/lib/v2/options.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { ResetValue } from "../common/options";
|
|
2
2
|
import { Expression } from "../params";
|
|
3
|
-
import { ParamSpec,
|
|
3
|
+
import { ParamSpec, SupportedSecretParam } from "../params/types";
|
|
4
4
|
export { RESET_VALUE } from "../common/options";
|
|
5
5
|
/**
|
|
6
6
|
* List of all regions supported by Cloud Functions (2nd gen).
|
|
@@ -104,7 +104,7 @@ export interface GlobalOptions {
|
|
|
104
104
|
* User labels to set on the function.
|
|
105
105
|
*/
|
|
106
106
|
labels?: Record<string, string>;
|
|
107
|
-
secrets?:
|
|
107
|
+
secrets?: SupportedSecretParam[];
|
|
108
108
|
/**
|
|
109
109
|
* Determines whether Firebase App Check is enforced. Defaults to false.
|
|
110
110
|
*
|
package/lib/v2/options.js
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
const require_logger_index = require('../logger/index.js');
|
|
2
|
-
const require_params_types = require('../params/types.js');
|
|
3
2
|
const require_params_index = require('../params/index.js');
|
|
4
3
|
const require_common_options = require('../common/options.js');
|
|
5
4
|
const require_common_encoding = require('../common/encoding.js');
|
|
@@ -84,7 +83,7 @@ function optionsToEndpoint(opts) {
|
|
|
84
83
|
}
|
|
85
84
|
return region;
|
|
86
85
|
});
|
|
87
|
-
require_common_encoding.convertIfPresent(endpoint, opts, "secretEnvironmentVariables", "secrets", (secrets) => secrets.map((secret) => ({ key: secret
|
|
86
|
+
require_common_encoding.convertIfPresent(endpoint, opts, "secretEnvironmentVariables", "secrets", (secrets) => secrets.map((secret) => ({ key: typeof secret === "string" ? secret : secret.name })));
|
|
88
87
|
return endpoint;
|
|
89
88
|
}
|
|
90
89
|
/**
|
|
@@ -2,7 +2,7 @@ import { ResetValue } from "../../../common/options";
|
|
|
2
2
|
import { CloudEvent, CloudFunction } from "../../core";
|
|
3
3
|
import { Expression } from "../../../params";
|
|
4
4
|
import * as options from "../../options";
|
|
5
|
-
import {
|
|
5
|
+
import { SupportedSecretParam } from "../../../params/types";
|
|
6
6
|
/**
|
|
7
7
|
* The CloudEvent data emitted by Firebase Alerts.
|
|
8
8
|
* @typeParam T - the payload type that is expected for this alert.
|
|
@@ -117,7 +117,7 @@ export interface FirebaseAlertOptions extends options.EventHandlerOptions {
|
|
|
117
117
|
* User labels to set on the function.
|
|
118
118
|
*/
|
|
119
119
|
labels?: Record<string, string>;
|
|
120
|
-
secrets?:
|
|
120
|
+
secrets?: SupportedSecretParam[];
|
|
121
121
|
/** Whether failed executions should be delivered again. */
|
|
122
122
|
retry?: boolean | Expression<boolean> | ResetValue;
|
|
123
123
|
}
|
|
@@ -7,7 +7,7 @@ import { Expression } from "../../../params";
|
|
|
7
7
|
import { CloudEvent, CloudFunction } from "../../core";
|
|
8
8
|
import { FirebaseAlertData } from "./alerts";
|
|
9
9
|
import * as options from "../../options";
|
|
10
|
-
import {
|
|
10
|
+
import { SupportedSecretParam } from "../../../params/types";
|
|
11
11
|
/**
|
|
12
12
|
* The internal payload object for adding a new tester device to app distribution.
|
|
13
13
|
* Payload is wrapped inside a `FirebaseAlertData` object.
|
|
@@ -140,7 +140,7 @@ export interface AppDistributionOptions extends options.EventHandlerOptions {
|
|
|
140
140
|
* User labels to set on the function.
|
|
141
141
|
*/
|
|
142
142
|
labels?: Record<string, string>;
|
|
143
|
-
secrets?:
|
|
143
|
+
secrets?: SupportedSecretParam[];
|
|
144
144
|
/** Whether failed executions should be delivered again. */
|
|
145
145
|
retry?: boolean | Expression<boolean> | ResetValue;
|
|
146
146
|
}
|
|
@@ -7,7 +7,7 @@ import { Expression } from "../../../params";
|
|
|
7
7
|
import { CloudEvent, CloudFunction } from "../../core";
|
|
8
8
|
import { FirebaseAlertData } from "./alerts";
|
|
9
9
|
import * as options from "../../options";
|
|
10
|
-
import {
|
|
10
|
+
import { SupportedSecretParam } from "../../../params/types";
|
|
11
11
|
/** Generic Crashlytics issue interface */
|
|
12
12
|
export interface Issue {
|
|
13
13
|
/** The ID of the Crashlytics issue */
|
|
@@ -206,7 +206,7 @@ export interface CrashlyticsOptions extends options.EventHandlerOptions {
|
|
|
206
206
|
* User labels to set on the function.
|
|
207
207
|
*/
|
|
208
208
|
labels?: Record<string, string>;
|
|
209
|
-
secrets?:
|
|
209
|
+
secrets?: SupportedSecretParam[];
|
|
210
210
|
/** Whether failed executions should be delivered again. */
|
|
211
211
|
retry?: boolean | Expression<boolean> | ResetValue;
|
|
212
212
|
}
|
|
@@ -5,7 +5,7 @@ import { DataSnapshot } from "../../common/providers/database";
|
|
|
5
5
|
import { CloudEvent, CloudFunction } from "../core";
|
|
6
6
|
import { Expression } from "../../params";
|
|
7
7
|
import * as options from "../options";
|
|
8
|
-
import {
|
|
8
|
+
import { SupportedSecretParam } from "../../params/types";
|
|
9
9
|
export { DataSnapshot };
|
|
10
10
|
/** @hidden */
|
|
11
11
|
export interface RawRTDBCloudEventData {
|
|
@@ -128,7 +128,7 @@ export interface ReferenceOptions<Ref extends string = string> extends options.E
|
|
|
128
128
|
* User labels to set on the function.
|
|
129
129
|
*/
|
|
130
130
|
labels?: Record<string, string>;
|
|
131
|
-
secrets?:
|
|
131
|
+
secrets?: SupportedSecretParam[];
|
|
132
132
|
/** Whether failed executions should be delivered again. */
|
|
133
133
|
retry?: boolean | Expression<boolean> | ResetValue;
|
|
134
134
|
}
|
|
@@ -2,7 +2,7 @@ import { ResetValue } from "../../common/options";
|
|
|
2
2
|
import { CloudEvent, CloudFunction } from "../core";
|
|
3
3
|
import { Expression } from "../../params";
|
|
4
4
|
import * as options from "../options";
|
|
5
|
-
import {
|
|
5
|
+
import { SupportedSecretParam } from "../../params/types";
|
|
6
6
|
/** Options that can be set on an Eventarc trigger. */
|
|
7
7
|
export interface EventarcTriggerOptions extends options.EventHandlerOptions {
|
|
8
8
|
/**
|
|
@@ -105,7 +105,7 @@ export interface EventarcTriggerOptions extends options.EventHandlerOptions {
|
|
|
105
105
|
* User labels to set on the function.
|
|
106
106
|
*/
|
|
107
107
|
labels?: Record<string, string>;
|
|
108
|
-
secrets?:
|
|
108
|
+
secrets?: SupportedSecretParam[];
|
|
109
109
|
/** Whether failed executions should be delivered again. */
|
|
110
110
|
retry?: boolean | Expression<boolean> | ResetValue;
|
|
111
111
|
}
|
|
@@ -4,7 +4,7 @@ import { type CallableRequest, type CallableResponse, type FunctionsErrorCode, H
|
|
|
4
4
|
import { ManifestEndpoint } from "../../runtime/manifest";
|
|
5
5
|
import { GlobalOptions, SupportedRegion } from "../options";
|
|
6
6
|
import { Expression } from "../../params";
|
|
7
|
-
import {
|
|
7
|
+
import { SupportedSecretParam } from "../../params/types";
|
|
8
8
|
import * as options from "../options";
|
|
9
9
|
export type { Request, CallableRequest, CallableResponse, FunctionsErrorCode };
|
|
10
10
|
export { HttpsError };
|
|
@@ -93,7 +93,7 @@ export interface HttpsOptions extends Omit<GlobalOptions, "region" | "enforceApp
|
|
|
93
93
|
* User labels to set on the function.
|
|
94
94
|
*/
|
|
95
95
|
labels?: Record<string, string>;
|
|
96
|
-
secrets?:
|
|
96
|
+
secrets?: SupportedSecretParam[];
|
|
97
97
|
/**
|
|
98
98
|
* Invoker to set access control on https functions.
|
|
99
99
|
*/
|
|
@@ -7,7 +7,7 @@ import { AuthBlockingEvent, AuthBlockingEventType, AuthUserRecord, BeforeCreateR
|
|
|
7
7
|
import { BlockingFunction } from "../../v1/cloud-functions";
|
|
8
8
|
import { Expression } from "../../params";
|
|
9
9
|
import * as options from "../options";
|
|
10
|
-
import {
|
|
10
|
+
import { SupportedSecretParam } from "../../params/types";
|
|
11
11
|
export { HttpsError };
|
|
12
12
|
export type { AuthUserRecord, AuthBlockingEvent };
|
|
13
13
|
/** @hidden Internally used when parsing the options. */
|
|
@@ -104,7 +104,7 @@ export interface BlockingOptions {
|
|
|
104
104
|
* User labels to set on the function.
|
|
105
105
|
*/
|
|
106
106
|
labels?: Record<string, string>;
|
|
107
|
-
secrets?:
|
|
107
|
+
secrets?: SupportedSecretParam[];
|
|
108
108
|
}
|
|
109
109
|
/**
|
|
110
110
|
* Handles an event that is triggered before a user is created.
|
|
@@ -2,7 +2,7 @@ import { ResetValue } from "../../common/options";
|
|
|
2
2
|
import { CloudEvent, CloudFunction } from "../core";
|
|
3
3
|
import { Expression } from "../../params";
|
|
4
4
|
import * as options from "../options";
|
|
5
|
-
import {
|
|
5
|
+
import { SupportedSecretParam } from "../../params/types";
|
|
6
6
|
/**
|
|
7
7
|
* Google Cloud Pub/Sub is a globally distributed message bus that automatically scales as you need it.
|
|
8
8
|
* You can create a function ({@link onMessagePublished}) that handles pub/sub events by using functions.pubsub.
|
|
@@ -161,7 +161,7 @@ export interface PubSubOptions extends options.EventHandlerOptions {
|
|
|
161
161
|
* User labels to set on the function.
|
|
162
162
|
*/
|
|
163
163
|
labels?: Record<string, string>;
|
|
164
|
-
secrets?:
|
|
164
|
+
secrets?: SupportedSecretParam[];
|
|
165
165
|
/** Whether failed executions should be delivered again. */
|
|
166
166
|
retry?: boolean | Expression<boolean> | ResetValue;
|
|
167
167
|
}
|
|
@@ -36,12 +36,6 @@ export interface ScheduleOptions extends options.GlobalOptions {
|
|
|
36
36
|
schedule: string;
|
|
37
37
|
/** The timezone that the schedule executes in. */
|
|
38
38
|
timeZone?: timezone | Expression<string> | ResetValue;
|
|
39
|
-
/**
|
|
40
|
-
* The deadline for job attempts in seconds. If the request handler does not respond by this deadline,
|
|
41
|
-
* the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure.
|
|
42
|
-
* The value must be between 15 and 1800. Defaults to 180.
|
|
43
|
-
*/
|
|
44
|
-
attemptDeadlineSeconds?: number | Expression<number> | ResetValue;
|
|
45
39
|
/** The number of retry attempts for a failed run. */
|
|
46
40
|
retryCount?: number | Expression<number> | ResetValue;
|
|
47
41
|
/** The time limit for retrying. */
|
|
@@ -22,7 +22,6 @@ function getOpts(args) {
|
|
|
22
22
|
return {
|
|
23
23
|
schedule: args.schedule,
|
|
24
24
|
timeZone: args.timeZone,
|
|
25
|
-
attemptDeadlineSeconds: args.attemptDeadlineSeconds,
|
|
26
25
|
retryConfig: {
|
|
27
26
|
retryCount: args.retryCount,
|
|
28
27
|
maxRetrySeconds: args.maxRetrySeconds,
|
|
@@ -71,7 +70,7 @@ function onSchedule(args, handler) {
|
|
|
71
70
|
},
|
|
72
71
|
scheduleTrigger: require_runtime_manifest.initV2ScheduleTrigger(separatedOpts.schedule, globalOpts, separatedOpts.opts)
|
|
73
72
|
};
|
|
74
|
-
require_common_encoding.copyIfPresent(ep.scheduleTrigger, separatedOpts, "timeZone"
|
|
73
|
+
require_common_encoding.copyIfPresent(ep.scheduleTrigger, separatedOpts, "timeZone");
|
|
75
74
|
require_common_encoding.copyIfPresent(ep.scheduleTrigger.retryConfig, separatedOpts.retryConfig, "retryCount", "maxRetrySeconds", "minBackoffSeconds", "maxBackoffSeconds", "maxDoublings");
|
|
76
75
|
func.__endpoint = ep;
|
|
77
76
|
func.__requiredAPIs = [{
|
|
@@ -2,7 +2,7 @@ import { ResetValue } from "../../common/options";
|
|
|
2
2
|
import { CloudEvent, CloudFunction } from "../core";
|
|
3
3
|
import { Expression } from "../../params";
|
|
4
4
|
import * as options from "../options";
|
|
5
|
-
import {
|
|
5
|
+
import { SupportedSecretParam } from "../../params/types";
|
|
6
6
|
/**
|
|
7
7
|
* An object within Google Cloud Storage.
|
|
8
8
|
* Ref: https://github.com/googleapis/google-cloudevents-nodejs/blob/main/cloud/storage/v1/StorageObjectData.ts
|
|
@@ -237,7 +237,7 @@ export interface StorageOptions extends options.EventHandlerOptions {
|
|
|
237
237
|
* User labels to set on the function.
|
|
238
238
|
*/
|
|
239
239
|
labels?: Record<string, string>;
|
|
240
|
-
secrets?:
|
|
240
|
+
secrets?: SupportedSecretParam[];
|
|
241
241
|
/** Whether failed executions should be delivered again. */
|
|
242
242
|
retry?: boolean | Expression<boolean> | ResetValue;
|
|
243
243
|
}
|
|
@@ -3,7 +3,7 @@ import { AuthData, RateLimits, Request, RetryConfig } from "../../common/provide
|
|
|
3
3
|
import * as options from "../options";
|
|
4
4
|
import { HttpsFunction } from "./https";
|
|
5
5
|
import { Expression } from "../../params";
|
|
6
|
-
import {
|
|
6
|
+
import { SupportedSecretParam } from "../../params/types";
|
|
7
7
|
export type { AuthData, Request, RateLimits, RetryConfig };
|
|
8
8
|
export interface TaskQueueOptions extends options.EventHandlerOptions {
|
|
9
9
|
/** How a task should be retried in the event of a non-2xx return. */
|
|
@@ -96,7 +96,7 @@ export interface TaskQueueOptions extends options.EventHandlerOptions {
|
|
|
96
96
|
* User labels to set on the function.
|
|
97
97
|
*/
|
|
98
98
|
labels?: Record<string, string>;
|
|
99
|
-
secrets?:
|
|
99
|
+
secrets?: SupportedSecretParam[];
|
|
100
100
|
/** Whether failed executions should be delivered again. */
|
|
101
101
|
retry?: boolean;
|
|
102
102
|
}
|