myanmar-nrc-validator 1.0.8 → 1.0.12

package/README.md

@@ -0,0 +1,122 @@
+
+---
+
+# myanmar-nrc-validator 🇲🇲
+
+A lightweight, robust, and zero-dependency (except Zod) TypeScript/JavaScript library for validating, parsing, and formatting Myanmar National Registration Card (NRC) numbers. Supports both English and Myanmar text formats, along with a handy CLI tool.
+
+---
+
+## Features ✨
+
+* **Validation**: Accurately validates Myanmar NRC numbers (format, state codes, township codes, citizen types, and number lengths).
+* **Parsing**: Extracts structured data (State, Township, Citizen Type, and Numbers) from NRC strings.
+* **Formatting**: Converts NRC strings smoothly between Myanmar and English formats.
+* **Zod Integration**: Provides built-in Zod schemas for form validation (e.g., in Express, NestJS, or React forms).
+* **CLI Support**: Quickly check NRC numbers straight from your terminal via `npx myanmar-nrc-validator`.
+
+---
+
+## Installation 📦
+
+Install the package via npm:
+
+```bash
+npm install myanmar-nrc-validator
+
+```
+
+---
+
+## CLI Usage 💻
+
+You can test or validate NRC numbers directly from your terminal using `npx`:
+
+```bash
+npx myanmar-nrc-validator "12/UKAMA(N)123456"
+
+```
+
+
+```bash
+npx myanmar-nrc-validator "၁၂/ဥကမ(နိုင်)၁၂၃၄၅၆"
+
+```
+
+---
+
+## 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 (`parseNRC`)
+
+Extracts detailed information from an NRC string.
+
+```typescript
+import { parseNRC } from "myanmar-nrc-validator";
+
+const result = parseNRC("၁၂/ဥကမ(နိုင်)၁၂၃၄၅၆");
+console.log(result);
+/*
+Output:
+{
+  stateNumber: "12",
+  townshipCode: "ဥကမ",
+  citizenType: "နိုင်",
+  number: "၁၂၃၄၅၆"
+}
+*/
+
+```
+
+### 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. 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "myanmar-nrc-validator",
-  "version": "1.0.8",
+  "version": "1.0.12",
   "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",