jodit 3.10.2 → 3.12.2

package/src/modules/file-browser/{README.MD → README.md}

@@ -1,6 +1,117 @@
-# FileBrowser
+Module for working with remote images or just files. Allows you to upload / delete / rename files on the server.
 
-Image and file browser on the server.
+> A prerequisite for the module to work is the server side. Jodit offers its own implementation in php [jodit-connectors](https://github.com/xdan/jodit-connectors). The module will not work without the server side.
+
+You can write the backend yourself, it must support [API](https://github.com/xdan/jodit-connectors#api)
+Module settings allow you to override behavior for your server-side implementation.
+
+For example, by default, the server side returns a list of files in this format:
+
+```json
+{
+	"success": true,
+	"time": "2021-12-23 16:30:01",
+	"data": {
+		"sources": [
+			{
+				"baseurl": "https://xdsoft.net/jodit/finder/files/",
+				"path": "/folder/somepath/",
+				"files": [
+					{
+						"name": "pexels-sachin-c-nair-954929.jpg",
+						"type": "image"
+					},
+					{
+						"name": "pexels-james-wheeler-417074.jpg",
+						"type": "image"
+					}
+				],
+				"name": "default"
+			}
+		],
+		"code": 220
+	}
+}
+```
+
+But what if your server returns such data for example?
+
+```json
+[
+	{
+		"name": "pexels-sachin-c-nair-954929.jpg",
+		"type": "image"
+	},
+	{
+		"name": "pexels-james-wheeler-417074.jpg",
+		"type": "image"
+	}
+]
+```
+
+In this case, you can add the setting [[IFileBrowser.ajax.process]] or define the same setting for a specific handle,
+for example, to get a list [[IFileBrowser.items]]
+
+```js
+Jodit.make('#editor', {
+	filebrowser: {
+		ajax: {
+			url: 'https://sitename.com/connector/index.php', // this parameter is required
+			process: resp => {
+				return {
+					success: true,
+					time: '2021-12-23 16:30:01',
+					data: {
+						sources: [
+							{
+								baseurl:
+									'https://xdsoft.net/jodit/finder/files/',
+								path: '/folder/somepath/',
+								files: resp,
+								name: 'default'
+							}
+						],
+						code: 220
+					}
+				};
+			}
+		}
+	}
+});
+```
+
+but in that case all the responses of the all endpoints will be processed by this function. Better to handle the response for a specific handle:
+
+```js
+Jodit.make('#editor', {
+	filebrowser: {
+		ajax: {
+			url: 'https://sitename.com/connector/index.php'
+		},
+		// a request for a list of files will be handled in a special way
+		items: {
+			process: resp => {
+				return {
+					success: true,
+					time: '2021-12-23 16:30:01',
+					data: {
+						sources: [
+							{
+								baseurl:
+									'https://xdsoft.net/jodit/finder/files/',
+								path: '/folder/somepath/',
+								files: resp,
+								name: 'default'
+							}
+						],
+						code: 220
+					}
+				};
+			}
+		}
+	}
+});
+```
 
 ## Settings
 
@@ -80,14 +191,13 @@ Jodit.make('#editor', {
     data obtained after administration of the server. Must return this PlainObject format
 
 ```js
- {
-    files: resp.files || [], // {array} The names of files or folders, files can
-    be ['image.jpg', 'image.jpg2', 'image3.jpg' ...] and [{file: 'image.jpg', thumb: '_thumbs/image.jpg'},
-    {file: 'image2.jpg', thumb: '_thumbs/image2.jpg'} ...]
-    path: resp.path, // {string} Real relative path
-    baseurl: resp.baseurl, // {string} Base url for filebrowser
-    error: resp.error, // {int}
-    msg: resp.msg // {string}
+const response = {
+	files: resp.files || [], // {array} The names of files or folders,
+	// files canbe ['image.jpg', 'image.jpg2', 'image3.jpg' ...] and [{file: 'image.jpg', thumb: '_thumbs/image.jpg'}, {file: 'image2.jpg', thumb: '_thumbs/image2.jpg'} ...]
+	path: resp.path, // {string} Real relative path
+	baseurl: resp.baseurl, // {string} Base url for filebrowser
+	error: resp.error, // {int}
+	msg: resp.msg // {string}
 };
 ```
 
@@ -127,59 +237,59 @@ Example:
 
 ```js
 // default values
-{
-    isSuccess: function (resp) {
-        return !resp.error;
-    },
-    getMessage: function (resp) {
-        return resp.msg;
-    },
-    ajax: {
-        url: '',
-        async: true,
-        data: {},
-        contentType : 'application/x-www-form-urlencoded; charset=UTF-8',
-        headers : {},
-        method : 'POST',
-        processData  : true,
-        dataType: 'json',
-        headers: {},
-        prepareData: function (data) {
-            return data;
-        },
-        process: function (resp) {
-            return {
-                files: resp.files || [],
-                path: resp.path,
-                baseurl: resp.baseurl,
-                error: resp.error,
-                msg: resp.msg
-            };
-        }
-    },
-    resize: {
-        data: {action: 'imageResize'},
-    },
-    crop: {
-        data: {action: 'imageCrop'},
-    },
-    create: {
-        data: {action: 'folderCreate'},
-    },
-    move: {
-        data: {action: 'fileMove'},
-    },
-    remove: {
-        data: {action: 'fileRemove'},
-    },
-    items: {
-        data: {action: 'files'},
-    },
-    folders: {
-        data: {action: 'folders'},
-    },
-    uploader: null // use default Uploader's settings
-}
+const options = {
+	isSuccess: function (resp) {
+		return !resp.error;
+	},
+	getMessage: function (resp) {
+		return resp.msg;
+	},
+	ajax: {
+		url: '',
+		async: true,
+		data: {},
+		contentType: 'application/x-www-form-urlencoded; charset=UTF-8',
+		headers: {},
+		method: 'POST',
+		processData: true,
+		dataType: 'json',
+		headers: {},
+		prepareData: function (data) {
+			return data;
+		},
+		process: function (resp) {
+			return {
+				files: resp.files || [],
+				path: resp.path,
+				baseurl: resp.baseurl,
+				error: resp.error,
+				msg: resp.msg
+			};
+		}
+	},
+	resize: {
+		data: { action: 'imageResize' }
+	},
+	crop: {
+		data: { action: 'imageCrop' }
+	},
+	create: {
+		data: { action: 'folderCreate' }
+	},
+	move: {
+		data: { action: 'fileMove' }
+	},
+	remove: {
+		data: { action: 'fileRemove' }
+	},
+	items: {
+		data: { action: 'files' }
+	},
+	folders: {
+		data: { action: 'folders' }
+	},
+	uploader: null // use default Uploader's settings
+};
 ```
 
 Example:

package/src/modules/file-browser/builders/context-menu.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 { FileBrowser } from '../file-browser';
+/**
+ * @module modules/file-browser
+ */
+
+import type { IFileBrowser } from '../../../types';
 import { Dialog } from '../../dialog';
 
 import { Dom } from '../../../core/dom';
@@ -21,7 +25,7 @@ const CLASS_PREVIEW = 'jodit-filebrowser-preview',
 		Icon.get('angle-' + right) +
 		'</a>';
 
-export default (self: FileBrowser): ((e: DragEvent) => boolean | void) => {
+export default (self: IFileBrowser): ((e: DragEvent) => boolean | void) => {
 	if (!self.o.contextMenu) {
 		return () => {};
 	}

package/src/modules/file-browser/builders/item.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 modules/file-browser
  */
 
 import type {

package/src/modules/file-browser/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 modules/file-browser
  */
 
 import { Config } from '../../config';

package/src/modules/file-browser/data-provider.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 modules/file-browser
  */
 
 import type {

package/src/modules/file-browser/factories.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 modules/file-browser
  */
 
 import type {

package/src/modules/file-browser/file-browser.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 modules/file-browser
  */
 
 import './styles';
@@ -25,7 +29,8 @@ import type {
 	IUploaderOptions,
 	IDialog,
 	CanUndef,
-	IViewOptions
+	IViewOptions,
+	IObservable
 } from '../../types/';
 
 import { Storage } from '../../core/storage/';
@@ -35,7 +40,6 @@ import { ViewWithToolbar } from '../../core/view/view-with-toolbar';
 import './config';
 
 import { Dom } from '../../core/dom';
-import { ObserveObject } from '../../core/events/';
 import { makeDataProvider } from './factories';
 import { stateListeners } from './listeners/state-listeners';
 import { nativeListeners } from './listeners/native-listeners';
@@ -43,6 +47,11 @@ import { selfListeners } from './listeners/self-listeners';
 import { DEFAULT_SOURCE_NAME } from './data-provider';
 import { autobind } from '../../core/decorators';
 import { FileBrowserFiles, FileBrowserTree } from './ui';
+import { ObservableObject } from '../../core/event-emitter';
+
+/**
+ * @module modules/file-browser
+ */
 
 export class FileBrowser extends ViewWithToolbar implements IFileBrowser {
 	/** @override */
@@ -61,20 +70,21 @@ export class FileBrowser extends ViewWithToolbar implements IFileBrowser {
 	tree = new FileBrowserTree(this);
 	files = new FileBrowserFiles(this);
 
-	state = ObserveObject.create<IFileBrowserState>({
-		currentPath: '',
-		currentSource: DEFAULT_SOURCE_NAME,
-		currentBaseUrl: '',
-
-		activeElements: [],
-		elements: [],
-		messages: [],
-		sources: [],
-		view: 'tiles',
-		sortBy: 'changed-desc',
-		filterWord: '',
-		onlyImages: false
-	});
+	state: IFileBrowserState & IObservable =
+		ObservableObject.create<IFileBrowserState>({
+			currentPath: '',
+			currentSource: DEFAULT_SOURCE_NAME,
+			currentBaseUrl: '',
+
+			activeElements: [],
+			elements: [],
+			messages: [],
+			sources: [],
+			view: 'tiles',
+			sortBy: 'changed-desc',
+			filterWord: '',
+			onlyImages: false
+		});
 
 	dataProvider!: IFileBrowserDataProvider;
 
@@ -467,3 +477,12 @@ export class FileBrowser extends ViewWithToolbar implements IFileBrowser {
 		super.destruct();
 	}
 }
+
+export function isFileBrowserFilesItem(target: unknown): boolean {
+	return (
+		Dom.isElement(target) &&
+		target.classList.contains(
+			FileBrowserFiles.prototype.getFullElName('item')
+		)
+	);
+}

package/src/modules/file-browser/index.ts

@@ -0,0 +1,13 @@
+/*!
+ * 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:modules/file-browser/README.md]]
+ * @packageDocumentation
+ * @module modules/file-browser
+ */
+
+export * from './file-browser';

package/src/modules/file-browser/listeners/native-listeners.ts

@@ -1,16 +1,20 @@
 /*!
  * 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 modules/file-browser
  */
 
 import type {
 	HTMLTagNames,
 	IFileBrowserItem,
 	Nullable,
-	IDictionary
+	IDictionary,
+	IFileBrowser
 } from '../../../types';
-import type { FileBrowser } from '../file-browser';
 import { ctrlKey, attr } from '../../../core/helpers';
 import contextMenu from '../builders/context-menu';
 import { Dom } from '../../../core/dom';
@@ -35,7 +39,7 @@ export const elementToItem = (
 	return item;
 };
 
-export function nativeListeners(this: FileBrowser): void {
+export function nativeListeners(this: IFileBrowser): void {
 	let dragElement: false | HTMLElement = false;
 
 	const self = this;

package/src/modules/file-browser/listeners/self-listeners.ts

@@ -1,18 +1,21 @@
 /*!
  * 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';
-import type { FileBrowser } from '../file-browser';
+/**
+ * @module modules/file-browser
+ */
+
+import type { IDictionary, IFileBrowser } from '../../../types';
 import { Confirm, Prompt } from '../../dialog';
 import { isValidName } from '../../../core/helpers/checker';
 import { normalizePath } from '../../../core/helpers';
 import { DEFAULT_SOURCE_NAME } from '../data-provider';
 import { openImageEditor } from '../../image-editor/image-editor';
 
-export function selfListeners(this: FileBrowser): void {
+export function selfListeners(this: IFileBrowser): void {
 	const state = this.state,
 		dp = this.dataProvider,
 		self = this;

package/src/modules/file-browser/listeners/state-listeners.ts

@@ -1,11 +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 { IFileBrowserItem } from '../../../types';
-import type { FileBrowser } from '../file-browser';
+/**
+ * @module modules/file-browser
+ */
+
+import type { IFileBrowser, IFileBrowserItem } from '../../../types';
 import { Dom } from '../../../core/dom';
 import { normalizePath } from '../../../core/helpers/normalize';
 import { Button } from '../../../core/ui';
@@ -15,7 +18,7 @@ const DEFAULT_SOURCE_NAME = 'default';
 /**
  * Convert state to view
  */
-export function stateListeners(this: FileBrowser): void {
+export function stateListeners(this: IFileBrowser): void {
 	const { state, files, create, options, elementsMap } = this,
 		getDomElement = (item: IFileBrowserItem): HTMLElement => {
 			const key = item.uniqueHashKey;

package/src/modules/file-browser/styles/file-browser.less

@@ -1,7 +1,7 @@
 /*!
  * 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 (reference) '../../../styles/variables';

package/src/modules/file-browser/styles/index.less

@@ -1,7 +1,7 @@
 /*!
  * 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 'file-browser';

package/src/modules/file-browser/styles/preview.less

@@ -1,7 +1,7 @@
 /*!
  * 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 (reference) '../../../styles/variables';

package/src/modules/file-browser/ui/files/files.ts

@@ -1,7 +1,7 @@
 /*!
  * 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 './files.less';

package/src/modules/file-browser/ui/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 modules/file-browser
  */
 
 export * from './files/files';

package/src/modules/file-browser/ui/tree/tree.ts

@@ -1,7 +1,7 @@
 /*!
  * 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 './tree.less';

package/src/modules/image-editor/README.md

@@ -0,0 +1 @@
+Image editor module

package/src/modules/image-editor/image-editor.less

@@ -1,7 +1,7 @@
 /*!
  * 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 (reference) '../../styles/variables';

package/src/modules/image-editor/image-editor.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
  */
 
-/* eslint-disable tsdoc/syntax */
+/**
+ * [[include:modules/image-editor/README.md]]
+ * @packageDocumentation
+ * @module modules/image-editor
+ */
 
 import './image-editor.less';
 
@@ -652,15 +656,12 @@ export class ImageEditor extends ViewComponent {
 	/**
 	 * Open image editor
 	 *
-	 * @method open
-	 * @param {string} url
-	 * @param {function} save
-	 * @param {string} [save.name] new filename
-	 * @param {object} save.data Bound box for resize and crop operation
-	 * @param {string} save.data.action resize or crop
-	 * @param {object} save.data.box Bound box
-	 * @param {function} save.success called after success operation
-	 * @param {function} save.failed called after failed operation
+	 * @param [save.name] - new filename
+	 * @param save.data - Bound box for resize and crop operation
+	 * @param save.data.action - resize or crop
+	 * @param save.data.box - Bound box
+	 * @param save.success - called after success operation
+	 * @param save.failed - called after failed operation
 	 * @example
 	 * ```javascript
 	 * var jodit = new Jodit('.editor', {

package/src/modules/image-editor/templates/form.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 modules/image-editor
  */
 
 import type { ImageEditorOptions, IViewBased } from '../../../types';