Small fixes

Author: hsubox76

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

@@ -20,12 +20,7 @@ export type _AppCheckInternalComponentName = 'app-check-internal';
 // @public
 export interface AppCheckOptions {
     isTokenAutoRefreshEnabled?: boolean;
-    provider: AppCheckProvider;
-}
-
-// @public
-export interface AppCheckProvider {
-    getToken: () => Promise<AppCheckToken>;
+    provider: CustomProvider | ReCaptchaV3Provider;
 }
 
 // @public
@@ -35,18 +30,22 @@ export interface AppCheckToken {
     readonly token: string;
 }
 
+// Warning: (ae-forgotten-export) The symbol "AppCheckProvider" needs to be exported by the entry point index.d.ts
+//
 // @public
 export class CustomProvider implements AppCheckProvider {
     constructor(_customProviderOptions: CustomProviderOptions);
+    // Warning: (ae-forgotten-export) The symbol "AppCheckTokenInternal" needs to be exported by the entry point index.d.ts
+    //
     // @internal (undocumented)
-    getToken(): Promise<AppCheckToken>;
+    getToken(): Promise<AppCheckTokenInternal>;
     // @internal (undocumented)
     initialize(app: FirebaseApp): void;
 }
 
 // @public
 export interface CustomProviderOptions {
-    getToken(): Promise<AppCheckToken>;
+    getToken: () => Promise<AppCheckToken>;
 }
 
 // @public
@@ -56,7 +55,7 @@ export function initializeAppCheck(app: FirebaseApp | undefined, options: AppChe
 export class ReCaptchaV3Provider implements AppCheckProvider {
     constructor(_siteKey: string);
     // @internal
-    getToken(): Promise<AppCheckToken>;
+    getToken(): Promise<AppCheckTokenInternal>;
     // @internal (undocumented)
     initialize(app: FirebaseApp): void;
     }

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

@@ -21,14 +21,16 @@ import { getState, setState, AppCheckState } from './state';
 import { FirebaseApp, getApp, _getProvider } from '@firebase/app-exp';
 import { getModularInstance } from '@firebase/util';
 import { AppCheckService } from './factory';
-import { AppCheckProviderInternal } from './types';
+import { AppCheckProvider } from './types';
 
 declare module '@firebase/component' {
   interface NameServiceMapping {
     'app-check-exp': AppCheckService;
   }
 }
 
+export { ReCaptchaV3Provider, CustomProvider } from './providers';
+
 /**
  * Activate AppCheck for the given app. Can be called only once per app.
  * @param app - the FirebaseApp to activate AppCheck for
@@ -49,11 +51,7 @@ export function initializeAppCheck(
   }
 
   const appCheck = provider.initialize({ options });
-  _activate(
-    app,
-    options.provider as AppCheckProviderInternal,
-    options.isTokenAutoRefreshEnabled
-  );
+  _activate(app, options.provider, options.isTokenAutoRefreshEnabled);
 
   return appCheck;
 }
@@ -72,7 +70,7 @@ export function initializeAppCheck(
  */
 function _activate(
   app: FirebaseApp,
-  provider: AppCheckProviderInternal,
+  provider: AppCheckProvider,
   isTokenAutoRefreshEnabled?: boolean
 ): void {
   const state = getState(app);
@@ -90,7 +88,7 @@ function _activate(
 
   setState(app, newState);
 
-  (newState.provider as AppCheckProviderInternal).initialize(app);
+  newState.provider.initialize(app);
 }
 
 /**

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

@@ -27,7 +27,6 @@ export { _AppCheckInternalComponentName };
 
 export * from './api';
 export * from './public-types';
-export { ReCaptchaV3Provider, CustomProvider } from './providers';
 
 const APP_CHECK_NAME: _AppCheckComponentName = 'app-check-exp';
 const APP_CHECK_NAME_INTERNAL: _AppCheckInternalComponentName =

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

@@ -20,15 +20,12 @@ import { Provider } from '@firebase/component';
 import { issuedAtTime } from '@firebase/util';
 import { exchangeToken, getExchangeRecaptchaTokenRequest } from './client';
 import { AppCheckError, ERROR_FACTORY } from './errors';
-import {
-  AppCheckProvider,
-  AppCheckToken,
-  CustomProviderOptions
-} from './public-types';
+import { CustomProviderOptions } from './public-types';
 import {
   getToken as getReCAPTCHAToken,
   initialize as initializeRecaptcha
 } from './recaptcha';
+import { AppCheckProvider, AppCheckTokenInternal } from './types';
 
 /**
  * App Check provider that can obtain a reCAPTCHA V3 token and exchange it
@@ -48,7 +45,7 @@ export class ReCaptchaV3Provider implements AppCheckProvider {
    * Returns an AppCheck token.
    * @internal
    */
-  async getToken(): Promise<AppCheckToken> {
+  async getToken(): Promise<AppCheckTokenInternal> {
     if (!this._app || !this._platformLoggerProvider) {
       // This should only occur if user has not called initializeAppCheck().
       // We don't have an appName to provide if so.
@@ -91,7 +88,7 @@ export class CustomProvider implements AppCheckProvider {
   /**
    * @internal
    */
-  async getToken(): Promise<AppCheckToken> {
+  async getToken(): Promise<AppCheckTokenInternal> {
     if (!this._app) {
       // This should only occur if user has not called initializeAppCheck().
       // We don't have an appName to provide if so.
@@ -114,7 +111,7 @@ export class CustomProvider implements AppCheckProvider {
         ? issuedAtTimeSeconds * 1000
         : Date.now();
 
-    return { ...customToken, issuedAtTimeMillis } as AppCheckToken;
+    return { ...customToken, issuedAtTimeMillis };
   }
 
   /**

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

@@ -16,6 +16,7 @@
  */
 
 import { FirebaseApp } from '@firebase/app-exp';
+import { CustomProvider, ReCaptchaV3Provider } from './providers';
 
 /**
  * The Firebase AppCheck service interface.
@@ -30,20 +31,7 @@ export interface AppCheck {
 }
 
 /**
- * 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
- * @public
- */
-export interface AppCheckProvider {
-  /**
-   * Returns an AppCheck token.
-   */
-  getToken: () => Promise<AppCheckToken>;
-}
-
-/**
- * The token returned from an {@link AppCheckProvider}.
+ * The token returned from an AppCheck provider.
  * @public
  */
 export interface AppCheckToken {
@@ -67,7 +55,7 @@ export interface AppCheckOptions {
   /**
    * reCAPTCHA provider or custom provider.
    */
-  provider: AppCheckProvider;
+  provider: CustomProvider | ReCaptchaV3Provider;
   /**
    * If set to true, enables automatic background refresh of app check token.
    */
@@ -80,8 +68,8 @@ export interface AppCheckOptions {
  */
 export interface CustomProviderOptions {
   /**
-   * Method to get an App Check token through a custom provider
+   * Function to get an App Check token through a custom provider
    * service.
    */
-  getToken(): Promise<AppCheckToken>;
+  getToken: () => Promise<AppCheckToken>;
 }

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

@@ -17,7 +17,7 @@
 
 import { FirebaseApp } from '@firebase/app-exp';
 import {
-  AppCheckProviderInternal,
+  AppCheckProvider,
   AppCheckTokenInternal,
   AppCheckTokenListener
 } from './types';
@@ -27,7 +27,7 @@ import { GreCAPTCHA } from './recaptcha';
 export interface AppCheckState {
   activated: boolean;
   tokenListeners: AppCheckTokenListener[];
-  provider?: AppCheckProviderInternal;
+  provider?: AppCheckProvider;
   token?: AppCheckTokenInternal;
   tokenRefresher?: Refresher;
   reCAPTCHAState?: ReCAPTCHAState;

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

@@ -45,7 +45,7 @@ export interface AppCheckTokenInternal extends AppCheckToken {
   issuedAtTimeMillis: number;
 }
 
-export interface AppCheckProviderInternal {
+export interface AppCheckProvider {
   /**
    * Returns an AppCheck token.
    */

packages-exp/app-check-exp/test/util.ts

@@ -20,7 +20,6 @@ import {
   initializeApp,
   _registerComponent
 } from '@firebase/app-exp';
-import { AppCheckProvider } from '../src/public-types';
 import { GreCAPTCHA, RECAPTCHA_URL } from '../src/recaptcha';
 import {
   Provider,
@@ -30,6 +29,7 @@ import {
 } from '@firebase/component';
 import { PlatformLoggerService } from '@firebase/app-exp/dist/packages-exp/app-exp/src/types';
 import { AppCheckService } from '../src/factory';
+import { CustomProvider } from '../src';
 
 export const FAKE_SITE_KEY = 'fake-site-key';
 
@@ -75,14 +75,14 @@ export function getFullApp(): FirebaseApp {
   return app;
 }
 
-export function getFakeCustomTokenProvider(): AppCheckProvider {
-  return {
+export function getFakeCustomTokenProvider(): CustomProvider {
+  return new CustomProvider({
     getToken: () =>
       Promise.resolve({
         token: 'fake-custom-app-check-token',
         expireTimeMillis: 1
       })
-  };
+  });
 }
 
 export function getFakePlatformLoggingProvider(