myanmar-nrc-validator 1.0.8 → 1.0.13

package/README.md

@@ -0,0 +1,167 @@
+
+---
+
+# myanmar-nrc-validator 🇲🇲
+
+A comprehensive, robust, and zero-dependency (except Zod) TypeScript/JavaScript library for validating, parsing, formatting, and handling Myanmar National Registration Card (NRC) numbers, state regions, and citizen types. Supports both English and Myanmar text formats, along with a powerful CLI tool.
+
+---
+
+## Features ✨
+
+* **Validation**: Accurately validates complete Myanmar NRC numbers, state codes, and township codes.
+* **Parsing**: Extracts structured data (State Number, Township Code, Citizen Type, and ID Numbers) from NRC strings.
+* **Formatting**: Seamlessly converts NRC strings between Myanmar script and English format (`en` / `mm`).
+* **Citizen Types & Regions**: Built-in utilities to retrieve Myanmar states, townships, and citizen types (`getStates`, `getStateTownships`, `getCitizenTypes`, etc.).
+* **Composition**: Easily construct/compose valid NRC strings using `composeNRC`.
+* **Zod Integration**: Provides built-in Zod schemas for form validation (e.g., in Express, NestJS, or React forms).
+* **CLI Support**: Quickly check and parse NRC numbers straight from your terminal using `npx myanmar-nrc-validator` or `npx nrc`.
+
+---
+
+## Installation 📦
+
+Install the package via npm:
+
+```bash
+npm install myanmar-nrc-validator
+
+```
+
+---
+
+## CLI Usage 💻
+
+You can test, validate, or parse NRC numbers directly from your terminal using `npx`:
+
+```bash
+npx myanmar-nrc-validator "12/UKAMA(N)123456"
+
+```
+
+
+```bash
+npx nrc "၁၂/ဥကမ(နိုင်)၁၂၃၄၅၆"
+
+```
+
+---
+
+## Programmatic Usage (JavaScript / TypeScript) 🚀
+
+### 1. Validate NRC (`validateNRC`)
+
+Checks whether a given NRC string is valid or not.
+
+```typescript
+import { validateNRC } from "myanmar-nrc-validator";
+
+console.log(validateNRC("၁၂/ဥကမ(နိုင်)၁၂၃၄၅၆")); // true
+console.log(validateNRC("12/UKAMA(N)123456")); // true
+console.log(validateNRC("99/XYZ(N)123456"));  // false (Invalid state/township)
+
+```
+
+### 2. Parse NRC & Get Citizen Type (`parseNRC`, `getCitizenType`)
+
+Extracts detailed information and citizen types from an NRC string.
+
+```typescript
+import { parseNRC, getCitizenType } from "myanmar-nrc-validator";
+
+const result = parseNRC("၁၂/ဥကမ(နိုင်)၁၂၃၄၅၆");
+console.log(result);
+/*
+Output:
+{
+  stateNumber: "12",
+  townshipCode: "ဥကမ",
+  citizenType: "နိုင်",
+  number: "၁၂၃၄၅၆"
+}
+*/
+
+const citizenType = getCitizenType("12/UKAMA(N)123456");
+console.log(citizenType); // နိုင် (or N based on input)
+
+```
+
+### 3. Format NRC (`formatNRC`)
+
+Converts NRC text between Myanmar script and English format (`en` / `mm`).
+
+```typescript
+import { formatNRC } from "myanmar-nrc-validator";
+
+// Convert to English format
+console.log(formatNRC("၁၂/ဥကမ(နိုင်)၁၂၃၄၅၆", "en")); 
+// Output: 12/UKAMA(N)123456
+
+// Convert to Myanmar format
+console.log(formatNRC("12/UKAMA(N)123456", "mm")); 
+// Output: ၁၂/ဥကမ(နိုင်)၁၂၃၄၅၆
+
+```
+
+### 4. Regions and Citizen Types Helpers (`getStates`, `getStateTownships`, `getCitizenTypes`)
+
+Quickly access states, corresponding townships, and valid citizen categories.
+
+```typescript
+import { getStates, getStateTownships, getCitizenTypes } from "myanmar-nrc-validator";
+
+// Get all 14 states & regions
+console.log(getStates());
+
+// Get townships for a specific state (e.g., Yangon -> "12")
+console.log(getStateTownships("12"));
+
+// Get all available citizen types (နိုင်, ဧည့်, ပြု, etc.)
+console.log(getCitizenTypes());
+
+```
+
+### 5. Compose NRC (`composeNRC`)
+
+Build an NRC string programmatically from parts.
+
+```typescript
+import { composeNRC } from "myanmar-nrc-validator";
+
+const nrc = composeNRC({
+  stateNumber: "12",
+  townshipCode: "ဥကမ",
+  citizenType: "နိုင်",
+  number: "123456",
+  format: "mm"
+});
+console.log(nrc); // ၁၂/ဥကမ(နိုင်)၁၂၃၄၅၆
+
+```
+
+### 6. Zod Schema Validation (`nrcStringSchema`)
+
+Useful for API validation (e.g., with Zod, NestJS, Express, or React Hook Form).
+
+```typescript
+import { nrcStringSchema } from "myanmar-nrc-validator";
+
+const validationResult = nrcStringSchema.safeParse("၁၂/ဥကမ(နိုင်)၁၂၃၄၅၆");
+
+if (validationResult.success) {
+  console.log("Valid NRC!");
+} else {
+  console.log("Validation failed:", validationResult.error.format());
+}
+
+```
+
+---
+
+## License 📄
+
+[MIT](https://www.google.com/search?q=LICENSE) © Aung Phyo Khant
+
+---
+
+ဒီ `README.md` ဖိုင်လေးကို သင့် project ထဲက README.md ထဲမှာ ကူးထည့်လိုက်လို့ ရပါပြီ ခင်ဗျာ။ အားလုံးအဆင်ပြေသွားပါပြီနော်!

package/dist/index.d.ts

@@ -6,8 +6,13 @@ export declare const CITIZENSHIP_TYPES: Record<string, {
     en: string;
     mm: string;
 }>;
+export declare function getCitizenTypes(): {
+    code: string;
+    en: string;
+    mm: string;
+}[];
 export { validateNRC, isValidTownship } from "./utils/validator.js";
-export { parseNRC } from "./utils/parser.js";
+export { parseNRC, getCitizenType } from "./utils/parser.js";
 export type { ParsedNRC } from "./utils/parser.js";
 export { composeNRC } from "./utils/composer.js";
 export type { ComposeOptions, CitizenType } from "./utils/composer.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,aAAa,EAAiB,MAAM,CAC/C,MAAM,EACN;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAC3B,CAAC;AACF,eAAO,MAAM,iBAAiB,EAAkC,MAAM,CACpE,MAAM,EACN;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAC3B,CAAC;AAEF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,YAAY,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,YAAY,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,aAAa,EAAiB,MAAM,CAC/C,MAAM,EACN;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAC3B,CAAC;AACF,eAAO,MAAM,iBAAiB,EAAkC,MAAM,CACpE,MAAM,EACN;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,CAC3B,CAAC;AAEF,wBAAgB,eAAe;;;;IAM9B;AAED,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC7D,YAAY,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,YAAY,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/index.js

@@ -2,8 +2,15 @@ import statesData from "./data/states.json" with { type: "json" };
 import citizenTypesData from "./data/citizen-types.json" with { type: "json" };
 export const STATE_REGIONS = statesData;
 export const CITIZENSHIP_TYPES = citizenTypesData;
+export function getCitizenTypes() {
+    return Object.entries(CITIZENSHIP_TYPES).map(([code, info]) => ({
+        code,
+        en: info.en,
+        mm: info.mm,
+    }));
+}
 export { validateNRC, isValidTownship } from "./utils/validator.js";
-export { parseNRC } from "./utils/parser.js";
+export { parseNRC, getCitizenType } from "./utils/parser.js";
 export { composeNRC } from "./utils/composer.js";
 export { getStates, getStateTownships } from "./utils/regions.js";
 export { formatNRC } from "./utils/formatter.js";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,oBAAoB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAClE,OAAO,gBAAgB,MAAM,2BAA2B,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAE/E,MAAM,CAAC,MAAM,aAAa,GAAG,UAG5B,CAAC;AACF,MAAM,CAAC,MAAM,iBAAiB,GAAG,gBAGhC,CAAC;AAEF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,oBAAoB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAClE,OAAO,gBAAgB,MAAM,2BAA2B,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAE/E,MAAM,CAAC,MAAM,aAAa,GAAG,UAG5B,CAAC;AACF,MAAM,CAAC,MAAM,iBAAiB,GAAG,gBAGhC,CAAC;AAEF,MAAM,UAAU,eAAe;IAC7B,OAAO,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QAC9D,IAAI;QACJ,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,EAAE,EAAE,IAAI,CAAC,EAAE;KACZ,CAAC,CAAC,CAAC;AACN,CAAC;AAED,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACpE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAE7D,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/utils/parser.d.ts

@@ -8,4 +8,5 @@ export interface ParsedNRC {
     raw: string;
 }
 export declare function parseNRC(nrcString: string): ParsedNRC | null;
+export declare function getCitizenType(nrcString: string): string | null;
 //# sourceMappingURL=parser.d.ts.map

package/dist/utils/parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../src/utils/parser.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;CACb;AAED,wBAAgB,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAuC5D"}
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../src/utils/parser.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,SAAS;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;CACb;AAED,wBAAgB,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAuC5D;AAED,wBAAgB,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAQ/D"}

package/dist/utils/parser.js

@@ -32,4 +32,13 @@ export function parseNRC(nrcString) {
         raw: nrcString.trim(),
     };
 }
+export function getCitizenType(nrcString) {
+    if (!nrcString)
+        return null;
+    const match = nrcString.match(/\(([^)]+)\)/);
+    if (match && match[1]) {
+        return match[1].trim();
+    }
+    return null;
+}
 //# sourceMappingURL=parser.js.map

package/dist/utils/parser.js.map

@@ -1 +1 @@
-{"version":3,"file":"parser.js","sourceRoot":"","sources":["../../src/utils/parser.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAE/E,MAAM,aAAa,GAAG,UAAwD,CAAC;AAY/E,MAAM,UAAU,QAAQ,CAAC,SAAiB;IACxC,IAAI,CAAC,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,UAAU,GAAG,eAAe,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;IAErD,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GACT,iEAAiE,CAAC;IACpE,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAEtC,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/D,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,SAAS,GAAW,KAAK,CAAC,CAAC,CAAC,CAAC;IACnC,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IACxC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACtB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAExB,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,SAAS,GAAG,aAAa,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;IAEjE,OAAO;QACL,SAAS;QACT,WAAW,EAAE,SAAS,CAAC,EAAE;QACzB,WAAW,EAAE,SAAS,CAAC,EAAE;QACzB,QAAQ;QACR,IAAI;QACJ,MAAM;QACN,GAAG,EAAE,SAAS,CAAC,IAAI,EAAE;KACtB,CAAC;AACJ,CAAC"}
+{"version":3,"file":"parser.js","sourceRoot":"","sources":["../../src/utils/parser.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qBAAqB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAE/E,MAAM,aAAa,GAAG,UAAwD,CAAC;AAY/E,MAAM,UAAU,QAAQ,CAAC,SAAiB;IACxC,IAAI,CAAC,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,UAAU,GAAG,eAAe,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;IAErD,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GACT,iEAAiE,CAAC;IACpE,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAEtC,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/D,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,SAAS,GAAW,KAAK,CAAC,CAAC,CAAC,CAAC;IACnC,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IACxC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACtB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAExB,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,SAAS,GAAG,aAAa,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;IAEjE,OAAO;QACL,SAAS;QACT,WAAW,EAAE,SAAS,CAAC,EAAE;QACzB,WAAW,EAAE,SAAS,CAAC,EAAE;QACzB,QAAQ;QACR,IAAI;QACJ,MAAM;QACN,GAAG,EAAE,SAAS,CAAC,IAAI,EAAE;KACtB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,SAAiB;IAC9C,IAAI,CAAC,SAAS;QAAE,OAAO,IAAI,CAAC;IAE5B,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IAC7C,IAAI,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACtB,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "myanmar-nrc-validator",
-  "version": "1.0.8",
+  "version": "1.0.13",
   "description": "A simple npm package to validate Myanmar NRC numbers",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -14,7 +14,8 @@
     "dist"
   ],
   "bin": {
-    "myanmar-nrc-validator": "./dist/cli.js"
+    "myanmar-nrc-validator": "./dist/cli.js",
+    "nrc": "./dist/cli.js"
   },
   "scripts": {
     "build": "tsc",