summaryrefslogtreecommitdiff
path: root/frontend-old/node_modules/@firebase/ai/dist/esm/src/websocket.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'frontend-old/node_modules/@firebase/ai/dist/esm/src/websocket.d.ts')
-rw-r--r--frontend-old/node_modules/@firebase/ai/dist/esm/src/websocket.d.ts67
1 files changed, 67 insertions, 0 deletions
diff --git a/frontend-old/node_modules/@firebase/ai/dist/esm/src/websocket.d.ts b/frontend-old/node_modules/@firebase/ai/dist/esm/src/websocket.d.ts
new file mode 100644
index 0000000..e2d511c
--- /dev/null
+++ b/frontend-old/node_modules/@firebase/ai/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>;
+}