firebase-admin 9.12.0 → 10.0.0

package/lib/app-check/app-check-api-client-internal.d.ts

@@ -0,0 +1,32 @@
+/*! firebase-admin v10.0.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.
+ */
+import { PrefixedFirebaseError } from '../utils/error';
+export declare const APP_CHECK_ERROR_CODE_MAPPING: {
+    [key: string]: AppCheckErrorCode;
+};
+export declare type AppCheckErrorCode = 'aborted' | 'invalid-argument' | 'invalid-credential' | 'internal-error' | 'permission-denied' | 'unauthenticated' | 'not-found' | 'app-check-token-expired' | 'unknown-error';
+/**
+ * Firebase App Check error code structure. This extends PrefixedFirebaseError.
+ *
+ * @param code - The error code.
+ * @param message - The error message.
+ * @constructor
+ */
+export declare class FirebaseAppCheckError extends PrefixedFirebaseError {
+    constructor(code: AppCheckErrorCode, message: string);
+}

package/lib/app-check/app-check-api-client-internal.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.12.0 */
+/*! firebase-admin v10.0.0 */
 "use strict";
 /*!
  * @license
@@ -56,9 +56,9 @@ var AppCheckApiClient = /** @class */ (function () {
     /**
      * Exchange a signed custom token to App Check token
      *
-     * @param customToken The custom token to be exchanged.
-     * @param appId The mobile App ID.
-     * @return A promise that fulfills with a `AppCheckToken`.
+     * @param customToken - The custom token to be exchanged.
+     * @param appId - The mobile App ID.
+     * @returns A promise that fulfills with a `AppCheckToken`.
      */
     AppCheckApiClient.prototype.exchangeToken = function (customToken, appId) {
         var _this = this;
@@ -131,8 +131,8 @@ var AppCheckApiClient = /** @class */ (function () {
     /**
      * Creates an AppCheckToken from the API response.
      *
-     * @param resp API response object.
-     * @return An AppCheckToken instance.
+     * @param resp - API response object.
+     * @returns An AppCheckToken instance.
      */
     AppCheckApiClient.prototype.toAppCheckToken = function (resp) {
         var token = resp.data.attestationToken;
@@ -147,12 +147,12 @@ var AppCheckApiClient = /** @class */ (function () {
     /**
      * Converts a duration string with the suffix `s` to milliseconds.
      *
-     * @param duration The duration as a string with the suffix "s" preceded by the
+     * @param duration - The duration as a string with the suffix "s" preceded by the
      * number of seconds, with fractional seconds. For example, 3 seconds with 0 nanoseconds
      * is expressed as "3s", while 3 seconds and 1 nanosecond is expressed as "3.000000001s",
      * and 3 seconds and 1 microsecond is expressed as "3.000001s".
      *
-     * @return The duration in milliseconds.
+     * @returns The duration in milliseconds.
      */
     AppCheckApiClient.prototype.stringToMilliseconds = function (duration) {
         if (!validator.isNonEmptyString(duration) || !duration.endsWith('s')) {
@@ -177,8 +177,8 @@ exports.APP_CHECK_ERROR_CODE_MAPPING = {
 /**
  * Firebase App Check error code structure. This extends PrefixedFirebaseError.
  *
- * @param {AppCheckErrorCode} code The error code.
- * @param {string} message The error message.
+ * @param code - The error code.
+ * @param message - The error message.
  * @constructor
  */
 var FirebaseAppCheckError = /** @class */ (function (_super) {

package/lib/app-check/app-check-api.d.ts

@@ -0,0 +1,95 @@
+/*! firebase-admin v10.0.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.
+ */
+/**
+ * Interface representing an App Check token.
+ */
+export interface AppCheckToken {
+    /**
+     * The Firebase App Check token.
+     */
+    token: string;
+    /**
+     * The time-to-live duration of the token in milliseconds.
+     */
+    ttlMillis: number;
+}
+/**
+ * Interface representing App Check token options.
+ */
+export interface AppCheckTokenOptions {
+    /**
+     * The length of time, in milliseconds, for which the App Check token will
+     * be valid. This value must be between 30 minutes and 7 days, inclusive.
+     */
+    ttlMillis?: number;
+}
+/**
+ * Interface representing a decoded Firebase App Check token, returned from the
+ * {@link AppCheck.verifyToken} method.
+ */
+export interface DecodedAppCheckToken {
+    /**
+     * The issuer identifier for the issuer of the response.
+     * This value is a URL with the format
+     * `https://firebaseappcheck.googleapis.com/<PROJECT_NUMBER>`, where `<PROJECT_NUMBER>` is the
+     * same project number specified in the {@link DecodedAppCheckToken.aud | aud} property.
+     */
+    iss: string;
+    /**
+     * The Firebase App ID corresponding to the app the token belonged to.
+     * As a convenience, this value is copied over to the {@link DecodedAppCheckToken.app_id | app_id} property.
+     */
+    sub: string;
+    /**
+     * The audience for which this token is intended.
+     * This value is a JSON array of two strings, the first is the project number of your
+     * Firebase project, and the second is the project ID of the same project.
+     */
+    aud: string[];
+    /**
+     * The App Check token's expiration time, in seconds since the Unix epoch. That is, the
+     * time at which this App Check token expires and should no longer be considered valid.
+     */
+    exp: number;
+    /**
+     * The App Check token's issued-at time, in seconds since the Unix epoch. That is, the
+     * time at which this App Check token was issued and should start to be considered
+     * valid.
+     */
+    iat: number;
+    /**
+     * The App ID corresponding to the App the App Check token belonged to.
+     * This value is not actually one of the JWT token claims. It is added as a
+     * convenience, and is set as the value of the {@link DecodedAppCheckToken.sub | sub} property.
+     */
+    app_id: string;
+    [key: string]: any;
+}
+/**
+ * Interface representing a verified App Check token response.
+ */
+export interface VerifyAppCheckTokenResponse {
+    /**
+     * The App ID corresponding to the App the App Check token belonged to.
+     */
+    appId: string;
+    /**
+     * The decoded Firebase App Check token.
+     */
+    token: DecodedAppCheckToken;
+}

package/lib/app-check/app-check-api.js

@@ -0,0 +1,19 @@
+/*! firebase-admin v10.0.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 });

package/lib/app-check/app-check-namespace.d.ts

@@ -0,0 +1,65 @@
+/*! firebase-admin v10.0.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 '../app';
+import { AppCheckToken as TAppCheckToken, AppCheckTokenOptions as TAppCheckTokenOptions, DecodedAppCheckToken as TDecodedAppCheckToken, VerifyAppCheckTokenResponse as TVerifyAppCheckTokenResponse } from './app-check-api';
+import { AppCheck as TAppCheck } from './app-check';
+/**
+ * Gets the {@link firebase-admin.app-check#AppCheck} service for the default app or a given app.
+ *
+ * `admin.appCheck()` can be called with no arguments to access the default
+ * app's `AppCheck` service or as `admin.appCheck(app)` to access the
+ * `AppCheck` service associated with a specific app.
+ *
+ * @example
+ * ```javascript
+ * // Get the `AppCheck` service for the default app
+ * var defaultAppCheck = admin.appCheck();
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Get the `AppCheck` service for a given app
+ * var otherAppCheck = admin.appCheck(otherApp);
+ * ```
+ *
+ * @param app - Optional app for which to return the `AppCheck` service.
+ *   If not provided, the default `AppCheck` service is returned.
+ *
+ * @returns The default `AppCheck` service if no
+ *   app is provided, or the `AppCheck` service associated with the provided
+ *   app.
+ */
+export declare function appCheck(app?: App): appCheck.AppCheck;
+export declare namespace appCheck {
+    /**
+     * Type alias to {@link firebase-admin.app-check#AppCheck}.
+     */
+    type AppCheck = TAppCheck;
+    /**
+     * Type alias to {@link firebase-admin.app-check#AppCheckToken}.
+     */
+    type AppCheckToken = TAppCheckToken;
+    /**
+     * Type alias to {@link firebase-admin.app-check#DecodedAppCheckToken}.
+     */
+    type DecodedAppCheckToken = TDecodedAppCheckToken;
+    /**
+     * Type alias to {@link firebase-admin.app-check#VerifyAppCheckTokenResponse}.
+     */
+    type VerifyAppCheckTokenResponse = TVerifyAppCheckTokenResponse;
+    type AppCheckTokenOptions = TAppCheckTokenOptions;
+}

package/lib/app-check/app-check-namespace.js

@@ -0,0 +1,18 @@
+/*! firebase-admin v10.0.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/app-check/app-check.d.ts

@@ -0,0 +1,49 @@
+/*! firebase-admin v10.0.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.
+ */
+import { App } from '../app';
+import { AppCheckToken, AppCheckTokenOptions, VerifyAppCheckTokenResponse } from './app-check-api';
+/**
+ * The Firebase `AppCheck` service interface.
+ */
+export declare class AppCheck {
+    readonly app: App;
+    private readonly client;
+    private readonly tokenGenerator;
+    private readonly appCheckTokenVerifier;
+    /**
+     * Creates a new {@link AppCheckToken} that can be sent
+     * back to a client.
+     *
+     * @param appId - The app ID to use as the JWT app_id.
+     * @param options - Optional options object when creating a new App Check Token.
+     *
+     * @returns A promise that fulfills with a `AppCheckToken`.
+     */
+    createToken(appId: string, options?: AppCheckTokenOptions): Promise<AppCheckToken>;
+    /**
+     * Verifies a Firebase App Check token (JWT). If the token is valid, the promise is
+     * fulfilled with the token's decoded claims; otherwise, the promise is
+     * rejected.
+     *
+     * @param appCheckToken - The App Check token to verify.
+     *
+     * @returns A promise fulfilled with the token's decoded claims
+     *   if the App Check token is valid; otherwise, a rejected promise.
+     */
+    verifyToken(appCheckToken: string): Promise<VerifyAppCheckTokenResponse>;
+}

package/lib/app-check/app-check.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.12.0 */
+/*! firebase-admin v10.0.0 */
 "use strict";
 /*!
  * @license
@@ -23,12 +23,13 @@ var token_generator_1 = require("./token-generator");
 var token_verifier_1 = require("./token-verifier");
 var crypto_signer_1 = require("../utils/crypto-signer");
 /**
- * AppCheck service bound to the provided app.
+ * The Firebase `AppCheck` service interface.
  */
 var AppCheck = /** @class */ (function () {
     /**
-     * @param app The app for this AppCheck service.
+     * @param app - The app for this AppCheck service.
      * @constructor
+     * @internal
      */
     function AppCheck(app) {
         this.app = app;
@@ -42,11 +43,11 @@ var AppCheck = /** @class */ (function () {
         this.appCheckTokenVerifier = new token_verifier_1.AppCheckTokenVerifier(app);
     }
     /**
-     * Creates a new {@link appCheck.AppCheckToken `AppCheckToken`} that can be sent
+     * Creates a new {@link AppCheckToken} that can be sent
      * back to a client.
      *
-     * @param appId The app ID to use as the JWT app_id.
-     * @param options Optional options object when creating a new App Check Token.
+     * @param appId - The app ID to use as the JWT app_id.
+     * @param options - Optional options object when creating a new App Check Token.
      *
      * @returns A promise that fulfills with a `AppCheckToken`.
      */
@@ -58,12 +59,14 @@ var AppCheck = /** @class */ (function () {
         });
     };
     /**
-     * Verifies an App Check token.
+     * Verifies a Firebase App Check token (JWT). If the token is valid, the promise is
+     * fulfilled with the token's decoded claims; otherwise, the promise is
+     * rejected.
      *
-     * @param appCheckToken The App Check token to verify.
+     * @param appCheckToken - The App Check token to verify.
      *
-     * @return A promise that fulfills with a `VerifyAppCheckTokenResponse` on successful
-     *     verification.
+     * @returns A promise fulfilled with the token's decoded claims
+     *   if the App Check token is valid; otherwise, a rejected promise.
      */
     AppCheck.prototype.verifyToken = function (appCheckToken) {
         return this.appCheckTokenVerifier.verifyToken(appCheckToken)

package/lib/app-check/index.d.ts

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.12.0 */
+/*! firebase-admin v10.0.0 */
 /*!
  * @license
  * Copyright 2021 Google Inc.
@@ -15,146 +15,39 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { app } from '../firebase-namespace-api';
 /**
- * Gets the {@link appCheck.AppCheck `AppCheck`} service for the
- * default app or a given app.
+ * Firebase App Check.
  *
- * You can call `admin.appCheck()` with no arguments to access the default
- * app's {@link appCheck.AppCheck `AppCheck`} service or as
- * `admin.appCheck(app)` to access the
- * {@link appCheck.AppCheck `AppCheck`} service associated with a
- * specific app.
+ * @packageDocumentation
+ */
+import { App } from '../app';
+import { AppCheck } from './app-check';
+export { AppCheckToken, AppCheckTokenOptions, DecodedAppCheckToken, VerifyAppCheckTokenResponse, } from './app-check-api';
+export { AppCheck } from './app-check';
+/**
+ * Gets the {@link AppCheck} service for the default app or a given app.
+ *
+ * `getAppCheck()` can be called with no arguments to access the default
+ * app's `AppCheck` service or as `getAppCheck(app)` to access the
+ * `AppCheck` service associated with a specific app.
  *
  * @example
  * ```javascript
  * // Get the `AppCheck` service for the default app
- * var defaultAppCheck = admin.appCheck();
+ * const defaultAppCheck = getAppCheck();
  * ```
  *
  * @example
  * ```javascript
  * // Get the `AppCheck` service for a given app
- * var otherAppCheck = admin.appCheck(otherApp);
+ * const otherAppCheck = getAppCheck(otherApp);
  * ```
  *
- * @param app Optional app for which to return the `AppCheck` service.
+ * @param app - Optional app for which to return the `AppCheck` service.
  *   If not provided, the default `AppCheck` service is returned.
  *
- * @return The default `AppCheck` service if no
+ * @returns The default `AppCheck` service if no
  *   app is provided, or the `AppCheck` service associated with the provided
  *   app.
  */
-export declare function appCheck(app?: app.App): appCheck.AppCheck;
-export declare namespace appCheck {
-    /**
-     * The Firebase `AppCheck` service interface.
-     */
-    interface AppCheck {
-        app: app.App;
-        /**
-         * Creates a new {@link appCheck.AppCheckToken `AppCheckToken`} that can be sent
-         * back to a client.
-         *
-         * @param appId The App ID of the Firebase App the token belongs to.
-         * @param options Optional options object when creating a new App Check Token.
-         *
-         * @returns A promise that fulfills with a `AppCheckToken`.
-         */
-        createToken(appId: string, options?: AppCheckTokenOptions): Promise<AppCheckToken>;
-        /**
-         * Verifies a Firebase App Check token (JWT). If the token is valid, the promise is
-         * fulfilled with the token's decoded claims; otherwise, the promise is
-         * rejected.
-         *
-         * @param appCheckToken The App Check token to verify.
-         *
-         * @return A promise fulfilled with the
-         *   token's decoded claims if the App Check token is valid; otherwise, a rejected
-         *   promise.
-         */
-        verifyToken(appCheckToken: string): Promise<VerifyAppCheckTokenResponse>;
-    }
-    /**
-     * Interface representing an App Check token.
-     */
-    interface AppCheckToken {
-        /**
-         * The Firebase App Check token.
-         */
-        token: string;
-        /**
-         * The time-to-live duration of the token in milliseconds.
-         */
-        ttlMillis: number;
-    }
-    /**
-     * Interface representing App Check token options.
-     */
-    interface AppCheckTokenOptions {
-        /**
-         * The length of time, in milliseconds, for which the App Check token will
-         * be valid. This value must be between 30 minutes and 7 days, inclusive.
-         */
-        ttlMillis?: number;
-    }
-    /**
-     * Interface representing a decoded Firebase App Check token, returned from the
-     * {@link appCheck.AppCheck.verifyToken `verifyToken()`} method.
-     */
-    interface DecodedAppCheckToken {
-        /**
-         * The issuer identifier for the issuer of the response.
-         *
-         * This value is a URL with the format
-         * `https://firebaseappcheck.googleapis.com/<PROJECT_NUMBER>`, where `<PROJECT_NUMBER>` is the
-         * same project number specified in the [`aud`](#aud) property.
-         */
-        iss: string;
-        /**
-         * The Firebase App ID corresponding to the app the token belonged to.
-         *
-         * As a convenience, this value is copied over to the [`app_id`](#app_id) property.
-         */
-        sub: string;
-        /**
-         * The audience for which this token is intended.
-         *
-         * This value is a JSON array of two strings, the first is the project number of your
-         * Firebase project, and the second is the project ID of the same project.
-         */
-        aud: string[];
-        /**
-         * The App Check token's expiration time, in seconds since the Unix epoch. That is, the
-         * time at which this App Check token expires and should no longer be considered valid.
-         */
-        exp: number;
-        /**
-         * The App Check token's issued-at time, in seconds since the Unix epoch. That is, the
-         * time at which this App Check token was issued and should start to be considered
-         * valid.
-         */
-        iat: number;
-        /**
-         * The App ID corresponding to the App the App Check token belonged to.
-         *
-         * This value is not actually one of the JWT token claims. It is added as a
-         * convenience, and is set as the value of the [`sub`](#sub) property.
-         */
-        app_id: string;
-        [key: string]: any;
-    }
-    /**
-     * Interface representing a verified App Check token response.
-     */
-    interface VerifyAppCheckTokenResponse {
-        /**
-         * The App ID corresponding to the App the App Check token belonged to.
-         */
-        appId: string;
-        /**
-         * The decoded Firebase App Check token.
-         */
-        token: appCheck.DecodedAppCheckToken;
-    }
-}
+export declare function getAppCheck(app?: App): AppCheck;

package/lib/app-check/index.js

@@ -1,4 +1,4 @@
-/*! firebase-admin v9.12.0 */
+/*! firebase-admin v10.0.0 */
 "use strict";
 /*!
  * @license
@@ -17,3 +17,47 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAppCheck = void 0;
+/**
+ * Firebase App Check.
+ *
+ * @packageDocumentation
+ */
+var app_1 = require("../app");
+var app_check_1 = require("./app-check");
+var app_check_2 = require("./app-check");
+Object.defineProperty(exports, "AppCheck", { enumerable: true, get: function () { return app_check_2.AppCheck; } });
+/**
+ * Gets the {@link AppCheck} service for the default app or a given app.
+ *
+ * `getAppCheck()` can be called with no arguments to access the default
+ * app's `AppCheck` service or as `getAppCheck(app)` to access the
+ * `AppCheck` service associated with a specific app.
+ *
+ * @example
+ * ```javascript
+ * // Get the `AppCheck` service for the default app
+ * const defaultAppCheck = getAppCheck();
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Get the `AppCheck` service for a given app
+ * const otherAppCheck = getAppCheck(otherApp);
+ * ```
+ *
+ * @param app - Optional app for which to return the `AppCheck` service.
+ *   If not provided, the default `AppCheck` service is returned.
+ *
+ * @returns The default `AppCheck` service if no
+ *   app is provided, or the `AppCheck` service associated with the provided
+ *   app.
+ */
+function getAppCheck(app) {
+    if (typeof app === 'undefined') {
+        app = app_1.getApp();
+    }
+    var firebaseApp = app;
+    return firebaseApp.getOrInitService('appCheck', function (app) { return new app_check_1.AppCheck(app); });
+}
+exports.getAppCheck = getAppCheck;

package/lib/app-check/token-generator.d.ts

@@ -0,0 +1,25 @@
+/*! firebase-admin v10.0.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.
+ */
+/**
+ * Creates a new `FirebaseAppCheckError` by extracting the error code, message and other relevant
+ * details from a `CryptoSignerError`.
+ *
+ * @param err - The Error to convert into a `FirebaseAppCheckError` error
+ * @returns A Firebase App Check error that can be returned to the user.
+ */
+export declare function appCheckErrorFromCryptoSignerError(err: Error): Error;