@firecms/core 3.0.0-beta.6 → 3.0.0-beta.7

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

@@ -24,4 +24,4 @@ import { EntityCollectionTableProps } from "./EntityCollectionTableProps";
  * @see VirtualTable
  * @group Components
  */
-export declare const EntityCollectionTable: <M extends Record<string, any>, UserType extends User>({ forceFilter, actionsStart, actions, title, tableRowActionsBuilder, uniqueFieldValidator, getPropertyFor, onValueChange, selectionController, highlightedEntities, onEntityClick, onColumnResize, onSizeChanged, textSearchEnabled, hoverRow, inlineEditing, additionalFields, displayedColumnIds, defaultSize, properties, tableController, filterable, sortable, endAdornment, AddColumnComponent, AdditionalHeaderWidget, additionalIDHeaderWidget, emptyComponent, getIdColumnWidth, onTextSearchClick, textSearchLoading }: EntityCollectionTableProps<M>) => import("react/jsx-runtime").JSX.Element;
+export declare const EntityCollectionTable: <M extends Record<string, any>, UserType extends User>({ className, style, forceFilter, actionsStart, actions, title, tableRowActionsBuilder, uniqueFieldValidator, getPropertyFor, onValueChange, selectionController, highlightedEntities, onEntityClick, onColumnResize, onSizeChanged, textSearchEnabled, hoverRow, inlineEditing, additionalFields, displayedColumnIds, defaultSize, properties, tableController, filterable, sortable, endAdornment, AddColumnComponent, AdditionalHeaderWidget, additionalIDHeaderWidget, emptyComponent, getIdColumnWidth, onTextSearchClick, textSearchLoading, enablePopupIcon }: EntityCollectionTableProps<M>) => import("react/jsx-runtime").JSX.Element;

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

@@ -5,6 +5,8 @@ import { OnCellValueChange, OnColumnResizeParams, UniqueFieldValidator } from ".
  * @group Collection components
  */
 export type EntityCollectionTableProps<M extends Record<string, any>, UserType extends User = User> = {
+    className?: string;
+    style?: React.CSSProperties;
     /**
      * Display these entities as selected
      */
@@ -87,13 +89,13 @@ export type EntityCollectionTableProps<M extends Record<string, any>, UserType e
     getIdColumnWidth?: () => number;
     onTextSearchClick?: () => void;
     textSearchLoading?: boolean;
+    enablePopupIcon: boolean;
 };
 export type GetPropertyForProps<M extends Record<string, any>> = {
     propertyKey: string;
-    propertyValue: any;
     entity: Entity<M>;
 };
 export type PropertyColumnConfig = {
     key: string;
-    disabled: boolean;
+    disabled?: boolean;
 };

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

@@ -14,5 +14,6 @@ export interface PropertyTableCellProps<T extends CMSType> {
     entity: Entity<any>;
     path: string;
     disabled: boolean;
+    enablePopupIcon?: boolean;
 }
 export declare const PropertyTableCell: React.FunctionComponent<PropertyTableCellProps<any>>;

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

@@ -6,11 +6,10 @@ 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?: React.ComponentType<{
         property: ResolvedProperty;
         propertyKey: string;
         onHover: boolean;
     }>;
 }
-export declare function propertiesToColumns<M extends Record<string, any>>({ properties, sortable, forceFilter, disabledFilter, AdditionalHeaderWidget }: PropertiesToColumnsParams<M>): VirtualTableColumn[];
+export declare function propertiesToColumns<M extends Record<string, any>>({ properties, sortable, forceFilter, AdditionalHeaderWidget }: PropertiesToColumnsParams<M>): VirtualTableColumn[];

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

@@ -11,6 +11,8 @@ type TableReferenceFieldProps = {
     title?: string;
     path: string;
     forceFilter?: FilterValues<string>;
+    includeId?: boolean;
+    includeEntityLink?: boolean;
 };
 export declare function TableReferenceField(props: TableReferenceFieldProps): import("react/jsx-runtime").JSX.Element;
 export declare const TableReferenceFieldSuccess: React.NamedExoticComponent<TableReferenceFieldProps & {

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

@@ -1,5 +1,5 @@
 import React from "react";
-import { VirtualTableSize } from "../../VirtualTable";
+import { TableSize } from "../../common/table_height";
 interface EntityTableCellProps {
     children: React.ReactNode;
     actions?: React.ReactNode;
@@ -12,7 +12,7 @@ interface EntityTableCellProps {
     error?: Error;
     allowScroll?: boolean;
     align: "right" | "left" | "center";
-    size: VirtualTableSize;
+    size: TableSize;
     disabledTooltip?: string;
     width: number;
     showExpandIcon?: boolean;

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> | void;
+    onCellValueChange?: (params: OnCellValueChangeParams<any, any>) => 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/EntityPreview.d.ts

@@ -9,14 +9,15 @@ export type EntityPreviewProps = {
     previewProperties?: string[];
     disabled: undefined | boolean;
     entity: Entity<any>;
-    includeEntityNavigation?: boolean;
+    includeId?: boolean;
+    includeEntityLink?: boolean;
     onClick?: (e: React.SyntheticEvent) => void;
 };
 /**
  * This view is used to display a preview of an entity.
  * It is used by default in reference fields and whenever a reference is displayed.
  */
-export declare function EntityPreview({ actions, disabled, hover, collection: collectionProp, previewProperties, onClick, size, includeEntityNavigation, entity }: EntityPreviewProps): import("react/jsx-runtime").JSX.Element;
+export declare function EntityPreview({ actions, disabled, hover, collection: collectionProp, previewProperties, onClick, size, includeId, includeEntityLink, entity }: EntityPreviewProps): import("react/jsx-runtime").JSX.Element;
 export type EntityPreviewContainerProps = {
     children: React.ReactNode;
     hover?: boolean;

package/dist/components/FireCMSAppBar.d.ts

@@ -1,7 +1,7 @@
 import React from "react";
 import { User } from "../types";
 export type FireCMSAppBarProps<ADDITIONAL_PROPS = object> = {
-    title: string;
+    title?: React.ReactNode;
     /**
      * A component that gets rendered on the upper side of the main toolbar
      */
@@ -9,9 +9,11 @@ export type FireCMSAppBarProps<ADDITIONAL_PROPS = object> = {
     startAdornment?: React.ReactNode;
     dropDownActions?: React.ReactNode;
     includeDrawer?: boolean;
+    includeModeToggle?: boolean;
     drawerOpen: boolean;
     className?: string;
     style?: React.CSSProperties;
+    logo?: string;
     user?: User;
 } & ADDITIONAL_PROPS;
 /**
@@ -23,4 +25,4 @@ export type FireCMSAppBarProps<ADDITIONAL_PROPS = object> = {
  * @param drawerOpen
  * @constructor
  */
-export declare const FireCMSAppBar: ({ title, endAdornment, startAdornment, drawerOpen, dropDownActions, includeDrawer, className, style, user: userProp }: FireCMSAppBarProps) => import("react/jsx-runtime").JSX.Element;
+export declare const FireCMSAppBar: ({ title, endAdornment, startAdornment, drawerOpen, dropDownActions, includeDrawer, includeModeToggle, className, style, logo, user: userProp }: FireCMSAppBarProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/ReferenceWidget.d.ts

@@ -21,8 +21,10 @@ export type ReferenceWidgetProps<M extends Record<string, any>> = {
     forceFilter?: FilterValues<string>;
     size: PreviewSize;
     className?: string;
+    includeId?: boolean;
+    includeEntityLink?: boolean;
 };
 /**
  * This field allows selecting reference/s.
  */
-export declare function ReferenceWidget<M extends Record<string, any>>({ name, multiselect, path, disabled, value, onReferenceSelected, onMultipleReferenceSelected, previewProperties, forceFilter, size, className }: ReferenceWidgetProps<M>): import("react/jsx-runtime").JSX.Element;
+export declare function ReferenceWidget<M extends Record<string, any>>({ name, multiselect, path, disabled, value, onReferenceSelected, onMultipleReferenceSelected, previewProperties, forceFilter, size, className, includeId, includeEntityLink }: ReferenceWidgetProps<M>): import("react/jsx-runtime").JSX.Element;

package/dist/components/SelectableTable/filters/ReferenceFilterField.d.ts

@@ -6,9 +6,10 @@ interface ReferenceFilterFieldProps {
     isArray?: boolean;
     path?: string;
     title?: string;
+    includeId?: boolean;
     previewProperties?: string[];
     hidden: boolean;
     setHidden: (hidden: boolean) => void;
 }
-export declare function ReferenceFilterField({ name, value, setValue, isArray, path, title, previewProperties, setHidden }: ReferenceFilterFieldProps): import("react/jsx-runtime").JSX.Element;
+export declare function ReferenceFilterField({ name, value, setValue, isArray, path, title, includeId, previewProperties, setHidden }: ReferenceFilterFieldProps): import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -56,7 +56,7 @@ export interface VirtualTableProps<T extends Record<string, any>> {
     /**
      * Size of the table
      */
-    size?: VirtualTableSize;
+    rowHeight?: number;
     /**
      * In case this table should have some filters set by default
      */
@@ -190,11 +190,6 @@ export type OnVirtualTableColumnResizeParams = {
     key: string;
     column: VirtualTableColumn;
 };
-/**
- * @see Table
- * @group Components
- */
-export type VirtualTableSize = "xs" | "s" | "m" | "l" | "xl";
 /**
  * @see Table
  * @group Components

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

@@ -1,9 +1,9 @@
 import React from "react";
-import { CellRendererParams, OnRowClickParams, OnVirtualTableColumnResizeParams, VirtualTableColumn, VirtualTableFilterValues, VirtualTableSize, VirtualTableWhereFilterOp } from "./VirtualTableProps";
+import { CellRendererParams, OnRowClickParams, OnVirtualTableColumnResizeParams, VirtualTableColumn, VirtualTableFilterValues, VirtualTableWhereFilterOp } from "./VirtualTableProps";
 import { FilterFormFieldProps } from "./VirtualTableHeader";
 export type VirtualTableRowProps<T> = {
     style: any;
-    size: VirtualTableSize;
+    rowHeight: number;
     rowData: T;
     rowIndex: number;
     onRowClick?: (props: OnRowClickParams<any>) => void;
@@ -14,7 +14,7 @@ export type VirtualTableRowProps<T> = {
 };
 export type VirtualTableContextProps<T extends any> = {
     data?: T[];
-    size?: VirtualTableSize;
+    rowHeight?: number;
     columns: VirtualTableColumn[];
     cellRenderer: React.ComponentType<CellRendererParams<T>>;
     currentSort: "asc" | "desc" | undefined;

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

@@ -1,4 +1,4 @@
-import { EntityAction } from "../../../types";
+import { EntityAction } from "../../types";
 export declare const editEntityAction: EntityAction;
 export declare const copyEntityAction: EntityAction;
 export declare const archiveEntityAction: EntityAction;

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

@@ -3,3 +3,4 @@ export * from "./useDebouncedData";
 export * from "./useColumnsIds";
 export * from "./useDataSourceEntityCollectionTableController";
 export * from "./useTableSearchHelper";
+export * from "./default_entity_actions";

package/dist/components/common/table_height.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @group Components
+ */
+export type TableSize = "xs" | "s" | "m" | "l" | "xl";
+export declare function getRowHeight(size: TableSize): number;

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

@@ -1,4 +1,4 @@
-import { CollectionSize, Entity, FireCMSContext, ResolvedProperty, SelectedCellProps } from "../../types";
+import { CollectionSize, ResolvedProperty, SelectedCellProps } from "../../types";
 export type EntityCollectionTableController<M extends Record<string, any>> = {
     /**
      * This cell is displayed as selected
@@ -28,14 +28,12 @@ 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 = any, M extends Record<string, any> = any> {
+export interface OnCellValueChangeParams<T = any, D = any> {
     value: T;
     propertyKey: string;
-    entity: Entity<M>;
+    data?: D;
     onValueUpdated: () => void;
     setError: (e: Error | undefined) => void;
-    fullPath: string;
-    context: FireCMSContext;
 }
 /**
  * @group Collection components

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

@@ -14,6 +14,9 @@ export type DataSourceEntityCollectionTableControllerProps<M extends Record<stri
      */
     entitiesDisplayedFirst?: Entity<M>[];
     lastDeleteTimestamp?: number;
+    /**
+     * Force filter to be applied to the table.
+     */
     forceFilter?: FilterValues<string>;
 };
 /**

package/dist/components/index.d.ts

@@ -8,6 +8,7 @@ export { CircularProgressCenter } from "./CircularProgressCenter";
 export * from "./common";
 export * from "./HomePage";
 export * from "./SelectableTable/SelectableTable";
+export * from "./SelectableTable/SelectableTableContext";
 export * from "./EntityCollectionView/EntityCollectionView";
 export * from "./EntityCollectionView/EntityCollectionViewActions";
 export * from "./EntityCollectionView/useSelectionController";

package/dist/core/Drawer.d.ts

@@ -1,23 +1,16 @@
-import React from "react";
 /**
  * Props used in case you need to override the default drawer
  * @group Core
  */
-export type DrawerProps<T = {}> = T & {
+export type DrawerProps = {
     hovered: boolean;
     drawerOpen: boolean;
-    closeDrawer: () => any;
+    openDrawer: () => void;
+    closeDrawer: () => void;
+    autoOpenDrawer?: boolean;
 };
 /**
  * Default drawer used in the CMS
  * @group Core
  */
-export declare function Drawer({ hovered, drawerOpen, closeDrawer }: DrawerProps): import("react/jsx-runtime").JSX.Element;
-export declare function DrawerNavigationItem({ name, icon, drawerOpen, tooltipsOpen, url, onClick }: {
-    icon: React.ReactElement;
-    name: string;
-    tooltipsOpen: boolean;
-    drawerOpen: boolean;
-    url: string;
-    onClick?: () => void;
-}): import("react/jsx-runtime").JSX.Element;
+export declare function Drawer(): import("react/jsx-runtime").JSX.Element;

package/dist/core/DrawerNavigationItem.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+export declare function DrawerNavigationItem({ name, icon, drawerOpen, tooltipsOpen, url, onClick }: {
+    icon: React.ReactElement;
+    name: string;
+    tooltipsOpen: boolean;
+    drawerOpen: boolean;
+    url: string;
+    onClick?: () => void;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/core/NavigationRoutes.d.ts

@@ -6,7 +6,7 @@ export type NavigationRoutesProps = {
     /**
      * In case you need to override the home page
      */
-    HomePage?: React.ComponentType;
+    homePage?: React.ReactNode;
     customRoutes?: React.ReactNode[];
 };
 /**

package/dist/core/Scaffold.d.ts

@@ -2,14 +2,15 @@ import React from "react";
 import { DrawerProps } from "./Drawer";
 import { FireCMSAppBarProps } from "../components";
 export declare const DRAWER_WIDTH = 280;
+export declare function useDrawer(): DrawerProps;
 /**
  * @group Core
  */
-export interface ScaffoldProps<ExtraDrawerProps = object, ExtraAppbarProps = object> {
+export interface ScaffoldProps<ExtraAppbarProps = object> {
     /**
      * Name of the app, displayed as the main title and in the tab title
      */
-    name: string;
+    name?: React.ReactNode;
     /**
      * Logo to be displayed in the drawer of the CMS
      */
@@ -19,21 +20,16 @@ export interface ScaffoldProps<ExtraDrawerProps = object, ExtraAppbarProps = obj
      */
     includeDrawer?: boolean;
     /**
-     * In case you need to override the view that gets rendered as a drawer
-     * @see DefaultDrawer
+     * You can define a custom drawer to be displayed in the scaffold.
+     * Use the hook `useDrawer` to access the context values.
      */
-    Drawer?: React.ComponentType<DrawerProps<ExtraDrawerProps>>;
-    /**
-     * Additional props passed to the custom Drawer
-     */
-    drawerProps?: Partial<DrawerProps> & ExtraDrawerProps;
+    drawer?: React.ReactNode;
     /**
      * Open the drawer on hover
      */
     autoOpenDrawer?: boolean;
     /**
-     * A component that gets rendered on the upper side of the main toolbar.
-     * `toolbarExtraWidget` has no effect if this is set.
+     * The AppBar component to be used in the scaffold.
      */
     FireCMSAppBar?: React.ComponentType<FireCMSAppBarProps<ExtraAppbarProps>>;
     /**
@@ -52,4 +48,4 @@ export interface ScaffoldProps<ExtraDrawerProps = object, ExtraAppbarProps = obj
  * @constructor
  * @group Core
  */
-export declare const Scaffold: React.NamedExoticComponent<React.PropsWithChildren<ScaffoldProps<object, object>>>;
+export declare const Scaffold: React.NamedExoticComponent<React.PropsWithChildren<ScaffoldProps<object>>>;

package/dist/core/index.d.ts

@@ -1,8 +1,7 @@
 export * from "./FireCMS";
-export type { ScaffoldProps } from "./Scaffold";
-export { Scaffold } from "./Scaffold";
-export type { DrawerProps } from "./Drawer";
-export { Drawer, DrawerNavigationItem } from "./Drawer";
+export * from "./Scaffold";
+export * from "./Drawer";
+export * from "./DrawerNavigationItem";
 export * from "./field_configs";
 export * from "./SideDialogs";
 export * from "./NavigationRoutes";

package/dist/hooks/data/save.d.ts

@@ -1,9 +1,8 @@
-import { DataSource, Entity, EntityCallbacks, EntityCollection, FireCMSContext, SaveEntityProps, User } from "../../types";
+import { DataSource, Entity, EntityCollection, FireCMSContext, SaveEntityProps, User } from "../../types";
 /**
  * @group Hooks and utilities
  */
 export type SaveEntityWithCallbacksProps<M extends Record<string, any>> = SaveEntityProps<M> & {
-    callbacks?: EntityCallbacks<M>;
     onSaveSuccess?: (updatedEntity: Entity<M>) => void;
     onSaveFailure?: (e: Error) => void;
     onPreSaveHookError?: (e: Error) => void;

package/dist/hooks/index.d.ts

@@ -7,6 +7,7 @@ export * from "./useNavigationController";
 export * from "./useResolvedNavigationFrom";
 export * from "./useStorageSource";
 export * from "./useAuthController";
+export * from "./useDialogsController";
 export * from "./useSideDialogsController";
 export * from "./useSideEntityController";
 export * from "./useFireCMSContext";