@zh-keyboard/core 0.5.1 → 1.0.0

package/dist/index.d.ts

@@ -1,25 +1,3 @@
-//#region src/advanced-pinyin.d.ts
-interface PinyinCharEntry {
-  id?: number;
-  pinyin: string;
-  char: string;
-  weight: number;
-}
-declare class AdvancedPinyinEngine {
-  private currentInput;
-  private candidates;
-  private db;
-  private pinyinDict;
-  private pinyinCharTable;
-  private initializationPromise;
-  constructor();
-  private initializeDatabase;
-  processInput(input: string): Promise<string[]>;
-  selectCandidate(selectedChar: string): Promise<void>;
-  clear(): void;
-  getCurrentInput(): string;
-  getCandidates(): string[];
-} //#endregion
 //#region src/canvas.d.ts
 interface CanvasDrawerOptions {
   onDrawEnd?: () => void;
@@ -83,9 +61,70 @@ interface HandwritingRecognizer {
    * 关闭手写识别服务
    */
   close(): Promise<void>;
+} //#endregion
+//#region src/pinyin-engine.d.ts
+interface Candidate {
+  text: string;
+  comment: string;
 }
-
-//#endregion
+interface PinyinState {
+  /** 已提交（最终）文本；若无提交则为 null。 */
+  committed: string | null;
+  /** 选区前的预编辑文本。 */
+  preeditHead: string;
+  /** 当前被选中的预编辑部分。 */
+  preeditBody: string;
+  /** 选区后的预编辑文本。 */
+  preeditTail: string;
+  /** 预编辑中的光标位置。 */
+  cursorPos: number;
+  /** 当前页的候选项列表。 */
+  candidates: Candidate[];
+  /** 当前页码（从 0 开始）。 */
+  pageNo: number;
+  /** 是否为候选的最后一页。 */
+  isLastPage: boolean;
+  /** 高亮候选的索引。 */
+  highlightedIndex: number;
+  /** 候选选择键的标签数组。 */
+  selectLabels: string[];
+}
+/**
+ * 拼音引擎通用接口
+ * 所有拼音引擎实现必须遵循此接口
+ */
+interface PinyinEngine {
+  /**
+   * 初始化引擎，加载必要资源
+   */
+  initialize(): Promise<void>;
+  /**
+   * 处理完整的拼音输入串，返回所有候选词列表（跨所有页）。
+   * 引擎内部负责增量 vs 重置的优化，调用方只传完整拼音。
+   * @param pinyin 完整的拼音字符串
+   * @returns 候选词状态，包括所有页的候选词集合和分页信息
+   */
+  processInput(pinyin: string): Promise<PinyinState | null>;
+  /**
+   * 按全局索引选择候选词，返回已提交的文本。
+   * @param index 候选词在全量列表中的全局索引（从0开始）
+   * @returns 候选词状态，包括所有页的候选词集合和分页信息
+   */
+  pickCandidate(index: number): Promise<PinyinState>;
+  /**
+   * 清除引擎当前的预编辑输入状态
+   */
+  clearInput(): Promise<void>;
+  /**
+   * 切换简体/繁体输出（可选，引擎不支持时忽略）
+   * @param simplified true 为简体，false 为繁体
+   */
+  setSimplified?(simplified: boolean): Promise<void>;
+  /**
+   * 销毁引擎，释放所有持有的资源
+   */
+  destroy(): Promise<void>;
+} //#endregion
 //#region src/config.d.ts
 /**
  * 键盘配置类型
@@ -111,6 +150,12 @@ interface KeyboardConfig {
    * 数字键盘的行配置
    */
   numKeys?: string[][];
+  /**
+   * RIME WASM 文件及数据文件的 URL 或路径前缀。
+   * 用于默认 RIME 引擎加载（当未通过 registerPinyinEngine 注册自定义引擎时）。
+   * @default '/rime'
+   */
+  wasmDir?: string;
 }
 /**
  * 获取全局键盘配置
@@ -130,6 +175,18 @@ declare function registerHandwritingRecognizer(recognizer: HandwritingRecognizer
  * @returns 手写识别服务实例
  */
 declare function getHandwritingRecognizer(): HandwritingRecognizer | null;
+/**
+ * 注册拼音引擎。
+ * 注册后，CandidateBar 将使用此引擎而非默认的 RIME 引擎。
+ * 适用于自定义引擎或 Worker 中运行的引擎。
+ * @param engine 拼音引擎实现
+ */
+declare function registerPinyinEngine(engine: PinyinEngine): void;
+/**
+ * 获取已注册的拼音引擎实例
+ * @returns 拼音引擎实例，未注册时返回 null
+ */
+declare function getPinyinEngine(): PinyinEngine | null;
 
 //#endregion
 //#region src/dom.d.ts
@@ -177,41 +234,6 @@ declare function delToInputElement(inputElement: HTMLInputElement): void;
  */
 declare function moveCursor(inputElement: HTMLInputElement, index: number): void;
 
-//#endregion
-//#region src/pinyin.d.ts
-/**
- * 简单拼音输入法引擎
- */
-declare class SimplePinyinEngine {
-  private currentInput;
-  private candidates;
-  private pinyinMap;
-  /**
-   * 处理拼音输入
-   * @param input 用户输入的拼音
-   * @returns 候选词列表
-   */
-  processInput(input: string): string[];
-  /**
-   * 清空当前输入
-   */
-  clear(): void;
-  /**
-   * 获取当前输入码
-   */
-  getCurrentInput(): string;
-  /**
-   * 获取当前候选词列表
-   */
-  getCandidates(): string[];
-  /**
-   * 选择候选词
-   * @param index 候选词索引
-   * @returns 选中的候选词
-   */
-  selectCandidate(index: number): string | null;
-}
-
 //#endregion
 //#region src/repeat.d.ts
 interface KeyRepeatOptions {
@@ -233,5 +255,5 @@ interface KeyRepeater {
 declare function createKeyRepeater(options?: KeyRepeatOptions): KeyRepeater;
 
 //#endregion
-export { AdvancedPinyinEngine, CanvasDrawer, CanvasDrawerOptions, HandwritingRecognizer, KeyRepeatOptions, KeyRepeater, KeyboardConfig, KeyboardPosition, PinyinCharEntry, RecognizerInitOptions, SimplePinyinEngine, calculateKeyboardPosition, createKeyRepeater, delToInputElement, getHandwritingRecognizer, getInputElement, getKeyboardConfig, isInputElement, moveCursor, registerHandwritingRecognizer, setKeyboardConfig, writeToInputElement };
+export { Candidate, CanvasDrawer, CanvasDrawerOptions, HandwritingRecognizer, KeyRepeatOptions, KeyRepeater, KeyboardConfig, KeyboardPosition, PinyinEngine, PinyinState, RecognizerInitOptions, calculateKeyboardPosition, createKeyRepeater, delToInputElement, getHandwritingRecognizer, getInputElement, getKeyboardConfig, getPinyinEngine, isInputElement, moveCursor, registerHandwritingRecognizer, registerPinyinEngine, setKeyboardConfig, writeToInputElement };
 //# sourceMappingURL=index.d.ts.map