@openleaf-editor/core 0.1.0-beta.2 → 0.1.0-beta.3

package/dist/insert-commands.d.ts

@@ -0,0 +1,172 @@
+import type { Command, EditorState } from 'prosemirror-state';
+import { type ImageAlign } from './tokens.js';
+export interface LinkAttrs {
+    href: string;
+    title?: string | null;
+    target?: string | null;
+    rel?: string | null;
+    id?: string | null;
+}
+/**
+ * Apply or update a link across the selection.
+ *
+ * Removes any existing link first: without that, updating a link that only
+ * partially overlaps the selection leaves two adjacent links with different
+ * hrefs, which looks fine and is wrong.
+ *
+ * Declines an href the schema would refuse. The parse rule at `schema.ts:541`
+ * already rejects `javascript:`, but only on the way *in* -- so without this
+ * check the hostile href lives in the document, serializes into the bound
+ * textarea and is submitted. It disappears on the next parse, one round trip
+ * after the server stored it, which is the wrong side of the write.
+ */
+export declare function setLink(attrs: LinkAttrs): Command;
+export declare const unsetLink: Command;
+export interface ImageAttrs {
+    src: string;
+    alt?: string | null;
+    title?: string | null;
+    width?: string | null;
+    height?: string | null;
+    align?: ImageAlign | null;
+    className?: string | null;
+    /**
+     * When present, the image is wrapped in `<figure>` with this caption.
+     * An empty string still wraps: a figure with no caption text is how an
+     * author says "this will have a caption" without writing one yet.
+     */
+    caption?: string | null;
+}
+/**
+ * Insert an image, optionally wrapped in a captioned `<figure>`.
+ *
+ * Declines a `src` the schema would refuse, for the same reason `setLink` does:
+ * the parse rule only guards the way in, so an unchecked `javascript:` src is
+ * live in the document and submitted with the form before anything strips it.
+ */
+export declare function insertImage(attrs: ImageAttrs): Command;
+export interface SelectedImage {
+    /** Document position of the `image` node, for `setNodeMarkup`. */
+    pos: number;
+    src: string;
+    alt: string | null;
+    title: string | null;
+    width: string | null;
+    height: string | null;
+    align: ImageAlign | null;
+    className: string | null;
+    /**
+     * Caption text when the image lives in a `<figure>`, including `''` for a
+     * figure whose figcaption is still empty. `null` means there is no figure.
+     */
+    caption: string | null;
+}
+/**
+ * The image the selection is on, or null.
+ *
+ * A `NodeSelection` on `image` counts, and so does one on a `figure` that
+ * contains an image -- clicking the picture and clicking the figure around it
+ * are the same author intent. A caret beside an image is not: treating that as
+ * a selection would let the dialog retarget a neighbour when the author meant
+ * to insert, the same trap `selectedMedia` refuses.
+ */
+export declare function selectedImage(state: EditorState): SelectedImage | null;
+/**
+ * Update the selected image in place.
+ *
+ * `setNodeMarkup` rather than replace-with-a-new-node: the surrounding
+ * `<figure>`, the author's `class`, and dimensions the dialog does not edit
+ * all survive a save that only changed the address or the alt text. Replacing
+ * the `NodeSelection` dropped every one of those, including the figcaption.
+ *
+ * Attributes omitted from `attrs` (`undefined`) stay as they were. `null` is
+ * an explicit clear -- except `src`, which must be a storeable address.
+ */
+export declare function updateImage(attrs: ImageAttrs): Command;
+export declare function insertText(text: string): Command;
+export declare const insertNonBreakingSpace: Command;
+export declare const insertPageBreak: Command;
+export declare function insertNamedAnchor(id: string): Command;
+export declare function setHeadingId(id: string | null): Command;
+export declare function insertDetails(summaryText?: string): Command;
+/**
+ * One `<source>` row from the insert-media dialog.
+ *
+ * `type` is the MIME hint a browser uses to pick between alternatives without
+ * downloading them. It is optional because a dialog cannot always know it, and
+ * a `<source>` with no type is still a working source.
+ */
+export interface MediaSource {
+    src: string;
+    type?: string | null;
+}
+export interface MediaAttrs {
+    /**
+     * Optional, because a player may carry its addresses in `sources` instead --
+     * the source-only shape `mediaAttrs` accepts on parse. One or the other must
+     * be present; a player with neither has nothing to play.
+     */
+    src?: string | null;
+    title?: string | null;
+    width?: string | null;
+    height?: string | null;
+    /**
+     * Omitted means different things on the two paths, deliberately. Inserting a
+     * player with no opinion gets controls, because a player nobody can start is
+     * not much of one. Updating one with no opinion changes nothing, because the
+     * caller did not ask to.
+     */
+    controls?: boolean;
+    poster?: string | null;
+    allow?: string | null;
+    allowfullscreen?: boolean;
+    /**
+     * Alternative addresses, stored as the `<source>` children of the player.
+     *
+     * Authoritative for `<source>` on an update: what is passed replaces what is
+     * there. Other furniture -- `<track>` captions -- is carried through, so a
+     * caller that cannot see them cannot delete them.
+     */
+    sources?: readonly MediaSource[];
+}
+export declare function insertVideo(attrs: MediaAttrs): Command;
+export declare function insertAudio(attrs: MediaAttrs): Command;
+export interface SelectedMedia {
+    kind: 'video' | 'audio' | 'iframe';
+    /** Document position of the node, for `setNodeMarkup`. */
+    pos: number;
+    src: string | null;
+    title: string | null;
+    width: string | null;
+    height: string | null;
+    controls: boolean;
+    poster: string | null;
+    /** Alternative addresses read back out of the stored `<source>` children. */
+    sources: MediaSource[];
+}
+/**
+ * The media node the selection is on, or null.
+ *
+ * Only a `NodeSelection` counts. A caret beside a player is not a selection of
+ * it, and treating it as one would let the dialog silently retarget: the author
+ * clicks away, opens the dialog expecting to insert, and edits the node they
+ * had selected a moment ago instead.
+ */
+export declare function selectedMedia(state: EditorState): SelectedMedia | null;
+/**
+ * Update the selected media node in place.
+ *
+ * `setNodeMarkup` rather than replace-with-a-new-node: the position and the
+ * selection both survive, so the player the author was editing is still the
+ * selected one afterwards and a second edit does not have to find it again.
+ */
+export declare function updateMedia(attrs: MediaAttrs): Command;
+export declare function insertIframe(attrs: MediaAttrs): Command;
+/**
+ * Parse HTML against the live schema and insert it.
+ *
+ * Used by the snippet picker. The HTML still goes through the same parse
+ * pipeline as stored content, so a snippet cannot smuggle in a `<script>`.
+ */
+export declare function insertHtml(html: string): Command;
+//# sourceMappingURL=insert-commands.d.ts.map

package/dist/insert-commands.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"insert-commands.d.ts","sourceRoot":"","sources":["../src/insert-commands.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAM7D,OAAO,EAA8C,KAAK,UAAU,EAAE,MAAM,aAAa,CAAA;AASzF,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACnB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CA0BjD;AAED,eAAO,MAAM,SAAS,EAAE,OAYvB,CAAA;AAED,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,KAAK,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACxB;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAkCtD;AAED,MAAM,WAAW,aAAa;IAC5B,kEAAkE;IAClE,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;IACxB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB;;;OAGG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;CACvB;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,WAAW,GAAG,aAAa,GAAG,IAAI,CAYtE;AAwBD;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CA0CtD;AAED,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAMhD;AAED,eAAO,MAAM,sBAAsB,EAAE,OAA8B,CAAA;AAEnE,eAAO,MAAM,eAAe,EAAE,OAQ7B,CAAA;AAED,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAWrD;AAED,wBAAgB,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAmBvD;AAED,wBAAgB,aAAa,CAAC,WAAW,SAAY,GAAG,OAAO,CAkB9D;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACrB;AAED,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,SAAS,WAAW,EAAE,CAAA;CACjC;AAoED,wBAAgB,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAyBtD;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAsBtD;AAKD,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAA;IAClC,0DAA0D;IAC1D,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,QAAQ,EAAE,OAAO,CAAA;IACjB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,6EAA6E;IAC7E,OAAO,EAAE,WAAW,EAAE,CAAA;CACvB;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,WAAW,GAAG,aAAa,GAAG,IAAI,CAkBtE;AAuBD;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CA2CtD;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAwBvD;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAShD"}