pakdatakit 1.0.2 → 1.1.0
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 +84 -15
- package/dist/cli.d.ts +1 -0
- package/dist/cli.js +2705 -0
- package/dist/cli.js.map +1 -0
- package/dist/index.d.ts +111 -1
- package/dist/index.js +300 -1
- package/dist/index.js.map +1 -1
- package/package.json +11 -3
package/README.md
CHANGED
|
@@ -54,6 +54,10 @@ PakDataKit provides a single, typed, reusable solution so you can focus on build
|
|
|
54
54
|
✅ IBAN Validation
|
|
55
55
|
✅ Bank Detection from IBAN
|
|
56
56
|
✅ Postal Code Lookup
|
|
57
|
+
✅ Address Parsing
|
|
58
|
+
✅ Roman Urdu Normalization
|
|
59
|
+
✅ Hijri Date Utilities
|
|
60
|
+
✅ CLI Tool
|
|
57
61
|
✅ Mobile Network Detection
|
|
58
62
|
✅ City → Province Lookup
|
|
59
63
|
✅ PKR Formatting
|
|
@@ -126,6 +130,16 @@ formatLakh(2500000);
|
|
|
126
130
|
// "25 Lakh"
|
|
127
131
|
```
|
|
128
132
|
|
|
133
|
+
### CLI
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
npx pakdatakit validate-cnic 35202-1234567-1
|
|
137
|
+
npx pakdatakit analyze-phone 03001234567
|
|
138
|
+
npx pakdatakit parse-address "House 12, Gulberg III, Lahore, Punjab 54660"
|
|
139
|
+
npx pakdatakit hijri
|
|
140
|
+
npx pakdatakit normalize-urdu "ap kia ker rhe ho"
|
|
141
|
+
```
|
|
142
|
+
|
|
129
143
|
---
|
|
130
144
|
|
|
131
145
|
# API Reference
|
|
@@ -206,8 +220,6 @@ formatPhone("+92 300-123-4567");
|
|
|
206
220
|
|
|
207
221
|
---
|
|
208
222
|
|
|
209
|
-
---
|
|
210
|
-
|
|
211
223
|
### analyzePhone()
|
|
212
224
|
|
|
213
225
|
Runs validation, formatting, and network detection in one call.
|
|
@@ -431,6 +443,57 @@ searchCities("kar");
|
|
|
431
443
|
|
|
432
444
|
---
|
|
433
445
|
|
|
446
|
+
### getDistrictProvince() / searchDistricts()
|
|
447
|
+
|
|
448
|
+
District-level geography lookup across 171 districts.
|
|
449
|
+
|
|
450
|
+
```ts
|
|
451
|
+
getDistrictProvince("Lahore"); // "Punjab"
|
|
452
|
+
searchDistricts("karachi"); // ["Karachi Central", "Karachi East", ...]
|
|
453
|
+
```
|
|
454
|
+
|
|
455
|
+
---
|
|
456
|
+
|
|
457
|
+
## Address Utilities
|
|
458
|
+
|
|
459
|
+
### parseAddress()
|
|
460
|
+
|
|
461
|
+
Parses free-form Pakistani addresses into structured components.
|
|
462
|
+
|
|
463
|
+
```ts
|
|
464
|
+
parseAddress("House 12, Gulberg III, Lahore, Punjab 54660");
|
|
465
|
+
// { street: "House 12", area: "Gulberg III", city: "Lahore", province: "Punjab", postalCode: "54660", ... }
|
|
466
|
+
```
|
|
467
|
+
|
|
468
|
+
### formatAddress()
|
|
469
|
+
|
|
470
|
+
Formats structured components back into a mailing address string.
|
|
471
|
+
|
|
472
|
+
---
|
|
473
|
+
|
|
474
|
+
## Text Utilities
|
|
475
|
+
|
|
476
|
+
### normalizeRomanUrdu()
|
|
477
|
+
|
|
478
|
+
Normalizes informal Roman Urdu spellings (`ap kia ker` → `aap kya kar`).
|
|
479
|
+
|
|
480
|
+
### toUrduDigits() / toEnglishDigits()
|
|
481
|
+
|
|
482
|
+
Convert between English, Urdu, and Arabic-Indic digits.
|
|
483
|
+
|
|
484
|
+
---
|
|
485
|
+
|
|
486
|
+
## Hijri Calendar
|
|
487
|
+
|
|
488
|
+
### toHijri() / formatHijri() / isRamadan()
|
|
489
|
+
|
|
490
|
+
```ts
|
|
491
|
+
formatHijri(new Date()); // "14 Ramadan 1447"
|
|
492
|
+
isRamadan(new Date()); // true | false
|
|
493
|
+
```
|
|
494
|
+
|
|
495
|
+
---
|
|
496
|
+
|
|
434
497
|
## Currency Formatting
|
|
435
498
|
|
|
436
499
|
### formatPKR()
|
|
@@ -548,26 +611,32 @@ The PakDataKit Playground will provide:
|
|
|
548
611
|
* Postal Code Lookup
|
|
549
612
|
* Expanded datasets (150 cities, 171 districts, 109 postal codes, 46 banks)
|
|
550
613
|
|
|
551
|
-
### v0.3
|
|
614
|
+
### v0.3 ✅
|
|
615
|
+
|
|
616
|
+
* Address Parsing (`parseAddress`, `formatAddress`)
|
|
617
|
+
* Expanded Postal Data (`getPostalAreas`, `searchPostalCodes`)
|
|
618
|
+
|
|
619
|
+
### v0.4 ✅
|
|
552
620
|
|
|
553
|
-
*
|
|
554
|
-
*
|
|
621
|
+
* Roman Urdu Utilities (`normalizeRomanUrdu`)
|
|
622
|
+
* Text Normalization (`normalizeText`, `toUrduDigits`, `toEnglishDigits`)
|
|
555
623
|
|
|
556
|
-
### v0.
|
|
624
|
+
### v0.5 ✅
|
|
557
625
|
|
|
558
|
-
*
|
|
559
|
-
*
|
|
626
|
+
* Islamic Calendar Utilities (`toHijri`, `fromHijri`, `formatHijri`)
|
|
627
|
+
* Hijri Date Helpers (`getHijriMonthName`, `isRamadan`)
|
|
560
628
|
|
|
561
|
-
###
|
|
629
|
+
### v1.0 ✅
|
|
562
630
|
|
|
563
|
-
*
|
|
564
|
-
*
|
|
631
|
+
* CLI Tool (`pakdatakit` command)
|
|
632
|
+
* Dataset-backed lookup APIs
|
|
633
|
+
* Community Contributions (see CONTRIBUTING.md)
|
|
565
634
|
|
|
566
|
-
### v1.
|
|
635
|
+
### v1.1+
|
|
567
636
|
|
|
568
|
-
*
|
|
569
|
-
*
|
|
570
|
-
*
|
|
637
|
+
* Interactive Playground
|
|
638
|
+
* CNIC checksum validation
|
|
639
|
+
* Mobile Number Portability lookup API
|
|
571
640
|
|
|
572
641
|
---
|
|
573
642
|
|
package/dist/cli.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
#!/usr/bin/env node
|