@nypl/web-reader 0.1.4 → 0.2.0-alpha.3

package/src/ServiceWorker/sw.ts

@@ -1,84 +0,0 @@
-import { clientsClaim } from 'workbox-core';
-import { ExpirationPlugin } from 'workbox-expiration';
-import { CacheFirst } from 'workbox-strategies';
-import { IS_DEV } from '../constants';
-import { CACHE_EXPIRATION_SECONDS, WEBPUB_CACHE_NAME } from './constants';
-import { WebReaderSWConfig } from './types';
-
-declare let self: ServiceWorkerGlobalScope;
-
-const VERSION = 'v1';
-
-/**
- * We claim the clients immediately and skip waiting because we don't care if
- * half the page resources come from the SW and half from the network. We use
- * content hashes for this to work
- */
-clientsClaim();
-
-/**
- * Sets up the event listeners to:
- *  - On Fetch
- *    - Serve cached responses if they exist and are less than a week old.
- */
-export default function initWebReaderSW({
-  cacheExpirationSeconds = CACHE_EXPIRATION_SECONDS,
-}: WebReaderSWConfig | undefined = {}): void {
-  log('INITIALIZING');
-  self.addEventListener('install', (event) => {
-    log('INSTALLING ');
-    async function installSW() {
-      // perform any install tasks
-      // skip the waiting phase and activate immediately
-      self.skipWaiting();
-      log('INSTALLED');
-    }
-    event.waitUntil(installSW);
-  });
-
-  /**
-   * On a fetch event, respond with an item from the cache, if
-   * it exists. We don't ever add things to the cache here,
-   * because the fetch event is called for _all_ network requests,
-   * and we can't tell if any given request is for app resources or
-   * publication resources. Thus publication resources are added
-   * to the cache separately, and then just returned if found here.
-   *
-   * This event listener MUST be run as the last fetch event listener
-   * of all in the host app because it always responds to the event
-   * in order to be able to use async functionality.
-   */
-  self.addEventListener('fetch', (event) => {
-    if (event.request.method !== 'GET') {
-      return;
-    }
-
-    async function matchOrFetch() {
-      const pubCache = await caches.open(WEBPUB_CACHE_NAME);
-      const match = await pubCache.match(event.request);
-
-      // check if there is a match
-      if (match) {
-        return new CacheFirst({
-          cacheName: WEBPUB_CACHE_NAME,
-          plugins: [
-            new ExpirationPlugin({
-              // Only cache requests for a week
-              maxAgeSeconds: cacheExpirationSeconds,
-            }),
-          ],
-        }).handle(event);
-      }
-      // otherwise go to network
-      return fetch(event.request);
-    }
-
-    // we have to make the event wait if we want to use async work
-    event.respondWith(matchOrFetch());
-  });
-}
-
-// each logging line will be prepended with the service worker version
-function log(message: string) {
-  if (IS_DEV) console.log(`SW (${VERSION}) -`, message);
-}

package/src/ServiceWorker/types.ts

@@ -1,3 +0,0 @@
-export type WebReaderSWConfig = {
-  cacheExpirationSeconds?: number;
-};

package/src/WebpubManifestTypes/ConformsTo.ts

@@ -1,9 +0,0 @@
-// a webpub pdf collection
-export const WebpubPdfConformsTo =
-  'https://librarysimplified.org/terms/profiles/pdf';
-// a webpub of axisnow content
-export const AxisNowEpubConformsTo = 'stub/webpub+axisnow';
-
-export type ConformsTo =
-  | typeof WebpubPdfConformsTo
-  | typeof AxisNowEpubConformsTo;

package/src/WebpubManifestTypes/Contributor.ts

@@ -1,24 +0,0 @@
-import { ReadiumLink } from './ReadiumLink';
-
-export interface ContributorObject {
-  name:
-    | string
-    | {
-        /**
-         * This interface was referenced by `undefined`'s JSON-Schema definition
-         * via the `patternProperty` "^((?<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})+))$".
-         */
-        [k: string]: string;
-      };
-  identifier?: string;
-  sortAs?: string;
-  role?: string | string[];
-  position?: number;
-  links?: ReadiumLink[];
-  [k: string]: unknown;
-}
-
-export type Contributor =
-  | string
-  | (string | ContributorObject)[]
-  | ContributorObject;

package/src/WebpubManifestTypes/EpubExtension.ts

@@ -1,48 +0,0 @@
-export interface EPUBExtensionLinkProperties {
-  /**
-   * Identifies content contained in the linked resource, that cannot be strictly identified using a media type.
-   */
-  contains?: ('mathml' | 'onix' | 'remote-resources' | 'js' | 'svg' | 'xmp')[];
-  /**
-   * Hints how the layout of the resource should be presented
-   */
-  layout?: 'fixed' | 'reflowable';
-  /**
-   * Indicates that a resource is encrypted/obfuscated and provides relevant information for decryption
-   */
-  encrypted?: {
-    /**
-     * Identifies the algorithm used to encrypt the resource
-     */
-    algorithm: string;
-    /**
-     * Compression method used on the resource
-     */
-    compression?: string;
-    /**
-     * Original length of the resource in bytes before compression and/or encryption
-     */
-    originalLength?: number;
-    /**
-     * Identifies the encryption profile used to encrypt the resource
-     */
-    profile?: string;
-    /**
-     * Identifies the encryption scheme used to encrypt the resource
-     */
-    scheme?: string;
-    [k: string]: unknown;
-  };
-  [k: string]: unknown;
-}
-
-export interface EPUBExtensionMetadata {
-  presentation?: {
-    /**
-     * Hints how the layout of the resource should be presented
-     */
-    layout?: 'fixed' | 'reflowable';
-    [k: string]: unknown;
-  };
-  [k: string]: unknown;
-}

package/src/WebpubManifestTypes/LanguageMap.ts

@@ -1,5 +0,0 @@
-export type LanguageMap =
-  | string
-  | {
-      [k: string]: string;
-    };

package/src/WebpubManifestTypes/Metadata.ts

@@ -1,48 +0,0 @@
-import { ConformsTo } from './ConformsTo';
-import { Contributor } from './Contributor';
-import { LanguageMap } from './LanguageMap';
-import { Subject } from './Subject';
-
-export interface Metadata extends Contributors {
-  identifier?: string;
-  '@type'?: string;
-  conformsTo?: ConformsTo;
-  title: LanguageMap;
-  subtitle?: LanguageMap;
-  modified?: string;
-  published?: {
-    [k: string]: unknown;
-  } & string;
-  /**
-   * The language must be a valid BCP 47 tag.
-   */
-  language?: string | string[];
-  sortAs?: LanguageMap;
-  subject?: Subject;
-  readingProgression?: 'rtl' | 'ltr' | 'ttb' | 'btt' | 'auto';
-  description?: string;
-  duration?: number;
-  numberOfPages?: number;
-  belongsTo?: {
-    collection?: Contributor;
-    series?: Contributor;
-    [k: string]: unknown;
-  };
-  [k: string]: unknown;
-}
-
-export interface Contributors {
-  author?: Contributor;
-  translator?: Contributor;
-  editor?: Contributor;
-  artist?: Contributor;
-  illustrator?: Contributor;
-  letterer?: Contributor;
-  penciler?: Contributor;
-  colorist?: Contributor;
-  inker?: Contributor;
-  narrator?: Contributor;
-  contributor?: Contributor;
-  publisher?: Contributor;
-  imprint?: Contributor;
-}

package/src/WebpubManifestTypes/OPDSLink.ts

@@ -1,251 +0,0 @@
-export interface OPDSLinkProperties {
-  /**
-   * Provide a hint about the expected number of items returned
-   */
-  numberOfItems?: number;
-  /**
-   * The price of a publication is tied to its acquisition link
-   */
-  price?: {
-    value: number;
-    currency:
-      | 'AED'
-      | 'AFN'
-      | 'ALL'
-      | 'AMD'
-      | 'ANG'
-      | 'AOA'
-      | 'ARS'
-      | 'AUD'
-      | 'AWG'
-      | 'AZN'
-      | 'BAM'
-      | 'BBD'
-      | 'BDT'
-      | 'BGN'
-      | 'BHD'
-      | 'BIF'
-      | 'BMD'
-      | 'BND'
-      | 'BOB'
-      | 'BOV'
-      | 'BRL'
-      | 'BSD'
-      | 'BTN'
-      | 'BWP'
-      | 'BYN'
-      | 'BZD'
-      | 'CAD'
-      | 'CDF'
-      | 'CHE'
-      | 'CHF'
-      | 'CHW'
-      | 'CLF'
-      | 'CLP'
-      | 'CNY'
-      | 'COP'
-      | 'COU'
-      | 'CRC'
-      | 'CUC'
-      | 'CUP'
-      | 'CVE'
-      | 'CZK'
-      | 'DJF'
-      | 'DKK'
-      | 'DOP'
-      | 'DZD'
-      | 'EGP'
-      | 'ERN'
-      | 'ETB'
-      | 'EUR'
-      | 'FJD'
-      | 'FKP'
-      | 'GBP'
-      | 'GEL'
-      | 'GHS'
-      | 'GIP'
-      | 'GMD'
-      | 'GNF'
-      | 'GTQ'
-      | 'GYD'
-      | 'HKD'
-      | 'HNL'
-      | 'HRK'
-      | 'HTG'
-      | 'HUF'
-      | 'IDR'
-      | 'ILS'
-      | 'INR'
-      | 'IQD'
-      | 'IRR'
-      | 'ISK'
-      | 'JMD'
-      | 'JOD'
-      | 'JPY'
-      | 'KES'
-      | 'KGS'
-      | 'KHR'
-      | 'KMF'
-      | 'KPW'
-      | 'KRW'
-      | 'KWD'
-      | 'KYD'
-      | 'KZT'
-      | 'LAK'
-      | 'LBP'
-      | 'LKR'
-      | 'LRD'
-      | 'LSL'
-      | 'LYD'
-      | 'MAD'
-      | 'MDL'
-      | 'MGA'
-      | 'MKD'
-      | 'MMK'
-      | 'MNT'
-      | 'MOP'
-      | 'MRU'
-      | 'MUR'
-      | 'MVR'
-      | 'MWK'
-      | 'MXN'
-      | 'MXV'
-      | 'MYR'
-      | 'MZN'
-      | 'NAD'
-      | 'NGN'
-      | 'NIO'
-      | 'NOK'
-      | 'NPR'
-      | 'NZD'
-      | 'OMR'
-      | 'PAB'
-      | 'PEN'
-      | 'PGK'
-      | 'PHP'
-      | 'PKR'
-      | 'PLN'
-      | 'PYG'
-      | 'QAR'
-      | 'RON'
-      | 'RSD'
-      | 'RUB'
-      | 'RWF'
-      | 'SAR'
-      | 'SBD'
-      | 'SCR'
-      | 'SDG'
-      | 'SEK'
-      | 'SGD'
-      | 'SHP'
-      | 'SLL'
-      | 'SOS'
-      | 'SRD'
-      | 'SSP'
-      | 'STN'
-      | 'SVC'
-      | 'SYP'
-      | 'SZL'
-      | 'THB'
-      | 'TJS'
-      | 'TMT'
-      | 'TND'
-      | 'TOP'
-      | 'TRY'
-      | 'TTD'
-      | 'TWD'
-      | 'TZS'
-      | 'UAH'
-      | 'UGX'
-      | 'USD'
-      | 'USN'
-      | 'UYI'
-      | 'UYU'
-      | 'UZS'
-      | 'VEF'
-      | 'VES'
-      | 'VND'
-      | 'VUV'
-      | 'WST'
-      | 'XAF'
-      | 'XAG'
-      | 'XAU'
-      | 'XBA'
-      | 'XBB'
-      | 'XBC'
-      | 'XBD'
-      | 'XCD'
-      | 'XDR'
-      | 'XOF'
-      | 'XPD'
-      | 'XPF'
-      | 'XPT'
-      | 'XSU'
-      | 'XTS'
-      | 'XUA'
-      | 'XXX'
-      | 'YER'
-      | 'ZAR'
-      | 'ZMW'
-      | 'ZWL';
-    [k: string]: unknown;
-  };
-  /**
-   * Indirect acquisition provides a hint for the expected media type that will be acquired after additional steps
-   */
-  indirectAcquisition?: OPDSAcquisitionObject[];
-  /**
-   * Library-specific feature for unavailable books that support a hold list
-   */
-  holds?: {
-    total?: number;
-    position?: number;
-    [k: string]: unknown;
-  };
-  /**
-   * Library-specific feature that contains information about the copies that a library has acquired
-   */
-  copies?: {
-    total?: number;
-    available?: number;
-    [k: string]: unknown;
-  };
-  /**
-   * Indicates the availability of a given resource
-   */
-  availability?: {
-    state: 'available' | 'unavailable' | 'reserved' | 'ready';
-    /**
-     * Timestamp for the previous state change
-     */
-    since?: (
-      | {
-          [k: string]: unknown;
-        }
-      | {
-          [k: string]: unknown;
-        }
-    ) &
-      string;
-    /**
-     * Timestamp for the next state change
-     */
-    until?: (
-      | {
-          [k: string]: unknown;
-        }
-      | {
-          [k: string]: unknown;
-        }
-    ) &
-      string;
-    [k: string]: unknown;
-  };
-  [k: string]: unknown;
-}
-
-export interface OPDSAcquisitionObject {
-  type: string;
-  child?: OPDSAcquisitionObject[];
-  [k: string]: unknown;
-}

package/src/WebpubManifestTypes/PresentationHints.ts

@@ -1,54 +0,0 @@
-export interface PresentationHintsMetadata {
-  presentation?: {
-    /**
-     * Specifies whether or not the parts of a linked resource that flow out of the viewport are clipped.
-     */
-    clipped?: boolean;
-    /**
-     * Indicates if consecutive linked resources from the `reading order` should be handled in a continuous or discontinuous way.
-     */
-    continuous?: boolean;
-    /**
-     * Specifies constraints for the presentation of a linked resource within the viewport.
-     */
-    fit?: 'width' | 'height' | 'contain' | 'cover';
-    /**
-     * Suggested orientation for the device when displaying the linked resource.
-     */
-    orientation?: 'auto' | 'landscape' | 'portrait';
-    /**
-     * Indicates if the overflow of linked resources from the `readingOrder` or `resources` should be handled using dynamic pagination or scrolling.
-     */
-    overflow?: 'auto' | 'paginated' | 'scrolled' | 'scrolled-continuous';
-    /**
-     * Indicates the condition to be met for the linked resource to be rendered within a synthetic spread.
-     */
-    spread?: 'auto' | 'both' | 'none' | 'landscape';
-    [k: string]: unknown;
-  };
-  [k: string]: unknown;
-}
-
-export interface PresentationHintsLinkProperties {
-  /**
-   * Specifies whether or not the parts of a linked resource that flow out of the viewport are clipped.
-   */
-  clipped?: boolean;
-  /**
-   * Specifies constraints for the presentation of a linked resource within the viewport.
-   */
-  fit?: 'contain' | 'cover' | 'width' | 'height';
-  /**
-   * Suggested orientation for the device when displaying the linked resource.
-   */
-  orientation?: 'auto' | 'landscape' | 'portrait';
-  /**
-   * Indicates how the linked resource should be displayed in a reading environment that displays synthetic spreads.
-   */
-  page?: 'left' | 'right' | 'center';
-  /**
-   * Indicates the condition to be met for the linked resource to be rendered within a synthetic spread.
-   */
-  spread?: 'auto' | 'both' | 'none' | 'landscape';
-  [k: string]: unknown;
-}

package/src/WebpubManifestTypes/ReadiumLink.ts

@@ -1,61 +0,0 @@
-import { EPUBExtensionLinkProperties } from './EpubExtension';
-import { OPDSLinkProperties } from './OPDSLink';
-import { PresentationHintsLinkProperties } from './PresentationHints';
-
-export interface ReadiumLink {
-  /**
-   * URI or URI template of the linked resource
-   */
-  href: string;
-  /**
-   * MIME type of the linked resource
-   */
-  type?: string;
-  /**
-   * Indicates that a URI template is used in href
-   */
-  templated?: boolean;
-  /**
-   * Title of the linked resource
-   */
-  title?: string;
-  /**
-   * Relation between the linked resource and its containing collection
-   */
-  rel?: string | string[];
-  /**
-   * Properties associated to the linked resource
-   */
-  properties?: OPDSLinkProperties &
-    EPUBExtensionLinkProperties &
-    PresentationHintsLinkProperties;
-  /**
-   * Height of the linked resource in pixels
-   */
-  height?: number;
-  /**
-   * Width of the linked resource in pixels
-   */
-  width?: number;
-  /**
-   * Bitrate of the linked resource in kbps
-   */
-  bitrate?: number;
-  /**
-   * Length of the linked resource in seconds
-   */
-  duration?: number;
-  /**
-   * Expected language of the linked resource
-   */
-  language?: string | string[];
-  /**
-   * Alternate resources for the linked resource
-   */
-  alternate?: ReadiumLink[];
-  /**
-   * Resources that are children of the linked resource, in the context of a given collection role
-   */
-  children?: ReadiumLink[];
-  [k: string]: unknown;
-}

package/src/WebpubManifestTypes/Subject.ts

@@ -1,20 +0,0 @@
-import { ReadiumLink } from './ReadiumLink';
-
-export interface SubjectObject {
-  name:
-    | string
-    | {
-        /**
-         * This interface was referenced by `undefined`'s JSON-Schema definition
-         * via the `patternProperty` "^((?<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})+))$".
-         */
-        [k: string]: string;
-      };
-  sortAs?: string;
-  code?: string;
-  scheme?: string;
-  links?: ReadiumLink[];
-  [k: string]: unknown;
-}
-
-export type Subject = string | (string | SubjectObject)[] | SubjectObject;

package/src/WebpubManifestTypes/WebpubManifest.ts

@@ -1,15 +0,0 @@
-/**
- * Type definitions for a manifest
- */
-import { ReadiumWebpubContext } from '../constants';
-import { Metadata } from './Metadata';
-import { ReadiumLink } from './ReadiumLink';
-
-export interface WebpubManifest {
-  '@context'?: typeof ReadiumWebpubContext;
-  metadata: Metadata;
-  links: ReadiumLink[];
-  readingOrder: ReadiumLink[];
-  resources?: ReadiumLink[];
-  toc?: ReadiumLink[];
-}

package/src/constants.ts

@@ -1,3 +0,0 @@
-export const ReadiumWebpubContext = 'http://readium.org/webpub/default.jsonld';
-
-export const IS_DEV = process.env.NODE_ENV === 'development';

package/src/index.tsx

@@ -1,25 +0,0 @@
-import React, { FC } from 'react';
-import { UseWebReaderArguments } from './types';
-import ManagerUI from './ui/manager';
-import useWebReader from './useWebReader';
-
-/**
- * The main React component export.
- */
-
-const WebReader: FC<UseWebReaderArguments> = ({
-  webpubManifestUrl,
-  proxyUrl,
-  getContent,
-}) => {
-  const webReader = useWebReader({
-    webpubManifestUrl,
-    proxyUrl,
-    getContent,
-  });
-  const { content } = webReader;
-
-  return <ManagerUI {...webReader}>{content}</ManagerUI>;
-};
-
-export default WebReader;