Skip to content

Latest commit

 

History

History
1529 lines (1016 loc) · 42.4 KB

CHANGELOG.md

File metadata and controls

1529 lines (1016 loc) · 42.4 KB

Next

Git diff:

Changes:

  • TODO

1.0.79

Build environment: NodeJS 22.11.0, NPM 11.0.0

Changes:

  • fix: XML BOM removal before parse

Git revision info:

Git commit history:

Git diff:

1.0.78

Build environment: NodeJS 22.11.0, NPM 11.0.0

Changes:

  • NPM package updates
  • Flox/Nix support (dev)

Git revision info:

Git commit history:

Git diff:

1.0.77

Build environment: NodeJS 22.11.0, NPM 10.9.0

Changes:

  • Fixed DAiSY 2.02 parsing of SMIL XML with system-required skippables

Git revision info:

Git commit history:

Git diff:

1.0.76

Build environment: NodeJS 22.11.0, NPM 10.9.0

Changes:

  • NPM package updates
  • Fixed DAiSY 2.02 parsing of SMIL XML with multiple contiguous AUDIO inside SEQ inside PAR (next to TEXT)

Git revision info:

Git commit history:

Git diff:

1.0.75

Build environment: NodeJS 20.17.0, NPM 10.8.3

Changes:

  • NPM package updates

Git revision info:

Git commit history:

Git diff:

1.0.74

Build environment: NodeJS 20.12.2, NPM 10.7.0

Changes:

  • NPM package updates
  • Workaround for broken DAISY 2.02 digital talking books that reference non-existing text documents, fallback to audio-only (works with both media overlays EPUB conversion and audiobook ReadiumWebPubManifest)

Git revision info:

Git commit history:

Git diff:

1.0.73

Build environment: NodeJS 20.12.0, NPM 10.5.0

Changes:

  • Fixed postinstall NPM script which was breaking production package installs (i.e. without rimraf development dependency)

Git revision info:

Git commit history:

Git diff:

1.0.72

Build environment: NodeJS 20.11.0, NPM 10.4.0

Changes:

  • Support for video in EPUB3 Media Overlays model (non-standardized, for prototyping reading system MVP)

Git revision info:

Git commit history:

Git diff:

1.0.71

Build environment: NodeJS 20.10.0, NPM 10.2.5

Changes:

  • NPM package updates

Git revision info:

Git commit history:

Git diff:

1.0.70

Build environment: NodeJS 18.17.1, NPM 9.8.1

Changes:

  • Fixes for DAISY 2.02 and 3.0 converter / audio-only audiobooks generator, removal of empty audio nodes (often page breaks)
  • NPM package updates

Git revision info:

Git commit history:

Git diff:

1.0.69

Build environment: NodeJS 18.17.0, NPM 9.8.1

Changes:

  • Workarounds for DAISY 2.02 and 3.0 converter (in particular for audio-only audiobooks generation)
  • NPM package updates

Git revision info:

Git commit history:

Git diff:

1.0.68

Build environment: NodeJS 18.16.0, NPM 9.8.0

Changes:

  • NPM package updates

Git revision info:

Git commit history:

Git diff:

1.0.67

Build environment: NodeJS 18.14.2, NPM 9.5.1

Changes:

  • Fix: added support for new / modern accessibility metadata, whilst preserving support for legacy JSON structure (so as to not break existing consumers)

Git revision info:

Git commit history:

Git diff:

1.0.66

Build environment: NodeJS 18.14.2, NPM 9.5.1

Changes:

  • NPM package updates
  • fix: encryption.xml with percent-encoded URIs (decode before compare with WebPubManifest already-decoded by package.opf XML-to-JSON converter)
  • fix: encrypted TOC is ignored
  • fix (workaround): linear=no in fixed layout publications is ignored, due to Apple iBooks / Books.app setting a precedent (authored FXL books with non-linear cover image as first spine item do exist, unfortunately this breaks spread left/right ordering if we apply the logical interpretation of linear=no :(
  • feat: added highlight text before/after raw (not normalised with whitespace collapse) in existing data structure (actual engine changes in navigator component)

Git revision info:

Git commit history:

Git diff:

1.0.65

Build environment: NodeJS 18.12.1, NPM 9.1.2

Changes:

  • Fix: EPUB fixed-layout pre-paginated publications, parsing of spine items properties rendition-prefixed page-spread-left/center/right metadata.

Git revision info:

Git commit history:

Git diff:

1.0.64

Build environment: NodeJS 18.12.1, NPM 9.1.1

Changes:

  • NPM package updates

Git revision info:

Git commit history:

Git diff:

1.0.63

Build environment: NodeJS 16.18.0, NPM 8.19.2

Changes:

  • Fixed EPUB OPF a11y metadata parsing (link rel attribute)
  • Added dual meta/link dcterms:conformsTo a11y metadata parsing

Git revision info:

Git commit history:

Git diff:

1.0.62

Build environment: NodeJS 16.18.0, NPM 8.19.2

Changes:

  • Fix DAISY 2.02 HTML NCC metadata parsing: multimedia type default to full text audio

Git revision info:

Git commit history:

Git diff:

1.0.61

Build environment: NodeJS 16.17.0, NPM 8.19.1

Changes:

  • Fix metadata multilingual parsing (xml:lang in package OPF): exception for RTL locales that convey direction, a11y:summary is not language sensitive (no translations) but can carry direction too
  • Fix incorrectly-generated "unknown" metadata in RWPM JSON (duplicate keys)

Git revision info:

Git commit history:

Git diff:

1.0.60

Build environment: NodeJS 16.17.0, NPM 8.19.1

Changes:

  • Fixed parsing of xml:lang in package OPF for metadata title, subtitle, contributors (authors, publishers, etc.), subjects, a11y-summary (see edrlab/thorium-reader-epub-tests#18 )

Git revision info:

Git commit history:

Git diff:

1.0.59

Build environment: NodeJS 16.14.2, NPM 8.5.5

Changes:

  • NPM package updates
  • Fixed cpy-cli (--flat)

Git revision info:

Git commit history:

Git diff:

1.0.58

Build environment: NodeJS 16.14.2, NPM 8.5.5

Changes:

  • Fixed NPM package lockfile (was corrupted)
  • Added fallback for metadata published/modified date parsing (EPUB v2/3 and DAISY v2/3)

Git revision info:

Git commit history:

Git diff:

1.0.57

Build environment: NodeJS 16.14.2, NPM 8.5.5

Changes:

  • NPM package updates
  • Fixed metadata published/modified date parsing (EPUB v2/3 and DAISY v2/3)

Git revision info:

Git commit history:

Git diff:

1.0.56

Build environment: NodeJS 16.14.0, NPM 8.5.3

Changes:

  • NPM package updates
  • Fixed HTML / XML decoding bug in DAISY parser

Git revision info:

Git commit history:

Git diff:

1.0.55

Build environment: NodeJS 16.13.1, NPM 8.3.0

Changes:

  • NPM package updates

Git revision info:

Git commit history:

Git diff:

1.0.54

Build environment: NodeJS 14.18.1, NPM 6.14.15

Changes:

  • NPM package updates
  • NodeJS v16 minimum requirement (NPM 8)
  • DAISY 2 support (audio-only with TOC and sub-phrases, as well as full-text full-audio)
  • CLI utility to generate audio-only ReadiumWebPubManifest external JSON from DAISY audio book

Git revision info:

Git commit history:

Git diff:

1.0.53

Build environment: NodeJS 14.18.1, NPM 6.14.15

Changes:

  • NPM package updates
  • NodeJS v14 minimum requirement

Git revision info:

Git commit history:

Git diff:

1.0.52

Build environment: NodeJS 14.17.5, NPM 6.14.14

Changes:

  • NPM package updates

Git revision info:

Git commit history:

Git diff:

1.0.51

Build environment: NodeJS 14.16.1, NPM 6.14.13

Changes:

  • NPM package updates

Git revision info:

Git commit history:

Git diff:

1.0.50

Build environment: NodeJS 14.16.0, NPM 6.14.12

Changes:

  • DAISY3 support: relax OPF detection to allow subfolder(s)

Git revision info:

Git commit history:

Git diff:

1.0.49

Build environment: NodeJS 14.15.1, NPM 6.14.10

Changes:

  • Fixed LCP PDF handling (webpub type discovery before parsing)

Git revision info:

Git commit history:

Git diff:

1.0.48

Build environment: NodeJS 14.15.1, NPM 6.14.10

Changes:

  • NPM package updates
  • Support for DAISY3 audio-only talking books (conversion to EPUB3 Media Overlays)
  • Added parsing of NCX audio NavLabels, and preserved in ReadiumWebPubManifest Table of Contents, Page List, Landmarks, etc. (alternate links with URI Media Fragments)
  • Fixed DAISY3 DTBook XHTML in full text+audio converter

Git revision info:

Git commit history:

Git diff:

1.0.47

Build environment: NodeJS 14.15.1, NPM 6.14.9

Changes:

  • NPM package updates (including fixed TA-JSON for class inheritance hierarchy and custom additional JSON properties)
  • Added missing support for Number type converter in XML deserialization

Git revision info:

Git commit history:

Git diff:

1.0.46

Build environment: NodeJS 14.15.0, NPM 6.14.8

Changes:

  • Fixed severe metadata parsing bug (code typo which skipped conditional branch)

Git revision info:

Git commit history:

Git diff:

1.0.45

Build environment: NodeJS 14.15.0, NPM 6.14.8

Changes:

  • Support for DAISY text-only publications (including multiple DTBOOK XML documents in the spine / reading order)

Git revision info:

Git commit history:

Git diff:

1.0.44

Build environment: NodeJS 14.15.0, NPM 6.14.8

Changes:

  • Fixed weird edge case in DAISY books with messed-up XML namespaces

Git revision info:

Git commit history:

Git diff:

1.0.43

Build environment: NodeJS 14.15.0, NPM 6.14.8

Changes:

  • Added support for DAISY publications with multiple DTBOOK XML documents (and multiple SMIL in the spine)

Git revision info:

Git commit history:

Git diff:

1.0.42

Build environment: NodeJS 14.15.0, NPM 6.14.8

Changes:

  • Fixed regression in surface public API

Git revision info:

Git commit history:

Git diff:

1.0.41

Build environment: NodeJS 14.15.0, NPM 6.14.8

Changes:

  • Improved support for DAISY3 audio-text and text-only publications: resilience for missing DocTitle, and lacking XML namespaces
  • Parse and preserve non-supported EPUB and DAISY metadata into JSON in-memory data model

Git revision info:

Git commit history:

Git diff:

1.0.40

Build environment: NodeJS 14.15.0, NPM 6.14.8

Changes:

  • NPM package updates
  • Support for DAISY3 audio-text and text-only publications, by converting to Readium Webpub Manifest (with EPUB3 Media Overlays)

Git revision info:

Git commit history:

Git diff:

1.0.39

Build environment: NodeJS 12.18.2, NPM 6.14.7

Changes:

  • NPM package updates
  • Support for Divina Readium webpub manifest

Git revision info:

Git commit history:

Git diff:

1.0.38

Build environment: NodeJS 12.18.2, NPM 6.14.5

Changes:

  • NPM package updates
  • TypeScript const enum safeguard (isolated modules)

Git revision info:

Git commit history:

Git diff:

1.0.37

Build environment: NodeJS 12.18.1, NPM 6.14.5

Changes:

  • NPM package updates

Git revision info:

Git commit history:

Git diff:

1.0.36

Build environment: NodeJS 12.16.3, NPM 6.14.5

Changes:

  • NPM package updates
  • EPUB Media Overlays / W3C Sync Media alignment

Git revision info:

Git commit history:

Git diff:

1.0.35

Build environment: NodeJS 12.16.1, NPM 6.14.4

Changes:

  • Fixed accessibility metadata: summary is now multilingual string, and access mode sufficient is now de-linearized from comma-separated string (as parsed from EPUB, versus W3C Web Publications which implement the array of string tokens natively)

Git revision info:

Git commit history:

Git diff:

1.0.34

Build environment: NodeJS 12.16.1, NPM 6.14.4

Changes:

  • Fixed crash when opening EPUBs with no Metadata Links (code typo)

Git revision info:

Git commit history:

Git diff:

1.0.33

Build environment: NodeJS 12.16.1, NPM 6.14.4

Changes:

  • Added missing "alternate" property on Link object (latest JSON Schema for Readium Web Pub Manifest). It's just like "children".

Git revision info:

Git commit history:

Git diff:

1.0.32

Build environment: NodeJS 12.16.1, NPM 6.14.4

Changes:

  • Accessibility metadata parsing: convenient helper function for accessModeSufficient, outputs normalized array of array-of-strings format, canonical decomposition with duplicates removal, whitespace elimination, and preserved order after the cleanup pass. See readium/architecture#94 (comment)

Git revision info:

Git commit history:

Git diff:

1.0.31

Build environment: NodeJS 12.16.1, NPM 6.14.4

Changes:

  • Accessibility metadata parsing

Git revision info:

Git commit history:

Git diff:

1.0.30

Build environment: NodeJS 12.16.1, NPM 6.14.4

Changes:

  • NPM package updates
  • Additional file extensions for Readium audiobooks

Git revision info:

Git commit history:

Git diff:

1.0.29

Build environment: NodeJS 12.16.1, NPM 6.14.4

Changes:

  • NPM package updates
  • LCP audiobook support (parsing)
  • Cson2Json build script fix

Git revision info:

Git commit history:

Git diff:

1.0.28

Build environment: NodeJS 12.16.1, NPM 6.14.4

Changes:

  • NPM package updates
  • camel case pageList JSON property with support for legacy page-list
  • fixes incorrect path in zipHasEntry (fallback to raw authored path, potentially percent-escaped), and replaced console.log() with debug().
  • added resource URL to transformer parameter
  • HTML transformer should not contains FXL vs. reflow heuristics (FXL audio/video patch)

Git revision info:

Git commit history:

Git diff:

1.0.27

Build environment: NodeJS 12.16.1, NPM 6.14.3

Changes:

  • NPM package updates
  • EPUB parser: added support for epub:type "roles" when handling links from TOC, landmarks, pagelist, etc.
  • BCP47 language code "und" for unknown locale (metadata contributors/authors, (sub)title)

Git revision info:

Git commit history:

Git diff:

1.0.26

Build environment: NodeJS 12.16.1, NPM 6.13.7

Changes:

  • NPM package updates
  • Fixed bug with decodeURIComponent for link.Href parsing (syntax normalization)

Git revision info:

Git commit history:

Git diff:

1.0.25

Build environment: NodeJS 12.15.0, NPM 6.13.7

Changes:

  • NPM package updates
  • Minor Typescript fixes: typing for XPath Select, and removed rogue "any"
  • Content transformers now pass "session info" semantic-agnostic data (serialized string) so that anonymous HTTP requests can be correlated with specific publications and with their reading session (multiple readers scenario). Also see changes in streamer, and of course navigator.
  • Support for AudioBook parsing, local-packed (zipped), local-exploded (unzipped), and remote-exploded.

Git revision info:

Git commit history:

Git diff:

1.0.24

Build environment: NodeJS 12.13.0, NPM 6.13.0

Changes:

  • NPM package updates
  • TAJSON now parses/generates arbitrary JSON properties with typed object

Git revision info:

Git commit history:

Git diff:

1.0.23

Build environment: NodeJS 12.13.0, NPM 6.12.0

Changes:

  • EPUB parser: improved support for percent-encoded URLs, with ZIP entry filename fallback on errors (edge case handling)

Git revision info:

Git commit history:

Git diff:

1.0.22

Build environment: NodeJS 12.13.0, NPM 6.12.0

Changes:

  • NPM updates

Git revision info:

Git commit history:

Git diff:

1.0.21

Build environment: NodeJS 10.16.3, NPM 6.12.0

Changes:

  • EPUB parser fix: title/etc. language map with full xml:lang support (local element and root OPF package)

Git revision info:

Git commit history:

Git diff:

1.0.20

Build environment: NodeJS 10.16.3, NPM 6.12.0

Changes:

  • EPUB parser fixes: added support for file-as/sort-as in Contributor, added language map support for Subject, added "_" default language fallback for object map that already has metadata refines.

Git revision info:

Git commit history:

Git diff:

1.0.19

Build environment: NodeJS 10.16.3, NPM 6.12.0

Changes:

  • NPM updates (including NodeJS v12 for Electron v6)

Git revision info:

Git commit history:

Git diff:

1.0.18

Build environment: NodeJS 10.16.3, NPM 6.11.3

Changes:

  • NPM updates

Git revision info:

Git commit history:

Git diff:

1.0.17

Build environment: NodeJS 10.16.3, NPM 6.11.3

Changes:

  • NPM updates
  • TypeScript sort imports

Git revision info:

Git commit history:

Git diff:

1.0.16

Build environment: NodeJS 10.16.3, NPM 6.11.3

Changes:

  • NPM updates

Git revision info:

Git commit history:

Git diff:

1.0.15

Build environment: NodeJS 10.16.0, NPM 6.10.2

Changes:

  • support for publications without resources (but with valid spine items, navdoc, etc.)

Git revision info:

Git commit history:

Git diff:

1.0.14

Build environment: NodeJS 10.16.0, NPM 6.10.2

Changes:

  • NPM updates
  • Buffer.from() API to remove deprecation messages

Git revision info:

Git commit history:

Git diff:

1.0.13

Build environment: NodeJS 10.16.0, NPM 6.9.0

Changes:

  • NPM updates (notable: Ava unit tests)

Git revision info:

Git commit history:

Git diff:

1.0.12

Build environment: NodeJS 10.15.3, NPM 6.9.0

Changes:

  • When no page-progression-direction is specified on EPUB spine, check the dc:language to enforce RTL if necessary (matches dir="rtl" injection logic, which occurs on a per-document basis)

Git revision info:

Git commit history:

Git diff:

1.0.11

Build environment: NodeJS 10.15.3, NPM 6.9.0

Changes:

  • NPM updates

Git revision info:

Git commit history:

Git diff:

1.0.10

Build environment: NodeJS 8.15.1, NPM 6.4.1

Changes:

  • NPM updates

Git revision info:

Git commit history:

Git diff:

1.0.9

Build environment: NodeJS 8.15.1, NPM 6.4.1

Changes:

  • Added EPUB subtitle parsing
  • Added string enums for publication metadata
  • Support for iBooks and Kobo display-options EPUB metadata (META-INF XML)
  • Support for Adobe page map
  • Added Locator JSON-Schema references

Git revision info:

Git commit history:

Git diff:

1.0.8

Build environment: NodeJS 8.15.1, NPM 6.4.1

Changes:

  • NPM updates
  • JSON Schema reference updates
  • NodeTS (TypeScript) unit test runner

Git revision info:

Git commit history:

Git diff:

1.0.7

Build environment: NodeJS 8.14.1, NPM 6.4.1

Changes:

  • NPM updates

Git revision info:

Git commit history:

Git diff:

1.0.6

Build environment: NodeJS 8.14.1, NPM 6.4.1

Changes:

  • Reviewed and annotated the data models based on the most current JSON Schema
  • Added fallback mechanism for (de)serialization to/from legacy (since renamed) JSON dictionary keys (e.g. sort_as, belongs_to, direction, spine)
  • Minor NPM updates

Git revision info:

Git commit history:

Git diff:

1.0.5

Build environment: NodeJS 8.14.1, NPM 6.4.1

Changes:

  • Updated documentation (minor)
  • NPM 6.5.* has regression bugs for global package installs, so revert back to NPM 6.4.1 (which is officially shipped with the NodeJS installer).

Git revision info:

Git commit history:

Git diff:

1.0.4

Build environment: NodeJS 8.14.0, NPM 6.5.0

Changes:

  • NPM updates

Git revision info:

Git commit history:

Git diff:

1.0.3

Build environment: NodeJS 8.14.0, NPM 6.5.0

Changes:

  • NPM updates (r2-xxx-js)
  • Support for remote HTTP exploded publications

Git revision info:

Git commit history:

Git diff:

1.0.2

Build environment: NodeJS 8.14.0, NPM 6.5.0

Changes:

  • Fixed EPUB detection and adapted CLI + publication parser (matrix: local vs. remote, exploded vs. packed)
  • NPM updates (minor)
  • Replaced deprecated RawGit URLs
  • Improved Ava unit test setup

Git revision info:

Git commit history:

Git diff:

1.0.1

Build environment: NodeJS 8.14.0, NPM 6.5.0

Changes:

  • Chainable transforms for HTML now configurable via constructor (function pointer)
  • Minor import aliases change

Git revision info:

Git commit history:

Git diff:

1.0.0

Build environment: NodeJS 8.14.0, NPM 6.5.0

Changes:

  • EPUB - ReadiumWebPubManifest converter CLI (demo)
  • Chainable transforms (content filters)
  • Sample HTML transform (will evolve into ReadiumCSS injector for navigator)
  • Locator model
  • NPM updates (minor)
  • README info
  • VisualStudio code tweaks (developer workflow)
  • Semantic versioning bump 1.. (3-digit style now, "-alphaX" suffix caused issues with NPM tooling: updates, lockfile, etc.)

Git revision info:

Git commit history:

Git diff:

1.0.0-alpha.6

Build environment: NodeJS 8.12.0, NPM 6.4.1

Changes:

  • NPM updates (minor)
  • Git revision JSON info now includes NodeJS and NPM version (build environment)

Git revision info:

Git commit history:

Git diff:

1.0.0-alpha.5

Changes:

  • Dependency "ta-json" GitHub semver dependency becomes "ta-json-x" NPM package (fixes readium/r2-testapp-js#10 )
  • Removed TypeScript linter warning message (checks for no unused variables)
  • NPM updates related to the Node TypeScript typings

Git revision info:

Git commit history:

Git diff:

1.0.0-alpha.4

Changes:

  • NPM updates (external deps)

Git revision info:

Git commit history:

Git diff:

1.0.0-alpha.3

Changes:

  • correct version in package-lock.json

Git revision info:

Git commit history:

Git diff:

1.0.0-alpha.2

Changes (NPM updates):

  • @types/node
  • r2-utils-js
  • r2-lcp-js

Git revision info:

Git commit history:

Git diff:

1.0.0-alpha.1

Changes:

  • initial NPM publish

Git revision info:

Git commit history:

Git diff:

  • initial NPM publish