firebase-admin 11.9.0 → 11.10.1

package/lib/functions/functions-api-client-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * @license
@@ -23,7 +23,8 @@ const error_1 = require("../utils/error");
 const utils = require("../utils/index");
 const validator = require("../utils/validator");
 const credential_internal_1 = require("../app/credential-internal");
-const CLOUD_TASKS_API_URL_FORMAT = 'https://cloudtasks.googleapis.com/v2/projects/{projectId}/locations/{locationId}/queues/{resourceId}/tasks';
+const CLOUD_TASKS_API_RESOURCE_PATH = 'projects/{projectId}/locations/{locationId}/queues/{resourceId}/tasks';
+const CLOUD_TASKS_API_URL_FORMAT = 'https://cloudtasks.googleapis.com/v2/' + CLOUD_TASKS_API_RESOURCE_PATH;
 const FIREBASE_FUNCTION_URL_FORMAT = 'https://{locationId}-{projectId}.cloudfunctions.net/{resourceId}';
 const FIREBASE_FUNCTIONS_CONFIG_HEADERS = {
     'X-Firebase-Client': `fire-admin-node/${utils.getSdkVersion()}`
@@ -43,6 +44,58 @@ class FunctionsApiClient {
         }
         this.httpClient = new api_request_1.AuthorizedHttpClient(app);
     }
+    /**
+     * Deletes a task from a queue.
+     *
+     * @param id - The ID of the task to delete.
+     * @param functionName - The function name of the queue.
+     * @param extensionId - Optional canonical ID of the extension.
+     */
+    async delete(id, functionName, extensionId) {
+        if (!validator.isNonEmptyString(functionName)) {
+            throw new FirebaseFunctionsError('invalid-argument', 'Function name must be a non empty string');
+        }
+        if (!validator.isTaskId(id)) {
+            throw new FirebaseFunctionsError('invalid-argument', 'id can contain only letters ([A-Za-z]), numbers ([0-9]), '
+                + 'hyphens (-), or underscores (_). The maximum length is 500 characters.');
+        }
+        let resources;
+        try {
+            resources = utils.parseResourceName(functionName, 'functions');
+        }
+        catch (err) {
+            throw new FirebaseFunctionsError('invalid-argument', 'Function name must be a single string or a qualified resource name');
+        }
+        resources.projectId = resources.projectId || await this.getProjectId();
+        resources.locationId = resources.locationId || DEFAULT_LOCATION;
+        if (!validator.isNonEmptyString(resources.resourceId)) {
+            throw new FirebaseFunctionsError('invalid-argument', 'No valid function name specified to enqueue tasks for.');
+        }
+        if (typeof extensionId !== 'undefined' && validator.isNonEmptyString(extensionId)) {
+            resources.resourceId = `ext-${extensionId}-${resources.resourceId}`;
+        }
+        try {
+            const serviceUrl = await this.getUrl(resources, CLOUD_TASKS_API_URL_FORMAT.concat('/', id));
+            const request = {
+                method: 'DELETE',
+                url: serviceUrl,
+                headers: FIREBASE_FUNCTIONS_CONFIG_HEADERS,
+            };
+            await this.httpClient.send(request);
+        }
+        catch (err) {
+            if (err instanceof api_request_1.HttpError) {
+                if (err.response.status === 404) {
+                    // if no task with the provided ID exists, then ignore the delete.
+                    return;
+                }
+                throw this.toFirebaseError(err);
+            }
+            else {
+                throw err;
+            }
+        }
+    }
     /**
      * Creates a task and adds it to a queue.
      *
@@ -51,11 +104,10 @@ class FunctionsApiClient {
      * @param extensionId - Optional canonical ID of the extension.
      * @param opts - Optional options when enqueuing a new task.
      */
-    enqueue(data, functionName, extensionId, opts) {
+    async enqueue(data, functionName, extensionId, opts) {
         if (!validator.isNonEmptyString(functionName)) {
             throw new FirebaseFunctionsError('invalid-argument', 'Function name must be a non empty string');
         }
-        const task = this.validateTaskOptions(data, opts);
         let resources;
         try {
             resources = utils.parseResourceName(functionName, 'functions');
@@ -63,30 +115,41 @@ class FunctionsApiClient {
         catch (err) {
             throw new FirebaseFunctionsError('invalid-argument', 'Function name must be a single string or a qualified resource name');
         }
+        resources.projectId = resources.projectId || await this.getProjectId();
+        resources.locationId = resources.locationId || DEFAULT_LOCATION;
+        if (!validator.isNonEmptyString(resources.resourceId)) {
+            throw new FirebaseFunctionsError('invalid-argument', 'No valid function name specified to enqueue tasks for.');
+        }
         if (typeof extensionId !== 'undefined' && validator.isNonEmptyString(extensionId)) {
             resources.resourceId = `ext-${extensionId}-${resources.resourceId}`;
         }
-        return this.getUrl(resources, CLOUD_TASKS_API_URL_FORMAT)
-            .then((serviceUrl) => {
-            return this.updateTaskPayload(task, resources, extensionId)
-                .then((task) => {
-                const request = {
-                    method: 'POST',
-                    url: serviceUrl,
-                    headers: FIREBASE_FUNCTIONS_CONFIG_HEADERS,
-                    data: {
-                        task,
-                    }
-                };
-                return this.httpClient.send(request);
-            });
-        })
-            .then(() => {
-            return;
-        })
-            .catch((err) => {
-            throw this.toFirebaseError(err);
-        });
+        const task = this.validateTaskOptions(data, resources, opts);
+        try {
+            const serviceUrl = await this.getUrl(resources, CLOUD_TASKS_API_URL_FORMAT);
+            const taskPayload = await this.updateTaskPayload(task, resources, extensionId);
+            const request = {
+                method: 'POST',
+                url: serviceUrl,
+                headers: FIREBASE_FUNCTIONS_CONFIG_HEADERS,
+                data: {
+                    task: taskPayload,
+                }
+            };
+            await this.httpClient.send(request);
+        }
+        catch (err) {
+            if (err instanceof api_request_1.HttpError) {
+                if (err.response.status === 409) {
+                    throw new FirebaseFunctionsError('task-already-exists', `A task with ID ${opts?.id} already exists`);
+                }
+                else {
+                    throw this.toFirebaseError(err);
+                }
+            }
+            else {
+                throw err;
+            }
+        }
     }
     getUrl(resourceName, urlFormat) {
         let { locationId } = resourceName;
@@ -142,7 +205,7 @@ class FunctionsApiClient {
             return accountId;
         });
     }
-    validateTaskOptions(data, opts) {
+    validateTaskOptions(data, resources, opts) {
         const task = {
             httpRequest: {
                 url: '',
@@ -150,7 +213,10 @@ class FunctionsApiClient {
                     serviceAccountEmail: '',
                 },
                 body: Buffer.from(JSON.stringify({ data })).toString('base64'),
-                headers: { 'Content-Type': 'application/json' }
+                headers: {
+                    'Content-Type': 'application/json',
+                    ...opts?.headers,
+                }
             }
         };
         if (typeof opts !== 'undefined') {
@@ -183,6 +249,18 @@ class FunctionsApiClient {
                 }
                 task.dispatchDeadline = `${opts.dispatchDeadlineSeconds}s`;
             }
+            if ('id' in opts && typeof opts.id !== 'undefined') {
+                if (!validator.isTaskId(opts.id)) {
+                    throw new FirebaseFunctionsError('invalid-argument', 'id can contain only letters ([A-Za-z]), numbers ([0-9]), '
+                        + 'hyphens (-), or underscores (_). The maximum length is 500 characters.');
+                }
+                const resourcePath = utils.formatString(CLOUD_TASKS_API_RESOURCE_PATH, {
+                    projectId: resources.projectId,
+                    locationId: resources.locationId,
+                    resourceId: resources.resourceId,
+                });
+                task.name = resourcePath.concat('/', opts.id);
+            }
             if (typeof opts.uri !== 'undefined') {
                 if (!validator.isURL(opts.uri)) {
                     throw new FirebaseFunctionsError('invalid-argument', 'uri must be a valid URL string.');

package/lib/functions/functions-api.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * @license
  * Copyright 2021 Google Inc.
@@ -54,6 +54,38 @@ export type TaskOptions = DeliverySchedule & TaskOptionsExperimental & {
      * The default is 10 minutes. The deadline must be in the range of 15 seconds and 30 minutes.
      */
     dispatchDeadlineSeconds?: number;
+    /**
+     * The ID to use for the enqueued event.
+     * If not provided, one will be automatically generated.
+     * If provided, an explicitly specified task ID enables task de-duplication. If a task's ID is
+     * identical to that of an existing task or a task that was deleted or executed recently then
+     * the call will throw an error with code "functions/task-already-exists". Another task with
+     * the same ID can't be created for ~1hour after the original task was deleted or executed.
+     *
+     * Because there is an extra lookup cost to identify duplicate task IDs, setting ID
+     * significantly increases latency. Using hashed strings for the task ID or for the prefix of
+     * the task ID is recommended. Choosing task IDs that are sequential or have sequential
+     * prefixes, for example using a timestamp, causes an increase in latency and error rates in
+     * all task commands. The infrastructure relies on an approximately uniform distribution of
+     * task IDs to store and serve tasks efficiently.
+     *
+     * "Push IDs" from the Firebase Realtime Database make poor IDs because they are based on
+     * timestamps and will cause contention (slowdowns) in your task queue. Reversed push IDs
+     * however form a perfect distribution and are an ideal key. To reverse a string in
+     * javascript use `someString.split("").reverse().join("")`
+     */
+    id?: string;
+    /**
+     * HTTP request headers to include in the request to the task queue function.
+     * These headers represent a subset of the headers that will accompany the task's HTTP
+     * request. Some HTTP request headers will be ignored or replaced, e.g. Authorization, Host, Content-Length,
+     * User-Agent etc. cannot be overridden.
+     *
+     * By default, Content-Type is set to 'application/json'.
+     *
+     * The size of the headers must be less than 80KB.
+     */
+    headers?: Record<string, string>;
 };
 /**
  * Type representing experimental (beta) task options.

package/lib/functions/functions-api.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * @license

package/lib/functions/functions.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * @license
  * Copyright 2021 Google Inc.
@@ -60,4 +60,10 @@ export declare class TaskQueue<Args = Record<string, any>> {
      * @returns A promise that resolves when the task has successfully been added to the queue.
      */
     enqueue(data: Args, opts?: TaskOptions): Promise<void>;
+    /**
+     * Deletes an enqueued task if it has not yet completed.
+     * @param id - the ID of the task, relative to this queue.
+     * @returns A promise that resolves when the task has been deleted.
+     */
+    delete(id: string): Promise<void>;
 }

package/lib/functions/functions.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * @license
@@ -93,5 +93,13 @@ class TaskQueue {
     enqueue(data, opts) {
         return this.client.enqueue(data, this.functionName, this.extensionId, opts);
     }
+    /**
+     * Deletes an enqueued task if it has not yet completed.
+     * @param id - the ID of the task, relative to this queue.
+     * @returns A promise that resolves when the task has been deleted.
+     */
+    delete(id) {
+        return this.client.delete(id, this.functionName, this.extensionId);
+    }
 }
 exports.TaskQueue = TaskQueue;

package/lib/functions/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * @license
  * Copyright 2021 Google Inc.
@@ -22,7 +22,7 @@
  */
 import { App } from '../app';
 import { Functions } from './functions';
-export { DelayDelivery, AbsoluteDelivery, DeliverySchedule, TaskOptions, TaskOptionsExperimental } from './functions-api';
+export { DelayDelivery, AbsoluteDelivery, DeliverySchedule, TaskOptions, TaskOptionsExperimental, } from './functions-api';
 export { Functions, TaskQueue } from './functions';
 /**
  * Gets the {@link Functions} service for the default app

package/lib/functions/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * @license

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * @license
  * Copyright 2017 Google Inc.

package/lib/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * @license

package/lib/installations/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/installations/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/installations/installations-namespace.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/installations/installations-namespace.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/installations/installations-request-handler.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * @license
  * Copyright 2021 Google Inc.

package/lib/installations/installations-request-handler.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * @license

package/lib/installations/installations.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/installations/installations.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/instance-id/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/instance-id/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

package/lib/instance-id/instance-id-namespace.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 import { App } from '../app/index';
 import { InstanceId as TInstanceId } from './instance-id';
 /**

package/lib/instance-id/instance-id-namespace.js

@@ -1,3 +1,3 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });

package/lib/instance-id/instance-id.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/instance-id/instance-id.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

package/lib/machine-learning/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/machine-learning/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

package/lib/machine-learning/machine-learning-api-client.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/machine-learning/machine-learning-api-client.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

package/lib/machine-learning/machine-learning-namespace.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/machine-learning/machine-learning-namespace.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/machine-learning/machine-learning-utils.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/machine-learning/machine-learning-utils.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

package/lib/machine-learning/machine-learning.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/machine-learning/machine-learning.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

package/lib/messaging/batch-request-internal.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * Copyright 2019 Google Inc.
  *

package/lib/messaging/batch-request-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * Copyright 2019 Google Inc.

package/lib/messaging/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/messaging/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

package/lib/messaging/messaging-api-request-internal.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * @license
  * Copyright 2017 Google Inc.

package/lib/messaging/messaging-api-request-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * @license

package/lib/messaging/messaging-api.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * @license
  * Copyright 2021 Google Inc.

package/lib/messaging/messaging-api.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * @license

package/lib/messaging/messaging-errors-internal.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * Copyright 2019 Google Inc.
  *

package/lib/messaging/messaging-errors-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * Copyright 2019 Google Inc.

package/lib/messaging/messaging-internal.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/messaging/messaging-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

package/lib/messaging/messaging-namespace.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/messaging/messaging-namespace.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/messaging/messaging.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * @license
  * Copyright 2017 Google Inc.

package/lib/messaging/messaging.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * @license

package/lib/project-management/android-app.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * Copyright 2018 Google Inc.
  *

package/lib/project-management/android-app.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * Copyright 2018 Google Inc.

package/lib/project-management/app-metadata.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/project-management/app-metadata.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/project-management/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v11.9.0 */
+/*! firebase-admin v11.10.1 */
 /*!
  * Copyright 2020 Google Inc.
  *