@aicayzer/inkkit 0.0.9 → 0.0.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/types.d.ts CHANGED
@@ -39,6 +39,49 @@ export interface ImageAdapter {
39
39
  }>;
40
40
  exportImage(reference: string, context: DocumentContext): Promise<PortableImage>;
41
41
  }
42
+ export interface WikiLinkReference {
43
+ target: string;
44
+ fragment?: string;
45
+ label: string;
46
+ }
47
+ export interface WikiLinkAdapter {
48
+ resolve?(reference: WikiLinkReference, context: DocumentContext): {
49
+ missing?: boolean;
50
+ } | undefined;
51
+ open(reference: WikiLinkReference, context: DocumentContext): void;
52
+ }
53
+ export interface FileReference {
54
+ reference: string;
55
+ kind: 'path' | 'wiki';
56
+ fragment?: string;
57
+ label?: string;
58
+ width?: number;
59
+ }
60
+ export interface FileContext extends DocumentContext {
61
+ signal: AbortSignal;
62
+ }
63
+ export type FilePresentation = {
64
+ kind: 'image' | 'audio' | 'video' | 'pdf';
65
+ url: string;
66
+ label?: string;
67
+ mimeType?: string;
68
+ } | {
69
+ kind: 'file' | 'missing';
70
+ label?: string;
71
+ } | {
72
+ kind: 'error';
73
+ label?: string;
74
+ message: string;
75
+ };
76
+ export interface FileAdapter {
77
+ resolve(reference: FileReference, context: FileContext): Promise<FilePresentation>;
78
+ exportImage?(reference: FileReference, context: FileContext): Promise<PortableImage>;
79
+ open?(reference: FileReference, context: DocumentContext): void;
80
+ contextMenu?(reference: FileReference, point: {
81
+ clientX: number;
82
+ clientY: number;
83
+ }, context: DocumentContext): void;
84
+ }
42
85
  export interface ClipboardInput {
43
86
  text: string;
44
87
  markdown?: string;
@@ -65,7 +108,7 @@ export interface ClipboardDiagram {
65
108
  error?: string;
66
109
  }
67
110
  export interface PrintableWarning {
68
- code: 'diagram-unavailable';
111
+ code: 'diagram-unavailable' | 'attachment-fallback' | 'attachment-unavailable';
69
112
  message: string;
70
113
  }
71
114
  export interface PrintableDocument {
@@ -0,0 +1,21 @@
1
+ import type { Node as ProseNode } from '@milkdown/kit/prose/model';
2
+ import type { EditorView } from '@milkdown/kit/prose/view';
3
+ import type { DocumentContext, WikiLinkAdapter } from './types.js';
4
+ import type { EditorLabels } from './labels.js';
5
+ interface WikiRuntime {
6
+ capture(): {
7
+ context: DocumentContext;
8
+ isCurrent(): boolean;
9
+ };
10
+ active(): boolean;
11
+ labels: Readonly<EditorLabels>;
12
+ error?(error: Error): void;
13
+ }
14
+ export declare function wikiLinkView(adapter: WikiLinkAdapter, runtime: WikiRuntime): import("@milkdown/kit/utils").$View<import("@milkdown/kit/utils").$Node, (node: ProseNode, view: EditorView) => {
15
+ dom: HTMLSpanElement;
16
+ update(next: ProseNode): boolean;
17
+ stopEvent(event: Event): boolean;
18
+ ignoreMutation: () => true;
19
+ destroy(): void;
20
+ }>;
21
+ export {};
@@ -0,0 +1,78 @@
1
+ import { $view } from '@milkdown/kit/utils';
2
+ import { wikiLinkSchema } from './linked-syntax.js';
3
+ export function wikiLinkView(adapter, runtime) {
4
+ return $view(wikiLinkSchema, () => (node, view) => {
5
+ let current = node;
6
+ const dom = document.createElement('span');
7
+ dom.className = 'inkkit-wiki-link';
8
+ dom.setAttribute('role', 'link');
9
+ dom.tabIndex = 0;
10
+ const reference = () => ({
11
+ target: String(current.attrs.target),
12
+ ...(current.attrs.fragment
13
+ ? { fragment: String(current.attrs.fragment) }
14
+ : {}),
15
+ label: String(current.attrs.label),
16
+ });
17
+ const report = (error) => runtime.error?.(error instanceof Error ? error : new Error(String(error)));
18
+ const render = () => {
19
+ dom.textContent = reference().label;
20
+ dom.removeAttribute('title');
21
+ dom.removeAttribute('data-missing');
22
+ if (!runtime.active())
23
+ return;
24
+ const captured = runtime.capture();
25
+ try {
26
+ const result = adapter.resolve?.(reference(), captured.context);
27
+ if (captured.isCurrent() && result?.missing) {
28
+ dom.dataset.missing = 'true';
29
+ dom.title = runtime.labels.wikiMissing;
30
+ }
31
+ }
32
+ catch (error) {
33
+ report(error);
34
+ }
35
+ };
36
+ const open = (event) => {
37
+ event.preventDefault();
38
+ if (!runtime.active())
39
+ return;
40
+ const captured = runtime.capture();
41
+ try {
42
+ if (captured.isCurrent())
43
+ adapter.open(reference(), captured.context);
44
+ }
45
+ catch (error) {
46
+ report(error);
47
+ }
48
+ };
49
+ dom.addEventListener('click', (event) => {
50
+ if (event.metaKey || event.ctrlKey)
51
+ open(event);
52
+ });
53
+ dom.addEventListener('keydown', (event) => {
54
+ if (event.key === 'Enter' || event.key === ' ')
55
+ open(event);
56
+ });
57
+ view.dom.addEventListener('inkkit-media-policy', render);
58
+ render();
59
+ return {
60
+ dom,
61
+ update(next) {
62
+ if (next.type !== current.type)
63
+ return false;
64
+ current = next;
65
+ render();
66
+ return true;
67
+ },
68
+ stopEvent(event) {
69
+ return (event.type === 'keydown' &&
70
+ ['Enter', ' '].includes(event.key));
71
+ },
72
+ ignoreMutation: () => true,
73
+ destroy() {
74
+ view.dom.removeEventListener('inkkit-media-policy', render);
75
+ },
76
+ };
77
+ });
78
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aicayzer/inkkit",
3
- "version": "0.0.9",
3
+ "version": "0.0.10",
4
4
  "description": "A preserving Markdown editor for offline web views and the web",
5
5
  "license": "MIT",
6
6
  "type": "module",