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

package/types/assets/suneditor-contents.css.d.ts

@@ -0,0 +1 @@
+declare module 'suneditor/css/contents';

package/types/assets/suneditor.css.d.ts

@@ -0,0 +1 @@
+declare module 'suneditor/css';

package/types/core/config/contextProvider.d.ts

@@ -0,0 +1,148 @@
+import type {} from '../../typedef';
+/**
+ * @typedef {import('../schema/frameContext').FrameContextStore} ConfigFrameContextStore
+ * @typedef {import('../schema/context').ContextStore} ConfigContextStore
+ */
+/**
+ * @typedef {Object} ContextMap
+ * @property {(k: keyof ConfigContextStore) => HTMLElement|null} get - Get a DOM element from the context by key.
+ * @property {(k: keyof ConfigContextStore, v: HTMLElement) => void} set - Set a DOM element in the context by key.
+ * @property {(k: keyof ConfigContextStore) => boolean} has - Check if a key exists in the context.
+ * @property {(k: keyof ConfigContextStore) => boolean} delete - Delete a key from the context.
+ * @property {() => Object<keyof ConfigContextStore, HTMLElement|null>} [getAll] - Get all DOM elements in the context as an object.
+ * @property {number} size - Get context size
+ * @property {() => void} clear - Clear all elements in the context.
+ */
+/**
+ * @typedef {Object} FrameContextMap
+ * @property {<K extends keyof ConfigFrameContextStore>(k: K) => ConfigFrameContextStore[K]} get - Get a DOM element from the context by key.
+ * @property {<K extends keyof ConfigFrameContextStore>(k: K, v: ConfigFrameContextStore[K]) => void} set - Set a DOM element in the context by key.
+ * @property {<K extends keyof ConfigFrameContextStore>(k: K) => boolean} has - Check if a key exists in the context.
+ * @property {<K extends keyof ConfigFrameContextStore>(k: K) => boolean} delete - Delete a key from the context.
+ * @property {() => Object<keyof ConfigFrameContextStore, *>} [getAll] - Get all DOM elements in the context as an object.
+ * @property {(newMap: *) => void} [reset] - Reset the context with a new Map.
+ * @property {number} size - Get context size
+ * @property {() => void} clear - Clear all elements in the context.
+ */
+/**
+ * @description Provides Map-based access to editor DOM contexts (global and per-frame).
+ */
+export default class ContextProvider {
+	/**
+	 * @constructor
+	 * @param {import('../section/constructor').ConstructorReturnType} product
+	 */
+	constructor(product: import('../section/constructor').ConstructorReturnType);
+	/**
+	 * @description Frame root key array
+	 * @type {Array<*>}
+	 */
+	rootKeys: Array<any>;
+	/**
+	 * @description Controllers carrier
+	 * @type {HTMLElement}
+	 */
+	carrierWrapper: HTMLElement;
+	/**
+	 * @description Default icons object
+	 * @type {Object<string, string>}
+	 */
+	icons: {
+		[x: string]: string;
+	};
+	/**
+	 * @description loaded language
+	 * @type {Object<string, *>}
+	 */
+	lang: {
+		[x: string]: any;
+	};
+	/**
+	 * @description Closest ShadowRoot to editor if found
+	 * @type {ShadowRoot & { getSelection?: () => Selection }} - Chromium-based browsers (Chrome, Edge, etc.) has a getSelection method on the ShadowRoot
+	 */
+	shadowRoot: ShadowRoot & {
+		getSelection?: () => Selection;
+	};
+	get frameRoots(): Map<string, import('../schema/frameContext').FrameContexType>;
+	get context(): ContextMap;
+	get frameContext(): FrameContextMap;
+	init(): void;
+	/**
+	 * @param {SunEditor.FrameContext} rt Root target[key] FrameContext
+	 */
+	reset(rt: SunEditor.FrameContext): void;
+	/**
+	 * @description Execute a function by traversing all root targets.
+	 * @param {(frameContext: SunEditor.FrameContext, rootKey: string|null, frameRoots: Map<string|null, SunEditor.FrameContext>) => void} f Callback function
+	 */
+	applyToRoots(f: (frameContext: SunEditor.FrameContext, rootKey: string | null, frameRoots: Map<string | null, SunEditor.FrameContext>) => void): void;
+	_destroy(): void;
+	#private;
+}
+export type ConfigFrameContextStore = import('../schema/frameContext').FrameContextStore;
+export type ConfigContextStore = import('../schema/context').ContextStore;
+export type ContextMap = {
+	/**
+	 * - Get a DOM element from the context by key.
+	 */
+	get: (k: keyof ConfigContextStore) => HTMLElement | null;
+	/**
+	 * - Set a DOM element in the context by key.
+	 */
+	set: (k: keyof ConfigContextStore, v: HTMLElement) => void;
+	/**
+	 * - Check if a key exists in the context.
+	 */
+	has: (k: keyof ConfigContextStore) => boolean;
+	/**
+	 * - Delete a key from the context.
+	 */
+	delete: (k: keyof ConfigContextStore) => boolean;
+	/**
+	 * - Get all DOM elements in the context as an object.
+	 */
+	getAll?: () => any;
+	/**
+	 * - Get context size
+	 */
+	size: number;
+	/**
+	 * - Clear all elements in the context.
+	 */
+	clear: () => void;
+};
+export type FrameContextMap = {
+	/**
+	 * - Get a DOM element from the context by key.
+	 */
+	get: <K extends keyof ConfigFrameContextStore>(k: K) => ConfigFrameContextStore[K];
+	/**
+	 * - Set a DOM element in the context by key.
+	 */
+	set: <K extends keyof ConfigFrameContextStore>(k: K, v: ConfigFrameContextStore[K]) => void;
+	/**
+	 * - Check if a key exists in the context.
+	 */
+	has: <K extends keyof ConfigFrameContextStore>(k: K) => boolean;
+	/**
+	 * - Delete a key from the context.
+	 */
+	delete: <K extends keyof ConfigFrameContextStore>(k: K) => boolean;
+	/**
+	 * - Get all DOM elements in the context as an object.
+	 */
+	getAll?: () => any;
+	/**
+	 * - Reset the context with a new Map.
+	 */
+	reset?: (newMap: any) => void;
+	/**
+	 * - Get context size
+	 */
+	size: number;
+	/**
+	 * - Clear all elements in the context.
+	 */
+	clear: () => void;
+};

package/types/core/config/eventManager.d.ts

@@ -0,0 +1,68 @@
+import type {} from '../../typedef';
+export default EventManager;
+/**
+ * @description Event manager, editor's all event management class
+ */
+declare class EventManager {
+	/**
+	 * @constructor
+	 * @param {import('./contextProvider').default} contextProvider
+	 * @param {import('./optionProvider').default} optionProvider
+	 * @param {import('../kernel/coreKernel').Deps} $
+	 */
+	constructor(contextProvider: import('./contextProvider').default, optionProvider: import('./optionProvider').default, $: import('../kernel/coreKernel').Deps);
+	/**
+	 * @description Events object, call by triggerEvent function
+	 * @type {SunEditor.Event.Handlers}
+	 */
+	events: SunEditor.Event.Handlers;
+	/**
+	 * @description Call the event function by injecting self: this.
+	 * @type {(eventName: string, ...args: *) => Promise<*>}
+	 */
+	triggerEvent: (eventName: string, ...args: any) => Promise<any>;
+	/** @type {HTMLInputElement} */
+	__focusTemp: HTMLInputElement;
+	/**
+	 * @description Register for an event.
+	 * - Only events registered with this method are unregistered or re-registered when methods such as 'setOptions', 'destroy' are called.
+	 * @param {*} target Target element
+	 * @param {string} type Event type
+	 * @param {EventListenerOrEventListenerObject} listener Event handler
+	 * @param {boolean|AddEventListenerOptions} [useCapture] Event useCapture option
+	 * @return {?SunEditor.Event.Info} Registered event information
+	 */
+	addEvent(target: any, type: string, listener: EventListenerOrEventListenerObject, useCapture?: boolean | AddEventListenerOptions): SunEditor.Event.Info | null;
+	/**
+	 * @description Remove event
+	 * @param {SunEditor.Event.Info} params event info = this.addEvent()
+	 * @returns {undefined|null} Success: null, Not found: undefined
+	 */
+	removeEvent(params: SunEditor.Event.Info): undefined | null;
+	/**
+	 * @description Add an event to document.
+	 * - When created as an Iframe, the same event is added to the document in the Iframe.
+	 * @param {string} type Event type
+	 * @param {(...args: *) => *} listener Event listener
+	 * @param {boolean|AddEventListenerOptions} [useCapture] Use event capture
+	 * @return {SunEditor.Event.GlobalInfo} Registered event information
+	 */
+	addGlobalEvent(type: string, listener: (...args: any) => any, useCapture?: boolean | AddEventListenerOptions): SunEditor.Event.GlobalInfo;
+	/**
+	 * @description Remove events from document.
+	 * - When created as an Iframe, the event of the document inside the Iframe is also removed.
+	 * @param {string|SunEditor.Event.GlobalInfo} type Event type or (Event info = this.addGlobalEvent())
+	 * @param {(...args: *) => *} [listener] Event listener
+	 * @param {boolean|AddEventListenerOptions} [useCapture] Use event capture
+	 * @returns {undefined|null} Success: null, Not found: undefined
+	 */
+	removeGlobalEvent(type: string | SunEditor.Event.GlobalInfo, listener?: (...args: any) => any, useCapture?: boolean | AddEventListenerOptions): undefined | null;
+	/**
+	 * @internal
+	 * @description Gives an active effect when the mouse down event is blocked. (Used when "env.isGecko" is true)
+	 * @param {Node} target Target element
+	 */
+	_injectActiveEvent(target: Node): void;
+	_init(): void;
+	#private;
+}

package/types/core/config/instanceCheck.d.ts

@@ -0,0 +1,33 @@
+import type {} from '../../typedef';
+export default InstanceCheck;
+/**
+ * @description iframe-safe instanceof check utility class
+ */
+declare class InstanceCheck {
+	/**
+	 * @constructor
+	 * @param {SunEditor.FrameContext} frameContext - Frame context
+	 */
+	constructor(frameContext: SunEditor.FrameContext);
+	/**
+	 * @param {*} obj
+	 * @returns {obj is Node}
+	 */
+	isNode(obj: any): obj is Node;
+	/**
+	 * @param {*} obj
+	 * @returns {obj is Element}
+	 */
+	isElement(obj: any): obj is Element;
+	/**
+	 * @param {*} obj
+	 * @returns {obj is Range}
+	 */
+	isRange(obj: any): obj is Range;
+	/**
+	 * @param {*} obj
+	 * @returns {obj is Selection}
+	 */
+	isSelection(obj: any): obj is Selection;
+	#private;
+}

package/types/core/config/optionProvider.d.ts

@@ -0,0 +1,147 @@
+import type {} from '../../typedef';
+/**
+ * @typedef {import('../schema/options').ProcessedBaseOptions} ConfigAllBaseOptions
+ * @typedef {import('../schema/options').ProcessedFrameOptions} ConfigAllFrameOptions
+ */
+/**
+ * @typedef {Object} BaseOptionsMap
+ * - A Map containing all processed editor base options.
+ * - This Map contains all keys from {@link ConfigAllBaseOptions}, where:
+ * - Keys are option names (string)
+ * - Values depend on the specific option (see {@link ConfigAllBaseOptions} for details)
+ *
+ * @property {<K extends keyof ConfigAllBaseOptions>(k: K) => ConfigAllBaseOptions[K]} get - Retrieves the value of a specific option.
+ * @property {<K extends keyof ConfigAllBaseOptions>(k: K, v: ConfigAllBaseOptions[K]) => void} set - Sets the value of a specific option.
+ * @property {<K extends keyof ConfigAllBaseOptions>(k: K) => boolean} has - Checks if a specific option exists.
+ * @property {() => Object<keyof ConfigAllBaseOptions, *>} getAll - Retrieves all options as an object.
+ * @property {(options: Map<*, *>) => void} setMany - Sets multiple options at once.
+ * @property {(newMap: SunEditor.InitOptions) => void} reset - Replaces all options with a new Map.
+ * @property {() => number} size - Get option size
+ * @property {() => void} clear - Clears all stored options.
+ */
+/**
+ * @typedef {Object} FrameOptionsMap
+ * - A Map containing all processed frame-level options.
+ * - This Map contains all keys from {@link ConfigAllFrameOptions}, where:
+ * - Keys are option names (string)
+ * - Values depend on the specific option (see {@link ConfigAllFrameOptions} for details)
+ *
+ * @property {<K extends keyof ConfigAllFrameOptions>(k: K) => ConfigAllFrameOptions[K]} get - Retrieves the value of a specific option.
+ * @property {<K extends keyof ConfigAllFrameOptions>(k: K, v: ConfigAllFrameOptions[K]) => void} set - Sets the value of a specific option.
+ * @property {<K extends keyof ConfigAllFrameOptions>(k: K) => boolean} has - Checks if a specific option exists.
+ * @property {() => Object<keyof ConfigAllFrameOptions, *>} getAll - Retrieves all options as an object.
+ * @property {(options: Map<*, *>) => void} setMany - Sets multiple options at once.
+ * @property {(newMap: SunEditor.FrameOptions) => void} reset - Replaces all options with a new Map.
+ * @property {() => number} size - Get option size
+ * @property {() => void} clear - Clears all stored options.
+ */
+/**
+ * @description Provides Map-based access to editor options (base and per-frame).
+ */
+export default class OptionProvider {
+	/**
+	 * @constructor
+	 * @param {SunEditor.Kernel} kernel
+	 * @param {import('../section/constructor').ConstructorReturnType} product
+	 */
+	constructor(kernel: SunEditor.Kernel, product: import('../section/constructor').ConstructorReturnType, options: any);
+	/**
+	 * @return {BaseOptionsMap}
+	 */
+	get options(): BaseOptionsMap;
+	get frameOptions(): FrameOptionsMap;
+	/**
+	 * @description Add or reset option property (Editor is reloaded)
+	 * @param {SunEditor.InitOptions} newOptions Options
+	 */
+	reset(newOptions: SunEditor.InitOptions): void;
+	/**
+	 * @description Add or reset frame option property (Editor is reloaded)
+	 * @param {SunEditor.FrameOptions} newOptions Options
+	 */
+	resetFrame(newOptions: SunEditor.FrameOptions): void;
+	_destroy(): void;
+	#private;
+}
+export type ConfigAllBaseOptions = import('../schema/options').ProcessedBaseOptions;
+export type ConfigAllFrameOptions = import('../schema/options').ProcessedFrameOptions;
+/**
+ * - A Map containing all processed editor base options.
+ * - This Map contains all keys from {@link ConfigAllBaseOptions}, where:
+ * - Keys are option names (string)
+ * - Values depend on the specific option (see {@link ConfigAllBaseOptions} for details)
+ */
+export type BaseOptionsMap = {
+	/**
+	 * - Retrieves the value of a specific option.
+	 */
+	get: <K extends keyof ConfigAllBaseOptions>(k: K) => ConfigAllBaseOptions[K];
+	/**
+	 * - Sets the value of a specific option.
+	 */
+	set: <K extends keyof ConfigAllBaseOptions>(k: K, v: ConfigAllBaseOptions[K]) => void;
+	/**
+	 * - Checks if a specific option exists.
+	 */
+	has: <K extends keyof ConfigAllBaseOptions>(k: K) => boolean;
+	/**
+	 * - Retrieves all options as an object.
+	 */
+	getAll: () => any;
+	/**
+	 * - Sets multiple options at once.
+	 */
+	setMany: (options: Map<any, any>) => void;
+	/**
+	 * - Replaces all options with a new Map.
+	 */
+	reset: (newMap: SunEditor.InitOptions) => void;
+	/**
+	 * - Get option size
+	 */
+	size: () => number;
+	/**
+	 * - Clears all stored options.
+	 */
+	clear: () => void;
+};
+/**
+ * - A Map containing all processed frame-level options.
+ * - This Map contains all keys from {@link ConfigAllFrameOptions}, where:
+ * - Keys are option names (string)
+ * - Values depend on the specific option (see {@link ConfigAllFrameOptions} for details)
+ */
+export type FrameOptionsMap = {
+	/**
+	 * - Retrieves the value of a specific option.
+	 */
+	get: <K extends keyof ConfigAllFrameOptions>(k: K) => ConfigAllFrameOptions[K];
+	/**
+	 * - Sets the value of a specific option.
+	 */
+	set: <K extends keyof ConfigAllFrameOptions>(k: K, v: ConfigAllFrameOptions[K]) => void;
+	/**
+	 * - Checks if a specific option exists.
+	 */
+	has: <K extends keyof ConfigAllFrameOptions>(k: K) => boolean;
+	/**
+	 * - Retrieves all options as an object.
+	 */
+	getAll: () => any;
+	/**
+	 * - Sets multiple options at once.
+	 */
+	setMany: (options: Map<any, any>) => void;
+	/**
+	 * - Replaces all options with a new Map.
+	 */
+	reset: (newMap: SunEditor.FrameOptions) => void;
+	/**
+	 * - Get option size
+	 */
+	size: () => number;
+	/**
+	 * - Clears all stored options.
+	 */
+	clear: () => void;
+};