@kungal/editor-core 0.9.0 → 0.11.0

package/dist/preset/index.d.cts

@@ -1,6 +1,6 @@
 import { MilkdownPlugin, Ctx } from '@milkdown/kit/ctx';
 import { KatexOptions } from 'katex';
-import { b as KunEditorLocale, N as Notify, U as UploadImage, K as KunEditorAdapters, a as KunEditorFeatures } from '../types-BXLT8DV7.cjs';
+import { b as KunEditorLocale, N as Notify, U as UploadImage, K as KunEditorAdapters, a as KunEditorFeatures } from '../types-Dq7UxR_g.cjs';
 import * as _milkdown_kit_utils from '@milkdown/kit/utils';
 import { Extension } from '@codemirror/state';
 import { Uploader } from '@milkdown/kit/plugin/upload';
@@ -95,22 +95,43 @@ declare const applyCodeBlockConfig: (ctx: Ctx, options?: CodeBlockOptions) => vo
 declare const createCodeBlockPlugins: (options?: CodeBlockOptions) => MilkdownPlugin[];
 
 declare const mentionId = "mention";
+/**
+ * How an @mention's user id maps TO / FROM its markdown link URL — host policy.
+ * Default: the `kungal-user:<id>` scheme (shared with the KUN server).
+ */
+interface MentionUrlConfig {
+    /** Build the link URL for a mention of `userId`. */
+    toUrl?: (userId: number) => string;
+    /**
+     * Parse a link back to a user id, or `null` if it isn't a mention. Gets the
+     * link URL AND its plain text, so a host can replicate text-based guards — e.g.
+     * moyu treats `/user/<id>` as a mention only when the link text starts with
+     * `@`, so `[see here](/user/5/x)` stays a plain link.
+     */
+    fromUrl?: (url: string, text: string) => number | null;
+}
+/** Default (kungal-user:) mention schema — for advanced direct use. */
 declare const mentionSchema: _milkdown_kit_utils.$NodeSchema<"mention">;
-/** Rewrites `[@name](kungal-user:id)` links into mention nodes on parse. */
+/** Default (kungal-user:) mention remark transform — for advanced direct use. */
 declare const remarkMentionPlugin: _milkdown_kit_utils.$Remark<"remarkMention", unknown>;
 /**
  * Insert a mention chip at the cursor, replacing the selection. The render-layer
- * dropdown (P3) usually replaces the `@query` range itself; this command is the
- * simple programmatic path (toolbar / tests). A trailing space lets the caret
- * continue past the atom naturally.
+ * dropdown usually replaces the `@query` range itself; this is the programmatic
+ * path (toolbar / tests / the imperative insertMention handle). A trailing space
+ * lets the caret continue past the atom naturally. Resolves the node type by id
+ * from the live schema, so it works with any mention config.
  */
 declare const insertMentionCommand: _milkdown_kit_utils.$Command<{
     userId: number;
     name: string;
 }>;
-/** The mention plugin bundle: schema + remark round-trip + insert command. The
- * `searchMentionUsers` adapter is consumed by the render-layer dropdown (P3). */
-declare const createMentionPlugin: () => MilkdownPlugin[];
+/**
+ * The mention plugin bundle: schema + remark round-trip + insert command. Pass
+ * `toUrl` / `fromUrl` to use a host-specific mention link form; omit for the
+ * default `kungal-user:` scheme. The `searchMentionUsers` adapter (the `@`
+ * autocomplete) is consumed by the render-layer dropdown.
+ */
+declare const createMentionPlugin: (config?: MentionUrlConfig) => MilkdownPlugin[];
 
 declare const quoteId = "quote";
 /** The payload a host passes to insert a reference. `refId` is opaque (the host
@@ -182,4 +203,4 @@ interface KunEditorPluginOptions {
  */
 declare const createKunEditorPlugins: (adapters?: KunEditorAdapters, features?: KunEditorFeatures, options?: KunEditorPluginOptions) => MilkdownPlugin[];
 
-export { type CodeBlockOptions, type KunEditorPluginOptions, type QuoteReference, type UploadPluginOptions, applyCodeBlockConfig, applyUploadConfig, blockKatexSchema, chevronDownIcon, clearIcon, copyIcon, createCodeBlockPlugins, createKatexPlugins, createKunEditorPlugins, createMentionPlugin, createQuotePlugin, createSpoilerPlugin, createStopLinkPlugin, createUploadPlugin, createUploadWidgetFactory, createUploader, editIcon, insertKunSpoilerCommand, insertMentionCommand, insertQuoteCommand, insertSpoilerInputRule, kunCM, kunCMHighlightStyle, kunCMTheme, linkCustomKeymap, mathBlockInputRule, mathInlineId, mathInlineInputRule, mathInlineSchema, mentionId, mentionSchema, quoteId, quoteSchema, remarkMathBlockPlugin, remarkMathPlugin, remarkMentionPlugin, remarkQuotePlugin, remarkSpoilerPlugin, searchIcon, spoilerAttr, spoilerSchema, stopLinkCommand, toggleLatexCommand, visibilityOffIcon };
+export { type CodeBlockOptions, type KunEditorPluginOptions, type MentionUrlConfig, type QuoteReference, type UploadPluginOptions, applyCodeBlockConfig, applyUploadConfig, blockKatexSchema, chevronDownIcon, clearIcon, copyIcon, createCodeBlockPlugins, createKatexPlugins, createKunEditorPlugins, createMentionPlugin, createQuotePlugin, createSpoilerPlugin, createStopLinkPlugin, createUploadPlugin, createUploadWidgetFactory, createUploader, editIcon, insertKunSpoilerCommand, insertMentionCommand, insertQuoteCommand, insertSpoilerInputRule, kunCM, kunCMHighlightStyle, kunCMTheme, linkCustomKeymap, mathBlockInputRule, mathInlineId, mathInlineInputRule, mathInlineSchema, mentionId, mentionSchema, quoteId, quoteSchema, remarkMathBlockPlugin, remarkMathPlugin, remarkMentionPlugin, remarkQuotePlugin, remarkSpoilerPlugin, searchIcon, spoilerAttr, spoilerSchema, stopLinkCommand, toggleLatexCommand, visibilityOffIcon };

package/dist/preset/index.d.ts

@@ -1,6 +1,6 @@
 import { MilkdownPlugin, Ctx } from '@milkdown/kit/ctx';
 import { KatexOptions } from 'katex';
-import { b as KunEditorLocale, N as Notify, U as UploadImage, K as KunEditorAdapters, a as KunEditorFeatures } from '../types-BXLT8DV7.js';
+import { b as KunEditorLocale, N as Notify, U as UploadImage, K as KunEditorAdapters, a as KunEditorFeatures } from '../types-Dq7UxR_g.js';
 import * as _milkdown_kit_utils from '@milkdown/kit/utils';
 import { Extension } from '@codemirror/state';
 import { Uploader } from '@milkdown/kit/plugin/upload';
@@ -95,22 +95,43 @@ declare const applyCodeBlockConfig: (ctx: Ctx, options?: CodeBlockOptions) => vo
 declare const createCodeBlockPlugins: (options?: CodeBlockOptions) => MilkdownPlugin[];
 
 declare const mentionId = "mention";
+/**
+ * How an @mention's user id maps TO / FROM its markdown link URL — host policy.
+ * Default: the `kungal-user:<id>` scheme (shared with the KUN server).
+ */
+interface MentionUrlConfig {
+    /** Build the link URL for a mention of `userId`. */
+    toUrl?: (userId: number) => string;
+    /**
+     * Parse a link back to a user id, or `null` if it isn't a mention. Gets the
+     * link URL AND its plain text, so a host can replicate text-based guards — e.g.
+     * moyu treats `/user/<id>` as a mention only when the link text starts with
+     * `@`, so `[see here](/user/5/x)` stays a plain link.
+     */
+    fromUrl?: (url: string, text: string) => number | null;
+}
+/** Default (kungal-user:) mention schema — for advanced direct use. */
 declare const mentionSchema: _milkdown_kit_utils.$NodeSchema<"mention">;
-/** Rewrites `[@name](kungal-user:id)` links into mention nodes on parse. */
+/** Default (kungal-user:) mention remark transform — for advanced direct use. */
 declare const remarkMentionPlugin: _milkdown_kit_utils.$Remark<"remarkMention", unknown>;
 /**
  * Insert a mention chip at the cursor, replacing the selection. The render-layer
- * dropdown (P3) usually replaces the `@query` range itself; this command is the
- * simple programmatic path (toolbar / tests). A trailing space lets the caret
- * continue past the atom naturally.
+ * dropdown usually replaces the `@query` range itself; this is the programmatic
+ * path (toolbar / tests / the imperative insertMention handle). A trailing space
+ * lets the caret continue past the atom naturally. Resolves the node type by id
+ * from the live schema, so it works with any mention config.
  */
 declare const insertMentionCommand: _milkdown_kit_utils.$Command<{
     userId: number;
     name: string;
 }>;
-/** The mention plugin bundle: schema + remark round-trip + insert command. The
- * `searchMentionUsers` adapter is consumed by the render-layer dropdown (P3). */
-declare const createMentionPlugin: () => MilkdownPlugin[];
+/**
+ * The mention plugin bundle: schema + remark round-trip + insert command. Pass
+ * `toUrl` / `fromUrl` to use a host-specific mention link form; omit for the
+ * default `kungal-user:` scheme. The `searchMentionUsers` adapter (the `@`
+ * autocomplete) is consumed by the render-layer dropdown.
+ */
+declare const createMentionPlugin: (config?: MentionUrlConfig) => MilkdownPlugin[];
 
 declare const quoteId = "quote";
 /** The payload a host passes to insert a reference. `refId` is opaque (the host
@@ -182,4 +203,4 @@ interface KunEditorPluginOptions {
  */
 declare const createKunEditorPlugins: (adapters?: KunEditorAdapters, features?: KunEditorFeatures, options?: KunEditorPluginOptions) => MilkdownPlugin[];
 
-export { type CodeBlockOptions, type KunEditorPluginOptions, type QuoteReference, type UploadPluginOptions, applyCodeBlockConfig, applyUploadConfig, blockKatexSchema, chevronDownIcon, clearIcon, copyIcon, createCodeBlockPlugins, createKatexPlugins, createKunEditorPlugins, createMentionPlugin, createQuotePlugin, createSpoilerPlugin, createStopLinkPlugin, createUploadPlugin, createUploadWidgetFactory, createUploader, editIcon, insertKunSpoilerCommand, insertMentionCommand, insertQuoteCommand, insertSpoilerInputRule, kunCM, kunCMHighlightStyle, kunCMTheme, linkCustomKeymap, mathBlockInputRule, mathInlineId, mathInlineInputRule, mathInlineSchema, mentionId, mentionSchema, quoteId, quoteSchema, remarkMathBlockPlugin, remarkMathPlugin, remarkMentionPlugin, remarkQuotePlugin, remarkSpoilerPlugin, searchIcon, spoilerAttr, spoilerSchema, stopLinkCommand, toggleLatexCommand, visibilityOffIcon };
+export { type CodeBlockOptions, type KunEditorPluginOptions, type MentionUrlConfig, type QuoteReference, type UploadPluginOptions, applyCodeBlockConfig, applyUploadConfig, blockKatexSchema, chevronDownIcon, clearIcon, copyIcon, createCodeBlockPlugins, createKatexPlugins, createKunEditorPlugins, createMentionPlugin, createQuotePlugin, createSpoilerPlugin, createStopLinkPlugin, createUploadPlugin, createUploadWidgetFactory, createUploader, editIcon, insertKunSpoilerCommand, insertMentionCommand, insertQuoteCommand, insertSpoilerInputRule, kunCM, kunCMHighlightStyle, kunCMTheme, linkCustomKeymap, mathBlockInputRule, mathInlineId, mathInlineInputRule, mathInlineSchema, mentionId, mentionSchema, quoteId, quoteSchema, remarkMathBlockPlugin, remarkMathPlugin, remarkMentionPlugin, remarkQuotePlugin, remarkSpoilerPlugin, searchIcon, spoilerAttr, spoilerSchema, stopLinkCommand, toggleLatexCommand, visibilityOffIcon };

package/dist/preset/index.js

@@ -1,4 +1,4 @@
-import { MENTION_SCHEME, QUOTE_SCHEME } from '../chunk-KY2VN6IQ.js';
+import { QUOTE_SCHEME, MENTION_SCHEME } from '../chunk-KY2VN6IQ.js';
 import { linkSchema, codeBlockSchema, commonmark } from '@milkdown/kit/preset/commonmark';
 import { gfm } from '@milkdown/kit/preset/gfm';
 import { history } from '@milkdown/kit/plugin/history';
@@ -716,7 +716,13 @@ var codeBlockConfigPlugin = (options) => (ctx) => () => {
 };
 var createCodeBlockPlugins = (options = {}) => [...codeBlockComponent, codeBlockConfigPlugin(options)];
 var mentionId = "mention";
-var mentionSchema = $nodeSchema(mentionId, () => ({
+var defaultToUrl = (userId) => `${MENTION_SCHEME}${userId}`;
+var defaultFromUrl = (url) => {
+  if (!url.startsWith(MENTION_SCHEME)) return null;
+  const id = Number.parseInt(url.slice(MENTION_SCHEME.length), 10);
+  return Number.isInteger(id) && id > 0 ? id : null;
+};
+var makeMentionSchema = (toUrl) => $nodeSchema(mentionId, () => ({
   group: "inline",
   inline: true,
   atom: true,
@@ -755,29 +761,24 @@ var mentionSchema = $nodeSchema(mentionId, () => ({
   toMarkdown: {
     match: (node) => node.type.name === mentionId,
     runner: (state, node) => {
-      state.openNode("link", void 0, {
-        url: `${MENTION_SCHEME}${node.attrs.userId}`
-      });
+      state.openNode("link", void 0, { url: toUrl(node.attrs.userId) });
       state.addNode("text", void 0, `@${node.attrs.name}`);
       state.closeNode();
     }
   }
 }));
-var remarkMentionPlugin = $remark("remarkMention", () => () => {
+var makeRemarkMention = (fromUrl) => $remark("remarkMention", () => () => {
   const transformer = (tree) => {
     visit(tree, "link", (node, index, parent) => {
-      if (typeof node.url !== "string" || !node.url.startsWith(MENTION_SCHEME)) {
+      if (typeof node.url !== "string") {
         return;
       }
-      const userId = Number.parseInt(node.url.slice(MENTION_SCHEME.length), 10);
-      if (!Number.isInteger(userId) || userId <= 0) {
+      const text = (node.children ?? []).map((child) => typeof child.value === "string" ? child.value : "").join("");
+      const userId = fromUrl(node.url, text);
+      if (userId == null) {
         return;
       }
-      const first = node.children?.[0];
-      const name = (typeof first?.value === "string" ? first.value : "").replace(
-        /^@/,
-        ""
-      );
+      const name = text.replace(/^@/, "");
       if (typeof index === "number" && parent.children) {
         parent.children.splice(index, 1, {
           type: mentionId,
@@ -789,9 +790,11 @@ var remarkMentionPlugin = $remark("remarkMention", () => () => {
   };
   return transformer;
 });
+var mentionSchema = makeMentionSchema(defaultToUrl);
+var remarkMentionPlugin = makeRemarkMention(defaultFromUrl);
 var insertMentionCommand = $command(
   "InsertKunMention",
-  (ctx) => (payload) => (state, dispatch) => {
+  () => (payload) => (state, dispatch) => {
     if (!payload || !dispatch) {
       return false;
     }
@@ -799,17 +802,22 @@ var insertMentionCommand = $command(
     if (!Number.isInteger(userId) || userId <= 0) {
       return false;
     }
-    const node = mentionSchema.type(ctx).create({ userId, name });
-    if (!node) {
+    const type = state.schema.nodes[mentionId];
+    if (!type) {
       return false;
     }
+    const node = type.create({ userId, name });
     const tr = state.tr.replaceSelectionWith(node);
     tr.insertText(" ");
     dispatch(tr.scrollIntoView());
     return true;
   }
 );
-var createMentionPlugin = () => [mentionSchema, remarkMentionPlugin, insertMentionCommand].flat();
+var createMentionPlugin = (config = {}) => {
+  const schema = config.toUrl ? makeMentionSchema(config.toUrl) : mentionSchema;
+  const remark = config.fromUrl ? makeRemarkMention(config.fromUrl) : remarkMentionPlugin;
+  return [schema, remark, insertMentionCommand].flat();
+};
 var quoteId = "quote";
 var quoteSchema = $nodeSchema(quoteId, () => ({
   group: "inline",
@@ -984,7 +992,12 @@ var createKunEditorPlugins = (adapters = {}, features = {}, options = {}) => {
     plugins.push(createSpoilerPlugin());
   }
   if (mention) {
-    plugins.push(createMentionPlugin());
+    plugins.push(
+      createMentionPlugin({
+        toUrl: adapters.mentionToUrl,
+        fromUrl: adapters.mentionFromUrl
+      })
+    );
   }
   if (quote) {
     plugins.push(createQuotePlugin());