@liveblocks/react-flow 3.16.0-flow1 → 3.16.0-flow2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,8 +1,25 @@
1
1
  import * as react from 'react';
2
- import { ComponentPropsWithoutRef } from 'react';
3
- import { LiveObject, DistributiveOmit, LsonObject, LiveMap, Resolve, JsonObject } from '@liveblocks/core';
4
- import { Node, Edge, OnNodesChange, OnEdgesChange, OnConnect } from '@xyflow/react';
2
+ import { ComponentPropsWithoutRef, ComponentType } from 'react';
3
+ import { SyncConfig, LiveObject, DistributiveOmit, LsonObject, LiveMap, Resolve } from '@liveblocks/core';
4
+ export { SyncConfig, SyncMode } from '@liveblocks/core';
5
+ import { Node, Edge, BuiltInNode, BuiltInEdge, OnNodesChange, OnEdgesChange, OnConnect, OnDelete } from '@xyflow/react';
5
6
 
7
+ interface CursorsCursorProps {
8
+ /**
9
+ * The user ID for this cursor.
10
+ */
11
+ userId: string;
12
+ /**
13
+ * The connection ID for this cursor.
14
+ */
15
+ connectionId: number;
16
+ }
17
+ interface CursorsComponents {
18
+ /**
19
+ * The component used to display each cursor.
20
+ */
21
+ Cursor: ComponentType<CursorsCursorProps>;
22
+ }
6
23
  interface CursorsProps extends ComponentPropsWithoutRef<"div"> {
7
24
  /**
8
25
  * The key used to store the cursors in users' Presence.
@@ -10,6 +27,10 @@ interface CursorsProps extends ComponentPropsWithoutRef<"div"> {
10
27
  * Defaults to `"cursor"`.
11
28
  */
12
29
  presenceKey?: string;
30
+ /**
31
+ * Override the component's components.
32
+ */
33
+ components?: Partial<CursorsComponents>;
13
34
  }
14
35
  /**
15
36
  * Displays other users' cursors inside a React Flow canvas and stores the
@@ -20,131 +41,177 @@ interface CursorsProps extends ComponentPropsWithoutRef<"div"> {
20
41
  */
21
42
  declare const Cursors: react.ForwardRefExoticComponent<CursorsProps & react.RefAttributes<HTMLDivElement>>;
22
43
 
23
- declare const NODE_LOCAL_KEYS: ["selected", "dragging", "measured", "resizing"];
24
- declare const EDGE_LOCAL_KEYS: ["selected"];
25
- type SerializableNode = Node<JsonObject>;
26
- type SerializableEdge = Edge<JsonObject>;
44
+ type InferNodeTypeLiterals<N> = N extends Node<any, infer T extends string> ? string extends T ? never : T : never;
45
+ type NodeTypeLiterals<N> = (string & {}) | "*" | InferNodeTypeLiterals<N>;
46
+ type InferEdgeTypeLiterals<E> = E extends Edge<any, infer T extends string> ? string extends T ? never : T : never;
47
+ type EdgeTypeLiterals<E> = (string & {}) | "*" | InferEdgeTypeLiterals<E>;
48
+ type NodeSyncConfig<N extends Node> = {
49
+ [key in NodeTypeLiterals<N>]?: SyncConfig;
50
+ };
51
+ type EdgeSyncConfig<E extends Edge> = {
52
+ [key in EdgeTypeLiterals<E>]?: SyncConfig;
53
+ };
27
54
  /**
28
55
  * The Liveblocks Storage representation of a React Flow `Node`.
29
- *
30
- * It doesn't include local-only properties.
31
- * The entire node and its `data` property are both stored as `LiveObject`s.
32
56
  */
33
- type LiveblocksNode<TNode extends SerializableNode = SerializableNode> = LiveObject<DistributiveOmit<TNode, (typeof NODE_LOCAL_KEYS)[number] | "data"> & {
34
- data: LiveObject<TNode["data"]>;
57
+ type LiveblocksNode<N extends Node = BuiltInNode, _S extends NodeSyncConfig<N> = NodeSyncConfig<N>> = LiveObject<DistributiveOmit<N, "data"> & {
58
+ data: LsonObject;
35
59
  } & LsonObject>;
36
60
  /**
37
61
  * The Liveblocks Storage representation of a React Flow `Edge`.
38
- *
39
- * It doesn't include local-only properties.
40
- * The entire edge and its `data` property are both stored as `LiveObject`s.
41
62
  */
42
- type LiveblocksEdge<TEdge extends SerializableEdge = SerializableEdge> = LiveObject<DistributiveOmit<TEdge, (typeof EDGE_LOCAL_KEYS)[number] | "data"> & {
43
- data?: LiveObject<NonNullable<TEdge["data"]>>;
63
+ type LiveblocksEdge<E extends Edge = BuiltInEdge, _S extends EdgeSyncConfig<E> = EdgeSyncConfig<E>> = LiveObject<DistributiveOmit<E, "data"> & {
64
+ data?: LsonObject;
44
65
  } & LsonObject>;
45
66
  /**
46
67
  * The Liveblocks Storage representation of a React Flow diagram made of nodes and edges.
47
- *
48
- * Nodes and edges are stored as `LiveMap`s keyed by their IDs, enabling
49
- * fine-grained conflict-free updates from multiple clients simultaneously.
50
68
  */
51
- type LiveblocksFlow<TNode extends SerializableNode = SerializableNode, TEdge extends SerializableEdge = SerializableEdge> = LiveObject<{
52
- nodes: LiveMap<string, LiveblocksNode<TNode>>;
53
- edges: LiveMap<string, LiveblocksEdge<TEdge>>;
69
+ type LiveblocksFlow<N extends Node = BuiltInNode, E extends Edge = BuiltInEdge, NS extends NodeSyncConfig<N> = NodeSyncConfig<N>, ES extends EdgeSyncConfig<E> = EdgeSyncConfig<E>> = LiveObject<{
70
+ nodes: LiveMap<string, LiveblocksNode<N, NS>>;
71
+ edges: LiveMap<string, LiveblocksEdge<E, ES>>;
54
72
  }>;
55
- type UseLiveblocksFlowResult<TNode extends SerializableNode = SerializableNode, TEdge extends SerializableEdge = SerializableEdge> = Resolve<({
73
+
74
+ type UseLiveblocksFlowResult<N extends Node = BuiltInNode, E extends Edge = BuiltInEdge> = Resolve<({
56
75
  nodes: null;
57
76
  edges: null;
58
77
  isLoading: true;
59
78
  } | {
60
- nodes: TNode[];
61
- edges: TEdge[];
79
+ nodes: N[];
80
+ edges: E[];
62
81
  isLoading: false;
63
82
  }) & {
64
- onNodesChange: OnNodesChange<TNode>;
65
- onEdgesChange: OnEdgesChange<TEdge>;
83
+ onNodesChange: OnNodesChange<N>;
84
+ onEdgesChange: OnEdgesChange<E>;
66
85
  onConnect: OnConnect;
86
+ onDelete: OnDelete<N, E>;
67
87
  }>;
68
- type UseLiveblocksFlowOptions<TNode extends SerializableNode, TEdge extends SerializableEdge> = {
69
- /**
70
- * The initial React Flow nodes and edges.
71
- *
72
- * @example
73
- * ```tsx
74
- * const { ... } = useLiveblocksFlow({
75
- * initial: {
76
- * nodes: [
77
- * { id: "1", position: { x: 0, y: 0 }, data: { label: "Node 1" } },
78
- * { id: "2", position: { x: 0, y: 100 }, data: { label: "Node 2" } },
79
- * ],
80
- * edges: [
81
- * { id: "1-2", source: "1", target: "2" },
82
- * ],
83
- * },
84
- * });
85
- * ```
86
- *
87
- * This is equivalent to setting `initialStorage` on `RoomProvider`.
88
- *
89
- * @example
90
- * ```tsx
91
- * <RoomProvider
92
- * initialStorage={{
93
- * flow: createLiveblocksFlow([
94
- * { id: "1", position: { x: 0, y: 0 }, data: { label: "Node 1" } },
95
- * { id: "2", position: { x: 0, y: 100 }, data: { label: "Node 2" } },
96
- * ], [
97
- * { id: "1-2", source: "1", target: "2" },
98
- * ]),
99
- * }}
100
- * />
101
- * ```
102
- */
103
- initial?: {
104
- nodes?: TNode[];
105
- edges?: TEdge[];
88
+ type LiveblocksFlowSuspenseResult<N extends Node = BuiltInNode, E extends Edge = BuiltInEdge> = Extract<UseLiveblocksFlowResult<N, E>, {
89
+ isLoading: false;
90
+ }>;
91
+ type UseLiveblocksFlowOptions<N extends Node, E extends Edge> = {
92
+ nodes?: {
93
+ /**
94
+ * The initial React Flow nodes.
95
+ *
96
+ * @example
97
+ * ```tsx
98
+ * const { ... } = useLiveblocksFlow({
99
+ * nodes: {
100
+ * initial: [
101
+ * { id: "1", position: { x: 0, y: 0 }, data: { label: "Node 1" } },
102
+ * { id: "2", position: { x: 0, y: 100 }, data: { label: "Node 2" } },
103
+ * ],
104
+ * },
105
+ * });
106
+ * ```
107
+ */
108
+ initial?: N[];
109
+ /**
110
+ * Per-type sync configuration for node data keys.
111
+ *
112
+ * Use `"*"` as a fallback for all node types. Type-specific entries are
113
+ * deep-merged on top of `"*"`, with explicitly named keys taking
114
+ * precedence.
115
+ *
116
+ * @example
117
+ * ```tsx
118
+ * const { ... } = useLiveblocksFlow({
119
+ * nodes: {
120
+ * sync: {
121
+ * // Fallback for all node types
122
+ * "*": { label: false },
123
+ *
124
+ * // Override for "custom" nodes
125
+ * "custom": { color: false },
126
+ * },
127
+ * },
128
+ * });
129
+ * ```
130
+ */
131
+ sync?: NodeSyncConfig<N>;
132
+ };
133
+ edges?: {
134
+ initial?: E[];
135
+ /**
136
+ * Per-type sync configuration for edge data keys.
137
+ *
138
+ * Use `"*"` as a fallback for all edge types. Type-specific entries are
139
+ * deep-merged on top of `"*"`, with explicitly named keys taking
140
+ * precedence.
141
+ *
142
+ * @example
143
+ * ```tsx
144
+ * const { ... } = useLiveblocksFlow({
145
+ * edges: {
146
+ * sync: {
147
+ * // Fallback for all node types
148
+ * "*": { floating: false },
149
+ * },
150
+ * },
151
+ * });
152
+ * ```
153
+ */
154
+ sync?: EdgeSyncConfig<E>;
106
155
  };
107
156
  /**
108
157
  * The key used to store the React Flow diagram in Liveblocks Storage.
109
- *
110
158
  * Defaults to `"flow"`.
111
- *
112
- * @example
113
- * ```tsx
114
- * const { ... } = useLiveblocksFlow({
115
- * storageKey: "myDiagram",
116
- * });
117
- * ```
118
159
  */
119
160
  storageKey?: string;
161
+ /**
162
+ * When true, suspends until Storage is ready (use a React `Suspense`
163
+ * boundary). Then `nodes` and `edges` are always arrays and `isLoading` is
164
+ * always false.
165
+ */
166
+ suspense?: boolean;
120
167
  };
121
- /**
122
- * Creates a Liveblocks Storage representation of a React Flow diagram from nodes and edges.
123
- *
124
- * @example
125
- * ```tsx
126
- * <RoomProvider
127
- * initialStorage={{
128
- * flow: createLiveblocksFlow(initialNodes, initialEdges),
129
- * }}
130
- * />
131
- * ```
132
- */
133
- declare function createLiveblocksFlow<TNode extends SerializableNode = SerializableNode, TEdge extends SerializableEdge = SerializableEdge>(nodes?: TNode[], edges?: TEdge[]): LiveblocksFlow<TNode, TEdge>;
134
168
  /**
135
169
  * Returns a controlled React Flow state backed by Liveblocks Storage.
136
170
  *
137
171
  * @example
138
172
  * ```tsx
139
- * const { nodes, edges, onNodesChange, onEdgesChange, onConnect, isLoading } = useLiveblocksFlow();
173
+ * const { nodes, edges, onNodesChange, onEdgesChange, onConnect, onDelete, isLoading } = useLiveblocksFlow();
140
174
  *
141
175
  * if (isLoading) {
142
176
  * return <div>Loading…</div>
143
177
  * }
144
178
  *
145
- * return <ReactFlow nodes={nodes} edges={edges} onNodesChange={onNodesChange} onEdgesChange={onEdgesChange} onConnect={onConnect} />;
179
+ * return <ReactFlow nodes={nodes} edges={edges} onNodesChange={onNodesChange} onEdgesChange={onEdgesChange} onConnect={onConnect} onDelete={onDelete} />;
146
180
  * ```
181
+ * Pass `{ suspense: true }` to suspend until Storage is ready, `nodes` and `edges` will never be `null`.
182
+ *
183
+ * @example
184
+ * ```tsx
185
+ * const { nodes, edges, onNodesChange, onEdgesChange, onConnect, onDelete } =
186
+ * useLiveblocksFlow({ suspense: true });
187
+ *
188
+ * return <ReactFlow nodes={nodes} edges={edges} onNodesChange={onNodesChange} onEdgesChange={onEdgesChange} onConnect={onConnect} onDelete={onDelete} />;
189
+ * ```
190
+ */
191
+ declare function useLiveblocksFlow<N extends Node = BuiltInNode, E extends Edge = BuiltInEdge>(options?: UseLiveblocksFlowOptions<N, E> & {
192
+ suspense?: false;
193
+ }): Resolve<UseLiveblocksFlowResult<N, E>>;
194
+ declare function useLiveblocksFlow<N extends Node = BuiltInNode, E extends Edge = BuiltInEdge>(options: UseLiveblocksFlowOptions<N, E> & {
195
+ suspense: true;
196
+ }): Resolve<LiveblocksFlowSuspenseResult<N, E>>;
197
+
198
+ /**
199
+ * @experimental
200
+ *
201
+ * Converts a React Flow `Node` into a Liveblocks Storage version.
202
+ * Keys marked `false` in config are set as local-only (not synced).
203
+ * Keys marked `"atomic"` are stored as plain Json (no deep wrapping).
204
+ * All other keys are deep-liveified (objects→LiveObject, arrays→LiveList).
205
+ */
206
+ declare function toLiveblocksNode<N extends Node>(node: N, config?: SyncConfig): LiveblocksNode<N>;
207
+ /**
208
+ * @experimental
209
+ *
210
+ * Converts a React Flow `Edge` into a Liveblocks Storage version.
211
+ * Keys marked `false` in config are set as local-only (not synced).
212
+ * Keys marked `"atomic"` are stored as plain Json (no deep wrapping).
213
+ * All other keys are deep-liveified (objects→LiveObject, arrays→LiveList).
147
214
  */
148
- declare function useLiveblocksFlow<TNode extends SerializableNode = SerializableNode, TEdge extends SerializableEdge = SerializableEdge>(options?: UseLiveblocksFlowOptions<TNode, TEdge>): Resolve<UseLiveblocksFlowResult<TNode, TEdge>>;
215
+ declare function toLiveblocksEdge<E extends Edge>(edge: E, config?: SyncConfig): LiveblocksEdge<E>;
149
216
 
150
- export { Cursors, LiveblocksEdge, LiveblocksFlow, LiveblocksNode, createLiveblocksFlow, useLiveblocksFlow };
217
+ export { Cursors, CursorsCursorProps, CursorsProps, EdgeSyncConfig, LiveblocksEdge, LiveblocksFlow, LiveblocksNode, NodeSyncConfig, toLiveblocksEdge, toLiveblocksNode, useLiveblocksFlow };
package/dist/index.js CHANGED
@@ -1,7 +1,8 @@
1
1
  import { detectDupes } from '@liveblocks/core';
2
2
  import { PKG_NAME, PKG_VERSION, PKG_FORMAT } from './version.js';
3
3
  export { Cursors } from './cursors.js';
4
- export { createLiveblocksFlow, useLiveblocksFlow } from './flow.js';
4
+ export { useLiveblocksFlow } from './flow.js';
5
+ export { toLiveblocksEdge, toLiveblocksNode } from './helpers.js';
5
6
 
6
7
  detectDupes(PKG_NAME, PKG_VERSION, PKG_FORMAT);
7
8
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["import { detectDupes } from \"@liveblocks/core\";\n\nimport { PKG_FORMAT, PKG_NAME, PKG_VERSION } from \"./version\";\n\ndetectDupes(PKG_NAME, PKG_VERSION, PKG_FORMAT);\n\nexport { Cursors } from \"./cursors\";\nexport type { LiveblocksEdge, LiveblocksFlow, LiveblocksNode } from \"./flow\";\nexport { createLiveblocksFlow, useLiveblocksFlow } from \"./flow\";\n"],"names":[],"mappings":";;;;;AAIA,WAAY,CAAA,QAAA,EAAU,aAAa,UAAU,CAAA"}
1
+ {"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["import { detectDupes } from \"@liveblocks/core\";\n\nimport { PKG_FORMAT, PKG_NAME, PKG_VERSION } from \"./version\";\n\ndetectDupes(PKG_NAME, PKG_VERSION, PKG_FORMAT);\n\nexport type { CursorsCursorProps, CursorsProps } from \"./cursors\";\nexport { Cursors } from \"./cursors\";\nexport { useLiveblocksFlow } from \"./flow\";\nexport { toLiveblocksEdge, toLiveblocksNode } from \"./helpers\";\nexport type {\n EdgeSyncConfig,\n LiveblocksEdge,\n LiveblocksFlow,\n LiveblocksNode,\n NodeSyncConfig,\n SyncConfig,\n SyncMode,\n} from \"./types\";\n"],"names":[],"mappings":";;;;;;AAIA,WAAY,CAAA,QAAA,EAAU,aAAa,UAAU,CAAA"}
package/dist/version.cjs CHANGED
@@ -1,7 +1,7 @@
1
1
  'use strict';
2
2
 
3
3
  const PKG_NAME = "@liveblocks/react-flow";
4
- const PKG_VERSION = typeof "3.16.0-flow1" === "string" && "3.16.0-flow1";
4
+ const PKG_VERSION = typeof "3.16.0-flow2" === "string" && "3.16.0-flow2";
5
5
  const PKG_FORMAT = typeof TSUP_FORMAT === "string" && TSUP_FORMAT;
6
6
 
7
7
  exports.PKG_FORMAT = PKG_FORMAT;
package/dist/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  const PKG_NAME = "@liveblocks/react-flow";
2
- const PKG_VERSION = typeof "3.16.0-flow1" === "string" && "3.16.0-flow1";
2
+ const PKG_VERSION = typeof "3.16.0-flow2" === "string" && "3.16.0-flow2";
3
3
  const PKG_FORMAT = typeof TSUP_FORMAT === "string" && TSUP_FORMAT;
4
4
 
5
5
  export { PKG_FORMAT, PKG_NAME, PKG_VERSION };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@liveblocks/react-flow",
3
- "version": "3.16.0-flow1",
4
- "description": "An integration of React Flow to enable collaboration, comments, live cursors, and more with Liveblocks.",
3
+ "version": "3.16.0-flow2",
4
+ "description": "An integration of React Flow to enable collaboration and realtime cursors with Liveblocks.",
5
5
  "license": "Apache-2.0",
6
6
  "author": "Liveblocks Inc.",
7
7
  "type": "module",
@@ -22,17 +22,6 @@
22
22
  "./styles.css": {
23
23
  "types": "./styles.css.d.cts",
24
24
  "default": "./styles.css"
25
- },
26
- "./suspense": {
27
- "import": {
28
- "types": "./dist/suspense.d.ts",
29
- "default": "./dist/suspense.js"
30
- },
31
- "require": {
32
- "types": "./dist/suspense.d.cts",
33
- "module": "./dist/suspense.js",
34
- "default": "./dist/suspense.cjs"
35
- }
36
25
  }
37
26
  },
38
27
  "files": [
@@ -41,7 +30,6 @@
41
30
  "**/*.css.d.cts",
42
31
  "**/*.css.d.ts",
43
32
  "**/*.css.map",
44
- "suspense/**",
45
33
  "README.md"
46
34
  ],
47
35
  "scripts": {
@@ -55,10 +43,10 @@
55
43
  "test:watch": "vitest"
56
44
  },
57
45
  "dependencies": {
58
- "@liveblocks/client": "3.16.0-flow1",
59
- "@liveblocks/core": "3.16.0-flow1",
60
- "@liveblocks/react": "3.16.0-flow1",
61
- "@liveblocks/react-ui": "3.16.0-flow1"
46
+ "@liveblocks/client": "3.16.0-flow2",
47
+ "@liveblocks/core": "3.16.0-flow2",
48
+ "@liveblocks/react": "3.16.0-flow2",
49
+ "@liveblocks/react-ui": "3.16.0-flow2"
62
50
  },
63
51
  "peerDependencies": {
64
52
  "@xyflow/react": "^12",
package/dist/suspense.cjs DELETED
@@ -1,13 +0,0 @@
1
- 'use strict';
2
-
3
- var core = require('@liveblocks/core');
4
- var version = require('./version.cjs');
5
- var cursors = require('./cursors.cjs');
6
- var flow = require('./flow.cjs');
7
-
8
- core.detectDupes(version.PKG_NAME, version.PKG_VERSION, version.PKG_FORMAT);
9
-
10
- exports.Cursors = cursors.Cursors;
11
- exports.createLiveblocksFlow = flow.createLiveblocksFlow;
12
- exports.useLiveblocksFlow = flow.useLiveblocksFlowSuspense;
13
- //# sourceMappingURL=suspense.cjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"suspense.cjs","sources":["../src/suspense.ts"],"sourcesContent":["import { detectDupes } from \"@liveblocks/core\";\n\nimport { PKG_FORMAT, PKG_NAME, PKG_VERSION } from \"./version\";\n\ndetectDupes(PKG_NAME, PKG_VERSION, PKG_FORMAT);\n\nexport { Cursors } from \"./cursors\";\nexport type { LiveblocksEdge, LiveblocksFlow, LiveblocksNode } from \"./flow\";\nexport {\n createLiveblocksFlow,\n useLiveblocksFlowSuspense as useLiveblocksFlow,\n} from \"./flow\";\n"],"names":["detectDupes","PKG_NAME","PKG_VERSION","PKG_FORMAT"],"mappings":";;;;;;;AAIAA,gBAAY,CAAAC,gBAAA,EAAUC,qBAAaC,kBAAU,CAAA;;;;;;"}
@@ -1,149 +0,0 @@
1
- import * as react from 'react';
2
- import { ComponentPropsWithoutRef } from 'react';
3
- import { LiveObject, DistributiveOmit, LsonObject, LiveMap, Resolve, JsonObject } from '@liveblocks/core';
4
- import { Node, Edge, OnNodesChange, OnEdgesChange, OnConnect } from '@xyflow/react';
5
-
6
- interface CursorsProps extends ComponentPropsWithoutRef<"div"> {
7
- /**
8
- * The key used to store the cursors in users' Presence.
9
- *
10
- * Defaults to `"cursor"`.
11
- */
12
- presenceKey?: string;
13
- }
14
- /**
15
- * Displays other users' cursors inside a React Flow canvas and stores the
16
- * current user's cursor in Presence as `{ cursor: { x, y } }`.
17
- *
18
- * Cursor coordinates are kept in React Flow canvas space, so panning moves
19
- * them correctly while zooming only affects their position, not their size.
20
- */
21
- declare const Cursors: react.ForwardRefExoticComponent<CursorsProps & react.RefAttributes<HTMLDivElement>>;
22
-
23
- declare const NODE_LOCAL_KEYS: ["selected", "dragging", "measured", "resizing"];
24
- declare const EDGE_LOCAL_KEYS: ["selected"];
25
- type SerializableNode = Node<JsonObject>;
26
- type SerializableEdge = Edge<JsonObject>;
27
- /**
28
- * The Liveblocks Storage representation of a React Flow `Node`.
29
- *
30
- * It doesn't include local-only properties.
31
- * The entire node and its `data` property are both stored as `LiveObject`s.
32
- */
33
- type LiveblocksNode<TNode extends SerializableNode = SerializableNode> = LiveObject<DistributiveOmit<TNode, (typeof NODE_LOCAL_KEYS)[number] | "data"> & {
34
- data: LiveObject<TNode["data"]>;
35
- } & LsonObject>;
36
- /**
37
- * The Liveblocks Storage representation of a React Flow `Edge`.
38
- *
39
- * It doesn't include local-only properties.
40
- * The entire edge and its `data` property are both stored as `LiveObject`s.
41
- */
42
- type LiveblocksEdge<TEdge extends SerializableEdge = SerializableEdge> = LiveObject<DistributiveOmit<TEdge, (typeof EDGE_LOCAL_KEYS)[number] | "data"> & {
43
- data?: LiveObject<NonNullable<TEdge["data"]>>;
44
- } & LsonObject>;
45
- /**
46
- * The Liveblocks Storage representation of a React Flow diagram made of nodes and edges.
47
- *
48
- * Nodes and edges are stored as `LiveMap`s keyed by their IDs, enabling
49
- * fine-grained conflict-free updates from multiple clients simultaneously.
50
- */
51
- type LiveblocksFlow<TNode extends SerializableNode = SerializableNode, TEdge extends SerializableEdge = SerializableEdge> = LiveObject<{
52
- nodes: LiveMap<string, LiveblocksNode<TNode>>;
53
- edges: LiveMap<string, LiveblocksEdge<TEdge>>;
54
- }>;
55
- type UseLiveblocksFlowResult<TNode extends SerializableNode = SerializableNode, TEdge extends SerializableEdge = SerializableEdge> = Resolve<({
56
- nodes: null;
57
- edges: null;
58
- isLoading: true;
59
- } | {
60
- nodes: TNode[];
61
- edges: TEdge[];
62
- isLoading: false;
63
- }) & {
64
- onNodesChange: OnNodesChange<TNode>;
65
- onEdgesChange: OnEdgesChange<TEdge>;
66
- onConnect: OnConnect;
67
- }>;
68
- type LiveblocksFlowSuspenseResult<TNode extends SerializableNode = SerializableNode, TEdge extends SerializableEdge = SerializableEdge> = Extract<UseLiveblocksFlowResult<TNode, TEdge>, {
69
- isLoading: false;
70
- }>;
71
- type UseLiveblocksFlowOptions<TNode extends SerializableNode, TEdge extends SerializableEdge> = {
72
- /**
73
- * The initial React Flow nodes and edges.
74
- *
75
- * @example
76
- * ```tsx
77
- * const { ... } = useLiveblocksFlow({
78
- * initial: {
79
- * nodes: [
80
- * { id: "1", position: { x: 0, y: 0 }, data: { label: "Node 1" } },
81
- * { id: "2", position: { x: 0, y: 100 }, data: { label: "Node 2" } },
82
- * ],
83
- * edges: [
84
- * { id: "1-2", source: "1", target: "2" },
85
- * ],
86
- * },
87
- * });
88
- * ```
89
- *
90
- * This is equivalent to setting `initialStorage` on `RoomProvider`.
91
- *
92
- * @example
93
- * ```tsx
94
- * <RoomProvider
95
- * initialStorage={{
96
- * flow: createLiveblocksFlow([
97
- * { id: "1", position: { x: 0, y: 0 }, data: { label: "Node 1" } },
98
- * { id: "2", position: { x: 0, y: 100 }, data: { label: "Node 2" } },
99
- * ], [
100
- * { id: "1-2", source: "1", target: "2" },
101
- * ]),
102
- * }}
103
- * />
104
- * ```
105
- */
106
- initial?: {
107
- nodes?: TNode[];
108
- edges?: TEdge[];
109
- };
110
- /**
111
- * The key used to store the React Flow diagram in Liveblocks Storage.
112
- *
113
- * Defaults to `"flow"`.
114
- *
115
- * @example
116
- * ```tsx
117
- * const { ... } = useLiveblocksFlow({
118
- * storageKey: "myDiagram",
119
- * });
120
- * ```
121
- */
122
- storageKey?: string;
123
- };
124
- /**
125
- * Creates a Liveblocks Storage representation of a React Flow diagram from nodes and edges.
126
- *
127
- * @example
128
- * ```tsx
129
- * <RoomProvider
130
- * initialStorage={{
131
- * flow: createLiveblocksFlow(initialNodes, initialEdges),
132
- * }}
133
- * />
134
- * ```
135
- */
136
- declare function createLiveblocksFlow<TNode extends SerializableNode = SerializableNode, TEdge extends SerializableEdge = SerializableEdge>(nodes?: TNode[], edges?: TEdge[]): LiveblocksFlow<TNode, TEdge>;
137
- /**
138
- * Returns a controlled React Flow state backed by Liveblocks Storage.
139
- *
140
- * @example
141
- * ```tsx
142
- * const { nodes, edges, onNodesChange, onEdgesChange, onConnect } = useLiveblocksFlow();
143
- *
144
- * return <ReactFlow nodes={nodes} edges={edges} onNodesChange={onNodesChange} onEdgesChange={onEdgesChange} onConnect={onConnect} />;
145
- * ```
146
- */
147
- declare function useLiveblocksFlowSuspense<TNode extends SerializableNode = SerializableNode, TEdge extends SerializableEdge = SerializableEdge>(options?: UseLiveblocksFlowOptions<TNode, TEdge>): Resolve<LiveblocksFlowSuspenseResult<TNode, TEdge>>;
148
-
149
- export { Cursors, LiveblocksEdge, LiveblocksFlow, LiveblocksNode, createLiveblocksFlow, useLiveblocksFlowSuspense as useLiveblocksFlow };