link
This commit is contained in:
girinb
155
node_modules/firebase-functions/lib/v2/providers/identity.d.ts
generated
vendored
Normal file
155
node_modules/firebase-functions/lib/v2/providers/identity.d.ts
generated
vendored
Normal file
@@ -0,0 +1,155 @@
|
||||
/**
|
||||
* Cloud functions to handle events from Google Cloud Identity Platform.
|
||||
* @packageDocumentation
|
||||
*/
|
||||
import { ResetValue } from "../../common/options";
|
||||
import { AuthBlockingEvent, AuthBlockingEventType, AuthUserRecord, BeforeCreateResponse, BeforeSignInResponse, BeforeEmailResponse, BeforeSmsResponse, HandlerV2, HttpsError, MaybeAsync } from "../../common/providers/identity";
|
||||
import { BlockingFunction } from "../../v1/cloud-functions";
|
||||
import { Expression } from "../../params";
|
||||
import * as options from "../options";
|
||||
import { SecretParam } from "../../params/types";
|
||||
export { AuthUserRecord, AuthBlockingEvent, HttpsError };
|
||||
/** @hidden Internally used when parsing the options. */
|
||||
interface InternalOptions {
|
||||
opts: options.GlobalOptions;
|
||||
idToken: boolean;
|
||||
accessToken: boolean;
|
||||
refreshToken: boolean;
|
||||
}
|
||||
/**
|
||||
* All function options plus idToken, accessToken, and refreshToken.
|
||||
*/
|
||||
export interface BlockingOptions {
|
||||
/** Pass the ID Token credential to the function. */
|
||||
idToken?: boolean;
|
||||
/** Pass the Access Token credential to the function. */
|
||||
accessToken?: boolean;
|
||||
/** Pass the Refresh Token credential to the function. */
|
||||
refreshToken?: boolean;
|
||||
/**
|
||||
* If true, do not deploy or emulate this function.
|
||||
*/
|
||||
omit?: boolean | Expression<boolean>;
|
||||
/**
|
||||
* Region where functions should be deployed.
|
||||
*/
|
||||
region?: options.SupportedRegion | string | Expression<string> | ResetValue;
|
||||
/**
|
||||
* Amount of memory to allocate to a function.
|
||||
*/
|
||||
memory?: options.MemoryOption | Expression<number> | ResetValue;
|
||||
/**
|
||||
* Timeout for the function in seconds, possible values are 0 to 540.
|
||||
* HTTPS functions can specify a higher timeout.
|
||||
*
|
||||
* @remarks
|
||||
* The minimum timeout for a gen 2 function is 1s. The maximum timeout for a
|
||||
* function depends on the type of function: Event handling functions have a
|
||||
* maximum timeout of 540s (9 minutes). HTTPS and callable functions have a
|
||||
* maximum timeout of 3,600s (1 hour). Task queue functions have a maximum
|
||||
* timeout of 1,800s (30 minutes)
|
||||
*/
|
||||
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 instances to be running in parallel.
|
||||
*/
|
||||
maxInstances?: number | Expression<number> | ResetValue;
|
||||
/**
|
||||
* Number of requests a function can serve at once.
|
||||
*
|
||||
* @remarks
|
||||
* Can only be applied to functions running on Cloud Functions v2.
|
||||
* A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise).
|
||||
* Concurrency cannot be set to any value other than 1 if `cpu` is less than 1.
|
||||
* The maximum value for concurrency is 1,000.
|
||||
*/
|
||||
concurrency?: number | Expression<number> | ResetValue;
|
||||
/**
|
||||
* Fractional number of CPUs to allocate to a function.
|
||||
*
|
||||
* @remarks
|
||||
* Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes.
|
||||
* This is different from the defaults when using the gcloud utility and is different from
|
||||
* the fixed amount assigned in Google Cloud Functions generation 1.
|
||||
* To revert to the CPU amounts used in gcloud or in Cloud Functions generation 1, set this
|
||||
* to the value "gcf_gen1"
|
||||
*/
|
||||
cpu?: number | "gcf_gen1";
|
||||
/**
|
||||
* Connect cloud function to specified VPC connector.
|
||||
*/
|
||||
vpcConnector?: string | Expression<string> | ResetValue;
|
||||
/**
|
||||
* Egress settings for VPC connector.
|
||||
*/
|
||||
vpcConnectorEgressSettings?: options.VpcEgressSetting | ResetValue;
|
||||
/**
|
||||
* Specific service account for the function to run as.
|
||||
*/
|
||||
serviceAccount?: string | Expression<string> | ResetValue;
|
||||
/**
|
||||
* Ingress settings which control where this function can be called from.
|
||||
*/
|
||||
ingressSettings?: options.IngressSetting | ResetValue;
|
||||
/**
|
||||
* User labels to set on the function.
|
||||
*/
|
||||
labels?: Record<string, string>;
|
||||
secrets?: (string | SecretParam)[];
|
||||
}
|
||||
/**
|
||||
* Handles an event that is triggered before a user is created.
|
||||
* @param handler - Event handler which is run every time before a user is created.
|
||||
*/
|
||||
export declare function beforeUserCreated(handler: (event: AuthBlockingEvent) => MaybeAsync<BeforeCreateResponse | void>): BlockingFunction;
|
||||
/**
|
||||
* Handles an event that is triggered before a user is created.
|
||||
* @param opts - Object containing function options.
|
||||
* @param handler - Event handler which is run every time before a user is created.
|
||||
*/
|
||||
export declare function beforeUserCreated(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => MaybeAsync<BeforeCreateResponse | void>): BlockingFunction;
|
||||
/**
|
||||
* Handles an event that is triggered before a user is signed in.
|
||||
* @param handler - Event handler which is run every time before a user is signed in.
|
||||
*/
|
||||
export declare function beforeUserSignedIn(handler: (event: AuthBlockingEvent) => MaybeAsync<BeforeSignInResponse | void>): BlockingFunction;
|
||||
/**
|
||||
* Handles an event that is triggered before a user is signed in.
|
||||
* @param opts - Object containing function options.
|
||||
* @param handler - Event handler which is run every time before a user is signed in.
|
||||
*/
|
||||
export declare function beforeUserSignedIn(opts: BlockingOptions, handler: (event: AuthBlockingEvent) => MaybeAsync<BeforeSignInResponse | void>): BlockingFunction;
|
||||
/**
|
||||
* Handles an event that is triggered before an email is sent to a user.
|
||||
* @param handler - Event handler that is run before an email is sent to a user.
|
||||
*/
|
||||
export declare function beforeEmailSent(handler: (event: AuthBlockingEvent) => MaybeAsync<BeforeEmailResponse | void>): BlockingFunction;
|
||||
/**
|
||||
* Handles an event that is triggered before an email is sent to a user.
|
||||
* @param opts - Object containing function options.
|
||||
* @param handler - Event handler that is run before an email is sent to a user.
|
||||
*/
|
||||
export declare function beforeEmailSent(opts: Omit<BlockingOptions, "idToken" | "accessToken" | "refreshToken">, handler: (event: AuthBlockingEvent) => MaybeAsync<BeforeEmailResponse | void>): BlockingFunction;
|
||||
/**
|
||||
* Handles an event that is triggered before an SMS is sent to a user.
|
||||
* @param handler - Event handler that is run before an SMS is sent to a user.
|
||||
*/
|
||||
export declare function beforeSmsSent(handler: (event: AuthBlockingEvent) => MaybeAsync<BeforeSmsResponse | void>): BlockingFunction;
|
||||
/**
|
||||
* Handles an event that is triggered before an SMS is sent to a user.
|
||||
* @param opts - Object containing function options.
|
||||
* @param handler - Event handler that is run before an SMS is sent to a user.
|
||||
*/
|
||||
export declare function beforeSmsSent(opts: Omit<BlockingOptions, "idToken" | "accessToken" | "refreshToken">, handler: (event: AuthBlockingEvent) => MaybeAsync<BeforeSmsResponse | void>): BlockingFunction;
|
||||
/** @hidden */
|
||||
export declare function beforeOperation(eventType: AuthBlockingEventType, optsOrHandler: BlockingOptions | ((event: AuthBlockingEvent) => MaybeAsync<BeforeCreateResponse | BeforeSignInResponse | BeforeEmailResponse | BeforeSmsResponse | void>), handler: HandlerV2): BlockingFunction;
|
||||
/** @hidden */
|
||||
export declare function getOpts(blockingOptions: BlockingOptions): InternalOptions;
|
||||
Reference in New Issue
Block a user