@openai/agents-realtime 0.0.1

package/dist/utils.mjs

@@ -0,0 +1,183 @@
+import METADATA from "./metadata.mjs";
+/**
+ * Converts a base64 string to an ArrayBuffer
+ * @param {string} base64
+ * @returns {ArrayBuffer}
+ */
+export function base64ToArrayBuffer(base64) {
+    const binaryString = atob(base64);
+    const len = binaryString.length;
+    const bytes = new Uint8Array(len);
+    for (let i = 0; i < len; i++) {
+        bytes[i] = binaryString.charCodeAt(i);
+    }
+    return bytes.buffer;
+}
+/**
+ * Converts an ArrayBuffer to a base64 string
+ * @param {ArrayBuffer} arrayBuffer
+ * @returns {string}
+ */
+export function arrayBufferToBase64(arrayBuffer) {
+    const binaryString = String.fromCharCode(...new Uint8Array(arrayBuffer));
+    return btoa(binaryString);
+}
+/**
+ * Get the last text from an audio output message
+ * @param item
+ * @returns
+ */
+export function getLastTextFromAudioOutputMessage(item) {
+    if (typeof item === 'undefined' ||
+        item === null ||
+        typeof item !== 'object' ||
+        !('type' in item) ||
+        typeof item.type !== 'string' ||
+        !item.type) {
+        return undefined;
+    }
+    if (item.type !== 'message') {
+        return undefined;
+    }
+    if (!('content' in item) ||
+        !Array.isArray(item.content) ||
+        item.content.length < 1) {
+        return undefined;
+    }
+    const lastContentItem = item.content[item.content.length - 1];
+    if (!('type' in lastContentItem) ||
+        typeof lastContentItem.type !== 'string') {
+        return undefined;
+    }
+    if (lastContentItem.type === 'text') {
+        return typeof lastContentItem.text === 'string'
+            ? lastContentItem.text
+            : undefined;
+    }
+    if (lastContentItem.type === 'audio') {
+        return typeof lastContentItem.transcript === 'string'
+            ? lastContentItem.transcript
+            : undefined;
+    }
+    return undefined;
+}
+/**
+ * Compare two conversation histories to determine the removals, additions, and updates.
+ * @param oldHistory - The old history.
+ * @param newHistory - The new history.
+ * @returns A diff of the two histories.
+ */
+export function diffRealtimeHistory(oldHistory, newHistory) {
+    const removals = oldHistory.filter((item) => !newHistory.some((newItem) => newItem.itemId === item.itemId));
+    const additions = newHistory.filter((item) => !oldHistory.some((oldItem) => oldItem.itemId === item.itemId));
+    const updates = newHistory.filter((item) => oldHistory.some((oldItem) => oldItem.itemId === item.itemId &&
+        JSON.stringify(oldItem) !== JSON.stringify(item)));
+    return {
+        removals,
+        additions,
+        updates,
+    };
+}
+/**
+ * Check if the browser supports WebRTC.
+ * @returns True if WebRTC is supported, false otherwise.
+ */
+export function hasWebRTCSupport() {
+    if (typeof window === 'undefined') {
+        return false;
+    }
+    return typeof window['RTCPeerConnection'] !== 'undefined';
+}
+/**
+ * Removes the audio data from all content in a message by setting it to null.
+ * @param item
+ * @returns
+ */
+export function removeAudioFromContent(item) {
+    if (item.role === 'system') {
+        return item;
+    }
+    if (item.role === 'assistant') {
+        return {
+            ...item,
+            content: item.content.map((entry) => {
+                if (entry.type === 'audio') {
+                    return {
+                        ...entry,
+                        audio: null,
+                    };
+                }
+                return entry;
+            }),
+        };
+    }
+    if (item.role === 'user') {
+        return {
+            ...item,
+            content: item.content.map((entry) => {
+                if (entry.type === 'input_audio') {
+                    return {
+                        ...entry,
+                        audio: null,
+                    };
+                }
+                return entry;
+            }),
+        };
+    }
+    return item;
+}
+/**
+ * Updates the realtime history array based on the incoming event and options.
+ * @param history - The current history array.
+ * @param event - The event to process (RealtimeItem).
+ * @param shouldIncludeAudioData - Whether to include audio data in message items.
+ * @returns The updated history array.
+ */
+export function updateRealtimeHistory(history, event, shouldIncludeAudioData) {
+    const newEvent = !shouldIncludeAudioData && event.type === 'message'
+        ? removeAudioFromContent(event)
+        : event;
+    const existingIndex = history.findIndex((item) => item.itemId === event.itemId);
+    if (existingIndex !== -1) {
+        // Update existing item
+        return history.map((item, idx) => {
+            if (idx === existingIndex) {
+                return newEvent;
+            }
+            if (!shouldIncludeAudioData && item.type === 'message') {
+                return removeAudioFromContent(item);
+            }
+            return item;
+        });
+    }
+    else if (event.previousItemId) {
+        // Insert after previousItemId if found, else at end
+        const prevIndex = history.findIndex((item) => item.itemId === event.previousItemId);
+        if (prevIndex !== -1) {
+            return [
+                ...history.slice(0, prevIndex + 1),
+                newEvent,
+                ...history.slice(prevIndex + 1),
+            ];
+        }
+        else {
+            return [...history, newEvent];
+        }
+    }
+    else {
+        return [...history, newEvent];
+    }
+}
+/**
+ * The headers to use for the Realtime API.
+ */
+export const HEADERS = {
+    'User-Agent': `Agents/JavaScript ${METADATA.version}`,
+    'X-OpenAI-Agents-SDK': `openai-agents-sdk.${METADATA.version}`,
+};
+/**
+ * Browser websocket header
+ */
+export const WEBSOCKET_META = `openai-agents-sdk.${METADATA.version}`;
+//# sourceMappingURL=utils.mjs.map

package/dist/utils.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.mjs","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"OACO,QAAQ;AAEf;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAc;IAChD,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;IAClC,MAAM,GAAG,GAAG,YAAY,CAAC,MAAM,CAAC;IAChC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;IAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC7B,KAAK,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,KAAK,CAAC,MAAM,CAAC;AACtB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,WAAwB;IAC1D,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,IAAI,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;IACzE,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC;AAC5B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iCAAiC,CAC/C,IAAa;IAEb,IACE,OAAO,IAAI,KAAK,WAAW;QAC3B,IAAI,KAAK,IAAI;QACb,OAAO,IAAI,KAAK,QAAQ;QACxB,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC;QACjB,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ;QAC7B,CAAC,IAAI,CAAC,IAAI,EACV,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IACE,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC;QACpB,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EACvB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAE9D,IACE,CAAC,CAAC,MAAM,IAAI,eAAe,CAAC;QAC5B,OAAO,eAAe,CAAC,IAAI,KAAK,QAAQ,EACxC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,eAAe,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QACpC,OAAO,OAAO,eAAe,CAAC,IAAI,KAAK,QAAQ;YAC7C,CAAC,CAAC,eAAe,CAAC,IAAI;YACtB,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAED,IAAI,eAAe,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QACrC,OAAO,OAAO,eAAe,CAAC,UAAU,KAAK,QAAQ;YACnD,CAAC,CAAC,eAAe,CAAC,UAAU;YAC5B,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAQD;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,UAA0B,EAC1B,UAA0B;IAE1B,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,CAChC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,CACxE,CAAC;IACF,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CACjC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,CAAC,CACxE,CAAC;IACF,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CACzC,UAAU,CAAC,IAAI,CACb,CAAC,OAAO,EAAE,EAAE,CACV,OAAO,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM;QAC9B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CACnD,CACF,CAAC;IACF,OAAO;QACL,QAAQ;QACR,SAAS;QACT,OAAO;KACR,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB;IAC9B,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;QAClC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,OAAO,MAAM,CAAC,mBAAmB,CAAC,KAAK,WAAW,CAAC;AAC5D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CACpC,IAAyB;IAEzB,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QAC9B,OAAO;YACL,GAAG,IAAI;YACP,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;gBAClC,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;oBAC3B,OAAO;wBACL,GAAG,KAAK;wBACR,KAAK,EAAE,IAAI;qBACZ,CAAC;gBACJ,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC,CAAC;SACH,CAAC;IACJ,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QACzB,OAAO;YACL,GAAG,IAAI;YACP,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;gBAClC,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;oBACjC,OAAO;wBACL,GAAG,KAAK;wBACR,KAAK,EAAE,IAAI;qBACZ,CAAC;gBACJ,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC,CAAC;SACH,CAAC;IACJ,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CACnC,OAAuB,EACvB,KAAmB,EACnB,sBAA+B;IAE/B,MAAM,QAAQ,GACZ,CAAC,sBAAsB,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS;QACjD,CAAC,CAAC,sBAAsB,CAAC,KAAY,CAAC;QACtC,CAAC,CAAC,KAAK,CAAC;IAEZ,MAAM,aAAa,GAAG,OAAO,CAAC,SAAS,CACrC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,CACvC,CAAC;IAEF,IAAI,aAAa,KAAK,CAAC,CAAC,EAAE,CAAC;QACzB,uBAAuB;QACvB,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YAC/B,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;gBAC1B,OAAO,QAAQ,CAAC;YAClB,CAAC;YACD,IAAI,CAAC,sBAAsB,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBACvD,OAAO,sBAAsB,CAAC,IAAW,CAAC,CAAC;YAC7C,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;SAAM,IAAK,KAAa,CAAC,cAAc,EAAE,CAAC;QACzC,oDAAoD;QACpD,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CACjC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAM,KAAa,CAAC,cAAc,CACxD,CAAC;QACF,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC;YACrB,OAAO;gBACL,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC;gBAClC,QAAQ;gBACR,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC;aAChC,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,OAAO,EAAE,QAAQ,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,GAAG,OAAO,EAAE,QAAQ,CAAC,CAAC;IAChC,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,YAAY,EAAE,qBAAqB,QAAQ,CAAC,OAAO,EAAE;IACrD,qBAAqB,EAAE,qBAAqB,QAAQ,CAAC,OAAO,EAAE;CAC/D,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,qBAAqB,QAAQ,CAAC,OAAO,EAAE,CAAC"}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@openai/agents-realtime",
+  "repository": "https://github.com/openai/openai-agents-js",
+  "homepage": "https://openai.github.io/openai-agents-js/",
+  "version": "0.0.1",
+  "description": "The OpenAI Agents SDK is a lightweight yet powerful framework for building multi-agent workflows. This package contains the logic for building realtime voice agents on the server or in the browser.",
+  "author": "OpenAI <support@openai.com>",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "browser": "./dist/bundle/openai-realtime-agents.umd.cjs",
+  "exports": {
+    ".": {
+      "browser": {
+        "require": "./dist/index.js",
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.mjs"
+    },
+    "./_shims": {
+      "browser": {
+        "require": "./dist/shims/shims-browser.js",
+        "types": "./dist/shims/shims-browser.d.ts",
+        "default": "./dist/shims/shims-browser.mjs"
+      },
+      "node": {
+        "require": "./dist/shims/shims-node.js",
+        "types": "./dist/shims/shims-node.d.ts",
+        "default": "./dist/shims/shims-node.mjs"
+      },
+      "require": {
+        "types": "./dist/shims/shims-node.d.ts",
+        "default": "./dist/shims/shims-node.js"
+      },
+      "types": "./dist/shims/shims-node.d.ts",
+      "default": "./dist/shims/shims-node.mjs"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "_shims": [
+        "dist/shims/shims-node.d.ts"
+      ]
+    }
+  },
+  "dependencies": {
+    "@types/ws": "^8.18.1",
+    "debug": "^4.4.0",
+    "ws": "^8.18.1",
+    "@openai/agents-core": "0.0.1"
+  },
+  "keywords": [
+    "openai",
+    "agents",
+    "ai",
+    "agentic"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "@types/debug": "^4.1.12",
+    "vite": "^6.3.5"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prebuild": "tsx ../../scripts/embedMeta.ts",
+    "build": "tsc",
+    "build-check": "tsc --noEmit -p ./tsconfig.test.json",
+    "bundle": "vite build"
+  }
+}