Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

feat(open-knowledge): open .base/.canvas as text + harden "Open file" affordance (#1637)

mike-inkeep238e35e41f6d
diff --git a/.changeset/open-base-canvas-as-text.md b/.changeset/open-base-canvas-as-text.md
new file mode 100644
index 000000000..bb6f0be11
--- /dev/null
+++ b/.changeset/open-base-canvas-as-text.md
@@ -0,0 +1,9 @@
+---
+"@inkeep/open-knowledge": patch
+"@inkeep/open-knowledge-core": patch
+"@inkeep/open-knowledge-server": patch
+"@inkeep/open-knowledge-app": patch
+"@inkeep/open-knowledge-desktop": patch
+---
+
+Open `.base` and `.canvas` files (Obsidian Bases / Canvas) directly in the read-only text viewer. Previously, clicking a `[[file.base]]` or `[[file.canvas]]` wiki-link opened a chooser pane; clicking "Open file" from the chooser then replaced the editor view with a raw `415` JSON error envelope from the API. Now both file types open immediately in the built-in text viewer (`.canvas` with JSON syntax highlighting) — no chooser, no broken "Open file". The "Open file" affordance for all other downloadable types (`.docx`, `.zip`, etc.) is also hardened: it now routes through the sanctioned asset-dispatch path (OS-handoff on desktop, new tab on web) instead of a same-frame navigation to the asset API.
diff --git a/packages/app/src/components/AssetPreview.dom.test.tsx b/packages/app/src/components/AssetPreview.dom.test.tsx
index fa5ef4b11..2fb58153b 100644
--- a/packages/app/src/components/AssetPreview.dom.test.tsx
+++ b/packages/app/src/components/AssetPreview.dom.test.tsx
@@ -78,10 +78,11 @@ describe('AssetPreview — image loading-state placeholder (PRD-6638)', () => {
test('renders the "Open file" fallback for mediaKind=null', () => {
const { container } = render(<AssetPreview assetPath="assets/data.csv" mediaKind={null} />);
- const anchor = container.querySelector('a[href]');
- expect(anchor).not.toBeNull();
- expect(anchor?.getAttribute('href')).toContain('data.csv');
- expect(anchor?.textContent).toMatch(/open file/i);
+ const openFileBtn = Array.from(container.querySelectorAll('button')).find((b) =>
+ /open file/i.test(b.textContent ?? ''),
+ );
+ expect(openFileBtn).not.toBeNull();
+ expect(container.querySelector('a[href*="/api/asset"]')).toBeNull();
expect(container.querySelector('img')).toBeNull();
expect(container.querySelector('audio')).toBeNull();
expect(container.querySelector('video')).toBeNull();
diff --git a/packages/app/src/components/AssetPreview.text-dispatch.dom.test.tsx b/packages/app/src/components/AssetPreview.text-dispatch.dom.test.tsx
index c1839bfe6..9d138ceea 100644
--- a/packages/app/src/components/AssetPreview.text-dispatch.dom.test.tsx
+++ b/packages/app/src/components/AssetPreview.text-dispatch.dom.test.tsx
@@ -1,11 +1,17 @@
-import { afterEach, describe, expect, test } from 'bun:test';
+import { afterEach, describe, expect, mock, test } from 'bun:test';
import { cleanup, fireEvent, render } from '@testing-library/react';
+const dispatchAssetClickStub = mock(async () => {});
+mock.module('@/editor/asset-dispatch', () => ({
+ dispatchAssetClick: dispatchAssetClickStub,
+}));
+
const { AssetPreview } = await import('./AssetPreview.tsx');
describe('AssetPreview — text-viewer dispatch', () => {
afterEach(() => {
cleanup();
+ dispatchAssetClickStub.mockClear();
});
test('mediaKind=text on a json asset mounts TextViewer (not the fallback)', () => {
@@ -15,13 +21,44 @@ describe('AssetPreview — text-viewer dispatch', () => {
expect(container.querySelector('[data-testid="asset-preview-open-as-text"]')).toBeNull();
});
- test('fallback pane exposes both "Open file" + "Open with built-in text editor"', () => {
+ test('mediaKind=text mounts TextViewer for .base (Obsidian Bases)', () => {
+ const { container } = render(
+ <AssetPreview assetPath="vault/Characters.base" mediaKind="text" />,
+ );
+ expect(container.querySelector('[data-text-viewer]')).not.toBeNull();
+ expect(container.querySelector('[data-text-viewer-extension="base"]')).not.toBeNull();
+ expect(container.querySelector('[data-testid="asset-preview-open-as-text"]')).toBeNull();
+ });
+
+ test('mediaKind=text mounts TextViewer for .canvas (Obsidian Canvas)', () => {
+ const { container } = render(<AssetPreview assetPath="vault/Board.canvas" mediaKind="text" />);
+ expect(container.querySelector('[data-text-viewer]')).not.toBeNull();
+ expect(container.querySelector('[data-text-viewer-extension="canvas"]')).not.toBeNull();
+ expect(container.querySelector('[data-testid="asset-preview-open-as-text"]')).toBeNull();
+ });
+
+ test('fallback pane has no raw <a href="/api/asset"> same-frame nav (FR2)', () => {
const { container } = render(<AssetPreview assetPath="docs/data.zip" mediaKind={null} />);
- expect(container.querySelector('a[href*="/api/asset"]')).not.toBeNull();
+ expect(container.querySelector('a[href*="/api/asset"]')).toBeNull();
expect(container.querySelector('[data-testid="asset-preview-open-as-text"]')).not.toBeNull();
expect(container.querySelector('[data-text-viewer]')).toBeNull();
});
+ test('"Open file" button calls dispatchAssetClick (not window navigation)', () => {
+ const { container } = render(<AssetPreview assetPath="docs/report.docx" mediaKind={null} />);
+ const openFileBtn = Array.from(container.querySelectorAll('button')).find((b) =>
+ /open file/i.test(b.textContent ?? ''),
+ );
+ expect(openFileBtn).not.toBeNull();
+ fireEvent.click(openFileBtn as HTMLButtonElement);
+ expect(dispatchAssetClickStub).toHaveBeenCalledTimes(1);
+ expect(dispatchAssetClickStub.mock.calls[0]?.[0]).toMatchObject({
+ url: expect.stringContaining('/api/asset?path='),
+ projectRelPath: 'docs/report.docx',
+ ext: 'docx',
+ });
+ });
+
test('clicking "Open with built-in text editor" flips into the text branch', () => {
const { container } = render(<AssetPreview assetPath="docs/report.pdf" mediaKind={null} />);
const btn = container.querySelector(
diff --git a/packages/app/src/components/AssetPreview.tsx b/packages/app/src/components/AssetPreview.tsx
index afca9675a..d2c8c70e7 100644
--- a/packages/app/src/components/AssetPreview.tsx
+++ b/packages/app/src/components/AssetPreview.tsx
@@ -4,6 +4,7 @@ import { useState } from 'react';
import { TextViewer } from '@/components/TextViewer';
import { Button } from '@/components/ui/button';
import { LoadingImage } from '@/components/ui/loading-image';
+import { dispatchAssetClick } from '@/editor/asset-dispatch';
import { Pdf } from '@/editor/components/Pdf';
interface AssetPreviewProps {
@@ -73,10 +74,20 @@ export function AssetPreview({ assetPath, mediaKind }: AssetPreviewProps) {
</div>
<div className="max-w-full break-words font-medium text-sm">{fileName}</div>
<div className="flex flex-wrap items-center justify-center gap-2">
- <Button asChild variant="outline" size="sm">
- <a href={src}>
- <Trans>Open file</Trans>
- </a>
+ <Button
+ variant="outline"
+ size="sm"
+ onClick={() => {
+ void dispatchAssetClick({
+ url: src,
+ projectRelPath: assetPath,
+ ext: rawExtension.toLowerCase(),
+ title: fileName,
+ forceOsDelegation: false,
+ });
+ }}
+ >
+ <Trans>Open file</Trans>
</Button>
<Button
variant="outline"
diff --git a/packages/app/src/components/TextViewer.tsx b/packages/app/src/components/TextViewer.tsx
index 99b910692..e29ca81e6 100644
--- a/packages/app/src/components/TextViewer.tsx
+++ b/packages/app/src/components/TextViewer.tsx
@@ -26,6 +26,7 @@ const lightTheme = basicLightInit({
function pickLanguageExtension(extension: string): Language | null {
switch (extension.toLowerCase()) {
case 'json':
+ case 'canvas':
return json().language;
case 'toml':
return StreamLanguage.define(toml);
diff --git a/packages/app/src/editor/extensions/link-resolution.test.ts b/packages/app/src/editor/extensions/link-resolution.test.ts
index 7b952af38..6f81c39ba 100644
--- a/packages/app/src/editor/extensions/link-resolution.test.ts
+++ b/packages/app/src/editor/extensions/link-resolution.test.ts
@@ -121,6 +121,26 @@ describe('computeLinkResolutionState', () => {
expect(computeLinkResolutionState('/test/nonexistent.png', 'README', cache)).toBe('unresolved');
});
+ test('.canvas href resolves to asset when index contains it', () => {
+ const cache = makeCache({ pages: [], assetPaths: ['vault/Board.canvas'] });
+ expect(computeLinkResolutionState('./Board.canvas', 'vault/note', cache)).toBe('asset');
+ });
+
+ test('.canvas href is unresolved when asset index lacks it', () => {
+ const cache = makeCache({ pages: [], assetPaths: [] });
+ expect(computeLinkResolutionState('./Board.canvas', 'vault/note', cache)).toBe('unresolved');
+ });
+
+ test('.base href resolves to asset when index contains it', () => {
+ const cache = makeCache({ pages: [], assetPaths: ['vault/Characters.base'] });
+ expect(computeLinkResolutionState('./Characters.base', 'vault/note', cache)).toBe('asset');
+ });
+
+ test('.base href is unresolved when asset index lacks it', () => {
+ const cache = makeCache({ pages: [], assetPaths: [] });
+ expect(computeLinkResolutionState('./Characters.base', 'vault/note', cache)).toBe('unresolved');
+ });
+
test('doc href with cache, target is folder → folder', () => {
const cache = makeCache({ pages: [], folderPaths: ['subfolder'] });
expect(computeLinkResolutionState('./subfolder', 'README', cache)).toBe('folder');
diff --git a/packages/core/src/constants/upload.test.ts b/packages/core/src/constants/upload.test.ts
index ad458a765..0049fa3bf 100644
--- a/packages/core/src/constants/upload.test.ts
+++ b/packages/core/src/constants/upload.test.ts
@@ -1,9 +1,13 @@
import { describe, expect, test } from 'bun:test';
import {
+ ASSET_EXTENSIONS,
AUDIO_EXTENSIONS,
FILE_ATTACHMENT_EXTENSIONS,
IMAGE_EXTENSIONS,
+ INLINE_RENDERABLE_EXTENSIONS,
+ LINKABLE_ASSET_EXTENSIONS,
mediaKindForSidebarAssetExtension,
+ TEXT_VIEWER_FALLBACK_EXTENSIONS,
VIDEO_EXTENSIONS,
WIKI_EMBED_EXTENSIONS,
} from './upload.ts';
@@ -102,6 +106,46 @@ describe('mediaKindForSidebarAssetExtension', () => {
expect(mediaKindForSidebarAssetExtension(ext)).toBe(expected);
});
+ test.each([
+ ['base', 'text'],
+ ['canvas', 'text'],
+ ] as const)('classifies %s → %s (text-viewer fallback set)', (ext, expected) => {
+ expect(mediaKindForSidebarAssetExtension(ext)).toBe(expected);
+ });
+
+ test('base and canvas are absent from ASSET_EXTENSIONS and INLINE_RENDERABLE_EXTENSIONS', () => {
+ expect(ASSET_EXTENSIONS.has('base')).toBe(false);
+ expect(ASSET_EXTENSIONS.has('canvas')).toBe(false);
+ expect(INLINE_RENDERABLE_EXTENSIONS.has('base')).toBe(false);
+ expect(INLINE_RENDERABLE_EXTENSIONS.has('canvas')).toBe(false);
+ });
+
+ test('TEXT_VIEWER_FALLBACK_EXTENSIONS contains exactly base and canvas', () => {
+ expect(TEXT_VIEWER_FALLBACK_EXTENSIONS.has('base')).toBe(true);
+ expect(TEXT_VIEWER_FALLBACK_EXTENSIONS.has('canvas')).toBe(true);
+ expect(TEXT_VIEWER_FALLBACK_EXTENSIONS.size).toBe(2);
+ });
+
+ describe('LINKABLE_ASSET_EXTENSIONS', () => {
+ test('is a strict superset of ASSET_EXTENSIONS', () => {
+ for (const ext of ASSET_EXTENSIONS) {
+ expect(LINKABLE_ASSET_EXTENSIONS.has(ext)).toBe(true);
+ }
+ expect(LINKABLE_ASSET_EXTENSIONS.size).toBeGreaterThan(ASSET_EXTENSIONS.size);
+ });
+
+ test('contains base and canvas (text-viewer-fallback members)', () => {
+ expect(LINKABLE_ASSET_EXTENSIONS.has('base')).toBe(true);
+ expect(LINKABLE_ASSET_EXTENSIONS.has('canvas')).toBe(true);
+ });
+
+ test('size equals ASSET_EXTENSIONS + TEXT_VIEWER_FALLBACK_EXTENSIONS', () => {
+ expect(LINKABLE_ASSET_EXTENSIONS.size).toBe(
+ ASSET_EXTENSIONS.size + TEXT_VIEWER_FALLBACK_EXTENSIONS.size,
+ );
+ });
+ });
+
test('lock files dispatch to TextViewer regardless of stem prefix', () => {
expect(mediaKindForSidebarAssetExtension('lock')).toBe('text');
expect(mediaKindForSidebarAssetExtension('.lock')).toBe('text');
diff --git a/packages/core/src/constants/upload.ts b/packages/core/src/constants/upload.ts
index 6a119a08c..a925df739 100644
--- a/packages/core/src/constants/upload.ts
+++ b/packages/core/src/constants/upload.ts
@@ -314,6 +314,13 @@ assertSubset(
INLINE_RENDERABLE_EXTENSIONS,
);
+export const TEXT_VIEWER_FALLBACK_EXTENSIONS: ReadonlySet<string> = new Set(['base', 'canvas']);
+
+export const LINKABLE_ASSET_EXTENSIONS: ReadonlySet<string> = new Set([
+ ...ASSET_EXTENSIONS,
+ ...TEXT_VIEWER_FALLBACK_EXTENSIONS,
+]);
+
export function mediaKindForSidebarAssetExtension(ext: string): InlineAssetMediaKind | null {
const normalized = ext.toLowerCase().replace(/^\./, '');
if (SIDEBAR_IMAGE_ASSET_EXTENSIONS.has(normalized)) return 'image';
@@ -321,5 +328,6 @@ export function mediaKindForSidebarAssetExtension(ext: string): InlineAssetMedia
if (SIDEBAR_AUDIO_ASSET_EXTENSIONS.has(normalized)) return 'audio';
if (SIDEBAR_PDF_ASSET_EXTENSIONS.has(normalized)) return 'pdf';
if (SIDEBAR_TEXT_ASSET_EXTENSIONS.has(normalized)) return 'text';
+ if (TEXT_VIEWER_FALLBACK_EXTENSIONS.has(normalized)) return 'text';
return null;
}
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
index 38ce197bf..a6fa609e2 100644
--- a/packages/core/src/index.ts
+++ b/packages/core/src/index.ts
@@ -213,6 +213,7 @@ export {
IMAGE_EXTENSIONS,
INLINE_RENDERABLE_EXTENSIONS,
type InlineAssetMediaKind,
+ LINKABLE_ASSET_EXTENSIONS,
mediaKindForSidebarAssetExtension,
PDF_EXTENSIONS,
SIDEBAR_AUDIO_ASSET_EXTENSIONS,
@@ -221,6 +222,7 @@ export {
SIDEBAR_RENDERABLE_ASSET_EXTENSIONS,
SIDEBAR_TEXT_ASSET_EXTENSIONS,
SIDEBAR_VIDEO_ASSET_EXTENSIONS,
+ TEXT_VIEWER_FALLBACK_EXTENSIONS,
VIDEO_EXTENSIONS,
WIKI_EMBED_EXTENSIONS,
} from './constants/upload.ts';
diff --git a/packages/server/src/api-extension.ts b/packages/server/src/api-extension.ts
index 86109d18d..4dc61aa47 100644
--- a/packages/server/src/api-extension.ts
+++ b/packages/server/src/api-extension.ts
@@ -87,6 +87,7 @@ import {
type InlineAssetMediaKind,
InstallSkillRequestSchema,
InstallSkillSuccessSchema,
+ LINKABLE_ASSET_EXTENSIONS,
type LifecycleStatus,
LinkGraphSuccessSchema,
LocalOpAuthEmptySuccessSchema,
@@ -1028,9 +1029,7 @@ export async function* streamShowAllEntries(
}
const assetExt = synthesizeShowAllAssetExt(entry.name);
- const mediaKind: InlineAssetMediaKind | null = ASSET_EXTENSIONS.has(assetExt)
- ? mediaKindForSidebarAssetExtension(assetExt)
- : null;
+ const mediaKind: InlineAssetMediaKind | null = mediaKindForSidebarAssetExtension(assetExt);
emitted += 1;
yield {
kind: 'asset',
@@ -2256,7 +2255,7 @@ export function createApiExtension(options: ApiExtensionOptions): Extension {
const candidates = entries
.filter((entry) => entry.isFile() && entry.name.startsWith(`${stem}.`))
.map((entry) => (parent ? `${parent}/${entry.name}` : entry.name))
- .filter((candidate) => isSupportedAssetFile(candidate, ASSET_EXTENSIONS));
+ .filter((candidate) => isSupportedAssetFile(candidate, LINKABLE_ASSET_EXTENSIONS));
if (candidates.length === 1) return { path: candidates[0], ambiguous: false };
return { path: assetPath, ambiguous: candidates.length > 1 };
@@ -2355,8 +2354,8 @@ export function createApiExtension(options: ApiExtensionOptions): Extension {
);
}
if (
- !isSupportedAssetFile(fromPath, ASSET_EXTENSIONS) ||
- !isSupportedAssetFile(destinationAssetPath, ASSET_EXTENSIONS)
+ !isSupportedAssetFile(fromPath, LINKABLE_ASSET_EXTENSIONS) ||
+ !isSupportedAssetFile(destinationAssetPath, LINKABLE_ASSET_EXTENSIONS)
) {
throw new ManagedRenameInvalidRequestError(
'Asset operations require supported asset extensions.',
diff --git a/packages/server/src/asset-references.test.ts b/packages/server/src/asset-references.test.ts
index 941eecb04..4af06367b 100644
--- a/packages/server/src/asset-references.test.ts
+++ b/packages/server/src/asset-references.test.ts
@@ -94,6 +94,43 @@ describe('asset reference extraction', () => {
expect(isLocalAssetReferenceHref('./doc.md')).toBe(false);
});
+ test('classifies .base and .canvas hrefs as local asset references', () => {
+ expect(isLocalAssetReferenceHref('./Characters.base')).toBe(true);
+ expect(isLocalAssetReferenceHref('Characters.base')).toBe(true);
+ expect(isLocalAssetReferenceHref('./vault/Board.canvas')).toBe(true);
+ });
+
+ test('resolves .base and .canvas hrefs to disk paths', () =>
+ withFixture((dir) => {
+ mkdirSync(join(dir, 'vault'));
+ writeFileSync(join(dir, 'vault', 'Characters.base'), 'fields:\n - name\n');
+ writeFileSync(join(dir, 'vault', 'Board.canvas'), '{"nodes":[],"edges":[]}\n');
+
+ expect(
+ resolveReferencedAssetPath({
+ contentDir: dir,
+ fromDocName: 'vault/note',
+ href: './Characters.base',
+ }),
+ ).toBe(realpathSync(resolve(dir, 'vault/Characters.base')));
+
+ expect(
+ resolveReferencedAssetPath({
+ contentDir: dir,
+ fromDocName: 'vault/note',
+ href: './Board.canvas',
+ }),
+ ).toBe(realpathSync(resolve(dir, 'vault/Board.canvas')));
+
+ expect(
+ resolveReferencedAssetPath({
+ contentDir: dir,
+ fromDocName: 'vault/note',
+ href: 'Board.canvas',
+ }),
+ ).toBe(realpathSync(resolve(dir, 'vault/Board.canvas')));
+ }));
+
test('classifies remote or opaque hrefs', () => {
expect(isRemoteOrOpaqueHref('#section')).toBe(true);
expect(isRemoteOrOpaqueHref('//cdn.example.com/photo.png')).toBe(true);
diff --git a/packages/server/src/asset-references.ts b/packages/server/src/asset-references.ts
index 16e37af5a..189ec56b0 100644
--- a/packages/server/src/asset-references.ts
+++ b/packages/server/src/asset-references.ts
@@ -1,9 +1,9 @@
import { realpathSync, type Stats, statSync } from 'node:fs';
import { extname, normalize, resolve, sep } from 'node:path';
import {
- ASSET_EXTENSIONS,
createCodeFenceTracker,
type InlineAssetMediaKind,
+ LINKABLE_ASSET_EXTENSIONS,
mediaKindForSidebarAssetExtension,
resolveAssetProjectPath,
} from '@inkeep/open-knowledge-core';
@@ -46,7 +46,7 @@ export function stripHrefDecorations(rawHref: string): string {
export function isLocalAssetReferenceHref(rawHref: string): boolean {
const href = stripHrefDecorations(rawHref);
if (!href || isRemoteOrOpaqueHref(href)) return false;
- return ASSET_EXTENSIONS.has(extname(href).slice(1).toLowerCase());
+ return LINKABLE_ASSET_EXTENSIONS.has(extname(href).slice(1).toLowerCase());
}
export function assetReferenceSignature(markdown: string | null): string {
@@ -142,7 +142,7 @@ function resolveReferencedAssetWithinContentDir(args: {
const href = decodeHrefPath(args.href);
if (!href || isRemoteOrOpaqueHref(href)) return null;
const ext = extname(href).slice(1).toLowerCase();
- if (!ASSET_EXTENSIONS.has(ext)) return null;
+ if (!LINKABLE_ASSET_EXTENSIONS.has(ext)) return null;
const relativeAssetPath = resolveAssetProjectPath(href, args.fromDocName);
if (!relativeAssetPath) return null;
diff --git a/packages/server/src/asset-walk.test.ts b/packages/server/src/asset-walk.test.ts
index 0ad4bfcac..d3e2c4f1c 100644
--- a/packages/server/src/asset-walk.test.ts
+++ b/packages/server/src/asset-walk.test.ts
@@ -43,6 +43,18 @@ describe('seedBasenameIndex — initial walk (no filter)', () => {
expect(idx.resolveEmbed('arbitrary.xyz', 'docs/meeting.md')).toBeNull();
});
+ test('admits .base and .canvas files into the basename index', () => {
+ write('vault/note.md');
+ write('vault/Characters.base', 'fields:\n - name\n');
+ write('vault/Board.canvas', '{"nodes":[],"edges":[]}\n');
+
+ const idx = createBasenameIndex();
+ seedBasenameIndex({ contentDir, basenameIndex: idx });
+
+ expect(idx.resolveEmbed('Characters.base', 'vault/note.md')).toBe('vault/Characters.base');
+ expect(idx.resolveEmbed('Board.canvas', 'vault/note.md')).toBe('vault/Board.canvas');
+ });
+
test('empty contentDir produces empty index without throwing', () => {
const idx = createBasenameIndex();
seedBasenameIndex({ contentDir, basenameIndex: idx });
diff --git a/packages/server/src/asset-walk.ts b/packages/server/src/asset-walk.ts
index e47a9e09e..e844a9efc 100644
--- a/packages/server/src/asset-walk.ts
+++ b/packages/server/src/asset-walk.ts
@@ -1,7 +1,7 @@
import type { Dirent } from 'node:fs';
import { lstatSync, readdirSync, realpathSync, statSync } from 'node:fs';
import { join, relative, sep } from 'node:path';
-import { ASSET_EXTENSIONS, type BasenameIndex } from '@inkeep/open-knowledge-core';
+import { type BasenameIndex, LINKABLE_ASSET_EXTENSIONS } from '@inkeep/open-knowledge-core';
import type { ContentFilter } from './content-filter.ts';
import { isSupportedAssetFile } from './doc-extensions.ts';
@@ -83,7 +83,7 @@ export function seedBasenameIndex(opts: SeedOptions): void {
if (realStat.isDirectory()) walk(canonical);
else if (
realStat.isFile() &&
- isSupportedAssetFile(full, ASSET_EXTENSIONS) &&
+ isSupportedAssetFile(full, LINKABLE_ASSET_EXTENSIONS) &&
!opts.contentFilter?.isExcluded(rel)
) {
opts.basenameIndex.add(rel);
@@ -99,7 +99,7 @@ export function seedBasenameIndex(opts: SeedOptions): void {
}
if (
stat.isFile() &&
- isSupportedAssetFile(full, ASSET_EXTENSIONS) &&
+ isSupportedAssetFile(full, LINKABLE_ASSET_EXTENSIONS) &&
!opts.contentFilter?.isExcluded(rel)
) {
opts.basenameIndex.add(rel);
diff --git a/packages/server/src/content-filter.test.ts b/packages/server/src/content-filter.test.ts
index 0a24bab7c..1a009891f 100644
--- a/packages/server/src/content-filter.test.ts
+++ b/packages/server/src/content-filter.test.ts
@@ -654,6 +654,17 @@ describe('ContentFilter', () => {
expect(filter.isExcluded('docs/config.json')).toBe(false);
});
+ test('.base and .canvas files are admitted when a sibling .md exists', () => {
+ mkdirSync(join(projectDir, 'vault'));
+ writeFileSync(join(projectDir, 'vault', 'note.md'), '# Note');
+
+ const filter = createContentFilter({ projectDir, contentDir: projectDir });
+
+ expect(filter.isExcluded('vault/Characters.base')).toBe(false);
+ expect(filter.isExcluded('vault/Board.canvas')).toBe(false);
+ expect(filter.isExcluded('standalone/Characters.base')).toBe(true);
+ });
+
test('.okignore exclusion takes precedence over sibling-asset rule', () => {
mkdirSync(join(projectDir, 'docs'));
writeFileSync(join(projectDir, 'docs', 'guide.md'), '# Guide');
diff --git a/packages/server/src/content-filter.ts b/packages/server/src/content-filter.ts
index a963f5f35..b15cde888 100644
--- a/packages/server/src/content-filter.ts
+++ b/packages/server/src/content-filter.ts
@@ -4,7 +4,7 @@ import { readdir, readFile as readFileAsync } from 'node:fs/promises';
import { homedir } from 'node:os';
import { dirname, extname, join, relative, resolve } from 'node:path';
import { promisify } from 'node:util';
-import { ASSET_EXTENSIONS } from '@inkeep/open-knowledge-core';
+import { LINKABLE_ASSET_EXTENSIONS } from '@inkeep/open-knowledge-core';
import ignore, { type Ignore } from 'ignore';
import { isConfigDoc, isSystemDoc } from './cc1-broadcast.ts';
import { isSupportedDocFile, stripDocExtension } from './doc-extensions.ts';
@@ -383,7 +383,7 @@ export function createContentFilter(opts: ContentFilterOptions): ContentFilter {
if (isSupportedDocFile(relativePath)) return false;
const ext = extname(relativePath).slice(1).toLowerCase();
- if (ASSET_EXTENSIONS.has(ext)) {
+ if (LINKABLE_ASSET_EXTENSIONS.has(ext)) {
const dir = dirname(relativePath);
const normalizedDir = dir === '.' ? '' : dir;
if ((dirCount.get(normalizedDir) ?? 0) > 0) return false;
@@ -770,7 +770,7 @@ export async function createContentFilterAsync(opts: ContentFilterOptions): Prom
if (isRejectedByConfigurableRules(relativePath)) return true;
if (isSupportedDocFile(relativePath)) return false;
const ext = extname(relativePath).slice(1).toLowerCase();
- if (ASSET_EXTENSIONS.has(ext)) {
+ if (LINKABLE_ASSET_EXTENSIONS.has(ext)) {
const dir = dirname(relativePath);
const normalizedDir = dir === '.' ? '' : dir;
if ((dirCount.get(normalizedDir) ?? 0) > 0) return false;
diff --git a/packages/server/src/file-watcher.test.ts b/packages/server/src/file-watcher.test.ts
index c9024533c..830d4f1af 100644
--- a/packages/server/src/file-watcher.test.ts
+++ b/packages/server/src/file-watcher.test.ts
@@ -925,6 +925,42 @@ describe('file-watcher ContentFilter refcount hooks', () => {
expect(filter.isExcluded('fresh/pic.png')).toBe(false);
});
+ test('LINKABLE_ASSET_EXTENSIONS: .base file alongside .md dispatches asset-create event', async () => {
+ const filter = createContentFilter({
+ projectDir: tmpDir,
+ contentDir,
+ });
+
+ const newDir = resolve(contentDir, 'canvas-test');
+ mkdirSync(newDir);
+ const mdPath = resolve(newDir, 'note.md');
+ const assetPath = resolve(newDir, 'board.base');
+ writeFileSync(mdPath, '# Note\n');
+ writeFileSync(assetPath, '{}');
+
+ const collected: DiskEvent[] = [];
+ await handleRawEvents(
+ [
+ { type: 'create', path: mdPath },
+ { type: 'create', path: assetPath },
+ ],
+ contentDir,
+ filter,
+ new Map(),
+ new Map(),
+ async (e) => {
+ collected.push(e);
+ },
+ );
+
+ const kinds = collected.map((e) => e.kind).sort();
+ expect(kinds).toEqual(['asset-create', 'create']);
+ const asset = collected.find((e) => e.kind === 'asset-create');
+ if (asset?.kind === 'asset-create') {
+ expect(asset.relativePath).toBe('canvas-test/board.base');
+ }
+ });
+
test('folder create/delete events update the folder index', async () => {
const folderIndex = new Map();
const collected: DiskEvent[] = [];
diff --git a/packages/server/src/file-watcher.ts b/packages/server/src/file-watcher.ts
index 3e5d7fe3f..a4b40258e 100644
--- a/packages/server/src/file-watcher.ts
+++ b/packages/server/src/file-watcher.ts
@@ -2,7 +2,7 @@ import { createHash } from 'node:crypto';
import { type Dirent, lstatSync, readdirSync, readFileSync, realpathSync, statSync } from 'node:fs';
import { readFile } from 'node:fs/promises';
import { dirname, extname, join, relative } from 'node:path';
-import { ASSET_EXTENSIONS } from '@inkeep/open-knowledge-core';
+import { LINKABLE_ASSET_EXTENSIONS } from '@inkeep/open-knowledge-core';
import { isConfigDoc, isSystemDoc } from './cc1-broadcast.ts';
import type { ContentFilter } from './content-filter.ts';
import {
@@ -774,7 +774,9 @@ export async function handleRawEvents(
});
const mdEvents = safeEvents.filter((e) => isSupportedDocFile(e.path));
- const assetEvents = safeEvents.filter((e) => isSupportedAssetFile(e.path, ASSET_EXTENSIONS));
+ const assetEvents = safeEvents.filter((e) =>
+ isSupportedAssetFile(e.path, LINKABLE_ASSET_EXTENSIONS),
+ );
const folderEvents = updateFolderIndexFromRawEvents(
safeEvents,
contentDir,
diff --git a/packages/server/src/showall-stream.test.ts b/packages/server/src/showall-stream.test.ts
index 120394604..b9b684982 100644
--- a/packages/server/src/showall-stream.test.ts
+++ b/packages/server/src/showall-stream.test.ts
@@ -2,7 +2,7 @@ import { afterEach, describe, expect, test } from 'bun:test';
import { mkdirSync, mkdtempSync, realpathSync, writeFileSync } from 'node:fs';
import { tmpdir } from 'node:os';
import { join } from 'node:path';
-import type { DocumentListEntry } from '@inkeep/open-knowledge-core';
+import { ASSET_EXTENSIONS, type DocumentListEntry } from '@inkeep/open-knowledge-core';
import {
__getShowAllWalkStatsForTesting,
__resetShowAllWalkStatsForTesting,
@@ -125,3 +125,27 @@ describe('streamShowAllEntries — abort + laziness', () => {
expect(ret.done).toBe(true);
});
});
+
+describe('streamShowAllEntries — .base/.canvas mediaKind', () => {
+ test('.base and .canvas entries report mediaKind text in showAll output', async () => {
+ const dir = realpathSync(mkdtempSync(join(tmpdir(), 'ok-showall-mediakind-')));
+ writeFileSync(join(dir, 'note.md'), '# Note\n');
+ writeFileSync(join(dir, 'Characters.base'), 'fields:\n - name\n');
+ writeFileSync(join(dir, 'Board.canvas'), '{"nodes":[],"edges":[]}\n');
+
+ const { entries } = await drain(streamShowAllEntries(streamOptsFor(dir, 50_000)));
+
+ const baseEntry = entries.find((e) => e.kind === 'asset' && e.docName === 'Characters.base');
+ const canvasEntry = entries.find((e) => e.kind === 'asset' && e.docName === 'Board.canvas');
+
+ expect(baseEntry).toBeDefined();
+ expect(baseEntry?.kind === 'asset' && baseEntry.mediaKind).toBe('text');
+ expect(canvasEntry).toBeDefined();
+ expect(canvasEntry?.kind === 'asset' && canvasEntry.mediaKind).toBe('text');
+ });
+
+ test('.base and .canvas are absent from ASSET_EXTENSIONS (serve allowlist unchanged)', () => {
+ expect(ASSET_EXTENSIONS.has('base')).toBe(false);
+ expect(ASSET_EXTENSIONS.has('canvas')).toBe(false);
+ });
+});