@code-plate/iran-cities 1.1.0 → 2.0.0

package/dist/src-mqZTwJfQ.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"src-mqZTwJfQ.cjs","names":["createApi","unpack","packed"],"sources":["../src/generated/data-full.json","../src/geo.ts","../src/index.ts"],"sourcesContent":["","import type {\r\n  CoordinateConfidence,\r\n  FlatCity,\r\n  IranCities,\r\n  IranCitiesGeo,\r\n  LatLng,\r\n  NearestCitiesOptions,\r\n  NearestCity,\r\n  Query,\r\n} from './types';\r\n\r\nconst EARTH_RADIUS_KM = 6371.0088;\r\n\r\nconst CONFIDENCE_LEVEL: Readonly<Record<CoordinateConfidence, number>> = { low: 0, medium: 1, high: 2 };\r\n\r\nfunction toRadians(deg: number): number {\r\n  return (deg * Math.PI) / 180;\r\n}\r\n\r\nfunction haversine(a: LatLng, b: LatLng): number {\r\n  const dLat = toRadians(b.lat - a.lat);\r\n  const dLng = toRadians(b.lng - a.lng);\r\n  const h =\r\n    Math.sin(dLat / 2) ** 2 + Math.cos(toRadians(a.lat)) * Math.cos(toRadians(b.lat)) * Math.sin(dLng / 2) ** 2;\r\n  return 2 * EARTH_RADIUS_KM * Math.asin(Math.min(1, Math.sqrt(h)));\r\n}\r\n\r\nfunction isLatLng(value: unknown): value is LatLng {\r\n  return (\r\n    typeof value === 'object' &&\r\n    value !== null &&\r\n    typeof (value as LatLng).lat === 'number' &&\r\n    typeof (value as LatLng).lng === 'number' &&\r\n    Number.isFinite((value as LatLng).lat) &&\r\n    Number.isFinite((value as LatLng).lng)\r\n  );\r\n}\r\n\r\nexport function createGeo(api: IranCities): IranCitiesGeo {\r\n  function resolve(point: LatLng | Query): { coords?: LatLng; city?: FlatCity } {\r\n    if (isLatLng(point)) return { coords: { lat: point.lat, lng: point.lng } };\r\n    if (typeof point !== 'string' && typeof point !== 'number') return {};\r\n    const city = api.getCity(point);\r\n    return { coords: city?.coordinates, city };\r\n  }\r\n\r\n  function getDistance(from: LatLng | Query, to: LatLng | Query): number | undefined {\r\n    const a = resolve(from).coords;\r\n    const b = resolve(to).coords;\r\n    return a && b ? haversine(a, b) : undefined;\r\n  }\r\n\r\n  function getNearestCities(point: LatLng | Query, options: NearestCitiesOptions = {}): NearestCity[] {\r\n    const { coords, city: origin } = resolve(point);\r\n    if (!coords) return [];\r\n    const limit = typeof options.limit === 'number' && options.limit >= 0 ? Math.floor(options.limit) : 5;\r\n    const minLevel = CONFIDENCE_LEVEL[options.minConfidence ?? 'low'] ?? 0;\r\n    const maxDistanceKm =\r\n      typeof options.maxDistanceKm === 'number' && options.maxDistanceKm >= 0 ? options.maxDistanceKm : Infinity;\r\n\r\n    const results: NearestCity[] = [];\r\n    for (const city of api.getAllCities()) {\r\n      if (!city.coordinates || city === origin) continue;\r\n      if (CONFIDENCE_LEVEL[city.coordinates.confidence] < minLevel) continue;\r\n      const distanceKm = haversine(coords, city.coordinates);\r\n      if (distanceKm <= maxDistanceKm) results.push({ city, distanceKm });\r\n    }\r\n    results.sort((a, b) => a.distanceKm - b.distanceKm || a.city.id - b.city.id);\r\n    return limit > 0 ? results.slice(0, limit) : results;\r\n  }\r\n\r\n  return { getDistance, getNearestCities };\r\n}\r\n","import packed from './generated/data-full.json' with { type: 'json' };\nimport { createApi } from './core';\nimport { unpack } from './packed';\nimport type { PackedData } from './packed';\nimport { createGeo } from './geo';\nimport type { IranCities, IranCitiesGeo } from './types';\n\nconst api: IranCities = createApi(unpack(packed as PackedData));\nconst geo: IranCitiesGeo = createGeo(api);\n\nexport const getProvinces: IranCities['getProvinces'] = api.getProvinces;\nexport const getProvincesList: IranCities['getProvincesList'] = api.getProvincesList;\nexport const getProvinceById: IranCities['getProvinceById'] = api.getProvinceById;\nexport const getProvince: IranCities['getProvince'] = api.getProvince;\nexport const getCities: IranCities['getCities'] = api.getCities;\nexport const getAllCities: IranCities['getAllCities'] = api.getAllCities;\nexport const getCityById: IranCities['getCityById'] = api.getCityById;\nexport const getCityBySlug: IranCities['getCityBySlug'] = api.getCityBySlug;\nexport const getCity: IranCities['getCity'] = api.getCity;\nexport const getCitiesByName: IranCities['getCitiesByName'] = api.getCitiesByName;\nexport const isAmbiguousCityName: IranCities['isAmbiguousCityName'] = api.isAmbiguousCityName;\nexport const getProvinceOfCity: IranCities['getProvinceOfCity'] = api.getProvinceOfCity;\nexport const getCapital: IranCities['getCapital'] = api.getCapital;\nexport const getCapitals: IranCities['getCapitals'] = api.getCapitals;\nexport const getProvinceByPhoneCode: IranCities['getProvinceByPhoneCode'] = api.getProvinceByPhoneCode;\nexport const searchProvinces: IranCities['searchProvinces'] = api.searchProvinces;\nexport const searchCities: IranCities['searchCities'] = api.searchCities;\nexport const getNeighborProvinces: IranCities['getNeighborProvinces'] = api.getNeighborProvinces;\nexport const areNeighborProvinces: IranCities['areNeighborProvinces'] = api.areNeighborProvinces;\nexport const getStats: IranCities['getStats'] = api.getStats;\nexport const getDistance: IranCitiesGeo['getDistance'] = geo.getDistance;\nexport const getNearestCities: IranCitiesGeo['getNearestCities'] = geo.getNearestCities;\n\nexport { normalize } from './normalize';\nexport { convertKeyboardLayout } from './keyboard';\nexport type { KeyboardTarget } from './keyboard';\nexport { DATA_VERSION, DATA_CHANGES, getDataChanges } from './changes';\n\nexport type {\n  City,\n  CityId,\n  CityKey,\n  DataChange,\n  DataChangeType,\n  CoordinateConfidence,\n  Coordinates,\n  FlatCity,\n  IranCities,\n  IranCitiesGeo,\n  LatLng,\n  Locale,\n  NearestCitiesOptions,\n  NearestCity,\n  Province,\n  ProvinceId,\n  ProvinceListItem,\n  Query,\n  SearchOptions,\n  Stats,\n} from './types';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACWA,MAAM,kBAAkB;AAExB,MAAM,mBAAmE;CAAE,KAAK;CAAG,QAAQ;CAAG,MAAM;AAAE;AAEtG,SAAS,UAAU,KAAqB;CACtC,OAAQ,MAAM,KAAK,KAAM;AAC3B;AAEA,SAAS,UAAU,GAAW,GAAmB;CAC/C,MAAM,OAAO,UAAU,EAAE,MAAM,EAAE,GAAG;CACpC,MAAM,OAAO,UAAU,EAAE,MAAM,EAAE,GAAG;CACpC,MAAM,IACJ,KAAK,IAAI,OAAO,CAAC,KAAK,IAAI,KAAK,IAAI,UAAU,EAAE,GAAG,CAAC,IAAI,KAAK,IAAI,UAAU,EAAE,GAAG,CAAC,IAAI,KAAK,IAAI,OAAO,CAAC,KAAK;CAC5G,OAAO,IAAI,kBAAkB,KAAK,KAAK,KAAK,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC;AAClE;AAEA,SAAS,SAAS,OAAiC;CACjD,OACE,OAAO,UAAU,YACjB,UAAU,QACV,OAAQ,MAAiB,QAAQ,YACjC,OAAQ,MAAiB,QAAQ,YACjC,OAAO,SAAU,MAAiB,GAAG,KACrC,OAAO,SAAU,MAAiB,GAAG;AAEzC;AAEA,SAAgB,UAAU,KAAgC;CACxD,SAAS,QAAQ,OAA6D;EAC5E,IAAI,SAAS,KAAK,GAAG,OAAO,EAAE,QAAQ;GAAE,KAAK,MAAM;GAAK,KAAK,MAAM;EAAI,EAAE;EACzE,IAAI,OAAO,UAAU,YAAY,OAAO,UAAU,UAAU,OAAO,CAAC;EACpE,MAAM,OAAO,IAAI,QAAQ,KAAK;EAC9B,OAAO;GAAE,QAAA,SAAA,QAAA,SAAA,KAAA,IAAA,KAAA,IAAQ,KAAM;GAAa;EAAK;CAC3C;CAEA,SAAS,YAAY,MAAsB,IAAwC;EACjF,MAAM,IAAI,QAAQ,IAAI,CAAC,CAAC;EACxB,MAAM,IAAI,QAAQ,EAAE,CAAC,CAAC;EACtB,OAAO,KAAK,IAAI,UAAU,GAAG,CAAC,IAAI,KAAA;CACpC;CAEA,SAAS,iBAAiB,OAAuB,UAAgC,CAAC,GAAkB;;EAClG,MAAM,EAAE,QAAQ,MAAM,WAAW,QAAQ,KAAK;EAC9C,IAAI,CAAC,QAAQ,OAAO,CAAC;EACrB,MAAM,QAAQ,OAAO,QAAQ,UAAU,YAAY,QAAQ,SAAS,IAAI,KAAK,MAAM,QAAQ,KAAK,IAAI;EACpG,MAAM,YAAA,oBAAW,kBAAA,wBAAiB,QAAQ,mBAAA,QAAA,0BAAA,KAAA,IAAA,wBAAiB,YAAA,QAAA,sBAAA,KAAA,IAAA,oBAAU;EACrE,MAAM,gBACJ,OAAO,QAAQ,kBAAkB,YAAY,QAAQ,iBAAiB,IAAI,QAAQ,gBAAgB;EAEpG,MAAM,UAAyB,CAAC;EAChC,KAAK,MAAM,QAAQ,IAAI,aAAa,GAAG;GACrC,IAAI,CAAC,KAAK,eAAe,SAAS,QAAQ;GAC1C,IAAI,iBAAiB,KAAK,YAAY,cAAc,UAAU;GAC9D,MAAM,aAAa,UAAU,QAAQ,KAAK,WAAW;GACrD,IAAI,cAAc,eAAe,QAAQ,KAAK;IAAE;IAAM;GAAW,CAAC;EACpE;EACA,QAAQ,MAAM,GAAG,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,KAAK,KAAK,EAAE,KAAK,EAAE;EAC3E,OAAO,QAAQ,IAAI,QAAQ,MAAM,GAAG,KAAK,IAAI;CAC/C;CAEA,OAAO;EAAE;EAAa;CAAiB;AACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACjEA,MAAM,MAAkBA,gBAAAA,UAAUC,gBAAAA,OAAOC,iBAAoB,CAAC;AAC9D,MAAM,MAAqB,UAAU,GAAG;AAExC,MAAa,eAA2C,IAAI;AAC5D,MAAa,mBAAmD,IAAI;AACpE,MAAa,kBAAiD,IAAI;AAClE,MAAa,cAAyC,IAAI;AAC1D,MAAa,YAAqC,IAAI;AACtD,MAAa,eAA2C,IAAI;AAC5D,MAAa,cAAyC,IAAI;AAC1D,MAAa,gBAA6C,IAAI;AAC9D,MAAa,UAAiC,IAAI;AAClD,MAAa,kBAAiD,IAAI;AAClE,MAAa,sBAAyD,IAAI;AAC1E,MAAa,oBAAqD,IAAI;AACtE,MAAa,aAAuC,IAAI;AACxD,MAAa,cAAyC,IAAI;AAC1D,MAAa,yBAA+D,IAAI;AAChF,MAAa,kBAAiD,IAAI;AAClE,MAAa,eAA2C,IAAI;AAC5D,MAAa,uBAA2D,IAAI;AAC5E,MAAa,uBAA2D,IAAI;AAC5E,MAAa,WAAmC,IAAI;AACpD,MAAa,cAA4C,IAAI;AAC7D,MAAa,mBAAsD,IAAI"}

package/dist/types/boundaries.d.ts

@@ -0,0 +1,30 @@
+import type { LatLng, Province, ProvinceId } from './types';
+export type Position = readonly [number, number];
+export interface PolygonGeometry {
+    readonly type: 'Polygon';
+    readonly coordinates: readonly (readonly Position[])[];
+}
+export interface MultiPolygonGeometry {
+    readonly type: 'MultiPolygon';
+    readonly coordinates: readonly (readonly (readonly Position[])[])[];
+}
+export interface ProvinceFeature {
+    readonly type: 'Feature';
+    readonly id: ProvinceId;
+    readonly properties: {
+        readonly id: ProvinceId;
+        readonly en: string;
+        readonly fa: string;
+    };
+    readonly geometry: PolygonGeometry | MultiPolygonGeometry;
+}
+export interface ProvinceBoundaries {
+    readonly type: 'FeatureCollection';
+    readonly features: readonly ProvinceFeature[];
+}
+export interface ProvinceAtOptions {
+    maxDistanceKm?: number;
+}
+export declare const provinceBoundaries: ProvinceBoundaries;
+export declare function getProvinceAt(point: LatLng, options?: ProvinceAtOptions): Province | undefined;
+export declare function getProvinceBoundary(provinceId: ProvinceId): ProvinceFeature | undefined;

package/dist/types/changes.d.ts

@@ -0,0 +1,4 @@
+import type { DataChange } from './types';
+export declare const DATA_VERSION: string;
+export declare const DATA_CHANGES: readonly DataChange[];
+export declare function getDataChanges(sinceVersion?: string): DataChange[];

package/dist/types/components.d.ts

@@ -0,0 +1,47 @@
+import * as React from 'react';
+import type { CityId, FlatCity, IranCities, IranCitiesHooks, ProvinceCityValue, Query } from './types';
+export interface CityComboboxProps {
+    value?: CityId | null;
+    defaultValue?: CityId | null;
+    onChange?: (city: FlatCity | null) => void;
+    province?: Query | null;
+    label?: React.ReactNode;
+    placeholder?: string;
+    noResultsText?: React.ReactNode;
+    limit?: number;
+    fuzzy?: boolean;
+    showProvince?: boolean;
+    locale?: 'fa' | 'en';
+    name?: string;
+    id?: string;
+    required?: boolean;
+    disabled?: boolean;
+    invalid?: boolean;
+    dir?: 'rtl' | 'ltr' | 'auto';
+    className?: string;
+    inputProps?: Omit<React.InputHTMLAttributes<HTMLInputElement>, 'value' | 'defaultValue' | 'onChange'>;
+}
+export interface ProvinceCitySelectProps {
+    value?: ProvinceCityValue;
+    defaultValue?: ProvinceCityValue;
+    onChange?: (value: ProvinceCityValue) => void;
+    provinceLabel?: React.ReactNode;
+    cityLabel?: React.ReactNode;
+    provincePlaceholder?: string;
+    cityPlaceholder?: string;
+    provinceName?: string;
+    cityName?: string;
+    locale?: 'fa' | 'en';
+    id?: string;
+    required?: boolean;
+    disabled?: boolean;
+    invalid?: boolean;
+    layout?: 'row' | 'column';
+    dir?: 'rtl' | 'ltr' | 'auto';
+    className?: string;
+}
+export interface IranCitiesComponents {
+    CityCombobox: (props: CityComboboxProps) => React.ReactElement;
+    ProvinceCitySelect: (props: ProvinceCitySelectProps) => React.ReactElement;
+}
+export declare function createComponents(api: IranCities, hooks: IranCitiesHooks): IranCitiesComponents;

package/dist/types/core.d.ts

@@ -0,0 +1,25 @@
+import type { IranCities } from './types';
+export interface RawCity {
+    'city-id': number;
+    'city-en': string;
+    'city-fa': string;
+    'name-en'?: string;
+    lat?: number;
+    lng?: number;
+    'coord-confidence'?: 'medium' | 'low';
+    aliases?: string[];
+    'legacy-slugs'?: string[];
+    primary?: boolean;
+}
+export interface RawProvince {
+    'province-id': number;
+    'province-en': string;
+    'province-fa': string;
+    'phone-code': string;
+    'capital-city-id': number;
+    'name-en': string;
+    neighbors: number[];
+    cities: RawCity[];
+}
+export declare function displayNameFromSlug(slug: string): string;
+export declare function createApi(rawData: readonly RawProvince[]): IranCities;

package/dist/types/geo.d.ts

@@ -0,0 +1,2 @@
+import type { IranCities, IranCitiesGeo } from './types';
+export declare function createGeo(api: IranCities): IranCitiesGeo;

package/dist/types/hooks.d.ts

@@ -0,0 +1,2 @@
+import type { IranCities, IranCitiesHooks } from './types';
+export declare function createHooks(api: IranCities): IranCitiesHooks;

package/dist/types/index.d.ts

@@ -0,0 +1,28 @@
+import type { IranCities, IranCitiesGeo } from './types';
+export declare const getProvinces: IranCities['getProvinces'];
+export declare const getProvincesList: IranCities['getProvincesList'];
+export declare const getProvinceById: IranCities['getProvinceById'];
+export declare const getProvince: IranCities['getProvince'];
+export declare const getCities: IranCities['getCities'];
+export declare const getAllCities: IranCities['getAllCities'];
+export declare const getCityById: IranCities['getCityById'];
+export declare const getCityBySlug: IranCities['getCityBySlug'];
+export declare const getCity: IranCities['getCity'];
+export declare const getCitiesByName: IranCities['getCitiesByName'];
+export declare const isAmbiguousCityName: IranCities['isAmbiguousCityName'];
+export declare const getProvinceOfCity: IranCities['getProvinceOfCity'];
+export declare const getCapital: IranCities['getCapital'];
+export declare const getCapitals: IranCities['getCapitals'];
+export declare const getProvinceByPhoneCode: IranCities['getProvinceByPhoneCode'];
+export declare const searchProvinces: IranCities['searchProvinces'];
+export declare const searchCities: IranCities['searchCities'];
+export declare const getNeighborProvinces: IranCities['getNeighborProvinces'];
+export declare const areNeighborProvinces: IranCities['areNeighborProvinces'];
+export declare const getStats: IranCities['getStats'];
+export declare const getDistance: IranCitiesGeo['getDistance'];
+export declare const getNearestCities: IranCitiesGeo['getNearestCities'];
+export { normalize } from './normalize';
+export { convertKeyboardLayout } from './keyboard';
+export type { KeyboardTarget } from './keyboard';
+export { DATA_VERSION, DATA_CHANGES, getDataChanges } from './changes';
+export type { City, CityId, CityKey, DataChange, DataChangeType, CoordinateConfidence, Coordinates, FlatCity, IranCities, IranCitiesGeo, LatLng, Locale, NearestCitiesOptions, NearestCity, Province, ProvinceId, ProvinceListItem, Query, SearchOptions, Stats, } from './types';

package/dist/types/keyboard.d.ts

@@ -0,0 +1,3 @@
+export type KeyboardTarget = 'fa' | 'en';
+export declare function convertKeyboardLayout(text: string, to: KeyboardTarget): string;
+export declare function guessKeyboardTarget(text: string): KeyboardTarget | undefined;

package/dist/types/lite-react-components.d.ts

@@ -0,0 +1,5 @@
+import type { IranCitiesComponents } from './components';
+export declare const CityCombobox: IranCitiesComponents['CityCombobox'];
+export declare const ProvinceCitySelect: IranCitiesComponents['ProvinceCitySelect'];
+export type { CityComboboxProps, IranCitiesComponents, ProvinceCitySelectProps } from './components';
+export type { CityId, FlatCity, ProvinceCityValue, ProvinceId, Query } from './types';

package/dist/types/lite-react.d.ts

@@ -0,0 +1,7 @@
+import type { IranCitiesHooks } from './types';
+export declare const useProvinces: IranCitiesHooks['useProvinces'];
+export declare const useCities: IranCitiesHooks['useCities'];
+export declare const useProvinceCitySelect: IranCitiesHooks['useProvinceCitySelect'];
+export declare const useCitySearch: IranCitiesHooks['useCitySearch'];
+export declare const useProvinceSearch: IranCitiesHooks['useProvinceSearch'];
+export type { City, CityId, FlatCity, IranCitiesHooks, Province, ProvinceCitySelect, ProvinceCitySelectOptions, ProvinceCityValue, ProvinceId, ProvinceListItem, Query, SearchOptions, SearchState, } from './types';

package/dist/types/lite.d.ts

@@ -0,0 +1,26 @@
+import type { IranCities } from './types';
+export declare const getProvinces: IranCities['getProvinces'];
+export declare const getProvincesList: IranCities['getProvincesList'];
+export declare const getProvinceById: IranCities['getProvinceById'];
+export declare const getProvince: IranCities['getProvince'];
+export declare const getCities: IranCities['getCities'];
+export declare const getAllCities: IranCities['getAllCities'];
+export declare const getCityById: IranCities['getCityById'];
+export declare const getCityBySlug: IranCities['getCityBySlug'];
+export declare const getCity: IranCities['getCity'];
+export declare const getCitiesByName: IranCities['getCitiesByName'];
+export declare const isAmbiguousCityName: IranCities['isAmbiguousCityName'];
+export declare const getProvinceOfCity: IranCities['getProvinceOfCity'];
+export declare const getCapital: IranCities['getCapital'];
+export declare const getCapitals: IranCities['getCapitals'];
+export declare const getProvinceByPhoneCode: IranCities['getProvinceByPhoneCode'];
+export declare const searchProvinces: IranCities['searchProvinces'];
+export declare const searchCities: IranCities['searchCities'];
+export declare const getNeighborProvinces: IranCities['getNeighborProvinces'];
+export declare const areNeighborProvinces: IranCities['areNeighborProvinces'];
+export declare const getStats: IranCities['getStats'];
+export { normalize } from './normalize';
+export { convertKeyboardLayout } from './keyboard';
+export type { KeyboardTarget } from './keyboard';
+export { DATA_VERSION, DATA_CHANGES, getDataChanges } from './changes';
+export type { City, CityId, CityKey, DataChange, DataChangeType, FlatCity, IranCities, Locale, Province, ProvinceId, ProvinceListItem, Query, SearchOptions, Stats, } from './types';

package/dist/types/normalize.d.ts

@@ -0,0 +1 @@
+export declare function normalize(input: string): string;

package/dist/types/packed.d.ts

@@ -0,0 +1,16 @@
+import type { RawProvince } from './core';
+type PackedProvince = [number, string, string, string, number, string, number[], number];
+type PackedExtra = [number, string | 0, string[] | 0, 0 | 1, string[] | 0];
+export interface PackedData {
+    format: number;
+    provinces: PackedProvince[];
+    ids: number[];
+    en: string;
+    fa: string;
+    extras: PackedExtra[];
+    confidence?: string;
+    lat?: number[];
+    lng?: number[];
+}
+export declare function unpack(packed: PackedData): RawProvince[];
+export {};

package/dist/types/react-components.d.ts

@@ -0,0 +1,5 @@
+import type { IranCitiesComponents } from './components';
+export declare const CityCombobox: IranCitiesComponents['CityCombobox'];
+export declare const ProvinceCitySelect: IranCitiesComponents['ProvinceCitySelect'];
+export type { CityComboboxProps, IranCitiesComponents, ProvinceCitySelectProps } from './components';
+export type { CityId, FlatCity, ProvinceCityValue, ProvinceId, Query } from './types';

package/dist/types/react.d.ts

@@ -0,0 +1,7 @@
+import type { IranCitiesHooks } from './types';
+export declare const useProvinces: IranCitiesHooks['useProvinces'];
+export declare const useCities: IranCitiesHooks['useCities'];
+export declare const useProvinceCitySelect: IranCitiesHooks['useProvinceCitySelect'];
+export declare const useCitySearch: IranCitiesHooks['useCitySearch'];
+export declare const useProvinceSearch: IranCitiesHooks['useProvinceSearch'];
+export type { City, CityId, FlatCity, IranCitiesHooks, Province, ProvinceCitySelect, ProvinceCitySelectOptions, ProvinceCityValue, ProvinceId, ProvinceListItem, Query, SearchOptions, SearchState, } from './types';

package/dist/types/types.d.ts

@@ -0,0 +1,149 @@
+export type CityId = number;
+export type ProvinceId = number;
+export type CityKey = string;
+export type Query = string | number;
+export type Locale = 'en' | 'fa';
+export type CoordinateConfidence = 'high' | 'medium' | 'low';
+export interface LatLng {
+    readonly lat: number;
+    readonly lng: number;
+}
+export interface Coordinates extends LatLng {
+    readonly confidence: CoordinateConfidence;
+}
+export interface City {
+    readonly id: CityId;
+    readonly isCapital: boolean;
+    readonly coordinates?: Coordinates;
+    readonly slug: CityKey;
+    readonly en: string;
+    readonly fa: string;
+    readonly nameEn: string;
+    readonly aliases: readonly string[];
+}
+export interface Province {
+    readonly id: ProvinceId;
+    readonly en: string;
+    readonly fa: string;
+    readonly nameEn: string;
+    readonly phoneCode: string;
+    readonly capitalId: CityId;
+    readonly neighborIds: readonly ProvinceId[];
+    readonly cities: readonly City[];
+}
+export interface ProvinceListItem {
+    id: ProvinceId;
+    en: string;
+    fa: string;
+    nameEn: string;
+    phoneCode: string;
+    capitalId: CityId;
+}
+export interface FlatCity extends City {
+    readonly provinceId: ProvinceId;
+    readonly provinceEn: string;
+    readonly provinceFa: string;
+    readonly provinceNameEn: string;
+    readonly phoneCode: string;
+}
+export interface SearchOptions {
+    limit?: number;
+    locale?: Locale | 'both';
+    fuzzy?: boolean;
+    maxDistance?: number;
+    emptyQuery?: 'all' | 'none';
+    keyboardFix?: boolean;
+}
+export interface NearestCitiesOptions {
+    limit?: number;
+    minConfidence?: CoordinateConfidence;
+    maxDistanceKm?: number;
+}
+export interface NearestCity {
+    readonly city: FlatCity;
+    readonly distanceKm: number;
+}
+export type DataChangeType = 'renamed' | 'spelling' | 'removed' | 'coordinates';
+export interface DataChange {
+    readonly version: string;
+    readonly type: DataChangeType;
+    readonly cityId?: CityId;
+    readonly provinceId?: ProvinceId;
+    readonly before?: {
+        readonly en?: string;
+        readonly fa?: string;
+        readonly slug?: CityKey;
+    };
+    readonly after?: {
+        readonly en?: string;
+        readonly fa?: string;
+        readonly slug?: CityKey;
+    };
+    readonly note: string;
+}
+export interface Stats {
+    readonly provinceCount: number;
+    readonly cityCount: number;
+}
+export interface IranCities {
+    getProvinces(): readonly Province[];
+    getProvincesList(): ProvinceListItem[];
+    getProvinceById(id: ProvinceId): Province | undefined;
+    getProvince(query: Query): Province | undefined;
+    getCities(provinceQuery: Query): readonly City[];
+    getAllCities(): readonly FlatCity[];
+    getCityById(id: CityId): FlatCity | undefined;
+    getCityBySlug(slug: CityKey): FlatCity | undefined;
+    getCity(cityQuery: Query, provinceQuery?: Query): FlatCity | undefined;
+    getCitiesByName(cityQuery: string): readonly FlatCity[];
+    isAmbiguousCityName(cityQuery: string): boolean;
+    getProvinceOfCity(cityQuery: Query): Province | undefined;
+    getCapital(provinceQuery: Query): FlatCity | undefined;
+    getCapitals(): FlatCity[];
+    getProvinceByPhoneCode(code: string | number): Province | undefined;
+    searchProvinces(query: string, options?: SearchOptions): Province[];
+    searchCities(query: string, options?: SearchOptions): FlatCity[];
+    getNeighborProvinces(provinceQuery: Query): Province[];
+    areNeighborProvinces(a: Query, b: Query): boolean;
+    getStats(): Stats;
+}
+export interface IranCitiesGeo {
+    getDistance(from: LatLng | Query, to: LatLng | Query): number | undefined;
+    getNearestCities(point: LatLng | Query, options?: NearestCitiesOptions): NearestCity[];
+}
+export interface ProvinceCityValue {
+    provinceId?: ProvinceId;
+    cityId?: CityId;
+}
+export interface ProvinceCitySelectOptions {
+    initialProvince?: Query;
+    initialCity?: Query;
+    value?: ProvinceCityValue;
+    onChange?: (value: ProvinceCityValue) => void;
+}
+export interface ProvinceCitySelect {
+    provinces: ProvinceListItem[];
+    cities: readonly City[];
+    province: string;
+    city: string;
+    provinceId: ProvinceId | undefined;
+    cityId: CityId | undefined;
+    value: ProvinceCityValue;
+    selectedProvince: Province | undefined;
+    selectedCity: FlatCity | undefined;
+    setProvince: (value: Query) => void;
+    setCity: (value: Query) => void;
+    reset: () => void;
+}
+export interface SearchState<T> {
+    query: string;
+    setQuery: (query: string | ((previous: string) => string)) => void;
+    results: T[];
+}
+export interface IranCitiesHooks {
+    useProvinces(): ProvinceListItem[];
+    useCities(provinceQuery: Query | undefined | null): readonly City[];
+    useProvinceCitySelect(options?: ProvinceCitySelectOptions): ProvinceCitySelect;
+    useCitySearch(initialQuery?: string, options?: SearchOptions): SearchState<FlatCity>;
+    useProvinceSearch(initialQuery?: string, options?: SearchOptions): SearchState<Province>;
+}

package/dist/types/valibot.d.ts

@@ -0,0 +1,23 @@
+import * as v from 'valibot';
+import type { FlatCity, Province } from './types';
+import { toId } from './validation-shared';
+import type { ValidationMessages } from './validation-shared';
+export interface ProvinceCityIds {
+    provinceId: number;
+    cityId: number;
+}
+export interface IranCitiesValibotSchemas {
+    provinceId: v.GenericSchema<unknown, number>;
+    cityId: v.GenericSchema<unknown, number>;
+    province: v.GenericSchema<unknown, Province>;
+    city: v.GenericSchema<unknown, FlatCity>;
+    provinceCity: v.GenericSchema<unknown, ProvinceCityIds>;
+}
+export declare function createValibotSchemas(messages?: Partial<ValidationMessages>): IranCitiesValibotSchemas;
+export declare const provinceIdSchema: v.GenericSchema<unknown, number>;
+export declare const cityIdSchema: v.GenericSchema<unknown, number>;
+export declare const provinceSchema: v.GenericSchema<unknown, Province>;
+export declare const citySchema: v.GenericSchema<unknown, FlatCity>;
+export declare const provinceCitySchema: v.GenericSchema<unknown, ProvinceCityIds>;
+export { toId };
+export type { ValidationMessages };

package/dist/types/validation-shared.d.ts

@@ -0,0 +1,11 @@
+import type { IranCities } from './types';
+export interface ValidationMessages {
+    province: string;
+    city: string;
+    cityNotInProvince: string;
+}
+export declare const DEFAULT_MESSAGES: ValidationMessages;
+export declare function toId(value: unknown): number | undefined;
+export declare function isProvinceId(api: IranCities, value: unknown): boolean;
+export declare function isCityId(api: IranCities, value: unknown): boolean;
+export declare function cityBelongsToProvince(api: IranCities, cityId: unknown, provinceId: unknown): boolean;

package/dist/types/zod.d.ts

@@ -0,0 +1,23 @@
+import { z } from 'zod';
+import type { FlatCity, Province } from './types';
+import { toId } from './validation-shared';
+import type { ValidationMessages } from './validation-shared';
+export interface ProvinceCityIds {
+    provinceId: number;
+    cityId: number;
+}
+export interface IranCitiesZodSchemas {
+    provinceId: z.ZodType<number>;
+    cityId: z.ZodType<number>;
+    province: z.ZodType<Province>;
+    city: z.ZodType<FlatCity>;
+    provinceCity: z.ZodType<ProvinceCityIds>;
+}
+export declare function createZodSchemas(messages?: Partial<ValidationMessages>): IranCitiesZodSchemas;
+export declare const provinceIdSchema: z.ZodType<number>;
+export declare const cityIdSchema: z.ZodType<number>;
+export declare const provinceSchema: z.ZodType<Province>;
+export declare const citySchema: z.ZodType<FlatCity>;
+export declare const provinceCitySchema: z.ZodType<ProvinceCityIds>;
+export { toId };
+export type { ValidationMessages };

package/dist/types-Ds_b0yHP.d.cts

@@ -0,0 +1,150 @@
+type CityId = number;
+type ProvinceId = number;
+type CityKey = string;
+type Query = string | number;
+type Locale = "en" | "fa";
+type CoordinateConfidence = "high" | "medium" | "low";
+interface LatLng {
+  readonly lat: number;
+  readonly lng: number;
+}
+interface Coordinates extends LatLng {
+  readonly confidence: CoordinateConfidence;
+}
+interface City {
+  readonly id: CityId;
+  readonly isCapital: boolean;
+  readonly coordinates?: Coordinates;
+  readonly slug: CityKey;
+  readonly en: string;
+  readonly fa: string;
+  readonly nameEn: string;
+  readonly aliases: readonly string[];
+}
+interface Province {
+  readonly id: ProvinceId;
+  readonly en: string;
+  readonly fa: string;
+  readonly nameEn: string;
+  readonly phoneCode: string;
+  readonly capitalId: CityId;
+  readonly neighborIds: readonly ProvinceId[];
+  readonly cities: readonly City[];
+}
+interface ProvinceListItem {
+  id: ProvinceId;
+  en: string;
+  fa: string;
+  nameEn: string;
+  phoneCode: string;
+  capitalId: CityId;
+}
+interface FlatCity extends City {
+  readonly provinceId: ProvinceId;
+  readonly provinceEn: string;
+  readonly provinceFa: string;
+  readonly provinceNameEn: string;
+  readonly phoneCode: string;
+}
+interface SearchOptions {
+  limit?: number;
+  locale?: Locale | "both";
+  fuzzy?: boolean;
+  maxDistance?: number;
+  emptyQuery?: "all" | "none";
+  keyboardFix?: boolean;
+}
+interface NearestCitiesOptions {
+  limit?: number;
+  minConfidence?: CoordinateConfidence;
+  maxDistanceKm?: number;
+}
+interface NearestCity {
+  readonly city: FlatCity;
+  readonly distanceKm: number;
+}
+type DataChangeType = "renamed" | "spelling" | "removed" | "coordinates";
+interface DataChange {
+  readonly version: string;
+  readonly type: DataChangeType;
+  readonly cityId?: CityId;
+  readonly provinceId?: ProvinceId;
+  readonly before?: {
+    readonly en?: string;
+    readonly fa?: string;
+    readonly slug?: CityKey;
+  };
+  readonly after?: {
+    readonly en?: string;
+    readonly fa?: string;
+    readonly slug?: CityKey;
+  };
+  readonly note: string;
+}
+interface Stats {
+  readonly provinceCount: number;
+  readonly cityCount: number;
+}
+interface IranCities {
+  getProvinces(): readonly Province[];
+  getProvincesList(): ProvinceListItem[];
+  getProvinceById(id: ProvinceId): Province | undefined;
+  getProvince(query: Query): Province | undefined;
+  getCities(provinceQuery: Query): readonly City[];
+  getAllCities(): readonly FlatCity[];
+  getCityById(id: CityId): FlatCity | undefined;
+  getCityBySlug(slug: CityKey): FlatCity | undefined;
+  getCity(cityQuery: Query, provinceQuery?: Query): FlatCity | undefined;
+  getCitiesByName(cityQuery: string): readonly FlatCity[];
+  isAmbiguousCityName(cityQuery: string): boolean;
+  getProvinceOfCity(cityQuery: Query): Province | undefined;
+  getCapital(provinceQuery: Query): FlatCity | undefined;
+  getCapitals(): FlatCity[];
+  getProvinceByPhoneCode(code: string | number): Province | undefined;
+  searchProvinces(query: string, options?: SearchOptions): Province[];
+  searchCities(query: string, options?: SearchOptions): FlatCity[];
+  getNeighborProvinces(provinceQuery: Query): Province[];
+  areNeighborProvinces(a: Query, b: Query): boolean;
+  getStats(): Stats;
+}
+interface IranCitiesGeo {
+  getDistance(from: LatLng | Query, to: LatLng | Query): number | undefined;
+  getNearestCities(point: LatLng | Query, options?: NearestCitiesOptions): NearestCity[];
+}
+interface ProvinceCityValue {
+  provinceId?: ProvinceId;
+  cityId?: CityId;
+}
+interface ProvinceCitySelectOptions {
+  initialProvince?: Query;
+  initialCity?: Query;
+  value?: ProvinceCityValue;
+  onChange?: (value: ProvinceCityValue) => void;
+}
+interface ProvinceCitySelect {
+  provinces: ProvinceListItem[];
+  cities: readonly City[];
+  province: string;
+  city: string;
+  provinceId: ProvinceId | undefined;
+  cityId: CityId | undefined;
+  value: ProvinceCityValue;
+  selectedProvince: Province | undefined;
+  selectedCity: FlatCity | undefined;
+  setProvince: (value: Query) => void;
+  setCity: (value: Query) => void;
+  reset: () => void;
+}
+interface SearchState<T> {
+  query: string;
+  setQuery: (query: string | ((previous: string) => string)) => void;
+  results: T[];
+}
+interface IranCitiesHooks {
+  useProvinces(): ProvinceListItem[];
+  useCities(provinceQuery: Query | undefined | null): readonly City[];
+  useProvinceCitySelect(options?: ProvinceCitySelectOptions): ProvinceCitySelect;
+  useCitySearch(initialQuery?: string, options?: SearchOptions): SearchState<FlatCity>;
+  useProvinceSearch(initialQuery?: string, options?: SearchOptions): SearchState<Province>;
+}
+export { SearchOptions as C, Query as S, Stats as T, ProvinceCitySelect as _, Coordinates as a, ProvinceId as b, FlatCity as c, IranCitiesHooks as d, LatLng as f, Province as g, NearestCity as h, CoordinateConfidence as i, IranCities as l, NearestCitiesOptions as m, CityId as n, DataChange as o, Locale as p, CityKey as r, DataChangeType as s, City as t, IranCitiesGeo as u, ProvinceCitySelectOptions as v, SearchState as w, ProvinceListItem as x, ProvinceCityValue as y };