firebase-functions 3.20.1 → 3.21.2

package/lib/providers/auth.d.ts

@@ -1,27 +1,61 @@
-import { UserRecord, UserInfo, UserRecordMetadata, userRecordConstructor } from '../common/providers/identity';
-import { CloudFunction, EventContext } from '../cloud-functions';
+import { BlockingFunction, CloudFunction, EventContext } from '../cloud-functions';
+import { AuthEventContext, AuthUserRecord, BeforeCreateResponse, BeforeSignInResponse, HttpsError, UserInfo, UserRecord, userRecordConstructor, UserRecordMetadata } from '../common/providers/identity';
 import { DeploymentOptions } from '../function-configuration';
 export { UserRecord, UserInfo, UserRecordMetadata, userRecordConstructor };
+export { HttpsError };
 /** @hidden */
 export declare const provider = "google.firebase.auth";
 /** @hidden */
 export declare const service = "firebaseauth.googleapis.com";
 /**
- * Handle events related to Firebase authentication users.
+ * Resource level options
+ * @public
  */
-export declare function user(): UserBuilder;
+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;
+    };
+}
+/**
+ * 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): UserBuilder;
-/** Builder used to create Cloud Functions for Firebase Auth user lifecycle events. */
+export declare function _userWithOptions(options: DeploymentOptions, userOptions: UserOptions): UserBuilder;
+/**
+ * Builder used to create Cloud Functions for Firebase Auth user lifecycle events.
+ * @public
+ */
 export declare class UserBuilder {
     private triggerResource;
-    private options?;
+    private options;
+    private userOptions?;
     private static dataConstructor;
     /** @hidden */
-    constructor(triggerResource: () => string, options?: DeploymentOptions);
-    /** Respond to the creation of a Firebase Auth user. */
+    constructor(triggerResource: () => string, options: DeploymentOptions, userOptions?: UserOptions);
+    /**
+     * 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

@@ -21,52 +21,73 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserBuilder = exports._userWithOptions = exports.user = exports.service = exports.provider = exports.userRecordConstructor = exports.UserRecordMetadata = void 0;
+exports.UserBuilder = exports._userWithOptions = exports.user = exports.service = exports.provider = exports.HttpsError = exports.userRecordConstructor = exports.UserRecordMetadata = void 0;
+const cloud_functions_1 = require("../cloud-functions");
 const identity_1 = require("../common/providers/identity");
-Object.defineProperty(exports, "UserRecordMetadata", { enumerable: true, get: function () { return identity_1.UserRecordMetadata; } });
+Object.defineProperty(exports, "HttpsError", { enumerable: true, get: function () { return identity_1.HttpsError; } });
 Object.defineProperty(exports, "userRecordConstructor", { enumerable: true, get: function () { return identity_1.userRecordConstructor; } });
-const cloud_functions_1 = require("../cloud-functions");
+Object.defineProperty(exports, "UserRecordMetadata", { enumerable: true, get: function () { return identity_1.UserRecordMetadata; } });
 /** @hidden */
 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() {
-    return _userWithOptions({});
+function user(userOptions) {
+    return _userWithOptions({}, userOptions || {});
 }
 exports.user = user;
 /** @hidden */
-function _userWithOptions(options) {
+function _userWithOptions(options, userOptions) {
     return new UserBuilder(() => {
         if (!process.env.GCLOUD_PROJECT) {
             throw new Error('process.env.GCLOUD_PROJECT is not set.');
         }
         return 'projects/' + process.env.GCLOUD_PROJECT;
-    }, options);
+    }, 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) {
+    constructor(triggerResource, options, userOptions) {
         this.triggerResource = triggerResource;
         this.options = options;
+        this.userOptions = userOptions;
     }
     static dataConstructor(raw) {
-        return identity_1.userRecordConstructor(raw.data);
+        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');
     }
+    beforeCreate(handler) {
+        return this.beforeOperation(handler, 'beforeCreate');
+    }
+    beforeSignIn(handler) {
+        return this.beforeOperation(handler, 'beforeSignIn');
+    }
+    /** @hidden */
     onOperation(handler, eventType) {
-        return cloud_functions_1.makeCloudFunction({
+        return (0, cloud_functions_1.makeCloudFunction)({
             handler,
             provider: exports.provider,
             eventType,
@@ -77,5 +98,50 @@ 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;
+        const idToken = ((_d = (_c = this.userOptions) === null || _c === void 0 ? void 0 : _c.blockingOptions) === null || _d === void 0 ? void 0 : _d.idToken) || false;
+        const refreshToken = ((_f = (_e = this.userOptions) === null || _e === void 0 ? void 0 : _e.blockingOptions) === null || _f === void 0 ? void 0 : _f.refreshToken) || false;
+        // Create our own function that just calls the provided function so we know for sure that
+        // handler takes two arguments. This is something common/providers/identity depends on.
+        const wrappedHandler = (user, context) => handler(user, context);
+        const func = (0, identity_1.wrapHandler)(eventType, wrappedHandler);
+        const legacyEventType = `providers/cloud.auth/eventTypes/user.${eventType}`;
+        func.__trigger = {
+            labels: {},
+            ...(0, cloud_functions_1.optionsToTrigger)(this.options),
+            blockingTrigger: {
+                eventType: legacyEventType,
+                options: {
+                    accessToken,
+                    idToken,
+                    refreshToken,
+                },
+            },
+        };
+        func.__endpoint = {
+            platform: 'gcfv1',
+            labels: {},
+            ...(0, cloud_functions_1.optionsToEndpoint)(this.options),
+            blockingTrigger: {
+                eventType: legacyEventType,
+                options: {
+                    accessToken,
+                    idToken,
+                    refreshToken,
+                },
+            },
+        };
+        func.__requiredAPIs = [
+            {
+                api: 'identitytoolkit.googleapis.com',
+                reason: 'Needed for auth blocking functions',
+            },
+        ];
+        func.run = handler;
+        return func;
+    }
 }
 exports.UserBuilder = UserBuilder;

package/lib/providers/database.js

@@ -104,20 +104,20 @@ class InstanceBuilder {
      * @return Firebase Realtime Database reference builder interface.
      */
     ref(path) {
-        const normalized = path_1.normalizePath(path);
-        return new RefBuilder(apps_1.apps(), () => `projects/_/instances/${this.instance}/refs/${normalized}`, this.options);
+        const normalized = (0, path_1.normalizePath)(path);
+        return new RefBuilder((0, apps_1.apps)(), () => `projects/_/instances/${this.instance}/refs/${normalized}`, this.options);
     }
 }
 exports.InstanceBuilder = InstanceBuilder;
 /** @hidden */
 function _refWithOptions(path, options) {
     const resourceGetter = () => {
-        const normalized = path_1.normalizePath(path);
-        const databaseURL = config_1.firebaseConfig().databaseURL;
+        const normalized = (0, path_1.normalizePath)(path);
+        const databaseURL = (0, config_1.firebaseConfig)().databaseURL;
         if (!databaseURL) {
             throw new Error('Missing expected firebase config value databaseURL, ' +
                 'config is actually' +
-                JSON.stringify(config_1.firebaseConfig()) +
+                JSON.stringify((0, config_1.firebaseConfig)()) +
                 '\n If you are unit testing, please set process.env.FIREBASE_CONFIG');
         }
         let instance;
@@ -136,7 +136,7 @@ function _refWithOptions(path, options) {
         }
         return `projects/_/instances/${instance}/refs/${normalized}`;
     };
-    return new RefBuilder(apps_1.apps(), resourceGetter, options);
+    return new RefBuilder((0, apps_1.apps)(), resourceGetter, options);
 }
 exports._refWithOptions = _refWithOptions;
 /**
@@ -153,7 +153,7 @@ class RefBuilder {
         this.changeConstructor = (raw) => {
             const [dbInstance, path] = extractInstanceAndPath(raw.context.resource.name, raw.context.domain);
             const before = new DataSnapshot(raw.data.data, path, this.apps.admin, dbInstance);
-            const after = new DataSnapshot(utils_1.applyChange(raw.data.data, raw.data.delta), path, this.apps.admin, dbInstance);
+            const after = new DataSnapshot((0, utils_1.applyChange)(raw.data.data, raw.data.delta), path, this.apps.admin, dbInstance);
             return {
                 before,
                 after,
@@ -214,7 +214,7 @@ class RefBuilder {
         return this.onOperation(handler, 'ref.delete', dataConstructor);
     }
     onOperation(handler, eventType, dataConstructor) {
-        return cloud_functions_1.makeCloudFunction({
+        return (0, cloud_functions_1.makeCloudFunction)({
             handler,
             provider: exports.provider,
             service: exports.service,
@@ -311,7 +311,7 @@ class DataSnapshot {
      * However, accessing the key on the root URL of a Database will return `null`.
      */
     get key() {
-        const last = _.last(path_1.pathParts(this._fullPath()));
+        const last = _.last((0, path_1.pathParts)(this._fullPath()));
         return !last || last === '' ? null : last;
     }
     /**
@@ -326,7 +326,7 @@ class DataSnapshot {
      *   Array, string, number, boolean, or `null`).
      */
     val() {
-        const parts = path_1.pathParts(this._childPath);
+        const parts = (0, path_1.pathParts)(this._childPath);
         const source = this._data;
         const node = _.cloneDeep(parts.length ? _.get(source, parts, null) : source);
         return this._checkAndConvertToArray(node);
@@ -494,7 +494,7 @@ class DataSnapshot {
         const dup = new DataSnapshot(this._data, undefined, this.app, this.instance);
         [dup._path, dup._childPath] = [this._path, this._childPath];
         if (childPath) {
-            dup._childPath = path_1.joinPath(dup._childPath, childPath);
+            dup._childPath = (0, path_1.joinPath)(dup._childPath, childPath);
         }
         return dup;
     }

package/lib/providers/firestore.js

@@ -113,8 +113,8 @@ function _getValueProto(data, resource, valueFieldName) {
     }
     const proto = {
         fields: _.get(data, [valueFieldName, 'fields'], {}),
-        createTime: encoder_1.dateToTimestampProto(_.get(data, [valueFieldName, 'createTime'])),
-        updateTime: encoder_1.dateToTimestampProto(_.get(data, [valueFieldName, 'updateTime'])),
+        createTime: (0, encoder_1.dateToTimestampProto)(_.get(data, [valueFieldName, 'createTime'])),
+        updateTime: (0, encoder_1.dateToTimestampProto)(_.get(data, [valueFieldName, 'updateTime'])),
         name: _.get(data, [valueFieldName, 'name'], resource),
     };
     return proto;
@@ -123,7 +123,7 @@ function _getValueProto(data, resource, valueFieldName) {
 function snapshotConstructor(event) {
     var _a;
     if (!firestoreInstance) {
-        firestoreInstance = firebase.firestore(apps_1.apps().admin);
+        firestoreInstance = firebase.firestore((0, apps_1.apps)().admin);
     }
     const valueProto = _getValueProto(event.data, event.context.resource.name, 'value');
     let timeString = (_a = _.get(event, 'data.value.readTime')) !== null && _a !== void 0 ? _a : _.get(event, 'data.value.updateTime');
@@ -131,7 +131,7 @@ function snapshotConstructor(event) {
         logger.warn('Snapshot has no readTime. Using now()');
         timeString = new Date().toISOString();
     }
-    const readTime = encoder_1.dateToTimestampProto(timeString);
+    const readTime = (0, encoder_1.dateToTimestampProto)(timeString);
     return firestoreInstance.snapshot_(valueProto, readTime, 'json');
 }
 exports.snapshotConstructor = snapshotConstructor;
@@ -139,10 +139,10 @@ exports.snapshotConstructor = snapshotConstructor;
 // TODO remove this function when wire format changes to new format
 function beforeSnapshotConstructor(event) {
     if (!firestoreInstance) {
-        firestoreInstance = firebase.firestore(apps_1.apps().admin);
+        firestoreInstance = firebase.firestore((0, apps_1.apps)().admin);
     }
     const oldValueProto = _getValueProto(event.data, event.context.resource.name, 'oldValue');
-    const oldReadTime = encoder_1.dateToTimestampProto(_.get(event, 'data.oldValue.readTime'));
+    const oldReadTime = (0, encoder_1.dateToTimestampProto)(_.get(event, 'data.oldValue.readTime'));
     return firestoreInstance.snapshot_(oldValueProto, oldReadTime, 'json');
 }
 exports.beforeSnapshotConstructor = beforeSnapshotConstructor;
@@ -173,7 +173,7 @@ class DocumentBuilder {
         return this.onOperation(handler, 'document.delete', beforeSnapshotConstructor);
     }
     onOperation(handler, eventType, dataConstructor) {
-        return cloud_functions_1.makeCloudFunction({
+        return (0, cloud_functions_1.makeCloudFunction)({
             handler,
             provider: exports.provider,
             eventType,

package/lib/providers/https.js

@@ -50,17 +50,17 @@ function _onRequestWithOptions(handler, options) {
         return handler(req, res);
     };
     cloudFunction.__trigger = {
-        ...cloud_functions_1.optionsToTrigger(options),
+        ...(0, cloud_functions_1.optionsToTrigger)(options),
         httpsTrigger: {},
     };
-    encoding_1.convertIfPresent(cloudFunction.__trigger.httpsTrigger, options, 'invoker', 'invoker', encoding_1.convertInvoker);
+    (0, encoding_1.convertIfPresent)(cloudFunction.__trigger.httpsTrigger, options, 'invoker', 'invoker', encoding_1.convertInvoker);
     // TODO parse the options
     cloudFunction.__endpoint = {
         platform: 'gcfv1',
-        ...cloud_functions_1.optionsToEndpoint(options),
+        ...(0, cloud_functions_1.optionsToEndpoint)(options),
         httpsTrigger: {},
     };
-    encoding_1.convertIfPresent(cloudFunction.__endpoint.httpsTrigger, options, 'invoker', 'invoker', encoding_1.convertInvoker);
+    (0, encoding_1.convertIfPresent)(cloudFunction.__endpoint.httpsTrigger, options, 'invoker', 'invoker', encoding_1.convertInvoker);
     return cloudFunction;
 }
 exports._onRequestWithOptions = _onRequestWithOptions;
@@ -70,20 +70,20 @@ function _onCallWithOptions(handler, options) {
     // and the user could have only tried to listen to data. Wrap their handler
     // in another handler to avoid accidentally triggering the v2 API
     const fixedLen = (data, context) => handler(data, context);
-    const func = https_1.onCallHandler({
+    const func = (0, https_1.onCallHandler)({
         allowInvalidAppCheckToken: options.allowInvalidAppCheckToken,
         cors: { origin: true, methods: 'POST' },
     }, fixedLen);
     func.__trigger = {
         labels: {},
-        ...cloud_functions_1.optionsToTrigger(options),
+        ...(0, cloud_functions_1.optionsToTrigger)(options),
         httpsTrigger: {},
     };
     func.__trigger.labels['deployment-callable'] = 'true';
     func.__endpoint = {
         platform: 'gcfv1',
         labels: {},
-        ...cloud_functions_1.optionsToEndpoint(options),
+        ...(0, cloud_functions_1.optionsToEndpoint)(options),
         callableTrigger: {},
     };
     func.run = handler;

package/lib/providers/pubsub.d.ts

@@ -8,8 +8,8 @@ export declare const service = "pubsub.googleapis.com";
  * Registers a Cloud Function triggered when a Google Cloud Pub/Sub message
  * is sent to a specified topic.
  *
- * @param topic The Pub/Sub topic to watch for message events.
- * @return Pub/Sub topic builder interface.
+ * @param topic - The Pub/Sub topic to watch for message events.
+ * @returns Pub/Sub topic builder interface.
  */
 export declare function topic(topic: string): TopicBuilder;
 /** @hidden */
@@ -28,7 +28,7 @@ export declare class TopicBuilder {
      * Event handler that fires every time a Cloud Pub/Sub message is
      * published.
      *
-     * @param handler Event handler that runs every time a Cloud Pub/Sub message
+     * @param handler - Event handler that runs every time a Cloud Pub/Sub message
      *   is published.
      * @return A Cloud Function that you can export and deploy.
      */
@@ -37,7 +37,7 @@ export declare class TopicBuilder {
 /**
  * Registers a Cloud Function to run at specified times.
  *
- * @param schedule The schedule, in Unix Crontab or AppEngine syntax.
+ * @param schedule - The schedule, in Unix Crontab or AppEngine syntax.
  * @return ScheduleBuilder interface.
  */
 export declare function schedule(schedule: string): ScheduleBuilder;
@@ -63,7 +63,7 @@ export declare class ScheduleBuilder {
      * Event handler for scheduled functions. Triggered whenever the associated
      * scheduler job sends a Pub/Sub message.
      *
-     * @param handler Handler that fires whenever the associated
+     * @param handler - Handler that fires whenever the associated
      *   scheduler job sends a Pub/Sub message.
      * @return A Cloud Function that you can export and deploy.
      */
@@ -72,7 +72,7 @@ export declare class ScheduleBuilder {
 /**
  * Interface representing a Google Cloud Pub/Sub message.
  *
- * @param data Payload of a Pub/Sub message.
+ * @param data - Payload of a Pub/Sub message.
  */
 export declare class Message {
     /**

package/lib/providers/pubsub.js

@@ -31,8 +31,8 @@ exports.service = 'pubsub.googleapis.com';
  * Registers a Cloud Function triggered when a Google Cloud Pub/Sub message
  * is sent to a specified topic.
  *
- * @param topic The Pub/Sub topic to watch for message events.
- * @return Pub/Sub topic builder interface.
+ * @param topic - The Pub/Sub topic to watch for message events.
+ * @returns Pub/Sub topic builder interface.
  */
 function topic(topic) {
     return _topicWithOptions(topic, {});
@@ -66,12 +66,12 @@ class TopicBuilder {
      * Event handler that fires every time a Cloud Pub/Sub message is
      * published.
      *
-     * @param handler Event handler that runs every time a Cloud Pub/Sub message
+     * @param handler - Event handler that runs every time a Cloud Pub/Sub message
      *   is published.
      * @return A Cloud Function that you can export and deploy.
      */
     onPublish(handler) {
-        return cloud_functions_1.makeCloudFunction({
+        return (0, cloud_functions_1.makeCloudFunction)({
             handler,
             provider: exports.provider,
             service: exports.service,
@@ -86,7 +86,7 @@ exports.TopicBuilder = TopicBuilder;
 /**
  * Registers a Cloud Function to run at specified times.
  *
- * @param schedule The schedule, in Unix Crontab or AppEngine syntax.
+ * @param schedule - The schedule, in Unix Crontab or AppEngine syntax.
  * @return ScheduleBuilder interface.
  */
 function schedule(schedule) {
@@ -135,12 +135,12 @@ class ScheduleBuilder {
      * Event handler for scheduled functions. Triggered whenever the associated
      * scheduler job sends a Pub/Sub message.
      *
-     * @param handler Handler that fires whenever the associated
+     * @param handler - Handler that fires whenever the associated
      *   scheduler job sends a Pub/Sub message.
      * @return A Cloud Function that you can export and deploy.
      */
     onRun(handler) {
-        const cloudFunction = cloud_functions_1.makeCloudFunction({
+        const cloudFunction = (0, cloud_functions_1.makeCloudFunction)({
             contextOnlyHandler: handler,
             provider: exports.provider,
             service: exports.service,
@@ -156,7 +156,7 @@ exports.ScheduleBuilder = ScheduleBuilder;
 /**
  * Interface representing a Google Cloud Pub/Sub message.
  *
- * @param data Payload of a Pub/Sub message.
+ * @param data - Payload of a Pub/Sub message.
  */
 class Message {
     constructor(data) {

package/lib/providers/remoteConfig.js

@@ -65,7 +65,7 @@ class UpdateBuilder {
      * version metadata as an argument.
      */
     onUpdate(handler) {
-        return cloud_functions_1.makeCloudFunction({
+        return (0, cloud_functions_1.makeCloudFunction)({
             handler,
             provider: exports.provider,
             service: exports.service,

package/lib/providers/storage.js

@@ -53,7 +53,7 @@ exports.object = object;
 /** @hidden */
 function _bucketWithOptions(options, bucket) {
     const resourceGetter = () => {
-        bucket = bucket || config_1.firebaseConfig().storageBucket;
+        bucket = bucket || (0, config_1.firebaseConfig)().storageBucket;
         if (!bucket) {
             throw new Error('Missing bucket name. If you are unit testing, please provide a bucket name' +
                 ' through `functions.storage.bucket(bucketName)`, or set process.env.FIREBASE_CONFIG.');
@@ -170,7 +170,7 @@ class ObjectBuilder {
     }
     /** @hidden */
     onOperation(handler, eventType) {
-        return cloud_functions_1.makeCloudFunction({
+        return (0, cloud_functions_1.makeCloudFunction)({
             handler,
             provider: exports.provider,
             service: exports.service,

package/lib/providers/tasks.d.ts

@@ -1,46 +1,61 @@
 import * as express from 'express';
 import { Request } from '../common/providers/https';
+import { RateLimits, RetryConfig, TaskContext } from '../common/providers/tasks';
 import { ManifestEndpoint, ManifestRequiredAPI } from '../runtime/manifest';
-import { TaskContext, RateLimits, RetryConfig } from '../common/providers/tasks';
-export { 
-/** @hidden */
-RetryConfig as RetryPolicy, 
-/** @hidden */
-RateLimits, 
-/** @hidden */
-TaskContext, };
+export { RetryConfig, RateLimits, TaskContext };
 /**
- * Configurations for Task Queue Functions.
- * @hidden
+ * Options for configuring the task queue to listen to.
  */
 export interface TaskQueueOptions {
+    /** How a task should be retried in the event of a non-2xx return. */
     retryConfig?: RetryConfig;
+    /** How congestion control should be applied to the function. */
     rateLimits?: RateLimits;
     /**
      * Who can enqueue tasks for this function.
      * If left unspecified, only service accounts which have
-     * roles/cloudtasks.enqueuer and roles/cloudfunctions.invoker
+     * `roles/cloudtasks.enqueuer` and `roles/cloudfunctions.invoker`
      * will have permissions.
      */
     invoker?: 'private' | string | string[];
 }
-/** @hidden */
+/**
+ * A handler for tasks.
+ */
 export interface TaskQueueFunction {
     (req: Request, res: express.Response): Promise<void>;
+    /** @alpha */
     __trigger: unknown;
+    /** @alpha */
     __endpoint: ManifestEndpoint;
+    /** @alpha */
     __requiredAPIs?: ManifestRequiredAPI[];
+    /**
+     * The callback passed to the `TaskQueueFunction` constructor.
+     * @param data - The body enqueued into a task queue.
+     * @param context - The request context of the enqueued task
+     * @returns Any return value. Google Cloud Functions will await any promise
+     *          before shutting down your function. Resolved return values
+     *          are only used for unit testing purposes.
+     */
     run(data: any, context: TaskContext): void | Promise<void>;
 }
-/** @hidden */
+/**
+ * Builder for creating a `TaskQueueFunction`.
+ */
 export declare class TaskQueueBuilder {
     private readonly tqOpts?;
     private readonly depOpts?;
+    /**
+     * Creates a handler for tasks sent to a Google Cloud Tasks queue.
+     * @param handler - A callback to handle task requests.
+     * @returns A Cloud Function you can export and deploy.
+     */
     onDispatch(handler: (data: any, context: TaskContext) => void | Promise<void>): TaskQueueFunction;
 }
 /**
  * Declares a function that can handle tasks enqueued using the Firebase Admin SDK.
- * @param options Configuration for the Task Queue that feeds into this function.
- * @hidden
+ * @param options - Configuration for the Task Queue that feeds into this function.
+ *        Omitting options will configure a Task Queue with default settings.
  */
 export declare function taskQueue(options?: TaskQueueOptions): TaskQueueBuilder;

package/lib/providers/tasks.js

@@ -25,34 +25,41 @@ exports.taskQueue = exports.TaskQueueBuilder = void 0;
 const cloud_functions_1 = require("../cloud-functions");
 const encoding_1 = require("../common/encoding");
 const tasks_1 = require("../common/providers/tasks");
-/** @hidden */
+/**
+ * Builder for creating a `TaskQueueFunction`.
+ */
 class TaskQueueBuilder {
     /** @internal */
     constructor(tqOpts, depOpts) {
         this.tqOpts = tqOpts;
         this.depOpts = depOpts;
     }
+    /**
+     * Creates a handler for tasks sent to a Google Cloud Tasks queue.
+     * @param handler - A callback to handle task requests.
+     * @returns A Cloud Function you can export and deploy.
+     */
     onDispatch(handler) {
         // onEnqueueHandler sniffs the function length of the passed-in callback
         // and the user could have only tried to listen to data. Wrap their handler
         // in another handler to avoid accidentally triggering the v2 API
         const fixedLen = (data, context) => handler(data, context);
-        const func = tasks_1.onDispatchHandler(fixedLen);
+        const func = (0, tasks_1.onDispatchHandler)(fixedLen);
         func.__trigger = {
-            ...cloud_functions_1.optionsToTrigger(this.depOpts || {}),
+            ...(0, cloud_functions_1.optionsToTrigger)(this.depOpts || {}),
             taskQueueTrigger: {},
         };
-        encoding_1.copyIfPresent(func.__trigger.taskQueueTrigger, this.tqOpts, 'retryConfig');
-        encoding_1.copyIfPresent(func.__trigger.taskQueueTrigger, this.tqOpts, 'rateLimits');
-        encoding_1.convertIfPresent(func.__trigger.taskQueueTrigger, this.tqOpts, 'invoker', 'invoker', encoding_1.convertInvoker);
+        (0, encoding_1.copyIfPresent)(func.__trigger.taskQueueTrigger, this.tqOpts, 'retryConfig');
+        (0, encoding_1.copyIfPresent)(func.__trigger.taskQueueTrigger, this.tqOpts, 'rateLimits');
+        (0, encoding_1.convertIfPresent)(func.__trigger.taskQueueTrigger, this.tqOpts, 'invoker', 'invoker', encoding_1.convertInvoker);
         func.__endpoint = {
             platform: 'gcfv1',
-            ...cloud_functions_1.optionsToEndpoint(this.depOpts),
+            ...(0, cloud_functions_1.optionsToEndpoint)(this.depOpts),
             taskQueueTrigger: {},
         };
-        encoding_1.copyIfPresent(func.__endpoint.taskQueueTrigger, this.tqOpts, 'retryConfig');
-        encoding_1.copyIfPresent(func.__endpoint.taskQueueTrigger, this.tqOpts, 'rateLimits');
-        encoding_1.convertIfPresent(func.__endpoint.taskQueueTrigger, this.tqOpts, 'invoker', 'invoker', encoding_1.convertInvoker);
+        (0, encoding_1.copyIfPresent)(func.__endpoint.taskQueueTrigger, this.tqOpts, 'retryConfig');
+        (0, encoding_1.copyIfPresent)(func.__endpoint.taskQueueTrigger, this.tqOpts, 'rateLimits');
+        (0, encoding_1.convertIfPresent)(func.__endpoint.taskQueueTrigger, this.tqOpts, 'invoker', 'invoker', encoding_1.convertInvoker);
         func.__requiredAPIs = [
             {
                 api: 'cloudtasks.googleapis.com',
@@ -66,8 +73,8 @@ class TaskQueueBuilder {
 exports.TaskQueueBuilder = TaskQueueBuilder;
 /**
  * Declares a function that can handle tasks enqueued using the Firebase Admin SDK.
- * @param options Configuration for the Task Queue that feeds into this function.
- * @hidden
+ * @param options - Configuration for the Task Queue that feeds into this function.
+ *        Omitting options will configure a Task Queue with default settings.
  */
 function taskQueue(options) {
     return new TaskQueueBuilder(options);