@ixo/editor 0.2.0

package/dist/hooks/useCollaborativeIxoEditor.d.ts

@@ -0,0 +1,571 @@
+import { IxoCollaborativeEditorOptions } from "../types";
+/**
+ * Custom hook that wraps useCreateBlockNote with IXO-specific configurations
+ * @param options - Configuration options for the IxoEditor
+ * @returns A configured BlockNote editor instance
+ */
+export declare function useCreateCollaborativeIxoEditor(options: IxoCollaborativeEditorOptions): {
+    editor: import("@blocknote/core").BlockNoteEditor<import("@blocknote/core").BlockSchemaFromSpecs<{
+        list: {
+            config: {
+                readonly type: "list";
+                readonly propSchema: {
+                    readonly title: {
+                        readonly default: "";
+                    };
+                    readonly did: {
+                        readonly default: "";
+                    };
+                    readonly fragmentIdentifier: {
+                        readonly default: "";
+                    };
+                    readonly listItemType: {
+                        readonly default: "keyvalue";
+                    };
+                    readonly showLinkedResources: {
+                        readonly default: false;
+                    };
+                    readonly showAssetsInCollection: {
+                        readonly default: false;
+                    };
+                };
+                readonly content: "none";
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                readonly type: "list";
+                readonly propSchema: {
+                    readonly title: {
+                        readonly default: "";
+                    };
+                    readonly did: {
+                        readonly default: "";
+                    };
+                    readonly fragmentIdentifier: {
+                        readonly default: "";
+                    };
+                    readonly listItemType: {
+                        readonly default: "keyvalue";
+                    };
+                    readonly showLinkedResources: {
+                        readonly default: false;
+                    };
+                    readonly showAssetsInCollection: {
+                        readonly default: false;
+                    };
+                };
+                readonly content: "none";
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        overview: {
+            config: {
+                type: "overview";
+                propSchema: {
+                    did: {
+                        default: string;
+                    };
+                };
+                content: "inline";
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "overview";
+                propSchema: {
+                    did: {
+                        default: string;
+                    };
+                };
+                content: "inline";
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        paragraph: {
+            config: {
+                type: "paragraph";
+                content: "inline";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "paragraph";
+                content: "inline";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        heading: {
+            config: {
+                type: "heading";
+                content: "inline";
+                propSchema: {
+                    level: {
+                        default: number;
+                        values: readonly [1, 2, 3];
+                    };
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "heading";
+                content: "inline";
+                propSchema: {
+                    level: {
+                        default: number;
+                        values: readonly [1, 2, 3];
+                    };
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        bulletListItem: {
+            config: {
+                type: "bulletListItem";
+                content: "inline";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "bulletListItem";
+                content: "inline";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        numberedListItem: {
+            config: {
+                type: "numberedListItem";
+                content: "inline";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "numberedListItem";
+                content: "inline";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        checkListItem: {
+            config: {
+                type: "checkListItem";
+                content: "inline";
+                propSchema: {
+                    checked: {
+                        default: false;
+                    };
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "checkListItem";
+                content: "inline";
+                propSchema: {
+                    checked: {
+                        default: false;
+                    };
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        table: {
+            config: {
+                type: "table";
+                content: "table";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "table";
+                content: "table";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    textColor: {
+                        default: "default";
+                    };
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                };
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        file: {
+            config: {
+                type: "file";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    name: {
+                        default: "";
+                    };
+                    url: {
+                        default: "";
+                    };
+                    caption: {
+                        default: "";
+                    };
+                };
+                content: "none";
+                isFileBlock: true;
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "file";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    name: {
+                        default: "";
+                    };
+                    url: {
+                        default: "";
+                    };
+                    caption: {
+                        default: "";
+                    };
+                };
+                content: "none";
+                isFileBlock: true;
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        image: {
+            config: {
+                type: "image";
+                propSchema: {
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    name: {
+                        default: "";
+                    };
+                    url: {
+                        default: "";
+                    };
+                    caption: {
+                        default: "";
+                    };
+                    showPreview: {
+                        default: true;
+                    };
+                    previewWidth: {
+                        default: number;
+                    };
+                };
+                content: "none";
+                isFileBlock: true;
+                fileBlockAccept: string[];
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "image";
+                propSchema: {
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    name: {
+                        default: "";
+                    };
+                    url: {
+                        default: "";
+                    };
+                    caption: {
+                        default: "";
+                    };
+                    showPreview: {
+                        default: true;
+                    };
+                    previewWidth: {
+                        default: number;
+                    };
+                };
+                content: "none";
+                isFileBlock: true;
+                fileBlockAccept: string[];
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        video: {
+            config: {
+                type: "video";
+                propSchema: {
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    name: {
+                        default: "";
+                    };
+                    url: {
+                        default: "";
+                    };
+                    caption: {
+                        default: "";
+                    };
+                    showPreview: {
+                        default: true;
+                    };
+                    previewWidth: {
+                        default: number;
+                    };
+                };
+                content: "none";
+                isFileBlock: true;
+                fileBlockAccept: string[];
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "video";
+                propSchema: {
+                    textAlignment: {
+                        default: "left";
+                        values: readonly ["left", "center", "right", "justify"];
+                    };
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    name: {
+                        default: "";
+                    };
+                    url: {
+                        default: "";
+                    };
+                    caption: {
+                        default: "";
+                    };
+                    showPreview: {
+                        default: true;
+                    };
+                    previewWidth: {
+                        default: number;
+                    };
+                };
+                content: "none";
+                isFileBlock: true;
+                fileBlockAccept: string[];
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+        audio: {
+            config: {
+                type: "audio";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    name: {
+                        default: "";
+                    };
+                    url: {
+                        default: "";
+                    };
+                    caption: {
+                        default: "";
+                    };
+                    showPreview: {
+                        default: true;
+                    };
+                };
+                content: "none";
+                isFileBlock: true;
+                fileBlockAccept: string[];
+            };
+            implementation: import("@blocknote/core").TiptapBlockImplementation<{
+                type: "audio";
+                propSchema: {
+                    backgroundColor: {
+                        default: "default";
+                    };
+                    name: {
+                        default: "";
+                    };
+                    url: {
+                        default: "";
+                    };
+                    caption: {
+                        default: "";
+                    };
+                    showPreview: {
+                        default: true;
+                    };
+                };
+                content: "none";
+                isFileBlock: true;
+                fileBlockAccept: string[];
+            }, any, import("@blocknote/core").InlineContentSchema, import("@blocknote/core").StyleSchema>;
+        };
+    }>, import("@blocknote/core").InlineContentSchemaFromSpecs<{
+        text: {
+            config: "text";
+            implementation: any;
+        };
+        link: {
+            config: "link";
+            implementation: any;
+        };
+    }>, import("@blocknote/core").StyleSchemaFromSpecs<{
+        bold: {
+            config: {
+                type: string;
+                propSchema: "boolean";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+        italic: {
+            config: {
+                type: string;
+                propSchema: "boolean";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+        underline: {
+            config: {
+                type: string;
+                propSchema: "boolean";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+        strike: {
+            config: {
+                type: string;
+                propSchema: "boolean";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+        code: {
+            config: {
+                type: string;
+                propSchema: "boolean";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+        textColor: {
+            config: {
+                type: string;
+                propSchema: "string";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+        backgroundColor: {
+            config: {
+                type: string;
+                propSchema: "string";
+            };
+            implementation: import("@blocknote/core").StyleImplementation;
+        };
+    }>>;
+    connectionStatus: "connecting" | "connected" | "failed" | "disconnected";
+};
+//# sourceMappingURL=useCollaborativeIxoEditor.d.ts.map

package/dist/hooks/useCollaborativeIxoEditor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCollaborativeIxoEditor.d.ts","sourceRoot":"","sources":["../../src/hooks/useCollaborativeIxoEditor.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,6BAA6B,EAAE,MAAM,UAAU,CAAC;AAMzD;;;;GAIG;AACH,wBAAgB,+BAA+B,CAC7C,OAAO,EAAE,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0GvC"}

package/dist/hooks/useCollaborativeIxoEditor.js

@@ -0,0 +1,127 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useCreateCollaborativeIxoEditor = useCreateCollaborativeIxoEditor;
+const react_1 = require("@blocknote/react");
+const core_1 = require("@blocknote/core");
+const blocks_1 = require("../blocks");
+const useMatrixProvider_1 = require("./useMatrixProvider");
+const Y = __importStar(require("yjs"));
+const react_2 = require("react");
+/**
+ * Custom hook that wraps useCreateBlockNote with IXO-specific configurations
+ * @param options - Configuration options for the IxoEditor
+ * @returns A configured BlockNote editor instance
+ */
+function useCreateCollaborativeIxoEditor(options) {
+    // Extract IXO-specific options and BlockNote options
+    // Memoize Y.Doc to prevent recreation on every render
+    const yDoc = (0, react_2.useMemo)(() => new Y.Doc(), []);
+    const { theme = "light", uploadFile, initialContent, editable = true, sideMenu = true, slashMenu = true, formattingToolbar = true, linkToolbar = true, filePanel = true, tableHandles = true, user, matrix: { roomId, baseUrl, } } = options || {};
+    // Memoize user data to prevent recreation
+    const memoizedUser = (0, react_2.useMemo)(() => ({
+        id: user?.id || "",
+        name: user?.name || "",
+        color: user?.color || "",
+        accessToken: user?.accessToken || "",
+    }), [user?.id, user?.name, user?.color, user?.accessToken]);
+    const { matrixProvider, connectionStatus } = (0, useMatrixProvider_1.useMatrixProvider)({
+        userId: memoizedUser.id,
+        accessToken: memoizedUser.accessToken,
+        baseUrl: baseUrl,
+        roomId: roomId,
+        yDoc,
+    });
+    // Memoize default upload handler to prevent recreation
+    const defaultUploadFile = (0, react_2.useMemo)(() => uploadFile ||
+        (async (file) => {
+            // Default implementation - convert to data URL
+            // In production, you'd want to upload to a server
+            return new Promise((resolve, reject) => {
+                const reader = new FileReader();
+                reader.onloadend = () => {
+                    const dataUrl = reader.result;
+                    resolve(dataUrl);
+                };
+                reader.onerror = reject;
+                reader.readAsDataURL(file);
+            });
+        }), [uploadFile]);
+    // Memoize schema to prevent recreation
+    const schema = (0, react_2.useMemo)(() => core_1.BlockNoteSchema.create({
+        blockSpecs: {
+            ...core_1.defaultBlockSpecs,
+            ...blocks_1.blockSpecs,
+        },
+        inlineContentSpecs: {
+            ...core_1.defaultInlineContentSpecs,
+        },
+        styleSpecs: {
+            ...core_1.defaultStyleSpecs,
+        },
+    }), []);
+    // Memoize collaboration config to prevent recreation
+    const collaborationConfig = (0, react_2.useMemo)(() => ({
+        provider: matrixProvider,
+        fragment: yDoc.getXmlFragment("document"),
+        user: {
+            name: memoizedUser.name,
+            color: memoizedUser.color,
+        },
+    }), [matrixProvider, yDoc, memoizedUser.name, memoizedUser.color]);
+    // Memoize IXO config to prevent recreation
+    const ixoConfig = (0, react_2.useMemo)(() => ({
+        theme,
+        editable,
+        sideMenu,
+        slashMenu,
+        formattingToolbar,
+        linkToolbar,
+        filePanel,
+        tableHandles,
+    }), [theme, editable, sideMenu, slashMenu, formattingToolbar, linkToolbar, filePanel, tableHandles]);
+    // Create the BlockNote editor with basic configurations
+    const editor = (0, react_1.useCreateBlockNote)({
+        schema,
+        initialContent,
+        uploadFile: defaultUploadFile,
+        collaboration: collaborationConfig,
+    });
+    // Store configuration in editor for components to access
+    if (editor) {
+        editor._ixoConfig = ixoConfig;
+    }
+    return { editor, connectionStatus: connectionStatus };
+}