SD-2261 - fix(types): expand definitions and exports to pass compilation

packages/super-editor/src/index.d.ts

@@ -77,7 +77,20 @@ export type Command = (props: CommandProps) => boolean;
  * Chainable command object returned by editor.chain()
  */
 export interface ChainableCommandObject {
-  run: () => boolean;
+  /** Execute the chained commands */
+  run(): boolean;
+  /** Chain any command - returns self for further chaining */
+  toggleBold(): ChainableCommandObject;
+  toggleItalic(): ChainableCommandObject;
+  toggleUnderline(): ChainableCommandObject;
+  toggleStrike(): ChainableCommandObject;
+  setFontSize(size: string | number): ChainableCommandObject;
+  setFontFamily(family: string): ChainableCommandObject;
+  setTextColor(color: string): ChainableCommandObject;
+  setTextAlign(alignment: 'left' | 'center' | 'right' | 'justify'): ChainableCommandObject;
+  insertContent(content: any): ChainableCommandObject;
+  focus(position?: 'start' | 'end' | 'all' | number | boolean | null): ChainableCommandObject;
+  /** Allow any other command */
   [commandName: string]: ((...args: any[]) => ChainableCommandObject) | (() => boolean);
 }
 
@@ -199,6 +212,67 @@ export interface OpenOptions {
   fonts?: Record<string, unknown>;
 }
 
+// ============================================
+// COMMENT TYPES
+// ============================================
+
+/** A comment element (paragraph, text run, etc.) */
+export interface CommentElement {
+  type: string;
+  content?: CommentElement[];
+  text?: string;
+}
+
+/** A comment in the document */
+export interface Comment {
+  /** Unique comment identifier */
+  commentId: string;
+  /** Timestamp when comment was created */
+  createdTime: number;
+  /** Email of the comment author */
+  creatorEmail: string;
+  /** Display name of the comment author */
+  creatorName: string;
+  /** Comment content elements */
+  elements: CommentElement[];
+  /** Original ID from imported document */
+  importedId?: string;
+  /** Whether the comment is resolved */
+  isDone: boolean;
+  /** Parent comment ID for replies */
+  parentCommentId?: string;
+  /** Raw JSON representation */
+  commentJSON?: unknown;
+}
+
+/** Event data for comments loaded event */
+export interface CommentsLoadedEventData {
+  comments: Comment[];
+}
+
+/** Event data for content error event */
+export interface ContentErrorEventData {
+  error: Error;
+}
+
+/** Font configuration */
+export interface FontConfig {
+  key: string;
+  label: string;
+  fontWeight?: number;
+  props?: {
+    style?: {
+      fontFamily?: string;
+    };
+  };
+}
+
+/** Font support information */
+export interface FontSupportInfo {
+  documentFonts: string[];
+  unsupportedFonts: string[];
+}
+
 // ============================================
 // PRESENTATION EDITOR TYPES
 // ============================================
@@ -586,6 +660,131 @@ export declare class Editor {
    */
   isEmpty: boolean;
 
+  // ============================================
+  // EVENT METHODS
+  // ============================================
+
+  /**
+   * Register an event listener.
+   * @param event - Event name ('update', 'create', 'transaction', etc.)
+   * @param handler - Event handler function
+   */
+  on(event: string, handler: (...args: any[]) => void): void;
+
+  /**
+   * Remove an event listener.
+   * @param event - Event name
+   * @param handler - Event handler function to remove
+   */
+  off(event: string, handler: (...args: any[]) => void): void;
+
+  /**
+   * Emit an event.
+   * @param event - Event name
+   * @param args - Arguments to pass to handlers
+   */
+  emit(event: string, ...args: any[]): void;
+
+  // ============================================
+  // DOCUMENT EXPORT METHODS
+  // ============================================
+
+  /**
+   * Export the document to DOCX format.
+   * @param options - Export options
+   * @returns Promise resolving to Blob (browser) or Buffer (Node.js)
+   */
+  exportDocx(options?: {
+    isFinalDoc?: boolean;
+    commentsType?: string;
+    comments?: Comment[];
+    fieldsHighlightColor?: string | null;
+    compression?: 'DEFLATE' | 'STORE';
+  }): Promise<Blob | ArrayBuffer>;
+
+  /**
+   * Export the document (alias for exportDocx).
+   */
+  exportDocument(options?: {
+    isFinalDoc?: boolean;
+    commentsType?: string;
+    comments?: Comment[];
+  }): Promise<Blob | ArrayBuffer>;
+
+  /**
+   * Save the document to the original source path (Node.js only).
+   */
+  save(options?: { isFinalDoc?: boolean; commentsType?: string; comments?: Comment[] }): Promise<void>;
+
+  /**
+   * Save the document to a specific path (Node.js only).
+   */
+  saveTo(
+    path: string,
+    options?: {
+      isFinalDoc?: boolean;
+      commentsType?: string;
+      comments?: Comment[];
+    },
+  ): Promise<void>;
+
+  // ============================================
+  // TOOLBAR & UI METHODS
+  // ============================================
+
+  /**
+   * Set the toolbar for this editor.
+   */
+  setToolbar(toolbar: any): void;
+
+  /**
+   * Set whether the editor is editable.
+   */
+  setEditable(editable: boolean, emitUpdate?: boolean): void;
+
+  /**
+   * Set the document mode.
+   */
+  setDocumentMode(mode: 'editing' | 'viewing' | 'suggesting'): void;
+
+  /**
+   * Focus the editor.
+   */
+  focus(): void;
+
+  /**
+   * Blur the editor.
+   */
+  blur(): void;
+
+  // ============================================
+  // DOCUMENT METHODS
+  // ============================================
+
+  /**
+   * Open a document.
+   */
+  open(source?: string | File | Blob | BinaryData, options?: OpenOptions): Promise<void>;
+
+  /**
+   * Close the current document.
+   */
+  close(): void;
+
+  /**
+   * Replace the current file.
+   */
+  replaceFile(newFile: File | Blob | BinaryData): Promise<void>;
+
+  /**
+   * Get the document as Markdown.
+   */
+  getMarkdown(): Promise<string>;
+
+  /**
+   * Check if the editor is currently active/focused.
+   */
+  isFocused: boolean;
   // --- Tracked selection handle API ---
 
   /** Capture the live PM selection as a tracked handle. Local-only. */
@@ -997,8 +1196,15 @@ export declare class PresentationEditor {
    */
   emit(event: string, ...args: any[]): void;
 
-  /** Allow additional properties */
-  [key: string]: any;
+  /**
+   * Replace the current file.
+   */
+  replaceFile(newFile: File | Blob | BinaryData): Promise<void>;
+
+  /**
+   * Set the toolbar for the editor.
+   */
+  setToolbar(toolbar: any): void;
 }
 
 // ============================================

packages/superdoc/src/index.js

@@ -1,6 +1,8 @@
 import {
   SuperConverter,
   Editor,
+  PresentationEditor,
+  getStarterExtensions,
   getRichTextExtensions,
   createZip,
   Extensions,
@@ -15,13 +17,46 @@ import { DOCX, PDF, HTML, getFileObject, compareVersions } from '@superdoc/commo
 import BlankDOCX from '@superdoc/common/data/blank.docx?url';
 import { getSchemaIntrospection } from './helpers/schema-introspection.js';
 
+// ============================================
+// TYPE RE-EXPORTS
+// These types are defined in @superdoc/super-editor and re-exported for consumers
+// ============================================
+
+/**
+ * @typedef {import('@superdoc/super-editor').EditorState} EditorState
+ * @typedef {import('@superdoc/super-editor').Transaction} Transaction
+ * @typedef {import('@superdoc/super-editor').Schema} Schema
+ * @typedef {import('@superdoc/super-editor').EditorView} EditorView
+ * @typedef {import('@superdoc/super-editor').EditorCommands} EditorCommands
+ * @typedef {import('@superdoc/super-editor').ChainedCommand} ChainedCommand
+ * @typedef {import('@superdoc/super-editor').ChainableCommandObject} ChainableCommandObject
+ * @typedef {import('@superdoc/super-editor').PresentationEditorOptions} PresentationEditorOptions
+ * @typedef {import('@superdoc/super-editor').LayoutEngineOptions} LayoutEngineOptions
+ * @typedef {import('@superdoc/super-editor').PageSize} PageSize
+ * @typedef {import('@superdoc/super-editor').PageMargins} PageMargins
+ * @typedef {import('@superdoc/super-editor').Layout} Layout
+ * @typedef {import('@superdoc/super-editor').LayoutPage} LayoutPage
+ * @typedef {import('@superdoc/super-editor').LayoutFragment} LayoutFragment
+ * @typedef {import('@superdoc/super-editor').RangeRect} RangeRect
+ * @typedef {import('@superdoc/super-editor').BoundingRect} BoundingRect
+ * @typedef {import('@superdoc/super-editor').OpenOptions} OpenOptions
+ * @typedef {import('@superdoc/super-editor').DocxFileEntry} DocxFileEntry
+ * @typedef {import('@superdoc/super-editor').Comment} Comment
+ * @typedef {import('@superdoc/super-editor').CommentElement} CommentElement
+ * @typedef {import('@superdoc/super-editor').CommentsLoadedEventData} CommentsLoadedEventData
+ * @typedef {import('@superdoc/super-editor').FontConfig} FontConfig
+ * @typedef {import('@superdoc/super-editor').FontSupportInfo} FontSupportInfo
+ */
+
 // Public exports
 export { SuperDoc } from './core/SuperDoc.js';
 export {
   BlankDOCX,
   getFileObject,
   compareVersions,
   Editor,
+  PresentationEditor,
+  getStarterExtensions,
   getRichTextExtensions,
   getSchemaIntrospection,
 

tests/consumer-typecheck/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "consumer-typecheck",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "superdoc": "file:../../packages/superdoc/superdoc.tgz"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}