@hishprorg/ducimus-accusamus NPM

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

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

GitHub repository

https://github.com/hishprorg/ducimus-accusamus

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

NPM package

https://www.npmjs.com/package/@hishprorg/ducimus-accusamus

Command line install:

npm install @hishprorg/ducimus-accusamus OR yarn add @hishprorg/ducimus-accusamus

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

  "dependencies": {
    "@hishprorg/ducimus-accusamus": "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/@hishprorg/ducimus-accusamus/dist/

(alternatively, GitHub mirror with semantic-versioning release tags: https://github.com/edrlab/@hishprorg/ducimus-accusamus-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/@hishprorg/ducimus-accusamus/dist/**, so this package can be used directly in a TypeScript project.

Example usage:

// from index file
import { Publication } from "@hishprorg/ducimus-accusamus/dist/es5/src";

// ES5 import (assuming node_modules/@hishprorg/ducimus-accusamus/):
import { Publication } from "@hishprorg/ducimus-accusamus/dist/es5/src/models/publication";

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

Dependencies

https://david-dm.org/readium/@hishprorg/ducimus-accusamus

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/@hishprorg/ducimus-accusamus

Badge: [![Travis](https://travis-ci.org/readium/@hishprorg/ducimus-accusamus.svg?branch=develop)](https://travis-ci.org/readium/@hishprorg/ducimus-accusamus)

Version(s), Git revision(s)

NPM package (latest published):

https://unpkg.com/@hishprorg/ducimus-accusamus/dist/gitrev.json

Alternatively, GitHub mirror with semantic-versioning release tags:

https://raw.githack.com/edrlab/@hishprorg/ducimus-accusamus-dist/develop/dist/gitrev.json

Developer quick start

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

1) cd @hishprorg/ducimus-accusamus 2) git status (please ensure there are no local changes, especially in package-lock.json and the dependency versions in package.json) 3) rm -rf node_modules (to start from a clean slate) 4) npm install, or alternatively npm ci (both commands initialize the node_modules tree of package dependencies, based on the strict package-lock.json definition) 5) npm run build:all (invoke the main build script: clean, lint, compile) 6) ls dist (that's the build output which gets published as NPM package) 7) 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) 8) 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) 9) 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) 10) npm run cli https://raw.githubusercontent.com/readium/@hishprorg/ducimus-accusamus/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

chrome idle validate serialization get Int8Array isConcatSpreadable is variables functions child classnames ES2020 fp StyleSheet ECMAScript 3 css function prototype handler awesomesauce drop collection.es6 telephone queueMicrotask configurable directory worker safe sharedarraybuffer syntax utils deep-copy hookform certificates three spinners mock generics auth regular module RxJS spinner Object.keys internal slot shim codes TypedArray @@toStringTag waf Int32Array language crypt commander extend internal babel-core manager ender babel local once airbnb traverse merge flag hasOwn lazy pure URL readablestream ECMAScript 7 autoscaling stringifier argument client clone loadbalancing indicator equality equal hardlinks names harmony .gitignore execfile linux aws react-testing-library eslint iteration toSorted apollo tacit animation stringify Array.prototype.findLastIndex syntaxerror acorn censor https callbound variables in css progress ansi jsx Float32Array Reflect.getPrototypeOf let parse set styleguide call-bind keys forEach serializer symbol wget spawn getter jsdiff mru channel effect-ts log reducer endpoint glob sqs dependencies positive array typeerror dotenv fast-clone deterministic JSON-Schema json sort warning jshint touch server ECMAScript 2017 autoprefixer streams Uint8ClampedArray beanstalk dynamodb fastify JSON dayjs create globals Int16Array fast-deep-clone byteOffset swf defineProperty BigUint64Array bundler Observable weakset trimLeft Observables proxy higher-order write queue remove tester express tostringtag optimist redux-toolkit find slot fastclone ECMAScript 2022 ses file lockfile datastructure includes environments asserts transpile core logger matches fork ecmascript ECMAScript 2021 has-own iterate bin sameValueZero mkdir toArray postcss-plugin es2018 fast query arktype handlers react findLast findLastIndex signal config polyfill front-end schema immer pose shared scheme dom react-component ArrayBuffer es7 ECMAScript 2018 require nodejs name concat point-free Object.is tslib environment import text move iterator symlinks japanese es2015 protobuf link take curried proto optimizer call-bound identifiers efficient performance computed-types espree ie expression gradients css css variable styled-components Object.assign last coercible mkdirs some filter ast cli i18n graphql 256 weakmap react-hooks 6to5 ECMAScript 2015 ES5 omit callback flux date storagegateway format values hash ECMAScript 2020 length global this value status typedarrays AsyncIterator TypeScript patch xhr korean valid metadata user-streams console error less.js typesafe yup negative rules assert WeakSet multi-package Array.prototype.findLast jsdom error-handling importexport intrinsic waapi Uint32Array windows rangeerror Array.prototype.flatMap querystring ArrayBuffer.prototype.slice Array.prototype.includes es5 bdd deepclone settings descriptors es2016 obj Iterator consume react-hook-form Array.prototype.filter mixins es-shim API Object.values call Push compare ES3 es-abstract less compiler events libphonenumber react animation output gdpr sequence art toobject es8 gradients css3 test authentication elasticache package manager es match symlink crypto scheme-validation check kinesis RegExp.prototype.flags zero jQuery slice types form-validation logging macos value ajv buffer json-schema-validation sns fast-deep-copy writable escape amazon ajax less mixins global object getopt formatting args typeof moment npmignore vpc unicode pyyaml System.global regex redirect testing make dir async jwt Set gestures file system chai validator gitignore fast-copy preprocessor toolkit drag bootstrap css from lesscss deep ESnext utilities spec functional password data stream fantasy-land transpiler private data back-end String.prototype.matchAll ES2019 Array.prototype.flat Object.getPrototypeOf fetch prop pino read make json-schema byte rgb url trimEnd WebSockets jest Map type entries subprocess lru recursive elb wait groupBy ebs descriptor HyBi Stream argv l10n javascript operating-system package.json typanion cloudtrail var flat column color buffers prefix binaries util ramda zx ECMAScript 2019 simpledb const qs whatwg typedarray http Underscore quote exec ReactiveExtensions cloudformation side ECMAScript 5 postcss execute openssl process classes prune setter listeners property routing helper superagent Streams CSSStyleDeclaration __proto__phone resolve ES2022 reuse starter arraybuffer character elm mkdirp packages number protocol-buffers eslintplugin serialize ES2016 nested css install accessibility sigint banner flags WeakMap full Object.defineProperty which trimStart Symbol.toStringTag pretty react pose ES6 utility private time Array.prototype.contains browser dataView json-schema-validator joi dom-testing-library route53 ArrayBuffer#slice columns fastcopy es-shims transport runtime function.length WebSocket irq eventEmitter matchAll ES8 fs colour request browserlist util.inspect regular-expression tools pnpm9 deepcopy yaml plugin every jsonschema styles compile less CSS extra s3 negative zero tc39 monorepo classname structuredClone upload URLSearchParams exit-code env bound ECMAScript 2016 ES inspect native css-in-js live walk robust self invariant interrupts Promise Symbol ReactiveX bootstrap less sorted deep-clone trim style location group ES2017 flatMap east-asian-width agent fixed-width global parser visual colors workflow sham ec2 delete hooks eslintconfig bundling vest dependency manager Rx tty arrays ECMAScript shebang cloudsearch performant accessor Object nope Object.entries symbols bcrypt cloudfront validation assertion readable enumerable eventDispatcher YAML vars iam exit ES2018 trimRight figlet predictable input assign emr state compiler window npm fnmatch forms glacier cache properties hasOwnProperty promise persistent key define asterisks less css rds callbind replay shell Object.fromEntries io-ts installer emit hot inference byteLength electron dataview binary string rapid term pipe view form fullwidth signals description BigInt64Array css nesting busy immutable popmotion class-validator loading flatten encryption es2017 Function.prototype.name Uint8Array RegExp#flags has redux ts terminal path es6 command-line Microsoft chromium TypeBox dir stateless api typed getPrototypeOf random ES7 estree uninstall 0 service sigterm ES2021 shrinkwrap ES2023 Float64Array redact full-width object circular real-time Array.prototype.flatten less getOwnPropertyDescriptor speed regexp eslint-plugin spring stylesheet stable ES2015 ECMAScript 6 contains $.extend browserslist toStringTag reduce Uint16Array ascii setPrototypeOf ponyfill js command minimal Array -0

@hishprorg/alias-quia-occaecati @hishprorg/aliquid-ad-vero @hishprorg/autem-sint-quas @hishprorg/commodi-distinctio-alias @hishprorg/cum-rem-consequuntur @hishprorg/cupiditate-quaerat-qui @hishprorg/earum-sint-veritatis @hishprorg/eius-vero-dicta @hishprorg/est-dicta-quis @hishprorg/et-pariatur-a @hishprorg/expedita-quo-accusamus @hishprorg/expedita-ut-iste @hishprorg/fuga-sit-corrupti @hishprorg/hic-repellendus-hic @hishprorg/incidunt-quibusdam-tempore @hishprorg/itaque-esse-accusamus @hishprorg/iure-optio-nihil @hishprorg/magni-amet-id @hishprorg/magni-nisi-aperiam @hishprorg/maxime-voluptates-enim @hishprorg/natus-eligendi-consequuntur @hishprorg/nihil-ad-ratione @hishprorg/perspiciatis-ratione-unde @hishprorg/quis-perferendis-culpa @hishprorg/reprehenderit-excepturi-sed @hishprorg/sint-nam-consequuntur @hishprorg/sunt-officia-eligendi @hishprorg/sunt-voluptatem-nobis @hishprorg/unde-vitae-reprehenderit @hishprorg/wafflejs

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago