@vm75/inditrans 0.7.0 → 0.13.1

package/README.md

@@ -1,69 +1,119 @@
-# inditrans
+# @vm75/inditrans
 
-A functional transliterator library for the most common [Indic/Brahmic](https://en.wikipedia.org/wiki/Brahmic_scripts) scripts.
+[![npm](https://img.shields.io/npm/v/@vm75/inditrans)](https://www.npmjs.com/package/@vm75/inditrans)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/vm75/inditrans/blob/master/LICENSE)
 
-- No dependencies and no server needed. Uses wasm for near native performance.
-- Supports ITRANS toggle transliteration with ## and skipping XML tags
-- Special handling for scripts like Tamil, Malayalam, Gurmukhi, etc. Tuned for reability.
-- Supports [vedic accents](https://en.wikipedia.org/wiki/Vedic_accent) for vedic scriptures.
+A transliteration library for [Indic/Brahmic](https://en.wikipedia.org/wiki/Brahmic_scripts)
+and Latin scripts for Node.js and the browser. Powered by a C++23 engine compiled to WASM
+for near-native performance, with no server dependency.
 
-<!-- - [Demo](http://vm75.github.io/inditrans/example/) -->
-- [Changelog](CHANGELOG.md)
+- ITRANS toggle transliteration — wrap any region in `##…##` to pass it through unchanged.
+- XML/HTML tag pass-through — tags are never transliterated.
+- Special handling for Tamil, Malayalam, Gurmukhi, and other scripts tuned for readability.
+- [Vedic accent](https://en.wikipedia.org/wiki/Vedic_accent) support for Vedic scriptures.
+- Full TypeScript typings included.
+
+## Supported scripts
 
-References:
+**Indic/Brahmic:** Assamese, Bengali, Burmese, Devanagari, Gujarati, Gurmukhi, Kannada,
+Khmer, Malayalam, Oriya, Sinhala, Tamil, Tamil-Extended, Telugu, Thai, Tibetan
 
-- [inditrans on Github](https://github.com/vm75/inditrans)
-- [inditrans for Flutter](https://pub.dev/packages/inditrans)
-- [inditrans for nodejs](https://www.npmjs.com/package/@vm75/inditrans)
+**Latin/Roman:**
+[IAST](https://en.wikipedia.org/wiki/International_Alphabet_of_Sanskrit_Transliteration) ·
+[IPA](https://en.wikipedia.org/wiki/International_Phonetic_Alphabet) ·
+[ISO 15919](https://en.wikipedia.org/wiki/ISO_15919) ·
+[ITRANS](https://www.aczoom.com/itrans/) ·
+[TITUS](https://titus.uni-frankfurt.de/indexe.htm) ·
+ReadableLatin
 
-## Supported scripts
+### ITRANS notation notes
 
-- Indic/Brahmic scripts:
-  - Assamese
-  - Bengali
-  - Burmese
-  - Devanagari
-  - Gujarati
-  - Gurmukhi
-  - Kannada
-  - Khmer
-  - Malayalam
-  - Oriya
-  - Sinhala
-  - Tamil
-  - Tamil-Extended
-  - Telugu
-  - Tibetan
-  - Thai
-- Latin/Roman scripts:
-  - IAST (https://en.wikipedia.org/wiki/International_Alphabet_of_Sanskrit_Transliteration)
-  - IPA (https://en.wikipedia.org/wiki/International_Phonetic_Alphabet)
-  - ISO 15919 (https://en.wikipedia.org/wiki/ISO_15919)
-  - ITRANS (https://en.wikipedia.org/wiki/ITRANS)
-  - ReadableLatin (easy to read in Latin alphabets with some customizations)
-  - TITUS (https://titus.uni-frankfurt.de/indexe.htm)
+`inditrans` implements uniform phonemic vowel mapping adhering to the [ITRANS specification](https://www.aczoom.com/itrans/):
+- **Short vowels**: `e` and `o` encode short vowels (e.g. Kannada `ಎ` / `ೆ`, Telugu `ఎ` / `ె`, Tamil `எ` / `ெ`, Malayalam `എ` / `െ`, Devanagari `ऎ` / `ॆ`). `^e` and `^o` remain supported as aliases.
+- **Long vowels**: `E` and `O` encode long vowels (e.g. Kannada `ಏ` / `ೇ`, Telugu `ఏ` / `ే`, Tamil `ஏ` / `ே`, Malayalam `ഏ` / `േ`, Devanagari `ए` / `े`).
+- Examples: `te` $\to$ `तॆ` / `ತೆ`, `tE` $\to$ `ते` / `ತೇ`; `tere bina` $\to$ `ತೆರೆ ಬಿನ` (Kannada), `tErE bina` $\to$ `ತೇರೇ ಬಿನ` (Kannada) / `तेरे बिन` (Devanagari).
+
+## Requirements
+
+- Node.js ≥ 18.3 (or modern browser with WebAssembly support)
 
 ## Installation
 
-```
+```sh
 npm install @vm75/inditrans
+# or
+yarn add @vm75/inditrans
 ```
 
-## Usage example
+## Quick start
 
-```javascript
-import * as inditrans from 'inditrans';
+```typescript
+import * as inditrans from '@vm75/inditrans';
 
-async function test() {
-  // Init needs to complete before Inditrans could be used
-  await indiTrans.init();
+async function main() {
+  // init() must complete before transliterate() is called
+  await inditrans.init();
 
-  result = inditrans.transliterate(
+  const result = inditrans.transliterate(
     "श्री॒ गु॒रु॒भ्यो नमः॒ । ह॒रिः॒ ओ३म् ॥",
     inditrans.Script.devanagari,
     inditrans.Script.tamil,
-    inditrans.Option.IgnoreVedicAccents + inditrans.Option.TamilSuperscripted
+    inditrans.Option.IgnoreVedicAccents | inditrans.Option.TamilSuperscripted,
   );
-  ...
+  console.log(result);
 }
+
+main();
 ```
+
+## API
+
+### `init(): Promise<void>`
+
+Loads and initialises the WASM module. Must be awaited before any other call.
+
+### `transliterate(text, from, to, options?): string`
+
+Transliterates `text` from the `from` script to the `to` script.
+
+| Parameter | Type | Description |
+|---|---|---|
+| `text` | `string` | Input text |
+| `from` | `Script` | Source script |
+| `to` | `Script` | Target script |
+| `options` | `Option` | Bitwise combination of option flags (default: `Option.None`) |
+
+### `isScriptSupported(script: string): boolean`
+
+Returns `true` when the given script name is recognised.
+
+## Options
+
+| Option | Value | Description |
+|---|---|---|
+| `Option.None` | `0` | No options (default) |
+| `Option.TamilTraditional` | `1` | Traditional Tamil consonants only |
+| `Option.TamilSuperscripted` | `2` | Superscripted Tamil consonants |
+| `Option.ASCIINumerals` | `4` | Force ASCII numerals in output |
+| `Option.IgnoreVedicAccents` | `8` | Strip Vedic accent markers |
+| `Option.RetainSpecialMarkers` | `16` | Keep non-standard character markers |
+| `Option.NoXMLTagHandling` | `32` | Treat XML/HTML tags as plain text |
+
+Combine flags with the bitwise OR operator: `Option.IgnoreVedicAccents | Option.TamilSuperscripted`.
+
+## Development
+
+```sh
+yarn install    # install dependencies
+yarn test       # build WASM and run tests
+```
+
+## Documentation
+
+- [Changelog](CHANGELOG.md)
+- [Project on GitHub](https://github.com/vm75/inditrans)
+- [Flutter / Dart package](https://pub.dev/packages/inditrans)
+
+## License
+
+[MIT](../LICENSE)

package/dist/src/Option.d.ts

@@ -4,5 +4,6 @@ export declare enum Option {
     TamilSuperscripted = 2,
     ASCIINumerals = 4,
     IgnoreVedicAccents = 8,
-    RetainSpecialMarkers = 16
+    RetainSpecialMarkers = 16,
+    NoXMLTagHandling = 32
 }

package/dist/src/Option.js

@@ -18,5 +18,7 @@ var Option;
     Option[Option["IgnoreVedicAccents"] = 8] = "IgnoreVedicAccents";
     /// Retain special markers which are used to identify non-standard chars
     Option[Option["RetainSpecialMarkers"] = 16] = "RetainSpecialMarkers";
-})(Option = exports.Option || (exports.Option = {}));
+    /// Do not check for xml/html tags, and treat them as normal text
+    Option[Option["NoXMLTagHandling"] = 32] = "NoXMLTagHandling";
+})(Option || (exports.Option = Option = {}));
 //# sourceMappingURL=Option.js.map

package/dist/src/Script.d.ts

@@ -7,6 +7,7 @@ export declare enum Script {
     gujarati = "gujarati",
     gurmukhi = "gurmukhi",
     hindi = "hindi",
+    hk = "hk",
     iast = "iast",
     indic = "indic",
     ipa = "ipa",
@@ -21,11 +22,13 @@ export declare enum Script {
     readableLatin = "readableLatin",
     sanskrit = "sanskrit",
     sinhala = "sinhala",
+    slp1 = "slp1",
     tamil = "tamil",
     tamilExtended = "tamilExtended",
     telugu = "telugu",
     thai = "thai",
     tibetan = "tibetan",
     titus = "titus",
+    velthuis = "velthuis",
     wx = "wx"
 }

package/dist/src/Script.js

@@ -13,6 +13,7 @@ var Script;
     Script["gujarati"] = "gujarati";
     Script["gurmukhi"] = "gurmukhi";
     Script["hindi"] = "hindi";
+    Script["hk"] = "hk";
     Script["iast"] = "iast";
     Script["indic"] = "indic";
     Script["ipa"] = "ipa";
@@ -27,12 +28,14 @@ var Script;
     Script["readableLatin"] = "readableLatin";
     Script["sanskrit"] = "sanskrit";
     Script["sinhala"] = "sinhala";
+    Script["slp1"] = "slp1";
     Script["tamil"] = "tamil";
     Script["tamilExtended"] = "tamilExtended";
     Script["telugu"] = "telugu";
     Script["thai"] = "thai";
     Script["tibetan"] = "tibetan";
     Script["titus"] = "titus";
+    Script["velthuis"] = "velthuis";
     Script["wx"] = "wx";
-})(Script = exports.Script || (exports.Script = {}));
+})(Script || (exports.Script = Script = {}));
 //# sourceMappingURL=Script.js.map

package/dist/src/index.d.ts

@@ -4,5 +4,11 @@ export { Option, Script };
 export declare function init(): Promise<void>;
 export declare function transliterate(text: string, from: Script, to: Script, options: Option): string;
 export declare function isScriptSupported(script: string): boolean;
-declare const _default: (typeof Option | typeof Script | typeof init | typeof transliterate | typeof isScriptSupported)[];
+declare const _default: {
+    Option: typeof Option;
+    Script: typeof Script;
+    init: typeof init;
+    transliterate: typeof transliterate;
+    isScriptSupported: typeof isScriptSupported;
+};
 export default _default;

package/dist/src/index.js

@@ -1,29 +1,57 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isScriptSupported = exports.transliterate = exports.init = exports.Script = exports.Option = void 0;
-const Inditrans_1 = require("./Inditrans");
+exports.Script = exports.Option = void 0;
+exports.init = init;
+exports.transliterate = transliterate;
+exports.isScriptSupported = isScriptSupported;
 const Option_1 = require("./Option");
 Object.defineProperty(exports, "Option", { enumerable: true, get: function () { return Option_1.Option; } });
 const Script_1 = require("./Script");
 Object.defineProperty(exports, "Script", { enumerable: true, get: function () { return Script_1.Script; } });
-let inditrans = null;
+const path_1 = __importDefault(require("path"));
+let Module = null;
 async function init() {
-    inditrans = await Inditrans_1.Inditrans.instance;
+    // Try to load from compiled dist location first, fall back to src
+    let inditransPath;
+    try {
+        inditransPath = path_1.default.join(__dirname, 'inditrans.js');
+    }
+    catch {
+        inditransPath = path_1.default.join(__dirname, '../js/public/inditrans.js');
+    }
+    // The module directly exports Module, not a factory
+    Module = require(inditransPath);
+    // Wait for runtime initialization if needed
+    if (Module.onRuntimeInitialized) {
+        await new Promise(resolve => {
+            if (Module.inditrans) {
+                resolve(undefined);
+            }
+            else {
+                const originalCallback = Module.onRuntimeInitialized;
+                Module.onRuntimeInitialized = () => {
+                    if (originalCallback)
+                        originalCallback();
+                    resolve(undefined);
+                };
+            }
+        });
+    }
 }
-exports.init = init;
 function transliterate(text, from, to, options) {
-    if (!inditrans) {
-        throw new Error('Inditrans not initialized');
+    if (!Module) {
+        throw new Error('Inditrans not initialized. Call init() first.');
     }
-    return inditrans.transliterate(text, from, to, options);
+    return Module.inditrans.transliterate(text, from, to, options);
 }
-exports.transliterate = transliterate;
 function isScriptSupported(script) {
-    if (!inditrans) {
-        throw new Error('Inditrans not initialized');
+    if (!Module) {
+        throw new Error('Inditrans not initialized. Call init() first.');
     }
-    return inditrans.isScriptSupported(script);
+    return Module.inditrans.isScriptSupported(script);
 }
-exports.isScriptSupported = isScriptSupported;
-exports.default = [Option_1.Option, Script_1.Script, init, transliterate, isScriptSupported];
+exports.default = { Option: Option_1.Option, Script: Script_1.Script, init, transliterate, isScriptSupported };
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vm75/inditrans",
-  "version": "0.7.0",
+  "version": "0.13.1",
   "description": "A functional transliterator library for the most common Indic/Brahmic scripts.",
   "main": "./dist/src/index.js",
   "author": "VM75",
@@ -20,30 +20,36 @@
     "test/"
   ],
   "types": "./dist/src/index.d.ts",
+  "engines": {
+    "node": ">=18.3"
+  },
   "scripts": {
     "clean": "shx rm -rf dist/*",
     "build": "yarn build-wasm && yarn copy-files && tsc",
     "build-wasm": "make -C .. wasm",
     "watch": "tsc --watch",
     "test": "yarn build && yarn jest --config jestconfig.json",
-    "copy-files": "shx mkdir -p dist/src && shx cp -f src/inditrans.wasm dist/src/",
+    "copy-files": "shx mkdir -p dist/src && shx cp -f ../js/public/inditrans.js dist/src/ && shx cp -f ../js/public/inditrans.js src/",
     "prepack": "yarn clean && yarn test",
     "pub": "npm publish --access=public"
   },
   "devDependencies": {
-    "@types/jest": "^27.0.2",
-    "@types/node": "^18.0.3",
-    "@typescript-eslint/eslint-plugin": "^5.4.0",
-    "@typescript-eslint/parser": "^5.4.0",
-    "eslint": "^8.2.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "jest": "^27.2.5",
-    "prettier": "^2.4.1",
-    "shx": "^0.3.3",
-    "ts-jest": "^27.0.5",
-    "ts-node": "^10.9.1",
-    "typescript": "^4.5.4"
+    "@types/jest": "^30.0.0",
+    "@types/node": "^26.6.3",
+    "@typescript-eslint/eslint-plugin": "^8.71.0",
+    "@typescript-eslint/parser": "^8.71.0",
+    "eslint": "^10.11.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.6",
+    "jest": "^30.5.2",
+    "prettier": "^3.9.9",
+    "shx": "^0.4.0",
+    "ts-jest": "^29.4.14",
+    "ts-node": "^10.9.2",
+    "typescript": "^6.0.3"
+  },
+  "resolutions": {
+    "handlebars": "^4.7.10"
   },
   "keywords": [
     "Transliterate",

package/dist/src/Inditrans.d.ts

@@ -1,13 +0,0 @@
-import { Option } from './Option';
-import { Script } from './Script';
-export declare class Inditrans {
-    static instance: Promise<Inditrans>;
-    private static _init;
-    private module;
-    private memory;
-    private constructor();
-    private utf82ToString;
-    private stringToUtf8;
-    transliterate(text: string, from: Script, to: Script, options: Option): string;
-    isScriptSupported(script: string): boolean;
-}

package/dist/src/Inditrans.js

@@ -1,65 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Inditrans = void 0;
-const fs_1 = __importDefault(require("fs"));
-class Inditrans {
-    static instance = Inditrans._init();
-    static async _init() {
-        const { instance } = await WebAssembly.instantiate(fs_1.default.readFileSync(`${__dirname}/inditrans.wasm`));
-        return new Inditrans(instance.exports);
-    }
-    module;
-    memory;
-    constructor(wrapper) {
-        this.module = wrapper;
-        this.memory = new Uint8Array(wrapper.memory.buffer);
-    }
-    utf82ToString(ptr) {
-        if (ptr === 0) {
-            return '';
-        }
-        const decoder = new TextDecoder();
-        let endPtr = ptr;
-        while (this.memory[endPtr]) {
-            ++endPtr;
-        }
-        return decoder.decode(this.memory.subarray(ptr, endPtr));
-    }
-    stringToUtf8(str) {
-        let ret = 0;
-        if (str === null && str === undefined) {
-            return ret;
-        }
-        const encoder = new TextEncoder();
-        const encodedText = encoder.encode(str);
-        const len = encodedText.length + 1;
-        ret = this.module.stackAlloc(len);
-        if (encodedText.length > 0) {
-            this.memory.set(encodedText, ret);
-        }
-        this.memory[ret + encodedText.length] = 0;
-        return ret;
-    }
-    transliterate(text, from, to, options) {
-        const pointers = [text, from, to].map((str) => this.stringToUtf8(str.toString()));
-        const resultPtr = this.module.transliterate(pointers[0], pointers[1], pointers[2], options);
-        let result = '';
-        if (resultPtr !== 0) {
-            result = this.utf82ToString(resultPtr);
-            this.module.releaseBuffer(resultPtr);
-        }
-        pointers.map((ptr) => this.module.stackRestore(ptr));
-        return result;
-    }
-    isScriptSupported(script) {
-        const ptr = this.stringToUtf8(script);
-        const result = this.module.isScriptSupported(ptr);
-        this.module.stackRestore(ptr);
-        return result == 1;
-    }
-}
-exports.Inditrans = Inditrans;
-//# sourceMappingURL=Inditrans.js.map

package/dist/src/InditransModule.d.ts

@@ -1,9 +0,0 @@
-export interface InditransModule {
-    transliterate(text: number, from: number, to: number, options: number): number;
-    isScriptSupported(script: number): number;
-    releaseBuffer(ptr: number): void;
-    stackAlloc(size: number): number;
-    stackRestore(ptr: number): void;
-    memory: WebAssembly.Memory;
-    __indirect_function_table: WebAssembly.Table;
-}

package/dist/src/InditransModule.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=InditransModule.js.map

package/dist/src/utf8.d.ts

@@ -1,9 +0,0 @@
-import { InditransModule } from './InditransModule';
-export declare class Codec {
-    private module;
-    private memory;
-    constructor(module: InditransModule);
-    private stringToNativeArray;
-    private nativeArrayToString;
-    private stringToUtf82;
-}

package/dist/src/utf8.js

@@ -1,101 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Codec = void 0;
-class Codec {
-    module;
-    memory;
-    constructor(module) {
-        this.module = module;
-        this.memory = new Uint8Array(module.memory.buffer);
-    }
-    stringToNativeArray(str, outIdx, maxBytesToWrite) {
-        if (!(maxBytesToWrite > 0))
-            return 0;
-        const startIdx = outIdx;
-        const endIdx = outIdx + maxBytesToWrite - 1;
-        for (let i = 0; i < str.length; ++i) {
-            let charCode = str.charCodeAt(i);
-            if (charCode >= 55296 && charCode <= 57343) {
-                const byte1 = str.charCodeAt(++i);
-                charCode = (65536 + ((charCode & 1023) << 10)) | (byte1 & 1023);
-            }
-            if (charCode <= 127) {
-                if (outIdx >= endIdx)
-                    break;
-                this.memory[outIdx++] = charCode;
-            }
-            else if (charCode <= 2047) {
-                if (outIdx + 1 >= endIdx)
-                    break;
-                this.memory[outIdx++] = 192 | (charCode >> 6);
-                this.memory[outIdx++] = 128 | (charCode & 63);
-            }
-            else if (charCode <= 65535) {
-                if (outIdx + 2 >= endIdx)
-                    break;
-                this.memory[outIdx++] = 224 | (charCode >> 12);
-                this.memory[outIdx++] = 128 | ((charCode >> 6) & 63);
-                this.memory[outIdx++] = 128 | (charCode & 63);
-            }
-            else {
-                if (outIdx + 3 >= endIdx)
-                    break;
-                this.memory[outIdx++] = 240 | (charCode >> 18);
-                this.memory[outIdx++] = 128 | ((charCode >> 12) & 63);
-                this.memory[outIdx++] = 128 | ((charCode >> 6) & 63);
-                this.memory[outIdx++] = 128 | (charCode & 63);
-            }
-        }
-        this.memory[outIdx] = 0;
-        return outIdx - startIdx;
-    }
-    nativeArrayToString(idx, maxBytesToRead) {
-        const endIdx = idx + maxBytesToRead;
-        let endPtr = idx;
-        while (this.memory[endPtr] && !(endPtr >= endIdx))
-            ++endPtr;
-        let str = '';
-        while (idx < endPtr) {
-            let byte0 = this.memory[idx++];
-            if (!(byte0 & 128)) {
-                str += String.fromCharCode(byte0);
-                continue;
-            }
-            const byte1 = this.memory[idx++] & 63;
-            if ((byte0 & 224) == 192) {
-                str += String.fromCharCode(((byte0 & 31) << 6) | byte1);
-                continue;
-            }
-            const byte2 = this.memory[idx++] & 63;
-            if ((byte0 & 240) == 224) {
-                byte0 = ((byte0 & 15) << 12) | (byte1 << 6) | byte2;
-            }
-            else {
-                byte0 =
-                    ((byte0 & 7) << 18) |
-                        (byte1 << 12) |
-                        (byte2 << 6) |
-                        (this.memory[idx++] & 63);
-            }
-            if (byte0 < 65536) {
-                str += String.fromCharCode(byte0);
-            }
-            else {
-                const ch = byte0 - 65536;
-                str += String.fromCharCode(55296 | (ch >> 10), 56320 | (ch & 1023));
-            }
-        }
-        return str;
-    }
-    stringToUtf82(str) {
-        let ret = 0;
-        if (str !== null && str !== undefined) {
-            const len = (str.length << 2) + 1;
-            ret = this.module.stackAlloc(len);
-            this.stringToNativeArray(str, ret, len);
-        }
-        return ret;
-    }
-}
-exports.Codec = Codec;
-//# sourceMappingURL=utf8.js.map