firebase-functions 3.21.0 → 3.21.1

package/lib/bin/firebase-functions.js

@@ -1,5 +1,26 @@
 #!/usr/bin/env node
 "use strict";
+// The MIT License (MIT)
+//
+// Copyright (c) 2022 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 });
 const express = require("express");
 const loader_1 = require("../runtime/loader");

package/lib/cloud-functions.d.ts

@@ -173,46 +173,35 @@ export interface Resource {
     };
 }
 /**
- * @hidden
- * TriggerAnnotated is used internally by the firebase CLI to understand what
+ * TriggerAnnotion is used internally by the firebase CLI to understand what
  * type of Cloud Function to deploy.
  */
-export interface TriggerAnnotated {
-    __trigger: {
-        availableMemoryMb?: number;
-        blockingTrigger?: {
-            eventType: string;
-            options?: Record<string, unknown>;
-        };
-        eventTrigger?: {
-            eventType: string;
-            resource: string;
-            service: string;
-        };
-        failurePolicy?: FailurePolicy;
-        httpsTrigger?: {
-            invoker?: string[];
-        };
-        labels?: {
-            [key: string]: string;
-        };
-        regions?: string[];
-        schedule?: Schedule;
-        timeout?: Duration;
-        vpcConnector?: string;
-        vpcConnectorEgressSettings?: string;
-        serviceAccountEmail?: string;
-        ingressSettings?: string;
-        secrets?: string[];
+interface TriggerAnnotation {
+    availableMemoryMb?: number;
+    blockingTrigger?: {
+        eventType: string;
+        options?: Record<string, unknown>;
     };
-}
-/**
- * @hidden
- * EndpointAnnotated is used to generate the manifest that conforms to the container contract.
- */
-export interface EndpointAnnotated {
-    __endpoint: ManifestEndpoint;
-    __requiredAPIs?: ManifestRequiredAPI[];
+    eventTrigger?: {
+        eventType: string;
+        resource: string;
+        service: string;
+    };
+    failurePolicy?: FailurePolicy;
+    httpsTrigger?: {
+        invoker?: string[];
+    };
+    labels?: {
+        [key: string]: string;
+    };
+    regions?: string[];
+    schedule?: Schedule;
+    timeout?: Duration;
+    vpcConnector?: string;
+    vpcConnectorEgressSettings?: string;
+    serviceAccountEmail?: string;
+    ingressSettings?: string;
+    secrets?: string[];
 }
 /**
  * A Runnable has a `run` method which directly invokes the user-defined
@@ -230,11 +219,27 @@ export interface Runnable<T> {
  * [`Response`](https://expressjs.com/en/api.html#res) objects as its only
  * arguments.
  */
-export declare type HttpsFunction = TriggerAnnotated & EndpointAnnotated & ((req: Request, resp: Response) => void | Promise<void>);
+export interface HttpsFunction {
+    (req: Request, resp: Response): void | Promise<void>;
+    /** @alpha */
+    __trigger: TriggerAnnotation;
+    /** @alpha */
+    __endpoint: ManifestEndpoint;
+    /** @alpha */
+    __requiredAPIs?: ManifestRequiredAPI[];
+}
 /**
  * The Cloud Function type for Blocking triggers.
  */
-export declare type BlockingFunction = HttpsFunction;
+export interface BlockingFunction {
+    (req: Request, resp: Response): void | Promise<void>;
+    /** @alpha */
+    __trigger: TriggerAnnotation;
+    /** @alpha */
+    __endpoint: ManifestEndpoint;
+    /** @alpha */
+    __requiredAPIs?: ManifestRequiredAPI[];
+}
 /**
  * The Cloud Function type for all non-HTTPS triggers. This should be exported
  * from your JavaScript file to define a Cloud Function.
@@ -242,7 +247,15 @@ export declare type BlockingFunction = HttpsFunction;
  * This type is a special JavaScript function which takes a templated
  * `Event` object as its only argument.
  */
-export declare type CloudFunction<T> = Runnable<T> & TriggerAnnotated & EndpointAnnotated & ((input: any, context?: any) => PromiseLike<any> | any);
+export interface CloudFunction<T> extends Runnable<T> {
+    (input: any, context?: any): PromiseLike<any> | any;
+    /** @alpha */
+    __trigger: TriggerAnnotation;
+    /** @alpha */
+    __endpoint: ManifestEndpoint;
+    /** @alpha */
+    __requiredAPIs?: ManifestRequiredAPI[];
+}
 /** @hidden */
 export interface MakeCloudFunctionArgs<EventData> {
     after?: (raw: Event) => void;

package/lib/common/encoding.js

@@ -1,5 +1,25 @@
 "use strict";
-// Copied from firebase-tools/src/gcp/proto
+// The MIT License (MIT)
+//
+// Copyright (c) 2021 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.convertInvoker = exports.serviceAccountFromShorthand = exports.convertIfPresent = exports.copyIfPresent = exports.durationFromSeconds = void 0;
 /** Get a google.protobuf.Duration for a number of seconds. */

package/lib/common/providers/https.d.ts

@@ -4,6 +4,7 @@ import * as firebase from 'firebase-admin';
 import { TaskContext } from './tasks';
 /** @hidden */
 export interface Request extends express.Request {
+    /** The wire format representation of the request body. */
     rawBody: Buffer;
 }
 interface DecodedAppCheckToken {
@@ -114,37 +115,53 @@ export interface CallableRequest<T = any> {
  * https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
  *
  * Possible values:
- * - 'cancelled': The operation was cancelled (typically by the caller).
- * - 'unknown': Unknown error or an error from a different error domain.
- * - 'invalid-argument': Client specified an invalid argument. Note that this
- *   differs from 'failed-precondition'. 'invalid-argument' indicates
+ *
+ * - `cancelled`: The operation was cancelled (typically by the caller).
+ *
+ * - `unknown`: Unknown error or an error from a different error domain.
+ *
+ * - `invalid-argument`: Client specified an invalid argument. Note that this
+ *   differs from `failed-precondition`. `invalid-argument` indicates
  *   arguments that are problematic regardless of the state of the system
  *   (e.g. an invalid field name).
- * - 'deadline-exceeded': Deadline expired before operation could complete.
+ *
+ * - `deadline-exceeded`: Deadline expired before operation could complete.
  *   For operations that change the state of the system, this error may be
  *   returned even if the operation has completed successfully. For example,
  *   a successful response from a server could have been delayed long enough
  *   for the deadline to expire.
- * - 'not-found': Some requested document was not found.
- * - 'already-exists': Some document that we attempted to create already
+ *
+ * - `not-found`: Some requested document was not found.
+ *
+ * - `already-exists`: Some document that we attempted to create already
  *   exists.
- * - 'permission-denied': The caller does not have permission to execute the
+ *
+ * - `permission-denied`: The caller does not have permission to execute the
  *   specified operation.
- * - 'resource-exhausted': Some resource has been exhausted, perhaps a
+ *
+ * - `resource-exhausted`: Some resource has been exhausted, perhaps a
  *   per-user quota, or perhaps the entire file system is out of space.
- * - 'failed-precondition': Operation was rejected because the system is not
+ *
+ * - `failed-precondition`: Operation was rejected because the system is not
  *   in a state required for the operation's execution.
- * - 'aborted': The operation was aborted, typically due to a concurrency
+ *
+ * - `aborted`: The operation was aborted, typically due to a concurrency
  *   issue like transaction aborts, etc.
- * - 'out-of-range': Operation was attempted past the valid range.
- * - 'unimplemented': Operation is not implemented or not supported/enabled.
- * - 'internal': Internal errors. Means some invariants expected by
+ *
+ * - `out-of-range`: Operation was attempted past the valid range.
+ *
+ * - `unimplemented`: Operation is not implemented or not supported/enabled.
+ *
+ * - `internal`: Internal errors. Means some invariants expected by
  *   underlying system has been broken. If you see one of these errors,
  *   something is very broken.
- * - 'unavailable': The service is currently unavailable. This is most likely
+ *
+ * - `unavailable`: The service is currently unavailable. This is most likely
  *   a transient condition and may be corrected by retrying with a backoff.
- * - 'data-loss': Unrecoverable data loss or corruption.
- * - 'unauthenticated': The request does not have valid authentication
+ *
+ * - `data-loss`: Unrecoverable data loss or corruption.
+ *
+ * - `unauthenticated`: The request does not have valid authentication
  *   credentials for the operation.
  */
 export declare type FunctionsErrorCode = 'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';
@@ -182,6 +199,9 @@ export declare class HttpsError extends Error {
      */
     readonly httpErrorCode: HttpErrorCode;
     constructor(code: FunctionsErrorCode, message: string, details?: unknown);
+    /**
+     * Returns a JSON-serializable representation of this object.
+     */
     toJSON(): HttpErrorWireFormat;
 }
 /** @hidden */

package/lib/common/providers/https.js

@@ -72,6 +72,9 @@ class HttpsError extends Error {
         this.details = details;
         this.httpErrorCode = errorCodeMap[code];
     }
+    /**
+     * Returns a JSON-serializable representation of this object.
+     */
     toJSON() {
         const { details, httpErrorCode: { canonicalName: status }, message, } = this;
         return {

package/lib/common/providers/identity.d.ts

@@ -2,7 +2,11 @@ import * as firebase from 'firebase-admin';
 import { EventContext } from '../../cloud-functions';
 import { HttpsError } from './https';
 export { HttpsError };
-/** Shorthand auth blocking events from GCIP. */
+/**
+ * Shorthand auth blocking events from GCIP.
+ * @hidden
+ * @alpha
+ */
 export declare type AuthBlockingEventType = 'beforeCreate' | 'beforeSignIn';
 /**
  * The UserRecord passed to Cloud Functions is the same UserRecord that is returned by the Firebase Admin

package/lib/common/providers/tasks.d.ts

@@ -29,9 +29,18 @@ export interface RetryConfig {
 }
 /** How congestion control should be applied to the function. */
 export interface RateLimits {
+    /**
+     * The maximum number of requests that can be outstanding at a time.
+     * If left unspecified, will default to 1000.
+     */
     maxConcurrentDispatches?: number;
+    /**
+     * The maximum number of requests that can be invoked per second.
+     * If left unspecified, will default to 500.
+     */
     maxDispatchesPerSecond?: number;
 }
+/** Metadata about the authorization used to invoke a function. */
 export interface AuthData {
     uid: string;
     token: firebase.auth.DecodedIdToken;

package/lib/function-builder.d.ts

@@ -78,7 +78,7 @@ export declare class FunctionBuilder {
          * Declares a callable method for clients to call using a Firebase SDK.
          * @param handler A method that takes a data and context and returns a value.
          */
-        onCall: (handler: (data: any, context: https.CallableContext) => any | Promise<any>) => import("./cloud-functions").TriggerAnnotated & import("./cloud-functions").EndpointAnnotated & ((req: express.Request<import("express-serve-static-core").ParamsDictionary>, resp: express.Response<any>) => void | Promise<void>) & import("./cloud-functions").Runnable<any>;
+        onCall: (handler: (data: any, context: https.CallableContext) => any | Promise<any>) => import("./cloud-functions").HttpsFunction & import("./cloud-functions").Runnable<any>;
     };
     get tasks(): {
         /**

package/lib/logger/common.js

@@ -1,4 +1,25 @@
 "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.
 var _a, _b, _c;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UNPATCHED_CONSOLE = exports.CONSOLE_SEVERITY = exports.SUPPORTS_STRUCTURED_LOGS = void 0;

package/lib/logger/compat.js

@@ -1,4 +1,25 @@
 "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 });
 const util_1 = require("util");
 const common_1 = require("./common");

package/lib/logger/index.d.ts

@@ -1,11 +1,13 @@
 /**
  * `LogSeverity` indicates the detailed severity of the log entry. See [LogSeverity](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity).
+ * @public
  */
 export declare type LogSeverity = 'DEBUG' | 'INFO' | 'NOTICE' | 'WARNING' | 'ERROR' | 'CRITICAL' | 'ALERT' | 'EMERGENCY';
 /**
  * `LogEntry` represents a [structured Cloud Logging](https://cloud.google.com/logging/docs/structured-logging)
  * entry. All keys aside from `severity` and `message` are
  * included in the `jsonPayload` of the logged entry.
+ * @public
  */
 export interface LogEntry {
     severity: LogSeverity;
@@ -14,36 +16,42 @@ export interface LogEntry {
 }
 /**
  * Writes a `LogEntry` to `stdout`/`stderr` (depending on severity).
- * @param entry The `LogEntry` including severity, message, and any additional structured metadata.
+ * @param entry - The `LogEntry` including severity, message, and any additional structured metadata.
+ * @public
  */
 export declare function write(entry: LogEntry): void;
 /**
  * Writes a `DEBUG` severity log. If the last argument provided is a plain object,
  * it is added to the `jsonPayload` in the Cloud Logging entry.
- * @param args Arguments, concatenated into the log message with space separators.
+ * @param args - Arguments, concatenated into the log message with space separators.
+ * @public
  */
 export declare function debug(...args: any[]): void;
 /**
  * Writes an `INFO` severity log. If the last argument provided is a plain object,
  * it is added to the `jsonPayload` in the Cloud Logging entry.
- * @param args Arguments, concatenated into the log message with space separators.
+ * @param args - Arguments, concatenated into the log message with space separators.
+ * @public
  */
 export declare function log(...args: any[]): void;
 /**
  * Writes an `INFO` severity log. If the last argument provided is a plain object,
  * it is added to the `jsonPayload` in the Cloud Logging entry.
- * @param args Arguments, concatenated into the log message with space separators.
+ * @param args - Arguments, concatenated into the log message with space separators.
+ * @public
  */
 export declare function info(...args: any[]): void;
 /**
  * Writes a `WARNING` severity log. If the last argument provided is a plain object,
  * it is added to the `jsonPayload` in the Cloud Logging entry.
- * @param args Arguments, concatenated into the log message with space separators.
+ * @param args - Arguments, concatenated into the log message with space separators.
+ * @public
  */
 export declare function warn(...args: any[]): void;
 /**
  * Writes an `ERROR` severity log. If the last argument provided is a plain object,
  * it is added to the `jsonPayload` in the Cloud Logging entry.
- * @param args Arguments, concatenated into the log message with space separators.
+ * @param args - Arguments, concatenated into the log message with space separators.
+ * @public
  */
 export declare function error(...args: any[]): void;

package/lib/logger/index.js

@@ -1,4 +1,25 @@
 "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.error = exports.warn = exports.info = exports.log = exports.debug = exports.write = void 0;
 const util_1 = require("util");
@@ -37,7 +58,8 @@ function removeCircular(obj, refs = []) {
 }
 /**
  * Writes a `LogEntry` to `stdout`/`stderr` (depending on severity).
- * @param entry The `LogEntry` including severity, message, and any additional structured metadata.
+ * @param entry - The `LogEntry` including severity, message, and any additional structured metadata.
+ * @public
  */
 function write(entry) {
     if (common_1.SUPPORTS_STRUCTURED_LOGS) {
@@ -62,7 +84,8 @@ exports.write = write;
 /**
  * Writes a `DEBUG` severity log. If the last argument provided is a plain object,
  * it is added to the `jsonPayload` in the Cloud Logging entry.
- * @param args Arguments, concatenated into the log message with space separators.
+ * @param args - Arguments, concatenated into the log message with space separators.
+ * @public
  */
 function debug(...args) {
     write(entryFromArgs('DEBUG', args));
@@ -71,7 +94,8 @@ exports.debug = debug;
 /**
  * Writes an `INFO` severity log. If the last argument provided is a plain object,
  * it is added to the `jsonPayload` in the Cloud Logging entry.
- * @param args Arguments, concatenated into the log message with space separators.
+ * @param args - Arguments, concatenated into the log message with space separators.
+ * @public
  */
 function log(...args) {
     write(entryFromArgs('INFO', args));
@@ -80,7 +104,8 @@ exports.log = log;
 /**
  * Writes an `INFO` severity log. If the last argument provided is a plain object,
  * it is added to the `jsonPayload` in the Cloud Logging entry.
- * @param args Arguments, concatenated into the log message with space separators.
+ * @param args - Arguments, concatenated into the log message with space separators.
+ * @public
  */
 function info(...args) {
     write(entryFromArgs('INFO', args));
@@ -89,7 +114,8 @@ exports.info = info;
 /**
  * Writes a `WARNING` severity log. If the last argument provided is a plain object,
  * it is added to the `jsonPayload` in the Cloud Logging entry.
- * @param args Arguments, concatenated into the log message with space separators.
+ * @param args - Arguments, concatenated into the log message with space separators.
+ * @public
  */
 function warn(...args) {
     write(entryFromArgs('WARNING', args));
@@ -98,7 +124,8 @@ exports.warn = warn;
 /**
  * Writes an `ERROR` severity log. If the last argument provided is a plain object,
  * it is added to the `jsonPayload` in the Cloud Logging entry.
- * @param args Arguments, concatenated into the log message with space separators.
+ * @param args - Arguments, concatenated into the log message with space separators.
+ * @public
  */
 function error(...args) {
     write(entryFromArgs('ERROR', args));

package/lib/providers/auth.d.ts

@@ -7,21 +7,34 @@ export { HttpsError };
 export declare const provider = "google.firebase.auth";
 /** @hidden */
 export declare const service = "firebaseauth.googleapis.com";
-/** Resource level options */
+/**
+ * Resource level options
+ * @public
+ */
 export interface UserOptions {
+    /** Options to set configuration at the resource level for blocking functions. */
     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;
     };
 }
 /**
- * Handle events related to Firebase authentication users.
+ * Handles events related to Firebase authentication users.
+ * @param userOptions - Resource level options
+ * @returns UserBuilder - Builder used to create Cloud Functions for Firebase Auth user lifecycle events
+ * @public
  */
 export declare function user(userOptions?: UserOptions): UserBuilder;
 /** @hidden */
 export declare function _userWithOptions(options: DeploymentOptions, userOptions: UserOptions): UserBuilder;
-/** Builder used to create Cloud Functions for Firebase Auth user lifecycle events. */
+/**
+ * Builder used to create Cloud Functions for Firebase Auth user lifecycle events.
+ * @public
+ */
 export declare class UserBuilder {
     private triggerResource;
     private options;
@@ -29,12 +42,20 @@ export declare class UserBuilder {
     private static dataConstructor;
     /** @hidden */
     constructor(triggerResource: () => string, options: DeploymentOptions, userOptions?: UserOptions);
-    /** Respond to the creation of a Firebase Auth user. */
+    /**
+     * Responds to the creation of a Firebase Auth user.
+     * @public
+     */
     onCreate(handler: (user: UserRecord, context: EventContext) => PromiseLike<any> | any): CloudFunction<UserRecord>;
-    /** Respond to the deletion of a Firebase Auth user. */
+    /**
+     * Responds to the deletion of a Firebase Auth user.
+     * @public
+     */
     onDelete(handler: (user: UserRecord, context: EventContext) => PromiseLike<any> | any): CloudFunction<UserRecord>;
     beforeCreate(handler: (user: AuthUserRecord, context: AuthEventContext) => BeforeCreateResponse | void | Promise<BeforeCreateResponse> | Promise<void>): BlockingFunction;
     beforeSignIn(handler: (user: AuthUserRecord, context: AuthEventContext) => BeforeSignInResponse | void | Promise<BeforeSignInResponse> | Promise<void>): BlockingFunction;
+    /** @hidden */
     private onOperation;
+    /** @hidden */
     private beforeOperation;
 }

package/lib/providers/auth.js

@@ -32,7 +32,10 @@ exports.provider = 'google.firebase.auth';
 /** @hidden */
 exports.service = 'firebaseauth.googleapis.com';
 /**
- * Handle events related to Firebase authentication users.
+ * Handles events related to Firebase authentication users.
+ * @param userOptions - Resource level options
+ * @returns UserBuilder - Builder used to create Cloud Functions for Firebase Auth user lifecycle events
+ * @public
  */
 function user(userOptions) {
     return _userWithOptions({}, userOptions || {});
@@ -48,7 +51,10 @@ function _userWithOptions(options, userOptions) {
     }, options, userOptions);
 }
 exports._userWithOptions = _userWithOptions;
-/** Builder used to create Cloud Functions for Firebase Auth user lifecycle events. */
+/**
+ * Builder used to create Cloud Functions for Firebase Auth user lifecycle events.
+ * @public
+ */
 class UserBuilder {
     /** @hidden */
     constructor(triggerResource, options, userOptions) {
@@ -59,11 +65,17 @@ class UserBuilder {
     static dataConstructor(raw) {
         return (0, identity_1.userRecordConstructor)(raw.data);
     }
-    /** Respond to the creation of a Firebase Auth user. */
+    /**
+     * Responds to the creation of a Firebase Auth user.
+     * @public
+     */
     onCreate(handler) {
         return this.onOperation(handler, 'user.create');
     }
-    /** Respond to the deletion of a Firebase Auth user. */
+    /**
+     * Responds to the deletion of a Firebase Auth user.
+     * @public
+     */
     onDelete(handler) {
         return this.onOperation(handler, 'user.delete');
     }
@@ -73,6 +85,7 @@ class UserBuilder {
     beforeSignIn(handler) {
         return this.beforeOperation(handler, 'beforeSignIn');
     }
+    /** @hidden */
     onOperation(handler, eventType) {
         return (0, cloud_functions_1.makeCloudFunction)({
             handler,
@@ -85,6 +98,7 @@ class UserBuilder {
             options: this.options,
         });
     }
+    /** @hidden */
     beforeOperation(handler, eventType) {
         var _a, _b, _c, _d, _e, _f;
         const accessToken = ((_b = (_a = this.userOptions) === null || _a === void 0 ? void 0 : _a.blockingOptions) === null || _b === void 0 ? void 0 : _b.accessToken) || false;