Add app-check-compat index.d.ts types and overload types (#5102)

Author: hsubox76

common/api-review/app-check-exp.api.md

@@ -70,6 +70,8 @@ export function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObse
 // @public
 export function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;
 
+export { PartialObserver }
+
 // @public
 export class ReCaptchaV3Provider implements AppCheckProvider {
     constructor(_siteKey: string);
@@ -82,6 +84,8 @@ export class ReCaptchaV3Provider implements AppCheckProvider {
 // @public
 export function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
 
+export { Unsubscribe }
+
 
 // (No @packageDocumentation comment for this package)
 

packages-exp/app-check-compat/package.json

@@ -14,12 +14,13 @@
     "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
     "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
     "build": "rollup -c",
-    "build:release": "rollup -c rollup.config.release.js",
+    "build:release": "rollup -c rollup.config.release.js && yarn add-compat-overloads",
     "build:deps": "lerna run --scope @firebase/app-check-compat --include-dependencies build",
     "dev": "rollup -c -w",
     "test": "run-p lint test:browser",
     "test:ci": "node ../../scripts/run_tests_in_ci.js -s test:browser",
-    "test:browser": "karma start --single-run --nocache"
+    "test:browser": "karma start --single-run --nocache",
+    "add-compat-overloads": "ts-node-script ../../scripts/exp/create-overloads.ts -i ../app-check-exp/dist/app-check-exp-public.d.ts -o dist/src/index.d.ts -a -r AppCheck:FirebaseAppCheck -r FirebaseApp:FirebaseAppCompat --moduleToEnhance @firebase/app-check"
   },
   "peerDependencies": {
     "@firebase/app-compat": "0.x"

packages-exp/app-check-exp/src/api.ts

@@ -15,17 +15,17 @@
  * limitations under the License.
  */
 
-import { AppCheck, AppCheckOptions, AppCheckTokenResult } from './public-types';
+import {
+  AppCheck,
+  AppCheckOptions,
+  AppCheckTokenResult,
+  Unsubscribe,
+  PartialObserver
+} from './public-types';
 import { ERROR_FACTORY, AppCheckError } from './errors';
 import { getState, setState, AppCheckState } from './state';
 import { FirebaseApp, getApp, _getProvider } from '@firebase/app-exp';
-import {
-  getModularInstance,
-  ErrorFn,
-  NextFn,
-  PartialObserver,
-  Unsubscribe
-} from '@firebase/util';
+import { getModularInstance, ErrorFn, NextFn } from '@firebase/util';
 import { AppCheckService } from './factory';
 import { AppCheckProvider, ListenerType } from './types';
 import {
@@ -214,18 +214,18 @@ export function onTokenChanged(
   let nextFn: NextFn<AppCheckTokenResult> = () => {};
   let errorFn: ErrorFn = () => {};
   if ((onNextOrObserver as PartialObserver<AppCheckTokenResult>).next != null) {
-    nextFn = (onNextOrObserver as PartialObserver<AppCheckTokenResult>).next!.bind(
-      onNextOrObserver
-    );
+    nextFn = (
+      onNextOrObserver as PartialObserver<AppCheckTokenResult>
+    ).next!.bind(onNextOrObserver);
   } else {
     nextFn = onNextOrObserver as NextFn<AppCheckTokenResult>;
   }
   if (
     (onNextOrObserver as PartialObserver<AppCheckTokenResult>).error != null
   ) {
-    errorFn = (onNextOrObserver as PartialObserver<AppCheckTokenResult>).error!.bind(
-      onNextOrObserver
-    );
+    errorFn = (
+      onNextOrObserver as PartialObserver<AppCheckTokenResult>
+    ).error!.bind(onNextOrObserver);
   } else if (onError) {
     errorFn = onError;
   }

packages-exp/app-check-exp/src/public-types.ts

@@ -17,6 +17,7 @@
 
 import { FirebaseApp } from '@firebase/app-exp';
 import { CustomProvider, ReCaptchaV3Provider } from './providers';
+export { Unsubscribe, PartialObserver } from '@firebase/util';
 
 /**
  * The Firebase App Check service interface.

packages-exp/firebase-exp/compat/index.d.ts

@@ -1274,6 +1274,8 @@ declare namespace firebase {
    * If not passed, uses the default app.
    */
   function analytics(app?: firebase.app.App): firebase.analytics.Analytics;
+
+  function appCheck(app?: firebase.app.App): firebase.appCheck.AppCheck;
 }
 
 declare namespace firebase.app {
@@ -1471,6 +1473,123 @@ declare namespace firebase.app {
      * ```
      */
     analytics(): firebase.analytics.Analytics;
+    appCheck(): firebase.appCheck.AppCheck;
+  }
+}
+
+declare namespace firebase.appCheck {
+  /**
+   * Result returned by
+   * {@link firebase.appCheck.AppCheck.getToken `firebase.appCheck().getToken()`}.
+   */
+  interface AppCheckTokenResult {
+    token: string;
+  }
+  /**
+   * The Firebase AppCheck service interface.
+   *
+   * Do not call this constructor directly. Instead, use
+   * {@link firebase.appCheck `firebase.appCheck()`}.
+   */
+  export interface AppCheck {
+    /**
+     * Activate AppCheck
+     * @param siteKeyOrProvider reCAPTCHA v3 site key (public key) or
+     * custom token provider.
+     * @param isTokenAutoRefreshEnabled If true, the SDK automatically
+     * refreshes App Check tokens as needed. If undefined, defaults to the
+     * value of `app.automaticDataCollectionEnabled`, which defaults to
+     * false and can be set in the app config.
+     */
+    activate(
+      siteKeyOrProvider: string | AppCheckProvider,
+      isTokenAutoRefreshEnabled?: boolean
+    ): void;
+
+    /**
+     *
+     * @param isTokenAutoRefreshEnabled If true, the SDK automatically
+     * refreshes App Check tokens as needed. This overrides any value set
+     * during `activate()`.
+     */
+    setTokenAutoRefreshEnabled(isTokenAutoRefreshEnabled: boolean): void;
+    /**
+     * 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 forceRefresh - If true, will always try to fetch a fresh token.
+     * If false, will use a cached token if found in storage.
+     */
+    getToken(
+      forceRefresh?: boolean
+    ): Promise<firebase.appCheck.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.
+     *
+     * @param observer An object with `next`, `error`, and `complete`
+     * properties. `next` is called with an
+     * {@link firebase.appCheck.AppCheckTokenResult `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.
+     */
+    onTokenChanged(observer: {
+      next: (tokenResult: firebase.appCheck.AppCheckTokenResult) => void;
+      error?: (error: Error) => void;
+      complete?: () => void;
+    }): 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 onNext When the token changes, this function is called with aa
+     * {@link firebase.appCheck.AppCheckTokenResult `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.
+     */
+    onTokenChanged(
+      onNext: (tokenResult: firebase.appCheck.AppCheckTokenResult) => void,
+      onError?: (error: Error) => void,
+      onCompletion?: () => void
+    ): Unsubscribe;
+  }
+
+  /**
+   * 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
+   */
+  interface AppCheckProvider {
+    /**
+     * Returns an AppCheck token.
+     */
+    getToken(): Promise<AppCheckToken>;
+  }
+
+  /**
+   * The token returned from an {@link firebase.appCheck.AppCheckProvider `AppCheckProvider`}.
+   */
+  interface AppCheckToken {
+    /**
+     * The token string in JWT format.
+     */
+    readonly token: string;
+    /**
+     * The local timestamp after which the token will expire.
+     */
+    readonly expireTimeMillis: number;
   }
 }
 
@@ -4419,7 +4538,8 @@ declare namespace firebase.auth {
    * @hidden
    */
   class RecaptchaVerifier_Instance
-    implements firebase.auth.ApplicationVerifier {
+    implements firebase.auth.ApplicationVerifier
+  {
     constructor(
       container: any | string,
       parameters?: Object | null,