@overmap-ai/forms 1.0.32-react-flow-david.1 → 1.0.32-react-flow-david-fixes.1

package/dist/form/fields/index.d.ts

@@ -1,5 +1,7 @@
 export * from './BaseField';
-export * from './BaseSelectField';
+export * from './BaseFormElement';
+export * from './BaseOptionsField';
+export * from './BaseStringField';
 export * from './BooleanField';
 export * from './CheckboxListField';
 export * from './components';
@@ -14,8 +16,7 @@ export * from './RadioField';
 export * from './ScanField';
 export * from './SelectField';
 export * from './StringField';
-export * from './StringOrTextField';
 export * from './TextField';
-export * from './typings';
+export type * from './typings';
 export * from './UploadField';
 export * from './utils';

package/dist/form/fields/typings.d.ts

@@ -1,37 +1,43 @@
 import { TextSize } from '@overmap-ai/blocks';
 import { HTMLProps } from 'react';
-import { FormBuilderValues } from '../builder';
-import { FormValues } from '../typings';
-import { BaseField, BaseFormElement } from './BaseField';
-import { SerializedBooleanField } from './BooleanField';
-import { SerializedCheckboxListField } from './CheckboxListField';
-import { SerializedDateField } from './DateField';
-import { SerializedFieldSection } from './FieldSection';
-import { SerializedMultiSelectField } from './MultiSelectField';
-import { SerializedMultiStringField } from './MultiStringField';
-import { SerializedNumberField } from './NumberField';
-import { SerializedRadioField } from './RadioField';
-import { SerializedScanField } from './ScanField';
-import { SerializedSelectField } from './SelectField';
-import { SerializedStringField } from './StringField';
-import { SerializedTextField } from './TextField';
-import { SerializedUploadField } from './UploadField';
-export type FieldTypeIdentifier = "string" | "text" | "boolean" | "number" | "date" | "select" | "section" | "multi-string" | "multi-select" | "upload" | "qr" | "radio" | "checkbox-list";
-export type FieldValue = string | number | boolean | string[] | File[] | Date | null;
-export type ValueOfField<TField extends AnyField> = TField extends BaseField<infer _TIdentifier, infer TValue, infer _TConditionValue, infer _TSerializedConditionValue> ? TValue : never;
-export type ConditionValueOfField<TField extends AnyField> = TField extends BaseField<infer _TIdentifier, infer _TValue, infer TConditionValue, infer _TSerializedConditionValue> ? TConditionValue : never;
-export type SerializedConditionValueOfField<TField extends AnyField> = TField extends BaseField<infer _TIdentifier, infer _TValue, infer _TConditionValue, infer TSerializedConditionValue> ? TSerializedConditionValue : never;
-export type InputFieldLevelValidator<TValue> = (value: TValue | undefined) => string | null | undefined;
-export type InputFormLevelValidator<TValue> = (value: TValue | undefined, allValues: FormValues | FormBuilderValues) => string | null | undefined;
-export type InputValidator<TValue> = InputFieldLevelValidator<TValue> | InputFormLevelValidator<TValue>;
-export interface ComponentProps<TField extends BaseFormElement> extends Omit<HTMLProps<HTMLElement>, "color" | "size" | "ref" | "type" | "onChange" | "onBlur" | "value" | "defaultValue" | "name" | "dir"> {
-    field: TField;
+import { BaseField } from './BaseField';
+import { AnyFormElement, BaseFormElement } from './BaseFormElement';
+import { BooleanField, SerializedBooleanField } from './BooleanField';
+import { CheckboxListField, SerializedCheckboxListField } from './CheckboxListField';
+import { DateField, SerializedDateField } from './DateField';
+import { FieldSection, SerializedFieldSection } from './FieldSection';
+import { MultiSelectField, SerializedMultiSelectField } from './MultiSelectField';
+import { MultiStringField, SerializedMultiStringField } from './MultiStringField';
+import { NumberField, SerializedNumberField } from './NumberField';
+import { RadioField, SerializedRadioField } from './RadioField';
+import { ScanField, SerializedScanField } from './ScanField';
+import { SelectField, SerializedSelectField } from './SelectField';
+import { SerializedStringField, StringField } from './StringField';
+import { SerializedTextField, TextField } from './TextField';
+import { SerializedUploadField, UploadField } from './UploadField';
+export type AnyField = BaseField<any, any, any, any>;
+export type TypeOfField<TField extends AnyFormElement> = TField extends BaseFormElement<infer TIdentifier, infer _TThis> ? TIdentifier : never;
+export type ValueOfField<TField extends AnyField> = TField extends BaseField<infer _TIdentifier, infer TValue, infer _TSerializedValue, infer _TThis> ? TValue : never;
+export type SerializedValueOfField<TField extends AnyField> = TField extends BaseField<infer _TIdentifier, infer _TValue, infer TSerializedValue, infer _TThis> ? TSerializedValue : never;
+export type FieldValidator<TValue> = (value: TValue | undefined) => string | null | undefined;
+export interface ComponentProps extends Omit<HTMLProps<HTMLElement>, "color" | "size" | "ref" | "type" | "onChange" | "onBlur" | "value" | "defaultValue" | "name" | "dir"> {
     formId: string;
     size?: TextSize;
     onValuesChange?: (identifier: string, value: ValueOfField<AnyField>) => void;
     showInputOnly?: boolean;
 }
-export type GetInputProps<TField extends BaseFormElement> = Omit<ComponentProps<TField>, "field">;
-export type AnyField = BaseField<any, any, any, any>;
-export type ISerializedField = SerializedTextField | SerializedBooleanField | SerializedNumberField | SerializedDateField | SerializedStringField | SerializedSelectField | SerializedFieldSection | SerializedMultiStringField | SerializedMultiSelectField | SerializedUploadField | SerializedScanField | SerializedRadioField | SerializedCheckboxListField;
-export type ISerializedOnlyField = Exclude<ISerializedField, SerializedFieldSection>;
+export type FieldType = TypeOfField<BooleanField> | TypeOfField<CheckboxListField> | TypeOfField<DateField> | TypeOfField<MultiSelectField> | TypeOfField<MultiStringField> | TypeOfField<NumberField> | TypeOfField<RadioField> | TypeOfField<ScanField> | TypeOfField<SelectField> | TypeOfField<StringField> | TypeOfField<TextField> | TypeOfField<UploadField> | TypeOfField<FieldSection>;
+export type FieldValue = ValueOfField<BooleanField> | ValueOfField<CheckboxListField> | ValueOfField<DateField> | ValueOfField<MultiSelectField> | ValueOfField<MultiStringField> | ValueOfField<NumberField> | ValueOfField<RadioField> | ValueOfField<ScanField> | ValueOfField<SelectField> | ValueOfField<StringField> | ValueOfField<TextField> | ValueOfField<UploadField>;
+export type SerializedFieldValue = SerializedValueOfField<BooleanField> | SerializedValueOfField<CheckboxListField> | SerializedValueOfField<DateField> | SerializedValueOfField<MultiSelectField> | SerializedValueOfField<MultiStringField> | SerializedValueOfField<NumberField> | SerializedValueOfField<RadioField> | SerializedValueOfField<ScanField> | SerializedValueOfField<SelectField> | SerializedValueOfField<StringField> | SerializedValueOfField<TextField> | SerializedValueOfField<UploadField>;
+export type Field = BooleanField | CheckboxListField | DateField | MultiSelectField | MultiStringField | NumberField | RadioField | ScanField | SelectField | StringField | TextField | UploadField;
+export type SerializedField = SerializedTextField | SerializedBooleanField | SerializedNumberField | SerializedDateField | SerializedStringField | SerializedSelectField | SerializedFieldSection | SerializedMultiStringField | SerializedMultiSelectField | SerializedUploadField | SerializedScanField | SerializedRadioField | SerializedCheckboxListField;
+export type SerializedOnlyField = Exclude<SerializedField, SerializedFieldSection>;
+export interface FieldsManagerInterface<TField extends AnyFormElement> {
+    readonly fields: TField[];
+    getFields(): TField[];
+    addField(field: TField): void;
+    addFields(fields: TField[]): void;
+    moveField(sourceIndex: number, targetIndex: number): void;
+    removeField(field: TField): void;
+    removeFields(fields: TField[]): void;
+}

package/dist/form/fields/utils.d.ts

@@ -1,16 +1,11 @@
-import { BaseFormElement } from './BaseField';
+import { SerializedFieldValues } from '../typings';
 import { FieldSection } from './FieldSection';
-import { AnyField, FieldValue, ISerializedField, ISerializedOnlyField } from './typings';
-/** Deserializes anything but a FieldSection.
- * @see `deserialize` for most use cases
- */
-export declare const deserializeField: (serializedField: ISerializedOnlyField) => AnyField;
-/** Deserializes anything */
-export declare const deserialize: (serialized: ISerializedField) => AnyField | FieldSection;
-export declare function deserializeFields(fields: ISerializedField[]): (AnyField | FieldSection)[];
-export declare function deserializeOnlyFields(fields: ISerializedOnlyField[]): AnyField[];
-export declare function flattenFields(fields: BaseFormElement[]): AnyField[];
-export declare function getFieldsMapping(fields: BaseFormElement[]): Record<string, AnyField>;
-export declare function decodeFieldValues(fields: BaseFormElement[], values: Record<string, string>): Record<string, FieldValue>;
-export declare function encodeFieldValues(fields: BaseFormElement[], values: Record<string, FieldValue>): Record<string, string>;
-export declare function valueIsFile(v: FieldValue | Promise<File>[] | undefined): v is File[] | Promise<File>[];
+import { AnyField, Field, FieldValue, SerializedField, SerializedFieldValue, SerializedOnlyField } from './typings';
+export declare const deserializeField: (serializedField: SerializedOnlyField) => Field;
+export declare const deserialize: (serialized: SerializedField) => Field | FieldSection;
+export declare function deserializeFields(fields: SerializedField[]): (Field | FieldSection)[];
+export declare function deserializeOnlyFields(fields: SerializedOnlyField[]): Field[];
+export declare function flattenFields(fields: (Field | FieldSection)[]): Field[];
+export declare function getFieldsMapping(fields: (Field | FieldSection)[]): Record<string, Field>;
+export declare function serializeFieldValues(fields: AnyField[], values: SerializedFieldValues): Record<string, SerializedFieldValue>;
+export declare function deserializeFieldValues(fields: AnyField[], values: SerializedFieldValues): Record<string, FieldValue>;

package/dist/form/index.d.ts

@@ -3,4 +3,4 @@ export * from './constants';
 export * from './fields';
 export * from './renderer';
 export type * from './typings';
-export { initializeFormValues, validateFields } from './utils';
+export { initializeFieldValues, validateFields } from './utils';

package/dist/form/{conditions/modifiers → modifiers}/boolean.d.ts

@@ -1,3 +1,3 @@
-import { ConditionModifier } from '../modifier/conditionModifier';
+import { ConditionModifier } from './conditionModifier';
 export declare const BooleanEqualsConditionModifier: ConditionModifier<boolean, boolean, boolean>;
 export declare const BooleanNotEqualsConditionModifier: ConditionModifier<boolean, boolean, boolean>;

package/dist/form/{conditions/modifier → modifiers}/conditionModifier.d.ts

@@ -1,15 +1,15 @@
-import { ConditionModifierFn, ConditionModifierRenderFn } from '../typings';
+import { ConditionModifierFn } from './typings';
 export interface ConditionModifierConfig<TModifierValue, TModifierConditionValue, TSerializedModifierConditionValue = TModifierConditionValue> {
     id: string;
+    label: string;
     modifierFn: ConditionModifierFn<TModifierValue, TModifierConditionValue>;
-    render: ConditionModifierRenderFn<TModifierConditionValue>;
     serialize: (conditionValue: TModifierConditionValue) => TSerializedModifierConditionValue;
     deserialize: (serializedConditionValue: TSerializedModifierConditionValue) => TModifierConditionValue | undefined;
 }
 export declare class ConditionModifier<TModifierValue, TConditionValue, TSerializedConditionValue = TConditionValue> {
     readonly id: string;
+    readonly label: string;
     readonly modifierFn: ConditionModifierFn<TModifierValue, TConditionValue>;
-    readonly render: ConditionModifierRenderFn<TConditionValue>;
     readonly serialize: (conditionValue: TConditionValue) => TSerializedConditionValue;
     readonly deserialize: (serializedConditionValue: TSerializedConditionValue) => TConditionValue | undefined;
     private constructor();

package/dist/form/modifiers/date.d.ts

@@ -0,0 +1,9 @@
+import { DateRange } from 'react-day-picker';
+import { SerializedDateRange } from '../fields';
+import { ConditionModifier } from './conditionModifier';
+export declare const DateEqualsConditionModifier: ConditionModifier<Date, Date, string>;
+export declare const DateNotEqualsConditionModifier: ConditionModifier<Date, Date, string>;
+export declare const DateBeforeConditionModifier: ConditionModifier<Date, Date, string>;
+export declare const DateAfterConditionModifier: ConditionModifier<Date, Date, string>;
+export declare const DateRangeInConditionModifier: ConditionModifier<Date, DateRange, SerializedDateRange>;
+export declare const DateRangeNotInConditionModifier: ConditionModifier<Date, DateRange, SerializedDateRange>;

package/dist/form/{conditions/modifiers → modifiers}/file.d.ts

@@ -1,3 +1,3 @@
-import { ConditionModifier } from '../modifier/conditionModifier';
+import { ConditionModifier } from './conditionModifier';
 export declare const HasFilesConditionModifier: ConditionModifier<File[], boolean, boolean>;
 export declare const DoesNotHaveFilesConditionModifier: ConditionModifier<File[], boolean, boolean>;

package/dist/form/{conditions/modifiers → modifiers}/index.d.ts

@@ -1,4 +1,7 @@
 export * from './boolean';
 export * from './date';
+export * from './file';
 export * from './number';
 export * from './string';
+export type * from './typings';
+export * from './utils';

package/dist/form/{conditions/modifiers → modifiers}/number.d.ts

@@ -1,7 +1,10 @@
-import { ConditionModifier } from '../modifier/conditionModifier';
+import { NumberRange } from '../fields';
+import { ConditionModifier } from './conditionModifier';
 export declare const NumberEqualsConditionModifier: ConditionModifier<number, number, number>;
 export declare const NumberNotEqualsConditionModifier: ConditionModifier<number, number, number>;
 export declare const NumberLessThanConditionModifier: ConditionModifier<number, number, number>;
 export declare const NumberLessThanOrEqualsConditionModifier: ConditionModifier<number, number, number>;
 export declare const NumberGreaterThanConditionModifier: ConditionModifier<number, number, number>;
 export declare const NumberGreaterThanOrEqualsConditionModifier: ConditionModifier<number, number, number>;
+export declare const NumberRangeInConditionModifier: ConditionModifier<number, NumberRange, NumberRange>;
+export declare const NumberRangeNotInConditionModifier: ConditionModifier<number, NumberRange, NumberRange>;

package/dist/form/{conditions/modifiers → modifiers}/string.d.ts

@@ -1,4 +1,4 @@
-import { ConditionModifier } from '../modifier/conditionModifier';
+import { ConditionModifier } from './conditionModifier';
 export declare const StringEqualsConditionModifier: ConditionModifier<string, string, string>;
 export declare const StringNotEqualsConditionModifier: ConditionModifier<string, string, string>;
 export declare const StringIncludesConditionModifier: ConditionModifier<string, string, string>;

package/dist/form/modifiers/typings.d.ts

@@ -0,0 +1,11 @@
+import { ConditionModifier } from './conditionModifier';
+export type ConditionModifierFn<TValue, TConditionValue> = (value: TValue, conditionValue: TConditionValue) => boolean;
+export interface FieldConditionModifierConfig<TValue, TConditionValue, TSerializedConditionValue, TModifierValue extends TValue, TModifierConditionValue extends TConditionValue, TSerializedModifierConditionValue extends TSerializedConditionValue> {
+    modifier: ConditionModifier<TModifierValue, TModifierConditionValue, TSerializedModifierConditionValue>;
+    isValueValid: (value: TValue) => value is TModifierValue;
+    isConditionValueValid: (conditionValue: TConditionValue) => conditionValue is TModifierConditionValue;
+    isSerializedValueValid: (serializedConditionValue: TSerializedConditionValue) => serializedConditionValue is TSerializedModifierConditionValue;
+}
+export type AnyConditionModifierConfig<TValue, TConditionValue, TSerializedConditionValue> = FieldConditionModifierConfig<TValue, TConditionValue, TSerializedConditionValue, any, // eslint-disable-line @typescript-eslint/no-explicit-any
+any, // eslint-disable-line @typescript-eslint/no-explicit-any
+any>;

package/dist/form/modifiers/utils.d.ts

@@ -0,0 +1,2 @@
+import { FieldConditionModifierConfig } from './typings';
+export declare const createConditionModifierConfig: <TFieldValue, TFieldConditionValue, TSerializedFieldConditionValue, TModifierValue extends TFieldValue, TModifierConditionalValue extends TFieldConditionValue, TSerializedModifierConditionValue extends TSerializedFieldConditionValue>(conifg: FieldConditionModifierConfig<TFieldValue, TFieldConditionValue, TSerializedFieldConditionValue, TModifierValue, TModifierConditionalValue, TSerializedModifierConditionValue>) => FieldConditionModifierConfig<TFieldValue, TFieldConditionValue, TSerializedFieldConditionValue, TModifierValue, TModifierConditionalValue, TSerializedModifierConditionValue>;

package/dist/form/observable/Observable.d.ts

@@ -0,0 +1,5 @@
+export declare abstract class Observable<TObservable> {
+    readonly observers: Set<(observable: TObservable) => void>;
+    protected notify(observable: TObservable): void;
+    observe(callback: (observable: TObservable) => void): () => void;
+}

package/dist/form/renderer/{FormRenderer/FormRenderer.d.ts → FormRenderer.d.ts}

@@ -1,15 +1,15 @@
 import { ButtonProps } from '@overmap-ai/blocks';
-import { FormValues, ISchema } from '../../typings';
+import { FieldValues, ISchema } from '../typings';
 interface FormRendererProps {
     /** The schema of the form the render */
     schema: ISchema;
     /** Initial values of the form */
-    values?: FormValues;
+    values?: FieldValues;
     /** The function to call when the form values change */
-    onValuesChange?: (allValues: FormValues, changedValues: FormValues) => void;
+    onValuesChange?: (allValues: FieldValues, changedValues: FieldValues) => void;
     enableReinitialize?: boolean;
     excludeUnchangedFields?: boolean;
-    onSubmit?: (values: FormValues) => Promise<void> | void;
+    onSubmit?: (values: FieldValues) => Promise<void> | void;
     /** @default "Submit" */
     submitText?: string;
     /** The text of the cancel button (hidden by default)

package/dist/form/renderer/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const requiredFields: (import('..').Field | import('..').FieldSection)[];
+export declare const notRequiredFields: (import('..').Field | import('..').FieldSection)[];

package/dist/form/renderer/context.d.ts

@@ -1,7 +1,2 @@
-import { BaseFormElement } from '../fields';
-interface RendererContextValue {
-    fields: BaseFormElement[];
-}
-export declare const RendererProvider: import('react').Provider<RendererContextValue | null>;
-export declare const useRendererContext: () => RendererContextValue | null;
-export {};
+import { ISchema } from '../typings';
+export declare const RendererContext: import('react').Context<ISchema>;

package/dist/form/renderer/index.d.ts

@@ -1,2 +1 @@
-export * from './FormRenderer/FormRenderer';
-export * from './PatchForm';
+export * from './FormRenderer';

package/dist/form/schema/FieldSchema.d.ts

@@ -0,0 +1,16 @@
+import { FieldSection, FieldsManagerInterface, SerializedFieldSection } from '../fields';
+import { Observable } from '../observable/Observable';
+export declare class FieldSchema extends Observable<FieldSchema> implements FieldsManagerInterface<FieldSection> {
+    fields: FieldSection[];
+    constructor(fields: FieldSection[]);
+    serialize(): SerializedFieldSection[];
+    static deserialize(serializedSections: SerializedFieldSection[]): FieldSchema;
+    private fieldObserver;
+    private initFields;
+    addField(field: FieldSection): void;
+    addFields(fields: FieldSection[]): void;
+    getFields(): FieldSection[];
+    removeField(field: FieldSection): void;
+    removeFields(fields: FieldSection[]): void;
+    moveField(sourceIndex: number, targetIndex: number): void;
+}

package/dist/form/schema/context.d.ts

@@ -0,0 +1,2 @@
+import { FieldSchema } from './FieldSchema';
+export declare const FieldSchemaContext: import('react').Context<FieldSchema>;

package/dist/form/schema/index.d.ts

@@ -0,0 +1 @@
+export * from './FieldSchema';

package/dist/form/typings.d.ts

@@ -1,27 +1,14 @@
-import { ReactNode } from 'react';
-import { BaseFormElement, FieldValue } from './fields';
-/**
- * When upload fields are given initial values, that value will be
- * a `Promise<File>[]` instead of a `File[]` as the files must be downloaded.
- * `Promise<File>[]` is not add to the `FieldValue` type as it is not a valid
- * value for submitted form as the files must be present to be submitted
- * TODO: This causes type errors in hemora-web. Maybe we should change this to:
- *  export type Form = {
- *    data: Record<string, FieldValue>,
- *    attachments: Record<string, Promise<File>[]>
- *  }
- *  Then, we could just use `data` for creating attachment instances.
- */
-export type FormValues = Record<string, FieldValue | Promise<File>[]>;
-/** All the possible field values */
+import { Field, FieldSection, FieldValue, SerializedFieldValue } from './fields';
+export type FieldValues = Record<string, FieldValue | Promise<File>[] | undefined>;
+export type SerializedFieldValues = Record<string, SerializedFieldValue>;
 export type Severity = "danger" | "warning" | "info" | "success";
 export interface SchemaMeta {
     readonly: boolean;
 }
 export interface ISchema {
     id?: string;
-    fields: BaseFormElement[];
+    fields: (Field | FieldSection)[];
     meta: SchemaMeta;
-    title: ReactNode;
-    description?: ReactNode;
+    title: string;
+    description?: string;
 }

package/dist/form/utils.d.ts

@@ -1,8 +1,8 @@
 import { FormikErrors } from 'formik';
 import { FormBuilderValues } from './builder';
-import { BaseFormElement } from './fields';
-import { FormValues } from './typings';
+import { AnyFormElement } from './fields';
+import { FieldValues } from './typings';
 export declare const hasKeys: (errors: object) => boolean;
-export declare const validateFields: (fields: BaseFormElement[], values: FormValues | FormBuilderValues) => FormikErrors<FormValues | FormBuilderValues> | undefined;
-export declare const initializeFormValues: (fields: BaseFormElement[], values: FormValues) => FormValues;
-export declare const getChangedFormValues: (fields: BaseFormElement[], values1: FormValues, values2: FormValues) => FormValues;
+export declare const validateFields: (fields: AnyFormElement[], values: FieldValues | FormBuilderValues) => FormikErrors<FieldValues | FormBuilderValues> | undefined;
+export declare const initializeFieldValues: (fields: AnyFormElement[], values: FieldValues) => FieldValues;
+export declare const changedFieldValues: (fields: AnyFormElement[], values1: FieldValues, values2: FieldValues) => FieldValues;