@mingto/xunfei-lat 2.2.5

package/README.md

@@ -0,0 +1,234 @@
+# @minto-ai/xunfei-lat
+
+一个用于音频录制、处理、分割和通过网络请求发送音频数据的语音处理库。
+
+## 安装
+
+```bash
+pnpm install @minto-ai/xunfei-lat
+```
+
+## 使用
+
+### 配置系统参数
+
+配置必要的系统参数，这些参数通常在讯飞开放平台申请：
+
+```javascript
+/**
+ * 平台系统配置
+ */
+const systemConfig = {
+  /**
+   * 在平台申请的密钥信息
+   */
+  API_SECRET: 'your_api_secret',
+  /**
+   * 在平台申请的APPID信息
+   */
+  APPID: 'your_appid',
+  /**
+   * 在平台申请的API_KEY信息
+   */
+  API_KEY: 'your_api_key'
+}
+
+// 配置系统参数
+LatController.config(systemConfig)
+```
+
+### 创建实例
+
+创建 `LatController` 实例，并配置业务参数：
+
+```javascript
+/**
+ * 创建LatController实例
+ */
+const BusinessParams = {
+  /**
+   * 语种
+   * - 'zh_cn': 中文（支持简单的英文识别）
+   * - 'en_us': 英文
+   * - 其他小语种参数值需在控制台添加试用或购买后显示
+   */
+  language: 'zh_cn',
+
+  /**
+   * 应用领域
+   * - 'iat': 日常用语
+   * - 'medical': 医疗
+   * - 'gov-seat-assistant': 政务坐席助手
+   * - 'seat-assistant': 金融坐席助手
+   * - 'gov-ansys': 政务语音分析
+   * - 'gov-nav': 政务语音导航
+   * - 'fin-nav': 金融语音导航
+   * - 'fin-ansys': 金融语音分析
+   */
+  domain: 'iat',
+
+  /**
+   * 方言，当前仅在language为中文时，支持方言选择。
+   * - 'mandarin': 中文普通话、其他语种
+   * - 其他方言参数值需在控制台添加试用或购买后显示
+   */
+  accent: 'mandarin',
+
+  /**
+   * 用于设置后端点检测的静默时间，单位是毫秒。
+   * 默认2000（小语种除外，小语种不设置该参数默认为未开启VAD）。
+   */
+  vad_eos: 3600000,
+
+  /**
+   * 动态修正（仅中文普通话支持）
+   * - 'wpgs': 开启流式结果返回功能
+   */
+  dwa: 'wpgs',
+
+  /**
+   * 领域个性化参数（仅中文支持）
+   * - 'game': 游戏
+   * - 'health': 健康
+   * - 'shopping': 购物
+   * - 'trip': 旅行
+   */
+  pd: 'game',
+
+  /**
+   * 是否开启标点符号添加（仅中文支持）
+   * - 1: 开启（默认值）
+   * - 0: 关闭
+   */
+  ptt: 1,
+
+  /**
+   * 字体（仅中文支持）
+   * - 'zh-cn': 简体中文（默认值）
+   * - 'zh-hk': 繁体香港
+   */
+  rlang: 'zh-cn',
+
+  /**
+   * 返回子句结果对应的起始和结束的端点帧偏移值。
+   * - 0: 关闭（默认值）
+   * - 1: 开启
+   */
+  vinfo: 0,
+
+  /**
+   * 数字格式规则为阿拉伯数字格式（中文普通话和日语支持）
+   * - 0: 关闭
+   * - 1: 开启（默认值）
+   */
+  nunum: 1,
+
+  /**
+   * speex音频帧长，仅在speex音频时使用
+   * - 1: 当speex编码为标准开源speex编码时必须指定
+   * - 2: 当speex编码为讯飞定制speex编码时不要设置
+   */
+  speex_size: 1,
+
+  /**
+   * 获取在发音相似时的句子多侯选结果。
+   * 取值范围[1,5]，设置多候选会影响性能，响应时间延迟200ms左右。
+   */
+  nbest: 1,
+
+  /**
+   * 获取在发音相似时的词语多侯选结果。
+   * 取值范围[1,5]，设置多候选会影响性能，响应时间延迟200ms左右。
+   */
+  wbest: 1
+}
+
+/**
+ *
+ */
+const sectionDelayParams = {
+
+  /**
+   * 是否自动控制延迟
+   */
+  autoControl: true,
+
+  /**
+   * 第一次延迟时间
+   */
+  initialDelay: 3000,
+
+  /**
+   * 后续延迟时间
+   */
+  subsequentDelay: 1000,
+}
+
+const latInstance = LatController.create(BusinessParams, sectionDelayParams)
+```
+
+### 可用方法
+
+#### 开始录音
+
+```js
+latInstance.start()
+```
+
+#### 智能语音监听
+
+```js
+latInstance.watch()
+```
+
+监听浏览器音频输入，当检测到音量大于20%且系统处于离线状态时自动启动录音和识别。
+
+#### 结束录音
+
+```js
+latController.finish()
+```
+
+### 应用钩子
+
+应用钩子事件允许您在特定时刻执行自定义逻辑。
+
+| 钩子名称          | 触发时机                           | 描述                           |
+| :---------------- | :--------------------------------- | :----------------------------- |
+| `appFinish`       | 应用被停止时触发。                 | 应用的所有处理器都已停止运行。 |
+| `appResultText`   | 识别结果事件触发。                 | 处理识别到的文本结果。         |
+| `appResponseText` | 单词识别触发，也就是应用过程中触发 |
+
+#### `appFinish`
+
+当应用的所有处理器完成工作，应用被停止时，此事件被触发：
+
+```javascript
+latInstance.on('appFinish', () => {
+  console.log('应用已停止运行，所有处理器均已完成工作。')
+})
+```
+
+#### `appResultText`
+
+当应用处理并识别出文本结果时，此事件被触发：
+
+```javascript
+latInstance.on('appResultText', () => {
+  console.log('应用已输出识别到的文本结果。')
+})
+```
+
+#### `appResponseText`
+
+当应用过程中触发，也就是应用过程中触发
+
+```javascript
+latInstance.on('appResponseText', () => {
+  console.log('应用已输出识别到的文本结果。')
+})
+```
+
+## 注意
+
+本工具库为内部工具库，不负责改BUG，请勿随便下载。

package/dist/handler/components/index.d.ts

@@ -0,0 +1,3 @@
+import { default as ParallelHandler } from './parallel-handler';
+import { default as SerialHandler } from './serial-handler';
+export { ParallelHandler, SerialHandler, };

package/dist/handler/components/parallel-handler.d.ts

@@ -0,0 +1,76 @@
+import { ParallelTaskItem, ParallelHandlerStatus } from '../types';
+import { BaseHandler } from '../core';
+/**
+ * 并行任务处理器 - 并行处理队列中的任务
+ *
+ * 特点：
+ * - 支持并行执行任务
+ * - 支持任务执行前的自定义条件检查
+ * - 实现完整的生命周期管理（激活、待机、执行、成功、销毁）
+ * - 可与其他处理器组成处理链
+ *
+ * 使用场景：
+ * - 需要并行执行的任务处理
+ * - 资源充足且任务独立的场景
+ */
+declare abstract class ParallelFactory<O, R> extends BaseHandler<O, R> {
+    /**
+     * 获取待处理任务数量
+     */
+    protected taskQueue: Array<ParallelTaskItem<O>>;
+    /**
+     * 当前处理器状态
+     */
+    handlerStatus: ParallelHandlerStatus;
+    /**
+     * 当前正在执行的任务ID数组
+     */
+    protected executingTaskIds: string[];
+    /**
+     * 待处理任务队列
+     */
+    get taskQueueLength(): number;
+    constructor();
+    /**
+     * 检查任务执行条件
+     * 子类可重写此方法，实现自定义的任务执行前置条件检查
+     *
+     * @returns {boolean} - 当满足执行条件时返回 true，否则返回 false
+     */
+    executePreCheck(): boolean;
+    /**
+     * 触发处理器激活行为（空闲状态 => 激活状态）
+     */
+    triggerHandlerActive(): void;
+    /**
+     *  触发处理器待机行为（激活状态 => 待执行状态）
+     */
+    triggerHandlerPending(): void;
+    /**
+     * 触发处理器执行行为（激活状态 => 执行状态）
+     */
+    triggerHandlerExecute(): Promise<void>;
+    handle(original: O): void;
+    /**
+     * 处理队列
+     */
+    taskCompletedCallback(uuid: string): void;
+    /**
+     * 批量处理任务完成回调
+     * 清空当前记录的执行任务ID数组，并标记所有相关任务为已完成
+     */
+    batchTaskCompletedCallback(isLastExecute?: boolean): void;
+    /**
+     * 触发处理器成功行为（执行状态 => 成功状态）
+     */
+    triggerHandlerCompleted(): void;
+    /**
+     * 触发处理器销毁行为（待机状态 => 销毁状态）
+     */
+    triggerHandlerFinish(): void;
+    /**
+     * 触发应用被销毁行为
+     */
+    triggerAppFinish(): void;
+}
+export default ParallelFactory;

package/dist/handler/components/serial-handler.d.ts

@@ -0,0 +1,68 @@
+import { SerialTaskItem, SerialHandlerStatus } from '../types';
+import { BaseHandler } from '../core';
+/**
+ * 串行任务处理器 - 按顺序处理队列中的任务
+ *
+ * 特点：
+ * - 使用先进先出(FIFO)队列管理待处理任务
+ * - 支持任务执行前的自定义条件检查
+ * - 实现完整的生命周期管理（激活、待机、执行、成功、销毁）
+ * - 可与其他处理器组成处理链
+ *
+ * 使用场景：
+ * - 需要顺序执行的任务处理
+ * - 资源有限需要排队执行的场景
+ * - 需要严格控制执行顺序的业务流程
+ */
+declare abstract class SerialHandler<O, R> extends BaseHandler<O, R> {
+    /**
+     * 待处理任务队列
+     */
+    protected taskQueue: Array<SerialTaskItem<O>>;
+    /**
+     * 当前处理器状态
+     */
+    handlerStatus: SerialHandlerStatus;
+    /**
+     * 获取待处理任务数量
+     */
+    get taskQueueLength(): number;
+    constructor();
+    /**
+     * 检查任务执行条件
+     * 子类可重写此方法，实现自定义的任务执行前置条件检查
+     *
+     * @returns {boolean} - 当满足执行条件时返回 true，否则返回 false
+     */
+    executePreCheck(): boolean;
+    /**
+     * 触发处理器激活行为（空闲状态 => 激活状态）
+     */
+    triggerHandlerActive(): void;
+    /**
+     *  触发处理器待机行为（激活状态 => 待执行状态   执行状态 => 待执行状态）
+     */
+    triggerHandlerPending(): void;
+    /**
+     * 触发处理器执行行为（激活状态 => 执行状态）
+     */
+    triggerHandlerExecute(): void;
+    /**
+     * 触发处理器成功行为（执行状态 => 成功状态）
+     */
+    triggerHandlerCompleted(): void;
+    /**
+     * 触发处理器销毁行为（待机状态 => 销毁状态）
+     */
+    triggerHandlerFinish(): void;
+    /**
+     * 触发应用被销毁行为
+     */
+    triggerAppFinish(): void;
+    /**
+     * 任务完成后的回调函数。
+     */
+    taskCompletedCallback(): void;
+    handle(original: O | null): void;
+}
+export default SerialHandler;

package/dist/handler/core/base-handler.d.ts

@@ -0,0 +1,22 @@
+import { default as ExecuteController } from '../../lat-controller';
+import { TaskExecuteContext } from '../types';
+import { InterfaceHandler } from './index';
+import { default as HandlerLife } from './life-handler';
+declare abstract class BaseHandler<O, R> extends HandlerLife implements InterfaceHandler<O, R> {
+    nextHandler: InterfaceHandler<R, unknown> | null;
+    prevHandler: InterfaceHandler<unknown, O> | null;
+    executeController: ExecuteController | null;
+    abstract handlerStatus: any;
+    isFirstExecute: boolean;
+    setExecuteController(executeController: ExecuteController): void;
+    linkHandler(nextHandler: InterfaceHandler<R, unknown>): void;
+    get isLastHandler(): boolean;
+    get isFirstHandler(): boolean;
+    abstract handle(original: O | null): void;
+    forwardToHandler(result: R): void;
+    setHandlerStatus(status: any): void;
+    equalHandlerStatus(status: any): boolean;
+    abstract execute(context: TaskExecuteContext): void;
+    isHandleDataAcceptedComplete: boolean;
+}
+export default BaseHandler;

package/dist/handler/core/index.d.ts

@@ -0,0 +1,4 @@
+import { default as InterfaceHandler } from './interface-handler';
+import { default as BaseHandler } from './base-handler';
+export { BaseHandler, };
+export type { InterfaceHandler, };

package/dist/handler/core/interface-handler.d.ts

@@ -0,0 +1,75 @@
+import { default as ExecuteController } from '../../lat-controller';
+import { TaskExecuteContext } from '../types';
+interface InterfaceHandler<O = unknown, R = unknown> {
+    /**
+     * 下一个处理器
+     * 链表中的下一个处理器，如果是链表中的最后一个处理器，则为null。
+     */
+    nextHandler: InterfaceHandler<R, unknown> | null;
+    /**
+     * 上一个处理器
+     * 链表中的上一个处理器，如果是链表中的第一个处理器，则为null。
+     */
+    prevHandler: InterfaceHandler<unknown, O> | null;
+    /**
+     * 当前处理器状态
+     */
+    handlerStatus: any;
+    /**
+     * 设置处理器链表，用于设置上一个或者下一个处理器
+     *
+     * @param handler 处理器
+     */
+    linkHandler: (handler: InterfaceHandler<R, unknown>) => void;
+    /**
+     * 处理器是否首次执行任务
+     */
+    isFirstExecute: boolean;
+    /**
+     * 处理器执行上下文
+     */
+    executeController: ExecuteController | null;
+    /**
+     * 设置处理器执行上下文
+     *
+     * @param executeController 执行上下文
+     */
+    setExecuteController: (executeController: ExecuteController) => void;
+    /**
+     * 是否为第一个处理器
+     */
+    isFirstHandler: boolean;
+    /**
+     * 是否为最后一个处理器
+     */
+    isLastHandler: boolean;
+    /**
+     * 向处理器输入任务数据
+     *
+     * @param original 任务数据
+     */
+    handle: (original: O | null) => void;
+    /**
+     * 将处理结果传递给下一个处理器，当做下一个处理器的任务数据
+     */
+    forwardToHandler: (result: R) => void;
+    /**
+     *  设置处理器的执行状态
+     */
+    setHandlerStatus: (status: any) => void;
+    /**
+     * 判断当前处理器是否处于指定执行状态
+     */
+    equalHandlerStatus: (status: any) => boolean;
+    /**
+     * 需要执行任务的具体逻辑
+     *
+     * @param context 当前执行者数据上下文（任务数据、是否首次执行、是否最后一次执行）
+     */
+    execute: (context: TaskExecuteContext) => void;
+    /**
+     * 处理器是否接受上一个处理传递的数据完毕
+     */
+    isHandleDataAcceptedComplete: boolean;
+}
+export default InterfaceHandler;

package/dist/handler/core/life-handler.d.ts

@@ -0,0 +1,19 @@
+declare class LifeHandler {
+    /**
+     * 处理器被激活（首次激活触发）
+     */
+    protected onActive(): void;
+    /**
+     * 处理器首次执行任务之前
+     */
+    protected onBeforeFirstExecute(): void;
+    /**
+     * 处理器执行任务完成
+     */
+    protected onCompleted(): void;
+    /**
+     * 处理器执被销毁
+     */
+    protected onFinish(): void;
+}
+export default LifeHandler;

package/dist/handler/index.d.ts

@@ -0,0 +1,2 @@
+export * from './components';
+export * from './types';

package/dist/handler/types/index.d.ts

@@ -0,0 +1,136 @@
+/**
+ * 串行任务处理器状态枚举
+ */
+declare enum SerialHandlerStatus {
+    /**
+     * 离线状态
+     */
+    OFFLINE = "offline",
+    /**
+     * 激活状态
+     */
+    ACTIVE = "active",
+    /**
+     * 待执行状态
+     */
+    PENDING = "pending",
+    /**
+     * 执行中状态
+     */
+    EXECUTING = "executing",
+    /**
+     * 完成状态
+     */
+    COMPLETED = "completed",
+    /**
+     * 销毁状态
+     */
+    FINISH = "finish"
+}
+/**
+ * 并行任务处理器状态枚举
+ */
+declare enum ParallelHandlerStatus {
+    /**
+     * 离线状态
+     */
+    OFFLINE = "offline",
+    /**
+     * 激活状态
+     */
+    ACTIVE = "active",
+    /**
+     * 待执行状态
+     */
+    PENDING = "pending",
+    /**
+    /**
+     * 执行中状态
+     */
+    EXECUTING = "executing",
+    /**
+     * 完成状态
+     */
+    COMPLETED = "completed",
+    /**
+     * 销毁状态
+     */
+    FINISH = "finish"
+}
+/**
+ * 工厂的处理上下文
+ */
+interface TaskExecuteContext {
+    /**
+     * 是否为第一次执行
+     */
+    isFirstExecute?: boolean;
+    /**
+     * 是否为最后一次执行
+     */
+    isLastExecute?: boolean;
+}
+/**
+ * 串行任务的处理上下文
+ */
+interface SerialTaskExecuteContext<O, _> extends TaskExecuteContext {
+    taskItem: SerialTaskItem<O>;
+}
+/**
+ * 并行任务的处理上下文
+ */
+interface ParallelTaskExecuteContext<O, _> extends TaskExecuteContext {
+    taskItem: ParallelTaskItem<O>;
+}
+/**
+ *  并行任务状态
+ */
+declare enum ParallelTaskItemStatus {
+    /**
+     * 待执行
+     */
+    PENDING = "pending",
+    /**
+     * 执行中
+     */
+    EXECUTING = "executing",
+    /**
+     * 执行完成
+     */
+    COMPLETED = "completed"
+}
+/**
+ *  串行任务状态
+ */
+declare enum SerialTaskItemStatus {
+    /**
+     * 待执行
+     */
+    PENDING = "pending",
+    /**
+     * 执行中
+     */
+    EXECUTING = "executing",
+    /**
+     * 执行完成
+     */
+    COMPLETED = "completed"
+}
+/**
+ * 并行每一项任务数据
+ */
+interface ParallelTaskItem<O> {
+    uuid: string;
+    status: ParallelTaskItemStatus;
+    original: O | null;
+}
+/**
+ *  串行每一项任务数据
+ */
+interface SerialTaskItem<O> {
+    uuid: string;
+    status: SerialTaskItemStatus;
+    original: O | null;
+}
+export type { ParallelTaskExecuteContext, ParallelTaskItem, SerialTaskExecuteContext, SerialTaskItem, TaskExecuteContext, };
+export { ParallelHandlerStatus, ParallelTaskItemStatus, SerialHandlerStatus, SerialTaskItemStatus };

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import { BusinessParams, SectionDelayParams, SystemConfig } from './types';
+import { default as LatController } from './lat-controller';
+/**
+ * 用于管理语音转文字配置
+ */
+declare const _default: {
+    /**
+     * 配置系统参数。
+     * @param _systemConfig - 系统配置参数。
+     * @returns 返回当前对象，支持链式调用。
+     */
+    config(_systemConfig: Required<SystemConfig>): {
+        config(_systemConfig: Required<SystemConfig>): /*elided*/ any;
+        create(_businessParams?: Partial<BusinessParams>, _sectionDelayParams?: Partial<SectionDelayParams>): LatController;
+    };
+    create(_businessParams?: Partial<BusinessParams>, _sectionDelayParams?: Partial<SectionDelayParams>): LatController;
+};
+export default _default;