@wix/patterns 1.468.0 → 1.469.0

package/dist/dts-bundle/types/EntityPageState.d.ts

@@ -1,6 +1,5 @@
 import { EventEmitter } from 'events';
 import { ReportProps } from '@wix/fe-essentials/bi';
-import { ComponentType, ReactNode, ReactElement, MutableRefObject } from 'react';
 import { cairoPageCtaClickedParams } from '@wix/bex-utils/@wix/bi-logger-os-data/v2/types';
 import { PatternsFieldsAppContainer } from '@wix/patterns-fields/providers';
 import { FieldValues, UseFormReturn } from 'react-hook-form';
@@ -88,7 +87,7 @@ type Field = ReferenceField | MultiReferenceField | NonReferenceField;
 
 /**
  * `OffsetQuery` — cut here because it has its own bundle.
- * Look `OffsetQuery` up in the bundle index for its full shape.
+ * Full shape: `types/OffsetQuery.d.ts`.
  */
 type OffsetQuery<F = any> = Omit<ComputedQuery<F>, 'cursor'>;
 type OffsetQueryResult<T> = Omit<DataResultRaw<T>, 'cursor'>;
@@ -97,7 +96,7 @@ type CursorQueryResult<T> = Omit<DataResultRaw<T>, 'cursor'> & {
 };
 /**
  * `CursorQuery` — cut here because it has its own bundle.
- * Look `CursorQuery` up in the bundle index for its full shape.
+ * Full shape: `types/CursorQuery.d.ts`.
  */
 type CursorQuery<F = any> = Omit<ComputedQuery<F>, 'offset'>;
 type FetchTotalFn = (query: CursorQuery) => Promise<number>;
@@ -251,481 +250,13 @@ interface LoadedSchema<T = Record<string, unknown>> {
     fieldActions?: FieldActions;
 }
 
-/** Read/write permission defaults a source supports, per audience. */
-interface FieldPermissions {
-    installedApps?: {
-        hide?: boolean;
-        defaultRead?: boolean;
-        defaultWrite?: boolean;
-    };
-    siteVisitors?: {
-        hide?: boolean;
-        defaultRead?: boolean;
-        defaultWrite?: boolean;
-    };
-}
-/** The add-modal subtitle: a line of text, an optional second note line, and an
- *  optional "learn more" link. */
-interface FieldModalSubtitle {
-    text: string;
-    note?: string;
-    learnMore?: {
-        label: string;
-        href: string;
-    };
-}
-/** The text a source supplies for the add/edit field modal. */
-interface FieldModalText {
-    addTitle: string;
-    editTitle: string;
-    /** Subtitle for the add modal; omit for none. */
-    addSubtitle?: FieldModalSubtitle;
-    /** Label of the collapsible section below the main fields. */
-    settingsLabel?: string;
-}
-/** A warning shown under the PII toggle, with an optional action button. */
-interface FieldPiiWarning {
-    text: string;
-    action?: {
-        label: string;
-        onClick: () => void;
-    };
-}
-interface FieldModalCollectionOption {
-    id: string;
-    label: string;
-}
-type FieldModalCollectionOptionsLoader = () => Promise<FieldModalCollectionOption[]>;
-/** Extra collection picker a field type can add to the main modal body. */
-interface FieldModalCollectionInput {
-    label?: string;
-    placeholder?: string;
-    emptyStateMessage?: string;
-    errorMessage?: string;
-    required?: boolean;
-    loadOptions?: FieldModalCollectionOptionsLoader;
-    /** Restores the picker value from an existing field. */
-    getValue?: (field: Field) => string | undefined;
-    /** Adds picker-derived values to the source-owned settings payload. */
-    getSettings?: (collectionId: string) => FieldSettings;
-}
-interface FieldSettingsProps {
-    /** The picked field type, or absent before one is picked. */
-    fieldType?: string;
-    /** Validation rules the section should render as fixed, not user-editable.
-     *  A section ignores any entry it doesn't recognize. */
-    lockedRules?: readonly string[];
-}
-/**
- * The collapsible section below the main add/edit field inputs, supplied by the
- * source. The modal renders it, blocks confirm while it has an error, and hands
- * its values to the source's own `addField`/`editField` — it never looks inside.
- */
-interface FieldSettingsSection {
-    Component: ComponentType<FieldSettingsProps>;
-    /** True keeps the modal open on confirm. The section shows the error itself. */
-    hasError(fieldType?: string): boolean;
-    /** Passed to `FieldActions.addField`/`editField` as-is. */
-    getValues(fieldType?: string): FieldSettings;
-    /**
-     * Fills the inputs when the modal opens: the field being edited, or nothing
-     * for a new field. Pushed in rather than read from a prop, so the values are
-     * there whether or not the section has been rendered yet.
-     */
-    setValues(field?: Field): void;
-    /**
-     * Prefills a new field's rules from the caller's requested initial values —
-     * there is no backing `Field` yet, so this is separate from `setValues`.
-     * Absent ⇒ the section doesn't support prefilling any rule this way, and
-     * the modal drops that rule from `lockedProperties` rather than locking a
-     * control at a value it could never actually apply.
-     */
-    setInitialValues?(initial: {
-        required?: boolean;
-    }): void;
-}
-
-type ValidationRule = {
-    type: 'required';
-    message: string;
-} | {
-    type: 'min' | 'max';
-    value: number;
-    message: string;
-} | {
-    type: 'minLength' | 'maxLength';
-    value: number;
-    message: string;
-} | {
-    type: 'pattern';
-    value: RegExp;
-    message: string;
-} | {
-    type: 'custom';
-    validate: (value: unknown) => boolean;
-    message: string;
-} | {
-    type: 'specificValues';
-    values: {
-        id: string;
-        value: string;
-    }[];
-    message: string;
-};
-interface Focusable {
-    focus: () => void;
-}
-type EditTrigger = {
-    kind: 'type';
-    key: string;
-} | 'enter' | 'click' | 'doubleClick';
-interface CellViewProps<V> {
-    value: V;
-    typeConfig?: unknown;
-    validation?: ValidationRule[];
-    /** Stable id of the column. Cell components can use it to derive unique DOM ids. */
-    columnId: string;
-    /** Stable key of the row. Cell components can use it to derive unique DOM ids. */
-    rowKey: string;
-}
-interface CellEditProps<V> {
-    value: V;
-    onChange(value: V): void;
-    onCommit: () => void;
-    onCancel: () => void;
-    /**
-     * Signals that the cell is starting an editing operation that will move focus
-     * outside the table (e.g., opening a media manager or a modal). Calling this
-     * sets isEditing=true so the table does not clear cell focus while the
-     * external UI is open. Pair with onCommit (after the operation succeeds)
-     * or onCancel (if the user dismisses without a value change).
-     */
-    onStartEdit?: () => void;
-    /** Ref to the focusable input element. Used for type-to-edit (focusing the input when user starts typing on a focused cell). */
-    inputRef?: MutableRefObject<Focusable | undefined | null>;
-    typeConfig?: unknown;
-    /** How edit mode was triggered. Edit components can use this to customize behavior (e.g., date picker auto-opens on 'type'). */
-    editTrigger?: EditTrigger | null;
-    /** Column-level validation rules. Edit components can derive UI behavior (e.g., maxLength blocking/tooltip) from these. */
-    validation?: ValidationRule[];
-    /** Stable id of the column. Cell components can use it to derive unique DOM ids. */
-    columnId: string;
-    /** Stable key of the row. Cell components can use it to derive unique DOM ids. */
-    rowKey: string;
-}
-/**
- * Props passed to a cell type's optional `EditWrapper`. The table mounts the
- * wrapper around the cell content and keeps it mounted across the edit↔view
- * transition, so the wrapper can own behavior that must outlive the inline
- * editor (e.g. a reference cell navigating to an overlay and refreshing on
- * return). The wrapper hands anything the editor needs down via its own context.
- */
-interface CellEditWrapperProps {
-    /** The column's typeConfig (same value handed to the cell's Edit/View). */
-    typeConfig?: unknown;
-    /** Stable id of the column. */
-    columnId: string;
-    /** Stable key of the row. */
-    rowKey: string;
-    /** The cell content (the Edit or View component) to render inside the wrapper. */
-    children: ReactNode;
-}
-type EditableCellContextMenuAction = 'copy' | 'cut' | 'paste' | 'clear';
-interface EditableCellContextMenuActionContext<V> {
-    /** Current cell value, including pending or draft edits. */
-    value: V;
-    /** Field metadata associated with the column, when available. */
-    field?: Field;
-    /** Stable key of the row. */
-    rowKey: string;
-    /** Stable id of the column. */
-    columnId: string;
-}
-interface EditableCellContextMenuActionConfig<V> {
-    /** Returning a non-empty string disables the action and shows the tooltip. */
-    disabledTooltip(context: EditableCellContextMenuActionContext<V>): string | undefined;
-}
-/**
- * The editable-cell slot of a field type definition: how a cell of that type
- * renders, edits, and moves through the clipboard. The definition's key
- * identifies the type and the definition's `value` owns validation, so the
- * slot carries neither.
- *
- * Members that take `V` use method syntax so a definition typed with a
- * concrete value type stays assignable where a loosely typed definition is
- * expected (see `FieldTypeDefinition`).
- */
-interface EditableCellConfig<V> {
-    /** Render cell in view mode (read-only display). */
-    ViewComponent(props: CellViewProps<V>): ReactElement | null;
-    /** Render cell in edit mode (inline editor). Optional — omit for view-only cells. */
-    EditComponent?(props: CellEditProps<V>): ReactElement | null;
-    /** Serialize value to clipboard string. */
-    serialize?(value: V): string;
-    /** Deserialize clipboard string to value. */
-    deserialize?(raw: string): V;
-    /** Can this cell type be edited? (default: true) */
-    editable?: boolean;
-    /** Availability of Cairo's built-in cell context-menu actions. */
-    contextMenu?: Partial<Record<EditableCellContextMenuAction, EditableCellContextMenuActionConfig<V>>>;
-    /** Toggle value on single click (e.g., boolean checkbox). Skips focus→edit flow. */
-    toggleValue?(value: V): V;
-    /** Enter edit mode on single click (e.g., image cell with no value). */
-    editOnClick?(value: V): boolean;
-    /** Show the EditComponent when the cell is focused, without entering edit mode.
-     *  Keyboard navigation remains active. Similar to toggleValue but without toggling. */
-    showEditWhenFocused?: boolean;
-    /** Optional wrapper component the cell type defines to own behavior that must
-     *  outlive the inline editor. Mounted around the cell content and kept mounted
-     *  across the edit↔view transition. */
-    EditWrapper?: ComponentType<CellEditWrapperProps>;
-    /** Cell content can grow past row height when focused. Only applies to
-     *  showEditWhenFocused cells. */
-    growable?: boolean;
-    /** Called on type-to-edit. Return object with cleared value and/or prevent flag.
-     *  Return undefined to block the key. Return {} to enter edit mode without changing the value. */
-    onTypeToEdit?(params: {
-        key: string;
-        validation?: ValidationRule[];
-    }): {
-        value?: V;
-    } | undefined;
-    /** Optional hook to normalize the committed value (e.g. auto-prepend https://).
-     *  Called before the edit commits; the value is written back before committing. */
-    normalizeOnCommit?(value: V): V;
-    /** When true, type-to-edit flushes the edit-mode render synchronously and
-     *  focuses the input within the same keydown event, then lets the browser's
-     *  default action deliver the keystroke to the now-focused input naturally.
-     *  Use for cells that wrap a controlled input whose value can't be seeded via props. */
-    nativeTypeToEdit?: boolean;
-}
-/** The props the filter builder passes to a definition's toolbar filter
- *  component — the same contract the built-in filter elements receive. */
-interface FilterTypeComponentProps<V = any> {
-    filter: Filter<V>;
-    toolbarItemProps?: {
-        label?: ReactNode;
-    };
-    toolbarTagProps?: {
-        label?: string;
-    };
-    accordionItemProps?: {
-        label?: string;
-    };
-}
-/** The filter slot of a field type definition: the filter state registered on
- *  the collection query and the toolbar element that renders it. */
-interface FilterTypeConfig {
-    createFilter: (field: Field) => Filter<any>;
-    Component: ComponentType<FilterTypeComponentProps>;
-}
-/**
- * The read-only table slot of a field type definition: how a cell of that
- * type renders in the table, and the column's layout. Independent of
- * `editableTable` — neither slot falls back to the other.
- */
-/** What a read-only table cell is told about itself. */
-interface TableCellProps<V> {
-    value: V;
-    /** Stable id of the column. Cell components can use it to derive unique DOM ids. */
-    columnId: string;
-    /** The row this cell belongs to, so a cell can act on its item and not just
-     *  display it. Typed loosely for the same reason as `FieldsSource.getCellValue`:
-     *  the row shape belongs to the source, not to Cairo. */
-    row: unknown;
-}
-interface TableCellConfig<V> {
-    /** Render the cell. Method syntax keeps the definition assignable to
-     *  `FieldTypeDefinition<unknown>` (see FieldTypeDefinition). */
-    CellComponent(props: TableCellProps<V>): ReactElement | null;
-    /** Column width. Required — custom types get no built-in layout default. */
-    width: string;
-    /** Default: 'start'. */
-    align?: 'start' | 'center' | 'end';
-}
-/** An extra menu item a field type definition adds to a field's actions menu. */
-interface FieldTypeActionItem {
-    key: string;
-    label: string;
-    icon?: ReactNode;
-    skin?: 'destructive';
-    onClick: (field: Field) => void;
-    /** Default: visible. */
-    visible?: (field: Field) => boolean;
-    /** Returning a string disables the item and shows the tooltip. */
-    disabledTooltip?: (field: Field) => string | undefined;
-}
-/** The actions slot of a field type definition: extra items for the field's "more actions" menu. */
-interface FieldActionsConfig {
-    items?: FieldTypeActionItem[];
-}
-/** Display metadata for a field type: menu label and type icons. */
-interface FieldTypeDisplay {
-    label: string;
-    icons: {
-        Small: ComponentType;
-        Medium: ComponentType;
-    };
-}
-/** Value semantics of a field type, independent of any rendering surface.
- *  Members use method syntax so a definition typed with a concrete value type
- *  stays assignable where a loosely typed definition is expected. */
-interface FieldValueBehavior<V> {
-    defaultValue?: V;
-    isEmpty?(value: V): boolean;
-    /** Returns an error message, or null when the value is valid. Every surface
-     *  that validates a field of this type runs this. */
-    validate?(value: V, rules?: ValidationRule[]): string | null;
-}
-interface FieldCapabilities {
-    sortable: boolean;
-}
-/** The field-modal slot of a field type definition: opts the type into the
- *  add/edit-field modal's type picker and describes its entry there. */
-interface FieldModalConfig {
-    /** True ⇒ the add-field modal offers this type. */
-    creatable: boolean;
-    /** Placeholder for the name input. Absent ⇒ the modal's generic placeholder. */
-    namePlaceholder?: string;
-    /** One-line description under the type in the picker. */
-    subtitle?: string;
-    /** Group heading this type is listed under in the picker. */
-    group?: string;
-    /** Whether a field of this type can be marked PII. Absent ⇒ follows the
-     *  source-wide setting. */
-    supportsPii?: boolean;
-    /** Warning shown while the PII toggle is on. Read on every render, so it can
-     *  use data that only exists once the schema has loaded. Default: none. */
-    piiWarning?: () => FieldPiiWarning | undefined;
-    /** This type's collapsible settings section — the same contract a
-     *  source-declared type option carries (see `FieldSettingsSection`). */
-    settingsSection?: FieldSettingsSection;
-    /** Collection picker shown in the main add/edit field form. */
-    collectionInput?: FieldModalCollectionInput;
-}
-/**
- * Props the entity-page form dispatcher passes to a field type's form
- * component. The dispatcher owns the form wiring (registration, validation
- * from the definition's `value.validate`) and the field UI (label, required
- * marker, error message); the component renders the input: read `value`,
- * report edits through `onChange`, and hand back the focusable control
- * through `inputRef` so a blocked save can reach it.
- */
-interface FormFieldComponentProps<V> {
-    field: Field;
-    value: V;
-    onChange(value: V): void;
-    /** Call when the input loses focus — marks the field touched, so error
-     *  timing matches the built-in renderers. */
-    onBlur: () => void;
-    /** Ref to the focusable input element. Used to focus the field when a
-     *  blocked save reports an error on it. Absent ⇒ the entity page brings the
-     *  field into view and focuses the first control it finds inside. */
-    inputRef?: MutableRefObject<Focusable | undefined | null>;
-    dataHook?: string;
-}
-/** The entity-page form slot of a field type definition. */
-interface FormTypeConfig<V = unknown> {
-    /** Renders the input. Method syntax keeps the definition assignable to
-     *  `FieldTypeDefinition<unknown>` (see FieldTypeDefinition). */
-    Component(props: FormFieldComponentProps<V>): ReactElement | null;
-}
+/** The resolved source: defaults filled, `loadSchema` memoized. */
 /**
- * A consumer-defined field type. Defined once on the fields source; every
- * entry point that renders the field resolves its slot from here. `V` is the
- * field's value type — `defineFieldType` infers it, and it keeps all the
- * slots consistent with each other.
- *
- * Sources hold definitions of mixed value types in one
- * `FieldTypeDefinition[]` (= `FieldTypeDefinition<unknown>[]`) array. That
- * works because every member that takes `V` is declared with method syntax,
- * which TypeScript checks bivariantly — so `FieldTypeDefinition<number>` is
- * assignable to `FieldTypeDefinition<unknown>` without casts.
+ * `SchemaSource` — cut here because it has its own bundle.
+ * Full shape: `types/SchemaSource.d.ts`.
  */
-interface FieldTypeDefinition<V = unknown> {
-    /** Unique key for the type. A built-in type uses its `PatternsFieldType`; a
-     *  consumer-defined type uses the string its fields reference via `customType`. */
-    type: string;
-    display: FieldTypeDisplay;
-    /** Filter behavior, or an explicit opt-out — never silently absent. */
-    filter: FilterTypeConfig | {
-        filterable: false;
-    };
-    value?: FieldValueBehavior<V>;
-    capabilities?: FieldCapabilities;
-    /** Absent ⇒ the field renders with the default cell in the read-only table. */
-    table?: TableCellConfig<V>;
-    /** Absent ⇒ the field renders as a read-only cell in editable surfaces. */
-    editableTable?: EditableCellConfig<V>;
-    /** Required once a field of this type renders on an entity page:
-     *  development throws without it; production skips the field. */
-    form?: FormTypeConfig<V>;
-    /** Extra items for the field's "more actions" menu. */
-    actions?: FieldActionsConfig;
-    /** Absent ⇒ the add/edit field modal never offers this type. Fields of the
-     *  type created elsewhere still open in the modal for name/PII edits. */
-    fieldModal?: FieldModalConfig;
-}
-
-/** A field type the add/edit field modal offers, with everything that type
- *  brings to it. Declare one entry per `patternsType` — the type is the entry's
- *  identity. Nothing here reaches the table or the filters; that is `fieldTypes`
- *  (`FieldTypeDefinition[]`). */
-interface FieldTypeOption {
-    patternsType: PatternsFieldType;
-    /** Custom display name. Absent ⇒ the UI's standard name for this type. */
-    label?: string;
-    /** Custom name-input placeholder. Absent ⇒ the UI's standard placeholder. */
-    namePlaceholder?: string;
-    /** A one-line description shown under the type in the add-field menu. */
-    subtitle?: string;
-    /** The group heading this type is listed under in the add-field menu, in
-     *  first-seen order. Types sharing a heading form one group. Absent ⇒
-     *  ungrouped. */
-    group?: string;
-    /** Whether a field of this type can be marked PII. Absent ⇒ follows the
-     *  source's `supportsPii`. */
-    supportsPii?: boolean;
-    /** Warning shown while the PII toggle is on. Read on every render, so it can
-     *  use data that only exists once the schema has loaded. Default: none. */
-    piiWarning?: () => FieldPiiWarning | undefined;
-    /** This type's own part of the collapsible section in the add/edit field
-     *  modal. Default: none. */
-    settingsSection?: FieldSettingsSection;
-    /** Collection picker shown in the main add/edit field form. */
-    collectionInput?: FieldModalCollectionInput;
-}
-/** The resolved source: defaults filled, `loadSchema` memoized. */
-interface SchemaSource<T> {
-    readonly collectionId: string;
-    loadSchema: () => Promise<LoadedSchema<T>>;
-    readonly paginationMode: 'offset';
-    /** Stable row identity. */
-    itemKey: (item: T) => string;
-    /** Row display label. */
-    itemName: (item: T) => string;
-    /** Sources for referenced collections, keyed by referenced collection id. */
-    readonly references: Record<string, SchemaSource<any>>;
-    getReferencedCollectionSource?: (collectionId: string) => SchemaSource<any> | undefined;
-    readonly fieldModal: {
-        text?: FieldModalText;
-        loadReferenceableCollectionOptions?: FieldModalCollectionOptionsLoader;
-        types: FieldTypeOption[];
-    };
-    readonly fieldTypes: FieldTypeDefinition[];
-    searchableFieldIds: (schema: Schema) => string[];
-    canAddFields: (schema: Schema) => boolean;
-    canEditField: (field: Field, schema: Schema) => boolean;
-    canDeleteField: (field: Field, schema: Schema) => boolean;
-    readonly fieldPermissions?: FieldPermissions;
-    readonly supportsPii: boolean;
-    /** The value of a field on an item. */
-    getFieldValue: (item: T, field: Field) => unknown;
-    /** Writes a field's value on an item, returning the updated item. */
-    setFieldValue: (item: T, field: Field, value: unknown) => T;
-    /** Replaces the memoized schema returned by later `loadSchema()` calls.
-     *  No-op before the first successful load. */
-    setLoadedSchema?: (schema: Schema) => void;
+interface SchemaSource<T = any> {
+    [key: string]: unknown;
 }
 
 type ToastType = 'STANDARD' | 'PREMIUM' | 'SUCCESS' | 'WARNING' | 'ERROR';
@@ -786,7 +317,7 @@ interface ActionsBarConfig {
 
 /**
  * `Filter` — cut here because it has its own bundle.
- * Look `Filter` up in the bundle index for its full shape.
+ * Full shape: `types/Filter.d.ts`.
  */
 interface Filter<T = any> {
     [key: string]: unknown;
@@ -800,7 +331,7 @@ type OptionalFiltersMap = {
 
 /**
  * `ComputedQuery` — cut here because it has its own bundle.
- * Look `ComputedQuery` up in the bundle index for its full shape.
+ * Full shape: `types/ComputedQuery.d.ts`.
  */
 interface ComputedQuery<F = any> {
     [key: string]: unknown;
@@ -808,7 +339,7 @@ interface ComputedQuery<F = any> {
 
 /**
  * `DataResultRaw` — cut here because it has its own bundle.
- * Look `DataResultRaw` up in the bundle index for its full shape.
+ * Full shape: `types/DataResultRaw.d.ts`.
  */
 interface DataResultRaw<T = any> {
     [key: string]: unknown;
@@ -874,7 +405,7 @@ declare class CustomColumnsEntityPageState {
 
 /**
  * `OnSaveParams` — cut here because it has its own bundle.
- * Look `OnSaveParams` up in the bundle index for its full shape.
+ * Full shape: `types/OnSaveParams.d.ts`.
  */
 type OnSaveParams = Record<string, unknown>;
 interface EntityPageStateParamsBase<T, V extends FieldValues = FieldValues> {
@@ -980,7 +511,7 @@ interface EntityPageStateParamsBase<T, V extends FieldValues = FieldValues> {
 }
 /**
  * `EntityPageStateParams` — cut here because it has its own bundle.
- * Look `EntityPageStateParams` up in the bundle index for its full shape.
+ * Full shape: `types/EntityPageStateParams.d.ts`.
  */
 type EntityPageStateParams<T = any, V = any> = EntityPageStateParamsBase<T, V>;
 interface EntityPageStateInterface {