nepal-places 0.1.1

package/dist/data/provinces.d.ts

@@ -0,0 +1,2 @@
+import type { Province } from '../types.js';
+export declare const provinces: Province[];

package/dist/data/provinces.js

@@ -0,0 +1,72 @@
+export const provinces = [
+    {
+        id: 1,
+        name: 'Koshi',
+        alt_name: 'Province No. 1',
+        name_np: 'कोशी',
+        headquarters: 'Biratnagar',
+        area_km2: 25905,
+        population: 4972021,
+        district_count: 14,
+    },
+    {
+        id: 2,
+        name: 'Madhesh',
+        alt_name: 'Province No. 2',
+        name_np: 'मधेश',
+        headquarters: 'Janakpur',
+        area_km2: 9661,
+        population: 6126288,
+        district_count: 8,
+    },
+    {
+        id: 3,
+        name: 'Bagmati',
+        alt_name: 'Province No. 3',
+        name_np: 'बागमती',
+        headquarters: 'Hetauda',
+        area_km2: 20300,
+        population: 6084042,
+        district_count: 13,
+    },
+    {
+        id: 4,
+        name: 'Gandaki',
+        alt_name: 'Province No. 4',
+        name_np: 'गण्डकी',
+        headquarters: 'Pokhara',
+        area_km2: 21504,
+        population: 2479745,
+        district_count: 11,
+    },
+    {
+        id: 5,
+        name: 'Lumbini',
+        alt_name: 'Province No. 5',
+        name_np: 'लुम्बिनी',
+        headquarters: 'Deukhuri',
+        area_km2: 22288,
+        population: 5124225,
+        district_count: 12,
+    },
+    {
+        id: 6,
+        name: 'Karnali',
+        alt_name: 'Province No. 6',
+        name_np: 'कर्णाली',
+        headquarters: 'Birendranagar',
+        area_km2: 27984,
+        population: 1694889,
+        district_count: 10,
+    },
+    {
+        id: 7,
+        name: 'Sudurpashchim',
+        alt_name: 'Province No. 7',
+        name_np: 'सुदूरपश्चिम',
+        headquarters: 'Godawari',
+        area_km2: 19999.28,
+        population: 2711270,
+        district_count: 9,
+    },
+];

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types.js';
+export * from './data/index.js';
+export { getProvinces, getProvince, getDistricts, getDistrict, getMunicipalities, getMunicipality, getWards, getHierarchy, toFlat, } from './utils.js';

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from './types.js';
+export * from './data/index.js';
+export { getProvinces, getProvince, getDistricts, getDistrict, getMunicipalities, getMunicipality, getWards, getHierarchy, toFlat, } from './utils.js';

package/dist/types.d.ts

@@ -0,0 +1,57 @@
+export interface Province {
+    id: number;
+    name: string;
+    name_np: string;
+    alt_name?: string;
+    headquarters: string;
+    area_km2: number;
+    population: number;
+    district_count: number;
+}
+export interface District {
+    id: number;
+    province_id: number;
+    name: string;
+    name_np?: string;
+    headquarters: string;
+    area_km2: number;
+    population: number;
+}
+export type LocalLevelType = 'metropolitan' | 'sub_metropolitan' | 'municipality' | 'rural_municipality';
+export interface LocalLevel {
+    id: number;
+    district_id: number;
+    name: string;
+    name_np?: string;
+    type: LocalLevelType;
+    wards: number;
+}
+export interface Ward {
+    id: number;
+    local_level_id: number;
+    ward_number: number;
+}
+export type Depth = 1 | 2 | 3 | 4 | 5;
+export interface PlaceResponse<TDepth extends Depth = 4> {
+    province: Province;
+    district: TDepth extends 1 ? never : District;
+    localLevel: TDepth extends 1 | 2 ? never : LocalLevel;
+    ward: TDepth extends 1 | 2 | 3 ? never : Ward;
+}
+export interface PlaceFlat {
+    province_id?: number;
+    district_id?: number;
+    local_level_id?: number;
+    ward_id?: number;
+    code?: string;
+}
+export interface HierarchyOptions {
+    depth?: Depth;
+    flat?: boolean;
+}
+export interface FilterOptions {
+    provinceId?: number;
+    districtId?: number;
+    localLevelId?: number;
+    type?: LocalLevelType;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/utils.d.ts

@@ -0,0 +1,15 @@
+import type { District, HierarchyOptions, LocalLevel, PlaceFlat, Province, Ward } from './types.js';
+export declare function getProvinces(): Province[];
+export declare function getProvince(id: number): Province | undefined;
+export declare function getDistricts(provinceId?: number): District[];
+export declare function getDistrict(id: number): District | undefined;
+export declare function getMunicipalities(districtId?: number): LocalLevel[];
+export declare function getMunicipality(id: number): LocalLevel | undefined;
+export declare function getWards(municipalityId: number): Ward[];
+export declare function getHierarchy(options: HierarchyOptions & {
+    flat: true;
+}): PlaceFlat | null;
+export declare function getHierarchy(options?: HierarchyOptions): Record<string, unknown> | null;
+export declare function toFlat(obj: Record<string, {
+    id: number;
+}>, depth: number): PlaceFlat;

package/dist/utils.js

@@ -0,0 +1,85 @@
+import { districts, municipalities, provinces } from './data/index.js';
+export function getProvinces() {
+    return provinces;
+}
+export function getProvince(id) {
+    return provinces.find((p) => p.id === id);
+}
+export function getDistricts(provinceId) {
+    if (provinceId)
+        return districts.filter((d) => d.province_id === provinceId);
+    return districts;
+}
+export function getDistrict(id) {
+    return districts.find((d) => d.id === id);
+}
+export function getMunicipalities(districtId) {
+    if (districtId)
+        return municipalities.filter((m) => m.district_id === districtId);
+    return municipalities;
+}
+export function getMunicipality(id) {
+    return municipalities.find((m) => m.id === id);
+}
+export function getWards(municipalityId) {
+    const m = getMunicipality(municipalityId);
+    if (!m || m.wards === 0)
+        return [];
+    const wards = [];
+    for (let i = 1; i <= m.wards; i++) {
+        wards.push({ id: i, local_level_id: municipalityId, ward_number: i });
+    }
+    return wards;
+}
+export function getHierarchy(options = {}) {
+    const { depth = 4 } = options;
+    // Return all provinces if no filtering
+    const firstProvince = provinces[0];
+    if (!firstProvince)
+        return null;
+    const result = {
+        province: firstProvince,
+    };
+    if (depth >= 2) {
+        const district = districts.find((d) => d.province_id === firstProvince.id);
+        if (district)
+            result.district = district;
+    }
+    if (depth >= 3) {
+        const localLevel = municipalities.find((m) => m.district_id === result.district?.id);
+        if (localLevel)
+            result.localLevel = localLevel;
+    }
+    if (depth >= 4) {
+        const localLevel = result.localLevel;
+        if (localLevel && localLevel.wards > 0) {
+            result.ward = { id: 1, local_level_id: localLevel.id, ward_number: 1 };
+        }
+    }
+    if (options.flat) {
+        return toFlat(result, depth);
+    }
+    return result;
+}
+export function toFlat(obj, depth) {
+    const flat = {};
+    const parts = [];
+    if (obj.province) {
+        flat.province_id = obj.province.id;
+        parts.push(String(obj.province.id));
+    }
+    if (depth >= 2 && obj.district) {
+        flat.district_id = obj.district.id;
+        parts.push(String(obj.district.id));
+    }
+    if (depth >= 3 && obj.localLevel) {
+        flat.local_level_id = obj.localLevel.id;
+        parts.push(String(obj.localLevel.id));
+    }
+    if (depth >= 4 && obj.ward) {
+        flat.ward_id = obj.ward.id;
+        parts.push(String(obj.ward.id));
+    }
+    flat.code = parts.join('/');
+    return flat;
+}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "nepal-places",
+  "version": "0.1.1",
+  "description": "Zero-dependency Nepal geographical data — Provinces, Districts, Municipalities, Wards. Works with React, Node.js, any JS framework.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run"
+  },
+  "keywords": [
+    "nepal",
+    "nepali",
+    "places",
+    "provinces",
+    "districts",
+    "municipalities",
+    "wards",
+    "geography",
+    "nepal-data",
+    "nepal-geography",
+    "koshi",
+    "bagmati",
+    "gandaki",
+    "lumbini",
+    "karnali",
+    "madhesh",
+    "sudurpashchim",
+    "dropdown",
+    "location-picker",
+    "nepal-places"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "kushal1o1",
+    "url": "https://github.com/kushal1o1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kushal1o1/NepalPlaces.git"
+  },
+  "bugs": {
+    "url": "https://github.com/kushal1o1/NepalPlaces/issues"
+  },
+  "homepage": "https://github.com/kushal1o1/NepalPlaces#readme",
+  "devDependencies": {
+    "typescript": "^5.4.0",
+    "vitest": "^3.0.0"
+  }
+}