Merge remote-tracking branch 'origin/main' into mtewani/add-more-integration-tests

Author: maneesht

.changeset/angry-scissors-sit.md

@@ -0,0 +1,6 @@
+---
+'firebase': minor
+'@firebase/ai': minor
+---
+
+Add support for `minItems` and `maxItems` to `Schema`.

.changeset/tricky-years-pump.md

@@ -0,0 +1,6 @@
+---
+'firebase': minor
+'@firebase/ai': minor
+---
+
+Add `title`, `maximum`, `minimum`, `propertyOrdering` to Schema builder

.github/workflows/e2e-test.yml

@@ -30,8 +30,8 @@ jobs:
 
     defaults:
       run:
-        # Run any command steps in the /e2e subdir
-        working-directory: './e2e'
+        # Run any command steps in the /e2e/smoke-tests subdir
+        working-directory: './e2e/smoke-tests'
 
     steps:
       - name: Checkout Repo
@@ -53,7 +53,9 @@ jobs:
       - name: Poll npm until version to test is available for install
         run: |
           echo "Polling npm for firebase@${{ github.event.client_payload.versionOrTag }}"
-          node ../scripts/release/poll-npm-publish.js
+          node ./scripts/release/poll-npm-publish.js
+        # run in root
+        working-directory: '.'
         env:
           VERSION: ${{ github.event.client_payload.versionOrTag }}
       - name: Yarn install

common/api-review/ai.api.md

@@ -518,7 +518,8 @@ export enum HarmBlockThreshold {
     BLOCK_LOW_AND_ABOVE = "BLOCK_LOW_AND_ABOVE",
     BLOCK_MEDIUM_AND_ABOVE = "BLOCK_MEDIUM_AND_ABOVE",
     BLOCK_NONE = "BLOCK_NONE",
-    BLOCK_ONLY_HIGH = "BLOCK_ONLY_HIGH"
+    BLOCK_ONLY_HIGH = "BLOCK_ONLY_HIGH",
+    OFF = "OFF"
 }
 
 // @public
@@ -790,6 +791,9 @@ export abstract class Schema implements SchemaInterface {
     format?: string;
     // (undocumented)
     static integer(integerParams?: SchemaParams): IntegerSchema;
+    items?: SchemaInterface;
+    maxItems?: number;
+    minItems?: number;
     nullable: boolean;
     // (undocumented)
     static number(numberParams?: SchemaParams): NumberSchema;
@@ -831,10 +835,16 @@ export interface SchemaShared<T> {
     example?: unknown;
     format?: string;
     items?: T;
+    maximum?: number;
+    maxItems?: number;
+    minimum?: number;
+    minItems?: number;
     nullable?: boolean;
     properties?: {
         [k: string]: T;
     };
+    propertyOrdering?: string[];
+    title?: string;
 }
 
 // @public

docs-devsite/ai.md

@@ -448,13 +448,13 @@ export declare const enum AIErrorCode
 |  INVALID\_CONTENT | <code>&quot;invalid-content&quot;</code> | An error associated with a Content object. |
 |  INVALID\_SCHEMA | <code>&quot;invalid-schema&quot;</code> | An error due to invalid Schema input. |
 |  NO\_API\_KEY | <code>&quot;no-api-key&quot;</code> | An error occurred due to a missing Firebase API key. |
-|  NO\_APP\_ID | <code>&quot;no-app-id&quot;</code> | An error occured due to a missing Firebase app ID. |
+|  NO\_APP\_ID | <code>&quot;no-app-id&quot;</code> | An error occurred due to a missing Firebase app ID. |
 |  NO\_MODEL | <code>&quot;no-model&quot;</code> | An error occurred due to a model name not being specified during initialization. |
 |  NO\_PROJECT\_ID | <code>&quot;no-project-id&quot;</code> | An error occurred due to a missing project ID. |
 |  PARSE\_FAILED | <code>&quot;parse-failed&quot;</code> | An error occurred while parsing. |
 |  REQUEST\_ERROR | <code>&quot;request-error&quot;</code> | An error occurred in a request. |
 |  RESPONSE\_ERROR | <code>&quot;response-error&quot;</code> | An error occurred in a response. |
-|  UNSUPPORTED | <code>&quot;unsupported&quot;</code> | An error occured due an attempt to use an unsupported feature. |
+|  UNSUPPORTED | <code>&quot;unsupported&quot;</code> | An error occurred due an attempt to use an unsupported feature. |
 
 ## BlockReason
 
@@ -551,6 +551,7 @@ export declare enum HarmBlockThreshold
 |  BLOCK\_MEDIUM\_AND\_ABOVE | <code>&quot;BLOCK_MEDIUM_AND_ABOVE&quot;</code> | Content with <code>NEGLIGIBLE</code> and <code>LOW</code> will be allowed. |
 |  BLOCK\_NONE | <code>&quot;BLOCK_NONE&quot;</code> | All content will be allowed. |
 |  BLOCK\_ONLY\_HIGH | <code>&quot;BLOCK_ONLY_HIGH&quot;</code> | Content with <code>NEGLIGIBLE</code>, <code>LOW</code>, and <code>MEDIUM</code> will be allowed. |
+|  OFF | <code>&quot;OFF&quot;</code> | All content will be allowed. This is the same as <code>BLOCK_NONE</code>, but the metadata corresponding to the [HarmCategory](./ai.md#harmcategory) will not be present in the response. |
 
 ## HarmCategory
 

docs-devsite/ai.schema.md

@@ -32,6 +32,9 @@ export declare abstract class Schema implements SchemaInterface
 |  [description](./ai.schema.md#schemadescription) |  | string | Optional. The description of the property. |
 |  [example](./ai.schema.md#schemaexample) |  | unknown | Optional. The example of the property. |
 |  [format](./ai.schema.md#schemaformat) |  | string | Optional. The format of the property. Supported formats:<br/> <ul> <li>for NUMBER type: "float", "double"</li> <li>for INTEGER type: "int32", "int64"</li> <li>for STRING type: "email", "byte", etc</li> </ul> |
+|  [items](./ai.schema.md#schemaitems) |  | [SchemaInterface](./ai.schemainterface.md#schemainterface_interface) | Optional. The items of the property. |
+|  [maxItems](./ai.schema.md#schemamaxitems) |  | number | The maximum number of items (elements) in a schema of type [SchemaType.ARRAY](./ai.md#schematypearray_enummember)<!-- -->. |
+|  [minItems](./ai.schema.md#schemaminitems) |  | number | The minimum number of items (elements) in a schema of type [SchemaType.ARRAY](./ai.md#schematypearray_enummember)<!-- -->. |
 |  [nullable](./ai.schema.md#schemanullable) |  | boolean | Optional. Whether the property is nullable. Defaults to false. |
 |  [type](./ai.schema.md#schematype) |  | [SchemaType](./ai.md#schematype) | Optional. The type of the property. [SchemaType](./ai.md#schematype)<!-- -->. |
 
@@ -93,6 +96,36 @@ Optional. The format of the property. Supported formats:<br/> <ul> <li>for NUMBE
 format?: string;
 ```
 
+## Schema.items
+
+Optional. The items of the property.
+
+<b>Signature:</b>
+
+```typescript
+items?: SchemaInterface;
+```
+
+## Schema.maxItems
+
+The maximum number of items (elements) in a schema of type [SchemaType.ARRAY](./ai.md#schematypearray_enummember)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+maxItems?: number;
+```
+
+## Schema.minItems
+
+The minimum number of items (elements) in a schema of type [SchemaType.ARRAY](./ai.md#schematypearray_enummember)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+minItems?: number;
+```
+
 ## Schema.nullable
 
 Optional. Whether the property is nullable. Defaults to false.

docs-devsite/ai.schemashared.md

@@ -27,8 +27,14 @@ export interface SchemaShared<T>
 |  [example](./ai.schemashared.md#schemasharedexample) | unknown | Optional. The example of the property. |
 |  [format](./ai.schemashared.md#schemasharedformat) | string | Optional. The format of the property. When using the Gemini Developer API ([GoogleAIBackend](./ai.googleaibackend.md#googleaibackend_class)<!-- -->), this must be either <code>'enum'</code> or <code>'date-time'</code>, otherwise requests will fail. |
 |  [items](./ai.schemashared.md#schemashareditems) | T | Optional. The items of the property. |
+|  [maximum](./ai.schemashared.md#schemasharedmaximum) | number | The maximum value of a numeric type. |
+|  [maxItems](./ai.schemashared.md#schemasharedmaxitems) | number | The maximum number of items (elements) in a schema of type [SchemaType.ARRAY](./ai.md#schematypearray_enummember)<!-- -->. |
+|  [minimum](./ai.schemashared.md#schemasharedminimum) | number | The minimum value of a numeric type. |
+|  [minItems](./ai.schemashared.md#schemasharedminitems) | number | The minimum number of items (elements) in a schema of type [SchemaType.ARRAY](./ai.md#schematypearray_enummember)<!-- -->. |
 |  [nullable](./ai.schemashared.md#schemasharednullable) | boolean | Optional. Whether the property is nullable. |
 |  [properties](./ai.schemashared.md#schemasharedproperties) | { \[k: string\]: T; } | Optional. Map of <code>Schema</code> objects. |
+|  [propertyOrdering](./ai.schemashared.md#schemasharedpropertyordering) | string\[\] | A hint suggesting the order in which the keys should appear in the generated JSON string. |
+|  [title](./ai.schemashared.md#schemasharedtitle) | string | The title of the property. This helps document the schema's purpose but does not typically constrain the generated value. It can subtly guide the model by clarifying the intent of a field. |
 
 ## SchemaShared.description
 
@@ -80,6 +86,46 @@ Optional. The items of the property.
 items?: T;
 ```
 
+## SchemaShared.maximum
+
+The maximum value of a numeric type.
+
+<b>Signature:</b>
+
+```typescript
+maximum?: number;
+```
+
+## SchemaShared.maxItems
+
+The maximum number of items (elements) in a schema of type [SchemaType.ARRAY](./ai.md#schematypearray_enummember)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+maxItems?: number;
+```
+
+## SchemaShared.minimum
+
+The minimum value of a numeric type.
+
+<b>Signature:</b>
+
+```typescript
+minimum?: number;
+```
+
+## SchemaShared.minItems
+
+The minimum number of items (elements) in a schema of type [SchemaType.ARRAY](./ai.md#schematypearray_enummember)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+minItems?: number;
+```
+
 ## SchemaShared.nullable
 
 Optional. Whether the property is nullable.
@@ -101,3 +147,23 @@ properties?: {
         [k: string]: T;
     };
 ```
+
+## SchemaShared.propertyOrdering
+
+A hint suggesting the order in which the keys should appear in the generated JSON string.
+
+<b>Signature:</b>
+
+```typescript
+propertyOrdering?: string[];
+```
+
+## SchemaShared.title
+
+The title of the property. This helps document the schema's purpose but does not typically constrain the generated value. It can subtly guide the model by clarifying the intent of a field.
+
+<b>Signature:</b>
+
+```typescript
+title?: string;
+```

e2e/README.md

@@ -1,92 +1,11 @@
-# Firebase JS SDK E2E Tests
+# E2E Tests
 
-This directory contains end-to-end tests for the Firebase JS SDK package as well as minimal quick start sample apps for debugging and development.
+This directory is for Firebase E2E tests that are completely independent of the main SDK workspaces. Packages in here should:
 
-## E2E Tests
+* Have a start trigger independent of the main CI PR/push triggers (e.g., manual trigger, repository_dispatch, from an external runner like Kokoro, etc.)
+  
+  A common use case might be to clone this repo, cd into the chosen directory under e2e, npm install, and run npm scripts.
 
-### Setup
+* Have a self-contained set of NPM dependencies. They should not depend on the local version of Firebase in the SDK nor assume inherited availability of any packages in the top level package.json of this repo (typescript, firebase, karma, etc.).
 
-Before running the tests, you will need:
-
-- a project config
-- a test user with an email/password login which has read/write privileges for Storage, Realtime Database, and Firestore
-- an App Check debug token
-- to deploy the `callTest` Cloud Function
-
-#### Project Config and Test User
-
-Create a file named `firebase-config.js` in the top level of this `e2e/` directory. The contents of the file should be:
-
-```javascript
-// A config for a project
-export const config = {
-  apiKey: ************,
-  authDomain: ************,
-  databaseURL: ************,
-  projectId: ************,
-  storageBucket: ************,
-  messagingSenderId: ************,
-  appId: ************,
-  measurementId: ************
-};
- *
-// A user account with read/write privileges in that project
-// for storage, database, firestore
-export const testAccount = {
-  email: ************,
-  password: ************
-}
-```
-
-#### App Check Debug Token
-
-Create an App Check debug token in the Firebase Console. Assign it to an environment variable in your shell named `APP_CHECK_DEBUG_TOKEN`.
-
-#### Deploy `callTest` Cloud Function
-
-From the top level of the firebase repo, ensure you have the Firebase CLI (`firebase-tools`) installed (if not, `npm install -g firebase-tools`).
-
-Ensure you are logged in using the CLI (`firebase login`);
-
-Then deploy the function with:
-`firebase deploy --only functions:callTest --project YOUR_PROJECT_ID`
-
-### Running the Tests
-
-To run the tests on the default modular API:
-
-```
-yarn test:modular
-```
-
-To run the tests on the compat API:
-
-```
-yarn test:compat
-```
-
-## Sample Apps
-
-Two minimal sample apps are provided for quick debugging and development. These apps import and initialize every product in the SDK and call some basic methods. Products can easily be commented out to focus on one or more products you are interested in looking at.
-
-### Setup
-
-The setup is the same as for the E2E tests above. Certain tests can be skipped if you are commenting out that product (e.g, no need to deploy the Cloud Function if you are commenting out the `callFunctions()` line in the sample app, and no need to set the App Check debug token env variable if not using App Check).
-
-### Running Sample Apps
-
-To run the modular sample app (uses current default version of the API):
-
-```
-yarn start:modular
-```
-
-Then open `localhost:8080` in a browser.
-
-To run the compat sample app (uses current compat version of the API):
-
-```
-yarn start:compat
-```
-
-Then open `localhost:8080` in a browser.
+See the `template/` directory for an example.