jodit 3.11.2 → 3.12.4

package/src/core/helpers/{css.ts → utils/css.ts}

@@ -1,13 +1,17 @@
 /*!
  * 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 { IStyle, StyleValue } from '../../types';
-import { isPlainObject, isNumeric, isVoid, isBoolean } from './checker/';
-import { normalizeCssValue } from './normalize/';
-import { camelCase, kebabCase } from './string/';
+/**
+ * @module helpers/utils
+ */
+
+import type { IStyle, StyleValue } from '../../../types';
+import { isPlainObject, isNumeric, isVoid, isBoolean } from '../checker/';
+import { normalizeCssValue } from '../normalize/';
+import { camelCase, kebabCase } from '../string/';
 
 export function css(
 	element: HTMLElement,

package/src/core/helpers/{ctrl-key.ts → utils/ctrl-key.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/utils
  */
 
 /**

package/src/core/helpers/{data-bind.ts → utils/data-bind.ts}

@@ -1,12 +1,16 @@
 /*!
  * 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 { IEventEmitter, IViewComponent, Nullable } from '../../types';
-import { ViewComponent } from '../component';
-import { isViewObject } from './checker';
+/**
+ * @module helpers/utils
+ */
+
+import type { IEventEmitter, IViewComponent, Nullable } from '../../../types';
+import { ViewComponent } from '../../component';
+import { isViewObject } from '../checker';
 
 const store = new WeakMap();
 

package/src/core/helpers/{default-language.ts → utils/default-language.ts}

@@ -1,10 +1,14 @@
 /*!
  * 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 { isString } from './checker';
+/**
+ * @module helpers/utils
+ */
+
+import { isString } from '../checker';
 
 /**
  * Try define user language

package/src/core/helpers/{type.ts → utils/error.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/utils
  */
 
 /**

package/src/core/helpers/{extend.ts → utils/extend.ts}

@@ -1,10 +1,14 @@
 /*!
  * 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 { stringify } from './string/stringify';
+/**
+ * @module helpers/utils
+ */
+
+import { stringify } from '../string/stringify';
 
 export function isAtom(obj: unknown): boolean {
 	return obj && (obj as any).isAtom;

package/src/core/helpers/utils/get-class-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/utils
  */
 
 import type { IDictionary } from '../../../types';

package/src/core/helpers/utils/get.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/utils
  */
 
 import type { IDictionary, Nullable } from '../../../types';

package/src/core/helpers/{human-size-to-bytes.ts → utils/human-size-to-bytes.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/utils
  */
 
 /**

package/src/core/helpers/utils/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/utils
  */
 
 export * from './mark-deprecated';
@@ -10,3 +14,20 @@ export * from './get';
 export * from './set';
 export * from './get-class-name';
 export * from './stack';
+export * from './append-script';
+export * from './browser';
+export * from './build-query';
+export * from './complete-url';
+export * from './config-proto';
+export * from './convert-media-url-to-video-embed';
+export * from './css';
+export * from './ctrl-key';
+export * from './data-bind';
+export * from './default-language';
+export * from './extend';
+export * from './human-size-to-bytes';
+export * from './parse-query';
+export * from './scroll-into-view';
+export * from './selector';
+export * from './error';
+export * from './val';

package/src/core/helpers/utils/mark-deprecated.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/utils
  */
 
 /**

package/src/core/helpers/{parse-query.ts → utils/parse-query.ts}

@@ -1,10 +1,14 @@
 /*!
  * 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 { IDictionary } from '../../types';
+/**
+ * @module helpers/utils
+ */
+
+import type { IDictionary } from '../../../types';
 
 /**
  * Parse query string

package/src/core/helpers/{scroll-into-view.ts → utils/scroll-into-view.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/utils
  */
 
 export const inView = (

package/src/core/helpers/{selector.ts → utils/selector.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/utils
  */
 
 import type {
@@ -9,15 +13,15 @@ import type {
 	IDictionary,
 	IUIElement,
 	Nullable
-} from '../../types/';
-import { IS_IE } from '../constants';
-import { isString } from './checker';
+} from '../../../types/';
+import { IS_IE } from '../../constants';
+import { isString } from '../checker';
 import { attr } from './utils';
-import { error } from './type';
-import { Dom } from '../dom';
-import { camelCase } from './string';
-import { toArray } from './array';
-import { UIElement } from '../ui';
+import { error } from './error';
+import { Dom } from '../../dom';
+import { camelCase } from '../string';
+import { toArray } from '../array';
+import { UIElement } from '../../ui';
 
 let temp = 1;
 

package/src/core/helpers/utils/set.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/utils
  */
 
 import type { IDictionary } from '../../../types';

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

@@ -1,8 +1,13 @@
 /*!
  * 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/utils
+ */
+
 import type { CanUndef } from '../../../types';
 
 export class LimitedStack<T> {

package/src/core/helpers/utils/utils.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/utils
  */
 
 import type {
@@ -16,10 +20,10 @@ import type {
 import { isFunction } from '../checker/is-function';
 import { isPromise } from '../checker/is-promise';
 import { get } from './get';
-import { dataBind } from '../data-bind';
+import { dataBind } from './data-bind';
 import { isVoid } from '../checker/is-void';
 import { isPlainObject, isString } from '../checker';
-import { css } from '../css';
+import { css } from './css';
 import { CamelCaseToKebabCase } from '../string';
 
 /**

package/src/core/helpers/{val.ts → utils/val.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/utils
  */
 
 export const val = (

package/src/core/plugin/README.md

@@ -0,0 +1,133 @@
+Jodit plugins are designed to extend the basic functionality of the editor.
+There are built-in plugins, without which the editor will not work correctly. There are plugins that add completely new functionality.
+You can write your own plugin that will either change the current behavior of the editor or add a new function.
+
+Plugins can be both simple functions and complex classes.
+
+In the simplest case, it's just a function that receives a Jodit instance as input.
+
+```js
+Jodit.plugins.add('alertMyId', function (jodit) {
+	alert(jodit.id);
+});
+```
+
+The moment you create an instance of Jodit, all plugins are initialized.
+
+```js
+const editor = Jodit.make('#editorId'); // alert('editorId')
+```
+
+This is usually not what you expect. You probably want the plugin to take action on certain events.
+The [EventEmiter](https://github.com/xdan/jodit/blob/master/src/types/events.d.ts#L9) editor will help you with this.
+
+```js
+Jodit.plugins.add('keyLogger', function (jodit) {
+	jodit.events.on('keydown', (e) => {
+		sendAnalytics('keydown', e.key);
+	});
+});
+```
+
+As mentioned above, plugins can be more complex than just a function. A plugin can be a class:
+
+```js
+class resizeEditor {
+	hasStyle = true;
+
+	buttons = [
+		{
+			name: 'custom',
+			group: 'other'
+		}
+	];
+
+	requires = ['enter', 'drag-and-drop'];
+
+	init(jodit: IJodit): void {
+		jodit.events.on('afterInit', () => {
+			Jodit.ns.Helpers.css(jodit.editor, {
+				width: 400
+			});
+		});
+	}
+
+	destruct() {
+		Jodit.ns.Helpers.css(this.jodit.editor, {
+			width: null
+		});
+	}
+}
+
+Jodit.plugins.add('resizeEditor', resizeEditor);
+```
+
+### hasStyle
+
+-   Type: boolean
+-   Default: false
+
+Jodit will try to load the styles along the same path as the plugin is loaded.
+
+### buttons
+
+-   Type: Array<IPluginButton>
+-   Default: `[]`
+
+```typescript
+export interface IPluginButton {
+	name: string;
+	group?: ButtonGroup;
+	position?: number;
+	options?: IControlType;
+}
+
+export type ButtonGroup =
+	| string
+	| 'source'
+	| 'font-style'
+	| 'script'
+	| 'list'
+	| 'indent'
+	| 'font'
+	| 'color'
+	| 'media'
+	| 'state'
+	| 'clipboard'
+	| 'insert'
+	| 'history'
+	| 'search'
+	| 'other'
+	| 'info';
+```
+
+Buttons to be automatically added to the editor's button groups.
+Those. if the plugin is connected, the button will appear in the list, if not connected, it will disappear.
+
+```js
+Jodit.defaultOptions.controls.insertTime = {
+	icon: require('./icon.svg'),
+	tooltip: 'Insert Time',
+	exec: (editor: IJodit) => {
+		editor.s.insertHTML(new Date().toTimeString());
+	}
+};
+
+class insertTimePlugin {
+	buttons = [
+		{
+			name: 'insertTime',
+			group: 'insert'
+		}
+	];
+}
+
+Jodit.plugins.add('insertTimePlugin', insertTimePlugin);
+```
+
+### requires
+
+-   Type: Array<string>
+-   Default: []
+
+If your plugin depends on other plugins, then it must be initialized after them.

package/src/core/plugin/index.ts

@@ -0,0 +1,12 @@
+/*!
+ * 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 plugin
+ */
+
+export * from './plugin-system';
+export * from './plugin';

package/src/core/{plugin-system.ts → plugin/plugin-system.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 plugin
  */
 
 import type {
@@ -14,7 +18,7 @@ import type {
 	PluginType,
 	CanPromise,
 	CanUndef
-} from '../types';
+} from '../../types';
 
 import {
 	isInitable,
@@ -27,7 +31,7 @@ import {
 	kebabCase,
 	callPromise,
 	isArray
-} from './helpers';
+} from '../helpers';
 
 /**
  * Jodit plugin system

package/src/core/{plugin.ts → plugin/plugin.ts}

@@ -1,13 +1,19 @@
 /*!
  * 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 { IJodit, IPlugin, IViewBased } from '../types';
-import { ViewComponent, STATUSES } from './component';
-import { autobind } from './decorators';
-import { isJoditObject } from './helpers';
+/**
+ * [[include:core/plugin/README.md]]
+ * @packageDocumentation
+ * @module plugin
+ */
+
+import type { IJodit, IPlugin, IViewBased } from '../../types';
+import { ViewComponent, STATUSES } from '../component';
+import { autobind } from '../decorators';
+import { isJoditObject } from '../helpers';
 
 export abstract class Plugin<T extends IViewBased = IJodit>
 	extends ViewComponent<T>

package/src/core/request/README.md

@@ -0,0 +1,11 @@
+The module is responsible for sending requests over the network:
+
+```js
+const ajax = new Jodit.modules.Ajax(jodit, {
+	url: 'https://xdsoft.net'
+});
+
+ajax.send().then((resp) => console.log(resp.text()));
+```
+
+The second argument can be settings [[AjaxOptions]]

package/src/core/request/ajax.ts

@@ -1,7 +1,13 @@
 /*!
  * 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/request/README.md]]
+ * @packageDocumentation
+ * @module request
  */
 
 import type {
@@ -30,6 +36,17 @@ import { Response } from './response';
 import './config';
 
 export class Ajax<T extends object = any> implements IAjax<T> {
+	constructor(readonly jodit: IViewBased, options: Partial<AjaxOptions>) {
+		this.options = ConfigProto(
+			options || {},
+			Config.prototype.defaultAjaxOptions
+		) as AjaxOptions;
+
+		this.xhr = this.o.xhr ? this.o.xhr() : new XMLHttpRequest();
+
+		jodit && jodit.e && jodit.e.on('beforeDestruct', () => this.destruct());
+	}
+
 	static log: IRequest[] = [];
 
 	private readonly xhr!: XMLHttpRequest;
@@ -195,17 +212,6 @@ export class Ajax<T extends object = any> implements IAjax<T> {
 		return request;
 	}
 
-	constructor(readonly jodit: IViewBased, options: Partial<AjaxOptions>) {
-		this.options = ConfigProto(
-			options || {},
-			Config.prototype.defaultAjaxOptions
-		) as AjaxOptions;
-
-		this.xhr = this.o.xhr ? this.o.xhr() : new XMLHttpRequest();
-
-		jodit && jodit.e && jodit.e.on('beforeDestruct', () => this.destruct());
-	}
-
 	destruct(): void {
 		if (this.activated && !this.resolved) {
 			this.abort();

package/src/core/request/config.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 request
  */
 
 import type { AjaxOptions } from '../../types';

package/src/core/request/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 request
  */
 
 export * from './ajax';

package/src/core/request/response.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 request
  */
 
 import type { IRequest, IResponse } from '../../types';

package/src/core/selection/README.md

@@ -0,0 +1,20 @@
+A module for working with the cursor, text selections, processing selections, inserting html in place of the cursor.
+most obvious use case
+
+## How to insert HTML into Jodit
+
+There is a family of methods for this.[[Select.prototype.insertHTML]], [[Select.prototype.insertNode]], [[Select.prototype.insertImage]].
+
+```js
+const jodit = Jodit.make('#editor');
+jodit.selection.insertHTML('<span>some html</span>')
+jodit.selection.insertNode(document.createElement('div')) // don't do that =) see [[core/create]]
+jodit.selection.insertImage('https://somesite.com/image.png')
+```
+
+## How to set focus in Jodit editor
+
+```js
+const jodit = Jodit.make('#editor');
+jodit.selection.focus()
+```