3.13.111 • Published 10 months ago

@patrtorg/ducimus-hic v3.13.111

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

NodeJS / TypeScript Readium-2 "shared" models

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

License

Build status

NPM David

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/patrtorg/ducimus-hic

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

NPM package

https://www.npmjs.com/package/@patrtorg/ducimus-hic

Command line install:

npm install @patrtorg/ducimus-hic OR yarn add @patrtorg/ducimus-hic

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

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

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

Example usage:

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

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

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

Dependencies

https://david-dm.org/readium/@patrtorg/ducimus-hic

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/@patrtorg/ducimus-hic

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

Version(s), Git revision(s)

NPM package (latest published):

https://unpkg.com/@patrtorg/ducimus-hic/dist/gitrev.json

Alternatively, GitHub mirror with semantic-versioning release tags:

https://raw.githack.com/edrlab/@patrtorg/ducimus-hic-dist/develop/dist/gitrev.json

Developer quick start

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

1) cd @patrtorg/ducimus-hic 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/@patrtorg/ducimus-hic/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

call-bindcomparestyleguideconsumeUint8ArraytoReversedeslintpluginlook-upiteratorexecroute53fastcloneimmutableObject.fromEntriesrobustformattingStreamsutilitiesObject.keysdependenciesl10nECMAScript 2016configurablelengthwarningreuseoffsetutilawesomesauceelbespreecurlvalidationeslint-pluginio-tsmanipulationfast-copylistenersdotenvflattenstylingjesttacitassignfinddircloudfrontenumerableUint32ArrayarraysRegExp#flagsfindupgenericsFloat32Arraykinesisuphttpurli18npoint-freeReactiveExtensionsaccessorJSON-Schemaes8sharedarraybufferInt32ArrayoptimizerclassnamenopemergepluginES3globalsReflect.getPrototypeOfpushsuperstructdom-testing-libraryPushrfc4122avaArray.prototype.findLasttapprivateArray.prototype.includesagentgetterreact-hook-formttypostcss-plugincollectionhigher-orderStyleSheetworkflowloadbalancingcoerciblefilejoiinternalutil.inspectcode pointsprocesscomputed-typesterminalboundUint16ArrayCSSsesentriesbytelintoncetyped arrayendpointprotosprings3ignorersscore-jsidlefpexecutetelephonefunction.length[[Prototype]]optimistmruvaluecloudtrailsnsnativefeed3dtransportajviamdebuggercolorroutershamsyntaxerrorMicrosoftfull-widthpropvariablescompileridentifiersrdsasteriskslibphonenumberemrstreamcryptoES2023sinatraebsfast-deep-clonelocalfromFloat64ArraycharactersvalidatoroutputwritableidhelperspureArray.prototype.flatMapproxymomentfigletbrowserlistnameTypedArraytranspilertraversehas-ownforkregularglobalWeakMapdeepreact-testing-libraryes7Array.prototype.flatobjectecmascripthasESRxgetPrototypeOftouchlookcheckwritehardlinkscodesObject.assignpostcssspeedglobrulescolumnsconstinvariantECMAScript 5Promisepreprocessorcloudformationfetchdebug.envqueueregular expressionrestroutingECMAScript 2019metadatanegativesetpatchlogasyncES2015removeObject.entriesspawnwalkingartdefineanimationenderponyfilllocationstreamsjQuerymatchAllstringBigUint64Arrayprivate datauser-streamsArray.prototype.containsexecfileswfscheme-validationamazonworkspace:*weakmaptszxreact-hooksnpminspectMapprunefpsjson-schema-validationbyteOffsetmatchemitcommand-lineargsassertrm -frdescriptioncoloursymbolspipemulti-packageCSSStyleDeclarationregexexpressiontoSortedhookformtypedarrayES7jsdiffredirectspecunicodetrimStarttakequeryclassnamescolorswhatwgnpmignoreIteratoryupec2ObservablefnmatchruntimehelperdatemkdirdayjschromiumTypeBoxsqsdeepcloneprotobufrouteES2018eventEmitterwebcloudwatchvpcObject.ises-abstractkarmafastcopyStreamECMAScript 2015reducehasOwncloneregular-expressionasciifastRFC-6455efficientdescriptorscommandgesturesdynamodbimportjsonschemavarsbddfantasy-landjsxparserSymbolrmreverseramdamapESnextdataViewes-shim APIreal-timeqsUnderscoreharmonyajaxAsyncIteratorjsloggeransiform-validationmanagerformtapehashmakereadabledeep-clonemonorepopicomatchhttpslanguageObjectsharedcensortoStringTagoptionuuidmkdirsfullomitlastairbnbWebSocketsinstalleast-asian-widthfind-upcollection.es6ES2021widthtestingES2016importexportdatachaiapiyamlObservablesclassesietoArraytc39superagentparentsescapelinkvisualinternal slottranspilejshintpathinprefixYAMLArrayBufferposereadablestreamenvironmentstarterperformancetrimRighttostringtagflatMapserializeschemafastifyshimhasOwnProperty
3.13.109

10 months ago

3.13.110

10 months ago

3.13.111

10 months ago

3.13.108

10 months ago

3.13.107

10 months ago

3.13.106

10 months ago

3.12.106

10 months ago

3.12.105

10 months ago

3.12.104

10 months ago

3.12.103

10 months ago

3.12.102

10 months ago

3.12.101

10 months ago

3.12.100

10 months ago

2.12.100

10 months ago

2.12.99

10 months ago

2.12.98

10 months ago

2.12.97

10 months ago

2.12.96

10 months ago

2.12.95

10 months ago

2.12.94

10 months ago

2.12.93

10 months ago

2.12.92

10 months ago

2.12.91

10 months ago

2.12.90

11 months ago

2.12.89

11 months ago

2.11.89

11 months ago

2.11.88

11 months ago

2.11.87

11 months ago

2.11.86

11 months ago

2.11.85

11 months ago

2.10.85

11 months ago

2.9.85

11 months ago

2.9.84

11 months ago

2.9.83

11 months ago

2.9.82

11 months ago

2.9.81

11 months ago

2.9.80

11 months ago

2.9.79

11 months ago

2.8.79

11 months ago

2.8.78

11 months ago

2.8.77

11 months ago

2.8.76

11 months ago

2.8.75

11 months ago

2.8.74

11 months ago

2.8.73

11 months ago

2.8.72

11 months ago

2.8.71

11 months ago

2.8.70

11 months ago

2.8.69

11 months ago

2.8.68

11 months ago

2.8.67

11 months ago

2.8.66

11 months ago

2.8.65

11 months ago

2.8.64

12 months ago

2.8.63

12 months ago

2.8.62

12 months ago

2.8.61

12 months ago

2.8.60

12 months ago

2.8.59

12 months ago

2.7.59

12 months ago

2.7.58

12 months ago

2.7.57

12 months ago

2.7.56

12 months ago

2.7.55

12 months ago

2.7.54

12 months ago

2.7.53

12 months ago

2.7.52

12 months ago

2.7.51

12 months ago

2.7.50

12 months ago

2.7.49

12 months ago

2.7.48

12 months ago

2.7.47

12 months ago

2.7.46

12 months ago

2.7.45

1 year ago

2.7.44

1 year ago

2.7.43

1 year ago

2.7.42

1 year ago

2.7.41

1 year ago

2.7.40

1 year ago

2.7.39

1 year ago

2.7.38

1 year ago

2.7.37

1 year ago

2.7.36

1 year ago

2.7.35

1 year ago

2.7.34

1 year ago

2.6.34

1 year ago

2.6.33

1 year ago

2.6.32

1 year ago

2.5.32

1 year ago

2.5.31

1 year ago

2.5.30

1 year ago

2.5.29

1 year ago

2.5.28

1 year ago

2.5.27

1 year ago

2.5.26

1 year ago

2.5.25

1 year ago

2.5.24

1 year ago

2.5.23

1 year ago

2.5.22

1 year ago

2.4.22

1 year ago

2.4.21

1 year ago

2.4.20

1 year ago

1.4.20

1 year ago

1.4.19

1 year ago

1.4.18

1 year ago

1.4.17

1 year ago

1.4.16

1 year ago

1.4.15

1 year ago

1.4.14

1 year ago

1.4.13

1 year ago

1.3.13

1 year ago

1.3.12

1 year ago

1.3.11

1 year ago

1.2.11

1 year ago

1.2.10

1 year ago

1.1.10

1 year ago

1.1.9

1 year ago

1.1.8

1 year ago

1.1.7

1 year ago

1.1.6

1 year ago

1.1.5

1 year ago

1.1.4

1 year ago

1.1.3

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago