@medway-ui/notes-core 0.1.0

package/dist/schema/index.js

@@ -0,0 +1,18 @@
+/**
+ * `@medway-ui/notes-core/schema` — the Tiptap half, behind its own subpath so
+ * that importing the document model never pulls Tiptap in.
+ *
+ * `Editor`, `generateHTML` and `generateJSON` are re-exported to guarantee a
+ * single ProseMirror copy, and must always be passed the exact array
+ * `buildExtensions()` returns.
+ */
+export { Editor, generateHTML, generateJSON } from '@tiptap/core';
+export { buildExtensions } from './extensions.js';
+// Re-exported so hosts can build custom extension lists, and — less obviously
+// — so `./image`'s `declare module '@tiptap/core'` augmentation (the
+// `setImage` command) ships: `buildExtensions`'s signature never mentions
+// `Image`, so declaration emission would otherwise drop the import.
+export { Image } from './image.js';
+export { createSlashCommand } from './slashCommand.js';
+export { MARK_TYPES, NODE_TYPES, assertSchemaContract, } from './contract.js';
+//# sourceMappingURL=index.js.map

package/dist/schema/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/schema/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAIlE,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD,8EAA8E;AAC9E,qEAAqE;AACrE,0EAA0E;AAC1E,oEAAoE;AACpE,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAGnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAEvD,OAAO,EACL,UAAU,EACV,UAAU,EACV,oBAAoB,GACrB,MAAM,eAAe,CAAC"}

package/dist/schema/slashCommand.d.ts

@@ -0,0 +1,19 @@
+import { Extension, type Editor } from '@tiptap/core';
+import type { SlashCommandId, SlashMenuState } from '../editor/vocabulary.js';
+export type SlashCommandController = {
+    /** Add this to the extension list — see `buildExtensions`. */
+    extension: Extension;
+    /** Runs the command the host picked, if the menu is still open. */
+    run: (commandId: SlashCommandId) => boolean;
+    dismiss: (editor: Editor) => void;
+    /** Re-publishes the caret position, e.g. after the document scrolls. */
+    refreshCaret: () => void;
+};
+/**
+ * The `/` menu's detection half: owns only *when* `/` is active, *what* was
+ * typed, *where* the caret is, and the range to replace. The host draws the
+ * menu and answers with `run`, which removes the typed `/query` in the same
+ * transaction as the command it applies.
+ */
+export declare const createSlashCommand: (onChange: (state: SlashMenuState) => void) => SlashCommandController;
+//# sourceMappingURL=slashCommand.d.ts.map

package/dist/schema/slashCommand.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"slashCommand.d.ts","sourceRoot":"","sources":["../../src/schema/slashCommand.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,MAAM,EAAc,MAAM,cAAc,CAAC;AAOlE,OAAO,KAAK,EAEV,cAAc,EACd,cAAc,EACf,MAAM,yBAAyB,CAAC;AA2EjC,MAAM,MAAM,sBAAsB,GAAG;IACnC,8DAA8D;IAC9D,SAAS,EAAE,SAAS,CAAC;IACrB,mEAAmE;IACnE,GAAG,EAAE,CAAC,SAAS,EAAE,cAAc,KAAK,OAAO,CAAC;IAC5C,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,wEAAwE;IACxE,YAAY,EAAE,MAAM,IAAI,CAAC;CAC1B,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAC7B,UAAU,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,KACxC,sBA4EF,CAAC"}

package/dist/schema/slashCommand.js

@@ -0,0 +1,146 @@
+import { Extension } from '@tiptap/core';
+import { PluginKey } from '@tiptap/pm/state';
+import Suggestion, { exitSuggestion, } from '@tiptap/suggestion';
+import { filterSlashCommands } from '../editor/slashCommands.js';
+const SlashPluginKey = new PluginKey('medwaySlashCommand');
+const EMPTY = {
+    active: false,
+    query: '',
+    commandIds: [],
+    caret: null,
+};
+const toCaretRect = (props) => {
+    const rect = props.clientRect?.() ?? props.decorationNode?.getBoundingClientRect();
+    if (!rect)
+        return null;
+    return { x: rect.left, y: rect.top, width: rect.width, height: rect.height };
+};
+const applyCommand = (editor, range, id) => {
+    // Deleting the typed range and applying the block happen in one chain so a
+    // single undo takes the student back to the text they typed.
+    const chain = editor.chain().focus().deleteRange(range);
+    switch (id) {
+        case 'paragraph':
+            chain.setParagraph().run();
+            return;
+        case 'heading1':
+            chain.setNode('heading', { level: 1 }).run();
+            return;
+        case 'heading2':
+            chain.setNode('heading', { level: 2 }).run();
+            return;
+        case 'heading3':
+            chain.setNode('heading', { level: 3 }).run();
+            return;
+        case 'bulletList':
+            chain.toggleBulletList().run();
+            return;
+        case 'orderedList':
+            chain.toggleOrderedList().run();
+            return;
+        case 'taskList':
+            chain.toggleTaskList().run();
+            return;
+        case 'blockquote':
+            chain.setBlockquote().run();
+            return;
+        case 'codeBlock':
+            chain.setCodeBlock().run();
+            return;
+        case 'horizontalRule':
+            chain.setHorizontalRule().run();
+            return;
+        case 'image':
+            // Only clears the typed `/query`: picking and uploading a file is host
+            // UI (`NoteEditor`'s `onImageUpload`), which inserts the node itself.
+            chain.run();
+            return;
+        default: {
+            // Exhaustiveness check: a new `SlashCommandId` without a case above stops
+            // this file compiling. Still a runtime no-op rather than a throw — `id`
+            // crosses the WebView bridge, so an out-of-contract value should degrade
+            // gracefully instead of crashing the editor.
+            const _exhaustive = id;
+            void _exhaustive;
+            chain.run();
+        }
+    }
+};
+/**
+ * The `/` menu's detection half: owns only *when* `/` is active, *what* was
+ * typed, *where* the caret is, and the range to replace. The host draws the
+ * menu and answers with `run`, which removes the typed `/query` in the same
+ * transaction as the command it applies.
+ */
+export const createSlashCommand = (onChange) => {
+    let active = null;
+    const publish = (props) => {
+        if (!props) {
+            onChange(EMPTY);
+            return;
+        }
+        onChange({
+            active: true,
+            query: props.query,
+            commandIds: props.items,
+            caret: toCaretRect(props),
+        });
+    };
+    const extension = Extension.create({
+        name: 'medwaySlashCommand',
+        addProseMirrorPlugins() {
+            return [
+                Suggestion({
+                    editor: this.editor,
+                    pluginKey: SlashPluginKey,
+                    char: '/',
+                    decorationClass: 'medway-slash',
+                    // A `/` inside a code block is code, not a command.
+                    allow: ({ state, range }) => state.doc.resolve(range.from).parent.type.name !== 'codeBlock',
+                    items: ({ query }) => filterSlashCommands(query),
+                    command: ({ editor, range, props }) => applyCommand(editor, range, props),
+                    render: () => ({
+                        onStart: (props) => {
+                            active = props;
+                            publish(props);
+                        },
+                        onUpdate: (props) => {
+                            active = props;
+                            publish(props);
+                        },
+                        onExit: () => {
+                            active = null;
+                            publish(null);
+                        },
+                        onKeyDown: ({ event }) => {
+                            if (event.key !== 'Escape')
+                                return false;
+                            active = null;
+                            publish(null);
+                            return true;
+                        },
+                    }),
+                }),
+            ];
+        },
+    });
+    return {
+        extension,
+        run: (commandId) => {
+            if (!active || !active.items.includes(commandId))
+                return false;
+            active.command(commandId);
+            return true;
+        },
+        dismiss: (editor) => {
+            if (!active)
+                return;
+            exitSuggestion(editor.view, SlashPluginKey);
+        },
+        refreshCaret: () => {
+            if (active)
+                publish(active);
+        },
+    };
+};
+//# sourceMappingURL=slashCommand.js.map

package/dist/schema/slashCommand.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"slashCommand.js","sourceRoot":"","sources":["../../src/schema/slashCommand.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAA2B,MAAM,cAAc,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,UAAU,EAAE,EACjB,cAAc,GAEf,MAAM,oBAAoB,CAAC;AAO5B,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAEjE,MAAM,cAAc,GAAG,IAAI,SAAS,CAAC,oBAAoB,CAAC,CAAC;AAI3D,MAAM,KAAK,GAAmB;IAC5B,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,EAAE;IACT,UAAU,EAAE,EAAE;IACd,KAAK,EAAE,IAAI;CACZ,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,KAAiB,EAA0B,EAAE;IAChE,MAAM,IAAI,GACR,KAAK,CAAC,UAAU,EAAE,EAAE,IAAI,KAAK,CAAC,cAAc,EAAE,qBAAqB,EAAE,CAAC;IACxE,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAC;IAEvB,OAAO,EAAE,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;AAC/E,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,MAAc,EAAE,KAAY,EAAE,EAAkB,EAAE,EAAE;IACxE,2EAA2E;IAC3E,6DAA6D;IAC7D,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAExD,QAAQ,EAAE,EAAE,CAAC;QACX,KAAK,WAAW;YACd,KAAK,CAAC,YAAY,EAAE,CAAC,GAAG,EAAE,CAAC;YAC3B,OAAO;QACT,KAAK,UAAU;YACb,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;YAC7C,OAAO;QACT,KAAK,UAAU;YACb,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;YAC7C,OAAO;QACT,KAAK,UAAU;YACb,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;YAC7C,OAAO;QACT,KAAK,YAAY;YACf,KAAK,CAAC,gBAAgB,EAAE,CAAC,GAAG,EAAE,CAAC;YAC/B,OAAO;QACT,KAAK,aAAa;YAChB,KAAK,CAAC,iBAAiB,EAAE,CAAC,GAAG,EAAE,CAAC;YAChC,OAAO;QACT,KAAK,UAAU;YACb,KAAK,CAAC,cAAc,EAAE,CAAC,GAAG,EAAE,CAAC;YAC7B,OAAO;QACT,KAAK,YAAY;YACf,KAAK,CAAC,aAAa,EAAE,CAAC,GAAG,EAAE,CAAC;YAC5B,OAAO;QACT,KAAK,WAAW;YACd,KAAK,CAAC,YAAY,EAAE,CAAC,GAAG,EAAE,CAAC;YAC3B,OAAO;QACT,KAAK,gBAAgB;YACnB,KAAK,CAAC,iBAAiB,EAAE,CAAC,GAAG,EAAE,CAAC;YAChC,OAAO;QACT,KAAK,OAAO;YACV,uEAAuE;YACvE,sEAAsE;YACtE,KAAK,CAAC,GAAG,EAAE,CAAC;YACZ,OAAO;QACT,OAAO,CAAC,CAAC,CAAC;YACR,0EAA0E;YAC1E,wEAAwE;YACxE,yEAAyE;YACzE,6CAA6C;YAC7C,MAAM,WAAW,GAAU,EAAE,CAAC;YAC9B,KAAK,WAAW,CAAC;YACjB,KAAK,CAAC,GAAG,EAAE,CAAC;QACd,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAYF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,QAAyC,EACjB,EAAE;IAC1B,IAAI,MAAM,GAAsB,IAAI,CAAC;IAErC,MAAM,OAAO,GAAG,CAAC,KAAwB,EAAE,EAAE;QAC3C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChB,OAAO;QACT,CAAC;QAED,QAAQ,CAAC;YACP,MAAM,EAAE,IAAI;YACZ,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,UAAU,EAAE,KAAK,CAAC,KAAK;YACvB,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC;SAC1B,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;QACjC,IAAI,EAAE,oBAAoB;QAE1B,qBAAqB;YACnB,OAAO;gBACL,UAAU,CAAiC;oBACzC,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,SAAS,EAAE,cAAc;oBACzB,IAAI,EAAE,GAAG;oBACT,eAAe,EAAE,cAAc;oBAC/B,oDAAoD;oBACpD,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,CAC1B,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,WAAW;oBAChE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC;oBAChD,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,CACpC,YAAY,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC;oBACpC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;wBACb,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;4BACjB,MAAM,GAAG,KAAK,CAAC;4BACf,OAAO,CAAC,KAAK,CAAC,CAAC;wBACjB,CAAC;wBACD,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;4BAClB,MAAM,GAAG,KAAK,CAAC;4BACf,OAAO,CAAC,KAAK,CAAC,CAAC;wBACjB,CAAC;wBACD,MAAM,EAAE,GAAG,EAAE;4BACX,MAAM,GAAG,IAAI,CAAC;4BACd,OAAO,CAAC,IAAI,CAAC,CAAC;wBAChB,CAAC;wBACD,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;4BACvB,IAAI,KAAK,CAAC,GAAG,KAAK,QAAQ;gCAAE,OAAO,KAAK,CAAC;4BAEzC,MAAM,GAAG,IAAI,CAAC;4BACd,OAAO,CAAC,IAAI,CAAC,CAAC;4BACd,OAAO,IAAI,CAAC;wBACd,CAAC;qBACF,CAAC;iBACH,CAAC;aACH,CAAC;QACJ,CAAC;KACF,CAAC,CAAC;IAEH,OAAO;QACL,SAAS;QACT,GAAG,EAAE,CAAC,SAAS,EAAE,EAAE;YACjB,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC;gBAAE,OAAO,KAAK,CAAC;YAE/D,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC1B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE;YAClB,IAAI,CAAC,MAAM;gBAAE,OAAO;YAEpB,cAAc,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAC9C,CAAC;QACD,YAAY,EAAE,GAAG,EAAE;YACjB,IAAI,MAAM;gBAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC9B,CAAC;KACF,CAAC;AACJ,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,134 @@
+{
+  "name": "@medway-ui/notes-core",
+  "version": "0.1.0",
+  "private": false,
+  "description": "Modelo de documento, schema Tiptap e vocabulário do editor de anotações — compartilhado entre o app mobile e a web.",
+  "license": "MIT",
+  "sideEffects": false,
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./schema": {
+      "types": "./dist/schema/index.d.ts",
+      "default": "./dist/schema/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "@tiptap/core": "^3.6.5",
+    "@tiptap/extension-blockquote": "^3.6.5",
+    "@tiptap/extension-bold": "^3.6.5",
+    "@tiptap/extension-code": "^3.6.5",
+    "@tiptap/extension-code-block": "^3.6.5",
+    "@tiptap/extension-document": "^3.6.5",
+    "@tiptap/extension-hard-break": "^3.6.5",
+    "@tiptap/extension-heading": "^3.6.5",
+    "@tiptap/extension-horizontal-rule": "^3.6.5",
+    "@tiptap/extension-italic": "^3.6.5",
+    "@tiptap/extension-link": "^3.6.5",
+    "@tiptap/extension-list": "^3.6.5",
+    "@tiptap/extension-paragraph": "^3.6.5",
+    "@tiptap/extension-strike": "^3.6.5",
+    "@tiptap/extension-text": "^3.6.5",
+    "@tiptap/extension-underline": "^3.6.5",
+    "@tiptap/extensions": "^3.6.5",
+    "@tiptap/pm": "^3.6.5",
+    "@tiptap/suggestion": "^3.6.5"
+  },
+  "peerDependenciesMeta": {
+    "@tiptap/core": {
+      "optional": true
+    },
+    "@tiptap/extension-blockquote": {
+      "optional": true
+    },
+    "@tiptap/extension-bold": {
+      "optional": true
+    },
+    "@tiptap/extension-code": {
+      "optional": true
+    },
+    "@tiptap/extension-code-block": {
+      "optional": true
+    },
+    "@tiptap/extension-document": {
+      "optional": true
+    },
+    "@tiptap/extension-hard-break": {
+      "optional": true
+    },
+    "@tiptap/extension-heading": {
+      "optional": true
+    },
+    "@tiptap/extension-horizontal-rule": {
+      "optional": true
+    },
+    "@tiptap/extension-italic": {
+      "optional": true
+    },
+    "@tiptap/extension-link": {
+      "optional": true
+    },
+    "@tiptap/extension-list": {
+      "optional": true
+    },
+    "@tiptap/extension-paragraph": {
+      "optional": true
+    },
+    "@tiptap/extension-strike": {
+      "optional": true
+    },
+    "@tiptap/extension-text": {
+      "optional": true
+    },
+    "@tiptap/extension-underline": {
+      "optional": true
+    },
+    "@tiptap/extensions": {
+      "optional": true
+    },
+    "@tiptap/pm": {
+      "optional": true
+    },
+    "@tiptap/suggestion": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@tiptap/core": "^3.6.5",
+    "@tiptap/extension-blockquote": "^3.6.5",
+    "@tiptap/extension-bold": "^3.6.5",
+    "@tiptap/extension-code": "^3.6.5",
+    "@tiptap/extension-code-block": "^3.6.5",
+    "@tiptap/extension-document": "^3.6.5",
+    "@tiptap/extension-hard-break": "^3.6.5",
+    "@tiptap/extension-heading": "^3.6.5",
+    "@tiptap/extension-horizontal-rule": "^3.6.5",
+    "@tiptap/extension-italic": "^3.6.5",
+    "@tiptap/extension-link": "^3.6.5",
+    "@tiptap/extension-list": "^3.6.5",
+    "@tiptap/extension-paragraph": "^3.6.5",
+    "@tiptap/extension-strike": "^3.6.5",
+    "@tiptap/extension-text": "^3.6.5",
+    "@tiptap/extension-underline": "^3.6.5",
+    "@tiptap/extensions": "^3.6.5",
+    "@tiptap/pm": "^3.6.5",
+    "@tiptap/suggestion": "^3.6.5",
+    "typescript": "~5.8.3"
+  }
+}