@axdspub/axiom-ui-forms 0.1.1 → 0.1.2

package/README.md

@@ -1,9 +1,22 @@
-Library that allows:
+React library that allows:
 - Creation of forms using a json config file
 - Creation of forms using a [json schema draft 6](https://json-schema.org/draft-06/json-schema-release-notes), with selective overrides using json config
 - To do: allow addition of new form types and UI components by consuming library
 - To do: allow schema version 4 and draft 7
 
+
+
+## Examples
+
+# Create a form using a config
+
+```
+import 
+
+```
+
+
+
 ## Testing build locally
 
 ```

package/library/axiom-ui-forms.d.ts

@@ -0,0 +1,186 @@
+import { GeoJSON } from 'geojson';
+import { ReactElement } from 'react';
+
+interface IValueTypes {
+    text: string;
+    number: number;
+    date: string;
+    datetime: string;
+    time: string;
+    boolean: boolean;
+    geojson: GeoJSON;
+    json: JSON;
+    composite: ICompositeValueType;
+}
+type ValueOf<T> = T[keyof T];
+interface ICompositeValueType {
+    [key: string]: IValueType | IValueType[] | undefined;
+}
+type IValueType = undefined | null | ValueOf<IValueTypes>;
+type IFormField = ITextField | ILongTextField | IJSONField | ISelectField | IRadioField | ICheckboxField | IDateField | ITimeField | IDateTimeField | IBooleanField | IObjectField | IGeoJSONField | IFormFieldSection;
+type IFormFieldType = 'section' | 'text' | 'long_text' | 'number' | 'json' | 'select' | 'radio' | 'checkbox' | 'date' | 'time' | 'datetime' | 'boolean' | 'object' | 'geojson';
+interface IFieldConditions {
+    dependsOn: string | string[];
+    value: string | number | boolean;
+}
+interface IFormFieldRoot {
+    id: string;
+    type: IFormFieldType;
+    required?: boolean;
+    label?: string | null | undefined;
+    multiple?: boolean;
+    path?: string[];
+    fullPath?: string[];
+    level?: number;
+    value?: IValueType;
+    conditions?: IFieldConditions;
+}
+interface IStringValueInput extends IFormFieldRoot {
+    value?: 'text' | 'number';
+    placeholder?: string;
+}
+interface ITextField extends IStringValueInput {
+    type: 'text' | 'number';
+}
+interface ILongTextField extends IStringValueInput {
+    type: 'long_text';
+}
+interface IJSONField extends IFormFieldRoot {
+    type: 'json';
+}
+interface ISelectOption {
+    label: string;
+    value: string;
+}
+interface ISelectableInput extends IFormFieldRoot {
+    options?: ISelectOption[];
+    options_source?: {
+        type: 'url';
+        url: string;
+        method?: 'GET' | 'POST';
+        headers?: Record<string, string>;
+        body?: Record<string, string>;
+        value_key: string;
+        label_key: string;
+    };
+}
+interface ISingleSelectableInput extends ISelectableInput {
+    value?: 'text' | 'number';
+}
+interface IMultiSelectableInput extends ISelectableInput {
+    values?: Array<'text' | 'number'>;
+}
+interface ISelectField extends ISingleSelectableInput {
+    type: 'select';
+}
+interface IRadioField extends ISingleSelectableInput {
+    type: 'radio';
+    layout?: 'horizontal' | 'vertical';
+}
+interface ICheckboxField extends IMultiSelectableInput {
+    type: 'checkbox';
+}
+interface IBooleanField extends IFormFieldRoot {
+    type: 'boolean';
+    value?: 'boolean';
+}
+interface IDateField extends IFormFieldRoot {
+    type: 'date';
+    value?: 'date';
+}
+interface ITimeField extends IFormFieldRoot {
+    type: 'time';
+    value?: 'time';
+}
+interface IDateTimeField extends IFormFieldRoot {
+    type: 'datetime';
+    value?: 'datetime';
+}
+interface IContainerField extends IFormFieldRoot {
+    skip_path?: boolean;
+    fields: IFormField[];
+    layout?: 'horizontal' | 'vertical' | 'grid2' | 'grid3' | 'grid4';
+}
+interface IObjectField extends IContainerField {
+    type: 'object';
+}
+interface IFormFieldSection extends IContainerField {
+    type: 'section';
+    description?: string;
+    multiple: false;
+    value: undefined;
+    values: undefined;
+}
+interface IGeoJSONField extends IFormFieldRoot {
+    type: 'geojson';
+    value?: 'geojson';
+    exclude_types?: string[];
+    include_types?: string[];
+}
+interface IPage {
+    id: string;
+    label: string;
+    description?: string;
+    sections: IFormFieldSection[];
+}
+interface IForm {
+    id: string;
+    label: string;
+    description?: string;
+    fields: IFormField[];
+}
+interface IFormWithPages {
+    id: string;
+    label: string;
+    description?: string;
+    pages: IPage[];
+}
+interface IFormFieldProps {
+    field: IFormField;
+    onChange?: IValueChangeFn;
+}
+type IFormValues = Record<string, IValueType | IValueType[]>;
+type IFormInputComponent = React.FC<IFormFieldProps>;
+type IValueChangeFn = (v: IValueType | IValueType[] | undefined) => void;
+interface IFieldInputProps {
+    form: IForm;
+    field: IFormField;
+    onChange: IValueChangeFn;
+    formValueState: [IFormValues, (v: IFormValues) => void];
+    value?: IValueType;
+}
+
+declare const getChildFields: (field: IFormField) => IFormField[];
+declare const addFieldPath: (field: IFormField, parentPath?: string[]) => IFormField;
+declare const getUniqueFormFields: (form: IForm) => IFormField[];
+declare const getFields: (fields: IFormField[]) => IFormField[];
+declare function copyAndAddPathToFields<T extends IForm | IFormFieldSection | IObjectField>(formOrContainer: T): T;
+declare function getFieldValue(field: IFormField, formValues: IFormValues): IValueType | IValueType[] | undefined;
+declare function getPathFromField(field: IFormField): string;
+declare const checkCondition: (field: IFormField, formValues: IFormValues) => boolean;
+declare function cleanUnusedDependenciesFromFormValues(form: IForm, formValues: IFormValues): IFormValues;
+
+interface IFieldCreator {
+    field: IFormField;
+    form: IForm;
+    onChange?: IValueChangeFn;
+    className?: string;
+    defaultClassName?: string;
+    value?: IValueType | IValueType[];
+    formValueState: [IFormValues, (v: IFormValues) => void];
+}
+declare const FieldCreator: ({ field, form, value, onChange, className, defaultClassName, formValueState }: IFieldCreator) => ReactElement | null;
+
+declare const BooleanInput: ({ field, onChange, value }: IFieldInputProps) => ReactElement;
+
+declare const JSONStringInput: ({ field, onChange, value }: IFieldInputProps) => ReactElement;
+
+declare const NumberInput: ({ field, onChange, value }: IFieldInputProps) => ReactElement;
+
+declare const StringInput: ({ field, onChange, value }: IFieldInputProps) => ReactElement;
+
+declare const LongStringInput: ({ field, onChange, value }: IFieldInputProps) => ReactElement;
+
+declare const SingleSelectInput: ({ field, onChange, value }: IFieldInputProps) => ReactElement;
+
+export { BooleanInput, FieldCreator, type IBooleanField, type ICheckboxField, type ICompositeValueType, type IFieldInputProps, type IForm, type IFormField, type IFormFieldProps, type IFormFieldSection, type IFormFieldType, type IFormInputComponent, type IFormValues, type IFormWithPages, type IObjectField, type IPage, type IRadioField, type ISelectField, type IValueChangeFn, type IValueType, JSONStringInput, LongStringInput as LongTextInput, NumberInput, SingleSelectInput as SelectInput, StringInput as TextInput, addFieldPath, checkCondition, cleanUnusedDependenciesFromFormValues, copyAndAddPathToFields, getChildFields, getFieldValue, getFields, getPathFromField, getUniqueFormFields };