@wix/patterns 1.461.0 → 1.463.0

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

@@ -57,7 +57,11 @@ interface NonReferenceField extends BaseField {
 }
 type Field = ReferenceField | MultiReferenceField | NonReferenceField;
 
-type OffsetQuery<F extends FiltersMap = OptionalFiltersMap> = Omit<ComputedQuery<F>, 'cursor'>;
+/**
+ * `OffsetQuery` — cut here because it has its own bundle.
+ * Look `OffsetQuery` up in the bundle index for its full shape.
+ */
+type OffsetQuery<F = any> = Omit<ComputedQuery<F>, 'cursor'>;
 type OffsetQueryResult<T> = Omit<DataResultRaw<T>, 'cursor'>;
 type CursorQueryResult<T> = Omit<DataResultRaw<T>, 'cursor'> & {
     cursor: string | undefined | null;
@@ -66,7 +70,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.
  */
-type CursorQuery<F = any> = Record<string, unknown>;
+type CursorQuery<F = any> = Omit<ComputedQuery<F>, 'offset'>;
 type FetchTotalFn = (query: CursorQuery) => Promise<number>;
 
 /** Field-management permissions. Absent when the schema's fields cannot be edited. */
@@ -397,6 +401,21 @@ interface CellEditWrapperProps {
     /** 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
@@ -418,8 +437,8 @@ interface EditableCellConfig<V> {
     deserialize?(raw: string): V;
     /** Can this cell type be edited? (default: true) */
     editable?: boolean;
-    /** Can this cell type be cleared with Delete key? (default: true) */
-    clearable?: 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). */
@@ -742,34 +761,12 @@ interface ComputedQuery<F = any> {
     [key: string]: unknown;
 }
 
-interface DataResultRaw<T> {
-    /**
-     * Array of items returned from the server.
-     * @external
-     */
-    items: T[];
-    /**
-     * Total items available in the server, *after* applying filters. If not provided, offset pagination will not work correctly.
-     * If you are using a cursor and did not include `total` in your query request, you can use the `fetchTotal` function to extract it asynchronously.
-     * @default `items.length`
-     * @external
-     */
-    total?: number | null;
-    /**
-     * Total items available in the server, *before* applying filters.
-     * @external
-     */
-    available?: number;
-    /**
-     * In case of cursor pagination, this will be the value that will be sent in the query on the next page request.
-     * @external
-     */
-    cursor?: string | undefined | null;
-    /**
-     * Indicates whether there are more items available after the current page.
-     * @external
-     */
-    hasNext?: boolean | null;
+/**
+ * `DataResultRaw` — cut here because it has its own bundle.
+ * Look `DataResultRaw` up in the bundle index for its full shape.
+ */
+interface DataResultRaw<T = any> {
+    [key: string]: unknown;
 }
 
 type DeleteErrorToast = (err: unknown, params: {

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

@@ -0,0 +1,53 @@
+/**
+ * `Filter` — cut here because it has its own bundle.
+ * Look `Filter` up in the bundle index for its full shape.
+ */
+interface Filter<T = any> {
+    [key: string]: unknown;
+}
+type FiltersMap = {
+    [key: string]: Filter<any> | undefined;
+};
+type OptionalFiltersMap = {
+    [key: string]: undefined;
+};
+
+/**
+ * `ComputedQuery` — cut here because it has its own bundle.
+ * Look `ComputedQuery` up in the bundle index for its full shape.
+ */
+interface ComputedQuery<F = any> {
+    [key: string]: unknown;
+}
+
+/**
+ * `DataResultRaw` — cut here because it has its own bundle.
+ * Look `DataResultRaw` up in the bundle index for its full shape.
+ */
+interface DataResultRaw<T = any> {
+    [key: string]: unknown;
+}
+
+type OffsetQuery<F extends FiltersMap = OptionalFiltersMap> = Omit<ComputedQuery<F>, 'cursor'>;
+type OffsetQueryResult<T> = Omit<DataResultRaw<T>, 'cursor'>;
+type OffsetFetchDataFn<T, F extends FiltersMap> = (query: OffsetQuery<F>) => Promise<OffsetQueryResult<T>>;
+type CursorQueryResult<T> = Omit<DataResultRaw<T>, 'cursor'> & {
+    cursor: string | undefined | null;
+};
+/**
+ * `CursorQuery` — cut here because it has its own bundle.
+ * Look `CursorQuery` up in the bundle index for its full shape.
+ */
+type CursorQuery<F = any> = Omit<ComputedQuery<F>, 'offset'>;
+type CursorFetchDataFn<T, F extends FiltersMap> = (query: CursorQuery<F>) => Promise<CursorQueryResult<T>>;
+type FetchTotalFn = (query: CursorQuery) => Promise<number>;
+type PaginationModeConfig<T, F extends FiltersMap> = {
+    paginationMode?: 'offset';
+    fetchData: OffsetFetchDataFn<T, F>;
+} | {
+    paginationMode: 'cursor';
+    fetchTotal?: FetchTotalFn;
+    fetchData: CursorFetchDataFn<T, F>;
+};
+
+export type { CursorFetchDataFn, CursorQuery, CursorQueryResult, FetchTotalFn, OffsetFetchDataFn, OffsetQuery, OffsetQueryResult, PaginationModeConfig };