tulih-editor 0.1.0

package/dist/types/core/Editor.d.ts

@@ -0,0 +1,20 @@
+import type { EditorOptions, ResolvedOptions, Features, EditorUtils, TulihEditorStatic, EditorInstance } from '../types';
+export default class Editor implements EditorInstance {
+    features: Features;
+    options: ResolvedOptions;
+    utils: EditorUtils;
+    container: HTMLElement | null;
+    editor: HTMLElement | null;
+    toolbar: HTMLElement | null;
+    textarea: HTMLTextAreaElement;
+    private _ctx;
+    constructor(target: string | Element, options: EditorOptions | undefined, TulihEditor: TulihEditorStatic);
+    getContent(): string;
+    setContent(html: string): void;
+    getText(): string;
+    getWordCount(): number;
+    getCharCount(): number;
+    setReadOnly(ro: boolean): void;
+    isReadOnly(): boolean;
+    destroy(): void;
+}

package/dist/types/core/PluginManager.d.ts

@@ -0,0 +1,22 @@
+import type { Plugin, PluginContext, Features, PluginManagerInstance } from '../types';
+/**
+ * Registry and lifecycle manager for plugins. Resolves toolbar order,
+ * dependency order, and one-time CSS injection.
+ */
+export default class PluginManager implements PluginManagerInstance {
+    private _plugins;
+    private _map;
+    private _injectedCSS;
+    private _cssInjected;
+    register(name: string, plugin: Plugin): this;
+    unregister(name: string): void;
+    get(name: string): Plugin | null;
+    has(name: string): boolean;
+    getNames(): string[];
+    private _resolveOrder;
+    initAll(ctx: PluginContext): void;
+    destroyAll(ctx: PluginContext): void;
+    getToolbarHTML(features: Features, toolbar?: string[][]): string;
+    getModalHTML(features: Features): string;
+    injectAllCSS(): void;
+}

package/dist/types/core/helpers.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Shared DOM utilities used by the editor core and plugins.
+ */
+declare const blockSelector = "p,h1,h2,h3,blockquote,pre,ul,ol,li,table,hr,iframe,.te-embed";
+declare const inlineTags: string[];
+declare function qs(selector: string, root?: Document | Element | null): Element | null;
+declare function qsa(selector: string, root?: Document | Element | null): Element[];
+declare function exec(command: string, value?: string): void;
+declare function getSelectionHtml(): string;
+declare function hasBlockDescendant(el: Element): boolean;
+declare function isInlineElement(el: Node): boolean;
+declare function wrapNodeInP(node: Node): HTMLParagraphElement;
+declare function wrapIframe(node: Element | null): HTMLDivElement | undefined;
+declare function normalizeParagraphs(root: Element | null): void;
+declare function ensureInitialParagraph(root: Element | null): void;
+declare function isInsideEditor(editor: Element, node: Node | null): boolean;
+declare function getBlockElement(editor: Element): Element | null;
+declare function setBtnActive(toolbar: Element | null, selector: string, active: boolean): void;
+declare function updateToolbarState(editor: HTMLElement, blockSelect: HTMLSelectElement | null, alignSelect: HTMLSelectElement | null, toolbar: HTMLElement | null): void;
+declare function escapeHtml(str: string): string;
+declare function removeNode(node: Node | null): void;
+export { qs, qsa, exec, getSelectionHtml, blockSelector, inlineTags, hasBlockDescendant, isInlineElement, wrapNodeInP, wrapIframe, normalizeParagraphs, ensureInitialParagraph, isInsideEditor, getBlockElement, setBtnActive, updateToolbarState, escapeHtml, removeNode, };

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+
+import type { TulihEditorStatic } from './types';
+declare const TulihEditor: TulihEditorStatic;
+export default TulihEditor;
+export type { Plugin, PluginContext, EditorOptions, EditorInstance, Features, SanitizeOptions, ResolvedOptions, EditorUtils, UploadImageHandler, BrowseImageHandler, TulihEditorStatic, PluginManagerInstance, HTMLProvider, CSSProvider, TeHistory, TeEditorElement, TeWrapperElement, } from './types';

package/dist/types/plugins/align.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const align: Plugin;
+export default align;

package/dist/types/plugins/autoLinkify.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const autoLinkify: Plugin;
+export default autoLinkify;

package/dist/types/plugins/autosave.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const autosave: Plugin;
+export default autosave;

package/dist/types/plugins/block.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const block: Plugin;
+export default block;

package/dist/types/plugins/caseTransform.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const caseTransform: Plugin;
+export default caseTransform;

package/dist/types/plugins/codeBlock.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const codeBlock: Plugin;
+export default codeBlock;

package/dist/types/plugins/colors.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const colors: Plugin;
+export default colors;

package/dist/types/plugins/darkMode.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const darkMode: Plugin;
+export default darkMode;

package/dist/types/plugins/direction.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const direction: Plugin;
+export default direction;

package/dist/types/plugins/dragDrop.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const dragDrop: Plugin;
+export default dragDrop;

package/dist/types/plugins/emoji.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const emoji: Plugin;
+export default emoji;

package/dist/types/plugins/emojiAutocomplete.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const emojiAutocomplete: Plugin;
+export default emojiAutocomplete;

package/dist/types/plugins/findReplace.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const findReplace: Plugin;
+export default findReplace;

package/dist/types/plugins/floatingToolbar.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const floatingToolbar: Plugin;
+export default floatingToolbar;

package/dist/types/plugins/fontFamily.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const fontFamily: Plugin;
+export default fontFamily;

package/dist/types/plugins/fontSize.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const fontSize: Plugin;
+export default fontSize;

package/dist/types/plugins/fullscreen.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const fullscreen: Plugin;
+export default fullscreen;

package/dist/types/plugins/history.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const history: Plugin;
+export default history;

package/dist/types/plugins/hr.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const hr: Plugin;
+export default hr;

package/dist/types/plugins/iframe.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const iframe: Plugin;
+export default iframe;

package/dist/types/plugins/image.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const image: Plugin;
+export default image;

package/dist/types/plugins/imageProps.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const imageProps: Plugin;
+export default imageProps;

package/dist/types/plugins/imageTools.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const imageTools: Plugin;
+export default imageTools;

package/dist/types/plugins/indent.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const indent: Plugin;
+export default indent;

package/dist/types/plugins/index.d.ts

@@ -0,0 +1,2 @@
+import type { PluginManagerInstance } from '../types';
+export default function registerDefaultPlugins(pm: PluginManagerInstance): void;

package/dist/types/plugins/inline.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const inline: Plugin;
+export default inline;

package/dist/types/plugins/inlineCode.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const inlineCode: Plugin;
+export default inlineCode;

package/dist/types/plugins/keyboardShortcuts.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const keyboardShortcuts: Plugin;
+export default keyboardShortcuts;

package/dist/types/plugins/lineHeight.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const lineHeight: Plugin;
+export default lineHeight;

package/dist/types/plugins/link.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const link: Plugin;
+export default link;

package/dist/types/plugins/linkTooltip.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const linkTooltip: Plugin;
+export default linkTooltip;

package/dist/types/plugins/list.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const list: Plugin;
+export default list;

package/dist/types/plugins/markdown.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const markdown: Plugin;
+export default markdown;

package/dist/types/plugins/mediaEmbed.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const mediaEmbed: Plugin;
+export default mediaEmbed;

package/dist/types/plugins/pasteImage.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const pasteImage: Plugin;
+export default pasteImage;

package/dist/types/plugins/pastePlain.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const pastePlain: Plugin;
+export default pastePlain;

package/dist/types/plugins/pre.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const pre: Plugin;
+export default pre;

package/dist/types/plugins/readOnly.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const readOnly: Plugin;
+export default readOnly;

package/dist/types/plugins/shortcutCustomizer.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const shortcutCustomizer: Plugin;
+export default shortcutCustomizer;

package/dist/types/plugins/shortcutsHelp.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const shortcutsHelp: Plugin;
+export default shortcutsHelp;

package/dist/types/plugins/source.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const source: Plugin;
+export default source;

package/dist/types/plugins/specialChars.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const specialChars: Plugin;
+export default specialChars;

package/dist/types/plugins/statusBar.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const statusBar: Plugin;
+export default statusBar;

package/dist/types/plugins/subSuper.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const subSuper: Plugin;
+export default subSuper;

package/dist/types/plugins/table.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const table: Plugin;
+export default table;

package/dist/types/plugins/tableBg.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const tableBg: Plugin;
+export default tableBg;

package/dist/types/plugins/tableTools.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const tableTools: Plugin;
+export default tableTools;

package/dist/types/plugins/toolbarCollapse.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const toolbarCollapse: Plugin;
+export default toolbarCollapse;

package/dist/types/plugins/unlink.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const unlink: Plugin;
+export default unlink;

package/dist/types/plugins/wordCount.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from '../types';
+declare const wordCount: Plugin;
+export default wordCount;

package/dist/types/types.d.ts

@@ -0,0 +1,226 @@
+/**
+ * Public type definitions for TulihEditor.
+ *
+ * These types describe the plugin contract, the editor options, and the
+ * runtime context (`ctx`) handed to every plugin's `init`/`destroy` hook.
+ */
+/**
+ * Map of plugin name -> enabled. Every built-in plugin is listed for
+ * autocomplete, but any custom plugin name is accepted too.
+ */
+export interface Features {
+    block?: boolean;
+    inline?: boolean;
+    pre?: boolean;
+    inlineCode?: boolean;
+    subSuper?: boolean;
+    removeFormat?: boolean;
+    keyboardShortcuts?: boolean;
+    readOnly?: boolean;
+    linkTooltip?: boolean;
+    emojiAutocomplete?: boolean;
+    statusBar?: boolean;
+    codeBlock?: boolean;
+    mediaEmbed?: boolean;
+    dragDrop?: boolean;
+    pastePlain?: boolean;
+    findReplace?: boolean;
+    indent?: boolean;
+    list?: boolean;
+    lineHeight?: boolean;
+    fontSize?: boolean;
+    fontFamily?: boolean;
+    specialChars?: boolean;
+    colors?: boolean;
+    tableBg?: boolean;
+    align?: boolean;
+    markdown?: boolean;
+    link?: boolean;
+    image?: boolean;
+    imageProps?: boolean;
+    imageTools?: boolean;
+    iframe?: boolean;
+    table?: boolean;
+    tableTools?: boolean;
+    hr?: boolean;
+    unlink?: boolean;
+    emoji?: boolean;
+    direction?: boolean;
+    source?: boolean;
+    history?: boolean;
+    fullscreen?: boolean;
+    toolbarCollapse?: boolean;
+    autosave?: boolean;
+    autoLinkify?: boolean;
+    caseTransform?: boolean;
+    shortcutsHelp?: boolean;
+    floatingToolbar?: boolean;
+    darkMode?: boolean;
+    shortcutCustomizer?: boolean;
+    minimal?: boolean;
+    [name: string]: boolean | undefined;
+}
+export interface SanitizeOptions {
+    allowedTags: string[];
+    allowedAttributes: string[];
+}
+/** Options accepted by `TulihEditor.attach(target, options)`. */
+export interface EditorOptions {
+    /** Enable/disable individual features (plugins). */
+    features?: Features;
+    /** Hide the classic toolbar; use the floating toolbar only. */
+    minimal?: boolean;
+    /** Custom toolbar layout. Each inner array is one button group (divider between groups). */
+    toolbar?: string[][];
+    /** Editor body height. A number is treated as pixels. */
+    height?: number | string;
+    /** Custom HTML sanitization rules (merged over the defaults). */
+    sanitize?: Partial<SanitizeOptions>;
+    /** URL schemes permitted for links. Defaults to http, https, mailto, tel. */
+    allowedUrlSchemes?: string[];
+    /** URL schemes permitted for images. Defaults to http, https, data. */
+    allowedImageSchemes?: string[];
+    /** Hostnames permitted for iframe embeds. */
+    iframeAllowlist?: string[];
+    /** `sandbox` attribute applied to embedded iframes. */
+    iframeSandbox?: string;
+    /** `allow` attribute applied to embedded iframes. */
+    iframeAllow?: string;
+    /** Start the editor in read-only mode. */
+    readOnly?: boolean;
+}
+/** Options after merging with defaults, stored on the editor instance. */
+export interface ResolvedOptions {
+    sanitize: SanitizeOptions;
+    urlSchemes: string[];
+    imageSchemes: string[];
+    iframeAllowlist: string[];
+    iframeSandbox: string;
+    iframeAllow: string;
+    readOnly: boolean;
+}
+export interface EditorUtils {
+    sanitizeHTML(html: string, sanOpts?: Partial<SanitizeOptions>): string;
+    isSafeUrl(url: string, schemes: string[]): boolean;
+    isAllowedIframeUrl(url: string): boolean;
+}
+export type UploadImageHandler = (file: File | Blob, callback: (url: string) => void) => void;
+export type BrowseImageHandler = (context: unknown, callback: (url: string) => void) => void;
+/** Either a static HTML string or a builder that receives the active features. */
+export type HTMLProvider = string | ((features: Features) => string);
+export type CSSProvider = string | ((features?: Features) => string);
+/**
+ * A TulihEditor plugin. The only required field is `name`; everything else is
+ * optional. Plugins contribute toolbar buttons, modals, CSS, and behavior.
+ */
+export interface Plugin {
+    /** Unique plugin name. Used as the feature flag key. */
+    name: string;
+    /** Sort order in the toolbar. Plugins are grouped per 10-unit range. */
+    order?: number;
+    /** Names of plugins that must initialize before this one. */
+    deps?: string[];
+    /** Toolbar markup injected into the toolbar. */
+    toolbarHTML?: HTMLProvider;
+    /** Modal markup injected after the editor body. */
+    modalHTML?: HTMLProvider;
+    /** CSS automatically injected into <head> once, on first load. */
+    css?: CSSProvider;
+    /** Called once per editor instance after the DOM is built. */
+    init?(ctx: PluginContext): void;
+    /** Called when an editor instance is destroyed. */
+    destroy?(ctx: PluginContext): void;
+}
+export interface PluginContext {
+    /** Wrapper element containing toolbar, editor body and modals. */
+    wrapper: HTMLElement;
+    /** The contenteditable editor body (`.te-editor`). */
+    editor: HTMLElement;
+    /** The toolbar element (`.te-toolbar`). */
+    toolbar: HTMLElement;
+    /** The original textarea the editor is attached to. */
+    textarea: HTMLTextAreaElement;
+    /** Resolved feature flags for this instance. */
+    features: Features;
+    /** Resolved options for this instance. */
+    options: ResolvedOptions;
+    /** Sanitization / URL helpers. */
+    utils: EditorUtils;
+    /** The global TulihEditor object. */
+    TulihEditor: TulihEditorStatic;
+    /** Save the current selection range onto the wrapper. */
+    saveSel(): void;
+    /** Restore a previously saved selection range. */
+    restoreSel(): void;
+    /** Refresh toolbar active states (bold/italic/lists/undo/redo). */
+    updateActiveStates(): void;
+    /** Set by the pastePlain plugin to toggle plain-text pasting. */
+    _pastePlain?: boolean;
+    /** Plugins may stash additional state on the context. */
+    [key: string]: unknown;
+}
+export interface EditorInstance {
+    /** Wrapper element. */
+    container: HTMLElement | null;
+    /** Contenteditable editor body. */
+    editor: HTMLElement | null;
+    /** Toolbar element. */
+    toolbar: HTMLElement | null;
+    /** Original textarea. */
+    textarea: HTMLTextAreaElement;
+    /** Resolved feature flags. */
+    features: Features;
+    /** Resolved options. */
+    options: ResolvedOptions;
+    /** Sanitization / URL helpers. */
+    utils: EditorUtils;
+    /** Get the editor HTML content. */
+    getContent(): string;
+    /** Replace the editor content (sanitized). */
+    setContent(html: string): void;
+    /** Get the plain text content. */
+    getText(): string;
+    /** Get the current word count. */
+    getWordCount(): number;
+    /** Get the current character count. */
+    getCharCount(): number;
+    /** Toggle read-only mode. */
+    setReadOnly(readOnly: boolean): void;
+    /** Whether the editor is currently read-only. */
+    isReadOnly(): boolean;
+    /** Tear down the editor and restore the original textarea. */
+    destroy(): void;
+}
+export interface PluginManagerInstance {
+    register(name: string, plugin: Plugin): this;
+    unregister(name: string): void;
+    get(name: string): Plugin | null;
+    has(name: string): boolean;
+    getNames(): string[];
+    initAll(ctx: PluginContext): void;
+    destroyAll(ctx: PluginContext): void;
+    getToolbarHTML(features: Features, toolbar?: string[][]): string;
+    getModalHTML(features: Features): string;
+    injectAllCSS(): void;
+}
+export interface TulihEditorStatic {
+    pluginManager: PluginManagerInstance;
+    instances: EditorInstance[];
+    onBrowseImage: BrowseImageHandler | null;
+    onUploadImage?: UploadImageHandler | null;
+    setBrowseImage(handler: BrowseImageHandler): void;
+    attach(target: string | Element, options?: EditorOptions): EditorInstance | undefined;
+    create(target: string | Element, options?: EditorOptions): EditorInstance | undefined;
+}
+export interface TeHistory {
+    undo: string[];
+    redo: string[];
+}
+/** Editor body element with the table-history expando used by history/table plugins. */
+export type TeEditorElement = HTMLElement & {
+    _tableHist?: TeHistory;
+};
+/** Wrapper element with the saved-selection expando. */
+export type TeWrapperElement = HTMLElement & {
+    __savedRange?: Range | null;
+};

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "tulih-editor",
+  "version": "0.1.0",
+  "description": "A lightweight, zero-dependency WYSIWYG rich text editor for the browser, built on contenteditable with a modular plugin system. ~50 plugins, written in TypeScript.",
+  "type": "module",
+  "main": "./dist/tulih-editor.umd.js",
+  "module": "./dist/tulih-editor.es.js",
+  "types": "./dist/types/index.d.ts",
+  "unpkg": "./dist/tulih-editor.umd.js",
+  "jsdelivr": "./dist/tulih-editor.umd.js",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/tulih-editor.es.js",
+      "require": "./dist/tulih-editor.umd.js"
+    },
+    "./style.css": "./dist/tulih-editor.css",
+    "./dist/*": "./dist/*"
+  },
+  "sideEffects": [
+    "**/*.css",
+    "./src/index.ts"
+  ],
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "npm run clean && npm run build:js && npm run build:types",
+    "build:js": "vite build",
+    "build:types": "tsc -p tsconfig.build.json && node scripts/fix-dts.mjs",
+    "clean": "rimraf dist",
+    "typecheck": "tsc --noEmit",
+    "test": "node --test",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "wysiwyg",
+    "rich-text-editor",
+    "editor",
+    "contenteditable",
+    "html-editor",
+    "text-editor",
+    "tulih-editor",
+    "typescript"
+  ],
+  "author": "Hendra Randy Nomura <https://github.com/hr-nomura>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hr-nomura/tulih-editor.git"
+  },
+  "bugs": {
+    "url": "https://github.com/hr-nomura/tulih-editor/issues"
+  },
+  "homepage": "https://github.com/hr-nomura/tulih-editor#readme",
+  "devDependencies": {
+    "jsdom": "^25.0.1",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.6.0",
+    "vite": "^6.0.0"
+  }
+}