SahajLipi documentation
Browse the package website for the library overview and searchable documentation, or read the Markdown guides here on GitHub. Choose the guide for the part of SahajLipi you are using. The package provides conversion and optional browser input adapters. The demo is a static playground built with that package.
The experimental Nepali developer alpha sahajlipi@0.1.0-alpha.4 was published and verified on 2026-10-09. Pin that exact version for reproducible behavior. The verified alpha and latest tags both select alpha.4; unversioned npm install sahajlipi selects alpha.4. All versions remain experimental. The release record documents registry integrity, fresh consumers and remaining limitations.
The current guides describe 0.1.0-alpha.4, including the full fallback consonants and explicit backtick or / half forms introduced in alpha.2. Alpha.1 retains its earlier behavior. The migration recipe preserves alpha.1 fallback endings with createEngine({ consonantMode: 'half' }) when adopting alpha.2 or later.
The typing reference and repository demo include the 13-key spelling slice introduced in alpha.3 and the 34 native forms shipped in alpha.4. The earlier alpha.3 artifact excludes those later forms. The release section distinguishes verified registry publication from dated candidate checks and separately deployed website content.
Reusable package
| Read | For |
|---|---|
| Getting started | Install the published alpha or a local checkout, use public imports, and choose an integration scope. |
| Integration recipes | Working candidates, TypeScript, React uncontrolled fields, and cleanup. |
| Package overview | Entry points, scope, and current distribution status. |
| API reference | Core engine and browser input APIs, one-call setup, and TypeScript declarations. |
| Typing reference | Full final consonants, internal conjuncts, explicit half forms, marks, and candidates. |
| Architecture | Conversion flow, module boundaries, Unicode, and adapter event handling. |
| Browser adapter compatibility | Desktop browser checks, reproducible setup, engine matrix, CI artifacts, and coverage limits. |
Evaluation and review
| Read | For |
|---|---|
| Alpha.4 registry publication | Official archive identity, tags, fresh JavaScript/strict TypeScript consumers and 9/9 registry-installed browser checks. |
| Alpha.3 native spelling follow-up | Twelve exact native preferences, an additional bhagna candidate, source checks and frozen development comparison. |
| Alpha.4 native-form batch | 34 exact mappings, candidate-order decisions, source access, all 12 deferrals and unchanged evaluation denominators. |
| Full-consonant candidate contracts | Full default endings, strict half compatibility, declared fixture revisions, and dated candidate evidence. |
| Developer consumer browser record | Inspect the later 51-check run, installed-package identity, and uncontrolled React lifecycle scope. |
| Digit desktop browser record | Inspect the later 42-check digit/configuration run, source identities, named flows, and limits. |
| Desktop browser run record | Inspect the dated desktop-engine results, test names, source hashes, environment, and scope limits. |
| Reviewed native spelling update | Four exact aliases, direct spelling evidence, frozen validation and unchanged-reference comparisons. |
| Loanword suffix update | Finite suffix rules, inherited readings, source evidence and dated comparisons. |
| Seed benchmark | Run behavior checks; inspect the recorded baseline, scoring rules, and exclusions. |
| Digit rendering record | Reproduce the revised default-digit contracts and separate historical Latin compatibility result. |
| Mixed-text and early-address records | Reproduce dated address-preservation comparisons with frozen fixtures, engine identities, and scope limits. |
| External evaluation | Reproduce the pinned word baseline and prepare sentence proposals for review. |
| Development review guide | Generate the 100-case development batch and record independent Nepali-language decisions. |
| Development batch report | Inspect dated source-proposal agreement and diagnostic signals, with review limitations. |
| Run manifest | Verify source pins, selected IDs, engine/tool hashes, and artifact hashes for the recorded development run. |
| Completed source-assisted review | Frozen development references, exclusions, spelling evidence and the original exact-output baseline. |
| Source-assisted online review | Inspect 100 draft recommendations, evidence scope, source links and pending human review. |
| Source-assisted review records | Read the public per-case projection, attribution and research hashes; complete sentence texts are omitted. |
| Ra-ya review and changes | Inspect exact word preferences, Shift lookup, before/after results and source-quality triage. |
| Loanword coverage audit | Review the company gap, pending catalogue, source-backed candidates, and evidence needed for broader loanword support. |
| Loanword expansion review | See the 30 later exact-word defaults, source scopes, held candidates and dated coverage limits. |
| Ra-ya machine report | Verify exact engine/fixture hashes, recorded checks and evidence limits. |
The repository Evaluation status summarizes dated baselines. The linked reports provide the evidence and limits behind each result. Unreviewed proposal agreement is not a language-accuracy score.
Browser demo
| Read | For |
|---|---|
| Demo guide | Live and local access, editor controls, candidate dropdown, and Pages hosting. |
| Live demo | Try typing in the hosted playground; its on-page guide shows the keys. |
The demo is one consumer of the package. Its Copy and Clear buttons, character count, and dropdown rendering are demo UI; the conversion rules and reusable adapter API are documented under the package.
Project and community
| Read | For |
|---|---|
| Release policy | Compatibility, versioning, migration, and the alpha release checklist. |
| Changelog | Published alpha contents and migration notes. |
| Development guide | Repository workflow, tests, CI, and release readiness. |
| Status and roadmap | Current capabilities, limits, and priorities. |
| Browser extension spike | Prototype MV3 extension, site coverage, privacy, and the path to broader typing coverage. |
| Browser extension releases | Extension versioning, packaging, store upload, rollout, and rollback. |
| Browser extension privacy policy | What the extension reads and stores, its permissions, and how to contact us. |
| Website and SEO | Markdown site builds, metadata, sitemap, publishing, and discoverability limits. |
| Brand guide | Name, message, logo assets, colors, typography and repository identity. |
| Contributing | Reporting a typing issue or proposing a focused change. |
| Security policy | Private vulnerability reporting and support status. |
| MIT license | Terms for code and documentation. |
The current Node and desktop-browser tests protect specific software behavior. The browser guide distinguishes keyboard tests from injected paste/composition events and records the tested environments. The seed benchmark uses selected examples and reports unreviewed proposals separately; these checks do not establish population-wide Nepali typing accuracy. See the benchmark protocol before interpreting its results.