@somniumism/kokoro-js-ja 1.2.1

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@somniumism/kokoro-js-ja",
+  "version": "1.2.1",
+  "type": "module",
+  "exports": {
+    "types": "./types/kokoro.d.ts",
+    "node": {
+      "import": "./dist/kokoro.js",
+      "require": "./dist/kokoro.cjs"
+    },
+    "default": "./dist/kokoro.js"
+  },
+  "scripts": {
+    "build": "rm -rf dist types && rollup -c && tsc",
+    "format": "prettier --write . --print-width 1000",
+    "test": "vitest run"
+  },
+  "keywords": [
+    "kokoro",
+    "tts",
+    "text-to-speech",
+    "japanese",
+    "日本語"
+  ],
+  "author": {
+    "name": "hexgrad",
+    "email": "hello@hexgrad.com"
+  },
+  "browser": {
+    "path": false,
+    "fs/promises": false
+  },
+  "contributors": [
+    "Xenova"
+  ],
+  "license": "Apache-2.0",
+  "description": "High-quality text-to-speech for the web with Japanese language support",
+  "dependencies": {
+    "@huggingface/transformers": "^3.5.1",
+    "phonemizer": "^1.2.1"
+  },
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^16.0.0",
+    "@rollup/plugin-terser": "^0.4.4",
+    "prettier": "3.4.2",
+    "rollup": "^4.30.1",
+    "typescript": "^5.7.3",
+    "vitest": "^3.1.2"
+  },
+  "files": [
+    "types",
+    "dist",
+    "voices",
+    "README.md",
+    "LICENSE"
+  ],
+  "homepage": "https://github.com/hexgrad/kokoro",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hexgrad/kokoro.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "jsdelivr": "./dist/kokoro.web.js",
+  "unpkg": "./dist/kokoro.web.js"
+}

package/types/kokoro.d.ts

@@ -0,0 +1,336 @@
+/**
+ * @typedef {Object} GenerateOptions
+ * @property {keyof typeof VOICES} [voice="af_heart"] The voice
+ * @property {number} [speed=1] The speaking speed
+ */
+/**
+ * @typedef {Object} StreamProperties
+ * @property {RegExp} [split_pattern] The pattern to split the input text. If unset, the default sentence splitter will be used.
+ * @typedef {GenerateOptions & StreamProperties} StreamGenerateOptions
+ */
+export class KokoroTTS {
+    /**
+     * Load a KokoroTTS model from the Hugging Face Hub.
+     * @param {string} model_id The model id
+     * @param {Object} options Additional options
+     * @param {"fp32"|"fp16"|"q8"|"q4"|"q4f16"} [options.dtype="fp32"] The data type to use.
+     * @param {"wasm"|"webgpu"|"cpu"|null} [options.device=null] The device to run the model on.
+     * @param {import("@huggingface/transformers").ProgressCallback} [options.progress_callback=null] A callback function that is called with progress information.
+     * @returns {Promise<KokoroTTS>} The loaded model
+     */
+    static from_pretrained(model_id: string, { dtype, device, progress_callback }?: {
+        dtype?: "fp32" | "fp16" | "q8" | "q4" | "q4f16";
+        device?: "wasm" | "webgpu" | "cpu" | null;
+        progress_callback?: import("@huggingface/transformers").ProgressCallback;
+    }): Promise<KokoroTTS>;
+    /**
+     * Create a new KokoroTTS instance.
+     * @param {import('@huggingface/transformers').StyleTextToSpeech2Model} model The model
+     * @param {import('@huggingface/transformers').PreTrainedTokenizer} tokenizer The tokenizer
+     */
+    constructor(model: import("@huggingface/transformers").StyleTextToSpeech2Model, tokenizer: import("@huggingface/transformers").PreTrainedTokenizer);
+    model: StyleTextToSpeech2Model;
+    tokenizer: import("@huggingface/transformers").PreTrainedTokenizer;
+    get voices(): Readonly<{
+        af_heart: {
+            name: string;
+            language: string;
+            gender: string;
+            traits: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        af_alloy: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        af_aoede: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        af_bella: {
+            name: string;
+            language: string;
+            gender: string;
+            traits: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        af_jessica: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        af_kore: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        af_nicole: {
+            name: string;
+            language: string;
+            gender: string;
+            traits: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        af_nova: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        af_river: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        af_sarah: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        af_sky: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        am_adam: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        am_echo: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        am_eric: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        am_fenrir: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        am_liam: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        am_michael: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        am_onyx: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        am_puck: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        am_santa: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        bf_emma: {
+            name: string;
+            language: string;
+            gender: string;
+            traits: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        bf_isabella: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        bm_george: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        bm_lewis: {
+            name: string;
+            language: string;
+            gender: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        bf_alice: {
+            name: string;
+            language: string;
+            gender: string;
+            traits: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        bf_lily: {
+            name: string;
+            language: string;
+            gender: string;
+            traits: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        bm_daniel: {
+            name: string;
+            language: string;
+            gender: string;
+            traits: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        bm_fable: {
+            name: string;
+            language: string;
+            gender: string;
+            traits: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        jf_alpha: {
+            name: string;
+            language: string;
+            gender: string;
+            traits: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        jf_gongitsune: {
+            name: string;
+            language: string;
+            gender: string;
+            traits: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        jf_nezumi: {
+            name: string;
+            language: string;
+            gender: string;
+            traits: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        jf_tebukuro: {
+            name: string;
+            language: string;
+            gender: string;
+            traits: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+        jm_kumo: {
+            name: string;
+            language: string;
+            gender: string;
+            traits: string;
+            targetQuality: string;
+            overallGrade: string;
+        };
+    }>;
+    list_voices(): void;
+    _validate_voice(voice: any): "b" | "a";
+    /**
+     * Generate audio from text.
+     *
+     * @param {string} text The input text
+     * @param {GenerateOptions} options Additional options
+     * @returns {Promise<RawAudio>} The generated audio
+     */
+    generate(text: string, { voice, speed }?: GenerateOptions): Promise<RawAudio>;
+    /**
+     * Generate audio from input ids.
+     * @param {Tensor} input_ids The input ids
+     * @param {GenerateOptions} options Additional options
+     * @returns {Promise<RawAudio>} The generated audio
+     */
+    generate_from_ids(input_ids: Tensor, { voice, speed }?: GenerateOptions): Promise<RawAudio>;
+    /**
+     * Generate audio from text in a streaming fashion.
+     * @param {string|TextSplitterStream} text The input text
+     * @param {StreamGenerateOptions} options Additional options
+     * @returns {AsyncGenerator<{text: string, phonemes: string, audio: RawAudio}, void, void>}
+     */
+    stream(text: string | TextSplitterStream, { voice, speed, split_pattern }?: StreamGenerateOptions): AsyncGenerator<{
+        text: string;
+        phonemes: string;
+        audio: RawAudio;
+    }, void, void>;
+}
+export namespace env {
+    let cacheDir: string;
+    let wasmPaths: import("onnxruntime-common").Env.WasmPrefixOrFilePaths;
+}
+export { TextSplitterStream };
+export type GenerateOptions = {
+    /**
+     * The voice
+     */
+    voice?: keyof typeof VOICES;
+    /**
+     * The speaking speed
+     */
+    speed?: number;
+};
+export type StreamProperties = {
+    /**
+     * The pattern to split the input text. If unset, the default sentence splitter will be used.
+     */
+    split_pattern?: RegExp;
+};
+export type StreamGenerateOptions = GenerateOptions & StreamProperties;
+import { StyleTextToSpeech2Model } from "@huggingface/transformers";
+import { RawAudio } from "@huggingface/transformers";
+import { Tensor } from "@huggingface/transformers";
+import { TextSplitterStream } from "./splitter.js";
+import { VOICES } from "./voices.js";
+//# sourceMappingURL=kokoro.d.ts.map

package/types/kokoro.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kokoro.d.ts","sourceRoot":"","sources":["../src/kokoro.js"],"names":[],"mappings":"AAQA;;;;GAIG;AAEH;;;;GAIG;AAEH;IAWE;;;;;;;;OAQG;IACH,iCAPW,MAAM,yCAEd;QAAkD,KAAK,GAA/C,MAAM,GAAC,MAAM,GAAC,IAAI,GAAC,IAAI,GAAC,OAAO;QACM,MAAM,GAA3C,MAAM,GAAC,QAAQ,GAAC,KAAK,GAAC,IAAI;QACqC,iBAAiB,GAAhF,OAAO,2BAA2B,EAAE,gBAAgB;KAC5D,GAAU,OAAO,CAAC,SAAS,CAAC,CAQ9B;IAzBD;;;;OAIG;IACH,mBAHW,OAAO,2BAA2B,EAAE,uBAAuB,aAC3D,OAAO,2BAA2B,EAAE,mBAAmB,EAKjE;IAFC,+BAAkB;IAClB,mEAA0B;IAoB5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAEC;IAED,oBAEC;IAED,uCAQC;IAED;;;;;;OAMG;IACH,eAJW,MAAM,qBACN,eAAe,GACb,OAAO,CAAC,QAAQ,CAAC,CAW7B;IAED;;;;;OAKG;IACH,6BAJW,MAAM,qBACN,eAAe,GACb,OAAO,CAAC,QAAQ,CAAC,CAqB7B;IAED;;;;;OAKG;IACH,aAJW,MAAM,GAAC,kBAAkB,oCACzB,qBAAqB,GACnB,cAAc,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,QAAQ,CAAA;KAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAiCzF;CACF;;;;;;;;;;YA3Ia,MAAM,OAAO,MAAM;;;;YACnB,MAAM;;;;;;oBAKN,MAAM;;oCACP,eAAe,GAAG,gBAAgB;wCAjBqC,2BAA2B;yBAA3B,2BAA2B;uBAA3B,2BAA2B;mCAE5E,eAAe;uBACb,aAAa"}

package/types/phonemize.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Phonemize text using the eSpeak-NG phonemizer
+ * @param {string} text The text to phonemize
+ * @param {"a"|"b"} language The language to use
+ * @param {boolean} norm Whether to normalize the text
+ * @returns {Promise<string>} The phonemized text
+ */
+export function phonemize(text: string, language?: "a" | "b", norm?: boolean): Promise<string>;
+//# sourceMappingURL=phonemize.d.ts.map

package/types/phonemize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"phonemize.d.ts","sourceRoot":"","sources":["../src/phonemize.js"],"names":[],"mappings":"AAsKA;;;;;;GAMG;AACH,gCALW,MAAM,aACN,GAAG,GAAC,GAAG,SACP,OAAO,GACL,OAAO,CAAC,MAAM,CAAC,CAgC3B"}

package/types/splitter.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Splits the input text into an array of sentences.
+ * @param {string} text The text to split.
+ * @returns {string[]} An array of sentences.
+ */
+export function split(text: string): string[];
+/**
+ * A simple stream-based text splitter that emits complete sentences.
+ */
+export class TextSplitterStream {
+    _buffer: string;
+    _sentences: any[];
+    _resolver: (value: any) => void;
+    _closed: boolean;
+    /**
+     * Push one or more text chunks into the stream.
+     * @param  {...string} texts Text fragments to process.
+     */
+    push(...texts: string[]): void;
+    /**
+     * Closes the stream, signaling that no more text will be pushed.
+     * This will flush any remaining text in the buffer as a sentence
+     * and allow the consuming process to finish processing the stream.
+     */
+    close(): void;
+    /**
+     * Flushes any remaining text in the buffer as a sentence.
+     */
+    flush(): void;
+    /**
+     * Resolve the pending promise to signal that sentences are available.
+     * @private
+     */
+    private _resolve;
+    /**
+     * Processes the internal buffer to extract complete sentences.
+     * If the potential sentence boundary is at the end of the current buffer,
+     * it waits for more text before splitting.
+     * @private
+     */
+    private _process;
+    /**
+     * Returns the array of sentences currently available.
+     * @type {string[]} The array of sentences.
+     * @readonly
+     */
+    readonly get sentences(): string[];
+    /**
+     * Async iterator to yield sentences as they become available.
+     * @returns {AsyncGenerator<string, void, void>}
+     */
+    [Symbol.asyncIterator](): AsyncGenerator<string, void, void>;
+    /**
+     * Synchronous iterator that flushes the buffer and returns all sentences.
+     * @returns {Iterator<string>}
+     */
+    [Symbol.iterator](): Iterator<string>;
+}
+//# sourceMappingURL=splitter.d.ts.map

package/types/splitter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"splitter.d.ts","sourceRoot":"","sources":["../src/splitter.js"],"names":[],"mappings":"AA8UA;;;;GAIG;AACH,4BAHW,MAAM,GACJ,MAAM,EAAE,CAMpB;AA9OD;;GAEG;AACH;IAEI,gBAAiB;IACjB,kBAAoB;IACpB,gCAAqB;IACrB,iBAAoB;IAGtB;;;OAGG;IACH,eAFe,MAAM,EAAA,QAOpB;IAED;;;;OAIG;IACH,cAMC;IAED;;OAEG;IACH,cAOC;IAED;;;OAGG;IACH,iBAKC;IAED;;;;;OAKG;IACH,iBAuHC;IAoCD;;;;OAIG;IACH,0BAHU,MAAM,EAAE,CAKjB;IAzCD;;;OAGG;IACH,0BAFa,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAmB9C;IAED;;;OAGG;IACH,qBAFa,QAAQ,CAAC,MAAM,CAAC,CAO5B;CAUF"}