@likecoin/epub-ts 0.3.93

package/dist/themes.d.ts

@@ -0,0 +1,103 @@
+import { default as Rendition } from './rendition';
+import { default as Contents } from './contents';
+import { ThemeEntry } from './types';
+/**
+ * Themes to apply to displayed content
+ * @class
+ * @param {Rendition} rendition
+ */
+declare class Themes {
+    rendition: Rendition;
+    _themes: Record<string, ThemeEntry>;
+    _overrides: Record<string, {
+        value: string;
+        priority: boolean;
+    }>;
+    _current: string;
+    _injected: string[];
+    constructor(rendition: Rendition);
+    /**
+     * Add themes to be used by a rendition
+     * @param {object | Array<object> | string}
+     * @example themes.register("light", "http://example.com/light.css")
+     * @example themes.register("light", { "body": { "color": "purple"}})
+     * @example themes.register({ "light" : {...}, "dark" : {...}})
+     */
+    register(..._args: any[]): void;
+    /**
+     * Add a default theme to be used by a rendition
+     * @param {object | string} theme
+     * @example themes.register("http://example.com/default.css")
+     * @example themes.register({ "body": { "color": "purple"}})
+     */
+    default(theme: string | Record<string, Record<string, string>>): void;
+    /**
+     * Register themes object
+     * @param {object} themes
+     */
+    registerThemes(themes: Record<string, string | Record<string, Record<string, string>>>): void;
+    /**
+     * Register a theme by passing its css as string
+     * @param {string} name
+     * @param {string} css
+     */
+    registerCss(name: string, css: string): void;
+    /**
+     * Register a url
+     * @param {string} name
+     * @param {string} input
+     */
+    registerUrl(name: string, input: string): void;
+    /**
+     * Register rule
+     * @param {string} name
+     * @param {object} rules
+     */
+    registerRules(name: string, rules: Record<string, Record<string, string>>): void;
+    /**
+     * Select a theme
+     * @param {string} name
+     */
+    select(name: string): void;
+    /**
+     * Update a theme
+     * @param {string} name
+     */
+    update(name: string): void;
+    /**
+     * Inject all themes into contents
+     * @param {Contents} contents
+     */
+    inject(contents: Contents): void;
+    /**
+     * Add Theme to contents
+     * @param {string} name
+     * @param {Contents} contents
+     */
+    add(name: string, contents: Contents): void;
+    /**
+     * Add override
+     * @param {string} name
+     * @param {string} value
+     * @param {boolean} priority
+     */
+    override(name: string, value: string, priority?: boolean): void;
+    removeOverride(name: string): void;
+    /**
+     * Add all overrides
+     * @param {Content} content
+     */
+    overrides(contents: Contents): void;
+    /**
+     * Adjust the font size of a rendition
+     * @param {number} size
+     */
+    fontSize(size: string): void;
+    /**
+     * Adjust the font-family of a rendition
+     * @param {string} f
+     */
+    font(f: string): void;
+    destroy(): void;
+}
+export default Themes;

package/dist/types.d.ts

@@ -0,0 +1,269 @@
+/**
+ * Shared type definitions for epub.ts
+ * Adapted from legacy types/ directory (epubjs v0.3.93)
+ */
+export interface Deferred<T = any> {
+    id: string;
+    resolve: (value?: T | PromiseLike<T>) => void;
+    reject: (reason?: any) => void;
+    promise: Promise<T>;
+}
+export interface IEventEmitter {
+    on(type: string, fn: (...args: any[]) => void): any;
+    off(type: string, fn?: (...args: any[]) => void): any;
+    emit(type: string, ...args: any[]): void;
+    __listeners?: Record<string, Array<(...args: any[]) => void>>;
+}
+export interface PackagingMetadataObject {
+    title: string;
+    creator: string;
+    description: string;
+    pubdate: string;
+    publisher: string;
+    identifier: string;
+    language: string;
+    rights: string;
+    modified_date: string;
+    layout: string;
+    orientation: string;
+    flow: string;
+    viewport: string;
+    media_active_class: string;
+    spread: string;
+    direction: string;
+}
+export interface PackagingSpineItem {
+    id?: string;
+    idref: string;
+    linear: string;
+    properties: string[];
+    index: number;
+}
+export interface PackagingManifestItem {
+    href: string;
+    type: string;
+    overlay: string;
+    properties: string[];
+}
+export interface PackagingManifestObject {
+    [key: string]: PackagingManifestItem;
+}
+export interface PackagingObject {
+    metadata: PackagingMetadataObject;
+    spine: PackagingSpineItem[];
+    manifest: PackagingManifestObject;
+    navPath: string;
+    ncxPath: string;
+    coverPath: string;
+    spineNodeIndex: number;
+}
+export interface NavItem {
+    id: string;
+    href: string;
+    label: string;
+    subitems?: NavItem[];
+    parent?: string;
+}
+export interface LandmarkItem {
+    href?: string;
+    label?: string;
+    type?: string;
+}
+export interface SpineItem {
+    index: number;
+    cfiBase: string;
+    idref: string;
+    href: string;
+    url: string;
+    canonical: string;
+    properties: string[];
+    linear: string;
+    id?: string;
+    next: () => SpineItem | undefined;
+    prev: () => SpineItem | undefined;
+}
+export interface PageListItem {
+    href: string;
+    page: number;
+    cfi?: string;
+    packageUrl?: string;
+}
+export interface BookOptions {
+    requestMethod?: (url: string, type: string, withCredentials?: boolean, headers?: object) => Promise<any>;
+    requestCredentials?: boolean;
+    requestHeaders?: Record<string, string>;
+    encoding?: string;
+    replacements?: string;
+    canonical?: (path: string) => string;
+    openAs?: string;
+    store?: string | boolean;
+}
+export interface RenditionOptions {
+    width?: number | string;
+    height?: number | string;
+    ignoreClass?: string;
+    manager?: string | Function | object;
+    view?: string | Function | object;
+    flow?: string;
+    layout?: string;
+    spread?: string | boolean;
+    minSpreadWidth?: number;
+    stylesheet?: string;
+    resizeOnOrientationChange?: boolean;
+    script?: string;
+    infinite?: boolean;
+    overflow?: string;
+    snap?: boolean | object;
+    defaultDirection?: string;
+    allowScriptedContent?: boolean;
+    allowPopups?: boolean;
+}
+export interface DisplayedLocation {
+    index: number;
+    href: string;
+    cfi: string;
+    location?: number;
+    percentage?: number;
+    page?: number;
+    displayed: {
+        page: number;
+        total: number;
+    };
+}
+export interface Location {
+    start: DisplayedLocation;
+    end: DisplayedLocation;
+    atStart?: boolean;
+    atEnd?: boolean;
+}
+export interface LayoutSettings {
+    layout?: string;
+    spread?: string;
+    minSpreadWidth?: number;
+    evenSpreads?: boolean;
+    flow?: string;
+    direction?: string;
+}
+export interface LayoutProps {
+    name: string;
+    spread: boolean;
+    flow: string;
+    width: number;
+    height: number;
+    spreadWidth: number;
+    pageWidth?: number;
+    delta: number;
+    columnWidth: number;
+    gap: number;
+    divisor: number;
+}
+export interface ViewportSettings {
+    width: string;
+    height: string;
+    scale: string;
+    scalable: string;
+    minimum: string;
+    maximum: string;
+}
+export interface EpubCFIPair {
+    start: string;
+    end: string;
+}
+export interface RangePair {
+    start: Range;
+    end: Range;
+}
+export interface EpubCFIStep {
+    id: string | null;
+    tagName: string;
+    type: string;
+    index: number;
+}
+export interface EpubCFIComponent {
+    steps: EpubCFIStep[];
+    terminal: {
+        offset: number | null;
+        assertion: string | null;
+    };
+}
+export type RequestFunction = (url: string, type?: string, withCredentials?: boolean, headers?: Record<string, string>) => Promise<any>;
+export interface SizeObject {
+    width: number;
+    height: number;
+}
+export interface ReframeBounds extends SizeObject {
+    widthDelta: number;
+    heightDelta: number;
+}
+export interface ThemeEntry {
+    rules?: Record<string, Record<string, string>>;
+    url?: string;
+    serialized?: string;
+    injected?: boolean;
+}
+export interface ViewSettings {
+    ignoreClass?: string;
+    axis?: string;
+    direction?: string;
+    flow?: string;
+    layout?: LayoutProps;
+    method?: string;
+    width?: number;
+    height?: number;
+    forceEvenPages?: boolean;
+    forceRight?: boolean;
+    allowScriptedContent?: boolean;
+    allowPopups?: boolean;
+    globalLayoutProperties?: GlobalLayout;
+}
+export interface ViewLocation {
+    index: number;
+    href: string;
+    pages: number[];
+    totalPages: number;
+    mapping: EpubCFIPair;
+}
+export interface ManagerOptions extends ViewSettings {
+    infinite?: boolean;
+    overflow?: string;
+    hidden?: boolean;
+    fullsize?: boolean;
+    snap?: boolean | object;
+    view?: string | Function | object;
+    request?: RequestFunction;
+    [key: string]: any;
+}
+export interface HooksObject {
+    [key: string]: any;
+}
+export interface StageOptions {
+    width?: number | string;
+    height?: number | string;
+    overflow?: string | boolean;
+    hidden?: boolean;
+    axis?: string;
+    fullsize?: boolean;
+    direction?: string;
+    dir?: string;
+    writingMode?: string;
+}
+export interface GlobalLayout {
+    layout: string;
+    spread: string;
+    orientation: string;
+    flow: string;
+    viewport: string;
+    minSpreadWidth: number;
+    direction: string;
+}
+export interface SearchResult {
+    cfi: string;
+    excerpt: string;
+}
+export interface ParsedPath {
+    root: string;
+    dir: string;
+    base: string;
+    ext: string;
+    name: string;
+}

package/dist/utils/constants.d.ts

@@ -0,0 +1,59 @@
+export declare const EPUBJS_VERSION = "0.3";
+export declare const DOM_EVENTS: readonly ["keydown", "keyup", "keypressed", "mouseup", "mousedown", "mousemove", "click", "touchend", "touchstart", "touchmove"];
+export declare const EVENTS: {
+    readonly BOOK: {
+        readonly OPEN_FAILED: "openFailed";
+    };
+    readonly CONTENTS: {
+        readonly EXPAND: "expand";
+        readonly RESIZE: "resize";
+        readonly SELECTED: "selected";
+        readonly SELECTED_RANGE: "selectedRange";
+        readonly LINK_CLICKED: "linkClicked";
+    };
+    readonly LOCATIONS: {
+        readonly CHANGED: "changed";
+    };
+    readonly MANAGERS: {
+        readonly RESIZE: "resize";
+        readonly RESIZED: "resized";
+        readonly ORIENTATION_CHANGE: "orientationchange";
+        readonly ADDED: "added";
+        readonly SCROLL: "scroll";
+        readonly SCROLLED: "scrolled";
+        readonly REMOVED: "removed";
+    };
+    readonly VIEWS: {
+        readonly AXIS: "axis";
+        readonly WRITING_MODE: "writingMode";
+        readonly LOAD_ERROR: "loaderror";
+        readonly RENDERED: "rendered";
+        readonly RESIZED: "resized";
+        readonly DISPLAYED: "displayed";
+        readonly SHOWN: "shown";
+        readonly HIDDEN: "hidden";
+        readonly MARK_CLICKED: "markClicked";
+    };
+    readonly RENDITION: {
+        readonly STARTED: "started";
+        readonly ATTACHED: "attached";
+        readonly DISPLAYED: "displayed";
+        readonly DISPLAY_ERROR: "displayerror";
+        readonly RENDERED: "rendered";
+        readonly REMOVED: "removed";
+        readonly RESIZED: "resized";
+        readonly ORIENTATION_CHANGE: "orientationchange";
+        readonly LOCATION_CHANGED: "locationChanged";
+        readonly RELOCATED: "relocated";
+        readonly MARK_CLICKED: "markClicked";
+        readonly SELECTED: "selected";
+        readonly LAYOUT: "layout";
+    };
+    readonly LAYOUT: {
+        readonly UPDATED: "updated";
+    };
+    readonly ANNOTATION: {
+        readonly ATTACH: "attach";
+        readonly DETACH: "detach";
+    };
+};