postext-folio 0.52.6 → 0.52.8

package/dist/postext.d.ts

@@ -1,127 +1,9 @@
-import { type PrintPreview, type VDTDocument, type VDTPage } from "postext";
-import { type FolioAppearance, type FolioOptions, type FolioPagePoint, type FolioViewer } from "./viewer.js";
-export interface FolioDocumentOptions extends Omit<FolioOptions, "pages" | "firstPageRecto" | "binding" | "at" | "aspect"> {
-    /** The page to open on (0-based). Default 0. */
-    at?: number;
-    /** Spreads painted on either side of the open one; pages farther away
-     *  are let go (drawn as blank paper should a long turn sweep past them).
-     *  Default 3. */
-    window?: number;
-    /** Passed to `renderPageToCanvas` (see its `RenderPageOptions`). */
-    singleInk?: boolean;
-    pageNegative?: boolean;
-    /** The print preview (soft proof) of the pages (`createPrintPreview`).
-     *  With `paper: true` the proof brings the paper's white: give the book
-     *  a neutral paper shade meanwhile, or it tints that paper again. */
-    printPreview?: PrintPreview;
-    /** A page's text alternative. Default `Page n`. */
-    alt?: (index: number) => string;
-    /**
-     * Draws over a painted page (a selection, a caret): `ctx` is set to the
-     * page's own pixels (the untrimmed sheet, as the document's coordinates
-     * are), over the page as painted. Returns whether it drew anything. Run
-     * when a page is painted and on `redecorate`.
-     */
-    decorate?: (index: number, ctx: CanvasRenderingContext2D) => boolean;
-    /**
-     * Videos printed on the pages play there (#477): a click on a video's
-     * poster plays it on the page (in every pointer mode), a click on it
-     * again pauses it, and it goes on playing while its leaf turns. Several
-     * may play at once (#507, up to eight drawn): starting a video stops the
-     * other exclusive ones (`player.exclusive`, the default) and holds those
-     * playing alongside (`exclusive: false`) until it pauses or ends; one
-     * playing alongside pauses only the exclusive ones. A video with
-     * `player.autoplay` starts by itself, muted: an exclusive one the first
-     * time its spread is shown (with its sound once the reader has
-     * interacted with the page), one playing alongside each time its page
-     * comes into view, unless the reader asks for less motion
-     * (`prefers-reduced-motion`). A video stops when the book comes to rest
-     * on a spread that does not show it. Self-hosted videos only (a file, or its
-     * address: MP4, WebM or an HLS stream); a YouTube or Vimeo poster turns
-     * the page as any other. The video's server must allow cross-origin
-     * reads (CORS) for WebGL to draw it. Default true.
-     */
-    videos?: boolean;
-    /** The address a self-hosted video's file plays from (an object URL for
-     *  its `fileId`); without one, its production address (`video.url`). */
-    videoUrl?: (fileId: string) => string | undefined;
-    /** Told when a video on a page starts playing, pauses, stops or cannot
-     *  play (`error`: no address, a refused cross-origin read, no HLS). */
-    onVideo?: (event: {
-        resourceId: string;
-        page: number;
-        state: "playing" | "paused" | "stopped" | "error";
-    }) => void;
-}
-export interface FolioDocumentViewer extends FolioViewer {
-    /** Shows another layout of the book (after an edit), on the same page
-     *  unless `at` says otherwise. A page that reads the same as before
-     *  keeps its painting; `repaint` paints every page again (an image that
-     *  came in after the pages were painted). `appearance` is laid over the
-     *  host's own, as `setAppearance` does, for the new document (a chapter
-     *  saying how many pages of the book lie round it). */
-    setDocument(doc: VDTDocument, options?: {
-        at?: number;
-        repaint?: boolean;
-        appearance?: FolioAppearance;
-    }): void;
-    /** Draws the decorations (`decorate`) again on these pages, or on every
-     *  painted page; the book shows them at once, on a turning leaf too. */
-    redecorate(pages?: Iterable<number>): void;
-    /** Plays or pauses the video printed at a point of a page, as a click
-     *  there does; false when no playable video lies there. */
-    toggleVideoAt(point: FolioPagePoint): boolean;
-    /** Stops the videos playing on the pages (their posters show again). */
-    stopVideo(): void;
-}
-/** Whether the document's first page is a recto: page 1, or a chapter
- *  continued after an even number of pages. */
-export declare function firstPageIsRecto(doc: VDTDocument): boolean;
-/** A page's width and height as bound: the trim box, since a book is cut
- *  (a sheet laid out with cut lines also carries the bleed, the slug and
- *  the crop marks, none of which a bound page shows). */
-export declare function trimmedSize(page: VDTPage, doc: VDTDocument): {
-    width: number;
-    height: number;
-};
-/** How the document's book is presented: its `folio` settings, its page
- *  width, the book's pages before and after it (a chapter of a longer
- *  book), with the host's own appearance laid over them. The pages round
- *  it are the host's word when it gives them (`extraPages`: a host laying
- *  a book out a chapter at a time knows the chapters after this one, which
- *  the document only knows when it was given the book's page count). A
- *  newspaper trim (`page.sizePreset` broadsheet, berliner, tabloid or
- *  compact) shows folded newsprint unless the settings name a stock or a
- *  binding (#506). */
-export declare function appearanceOf(doc: VDTDocument, own: FolioAppearance | undefined): FolioAppearance;
-/**
- * Which paintings a new layout can keep: new page index → old page index,
- * for every page of `wanted` that is the same page as a painted one (the
- * same object, or one that reads the same). Each old painting goes to one
- * page at most.
- */
-export declare function carriedPaintings(before: readonly VDTPage[], painted: Iterable<number>, next: readonly VDTPage[], wanted: Iterable<number>): Map<number, number>;
-/** A run of turns, from the spread at rest to the book's next rest: where
- *  its leaves started and, when it opened with a block jump, the spread
- *  that block lands on. */
-export interface SweepRun {
-    from: number[];
-    block: number[] | null;
-}
-/**
- * The pages a turn to `target` sweeps past, in the order its leaves lift,
- * and the run it belongs to. A turn set at rest (`run` null) more than
- * `BLOCK_PAGES` away goes over as one block, as the renderer turns it: it
- * keeps only the pages on show (the block's top face), the target's being
- * painted with it. A target set while leaves are in the air carries the
- * run on leaf by leaf (the renderer lifts a block only with no leaf in
- * the air), so every page from where the run started (or its block
- * lands) to the target is swept, a run of fast clicks included.
- */
-export declare function sweepFor(run: SweepRun | null, settled: number[], target: number[], count: number): {
-    run: SweepRun;
-    pages: number[];
-};
+import { type VDTDocument } from 'postext';
+import type { FolioDocumentOptions, FolioDocumentViewer } from './postext/types.js';
+export type { FolioDocumentOptions, FolioDocumentViewer } from './postext/types.js';
+export { firstPageIsRecto, trimmedSize, appearanceOf, carriedPaintings } from './postext/book.js';
+export { sweepFor } from './postext/sweep.js';
+export type { SweepRun } from './postext/sweep.js';
 /**
  * A postext document as a book: `createFolio` over its pages, painted with
  * `renderPageToCanvas` at exactly the device pixels of a page slot, so the

package/dist/postext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"postext.d.ts","sourceRoot":"","sources":["../src/postext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,KAAK,OAAO,EAAE,MAAM,SAAS,CAAC;AAGhG,OAAO,EAAe,KAAK,eAAe,EAAE,KAAK,YAAY,EAAE,KAAK,cAAc,EAAuC,KAAK,WAAW,EAAE,MAAM,aAAa,CAAC;AAG/J,MAAM,WAAW,oBAAqB,SAAQ,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,gBAAgB,GAAG,SAAS,GAAG,IAAI,GAAG,QAAQ,CAAC;IACxH,gDAAgD;IAChD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;qBAEiB;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oEAAoE;IACpE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;yEAEqE;IACrE,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,mDAAmD;IACnD,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;IAChC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,wBAAwB,KAAK,OAAO,CAAC;IACrE;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;4EACwE;IACxE,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;IAClD;2EACuE;IACvE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAA;KAAE,KAAK,IAAI,CAAC;CACpH;AAED,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD;;;;;2DAKuD;IACvD,WAAW,CAAC,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE;QAAE,EAAE,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,UAAU,CAAC,EAAE,eAAe,CAAA;KAAE,GAAG,IAAI,CAAC;IAChH;4EACwE;IACxE,UAAU,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAC3C;+DAC2D;IAC3D,aAAa,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC;IAC9C,wEAAwE;IACxE,SAAS,IAAI,IAAI,CAAC;CACnB;AAED;+CAC+C;AAC/C,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAE1D;AAED;;yDAEyD;AACzD,wBAAgB,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,WAAW,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAG9F;AAQD;;;;;;;;sBAQsB;AACtB,wBAAgB,YAAY,CAAC,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,eAAe,GAAG,SAAS,GAAG,eAAe,CAmBhG;AAiBD;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,SAAS,OAAO,EAAE,EAC1B,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,EACzB,IAAI,EAAE,SAAS,OAAO,EAAE,EACxB,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,GACvB,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAoBrB;AAKD;;2BAE2B;AAC3B,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CACxB;AAED;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,QAAQ,GAAG,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG;IAAE,GAAG,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CAAE,CAerI;AAyCD;;;;;;;;;;;;GAYG;AACH,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,WAAW,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,GAAE,oBAAyB,GAAG,mBAAmB,CAqtBzI"}
+{"version":3,"file":"postext.d.ts","sourceRoot":"","sources":["../src/postext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAK3C,OAAO,KAAK,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAMpF,YAAY,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACpF,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAClG,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,YAAY,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;;;;;;;;;;GAYG;AACH,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,WAAW,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,GAAE,oBAAyB,GAAG,mBAAmB,CA2PzI"}