@vm75/inditrans 0.3.5

package/CHANGELOG.md

@@ -0,0 +1,87 @@
+## 0.3.5
+
+- Fixed wasm, tests and nodejs support
+
+## 0.3.4
+
+- Fixed some corner case
+
+## 0.3.3
+
+- Added support for Tamil prefix
+
+## 0.3.2
+
+- Renamed indicroman to readablelatin
+
+## 0.3.1
+
+- Improved Tamil transliteration based on rules
+
+## 0.2.0
+
+- Fixed Sinhara symbols
+
+## 0.1.9
+
+- modified easyroman and renamed to readablelatin
+
+## 0.1.8
+
+- Made InferAnuswara automatic. Fixed Diactric for Vowels.
+
+## 0.1.7
+
+- fixed bug for indic
+
+## 0.1.6
+
+- exported indic, added 2 scripts, fixed roman
+
+## 0.1.5
+
+- Added fromString to Script enum
+
+## 0.1.4
+
+- re-publish from correct branch.
+
+## 0.1.3
+
+- Fixed build error
+
+## 0.1.2
+
+- Added option to use ASCII numerals
+
+## 0.1.1
+
+- fixed inferAnuswara for consonants after ma
+
+## 0.1.0
+
+- Removed unnecessary Inditrans class. Added helpful scripts.
+
+## 0.0.6
+
+- fixed example.
+
+## 0.0.5
+
+- fixed android build issue.
+
+## 0.0.4
+
+- removed unnecessary code and files.
+
+## 0.0.3
+
+- Added comments and fixed formatting and example.
+
+## 0.0.2
+
+- Fixed ffi_lib for non-web
+
+## 0.0.1
+
+- Initial release

package/README.md

@@ -0,0 +1,46 @@
+# inditrans
+
+An experimental transliterator library for some [Indic/Brahmi](https://en.wikipedia.org/wiki/Brahmic_scripts) scripts.
+
+* Available on all platforms. Uses ffi for non-Web platforms and wasm for Web.
+* Self-contained and performant.
+* Supports [vedic accents](https://en.wikipedia.org/wiki/Vedic_accent). Useful for vedic scriptures.
+
+References:
+- [inditrans on Github](https://github.com/vm75/inditrans)
+- [inditrans on pub.dev](https://pub.dev/packages/inditrans)
+
+## Supported scripts
+* Brahmi scripts:
+  * bengali
+  * devanagari
+  * gujarati
+  * gurmukhi
+  * kannada
+  * malayalam
+  * oriya
+  * tamil
+  * telugu
+* 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 (custom)
+
+## Usage example
+```dart
+import 'package:inditrans/inditrans.dart' as inditrans;
+
+Future<void> main() async {
+  // Init needs to complete before Inditrans could be used
+  await inditrans.init();
+
+  final result = inditrans.transliterate(
+      "श्री॒ गु॒रु॒भ्यो नमः॒ । ह॒रिः॒ ओ३म् ॥",
+      inditrans.Script.devanagari,
+      inditrans.Script.tamil,
+      inditrans.Options.IgnoreVedicAccents + inditrans.Options.TamilSuperscripted);
+  ...
+}
+```

package/dist/src/IndiTrans.d.ts

@@ -0,0 +1,11 @@
+import { TranslitOptions } from './TranslitOptions';
+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: string, to: string, options: TranslitOptions): string;
+}

package/dist/src/IndiTrans.js

@@ -0,0 +1,59 @@
+"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));
+        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;
+    }
+}
+exports.IndiTrans = IndiTrans;
+//# sourceMappingURL=IndiTrans.js.map

package/dist/src/IndiTransModule.d.ts

@@ -0,0 +1,8 @@
+export interface IndiTransModule {
+    transliterate(text: number, from: number, to: number, options: 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

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

package/dist/src/TranslitOptions.d.ts

@@ -0,0 +1,9 @@
+export declare enum TranslitOptions {
+    None = 0,
+    IgnoreVedicAccents = 1,
+    IgnoreQuotedMarkers = 2,
+    TamilTraditional = 4,
+    TamilSuperscripted = 8,
+    RetainZeroWidthChars = 16,
+    ASCIINumerals = 32
+}

package/dist/src/TranslitOptions.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TranslitOptions = void 0;
+var TranslitOptions;
+(function (TranslitOptions) {
+    TranslitOptions[TranslitOptions["None"] = 0] = "None";
+    TranslitOptions[TranslitOptions["IgnoreVedicAccents"] = 1] = "IgnoreVedicAccents";
+    TranslitOptions[TranslitOptions["IgnoreQuotedMarkers"] = 2] = "IgnoreQuotedMarkers";
+    TranslitOptions[TranslitOptions["TamilTraditional"] = 4] = "TamilTraditional";
+    TranslitOptions[TranslitOptions["TamilSuperscripted"] = 8] = "TamilSuperscripted";
+    TranslitOptions[TranslitOptions["RetainZeroWidthChars"] = 16] = "RetainZeroWidthChars";
+    TranslitOptions[TranslitOptions["ASCIINumerals"] = 32] = "ASCIINumerals";
+})(TranslitOptions = exports.TranslitOptions || (exports.TranslitOptions = {}));
+//# sourceMappingURL=TranslitOptions.js.map

package/dist/src/index.d.ts

@@ -0,0 +1,3 @@
+import { IndiTrans } from './IndiTrans';
+import { TranslitOptions } from './TranslitOptions';
+export { IndiTrans, TranslitOptions };

package/dist/src/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TranslitOptions = exports.IndiTrans = void 0;
+const IndiTrans_1 = require("./IndiTrans");
+Object.defineProperty(exports, "IndiTrans", { enumerable: true, get: function () { return IndiTrans_1.IndiTrans; } });
+const TranslitOptions_1 = require("./TranslitOptions");
+Object.defineProperty(exports, "TranslitOptions", { enumerable: true, get: function () { return TranslitOptions_1.TranslitOptions; } });
+//# sourceMappingURL=index.js.map

package/dist/src/utf8.d.ts

@@ -0,0 +1,9 @@
+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

@@ -0,0 +1,101 @@
+"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

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@vm75/inditrans",
+  "version": "0.3.5",
+  "description": "An experimental transliterator library for some Indic scripts.",
+  "main": "./dist/src/index.js",
+  "author": "VM75",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vm75/inditrans"
+  },
+  "files": [
+    "dist/src/*.ts",
+    "dist/src/*.js",
+    "dist/src/*.wasm"
+  ],
+  "types": "./dist/src/index.d.ts",
+  "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/",
+    "prepack": "yarn clean && yarn build",
+    "publish": "yarn test && 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"
+  }
+}