suneditor 3.0.0-alpha.2 → 3.0.0-alpha.20

package/types/core/base/events.d.ts

@@ -0,0 +1,297 @@
+declare namespace _default {
+	let onload: any;
+	let onScroll: any;
+	let onMouseDown: any;
+	let onClick: any;
+	let onInput: any;
+	let onMouseLeave: any;
+	let onKeyDown: any;
+	let onKeyUp: any;
+	let onFocus: any;
+	let onBlur: any;
+	let onCopy: any;
+	let onCut: any;
+	let onChange: any;
+	let onShowToolbar: any;
+	let onShowController: any;
+	let onBeforeShowController: any;
+	let onToggleCodeView: any;
+	let onToggleFullScreen: any;
+	let onResizeEditor: any;
+	let onSetToolbarButtons: any;
+	let onSave: any;
+	let onDrop: any;
+	let onPaste: any;
+	let imageUploadHandler: any;
+	let onImageUploadBefore: any;
+	let onImageLoad: any;
+	let onImageAction: any;
+	let onImageUploadError: any;
+	let onImageDeleteBefore: any;
+	let videoUploadHandler: any;
+	let onVideoUploadBefore: any;
+	let onVideoLoad: any;
+	let onVideoAction: any;
+	let onVideoUploadError: any;
+	let onVideoDeleteBefore: any;
+	let audioUploadHandler: any;
+	let onAudioUploadBefore: any;
+	let onAudioUploadError: any;
+	let onAudioLoad: any;
+	let onAudioAction: any;
+	let onAudioDeleteBefore: any;
+	let onFileUploadBefore: any;
+	let onFileLoad: any;
+	let onFileAction: any;
+	let onFileUploadError: any;
+	let onFileDeleteBefore: any;
+	let onExportPDFBefore: any;
+	let onFileManagerAction: any;
+	let onEmbedInputBefore: any;
+}
+export default _default;
+export type ControllerInstance = import('../../modules/Controller').default;
+export type BaseEvent = {
+	/**
+	 * - The root editor instance
+	 */
+	editor: __se__EditorCore;
+	/**
+	 * - frame context
+	 */
+	frameContext: __se__FrameContext;
+	/**
+	 * - event object
+	 */
+	event: Event;
+};
+export type ClipboardEvent = {
+	/**
+	 * - The root editor instance
+	 */
+	editor: __se__EditorCore;
+	/**
+	 * - frame context
+	 */
+	frameContext: __se__FrameContext;
+	/**
+	 * - event object
+	 */
+	event: Event;
+	/**
+	 * - drop data
+	 */
+	data: string;
+	/**
+	 * - is max char count
+	 */
+	maxCharCount: boolean;
+	/**
+	 * - "SE"|"MS"|"" - source
+	 */
+	from: string;
+};
+export type ControllerInfo = {
+	/**
+	 * - controller position
+	 */
+	position: 'top' | 'bottom' | 'position';
+	/**
+	 * - controller instance
+	 */
+	inst: ControllerInstance;
+	/**
+	 * - controller element
+	 */
+	form: HTMLElement;
+	/**
+	 * - controller target element
+	 */
+	target: HTMLElement;
+	/**
+	 * - If the target is a Range, set it to true.
+	 */
+	isRangeTarget: boolean;
+	/**
+	 * - "form"" is not included in the carrier.
+	 */
+	notInCarrier: boolean;
+};
+export type FileManagementInfo = {
+	/**
+	 * - source URL of the image.
+	 */
+	src: string;
+	/**
+	 * - index of the image.
+	 */
+	index: number;
+	/**
+	 * - name of the file.
+	 */
+	name: string;
+	/**
+	 * -  size of the file in bytes.
+	 */
+	size: number;
+	/**
+	 * -  target element.
+	 */
+	element: HTMLElement;
+	/**
+	 * -  delete function.
+	 */
+	delete: () => void;
+	/**
+	 * -  select function.
+	 */
+	select: () => void;
+};
+export type ProcessInfo = {
+	/**
+	 * - origin url
+	 */
+	origin: string;
+	/**
+	 * - url
+	 */
+	url: string;
+	/**
+	 * - tag name
+	 */
+	tag: 'video' | 'iframe';
+	/**
+	 * - embed children tags
+	 */
+	children: HTMLCollection | null;
+};
+export type ImageInfo = {
+	/**
+	 * - FileList object
+	 */
+	files: FileList;
+	/**
+	 * - target element
+	 */
+	element: HTMLImageElement;
+	/**
+	 * - width value
+	 */
+	inputWidth: string;
+	/**
+	 * - height value
+	 */
+	inputHeight: string;
+	/**
+	 * - align value
+	 */
+	align: string;
+	/**
+	 * - new create or update
+	 */
+	isUpdate: boolean;
+	/**
+	 * - Anchor element, if it exists
+	 */
+	anchor: HTMLElement | null;
+	/**
+	 * - alt text value
+	 */
+	alt: string;
+};
+export type VideoInfo = {
+	/**
+	 * - FileList object
+	 */
+	files: FileList;
+	/**
+	 * - target element
+	 */
+	element: HTMLIFrameElement | HTMLVideoElement;
+	/**
+	 * - width value
+	 */
+	inputWidth: string;
+	/**
+	 * - height value
+	 */
+	inputHeight: string;
+	/**
+	 * - align value
+	 */
+	align: string;
+	/**
+	 * - new create or update
+	 */
+	isUpdate: boolean;
+	/**
+	 * - video url
+	 */
+	url: string;
+	/**
+	 * - video process info
+	 */
+	process: ProcessInfo | null;
+};
+export type AudioInfo = {
+	/**
+	 * - target element
+	 */
+	element: HTMLAudioElement;
+	/**
+	 * - FileList object
+	 */
+	files: FileList;
+	/**
+	 * - new create or update
+	 */
+	isUpdate: boolean;
+};
+export type FileInfo = {
+	/**
+	 * - file url
+	 */
+	url: string;
+	/**
+	 * - FileList object
+	 */
+	files: FileList;
+	/**
+	 * - upload headers
+	 */
+	uploadHeaders: any;
+};
+export type EmbedInfo = {
+	/**
+	 * - target element
+	 */
+	element: HTMLElement;
+	/**
+	 * - width value
+	 */
+	inputWidth: string;
+	/**
+	 * - height value
+	 */
+	inputHeight: string;
+	/**
+	 * - align value
+	 */
+	align: string;
+	/**
+	 * - new create or update
+	 */
+	isUpdate: boolean;
+	/**
+	 * - embed url
+	 */
+	url: string;
+	/**
+	 * - When the input source is stacked in an iframe, etc., the actual embedded DOM
+	 */
+	children: HTMLElement | null;
+	/**
+	 * - embed process info
+	 */
+	process: ProcessInfo | null;
+};

package/types/core/base/history.d.ts

@@ -0,0 +1,81 @@
+/**
+ * @description History stack closure
+ * @param {__se__EditorCore} editor - The root editor instance
+ */
+export default function History(editor: __se__EditorCore): {
+	/**
+	 * @description Saving the current status to the history object stack
+	 * - If "delay" is true, it will be saved after (options.get('historyStackDelayTime') || 400) milliseconds.
+	 * - If the function is called again with the "delay" argument true before it is saved, the delay time is renewed.
+	 * - You can specify the delay time by sending a number.
+	 * @param {boolean|number} delay If true, add stack without delay time.
+	 * @param {*=} [rootKey] The key of the root frame to save history for.
+	 */
+	push(delay: boolean | number, rootKey?: any | undefined): void;
+	/**
+	 * @description Immediately saves the current state to the history stack if a delayed save is pending.
+	 * @param {*} rootKey The key of the root frame.
+	 * @param {Range} range The selection range object.
+	 */
+	check(rootKey: any, range: Range): void;
+	/**
+	 * @description Undo function that restores the previous state from the history stack.
+	 */
+	undo(): void;
+	/**
+	 * @description Redo function that re-applies a previously undone state from the history stack.
+	 */
+	redo(): void;
+	/**
+	 * @description Overwrites the current state in the history stack with the latest content.
+	 * @param {string=} [rootKey] The key of the root frame to overwrite.
+	 */
+	overwrite(rootKey?: string | undefined): void;
+	/**
+	 * @description Pauses the history stack, preventing new entries from being added for up to 5 seconds.
+	 */
+	pause(): void;
+	/**
+	 * @description Resumes history tracking by allowing new entries to be added to the stack.
+	 */
+	resume(): void;
+	/**
+	 * @description Resets the history stack and disables related UI buttons.
+	 */
+	reset(): void;
+	/**
+	 * @description Updates the state of history-related buttons (undo, redo, save) based on the current history stack.
+	 * @param {*} rootKey The key of the root frame.
+	 * @param {number} [index] The index of the current history state.
+	 */
+	resetButtons(rootKey: any, index?: number): void;
+	/**
+	 * @description Returns the root stack containing the history of each frame.
+	 * @returns {{content: string, s: {path: number|number[], offset: number|number[]}, e: {path: number|number[], offset: number|number[]}, frame: HTMLElement}} The root stack object.
+	 * - content: content html string
+	 * - s: depth info of the "start" range
+	 * - e: depth info of the "end" range
+	 * - frame: wysiwyg editable element.
+	 */
+	getRootStack(): {
+		content: string;
+		s: {
+			path: number | number[];
+			offset: number | number[];
+		};
+		e: {
+			path: number | number[];
+			offset: number | number[];
+		};
+		frame: HTMLElement;
+	};
+	/**
+	 * @description Resets the delay time for saving history.
+	 * @param {number} ms The new delay time in milliseconds.
+	 */
+	resetDelayTime(ms: number): void;
+	/**
+	 * @description Clears the entire history stack and cancels any pending save operations.
+	 */
+	destroy(): void;
+};

package/types/core/class/char.d.ts

@@ -0,0 +1,60 @@
+export default Char;
+export type CharThis = Omit<Char & Partial<__se__EditorInjector>, 'char'>;
+/**
+ * @typedef {Omit<Char & Partial<__se__EditorInjector>, 'char'>} CharThis
+ */
+/**
+ * @constructor
+ * @this {CharThis}
+ * @description character count, character limit, etc. management class
+ * @param {__se__EditorCore} editor - The root editor instance
+ */
+declare function Char(this: Omit<Char & Partial<import('../../editorInjector').default>, 'char'>, editor: __se__EditorCore): void;
+declare class Char {
+	/**
+	 * @typedef {Omit<Char & Partial<__se__EditorInjector>, 'char'>} CharThis
+	 */
+	/**
+	 * @constructor
+	 * @this {CharThis}
+	 * @description character count, character limit, etc. management class
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 */
+	constructor(editor: __se__EditorCore);
+	/**
+	 * @this {CharThis}
+	 * @description Returns false if char count is greater than "frameOptions.get('charCounter_max')" when "html" is added to the current editor.
+	 * @param {Node|string} html Element node or String.
+	 * @returns {boolean}
+	 */
+	check(this: Omit<Char & Partial<import('../../editorInjector').default>, 'char'>, html: Node | string): boolean;
+	/**
+	 * @this {CharThis}
+	 * @description Get the [content]'s number of characters or binary data size. (frameOptions.get('charCounter_type'))
+	 * - If [content] is undefined, get the current editor's number of characters or binary data size.
+	 * @param {string=} content Content to count. (defalut: this.editor.frameContext.get('wysiwyg'))
+	 * @returns {number}
+	 */
+	getLength(this: Omit<Char & Partial<import('../../editorInjector').default>, 'char'>, content?: string | undefined): number;
+	/**
+	 * @this {CharThis}
+	 * @descriptionGets Get the length in bytes of a string.
+	 * @param {string} text String text
+	 * @returns {number}
+	 */
+	getByteLength(this: Omit<Char & Partial<import('../../editorInjector').default>, 'char'>, text: string): number;
+	/**
+	 * @this {CharThis}
+	 * @description Set the char count to charCounter element textContent.
+	 */
+	display(this: Omit<Char & Partial<import('../../editorInjector').default>, 'char'>): void;
+	/**
+	 * @this {CharThis}
+	 * @description Returns false if char count is greater than "frameOptions.get('charCounter_max')" when "inputText" is added to the current editor.
+	 * - If the current number of characters is greater than "charCounter_max", the excess characters are removed.
+	 * And call the char.display()
+	 * @param {string} inputText Text added.
+	 * @returns {boolean}
+	 */
+	test(this: Omit<Char & Partial<import('../../editorInjector').default>, 'char'>, inputText: string, _fromInputEvent: any): boolean;
+}

package/types/core/class/component.d.ts

@@ -0,0 +1,259 @@
+export default Component;
+export type ComponentThis = Omit<Component & Partial<__se__EditorInjector>, 'component'>;
+export type ComponentInfo = {
+	/**
+	 * - The target element associated with the component.
+	 */
+	target: HTMLElement;
+	/**
+	 * - The name of the plugin related to the component.
+	 */
+	pluginName: string;
+	/**
+	 * - Options related to the component.
+	 */
+	options: {
+		[x: string]: any;
+	};
+	/**
+	 * - The main container element for the component.
+	 */
+	container: HTMLElement;
+	/**
+	 * - The cover element, if applicable.
+	 */
+	cover: HTMLElement | null;
+	/**
+	 * - The inline cover element, if applicable.
+	 */
+	inlineCover: HTMLElement | null;
+	/**
+	 * - The caption element, if applicable.
+	 */
+	caption: HTMLElement | null;
+	/**
+	 * - Whether the component is a file-related component.
+	 */
+	isFile: boolean;
+	/**
+	 * - The element that triggered the component, if applicable.
+	 */
+	launcher: HTMLElement | null;
+};
+/**
+ * @typedef {Omit<Component & Partial<__se__EditorInjector>, 'component'>} ComponentThis
+ */
+/**
+ * @typedef {Object} ComponentInfo
+ * @property {HTMLElement} target - The target element associated with the component.
+ * @property {string} pluginName - The name of the plugin related to the component.
+ * @property {Object<string, *>} options - Options related to the component.
+ * @property {HTMLElement} container - The main container element for the component.
+ * @property {?HTMLElement} cover - The cover element, if applicable.
+ * @property {?HTMLElement} inlineCover - The inline cover element, if applicable.
+ * @property {?HTMLElement} caption - The caption element, if applicable.
+ * @property {boolean} isFile - Whether the component is a file-related component.
+ * @property {?HTMLElement} launcher - The element that triggered the component, if applicable.
+ */
+/**
+ * @constructor
+ * @this {ComponentThis}
+ * @description Class for managing components such as images and tables that are not in line format
+ * @param {__se__EditorCore} editor - The root editor instance
+ */
+declare function Component(this: Omit<Component & Partial<import('../../editorInjector').default>, 'component'>, editor: __se__EditorCore): void;
+declare class Component {
+	/**
+	 * @typedef {Omit<Component & Partial<__se__EditorInjector>, 'component'>} ComponentThis
+	 */
+	/**
+	 * @typedef {Object} ComponentInfo
+	 * @property {HTMLElement} target - The target element associated with the component.
+	 * @property {string} pluginName - The name of the plugin related to the component.
+	 * @property {Object<string, *>} options - Options related to the component.
+	 * @property {HTMLElement} container - The main container element for the component.
+	 * @property {?HTMLElement} cover - The cover element, if applicable.
+	 * @property {?HTMLElement} inlineCover - The inline cover element, if applicable.
+	 * @property {?HTMLElement} caption - The caption element, if applicable.
+	 * @property {boolean} isFile - Whether the component is a file-related component.
+	 * @property {?HTMLElement} launcher - The element that triggered the component, if applicable.
+	 */
+	/**
+	 * @constructor
+	 * @this {ComponentThis}
+	 * @description Class for managing components such as images and tables that are not in line format
+	 * @param {__se__EditorCore} editor - The root editor instance
+	 */
+	constructor(editor: __se__EditorCore);
+	/**
+	 * @description The current component information, used copy, cut, and keydown events
+	 * @type {ComponentInfo}
+	 */
+	info: ComponentInfo;
+	/**
+	 * @description Component is selected
+	 * @type {boolean}
+	 */
+	isSelected: boolean;
+	/**
+	 * @description Currently selected component target
+	 * @type {Node|null}
+	 */
+	currentTarget: Node | null;
+	/**
+	 * @description Currently selected component plugin instance
+	 * @type {*}
+	 */
+	currentPlugin: any;
+	/**
+	 * @description Currently selected component plugin name
+	 * @type {*}
+	 */
+	currentPluginName: any;
+	/**
+	 * @description Currently selected component information
+	 * @type {ComponentInfo|null}
+	 */
+	currentInfo: ComponentInfo | null;
+	/** @type {Object<string, (...args: *) => *>} */
+	__globalEvents: {
+		[x: string]: (...args: any) => any;
+	};
+	/** @type {__se__GlobalEventInfo|void} */
+	_bindClose_copy: __se__GlobalEventInfo | void;
+	/** @type {__se__GlobalEventInfo|void} */
+	_bindClose_cut: __se__GlobalEventInfo | void;
+	/** @type {__se__GlobalEventInfo|void} */
+	_bindClose_keydown: __se__GlobalEventInfo | void;
+	/** @type {__se__GlobalEventInfo|void} */
+	_bindClose_mousedown: __se__GlobalEventInfo | void;
+	/** @type {__se__GlobalEventInfo|void} */
+	_bindClose_touchstart: __se__GlobalEventInfo | void;
+	/** @type {boolean} */
+	__selectionSelected: boolean;
+	/**
+	 * @this {ComponentThis}
+	 * @description Inserts an element and returns it. (Used for elements: table, hr, image, video)
+	 * - If "element" is "HR", inserts and returns the new line.
+	 * @param {Node} element Element to be inserted
+	 * @param {Object} [options] Options
+	 * @param {boolean} [options.skipCharCount=false] If true, it will be inserted even if "frameOptions.get('charCounter_max')" is exceeded.
+	 * @param {boolean} [options.skipSelection=false] If true, do not automatically select the inserted component.
+	 * @param {boolean} [options.skipHistory=false] If true, do not push to history.
+	 * @returns {HTMLElement} The inserted element or new line (for HR)
+	 */
+	insert(
+		this: Omit<Component & Partial<import('../../editorInjector').default>, 'component'>,
+		element: Node,
+		{
+			skipCharCount,
+			skipSelection,
+			skipHistory
+		}?: {
+			skipCharCount?: boolean;
+			skipSelection?: boolean;
+			skipHistory?: boolean;
+		}
+	): HTMLElement;
+	/**
+	 * @this {ComponentThis}
+	 * @description Gets the file component and that plugin name
+	 * - return: {target, component, pluginName} | null
+	 * @param {Node} element Target element (figure tag, component div, file tag)
+	 * @returns {ComponentInfo|null}
+	 */
+	get(this: Omit<Component & Partial<import('../../editorInjector').default>, 'component'>, element: Node): ComponentInfo | null;
+	/**
+	 * @this {ComponentThis}
+	 * @description The component(media, file component, table, etc) is selected and the resizing module is called.
+	 * @param {Node} element Target element
+	 * @param {string} pluginName The plugin name for the selected target.
+	 * @param {boolean=} isInput Whether the target is an input component.(table)
+	 */
+	select(this: Omit<Component & Partial<import('../../editorInjector').default>, 'component'>, element: Node, pluginName: string, isInput?: boolean | undefined): boolean;
+	/**
+	 * @this {ComponentThis}
+	 * @description Deselects the selected component.
+	 */
+	deselect(this: Omit<Component & Partial<import('../../editorInjector').default>, 'component'>): void;
+	/**
+	 * @this {ComponentThis}
+	 * @description Determines if the specified node is a block component (e.g., img, iframe, video, audio, table) with the class "se-component"
+	 * - or a direct FIGURE node. This function checks if the node itself is a component
+	 * - or if it belongs to any components identified by the component manager.
+	 * @param {Node} element The DOM node to check.
+	 * @returns {boolean} True if the node is a block component or part of it, otherwise false.
+	 */
+	is(this: Omit<Component & Partial<import('../../editorInjector').default>, 'component'>, element: Node): boolean;
+	/**
+	 * @this {ComponentThis}
+	 * @description Checks if the given node is an inline component (class "se-inline-component").
+	 * - If the node is a FIGURE, it checks the parent element instead.
+	 * - It also verifies whether the node is part of an inline component recognized by the component manager.
+	 * @param {Node} element The DOM node to check.
+	 * @returns {boolean} True if the node is an inline component or part of it, otherwise false.
+	 */
+	isInline(this: Omit<Component & Partial<import('../../editorInjector').default>, 'component'>, element: Node): boolean;
+	/**
+	 * @this {ComponentThis}
+	 * @description Checks if the specified node qualifies as a basic component within the editor.
+	 * - This function verifies whether the node is recognized as a component by the `is` function, while also ensuring that it is not an inline component as determined by the `isInline` function.
+	 * - This is used to identify block-level elements or standalone components that are not part of the inline component classification.
+	 * @param {Node} element The DOM node to check.
+	 * @returns {boolean} True if the node is a basic (non-inline) component, otherwise false.
+	 */
+	isBasic(this: Omit<Component & Partial<import('../../editorInjector').default>, 'component'>, element: Node): boolean;
+	/**
+	 * @private
+	 * @this {ComponentThis}
+	 * @description Checks if the given element is a file component by matching its tag name against the file manager's regular expressions.
+	 * - It also verifies whether the element has the required attributes based on the tag type.
+	 * @param {Node} element The element to check.
+	 * @returns {boolean} Returns true if the element is a file component, otherwise false.
+	 */
+	__isFiles(this: Omit<Component & Partial<import('../../editorInjector').default>, 'component'>, element: Node): boolean;
+	/**
+	 * @private
+	 * @this {ComponentThis}
+	 * @description Deselects the currently selected component, removing any selection effects and associated event listeners.
+	 * - This method resets the selection state and hides UI elements related to the component selection.
+	 */
+	__deselect(this: Omit<Component & Partial<import('../../editorInjector').default>, 'component'>): void;
+	/**
+	 * @private
+	 * @this {ComponentThis}
+	 * @description Set line breaker of component
+	 * @param {HTMLElement} element Element tag
+	 */
+	_setComponentLineBreaker(this: Omit<Component & Partial<import('../../editorInjector').default>, 'component'>, element: HTMLElement): void;
+	/**
+	 * @private
+	 * @this {ComponentThis}
+	 * @description Adds global event listeners for component interactions such as copy, cut, and keydown events.
+	 */
+	__addGlobalEvent(this: Omit<Component & Partial<import('../../editorInjector').default>, 'component'>): void;
+	/**
+	 * @private
+	 * @this {ComponentThis}
+	 * @description Removes global event listeners that were previously added for component interactions.
+	 */
+	__removeGlobalEvent(this: Omit<Component & Partial<import('../../editorInjector').default>, 'component'>): void;
+	/**
+	 * @private
+	 * @this {ComponentThis}
+	 * @description Adds global event listeners for non-file-related interactions such as mouse and touch events.
+	 */
+	__addNotFileGlobalEvent(this: Omit<Component & Partial<import('../../editorInjector').default>, 'component'>): void;
+	/**
+	 * @private
+	 * @this {ComponentThis}
+	 * @description Removes global event listeners related to non-file interactions.
+	 */
+	__removeNotFileGlobalEvent(this: Omit<Component & Partial<import('../../editorInjector').default>, 'component'>): void;
+	/**
+	 * @private
+	 * @this {ComponentThis}
+	 * @description Removes drag-related events and resets drag-related states.
+	 */
+	_removeDragEvent(this: Omit<Component & Partial<import('../../editorInjector').default>, 'component'>): void;
+}