@ahmadmubarak98/namozaj 1.1.5 → 1.1.6

package/dist/main.d.ts

@@ -0,0 +1,395 @@
+import { default as default_2 } from 'react';
+
+export declare type AutoPlacement = "auto" | "auto-start" | "auto-end";
+
+export declare type BaseColors = "primary" | "secondary" | "error" | "warning" | "info" | "success";
+
+export declare type BaseFieldConfig = {
+    name: string;
+    type: FieldType;
+    meta: {
+        label: string;
+        defaultValue?: FieldValueType;
+        style?: React.CSSProperties;
+        placeholder?: string;
+        tooltip?: TooltipConfig;
+        helperText?: HelperTextConfig;
+        validations?: ValidationRule[];
+        grid?: GridColumnConfig;
+        className?: string;
+        disabled?: boolean;
+        visibilityRules?: VisibilityRule[];
+        dependencies?: FieldDependency[];
+    };
+};
+
+export declare type BaseFormFieldProps = {
+    id?: string;
+    name: string;
+    value: any;
+    onChange: ((value: any) => void);
+    error?: boolean;
+    config: DynamicFormField;
+};
+
+export declare type BasePlacement = "top" | "bottom" | "right" | "left";
+
+export declare type ButtonFieldConfig = BaseFieldConfig & {
+    type: "button";
+    meta: BaseFieldConfig["meta"] & {
+        onClick: () => void;
+    };
+};
+
+export declare type CheckboxFieldConfig = BaseFieldConfig & {
+    type: "checkbox";
+    meta: BaseFieldConfig["meta"] & {
+        checked?: boolean;
+    };
+};
+
+export declare type CheckBoxGroupFieldConfig = BaseFieldConfig & {
+    type: "checkbox-group";
+    meta: BaseFieldConfig["meta"] & {
+        horizontal?: boolean;
+        options?: FieldOption[];
+        optionsFetch?: FieldOptionFetch;
+        optionsFetchFnc?: FieldOptionFetchFunction;
+    };
+};
+
+export declare type ComputedFieldConfig = BaseFieldConfig & {
+    type: "computed";
+    meta: BaseFieldConfig["meta"] & {
+        compute: (data: any) => any;
+    };
+};
+
+export declare type DateFieldConfig = BaseFieldConfig & {
+    type: "date" | "time" | "datetime";
+    meta: BaseFieldConfig["meta"] & {
+        format?: string;
+        minDate?: Date;
+        maxDate?: Date;
+        minTime?: Date;
+        maxTime?: Date;
+    };
+};
+
+export declare interface DefaultSubmitButtonProps {
+    label?: string;
+    size?: "default" | "xs" | "sm" | "md" | "lg" | "xl";
+    className?: string;
+    buttonType?: "button" | "submit" | "reset";
+    disabled?: boolean;
+    hidden?: boolean;
+}
+
+export declare type DynamicFormField = TextFieldConfig | NumberFieldConfig | SliderFieldConfig | PhoneFieldConfig | SelectFieldConfig | CheckBoxGroupFieldConfig | RadioGroupFieldConfig | SwitchFieldConfig | CheckboxFieldConfig | DateFieldConfig | FileFieldConfig | ComputedFieldConfig | SectionFieldConfig | ButtonFieldConfig | RepeaterFieldConfig | FieldArrayFieldConfig;
+
+export declare interface DynamicFormProps {
+    fields: DynamicFormField[];
+    emptyFormMessage?: string;
+    defaultValues?: Record<string, FieldValueType>;
+    defaultSubmitButtonProps?: DefaultSubmitButtonProps;
+    loading?: boolean;
+    isNested?: boolean;
+    validationMode?: ValidationMode;
+    enableRtl?: boolean;
+    error?: any;
+    onSubmit?: (data: any) => void;
+    onChange?: (data: any) => void;
+}
+
+export declare interface DynamicFormRef {
+    setFieldValue: (name: string, value: FieldValueType) => void;
+    getFieldValue: (name: string) => any;
+    validateField: (name: string) => Promise<boolean>;
+    validateForm: () => Promise<boolean>;
+    resetForm: () => void;
+    setMultipleFieldValues: (values: Record<string, FieldValueType>) => void;
+    clearFieldError: (name: string) => void;
+    setFieldError: (name: string, error: string) => void;
+    focusField: (name: string) => void;
+    isDirty: () => boolean;
+    isFieldDirty: (name: string) => boolean;
+    submitForm: () => Promise<void>;
+    getFieldError: (name: string) => string | undefined;
+    setFieldVisibility: (name: string, visible: boolean) => void;
+    getFetchedFieldsOptions: () => Promise<any>;
+}
+
+export declare type FieldArrayFieldConfig = BaseFieldConfig & {
+    type: "field-array";
+    meta: BaseFieldConfig["meta"] & {
+        fields: DynamicFormField[];
+        minEntries?: number;
+        maxEntries?: number;
+        addBtn?: string | React.ReactNode;
+        removeBtn?: string | React.ReactNode;
+        cancelBtn?: string | React.ReactNode;
+        removeDialogTitle?: string;
+        removeDialogDescription?: string;
+        emptyMessage?: string;
+        canAdd?: boolean;
+        canRemove?: boolean;
+        unRemovableIndexes?: number[];
+        onBeforeAdd?: (data: any, formMethods: any) => void | Promise<void>;
+        onBeforeRemove?: (data: any, formMethods: any) => void | Promise<void>;
+    };
+};
+
+export declare type FieldDependency = {
+    ref: string;
+    operand?: Operand;
+    operator: Operator;
+    valueMap: Record<string, FieldValueType>;
+};
+
+export declare type FieldOption = {
+    label: string;
+    value: string | number;
+    disabled?: boolean;
+    selected?: boolean;
+};
+
+export declare type FieldOptionFetch = {
+    url: string;
+    method?: "GET" | "POST" | "PUT" | "DELETE";
+    headers?: Record<string, string>;
+    params?: Record<string, string | number>;
+    body?: Record<string, any>;
+    transform?: (data: any) => FieldOption[];
+};
+
+export declare type FieldOptionFetchFunction = () => Promise<FieldOption[]>;
+
+export declare type FieldSize = 'small' | 'medium';
+
+export declare type FieldType = "text" | "phone" | "number" | "slider" | "select" | "checkbox-group" | "radio-group" | "checkbox" | "switch" | "date" | "time" | "datetime" | "file" | "repeater" | "field-array";
+
+export declare type FieldValueType = string | number | boolean | Date | File | (string | undefined)[] | ({
+    [x: string]: any;
+} | undefined)[] | null | undefined;
+
+export declare type FieldVariant = "outlined" | "filled" | "standard";
+
+export declare type FileFieldConfig = BaseFieldConfig & {
+    type: "file";
+    meta: BaseFieldConfig["meta"] & {
+        variant?: FileFieldVariant;
+        acceptExtensions?: string[] | string;
+        multiple?: boolean;
+        minSize?: number;
+        maxSize?: number;
+        minFiles?: number;
+        maxFiles?: number;
+        fileSizeErrorMessage?: string;
+        fileTypeErrorMessage?: string;
+        uploadErrorMessage?: string;
+        uploadBtnText?: string;
+        dragText?: string;
+        dropText?: string;
+        enablePreview?: boolean;
+        avatarIcon?: string;
+        uploadCb?: (files: File[]) => Promise<string>;
+        uploadApi?: {
+            url: string;
+            method?: "GET" | "POST" | "PUT" | "DELETE";
+            headers?: Record<string, string>;
+            extraArgs?: Record<string, any>;
+            uploadType?: "multipart/form-data" | "base64";
+            requestKey?: string;
+            responseKey?: string;
+        };
+    };
+};
+
+export declare type FileFieldVariant = "default" | "dropzone" | "avatar";
+
+export declare type GridColumnConfig = {
+    xs?: GridSize;
+    sm?: GridSize;
+    md?: GridSize;
+    lg?: GridSize;
+    xl?: GridSize;
+};
+
+export declare type GridSize = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+
+export declare type HelperTextConfig = {
+    content?: string | React.ReactNode;
+    color?: BaseColors | string;
+};
+
+export declare type InputRestriction = "alpha" | "alphanumeric" | "numeric" | "alpha-with-spaces" | "alphanumeric-with-spaces" | "numeric-with-spaces" | RegExp;
+
+export declare type ModalSize = "small" | "medium" | "large" | "full";
+
+export declare const Namozaj: default_2.ForwardRefExoticComponent<DynamicFormProps & default_2.RefAttributes<any>>;
+
+export declare type NumberFieldConfig = BaseFieldConfig & {
+    type: "number";
+    meta: BaseFieldConfig["meta"] & {
+        variant?: FieldVariant;
+        size?: FieldSize;
+        startAdornment?: React.ReactNode | string;
+        endAdornment?: React.ReactNode | string;
+        min?: number;
+        max?: number;
+        step?: number;
+    };
+};
+
+export declare type Operand = "OR" | "AND";
+
+export declare type Operator = "=" | "!=" | ">" | "<" | ">=" | "<=" | "in" | "not-in" | "contains" | "not-contains" | "match" | "not-match" | "between" | "starts-with" | "not-starts-with";
+
+export declare type PhoneFieldConfig = BaseFieldConfig & {
+    type: "phone";
+    meta: BaseFieldConfig["meta"] & {
+        variant?: FieldVariant;
+        size?: FieldSize;
+        defaultCountry?: string;
+        hideDropdown?: boolean;
+        maxLength?: number;
+        minLength?: number;
+        seperateCountryCode?: boolean;
+    };
+};
+
+export declare type RadioGroupFieldConfig = BaseFieldConfig & {
+    type: "radio-group";
+    meta: BaseFieldConfig["meta"] & {
+        horizontal?: boolean;
+        options?: FieldOption[];
+        optionsFetch?: FieldOptionFetch;
+        optionsFetchFnc?: FieldOptionFetchFunction;
+    };
+};
+
+export declare type RepeaterFieldConfig = BaseFieldConfig & {
+    type: "repeater";
+    meta: BaseFieldConfig["meta"] & {
+        fields: DynamicFormField[];
+        minEntries?: number;
+        maxEntries?: number;
+        inline?: boolean;
+        addEditModalTitle?: string;
+        removeDialogTitle?: string;
+        removeDialogDescription?: string;
+        cancelBtn?: string | React.ReactNode;
+        saveBtn?: string | React.ReactNode;
+        addBtn?: string | React.ReactNode;
+        editBtn?: string | React.ReactNode;
+        removeBtn?: string | React.ReactNode;
+        canAdd?: boolean;
+        canEdit?: boolean;
+        canRemove?: boolean;
+        unEditableIndexes?: number[];
+        unRemovableIndexes?: number[];
+        emptyMessage?: string;
+        defaultValues?: Record<string, FieldValueType>[];
+        onBeforeAdd?: (data: any, formMethods: any) => void | Promise<void>;
+        onBeforeEdit?: (data: any, formMethods: any) => void | Promise<void>;
+        onBeforeRemove?: (data: any, formMethods: any) => void | Promise<void>;
+    };
+};
+
+export declare type SectionFieldConfig = BaseFieldConfig & {
+    type: "section";
+    meta: BaseFieldConfig["meta"] & {
+        fields: DynamicFormField[];
+        collapsible?: boolean;
+        collapsed?: boolean;
+    };
+};
+
+export declare type SelectFieldConfig = BaseFieldConfig & {
+    type: "select";
+    meta: BaseFieldConfig["meta"] & {
+        options?: FieldOption[];
+        optionsFetch?: FieldOptionFetch;
+        optionsFetchFnc?: FieldOptionFetchFunction;
+        multiple?: boolean;
+        searchable?: boolean;
+        creatable?: boolean;
+        clearable?: boolean;
+    };
+};
+
+export declare type SliderFieldConfig = BaseFieldConfig & {
+    type: "slider";
+    meta: BaseFieldConfig["meta"] & {
+        size?: FieldSize;
+        min?: number;
+        max?: number;
+        step?: number | null;
+        marks?: boolean | {
+            value: number;
+            label: string;
+        }[];
+        labelAlwaysVisible?: boolean;
+        thumbStyle?: React.CSSProperties;
+        trackStyle?: React.CSSProperties;
+        railStyle?: React.CSSProperties;
+        valueLabelStyle?: React.CSSProperties;
+    };
+};
+
+export declare type SwitchFieldConfig = BaseFieldConfig & {
+    type: "switch";
+    meta: BaseFieldConfig["meta"] & {
+        checked?: boolean;
+    };
+};
+
+export declare type TextFieldConfig = BaseFieldConfig & {
+    type: "text";
+    meta: BaseFieldConfig["meta"] & {
+        variant?: FieldVariant;
+        size?: FieldSize;
+        maxLength?: number;
+        minLength?: number;
+        secured?: boolean;
+        multiline?: boolean;
+        rows?: number;
+        startAdornment?: React.ReactNode | string;
+        endAdornment?: React.ReactNode | string;
+        inputRestriction?: InputRestriction;
+    };
+};
+
+export declare type TooltipConfig = {
+    text?: string;
+    placement?: TooltipPlacement;
+};
+
+export declare type TooltipPlacement = AutoPlacement | BasePlacement | VariationPlacement;
+
+export declare type ValidationMode = "onChange" | "onBlur" | "onTouched" | "onSubmit" | "all";
+
+export declare type ValidationRule = {
+    type: "required" | "pattern" | "minLength" | "maxLength" | "min" | "max" | "email" | "phone" | "url" | "between";
+    value?: FieldValueType;
+    when?: {
+        field: string;
+        operator: Operator;
+        value: FieldValueType;
+    };
+    errorMessage?: string;
+};
+
+export declare type VariationPlacement = "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end";
+
+export declare type VisibilityRule = {
+    type: VisibilityRuleType;
+    ref: string;
+    operand?: Operand;
+    operator: Operator;
+    value: FieldValueType;
+};
+
+export declare type VisibilityRuleType = "show" | "hide";
+
+export { }