@omnia/fx 8.0.264-dev → 8.0.266-dev

package/internal-do-not-import-from-here/ux/floweditor/commands/EditorCommands.d.ts

@@ -0,0 +1,99 @@
+import { FlowContent, NodeSelection } from "../models/EditorModels";
+import { FlowEditorPlugin, FlowEditorPluginContext } from "../models/EditorPlugin";
+export type builtIndataTypes = "text" | "formatting";
+export declare function useEditorCommands(state: {
+    editor: HTMLDivElement;
+    selectedRange: Range;
+    maxNodeId: number;
+    editorContent: FlowContent;
+    nodeSelection: NodeSelection;
+    plugins: Array<FlowEditorPlugin>;
+    pluginContext: FlowEditorPluginContext;
+}): {
+    content: {
+        convert: (element: HTMLElement) => void;
+    };
+    ensure: {
+        lastElement: () => void;
+        unique: {
+            ids: (element: HTMLElement) => void;
+        };
+    };
+    selection: {
+        get: {
+            byPluginType: (pluginType: string) => import("../models/EditorModels").FlowNodeReference[];
+        };
+    };
+    cursor: {
+        isAfterEndOfContent: (range: Range, container: HTMLElement) => boolean;
+        isBeforeContent: (range: Range, container: HTMLElement) => boolean;
+    };
+    actions: {
+        setSelection: () => void;
+    };
+    formatting: {
+        add: (element: HTMLElement) => void;
+        remove: (dataType: string | HTMLElement) => void;
+        has: (dataType: string | HTMLElement) => boolean;
+    };
+    element: {
+        clean: (element: HTMLElement) => void;
+        add: (element: HTMLElement) => void;
+        create: (tagName: string, dataType: builtIndataTypes | string) => HTMLElement;
+        createText: () => HTMLParagraphElement;
+        createTextNode: (data: any) => Text;
+        createComponent: (componentName: string) => HTMLDivElement;
+        insert: {
+            text: (element: Node, text: string, offset: any) => void;
+        };
+        ids: {
+            unique: (element: HTMLElement) => void;
+        };
+    };
+    helpers: {
+        editor: {
+            ensure: {
+                uniqueIds: (element: HTMLElement, state: {
+                    maxNodeId: number;
+                }) => HTMLElement;
+                selectionIsInEditor: (range: Range) => void;
+            };
+            cursor: {
+                storePosition: (state: {
+                    selectedRange: Range;
+                }) => void;
+                isAfterEndOfContent: (range: Range, container: HTMLElement) => boolean;
+                isBeforeContent: (range: Range, container: HTMLElement) => boolean;
+            };
+        };
+        editorNode: {
+            get: {
+                nodesInArrayByPluginType: (nodes: Array<import("../models/EditorModels").FlowNodeReference>, dataType: string) => Array<import("../models/EditorModels").FlowNodeReference>;
+            };
+        };
+        htmlNode: {
+            copy: {
+                children: (from: HTMLElement, to: HTMLElement) => void;
+            };
+            insert: {
+                text: (element: Node, text: string, offset: any) => void;
+                elementInContainer: (element: HTMLElement, container: HTMLElement) => void;
+            };
+            get: {
+                topContainerForContent: (element: HTMLElement) => HTMLElement;
+                nodeSelectionForRange: (range: Range) => NodeSelection;
+                htmlElementInStructureById: (id: number, currentElement: HTMLElement) => HTMLElement;
+            };
+            remove: {
+                nodes: (nodes2Remove: Array<import("../models/EditorModels").FlowNodeReference>, editor: HTMLElement) => void;
+            };
+            strip: {
+                after: (element: HTMLElement, splitter: string) => void;
+                before: (element: HTMLElement, splitter: string) => void;
+            };
+            surround: {
+                selectionWithElement: (element: HTMLElement, range: Range) => void;
+            };
+        };
+    };
+};

package/internal-do-not-import-from-here/ux/floweditor/commands/helpers/EditorNodeHelper.d.ts

@@ -0,0 +1,6 @@
+import { FlowNodeReference } from "../../models/EditorModels";
+export declare function useEditorNodeHelper(): {
+    get: {
+        nodesInArrayByPluginType: (nodes: Array<FlowNodeReference>, dataType: string) => Array<FlowNodeReference>;
+    };
+};

package/internal-do-not-import-from-here/ux/floweditor/commands/helpers/Editorhelper.d.ts

@@ -0,0 +1,15 @@
+export declare function useEditorHelper(): {
+    ensure: {
+        uniqueIds: (element: HTMLElement, state: {
+            maxNodeId: number;
+        }) => HTMLElement;
+        selectionIsInEditor: (range: Range) => void;
+    };
+    cursor: {
+        storePosition: (state: {
+            selectedRange: Range;
+        }) => void;
+        isAfterEndOfContent: (range: Range, container: HTMLElement) => boolean;
+        isBeforeContent: (range: Range, container: HTMLElement) => boolean;
+    };
+};

package/internal-do-not-import-from-here/ux/floweditor/commands/helpers/HtmlNodehelper.d.ts

@@ -0,0 +1,25 @@
+import { FlowNodeReference, NodeSelection } from "../../models/EditorModels";
+export declare function useHtmlNodeHelper(): {
+    copy: {
+        children: (from: HTMLElement, to: HTMLElement) => void;
+    };
+    insert: {
+        text: (element: Node, text: string, offset: any) => void;
+        elementInContainer: (element: HTMLElement, container: HTMLElement) => void;
+    };
+    get: {
+        topContainerForContent: (element: HTMLElement) => HTMLElement;
+        nodeSelectionForRange: (range: Range) => NodeSelection;
+        htmlElementInStructureById: (id: number, currentElement: HTMLElement) => HTMLElement;
+    };
+    remove: {
+        nodes: (nodes2Remove: Array<FlowNodeReference>, editor: HTMLElement) => void;
+    };
+    strip: {
+        after: (element: HTMLElement, splitter: string) => void;
+        before: (element: HTMLElement, splitter: string) => void;
+    };
+    surround: {
+        selectionWithElement: (element: HTMLElement, range: Range) => void;
+    };
+};

package/internal-do-not-import-from-here/ux/floweditor/models/Constants.d.ts

@@ -0,0 +1,14 @@
+export declare const FlowEditorConstants: {
+    node: {
+        attributes: {
+            pluginType: string;
+            Id: string;
+        };
+    };
+    editor: {
+        container: string;
+    };
+    clipboard: {
+        container: string;
+    };
+};

package/internal-do-not-import-from-here/ux/floweditor/models/EditorModels.d.ts

@@ -0,0 +1,21 @@
+export interface FlowContent {
+    version: string;
+    nodes: FlowNode[];
+}
+export interface FlowNode {
+    type: string;
+    children?: FlowNode[];
+}
+export interface FlowTextNode extends FlowNode {
+    value?: string;
+}
+export interface FlowNodeReference {
+    type: string;
+    id: number;
+    element: HTMLElement;
+}
+export interface NodeSelection {
+    commonAncestorContainer: FlowNodeReference;
+    formatters: FlowNodeReference[];
+    nodes: FlowNodeReference[];
+}

package/internal-do-not-import-from-here/ux/floweditor/models/EditorPlugin.d.ts

@@ -0,0 +1,40 @@
+import { FlowEditorActionRegistration } from "@omnia/fx-models";
+import { FlowNode } from "./EditorModels";
+import { useFlowEditorStore } from "../stores/FlowEditorStore";
+import { useFlowEditorToolbarStore } from "../stores/FlowEditorToolbarStore";
+export interface FlowEditorPlugin {
+    name: string;
+    commands?: object;
+    eventListeners?: Array<FlowEditorEventListener>;
+    actions?: Array<FlowEditorActionRegistration>;
+}
+export interface FlowEditorEventListener {
+    event?: keyof HTMLElementEventMap | Array<keyof HTMLElementEventMap>;
+    action: (event: Event, context: FlowEditorPluginContext) => void;
+}
+export interface FlowRenderingContext {
+    parentElement: HTMLElement;
+}
+export interface FlowToHtmlContext {
+    node: FlowNode;
+    pluginContext: FlowEditorPluginContext;
+    renderingContext: FlowRenderingContext;
+}
+export interface FlowToJsonContext {
+    element: HTMLElement;
+    parent: FlowNode;
+}
+export interface ElementConverter {
+    canConvert: (el: HTMLElement) => boolean;
+    convert: (el: HTMLElement, pluginContext: FlowEditorPluginContext) => HTMLElement;
+}
+export interface FlowEditorContentPlugin extends FlowEditorPlugin {
+    toJSON: (context: FlowToJsonContext) => FlowNode;
+    toHtml: (context: FlowToHtmlContext) => HTMLElement;
+    elementConverter?: ElementConverter;
+}
+export interface FlowEditorPluginContext {
+    componentCreator?: (componentDef: any, props: {}, el: HTMLElement) => void;
+    editorStore: ReturnType<typeof useFlowEditorStore>;
+    toolbarStore: ReturnType<typeof useFlowEditorToolbarStore>;
+}

package/internal-do-not-import-from-here/ux/floweditor/parsers/HtmlParser.d.ts

@@ -0,0 +1,8 @@
+import { FlowEditorPlugin } from "../models/EditorPlugin";
+import { FlowContent } from "../models/EditorModels";
+export declare function useHtmlParser(state: {
+    editor: HTMLDivElement;
+    plugins: Array<FlowEditorPlugin>;
+}): {
+    toJSON: () => FlowContent;
+};

package/internal-do-not-import-from-here/ux/floweditor/parsers/JSONParser.d.ts

@@ -0,0 +1,8 @@
+import { FlowContent } from "../models/EditorModels";
+import { FlowEditorPlugin, FlowEditorPluginContext } from "../models/EditorPlugin";
+export declare function useJSONParser(state: {
+    editor: HTMLDivElement;
+    plugins: Array<FlowEditorPlugin>;
+}, pluginContext: FlowEditorPluginContext): {
+    loadJSONToEditor: (editorContent: FlowContent) => any;
+};

package/internal-do-not-import-from-here/ux/{markdown2 → floweditor}/plugins/DefineEditorPlugin.d.ts

@@ -1,8 +1,8 @@
 import { SetupFactoryContext } from "@omnia/fx";
-import { EditorFormattingPlugin, EditorPlugin } from "../models/EditorPlugin";
+import { FlowEditorContentPlugin, FlowEditorPlugin } from "../models/EditorPlugin";
 interface SetupEditorPluginContext extends SetupFactoryContext {
 }
-export declare function defineEditorPlugin<TArgs extends any[]>(setup: (ctx: SetupEditorPluginContext) => EditorPlugin | EditorFormattingPlugin): () => EditorPlugin & {
+export declare function defineEditorPlugin<TArgs extends any[]>(setup: (ctx: SetupEditorPluginContext) => FlowEditorPlugin | FlowEditorContentPlugin): () => FlowEditorPlugin & {
     dispose?: () => void;
 };
 export {};

package/internal-do-not-import-from-here/ux/{markdown2 → floweditor}/plugins/bold/BoldPlugin.d.ts

@@ -1,3 +1,3 @@
-export declare const boldPlugin: () => import("../../models/EditorPlugin").EditorPlugin & {
+export declare const boldPlugin: () => import("../../models/EditorPlugin").FlowEditorPlugin & {
     dispose?: () => void;
 };

package/internal-do-not-import-from-here/ux/{markdown2 → floweditor}/plugins/colorstyle/ColorButton.d.ts

@@ -1,6 +1,6 @@
 import { ColorValue } from "@omnia/fx-models";
-import { ContentNode } from "../../models/EditorModels";
-export interface ColorFormatNode extends ContentNode {
+import { FlowNode } from "../../models/EditorModels";
+export interface ColorFormatNode extends FlowNode {
     data: ColorValue;
 }
 declare const _default: (props: import("@omnia/fx/ux").ConstructComponentProps<{}>) => any;

package/internal-do-not-import-from-here/ux/{markdown2 → floweditor}/plugins/colorstyle/ColorStylePlugin.d.ts

@@ -1,3 +1,3 @@
-export declare const colorStylePlugin: () => import("../../models/EditorPlugin").EditorPlugin & {
+export declare const colorStylePlugin: () => import("../../models/EditorPlugin").FlowEditorPlugin & {
     dispose?: () => void;
 };

package/internal-do-not-import-from-here/ux/floweditor/plugins/elements/ElementPlugin.d.ts

@@ -0,0 +1,7 @@
+import { FlowNode } from "../../models/EditorModels";
+export interface ElementNode extends FlowNode {
+    name: "br";
+}
+export declare const elementPlugin: () => import("../../models/EditorPlugin").FlowEditorPlugin & {
+    dispose?: () => void;
+};

package/internal-do-not-import-from-here/ux/floweditor/plugins/eventhandlers/EditorEvents.d.ts

@@ -0,0 +1,4 @@
+import { FlowEditorPlugin } from "../../models/EditorPlugin";
+export declare const editorEventsPlugin: () => FlowEditorPlugin & {
+    dispose?: () => void;
+};

package/internal-do-not-import-from-here/ux/floweditor/plugins/eventhandlers/KeyboardEvents.d.ts

@@ -0,0 +1,4 @@
+import { FlowEditorPlugin } from "../../models/EditorPlugin";
+export declare const keyboardEventsPlugin: () => FlowEditorPlugin & {
+    dispose?: () => void;
+};

package/internal-do-not-import-from-here/ux/floweditor/plugins/eventhandlers/handlers/BackspaceHandler.d.ts

@@ -0,0 +1,4 @@
+import { useFlowEditorStore } from "../../../stores/FlowEditorStore";
+export declare function useBackspaceHandler(): {
+    handle: (store: ReturnType<typeof useFlowEditorStore>) => void;
+};

package/internal-do-not-import-from-here/ux/floweditor/plugins/eventhandlers/handlers/ClipboardHandler.d.ts

@@ -0,0 +1,4 @@
+import { useFlowEditorStore } from "../../../stores/FlowEditorStore";
+export declare function useClipboardHandler(): {
+    paste: (ev: ClipboardEvent, editorStore: ReturnType<typeof useFlowEditorStore>) => void;
+};

package/internal-do-not-import-from-here/ux/floweditor/plugins/eventhandlers/handlers/EnterHandler.d.ts

@@ -0,0 +1,4 @@
+import { useFlowEditorStore } from "../../../stores/FlowEditorStore";
+export declare function useEnterHandler(): {
+    handle: (store: ReturnType<typeof useFlowEditorStore>) => void;
+};

package/internal-do-not-import-from-here/ux/{markdown2 → floweditor}/plugins/italic/ItalicPlugin.d.ts

@@ -1,3 +1,3 @@
-export declare const italicPlugin: () => import("../../models/EditorPlugin").EditorPlugin & {
+export declare const italicPlugin: () => import("../../models/EditorPlugin").FlowEditorPlugin & {
     dispose?: () => void;
 };

package/internal-do-not-import-from-here/ux/floweditor/plugins/sourceeditor/SourceEditorPlugin.d.ts

@@ -0,0 +1,4 @@
+import { FlowEditorPlugin } from "../../models/EditorPlugin";
+export declare const sourceEditorPlugin: () => FlowEditorPlugin & {
+    dispose?: () => void;
+};

package/internal-do-not-import-from-here/ux/floweditor/plugins/testdata/TestDataPlugin.d.ts

@@ -0,0 +1,4 @@
+import { FlowEditorPlugin } from "../../models/EditorPlugin";
+export declare const testDataPlugin: () => FlowEditorPlugin & {
+    dispose?: () => void;
+};

package/internal-do-not-import-from-here/ux/floweditor/plugins/text/TextPlugin.d.ts

@@ -0,0 +1,3 @@
+export declare const textPlugin: () => import("../../models/EditorPlugin").FlowEditorPlugin & {
+    dispose?: () => void;
+};

package/internal-do-not-import-from-here/ux/{markdown2 → floweditor}/plugins/typography/TypographyButton.d.ts

@@ -1,6 +1,6 @@
 import { TypographyValue } from "@omnia/fx-models";
-import { ContentNode } from "../../models/EditorModels";
-export interface TypographyFormatNode extends ContentNode {
+import { FlowNode } from "../../models/EditorModels";
+export interface TypographyFormatNode extends FlowNode {
     data: TypographyValue;
 }
 declare const _default: (props: import("@omnia/fx/ux").ConstructComponentProps<{}>) => any;

package/internal-do-not-import-from-here/ux/{markdown2 → floweditor}/plugins/typography/TypographyPlugin.d.ts

@@ -1,3 +1,3 @@
-export declare const typographyPlugin: () => import("../../models/EditorPlugin").EditorPlugin & {
+export declare const typographyPlugin: () => import("../../models/EditorPlugin").FlowEditorPlugin & {
     dispose?: () => void;
 };

package/internal-do-not-import-from-here/ux/{markdown2 → floweditor}/plugins/velcron/VelcronPlugin.d.ts

@@ -1,8 +1,8 @@
 import { VelcronAppDefinition } from "@omnia/fx-models";
-import { ContentNode } from "../../models/EditorModels";
-export interface VelcronContentNode extends ContentNode {
+import { FlowNode } from "../../models/EditorModels";
+export interface VelcronContentNode extends FlowNode {
     definition: VelcronAppDefinition;
 }
-export declare const velcronRendererPlugin: () => import("../../models/EditorPlugin").EditorPlugin & {
+export declare const velcronRendererPlugin: () => import("../../models/EditorPlugin").FlowEditorPlugin & {
     dispose?: () => void;
 };

package/internal-do-not-import-from-here/ux/floweditor/rules/EditorRules.d.ts

@@ -0,0 +1,7 @@
+export declare function useFlowEditorRules(): {
+    is: {
+        topContainer: (node: HTMLElement) => boolean;
+        editorNode: (node: HTMLElement) => boolean;
+        clipboardContainer: (node: HTMLElement) => boolean;
+    };
+};