@coze/realtime-api 0.0.3 → 1.0.0

package/dist/umd/index.js.LICENSE.txt

@@ -0,0 +1 @@
+/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */

package/package.json

@@ -1,7 +1,18 @@
 {
   "name": "@coze/realtime-api",
-  "version": "0.0.3",
-  "description": "Coze Realtime API",
+  "version": "1.0.0",
+  "description": "A powerful real-time communication SDK for voice interactions with Coze AI bots | 扣子官方实时通信 SDK，用于与 Coze AI bots 进行语音交互",
+  "keywords": [
+    "coze",
+    "ai",
+    "realtime",
+    "voice",
+    "rtc",
+    "asr",
+    "tts",
+    "ai-agent",
+    "voice-synthesis"
+  ],
   "homepage": "https://github.com/coze-dev/coze-js/packages/realtime-api",
   "repository": {
     "type": "git",
@@ -12,10 +23,15 @@
   "author": "jackshen <jackshen310@gmail.com>",
   "type": "module",
   "exports": {
-    ".": "./dist/index.js"
+    ".": {
+      "require": "./dist/cjs/index.cjs",
+      "import": "./dist/esm/index.js",
+      "types": "./dist/types/index.d.ts"
+    }
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.js",
+  "typings": "dist/types/index.d.ts",
   "files": [
     "dist",
     "assets",
@@ -24,24 +40,25 @@
     "README.md"
   ],
   "scripts": {
-    "build": "rm -rf dist && tsc -b tsconfig.build.json",
-    "buildAll": "npm run build && cd examples/realtime-console && npm run build",
-    "demo": "npm run build && cd examples/realtime-console && npm run start",
+    "build": "rm -rf ./dist && rslib build",
+    "buildAll": "npm run build && cd ../../examples/realtime-console && npm run build",
+    "demo": "npm run start & cd ../../examples/realtime-console && npm run start",
     "format": "prettier --write .",
     "lint": "eslint ./ --cache --quiet",
     "prepublishOnly": "npm run build",
-    "start": "rm -rf dist && tsc -b -w tsconfig.build.json",
+    "start": "rm -rf dist && rslib build -w",
     "test": "vitest",
     "test:cov": "vitest --coverage --run"
   },
   "dependencies": {
-    "@coze/api": "1.0.5",
+    "@coze/api": "1.0.10",
     "@volcengine/rtc": "^4.62.1"
   },
   "devDependencies": {
     "@coze-infra/eslint-config": "workspace:*",
     "@coze-infra/ts-config": "workspace:*",
     "@coze-infra/vitest-config": "workspace:*",
+    "@rslib/core": "0.0.18",
     "@swc/core": "^1.3.14",
     "@types/node": "^20",
     "@types/uuid": "^9.0.1",

package/dist/client.js

@@ -1,242 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EngineClient = void 0;
-const extension_ainr_1 = __importDefault(require("@volcengine/rtc/extension-ainr"));
-const rtc_1 = __importStar(require("@volcengine/rtc"));
-const utils_1 = require("./utils");
-const event_handler_1 = require("./event-handler");
-const error_1 = require("./error");
-class EngineClient extends event_handler_1.RealtimeEventHandler {
-    constructor(appId, debug = false, isTestEnv = false) {
-        super(debug);
-        this.joinUserId = '';
-        this._AIAnsExtension = null;
-        if (isTestEnv) {
-            rtc_1.default.setParameter('ICE_CONFIG_REQUEST_URLS', ['rtc-test.bytedance.com']);
-        }
-        this.engine = rtc_1.default.createEngine(appId);
-        this.handleMessage = this.handleMessage.bind(this);
-        this.handleUserJoin = this.handleUserJoin.bind(this);
-        this.handleUserLeave = this.handleUserLeave.bind(this);
-        this.handleEventError = this.handleEventError.bind(this);
-        // Debug only
-        this.handleLocalAudioPropertiesReport =
-            this.handleLocalAudioPropertiesReport.bind(this);
-        this.handleRemoteAudioPropertiesReport =
-            this.handleRemoteAudioPropertiesReport.bind(this);
-    }
-    bindEngineEvents() {
-        this.engine.on(rtc_1.default.events.onUserMessageReceived, this.handleMessage);
-        this.engine.on(rtc_1.default.events.onUserJoined, this.handleUserJoin);
-        this.engine.on(rtc_1.default.events.onUserLeave, this.handleUserLeave);
-        this.engine.on(rtc_1.default.events.onError, this.handleEventError);
-        if (this._debug) {
-            this.engine.on(rtc_1.default.events.onLocalAudioPropertiesReport, this.handleLocalAudioPropertiesReport);
-            this.engine.on(rtc_1.default.events.onRemoteAudioPropertiesReport, this.handleRemoteAudioPropertiesReport);
-        }
-    }
-    removeEventListener() {
-        this.engine.off(rtc_1.default.events.onUserMessageReceived, this.handleMessage);
-        this.engine.off(rtc_1.default.events.onUserJoined, this.handleUserJoin);
-        this.engine.off(rtc_1.default.events.onUserLeave, this.handleUserLeave);
-        this.engine.off(rtc_1.default.events.onError, this.handleEventError);
-        if (this._debug) {
-            this.engine.off(rtc_1.default.events.onLocalAudioPropertiesReport, this.handleLocalAudioPropertiesReport);
-            this.engine.off(rtc_1.default.events.onRemoteAudioPropertiesReport, this.handleRemoteAudioPropertiesReport);
-        }
-    }
-    handleMessage(event) {
-        try {
-            const message = JSON.parse(event.message);
-            this.dispatch(`server.${message.event_type}`, message);
-        }
-        catch (e) {
-            this.dispatch('client.error', {
-                message: `Failed to parse message: ${event.message}`,
-                error: e,
-            });
-        }
-    }
-    handleEventError(e) {
-        this.dispatch('client.error', e);
-    }
-    handleUserJoin(event) {
-        this.joinUserId = event.userInfo.userId;
-        this.dispatch('server.bot.join', event);
-    }
-    handleUserLeave(event) {
-        this.dispatch('server.bot.leave', event);
-    }
-    async joinRoom(options) {
-        const { token, roomId, uid, audioMutedDefault = false } = options;
-        try {
-            await this.engine.joinRoom(token, roomId, {
-                userId: uid,
-            }, {
-                isAutoPublish: !audioMutedDefault,
-                isAutoSubscribeAudio: true,
-                isAutoSubscribeVideo: false,
-            });
-        }
-        catch (e) {
-            if (e instanceof Error) {
-                throw new error_1.RealtimeAPIError(error_1.RealtimeError.CONNECTION_ERROR, e.message);
-            }
-            throw new error_1.RealtimeAPIError(error_1.RealtimeError.CONNECTION_ERROR, 'Unknown error');
-        }
-    }
-    async setAudioInputDevice(deviceId) {
-        const devices = await (0, utils_1.getAudioDevices)();
-        if (devices.audioInputs.findIndex(i => i.deviceId === deviceId) === -1) {
-            throw new error_1.RealtimeAPIError(error_1.RealtimeError.DEVICE_ACCESS_ERROR, `Audio input device not found: ${deviceId}`);
-        }
-        this.engine.stopAudioCapture();
-        await this.engine.startAudioCapture(deviceId);
-    }
-    async setAudioOutputDevice(deviceId) {
-        const devices = await (0, utils_1.getAudioDevices)();
-        if (devices.audioOutputs.findIndex(i => i.deviceId === deviceId) === -1) {
-            throw new error_1.RealtimeAPIError(error_1.RealtimeError.DEVICE_ACCESS_ERROR, `Audio output device not found: ${deviceId}`);
-        }
-        await this.engine.setAudioPlaybackDevice(deviceId);
-    }
-    async createLocalStream() {
-        const devices = await (0, utils_1.getAudioDevices)();
-        if (!devices.audioInputs.length) {
-            throw new error_1.RealtimeAPIError(error_1.RealtimeError.DEVICE_ACCESS_ERROR, 'Failed to get devices');
-        }
-        await this.engine.startAudioCapture(devices.audioInputs[0].deviceId);
-    }
-    async disconnect() {
-        try {
-            await this.engine.stopAudioCapture();
-            await this.engine.unpublishStream(rtc_1.MediaType.AUDIO);
-            await this.engine.leaveRoom();
-            this.removeEventListener();
-        }
-        catch (e) {
-            this.dispatch('client.error', e);
-            throw e;
-        }
-    }
-    async changeAudioState(isMicOn) {
-        try {
-            if (isMicOn) {
-                await this.engine.publishStream(rtc_1.MediaType.AUDIO);
-            }
-            else {
-                await this.engine.unpublishStream(rtc_1.MediaType.AUDIO);
-            }
-        }
-        catch (e) {
-            this.dispatch('client.error', e);
-            throw e;
-        }
-    }
-    async stop() {
-        try {
-            const result = await this.engine.sendUserMessage(this.joinUserId, JSON.stringify({
-                id: 'event_1',
-                event_type: 'conversation.chat.cancel',
-                data: {},
-            }));
-            this._log(`interrupt ${this.joinUserId} ${result}`);
-        }
-        catch (e) {
-            this.dispatch('client.error', e);
-            throw e;
-        }
-    }
-    async sendMessage(message) {
-        try {
-            const result = await this.engine.sendUserMessage(this.joinUserId, JSON.stringify(message));
-            this._log(`sendMessage ${this.joinUserId} ${JSON.stringify(message)} ${result}`);
-        }
-        catch (e) {
-            this.dispatch('client.error', e);
-            throw e;
-        }
-    }
-    enableAudioPropertiesReport(config) {
-        this.engine.enableAudioPropertiesReport(config);
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    handleLocalAudioPropertiesReport(event) {
-        var _a, _b;
-        if (this._debug && ((_b = (_a = event[0]) === null || _a === void 0 ? void 0 : _a.audioPropertiesInfo) === null || _b === void 0 ? void 0 : _b.linearVolume) > 0) {
-            console.log('handleLocalAudioPropertiesReport', event);
-        }
-    }
-    handleRemoteAudioPropertiesReport(event) {
-        if (this._debug) {
-            console.log('handleRemoteAudioPropertiesReport', event);
-        }
-    }
-    async enableAudioNoiseReduction() {
-        var _a;
-        await ((_a = this.engine) === null || _a === void 0 ? void 0 : _a.setAudioCaptureConfig({
-            noiseSuppression: true,
-            echoCancellation: true,
-            autoGainControl: true,
-        }));
-    }
-    async initAIAnsExtension() {
-        const AIAnsExtension = new extension_ainr_1.default();
-        await this.engine.registerExtension(AIAnsExtension);
-        this._AIAnsExtension = AIAnsExtension;
-    }
-    changeAIAnsExtension(enable) {
-        var _a, _b;
-        if (enable) {
-            (_a = this._AIAnsExtension) === null || _a === void 0 ? void 0 : _a.enable();
-        }
-        else {
-            (_b = this._AIAnsExtension) === null || _b === void 0 ? void 0 : _b.disable();
-        }
-    }
-    async startAudioPlaybackDeviceTest() {
-        try {
-            await this.engine.startAudioPlaybackDeviceTest('audio-test.wav', 200);
-        }
-        catch (e) {
-            this.dispatch('client.error', e);
-            throw e;
-        }
-    }
-    stopAudioPlaybackDeviceTest() {
-        try {
-            this.engine.stopAudioPlaybackDeviceTest();
-        }
-        catch (e) {
-            this.dispatch('client.error', e);
-            throw e;
-        }
-    }
-}
-exports.EngineClient = EngineClient;

package/dist/error.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RealtimeAPIError = exports.ErrorMessages = exports.RealtimeError = void 0;
-var RealtimeError;
-(function (RealtimeError) {
-    RealtimeError["DEVICE_ACCESS_ERROR"] = "DEVICE_ACCESS_ERROR";
-    RealtimeError["STREAM_CREATION_ERROR"] = "STREAM_CREATION_ERROR";
-    RealtimeError["CONNECTION_ERROR"] = "CONNECTION_ERROR";
-    RealtimeError["DISCONNECTION_ERROR"] = "DISCONNECTION_ERROR";
-    RealtimeError["INTERRUPT_ERROR"] = "INTERRUPT_ERROR";
-    RealtimeError["EVENT_HANDLER_ERROR"] = "EVENT_HANDLER_ERROR";
-    RealtimeError["PERMISSION_DENIED"] = "PERMISSION_DENIED";
-    RealtimeError["NETWORK_ERROR"] = "NETWORK_ERROR";
-    RealtimeError["INVALID_STATE"] = "INVALID_STATE";
-    RealtimeError["CREATE_ROOM_ERROR"] = "CREATE_ROOM_ERROR";
-})(RealtimeError || (exports.RealtimeError = RealtimeError = {}));
-exports.ErrorMessages = {
-    [RealtimeError.DEVICE_ACCESS_ERROR]: 'Failed to get devices',
-    [RealtimeError.STREAM_CREATION_ERROR]: 'Failed to create local stream',
-    [RealtimeError.CONNECTION_ERROR]: 'Failed to connect',
-    [RealtimeError.DISCONNECTION_ERROR]: 'Failed to disconnect',
-    [RealtimeError.INTERRUPT_ERROR]: 'Failed to interrupt',
-    [RealtimeError.EVENT_HANDLER_ERROR]: 'Event handler not found',
-    [RealtimeError.PERMISSION_DENIED]: 'Permission denied for requested operation',
-    [RealtimeError.NETWORK_ERROR]: 'Network connection error occurred',
-    [RealtimeError.INVALID_STATE]: 'Operation invalid in current state',
-    [RealtimeError.CREATE_ROOM_ERROR]: 'Failed to create room',
-};
-class RealtimeAPIError extends Error {
-    constructor(code, message) {
-        super(`[${code}] ${message}`);
-        this.code = code;
-        this.name = 'RealtimeAPIError';
-    }
-}
-exports.RealtimeAPIError = RealtimeAPIError;

package/dist/event-handler.js

@@ -1,126 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RealtimeEventHandler = exports.EventNames = void 0;
-const error_1 = require("./error");
-var EventNames;
-(function (EventNames) {
-    /**
-     * en: All events
-     * zh: 所有事件
-     */
-    EventNames["ALL"] = "realtime.event";
-    /**
-     * en: All client events
-     * zh: 所有客户端事件
-     */
-    EventNames["ALL_CLIENT"] = "client.*";
-    /**
-     * en: All server events
-     * zh: 所有服务端事件
-     */
-    EventNames["ALL_SERVER"] = "server.*";
-    /**
-     * en: Client connected
-     * zh: 客户端连接
-     */
-    EventNames["CONNECTED"] = "client.connected";
-    /**
-     * en: Client interrupted
-     * zh: 客户端中断
-     */
-    EventNames["INTERRUPTED"] = "client.interrupted";
-    /**
-     * en: Client disconnected
-     * zh: 客户端断开
-     */
-    EventNames["DISCONNECTED"] = "client.disconnected";
-    /**
-     * en: Client audio unmuted
-     * zh: 客户端音频未静音
-     */
-    EventNames["AUDIO_UNMUTED"] = "client.audio.unmuted";
-    /**
-     * en: Client audio muted
-     * zh: 客户端音频静音
-     */
-    EventNames["AUDIO_MUTED"] = "client.audio.muted";
-    /**
-     * en: Client error
-     * zh: 客户端错误
-     */
-    EventNames["ERROR"] = "client.error";
-    /**
-     * en: Audio noise reduction enabled
-     * zh: 抑制平稳噪声
-     */
-    EventNames["SUPPRESS_STATIONARY_NOISE"] = "client.suppress.stationary.noise";
-    /**
-     * en: Suppress non-stationary noise
-     * zh: 抑制非平稳噪声
-     */
-    EventNames["SUPPRESS_NON_STATIONARY_NOISE"] = "client.suppress.non.stationary.noise";
-    /**
-     * en: Audio input device changed
-     * zh: 音频输入设备改变
-     */
-    EventNames["AUDIO_INPUT_DEVICE_CHANGED"] = "client.input.device.changed";
-    /**
-     * en: Audio output device changed
-     * zh: 音频输出设备改变
-     */
-    EventNames["AUDIO_OUTPUT_DEVICE_CHANGED"] = "client.output.device.changed";
-})(EventNames || (exports.EventNames = EventNames = {}));
-class RealtimeEventHandler {
-    constructor(debug = false) {
-        this.eventHandlers = {};
-        this._debug = debug;
-    }
-    clearEventHandlers() {
-        this.eventHandlers = {};
-    }
-    on(eventName, callback) {
-        this._log(`on ${eventName} event`);
-        this.eventHandlers[eventName] = this.eventHandlers[eventName] || [];
-        this.eventHandlers[eventName].push(callback);
-        return callback;
-    }
-    off(eventName, callback) {
-        this._log(`off ${eventName} event`);
-        const handlers = this.eventHandlers[eventName] || [];
-        if (callback) {
-            const index = handlers.indexOf(callback);
-            if (index === -1) {
-                throw new error_1.RealtimeAPIError(error_1.RealtimeError.EVENT_HANDLER_ERROR, `Could not turn off specified event listener for "${eventName}": not found as a listener`);
-            }
-            handlers.splice(index, 1);
-        }
-        else {
-            delete this.eventHandlers[eventName];
-        }
-    }
-    // eslint-disable-next-line max-params
-    _dispatchToHandlers(eventName, event, handlers, prefix) {
-        for (const handler of handlers) {
-            if (!prefix || eventName.startsWith(prefix)) {
-                handler(eventName, event);
-            }
-        }
-    }
-    dispatch(eventName, event) {
-        this._log(`dispatch ${eventName} event`);
-        const handlers = (this.eventHandlers[eventName] || []).slice();
-        this._dispatchToHandlers(eventName, event, handlers);
-        const allHandlers = (this.eventHandlers[EventNames.ALL] || []).slice();
-        this._dispatchToHandlers(eventName, event, allHandlers);
-        const allClientHandlers = (this.eventHandlers[EventNames.ALL_CLIENT] || []).slice();
-        this._dispatchToHandlers(eventName, event, allClientHandlers, 'client.');
-        const allServerHandlers = (this.eventHandlers[EventNames.ALL_SERVER] || []).slice();
-        this._dispatchToHandlers(eventName, event, allServerHandlers, 'server.');
-    }
-    _log(message) {
-        if (this._debug) {
-            console.log(`[RealtimeClient] ${message}`);
-        }
-    }
-}
-exports.RealtimeEventHandler = RealtimeEventHandler;