@firecms/core 3.0.0-canary.168 → 3.0.0-canary.169

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>, USER 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

@@ -48,6 +48,19 @@ export type EntityCollectionTableProps<M extends Record<string, any>, USER exten
      * 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>, USER exten
     actions?: React.ReactNode;
     /**
      * Controller holding the logic for the table
-     * {@link useDataSourceEntityCollectionTableController}
+     * {@link useDataSourceTableController}
      * {@link EntityTableController}
      */
     tableController: EntityTableController<M>;
@@ -90,6 +103,7 @@ export type EntityCollectionTableProps<M extends Record<string, any>, USER exten
     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/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/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/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/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/{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, USER 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,17 +1,34 @@
-import { Entity, EntityCollection, EntityValues, ResolvedEntityCollection, User } from "../types";
+import React from "react";
+import { Entity, EntityCollection, EntityStatus, EntityValues, ResolvedEntityCollection, User } from "../types";
 import { ValidationError } from "yup";
+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;
+    onValuesModified?: (modified: boolean) => void;
+    onSaved?: (params: OnUpdateParams) => void;
     onClose?: () => void;
+    onTabChange?: (props: OnTabChangeParams<M>) => void;
+    layout?: "side_panel" | "full_screen";
+    barActions?: React.ReactNode;
 }
 /**
  * This is the default view that is used as the content of a side panel when
@@ -20,8 +37,9 @@ export interface EntityEditViewProps<M extends Record<string, any>> {
  * side panel.
  */
 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: entityIdProp, selectedSubPath: selectedSubPathProp, copy, collection, parentCollectionIds, onValuesAreModified, onUpdate, onClose, entity, dataLoading }: EntityEditViewProps<M> & {
+export declare function EntityEditViewInner<M extends Record<string, any>>({ path, entityId: entityIdProp, selectedTab: selectedTabProp, copy, collection, parentCollectionIds, onValuesModified, onSaved, onClose, onTabChange, entity, cachedDirtyValues, dataLoading, layout, barActions }: EntityEditViewProps<M> & {
     entity?: Entity<M>;
+    cachedDirtyValues?: Partial<M>;
     dataLoading: boolean;
 }): import("react/jsx-runtime").JSX.Element;
 export type EntityFormSaveParams<M extends Record<string, any>> = {

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/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/hooks/data/useEntityFetch.d.ts

@@ -5,6 +5,7 @@ import { Entity, EntityCollection, User } from "../../types";
 export interface EntityFetchProps<M extends Record<string, any>, USER extends User = User> {
     path: string;
     entityId?: string;
+    databaseId?: string;
     collection: EntityCollection<M, USER>;
     useCache?: boolean;
 }
@@ -25,4 +26,4 @@ export interface EntityFetchResult<M extends Record<string, any>> {
  * @param useCache
  * @group Hooks and utilities
  */
-export declare function useEntityFetch<M extends Record<string, any>, USER extends User>({ path: inputPath, entityId, collection, useCache }: EntityFetchProps<M, USER>): EntityFetchResult<M>;
+export declare function useEntityFetch<M extends Record<string, any>, USER extends User>({ path: inputPath, entityId, collection, databaseId, useCache }: EntityFetchProps<M, USER>): EntityFetchResult<M>;

package/dist/hooks/useBreadcrumbsController.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @group Hooks and utilities
+ */
+export interface BreadcrumbsController {
+    breadcrumbs: BreadcrumbEntry[];
+    set: (props: {
+        breadcrumbs: BreadcrumbEntry[];
+    }) => void;
+}
+/**
+ * @group Hooks and utilities
+ */
+export interface BreadcrumbEntry {
+    title: string;
+    url: string;
+}
+/**
+ * Hook to retrieve the BreadcrumbsController.
+ *
+ * Consider that in order to use this hook you need to have a parent
+ * `FireCMS`
+ *
+ * @see BreadcrumbsController
+ * @group Hooks and utilities
+ */
+export declare const useBreadcrumbsController: () => BreadcrumbsController;

package/dist/hooks/useBuildNavigationController.d.ts

@@ -20,4 +20,3 @@ export type BuildNavigationContextProps<EC extends EntityCollection, USER extend
     injectCollections?: (collections: EntityCollection[]) => EntityCollection[];
 };
 export declare function useBuildNavigationController<EC extends EntityCollection, USER extends User>(props: BuildNavigationContextProps<EC, USER>): NavigationController;
-export declare function getSidePanelKey(path: string, entityId?: string): string;