@firebase/app-check 0.5.8 → 0.5.9-canary.ebc17e27f

package/dist/app-check.d.ts

@@ -1,266 +1,266 @@
-/**
- * Firebase App Check
- *
- * @packageDocumentation
- */
-
-import { FirebaseApp } from '@firebase/app';
-import { PartialObserver } from '@firebase/util';
-import { Unsubscribe } from '@firebase/util';
-
-/**
- * The Firebase App Check service interface.
- *
- * @public
- */
-export declare interface AppCheck {
-    /**
-     * The {@link @firebase/app#FirebaseApp} this `AppCheck` instance is associated with.
-     */
-    app: FirebaseApp;
-}
-
-/**
- * @internal
- */
-export declare type _AppCheckComponentName = 'app-check';
-
-/**
- * @internal
- */
-export declare type _AppCheckInternalComponentName = 'app-check-internal';
-
-/**
- * Options for App Check initialization.
- * @public
- */
-export declare interface AppCheckOptions {
-    /**
-     * A reCAPTCHA V3 provider, reCAPTCHA Enterprise provider, or custom provider.
-     */
-    provider: CustomProvider | ReCaptchaV3Provider | ReCaptchaEnterpriseProvider;
-    /**
-     * If set to true, enables automatic background refresh of App Check token.
-     */
-    isTokenAutoRefreshEnabled?: boolean;
-}
-
-declare interface AppCheckProvider {
-    /**
-     * Returns an App Check token.
-     * @internal
-     */
-    getToken: () => Promise<AppCheckTokenInternal>;
-    /**
-     * @internal
-     */
-    initialize(app: FirebaseApp): void;
-}
-
-/**
- * The token returned from an App Check provider.
- * @public
- */
-export declare interface AppCheckToken {
-    readonly token: string;
-    /**
-     * The local timestamp after which the token will expire.
-     */
-    readonly expireTimeMillis: number;
-}
-
-declare interface AppCheckTokenInternal extends AppCheckToken {
-    issuedAtTimeMillis: number;
-}
-
-/**
- * A listener that is called whenever the App Check token changes.
- * @public
- */
-export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;
-
-/**
- * Result returned by `getToken()`.
- * @public
- */
-export declare interface AppCheckTokenResult {
-    /**
-     * The token string in JWT format.
-     */
-    readonly token: string;
-}
-
-/**
- * Custom provider class.
- * @public
- */
-export declare class CustomProvider implements AppCheckProvider {
-    private _customProviderOptions;
-    private _app?;
-    constructor(_customProviderOptions: CustomProviderOptions);
-    /**
-     * @internal
-     */
-    getToken(): Promise<AppCheckTokenInternal>;
-    /**
-     * @internal
-     */
-    initialize(app: FirebaseApp): void;
-    /**
-     * @internal
-     */
-    isEqual(otherProvider: unknown): boolean;
-}
-
-/**
- * Options when creating a {@link CustomProvider}.
- * @public
- */
-export declare interface CustomProviderOptions {
-    /**
-     * Function to get an App Check token through a custom provider
-     * service.
-     */
-    getToken: () => Promise<AppCheckToken>;
-}
-
-/**
- * Get the current App Check token. Attaches to the most recent
- * in-flight request if one is present. Returns null if no token
- * is present and no token requests are in-flight.
- *
- * @param appCheckInstance - The App Check service instance.
- * @param forceRefresh - If true, will always try to fetch a fresh token.
- * If false, will use a cached token if found in storage.
- * @public
- */
-export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
-
-/**
- * Activate App Check for the given app. Can be called only once per app.
- * @param app - the {@link @firebase/app#FirebaseApp} to activate App Check for
- * @param options - App Check initialization options
- * @public
- */
-export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
-
-/**
- * Registers a listener to changes in the token state. There can be more
- * than one listener registered at the same time for one or more
- * App Check instances. The listeners call back on the UI thread whenever
- * the current token associated with this App Check instance changes.
- *
- * @param appCheckInstance - The App Check service instance.
- * @param observer - An object with `next`, `error`, and `complete`
- * properties. `next` is called with an
- * {@link AppCheckTokenResult}
- * whenever the token changes. `error` is optional and is called if an
- * error is thrown by the listener (the `next` function). `complete`
- * is unused, as the token stream is unending.
- *
- * @returns A function that unsubscribes this listener.
- * @public
- */
-export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;
-
-/**
- * Registers a listener to changes in the token state. There can be more
- * than one listener registered at the same time for one or more
- * App Check instances. The listeners call back on the UI thread whenever
- * the current token associated with this App Check instance changes.
- *
- * @param appCheckInstance - The App Check service instance.
- * @param onNext - When the token changes, this function is called with aa
- * {@link AppCheckTokenResult}.
- * @param onError - Optional. Called if there is an error thrown by the
- * listener (the `onNext` function).
- * @param onCompletion - Currently unused, as the token stream is unending.
- * @returns A function that unsubscribes this listener.
- * @public
- */
-export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;
-export { PartialObserver }
-
-/**
- * App Check provider that can obtain a reCAPTCHA Enterprise token and exchange it
- * for an App Check token.
- *
- * @public
- */
-export declare class ReCaptchaEnterpriseProvider implements AppCheckProvider {
-    private _siteKey;
-    private _app?;
-    private _heartbeatServiceProvider?;
-    /**
-     * Throttle requests on certain error codes to prevent too many retries
-     * in a short time.
-     */
-    private _throttleData;
-    /**
-     * Create a ReCaptchaEnterpriseProvider instance.
-     * @param siteKey - reCAPTCHA Enterprise score-based site key.
-     */
-    constructor(_siteKey: string);
-    /**
-     * Returns an App Check token.
-     * @internal
-     */
-    getToken(): Promise<AppCheckTokenInternal>;
-    /**
-     * @internal
-     */
-    initialize(app: FirebaseApp): void;
-    /**
-     * @internal
-     */
-    isEqual(otherProvider: unknown): boolean;
-}
-
-/**
- * App Check provider that can obtain a reCAPTCHA V3 token and exchange it
- * for an App Check token.
- *
- * @public
- */
-export declare class ReCaptchaV3Provider implements AppCheckProvider {
-    private _siteKey;
-    private _app?;
-    private _heartbeatServiceProvider?;
-    /**
-     * Throttle requests on certain error codes to prevent too many retries
-     * in a short time.
-     */
-    private _throttleData;
-    /**
-     * Create a ReCaptchaV3Provider instance.
-     * @param siteKey - ReCAPTCHA V3 siteKey.
-     */
-    constructor(_siteKey: string);
-    /**
-     * Returns an App Check token.
-     * @internal
-     */
-    getToken(): Promise<AppCheckTokenInternal>;
-    /**
-     * @internal
-     */
-    initialize(app: FirebaseApp): void;
-    /**
-     * @internal
-     */
-    isEqual(otherProvider: unknown): boolean;
-}
-
-/**
- * Set whether App Check will automatically refresh tokens as needed.
- *
- * @param appCheckInstance - The App Check service instance.
- * @param isTokenAutoRefreshEnabled - If true, the SDK automatically
- * refreshes App Check tokens as needed. This overrides any value set
- * during `initializeAppCheck()`.
- * @public
- */
-export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
-export { Unsubscribe }
-
-export { }
+/**
+ * Firebase App Check
+ *
+ * @packageDocumentation
+ */
+
+import { FirebaseApp } from '@firebase/app';
+import { PartialObserver } from '@firebase/util';
+import { Unsubscribe } from '@firebase/util';
+
+/**
+ * The Firebase App Check service interface.
+ *
+ * @public
+ */
+export declare interface AppCheck {
+    /**
+     * The {@link @firebase/app#FirebaseApp} this `AppCheck` instance is associated with.
+     */
+    app: FirebaseApp;
+}
+
+/**
+ * @internal
+ */
+export declare type _AppCheckComponentName = 'app-check';
+
+/**
+ * @internal
+ */
+export declare type _AppCheckInternalComponentName = 'app-check-internal';
+
+/**
+ * Options for App Check initialization.
+ * @public
+ */
+export declare interface AppCheckOptions {
+    /**
+     * A reCAPTCHA V3 provider, reCAPTCHA Enterprise provider, or custom provider.
+     */
+    provider: CustomProvider | ReCaptchaV3Provider | ReCaptchaEnterpriseProvider;
+    /**
+     * If set to true, enables automatic background refresh of App Check token.
+     */
+    isTokenAutoRefreshEnabled?: boolean;
+}
+
+declare interface AppCheckProvider {
+    /**
+     * Returns an App Check token.
+     * @internal
+     */
+    getToken: () => Promise<AppCheckTokenInternal>;
+    /**
+     * @internal
+     */
+    initialize(app: FirebaseApp): void;
+}
+
+/**
+ * The token returned from an App Check provider.
+ * @public
+ */
+export declare interface AppCheckToken {
+    readonly token: string;
+    /**
+     * The local timestamp after which the token will expire.
+     */
+    readonly expireTimeMillis: number;
+}
+
+declare interface AppCheckTokenInternal extends AppCheckToken {
+    issuedAtTimeMillis: number;
+}
+
+/**
+ * A listener that is called whenever the App Check token changes.
+ * @public
+ */
+export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;
+
+/**
+ * Result returned by `getToken()`.
+ * @public
+ */
+export declare interface AppCheckTokenResult {
+    /**
+     * The token string in JWT format.
+     */
+    readonly token: string;
+}
+
+/**
+ * Custom provider class.
+ * @public
+ */
+export declare class CustomProvider implements AppCheckProvider {
+    private _customProviderOptions;
+    private _app?;
+    constructor(_customProviderOptions: CustomProviderOptions);
+    /**
+     * @internal
+     */
+    getToken(): Promise<AppCheckTokenInternal>;
+    /**
+     * @internal
+     */
+    initialize(app: FirebaseApp): void;
+    /**
+     * @internal
+     */
+    isEqual(otherProvider: unknown): boolean;
+}
+
+/**
+ * Options when creating a {@link CustomProvider}.
+ * @public
+ */
+export declare interface CustomProviderOptions {
+    /**
+     * Function to get an App Check token through a custom provider
+     * service.
+     */
+    getToken: () => Promise<AppCheckToken>;
+}
+
+/**
+ * Get the current App Check token. Attaches to the most recent
+ * in-flight request if one is present. Returns null if no token
+ * is present and no token requests are in-flight.
+ *
+ * @param appCheckInstance - The App Check service instance.
+ * @param forceRefresh - If true, will always try to fetch a fresh token.
+ * If false, will use a cached token if found in storage.
+ * @public
+ */
+export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
+
+/**
+ * Activate App Check for the given app. Can be called only once per app.
+ * @param app - the {@link @firebase/app#FirebaseApp} to activate App Check for
+ * @param options - App Check initialization options
+ * @public
+ */
+export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
+
+/**
+ * Registers a listener to changes in the token state. There can be more
+ * than one listener registered at the same time for one or more
+ * App Check instances. The listeners call back on the UI thread whenever
+ * the current token associated with this App Check instance changes.
+ *
+ * @param appCheckInstance - The App Check service instance.
+ * @param observer - An object with `next`, `error`, and `complete`
+ * properties. `next` is called with an
+ * {@link AppCheckTokenResult}
+ * whenever the token changes. `error` is optional and is called if an
+ * error is thrown by the listener (the `next` function). `complete`
+ * is unused, as the token stream is unending.
+ *
+ * @returns A function that unsubscribes this listener.
+ * @public
+ */
+export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;
+
+/**
+ * Registers a listener to changes in the token state. There can be more
+ * than one listener registered at the same time for one or more
+ * App Check instances. The listeners call back on the UI thread whenever
+ * the current token associated with this App Check instance changes.
+ *
+ * @param appCheckInstance - The App Check service instance.
+ * @param onNext - When the token changes, this function is called with aa
+ * {@link AppCheckTokenResult}.
+ * @param onError - Optional. Called if there is an error thrown by the
+ * listener (the `onNext` function).
+ * @param onCompletion - Currently unused, as the token stream is unending.
+ * @returns A function that unsubscribes this listener.
+ * @public
+ */
+export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;
+export { PartialObserver }
+
+/**
+ * App Check provider that can obtain a reCAPTCHA Enterprise token and exchange it
+ * for an App Check token.
+ *
+ * @public
+ */
+export declare class ReCaptchaEnterpriseProvider implements AppCheckProvider {
+    private _siteKey;
+    private _app?;
+    private _heartbeatServiceProvider?;
+    /**
+     * Throttle requests on certain error codes to prevent too many retries
+     * in a short time.
+     */
+    private _throttleData;
+    /**
+     * Create a ReCaptchaEnterpriseProvider instance.
+     * @param siteKey - reCAPTCHA Enterprise score-based site key.
+     */
+    constructor(_siteKey: string);
+    /**
+     * Returns an App Check token.
+     * @internal
+     */
+    getToken(): Promise<AppCheckTokenInternal>;
+    /**
+     * @internal
+     */
+    initialize(app: FirebaseApp): void;
+    /**
+     * @internal
+     */
+    isEqual(otherProvider: unknown): boolean;
+}
+
+/**
+ * App Check provider that can obtain a reCAPTCHA V3 token and exchange it
+ * for an App Check token.
+ *
+ * @public
+ */
+export declare class ReCaptchaV3Provider implements AppCheckProvider {
+    private _siteKey;
+    private _app?;
+    private _heartbeatServiceProvider?;
+    /**
+     * Throttle requests on certain error codes to prevent too many retries
+     * in a short time.
+     */
+    private _throttleData;
+    /**
+     * Create a ReCaptchaV3Provider instance.
+     * @param siteKey - ReCAPTCHA V3 siteKey.
+     */
+    constructor(_siteKey: string);
+    /**
+     * Returns an App Check token.
+     * @internal
+     */
+    getToken(): Promise<AppCheckTokenInternal>;
+    /**
+     * @internal
+     */
+    initialize(app: FirebaseApp): void;
+    /**
+     * @internal
+     */
+    isEqual(otherProvider: unknown): boolean;
+}
+
+/**
+ * Set whether App Check will automatically refresh tokens as needed.
+ *
+ * @param appCheckInstance - The App Check service instance.
+ * @param isTokenAutoRefreshEnabled - If true, the SDK automatically
+ * refreshes App Check tokens as needed. This overrides any value set
+ * during `initializeAppCheck()`.
+ * @public
+ */
+export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
+export { Unsubscribe }
+
+export { }

package/dist/esm/index.esm.js

@@ -326,11 +326,12 @@ function pad(value) {
  * limitations under the License.
  */
 function exchangeToken(_a, heartbeatServiceProvider) {
+    var _b, _c;
     var url = _a.url, body = _a.body;
     return __awaiter(this, void 0, void 0, function () {
         var headers, heartbeatService, heartbeatsHeader, options, response, originalError_1, responseBody, originalError_2, match, timeToLiveAsNumber, now;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
+        return __generator(this, function (_d) {
+            switch (_d.label) {
                 case 0:
                     headers = {
                         'Content-Type': 'application/json'
@@ -341,28 +342,28 @@ function exchangeToken(_a, heartbeatServiceProvider) {
                     if (!heartbeatService) return [3 /*break*/, 2];
                     return [4 /*yield*/, heartbeatService.getHeartbeatsHeader()];
                 case 1:
-                    heartbeatsHeader = _b.sent();
+                    heartbeatsHeader = _d.sent();
                     if (heartbeatsHeader) {
                         headers['X-Firebase-Client'] = heartbeatsHeader;
                     }
-                    _b.label = 2;
+                    _d.label = 2;
                 case 2:
                     options = {
                         method: 'POST',
                         body: JSON.stringify(body),
                         headers: headers
                     };
-                    _b.label = 3;
+                    _d.label = 3;
                 case 3:
-                    _b.trys.push([3, 5, , 6]);
+                    _d.trys.push([3, 5, , 6]);
                     return [4 /*yield*/, fetch(url, options)];
                 case 4:
-                    response = _b.sent();
+                    response = _d.sent();
                     return [3 /*break*/, 6];
                 case 5:
-                    originalError_1 = _b.sent();
+                    originalError_1 = _d.sent();
                     throw ERROR_FACTORY.create("fetch-network-error" /* FETCH_NETWORK_ERROR */, {
-                        originalErrorMessage: originalError_1.message
+                        originalErrorMessage: (_b = originalError_1) === null || _b === void 0 ? void 0 : _b.message
                     });
                 case 6:
                     if (response.status !== 200) {
@@ -370,18 +371,18 @@ function exchangeToken(_a, heartbeatServiceProvider) {
                             httpStatus: response.status
                         });
                     }
-                    _b.label = 7;
+                    _d.label = 7;
                 case 7:
-                    _b.trys.push([7, 9, , 10]);
+                    _d.trys.push([7, 9, , 10]);
                     return [4 /*yield*/, response.json()];
                 case 8:
                     // JSON parsing throws SyntaxError if the response body isn't a JSON string.
-                    responseBody = _b.sent();
+                    responseBody = _d.sent();
                     return [3 /*break*/, 10];
                 case 9:
-                    originalError_2 = _b.sent();
+                    originalError_2 = _d.sent();
                     throw ERROR_FACTORY.create("fetch-parse-error" /* FETCH_PARSE_ERROR */, {
-                        originalErrorMessage: originalError_2.message
+                        originalErrorMessage: (_c = originalError_2) === null || _c === void 0 ? void 0 : _c.message
                     });
                 case 10:
                     match = responseBody.ttl.match(/^([\d.]+)(s)$/);
@@ -457,6 +458,7 @@ function getDBPromise() {
         return dbPromise;
     }
     dbPromise = new Promise(function (resolve, reject) {
+        var _a;
         try {
             var request = indexedDB.open(DB_NAME, DB_VERSION);
             request.onsuccess = function (event) {
@@ -485,7 +487,7 @@ function getDBPromise() {
         }
         catch (e) {
             reject(ERROR_FACTORY.create("storage-open" /* STORAGE_OPEN */, {
-                originalErrorMessage: e.message
+                originalErrorMessage: (_a = e) === null || _a === void 0 ? void 0 : _a.message
             }));
         }
     });
@@ -1070,7 +1072,7 @@ function internalFactory(appCheck) {
 }
 
 var name = "@firebase/app-check";
-var version = "0.5.8";
+var version = "0.5.9-canary.ebc17e27f";
 
 /**
  * @license