@cartesia/cartesia-js 0.0.3 → 0.0.4-alpha.0

package/dist/types/index.js

@@ -1,18 +1 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/types/index.ts
-var types_exports = {};
-module.exports = __toCommonJS(types_exports);
+import "../chunk-FXPGR372.js";

package/package.json

@@ -4,21 +4,24 @@
 		"name": "Cartesia",
 		"url": "https://cartesia.ai"
 	},
-	"version": "0.0.3",
+	"version": "0.0.4-alpha.0",
 	"description": "Client for the Cartesia API.",
-	"main": "./dist/index.js",
-	"module": "./dist/index.mjs",
+	"type": "module",
+	"module": "./dist/index.js",
 	"types": "./dist/index.d.ts",
 	"exports": {
 		".": {
-			"import": "./dist/index.mjs",
-			"require": "./dist/index.js"
+			"import": "./dist/index.js",
+			"require": "./dist/index.cjs"
 		},
 		"./react": {
-			"import": "./dist/react/index.mjs",
-			"require": "./dist/react/index.js"
+			"import": "./dist/react/index.js",
+			"require": "./dist/react/index.cjs"
 		}
 	},
+	"engines": {
+		"node": ">=18"
+	},
 	"dependencies": {
 		"base64-js": "^1.5.1",
 		"emittery": "^1.0.3",

package/src/audio/index.ts

@@ -24,6 +24,11 @@ export type StreamEventData = {
 		chunks: Chunk[];
 	};
 	message: unknown;
+	buffering: never;
+	buffered: never;
+	scheduled: {
+		playbackEndsIn: number;
+	};
 };
 export type ConnectionEventData = {
 	open: never;
@@ -166,11 +171,13 @@ export default class extends Client {
 				startNextPlaybackAt = context.currentTime;
 
 				if (isComplete(chunks) || streamCompleteController.signal.aborted) {
+					emitter.emit("buffered");
 					playChunks(chunks);
 					return true; // Done playing.
 				}
 
 				if (getBufferDuration(chunks) > bufferDuration) {
+					emitter.emit("buffered");
 					// Play the initial chunks that we already have.
 					playChunks(chunks);
 					// If the stream is not complete, play new chunks as they
@@ -182,15 +189,23 @@ export default class extends Client {
 					}
 					return true; // Done playing.
 				}
+				emitter.emit("buffering");
 				return false; // Need to buffer more audio.
 			};
 
 			if (!(await tryStart(chunks))) {
 				for await (const { chunks } of emitter.events("chunk")) {
 					if (await tryStart(chunks)) {
+						const playbackEndsIn =
+							Math.max(0, startNextPlaybackAt - context.currentTime) * 1000;
+						emitter.emit("scheduled", { playbackEndsIn });
 						break;
 					}
 				}
+			} else {
+				const playbackEndsIn =
+					Math.max(0, startNextPlaybackAt - context.currentTime) * 1000;
+				emitter.emit("scheduled", { playbackEndsIn });
 			}
 		};
 

package/src/index.ts

@@ -0,0 +1,3 @@
+export { Cartesia as default } from "./lib";
+export * from "./lib";
+export * from "./types";

package/src/react/index.ts

@@ -2,6 +2,7 @@ import { useCallback, useEffect, useMemo, useRef, useState } from "react";
 import CartesiaAudio, { type Chunk, type StreamEventData } from "../audio";
 import { base64ToArray, bufferToWav } from "../audio/utils";
 import { SAMPLE_RATE } from "../lib/constants";
+import { pingServer } from "./utils";
 
 export type UseAudioOptions = {
 	apiKey: string | null;
@@ -15,6 +16,7 @@ interface UseAudioReturn {
 	isPlaying: boolean;
 	isConnected: boolean;
 	isStreamed: boolean;
+	isBuffering: boolean;
 	chunks: Chunk[];
 	messages: StreamEventData["message"][];
 }
@@ -30,6 +32,7 @@ export function useAudio({ apiKey, baseUrl }: UseAudioOptions): UseAudioReturn {
 			isConnected: false,
 			isPlaying: false,
 			isStreamed: false,
+			isBuffering: false,
 			chunks: [],
 			messages: [],
 		};
@@ -45,12 +48,16 @@ export function useAudio({ apiKey, baseUrl }: UseAudioOptions): UseAudioReturn {
 	const streamReturn = useRef<ReturnType<CartesiaAudio["stream"]> | null>(null);
 	const [isStreamed, setIsStreamed] = useState(false);
 	const [isPlaying, setIsPlaying] = useState(false);
+	const [isBuffering, setIsBuffering] = useState(false);
 	const [isConnected, setIsConnected] = useState(false);
 	const [chunks, setChunks] = useState<Chunk[]>([]);
 	const [messages, setMessages] = useState<StreamEventData["message"][]>([]);
 
+	const latencyEndpoint = "https://api.cartesia.ai";
+
 	const stream = useCallback(
 		async (options: object) => {
+			setIsStreamed(false);
 			streamReturn.current = audio?.stream(options) ?? null;
 			if (!streamReturn.current) {
 				return;
@@ -92,6 +99,9 @@ export function useAudio({ apiKey, baseUrl }: UseAudioOptions): UseAudioReturn {
 					return;
 				}
 				setIsConnected(true);
+				connection.on("open", () => {
+					setIsConnected(true);
+				});
 				const unsubscribe = connection.on("close", () => {
 					setIsConnected(false);
 				});
@@ -109,17 +119,44 @@ export function useAudio({ apiKey, baseUrl }: UseAudioOptions): UseAudioReturn {
 		return () => cleanup?.();
 	}, [audio]);
 
-	const play = useCallback(
-		async (bufferDuration = 0) => {
-			if (isPlaying || !streamReturn.current) {
-				return;
+	const play = useCallback(async () => {
+		if (isPlaying || !streamReturn.current) {
+			return;
+		}
+		setIsPlaying(true);
+		const ping = await pingServer(latencyEndpoint);
+		let bufferingTimeout: ReturnType<typeof setTimeout> | null;
+
+		let bufferDuration: number;
+		if (ping < 300) {
+			bufferDuration = 0; // No buffering for very low latency
+		} else if (ping > 1500) {
+			bufferDuration = 6; // Max buffering for very high latency (6 seconds)
+		} else {
+			bufferDuration = (ping / 1000) * 4; // Adjust buffer duration based on ping
+		}
+
+		streamReturn.current.once("buffering").then(() => {
+			bufferingTimeout = setTimeout(() => {
+				setIsBuffering(true);
+			}, 250); // Delay for 250ms before showing buffering indicator
+		});
+		streamReturn.current.once("buffered").then(() => {
+			if (bufferingTimeout) {
+				clearTimeout(bufferingTimeout); // Clear the timeout if buffering completes before 500ms
 			}
-			setIsPlaying(true);
-			await streamReturn.current?.play({ bufferDuration });
-			setIsPlaying(false);
-		},
-		[isPlaying],
-	);
+			setIsBuffering(false);
+		});
+
+		// Wait for the playback to finish before setting isPlaying to false
+		streamReturn.current.once("scheduled").then((data) => {
+			setTimeout(() => {
+				setIsPlaying(false);
+			}, data.playbackEndsIn);
+		});
+
+		await streamReturn.current?.play({ bufferDuration });
+	}, [isPlaying]);
 
 	// TODO:
 	// - [] Pause and stop playback.
@@ -134,6 +171,7 @@ export function useAudio({ apiKey, baseUrl }: UseAudioOptions): UseAudioReturn {
 		isPlaying,
 		isConnected,
 		isStreamed,
+		isBuffering,
 		chunks,
 		messages,
 	};

package/src/react/utils.ts

@@ -0,0 +1,11 @@
+/**
+ * Ping the server to calculate the round-trip time. This is useful for buffering audio in high-latency environments.
+ * @param url The URL to ping.
+ */
+
+export async function pingServer(url: string): Promise<number> {
+	const start = new Date().getTime();
+	await fetch(url);
+	const end = new Date().getTime();
+	return end - start;
+}

package/dist/audio/index.d.mts

@@ -1,5 +0,0 @@
-import 'emittery';
-import 'partysocket';
-import '../lib/client.mjs';
-export { C as Chunk, l as ConnectionEventData, S as StreamEventData, m as StreamRequest, e as default } from '../index-DSBmfK9-.mjs';
-import '../types/index.mjs';

package/dist/audio/index.mjs

@@ -1,9 +0,0 @@
-import {
-  audio_default
-} from "../chunk-3CYTAFLF.mjs";
-import "../chunk-FRIBQZPN.mjs";
-import "../chunk-XSFPHPPG.mjs";
-import "../chunk-HNLIBHEN.mjs";
-export {
-  audio_default as default
-};

package/dist/audio/utils.mjs

@@ -1,25 +0,0 @@
-import {
-  base64ToArray,
-  bufferToWav,
-  createMessageHandlerForContextId,
-  filterSentinel,
-  getBufferDuration,
-  getEmitteryCallbacks,
-  getSentinel,
-  isComplete,
-  isSentinel,
-  playAudioBuffer
-} from "../chunk-FRIBQZPN.mjs";
-import "../chunk-HNLIBHEN.mjs";
-export {
-  base64ToArray,
-  bufferToWav,
-  createMessageHandlerForContextId,
-  filterSentinel,
-  getBufferDuration,
-  getEmitteryCallbacks,
-  getSentinel,
-  isComplete,
-  isSentinel,
-  playAudioBuffer
-};

package/dist/lib/client.mjs

@@ -1,7 +0,0 @@
-import {
-  Client
-} from "../chunk-XSFPHPPG.mjs";
-import "../chunk-HNLIBHEN.mjs";
-export {
-  Client
-};

package/dist/lib/constants.mjs

@@ -1,10 +0,0 @@
-import {
-  BASE_URL,
-  SAMPLE_RATE,
-  constructWebsocketUrl
-} from "../chunk-HNLIBHEN.mjs";
-export {
-  BASE_URL,
-  SAMPLE_RATE,
-  constructWebsocketUrl
-};

package/dist/react/index.mjs

@@ -1,130 +0,0 @@
-import {
-  audio_default
-} from "../chunk-3CYTAFLF.mjs";
-import {
-  base64ToArray,
-  bufferToWav
-} from "../chunk-FRIBQZPN.mjs";
-import "../chunk-XSFPHPPG.mjs";
-import {
-  SAMPLE_RATE,
-  __async
-} from "../chunk-HNLIBHEN.mjs";
-
-// src/react/index.ts
-import { useCallback, useEffect, useMemo, useRef, useState } from "react";
-function useAudio({ apiKey, baseUrl }) {
-  if (typeof window === "undefined") {
-    return {
-      stream: () => {
-      },
-      play: () => __async(this, null, function* () {
-      }),
-      download: () => null,
-      isConnected: false,
-      isPlaying: false,
-      isStreamed: false,
-      chunks: [],
-      messages: []
-    };
-  }
-  const audio = useMemo(() => {
-    if (!apiKey) {
-      return null;
-    }
-    const audio2 = new audio_default({ apiKey, baseUrl });
-    return audio2;
-  }, [apiKey, baseUrl]);
-  const streamReturn = useRef(null);
-  const [isStreamed, setIsStreamed] = useState(false);
-  const [isPlaying, setIsPlaying] = useState(false);
-  const [isConnected, setIsConnected] = useState(false);
-  const [chunks, setChunks] = useState([]);
-  const [messages, setMessages] = useState([]);
-  const stream = useCallback(
-    (options) => __async(this, null, function* () {
-      var _a;
-      streamReturn.current = (_a = audio == null ? void 0 : audio.stream(options)) != null ? _a : null;
-      if (!streamReturn.current) {
-        return;
-      }
-      setMessages([]);
-      streamReturn.current.on(
-        "chunk",
-        ({ chunks: chunks3 }) => {
-          setChunks(chunks3);
-        }
-      );
-      streamReturn.current.on(
-        "message",
-        (message) => {
-          setMessages((messages2) => [...messages2, message]);
-        }
-      );
-      const { chunks: chunks2 } = yield streamReturn.current.once("streamed");
-      setChunks(chunks2);
-      setIsStreamed(true);
-    }),
-    [audio]
-  );
-  const download = useCallback(() => {
-    if (!isStreamed) {
-      return null;
-    }
-    const audio2 = bufferToWav(SAMPLE_RATE, [base64ToArray(chunks)]);
-    return new Blob([audio2], { type: "audio/wav" });
-  }, [isStreamed, chunks]);
-  useEffect(() => {
-    let cleanup = () => {
-    };
-    function setupConnection() {
-      return __async(this, null, function* () {
-        try {
-          const connection = yield audio == null ? void 0 : audio.connect();
-          if (!connection) {
-            return;
-          }
-          setIsConnected(true);
-          const unsubscribe = connection.on("close", () => {
-            setIsConnected(false);
-          });
-          return () => {
-            unsubscribe();
-            audio == null ? void 0 : audio.disconnect();
-          };
-        } catch (e) {
-          console.error(e);
-        }
-      });
-    }
-    setupConnection().then((cleanupConnection) => {
-      cleanup = cleanupConnection;
-    });
-    return () => cleanup == null ? void 0 : cleanup();
-  }, [audio]);
-  const play = useCallback(
-    (bufferDuration = 0) => __async(this, null, function* () {
-      var _a;
-      if (isPlaying || !streamReturn.current) {
-        return;
-      }
-      setIsPlaying(true);
-      yield (_a = streamReturn.current) == null ? void 0 : _a.play({ bufferDuration });
-      setIsPlaying(false);
-    }),
-    [isPlaying]
-  );
-  return {
-    stream,
-    play,
-    download,
-    isPlaying,
-    isConnected,
-    isStreamed,
-    chunks,
-    messages
-  };
-}
-export {
-  useAudio
-};

package/index.ts

@@ -1,3 +0,0 @@
-export { Cartesia as default } from "./src/lib";
-export * from "./src/lib";
-export * from "./src/types";