Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
chore(text): pass reference link titles through editor config
Elian Doran4c2471b479da
diff --git a/apps/client/src/widgets/type_widgets/text/config.spec.ts b/apps/client/src/widgets/type_widgets/text/config.spec.tsindex d9d6e15072..62a9b6c909 100644--- a/apps/client/src/widgets/type_widgets/text/config.spec.ts+++ b/apps/client/src/widgets/type_widgets/text/config.spec.ts@@ -3,6 +3,7 @@ import { DISPLAYABLE_LOCALE_IDS, IMAGE_MIMES, LOCALES, SANITIZER_DEFAULT_ALLOWEDimport { afterEach, beforeEach, describe, expect, it, vi } from "vitest";import imageService from "../../../services/image.js";+import linkService from "../../../services/link.js";import { ensureMimeTypesForHighlighting } from "../../../services/syntax_highlight.js";import { buildConfig, type BuildEditorOptions, OPEN_SOURCE_LICENSE_KEY } from "./config.js";@@ -345,6 +346,13 @@ describe("CK config - tables", () => {optionsState.map.customDateTimeFormat = "DD.MM.YYYY HH:mm";expect(formatDateTime?.(date)).toBe("25.09.2026 10:30");});++ it("titles reference links through the link service", async () => {+ expect((await buildConfig(baseOpts())).referenceLink).toStrictEqual({+ getTitle: linkService.getReferenceLinkTitle,+ getTitleSync: linkService.getReferenceLinkTitleSync+ });+ });});describe("CK config - licensing", () => {diff --git a/apps/client/src/widgets/type_widgets/text/config.ts b/apps/client/src/widgets/type_widgets/text/config.tsindex 517f81e555..259851c133 100644--- a/apps/client/src/widgets/type_widgets/text/config.ts+++ b/apps/client/src/widgets/type_widgets/text/config.ts@@ -8,6 +8,7 @@ import { prompt } from "../../../services/dialog.js";import { t } from "../../../services/i18n.js";import imageService from "../../../services/image.js";import { getNoteImageSourceToLoad } from "../../../services/image_urls.js";+import linkService from "../../../services/link.js";import { default as mimeTypesService, getHighlightJsNameForMime } from "../../../services/mime_types.js";import options from "../../../services/options.js";import { sanitizeNoteContentHtml } from "../../../services/sanitize_content.js";@@ -198,6 +199,10 @@ export async function buildConfig(opts: BuildEditorOptions): Promise<EditorConfi},// Reads `customDateTimeFormat` on each call, so a changed format applies to open editors.formatDateTime: (date, format) => formatDateTime(date, format ?? options.get("customDateTimeFormat")),+ referenceLink: {+ getTitle: linkService.getReferenceLinkTitle,+ getTitleSync: linkService.getReferenceLinkTitleSync+ },slashCommand: {// Drop CKEditor's built-in list slash commands, whose Title Case titles the palette// re-defines in sentence case.diff --git a/packages/ckeditor5/src/augmentation.ts b/packages/ckeditor5/src/augmentation.tsindex 60b2d420a7..604a33df98 100644--- a/packages/ckeditor5/src/augmentation.ts+++ b/packages/ckeditor5/src/augmentation.ts@@ -206,7 +206,5 @@ declare global {* because a raw request with a body cannot reach that server from every platform.*/getLocalUpload?(): LocalUpload | undefined;- getReferenceLinkTitle(href: string): Promise<string>;- getReferenceLinkTitleSync(href: string, storedTitle?: string): string;};}diff --git a/packages/ckeditor5/src/plugins/content_embed/content_embed.spec.ts b/packages/ckeditor5/src/plugins/content_embed/content_embed.spec.tsindex d09f682b8f..616bbb4968 100644--- a/packages/ckeditor5/src/plugins/content_embed/content_embed.spec.ts+++ b/packages/ckeditor5/src/plugins/content_embed/content_embed.spec.ts@@ -806,13 +806,14 @@ describe("ContentEmbed with attachments", () => {loadEmbeddedAttachment,getAttachmentHref,loadReferenceLinkTitle: vi.fn(async () => undefined)- }),- getReferenceLinkTitleSync: () => "report.pdf"+ })});editor = await createTestEditor([Essentials, Paragraph, Undo, Widget, LinkEditing, ReferenceLink, ContentEmbed- ]);+ ], {+ referenceLink: { getTitle: async () => "report.pdf", getTitleSync: () => "report.pdf" }+ });});/** Querying the DOM root forces the UIElement render callbacks to run. */diff --git a/packages/ckeditor5/src/plugins/copy_anchor_link.spec.ts b/packages/ckeditor5/src/plugins/copy_anchor_link.spec.tsindex 67ebe653c7..37d4f06cd7 100644--- a/packages/ckeditor5/src/plugins/copy_anchor_link.spec.ts+++ b/packages/ckeditor5/src/plugins/copy_anchor_link.spec.ts@@ -18,14 +18,14 @@ describe("CopyAnchorLinkButton", () => {getComponentByEl = vi.fn(() => ({}));installGlobMock({getActiveContextNote,- getReferenceLinkTitleSync,getComponentByEl});copyHtml = vi.fn();editor = await createTestEditor([Essentials, Paragraph, Bold, Bookmark, CopyAnchorLinkButton], {- clipboard: { copy: vi.fn(), copyHtml }+ clipboard: { copy: vi.fn(), copyHtml },+ referenceLink: { getTitle: async () => "Some title", getTitleSync: getReferenceLinkTitleSync }});});@@ -44,7 +44,7 @@ describe("CopyAnchorLinkButton", () => {getButton().fire("execute");const href = "#root/noteAbc?bookmark=my%20anchor";- expect(getReferenceLinkTitleSync).toHaveBeenCalledWith(href);+ expect(getReferenceLinkTitleSync).toHaveBeenCalledWith(href, undefined);expect(copyHtml).toHaveBeenCalledWith(`<a class="reference-link" href="${href}">Some title</a>`, href);});diff --git a/packages/ckeditor5/src/plugins/copy_anchor_link.ts b/packages/ckeditor5/src/plugins/copy_anchor_link.tsindex 97fcceb412..1ca7282d2c 100644--- a/packages/ckeditor5/src/plugins/copy_anchor_link.ts+++ b/packages/ckeditor5/src/plugins/copy_anchor_link.ts@@ -1,6 +1,7 @@import { ButtonView, Plugin } from "ckeditor5";import copyIcon from "../icons/copy.svg?raw";import { escapeHtml } from "../utils";+import { getReferenceTitleSync } from "./referencelink";/*** Adds a "Copy anchor link" button to the bookmark/anchor widget toolbar.@@ -38,7 +39,7 @@ export default class CopyAnchorLinkButton extends Plugin {if (noteId && bookmarkId) {const href = `#root/${noteId}?bookmark=${encodeURIComponent(bookmarkId)}`;- const title = glob.getReferenceLinkTitleSync(href);+ const title = getReferenceTitleSync(editor, href);const html = `<a class="reference-link" href="${escapeHtml(href)}">${escapeHtml(title)}</a>`;editor.config.get("clipboard")?.copyHtml?.(html, href);}diff --git a/packages/ckeditor5/src/plugins/find_in_link_widgets.spec.ts b/packages/ckeditor5/src/plugins/find_in_link_widgets.spec.tsindex f26caede85..3777559946 100644--- a/packages/ckeditor5/src/plugins/find_in_link_widgets.spec.ts+++ b/packages/ckeditor5/src/plugins/find_in_link_widgets.spec.ts@@ -43,9 +43,7 @@ describe("FindInLinkWidgets", () => {renderLinkMention: vi.fn((container: HTMLElement, metadata: LinkEmbedMetadata) => {appendText(container, metadata.title || safeHostname(metadata.url));})- }),- getReferenceLinkTitle: vi.fn(async () => "Reference match"),- getReferenceLinkTitleSync: vi.fn(() => "Reference match")+ })});editor = await createTestEditor([@@ -56,7 +54,12 @@ describe("FindInLinkWidgets", () => {LinkEmbedEditing,FindAndReplaceEditing,FindInLinkWidgets- ]);+ ], {+ referenceLink: {+ getTitle: vi.fn(async () => "Reference match"),+ getTitleSync: vi.fn(() => "Reference match")+ }+ });});it("finds text and all rendered link widgets in document order", () => {diff --git a/packages/ckeditor5/src/plugins/inline_icon/inline_icon.spec.ts b/packages/ckeditor5/src/plugins/inline_icon/inline_icon.spec.tsindex 2f82536cdc..67d37bd63d 100644--- a/packages/ckeditor5/src/plugins/inline_icon/inline_icon.spec.ts+++ b/packages/ckeditor5/src/plugins/inline_icon/inline_icon.spec.ts@@ -102,12 +102,12 @@ describe("a reference link pasted from a rendered page", () => {// beside the link.it("loses the icon the renderer drew inside it, leaving the link alone", async () => {installGlobMock({- getComponentByEl: () => ({ loadReferenceLinkTitle: () => Promise.resolve() }),- getReferenceLinkTitleSync: () => "Some note",- getReferenceLinkTitle: async () => "Some note"+ getComponentByEl: () => ({ loadReferenceLinkTitle: () => Promise.resolve() })});- const editor = await createTestEditor([ Paragraph, Link, ReferenceLink, InlineIcon ]);+ const editor = await createTestEditor([ Paragraph, Link, ReferenceLink, InlineIcon ], {+ referenceLink: { getTitle: async () => "Some note", getTitleSync: () => "Some note" }+ });editor.setData(`<p>See <a class="reference-link" href="#root/abc">`+ `<span><span class="tn-icon bx bx-file"></span>Some note</span></a> for more.</p>`);diff --git a/packages/ckeditor5/src/plugins/internallink.spec.ts b/packages/ckeditor5/src/plugins/internallink.spec.tsindex f741f7379f..f2a569ee02 100644--- a/packages/ckeditor5/src/plugins/internallink.spec.ts+++ b/packages/ckeditor5/src/plugins/internallink.spec.ts@@ -75,14 +75,16 @@ describe("InternalLinkPlugin", () => {describe("the link at the selection", () => {let editor: ClassicEditor;+ let getTitle: ReturnType<typeof vi.fn>;beforeEach(async () => {installGlobMock({- getComponentByEl: () => ({ loadReferenceLinkTitle: async () => undefined }),- getReferenceLinkTitle: async () => "Target",- getReferenceLinkTitleSync: () => "Target"+ getComponentByEl: () => ({ loadReferenceLinkTitle: async () => undefined })+ });+ getTitle = vi.fn(async () => "Target");+ editor = await createTestEditor([Essentials, Paragraph, Bold, LinkEditing, InternalLinkPlugin], {+ referenceLink: { getTitle, getTitleSync: () => "Target" }});- editor = await createTestEditor([Essentials, Paragraph, Bold, LinkEditing, InternalLinkPlugin]);});const LINKED = "<paragraph>a <$text bold=\"true\" linkHref=\"https://a.example\">fo[]o</$text> b"@@ -134,13 +136,7 @@ describe("the link at the selection", () => {editor.execute("undo");expect(data()).toBe(original);- installGlobMock({- getComponentByEl: () => ({ loadReferenceLinkTitle: async () => undefined }),- getReferenceLinkTitle: async () => {- throw new Error("not found");- },- getReferenceLinkTitleSync: () => "Target"- });+ getTitle.mockRejectedValue(new Error("not found"));setModelData(editor.model, LINKED);const replacing = replaceLinkAtSelection(editor, "#root/abc", null);await expect(replacing).rejects.toThrow("not found");diff --git a/packages/ckeditor5/src/plugins/internallink.ts b/packages/ckeditor5/src/plugins/internallink.tsindex ee7c5e86ce..b559946e2b 100644--- a/packages/ckeditor5/src/plugins/internallink.ts+++ b/packages/ckeditor5/src/plugins/internallink.ts@@ -3,7 +3,7 @@ import {} from 'ckeditor5';import type { Editor, ModelRange } from 'ckeditor5';import internalLinkIcon from '../icons/trilium.svg?raw';-import ReferenceLink, { referenceAttributes } from './referencelink';+import ReferenceLink, { getReferenceTitle, referenceAttributes } from './referencelink';export const COMMAND_NAME = 'insertInternalLink';@@ -109,7 +109,7 @@ export function getLinkAtSelection(editor: Editor): { href: string; text: string/*** Replaces the link around the selection with `text` linking to `href`, keeping the formatting of* its start, or with a reference to the note at `href` when `text` is `null`. A reference replaces- * the link once `glob.getReferenceLinkTitle()` resolves, in one undo step with the removal, and+ * the link once `getReferenceTitle()` resolves, in one undo step with the removal, and* takes the caret along only if the user has not moved it in the meantime.*/export async function replaceLinkAtSelection(editor: Editor, href: string, text: string | null) {@@ -128,7 +128,7 @@ export async function replaceLinkAtSelection(editor: Editor, href: string, text:};selection.on('change:range', onSelectionChange);try {- const title = await glob.getReferenceLinkTitle(href);+ const title = await getReferenceTitle(editor, href);if (range.root.rootName === '$graveyard') {return;}diff --git a/packages/ckeditor5/src/plugins/mention_customization.spec.ts b/packages/ckeditor5/src/plugins/mention_customization.spec.tsindex 3a5ffbc338..cd0642bdfa 100644--- a/packages/ckeditor5/src/plugins/mention_customization.spec.ts+++ b/packages/ckeditor5/src/plugins/mention_customization.spec.ts@@ -21,9 +21,7 @@ describe("MentionCustomization", () => {installGlobMock({getComponentByEl: () => ({loadReferenceLinkTitle: vi.fn(async () => {})- }),- getReferenceLinkTitle: vi.fn(async () => "Some title"),- getReferenceLinkTitleSync: () => "Some title"+ })});editor = await createTestEditor([@@ -33,7 +31,12 @@ describe("MentionCustomization", () => {TriliumMentionUI,ReferenceLink,MentionCustomization- ]);+ ], {+ referenceLink: {+ getTitle: vi.fn(async () => "Some title"),+ getTitleSync: () => "Some title"+ }+ });});it("loads the plugin, requires the mention editing/UI pair and overrides the mention command", () => {@@ -69,7 +72,7 @@ describe("MentionCustomization", () => {});// The referenceLink command inserts the reference element only after- // glob.getReferenceLinkTitle resolves.+ // referenceLink.getTitle resolves.await Promise.resolve();await Promise.resolve();@@ -101,7 +104,7 @@ describe("MentionCustomization", () => {});// The referenceLink command inserts the reference element only after- // glob.getReferenceLinkTitle resolves.+ // referenceLink.getTitle resolves.await Promise.resolve();await Promise.resolve();diff --git a/packages/ckeditor5/src/plugins/referencelink.spec.ts b/packages/ckeditor5/src/plugins/referencelink.spec.tsindex 0a65d1d585..40da1f0b1c 100644--- a/packages/ckeditor5/src/plugins/referencelink.spec.ts+++ b/packages/ckeditor5/src/plugins/referencelink.spec.ts@@ -16,12 +16,12 @@ describe("ReferenceLink", () => {getReferenceLinkTitleSync = vi.fn(() => "Some title");loadReferenceLinkTitle = vi.fn(async () => undefined);installGlobMock({- getComponentByEl: () => ({ loadReferenceLinkTitle }),- getReferenceLinkTitle,- getReferenceLinkTitleSync+ getComponentByEl: () => ({ loadReferenceLinkTitle })});- editor = await createTestEditor([Essentials, Paragraph, LinkEditing, ReferenceLink]);+ editor = await createTestEditor([Essentials, Paragraph, LinkEditing, ReferenceLink], {+ referenceLink: { getTitle: getReferenceLinkTitle, getTitleSync: getReferenceLinkTitleSync }+ });});it("loads the plugin, registers the schema and the command", () => {@@ -284,6 +284,17 @@ describe("ReferenceLink", () => {expect(data).toContain("Some title");});+ it("titles a reference with its stored title, or else its href, without referenceLink", async () => {+ const plainEditor = await createTestEditor([Essentials, Paragraph, LinkEditing, ReferenceLink]);++ plainEditor.setData('<p><a class="reference-link" href="#root/noteAbc">Stored</a></p>');+ expect(plainEditor.getData()).toContain(">Stored</a>");++ setModelData(plainEditor.model, "<paragraph>[]</paragraph>");+ plainEditor.execute("referenceLink", { href: "#root/noteNew" });+ await vi.waitFor(() => expect(plainEditor.getData()).toContain('href="#root/noteNew">#root/noteNew</a>'));+ });+it("maps a view position inside the reference widget to a model position outside of it", () => {editor.setData('<p><a class="reference-link" href="#root/noteAbc">Some title</a></p>');@@ -359,9 +370,7 @@ describe("ReferenceLink", () => {el.classList.toggle("reference-link-missing", href === "#root/gone");});installGlobMock({- getComponentByEl: () => ({ loadReferenceLinkTitle, fixReferenceLink }),- getReferenceLinkTitle,- getReferenceLinkTitleSync+ getComponentByEl: () => ({ loadReferenceLinkTitle, fixReferenceLink })});editor.setData('<p><a class="reference-link" href="#root/noteAbc">Fine</a>'@@ -395,9 +404,7 @@ describe("ReferenceLink", () => {el.classList.add("reference-link-missing");});installGlobMock({- getComponentByEl: () => ({ loadReferenceLinkTitle, fixReferenceLink }),- getReferenceLinkTitle,- getReferenceLinkTitleSync+ getComponentByEl: () => ({ loadReferenceLinkTitle, fixReferenceLink })});editor.setData('<p><a class="reference-link" href="#root/gone"></a><a href="https://x.org">x</a></p>'diff --git a/packages/ckeditor5/src/plugins/referencelink.ts b/packages/ckeditor5/src/plugins/referencelink.tsindex 7619cd616e..cd775e5fa0 100644--- a/packages/ckeditor5/src/plugins/referencelink.ts+++ b/packages/ckeditor5/src/plugins/referencelink.ts@@ -1,5 +1,5 @@import {- ClickObserver, Command, LinkEditing, ModelElement, ModelLivePosition, Plugin, toWidget,+ ClickObserver, Command, type Editor, LinkEditing, ModelElement, ModelLivePosition, Plugin, toWidget,type ViewDocumentClickEvent, ViewElement, viewToModelPositionOutsideModelElement, Widget} from "ckeditor5";@@ -22,7 +22,7 @@ class ReferenceLinkCommand extends Command {const editor = this.editor;if (replace) {- glob.getReferenceLinkTitle(href).then(title => {+ getReferenceTitle(editor, href).then(title => {const root = replace.root;if (!root.is('rootElement') || root.rootName === '$graveyard') {return;@@ -49,7 +49,7 @@ class ReferenceLinkCommand extends Command {const insertionPosition = ModelLivePosition.fromPosition(selectionPosition, 'toPrevious');// make sure the referenced note is in cache before adding the reference element- glob.getReferenceLinkTitle(href).then(title => {+ getReferenceTitle(editor, href).then(title => {if (insertionPosition.root.rootName === '$graveyard') {// The context the user picked in was deleted while the title loaded.return;@@ -286,7 +286,7 @@ export class ReferenceLinkEditing extends Plugin {// A note deleted while the editor is open keeps the title saved last, not the loaded one.const storedTitle = this._savedTitles.get( modelItem )?? modelItem.getAttribute('storedTitle') as string | undefined;- const title = glob.getReferenceLinkTitleSync(href, storedTitle);+ const title = getReferenceTitleSync(editor, href, storedTitle);this._savedTitles.set( modelItem, title );const innerText = viewWriter.createText(title);@@ -298,6 +298,24 @@ export class ReferenceLinkEditing extends Plugin {}}+/**+ * The title of the note or attachment `href` points to, as `referenceLink.getTitle` resolves it.+ * Without that config entry, the title is `href` itself.+ */+export function getReferenceTitle( editor: Editor, href: string ): Promise<string> {+ const getTitle = editor.config.get( 'referenceLink' )?.getTitle;+ return getTitle ? getTitle( href ) : Promise.resolve( href );+}++/**+ * The title of the note or attachment `href` points to, as `referenceLink.getTitleSync` reads+ * it. Without that config entry, the title is `storedTitle`, or else `href`.+ */+export function getReferenceTitleSync( editor: Editor, href: string, storedTitle?: string ): string {+ const getTitleSync = editor.config.get( 'referenceLink' )?.getTitleSync;+ return getTitleSync ? getTitleSync( href, storedTitle ) : storedTitle ?? href;+}+/** The attributes of a `reference` to `href`, with `storedTitle` when there is one to keep. */export function referenceAttributes( href: string | undefined, storedTitle: string | undefined ) {return storedTitle ? { href, storedTitle } : { href };@@ -331,4 +349,16 @@ declare module "ckeditor5" {interface PluginsMap {[ReferenceLinkEditing.pluginName]: ReferenceLinkEditing;}++ interface EditorConfig {+ referenceLink?: {+ /** Resolves the title of the note or attachment `href` points to, loading it if needed. */+ getTitle( href: string ): Promise<string>;+ /**+ * The title of the note or attachment `href` points to, from what is already loaded.+ * `storedTitle` is the title the saved content holds, for a note that is not loaded.+ */+ getTitleSync( href: string, storedTitle?: string ): string;+ };+ }}