@lifesg/web-frontend-engine 2.2.4 → 2.2.5

package/components/fields/location-field/location-modal/location-search/types.d.ts

@@ -1,30 +1,30 @@
-import { ILocationCoord, ILocationFieldValues, ILocationMapApi, TExplicitEditMode, TPanelInputMode, TSinglePanelInputMode } from "../../types";
-import { IMapPin } from "../location-picker/types";
-export interface ILocationSearchProps {
-    id?: string | undefined;
-    className: string;
-    onCancel: () => void;
-    onConfirm: () => void;
-    panelInputMode: TPanelInputMode;
-    addressFieldPlaceholder?: string | undefined;
-    gettingCurrentLocation: boolean;
-    gettingCurrentLocationFetchMessage?: string | undefined;
-    locationListTitle?: string | undefined;
-    selectedAddressInfo: ILocationFieldValues;
-    onChangeSelectedAddressInfo: (addressInfo: ILocationFieldValues) => void;
-    handleApiErrors: (error: any) => void;
-    mustHavePostalCode?: boolean | undefined;
-    mapApi?: ILocationMapApi | undefined;
-    onGetLocationCallback: (lat?: number | undefined, lng?: number | undefined) => void;
-    showLocationModal: boolean;
-    mapPickedLatLng?: ILocationCoord | undefined;
-    formValues?: ILocationFieldValues | undefined;
-    updateFormValues: (values: ILocationFieldValues, shouldDirty?: boolean) => void;
-    setSinglePanelMode: (panelMode: TSinglePanelInputMode) => void;
-    hasExplicitEdit?: TExplicitEditMode | undefined;
-    restrictLocationSelection?: boolean | undefined;
-    selectablePins: IMapPin[];
-    disableSearch?: "disabled" | "readonly" | undefined;
-    searchBarIcon?: "search" | "location-pin";
-    bufferRadius?: number | undefined;
-}
+import { ILocationCoord, ILocationFieldValues, ILocationMapApi, TExplicitEditMode, TPanelInputMode, TSinglePanelInputMode } from "../../types";
+import { IMapPin } from "../location-picker/types";
+export interface ILocationSearchProps {
+    id?: string | undefined;
+    className: string;
+    onCancel: () => void;
+    onConfirm: () => void;
+    panelInputMode: TPanelInputMode;
+    addressFieldPlaceholder?: string | undefined;
+    gettingCurrentLocation: boolean;
+    gettingCurrentLocationFetchMessage?: string | undefined;
+    locationListTitle?: string | undefined;
+    selectedAddressInfo: ILocationFieldValues;
+    onChangeSelectedAddressInfo: (addressInfo: ILocationFieldValues) => void;
+    handleApiErrors: (error: any) => void;
+    mustHavePostalCode?: boolean | undefined;
+    mapApi?: ILocationMapApi | undefined;
+    onGetLocationCallback: (lat?: number | undefined, lng?: number | undefined) => void;
+    showLocationModal: boolean;
+    mapPickedLatLng?: ILocationCoord | undefined;
+    formValues?: ILocationFieldValues | undefined;
+    updateFormValues: (values: ILocationFieldValues, shouldDirty?: boolean) => void;
+    setSinglePanelMode: (panelMode: TSinglePanelInputMode) => void;
+    hasExplicitEdit?: TExplicitEditMode | undefined;
+    restrictLocationSelection?: boolean | undefined;
+    selectablePins: IMapPin[];
+    disableSearch?: "disabled" | "readonly" | undefined;
+    searchBarIcon?: "search" | "location-pin";
+    bufferRadius?: number | undefined;
+}

package/components/fields/location-field/location-modal/no-network-modal/no-network-modal.d.ts

@@ -1,7 +1,7 @@
-interface INoNetworkModal {
-    id: string;
-    cachedImage: string;
-    refreshNetwork: () => void;
-}
-declare const NoNetworkModal: ({ id, cachedImage, refreshNetwork }: INoNetworkModal) => import("react/jsx-runtime").JSX.Element;
-export default NoNetworkModal;
+interface INoNetworkModal {
+    id: string;
+    cachedImage: string;
+    refreshNetwork: () => void;
+}
+declare const NoNetworkModal: ({ id, cachedImage, refreshNetwork }: INoNetworkModal) => import("react/jsx-runtime").JSX.Element;
+export default NoNetworkModal;

package/components/fields/location-field/location-modal/no-network-modal/no-network-modal.styles.d.ts

@@ -1,30 +1,29 @@
-/// <reference types="react" />
-export declare const Container: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never> & Partial<Pick<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>>> & string;
-export declare const Image: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>, never> & Partial<Pick<import("react").DetailedHTMLProps<import("react").ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>, never>>> & string;
-export declare const ContentTitle: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("@lifesg/react-design-system/typography").TypographyProps & {
-    ref?: import("react").RefObject<HTMLParagraphElement>;
-} & {
-    as?: import("styled-components").WebTarget;
-    forwardedAs?: import("styled-components").WebTarget;
-}, never> & Partial<Pick<import("@lifesg/react-design-system/typography").TypographyProps & {
-    ref?: import("react").RefObject<HTMLParagraphElement>;
-} & {
-    as?: import("styled-components").WebTarget;
-    forwardedAs?: import("styled-components").WebTarget;
-}, never>>> & string;
-export declare const ContentBody: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("@lifesg/react-design-system/typography").TypographyProps & {
-    ref?: import("react").RefObject<HTMLParagraphElement>;
-} & {
-    as?: import("styled-components").WebTarget;
-    forwardedAs?: import("styled-components").WebTarget;
-}, never> & Partial<Pick<import("@lifesg/react-design-system/typography").TypographyProps & {
-    ref?: import("react").RefObject<HTMLParagraphElement>;
-} & {
-    as?: import("styled-components").WebTarget;
-    forwardedAs?: import("styled-components").WebTarget;
-}, never>>> & string;
-export declare const ButtonWrapper: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<Omit<import("@lifesg/react-design-system/button").ButtonProps & import("react").RefAttributes<HTMLButtonElement>, "ref"> & {
-    ref?: import("react").Ref<HTMLButtonElement>;
-}, never> & Partial<Pick<Omit<import("@lifesg/react-design-system/button").ButtonProps & import("react").RefAttributes<HTMLButtonElement>, "ref"> & {
-    ref?: import("react").Ref<HTMLButtonElement>;
-}, never>>> & string & Omit<(props: import("@lifesg/react-design-system/button").ButtonProps & import("react").RefAttributes<HTMLButtonElement>) => import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>, keyof import("react").Component<any, {}, any>>;
+export declare const Container: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never> & Partial<Pick<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>>> & string;
+export declare const Image: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>, never> & Partial<Pick<import("react").DetailedHTMLProps<import("react").ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>, never>>> & string;
+export declare const ContentTitle: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("@lifesg/react-design-system").TypographyProps & {
+    ref?: import("react").RefObject<HTMLParagraphElement> | undefined;
+} & {
+    as?: import("styled-components").WebTarget;
+    forwardedAs?: import("styled-components").WebTarget;
+}, never> & Partial<Pick<import("@lifesg/react-design-system").TypographyProps & {
+    ref?: import("react").RefObject<HTMLParagraphElement> | undefined;
+} & {
+    as?: import("styled-components").WebTarget;
+    forwardedAs?: import("styled-components").WebTarget;
+}, never>>> & string;
+export declare const ContentBody: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("@lifesg/react-design-system").TypographyProps & {
+    ref?: import("react").RefObject<HTMLParagraphElement> | undefined;
+} & {
+    as?: import("styled-components").WebTarget;
+    forwardedAs?: import("styled-components").WebTarget;
+}, never> & Partial<Pick<import("@lifesg/react-design-system").TypographyProps & {
+    ref?: import("react").RefObject<HTMLParagraphElement> | undefined;
+} & {
+    as?: import("styled-components").WebTarget;
+    forwardedAs?: import("styled-components").WebTarget;
+}, never>>> & string;
+export declare const ButtonWrapper: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<Omit<import("@lifesg/react-design-system").ButtonProps & import("react").RefAttributes<HTMLButtonElement>, "ref"> & {
+    ref?: import("react").Ref<HTMLButtonElement>;
+}, never> & Partial<Pick<Omit<import("@lifesg/react-design-system").ButtonProps & import("react").RefAttributes<HTMLButtonElement>, "ref"> & {
+    ref?: import("react").Ref<HTMLButtonElement>;
+}, never>>> & string & Omit<(props: import("@lifesg/react-design-system").ButtonProps & React.RefAttributes<HTMLButtonElement>) => React.ReactElement | null, keyof import("react").Component<any, {}, any>>;

package/components/fields/location-field/location-modal/types.d.ts

@@ -1,18 +1,18 @@
-import { ILocationCoord, ILocationFieldValues } from "../types";
-import { ILocationPickerProps } from "./location-picker/types";
-import { ILocationSearchProps } from "./location-search/types";
-export interface ILocationModalProps extends Pick<ILocationPickerProps, "mapPanZoom" | "interactiveMapPinIconUrl" | "legendItems">, Pick<ILocationSearchProps, "mapApi" | "mustHavePostalCode" | "gettingCurrentLocationFetchMessage" | "disableSearch" | "addressFieldPlaceholder" | "searchBarIcon" | "bufferRadius"> {
-    id: string;
-    className: string;
-    showLocationModal: boolean;
-    formValues?: ILocationFieldValues | undefined;
-    locationModalStyles?: string | undefined;
-    onClose: () => void;
-    onConfirm: (values: ILocationFieldValues) => void;
-    updateFormValues: (values: ILocationFieldValues, shouldDirty?: boolean) => void;
-    locationListTitle?: string | undefined;
-    mapBannerText?: string | undefined;
-    locationSelectionMode?: "default" | "pins-only" | undefined;
-    pinsOnlyIndicateCurrentLocation?: boolean | undefined;
-    defaultAddress?: ILocationCoord | undefined;
-}
+import { ILocationCoord, ILocationFieldValues } from "../types";
+import { ILocationPickerProps } from "./location-picker/types";
+import { ILocationSearchProps } from "./location-search/types";
+export interface ILocationModalProps extends Pick<ILocationPickerProps, "mapPanZoom" | "interactiveMapPinIconUrl" | "legendItems">, Pick<ILocationSearchProps, "mapApi" | "mustHavePostalCode" | "gettingCurrentLocationFetchMessage" | "disableSearch" | "addressFieldPlaceholder" | "searchBarIcon" | "bufferRadius"> {
+    id: string;
+    className: string;
+    showLocationModal: boolean;
+    formValues?: ILocationFieldValues | undefined;
+    locationModalStyles?: string | undefined;
+    onClose: () => void;
+    onConfirm: (values: ILocationFieldValues) => void;
+    updateFormValues: (values: ILocationFieldValues, shouldDirty?: boolean) => void;
+    locationListTitle?: string | undefined;
+    mapBannerText?: string | undefined;
+    locationSelectionMode?: "default" | "pins-only" | undefined;
+    pinsOnlyIndicateCurrentLocation?: boolean | undefined;
+    defaultAddress?: ILocationCoord | undefined;
+}

package/components/fields/location-field/types.d.ts

@@ -1,163 +1,163 @@
-import { TFieldEventListener } from "../../../utils";
-import { IYupValidationRule } from "../../frontend-engine";
-import { IStaticMapProps } from "../../shared";
-import { IBaseFieldSchema } from "../types";
-import { ILocationInputProps } from "./location-input";
-import { ILocationPickerProps, IMapPin } from "./location-modal/location-picker/types";
-import { ILocationSearchProps } from "./location-modal/location-search/types";
-import { ILocationModalProps } from "./location-modal/types";
-export interface ILocationFieldValidation extends IYupValidationRule {
-    postalCode?: boolean | undefined;
-}
-export interface ILegendItem {
-    id: string;
-    label: string;
-    icon: string;
-}
-export interface ILocationMapApi {
-    reverseGeocode?: string | undefined;
-    convertLatLngToXY?: string | undefined;
-    search?: string | undefined;
-    headers?: Record<string, string> | undefined;
-}
-export interface ILocationFieldSchema<V = undefined> extends IBaseFieldSchema<"location-field", V, ILocationFieldValidation>, Pick<ILocationPickerProps, "interactiveMapPinIconUrl" | "mapPanZoom">, Pick<ILocationSearchProps, "mapApi" | "mustHavePostalCode" | "gettingCurrentLocationFetchMessage" | "hasExplicitEdit" | "disableSearch" | "addressFieldPlaceholder" | "searchBarIcon" | "bufferRadius">, Pick<ILocationInputProps, "locationInputPlaceholder" | "disabled" | "readOnly">, Pick<IStaticMapProps, "staticMapPinColor">, Pick<ILocationModalProps, "locationSelectionMode"> {
-    className?: string;
-    locationModalStyles?: string | undefined;
-    locationListTitle?: string | undefined;
-    mapBannerText?: string | undefined;
-    pinsOnlyIndicateCurrentLocation?: boolean | undefined;
-    legendItems?: ILegendItem[] | undefined;
-    defaultAddress?: ILocationCoord | undefined;
-}
-export type TSinglePanelInputMode = "search" | "map";
-export type TExplicitEditMode = "show" | "explicit";
-export type TPanelInputMode = "search" | "map" | "double";
-export interface ILocationFieldValues {
-    address?: string | undefined;
-    blockNo?: string | undefined;
-    building?: string | undefined;
-    postalCode?: string | undefined;
-    roadName?: string | undefined;
-    lat?: number | undefined;
-    lng?: number | undefined;
-    x?: number | undefined;
-    y?: number | undefined;
-}
-export interface ILocationCoord {
-    lat: number;
-    lng: number;
-}
-export interface IResultListItem extends ILocationFieldValues {
-    displayAddressText?: string | undefined;
-}
-export interface IResultsMetaData {
-    results: IResultListItem[];
-    apiPageNum?: number | undefined;
-    totalNumPages?: number | undefined;
-}
-export interface IDisplayResultListParams extends IResultsMetaData {
-    queryString?: string | undefined;
-    boldResults?: boolean | undefined;
-}
-export type TErrorType = {
-    errorType: "OneMapError" | "GetLocationError" | "GetLocationTimeoutError" | "PostalCodeError";
-};
-export interface TLocationFieldDetail<T = unknown> {
-    payload?: T | undefined;
-    errors?: any | undefined;
-}
-export type TSetCurrentLocationDetail = TLocationFieldDetail<ILocationCoord>;
-export type TLocationFieldErrorDetail = TLocationFieldDetail<TErrorType>;
-export type TLocationFieldEvents = {
-    "show-location-modal-ready": CustomEvent;
-    "get-current-location": CustomEvent;
-    "set-current-location": CustomEvent<TSetCurrentLocationDetail>;
-    error: CustomEvent<TLocationFieldErrorDetail>;
-    "error-end": CustomEvent<TLocationFieldErrorDetail>;
-    "set-selectable-pins": CustomEvent<{
-        pins: IMapPin[];
-    }>;
-};
-export declare class GeolocationPositionErrorWrapper extends Error {
-    code: any;
-    message: any;
-    constructor(error: GeolocationPositionError);
-}
-/** fired after the location field registers the `show-location-modal` event listener and is ready for external triggers */
-declare function locationFieldEvent(uiType: "location-field", type: "show-location-modal-ready", id: string, listener: TFieldEventListener, options?: boolean | AddEventListenerOptions | undefined): void;
-/** fired on showing location modal */
-declare function locationFieldEvent(uiType: "location-field", type: "show-location-modal", id: string, listener: TFieldEventListener, options?: boolean | AddEventListenerOptions | undefined): void;
-/** fired on dismissing location modal */
-declare function locationFieldEvent(uiType: "location-field", type: "hide-location-modal", id: string, listener: TFieldEventListener, options?: boolean | AddEventListenerOptions | undefined): void;
-/**
- * fired on clicking edit button (edit button is only render with `hasExplicitEdit:true` and if a location is selected)
- *
- * `event.preventDefault()` will stop location modal from being shown
- * */
-declare function locationFieldEvent(uiType: "location-field", type: "click-edit-button", id: string, listener: TFieldEventListener, options?: boolean | AddEventListenerOptions | undefined): void;
-/**
- * fired immediately on clicking refresh current location button in location picker
- *
- * `event.preventDefault()` will prevent the search copy from being updated and stop the retrieval of current location
- *
- * Note: if event is prevented, dispatch `trigger-get-current-location` to resume logic
- * */
-declare function locationFieldEvent(uiType: "location-field", type: "click-refresh-current-location", id: string, listener: TFieldEventListener, options?: boolean | AddEventListenerOptions | undefined): void;
-/**
- * fired on attempting to get current location, after search bar copy has been updated to indicate it is getting current location
- *
- * `event.preventDefault()` will stop the retrieval of current location.
- *
- * Note: if event is prevented, dispatch `set-current-location` to set current location and resume the rest of the logic
- * */
-declare function locationFieldEvent(uiType: "location-field", type: "get-current-location", id: string, listener: TFieldEventListener, options?: boolean | AddEventListenerOptions | undefined): void;
-/** fired after determining current location, before updating search results */
-declare function locationFieldEvent(uiType: "location-field", type: "get-selectable-pins", id: string, listener: TFieldEventListener<ILocationCoord>, options?: boolean | AddEventListenerOptions | undefined): void;
-/**
- * fired on confirming selected address in the location modal
- *
- * `event.preventDefault()` will stop the selected address from being passed into Frontend Engine and from dismissing the location modal
- *
- * Note: if event is prevented, dispatch `confirm-location` to confirm location and dismiss location modal
- */
-declare function locationFieldEvent(uiType: "location-field", type: "click-confirm-location", id: string, listener: TFieldEventListener<ILocationFieldValues>, options?: boolean | AddEventListenerOptions | undefined): void;
-/**
- * fired before request location permission modal is dismissed
- *
- * `event.preventDefault()` will stop the permission modal from being dismissed
- *
- * Note: if event is prevented, dispatch `hide-permission-modal` to dismiss the permission modal
- * */
-declare function locationFieldEvent(uiType: "location-field", type: "before-hide-permission-modal", id: string, listener: TFieldEventListener, options?: boolean | AddEventListenerOptions | undefined): void;
-/**
- * fired when there is an error due to:
- * - failure in calling reverse geocode endpoint
- * - failure in performing location search via onemap
- * - `set-current-location` event contains error
- *
- * `event.preventDefault()` will prevent the error from being handled and respective error modal from being shown
- *
- *  Note: if event is prevented, dispatch `error-end` to dismiss any error modals
- **/
-declare function locationFieldEvent(uiType: "location-field", type: "error", id: string, listener: TFieldEventListener<TLocationFieldErrorDetail>, options?: boolean | AddEventListenerOptions | undefined): void;
-export type TLocationEvents = typeof locationFieldEvent;
-/** shows location modal */
-declare function locationFieldTrigger(uiType: "location-field", type: "show-location-modal", id: string, details: TSetCurrentLocationDetail): boolean;
-/** sets current location manually, this is meant to be triggered if `get-current-location` event is prevented */
-declare function locationFieldTrigger(uiType: "location-field", type: "set-current-location", id: string, details: TSetCurrentLocationDetail): boolean;
-/** dismisses error modal (if any), this is meant to be triggered if `error` event is prevented */
-declare function locationFieldTrigger(uiType: "location-field", type: "error-end", id: string, details: TLocationFieldErrorDetail): void;
-/** add pins to location picker */
-declare function locationFieldTrigger(uiType: "location-field", type: "set-selectable-pins", id: string, details: {
-    pins: IMapPin[];
-}): void;
-/** passes location info to Frontend Engine and dismisses location modal. this is meant to be triggered if `click-confirm-location` event is prevented */
-declare function locationFieldTrigger(uiType: "location-field", type: "confirm-location", id: string, details: ILocationFieldValues): void;
-/** dismisses location permission request modal. this is meant to be triggered if `before-hide-permission-modal` is prevented */
-declare function locationFieldTrigger(uiType: "location-field", type: "hide-permission-modal", id: string): void;
-/** dismisses the location modal and discards any location selected in the modal */
-declare function locationFieldTrigger(uiType: "location-field", type: "dismiss-location-modal", id: string): void;
-/** initiate attempt to get current location and updates the search bar to indicate it is getting current location. this is meant to be triggered if `click-refresh-current-location` event is prevented */
-declare function locationFieldTrigger(uiType: "location-field", type: "trigger-get-current-location", id: string): void;
-export type TLocationFieldTriggers = typeof locationFieldTrigger;
-export {};
+import { TFieldEventListener } from "../../../utils";
+import { IYupValidationRule } from "../../frontend-engine";
+import { IStaticMapProps } from "../../shared";
+import { IBaseFieldSchema } from "../types";
+import { ILocationInputProps } from "./location-input";
+import { ILocationPickerProps, IMapPin } from "./location-modal/location-picker/types";
+import { ILocationSearchProps } from "./location-modal/location-search/types";
+import { ILocationModalProps } from "./location-modal/types";
+export interface ILocationFieldValidation extends IYupValidationRule {
+    postalCode?: boolean | undefined;
+}
+export interface ILegendItem {
+    id: string;
+    label: string;
+    icon: string;
+}
+export interface ILocationMapApi {
+    reverseGeocode?: string | undefined;
+    convertLatLngToXY?: string | undefined;
+    search?: string | undefined;
+    headers?: Record<string, string> | undefined;
+}
+export interface ILocationFieldSchema<V = undefined> extends IBaseFieldSchema<"location-field", V, ILocationFieldValidation>, Pick<ILocationPickerProps, "interactiveMapPinIconUrl" | "mapPanZoom">, Pick<ILocationSearchProps, "mapApi" | "mustHavePostalCode" | "gettingCurrentLocationFetchMessage" | "hasExplicitEdit" | "disableSearch" | "addressFieldPlaceholder" | "searchBarIcon" | "bufferRadius">, Pick<ILocationInputProps, "locationInputPlaceholder" | "disabled" | "readOnly">, Pick<IStaticMapProps, "staticMapPinColor">, Pick<ILocationModalProps, "locationSelectionMode"> {
+    className?: string;
+    locationModalStyles?: string | undefined;
+    locationListTitle?: string | undefined;
+    mapBannerText?: string | undefined;
+    pinsOnlyIndicateCurrentLocation?: boolean | undefined;
+    legendItems?: ILegendItem[] | undefined;
+    defaultAddress?: ILocationCoord | undefined;
+}
+export type TSinglePanelInputMode = "search" | "map";
+export type TExplicitEditMode = "show" | "explicit";
+export type TPanelInputMode = "search" | "map" | "double";
+export interface ILocationFieldValues {
+    address?: string | undefined;
+    blockNo?: string | undefined;
+    building?: string | undefined;
+    postalCode?: string | undefined;
+    roadName?: string | undefined;
+    lat?: number | undefined;
+    lng?: number | undefined;
+    x?: number | undefined;
+    y?: number | undefined;
+}
+export interface ILocationCoord {
+    lat: number;
+    lng: number;
+}
+export interface IResultListItem extends ILocationFieldValues {
+    displayAddressText?: string | undefined;
+}
+export interface IResultsMetaData {
+    results: IResultListItem[];
+    apiPageNum?: number | undefined;
+    totalNumPages?: number | undefined;
+}
+export interface IDisplayResultListParams extends IResultsMetaData {
+    queryString?: string | undefined;
+    boldResults?: boolean | undefined;
+}
+export type TErrorType = {
+    errorType: "OneMapError" | "GetLocationError" | "GetLocationTimeoutError" | "PostalCodeError";
+};
+export interface TLocationFieldDetail<T = unknown> {
+    payload?: T | undefined;
+    errors?: any | undefined;
+}
+export type TSetCurrentLocationDetail = TLocationFieldDetail<ILocationCoord>;
+export type TLocationFieldErrorDetail = TLocationFieldDetail<TErrorType>;
+export type TLocationFieldEvents = {
+    "show-location-modal-ready": CustomEvent;
+    "get-current-location": CustomEvent;
+    "set-current-location": CustomEvent<TSetCurrentLocationDetail>;
+    error: CustomEvent<TLocationFieldErrorDetail>;
+    "error-end": CustomEvent<TLocationFieldErrorDetail>;
+    "set-selectable-pins": CustomEvent<{
+        pins: IMapPin[];
+    }>;
+};
+export declare class GeolocationPositionErrorWrapper extends Error {
+    code: any;
+    message: any;
+    constructor(error: GeolocationPositionError);
+}
+/** fired after the location field registers the `show-location-modal` event listener and is ready for external triggers */
+declare function locationFieldEvent(uiType: "location-field", type: "show-location-modal-ready", id: string, listener: TFieldEventListener, options?: boolean | AddEventListenerOptions | undefined): void;
+/** fired on showing location modal */
+declare function locationFieldEvent(uiType: "location-field", type: "show-location-modal", id: string, listener: TFieldEventListener, options?: boolean | AddEventListenerOptions | undefined): void;
+/** fired on dismissing location modal */
+declare function locationFieldEvent(uiType: "location-field", type: "hide-location-modal", id: string, listener: TFieldEventListener, options?: boolean | AddEventListenerOptions | undefined): void;
+/**
+ * fired on clicking edit button (edit button is only render with `hasExplicitEdit:true` and if a location is selected)
+ *
+ * `event.preventDefault()` will stop location modal from being shown
+ * */
+declare function locationFieldEvent(uiType: "location-field", type: "click-edit-button", id: string, listener: TFieldEventListener, options?: boolean | AddEventListenerOptions | undefined): void;
+/**
+ * fired immediately on clicking refresh current location button in location picker
+ *
+ * `event.preventDefault()` will prevent the search copy from being updated and stop the retrieval of current location
+ *
+ * Note: if event is prevented, dispatch `trigger-get-current-location` to resume logic
+ * */
+declare function locationFieldEvent(uiType: "location-field", type: "click-refresh-current-location", id: string, listener: TFieldEventListener, options?: boolean | AddEventListenerOptions | undefined): void;
+/**
+ * fired on attempting to get current location, after search bar copy has been updated to indicate it is getting current location
+ *
+ * `event.preventDefault()` will stop the retrieval of current location.
+ *
+ * Note: if event is prevented, dispatch `set-current-location` to set current location and resume the rest of the logic
+ * */
+declare function locationFieldEvent(uiType: "location-field", type: "get-current-location", id: string, listener: TFieldEventListener, options?: boolean | AddEventListenerOptions | undefined): void;
+/** fired after determining current location, before updating search results */
+declare function locationFieldEvent(uiType: "location-field", type: "get-selectable-pins", id: string, listener: TFieldEventListener<ILocationCoord>, options?: boolean | AddEventListenerOptions | undefined): void;
+/**
+ * fired on confirming selected address in the location modal
+ *
+ * `event.preventDefault()` will stop the selected address from being passed into Frontend Engine and from dismissing the location modal
+ *
+ * Note: if event is prevented, dispatch `confirm-location` to confirm location and dismiss location modal
+ */
+declare function locationFieldEvent(uiType: "location-field", type: "click-confirm-location", id: string, listener: TFieldEventListener<ILocationFieldValues>, options?: boolean | AddEventListenerOptions | undefined): void;
+/**
+ * fired before request location permission modal is dismissed
+ *
+ * `event.preventDefault()` will stop the permission modal from being dismissed
+ *
+ * Note: if event is prevented, dispatch `hide-permission-modal` to dismiss the permission modal
+ * */
+declare function locationFieldEvent(uiType: "location-field", type: "before-hide-permission-modal", id: string, listener: TFieldEventListener, options?: boolean | AddEventListenerOptions | undefined): void;
+/**
+ * fired when there is an error due to:
+ * - failure in calling reverse geocode endpoint
+ * - failure in performing location search via onemap
+ * - `set-current-location` event contains error
+ *
+ * `event.preventDefault()` will prevent the error from being handled and respective error modal from being shown
+ *
+ *  Note: if event is prevented, dispatch `error-end` to dismiss any error modals
+ **/
+declare function locationFieldEvent(uiType: "location-field", type: "error", id: string, listener: TFieldEventListener<TLocationFieldErrorDetail>, options?: boolean | AddEventListenerOptions | undefined): void;
+export type TLocationEvents = typeof locationFieldEvent;
+/** shows location modal */
+declare function locationFieldTrigger(uiType: "location-field", type: "show-location-modal", id: string, details: TSetCurrentLocationDetail): boolean;
+/** sets current location manually, this is meant to be triggered if `get-current-location` event is prevented */
+declare function locationFieldTrigger(uiType: "location-field", type: "set-current-location", id: string, details: TSetCurrentLocationDetail): boolean;
+/** dismisses error modal (if any), this is meant to be triggered if `error` event is prevented */
+declare function locationFieldTrigger(uiType: "location-field", type: "error-end", id: string, details: TLocationFieldErrorDetail): void;
+/** add pins to location picker */
+declare function locationFieldTrigger(uiType: "location-field", type: "set-selectable-pins", id: string, details: {
+    pins: IMapPin[];
+}): void;
+/** passes location info to Frontend Engine and dismisses location modal. this is meant to be triggered if `click-confirm-location` event is prevented */
+declare function locationFieldTrigger(uiType: "location-field", type: "confirm-location", id: string, details: ILocationFieldValues): void;
+/** dismisses location permission request modal. this is meant to be triggered if `before-hide-permission-modal` is prevented */
+declare function locationFieldTrigger(uiType: "location-field", type: "hide-permission-modal", id: string): void;
+/** dismisses the location modal and discards any location selected in the modal */
+declare function locationFieldTrigger(uiType: "location-field", type: "dismiss-location-modal", id: string): void;
+/** initiate attempt to get current location and updates the search bar to indicate it is getting current location. this is meant to be triggered if `click-refresh-current-location` event is prevented */
+declare function locationFieldTrigger(uiType: "location-field", type: "trigger-get-current-location", id: string): void;
+export type TLocationFieldTriggers = typeof locationFieldTrigger;
+export {};

package/components/fields/masked-field/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./masked-field";
-export * from "./types";
+export * from "./masked-field";
+export * from "./types";

package/components/fields/masked-field/masked-field.d.ts

@@ -1,3 +1,3 @@
-import { IGenericFieldProps } from "..";
-import { IMaskedFieldSchema } from "./types";
-export declare const MaskedField: (props: IGenericFieldProps<IMaskedFieldSchema>) => import("react/jsx-runtime").JSX.Element;
+import { IGenericFieldProps } from "..";
+import { IMaskedFieldSchema } from "./types";
+export declare const MaskedField: (props: IGenericFieldProps<IMaskedFieldSchema>) => import("react/jsx-runtime").JSX.Element;

package/components/fields/masked-field/types.d.ts

@@ -1,12 +1,12 @@
-import { FormInputProps, FormMaskedInputProps } from "@lifesg/react-design-system/form/types";
-import * as Icons from "@lifesg/react-icons";
-import { TComponentOmitProps } from "../../frontend-engine";
-import { IBaseFieldSchema } from "../types";
-interface IMaskedFieldProps extends Pick<FormMaskedInputProps, "maskChar" | "maskRange" | "unmaskRange" | "iconActiveColor" | "iconInactiveColor" | "transformInput"> {
-    maskRegex?: string | undefined;
-    iconMask?: keyof typeof Icons | undefined;
-    iconUnmask?: keyof typeof Icons | undefined;
-}
-export interface IMaskedFieldSchema<V = undefined> extends IBaseFieldSchema<"masked-field", V>, TComponentOmitProps<FormInputProps & IMaskedFieldProps, "type" | "maxLength"> {
-}
-export {};
+import { FormInputProps, FormMaskedInputProps } from "@lifesg/react-design-system/form/types";
+import * as Icons from "@lifesg/react-icons";
+import { TComponentOmitProps } from "../../frontend-engine";
+import { IBaseFieldSchema } from "../types";
+interface IMaskedFieldProps extends Pick<FormMaskedInputProps, "maskChar" | "maskRange" | "unmaskRange" | "iconActiveColor" | "iconInactiveColor" | "transformInput"> {
+    maskRegex?: string | undefined;
+    iconMask?: keyof typeof Icons | undefined;
+    iconUnmask?: keyof typeof Icons | undefined;
+}
+export interface IMaskedFieldSchema<V = undefined> extends IBaseFieldSchema<"masked-field", V>, TComponentOmitProps<FormInputProps & IMaskedFieldProps, "type" | "maxLength"> {
+}
+export {};

package/components/fields/multi-select/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./multi-select";
-export * from "./types";
+export * from "./multi-select";
+export * from "./types";

package/components/fields/multi-select/multi-select.d.ts

@@ -1,3 +1,3 @@
-import { IGenericFieldProps } from "..";
-import { IMultiSelectSchema } from "./types";
-export declare const MultiSelect: (props: IGenericFieldProps<IMultiSelectSchema>) => import("react/jsx-runtime").JSX.Element;
+import { IGenericFieldProps } from "..";
+import { IMultiSelectSchema } from "./types";
+export declare const MultiSelect: (props: IGenericFieldProps<IMultiSelectSchema>) => import("react/jsx-runtime").JSX.Element;

package/components/fields/multi-select/types.d.ts

@@ -1,9 +1,9 @@
-import { InputMultiSelectProps } from "@lifesg/react-design-system/input-multi-select";
-import { TComponentOmitProps } from "../../frontend-engine";
-import { IBaseFieldSchema } from "../types";
-export interface IMultiSelectOption {
-    label: string;
-    value: string;
-}
-export interface IMultiSelectSchema<V = undefined> extends IBaseFieldSchema<"multi-select", V>, TComponentOmitProps<InputMultiSelectProps<IMultiSelectOption, string>> {
-}
+import { InputMultiSelectProps } from "@lifesg/react-design-system/input-multi-select";
+import { TComponentOmitProps } from "../../frontend-engine";
+import { IBaseFieldSchema } from "../types";
+export interface IMultiSelectOption {
+    label: string;
+    value: string;
+}
+export interface IMultiSelectSchema<V = undefined> extends IBaseFieldSchema<"multi-select", V>, TComponentOmitProps<InputMultiSelectProps<IMultiSelectOption, string>> {
+}

package/components/fields/nested-multi-select/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./nested-multi-select";
-export * from "./types";
+export * from "./nested-multi-select";
+export * from "./types";

package/components/fields/nested-multi-select/nested-multi-select.d.ts

@@ -1,3 +1,3 @@
-import { IGenericFieldProps } from "..";
-import { INestedMultiSelectSchema } from "./types";
-export declare const NestedMultiSelect: (props: IGenericFieldProps<INestedMultiSelectSchema>) => import("react/jsx-runtime").JSX.Element;
+import { IGenericFieldProps } from "..";
+import { INestedMultiSelectSchema } from "./types";
+export declare const NestedMultiSelect: (props: IGenericFieldProps<INestedMultiSelectSchema>) => import("react/jsx-runtime").JSX.Element;