@firecms/core 3.0.0-beta.11 → 3.0.0-beta.13

package/dist/internal/useBuildDataSource.d.ts

@@ -1,11 +1,12 @@
-import { DataSource, DataSourceDelegate, NavigationController, PropertyConfig } from "../types";
+import { AuthController, DataSource, DataSourceDelegate, NavigationController, PropertyConfig } from "../types";
 /**
  * Use this hook to build a {@link DataSource} based on Firestore
  * @param firebaseApp
  * @group Firebase
  */
-export declare function useBuildDataSource({ delegate, propertyConfigs, navigationController }: {
+export declare function useBuildDataSource({ delegate, propertyConfigs, navigationController, authController }: {
     delegate: DataSourceDelegate;
     propertyConfigs?: Record<string, PropertyConfig>;
     navigationController: NavigationController;
+    authController: AuthController;
 }): DataSource;

package/dist/internal/useBuildSideEntityController.d.ts

@@ -1,4 +1,4 @@
-import { EntityCollection, EntitySidePanelProps, NavigationController, SideDialogsController, SideEntityController } from "../types";
-export declare function getEntityViewWidth(props: EntitySidePanelProps<any>, small: boolean): string;
-export declare const useBuildSideEntityController: (navigation: NavigationController, sideDialogsController: SideDialogsController) => SideEntityController;
+import { AuthController, CustomizationController, EntityCollection, EntitySidePanelProps, NavigationController, SideDialogsController, SideEntityController } from "../types";
+export declare function getEntityViewWidth(props: EntitySidePanelProps<any>, small: boolean, customizationController: CustomizationController, authController: AuthController): string;
+export declare const useBuildSideEntityController: (navigation: NavigationController, sideDialogsController: SideDialogsController, authController: AuthController) => SideEntityController;
 export declare function buildSidePanelsFromUrl(path: string, collections: EntityCollection[], newFlag: boolean): EntitySidePanelProps<any>[];

package/dist/internal/useUnsavedChangesDialog.d.ts

@@ -1,14 +1,12 @@
-import React from "react";
+/**
+ * Custom hook to handle navigation blocking when there are unsaved changes.
+ *
+ * @param when - Indicates whether to block navigation.
+ * @param onSuccess - Callback invoked when navigation is confirmed.
+ * @returns An object containing the state of navigation blocking and handlers.
+ */
 export declare function useNavigationUnsavedChangesDialog(when: boolean, onSuccess: () => void): {
     navigationWasBlocked: boolean;
     handleCancel: () => void;
     handleOk: () => void;
 };
-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/routes/CustomCMSRoute.d.ts

@@ -0,0 +1,4 @@
+import { CMSView } from "../types";
+export declare function CustomCMSRoute({ cmsView }: {
+    cmsView: CMSView;
+}): import("react").ReactNode;

package/dist/routes/FireCMSRoute.d.ts

@@ -0,0 +1 @@
+export declare function FireCMSRoute(): import("react/jsx-runtime").JSX.Element | null;

package/dist/routes/HomePageRoute.d.ts

@@ -0,0 +1,3 @@
+export declare function HomePageRoute({ children }: {
+    children: React.ReactNode;
+}): import("react").ReactNode;

package/dist/types/collections.d.ts

@@ -72,6 +72,10 @@ export interface EntityCollection<M extends Record<string, any> = any, USER exte
      * Set of properties that compose an entity
      */
     properties: PropertiesOrBuilders<M>;
+    /**
+     * Default preview properties displayed when this collection is referenced to.
+     */
+    previewProperties?: string[];
     /**
      * Title property of the entity. This is the property that will be used
      * as the title in entity related views and references.
@@ -79,11 +83,10 @@ export interface EntityCollection<M extends Record<string, any> = any, USER exte
      */
     titleProperty?: keyof M;
     /**
-     * Can this collection be edited by the end user.
-     * Defaults to `true`.
-     * Keep in mind that you can also set this prop to individual properties.
+     * When editing an entity, you can choose to open the entity in a side dialog
+     * or in a full screen dialog. Defaults to `full_screen`.
      */
-    editable?: boolean;
+    openEntityMode?: "side_panel" | "full_screen";
     /**
      * Order in which the properties are displayed.
      * If you are specifying your collection as code, the order is the same as the
@@ -105,7 +108,7 @@ export interface EntityCollection<M extends Record<string, any> = any, USER exte
      * `hidden` in the property definition,will be ignored.
      * `propertiesOrder` has precedence over `hidden`.
      */
-    propertiesOrder?: (Extract<keyof M, string> | `subcollection:${string}`)[];
+    propertiesOrder?: (Extract<keyof M, string> | string | `subcollection:${string}` | "collectionGroupParent")[];
     /**
      * If enabled, content is loaded in batches. If `false` all entities in the
      * collection are loaded.
@@ -186,12 +189,14 @@ export interface EntityCollection<M extends Record<string, any> = any, USER exte
      * Force a filter in this view. If applied, the rest of the filters will
      * be disabled. Filters applied with this prop cannot be changed.
      * e.g. `forceFilter: { age: [">=", 18] }`
+     * e.g. `forceFilter: { related_user: ["==", new EntityReference("sdc43dsw2", "users")] }`
      */
     forceFilter?: FilterValues<Extract<keyof M, string>>;
     /**
      * Initial filters applied to the collection this collection is related to.
      * Defaults to none. Filters applied with this prop can be changed.
      * e.g. `initialFilter: { age: [">=", 18] }`
+     * e.g. `initialFilter: { related_user: ["==", new EntityReference("sdc43dsw2", "users")] }`
      */
     initialFilter?: FilterValues<Extract<keyof M, string>>;
     /**
@@ -272,9 +277,22 @@ export interface EntityCollection<M extends Record<string, any> = any, USER exte
      */
     sideDialogWidth?: number | string;
     /**
-     * Default preview properties displayed when this collection is referenced to.
+     * Can this collection configuration be edited by the end user.
+     * Defaults to `true`.
+     * Keep in mind that you can also set this prop to individual properties.
+     * This prop has only effect if you are using the collection editor.
      */
-    previewProperties?: string[];
+    editable?: boolean;
+    /**
+     * If set to true, the default values of the properties will be applied
+     * to the entity every time the entity is updated (not only when created).
+     * Defaults to false.
+     */
+    alwaysApplyDefaultValues?: boolean;
+    /**
+     * If set to true, a tab including the JSON representation of the entity will be included.
+     */
+    includeJsonView?: boolean;
 }
 /**
  * Parameter passed to the `Actions` prop in the collection configuration.
@@ -420,10 +438,12 @@ export type EntityCustomView<M extends Record<string, any> = any> = {
      */
     name: string;
     /**
-     * If set to true, the actions of the entity will be included in the
-     * bottom of the panel (save buttons, delete buttons, etc.)
+     * If set to true, the actions of the entity (save, discard,delete) will be
+     * included in the view. By default the actions are located in the right or bottom,
+     * based on the screen size. You can force the actions to be located at the bottom
+     * by setting this prop to "bottom".
      */
-    includeActions?: boolean;
+    includeActions?: boolean | "bottom";
     /**
      * Builder for rendering the custom view
      */
@@ -485,6 +505,12 @@ export type EntityTableController<M extends Record<string, any> = any> = {
     clearFilter?: () => void;
     itemCount?: number;
     setItemCount?: (itemCount: number) => void;
+    initialScroll?: number;
+    onScroll?: (props: {
+        scrollDirection: "forward" | "backward";
+        scrollOffset: number;
+        scrollUpdateWasRequested: boolean;
+    }) => void;
     paginationEnabled?: boolean;
     pageSize?: number;
     checkFilterCombination?: (filterValues: FilterValues<any>, sortBy?: [string, "asc" | "desc"]) => boolean;

package/dist/types/datasource.d.ts

@@ -8,13 +8,13 @@ import { FireCMSContext } from "./firecms_context";
 export interface FetchEntityProps<M extends Record<string, any> = any> {
     path: string;
     entityId: string;
+    databaseId?: string;
     collection?: EntityCollection<M, any>;
 }
 /**
  * @group Datasource
  */
 export type ListenEntityProps<M extends Record<string, any> = any> = FetchEntityProps<M> & {
-    databaseId?: string;
     onUpdate: (entity: Entity<M>) => void;
     onError?: (error: Error) => void;
 };
@@ -99,7 +99,7 @@ export interface DataSource {
      * @param entityId
      * @param collection
      */
-    fetchEntity<M extends Record<string, any> = any>({ path, entityId, collection }: FetchEntityProps<M>): Promise<Entity<M> | undefined>;
+    fetchEntity<M extends Record<string, any> = any>({ path, entityId, databaseId, collection }: FetchEntityProps<M>): Promise<Entity<M> | undefined>;
     /**
      * Get realtime updates on one entity.
      * @param path

package/dist/types/dialogs_controller.d.ts

@@ -12,7 +12,7 @@ export interface DialogsController {
      * Open a dialog
      * @param props
      */
-    open: (props: DialogControllerEntryProps) => {
+    open: <T extends object = object>(props: DialogControllerEntryProps<T>) => {
         closeDialog: () => void;
     };
 }
@@ -20,7 +20,7 @@ export interface DialogsController {
  * Props used to open a side dialog
  * @group Hooks and utilities
  */
-export interface DialogControllerEntryProps {
+export interface DialogControllerEntryProps<T extends object = object> {
     key: string;
     /**
      * The component type that will be rendered
@@ -28,5 +28,9 @@ export interface DialogControllerEntryProps {
     Component: React.ComponentType<{
         open: boolean;
         closeDialog: () => void;
-    }>;
+    } & T>;
+    /**
+     * Props to pass to the dialog component
+     */
+    props?: T;
 }

package/dist/types/entities.d.ts

@@ -7,7 +7,7 @@ export type EntityStatus = "new" | "existing" | "copy";
  * Representation of an entity fetched from the datasource
  * @group Models
  */
-export interface Entity<M extends object> {
+export interface Entity<M extends object = any> {
     /**
      * ID of the entity
      */

package/dist/types/entity_actions.d.ts

@@ -13,6 +13,15 @@ export type EntityAction<M extends object = any, USER extends User = User> = {
      * Title of the action
      */
     name: string;
+    /**
+     * Key of the action. You only need to provide this if you want to
+     * override the default actions.
+     * The default actions are:
+     * - edit
+     * - delete
+     * - copy
+     */
+    key?: string;
     /**
      * Icon of the action
      */
@@ -46,4 +55,5 @@ export type EntityActionClickProps<M extends object, USER extends User = User> =
      * If this actions is being called from a side dialog
      */
     sideEntityController?: SideEntityController;
+    openEntityMode: "side_panel" | "full_screen";
 };

package/dist/types/fields.d.ts

@@ -1,6 +1,7 @@
 import { CMSType, Property, PropertyOrBuilder } from "./properties";
 import { ResolvedEntityCollection, ResolvedProperty } from "./resolved_entities";
 import { FormexController } from "@firecms/formex";
+import { Entity } from "./entities";
 /**
  * When building a custom field you need to create a React component that takes
  * this interface as props.
@@ -67,7 +68,8 @@ export interface FieldProps<T extends CMSType = any, CustomProps = any, M extend
      */
     partOfArray?: boolean;
     /**
-     * Should this field render with the minimal amount of UI elements
+     * Display the child properties directly, without being wrapped in an
+     * extendable panel. Note that this will also hide the title of this property.
      */
     minimalistView?: boolean;
     /**
@@ -131,10 +133,17 @@ export interface FormContext<M extends Record<string, any> = any> {
      * Path this entity is located at
      */
     path?: string;
+    status: "new" | "existing" | "copy";
+    entity?: Entity<M>;
+    savingError?: Error;
+    openEntityMode: "side_panel" | "full_screen";
     /**
-     * This is the underlying formex controller that powers the form
+     * This is the underlying formex controller that powers the form.
+     * If you are in a red only mode, the formex controller is there, but you can't
+     * operate with it
      */
     formex: FormexController<M>;
+    disabled: boolean;
 }
 /**
  * In case you need to render a field bound to a Property inside your
@@ -170,7 +179,8 @@ export interface PropertyFieldBindingProps<T extends CMSType, M extends Record<s
      */
     partOfArray?: boolean;
     /**
-     * Is this field part of a block (oneOf array)
+     * Display the child properties directly, without being wrapped in an
+     * extendable panel. Note that this will also hide the title of this property.
      */
     minimalistView?: boolean;
     /**

package/dist/types/firecms.d.ts

@@ -44,7 +44,7 @@ export type CMSViewsBuilder = (params: {
 /**
  * @group Models
  */
-export type FireCMSProps<USER extends User, EC extends EntityCollection> = {
+export type FireCMSProps<USER extends User> = {
     /**
      * Use this function to return the components you want to render under
      * FireCMS

package/dist/types/navigation.d.ts

@@ -4,6 +4,7 @@ import { EntityReference } from "./entities";
 /**
  * Controller that includes the resolved navigation and utility methods and
  * attributes.
+ * This controller holds the state of the navigation including the collections.
  * @group Models
  */
 export type NavigationController<EC extends EntityCollection = EntityCollection<any>> = {
@@ -48,6 +49,10 @@ export type NavigationController<EC extends EntityCollection = EntityCollection<
      * The collection is resolved from the given path or alias.
      */
     getCollection: (pathOrId: string, includeUserOverride?: boolean) => EC | undefined;
+    /**
+     * Get the top level collection configuration for a given id
+     */
+    getCollectionById: (id: string) => EC | undefined;
     /**
      * Get the collection configuration from its parent ids.
      */
@@ -57,11 +62,13 @@ export type NavigationController<EC extends EntityCollection = EntityCollection<
      */
     getCollectionFromPaths: (pathSegments: string[]) => EC | undefined;
     /**
-     * Default path under the navigation routes of the CMS will be created
+     * Default path under the navigation routes of the CMS will be created.
+     * Defaults to '/'. You may want to change this `basepath` to 'admin' for example.
      */
     basePath: string;
     /**
-     * Default path under the collection routes of the CMS will be created
+     * Default path under the collection routes of the CMS will be created.
+     * It defaults to '/c'
      */
     baseCollectionPath: string;
     /**
@@ -72,14 +79,6 @@ export type NavigationController<EC extends EntityCollection = EntityCollection<
      * @param cmsPath
      */
     urlPathToDataPath: (cmsPath: string) => string;
-    /**
-     * Convert a collection or entity path to a URL path
-     * @param path
-     */
-    buildCMSUrlPath: (path: string) => string;
-    buildUrlEditCollectionPath: (props: {
-        path: string;
-    }) => string;
     /**
      * Base url path for the home screen
      */
@@ -97,10 +96,11 @@ export type NavigationController<EC extends EntityCollection = EntityCollection<
      */
     buildUrlCollectionPath: (path: string) => string;
     /**
-     * Turn a path with aliases into a resolved path
+     * Turn a path with collection ids into a resolved path.
+     * The ids (typically used in urls) will be replaced with relative paths (typically used in database paths)
      * @param pathWithAliases
      */
-    resolveAliasesFrom: (pathWithAliases: string) => string;
+    resolveIdsFrom: (pathWithAliases: string) => string;
     /**
      * Call this method to recalculate the navigation
      */
@@ -120,6 +120,27 @@ export type NavigationController<EC extends EntityCollection = EntityCollection<
      * @param ids
      */
     convertIdsToPaths: (ids: string[]) => string[];
+    /**
+     * A function to navigate to a specified route or URL.
+     *
+     * @param {string} to - The target route or URL to navigate to.
+     * @param {NavigateOptions} [options] - Optional configuration settings for navigation, such as replace behavior or state data.
+     */
+    navigate: (to: string, options?: NavigateOptions) => void;
+};
+export interface NavigateOptions {
+    replace?: boolean;
+    state?: any;
+    preventScrollReset?: boolean;
+    relative?: "route" | "path";
+    flushSync?: boolean;
+    viewTransition?: boolean;
+}
+export type NavigationBlocker = {
+    updateBlockListener: (path: string, block: boolean, basePath?: string) => () => void;
+    isBlocked: (path: string) => boolean;
+    proceed?: () => void;
+    reset?: () => void;
 };
 /**
  * Custom additional views created by the developer, added to the main

package/dist/types/plugins.d.ts

@@ -159,9 +159,11 @@ export interface PluginFormActionProps<USER extends User = User, EC extends Enti
     path: string;
     status: EntityStatus;
     collection: EC;
+    disabled: boolean;
     formContext?: FormContext<any>;
     context: FireCMSContext<USER>;
     currentEntityId?: string;
+    openEntityMode: "side_panel" | "full_screen";
 }
 export type PluginFieldBuilderParams<T extends CMSType = CMSType, M extends Record<string, any> = any, EC extends EntityCollection<M> = EntityCollection<M>> = {
     fieldConfigId: string;

package/dist/types/properties.d.ts

@@ -5,6 +5,7 @@ import { EntityReference, EntityValues, GeoPoint, Vector } from "./entities";
 import { ResolvedArrayProperty, ResolvedStringProperty } from "./resolved_entities";
 import { FilterValues } from "./collections";
 import { ChipColorKey, ChipColorScheme } from "@firecms/ui";
+import { AuthController } from "./auth";
 /**
  * @group Entity properties
  */
@@ -103,6 +104,11 @@ export interface BaseProperty<T extends CMSType, CustomProps = any> {
      * save the new config. The saved config will then become the source of truth.
      */
     editable?: boolean;
+    /**
+     * A number between 0 and 100 that indicates the width of the field in the form view.
+     * It defaults to 100, but you can set it to 50 to have two fields in the same row.
+     */
+    widthPercentage?: number;
 }
 /**
  * @group Entity properties
@@ -200,6 +206,10 @@ export type PropertyBuilderProps<M extends Record<string, any> = any> = {
      * Entity ID
      */
     entityId?: string;
+    /**
+     * Controller to manage authentication
+     */
+    authController: AuthController;
 };
 /**
  * You can use this type to define a property dynamically, based
@@ -207,15 +217,15 @@ export type PropertyBuilderProps<M extends Record<string, any> = any> = {
  * current value of the property, as well as the path and entity ID.
  * @group Entity properties
  */
-export type PropertyBuilder<T extends CMSType = any, M extends Record<string, any> = any> = ({ values, previousValues, propertyValue, index, path, entityId }: PropertyBuilderProps<M>) => Property<T> | null;
+export type PropertyBuilder<T extends CMSType = any, M extends Record<string, any> = any> = ({ values, previousValues, propertyValue, index, path, entityId, authController }: PropertyBuilderProps<M>) => Property<T> | null;
 /**
  * @group Entity properties
  */
-export type PropertyOrBuilder<T extends CMSType = CMSType, M extends Record<string, any> = Record<string, any>> = Property<T> | PropertyBuilder<T, M>;
+export type PropertyOrBuilder<T extends CMSType = CMSType, M extends Record<string, any> = any> = Property<T> | PropertyBuilder<T, M>;
 /**
  * @group Entity properties
  */
-export type PropertiesOrBuilders<M extends Record<string, any> = Record<string, any>> = {
+export type PropertiesOrBuilders<M extends Record<string, any> = any> = {
     [k in keyof M]: PropertyOrBuilder<M[k], M>;
 };
 /**
@@ -278,7 +288,7 @@ export interface StringProperty extends BaseProperty<string> {
     enumValues?: EnumValues;
     /**
      * You can specify a `Storage` configuration. It is used to
-     * indicate that this string refers to a path in Google Cloud Storage.
+     * indicate that this string refers to a path in your storage provider.
      */
     storage?: StorageConfig;
     /**
@@ -361,6 +371,21 @@ export interface ArrayProperty<T extends ArrayT[] = any[], ArrayT extends CMSTyp
      * Should the field be initially expanded. Defaults to `true`
      */
     expanded?: boolean;
+    /**
+     * Display the child properties directly, without being wrapped in an
+     * extendable panel.
+     */
+    minimalistView?: boolean;
+    /**
+     * Can the elements in this array be reordered. Defaults to `true`.
+     * This prop has no effect if `disabled` is set to true.
+     */
+    sortable?: boolean;
+    /**
+     * Can the elements in this array be added. Defaults to `true`
+     * This prop has no effect if `disabled` is set to true.
+     */
+    canAddElements?: boolean;
 }
 /**
  * @group Entity properties
@@ -400,6 +425,11 @@ export interface MapProperty<T extends Record<string, CMSType> = Record<string,
      * view
      */
     spreadChildren?: boolean;
+    /**
+     * Display the child properties directly, without being wrapped in an
+     * extendable panel. Note that this will also hide the title of this property.
+     */
+    minimalistView?: boolean;
     /**
      * Should the field be initially expanded. Defaults to `true`
      */
@@ -623,6 +653,12 @@ export type StorageConfig = {
      * Define maximal file size in bytes
      */
     maxSize?: number;
+    /**
+     * Use this callback to process the file before uploading it to the storage.
+     * If nothing is returned, the file is uploaded as it is.
+     * @param file
+     */
+    processFile?: (file: File) => Promise<File> | undefined;
     /**
      * Postprocess the saved value (storage path or URL)
      * after it has been resolved.

package/dist/types/side_entity_controller.d.ts

@@ -1,6 +1,7 @@
 import { EntityCollection } from "./collections";
 import { ResolvedEntityCollection } from "./resolved_entities";
 import { Entity } from "./entities";
+import { EntityFormProps } from "../form";
 /**
  * Props used to open a side dialog
  * @group Hooks and utilities
@@ -22,7 +23,7 @@ export interface EntitySidePanelProps<M extends Record<string, any> = any> {
      * Open the entity with a selected sub-collection view. If the panel for this
      * entity was already open, it is replaced.
      */
-    selectedSubPath?: string;
+    selectedTab?: string;
     /**
      * Use this prop to override the width of the form view.
      * e.g. "600px"
@@ -55,6 +56,10 @@ export interface EntitySidePanelProps<M extends Record<string, any> = any> {
      * Should this panel close when saving
      */
     closeOnSave?: boolean;
+    /**
+     * Override some form properties
+     */
+    formProps?: Partial<EntityFormProps<M>>;
 }
 /**
  * Controller to open the side dialog displaying entity forms

package/dist/util/builders.d.ts

@@ -12,7 +12,7 @@ export declare function buildCollection<M extends Record<string, any> = any, USE
  * @param property
  * @group Builder
  */
-export declare function buildProperty<T extends CMSType = CMSType, P extends PropertyOrBuilder<T> = PropertyOrBuilder<T>, M extends Record<string, any> = Record<string, any>>(property: P): P extends StringProperty ? StringProperty : P extends NumberProperty ? NumberProperty : P extends BooleanProperty ? BooleanProperty : P extends DateProperty ? DateProperty : P extends GeopointProperty ? GeopointProperty : P extends ReferenceProperty ? ReferenceProperty : P extends ArrayProperty ? ArrayProperty : P extends MapProperty ? MapProperty : P extends PropertyBuilder<T, M> ? PropertyBuilder<T, M> : never;
+export declare function buildProperty<T extends CMSType = CMSType, P extends PropertyOrBuilder<T> = PropertyOrBuilder<T>, M extends Record<string, any> = any>(property: P): P extends StringProperty ? StringProperty : P extends NumberProperty ? NumberProperty : P extends BooleanProperty ? BooleanProperty : P extends DateProperty ? DateProperty : P extends GeopointProperty ? GeopointProperty : P extends ReferenceProperty ? ReferenceProperty : P extends ArrayProperty ? ArrayProperty : P extends MapProperty ? MapProperty : P extends PropertyBuilder<T, M> ? PropertyBuilder<T, M> : never;
 /**
  * Identity function we use to defeat the type system of Typescript and preserve
  * the properties keys.

package/dist/util/createFormexStub.d.ts

@@ -0,0 +1,2 @@
+import { FormexController } from "@firecms/formex";
+export declare function createFormexStub<T extends object>(values: T): FormexController<T>;

package/dist/util/entity_actions.d.ts

@@ -0,0 +1,2 @@
+import { EntityAction } from "../types";
+export declare function mergeEntityActions(currentActions: EntityAction[], newActions: EntityAction[]): EntityAction[];

package/dist/util/entity_cache.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Saves data to the in-memory cache and persists it individually in `localStorage`.
+ * @param path - The unique path/key for the data.
+ * @param data - The data to cache and persist.
+ */
+export declare function saveEntityToCache(path: string, data: object): void;
+/**
+ * Retrieves an entity from the in-memory cache or `localStorage`.
+ * If the entity is not in the cache but exists in `localStorage`, it loads it into the cache.
+ * @param path - The unique path/key for the entity.
+ * @returns The cached entity or `undefined` if not found.
+ */
+export declare function getEntityFromCache(path: string): object | undefined;
+export declare function hasEntityInCache(path: string): boolean;
+/**
+ * Removes an entity from both the in-memory cache and `localStorage`.
+ * @param path - The unique path/key for the entity to remove.
+ */
+export declare function removeEntityFromCache(path: string): void;
+/**
+ * Clears the entire in-memory cache and removes all related entities from `localStorage`.
+ */
+export declare function clearEntityCache(): void;

package/dist/util/index.d.ts

@@ -7,6 +7,7 @@ export * from "./objects";
 export * from "./paths";
 export * from "./regexp";
 export * from "./navigation_utils";
+export * from "./entity_actions";
 export * from "./useDebouncedCallback";
 export * from "./property_utils";
 export * from "./resolutions";

package/dist/util/navigation_from_path.d.ts

@@ -4,19 +4,24 @@ export interface NavigationViewEntityInternal<M extends Record<string, any>> {
     type: "entity";
     entityId: string;
     path: string;
+    fullPath: string;
     parentCollection: EntityCollection<M>;
 }
 export interface NavigationViewCollectionInternal<M extends Record<string, any>> {
     type: "collection";
+    id: string;
     path: string;
+    fullPath: string;
     collection: EntityCollection<M>;
 }
 export interface NavigationViewEntityCustomInternal<M extends Record<string, any>> {
     type: "custom_view";
     path: string;
+    fullPath: string;
+    entityId: string;
     view: EntityCustomView<M>;
 }
-export declare function getNavigationEntriesFromPathInternal(props: {
+export declare function getNavigationEntriesFromPath(props: {
     path: string;
     collections: EntityCollection[] | undefined;
     currentFullPath?: string;

package/dist/util/navigation_utils.d.ts

@@ -1,4 +1,4 @@
-import { EntityCollection } from "../types";
+import { EntityCollection, NavigationController, SideEntityController } from "../types";
 export declare function removeInitialAndTrailingSlashes(s: string): string;
 export declare function removeInitialSlash(s: string): string;
 export declare function removeTrailingSlash(s: string): string;
@@ -18,3 +18,15 @@ export declare function getCollectionByPathOrId(pathOrId: string, collections: E
  * @param subpaths
  */
 export declare function getCollectionPathsCombinations(subpaths: string[]): string[];
+export declare function navigateToEntity({ openEntityMode, collection, entityId, copy, path, fullIdPath, selectedTab, sideEntityController, onClose, navigation }: {
+    openEntityMode: "side_panel" | "full_screen";
+    collection?: EntityCollection;
+    entityId?: string;
+    selectedTab?: string;
+    copy?: boolean;
+    path: string;
+    fullIdPath?: string;
+    sideEntityController: SideEntityController;
+    onClose?: () => void;
+    navigation: NavigationController;
+}): void;

package/dist/util/objects.d.ts

@@ -1,6 +1,6 @@
 export declare const pick: <T>(obj: T, ...args: any[]) => T;
 export declare function isObject(item: any): any;
-export declare function mergeDeep<T extends Record<any, any>, U extends Record<any, any>>(target: T, source: U): T & U;
+export declare function mergeDeep<T extends Record<any, any>, U extends Record<any, any>>(target: T, source: U, ignoreUndefined?: boolean): T & U;
 export declare function getValueInPath(o: object | undefined, path: string): any;
 export declare function removeInPath(o: object, path: string): object | undefined;
 export declare function removeFunctions(o: object | undefined): any;