@firecms/core 3.0.0-canary.14 → 3.0.0-canary.141

package/src/components/{VirtualTable/common.tsx → common/table_height.tsx}

@@ -1,6 +1,9 @@
-import { VirtualTableSize } from "./VirtualTableProps";
+/**
+ * @group Components
+ */
+export type TableSize = "xs" | "s" | "m" | "l" | "xl";
 
-export function getRowHeight(size: VirtualTableSize): number {
+export function getRowHeight(size: TableSize): number {
     switch (size) {
         case "xl":
             return 400;

package/src/components/common/types.tsx

@@ -1,4 +1,4 @@
-import { CollectionSize, Entity, FireCMSContext, ResolvedProperty, SelectedCellProps } from "../../types";
+import { CollectionSize, ResolvedProperty, SelectedCellProps } from "../../types";
 
 export type EntityCollectionTableController<M extends Record<string, any>> = {
 
@@ -31,14 +31,12 @@ export type EntityCollectionTableController<M extends Record<string, any>> = {
  * Props passed in a callback when the content of a cell in a table has been edited
  * @group Collection components
  */
-export interface OnCellValueChangeParams<T = any, M extends Record<string, any> = any> {
+export interface OnCellValueChangeParams<T = any, D = any> {
     value: T,
     propertyKey: string,
-    entity: Entity<M>,
+    data?: D,
     onValueUpdated: () => void
-    setError: (e: Error) => void
-    fullPath: string
-    context: FireCMSContext
+    setError: (e: Error | undefined) => void
 }
 
 /**

package/src/components/common/useColumnsIds.tsx

@@ -7,8 +7,16 @@ const COLLECTION_GROUP_PARENT_ID = "collectionGroupParent";
 
 export function useColumnIds<M extends Record<string, any>>(collection: ResolvedEntityCollection<M>, includeSubcollections: boolean): PropertyColumnConfig[] {
     return useMemo(() => {
-        if (collection.propertiesOrder)
-            return hideAndExpandKeys(collection, collection.propertiesOrder);
+        if (collection.propertiesOrder) {
+            const propertyColumnConfigs = hideAndExpandKeys(collection, collection.propertiesOrder);
+            if (collection.collectionGroup) {
+                propertyColumnConfigs.push({
+                    key: COLLECTION_GROUP_PARENT_ID,
+                    disabled: true
+                });
+            }
+            return propertyColumnConfigs;
+        }
         return getDefaultColumnKeys(collection, includeSubcollections);
     }, [collection, includeSubcollections]);
 }
@@ -98,3 +106,16 @@ export function getColumnKeysForProperty(property: ResolvedProperty, key: string
         disabled: disabled || Boolean(property.disabled) || Boolean(property.readOnly)
     }];
 }
+
+export function getFormFieldKeys(collection: EntityCollection): string[] {
+    const propertyKeys = Object.keys(collection.properties);
+    const additionalFields = collection.additionalFields ?? [];
+    const allKeys = [
+        ...propertyKeys,
+        ...additionalFields.map((field) => field.key)
+    ];
+    if (collection.propertiesOrder) {
+        return collection.propertiesOrder.filter(key => allKeys.includes(key));
+    }
+    return allKeys;
+}

package/src/components/common/useDataSourceEntityCollectionTableController.tsx

@@ -12,6 +12,7 @@ import {
     User
 } from "../../types";
 import { useDebouncedData } from "./useDebouncedData";
+import equal from "react-fast-compare"
 
 const DEFAULT_PAGE_SIZE = 50;
 
@@ -31,6 +32,10 @@ export type DataSourceEntityCollectionTableControllerProps<M extends Record<stri
     entitiesDisplayedFirst?: Entity<M>[];
 
     lastDeleteTimestamp?: number;
+
+    /**
+     * Force filter to be applied to the table.
+     */
     forceFilter?: FilterValues<string>;
 }
 
@@ -75,6 +80,18 @@ export function useDataSourceEntityCollectionTableController<M extends Record<st
     const [searchString, setSearchString] = React.useState<string | undefined>();
     const [itemCount, setItemCount] = React.useState<number | undefined>(paginationEnabled ? pageSize : undefined);
 
+    const checkFilterCombination = useCallback((filterValues: FilterValues<any>,
+                                                sortBy?: [string, "asc" | "desc"]) => {
+        if (!dataSource.isFilterCombinationValid)
+            return true;
+        return dataSource.isFilterCombinationValid({
+            path: resolvedPath,
+            collection,
+            filterValues,
+            sortBy
+        })
+    }, []);
+
     const initialSortInternal = useMemo(() => {
         if (initialSort && forceFilter && !checkFilterCombination(forceFilter, initialSort)) {
             console.warn("Initial sort is not compatible with the force filter. Ignoring initial sort");
@@ -83,6 +100,12 @@ export function useDataSourceEntityCollectionTableController<M extends Record<st
         return initialSort;
     }, [initialSort, forceFilter]);
 
+    useEffect(() => {
+        if (!equal(forceFilter, filterValues)) {
+            setFilterValues(forceFilter)
+        }
+    }, [forceFilter]);
+
     const [filterValues, setFilterValues] = React.useState<FilterValues<Extract<keyof M, string>> | undefined>(forceFilter ?? initialFilter ?? undefined);
     const [sortBy, setSortBy] = React.useState<[Extract<keyof M, string>, "asc" | "desc"] | undefined>(initialSortInternal);
 
@@ -97,18 +120,6 @@ export function useDataSourceEntityCollectionTableController<M extends Record<st
     const [dataLoadingError, setDataLoadingError] = useState<Error | undefined>();
     const [noMoreToLoad, setNoMoreToLoad] = useState<boolean>(false);
 
-    const checkFilterCombination = useCallback((filterValues: FilterValues<any>,
-                                                sortBy?: [string, "asc" | "desc"]) => {
-        if (!dataSource.isFilterCombinationValid)
-            return true;
-        return dataSource.isFilterCombinationValid({
-            path: resolvedPath,
-            collection,
-            filterValues,
-            sortBy
-        })
-    }, []);
-
     const clearFilter = useCallback(() => setFilterValues(forceFilter ?? undefined), [forceFilter]);
 
     const updateFilterValues = useCallback((updatedFilter: FilterValues<Extract<keyof M, string>> | undefined) => {

package/src/components/common/useTableSearchHelper.ts

@@ -1,7 +1,7 @@
 import { useState } from "react";
 
 import { EntityCollection } from "../../types";
-import { useCustomizationController, useFireCMSContext } from "../../hooks";
+import { useCustomizationController, useDataSource, useFireCMSContext } from "../../hooks";
 
 export interface UseTableSearchHelperParams<M extends Record<string, any>> {
     collection: EntityCollection<M>;
@@ -9,27 +9,58 @@ export interface UseTableSearchHelperParams<M extends Record<string, any>> {
     parentCollectionIds?: string[];
 }
 
-export function useTableSearchHelper<M extends Record<string, any>>({ collection, fullPath, parentCollectionIds }: UseTableSearchHelperParams<M>) {
+export function useTableSearchHelper<M extends Record<string, any>>({
+                                                                        collection,
+                                                                        fullPath,
+                                                                        parentCollectionIds
+                                                                    }: UseTableSearchHelperParams<M>) {
 
     const context = useFireCMSContext();
     const customizationController = useCustomizationController();
+    const dataSource = useDataSource();
 
     const [textSearchLoading, setTextSearchLoading] = useState<boolean>(false);
     const [textSearchInitialised, setTextSearchInitialised] = useState<boolean>(false);
+
     let onTextSearchClick: (() => void) | undefined;
     let textSearchEnabled = Boolean(collection.textSearchEnabled);
-    if (customizationController?.plugins) {
-        const addTextSearchClickListener = customizationController.plugins?.find(p => Boolean(p.collectionView?.onTextSearchClick));
+
+    const props = {
+        context,
+        path: fullPath,
+        databaseId: collection.databaseId,
+        collection,
+        parentCollectionIds
+    };
+
+    const searchBlocked = customizationController.plugins?.find(p => {
+        return p.collectionView?.blockSearch?.(props);
+    });
+
+    const addTextSearchClickListener = Boolean(dataSource?.initTextSearch) || customizationController.plugins?.find(p => Boolean(p.collectionView?.onTextSearchClick));
+
+    if (addTextSearchClickListener) {
 
         onTextSearchClick = addTextSearchClickListener
             ? () => {
                 setTextSearchLoading(true);
-                Promise.all(customizationController.plugins?.map(p => {
-                    if (p.collectionView?.onTextSearchClick)
-                        return p.collectionView.onTextSearchClick({ context, path: fullPath, collection, parentCollectionIds });
-                    return Promise.resolve(true);
-                }) as Promise<boolean>[])
-                    .then((res) => {
+                const promises: Promise<boolean>[] = [];
+                if (dataSource?.initTextSearch && !searchBlocked) {
+                    promises.push(dataSource.initTextSearch(props));
+                }
+                if (searchBlocked) {
+                    customizationController.plugins?.forEach(p => {
+                        if (p.collectionView?.onTextSearchClick)
+                            promises.push(p.collectionView.onTextSearchClick({
+                                context,
+                                path: fullPath,
+                                collection,
+                                parentCollectionIds
+                            }));
+                    })
+                }
+                return Promise.all(promises)
+                    .then((res: boolean[]) => {
                         if (res.every(Boolean)) setTextSearchInitialised(true);
                     })
                     .finally(() => setTextSearchLoading(false));
@@ -39,9 +70,19 @@ export function useTableSearchHelper<M extends Record<string, any>>({ collection
         customizationController.plugins?.forEach(p => {
             if (!textSearchEnabled)
                 if (p.collectionView?.showTextSearchBar) {
-                    textSearchEnabled = p.collectionView.showTextSearchBar({ context, path: fullPath, collection, parentCollectionIds });
+                    textSearchEnabled = p.collectionView.showTextSearchBar({
+                        context,
+                        path: fullPath,
+                        collection,
+                        parentCollectionIds
+                    });
                 }
         })
     }
-    return { textSearchLoading, textSearchInitialised, onTextSearchClick, textSearchEnabled };
+    return {
+        textSearchLoading,
+        textSearchInitialised,
+        onTextSearchClick,
+        textSearchEnabled
+    };
 }

package/src/components/index.tsx

@@ -13,22 +13,24 @@ export * from "./common";
 
 export * from "./HomePage";
 export * from "./SelectableTable/SelectableTable";
+export * from "./SelectableTable/SelectableTableContext";
 export * from "./EntityCollectionView/EntityCollectionView";
 export * from "./EntityCollectionView/EntityCollectionViewActions";
 export * from "./EntityCollectionView/useSelectionController";
 
 export * from "./PropertyConfigBadge";
+export * from "./PropertyIdCopyTooltip";
 
 export * from "./EntityCollectionTable";
 export * from "./NotFoundPage";
 
 export * from "./VirtualTable";
 export * from "./ErrorBoundary";
-export * from "./DeleteConfirmationDialog";
+export * from "./ConfirmationDialog";
 
 export * from "./FireCMSLogo";
 
-export * from "./FireCMSAppBar";
+export * from "../core/DefaultAppBar";
 
 export * from "./ArrayContainer";
 export * from "./ReferenceWidget";

package/src/contexts/DialogsProvider.tsx

@@ -18,14 +18,14 @@ export const DialogsProvider: React.FC<PropsWithChildren<{}>> = ({ children }) =
         if (dialogEntries.length === 0)
             return;
 
-        const updatedPanels = [...dialogEntries.slice(0, -1)];
+        const updatedPanels = [...dialogEntriesRef.current.slice(0, -1)];
         updateDialogEntries(updatedPanels);
 
     }, [dialogEntries]);
 
     const open = useCallback((dialogEntry: DialogControllerEntryProps) => {
 
-        const updatedPanels = [...dialogEntries, dialogEntry];
+        const updatedPanels = [...dialogEntriesRef.current, dialogEntry];
         updateDialogEntries(updatedPanels);
 
         return {

package/src/core/DefaultAppBar.tsx

@@ -0,0 +1,176 @@
+import React from "react";
+
+import { Link as ReactLink, useNavigate } from "react-router-dom";
+import { ErrorBoundary, FireCMSLogo } from "../components";
+import {
+    Avatar,
+    cls,
+    DarkModeIcon,
+    IconButton,
+    LightModeIcon,
+    LogoutIcon,
+    Menu,
+    MenuItem,
+    Skeleton,
+    Typography
+} from "@firecms/ui";
+import { useAuthController, useLargeLayout, useModeController, useNavigationController } from "../hooks";
+import { User } from "../types";
+import { useApp } from "../app/useApp";
+
+export type DefaultAppBarProps<ADDITIONAL_PROPS = object> = {
+
+    title?: React.ReactNode;
+    /**
+     * A component that gets rendered on the upper side of the main toolbar
+     */
+    endAdornment?: React.ReactNode;
+
+    startAdornment?: React.ReactNode;
+
+    dropDownActions?: React.ReactNode;
+
+    includeModeToggle?: boolean;
+
+    className?: string;
+
+    style?: React.CSSProperties;
+
+    logo?: string;
+
+    user?: User;
+} & ADDITIONAL_PROPS;
+
+/**
+ * This component renders the main app bar of FireCMS.
+ * You will likely not need to use this component directly.
+ *
+
+ */
+export const DefaultAppBar = function DefaultAppBar({
+                                                        title,
+                                                        endAdornment,
+                                                        startAdornment,
+                                                        dropDownActions,
+                                                        includeModeToggle = true,
+                                                        className,
+                                                        style,
+                                                        user: userProp
+                                                    }: DefaultAppBarProps) {
+
+    const {
+        hasDrawer,
+        drawerOpen,
+        logo
+    } = useApp();
+    const navigation = useNavigationController();
+
+    const authController = useAuthController();
+    const {
+        mode,
+        toggleMode
+    } = useModeController();
+
+    const navigate = useNavigate();
+
+    const largeLayout = useLargeLayout();
+
+    const user = userProp ?? authController.user;
+
+    let avatarComponent: JSX.Element;
+    if (user && user.photoURL) {
+        avatarComponent = <Avatar
+            src={user.photoURL}/>;
+    } else if (user === undefined || authController.initialLoading) {
+        avatarComponent = <div className={"p-1 flex justify-center"}>
+            <Skeleton className={"w-10 h-10 rounded-full"}/>
+        </div>;
+    } else {
+        const initial = user?.displayName
+            ? user.displayName[0].toUpperCase()
+            : (user?.email ? user.email[0].toUpperCase() : "A");
+        avatarComponent = <Avatar>{initial}</Avatar>;
+    }
+
+    return (
+        <div
+            style={style}
+            className={cls("w-full h-16 transition-all ease-in duration-75 absolute top-0 max-w-full overflow-x-auto no-scrollbar",
+                "flex flex-row gap-2 px-4 items-center",
+                {
+                    "pl-[19rem]": drawerOpen && largeLayout,
+                    "pl-24": hasDrawer && !(drawerOpen && largeLayout),
+                    "z-10": largeLayout,
+                    "duration-100": drawerOpen && largeLayout,
+                },
+                className)}>
+
+
+            {navigation && <div className="mr-8 hidden lg:block">
+                <ReactLink
+                    className="visited:text-inherit visited:dark:text-inherit"
+                    to={navigation?.basePath ?? "/"}
+                >
+                    <div className={"flex flex-row gap-4"}>
+                        {!hasDrawer && (logo
+                            ? <img src={logo}
+                                   alt="Logo"
+                                   className={cls("w-[32px] h-[32px] object-contain")}/>
+                            : <FireCMSLogo width={"32px"} height={"32px"}/>)}
+
+                        {typeof title === "string"
+                            ? <Typography variant="subtitle1"
+                                          noWrap
+                                          className={cls("transition-all", drawerOpen ? "ml-2" : "")}>
+                                {title}
+                            </Typography>
+                            : title}
+                    </div>
+                </ReactLink>
+            </div>}
+
+            {startAdornment}
+
+            <div className={"flex-grow"}/>
+
+            {endAdornment &&
+                <ErrorBoundary>
+                    {endAdornment}
+                </ErrorBoundary>}
+
+            {includeModeToggle && <IconButton
+                color="inherit"
+                aria-label="Open drawer"
+                onClick={toggleMode}
+                size="large">
+                {mode === "dark"
+                    ? <DarkModeIcon/>
+                    : <LightModeIcon/>}
+            </IconButton>}
+
+            <Menu trigger={avatarComponent}>
+                {user && <div className={"px-4 py-2 mb-2"}>
+                    {user.displayName && <Typography variant={"body1"} color={"secondary"}>
+                        {user.displayName}
+                    </Typography>}
+                    {user.email && <Typography variant={"body2"} color={"secondary"}>
+                        {user.email}
+                    </Typography>}
+                </div>}
+
+                {dropDownActions}
+
+                {!dropDownActions && <MenuItem onClick={async () => {
+                    await authController.signOut();
+                    // replace current route with home
+                    navigate("/");
+                }}>
+                    <LogoutIcon/>
+                    Log Out
+                </MenuItem>}
+
+            </Menu>
+
+        </div>
+    );
+}

package/src/core/DefaultDrawer.tsx

@@ -0,0 +1,183 @@
+import React, { useCallback } from "react";
+
+import { useLargeLayout, useNavigationController } from "../hooks";
+
+import { Link, useNavigate } from "react-router-dom";
+import { CMSAnalyticsEvent, TopNavigationEntry, TopNavigationResult } from "../types";
+import { IconForView } from "../util";
+import { cls, IconButton, Menu, MenuItem, MoreVertIcon, Tooltip, Typography } from "@firecms/ui";
+import { useAnalyticsController } from "../hooks/useAnalyticsController";
+import { DrawerNavigationItem } from "./DrawerNavigationItem";
+import { FireCMSLogo } from "../components";
+import { useApp } from "../app/useApp";
+
+/**
+ * Default drawer used in the CMS
+ * @group Core
+ */
+export function DefaultDrawer({
+                                  className,
+                                  style,
+                              }: {
+    className?: string
+    style?: React.CSSProperties,
+}) {
+
+    const {
+        drawerHovered,
+        drawerOpen,
+        closeDrawer,
+        logo
+    } = useApp();
+
+    const [adminMenuOpen, setAdminMenuOpen] = React.useState(false);
+
+    const analyticsController = useAnalyticsController();
+    const navigation = useNavigationController();
+
+    const tooltipsOpen = drawerHovered && !drawerOpen && !adminMenuOpen;
+    const largeLayout = useLargeLayout();
+    const navigate = useNavigate();
+
+    if (!navigation.topLevelNavigation)
+        throw Error("Navigation not ready in Drawer");
+
+    const {
+        navigationEntries,
+        groups
+    }: TopNavigationResult = navigation.topLevelNavigation;
+
+    const adminViews = navigationEntries.filter(e => e.type === "admin") ?? [];
+    const groupsWithoutAdmin = groups.filter(g => g !== "Admin");
+
+    const buildGroupHeader = useCallback((group?: string) => {
+        if (!drawerOpen) return <div className="w-full"/>;
+        return <div
+            className="pl-6 pr-8 py-4 flex flex-row items-center">
+            <Typography variant={"caption"}
+                        color={"secondary"}
+                        className="font-medium flex-grow line-clamp-1">
+                {group ? group.toUpperCase() : "Views".toUpperCase()}
+            </Typography>
+
+        </div>;
+    }, [drawerOpen]);
+
+    const onClick = (view: TopNavigationEntry) => {
+        const eventName: CMSAnalyticsEvent = view.type === "collection"
+            ? "drawer_navigate_to_collection"
+            : (view.type === "view" ? "drawer_navigate_to_view" : "unmapped_event");
+        analyticsController.onAnalyticsEvent?.(eventName, { url: view.url });
+        if (!largeLayout)
+            closeDrawer();
+    };
+
+    return (
+        <>
+            <div className={cls("flex flex-col h-full relative flex-grow w-full", className)} style={style}>
+
+                <DrawerLogo logo={logo}/>
+
+                <div className={"mt-4 flex-grow overflow-scroll no-scrollbar"}
+                style={{
+                    maskImage: "linear-gradient(to bottom, transparent 0, black 20px, black calc(100% - 20px), transparent 100%)",
+                }}>
+
+                    {groupsWithoutAdmin.map((group) => (
+                        <div
+                            className={"bg-gray-50 dark:bg-gray-800 dark:bg-opacity-30 my-4 rounded-lg ml-4"}
+                            key={`drawer_group_${group}`}>
+                            {buildGroupHeader(group)}
+                            {Object.values(navigationEntries)
+                                .filter(e => e.group === group)
+                                .map((view, index) =>
+                                    <DrawerNavigationItem
+                                        key={`navigation_${index}`}
+                                        icon={<IconForView collectionOrView={view.collection ?? view.view} size={"small"}/>}
+                                        tooltipsOpen={tooltipsOpen}
+                                        adminMenuOpen={adminMenuOpen}
+                                        drawerOpen={drawerOpen}
+                                        onClick={() => onClick(view)}
+                                        url={view.url}
+                                        name={view.name}/>)}
+                        </div>
+                    ))}
+
+                </div>
+
+                {adminViews.length > 0 && <Menu
+                    side={"right"}
+                    open={adminMenuOpen}
+                    onOpenChange={setAdminMenuOpen}
+                    trigger={
+                        <IconButton
+                            shape={"square"}
+                            className={"m-4 text-gray-900 dark:text-white w-fit"}>
+                            <Tooltip title={"Admin"}
+                                     open={tooltipsOpen}
+                                     side={"right"} sideOffset={28}>
+                                <MoreVertIcon/>
+                            </Tooltip>
+                            {drawerOpen && <div
+                                className={cls(
+                                    drawerOpen ? "opacity-100" : "opacity-0 hidden",
+                                    "mx-4 font-inherit text-inherit"
+                                )}>
+                                ADMIN
+                            </div>}
+                        </IconButton>}
+                >
+                    {adminViews.map((entry, index) =>
+                        <MenuItem
+                            onClick={(event) => {
+                                event.preventDefault();
+                                navigate(entry.path);
+                            }}
+                            key={`navigation_${index}`}>
+                            {<IconForView collectionOrView={entry.view}/>}
+                            {entry.name}
+                        </MenuItem>)}
+
+                </Menu>}
+            </div>
+
+        </>
+    );
+}
+
+/**
+ * This is the logo displayed in the drawer
+ * It expands when the drawer is open.
+ *
+ * @param logo
+
+ */
+export function DrawerLogo({ logo }: {
+    logo?: string;
+}) {
+
+    const navigation = useNavigationController();
+    const { drawerOpen } = useApp();
+    return <div
+        style={{
+            transition: "padding 100ms cubic-bezier(0.4, 0, 0.6, 1) 0ms",
+            padding: drawerOpen ? "32px 144px 0px 24px" : "72px 12px 0px 12px"
+        }}
+        className={cls("cursor-pointer ml-4")}>
+
+        <Tooltip title={"Home"}
+                 sideOffset={20}
+                 side="right">
+            <Link
+                to={navigation.basePath}>
+                {logo
+                    ? <img src={logo}
+                           alt="Logo"
+                           className={cls("max-w-full max-h-full",
+                               drawerOpen ?? "w-[112px] h-[112px]")}/>
+                    : <FireCMSLogo/>}
+
+            </Link>
+        </Tooltip>
+    </div>;
+}