@firecms/core 3.0.0-alpha.72 → 3.0.0-alpha.74

package/dist/components/{EntityCollectionTable/internal/DeleteEntityDialog.d.ts → DeleteEntityDialog.d.ts}

@@ -1,4 +1,4 @@
-import { Entity, EntityCallbacks, EntityCollection } from "../../../types";
+import { Entity, EntityCallbacks, EntityCollection } from "../types";
 export interface DeleteEntityDialogProps<M extends Record<string, any>> {
     entityOrEntitiesToDelete?: Entity<M> | Entity<M>[];
     path: string;

package/dist/components/EntityCollectionTable/{internal/EntityCollectionRowActions.d.ts → EntityCollectionRowActions.d.ts}

@@ -1,5 +1,5 @@
 import React from "react";
-import { CollectionSize, Entity, EntityAction, EntityCollection, SelectionController } from "../../../types";
+import { CollectionSize, Entity, EntityAction, EntityCollection, SelectionController } from "../../types";
 /**
  *
  * @param entity
@@ -19,12 +19,12 @@ import { CollectionSize, Entity, EntityAction, EntityCollection, SelectionContro
  */
 export declare const EntityCollectionRowActions: React.NamedExoticComponent<{
     entity: Entity<any>;
-    collection?: EntityCollection<any, import("../../../types").User> | undefined;
+    collection?: EntityCollection<any, import("../../types").User> | undefined;
     fullPath?: string | undefined;
     width: number;
     frozen?: boolean | undefined;
     size: CollectionSize;
-    isSelected: boolean;
+    isSelected?: boolean | undefined;
     selectionEnabled?: boolean | undefined;
     actions?: EntityAction[] | undefined;
     hideId?: boolean | undefined;

package/dist/components/EntityCollectionTable/EntityCollectionTable.d.ts

@@ -18,7 +18,7 @@ export declare const useEntityCollectionTableController: () => EntityCollectionT
  * options you see in collections in the top level navigation, you can
  * check {@link EntityCollectionView}.
  *
- * The data displayed in the table is managed by a {@link TableController}.
+ * The data displayed in the table is managed by a {@link EntityTableController}.
  * You can build the default, bound to a path in the datasource, by using the hook
  * {@link useDataSourceEntityCollectionTableController}
  *

package/dist/components/EntityCollectionTable/EntityCollectionTableProps.d.ts

@@ -1,5 +1,5 @@
 import React from "react";
-import { AdditionalFieldDelegate, CollectionSize, Entity, FilterValues, ResolvedProperties, ResolvedProperty, SelectionController, TableController, User } from "../../types";
+import { AdditionalFieldDelegate, CollectionSize, Entity, FilterValues, ResolvedProperties, ResolvedProperty, SelectionController, EntityTableController, User } from "../../types";
 import { OnCellValueChange, UniqueFieldValidator } from "./types";
 /**
  * @group Collection components
@@ -69,9 +69,9 @@ export type EntityCollectionTableProps<M extends Record<string, any>, UserType e
     /**
      * Controller holding the logic for the table
      * {@link useDataSourceEntityCollectionTableController}
-     * {@link TableController}
+     * {@link EntityTableController}
      */
-    tableController: TableController<M>;
+    tableController: EntityTableController<M>;
     displayedColumnIds: PropertyColumnConfig[];
     forceFilter?: FilterValues<Extract<keyof M, string>>;
     textSearchEnabled?: boolean;

package/dist/components/EntityCollectionTable/{internal/PropertyTableCell.d.ts → PropertyTableCell.d.ts}

@@ -1,6 +1,6 @@
 import React from "react";
-import { CMSType, Entity, ResolvedProperty } from "../../../types";
-import { CustomFieldValidator } from "../../../form/validation";
+import { CMSType, Entity, ResolvedProperty } from "../../types";
+import { CustomFieldValidator } from "../../form/validation";
 export interface PropertyTableCellProps<T extends CMSType, M extends Record<string, any>> {
     propertyKey: string;
     columnIndex: number;

package/dist/components/EntityCollectionTable/SimpleEntityCollectionTable.d.ts

@@ -0,0 +1,95 @@
+import React from "react";
+import { CollectionSize, Entity, EntityTableController, FilterValues } from "../../types";
+import { CellRendererParams, VirtualTableColumn } from "../VirtualTable";
+import { OnCellValueChange } from "./types";
+import { OnColumnResizeParams } from "./EntityCollectionTableProps";
+export type SimpleEntityCollectionTableProps<M extends Record<string, any>> = {
+    /**
+     * List of entities that will be displayed as selected;
+     */
+    highlightedEntities?: Entity<M>[];
+    /**
+     * Override the title in the toolbar
+     */
+    title?: React.ReactNode;
+    /**
+     * Callback when a cell value changes.
+     */
+    onValueChange?: OnCellValueChange<any, M>;
+    columns: VirtualTableColumn[];
+    cellRenderer: React.ComponentType<CellRendererParams<Entity<M>>>;
+    /**
+     * Builder for creating the buttons in each row
+     * @param entity
+     * @param size
+     */
+    tableRowActionsBuilder?: (params: {
+        entity: Entity<M>;
+        size: CollectionSize;
+        width: number;
+        frozen?: boolean;
+    }) => React.ReactNode;
+    /**
+     * Callback when anywhere on the table is clicked
+     */
+    onEntityClick?(entity: Entity<M>): void;
+    /**
+     * Callback when a column is resized
+     */
+    onColumnResize?(params: OnColumnResizeParams): void;
+    /**
+     * Callback when the selected size of the table is changed
+     */
+    onSizeChanged?(size: CollectionSize): void;
+    /**
+     * Should apply a different style to a row when hovering
+     */
+    hoverRow?: boolean;
+    /**
+     * Additional component that renders actions such as buttons in the
+     * collection toolbar, displayed on the left side
+     */
+    actionsStart?: React.ReactNode;
+    /**
+     * Additional component that renders actions such as buttons in the
+     * collection toolbar, displayed on the right side
+     */
+    actions?: React.ReactNode;
+    /**
+     * Controller holding the logic for the table
+     * {@link useDataSourceEntityCollectionTableController}
+     * {@link EntityTableController}
+     */
+    tableController: EntityTableController<M>;
+    filterable?: boolean;
+    sortable?: boolean;
+    inlineEditing?: boolean;
+    textSearchEnabled?: boolean;
+    emptyComponent?: React.ReactNode;
+    forceFilter?: FilterValues<keyof M extends string ? keyof M : never>;
+};
+/**
+ * This component is in charge of rendering a collection table with a high
+ * degree of customization.
+ *
+ * This component is used internally by {@link EntityCollectionView} and
+ * {@link useReferenceDialog}
+ *
+ * Please note that you only need to use this component if you are building
+ * a custom view. If you just need to create a default view you can do it
+ * exclusively with config options.
+ *
+ * If you want to bind a {@link EntityCollection} to a table with the default
+ * options you see in collections in the top level navigation, you can
+ * check {@link EntityCollectionView}.
+ *
+ * The data displayed in the table is managed by a {@link EntityTableController}.
+ * You can build the default, bound to a path in the datasource, by using the hook
+ * {@link useDataSourceEntityCollectionTableController}
+ *
+ * @see EntityCollectionTableProps
+ * @see EntityCollectionView
+ * @see VirtualTable
+ * @group Components
+ */
+export declare const SimpleEntityCollectionTable: React.NamedExoticComponent<SimpleEntityCollectionTableProps<any>>;

package/dist/components/EntityCollectionTable/column_utils.d.ts

@@ -0,0 +1,16 @@
+import React from "react";
+import { FilterValues, ResolvedProperties, ResolvedProperty } from "../../types";
+import { VirtualTableColumn } from "../VirtualTable";
+export declare function buildIdColumn(largeLayout?: boolean): VirtualTableColumn;
+export interface PropertiesToColumnsParams<M extends Record<string, any>> {
+    properties: ResolvedProperties<M>;
+    sortable?: boolean;
+    forceFilter?: FilterValues<keyof M extends string ? keyof M : never>;
+    disabledFilter?: boolean;
+    AdditionalHeaderWidget?: (props: {
+        property: ResolvedProperty;
+        propertyKey: string;
+        onHover: boolean;
+    }) => React.ReactNode;
+}
+export declare function propertiesToColumns<M extends Record<string, any>>({ properties, sortable, forceFilter, disabledFilter, AdditionalHeaderWidget }: PropertiesToColumnsParams<M>): VirtualTableColumn[];

package/dist/components/EntityCollectionTable/index.d.ts

@@ -1,4 +1,8 @@
 export { EntityCollectionTable } from "./EntityCollectionTable";
 export type { EntityCollectionTableProps, OnColumnResizeParams } from "./EntityCollectionTableProps";
 export type { UniqueFieldValidator, OnCellValueChange, OnCellValueChangeParams } from "./types";
+export * from "./PropertyTableCell";
+export * from "./SimpleEntityCollectionTable";
+export * from "./EntityCollectionRowActions";
 export * from "./useDataSourceEntityCollectionTableController";
+export * from "./column_utils";

package/dist/components/EntityCollectionTable/internal/CollectionTableToolbar.d.ts

@@ -4,7 +4,7 @@ interface CollectionTableToolbarProps {
     size: CollectionSize;
     filterIsSet: boolean;
     loading: boolean;
-    forceFilter: boolean;
+    forceFilter?: boolean;
     actionsStart?: React.ReactNode;
     actions?: React.ReactNode;
     title?: React.ReactNode;

package/dist/components/EntityCollectionTable/internal/popup_field/PopupFormField.d.ts

@@ -16,7 +16,7 @@ interface PopupFormFieldProps<M extends Record<string, any>> {
      * Callback when the value of a cell has been edited
      * @param params
      */
-    onCellValueChange?: (params: OnCellValueChangeParams<any, M>) => Promise<void>;
+    onCellValueChange?: (params: OnCellValueChangeParams<any, M>) => Promise<void> | void;
 }
 export declare function PopupFormField<M extends Record<string, any>>(props: PopupFormFieldProps<M>): import("react/jsx-runtime").JSX.Element | null;
 export declare function PopupFormFieldInternal<M extends Record<string, any>>({ tableKey, entity: entityProp, customFieldValidator, propertyKey, collection: inputCollection, path, cellRect, open, onClose, onCellValueChange, container }: PopupFormFieldProps<M>): import("react/jsx-runtime").JSX.Element;

package/dist/components/EntityCollectionTable/types.d.ts

@@ -28,7 +28,7 @@ export type EntityCollectionTableController<M extends Record<string, any>> = {
  * Props passed in a callback when the content of a cell in a table has been edited
  * @group Collection components
  */
-export interface OnCellValueChangeParams<T, M extends Record<string, any>> {
+export interface OnCellValueChangeParams<T = any, M extends Record<string, any> = any> {
     value: T;
     propertyKey: string;
     entity: Entity<M>;
@@ -50,4 +50,4 @@ export type UniqueFieldValidator = (props: {
  * Callback when a cell has changed in a table
  * @group Collection components
  */
-export type OnCellValueChange<T, M extends Record<string, any>> = (params: OnCellValueChangeParams<T, M>) => Promise<void>;
+export type OnCellValueChange<T, M extends Record<string, any>> = (params: OnCellValueChangeParams<T, M>) => Promise<void> | void;

package/dist/components/EntityCollectionTable/useDataSourceEntityCollectionTableController.d.ts

@@ -1,4 +1,4 @@
-import { Entity, EntityCollection, FilterValues, TableController, User } from "../../types";
+import { Entity, EntityCollection, FilterValues, EntityTableController, User } from "../../types";
 export type DataSourceEntityCollectionTableControllerProps<M extends Record<string, any> = any> = {
     /**
      * Full path where the data of this table is located
@@ -20,7 +20,7 @@ export type DataSourceEntityCollectionTableControllerProps<M extends Record<stri
  * Use this hook to build a controller for the {@link EntityCollectionTable}.
  * This controller is bound to data in a path in your specified datasource.
  *
- * Note that you can build your own hook returning a {@link TableController}
+ * Note that you can build your own hook returning a {@link EntityTableController}
  * if you would like to display different data.
  *
  * @param fullPath
@@ -29,4 +29,4 @@ export type DataSourceEntityCollectionTableControllerProps<M extends Record<stri
  * @param lastDeleteTimestamp
  * @param forceFilterFromProps
  */
-export declare function useDataSourceEntityCollectionTableController<M extends Record<string, any> = any, UserType extends User = User>({ fullPath, collection, entitiesDisplayedFirst, lastDeleteTimestamp, forceFilter: forceFilterFromProps, }: DataSourceEntityCollectionTableControllerProps<M>): TableController<M>;
+export declare function useDataSourceEntityCollectionTableController<M extends Record<string, any> = any, UserType extends User = User>({ fullPath, collection, entitiesDisplayedFirst, lastDeleteTimestamp, forceFilter: forceFilterFromProps, }: DataSourceEntityCollectionTableControllerProps<M>): EntityTableController<M>;

package/dist/components/EntityCollectionView/EntityCollectionViewActions.d.ts

@@ -1,4 +1,4 @@
-import { EntityCollection, SelectionController, TableController } from "../../types";
+import { EntityCollection, SelectionController, EntityTableController } from "../../types";
 export type EntityCollectionViewActionsProps<M extends Record<string, any>> = {
     collection: EntityCollection<M>;
     path: string;
@@ -8,7 +8,7 @@ export type EntityCollectionViewActionsProps<M extends Record<string, any>> = {
     onNewClick: () => void;
     onMultipleDeleteClick: () => void;
     selectionController: SelectionController<M>;
-    tableController: TableController<M>;
+    tableController: EntityTableController<M>;
     collectionEntitiesCount: number;
 };
 export declare function EntityCollectionViewActions<M extends Record<string, any>>({ collection, relativePath, parentCollectionIds, onNewClick, onMultipleDeleteClick, selectionEnabled, path, selectionController, tableController, collectionEntitiesCount }: EntityCollectionViewActionsProps<M>): import("react/jsx-runtime").JSX.Element;

package/dist/components/VirtualTable/VirtualTableCell.d.ts

@@ -8,7 +8,7 @@ type VirtualTableCellProps<T extends any> = {
     cellData: any;
     rowIndex: any;
     columnIndex: number;
-    cellRenderer: (params: CellRendererParams<T>) => React.ReactNode;
+    cellRenderer: React.ComponentType<CellRendererParams<T>>;
 };
 export declare const VirtualTableCell: React.NamedExoticComponent<VirtualTableCellProps<any>>;
 export {};

package/dist/components/VirtualTable/VirtualTableProps.d.ts

@@ -24,7 +24,7 @@ export interface VirtualTableProps<T extends Record<string, any>> {
      * Custom cell renderer
      * The renderer receives props `{ cellData, columns, column, columnIndex, rowData, rowIndex, container, isScrolling }`
      */
-    cellRenderer: (params: CellRendererParams<T>) => React.ReactNode;
+    cellRenderer: React.ComponentType<CellRendererParams<T>>;
     /**
      * If enabled, content is loaded in batch
      */
@@ -116,8 +116,7 @@ export interface VirtualTableProps<T extends Record<string, any>> {
      */
     AddColumnComponent?: React.ComponentType;
 }
-export type CellRendererParams<T extends any> = {
-    cellData?: any;
+export type CellRendererParams<T extends any = any> = {
     column: VirtualTableColumn;
     columns: VirtualTableColumn[];
     columnIndex: number;

package/dist/components/VirtualTable/types.d.ts

@@ -16,7 +16,7 @@ export type VirtualTableContextProps<T extends any> = {
     data?: T[];
     size?: VirtualTableSize;
     columns: VirtualTableColumn[];
-    cellRenderer: (params: CellRendererParams<T>) => React.ReactNode;
+    cellRenderer: React.ComponentType<CellRendererParams<T>>;
     currentSort: "asc" | "desc" | undefined;
     filter?: VirtualTableFilterValues<any>;
     onRowClick?: (props: OnRowClickParams<any>) => void;

package/dist/form/components/FieldHelperText.d.ts

@@ -4,7 +4,7 @@ import { ResolvedProperty } from "../../types";
  * as well as the error message if any.
  */
 export declare function FieldHelperText({ error, showError, property, includeDescription, disabled }: {
-    error: string;
+    error?: string;
     showError: boolean;
     property: ResolvedProperty;
     includeDescription?: boolean;