jodit 3.15.2 → 3.16.2

package/types/modules/{observer/observer.d.ts → history/history.d.ts}

@@ -4,17 +4,18 @@
  * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
 /**
- * [[include:modules/observer/README.md]]
+ * [[include:modules/history/README.md]]
  * @packageDocumentation
- * @module modules/observer
+ * @module modules/history
  */
-import type { IJodit, SnapshotType, IObserver } from 'jodit/types';
+import type { IJodit, SnapshotType, IHistory, ISnapshot, IDestructible } from 'jodit/types';
 import { ViewComponent } from 'jodit/core/component';
 import { Snapshot } from './snapshot';
 import { Stack } from './stack';
 declare module 'jodit/config' {
     interface Config {
-        observer: {
+        history: {
+            enable: boolean;
             /**
              * Limit of history length
              */
@@ -24,25 +25,31 @@ declare module 'jodit/config' {
              */
             timeout: number;
         };
+        /**
+         * @deprecated Instead use `history`
+         */
+        observer: this['history'];
     }
 }
 /**
  * The module monitors the status of the editor and creates / deletes the required number of Undo / Redo shots .
  */
-export declare class Observer extends ViewComponent<IJodit> implements IObserver {
+export declare class History extends ViewComponent<IJodit> implements IHistory {
     /** @override */
     className(): string;
     private __startValue;
     protected get startValue(): SnapshotType;
     protected set startValue(value: SnapshotType);
-    stack: Stack;
-    snapshot: Snapshot;
+    private readonly stack;
+    snapshot: ISnapshot & IDestructible;
+    constructor(editor: IJodit, stack?: Stack, snapshot?: Snapshot);
     private updateTick;
     upTick(): void;
     /**
      * Push new command in stack on some changes
      */
     private onChange;
+    processChanges(): void;
     /**
      * Update history stack
      */
@@ -51,13 +58,14 @@ export declare class Observer extends ViewComponent<IJodit> implements IObserver
      * Return state of the WYSIWYG editor to step back
      */
     redo(): void;
+    canRedo(): boolean;
     /**
      * Return the state of the WYSIWYG editor to step forward
      */
     undo(): void;
+    canUndo(): boolean;
     clear(): void;
-    replaceSnapshot(): void;
+    get length(): number;
     private fireChangeStack;
-    constructor(editor: IJodit);
     destruct(): void;
 }

package/types/modules/{observer → history}/snapshot.d.ts

@@ -4,7 +4,7 @@
  * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
 /**
- * @module modules/observer
+ * @module modules/history
  */
 import type { IJodit, ISnapshot, SnapshotType } from 'jodit/types';
 import { ViewComponent } from 'jodit/core/component';

package/types/modules/{observer → history}/stack.d.ts

@@ -4,13 +4,13 @@
  * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
 /**
- * @module modules/observer
+ * @module modules/history
  */
 import type { CanUndef, IStack } from 'jodit/types';
 import type { Command } from './command';
 export declare class Stack implements IStack {
-    private size;
-    private commands;
+    private readonly size;
+    private readonly commands;
     private stackPosition;
     constructor(size: number);
     get length(): number;

package/types/modules/image-editor/image-editor.d.ts

@@ -87,7 +87,7 @@ export declare class ImageEditor extends ViewComponent {
      * Open image editor
      * @example
      * ```javascript
-     * var jodit = new Jodit('.editor', {
+     * var jodit = Jodit.make('.editor', {
      *		 imageeditor: {
      *				 crop: false,
      *				 closeAfterSave: true,

package/types/modules/index.d.ts

@@ -14,7 +14,7 @@ export * from '../core/request';
 export { Component, ViewComponent, STATUSES } from '../core/component';
 export { ContextMenu } from './context-menu/context-menu';
 export * from './dialog/';
-export { Dom } from '../core/dom';
+export { Dom, LazyWalker } from '../core/dom';
 export { Plugin } from '../core/plugin';
 export { Create } from '../core/create';
 export { UIElement, UIButton, Popup, UISeparator, UIGroup, UIList, UIForm, UIInput, UITextArea, UICheckbox, UIBlock, ProgressBar, Icon } from '../core/ui';
@@ -24,9 +24,9 @@ export * from './file-browser';
 import * as Helpers from '../core/helpers/';
 export { Helpers };
 export { ImageEditor } from './image-editor/image-editor';
-export { Observer } from './observer/observer';
+export { History } from './history/history';
+export { Snapshot } from './history/snapshot';
 export { Select, CommitStyle } from '../core/selection';
-export { Snapshot } from './observer/snapshot';
 export { StatusBar } from './status-bar/status-bar';
 export { Table } from './table/table';
 export { ToolbarEditorCollection } from './toolbar/collection/editor-collection';

package/types/modules/toolbar/button/button.d.ts

@@ -16,7 +16,7 @@ export declare class ToolbarButton<T extends IViewBased = IViewBased> extends UI
     readonly target: Nullable<HTMLElement>;
     /** @override */
     className(): string;
-    state: {
+    readonly state: {
         theme: string;
         currentValue: string;
         hasTrigger: boolean;
@@ -27,9 +27,6 @@ export declare class ToolbarButton<T extends IViewBased = IViewBased> extends UI
         type: "button" | "submit";
         disabled: boolean;
         activated: boolean;
-        /**
-         * Get parent toolbar
-         */
         icon: import("jodit/types").IUIIconState;
         text: string;
         tooltip: string;
@@ -59,7 +56,7 @@ export declare class ToolbarButton<T extends IViewBased = IViewBased> extends UI
     /** @override */
     protected onChangeText(): void;
     /** @override */
-    onChangeTabIndex(): void;
+    protected onChangeTabIndex(): void;
     protected onChangeTooltip(): void;
     /** @override */
     protected createContainer(): HTMLElement;

package/types/modules/widget/tabs/tabs.d.ts

@@ -33,6 +33,6 @@ export interface TabOption {
  * ]);
  * ```
  */
-export declare const TabsWidget: (editor: IJodit, tabs: TabOption[], state?: {
+export declare const TabsWidget: (jodit: IJodit, tabs: TabOption[], state?: {
     __activeTab: string;
 } | undefined) => HTMLDivElement;

package/types/plugins/class-span/class-span.d.ts

@@ -12,7 +12,7 @@ import { Plugin } from 'jodit/core/plugin';
  * Applying some className to selected text.
  * @example
  * ```js
- * const editor = new Jodit('#editor', {
+ * const editor = Jodit.make('#editor', {
  *	controls: {
  *		classSpan: {
  *			list: {

package/types/plugins/clipboard/paste/config.d.ts

@@ -3,6 +3,10 @@
  * Released under MIT see LICENSE.txt in the project root for license information.
  * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
+/**
+ * @module plugins/clipboard/paste
+ */
+import type { IUIOption } from 'jodit/types';
 import type { InsertMode } from 'jodit/plugins/clipboard/paste/interface';
 declare module 'jodit/config' {
     interface Config {
@@ -32,5 +36,9 @@ declare module 'jodit/config' {
          * Draggable elements
          */
         draggableTags: string | string[];
+        /**
+         * Options when inserting HTML string
+         */
+        pasteHTMLActionList: IUIOption[];
     }
 }

package/types/plugins/clipboard/paste/helpers.d.ts

@@ -6,7 +6,7 @@
 /**
  * @module plugins/clipboard/paste
  */
-import type { IJodit, Nullable } from 'jodit/types';
+import type { IJodit, IUIOption, Nullable } from 'jodit/types';
 import type { PasteEvent, InsertMode } from 'jodit/plugins/clipboard/paste/interface';
 import { Dialog } from 'jodit/modules';
 /**
@@ -24,4 +24,4 @@ export declare function getAllTypes(dt: DataTransfer): string;
 /**
  * Make command dialog
  */
-export declare function askInsertTypeDialog(jodit: IJodit, msg: string, title: string, callback: (yes: InsertMode) => void, clearButton?: string, insertText?: string): Dialog | void;
+export declare function askInsertTypeDialog(jodit: IJodit, msg: string, title: string, callback: (yes: InsertMode) => void, buttonList: IUIOption[]): Dialog | void;

package/types/plugins/clipboard/paste/interface.d.ts

@@ -13,3 +13,8 @@ export declare type PastedValue = {
     html: string | Node;
     action?: InsertMode;
 };
+export interface PastedData {
+    html?: string;
+    plain?: string;
+    rtf?: string;
+}

package/types/plugins/clipboard/paste-from-word/config.d.ts

@@ -7,6 +7,7 @@
  * @module plugins/clipboard/paste-from-word
  */
 import type { InsertMode } from 'jodit/plugins/clipboard/paste/interface';
+import type { IUIOption } from 'jodit/types';
 declare module 'jodit/config' {
     interface Config {
         /**
@@ -27,5 +28,9 @@ declare module 'jodit/config' {
          * ```
          */
         defaultActionOnPasteFromWord: InsertMode | null;
+        /**
+         * Options when inserting data from Word
+         */
+        pasteFromWordActionList: IUIOption[];
     }
 }

package/types/plugins/clipboard/paste-from-word/paste-from-word.d.ts

@@ -11,6 +11,7 @@
 import type { IJodit } from 'jodit/types';
 import type { PasteEvent, InsertMode } from 'jodit/plugins/clipboard/paste/interface';
 import { Plugin } from 'jodit/core/plugin';
+import type { PastedData } from 'jodit/plugins/clipboard/paste/interface';
 import './config';
 export declare class PasteFromWord extends Plugin {
     protected afterInit(jodit: IJodit): void;
@@ -18,9 +19,9 @@ export declare class PasteFromWord extends Plugin {
     /**
      * Try if text is Word's document fragment and try process this
      */
-    protected processWordHTML(e: PasteEvent, text: string): boolean;
+    protected processWordHTML(e: PasteEvent, text: string, texts: PastedData): boolean;
     /**
      * Clear extra styles and tags from Word's pasted text
      */
-    protected insertFromWordByType(e: PasteEvent, html: string, insertType: InsertMode): void;
+    protected insertFromWordByType(e: PasteEvent, html: string, insertType: InsertMode, texts: PastedData): void;
 }

package/types/plugins/fix/clean-html/clean-html.d.ts

@@ -0,0 +1,70 @@
+/*!
+ * Jodit Editor (https://xdsoft.net/jodit/)
+ * Released under MIT see LICENSE.txt in the project root for license information.
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+/**
+ * [[include:src/plugins/fix/clean-html/README.md]]
+ * @packageDocumentation
+ * @module plugins/fix/clean-html
+ */
+import type { IJodit } from 'jodit/types';
+import { Plugin } from 'jodit/core/plugin';
+import './config';
+/**
+ * Clean HTML after removeFormat and insertHorizontalRule command
+ */
+export declare class cleanHtml extends Plugin {
+    /** @override */
+    buttons: Plugin['buttons'];
+    /** @override */
+    protected afterInit(jodit: IJodit): void;
+    /**
+     * Replaces an element with a newer one if specified in the configuration match
+     */
+    private replaceIfMatched;
+    /**
+     * Clean HTML code on every change
+     */
+    private onChangeCleanHTML;
+    private currentSelectionNode;
+    private walker;
+    protected startWalker(): void;
+    private visitNode;
+    private allowEdit;
+    private static getHash;
+    private allowTagsHash;
+    private denyTagsHash;
+    /**
+     * Remove invisible chars if node has another chars
+     */
+    private onKeyUpCleanUp;
+    private beforeCommand;
+    /**
+     * Command: removeFormat
+     */
+    private onRemoveFormat;
+    /**
+     * For collapsed selection move cursor outside or split inline block
+     */
+    private removeFormatForCollapsedSelection;
+    /**
+     * Element has inline display mode
+     */
+    private isInlineBlock;
+    /**
+     * Remove formatting for all selected elements
+     */
+    private removeFormatForSelection;
+    private isRemovableNode;
+    private static hasNotEmptyTextSibling;
+    /**
+     * Event handler when manually assigning a value to the HTML editor.
+     */
+    protected onBeforeSetNativeEditorValue(data: {
+        value: string;
+    }): boolean;
+    protected onSafeHTML(sandBox: HTMLElement): void;
+    /** @override */
+    protected beforeDestruct(): void;
+}

package/types/plugins/fix/{clean-html.d.ts → clean-html/config.d.ts}

@@ -4,10 +4,9 @@
  * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
 /**
- * @module plugins/fix
+ * @module plugins/fix/clean-html
  */
-import type { HTMLTagNames, IDictionary, IJodit } from 'jodit/types';
-import { Plugin } from 'jodit/core/plugin';
+import type { HTMLTagNames, IDictionary } from 'jodit/types';
 declare module 'jodit/config' {
     interface Config {
         cleanHTML: {
@@ -76,57 +75,3 @@ declare module 'jodit/config' {
         };
     }
 }
-/**
- * Clean HTML after removeFormat and insertHorizontalRule command
- */
-export declare class cleanHtml extends Plugin {
-    /** @override */
-    buttons: Plugin['buttons'];
-    /** @override */
-    protected afterInit(jodit: IJodit): void;
-    /**
-     * Replaces an element with a newer one if specified in the configuration match
-     */
-    private replaceIfMatched;
-    /**
-     * Clean HTML code on every change
-     */
-    private onChangeCleanHTML;
-    private allowEdit;
-    private visitNode;
-    private static getHash;
-    private allowTagsHash;
-    private denyTagsHash;
-    /**
-     * Remove invisible chars if node has another chars
-     */
-    private onKeyUpCleanUp;
-    private beforeCommand;
-    /**
-     * Command: removeFormat
-     */
-    private onRemoveFormat;
-    /**
-     * For collapsed selection move cursor outside or split inline block
-     */
-    private removeFormatForCollapsedSelection;
-    /**
-     * Element has inline display mode
-     */
-    private isInlineBlock;
-    /**
-     * Remove formatting for all selected elements
-     */
-    private removeFormatForSelection;
-    private isRemovableNode;
-    private static hasNotEmptyTextSibling;
-    /**
-     * Event handler when manually assigning a value to the HTML editor.
-     */
-    protected onBeforeSetNativeEditorValue(data: {
-        value: string;
-    }): boolean;
-    protected onSafeHTML(sandBox: HTMLElement): void;
-    /** @override */
-    protected beforeDestruct(): void;
-}

package/types/plugins/fix/index.d.ts

@@ -0,0 +1,10 @@
+/*!
+ * Jodit Editor (https://xdsoft.net/jodit/)
+ * Released under MIT see LICENSE.txt in the project root for license information.
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+/**
+ * @module plugins/fix
+ */
+export * from './clean-html/clean-html';
+export * from './wrap-nodes/wrap-nodes';

package/types/plugins/fix/wrap-nodes/config.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Jodit Editor (https://xdsoft.net/jodit/)
+ * Released under MIT see LICENSE.txt in the project root for license information.
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+/**
+ * @module plugins/fix/wrap-nodes
+ */
+import type { HTMLTagNames } from 'jodit/types';
+declare module 'jodit/config' {
+    interface Config {
+        wrapNodes: {
+            exclude: HTMLTagNames[];
+        };
+    }
+}

package/types/plugins/fix/{wrap-text-nodes.d.ts → wrap-nodes/wrap-nodes.d.ts}

@@ -4,14 +4,17 @@
  * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
 /**
- * @module plugins/fix
+ * [[include:plugins/fix/wrap-nodes/README.md]]
+ * @packageDocumentation
+ * @module plugins/fix/wrap-nodes
  */
 import type { IJodit } from 'jodit/types';
 import { Plugin } from 'jodit/core/plugin';
+import './config';
 /**
  * Wrap single text nodes in block wrapper
  */
-export declare class WrapTextNodes extends Plugin {
+export declare class WrapNodes extends Plugin {
     /** @override **/
     protected afterInit(jodit: IJodit): void;
     /** @override **/

package/types/plugins/fullsize/fullsize.d.ts

@@ -14,13 +14,13 @@ declare module 'jodit/config' {
          * Open WYSIWYG in full screen
          * @example
          * ```javascript
-         * var editor = new jodit({
+         * var editor = Jodit.make({
          *     fullsize: true // fullsize editor
          * });
          * ```
          * @example
          * ```javascript
-         * var editor = new Jodit();
+         * var editor = Jodit.make();
          * editor.e.fire('toggleFullSize');
          * editor.e.fire('toggleFullSize', true); // fullsize
          * editor.e.fire('toggleFullSize', false); // usual mode

package/types/plugins/index.d.ts

@@ -14,8 +14,7 @@ export { focus } from './focus/focus';
 export { classSpan } from './class-span/class-span';
 export { Backspace } from './keyboard/backspace/backspace';
 export { bold } from './bold/bold';
-export { cleanHtml } from './fix/clean-html';
-export { WrapTextNodes } from './fix/wrap-text-nodes';
+export { WrapNodes, cleanHtml } from './fix';
 export { copyFormat, clipboard, paste, pasteStorage, PasteFromWord } from './clipboard';
 export { color } from './color/color';
 export { DragAndDrop } from './clipboard/drag-and-drop';
@@ -49,6 +48,7 @@ export { size, resizeHandler } from './size';
 export { source } from './source';
 export { stat } from './stat/stat';
 export { sticky } from './sticky/sticky';
+export { spellcheck } from './spellcheck/spellcheck';
 export { symbols } from './symbols/symbols';
 export * from './table';
 export { tooltip } from './tooltip/tooltip';

package/types/plugins/ordered-list/config.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * Jodit Editor (https://xdsoft.net/jodit/)
+ * Released under MIT see LICENSE.txt in the project root for license information.
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+export {};

package/types/plugins/ordered-list/ordered-list.d.ts

@@ -8,6 +8,7 @@
  */
 import type { IJodit } from 'jodit/types';
 import { Plugin } from 'jodit/core/plugin';
+import './config';
 /**
  * Process commands insertOrderedList and insertUnOrderedList
  */
@@ -17,4 +18,3 @@ export declare class orderedList extends Plugin {
     private onCommand;
     protected beforeDestruct(jodit: IJodit): void;
 }
-export declare function orderedList1(editor: IJodit): void;

package/types/plugins/print/helpers.d.ts

@@ -6,11 +6,11 @@
 /**
  * @module plugins/print
  */
-import type { IJodit } from 'jodit/types';
+import type { IJodit, Nullable } from 'jodit/types';
 /**
  * Generates a copy of an HTML document, resizes images, executes JS
  *
  * @event beforePreviewBox(string | undefined, 'pt' | 'px' | '')
  * @event afterPreviewBox(HTMLElement)
  */
-export declare function previewBox(editor: IJodit, defaultValue?: string, points?: 'pt' | 'px' | ''): HTMLElement;
+export declare function previewBox(editor: IJodit, defaultValue?: string, points?: 'pt' | 'px' | '', container?: Nullable<HTMLElement>): HTMLElement;

package/types/plugins/print/index.d.ts

@@ -6,5 +6,5 @@
 /**
  * @module plugins/print
  */
-export * from './preview';
+export * from './preview/preview';
 export * from './print';

package/types/plugins/print/{preview.d.ts → preview/preview.d.ts}

@@ -4,7 +4,7 @@
  * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
 /**
- * @module plugins/print
+ * @module plugins/print/preview
  */
 import './preview.less';
 import type { IJodit } from 'jodit/types';

package/types/plugins/search/config.d.ts

@@ -0,0 +1,36 @@
+/*!
+ * Jodit Editor (https://xdsoft.net/jodit/)
+ * Released under MIT see LICENSE.txt in the project root for license information.
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+/**
+ * @module plugins/search
+ */
+import type { FuzzySearch } from 'jodit/types';
+declare module 'jodit/config' {
+    interface Config {
+        /**
+         * Enable custom search plugin
+         * ![search](https://user-images.githubusercontent.com/794318/34545433-cd0a9220-f10e-11e7-8d26-7e22f66e266d.gif)
+         */
+        useSearch: boolean;
+        search: {
+            lazyIdleTimeout: number;
+            /**
+             * Function to search for a string within a substring. The default implementation is [[fuzzySearchIndex]]
+             * But you can write your own. It must implement the [[FuzzySearch]] interface.
+             *
+             * ```ts
+             * Jodit.make('#editor', {
+             *   search: {
+             *     fuzzySearch: (needle, haystack, offset) => {
+             *       return [haystack.indexOf(needle, offset), needle.length];
+             *     }
+             *   }
+             * })
+             * ```
+             */
+            fuzzySearch?: FuzzySearch;
+        };
+    }
+}

package/types/plugins/search/helpers/index.d.ts

@@ -0,0 +1,10 @@
+/*!
+ * Jodit Editor (https://xdsoft.net/jodit/)
+ * Released under MIT see LICENSE.txt in the project root for license information.
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+/**
+ * @module plugins/search
+ */
+export * from './sentence-finder';
+export * from './wrap-ranges-texts-in-tmp-span';

package/types/plugins/search/helpers/sentence-finder.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * Jodit Editor (https://xdsoft.net/jodit/)
+ * Released under MIT see LICENSE.txt in the project root for license information.
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+/**
+ * @module plugins/search
+ */
+import type { FuzzySearch, ISelectionRange, Nullable } from 'jodit/types';
+export interface State {
+    query: string;
+    sentence: SentenceFinder;
+}
+export declare class SentenceFinder {
+    private readonly searchIndex;
+    private queue;
+    private value;
+    constructor(searchIndex?: FuzzySearch);
+    add(node: Text): void;
+    ranges(needle: string, position?: number): Nullable<ISelectionRange[]>;
+}

package/types/plugins/search/helpers/wrap-ranges-texts-in-tmp-span.d.ts

@@ -0,0 +1,14 @@
+/*!
+ * Jodit Editor (https://xdsoft.net/jodit/)
+ * Released under MIT see LICENSE.txt in the project root for license information.
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+/**
+ * @module plugins/search
+ */
+import type { ICreate, ISelectionRange } from 'jodit/types';
+export declare function wrapRangesTextsInTmpSpan(rng: ISelectionRange, restRanges: ISelectionRange[], ci: ICreate, root: HTMLElement): void;
+export declare function getSelectionWrappers(root: HTMLElement): HTMLElement[];
+export declare function clearSelectionWrappers(root: HTMLElement): void;
+export declare function clearSelectionWrappersFromHTML(root: string): string;
+export declare function isSelectionWrapper(node: unknown): boolean;