API Reference

Complete API reference for DocsJS.

CoreEngine

The main engine for programmatic document processing.

Constructor

new CoreEngine(config?: EngineConfig)

Methods

transformDocument(file: File): Promise<TransformResult>

Transform a document file.

const engine = new CoreEngine();
const result = await engine.transformDocument(file);

applyProfile(profileId: string): void

Apply a processing profile.

engine.applyProfile("knowledge-base");

registerPlugin(plugin: PluginConfig): void

Register a custom plugin.

engine.registerPlugin({
  name: "my-plugin",
  availableHooks: ["afterParse"],
  afterParse: (context) => context,
});

registerProfile(profile: ProfileConfig): void

Register a custom profile.

engine.registerProfile({
  id: "custom-profile",
  name: "Custom Profile",
  parse: { features: { mathML: true } },
});

Components

Web Component

<docs-word-editor lang="en" show-toolbar profile="knowledge-base"></docs-word-editor>

Attributes

Attribute	Type	Default	Description
lang	string	'en'	UI language
show-toolbar	boolean	false	Show toolbar
profile	string	'default'	Processing profile

Methods

Method	Parameters	Returns	Description
loadHtml(html)	html: string	Promise<void>	Load HTML content
loadDocx(file)	file: File	Promise<void>	Load DOCX file
loadClipboard()	-	Promise<void>	Load from clipboard
getSnapshot()	-	string	Get HTML output
clear()	-	void	Clear content

React Component

<WordFidelityEditorReact
  lang="en"
  showToolbar={true}
  profile="knowledge-base"
  config={{}}
  onReady={() => {}}
  onChange={(e) => {}}
  onError={(e) => {}}
/>

Props

Prop	Type	Default	Description
lang	string	'en'	UI language
showToolbar	boolean	false	Show toolbar
profile	string	'default'	Processing profile
config	EngineConfig	{}	Engine configuration
onReady	() => void	-	Ready callback
onChange	(e: ChangeEvent) => void	-	Change callback
onError	(e: ErrorEvent) => void	-	Error callback

Vue Component

<WordFidelityEditorVue
  lang="en"
  :show-toolbar="true"
  profile="knowledge-base"
  @ready="onReady"
  @change="onChange"
  @error="onError"
/>

Props

Prop	Type	Default	Description
lang	string	'en'	UI language
showToolbar	boolean	false	Show toolbar
profile	string	'default'	Processing profile
config	EngineConfig	{}	Engine configuration

Events

Event	Payload	Description
ready	{}	Editor ready
change	{ htmlSnapshot, textContent }	Content changed
error	{ error }	Error occurred

Events

docsjs-change

Fired when content changes.

editor.addEventListener("docsjs-change", (e) => {
  const { htmlSnapshot, textContent } = e.detail;
});

docsjs-ready

Fired when the editor is ready.

editor.addEventListener("docsjs-ready", () => {
  console.log("Ready!");
});

docsjs-error

Fired when an error occurs.

editor.addEventListener("docsjs-error", (e) => {
  const { error } = e.detail;
  console.error(error);
});

Types

EngineConfig

interface EngineConfig {
  profile?: string;
  plugins?: PluginConfig[];
  security?: SecurityConfig;
  performance?: PerformanceConfig;
}

PluginConfig

interface PluginConfig {
  name: string;
  version?: string;
  availableHooks: HookName[];
  permissions?: PluginPermissions;
  beforeParse?: (context: PluginContext) => PluginContext;
  afterParse?: (context: PluginContext) => PluginContext;
  beforeTransform?: (context: PluginContext) => PluginContext;
  afterTransform?: (context: PluginContext) => PluginContext;
  beforeRender?: (context: PluginContext) => PluginContext;
  afterRender?: (context: PluginContext) => PluginContext;
  beforeExport?: (context: PluginContext) => PluginContext;
  afterExport?: (context: PluginContext) => PluginContext;
}

type HookName =
  | "beforeParse"
  | "afterParse"
  | "beforeTransform"
  | "afterTransform"
  | "beforeRender"
  | "afterRender"
  | "beforeExport"
  | "afterExport";

PluginPermissions

interface PluginPermissions {
  read?: string[];
  write?: string[];
  network?: boolean;
  compute?: {
    maxMemoryMB?: number;
    maxCpuSecs?: number;
  };
  ast?: {
    canModifySemantics?: boolean;
    canAccessOriginal?: boolean;
    canExportRawAst?: boolean;
  };
  export?: {
    canGenerateFiles?: boolean;
    canUpload?: boolean;
  };
  misc?: {
    allowUnsafeCode?: boolean;
  };
}

ProfileConfig

interface ProfileConfig {
  id: string;
  name: string;
  description?: string;
  parse?: ParseConfig;
  transform?: TransformConfig;
  render?: RenderConfig;
  security?: SecurityConfig;
}

TransformResult

interface TransformResult {
  output: string;
  diagnostics: Diagnostic[];
  metrics: PerformanceMetrics;
}

interface Diagnostic {
  type: "error" | "warning" | "info";
  message: string;
  location?: {
    line: number;
    column: number;
  };
}

interface PerformanceMetrics {
  parseTime: number;
  transformTime: number;
  renderTime: number;
  totalTime: number;
}

Built-in Profiles

Profile ID	Description
default	Balanced performance vs fidelity
knowledge-base	High-fidelity, MathML support, tables
exam-paper	Question extraction, strict semantic parsing
enterprise-document	Security, compliance, sanitization

Next Steps

• Core Engine API - Detailed engine documentation
• Components API - Component reference
• Events API - Event handling
• Types - Complete type reference