@aicayzer/inkkit 0.2.0 → 0.3.1

package/dist/chunks/{highlight-AI86evan.js → highlight-GlZZ_7st.js}

@@ -1,4 +1,4 @@
-import { a as Decoration, c as PluginKey, d as __toESM, i as $prose, o as DecorationSet, s as Plugin, u as __commonJSMin } from "./core-C612uj1Q.js";
+import { a as Decoration, c as PluginKey, d as __toESM, i as $prose, o as DecorationSet, s as Plugin, u as __commonJSMin } from "./core-Dx4gTiUo.js";
 //#region node_modules/.pnpm/highlight.js@11.11.2/node_modules/highlight.js/es/languages/arduino.js
 /** @type LanguageFn */
 function cPlusPlus(hljs) {

package/dist/core.js

@@ -1,2 +1,2 @@
-import { r as InkKitError, t as InkKitEditor } from "./chunks/core-C612uj1Q.js";
+import { r as InkKitError, t as InkKitEditor } from "./chunks/core-Dx4gTiUo.js";
 export { InkKitEditor, InkKitError };

package/dist/editor.d.ts

@@ -50,9 +50,9 @@ export interface ImageInsertion {
     alt: string;
     title?: string;
 }
-/** A name in `Keymap`: every format command except `link`, history, block moves, and every table
- *  command. */
-export type ShortcutName = Exclude<FormatCommand, 'link'> | 'undo' | 'redo' | 'moveBlockUp' | 'moveBlockDown' | `table${Capitalize<TableCommand>}`;
+/** A name in `Keymap`: every format command except `link`, history, block moves, list indentation,
+ *  and every table command. */
+export type ShortcutName = Exclude<FormatCommand, 'link'> | 'undo' | 'redo' | 'moveBlockUp' | 'moveBlockDown' | 'indent' | 'outdent' | `table${Capitalize<TableCommand>}`;
 /** Host bindings in ProseMirror key notation, by shortcut name. */
 export type Keymap = Partial<Record<ShortcutName, readonly string[]>>;
 /** Every `ShortcutName`. */
@@ -65,7 +65,7 @@ export interface TextInputPreferences {
     /** Typing a quote or `--` gives a curly quote or a dash, in formatted mode. Off unless true. */
     smartPunctuation?: boolean;
 }
-/** Mount options. Adapters, `labels` and `rendering` are fixed at mount; the rest can change. */
+/** Mount options. Adapters, `labels`, `linkSchemes` and `rendering` are fixed at mount; the rest can change. */
 export interface EditorOptions {
     /** Shows, imports and exports images. Without it and `files`, image Markdown stays literal. */
     images?: ImageAdapter;
@@ -82,6 +82,9 @@ export interface EditorOptions {
     labels?: Partial<EditorLabels>;
     /** See `setKeymap`. */
     keymap?: Keymap;
+    /** Schemes beyond `http`, `https`, `mailto` and `tel` that links may use, such as `things`.
+     *  Fixed at mount. */
+    linkSchemes?: readonly string[];
     rendering?: {
         /** Defaults to true. */
         codeHighlighting?: boolean;
@@ -114,6 +117,7 @@ export interface CommandState extends DocumentVersion {
         replace: boolean;
         replaceSource: boolean;
         insertImages: boolean;
+        appendImages: boolean;
         insertPaths: boolean;
         insertFootnote: boolean;
         editReferenceDefinition: boolean;
@@ -196,12 +200,15 @@ export declare class InkKitEditor {
     private inputPreferences;
     private literalKeys;
     private configuredKeys;
+    private indentKeys;
     private readOnlyKeys;
     private suggestions?;
     private suggestionBase?;
     private changePlugin;
     private keys;
     private readonly events;
+    /** The host's extra link schemes, in lower case. */
+    private readonly linkSchemes;
     /** How many of each state event the host has been sent. */
     private readonly sentEvents;
     private constructor();
@@ -343,6 +350,7 @@ export declare class InkKitEditor {
      *  throws `destroyed`. */
     destroy(): Promise<void>;
     private keymapPlugin;
+    private indentPlugin;
     private copySourceSelection;
     /** Builds the editor in `root`. It has no document until `loadDocument`. Rejects with
      *  `invalid-argument` for a bad root, handler or option. */
@@ -414,10 +422,18 @@ export declare class InkKitEditor {
     /** Moves focus off InkKit's text surfaces. Focus anywhere else, such as in a host control or a
      *  control InkKit draws, is left alone. */
     blur(expectedGeneration?: number): void;
+    /**
+     * Resolves wiki links and file embeds again, all of them or those whose `target` is named, after
+     * something they point to changed. A file keeps its card until the new answer differs. Changes no
+     * document state, so it works in a read-only editor and during composition. Source and TXT modes
+     * draw no references, and they resolve afresh when formatted mode returns.
+     */
+    refreshReferences(targets?: readonly string[], expectedGeneration?: number): void;
     /** Replaces every binding. Keys are in ProseMirror's notation. A key given to two shortcuts goes
      *  to the later one, in the order history, formatting, block moves, tables, so it lands the same
      *  way every time. A table binding passes a key it shares with a block move to the move outside
-     *  a table. */
+     *  a table. List indentation keys apply after all of these, and after the table keys the editor
+     *  keeps for itself. */
     setKeymap(keymap: Keymap): void;
     /** Dropped files land as one paragraph per path at the drop point: in place of an empty block, after
      *  the top-level block otherwise, so a list or quote is not opened up by them. */
@@ -425,6 +441,11 @@ export declare class InkKitEditor {
     /** Inserts images by reference, at the selection or the drop point `at`. Returns false when it
      *  does nothing. */
     insertImages(images: ImageInsertion[], at?: ClientPoint, expectedGeneration?: number): boolean;
+    /** Adds images as the last blocks of the document and leaves everything else as it is: no focus,
+     *  no scrolling, and the selection stays on the text it covered. For a host that attaches images
+     *  to a document the person is not editing at that moment. Returns false when it does nothing. */
+    appendImages(images: ImageInsertion[], expectedGeneration?: number): boolean;
+    private imageBlocks;
     private insertInline;
     private insertBlocks;
     private withMarkRunSelected;
@@ -447,8 +468,9 @@ export declare class InkKitEditor {
     /** Returns whether the document or the marks the next typed text takes changed. */
     format(command: FormatCommand, options?: FormatOptions, expectedGeneration?: number): boolean;
     /**
-     * Refuses a link destination that is empty, that opens anything but a web, mail or phone address,
-     * or that the Markdown writer cannot save so that it reads back the same.
+     * Refuses a link destination that is empty, that opens anything but a web, mail or phone address
+     * or a scheme the host listed, or that the Markdown writer cannot save so that it reads back the
+     * same.
      */
     private checkDestination;
     /**

package/dist/index.js

@@ -1,4 +1,4 @@
-import { n as registerMermaid, r as InkKitError, t as InkKitEditor } from "./chunks/core-C612uj1Q.js";
+import { n as registerMermaid, r as InkKitError, t as InkKitEditor } from "./chunks/core-Dx4gTiUo.js";
 //#region src/index.ts
 registerMermaid(async () => (await import("mermaid")).default);
 //#endregion

package/dist/style.css

@@ -81,7 +81,10 @@
   overflow-x: auto;
 }
 .inkkit-root .ProseMirror table {
-  border-collapse: collapse;
+  border-collapse: separate;
+  border-spacing: 0;
+  border: 1px solid var(--_inkkit-rule);
+  border-radius: var(--inkkit-table-radius, 4px);
   width: 100%;
 }
 .inkkit-root .ProseMirror td,
@@ -91,9 +94,39 @@
   min-width: calc(var(--inkkit-font-size, 15px) * 4);
   padding: calc(var(--inkkit-font-size, 15px) * 0.4)
     calc(var(--inkkit-font-size, 15px) * 0.6);
-  border: 1px solid var(--_inkkit-rule);
+  border: 0 solid var(--_inkkit-rule);
+  border-width: 0 1px 1px 0;
   vertical-align: top;
 }
+/* Round only the perimeter; keep controls and focus rings outside the table
+   unclipped, and leave every internal cell division square. */
+.inkkit-root .ProseMirror tr > :last-child {
+  border-right-width: 0;
+}
+.inkkit-root .ProseMirror tr:last-child > * {
+  border-bottom-width: 0;
+}
+.inkkit-root .ProseMirror tr:first-child > :first-child {
+  border-top-left-radius: max(0px, calc(var(--inkkit-table-radius, 4px) - 1px));
+}
+.inkkit-root .ProseMirror tr:first-child > :last-child {
+  border-top-right-radius: max(
+    0px,
+    calc(var(--inkkit-table-radius, 4px) - 1px)
+  );
+}
+.inkkit-root .ProseMirror tr:last-child > :first-child {
+  border-bottom-left-radius: max(
+    0px,
+    calc(var(--inkkit-table-radius, 4px) - 1px)
+  );
+}
+.inkkit-root .ProseMirror tr:last-child > :last-child {
+  border-bottom-right-radius: max(
+    0px,
+    calc(var(--inkkit-table-radius, 4px) - 1px)
+  );
+}
 .inkkit-root .ProseMirror th {
   background: var(--_inkkit-code-bg);
   font-weight: 600;
@@ -107,6 +140,7 @@
   position: absolute;
   inset: 0;
   z-index: 2;
+  border-radius: inherit;
   content: '';
   background: color-mix(in srgb, var(--_inkkit-accent) 25%, transparent);
   pointer-events: none;
@@ -267,9 +301,10 @@
   content: '';
   display: block;
   position: absolute;
-  top: -2px;
-  width: 20px;
-  border-top: 2px solid var(--_inkkit-accent);
+  top: 0;
+  width: 2px;
+  height: 1lh;
+  background: var(--_inkkit-accent);
   animation: inkkit-gapcursor-blink 1.1s steps(2, start) infinite;
 }
 @keyframes inkkit-gapcursor-blink {
@@ -463,13 +498,26 @@
   pointer-events: none;
 }
 
-/* The selection plugin draws the selection over the text alone; the engine's own fills the margins too. */
+/* The selection plugin draws the selection over the text alone; the engine's own fills the margins too.
+   The surface needs its own rule: the descendant selector does not reach the surface itself, and WebKit paints that as full-width bars. */
+.inkkit-root .ProseMirror.inkkit-painted-selection::selection,
 .inkkit-root .ProseMirror.inkkit-painted-selection ::selection {
   background: transparent;
 }
 
-.inkkit-root ::highlight(inkkit-selection) {
-  background-color: color-mix(in srgb, var(--_inkkit-accent) 30%, transparent);
+.inkkit-root ::highlight(inkkit-selection),
+.inkkit-root ::selection {
+  background: var(
+    --inkkit-inactive-selection-background,
+    light-dark(#d4d4d4, #555)
+  );
+}
+.inkkit-root.inkkit-selection-active ::highlight(inkkit-selection),
+.inkkit-root.inkkit-selection-active ::selection {
+  background: var(
+    --inkkit-selection-background,
+    color-mix(in srgb, var(--_inkkit-accent) 30%, transparent)
+  );
 }
 
 .inkkit-root .ProseMirror > :first-child {
@@ -518,16 +566,29 @@
   font-weight: 700;
 }
 
-.inkkit-root .ProseMirror a {
+.inkkit-root .ProseMirror a,
+.inkkit-root .inkkit-wiki-link {
   color: var(--_inkkit-accent);
   text-decoration: none;
   text-underline-offset: 2px;
 }
 
-.inkkit-root .ProseMirror a:hover {
+.inkkit-root .ProseMirror a:hover,
+.inkkit-root .inkkit-wiki-link:hover {
   text-decoration: underline;
 }
 
+/* A missing target differs by its line, not only its color, which forced colors replace. */
+.inkkit-root .inkkit-wiki-link[data-missing] {
+  text-decoration: underline dashed;
+}
+
+@media (forced-colors: active) {
+  .inkkit-root .inkkit-wiki-link {
+    color: LinkText;
+  }
+}
+
 /* Held Mod opens a link on click; an empty address opens nothing. */
 .inkkit-root.inkkit-link-modifier .ProseMirror a[href]:not([href='']),
 .inkkit-root.inkkit-link-modifier .inkkit-wiki-link {
@@ -665,7 +726,11 @@
   width: var(--_inkkit-task-size);
   height: var(--_inkkit-task-size);
   box-sizing: border-box;
-  border: 1.5px solid color-mix(in srgb, CanvasText 35%, transparent);
+  border: 1.5px solid
+    var(
+      --inkkit-checkbox-border-color,
+      color-mix(in srgb, CanvasText 35%, transparent)
+    );
   border-radius: 4px;
   cursor: pointer;
 }
@@ -808,7 +873,7 @@
 }
 
 .inkkit-root .inkkit-reference-definition {
-  font-family: ui-monospace, monospace;
+  font-family: var(--_inkkit-mono);
   font-size: calc(var(--inkkit-font-size, 15px) * 0.8);
   opacity: 0.7;
 }
@@ -963,11 +1028,13 @@
   background: var(--inkkit-menu-background, light-dark(#fff, #252529));
   color: var(--inkkit-menu-text, CanvasText);
   box-shadow: var(--inkkit-menu-shadow, 0 4px 18px #0003);
-  font: 14px / 24px var(--inkkit-font-family, system-ui, sans-serif);
+  font: calc(var(--inkkit-font-size, 15px) * 14 / 15) /
+    calc(var(--inkkit-font-size, 15px) * 1.6)
+    var(--inkkit-font-family, system-ui, sans-serif);
 }
 .inkkit-root .inkkit-suggestions [role='option'] {
   box-sizing: border-box;
-  height: 32px;
+  min-height: 32px;
   display: flex;
   align-items: center;
   gap: 8px;
@@ -1027,8 +1094,9 @@
 }
 .inkkit-root .inkkit-code-language:focus-visible,
 .inkkit-root .inkkit-copy:focus-visible {
-  outline: 2px solid var(--_inkkit-accent);
-  outline-offset: 1px;
+  outline: var(--inkkit-focus-width, 2px) solid
+    var(--inkkit-focus-color, var(--_inkkit-accent));
+  outline-offset: var(--inkkit-focus-offset, 1px);
 }
 .inkkit-root .inkkit-code-language-menu {
   position: fixed;
@@ -1078,3 +1146,7 @@
 .inkkit-root .inkkit-code-language-list button[aria-pressed='true'] {
   background: color-mix(in srgb, CanvasText 8%, transparent);
 }
+
+.inkkit-root .milkdown-drop-indicator {
+  background: var(--inkkit-drop-indicator-color, var(--_inkkit-accent));
+}

package/dist/types.d.ts

@@ -26,7 +26,7 @@ export interface DocumentSnapshot extends DocumentInput, DocumentVersion {
     dirty: boolean;
 }
 /** The closed list of failure codes. The API reference describes each one. */
-export declare const editorErrorCodes: readonly ['not-ready', 'destroyed', 'stale-document', 'composition', 'operation-pending', 'read-only', 'invalid-argument', 'invalid-range', 'preservation', 'image-unavailable', 'diagram-unavailable', 'file-unavailable', 'clipboard-unavailable', 'internal'];
+export declare const editorErrorCodes: readonly ['not-ready', 'destroyed', 'stale-document', 'composition', 'operation-pending', 'read-only', 'invalid-argument', 'invalid-range', 'preservation', 'image-unavailable', 'diagram-unavailable', 'file-unavailable', 'clipboard-unavailable', 'slash-command-failed', 'internal'];
 export type EditorErrorCode = (typeof editorErrorCodes)[number];
 /** Every failure InkKit reports. Hosts branch on `code`; `message` is for logs. When the failure
  *  started elsewhere, such as in an adapter, the host clipboard or the renderer, `cause` holds the
@@ -67,9 +67,13 @@ export interface ImageAdapter {
     }>;
     /** The stored bytes and type of `reference`, for portable clipboard and print output. */
     exportImage(reference: string, context: DocumentContext): Promise<PortableImage>;
+    /** Called for a context-menu request on an image. Inkkit selects the image first. */
+    contextMenu?(reference: string, point: ClientPoint, context: DocumentContext): void;
 }
 /** A wiki link as authored. */
 export interface WikiLinkReference {
+    /** The link's Markdown as the document holds it, such as `[[Plan|Plan]]`. */
+    raw: string;
     /** The note name, with escapes removed. Empty for a link such as `[[#Heading]]`. */
     target: string;
     fragment?: string;
@@ -93,6 +97,8 @@ export interface FileReference {
     reference: string;
     /** `path` for `![alt](destination)`, `wiki` for `![[name]]`. */
     kind: 'path' | 'wiki';
+    /** The embed's Markdown as the document holds it, such as `![alt](a\_b.png)`. */
+    raw: string;
     /** The reference without its fragment. Use it to find the file. */
     target: string;
     /** Everything after the separating `#`, such as `t=10` or `page=3`. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aicayzer/inkkit",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "A preserving Markdown editor for offline web views and the web",
   "license": "MIT",
   "type": "module",