leksy-editor 2.6.0 → 3.0.0

package/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types/index';
+export { default } from './types/index';

package/package.json

@@ -1,13 +1,34 @@
 {
   "name": "leksy-editor",
-  "version": "2.6.0",
+  "version": "3.0.0",
   "description": "Leksy Editor is an alternative to traditional WYSIWYG editors, designed primarily for creating mail templates, blogs, and documents without any content manipulation.",
-  "main": "index.js",
+  "main": "./dist/index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./backend": {
+      "types": "./backend.d.ts",
+      "import": "./dist/backend/index.mjs",
+      "require": "./dist/backend/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "types",
+    "index.d.ts",
+    "backend.d.ts",
+    "README.md"
+  ],
   "directories": {
     "example": "examples"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "tsup",
+    "prepublishOnly": "npm run build"
   },
   "repository": {
     "type": "git",
@@ -17,10 +38,15 @@
     "editor",
     "leksy-editor"
   ],
-  "author": "Agami Technologies",
+  "author": "Agami Technologies Pvt Ltd",
   "license": "MIT",
   "dependencies": {
     "diff-dom": "5.2.0",
+    "jsdom": "29.1.1",
     "uuid": "13.0.2"
+  },
+  "devDependencies": {
+    "tsup": "^8.5.1",
+    "typescript": "^6.0.3"
   }
 }

package/types/backend.d.ts

@@ -0,0 +1,89 @@
+import type { LeksySyncMessage, LeksyTab } from './index';
+
+export interface LeksyBackendOptions {
+    autoSaveMs?: number;
+    cleanMs?: number;
+}
+
+export interface LeksyUserParams {
+    documentId: string;
+    userId: string | number;
+    connectionId: string;
+}
+
+export interface LeksyContentState {
+    content: LeksyTab[] | null;
+    isLoaded: boolean;
+}
+
+export interface LeksySetContentOptions {
+    dirty?: boolean;
+    isRestore?: boolean;
+}
+
+export interface LeksyVersion {
+    versionId: string;
+    startedAt: number;
+    endedAt: number | null;
+    fromSequence: number;
+    toSequence: number;
+    users: Array<string | number>;
+    changes: unknown[];
+    startSnapshot: LeksyTab[];
+}
+
+export interface LeksyVersionFinalizePayload {
+    documentId: string;
+    versionId: string;
+    startSnapshot: LeksyTab[];
+    version: LeksyVersion;
+    metadata: Record<string, unknown>;
+}
+
+export interface LeksySavePayload {
+    documentId: string;
+    content: LeksyTab[];
+    updatedBy?: string | number;
+    metadata: Record<string, unknown>;
+}
+
+export interface LeksyBackendChange {
+    sequence: number;
+    userId?: string | number;
+    timestamp?: number;
+    type: string;
+    message?: LeksySyncMessage;
+}
+
+export interface LeksyEditorBackendInstance {
+    user: {
+        add(params: LeksyUserParams): Promise<void>;
+        remove(params: LeksyUserParams): Promise<{ collabEvents: LeksySyncMessage[] } | void>;
+    };
+    content: {
+        get(documentId: string): LeksyContentState;
+        set(
+            documentId: string,
+            content: LeksyTab[],
+            metadata?: Record<string, unknown>,
+            options?: LeksySetContentOptions
+        ): void;
+        getRuntimeDoms(documentId: string): Record<string, unknown>;
+    };
+    changes: {
+        apply(documentId: string, userId: string | number, message: LeksySyncMessage): Promise<number | null | void>;
+        getSince(documentId: string, sequence: number): LeksyBackendChange[] | null;
+        getCurrentSequence(documentId: string): number;
+    };
+    isActive(documentId: string): boolean;
+    save(documentId: string): Promise<void>;
+    onSave(fn: (payload: LeksySavePayload) => void | Promise<void>): void;
+    onVersionFinalize(fn: (payload: LeksyVersionFinalizePayload) => void | Promise<void>): void;
+    restore(documentId: string, snapshot: LeksyTab[], changes?: LeksySyncMessage[]): Promise<LeksyTab[]>;
+}
+
+export default class LeksyEditorBackend {
+    static create(options?: LeksyBackendOptions): LeksyEditorBackendInstance;
+}
+
+export function create(options?: LeksyBackendOptions): LeksyEditorBackendInstance;

package/types/index.d.ts

@@ -0,0 +1,200 @@
+export type LeksyPluginName =
+    | 'undo'
+    | 'redo'
+    | 'bold'
+    | 'underline'
+    | 'italic'
+    | 'strike'
+    | 'font'
+    | 'font-size'
+    | 'subscript'
+    | 'superscript'
+    | 'font_color'
+    | 'highlight_color'
+    | 'remove_font_color'
+    | 'remove_highlight_color'
+    | 'align_justify'
+    | 'align_left'
+    | 'align_center'
+    | 'align_right'
+    | 'ordered_list'
+    | 'unordered_list'
+    | 'image'
+    | 'video'
+    | 'table'
+    | 'attachment'
+    | 'cut'
+    | 'copy'
+    | 'paste'
+    | 'select_all'
+    | 'link'
+    | 'unlink'
+    | 'embed'
+    | 'format-block'
+    | 'text_style'
+    | 'line_height'
+    | 'paragraph_style'
+    | 'indent'
+    | 'outdent'
+    | 'horizontal_rule'
+    | 'remove_format'
+    | 'emoji'
+    | 'mention'
+    | 'special_character'
+    | 'pexels'
+    | 'giphy'
+    | 'tenor'
+    | 'code_view'
+    | 'fullscreen'
+    | 'print'
+    | 'table_of_content'
+    | 'find_and_replace';
+
+export type LeksyPluginGroup = LeksyPluginName | string | Array<LeksyPluginName | string>;
+
+export interface LeksyTab {
+    tabTitle: string;
+    tabId: string;
+    content: string;
+    children: LeksyTab[];
+}
+
+export interface LeksyLabelField {
+    name: string;
+    value: string;
+}
+
+export interface LeksyLabel {
+    name: string;
+    category: string;
+    fields: LeksyLabelField[];
+}
+
+export interface LeksyAdditionalFont {
+    name: string;
+    fontFamily: string;
+    links: string[];
+}
+
+export interface LeksyCssVariables {
+    primary?: string;
+    baseWhite?: string;
+    whiteDark?: string;
+    shadow?: string;
+    resizer?: string;
+    resizerBackground?: string;
+    mention?: string;
+    mentionHighlight?: string;
+    dashedBorder?: string;
+    tableResizer?: string;
+    tableResizerOutline?: string;
+    textColor?: string;
+    resizerPosition?: string;
+    resizerPositionBackground?: string;
+    linkColor?: string;
+    scrollbarThumb?: string;
+    scrollbarTrack?: string;
+    [key: string]: string | undefined;
+}
+
+export interface LeksyCustomPlugin {
+    title?: string;
+    icon?: string;
+    type?: string;
+    event?: string;
+    command?: string;
+    values?: unknown;
+    [key: string]: unknown;
+}
+
+export interface LeksyEditorOptions {
+    classPrefix?: string;
+    placeholder?: string;
+    plugins?: LeksyPluginGroup[];
+    labels?: LeksyLabel[];
+    customPlugins?: Record<string, LeksyCustomPlugin>;
+    spellcheck?: boolean;
+    closePluginOnClick?: boolean;
+    value?: string | LeksyTab[];
+    hideNavigation?: boolean;
+    giphyApiKey?: string;
+    pexelsApiKey?: string;
+    tenorApiKey?: string;
+    cssVariables?: LeksyCssVariables;
+    disablePastedColorStyles?: boolean;
+    removeColorsWhilePasting?: boolean;
+    autoHeight?: boolean;
+    height?: string;
+    maxHeight?: string;
+    minHeight?: string;
+    iframeStyle?: string;
+    disabled?: boolean;
+    showTabs?: boolean;
+    enableFindAndReplace?: boolean;
+    customTooltip?: Record<string, string>;
+    customIcon?: Record<string, string>;
+    additionalFonts?: LeksyAdditionalFont[];
+    onFullScreen?: (isFullScreen: boolean) => void;
+}
+
+export interface LeksyCursor {
+    startIndex: number;
+    endIndex: number;
+    cursorIndex: number;
+    isCollapsed: boolean;
+}
+
+export interface LeksySyncMessage {
+    type: string;
+    tabId?: string;
+    userId?: string;
+    userName?: string;
+    sequence?: number;
+    cursor?: LeksyCursor;
+    diff?: unknown;
+    tabs?: LeksyTab[];
+    editorHTML?: string;
+    [key: string]: unknown;
+}
+
+export interface LeksyChangeHighlight {
+    tabId: string;
+    route: number[];
+    color: string;
+    userName: string;
+}
+
+export interface LeksyEditorInstance {
+    setContents(content: string | LeksyTab[]): void;
+    getContents(): LeksyTab[];
+    onChange: (tabs: LeksyTab[]) => void;
+    onSave: () => void;
+    onBlur: (html: string) => void;
+    onAttachment: (files: FileList | File[]) => void;
+    onLinkClick: (href: string) => void;
+    manuplateImage: (type: string, content: string) => string | Promise<string | undefined> | undefined;
+    handleFilePicker: (mimeType: string, type: string) => File | string | null | Promise<File | string | null>;
+    uploadVideo: (file: File) => string | Promise<string | undefined> | undefined;
+    focus(): void;
+    getCore(): unknown;
+    updateHeight(height: string): void;
+    setDisabled(disabled: boolean): void;
+    updateCssVariables(variables: LeksyCssVariables): void;
+    updateLabels(labels?: LeksyLabel[]): void;
+    getLocalCursor(): LeksyCursor;
+    onLocalSyncChanges: (message: LeksySyncMessage) => void;
+    applyRemoteSyncChanges(message: LeksySyncMessage): void;
+    getCurrentTab(): LeksyTab | null;
+    parseTabFromHTML(html: string): LeksyTab;
+    compare(tabs1: LeksyTab[], tabs2: LeksyTab[]): boolean;
+    initRuntimeDoms(runtimeDoms: Record<string, string>): void;
+    reloadRuntimeDom(content: string | LeksyTab[], runtimeDoms?: Record<string, string>): void;
+    showChangeHighlight(highlights: LeksyChangeHighlight[]): void;
+}
+
+export default class LeksyEditor {
+    static create(baseElement: HTMLElement, options?: LeksyEditorOptions): LeksyEditorInstance;
+}
+
+export function convertHtmlToText(html: string): string | null;
+export function isHTMLEmpty(html: string): boolean;