egydata 1.0.1 → 1.1.1

package/README.md

@@ -1,156 +1,156 @@
-# Egydata
-
-[![NPM Version](https://img.shields.io/npm/v/egydata.svg)](https://www.npmjs.com/package/egydata)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/ahmed-ashraf-dv/egydata/blob/main/LICENSE)
-
-Structured Egyptian geographical and timezone data for Node.js and the browser.
-
-Provides a complete, offline dataset of Egyptian governorates, cities, landline and mobile area codes, and timezone utilities — with zero dependencies.
-
-[View on GitHub](https://github.com/ahmed-ashraf-dv/egydata) | [View on NPM](https://www.npmjs.com/package/egydata)
-
-## Installation
-
-```bash
-npm install egydata
-```
-
-## Quick Start
-
-```javascript
-// CommonJS
-const { governorates, cities, phoneArea, timezone } = require("egydata");
-
-// ESM
-import { governorates, cities, phoneArea, timezone } from "egydata";
-```
-
-## Usage
-
-### Governorates
-
-```javascript
-const { governorates } = require("egydata");
-
-// Get all 27 governorates
-const all = governorates.getAll();
-// [{ id: 1, code: 'CAI', name: 'القاهرة', nameEn: 'Cairo' }, ...]
-
-// Find by code
-const cairo = governorates.getByCode("CAI");
-// { id: 1, code: 'CAI', name: 'القاهرة', nameEn: 'Cairo' }
-
-// Find by id
-const gov = governorates.getById(2);
-// { id: 2, code: 'ALX', name: 'الإسكندرية', nameEn: 'Alexandria' }
-
-// Search (Arabic or English, partial match)
-const results = governorates.search("alex");
-// [{ id: 2, code: 'ALX', name: 'الإسكندرية', nameEn: 'Alexandria' }]
-
-const arResults = governorates.search("القاهرة");
-// [{ id: 1, code: 'CAI', name: 'القاهرة', nameEn: 'Cairo' }]
-```
-
-### Cities
-
-```javascript
-const { cities } = require("egydata");
-
-// Get cities by governorate code
-const cairoCities = cities.getByGovernorate("CAI");
-// [{ id: 1, name: 'مدينة نصر', nameEn: 'Nasr City', governorateCode: 'CAI' }, ...]
-
-// Find by id
-const city = cities.getById(131);
-// { id: 131, name: 'شرم الشيخ', nameEn: 'Sharm El Sheikh', governorateCode: 'SIS' }
-
-// Search cities (Arabic or English, partial match)
-const found = cities.search("Maadi");
-// [{ id: 3, name: 'المعادي', nameEn: 'Maadi', governorateCode: 'CAI' }]
-```
-
-### Phone Area Codes
-
-```javascript
-const { phoneArea } = require("egydata");
-
-// Get all area codes (landline and mobile)
-const all = phoneArea.getAll();
-// [{ code: '02', region: 'القاهرة والجيزة', regionEn: 'Cairo & Giza' }, ...]
-
-// Look up a region by code
-const region = phoneArea.getRegion("03");
-// { code: '03', region: 'الإسكندرية', regionEn: 'Alexandria' }
-
-// Find area code by region name
-const entry = phoneArea.getCode("Mansoura");
-// { code: '050', region: 'الدقهلية (المنصورة)', regionEn: 'Dakahlia (Mansoura)' }
-```
-
-### Timezone
-
-```javascript
-const { timezone } = require("egydata");
-
-console.log(timezone.name); // 'Africa/Cairo'
-console.log(timezone.offset); // '+02:00'
-
-const now = timezone.now(); // Current date/time in Egypt (Date object)
-console.log(now.toISOString());
-
-console.log(timezone.isDST()); // true or false depending on current date (Egypt resumed DST in 2023)
-```
-
-## API Reference
-
-### `governorates`
-
-| Method            | Parameters | Returns              | Description                                                  |
-| ----------------- | ---------- | -------------------- | ------------------------------------------------------------ | --------------------------------------------- | ------------------------------------ |
-| `getAll()`        | —          | `Array<Governorate>` | Returns all 27 Egyptian governorates                         |
-| `getByCode(code)` | `string`   | `Governorate         | undefined`                                                   | Find a governorate by its code (e.g. `'CAI'`) |
-| `getById(id)`     | `number    | string`              | `Governorate                                                 | undefined`                                    | Find a governorate by its numeric id |
-| `search(query)`   | `string`   | `Array<Governorate>` | Search by Arabic or English name (partial, case-insensitive) |
-
-**Governorate shape:** `{ id: number, code: string, name: string, nameEn: string }`
-
-### `cities`
-
-| Method                      | Parameters | Returns       | Description                                                  |
-| --------------------------- | ---------- | ------------- | ------------------------------------------------------------ | ---------- | ----------------------------- |
-| `getByGovernorate(govCode)` | `string`   | `Array<City>` | Get all cities in a governorate                              |
-| `getById(id)`               | `number    | string`       | `City                                                        | undefined` | Find a city by its numeric id |
-| `search(query)`             | `string`   | `Array<City>` | Search by Arabic or English name (partial, case-insensitive) |
-
-**City shape:** `{ id: number, name: string, nameEn: string, governorateCode: string }`
-
-### `phoneArea`
-
-| Method                | Parameters | Returns           | Description                                         |
-| --------------------- | ---------- | ----------------- | --------------------------------------------------- | ------------------------------------------------------- |
-| `getAll()`            | —          | `Array<AreaCode>` | Returns all Egyptian landline and mobile area codes |
-| `getRegion(code)`     | `string`   | `AreaCode         | undefined`                                          | Look up region info by area code                        |
-| `getCode(regionName)` | `string`   | `AreaCode         | undefined`                                          | Find area code entry by region name (Arabic or English) |
-
-**AreaCode shape:** `{ code: string, region: string, regionEn: string }`
-
-### `timezone`
-
-| Property / Method | Returns          | Description                                         |
-| ----------------- | ---------------- | --------------------------------------------------- |
-| `name`            | `'Africa/Cairo'` | IANA timezone identifier                            |
-| `offset`          | `'+02:00'`       | UTC offset                                          |
-| `now()`           | `Date`           | Current date/time in Egypt                          |
-| `isDST(date?)`    | `boolean`        | Whether DST is active (optionally for a given date) |
-
-## Data Coverage
-
-- **27** governorates with Arabic and English names
-- **151** cities and districts across all governorates
-- **30** landline and mobile area codes
-- Full timezone support for `Africa/Cairo`
-
-## License
-
-[MIT](LICENSE)
+# Egydata
+
+[![NPM Version](https://img.shields.io/npm/v/egydata.svg)](https://www.npmjs.com/package/egydata)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/ahmed-ashraf-dv/egydata/blob/main/LICENSE)
+
+Structured Egyptian geographical and timezone data for Node.js and the browser.
+
+Provides a complete, offline dataset of Egyptian governorates, cities, landline and mobile area codes, and timezone utilities — with zero dependencies.
+
+[View on GitHub](https://github.com/ahmed-ashraf-dv/egydata) | [View on NPM](https://www.npmjs.com/package/egydata)
+
+## Installation
+
+```bash
+npm install egydata
+```
+
+## Quick Start
+
+```javascript
+// CommonJS
+const { governorates, cities, phoneArea, timezone } = require("egydata");
+
+// ESM
+import { governorates, cities, phoneArea, timezone } from "egydata";
+```
+
+## Usage
+
+### Governorates
+
+```javascript
+const { governorates } = require("egydata");
+
+// Get all 27 governorates
+const all = governorates.getAll();
+// [{ id: 1, code: 'CAI', name: 'القاهرة', nameEn: 'Cairo' }, ...]
+
+// Find by code
+const cairo = governorates.getByCode("CAI");
+// { id: 1, code: 'CAI', name: 'القاهرة', nameEn: 'Cairo' }
+
+// Find by id
+const gov = governorates.getById(2);
+// { id: 2, code: 'ALX', name: 'الإسكندرية', nameEn: 'Alexandria' }
+
+// Search (Arabic or English, partial match)
+const results = governorates.search("alex");
+// [{ id: 2, code: 'ALX', name: 'الإسكندرية', nameEn: 'Alexandria' }]
+
+const arResults = governorates.search("القاهرة");
+// [{ id: 1, code: 'CAI', name: 'القاهرة', nameEn: 'Cairo' }]
+```
+
+### Cities
+
+```javascript
+const { cities } = require("egydata");
+
+// Get cities by governorate code
+const cairoCities = cities.getByGovernorate("CAI");
+// [{ id: 1, name: 'مدينة نصر', nameEn: 'Nasr City', governorateCode: 'CAI' }, ...]
+
+// Find by id
+const city = cities.getById(131);
+// { id: 131, name: 'شرم الشيخ', nameEn: 'Sharm El Sheikh', governorateCode: 'SIS' }
+
+// Search cities (Arabic or English, partial match)
+const found = cities.search("Maadi");
+// [{ id: 3, name: 'المعادي', nameEn: 'Maadi', governorateCode: 'CAI' }]
+```
+
+### Phone Area Codes
+
+```javascript
+const { phoneArea } = require("egydata");
+
+// Get all area codes (landline and mobile)
+const all = phoneArea.getAll();
+// [{ code: '02', region: 'القاهرة والجيزة', regionEn: 'Cairo & Giza' }, ...]
+
+// Look up a region by code
+const region = phoneArea.getRegion("03");
+// { code: '03', region: 'الإسكندرية', regionEn: 'Alexandria' }
+
+// Find area code by region name
+const entry = phoneArea.getCode("Mansoura");
+// { code: '050', region: 'الدقهلية (المنصورة)', regionEn: 'Dakahlia (Mansoura)' }
+```
+
+### Timezone
+
+```javascript
+const { timezone } = require("egydata");
+
+console.log(timezone.name); // 'Africa/Cairo'
+console.log(timezone.offset); // '+02:00'
+
+const now = timezone.now(); // Current date/time in Egypt (Date object)
+console.log(now.toISOString());
+
+console.log(timezone.isDST()); // true or false depending on current date (Egypt resumed DST in 2023)
+```
+
+## API Reference
+
+### `governorates`
+
+| Method            | Parameters         | Returns                          | Description                                                  |
+| ----------------- | ------------------ | -------------------------------- | ------------------------------------------------------------ |
+| `getAll()`        | —                  | `Array<Governorate>`             | Returns all 27 Egyptian governorates                         |
+| `getByCode(code)` | `string`           | `Governorate \| undefined`       | Find a governorate by its code (e.g. `'CAI'`)                |
+| `getById(id)`     | `number \| string` | `Governorate \| undefined`       | Find a governorate by its numeric id                         |
+| `search(query)`   | `string`           | `Array<Governorate>`             | Search by Arabic or English name (partial, case-insensitive) |
+
+**Governorate shape:** `{ id: number, code: string, name: string, nameEn: string }`
+
+### `cities`
+
+| Method                      | Parameters         | Returns                 | Description                                                  |
+| --------------------------- | ------------------ | ----------------------- | ------------------------------------------------------------ |
+| `getByGovernorate(govCode)` | `string`           | `Array<City>`           | Get all cities in a governorate                              |
+| `getById(id)`               | `number \| string` | `City \| undefined`     | Find a city by its numeric id                                |
+| `search(query)`             | `string`           | `Array<City>`           | Search by Arabic or English name (partial, case-insensitive) |
+
+**City shape:** `{ id: number, name: string, nameEn: string, governorateCode: string }`
+
+### `phoneArea`
+
+| Method                | Parameters | Returns                    | Description                                             |
+| --------------------- | ---------- | -------------------------- | ------------------------------------------------------- |
+| `getAll()`            | —          | `Array<AreaCode>`          | Returns all Egyptian landline and mobile area codes     |
+| `getRegion(code)`     | `string`   | `AreaCode \| undefined`    | Look up region info by area code                        |
+| `getCode(regionName)` | `string`   | `AreaCode \| undefined`    | Find area code entry by region name (Arabic or English) |
+
+**AreaCode shape:** `{ code: string, region: string, regionEn: string }`
+
+### `timezone`
+
+| Property / Method | Returns          | Description                                         |
+| ----------------- | ---------------- | --------------------------------------------------- |
+| `name`            | `'Africa/Cairo'` | IANA timezone identifier                            |
+| `offset`          | `'+02:00'`       | UTC offset                                          |
+| `now()`           | `Date`           | Current date/time in Egypt                          |
+| `isDST(date?)`    | `boolean`        | Whether DST is active (optionally for a given date) |
+
+## Data Coverage
+
+- **27** governorates with Arabic and English names
+- **389** cities and districts across all governorates
+- **30** landline and mobile area codes
+- Full timezone support for `Africa/Cairo`
+
+## License
+
+[MIT](LICENSE)

package/dist/cities.d.ts

@@ -0,0 +1,5 @@
+import type { City } from './types';
+export declare function getByGovernorate(govCode: unknown): City[];
+export declare function getById(id: unknown): City | undefined;
+export declare function search(query: unknown): City[];
+//# sourceMappingURL=cities.d.ts.map

package/dist/cities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cities.d.ts","sourceRoot":"","sources":["../src/cities.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAcpC,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,EAAE,CAIzD;AAED,wBAAgB,OAAO,CAAC,EAAE,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAIrD;AAED,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,EAAE,CAM7C"}

package/dist/cities.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getByGovernorate = getByGovernorate;
+exports.getById = getById;
+exports.search = search;
+const cities_json_1 = __importDefault(require("./data/cities.json"));
+const cities = cities_json_1.default;
+const idMap = new Map(cities.map((c) => [c.id, c]));
+const govMap = new Map();
+for (const city of cities) {
+    const code = city.governorateCode;
+    if (!govMap.has(code))
+        govMap.set(code, []);
+    govMap.get(code).push(city);
+}
+function getByGovernorate(govCode) {
+    if (typeof govCode !== 'string')
+        return [];
+    const list = govMap.get(govCode.toUpperCase());
+    return list ? [...list] : [];
+}
+function getById(id) {
+    const numId = Number(id);
+    if (!Number.isInteger(numId))
+        return undefined;
+    return idMap.get(numId) || undefined;
+}
+function search(query) {
+    if (typeof query !== 'string' || !query.trim())
+        return [];
+    const q = query.trim().toLowerCase();
+    return cities.filter((c) => c.name.includes(q) || c.nameEn.toLowerCase().includes(q));
+}
+//# sourceMappingURL=cities.js.map

package/dist/cities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cities.js","sourceRoot":"","sources":["../src/cities.ts"],"names":[],"mappings":";;;;;AAcA,4CAIC;AAED,0BAIC;AAED,wBAMC;AA/BD,qEAA4C;AAE5C,MAAM,MAAM,GAAW,qBAAU,CAAC;AAElC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAe,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAElE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;AACzC,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;IAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC;IAClC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC;QAAE,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC5C,MAAM,CAAC,GAAG,CAAC,IAAI,CAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC/B,CAAC;AAED,SAAgB,gBAAgB,CAAC,OAAgB;IAC/C,IAAI,OAAO,OAAO,KAAK,QAAQ;QAAE,OAAO,EAAE,CAAC;IAC3C,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAC/C,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC/B,CAAC;AAED,SAAgB,OAAO,CAAC,EAAW;IACjC,MAAM,KAAK,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;IACzB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC/C,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC;AACvC,CAAC;AAED,SAAgB,MAAM,CAAC,KAAc;IACnC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,CAAC;IAC1D,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACrC,OAAO,MAAM,CAAC,MAAM,CAClB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAChE,CAAC;AACJ,CAAC"}