@firecms/core 3.0.0-canary.248 → 3.0.0-canary.249

package/dist/components/HomePage/DefaultHomePage.d.ts

@@ -1,21 +1,8 @@
 import React from "react";
-/**
- * Default entry view for the CMS. This component renders navigation cards
- * for each collection defined in the navigation.
-
- * @group Components
- */
+export declare const DEFAULT_GROUP_NAME = "Views";
+export declare const ADMIN_GROUP_NAME = "Admin";
 export declare function DefaultHomePage({ additionalActions, additionalChildrenStart, additionalChildrenEnd }: {
-    /**
-     * Additional actions to be rendered in the home page, close to the search bar.
-     */
     additionalActions?: React.ReactNode;
-    /**
-     * Additional children to be rendered in the beginning of the home page.
-     */
     additionalChildrenStart?: React.ReactNode;
-    /**
-     * Additional children to be rendered at the end of the home page.
-     */
     additionalChildrenEnd?: React.ReactNode;
 }): import("react/jsx-runtime").JSX.Element;

package/dist/components/HomePage/HomePageDnD.d.ts

@@ -0,0 +1,76 @@
+import React from "react";
+import { Active, CollisionDetection, DropAnimation, UniqueIdentifier } from "@dnd-kit/core";
+import { NavigationEntry } from "../../types";
+export declare function SortableNavigationCard({ entry, onClick }: {
+    entry: NavigationEntry;
+    onClick?: () => void;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function NavigationGroupDroppable({ id, itemIds, children, isPotentialCardDropTarget }: {
+    id: UniqueIdentifier;
+    itemIds: UniqueIdentifier[];
+    children: React.ReactNode;
+    isPotentialCardDropTarget?: boolean;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function SortableNavigationGroup({ groupName, children, disabled }: {
+    groupName: string;
+    children: React.ReactNode;
+    disabled?: boolean;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function useHomePageDnd({ items: dndItems, setItems: setDndItems, disabled, onCardMovedBetweenGroups, onGroupMoved, onNewGroupDrop, onPersist }: {
+    items: {
+        name: string;
+        entries: NavigationEntry[];
+    }[];
+    setItems: (newItemsOrUpdater: {
+        name: string;
+        entries: NavigationEntry[];
+    }[] | ((currentItems: {
+        name: string;
+        entries: NavigationEntry[];
+    }[]) => {
+        name: string;
+        entries: NavigationEntry[];
+    }[])) => void;
+    disabled: boolean;
+    onCardMovedBetweenGroups?: (card: NavigationEntry) => void;
+    onGroupMoved?: (groupName: string, oldIndex: number, newIndex: number) => void;
+    onNewGroupDrop?: () => void;
+    onPersist?: (latest: {
+        name: string;
+        entries: NavigationEntry[];
+    }[]) => void;
+}): {
+    sensors: import("@dnd-kit/core").SensorDescriptor<import("@dnd-kit/core").SensorOptions>[];
+    collisionDetection: CollisionDetection;
+    onDragStart: ({ active }: {
+        active: Active;
+    }) => void;
+    onDragOver: ({ active, over }: {
+        active: Active;
+        over: any;
+    }) => void;
+    onDragEnd: ({ active, over }: {
+        active: Active;
+        over: any;
+    }) => void;
+    onDragCancel: () => void;
+    dropAnimation: DropAnimation;
+    activeItemForOverlay: NavigationEntry | null;
+    activeGroupData: {
+        name: string;
+        entries: NavigationEntry[];
+    } | null;
+    draggingGroupId: UniqueIdentifier | null;
+    containers: string[];
+    dndKitActiveNode: Active | null;
+    isDraggingCardOnly: boolean;
+    dialogOpenForGroup: string | null;
+    setDialogOpenForGroup: React.Dispatch<React.SetStateAction<string | null>>;
+    handleRenameGroup: (oldName: string, newName: string) => void;
+    isHoveringNewGroupDropZone: boolean;
+    setIsHoveringNewGroupDropZone: React.Dispatch<React.SetStateAction<boolean>>;
+};
+export declare function NewGroupDropZone({ disabled, setIsHovering }: {
+    disabled: boolean;
+    setIsHovering: (v: boolean) => void;
+}): import("react/jsx-runtime").JSX.Element | null;

package/dist/components/HomePage/NavigationCard.d.ts

@@ -1,8 +1,10 @@
+import React from "react";
 export type NavigationCardProps = {
     name: string;
     description?: string;
     actions: React.ReactNode;
     icon: React.ReactNode;
     onClick?: () => void;
+    shrink?: boolean;
 };
-export declare function NavigationCard({ name, description, icon, actions, onClick, }: NavigationCardProps): import("react/jsx-runtime").JSX.Element;
+export declare const NavigationCard: React.NamedExoticComponent<NavigationCardProps>;

package/dist/components/HomePage/NavigationCardBinding.d.ts

@@ -1,4 +1,4 @@
-import { TopNavigationEntry } from "../../types";
+import { NavigationEntry } from "../../types";
 /**
  * This is the component used in the home page to render a card for each
  * collection or view.
@@ -12,6 +12,7 @@ import { TopNavigationEntry } from "../../types";
  * @param onClick
 
  */
-export declare function NavigationCardBinding({ path, collection, view, url, name, description, onClick, type }: TopNavigationEntry & {
+export declare function NavigationCardBinding({ path, collection, view, url, name, description, onClick, type, shrink }: NavigationEntry & {
     onClick?: () => void;
+    shrink?: boolean;
 }): import("react/jsx-runtime").JSX.Element;

package/dist/components/HomePage/NavigationGroup.d.ts

@@ -1,4 +1,10 @@
 import { PropsWithChildren } from "react";
-export declare function NavigationGroup({ children, group }: PropsWithChildren<{
+export declare function NavigationGroup({ children, group, minimised, isPreview, isPotentialCardDropTarget, onEditGroup, // New prop to handle editing
+dndDisabled }: PropsWithChildren<{
     group: string | undefined;
+    minimised?: boolean;
+    isPreview?: boolean;
+    isPotentialCardDropTarget?: boolean;
+    onEditGroup?: (groupName: string) => void;
+    dndDisabled?: boolean;
 }>): import("react/jsx-runtime").JSX.Element;

package/dist/components/HomePage/RenameGroupDialog.d.ts

@@ -0,0 +1,9 @@
+interface RenameGroupDialogProps {
+    open: boolean;
+    initialName: string;
+    existingGroupNames: string[];
+    onClose: () => void;
+    onRename: (newName: string) => void;
+}
+export declare function RenameGroupDialog({ open, initialName, existingGroupNames, onClose, onRename }: RenameGroupDialogProps): import("react/jsx-runtime").JSX.Element | null;
+export {};

package/dist/core/field_configs.d.ts

@@ -3,5 +3,5 @@ export declare function isDefaultFieldConfigId(id: string): boolean;
 export declare const DEFAULT_FIELD_CONFIGS: Record<string, PropertyConfig<any>>;
 export declare function getDefaultFieldConfig(property: Property | ResolvedProperty): PropertyConfig | undefined;
 export declare function getFieldConfig(property: Property | ResolvedProperty, propertyConfigs: Record<string, PropertyConfig<any>>): PropertyConfig | undefined;
-export declare function getDefaultFieldId(property: Property | ResolvedProperty): "reference" | "date_time" | "text_field" | "multiline" | "markdown" | "url" | "email" | "select" | "multi_select" | "number_input" | "number_select" | "multi_number_select" | "file_upload" | "multi_file_upload" | "group" | "key_value" | "multi_references" | "switch" | "repeat" | "custom_array" | "block" | undefined;
+export declare function getDefaultFieldId(property: Property | ResolvedProperty): "reference" | "date_time" | "text_field" | "multiline" | "markdown" | "url" | "email" | "select" | "multi_select" | "number_input" | "number_select" | "multi_number_select" | "file_upload" | "multi_file_upload" | "group" | "key_value" | "reference_as_string" | "multi_references" | "switch" | "repeat" | "custom_array" | "block" | undefined;
 export declare function getFieldId(property: Property | ResolvedProperty): string | undefined;

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

@@ -0,0 +1,9 @@
+import { FieldProps } from "../../types";
+/**
+ * Field that opens a reference selection dialog and stores the entity ID as a string.
+ *
+ * This is one of the internal components that get mapped natively inside forms
+ * and tables to the specified properties.
+ * @group Form fields
+ */
+export declare function ReferenceAsStringFieldBinding(props: FieldProps<string>): import("react/jsx-runtime").JSX.Element;

package/dist/form/index.d.ts

@@ -7,6 +7,7 @@ export { TextFieldBinding } from "./field_bindings/TextFieldBinding";
 export { SwitchFieldBinding } from "./field_bindings/SwitchFieldBinding";
 export { DateTimeFieldBinding } from "./field_bindings/DateTimeFieldBinding";
 export { ReferenceFieldBinding } from "./field_bindings/ReferenceFieldBinding";
+export { ReferenceAsStringFieldBinding } from "./field_bindings/ReferenceAsStringFieldBinding";
 export { MapFieldBinding } from "./field_bindings/MapFieldBinding";
 export { KeyValueFieldBinding } from "./field_bindings/KeyValueFieldBinding";
 export { RepeatFieldBinding } from "./field_bindings/RepeatFieldBinding";

package/dist/hooks/useBuildNavigationController.d.ts

@@ -1,19 +1,68 @@
-import { AuthController, CMSView, CMSViewsBuilder, DataSourceDelegate, EntityCollection, EntityCollectionsBuilder, FireCMSPlugin, NavigationController, PermissionsBuilder, User, UserConfigurationPersistence } from "../types";
+import { AuthController, CMSView, CMSViewsBuilder, DataSourceDelegate, EntityCollection, EntityCollectionsBuilder, FireCMSPlugin, NavigationController, NavigationGroupMapping, PermissionsBuilder, User, UserConfigurationPersistence } from "../types";
+export declare const NAVIGATION_DEFAULT_GROUP_NAME = "Views";
+export declare const NAVIGATION_ADMIN_GROUP_NAME = "Admin";
 export type BuildNavigationContextProps<EC extends EntityCollection, USER extends User> = {
+    /**
+     * Base path for the CMS, used to build the all the URLs.
+     * Defaults to "/".
+     */
     basePath?: string;
+    /**
+     * Base path for the collections, used to build the collection URLs.
+     * Defaults to "c" (e.g. "/c/products").
+     */
     baseCollectionPath?: string;
+    /**
+     * The auth controller used to manage the user authentication and permissions.
+     */
     authController: AuthController<USER>;
+    /**
+     * The collections to be used in the CMS.
+     * This can be a static array of collections or a function that returns a promise
+     * resolving to an array of collections.
+     */
     collections?: EC[] | EntityCollectionsBuilder<EC>;
+    /**
+     * Optional permissions builder to be applied to the collections.
+     * If not provided, the permissions will be resolved from the collection configuration.
+     */
     collectionPermissions?: PermissionsBuilder;
+    /**
+     * Custom views to be added to the CMS, these will be available in the main navigation.
+     * This can be a static array of views or a function that returns a promise
+     * resolving to an array of views.
+     */
     views?: CMSView[] | CMSViewsBuilder;
+    /**
+     * Custom views to be added to the CMS admin navigation.
+     * This can be a static array of views or a function that returns a promise
+     * resolving to an array of views.
+     */
     adminViews?: CMSView[] | CMSViewsBuilder;
-    viewsOrder?: string[];
+    /**
+     * Controller for storing user preferences.
+     */
     userConfigPersistence?: UserConfigurationPersistence;
+    /**
+     * Delegate for data source operations, used to resolve collections and views.
+     */
     dataSourceDelegate: DataSourceDelegate;
+    /**
+     * Plugins to be used in the CMS.
+     */
     plugins?: FireCMSPlugin[];
+    /**
+     * Used to define the name of groups and order of the navigation entries.
+     */
+    navigationGroupMappings?: NavigationGroupMapping[];
     /**
      * If true, the navigation logic will not be updated until this flag is false
      */
     disabled?: boolean;
+    /**
+     * @deprecated
+     * Use `navigationGroupMappings` instead.
+     */
+    viewsOrder?: string[];
 };
 export declare function useBuildNavigationController<EC extends EntityCollection, USER extends User>(props: BuildNavigationContextProps<EC, USER>): NavigationController;