@object-ui/plugin-form 6.2.3 → 7.1.0

package/dist/deriveMasterDetail.d.ts

@@ -0,0 +1,86 @@
+import { GridColumn } from '@object-ui/fields';
+/** Minimal shape of an object schema as returned by `DataSource.getObjectSchema`. */
+export interface ObjectSchemaLike {
+    name?: string;
+    fields?: Record<string, any>;
+}
+/** Map an ObjectQL field type to a LineItems grid column type. */
+export declare function fieldTypeToColumnType(type: string | undefined): GridColumn['type'];
+/**
+ * Find the field on the child object that points back to the parent — the
+ * master_detail/lookup field whose `reference` is the parent object. Prefer
+ * `master_detail` over `lookup` when both exist.
+ */
+export declare function findRelationshipField(childSchema: ObjectSchemaLike | undefined, parentObjectName: string): string | undefined;
+/**
+ * Default-visible column budget for an auto-derived inline grid. An inline
+ * line-item grid lives in a constrained width (modal / detail card), so we show
+ * a focused set by default and mark the rest `defaultHidden` — they are NOT
+ * dropped: the grid's column chooser reveals them on demand (the mainstream
+ * "personalize columns" pattern; cf. Odoo `optional` / Salesforce column
+ * personalization). Required columns are always visible. Authors can override
+ * with explicit `columns` / `inlineColumns` (no curation), or `maxColumns: 0`.
+ */
+export declare const DEFAULT_MAX_INLINE_COLUMNS = 6;
+/**
+ * Derive editable grid columns from a child object's fields, skipping system /
+ * audit fields, non-editable types, and the back-reference FK to the parent.
+ * Every editable column is returned; those beyond {@link DEFAULT_MAX_INLINE_COLUMNS}
+ * are flagged `defaultHidden` (collapsed into the grid's column chooser, not
+ * dropped). Pass `maxColumns: 0` to flag none.
+ */
+export declare function deriveColumns(childSchema: ObjectSchemaLike | undefined, opts?: {
+    relationshipField?: string;
+    exclude?: string[];
+    maxColumns?: number;
+}): GridColumn[];
+/**
+ * Field names for a child's full "row form" (the per-row expand editor) — every
+ * editable business field, skipping system/audit fields, the back-reference FK,
+ * and computed types. Broader than {@link deriveColumns} (which only returns
+ * grid-friendly types): the form has room for textarea/richtext/file/etc.
+ */
+export declare function deriveFormFields(childSchema: ObjectSchemaLike | undefined, opts?: {
+    relationshipField?: string;
+    exclude?: string[];
+}): string[];
+/** Inline-edit form factor. */
+export type InlineMode = 'grid' | 'form';
+/** Above this many editable business fields, the grid gets cramped → `form`. */
+export declare const SMART_FORM_FIELD_THRESHOLD = 8;
+/**
+ * Resolve the inline-edit form factor for a child collection.
+ *   - explicit `'grid'` / `'form'` win;
+ *   - otherwise (`true` / undefined) pick by the child's shape: a `form` when it
+ *     has rich/form-only fields or more than {@link SMART_FORM_FIELD_THRESHOLD}
+ *     editable business fields, else a `grid`.
+ */
+export declare function resolveInlineMode(childSchema: ObjectSchemaLike | undefined, inlineEdit: boolean | InlineMode | undefined, opts?: {
+    relationshipField?: string;
+}): InlineMode;
+export interface DerivedDetail {
+    childObject: string;
+    relationshipField: string;
+    columns: GridColumn[];
+    /** Field names for the per-row expand form (broader than `columns`). */
+    formFields: string[];
+    /** Inline-edit form factor (grid = editable cells; form = list + per-row form). */
+    mode: InlineMode;
+    /** First numeric column, used as the running-total source when none is set. */
+    amountField?: string;
+    /** Child field holding the line sort position, if any — the grid stamps it on
+     *  drag-reorder so order persists (excluded from the editable columns). */
+    sortField?: string;
+}
+/**
+ * Resolve a child collection's full config (FK + columns) from its object
+ * schema. Throws when no relationship to the parent can be found. The caller
+ * supplies any explicit overrides (relationshipField / columns / amountField),
+ * which win over the derived values.
+ */
+export declare function deriveDetail(childObject: string, childSchema: ObjectSchemaLike | undefined, parentObjectName: string, override?: {
+    relationshipField?: string;
+    columns?: GridColumn[];
+    amountField?: string;
+    inlineEdit?: boolean | InlineMode;
+}): DerivedDetail;

package/dist/fieldGroups.d.ts

@@ -0,0 +1,27 @@
+import { FormField, ObjectFormSection } from '@object-ui/types';
+/** A declared field group on the object metadata. */
+export interface DeclaredFieldGroup {
+    key: string;
+    label?: string;
+    /** Render the group's section header with a collapse toggle. */
+    collapsible?: boolean;
+    /** Start the (collapsible) group collapsed. */
+    collapsed?: boolean;
+}
+/** Read an object's `fieldGroups` into a normalized, well-typed list. */
+export declare function readObjectFieldGroups(input: unknown): DeclaredFieldGroup[];
+/**
+ * Derive form sections from an object's declared `fieldGroups` and each
+ * rendered field's `group`.
+ *
+ * Returns `null` when grouping does not apply — no declared groups, or no
+ * rendered field opts into a declared group — so callers fall back to a flat
+ * form. Sections come back in declared order; fields without a declared group
+ * collect into a trailing untitled section (no `name`/`label`) so they render
+ * as a plain block rather than a card.
+ *
+ * Section `fields` are returned as field *names* (strings) so the result plugs
+ * straight into ObjectForm's existing section-render path, which resolves names
+ * back to generated `FormField`s and applies field-level permissions.
+ */
+export declare function deriveFieldGroupSections(fields: FormField[], fieldGroups: unknown): ObjectFormSection[] | null;

package/dist/index.d.ts

@@ -1,2 +1,26 @@
-export * from './packages/plugin-form/src/index'
-export {}
+import { ObjectForm } from './ObjectForm';
+export { ObjectForm };
+export type { ObjectFormProps } from './ObjectForm';
+export { FormSection } from './FormSection';
+export type { FormSectionProps } from './FormSection';
+export { applyAutoLayout, inferColumns, inferModalSize, isWideFieldType, isAutoGeneratedFieldType, applyAutoColSpan, filterCreateModeFields, filterSystemFields, filterAutoGeneratedFields, } from './autoLayout';
+export { TabbedForm } from './TabbedForm';
+export type { TabbedFormProps, TabbedFormSchema, FormSectionConfig } from './TabbedForm';
+export { WizardForm } from './WizardForm';
+export type { WizardFormProps, WizardFormSchema } from './WizardForm';
+export { SplitForm } from './SplitForm';
+export type { SplitFormProps, SplitFormSchema } from './SplitForm';
+export { DrawerForm } from './DrawerForm';
+export type { DrawerFormProps, DrawerFormSchema } from './DrawerForm';
+export { ModalForm } from './ModalForm';
+export type { ModalFormProps, ModalFormSchema } from './ModalForm';
+export { EmbeddableForm } from './EmbeddableForm';
+export type { EmbeddableFormProps, EmbeddableFormConfig, EmbeddableFormTexts } from './EmbeddableForm';
+export { FormAnalytics } from './FormAnalytics';
+export type { FormAnalyticsProps, FormSubmissionMetric } from './FormAnalytics';
+export { MasterDetailForm } from './MasterDetailForm';
+export type { MasterDetailFormProps, MasterDetailFormSchema, MasterDetailDetailConfig, } from './MasterDetailForm';
+export { LineItemsPanel } from './LineItemsPanel';
+export type { LineItemsPanelSchema } from './LineItemsPanel';
+export { deriveDetail, deriveColumns, deriveFormFields, findRelationshipField, resolveInlineMode } from './deriveMasterDetail';
+export type { DerivedDetail, InlineMode } from './deriveMasterDetail';