@aicayzer/inkkit 0.1.1 → 0.1.3

package/dist/chunks/{highlight-BW9W8PtS.js → highlight-yHFoKkKz.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-CYp5ONPO.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-Bvj0PMMi.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.d.ts

@@ -1,4 +1,5 @@
 export { InkKitEditor } from './editor.js';
 export type { EditorEvents, EditorOptions, TextInputPreferences, CommandState, EditingMode, CaretState, Mark, Block, FormatCommand, FormatOptions, KeyInput, ImageInsertion, ShortcutName, Keymap, } from './editor.js';
 export { InkKitError } from './types.js';
-export type { DocumentFormat, EditorLabels, Heading, TableCommand, TableOptions, DocumentContext, DocumentInput, DocumentSnapshot, DocumentVersion, EditorErrorCode, ImageAdapter, WikiLinkReference, WikiLinkAdapter, FileReference, ClientPoint, FileContext, FilePresentation, FileAdapter, CapturedImage, PortableImage, ClipboardInput, ClipboardOutput, ClipboardScope, ClipboardImage, ClipboardDiagram, PrintableDocument, PrintableWarning, TextRange, ReadableTextSnapshot, TextRect, ViewportInsets, ViewportOptions, ViewportSnapshot, } from './types.js';
+export type { DocumentFormat, EditorLabels, Heading, TableCommand, TableOptions, BlockMoveDirection, DocumentContext, DocumentInput, DocumentSnapshot, DocumentVersion, EditorErrorCode, ImageAdapter, WikiLinkReference, WikiLinkAdapter, FileReference, ClientPoint, FileContext, FilePresentation, FileAdapter, CapturedImage, PortableImage, ClipboardInput, ClipboardOutput, ClipboardScope, ClipboardImage, ClipboardDiagram, PrintableDocument, PrintableWarning, TextRange, ReadableTextSnapshot, TextRect, ViewportInsets, ViewportOptions, ViewportSnapshot, } from './types.js';
+export type { SlashMenuOptions, SlashCommandName, SlashCommand } from './types.js';

package/dist/core.js

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

package/dist/editor.d.ts

@@ -1,4 +1,5 @@
-import { InkKitError, type ClientPoint, type DocumentInput, type DocumentSnapshot, type ImageAdapter, type FileAdapter, type WikiLinkAdapter, type ClipboardInput, type ClipboardOutput, type ClipboardScope, type DocumentVersion, type PrintableDocument, type TextRange, type ReadableTextSnapshot, type TextRect, type ViewportOptions, type ViewportSnapshot, type EditorLabels, type Heading, type TableCommand, type TableOptions } from './types.js';
+import type { SlashMenuOptions } from './types.js';
+import { InkKitError, type ClientPoint, type DocumentInput, type DocumentSnapshot, type ImageAdapter, type FileAdapter, type WikiLinkAdapter, type ClipboardInput, type ClipboardOutput, type ClipboardScope, type DocumentVersion, type PrintableDocument, type TextRange, type ReadableTextSnapshot, type TextRect, type ViewportOptions, type ViewportSnapshot, type EditorLabels, type Heading, type TableCommand, type TableOptions, type BlockMoveDirection } from './types.js';
 /** An inline format that `CaretState` can report. */
 export type Mark = 'bold' | 'italic' | 'strikethrough' | 'highlight' | 'code' | 'link';
 /** The kind of block that holds the start of the selection. Any other block reports `paragraph`. */
@@ -49,22 +50,27 @@ export interface ImageInsertion {
     alt: string;
     title?: string;
 }
-/** A name in `Keymap`: every format command except `link`, history, and every table command. */
-export type ShortcutName = Exclude<FormatCommand, 'link'> | 'undo' | 'redo' | `table${Capitalize<TableCommand>}`;
+/** 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>}`;
 /** Host bindings in ProseMirror key notation, by shortcut name. */
 export type Keymap = Partial<Record<ShortcutName, readonly string[]>>;
 /** Every `ShortcutName`. */
 export declare const shortcutNames: readonly ShortcutName[];
-/** Hints for the browser's input features. A field left out leaves the behavior to the browser. */
+/** Hints for the browser's input features, and smart punctuation. A field left out takes its default. */
 export interface TextInputPreferences {
     spellcheck?: boolean;
     autocorrect?: boolean;
     autocapitalize?: 'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters';
+    /** 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. */
 export interface EditorOptions {
     /** Shows, imports and exports images. Without it and `files`, image Markdown stays literal. */
     images?: ImageAdapter;
+    /** Opt-in block suggestions on an empty line. Fixed at mount. */
+    slashMenu?: SlashMenuOptions;
     /** Resolves path images and `![[name]]` embeds into images, audio, video, PDFs and file cards. */
     files?: FileAdapter;
     /** Resolves and opens `[[wiki links]]`. Without it they stay literal. */
@@ -113,6 +119,8 @@ export interface CommandState extends DocumentVersion {
         editReferenceDefinition: boolean;
         format: Record<FormatCommand, boolean>;
         table: Record<TableCommand, boolean>;
+        moveBlockUp: boolean;
+        moveBlockDown: boolean;
     };
 }
 /** The host's handlers, passed to `mount`. Only `changed` is required. */
@@ -160,6 +168,7 @@ export declare class InkKitEditor {
     private ready;
     private destroyed;
     private preservation?;
+    private carried?;
     private pasteController;
     private plain;
     private root;
@@ -182,6 +191,8 @@ export declare class InkKitEditor {
     private literalKeys;
     private configuredKeys;
     private readOnlyKeys;
+    private suggestions?;
+    private suggestionBase?;
     private changePlugin;
     private keys;
     private readonly events;
@@ -243,7 +254,7 @@ export declare class InkKitEditor {
     get editable(): boolean;
     /** Turns editing on or off for both surfaces. Throws `composition` during text composition. */
     setEditable(editable: boolean): void;
-    /** Replaces the input hints. A field left out leaves the browser's behavior. Throws `composition`
+    /** Replaces the input preferences. A field left out takes its default. Throws `composition`
      *  during text composition. */
     setTextInputPreferences(preferences: TextInputPreferences): void;
     private applyInputPolicy;
@@ -254,6 +265,7 @@ export declare class InkKitEditor {
     /** An image adapter shows and exports an inserted reference, and so does a file adapter. */
     private get canInsertImages();
     private canQuote;
+    private historyInputPlugin;
     private policyPlugin;
     private get literalSurface();
     /** `formatted` or `source`. A TXT document is always `source`. */
@@ -314,6 +326,10 @@ export declare class InkKitEditor {
     /** Runs a table command and returns whether it applied. False in source and TXT modes, outside a
      *  table for commands that need one, and at a boundary a move can't cross. */
     table(command: TableCommand, options?: TableOptions, expectedGeneration?: number): boolean;
+    /** Moves the blocks at the selection one place up or down in their list, quote, callout, footnote
+     *  or note, as one undo step. Returns whether they moved: false in source and TXT modes, in a
+     *  table, and when they are already first or last. */
+    moveBlock(direction: BlockMoveDirection, expectedGeneration?: number): boolean;
     /** Cancels pending work and releases the editor. It never rejects. Afterwards every other member
      *  throws `destroyed`. */
     destroy(): Promise<void>;
@@ -345,6 +361,9 @@ export declare class InkKitEditor {
         focus?: boolean;
         reveal?: boolean;
     }): void;
+    /** Whether two documents are the same note. A move of blocks that read alike, such as a setext
+     *  heading and the same heading written with `#`, gives an equal document with other source. */
+    private sameDocument;
     /** Throws when a document reached by an edit, after every appended normalisation, cannot be
      *  saved as preserved Markdown. Dispatch and the replacement commands share this check.
      *  `written` is false for history steps and source replacement, which restore or supply a
@@ -387,8 +406,9 @@ export declare class InkKitEditor {
      *  control InkKit draws, is left alone. */
     blur(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, tables, so it lands the same way every
-     *  time. */
+     *  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. */
     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. */
@@ -413,6 +433,8 @@ export declare class InkKitEditor {
      * text is each block's source.
      */
     private authoredSources;
+    private chooseWiki;
+    private chooseSlash;
     /** Returns whether the document or the marks the next typed text takes changed. */
     format(command: FormatCommand, options?: FormatOptions, expectedGeneration?: number): boolean;
     /**

package/dist/index.js

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

package/dist/style.css

@@ -125,9 +125,13 @@
 }
 .inkkit-root .inkkit-table-controls button {
   display: grid;
+  /* The icon is larger than the grabbers' short side, so the track itself is
+     centered; otherwise it overflows to one side. */
+  place-content: center;
   place-items: center;
   box-sizing: border-box;
   margin: 0;
+  padding: 0;
   border: 0;
   color: var(--_inkkit-muted);
   background: Canvas;
@@ -569,9 +573,13 @@
   top: 6px;
   right: 6px;
   display: grid;
+  place-content: center;
   place-items: center;
+  box-sizing: border-box;
   width: 26px;
   height: 24px;
+  margin: 0;
+  padding: 0;
   border: 0;
   border-radius: 6px;
   background: color-mix(in srgb, CanvasText 10%, transparent);
@@ -646,15 +654,22 @@
 .inkkit-root .ProseMirror li[data-item-type='task'] {
   list-style: none;
   position: relative;
+  /* The box is centered on the first line: 1lh is the line height the item's
+     text uses, including when it is normal, and --inkkit-checkbox-offset
+     moves the box down for a font whose lines look off-center. */
+  --_inkkit-task-size: calc(var(--inkkit-font-size, 15px) * 0.933);
+  --_inkkit-task-top: calc(
+    (1lh - var(--_inkkit-task-size)) / 2 + var(--inkkit-checkbox-offset, 0px)
+  );
 }
 
 .inkkit-root .ProseMirror li[data-item-type='task']::before {
   content: '';
   position: absolute;
   left: calc(var(--inkkit-font-size, 15px) * -1.667);
-  top: 0.32em;
-  width: calc(var(--inkkit-font-size, 15px) * 0.933);
-  height: calc(var(--inkkit-font-size, 15px) * 0.933);
+  top: var(--_inkkit-task-top);
+  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-radius: 4px;
@@ -674,8 +689,7 @@
   content: '';
   position: absolute;
   left: calc(var(--inkkit-font-size, 15px) * -1.333);
-  top: 0.32em;
-  margin-top: calc(var(--inkkit-font-size, 15px) * 0.133);
+  top: calc(var(--_inkkit-task-top) + var(--inkkit-font-size, 15px) * 0.133);
   width: calc(var(--inkkit-font-size, 15px) * 0.2);
   height: calc(var(--inkkit-font-size, 15px) * 0.467);
   border: solid Canvas;
@@ -939,3 +953,51 @@
     var(--inkkit-focus-offset, -2px)
   );
 }
+
+.inkkit-root .inkkit-suggestions {
+  position: fixed;
+  z-index: 100;
+  box-sizing: border-box;
+  width: var(--inkkit-menu-width, 240px);
+  max-width: calc(100vw - 8px);
+  max-height: 264px;
+  overflow-y: auto;
+  overscroll-behavior: contain;
+  padding: 4px;
+  border-radius: var(--inkkit-menu-radius, 8px);
+  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);
+}
+.inkkit-root .inkkit-suggestions [role='option'] {
+  box-sizing: border-box;
+  height: 32px;
+  display: flex;
+  align-items: center;
+  gap: 8px;
+  padding: 4px 8px;
+  border-radius: 4px;
+  cursor: default;
+  white-space: nowrap;
+  overflow: hidden;
+}
+.inkkit-root .inkkit-suggestions [aria-selected='true'] {
+  background: var(--inkkit-menu-highlight, light-dark(#e8e8ed, #414146));
+}
+.inkkit-root .inkkit-suggestion-glyph {
+  display: inline-block;
+  flex: 0 0 22px;
+  text-align: center;
+  font-size: 12px;
+}
+.inkkit-root .inkkit-suggestion-glyph::before {
+  content: attr(data-glyph);
+}
+.inkkit-root .inkkit-suggestions-status {
+  position: absolute;
+  width: 1px;
+  height: 1px;
+  clip-path: inset(50%);
+  overflow: hidden;
+}

package/dist/types.d.ts

@@ -74,6 +74,8 @@ export interface WikiLinkReference {
 }
 /** Resolves and opens wiki links. The host owns lookup, permissions and navigation. */
 export interface WikiLinkAdapter {
+    /** Matches note names for a typed `[[` query. Late answers are ignored. */
+    suggest?(query: string, context: FileContext): Promise<readonly string[]>;
     /** Whether the target is missing, for presentation only. */
     resolve?(reference: WikiLinkReference, context: DocumentContext): {
         missing?: boolean;
@@ -228,6 +230,26 @@ export interface ViewportSnapshot {
 }
 /** Built-in editor text. Hosts can override individual labels at mount time. */
 export interface EditorLabels {
+    suggestions: string;
+    suggestionsEmpty: string;
+    suggestionsLoading: string;
+    slashHeading1: string;
+    slashHeading2: string;
+    slashHeading3: string;
+    slashBulletList: string;
+    slashOrderedList: string;
+    slashTaskList: string;
+    slashQuote: string;
+    slashCodeBlock: string;
+    slashTable: string;
+    slashCallout: string;
+    slashDivider: string;
+    slashDiagram: string;
+    slashNote: string;
+    slashTip: string;
+    slashImportant: string;
+    slashWarning: string;
+    slashCaution: string;
     formattedEditor: string;
     plainTextEditor: string;
     sourceEditor: string;
@@ -272,6 +294,8 @@ export interface Heading extends Readonly<DocumentVersion> {
 }
 /** A command for `table`. `insert` makes a table; the others work on the table at the selection. */
 export type TableCommand = 'insert' | 'addRowBefore' | 'addRowAfter' | 'addColumnBefore' | 'addColumnAfter' | 'deleteRow' | 'deleteColumn' | 'deleteTable' | 'alignLeft' | 'alignCenter' | 'alignRight' | 'moveRowUp' | 'moveRowDown' | 'moveColumnLeft' | 'moveColumnRight' | 'sortRows' | 'exit';
+/** Where `moveBlock` moves the blocks at the selection. */
+export type BlockMoveDirection = 'up' | 'down';
 /** Each option belongs to one command; any other combination is refused. */
 export interface TableOptions {
     /** `insert`: 1 to 100, counting the header row. Defaults to 3. */
@@ -285,3 +309,15 @@ export interface TableOptions {
     /** `sortRows`. Defaults to `text`. */
     comparison?: 'text' | 'number';
 }
+export type SlashCommandName = 'heading1' | 'heading2' | 'heading3' | 'bulletList' | 'orderedList' | 'taskList' | 'quote' | 'codeBlock' | 'table' | 'callout' | 'divider' | 'diagram';
+export interface SlashCommand {
+    name: string;
+    keywords?: readonly string[];
+    /** Returns Markdown to insert in place of the trigger. Undefined cancels the action. */
+    action(context: DocumentContext): string | undefined | Promise<string | undefined>;
+}
+export interface SlashMenuOptions {
+    enabled?: boolean;
+    commands?: readonly SlashCommandName[];
+    customCommands?: readonly SlashCommand[];
+}

package/package.json

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