@eigenpal/docx-js-editor 0.0.16 → 0.0.17

package/dist/types-xMzSPT4i.d.ts

@@ -1,310 +0,0 @@
-import { h as Document, v as Position, R as Range, b as AgentCommand } from './agentApi-CbVUCZRu.js';
-
-/**
- * Core Plugin System Types
- *
- * Defines the interfaces for headless plugins that work in Node.js
- * without React/DOM dependencies. These plugins extend DocumentAgent
- * with additional commands and expose MCP tools for AI integration.
- */
-
-/**
- * Core plugin interface - headless, works in Node.js
- *
- * Plugins can:
- * - Register command handlers that DocumentAgent dispatches to
- * - Declare MCP tools that the MCP server exposes to AI clients
- * - Have optional initialization logic
- * - Declare dependencies on other plugins
- */
-interface CorePlugin {
-    /** Unique plugin identifier */
-    id: string;
-    /** Human-readable plugin name */
-    name: string;
-    /** Plugin version (semver) */
-    version?: string;
-    /** Plugin description */
-    description?: string;
-    /**
-     * Command handlers this plugin provides.
-     * DocumentAgent dispatches commands to these handlers.
-     *
-     * @example
-     * ```ts
-     * commandHandlers: {
-     *   'insertTemplateVariable': (doc, cmd) => {
-     *     // Transform document
-     *     return modifiedDoc;
-     *   },
-     * }
-     * ```
-     */
-    commandHandlers?: Record<string, CommandHandler>;
-    /**
-     * MCP tools this plugin exposes.
-     * MCP server collects these from all plugins.
-     */
-    mcpTools?: McpToolDefinition[];
-    /**
-     * Optional setup when plugin is registered.
-     * Called once during plugin registration.
-     */
-    initialize?: () => void | Promise<void>;
-    /**
-     * Optional cleanup when plugin is unregistered.
-     */
-    destroy?: () => void | Promise<void>;
-    /**
-     * Dependencies on other plugins (by ID).
-     * The registry ensures dependencies are loaded first.
-     */
-    dependencies?: string[];
-}
-/**
- * Command handler function type
- *
- * Receives a document and a command, returns a modified document.
- * Must be pure/immutable - always return a new document.
- */
-type CommandHandler = (doc: Document, command: PluginCommand) => Document;
-/**
- * Extended command type for plugins
- *
- * Plugins can define custom command types beyond the built-in AgentCommand types.
- */
-interface PluginCommand {
-    /** Command type identifier */
-    type: string;
-    /** Unique command ID (for undo tracking) */
-    id?: string;
-    /** Position for positional commands */
-    position?: Position;
-    /** Range for range-based commands */
-    range?: Range;
-    /** Additional command-specific data */
-    [key: string]: unknown;
-}
-/**
- * Result of command execution
- */
-interface CommandResult {
-    /** The modified document */
-    document: Document;
-    /** Whether the command succeeded */
-    success: boolean;
-    /** Error message if failed */
-    error?: string;
-    /** Metadata about the operation */
-    metadata?: Record<string, unknown>;
-}
-/**
- * MCP tool definition
- *
- * Describes a tool that can be called by AI clients through the MCP server.
- */
-interface McpToolDefinition {
-    /** Tool name (used in MCP protocol) */
-    name: string;
-    /** Human-readable description for AI */
-    description: string;
-    /**
-     * JSON Schema for tool input validation.
-     * Can be a Zod schema or plain JSON Schema object.
-     */
-    inputSchema: JsonSchema | ZodSchemaLike;
-    /**
-     * Handler function for the tool.
-     * Receives validated input and returns a result.
-     */
-    handler: McpToolHandler;
-    /**
-     * Optional annotations for the tool
-     */
-    annotations?: McpToolAnnotations;
-}
-/**
- * MCP tool handler function
- */
-type McpToolHandler = (input: unknown, context: McpToolContext) => Promise<McpToolResult> | McpToolResult;
-/**
- * Context passed to MCP tool handlers
- */
-interface McpToolContext {
-    /** Current document (if loaded) */
-    document?: Document;
-    /** Document buffer (if loaded) */
-    documentBuffer?: ArrayBuffer;
-    /** Session state */
-    session: McpSession;
-    /** Logger for debugging */
-    log: (message: string, data?: unknown) => void;
-}
-/**
- * MCP session state
- *
- * Maintains state across tool calls within a session.
- */
-interface McpSession {
-    /** Session ID */
-    id: string;
-    /** Loaded documents by ID */
-    documents: Map<string, LoadedDocument>;
-    /** Custom session data */
-    data: Map<string, unknown>;
-}
-/**
- * A loaded document in the session
- */
-interface LoadedDocument {
-    /** Document ID */
-    id: string;
-    /** Parsed document */
-    document: Document;
-    /** Original buffer (for repacking) */
-    buffer?: ArrayBuffer;
-    /** Source filename or path */
-    source?: string;
-    /** Last modified timestamp */
-    lastModified: number;
-}
-/**
- * MCP tool result
- */
-interface McpToolResult {
-    /** Result content */
-    content: McpToolContent[];
-    /** Whether this is an error result */
-    isError?: boolean;
-}
-/**
- * MCP tool content types
- */
-type McpToolContent = {
-    type: 'text';
-    text: string;
-} | {
-    type: 'image';
-    data: string;
-    mimeType: string;
-} | {
-    type: 'resource';
-    uri: string;
-    mimeType?: string;
-    text?: string;
-};
-/**
- * MCP tool annotations
- */
-interface McpToolAnnotations {
-    /** Tool category for organization */
-    category?: string;
-    /** Whether this tool modifies the document */
-    readOnly?: boolean;
-    /** Estimated cost/complexity */
-    complexity?: 'low' | 'medium' | 'high';
-    /** Example usage */
-    examples?: McpToolExample[];
-}
-/**
- * MCP tool example
- */
-interface McpToolExample {
-    /** Example description */
-    description: string;
-    /** Example input */
-    input: unknown;
-    /** Expected output description */
-    output?: string;
-}
-/**
- * JSON Schema definition (subset)
- */
-interface JsonSchema {
-    type?: string | string[];
-    properties?: Record<string, JsonSchema>;
-    items?: JsonSchema;
-    required?: string[];
-    description?: string;
-    enum?: unknown[];
-    default?: unknown;
-    minimum?: number;
-    maximum?: number;
-    minLength?: number;
-    maxLength?: number;
-    pattern?: string;
-    format?: string;
-    additionalProperties?: boolean | JsonSchema;
-    anyOf?: JsonSchema[];
-    oneOf?: JsonSchema[];
-    allOf?: JsonSchema[];
-    $ref?: string;
-}
-/**
- * Zod-like schema interface for compatibility
- */
-interface ZodSchemaLike {
-    _def?: unknown;
-    parse?: (data: unknown) => unknown;
-    safeParse?: (data: unknown) => {
-        success: boolean;
-        data?: unknown;
-        error?: unknown;
-    };
-}
-/**
- * Check if a schema is Zod-like
- */
-declare function isZodSchema(schema: unknown): schema is ZodSchemaLike;
-/**
- * Plugin lifecycle events
- */
-type PluginEvent = {
-    type: 'registered';
-    plugin: CorePlugin;
-} | {
-    type: 'unregistered';
-    pluginId: string;
-} | {
-    type: 'error';
-    pluginId: string;
-    error: Error;
-};
-/**
- * Plugin event listener
- */
-type PluginEventListener = (event: PluginEvent) => void;
-/**
- * Extract command type from a union
- */
-type ExtractCommand<T extends AgentCommand, Type extends string> = T extends {
-    type: Type;
-} ? T : never;
-/**
- * Create a typed command handler
- */
-type TypedCommandHandler<T extends PluginCommand> = (doc: Document, command: T) => Document;
-/**
- * Plugin configuration options
- */
-interface PluginOptions {
-    /** Enable debug logging */
-    debug?: boolean;
-    /** Custom configuration */
-    config?: Record<string, unknown>;
-}
-/**
- * Result of plugin registration
- */
-interface PluginRegistrationResult {
-    /** Whether registration succeeded */
-    success: boolean;
-    /** Registered plugin (if successful) */
-    plugin?: CorePlugin;
-    /** Error message (if failed) */
-    error?: string;
-    /** Warning messages */
-    warnings?: string[];
-}
-
-export { type CorePlugin as C, type ExtractCommand as E, type JsonSchema as J, type LoadedDocument as L, type McpSession as M, type PluginOptions as P, type TypedCommandHandler as T, type ZodSchemaLike as Z, type McpToolDefinition as a, type McpToolHandler as b, type McpToolResult as c, type PluginRegistrationResult as d, type CommandHandler as e, type PluginEventListener as f, type CommandResult as g, type McpToolAnnotations as h, type McpToolContent as i, type McpToolContext as j, type PluginCommand as k, type PluginEvent as l, isZodSchema as m, type McpToolExample as n };

package/dist/variableDetector-CPxKo9jP.d.cts

@@ -1,173 +0,0 @@
-import { h as Document, i as DocumentBody, P as Paragraph } from './agentApi-CbVUCZRu.cjs';
-
-/**
- * DOCX Repacker - Repack modified document into valid DOCX
- *
- * Takes a Document with modified content and creates a new DOCX file
- * by updating document.xml while preserving all other files from
- * the original ZIP archive.
- *
- * This ensures round-trip fidelity:
- * - styles.xml, theme1.xml, fontTable.xml remain untouched
- * - Media files preserved
- * - Relationships preserved
- * - Only document.xml is updated with new content
- *
- * OOXML Package Structure:
- * - [Content_Types].xml - Content type declarations
- * - _rels/.rels - Package relationships
- * - word/document.xml - Main document (modified)
- * - word/styles.xml - Styles (preserved)
- * - word/theme/theme1.xml - Theme (preserved)
- * - word/numbering.xml - Numbering (preserved)
- * - word/fontTable.xml - Font table (preserved)
- * - word/settings.xml - Settings (preserved)
- * - word/header*.xml - Headers (preserved)
- * - word/footer*.xml - Footers (preserved)
- * - word/footnotes.xml - Footnotes (preserved)
- * - word/endnotes.xml - Endnotes (preserved)
- * - word/media/* - Media files (preserved)
- * - word/_rels/document.xml.rels - Document relationships (preserved)
- * - docProps/* - Document properties (preserved)
- */
-
-/**
- * Options for repacking DOCX
- */
-interface RepackOptions {
-    /** Compression level (0-9, default: 6) */
-    compressionLevel?: number;
-    /** Whether to update modification date in docProps/core.xml */
-    updateModifiedDate?: boolean;
-    /** Custom modifier name for lastModifiedBy */
-    modifiedBy?: string;
-}
-/**
- * Repack a Document into a valid DOCX file
- *
- * @param doc - Document with modified content
- * @param options - Optional repack options
- * @returns Promise resolving to DOCX as ArrayBuffer
- * @throws Error if document has no original buffer for round-trip
- */
-declare function repackDocx(doc: Document, options?: RepackOptions): Promise<ArrayBuffer>;
-/**
- * Create a new DOCX from a Document (without requiring original buffer)
- *
- * @param doc - Document to serialize
- * @returns Promise resolving to DOCX as ArrayBuffer
- */
-declare function createDocx(doc: Document): Promise<ArrayBuffer>;
-
-/**
- * Variable Detector Utility
- *
- * Scans a DOCX document for template variables in the format {variable_name}
- * (standard docxtemplater syntax).
- * Returns a unique, sorted list of variable names found in the document.
- */
-
-/**
- * Result of variable detection
- */
-interface VariableDetectionResult {
-    /** Unique variable names sorted alphabetically */
-    variables: string[];
-    /** Total count of variable occurrences */
-    totalOccurrences: number;
-    /** Variables by location */
-    byLocation: {
-        body: string[];
-        headers: string[];
-        footers: string[];
-        footnotes: string[];
-        endnotes: string[];
-        textBoxes: string[];
-    };
-    /** Variable occurrences with positions */
-    occurrences: VariableOccurrence[];
-}
-/**
- * A single variable occurrence with location info
- */
-interface VariableOccurrence {
-    /** Variable name (without braces) */
-    name: string;
-    /** Location type */
-    location: 'body' | 'header' | 'footer' | 'footnote' | 'endnote' | 'textBox';
-    /** Paragraph index within location */
-    paragraphIndex?: number;
-    /** Section index (for headers/footers) */
-    sectionIndex?: number;
-}
-/**
- * Detect all template variables in a document
- *
- * @param doc - The parsed document
- * @returns Array of unique variable names sorted alphabetically
- */
-declare function detectVariables(doc: Document): string[];
-/**
- * Detect variables with detailed information
- *
- * @param doc - The parsed document
- * @returns Detailed detection result
- */
-declare function detectVariablesDetailed(doc: Document): VariableDetectionResult;
-/**
- * Detect variables in document body
- */
-declare function detectVariablesInBody(body: DocumentBody): string[];
-/**
- * Detect variables in a paragraph
- */
-declare function detectVariablesInParagraph(paragraph: Paragraph): string[];
-/**
- * Extract variable names from text
- *
- * @param text - The text to search
- * @returns Array of variable names (without braces)
- */
-declare function extractVariablesFromText(text: string): string[];
-/**
- * Check if text contains template variables
- */
-declare function hasTemplateVariables(text: string): boolean;
-/**
- * Check if a variable name is valid
- */
-declare function isValidVariableName(name: string): boolean;
-/**
- * Sanitize a variable name
- */
-declare function sanitizeVariableName(name: string): string;
-/**
- * Format a variable name with braces (standard docxtemplater syntax)
- */
-declare function formatVariable(name: string): string;
-/**
- * Parse a variable string to get the name
- */
-declare function parseVariable(variable: string): string | null;
-/**
- * Replace variables in text with values
- *
- * @param text - The text containing variables
- * @param values - Map of variable name to replacement value
- * @returns Text with variables replaced
- */
-declare function replaceVariables(text: string, values: Record<string, string>): string;
-/**
- * Replace all variables in text with a placeholder
- *
- * @param text - The text containing variables
- * @param placeholder - Placeholder to use (default: empty string)
- * @returns Text with variables replaced
- */
-declare function removeVariables(text: string, placeholder?: string): string;
-/**
- * Check if document has any template variables
- */
-declare function documentHasVariables(doc: Document): boolean;
-
-export { type VariableDetectionResult as V, type VariableOccurrence as a, detectVariablesDetailed as b, createDocx as c, detectVariables as d, detectVariablesInBody as e, detectVariablesInParagraph as f, documentHasVariables as g, extractVariablesFromText as h, formatVariable as i, hasTemplateVariables as j, isValidVariableName as k, repackDocx as l, replaceVariables as m, parseVariable as p, removeVariables as r, sanitizeVariableName as s };

package/dist/variableDetector-DeM1N-_L.d.ts

@@ -1,173 +0,0 @@
-import { h as Document, i as DocumentBody, P as Paragraph } from './agentApi-CbVUCZRu.js';
-
-/**
- * DOCX Repacker - Repack modified document into valid DOCX
- *
- * Takes a Document with modified content and creates a new DOCX file
- * by updating document.xml while preserving all other files from
- * the original ZIP archive.
- *
- * This ensures round-trip fidelity:
- * - styles.xml, theme1.xml, fontTable.xml remain untouched
- * - Media files preserved
- * - Relationships preserved
- * - Only document.xml is updated with new content
- *
- * OOXML Package Structure:
- * - [Content_Types].xml - Content type declarations
- * - _rels/.rels - Package relationships
- * - word/document.xml - Main document (modified)
- * - word/styles.xml - Styles (preserved)
- * - word/theme/theme1.xml - Theme (preserved)
- * - word/numbering.xml - Numbering (preserved)
- * - word/fontTable.xml - Font table (preserved)
- * - word/settings.xml - Settings (preserved)
- * - word/header*.xml - Headers (preserved)
- * - word/footer*.xml - Footers (preserved)
- * - word/footnotes.xml - Footnotes (preserved)
- * - word/endnotes.xml - Endnotes (preserved)
- * - word/media/* - Media files (preserved)
- * - word/_rels/document.xml.rels - Document relationships (preserved)
- * - docProps/* - Document properties (preserved)
- */
-
-/**
- * Options for repacking DOCX
- */
-interface RepackOptions {
-    /** Compression level (0-9, default: 6) */
-    compressionLevel?: number;
-    /** Whether to update modification date in docProps/core.xml */
-    updateModifiedDate?: boolean;
-    /** Custom modifier name for lastModifiedBy */
-    modifiedBy?: string;
-}
-/**
- * Repack a Document into a valid DOCX file
- *
- * @param doc - Document with modified content
- * @param options - Optional repack options
- * @returns Promise resolving to DOCX as ArrayBuffer
- * @throws Error if document has no original buffer for round-trip
- */
-declare function repackDocx(doc: Document, options?: RepackOptions): Promise<ArrayBuffer>;
-/**
- * Create a new DOCX from a Document (without requiring original buffer)
- *
- * @param doc - Document to serialize
- * @returns Promise resolving to DOCX as ArrayBuffer
- */
-declare function createDocx(doc: Document): Promise<ArrayBuffer>;
-
-/**
- * Variable Detector Utility
- *
- * Scans a DOCX document for template variables in the format {variable_name}
- * (standard docxtemplater syntax).
- * Returns a unique, sorted list of variable names found in the document.
- */
-
-/**
- * Result of variable detection
- */
-interface VariableDetectionResult {
-    /** Unique variable names sorted alphabetically */
-    variables: string[];
-    /** Total count of variable occurrences */
-    totalOccurrences: number;
-    /** Variables by location */
-    byLocation: {
-        body: string[];
-        headers: string[];
-        footers: string[];
-        footnotes: string[];
-        endnotes: string[];
-        textBoxes: string[];
-    };
-    /** Variable occurrences with positions */
-    occurrences: VariableOccurrence[];
-}
-/**
- * A single variable occurrence with location info
- */
-interface VariableOccurrence {
-    /** Variable name (without braces) */
-    name: string;
-    /** Location type */
-    location: 'body' | 'header' | 'footer' | 'footnote' | 'endnote' | 'textBox';
-    /** Paragraph index within location */
-    paragraphIndex?: number;
-    /** Section index (for headers/footers) */
-    sectionIndex?: number;
-}
-/**
- * Detect all template variables in a document
- *
- * @param doc - The parsed document
- * @returns Array of unique variable names sorted alphabetically
- */
-declare function detectVariables(doc: Document): string[];
-/**
- * Detect variables with detailed information
- *
- * @param doc - The parsed document
- * @returns Detailed detection result
- */
-declare function detectVariablesDetailed(doc: Document): VariableDetectionResult;
-/**
- * Detect variables in document body
- */
-declare function detectVariablesInBody(body: DocumentBody): string[];
-/**
- * Detect variables in a paragraph
- */
-declare function detectVariablesInParagraph(paragraph: Paragraph): string[];
-/**
- * Extract variable names from text
- *
- * @param text - The text to search
- * @returns Array of variable names (without braces)
- */
-declare function extractVariablesFromText(text: string): string[];
-/**
- * Check if text contains template variables
- */
-declare function hasTemplateVariables(text: string): boolean;
-/**
- * Check if a variable name is valid
- */
-declare function isValidVariableName(name: string): boolean;
-/**
- * Sanitize a variable name
- */
-declare function sanitizeVariableName(name: string): string;
-/**
- * Format a variable name with braces (standard docxtemplater syntax)
- */
-declare function formatVariable(name: string): string;
-/**
- * Parse a variable string to get the name
- */
-declare function parseVariable(variable: string): string | null;
-/**
- * Replace variables in text with values
- *
- * @param text - The text containing variables
- * @param values - Map of variable name to replacement value
- * @returns Text with variables replaced
- */
-declare function replaceVariables(text: string, values: Record<string, string>): string;
-/**
- * Replace all variables in text with a placeholder
- *
- * @param text - The text containing variables
- * @param placeholder - Placeholder to use (default: empty string)
- * @returns Text with variables replaced
- */
-declare function removeVariables(text: string, placeholder?: string): string;
-/**
- * Check if document has any template variables
- */
-declare function documentHasVariables(doc: Document): boolean;
-
-export { type VariableDetectionResult as V, type VariableOccurrence as a, detectVariablesDetailed as b, createDocx as c, detectVariables as d, detectVariablesInBody as e, detectVariablesInParagraph as f, documentHasVariables as g, extractVariablesFromText as h, formatVariable as i, hasTemplateVariables as j, isValidVariableName as k, repackDocx as l, replaceVariables as m, parseVariable as p, removeVariables as r, sanitizeVariableName as s };