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

package/dist/suspense.d.ts

@@ -1,149 +0,0 @@
-import * as react from 'react';
-import { ComponentPropsWithoutRef } from 'react';
-import { LiveObject, DistributiveOmit, LsonObject, LiveMap, Resolve, JsonObject } from '@liveblocks/core';
-import { Node, Edge, OnNodesChange, OnEdgesChange, OnConnect } from '@xyflow/react';
-
-interface CursorsProps extends ComponentPropsWithoutRef<"div"> {
-    /**
-     * The key used to store the cursors in users' Presence.
-     *
-     * Defaults to `"cursor"`.
-     */
-    presenceKey?: string;
-}
-/**
- * Displays other users' cursors inside a React Flow canvas and stores the
- * current user's cursor in Presence as `{ cursor: { x, y } }`.
- *
- * Cursor coordinates are kept in React Flow canvas space, so panning moves
- * them correctly while zooming only affects their position, not their size.
- */
-declare const Cursors: react.ForwardRefExoticComponent<CursorsProps & react.RefAttributes<HTMLDivElement>>;
-
-declare const NODE_LOCAL_KEYS: ["selected", "dragging", "measured", "resizing"];
-declare const EDGE_LOCAL_KEYS: ["selected"];
-type SerializableNode = Node<JsonObject>;
-type SerializableEdge = Edge<JsonObject>;
-/**
- * The Liveblocks Storage representation of a React Flow `Node`.
- *
- * It doesn't include local-only properties.
- * The entire node and its `data` property are both stored as `LiveObject`s.
- */
-type LiveblocksNode<TNode extends SerializableNode = SerializableNode> = LiveObject<DistributiveOmit<TNode, (typeof NODE_LOCAL_KEYS)[number] | "data"> & {
-    data: LiveObject<TNode["data"]>;
-} & LsonObject>;
-/**
- * The Liveblocks Storage representation of a React Flow `Edge`.
- *
- * It doesn't include local-only properties.
- * The entire edge and its `data` property are both stored as `LiveObject`s.
- */
-type LiveblocksEdge<TEdge extends SerializableEdge = SerializableEdge> = LiveObject<DistributiveOmit<TEdge, (typeof EDGE_LOCAL_KEYS)[number] | "data"> & {
-    data?: LiveObject<NonNullable<TEdge["data"]>>;
-} & LsonObject>;
-/**
- * The Liveblocks Storage representation of a React Flow diagram made of nodes and edges.
- *
- * Nodes and edges are stored as `LiveMap`s keyed by their IDs, enabling
- * fine-grained conflict-free updates from multiple clients simultaneously.
- */
-type LiveblocksFlow<TNode extends SerializableNode = SerializableNode, TEdge extends SerializableEdge = SerializableEdge> = LiveObject<{
-    nodes: LiveMap<string, LiveblocksNode<TNode>>;
-    edges: LiveMap<string, LiveblocksEdge<TEdge>>;
-}>;
-type UseLiveblocksFlowResult<TNode extends SerializableNode = SerializableNode, TEdge extends SerializableEdge = SerializableEdge> = Resolve<({
-    nodes: null;
-    edges: null;
-    isLoading: true;
-} | {
-    nodes: TNode[];
-    edges: TEdge[];
-    isLoading: false;
-}) & {
-    onNodesChange: OnNodesChange<TNode>;
-    onEdgesChange: OnEdgesChange<TEdge>;
-    onConnect: OnConnect;
-}>;
-type LiveblocksFlowSuspenseResult<TNode extends SerializableNode = SerializableNode, TEdge extends SerializableEdge = SerializableEdge> = Extract<UseLiveblocksFlowResult<TNode, TEdge>, {
-    isLoading: false;
-}>;
-type UseLiveblocksFlowOptions<TNode extends SerializableNode, TEdge extends SerializableEdge> = {
-    /**
-     * The initial React Flow nodes and edges.
-     *
-     * @example
-     * ```tsx
-     * const { ... } = useLiveblocksFlow({
-     *   initial: {
-     *     nodes: [
-     *       { id: "1", position: { x: 0, y: 0 }, data: { label: "Node 1" } },
-     *       { id: "2", position: { x: 0, y: 100 }, data: { label: "Node 2" } },
-     *     ],
-     *     edges: [
-     *       { id: "1-2", source: "1", target: "2" },
-     *     ],
-     *   },
-     * });
-     * ```
-     *
-     * This is equivalent to setting `initialStorage` on `RoomProvider`.
-     *
-     * @example
-     * ```tsx
-     * <RoomProvider
-     *   initialStorage={{
-     *     flow: createLiveblocksFlow([
-     *       { id: "1", position: { x: 0, y: 0 }, data: { label: "Node 1" } },
-     *       { id: "2", position: { x: 0, y: 100 }, data: { label: "Node 2" } },
-     *     ], [
-     *       { id: "1-2", source: "1", target: "2" },
-     *     ]),
-     *   }}
-     * />
-     * ```
-     */
-    initial?: {
-        nodes?: TNode[];
-        edges?: TEdge[];
-    };
-    /**
-     * The key used to store the React Flow diagram in Liveblocks Storage.
-     *
-     * Defaults to `"flow"`.
-     *
-     * @example
-     * ```tsx
-     * const { ... } = useLiveblocksFlow({
-     *   storageKey: "myDiagram",
-     * });
-     * ```
-     */
-    storageKey?: string;
-};
-/**
- * Creates a Liveblocks Storage representation of a React Flow diagram from nodes and edges.
- *
- * @example
- * ```tsx
- * <RoomProvider
- *   initialStorage={{
- *     flow: createLiveblocksFlow(initialNodes, initialEdges),
- *   }}
- * />
- * ```
- */
-declare function createLiveblocksFlow<TNode extends SerializableNode = SerializableNode, TEdge extends SerializableEdge = SerializableEdge>(nodes?: TNode[], edges?: TEdge[]): LiveblocksFlow<TNode, TEdge>;
-/**
- * Returns a controlled React Flow state backed by Liveblocks Storage.
- *
- * @example
- * ```tsx
- * const { nodes, edges, onNodesChange, onEdgesChange, onConnect } = useLiveblocksFlow();
- *
- * return <ReactFlow nodes={nodes} edges={edges} onNodesChange={onNodesChange} onEdgesChange={onEdgesChange} onConnect={onConnect} />;
- * ```
- */
-declare function useLiveblocksFlowSuspense<TNode extends SerializableNode = SerializableNode, TEdge extends SerializableEdge = SerializableEdge>(options?: UseLiveblocksFlowOptions<TNode, TEdge>): Resolve<LiveblocksFlowSuspenseResult<TNode, TEdge>>;
-
-export { Cursors, LiveblocksEdge, LiveblocksFlow, LiveblocksNode, createLiveblocksFlow, useLiveblocksFlowSuspense as useLiveblocksFlow };

package/dist/suspense.js

@@ -1,7 +0,0 @@
-import { detectDupes } from '@liveblocks/core';
-import { PKG_NAME, PKG_VERSION, PKG_FORMAT } from './version.js';
-export { Cursors } from './cursors.js';
-export { createLiveblocksFlow, useLiveblocksFlowSuspense as useLiveblocksFlow } from './flow.js';
-
-detectDupes(PKG_NAME, PKG_VERSION, PKG_FORMAT);
-//# sourceMappingURL=suspense.js.map

package/dist/suspense.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"suspense.js","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":[],"mappings":";;;;;AAIA,WAAY,CAAA,QAAA,EAAU,aAAa,UAAU,CAAA"}

package/suspense/README.md

@@ -1,5 +0,0 @@
-What is this directory? It exists solely to support subpath imports for node10.
-
-While we're not interested in supporting this long-past EOL version 10 of Node,
-we add this to acknowledge the reality that many TypeScript projects out there
-are still using `--moduleResolution node`.

package/suspense/package.json

@@ -1,4 +0,0 @@
-{
-  "main": "../dist/suspense.cjs",
-  "types": "../dist/suspense.d.cts"
-}