Entity history plugin

Author: fgatti675

demo_backend/functions/src/backup.ts

@@ -8,7 +8,7 @@ const firestore = require("@google-cloud/firestore");
  * gcloud firestore export gs://firecms_firestore_backups --project firecms-demo-27150
  * ```
  */
-const bucket = "gs://firecms_firestore_backups/2025-03-11T20:51:40_46328";
+const bucket = "gs://firecms_firestore_backups/2025-05-12T17:58:18_30881";
 
 // export function eraseDatabase() {
 //     const firebase_tools = require("firebase-tools");

examples/example_cloud/src/entity_views/SampleEntityView.tsx

@@ -1,14 +1,11 @@
 import React from "react";
-import { Button, Entity, EntityValues, useSnackbarController } from "@firecms/cloud";
+import { Button, EntityCustomViewParams, useSnackbarController } from "@firecms/cloud";
 import { Product } from "../types";
 
 export function SampleEntityView({
-                                       entity,
-                                       modifiedValues
-                                   }: {
-    entity?: Entity<Product>;
-    modifiedValues?: EntityValues<Product>;
-}) {
+                                     entity,
+                                     modifiedValues
+                                 }: EntityCustomViewParams<Product>) {
 
     const snackbarController = useSnackbarController();
 

examples/example_next/src/app/cms/App.tsx

@@ -197,6 +197,7 @@ export function App() {
     const importPlugin = useImportPlugin();
     const exportPlugin = useExportPlugin();
 
+
     if (firebaseConfigLoading || !firebaseApp) {
         return <CircularProgressCenter/>;
     }

examples/example_pro/package.json

@@ -11,6 +11,7 @@
     "@firecms/data_enhancement": "^3.0.0-canary.235",
     "@firecms/data_export": "^3.0.0-canary.235",
     "@firecms/data_import": "^3.0.0-canary.235",
+    "@firecms/entity_history": "^3.0.0-canary.235",
     "@firecms/datatalk": "^3.0.0-canary.235",
     "@firecms/editor": "^3.0.0-canary.235",
     "@firecms/formex": "^3.0.0-canary.235",

examples/example_pro/src/FirestoreApp/App.tsx

@@ -48,7 +48,7 @@ import { firebaseConfig, secondaryFirebaseConfig } from "../firebase_config";
 import { ExampleCMSView } from "./views/ExampleCMSView";
 import { testCollection } from "./collections/test_collection";
 import { usersCollection } from "./collections/users_collection";
-import { localeCollectionGroup, productsCollection, productsCollection2 } from "./collections/products_collection";
+import { localeCollectionGroup, productsCollection } from "./collections/products_collection";
 import { blogCollection } from "./collections/blog_collection";
 import { showcaseCollection } from "./collections/showcase_collection";
 
@@ -65,6 +65,7 @@ import { useImportPlugin } from "@firecms/data_import";
 import { DemoImportAction } from "./DemoImportAction";
 import { algoliaSearchControllerBuilder } from "./text_search";
 import ClientUIComponentsShowcase from "./views/ClientUIComponentsShowcase";
+import { useEntityHistoryPlugin } from "@firecms/entity_history";
 
 const signInOptions: FirebaseSignInProvider[] = ["google.com", "password"];
 
@@ -308,12 +309,18 @@ export function App() {
     const importPlugin = useImportPlugin();
     const exportPlugin = useExportPlugin();
 
+    const entityHistoryPlugin = useEntityHistoryPlugin({
+        defaultEnabled: true,
+        getUser: userManagement.getUser
+    });
+
     const demoPlugin = useMemo(() => ({
         key: "demo",
         collectionView: {
             CollectionActions: [DemoImportAction]
         }
     }), []);
+
     /**
      * Check if the user is allowed to access the main view
      */
@@ -330,10 +337,20 @@ export function App() {
         storageSource
     });
 
+    const plugins = [
+        userManagementPlugin,
+        dataEnhancementPlugin,
+        exportPlugin,
+        entityHistoryPlugin,
+        demoPlugin,
+        collectionEditorPlugin
+    ];
+
     const navigationController = useBuildNavigationController({
         disabled: authLoading || collectionConfigController.loading,
         // basePath: "cms",
         collections,
+        plugins,
         // collectionPermissions: userManagement.collectionPermissions,
         views,
         adminViews: userManagementAdminViews,
@@ -364,14 +381,7 @@ export function App() {
                     userConfigPersistence={userConfigPersistence}
                     dataSourceDelegate={firestoreDelegate}
                     storageSource={storageSource}
-
-                    plugins={[
-                        userManagementPlugin,
-                        dataEnhancementPlugin,
-                        exportPlugin,
-                        demoPlugin,
-                        collectionEditorPlugin
-                    ]}
+                    plugins={plugins}
                     onAnalyticsEvent={onAnalyticsEvent}
                     propertyConfigs={propertyConfigs}
                 >

examples/example_pro/tsconfig.json

@@ -27,6 +27,7 @@
       "@firecms/data_enhancement": ["../../packages/data_enhancement/src"],
       "@firecms/collection_editor": ["../../packages/collection_editor/src"],
       "@firecms/collection_editor_firebase": ["../../packages/collection_editor_firebase/src"],
+      "@firecms/entity_history": ["../../packages/entity_history/src"],
       "@firecms/data_import": ["../../packages/data_import/src"],
       "@firecms/data_export": ["../../packages/data_export/src"],
       "@firecms/user_management": ["../../packages/user_management/src"]

examples/example_pro/vite.config.ts

@@ -30,6 +30,7 @@ export default defineConfig({
             "@firecms/firebase": path.resolve(__dirname, "../../packages/firebase_firecms/src"),
             "@firecms/data_enhancement": path.resolve(__dirname, "../../packages/data_enhancement/src"),
             "@firecms/data_import": path.resolve(__dirname, "../../packages/data_import/src"),
+            "@firecms/entity_history": path.resolve(__dirname, "../../packages/entity_history/src"),
             "@firecms/data_export": path.resolve(__dirname, "../../packages/data_export/src"),
             "@firecms/schema_inference": path.resolve(__dirname, "../../packages/schema_inference/src"),
             "@firecms/collection_editor": path.resolve(__dirname, "../../packages/collection_editor/src"),

lerna.json

@@ -12,6 +12,7 @@
     "packages/data_import",
     "packages/data_export",
     "packages/data_import_export",
+    "packages/entity_history",
     "packages/firebase_firecms",
     "packages/mongodb",
     "packages/cli",
@@ -28,4 +29,4 @@
     "examples/example_pro"
   ],
   "npmClient": "npm"
-}
+}

package-lock.json

@@ -24,6 +24,7 @@
     "packages/data_import",
     "packages/data_export",
     "packages/data_import_export",
+    "packages/entity_history",
     "packages/schema_inference",
     "packages/data_enhancement",
     "packages/user_management",

package.json

@@ -31,11 +31,7 @@ import {
 import { firebaseConfig } from "./firebase_config";
 import { productsCollection } from "./collections/products";
 import { useDataEnhancementPlugin } from "@firecms/data_enhancement";
-import {
-    useBuildUserManagement,
-    userManagementAdminViews,
-    useUserManagementPlugin
-} from "@firecms/user_management";
+import { useBuildUserManagement, userManagementAdminViews, useUserManagementPlugin } from "@firecms/user_management";
 import { useImportPlugin } from "@firecms/data_import";
 import { useExportPlugin } from "@firecms/data_export";
 import { ExampleCMSView } from "./views/ExampleCMSView";
@@ -112,7 +108,6 @@ export function App() {
         firebaseApp
     });
 
-
     /**
      * Controller for managing authentication
      */
@@ -149,16 +144,6 @@ export function App() {
         storageSource
     });
 
-    const navigationController = useBuildNavigationController({
-        disabled: authLoading || collectionConfigController.loading,
-        collections: collectionsBuilder,
-        collectionPermissions: userManagement.collectionPermissions,
-        views,
-        adminViews: userManagementAdminViews,
-        authController,
-        dataSourceDelegate: firestoreDelegate
-    });
-
     /**
      * Data enhancement plugin
      */
@@ -185,6 +170,25 @@ export function App() {
         collectionConfigController
     });
 
+    const plugins = [
+        dataEnhancementPlugin,
+        importPlugin,
+        exportPlugin,
+        userManagementPlugin,
+        collectionEditorPlugin
+    ];
+
+    const navigationController = useBuildNavigationController({
+        disabled: authLoading || collectionConfigController.loading,
+        collections: collectionsBuilder,
+        collectionPermissions: userManagement.collectionPermissions,
+        views,
+        adminViews: userManagementAdminViews,
+        authController,
+        dataSourceDelegate: firestoreDelegate,
+        plugins
+    });
+
     if (firebaseConfigLoading || !firebaseApp) {
         return <CircularProgressCenter/>;
     }
@@ -193,7 +197,6 @@ export function App() {
         return <>{configError}</>;
     }
 
-
     return (
         <SnackbarProvider>
             <ModeControllerProvider value={modeController}>
@@ -205,13 +208,7 @@ export function App() {
                     userConfigPersistence={userConfigPersistence}
                     dataSourceDelegate={firestoreDelegate}
                     storageSource={storageSource}
-                    plugins={[
-                        dataEnhancementPlugin,
-                        importPlugin,
-                        exportPlugin,
-                        userManagementPlugin,
-                        collectionEditorPlugin
-                    ]}
+                    plugins={plugins}
                 >
                     {({
                           context,

packages/cli/templates/template_pro/src/App.tsx

@@ -49,8 +49,6 @@ export interface ConfigControllerProviderProps {
         icon: React.ReactNode
     };
 
-    getPathSuggestions?: (path?: string) => Promise<string[]>;
-
     getUser?: (uid: string) => User | null
 
     getData?: (path: string, parentPaths: string[]) => Promise<object[]>;
@@ -67,7 +65,6 @@ export const ConfigControllerProvider = React.memo(
                                           reservedGroups,
                                           collectionInference,
                                           extraView,
-                                          getPathSuggestions,
                                           getUser,
                                           getData,
                                           onAnalyticsEvent,
@@ -230,7 +227,6 @@ export const ConfigControllerProvider = React.memo(
                         createCollection,
                         editProperty,
                         configPermissions: configPermissions ?? defaultConfigPermissions,
-                        getPathSuggestions,
                     }}>
 
                     {children}
@@ -244,7 +240,6 @@ export const ConfigControllerProvider = React.memo(
                         getData={getData}
                         reservedGroups={reservedGroups}
                         extraView={extraView}
-                        pathSuggestions={getPathSuggestions}
                         getUser={getUser}
                         handleClose={(collection) => {
                             if (currentDialog?.redirect) {

packages/collection_editor/src/ConfigControllerProvider.tsx

@@ -41,6 +41,4 @@ export interface CollectionEditorController {
 
     configPermissions: CollectionEditorPermissionsBuilder;
 
-    getPathSuggestions?: (path: string) => Promise<string[]>;
-
 }