Open-source and local-first Slack and Notion alternative that puts you in control of your data
TypeScript chatchat-applicationcrdteditorelectronknowledge-baselocal-firstnotionnotion-alternativerealtime-collaborationself-hostedslacksqliteteam-collaborationwikiyjs
Improvements in page editor
Hakan Shehu16e2cf2d3e68
diff --git a/desktop/package-lock.json b/desktop/package-lock.jsonindex 7abf5c60..37f28fde 100644--- a/desktop/package-lock.json+++ b/desktop/package-lock.json@@ -60,6 +60,7 @@"fractional-indexing-jittered": "^0.9.1","is-hotkey": "^0.2.0","kysely": "^0.27.4",+ "lodash": "^4.17.21","lowlight": "^3.1.0","mobx": "^6.13.1","mobx-react-lite": "^4.0.7",@@ -86,6 +87,7 @@"@electron/fuses": "^1.8.0","@types/better-sqlite3": "^7.6.11","@types/is-hotkey": "^0.1.10",+ "@types/lodash": "^4.17.7","@types/react": "^18.3.3","@types/react-dom": "^18.3.0","@typescript-eslint/eslint-plugin": "^5.62.0",@@ -3302,6 +3304,13 @@"@types/node": "*"}},+ "node_modules/@types/lodash": {+ "version": "4.17.7",+ "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.7.tgz",+ "integrity": "sha512-8wTvZawATi/lsmNu10/j2hk1KEP0IvjubqPE3cu1Xz7xfXXt5oCq3SNUz4fMIP4XGF9Ky+Ue2tBA3hcS7LSBlA==",+ "dev": true,+ "license": "MIT"+ },"node_modules/@types/minimatch": {"version": "5.1.2","resolved": "https://registry.npmjs.org/@types/minimatch/-/minimatch-5.1.2.tgz",@@ -8936,7 +8945,6 @@"version": "4.17.21","resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz","integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==",- "dev": true,"license": "MIT"},"node_modules/lodash.get": {diff --git a/desktop/package.json b/desktop/package.jsonindex 97696b8e..2700872b 100644--- a/desktop/package.json+++ b/desktop/package.json@@ -24,6 +24,7 @@"@electron/fuses": "^1.8.0","@types/better-sqlite3": "^7.6.11","@types/is-hotkey": "^0.1.10",+ "@types/lodash": "^4.17.7","@types/react": "^18.3.3","@types/react-dom": "^18.3.0","@typescript-eslint/eslint-plugin": "^5.62.0",@@ -98,6 +99,7 @@"fractional-indexing-jittered": "^0.9.1","is-hotkey": "^0.2.0","kysely": "^0.27.4",+ "lodash": "^4.17.21","lowlight": "^3.1.0","mobx": "^6.13.1","mobx-react-lite": "^4.0.7",diff --git a/desktop/src/components/pages/page-editor.tsx b/desktop/src/components/pages/page-editor.tsxindex 3d1f5a92..7910dcb8 100644--- a/desktop/src/components/pages/page-editor.tsx+++ b/desktop/src/components/pages/page-editor.tsx@@ -1,5 +1,4 @@import React from 'react';-import type { JSONContent } from '@tiptap/core';import '@/styles/editor.css';import { useEditor, EditorContent } from '@tiptap/react';import { Node } from '@/types/nodes';@@ -17,7 +16,7 @@ import {} from '@/editor/commands';import {IdExtension,- DocumentNode,+ PageNode,TextNode,ParagraphNode,HeadingNode,@@ -48,17 +47,20 @@ import {import { EditorBubbleMenu } from '@/editor/menu/bubble-menu';import { observer } from 'mobx-react-lite';+import { useDocument } from '@/hooks/use-document';interface PageEditorProps {node: Node;}export const PageEditor = observer(({ node }: PageEditorProps) => {+ const { content, onUpdate } = useDocument(node);+const editor = useEditor({extensions: [IdExtension,- DocumentNode,+ PageNode,TextNode,ParagraphNode,HeadingNode,@@ -110,8 +112,11 @@ export const PageEditor = observer(({ node }: PageEditorProps) => {},},shouldRerenderOnTransaction: false,- onUpdate: ({ editor }) => {- console.log(editor.getJSON());+ content: content,+ onUpdate: ({ editor, transaction }) => {+ if (transaction.docChanged) {+ onUpdate(editor.getJSON());+ }},autofocus: 'start',},diff --git a/desktop/src/components/workspaces/workspace.tsx b/desktop/src/components/workspaces/workspace.tsxindex 2b2656b4..ed4f1714 100644--- a/desktop/src/components/workspaces/workspace.tsx+++ b/desktop/src/components/workspaces/workspace.tsx@@ -1,10 +1,10 @@-import React from "react";-import {Sidebar} from "@/components/workspaces/sidebar";-import {WorkspaceCreate} from "@/components/workspaces/workspace-create";-import {WorkspaceContext} from "@/contexts/workspace";-import {useStore} from "@/contexts/store";-import {observer} from "mobx-react-lite";-import {Container} from "@/components/workspaces/container";+import React from 'react';+import { Sidebar } from '@/components/workspaces/sidebar';+import { WorkspaceCreate } from '@/components/workspaces/workspace-create';+import { WorkspaceContext } from '@/contexts/workspace';+import { useStore } from '@/contexts/store';+import { observer } from 'mobx-react-lite';+import { Container } from '@/components/workspaces/container';export const Workspace = observer(() => {const store = useStore();@@ -16,39 +16,59 @@ export const Workspace = observer(() => {const workspace = workspaces[0];return (- <WorkspaceContext.Provider value={{- ...workspace,- addNode: async (node) => {- await window.workspaceDb.addNode(workspace.accountId, workspace.id, node);- workspace.setNode(node);- },- addNodes: async (nodes) => {- await window.workspaceDb.addNodes(workspace.accountId, workspace.id, nodes);- nodes.forEach(node => workspace.setNode(node));- },- getNodes: () => {- return workspace.getNodes()- },- updateNode: async (node) => {- workspace.setNode(node);- await window.workspaceDb.updateNode(workspace.accountId, workspace.id, node);- },- deleteNode: async (nodeId) => {- workspace.deleteNode(nodeId);- await window.workspaceDb.deleteNode(workspace.accountId, workspace.id, nodeId);- },- setContainerNode: (nodeId) => {- workspace.setContainerNode(nodeId);- }- }}>+ <WorkspaceContext.Provider+ value={{+ ...workspace,+ addNode: async (node) => {+ await window.workspaceDb.addNode(+ workspace.accountId,+ workspace.id,+ node,+ );+ workspace.setNode(node);+ },+ addNodes: async (nodes) => {+ await window.workspaceDb.addNodes(+ workspace.accountId,+ workspace.id,+ nodes,+ );+ nodes.forEach((node) => workspace.setNode(node));+ },+ getNodes: () => {+ return workspace.getNodes();+ },+ updateNode: async (node) => {+ workspace.setNode(node);+ await window.workspaceDb.updateNode(+ workspace.accountId,+ workspace.id,+ node,+ );+ },+ deleteNode: async (nodeId) => {+ workspace.deleteNode(nodeId);+ await window.workspaceDb.deleteNode(+ workspace.accountId,+ workspace.id,+ nodeId,+ );+ },+ setContainerNode: (nodeId) => {+ workspace.setContainerNode(nodeId);+ },+ }}+ ><div className="flex h-screen max-h-screen flex-row"><div className="w-96"><Sidebar /></div>- <main className="h-full w-full min-w-128 flex-grow overflow-hidden bg-white">- {workspace.containerNodeId && <Container nodeId={workspace.containerNodeId} />}+ <main className="min-w-128 h-full w-full flex-grow overflow-hidden bg-white">+ {workspace.containerNodeId && (+ <Container nodeId={workspace.containerNodeId} />+ )}</main></div></WorkspaceContext.Provider>- )-});\ No newline at end of file+ );+});diff --git a/desktop/src/editor/extensions/index.tsx b/desktop/src/editor/extensions/index.tsxindex 1fc0b2db..23a5bdf1 100644--- a/desktop/src/editor/extensions/index.tsx+++ b/desktop/src/editor/extensions/index.tsx@@ -28,6 +28,7 @@ import { TabKeymapExtension } from '@/editor/extensions/tab-keymap';import { TaskItemNode } from '@/editor/extensions/task-item';import { TaskListNode } from '@/editor/extensions/task-list';import { TrailingNode } from '@/editor/extensions/trailing-node';+import { PageNode } from '@/editor/extensions/page';export {IdExtension,@@ -59,4 +60,5 @@ export {TrailingNode,UnderlineMark,DropcursorExtension,+ PageNode,};diff --git a/desktop/src/editor/extensions/page.tsx b/desktop/src/editor/extensions/page.tsxnew file mode 100644index 00000000..8d8704ee--- /dev/null+++ b/desktop/src/editor/extensions/page.tsx@@ -0,0 +1,7 @@+import { Node } from '@tiptap/core';++export const PageNode = Node.create({+ name: 'page',+ topNode: true,+ content: 'block+',+});diff --git a/desktop/src/editor/extensions/trailing-node.tsx b/desktop/src/editor/extensions/trailing-node.tsxindex a4fd0108..1bf23e64 100644--- a/desktop/src/editor/extensions/trailing-node.tsx+++ b/desktop/src/editor/extensions/trailing-node.tsx@@ -4,9 +4,9 @@ import { Plugin, PluginKey } from '@tiptap/pm/state';const nodeEqualsType = ({ types, node }: { types: NodeType[]; node: any }) => {return (- (Array.isArray(types) && types.includes(node.type)) || node.type === types+ (Array.isArray(types) && types.includes(node?.type)) || node?.type === types);-}+};export interface TrailingNodeOptions {node: string;diff --git a/desktop/src/editor/utils.ts b/desktop/src/editor/utils.tsindex 9cc9beeb..007acaeb 100644--- a/desktop/src/editor/utils.ts+++ b/desktop/src/editor/utils.ts@@ -3,6 +3,7 @@ import { JSONContent } from '@tiptap/core';import { NeuronId } from '@/lib/id';import { generateKeyBetween } from 'fractional-indexing-jittered';import { Workspace } from '@/types/workspaces';+import { LeafNodeTypes } from '@/lib/constants';export const mapToEditorContent = (parent: Node,@@ -146,7 +147,10 @@ const buildNodeWithChildren = (};};-const enumerateNodes = (nodeWithChildren: NodeWithChildren, nodes: Node[]) => {+export const enumerateNodes = (+ nodeWithChildren: NodeWithChildren,+ nodes: Node[],+) => {nodes.push(nodeWithChildren);nodeWithChildren.children.forEach((child) => {enumerateNodes(child, nodes);@@ -154,5 +158,5 @@ const enumerateNodes = (nodeWithChildren: NodeWithChildren, nodes: Node[]) => {};const isLeafNode = (type: string) => {- return type === 'paragraph' || type === 'heading' || type === 'blockquote';+ return LeafNodeTypes.includes(type);};diff --git a/desktop/src/electron/database/workspace/index.ts b/desktop/src/electron/database/workspace/index.tsindex b3c8cc1a..0a64b768 100644--- a/desktop/src/electron/database/workspace/index.ts+++ b/desktop/src/electron/database/workspace/index.ts@@ -139,7 +139,7 @@ export class WorkspaceDatabase {.executeTakeFirst();await this.globalDatabase.addTransaction({- id: NeuronId.getType(NeuronId.Type.Transaction),+ id: NeuronId.generate(NeuronId.Type.Transaction),nodeId: node.id,type: 'update_node',workspaceId: node.workspaceId,diff --git a/desktop/src/hooks/use-document.tsx b/desktop/src/hooks/use-document.tsxnew file mode 100644index 00000000..3801eed0--- /dev/null+++ b/desktop/src/hooks/use-document.tsx@@ -0,0 +1,60 @@+import React from 'react';+import { debounce } from 'lodash';+import { Node } from '@/types/nodes';+import { useWorkspace } from '@/contexts/workspace';+import { buildNodes, enumerateNodes, mapToEditorContent } from '@/editor/utils';+import { JSONContent } from '@tiptap/core';+import { buildNodeWithChildren } from '@/lib/nodes';++interface useNodeResult {+ content: JSONContent;+ onUpdate: (content: JSONContent) => void;+}++export const useDocument = (node: Node): useNodeResult => {+ const workspace = useWorkspace();+ const nodes = workspace.getNodes();+ const content = mapToEditorContent(node, nodes);++ const onUpdate = React.useMemo(+ () =>+ // Update the content of the node+ debounce(async (updatedContent: JSONContent) => {+ const nodeWithChildren = buildNodeWithChildren(node, nodes);+ const childNodes: Node[] = [];+ enumerateNodes(nodeWithChildren, childNodes);++ const newNodes = buildNodes(+ workspace,+ node,+ updatedContent.content,+ childNodes,+ );++ for (const newNode of newNodes) {+ const existingNode = childNodes.find((n) => n.id === newNode.id);+ if (existingNode) {+ newNode.updatedBy = workspace.userNodeId;+ newNode.updatedAt = new Date();+ await workspace.updateNode(newNode);+ } else {+ await workspace.addNode(newNode);+ }+ }++ const nodesToDelete = childNodes.filter(+ (n) => n.id != node.id && !newNodes.find((nn) => nn.id === n.id),+ );++ for (const nodeToDelete of nodesToDelete) {+ await workspace.deleteNode(nodeToDelete.id);+ }+ }, 500),+ [node.id],+ );++ return {+ content,+ onUpdate,+ };+};diff --git a/desktop/src/lib/constants.ts b/desktop/src/lib/constants.tsindex 256c91ee..c129c917 100644--- a/desktop/src/lib/constants.ts+++ b/desktop/src/lib/constants.ts@@ -3,4 +3,22 @@ export const NodeTypes = {Page: 'page',Channel: 'channel',Message: 'message',+ Paragraph: 'paragraph',+ Heading: 'heading',+ Blockquote: 'blockquote',+ BulletList: 'bulletList',+ CodeBlock: 'codeBlock',+ ListItem: 'listItem',+ OrderedList: 'orderedList',+ TaskList: 'taskList',+ TaskItem: 'taskItem',+ Divider: 'divider',};++export const LeafNodeTypes: string[] = [+ NodeTypes.Paragraph,+ NodeTypes.Heading,+ NodeTypes.Blockquote,+ NodeTypes.Divider,+ NodeTypes.CodeBlock,+];