@firecms/entity_history 3.0.0-beta.14

package/src/entity_history_callbacks.ts

@@ -0,0 +1,99 @@
+import { EntityCallbacks } from "@firecms/core";
+import equal from "react-fast-compare"
+
+export const entityHistoryCallbacks: EntityCallbacks = {
+    onSaveSuccess: async (props) => {
+
+        const changedFields = props.previousValues ? findChangedFields(props.previousValues, props.values) : null;
+        const uid = props.context.authController.user?.uid;
+        props.context.dataSource.saveEntity({
+            path: props.path + "/" + props.entityId + "/__history",
+            values: {
+                ...props.values,
+                __metadata: {
+                    changed_fields: changedFields,
+                    updated_on: new Date(),
+                    updated_by: uid,
+                }
+            },
+            status: "new"
+        }).then(() => {
+            console.debug("History saved for", props.path, props.entityId);
+        });
+    }
+}
+
+function findChangedFields<M extends object>(oldValues: M, newValues: M, prefix: string = ""): string[] {
+    const changedFields: string[] = [];
+
+    // Handle null/undefined cases
+    if (equal(oldValues, newValues)) return changedFields;
+    if (!oldValues || !newValues) return [prefix || "."];
+
+    // Get all unique keys from both objects
+    const allKeys = new Set([
+        ...Object.keys(oldValues),
+        ...Object.keys(newValues)
+    ]);
+
+    for (const key of allKeys) {
+        const oldValue = oldValues[key as keyof M];
+        const newValue = newValues[key as keyof M];
+        const currentPath = prefix ? `${prefix}.${key}` : key;
+
+        // If key exists only in one object
+        if ((key in oldValues) !== (key in newValues)) {
+            changedFields.push(currentPath);
+            continue;
+        }
+
+        // If values are identical (deep equality)
+        if (equal(oldValue, newValue)) continue;
+
+        // Handle arrays
+        if (Array.isArray(oldValue) && Array.isArray(newValue)) {
+            if (oldValue.length !== newValue.length) {
+                changedFields.push(currentPath);
+            } else {
+                // Check if any array element changed
+                for (let i = 0; i < oldValue.length; i++) {
+                    if (
+                        typeof oldValue[i] === "object" && oldValue[i] !== null &&
+                        typeof newValue[i] === "object" && newValue[i] !== null
+                    ) {
+                        const nestedChanges = findChangedFields(
+                            oldValue[i] as object,
+                            newValue[i] as object,
+                            `${currentPath}[${i}]`
+                        );
+                        if (nestedChanges.length > 0) {
+                            changedFields.push(currentPath);
+                            break;
+                        }
+                    } else if (!equal(oldValue[i], newValue[i])) {
+                        changedFields.push(currentPath);
+                        break;
+                    }
+                }
+            }
+        }
+        // Handle nested objects
+        else if (
+            typeof oldValue === "object" && oldValue !== null &&
+            typeof newValue === "object" && newValue !== null
+        ) {
+            const nestedChanges = findChangedFields(
+                oldValue as object,
+                newValue as object,
+                currentPath
+            );
+            changedFields.push(...nestedChanges);
+        }
+        // Handle primitives
+        else {
+            changedFields.push(currentPath);
+        }
+    }
+
+    return changedFields;
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./useEntityHistoryPlugin";
+export * from "./HistoryControllerProvider";

package/src/useEntityHistoryPlugin.tsx

@@ -0,0 +1,61 @@
+import { useCallback, useMemo } from "react";
+import { EntityCollection, FireCMSPlugin, mergeCallbacks, User } from "@firecms/core";
+import { EntityHistoryView } from "./components/EntityHistoryView";
+import { HistoryIcon } from "@firecms/ui";
+import { entityHistoryCallbacks } from "./entity_history_callbacks";
+import { HistoryControllerProvider } from "./HistoryControllerProvider";
+
+/**
+ * This plugin adds a history view to the entity side panel.
+ */
+export function useEntityHistoryPlugin(props?: EntityHistoryPluginProps): FireCMSPlugin<any, any, any, EntityHistoryPluginProps> {
+
+    const { defaultEnabled = false } = props ?? {};
+
+    const modifyCollection = useCallback((collection: EntityCollection) => {
+        if (collection.history === true || (defaultEnabled && collection.history !== false)) {
+            return {
+                ...collection,
+                entityViews: [
+                    ...(collection.entityViews ?? []),
+                    {
+                        key: "__history",
+                        name: "History",
+                        tabComponent: <HistoryIcon size={"small"}/>,
+                        Builder: EntityHistoryView,
+                        position: "start"
+                    }
+                ],
+                callbacks: mergeCallbacks(collection.callbacks, entityHistoryCallbacks)
+            } satisfies EntityCollection;
+        }
+        return collection;
+    }, []);
+
+    return useMemo(() => ({
+        key: "entity_history",
+        provider: {
+            Component: HistoryControllerProvider,
+            props: {
+                getUser: props?.getUser
+            }
+        },
+        collection: {
+            modifyCollection
+        }
+    } satisfies FireCMSPlugin), [props]);
+}
+
+export type EntityHistoryPluginProps = {
+    /**
+     * If true, the history view will be enabled to all collections by default.
+     * Each collection can override this value by setting the `history` property.
+     */
+    defaultEnabled?: boolean;
+
+    /**
+     * Function to get the user object from the uid.
+     * @param uid
+     */
+    getUser?: (uid: string) => User | null;
+}

package/src/vite-env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />