@openleaf-editor/ui 0.1.0-beta.1 → 0.1.0-beta.3

package/dist/css.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"css.js","sourceRoot":"","sources":["../src/css.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH;;;;;;;GAOG;AACH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AAEH,MAAM,WAAW,GAAG;;;;;;;;;;;CAWnB,CAAA;AAED,MAAM,CAAC,MAAM,GAAG,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mEAiDgD,WAAW;;;0DAGpB,WAAW;;qCAEhC,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkpB/C,CAAA"}

package/dist/dialog.d.ts

@@ -22,42 +22,182 @@
 import { type ImageUploadResult } from './upload.js';
 export interface LinkResult {
     href: string;
+    title: string | null;
     target: string | null;
     rel: string | null;
+    id: string | null;
 }
 export interface ImageResult {
     src: string;
     /** `''` means explicitly decorative. `null` is never returned. */
     alt: string;
+    title: string | null;
     /** Intrinsic size, when an uploader reported one. */
     width: string | null;
     height: string | null;
+    className: string | null;
+    align: 'left' | 'right' | 'center' | null;
+    caption: string | null;
 }
+export interface FieldOption {
+    value: string;
+    label: string;
+}
+export interface FieldSpec {
+    name: string;
+    label: string;
+    type?: string;
+    value?: string;
+    required?: boolean;
+    hint?: string;
+    /** For `type: 'file'`: the accept list. */
+    accept?: string;
+    /** When set, the field is a `<select>` rather than an input. */
+    options?: readonly FieldOption[];
+    /**
+     * The field this control writes into when it changes.
+     *
+     * A chooser that only *contributed* its value could never change a field that
+     * was already filled in: editing a link or an image prefills the address, so
+     * picking from the list lost to it every time and the list worked only for new
+     * insertions. Writing into the field it fills keeps one source of truth, and
+     * shows the author what they picked so they can still edit it.
+     */
+    fills?: string;
+}
+/**
+ * A commit failure.
+ *
+ * `field` names the control the message is about, when there is one. Without it
+ * a failed submit could only mark the FIRST field invalid and focus it, which is
+ * a guess -- and a wrong `aria-invalid` is worse for a screen reader user than
+ * none, because it sends them to correct a field that was already right.
+ */
+export interface CommitError {
+    error: string;
+    field?: string;
+}
+/**
+ * Install the dialog sheet.
+ *
+ * Delegates to `registerStyles` rather than repeating the constructable-sheet
+ * dance, which also removes this file's `<style>`-element fallback. That
+ * fallback contradicted the invariant argued at the top of `styles.ts`: a
+ * `<style>` element is blocked by exactly the `style-src 'self'` policies that
+ * would need it, and it fails silently. `registerStyles` warns instead, once,
+ * naming the stylesheet to link.
+ *
+ * It also deduplicates per *document* by the CSS text, where the flag this used
+ * to keep was module-global -- so a second document (an iframe, a print view)
+ * previously got the dialog markup with none of its styles.
+ */
+export declare function ensureDialogStyles(doc: Document): void;
+export interface PromptFormOptions {
+    extraCheckbox?: {
+        name: string;
+        label: string;
+        hint?: string;
+        checked?: boolean;
+    };
+    note?: string;
+    busyLabel?: string;
+    /** The editor's own `lang`, so two editors on a page do not share a language. */
+    locale?: string | null;
+    /**
+     * The editor the dialog belongs to. Pass it: the dialog is mounted inside
+     * this element so the skin's tokens reach it, and without it the dialog is
+     * painted in the default light palette whatever the editor looks like.
+     */
+    host?: HTMLElement;
+}
+/**
+ * A generic modal form, used by table property dialogs and anything else that
+ * is a handful of labelled fields rather than a specialised prompt.
+ */
+export declare function promptFields<T>(doc: Document, title: string, fields: FieldSpec[], options: PromptFormOptions, commit: (values: Record<string, string>, files: Record<string, File | undefined>) => Promise<{
+    value: T;
+} | {
+    error: string;
+}> | {
+    value: T;
+} | {
+    error: string;
+}): Promise<T | null>;
 export declare function promptForLink(doc: Document, existing?: {
     href?: string;
+    title?: string | null;
     target?: string | null;
-}): Promise<LinkResult | null>;
+    rel?: string | null;
+    id?: string | null;
+}, host?: HTMLElement): Promise<LinkResult | null>;
 export interface ImagePromptOptions {
-    /**
-     * A file the author has already chosen, by dropping or pasting it.
-     *
-     * When present the dialog does not offer a picker or an address field: the
-     * source is settled and the only open question is the description.
-     */
     file?: File;
-    /** Uploads a file and reports where it landed. Absent means URL-only. */
     upload?: (file: File) => Promise<ImageUploadResult>;
+    host?: HTMLElement;
+    existing?: {
+        src?: string;
+        alt?: string | null;
+        title?: string | null;
+        className?: string | null;
+        align?: 'left' | 'right' | 'center' | null;
+        caption?: string | null;
+        width?: string | null;
+        height?: string | null;
+    };
+}
+export declare function promptForImage(doc: Document, options?: ImagePromptOptions): Promise<ImageResult | null>;
+/** One alternative address the author gave the player. */
+export interface MediaSourceResult {
+    src: string;
+    type: string | null;
+}
+export interface MediaResult {
+    /** Empty when the player carries all its addresses in `sources`. */
+    src: string;
+    title: string | null;
+    poster: string | null;
+    width: string | null;
+    height: string | null;
+    sources: MediaSourceResult[];
+}
+export interface MediaPromptOptions {
+    host?: HTMLElement;
+    /** Prefilled state, when editing a player already in the document. */
+    existing?: {
+        /**
+         * What the selected node is. An `<iframe>` accepts only the addresses the
+         * embed allowlist permits, and the form has to say so itself: the update
+         * command declines anything else, and by then this dialog has closed, so a
+         * rejected address looked like a save that did nothing.
+         */
+        kind?: 'video' | 'audio' | 'iframe';
+        src?: string | null;
+        title?: string | null;
+        poster?: string | null;
+        width?: string | null;
+        height?: string | null;
+        sources?: readonly MediaSourceResult[];
+    };
 }
 /**
- * Ask for an image.
- *
- * The alternative text is asked for in the same dialog as the file, and this is
- * the reason the upload happens on submit rather than on selection: one dialog
- * means one decision point, and there is no path through it that inserts an
- * image nobody described. A drop that uploaded immediately and asked afterwards
- * would leave an undescribed image in the document every time somebody cancelled
- * -- and OpenLeaf has no image-editing dialog yet, so "afterwards" would mean
- * never.
+ * The insert-media dialog.
+ *
+ * Two spare alternative-source rows, because that is the shape the format is
+ * actually used in: a `<video>` with a `.webm` and an `.mp4` covers every
+ * current browser, and offering a single alternative makes the common case the
+ * one the author has to work around. Not a growable list with add and remove
+ * controls, which would owe keyboard semantics and a reordering story.
+ *
+ * But the rows are spare capacity *on top of* what the player already has, never
+ * a cap on it. A fixed two rows silently deleted the third and later encodings
+ * of any player that had them, on a save the author made to change the title --
+ * because what this form returns is what replaces the stored sources. Every
+ * existing source gets a row, so the form cannot lose one it was never shown.
+ *
+ * The type hints are separate fields rather than guessed from the extension. A
+ * guess is wrong for exactly the addresses that need it -- a signed URL, or a
+ * stream with no extension at all -- and being wrong here means the browser
+ * downloads a format it cannot play before finding out.
  */
-export declare function promptForImage(doc: Document, options?: ImagePromptOptions): Promise<ImageResult | null>;
+export declare function promptForMedia(doc: Document, options?: MediaPromptOptions): Promise<MediaResult | null>;
 //# sourceMappingURL=dialog.d.ts.map

package/dist/dialog.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dialog.d.ts","sourceRoot":"","sources":["../src/dialog.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAGH,OAAO,EAA2B,KAAK,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAE7E,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAA;IACX,kEAAkE;IAClE,GAAG,EAAE,MAAM,CAAA;IACX,qDAAqD;IACrD,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;CACtB;AA8TD,wBAAsB,aAAa,CACjC,GAAG,EAAE,QAAQ,EACb,QAAQ,CAAC,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GACnD,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAuC5B;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,yEAAyE;IACzE,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAA;CACpD;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,cAAc,CAClC,GAAG,EAAE,QAAQ,EACb,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CAgF7B"}
+{"version":3,"file":"dialog.d.ts","sourceRoot":"","sources":["../src/dialog.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAKH,OAAO,EAA2B,KAAK,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAQ7E,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAClB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;CAClB;AAkCD,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAA;IACX,kEAAkE;IAClE,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,qDAAqD;IACrD,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,IAAI,CAAA;IACzC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;CACvB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,2CAA2C;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,gEAAgE;IAChE,OAAO,CAAC,EAAE,SAAS,WAAW,EAAE,CAAA;IAChC;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AA6FD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,QAAQ,GAAG,IAAI,CAGtD;AAqZD,MAAM,WAAW,iBAAiB;IAChC,aAAa,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;IACjF,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,iFAAiF;IACjF,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB;;;;OAIG;IACH,IAAI,CAAC,EAAE,WAAW,CAAA;CACnB;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,GAAG,EAAE,QAAQ,EACb,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,SAAS,EAAE,EACnB,OAAO,EAAE,iBAAiB,EAC1B,MAAM,EAAE,CACN,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC9B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,GAAG,SAAS,CAAC,KACpC,OAAO,CAAC;IAAE,KAAK,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,GAAG;IAAE,KAAK,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAChF,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAEnB;AAED,wBAAsB,aAAa,CACjC,GAAG,EAAE,QAAQ,EACb,QAAQ,CAAC,EAAE;IACT,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,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,EACD,IAAI,CAAC,EAAE,WAAW,GACjB,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAoF5B;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,iBAAiB,CAAC,CAAA;IACnD,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB,QAAQ,CAAC,EAAE;QACT,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACnB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACrB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACzB,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,IAAI,CAAA;QAC1C,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACvB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KACvB,CAAA;CACF;AAED,wBAAsB,cAAc,CAClC,GAAG,EAAE,QAAQ,EACb,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CAoL7B;AAMD,0DAA0D;AAC1D,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,oEAAoE;IACpE,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,OAAO,EAAE,iBAAiB,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB,sEAAsE;IACtE,QAAQ,CAAC,EAAE;QACT;;;;;WAKG;QACH,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAA;QACnC,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACnB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACtB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACrB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACtB,OAAO,CAAC,EAAE,SAAS,iBAAiB,EAAE,CAAA;KACvC,CAAA;CACF;AAKD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,cAAc,CAClC,GAAG,EAAE,QAAQ,EACb,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CA2H7B"}