jodit 3.12.3 → 3.13.2

package/src/core/event-emitter/observable.ts

@@ -0,0 +1,192 @@
+/*!
+ * 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 event-emitter
+ */
+
+import type {
+	CanUndef,
+	IObservable,
+	CallbackFunction,
+	IDictionary
+} from 'jodit/types';
+import { isArray, isFastEqual, isPlainObject } from 'jodit/core/helpers';
+import { getPropertyDescriptor } from 'jodit/core/decorators';
+
+const OBSERVABLE_OBJECT = Symbol('observable-object');
+
+function isObservableObject<T extends Record<string | symbol, any>>(
+	obj: T
+): obj is T & IObservable {
+	return obj[OBSERVABLE_OBJECT] !== undefined;
+}
+
+/**
+ * Makes any object an observable object
+ * @example
+ * ```js
+ * const obj = {
+ *   a: 1,
+ *   b: {
+ *     c: 5
+ *   }
+ * }
+ *
+ * const obsObj = Jodit.modules.observable(obj);
+ * console.log(obj === obsObj); // true
+ * obsObj.on('change', () => {
+ *   console.log('Object changed');
+ * });
+ * obsObj.on('change.a', () => {
+ *   console.log('Key a changed');
+ * });
+ * obsObj.on('change.b.c', () => {
+ *   console.log('Key b.c changed');
+ * });
+ *
+ * obj.a = 6;
+ * // Object changed
+ * // Key a changed
+ *
+ * obj.b = {c: 6}
+ * // Object changed
+ *
+ * obj.b.c = 8
+ * // Object changed
+ * // Key b.c changed
+ * ```
+ */
+export function observable<T extends IDictionary, O extends T & IObservable>(
+	obj: T
+): O {
+	if (isObservableObject(obj)) {
+		return obj as O;
+	}
+
+	const __lockEvent: IDictionary<boolean> = {};
+	const __onEvents: IDictionary<CallbackFunction[]> = {};
+
+	const on = (event: string | string[], callback: CallbackFunction): O => {
+		if (isArray(event)) {
+			event.map(e => on(e, callback));
+			return obj as O;
+		}
+
+		if (!__onEvents[event]) {
+			__onEvents[event] = [];
+		}
+
+		__onEvents[event].push(callback);
+
+		return obj as O;
+	};
+
+	const fire = (event: string | string[], ...attr: any[]): void => {
+		if (isArray(event)) {
+			event.map(e => fire(e, ...attr));
+			return;
+		}
+
+		try {
+			if (!__lockEvent[event] && __onEvents[event]) {
+				__lockEvent[event] = true;
+				__onEvents[event].forEach(clb => clb.call(obj, ...attr));
+			}
+		} finally {
+			__lockEvent[event] = false;
+		}
+	};
+
+	const initAccessors = <K extends IDictionary>(
+		dict: K,
+		prefixes: string[] = []
+	): void => {
+		const store = {} as K;
+
+		if (isObservableObject(dict)) {
+			return;
+		}
+
+		Object.defineProperty(dict, OBSERVABLE_OBJECT, {
+			enumerable: false,
+			value: true
+		});
+
+		Object.keys(dict).forEach(_key => {
+			const key = _key as keyof T & string;
+			const prefix = prefixes.concat(key).filter(a => a.length);
+			store[key] = dict[key];
+
+			const descriptor = getPropertyDescriptor(dict, key);
+
+			Object.defineProperty(dict, key, {
+				set: (value: CanUndef<unknown>) => {
+					const oldValue = store[key];
+					if (!isFastEqual(store[key], value)) {
+						fire(
+							[
+								'beforeChange',
+								`beforeChange.${prefix.join('.')}`
+							],
+							key,
+							value
+						);
+
+						if (isPlainObject(value)) {
+							initAccessors(value, prefix);
+						}
+
+						if (descriptor && descriptor.set) {
+							descriptor.set.call(obj, value);
+						} else {
+							store[key] = value as any;
+						}
+
+						const sum: string[] = [];
+
+						fire(
+							[
+								'change',
+								...prefix.reduce((rs, p) => {
+									sum.push(p);
+									rs.push(`change.${sum.join('.')}`);
+									return rs;
+								}, [] as string[])
+							],
+							prefix.join('.'),
+							oldValue,
+							(value as any)?.valueOf
+								? (value as any).valueOf()
+								: value
+						);
+					}
+				},
+				get: () => {
+					if (descriptor && descriptor.get) {
+						return descriptor.get.call(obj);
+					}
+
+					return store[key];
+				},
+				enumerable: true,
+				configurable: true
+			});
+
+			if (isPlainObject(store[key])) {
+				initAccessors(store[key], prefix);
+			}
+		});
+
+		Object.defineProperty(obj, 'on', {
+			value: on
+		});
+	};
+
+	initAccessors(obj);
+
+	return obj as O;
+}

package/src/core/event-emitter/store.ts

@@ -12,7 +12,7 @@ import type {
 	CallbackFunction,
 	EventHandlerBlock,
 	IDictionary
-} from '../../types';
+} from 'jodit/types';
 
 export const defaultNameSpace = 'JoditEventDefaultNamespace';
 

package/src/core/global.ts

@@ -15,7 +15,7 @@ import type {
 	IJodit,
 	IViewBased,
 	IViewComponent
-} from '../types';
+} from 'jodit/types';
 
 import { PluginSystem } from './plugin/plugin-system';
 

package/src/core/helpers/README.md

@@ -1 +1,31 @@
-Jodit helpers
+Assistant functions are intended for small basic operations and are divided into subgroups.
+
+For example, the [[helpers/string]] subgroup is designed to work with strings:
+```js
+Jodit.modules.Helpers.ucfirst('hello') // Hello
+Jodit.modules.Helpers.camelCase('hello-world') // helloWorld
+Jodit.modules.Helpers.trim('       hello-world  ') // hello-world
+Jodit.modules.Helpers.kebabCase('helloWorld') // hello-world
+```
+And the [[helpers/html]] subgroup is designed to work with strings containing HTML:
+```js
+Jodit.modules.Helpers.nl2br('hello\nworld') // hello<br>world
+```
+
+> All helpers, regardless of the group, are in the namespace `Jodit.modules.Helpers`
+
+The most commonly used helpers are checkers [[helpers/checker]]:
+
+```js
+Jodit.modules.Helpers.isBoolean('hello') // false
+
+Jodit.modules.Helpers.isHtml('hello-world') // false
+Jodit.modules.Helpers.isHtml('<p>hello world</p>') // true
+
+Jodit.modules.Helpers.isInt('100') // true
+Jodit.modules.Helpers.isInt('100.1') // false
+Jodit.modules.Helpers.isInt('test') // false
+
+Jodit.modules.Helpers.isFunction(() => {}) // true
+Jodit.modules.Helpers.isString(123) // false
+```

package/src/core/helpers/checker/is-equal.ts

@@ -8,7 +8,7 @@
  * @module helpers/checker
  */
 
-import { stringify } from '../string/stringify';
+import { stringify } from 'jodit/core/helpers/string/stringify';
 
 /**
  * Check two element are equal

package/src/core/helpers/checker/is-imp-interface.ts

@@ -8,9 +8,9 @@
  * @module helpers/checker
  */
 
-import type { IContainer, IDestructible, IInitable } from '../../../types';
+import type { IContainer, IDestructible, IInitable } from 'jodit/types';
 import { isFunction } from './is-function';
-import { Dom } from '../../dom';
+import { Dom } from 'jodit/core/dom';
 import { isVoid } from './is-void';
 
 /**

package/src/core/helpers/checker/is-jodit-object.ts

@@ -8,7 +8,7 @@
  * @module helpers/checker
  */
 
-import type { IJodit, IViewBased } from '../../../types';
+import type { IJodit, IViewBased } from 'jodit/types';
 import { isFunction } from './is-function';
 import { modules } from '../../global';
 

package/src/core/helpers/checker/is-plain-object.ts

@@ -8,7 +8,7 @@
  * @module helpers/checker
  */
 
-import type { IDictionary } from '../../../types';
+import type { IDictionary } from 'jodit/types';
 import { isWindow } from './is-window';
 
 /**

package/src/core/helpers/html/apply-styles.ts

@@ -8,8 +8,8 @@
  * @module helpers/html
  */
 
-import { Dom } from '../../dom';
-import { $$ } from '../utils';
+import { Dom } from 'jodit/core/dom';
+import { $$ } from 'jodit/core/helpers/utils';
 import { trim } from '../string';
 
 function normalizeCSS(s: string) {

package/src/core/helpers/html/clean-from-word.ts

@@ -8,9 +8,9 @@
  * @module helpers/html
  */
 
-import { Dom } from '../../dom';
-import { trim } from '../string';
-import { toArray } from '../array';
+import { Dom } from 'jodit/core/dom';
+import { trim } from 'jodit/core/helpers/string/trim';
+import { toArray } from 'jodit/core/helpers/array/to-array';
 
 /**
  * The method automatically cleans up content from Microsoft Word and other HTML sources to ensure clean, compliant

package/src/core/helpers/html/nl2br.ts

@@ -12,5 +12,5 @@
  *  Inserts HTML line breaks before all newlines in a string
  */
 export function nl2br(html: string): string {
-	return html.replace(/[\n\r]/g, '<br/>');
+	return html.replace(/\r\n|\r|\n/g, '<br/>');
 }

package/src/core/helpers/html/strip-tags.ts

@@ -8,11 +8,11 @@
  * @module helpers/html
  */
 
-import { isString } from '../checker';
-import { $$ } from '../utils';
-import { trim } from '../string';
-import { Dom } from '../../dom';
-import { attr } from '../utils';
+import { isString } from 'jodit/core/helpers/checker/is-string';
+import { $$ } from 'jodit/core/helpers/utils';
+import { trim } from 'jodit/core/helpers/string/trim';
+import { Dom } from 'jodit/core/dom';
+import { attr } from 'jodit/core/helpers/utils';
 
 /**
  * Extract plain text from HTML text

package/src/core/helpers/normalize/normalize-key-aliases.ts

@@ -8,9 +8,9 @@
  * @module helpers/normalize
  */
 
-import type { IDictionary } from '../../../types';
-import { trim } from '../string';
-import { KEY_ALIASES } from '../../constants';
+import type { IDictionary } from 'jodit/types';
+import { trim } from 'jodit/core/helpers/string';
+import { KEY_ALIASES } from 'jodit/core/constants';
 
 /**
  * Normalize keys to some standard name

package/src/core/helpers/normalize/normalize-node.ts

@@ -8,8 +8,8 @@
  * @module helpers/normalize
  */
 
-import { INVISIBLE_SPACE_REG_EXP } from '../../constants';
-import { Dom } from '../../dom';
+import { INVISIBLE_SPACE_REG_EXP } from 'jodit/core/constants';
+import { Dom } from 'jodit/core/dom';
 
 export const normalizeNode = (node: Node | null): void => {
 	if (!node) {

package/src/core/helpers/size/get-scroll-parent.ts

@@ -8,9 +8,9 @@
  * @module helpers/size
  */
 
-import type { Nullable } from '../../../types';
-import { css } from '../utils';
-import { Dom } from '../../dom';
+import type { Nullable } from 'jodit/types';
+import { css } from 'jodit/core/helpers/utils';
+import { Dom } from 'jodit/core/dom';
 
 export function getScrollParent(node: Nullable<Node>): Nullable<Element> {
 	if (!node) {

package/src/core/helpers/size/object-size.ts

@@ -9,7 +9,7 @@
  */
 
 import { isArray, isPlainObject, isString } from '../checker';
-import type { CanUndef } from '../../../types';
+import type { CanUndef } from 'jodit/types';
 
 export function size(
 	subject: CanUndef<object | string | Array<unknown>>

package/src/core/helpers/size/offset.ts

@@ -13,7 +13,7 @@
  * @returns returns an object containing the properties top and left.
  */
 
-import type { IBound, IHasScroll, IJodit, IViewBased } from '../../../types';
+import type { IBound, IHasScroll, IJodit, IViewBased } from 'jodit/types';
 
 export const offset = (
 	elm: HTMLElement | Range,

package/src/core/helpers/size/position.ts

@@ -8,7 +8,7 @@
  * @module helpers/size
  */
 
-import type { IBound, IViewBased } from '../../../types';
+import type { IBound, IViewBased } from 'jodit/types';
 import { isJoditObject } from '../checker';
 
 export function position(elm: HTMLElement): IBound;

package/src/core/helpers/string/i18n.ts

@@ -8,11 +8,15 @@
  * @module helpers/string
  */
 
-import type { IDictionary, ILanguageOptions } from '../../../types';
-import { Config } from '../../../config';
-import { defaultLanguage as defineLanguage } from '../utils';
-import { ucfirst, isString, error } from '../';
-import { lang } from '../../global';
+import type { IDictionary, ILanguageOptions } from 'jodit/types';
+import { Config } from 'jodit/config';
+import {
+	defaultLanguage as defineLanguage,
+	error
+} from 'jodit/core/helpers/utils';
+import { isString } from 'jodit/core/helpers/checker';
+import { ucfirst } from 'jodit/core/helpers/string';
+import { lang } from 'jodit/core/global';
 
 /**
  * Simple variant sprintf function
@@ -43,7 +47,7 @@ export const sprintf = (str: string, args?: Array<string | number>): string => {
  * @example
  * ```javascript
  * var editor = new Jodit("#redactor", {
- *      langusage: 'ru'
+ *      language: 'ru'
  * });
  * console.log(editor.i18n('Cancel')) //Отмена;
  *

package/src/core/helpers/string/stringify.ts

@@ -8,7 +8,7 @@
  * @module helpers/string
  */
 
-import type { CanUndef } from '../../../types';
+import type { CanUndef } from 'jodit/types';
 
 /**
  * Safe stringify circular object

package/src/core/helpers/string/trim.ts

@@ -13,7 +13,7 @@ import {
 	SPACE_REG_EXP_START,
 	INVISIBLE_SPACE_REG_EXP_END,
 	INVISIBLE_SPACE_REG_EXP_START
-} from '../../constants';
+} from 'jodit/core/constants';
 
 /**
  * It clears the line of all auxiliary invisible characters , from the spaces and line breaks , tabs

package/src/core/helpers/utils/append-script.ts

@@ -8,7 +8,7 @@
  * @module helpers/utils
  */
 
-import type { IViewBased } from '../../../types';
+import type { IViewBased } from 'jodit/types';
 import { completeUrl } from './complete-url';
 import { isFunction, isString } from '../checker';
 

package/src/core/helpers/utils/assert.ts

@@ -0,0 +1,25 @@
+/*!
+ * 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 helpers/utils
+ */
+
+class AssertionError extends Error {
+	constructor(message: string) {
+		super(message);
+		this.name = 'AssertionError';
+	}
+}
+
+/** Asserts that condition is truthy (or evaluates to true). */
+function assert(condition: boolean, message: string): asserts condition {
+	if (!condition) {
+		throw new AssertionError(`Assertion failed: ${message}`);
+	}
+}
+
+export { assert };

package/src/core/helpers/utils/build-query.ts

@@ -8,7 +8,7 @@
  * @module helpers/utils
  */
 
-import type { IDictionary } from '../../../types';
+import type { IDictionary } from 'jodit/types';
 import { isPlainObject } from '../checker';
 
 /**

package/src/core/helpers/utils/config-proto.ts

@@ -8,10 +8,10 @@
  * @module helpers/utils
  */
 
-import type { IDictionary } from '../../../types';
+import type { IDictionary } from 'jodit/types';
 import { isAtom } from './extend';
 import { isArray, isPlainObject, isString, isVoid } from '../checker';
-import { Config } from '../../../config';
+import { Config } from 'jodit/config';
 import { keys } from './utils';
 /**
  * @example

package/src/core/helpers/utils/css.ts

@@ -8,7 +8,7 @@
  * @module helpers/utils
  */
 
-import type { IStyle, StyleValue } from '../../../types';
+import type { IStyle, StyleValue } from 'jodit/types';
 import { isPlainObject, isNumeric, isVoid, isBoolean } from '../checker/';
 import { normalizeCssValue } from '../normalize/';
 import { camelCase, kebabCase } from '../string/';

package/src/core/helpers/utils/data-bind.ts

@@ -8,8 +8,8 @@
  * @module helpers/utils
  */
 
-import type { IEventEmitter, IViewComponent, Nullable } from '../../../types';
-import { ViewComponent } from '../../component';
+import type { IEventEmitter, IViewComponent, Nullable } from 'jodit/types';
+import { ViewComponent } from 'jodit/core/component';
 import { isViewObject } from '../checker';
 
 const store = new WeakMap();

package/src/core/helpers/utils/get-class-name.ts

@@ -8,7 +8,7 @@
  * @module helpers/utils
  */
 
-import type { IDictionary } from '../../../types';
+import type { IDictionary } from 'jodit/types';
 import { isFunction } from '../checker/is-function';
 
 export const keepNames = new Map<Function, string>();

package/src/core/helpers/utils/get.ts

@@ -8,7 +8,7 @@
  * @module helpers/utils
  */
 
-import type { IDictionary, Nullable } from '../../../types';
+import type { IDictionary, Nullable } from 'jodit/types';
 import { isString } from '../checker/is-string';
 import { isVoid } from '../checker/is-void';
 

package/src/core/helpers/utils/index.ts

@@ -8,6 +8,7 @@
  * @module helpers/utils
  */
 
+export * from './assert';
 export * from './mark-deprecated';
 export * from './utils';
 export * from './get';

package/src/core/helpers/utils/parse-query.ts

@@ -8,7 +8,7 @@
  * @module helpers/utils
  */
 
-import type { IDictionary } from '../../../types';
+import type { IDictionary } from 'jodit/types';
 
 /**
  * Parse query string

package/src/core/helpers/utils/selector.ts

@@ -13,15 +13,14 @@ import type {
 	IDictionary,
 	IUIElement,
 	Nullable
-} from '../../../types/';
-import { IS_IE } from '../../constants';
-import { isString } from '../checker';
-import { attr } from './utils';
-import { error } from './error';
-import { Dom } from '../../dom';
-import { camelCase } from '../string';
-import { toArray } from '../array';
-import { UIElement } from '../../ui';
+} from 'jodit/types/';
+import { IS_IE } from 'jodit/core/constants';
+import { isString } from 'jodit/core/helpers/checker';
+import { attr, error } from 'jodit/core/helpers/utils';
+import { Dom } from 'jodit/core/dom';
+import { camelCase } from 'jodit/core/helpers/string';
+import { toArray } from 'jodit/core/helpers/array';
+import { UIElement } from 'jodit/core/ui';
 
 let temp = 1;
 

package/src/core/helpers/utils/set.ts

@@ -8,7 +8,7 @@
  * @module helpers/utils
  */
 
-import type { IDictionary } from '../../../types';
+import type { IDictionary } from 'jodit/types';
 import { isString } from '../checker/is-string';
 import { isNumeric } from '../checker/is-numeric';
 import { isArray } from '../checker/is-array';

package/src/core/helpers/utils/stack.ts

@@ -8,7 +8,7 @@
  * @module helpers/utils
  */
 
-import type { CanUndef } from '../../../types';
+import type { CanUndef } from 'jodit/types';
 
 export class LimitedStack<T> {
 	private stack: T[] = [];

package/src/core/helpers/utils/utils.ts

@@ -16,7 +16,7 @@ import type {
 	Nullable,
 	IJodit,
 	RejectablePromise
-} from '../../../types';
+} from 'jodit/types';
 import { isFunction } from '../checker/is-function';
 import { isPromise } from '../checker/is-promise';
 import { get } from './get';

package/src/core/plugin/README.md

@@ -131,3 +131,16 @@ Jodit.plugins.add('insertTimePlugin', insertTimePlugin);
 -   Default: []
 
 If your plugin depends on other plugins, then it must be initialized after them.
+
+
+## Debug
+
+Since version `3.12.4` you can disable all Jodit plugins during development and work only with your own plugin.
+This will allow you to find out if it works correctly and if it breaks the behavior of the editor or if it is caused by other plugins.
+
+```js
+Jodit.make('#editor', {
+	safeMode: true,
+	safePluginsList: ['about'],
+	extraPlugins: ['yourPluginDev']
+});