mahal_map 2.2.2 → 2.2.3

package/dist/index.d.mts

@@ -469,31 +469,52 @@ interface ISearchByLocationParam {
     token: string;
     type?: string;
 }
+/**
+ * Тип объекта в ответе геокодера. Регистр у сервиса плавает: обратный геокодинг отдаёт
+ * `"Address"`, прямой — `"address"`. Сравнивайте через `type.toLowerCase()`.
+ */
+type SearchResultType = "poi" | "locality" | "address" | "Address" | (string & {});
+/** Адрес объекта. Любое поле может отсутствовать — сервис отдаёт только то, что знает. */
+interface ISearchDetailAddress {
+    /** Область: `вилоят`, `Суғд`. */
+    subject_type?: string;
+    subject_name?: string;
+    /** Город: `шаҳр`, `Хуҷанд`. Так город приходит в обратном геокодинге. */
+    city_type?: string;
+    city?: string;
+    /** Район / ноҳия. */
+    region_type?: string;
+    region?: string;
+    /** Населённый пункт — встречается в ответах вместо `city`. */
+    settlement_type?: string;
+    settlement?: string;
+    /** Посёлок / махалля. */
+    village_type?: string;
+    village?: string;
+    /** Улица: `кӯчаи`, `Камоли Хуҷандӣ`. */
+    street_type?: string;
+    street_name?: string;
+    /** Номер дома. У многих POI его нет. */
+    number?: string;
+}
+interface ISearchDetailInfo {
+    name?: string;
+    short_name?: string;
+    categories?: string;
+    translate_ru?: string;
+    description?: string;
+    phone?: string;
+    website?: string;
+}
 interface ISearchResponse {
     latitude: number;
     longitude: number;
-    type: "poi" | "locality" | "address";
+    type: SearchResultType;
+    /** Расстояние от точки запроса в метрах (обратный геокодинг). */
     distance: number | null;
-    detailInfo: {
-        name?: string;
-        short_name?: string;
-        categories?: string;
-        translate_ru?: string;
-        description?: string;
-    } | null;
-    detailAddress: {
-        subject_type?: string;
-        subject_name?: string;
-        region_type?: string;
-        region?: string;
-        settlement_type?: string;
-        settlement?: string;
-        village_type?: string;
-        village?: string;
-        street_type?: string;
-        street_name?: string;
-        number: string;
-    } | [];
+    detailInfo: ISearchDetailInfo | null;
+    /** Пустой массив — адрес неизвестен. */
+    detailAddress: ISearchDetailAddress | [];
 }
 interface ICheckJSApiParam {
     token: string;
@@ -848,7 +869,11 @@ declare function Router(param: number[][], typeData: string, token: string): Pro
 
 declare function Search(param: string, token: string, additionalParam?: IAdditionalParamType): Promise<ISearchResponse[]>;
 declare function SearchPoi(param: string, token: string, additionalParam?: IAdditionalParamType): Promise<ISearchResponse[]>;
-declare function SearchByLocation(params: ISearchByLocationParam): Promise<ISearchResponse>;
+/**
+ * Обратный геокодинг. В отличие от Search/SearchPoi возвращает тело ответа целиком:
+ * `{ success, data: ISearchResponse[], message }` — объекты рядом с точкой, по `distance`.
+ */
+declare function SearchByLocation(params: ISearchByLocationParam): Promise<IResponse<ISearchResponse[]>>;
 declare function CheckJSApi(token: string): Promise<ICheckJSApiResponse>;
 
 declare const index$2_CheckJSApi: typeof CheckJSApi;
@@ -1105,4 +1130,4 @@ declare namespace index {
   export { index_checkCoordinates as checkCoordinates, index_debounce as debounce, index_geojsonPolyline as geojsonPolyline, index_geometryPolyline as geometryPolyline, index_trimValue as trimValue };
 }
 
-export { CheckJSApi, type IAdditionalParamType, type ICheckJSApiParam, type ICheckJSApiResponse, type IMahalMapOptions, type IMapMarker, type IMaps3DBuildingClickInfo, type IMaps3DBuildingsController, type IMaps3DBuildingsOptions, type IMaps3DClosuresOptions, type IMaps3DDiagnostics, type IMaps3DHoverStyle, type IMaps3DIndoorOptions, type IMaps3DLayer, type IMaps3DLayerOptions, type IMaps3DLayerParams, type IMaps3DLayerState, type IMaps3DMapOptionsInput, type IMaps3DMapOptionsResult, type IMaps3DObjectsLightOptions, type IMaps3DParkingHoverStyle, type IMaps3DParkingInfo, type IMaps3DPlacesOptions, type IMaps3DRoadHit, type IMaps3DSelectionStyle, type IMaps3DTrafficOptions, type IMaps3DTransformRequestOptions, type IResponse, type IRoute, type ISearchByLocationParam, type ISearchParam, type ISearchResponse, MahalMap, MahalMapDefaultMarker, type MahalMapDefaultMarkerProps, type MapEngine, type MapLanguage, type MapStyleFamily, type Maps3DBuildingDetail, type Maps3DCtor, type Maps3DLayerId, type Maps3DParkingSubtype, type Maps3DTerrainMode, type Maps3DThemeName, type Maps3DTransformRequest, type MeasureIcons, type MeasureLabels, type MeasureMode, type MeasurePoint, type MeasureShape, type MeasureState, type MeasureStyleOptions, MeasureTool, type MeasureToolOptions, Router, Search, SearchByLocation, SearchPoi, type Theme, index$2 as keyUtils, index$1 as measureUtils, index as utils };
+export { CheckJSApi, type IAdditionalParamType, type ICheckJSApiParam, type ICheckJSApiResponse, type IMahalMapOptions, type IMapMarker, type IMaps3DBuildingClickInfo, type IMaps3DBuildingsController, type IMaps3DBuildingsOptions, type IMaps3DClosuresOptions, type IMaps3DDiagnostics, type IMaps3DHoverStyle, type IMaps3DIndoorOptions, type IMaps3DLayer, type IMaps3DLayerOptions, type IMaps3DLayerParams, type IMaps3DLayerState, type IMaps3DMapOptionsInput, type IMaps3DMapOptionsResult, type IMaps3DObjectsLightOptions, type IMaps3DParkingHoverStyle, type IMaps3DParkingInfo, type IMaps3DPlacesOptions, type IMaps3DRoadHit, type IMaps3DSelectionStyle, type IMaps3DTrafficOptions, type IMaps3DTransformRequestOptions, type IResponse, type IRoute, type ISearchByLocationParam, type ISearchDetailAddress, type ISearchDetailInfo, type ISearchParam, type ISearchResponse, MahalMap, MahalMapDefaultMarker, type MahalMapDefaultMarkerProps, type MapEngine, type MapLanguage, type MapStyleFamily, type Maps3DBuildingDetail, type Maps3DCtor, type Maps3DLayerId, type Maps3DParkingSubtype, type Maps3DTerrainMode, type Maps3DThemeName, type Maps3DTransformRequest, type MeasureIcons, type MeasureLabels, type MeasureMode, type MeasurePoint, type MeasureShape, type MeasureState, type MeasureStyleOptions, MeasureTool, type MeasureToolOptions, Router, Search, SearchByLocation, SearchPoi, type SearchResultType, type Theme, index$2 as keyUtils, index$1 as measureUtils, index as utils };

package/dist/index.d.ts

@@ -469,31 +469,52 @@ interface ISearchByLocationParam {
     token: string;
     type?: string;
 }
+/**
+ * Тип объекта в ответе геокодера. Регистр у сервиса плавает: обратный геокодинг отдаёт
+ * `"Address"`, прямой — `"address"`. Сравнивайте через `type.toLowerCase()`.
+ */
+type SearchResultType = "poi" | "locality" | "address" | "Address" | (string & {});
+/** Адрес объекта. Любое поле может отсутствовать — сервис отдаёт только то, что знает. */
+interface ISearchDetailAddress {
+    /** Область: `вилоят`, `Суғд`. */
+    subject_type?: string;
+    subject_name?: string;
+    /** Город: `шаҳр`, `Хуҷанд`. Так город приходит в обратном геокодинге. */
+    city_type?: string;
+    city?: string;
+    /** Район / ноҳия. */
+    region_type?: string;
+    region?: string;
+    /** Населённый пункт — встречается в ответах вместо `city`. */
+    settlement_type?: string;
+    settlement?: string;
+    /** Посёлок / махалля. */
+    village_type?: string;
+    village?: string;
+    /** Улица: `кӯчаи`, `Камоли Хуҷандӣ`. */
+    street_type?: string;
+    street_name?: string;
+    /** Номер дома. У многих POI его нет. */
+    number?: string;
+}
+interface ISearchDetailInfo {
+    name?: string;
+    short_name?: string;
+    categories?: string;
+    translate_ru?: string;
+    description?: string;
+    phone?: string;
+    website?: string;
+}
 interface ISearchResponse {
     latitude: number;
     longitude: number;
-    type: "poi" | "locality" | "address";
+    type: SearchResultType;
+    /** Расстояние от точки запроса в метрах (обратный геокодинг). */
     distance: number | null;
-    detailInfo: {
-        name?: string;
-        short_name?: string;
-        categories?: string;
-        translate_ru?: string;
-        description?: string;
-    } | null;
-    detailAddress: {
-        subject_type?: string;
-        subject_name?: string;
-        region_type?: string;
-        region?: string;
-        settlement_type?: string;
-        settlement?: string;
-        village_type?: string;
-        village?: string;
-        street_type?: string;
-        street_name?: string;
-        number: string;
-    } | [];
+    detailInfo: ISearchDetailInfo | null;
+    /** Пустой массив — адрес неизвестен. */
+    detailAddress: ISearchDetailAddress | [];
 }
 interface ICheckJSApiParam {
     token: string;
@@ -848,7 +869,11 @@ declare function Router(param: number[][], typeData: string, token: string): Pro
 
 declare function Search(param: string, token: string, additionalParam?: IAdditionalParamType): Promise<ISearchResponse[]>;
 declare function SearchPoi(param: string, token: string, additionalParam?: IAdditionalParamType): Promise<ISearchResponse[]>;
-declare function SearchByLocation(params: ISearchByLocationParam): Promise<ISearchResponse>;
+/**
+ * Обратный геокодинг. В отличие от Search/SearchPoi возвращает тело ответа целиком:
+ * `{ success, data: ISearchResponse[], message }` — объекты рядом с точкой, по `distance`.
+ */
+declare function SearchByLocation(params: ISearchByLocationParam): Promise<IResponse<ISearchResponse[]>>;
 declare function CheckJSApi(token: string): Promise<ICheckJSApiResponse>;
 
 declare const index$2_CheckJSApi: typeof CheckJSApi;
@@ -1105,4 +1130,4 @@ declare namespace index {
   export { index_checkCoordinates as checkCoordinates, index_debounce as debounce, index_geojsonPolyline as geojsonPolyline, index_geometryPolyline as geometryPolyline, index_trimValue as trimValue };
 }
 
-export { CheckJSApi, type IAdditionalParamType, type ICheckJSApiParam, type ICheckJSApiResponse, type IMahalMapOptions, type IMapMarker, type IMaps3DBuildingClickInfo, type IMaps3DBuildingsController, type IMaps3DBuildingsOptions, type IMaps3DClosuresOptions, type IMaps3DDiagnostics, type IMaps3DHoverStyle, type IMaps3DIndoorOptions, type IMaps3DLayer, type IMaps3DLayerOptions, type IMaps3DLayerParams, type IMaps3DLayerState, type IMaps3DMapOptionsInput, type IMaps3DMapOptionsResult, type IMaps3DObjectsLightOptions, type IMaps3DParkingHoverStyle, type IMaps3DParkingInfo, type IMaps3DPlacesOptions, type IMaps3DRoadHit, type IMaps3DSelectionStyle, type IMaps3DTrafficOptions, type IMaps3DTransformRequestOptions, type IResponse, type IRoute, type ISearchByLocationParam, type ISearchParam, type ISearchResponse, MahalMap, MahalMapDefaultMarker, type MahalMapDefaultMarkerProps, type MapEngine, type MapLanguage, type MapStyleFamily, type Maps3DBuildingDetail, type Maps3DCtor, type Maps3DLayerId, type Maps3DParkingSubtype, type Maps3DTerrainMode, type Maps3DThemeName, type Maps3DTransformRequest, type MeasureIcons, type MeasureLabels, type MeasureMode, type MeasurePoint, type MeasureShape, type MeasureState, type MeasureStyleOptions, MeasureTool, type MeasureToolOptions, Router, Search, SearchByLocation, SearchPoi, type Theme, index$2 as keyUtils, index$1 as measureUtils, index as utils };
+export { CheckJSApi, type IAdditionalParamType, type ICheckJSApiParam, type ICheckJSApiResponse, type IMahalMapOptions, type IMapMarker, type IMaps3DBuildingClickInfo, type IMaps3DBuildingsController, type IMaps3DBuildingsOptions, type IMaps3DClosuresOptions, type IMaps3DDiagnostics, type IMaps3DHoverStyle, type IMaps3DIndoorOptions, type IMaps3DLayer, type IMaps3DLayerOptions, type IMaps3DLayerParams, type IMaps3DLayerState, type IMaps3DMapOptionsInput, type IMaps3DMapOptionsResult, type IMaps3DObjectsLightOptions, type IMaps3DParkingHoverStyle, type IMaps3DParkingInfo, type IMaps3DPlacesOptions, type IMaps3DRoadHit, type IMaps3DSelectionStyle, type IMaps3DTrafficOptions, type IMaps3DTransformRequestOptions, type IResponse, type IRoute, type ISearchByLocationParam, type ISearchDetailAddress, type ISearchDetailInfo, type ISearchParam, type ISearchResponse, MahalMap, MahalMapDefaultMarker, type MahalMapDefaultMarkerProps, type MapEngine, type MapLanguage, type MapStyleFamily, type Maps3DBuildingDetail, type Maps3DCtor, type Maps3DLayerId, type Maps3DParkingSubtype, type Maps3DTerrainMode, type Maps3DThemeName, type Maps3DTransformRequest, type MeasureIcons, type MeasureLabels, type MeasureMode, type MeasurePoint, type MeasureShape, type MeasureState, type MeasureStyleOptions, MeasureTool, type MeasureToolOptions, Router, Search, SearchByLocation, SearchPoi, type SearchResultType, type Theme, index$2 as keyUtils, index$1 as measureUtils, index as utils };