@firecms/collection_editor 3.0.0-canary.28 → 3.0.0-canary.280

package/dist/types/collection_editor_controller.d.ts

@@ -1,5 +1,5 @@
 import { CollectionEditorPermissionsBuilder } from "./config_permissions";
-import { Property } from "@firecms/core";
+import { Entity, Property } from "@firecms/core";
 import { PersistedCollection } from "./persisted_collection";
 /**
  * Controller to open the collection editor dialog.
@@ -11,6 +11,7 @@ export interface CollectionEditorController {
         fullPath?: string;
         parentCollectionIds: string[];
         parentCollection?: PersistedCollection;
+        existingEntities?: Entity<any>[];
     }) => void;
     createCollection: (props: {
         initialValues?: {
@@ -30,7 +31,7 @@ export interface CollectionEditorController {
         editedCollectionId: string;
         parentCollectionIds: string[];
         collection: PersistedCollection;
+        existingEntities: Entity<any>[];
     }) => void;
     configPermissions: CollectionEditorPermissionsBuilder;
-    rootPathSuggestions?: string[];
 }

package/dist/types/collection_inference.d.ts

@@ -1,2 +1,5 @@
 import { EntityCollection } from "@firecms/core";
-export type CollectionInference = (path: string, collectionGroup: boolean, parentCollectionIds: string[]) => Promise<Partial<EntityCollection> | null>;
+/**
+ * This function is used to infer the configuration of a collection given its path.
+ */
+export type CollectionInference = (path: string, collectionGroup: boolean, parentCollectionPaths: string[], databaseId?: string) => Promise<Partial<EntityCollection> | null>;

package/dist/types/config_controller.d.ts

@@ -1,4 +1,4 @@
-import { CMSType, Property } from "@firecms/core";
+import { CMSType, NavigationGroupMapping, Property } from "@firecms/core";
 import { PersistedCollection } from "./persisted_collection";
 /**
  * Use this controller to access the configuration that is stored externally,
@@ -17,6 +17,8 @@ export interface CollectionsConfigController {
     saveProperty: (params: SavePropertyParams) => Promise<void>;
     deleteProperty: (params: DeletePropertyParams) => Promise<void>;
     deleteCollection: (props: DeleteCollectionParams) => Promise<void>;
+    navigationEntries: NavigationGroupMapping[];
+    saveNavigationEntries: (entries: NavigationGroupMapping[]) => Promise<void>;
 }
 export type UpdateCollectionParams<M extends Record<string, any>> = {
     id: string;

package/dist/types/config_permissions.d.ts

@@ -1,6 +1,6 @@
 import { EntityCollection } from "@firecms/core";
-export type CollectionEditorPermissionsBuilder<UserType = any, EC extends EntityCollection = EntityCollection> = (params: {
-    user: UserType | null;
+export type CollectionEditorPermissionsBuilder<USER = any, EC extends EntityCollection = EntityCollection> = (params: {
+    user: USER | null;
     collection?: EC;
 }) => CollectionEditorPermissions;
 export type CollectionEditorPermissions = {

package/dist/types/persisted_collection.d.ts

@@ -1,5 +1,5 @@
 import { EntityCollection, User } from "@firecms/core";
-export type PersistedCollection<M extends Record<string, any> = any, UserType extends User = User> = Omit<EntityCollection<M, UserType>, "subcollections"> & {
+export type PersistedCollection<M extends Record<string, any> = any, USER extends User = User> = Omit<EntityCollection<M, USER>, "subcollections"> & {
     ownerId?: string;
     subcollections?: PersistedCollection<any, any>[];
     editable?: boolean;

package/dist/ui/CollectionViewHeaderAction.d.ts

@@ -1,10 +1,11 @@
-import { ResolvedProperty } from "@firecms/core";
+import { EntityTableController, ResolvedProperty } from "@firecms/core";
 import { PersistedCollection } from "../types/persisted_collection";
-export declare function CollectionViewHeaderAction({ propertyKey, onHover, property, fullPath, parentCollectionIds, collection }: {
+export declare function CollectionViewHeaderAction({ propertyKey, onHover, property, fullPath, parentCollectionIds, collection, tableController }: {
     property: ResolvedProperty;
     propertyKey: string;
     onHover: boolean;
     fullPath: string;
     parentCollectionIds: string[];
     collection: PersistedCollection;
+    tableController: EntityTableController;
 }): import("react/jsx-runtime").JSX.Element;

package/dist/ui/EditorCollectionActionStart.d.ts

@@ -0,0 +1,2 @@
+import { CollectionActionsProps } from "@firecms/core";
+export declare function EditorCollectionActionStart({ path: fullPath, parentCollectionIds, collection, tableController }: CollectionActionsProps): import("react/jsx-runtime").JSX.Element;

package/dist/ui/EditorEntityAction.d.ts

@@ -0,0 +1,2 @@
+import { PluginFormActionProps } from "@firecms/core";
+export declare function EditorEntityAction({ path: fullPath, parentCollectionIds, collection, formContext }: PluginFormActionProps): import("react/jsx-runtime").JSX.Element;

package/dist/ui/PropertyAddColumnComponent.d.ts

@@ -1,6 +1,8 @@
+import { EntityTableController } from "@firecms/core";
 import { PersistedCollection } from "../types/persisted_collection";
-export declare function PropertyAddColumnComponent({ fullPath, parentCollectionIds, collection }: {
+export declare function PropertyAddColumnComponent({ fullPath, parentCollectionIds, collection, tableController }: {
     fullPath: string;
     parentCollectionIds: string[];
     collection: PersistedCollection;
+    tableController: EntityTableController;
 }): import("react/jsx-runtime").JSX.Element;

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

@@ -1,5 +1,6 @@
+import React from "react";
 import { EntityCollection } from "@firecms/core";
-export declare function CollectionDetailsForm({ isNewCollection, reservedGroups, existingPaths, existingIds, groups, parentCollection }: {
+export declare function CollectionDetailsForm({ isNewCollection, reservedGroups, existingPaths, existingIds, groups, parentCollection, children }: {
     isNewCollection: boolean;
     reservedGroups?: string[];
     existingPaths?: string[];
@@ -7,4 +8,5 @@ export declare function CollectionDetailsForm({ isNewCollection, reservedGroups,
     groups: string[] | null;
     parentCollection?: EntityCollection;
     parentCollectionIds?: string[];
+    children?: React.ReactNode;
 }): import("react/jsx-runtime").JSX.Element;

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

@@ -1,5 +1,5 @@
 import * as React from "react";
-import { EntityCollection, User } from "@firecms/core";
+import { Entity, EntityCollection, User } from "@firecms/core";
 import { CollectionsConfigController } from "../../types/config_controller";
 import { CollectionInference } from "../../types/collection_inference";
 import { PersistedCollection } from "../../types/persisted_collection";
@@ -25,9 +25,10 @@ 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;
+    existingEntities?: Entity<any>[];
 }
 export declare function CollectionEditorDialog(props: CollectionEditorDialogProps): import("react/jsx-runtime").JSX.Element;
 export declare function CollectionEditor(props: CollectionEditorDialogProps & {

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

@@ -4,9 +4,9 @@ export declare function CollectionEditorWelcomeView({ path, pathSuggestions, par
     path: string;
     pathSuggestions?: (path: string) => Promise<string[]>;
     parentCollection?: EntityCollection;
-    onContinue: (importData?: object[]) => void;
+    onContinue: (importData?: object[], propertiesOrder?: string[]) => void;
     existingCollectionPaths?: string[];
-}): import("react/jsx-runtime").JSX.Element;
+}): import("react/jsx-runtime").JSX.Element | null;
 export declare function TemplateButton({ title, subtitle, icon, onClick }: {
     title: string;
     icon: React.ReactNode;

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

@@ -9,9 +9,9 @@ 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;
+    doCollectionInference?: (collection: PersistedCollection) => Promise<Partial<EntityCollection> | null> | undefined;
     propertyConfigs: Record<string, PropertyConfig>;
     collectionEditable: boolean;
 };

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

@@ -0,0 +1,4 @@
+import { PersistedCollection } from "../../types/persisted_collection";
+export declare function EntityActionsEditTab({ collection, }: {
+    collection: PersistedCollection;
+}): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,4 @@
+export declare function EntityActionsSelectDialog({ open, onClose }: {
+    open: boolean;
+    onClose: (selectedActionKey?: string) => void;
+}): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,5 @@
+export declare function LayoutModeSwitch({ value, onChange, className }: {
+    value: "side_panel" | "full_screen";
+    onChange: (value: "side_panel" | "full_screen") => void;
+    className?: string;
+}): import("react/jsx-runtime").JSX.Element;

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

@@ -21,6 +21,7 @@ export type PropertyFormProps = {
     property?: Property;
     onPropertyChanged?: (params: OnPropertyChangedParams) => void;
     onPropertyChangedImmediate?: boolean;
+    onDismiss?: () => void;
     onDelete?: (id?: string, namespace?: string) => void;
     onError?: (id: string, namespace?: string, error?: Record<string, any>) => void;
     initialErrors?: Record<string, any>;
@@ -38,3 +39,10 @@ export declare function PropertyFormDialog({ open, onCancel, onOkClicked, onProp
     onOkClicked?: () => void;
     onCancel?: () => void;
 }): import("react/jsx-runtime").JSX.Element;
+export interface PropertySelectItemProps {
+    onClick?: () => void;
+    initialProperty?: PropertyWithId;
+    propertyConfig: PropertyConfig;
+    existing: boolean;
+}
+export declare function WidgetSelectViewItem({ onClick, initialProperty, propertyConfig, existing }: PropertySelectItemProps): import("react/jsx-runtime").JSX.Element;

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

@@ -1,29 +1,28 @@
 import React from "react";
 import { AdditionalFieldDelegate, CMSType, PropertiesOrBuilders, PropertyOrBuilder } from "@firecms/core";
-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 }: {
+export declare function PropertyTreeEntry({ id, propertyKey, namespace, propertyOrBuilder, additionalField, selectedPropertyKey, errors, onPropertyClick, onPropertyMove, onPropertyRemove, inferredPropertyKeys, collectionEditable }: {
+    id: string;
     propertyKey: string;
     namespace?: string;
     propertyOrBuilder: PropertyOrBuilder;
     additionalField?: AdditionalFieldDelegate<any>;
     selectedPropertyKey?: string;
-    provided: DraggableProvided;
     errors: Record<string, any>;
     onPropertyClick?: (propertyKey: string, namespace?: string) => void;
     onPropertyMove?: (propertiesOrder: string[], namespace?: string) => void;

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/ui/collection_editor/import/CollectionEditorImportDataPreview.d.ts

@@ -1,4 +1,4 @@
-import { ImportConfig } from "@firecms/data_import_export";
+import { ImportConfig } from "@firecms/data_import";
 import { Properties } from "@firecms/core";
 export declare function CollectionEditorImportDataPreview({ importConfig, properties, propertiesOrder }: {
     importConfig: ImportConfig;

package/dist/ui/collection_editor/import/CollectionEditorImportMapping.d.ts

@@ -1,7 +1,14 @@
-import { ImportConfig } from "@firecms/data_import_export";
+import { ImportConfig } from "@firecms/data_import";
 import { PropertyConfig } from "@firecms/core";
 export declare function CollectionEditorImportMapping({ importConfig, propertyConfigs, collectionEditable }: {
     importConfig: ImportConfig;
     propertyConfigs: Record<string, PropertyConfig>;
     collectionEditable: boolean;
 }): import("react/jsx-runtime").JSX.Element;
+export interface PropertySelectItemProps {
+    value: string;
+    optionDisabled: boolean;
+    propertyConfig: PropertyConfig;
+    existing: boolean;
+}
+export declare function PropertySelectItem({ value, optionDisabled, propertyConfig, existing }: PropertySelectItemProps): import("react/jsx-runtime").JSX.Element;

package/dist/ui/collection_editor/import/clean_import_data.d.ts

@@ -1,5 +1,5 @@
 import { Properties } from "@firecms/core";
-import { ImportConfig } from "@firecms/data_import_export";
+import { ImportConfig } from "@firecms/data_import";
 export declare function cleanPropertiesFromImport(properties: Properties, parentSlug?: string): {
     headersMapping: ImportConfig["headersMapping"];
     properties: Properties;

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

@@ -0,0 +1,4 @@
+export declare function MarkdownPropertyField({ disabled, showErrors }: {
+    disabled: boolean;
+    showErrors: boolean;
+}): import("react/jsx-runtime").JSX.Element;

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

@@ -1,8 +1,9 @@
-export declare function ReferencePropertyField({ existing, multiple, disabled, showErrors }: {
+export declare function ReferencePropertyField({ existing, multiple, disabled, showErrors, asString }: {
     existing: boolean;
     multiple: boolean;
     disabled: boolean;
     showErrors: boolean;
+    asString?: boolean;
 }): import("react/jsx-runtime").JSX.Element;
 export declare function CollectionsSelect({ disabled, pathPath, value, handleChange, error, ...props }: {
     disabled: boolean;

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

@@ -1,5 +1,5 @@
 export declare function StringPropertyField({ widgetId, disabled, showErrors }: {
-    widgetId: "text_field" | "multiline" | "markdown" | "email";
+    widgetId: "text_field" | "multiline" | "email" | "user_select";
     disabled: boolean;
     showErrors: boolean;
 }): import("react/jsx-runtime").JSX.Element;

package/dist/useCollectionEditorPlugin.d.ts

@@ -4,7 +4,7 @@ import { CollectionEditorPermissionsBuilder } from "./types/config_permissions";
 import { PersistedCollection } from "./types/persisted_collection";
 import { CollectionInference } from "./types/collection_inference";
 import { CollectionsConfigController } from "./types/config_controller";
-export interface CollectionConfigControllerProps<EC extends PersistedCollection = PersistedCollection, UserType extends User = User> {
+export interface CollectionConfigControllerProps<EC extends PersistedCollection = PersistedCollection, USER extends User = User> {
     /**
      * Firebase app where the configuration is saved.
      */
@@ -12,25 +12,24 @@ export interface CollectionConfigControllerProps<EC extends PersistedCollection
     /**
      * Define what actions can be performed on the configuration.
      */
-    configPermissions?: CollectionEditorPermissionsBuilder<UserType, EC>;
+    configPermissions?: CollectionEditorPermissionsBuilder<USER, EC>;
     /**
      * The words you define here will not be allowed to be used as group
      * names when creating collections.
      * e.g. ["admin"]
      */
-    reservedGroups: string[];
+    reservedGroups?: string[];
     extraView?: {
         View: React.ComponentType<{
             path: string;
         }>;
         icon: React.ReactNode;
     };
-    pathSuggestions?: (path: string) => Promise<string[]>;
     collectionInference?: CollectionInference;
     getData?: (path: string, parentPaths: string[]) => Promise<object[]>;
-    getUser: (uid: string) => UserType | null;
+    getUser?: (uid: string) => USER | null;
     onAnalyticsEvent?: (event: string, params?: object) => void;
-    introMode?: "new_project" | "existing_project";
+    includeIntroView?: boolean;
 }
 /**
  * Use this hook to initialise the Collection Editor plugin.
@@ -39,11 +38,9 @@ export interface CollectionConfigControllerProps<EC extends PersistedCollection
  * @param configPermissions
  * @param reservedGroups
  * @param extraView
- * @param pathSuggestions
+ * @param getData
  * @param getUser
  * @param collectionInference
  */
-export declare function useCollectionEditorPlugin<EC extends PersistedCollection = PersistedCollection, UserType extends User = User>({ collectionConfigController, introMode, configPermissions, reservedGroups, extraView, pathSuggestions, getUser, collectionInference, getData, onAnalyticsEvent }: CollectionConfigControllerProps<EC, UserType>): FireCMSPlugin<any, any, PersistedCollection>;
-export declare function IntroWidget({ introMode }: {
-    introMode?: "new_project" | "existing_project";
-}): import("react/jsx-runtime").JSX.Element;
+export declare function useCollectionEditorPlugin<EC extends PersistedCollection = PersistedCollection, USER extends User = User>({ collectionConfigController, configPermissions, reservedGroups, extraView, getUser, collectionInference, getData, onAnalyticsEvent, includeIntroView }: CollectionConfigControllerProps<EC, USER>): FireCMSPlugin<any, any, PersistedCollection>;
+export declare function IntroWidget(): import("react/jsx-runtime").JSX.Element | null;

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,24 +1,26 @@
 {
   "name": "@firecms/collection_editor",
   "type": "module",
-  "version": "3.0.0-canary.28",
+  "version": "3.0.0-canary.280",
   "main": "./dist/index.umd.js",
   "module": "./dist/index.es.js",
-  "types": "dist/index.d.ts",
+  "types": "./dist/index.d.ts",
   "source": "src/index.ts",
   "dependencies": {
-    "@firecms/data_import_export": "^3.0.0-canary.28",
-    "@firecms/formex": "^3.0.0-canary.28",
-    "@firecms/schema_inference": "^3.0.0-canary.28",
-    "@firecms/ui": "^3.0.0-canary.28",
+    "@firecms/data_export": "^3.0.0-canary.280",
+    "@firecms/data_import": "^3.0.0-canary.280",
+    "@firecms/data_import_export": "^3.0.0-canary.280",
+    "@firecms/formex": "^3.0.0-canary.280",
+    "@firecms/schema_inference": "^3.0.0-canary.280",
+    "@firecms/ui": "^3.0.0-canary.280",
     "json5": "^2.2.3",
-    "prism-react-renderer": "^2.3.1"
+    "prism-react-renderer": "^2.4.1"
   },
   "peerDependencies": {
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "react-router": "^6.22.0",
-    "react-router-dom": "^6.22.0"
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0",
+    "react-router": "^6.28.0",
+    "react-router-dom": "^6.28.0"
   },
   "exports": {
     ".": {
@@ -34,12 +36,6 @@
     "build": "vite build && tsc --emitDeclarationOnly -p tsconfig.prod.json",
     "clean": "rm -rf dist && find ./src -name '*.js' -type f | xargs rm -f"
   },
-  "eslintConfig": {
-    "extends": [
-      "react-app",
-      "react-app/jest"
-    ]
-  },
   "browserslist": {
     "production": [
       ">0.2%",
@@ -53,26 +49,18 @@
     ]
   },
   "devDependencies": {
-    "@jest/globals": "^29.7.0",
-    "@types/react": "^18.2.67",
-    "@types/react-dom": "^18.2.22",
-    "@typescript-eslint/eslint-plugin": "^7.3.1",
-    "@typescript-eslint/parser": "^7.3.1",
-    "@vitejs/plugin-react": "^4.2.1",
-    "eslint": "^8.57.0",
-    "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-n": "^16.6.2",
-    "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-react": "^7.34.1",
-    "eslint-plugin-react-hooks": "^4.6.0",
+    "@jest/globals": "^30.1.2",
+    "@types/react": "^18.3.24",
+    "@types/react-dom": "^18.3.7",
+    "@vitejs/plugin-react": "^4.7.0",
+    "babel-plugin-react-compiler": "^19.0.0-beta-af1b7da-20250417",
+    "eslint-plugin-react-compiler": "^19.0.0-beta-af1b7da-20250417",
     "jest": "^29.7.0",
-    "react-router": "^6.22.0",
-    "react-router-dom": "^6.22.0",
-    "ts-jest": "^29.1.2",
-    "typescript": "^5.4.2",
-    "vite": "^5.2.3",
-    "vite-plugin-fonts": "^0.7.0"
+    "react-router": "^6.30.1",
+    "react-router-dom": "^6.30.1",
+    "ts-jest": "^29.4.3",
+    "typescript": "^5.9.2",
+    "vite": "^7.1.6"
   },
   "files": [
     "dist",
@@ -81,5 +69,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "441a5992df035cea5efef3b618d7f1c665cfe284"
+  "gitHead": "4c511808713ad163340dd67cb07f4bbba3d15c56"
 }