@nutrient-sdk/document-authoring 1.8.0 → 1.9.0-preview.202508262146.00d4b4b113b716d41439d1b4930563b2d82f1465

package/README.md

@@ -78,7 +78,7 @@ the SDK via `npm`).
 
 ### Example
 
-You can download an example project demoing both TypeScript and JavaScript integration from [here](https://document-authoring.cdn.nutrient.io/releases/document-authoring-1.8.0-example.zip), unzip it and run:
+You can download an example project demoing both TypeScript and JavaScript integration from [here](https://document-authoring.cdn.staging.nutrient.io/releases/document-authoring-1.9.0-preview.202508262146.00d4b4b113b716d41439d1b4930563b2d82f1465-example.zip), unzip it and run:
 
 ```bash
 npm install
@@ -92,7 +92,7 @@ By default, the Document Authoring SDK will fetch the required files (fonts, emo
 
 ### Self-hosting the assets
 
-To host the assets on your own infrastructure you can download them from [here](https://document-authoring.cdn.nutrient.io/releases/document-authoring-1.8.0-assets.zip) and deploy them to a suitable location.
+To host the assets on your own infrastructure you can download them from [here](https://document-authoring.cdn.staging.nutrient.io/releases/document-authoring-1.9.0-preview.202508262146.00d4b4b113b716d41439d1b4930563b2d82f1465-assets.zip) and deploy them to a suitable location.
 Provide an appropriate base path when initializing the Document Authoring SDK.
 
 #### Example:

package/lib/docauth.mjs

@@ -1,4 +1,4 @@
-const t={type:"default-index"},e=async t=>(await(async t=>{const e=new URL(t??"https://document-authoring.cdn.nutrient.io/2025/1/",window.location.href).href,a=new URL("docauth-impl-2e14989b0a9b1796.js",e).href;return import(
+const t={type:"default-index"},e=async t=>(await(async t=>{const e=new URL(t??"https://document-authoring.cdn.staging.nutrient.io/2025/1/",window.location.href).href,n=new URL("docauth-impl-189f1c547985c1c6.js",e).href;return import(
 /*webpackIgnore: true*/
 /* @vite-ignore */
-a)})(t?.assets?.base)).createDocAuthSystem(t);var a={createDocAuthSystem:e,defaultFontIndex:t};export{e as createDocAuthSystem,a as default,t as defaultFontIndex};
+n)})(t?.assets?.base)).createDocAuthSystem(t);var n={createDocAuthSystem:e,defaultFontIndex:t};export{e as createDocAuthSystem,n as default,t as defaultFontIndex};

package/lib/docauth.umd.js

@@ -1,4 +1,4 @@
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).DocAuth={})}(this,(function(e){"use strict";const t={type:"default-index"},n=async e=>(await(async e=>{const t=new URL(e??"https://document-authoring.cdn.nutrient.io/2025/1/",window.location.href).href,n=new URL("docauth-impl-2e14989b0a9b1796.js",t).href;return import(
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).DocAuth={})}(this,(function(e){"use strict";const t={type:"default-index"},n=async e=>(await(async e=>{const t=new URL(e??"https://document-authoring.cdn.staging.nutrient.io/2025/1/",window.location.href).href,n=new URL("docauth-impl-189f1c547985c1c6.js",t).href;return import(
 /*webpackIgnore: true*/
 /* @vite-ignore */
 n)})(e?.assets?.base)).createDocAuthSystem(e);var o={createDocAuthSystem:n,defaultFontIndex:t};e.createDocAuthSystem=n,e.default=o,e.defaultFontIndex=t,Object.defineProperty(e,"__esModule",{value:!0})}));

package/lib/index.d.cts

@@ -1,3 +1,5 @@
+import * as JsonDiffTs from 'json-diff-ts';
+
 /**
  * @public
  */
@@ -80,8 +82,14 @@ export declare type CreateEditorOptions = {
      * See {@link UIOptions}
      */
     ui?: UIOptions;
-
-
+    /**
+     * @internal
+     */
+    __hideDOCXDownload?: boolean;
+    /**
+     * @internal
+     */
+    __hidePDFDownload?: boolean;
 };
 
 /**
@@ -136,7 +144,12 @@ export declare type DocAuthDocument = {
      * Exports a snapshot of the current document as a DOCX file.
      */
     exportDOCX(options?: ExportDOCXOptions): Promise<ArrayBuffer>;
-
+    __athenaSetJSONDiffHandler(handler: (diff: JsonDiffTs.IChange[]) => void): void;
+    __athenaApplyJSONDiff(diffGetter: () => JsonDiffTs.IChange[]): void;
+    /**
+     * @alpha
+     */
+    transaction<T = void>(callback: TransactionCallback<T>): Promise<T>;
     /**
      * The `DocAuthSystem` this document is bound to.
      */
@@ -173,7 +186,15 @@ export declare type DocAuthEditor = {
      * Retrieves the `DocAuthSystem` instance this editor is bound to.
      */
     docAuthSystem(): DocAuthSystem;
-
+    /**
+     * Inserts text at the current cursor position.
+     * If there's a selection, it will be replaced with the provided text.
+     *
+     * @param text - The text to insert at the cursor position
+     *
+     * @internal
+     */
+    insertTextAtCursor(text: string): void;
     /**
      * Adds an event listener that will be called every time the specified event is emitted.
      *
@@ -420,6 +441,190 @@ export declare type ImportDOCXOptions = {
  */
 export declare type Locale = 'en' | 'fr' | 'de';
 
+/**
+ * @alpha
+ */
+export declare namespace Programmatic {
+    export type Range = {
+        begin: number;
+        end?: number;
+    };
+    export type Formatting = {
+        font: string | null;
+        fontSize: number | null;
+        bold: boolean | null;
+        italic: boolean | null;
+        color: string | null;
+        highlight: string | null;
+        strikeout: boolean | null;
+        underline: boolean | null;
+    };
+    export type SearchFor = string | RegExp;
+    export type Replacement = {
+        text?: string;
+        formatting?: Partial<Formatting>;
+    };
+    export type ReplaceFn = (value: string) => Replacement | string;
+    export type ReplacementOrReplaceFn = Replacement | ReplaceFn | string;
+    export type ReplaceTextSignature = (searchFor: SearchFor, replace: ReplacementOrReplaceFn) => number;
+    export type SearchResult = {
+        range: Range;
+        text: string;
+    };
+    export type TextView = {
+        getPlainText(range?: Range): string;
+        searchText(searchFor: SearchFor, after?: Range): SearchResult | undefined;
+        replaceText: ReplaceTextSignature;
+        setText(value: string, range?: Range): Range;
+        setFormatting(formatting: Partial<Formatting>, range?: Range): void;
+        inlines(): RangeInline[];
+        addLineBreak(insertionPoint?: {
+            placement: 'before' | 'after';
+            range: Range;
+        }): LineBreak;
+        addInlineText(text: string, insertionPoint?: {
+            placement: 'before' | 'after';
+            range: Range;
+        }): InlineText;
+        removeInline(index?: number): Inline | undefined;
+    };
+    export type Extent = {
+        width: number;
+        height: number;
+    };
+    export type Image = {
+        type: 'image';
+        extent(): Extent;
+        setExtent(extent: Partial<Extent>): void;
+    };
+    export type Field = {
+        type: 'field';
+    };
+    export type Footnote = {
+        type: 'footnote';
+    };
+    export type FootnoteRef = {
+        type: 'footnote/ref';
+    };
+    export type Endnote = {
+        type: 'endnote';
+    };
+    export type EndnoteRef = {
+        type: 'endnote/ref';
+    };
+    export type LineBreak = {
+        type: 'line-break';
+    };
+    export type PageBreak = {
+        type: 'page-break';
+    };
+    export type Tab = {
+        type: 'tab';
+    };
+    export type Separator = {
+        type: 'sep';
+    };
+    export type InlineText = {
+        type: 'text';
+        plainText(): string;
+        formatting(): Formatting;
+    };
+    export type Inline = InlineText | Tab | Separator | LineBreak | PageBreak | Image | Field | Footnote | FootnoteRef | Endnote | EndnoteRef;
+    export type RangeInline = {
+        range: Range;
+        inline: Inline;
+    };
+    export type Paragraph = {
+        type: 'paragraph';
+        asTextView(): TextView;
+        replaceText: ReplaceTextSignature;
+    };
+    export type TableCell = BlockLevelContainer;
+    export type TableRow = {
+        cells(): TableCell[];
+        addCell(index?: number): TableCell;
+        removeCell(index: number): TableCell | undefined;
+        replaceText: ReplaceTextSignature;
+    };
+    export type Table = {
+        type: 'table';
+        rows(): TableRow[];
+        addRow(index?: number): TableRow;
+        removeRow(index: number): TableRow | undefined;
+        replaceText: ReplaceTextSignature;
+    };
+    export type BlockLevel = Paragraph | Table;
+    export type BlockLevelContainer = {
+        blocklevels(): BlockLevel[];
+        addParagraph(index?: number): Paragraph;
+        addTable(index?: number): Table;
+        removeElement(index: number): BlockLevel | undefined;
+        replaceText: ReplaceTextSignature;
+    };
+    export type PageSize = {
+        width: number;
+        height: number;
+    };
+    export type PageMargins = {
+        left: number;
+        right: number;
+        top: number;
+        bottom: number;
+    };
+    export type PageSetup = {
+        setPageSize(size: Partial<PageSize>): void;
+        setPageMargins(margins: Partial<PageMargins>): void;
+        pageSize(): PageSize;
+        pageMargins(): PageMargins;
+    };
+    export type HeaderFooter = BlockLevelContainer;
+    export type HeadersFooters = {
+        default(): HeaderFooter | null;
+        first(): HeaderFooter | null;
+        even(): HeaderFooter | null;
+        replaceText: ReplaceTextSignature;
+    };
+    export type HeadersAndFooters = {
+        headers(): HeadersFooters;
+        footers(): HeadersFooters;
+        replaceText: ReplaceTextSignature;
+    };
+    export type Section = {
+        pageSetup(): PageSetup;
+        headersAndFooters(): HeadersAndFooters;
+        content(): BlockLevelContainer;
+    };
+    export type Body = {
+        sections(): Section[];
+        addSection(index?: number): Section;
+        removeSection(index: number): Section | undefined;
+        replaceText: ReplaceTextSignature;
+    };
+    export type Document = {
+        body(): Body;
+        replaceText: ReplaceTextSignature;
+    };
+        {};
+}
+
+/**
+ * @alpha
+ */
+export declare type TransactionCallback<T = void> = (context: {
+    draft: Programmatic.Document;
+}) => Promise<TransactionResult<T>>;
+
+/**
+ * @alpha
+ */
+export declare type TransactionResult<T = void> = undefined | boolean | {
+    commit: boolean;
+    result: T;
+} | Promise<undefined | boolean | {
+    commit: boolean;
+    result: T;
+}>;
+
 /**
  * Configuration options for the user interface.
  *
@@ -451,7 +656,16 @@ export declare type UIOptions = {
          */
         enabled: boolean;
     };
-
+    /**
+     * @internal
+     *
+     * Initial zoom level for the editor.
+     *
+     * Valid range is 0.5 to 4.0.
+     *
+     * @defaultValue `1`
+     */
+    initialZoom?: number;
 };
 
 /**

package/lib/index.d.mts

@@ -1,3 +1,5 @@
+import * as JsonDiffTs from 'json-diff-ts';
+
 /**
  * @public
  */
@@ -80,8 +82,14 @@ export declare type CreateEditorOptions = {
      * See {@link UIOptions}
      */
     ui?: UIOptions;
-
-
+    /**
+     * @internal
+     */
+    __hideDOCXDownload?: boolean;
+    /**
+     * @internal
+     */
+    __hidePDFDownload?: boolean;
 };
 
 /**
@@ -136,7 +144,12 @@ export declare type DocAuthDocument = {
      * Exports a snapshot of the current document as a DOCX file.
      */
     exportDOCX(options?: ExportDOCXOptions): Promise<ArrayBuffer>;
-
+    __athenaSetJSONDiffHandler(handler: (diff: JsonDiffTs.IChange[]) => void): void;
+    __athenaApplyJSONDiff(diffGetter: () => JsonDiffTs.IChange[]): void;
+    /**
+     * @alpha
+     */
+    transaction<T = void>(callback: TransactionCallback<T>): Promise<T>;
     /**
      * The `DocAuthSystem` this document is bound to.
      */
@@ -173,7 +186,15 @@ export declare type DocAuthEditor = {
      * Retrieves the `DocAuthSystem` instance this editor is bound to.
      */
     docAuthSystem(): DocAuthSystem;
-
+    /**
+     * Inserts text at the current cursor position.
+     * If there's a selection, it will be replaced with the provided text.
+     *
+     * @param text - The text to insert at the cursor position
+     *
+     * @internal
+     */
+    insertTextAtCursor(text: string): void;
     /**
      * Adds an event listener that will be called every time the specified event is emitted.
      *
@@ -420,6 +441,190 @@ export declare type ImportDOCXOptions = {
  */
 export declare type Locale = 'en' | 'fr' | 'de';
 
+/**
+ * @alpha
+ */
+export declare namespace Programmatic {
+    export type Range = {
+        begin: number;
+        end?: number;
+    };
+    export type Formatting = {
+        font: string | null;
+        fontSize: number | null;
+        bold: boolean | null;
+        italic: boolean | null;
+        color: string | null;
+        highlight: string | null;
+        strikeout: boolean | null;
+        underline: boolean | null;
+    };
+    export type SearchFor = string | RegExp;
+    export type Replacement = {
+        text?: string;
+        formatting?: Partial<Formatting>;
+    };
+    export type ReplaceFn = (value: string) => Replacement | string;
+    export type ReplacementOrReplaceFn = Replacement | ReplaceFn | string;
+    export type ReplaceTextSignature = (searchFor: SearchFor, replace: ReplacementOrReplaceFn) => number;
+    export type SearchResult = {
+        range: Range;
+        text: string;
+    };
+    export type TextView = {
+        getPlainText(range?: Range): string;
+        searchText(searchFor: SearchFor, after?: Range): SearchResult | undefined;
+        replaceText: ReplaceTextSignature;
+        setText(value: string, range?: Range): Range;
+        setFormatting(formatting: Partial<Formatting>, range?: Range): void;
+        inlines(): RangeInline[];
+        addLineBreak(insertionPoint?: {
+            placement: 'before' | 'after';
+            range: Range;
+        }): LineBreak;
+        addInlineText(text: string, insertionPoint?: {
+            placement: 'before' | 'after';
+            range: Range;
+        }): InlineText;
+        removeInline(index?: number): Inline | undefined;
+    };
+    export type Extent = {
+        width: number;
+        height: number;
+    };
+    export type Image = {
+        type: 'image';
+        extent(): Extent;
+        setExtent(extent: Partial<Extent>): void;
+    };
+    export type Field = {
+        type: 'field';
+    };
+    export type Footnote = {
+        type: 'footnote';
+    };
+    export type FootnoteRef = {
+        type: 'footnote/ref';
+    };
+    export type Endnote = {
+        type: 'endnote';
+    };
+    export type EndnoteRef = {
+        type: 'endnote/ref';
+    };
+    export type LineBreak = {
+        type: 'line-break';
+    };
+    export type PageBreak = {
+        type: 'page-break';
+    };
+    export type Tab = {
+        type: 'tab';
+    };
+    export type Separator = {
+        type: 'sep';
+    };
+    export type InlineText = {
+        type: 'text';
+        plainText(): string;
+        formatting(): Formatting;
+    };
+    export type Inline = InlineText | Tab | Separator | LineBreak | PageBreak | Image | Field | Footnote | FootnoteRef | Endnote | EndnoteRef;
+    export type RangeInline = {
+        range: Range;
+        inline: Inline;
+    };
+    export type Paragraph = {
+        type: 'paragraph';
+        asTextView(): TextView;
+        replaceText: ReplaceTextSignature;
+    };
+    export type TableCell = BlockLevelContainer;
+    export type TableRow = {
+        cells(): TableCell[];
+        addCell(index?: number): TableCell;
+        removeCell(index: number): TableCell | undefined;
+        replaceText: ReplaceTextSignature;
+    };
+    export type Table = {
+        type: 'table';
+        rows(): TableRow[];
+        addRow(index?: number): TableRow;
+        removeRow(index: number): TableRow | undefined;
+        replaceText: ReplaceTextSignature;
+    };
+    export type BlockLevel = Paragraph | Table;
+    export type BlockLevelContainer = {
+        blocklevels(): BlockLevel[];
+        addParagraph(index?: number): Paragraph;
+        addTable(index?: number): Table;
+        removeElement(index: number): BlockLevel | undefined;
+        replaceText: ReplaceTextSignature;
+    };
+    export type PageSize = {
+        width: number;
+        height: number;
+    };
+    export type PageMargins = {
+        left: number;
+        right: number;
+        top: number;
+        bottom: number;
+    };
+    export type PageSetup = {
+        setPageSize(size: Partial<PageSize>): void;
+        setPageMargins(margins: Partial<PageMargins>): void;
+        pageSize(): PageSize;
+        pageMargins(): PageMargins;
+    };
+    export type HeaderFooter = BlockLevelContainer;
+    export type HeadersFooters = {
+        default(): HeaderFooter | null;
+        first(): HeaderFooter | null;
+        even(): HeaderFooter | null;
+        replaceText: ReplaceTextSignature;
+    };
+    export type HeadersAndFooters = {
+        headers(): HeadersFooters;
+        footers(): HeadersFooters;
+        replaceText: ReplaceTextSignature;
+    };
+    export type Section = {
+        pageSetup(): PageSetup;
+        headersAndFooters(): HeadersAndFooters;
+        content(): BlockLevelContainer;
+    };
+    export type Body = {
+        sections(): Section[];
+        addSection(index?: number): Section;
+        removeSection(index: number): Section | undefined;
+        replaceText: ReplaceTextSignature;
+    };
+    export type Document = {
+        body(): Body;
+        replaceText: ReplaceTextSignature;
+    };
+        {};
+}
+
+/**
+ * @alpha
+ */
+export declare type TransactionCallback<T = void> = (context: {
+    draft: Programmatic.Document;
+}) => Promise<TransactionResult<T>>;
+
+/**
+ * @alpha
+ */
+export declare type TransactionResult<T = void> = undefined | boolean | {
+    commit: boolean;
+    result: T;
+} | Promise<undefined | boolean | {
+    commit: boolean;
+    result: T;
+}>;
+
 /**
  * Configuration options for the user interface.
  *
@@ -451,7 +656,16 @@ export declare type UIOptions = {
          */
         enabled: boolean;
     };
-
+    /**
+     * @internal
+     *
+     * Initial zoom level for the editor.
+     *
+     * Valid range is 0.5 to 4.0.
+     *
+     * @defaultValue `1`
+     */
+    initialZoom?: number;
 };
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nutrient-sdk/document-authoring",
-	"version": "1.8.0",
+	"version": "1.9.0-preview.202508262146.00d4b4b113b716d41439d1b4930563b2d82f1465",
 	"description": "A web SDK for word processing and rich text capabilities.",
 	"type": "commonjs",
 	"main": "lib/docauth.umd.js",