@readium/shared 1.2.0

package/src/util/tokenizer/tokenize-text/tokens.js

@@ -0,0 +1,100 @@
+/*
+Token is an object like:
+
+{
+    "value": "text content",
+
+    // Position of the index
+    "index": 0,
+
+    // Length of the token
+    "offset": "text content".length
+}
+*/
+
+// Return a string ID to represent a list of tokens
+function tokensId(tokens, prepend) {
+    if (!prepend) return null;
+
+    return tokens.reduce(function(prev, token) {
+        var tokId = [
+            token.index,
+            token.offset,
+            token.value
+        ].join('-');
+
+        return [prev, tokId].join(':');
+    }, prepend);
+}
+
+// Return properties for a token
+function tokenProperties(tok) {
+    const { index, offset, value, ...rest } = tok;
+    return rest;
+}
+
+// Normalize and resolve a list of tokens relative to a token
+function normalizeTokens(relative, tokens) {
+    var _index = 0;
+
+    // Force as an array
+    if (!Array.isArray(tokens)) tokens = [tokens];
+
+    return tokens.map(function(subtoken) {
+        if (subtoken === null) return null;
+        if (typeof subtoken === 'string') {
+            subtoken = {
+                value: subtoken,
+                index: _index,
+                offset: subtoken.length
+            };
+        }
+
+        if (typeof subtoken === 'object') {
+            subtoken.index = subtoken.index || 0;
+            _index = _index + subtoken.index + subtoken.offset;
+
+            // Transform as an absolute token
+            subtoken.index = relative.index + subtoken.index;
+            subtoken.offset = subtoken.offset || subtoken.value.length;
+        }
+
+        return subtoken;
+    });
+}
+
+// Merge tokens
+function mergeTokens(tokens, mergeWith) {
+    if (tokens.length == 0) return null;
+
+    var value = '';
+    var offset = 0;
+
+    var firstIndex = tokens[0]?.index;
+
+    tokens.forEach(function(token, i) {
+        var prev = tokens[i - 1];
+        var next = tokens[i + 1];
+
+        var toFill = prev ? (token.index + 1 - (prev.index + prev.offset)): 0;
+        value = value + new Array(toFill).join(mergeWith) + token.value;
+
+        var absoluteOffset = (token.index - firstIndex) + token.offset;
+        if (absoluteOffset > offset) offset = absoluteOffset;
+    });
+
+    return {
+        // Index equal is the one from the first token
+        index: firstIndex,
+
+        value: value,
+        offset: Math.max(offset, value.length)
+    }
+}
+
+export default {
+    tokensId: tokensId,
+    normalize: normalizeTokens,
+    properties: tokenProperties,
+    merge: mergeTokens
+};

package/types/src/fetcher/Fetcher.d.ts

@@ -0,0 +1,27 @@
+import { Link } from '../publication/Link';
+import { Resource } from './Resource';
+/** Provides access to a [Resource] from a [Link]. */
+export interface Fetcher {
+    /**
+     * Known resources available in the medium, such as file paths on the file system
+     * or entries in a ZIP archive. This list is not exhaustive, and additional
+     * unknown resources might be reachable.
+     *
+     * If the medium has an inherent resource order, it should be followed.
+     * Otherwise, HREFs are sorted alphabetically.
+     */
+    links(): Link[];
+    /**
+     * Returns the [Resource] at the given [link]'s HREF.
+     *
+     * A [Resource] is always returned, since for some cases we can't know if it exists before
+     * actually fetching it, such as HTTP. Therefore, errors are handled at the Resource level.
+     */
+    get(link: Link): Resource;
+    close(): void;
+}
+export declare class EmptyFetcher implements Fetcher {
+    close(): void;
+    links(): Link[];
+    get(_link: Link): Resource;
+}

package/types/src/fetcher/HttpFetcher.d.ts

@@ -0,0 +1,28 @@
+import { Link } from '../publication/Link';
+import { Fetcher } from './Fetcher';
+import { NumberRange, Resource } from './Resource';
+export type FetchImplementation = (input: RequestInfo | URL, init?: RequestInit | undefined) => Promise<Response>;
+export declare class HttpFetcher implements Fetcher {
+    private readonly baseUrl?;
+    private readonly client;
+    constructor(client?: FetchImplementation, baseUrl?: string);
+    links(): Link[];
+    get(link: Link): Resource;
+    close(): void;
+}
+export declare class HttpResource implements Resource {
+    private readonly _link;
+    private readonly url;
+    private readonly client;
+    private _headResponse?;
+    constructor(client: FetchImplementation, link: Link, url: string);
+    /** Cached HEAD response to get the expected content length and other metadata. */
+    private headResponse;
+    close(): void;
+    link(): Promise<Link>;
+    read(range?: NumberRange): Promise<Uint8Array | undefined>;
+    length(): Promise<number>;
+    readAsJSON(): Promise<unknown>;
+    readAsString(): Promise<string>;
+    readAsXML(): Promise<XMLDocument>;
+}

package/types/src/fetcher/Resource.d.ts

@@ -0,0 +1,15 @@
+import { Link } from '../publication/Link';
+export declare class NumberRange {
+    readonly start: number;
+    readonly endInclusive: number;
+    constructor(start: number, endInclusive: number);
+}
+export declare abstract class Resource {
+    abstract link(): Promise<Link>;
+    abstract length(): Promise<number | undefined>;
+    abstract read(range?: NumberRange): Promise<Uint8Array | undefined>;
+    readAsString(): Promise<string | undefined>;
+    readAsJSON(): Promise<unknown | undefined>;
+    readAsXML(): Promise<XMLDocument | undefined>;
+    abstract close(): void;
+}

package/types/src/fetcher/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Fetcher';
+export * from "./HttpFetcher";

package/types/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from './fetcher';
+export * from './publication';
+export * from './opds';
+export * from './util';

package/types/src/opds/Acquisition.d.ts

@@ -0,0 +1,26 @@
+/**
+ * OPDS Acquisition Object.
+ *
+ * https://drafts.opds.io/schema/acquisition-object.schema.json
+ */
+export declare class Acquisition {
+    /** Currency for the price, eg. EUR. */
+    type: string;
+    /** Price value, should only be used for display purposes, because of precision issues
+     *    inherent with Double and the JSON parsing. */
+    children?: Array<Acquisition>;
+    /** Creates a [Acquisition]. */
+    constructor(values: {
+        type: string;
+        children?: Array<Acquisition>;
+    });
+    /**
+     * Parses a [Acquisition] from its RWPM JSON representation.
+     */
+    static deserialize(json: any): Acquisition | undefined;
+    static deserializeArray(json: any): Array<Acquisition> | undefined;
+    /**
+     * Serializes a [Acquisition] to its RWPM JSON representation.
+     */
+    serialize(): any;
+}

package/types/src/opds/Availability.d.ts

@@ -0,0 +1,32 @@
+export declare enum AvailabilityStatus {
+    available = "available",
+    reserved = "reserved",
+    ready = "ready"
+}
+/**
+ * Indicated the availability of a given resource.
+ *
+ * https://drafts.opds.io/schema/properties.schema.json
+ *
+ */
+export declare class Availability {
+    /**Timestamp for the previous state change. */
+    since?: Date;
+    /**Timestamp for the next state change. */
+    until?: Date;
+    state: AvailabilityStatus;
+    /** Creates a [Availability]. */
+    constructor(values: {
+        state: AvailabilityStatus;
+        since?: Date;
+        until?: Date;
+    });
+    /**
+     * Parses a [Availability] from its RWPM JSON representation.
+     */
+    static deserialize(json: any): Availability | undefined;
+    /**
+     * Serializes a [Availability] to its RWPM JSON representation.
+     */
+    serialize(): any;
+}

package/types/src/opds/Copies.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Library-specific feature that contains information about the copies that a library has acquired.
+ *
+ * https://drafts.opds.io/schema/properties.schema.json
+ */
+export declare class Copies {
+    total?: number;
+    available?: number;
+    /** Creates a [Copies]. */
+    constructor(values: {
+        total?: number;
+        available?: number;
+    });
+    /**
+     * Parses a [Copies] from its RWPM JSON representation.
+     */
+    static deserialize(json: any): Copies | undefined;
+    /**
+     * Serializes a [Copies] to its RWPM JSON representation.
+     */
+    serialize(): any;
+}

package/types/src/opds/Holds.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Library-specific features when a specific book is unavailable but provides a hold list.
+ *
+ * https://drafts.opds.io/schema/properties.schema.json
+ */
+export declare class Holds {
+    total?: number;
+    position?: number;
+    /** Creates a [Price]. */
+    constructor(values: {
+        total?: number;
+        position?: number;
+    });
+    /**
+     * Parses a [Holds] from its RWPM JSON representation.
+     */
+    static deserialize(json: any): Holds | undefined;
+    /**
+     * Serializes a [Holds] to its RWPM JSON representation.
+     */
+    serialize(): any;
+}

package/types/src/opds/Price.d.ts

@@ -0,0 +1,29 @@
+/**
+ * The price of a publication in an OPDS link.
+ *
+ * https://drafts.opds.io/schema/properties.schema.json
+ *
+ * currency Currency for the price, eg. EUR.
+ * value Price value, should only be used for display purposes, because of precision issues
+ *     inherent with Double and the JSON parsing.
+ */
+export declare class Price {
+    /** Currency for the price, eg. EUR. */
+    currency: string;
+    /** Price value, should only be used for display purposes, because of precision issues
+     *    inherent with Double and the JSON parsing. */
+    value: number;
+    /** Creates a [Price]. */
+    constructor(values: {
+        currency: string;
+        value: number;
+    });
+    /**
+     * Parses a [Price] from its RWPM JSON representation.
+     */
+    static deserialize(json: any): Price | undefined;
+    /**
+     * Serializes a [Price] to its RWPM JSON representation.
+     */
+    serialize(): any;
+}

package/types/src/opds/index.d.ts

@@ -0,0 +1,5 @@
+export * from './Price';
+export * from './Acquisition';
+export * from './Holds';
+export * from './Copies';
+export * from './Availability';

package/types/src/publication/BelongsTo.d.ts

@@ -0,0 +1,23 @@
+import { Contributors as Collection } from './Contributor';
+/**
+ * BelongsTo Object for the Readium Web Publication Manifest.
+ * https://readium.org/webpub-manifest/schema/contributor-object.schema.json
+ */
+export declare class BelongsTo {
+    /**
+     * Map of [BelongsTo] items.
+     */
+    readonly items: Map<string, Collection>;
+    /** Creates an Array of [Subject]. */
+    constructor(values?: {
+        items?: Map<string, Collection>;
+    });
+    /**
+     * Parses a [BelongsTo] from its RWPM JSON representation.
+     */
+    static deserialize(json: any): BelongsTo | undefined;
+    /**
+     * Serializes a [BelongsTo] to its RWPM JSON representation.
+     */
+    serialize(): any;
+}

package/types/src/publication/Contributor.d.ts

@@ -0,0 +1,60 @@
+import { Links } from './Link';
+import { LocalizedString } from './LocalizedString';
+/**
+ * Contributor Object for the Readium Web Publication Manifest.
+ * https://readium.org/webpub-manifest/schema/contributor-object.schema.json
+ */
+export declare class Contributor {
+    /** The name of the contributor. */
+    readonly name: LocalizedString;
+    /** The string used to sort the name of the contributor. */
+    readonly sortAs?: string;
+    /** An unambiguous reference to this contributor. */
+    readonly identifier?: string;
+    /** The role of the contributor in the publication making. */
+    readonly roles?: Set<string>;
+    /** Used to retrieve similar publications for the given contributor. */
+    readonly links?: Links;
+    /** The position of the publication in this collection/series, when the contributor represents a collection. */
+    readonly position?: number;
+    /**
+     * Creates a [Contributor] object.
+     */
+    constructor(values: {
+        name: LocalizedString;
+        sortAs?: string;
+        identifier?: string;
+        roles?: Set<string>;
+        links?: Links;
+        position?: number;
+    });
+    /**
+     * Parses a [Contributor] from its RWPM JSON representation.
+     *
+     * A contributor can be parsed from a single string, or a full-fledged object.
+     */
+    static deserialize(json: any): Contributor | undefined;
+    /**
+     * Serializes a [Contributor] to its RWPM JSON representation.
+     */
+    serialize(): any;
+}
+export declare class Contributors {
+    /**
+     * Array of [Contributor] .
+     */
+    readonly items: Array<Contributor>;
+    /**
+     * Creates a [Contributors] object.
+     */
+    constructor(items: Array<Contributor>);
+    /**
+     * Parses a [Contributors] from its RWPM JSON representation.
+     *
+     */
+    static deserialize(json: any): Contributors | undefined;
+    /**
+     * Serializes a [Contributors] to its RWPM JSON representation.
+     */
+    serialize(): any;
+}

package/types/src/publication/GuidedNavigation.d.ts

@@ -0,0 +1,70 @@
+import { Links } from "./Link";
+export interface Clip {
+    audioResource: string;
+    fragmentId?: string;
+    start?: number;
+    end?: number;
+}
+/**
+ * Guided Navigation Document
+ * https://readium.org/guided-navigation/schema/document.schema.json
+ */
+export declare class GuidedNavigationDocument {
+    readonly links?: Links;
+    readonly guided?: GuidedNavigationObject[];
+    constructor(values: {
+        links?: Links;
+        guided?: GuidedNavigationObject[];
+    });
+    static deserialize(json: any): GuidedNavigationDocument | undefined;
+    serialize(): any;
+}
+/**
+ * Guided Navigation Object
+ * https://github.com/readium/guided-navigation/blob/main/schema/object.schema.json
+ */
+export declare class GuidedNavigationObject {
+    /** References an audio resource or a fragment of it. */
+    readonly audioref?: string;
+    /** Items that are children of the containing Guided Navigation Object. */
+    readonly children?: GuidedNavigationObject[];
+    /** References an image or a fragment of it. */
+    readonly imgref?: string;
+    /** Convey the structural semantics of a publication. */
+    readonly role?: Set<string>;
+    /** Textual equivalent of the resources or fragment of the resources referenced by the current Guided Navigation Object. */
+    readonly text?: string;
+    /** References a textual resource or a fragment of it. */
+    readonly textref?: string;
+    /**
+     * Creates a [GuidedNavigation] object.
+    */
+    constructor(values: {
+        audioref?: string;
+        children?: GuidedNavigationObject[];
+        imgref?: string;
+        role?: Set<string>;
+        text?: string;
+        textref?: string;
+    });
+    /**
+     * Parses a [GuidedNavigationObject] from its RWPM JSON representation.
+     *
+     * A GuidedNavigationObject can be parsed from a single string, or a full-fledged object.
+    */
+    static deserialize(json: any): GuidedNavigationObject | undefined;
+    /**
+     * Parses a [GuidedNavigationObject] array from its RWPM JSON representation.
+    */
+    static deserializeArray(json: any): GuidedNavigationObject[] | undefined;
+    /**
+     * Serializes a [GuidedNavigationObject] to its RWPM JSON representation.
+    */
+    serialize(): any;
+    get audioFile(): string | undefined;
+    get audioTime(): string | undefined;
+    get textFile(): string | undefined;
+    get fragmentId(): string | undefined;
+    get clip(): Clip | undefined;
+    private parseTimer;
+}

package/types/src/publication/Link.d.ts

@@ -0,0 +1,128 @@
+import { MediaType } from '../util/mediatype/MediaType';
+import { Properties } from './Properties';
+import { Locator } from './Locator';
+/**
+ * Link Object for the Readium Web Publication Manifest.
+ * https://readium.org/webpub-manifest/schema/link.schema.json
+ */
+export declare class Link {
+    /** URI or URI template of the linked resource. */
+    readonly href: string;
+    /** Indicates that a URI template is used in href. */
+    readonly templated?: boolean;
+    /** MIME type of the linked resource. */
+    readonly type?: string;
+    /** Title of the linked resource. */
+    readonly title?: string;
+    /** Relation between the linked resource and its containing collection. */
+    readonly rels?: Set<string>;
+    /** Properties associated to the linked resource. */
+    properties?: Properties;
+    /** Height of the linked resource in pixels. */
+    readonly height?: number;
+    /** Width of the linked resource in pixels. */
+    readonly width?: number;
+    /** Length of the linked resource in seconds. */
+    readonly duration?: number;
+    /** Bitrate of the linked resource in kbps. */
+    readonly bitrate?: number;
+    /** Expected language of the linked resource. */
+    readonly languages?: Array<string>;
+    /** Alternate resources for the linked resource. */
+    readonly alternates?: Links;
+    /** Resources that are children of the linked resource, in the context of a given collection role. */
+    readonly children?: Links;
+    /**
+     * Creates a [Link].
+     */
+    constructor(values: {
+        href: string;
+        templated?: boolean;
+        type?: string;
+        title?: string;
+        rels?: Set<string>;
+        properties?: Properties;
+        height?: number;
+        width?: number;
+        duration?: number;
+        bitrate?: number;
+        languages?: Array<string>;
+        alternates?: Links;
+        children?: Links;
+    });
+    /**
+     * Parses a [Link] from its RWPM JSON representation.
+     */
+    static deserialize(json: any): Link | undefined;
+    /**
+     * Serializes a [Link] to its RWPM JSON representation.
+     */
+    serialize(): any;
+    /** MediaType of the linked resource. */
+    get mediaType(): MediaType;
+    /** Computes an absolute URL to the link, relative to the given `baseURL`.
+     *  If the link's `href` is already absolute, the `baseURL` is ignored.
+     */
+    toURL(baseUrl?: string): string | undefined;
+    /** List of URI template parameter keys, if the `Link` is templated. */
+    get templateParameters(): Set<string>;
+    /** Expands the `Link`'s HREF by replacing URI template variables by the given parameters.
+     *  See RFC 6570 on URI template: https://tools.ietf.org/html/rfc6570
+     */
+    expandTemplate(parameters: {
+        [param: string]: string;
+    }): Link;
+    /**
+     * Makes a copy of this [Link] after merging in the given additional other [properties].
+     */
+    addProperties(properties: {
+        [key: string]: any;
+    }): Link;
+    /**
+     * Creates a [Locator] from a reading order [Link].
+     */
+    get locator(): Locator;
+}
+/**
+ * Parses multiple JSON links into an array of Link.
+ */
+export declare class Links {
+    items: Array<Link>;
+    /**
+     * Creates a [Links].
+     */
+    constructor(items: Array<Link>);
+    /**
+     * Creates a list of [Link] from its RWPM JSON representation.
+     */
+    static deserialize(json: any): Links | undefined;
+    /**
+     * Serializes an array of [Link] to its RWPM JSON representation.
+     */
+    serialize(): any;
+    /** Finds the first link with the given relation. */
+    findWithRel(rel: string): Link | undefined;
+    /** Finds all the links with the given relation. */
+    filterByRel(rel: string): Array<Link>;
+    /** Finds the first link matching the given HREF. */
+    findWithHref(href: string): Link | undefined;
+    /** Finds the index of the first link matching the given HREF. */
+    findIndexWithHref(href: string): number;
+    /** Finds the first link matching the given media type. */
+    findWithMediaType(mediaType: string): Link | undefined;
+    /** Finds all the links matching the given media type. */
+    filterByMediaType(mediaType: string): Array<Link>;
+    /** Finds all the links matching any of the given media types. */
+    filterByMediaTypes(mediaTypes: Array<string>): Array<Link>;
+    /** Returns whether all the resources in the collection are audio clips. */
+    everyIsAudio(): boolean;
+    /** Returns whether all the resources in the collection are bitmaps. */
+    everyIsBitmap(): boolean;
+    /** Returns whether all the resources in the collection are HTML documents. */
+    everyIsHTML(): boolean;
+    /** Returns whether all the resources in the collection are video clips. */
+    everyIsVideo(): boolean;
+    /** Returns whether all the resources in the collection are matching any of the given media types. */
+    everyMatchesMediaType(mediaTypes: string | Array<string>): boolean;
+    filterLinksHasType(): Array<Link>;
+}

package/types/src/publication/LocalizedString.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Represents a string with multiple translations indexed by a BCP 47 language tag.
+ */
+export declare class LocalizedString {
+    readonly translations: {
+        [key: string]: string;
+    };
+    static readonly UNDEFINED_LANGUAGE = "undefined";
+    static readonly LANGUAGE_EN = "en";
+    /**
+     * translations can be a string or a collection of language/translation pairs,
+     * for a single string the language is assumed to be undefined
+     */
+    constructor(translations: string | {
+        [key: string]: string;
+    });
+    /**
+     * Parses a [LocalizedString] from its RWPM JSON representation.
+     *
+     * "anyOf": [
+     *   {
+     *     "type": "string"
+     *   },
+     *   {
+     *     "description": "The language in a language map must be a valid BCP 47 tag.",
+     *     "type": "object",
+     *     "patternProperties": {
+     *       "^((?<grandfathered>(en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang))|((?<language>([A-Za-z]{2,3}(-(?<extlang>[A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-(?<script>[A-Za-z]{4}))?(-(?<region>[A-Za-z]{2}|[0-9]{3}))?(-(?<variant>[A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-(?<extension>[0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(?<privateUse>x(-[A-Za-z0-9]{1,8})+))?)|(?<privateUse2>x(-[A-Za-z0-9]{1,8})+))$": {
+     *         "type": "string"
+     *       }
+     *     },
+     *     "additionalProperties": false,
+     *     "minProperties": 1
+     *   }
+     * ]
+     */
+    static deserialize(json: any): undefined | LocalizedString;
+    serialize(): any;
+    /**
+     * Returns the first translation for the given [language] BCP–47 tag.
+     * If not found, then fallback:
+     *    1. on the undefined language
+     *    2. on the English language
+     *    3. the first translation found
+     *    4. returns empty string
+     */
+    getTranslation(language?: string): string;
+}