@vm75/inditrans 0.4.5 → 0.6.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.6.0
+
+- Refactoring and constants generation
+
+## 0.5.0
+
+- Added support for Gurmukhi adhak
+
+## 0.4.6
+
+- Fixed Zero Width Joiner and Non-Joiner
+
 ## 0.4.5
 
 - Support compound alternates and Malayalam Chillus

package/README.md

@@ -1,13 +1,14 @@
 # inditrans
 
-An experimental transliterator library for some [Indic/Brahmic](https://en.wikipedia.org/wiki/Brahmic_scripts) scripts.
+A functional transliterator library for the most common [Indic/Brahmic](https://en.wikipedia.org/wiki/Brahmic_scripts) scripts.
 
-- Uses wasm for near native performance.
-- No dependencies and no server needed.
-- 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).
-- Supports ITRANS toggle transliteration with ## and skipping HTML tags
+- 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.
+
+<!-- - [Demo](http://vm75.github.io/inditrans/example/) -->
+- [Changelog](CHANGELOG.md)
 
 References:
 

package/dist/src/Option.js

@@ -1,13 +1,22 @@
 "use strict";
+// GENERATED CODE - DO NOT MODIFY BY HAND
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Option = void 0;
+/// Transliteration options
+/// Flags to control transliteration
 var Option;
 (function (Option) {
+    /// No options (default)
     Option[Option["None"] = 0] = "None";
+    /// Use traditional Tamil consonants only
     Option[Option["TamilTraditional"] = 1] = "TamilTraditional";
+    /// Use superscripted Tamil consonants
     Option[Option["TamilSuperscripted"] = 2] = "TamilSuperscripted";
+    /// Force ASCII numerals in transliterated text
     Option[Option["ASCIINumerals"] = 4] = "ASCIINumerals";
+    /// Ignore Vedic accents in transliterated text
     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 = {}));
 //# sourceMappingURL=Option.js.map

package/dist/src/Script.d.ts

@@ -1,19 +1,30 @@
 export declare enum Script {
     assamese = "assamese",
+    bangla = "bangla",
     bengali = "bengali",
+    burmese = "burmese",
     devanagari = "devanagari",
-    readablelatin = "readablelatin",
     gujarati = "gujarati",
     gurmukhi = "gurmukhi",
+    hindi = "hindi",
     iast = "iast",
-    indic = "indic",
     ipa = "ipa",
     iso = "iso",
     itrans = "itrans",
     kannada = "kannada",
+    khmer = "khmer",
     malayalam = "malayalam",
+    odia = "odia",
     oriya = "oriya",
+    punjabi = "punjabi",
+    readableLatin = "readableLatin",
+    sanskrit = "sanskrit",
     sinhala = "sinhala",
     tamil = "tamil",
-    telugu = "telugu"
+    tamilExtended = "tamilExtended",
+    telugu = "telugu",
+    thai = "thai",
+    tibetan = "tibetan",
+    titus = "titus",
+    wx = "wx"
 }

package/dist/src/Script.js

@@ -1,24 +1,37 @@
 "use strict";
+// GENERATED CODE - DO NOT MODIFY BY HAND
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Script = void 0;
+/// Supported scripts
 var Script;
 (function (Script) {
     Script["assamese"] = "assamese";
+    Script["bangla"] = "bangla";
     Script["bengali"] = "bengali";
+    Script["burmese"] = "burmese";
     Script["devanagari"] = "devanagari";
-    Script["readablelatin"] = "readablelatin";
     Script["gujarati"] = "gujarati";
     Script["gurmukhi"] = "gurmukhi";
+    Script["hindi"] = "hindi";
     Script["iast"] = "iast";
-    Script["indic"] = "indic";
     Script["ipa"] = "ipa";
     Script["iso"] = "iso";
     Script["itrans"] = "itrans";
     Script["kannada"] = "kannada";
+    Script["khmer"] = "khmer";
     Script["malayalam"] = "malayalam";
+    Script["odia"] = "odia";
     Script["oriya"] = "oriya";
+    Script["punjabi"] = "punjabi";
+    Script["readableLatin"] = "readableLatin";
+    Script["sanskrit"] = "sanskrit";
     Script["sinhala"] = "sinhala";
     Script["tamil"] = "tamil";
+    Script["tamilExtended"] = "tamilExtended";
     Script["telugu"] = "telugu";
+    Script["thai"] = "thai";
+    Script["tibetan"] = "tibetan";
+    Script["titus"] = "titus";
+    Script["wx"] = "wx";
 })(Script = exports.Script || (exports.Script = {}));
 //# sourceMappingURL=Script.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vm75/inditrans",
-  "version": "0.4.5",
-  "description": "An experimental transliterator library for some Indic/Brahmic scripts.",
+  "version": "0.6.0",
+  "description": "A functional transliterator library for the most common Indic/Brahmic scripts.",
   "main": "./dist/src/index.js",
   "author": "VM75",
   "license": "MIT",
@@ -9,10 +9,15 @@
     "type": "git",
     "url": "https://github.com/vm75/inditrans"
   },
+  "bugs": {
+    "url": "https://github.com/vm75/inditrans/issues"
+  },
+  "homepage": "https://github.com/vm75/inditrans",
   "files": [
     "dist/src/*.ts",
     "dist/src/*.js",
-    "dist/src/*.wasm"
+    "dist/src/*.wasm",
+    "test/"
   ],
   "types": "./dist/src/index.d.ts",
   "scripts": {
@@ -42,6 +47,7 @@
   },
   "keywords": [
     "Transliterate",
+    "Transliterator",
     "Indian",
     "Indian language",
     "Indian script",
@@ -67,5 +73,9 @@
     "ITRANS",
     "IPA",
     "TITUS"
+  ],
+  "precommit": [
+    "lint",
+    "test"
   ]
 }

package/test/index.html

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="utf-8">
+  <title>inditrans Test</title>
+  <div>
+    <button class="mybutton">Run inditrans</button>
+    <span id="content"></span>
+  </div>
+
+  <script type="module" defer>
+    import { Inditrans } from 'inditrans_wasm.js';
+    Inditrans().then(inditrans => {
+      document.querySelector('.mybutton')
+        .addEventListener('click', function () {
+          var out = inditrans.transliterate("श्री॒ गु॒रु॒भ्यो नमः॒ । ह॒रिः॒ ओ३म् ॥", "devanagari", "tamil", "");
+          document.querySelector('#content').innerHTML = out;
+        });
+    })
+  </script>
+</head>
+
+</html>

package/test/tests.ts

@@ -0,0 +1,85 @@
+import * as inditrans from '../src';
+import Tests from './test-cases.json';
+
+function getOptionsMap(): Map<string, inditrans.Option> {
+  const map = new Map<string, inditrans.Option>();
+  const optionStrings = Object.values(inditrans.Option).filter((value) =>
+    isNaN(Number(value))
+  ) as string[];
+  const optionValue = Object.values(inditrans.Option).filter(
+    (value) => !isNaN(Number(value))
+  ) as inditrans.Option[];
+  for (let i = 0; i < optionStrings.length; i++) {
+    map.set(optionStrings[i], optionValue[i]);
+  }
+  return map;
+}
+
+function getOptions(options: string): inditrans.Option {
+  const optionsMap = getOptionsMap();
+  let result = inditrans.Option.None;
+  options.split(' ').forEach((option) => {
+    result += optionsMap.get(option) || 0;
+  });
+
+  return result;
+}
+
+class TestData {
+  description: string;
+  text: string;
+  fromScript: string;
+  toScript: string;
+  options: string;
+  expected: string;
+
+  constructor(
+    description: string,
+    text: string,
+    fromScript: string,
+    toScript: string,
+    options: string,
+    expected: string
+  ) {
+    this.description = description;
+    this.text = text;
+    this.fromScript = fromScript;
+    this.toScript = toScript;
+    this.options = options;
+    this.expected = expected;
+  }
+}
+
+const testData = [];
+
+for (const input of Tests) {
+  for (const target of input.targets) {
+    testData.push(
+      new TestData(
+        input.description,
+        input.text,
+        input.script,
+        target.script,
+        target.options || '',
+        target.text
+      )
+    );
+  }
+}
+
+beforeAll(async () => {
+  await inditrans.init();
+});
+
+test.each(testData)(
+  '$description',
+  ({ text, fromScript, toScript, options, expected }) => {
+    const result = inditrans.transliterate(
+      text,
+      <inditrans.Script>fromScript,
+      <inditrans.Script>toScript,
+      getOptions(options)
+    );
+    expect(result).toBe(expected);
+  }
+);