@react-native-firebase/app-check 25.0.1 → 26.0.0

package/lib/types/namespaced.ts

@@ -1,422 +0,0 @@
-/*
- * Copyright (c) 2016-present Invertase Limited & Contributors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this library 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 type { ReactNativeFirebase } from '@react-native-firebase/app';
-
-/**
- * Firebase App Check package for React Native.
- *
- * #### Example 1
- *
- * Access the firebase export from the `appCheck` package:
- *
- * ```js
- * import { firebase } from '@react-native-firebase/app-check';
- *
- * // firebase.appCheck().X
- * ```
- *
- * #### Example 2
- *
- * Using the default export from the `appCheck` package:
- *
- * ```js
- * import appCheck from '@react-native-firebase/app-check';
- *
- * // appCheck().X
- * ```
- *
- * #### Example 3
- *
- * Using the default export from the `app` package:
- *
- * ```js
- * import firebase from '@react-native-firebase/app';
- * import '@react-native-firebase/app-check';
- *
- * // firebase.appCheck().X
- * ```
- * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
- * @firebase app-check
- */
-/* eslint-disable @typescript-eslint/no-namespace */
-export namespace FirebaseAppCheckTypes {
-  type FirebaseModule = ReactNativeFirebase.FirebaseModule;
-
-  /**
-   * An App Check provider. This can be either the built-in reCAPTCHA provider
-   * or a custom provider. For more on custom providers, see
-   * https://firebase.google.com/docs/app-check/web-custom-provider
-   * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-   */
-  export interface AppCheckProvider {
-    /**
-     * Returns an AppCheck token.
-     */
-    getToken(): Promise<AppCheckToken>;
-  }
-
-  /**
-   * Custom provider class.
-   * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-   * @public
-   */
-  export declare class CustomProvider implements AppCheckProvider {
-    constructor(customProviderOptions: CustomProviderOptions);
-    getToken(): Promise<AppCheckToken>;
-  }
-  /**
-   * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-   */
-  export interface CustomProviderOptions {
-    /**
-     * Function to get an App Check token through a custom provider
-     * service.
-     */
-    getToken: () => Promise<AppCheckToken>;
-  }
-  /**
-   * Options for App Check initialization.
-   * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-   */
-  export interface AppCheckOptions {
-    /**
-     * The App Check provider to use. This can be either the built-in reCAPTCHA provider
-     * or a custom provider.
-     */
-    provider: CustomProvider | ReactNativeFirebaseAppCheckProvider;
-
-    /**
-     * If true, enables SDK to automatically
-     * refresh AppCheck token as needed. If undefined, the value will default
-     * to the value of `app.automaticDataCollectionEnabled`. That property
-     * defaults to false and can be set in the app config.
-     */
-    isTokenAutoRefreshEnabled?: boolean;
-  }
-
-  /**
-   * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-   */
-  export type NextFn<T> = (value: T) => void;
-  export type ErrorFn = (error: Error) => void;
-  export type CompleteFn = () => void;
-
-  /**
-   * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-   */
-  export interface Observer<T> {
-    next: NextFn<T>;
-    error: ErrorFn;
-    complete: CompleteFn;
-  }
-
-  /**
-   * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-   */
-  export type PartialObserver<T> = Partial<Observer<T>>;
-
-  /**
-   * A function that unsubscribes from token changes.
-   */
-  export type Unsubscribe = () => void;
-
-  /**
-   * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-   */
-  export interface ReactNativeFirebaseAppCheckProviderOptions {
-    /**
-     * debug token to use, if any. Defaults to undefined, pre-configure tokens in firebase web console if needed
-     */
-    debugToken?: string;
-  }
-
-  /**
-   * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-   */
-  export interface ReactNativeFirebaseAppCheckProviderWebOptions extends ReactNativeFirebaseAppCheckProviderOptions {
-    /**
-     * The web provider to use, either `reCaptchaV3` or `reCaptchaEnterprise`, defaults to `reCaptchaV3`
-     */
-    provider?: 'debug' | 'reCaptchaV3' | 'reCaptchaEnterprise';
-
-    /**
-     * siteKey for use in web queries, defaults to `none`
-     */
-    siteKey?: string;
-  }
-
-  /**
-   * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-   */
-  export interface ReactNativeFirebaseAppCheckProviderAppleOptions extends ReactNativeFirebaseAppCheckProviderOptions {
-    /**
-     * The apple provider to use, either `deviceCheck` or `appAttest`, or `appAttestWithDeviceCheckFallback`,
-     * defaults to `DeviceCheck`. `appAttest` requires iOS 14+ or will fail, `appAttestWithDeviceCheckFallback`
-     * will use `appAttest` for iOS14+ and fallback to `deviceCheck` on devices with ios13 and lower
-     */
-    provider?: 'debug' | 'deviceCheck' | 'appAttest' | 'appAttestWithDeviceCheckFallback';
-  }
-
-  /**
-   * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-   */
-  export interface ReactNativeFirebaseAppCheckProviderAndroidOptions extends ReactNativeFirebaseAppCheckProviderOptions {
-    /**
-     * The android provider to use, either `debug` or `playIntegrity`. default is `playIntegrity`.
-     */
-    provider?: 'debug' | 'playIntegrity';
-  }
-
-  /**
-   * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-   */
-  export interface ReactNativeFirebaseAppCheckProvider extends AppCheckProvider {
-    /**
-     * Specify how the app check provider should be configured. The new configuration is
-     * in effect when this call returns. You must call `getToken()`
-     * after this call to get a token using the new configuration.
-     * This custom provider allows for delayed configuration and re-configuration on all platforms
-     * so AppCheck has the same experience across all platforms, with the only difference being the native
-     * providers you choose to use on each platform.
-     */
-    configure(options: {
-      web?: ReactNativeFirebaseAppCheckProviderWebOptions;
-      android?: ReactNativeFirebaseAppCheckProviderAndroidOptions;
-      apple?: ReactNativeFirebaseAppCheckProviderAppleOptions;
-      isTokenAutoRefreshEnabled?: boolean;
-    }): void;
-  }
-
-  /**
-   * Result returned by `getToken()`.
-   * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-   */
-  export interface AppCheckTokenResult {
-    /**
-     * The token string in JWT format.
-     */
-    readonly token: string;
-  }
-  /**
-   * The token returned from an `AppCheckProvider`.
-   * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-   */
-  export interface AppCheckToken {
-    /**
-     * The token string in JWT format.
-     */
-    readonly token: string;
-    /**
-     * The local timestamp after which the token will expire.
-     */
-    readonly expireTimeMillis: number;
-  }
-  /**
-   * The result return from `onTokenChanged`
-   * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-   */
-  export type AppCheckListenerResult = AppCheckToken & { readonly appName: string };
-
-  /**
-   * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-   */
-  export interface Statics {
-    // firebase.appCheck.* static props go here
-    CustomProvider: typeof CustomProvider;
-    SDK_VERSION: string;
-  }
-
-  /**
-   * The Firebase App Check service is available for the default app or a given app.
-   *
-   * #### Example 1
-   *
-   * Get the appCheck instance for the **default app**:
-   *
-   * ```js
-   * const appCheckForDefaultApp = firebase.appCheck();
-   * ```
-   *
-   * #### Example 2
-   *
-   * Get the appCheck instance for a **secondary app**:
-   *˚
-   * ```js
-   * const otherApp = firebase.app('otherApp');
-   * const appCheckForOtherApp = firebase.appCheck(otherApp);
-   * ```
-   *
-   * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-   */
-  export interface Module extends FirebaseModule {
-    /**
-     * The current `FirebaseApp` instance for this Firebase service.
-     */
-    app: ReactNativeFirebase.FirebaseApp;
-
-    /**
-     * Create a ReactNativeFirebaseAppCheckProvider option for use in react-native-firebase
-     * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-     */
-    newReactNativeFirebaseAppCheckProvider(): ReactNativeFirebaseAppCheckProvider;
-
-    /**
-     * Initialize the AppCheck module. Note that in react-native-firebase AppCheckOptions must always
-     * be an object with a `provider` member containing `ReactNativeFirebaseAppCheckProvider` that has returned successfully
-     * from a call to the `configure` method, with sub-providers for the various platforms configured to meet your project
-     * requirements. This must be called prior to interacting with any firebase services protected by AppCheck
-     *
-     * @param options an AppCheckOptions with a configured ReactNativeFirebaseAppCheckProvider as the provider
-     * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-     */
-    // TODO wrong types
-    initializeAppCheck(options: AppCheckOptions): Promise<void>;
-
-    /**
-     * Activate App Check
-     * On iOS App Check is activated with DeviceCheck provider simply by including the module, using the token auto refresh default or
-     * the specific value (if configured) in firebase.json, but calling this does no harm.
-     * On Android if you call this it will install the PlayIntegrity provider in release builds, the Debug provider if debuggable.
-     * On both platforms you may use this method to alter the token refresh setting after startup.
-     * On iOS if you want to set a specific AppCheckProviderFactory (for instance to FIRAppCheckDebugProviderFactory or
-     * FIRAppAttestProvider) you must manually do that in your AppDelegate.m prior to calling [FIRApp configure]
-     *
-     * @deprecated use initializeAppCheck to gain access to all platform providers and firebase-js-sdk v9 compatibility
-     * @param siteKeyOrProvider - This is ignored, Android uses DebugProviderFactory if the app is debuggable (https://firebase.google.com/docs/app-check/android/debug-provider)
-     *                            Android uses PlayIntegrityProviderFactory for release builds.
-     *                            iOS uses DeviceCheckProviderFactory by default unless altered in AppDelegate.m manually
-     * @param isTokenAutoRefreshEnabled - If true, enables SDK to automatically
-     * refresh AppCheck token as needed. If undefined, the value will default
-     * to the value of `app.automaticDataCollectionEnabled`. That property
-     * defaults to false and can be set in the app config.
-     * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-     */
-    activate(
-      siteKeyOrProvider: string | AppCheckProvider,
-      isTokenAutoRefreshEnabled?: boolean,
-    ): Promise<void>;
-
-    /**
-     * Alter the token auto refresh setting. By default it will take the value of automaticDataCollectionEnabled from Info.plist / AndroidManifest.xml
-     * @param isTokenAutoRefreshEnabled - If true, the SDK automatically
-     * refreshes App Check tokens as needed. This overrides any value set
-     * during `activate()` or taken by default from automaticDataCollectionEnabled in plist / android manifest
-     * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-     */
-    setTokenAutoRefreshEnabled(isTokenAutoRefreshEnabled: boolean): void;
-
-    /**
-     * Requests Firebase App Check token.
-     * This method should only be used if you need to authorize requests to a non-Firebase backend.
-     * Requests to Firebase backend are authorized automatically if configured.
-     *
-     * @param forceRefresh - If true, a new Firebase App Check token is requested and the token cache is ignored.
-     * If false, the cached token is used if it exists and has not expired yet.
-     * In most cases, false should be used. True should only be used if the server explicitly returns an error, indicating a revoked token.
-     * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-     */
-    getToken(forceRefresh?: boolean): Promise<AppCheckTokenResult>;
-
-    /**
-     * Requests a Firebase App Check token. This method should be used only if you need to authorize requests
-     * to a non-Firebase backend. Returns limited-use tokens that are intended for use with your non-Firebase
-     * backend endpoints that are protected with Replay Protection (https://firebase.google.com/docs/app-check/custom-resource-backend#replay-protection).
-     * This method does not affect the token generation behavior of the getAppCheckToken() method.
-     * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-     */
-    getLimitedUseToken(): Promise<AppCheckTokenResult>;
-
-    /**
-     * 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.
-     *
-     * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-     * @returns A function that unsubscribes this listener.
-     */
-    // TODO wrong types
-    onTokenChanged(observer: PartialObserver<AppCheckListenerResult>): () => void;
-
-    /**
-     * 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.
-     *
-     * Token listeners do not exist in the native SDK for iOS, no token change events will be emitted on that platform.
-     * This is not yet implemented on Android, no token change events will be emitted until implemented.
-     *
-     * NOTE: Although an `onError` callback can be provided, it will
-     * never be called, Android sdk code doesn't provide handling for onError function
-     *
-     * NOTE: Although an `onCompletion` callback can be provided, it will
-     * never be called because the token stream is never-ending.
-     *
-     * @deprecated Use the exported types directly instead. FirebaseAppCheckTypes namespace is kept for backwards compatibility.
-     * @returns A function that unsubscribes this listener.
-     */
-    // TODO wrong types
-    onTokenChanged(
-      onNext: (tokenResult: AppCheckListenerResult) => void,
-      onError?: (error: Error) => void,
-      onCompletion?: () => void,
-    ): () => void;
-  }
-}
-
-type AppCheckNamespace = ReactNativeFirebase.FirebaseModuleWithStaticsAndApp<
-  FirebaseAppCheckTypes.Module,
-  FirebaseAppCheckTypes.Statics
-> & {
-  appCheck: ReactNativeFirebase.FirebaseModuleWithStaticsAndApp<
-    FirebaseAppCheckTypes.Module,
-    FirebaseAppCheckTypes.Statics
-  >;
-  firebase: ReactNativeFirebase.Module;
-  app(name?: string): ReactNativeFirebase.FirebaseApp;
-};
-
-declare const defaultExport: AppCheckNamespace;
-
-export declare const firebase: ReactNativeFirebase.Module & {
-  appCheck: typeof defaultExport;
-  app(
-    name?: string,
-  ): ReactNativeFirebase.FirebaseApp & { appCheck(): FirebaseAppCheckTypes.Module };
-};
-
-export default defaultExport;
-
-/**
- * Attach namespace to `firebase.` and `FirebaseApp.`.
- */
-declare module '@react-native-firebase/app' {
-  namespace ReactNativeFirebase {
-    import FirebaseModuleWithStaticsAndApp = ReactNativeFirebase.FirebaseModuleWithStaticsAndApp;
-    interface Module {
-      appCheck: FirebaseModuleWithStaticsAndApp<
-        FirebaseAppCheckTypes.Module,
-        FirebaseAppCheckTypes.Statics
-      >;
-    }
-    interface FirebaseApp {
-      appCheck(): FirebaseAppCheckTypes.Module;
-    }
-  }
-}