@wordpress/dataviews 9.1.1-next.f56bd8138.0 → 10.0.1-next.47f435fc9.0

package/build-types/stories/dataviews.story.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataviews.story.d.ts","sourceRoot":"","sources":["../../src/stories/dataviews.story.tsx"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAyB7C;;GAEG;AACH,OAAO,SAAS,MAAM,+BAA+B,CAAC;AAYtD,OAAO,uBAAuB,CAAC;AAE/B,QAAA,MAAM,IAAI,EAiBL,IAAI,CAAE,OAAO,SAAS,CAAE,CAAC;AAE9B,eAAe,IAAI,CAAC;AAQpB,eAAO,MAAM,OAAO;;;;;;;;;;;;;CAmCnB,CAAC;AAaF,eAAO,MAAM,KAAK,mCAkBjB,CAAC;AAEF,eAAO,MAAM,WAAW,mCAmBvB,CAAC;AA+CF,eAAO,MAAM,SAAS;0BA3CnB;QACF,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;KAClC;;;;;;;;CAkDA,CAAC;AA8EF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,eAAe,mCAiD3B,CAAC;AAEF,eAAO,MAAM,QAAQ,mCA8BpB,CAAC;AAEF,eAAO,MAAM,aAAa,mCAmCzB,CAAC;AAEF,eAAO,MAAM,cAAc,mCA2H1B,CAAC"}

package/build-types/stories/field-types.story.d.ts

@@ -0,0 +1,134 @@
+import DataForm from '../components/dataform/index';
+declare const meta: {
+    title: string;
+    component: typeof DataForm;
+    argTypes: {
+        type: {
+            control: {
+                type: string;
+            };
+            description: string;
+            options: string[];
+        };
+        Edit: {
+            control: {
+                type: string;
+            };
+            description: string;
+            options: string[];
+        };
+    };
+    args: {
+        type: string;
+        Edit: string;
+    };
+};
+export default meta;
+type PanelTypes = 'regular' | 'panel';
+type ControlTypes = 'default' | 'array' | 'checkbox' | 'color' | 'date' | 'datetime' | 'email' | 'integer' | 'number' | 'password' | 'radio' | 'select' | 'telephone' | 'url' | 'text' | 'toggle' | 'toggleGroup';
+export declare const AllComponent: {
+    ({ type, Edit, }: {
+        type: PanelTypes;
+        Edit: ControlTypes;
+    }): import("react").JSX.Element;
+    storyName: string;
+};
+export declare const TextComponent: {
+    ({ type, Edit, }: {
+        type: PanelTypes;
+        Edit: ControlTypes;
+    }): import("react").JSX.Element;
+    storyName: string;
+};
+export declare const IntegerComponent: {
+    ({ type, Edit, }: {
+        type: PanelTypes;
+        Edit: ControlTypes;
+    }): import("react").JSX.Element;
+    storyName: string;
+};
+export declare const NumberComponent: {
+    ({ type, Edit, }: {
+        type: PanelTypes;
+        Edit: ControlTypes;
+    }): import("react").JSX.Element;
+    storyName: string;
+};
+export declare const BooleanComponent: {
+    ({ type, Edit, }: {
+        type: PanelTypes;
+        Edit: ControlTypes;
+    }): import("react").JSX.Element;
+    storyName: string;
+};
+export declare const DateTimeComponent: {
+    ({ type, Edit, }: {
+        type: PanelTypes;
+        Edit: ControlTypes;
+    }): import("react").JSX.Element;
+    storyName: string;
+};
+export declare const DateComponent: {
+    ({ type, Edit, }: {
+        type: PanelTypes;
+        Edit: ControlTypes;
+    }): import("react").JSX.Element;
+    storyName: string;
+};
+export declare const EmailComponent: {
+    ({ type, Edit, }: {
+        type: PanelTypes;
+        Edit: ControlTypes;
+    }): import("react").JSX.Element;
+    storyName: string;
+};
+export declare const TelephoneComponent: {
+    ({ type, Edit, }: {
+        type: PanelTypes;
+        Edit: ControlTypes;
+    }): import("react").JSX.Element;
+    storyName: string;
+};
+export declare const UrlComponent: {
+    ({ type, Edit, }: {
+        type: PanelTypes;
+        Edit: ControlTypes;
+    }): import("react").JSX.Element;
+    storyName: string;
+};
+export declare const ColorComponent: {
+    ({ type, Edit, }: {
+        type: PanelTypes;
+        Edit: ControlTypes;
+    }): import("react").JSX.Element;
+    storyName: string;
+};
+export declare const MediaComponent: {
+    ({ type, Edit, }: {
+        type: PanelTypes;
+        Edit: ControlTypes;
+    }): import("react").JSX.Element;
+    storyName: string;
+};
+export declare const ArrayComponent: {
+    ({ type, Edit, }: {
+        type: PanelTypes;
+        Edit: ControlTypes;
+    }): import("react").JSX.Element;
+    storyName: string;
+};
+export declare const PasswordComponent: {
+    ({ type, Edit, }: {
+        type: PanelTypes;
+        Edit: ControlTypes;
+    }): import("react").JSX.Element;
+    storyName: string;
+};
+export declare const NoTypeComponent: {
+    ({ type, Edit, }: {
+        type: PanelTypes;
+        Edit: ControlTypes;
+    }): import("react").JSX.Element;
+    storyName: string;
+};
+//# sourceMappingURL=field-types.story.d.ts.map

package/build-types/stories/field-types.story.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"field-types.story.d.ts","sourceRoot":"","sources":["../../src/stories/field-types.story.tsx"],"names":[],"mappings":"AAiBA,OAAO,QAAQ,MAAM,8BAA8B,CAAC;AAIpD,QAAA,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;CAuCT,CAAC;AACF,eAAe,IAAI,CAAC;AA2cpB,KAAK,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC;AACtC,KAAK,YAAY,GACd,SAAS,GACT,OAAO,GACP,UAAU,GACV,OAAO,GACP,MAAM,GACN,UAAU,GACV,OAAO,GACP,SAAS,GACT,QAAQ,GACR,UAAU,GACV,OAAO,GACP,QAAQ,GACR,WAAW,GACX,KAAK,GACL,MAAM,GACN,QAAQ,GACR,aAAa,CAAC;AAwHjB,eAAO,MAAM,YAAY;sBAGtB;QACF,IAAI,EAAE,UAAU,CAAC;QACjB,IAAI,EAAE,YAAY,CAAC;KACnB;;CAEA,CAAC;AAGF,eAAO,MAAM,aAAa;sBAGvB;QACF,IAAI,EAAE,UAAU,CAAC;QACjB,IAAI,EAAE,YAAY,CAAC;KACnB;;CAOA,CAAC;AAGF,eAAO,MAAM,gBAAgB;sBAG1B;QACF,IAAI,EAAE,UAAU,CAAC;QACjB,IAAI,EAAE,YAAY,CAAC;KACnB;;CASA,CAAC;AAGF,eAAO,MAAM,eAAe;sBAGzB;QACF,IAAI,EAAE,UAAU,CAAC;QACjB,IAAI,EAAE,YAAY,CAAC;KACnB;;CASA,CAAC;AAGF,eAAO,MAAM,gBAAgB;sBAG1B;QACF,IAAI,EAAE,UAAU,CAAC;QACjB,IAAI,EAAE,YAAY,CAAC;KACnB;;CASA,CAAC;AAGF,eAAO,MAAM,iBAAiB;sBAG3B;QACF,IAAI,EAAE,UAAU,CAAC;QACjB,IAAI,EAAE,YAAY,CAAC;KACnB;;CASA,CAAC;AAGF,eAAO,MAAM,aAAa;sBAGvB;QACF,IAAI,EAAE,UAAU,CAAC;QACjB,IAAI,EAAE,YAAY,CAAC;KACnB;;CAOA,CAAC;AAGF,eAAO,MAAM,cAAc;sBAGxB;QACF,IAAI,EAAE,UAAU,CAAC;QACjB,IAAI,EAAE,YAAY,CAAC;KACnB;;CASA,CAAC;AAGF,eAAO,MAAM,kBAAkB;sBAG5B;QACF,IAAI,EAAE,UAAU,CAAC;QACjB,IAAI,EAAE,YAAY,CAAC;KACnB;;CAaA,CAAC;AAGF,eAAO,MAAM,YAAY;sBAGtB;QACF,IAAI,EAAE,UAAU,CAAC;QACjB,IAAI,EAAE,YAAY,CAAC;KACnB;;CAOA,CAAC;AAGF,eAAO,MAAM,cAAc;sBAGxB;QACF,IAAI,EAAE,UAAU,CAAC;QACjB,IAAI,EAAE,YAAY,CAAC;KACnB;;CASA,CAAC;AAGF,eAAO,MAAM,cAAc;sBAGxB;QACF,IAAI,EAAE,UAAU,CAAC;QACjB,IAAI,EAAE,YAAY,CAAC;KACnB;;CASA,CAAC;AAGF,eAAO,MAAM,cAAc;sBAGxB;QACF,IAAI,EAAE,UAAU,CAAC;QACjB,IAAI,EAAE,YAAY,CAAC;KACnB;;CAaA,CAAC;AAGF,eAAO,MAAM,iBAAiB;sBAG3B;QACF,IAAI,EAAE,UAAU,CAAC;QACjB,IAAI,EAAE,YAAY,CAAC;KACnB;;CASA,CAAC;AAGF,eAAO,MAAM,eAAe;sBAGzB;QACF,IAAI,EAAE,UAAU,CAAC;QACjB,IAAI,EAAE,YAAY,CAAC;KACnB;;CASA,CAAC"}

package/build-types/types/dataform.d.ts

@@ -0,0 +1,109 @@
+/**
+ * Internal dependencies
+ */
+import type { Field } from './field-api';
+/**
+ * DataForm layouts.
+ */
+export type LayoutType = 'regular' | 'panel' | 'card' | 'row';
+export type LabelPosition = 'top' | 'side' | 'none';
+export type PanelSummaryField = string | string[];
+export type NormalizedPanelSummaryField = string[];
+export type RegularLayout = {
+    type: 'regular';
+    labelPosition?: LabelPosition;
+};
+export type NormalizedRegularLayout = {
+    type: 'regular';
+    labelPosition: LabelPosition;
+};
+export type PanelLayout = {
+    type: 'panel';
+    labelPosition?: LabelPosition;
+    openAs?: 'dropdown' | 'modal';
+    summary?: PanelSummaryField;
+};
+export type NormalizedPanelLayout = {
+    type: 'panel';
+    labelPosition: LabelPosition;
+    openAs: 'dropdown' | 'modal';
+    summary: NormalizedPanelSummaryField;
+};
+export type CardSummaryField = PanelSummaryField | Array<string | {
+    id: string;
+    visibility: 'always' | 'when-collapsed';
+}>;
+export type NormalizedCardSummaryField = Array<{
+    id: string;
+    visibility: 'always' | 'when-collapsed';
+}>;
+export type CardLayout = {
+    type: 'card';
+    withHeader: false;
+    isOpened?: true;
+} | {
+    type: 'card';
+    withHeader?: true | undefined;
+    isOpened?: boolean;
+    summary?: CardSummaryField;
+};
+export type NormalizedCardLayout = {
+    type: 'card';
+    withHeader: false;
+    isOpened: true;
+    summary: [];
+} | {
+    type: 'card';
+    withHeader: true;
+    isOpened: boolean;
+    summary: NormalizedCardSummaryField;
+};
+export type RowLayout = {
+    type: 'row';
+    alignment?: 'start' | 'center' | 'end';
+    styles?: Record<string, {
+        flex?: React.CSSProperties['flex'];
+    }>;
+};
+export type NormalizedRowLayout = {
+    type: 'row';
+    alignment: 'start' | 'center' | 'end';
+    styles: Record<string, {
+        flex?: React.CSSProperties['flex'];
+    }>;
+};
+export type Layout = RegularLayout | PanelLayout | CardLayout | RowLayout;
+export type NormalizedLayout = NormalizedRegularLayout | NormalizedPanelLayout | NormalizedCardLayout | NormalizedRowLayout;
+export type NormalizedSummaryField = NormalizedPanelSummaryField | NormalizedCardSummaryField;
+export type SimpleFormField = {
+    id: string;
+    layout?: Layout;
+};
+export type CombinedFormField = {
+    id: string;
+    label?: string;
+    description?: string;
+    layout?: Layout;
+    children: Array<FormField | string>;
+};
+export type FormField = SimpleFormField | CombinedFormField;
+/**
+ * The form configuration.
+ */
+export type Form = {
+    layout?: Layout;
+    fields?: Array<FormField | string>;
+};
+export interface DataFormProps<Item> {
+    data: Item;
+    fields: Field<Item>[];
+    form: Form;
+    onChange: (value: Record<string, any>) => void;
+}
+export interface FieldLayoutProps<Item> {
+    data: Item;
+    field: FormField;
+    onChange: (value: any) => void;
+    hideLabelFromVision?: boolean;
+}
+//# sourceMappingURL=dataform.d.ts.map

package/build-types/types/dataform.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataform.d.ts","sourceRoot":"","sources":["../../src/types/dataform.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC;AAC9D,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAEpD,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AAClD,MAAM,MAAM,2BAA2B,GAAG,MAAM,EAAE,CAAC;AAEnD,MAAM,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,SAAS,CAAC;IAChB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC9B,CAAC;AACF,MAAM,MAAM,uBAAuB,GAAG;IACrC,IAAI,EAAE,SAAS,CAAC;IAChB,aAAa,EAAE,aAAa,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACzB,IAAI,EAAE,OAAO,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC;IAC9B,OAAO,CAAC,EAAE,iBAAiB,CAAC;CAC5B,CAAC;AACF,MAAM,MAAM,qBAAqB,GAAG;IACnC,IAAI,EAAE,OAAO,CAAC;IACd,aAAa,EAAE,aAAa,CAAC;IAC7B,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC;IAC7B,OAAO,EAAE,2BAA2B,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACzB,iBAAiB,GACjB,KAAK,CACH,MAAM,GACN;IACA,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,QAAQ,GAAG,gBAAgB,CAAC;CACvC,CACF,CAAC;AAEL,MAAM,MAAM,0BAA0B,GAAG,KAAK,CAAE;IAC/C,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,QAAQ,GAAG,gBAAgB,CAAC;CACxC,CAAE,CAAC;AAEJ,MAAM,MAAM,UAAU,GACnB;IACA,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,KAAK,CAAC;IAGlB,QAAQ,CAAC,EAAE,IAAI,CAAC;CACf,GACD;IACA,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,IAAI,GAAG,SAAS,CAAC;IAC9B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,gBAAgB,CAAC;CAC1B,CAAC;AACL,MAAM,MAAM,oBAAoB,GAC7B;IACA,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,KAAK,CAAC;IAGlB,QAAQ,EAAE,IAAI,CAAC;IAEf,OAAO,EAAE,EAAE,CAAC;CACX,GACD;IACA,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,IAAI,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,0BAA0B,CAAC;CACnC,CAAC;AAEL,MAAM,MAAM,SAAS,GAAG;IACvB,IAAI,EAAE,KAAK,CAAC;IACZ,SAAS,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAE,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,KAAK,CAAC,aAAa,CAAE,MAAM,CAAE,CAAA;KAAE,CAAE,CAAC;CACpE,CAAC;AACF,MAAM,MAAM,mBAAmB,GAAG;IACjC,IAAI,EAAE,KAAK,CAAC;IACZ,SAAS,EAAE,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAC;IACtC,MAAM,EAAE,MAAM,CAAE,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,KAAK,CAAC,aAAa,CAAE,MAAM,CAAE,CAAA;KAAE,CAAE,CAAC;CACnE,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,aAAa,GAAG,WAAW,GAAG,UAAU,GAAG,SAAS,CAAC;AAC1E,MAAM,MAAM,gBAAgB,GACzB,uBAAuB,GACvB,qBAAqB,GACrB,oBAAoB,GACpB,mBAAmB,CAAC;AAEvB,MAAM,MAAM,sBAAsB,GAC/B,2BAA2B,GAC3B,0BAA0B,CAAC;AAE9B,MAAM,MAAM,eAAe,GAAG;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,KAAK,CAAE,SAAS,GAAG,MAAM,CAAE,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,eAAe,GAAG,iBAAiB,CAAC;AAE5D;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,KAAK,CAAE,SAAS,GAAG,MAAM,CAAE,CAAC;CACrC,CAAC;AAEF,MAAM,WAAW,aAAa,CAAE,IAAI;IACnC,IAAI,EAAE,IAAI,CAAC;IACX,MAAM,EAAE,KAAK,CAAE,IAAI,CAAE,EAAE,CAAC;IACxB,IAAI,EAAE,IAAI,CAAC;IACX,QAAQ,EAAE,CAAE,KAAK,EAAE,MAAM,CAAE,MAAM,EAAE,GAAG,CAAE,KAAM,IAAI,CAAC;CACnD;AAED,MAAM,WAAW,gBAAgB,CAAE,IAAI;IACtC,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,SAAS,CAAC;IACjB,QAAQ,EAAE,CAAE,KAAK,EAAE,GAAG,KAAM,IAAI,CAAC;IACjC,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC9B"}

package/build-types/types/dataviews.d.ts

@@ -0,0 +1,333 @@
+/**
+ * External dependencies
+ */
+import type { ReactElement, ReactNode, ComponentProps } from 'react';
+/**
+ * WordPress dependencies
+ */
+import type { useFocusOnMount } from '@wordpress/compose';
+/**
+ * Internal dependencies
+ */
+import type { NormalizedField, Operator, Option, SortDirection } from './field-api';
+import type { SetSelection } from './private';
+/**
+ * The filters applied to the dataset.
+ */
+export interface Filter {
+    /**
+     * The field to filter by.
+     */
+    field: string;
+    /**
+     * The operator to use.
+     */
+    operator: Operator;
+    /**
+     * The value to filter by.
+     */
+    value: any;
+    /**
+     * Whether the filter can be edited by the user.
+     */
+    isLocked?: boolean;
+}
+export interface NormalizedFilter {
+    /**
+     * The field to filter by.
+     */
+    field: string;
+    /**
+     * The field name.
+     */
+    name: string;
+    /**
+     * The list of options to pick from when using the field as a filter.
+     */
+    elements: Option[];
+    /**
+     * Is a single selection filter.
+     */
+    singleSelection: boolean;
+    /**
+     * The list of operators supported by the field.
+     */
+    operators: Operator[];
+    /**
+     * Whether the filter is visible.
+     */
+    isVisible: boolean;
+    /**
+     * Whether it is a primary filter.
+     */
+    isPrimary: boolean;
+    /**
+     * Whether the filter can be edited by the user.
+     */
+    isLocked: boolean;
+}
+interface ViewBase {
+    /**
+     * The layout of the view.
+     */
+    type: string;
+    /**
+     * The global search term.
+     */
+    search?: string;
+    /**
+     * The filters to apply.
+     */
+    filters?: Filter[];
+    /**
+     * The sorting configuration.
+     */
+    sort?: {
+        /**
+         * The field to sort by.
+         */
+        field: string;
+        /**
+         * The direction to sort by.
+         */
+        direction: SortDirection;
+    };
+    /**
+     * The active page
+     */
+    page?: number;
+    /**
+     * The number of items per page
+     */
+    perPage?: number;
+    /**
+     * The fields to render
+     */
+    fields?: string[];
+    /**
+     * Title field
+     */
+    titleField?: string;
+    /**
+     * Media field
+     */
+    mediaField?: string;
+    /**
+     * Description field
+     */
+    descriptionField?: string;
+    /**
+     * Whether to show the title
+     */
+    showTitle?: boolean;
+    /**
+     * Whether to show the media
+     */
+    showMedia?: boolean;
+    /**
+     * Whether to show the description
+     */
+    showDescription?: boolean;
+    /**
+     * Whether to show the hierarchical levels.
+     */
+    showLevels?: boolean;
+    /**
+     * The field to group by.
+     */
+    groupByField?: string;
+    /**
+     * Whether infinite scroll is enabled.
+     */
+    infiniteScrollEnabled?: boolean;
+}
+export interface ColumnStyle {
+    /**
+     * The width of the field column.
+     */
+    width?: string | number;
+    /**
+     * The minimum width of the field column.
+     */
+    maxWidth?: string | number;
+    /**
+     * The maximum width of the field column.
+     */
+    minWidth?: string | number;
+    /**
+     * The alignment of the field column, defaults to left.
+     */
+    align?: 'start' | 'center' | 'end';
+}
+export type Density = 'compact' | 'balanced' | 'comfortable';
+export interface ViewTable extends ViewBase {
+    type: 'table';
+    layout?: {
+        /**
+         * The styles for the columns.
+         */
+        styles?: Record<string, ColumnStyle>;
+        /**
+         * The density of the view.
+         */
+        density?: Density;
+        /**
+         * Whether the view allows column moving.
+         */
+        enableMoving?: boolean;
+    };
+}
+export interface ViewList extends ViewBase {
+    type: 'list';
+}
+export interface ViewGrid extends ViewBase {
+    type: 'grid';
+    layout?: {
+        /**
+         * The fields to use as badge fields.
+         */
+        badgeFields?: string[];
+        /**
+         * The preview size of the grid.
+         */
+        previewSize?: number;
+    };
+}
+export interface ViewPickerGrid extends ViewBase {
+    type: 'pickerGrid';
+    layout?: {
+        /**
+         * The fields to use as badge fields.
+         */
+        badgeFields?: string[];
+        /**
+         * The preview size of the grid.
+         */
+        previewSize?: number;
+    };
+}
+export type View = ViewList | ViewGrid | ViewTable | ViewPickerGrid;
+interface ActionBase<Item> {
+    /**
+     * The unique identifier of the action.
+     */
+    id: string;
+    /**
+     * The label of the action.
+     * In case we want to adjust the label based on the selected items,
+     * a function can be provided.
+     */
+    label: string | ((items: Item[]) => string);
+    /**
+     * The icon of the action. (Either a string or an SVG element)
+     * This should be IconType from the components package
+     * but that import is breaking typescript build for the moment.
+     */
+    icon?: any;
+    /**
+     * Whether the action is disabled.
+     */
+    disabled?: boolean;
+    /**
+     * Whether the action is a primary action.
+     */
+    isPrimary?: boolean;
+    /**
+     * Whether the item passed as an argument supports the current action.
+     */
+    isEligible?: (item: Item) => boolean;
+    /**
+     * Whether the action can be used as a bulk action.
+     */
+    supportsBulk?: boolean;
+    /**
+     * The context in which the action is visible.
+     * This is only a "meta" information for now.
+     */
+    context?: 'list' | 'single';
+}
+export interface RenderModalProps<Item> {
+    items: Item[];
+    closeModal?: () => void;
+    onActionPerformed?: (items: Item[]) => void;
+}
+export interface ActionModal<Item> extends ActionBase<Item> {
+    /**
+     * Modal to render when the action is triggered.
+     */
+    RenderModal: ({ items, closeModal, onActionPerformed, }: RenderModalProps<Item>) => ReactElement;
+    /**
+     * Whether to hide the modal header.
+     */
+    hideModalHeader?: boolean;
+    /**
+     * The header of the modal.
+     */
+    modalHeader?: string;
+    /**
+     * The size of the modal.
+     *
+     * @default 'medium'
+     */
+    modalSize?: 'small' | 'medium' | 'large' | 'fill';
+    /**
+     * The focus on mount property of the modal.
+     */
+    modalFocusOnMount?: Parameters<typeof useFocusOnMount>[0] | 'firstContentElement';
+}
+export interface ActionButton<Item> extends ActionBase<Item> {
+    /**
+     * The callback to execute when the action is triggered.
+     */
+    callback: (items: Item[], context: {
+        registry: any;
+        onActionPerformed?: (items: Item[]) => void;
+    }) => void;
+}
+export type Action<Item> = ActionModal<Item> | ActionButton<Item>;
+export interface ViewBaseProps<Item> {
+    className?: string;
+    actions: Action<Item>[];
+    data: Item[];
+    fields: NormalizedField<Item>[];
+    getItemId: (item: Item) => string;
+    getItemLevel?: (item: Item) => number;
+    isLoading?: boolean;
+    onChangeView: (view: View) => void;
+    onChangeSelection: SetSelection;
+    selection: string[];
+    setOpenedFilter: (fieldId: string) => void;
+    onClickItem?: (item: Item) => void;
+    renderItemLink?: (props: {
+        item: Item;
+    } & ComponentProps<'a'>) => ReactElement;
+    isItemClickable: (item: Item) => boolean;
+    view: View;
+    empty: ReactNode;
+}
+export type ViewPickerBaseProps<Item> = Omit<ViewBaseProps<Item>, 'view' | 'onChangeView' | 'isItemClickable' | 'onClickItem' | 'renderItemLink' | 'getItemLevel'> & {
+    view: View;
+    onChangeView: (view: View) => void;
+};
+export interface ViewTableProps<Item> extends ViewBaseProps<Item> {
+    view: ViewTable;
+}
+export interface ViewListProps<Item> extends ViewBaseProps<Item> {
+    view: ViewList;
+}
+export interface ViewGridProps<Item> extends ViewBaseProps<Item> {
+    view: ViewGrid;
+}
+export interface ViewPickerGridProps<Item> extends Omit<ViewPickerBaseProps<Item>, 'view'> {
+    view: ViewPickerGrid;
+}
+export type ViewProps<Item> = ViewTableProps<Item> | ViewGridProps<Item> | ViewListProps<Item>;
+export type ViewPickerProps<Item> = ViewPickerGridProps<Item>;
+export interface SupportedLayouts {
+    list?: Omit<ViewList, 'type'>;
+    grid?: Omit<ViewGrid, 'type'>;
+    table?: Omit<ViewTable, 'type'>;
+    pickerGrid?: Omit<ViewPickerGrid, 'type'>;
+}
+export {};
+//# sourceMappingURL=dataviews.d.ts.map

package/build-types/types/dataviews.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataviews.d.ts","sourceRoot":"","sources":["../../src/types/dataviews.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAErE;;GAEG;AACH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAE1D;;GAEG;AACH,OAAO,KAAK,EACX,eAAe,EACf,QAAQ,EACR,MAAM,EACN,aAAa,EACb,MAAM,aAAa,CAAC;AACrB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,MAAM;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,KAAK,EAAE,GAAG,CAAC;IAEX;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,QAAQ,EAAE,CAAC;IAEtB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CAClB;AAED,UAAU,QAAQ;IACjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE;QACN;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,SAAS,EAAE,aAAa,CAAC;KACzB,CAAC;IAEF;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAC;CACnC;AAED,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,UAAU,GAAG,aAAa,CAAC;AAE7D,MAAM,WAAW,SAAU,SAAQ,QAAQ;IAC1C,IAAI,EAAE,OAAO,CAAC;IAEd,MAAM,CAAC,EAAE;QACR;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAE,MAAM,EAAE,WAAW,CAAE,CAAC;QAEvC;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;KACvB,CAAC;CACF;AAED,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACzC,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACzC,IAAI,EAAE,MAAM,CAAC;IAEb,MAAM,CAAC,EAAE;QACR;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QAEvB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;CACF;AAED,MAAM,WAAW,cAAe,SAAQ,QAAQ;IAC/C,IAAI,EAAE,YAAY,CAAC;IAEnB,MAAM,CAAC,EAAE;QACR;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QAEvB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;CACF;AAED,MAAM,MAAM,IAAI,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,cAAc,CAAC;AAEpE,UAAU,UAAU,CAAE,IAAI;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,KAAK,EAAE,MAAM,GAAG,CAAE,CAAE,KAAK,EAAE,IAAI,EAAE,KAAM,MAAM,CAAE,CAAC;IAEhD;;;;OAIG;IACH,IAAI,CAAC,EAAE,GAAG,CAAC;IAEX;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,CAAE,IAAI,EAAE,IAAI,KAAM,OAAO,CAAC;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;CAC5B;AAED,MAAM,WAAW,gBAAgB,CAAE,IAAI;IACtC,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;IACxB,iBAAiB,CAAC,EAAE,CAAE,KAAK,EAAE,IAAI,EAAE,KAAM,IAAI,CAAC;CAC9C;AAED,MAAM,WAAW,WAAW,CAAE,IAAI,CAAG,SAAQ,UAAU,CAAE,IAAI,CAAE;IAC9D;;OAEG;IACH,WAAW,EAAE,CAAE,EACd,KAAK,EACL,UAAU,EACV,iBAAiB,GACjB,EAAE,gBAAgB,CAAE,IAAI,CAAE,KAAM,YAAY,CAAC;IAE9C;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAC;IAElD;;OAEG;IACH,iBAAiB,CAAC,EACf,UAAU,CAAE,OAAO,eAAe,CAAE,CAAE,CAAC,CAAE,GACzC,qBAAqB,CAAC;CACzB;AAED,MAAM,WAAW,YAAY,CAAE,IAAI,CAAG,SAAQ,UAAU,CAAE,IAAI,CAAE;IAC/D;;OAEG;IACH,QAAQ,EAAE,CACT,KAAK,EAAE,IAAI,EAAE,EACb,OAAO,EAAE;QACR,QAAQ,EAAE,GAAG,CAAC;QACd,iBAAiB,CAAC,EAAE,CAAE,KAAK,EAAE,IAAI,EAAE,KAAM,IAAI,CAAC;KAC9C,KACG,IAAI,CAAC;CACV;AAED,MAAM,MAAM,MAAM,CAAE,IAAI,IAAK,WAAW,CAAE,IAAI,CAAE,GAAG,YAAY,CAAE,IAAI,CAAE,CAAC;AAExE,MAAM,WAAW,aAAa,CAAE,IAAI;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAE,IAAI,CAAE,EAAE,CAAC;IAC1B,IAAI,EAAE,IAAI,EAAE,CAAC;IACb,MAAM,EAAE,eAAe,CAAE,IAAI,CAAE,EAAE,CAAC;IAClC,SAAS,EAAE,CAAE,IAAI,EAAE,IAAI,KAAM,MAAM,CAAC;IACpC,YAAY,CAAC,EAAE,CAAE,IAAI,EAAE,IAAI,KAAM,MAAM,CAAC;IACxC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,YAAY,EAAE,CAAE,IAAI,EAAE,IAAI,KAAM,IAAI,CAAC;IACrC,iBAAiB,EAAE,YAAY,CAAC;IAChC,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,eAAe,EAAE,CAAE,OAAO,EAAE,MAAM,KAAM,IAAI,CAAC;IAC7C,WAAW,CAAC,EAAE,CAAE,IAAI,EAAE,IAAI,KAAM,IAAI,CAAC;IACrC,cAAc,CAAC,EAAE,CAChB,KAAK,EAAE;QACN,IAAI,EAAE,IAAI,CAAC;KACX,GAAG,cAAc,CAAE,GAAG,CAAE,KACrB,YAAY,CAAC;IAClB,eAAe,EAAE,CAAE,IAAI,EAAE,IAAI,KAAM,OAAO,CAAC;IAC3C,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,SAAS,CAAC;CACjB;AAED,MAAM,MAAM,mBAAmB,CAAE,IAAI,IAAK,IAAI,CAC7C,aAAa,CAAE,IAAI,CAAE,EACnB,MAAM,GACN,cAAc,GAEd,iBAAiB,GACjB,aAAa,GACb,gBAAgB,GAChB,cAAc,CAChB,GAAG;IACH,IAAI,EAAE,IAAI,CAAC;IACX,YAAY,EAAE,CAAE,IAAI,EAAE,IAAI,KAAM,IAAI,CAAC;CACrC,CAAC;AAEF,MAAM,WAAW,cAAc,CAAE,IAAI,CAAG,SAAQ,aAAa,CAAE,IAAI,CAAE;IACpE,IAAI,EAAE,SAAS,CAAC;CAChB;AAED,MAAM,WAAW,aAAa,CAAE,IAAI,CAAG,SAAQ,aAAa,CAAE,IAAI,CAAE;IACnE,IAAI,EAAE,QAAQ,CAAC;CACf;AAED,MAAM,WAAW,aAAa,CAAE,IAAI,CAAG,SAAQ,aAAa,CAAE,IAAI,CAAE;IACnE,IAAI,EAAE,QAAQ,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB,CAAE,IAAI,CACzC,SAAQ,IAAI,CAAE,mBAAmB,CAAE,IAAI,CAAE,EAAE,MAAM,CAAE;IACnD,IAAI,EAAE,cAAc,CAAC;CACrB;AAED,MAAM,MAAM,SAAS,CAAE,IAAI,IACxB,cAAc,CAAE,IAAI,CAAE,GACtB,aAAa,CAAE,IAAI,CAAE,GACrB,aAAa,CAAE,IAAI,CAAE,CAAC;AAEzB,MAAM,MAAM,eAAe,CAAE,IAAI,IAAK,mBAAmB,CAAE,IAAI,CAAE,CAAC;AAElE,MAAM,WAAW,gBAAgB;IAChC,IAAI,CAAC,EAAE,IAAI,CAAE,QAAQ,EAAE,MAAM,CAAE,CAAC;IAChC,IAAI,CAAC,EAAE,IAAI,CAAE,QAAQ,EAAE,MAAM,CAAE,CAAC;IAChC,KAAK,CAAC,EAAE,IAAI,CAAE,SAAS,EAAE,MAAM,CAAE,CAAC;IAClC,UAAU,CAAC,EAAE,IAAI,CAAE,cAAc,EAAE,MAAM,CAAE,CAAC;CAC5C"}