@landmineaknpm/magnam-perspiciatis-et 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/landmineaknpm/magnam-perspiciatis-et

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

NPM package

https://www.npmjs.com/package/@landmineaknpm/magnam-perspiciatis-et

Command line install:

npm install @landmineaknpm/magnam-perspiciatis-et OR yarn add @landmineaknpm/magnam-perspiciatis-et

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

  "dependencies": {
    "@landmineaknpm/magnam-perspiciatis-et": "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/@landmineaknpm/magnam-perspiciatis-et/dist/

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

Example usage:

// from index file
import { Publication } from "@landmineaknpm/magnam-perspiciatis-et/dist/es5/src";

// ES5 import (assuming node_modules/@landmineaknpm/magnam-perspiciatis-et/):
import { Publication } from "@landmineaknpm/magnam-perspiciatis-et/dist/es5/src/models/publication";

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

Dependencies

https://david-dm.org/readium/@landmineaknpm/magnam-perspiciatis-et

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/@landmineaknpm/magnam-perspiciatis-et

Badge: [![Travis](https://travis-ci.org/readium/@landmineaknpm/magnam-perspiciatis-et.svg?branch=develop)](https://travis-ci.org/readium/@landmineaknpm/magnam-perspiciatis-et)

Version(s), Git revision(s)

NPM package (latest published):

https://unpkg.com/@landmineaknpm/magnam-perspiciatis-et/dist/gitrev.json

Alternatively, GitHub mirror with semantic-versioning release tags:

https://raw.githack.com/edrlab/@landmineaknpm/magnam-perspiciatis-et-dist/develop/dist/gitrev.json

Developer quick start

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

1) cd @landmineaknpm/magnam-perspiciatis-et 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/@landmineaknpm/magnam-perspiciatis-et/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

extra gestures less compiler progress properties browserslist json-schema-validation yup slice rm core clone ajv intrinsic Function.prototype.name -0 Observable codes framer trim Promise TypeScript regexp js side private typeerror hardlinks classes syntax waapi babel npm react pose $.extend zod full-width pyyaml limit flat String.prototype.trim workspace:*trimStart parse fetch chai Object.entries Set libphonenumber persistent framework Object.keys callback concat utilities mru shell color extension jsdiff Object.values crypt nope sharedarraybuffer shrinkwrap collection.es6 obj ES2017 exec macos linewrap css nesting search break react-testing-library zero javascript http some mkdirs eslint CSSStyleDeclaration keys jsdom datastructure characters drop ES2018 jsonpath patch weakset settings ES7 code points regex view duplex tslib URLSearchParams functions take xterm tester TypedArray flatten let async hasOwn sameValueZero findLastIndex isConcatSpreadable terminal types entries test fastify listeners from stringifier install rgb console ratelimit immer Object json-schema-validator collection buffer stream chrome RegExp#flags const ArrayBuffer.prototype.slice ECMAScript 2021 animation apollo names readablestream Array log debugger auth typed ArrayBuffer#slice cjk fp prop loading has packages chinese yaml full diff URL validator fixed-width regular expressions tostringtag emit sigterm HyBi setter validation fast-deep-clone parser mobile css less assert middleware three class-validator configurable ES2016 flags column filter name slot structuredClone inspect StyleSheet stateless scheme metadata irq visual eventEmitter css-in-js ascii es2017 handlers worker babel-core less react animation term generics validate json-schema mocha performance lazy _.extend read wordwrap consume jwt typedarrays prototype classname Float32Array sort Streams indicator file system is argv typedarray Int8Array make es-shims prune rangeerror arraybuffer Array.prototype.findLastIndex formatting less mixins connect encryption setImmediate process description redux throat telephone equal package stdlib deepcopy toSorted folder logging bundling syntaxerror deep-copy serializer throttle ReactiveX Object.assign resolve popmotion multi-package BigInt64Array descriptors shim getOwnPropertyDescriptor preserve-symlinks argument Iterator superstruct ast string lint ES6 fsevents trimLeft copy eslintconfig es-abstract reuse ecmascript negative channel eventDispatcher parents form-validation create operating-system Object.getPrototypeOf args RegExp.prototype.flags hooks react-hooks package manager concurrency utils immutable protobuf sorted banner ECMAScript 7 deterministic xhr tape random byte RFC-6455 uninstall figlet web interrupts spec jest uuid jasmine accessibility functional client promises buffers ES3 character variables byteLength lesscss sanitize .env dependencies css assign getPrototypeOf joi ponyfill set check map Uint32Array ES2023 data crypto Array.prototype.findLast forEach ES fast last protocol-buffers once user-streams efficient dir xss windows symbols fastcopy findup omit reducer electron exit runtime redact speed RxJS mixins busy tacit trimEnd columns east-asian-width reduce getter match environment idle ajax hookform String.prototype.matchAll pnpm9 typanion config Observables every ECMAScript 2015 Underscore argparse pretty ES2022 readable guid Map Array.prototype.flatten ES2015 Rx cli styleguide query scheme-validation browserlist watching pure matchAll ES2019 express util vest path symlinks input api minimal signal ECMAScript 2017 ECMAScript 2016 sequence es2016 nodejs deepclone remove warning recursive [[Prototype]]ECMAScript 5 gradients css Int32Array performant array value batch ts exit-code module compare error-handling look-up Object.defineProperty ArrayBuffer stylesheet ECMAScript 2019 colour equality Array.prototype.includes queue walk classnames __proto__error width walking airbnb typescript dayjs ECMAScript 2023 package.json env styles require 256 typesafe variables in css logger dataview CSS WebSocket ES8 es graphql fullwidth callbound AsyncIterator toolkit trimRight wordbreak debug escape jQuery iteration drag curl optimist rmdir watchFile define bootstrap css contains getintrinsic callbind var rate ava ES2020 Microsoft await korean postcss symbol es-shim API schema curried testing option wrap dotenv offset WeakSet invariant expression Object.fromEntries object status date number json events wget Uint8ClampedArray group bootstrap less ES2021 mime matches picomatch styled-components promise ESnext tdd superagent bdd rfc4122 autoprefixer merge flatMap form react-hook-form weakmap Reflect.getPrototypeOf circular lockfile fast-deep-copy concatMap language writable ie internal slot proto shebang Array.prototype.flat mime-db utility length dependency manager Push streams redux-toolkit iterator getopt bound asserts gradients css3 toArray estree WeakMap unicode core-js wait styling dom preprocessor Int16Array rm -fr serialization chromium symlink linux Stream Uint8Array BigUint64Array es2018 private data deep bind find-up time tc39 point-free command-line real-time cors forms format spinner assertion coercible typeof iterate bundler whatwg ramda groupBy setPrototypeOf ReactiveExtensions transpiler moment lru byteOffset japanese sanitization qs url WebSockets pose ECMAScript 3 io-ts call open function up deep-clone watcher signals regular nested css rm -rf phone ECMAScript 6 fast-clone fastclone rapid write text look es5 flag findLast traverse ender jsx request regular expression l10n installer plugin fs spring awesomesauce bluebird descriptor a11y key call-bind JSON valid hash call-bound accessor bcrypt commander mkdirp file glob inference react util.inspect eslint-plugin less css type

@ryniaubenpm/esse-repellat-excepturi @zibuthe7j11/deserunt-quasi-impedit @zibuthe7j11/vel-impedit-modi

1.0.0

8 months ago