@code-plate/iran-cities 1.0.2 → 1.1.0

package/dist/index.d.mts

@@ -1,44 +1,25 @@
-import { F as FlatCity, C as City, a as CityKey, P as Province, S as SearchOptions } from './types-DwFZSr9I.mjs';
-export { L as Locale } from './types-DwFZSr9I.mjs';
+import { F as FlatCity, Q as Query, C as City, a as CityId, b as CityKey, P as Province, c as ProvinceId, d as ProvinceListItem, S as SearchOptions } from './types-DzSw8Uw2.mjs';
+export { e as Coordinates, L as Locale } from './types-DzSw8Uw2.mjs';
 
-/** لیست کامل استان‌ها به همراه شهرهای هرکدام */
 declare function getProvinces(): Province[];
-/** لیست استان‌ها بدون آرایه‌ی شهرها (سبک‌تر، برای Select/Dropdown) */
-declare function getProvincesList(): {
-    en: string;
-    fa: string;
-}[];
-/** پیدا کردن یک استان با شناسه انگلیسی یا نام فارسی (دقیق، نرمال‌شده) - O(1) */
-declare function getProvince(query: string): Province | undefined;
-/** لیست شهرهای یک استان بر اساس شناسه انگلیسی یا نام فارسی استان */
-declare function getCities(provinceQuery: string): City[];
-/** لیست تمام شهرهای کشور به صورت مسطح، همراه با اطلاعات استان مربوطه */
+declare function getProvincesList(): ProvinceListItem[];
+declare function getProvinceById(id: ProvinceId): Province | undefined;
+declare function getProvince(query: Query): Province | undefined;
+declare function getCities(provinceQuery: Query): City[];
 declare function getAllCities(): FlatCity[];
-/**
- * پیدا کردن یک شهر با شناسه‌ی یکتای سراسری آن (City.slug، به‌فرم `provinceEn/cityEn`) - O(1)
- * برای پکیج‌های وابسته که داده‌ی اضافه (کد تلفن، پلاک، پیش‌شماره کد ملی و ...) را بر اساس
- * این کلید نگه می‌دارند، مسیر پیشنهادی همین تابع است چون بدون ابهامِ هم‌نامی کار می‌کند.
- */
+declare function getCityById(id: CityId): FlatCity | undefined;
 declare function getCityBySlug(slug: CityKey): FlatCity | undefined;
-/** پیدا کردن یک شهر با شناسه انگلیسی یا نام فارسی (اختیاری: محدود به یک استان خاص) - O(1) / O(اندازه استان) */
-declare function getCity(cityQuery: string, provinceQuery?: string): FlatCity | undefined;
-/** استانی که یک شهر مشخص در آن قرار دارد را برمی‌گرداند - O(1) */
-declare function getProvinceOfCity(cityQuery: string): Province | undefined;
-/**
- * جستجوی رتبه‌بندی‌شده در بین استان‌ها بر اساس بخشی از نام.
- * ترتیب نتایج: تطابق دقیق > شروع‌شونده‌با > شامل‌شونده > (در حالت fuzzy) نزدیک از نظر فاصله‌ی ادیت.
- */
+declare function getCity(cityQuery: Query, provinceQuery?: Query): FlatCity | undefined;
+declare function getCitiesByName(cityQuery: string): FlatCity[];
+declare function getProvinceOfCity(cityQuery: Query): Province | undefined;
+declare function getCapital(provinceQuery: Query): FlatCity | undefined;
+declare function getCapitals(): FlatCity[];
+declare function getProvinceByPhoneCode(code: string | number): Province | undefined;
 declare function searchProvinces(query: string, options?: SearchOptions): Province[];
-/**
- * جستجوی رتبه‌بندی‌شده در بین تمام شهرهای کشور بر اساس بخشی از نام.
- * ترتیب نتایج: تطابق دقیق > شروع‌شونده‌با > شامل‌شونده > (در حالت fuzzy) نزدیک از نظر فاصله‌ی ادیت.
- * برای تحمل غلط تایپی، `{ fuzzy: true }` را در options پاس بده.
- */
 declare function searchCities(query: string, options?: SearchOptions): FlatCity[];
-/** آمار کلی: تعداد استان‌ها و تعداد کل شهرها */
 declare function getStats(): {
     provinceCount: number;
     cityCount: number;
 };
 
-export { City, CityKey, FlatCity, Province, SearchOptions, getAllCities, getCities, getCity, getCityBySlug, getProvince, getProvinceOfCity, getProvinces, getProvincesList, getStats, searchCities, searchProvinces };
+export { City, CityId, CityKey, FlatCity, Province, ProvinceId, ProvinceListItem, Query, SearchOptions, getAllCities, getCapital, getCapitals, getCities, getCitiesByName, getCity, getCityById, getCityBySlug, getProvince, getProvinceById, getProvinceByPhoneCode, getProvinceOfCity, getProvinces, getProvincesList, getStats, searchCities, searchProvinces };

package/dist/index.d.ts

@@ -1,44 +1,25 @@
-import { F as FlatCity, C as City, a as CityKey, P as Province, S as SearchOptions } from './types-DwFZSr9I.js';
-export { L as Locale } from './types-DwFZSr9I.js';
+import { F as FlatCity, Q as Query, C as City, a as CityId, b as CityKey, P as Province, c as ProvinceId, d as ProvinceListItem, S as SearchOptions } from './types-DzSw8Uw2.js';
+export { e as Coordinates, L as Locale } from './types-DzSw8Uw2.js';
 
-/** لیست کامل استان‌ها به همراه شهرهای هرکدام */
 declare function getProvinces(): Province[];
-/** لیست استان‌ها بدون آرایه‌ی شهرها (سبک‌تر، برای Select/Dropdown) */
-declare function getProvincesList(): {
-    en: string;
-    fa: string;
-}[];
-/** پیدا کردن یک استان با شناسه انگلیسی یا نام فارسی (دقیق، نرمال‌شده) - O(1) */
-declare function getProvince(query: string): Province | undefined;
-/** لیست شهرهای یک استان بر اساس شناسه انگلیسی یا نام فارسی استان */
-declare function getCities(provinceQuery: string): City[];
-/** لیست تمام شهرهای کشور به صورت مسطح، همراه با اطلاعات استان مربوطه */
+declare function getProvincesList(): ProvinceListItem[];
+declare function getProvinceById(id: ProvinceId): Province | undefined;
+declare function getProvince(query: Query): Province | undefined;
+declare function getCities(provinceQuery: Query): City[];
 declare function getAllCities(): FlatCity[];
-/**
- * پیدا کردن یک شهر با شناسه‌ی یکتای سراسری آن (City.slug، به‌فرم `provinceEn/cityEn`) - O(1)
- * برای پکیج‌های وابسته که داده‌ی اضافه (کد تلفن، پلاک، پیش‌شماره کد ملی و ...) را بر اساس
- * این کلید نگه می‌دارند، مسیر پیشنهادی همین تابع است چون بدون ابهامِ هم‌نامی کار می‌کند.
- */
+declare function getCityById(id: CityId): FlatCity | undefined;
 declare function getCityBySlug(slug: CityKey): FlatCity | undefined;
-/** پیدا کردن یک شهر با شناسه انگلیسی یا نام فارسی (اختیاری: محدود به یک استان خاص) - O(1) / O(اندازه استان) */
-declare function getCity(cityQuery: string, provinceQuery?: string): FlatCity | undefined;
-/** استانی که یک شهر مشخص در آن قرار دارد را برمی‌گرداند - O(1) */
-declare function getProvinceOfCity(cityQuery: string): Province | undefined;
-/**
- * جستجوی رتبه‌بندی‌شده در بین استان‌ها بر اساس بخشی از نام.
- * ترتیب نتایج: تطابق دقیق > شروع‌شونده‌با > شامل‌شونده > (در حالت fuzzy) نزدیک از نظر فاصله‌ی ادیت.
- */
+declare function getCity(cityQuery: Query, provinceQuery?: Query): FlatCity | undefined;
+declare function getCitiesByName(cityQuery: string): FlatCity[];
+declare function getProvinceOfCity(cityQuery: Query): Province | undefined;
+declare function getCapital(provinceQuery: Query): FlatCity | undefined;
+declare function getCapitals(): FlatCity[];
+declare function getProvinceByPhoneCode(code: string | number): Province | undefined;
 declare function searchProvinces(query: string, options?: SearchOptions): Province[];
-/**
- * جستجوی رتبه‌بندی‌شده در بین تمام شهرهای کشور بر اساس بخشی از نام.
- * ترتیب نتایج: تطابق دقیق > شروع‌شونده‌با > شامل‌شونده > (در حالت fuzzy) نزدیک از نظر فاصله‌ی ادیت.
- * برای تحمل غلط تایپی، `{ fuzzy: true }` را در options پاس بده.
- */
 declare function searchCities(query: string, options?: SearchOptions): FlatCity[];
-/** آمار کلی: تعداد استان‌ها و تعداد کل شهرها */
 declare function getStats(): {
     provinceCount: number;
     cityCount: number;
 };
 
-export { City, CityKey, FlatCity, Province, SearchOptions, getAllCities, getCities, getCity, getCityBySlug, getProvince, getProvinceOfCity, getProvinces, getProvincesList, getStats, searchCities, searchProvinces };
+export { City, CityId, CityKey, FlatCity, Province, ProvinceId, ProvinceListItem, Query, SearchOptions, getAllCities, getCapital, getCapitals, getCities, getCitiesByName, getCity, getCityById, getCityBySlug, getProvince, getProvinceById, getProvinceByPhoneCode, getProvinceOfCity, getProvinces, getProvincesList, getStats, searchCities, searchProvinces };