feat: allow component metadata storage (#578)

prevwong · Feb 29, 2024 · 246fa3c · 246fa3c
1 parent d07899b
commit 246fa3c
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/.changeset/stupid-onions-mate.md b/.changeset/stupid-onions-mate.md
@@ -0,0 +1,5 @@
+---
+'@craftjs/core': patch
+---
+
+Add a property `info` to `UserComponent`, which will be copied to `Node`, but will not be serialized.
diff --git a/packages/core/src/interfaces/nodes.ts b/packages/core/src/interfaces/nodes.ts
@@ -9,6 +9,7 @@ export type UserComponentConfig<T> = {
   related: Partial<NodeRelated>;
   props: Partial<T>;
   custom: Record<string, any>;
+  info: Record<string, any>;
   isCanvas: boolean;
 
   // TODO: Deprecate
@@ -26,6 +27,7 @@ export type NodeEventTypes = 'selected' | 'dragged' | 'hovered';
 export type Node = {
   id: NodeId;
   data: NodeData;
+  info: Record<string, any>;
   events: Record<NodeEventTypes, boolean>;
   dom: HTMLElement | null;
   related: Record<string, React.ElementType>;

diff --git a/packages/core/src/utils/createNode.ts b/packages/core/src/utils/createNode.ts
@@ -37,6 +37,7 @@ export function createNode(
       linkedNodes: {},
       ...newNode.data,
     },
+    info: {},
     related: {},
     events: {
       selected: false,
@@ -136,6 +137,10 @@ export function createNode(
           );
       });
     }
+
+    if (userComponentConfig.info) {
+      node.info = userComponentConfig.info;
+    }
   }
 
   return node;