@firecms/collection_editor 3.0.0-canary.40 → 3.0.0-canary.41

package/dist/ui/collection_editor/CollectionEditorDialog.d.ts

@@ -25,7 +25,7 @@ export interface CollectionEditorDialogProps {
         icon: React.ReactNode;
     };
     pathSuggestions?: (path?: string) => Promise<string[]>;
-    getUser: (uid: string) => User | null;
+    getUser?: (uid: string) => User | null;
     getData?: (path: string, parentPaths: string[]) => Promise<object[]>;
     parentCollection?: PersistedCollection;
 }

package/dist/ui/collection_editor/CollectionPropertiesEditorForm.d.ts

@@ -9,7 +9,7 @@ type CollectionEditorFormProps = {
     setDirty?: (dirty: boolean) => void;
     reservedGroups?: string[];
     extraIcon: React.ReactNode;
-    getUser: (uid: string) => User | null;
+    getUser?: (uid: string) => User | null;
     getData?: () => Promise<object[]>;
     doCollectionInference: (collection: PersistedCollection) => Promise<Partial<EntityCollection> | null> | undefined;
     propertyConfigs: Record<string, PropertyConfig>;

package/dist/ui/collection_editor/PropertyTree.d.ts

@@ -4,17 +4,17 @@ import { DraggableProvided } from "@hello-pangea/dnd";
 export declare const PropertyTree: React.MemoExoticComponent<(<M extends {
     [Key: string]: CMSType;
 }>({ namespace, selectedPropertyKey, onPropertyClick, properties, propertiesOrder: propertiesOrderProp, additionalFields, errors, onPropertyMove, onPropertyRemove, className, inferredPropertyKeys, collectionEditable }: {
-    namespace?: string | undefined;
-    selectedPropertyKey?: string | undefined;
-    onPropertyClick?: ((propertyKey: string, namespace?: string) => void) | undefined;
+    namespace?: string;
+    selectedPropertyKey?: string;
+    onPropertyClick?: (propertyKey: string, namespace?: string) => void;
     properties: PropertiesOrBuilders<M>;
-    propertiesOrder?: string[] | undefined;
-    additionalFields?: AdditionalFieldDelegate<M, import("@firecms/core").User>[] | undefined;
+    propertiesOrder?: string[];
+    additionalFields?: AdditionalFieldDelegate<M>[];
     errors: Record<string, any>;
-    onPropertyMove?: ((propertiesOrder: string[], namespace?: string) => void) | undefined;
-    onPropertyRemove?: ((propertyKey: string, namespace?: string) => void) | undefined;
-    className?: string | undefined;
-    inferredPropertyKeys?: string[] | undefined;
+    onPropertyMove?: (propertiesOrder: string[], namespace?: string) => void;
+    onPropertyRemove?: (propertyKey: string, namespace?: string) => void;
+    className?: string;
+    inferredPropertyKeys?: string[];
     collectionEditable: boolean;
 }) => import("react/jsx-runtime").JSX.Element)>;
 export declare function PropertyTreeEntry({ propertyKey, namespace, propertyOrBuilder, additionalField, provided, selectedPropertyKey, errors, onPropertyClick, onPropertyMove, onPropertyRemove, inferredPropertyKeys, collectionEditable }: {

package/dist/ui/collection_editor/SubcollectionsEditTab.d.ts

@@ -7,6 +7,6 @@ export declare function SubcollectionsEditTab({ collection, parentCollection, co
     parentCollection?: EntityCollection;
     configController: CollectionsConfigController;
     collectionInference?: CollectionInference;
-    getUser: (uid: string) => User | null;
+    getUser?: (uid: string) => User | null;
     parentCollectionIds?: string[];
 }): import("react/jsx-runtime").JSX.Element;

package/dist/useCollectionEditorPlugin.d.ts

@@ -18,7 +18,7 @@ export interface CollectionConfigControllerProps<EC extends PersistedCollection
      * names when creating collections.
      * e.g. ["admin"]
      */
-    reservedGroups: string[];
+    reservedGroups?: string[];
     extraView?: {
         View: React.ComponentType<{
             path: string;
@@ -28,7 +28,7 @@ export interface CollectionConfigControllerProps<EC extends PersistedCollection
     pathSuggestions?: (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";
 }

package/dist/utils/collections.d.ts

@@ -0,0 +1,6 @@
+import { EntityCollection, ModifyCollectionProps } 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 declare const mergeCollections: (baseCollections: EntityCollection[], backendCollections: PersistedCollection[], modifyCollection?: (props: ModifyCollectionProps) => EntityCollection | void) => EntityCollection<any, any>[];

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@firecms/collection_editor",
   "type": "module",
-  "version": "3.0.0-canary.40",
+  "version": "3.0.0-canary.41",
   "main": "./dist/index.umd.js",
   "module": "./dist/index.es.js",
   "types": "dist/index.d.ts",
   "source": "src/index.ts",
   "dependencies": {
-    "@firecms/data_import_export": "^3.0.0-canary.40",
-    "@firecms/formex": "^3.0.0-canary.40",
-    "@firecms/schema_inference": "^3.0.0-canary.40",
-    "@firecms/ui": "^3.0.0-canary.40",
+    "@firecms/data_import_export": "^3.0.0-canary.41",
+    "@firecms/formex": "^3.0.0-canary.41",
+    "@firecms/schema_inference": "^3.0.0-canary.41",
+    "@firecms/ui": "^3.0.0-canary.41",
     "json5": "^2.2.3",
     "prism-react-renderer": "^2.3.1"
   },
@@ -81,5 +81,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "40b01721ac260b6cce7f5d8a3a1d768410e7f20d"
+  "gitHead": "d1ffa185f8930bab4e7b9941ba551c53f947aa1f"
 }

package/src/ConfigControllerProvider.tsx

@@ -50,7 +50,7 @@ export interface ConfigControllerProviderProps {
 
     pathSuggestions?: (path?: string) => Promise<string[]>;
 
-    getUser: (uid: string) => User | null
+    getUser?: (uid: string) => User | null
 
     getData?: (path: string, parentPaths: string[]) => Promise<object[]>;
 

package/src/index.ts

@@ -12,6 +12,7 @@ export {
 export {
     editableProperty, removeNonEditableProperties
 } from "./utils/entities";
+export * from "./utils/collections";
 
 export type {
     CollectionsConfigController, DeleteCollectionParams, SaveCollectionParams, UpdateCollectionParams

package/src/ui/collection_editor/CollectionEditorDialog.tsx

@@ -76,7 +76,7 @@ export interface CollectionEditorDialogProps {
         icon: React.ReactNode
     };
     pathSuggestions?: (path?: string) => Promise<string[]>;
-    getUser: (uid: string) => User | null;
+    getUser?: (uid: string) => User | null;
     getData?: (path: string, parentPaths: string[]) => Promise<object[]>;
     parentCollection?: PersistedCollection;
 }
@@ -170,7 +170,8 @@ export function CollectionEditor(props: CollectionEditorDialogProps & {
         } catch (e) {
             console.error(e);
         }
-    }, [navigation.getCollectionFromPaths, props.editedCollectionId, props.parentCollectionIds, navigation.initialised]);
+    }, [props.editedCollectionId, props.parentCollectionIds, navigation]);
+
     if (!topLevelNavigation) {
         throw Error("Internal: Navigation not ready in collection editor");
     }
@@ -733,7 +734,10 @@ function CollectionEditorInternal<M extends Record<string, any>>({
 }
 
 function applyPropertyConfigs<M extends Record<string, any> = any>(collection: PersistedCollection<M>, propertyConfigs: Record<string, PropertyConfig<any>>): PersistedCollection<M> {
-    const { properties, ...rest } = collection;
+    const {
+        properties,
+        ...rest
+    } = collection;
     const propertiesResult: PropertiesOrBuilders<any> = {};
     if (properties) {
         Object.keys(properties).forEach((key) => {
@@ -741,7 +745,10 @@ function applyPropertyConfigs<M extends Record<string, any> = any>(collection: P
         });
     }
 
-    return { ...rest, properties: propertiesResult };
+    return {
+        ...rest,
+        properties: propertiesResult
+    };
 }
 
 function applyPropertiesConfig(property: PropertyOrBuilder, propertyConfigs: Record<string, PropertyConfig<any>>) {
@@ -761,7 +768,10 @@ function applyPropertiesConfig(property: PropertyOrBuilder, propertyConfigs: Rec
                 Object.keys(internalProperty.properties).forEach((key) => {
                     properties[key] = applyPropertiesConfig(((internalProperty as MapProperty).properties as Properties)[key] as Property, propertyConfigs);
                 });
-                internalProperty = { ...internalProperty, properties };
+                internalProperty = {
+                    ...internalProperty,
+                    properties
+                };
             }
 
         }

package/src/ui/collection_editor/CollectionPropertiesEditorForm.tsx

@@ -43,7 +43,7 @@ type CollectionEditorFormProps = {
     setDirty?: (dirty: boolean) => void;
     reservedGroups?: string[];
     extraIcon: React.ReactNode;
-    getUser: (uid: string) => User | null;
+    getUser?: (uid: string) => User | null;
     getData?: () => Promise<object[]>;
     doCollectionInference: (collection: PersistedCollection) => Promise<Partial<EntityCollection> | null> | undefined;
     propertyConfigs: Record<string, PropertyConfig>;
@@ -301,7 +301,7 @@ export function CollectionPropertiesEditorForm({
         ? values.propertiesOrder
         : Object.keys(values.properties)) as string[];
 
-    const owner = useMemo(() => values.ownerId ? getUser(values.ownerId) : null, [getUser, values.ownerId]);
+    const owner = useMemo(() => values.ownerId && getUser ? getUser(values.ownerId) : null, [getUser, values.ownerId]);
 
     const onPropertyClick = useCallback((propertyKey: string, namespace?: string) => {
         console.debug("CollectionEditor: onPropertyClick", {

package/src/ui/collection_editor/SubcollectionsEditTab.tsx

@@ -41,7 +41,7 @@ export function SubcollectionsEditTab({
     parentCollection?: EntityCollection,
     configController: CollectionsConfigController;
     collectionInference?: CollectionInference;
-    getUser: (uid: string) => User | null;
+    getUser?: (uid: string) => User | null;
     parentCollectionIds?: string[];
 }) {
 

package/src/useCollectionEditorPlugin.tsx

@@ -33,7 +33,7 @@ export interface CollectionConfigControllerProps<EC extends PersistedCollection
      * names when creating collections.
      * e.g. ["admin"]
      */
-    reservedGroups: string[];
+    reservedGroups?: string[];
 
     extraView?: {
         View: React.ComponentType<{
@@ -48,7 +48,7 @@ export interface CollectionConfigControllerProps<EC extends PersistedCollection
 
     getData?: (path: string, parentPaths: string[]) => Promise<object[]>;
 
-    getUser: (uid: string) => UserType | null;
+    getUser?: (uid: string) => UserType | null;
 
     onAnalyticsEvent?: (event: string, params?: object) => void;
 

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;
+}