@vm75/inditrans 0.3.5 → 0.4.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.4.0
+
+- Lot of refactoring.
+
+## 0.3.6
+
+- Refactored nodejs interface. Updated readme.
+
 ## 0.3.5
 
 - Fixed wasm, tests and nodejs support
@@ -28,7 +36,7 @@
 
 ## 0.1.8
 
-- Made InferAnuswara automatic. Fixed Diactric for Vowels.
+- Made InferAnuswara automatic. Fixed Diacritic for Vowels.
 
 ## 0.1.7
 

package/README.md

@@ -1,46 +1,60 @@
 # inditrans
 
-An experimental transliterator library for some [Indic/Brahmi](https://en.wikipedia.org/wiki/Brahmic_scripts) scripts.
+An experimental transliterator library for some [Indic/Indic](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.
+- Self-contained and performant. Uses wasm.
+- Supports [vedic accents](https://en.wikipedia.org/wiki/Vedic_accent). Useful for vedic scriptures.
+- Smart transliteration to and from Tamil. Supports tamil superscript.
+- Very small footprint (< 80kb uncompressed).
 
 References:
+
 - [inditrans on Github](https://github.com/vm75/inditrans)
-- [inditrans on pub.dev](https://pub.dev/packages/inditrans)
+- [inditrans for Flutter](https://pub.dev/packages/inditrans)
+- [inditrans for nodejs](https://www.npmjs.com/package/@vm75/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)
+
+- Indic/Brahmic scripts:
+  - assamese
+  - bengali
+  - devanagari
+  - gujarati
+  - gurmukhi
+  - kannada
+  - malayalam
+  - oriya
+  - sinhala
+  - tamil
+  - telugu
+- 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)
+
+## Installation
+
+```
+npm install @vm75/inditrans
+```
 
 ## Usage example
-```dart
-import 'package:inditrans/inditrans.dart' as inditrans;
 
-Future<void> main() async {
+```javascript
+import * as inditrans from 'inditrans';
+
+async function test() {
   // Init needs to complete before Inditrans could be used
-  await inditrans.init();
+  await indiTrans.init();
 
-  final result = inditrans.transliterate(
-      "श्री॒ गु॒रु॒भ्यो नमः॒ । ह॒रिः॒ ओ३म् ॥",
-      inditrans.Script.devanagari,
-      inditrans.Script.tamil,
-      inditrans.Options.IgnoreVedicAccents + inditrans.Options.TamilSuperscripted);
+  result = inditrans.transliterate(
+    "श्री॒ गु॒रु॒भ्यो नमः॒ । ह॒रिः॒ ओ३म् ॥",
+    inditrans.Script.devanagari,
+    inditrans.Script.tamil,
+    inditrans.Option.IgnoreVedicAccents + inditrans.Option.TamilSuperscripted
+  );
   ...
 }
 ```

package/dist/src/Inditrans.d.ts

@@ -0,0 +1,12 @@
+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;
+}

package/dist/src/{IndiTrans.js → Inditrans.js}

@@ -3,13 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IndiTrans = void 0;
+exports.Inditrans = void 0;
 const fs_1 = __importDefault(require("fs"));
-class IndiTrans {
-    static instance = IndiTrans._init();
+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);
+        return new Inditrans(instance.exports);
     }
     module;
     memory;
@@ -44,7 +44,7 @@ class IndiTrans {
         return ret;
     }
     transliterate(text, from, to, options) {
-        const pointers = [text, from, to].map((str) => this.stringToUtf8(str));
+        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) {
@@ -55,5 +55,5 @@ class IndiTrans {
         return result;
     }
 }
-exports.IndiTrans = IndiTrans;
-//# sourceMappingURL=IndiTrans.js.map
+exports.Inditrans = Inditrans;
+//# sourceMappingURL=Inditrans.js.map

package/dist/src/{IndiTransModule.d.ts → InditransModule.d.ts}

@@ -1,4 +1,4 @@
-export interface IndiTransModule {
+export interface InditransModule {
     transliterate(text: number, from: number, to: number, options: number): number;
     releaseBuffer(ptr: number): void;
     stackAlloc(size: number): number;

package/dist/src/{IndiTransModule.js → InditransModule.js}

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

package/dist/src/{TranslitOptions.d.ts → Option.d.ts}

@@ -1,4 +1,4 @@
-export declare enum TranslitOptions {
+export declare enum Option {
     None = 0,
     IgnoreVedicAccents = 1,
     IgnoreQuotedMarkers = 2,

package/dist/src/Option.js

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

package/dist/src/Script.d.ts

@@ -0,0 +1,19 @@
+export declare enum Script {
+    assamese = "assamese",
+    bengali = "bengali",
+    devanagari = "devanagari",
+    readablelatin = "readablelatin",
+    gujarati = "gujarati",
+    gurmukhi = "gurmukhi",
+    iast = "iast",
+    indic = "indic",
+    ipa = "ipa",
+    iso = "iso",
+    itrans = "itrans",
+    kannada = "kannada",
+    malayalam = "malayalam",
+    oriya = "oriya",
+    sinhala = "sinhala",
+    tamil = "tamil",
+    telugu = "telugu"
+}

package/dist/src/Script.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Script = void 0;
+var Script;
+(function (Script) {
+    Script["assamese"] = "assamese";
+    Script["bengali"] = "bengali";
+    Script["devanagari"] = "devanagari";
+    Script["readablelatin"] = "readablelatin";
+    Script["gujarati"] = "gujarati";
+    Script["gurmukhi"] = "gurmukhi";
+    Script["iast"] = "iast";
+    Script["indic"] = "indic";
+    Script["ipa"] = "ipa";
+    Script["iso"] = "iso";
+    Script["itrans"] = "itrans";
+    Script["kannada"] = "kannada";
+    Script["malayalam"] = "malayalam";
+    Script["oriya"] = "oriya";
+    Script["sinhala"] = "sinhala";
+    Script["tamil"] = "tamil";
+    Script["telugu"] = "telugu";
+})(Script = exports.Script || (exports.Script = {}));
+//# sourceMappingURL=Script.js.map

package/dist/src/index.d.ts

@@ -1,3 +1,7 @@
-import { IndiTrans } from './IndiTrans';
-import { TranslitOptions } from './TranslitOptions';
-export { IndiTrans, TranslitOptions };
+import { Option } from './Option';
+import { Script } from './Script';
+export { Option, Script };
+export declare function init(): Promise<void>;
+export declare function transliterate(text: string, from: Script, to: Script, options: Option): string;
+declare const _default: (typeof Option | typeof Script | typeof init | typeof transliterate)[];
+export default _default;

package/dist/src/index.js

@@ -1,8 +1,22 @@
 "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; } });
+exports.transliterate = exports.init = exports.Script = exports.Option = void 0;
+const Inditrans_1 = require("./Inditrans");
+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;
+async function init() {
+    inditrans = await Inditrans_1.Inditrans.instance;
+}
+exports.init = init;
+function transliterate(text, from, to, options) {
+    if (!inditrans) {
+        throw new Error('Inditrans not initialized');
+    }
+    return inditrans.transliterate(text, from, to, options);
+}
+exports.transliterate = transliterate;
+exports.default = [Option_1.Option, Script_1.Script, init, transliterate];
 //# sourceMappingURL=index.js.map

package/dist/src/utf8.d.ts

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vm75/inditrans",
-  "version": "0.3.5",
-  "description": "An experimental transliterator library for some Indic scripts.",
+  "version": "0.4.0",
+  "description": "An experimental transliterator library for some Indic/Brahmic scripts.",
   "main": "./dist/src/index.js",
   "author": "VM75",
   "license": "MIT",
@@ -22,8 +22,8 @@
     "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"
+    "prepack": "yarn clean && yarn test",
+    "pub": "npm publish --access=public"
   },
   "devDependencies": {
     "@types/jest": "^27.0.2",
@@ -39,5 +39,29 @@
     "ts-jest": "^27.0.5",
     "ts-node": "^10.9.1",
     "typescript": "^4.5.4"
-  }
+  },
+  "keywords": [
+    "transliterator",
+    "transliteration",
+    "indian",
+    "indian language",
+    "indian script",
+    "devanagari",
+    "tamil",
+    "sanskrit",
+    "telugu",
+    "kannada",
+    "malayalam",
+    "bengali",
+    "gurmukhi",
+    "gujarati",
+    "oriya",
+    "brahmic",
+    "vedic accents",
+    "wasm",
+    "ISO 15919",
+    "IAST",
+    "ITRANS",
+    "IPA"
+  ]
 }

package/dist/src/IndiTrans.d.ts

@@ -1,11 +0,0 @@
-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/TranslitOptions.js

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