@firecms/collection_editor 3.0.0-canary.7 → 3.0.0-canary.70

package/src/ui/collection_editor/properties/MapPropertyField.tsx

@@ -1,11 +1,10 @@
-import React, { useCallback, useState } from "react";
-import { MapProperty, Property, PropertyConfig, } from "@firecms/core";
+import React, { useState } from "react";
+import { FieldCaption, MapProperty, Property, PropertyConfig, } from "@firecms/core";
 import { AddIcon, BooleanSwitchWithLabel, Button, Paper, Typography } from "@firecms/ui";
 import { PropertyFormDialog } from "../PropertyEditView";
 import { getIn, useFormex } from "@firecms/formex";
 import { PropertyTree } from "../PropertyTree";
 import { getFullId, idToPropertiesPath, namespaceToPropertiesOrderPath, namespaceToPropertiesPath } from "../util";
-import { FieldHelperView } from "./FieldHelperView";
 
 export function MapPropertyField({ disabled, getData, allowDataInference, propertyConfigs, collectionEditable }: {
     disabled: boolean;
@@ -43,7 +42,7 @@ export function MapPropertyField({ disabled, getData, allowDataInference, proper
         setPropertyDialogOpen(false);
     };
 
-    const deleteProperty = useCallback((propertyKey?: string, namespace?: string) => {
+    const deleteProperty = (propertyKey?: string, namespace?: string) => {
         const fullId = propertyKey ? getFullId(propertyKey, namespace) : undefined;
         if (!fullId)
             throw Error("collection editor miss config");
@@ -59,16 +58,16 @@ export function MapPropertyField({ disabled, getData, allowDataInference, proper
         setPropertyDialogOpen(false);
         setSelectedPropertyKey(undefined);
         setSelectedPropertyNamespace(undefined);
-    }, [setFieldValue, values]);
+    };
 
     const selectedPropertyFullId = selectedPropertyKey ? getFullId(selectedPropertyKey, selectedPropertyNamespace) : undefined;
     const selectedProperty = selectedPropertyFullId ? getIn(values.properties, selectedPropertyFullId.replaceAll(".", ".properties.")) : undefined;
 
     const empty = !propertiesOrder || propertiesOrder.length < 1;
 
-    const onPropertyMove = useCallback((propertiesOrder: string[], namespace?: string) => {
+    const onPropertyMove = (propertiesOrder: string[], namespace?: string) => {
         setFieldValue(namespaceToPropertiesOrderPath(namespace), propertiesOrder, false);
-    }, []);
+    };
 
     return (
         <>
@@ -113,9 +112,9 @@ export function MapPropertyField({ disabled, getData, allowDataInference, proper
                     onValueChange={(v) => setFieldValue("spreadChildren", v)}
                     value={values.spreadChildren ?? false}
                 />
-                <FieldHelperView>
+                <FieldCaption>
                     Set this flag to true if you want to display the children of this group as individual columns.
-                </FieldHelperView>
+                </FieldCaption>
             </div>
 
             <PropertyFormDialog

package/src/ui/collection_editor/properties/ReferencePropertyField.tsx

@@ -1,8 +1,7 @@
 import React from "react";
 import { Field, getIn, useFormex } from "@firecms/formex";
-import { IconForView, NumberProperty, StringProperty, useNavigationController } from "@firecms/core";
+import { FieldCaption, IconForView, NumberProperty, StringProperty, useNavigationController } from "@firecms/core";
 import { CircularProgress, Select, SelectGroup, SelectItem, Typography, } from "@firecms/ui";
-import { FieldHelperView } from "./FieldHelperView";
 
 export function ReferencePropertyField({
                                            existing,
@@ -152,10 +151,10 @@ export function CollectionsSelect({
 
             </Select>
 
-            <FieldHelperView>
+            <FieldCaption>
                 You can only edit the reference collection upon field
                 creation.
-            </FieldHelperView>
+            </FieldCaption>
         </>
     );
 }

package/src/ui/collection_editor/properties/RepeatPropertyField.tsx

@@ -39,7 +39,6 @@ export function RepeatPropertyField({
 
     const onPropertyChanged = ({ id, property, namespace }:
                                    { id?: string, property: Property, namespace?: string }) => {
-        console.log("onPropertyChanged", id, property, namespace);
         setFieldValue("of", property);
     };
 

package/src/ui/collection_editor/properties/validation/StringPropertyValidation.tsx

@@ -1,10 +1,9 @@
 import React from "react";
 
 import { Field, FormexFieldProps, getIn, useFormex } from "@firecms/formex";
-import { serializeRegExp } from "@firecms/core";
+import { FieldCaption, serializeRegExp } from "@firecms/core";
 import { DebouncedTextField, } from "@firecms/ui";
 import { GeneralPropertyValidation } from "./GeneralPropertyValidation";
-import { FieldHelperView } from "../FieldHelperView";
 import { SwitchControl } from "../../SwitchControl";
 
 export function StringPropertyValidation({
@@ -140,9 +139,9 @@ export function StringPropertyValidation({
                        disabled={disabled}
                        value={matchesStringValue}
                        error={Boolean(matchesError)}/>
-                <FieldHelperView error={Boolean(matchesError)}>
+                <FieldCaption error={Boolean(matchesError)}>
                     {matchesError ? "Not a valid regexp" : "e.g. /^\\d+$/ for digits only"}
-                </FieldHelperView>
+                </FieldCaption>
             </div>}
 
         </div>

package/src/ui/collection_editor/utils/supported_fields.tsx

@@ -1,6 +1,6 @@
-import { DEFAULT_FIELD_CONFIGS, FieldConfigId, PropertyConfig } from "@firecms/core";
+import { DEFAULT_FIELD_CONFIGS, PropertyConfigId, PropertyConfig } from "@firecms/core";
 
-export const supportedFieldsIds: FieldConfigId[] = [
+export const supportedFieldsIds: PropertyConfigId[] = [
     "text_field",
     "multiline",
     "markdown",
@@ -24,6 +24,6 @@ export const supportedFieldsIds: FieldConfigId[] = [
 ];
 
 export const supportedFields: Record<string, PropertyConfig> = Object.entries(DEFAULT_FIELD_CONFIGS)
-    .filter(([id]) => supportedFieldsIds.includes(id as FieldConfigId))
+    .filter(([id]) => supportedFieldsIds.includes(id as PropertyConfigId))
     .map(([id, config]) => ({ [id]: config }))
     .reduce((a, b) => ({ ...a, ...b }), {});

package/src/useCollectionEditorPlugin.tsx

@@ -4,16 +4,16 @@ import { ConfigControllerProvider } from "./ConfigControllerProvider";
 import { CollectionEditorPermissionsBuilder } from "./types/config_permissions";
 import { EditorCollectionAction } from "./ui/EditorCollectionAction";
 import { HomePageEditorCollectionAction } from "./ui/HomePageEditorCollectionAction";
-import { NewCollectionCard } from "./ui/NewCollectionCard";
 import { PersistedCollection } from "./types/persisted_collection";
 import { CollectionInference } from "./types/collection_inference";
 import { CollectionsConfigController } from "./types/config_controller";
-import { RootCollectionSuggestions } from "./ui/RootCollectionSuggestions";
 import { CollectionViewHeaderAction } from "./ui/CollectionViewHeaderAction";
 import { PropertyAddColumnComponent } from "./ui/PropertyAddColumnComponent";
 import { NewCollectionButton } from "./ui/NewCollectionButton";
-import { AddIcon, Button, Typography } from "@firecms/ui";
+import { AddIcon, Button, Paper, Typography } from "@firecms/ui";
 import { useCollectionEditorController } from "./useCollectionEditorController";
+import { EditorCollectionActionStart } from "./ui/EditorCollectionActionStart";
+import { NewCollectionCard } from "./ui/NewCollectionCard";
 
 export interface CollectionConfigControllerProps<EC extends PersistedCollection = PersistedCollection, UserType extends User = User> {
 
@@ -32,7 +32,7 @@ export interface CollectionConfigControllerProps<EC extends PersistedCollection
      * names when creating collections.
      * e.g. ["admin"]
      */
-    reservedGroups: string[];
+    reservedGroups?: string[];
 
     extraView?: {
         View: React.ComponentType<{
@@ -41,18 +41,16 @@ export interface CollectionConfigControllerProps<EC extends PersistedCollection
         icon: React.ReactNode
     };
 
-    pathSuggestions?: (path: string) => Promise<string[]>;
+    getPathSuggestions?: (path?: string) => Promise<string[]>;
 
     collectionInference?: CollectionInference;
 
     getData?: (path: string, parentPaths: string[]) => Promise<object[]>;
 
-    getUser: (uid: string) => UserType | null;
+    getUser?: (uid: string) => UserType | null;
 
     onAnalyticsEvent?: (event: string, params?: object) => void;
 
-    introMode?: "new_project" | "existing_project";
-
 }
 
 /**
@@ -62,18 +60,17 @@ export interface CollectionConfigControllerProps<EC extends PersistedCollection
  * @param configPermissions
  * @param reservedGroups
  * @param extraView
- * @param pathSuggestions
+ * @param getPathsSuggestions
  * @param getUser
  * @param collectionInference
  */
 export function useCollectionEditorPlugin<EC extends PersistedCollection = PersistedCollection, UserType extends User = User>
 ({
      collectionConfigController,
-     introMode,
      configPermissions,
      reservedGroups,
      extraView,
-     pathSuggestions,
+     getPathSuggestions,
      getUser,
      collectionInference,
      getData,
@@ -81,11 +78,8 @@ export function useCollectionEditorPlugin<EC extends PersistedCollection = Persi
  }: CollectionConfigControllerProps<EC, UserType>): FireCMSPlugin<any, any, PersistedCollection> {
 
     return {
-        name: "Collection Editor",
+        key: "collection_editor",
         loading: collectionConfigController.loading,
-        collections: {
-            CollectionActions: EditorCollectionAction
-        },
         provider: {
             Component: ConfigControllerProvider,
             props: {
@@ -94,7 +88,7 @@ export function useCollectionEditorPlugin<EC extends PersistedCollection = Persi
                 collectionInference,
                 reservedGroups,
                 extraView,
-                pathSuggestions,
+                getPathSuggestions,
                 getUser,
                 getData,
                 onAnalyticsEvent
@@ -102,21 +96,21 @@ export function useCollectionEditorPlugin<EC extends PersistedCollection = Persi
         },
         homePage: {
             additionalActions: <NewCollectionButton/>,
-            additionalChildrenStart: introMode ? <IntroWidget introMode={introMode}/> : undefined,
-            additionalChildrenEnd: <RootCollectionSuggestions introMode={introMode}/>,
+            additionalChildrenStart: <IntroWidget/>,
+            // additionalChildrenEnd: <RootCollectionSuggestions introMode={introMode}/>,
             CollectionActions: HomePageEditorCollectionAction,
-            AdditionalCards: introMode ? undefined : NewCollectionCard,
+            AdditionalCards: NewCollectionCard,
         },
         collectionView: {
+            CollectionActionsStart: EditorCollectionActionStart,
+            CollectionActions: EditorCollectionAction,
             HeaderAction: CollectionViewHeaderAction,
             AddColumnComponent: PropertyAddColumnComponent
         }
     };
 }
 
-export function IntroWidget({ introMode }: {
-    introMode?: "new_project" | "existing_project";
-}) {
+export function IntroWidget({}: {}) {
 
     const navigation = useNavigationController();
     if (!navigation.topLevelNavigation)
@@ -131,17 +125,19 @@ export function IntroWidget({ introMode }: {
         }).createCollections
         : true;
 
+    if (!navigation.initialised || (navigation.collections ?? []).length > 0) {
+        return null;
+    }
+
     return (
-        <div className={"mt-8 flex flex-col mt-8 p-2"}>
-            <Typography variant={"h4"} className="mb-4">Welcome</Typography>
-            <Typography paragraph={true}>Your admin panel is ready ✌️</Typography>
-            <Typography paragraph={true}>
+        <Paper
+            className={"my-4 px-4 py-6 flex flex-col  bg-white dark:bg-slate-800 gap-2"}>
+            <Typography variant={"subtitle2"} className={"uppercase"}>No collections found</Typography>
+            <Typography>
                 Start building collections in FireCMS easily. Map them to your existing
-                database data, import from files, or use our templates. Simplify your data management process
-                now.
+                database data, import from files, or use our templates.
             </Typography>
             {canCreateCollections && <Button
-                className={"mt-4"}
                 onClick={collectionEditorController && canCreateCollections
                     ? () => collectionEditorController.createCollection({
                         parentCollectionIds: [],
@@ -151,6 +147,9 @@ export function IntroWidget({ introMode }: {
                     : undefined}>
                 <AddIcon/>Create your first collection
             </Button>}
-        </div>
+            <Typography variant={"caption"} color={"secondary"}>
+                You can also define collections programmatically.
+            </Typography>
+        </Paper>
     );
 }

package/src/utils/collections.ts

@@ -0,0 +1,30 @@
+import {
+    EntityCollection,
+    joinCollectionLists,
+    makePropertiesEditable,
+    ModifyCollectionProps,
+    Properties
+} from "@firecms/core";
+import { PersistedCollection } from "../types/persisted_collection";
+
+/**
+ * Function in charge of merging collections defined in code with those stored in the backend.
+ */
+export const mergeCollections = (baseCollections: EntityCollection[],
+                                 backendCollections: PersistedCollection[],
+                                 modifyCollection?: (props: ModifyCollectionProps) => EntityCollection | void
+) => {
+
+    const markAsEditable = (c: PersistedCollection) => {
+        makePropertiesEditable(c.properties as Properties);
+        c.subcollections?.forEach(markAsEditable);
+    };
+    const storedCollections = backendCollections ?? [];
+    storedCollections.forEach(markAsEditable);
+
+    console.debug("Collections specified in code:", baseCollections);
+    console.debug("Collections stored in the backend", storedCollections);
+    const result = joinCollectionLists(baseCollections, storedCollections, [], modifyCollection);
+    console.debug("Collections after joining:", result);
+    return result;
+}

package/dist/ui/RootCollectionSuggestions.d.ts

@@ -1,3 +0,0 @@
-export declare function RootCollectionSuggestions({ introMode }: {
-    introMode?: "new_project" | "existing_project";
-}): import("react/jsx-runtime").JSX.Element;

package/dist/ui/collection_editor/properties/FieldHelperView.d.ts

@@ -1,4 +0,0 @@
-export declare function FieldHelperView({ error, children }: {
-    error?: boolean;
-    children?: React.ReactNode;
-}): import("react/jsx-runtime").JSX.Element | null;

package/src/ui/RootCollectionSuggestions.tsx

@@ -1,63 +0,0 @@
-import { unslugify, useAuthController, useNavigationController } from "@firecms/core";
-import { AddIcon, Chip, CircularProgress, Collapse, Typography, } from "@firecms/ui";
-import { useCollectionEditorController } from "../useCollectionEditorController";
-import React from "react";
-
-export function RootCollectionSuggestions({ introMode }: { introMode?: "new_project" | "existing_project" }) {
-
-    const authController = useAuthController();
-    const navigationController = useNavigationController();
-
-    const collectionEditorController = useCollectionEditorController();
-    const canCreateCollections = collectionEditorController.configPermissions
-        ? collectionEditorController.configPermissions({
-            user: authController.user
-        }).createCollections
-        : true;
-
-    const rootPathSuggestions = collectionEditorController.rootPathSuggestions;
-
-    const showSuggestions = (rootPathSuggestions ?? []).length > 3 || ((navigationController.collections ?? []).length === 0 && (rootPathSuggestions ?? []).length > 0);
-    const forceShowSuggestions = introMode === "existing_project";
-    return <Collapse
-        in={forceShowSuggestions || showSuggestions}>
-
-        <div
-            className={"flex flex-col gap-1 p-2 my-4"}>
-
-            {!introMode && <Typography variant={"body2"} color={"secondary"}>
-                Create a collection <b>automatically</b> from your data:
-            </Typography>}
-
-            {introMode === "existing_project" && <Typography>
-                You will see your <b>database collections</b> here, a few seconds after project creation
-            </Typography>}
-
-            <div
-                className={"flex flex-row gap-1 overflow-scroll no-scrollbar "}>
-                {(rootPathSuggestions ?? []).map((path) => {
-                    return (
-                        <div key={path}>
-                            <Chip
-                                icon={<AddIcon size={"small"}/>}
-                                colorScheme={"cyanLighter"}
-                                onClick={collectionEditorController && canCreateCollections
-                                    ? () => collectionEditorController.createCollection({
-                                        initialValues: { path, name: unslugify(path) },
-                                        parentCollectionIds: [],
-                                        redirect: true,
-                                        sourceClick: "root_collection_suggestion"
-                                    })
-                                    : undefined}
-                                size="small">
-                                {path}
-                            </Chip>
-                        </div>
-                    );
-                })}
-                {rootPathSuggestions === undefined && <CircularProgress size={"small"}/>}
-                {rootPathSuggestions?.length === 0 && <Typography variant={"caption"}>No suggestions</Typography>}
-            </div>
-        </div>
-    </Collapse>
-}

package/src/ui/collection_editor/properties/FieldHelperView.tsx

@@ -1,13 +0,0 @@
-import { Typography } from "@firecms/ui";
-
-export function FieldHelperView({
-                                    error,
-                                    children
-                                }: { error?: boolean, children?: React.ReactNode }) {
-    if (!children) return null;
-    return (
-        <Typography variant={"caption"} color={error ? "error" : "secondary"} className={"ml-3.5 mt-0.5"}>
-            {children}
-        </Typography>
-    );
-}