@firebase/app-check 0.5.8 → 0.5.9-canary.8e952e2ee

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @firebase/app-check
 
+## 0.5.9
+
+### Patch Changes
+
+- [`2cd1cc76f`](https://github.com/firebase/firebase-js-sdk/commit/2cd1cc76f2a308135cd60f424fe09084a34b5cb5) [#6307](https://github.com/firebase/firebase-js-sdk/pull/6307) (fixes [#6300](https://github.com/firebase/firebase-js-sdk/issues/6300)) - fix: add type declarations to exports field
+
+- Updated dependencies [[`2cd1cc76f`](https://github.com/firebase/firebase-js-sdk/commit/2cd1cc76f2a308135cd60f424fe09084a34b5cb5)]:
+  - @firebase/component@0.5.15
+  - @firebase/logger@0.3.3
+  - @firebase/util@1.6.1
+
 ## 0.5.8
 
 ### Patch Changes

package/dist/app-check-public.d.ts

@@ -1,224 +1,224 @@
-/**
- * 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;
-}
-
-/* Excluded from this release type: _AppCheckComponentName */
-
-/* Excluded from this release type: _AppCheckInternalComponentName */
-
-/**
- * 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 {
-    /* Excluded from this release type: getToken */
-    /* Excluded from this release type: initialize */
-}
-
-/**
- * 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);
-    /* Excluded from this release type: getToken */
-    /* Excluded from this release type: initialize */
-    /* Excluded from this release type: isEqual */
-}
-
-/**
- * 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);
-    /* Excluded from this release type: getToken */
-    /* Excluded from this release type: initialize */
-    /* Excluded from this release type: isEqual */
-}
-
-/**
- * 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);
-    /* Excluded from this release type: getToken */
-    /* Excluded from this release type: initialize */
-    /* Excluded from this release type: isEqual */
-}
-
-/**
- * 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;
+}
+
+/* Excluded from this release type: _AppCheckComponentName */
+
+/* Excluded from this release type: _AppCheckInternalComponentName */
+
+/**
+ * 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 {
+    /* Excluded from this release type: getToken */
+    /* Excluded from this release type: initialize */
+}
+
+/**
+ * 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);
+    /* Excluded from this release type: getToken */
+    /* Excluded from this release type: initialize */
+    /* Excluded from this release type: isEqual */
+}
+
+/**
+ * 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);
+    /* Excluded from this release type: getToken */
+    /* Excluded from this release type: initialize */
+    /* Excluded from this release type: isEqual */
+}
+
+/**
+ * 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);
+    /* Excluded from this release type: getToken */
+    /* Excluded from this release type: initialize */
+    /* Excluded from this release type: isEqual */
+}
+
+/**
+ * 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 { }