@depup/firebase__ai 2.9.0-depup.0

package/dist/esm/src/types/schema.d.ts

@@ -0,0 +1,139 @@
+/**
+ * @license
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Contains the list of OpenAPI data types
+ * as defined by the
+ * {@link https://swagger.io/docs/specification/data-models/data-types/ | OpenAPI specification}
+ * @public
+ */
+export declare const SchemaType: {
+    /** String type. */
+    readonly STRING: "string";
+    /** Number type. */
+    readonly NUMBER: "number";
+    /** Integer type. */
+    readonly INTEGER: "integer";
+    /** Boolean type. */
+    readonly BOOLEAN: "boolean";
+    /** Array type. */
+    readonly ARRAY: "array";
+    /** Object type. */
+    readonly OBJECT: "object";
+};
+/**
+ * Contains the list of OpenAPI data types
+ * as defined by the
+ * {@link https://swagger.io/docs/specification/data-models/data-types/ | OpenAPI specification}
+ * @public
+ */
+export type SchemaType = (typeof SchemaType)[keyof typeof SchemaType];
+/**
+ * Basic {@link Schema} properties shared across several Schema-related
+ * types.
+ * @public
+ */
+export interface SchemaShared<T> {
+    /**
+     * An array of {@link Schema}. The generated data must be valid against any of the schemas
+     * listed in this array. This allows specifying multiple possible structures or types for a
+     * single field.
+     */
+    anyOf?: T[];
+    /** Optional. The format of the property.
+     * When using the Gemini Developer API ({@link GoogleAIBackend}), this must be either `'enum'` or
+     * `'date-time'`, otherwise requests will fail.
+     */
+    format?: string;
+    /** Optional. The description of the property. */
+    description?: 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.
+     */
+    title?: string;
+    /** Optional. The items of the property. */
+    items?: T;
+    /** The minimum number of items (elements) in a schema of {@link (SchemaType:type)} `array`. */
+    minItems?: number;
+    /** The maximum number of items (elements) in a schema of {@link (SchemaType:type)} `array`. */
+    maxItems?: number;
+    /** Optional. Map of `Schema` objects. */
+    properties?: {
+        [k: string]: T;
+    };
+    /** A hint suggesting the order in which the keys should appear in the generated JSON string. */
+    propertyOrdering?: string[];
+    /** Optional. The enum of the property. */
+    enum?: string[];
+    /** Optional. The example of the property. */
+    example?: unknown;
+    /** Optional. Whether the property is nullable. */
+    nullable?: boolean;
+    /** The minimum value of a numeric type. */
+    minimum?: number;
+    /** The maximum value of a numeric type. */
+    maximum?: number;
+    [key: string]: unknown;
+}
+/**
+ * Params passed to {@link Schema} static methods to create specific
+ * {@link Schema} classes.
+ * @public
+ */
+export interface SchemaParams extends SchemaShared<SchemaInterface> {
+}
+/**
+ * Final format for {@link Schema} params passed to backend requests.
+ * @public
+ */
+export interface SchemaRequest extends SchemaShared<SchemaRequest> {
+    /**
+     * The type of the property. this can only be undefined when using `anyOf` schemas,
+     * which do not have an explicit type in the {@link https://swagger.io/docs/specification/v3_0/data-models/data-types/#any-type | OpenAPI specification }.
+     */
+    type?: SchemaType;
+    /** Optional. Array of required property. */
+    required?: string[];
+}
+/**
+ * Interface for {@link Schema} class.
+ * @public
+ */
+export interface SchemaInterface extends SchemaShared<SchemaInterface> {
+    /**
+     * The type of the property. this can only be undefined when using `anyof` schemas,
+     * which do not have an explicit type in the {@link https://swagger.io/docs/specification/v3_0/data-models/data-types/#any-type | OpenAPI Specification}.
+     */
+    type?: SchemaType;
+}
+/**
+ * Interface for JSON parameters in a schema of {@link (SchemaType:type)}
+ * "object" when not using the `Schema.object()` helper.
+ * @public
+ */
+export interface ObjectSchemaRequest extends SchemaRequest {
+    type: 'object';
+    /**
+     * 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. Populating this
+     * property will cause response errors if the object is not wrapped with
+     * `Schema.object()`.
+     */
+    optionalProperties?: never;
+}

package/dist/esm/src/websocket.d.ts

@@ -0,0 +1,67 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * A standardized interface for interacting with a WebSocket connection.
+ * This abstraction allows the SDK to use the appropriate WebSocket implementation
+ * for the current JS environment (Browser vs. Node) without
+ * changing the core logic of the `LiveSession`.
+ * @internal
+ */
+export interface WebSocketHandler {
+    /**
+     * Establishes a connection to the given URL.
+     *
+     * @param url The WebSocket URL (e.g., wss://...).
+     * @returns A promise that resolves on successful connection or rejects on failure.
+     */
+    connect(url: string): Promise<void>;
+    /**
+     * Sends data over the WebSocket.
+     *
+     * @param data The string or binary data to send.
+     */
+    send(data: string | ArrayBuffer): void;
+    /**
+     * Returns an async generator that yields parsed JSON objects from the server.
+     * The yielded type is `unknown` because the handler cannot guarantee the shape of the data.
+     * The consumer is responsible for type validation.
+     * The generator terminates when the connection is closed.
+     *
+     * @returns A generator that allows consumers to pull messages using a `for await...of` loop.
+     */
+    listen(): AsyncGenerator<unknown>;
+    /**
+     * Closes the WebSocket connection.
+     *
+     * @param code - A numeric status code explaining why the connection is closing.
+     * @param reason - A human-readable string explaining why the connection is closing.
+     */
+    close(code?: number, reason?: string): Promise<void>;
+}
+/**
+ * A wrapper for the native `WebSocket` available in both Browsers and Node >= 22.
+ *
+ * @internal
+ */
+export declare class WebSocketHandlerImpl implements WebSocketHandler {
+    private ws?;
+    constructor();
+    connect(url: string): Promise<void>;
+    send(data: string | ArrayBuffer): void;
+    listen(): AsyncGenerator<unknown>;
+    close(code?: number, reason?: string): Promise<void>;
+}