tamil-toolkit 0.0.0-stage → 0.1.0-alpha.10
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/LICENSE +201 -0
- package/NOTICE +42 -0
- package/README.md +228 -2
- package/THIRD_PARTY_LICENSES.txt +12501 -0
- package/THIRD_PARTY_NOTICES.md +207 -0
- package/dist/api.d.ts +848 -0
- package/dist/api.js +254 -0
- package/dist/index.d.ts +27 -0
- package/dist/index.js +10 -0
- package/dist/web.d.ts +29 -0
- package/dist/web.js +11 -0
- package/package.json +69 -4
- package/pkg-node/LICENSE +201 -0
- package/pkg-node/README.md +229 -0
- package/pkg-node/package.json +17 -0
- package/pkg-node/tamil_toolkit.d.ts +4 -0
- package/pkg-node/tamil_toolkit.js +132 -0
- package/pkg-node/tamil_toolkit_bg.wasm +0 -0
- package/pkg-node/tamil_toolkit_bg.wasm.d.ts +10 -0
- package/pkg-web/LICENSE +201 -0
- package/pkg-web/README.md +229 -0
- package/pkg-web/package.json +21 -0
- package/pkg-web/tamil_toolkit.d.ts +39 -0
- package/pkg-web/tamil_toolkit.js +237 -0
- package/pkg-web/tamil_toolkit_bg.wasm +0 -0
- package/pkg-web/tamil_toolkit_bg.wasm.d.ts +10 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Work; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text file from the Work,
|
|
120
|
+
provided that such additional attribution notices cannot be
|
|
121
|
+
construed as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, or indemnity
|
|
168
|
+
obligations and/or other liability rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, and not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description that describes the same
|
|
186
|
+
purpose as the file be included on the same "printed page" as the
|
|
187
|
+
copyright notice for the particular page.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Abishtakan Sivachandrathevan and tamil-toolkit contributors
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
tamil-toolkit
|
|
2
|
+
Copyright 2026 Abishtakan Sivachandrathevan and tamil-toolkit contributors
|
|
3
|
+
|
|
4
|
+
This product includes software originally created by Abishtakan Sivachandrathevan
|
|
5
|
+
and developed with tamil-toolkit contributors:
|
|
6
|
+
https://github.com/abishtakan/tamil-toolkit
|
|
7
|
+
|
|
8
|
+
Licensed under the Apache License, Version 2.0 (the "License").
|
|
9
|
+
You may obtain a copy of the License in the LICENSE file or at:
|
|
10
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
Third-Party Attributions and Upstream Notices
|
|
15
|
+
|
|
16
|
+
Original tamil-toolkit code is licensed under Apache-2.0. Upstream datasets,
|
|
17
|
+
standards, and reference mappings retain their original licenses and terms as
|
|
18
|
+
recorded in THIRD_PARTY_NOTICES.md:
|
|
19
|
+
|
|
20
|
+
- Unicode 17.0.0 and CLDR 49 data: Unicode, Inc. (Unicode License V3)
|
|
21
|
+
https://www.unicode.org/ and https://cldr.unicode.org/
|
|
22
|
+
- Dictionary data packs (when bundled): English and Tamil Wiktionary contributors
|
|
23
|
+
(CC-BY-SA-4.0; see lexicon/dictionary/ and lexicon/packs/ notices)
|
|
24
|
+
- Bamini mapping references:
|
|
25
|
+
- ag-sanjjeev/app-tamil-fonts-unicode-converter (MIT)
|
|
26
|
+
- Pakeetharan/unicode-bamini-converter (MIT)
|
|
27
|
+
- TSCII mapping reference: mayooresan/Android-TamilUtil (MIT)
|
|
28
|
+
- Thirukanitham Drik astronomical calculations: `astro` 2.0.0 by Saurav
|
|
29
|
+
Sachidanand (MIT)
|
|
30
|
+
- City coordinates: GeoNames (CC BY 4.0)
|
|
31
|
+
- Legacy 16-bit CID font mapping references (LT-TM, Vanavil, Senthamil,
|
|
32
|
+
Shree-Tam, Softview, TBO): Azhagi+ Portable reference configurations
|
|
33
|
+
(see docs/specs/codec-*.md for digests and scope)
|
|
34
|
+
- Bharathi Tamil Braille Grade 1 reference: World Braille Usage / NIEPVD
|
|
35
|
+
(see docs/specs/codec-braille.md)
|
|
36
|
+
- Transliteration and keyboard layout references: ISO 15919, University of
|
|
37
|
+
Madras Tamil Lexicon, ITRANS, Harvard-Kyoto, TamilNet'99 (ELCOT), Anjal
|
|
38
|
+
Phonetic, and Suratha Bamini (see docs/specs/translit-v0.1.md)
|
|
39
|
+
- Weekday Latin transliterations: Vidya Mohan and Rajiv Ranjan, Basic Tamil
|
|
40
|
+
(2024), chapter 6.1 (CC BY-NC 4.0)
|
|
41
|
+
- Historical Vakyakarana mathematical tables: Vakyakarana with Sundararaja's
|
|
42
|
+
Laghuprakashika, eds. T. S. Kuppanna Sastri and K. V. Sarma (1962)
|
package/README.md
CHANGED
|
@@ -1,3 +1,229 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
# tamil-toolkit for JavaScript & TypeScript
|
|
4
|
+
|
|
5
|
+
### High-Performance Tamil Text Processing, Unicode & Font Transcoder for Node.js and Browsers
|
|
6
|
+
|
|
7
|
+
**Zero-dependency WebAssembly · Bamini / TSCII / TAB / TAM / Vanavil font conversion · Grapheme segmentation · Agara varisai sorting · Currency & Numerals · 100% offline & private**
|
|
8
|
+
|
|
9
|
+
[](https://www.npmjs.com/package/tamil-toolkit)
|
|
10
|
+
[](https://www.npmjs.com/package/tamil-toolkit)
|
|
11
|
+
[](https://github.com/abishtakan/tamil-toolkit/actions/workflows/ci.yml)
|
|
12
|
+
[](https://github.com/abishtakan/tamil-toolkit/blob/master/LICENSE)
|
|
13
|
+
[](bindings/js-wasm)
|
|
14
|
+
[](bindings/js-wasm)
|
|
15
|
+
|
|
16
|
+
[Install](#install) · [Node Quick Start](#node-quick-start) · [Browser Quick Start](#browser-quick-start) · [Use Cases](#practical-web-recipes) · [Documentation](#documentation) · [License](#license)
|
|
17
|
+
|
|
18
|
+
</div>
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
**tamil-toolkit** is the premier, high-performance Tamil text and Unicode processing library for JavaScript, TypeScript, Node.js, and modern web browsers. Powered by compiled Rust WebAssembly (WASM), it brings zero-latency, deterministic Tamil computing to frontend web apps, serverless functions, and backend services.
|
|
23
|
+
|
|
24
|
+
Runs **100% client-side** with zero network tracking, zero external dependencies, and complete offline PWA compatibility.
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## What is Included
|
|
29
|
+
|
|
30
|
+
| Domain | Capabilities in JS / TS / WASM |
|
|
31
|
+
|---|---|
|
|
32
|
+
| 🔤 **Unicode & Letters** | NFC/NFD normalization, tailored Tamil grapheme segmentation (`get_letters`), Mei/Uyir splitting, and scalar inspection. Handles complex ligatures like `க்ஷ` and `ஸ்ரீ`. |
|
|
33
|
+
| 🔄 **Legacy Font Transcoder** | Universal bidirectional transcoding between Unicode and legacy Tamil encoding formats: **Bamini**, **TSCII**, **TAB**, **TAM**, **Anjal**, **Vanavil Avvaiyar**, and **LT-TM / IndoWord**. |
|
|
34
|
+
| 🔠 **Agara Varisai Collation** | Traditional Tamil dictionary alphabetical sorting with stable Mei-first collation order (`sort_words`, `compare`). |
|
|
35
|
+
| 🔢 **Numerals & Currency** | Bounded Tamil Nadu (`ta-IN`) and Sri Lankan (`ta-LK`) number-to-words conversion, exact financial currency formatting (INR/LKR) with zero floating-point drift, and Gregorian civil dates. |
|
|
36
|
+
| 🎵 **Phonology & Prosody** | Tholkappiyam-grounded phonology: mora (*Maathirai*) duration calculation, letter quantity classification (`is_kuril`, `is_nedil`, `is_mei`, `is_aytham`), stop-nasal cognates (*Ina Ezhuthu*), and syllable nuclei (*Olippasai*). |
|
|
37
|
+
| 📅 **Solar Calendar & Panchangam** | Classical Thirukanitham Drik and 1962 Vākyakaraṇa calendar models: Gregorian ↔ Tamil solar date conversion, 60-year Jovian cycles, and five-limb astronomical panchangam calculations. |
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## Install
|
|
42
|
+
|
|
43
|
+
Node.js 22+ is supported. Install alpha 10 from npm’s `alpha` dist-tag:
|
|
44
|
+
|
|
45
|
+
```sh
|
|
46
|
+
npm install tamil-toolkit@alpha
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Or using pnpm / yarn:
|
|
50
|
+
|
|
51
|
+
```sh
|
|
52
|
+
pnpm add tamil-toolkit@alpha
|
|
53
|
+
# or
|
|
54
|
+
yarn add tamil-toolkit@alpha
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
The `alpha` tag points to `0.1.0-alpha.10`; npm’s `latest` tag still points to `0.1.0-alpha.1`. The version badge above tracks the `alpha` tag.
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## Node Quick Start
|
|
62
|
+
|
|
63
|
+
In Node.js (ESM or TypeScript), the native WebAssembly module initializes automatically on import:
|
|
64
|
+
|
|
65
|
+
```typescript
|
|
66
|
+
import * as tamil from "tamil-toolkit";
|
|
67
|
+
|
|
68
|
+
// 1. Grapheme Segmentation (handles ligatures accurately)
|
|
69
|
+
const text = "தமிழ்நாடு";
|
|
70
|
+
const letters = tamil.get_letters(text);
|
|
71
|
+
console.log("Letters:", letters); // [ 'த', 'மி', 'ழ்', 'நா', 'டு' ]
|
|
72
|
+
|
|
73
|
+
// 2. Legacy Font Conversion (Bamini, TSCII, TAB, TAM, Vanavil)
|
|
74
|
+
const bamini = tamil.unicode_to_bamini(text);
|
|
75
|
+
console.log("Bamini encoded:", bamini); // "jkpo;ehL"
|
|
76
|
+
console.log("Back to Unicode:", tamil.bamini_to_unicode(bamini)); // "தமிழ்நாடு"
|
|
77
|
+
|
|
78
|
+
// 3. Exact Currency & Cheque Formatting (no float errors!)
|
|
79
|
+
console.log(tamil.format_currency(102550, "INR", "TN")); // "INR 1,025.50"
|
|
80
|
+
console.log(tamil.format_currency(102550, "LKR", "SL")); // "LKR 1,025.50"
|
|
81
|
+
|
|
82
|
+
// 4. Tamil Alphabetical Sorting (Agara Varisai)
|
|
83
|
+
const words = ["ஆப்பிள்", "அணில்", "இலை", "ஈட்டி"];
|
|
84
|
+
console.log(tamil.sort_words(words)); // [ 'அணில்', 'ஆப்பிள்', 'இலை', 'ஈட்டி' ]
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## Browser Quick Start
|
|
90
|
+
|
|
91
|
+
For browser applications (Vite, Next.js, Webpack, Nuxt, or Vanilla JS), use the `/web` entry point and initialize WebAssembly once before calling API methods:
|
|
92
|
+
|
|
93
|
+
```typescript
|
|
94
|
+
import { init, get_letters, unicode_to_bamini, bamini_to_unicode } from "tamil-toolkit/web";
|
|
95
|
+
|
|
96
|
+
// 1. Initialize WebAssembly module (load and compile WASM)
|
|
97
|
+
await init();
|
|
98
|
+
|
|
99
|
+
// 2. Ready to use!
|
|
100
|
+
const letters = get_letters("வணக்கம்");
|
|
101
|
+
console.log(letters); // [ 'வ', 'ண', 'க்', 'க', 'ம்' ]
|
|
102
|
+
|
|
103
|
+
const bamini = unicode_to_bamini("வணக்கம்");
|
|
104
|
+
console.log(bamini); // "tzf;fk;"
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Next.js & React Example:
|
|
108
|
+
|
|
109
|
+
```tsx
|
|
110
|
+
"use client";
|
|
111
|
+
|
|
112
|
+
import { useEffect, useState } from "react";
|
|
113
|
+
import { init, unicode_to_bamini, bamini_to_unicode } from "tamil-toolkit/web";
|
|
114
|
+
|
|
115
|
+
export default function TamilConverter() {
|
|
116
|
+
const [ready, setReady] = useState(false);
|
|
117
|
+
const [input, setInput] = useState("தமிழ்");
|
|
118
|
+
const [output, setOutput] = useState("");
|
|
119
|
+
|
|
120
|
+
useEffect(() => {
|
|
121
|
+
init().then(() => setReady(true));
|
|
122
|
+
}, []);
|
|
123
|
+
|
|
124
|
+
const handleConvert = () => {
|
|
125
|
+
if (ready) {
|
|
126
|
+
setOutput(unicode_to_bamini(input));
|
|
127
|
+
}
|
|
128
|
+
};
|
|
129
|
+
|
|
130
|
+
return (
|
|
131
|
+
<div>
|
|
132
|
+
<input value={input} onChange={(e) => setInput(e.target.value)} />
|
|
133
|
+
<button onClick={handleConvert} disabled={!ready}>Convert to Bamini</button>
|
|
134
|
+
<p>Result: {output}</p>
|
|
135
|
+
</div>
|
|
136
|
+
);
|
|
137
|
+
}
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
---
|
|
141
|
+
|
|
142
|
+
## Practical Web Recipes
|
|
143
|
+
|
|
144
|
+
### 1. Sorting Tamil Arrays in UI State (Agara Varisai)
|
|
145
|
+
|
|
146
|
+
Use `compare` directly in standard JavaScript `Array.prototype.sort()`:
|
|
147
|
+
|
|
148
|
+
```typescript
|
|
149
|
+
import { compare } from "tamil-toolkit";
|
|
150
|
+
|
|
151
|
+
const users = [
|
|
152
|
+
{ name: "கவிதா" },
|
|
153
|
+
{ name: "அமுதா" },
|
|
154
|
+
{ name: "பாரதி" }
|
|
155
|
+
];
|
|
156
|
+
|
|
157
|
+
users.sort((a, b) => compare(a.name, b.name));
|
|
158
|
+
// Result: அமுதா, கவிதா, பாரதி
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
### 2. Converting Legacy Files & Clipboard Content
|
|
162
|
+
|
|
163
|
+
```typescript
|
|
164
|
+
import * as tamil from "tamil-toolkit";
|
|
165
|
+
|
|
166
|
+
// Transcode Bamini clipboard text
|
|
167
|
+
function convertClipboard(pastedText: string): string {
|
|
168
|
+
try {
|
|
169
|
+
return tamil.bamini_to_unicode(pastedText);
|
|
170
|
+
} catch (err) {
|
|
171
|
+
console.error("Transcoding error:", err);
|
|
172
|
+
return pastedText;
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
---
|
|
178
|
+
|
|
179
|
+
## Alpha 10 scope
|
|
180
|
+
|
|
181
|
+
The npm `0.1.0-alpha.10` package includes the capabilities listed above. The
|
|
182
|
+
shared `execute` API exposes `lt_tm_codes_to_unicode`, `lt_tm_text_to_unicode`,
|
|
183
|
+
`unicode_to_lt_tm_codes`, and `unicode_to_lt_tm_text`. LT-TM conversion handles
|
|
184
|
+
selected 16-bit code sequences; it does not parse PDFs, select font runs, or
|
|
185
|
+
detect encodings. The profile does not claim complete historical-font coverage.
|
|
186
|
+
APIs may change.
|
|
187
|
+
|
|
188
|
+
Other planned linguistic modules, the private PDF extraction utility, and
|
|
189
|
+
Dart/Pub distribution are not published.
|
|
190
|
+
|
|
191
|
+
```javascript
|
|
192
|
+
import * as tamil from "tamil-toolkit";
|
|
193
|
+
|
|
194
|
+
const codes = tamil.execute({ op: "unicode_to_lt_tm_codes", input: { text: "தமிழ்" } });
|
|
195
|
+
const text = tamil.execute({ op: "lt_tm_codes_to_unicode", input: { codes } });
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
---
|
|
199
|
+
|
|
200
|
+
## Author & Maintainer
|
|
201
|
+
|
|
202
|
+
**Abishtakan Sivachandrathevan** ([@abishtakan](https://github.com/abishtakan))
|
|
203
|
+
|
|
204
|
+
---
|
|
205
|
+
|
|
206
|
+
## Documentation
|
|
207
|
+
|
|
208
|
+
- [API and feature overview](https://github.com/abishtakan/tamil-toolkit#capability-contracts)
|
|
209
|
+
- [JavaScript/WASM API declarations](https://github.com/abishtakan/tamil-toolkit/tree/master/bindings/js-wasm)
|
|
210
|
+
- [Unicode/core contract](https://github.com/abishtakan/tamil-toolkit/blob/master/docs/specs/core-v0.1.md)
|
|
211
|
+
- [Collation contract](https://github.com/abishtakan/tamil-toolkit/blob/master/docs/specs/collate-v0.1.md)
|
|
212
|
+
- [Numerals, fractions, and dates](https://github.com/abishtakan/tamil-toolkit/blob/master/docs/specs/numerals-v0.2.md)
|
|
213
|
+
- [Codec contract and alpha 3 limits](https://github.com/abishtakan/tamil-toolkit/blob/master/docs/releases/alpha-10.md#compatibility-and-scope)
|
|
214
|
+
- [LT-TM CID profile contract](https://github.com/abishtakan/tamil-toolkit/blob/master/docs/specs/codec-lt-tm.md)
|
|
215
|
+
- [Third-party notices](https://github.com/abishtakan/tamil-toolkit/blob/master/THIRD_PARTY_NOTICES.md)
|
|
216
|
+
|
|
217
|
+
---
|
|
218
|
+
|
|
219
|
+
## License
|
|
220
|
+
|
|
221
|
+
Original code is [Apache-2.0 licensed](https://github.com/abishtakan/tamil-toolkit/blob/master/LICENSE) (see [NOTICE](https://github.com/abishtakan/tamil-toolkit/blob/master/NOTICE)).
|
|
222
|
+
Bundled data and mappings retain their recorded terms in the
|
|
223
|
+
[third-party notices](https://github.com/abishtakan/tamil-toolkit/blob/master/THIRD_PARTY_NOTICES.md).
|
|
224
|
+
|
|
225
|
+
---
|
|
226
|
+
|
|
227
|
+
## Keywords & Search Queries
|
|
228
|
+
|
|
229
|
+
`tamil npm`, `tamil unicode javascript`, `bamini to unicode converter npm`, `tscii to unicode javascript`, `tamil font converter web`, `tamil text processing nodejs`, `tamil sort agara varisai js`, `tamil numbers to words npm`, `tamil wasm webassembly`, `offline tamil converter`.
|