Fix typings for functionDeclaration.parameters.

Author: hsubox76

.changeset/rotten-taxis-allow.md

@@ -0,0 +1,5 @@
+---
+'@firebase/vertexai': patch
+---
+
+Fix typings for functionDeclaration.parameters.

common/api-review/vertexai.api.md

@@ -211,7 +211,7 @@ export interface FunctionCallPart {
 export interface FunctionDeclaration {
     description: string;
     name: string;
-    parameters?: ObjectSchemaInterface;
+    parameters?: ObjectSchema | ObjectSchemaRequest;
 }
 
 // @public
@@ -567,9 +567,8 @@ export class ObjectSchema extends Schema {
 }
 
 // @public
-export interface ObjectSchemaInterface extends SchemaInterface {
-    // (undocumented)
-    optionalProperties?: string[];
+export interface ObjectSchemaRequest extends SchemaRequest {
+    optionalProperties?: never;
     // (undocumented)
     type: SchemaType.OBJECT;
 }

packages/vertexai/src/requests/schema-builder.ts

@@ -21,8 +21,7 @@ import {
   SchemaInterface,
   SchemaType,
   SchemaParams,
-  SchemaRequest,
-  ObjectSchemaInterface
+  SchemaRequest
 } from '../types/schema';
 
 /**
@@ -286,7 +285,7 @@ export class ObjectSchema extends Schema {
     if (required.length > 0) {
       obj.required = required;
     }
-    delete (obj as ObjectSchemaInterface).optionalProperties;
+    delete obj.optionalProperties;
     return obj as SchemaRequest;
   }
 }

packages/vertexai/src/types/requests.ts

@@ -15,15 +15,15 @@
  * limitations under the License.
  */
 
-import { TypedSchema } from '../requests/schema-builder';
+import { ObjectSchema, TypedSchema } from '../requests/schema-builder';
 import { Content, Part } from './content';
 import {
   FunctionCallingMode,
   HarmBlockMethod,
   HarmBlockThreshold,
   HarmCategory
 } from './enums';
-import { ObjectSchemaInterface, SchemaRequest } from './schema';
+import { ObjectSchemaRequest, SchemaRequest } from './schema';
 
 /**
  * Base parameters for a number of methods.
@@ -175,7 +175,7 @@ export declare interface FunctionDeclaration {
    * format. Reflects the Open API 3.03 Parameter Object. Parameter names are
    * case-sensitive. For a function with no parameters, this can be left unset.
    */
-  parameters?: ObjectSchemaInterface;
+  parameters?: ObjectSchema | ObjectSchemaRequest;
 }
 
 /**

packages/vertexai/src/types/schema.ts

@@ -95,10 +95,16 @@ export interface SchemaInterface extends SchemaShared<SchemaInterface> {
 }
 
 /**
- * Interface for {@link ObjectSchema} class.
+ * Interface for JSON parameters in {@link SchemaType.OBJECT} format when
+ * not using the {@link ObjectSchema} helper.
  * @public
  */
-export interface ObjectSchemaInterface extends SchemaInterface {
+export interface ObjectSchemaRequest extends SchemaRequest {
   type: SchemaType.OBJECT;
-  optionalProperties?: string[];
+  /**
+   * This is not a property accepted in the final request to the backend, but is
+   * a client-side convenience property that is only usable by constructing
+   * a schema through the `Schema.object()` helper method.
+   */
+  optionalProperties?: never;
 }