canvu-react 0.3.10 → 0.3.12

package/dist/realtime.d.cts

@@ -1,11 +1,11 @@
-import { P as PlacementPreview, X as RemotePresenceMarkupStroke, Y as RemotePresencePeer, Z as RemotePresenceCamera, _ as RealtimeConnectionState, J as VectorViewportHandle, b as VectorToolDefinition, K as VectorViewportProps, C as CanvasPlugin, f as CanvasPluginRenderContext } from './types-BtLGGw0r.cjs';
-export { $ as PresenceOverlayRenderContext } from './types-BtLGGw0r.cjs';
+import { P as PlacementPreview, R as RemotePresenceMarkupStroke, O as RemotePresencePeer, Q as RemotePresenceCamera, S as RealtimeConnectionState, D as VectorViewportHandle, V as VectorToolDefinition, E as VectorViewportProps, C as CanvasPlugin, d as CanvasPluginRenderContext } from './types-CTyASYIm.cjs';
+export { T as PresenceOverlayRenderContext } from './types-CTyASYIm.cjs';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { C as Camera2D } from './camera-BwQjm5oh.cjs';
 import { V as VectorSceneItem, R as Rect } from './types-CB0TZZuk.cjs';
 import { ReactNode, RefObject } from 'react';
-import { a as VectorCanvasRemoteAdapter } from './types-B58i5k-u.cjs';
-import './shape-builders-DxPoOecg.cjs';
+import { a as VectorCanvasRemoteAdapter } from './types-DNwjgs5U.cjs';
+import './shape-builders-DFudWDFI.cjs';
 
 /**
  * Maps a local {@link PlacementPreview} stroke to {@link RemotePresenceMarkupStroke} for broadcasting.
@@ -222,14 +222,27 @@ type BindViewportPresenceOptions = {
     activeTool?: string;
     viewportRef?: RefObject<VectorViewportHandle | null>;
 };
+type RealtimeSyncState = "connected" | "reconnecting" | "offline" | "conflicted";
+type RealtimeDocumentConflict = {
+    readonly serverRevision: number;
+    readonly serverItems: VectorSceneItem[];
+    readonly localItems: VectorSceneItem[];
+};
 type UseRealtimeSessionResult = {
     connection: RealtimeConnectionInfo;
     sessionPeers: RealtimeSessionPeer[];
     remotePresence: RealtimeSessionPeer[];
     remoteAdapter: VectorCanvasRemoteAdapter;
     document: RealtimeDocumentSnapshot | null;
+    hasLocalOfflineDraft: boolean;
+    hasPendingDocumentSync: boolean;
+    syncState: RealtimeSyncState;
+    conflict: RealtimeDocumentConflict | null;
     bindViewportPresence: (options?: BindViewportPresenceOptions) => RealtimeViewportPresenceBindings;
     syncViewportPresence: (options?: BindViewportPresenceOptions) => boolean;
+    resolveConflict: (action: "keep-local" | "use-server") => void;
+    clearLocalDraft: () => void;
+    flushDocumentSync: () => Promise<void>;
     disconnect: () => void;
     reconnectNow: () => void;
 };
@@ -312,6 +325,28 @@ type RealtimeSessionPluginOptions = RealtimeSessionPanelProps;
  */
 declare function realtimeSessionPlugin(options: RealtimeSessionPluginOptions): CanvasPlugin;
 
+type UseRealtimeCanvasDocumentOptions = {
+    session: Pick<UseRealtimeSessionResult, "connection" | "document" | "remoteAdapter" | "hasLocalOfflineDraft" | "hasPendingDocumentSync" | "syncState" | "conflict" | "resolveConflict" | "clearLocalDraft" | "flushDocumentSync"> | null;
+    items: readonly VectorSceneItem[];
+    onItemsChange?: (nextItems: VectorSceneItem[]) => void;
+    normalizeItems?: (nextItems: readonly VectorSceneItem[]) => VectorSceneItem[];
+    hydrateItems?: (nextItems: readonly VectorSceneItem[]) => Promise<VectorSceneItem[]>;
+    enabled?: boolean;
+};
+type UseRealtimeCanvasDocumentResult = {
+    items: readonly VectorSceneItem[];
+    onItemsChange?: (nextItems: VectorSceneItem[]) => void;
+    loading: boolean;
+    saving: boolean;
+    hasLocalOfflineDraft: boolean;
+    syncState: RealtimeSyncState;
+    conflict: RealtimeDocumentConflict | null;
+    resolveConflict: (action: "keep-local" | "use-server") => void;
+    clearLocalDraft: () => void;
+    flush: () => Promise<void>;
+};
+declare function useRealtimeCanvasDocument(options: UseRealtimeCanvasDocumentOptions): UseRealtimeCanvasDocumentResult;
+
 type UseRealtimePeerFollowOptions = {
     viewportRef: RefObject<VectorViewportHandle | null>;
     sessionPeers: RealtimeSessionPeer[];
@@ -320,4 +355,4 @@ type UseRealtimePeerFollowOptions = {
 };
 declare function useRealtimePeerFollow(options: UseRealtimePeerFollowOptions): void;
 
-export { PresenceRemoteLayer, type PresenceRemoteLayerProps, REALTIME_COMMENT_TOOL, type RealtimeClientMessage, type RealtimeCollaborationPluginOptions, type RealtimeCommentData, type RealtimeCommentsAuthor, RealtimeCommentsOverlay, type RealtimeCommentsOverlayProps, type RealtimeCommentsPluginOptions, type RealtimeCommentsViewportBindings, type RealtimeConnectionInfo, RealtimeConnectionState, type RealtimeDocumentSnapshot, type RealtimePresencePayload, type RealtimeServerMessage, RealtimeSessionPanel, type RealtimeSessionPanelProps, type RealtimeSessionPeer, type RealtimeSessionPluginOptions, type RealtimeViewportPresenceBindings, RemotePresenceCamera, RemotePresenceMarkupStroke, RemotePresencePeer, type UseRealtimeCommentsOptions, type UseRealtimeCommentsResult, type UseRealtimePeerFollowOptions, type UseRealtimeSessionOptions, type UseRealtimeSessionResult, createRealtimeCommentAvatarDataUrl, createRealtimeCommentDraftItem, createRealtimeCommentItem, defaultPresenceColorForId, getRealtimeCommentData, isRealtimeCommentDraftItem, isRealtimeCommentItem, parseRealtimeClientMessage, parseRealtimeServerMessage, realtimeCollaborationPlugin, realtimeCommentsPlugin, realtimeSessionPlugin, remoteMarkupStrokeFromPlacementPreview, useRealtimeComments, useRealtimePeerFollow, useRealtimeSession, withRealtimeCommentTool };
+export { PresenceRemoteLayer, type PresenceRemoteLayerProps, REALTIME_COMMENT_TOOL, type RealtimeClientMessage, type RealtimeCollaborationPluginOptions, type RealtimeCommentData, type RealtimeCommentsAuthor, RealtimeCommentsOverlay, type RealtimeCommentsOverlayProps, type RealtimeCommentsPluginOptions, type RealtimeCommentsViewportBindings, type RealtimeConnectionInfo, RealtimeConnectionState, type RealtimeDocumentConflict, type RealtimeDocumentSnapshot, type RealtimePresencePayload, type RealtimeServerMessage, RealtimeSessionPanel, type RealtimeSessionPanelProps, type RealtimeSessionPeer, type RealtimeSessionPluginOptions, type RealtimeSyncState, type RealtimeViewportPresenceBindings, RemotePresenceCamera, RemotePresenceMarkupStroke, RemotePresencePeer, type UseRealtimeCanvasDocumentResult, type UseRealtimeCommentsOptions, type UseRealtimeCommentsResult, type UseRealtimePeerFollowOptions, type UseRealtimeSessionOptions, type UseRealtimeSessionResult, createRealtimeCommentAvatarDataUrl, createRealtimeCommentDraftItem, createRealtimeCommentItem, defaultPresenceColorForId, getRealtimeCommentData, isRealtimeCommentDraftItem, isRealtimeCommentItem, parseRealtimeClientMessage, parseRealtimeServerMessage, realtimeCollaborationPlugin, realtimeCommentsPlugin, realtimeSessionPlugin, remoteMarkupStrokeFromPlacementPreview, useRealtimeCanvasDocument, useRealtimeComments, useRealtimePeerFollow, useRealtimeSession, withRealtimeCommentTool };

package/dist/realtime.d.ts

@@ -1,11 +1,11 @@
-import { P as PlacementPreview, X as RemotePresenceMarkupStroke, Y as RemotePresencePeer, Z as RemotePresenceCamera, _ as RealtimeConnectionState, J as VectorViewportHandle, b as VectorToolDefinition, K as VectorViewportProps, C as CanvasPlugin, f as CanvasPluginRenderContext } from './types-ChnTSRSe.js';
-export { $ as PresenceOverlayRenderContext } from './types-ChnTSRSe.js';
+import { P as PlacementPreview, R as RemotePresenceMarkupStroke, O as RemotePresencePeer, Q as RemotePresenceCamera, S as RealtimeConnectionState, D as VectorViewportHandle, V as VectorToolDefinition, E as VectorViewportProps, C as CanvasPlugin, d as CanvasPluginRenderContext } from './types-UvUy2Eed.js';
+export { T as PresenceOverlayRenderContext } from './types-UvUy2Eed.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { C as Camera2D } from './camera-KwCYYPhm.js';
 import { V as VectorSceneItem, R as Rect } from './types-CB0TZZuk.js';
 import { ReactNode, RefObject } from 'react';
-import { a as VectorCanvasRemoteAdapter } from './types-DgEArHkA.js';
-import './shape-builders-DTYvub8W.js';
+import { a as VectorCanvasRemoteAdapter } from './types-BtAJFS_-.js';
+import './shape-builders-ENwnK-zT.js';
 
 /**
  * Maps a local {@link PlacementPreview} stroke to {@link RemotePresenceMarkupStroke} for broadcasting.
@@ -222,14 +222,27 @@ type BindViewportPresenceOptions = {
     activeTool?: string;
     viewportRef?: RefObject<VectorViewportHandle | null>;
 };
+type RealtimeSyncState = "connected" | "reconnecting" | "offline" | "conflicted";
+type RealtimeDocumentConflict = {
+    readonly serverRevision: number;
+    readonly serverItems: VectorSceneItem[];
+    readonly localItems: VectorSceneItem[];
+};
 type UseRealtimeSessionResult = {
     connection: RealtimeConnectionInfo;
     sessionPeers: RealtimeSessionPeer[];
     remotePresence: RealtimeSessionPeer[];
     remoteAdapter: VectorCanvasRemoteAdapter;
     document: RealtimeDocumentSnapshot | null;
+    hasLocalOfflineDraft: boolean;
+    hasPendingDocumentSync: boolean;
+    syncState: RealtimeSyncState;
+    conflict: RealtimeDocumentConflict | null;
     bindViewportPresence: (options?: BindViewportPresenceOptions) => RealtimeViewportPresenceBindings;
     syncViewportPresence: (options?: BindViewportPresenceOptions) => boolean;
+    resolveConflict: (action: "keep-local" | "use-server") => void;
+    clearLocalDraft: () => void;
+    flushDocumentSync: () => Promise<void>;
     disconnect: () => void;
     reconnectNow: () => void;
 };
@@ -312,6 +325,28 @@ type RealtimeSessionPluginOptions = RealtimeSessionPanelProps;
  */
 declare function realtimeSessionPlugin(options: RealtimeSessionPluginOptions): CanvasPlugin;
 
+type UseRealtimeCanvasDocumentOptions = {
+    session: Pick<UseRealtimeSessionResult, "connection" | "document" | "remoteAdapter" | "hasLocalOfflineDraft" | "hasPendingDocumentSync" | "syncState" | "conflict" | "resolveConflict" | "clearLocalDraft" | "flushDocumentSync"> | null;
+    items: readonly VectorSceneItem[];
+    onItemsChange?: (nextItems: VectorSceneItem[]) => void;
+    normalizeItems?: (nextItems: readonly VectorSceneItem[]) => VectorSceneItem[];
+    hydrateItems?: (nextItems: readonly VectorSceneItem[]) => Promise<VectorSceneItem[]>;
+    enabled?: boolean;
+};
+type UseRealtimeCanvasDocumentResult = {
+    items: readonly VectorSceneItem[];
+    onItemsChange?: (nextItems: VectorSceneItem[]) => void;
+    loading: boolean;
+    saving: boolean;
+    hasLocalOfflineDraft: boolean;
+    syncState: RealtimeSyncState;
+    conflict: RealtimeDocumentConflict | null;
+    resolveConflict: (action: "keep-local" | "use-server") => void;
+    clearLocalDraft: () => void;
+    flush: () => Promise<void>;
+};
+declare function useRealtimeCanvasDocument(options: UseRealtimeCanvasDocumentOptions): UseRealtimeCanvasDocumentResult;
+
 type UseRealtimePeerFollowOptions = {
     viewportRef: RefObject<VectorViewportHandle | null>;
     sessionPeers: RealtimeSessionPeer[];
@@ -320,4 +355,4 @@ type UseRealtimePeerFollowOptions = {
 };
 declare function useRealtimePeerFollow(options: UseRealtimePeerFollowOptions): void;
 
-export { PresenceRemoteLayer, type PresenceRemoteLayerProps, REALTIME_COMMENT_TOOL, type RealtimeClientMessage, type RealtimeCollaborationPluginOptions, type RealtimeCommentData, type RealtimeCommentsAuthor, RealtimeCommentsOverlay, type RealtimeCommentsOverlayProps, type RealtimeCommentsPluginOptions, type RealtimeCommentsViewportBindings, type RealtimeConnectionInfo, RealtimeConnectionState, type RealtimeDocumentSnapshot, type RealtimePresencePayload, type RealtimeServerMessage, RealtimeSessionPanel, type RealtimeSessionPanelProps, type RealtimeSessionPeer, type RealtimeSessionPluginOptions, type RealtimeViewportPresenceBindings, RemotePresenceCamera, RemotePresenceMarkupStroke, RemotePresencePeer, type UseRealtimeCommentsOptions, type UseRealtimeCommentsResult, type UseRealtimePeerFollowOptions, type UseRealtimeSessionOptions, type UseRealtimeSessionResult, createRealtimeCommentAvatarDataUrl, createRealtimeCommentDraftItem, createRealtimeCommentItem, defaultPresenceColorForId, getRealtimeCommentData, isRealtimeCommentDraftItem, isRealtimeCommentItem, parseRealtimeClientMessage, parseRealtimeServerMessage, realtimeCollaborationPlugin, realtimeCommentsPlugin, realtimeSessionPlugin, remoteMarkupStrokeFromPlacementPreview, useRealtimeComments, useRealtimePeerFollow, useRealtimeSession, withRealtimeCommentTool };
+export { PresenceRemoteLayer, type PresenceRemoteLayerProps, REALTIME_COMMENT_TOOL, type RealtimeClientMessage, type RealtimeCollaborationPluginOptions, type RealtimeCommentData, type RealtimeCommentsAuthor, RealtimeCommentsOverlay, type RealtimeCommentsOverlayProps, type RealtimeCommentsPluginOptions, type RealtimeCommentsViewportBindings, type RealtimeConnectionInfo, RealtimeConnectionState, type RealtimeDocumentConflict, type RealtimeDocumentSnapshot, type RealtimePresencePayload, type RealtimeServerMessage, RealtimeSessionPanel, type RealtimeSessionPanelProps, type RealtimeSessionPeer, type RealtimeSessionPluginOptions, type RealtimeSyncState, type RealtimeViewportPresenceBindings, RemotePresenceCamera, RemotePresenceMarkupStroke, RemotePresencePeer, type UseRealtimeCanvasDocumentResult, type UseRealtimeCommentsOptions, type UseRealtimeCommentsResult, type UseRealtimePeerFollowOptions, type UseRealtimeSessionOptions, type UseRealtimeSessionResult, createRealtimeCommentAvatarDataUrl, createRealtimeCommentDraftItem, createRealtimeCommentItem, defaultPresenceColorForId, getRealtimeCommentData, isRealtimeCommentDraftItem, isRealtimeCommentItem, parseRealtimeClientMessage, parseRealtimeServerMessage, realtimeCollaborationPlugin, realtimeCommentsPlugin, realtimeSessionPlugin, remoteMarkupStrokeFromPlacementPreview, useRealtimeCanvasDocument, useRealtimeComments, useRealtimePeerFollow, useRealtimeSession, withRealtimeCommentTool };