@isi-ui7/bos7-shared 0.2.0

package/dist/form-types.d.ts

@@ -0,0 +1,130 @@
+import { ReactNode } from 'react';
+import { Ui7FormDensity } from './style-contract';
+import { T_LookupTblStruct } from '@isi-ui7/lookup-input';
+
+export type FormMode = "create" | "edit" | "view";
+export type ApiPath = string | ((params: Record<string, string>) => string);
+/** Per-field validator function — same signature used by Rules.* and FieldValidation.validators[]. */
+export type FieldValidatorFn<TData = Record<string, unknown>> = (value: unknown, data: TData) => string | undefined;
+export type FieldValidation<TData extends Record<string, unknown>> = {
+    required?: true | string;
+    minLength?: number | [number, string];
+    maxLength?: number | [number, string];
+    min?: number | [number, string];
+    max?: number | [number, string];
+    pattern?: RegExp | [RegExp, string];
+    /** Single custom validator (kept for backward compatibility). */
+    custom?: FieldValidatorFn<TData>;
+    /** Array of validators — compose Rules.* or custom functions. Runs after built-in rules. */
+    validators?: FieldValidatorFn<TData>[];
+};
+export type FormFieldType = "text" | "textarea" | "number" | "date" | "select" | "lookup" | "checkbox" | "toggle";
+export type FormFieldOption = {
+    value: string;
+    label: string;
+};
+export type FormFieldLookupConfig<TData extends Record<string, unknown>> = {
+    lookupAPI: string;
+    lookupDataStructure: Record<string, T_LookupTblStruct>;
+    lookupFieldTitles: Record<string, string>;
+    displayFieldNames: string[];
+    popupWidthPx?: number;
+    placeholder?: string;
+    dataSource?: "api" | "direct";
+    /** Return a patch to merge into the form when a lookup row is selected. */
+    onDataPatch?: (row: Record<string, unknown>, data: TData) => Partial<TData>;
+};
+export type FormFieldNumericConfig<TData extends Record<string, unknown>> = {
+    kind: "currency";
+    currencyField: keyof TData;
+    precisionByCurrency: Record<string, number>;
+    defaultPrecision?: number;
+} | {
+    kind: "percent";
+    maxFractionDigits: number;
+} | {
+    kind: "integer";
+} | {
+    kind: "phone";
+    minDigits: number;
+    maxDigits: number;
+    allowedPrefixes?: string[];
+};
+export type FormField<TData extends Record<string, unknown>> = {
+    key: keyof TData;
+    label: ReactNode;
+    type: FormFieldType;
+    span?: number;
+    /** Static or dynamic readonly. Function receives current mode + form data. */
+    readonly?: boolean | ((mode: FormMode, data: TData) => boolean);
+    /** Static or dynamic visibility. Hidden fields are skipped in validation. */
+    hidden?: boolean | ((mode: FormMode, data: TData) => boolean);
+    /** Restrict to specific modes (undefined = all modes). */
+    mode?: FormMode | FormMode[];
+    helperText?: ReactNode;
+    placeholder?: string;
+    maxLength?: number;
+    rows?: number;
+    inputMode?: "text" | "numeric" | "decimal" | "email" | "tel" | "url";
+    options?: FormFieldOption[];
+    lookup?: FormFieldLookupConfig<TData>;
+    numeric?: FormFieldNumericConfig<TData>;
+    format?: (value: TData[keyof TData], data: TData) => ReactNode;
+    validation?: FieldValidation<TData>;
+};
+export type FormSection<TData extends Record<string, unknown>> = {
+    title?: ReactNode;
+    description?: ReactNode;
+    /** Number of equal columns in the section grid. Default 1. */
+    columns?: 1 | 2 | 3;
+    fields: FormField<TData>[];
+};
+export type FormPageDef<TData extends Record<string, unknown>> = {
+    label: string;
+    sections: FormSection<TData>[];
+    /** Optional: save draft on Next. Returns {ok,error?} (no 202 required). */
+    stepSaveApiPath?: ApiPath;
+};
+export type FormLayout<TData extends Record<string, unknown>> = {
+    type: "single-page";
+    sections: FormSection<TData>[];
+} | {
+    type: "tabs";
+    pages: FormPageDef<TData>[];
+} | {
+    type: "wizard";
+    pages: FormPageDef<TData>[];
+    validateOnNext?: boolean;
+};
+export type CrudForm<TData extends Record<string, unknown>> = {
+    title: {
+        create: string;
+        edit: string;
+        view: string;
+    };
+    subtitle?: string | {
+        create: string;
+        edit: string;
+        view: string;
+    };
+    /** Omit entirely to use i18n defaults ("Simpan" / "Update"). Per-key also optional. */
+    submitLabel?: {
+        create?: string;
+        edit?: string;
+    };
+    /** Omit to use i18n default ("Batal"). */
+    backLabel?: {
+        view?: string;
+        others?: string;
+    };
+    /** Form layout density. Defaults to "compact". */
+    density?: Ui7FormDensity;
+    emptyData: TData;
+    createApiPath: ApiPath;
+    updateApiPath?: ApiPath;
+    /** Required for edit + view modes. */
+    loadApiPath?: ApiPath;
+    /** Cross-field validation run after per-field rules. */
+    validate?: (data: TData) => Partial<Record<keyof TData, string>>;
+    layout: FormLayout<TData>;
+};