@aicayzer/inkkit 0.6.1 → 0.7.1

package/dist/chunks/{highlight-C-9lbVMU.js → highlight-CVL-YhFo.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-CbHV2KPY.js";
+import { c as DecorationSet, f as __commonJSMin, l as Plugin, o as $prose, p as __toESM, s as Decoration, u as PluginKey } from "./core-Bn6QiQSD.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,6 +1,7 @@
 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, TextDocumentFormat, TextDocumentInput, RichTextDocumentInput, TextDocumentSnapshot, RichTextDocumentSnapshot, RichTextDocument, RichTextBlock, RichTextListItem, RichTextTableCell, RichTextInline, RichTextMark, FormatLoss, FormatLossCode, ConvertedDocument, FormatPromise, OfferedFormat, EditorLabels, Heading, TableCommand, TableOptions, BlockMoveDirection, DocumentContext, DocumentInput, DocumentSnapshot, DocumentVersion, EditorErrorCode, ImageAdapter, ImageImportContext, 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 { normalizeLinkAddress, canOpenLink } from './link-address.js';
+export type { DocumentFormat, TextDocumentFormat, TextDocumentInput, RichTextDocumentInput, TextDocumentSnapshot, RichTextDocumentSnapshot, RichTextDocument, RichTextBlock, RichTextListItem, RichTextTableCell, RichTextInline, RichTextMark, FormatLoss, FormatLossCode, ConvertedDocument, FormatPromise, OfferedFormat, EditorLabels, Heading, TableCommand, TableOptions, BlockMoveDirection, DocumentContext, DocumentInput, DocumentSnapshot, DocumentVersion, EditorErrorCode, ImageAdapter, ImageImportContext, WikiLinkReference, WikiLinkAdapter, FileReference, ClientPoint, FileContext, FilePresentation, FileAdapter, CapturedImage, PortableImage, ClipboardInput, ClipboardOutput, ClipboardScope, ClipboardImage, ClipboardDiagram, PrintableDocument, PrintableWarning, TextRange, FindState, FindSession, ReadableTextSnapshot, TextRect, ViewportInsets, ViewportOptions, ViewportSnapshot, } from './types.js';
 export type { SlashMenuOptions, SlashCommandName, SlashCommand } from './types.js';
 export type { DiagnosticReport, DiagnosticEvent, DiagnosticState, DiagnosticPresentation, } from './diagnostics.js';

package/dist/core.js

@@ -1,2 +1,2 @@
-import { r as InkKitError, t as InkKitEditor } from "./chunks/core-CbHV2KPY.js";
-export { InkKitEditor, InkKitError };
+import { a as InkKitError, n as normalizeLinkAddress, r as InkKitEditor, t as canOpenLink } from "./chunks/core-Bn6QiQSD.js";
+export { InkKitEditor, InkKitError, canOpenLink, normalizeLinkAddress };

package/dist/editor.d.ts

@@ -1,6 +1,6 @@
 import { type DiagnosticReport } from './diagnostics.js';
 import type { SlashMenuOptions } from './types.js';
-import { InkKitError, type ClientPoint, type DocumentFormat, type DocumentInput, type DocumentSnapshot, type ConvertedDocument, type TextDocumentFormat, 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, type OfferedFormat } from './types.js';
+import { InkKitError, type ClientPoint, type DocumentFormat, type DocumentInput, type DocumentSnapshot, type ConvertedDocument, type TextDocumentFormat, type ImageAdapter, type FileAdapter, type WikiLinkAdapter, type ClipboardInput, type ClipboardOutput, type ClipboardScope, type DocumentVersion, type PrintableDocument, type TextRange, type ReadableTextSnapshot, type FindSession, type FindState, type TextRect, type ViewportOptions, type ViewportSnapshot, type EditorLabels, type Heading, type TableCommand, type TableOptions, type BlockMoveDirection, type OfferedFormat } from './types.js';
 /** An inline format that `CaretState` can report. */
 export type Mark = 'bold' | 'italic' | 'strikethrough' | 'highlight' | 'underline' | 'superscript' | 'subscript' | 'code' | 'link';
 /** The kind of block that holds the start of the selection. Any other block reports `paragraph`. */
@@ -27,6 +27,10 @@ export interface CaretState {
     block: Block;
     /** One quote holds the whole selection; the block is what sits inside it. */
     quoted: boolean;
+    /** The address of the link at the caret or, for a range, of the first link in it, as the
+     *  document holds it. Present exactly when `marks` includes `'link'`. For a reference link, it
+     *  is the address its definition gives. A host's Link sheet starts from it. */
+    href?: string;
     /** In an RTF document, the alignment of the paragraph that holds the start of the selection. */
     align?: 'left' | 'center' | 'right' | 'justify';
 }
@@ -178,6 +182,9 @@ export declare class InkKitEditor<F extends DocumentFormat = TextDocumentFormat>
     private ownsRootClass;
     private activation;
     private reportingSuppressed;
+    /** A reload keeps each find session's query; a load starts without one. */
+    private reloading;
+    private readonly findSessions;
     private loading;
     private call?;
     private writable;
@@ -268,6 +275,7 @@ export declare class InkKitEditor<F extends DocumentFormat = TextDocumentFormat>
     setTextInputPreferences(preferences: TextInputPreferences): void;
     private applyInputPolicy;
     private publishCommandState;
+    private refreshFindSessions;
     /** What the editor can do now, for enabling host controls. Unlike `snapshot`, it works during
      *  composition. */
     commandState(expectedGeneration?: number): CommandState;
@@ -289,6 +297,11 @@ export declare class InkKitEditor<F extends DocumentFormat = TextDocumentFormat>
     undo(expectedGeneration?: number): boolean;
     /** Returns whether a history step applied. */
     redo(expectedGeneration?: number): boolean;
+    /** Drops the steps that `undo` took off the history, so `redo` has nothing to bring back. For a
+     *  host that adds content after an undo and must not let a redo resurrect what was undone.
+     *  Returns whether a redo was available. The document, selection, revision and undo steps stay
+     *  as they are, and no `changed` event is sent. */
+    discardUndone(expectedGeneration?: number): boolean;
     /** The complete current document, which is what a host saves. It throws rather than return a
      *  partial document. */
     snapshot(expectedGeneration?: number): DocumentSnapshot<F>;
@@ -379,6 +392,12 @@ export declare class InkKitEditor<F extends DocumentFormat = TextDocumentFormat>
     replace(search: string, replacement: string, expectedGeneration?: number): boolean;
     /** Replaces every non-overlapping match once and returns how many. */
     replaceAll(search: string, replacement: string, expectedGeneration?: number): number;
+    /**
+     * Opens a find session, which keeps a query and reports its match count and position to
+     * `onChange` whenever they change. Open one session per editor: the editor has one set of
+     * highlights.
+     */
+    findSession(onChange: (state: FindState) => void): FindSession;
     private outlineContext;
     /** The outline in document order. Entries go stale when the document changes. */
     headings(expectedGeneration?: number): readonly Heading[];

package/dist/index.js

@@ -1,4 +1,4 @@
-import { n as registerDiagram, r as InkKitError, t as InkKitEditor } from "./chunks/core-CbHV2KPY.js";
+import { a as InkKitError, i as registerDiagram, n as normalizeLinkAddress, r as InkKitEditor, t as canOpenLink } from "./chunks/core-Bn6QiQSD.js";
 //#region node_modules/.pnpm/dompurify@3.4.17/node_modules/dompurify/dist/purify.es.mjs
 /*! @license DOMPurify 3.4.17 | (c) Cure53 and other contributors | Released under the Apache license 2.0 and Mozilla Public License 2.0 | github.com/cure53/DOMPurify/blob/3.4.17/LICENSE */
 function _OverloadYield(e, d) {
@@ -32790,4 +32790,4 @@ function renderPele(source) {
 //#region src/index.ts
 registerDiagram(renderPele);
 //#endregion
-export { InkKitEditor, InkKitError };
+export { InkKitEditor, InkKitError, canOpenLink, normalizeLinkAddress };

package/dist/link-address.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The address a Link field should write for what the person typed, or `undefined` when it is not
+ * a web, mail or phone address. See the reference, which describes each rule.
+ */
+export declare function normalizeLinkAddress(input: string): string | undefined;
+/**
+ * Whether a host may open `address` for the person. Only `http`, `https`, `mailto` and `tel`
+ * qualify, whatever the letter case. An address with no scheme, an unknown scheme such as
+ * `javascript:` or `file:`, or a control character does not.
+ */
+export declare function canOpenLink(address: string): boolean;

package/dist/types.d.ts

@@ -120,7 +120,7 @@ export interface RichTextDocumentSnapshot extends RichTextDocumentInput, Documen
     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', 'slash-command-failed', 'internal'];
+export declare const editorErrorCodes: readonly ['not-ready', 'destroyed', 'stale-document', 'composition', 'operation-pending', 'read-only', 'invalid-argument', 'invalid-range', 'preservation', 'image-unavailable', 'image-unsupported', '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
@@ -310,6 +310,44 @@ export interface ReadableTextSnapshot extends DocumentVersion {
     text: string;
     selection: TextRange;
 }
+/** What a find session shows: how many matches the query has and which one the selection is on. */
+export interface FindState extends DocumentVersion {
+    /** The query, or an empty string when there is none. */
+    query: string;
+    /** The position, from 1, of the match that the selection covers exactly, or 0 when the selection
+     *  is not on a match. */
+    current: number;
+    /** The number of matches. */
+    total: number;
+}
+/**
+ * A find bar's state and commands: the query, the match count, the match the selection is on, and
+ * navigation that wraps. Open one with `InkKitEditor.findSession`.
+ */
+export interface FindSession {
+    /** The current state. It does not call the change handler. */
+    state(expectedGeneration?: number): FindState;
+    /** Sets the query, highlights its matches and selects one. A new query selects the first match
+     *  at or after the selection, or the last one before it with `direction: 'previous'`. With the
+     *  same query, the selection moves to the next or previous match and wraps at the ends; without
+     *  a direction, a selection on a match stays there. Returns whether there is a match. */
+    find(query: string, options?: {
+        direction?: 'next' | 'previous';
+    }, expectedGeneration?: number): boolean;
+    /** Moves to the next match, wrapping at the end. Returns whether there is a match. */
+    next(expectedGeneration?: number): boolean;
+    /** Moves to the previous match, wrapping at the start. Returns whether there is a match. */
+    previous(expectedGeneration?: number): boolean;
+    /** Replaces the selected match, or the next one, and selects the match after it. Returns whether
+     *  the text changed. A match that already reads as the replacement is skipped without a change. */
+    replace(query: string, replacement: string, expectedGeneration?: number): boolean;
+    /** Replaces every match and returns how many were replaced. */
+    replaceAll(query: string, replacement: string, expectedGeneration?: number): number;
+    /** Clears the query and the highlights. */
+    clear(expectedGeneration?: number): void;
+    /** Stops the session: it clears the highlights and its handler is not called again. */
+    close(): void;
+}
 /** A rectangle in CSS pixels in the web view's client coordinate space. */
 export interface TextRect {
     left: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aicayzer/inkkit",
-  "version": "0.6.1",
+  "version": "0.7.1",
   "description": "A preserving Markdown editor for offline web views and the web",
   "license": "MIT",
   "type": "module",
@@ -55,6 +55,8 @@
     "test:package": "node scripts/test-package.mjs",
     "check": "pnpm typecheck && pnpm test && pnpm build && pnpm test:docs && pnpm test:package",
     "test:browser": "playwright test --project=chromium",
+    "test:playground": "playwright test --config playwright.playground.config.ts --project=chromium",
+    "measure:browser": "playwright test --config playwright.measure.config.ts",
     "test:built-playground": "playwright test --config playwright.built.config.ts"
   },
   "devDependencies": {