Simplify limitedUseToken option

Author: hsubox76

common/api-review/ai.api.md

@@ -70,8 +70,8 @@ export abstract class AIModel {
 
 // @public
 export interface AIOptions {
-    appCheck?: AppCheckOptions;
     backend?: Backend;
+    useLimitedUseAppCheckTokens?: boolean;
 }
 
 // @public
@@ -85,11 +85,6 @@ export class AnyOfSchema extends Schema {
     toJSON(): SchemaRequest;
 }
 
-// @public
-export interface AppCheckOptions {
-    limitedUseTokens?: boolean;
-}
-
 // @public
 export class ArraySchema extends Schema {
     constructor(schemaParams: SchemaParams, items: TypedSchema);

docs-devsite/_toc.yaml

@@ -14,8 +14,6 @@ toc:
     path: /docs/reference/js/ai.aioptions.md
   - title: AnyOfSchema
     path: /docs/reference/js/ai.anyofschema.md
-  - title: AppCheckOptions
-    path: /docs/reference/js/ai.appcheckoptions.md
   - title: ArraySchema
     path: /docs/reference/js/ai.arrayschema.md
   - title: Backend

docs-devsite/ai.aioptions.md

@@ -22,25 +22,25 @@ export interface AIOptions
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [appCheck](./ai.aioptions.md#aioptionsappcheck) | [AppCheckOptions](./ai.appcheckoptions.md#appcheckoptions_interface) | Configures App Check usage for this AI service instance. |
 |  [backend](./ai.aioptions.md#aioptionsbackend) | [Backend](./ai.backend.md#backend_class) | The backend configuration to use for the AI service instance. Defaults to the Gemini Developer API backend ([GoogleAIBackend](./ai.googleaibackend.md#googleaibackend_class)<!-- -->). |
+|  [useLimitedUseAppCheckTokens](./ai.aioptions.md#aioptionsuselimiteduseappchecktokens) | boolean | Whether to use App Check limited use tokens. Defaults to false. |
 
-## AIOptions.appCheck
+## AIOptions.backend
 
-Configures App Check usage for this AI service instance.
+The backend configuration to use for the AI service instance. Defaults to the Gemini Developer API backend ([GoogleAIBackend](./ai.googleaibackend.md#googleaibackend_class)<!-- -->).
 
 <b>Signature:</b>
 
 ```typescript
-appCheck?: AppCheckOptions;
+backend?: Backend;
 ```
 
-## AIOptions.backend
+## AIOptions.useLimitedUseAppCheckTokens
 
-The backend configuration to use for the AI service instance. Defaults to the Gemini Developer API backend ([GoogleAIBackend](./ai.googleaibackend.md#googleaibackend_class)<!-- -->).
+Whether to use App Check limited use tokens. Defaults to false.
 
 <b>Signature:</b>
 
 ```typescript
-backend?: Backend;
+useLimitedUseAppCheckTokens?: boolean;
 ```

docs-devsite/ai.appcheckoptions.md

@@ -52,7 +52,6 @@ The Firebase AI Web SDK.
 |  --- | --- |
 |  [AI](./ai.ai.md#ai_interface) | An instance of the Firebase AI SDK.<!-- -->Do not create this instance directly. Instead, use [getAI()](./ai.md#getai_a94a413)<!-- -->. |
 |  [AIOptions](./ai.aioptions.md#aioptions_interface) | Options for initializing the AI service using [getAI()](./ai.md#getai_a94a413)<!-- -->. This allows specifying which backend to use (Vertex AI Gemini API or Gemini Developer API) and configuring its specific options (like location for Vertex AI). |
-|  [AppCheckOptions](./ai.appcheckoptions.md#appcheckoptions_interface) | Configures App Check usage for this AI service instance. |
 |  [BaseParams](./ai.baseparams.md#baseparams_interface) | Base parameters for a number of methods. |
 |  [ChromeAdapter](./ai.chromeadapter.md#chromeadapter_interface) | <b>(EXPERIMENTAL)</b> Defines an inference "backend" that uses Chrome's on-device model, and encapsulates logic for detecting when on-device inference is possible.<!-- -->These methods should not be called directly by the user. |
 |  [Citation](./ai.citation.md#citation_interface) | A single citation. |

docs-devsite/ai.md

@@ -45,32 +45,32 @@ describe('Top level API', () => {
       expect(ai.backend).to.be.instanceOf(GoogleAIBackend);
     });
     it('works with options: no backend, limited use token', () => {
-      const ai = getAI(getFullApp(), { appCheck: { limitedUseTokens: true } });
+      const ai = getAI(getFullApp(), { useLimitedUseAppCheckTokens: true });
       expect(ai.backend).to.be.instanceOf(GoogleAIBackend);
-      expect(ai.options?.appCheck?.limitedUseTokens).to.be.true;
+      expect(ai.options?.useLimitedUseAppCheckTokens).to.be.true;
     });
     it('works with options: backend specified, limited use token', () => {
       const ai = getAI(getFullApp(), {
         backend: new VertexAIBackend('us-central1'),
-        appCheck: { limitedUseTokens: true }
+        useLimitedUseAppCheckTokens: true
       });
       expect(ai.backend).to.be.instanceOf(VertexAIBackend);
-      expect(ai.options?.appCheck?.limitedUseTokens).to.be.true;
+      expect(ai.options?.useLimitedUseAppCheckTokens).to.be.true;
     });
-    it('works with options: appCheck option is empty', () => {
+    it('works with options: appCheck option is falsy', () => {
       const ai = getAI(getFullApp(), {
         backend: new VertexAIBackend('us-central1'),
-        appCheck: {}
+        useLimitedUseAppCheckTokens: undefined
       });
       expect(ai.backend).to.be.instanceOf(VertexAIBackend);
-      expect(ai.options?.appCheck?.limitedUseTokens).to.be.false;
+      expect(ai.options?.useLimitedUseAppCheckTokens).to.be.false;
     });
     it('works with options: backend specified only', () => {
       const ai = getAI(getFullApp(), {
         backend: new VertexAIBackend('us-central1')
       });
       expect(ai.backend).to.be.instanceOf(VertexAIBackend);
-      expect(ai.options?.appCheck?.limitedUseTokens).to.be.false;
+      expect(ai.options?.useLimitedUseAppCheckTokens).to.be.false;
     });
   });
   it('getGenerativeModel throws if no model is provided', () => {

packages/ai/src/api.test.ts

@@ -82,17 +82,9 @@ export function getAI(app: FirebaseApp = getApp(), options?: AIOptions): AI {
 
   const backend = options?.backend ?? new GoogleAIBackend();
 
-  const finalOptions: Omit<AIOptions, 'backend'> = {};
-
-  if (options?.appCheck) {
-    if (options.appCheck.hasOwnProperty('limitedUseTokens')) {
-      finalOptions.appCheck = options.appCheck;
-    } else {
-      finalOptions.appCheck = { ...options.appCheck, limitedUseTokens: false };
-    }
-  } else {
-    finalOptions.appCheck = { limitedUseTokens: false };
-  }
+  const finalOptions: Omit<AIOptions, 'backend'> = {
+    useLimitedUseAppCheckTokens: options?.useLimitedUseAppCheckTokens ?? false
+  };
 
   const identifier = encodeInstanceIdentifier(backend);
   const aiInstance = AIProvider.getImmediate({

packages/ai/src/api.ts

@@ -76,7 +76,7 @@ describe('AIModel', () => {
       //@ts-ignore
       {
         ...fakeAI,
-        options: { appCheck: { limitedUseTokens: false } },
+        options: { useLimitedUseAppCheckTokens: false },
         appCheck: {
           getToken: getTokenStub,
           getLimitedUseToken: getLimitedUseTokenStub
@@ -99,7 +99,7 @@ describe('AIModel', () => {
       //@ts-ignore
       {
         ...fakeAI,
-        options: { appCheck: { limitedUseTokens: true } },
+        options: { useLimitedUseAppCheckTokens: true },
         appCheck: {
           getToken: getTokenStub,
           getLimitedUseToken: getLimitedUseTokenStub

packages/ai/src/models/ai-model.test.ts

@@ -90,7 +90,7 @@ export abstract class AIModel {
           return Promise.resolve({ token });
         };
       } else if ((ai as AIService).appCheck) {
-        if (ai.options?.appCheck?.limitedUseTokens) {
+        if (ai.options?.useLimitedUseAppCheckTokens) {
           this._apiSettings.getAppCheckToken = () =>
             (ai as AIService).appCheck!.getLimitedUseToken();
         } else {

packages/ai/src/models/ai-model.ts

@@ -98,17 +98,7 @@ export interface AIOptions {
    */
   backend?: Backend;
   /**
-   * Configures App Check usage for this AI service instance.
+   * Whether to use App Check limited use tokens. Defaults to false.
    */
-  appCheck?: AppCheckOptions;
-}
-
-/**
- * Configures App Check usage for this AI service instance.
- */
-export interface AppCheckOptions {
-  /**
-   * Defaults to false.
-   */
-  limitedUseTokens?: boolean;
+  useLimitedUseAppCheckTokens?: boolean;
 }