DocAuthSystem

DocAuthSystem:

{
  getFragmentContract(): FragmentContract;
  validateFragment(value: unknown): FragmentValidationResult;
  loadDocument(documentInput: DocAuthDocumentInput): Promise<DocAuthDocument>;
  importDOCX(docx: BlobInput, options?: ImportDOCXOptions): Promise<DocAuthDocument>;
  import(blob: BlobInput, options?: ImportConfig): Promise<DocAuthDocument>;
  createEditor(target: HTMLElement, options?: CreateEditorOptions): Promise<DocAuthEditor>;
  createDocumentFromPlaintext(text: string, options?: CreateDocumentFromPlaintextOptions): Promise<DocAuthDocument>;
  destroy(): void;
}

A DocAuthSystem instance holds the internal WASM engine and loaded fonts. It is used to load or import documents and create DocAuthEditor instances.

See

Getting started guide

Methods

getFragmentContract()

getFragmentContract(): FragmentContract

Returns the validation contract for structured fragments returned by this SDK version.

Returns

FragmentContract

validateFragment()

validateFragment(value): FragmentValidationResult

Validates an opaque structured fragment against the current contract without changing the value. Returns validation failures as structured issues instead of throwing.

Parameters

value

unknown

Returns

FragmentValidationResult

loadDocument()

Call Signature

loadDocument(documentInput): Promise<DocAuthDocument>

Loads a document stored in the Document Authoring format. The document can be provided as a JSON string or a JavaScript object.

Parameters

documentInput

DocAuthDocumentInput

Returns

Promise<DocAuthDocument>

Examples

// Load from JSON string
const doc = await system.loadDocument('{"version":"7.0","content":[...]}');

// Load from object
const docData = { version: '7.0', content: [...] };
const doc = await system.loadDocument(docData);

// Load from server
const doc = await system.loadDocument(fetch('/api/documents/123'));

// Load and create editor
const doc = await system.loadDocument(savedDocJSON);
const editor = await system.createEditor(targetElement, { document: doc });

Use the optional participant load option to set the author label and access role for the document. If omitted, the document uses an owner with an empty author label. Hosts must bind the label to an authenticated user themselves; the SDK does not authenticate.

See

DocJSON guide
DocAuthDocumentInput for supported input types.

Call Signature

loadDocument(documentInput, options?): Promise<DocAuthDocument>

Loads a document stored in a native Document Authoring format. The input can be a JSON string, a JavaScript object, a Blob/Response carrying JSON, or a Promise resolving to one of those.

format: 'docjson' (the default) parses the canonical DocJSON wire format.
format: 'fragment' parses the wire format produced by DocAuthDocument.saveDocument with format: 'fragment' (or by DocAuthEditor.getSelectionContent with format: 'fragment'), and wraps it in a new document. The complete fragment is validated against the generated active contract before any model or resource import; invalid input rejects the returned promise. Section structure (page setup, headers/footers, etc.) is reconstructed from the fragment’s trailing section break, or defaulted if absent. Document-level state that doesn’t ride along in a fragment (comment threads, document settings, imported-DOCX metadata) is initialised empty.

Parameters

importDOCX()

importDOCX(docx, options?): Promise<DocAuthDocument>

Imports a DOCX document.

Parameters

docx

BlobInput

options?

ImportDOCXOptions

Returns

Promise<DocAuthDocument>

Examples

// Import from file input
const fileInput = document.querySelector('input[type="file"]');
const file = fileInput.files[0];
const doc = await system.importDOCX(file);

// Import from URL
const doc = await system.importDOCX(fetch('/documents/template.docx'));

// Import with abort signal
const controller = new AbortController();
const doc = await system.importDOCX(file, {
  abortSignal: controller.signal,
});

// Complete workflow: import DOCX, edit, export PDF
const doc = await system.importDOCX(fetch('/template.docx'));
const editor = await system.createEditor(targetElement, { document: doc });
// ... user edits document ...
const pdfBuffer = await editor.currentDocument().exportPDF();

See

DOCX import guide
BlobInput for supported input types.

import()

>= v1.12.0

import(blob, options?): Promise<DocAuthDocument>

Imports a document by automatically detecting its format from the binary content (and optionally the file name or file type).

Supported import formats: DOCX (including DOTX, DOCM), RTF, ODT, Markdown, TXT, DocJSON, and images (PNG, JPEG, BMP, GIF, WebP).

Throws if the format is unsupported or the file is corrupted.

Parameters

blob

BlobInput

options?

ImportConfig

Returns

Promise<DocAuthDocument>

Examples

// Import with automatic format detection
const document = await system.import(file, { fileName: 'report.docx' });
const editor = await system.createEditor(target, { document });

// Import with explicit file type (skips auto-detection)
const document = await system.import(blob, { format: 'docx' });

// Import from URL
const response = await fetch('/documents/template.docx');
const document = await system.import(response, { fileName: 'template.docx' });

See

ImportFileFormat
BlobInput for supported input types.

createEditor()

createEditor(target, options?): Promise<DocAuthEditor>

Creates an editor in the specified HTML element. IMPORTANT: The position of the target element cannot be static or unset. If unsure, use relative.

Browser only: systems created through the Node.js entry (@nutrient-sdk/document-authoring/node) are headless, and calling this method on them throws.

Parameters

target

HTMLElement

options?

CreateEditorOptions

Returns

Promise<DocAuthEditor>

Examples

// Shared code for the examples below - ensure target element has proper positioning
const target = document.getElementById('editor');
target.style.position = 'relative';
target.style.height = '600px';

// Create editor with empty document
const editor = await system.createEditor(target);

// Create editor with existing document
const doc = await system.loadDocument(docJSON);
const editor = await system.createEditor(target, { document: doc });

// Complete workflow with event handling
const editor = await system.createEditor(target);
editor.on('content.change', async () => {
  const doc = await editor.currentDocument().saveDocument();
  localStorage.setItem('draft', JSON.stringify(doc));
});

See

Getting started guide
CreateEditorOptions for available options.

createDocumentFromPlaintext()

createDocumentFromPlaintext(text, options?): Promise<DocAuthDocument>

Creates a document from plain text by interpreting patterns and replacing characters. E.g.:

\n creates a line break in a paragraph
\n\n separates paragraphs
\t is replaced with spaces

Parameters

text

string

options?

CreateDocumentFromPlaintextOptions

Returns

Promise<DocAuthDocument>

Examples

// Simple text document
const doc = await system.createDocumentFromPlaintext('Hello World');

// Multi-paragraph document
const text = `First paragraph.

Second paragraph with line break\nand continuation.`;
const doc = await system.createDocumentFromPlaintext(text);

// With custom page settings
const doc = await system.createDocumentFromPlaintext('My content', {
  pageSize: 'A4',
  pageMargins: { left: 72, right: 72, top: 72, bottom: 72 },
});

// Create document and editor in one flow
const doc = await system.createDocumentFromPlaintext('Initial content');
const editor = await system.createEditor(targetElement, { document: doc });

See

CreateDocumentFromPlaintextOptions for available options.

destroy()

destroy(): void

Releases resources held by the system. IMPORTANT: The system and any editors created by this system can no longer be used after calling this.

Returns

void

Example

// Clean up when done
editor.destroy();
system.destroy();

// Or use try-finally pattern
const system = await createDocAuthSystem();
try {
  const editor = await system.createEditor(target);
  // ... use editor ...
  editor.destroy();
} finally {
  system.destroy();
}