@aws/address-form-sdk-js 1.0.0 → 1.2.0

package/dist/lib/components/AddressForm/index.d.ts

@@ -1,4 +1,4 @@
-import { AutocompleteFilterPlaceType } from '@aws-sdk/client-geo-places';
+import { AutocompleteFilterPlaceType, Address } from '@aws-sdk/client-geo-places';
 import { Config } from '../../types/config.ts';
 import { MapProps, MapStyle } from '../Map';
 import { MapMarkerProps } from '../MapMarker/index.tsx';
@@ -14,6 +14,7 @@ export interface AddressFormData {
     country?: string;
     originalPosition?: string;
     adjustedPosition?: string;
+    addressDetails?: Address;
 }
 export type AddressFormField = {
     id: FormFieldID;
@@ -37,6 +38,7 @@ export interface AddressFormProps {
         showAdjustPosition?: boolean;
         hide?: boolean;
         center?: number[];
+        zoom?: number;
     }>;
     className?: string;
     language?: string;

package/dist/lib/components/AddressFormReact/AddressForm.d.ts

@@ -1,22 +1,31 @@
-import { AutocompleteFilterPlaceType } from '@aws-sdk/client-geo-places';
-import { ComponentProps, FormEvent, FunctionComponent, ReactNode } from 'react';
-import { AddressFormData } from '../AddressForm';
+import { Address, AutocompleteFilterPlaceType, GetPlaceIntendedUse } from '@aws-sdk/client-geo-places';
+import { ComponentProps, FunctionComponent, ReactNode } from 'react';
 import { AddressFormAddressFieldProps } from './AddressFormAddressField';
 import { AddressFormCountryFieldProps } from './AddressFormCountryField';
 import { AddressFormMapProps } from './AddressFormMap';
 import { AddressFormTextFieldProps } from './AddressFormTextField';
+export interface AddressFormData {
+    placeId?: string;
+    addressLineOne?: string;
+    addressLineTwo?: string;
+    city?: string;
+    province?: string;
+    postalCode?: string;
+    country?: string;
+    originalPosition?: string;
+    adjustedPosition?: string;
+    addressDetails?: Address;
+}
 export interface AddressFormProps extends AddressFormContentProps {
     apiKey: string;
     region: string;
-    preventDefaultOnSubmit?: boolean;
     language?: string;
     politicalView?: string;
     showCurrentCountryResultsOnly?: boolean;
     allowedCountries?: string[];
     placeTypes?: AutocompleteFilterPlaceType[];
-    onSubmit?: (event: FormEvent & {
-        data: AddressFormData;
-    }) => void;
+    initialMapCenter?: [number, number];
+    initialMapZoom?: number;
 }
 interface ChildComponents {
     AddressField: FunctionComponent<AddressFormAddressFieldProps>;
@@ -25,11 +34,11 @@ interface ChildComponents {
     TextField: FunctionComponent<AddressFormTextFieldProps>;
 }
 export declare const AddressForm: FunctionComponent<AddressFormProps> & ChildComponents;
+export type SubmitHandler = (getData: (options: {
+    intendedUse: GetPlaceIntendedUse;
+}) => Promise<AddressFormData>) => void;
 interface AddressFormContentProps extends Omit<ComponentProps<"form">, "onSubmit"> {
-    preventDefaultOnSubmit?: boolean;
-    onSubmit?: (event: FormEvent & {
-        data: AddressFormData;
-    }) => void;
+    onSubmit?: SubmitHandler;
     className?: string;
     children: ReactNode;
 }

package/dist/lib/components/AddressFormReact/AddressFormAddressField.d.ts

@@ -1,7 +1,7 @@
-import { AddressFormData } from '../AddressForm';
 import { TypeaheadAPIName } from '../Typeahead/use-typeahead-query';
+import { Field } from './AddressFormFields';
 export interface AddressFormAddressFieldProps {
-    name: keyof AddressFormData;
+    name: Field;
     label: string;
     showCurrentLocation: boolean;
     apiName: string | TypeaheadAPIName | null;

package/dist/lib/components/AddressFormReact/AddressFormAutofillHandler.d.ts

@@ -0,0 +1,5 @@
+interface AddressFormAutofillHandlerProps {
+    form: HTMLFormElement;
+}
+export declare const AddressFormAutofillHandler: ({ form }: AddressFormAutofillHandlerProps) => null;
+export {};

package/dist/lib/components/AddressFormReact/AddressFormContext.d.ts

@@ -1,5 +1,6 @@
 import { AutocompleteFilterPlaceType } from '@aws-sdk/client-geo-places';
-import { AddressFormData } from '../AddressForm';
+import { AddressFormData } from './AddressForm';
+import { TypeaheadAPIName } from '../Typeahead/use-typeahead-query';
 export interface MapViewState {
     longitude: number;
     latitude: number;
@@ -10,6 +11,7 @@ export interface AddressFormContextType {
     region: string;
     data: AddressFormData;
     setData: (data: AddressFormData) => void;
+    resetData?: () => void;
     mapViewState?: MapViewState;
     setMapViewState: (mapViewState: MapViewState) => void;
     language?: string;
@@ -17,6 +19,10 @@ export interface AddressFormContextType {
     showCurrentCountryResultsOnly?: boolean;
     allowedCountries?: string[];
     placeTypes?: AutocompleteFilterPlaceType[];
+    isAutofill: boolean;
+    setIsAutofill: (isAutofill: boolean) => void;
+    typeaheadApiName: TypeaheadAPIName | null;
+    setTypeaheadApiName: (typeaheadApiName: TypeaheadAPIName | null) => void;
 }
 export declare const AddressFormContext: import('react').Context<AddressFormContextType | undefined>;
 export declare const useAddressFormContext: () => AddressFormContextType;

package/dist/lib/components/AddressFormReact/AddressFormCountryField.d.ts

@@ -1,6 +1,6 @@
-import { AddressFormData } from '../AddressForm';
+import { Field } from './AddressFormFields';
 export interface AddressFormCountryFieldProps {
-    name: keyof AddressFormData;
+    name: Field;
     className?: string;
     label: string;
     placeholder?: string;

package/dist/lib/components/AddressFormReact/AddressFormFields.d.ts

@@ -1,5 +1,5 @@
 import { PropsWithChildren } from 'react';
-import { AddressFormData } from '../AddressForm';
-export declare const Field: Record<string, keyof AddressFormData>;
+import { AddressFormData } from './AddressForm';
+export declare const Field: Record<string, keyof Omit<AddressFormData, "addressDetails">>;
 export type Field = (typeof Field)[keyof typeof Field];
 export declare const AddressFormFields: import('react').MemoExoticComponent<({ children }: PropsWithChildren) => import('react').ReactNode>;

package/dist/lib/components/AddressFormReact/AddressFormProvider.d.ts

@@ -1,4 +1,4 @@
-import { AutocompleteFilterPlaceType } from '@aws-sdk/client-geo-places';
+import { AutocompleteFilterPlaceType, GeoPlacesClient } from '@aws-sdk/client-geo-places';
 import { FunctionComponent, PropsWithChildren } from 'react';
 export interface AddressFormProps extends PropsWithChildren {
     apiKey: string;
@@ -8,5 +8,8 @@ export interface AddressFormProps extends PropsWithChildren {
     showCurrentCountryResultsOnly?: boolean;
     allowedCountries?: string[];
     placeTypes?: AutocompleteFilterPlaceType[];
+    client?: GeoPlacesClient;
+    initialMapCenter?: [number, number];
+    initialMapZoom?: number;
 }
 export declare const AddressFormProvider: FunctionComponent<AddressFormProps>;

package/dist/lib/components/AddressFormReact/AddressFormTextField.d.ts

@@ -1,6 +1,6 @@
-import { AddressFormData } from '../AddressForm';
+import { Field } from './AddressFormFields';
 export interface AddressFormTextFieldProps {
-    name: keyof AddressFormData;
+    name: Field;
     className?: string;
     label: string;
     placeholder?: string;

package/dist/lib/components/AddressFormReact/index.d.ts

@@ -1 +1 @@
-export { AddressForm } from './AddressForm';
+export { AddressForm, type AddressFormData, type SubmitHandler } from './AddressForm';

package/dist/lib/components/AddressFormReact/render.d.ts

@@ -1,18 +1,16 @@
 import { AutocompleteFilterPlaceType } from '@aws-sdk/client-geo-places';
-import { FormEvent } from 'react';
-import { AddressFormData } from '../AddressForm';
+import { SubmitHandler } from './AddressForm';
 export interface RenderParams {
     root: string;
     apiKey: string;
     region: string;
-    preventDefaultOnSubmit?: boolean;
     language?: string;
     politicalView?: string;
     showCurrentCountryResultsOnly?: boolean;
     allowedCountries?: string[];
     placeTypes?: AutocompleteFilterPlaceType[];
-    onSubmit?: (event: FormEvent & {
-        data: AddressFormData;
-    }) => void;
+    onSubmit?: SubmitHandler;
+    initialMapCenter?: [number, number];
+    initialMapZoom?: number;
 }
 export declare const render: ({ root: selector, ...formProps }: RenderParams) => void;

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

@@ -1,2 +1,3 @@
 export declare const getBoolean: (props: Record<string, unknown>, name: string) => boolean | undefined;
 export declare const getString: (props: Record<string, unknown>, name: string) => string | undefined;
+export declare const parsePosition: (position: string) => [number, number] | undefined;

package/dist/lib/components/MapMarker/AdjustButton/index.d.ts

@@ -0,0 +1,3 @@
+import { FunctionComponent } from 'react';
+import { ButtonProps } from '../../Button';
+export declare const AdjustButton: FunctionComponent<Omit<ButtonProps, "variant">>;

package/dist/lib/components/MapMarker/index.d.ts

@@ -1,6 +1,8 @@
+import { ColorScheme } from '../Map/index.tsx';
 export interface MapMarkerProps {
     adjustablePosition?: boolean;
     markerPosition?: [number, number];
     onSaveMarkerPosition?: (position: [number, number]) => void;
+    colorScheme?: ColorScheme;
 }
-export declare function MapMarker({ adjustablePosition, markerPosition, onSaveMarkerPosition }: MapMarkerProps): import("react/jsx-runtime").JSX.Element | undefined;
+export declare function MapMarker({ adjustablePosition, markerPosition, onSaveMarkerPosition, colorScheme, }: MapMarkerProps): import("react/jsx-runtime").JSX.Element | undefined;

package/dist/lib/components/Typeahead/index.d.ts

@@ -1,7 +1,9 @@
 import { Address } from '@aws-sdk/client-geo-places';
 import { TypeaheadAPIInput, TypeaheadAPIName } from './use-typeahead-query.ts';
 export interface TypeaheadOutput {
+    placeId?: string;
     addressLineOneField?: string;
+    addressLineTwoField?: string;
     fullAddress?: Address;
     position?: [number, number];
 }
@@ -17,5 +19,6 @@ export interface TypeaheadProps {
     onSelect: (value: TypeaheadOutput) => void;
     showCurrentLocation?: boolean;
     debounce?: number;
+    skipNextQuery?: boolean;
 }
 export declare const Typeahead: ({ apiName, ...props }: TypeaheadProps) => import("react/jsx-runtime").JSX.Element;

package/dist/lib/data/countries.d.ts

@@ -2,5 +2,6 @@ export interface Country {
     code: string;
     name: string;
     position?: number[];
+    supported?: boolean;
 }
 export declare const countries: Country[];

package/dist/lib/main.d.ts

@@ -1,18 +1,17 @@
-export { AddressForm, AddressFormMap } from './components/AddressForm';
-export { defaultAddressFormFields, FormFieldID } from './components/AddressForm/form-field';
-export { AddressForm as AddressFormReact } from './components/AddressFormReact/AddressForm';
-export { CountrySelect } from './components/CountrySelect';
-export type { CountrySelectProps } from './components/CountrySelect';
-export type { AddressFormProps, AddressFormMapProps, AddressFormField, AddressFormData, } from './components/AddressForm';
+export { AddressForm, type AddressFormData, type SubmitHandler } from './components/AddressFormReact';
 export { AmazonLocationProvider } from './components/AmazonLocationProvider';
 export { Button } from './components/Button';
+export { CountrySelect, type CountrySelectProps } from './components/CountrySelect';
+export { Flex } from './components/Flex';
 export { FormField } from './components/FormField';
 export { Input } from './components/Input';
 export { LocateButton } from './components/LocateButton';
-export { Map } from './components/Map';
-export { getMapStyleType, getColorScheme } from './components/Map/utils';
-export type { ColorScheme } from './components/Map';
+export { Map, type ColorScheme } from './components/Map';
 export { MapMarker } from './components/MapMarker';
 export { Typeahead } from './components/Typeahead';
 export { getIncludeCountriesFilter } from './utils/country-filter';
+export { getMapStyleType, getColorScheme } from './components/Map/utils';
 export { countries } from './data/countries';
+export { AddressForm as __AddressForm, AddressFormMap as __AddressFormMap } from './components/AddressForm';
+export { defaultAddressFormFields as __defaultAddressFormFields, FormFieldID as __FormFieldID, } from './components/AddressForm/form-field';
+export type { AddressFormProps as __AddressFormProps, AddressFormMapProps as __AddressFormMapProps, AddressFormField as __AddressFormField, AddressFormData as __AddressFormData, } from './components/AddressForm';

package/dist/lib/utils/detect-autofill.d.ts

@@ -0,0 +1,24 @@
+export type AutofillValues = Record<string, string>;
+/**
+ * Detects browser autofill events on a form and executes a callback with the filled values.
+ *
+ * Uses CSS animations to detect when browsers autofill form fields. When autofill is detected,
+ * the callback is invoked with the form's current values after a debounced delay.
+ *
+ * @param form - The HTML form element to monitor for autofill events
+ * @param callback - Function called when autofill is detected, receives form values as key-value pairs
+ * @returns Cleanup function to remove event listeners and reset state
+ *
+ * @example
+ * ```typescript
+ * const form = document.querySelector('form');
+ * const cleanup = detectAutofill(form, (values) => {
+ *   console.log('Autofill detected:', values);
+ *   // { addressLineOne: "123 Main St", city: "New York", ... }
+ * });
+ *
+ * // Later, clean up
+ * cleanup();
+ * ```
+ */
+export declare const detectAutofill: (form: HTMLFormElement, callback: (values: AutofillValues) => void) => () => void;