firebase-admin 9.12.0

package/lib/installations/index.d.ts

@@ -0,0 +1,81 @@
+/*! firebase-admin v9.12.0 */
+/*!
+ * 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.
+ */
+import { app } from '../firebase-namespace-api';
+/**
+ * Gets the {@link installations.Installations `Installations`} service for the
+ * default app or a given app.
+ *
+ * `admin.installations()` can be called with no arguments to access the default
+ * app's {@link installations.Installations `Installations`} service or as
+ * `admin.installations(app)` to access the
+ * {@link installations.Installations `Installations`} service associated with a
+ * specific app.
+ *
+ * @example
+ * ```javascript
+ * // Get the Installations service for the default app
+ * var defaultInstallations = admin.installations();
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Get the Installations service for a given app
+ * var otherInstallations = admin.installations(otherApp);
+ *```
+ *
+ * @param app Optional app whose `Installations` service to
+ *   return. If not provided, the default `Installations` service is
+ *   returned.
+ *
+ * @return The default `Installations` service if
+ *   no app is provided or the `Installations` service associated with the
+ *   provided app.
+ */
+export declare function installations(app?: app.App): installations.Installations;
+export declare namespace installations {
+    /**
+     * Gets the {@link Installations `Installations`} service for the
+     * current app.
+     *
+     * @example
+     * ```javascript
+     * var installations = app.installations();
+     * // The above is shorthand for:
+     * // var installations = admin.installations(app);
+     * ```
+     *
+     * @return The `Installations` service for the
+     *   current app.
+     */
+    interface Installations {
+        app: app.App;
+        /**
+         * Deletes the specified installation ID and the associated data from Firebase.
+         *
+         * Note that Google Analytics for Firebase uses its own form of Instance ID to
+         * keep track of analytics data. Therefore deleting a Firebase installation ID does
+         * not delete Analytics data. See
+         * [Delete a Firebase installation](/docs/projects/manage-installations#delete-installation)
+         * for more information.
+         *
+         * @param fid The Firebase installation ID to be deleted.
+         *
+         * @return A promise fulfilled when the installation ID is deleted.
+         */
+        deleteInstallation(fid: string): Promise<void>;
+    }
+}

package/lib/installations/index.js

@@ -0,0 +1,18 @@
+/*! firebase-admin v9.12.0 */
+"use strict";
+/*!
+ * 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 });

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

@@ -0,0 +1,117 @@
+/*! firebase-admin v9.12.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.FirebaseInstallationsRequestHandler = void 0;
+var error_1 = require("../utils/error");
+var api_request_1 = require("../utils/api-request");
+var utils = require("../utils/index");
+var validator = require("../utils/validator");
+/** Firebase IID backend host. */
+var FIREBASE_IID_HOST = 'console.firebase.google.com';
+/** Firebase IID backend path. */
+var FIREBASE_IID_PATH = '/v1/';
+/** Firebase IID request timeout duration in milliseconds. */
+var FIREBASE_IID_TIMEOUT = 10000;
+/** HTTP error codes raised by the backend server. */
+var ERROR_CODES = {
+    400: 'Malformed installation ID argument.',
+    401: 'Request not authorized.',
+    403: 'Project does not match installation ID or the client does not have sufficient privileges.',
+    404: 'Failed to find the installation ID.',
+    409: 'Already deleted.',
+    429: 'Request throttled out by the backend server.',
+    500: 'Internal server error.',
+    503: 'Backend servers are over capacity. Try again later.',
+};
+/**
+ * Class that provides mechanism to send requests to the FIS backend endpoints.
+ */
+var FirebaseInstallationsRequestHandler = /** @class */ (function () {
+    /**
+     * @param app The app used to fetch access tokens to sign API requests.
+     *
+     * @constructor
+     */
+    function FirebaseInstallationsRequestHandler(app) {
+        this.app = app;
+        this.host = FIREBASE_IID_HOST;
+        this.timeout = FIREBASE_IID_TIMEOUT;
+        this.httpClient = new api_request_1.AuthorizedHttpClient(app);
+    }
+    FirebaseInstallationsRequestHandler.prototype.deleteInstallation = function (fid) {
+        if (!validator.isNonEmptyString(fid)) {
+            return Promise.reject(new error_1.FirebaseInstallationsError(error_1.InstallationsClientErrorCode.INVALID_INSTALLATION_ID, 'Installation ID must be a non-empty string.'));
+        }
+        return this.invokeRequestHandler(new api_request_1.ApiSettings(fid, 'DELETE'));
+    };
+    /**
+     * Invokes the request handler based on the API settings object passed.
+     *
+     * @param apiSettings The API endpoint settings to apply to request and response.
+     * @return A promise that resolves when the request is complete.
+     */
+    FirebaseInstallationsRequestHandler.prototype.invokeRequestHandler = function (apiSettings) {
+        var _this = this;
+        return this.getPathPrefix()
+            .then(function (path) {
+            var req = {
+                url: "https://" + _this.host + path + apiSettings.getEndpoint(),
+                method: apiSettings.getHttpMethod(),
+                timeout: _this.timeout,
+            };
+            return _this.httpClient.send(req);
+        })
+            .then(function () {
+            // return nothing on success
+        })
+            .catch(function (err) {
+            if (err instanceof api_request_1.HttpError) {
+                var response = err.response;
+                var errorMessage = (response.isJson() && 'error' in response.data) ?
+                    response.data.error : response.text;
+                var template = ERROR_CODES[response.status];
+                var message = template ?
+                    "Installation ID \"" + apiSettings.getEndpoint() + "\": " + template : errorMessage;
+                throw new error_1.FirebaseInstallationsError(error_1.InstallationsClientErrorCode.API_ERROR, message);
+            }
+            // In case of timeouts and other network errors, the HttpClient returns a
+            // FirebaseError wrapped in the response. Simply throw it here.
+            throw err;
+        });
+    };
+    FirebaseInstallationsRequestHandler.prototype.getPathPrefix = function () {
+        var _this = this;
+        if (this.path) {
+            return Promise.resolve(this.path);
+        }
+        return utils.findProjectId(this.app)
+            .then(function (projectId) {
+            if (!validator.isNonEmptyString(projectId)) {
+                // Assert for an explicit projct ID (either via AppOptions or the cert itself).
+                throw new error_1.FirebaseInstallationsError(error_1.InstallationsClientErrorCode.INVALID_PROJECT_ID, 'Failed to determine project ID for Installations. Initialize the '
+                    + 'SDK with service account credentials or set project ID as an app option. '
+                    + 'Alternatively set the GOOGLE_CLOUD_PROJECT environment variable.');
+            }
+            _this.path = FIREBASE_IID_PATH + ("project/" + projectId + "/instanceId/");
+            return _this.path;
+        });
+    };
+    return FirebaseInstallationsRequestHandler;
+}());
+exports.FirebaseInstallationsRequestHandler = FirebaseInstallationsRequestHandler;

package/lib/installations/installations.js

@@ -0,0 +1,62 @@
+/*! firebase-admin v9.12.0 */
+"use strict";
+/*!
+ * 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.Installations = void 0;
+var error_1 = require("../utils/error");
+var installations_request_handler_1 = require("./installations-request-handler");
+var validator = require("../utils/validator");
+/**
+ * The `Installations` service for the current app.
+ */
+var Installations = /** @class */ (function () {
+    /**
+     * @param app The app for this Installations service.
+     * @constructor
+     */
+    function Installations(app) {
+        if (!validator.isNonNullObject(app) || !('options' in app)) {
+            throw new error_1.FirebaseInstallationsError(error_1.InstallationsClientErrorCode.INVALID_ARGUMENT, 'First argument passed to admin.installations() must be a valid Firebase app instance.');
+        }
+        this.app_ = app;
+        this.requestHandler = new installations_request_handler_1.FirebaseInstallationsRequestHandler(app);
+    }
+    /**
+     * Deletes the specified installation ID and the associated data from Firebase.
+     *
+     * @param fid The Firebase installation ID to be deleted.
+     *
+     * @return A promise fulfilled when the installation ID is deleted.
+     */
+    Installations.prototype.deleteInstallation = function (fid) {
+        return this.requestHandler.deleteInstallation(fid);
+    };
+    Object.defineProperty(Installations.prototype, "app", {
+        /**
+         * Returns the app associated with this Installations instance.
+         *
+         * @return The app associated with this Installations instance.
+         */
+        get: function () {
+            return this.app_;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return Installations;
+}());
+exports.Installations = Installations;

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

@@ -0,0 +1,83 @@
+/*! firebase-admin v9.12.0 */
+/*!
+ * Copyright 2020 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.
+ */
+import { app } from '../firebase-namespace-api';
+/**
+ * Gets the {@link instanceId.InstanceId `InstanceId`} service for the
+ * default app or a given app.
+ *
+ * `admin.instanceId()` can be called with no arguments to access the default
+ * app's {@link instanceId.InstanceId `InstanceId`} service or as
+ * `admin.instanceId(app)` to access the
+ * {@link instanceId.InstanceId `InstanceId`} service associated with a
+ * specific app.
+ *
+ * @example
+ * ```javascript
+ * // Get the Instance ID service for the default app
+ * var defaultInstanceId = admin.instanceId();
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Get the Instance ID service for a given app
+ * var otherInstanceId = admin.instanceId(otherApp);
+ *```
+ *
+ * This API is deprecated. Developers are advised to use the `admin.installations()`
+ * API to delete their instance IDs and Firebase installation IDs.
+ *
+ * @param app Optional app whose `InstanceId` service to
+ *   return. If not provided, the default `InstanceId` service will be
+ *   returned.
+ *
+ * @return The default `InstanceId` service if
+ *   no app is provided or the `InstanceId` service associated with the
+ *   provided app.
+ *
+ * @deprecated
+ */
+export declare function instanceId(app?: app.App): instanceId.InstanceId;
+export declare namespace instanceId {
+    /**
+     * The {@link InstanceId `InstanceId`} service for the
+     * current app.
+     *
+     * @deprecated
+     */
+    interface InstanceId {
+        app: app.App;
+        /**
+         * Deletes the specified instance ID and the associated data from Firebase.
+         *
+         * Note that Google Analytics for Firebase uses its own form of Instance ID to
+         * keep track of analytics data. Therefore deleting a Firebase Instance ID does
+         * not delete Analytics data. See
+         * [Delete an Instance ID](/support/privacy/manage-iids#delete_an_instance_id)
+         * for more information.
+         *
+         * This API is deprecated. Developers are advised to use the `Installations.deleteInstallation()`
+         * API instead.
+         *
+         * @param instanceId The instance ID to be deleted.
+         *
+         * @return A promise fulfilled when the instance ID is deleted.
+         *
+         * @deprecated
+         */
+        deleteInstanceId(instanceId: string): Promise<void>;
+    }
+}

package/lib/instance-id/index.js

@@ -0,0 +1,18 @@
+/*! firebase-admin v9.12.0 */
+"use strict";
+/*!
+ * Copyright 2020 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 });

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

@@ -0,0 +1,87 @@
+/*! firebase-admin v9.12.0 */
+"use strict";
+/*!
+ * Copyright 2020 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.InstanceId = void 0;
+var error_1 = require("../utils/error");
+var validator = require("../utils/validator");
+/**
+ * Gets the {@link InstanceId `InstanceId`} service for the
+ * current app.
+ *
+ * @example
+ * ```javascript
+ * var instanceId = app.instanceId();
+ * // The above is shorthand for:
+ * // var instanceId = admin.instanceId(app);
+ * ```
+ *
+ * @return The `InstanceId` service for the
+ *   current app.
+ */
+var InstanceId = /** @class */ (function () {
+    /**
+     * @param app The app for this InstanceId service.
+     * @constructor
+     */
+    function InstanceId(app) {
+        if (!validator.isNonNullObject(app) || !('options' in app)) {
+            throw new error_1.FirebaseInstanceIdError(error_1.InstanceIdClientErrorCode.INVALID_ARGUMENT, 'First argument passed to admin.instanceId() must be a valid Firebase app instance.');
+        }
+        this.app_ = app;
+    }
+    /**
+     * Deletes the specified instance ID and the associated data from Firebase.
+     *
+     * Note that Google Analytics for Firebase uses its own form of Instance ID to
+     * keep track of analytics data. Therefore deleting a Firebase Instance ID does
+     * not delete Analytics data. See
+     * [Delete an Instance ID](/support/privacy/manage-iids#delete_an_instance_id)
+     * for more information.
+     *
+     * @param instanceId The instance ID to be deleted.
+     *
+     * @return A promise fulfilled when the instance ID is deleted.
+     */
+    InstanceId.prototype.deleteInstanceId = function (instanceId) {
+        return this.app.installations().deleteInstallation(instanceId)
+            .catch(function (err) {
+            if (err instanceof error_1.FirebaseInstallationsError) {
+                var code = err.code.replace('installations/', '');
+                if (code === error_1.InstallationsClientErrorCode.INVALID_INSTALLATION_ID.code) {
+                    code = error_1.InstanceIdClientErrorCode.INVALID_INSTANCE_ID.code;
+                }
+                throw new error_1.FirebaseInstanceIdError({ code: code, message: err.message });
+            }
+            throw err;
+        });
+    };
+    Object.defineProperty(InstanceId.prototype, "app", {
+        /**
+         * Returns the app associated with this InstanceId instance.
+         *
+         * @return The app associated with this InstanceId instance.
+         */
+        get: function () {
+            return this.app_;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return InstanceId;
+}());
+exports.InstanceId = InstanceId;