firebase-admin 10.0.1 → 10.2.0

package/lib/functions/functions.js

@@ -0,0 +1,99 @@
+/*! firebase-admin v10.2.0 */
+"use strict";
+/*!
+ * @license
+ * Copyright 2021 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TaskQueue = exports.Functions = void 0;
+var functions_api_client_internal_1 = require("./functions-api-client-internal");
+var validator = require("../utils/validator");
+/**
+ * The Firebase `Functions` service interface.
+ */
+var Functions = /** @class */ (function () {
+    /**
+   * @param app - The app for this `Functions` service.
+   * @constructor
+   * @internal
+   */
+    function Functions(app) {
+        this.app = app;
+        this.client = new functions_api_client_internal_1.FunctionsApiClient(app);
+    }
+    /**
+     * Creates a reference to a {@link TaskQueue} for a given function name.
+     * The function name can be either:
+     *
+     * 1) A fully qualified function resource name:
+     *     `projects/{project}/locations/{location}/functions/{functionName}`
+     *
+     * 2) A partial resource name with location and function name, in which case
+     *     the runtime project ID is used:
+     *     `locations/{location}/functions/{functionName}`
+     *
+     * 3) A partial function name, in which case the runtime project ID and the default location,
+     *     `us-central1`, is used:
+     *     `{functionName}`
+     *
+     * @param functionName - The name of the function.
+     * @param extensionId - Optional Firebase extension ID.
+     * @returns A promise that fulfills with a `TaskQueue`.
+     */
+    Functions.prototype.taskQueue = function (functionName, extensionId) {
+        return new TaskQueue(functionName, this.client, extensionId);
+    };
+    return Functions;
+}());
+exports.Functions = Functions;
+/**
+ * The `TaskQueue` interface.
+ */
+var TaskQueue = /** @class */ (function () {
+    /**
+     * @param functionName - The name of the function.
+     * @param client - The `FunctionsApiClient` instance.
+     * @param extensionId - Optional canonical ID of the extension.
+     * @constructor
+     * @internal
+     */
+    function TaskQueue(functionName, client, extensionId) {
+        this.functionName = functionName;
+        this.client = client;
+        this.extensionId = extensionId;
+        if (!validator.isNonEmptyString(functionName)) {
+            throw new functions_api_client_internal_1.FirebaseFunctionsError('invalid-argument', '`functionName` must be a non-empty string.');
+        }
+        if (!validator.isNonNullObject(client) || !('enqueue' in client)) {
+            throw new functions_api_client_internal_1.FirebaseFunctionsError('invalid-argument', 'Must provide a valid FunctionsApiClient instance to create a new TaskQueue.');
+        }
+        if (typeof extensionId !== 'undefined' && !validator.isString(extensionId)) {
+            throw new functions_api_client_internal_1.FirebaseFunctionsError('invalid-argument', '`extensionId` must be a string.');
+        }
+    }
+    /**
+     * Creates a task and adds it to the queue. Tasks cannot be updated after creation.
+     * This action requires `cloudtasks.tasks.create` IAM permission on the service account.
+     *
+     * @param data - The data payload of the task.
+     * @param opts - Optional options when enqueuing a new task.
+     * @returns A promise that resolves when the task has successfully been added to the queue.
+     */
+    TaskQueue.prototype.enqueue = function (data, opts) {
+        return this.client.enqueue(data, this.functionName, this.extensionId, opts);
+    };
+    return TaskQueue;
+}());
+exports.TaskQueue = TaskQueue;

package/lib/functions/index.d.ts

@@ -0,0 +1,53 @@
+/*! firebase-admin v10.2.0 */
+/*!
+ * @license
+ * Copyright 2021 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Firebase Functions service.
+ *
+ * @packageDocumentation
+ */
+import { App } from '../app';
+import { Functions } from './functions';
+export { DelayDelivery, AbsoluteDelivery, DeliverySchedule, TaskOptions, TaskOptionsExperimental } from './functions-api';
+export { Functions, TaskQueue } from './functions';
+/**
+ * Gets the {@link Functions} service for the default app
+ * or a given app.
+ *
+ * `getFunctions()` can be called with no arguments to access the default
+ * app's `Functions` service or as `getFunctions(app)` to access the
+ * `Functions` service associated with a specific app.
+ *
+ * @example
+ * ```javascript
+ * // Get the `Functions` service for the default app
+ * const defaultFunctions = getFunctions();
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Get the `Functions` service for a given app
+ * const otherFunctions = getFunctions(otherApp);
+ * ```
+ *
+ * @param app - Optional app for which to return the `Functions` service.
+ *   If not provided, the default `Functions` service is returned.
+ *
+ * @returns The default `Functions` service if no app is provided, or the `Functions`
+ *   service associated with the provided app.
+ */
+export declare function getFunctions(app?: App): Functions;

package/lib/functions/index.js

@@ -0,0 +1,64 @@
+/*! firebase-admin v10.2.0 */
+"use strict";
+/*!
+ * @license
+ * Copyright 2021 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFunctions = void 0;
+/**
+ * Firebase Functions service.
+ *
+ * @packageDocumentation
+ */
+var app_1 = require("../app");
+var functions_1 = require("./functions");
+var functions_2 = require("./functions");
+Object.defineProperty(exports, "Functions", { enumerable: true, get: function () { return functions_2.Functions; } });
+Object.defineProperty(exports, "TaskQueue", { enumerable: true, get: function () { return functions_2.TaskQueue; } });
+/**
+ * Gets the {@link Functions} service for the default app
+ * or a given app.
+ *
+ * `getFunctions()` can be called with no arguments to access the default
+ * app's `Functions` service or as `getFunctions(app)` to access the
+ * `Functions` service associated with a specific app.
+ *
+ * @example
+ * ```javascript
+ * // Get the `Functions` service for the default app
+ * const defaultFunctions = getFunctions();
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Get the `Functions` service for a given app
+ * const otherFunctions = getFunctions(otherApp);
+ * ```
+ *
+ * @param app - Optional app for which to return the `Functions` service.
+ *   If not provided, the default `Functions` service is returned.
+ *
+ * @returns The default `Functions` service if no app is provided, or the `Functions`
+ *   service associated with the provided app.
+ */
+function getFunctions(app) {
+    if (typeof app === 'undefined') {
+        app = app_1.getApp();
+    }
+    var firebaseApp = app;
+    return firebaseApp.getOrInitService('functions', function (app) { return new functions_1.Functions(app); });
+}
+exports.getFunctions = getFunctions;

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * @license
  * Copyright 2017 Google Inc.

package/lib/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * @license

package/lib/installations/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/installations/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/installations/installations-namespace.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * @license
  * Copyright 2021 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * @license

package/lib/installations/installations.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/installations/installations.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/instance-id/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 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 v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2020 Google Inc.
  *

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/machine-learning/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2020 Google Inc.
  *

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2020 Google Inc.
  *

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2020 Google Inc.
  *

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2019 Google Inc.
  *

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2019 Google Inc.

package/lib/messaging/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/messaging/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * @license
  * Copyright 2017 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * @license

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * @license
  * Copyright 2021 Google Inc.

package/lib/messaging/messaging-api.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * @license

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2019 Google Inc.
  *

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2019 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/messaging/messaging-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/messaging/messaging-namespace.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

package/lib/messaging/messaging.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * @license
  * Copyright 2017 Google Inc.

package/lib/messaging/messaging.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * @license
@@ -35,7 +35,6 @@ var utils = require("../utils");
 var validator = require("../utils/validator");
 var messaging_internal_1 = require("./messaging-internal");
 var messaging_api_request_internal_1 = require("./messaging-api-request-internal");
-/* eslint-disable @typescript-eslint/camelcase */
 // FCM endpoints
 var FCM_SEND_HOST = 'fcm.googleapis.com';
 var FCM_SEND_PATH = '/fcm/send';

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2018 Google Inc.
  *

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2018 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/project-management/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2018 Google Inc.
  *

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2018 Google Inc.

package/lib/project-management/project-management-api-request-internal.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2018 Google Inc.
  *

package/lib/project-management/project-management-api-request-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2018 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2021 Google Inc.
  *

package/lib/project-management/project-management-namespace.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2021 Google Inc.

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2018 Google Inc.
  *

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

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2018 Google Inc.

package/lib/remote-config/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 /*!
  * Copyright 2020 Google Inc.
  *

package/lib/remote-config/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v10.0.1 */
+/*! firebase-admin v10.2.0 */
 "use strict";
 /*!
  * Copyright 2020 Google Inc.