@omnic/widget-locations 1.1.7 → 1.1.9

package/dist/lib/components/MapGoogle/MapGoogle.utils.d.ts

@@ -1,3 +1,11 @@
 /// <reference types="google.maps" />
+/**
+ * Creates zoom controls for the map.
+ * @param map - The Google Map instance.
+ */
 export declare const createZoomControls: (map: google.maps.Map) => void;
+/**
+ * Creates a control for displaying the user's current location on the map.
+ * @param map - The Google Map instance.
+ */
 export declare const createCurrentLocationControl: (map: google.maps.Map) => void;

package/dist/lib/constants/map.d.ts

@@ -5,7 +5,6 @@ export declare const BALLOON_DETAILS_ID: string;
 export declare const MARKER_SIZE: Size;
 export declare const SCALED_MARKER_SIZE: Size;
 export declare const FALLBACK_ZOOM = 6;
-export declare const SELECTED_PLACE_ZOOM = 10;
 export declare const FALLBACK_CENTER: Coordinates;
 export declare const FALLBACK_LOCALE: Locale;
 export declare const GOOGLE_MAP_LIBRARIES: LoadScriptProps["libraries"];

package/dist/lib/hooks/useGeoCenter.d.ts

@@ -1,4 +1,11 @@
 export interface UseGeoCenterOption {
     disableGeolocation?: boolean;
 }
+/**
+ * A custom hook that handles the centering of the map based on the provided coordinates.
+ *
+ * @param center - The center coordinates.
+ * @param zoom - The zoom level of the map.
+ * @param options - The options for the hook.
+ */
 export declare const useGeoCenter: (center: Coordinates, zoom: number, options?: UseGeoCenterOption) => void;

package/dist/lib/hooks/useLocaleWatcher.d.ts

@@ -1,2 +1,7 @@
 import type { Locale } from '../types/i18n';
+/**
+ * Watches the locale and changes the language in Tolgee and Geocode accordingly.
+ *
+ * @param locale - The locale to watch.
+ */
 export declare const useLocaleWatcher: (locale: Nullable<Locale>) => void;

package/dist/lib/stores/deliveryAddress.d.ts

@@ -1,11 +1,39 @@
 /// <reference types="google.maps" />
+import type { GeoLocationType } from '../utils';
 interface State {
     place: Nullable<google.maps.places.PlaceResult>;
 }
 interface Action {
-    setPlace(place: Nullable<google.maps.places.PlaceResult>, zoom?: number): void;
+    /**
+     * Set the selected place.
+     *
+     * @param place - The selected place.
+     * @param types - The types of the place.
+     * @returns A promise that resolves when the place is set.
+     */
+    setPlace(place: Nullable<google.maps.places.PlaceResult>): Promise<google.maps.places.PlaceResult>;
+    /**
+     * Set the selected place.
+     *
+     * @param coordinates - The selected place.
+     * @param types - The types of the place.
+     * @returns A promise that resolves when the place is set.
+     */
+    setPlace(coordinates: Coordinates, types?: GeoLocationType[]): Promise<google.maps.places.PlaceResult>;
 }
+/**
+ * Selects the delivery address from the state.
+ *
+ * @param state - The state object.
+ * @returns The selected delivery address.
+ */
 export declare const selectDeliveryAddress: (state: State) => Nullable<google.maps.places.PlaceResult>;
+/**
+ * Returns the selected address locality from the state.
+ *
+ * @param state - The state object.
+ * @returns The selected address locality.
+ */
 export declare const selectedAddressLocality: (state: State) => google.maps.GeocoderAddressComponent | undefined;
 export declare const useDeliveryAddressStore: import("zustand").UseBoundStore<import("zustand").StoreApi<State & Action>>;
 export {};

package/dist/lib/stores/deliveryPoint.d.ts

@@ -3,8 +3,19 @@ interface State {
     location: Nullable<DeliveryPoint>;
 }
 interface Action {
+    /**
+     * Sets the delivery point.
+     *
+     * @param point - The delivery point.
+     */
     setDeliverPoint(point: Nullable<DeliveryPoint>): void;
 }
+/**
+ * Selects the delivery point from the state.
+ *
+ * @param state - The state object.
+ * @returns The selected delivery point.
+ */
 export declare const selectDeliveryPoint: (state: State) => Nullable<DeliveryPoint>;
 export declare const useDeliveryPointStore: import("zustand").UseBoundStore<import("zustand").StoreApi<State & Action>>;
 export {};

package/dist/lib/utils/getAddressFormGeocode.d.ts

@@ -0,0 +1,42 @@
+/// <reference types="google.maps" />
+interface PlusCode {
+    compound_code: string;
+    global_code: string;
+}
+interface GetAddressFromLatLngResponse {
+    plus_code: PlusCode;
+    results?: Array<google.maps.places.PlaceResult>;
+    status: string | "OK";
+}
+type PlaceId = string;
+export type GeoLocationType = "ROOFTOP" | "GEOMETRIC_CENTER" | "RANGE_INTERPOLATED" | "GEOMETRIC_CENTER" | "APPROXIMATE";
+/**
+ * Checks if a value is a place ID.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is a place ID, false otherwise.
+ */
+export declare const isPlaceId: (value: unknown) => value is string;
+/**
+ * Checks if a value is coordinates.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is coordinates, false otherwise.
+ */
+export declare const isCoordinates: (value: unknown) => value is Coordinates;
+/**
+ * Retrieves the address information from a place ID.
+ *
+ * @param placeId - The place ID.
+ * @returns A promise that resolves to the address information.
+ */
+export declare function getAddressFormGeocode(placeId: PlaceId): Promise<GetAddressFromLatLngResponse>;
+/**
+ * Retrieves the address information from a set of coordinates.
+ *
+ * @param coordinates - The coordinates.
+ * @param types - The types of the location.
+ * @returns A promise that resolves to the address information.
+ */
+export declare function getAddressFormGeocode(coordinates: Coordinates, types?: GeoLocationType[]): Promise<GetAddressFromLatLngResponse>;
+export {};

package/dist/lib/utils/index.d.ts

@@ -4,7 +4,7 @@ export * from "./getBoundsFromPoint";
 export * from "./createPointsIterator";
 export * from "./setWidgetCSSProperty";
 export * from "./stopImmediatePropagation";
-export * from "./getAddressFromLatLng";
+export * from "./getAddressFormGeocode";
 export * from "./getCurrentPosition";
 export * from "./isHttpSuccess";
 export * from "./getPropertyValue";