@scrawl-board/board 0.1.0-beta.10 → 0.1.0-beta.11

package/dist/react.d.ts

@@ -1323,6 +1323,13 @@ interface BoardSnapshot {
     readonly readOnly: boolean;
     readonly selection: readonly string[];
     readonly focusedItem: FocusedItem | null;
+    /**
+     * What an inline editor currently covers, as last set through
+     * `view.setInlineEditing` — a text block (`{ id }`) or a table cell
+     * (`{ id, row, col }`), else null. Chrome uses it to stay out of an open
+     * editor's way.
+     */
+    readonly inlineEditing: InlineEditingTarget | null;
     readonly strokeCount: number;
     readonly objectCount: number;
     readonly canUndo: boolean;
@@ -1346,6 +1353,18 @@ interface BoardSnapshot {
  * shape doesn't carry a holder name, so it always reports `locked: false`
  * here, matching the engine's own internal selection-badge behavior.
  */
+/** Axis-aligned bounds in board space (y up). */
+interface BoardBounds {
+    readonly minX: number;
+    readonly minY: number;
+    readonly maxX: number;
+    readonly maxY: number;
+}
+interface InlineEditingTarget {
+    readonly id: string;
+    readonly row?: number;
+    readonly col?: number;
+}
 interface FocusedItem {
     readonly type: "stroke" | "note" | "text" | "table" | "image" | "timer" | "rectangle" | "ellipse" | "group" | "line" | "arrow" | "polygon" | "star" | "heart" | "custom";
     readonly id: string;
@@ -2138,10 +2157,14 @@ interface BoardController {
         get(id: string): DeepReadonly<BoardObject> | undefined;
         all(): readonly DeepReadonly<BoardObject>[];
         search(query: string): readonly SearchHit[];
+        /** An object's axis-aligned board-space bounds (y up), or undefined for an unknown id. */
+        bounds(id: string): BoardBounds | undefined;
     };
     /** Host-owned comments, synced in for search and marker rendering only — see CommentMarker. */
     readonly comments: {
         sync(comments: readonly CommentMarker[]): void;
+        /** The markers last passed to `sync`, in the order given. */
+        list(): readonly CommentMarker[];
         open(id: string): void;
         setActive(id: string | null): void;
     };
@@ -2311,6 +2334,62 @@ declare const scrawlThemePresets: Readonly<Record<ScrawlThemePreset, Readonly<Re
 declare function validateScrawlTheme(theme: ScrawlTheme | Record<string, unknown>): ScrawlThemeDiagnostic[];
 declare function resolveScrawlTheme(preset?: ScrawlThemePreset, theme?: ScrawlTheme | Record<string, unknown>): ScrawlResolvedTheme;
 
+/** Access levels, shown as View / Edit / Admin. Map your backend's roles onto these. */
+type BoardRole = "viewer" | "editor" | "admin";
+interface BoardMember {
+    id: string;
+    name: string;
+    email?: string;
+    avatarUrl?: string;
+    online?: boolean;
+    role: BoardRole;
+}
+interface BoardRoleChange {
+    memberId: string;
+    role: BoardRole;
+}
+interface BoardPermissions {
+    members: readonly BoardMember[];
+    /** Marks "(you)" and keeps your own access level from being changed here. */
+    currentUserId?: string;
+    /** Whether "Manage permissions" is offered at all — your rule, from your backend. */
+    canManage: boolean;
+    /**
+     * Called with every pending change when Save is pressed. Resolve once your
+     * backend accepted them; reject to show the error and keep them pending.
+     * Nothing changes until your backend says so — update `members` afterwards.
+     */
+    onSave(changes: readonly BoardRoleChange[]): Promise<void>;
+}
+type BoardActivityKind = "added" | "removed" | "updated" | "commented" | "shared" | "exported";
+interface BoardActivityEntry {
+    id: string;
+    kind: BoardActivityKind;
+    /** e.g. "Added a sticky note". */
+    title: string;
+    actorName?: string;
+    /** When it happened (ms since epoch or ISO string). */
+    at: number | string;
+    /** Board point to jump to, if the action has a place on the board. */
+    location?: BoardPoint;
+}
+interface BoardActivityFeed {
+    /** Newest first. Omit to show this session's own actions instead. */
+    entries?: readonly BoardActivityEntry[];
+    unreadCount?: number;
+    onMarkAllRead?(): void;
+}
+interface BoardCommentFeed {
+    unreadCount?: number;
+    onMarkAllRead?(): void;
+}
+interface BoardMenuItem {
+    id: string;
+    label: string;
+    icon?: ReactNode;
+    onSelect(): void;
+}
+
 interface CommentAuthor {
     name: string;
     color?: string;
@@ -2331,6 +2410,26 @@ interface DefaultBoardChromeProps {
     icons?: Partial<Record<BuiltInTool, ReactNode>>;
     /** Name (and pin colour) shown on comments left through the default comment UI. Defaults to "You". */
     commentAuthor?: CommentAuthor;
+    /**
+     * Sharing is the Host's own (links, permissions, backends), so the board
+     * actions only offer a Share button when this is supplied.
+     */
+    onShare?(): void;
+    /**
+     * Your backend's activity feed for the Recent Activity drawer. Without
+     * `entries`, the drawer lists this session's own board actions.
+     */
+    activity?: BoardActivityFeed;
+    /** Unread state for the Comments drawer's badge and "Mark all as read". */
+    commentFeed?: BoardCommentFeed;
+    /**
+     * Members and access levels from your backend, for the permissions drawer
+     * (offered in the More menu when `canManage`). The SDK never changes a role
+     * itself: Save calls `onSave`, and your backend decides.
+     */
+    permissions?: BoardPermissions;
+    /** Extra More-menu actions your app provides (board settings, version history, duplicate…). */
+    menuItems?: readonly BoardMenuItem[];
 }
 
 /**
@@ -2339,7 +2438,7 @@ interface DefaultBoardChromeProps {
  * Turn either off when the Host handles `comment-draft-request`/
  * `comment-open-request` or `import-request` itself.
  */
-type DefaultUIRegion = "tools" | "history" | "view" | "style" | "search" | "import" | "export" | "inlineEditing" | "styleShelf" | "focusedItemToolbar" | "emptyState" | "pages" | "comments" | "images";
+type DefaultUIRegion = "tools" | "history" | "view" | "style" | "search" | "import" | "export" | "inlineEditing" | "styleShelf" | "focusedItemToolbar" | "emptyState" | "pages" | "comments" | "images" | "activity";
 /** Props for the toolbar/topBar/stylePanel/contextMenu slots. */
 interface BoardSlotProps {
     controller: BoardController;
@@ -2367,7 +2466,7 @@ interface DefaultUISlots {
      */
     contextMenu?: ComponentType<BoardSlotProps> | null;
 }
-declare function DefaultBoardChrome({ controller, snapshot, renderPortal, className, style, regions, slots, icons, commentAuthor }: DefaultBoardChromeProps): react.JSX.Element;
+declare function DefaultBoardChrome({ controller, snapshot, renderPortal, className, style, regions, slots, icons, commentAuthor, onShare, activity, commentFeed, permissions, menuItems }: DefaultBoardChromeProps): react.JSX.Element;
 
 interface InlineEditorsProps {
     controller: BoardController;
@@ -2400,9 +2499,11 @@ interface FocusedItemToolbarProps {
  * Floating toolbar above the focused note, shape, text block, or semantic
  * Rectangle/Ellipse — Colour, Size (note/text) or Width (shape), Fill/Stroke
  * (Rectangle/Ellipse), Lock/Unlock, Duplicate, Delete. Images (photos and
- * placed emoji/icons) get Lock/Duplicate/Delete only — the native gizmo
- * already resizes them. Table/timer/custom objects and plain (non-shape) ink
- * strokes never get a toolbar here — out of scope for this destination.
+ * placed emoji/icons) and tables get Lock/Duplicate/Delete only — each
+ * already has its own resize affordance (the native gizmo for images, edge
+ * handles for tables), and a table's row/column actions live in its cell
+ * editor. Timer/custom objects and plain (non-shape) ink strokes never get a
+ * toolbar here — out of scope for this destination.
  *
  * Rectangle/Ellipse (Phase 2) are a second, parallel "shape" concept from
  * the legacy ink-stroke shape below: both draw from the same toolbar
@@ -2496,6 +2597,16 @@ interface ScrawlProps extends Omit<CreateBoardControllerOptions, "canvas"> {
      * SDK's default UI). See DefaultBoardChromeProps.icons.
      */
     icons?: Partial<Record<BuiltInTool, ReactNode>>;
+    /** Offer a Share button in the default UI's board actions — see DefaultBoardChromeProps.onShare. */
+    onShare?(): void;
+    /** Your backend's activity feed — see DefaultBoardChromeProps.activity. */
+    activity?: BoardActivityFeed;
+    /** Unread state for the Comments drawer — see DefaultBoardChromeProps.commentFeed. */
+    commentFeed?: BoardCommentFeed;
+    /** Members and access levels from your backend — see DefaultBoardChromeProps.permissions. */
+    permissions?: BoardPermissions;
+    /** Extra More-menu actions — see DefaultBoardChromeProps.menuItems. */
+    menuItems?: readonly BoardMenuItem[];
 }
 /**
  * The fastest path to an embedded Board: creates and owns a
@@ -2508,7 +2619,7 @@ interface ScrawlProps extends Omit<CreateBoardControllerOptions, "canvas"> {
  * field except `canvas` (pass `canvas={null}` for a headless board, or an
  * existing `<canvas>` element to control its identity yourself).
  */
-declare function Scrawl({ children, preset, theme, portalContainer, className, style, onReady, onError, onThemeDiagnostic, canvas: suppliedCanvas, icons, ...options }: ScrawlProps): react.JSX.Element;
+declare function Scrawl({ children, preset, theme, portalContainer, className, style, onReady, onError, onThemeDiagnostic, canvas: suppliedCanvas, icons, onShare, activity, commentFeed, permissions, menuItems, ...options }: ScrawlProps): react.JSX.Element;
 interface ScrawlCanvasProps {
     element?: HTMLCanvasElement;
     className?: string;
@@ -2527,8 +2638,18 @@ interface ScrawlDefaultUIProps {
     icons?: Partial<Record<BuiltInTool, ReactNode>>;
     /** Author shown on comments left through the default comment UI — see DefaultBoardChromeProps.commentAuthor. */
     commentAuthor?: CommentAuthor;
-}
-declare function ScrawlDefaultUI({ className, style, regions, slots, icons, commentAuthor }: ScrawlDefaultUIProps): react.JSX.Element;
+    /** Supply to offer a Share button in the board actions — see DefaultBoardChromeProps.onShare. */
+    onShare?(): void;
+    /** Your backend's activity feed — see DefaultBoardChromeProps.activity. */
+    activity?: BoardActivityFeed;
+    /** Unread state for the Comments drawer — see DefaultBoardChromeProps.commentFeed. */
+    commentFeed?: BoardCommentFeed;
+    /** Members and access levels from your backend — see DefaultBoardChromeProps.permissions. */
+    permissions?: BoardPermissions;
+    /** Extra More-menu actions — see DefaultBoardChromeProps.menuItems. */
+    menuItems?: readonly BoardMenuItem[];
+}
+declare function ScrawlDefaultUI({ className, style, regions, slots, icons, commentAuthor, onShare, activity, commentFeed, permissions, menuItems }: ScrawlDefaultUIProps): react.JSX.Element;
 declare function ScrawlPortal({ children }: {
     children: ReactNode;
 }): react.ReactPortal | null;
@@ -2578,4 +2699,4 @@ type ScrawlBoardProps = {
 declare function ScrawlBoard({ documentId, initialDocument, onReady, className, style }: ScrawlBoardProps): react.JSX.Element;
 
 export { AssetResolutionError, DefaultBoardChrome, FocusedItemToolbar, InlineEditors, MultiplayerCursors, SUPPORTED_ASSET_MEDIA_TYPES, Scrawl, ScrawlBoard, ScrawlCanvas, ScrawlDefaultUI, ScrawlPortal, ScrawlProvider, StyleShelf, assetRef, clampAssetCacheBytes, cloneCustomObject, isAssetRef, resolveScrawlTheme, scrawlThemePresets, useCollaborationStatus, usePersistenceStatus, usePresence, useScrawlController, useScrawlSnapshot, useScrawlTheme, validateScrawlTheme };
-export type { AssetDiagnostic, AssetExportFailure, AssetIngestRequest, AssetIngestResult, AssetIngestor, AssetKind, AssetPurpose, AssetRef, AssetResolutionErrorCode, AssetResolveRequest, AssetResolveResult, AssetResolver, BoardController, BoardKeyInput, BoardNotebook, BoardPage, BoardPointerInput, BoardScene, BoardSection, BoardSlotProps, BoardSnapshot, BoardStyle, BoardThemeOptions, CollaborationSnapshot, CommentAuthor, CommentMarker, CreateBoardControllerOptions, CustomBoardObject, CustomObjectAddInput, CustomObjectDefinition, CustomTool, CustomToolDefinition, DefaultBoardChromeProps, DefaultUIRegion, DefaultUISlot, DefaultUISlots, DialogSlotProps, ExportDocumentSVGOptions, ExportDocumentSVGResult, ExtensionCommand, ExtensionDiagnostic, ExtensionHitResult, ExtensionId, ExtensionRequirement, FocusedItem, FocusedItemToolbarProps, InlineEditorsProps, InputModifiers, JsonObject, JsonValue, LocalBoard, LocalBoardSnapshot, LocalPresence, Mat2x3, MultiplayerCursorsProps, ObjectDescribeContext, ObjectIntent, ObjectType, PresenceCursor, PresenceUser, PresenceView, QueryableBoardObject, ReadonlyCustomObject, SceneEllipse, SceneGroup, SceneImage, ScenePath, SceneRect, SceneText, ScrawlBoardProps, ScrawlCanvasProps, ScrawlDefaultUIProps, ScrawlDensity, ScrawlExtension, ScrawlGridMode, ScrawlProps, ScrawlProviderProps, ScrawlResolvedTheme, ScrawlSurfaceTexture, ScrawlTheme, ScrawlThemeDiagnostic, ScrawlThemePreset, SearchHit, SearchHitKind, SearchableComment, StyleShelfProps, SupportedAssetMediaType, ToolCancelReason, ToolCapabilities, ToolCursor, ToolId };
+export type { AssetDiagnostic, AssetExportFailure, AssetIngestRequest, AssetIngestResult, AssetIngestor, AssetKind, AssetPurpose, AssetRef, AssetResolutionErrorCode, AssetResolveRequest, AssetResolveResult, AssetResolver, BoardActivityEntry, BoardActivityFeed, BoardActivityKind, BoardBounds, BoardCommentFeed, BoardController, BoardKeyInput, BoardMember, BoardMenuItem, BoardNotebook, BoardPage, BoardPermissions, BoardPoint, BoardPointerInput, BoardRole, BoardRoleChange, BoardScene, BoardSection, BoardSlotProps, BoardSnapshot, BoardStyle, BoardThemeOptions, CollaborationSnapshot, CommentAuthor, CommentMarker, CreateBoardControllerOptions, CustomBoardObject, CustomObjectAddInput, CustomObjectDefinition, CustomTool, CustomToolDefinition, DefaultBoardChromeProps, DefaultUIRegion, DefaultUISlot, DefaultUISlots, DialogSlotProps, ExportDocumentSVGOptions, ExportDocumentSVGResult, ExtensionCommand, ExtensionDiagnostic, ExtensionHitResult, ExtensionId, ExtensionRequirement, FocusedItem, FocusedItemToolbarProps, InlineEditorsProps, InputModifiers, JsonObject, JsonValue, LocalBoard, LocalBoardSnapshot, LocalPresence, Mat2x3, MultiplayerCursorsProps, ObjectDescribeContext, ObjectIntent, ObjectType, PresenceCursor, PresenceUser, PresenceView, QueryableBoardObject, ReadonlyCustomObject, SceneEllipse, SceneGroup, SceneImage, ScenePath, SceneRect, SceneText, ScrawlBoardProps, ScrawlCanvasProps, ScrawlDefaultUIProps, ScrawlDensity, ScrawlExtension, ScrawlGridMode, ScrawlProps, ScrawlProviderProps, ScrawlResolvedTheme, ScrawlSurfaceTexture, ScrawlTheme, ScrawlThemeDiagnostic, ScrawlThemePreset, SearchHit, SearchHitKind, SearchableComment, StyleShelfProps, SupportedAssetMediaType, ToolCancelReason, ToolCapabilities, ToolCursor, ToolId };