superdoc 2.4.0-next.8 → 2.4.0

package/dist/superdoc/src/components/CommentsLayer/CommentDialog.vue.d.ts

@@ -5,6 +5,7 @@ declare const _default: import('vue').DefineComponent<{}, {
     floatingInstanceId: string;
     floatingPageIndex: number;
     floatingPositionEntry: Record<string, any>;
+    threadComments: unknown[];
     parent?: Record<string, any> | undefined;
     isFloatingInstanceActive?: boolean | undefined;
     $props: {
@@ -13,6 +14,7 @@ declare const _default: import('vue').DefineComponent<{}, {
         readonly floatingInstanceId?: string | undefined;
         readonly floatingPageIndex?: number | undefined;
         readonly floatingPositionEntry?: Record<string, any> | undefined;
+        readonly threadComments?: unknown[] | undefined;
         readonly parent?: Record<string, any> | undefined;
         readonly isFloatingInstanceActive?: boolean | undefined;
     };

package/dist/superdoc/src/components/CommentsLayer/commentsList/ReviewDirectoryListItem.vue.d.ts

@@ -0,0 +1,16 @@
+declare const _default: import('vue').DefineComponent<{}, {
+    $emit: (event: "focus-item" | "navigate", ...args: any[]) => void;
+    item: Record<string, any>;
+    index: number;
+    total: number;
+    tabIndex: number;
+    $props: {
+        readonly item?: Record<string, any> | undefined;
+        readonly index?: number | undefined;
+        readonly total?: number | undefined;
+        readonly tabIndex?: number | undefined;
+    };
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {
+    shell: HTMLDivElement;
+}, HTMLDivElement>;
+export default _default;

package/dist/superdoc/src/components/CommentsLayer/commentsList/commentsList.vue.d.ts

@@ -5,5 +5,7 @@ declare const _default: import('vue').DefineComponent<{}, {
         readonly showMainComments?: boolean | undefined;
         readonly showResolvedComments?: boolean | undefined;
     };
-}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {
+    listRoot: HTMLDivElement;
+}, HTMLDivElement>;
 export default _default;

package/dist/superdoc/src/components/CommentsLayer/commentsList/super-comments-list.d.ts

@@ -14,6 +14,18 @@ export class SuperComments extends EventEmitter<string | symbol, any> {
     };
     app: import('vue').App<Element> | null;
     superdoc: any;
+    stopDirectoryObservers: any[];
+    directorySnapshots: {
+        comments: null;
+        trackChanges: null;
+    };
+    directoryItemRefs: {
+        comments: null;
+        trackChanges: null;
+    };
+    directoryGeneration: number;
+    syncDirectory(): void;
+    startDirectoryObservers(): void;
     createVueApp(): void;
     container: import('vue').ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import('vue').ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}, {}, {}, string, import('vue').ComponentProvideOptions>, {}, {}, "", {}, any> | null | undefined;
     close(): void;

package/dist/superdoc/src/core/SuperDoc.d.ts

@@ -30,6 +30,9 @@ interface SuperDocFormattingMarksPayload {
 interface SuperDocDocumentModeChangePayload {
     documentMode: DocumentMode;
 }
+interface SuperDocCommentsListChangePayload {
+    isRendered: boolean;
+}
 interface SuperDocPaginationPayload {
     totalPages: number;
     superdoc: SuperDoc;
@@ -51,6 +54,7 @@ interface SuperDocEventMap {
     editorDestroy: [];
     'pdf:document-ready': [];
     'sidebar-toggle': [boolean];
+    'comments-list-change': [SuperDocCommentsListChangePayload];
     /** Requests the shell open its find/replace surface (e.g. the toolbar search button). */
     'search:open': [];
     zoomChange: [SuperDocZoomPayload];
@@ -347,18 +351,17 @@ export declare class SuperDoc extends EventEmitter<SuperDocEventMap> {
      */
     get element(): Element | null;
     /**
-     * Upgrade a local SuperDoc instance into collaboration by overwriting
-     * the supplied room with the current local document and comment state,
-     * then attaching collaboration to the live editor instance in place.
+     * Upgrade a local SuperDoc instance into collaboration by creating the
+     * supplied room from the current local document and comment state, then
+     * attaching collaboration to the live editor instance in place.
      *
-     * This is a **destructive promotion**: the target room is authoritatively
-     * overwritten with the caller's current local state. It is NOT the API
-     * for joining an existing room without changing its content.
+     * The target room must not already exist. This is not the API for joining
+     * an existing room or merging its content.
      *
      * Currently limited to:
      * - A single DOCX document
      * - A supported v2 single-doc `v2Collaboration` target
-     * - Overwrite-and-upgrade only (no merge semantics)
+     * - Create-and-upgrade only (no merge semantics)
      *
      * @returns Resolves once the collaborative runtime is ready
      */

package/dist/superdoc/src/core/extensions/index.d.ts

@@ -1,2 +1,2 @@
 export { defineSuperDocExtension } from './define.js';
-export type { SuperDocActiveEditorExtensions, SuperDocActiveEditorExtensionsCommands, SuperDocActiveEditorExtensionsDiagnostics, SuperDocAnchor, SuperDocAnchorApi, SuperDocAnchorCollection, SuperDocAnchorStatus, SuperDocAnchorTarget, SuperDocCharRange, SuperDocCommandApi, SuperDocCommandExecuteContext, SuperDocCommandState, SuperDocCommandStateContext, SuperDocDecoration, SuperDocDecorationApi, SuperDocDecorationContext, SuperDocDecorationData, SuperDocDecorationProvider, SuperDocDisposableBag, SuperDocExtension, SuperDocExtensionActivateReturn, SuperDocExtensionCapabilities, SuperDocExtensionCommandHandle, SuperDocExtensionCommandListEntry, SuperDocExtensionCommandRegistration, SuperDocExtensionCommandStateView, SuperDocExtensionContext, SuperDocExtensionDiagnostic, SuperDocExtensionDiagnostics, SuperDocExtensionDisposable, SuperDocExtensionEventApi, SuperDocExtensionPhase, SuperDocExtensionSnapshot, SuperDocExtensionStorage, SuperDocGuardedDoc, SuperDocGuardedDocQuery, SuperDocGuardedDocSelection, SuperDocMutationAffect, SuperDocMutationEvent, SuperDocMutationFilter, SuperDocMutationOrigin, SuperDocPaintEvent, SuperDocReceiptSuccess, SuperDocSaveEvent, SuperDocSelectionEvent, SuperDocSelectionPoint, SuperDocSelectionTarget, SuperDocStoryLocator, SuperDocTextAddress, SuperDocTextTarget, SuperDocVisibleRange, SuperDocVisualApi, SuperDocVisualHandle, SuperDocVisualOptions, SuperDocVisualTarget, } from './types.js';
+export type { SuperDocActiveEditorExtensions, SuperDocActiveEditorExtensionsCommands, SuperDocActiveEditorExtensionsDiagnostics, SuperDocAnchor, SuperDocAnchorApi, SuperDocAnchorCollection, SuperDocAnchorStatus, SuperDocAnchorTarget, SuperDocCharRange, SuperDocCommandApi, SuperDocCommandExecuteContext, SuperDocCommandState, SuperDocCommandStateContext, SuperDocDecoration, SuperDocDecorationApi, SuperDocDecorationContext, SuperDocDecorationData, SuperDocDecorationProvider, SuperDocDisposableBag, SuperDocExtension, SuperDocExtensionActivateReturn, SuperDocExtensionCapabilities, SuperDocExtensionCommandHandle, SuperDocExtensionCommandListEntry, SuperDocExtensionCommandRegistration, SuperDocExtensionCommandStateView, SuperDocExtensionContext, SuperDocExtensionDiagnostic, SuperDocExtensionDiagnostics, SuperDocExtensionDisposable, SuperDocExtensionEventApi, SuperDocExtensionPhase, SuperDocExtensionSnapshot, SuperDocExtensionStorage, SuperDocGuardedDoc, SuperDocGuardedDocQuery, SuperDocGuardedDocSelection, SuperDocInlineBoxAppearance, SuperDocInlineBoxLayout, SuperDocInlineBoxOptions, SuperDocMutationAffect, SuperDocMutationEvent, SuperDocMutationFilter, SuperDocMutationOrigin, SuperDocPaintEvent, SuperDocReceiptSuccess, SuperDocSaveEvent, SuperDocSelectionEvent, SuperDocSelectionPoint, SuperDocSelectionTarget, SuperDocStoryLocator, SuperDocTextAddress, SuperDocTextTarget, SuperDocVisibleRange, SuperDocVisualApi, SuperDocVisualHandle, SuperDocVisualOptions, SuperDocVisualTarget, } from './types.js';

package/dist/superdoc/src/core/extensions/types.d.ts

@@ -105,15 +105,17 @@ export interface SuperDocSelectionTarget {
     start: SuperDocSelectionPoint;
     end: SuperDocSelectionPoint;
     story?: SuperDocStoryLocator;
+    /** Coordinate space for text endpoint offsets. Omitted means `visible`. */
+    coordinateSpace?: 'visible' | 'tracked';
 }
-/** Locations an extension anchor can be created from. */
+/** Visible-coordinate locations an extension anchor can be created from. */
 export type SuperDocAnchorTarget = SuperDocSelectionTarget | SuperDocTextTarget | SuperDocTextAddress;
 /** Lifecycle status of a {@link SuperDocAnchor}. */
 export type SuperDocAnchorStatus = 'active' | 'stale' | 'disposed' | 'pending';
 /**
- * A session-stable location handle. The runtime remaps anchors as it observes
- * Document API receipts; an anchor that cannot be remapped safely fails closed
- * to `stale` and never silently points at the wrong range.
+ * A session-stable location handle. The runtime rebases anchors from
+ * block-local Document API receipt data; an anchor that cannot be rebased
+ * safely fails closed to `stale` and never silently points at the wrong range.
  */
 export interface SuperDocAnchor {
     readonly id: string;
@@ -171,7 +173,7 @@ export interface SuperDocDecorationProvider {
     id: string;
     provide(context: SuperDocDecorationContext): SuperDocDecoration[];
 }
-export type SuperDocMutationOrigin = 'local' | 'history' | 'extension';
+export type SuperDocMutationOrigin = 'local' | 'history' | 'extension' | 'remote';
 export type SuperDocMutationAffect = 'text' | 'block' | 'comment' | 'trackedChange' | 'bookmark';
 /** Synchronous filter applied before a mutation handler runs. */
 export interface SuperDocMutationFilter {
@@ -390,6 +392,50 @@ export interface SuperDocVisualOptions {
      */
     scope?: 'text' | 'block';
 }
+/**
+ * Layout-affecting inline-box values in non-negative integer CSS pixels.
+ * Padding, gaps, and borders participate in wrapping and pagination.
+ */
+export interface SuperDocInlineBoxLayout {
+    paddingInline?: number | {
+        start: number;
+        end: number;
+    };
+    paddingBlock?: number | {
+        start: number;
+        end: number;
+    };
+    /** Logical spacing outside the range, paid once at each boundary. */
+    gapBefore?: number;
+    gapAfter?: number;
+    /** Border width consumes layout space. */
+    borderWidth?: number;
+}
+/** Paint-only appearance for a layout-aware inline box. */
+export interface SuperDocInlineBoxAppearance {
+    backgroundColor?: string;
+    borderColor?: string;
+    borderStyle?: 'solid' | 'dashed' | 'dotted';
+    borderRadius?: number;
+    color?: string;
+}
+/**
+ * Options for {@link SuperDocVisualApi.inlineBox}. Inline boxes are
+ * render-only and byte-neutral. They currently support LTR visible-text
+ * targets only; unsupported directions and overlapping boxes fail closed.
+ */
+export interface SuperDocInlineBoxOptions {
+    layout?: SuperDocInlineBoxLayout;
+    appearance?: SuperDocInlineBoxAppearance;
+    /** Additive paint-only class. It must not alter geometry. */
+    className?: string;
+    /** Sanitized data attributes stamped on the painted text leaves. */
+    data?: SuperDocDecorationData;
+    /** Paint-only cursor. */
+    cursor?: 'default' | 'pointer' | 'text' | 'help';
+    /** Wrapped ranges clone their box edges on every line. */
+    wrap?: 'clone';
+}
 /**
  * The easy, beginner-facing visual authoring layer exposed as `ctx.visuals`.
  * Backed by the same render-only decoration runtime as
@@ -400,6 +446,13 @@ export interface SuperDocVisualOptions {
  * const risks = ctx.visuals.highlight('risks', { className: 'acme-risk' });
  * const result = await ctx.doc.query.match({ select: { type: 'text', pattern: /risk/i } });
  * risks.replace(result.items.map((item) => item.target));
+ *
+ * const pills = ctx.visuals.inlineBox('citations', {
+ *   layout: { paddingInline: 4, paddingBlock: 2, borderWidth: 1 },
+ *   appearance: { backgroundColor: '#eef4ff', borderColor: '#8aa8d8', borderRadius: 8 },
+ *   cursor: 'pointer',
+ * });
+ * pills.replace(citationTargets);
  * ```
  */
 export interface SuperDocVisualApi {
@@ -407,6 +460,11 @@ export interface SuperDocVisualApi {
     highlight(id: string, options?: SuperDocVisualOptions): SuperDocVisualHandle;
     /** Create a neutral class/data visual layer (synonym of highlight). */
     decorate(id: string, options?: SuperDocVisualOptions): SuperDocVisualHandle;
+    /**
+     * Create a layout-aware box over anchored visible text. Local typing,
+     * undo, and redo rebase its anchors; dispose the returned handle on cleanup.
+     */
+    inlineBox(id: string, options?: SuperDocInlineBoxOptions): SuperDocVisualHandle;
 }
 /** Advanced escape-hatch generic event surface. */
 export interface SuperDocExtensionEventApi {