canvu-react 0.4.33 → 0.4.34

package/dist/realtimeNative.d.cts

@@ -0,0 +1,255 @@
+import { a as RemotePresenceMarkupStroke, b as RemotePresenceCamera, c as RealtimeConnectionState, R as RemotePresencePeer } from './types-BQUbxMgz.cjs';
+import { V as VectorSceneItem } from './types-BCCvY6ie.cjs';
+import { RefObject } from 'react';
+import { a as VectorCanvasRemoteAdapter } from './types-BUPc2Zgw.cjs';
+import { S as StrokeStyle } from './shape-builders-CKEMjivV.cjs';
+
+type RealtimeSessionPeer = RemotePresencePeer & {
+    readonly clientId: string;
+    readonly peerId: string;
+    readonly roomId: string;
+    readonly joinedAt: number;
+    readonly lastSeenAt: number;
+    readonly isSelf: boolean;
+    readonly connectionState?: RealtimeConnectionState;
+};
+type RealtimeDocumentSnapshot = {
+    readonly revision: number;
+    readonly items: VectorSceneItem[];
+    readonly updatedAt: number;
+    readonly updatedByClientId?: string;
+    readonly persistedRevision?: number;
+};
+type RealtimeConnectionInfo = {
+    readonly state: RealtimeConnectionState;
+    readonly connected: boolean;
+    readonly roomId: string;
+    readonly clientId: string | null;
+    readonly retryCount: number;
+    readonly lastConnectedAt: number | null;
+    readonly lastMessageAt: number | null;
+    readonly lastPongAt: number | null;
+    readonly lastError: string | null;
+};
+type RealtimePresencePayload = {
+    readonly cursor: {
+        readonly x: number;
+        readonly y: number;
+    } | null;
+    readonly markupStroke?: RemotePresenceMarkupStroke | null;
+    readonly camera?: RemotePresenceCamera | null;
+    readonly activeTool?: string;
+};
+type RealtimeClientPeer = {
+    readonly clientId: string;
+    readonly peerId: string;
+    readonly displayName?: string;
+    readonly color?: string;
+    readonly image?: string;
+};
+type RealtimeClientMessage = {
+    readonly type: "session:join";
+    readonly roomId: string;
+    readonly peer: RealtimeClientPeer;
+} | {
+    readonly type: "session:leave";
+    readonly roomId: string;
+    readonly clientId: string;
+} | {
+    readonly type: "session:ping";
+    readonly roomId: string;
+    readonly clientId: string;
+    readonly sentAt: number;
+} | {
+    readonly type: "presence:update";
+    readonly roomId: string;
+    readonly clientId: string;
+    readonly presence: RealtimePresencePayload;
+} | {
+    readonly type: "document:update";
+    readonly roomId: string;
+    readonly clientId: string;
+    readonly baseRevision: number;
+    readonly items: VectorSceneItem[];
+};
+type RealtimeServerMessage = {
+    readonly type: "session:welcome";
+    readonly roomId: string;
+    readonly clientId: string;
+    readonly serverTime: number;
+    readonly document: RealtimeDocumentSnapshot;
+    readonly peers: RealtimeSessionPeer[];
+} | {
+    readonly type: "session:peer-joined";
+    readonly roomId: string;
+    readonly peer: RealtimeSessionPeer;
+} | {
+    readonly type: "session:peer-left";
+    readonly roomId: string;
+    readonly clientId: string;
+} | {
+    readonly type: "session:pong";
+    readonly roomId: string;
+    readonly clientId: string;
+    readonly sentAt: number;
+    readonly serverTime: number;
+} | {
+    readonly type: "session:error";
+    readonly roomId?: string;
+    readonly code: string;
+    readonly message: string;
+} | {
+    readonly type: "presence:sync";
+    readonly roomId: string;
+    readonly peers: RealtimeSessionPeer[];
+    readonly serverTime: number;
+} | {
+    readonly type: "document:sync";
+    readonly roomId: string;
+    readonly document: RealtimeDocumentSnapshot;
+} | {
+    readonly type: "document:resync-required";
+    readonly roomId: string;
+    readonly reason: string;
+    readonly document: RealtimeDocumentSnapshot;
+};
+declare function parseRealtimeClientMessage(value: unknown): RealtimeClientMessage | undefined;
+declare function parseRealtimeServerMessage(value: unknown): RealtimeServerMessage | undefined;
+
+type RealtimeSessionPeerInput = {
+    id: string;
+    displayName?: string;
+    color?: string;
+    image?: string;
+    clientId?: string;
+};
+type UseRealtimeSessionOptions = {
+    url: string;
+    roomId: string;
+    peer: RealtimeSessionPeerInput;
+    enabled?: boolean;
+    draftStorage?: RealtimeDraftStorage | null;
+    reconnect?: boolean;
+    heartbeatMs?: number;
+    maxReconnectDelayMs?: number;
+    initialReconnectDelayMs?: number;
+    connectTimeoutMs?: number;
+    onError?: (message: string) => void;
+};
+type RealtimeDraftStorage = {
+    getItem: (key: string) => string | null | Promise<string | null>;
+    setItem: (key: string, value: string) => void | Promise<void>;
+    removeItem: (key: string) => void | Promise<void>;
+};
+type RealtimeViewportCamera = {
+    x: number;
+    y: number;
+    zoom: number;
+};
+type RealtimeViewportHandle = {
+    getCamera: () => RealtimeViewportCamera | null;
+    requestRender: () => void;
+    getViewportSize: () => {
+        width: number;
+        height: number;
+    };
+};
+type RealtimePlacementPreview = {
+    readonly kind: "rect" | "ellipse" | "architectural-cloud" | "marquee";
+    readonly rect: {
+        readonly x: number;
+        readonly y: number;
+        readonly width: number;
+        readonly height: number;
+    };
+} | {
+    readonly kind: "line" | "arrow";
+    readonly start: {
+        readonly x: number;
+        readonly y: number;
+    };
+    readonly end: {
+        readonly x: number;
+        readonly y: number;
+    };
+} | {
+    readonly kind: "stroke";
+    readonly tool: "draw" | "marker" | "laser";
+    readonly points: readonly {
+        readonly x: number;
+        readonly y: number;
+    }[];
+    readonly style?: StrokeStyle;
+};
+type RealtimeViewportPresenceBindings = {
+    remotePresence: RealtimeSessionPeer[];
+    onWorldPointerMove: (world: {
+        readonly x: number;
+        readonly y: number;
+    }) => void;
+    onWorldPointerLeave: () => void;
+    onPlacementPreviewChange: (preview: RealtimePlacementPreview | null) => void;
+    onCameraChange: () => void;
+};
+type BindViewportPresenceOptions = {
+    activeTool?: string;
+    viewportRef?: RefObject<RealtimeViewportHandle | 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;
+};
+declare function createBrowserDraftStorage(): RealtimeDraftStorage | null;
+declare function useRealtimeSession(options: UseRealtimeSessionOptions): UseRealtimeSessionResult;
+
+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<RealtimeViewportHandle | null>;
+    sessionPeers: RealtimeSessionPeer[];
+    followedPeerId: string | null | undefined;
+    onFollowEnd?: () => void;
+};
+declare function useRealtimePeerFollow(options: UseRealtimePeerFollowOptions): void;
+
+export { type RealtimeClientMessage, type RealtimeConnectionInfo, type RealtimeDocumentConflict, type RealtimeDocumentSnapshot, type RealtimeDraftStorage, type RealtimePlacementPreview, type RealtimePresencePayload, type RealtimeServerMessage, type RealtimeSessionPeer, type RealtimeSyncState, type RealtimeViewportHandle, type RealtimeViewportPresenceBindings, type UseRealtimeCanvasDocumentResult, type UseRealtimePeerFollowOptions, type UseRealtimeSessionOptions, type UseRealtimeSessionResult, createBrowserDraftStorage, parseRealtimeClientMessage, parseRealtimeServerMessage, useRealtimeCanvasDocument, useRealtimePeerFollow, useRealtimeSession };

package/dist/realtimeNative.d.ts

@@ -0,0 +1,255 @@
+import { a as RemotePresenceMarkupStroke, b as RemotePresenceCamera, c as RealtimeConnectionState, R as RemotePresencePeer } from './types-B82WiQQh.js';
+import { V as VectorSceneItem } from './types-BCCvY6ie.js';
+import { RefObject } from 'react';
+import { a as VectorCanvasRemoteAdapter } from './types-CYtq9Pr9.js';
+import { S as StrokeStyle } from './shape-builders-Cyh8zvDG.js';
+
+type RealtimeSessionPeer = RemotePresencePeer & {
+    readonly clientId: string;
+    readonly peerId: string;
+    readonly roomId: string;
+    readonly joinedAt: number;
+    readonly lastSeenAt: number;
+    readonly isSelf: boolean;
+    readonly connectionState?: RealtimeConnectionState;
+};
+type RealtimeDocumentSnapshot = {
+    readonly revision: number;
+    readonly items: VectorSceneItem[];
+    readonly updatedAt: number;
+    readonly updatedByClientId?: string;
+    readonly persistedRevision?: number;
+};
+type RealtimeConnectionInfo = {
+    readonly state: RealtimeConnectionState;
+    readonly connected: boolean;
+    readonly roomId: string;
+    readonly clientId: string | null;
+    readonly retryCount: number;
+    readonly lastConnectedAt: number | null;
+    readonly lastMessageAt: number | null;
+    readonly lastPongAt: number | null;
+    readonly lastError: string | null;
+};
+type RealtimePresencePayload = {
+    readonly cursor: {
+        readonly x: number;
+        readonly y: number;
+    } | null;
+    readonly markupStroke?: RemotePresenceMarkupStroke | null;
+    readonly camera?: RemotePresenceCamera | null;
+    readonly activeTool?: string;
+};
+type RealtimeClientPeer = {
+    readonly clientId: string;
+    readonly peerId: string;
+    readonly displayName?: string;
+    readonly color?: string;
+    readonly image?: string;
+};
+type RealtimeClientMessage = {
+    readonly type: "session:join";
+    readonly roomId: string;
+    readonly peer: RealtimeClientPeer;
+} | {
+    readonly type: "session:leave";
+    readonly roomId: string;
+    readonly clientId: string;
+} | {
+    readonly type: "session:ping";
+    readonly roomId: string;
+    readonly clientId: string;
+    readonly sentAt: number;
+} | {
+    readonly type: "presence:update";
+    readonly roomId: string;
+    readonly clientId: string;
+    readonly presence: RealtimePresencePayload;
+} | {
+    readonly type: "document:update";
+    readonly roomId: string;
+    readonly clientId: string;
+    readonly baseRevision: number;
+    readonly items: VectorSceneItem[];
+};
+type RealtimeServerMessage = {
+    readonly type: "session:welcome";
+    readonly roomId: string;
+    readonly clientId: string;
+    readonly serverTime: number;
+    readonly document: RealtimeDocumentSnapshot;
+    readonly peers: RealtimeSessionPeer[];
+} | {
+    readonly type: "session:peer-joined";
+    readonly roomId: string;
+    readonly peer: RealtimeSessionPeer;
+} | {
+    readonly type: "session:peer-left";
+    readonly roomId: string;
+    readonly clientId: string;
+} | {
+    readonly type: "session:pong";
+    readonly roomId: string;
+    readonly clientId: string;
+    readonly sentAt: number;
+    readonly serverTime: number;
+} | {
+    readonly type: "session:error";
+    readonly roomId?: string;
+    readonly code: string;
+    readonly message: string;
+} | {
+    readonly type: "presence:sync";
+    readonly roomId: string;
+    readonly peers: RealtimeSessionPeer[];
+    readonly serverTime: number;
+} | {
+    readonly type: "document:sync";
+    readonly roomId: string;
+    readonly document: RealtimeDocumentSnapshot;
+} | {
+    readonly type: "document:resync-required";
+    readonly roomId: string;
+    readonly reason: string;
+    readonly document: RealtimeDocumentSnapshot;
+};
+declare function parseRealtimeClientMessage(value: unknown): RealtimeClientMessage | undefined;
+declare function parseRealtimeServerMessage(value: unknown): RealtimeServerMessage | undefined;
+
+type RealtimeSessionPeerInput = {
+    id: string;
+    displayName?: string;
+    color?: string;
+    image?: string;
+    clientId?: string;
+};
+type UseRealtimeSessionOptions = {
+    url: string;
+    roomId: string;
+    peer: RealtimeSessionPeerInput;
+    enabled?: boolean;
+    draftStorage?: RealtimeDraftStorage | null;
+    reconnect?: boolean;
+    heartbeatMs?: number;
+    maxReconnectDelayMs?: number;
+    initialReconnectDelayMs?: number;
+    connectTimeoutMs?: number;
+    onError?: (message: string) => void;
+};
+type RealtimeDraftStorage = {
+    getItem: (key: string) => string | null | Promise<string | null>;
+    setItem: (key: string, value: string) => void | Promise<void>;
+    removeItem: (key: string) => void | Promise<void>;
+};
+type RealtimeViewportCamera = {
+    x: number;
+    y: number;
+    zoom: number;
+};
+type RealtimeViewportHandle = {
+    getCamera: () => RealtimeViewportCamera | null;
+    requestRender: () => void;
+    getViewportSize: () => {
+        width: number;
+        height: number;
+    };
+};
+type RealtimePlacementPreview = {
+    readonly kind: "rect" | "ellipse" | "architectural-cloud" | "marquee";
+    readonly rect: {
+        readonly x: number;
+        readonly y: number;
+        readonly width: number;
+        readonly height: number;
+    };
+} | {
+    readonly kind: "line" | "arrow";
+    readonly start: {
+        readonly x: number;
+        readonly y: number;
+    };
+    readonly end: {
+        readonly x: number;
+        readonly y: number;
+    };
+} | {
+    readonly kind: "stroke";
+    readonly tool: "draw" | "marker" | "laser";
+    readonly points: readonly {
+        readonly x: number;
+        readonly y: number;
+    }[];
+    readonly style?: StrokeStyle;
+};
+type RealtimeViewportPresenceBindings = {
+    remotePresence: RealtimeSessionPeer[];
+    onWorldPointerMove: (world: {
+        readonly x: number;
+        readonly y: number;
+    }) => void;
+    onWorldPointerLeave: () => void;
+    onPlacementPreviewChange: (preview: RealtimePlacementPreview | null) => void;
+    onCameraChange: () => void;
+};
+type BindViewportPresenceOptions = {
+    activeTool?: string;
+    viewportRef?: RefObject<RealtimeViewportHandle | 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;
+};
+declare function createBrowserDraftStorage(): RealtimeDraftStorage | null;
+declare function useRealtimeSession(options: UseRealtimeSessionOptions): UseRealtimeSessionResult;
+
+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<RealtimeViewportHandle | null>;
+    sessionPeers: RealtimeSessionPeer[];
+    followedPeerId: string | null | undefined;
+    onFollowEnd?: () => void;
+};
+declare function useRealtimePeerFollow(options: UseRealtimePeerFollowOptions): void;
+
+export { type RealtimeClientMessage, type RealtimeConnectionInfo, type RealtimeDocumentConflict, type RealtimeDocumentSnapshot, type RealtimeDraftStorage, type RealtimePlacementPreview, type RealtimePresencePayload, type RealtimeServerMessage, type RealtimeSessionPeer, type RealtimeSyncState, type RealtimeViewportHandle, type RealtimeViewportPresenceBindings, type UseRealtimeCanvasDocumentResult, type UseRealtimePeerFollowOptions, type UseRealtimeSessionOptions, type UseRealtimeSessionResult, createBrowserDraftStorage, parseRealtimeClientMessage, parseRealtimeServerMessage, useRealtimeCanvasDocument, useRealtimePeerFollow, useRealtimeSession };