@kiberon-labs/behave-graph-flow 2.0.0 → 3.0.0

package/src/store/conversions.ts

@@ -0,0 +1,47 @@
+import { create, type StoreApi } from 'zustand';
+
+/**
+ * A user/plugin-defined automatic type conversion: "when connecting a `from`
+ * socket to a `to` socket, splice in `nodeType`". `inputKey`/`outputKey` name
+ * the converter's value sockets; when omitted they're resolved from the node
+ * spec (first non-flow input/output).
+ */
+export type ConversionRule = {
+  from: string;
+  to: string;
+  nodeType: string;
+  inputKey?: string;
+  outputKey?: string;
+};
+
+export type ConversionStore = {
+  conversions: ConversionRule[];
+  /** Add (or replace the existing rule for the same from→to pair). */
+  registerConversion: (rule: ConversionRule) => void;
+  removeConversion: (from: string, to: string) => void;
+  setConversions: (rules: ConversionRule[]) => void;
+  findConversion: (from: string, to: string) => ConversionRule | undefined;
+};
+
+export const conversionStoreFactory = (): StoreApi<ConversionStore> =>
+  create<ConversionStore>((set, get) => ({
+    conversions: [],
+    registerConversion: (rule) =>
+      set((s) => ({
+        conversions: [
+          ...s.conversions.filter(
+            (c) => !(c.from === rule.from && c.to === rule.to)
+          ),
+          rule
+        ]
+      })),
+    removeConversion: (from, to) =>
+      set((s) => ({
+        conversions: s.conversions.filter(
+          (c) => !(c.from === from && c.to === to)
+        )
+      })),
+    setConversions: (conversions) => set({ conversions: [...conversions] }),
+    findConversion: (from, to) =>
+      get().conversions.find((c) => c.from === from && c.to === to)
+  }));

package/src/store/flow.tsx

@@ -1,5 +1,5 @@
 import { CustomEdge } from '@/components/edges';
-import type { System } from '@/system';
+import type { GraphSession } from '@/system/graphSession';
 import { behaveToFlow } from '@/transformers/behaveToFlow';
 import { flowToBehave } from '@/transformers/flowToBehave';
 import { autoLayout } from '@/util/autoLayout';
@@ -18,7 +18,6 @@ import {
 import { create } from 'zustand';
 import { nonDeletable } from '@/annotations';
 import GroupNode from '@/components/nodes/group';
-import { CommentNode } from '@/components/nodes/comment/comment';
 import { BehaveNode } from '@/components/nodes/behave';
 
 export type FlowStore = {
@@ -38,28 +37,14 @@ export type FlowStore = {
   ) => void;
 };
 
-// const specJson = useStore(sys.specStore, (s) => s.specs);
-// const [customNodeTypes, setCustomNodeTypes] = useState<NodeTypes>();
-// useEffect(() => {
-//   if (!specJson) return;
-//   const customNodeTypes: Record<
-//     AnyNodeType,
-//     React.ComponentType<any>
-//   > = getCustomNodeTypes(specJson);
-
-//   customNodeTypes['commentNode'] = CommentNode;
-//   customNodeTypes['group'] = GroupNode;
-//   // customNodeTypes['behaveNode:ai'] = AINode;
-
-//   setCustomNodeTypes(customNodeTypes);
-// }, [specJson]);
-
-export const flowStoreFactory = (system: System) => {
+export const flowStoreFactory = (session: GraphSession) => {
   const flowStore = create<FlowStore>((set, get) => ({
     graphJson: null,
+    // `noteNode` (and its legacy `commentNode` alias) is contributed by the
+    // optional notes plugin (`@/plugin/notes`), which owns the heavy
+    // tiptap/prosemirror dependency.
     nodeTypes: {
       group: GroupNode,
-      commentNode: CommentNode,
       behaveNode: BehaveNode
     },
     invalidateCache: () => set({ graphJson: null }),
@@ -69,19 +54,19 @@ export const flowStoreFactory = (system: System) => {
         return cached;
       }
 
-      const nodes = system.nodeStore.getState().nodes;
-      const edges = system.edgeStore.getState().edges;
-      const _variables = system.variableStore.getState().variables;
-      const specs = system.specStore.getState().specs;
+      const nodes = session.nodeStore.getState().nodes;
+      const edges = session.edgeStore.getState().edges;
+      const _variables = session.variableStore.getState().variables;
+      const specs = session.editor.specStore.getState().specs;
 
-      const computed = flowToBehave(system, nodes, edges, specs);
+      const computed = flowToBehave(session, nodes, edges, specs);
 
       set({ graphJson: computed });
       return computed;
     },
 
     setGraph: (graphJson: GraphJSON, options?: { skipLayout?: boolean }) => {
-      system.eventsStore
+      session.eventsStore
         .getState()
         .setCustomEvents(
           Object.fromEntries(
@@ -94,7 +79,7 @@ export const flowStoreFactory = (system: System) => {
       if (graphJson.variables) {
         graphJson.variables.forEach((varJson) => {
           const valueType =
-            system.registry.getState().values[varJson.valueTypeName];
+            session.editor.registry.getState().values[varJson.valueTypeName];
           const initialValue = valueType?.deserialize
             ? valueType.deserialize(varJson.initialValue)
             : varJson.initialValue;
@@ -116,12 +101,12 @@ export const flowStoreFactory = (system: System) => {
         if (!hasPositionMetaData(graphJson)) {
           autoLayout(nodes, edges);
         }
-        system.nodeStore.getState().setNodes(nodes);
-        system.edgeStore.getState().setEdges(edges);
+        session.nodeStore.getState().setNodes(nodes);
+        session.edgeStore.getState().setEdges(edges);
       }
 
-      // custom events stored in system.eventsStore
-      system.variableStore.getState().setVariables(variables);
+      // custom events stored in session.eventsStore
+      session.variableStore.getState().setVariables(variables);
       get().invalidateCache();
     },
     edgeTypes: {
@@ -146,11 +131,11 @@ export const flowStoreFactory = (system: System) => {
     }
   }));
 
-  system.nodeStore.subscribe(() => {
+  session.nodeStore.subscribe(() => {
     flowStore.getState().invalidateCache();
   });
 
-  system.eventsStore.subscribe(() => {
+  session.eventsStore.subscribe(() => {
     flowStore.getState().invalidateCache();
   });
 
@@ -165,12 +150,12 @@ export type NodeStore = {
   applyNodeChanges: (changes: NodeChange[]) => void;
 };
 
-export const nodeStoreFactory = (system: System) =>
+export const nodeStoreFactory = (session: GraphSession) =>
   create<NodeStore>((set) => ({
     nodes: [],
     addNode(node) {
       set((x) => ({ nodes: [...x.nodes, node] }));
-      system.pubsub.publish('node:added', node);
+      session.pubsub.publish('node:added', node);
     },
     applyNodeChanges(changes: NodeChange[]) {
       set((p) => {
@@ -183,7 +168,7 @@ export const nodeStoreFactory = (system: System) =>
             }
             // Publish nodeRemoved event for deletable nodes
             if (node) {
-              system.pubsub.publish('node:removed', node);
+              session.pubsub.publish('node:removed', node);
             }
           }
           return true;
@@ -211,7 +196,7 @@ export type EdgeStore = {
   applyEdgeChanges: (changes: EdgeChange[]) => void;
 };
 
-export const edgeStoreFactory = (_system: System) =>
+export const edgeStoreFactory = (session: GraphSession) =>
   create<EdgeStore>((set) => ({
     edges: [],
 
@@ -225,7 +210,7 @@ export const edgeStoreFactory = (_system: System) =>
           if (change.type === 'remove') {
             const edge = p.edges.find((e) => e.id === change.id);
             if (edge) {
-              _system.pubsub.publish('edge:removed', edge);
+              session.pubsub.publish('edge:removed', edge);
             }
           }
         });

package/src/store/graphMeta.ts

@@ -0,0 +1,39 @@
+import { create, type StoreApi } from 'zustand';
+
+/**
+ * Reactive graph-level properties for a single {@link GraphSession}: the display
+ * name (also the tab title) and an arbitrary metadata bag (the graph
+ * annotations). Backed by a store so the Graph Properties panel, the tab title
+ * and anything else stay in sync.
+ */
+export type GraphMetaStore = {
+  name: string;
+  metadata: Record<string, any>;
+  setName: (name: string) => void;
+  /** Replace the whole metadata bag. */
+  setMetadata: (metadata: Record<string, any>) => void;
+  /** Shallow-merge into the metadata bag. */
+  mergeMetadata: (partial: Record<string, any>) => void;
+  setMetadataValue: (key: string, value: any) => void;
+  removeMetadataKey: (key: string) => void;
+};
+
+export const graphMetaStoreFactory = (
+  name = 'Graph'
+): StoreApi<GraphMetaStore> =>
+  create<GraphMetaStore>((set) => ({
+    name,
+    metadata: {},
+    setName: (name) => set({ name }),
+    setMetadata: (metadata) => set({ metadata: { ...metadata } }),
+    mergeMetadata: (partial) =>
+      set((s) => ({ metadata: { ...s.metadata, ...partial } })),
+    setMetadataValue: (key, value) =>
+      set((s) => ({ metadata: { ...s.metadata, [key]: value } })),
+    removeMetadataKey: (key) =>
+      set((s) => {
+        const next = { ...s.metadata };
+        delete next[key];
+        return { metadata: next };
+      })
+  }));