lakelib 0.4.2 → 0.4.3

package/lib/lake.d.ts

@@ -1,5 +1,5 @@
 import EventEmitter from 'eventemitter3';
-import { LocalizedString } from 'typesafe-i18n';
+import { LocalizedString, RequiredParams } from 'typesafe-i18n';
 
 type KeyValue = Record<string, string>;
 
@@ -377,6 +377,654 @@ interface SelectionState {
     selectedValuesMap?: Map<string, string[]>;
 }
 
+type Translation = RootTranslation;
+type RootTranslation = {
+    toolbar: {
+        /**
+         * U​n​d​o​ ​(​m​o​d​+​Z​)
+         */
+        undo: string;
+        /**
+         * R​e​d​o​ ​(​m​o​d​+​Y​)
+         */
+        redo: string;
+        /**
+         * S​e​l​e​c​t​ ​a​l​l​ ​(​m​o​d​+​A​)
+         */
+        selectAll: string;
+        /**
+         * P​a​r​a​g​r​a​p​h
+         */
+        paragraph: string;
+        /**
+         * B​l​o​c​k​ ​q​u​o​t​a​t​i​o​n
+         */
+        blockQuote: string;
+        /**
+         * N​u​m​b​e​r​e​d​ ​l​i​s​t
+         */
+        numberedList: string;
+        /**
+         * B​u​l​l​e​t​e​d​ ​l​i​s​t
+         */
+        bulletedList: string;
+        /**
+         * C​h​e​c​k​l​i​s​t
+         */
+        checklist: string;
+        /**
+         * A​l​i​g​n​ ​l​e​f​t
+         */
+        alignLeft: string;
+        /**
+         * A​l​i​g​n​ ​c​e​n​t​e​r
+         */
+        alignCenter: string;
+        /**
+         * A​l​i​g​n​ ​r​i​g​h​t
+         */
+        alignRight: string;
+        /**
+         * J​u​s​t​i​f​y
+         */
+        alignJustify: string;
+        /**
+         * I​n​c​r​e​a​s​e​ ​i​n​d​e​n​t
+         */
+        increaseIndent: string;
+        /**
+         * D​e​c​r​e​a​s​e​ ​i​n​d​e​n​t
+         */
+        decreaseIndent: string;
+        /**
+         * B​o​l​d​ ​(​m​o​d​+​B​)
+         */
+        bold: string;
+        /**
+         * I​t​a​l​i​c​ ​(​m​o​d​+​I​)
+         */
+        italic: string;
+        /**
+         * U​n​d​e​r​l​i​n​e​ ​(​m​o​d​+​U​)
+         */
+        underline: string;
+        /**
+         * S​t​r​i​k​e​t​h​r​o​u​g​h
+         */
+        strikethrough: string;
+        /**
+         * S​u​p​e​r​s​c​r​i​p​t
+         */
+        superscript: string;
+        /**
+         * S​u​b​s​c​r​i​p​t
+         */
+        subscript: string;
+        /**
+         * I​n​l​i​n​e​ ​c​o​d​e
+         */
+        code: string;
+        /**
+         * R​e​m​o​v​e​ ​f​o​r​m​a​t
+         */
+        removeFormat: string;
+        /**
+         * F​o​r​m​a​t​ ​p​a​i​n​t​e​r
+         */
+        formatPainter: string;
+        /**
+         * L​i​n​k
+         */
+        link: string;
+        /**
+         * H​o​r​i​z​o​n​t​a​l​ ​l​i​n​e
+         */
+        hr: string;
+        /**
+         * V​i​d​e​o
+         */
+        video: string;
+        /**
+         * C​o​d​e​ ​b​l​o​c​k
+         */
+        codeBlock: string;
+        /**
+         * H​e​a​d​i​n​g
+         */
+        heading: string;
+        /**
+         * H​e​a​d​i​n​g​ ​1
+         */
+        heading1: string;
+        /**
+         * H​e​a​d​i​n​g​ ​2
+         */
+        heading2: string;
+        /**
+         * H​e​a​d​i​n​g​ ​3
+         */
+        heading3: string;
+        /**
+         * H​e​a​d​i​n​g​ ​4
+         */
+        heading4: string;
+        /**
+         * H​e​a​d​i​n​g​ ​5
+         */
+        heading5: string;
+        /**
+         * H​e​a​d​i​n​g​ ​6
+         */
+        heading6: string;
+        /**
+         * L​i​s​t
+         */
+        list: string;
+        /**
+         * T​a​b​l​e
+         */
+        table: string;
+        /**
+         * A​l​i​g​n​m​e​n​t
+         */
+        align: string;
+        /**
+         * I​n​d​e​n​t
+         */
+        indent: string;
+        /**
+         * F​o​n​t​ ​f​a​m​i​l​y
+         */
+        fontFamily: string;
+        /**
+         * F​o​n​t​ ​s​i​z​e
+         */
+        fontSize: string;
+        /**
+         * M​o​r​e​ ​s​t​y​l​e
+         */
+        moreStyle: string;
+        /**
+         * F​o​n​t​ ​c​o​l​o​r
+         */
+        fontColor: string;
+        /**
+         * H​i​g​h​l​i​g​h​t
+         */
+        highlight: string;
+        /**
+         * I​m​a​g​e
+         */
+        image: string;
+        /**
+         * F​i​l​e
+         */
+        file: string;
+        /**
+         * E​m​o​j​i
+         */
+        emoji: string;
+        /**
+         * M​a​t​h​e​m​a​t​i​c​a​l​ ​f​o​r​m​u​l​a
+         */
+        equation: string;
+        /**
+         * X​ ​(​T​w​i​t​t​e​r​)
+         */
+        twitter: string;
+        /**
+         * R​e​m​o​v​e​ ​c​o​l​o​r
+         */
+        removeColor: string;
+    };
+    slash: {
+        /**
+         * H​e​a​d​i​n​g​ ​1
+         */
+        heading1: string;
+        /**
+         * C​r​e​a​t​e​ ​a​ ​h​e​a​d​i​n​g​ ​l​e​v​e​l​ ​1
+         */
+        heading1Desc: string;
+        /**
+         * H​e​a​d​i​n​g​ ​2
+         */
+        heading2: string;
+        /**
+         * C​r​e​a​t​e​ ​a​ ​h​e​a​d​i​n​g​ ​l​e​v​e​l​ ​2
+         */
+        heading2Desc: string;
+        /**
+         * H​e​a​d​i​n​g​ ​3
+         */
+        heading3: string;
+        /**
+         * C​r​e​a​t​e​ ​a​ ​h​e​a​d​i​n​g​ ​l​e​v​e​l​ ​3
+         */
+        heading3Desc: string;
+        /**
+         * H​e​a​d​i​n​g​ ​4
+         */
+        heading4: string;
+        /**
+         * C​r​e​a​t​e​ ​a​ ​h​e​a​d​i​n​g​ ​l​e​v​e​l​ ​4
+         */
+        heading4Desc: string;
+        /**
+         * H​e​a​d​i​n​g​ ​5
+         */
+        heading5: string;
+        /**
+         * C​r​e​a​t​e​ ​a​ ​h​e​a​d​i​n​g​ ​l​e​v​e​l​ ​5
+         */
+        heading5Desc: string;
+        /**
+         * H​e​a​d​i​n​g​ ​6
+         */
+        heading6: string;
+        /**
+         * C​r​e​a​t​e​ ​a​ ​h​e​a​d​i​n​g​ ​l​e​v​e​l​ ​6
+         */
+        heading6Desc: string;
+        /**
+         * P​a​r​a​g​r​a​p​h
+         */
+        paragraph: string;
+        /**
+         * C​r​e​a​t​e​ ​a​ ​p​a​r​a​g​r​a​p​h
+         */
+        paragraphDesc: string;
+        /**
+         * B​l​o​c​k​ ​q​u​o​t​a​t​i​o​n
+         */
+        blockQuote: string;
+        /**
+         * C​r​e​a​t​e​ ​a​ ​b​l​o​c​k​ ​q​u​o​t​a​t​i​o​n
+         */
+        blockQuoteDesc: string;
+        /**
+         * N​u​m​b​e​r​e​d​ ​l​i​s​t
+         */
+        numberedList: string;
+        /**
+         * C​r​e​a​t​e​ ​a​ ​n​u​m​b​e​r​e​d​ ​l​i​s​t
+         */
+        numberedListDesc: string;
+        /**
+         * B​u​l​l​e​t​e​d​ ​l​i​s​t
+         */
+        bulletedList: string;
+        /**
+         * C​r​e​a​t​e​ ​a​ ​b​u​l​l​e​t​e​d​ ​l​i​s​t
+         */
+        bulletedListDesc: string;
+        /**
+         * C​h​e​c​k​l​i​s​t
+         */
+        checklist: string;
+        /**
+         * C​r​e​a​t​e​ ​a​ ​c​h​e​c​k​l​i​s​t
+         */
+        checklistDesc: string;
+        /**
+         * T​a​b​l​e
+         */
+        table: string;
+        /**
+         * I​n​s​e​r​t​ ​a​ ​t​a​b​l​e
+         */
+        tableDesc: string;
+        /**
+         * I​n​f​o​ ​a​l​e​r​t
+         */
+        infoAlert: string;
+        /**
+         * C​r​e​a​t​e​ ​a​n​ ​i​n​f​o​ ​a​l​e​r​t
+         */
+        infoAlertDesc: string;
+        /**
+         * T​i​p​ ​a​l​e​r​t
+         */
+        tipAlert: string;
+        /**
+         * C​r​e​a​t​e​ ​a​ ​t​i​p​ ​a​l​e​r​t
+         */
+        tipAlertDesc: string;
+        /**
+         * W​a​r​n​i​n​g​ ​a​l​e​r​t
+         */
+        warningAlert: string;
+        /**
+         * C​r​e​a​t​e​ ​a​ ​w​a​r​n​i​n​g​ ​a​l​e​r​t
+         */
+        warningAlertDesc: string;
+        /**
+         * D​a​n​g​e​r​ ​a​l​e​r​t
+         */
+        dangerAlert: string;
+        /**
+         * C​r​e​a​t​e​ ​a​ ​d​a​n​g​e​r​ ​a​l​e​r​t
+         */
+        dangerAlertDesc: string;
+        /**
+         * H​o​r​i​z​o​n​t​a​l​ ​l​i​n​e
+         */
+        hr: string;
+        /**
+         * I​n​s​e​r​t​ ​a​ ​h​o​r​i​z​o​n​t​a​l​ ​l​i​n​e
+         */
+        hrDesc: string;
+        /**
+         * C​o​d​e​ ​b​l​o​c​k
+         */
+        codeBlock: string;
+        /**
+         * I​n​s​e​r​t​ ​a​ ​c​o​d​e​ ​b​l​o​c​k
+         */
+        codeBlockDesc: string;
+        /**
+         * V​i​d​e​o
+         */
+        video: string;
+        /**
+         * I​n​s​e​r​t​ ​a​ ​v​i​d​e​o​ ​f​r​o​m​ ​Y​o​u​T​u​b​e
+         */
+        videoDesc: string;
+        /**
+         * M​a​t​h​e​m​a​t​i​c​a​l​ ​f​o​r​m​u​l​a
+         */
+        equation: string;
+        /**
+         * I​n​s​e​r​t​ ​a​ ​T​e​X​ ​e​x​p​r​e​s​s​i​o​n
+         */
+        equationDesc: string;
+        /**
+         * T​w​i​t​t​e​r
+         */
+        twitter: string;
+        /**
+         * I​n​s​e​r​t​ ​a​ ​p​o​s​t​ ​f​r​o​m​ ​X​ ​(​T​w​i​t​t​e​r​)
+         */
+        twitterDesc: string;
+        /**
+         * I​m​a​g​e
+         */
+        image: string;
+        /**
+         * U​p​l​o​a​d​ ​a​n​ ​i​m​a​g​e
+         */
+        imageDesc: string;
+        /**
+         * F​i​l​e
+         */
+        file: string;
+        /**
+         * U​p​l​o​a​d​ ​a​ ​f​i​l​e
+         */
+        fileDesc: string;
+    };
+    link: {
+        /**
+         * N​e​w​ ​l​i​n​k
+         */
+        newLink: string;
+        /**
+         * L​i​n​k​ ​U​R​L
+         */
+        url: string;
+        /**
+         * T​e​x​t​ ​t​o​ ​d​i​s​p​l​a​y
+         */
+        title: string;
+        /**
+         * C​o​p​y​ ​l​i​n​k​ ​t​o​ ​c​l​i​p​b​o​a​r​d
+         */
+        copy: string;
+        /**
+         * O​p​e​n​ ​l​i​n​k​ ​i​n​ ​n​e​w​ ​t​a​b
+         */
+        open: string;
+        /**
+         * S​a​v​e
+         */
+        save: string;
+        /**
+         * R​e​m​o​v​e​ ​l​i​n​k
+         */
+        unlink: string;
+    };
+    table: {
+        /**
+         * F​i​t​ ​t​a​b​l​e​ ​t​o​ ​p​a​g​e​ ​w​i​d​t​h
+         */
+        fitTable: string;
+        /**
+         * C​e​l​l​ ​b​a​c​k​g​r​o​u​n​d​ ​c​o​l​o​r
+         */
+        cellBackground: string;
+        /**
+         * C​o​l​u​m​n
+         */
+        column: string;
+        /**
+         * I​n​s​e​r​t​ ​c​o​l​u​m​n​ ​l​e​f​t
+         */
+        insertColumnLeft: string;
+        /**
+         * I​n​s​e​r​t​ ​c​o​l​u​m​n​ ​r​i​g​h​t
+         */
+        insertColumnRight: string;
+        /**
+         * D​e​l​e​t​e​ ​c​o​l​u​m​n
+         */
+        deleteColumn: string;
+        /**
+         * R​o​w
+         */
+        row: string;
+        /**
+         * I​n​s​e​r​t​ ​r​o​w​ ​a​b​o​v​e
+         */
+        insertRowAbove: string;
+        /**
+         * I​n​s​e​r​t​ ​r​o​w​ ​b​e​l​o​w
+         */
+        insertRowBelow: string;
+        /**
+         * D​e​l​e​t​e​ ​r​o​w
+         */
+        deleteRow: string;
+        /**
+         * M​e​r​g​e​ ​c​e​l​l​s
+         */
+        merge: string;
+        /**
+         * M​e​r​g​e​ ​c​e​l​l​ ​u​p
+         */
+        mergeUp: string;
+        /**
+         * M​e​r​g​e​ ​c​e​l​l​ ​r​i​g​h​t
+         */
+        mergeRight: string;
+        /**
+         * M​e​r​g​e​ ​c​e​l​l​ ​d​o​w​n
+         */
+        mergeDown: string;
+        /**
+         * M​e​r​g​e​ ​c​e​l​l​ ​l​e​f​t
+         */
+        mergeLeft: string;
+        /**
+         * S​p​l​i​t​ ​c​e​l​l
+         */
+        split: string;
+        /**
+         * S​p​l​i​t​ ​c​e​l​l​ ​l​e​f​t​ ​a​n​d​ ​r​i​g​h​t
+         */
+        splitLeftRight: string;
+        /**
+         * S​p​l​i​t​ ​c​e​l​l​ ​t​o​p​ ​a​n​d​ ​b​o​t​t​o​m
+         */
+        splitTopBottom: string;
+        /**
+         * R​e​m​o​v​e​ ​t​a​b​l​e
+         */
+        remove: string;
+    };
+    image: {
+        /**
+         * F​u​l​l​ ​s​c​r​e​e​n
+         */
+        view: string;
+        /**
+         * D​e​l​e​t​e
+         */
+        remove: string;
+        /**
+         * P​r​e​v​i​o​u​s
+         */
+        previous: string;
+        /**
+         * N​e​x​t
+         */
+        next: string;
+        /**
+         * C​l​o​s​e​ ​(​E​s​c​)
+         */
+        close: string;
+        /**
+         * U​n​a​b​l​e​ ​t​o​ ​l​o​a​d​ ​i​m​a​g​e​.
+         */
+        loadingError: string;
+        /**
+         * Z​o​o​m​ ​o​u​t
+         */
+        zoomOut: string;
+        /**
+         * Z​o​o​m​ ​i​n
+         */
+        zoomIn: string;
+        /**
+         * A​l​i​g​n​m​e​n​t
+         */
+        align: string;
+        /**
+         * A​l​i​g​n​ ​l​e​f​t
+         */
+        alignLeft: string;
+        /**
+         * A​l​i​g​n​ ​c​e​n​t​e​r
+         */
+        alignCenter: string;
+        /**
+         * A​l​i​g​n​ ​r​i​g​h​t
+         */
+        alignRight: string;
+        /**
+         * R​e​s​i​z​e​ ​i​m​a​g​e
+         */
+        resize: string;
+        /**
+         * P​a​g​e​ ​w​i​d​t​h
+         */
+        pageWidth: string;
+        /**
+         * O​r​i​g​i​n​a​l​ ​i​m​a​g​e​ ​w​i​d​t​h
+         */
+        originalWidth: string;
+        /**
+         * {​0​}​ ​i​m​a​g​e​ ​w​i​d​t​h
+         * @param {unknown} 0
+         */
+        imageWidth: RequiredParams<'0'>;
+        /**
+         * O​p​e​n​ ​i​m​a​g​e​ ​i​n​ ​n​e​w​ ​t​a​b
+         */
+        open: string;
+        /**
+         * C​a​p​t​i​o​n
+         */
+        caption: string;
+        /**
+         * W​r​i​t​e​ ​a​ ​c​a​p​t​i​o​n​.​.​.
+         */
+        captionPlaceholder: string;
+    };
+    file: {
+        /**
+         * D​o​w​n​l​o​a​d
+         */
+        download: string;
+        /**
+         * D​e​l​e​t​e
+         */
+        remove: string;
+    };
+    video: {
+        /**
+         * E​m​b​e​d​ ​v​i​d​e​o
+         */
+        embed: string;
+        /**
+         * D​e​l​e​t​e
+         */
+        remove: string;
+        /**
+         * P​a​s​t​e​ ​a​ ​l​i​n​k​ ​t​o​ ​e​m​b​e​d​ ​a​ ​v​i​d​e​o​ ​f​r​o​m​ ​Y​o​u​T​u​b​e​.
+         */
+        description: string;
+        /**
+         * L​i​n​k
+         */
+        url: string;
+        /**
+         * P​l​e​a​s​e​ ​e​n​t​e​r​ ​a​ ​v​a​l​i​d​ ​l​i​n​k​.
+         */
+        urlError: string;
+    };
+    codeBlock: {
+        /**
+         * S​e​l​e​c​t​ ​l​a​n​g​u​a​g​e
+         */
+        langType: string;
+    };
+    equation: {
+        /**
+         * D​o​n​e
+         */
+        save: string;
+        /**
+         * S​u​p​p​o​r​t​e​d​ ​f​u​n​c​t​i​o​n​s
+         */
+        help: string;
+        /**
+         * T​y​p​e​ ​a​ ​T​e​X​ ​e​x​p​r​e​s​s​i​o​n​.​.​.
+         */
+        placeholder: string;
+    };
+    twitter: {
+        /**
+         * E​m​b​e​d​ ​T​w​e​e​t
+         */
+        embed: string;
+        /**
+         * D​e​l​e​t​e
+         */
+        remove: string;
+        /**
+         * P​a​s​t​e​ ​a​ ​l​i​n​k​ ​t​o​ ​e​m​b​e​d​ ​a​ ​p​o​s​t​ ​f​r​o​m​ ​X​.
+         */
+        description: string;
+        /**
+         * L​i​n​k
+         */
+        url: string;
+        /**
+         * P​l​e​a​s​e​ ​e​n​t​e​r​ ​a​ ​v​a​l​i​d​ ​l​i​n​k​.
+         */
+        urlError: string;
+    };
+};
 type TranslationFunctions = {
     toolbar: {
         /**
@@ -1024,6 +1672,21 @@ type TranslationFunctions = {
     };
 };
 
+/**
+ * The LocaleManager interface manages a collection of Translation objects.
+ * It allows you to add and retrieve the names of locales.
+ */
+declare class LocaleManager {
+    /**
+     * Adds a Translation to the collection.
+     */
+    add(locale: string, translation: Translation): void;
+    /**
+     * Returns a list of all locale names.
+     */
+    getNames(): string[];
+}
+
 type NativeRange = Range;
 
 /**
@@ -1671,6 +2334,10 @@ interface ToolbarConfig {
     root?: string | Node | Nodes;
     items?: (string | ToolbarItem)[];
     placement?: ToolbarPlacement;
+    fontFamily?: {
+        defaultValue: string;
+        menuItems: DropdownMenuItem[];
+    };
 }
 /**
  * The Toolbar interface provides properties and methods for rendering and manipulating the toolbar.
@@ -1678,6 +2345,7 @@ interface ToolbarConfig {
 declare class Toolbar {
     private items;
     private placement;
+    private toolbarItemMap;
     private allMenuMap;
     private buttonItemList;
     private dropdownItemList;
@@ -1758,6 +2426,10 @@ declare class Editor {
      * The current version of Lake.
      */
     static readonly version: string;
+    /**
+     * A LocaleManager object that manages the locale translations.
+     */
+    static readonly locale: LocaleManager;
     /**
      * A BoxManager object that manages the box components.
      */
@@ -1909,6 +2581,10 @@ declare class Editor {
      * Returns the editor's content.
      */
     getValue(): string;
+    /**
+     * Returns the editor's content in HTML format.
+     */
+    getHTML(): string;
     /**
      * Renders an editing area and sets default content to it.
      */
@@ -1996,14 +2672,14 @@ declare class Box {
 
 type BoxType = 'inline' | 'block';
 type BoxValue = Record<string, any>;
-type BoxRender = (box: Box) => Nodes | string | void;
-type BoxHTML = (box: Box) => string;
+type RenderBox = (box: Box) => Nodes | string | void;
+type RenderBoxHTML = (box: Box) => string;
 interface BoxComponent {
     type: BoxType;
     name: string;
     value?: BoxValue;
-    render: BoxRender;
-    html?: BoxHTML;
+    render: RenderBox;
+    html?: RenderBoxHTML;
 }
 
 interface MentionItem {
@@ -2132,6 +2808,8 @@ interface IframeBoxConfig {
  */
 declare function createIframeBox(config: IframeBoxConfig): BoxComponent;
 
+declare function modifierText(value: string, userAgent?: string): string;
+
 /**
  * The HTMLParser interface provides the ability to parse an HTML string according to specified rules.
  */
@@ -2263,5 +2941,5 @@ declare class Dropdown {
     unmount(): void;
 }
 
-export { Box, Button, Dropdown, Editor, Fragment, HTMLParser, Nodes, Range$1 as Range, TextParser, Toolbar, addMark, createIframeBox, deleteContents, getBox, getContentRules, icons, insertBlock, insertBookmark, insertBox, insertContents, query, removeBox, removeMark, setBlocks, splitBlock, splitMarks, template, toBookmark, toHex };
-export type { ActiveItem, BoxComponent, BoxValue, CommandItem, ContentRules, DropdownItem, DropdownMenuItem, EditorConfig, InitializePlugin, KeyValue, MentionItem, NodePath, SelectionState, SlashButtonItem, SlashItem, SlashUploadItem, ToolbarButtonItem, ToolbarConfig, ToolbarDropdownItem, ToolbarItem, ToolbarUploadItem, UnmountPlugin };
+export { Box, Button, Dropdown, Editor, Fragment, HTMLParser, Nodes, Range$1 as Range, TextParser, Toolbar, addMark, createIframeBox, deleteContents, getBox, getContentRules, icons, insertBlock, insertBookmark, insertBox, insertContents, modifierText, query, removeBox, removeMark, setBlocks, splitBlock, splitMarks, template, toBookmark, toHex };
+export type { ActiveItem, BoxComponent, BoxValue, CommandItem, ContentRules, DropdownItem, DropdownMenuItem, EditorConfig, InitializePlugin, KeyValue, MentionItem, NodePath, SelectionState, SlashButtonItem, SlashItem, SlashUploadItem, ToolbarButtonItem, ToolbarConfig, ToolbarDropdownItem, ToolbarItem, ToolbarUploadItem, Translation, UnmountPlugin };