Initial commit

2021-12-29 01:57:42 -08:00
commit ce39a60b42
4634 changed files with 997667 additions and 0 deletions
@@ -0,0 +1,61 @@
+/*! firebase-admin v10.0.1 */
+/*!
+ * 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.
+ */
+/**
+ * Firebase Instance ID service.
+ *
+ * @packageDocumentation
+ */
+import { App } from '../app/index';
+import { InstanceId } from './instance-id';
+export { InstanceId };
+/**
+ * Gets the {@link InstanceId} service for the default app or a given app.
+ *
+ * This API is deprecated. Developers are advised to use the
+ * {@link firebase-admin.installations#getInstallations}
+ * API to delete their instance IDs and Firebase installation IDs.
+ *
+ * `getInstanceId()` can be called with no arguments to access the default
+ * app's `InstanceId` service or as `getInstanceId(app)` to access the
+ * `InstanceId` service associated with a specific app.
+ *
+ * @example
+ * ```javascript
+ * // Get the Instance ID service for the default app
+ * const defaultInstanceId = getInstanceId();
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Get the Instance ID service for a given app
+ * const otherInstanceId = getInstanceId(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.
+ *
+ * @returns The default `InstanceId` service if
+ *   no app is provided or the `InstanceId` service associated with the
+ *   provided app.
+ *
+ * @deprecated Use {@link firebase-admin.installations#getInstallations} instead.
+ */
+export declare function getInstanceId(app?: App): InstanceId;
@@ -0,0 +1,71 @@
+/*! firebase-admin v10.0.1 */
+"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.getInstanceId = exports.InstanceId = void 0;
+/**
+ * Firebase Instance ID service.
+ *
+ * @packageDocumentation
+ */
+var index_1 = require("../app/index");
+var instance_id_1 = require("./instance-id");
+Object.defineProperty(exports, "InstanceId", { enumerable: true, get: function () { return instance_id_1.InstanceId; } });
+/**
+ * Gets the {@link InstanceId} service for the default app or a given app.
+ *
+ * This API is deprecated. Developers are advised to use the
+ * {@link firebase-admin.installations#getInstallations}
+ * API to delete their instance IDs and Firebase installation IDs.
+ *
+ * `getInstanceId()` can be called with no arguments to access the default
+ * app's `InstanceId` service or as `getInstanceId(app)` to access the
+ * `InstanceId` service associated with a specific app.
+ *
+ * @example
+ * ```javascript
+ * // Get the Instance ID service for the default app
+ * const defaultInstanceId = getInstanceId();
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Get the Instance ID service for a given app
+ * const otherInstanceId = getInstanceId(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.
+ *
+ * @returns The default `InstanceId` service if
+ *   no app is provided or the `InstanceId` service associated with the
+ *   provided app.
+ *
+ * @deprecated Use {@link firebase-admin.installations#getInstallations} instead.
+ */
+function getInstanceId(app) {
+    if (typeof app === 'undefined') {
+        app = index_1.getApp();
+    }
+    var firebaseApp = app;
+    return firebaseApp.getOrInitService('instanceId', function (app) { return new instance_id_1.InstanceId(app); });
+}
+exports.getInstanceId = getInstanceId;
@@ -0,0 +1,38 @@
+/*! firebase-admin v10.0.1 */
+import { App } from '../app/index';
+import { InstanceId as TInstanceId } from './instance-id';
+/**
+ * Gets the {@link firebase-admin.instance-id#InstanceId} service for the
+ * default app or a given app.
+ *
+ * `admin.instanceId()` can be called with no arguments to access the default
+ * app's `InstanceId` service or as `admin.instanceId(app)` to access the
+ * `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);
+ *```
+ *
+ * @param app - Optional app whose `InstanceId` service to
+ *   return. If not provided, the default `InstanceId` service will be
+ *   returned.
+ *
+ * @returns The default `InstanceId` service if
+ *   no app is provided or the `InstanceId` service associated with the
+ *   provided app.
+ */
+export declare function instanceId(app?: App): instanceId.InstanceId;
+export declare namespace instanceId {
+    /**
+     * Type alias to {@link firebase-admin.instance-id#InstanceId}.
+     */
+    type InstanceId = TInstanceId;
+}
@@ -0,0 +1,3 @@
+/*! firebase-admin v10.0.1 */
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,47 @@
+/*! firebase-admin v10.0.1 */
+/*!
+ * 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 '../app/index';
+/**
+ * The `InstanceId` service enables deleting the Firebase instance IDs
+ * associated with Firebase client app instances.
+ *
+ * @deprecated Use {@link firebase-admin.installations#Installations} instead.
+ */
+export declare class InstanceId {
+    private 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
+     * {@link https://firebase.google.com/support/privacy/manage-iids#delete_an_instance_id |
+     * Delete an Instance ID}
+     * for more information.
+     *
+     * @param instanceId - The instance ID to be deleted.
+     *
+     * @returns A promise fulfilled when the instance ID is deleted.
+     */
+    deleteInstanceId(instanceId: string): Promise<void>;
+    /**
+     * Returns the app associated with this InstanceId instance.
+     *
+     * @returns The app associated with this InstanceId instance.
+     */
+    get app(): App;
+}
@@ -0,0 +1,82 @@
+/*! firebase-admin v10.0.1 */
+"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 installations_1 = require("../installations");
+var error_1 = require("../utils/error");
+var validator = require("../utils/validator");
+/**
+ * The `InstanceId` service enables deleting the Firebase instance IDs
+ * associated with Firebase client app instances.
+ *
+ * @deprecated Use {@link firebase-admin.installations#Installations} instead.
+ */
+var InstanceId = /** @class */ (function () {
+    /**
+     * @param app - The app for this InstanceId service.
+     * @constructor
+     * @internal
+     */
+    function InstanceId(app) {
+        if (!validator.isNonNullObject(app) || !('options' in app)) {
+            throw new error_1.FirebaseInstanceIdError(error_1.InstanceIdClientErrorCode.INVALID_ARGUMENT, 'First argument passed to 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
+     * {@link https://firebase.google.com/support/privacy/manage-iids#delete_an_instance_id |
+     * Delete an Instance ID}
+     * for more information.
+     *
+     * @param instanceId - The instance ID to be deleted.
+     *
+     * @returns A promise fulfilled when the instance ID is deleted.
+     */
+    InstanceId.prototype.deleteInstanceId = function (instanceId) {
+        return installations_1.getInstallations(this.app).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.
+         *
+         * @returns The app associated with this InstanceId instance.
+         */
+        get: function () {
+            return this.app_;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return InstanceId;
+}());
+exports.InstanceId = InstanceId;