lipilekhika 1.0.5 → 1.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -34,6 +34,7 @@ pnpm add lipilekhika
34
34
  bun add lipilekhika
35
35
  yarn add lipilekhika
36
36
  ```
37
+
37
38
  </details>
38
39
 
39
40
  ## 🚀 Quick Start
@@ -53,12 +54,9 @@ console.log(result); // न जायते म्रियते वा
53
54
  ```typescript
54
55
  import { transliterate } from 'lipilekhika';
55
56
 
56
- const result = await transliterate(
57
- 'గంగా',
58
- 'Devanagari',
59
- 'Gujarati',
60
- { 'brahmic_to_brahmic:replace_pancham_varga_varna_with_anusvAra': true }
61
- );
57
+ const result = await transliterate('గంగా', 'Devanagari', 'Gujarati', {
58
+ 'brahmic_to_brahmic:replace_pancham_varga_varna_with_anusvAra': true
59
+ });
62
60
  console.log(result); // ગંગા (instead of ગઙ્ગા)
63
61
  ```
64
62
 
@@ -72,6 +70,7 @@ console.log(result); // ગંગા (instead of ગઙ્ગા)
72
70
  <summary><strong><code>transliterate(text, from, to, options?)</code></strong> — Transliterate text between scripts</summary>
73
71
 
74
72
  **Parameters:**
73
+
75
74
  - `text: string` — Text to transliterate
76
75
  - `from: ScriptLangType` — Source script/language
77
76
  - `to: ScriptLangType` — Target script/language
@@ -85,6 +84,7 @@ console.log(result); // ગંગા (instead of ગઙ્ગા)
85
84
  <summary><strong><code>preloadScriptData(name)</code></strong> — Preload script data to avoid fetch latency</summary>
86
85
 
87
86
  **Parameters:**
87
+
88
88
  - `name: ScriptLangType` — Script/language name to preload
89
89
 
90
90
  **Returns:** `Promise<ScriptData>`
@@ -97,6 +97,7 @@ console.log(result); // ગંગા (instead of ગઙ્ગા)
97
97
  <summary><strong><code>getAllOptions(from, to)</code></strong> — Get available custom options for a script pair</summary>
98
98
 
99
99
  **Parameters:**
100
+
100
101
  - `from: ScriptLangType` — Source script/language
101
102
  - `to: ScriptLangType` — Target script/language
102
103
 
@@ -110,6 +111,7 @@ console.log(result); // ગંગા (instead of ગઙ્ગા)
110
111
  Read more about [WASM Module](https://lipilekhika.in/getting-started/wasm/)
111
112
 
112
113
  **Parameters:**
114
+
113
115
  - `text: string` — Text to transliterate
114
116
  - `from: ScriptLangType` — Source script/language
115
117
  - `to: ScriptLangType` — Target script/language
@@ -137,15 +139,15 @@ import { SCRIPT_LIST, LANG_LIST, ALL_LANG_SCRIPT_LIST } from 'lipilekhika';
137
139
  import type { ScriptLangType, TransliterationOptions } from 'lipilekhika';
138
140
  ```
139
141
 
140
- | Export | Description |
141
- |--------|-------------|
142
- | `SCRIPT_LIST` | Array of all supported script names |
143
- | `LANG_LIST` | Array of all supported language names mapped to scripts |
144
- | `ALL_LANG_SCRIPT_LIST` | Combined list of all scripts and languages |
145
- | `ScriptLangType` | Type for script/language identifiers (includes aliases) |
146
- | `TransliterationOptions` | Type for custom transliteration options |
147
- | `ScriptListType` | Type for the script list |
148
- | `LangListType` | Type for the language list |
142
+ | Export | Description |
143
+ | ------------------------ | ------------------------------------------------------- |
144
+ | `SCRIPT_LIST` | Array of all supported script names |
145
+ | `LANG_LIST` | Array of all supported language names mapped to scripts |
146
+ | `ALL_LANG_SCRIPT_LIST` | Combined list of all scripts and languages |
147
+ | `ScriptLangType` | Type for script/language identifiers (includes aliases) |
148
+ | `TransliterationOptions` | Type for custom transliteration options |
149
+ | `ScriptListType` | Type for the script list |
150
+ | `LangListType` | Type for the language list |
149
151
 
150
152
  ## ⌨️ Real-time Typing
151
153
 
@@ -164,7 +166,11 @@ import {
164
166
  ### Quick Example
165
167
 
166
168
  ```tsx
167
- import { createTypingContext, handleTypingBeforeInputEvent, clearTypingContextOnKeyDown } from 'lipilekhika/typing';
169
+ import {
170
+ createTypingContext,
171
+ handleTypingBeforeInputEvent,
172
+ clearTypingContextOnKeyDown
173
+ } from 'lipilekhika/typing';
168
174
 
169
175
  const ctx = createTypingContext('Telugu');
170
176
 
@@ -172,7 +178,7 @@ const ctx = createTypingContext('Telugu');
172
178
  onBeforeInput={(e) => handleTypingBeforeInputEvent(ctx, e, setText)}
173
179
  onBlur={() => ctx.clearContext()}
174
180
  onKeyDown={(e) => clearTypingContextOnKeyDown(e, ctx)}
175
- />
181
+ />;
176
182
  ```
177
183
 
178
184
  ### API
@@ -181,6 +187,7 @@ const ctx = createTypingContext('Telugu');
181
187
  <summary><strong><code>createTypingContext(script, options?)</code></strong> — Create a typing context</summary>
182
188
 
183
189
  **Parameters:**
190
+
184
191
  - `script: ScriptLangType` — Target script/language for typing
185
192
  - `options?: TypingOptions` — Custom typing options
186
193
  - `autoContextClearTimeMs?: number` (default: `4500`)
@@ -188,6 +195,7 @@ const ctx = createTypingContext('Telugu');
188
195
  - `includeInherentVowel?: boolean` (default: `false`)
189
196
 
190
197
  **Returns:** `TypingContext` with:
198
+
191
199
  - `ready: Promise<void>` — Await before using (ensures script data loaded)
192
200
  - `takeKeyInput(char: string)` — Process character input and return diff
193
201
  - `clearContext()` — Clear internal state
@@ -200,6 +208,7 @@ const ctx = createTypingContext('Telugu');
200
208
  <summary><strong><code>handleTypingBeforeInputEvent(ctx, event, callback?, options?)</code></strong> — Handle beforeinput events</summary>
201
209
 
202
210
  **Parameters:**
211
+
203
212
  - `ctx: TypingContext` — Typing context
204
213
  - `event: InputEvent` — The beforeinput event
205
214
  - `callback?: (newValue: string) => void` — Called with updated value
@@ -213,6 +222,7 @@ const ctx = createTypingContext('Telugu');
213
222
  Handles keyboard events (Arrow keys, Esc, etc.) to clear context appropriately.
214
223
 
215
224
  **Parameters:**
225
+
216
226
  - `event: KeyboardEvent` — The keydown event
217
227
  - `ctx: TypingContext` — Typing context to clear
218
228
 
@@ -240,7 +250,7 @@ const typingMap = await getScriptTypingDataMap('Telugu');
240
250
  ```html
241
251
  <script type="module">
242
252
  import { transliterate } from 'https://cdn.jsdelivr.net/npm/lipilekhika/dist/esm/index.mjs';
243
-
253
+
244
254
  const text = await transliterate('namaste', 'Normal', 'Devanagari');
245
255
  console.log(text); // नमस्ते
246
256
  </script>
@@ -254,8 +264,7 @@ const typingMap = await getScriptTypingDataMap('Telugu');
254
264
  ```html
255
265
  <script src="https://cdn.jsdelivr.net/npm/lipilekhika"></script>
256
266
  <script>
257
- lipilekhika.transliterate('namaste', 'Normal', 'Devanagari')
258
- .then(text => console.log(text)); // नमस्ते
267
+ lipilekhika.transliterate('namaste', 'Normal', 'Devanagari').then((text) => console.log(text)); // नमस्ते
259
268
  </script>
260
269
  ```
261
270
 
@@ -272,4 +281,3 @@ const typingMap = await getScriptTypingDataMap('Telugu');
272
281
  - **[Custom Options](https://lipilekhika.in/reference/custom_trans_options)** — Transliteration options reference
273
282
  - **[GitHub Repository](https://github.com/shubhattin/lipilekhika)** — Source code and issues
274
283
  - **[Changelog](./CHANGELOG.md)** — Version history and updates
275
-
@@ -0,0 +1 @@
1
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a="other",l="Romanized",n=12,r="a",m=[[".",{krama:[115],next:["."]}],["..",{krama:[116]}],["C",{krama:[61],next:["h"]}],["Ch",{krama:[62]}],["L",{next:["̥"]}],["L̥",{krama:[41],next:["̄"]}],["L̥̄",{krama:[43]}],["M",{next:["̐"]}],["M̐",{krama:[46]}],["R",{next:["̥","̤"]}],["R̤",{krama:[77],next:["h"]}],["R̤h",{krama:[80]}],["R̥",{krama:[37],next:["̄"]}],["R̥̄",{krama:[39]}],["a",{krama:[1],next:["i","u"]}],["ai",{krama:[25]}],["au",{krama:[33]}],["b",{krama:[85],next:["h"]}],["bh",{krama:[87]}],["c",{next:["h"],krama:[-1]}],["ch",{next:["h"]}],["chh",{krama:[62]}],["d",{krama:[70],next:["h"]}],["dh",{krama:[71]}],["g",{krama:[56],next:["z","h"]}],["gh",{krama:[59]}],["gz",{krama:[57]}],["j",{krama:[63],next:["z","h"]}],["jh",{krama:[66]}],["jz",{krama:[64]}],["k",{krama:[52],next:["z","h"]}],["kh",{krama:[54],next:["z"]}],["khz",{krama:[55]}],["kz",{krama:[53]}],["l",{krama:[94],next:["̥"]}],["l̥",{krama:[41],next:["̄"]}],["l̥̄",{krama:[43]}],["m",{krama:[88],next:["̐"]}],["m̐",{krama:[46]}],["p",{krama:[82],next:["h"]}],["ph",{krama:[83],next:["z"]}],["phz",{krama:[84]}],["r",{next:["̥","̤"],krama:[92]}],["r̤",{krama:[77],next:["h"]}],["r̤h",{krama:[80]}],["r̥",{krama:[37],next:["̄"]}],["r̥̄",{krama:[39]}],["s",{next:["h"]}],["sh",{next:["h"]}],["shh",{krama:[100]}],["t",{krama:[68],next:["h"]}],["th",{krama:[69]}],["Ê",{krama:[27]}],["Ñ",{krama:[67]}],["Ô",{krama:[35]}],["Ā",{krama:[5]}],["ā",{krama:[5],next:["ū"]}],["āū",{krama:[5,17],next:["ṁ"]}],["āūṁ",{krama:[0]}],["Ē",{krama:[21]}],["Ī",{krama:[11]}],["Ō",{krama:[29]}],["Ś",{krama:[99]}],["Ū",{krama:[17]}],["Ḍ",{krama:[76],next:["h"]}],["Ḍh",{krama:[79]}],["ḍ",{krama:[76],next:["h"]}],["ḍh",{krama:[79]}],["Ḥ",{krama:[47]}],["Ḷ",{krama:[95]}],["Ḻ",{krama:[96]}],["Ṁ",{krama:[45]}],["Ṅ",{krama:[60]}],["Ṇ",{krama:[81]}],["Ṉ",{krama:[73]}],["Ṛ",{krama:[37]}],["Ṝ",{krama:[39]}],["Ṟ",{krama:[93]}],["Ṣ",{krama:[100]}],["Ṭ",{krama:[74],next:["h"]}],["Ṭh",{krama:[75]}],["ṭ",{krama:[74],next:["h"]}],["ṭh",{krama:[75]}],["↑",{krama:[102],next:["↑"]}],["↑↑",{krama:[103],next:["↑"]}],["↑↑↑",{krama:[104]}]],k=[],u=[["āūṁ",null],["a",null],["a",null],["a",null],["a",null],["ā",null],["ā",null],["ā",null],["ā",null],["i",null],["i",null],["ī",null],["ī",null],["u",null],["u",null],["u",null],["u",null],["ū",null],["ū",null],["ū",null],["ū",null],["ē",null],["ē",null],["e",null],["e",null],["ai",null],["ai",null],["ê",null],["ê",null],["ō",null],["ō",null],["o",null],["o",null],["au",null],["au",null],["ô",null],["ô",null],["ṛ",null],["ṛ",null],["ṝ",null],["ṝ",null],["l̥",null],["l̥",null],["l̥̄",null],["l̥̄",null],["ṁ",null],["m̐",null],["ḥ",null],["`",null],["",null],["",null],["",null],["k",null],["kz",null],["kh",null],["khz",null],["g",null],["gz",null],["g",null],["gh",null],["ṅ",null],["ch",null],["Ch",null],["j",null],["jz",null],["j",null],["jh",null],["ñ",null],["t",null],["th",null],["d",null],["dh",null],["n",null],["ṉ",null],["ṭ",null],["ṭh",null],["ḍ",null],["r̤",null],["ḍ",null],["ḍh",null],["r̤h",null],["ṇ",null],["p",null],["ph",null],["phz",null],["b",null],["b",null],["bh",null],["m",null],["y",null],["y",null],["v",null],["r",null],["ṟ",null],["l",null],["ḷ",null],["ḻ",null],["h",null],["s",null],["ś",null],["ṣ",null],["↓",null],["↑",null],["↑↑",null],["↑↑↑",null],["0",null],["1",null],["2",null],["3",null],["4",null],["5",null],["6",null],["7",null],["8",null],["9",null],[".",null],["..",null]],t=[49,50,51,115,116,105,106,107,108,109,110,111,112,113,114,62,48,1,2,3,4,25,26,33,34,85,86,87,61,70,71,23,24,56,58,59,57,97,9,10,63,65,66,64,52,54,55,53,94,41,42,43,44,88,46,72,31,32,82,83,84,92,77,80,98,68,69,13,14,15,16,91,89,90,27,28,67,35,36,5,6,7,8,0,21,22,11,12,29,30,99,17,18,19,20,76,78,79,47,95,96,45,60,81,73,37,38,39,40,93,100,74,75,102,103,104,101],e=[["'",{next:["'"],krama:[102]}],["''",{next:["'"],krama:[103]}],["'''",{krama:[104]}],[".",{krama:[115],next:[".","q","h","A","i","I","u","U","e","E","a","O","o","R","L"]}],["..",{krama:[116]}],[".A",{krama:[6],next:["1"]}],[".A1",{krama:[8]}],[".E",{krama:[22]}],[".I",{krama:[12]}],[".L",{next:["R"],krama:[2,95]}],[".LR",{krama:[42],next:["R"]}],[".LRR",{krama:[44]}],[".O",{krama:[30]}],[".R",{krama:[38],next:["R"]}],[".RR",{krama:[40]}],[".U",{krama:[18],next:["1"]}],[".U1",{krama:[20]}],[".a",{next:["i","u"],krama:[2,2]}],[".ai",{next:["I"],krama:[2,2,2]}],[".aiI",{krama:[28]}],[".au",{next:["U"],krama:[2,2,2]}],[".auU",{krama:[36]}],[".e",{krama:[24]}],[".h",{krama:[49]}],[".i",{krama:[10]}],[".o",{krama:[32]}],[".q",{custom_back_ref:49}],[".u",{krama:[14],next:["1"]}],[".u1",{krama:[16]}],[";",{krama:[48]}],["A",{krama:[5],next:["U","^","#"]}],["A#",{custom_back_ref:1}],["AU",{krama:[5,17],next:["M"]}],["AUM",{krama:[0]}],["A^",{custom_back_ref:23}],["C",{krama:[61],next:["h"]}],["Ch",{krama:[62]}],["D",{krama:[76],next:["z","h","^","#"]}],["D#",{custom_back_ref:2}],["D^",{custom_back_ref:34}],["Dh",{krama:[79],next:["z","^"]}],["Dh^",{custom_back_ref:35}],["Dhz",{krama:[80],next:["^"]}],["Dhz^",{custom_back_ref:16}],["Dz",{krama:[77],next:["^"]}],["Dz^",{custom_back_ref:15}],["E",{next:["^","#"],krama:[21]}],["E#",{custom_back_ref:3}],["E^",{custom_back_ref:25}],["G",{next:["^"],krama:[60]}],["G^",{custom_back_ref:40}],["H",{next:["^","#"],krama:[47]}],["H#",{custom_back_ref:4}],["H^",{custom_back_ref:36}],["I",{next:["^","#"],krama:[11]}],["I#",{custom_back_ref:5}],["I^",{custom_back_ref:26}],["J",{next:["^"],krama:[67]}],["J^",{custom_back_ref:21}],["L",{krama:[95],next:["R","z","^","#"]}],["L#",{custom_back_ref:6}],["LR",{krama:[41],next:["R","^"]}],["LRR",{krama:[43],next:["^"]}],["LRR^",{custom_back_ref:8}],["LR^",{custom_back_ref:7}],["L^",{custom_back_ref:37}],["Lz",{krama:[96],next:["^"]}],["Lz^",{custom_back_ref:38}],["M",{krama:[45],next:["M","^","#"]}],["M#",{custom_back_ref:9}],["MM",{krama:[46],next:["^"]}],["MM^",{custom_back_ref:10}],["M^",{custom_back_ref:39}],["N",{next:["^","#"],krama:[81]}],["N#",{custom_back_ref:11}],["N^",{custom_back_ref:41}],["O",{next:["^","#"],krama:[29]}],["O#",{custom_back_ref:12}],["O^",{custom_back_ref:29}],["Q",{krama:[51],next:["Q"]}],["QQ",{custom_back_ref:13}],["R",{krama:[37],next:["R","^","#"]}],["R#",{custom_back_ref:14}],["RR",{krama:[39],next:["^"]}],["RR^",{custom_back_ref:44}],["R^",{custom_back_ref:43}],["S",{krama:[-1],next:["h"]}],["Sh",{krama:[100],next:["^"]}],["Sh^",{custom_back_ref:46}],["T",{krama:[74],next:["h","^","#"]}],["T#",{custom_back_ref:17}],["T^",{custom_back_ref:47}],["Th",{krama:[75],next:["^"]}],["Th^",{custom_back_ref:48}],["U",{next:["^","#"],krama:[17]}],["U#",{custom_back_ref:18}],["U^",{custom_back_ref:31}],["Y",{krama:[67]}],["_",{krama:[101]}],["a",{krama:[1],next:["i","u","a"]}],["aa",{krama:[5],next:["^"]}],["aa^",{custom_back_ref:23}],["ai",{krama:[25],next:["I"]}],["aiI",{next:["^"],krama:[2,2,2]}],["aiI^",{custom_back_ref:20}],["au",{krama:[33],next:["U"]}],["auU",{next:["^"],krama:[2,2,2]}],["auU^",{custom_back_ref:22}],["b",{krama:[85],next:["h"]}],["bh",{krama:[87]}],["c",{next:["h"],krama:[-1]}],["ch",{next:["h"]}],["chh",{krama:[62]}],["d",{krama:[70],next:["h"]}],["dh",{krama:[71]}],["e",{next:["e"],krama:[23]}],["ee",{krama:[11],next:["^"]}],["ee^",{custom_back_ref:26}],["f",{krama:[84]}],["g",{krama:[56],next:["z","h"]}],["gh",{krama:[59]}],["gz",{krama:[57]}],["i",{next:["i"],krama:[9]}],["ii",{krama:[11],next:["^"]}],["ii^",{custom_back_ref:26}],["j",{krama:[63],next:["z","h"]}],["jh",{krama:[66]}],["jz",{krama:[64]}],["k",{krama:[52],next:["z","h"]}],["kh",{krama:[54],next:["z"]}],["khz",{krama:[55]}],["kz",{krama:[53]}],["n",{krama:[72],next:["z","1"]}],["n1",{krama:[73]}],["nz",{krama:[73],next:["^"]}],["nz^",{custom_back_ref:42}],["o",{next:["o"],krama:[31]}],["oo",{krama:[17],next:["^"]}],["oo^",{custom_back_ref:31}],["p",{krama:[82],next:["h"]}],["ph",{krama:[83],next:["z"]}],["phz",{krama:[84]}],["q",{custom_back_ref:0,next:["q"]}],["qq",{custom_back_ref:19}],["r",{krama:[92],next:["z","1"]}],["r1",{krama:[93]}],["rz",{krama:[93],next:["^"]}],["rz^",{custom_back_ref:45}],["s",{next:["h"],krama:[98]}],["sh",{next:["h","^"]}],["sh^",{custom_back_ref:30}],["shh",{krama:[100]}],["t",{krama:[68],next:["h"]}],["th",{krama:[69]}],["u",{next:["u"],krama:[13]}],["uu",{krama:[17],next:["^"]}],["uu^",{custom_back_ref:31}],["w",{krama:[91]}],["z",{krama:[64],next:["h"]}],["zh",{krama:[96]}],["↑",{krama:[102],next:["↑"]}],["↑↑",{krama:[103],next:["↑"]}],["↑↑↑",{krama:[104]}]],_=[["",null,142],["A",null,31],["D",null,38],["E",null,47],["H",null,52],["I",null,55],["L",null,60],["L̥",null,64],["L̥̄",null,63],["M",null,69],["M̐",null,71],["N",null,74],["O",null,77],["Q",null,80],["R",null,82],["R̤",null,45],["R̤h",null,43],["T",null,90],["U",null,95],["q",null,143],["Ê",null,104],["Ñ",null,58],["Ô",null,107],["Ā",null,34],["Ā",null,34],["Ē",null,48],["Ī",null,56],["Ī",null,56],["Ī",null,56],["Ō",null,78],["Ś",null,150],["Ū",null,96],["Ū",null,96],["Ū",null,96],["Ḍ",null,39],["Ḍh",null,41],["Ḥ",null,53],["Ḷ",null,65],["Ḻ",null,67],["Ṁ",null,72],["Ṅ",null,50],["Ṇ",null,75],["Ṉ",null,135],["Ṛ",null,85],["Ṝ",null,84],["Ṟ",null,147],["Ṣ",null,88],["Ṭ",null,91],["Ṭh",null,93],["‍",null,26]],c={script_type:a,script_name:l,script_id:n,schwa_character:r,text_to_krama_map:m,list:k,krama_text_arr:u,krama_text_arr_index:t,typing_text_to_krama_map:e,custom_script_chars_arr:_};exports.custom_script_chars_arr=_;exports.default=c;exports.krama_text_arr=u;exports.krama_text_arr_index=t;exports.list=k;exports.schwa_character=r;exports.script_id=n;exports.script_name=l;exports.script_type=a;exports.text_to_krama_map=m;exports.typing_text_to_krama_map=e;