@wix/form-public 0.39.0 → 0.40.0

package/dist/_tsup-dts-rollup.d.cts

@@ -1,9 +1,13 @@
 import { ErrorType } from '@wix/ambassador-forms-v1-validation-result/types';
-import { FieldType } from '@wix/form-fields';
-import { Form as Form_2 } from '@wix/ambassador-forms-v4-form/types';
+import { Form } from '@wix/ambassador-forms-v4-form/types';
+import { FormFields } from '@wix/form-fields';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { Layout } from '@wix/form-fields';
+import { default as React_2 } from 'react';
+import { ReactElement } from 'react';
 import { requests } from '@wix/ambassador-forms-v4-submission/build/cjs/proto/client/proto-generated';
 import { RichContent } from '@wix/ricos';
+import { FieldType as SchemaFieldType } from '@wix/form-fields';
 
 export declare const AppointmentMapper: PropsMapper;
 
@@ -688,9 +692,43 @@ export declare const ErrorMapper: PropsMapper;
 
 export declare const FIELD_PROP_MAP: FieldMappers;
 
-export declare const FIELD_TYPE_MAP: Record<FieldType, string>;
+export declare const FIELD_TYPE_MAP: Record<SchemaFieldType, FieldType>;
 
-export declare type FieldMappers = Record<string, PropsMapper>;
+declare type FieldMap = {
+    TEXT_INPUT: React.ComponentType<TextInputProps>;
+    TEXT_AREA: React.ComponentType<TextAreaProps>;
+    PHONE_INPUT: React.ComponentType<PhoneInputProps>;
+    MULTILINE_ADDRESS: React.ComponentType<MultilineAddressProps>;
+    DATE_INPUT: React.ComponentType<DateInputProps>;
+    DATE_PICKER: React.ComponentType<DatePickerProps>;
+    DATE_TIME_INPUT: React.ComponentType<DateTimeInputProps>;
+    FILE_UPLOAD: React.ComponentType<FileUploadProps>;
+    NUMBER_INPUT: React.ComponentType<NumberInputProps>;
+    CHECKBOX: React.ComponentType<CheckboxProps>;
+    SIGNATURE: React.ComponentType<SignatureProps>;
+    RATING_INPUT: React.ComponentType<RatingInputProps>;
+    RADIO_GROUP: React.ComponentType<RadioGroupProps>;
+    CHECKBOX_GROUP: React.ComponentType<CheckboxGroupProps>;
+    DROPDOWN: React.ComponentType<DropdownProps>;
+    TAGS: React.ComponentType<TagsProps>;
+    TIME_INPUT: React.ComponentType<TimeInputProps>;
+    TEXT: React.ComponentType<RichTextProps>;
+    SUBMIT_BUTTON: React.ComponentType<SubmitButtonProps>;
+    PRODUCT_LIST: React.ComponentType<ProductListProps>;
+    FIXED_PAYMENT: React.ComponentType<FixedPaymentProps>;
+    PAYMENT_INPUT: React.ComponentType<PaymentInputProps>;
+    DONATION: React.ComponentType<DonationProps>;
+    APPOINTMENT: React.ComponentType<AppointmentProps>;
+    IMAGE_CHOICE: React.ComponentType<ImageChoiceProps>;
+};
+export { FieldMap }
+export { FieldMap as FieldMap_alias_1 }
+
+export declare type FieldMappers = Record<FieldType, PropsMapper>;
+
+export declare type FieldProps = TextInputProps | TextAreaProps | PhoneInputProps | MultilineAddressProps | DateInputProps | DatePickerProps | DateTimeInputProps | FileUploadProps | NumberInputProps | CheckboxProps | SignatureProps | RatingInputProps | RadioGroupProps | CheckboxGroupProps | DropdownProps | TagsProps | TimeInputProps | RichTextProps | SubmitButtonProps | ProductListProps | FixedPaymentProps | PaymentInputProps | DonationProps | AppointmentProps | ImageChoiceProps;
+
+export declare type FieldType = 'TEXT_INPUT' | 'TEXT_AREA' | 'PHONE_INPUT' | 'MULTILINE_ADDRESS' | 'DATE_INPUT' | 'DATE_PICKER' | 'DATE_TIME_INPUT' | 'TIME_INPUT' | 'FILE_UPLOAD' | 'NUMBER_INPUT' | 'CHECKBOX' | 'SIGNATURE' | 'RATING_INPUT' | 'RADIO_GROUP' | 'CHECKBOX_GROUP' | 'DROPDOWN' | 'TAGS' | 'SUBMIT_BUTTON' | 'PRODUCT_LIST' | 'FIXED_PAYMENT' | 'PAYMENT_INPUT' | 'DONATION' | 'APPOINTMENT' | 'IMAGE_CHOICE' | 'TEXT' | '';
 
 /**
  * Data structure for uploaded file information.
@@ -814,10 +852,6 @@ declare interface FixedPaymentProps {
 export { FixedPaymentProps }
 export { FixedPaymentProps as FixedPaymentProps_alias_1 }
 
-declare const Form: ({ form: unformattedForm, fields, values, onChange, errors, onValidate, submitForm, }: FormProps) => JSX_2.Element;
-export { Form }
-export { Form as Form_alias_1 }
-
 declare interface FormError {
     errorPath: string;
     errorType: ErrorType;
@@ -828,47 +862,9 @@ declare interface FormError {
 export { FormError }
 export { FormError as FormError_alias_1 }
 
-declare type FormFields = {
-    TEXT_INPUT: React.ComponentType<TextInputProps>;
-    TEXT_AREA: React.ComponentType<TextAreaProps>;
-    PHONE_INPUT: React.ComponentType<PhoneInputProps>;
-    MULTILINE_ADDRESS: React.ComponentType<MultilineAddressProps>;
-    DATE_INPUT: React.ComponentType<DateInputProps>;
-    DATE_PICKER: React.ComponentType<DatePickerProps>;
-    DATE_TIME_INPUT: React.ComponentType<DateTimeInputProps>;
-    FILE_UPLOAD: React.ComponentType<FileUploadProps>;
-    NUMBER_INPUT: React.ComponentType<NumberInputProps>;
-    CHECKBOX: React.ComponentType<CheckboxProps>;
-    SIGNATURE: React.ComponentType<SignatureProps>;
-    RATING_INPUT: React.ComponentType<RatingInputProps>;
-    RADIO_GROUP: React.ComponentType<RadioGroupProps>;
-    CHECKBOX_GROUP: React.ComponentType<CheckboxGroupProps>;
-    DROPDOWN: React.ComponentType<DropdownProps>;
-    TAGS: React.ComponentType<TagsProps>;
-    TIME_INPUT: React.ComponentType<TimeInputProps>;
-    TEXT: React.ComponentType<RichTextProps>;
-    SUBMIT_BUTTON: React.ComponentType<SubmitButtonProps>;
-    PRODUCT_LIST: React.ComponentType<ProductListProps>;
-    FIXED_PAYMENT: React.ComponentType<FixedPaymentProps>;
-    PAYMENT_INPUT: React.ComponentType<PaymentInputProps>;
-    DONATION: React.ComponentType<DonationProps>;
-    APPOINTMENT: React.ComponentType<AppointmentProps>;
-    IMAGE_CHOICE: React.ComponentType<ImageChoiceProps>;
-};
-export { FormFields }
-export { FormFields as FormFields_alias_1 }
-
-declare type FormProps = {
-    form?: Form_2;
-    values: FormValues;
-    onChange: OnChange;
-    errors: FormError[];
-    onValidate: (errors: FormError[]) => void;
-    fields: FormFields;
-    submitForm: () => void;
-};
-export { FormProps }
-export { FormProps as FormProps_alias_1 }
+declare const FormProvider: ({ children }: Props) => JSX_2.Element;
+export { FormProvider }
+export { FormProvider as FormProvider_alias_1 }
 
 declare type FormValues = {
     [target: string]: PossibleValues;
@@ -1053,6 +1049,10 @@ declare interface ImageChoiceProps extends BaseFieldProps {
 export { ImageChoiceProps }
 export { ImageChoiceProps as ImageChoiceProps_alias_1 }
 
+export declare const mapFieldProps: (fields: FieldMap, mappers: FieldMappers) => FormFields;
+
+export declare const mapFieldTypes: (fields: FormFields, typeMap: Record<SchemaFieldType, string>) => Record<string, React_2.ComponentType<any>>;
+
 declare interface MinMaxLengthProps {
     minLength: number | undefined;
     maxLength: number | undefined;
@@ -1352,7 +1352,7 @@ export declare const ProductListMapper: PropsMapper;
  * ```
  */
 declare interface ProductListProps extends BaseFieldProps {
-    value: ProductValue_2 | null | undefined;
+    value: ProductValue | null | undefined;
     label: string;
     showLabel: boolean;
     description?: RichContent;
@@ -1382,13 +1382,11 @@ export declare type ProductValue = {
     quantity: number;
 };
 
-declare interface ProductValue_2 {
-    productId: string;
-    price: string | number;
-    quantity: number;
-}
+declare type Props = {
+    children: React_2.ReactNode;
+};
 
-export declare type PropsMapper = (props: any) => any;
+export declare type PropsMapper = (props: any) => FieldProps;
 
 export declare const RadioGroupMapper: PropsMapper;
 
@@ -1489,10 +1487,13 @@ export { RatingInputProps as RatingInputProps_alias_1 }
 declare interface RichTextProps {
     content: RichContent;
     maxShownParagraphs: number;
+    id: string;
 }
 export { RichTextProps }
 export { RichTextProps as RichTextProps_alias_1 }
 
+export { SchemaFieldType }
+
 export declare const SignatureMapper: PropsMapper;
 
 /**
@@ -1778,6 +1779,26 @@ declare interface TimeInputProps extends BaseFieldProps {
 export { TimeInputProps }
 export { TimeInputProps as TimeInputProps_alias_1 }
 
+declare const useForm: ({ form: unformattedForm, values, onChange, errors, onValidate, submitForm, fieldMap: fields, }: UseFormProps) => UseFormReturn;
+export { useForm }
+export { useForm as useForm_alias_1 }
+
+export declare type UseFormProps = {
+    form: Form;
+    values: FormValues;
+    onChange: OnChange;
+    errors: FormError[];
+    onValidate: (errors: FormError[]) => void;
+    submitForm: () => void;
+    fieldMap: FieldMap;
+};
+
+declare type UseFormReturn = {
+    columnCount: number;
+    fieldElements: ReactElement[][];
+    fieldsLayout: Record<string, Layout>;
+} | null;
+
 export declare type ValueType = string | number | boolean | string[] | null | undefined | VatIDValue | ProductListValue | WixFile[] | MultilineAddressSubmission | AppointmentSubmitData;
 
 export declare type VatIDValue = {

package/dist/_tsup-dts-rollup.d.ts

@@ -1,9 +1,13 @@
 import { ErrorType } from '@wix/ambassador-forms-v1-validation-result/types';
-import { FieldType } from '@wix/form-fields';
-import { Form as Form_2 } from '@wix/ambassador-forms-v4-form/types';
+import { Form } from '@wix/ambassador-forms-v4-form/types';
+import { FormFields } from '@wix/form-fields';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { Layout } from '@wix/form-fields';
+import { default as React_2 } from 'react';
+import { ReactElement } from 'react';
 import { requests } from '@wix/ambassador-forms-v4-submission/build/cjs/proto/client/proto-generated';
 import { RichContent } from '@wix/ricos';
+import { FieldType as SchemaFieldType } from '@wix/form-fields';
 
 export declare const AppointmentMapper: PropsMapper;
 
@@ -688,9 +692,43 @@ export declare const ErrorMapper: PropsMapper;
 
 export declare const FIELD_PROP_MAP: FieldMappers;
 
-export declare const FIELD_TYPE_MAP: Record<FieldType, string>;
+export declare const FIELD_TYPE_MAP: Record<SchemaFieldType, FieldType>;
 
-export declare type FieldMappers = Record<string, PropsMapper>;
+declare type FieldMap = {
+    TEXT_INPUT: React.ComponentType<TextInputProps>;
+    TEXT_AREA: React.ComponentType<TextAreaProps>;
+    PHONE_INPUT: React.ComponentType<PhoneInputProps>;
+    MULTILINE_ADDRESS: React.ComponentType<MultilineAddressProps>;
+    DATE_INPUT: React.ComponentType<DateInputProps>;
+    DATE_PICKER: React.ComponentType<DatePickerProps>;
+    DATE_TIME_INPUT: React.ComponentType<DateTimeInputProps>;
+    FILE_UPLOAD: React.ComponentType<FileUploadProps>;
+    NUMBER_INPUT: React.ComponentType<NumberInputProps>;
+    CHECKBOX: React.ComponentType<CheckboxProps>;
+    SIGNATURE: React.ComponentType<SignatureProps>;
+    RATING_INPUT: React.ComponentType<RatingInputProps>;
+    RADIO_GROUP: React.ComponentType<RadioGroupProps>;
+    CHECKBOX_GROUP: React.ComponentType<CheckboxGroupProps>;
+    DROPDOWN: React.ComponentType<DropdownProps>;
+    TAGS: React.ComponentType<TagsProps>;
+    TIME_INPUT: React.ComponentType<TimeInputProps>;
+    TEXT: React.ComponentType<RichTextProps>;
+    SUBMIT_BUTTON: React.ComponentType<SubmitButtonProps>;
+    PRODUCT_LIST: React.ComponentType<ProductListProps>;
+    FIXED_PAYMENT: React.ComponentType<FixedPaymentProps>;
+    PAYMENT_INPUT: React.ComponentType<PaymentInputProps>;
+    DONATION: React.ComponentType<DonationProps>;
+    APPOINTMENT: React.ComponentType<AppointmentProps>;
+    IMAGE_CHOICE: React.ComponentType<ImageChoiceProps>;
+};
+export { FieldMap }
+export { FieldMap as FieldMap_alias_1 }
+
+export declare type FieldMappers = Record<FieldType, PropsMapper>;
+
+export declare type FieldProps = TextInputProps | TextAreaProps | PhoneInputProps | MultilineAddressProps | DateInputProps | DatePickerProps | DateTimeInputProps | FileUploadProps | NumberInputProps | CheckboxProps | SignatureProps | RatingInputProps | RadioGroupProps | CheckboxGroupProps | DropdownProps | TagsProps | TimeInputProps | RichTextProps | SubmitButtonProps | ProductListProps | FixedPaymentProps | PaymentInputProps | DonationProps | AppointmentProps | ImageChoiceProps;
+
+export declare type FieldType = 'TEXT_INPUT' | 'TEXT_AREA' | 'PHONE_INPUT' | 'MULTILINE_ADDRESS' | 'DATE_INPUT' | 'DATE_PICKER' | 'DATE_TIME_INPUT' | 'TIME_INPUT' | 'FILE_UPLOAD' | 'NUMBER_INPUT' | 'CHECKBOX' | 'SIGNATURE' | 'RATING_INPUT' | 'RADIO_GROUP' | 'CHECKBOX_GROUP' | 'DROPDOWN' | 'TAGS' | 'SUBMIT_BUTTON' | 'PRODUCT_LIST' | 'FIXED_PAYMENT' | 'PAYMENT_INPUT' | 'DONATION' | 'APPOINTMENT' | 'IMAGE_CHOICE' | 'TEXT' | '';
 
 /**
  * Data structure for uploaded file information.
@@ -814,10 +852,6 @@ declare interface FixedPaymentProps {
 export { FixedPaymentProps }
 export { FixedPaymentProps as FixedPaymentProps_alias_1 }
 
-declare const Form: ({ form: unformattedForm, fields, values, onChange, errors, onValidate, submitForm, }: FormProps) => JSX_2.Element;
-export { Form }
-export { Form as Form_alias_1 }
-
 declare interface FormError {
     errorPath: string;
     errorType: ErrorType;
@@ -828,47 +862,9 @@ declare interface FormError {
 export { FormError }
 export { FormError as FormError_alias_1 }
 
-declare type FormFields = {
-    TEXT_INPUT: React.ComponentType<TextInputProps>;
-    TEXT_AREA: React.ComponentType<TextAreaProps>;
-    PHONE_INPUT: React.ComponentType<PhoneInputProps>;
-    MULTILINE_ADDRESS: React.ComponentType<MultilineAddressProps>;
-    DATE_INPUT: React.ComponentType<DateInputProps>;
-    DATE_PICKER: React.ComponentType<DatePickerProps>;
-    DATE_TIME_INPUT: React.ComponentType<DateTimeInputProps>;
-    FILE_UPLOAD: React.ComponentType<FileUploadProps>;
-    NUMBER_INPUT: React.ComponentType<NumberInputProps>;
-    CHECKBOX: React.ComponentType<CheckboxProps>;
-    SIGNATURE: React.ComponentType<SignatureProps>;
-    RATING_INPUT: React.ComponentType<RatingInputProps>;
-    RADIO_GROUP: React.ComponentType<RadioGroupProps>;
-    CHECKBOX_GROUP: React.ComponentType<CheckboxGroupProps>;
-    DROPDOWN: React.ComponentType<DropdownProps>;
-    TAGS: React.ComponentType<TagsProps>;
-    TIME_INPUT: React.ComponentType<TimeInputProps>;
-    TEXT: React.ComponentType<RichTextProps>;
-    SUBMIT_BUTTON: React.ComponentType<SubmitButtonProps>;
-    PRODUCT_LIST: React.ComponentType<ProductListProps>;
-    FIXED_PAYMENT: React.ComponentType<FixedPaymentProps>;
-    PAYMENT_INPUT: React.ComponentType<PaymentInputProps>;
-    DONATION: React.ComponentType<DonationProps>;
-    APPOINTMENT: React.ComponentType<AppointmentProps>;
-    IMAGE_CHOICE: React.ComponentType<ImageChoiceProps>;
-};
-export { FormFields }
-export { FormFields as FormFields_alias_1 }
-
-declare type FormProps = {
-    form?: Form_2;
-    values: FormValues;
-    onChange: OnChange;
-    errors: FormError[];
-    onValidate: (errors: FormError[]) => void;
-    fields: FormFields;
-    submitForm: () => void;
-};
-export { FormProps }
-export { FormProps as FormProps_alias_1 }
+declare const FormProvider: ({ children }: Props) => JSX_2.Element;
+export { FormProvider }
+export { FormProvider as FormProvider_alias_1 }
 
 declare type FormValues = {
     [target: string]: PossibleValues;
@@ -1053,6 +1049,10 @@ declare interface ImageChoiceProps extends BaseFieldProps {
 export { ImageChoiceProps }
 export { ImageChoiceProps as ImageChoiceProps_alias_1 }
 
+export declare const mapFieldProps: (fields: FieldMap, mappers: FieldMappers) => FormFields;
+
+export declare const mapFieldTypes: (fields: FormFields, typeMap: Record<SchemaFieldType, string>) => Record<string, React_2.ComponentType<any>>;
+
 declare interface MinMaxLengthProps {
     minLength: number | undefined;
     maxLength: number | undefined;
@@ -1352,7 +1352,7 @@ export declare const ProductListMapper: PropsMapper;
  * ```
  */
 declare interface ProductListProps extends BaseFieldProps {
-    value: ProductValue_2 | null | undefined;
+    value: ProductValue | null | undefined;
     label: string;
     showLabel: boolean;
     description?: RichContent;
@@ -1382,13 +1382,11 @@ export declare type ProductValue = {
     quantity: number;
 };
 
-declare interface ProductValue_2 {
-    productId: string;
-    price: string | number;
-    quantity: number;
-}
+declare type Props = {
+    children: React_2.ReactNode;
+};
 
-export declare type PropsMapper = (props: any) => any;
+export declare type PropsMapper = (props: any) => FieldProps;
 
 export declare const RadioGroupMapper: PropsMapper;
 
@@ -1489,10 +1487,13 @@ export { RatingInputProps as RatingInputProps_alias_1 }
 declare interface RichTextProps {
     content: RichContent;
     maxShownParagraphs: number;
+    id: string;
 }
 export { RichTextProps }
 export { RichTextProps as RichTextProps_alias_1 }
 
+export { SchemaFieldType }
+
 export declare const SignatureMapper: PropsMapper;
 
 /**
@@ -1778,6 +1779,26 @@ declare interface TimeInputProps extends BaseFieldProps {
 export { TimeInputProps }
 export { TimeInputProps as TimeInputProps_alias_1 }
 
+declare const useForm: ({ form: unformattedForm, values, onChange, errors, onValidate, submitForm, fieldMap: fields, }: UseFormProps) => UseFormReturn;
+export { useForm }
+export { useForm as useForm_alias_1 }
+
+export declare type UseFormProps = {
+    form: Form;
+    values: FormValues;
+    onChange: OnChange;
+    errors: FormError[];
+    onValidate: (errors: FormError[]) => void;
+    submitForm: () => void;
+    fieldMap: FieldMap;
+};
+
+declare type UseFormReturn = {
+    columnCount: number;
+    fieldElements: ReactElement[][];
+    fieldsLayout: Record<string, Layout>;
+} | null;
+
 export declare type ValueType = string | number | boolean | string[] | null | undefined | VatIDValue | ProductListValue | WixFile[] | MultilineAddressSubmission | AppointmentSubmitData;
 
 export declare type VatIDValue = {