@ryniaubenpm2/debitis-praesentium-non

v1.0.0

Published

8 months ago

NodeJS implementation (written in TypeScript) of core models for the Readium2 architecture ( https://github.com/readium/architecture/ ).

Downloads

0High
0Medium
0Low

mi762136

listeners patch descriptor setter uninstall call-bind rm gradients css positive object sinatra logging sham rds wrap emit clone pyyaml package.json find-up hash typeerror Object.is cloudfront ArrayBuffer.prototype.slice escape tc39 es8 framework chrome es5 sns mime nodejs fastify wordbreak compile less arraybuffer less mixins ES2023 zod ES2015 es2017 iterate libphonenumber merge immutable fetch testing deepclone jasmine less compiler getOwnPropertyDescriptor bluebird tape spawn parse look term ES2021 WebSockets flux styleguide pipe Float32Array expression electron StyleSheet throat predictable equal flatten metadata browserslist Stream symlink yup sharedarraybuffer limit speed yaml spec name cloudtrail callbind Object.keys forEach opens concatMap react-testing-library cloudwatch scheme Rx ECMAScript 2017 eslintconfig ratelimit colour entries has $.extend Push copy buffers fullwidth option remove Promise korean test stringify ArrayBuffer#slice authentication Underscore shebang ES ec2 shell console once picomatch toobject monorepo modules reuse guid column irq simpledb accessibility every regular install create look-up japanese glacier weakmap which compare environments es2018 Set negative zero types hardlinks Function.prototype.name reduce launch matches ponyfill loadbalancing style callbound delete ArrayBuffer property schema text hasOwn json mkdir key arrays gradients css3 bootstrap css exe environment JSON-Schema eventEmitter ES2019 setPrototypeOf recursive gdpr minimal rest uuid Microsoft io-ts rapid wget dynamodb rfc4122 ReactiveX Array.prototype.findLastIndex css less http concat serialize internal Object.entries findLastIndex find serializer groupBy file system accessor superagent cli jest toSorted ES5 Array.prototype.flat String.prototype.matchAll tty cors open Array.prototype.contains sort compiler Symbol.toStringTag mobile description watching auth time beanstalk s3 rate performant tslib write get WeakSet concurrency cloudsearch argv hot date ender symbols querystring importexport es2015 walk break Array.prototype.filter match ES2018 form path unicode ES8 set Reflect.getPrototypeOf ESnext symlinks packages optimizer collection.es6 typedarrays Object number https sigterm codes watch [[Prototype]]functional react-hooks stdlib preserve-symlinks TypeBox dayjs styling view typedarray last ECMAScript 2020 equality lint intrinsic banner native efficient curl utility mapreduce fast-copy tools hookform assert value stringifier ECMAScript 5 postcss-plugin progress workflow elm shared jQuery state bound events ascii ES2016 matchAll getintrinsic vars YAML computed-types callback storagegateway async Float64Array extension toolkit prototype language spinner queue configurable variables watchFile es-shim API formatting byteLength l10n xterm ES2020 _.extend vest core flatMap search arguments typed link __proto__less.js dependency manager robust route53 opener commander argparse api Uint8Array traverse lazy Array.prototype.flatten jwt sorted tap airbnb CSS start -0 properties linux terminal RegExp.prototype.flags trimStart bundling require touch eslintplugin es7 restful shim toStringTag idle eslint-plugin mkdirs parent streams ECMAScript 2022 streams2 typescript inference postcss Array.prototype.findLast glob default Int8Array ECMAScript 2021 wordwrap own core-js includes Object.defineProperty fast ebs loading operating-system promises trimEnd redux command-line signals prefix dependencies cache consume byte await karma AsyncIterator in error-handling higher-order debug util dom throttle internal slot globals installer env names Int32Array query ava mru shrinkwrap ECMAScript 6 css interrupts resolve syntaxerror full zero wait tostringtag map stable ECMAScript 2018 encryption toArray exit prop readablestream Array Map ReactiveExtensions signal rm -rf log dataView runtime deep mixins proxy xdg Array.prototype.includes structuredClone jsdom nested css 256 syntax isConcatSpreadable mimetypes width qs is live URLSearchParams define fastclone make dir HyBi defineProperty redact Streams es6 WeakMap String.prototype.trim package manager jshint group diff cmd estree keys real-time util.inspect jsx rm -fr identifiers parsing RFC-6455 windows deepcopy private data validation buffer router getter file collection protobuf Object.values directory whatwg Iterator module emoji child chai polyfill argument app emr serialization ES6 exit-code ast columns byteOffset task slot bind node BigInt64Array push debugger findLast fps fastcopy iteration variables in css javascript browserlist starter hasOwnProperty assign amazon handlers es-abstract batch react-hook-form parents mime-db color immer tdd flag iterator classnames WebSocket dotenv functions autoscaling es ECMAScript 2016 input awesomesauce a11y mocha enumerable Uint16Array url regexp express dom-testing-library ECMAScript 3 trimRight chinese colors ECMAScript 2023 Int16Array rmdir ts eslint tester nope js extra valid lockfile limited urls Observable fs up args Array.prototype.flatMap telephone sequence queueMicrotask validate visual bdd

NodeJS / TypeScript Readium-2 "shared" models

NodeJS implementation (written in TypeScript) of core models for the Readium2 architecture ( https://github.com/readium/architecture/ ).

Build status

Changelog

Prerequisites

https://nodejs.org NodeJS >= 8, NPM >= 5 (check with command line node --version and npm --version)
OPTIONAL: https://yarnpkg.com Yarn >= 1.0 (check with command line yarn --version)

GitHub repository

https://github.com/ryniaubenpm2/debitis-praesentium-non

There is no github.io site for this project (no gh-pages branch).

NPM package

https://www.npmjs.com/package/@ryniaubenpm2/debitis-praesentium-non

Command line install:

npm install @ryniaubenpm2/debitis-praesentium-non OR yarn add @ryniaubenpm2/debitis-praesentium-non

...or manually add in your package.json:

  "dependencies": {
    "@ryniaubenpm2/debitis-praesentium-non": "latest"
  }

The JavaScript code distributed in the NPM package is usable as-is (no transpilation required), as it is automatically-generated from the TypeScript source.

Several ECMAScript flavours are provided out-of-the-box: ES5, ES6-2015, ES7-2016, ES8-2017:

https://unpkg.com/@ryniaubenpm2/debitis-praesentium-non/dist/

(alternatively, GitHub mirror with semantic-versioning release tags: https://github.com/edrlab/@ryniaubenpm2/debitis-praesentium-non-dist/tree/develop/dist/ )

The JavaScript code is not bundled, and it uses require() statement for imports (NodeJS style).

More information about NodeJS compatibility:

http://node.green

Note that web-browser Javascript is currently not supported (only NodeJS runtimes).

The type definitions (aka "typings") are included as *.d.ts files in ./node_modules/@ryniaubenpm2/debitis-praesentium-non/dist/**, so this package can be used directly in a TypeScript project.

Example usage:

// from index file
import { Publication } from "@ryniaubenpm2/debitis-praesentium-non/dist/es5/src";

// ES5 import (assuming node_modules/@ryniaubenpm2/debitis-praesentium-non/):
import { Publication } from "@ryniaubenpm2/debitis-praesentium-non/dist/es5/src/models/publication";

// ... or alternatively using a convenient path alias in the TypeScript config (+ WebPack etc.):
import { Publication } from "@@ryniaubenpm2/debitis-praesentium-non/models/publication";

Dependencies

https://david-dm.org/readium/@ryniaubenpm2/debitis-praesentium-non

A package-lock.json is provided (modern NPM replacement for npm-shrinkwrap.json).

A yarn.lock file is currently not provided at the root of the source tree.

Continuous Integration

TODO (unit tests?) https://travis-ci.org/readium/@ryniaubenpm2/debitis-praesentium-non

Badge: [![Travis](https://travis-ci.org/readium/@ryniaubenpm2/debitis-praesentium-non.svg?branch=develop)](https://travis-ci.org/readium/@ryniaubenpm2/debitis-praesentium-non)

Version(s), Git revision(s)

NPM package (latest published):

https://unpkg.com/@ryniaubenpm2/debitis-praesentium-non/dist/gitrev.json

Alternatively, GitHub mirror with semantic-versioning release tags:

https://raw.githack.com/edrlab/@ryniaubenpm2/debitis-praesentium-non-dist/develop/dist/gitrev.json

Developer quick start

Command line steps (NPM, but similar with YARN):

cd @ryniaubenpm2/debitis-praesentium-non
git status (please ensure there are no local changes, especially in package-lock.json and the dependency versions in package.json)
rm -rf node_modules (to start from a clean slate)
npm install, or alternatively npm ci (both commands initialize the node_modules tree of package dependencies, based on the strict package-lock.json definition)
npm run build:all (invoke the main build script: clean, lint, compile)
ls dist (that's the build output which gets published as NPM package)
npm run cli PATH_TO_PACKED_OR_EXPLODED_EPUB PATH_TO_OUTPUT_FOLDER OPTIONAL_DECRYPT_KEY (to parse a publication and convert it to a Readium2 manifest with extracted resources, paths can be relative or absolute)
npm run cli ./misc/epubs/wasteland-otf-obf_LCP_dan.lcpl.epub ./misc/epubs/ dan (same as above, working example with built-in sample LCP basic/test profile)
npm run cli ./misc/epubs/wasteland-otf-obf_LCP_dan.lcpl.epub ./misc/epubs/ ec4f2dbb3b140095550c9afbbb69b5d6fd9e814b9da82fad0b34e9fcbe56f1cb (same as above, with SHA256 checksum/hex-digest to avoid plain-text passphrase in console)
npm run cli https://raw.githubusercontent.com/readium/@ryniaubenpm2/debitis-praesentium-non/develop/misc/epubs/wasteland-otf-obf_LCP_dan.lcpl.epub ./misc/epubs/ dan (same as above, but with a remote HTTP URL)

Daisy Integration

Daisy

Documentation

TODO