⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.
TypeScript honoissue-managementissue-trackerjira-alternativekanbanlinear-alternativemcpproject-managementreactself-hostedtypescript
feat(editor): share the rich text schema between web and mobile
Andrej41a9dbcd3ba8
diff --git a/Dockerfile.kaneo b/Dockerfile.kaneoindex 45334af1a..f85832d9a 100644--- a/Dockerfile.kaneo+++ b/Dockerfile.kaneo@@ -84,6 +84,7 @@ COPY packages/libs/package.json ./packages/libs/COPY packages/typescript-config ./packages/typescript-configCOPY packages/libs ./packages/libsCOPY packages/permissions ./packages/permissions+COPY packages/editor ./packages/editorCOPY i18n ./i18nCOPY apps/web ./apps/web@@ -92,6 +93,9 @@ RUN pnpm install --frozen-lockfileWORKDIR /app/packages/permissionsRUN pnpm run build+WORKDIR /app/packages/editor+RUN pnpm run build+WORKDIR /app/apps/webRUN pnpm run build && find dist -type f -name '*.map' -deletediff --git a/apps/web/Dockerfile b/apps/web/Dockerfileindex 4a6c406f9..9cfd44e34 100644--- a/apps/web/Dockerfile+++ b/apps/web/Dockerfile@@ -24,6 +24,7 @@ COPY apps/web/package.json ./apps/web/COPY packages/typescript-config/package.json ./packages/typescript-config/COPY packages/libs/package.json ./packages/libs/COPY packages/permissions/package.json ./packages/permissions/+COPY packages/editor/package.json ./packages/editor/# Install dependenciesRUN pnpm install --frozen-lockfile@@ -32,13 +33,17 @@ RUN pnpm install --frozen-lockfileCOPY packages/typescript-config ./packages/typescript-configCOPY packages/libs ./packages/libsCOPY packages/permissions ./packages/permissions+COPY packages/editor ./packages/editorCOPY i18n ./i18nCOPY apps/web ./apps/web-# Build the permissions package first+# Build the shared packages firstWORKDIR /app/packages/permissionsRUN pnpm run build+WORKDIR /app/packages/editor+RUN pnpm run build+# Build the applicationWORKDIR /app/apps/web# SENTRY_AUTH_TOKEN is optional: only mounted during container builds thatdiff --git a/apps/web/package.json b/apps/web/package.jsonindex 4aa964155..7631cd070 100644--- a/apps/web/package.json+++ b/apps/web/package.json@@ -108,6 +108,7 @@},"devDependencies": {"@babel/core": "^8.0.9",+ "@kaneo/editor": "workspace:*","@kaneo/libs": "workspace:*","@kaneo/permissions": "workspace:*","@rolldown/plugin-babel": "^0.2.4",diff --git a/apps/web/src/components/activity/comment-editor-image-upload.test.tsx b/apps/web/src/components/activity/comment-editor-image-upload.test.tsxindex 13bbcaf1f..861d2ce16 100644--- a/apps/web/src/components/activity/comment-editor-image-upload.test.tsx+++ b/apps/web/src/components/activity/comment-editor-image-upload.test.tsx@@ -51,9 +51,6 @@ vi.mock("@/components/task/extensions/attachment-card", () => ({vi.mock("@/components/task/extensions/kaneo-issue-link", () => ({KaneoIssueLink: inert("kaneoIssueLinkStub"),}));-vi.mock("@/components/task/extensions/kaneo-mention", () => ({- KaneoMention: inert("kaneoMentionStub"),-}));vi.mock("@/components/task/extensions/mention-suggestion", () => ({MentionSuggestion: inert("mentionSuggestionStub"),}));diff --git a/apps/web/src/components/activity/comment-editor-markdown-paste.test.tsx b/apps/web/src/components/activity/comment-editor-markdown-paste.test.tsxindex bd336d592..a70513713 100644--- a/apps/web/src/components/activity/comment-editor-markdown-paste.test.tsx+++ b/apps/web/src/components/activity/comment-editor-markdown-paste.test.tsx@@ -41,9 +41,6 @@ vi.mock("@/components/task/extensions/attachment-card", () => ({vi.mock("@/components/task/extensions/kaneo-issue-link", () => ({KaneoIssueLink: inert("kaneoIssueLinkStub"),}));-vi.mock("@/components/task/extensions/kaneo-mention", () => ({- KaneoMention: inert("kaneoMentionStub"),-}));vi.mock("@/components/task/extensions/mention-suggestion", () => ({MentionSuggestion: inert("mentionSuggestionStub"),}));diff --git a/apps/web/src/components/activity/comment-editor.tsx b/apps/web/src/components/activity/comment-editor.tsxindex 1848a5017..c80da4a26 100644--- a/apps/web/src/components/activity/comment-editor.tsx+++ b/apps/web/src/components/activity/comment-editor.tsx@@ -32,7 +32,7 @@ import {import type { MouseEvent as ReactMouseEvent } from "react";import { useCallback, useEffect, useMemo, useRef, useState } from "react";import { useTranslation } from "react-i18next";-import { KaneoMention } from "@/components/task/extensions/kaneo-mention";+import { KaneoMention } from "@kaneo/editor";import type { MentionMember } from "@/components/task/extensions/mention-list";import { MentionSuggestion } from "@/components/task/extensions/mention-suggestion";import { SHIKI_CODEBLOCK_REFRESH_META } from "@/components/task/extensions/shiki-code-block";diff --git a/apps/web/src/components/editor/extensions.ts b/apps/web/src/components/editor/extensions.tsindex 23287bbcd..ca7343c6a 100644--- a/apps/web/src/components/editor/extensions.ts+++ b/apps/web/src/components/editor/extensions.ts@@ -1,18 +1,10 @@+import { createBaseExtensions } from "@kaneo/editor";import type { AnyExtension } from "@tiptap/core";-import Placeholder from "@tiptap/extension-placeholder";-import { Table } from "@tiptap/extension-table";-import TableCell from "@tiptap/extension-table-cell";-import TableHeader from "@tiptap/extension-table-header";-import TableRow from "@tiptap/extension-table-row";-import TaskList from "@tiptap/extension-task-list";-import { Markdown } from "@tiptap/markdown";-import StarterKit from "@tiptap/starter-kit";import type { Highlighter } from "shiki";import { AttachmentCard } from "@/components/task/extensions/attachment-card";import { EmbedBlock } from "@/components/task/extensions/embed-block";import { KaneoIssueLink } from "@/components/task/extensions/kaneo-issue-link";import { MermaidBlock } from "@/components/task/extensions/mermaid-block";-import { SafeHardBreak } from "@/components/task/extensions/safe-hard-break";import { ShikiCodeBlock } from "@/components/task/extensions/shiki-code-block";import { TaskItemWithCheckbox } from "@/components/task/extensions/task-item-with-checkbox";import { EditorKeymap } from "./editor-keymap";@@ -33,39 +25,28 @@ export function createEditorExtensions({extra?: AnyExtension[];mermaidErrorKey?: string;}) {- return [- StarterKit.configure({- codeBlock: { HTMLAttributes: { class: "kaneo-tiptap-codeblock" } },- trailingNode: false,- heading: { levels: [1, 2, 3] },- hardBreak: false,- }),- SafeHardBreak,- EditorKeymap,- Markdown.configure({ markedOptions: { breaks: true, gfm: true } }),- ShikiCodeBlock.configure({- highlighter,- resolveLanguage,- detectLanguage: detectCodeLanguage,- themeDark: "github-dark",- themeLight: "github-light",- }),- mermaidErrorKey- ? MermaidBlock.configure({ errorKey: mermaidErrorKey })- : MermaidBlock,- EmbedBlock,- AttachmentCard,- KaneoIssueLink,- ...extra,- TaskList,- image.configure({- HTMLAttributes: { class: "kaneo-editor-image", loading: "lazy" },- }),- TaskItemWithCheckbox.configure({ nested: true }),- Placeholder.configure({ placeholder }),- Table.configure({ resizable: true }),- TableRow,- TableHeader,- TableCell,- ];+ return createBaseExtensions({+ placeholder,+ keymap: [EditorKeymap],+ decorations: [+ ShikiCodeBlock.configure({+ highlighter,+ resolveLanguage,+ detectLanguage: detectCodeLanguage,+ themeDark: "github-dark",+ themeLight: "github-light",+ }),+ mermaidErrorKey+ ? MermaidBlock.configure({ errorKey: mermaidErrorKey })+ : MermaidBlock,+ ],+ extra,+ nodes: {+ embedBlock: EmbedBlock,+ attachmentCard: AttachmentCard,+ kaneoIssueLink: KaneoIssueLink,+ image,+ taskItem: TaskItemWithCheckbox,+ },+ });}diff --git a/apps/web/src/components/task/extensions/attachment-card.tsx b/apps/web/src/components/task/extensions/attachment-card.tsxindex c5861f6dd..bd95ef465 100644--- a/apps/web/src/components/task/extensions/attachment-card.tsx+++ b/apps/web/src/components/task/extensions/attachment-card.tsx@@ -1,8 +1,10 @@-import { mergeAttributes, Node } from "@tiptap/core";+import {+ AttachmentCard as AttachmentCardNode,+ isValidUrl,+} from "@kaneo/editor";import type { NodeViewProps } from "@tiptap/react";import { NodeViewWrapper, ReactNodeViewRenderer } from "@tiptap/react";import { FileText } from "lucide-react";-import { escapeHtml, isValidUrl } from "./url-safety";function formatBytes(size: number) {if (!Number.isFinite(size) || size <= 0) return "";@@ -44,66 +46,8 @@ function AttachmentCardView({ node }: NodeViewProps) {);}-export const AttachmentCard = Node.create({- name: "attachmentCard",- group: "inline",- inline: true,- atom: true,- selectable: false,-- addAttributes() {- return {- url: { default: "" },- filename: { default: "" },- mimeType: { default: "" },- size: { default: 0 },- };- },-- parseHTML() {- return [- { tag: "kaneo-attachment[url]" },- { tag: "span[data-type='attachment-card'][data-url]" },- ];- },-- renderHTML({ HTMLAttributes }) {- return [- "kaneo-attachment",- mergeAttributes(HTMLAttributes, {- "data-type": "attachment-card",- "data-url": HTMLAttributes.url,- "data-filename": HTMLAttributes.filename,- "data-mime-type": HTMLAttributes.mimeType,- "data-size": HTMLAttributes.size,- url: HTMLAttributes.url,- }),- ];- },-+export const AttachmentCard = AttachmentCardNode.extend({addNodeView() {return ReactNodeViewRenderer(AttachmentCardView);},-- renderMarkdown(- node: {- attrs?: {- url?: string;- filename?: string;- mimeType?: string;- size?: number;- };- },- _helpers: unknown,- _context: unknown,- ) {- const url = String(node.attrs?.url || "");- const filename = String(node.attrs?.filename || "");- const mimeType = String(node.attrs?.mimeType || "");- const size = Number(node.attrs?.size || 0);-- if (!url) return "";-- return `\n<kaneo-attachment url="${escapeHtml(url)}" filename="${escapeHtml(filename)}" mime-type="${escapeHtml(mimeType)}" size="${size}" />\n`;- },});diff --git a/apps/web/src/components/task/extensions/embed-block.ts b/apps/web/src/components/task/extensions/embed-block.tsindex 4f8d49248..7f73b019b 100644--- a/apps/web/src/components/task/extensions/embed-block.ts+++ b/apps/web/src/components/task/extensions/embed-block.ts@@ -1,141 +1,9 @@-import { mergeAttributes, Node } from "@tiptap/core";+import { EmbedBlock as EmbedBlockNode } from "@kaneo/editor";import { i18n } from "@/lib/i18n";-import { escapeHtml, isValidUrl } from "./url-safety";-type EmbedMode = "embed" | "link";--function getEmbedSource(url: string) {- try {- const parsed = new URL(url);- const host = parsed.hostname.replace(/^www\./, "");-- if (- host === "youtube.com" ||- host === "m.youtube.com" ||- host === "youtu.be"- ) {- const pathParts = parsed.pathname.split("/").filter(Boolean);- const videoId =- host === "youtu.be"- ? pathParts[0]- : parsed.searchParams.get("v") ||- (pathParts[0] === "shorts" ? pathParts[1] : null) ||- (pathParts[0] === "live" ? pathParts[1] : null);- if (videoId) {- return `https://www.youtube.com/embed/${videoId}`;- }- }- } catch {- return null;- }-- return null;-}--export const EmbedBlock = Node.create({- name: "embedBlock",- group: "block",- atom: true,- selectable: true,- draggable: false,-- addAttributes() {- return {- url: {- default: "",- },- mode: {- default: "embed",- },- };- },-- parseHTML() {- return [- {- tag: "kaneo-embed[url]",- },- {- tag: "div[data-type='kaneo-embed'][data-url]",- },- ];- },-- renderHTML({ HTMLAttributes }) {- const url = String(HTMLAttributes.url || "");- const mode = String(HTMLAttributes.mode || "embed") as EmbedMode;- const embedSource = mode === "embed" ? getEmbedSource(url) : null;- const attrs = mergeAttributes(HTMLAttributes, {- "data-type": "kaneo-embed",- "data-url": url,- "data-mode": mode,- contenteditable: "false",- });-- if (!isValidUrl(url)) {- return [- "div",- attrs,- ["span", { class: "kaneo-embed-invalid-link" }, url],- ];- }-- if (embedSource) {- return [- "div",- attrs,- [- "iframe",- {- src: embedSource,- loading: "lazy",- allow:- "accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share",- allowfullscreen: "true",- referrerpolicy: "strict-origin-when-cross-origin",- title: i18n.t("tasks:detail.editor.embed.embeddedContent"),- },- ],- ];- }-- if (mode === "embed") {- return [- "div",- attrs,- [- "div",- { class: "kaneo-embed-unsupported" },- i18n.t("tasks:detail.editor.embed.onlyYoutubeInline"),- ],- ];- }-- return [- "div",- attrs,- [- "a",- {- href: url,- target: "_blank",- rel: "noopener noreferrer nofollow",- },- url,- ],- ];- },-- renderMarkdown(- node: { attrs?: { url?: string; mode?: string } },- _helpers: unknown,- _context: unknown,- ) {- const url = String(node.attrs?.url || "");- const mode = node.attrs?.mode === "link" ? "link" : "embed";- if (!isValidUrl(url)) {- return `\n<span class="kaneo-embed-invalid-link">${escapeHtml(url)}</span>\n`;- }- return `\n<kaneo-embed url="${escapeHtml(url)}" mode="${mode}" />\n`;- },+export const EmbedBlock = EmbedBlockNode.configure({+ embeddedContentTitle: () =>+ i18n.t("tasks:detail.editor.embed.embeddedContent"),+ onlyYoutubeInlineLabel: () =>+ i18n.t("tasks:detail.editor.embed.onlyYoutubeInline"),});diff --git a/apps/web/src/components/task/extensions/kaneo-issue-link.tsx b/apps/web/src/components/task/extensions/kaneo-issue-link.tsxindex 7616daf1e..68b41b391 100644--- a/apps/web/src/components/task/extensions/kaneo-issue-link.tsx+++ b/apps/web/src/components/task/extensions/kaneo-issue-link.tsx@@ -1,5 +1,8 @@+import {+ isValidUrl,+ KaneoIssueLink as KaneoIssueLinkNode,+} from "@kaneo/editor";import { useQuery } from "@tanstack/react-query";-import { mergeAttributes, Node } from "@tiptap/core";import type { NodeViewProps } from "@tiptap/react";import { NodeViewWrapper, ReactNodeViewRenderer } from "@tiptap/react";import { useTranslation } from "react-i18next";@@ -10,7 +13,6 @@ import {} from "@/components/ui/preview-card";import getProject from "@/fetchers/project/get-project";import getTask from "@/fetchers/task/get-task";-import { escapeHtml, isValidUrl } from "./url-safety";function parseTaskRouteFromUrl(url: string) {try {@@ -120,56 +122,8 @@ function KaneoIssueLinkView({ node }: NodeViewProps) {);}-export const KaneoIssueLink = Node.create({- name: "kaneoIssueLink",- group: "inline",- inline: true,- atom: true,- selectable: false,-- addAttributes() {- return {- url: { default: "" },- issueKey: { default: "" },- taskId: { default: "" },- };- },-- parseHTML() {- return [- { tag: "kaneo-issue-link[url]" },- { tag: "span[data-type='kaneo-issue-link'][data-url]" },- ];- },-- renderHTML({ HTMLAttributes }) {- return [- "kaneo-issue-link",- mergeAttributes(HTMLAttributes, {- "data-type": "kaneo-issue-link",- "data-url": HTMLAttributes.url,- "data-issue-key": HTMLAttributes.issueKey,- "data-task-id": HTMLAttributes.taskId,- url: HTMLAttributes.url,- "issue-key": HTMLAttributes.issueKey,- "task-id": HTMLAttributes.taskId,- }),- ];- },-+export const KaneoIssueLink = KaneoIssueLinkNode.extend({addNodeView() {return ReactNodeViewRenderer(KaneoIssueLinkView);},-- renderMarkdown(- node: { attrs?: { url?: string; issueKey?: string; taskId?: string } },- _helpers: unknown,- _context: unknown,- ) {- const url = String(node.attrs?.url || "");- const issueKey = String(node.attrs?.issueKey || "");- const taskId = String(node.attrs?.taskId || "");- if (!url) return "";- return `\n<kaneo-issue-link url="${escapeHtml(url)}" issue-key="${escapeHtml(issueKey)}" task-id="${escapeHtml(taskId)}" />\n`;- },});diff --git a/apps/web/src/components/task/extensions/resizable-image.tsx b/apps/web/src/components/task/extensions/resizable-image.tsxindex 239389624..e417dfca7 100644--- a/apps/web/src/components/task/extensions/resizable-image.tsx+++ b/apps/web/src/components/task/extensions/resizable-image.tsx@@ -1,4 +1,4 @@-import Image from "@tiptap/extension-image";+import { KaneoImage, parseWidth } from "@kaneo/editor";import type { NodeViewProps } from "@tiptap/react";import {NodeViewWrapper,@@ -13,12 +13,6 @@ import {} from "react";import { useTranslation } from "react-i18next";import { cn } from "@/lib/cn";-import {- escapeHtml,- escapeMarkdownText,- escapeMarkdownTitle,- formatMarkdownUrl,-} from "./url-safety";const MIN_WIDTH = 80;const RESIZE_STEP = 16;@@ -29,21 +23,6 @@ const SIZE_PRESETS = [{ key: "large", label: "tasks:detail.editor.image.large", fraction: 1 },] as const;-function parseWidth(value: unknown) {- if (typeof value === "number") {- return Number.isSafeInteger(value) && value > 0 ? value : null;- }-- // `Number.parseInt` stops at the first non-digit and discards the rest, so it- // would read `50%` as 50 pixels. Match the whole value instead, so only a- // pixel count gets through and every other unit is rejected.- const match = /^(\d+)(?:px)?$/i.exec(String(value ?? "").trim());- if (!match) return null;-- const width = Number.parseInt(match[1], 10);- return Number.isSafeInteger(width) && width > 0 ? width : null;-}-function ResizableImageNodeView({editor,node,@@ -181,55 +160,8 @@ function ResizableImageNodeView({);}-export const ResizableImage = Image.extend({- addAttributes() {- return {- ...this.parent?.(),- width: {- default: null,- parseHTML: (element: HTMLElement) =>- // `parseWidth` rejects every unit but `px`, so both raw values can go- // straight in. Reading them independently also stops an unusable- // `width="50%"` from shadowing a usable inline `width: 320px`.- parseWidth(element.getAttribute("width")) ??- parseWidth(element.style.width),- renderHTML: (attributes: Record<string, unknown>) => {- const width = parseWidth(attributes.width);- return width ? { width } : {};- },- },- };- },-+export const ResizableImage = KaneoImage.extend({addNodeView() {return ReactNodeViewRenderer(ResizableImageNodeView);},-- renderMarkdown(- node: {- attrs?: { src?: string; alt?: string; title?: string; width?: number };- },- _helpers: unknown,- _context: unknown,- ) {- const src = String(node.attrs?.src || "");- const alt = String(node.attrs?.alt || "");- const title = String(node.attrs?.title || "");- const width = parseWidth(node.attrs?.width);-- if (!src) return "";-- // Standard markdown has nowhere to carry a width, so a resized image is- // written as HTML — which the markdown pipeline round-trips intact.- if (!width) {- const markdownTitle = title ? ` "${escapeMarkdownTitle(title)}"` : "";- return `}${markdownTitle})`;- }-- return `<img src="${escapeHtml(src)}" alt="${escapeHtml(alt)}"${- title ? ` title="${escapeHtml(title)}"` : ""- } width="${width}" />`;- },});diff --git a/apps/web/src/components/task/extensions/task-item-with-checkbox.tsx b/apps/web/src/components/task/extensions/task-item-with-checkbox.tsxindex 78f45d75f..4b9f36a1d 100644--- a/apps/web/src/components/task/extensions/task-item-with-checkbox.tsx+++ b/apps/web/src/components/task/extensions/task-item-with-checkbox.tsx@@ -1,4 +1,4 @@-import TaskItem from "@tiptap/extension-task-item";+import { KaneoTaskItem } from "@kaneo/editor";import type { NodeViewProps } from "@tiptap/react";import {NodeViewContent,@@ -39,7 +39,7 @@ function TaskItemNodeView({ editor, node, updateAttributes }: NodeViewProps) {);}-export const TaskItemWithCheckbox = TaskItem.extend({+export const TaskItemWithCheckbox = KaneoTaskItem.extend({addNodeView() {return ReactNodeViewRenderer(TaskItemNodeView);},diff --git a/packages/editor/package.json b/packages/editor/package.jsonnew file mode 100644index 000000000..80e946d70--- /dev/null+++ b/packages/editor/package.json@@ -0,0 +1,43 @@+{+ "name": "@kaneo/editor",+ "version": "0.0.0",+ "private": true,+ "type": "module",+ "main": "./dist/index.js",+ "types": "./dist/index.d.ts",+ "exports": {+ ".": {+ "types": "./dist/index.d.ts",+ "default": "./dist/index.js"+ }+ },+ "license": "MIT",+ "scripts": {+ "build": "vp run compile",+ "lint": "vp check .",+ "test": "vp run test:run",+ "test:watch": "vp test --config vitest.config.ts"+ },+ "dependencies": {+ "@tiptap/core": "^3.32.0",+ "@tiptap/extension-hard-break": "^3.32.0",+ "@tiptap/extension-image": "^3.32.0",+ "@tiptap/extension-placeholder": "^3.32.0",+ "@tiptap/extension-table": "^3.32.0",+ "@tiptap/extension-table-cell": "^3.32.0",+ "@tiptap/extension-table-header": "^3.32.0",+ "@tiptap/extension-table-row": "^3.32.0",+ "@tiptap/extension-task-item": "^3.32.0",+ "@tiptap/extension-task-list": "^3.32.0",+ "@tiptap/markdown": "^3.32.0",+ "@tiptap/pm": "^3.32.0",+ "@tiptap/starter-kit": "^3.32.0"+ },+ "devDependencies": {+ "@kaneo/typescript-config": "workspace:*",+ "jsdom": "^30.1.3",+ "typescript": "^7.0.2",+ "vite": "catalog:",+ "vite-plus": "catalog:"+ }+}diff --git a/packages/editor/src/attachment-card.ts b/packages/editor/src/attachment-card.tsnew file mode 100644index 000000000..6135cefb4--- /dev/null+++ b/packages/editor/src/attachment-card.ts@@ -0,0 +1,69 @@+import { mergeAttributes, Node } from "@tiptap/core";+import { escapeHtml } from "./url-safety";++export const AttachmentCard = Node.create({+ name: "attachmentCard",+ group: "inline",+ inline: true,+ atom: true,+ selectable: false,++ addAttributes() {+ return {+ url: { default: "" },+ filename: { default: "" },+ mimeType: {+ default: "",+ parseHTML: (element: HTMLElement) =>+ element.getAttribute("mime-type") ??+ element.getAttribute("data-mime-type") ??+ element.getAttribute("mimetype") ??+ "",+ },+ size: { default: 0 },+ };+ },++ parseHTML() {+ return [+ { tag: "kaneo-attachment[url]" },+ { tag: "span[data-type='attachment-card'][data-url]" },+ ];+ },++ renderHTML({ HTMLAttributes }) {+ return [+ "kaneo-attachment",+ mergeAttributes(HTMLAttributes, {+ "data-type": "attachment-card",+ "data-url": HTMLAttributes.url,+ "data-filename": HTMLAttributes.filename,+ "data-mime-type": HTMLAttributes.mimeType,+ "data-size": HTMLAttributes.size,+ url: HTMLAttributes.url,+ }),+ ];+ },++ renderMarkdown(+ node: {+ attrs?: {+ url?: string;+ filename?: string;+ mimeType?: string;+ size?: number;+ };+ },+ _helpers: unknown,+ _context: unknown,+ ) {+ const url = String(node.attrs?.url || "");+ const filename = String(node.attrs?.filename || "");+ const mimeType = String(node.attrs?.mimeType || "");+ const size = Number(node.attrs?.size || 0);++ if (!url) return "";++ return `\n<kaneo-attachment url="${escapeHtml(url)}" filename="${escapeHtml(filename)}" mime-type="${escapeHtml(mimeType)}" size="${size}" />\n`;+ },+});diff --git a/packages/editor/src/base-extensions.test.ts b/packages/editor/src/base-extensions.test.tsnew file mode 100644index 000000000..7ba045e1f--- /dev/null+++ b/packages/editor/src/base-extensions.test.ts@@ -0,0 +1,127 @@+import { Editor } from "@tiptap/core";+import { afterEach, describe, expect, it } from "vite-plus/test";+import { createBaseExtensions } from "./base-extensions";+import { KaneoMention } from "./kaneo-mention";++const MARKDOWN = [+ "# Release notes",+ "",+ 'Ping <kaneo-mention id="user-1" label="Ada"></kaneo-mention> about this.',+ "",+ "",+ '<kaneo-attachment url="https://kaneo.app/files/report.pdf" filename="report.pdf" mime-type="application/pdf" size="2048" />',+ "",+ "",+ "Related work:",+ "",+ "",+ '<kaneo-issue-link url="https://kaneo.app/dashboard/workspace/w1/project/p1/task/t1" issue-key="KAN-1" task-id="t1" />',+ "",+ "",+ "Demo:",+ "",+ "",+ '<kaneo-embed url="https://www.youtube.com/watch?v=abc123" mode="embed" />',+ "",+ "",+ '<img src="https://kaneo.app/diagram.png" alt="Diagram" width="320" />',+ "",+ "- [ ] Draft",+ "- [x] Review",+ "",+ "",+ "| Name | Status |",+ "| ----- | ------ |",+ "| Board | Done |",+ "",+].join("\n");++let editor: Editor | null = null;++function createEditor() {+ editor = new Editor({+ extensions: createBaseExtensions({+ placeholder: "Write something",+ extra: [KaneoMention],+ }),+ });+ return editor;+}++afterEach(() => {+ editor?.destroy();+ editor = null;+});++describe("createBaseExtensions", () => {+ it("round-trips Kaneo markdown without changes", () => {+ const instance = createEditor();+ instance.commands.setContent(MARKDOWN, { contentType: "markdown" });++ expect(+ instance+ .getJSON()+ .content?.map((node) => node.content?.[0]?.type ?? node.type),+ ).toEqual([+ "text",+ "text",+ "attachmentCard",+ "text",+ "kaneoIssueLink",+ "text",+ "embedBlock",+ "image",+ "taskItem",+ "tableRow",+ ]);+ expect(instance.getMarkdown()).toBe(MARKDOWN);+ });++ it("serializes custom node attributes into markdown", () => {+ const instance = createEditor();+ instance.commands.setContent({+ type: "doc",+ content: [+ {+ type: "paragraph",+ content: [+ {+ type: "attachmentCard",+ attrs: {+ url: "https://kaneo.app/files/report.pdf",+ filename: "report.pdf",+ mimeType: "application/pdf",+ size: 2048,+ },+ },+ ],+ },+ {+ type: "paragraph",+ content: [+ {+ type: "kaneoIssueLink",+ attrs: {+ url: "https://kaneo.app/task/t1",+ issueKey: "KAN-1",+ taskId: "t1",+ },+ },+ ],+ },+ ],+ });++ expect(instance.getMarkdown()).toBe(+ [+ "",+ '<kaneo-attachment url="https://kaneo.app/files/report.pdf" filename="report.pdf" mime-type="application/pdf" size="2048" />',+ "",+ "",+ "",+ '<kaneo-issue-link url="https://kaneo.app/task/t1" issue-key="KAN-1" task-id="t1" />',+ "",+ ].join("\n"),+ );+ });+});diff --git a/packages/editor/src/base-extensions.ts b/packages/editor/src/base-extensions.tsnew file mode 100644index 000000000..68910f8fb--- /dev/null+++ b/packages/editor/src/base-extensions.ts@@ -0,0 +1,71 @@+import type { AnyExtension } from "@tiptap/core";+import Placeholder from "@tiptap/extension-placeholder";+import { Table } from "@tiptap/extension-table";+import TableCell from "@tiptap/extension-table-cell";+import TableHeader from "@tiptap/extension-table-header";+import TableRow from "@tiptap/extension-table-row";+import TaskItem from "@tiptap/extension-task-item";+import TaskList from "@tiptap/extension-task-list";+import { Markdown } from "@tiptap/markdown";+import StarterKit from "@tiptap/starter-kit";+import { AttachmentCard } from "./attachment-card";+import { EmbedBlock } from "./embed-block";+import { KaneoImage } from "./kaneo-image";+import { KaneoIssueLink } from "./kaneo-issue-link";+import { SafeHardBreak } from "./safe-hard-break";++export type BaseExtensionNodes = {+ attachmentCard?: AnyExtension;+ kaneoIssueLink?: AnyExtension;+ image?: AnyExtension;+ taskItem?: AnyExtension;+ embedBlock?: AnyExtension;+};++export type BaseExtensionsOptions = {+ placeholder: string;+ keymap?: AnyExtension[];+ decorations?: AnyExtension[];+ extra?: AnyExtension[];+ nodes?: BaseExtensionNodes;+ tableResizable?: boolean;+};++export function createBaseExtensions({+ placeholder,+ keymap = [],+ decorations = [],+ extra = [],+ nodes = {},+ tableResizable = true,+}: BaseExtensionsOptions): AnyExtension[] {+ const image = nodes.image ?? KaneoImage;+ const taskItem = nodes.taskItem ?? TaskItem;++ return [+ StarterKit.configure({+ codeBlock: { HTMLAttributes: { class: "kaneo-tiptap-codeblock" } },+ trailingNode: false,+ heading: { levels: [1, 2, 3] },+ hardBreak: false,+ }),+ SafeHardBreak,+ ...keymap,+ Markdown.configure({ markedOptions: { breaks: true, gfm: true } }),+ ...decorations,+ nodes.embedBlock ?? EmbedBlock,+ nodes.attachmentCard ?? AttachmentCard,+ nodes.kaneoIssueLink ?? KaneoIssueLink,+ ...extra,+ TaskList,+ image.configure({+ HTMLAttributes: { class: "kaneo-editor-image", loading: "lazy" },+ }),+ taskItem.configure({ nested: true }),+ Placeholder.configure({ placeholder }),+ Table.configure({ resizable: tableResizable }),+ TableRow,+ TableHeader,+ TableCell,+ ];+}diff --git a/packages/editor/src/embed-block.ts b/packages/editor/src/embed-block.tsnew file mode 100644index 000000000..985c50f10--- /dev/null+++ b/packages/editor/src/embed-block.ts@@ -0,0 +1,126 @@+import { mergeAttributes, Node } from "@tiptap/core";+import { getEmbedSource } from "./embed-source";+import { escapeHtml, isValidUrl } from "./url-safety";++type EmbedMode = "embed" | "link";++export type EmbedBlockOptions = {+ embeddedContentTitle: () => string;+ onlyYoutubeInlineLabel: () => string;+};++export const EmbedBlock = Node.create<EmbedBlockOptions>({+ name: "embedBlock",+ group: "block",+ atom: true,+ selectable: true,+ draggable: false,++ addOptions() {+ return {+ embeddedContentTitle: () => "Embedded content",+ onlyYoutubeInlineLabel: () =>+ "Only YouTube URLs can be embedded. Use link mode instead.",+ };+ },++ addAttributes() {+ return {+ url: {+ default: "",+ },+ mode: {+ default: "embed",+ },+ };+ },++ parseHTML() {+ return [+ {+ tag: "kaneo-embed[url]",+ },+ {+ tag: "div[data-type='kaneo-embed'][data-url]",+ },+ ];+ },++ renderHTML({ HTMLAttributes }) {+ const url = String(HTMLAttributes.url || "");+ const mode = String(HTMLAttributes.mode || "embed") as EmbedMode;+ const embedSource = mode === "embed" ? getEmbedSource(url) : null;+ const attrs = mergeAttributes(HTMLAttributes, {+ "data-type": "kaneo-embed",+ "data-url": url,+ "data-mode": mode,+ contenteditable: "false",+ });++ if (!isValidUrl(url)) {+ return [+ "div",+ attrs,+ ["span", { class: "kaneo-embed-invalid-link" }, url],+ ];+ }++ if (embedSource) {+ return [+ "div",+ attrs,+ [+ "iframe",+ {+ src: embedSource,+ loading: "lazy",+ allow:+ "accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share",+ allowfullscreen: "true",+ referrerpolicy: "strict-origin-when-cross-origin",+ title: this.options.embeddedContentTitle(),+ },+ ],+ ];+ }++ if (mode === "embed") {+ return [+ "div",+ attrs,+ [+ "div",+ { class: "kaneo-embed-unsupported" },+ this.options.onlyYoutubeInlineLabel(),+ ],+ ];+ }++ return [+ "div",+ attrs,+ [+ "a",+ {+ href: url,+ target: "_blank",+ rel: "noopener noreferrer nofollow",+ },+ url,+ ],+ ];+ },++ renderMarkdown(+ node: { attrs?: { url?: string; mode?: string } },+ _helpers: unknown,+ _context: unknown,+ ) {+ const url = String(node.attrs?.url || "");+ const mode = node.attrs?.mode === "link" ? "link" : "embed";+ if (!isValidUrl(url)) {+ return `\n<span class="kaneo-embed-invalid-link">${escapeHtml(url)}</span>\n`;+ }+ return `\n<kaneo-embed url="${escapeHtml(url)}" mode="${mode}" />\n`;+ },+});diff --git a/packages/editor/src/embed-source.ts b/packages/editor/src/embed-source.tsnew file mode 100644index 000000000..867cc0984--- /dev/null+++ b/packages/editor/src/embed-source.ts@@ -0,0 +1,27 @@+export function getEmbedSource(url: string) {+ try {+ const parsed = new URL(url);+ const host = parsed.hostname.replace(/^www\./, "");++ if (+ host === "youtube.com" ||+ host === "m.youtube.com" ||+ host === "youtu.be"+ ) {+ const pathParts = parsed.pathname.split("/").filter(Boolean);+ const videoId =+ host === "youtu.be"+ ? pathParts[0]+ : parsed.searchParams.get("v") ||+ (pathParts[0] === "shorts" ? pathParts[1] : null) ||+ (pathParts[0] === "live" ? pathParts[1] : null);+ if (videoId) {+ return `https://www.youtube.com/embed/${videoId}`;+ }+ }+ } catch {+ return null;+ }++ return null;+}diff --git a/packages/editor/src/index.ts b/packages/editor/src/index.tsnew file mode 100644index 000000000..f8d3ac65a--- /dev/null+++ b/packages/editor/src/index.ts@@ -0,0 +1,27 @@+/// <reference types="@tiptap/extension-hard-break" preserve="true" />+/// <reference types="@tiptap/extension-image" preserve="true" />+/// <reference types="@tiptap/extension-table" preserve="true" />+/// <reference types="@tiptap/extension-task-item" preserve="true" />+/// <reference types="@tiptap/markdown" preserve="true" />+/// <reference types="@tiptap/starter-kit" preserve="true" />+export { default as KaneoTaskItem } from "@tiptap/extension-task-item";+export { AttachmentCard } from "./attachment-card";+export {+ type BaseExtensionNodes,+ type BaseExtensionsOptions,+ createBaseExtensions,+} from "./base-extensions";+export { EmbedBlock, type EmbedBlockOptions } from "./embed-block";+export { getEmbedSource } from "./embed-source";+export { KaneoImage } from "./kaneo-image";+export { KaneoIssueLink } from "./kaneo-issue-link";+export { KaneoMention } from "./kaneo-mention";+export { parseWidth } from "./parse-width";+export { SafeHardBreak } from "./safe-hard-break";+export {+ escapeHtml,+ escapeMarkdownText,+ escapeMarkdownTitle,+ formatMarkdownUrl,+ isValidUrl,+} from "./url-safety";diff --git a/apps/web/src/components/task/extensions/resizable-image.test.ts b/packages/editor/src/kaneo-image.test.tssimilarity index 98%rename from apps/web/src/components/task/extensions/resizable-image.test.tsrename to packages/editor/src/kaneo-image.test.tsindex de820e4fb..3ec96d2bd 100644--- a/apps/web/src/components/task/extensions/resizable-image.test.ts+++ b/packages/editor/src/kaneo-image.test.ts@@ -2,7 +2,7 @@ import { Editor } from "@tiptap/core";import { Markdown } from "@tiptap/markdown";import StarterKit from "@tiptap/starter-kit";import { afterEach, describe, expect, it } from "vite-plus/test";-import { ResizableImage } from "./resizable-image";+import { KaneoImage } from "./kaneo-image";const SRC = "https://kaneo.app/diagram.png";@@ -13,7 +13,7 @@ function createEditor() {extensions: [StarterKit,Markdown.configure({ markedOptions: { breaks: true, gfm: true } }),- ResizableImage,+ KaneoImage,],content: "",});@@ -33,7 +33,7 @@ afterEach(() => {editor = null;});-describe("ResizableImage", () => {+describe("KaneoImage", () => {it("keeps an unresized image as plain markdown", () => {const instance = createEditor();setImage(instance, { alt: "Diagram" });diff --git a/packages/editor/src/kaneo-image.ts b/packages/editor/src/kaneo-image.tsnew file mode 100644index 000000000..046b753d5--- /dev/null+++ b/packages/editor/src/kaneo-image.ts@@ -0,0 +1,57 @@+import Image from "@tiptap/extension-image";+import { parseWidth } from "./parse-width";+import {+ escapeHtml,+ escapeMarkdownText,+ escapeMarkdownTitle,+ formatMarkdownUrl,+} from "./url-safety";++export const KaneoImage = Image.extend({+ addAttributes() {+ return {+ ...this.parent?.(),+ width: {+ default: null,+ parseHTML: (element: HTMLElement) =>+ // `parseWidth` rejects every unit but `px`, so both raw values can go+ // straight in. Reading them independently also stops an unusable+ // `width="50%"` from shadowing a usable inline `width: 320px`.+ parseWidth(element.getAttribute("width")) ??+ parseWidth(element.style.width),+ renderHTML: (attributes: Record<string, unknown>) => {+ const width = parseWidth(attributes.width);+ return width ? { width } : {};+ },+ },+ };+ },++ renderMarkdown(+ node: {+ attrs?: { src?: string; alt?: string; title?: string; width?: number };+ },+ _helpers: unknown,+ _context: unknown,+ ) {+ const src = String(node.attrs?.src || "");+ const alt = String(node.attrs?.alt || "");+ const title = String(node.attrs?.title || "");+ const width = parseWidth(node.attrs?.width);++ if (!src) return "";++ // Standard markdown has nowhere to carry a width, so a resized image is+ // written as HTML — which the markdown pipeline round-trips intact.+ if (!width) {+ const markdownTitle = title ? ` "${escapeMarkdownTitle(title)}"` : "";+ return `}${markdownTitle})`;+ }++ return `<img src="${escapeHtml(src)}" alt="${escapeHtml(alt)}"${+ title ? ` title="${escapeHtml(title)}"` : ""+ } width="${width}" />`;+ },+});diff --git a/packages/editor/src/kaneo-issue-link.ts b/packages/editor/src/kaneo-issue-link.tsnew file mode 100644index 000000000..ef13e6150--- /dev/null+++ b/packages/editor/src/kaneo-issue-link.ts@@ -0,0 +1,66 @@+import { mergeAttributes, Node } from "@tiptap/core";+import { escapeHtml } from "./url-safety";++export const KaneoIssueLink = Node.create({+ name: "kaneoIssueLink",+ group: "inline",+ inline: true,+ atom: true,+ selectable: false,++ addAttributes() {+ return {+ url: { default: "" },+ issueKey: {+ default: "",+ parseHTML: (element: HTMLElement) =>+ element.getAttribute("issue-key") ??+ element.getAttribute("data-issue-key") ??+ element.getAttribute("issuekey") ??+ "",+ },+ taskId: {+ default: "",+ parseHTML: (element: HTMLElement) =>+ element.getAttribute("task-id") ??+ element.getAttribute("data-task-id") ??+ element.getAttribute("taskid") ??+ "",+ },+ };+ },++ parseHTML() {+ return [+ { tag: "kaneo-issue-link[url]" },+ { tag: "span[data-type='kaneo-issue-link'][data-url]" },+ ];+ },++ renderHTML({ HTMLAttributes }) {+ return [+ "kaneo-issue-link",+ mergeAttributes(HTMLAttributes, {+ "data-type": "kaneo-issue-link",+ "data-url": HTMLAttributes.url,+ "data-issue-key": HTMLAttributes.issueKey,+ "data-task-id": HTMLAttributes.taskId,+ url: HTMLAttributes.url,+ "issue-key": HTMLAttributes.issueKey,+ "task-id": HTMLAttributes.taskId,+ }),+ ];+ },++ renderMarkdown(+ node: { attrs?: { url?: string; issueKey?: string; taskId?: string } },+ _helpers: unknown,+ _context: unknown,+ ) {+ const url = String(node.attrs?.url || "");+ const issueKey = String(node.attrs?.issueKey || "");+ const taskId = String(node.attrs?.taskId || "");+ if (!url) return "";+ return `\n<kaneo-issue-link url="${escapeHtml(url)}" issue-key="${escapeHtml(issueKey)}" task-id="${escapeHtml(taskId)}" />\n`;+ },+});diff --git a/apps/web/src/components/task/extensions/kaneo-mention.tsx b/packages/editor/src/kaneo-mention.tssimilarity index 100%rename from apps/web/src/components/task/extensions/kaneo-mention.tsxrename to packages/editor/src/kaneo-mention.tsdiff --git a/packages/editor/src/parse-width.ts b/packages/editor/src/parse-width.tsnew file mode 100644index 000000000..b95503fb5--- /dev/null+++ b/packages/editor/src/parse-width.ts@@ -0,0 +1,14 @@+export function parseWidth(value: unknown) {+ if (typeof value === "number") {+ return Number.isSafeInteger(value) && value > 0 ? value : null;+ }++ // `Number.parseInt` stops at the first non-digit and discards the rest, so it+ // would read `50%` as 50 pixels. Match the whole value instead, so only a+ // pixel count gets through and every other unit is rejected.+ const match = /^(\d+)(?:px)?$/i.exec(String(value ?? "").trim());+ if (!match) return null;++ const width = Number.parseInt(match[1], 10);+ return Number.isSafeInteger(width) && width > 0 ? width : null;+}diff --git a/apps/web/src/components/task/extensions/safe-hard-break.test.ts b/packages/editor/src/safe-hard-break.test.tssimilarity index 100%rename from apps/web/src/components/task/extensions/safe-hard-break.test.tsrename to packages/editor/src/safe-hard-break.test.tsdiff --git a/apps/web/src/components/task/extensions/safe-hard-break.ts b/packages/editor/src/safe-hard-break.tssimilarity index 100%rename from apps/web/src/components/task/extensions/safe-hard-break.tsrename to packages/editor/src/safe-hard-break.tsdiff --git a/apps/web/src/components/task/extensions/url-safety.ts b/packages/editor/src/url-safety.tssimilarity index 100%rename from apps/web/src/components/task/extensions/url-safety.tsrename to packages/editor/src/url-safety.tsdiff --git a/packages/editor/tsconfig.json b/packages/editor/tsconfig.jsonnew file mode 100644index 000000000..4053b0248--- /dev/null+++ b/packages/editor/tsconfig.json@@ -0,0 +1,23 @@+{+ "compilerOptions": {+ "outDir": "./dist",+ "rootDir": "./src",+ "module": "ESNext",+ "target": "ESNext",+ "moduleResolution": "bundler",+ "declaration": true,+ "sourceMap": true,+ "strict": true,+ "esModuleInterop": true,+ "skipLibCheck": true,+ "forceConsistentCasingInFileNames": true+ },+ "include": [+ "src/**/*"+ ],+ "exclude": [+ "node_modules",+ "dist",+ "src/**/*.test.ts"+ ]+}diff --git a/packages/editor/vite.config.ts b/packages/editor/vite.config.tsnew file mode 100644index 000000000..9e4e8c0da--- /dev/null+++ b/packages/editor/vite.config.ts@@ -0,0 +1,33 @@+import { defineConfig } from "vite-plus";++export default defineConfig({+ run: {+ tasks: {+ compile: {+ command: "tsc",+ dependsOn: [+ { task: "build", from: ["dependencies", "devDependencies"] },+ ],+ cache: {+ input: [+ { auto: true },+ "src/**",+ "tsconfig.json",+ ".env*",+ { pattern: ".env*", base: "workspace" },+ "package.json",+ { pattern: "pnpm-lock.yaml", base: "workspace" },+ ],+ output: ["dist/**"],+ },+ },+ "test:run": {+ command: "vp test run --config vitest.config.ts",+ dependsOn: [+ { task: "build", from: ["dependencies", "devDependencies"] },+ ],+ cache: false,+ },+ },+ },+});diff --git a/packages/editor/vitest.config.ts b/packages/editor/vitest.config.tsnew file mode 100644index 000000000..f15cf618f--- /dev/null+++ b/packages/editor/vitest.config.ts@@ -0,0 +1,8 @@+import { defineConfig } from "vite-plus";++export default defineConfig({+ test: {+ environment: "jsdom",+ include: ["src/**/*.test.ts"],+ },+});diff --git a/scripts/ui-review-bot/runner.mjs b/scripts/ui-review-bot/runner.mjsindex ab2803051..87dc36270 100644--- a/scripts/ui-review-bot/runner.mjs+++ b/scripts/ui-review-bot/runner.mjs@@ -137,9 +137,13 @@ export async function prepare(pr, log, signal) {);await writeFile(path.join(dir, ".ui-review-deps-ready"), sha);}- if (!(await exists(path.join(dir, "packages/permissions/dist/index.js")))) {- log("prepare", `Compiling the shared permissions package for ${side}`);- await command("pnpm", ["--filter", "@kaneo/permissions", "exec", "tsc"], {+ for (const name of ["permissions", "editor"]) {+ const packageDir = path.join(dir, "packages", name);+ // Base snapshots can predate a shared package.+ if (!(await exists(path.join(packageDir, "package.json")))) continue;+ if (await exists(path.join(packageDir, "dist/index.js"))) continue;+ log("prepare", `Compiling the shared ${name} package for ${side}`);+ await command("pnpm", ["--filter", `@kaneo/${name}`, "exec", "tsc"], {cwd: dir,signal,env: {