@wix/patterns 1.476.0 → 1.478.0

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

@@ -0,0 +1,922 @@
+import { ComponentType, ReactNode, ReactElement, MutableRefObject, FunctionComponent } from 'react';
+import { collections } from '@wix/data';
+import { useTranslation, Trans } from '@wix/fe-essentials/react';
+import { History as History$1 } from 'history';
+import * as lodash from 'lodash';
+import { IObservableArray } from 'mobx';
+import { EventEmitter } from 'events';
+import { Essentials, EssentialsOptions } from '@wix/fe-essentials/core';
+import { ReportProps, LogParams } from '@wix/fe-essentials/bi';
+import { errorHandler } from '@wix/essentials';
+import { QueryCache } from 'react-query/core';
+import { HttpRequestOrHttpRequestFactory, RequestOverrides } from '@wix/fe-essentials/http-client';
+import { SDK } from '@wix/dashboard';
+import { Messages } from '@wix/fe-essentials/i18n';
+
+type Arguments<T> = [T] extends [(...args: infer U) => any] ? U : [T] extends [void] ? [] : [T];
+interface TypedEventEmitter<Events> {
+    addListener<E extends keyof Events>(event: E, listener: Events[E]): this;
+    on<E extends keyof Events>(event: E, listener: Events[E]): this;
+    once<E extends keyof Events>(event: E, listener: Events[E]): this;
+    off<E extends keyof Events>(event: E, listener: Events[E]): this;
+    removeAllListeners<E extends keyof Events>(event?: E): this;
+    removeListener<E extends keyof Events>(event: E, listener: Events[E]): this;
+    emit<E extends keyof Events>(event: E, ...args: Arguments<Events[E]>): boolean;
+    listeners<E extends keyof Events>(event: E): Events[E][];
+}
+type TypedEmitter<Events> = Omit<EventEmitter, keyof TypedEventEmitter<Events>> & TypedEventEmitter<Events>;
+
+interface Environment {
+    readonly language: string;
+    readonly artifactId: string;
+    readonly componentId?: string;
+    readonly componentName?: string;
+    readonly uiLibVersion?: string;
+    readonly providerType?: 'bm' | 'giza' | 'essentials';
+    readonly msid?: string;
+}
+interface EnvironmentBi {
+    readonly artifactId?: string;
+    readonly componentId?: string;
+}
+
+type MonitorLogger = Pick<Essentials['fedopsLogger'], 'interactionStarted' | 'interactionEnded' | 'reportErrorThrownOncePerFlow'>;
+
+interface ErrorMonitor {
+    captureException(exception: unknown): string;
+}
+
+interface OnlineManager {
+    isOnline: () => boolean;
+    subscribe: (listener?: () => unknown) => () => void;
+}
+
+type History = History$1;
+
+interface PartialWindow {
+    readonly location: Pick<Location, 'href'>;
+    readonly matchMedia: Window['matchMedia'];
+    readonly download: (uri: string, saveAs?: string) => void;
+    readonly close: () => void;
+    readonly requestAnimationFrame: Window['requestAnimationFrame'];
+    readonly cancelAnimationFrame: Window['cancelAnimationFrame'];
+}
+
+type PartialLodash = Pick<typeof lodash, 'debounce' | 'throttle'>;
+
+interface FocusManager {
+    isFocused: () => boolean;
+    subscribe: (listener?: () => unknown) => () => void;
+}
+
+interface Experiments {
+    enabled(key: string): boolean;
+    ready(): Promise<any>;
+    get(key: string): any;
+}
+
+interface ModalLayoutProps {
+    title?: string;
+    content?: string;
+    onConfirm?: () => void;
+    onResume?: () => void;
+    onClose?: () => void;
+    onAfterClose?: () => void;
+    primaryButtonText?: string;
+    secondaryButtonText?: string;
+}
+
+/**
+ * `TransitionState` — you receive this, you don't construct it.
+ * An internal state object — reached through another state object, never built directly.
+ */
+declare class TransitionState<T = any> {
+    [key: string]: unknown;
+}
+
+/**
+ * `OptimisticPatch` — you receive this, you don't construct it.
+ * Produced by `prepareItemsToMergeIntoPage()`.
+ */
+declare class OptimisticPatch<T = any> {
+    [key: string]: unknown;
+}
+
+type PatternsFieldType = 'SHORT_TEXT' | 'LONG_TEXT' | 'NUMBER' | 'BOOLEAN' | 'DATE' | 'DATETIME' | 'TIME' | 'URL' | 'ARRAY' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'IMAGE' | 'VIDEO' | 'MEDIA_GALLERY' | 'ADDRESS' | 'RICH_TEXT' | 'DOCUMENT' | 'RICH_CONTENT' | 'MULTI_DOCUMENT' | 'EMAIL' | 'AUDIO' | 'COLOR' | 'CUSTOM' | 'UNKNOWN';
+type QueryOperator = 'CONTAINS' | 'ENDS_WITH' | 'EQ' | 'EXISTS' | 'GT' | 'GTE' | 'HAS_ALL' | 'HAS_SOME' | 'LT' | 'LTE' | 'NE' | 'STARTS_WITH' | 'URLIZED';
+interface NumberRange {
+    min?: number;
+    max?: number;
+}
+interface StringLengthRange {
+    minLength?: number;
+    maxLength?: number;
+}
+interface SpecificValue {
+    id: string;
+    value: string;
+}
+interface BaseField {
+    id: string;
+    displayName: string;
+    isPii?: boolean;
+    helpText?: string;
+    /** Whether this is a system-managed field (not user-created). */
+    isSystem?: boolean;
+    /** The group this field belongs to, when the source groups its fields.
+     *  Absent ⇒ ungrouped. */
+    group?: string;
+    /** Whether this is the collection's primary display field. */
+    isPrimary?: boolean;
+    validation?: {
+        numberRange?: NumberRange;
+        stringLengthRange?: StringLengthRange;
+        specificValues?: SpecificValue[];
+        /** Regular expression source the value must match. Applies to text-like
+         *  fields only; mutually exclusive with `specificValues`. */
+        pattern?: string;
+        required: boolean;
+    };
+    capabilities?: {
+        supportedQueryOperators: QueryOperator[];
+        sortable: boolean;
+    };
+}
+interface BaseReferenceField extends BaseField {
+    referenceMetadata: {
+        referencedCollectionId: string;
+    };
+}
+interface ReferenceField extends BaseReferenceField {
+    type: 'REFERENCE';
+}
+interface MultiReferenceField extends BaseReferenceField {
+    type: 'MULTI_REFERENCE';
+}
+interface NonReferenceField extends BaseField {
+    type: Exclude<PatternsFieldType, 'REFERENCE' | 'MULTI_REFERENCE'>;
+    /** Present iff `type` is 'CUSTOM'; keys a field type definition registered on the source. */
+    customType?: string;
+}
+type Field = ReferenceField | MultiReferenceField | NonReferenceField;
+
+/**
+ * Whatever the source's settings section collected in the add/edit field modal.
+ * The modal and the collection layer only carry it; the source that produced it
+ * is the only one that looks inside, so it declares its own shape on `addField`
+ * and `editField` (both are methods, so a narrower parameter type is allowed).
+ */
+type FieldSettings = unknown;
+
+/** 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[]>;
+interface FieldModalCollectionAction {
+    label: string;
+    icon?: ComponentType;
+    disabled?: boolean;
+    /** Return an option to select, or undefined on cancellation. The option may
+     *  be pending creation; persistence remains the source's responsibility. */
+    onClick: () => Promise<FieldModalCollectionOption | undefined>;
+}
+/** 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;
+    /** An action below the options, also shown when no options match. */
+    dropdownAction?: FieldModalCollectionAction;
+    /** 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;
+    /** Whether the cell is editable. Used to conditionally render placeholders (don't show them for read-only cells). */
+    isEditable?: boolean;
+}
+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;
+    /** Optional valid field ID base. Default: the normalized uppercase type ID.
+     *  Numeric suffixes are added only on collision. */
+    keyBase?: 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;
+}
+/**
+ * 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.
+ */
+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;
+}
+
+/** What a caller passes. Only `collectionId` and `loadSchema` are required. */
+/**
+ * `SchemaSourceInput` — cut here because it has its own bundle.
+ * Full shape: `types/SchemaSourceInput.d.ts`.
+ */
+interface SchemaSourceInput<T = any> {
+    [key: string]: unknown;
+}
+/** The resolved source: defaults filled, `loadSchema` memoized. */
+/**
+ * `SchemaSource` — cut here because it has its own bundle.
+ * Full shape: `types/SchemaSource.d.ts`.
+ */
+interface SchemaSource<T = any> {
+    [key: string]: unknown;
+}
+
+type ToastType = 'STANDARD' | 'PREMIUM' | 'SUCCESS' | 'WARNING' | 'ERROR';
+type ToastTimeout = 'NONE' | 'NORMAL';
+type ToastPriority = 'LOW' | 'NORMAL' | 'HIGH';
+type ToastActionUiType = 'BUTTON' | 'LINK';
+type ToastAction = {
+    text: string;
+    onClick?: Function;
+    removeToastOnClick?: boolean;
+    uiType?: ToastActionUiType;
+    navigationTarget?: {
+        url: string;
+        openInNewTab?: boolean;
+    };
+};
+type ErrorToastDetails = {
+    requestId: string;
+};
+type ToastConfig = {
+    message: string;
+    biName?: string;
+    timeout?: ToastTimeout;
+    priority?: ToastPriority;
+    type?: ToastType;
+    onCloseClick?: () => unknown;
+    onToastSeen?: () => unknown;
+    action?: ToastAction;
+    details?: ErrorToastDetails;
+};
+type RemoveToast = () => void;
+type ShowToast = (toastConfig: ToastConfig) => {
+    remove: RemoveToast;
+};
+
+/**
+ * `ConditionalModalState` — you receive this, you don't construct it.
+ * An internal state object — reached through another state object, never built directly.
+ */
+declare class ConditionalModalState<T = any> {
+    [key: string]: unknown;
+}
+
+type PatternsLayoutType = 'panel' | 'page';
+
+type WixPatternsContainerEvents = TypedEmitter<{
+    navigation: () => ModalLayoutProps | null | undefined;
+}>;
+interface WixPatternsContainerParams {
+    readonly initialProps?: WixPatternsInitialProps;
+    readonly createEssentials: WixPatternsEssentials['createEssentials'];
+    readonly biLogger?: WixPatternsEssentials['biLogger'];
+    readonly messagesEnImport?: () => Promise<{}>;
+    readonly fetchTranslations?: (p: {
+        readonly errorMonitor: ErrorMonitor;
+    }) => (locale: string) => Promise<{}>;
+    readonly createComponentSettings?: WixPatternsEssentials['createComponentSettings'];
+    readonly errorMonitor: ErrorMonitor;
+    readonly httpClient: WixPatternsEssentials['httpClient'];
+    readonly onlineManager: OnlineManager;
+    readonly focusManager: FocusManager;
+    readonly contextType?: ContextType;
+    readonly history: History;
+    readonly window: PartialWindow;
+    readonly useTranslation: typeof useTranslation;
+    readonly Trans: typeof Trans;
+    readonly useExperiments: WixPatternsEssentials['useExperiments'];
+    readonly experiments: WixPatternsEssentials['experiments'];
+    readonly environment: WixPatternsEssentials['environment'];
+    readonly environmentBI: WixPatternsEssentials['environmentBI'];
+    readonly errorHandler?: WixPatternsEssentials['errorHandler'];
+    readonly user: WixPatternsEssentials['user'];
+    readonly showToast?: ShowToast;
+    readonly usePageLocation?: WixPatternsEssentials['usePageLocation'];
+    readonly navigateTo?: WixPatternsEssentials['navigateTo'];
+    readonly onNavigation?: OnNavigation;
+    readonly getHostContainer?: GetHostContainer;
+    readonly queryCache: QueryCache;
+    readonly patchesCache: Map<string, IObservableArray<OptimisticPatch<any>>>;
+    readonly onSidePanelOpen?: OnSidePanelOpen;
+    readonly closeSidePanel?: CloseSidePanel;
+    readonly lodash: PartialLodash;
+    readonly events?: WixPatternsContainerEvents;
+    readonly sidePanel?: TransitionState<string>;
+    readonly onNavigationModal?: ConditionalModalState<ModalLayoutProps>;
+    readonly sidePanelComponents?: Map<string, ReactElement>;
+    readonly appendModalsToBody?: boolean;
+    readonly layoutType?: PatternsLayoutType;
+    readonly useRelativeSidePanel?: boolean;
+    readonly onBeforeUnload?: WixPatternsEssentials['onBeforeUnload'];
+    readonly onLayerStateChange?: WixPatternsEssentials['onLayerStateChange'];
+    readonly openMediaManager?: WixPatternsEssentials['openMediaManager'];
+}
+
+interface HttpClient$1 {
+    request<T>(req: HttpRequestOrHttpRequestFactory<T>, overrides?: RequestOverrides): Promise<{
+        data: T;
+        status: number;
+        statusText: string;
+        headers: Record<string, string | undefined>;
+    }>;
+}
+
+/**
+ * `Filter` — cut here because it has its own bundle.
+ * Full shape: `types/Filter.d.ts`.
+ */
+interface Filter<T = any> {
+    [key: string]: unknown;
+}
+
+interface DataCapsule {
+    setItem<T>(key: string, value: T, options?: Record<string, any>): Promise<void>;
+    removeItem(key: string, options?: Record<string, any>): Promise<void>;
+    getItem<T>(key: string): Promise<T>;
+}
+
+type OnSidePanelOpen = (listener: () => void) => {
+    remove(): void;
+};
+type CloseSidePanel = () => unknown;
+interface BiLogger {
+    report(reportProps: ReportProps): Promise<any>;
+}
+interface CairoBILoggerFactory {
+    updateDefaults(params: LogParams): this;
+    logger(): BiLogger;
+}
+type PageLocation = {
+    pageId: string;
+    pathname: string;
+    search?: string;
+    hash?: string;
+};
+type OnNavigationPause = () => {
+    resume(): void;
+};
+type OnNavigationCallback = (pause: OnNavigationPause) => void;
+type OnNavigation = (callback: OnNavigationCallback) => {
+    remove(): void;
+};
+type NavigateToObject = {
+    pageId: string;
+    relativeUrl?: string;
+    appState?: string;
+    referrer?: string;
+    /**
+     * How the target page should be presented. `overlay` opens it as a layer on
+     * top of the current page (e.g. the dashboard overlay). Hosts that don't
+     * support layered navigation ignore this and navigate in place.
+     */
+    displayMode?: 'auto' | 'main' | 'overlay';
+    /** Whether the navigation should push a new history entry or replace the current one. */
+    history?: 'push' | 'replace';
+};
+type NavigateToFunc = (to: NavigateToObject) => void;
+type BeforeUnloadResponse = {
+    remove: () => void;
+};
+type OnBeforeUnload = (callback: (event: Event) => void) => BeforeUnloadResponse;
+/** The layered-navigation state of the current page relative to the host. */
+type LayerState = 'background' | 'foreground';
+/**
+ * Subscribe to layer-state transitions of the current page. Fires `background`
+ * when another layer (e.g. an overlay) is opened on top of the current page and
+ * `foreground` when it returns to the top. Hosts without layered navigation
+ * leave this undefined.
+ */
+type OnLayerStateChange = (callback: (newState: LayerState) => void) => {
+    remove: () => void;
+};
+interface HostContainerExtension {
+    appId?: string;
+    componentId: string;
+    title?: string;
+    menuItem?: {
+        IconComponent?: FunctionComponent;
+        IconSmallComponent?: FunctionComponent;
+        structuredAction: (params?: Record<string, any>) => unknown;
+    };
+    Component?: React.ComponentType;
+    Extension?: React.ComponentType;
+}
+type GetExtensions = () => HostContainerExtension[] | Promise<HostContainerExtension[]>;
+interface HostContainer {
+    getExtensions: GetExtensions;
+}
+type GetHostContainer = (hostContainerId: string) => HostContainer;
+type OpenMediaManager = SDK['openMediaManager'];
+type CreateEssentials = (options: EssentialsOptions) => {
+    i18n: Essentials['i18n'];
+    dataCapsule: Essentials['dataCapsule'];
+    biLoggerFactory?: () => CairoBILoggerFactory;
+    errorMonitor: ErrorMonitor;
+    fedopsLogger?: MonitorLogger;
+    experiments?: Experiments;
+};
+type CreateComponentSettings = (container: {
+    httpClient: HttpClient$1;
+    queryCache: QueryCache;
+    environment: Environment;
+    createEssentials: CreateEssentials;
+}) => (options: {
+    namespace: string;
+}) => DataCapsule;
+interface PatternsErrorHandler {
+    withErrorHandler: errorHandler.ErrorHandler['withErrorHandler'];
+    getResolvedError?: errorHandler.ErrorHandler['getResolvedError'];
+    showError?: errorHandler.ErrorHandler['showError'];
+    reportRetryAttempt?: errorHandler.ErrorHandler['reportRetryAttempt'];
+}
+interface WixPatternsEssentials {
+    httpClient: HttpClient$1;
+    /** A `ErrorMonitor` instance `@wix/fe-essentials/error-monitor` */
+    errorMonitor: ErrorMonitor;
+    /** A `Experiments` instance `@wix/fe-essentials/experiments` */
+    experiments: Experiments;
+    errorHandler?: PatternsErrorHandler;
+    biLogger?: BiLogger | null;
+    /**
+     * A function that returns the shape `{ i18n }` - should be compatible with `{createEssentials} from '@wix/fe-essentials'` */
+    createEssentials: CreateEssentials;
+    /** A `DataCapsule` to store component-level settings such as `Views` */
+    createComponentSettings?: CreateComponentSettings;
+    /** The user's environment
+     * - `language` - preferable language for the user
+     * - `artifactId` - App level identifier, usually the artifact ID
+     * - `componentId` - Component/page level identifier (Optional)
+     * - `componentName` - Readable component/page name (Optional)
+     */
+    environment: Pick<Environment, 'language'> & Partial<Omit<Environment, 'language'>> & {
+        uiLibVersion?: string;
+        msid?: string;
+    };
+    environmentBI: EnvironmentBi;
+    /** `useTranslation` hook from `react-i18next` or `@wix/fe-essentials/react` */
+    useTranslation: typeof useTranslation;
+    /** `Trans` component from `react-i18next` or `@wix/fe-essentials/react */
+    Trans: typeof Trans;
+    user: {
+        id?: string;
+        permissions: string[];
+    };
+    /** `useExperiments` hook from `@wix/yoshi-flow-bm` or `@wix/fe-essentials/react` */
+    useExperiments: () => {
+        ready: boolean;
+        experiments: {
+            enabled: (key: string) => boolean;
+        };
+    };
+    usePageLocation?: () => PageLocation | undefined;
+    /** A function that shows a global toast. For BM usage, it should be `showToast` from `business-manager-api` */
+    showToast?: ShowToast;
+    /** A function to perform a navigation to a given pageId */
+    navigateTo?: NavigateToFunc;
+    useAppLoaded?: () => void;
+    onSidePanelOpen?: OnSidePanelOpen;
+    closeSidePanel?: CloseSidePanel;
+    /** Custom [history](https://github.com/remix-run/history/tree/v5.3.0/packages/history) instance to sync custom consumer navigations with Cairo navigations */
+    history?: History$1;
+    /** An optional query cache instance for controlling the cache from other modules */
+    queryCache?: QueryCache;
+    /** A function that interrupts a navigation to another app inside wix platforms */
+    onNavigation?: OnNavigation;
+    getHostContainer?: GetHostContainer;
+    onlineManager?: OnlineManager;
+    /**
+     * Deals with dirty state by setting up a listener that triggers a confirmation dialog when a user attempts to leave a page. The event listener is removed upon component unmount.
+     * @param callback - called on navigation with an event object. Use event.preventDefault() within the callback to display the dialog.
+     * @returns { remove: () => void } - object that includes a remove method. You can use this method to remove the listener whenever necessary.
+     */
+    onBeforeUnload?: OnBeforeUnload;
+    /**
+     * Subscribe to layer-state transitions of the current page (e.g. to refresh
+     * data when an overlay opened on top of it is closed). Provided by hosts that
+     * support layered navigation; left undefined otherwise.
+     */
+    onLayerStateChange?: OnLayerStateChange;
+    /** Opens the Wix Media Manager. Provided by the Dashboard SDK via context. */
+    openMediaManager?: OpenMediaManager;
+}
+type ContextType = 'ACCOUNT' | 'SITE';
+
+interface WixPatternsInitialProps {
+    messages?: Messages;
+}
+
+/** An external-database connection; determines whether an EXTERNAL collection is editable. */
+interface ExternalDbConnection {
+    namespace: string;
+    capabilities?: {
+        collectionModificationsSupported?: boolean;
+        fieldTypes?: string[];
+    };
+}
+
+type HttpClient = WixPatternsContainerParams['httpClient'];
+interface CreateCmsSchemaLoaderDeps {
+    httpClient: HttpClient;
+    /** Fetch the user's ABAC permissions for field-management gating. Default `false`. */
+    includeUserPermissions?: boolean;
+    /** Host-supplied metasite id; the ABAC permission fetch is skipped without it. */
+    metasiteId?: string;
+    /** Pre-resolved overrides (tests); skip the internal fetch when provided. */
+    userPermissions?: string[];
+    externalDbConnections?: ExternalDbConnection[];
+    /** Called with the raw collection on every load, for the parts of it that the
+     *  source-neutral schema doesn't carry (e.g. who can read the collection). */
+    onCollectionLoaded?: (collection: collections.DataCollection) => void;
+}
+
+interface UseCmsSchemaSourceDeps extends Omit<CreateCmsSchemaLoaderDeps, 'httpClient' | 'onCollectionLoaded'> {
+    collectionId: string;
+    /** Default: the patterns container's client. */
+    httpClient?: CreateCmsSchemaLoaderDeps['httpClient'];
+    /** The site whose user permissions `includeUserPermissions` fetches.
+     *  Default: the patterns container's `environment.msid`. */
+    metasiteId?: string;
+    /** Seed sources for referenced collections, keyed by referenced collection
+     *  id. Usually unnecessary — reference fields are resolved automatically from
+     *  the loaded schema. Provide an entry only to override the auto-built one. */
+    references?: Record<string, SchemaSource<any>>;
+    /** Consumer-defined field types, resolved by fields with `type: 'CUSTOM'`. */
+    fieldTypes?: FieldTypeDefinition[];
+    /** Opens the host's collection-permissions UI. Without it the PII warning
+     *  shows its text but no action. */
+    onEditCollectionPermissions?: () => void;
+}
+declare function cmsSchemaSourceInput<T extends Record<string, unknown> = Record<string, unknown>>(deps: UseCmsSchemaSourceDeps & Pick<CreateCmsSchemaLoaderDeps, 'httpClient'>): SchemaSourceInput<T>;
+/**
+ * A ready-to-use `SchemaSource` for a CMS collection: wraps the CMS schema
+ * loader and supplies the CMS field types. Pass it to a `@wix/patterns/schema`
+ * collection hook.
+ */
+declare function useCmsSchemaSource<T extends Record<string, unknown> = Record<string, unknown>>(deps: UseCmsSchemaSourceDeps): SchemaSource<T>;
+
+export { cmsSchemaSourceInput, useCmsSchemaSource };
+export type { UseCmsSchemaSourceDeps };