@kungal/editor-core 0.25.2 → 0.27.0

package/CHANGELOG.md

@@ -1,5 +1,58 @@
 # @kungal/editor-core
 
+## 0.27.0
+
+### Minor Changes
+
+- ac86c0a: Add a heading-outline API for building a table of contents (TOC).
+
+  A host (e.g. a desktop editor with a left-side outline) can now render its own TOC
+  and navigate the editor, without reaching into editor internals:
+
+  - **`@update:headings`** on `<KunEditor>` — emits the ordered outline
+    (`KunHeading[]` = `{ level, text }`) whenever the content changes.
+  - **`ref.scrollToHeading(index)`** — scrolls to that heading in the _current_ view
+    and places the caret there: the WYSIWYG heading in wysiwyg mode, the CodeMirror
+    heading line in source/split mode (so a click navigates the editable pane).
+  - **editor-core** exports the pure `parseHeadings(markdown)` (and `KunHeading`) it's
+    built on — usable server-side too. Parses ATX headings, skipping code fences.
+
+  The TOC's styling, colour, indentation and layout (e.g. reserving space on the
+  left of the split editor) are entirely the host's — the editor only exposes the
+  data + navigation, matching the headless design.
+
+  Verified in a new docs example (`/examples/toc`): the outline tracks the content;
+  clicking an item scrolls + carets to that heading in wysiwyg (scrollTop 0→386,
+  caret in the target) and in source (CodeMirror scrolled, cursor on `## …`); new
+  `parseHeadings` unit tests pass; 0 console errors.
+
+## 0.26.0
+
+### Minor Changes
+
+- 945708d: Add an insert-link feature (click to add a URL).
+
+  The `link` mark already existed (so `[text](url)` round-trips and pasted URLs
+  autolink), but there was no click-to-insert UI. Now there is:
+
+  - **editor-core**: `insertLinkCommand` (`{ href, text? }`) — applies the link mark
+    to the selection, or inserts linked text on an empty selection; clears the
+    stored mark afterwards. Re-exported from `@kungal/editor-core/preset`.
+  - **editor-vue**: `KunEditorToolbarApi.insertLink(payload)`; a `link` button in the
+    default toolbar and the selection bubble (both default-on); `'link'` added to
+    `KunToolbarItem` and `KunSelectionItem`. Headless UI prompts for the URL.
+  - **editor-nuxt**: `<KunEditorToolbar>` gains a `link` button — a KunPopover with a
+    KunInput for the URL.
+
+  A link is a **mark** (`[text](url)`), deliberately distinct from the custom-NODE
+  embeds (mention / quote). A future "article card" or custom component would be a
+  node like those (schema + toUrl/fromUrl), not this — a separate mechanism.
+
+  Verified in the docs production build: the KunUI toolbar popover wraps a selection
+  (`[…](https://example.com)`); the selection bubble does too
+  (`[linktext](https://kun.com)`); 4 new core tests (wrap / insert / autolink
+  fallback / blank-href no-op) pass; 0 console errors.
+
 ## 0.25.2
 
 ## 0.25.1

package/dist/chunk-PT42ZQGO.js

@@ -0,0 +1,30 @@
+// src/outline.ts
+var FENCE = /^\s{0,3}(?:```|~~~)/;
+var ATX = /^ {0,3}(#{1,6})\s+(.+?)\s*#*\s*$/;
+var parseHeadings = (markdown) => {
+  const out = [];
+  let inFence = false;
+  for (const line of markdown.split("\n")) {
+    if (FENCE.test(line)) {
+      inFence = !inFence;
+      continue;
+    }
+    if (inFence) {
+      continue;
+    }
+    const m = line.match(ATX);
+    if (m) {
+      out.push({ level: m[1].length, text: m[2].trim() });
+    }
+  }
+  return out;
+};
+
+// src/index.ts
+var MENTION_SCHEME = "kungal-user:";
+var QUOTE_SCHEME = "kungal-reply:";
+var KUN_EDITOR_CORE_VERSION = "0.0.0";
+
+export { KUN_EDITOR_CORE_VERSION, MENTION_SCHEME, QUOTE_SCHEME, parseHeadings };
+//# sourceMappingURL=chunk-PT42ZQGO.js.map
+//# sourceMappingURL=chunk-PT42ZQGO.js.map

package/dist/chunk-PT42ZQGO.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/outline.ts","../src/index.ts"],"names":[],"mappings":";AAgBA,IAAM,KAAA,GAAQ,qBAAA;AACd,IAAM,GAAA,GAAM,kCAAA;AAGL,IAAM,aAAA,GAAgB,CAAC,QAAA,KAAmC;AAC/D,EAAA,MAAM,MAAoB,EAAC;AAC3B,EAAA,IAAI,OAAA,GAAU,KAAA;AACd,EAAA,KAAA,MAAW,IAAA,IAAQ,QAAA,CAAS,KAAA,CAAM,IAAI,CAAA,EAAG;AACvC,IAAA,IAAI,KAAA,CAAM,IAAA,CAAK,IAAI,CAAA,EAAG;AACpB,MAAA,OAAA,GAAU,CAAC,OAAA;AACX,MAAA;AAAA,IACF;AACA,IAAA,IAAI,OAAA,EAAS;AACX,MAAA;AAAA,IACF;AACA,IAAA,MAAM,CAAA,GAAI,IAAA,CAAK,KAAA,CAAM,GAAG,CAAA;AACxB,IAAA,IAAI,CAAA,EAAG;AACL,MAAA,GAAA,CAAI,IAAA,CAAK,EAAE,KAAA,EAAO,CAAA,CAAE,CAAC,CAAA,CAAG,MAAA,EAAQ,IAAA,EAAM,CAAA,CAAE,CAAC,CAAA,CAAG,IAAA,IAAQ,CAAA;AAAA,IACtD;AAAA,EACF;AACA,EAAA,OAAO,GAAA;AACT;;;ACtBO,IAAM,cAAA,GAAiB;AAMvB,IAAM,YAAA,GAAe;AAErB,IAAM,uBAAA,GAA0B","file":"chunk-PT42ZQGO.js","sourcesContent":["// Heading outline (table-of-contents) parsing — pure, zero-dep, so it lives in\n// the light main entry (a host, or the server, can build a TOC without pulling in\n// @milkdown/kit). Parses ATX headings (`#`…`######`) — what the toolbar produces\n// — and skips fenced code blocks so a `# comment` inside ``` isn't mistaken for a\n// heading. Setext headings (underlined) are intentionally not parsed.\n//\n// The result is an ordered list; a UI renders it and, on click, calls the\n// editor's `scrollToHeading(index)` with the item's array index.\n\nexport interface KunHeading {\n  /** Heading level 1–6. */\n  level: number\n  /** The heading's text (trailing `#` closers stripped). */\n  text: string\n}\n\nconst FENCE = /^\\s{0,3}(?:```|~~~)/\nconst ATX = /^ {0,3}(#{1,6})\\s+(.+?)\\s*#*\\s*$/\n\n/** Parse the ordered ATX-heading outline from a markdown string. */\nexport const parseHeadings = (markdown: string): KunHeading[] => {\n  const out: KunHeading[] = []\n  let inFence = false\n  for (const line of markdown.split('\\n')) {\n    if (FENCE.test(line)) {\n      inFence = !inFence\n      continue\n    }\n    if (inFence) {\n      continue\n    }\n    const m = line.match(ATX)\n    if (m) {\n      out.push({ level: m[1]!.length, text: m[2]!.trim() })\n    }\n  }\n  return out\n}\n","// @kungal/editor-core — public entry.\n//\n// STATUS: scaffold. The adapter contracts (the stable public surface) are\n// defined and exported now; the Milkdown plugin ports land incrementally per\n// docs/architecture.md § migration. Consumers should code against the types\n// below — those are the contract that will not churn as plugins move over.\n\nexport * from './types'\n\n// Heading outline (TOC) parsing — pure, so it's here in the light entry.\nexport * from './outline'\n\n// Markdown scheme used to encode an @mention as a plain link the server can\n// render + parse: `[@name](kungal-user:<id>)`. Lives here (not the plugin) so\n// hosts and the server can share the exact string. See ./plugins/mention.\nexport const MENTION_SCHEME = 'kungal-user:'\n\n// Markdown scheme for an inline reference (reply quote): `[label](kungal-reply:<refId>)`.\n// Like MENTION_SCHEME, shared with the server renderer so both agree on the\n// exact string. The reference is opaque here — the host decides what `refId` /\n// `label` mean (see docs/architecture.md § the reply-quote question, option 1).\nexport const QUOTE_SCHEME = 'kungal-reply:'\n\nexport const KUN_EDITOR_CORE_VERSION = '0.0.0'\n\n// ── The Milkdown plugins live in the `./preset` subpath ──────────────────────\n// This main entry stays light on purpose: types + MENTION_SCHEME, ZERO runtime\n// deps, so the server (which only needs the @mention scheme string) can import\n// it without installing @milkdown/kit / katex / codemirror.\n//\n// The composed Milkdown bundle and the individual plugin factories are exported\n// from `@kungal/editor-core/preset` (they pull in the peer deps):\n//\n//   import { createKunEditorPlugins } from '@kungal/editor-core/preset'\n//\n// P1 landed (docs/architecture.md § migration): spoiler, katex, code-block,\n// stop-link — each a factory (createXxxPlugin), never a host-bound singleton.\n// P2 adds the adapter-driven plugins (upload / mention / sticker).\n"]}

package/dist/index.cjs

@@ -1,5 +1,27 @@
 'use strict';
 
+// src/outline.ts
+var FENCE = /^\s{0,3}(?:```|~~~)/;
+var ATX = /^ {0,3}(#{1,6})\s+(.+?)\s*#*\s*$/;
+var parseHeadings = (markdown) => {
+  const out = [];
+  let inFence = false;
+  for (const line of markdown.split("\n")) {
+    if (FENCE.test(line)) {
+      inFence = !inFence;
+      continue;
+    }
+    if (inFence) {
+      continue;
+    }
+    const m = line.match(ATX);
+    if (m) {
+      out.push({ level: m[1].length, text: m[2].trim() });
+    }
+  }
+  return out;
+};
+
 // src/index.ts
 var MENTION_SCHEME = "kungal-user:";
 var QUOTE_SCHEME = "kungal-reply:";
@@ -8,5 +30,6 @@ var KUN_EDITOR_CORE_VERSION = "0.0.0";
 exports.KUN_EDITOR_CORE_VERSION = KUN_EDITOR_CORE_VERSION;
 exports.MENTION_SCHEME = MENTION_SCHEME;
 exports.QUOTE_SCHEME = QUOTE_SCHEME;
+exports.parseHeadings = parseHeadings;
 //# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;AAYO,IAAM,cAAA,GAAiB;AAMvB,IAAM,YAAA,GAAe;AAErB,IAAM,uBAAA,GAA0B","file":"index.cjs","sourcesContent":["// @kungal/editor-core — public entry.\n//\n// STATUS: scaffold. The adapter contracts (the stable public surface) are\n// defined and exported now; the Milkdown plugin ports land incrementally per\n// docs/architecture.md § migration. Consumers should code against the types\n// below — those are the contract that will not churn as plugins move over.\n\nexport * from './types'\n\n// Markdown scheme used to encode an @mention as a plain link the server can\n// render + parse: `[@name](kungal-user:<id>)`. Lives here (not the plugin) so\n// hosts and the server can share the exact string. See ./plugins/mention.\nexport const MENTION_SCHEME = 'kungal-user:'\n\n// Markdown scheme for an inline reference (reply quote): `[label](kungal-reply:<refId>)`.\n// Like MENTION_SCHEME, shared with the server renderer so both agree on the\n// exact string. The reference is opaque here — the host decides what `refId` /\n// `label` mean (see docs/architecture.md § the reply-quote question, option 1).\nexport const QUOTE_SCHEME = 'kungal-reply:'\n\nexport const KUN_EDITOR_CORE_VERSION = '0.0.0'\n\n// ── The Milkdown plugins live in the `./preset` subpath ──────────────────────\n// This main entry stays light on purpose: types + MENTION_SCHEME, ZERO runtime\n// deps, so the server (which only needs the @mention scheme string) can import\n// it without installing @milkdown/kit / katex / codemirror.\n//\n// The composed Milkdown bundle and the individual plugin factories are exported\n// from `@kungal/editor-core/preset` (they pull in the peer deps):\n//\n//   import { createKunEditorPlugins } from '@kungal/editor-core/preset'\n//\n// P1 landed (docs/architecture.md § migration): spoiler, katex, code-block,\n// stop-link — each a factory (createXxxPlugin), never a host-bound singleton.\n// P2 adds the adapter-driven plugins (upload / mention / sticker).\n"]}
+{"version":3,"sources":["../src/outline.ts","../src/index.ts"],"names":[],"mappings":";;;AAgBA,IAAM,KAAA,GAAQ,qBAAA;AACd,IAAM,GAAA,GAAM,kCAAA;AAGL,IAAM,aAAA,GAAgB,CAAC,QAAA,KAAmC;AAC/D,EAAA,MAAM,MAAoB,EAAC;AAC3B,EAAA,IAAI,OAAA,GAAU,KAAA;AACd,EAAA,KAAA,MAAW,IAAA,IAAQ,QAAA,CAAS,KAAA,CAAM,IAAI,CAAA,EAAG;AACvC,IAAA,IAAI,KAAA,CAAM,IAAA,CAAK,IAAI,CAAA,EAAG;AACpB,MAAA,OAAA,GAAU,CAAC,OAAA;AACX,MAAA;AAAA,IACF;AACA,IAAA,IAAI,OAAA,EAAS;AACX,MAAA;AAAA,IACF;AACA,IAAA,MAAM,CAAA,GAAI,IAAA,CAAK,KAAA,CAAM,GAAG,CAAA;AACxB,IAAA,IAAI,CAAA,EAAG;AACL,MAAA,GAAA,CAAI,IAAA,CAAK,EAAE,KAAA,EAAO,CAAA,CAAE,CAAC,CAAA,CAAG,MAAA,EAAQ,IAAA,EAAM,CAAA,CAAE,CAAC,CAAA,CAAG,IAAA,IAAQ,CAAA;AAAA,IACtD;AAAA,EACF;AACA,EAAA,OAAO,GAAA;AACT;;;ACtBO,IAAM,cAAA,GAAiB;AAMvB,IAAM,YAAA,GAAe;AAErB,IAAM,uBAAA,GAA0B","file":"index.cjs","sourcesContent":["// Heading outline (table-of-contents) parsing — pure, zero-dep, so it lives in\n// the light main entry (a host, or the server, can build a TOC without pulling in\n// @milkdown/kit). Parses ATX headings (`#`…`######`) — what the toolbar produces\n// — and skips fenced code blocks so a `# comment` inside ``` isn't mistaken for a\n// heading. Setext headings (underlined) are intentionally not parsed.\n//\n// The result is an ordered list; a UI renders it and, on click, calls the\n// editor's `scrollToHeading(index)` with the item's array index.\n\nexport interface KunHeading {\n  /** Heading level 1–6. */\n  level: number\n  /** The heading's text (trailing `#` closers stripped). */\n  text: string\n}\n\nconst FENCE = /^\\s{0,3}(?:```|~~~)/\nconst ATX = /^ {0,3}(#{1,6})\\s+(.+?)\\s*#*\\s*$/\n\n/** Parse the ordered ATX-heading outline from a markdown string. */\nexport const parseHeadings = (markdown: string): KunHeading[] => {\n  const out: KunHeading[] = []\n  let inFence = false\n  for (const line of markdown.split('\\n')) {\n    if (FENCE.test(line)) {\n      inFence = !inFence\n      continue\n    }\n    if (inFence) {\n      continue\n    }\n    const m = line.match(ATX)\n    if (m) {\n      out.push({ level: m[1]!.length, text: m[2]!.trim() })\n    }\n  }\n  return out\n}\n","// @kungal/editor-core — public entry.\n//\n// STATUS: scaffold. The adapter contracts (the stable public surface) are\n// defined and exported now; the Milkdown plugin ports land incrementally per\n// docs/architecture.md § migration. Consumers should code against the types\n// below — those are the contract that will not churn as plugins move over.\n\nexport * from './types'\n\n// Heading outline (TOC) parsing — pure, so it's here in the light entry.\nexport * from './outline'\n\n// Markdown scheme used to encode an @mention as a plain link the server can\n// render + parse: `[@name](kungal-user:<id>)`. Lives here (not the plugin) so\n// hosts and the server can share the exact string. See ./plugins/mention.\nexport const MENTION_SCHEME = 'kungal-user:'\n\n// Markdown scheme for an inline reference (reply quote): `[label](kungal-reply:<refId>)`.\n// Like MENTION_SCHEME, shared with the server renderer so both agree on the\n// exact string. The reference is opaque here — the host decides what `refId` /\n// `label` mean (see docs/architecture.md § the reply-quote question, option 1).\nexport const QUOTE_SCHEME = 'kungal-reply:'\n\nexport const KUN_EDITOR_CORE_VERSION = '0.0.0'\n\n// ── The Milkdown plugins live in the `./preset` subpath ──────────────────────\n// This main entry stays light on purpose: types + MENTION_SCHEME, ZERO runtime\n// deps, so the server (which only needs the @mention scheme string) can import\n// it without installing @milkdown/kit / katex / codemirror.\n//\n// The composed Milkdown bundle and the individual plugin factories are exported\n// from `@kungal/editor-core/preset` (they pull in the peer deps):\n//\n//   import { createKunEditorPlugins } from '@kungal/editor-core/preset'\n//\n// P1 landed (docs/architecture.md § migration): spoiler, katex, code-block,\n// stop-link — each a factory (createXxxPlugin), never a host-bound singleton.\n// P2 adds the adapter-driven plugins (upload / mention / sticker).\n"]}

package/dist/index.d.cts

@@ -1,7 +1,16 @@
 export { K as KunEditorAdapters, a as KunEditorFeatures, b as KunEditorLocale, M as MentionUser, N as Notify, c as NotifyLevel, S as SearchMentionUsers, d as StickerItem, e as StickerPack, f as StickerSource, U as UploadImage } from './types-Dq7UxR_g.cjs';
 
+interface KunHeading {
+    /** Heading level 1–6. */
+    level: number;
+    /** The heading's text (trailing `#` closers stripped). */
+    text: string;
+}
+/** Parse the ordered ATX-heading outline from a markdown string. */
+declare const parseHeadings: (markdown: string) => KunHeading[];
+
 declare const MENTION_SCHEME = "kungal-user:";
 declare const QUOTE_SCHEME = "kungal-reply:";
 declare const KUN_EDITOR_CORE_VERSION = "0.0.0";
 
-export { KUN_EDITOR_CORE_VERSION, MENTION_SCHEME, QUOTE_SCHEME };
+export { KUN_EDITOR_CORE_VERSION, type KunHeading, MENTION_SCHEME, QUOTE_SCHEME, parseHeadings };

package/dist/index.d.ts

@@ -1,7 +1,16 @@
 export { K as KunEditorAdapters, a as KunEditorFeatures, b as KunEditorLocale, M as MentionUser, N as Notify, c as NotifyLevel, S as SearchMentionUsers, d as StickerItem, e as StickerPack, f as StickerSource, U as UploadImage } from './types-Dq7UxR_g.js';
 
+interface KunHeading {
+    /** Heading level 1–6. */
+    level: number;
+    /** The heading's text (trailing `#` closers stripped). */
+    text: string;
+}
+/** Parse the ordered ATX-heading outline from a markdown string. */
+declare const parseHeadings: (markdown: string) => KunHeading[];
+
 declare const MENTION_SCHEME = "kungal-user:";
 declare const QUOTE_SCHEME = "kungal-reply:";
 declare const KUN_EDITOR_CORE_VERSION = "0.0.0";
 
-export { KUN_EDITOR_CORE_VERSION, MENTION_SCHEME, QUOTE_SCHEME };
+export { KUN_EDITOR_CORE_VERSION, type KunHeading, MENTION_SCHEME, QUOTE_SCHEME, parseHeadings };

package/dist/index.js

@@ -1,3 +1,3 @@
-export { KUN_EDITOR_CORE_VERSION, MENTION_SCHEME, QUOTE_SCHEME } from './chunk-KY2VN6IQ.js';
+export { KUN_EDITOR_CORE_VERSION, MENTION_SCHEME, QUOTE_SCHEME, parseHeadings } from './chunk-PT42ZQGO.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/preset/index.cjs

@@ -196,6 +196,29 @@ var linkCustomKeymap = utils.$useKeymap("linkCustomKeymap", {
   }
 });
 var createStopLinkPlugin = () => [stopLinkCommand, linkCustomKeymap].flat();
+var insertLinkCommand = utils.$command(
+  "InsertKunLink",
+  (ctx) => (payload) => (state, dispatch) => {
+    const href = payload?.href?.trim();
+    if (!href) {
+      return false;
+    }
+    const markType = commonmark.linkSchema.type(ctx);
+    const mark = markType.create({ href });
+    const { from, to, empty } = state.selection;
+    if (empty) {
+      const text = payload?.text?.trim() || href;
+      const tr = state.tr.insertText(text, from);
+      tr.addMark(from, from + text.length, mark);
+      tr.removeStoredMark(markType);
+      dispatch?.(tr.scrollIntoView());
+    } else {
+      dispatch?.(state.tr.addMark(from, to, mark).scrollIntoView());
+    }
+    return true;
+  }
+);
+var createLinkPlugin = () => [insertLinkCommand].flat();
 var setHeadingCommand = utils.$command(
   "SetHeadingKun",
   (ctx) => (level = 0) => level >= 1 && level <= 6 ? commands.setBlockType(commonmark.headingSchema.type(ctx), { level }) : commands.setBlockType(commonmark.paragraphSchema.type(ctx))
@@ -1160,6 +1183,7 @@ var createKunEditorPlugins = (adapters = {}, features = {}, options = {}) => {
     plugins.push(imageUploadPlaceholder);
   }
   plugins.push(createStopLinkPlugin());
+  plugins.push(createLinkPlugin());
   plugins.push(createHeadingPlugin());
   if (options.placeholder) {
     plugins.push(
@@ -1182,6 +1206,7 @@ exports.createCodeBlockPlugins = createCodeBlockPlugins;
 exports.createHeadingPlugin = createHeadingPlugin;
 exports.createKatexPlugins = createKatexPlugins;
 exports.createKunEditorPlugins = createKunEditorPlugins;
+exports.createLinkPlugin = createLinkPlugin;
 exports.createMentionPlugin = createMentionPlugin;
 exports.createPlaceholderPlugin = createPlaceholderPlugin;
 exports.createQuotePlugin = createQuotePlugin;
@@ -1193,6 +1218,7 @@ exports.createUploader = createUploader;
 exports.editIcon = editIcon;
 exports.imageUploadPlaceholder = imageUploadPlaceholder;
 exports.insertKunSpoilerCommand = insertKunSpoilerCommand;
+exports.insertLinkCommand = insertLinkCommand;
 exports.insertMentionCommand = insertMentionCommand;
 exports.insertQuoteCommand = insertQuoteCommand;
 exports.insertSpoilerInputRule = insertSpoilerInputRule;