@firecms/core 3.0.0-beta.10 → 3.0.0-beta.12

package/dist/components/ArrayContainer.d.ts

@@ -1,10 +1,18 @@
 import React from "react";
 import { DraggableProvided } from "@hello-pangea/dnd";
-interface ArrayContainerProps<T> {
+export type ArrayEntryParams = {
+    index: number;
+    internalId: number;
+    isDragging: boolean;
+    storedProps?: object;
+    storeProps: (props: object) => void;
+};
+export type ArrayEntryBuilder = (params: ArrayEntryParams) => React.ReactNode;
+export interface ArrayContainerProps<T> {
     droppableId: string;
     value: T[];
     addLabel: string;
-    buildEntry: (index: number, internalId: number) => React.ReactNode;
+    buildEntry: ArrayEntryBuilder;
     disabled?: boolean;
     size?: "small" | "medium";
     onInternalIdAdded?: (id: number) => void;
@@ -12,30 +20,38 @@ interface ArrayContainerProps<T> {
     newDefaultEntry: T;
     onValueChange: (value: T[]) => void;
     className?: string;
+    min?: number;
+    max?: number;
 }
 /**
  * @group Form custom fields
  */
-export declare function ArrayContainer<T>({ droppableId, addLabel, value, disabled, buildEntry, size, onInternalIdAdded, includeAddButton, newDefaultEntry, onValueChange, className }: ArrayContainerProps<T>): import("react/jsx-runtime").JSX.Element;
+export declare function ArrayContainer<T>({ droppableId, addLabel, value, disabled, buildEntry, size, onInternalIdAdded, includeAddButton, newDefaultEntry, onValueChange, className, min, max }: ArrayContainerProps<T>): import("react/jsx-runtime").JSX.Element;
 type ArrayContainerItemProps = {
     provided: DraggableProvided;
     index: number;
     internalId: number;
     size?: "small" | "medium";
     disabled: boolean;
-    buildEntry: (index: number, internalId: number) => React.ReactNode;
+    buildEntry: ArrayEntryBuilder;
     remove: (index: number) => void;
     copy: (index: number) => void;
+    addInIndex?: (index: number) => void;
+    includeAddButton?: boolean;
     isDragging: boolean;
+    storedProps?: object;
+    updateItemCustomProps: (internalId: number, props: object) => void;
 };
-export declare function ArrayContainerItem({ provided, index, internalId, size, disabled, buildEntry, remove, copy, isDragging }: ArrayContainerItemProps): import("react/jsx-runtime").JSX.Element;
-export declare function ArrayItemOptions({ direction, disabled, remove, index, provided, copy, }: {
+export declare function ArrayContainerItem({ provided, index, internalId, size, disabled, buildEntry, remove, addInIndex, includeAddButton, copy, isDragging, storedProps, updateItemCustomProps }: ArrayContainerItemProps): import("react/jsx-runtime").JSX.Element;
+export declare function ArrayItemOptions({ direction, disabled, remove, index, provided, copy, includeAddButton, addInIndex }: {
     direction?: "row" | "column";
     disabled: boolean;
     remove: (index: number) => void;
     index: number;
     provided: any;
     copy: (index: number) => void;
+    includeAddButton?: boolean;
+    addInIndex?: (index: number) => void;
 }): import("react/jsx-runtime").JSX.Element;
 export declare function getRandomId(): number;
 export {};

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

@@ -12,7 +12,7 @@ import { CollectionSize, Entity, EntityAction, EntityCollection, SelectionContro
  *
  * @group Collection components
  */
-export declare const EntityCollectionRowActions: ({ entity, collection, fullPath, width, frozen, isSelected, selectionEnabled, size, highlightEntity, onCollectionChange, unhighlightEntity, actions, hideId, selectionController, }: {
+export declare const EntityCollectionRowActions: ({ entity, collection, fullPath, width, frozen, isSelected, selectionEnabled, size, highlightEntity, onCollectionChange, unhighlightEntity, actions, hideId, selectionController, openEntityMode }: {
     entity: Entity<any>;
     collection?: EntityCollection<any>;
     fullPath?: string;
@@ -27,4 +27,5 @@ export declare const EntityCollectionRowActions: ({ entity, collection, fullPath
     selectionController?: SelectionController;
     highlightEntity?: (entity: Entity<any>) => void;
     unhighlightEntity?: (entity: Entity<any>) => void;
+    openEntityMode: "side_panel" | "full_screen";
 }) => import("react/jsx-runtime").JSX.Element;

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

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

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

@@ -4,7 +4,7 @@ import { OnCellValueChange, OnColumnResizeParams, UniqueFieldValidator } from ".
 /**
  * @group Collection components
  */
-export type EntityCollectionTableProps<M extends Record<string, any>, UserType extends User = User> = {
+export type EntityCollectionTableProps<M extends Record<string, any>, USER extends User = User> = {
     className?: string;
     style?: React.CSSProperties;
     /**
@@ -48,6 +48,19 @@ export type EntityCollectionTableProps<M extends Record<string, any>, UserType e
      * Callback when a column is resized
      */
     onColumnResize?(params: OnColumnResizeParams): void;
+    /**
+     * Initial scroll position
+     */
+    initialScroll?: number;
+    /**
+     * Callback when the table is scrolled
+     * @param props
+     */
+    onScroll?: (props: {
+        scrollDirection: "forward" | "backward";
+        scrollOffset: number;
+        scrollUpdateWasRequested: boolean;
+    }) => void;
     /**
      * Callback when the selected size of the table is changed
      */
@@ -63,7 +76,7 @@ export type EntityCollectionTableProps<M extends Record<string, any>, UserType e
     actions?: React.ReactNode;
     /**
      * Controller holding the logic for the table
-     * {@link useDataSourceEntityCollectionTableController}
+     * {@link useDataSourceTableController}
      * {@link EntityTableController}
      */
     tableController: EntityTableController<M>;
@@ -71,7 +84,7 @@ export type EntityCollectionTableProps<M extends Record<string, any>, UserType e
     forceFilter?: FilterValues<Extract<keyof M, string>>;
     textSearchEnabled?: boolean;
     inlineEditing?: boolean;
-    additionalFields?: AdditionalFieldDelegate<M, UserType>[];
+    additionalFields?: AdditionalFieldDelegate<M, USER>[];
     defaultSize?: CollectionSize;
     properties: ResolvedProperties<M>;
     getPropertyFor?: (props: GetPropertyForProps<M>) => ResolvedProperties<M>[string];
@@ -90,6 +103,7 @@ export type EntityCollectionTableProps<M extends Record<string, any>, UserType e
     onTextSearchClick?: () => void;
     textSearchLoading?: boolean;
     enablePopupIcon: boolean;
+    openEntityMode?: "side_panel" | "full_screen";
 };
 export type GetPropertyForProps<M extends Record<string, any>> = {
     propertyKey: string;

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

@@ -2,5 +2,5 @@ export { EntityCollectionTable } from "./EntityCollectionTable";
 export type { EntityCollectionTableProps, } from "./EntityCollectionTableProps";
 export * from "./PropertyTableCell";
 export * from "./EntityCollectionRowActions";
-export * from "../common/useDataSourceEntityCollectionTableController";
+export * from "../common/useDataSourceTableController";
 export * from "./column_utils";

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

@@ -2,12 +2,12 @@ import { Entity, EntityCollection } from "../../../../types";
 import { CustomFieldValidator } from "../../../../form/validation";
 import { OnCellValueChangeParams } from "../../../common";
 interface PopupFormFieldProps<M extends Record<string, any>> {
-    entity: Entity<M>;
     customFieldValidator?: CustomFieldValidator;
     path: string;
+    entityId: string;
     tableKey: string;
     propertyKey?: Extract<keyof M, string>;
-    collection?: EntityCollection<M>;
+    collection?: EntityCollection<any>;
     cellRect?: DOMRect;
     open: boolean;
     onClose: () => void;
@@ -19,5 +19,8 @@ interface PopupFormFieldProps<M extends Record<string, any>> {
     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;
+export declare function PopupFormFieldLoading<M extends Record<string, any>>({ tableKey, entityId, customFieldValidator, propertyKey, collection: inputCollection, path, cellRect, open, onClose, onCellValueChange, container }: PopupFormFieldProps<M>): import("react/jsx-runtime").JSX.Element | null;
+export declare function PopupFormFieldInternal<M extends Record<string, any>>({ tableKey, entityId, customFieldValidator, propertyKey, collection: inputCollection, path, cellRect, open, onClose, onCellValueChange, container, entity }: PopupFormFieldProps<M> & {
+    entity?: Entity<M>;
+}): import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -18,6 +18,10 @@ export type EntityCollectionViewProps<M extends Record<string, any>> = {
      */
     isSubCollection?: boolean;
     className?: string;
+    /**
+     * If true, this view will store its filter and sorting status in the url params
+     */
+    updateUrl?: boolean;
 } & EntityCollection<M>;
 /**
  * This component is in charge of binding a datasource path with an {@link EntityCollection}

package/dist/components/PropertyIdCopyTooltip.d.ts

@@ -1,4 +1,4 @@
-export declare function PropertyIdCopyTooltip({ propertyKey, className, children }: {
+export declare function PropertyIdCopyTooltip({ propertyKey, className, children, }: {
     propertyKey: string;
     className?: string;
     children: React.ReactNode;

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

@@ -34,7 +34,7 @@ export type SelectableTableProps<M extends Record<string, any>> = {
     hoverRow?: boolean;
     /**
      * Controller holding the logic for the table
-     * {@link useDataSourceEntityCollectionTableController}
+     * {@link useDataSourceTableController}
      * {@link EntityTableController}
      */
     tableController: EntityTableController<M>;
@@ -44,6 +44,16 @@ export type SelectableTableProps<M extends Record<string, any>> = {
     forceFilter?: FilterValues<keyof M extends string ? keyof M : never>;
     highlightedRow?: (data: Entity<M>) => boolean;
     size?: CollectionSize;
+    initialScroll?: number;
+    /**
+     * Callback when the table is scrolled
+     * @param props
+     */
+    onScroll?: (props: {
+        scrollDirection: "forward" | "backward";
+        scrollOffset: number;
+        scrollUpdateWasRequested: boolean;
+    }) => void;
     emptyComponent?: React.ReactNode;
     endAdornment?: React.ReactNode;
     AddColumnComponent?: React.ComponentType;
@@ -65,7 +75,7 @@ export type SelectableTableProps<M extends Record<string, any>> = {
  *
  * 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}
+ * {@link useDataSourceTableController}
  *
  * @see EntityCollectionTableProps
  * @see EntityCollectionView

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

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

package/dist/components/UnsavedChangesDialog.d.ts

@@ -0,0 +1,8 @@
+export interface UnsavedChangesDialogProps {
+    open: boolean;
+    body?: React.ReactNode;
+    title?: string;
+    handleOk: () => void;
+    handleCancel: () => void;
+}
+export declare function UnsavedChangesDialog({ open, handleOk, handleCancel, body, title }: UnsavedChangesDialogProps): import("react/jsx-runtime").JSX.Element;

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

@@ -66,6 +66,15 @@ export interface VirtualTableProps<T extends Record<string, any>> {
      * @param filter
      */
     onFilterUpdate?: (filter?: VirtualTableFilterValues<any> | undefined) => void;
+    /**
+     * Callback when the table is scrolled
+     * @param props
+     */
+    onScroll?: (props: {
+        scrollDirection: "forward" | "backward";
+        scrollOffset: number;
+        scrollUpdateWasRequested: boolean;
+    }) => void;
     /**
      * Default sort applied to this collection
      */
@@ -119,6 +128,10 @@ export interface VirtualTableProps<T extends Record<string, any>> {
      * @param column
      */
     AddColumnComponent?: React.ComponentType;
+    /**
+     * Initial scroll position
+     */
+    initialScroll?: number;
     /**
      * Debug mode
      */

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

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

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

@@ -1,6 +1,6 @@
 export * from "./types";
 export * from "./useDebouncedData";
 export * from "./useColumnsIds";
-export * from "./useDataSourceEntityCollectionTableController";
+export * from "./useDataSourceTableController";
 export * from "./useTableSearchHelper";
 export * from "./default_entity_actions";

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

@@ -1,5 +1,6 @@
 import { EntityCollection, ResolvedEntityCollection, ResolvedProperty } from "../../types";
 import { PropertyColumnConfig } from "../EntityCollectionTable/EntityCollectionTableProps";
+export declare const COLLECTION_GROUP_PARENT_ID = "collectionGroupParent";
 export declare function useColumnIds<M extends Record<string, any>>(collection: ResolvedEntityCollection<M>, includeSubcollections: boolean): PropertyColumnConfig[];
 export declare function getColumnKeysForProperty(property: ResolvedProperty, key: string, disabled?: boolean): PropertyColumnConfig[];
 export declare function getFormFieldKeys(collection: EntityCollection): string[];

package/dist/components/common/{useDataSourceEntityCollectionTableController.d.ts → useDataSourceTableController.d.ts}

@@ -1,5 +1,6 @@
 import { Entity, EntityCollection, EntityTableController, FilterValues, User } from "../../types";
-export type DataSourceEntityCollectionTableControllerProps<M extends Record<string, any> = any> = {
+import { ScrollRestorationController } from "./useScrollRestoration";
+export type DataSourceTableControllerProps<M extends Record<string, any> = any> = {
     /**
      * Full path where the data of this table is located
      */
@@ -18,6 +19,11 @@ export type DataSourceEntityCollectionTableControllerProps<M extends Record<stri
      * Force filter to be applied to the table.
      */
     forceFilter?: FilterValues<string>;
+    scrollRestoration?: ScrollRestorationController;
+    /**
+     * When set to true the filters and sort will be updated in the URL
+     */
+    updateUrl?: boolean;
 };
 /**
  * Use this hook to build a controller for the {@link EntityCollectionTable}.
@@ -28,8 +34,10 @@ export type DataSourceEntityCollectionTableControllerProps<M extends Record<stri
  *
  * @param fullPath
  * @param collection
+ * @param scrollRestoration
  * @param entitiesDisplayedFirst
  * @param lastDeleteTimestamp
  * @param forceFilterFromProps
+ * @param updateUrl
  */
-export declare function useDataSourceEntityCollectionTableController<M extends Record<string, any> = any, UserType extends User = User>({ fullPath, collection, entitiesDisplayedFirst, lastDeleteTimestamp, forceFilter: forceFilterFromProps, }: DataSourceEntityCollectionTableControllerProps<M>): EntityTableController<M>;
+export declare function useDataSourceTableController<M extends Record<string, any> = any, USER extends User = User>({ fullPath, collection, scrollRestoration, entitiesDisplayedFirst, lastDeleteTimestamp, forceFilter: forceFilterFromProps, updateUrl }: DataSourceTableControllerProps<M>): EntityTableController<M>;

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

@@ -0,0 +1 @@
+export declare function useDebounceCallback<T extends (...args: any[]) => any>(callback?: T, delay?: number): T;

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

@@ -0,0 +1,14 @@
+import { Entity, FilterValues } from "../../types";
+export type ScrollRestorationController = {
+    getCollectionScroll: (fullPath: string, filters?: FilterValues<any>) => {
+        scrollOffset: number;
+        data: Entity<any>[];
+    } | undefined;
+    updateCollectionScroll: (props: {
+        fullPath: string;
+        scrollOffset: number;
+        filters?: FilterValues<any>;
+        data: Entity<any>[];
+    }) => void;
+};
+export declare function useScrollRestoration(): ScrollRestorationController;

package/dist/contexts/BreacrumbsContext.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+import { BreadcrumbsController } from "../hooks/useBreadcrumbsController";
+export declare const BreadcrumbContext: React.Context<BreadcrumbsController>;
+interface BreadcrumbsProviderProps {
+    children: React.ReactNode;
+}
+export declare const BreadcrumbsProvider: React.FC<BreadcrumbsProviderProps>;
+export {};

package/dist/core/EntityEditView.d.ts

@@ -1,36 +1,44 @@
-import { Entity, EntityCollection, EntityValues, ResolvedEntityCollection, User } from "../types";
-import { ValidationError } from "yup";
+import React from "react";
+import { Entity, EntityCollection, EntityStatus, User } from "../types";
+import { EntityFormProps } from "../form";
+export type OnUpdateParams = {
+    entity: Entity<any>;
+    status: EntityStatus;
+    path: string;
+    entityId?: string;
+    selectedTab?: string;
+    collection: EntityCollection<any>;
+};
+export type OnTabChangeParams<M extends Record<string, any>> = {
+    path: string;
+    entityId?: string;
+    selectedTab?: string;
+    collection: EntityCollection<M>;
+};
 export interface EntityEditViewProps<M extends Record<string, any>> {
     path: string;
     collection: EntityCollection<M>;
     entityId?: string;
+    databaseId?: string;
     copy?: boolean;
-    selectedSubPath?: string;
+    selectedTab?: string;
     parentCollectionIds: string[];
-    onValuesAreModified: (modified: boolean) => void;
-    onUpdate?: (params: {
-        entity: Entity<any>;
-    }) => void;
-    onClose?: () => void;
+    onValuesModified?: (modified: boolean) => void;
+    onSaved?: (params: OnUpdateParams) => void;
+    onTabChange?: (props: OnTabChangeParams<M>) => void;
+    layout?: "side_panel" | "full_screen";
+    barActions?: React.ReactNode;
+    formProps?: Partial<EntityFormProps<M>>;
 }
 /**
  * This is the default view that is used as the content of a side panel when
  * an entity is opened.
- * You probably don't want to use this view directly since it is bound to the
- * side panel.
  */
-export declare function EntityEditView<M extends Record<string, any>, UserType extends User>({ entityId, ...props }: EntityEditViewProps<M>): import("react/jsx-runtime").JSX.Element;
-export declare function EntityEditViewInner<M extends Record<string, any>>({ path, entityId: entityIdProp, selectedSubPath: selectedSubPathProp, copy, collection, parentCollectionIds, onValuesAreModified, onUpdate, onClose, entity, dataLoading }: EntityEditViewProps<M> & {
+export declare function EntityEditView<M extends Record<string, any>, USER extends User>({ entityId, ...props }: EntityEditViewProps<M>): import("react/jsx-runtime").JSX.Element;
+export declare function EntityEditViewInner<M extends Record<string, any>>({ path, entityId, selectedTab: selectedTabProp, collection, parentCollectionIds, onValuesModified, onSaved, onTabChange, entity, cachedDirtyValues, dataLoading, layout, barActions, status, setStatus, formProps, }: EntityEditViewProps<M> & {
     entity?: Entity<M>;
+    cachedDirtyValues?: Partial<M>;
     dataLoading: boolean;
+    status: EntityStatus;
+    setStatus: (status: EntityStatus) => void;
 }): import("react/jsx-runtime").JSX.Element;
-export type EntityFormSaveParams<M extends Record<string, any>> = {
-    collection: ResolvedEntityCollection<M>;
-    path: string;
-    entityId: string | undefined;
-    values: EntityValues<M>;
-    previousValues?: EntityValues<M>;
-    closeAfterSave: boolean;
-    autoSave: boolean;
-};
-export declare function yupToFormErrors(yupError: ValidationError): Record<string, any>;

package/dist/core/EntityEditViewFormActions.d.ts

@@ -0,0 +1,2 @@
+import { EntityFormActionsProps } from "../form/EntityFormActions";
+export declare function EntityEditViewFormActions({ collection, path, entity, layout, savingError, formex, disabled, status, pluginActions, openEntityMode, showDefaultActions }: EntityFormActionsProps): import("react/jsx-runtime").JSX.Element;

package/dist/core/FireCMS.d.ts

@@ -11,4 +11,4 @@ import { EntityCollection, FireCMSProps, User } from "../types";
 
  * @group Core
  */
-export declare function FireCMS<UserType extends User, EC extends EntityCollection>(props: FireCMSProps<UserType, EC>): import("react/jsx-runtime").JSX.Element;
+export declare function FireCMS<USER extends User, EC extends EntityCollection>(props: FireCMSProps<USER, EC>): import("react/jsx-runtime").JSX.Element;

package/dist/core/FireCMSRouter.d.ts

@@ -0,0 +1,4 @@
+export declare function FireCMSRouter({ children, basePath }: {
+    children: React.ReactNode;
+    basePath?: string;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/core/NavigationRoutes.d.ts

@@ -15,7 +15,6 @@ export type NavigationRoutesProps = {
  * or the home route) related to a {@link NavigationController}.
  * This component needs a parent {@link FireCMS}
  *
-
  * @group Components
  */
 export declare const NavigationRoutes: React.NamedExoticComponent<NavigationRoutesProps>;

package/dist/core/SideDialogs.d.ts

@@ -1,17 +1,19 @@
 import React from "react";
-export type SideDialogContextProps = {
+export type SideDialogController = {
     blocked: boolean;
     setBlocked: (blocked: boolean) => void;
     setBlockedNavigationMessage: (message?: React.ReactNode) => void;
     width?: string;
     close: (force?: boolean) => void;
+    pendingClose: boolean;
+    setPendingClose: (pendingClose: boolean) => void;
 };
 /**
  * This hook is used to access the properties of a particular side dialog,
  * in contrast with {@link useSideDialogsController} which handles the
  * state of all the dialogs.
  */
-export declare const useSideDialogContext: () => SideDialogContextProps;
+export declare const useSideDialogContext: () => SideDialogController;
 /**
  * This is the component in charge of rendering the side dialogs used
  * for editing entities. Use the {@link useSideEntityController} to open

package/dist/core/index.d.ts

@@ -1,7 +1,8 @@
 export * from "./FireCMS";
-export * from "../app/Scaffold";
 export * from "./DefaultDrawer";
 export * from "./DrawerNavigationItem";
 export * from "./field_configs";
 export * from "./SideDialogs";
 export * from "./NavigationRoutes";
+export * from "./FireCMSRouter";
+export * from "../app";

package/dist/form/EntityForm.d.ts

@@ -0,0 +1,45 @@
+import React from "react";
+import { Entity, EntityCollection, EntityCustomViewParams, EntityStatus, FormContext } from "../types";
+import { FormexController } from "@firecms/formex";
+import { ValidationError } from "yup";
+import { EntityFormActionsProps } from "./EntityFormActions";
+export type OnUpdateParams = {
+    entity: Entity<any>;
+    status: EntityStatus;
+    path: string;
+    entityId?: string;
+    selectedTab?: string;
+    collection: EntityCollection<any>;
+};
+export type EntityFormProps<M extends Record<string, any>> = {
+    path: string;
+    collection: EntityCollection<M>;
+    entityId?: string;
+    entity?: Entity<M>;
+    databaseId?: string;
+    onIdChange?: (id: string) => void;
+    onValuesModified?: (modified: boolean) => void;
+    onSaved?: (params: OnUpdateParams) => void;
+    initialDirtyValues?: Partial<M>;
+    onFormContextReady?: (formContext: FormContext) => void;
+    forceActionsAtTheBottom?: boolean;
+    className?: string;
+    initialStatus: EntityStatus;
+    onStatusChange?: (status: EntityStatus) => void;
+    onEntityChange?: (entity: Entity<M>) => void;
+    formex?: FormexController<M>;
+    openEntityMode?: "side_panel" | "full_screen";
+    /**
+     * Include the copy and delete actions in the form
+     */
+    showDefaultActions?: boolean;
+    /**
+     * Display the entity path in the form
+     */
+    showEntityPath?: boolean;
+    EntityFormActionsComponent?: React.FC<EntityFormActionsProps>;
+    Builder?: React.ComponentType<EntityCustomViewParams<M>>;
+    children?: React.ReactNode;
+};
+export declare function EntityForm<M extends Record<string, any>>({ path, entityId: entityIdProp, collection, onValuesModified, onIdChange, onSaved, entity, initialDirtyValues, onFormContextReady, forceActionsAtTheBottom, initialStatus, className, onStatusChange, onEntityChange, openEntityMode, formex: formexProp, Builder, EntityFormActionsComponent, showDefaultActions, showEntityPath, children }: EntityFormProps<M>): import("react/jsx-runtime").JSX.Element;
+export declare function yupToFormErrors(yupError: ValidationError): Record<string, any>;

package/dist/form/EntityFormActions.d.ts

@@ -0,0 +1,17 @@
+import React from "react";
+import { Entity, ResolvedEntityCollection } from "../types";
+import { FormexController } from "@firecms/formex";
+export interface EntityFormActionsProps {
+    collection: ResolvedEntityCollection;
+    path: string;
+    entity?: Entity;
+    layout: "bottom" | "side";
+    savingError?: Error;
+    formex: FormexController<any>;
+    disabled: boolean;
+    status: "new" | "existing" | "copy";
+    pluginActions: React.ReactNode[];
+    openEntityMode: "side_panel" | "full_screen";
+    showDefaultActions?: boolean;
+}
+export declare function EntityFormActions({ collection, entity, layout, savingError, formex, disabled, status, pluginActions, openEntityMode }: EntityFormActionsProps): import("react/jsx-runtime").JSX.Element;

package/dist/form/PropertyFieldBinding.d.ts

@@ -26,5 +26,5 @@ import { CMSType, PropertyFieldBindingProps } from "../types";
  * @group Form custom fields
  */
 export declare const PropertyFieldBinding: typeof PropertyFieldBindingInternal;
-declare function PropertyFieldBindingInternal<T extends CMSType = CMSType, M extends Record<string, any> = Record<string, any>>({ propertyKey, property, context, includeDescription, underlyingValueHasChanged, disabled, partOfArray, minimalistView, autoFocus, index, size }: PropertyFieldBindingProps<T, M>): ReactElement<PropertyFieldBindingProps<T, M>>;
+declare function PropertyFieldBindingInternal<T extends CMSType = CMSType, M extends Record<string, any> = any>({ propertyKey, property, context, includeDescription, underlyingValueHasChanged, disabled: disabledProp, partOfArray, minimalistView, autoFocus, index, size, onPropertyChange }: PropertyFieldBindingProps<T, M>): ReactElement<PropertyFieldBindingProps<T, M>>;
 export {};

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

@@ -0,0 +1,6 @@
+import React from "react";
+export declare function FormEntry({ propertyKey, widthPercentage, children }: {
+    propertyKey: string;
+    widthPercentage?: number;
+    children: React.ReactNode;
+}): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,5 @@
+import React from "react";
+export declare function FormLayout({ children, className }: {
+    children: React.ReactNode;
+    className?: string;
+}): import("react/jsx-runtime").JSX.Element;

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

@@ -1,4 +1,5 @@
-export * from "./FormikArrayContainer";
 export * from "./FieldHelperText";
 export * from "./LabelWithIcon";
 export * from "./LabelWithIconAndTooltip";
+export * from "./FormEntry";
+export * from "./FormLayout";

package/dist/form/field_bindings/ArrayCustomShapedFieldBinding.d.ts

@@ -6,4 +6,4 @@ import { FieldProps } from "../../types";
  * and tables to the specified properties.
  * @group Form fields
  */
-export declare function ArrayCustomShapedFieldBinding<T extends Array<any>>({ propertyKey, value, error, showError, isSubmitting, setValue, minimalistView, property, includeDescription, underlyingValueHasChanged, context, disabled }: FieldProps<T, any, any>): import("react/jsx-runtime").JSX.Element;
+export declare function ArrayCustomShapedFieldBinding<T extends Array<any>>({ propertyKey, value, error, showError, isSubmitting, setValue, minimalistView: minimalistViewProp, property, includeDescription, context, disabled }: FieldProps<T, any, any>): import("react/jsx-runtime").JSX.Element;

package/dist/form/field_bindings/ArrayOfReferencesFieldBinding.d.ts

@@ -7,5 +7,5 @@ type ArrayOfReferencesFieldProps = FieldProps<EntityReference[]>;
  * and tables to the specified properties.
  * @group Form fields
  */
-export declare function ArrayOfReferencesFieldBinding({ propertyKey, value, error, showError, disabled, isSubmitting, minimalistView, property, includeDescription, setValue, setFieldValue }: ArrayOfReferencesFieldProps): import("react/jsx-runtime").JSX.Element;
+export declare function ArrayOfReferencesFieldBinding({ propertyKey, value, error, showError, disabled, isSubmitting, minimalistView: minimalistViewProp, property, includeDescription, setValue, setFieldValue }: ArrayOfReferencesFieldProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/form/field_bindings/BlockFieldBinding.d.ts

@@ -7,4 +7,4 @@ import { FieldProps } from "../../types";
  * and tables to the specified properties.
  * @group Form fields
  */
-export declare function BlockFieldBinding<T extends Array<any>>({ propertyKey, value, error, showError, isSubmitting, setValue, setFieldValue, minimalistView, property, includeDescription, underlyingValueHasChanged, context, disabled }: FieldProps<T>): import("react/jsx-runtime").JSX.Element;
+export declare function BlockFieldBinding<T extends Array<any>>({ propertyKey, value, error, showError, isSubmitting, setValue, setFieldValue, minimalistView: minimalistViewProp, property, includeDescription, underlyingValueHasChanged, context, disabled }: FieldProps<T>): import("react/jsx-runtime").JSX.Element;

package/dist/form/field_bindings/MapFieldBinding.d.ts

@@ -6,4 +6,4 @@ import { FieldProps } from "../../types";
  * and tables to the specified properties.
  * @group Form fields
  */
-export declare function MapFieldBinding({ propertyKey, value, showError, error, disabled, property, minimalistView, includeDescription, underlyingValueHasChanged, autoFocus, context }: FieldProps<Record<string, any>>): import("react/jsx-runtime").JSX.Element;
+export declare function MapFieldBinding({ propertyKey, value, showError, error, disabled, property, minimalistView: minimalistViewProp, includeDescription, autoFocus, context, onPropertyChange }: FieldProps<Record<string, any>>): import("react/jsx-runtime").JSX.Element;