jodit 3.11.3 → 3.12.2

package/src/core/event-emitter/README.md

@@ -0,0 +1,39 @@
+This is the heart of Jodit. All processes inside Jodit mostly flow through events.
+
+```js
+const jodit = Jodit.make('#editor');
+jodit.e.on('someEvent', (param) => alert(`Some event fired for ${param}!!!`));
+jodit.async.setTimeout(() => {
+  jodit.e.fire('someEvent', 'you');
+}, 1000);
+```
+
+In addition to custom events, the emitter can work with DOM elements and browser events:
+
+```js
+jodit.e.on(document.body, 'click', () => alert(`Doc click!!!`));
+```
+
+If you don't want to listen to the event anymore, you can unsubscribe from it:
+
+```js
+jodit.e
+  .one('someEvent', (param) => alert(`Some event fired for ${param}!!!`))
+  .one('someEvent', (param) => alert(`Some event fired for ${param}!!!`))
+  .one('someEvent', (param) => alert(`Some event fired for ${param}!!!`));
+
+jodit.e.off('someEvent') // will unsubscribe from all handlers
+```
+
+```js
+const handler1 = (param) => alert(`Some event fired for ${param}!!!`);
+const handler2 = (param) => alert(`Some event fired for ${param}!!!`);
+const handler3 = (param) => alert(`Some event fired for ${param}!!!`);
+
+jodit.e
+  .one('someEvent', handler1)
+  .one('someEvent', handler2)
+  .one('someEvent', handler3);
+
+jodit.e.off('someEvent', handler1) // only handler1 will unsubscribe
+```

package/src/core/{events → event-emitter}/event-emitter.ts

@@ -1,10 +1,15 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * [[include:core/event-emitter/README.md]]
+ * @packageDocumentation
+ * @module event-emitter
  */
 
-// eslint-disable-next-line max-classes-per-file
 import type {
 	CallbackFunction,
 	EventHandlerBlock,
@@ -14,7 +19,7 @@ import { defaultNameSpace, EventHandlersStore } from './store';
 import { isString } from '../helpers/checker/is-string';
 import { isFunction } from '../helpers/checker/is-function';
 import { isArray } from '../helpers/checker/is-array';
-import { error } from '../helpers/type';
+import { error } from '../helpers/utils/error';
 
 /**
  * The module editor's event manager
@@ -550,7 +555,7 @@ export class EventEmitter implements IEventEmitter {
 	}
 
 	/**
-	 * Sets the handler for the specified event (Event List) for a given element .
+	 * Emits an event to all handlers and calls them
 	 *
 	 * @param subjectOrEvents - The object which is caused by certain events
 	 * @param eventsList - List of events , separated by a space or comma
@@ -699,8 +704,3 @@ export class EventEmitter implements IEventEmitter {
 		delete (this as any)[this.__key];
 	}
 }
-
-/**
- * @deprecated Use `EventEmitter` instead
- */
-export class EventsNative extends EventEmitter implements IEventEmitter {}

package/src/core/{events → event-emitter}/index.ts

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module event-emitter
  */
 
 export * from './event-emitter';

package/src/core/{events → event-emitter}/observe-object.ts

@@ -1,14 +1,23 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
  */
 
-import type { CallbackFunction, CanUndef, IDictionary } from '../../types';
+/**
+ * @module event-emitter
+ */
+
+import type {
+	CallbackFunction,
+	CanUndef,
+	IDictionary,
+	IObservable
+} from '../../types';
 import { isPlainObject, isFastEqual, isArray } from '../helpers';
 import { nonenumerable } from '../decorators';
 
-export class ObserveObject {
+export class ObservableObject implements IObservable {
 	@nonenumerable
 	private readonly __data!: IDictionary;
 
@@ -45,7 +54,7 @@ export class ObserveObject {
 						);
 
 						if (isPlainObject(value)) {
-							value = new ObserveObject(
+							value = new ObservableObject(
 								value,
 								prefix,
 								this.__onEvents
@@ -81,7 +90,7 @@ export class ObserveObject {
 			});
 
 			if (isPlainObject(data[key])) {
-				data[key] = new ObserveObject(
+				data[key] = new ObservableObject(
 					data[key],
 					prefix,
 					this.__onEvents
@@ -135,14 +144,14 @@ export class ObserveObject {
 		}
 	}
 
-	static create<T, K extends T & ObserveObject = T & ObserveObject>(
+	static create<T, K extends T & ObservableObject = T & ObservableObject>(
 		data: T,
 		prefix: string[] = []
 	): K {
-		if (data instanceof ObserveObject) {
+		if (data instanceof ObservableObject) {
 			return data as any;
 		}
 
-		return new ObserveObject(data, prefix) as any;
+		return new ObservableObject(data, prefix) as any;
 	}
 }

package/src/core/{events → event-emitter}/store.ts

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module event-emitter
  */
 
 import type {

package/src/core/global.ts

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module global
  */
 
 import type {
@@ -13,18 +17,14 @@ import type {
 	IViewComponent
 } from '../types';
 
-import { PluginSystem } from './plugin-system';
+import { PluginSystem } from './plugin/plugin-system';
 
 import { Dom } from './dom';
 
-import {
-	getClassName,
-	isJoditObject,
-	isViewObject,
-	kebabCase
-} from './helpers/';
-
-import { EventEmitter } from './events';
+import { EventEmitter } from './event-emitter';
+import { isJoditObject, isViewObject } from './helpers/checker';
+import { getClassName } from './helpers/utils/get-class-name';
+import { kebabCase } from './helpers/string';
 
 export const instances: IDictionary<IJodit> = {};
 

package/src/core/helpers/README.md

@@ -0,0 +1 @@
+Jodit helpers

package/src/core/helpers/array/as-array.ts

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/array
  */
 
 import { isArray } from '../checker/is-array';

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/array
  */
 
 export { asArray } from './as-array';

package/src/core/helpers/array/split-array.ts

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/array
  */
 
 import { isString } from '../checker/is-string';

package/src/core/helpers/array/to-array.ts

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/array
  */
 
 import { reset } from '../utils/utils';

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/async
  */
 
 export * from './set-timeout';

package/src/core/helpers/async/set-timeout.ts

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/async
  */
 
 /**

package/src/core/helpers/checker/has-browser-color-picker.ts

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 /**

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 export * from './has-browser-color-picker';

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 /**

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 export function isBoolean(elm: unknown): elm is Boolean {

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 import { stringify } from '../string/stringify';

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 /**

package/src/core/helpers/checker/is-html-from-word.ts

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 /**

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 import { isString } from './is-string';

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 import type { IContainer, IDestructible, IInitable } from '../../../types';

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 import { isNumeric } from './is-numeric';

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 import type { IJodit, IViewBased } from '../../../types';

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 import { isString } from './is-string';

package/src/core/helpers/checker/is-native-function.ts

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 /**

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 /**

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 import { isString } from './is-string';

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 import type { IDictionary } from '../../../types';

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 export function isPromise(val: any | Promise<any>): val is Promise<any> {

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 /**

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 /**

package/src/core/helpers/checker/is-valid-name.ts

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 /**

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 /**

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/checker
  */
 
 export function isWindow(obj: object): boolean {

package/src/core/helpers/color/color-to-hex.ts

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/color
  */
 
 /**

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

@@ -1,7 +1,11 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/color
  */
 
 export * from './color-to-hex';

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

@@ -1,11 +1,15 @@
 /*!
  * Jodit Editor (https://xdsoft.net/jodit/)
  * Released under MIT see LICENSE.txt in the project root for license information.
- * Copyright (c) 2013-2021 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ * Copyright (c) 2013-2022 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module helpers/html
  */
 
 import { Dom } from '../../dom';
-import { $$ } from '../selector';
+import { $$ } from '../utils';
 import { trim } from '../string';
 
 function normalizeCSS(s: string) {