r2-streamer-js

NodeJS Readium-2 "streamer"

NodeJS implementation (TypeScript transpiled to ECMAScript 2015 / ES6) of https://github.com/readium/readium-2/tree/master/streamer

Build status

THIS IS ALPHA SOFTWARE! Do not use in production. APIs are not stable, the architecture / code organization is likely to change frequently. All builds are from the develop branch. Continuous integration via TravisCI. NodeJS package published at the NPM registry. Test server apps deployed at Heroku and Now.sh.

Prerequisites

1. https://nodejs.org NodeJS >= 6, NPM >= 3 (check with node --version and npm --version from the command line)
2. https://yarnpkg.com Yarn >= 0.23 (check with yarn --version from the command line)

NPM package usage

https://www.npmjs.com/package/r2-streamer-js

yarn add r2-streamer-js or npm install r2-streamer-js

...or manually, in your project's package.json:

  "dependencies": {
    "r2-streamer-js": "latest"
  }

In your Javascript code (ECMAScript 2015 / ES6) or TypeScript code (all *.d.ts type definitions are included in ./node_modules/r2-streamer-js/**):

// see r2-streamer-js/dist/src/index.d.ts for exported types:
import { * } from "r2-streamer-js";

// ... or specific, direct type import, e.g.:
import { Publication } from "r2-streamer-js/dist/src/models/publication";

Quick start

Command line steps:

1. cd r2-streamer-js
2. npm update --global (sync NPM global packages)
3. yarn global upgrade (sync Yarn global packages)
4. yarn install (initialize local node_modules packages from dependencies declared in package.json)
5. yarn upgrade (sync local packages)
6. yarn run build (invoke the main build script: clean, lint, compile)
7. yarn test (run the unit tests)
8. yarn run cli {PATH_TO_EPUB_OR_DIR} (command line publication "dump") (path is relative or absolute)
9. yarn run server-debug {PATH_TO_EPUB_OR_DIR} (HTTP micro-service to serve publication manifest and associated resources)

Server API, HTTP routes

Two active deployments, at Heroku and Now.sh:

https://readium2.herokuapp.com

https://readium2-istyujuiho.now.sh

(all quoted HTTP routes below use the GET verb)

/pub/{PUB_ID}

{PUB_ID} is the base64 encoding of a local publication file (server filesystem, therefore limited to app-approved files), or of any arbitrary HTTP URL (see the "Support for remote publications" section below).

For demonstration purposes, the deployed server apps include wasteland-otf-obf.epub and childrens-literature.epub, obtained from https://idpf.github.io/epub3-samples/samples.html / https://github.com/IDPF/epub3-samples

/pub/{PUB_ID}/manifest.json

This route serves the "webpub manifest" JSON file using the application/webpub+json content type (canonical syntax, keys are recursively alphabetically sorted).

/pub/{PUB_ID}/manifest.json/show

This route serves a pretty-printed representation of the "webpub manifest" JSON, with clickable links for easy navigation into individual publication assets (see next route below).

/show is equivalent to /show/all. Here is a list of available JSON "filters": Cover image: /cover, Table of Contents: /toc, Metadata: /metadata, Spine: /spine, Page List: /pagelist, Landmarks: /landmarks, Links: /links, Resources: /resources, Media Overlays: /mediaoverlays.

/pub/{PUB_ID}/{ASSET_PATH}

This route serves individual assets (file resources) from the publication archive. {ASSET_PATH} is relative to the root of the publication container (e.g. EPUB zip archive), so files like /META-INF/container.xml can be requested.

Text files can be rendered in-page (for debugging) rather than processed by the web browser, by using the ?show=1 URL query string parameter.

/pub/{PUB_ID}/media-overlay

This route serves the full EPUB3 Media Overlay SMIL data (in its JSON form) using the application/vnd.readium.mo+json content type. Single spine item Media Overlays can be requested using the /media-overlay?resource={ASSET_PATH} URL query parameter ({ASSET_PATH} has the same definition as in the above section).

/url/ and /url/{ENCODED_URL}

This conveninent micro-service automatically redirects to the base64 route described in the above section (/pub/{PUB_ID}). Also see the "Support for remote publications" section below.

/opds/ and /opds/{ENCODED_URL}

This micro-service provides a basic OPDS reader. See the "Support for OPDS feeds" section below

Support for remote publications

See: https://github.com/edrlab/r2-streamer-js/blob/develop/docs/remote-epub.md

Support for OPDS feeds

See: https://github.com/edrlab/r2-streamer-js/blob/develop/docs/opds.md