postext-folio 0.52.6 → 0.52.8

package/dist/viewer.d.ts

@@ -1,245 +1,6 @@
-import { type FolioConfig, type FolioPaperConfig } from "postext";
-import { type PageSource, type PageVideoFrame } from "./pageFlip.js";
-/** A page of the book: its source, or its source with a text alternative
- *  and the paper it is printed on when that is not the book's (a plate
- *  section on gloss in a matte book). */
-export type FolioPage = PageSource | {
-    src: PageSource;
-    alt?: string;
-    paper?: FolioPaperConfig;
-};
-/** How the 3D book is presented. */
-export interface FolioAppearance {
-    /** View, paper, binding, desk and light (postext's `folio` config). */
-    folio?: FolioConfig;
-    /** The trim width of a page in mm (the paper's caliper and the cover's
-     *  board are scaled against it). Default 150. */
-    pageWidthMm?: number;
-    /** Pages of the book before the first page given and after the last
-     *  (the other chapters of a book shown a chapter at a time): they are
-     *  never drawn, only counted for the thickness of the page block.
-     *  `createFolioFromDocument` places the covers by them too: with pages
-     *  before, the first page given is not the book's front cover, nor with
-     *  pages after the last its back cover (a chapter from the middle of a
-     *  book with its own covers turns paper leaves). */
-    extraPages?: {
-        before: number;
-        after: number;
-    };
-    /** Where the scanned desk textures are served (see
-     *  `FlipAppearance.textureBaseUrl`). */
-    textureBaseUrl?: string;
-    /** The first page given is the book's front cover, the last its back
-     *  cover (when it falls on a verso): they turn as boards and no case
-     *  is drawn round the pages. */
-    covers?: {
-        front: boolean;
-        back: boolean;
-    };
-    /** The picture printed on the spine: the image the `folio.binding.
-     *  spineImage` resource names, as a URL (or a drawn canvas or image).
-     *  See `FlipAppearance.spineImage`. */
-    spineImage?: PageSource;
-}
-/** What the left button (or one finger) does on the book: `hand` takes
- *  and turns the pages, `orbit` turns the view round the book (what the
- *  right button always does), `select` leaves the pointer to the host (to
- *  select text: `pageAt` says where on which page it is), `magnify` holds
- *  a magnifying glass over the book where the pointer is (#527; a finger
- *  holds it above itself while it touches the screen): the wheel, + and −
- *  change how much it magnifies, Esc puts it away. The pointer is left to
- *  the host under the glass too, a text cursor over the pages (#543):
- *  `pageAt` then says what lies under the glass's centre. */
-export type FolioInteraction = "hand" | "orbit" | "select" | "magnify";
-/** The magnifying glass (`interaction: 'magnify'`). */
-export interface FolioMagnifier {
-    /** How many times it magnifies the book at its centre (1.5 … 10).
-     *  Default: enough to show the page at about 5.5 CSS px a millimetre
-     *  (small print readable), between 2 and 8. */
-    zoom?: number;
-    /** The glass's diameter with its rim, in CSS px. Default 42 % of the
-     *  viewer's shorter side, between 180 and 520. */
-    diameter?: number;
-}
-/** Sharper paintings of the pages for the magnifying glass: without them
- *  it magnifies the pages as given (an image at its natural size, a
- *  canvas at its own). */
-export interface FolioPageDetail {
-    /** Page `index` painted `deviceWidth` px wide (or as near as the host
-     *  can): the glass shows it in place of the page's own source. */
-    paint(index: number, deviceWidth: number): PageSource | Promise<PageSource>;
-    /** The glass was put away (another interaction): the paintings can be
-     *  let go. */
-    release?(): void;
-}
-/** A point on a page as printed: the page index and where on it, as
- *  fractions of its width and height from its top left corner. */
-export interface FolioPagePoint {
-    page: number;
-    x: number;
-    y: number;
-}
-/** A video drawn on a page of the book (#477): the element playing it and
- *  where its picture lies on the page (see `PageVideoFrame`). */
-export interface FolioPageVideo extends PageVideoFrame {
-    page: number;
-    element: HTMLVideoElement;
-}
-export interface FolioLabels {
-    /** The viewer's accessible name. */
-    region: string;
-    prev: string;
-    next: string;
-    /** The pages on show, for the live count under the book: page indexes
-     *  (0-based) and the page count. */
-    count: (pages: number[], total: number) => string;
-}
-export interface FolioOptions {
-    pages: FolioPage[];
-    /** Whether the first page is a recto (it opens alone, on the right of a
-     *  left-bound book). Default true. */
-    firstPageRecto?: boolean;
-    /** The edge the book is bound on. A right-bound book lies mirrored: page
-     *  1 alone on the left, pairs [3 | 2], and its pages turn leftward. */
-    binding?: "left" | "right";
-    /** The page to open on (0-based). Default 0. */
-    at?: number;
-    /** `double` shows spreads and turns leaves in 3D; `single` one page at a
-     *  time; `auto` (default) is single in a box narrower than 560 px. */
-    mode?: "auto" | "single" | "double";
-    /** A page's width / height, when the pages cannot tell it yet (blank
-     *  until painted). Default: the first sized page's, else 1 : √2. */
-    aspect?: number;
-    /** The colour of blank pages (any CSS colour). Default white. */
-    paper?: string;
-    /** Turns leaves in 3D when WebGL2 is there and the reader has not asked
-     *  for reduced motion. Default true. */
-    animate?: boolean;
-    /** Draws the ‹ › buttons and the page count. Default true. */
-    controls?: boolean;
-    /** Shows the page count under the book. Default true. When false it is
-     *  still announced to screen readers (a visually hidden live region). */
-    showCount?: boolean;
-    labels?: Partial<FolioLabels>;
-    /** How the 3D book is presented (see {@link FolioAppearance}). */
-    appearance?: FolioAppearance;
-    /** What the left button does (see {@link FolioInteraction}). Default
-     *  `hand`. */
-    interaction?: FolioInteraction;
-    /** The magnifying glass (see {@link FolioMagnifier}). */
-    magnifier?: FolioMagnifier;
-    /** Sharper paintings for the magnifying glass (see
-     *  {@link FolioPageDetail}). */
-    detail?: FolioPageDetail;
-    /** Told of every spread that settles: its index and the pages on show. */
-    onChange?: (state: FolioState) => void;
-    /** Told as soon as the book is sent to another spread (a button, a key,
-     *  a page let go past halfway), before its leaves have landed. */
-    onTarget?: (state: FolioState) => void;
-    /** A click on a page, before it turns the page (hand mode) or reaches
-     *  the host (select mode): return true when the click did something else,
-     *  such as playing a video printed there. In orbit and select modes it is
-     *  asked only where `isPageAction` says a click acts. */
-    onPageClick?: (point: FolioPagePoint) => boolean;
-    /** Whether a click at this point of a page acts on it (`onPageClick`):
-     *  the pointer shows a hand there. */
-    isPageAction?: (point: FolioPagePoint) => boolean;
-    /** Told when the page slots change size: a host painting pages for the
-     *  viewer paints them at `deviceWidth` × `deviceHeight` pixels, so they
-     *  are shown 1:1 both at rest and on a turning leaf. */
-    onLayout?: (size: FolioPageSize) => void;
-}
-/** One page slot of the spread: its CSS size, and the device pixels it
- *  covers (the size a page bitmap is shown 1:1 at). */
-export interface FolioPageSize {
-    width: number;
-    height: number;
-    deviceWidth: number;
-    deviceHeight: number;
-}
-export interface FolioState {
-    spread: number;
-    /** The page indexes on show (one or two). */
-    pages: number[];
-}
-export interface FolioViewer {
-    /** The viewer's root element. */
-    readonly element: HTMLElement;
-    /** Turns to the spread that shows page `index`; `instant` opens it
-     *  there without turning the leaves (a link, a restored position). */
-    goToPage(index: number, options?: {
-        instant?: boolean;
-    }): void;
-    /** Turns to spread `index` (`instant`: opens it there). */
-    goToSpread(index: number, options?: {
-        instant?: boolean;
-    }): void;
-    next(): void;
-    prev(): void;
-    /** Replaces the pages (a relayout, or more pages painted), staying on
-     *  the page on show unless `at` says otherwise. */
-    setPages(pages: FolioPage[], options?: Pick<FolioOptions, "firstPageRecto" | "binding" | "at" | "paper" | "mode">): void;
-    /** The page slot's size, as last laid out. */
-    readonly pageSize: FolioPageSize;
-    /** Swaps the labels (a host that changes language). */
-    setLabels(labels: Partial<FolioLabels>): void;
-    /** Changes how the 3D book is presented. */
-    setAppearance(appearance: FolioAppearance): void;
-    /** Eases the view back to the one the settings give (after the reader
-     *  orbited it with a right-drag). */
-    resetView(): void;
-    /** The view as it is seen now, in degrees: `tilt` from straight above,
-     *  `yaw` round the book (−180 … 180), ready to store as `folio.tilt` and
-     *  `folio.yaw`; null without the 3D book. */
-    getView(): {
-        tilt: number;
-        yaw: number;
-    } | null;
-    /** Changes what the left button does. */
-    setInteraction(mode: FolioInteraction): void;
-    /** How many times the magnifying glass magnifies at its centre; null
-     *  goes back to the default (see {@link FolioMagnifier.zoom}). */
-    setMagnification(zoom: number | null): void;
-    /** The magnifying glass as it is: how many times it magnifies at its
-     *  centre, and whether it is held over the book now. */
-    getMagnifier(): {
-        zoom: number;
-        held: boolean;
-    };
-    /** Holds the glass over the middle of the open spread, as the + and −
-     *  keys do (in the magnify interaction, on the 3D book), or puts it
-     *  away, as Escape does. */
-    holdMagnifier(held: boolean): void;
-    /** A page's canvas was drawn again in place: shows it again. */
-    refreshPage(src: PageSource): void;
-    /** Plays a video on a page (#477): drawn over the page's painting, on
-     *  the leaf that carries it as it lies or turns; `null` takes it off.
-     *  The same as `setPageVideos` with one video or none. */
-    setPageVideo(video: FolioPageVideo | null): void;
-    /** Plays these videos on their pages together (#507), in place of the
-     *  ones shown before; an empty list takes them all off. The WebGL book
-     *  draws up to eight at once (any more show their posters); the DOM
-     *  spread lays each element over its page. */
-    setPageVideos(videos: readonly FolioPageVideo[]): void;
-    /** The page under a pointer and where on it, as the book is seen (the
-     *  tilted, orbited 3D book included); null off the open pages. In
-     *  magnify mode, the point under the glass's centre (#543), which a
-     *  finger holds above itself. */
-    pageAt(event: {
-        clientX: number;
-        clientY: number;
-    }): FolioPagePoint | null;
-    /** Where a point of a page lies on screen (client px), when the page
-     *  lies open; null otherwise. */
-    pointOnScreen(point: FolioPagePoint): {
-        x: number;
-        y: number;
-    } | null;
-    readonly state: FolioState;
-    dispose(): void;
-}
-/** Below this width (px) `mode: 'auto'` shows one page at a time. */
-export declare const SINGLE_BELOW = 560;
+import type { FolioOptions, FolioViewer } from './viewer/types.js';
+export type { FolioPage, FolioAppearance, FolioInteraction, FolioMagnifier, FolioPageDetail, FolioPagePoint, FolioPageVideo, FolioLabels, FolioOptions, FolioPageSize, FolioState, FolioViewer } from './viewer/types.js';
+export { SINGLE_BELOW } from './viewer/constants.js';
 /**
  * A book on the page: the pages in spreads by the recto rule, turned with
  * the ‹ › buttons, ←/→, a swipe, a click on a page, or taken by hand and

package/dist/viewer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"viewer.d.ts","sourceRoot":"","sources":["../src/viewer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,KAAK,WAAW,EAAE,KAAK,gBAAgB,EAAE,MAAM,SAAS,CAAC;AACtF,OAAO,EAA6C,KAAK,UAAU,EAAE,KAAK,cAAc,EAAkB,MAAM,eAAe,CAAC;AAIhI;;yCAEyC;AACzC,MAAM,MAAM,SAAS,GAAG,UAAU,GAAG;IAAE,GAAG,EAAE,UAAU,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,gBAAgB,CAAA;CAAE,CAAC;AAEjG,oCAAoC;AACpC,MAAM,WAAW,eAAe;IAC9B,uEAAuE;IACvE,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB;qDACiD;IACjD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;wDAMoD;IACpD,UAAU,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/C;4CACwC;IACxC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;oCAEgC;IAChC,MAAM,CAAC,EAAE;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,CAAC;IAC3C;;2CAEuC;IACvC,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;;;;;;;6DAQ6D;AAC7D,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEvE,uDAAuD;AACvD,MAAM,WAAW,cAAc;IAC7B;;mDAE+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;sDACkD;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;0BAE0B;AAC1B,MAAM,WAAW,eAAe;IAC9B;sEACkE;IAClE,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC5E;kBACc;IACd,OAAO,CAAC,IAAI,IAAI,CAAC;CAClB;AAED;kEACkE;AAClE,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED;iEACiE;AACjE,MAAM,WAAW,cAAe,SAAQ,cAAc;IACpD,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,gBAAgB,CAAC;CAC3B;AAED,MAAM,WAAW,WAAW;IAC1B,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb;wCACoC;IACpC,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;CACnD;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB;0CACsC;IACtC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;2EACuE;IACvE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAC3B,gDAAgD;IAChD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;0EACsE;IACtE,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACpC;wEACoE;IACpE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iEAAiE;IACjE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;4CACwC;IACxC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;6EACyE;IACzE,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAC9B,kEAAkE;IAClE,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B;kBACc;IACd,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAC/B,yDAAyD;IACzD,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B;oCACgC;IAChC,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;IACvC;sEACkE;IAClE,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC;IACvC;;;6DAGyD;IACzD,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,OAAO,CAAC;IACjD;0CACsC;IACtC,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,OAAO,CAAC;IAClD;;4DAEwD;IACxD,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,IAAI,CAAC;CAC1C;AAED;uDACuD;AACvD,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,6CAA6C;IAC7C,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,WAAW;IAC1B,iCAAiC;IACjC,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC;IAC9B;0EACsE;IACtE,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAC/D,2DAA2D;IAC3D,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IACjE,IAAI,IAAI,IAAI,CAAC;IACb,IAAI,IAAI,IAAI,CAAC;IACb;uDACmD;IACnD,QAAQ,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,gBAAgB,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC;IACzH,8CAA8C;IAC9C,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC,uDAAuD;IACvD,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAC9C,4CAA4C;IAC5C,aAAa,CAAC,UAAU,EAAE,eAAe,GAAG,IAAI,CAAC;IACjD;yCACqC;IACrC,SAAS,IAAI,IAAI,CAAC;IAClB;;iDAE6C;IAC7C,OAAO,IAAI;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAChD,yCAAyC;IACzC,cAAc,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC7C;sEACkE;IAClE,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC;IAC5C;4DACwD;IACxD,YAAY,IAAI;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,CAAC;IAChD;;gCAE4B;IAC5B,aAAa,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;IACnC,gEAAgE;IAChE,WAAW,CAAC,GAAG,EAAE,UAAU,GAAG,IAAI,CAAC;IACnC;;8DAE0D;IAC1D,YAAY,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI,GAAG,IAAI,CAAC;IACjD;;;kDAG8C;IAC9C,aAAa,CAAC,MAAM,EAAE,SAAS,cAAc,EAAE,GAAG,IAAI,CAAC;IACvD;;;qCAGiC;IACjC,MAAM,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,cAAc,GAAG,IAAI,CAAC;IAC3E;qCACiC;IACjC,aAAa,CAAC,KAAK,EAAE,cAAc,GAAG;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IACtE,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,OAAO,IAAI,IAAI,CAAC;CACjB;AAeD,qEAAqE;AACrE,eAAO,MAAM,YAAY,MAAM,CAAC;AAyChC;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,GAAG,WAAW,CAo+BtF"}
+{"version":3,"file":"viewer.d.ts","sourceRoot":"","sources":["../src/viewer.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAQnE,YAAY,EAAE,SAAS,EAAE,eAAe,EAAE,gBAAgB,EAAE,cAAc,EAAE,eAAe,EAAE,cAAc,EAAE,cAAc,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAC1N,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,GAAG,WAAW,CAuOtF"}