suneditor 3.0.0-beta.9 → 3.0.0-rc.2

package/types/core/event/ports.d.ts

@@ -0,0 +1,256 @@
+import type {} from '../../typedef';
+/**
+ * @typedef {import('./eventOrchestrator').default} EventManagerInstanceType
+ */
+/**
+ * @typedef {import('../logic/dom/selection').default} Selection
+ * @typedef {import('../logic/dom/format').default} Format
+ * @typedef {import('../logic/dom/listFormat').default} ListFormat
+ * @typedef {import('../logic/shell/component').default} Component
+ * @typedef {import('../logic/dom/html').default} Html
+ * @typedef {import('../logic/dom/nodeTransform').default} NodeTransform
+ * @typedef {import('../logic/dom/char').default} Char
+ * @typedef {import('../logic/panel/menu').default} Menu
+ */
+/**
+ * @typedef {Object} SelectionPorts
+ * @property {(...args: Parameters<Selection['getRange']>) => ReturnType<Selection['getRange']>} getRange
+ * @property {(...args: Parameters<Selection['getNode']>) => ReturnType<Selection['getNode']>} getNode
+ * @property {(...args: Parameters<Selection['setRange']>) => ReturnType<Selection['setRange']>} setRange
+ * @property {(...args: Parameters<Selection['get']>) => ReturnType<Selection['get']>} get
+ */
+/**
+ * @typedef {Object} FormatPorts
+ * @property {(...args: Parameters<Format['isLine']>) => ReturnType<Format['isLine']>} isLine
+ * @property {(...args: Parameters<Format['getLine']>) => ReturnType<Format['getLine']>} getLine
+ * @property {(...args: Parameters<Format['getLines']>) => ReturnType<Format['getLines']>} getLines
+ * @property {(...args: Parameters<Format['getBrLine']>) => ReturnType<Format['getBrLine']>} getBrLine
+ * @property {(...args: Parameters<Format['getBlock']>) => ReturnType<Format['getBlock']>} getBlock
+ * @property {(...args: Parameters<Format['isNormalLine']>) => ReturnType<Format['isNormalLine']>} isNormalLine
+ * @property {(...args: Parameters<Format['isBrLine']>) => ReturnType<Format['isBrLine']>} isBrLine
+ * @property {(...args: Parameters<Format['isClosureBrLine']>) => ReturnType<Format['isClosureBrLine']>} isClosureBrLine
+ * @property {(...args: Parameters<Format['isClosureBlock']>) => ReturnType<Format['isClosureBlock']>} isClosureBlock
+ * @property {(...args: Parameters<Format['isEdgeLine']>) => ReturnType<Format['isEdgeLine']>} isEdgeLine
+ * @property {(...args: Parameters<Format['removeBlock']>) => ReturnType<Format['removeBlock']>} removeBlock
+ * @property {(...args: Parameters<Format['addLine']>) => ReturnType<Format['addLine']>} addLine
+ */
+/**
+ * @typedef {Object} ListFormatPorts
+ * @property {(...args: Parameters<ListFormat['applyNested']>) => ReturnType<ListFormat['applyNested']>} applyNested
+ */
+/**
+ * @typedef {Object} ComponentPorts
+ * @property {(...args: Parameters<Component['deselect']>) => ReturnType<Component['deselect']>} deselect
+ * @property {(...args: Parameters<Component['is']>) => ReturnType<Component['is']>} is
+ * @property {(...args: Parameters<Component['get']>) => ReturnType<Component['get']>} get
+ * @property {(...args: Parameters<Component['select']>) => ReturnType<Component['select']>} select
+ */
+/**
+ * @typedef {Object} HtmlPorts
+ * @property {(...args: Parameters<Html['remove']>) => ReturnType<Html['remove']>} remove
+ * @property {(...args: Parameters<Html['insert']>) => ReturnType<Html['insert']>} insert
+ * @property {(...args: Parameters<Html['insertNode']>) => ReturnType<Html['insertNode']>} insertNode
+ */
+/**
+ * @typedef {Object} NodeTransformPorts
+ * @property {(...args: Parameters<NodeTransform['removeAllParents']>) => ReturnType<NodeTransform['removeAllParents']>} removeAllParents
+ * @property {(...args: Parameters<NodeTransform['split']>) => ReturnType<NodeTransform['split']>} split
+ */
+/**
+ * @typedef {Object} CharPorts
+ * @property {(...args: Parameters<Char['check']>) => ReturnType<Char['check']>} check
+ */
+/**
+ * @typedef {Object} MenuPorts
+ * @property {(...args: Parameters<Menu['dropdownOff']>) => ReturnType<Menu['dropdownOff']>} dropdownOff
+ */
+/**
+ * @description Create ports for event reducers
+ * @param {EventManagerInstanceType} inst - EventManager instance
+ * @param {Object} param1 - Additional parameters
+ * @param {*} param1._styleNodes - Style nodes reference object
+ */
+export function makePorts(
+	inst: EventManagerInstanceType,
+	{
+		_styleNodes,
+	}: {
+		_styleNodes: any;
+	},
+): {
+	focusManager: {
+		nativeFocus: () => void;
+		blur: () => void;
+	};
+	selection: {
+		getRange: () => Range;
+		getNode: () => HTMLElement | Text;
+		setRange: (se: any, so: any, ec: any, eo: any) => Range;
+		get: () => globalThis.Selection;
+	};
+	format: {
+		isLine: (n: any) => n is HTMLElement;
+		getLine: (n: any, p: any) => HTMLElement;
+		getLines: (v: any) => HTMLElement[];
+		getBrLine: (n: any, p: any) => HTMLBRElement;
+		getBlock: (n: any, p: any) => HTMLElement;
+		isNormalLine: (n: any) => n is HTMLElement;
+		isBrLine: (n: any) => n is HTMLElement;
+		isClosureBrLine: (n: any) => n is HTMLElement;
+		isClosureBlock: (n: any) => n is HTMLElement;
+		isEdgeLine: (node: any, offset: any, dir: any) => node is HTMLElement;
+		removeBlock: (
+			n: any,
+			p: any,
+		) => {
+			cc: Node;
+			sc: Node;
+			so: number;
+			ec: Node;
+			eo: number;
+			removeArray: Array<Node> | null;
+		};
+		addLine: (el: any, nextOrTag: any) => HTMLElement;
+	};
+	listFormat: {
+		applyNested: (
+			cells: any,
+			shift: any,
+		) => {
+			sc: Node;
+			so: number;
+			ec: Node;
+			eo: number;
+		};
+	};
+	component: {
+		deselect: () => void;
+		is: (n: any) => boolean;
+		get: (n: any) => SunEditor.ComponentInfo;
+		select: (t: any, p: any) => boolean;
+	};
+	html: {
+		remove: () => {
+			container: Node;
+			offset: number;
+			commonCon?: Node | null;
+			prevContainer?: Node | null;
+		};
+		insert: (h: any, p: any) => HTMLElement;
+		insertNode: (n: any, p: any) => any;
+	};
+	history: {
+		push: (hard: any) => void;
+	};
+	nodeTransform: {
+		removeAllParents: (
+			s: any,
+			n: any,
+			p: any,
+		) => {
+			sc: Node | null;
+			ec: Node | null;
+		};
+		split: (n: any, o: any, d: any) => HTMLElement;
+	};
+	char: {
+		check: (content: any) => boolean;
+	};
+	menu: {
+		dropdownOff: () => void;
+	};
+	setDefaultLine: (tag: any) => void;
+	hideToolbar: () => void;
+	hideToolbar_sub: () => void;
+	styleNodeCache: () => Node[];
+	formatAttrsTempCache: (attrs: any) => any;
+	setOnShortcutKey: (v: any) => any;
+	/**
+	 * @description Scrolls the editor view to the caret position after pressing `Enter`. (Ignored on mobile devices)
+	 * @param {Range} range Range object
+	 */
+	enterScrollTo(range: Range): void;
+	/**
+	 * @description Prevents the default behavior of the `Enter` key and refocuses the editor.
+	 * @param {Event} e The keyboard event
+	 */
+	enterPrevent(e: Event): void;
+};
+export type EventManagerInstanceType = import('./eventOrchestrator').default;
+export type Selection = import('../logic/dom/selection').default;
+export type Format = import('../logic/dom/format').default;
+export type ListFormat = import('../logic/dom/listFormat').default;
+export type Component = import('../logic/shell/component').default;
+export type Html = import('../logic/dom/html').default;
+export type NodeTransform = import('../logic/dom/nodeTransform').default;
+export type Char = import('../logic/dom/char').default;
+export type Menu = import('../logic/panel/menu').default;
+export type SelectionPorts = {
+	getRange: (...args: Parameters<Selection['getRange']>) => ReturnType<Selection['getRange']>;
+	getNode: (...args: Parameters<Selection['getNode']>) => ReturnType<Selection['getNode']>;
+	setRange: (...args: Parameters<Selection['setRange']>) => ReturnType<Selection['setRange']>;
+	get: (...args: Parameters<Selection['get']>) => ReturnType<Selection['get']>;
+};
+export type FormatPorts = {
+	isLine: (...args: Parameters<Format['isLine']>) => ReturnType<Format['isLine']>;
+	getLine: (...args: Parameters<Format['getLine']>) => ReturnType<Format['getLine']>;
+	getLines: (...args: Parameters<Format['getLines']>) => ReturnType<Format['getLines']>;
+	getBrLine: (...args: Parameters<Format['getBrLine']>) => ReturnType<Format['getBrLine']>;
+	getBlock: (...args: Parameters<Format['getBlock']>) => ReturnType<Format['getBlock']>;
+	isNormalLine: (...args: Parameters<Format['isNormalLine']>) => ReturnType<Format['isNormalLine']>;
+	isBrLine: (...args: Parameters<Format['isBrLine']>) => ReturnType<Format['isBrLine']>;
+	isClosureBrLine: (...args: Parameters<Format['isClosureBrLine']>) => ReturnType<Format['isClosureBrLine']>;
+	isClosureBlock: (...args: Parameters<Format['isClosureBlock']>) => ReturnType<Format['isClosureBlock']>;
+	isEdgeLine: (...args: Parameters<Format['isEdgeLine']>) => ReturnType<Format['isEdgeLine']>;
+	removeBlock: (...args: Parameters<Format['removeBlock']>) => ReturnType<Format['removeBlock']>;
+	addLine: (...args: Parameters<Format['addLine']>) => ReturnType<Format['addLine']>;
+};
+export type ListFormatPorts = {
+	applyNested: (...args: Parameters<ListFormat['applyNested']>) => ReturnType<ListFormat['applyNested']>;
+};
+export type ComponentPorts = {
+	deselect: (...args: Parameters<Component['deselect']>) => ReturnType<Component['deselect']>;
+	is: (...args: Parameters<Component['is']>) => ReturnType<Component['is']>;
+	get: (...args: Parameters<Component['get']>) => ReturnType<Component['get']>;
+	select: (...args: Parameters<Component['select']>) => ReturnType<Component['select']>;
+};
+export type HtmlPorts = {
+	remove: (...args: Parameters<Html['remove']>) => ReturnType<Html['remove']>;
+	insert: (...args: Parameters<Html['insert']>) => ReturnType<Html['insert']>;
+	insertNode: (...args: Parameters<Html['insertNode']>) => ReturnType<Html['insertNode']>;
+};
+export type NodeTransformPorts = {
+	removeAllParents: (...args: Parameters<NodeTransform['removeAllParents']>) => ReturnType<NodeTransform['removeAllParents']>;
+	split: (...args: Parameters<NodeTransform['split']>) => ReturnType<NodeTransform['split']>;
+};
+export type CharPorts = {
+	check: (...args: Parameters<Char['check']>) => ReturnType<Char['check']>;
+};
+export type MenuPorts = {
+	dropdownOff: (...args: Parameters<Menu['dropdownOff']>) => ReturnType<Menu['dropdownOff']>;
+};
+export type EventReducerPorts = {
+	focusManager: {
+		nativeFocus: () => void;
+		blur: () => void;
+	};
+	selection: SelectionPorts;
+	format: FormatPorts;
+	listFormat: ListFormatPorts;
+	component: ComponentPorts;
+	html: HtmlPorts;
+	history: {
+		push: (hard: boolean) => void;
+	};
+	nodeTransform: NodeTransformPorts;
+	char: CharPorts;
+	menu: MenuPorts;
+	setDefaultLine: (tag: string) => void;
+	hideToolbar: () => void;
+	hideToolbar_sub: () => void;
+	styleNodeCache: () => void;
+	formatAttrsTempCache: (attrs: { [x: string]: any }) => void;
+	setOnShortcutKey: (v: boolean) => void;
+	enterPrevent: (e: Event) => void;
+	enterScrollTo: (range: Range) => void;
+};

package/types/core/event/reducers/keydown.reducer.d.ts

@@ -0,0 +1,84 @@
+import type {} from '../../../typedef';
+/**
+ * @typedef {import('../ports').EventReducerPorts} EventPorts
+ */
+/**
+ * @typedef {Object} KeydownReducerCtx - Keydown Reducer Context object
+ * @property {KeyboardEvent} ctx.e - The keyboard event
+ * @property {SunEditor.FrameContext} ctx.fc - Frame context object
+ * @property {SunEditor.Store} ctx.store - Editor store object
+ * @property {SunEditor.Options} ctx.options - Options object
+ * @property {SunEditor.FrameOptions} ctx.frameOptions - Frame options object
+ * @property {Range} ctx.range - Current selection range
+ * @property {HTMLElement|Text} ctx.selectionNode - Current selection node
+ * @property {HTMLElement} ctx.formatEl - Current format element
+ * @property {string} ctx.keyCode - Key code
+ * @property {boolean} ctx.ctrl - Whether the `ctrl` key is pressed
+ * @property {boolean} ctx.alt - Whether the `alt` key is pressed
+ * @property {boolean} ctx.shift - Whether the `shift` key is pressed
+ */
+/**
+ * @typedef {import('../actions').Action[]} EventActions
+ */
+/**
+ * @description Keydown event reducer
+ * @param {EventPorts} ports - Ports for interacting with editor
+ * @param {KeydownReducerCtx} ctx - Context object
+ * @returns {Promise<EventActions>} Action list
+ */
+export function reduceKeydown(ports: EventPorts, ctx: KeydownReducerCtx): Promise<EventActions>;
+export type EventPorts = import('../ports').EventReducerPorts;
+/**
+ * - Keydown Reducer Context object
+ */
+export type KeydownReducerCtx = {
+	/**
+	 * - The keyboard event
+	 */
+	e: KeyboardEvent;
+	/**
+	 * - Frame context object
+	 */
+	fc: SunEditor.FrameContext;
+	/**
+	 * - Editor store object
+	 */
+	store: SunEditor.Store;
+	/**
+	 * - Options object
+	 */
+	options: SunEditor.Options;
+	/**
+	 * - Frame options object
+	 */
+	frameOptions: SunEditor.FrameOptions;
+	/**
+	 * - Current selection range
+	 */
+	range: Range;
+	/**
+	 * - Current selection node
+	 */
+	selectionNode: HTMLElement | Text;
+	/**
+	 * - Current format element
+	 */
+	formatEl: HTMLElement;
+	/**
+	 * - Key code
+	 */
+	keyCode: string;
+	/**
+	 * - Whether the `ctrl` key is pressed
+	 */
+	ctrl: boolean;
+	/**
+	 * - Whether the `alt` key is pressed
+	 */
+	alt: boolean;
+	/**
+	 * - Whether the `shift` key is pressed
+	 */
+	shift: boolean;
+};
+export type EventActions = import('../actions').Action[];

package/types/core/event/rules/keydown.rule.arrow.d.ts

@@ -0,0 +1,19 @@
+import type {} from '../../../typedef';
+/**
+ * @typedef {import('../actions').Action[]} EventActions
+ * @typedef {import('../ports').EventReducerPorts} EventPorts
+ * @typedef {import('../reducers/keydown.reducer').KeydownReducerCtx} EventKeydownCtx
+ */
+/**
+ */
+/**
+ * @this {void}
+ * @description Arrow key down rule
+ * @param {EventActions} actions - Action list
+ * @param {EventPorts} ports - Ports for interacting with editor
+ * @param {EventKeydownCtx} ctx - Context object
+ */
+export function reduceArrowDown(this: void, actions: EventActions, ports: EventPorts, ctx: EventKeydownCtx): void;
+export type EventActions = import('../actions').Action[];
+export type EventPorts = import('../ports').EventReducerPorts;
+export type EventKeydownCtx = import('../reducers/keydown.reducer').KeydownReducerCtx;

package/types/core/event/rules/keydown.rule.backspace.d.ts

@@ -0,0 +1,18 @@
+import type {} from '../../../typedef';
+/**
+ * @typedef {import('../actions').Action[]} EventActions
+ * @typedef {import('../ports').EventReducerPorts} EventPorts
+ * @typedef {import('../reducers/keydown.reducer').KeydownReducerCtx} EventKeydownCtx
+ */
+/**
+ * @this {void}
+ * @description Backspace key down rule
+ * @param {EventActions} actions - Action list
+ * @param {EventPorts} ports - Ports for interacting with editor
+ * @param {EventKeydownCtx} ctx - Context object
+ * @returns {boolean} Return false to stop the processing
+ */
+export function reduceBackspaceDown(this: void, actions: EventActions, ports: EventPorts, ctx: EventKeydownCtx): boolean;
+export type EventActions = import('../actions').Action[];
+export type EventPorts = import('../ports').EventReducerPorts;
+export type EventKeydownCtx = import('../reducers/keydown.reducer').KeydownReducerCtx;

package/types/core/event/rules/keydown.rule.delete.d.ts

@@ -0,0 +1,18 @@
+import type {} from '../../../typedef';
+/**
+ * @typedef {import('../actions').Action[]} EventActions
+ * @typedef {import('../ports').EventReducerPorts} EventPorts
+ * @typedef {import('../reducers/keydown.reducer').KeydownReducerCtx} EventKeydownCtx
+ */
+/**
+ * @this {void}
+ * @description Delete key down rule
+ * @param {EventActions} actions - Action list
+ * @param {EventPorts} ports - Ports for interacting with editor
+ * @param {EventKeydownCtx} ctx - Context object
+ * @returns {boolean} Return false to stop the processing
+ */
+export function reduceDeleteDown(this: void, actions: EventActions, ports: EventPorts, ctx: EventKeydownCtx): boolean;
+export type EventActions = import('../actions').Action[];
+export type EventPorts = import('../ports').EventReducerPorts;
+export type EventKeydownCtx = import('../reducers/keydown.reducer').KeydownReducerCtx;

package/types/core/event/rules/keydown.rule.enter.d.ts

@@ -0,0 +1,18 @@
+import type {} from '../../../typedef';
+/**
+ * @typedef {import('../actions').Action[]} EventActions
+ * @typedef {import('../ports').EventReducerPorts} EventPorts
+ * @typedef {import('../reducers/keydown.reducer').KeydownReducerCtx} EventKeydownCtx
+ */
+/**
+ * @this {void}
+ * @description Enter key down rule
+ * @param {EventActions} actions - Action list
+ * @param {EventPorts} ports - Ports for interacting with editor
+ * @param {EventKeydownCtx} ctx - Context object
+ * @returns {boolean} Return false to stop the processing
+ */
+export function reduceEnterDown(this: void, actions: EventActions, ports: EventPorts, ctx: EventKeydownCtx): boolean;
+export type EventActions = import('../actions').Action[];
+export type EventPorts = import('../ports').EventReducerPorts;
+export type EventKeydownCtx = import('../reducers/keydown.reducer').KeydownReducerCtx;

package/types/core/event/rules/keydown.rule.tab.d.ts

@@ -0,0 +1,18 @@
+import type {} from '../../../typedef';
+/**
+ * @typedef {import('../actions').Action[]} EventActions
+ * @typedef {import('../ports').EventReducerPorts} EventPorts
+ * @typedef {import('../reducers/keydown.reducer').KeydownReducerCtx} EventKeydownCtx
+ */
+/**
+ * @this {void}
+ * @description Tab key down rule
+ * @param {EventActions} actions - Action list
+ * @param {EventPorts} _ports - Ports for interacting with editor
+ * @param {EventKeydownCtx} ctx - Context object
+ * @returns {boolean} Return false to stop the processing
+ */
+export function reduceTabDown(this: void, actions: EventActions, _ports: EventPorts, ctx: EventKeydownCtx): boolean;
+export type EventActions = import('../actions').Action[];
+export type EventPorts = import('../ports').EventReducerPorts;
+export type EventKeydownCtx = import('../reducers/keydown.reducer').KeydownReducerCtx;

package/types/core/event/support/defaultLineManager.d.ts

@@ -0,0 +1,22 @@
+import type {} from '../../../typedef';
+/**
+ * @description Service responsible for `line` breaking and default `line` creation logic.
+ * - Handles the `Enter` key behavior (`P` vs `BR` vs `DIV`).
+ * - Manages the initial `line` creation when the editor is empty.
+ */
+export default class DefaultLineManager {
+	/**
+	 * @constructor
+	 * @param {import('../eventOrchestrator').default} inst
+	 */
+	constructor({ $ }: import('../eventOrchestrator').default);
+	/**
+	 * @description Executes the default `line` creation logic.
+	 * - If no `formatName` is provided, it uses the `defaultLine` option (usually `P`).
+	 * - Handles creating a new `block` element when the user presses `Enter` or when initializing.
+	 * @param {string} [formatName] The tag name to be used for the new `line` (e.g., `P`, `DIV`, `BR`).
+	 * @returns {?void}
+	 */
+	execute(formatName?: string): void | null;
+	#private;
+}

package/types/core/event/support/selectionState.d.ts

@@ -0,0 +1,29 @@
+import type {} from '../../../typedef';
+/**
+ * @description Service class managing the selection state and toolbar updates.
+ * - Handles activating toolbar buttons based on the current selection.
+ * - Manages the `active` state of plugins and commands.
+ */
+export default class SelectionState {
+	/**
+	 * @constructor
+	 * @param {import('../eventOrchestrator').default} eventOrchestrator
+	 */
+	constructor(eventOrchestrator: import('../eventOrchestrator').default);
+	/**
+	 * @description Updates the toolbar state based on the current selection.
+	 * - Traverses the DOM from the selection to the root.
+	 * - Checks for active tags and styles.
+	 * - Activates corresponding toolbar buttons.
+	 * @param {Node} [selectionNode] The node where the selection is currently located.
+	 * @returns {Node|undefined} The processed selection node.
+	 */
+	update(selectionNode?: Node): Node | undefined;
+	/**
+	 * @description Resets the toolbar state.
+	 * - Deactivates all buttons and clears the effect.
+	 * - Equivalent to calling `setKeyEffect([])`.
+	 */
+	reset(): void;
+	#private;
+}