feat(store): add store as refs to useVueFlow

Signed-off-by: Braks <78412429+bcakmakoglu@users.noreply.github.com>

src/additional-components/MiniMap/MiniMap.vue

@@ -5,6 +5,8 @@ import { getBoundsofRects, getRectOfNodes } from '../../utils'
 import type { MiniMapProps } from '../../types/components'
 import MiniMapNode from './MiniMapNode.vue'
 
+type StringFunc = (node: GraphNode) => string
+
 const props = withDefaults(defineProps<MiniMapProps>(), {
   nodeStrokeColor: '#555',
   nodeColor: '#fff',

src/composables/useVueFlow.ts

@@ -8,16 +8,19 @@ import { useStore } from '~/store'
 const applyNodeChanges = (changes: NodeChange[], nodes: GraphNode[]) => applyChanges(changes, nodes)
 const applyEdgeChanges = (changes: EdgeChange[], edges: GraphEdge[]) => applyChanges(changes, edges)
 
+let id = 0
 export default (options?: FlowOptions): UseVueFlow => {
   const currentInstance = getCurrentInstance()
   let vueFlow: UseVueFlow | false | undefined = currentInstance ? inject(VueFlow, undefined) : false
-  if (!vueFlow || (vueFlow && options?.id && options.id !== vueFlow.store.id)) {
-    const store = reactive(useStore(options))
+  if (!vueFlow || (vueFlow && options?.id && options.id !== vueFlow.id)) {
+    const name = options?.id ?? `vue-flow-${id++}`
+    const store = reactive(useStore(name, options))
     const applyNodes = (changes: NodeChange[]) => applyNodeChanges(changes, store.nodes)
     const applyEdges = (changes: EdgeChange[]) => applyEdgeChanges(changes, store.edges)
     vueFlow = {
-      id: store.id,
+      id: name,
       store,
+      ...toRefs(store),
       useNodesState: (nodes, applyDefault = true) => useNodesState(store, applyNodes)({ nodes, applyDefault }),
       useEdgesState: (edges, applyDefault = true) => useEdgesState(store, applyEdges)({ edges, applyDefault }),
       applyNodeChanges: applyNodes,

src/container/VueFlow/VueFlow.vue

@@ -23,7 +23,7 @@ const emit = defineEmits([...Object.keys(createHooks()), 'update:modelValue', 'u
 const { modelValue, nodes, edges } = useVModels(props, emit)
 
 const { store } = useVueFlow(props)
-useHooks(store, emit)
+useHooks(store.hooks, emit)
 
 nextTick(() => {
   modelValue && (modelValue.value = [...store.nodes, ...store.edges])
@@ -33,13 +33,11 @@ nextTick(() => {
   modelValue && (modelValue.value = [...store.nodes, ...store.edges])
   edges && (edges.value = store.edges)
 })
-onMounted(() => {
-  watch(
-    () => props,
-    (v) => nextTick(() => store.setState(v)),
-    { flush: 'sync' },
-  )
-})
+watch(
+  () => props,
+  (v) => nextTick(() => store.setState(v)),
+  { flush: 'sync', deep: true, immediate: true },
+)
 </script>
 <script lang="ts">
 export default {

src/store/hooks.ts

@@ -47,4 +47,4 @@ const bind = (emit: EmitFunc, hooks: FlowHooks) => {
   }
 }
 
-export default (store: FlowStore, emit: EmitFunc) => bind(emit, store.hooks)
+export default (hooks: FlowHooks, emit: EmitFunc) => bind(emit, hooks)

src/store/state.ts

@@ -15,7 +15,7 @@ export const defaultEdgeTypes: DefaultEdgeTypes = {
   smoothstep: SmoothStepEdge,
 }
 
-export default (): FlowState => ({
+export default (preloadedState?: Partial<FlowState>): FlowState => ({
   nodes: [],
   edges: [],
 
@@ -87,4 +87,5 @@ export default (): FlowState => ({
   storageKey: undefined,
 
   vueFlowVersion: typeof __VUE_FLOW_VERSION__ !== 'undefined' ? __VUE_FLOW_VERSION__ : '-',
+  ...preloadedState,
 })

src/store/store.ts

@@ -2,10 +2,10 @@ import useState from './state'
 import useActions from './actions'
 import useGetters from './getters'
 import { FlowExportObject, FlowHooksOn, FlowOptions, FlowState, GraphEdge, GraphNode, Store } from '~/types'
-import { onLoadToObject } from '~/utils'
+import { isEdge, isNode, onLoadToObject } from '~/utils'
 
-const useFlowStore = (id: string, preloadedState: FlowState): Store => {
-  const state = reactive(useState())
+const useFlowStore = (preloadedState: FlowState): Store => {
+  const state = reactive(useState(preloadedState))
   const getters = useGetters(state)
   const actions = useActions(state, getters)
   const hooksOn: FlowHooksOn = <any>{}
@@ -15,7 +15,6 @@ const useFlowStore = (id: string, preloadedState: FlowState): Store => {
   })
   actions.setState(preloadedState)
   return {
-    id,
     state,
     hooksOn,
     ...toRefs(state),
@@ -24,27 +23,40 @@ const useFlowStore = (id: string, preloadedState: FlowState): Store => {
   }
 }
 
-let id = 0
-export default (options?: FlowOptions) => {
+export default (id: string, options?: FlowOptions) => {
   const withStorage = options?.storageKey ?? false
   let storedState = ref<FlowExportObject>()
-  const initial = useState()
-  const storageKey = options?.id ?? `vue-flow-${id++}`
+  const storageKey = id ?? options?.id
   const preloadedState = {
-    ...initial,
     ...(options as FlowState),
   }
   if (withStorage) {
     storedState = useStorage<FlowExportObject>(storageKey, { edges: [], nodes: [], position: [0, 0], zoom: 0 })
     if (storedState.value) {
-      preloadedState.nodes = (storedState.value.nodes ? storedState.value.nodes : options?.nodes ?? []) as GraphNode[]
-      preloadedState.edges = (storedState.value.edges ? storedState.value.edges : options?.edges ?? []) as GraphEdge[]
+      preloadedState.nodes = (
+        storedState.value.nodes
+          ? storedState.value.nodes
+          : options?.nodes
+          ? options.nodes
+          : options?.elements
+          ? options?.elements.filter((el) => isNode(el))
+          : []
+      ) as GraphNode[]
+      preloadedState.edges = (
+        storedState.value.edges
+          ? storedState.value.edges
+          : options?.edges
+          ? options.edges
+          : options?.elements
+          ? options?.elements.filter((el) => isEdge(el))
+          : []
+      ) as GraphEdge[]
       if (storedState.value.position && storedState.value.zoom)
         preloadedState.transform = [storedState.value.position[0], storedState.value.position[1], storedState.value.zoom]
     }
   }
-  const store = useFlowStore(storageKey, preloadedState)
-  if (withStorage && storageKey === store.id) {
+  const store = useFlowStore(preloadedState)
+  if (withStorage && storageKey === id) {
     const toObject = onLoadToObject(store.state)
     watch(
       store.state,

src/types/flow.ts

@@ -1,4 +1,4 @@
-import { CSSProperties } from 'vue'
+import { CSSProperties, ToRefs } from 'vue'
 import { GraphEdge, Edge } from './edge'
 import { GraphNode, CoordinateExtent, Node } from './node'
 import { Connection, ConnectionLineType, ConnectionMode } from './connection'
@@ -153,4 +153,5 @@ export type UseVueFlow = {
   useEdgesState: (edges?: Edge[], applyDefault?: boolean) => UseEdgeState
   applyNodeChanges: (changes: NodeChange[]) => void
   applyEdgeChanges: (changes: EdgeChange[]) => void
-} & FlowHooksOn
+} & FlowHooksOn &
+  ToRefs<FlowStore>

src/types/store.ts

@@ -97,7 +97,7 @@ export interface FlowGetters<N = any, E = N> {
   getSelectedEdges: ComputedRef<GraphEdge<E>[]>
 }
 
-export type Store<N = any, E = N> = { id: string; state: FlowState<N, E>; hooksOn: FlowHooksOn } & ToRefs<FlowState<N, E>> &
+export type Store<N = any, E = N> = { state: FlowState<N, E>; hooksOn: FlowHooksOn } & ToRefs<FlowState<N, E>> &
   FlowActions<N, E> &
   FlowGetters<N, E>
 export type FlowStore<N = any, E = N> = UnwrapNestedRefs<Store<N, E>>