jodit 4.0.0-beta.67 → 4.0.0-beta.69

package/esm/types/types.d.ts

@@ -0,0 +1,311 @@
+/*!
+ * Jodit Editor (https://xdsoft.net/jodit/)
+ * Released under MIT see LICENSE.txt in the project root for license information.
+ * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module types
+ */
+
+import type { IViewBased } from './view';
+import type { IAsync } from './async';
+
+export type IDictionary<T = any, K extends string = string> = {
+	[key in K]: T;
+};
+
+export type Prettify<T> = {
+	[P in keyof T]: T[P];
+};
+
+export type CanPromise<T> = T | Promise<T>;
+export type CanUndef<T> = T | undefined;
+export type CanArray<T> = T | Array<T>;
+export type Nullable<T> = T | null;
+
+export interface IInitable {
+	init(jodit: IViewBased): any;
+}
+
+export interface IDestructible {
+	destruct(jodit?: IViewBased): any;
+}
+
+export type ComponentStatus =
+	| 'beforeInit'
+	| 'ready'
+	| 'beforeDestruct'
+	| 'destructed';
+
+export interface IContainer {
+	container: HTMLElement;
+}
+
+interface IComponent<T extends IViewBased = IViewBased> extends IDestructible {
+	readonly async: IAsync;
+	readonly ownerDocument: Document;
+	readonly od: this['ownerDocument'];
+	readonly ownerWindow: Window;
+	readonly ow: this['ownerWindow'];
+
+	get<T>(chain: string, obj?: IDictionary): Nullable<T>;
+
+	readonly componentName: string;
+	className(): string;
+
+	getFullElName(elementName: string): string;
+	getFullElName(elementName: string, mod: string): string;
+	getFullElName(
+		elementName: string,
+		mod?: string,
+		modValue?: boolean | string
+	): string;
+
+	readonly uid: string;
+	readonly isDestructed: boolean;
+	readonly isInDestruct: boolean;
+	readonly isReady: boolean;
+
+	readonly componentStatus: ComponentStatus;
+	setStatus(componentStatus: ComponentStatus): void;
+
+	hookStatus(
+		status: ComponentStatus,
+		callback: (component: this) => void
+	): void;
+
+	bindDestruct(component: IComponent): this;
+}
+
+interface IViewComponent<T extends IViewBased = IViewBased> extends IComponent {
+	jodit: T;
+	readonly j: T;
+	setParentView(jodit: T): this;
+	readonly i18n: T['i18n'];
+	readonly defaultTimeout: number;
+}
+
+export type NodeCondition<T extends Node = Node> = (
+	node: Nullable<T>
+) => boolean | null | false | void | '';
+
+/**
+ * Bound interface
+ */
+export interface IBound {
+	top: number;
+	left: number;
+	width: number;
+	height: number;
+}
+
+export interface IBoundP {
+	top: number;
+	left: number;
+	width?: number;
+	height?: number;
+}
+
+export interface IPoint {
+	x: number;
+	y: number;
+}
+
+export interface IPointBound extends IPoint {
+	w: number;
+	h: number;
+}
+
+export interface ISelectionRange {
+	startContainer: Text;
+	startOffset: number;
+	endContainer: Text;
+	endOffset: number;
+}
+
+export interface IRGB {
+	r: number;
+	g: number;
+	b: number;
+}
+
+export interface IPermissions {
+	allowFiles: boolean;
+	allowFileMove: boolean;
+	allowFileUpload: boolean;
+	allowFileUploadRemote: boolean;
+	allowFileRemove: boolean;
+	allowFileRename: boolean;
+	allowFolders: boolean;
+	allowFolderCreate: boolean;
+	allowFolderMove: boolean;
+	allowFolderRemove: boolean;
+	allowFolderRename: boolean;
+	allowImageResize: boolean;
+	allowImageCrop: boolean;
+	[key: string]: boolean;
+}
+
+export interface CallbackFunction<T = any> {
+	(this: T, ...args: any[]): any | void;
+}
+
+interface CallbackFunction {
+	options?: unknown;
+}
+
+export type BooleanFunction<T = any> = (this: T, ...args: any[]) => boolean;
+
+export type ExecCommandCallback<T, C extends string> =
+	| ((
+			this: T,
+			command: C,
+			value?: string,
+			next?: any,
+			...args: unknown[]
+	  ) => void | boolean | Promise<void | boolean>)
+	| ((
+			this: T,
+			command: C,
+			value: string,
+			next: string,
+			...args: unknown[]
+	  ) => void | boolean | Promise<void | boolean>);
+
+export interface ICommandType<T, C extends string> {
+	exec: ExecCommandCallback<T, C>;
+	hotkeys?: string | string[];
+}
+
+export type CustomCommand<T, C extends string> =
+	| ICommandType<T, C>
+	| ExecCommandCallback<T, C>;
+
+export interface IHasScroll {
+	clientTop: number;
+	clientLeft: number;
+	scrollTop: number;
+	scrollLeft: number;
+}
+
+export interface RangeType {
+	startContainer: number[];
+	startOffset: number;
+	endContainer: number[];
+	endOffset: number;
+}
+
+export interface SnapshotType {
+	html: string;
+	range: RangeType;
+}
+
+export interface ImageEditorOptions {
+	min_width: number;
+	min_height: number;
+	/**
+	 * Close editor after save image
+	 */
+	closeAfterSave: boolean;
+
+	/**
+	 * Default dialog width by screen
+	 */
+	width: string | number;
+
+	/**
+	 * Default dialog height by screen
+	 */
+	height: string | number;
+
+	/**
+	 * Show tab cropping
+	 */
+	crop: boolean;
+
+	/**
+	 * Show tab resizing
+	 */
+	resize: boolean;
+
+	/**
+	 * Keep aspect ratio on resize
+	 */
+	resizeUseRatio: boolean;
+
+	/**
+	 * Minimal width on resize
+	 */
+	resizeMinWidth: number;
+
+	/**
+	 * Minimal height on resize
+	 */
+	resizeMinHeight: number;
+
+	/**
+	 * Keep aspect ratio on crop
+	 */
+	cropUseRatio: boolean;
+
+	/**
+	 * In the tab, crop the image is displayed not in real size
+	 */
+	cropDefaultWidth: string | number;
+	cropDefaultHeight: string | number;
+}
+
+export type InsertMode =
+	| 'insert_as_html'
+	| 'insert_as_text'
+	| 'insert_clear_html'
+	| 'insert_only_text';
+
+export type ImageAction = 'resize' | 'crop';
+export type ImageHAlign = 'normal' | 'left' | 'right' | 'center' | '';
+
+export interface ImageBox {
+	w: number;
+	h: number;
+	x?: number;
+	y?: number;
+}
+
+export interface ImageEditorActionBox {
+	action: ImageAction;
+	box: ImageBox;
+}
+
+export interface EventHandlerBlock {
+	event: string;
+	originalCallback: CallbackFunction;
+	syntheticCallback: CallbackFunction;
+}
+
+declare global {
+	interface HTMLElementTagNameMap {
+		jodit: HTMLDivElement;
+		svg: HTMLElement;
+		path: HTMLElement;
+		font: HTMLElement;
+		'jodit-media': HTMLElement;
+	}
+}
+
+export type HTMLTagNames = Prettify<keyof HTMLElementTagNameMap>;
+
+export type Modes = 1 | 2 | 3;
+
+declare global {
+	interface MouseEvent {
+		buffer?: IDictionary;
+	}
+}
+
+export interface FuzzySearch {
+	(needle: string, haystack: string, offset?: number, maxDistance?: number): [
+		number,
+		number
+	];
+}

package/esm/types/ui.d.ts

@@ -0,0 +1,196 @@
+/*!
+ * Jodit Editor (https://xdsoft.net/jodit/)
+ * Released under MIT see LICENSE.txt in the project root for license information.
+ * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module types
+ */
+
+import type { IFocusable } from './form';
+import type {
+	CanUndef,
+	IContainer,
+	IDestructible,
+	IDictionary,
+	IViewComponent,
+	Nullable
+} from './types';
+import type { IViewBased } from './view';
+import type { ButtonsOption } from './toolbar';
+import type { IElms, IMods } from './traits';
+
+export interface IUIElement
+	extends IViewComponent,
+		IContainer,
+		IDestructible,
+		IMods,
+		IElms {
+	parentElement: Nullable<IUIElement>;
+	container: HTMLElement;
+	name: string;
+
+	/**
+	 * Apply callback for all parents
+	 */
+	bubble(callback: (parent: IUIElement) => void): this;
+
+	closest<T extends IUIElement>(type: Function): Nullable<T>;
+	closest<T extends IUIElement>(type: Function | T): Nullable<T>;
+
+	update(): void;
+	updateParentElement(target: IUIElement): this;
+	appendTo(element: HTMLElement): this;
+}
+
+export interface IUIIconState {
+	name: string;
+	iconURL: string;
+	fill: string;
+}
+
+export type ButtonVariant =
+	| 'initial'
+	| 'default'
+	| 'primary'
+	| 'secondary'
+	| 'success'
+	| 'danger';
+
+export interface IUIButtonState {
+	size: 'tiny' | 'xsmall' | 'small' | 'middle' | 'large';
+	name: string;
+	value: string | number | boolean;
+
+	variant: ButtonVariant;
+
+	type: 'button' | 'submit';
+	disabled: boolean;
+	activated: boolean;
+
+	icon: IUIIconState;
+
+	text: string;
+	tooltip: string;
+
+	tabIndex: CanUndef<number>;
+}
+
+export type IUIButtonStatePartial = Omit<Partial<IUIButtonState>, 'icon'> & {
+	icon?: Partial<IUIButtonState['icon']>;
+};
+
+export interface IUIButton extends IViewComponent, IUIElement, IFocusable {
+	readonly state: IUIButtonState;
+
+	setState(state: IUIButtonStatePartial): this;
+
+	readonly text: HTMLElement;
+	readonly icon: HTMLElement;
+
+	readonly isButton: true;
+
+	onAction(callback: (event: MouseEvent) => void): this;
+}
+
+export interface IUIGroup extends IUIElement {
+	readonly elements: IUIElement[];
+	readonly allChildren: IUIElement[];
+	append(elm: IUIElement | IUIElement[], distElement?: string): this;
+	remove(elm: IUIElement): this;
+	clear(): this;
+}
+
+export interface IUIList extends IUIGroup {
+	jodit: IViewBased;
+
+	mode: 'vertical' | 'horizontal';
+	buttonSize: IUIButtonState['size'];
+
+	buttons: IUIButton[];
+	getButtonsNames(): string[];
+
+	setRemoveButtons(removeButtons?: string[]): this;
+
+	build(items: ButtonsOption, target?: Nullable<HTMLElement>): IUIList;
+}
+
+export interface IUIForm extends IUIGroup {
+	container: HTMLFormElement;
+	submit(): void;
+	validate(): boolean;
+	onSubmit(handler: (data: IDictionary) => false | void): void;
+}
+
+export interface IUIInput extends IUIElement {
+	readonly nativeInput:
+		| HTMLInputElement
+		| HTMLSelectElement
+		| HTMLTextAreaElement;
+
+	readonly state: {
+		className: string;
+		autocomplete: boolean;
+		name: string;
+		value: string | number;
+		icon: string;
+		label: string;
+		ref: string;
+		type: 'text' | 'number' | 'checkbox' | 'url' | 'file' | 'hidden';
+		placeholder: string;
+		required: boolean;
+		validators: string[];
+		clearButton?: boolean;
+		onChange?: (value: string) => void;
+	};
+
+	value: string;
+	error: string;
+	validate(): boolean;
+	focus(): void;
+
+	readonly isFocused: boolean;
+}
+
+export interface IUIInputValidator<T extends IUIInput = IUIInput> {
+	(input: T): boolean;
+}
+
+export interface IUIOption {
+	value: string | boolean | number;
+	text: string;
+}
+
+export interface IUISelect extends IUIInput {
+	readonly nativeInput: HTMLSelectElement;
+
+	readonly state: IUIInput['state'] & {
+		options: IUIOption[];
+		size?: number;
+		multiple?: boolean;
+	};
+}
+
+export interface IUITextArea extends IUIInput {
+	readonly nativeInput: HTMLTextAreaElement;
+
+	readonly state: IUIInput['state'] & {
+		size?: number;
+		resizable?: boolean;
+	};
+}
+
+export interface IUIRange extends IUIInput {
+	readonly state: IUIInput['state'] & {
+		min: number;
+		max: number;
+	};
+}
+
+export interface IUICheckBox extends IUIInput {
+	readonly state: IUIInput['state'] & {
+		checked: boolean;
+		switch: boolean;
+	};
+}

package/esm/types/uploader.d.ts

@@ -0,0 +1,158 @@
+/*!
+ * Jodit Editor (https://xdsoft.net/jodit/)
+ * Released under MIT see LICENSE.txt in the project root for license information.
+ * Copyright (c) 2013-2023 Valeriy Chupurnov. All rights reserved. https://xdsoft.net
+ */
+
+/**
+ * @module types
+ */
+
+import type { CanPromise, IDictionary, IViewComponent } from './types';
+import type { IViewBased } from './view';
+import type { IAjax } from './ajax';
+
+interface IUploaderData {
+	messages?: string[];
+	files: string[];
+	isImages?: boolean[];
+	path?: string;
+	baseurl: string;
+	newfilename?: string;
+}
+
+interface IUploaderAnswer {
+	success: boolean;
+	time: string;
+	data: IUploaderData;
+}
+
+export type HandlerSuccess = (resp: IUploaderData) => void;
+export type HandlerError = (e: Error) => void;
+export type BuildDataResult =
+	| FormData
+	| IDictionary<string>
+	| Promise<FormData | IDictionary<string>>
+	| string;
+
+export interface IUploaderOptions<T> {
+	url:
+		| string
+		| ((request: FormData | IDictionary<string> | string) => string);
+	insertImageAsBase64URI: boolean;
+
+	/**
+	 * List of extensions for images
+	 * @default ['jpg', 'png', 'jpeg', 'gif']
+	 * @example
+	 * ```javascript
+	 * Jodit.make('#editor', {
+	 * 	uploader: {
+	 * 		insertImageAsBase64URI: true,
+	 * 		imagesExtensions: ['jpg', 'png', 'jpeg', 'gif', 'svg', 'webp']
+	 * 	}
+	 * });
+	 * ```
+	 */
+	imagesExtensions: string[];
+	headers?:
+		| IDictionary<string>
+		| null
+		| ((this: IAjax<any>) => CanPromise<IDictionary<string> | null>);
+	data: null | object;
+	format: string;
+	method: string;
+
+	filesVariableName: (i: number) => string;
+
+	/**
+	 * The method can be used to change the name of the uploaded file
+	 * This is the name the file will have when it is sent to the server
+	 * ```js
+	 * Jodit.make('#editor', {
+	 *  uploader: {
+	 *    url: 'some-connector.php',
+	 *    processFileName: (key, file, name) => {
+	 *      return [key, file, 'some-prefix_' + name];
+	 *    }
+	 *  }
+	 * });
+	 * ```
+	 */
+	processFileName(
+		this: T,
+		key: string,
+		file: File,
+		name: string
+	): [string, File, string];
+
+	/**
+	 * The method can be used to change the displayed name of the uploaded file
+	 * ```javascript
+	 * Jodit.make('#editor', {
+	 * 	uploader: {
+	 * 		url: 'https://sitename.net/jodit/connector/index.php?action=fileUpload',
+	 * 		getDisplayName: (_, name) => 'File:' + name
+	 * 	}
+	 * });
+	 * ```
+	 */
+	getDisplayName(this: T, baseurl: string, filename: string): string;
+
+	pathVariableName: string;
+	withCredentials: boolean;
+
+	prepareData: (this: T, formData: FormData) => any;
+	buildData?: (this: T, formData: any) => BuildDataResult;
+	queryBuild?: (
+		obj: string | IDictionary<string | object> | FormData,
+		prefix?: string
+	) => string | FormData;
+
+	isSuccess: (this: T, resp: IUploaderAnswer) => boolean;
+
+	getMessage: (this: T, resp: IUploaderAnswer) => string;
+
+	process: (this: T, resp: IUploaderAnswer) => IUploaderData;
+
+	error: (this: T, e: Error) => void;
+
+	defaultHandlerSuccess: HandlerSuccess;
+	defaultHandlerError: HandlerError;
+
+	contentType: (this: T, requestData: any) => string | false;
+}
+
+export interface IUploader extends IViewComponent {
+	readonly jodit: IViewBased;
+	readonly j: this['jodit'];
+
+	readonly options: IUploaderOptions<IUploader>;
+	readonly o: this['options'];
+
+	bind(
+		form: HTMLElement,
+		handlerSuccess?: HandlerSuccess,
+		handlerError?: HandlerError
+	): void;
+
+	uploadRemoteImage(
+		url: string,
+		handlerSuccess?: HandlerSuccess,
+		handlerError?: HandlerError
+	): void;
+
+	readonly path: string;
+
+	readonly source: string;
+
+	/**
+	 * It sets the path for uploading files
+	 */
+	setPath(path: string): this;
+
+	/**
+	 * It sets the source for connector
+	 */
+	setSource(source: string): this;
+}