Skip to content

Latest commit

 

History

History
3224 lines (2170 loc) · 106 KB

CHANGELOG.md

File metadata and controls

3224 lines (2170 loc) · 106 KB
Raw

Next

Git diff:

Changes:

  • TODO

1.16.3

> Build environment: NodeJS 20.17.0, NPM 10.8.3

Changes:

  • Updated the technique used to append a blank pagination column after an odd (non even) number of columns when 2-page spreads are rendered (this removes the complex viewport shifting transform)
  • Disabled the visibility mask technique which never delivered satisfactory results
  • Replaced the buggy (Chromium) pure CSS computation of high-contrast foreground colour over highlighted text background (fixed TTS, annotations, search, etc.) with a simpler luminance-based calculation

Git revision info:

Git commit history:

Git diff:

1.16.2

> Build environment: NodeJS 20.17.0, NPM 10.8.3

Changes:

  • Fixed text finger selection which now triggers notification of current reading location (mouse / trackpad cursor and stylus worked fine, but touchscreen interactions were failing)
  • Fixed the inversed finger touch swipe direction (horizontal axis RTL / LTR)
  • NPM package updates

Git revision info:

Git commit history:

Git diff:

1.16.1

> Build environment: NodeJS 20.17.0, NPM 10.8.3

Changes:

  • LocatorExtended followingElementIDs only for Media Overlays and with length limit to avoid spamming the reading location notifications with useless heavy data (also fixed in Thorium)

Git revision info:

Git commit history:

Git diff:

1.16.0

> Build environment: NodeJS 20.17.0, NPM 10.8.3

Changes:

  • NPM package updates, notably Electron v32
  • CSS Highlights API for solid background, underline and strikethrough (retains SVG polygons for hit-testing and hover outline interactions, including margin display, but the CSS Highlights API controls text foreground/background contrast in the case of solid background, note that outline style remains entirely based on SVG)
  • Fixed CSS column pagination edge case: when column count is 2 but because of column width in Readium CSS in fact a single column is displayed (for example when shrinking the window or increasing the font size, the bug is immediately observable when displaying annotation highlights)

Git revision info:

Git commit history:

Git diff:

1.15.10

> Build environment: NodeJS 20.12.2, NPM 10.8.1

Changes:

  • fix: ReadiumCSS override was aggressively affecting GUI chrome injected in documents (generic div styling)
  • fix: keyboard focus handling (notably, ReadiumCSS setter was restoring reading location with focus steal)

Git revision info:

Git commit history:

Git diff:

1.15.9

> Build environment: NodeJS 20.12.2, NPM 10.8.1

Changes:

  • fix: steal focus disabled boolean, code guard for global function call when navigator is not instantiated yet (e.g. Thorium Divina and PDF)
  • fix: Japanese font stack (see ReadiumCSS readium/readium-css#146)

Git revision info:

Git commit history:

Git diff:

1.15.8

> Build environment: NodeJS 20.12.2, NPM 10.7.0

Changes:

  • Footnotes backlinks are now hidden
  • Fixed incorrect default content margins

Git revision info:

Git commit history:

Git diff:

1.15.7

> Build environment: NodeJS 20.12.2, NPM 10.7.0

Changes:

  • Added API function to disable (and re-enable if necessary) focus steal when publication documents are hyperlinked into (webview / iframe keyboard grab)
  • Fixed highlights engine: default drawtype is background, CSS mix blend mode now works in dark mode

Git revision info:

Git commit history:

Git diff:

1.15.6

> Build environment: NodeJS 20.12.2, NPM 10.7.0

Changes:

  • NPM package updates, Electron 30
  • Added ReadiumCSS custom selection and link colors (theme handling)

Git revision info:

Git commit history:

Git diff:

1.15.5

> Build environment: NodeJS 20.12.0, NPM 10.5.0

Changes:

  • NPM package updates, breaking change in the polygon lib (API getters)

Git revision info:

Git commit history:

Git diff:

1.15.4

> Build environment: NodeJS 20.11.0, NPM 10.4.0

Changes:

  • New option to disable / hide Japanese Ruby superscript text

Git revision info:

Git commit history:

Git diff:

1.15.3

> Build environment: NodeJS 20.11.0, NPM 10.4.0

Changes:

  • TTS readaloud fix: Japanese Ruby superscript RT/RP must not be highlighted (orange underline forbidden, yellow background ok). This logic generally applies to annotation highlights too (when not solid background or outline, i.e. underline and strikethrough), but as this is currently an early prototype preview in Thorium we label this change as mostly a TTS fix.

Git revision info:

Git commit history:

Git diff:

1.15.2

> Build environment: NodeJS 20.11.0, NPM 10.4.0

Changes:

  • Improved the prototype EPUB3 Media Overlays sign language video player by allowing the user to detach the video frame overlay into its own system window (simply by clicking on it), which can then be moved and resized outside of Thorium's own window bounds.

Git revision info:

Git commit history:

Git diff:

1.15.1

> Build environment: NodeJS 20.11.0, NPM 10.4.0

Changes:

  • Added prototype MVP EPUB3 Media Overlays video player (simple draggable overlay, not separate window)

Git revision info:

Git commit history:

Git diff:

1.15.0

> Build environment: NodeJS 20.11.0, NPM 10.4.0

Changes:

  • WBR Word Break Opportunity for Japanese text, alternative to word-space-transform:ideographic-space CSS, using custom DOM element instead so word-space CSS property can be used as normal from ReadiumCSS
  • NPM package updates (Electron29 + Node20)

Git revision info:

Git commit history:

Git diff:

1.14.19

> Build environment: NodeJS 20.11.0, NPM 10.4.0

Changes:

  • Japanese: enable CSS letter-spacing (override ReadiumCSS recommendation), TTS readaloud Ruby RT/RP are now both ignored
  • CSS Selectors (reading location, bookmarks, etc.) now handle SVG and MathML namespace-prefixed element names

Git revision info:

Git commit history:

Git diff:

1.14.18

> Build environment: NodeJS 20.11.0, NPM 10.4.0

Changes:

  • Highlights / visual annotations rendering engine: now with outline/border decoration (other drawing types are: solid/block/background, underline, strikethrough/crossed-over)

Git revision info:

Git commit history:

Git diff:

1.14.17

> Build environment: NodeJS 20.11.0, NPM 10.4.0

Changes:

  • Adds support for character-level bookmarking / reading location, prevents page jumps in paginated mode when referencing a partially-visible DOM element at the beginning of the page spread (fixes search results highlights, and annotations too).

Git revision info:

Git commit history:

Git diff:

1.14.16

> Build environment: NodeJS 20.11.0, NPM 10.4.0

Changes:

  • Fixes highlights rendering engine, line-dependent decorations (underline, strikethrough)

Git revision info:

Git commit history:

Git diff:

1.14.15

> Build environment: NodeJS 20.11.0, NPM 10.4.0

Changes:

  • Highlights rendering engine fixes and optimisations: polygon holes and bounding boxes in margin indicators

Git revision info:

Git commit history:

Git diff:

1.14.14

> Build environment: NodeJS 20.11.0, NPM 10.4.0

Changes:

  • Highlights rendering engine fixes: outline stroke was redundant, opacity was inconsistent

Git revision info:

Git commit history:

Git diff:

1.14.13

> Build environment: NodeJS 20.11.0, NPM 10.4.0

Changes:

  • SVG rendering in the highlights engine to work around performance issues and problems with annotations crossing over page boundaries (bounding boxes).

Git revision info:

Git commit history:

Git diff:

1.14.12

> Build environment: NodeJS 20.11.0, NPM 10.4.0

Changes:

  • TTS readaloud fix: now previous/next commands move to the respective preceding/following documents (only auto play was moving to the next spine item)
  • Numerous performance improvements and bugfixes in the highlights engine

Git revision info:

Git commit history:

Git diff:

1.14.11

> Build environment: NodeJS 20.11.0, NPM 10.4.0

Changes:

  • TTS readloud in SVG (PDF-like) fixed-layout pages, based on inner 'text' elements (excluding 'tspan' fragmentation which breaks words and sentences), also fixed concurrent highlights rendering.
  • Highlights (e.g. search results) display correctly in fixed layout and reflowable hybrid publications, also fixed window resizing bug, also ensure highlights are backed-up and restored during webview refresh that does not involve the application's own state.

Git revision info:

Git commit history:

Git diff:

1.14.10

Build environment: NodeJS 20.10.0, NPM 10.2.5

Changes:

  • Fixed regression: goto progression percentage (click on Thorium's bottom bar) was broken due to async location.href hash # set and scroll reset
  • Fixed TTS readaloud dark / night mode highlights
  • Fixed TTS whitespace handling (offset highlights)
  • Improved TTS performance by passing native DOM Ranges to the highlighing engine instead of serialised format
  • Fixed collapsible highlight handling (should not affect TTS's own highlights, which are not tactile / interactive)

Git revision info:

Git commit history:

Git diff:

1.14.9

Build environment: NodeJS 20.10.0, NPM 10.2.5

Changes:

  • TTS readaloud improvement: click-on-text now plays instantly instead of pausing and expecting the user to click a second time to resume
  • TTS readaloud fix: significant whitespace handling, space between span elements sometimes wasn't preserved (mostly visible in the captions/simple view, but also underlying utterances sent to TTS engine)

Git revision info:

Git commit history:

Git diff:

1.14.8

Build environment: NodeJS 20.10.0, NPM 10.2.5

Changes:

  • Improved highlights rendering engine: better performance (CSS class factorisation), better UX (less flickering, more visual contrast, mouse cursors for "proactive feedback" to announce the interactive lightweight affordances)

Git revision info:

Git commit history:

Git diff:

1.14.7

Build environment: NodeJS 20.10.0, NPM 10.2.5

Changes:

  • Fix (minor): TTS readaloud focus/scroll-into-view throttled function incorrectly queued the arguments

Git revision info:

Git commit history:

Git diff:

1.14.6

Build environment: NodeJS 20.10.0, NPM 10.2.5

Changes:

  • Fix: ReadiumCSS body width/height extent bugs (background colour was cropped)
  • Fix: avoid scroll jump when navigating inside already loaded page
  • Added highlights margin indicators (alt click to trigger, but will be controlled via app in future updates, to implement a proper affordance model with special behaviour associated with collapsed margin highlights)

Git revision info:

Git commit history:

Git diff:

1.14.5

Build environment: NodeJS 20.10.0, NPM 10.2.5

Changes:

  • Right To Left fixes, mostly for mixed document directions in spine, and inconsistent direction between script and vertical writing mode (EPUB has package-level page-progression-direction in addition to document-level possible ways to declare direction, HTML attributes and CSS styles)

Git revision info:

Git commit history:

Git diff:

1.14.4

Build environment: NodeJS 20.10.0, NPM 10.2.5

Changes:

  • Fixed hyperlinks handling during TTS and Media Overlays
  • Fixed pagination visibility regression bug introduced in previous release

Git revision info:

Git commit history:

Git diff:

1.14.3

Build environment: NodeJS 20.10.0, NPM 10.2.5

Changes:

  • Fixed TTS and Media Overlays scrolling content / bad UX (also applies to text-only rendering). Now minimised viewport shifts and more reliable discovery of reading location (virtual click pointer into DOM "beginning" of visible viewport).

Git revision info:

Git commit history:

Git diff:

1.14.2

Build environment: NodeJS 20.10.0, NPM 10.2.5

Changes:

  • Fixed Right To Left "current reading location" calculation (virtual click in corner without user interaction)
  • Fixed TTS bugs (pausing without resuming when turning pages)

Git revision info:

Git commit history:

Git diff:

1.14.1

Build environment: NodeJS 20.10.0, NPM 10.2.5

Changes:

  • Much improved support for Japanese Vertical Writing Mode and Right To Left direction
  • Fixed Media Overlays and TTS readaloud edge case bugs (failure to play or jumping back to begining) related to images without text, excluded elements like Ruby RT, unsynchronised text fragments, etc.

Git revision info:

Git commit history:

Git diff:

1.14.0

Build environment: NodeJS 20.10.0, NPM 10.2.5

Changes:

  • NPM package updates

Git revision info:

Git commit history:

Git diff:

1.13.9

Build environment: NodeJS 18.17.0, NPM 9.8.1

Changes:

  • TTS readaloud now supports "skippability" (like EPUB3 Media Overlays), typically page breaks identified by epub:type or ARIA role
  • NPM package updates

Git revision info:

Git commit history:

Git diff:

1.13.8

Build environment: NodeJS 18.17.0, NPM 9.8.1

Changes:

  • fix: handle role attribute as well as epub:type (just in case the latter is ommitted)
  • TTS fixes / features: aria-label on img in addition to alt attribute, epub:type pagebreak (and role) title/label takes precedence over inner text, same with links, japanese ruby RT are ignored
  • fix: Media Overlays interact click on images or text without sync media now continues playback at current timestamp instead of resuming from begining
  • fix: ensure image zoom outline is deactivated when entering media overlay or TTS playback
  • fix: tabbable CJS import was broken!
  • fix: image zoom UI chrome controls now match colour scheme + fixed-size (like main GUI)
  • chore: switch to updated CSS selector lib (better performance)
  • updated NPM packages

Git revision info:

Git commit history:

Git diff:

1.13.7

Build environment: NodeJS 18.17.0, NPM 9.8.1

Changes:

  • fix: popup dialog GUI (footnotes, image zoom, TTS + Media Overlays "captions" mode) forced to horizontal writing mode for chrome controls
  • fix: TTS pause from click-on-text now syncs properly (state was incorrectly STOPPED instead of PAUSE)
  • fix: TTS playback engine / state machine now handles hyperlinks and image zoom click properly
  • updated NPM packages

Git revision info:

Git commit history:

Git diff:

1.13.6

Build environment: NodeJS 18.16.1, NPM 9.8.0

Changes:

  • Image zoom feature: support for SVG markup island (foreign HTML5 namespace), which like fixed layout and images-inside-link require SHIFT key modifier to avoid interfering with authored hyperlinking or interactives.

Git revision info:

Git commit history:

Git diff:

1.13.5

Build environment: NodeJS 18.16.1, NPM 9.8.0

Changes:

  • Improved image zoom feature: in addition to HTML img@src (possibly SVG file instead of raster/bitmap) now SVG image@xlink:href too (if nested inside link, same logic as HTML a@href with shift-click modifier to bypass hyperlink activation)

Git revision info:

Git commit history:

Git diff:

1.13.4

Build environment: NodeJS 18.16.1, NPM 9.8.0

Changes:

  • Feature: image zoom with mouse wheel, trackpad and touch gestures (pinch stretch), panning, keyboard support
  • Feature: finger touch swipe gesture to turn pages / navigate left/right in book contents
  • Fix: in DEV mode, web inspector context menu was registering multiple times
  • Fix: mouse wheel middle click was opening Electron browser window
  • Fix: Electron now stricter with uncaught exceptions / rejected promises across IPC messaging system, must code fence properly for webview dom-ready state

Git revision info:

Git commit history:

Git diff:

1.13.3

Build environment: NodeJS 18.16.1, NPM 9.8.0

Changes:

  • Fix: audio playback rate HTML select > option dark/night mode was white-on-white background+foreground colours
  • Fix: hyperlink activation now causes a recording in navigation history of the origination without triggering an actual navigation (only activates the link into the destination, not the source)
  • Fix: ReadiumCSS text alignment inherit did not work in some cases, must be forced on body not just HTML root

Git revision info:

Git commit history:

Git diff:

1.13.2

Build environment: NodeJS 18.16.0, NPM 9.8.0

Changes:

  • HOTFIX (for the previous hotfix!): postinstall script runs in embedding context, fails to patch offending node_module lib

Git revision info:

Git commit history:

Git diff:

1.13.1

Build environment: NodeJS 18.16.0, NPM 9.8.0

Changes:

  • HOTFIX: ReadiumCSS was not copied into NPM published dist folder

Git revision info:

Git commit history:

Git diff:

1.13.0

Build environment: NodeJS 18.16.0, NPM 9.8.0

Changes:

  • NPM package updates (Electron 25)

Git revision info:

Git commit history:

Git diff:

1.12.4

Build environment: NodeJS 18.16.0, NPM 9.6.5

Changes:

  • NPM package updates
  • Fix: when SVG a@href animVal doesn't resolve to full absolute URL we explicitly prefix the # hash fragment identifier with the document location

Git revision info:

Git commit history:

Git diff:

1.12.3

Build environment: NodeJS 18.15.0, NPM 9.6.1

Changes:

  • NPM package updates
  • Fix: mouse cursor double-click on trailing edge of debounce (instead of leading / immediate) in order to correctly capture user selection (for bookmarks and annotations)

Git revision info:

Git commit history:

Git diff:

1.12.2

Build environment: NodeJS 18.14.2, NPM 9.5.1

Changes:

  • Fix: TTS voice selected is user-forced unless strict and loose language mismatch (allows variants override like en-US vs. en-UK, user wins over authored lang)

Git revision info:

Git commit history:

Git diff:

1.12.1

Build environment: NodeJS 18.14.2, NPM 9.5.1

Changes:

  • NPM package updates
  • Fix: TTS caption/simple mode was not escaping ampersand characters on initial render (before word boundaries)
  • Fix: HTML5 audio controls with authored percentage dimensions were invisible, now using revert!important to not only override ReadiumCSS, but also authored dimensions

Git revision info:

Git commit history:

Git diff:

1.12.0

Build environment: NodeJS 18.14.2, NPM 9.5.1

Changes:

  • Electron major version update (22 -> 23)
  • Feat: support for before/previous text in highlighted / selected DOM range (as always, cleaned-up text is with collapsed whitespace, raw is as authored including line breaks, tabulations, etc.)

Git revision info:

Git commit history:

Git diff:

1.11.6

Build environment: NodeJS 18.12.1, NPM 9.1.2

Changes:

  • Fix: EPUB FXL Fixed-Layout pre-paginated publications can now render with single centered pages (override from authored spread rules, when aspect ratio is portrait instead of landscape)

Git revision info:

Git commit history:

Git diff:

1.11.5

Build environment: NodeJS 18.12.1, NPM 9.1.2

Changes:

  • Fix: pagebreak (role or epub:type) in EPUB HTML documents can have empty text, to be correlated later with authored pagelist in navigation document (if any) via the target element ID (if any). Also take into account first available page break in HTML markup that does not have significant preceding text, when no specific text cursor is placed in chapter yet.

Git revision info:

Git commit history:

Git diff:

1.11.4

Build environment: NodeJS 18.12.1, NPM 9.1.1

Changes:

  • Fixed Electron webview session partition handling (protocol handler can be default unamed)

Git revision info:

Git commit history:

Git diff:

1.11.3

Build environment: NodeJS 18.12.1, NPM 9.1.1

Changes:

  • NPM package updates
  • CSS fix for Chromium regression (broken overflow hidden/clip style, column pagination)

Git revision info:

Git commit history:

Git diff:

1.11.2

Build environment: NodeJS 16.17.0, NPM 8.19.1

Changes:

  • feature: internal document link handling now via IPC renderer process event emitter (local) so it can be intercepted for external additional logic (e.g. history state)

Git revision info:

Git commit history:

Git diff:

1.11.1

Build environment: NodeJS 16.15.0, NPM 8.10.0

Changes:

  • fix: aside footnotes were not hidden
  • fix: keyboard focus inside webview was causing scroll reset

Git revision info:

Git commit history:

Git diff:

1.11.0

Build environment: NodeJS 16.15.0, NPM 8.10.0

Changes:

  • Updated NPM packages, notably Electron v19
  • Bugfix for CSS regression in Chromium v102 (flex / flow-root reset breaking CSS columns layout)
  • Improved previous fix for CSS height:inherit, now using min-height in column pagination to allow full extent, but retain previous strategy in scrolling mode.

Git revision info:

Git commit history:

Git diff:

1.10.2

Build environment: NodeJS 16.15.0, NPM 8.9.0

Changes:

  • Improved fix for CSS body position:relative with height:inherit (paginated and scrolling views, excluding fixed layout)

Git revision info:

Git commit history:

Git diff:

1.10.1

Build environment: NodeJS 16.15.0, NPM 8.9.0

Changes:

  • NPM package updates
  • Fix CSS body position:relative with height:inherit

Git revision info:

Git commit history:

Git diff:

1.10.0

Build environment: NodeJS 16.14.2, NPM 8.5.5

Changes:

  • NPM package updates (including Electron 18)
  • Fix Readium CSS -webkit-perspective stacking context hack (CSS column layout performance)
  • Attempted fix for Electron window.localStorage regression (partition session)

Git revision info:

Git commit history:

Git diff:

1.9.14

Build environment: NodeJS 16.14.0, NPM 8.5.2

Changes:

Git revision info:

Git commit history:

Git diff:

1.9.13

Build environment: NodeJS 16.13.1, NPM 8.3.0

Changes:

  • NPM package updates
  • Workaround for ReadiumCSS audio width/height bug
  • Feature to popout images into full document viewport (SHIFT CLICK to initiate, and to zoom in further, ESC or CLICK to return to normal publication view)

Git revision info:

Git commit history:

Git diff:

1.9.12

Build environment: NodeJS 16.13.1, NPM 8.3.0

Changes:

  • NPM package updates

Git revision info:

Git commit history:

Git diff:

1.9.11

Build environment: NodeJS 16.13.1, NPM 8.3.0

Changes:

  • Screen reader support: fix for hyperlink activation which causes mouse interaction depending on which keyboard shortcut is used to trigger the link (regular Enter keystroke vs. control-option-space in VoiceOver, for example)

Git revision info:

Git commit history:

Git diff:

1.9.10

Build environment: NodeJS 16.13.1, NPM 8.3.0

Changes:

  • EPUB popup footnotes: fixed modal popup dialog positioning (bottom-aligned), fixed auto-hiding (only hide footnotes when they are referenced AND presented in the same document), added support for external popup footnotes (other HTML publication document)

Git revision info:

Git commit history:

Git diff:

1.9.9

Build environment: NodeJS 16.13.1, NPM 8.3.0

Changes:

  • Fix: headings trail leading to current reading location now supports missing ID by looking up to nearest linkable containing ancestor (common HTML authoring pattern: headings without ID have linkable section parent)

Git revision info:

Git commit history:

Git diff:

1.9.8

Build environment: NodeJS 16.13.1, NPM 8.3.0

Changes:

  • NPM package updates
  • Feature: headings trail leading to current reading location (similar to contextual EPUB page break reporting via locator extended event payload)

Git revision info:

Git commit history:

Git diff:

1.9.7

Build environment: NodeJS 16.13.1, NPM 8.3.0

Changes:

  • NPM package updates
  • Synthetic speech TTS readaloud improvements: skip "hidden" DOM fragments, handle deep MathML click-and-play, hit-test image x,y coordinates, ignore underscore special link in caption/simple view

Git revision info:

Git commit history:

Git diff:

1.9.6

Build environment: NodeJS 16.13.1, NPM 8.3.0

Changes:

  • NPM package updates
  • Fixed keyboard focus management in content webview, works with screen readers (accessible UI / UX tested with VoiceOver on MacOS), TOC, landmarks, bookmarks, page numbers, search matches

Git revision info:

Git commit history:

Git diff:

1.9.5

Build environment: NodeJS 16.13.1, NPM 8.2.0

Changes:

  • Fixed epub:type and role (doc)-pagebreak attributes XPath, now performing a union / pipe on separate matches ("or" combinator inside the single / combined assertion predicate was breaking on first match)

Git revision info:

Git commit history:

Git diff:

1.9.4

Build environment: NodeJS 16.13.1, NPM 8.2.0

Changes:

  • NPM package updates
  • TTS support for MathML (without MathJax) via alttext attribute or fallback to element textual contents

Git revision info:

Git commit history:

Git diff:

1.9.3

Build environment: NodeJS 16.13.0, NPM 8.1.4

Changes:

  • NPM package updates
  • TTS support for MathJax / MathML
  • TTS highlight of images / SVG etc. (when alt text source not children textnodes)

Git revision info:

Git commit history:

Git diff:

1.9.2

Build environment: NodeJS 16.13.0, NPM 8.1.4

Changes:

  • NPM package updates
  • NodeJS 16 + NPM 8
  • Electron 16
  • ESLINT (was TSLINT)
  • Improved EPUB Media Overlays playback when no audio (skip fragment, was stalling)
  • Fixed highlights CSS reset (styles leak from host document)

Git revision info:

Git commit history:

Git diff:

1.9.1

Build environment: NodeJS 14.18.1, NPM 6.14.15

Changes:

  • NPM package updates
  • Fixed Layout zoom factor now CSS transform scale on HTML root element, not enclosing WebView (to avoid raster pixelisation, now crisp text vector graphics / font magnification)

Git revision info:

Git commit history:

Git diff:

1.9.0

Build environment: NodeJS 14.18.1, NPM 6.14.15

Changes:

  • Electron v15 (NodeJS v16)

Git revision info:

Git commit history:

Git diff:

1.8.7

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.8.6

Build environment: NodeJS 14.17.5, NPM 6.14.15

Changes:

  • NPM package updates
  • Fixed edge-case with body CSS overflow:hidden (column pagination was broken with some combination of line heights + typeface + font size) See edrlab/thorium-reader#1535

Git revision info:

Git commit history:

Git diff:

1.8.5

Build environment: NodeJS 14.17.5, NPM 6.14.14

Changes:

  • Electron v14

Git revision info:

Git commit history:

Git diff:

1.8.4

Build environment: NodeJS 14.17.5, NPM 6.14.14

Changes:

  • Fixed-layout zoom improved, now with arbitrary scaling (not just "fit into viewport")

Git revision info:

Git commit history:

Git diff:

1.8.3

Build environment: NodeJS 14.17.5, NPM 6.14.14

Changes:

  • NPM package updates
  • Fixed-layout documents now scaled and translated (CSS transform) on the webview container instead of the root HTML element within
  • Fix: handling of special custom URL protocol used to simulate HTTPs (pure Electron streamer, no HTTP / Express server)

Git revision info:

Git commit history:

Git diff:

1.8.2

Build environment: NodeJS 14.17.5, NPM 6.14.14

Changes:

  • NPM package updates
  • ReadiumCSS "default" zero values for spacing of words, paragraphs, line height, etc. ("publisher defaults")

Git revision info:

Git commit history:

Git diff:

1.8.1

Build environment: NodeJS 14.17.5, NPM 6.14.14

Changes:

  • NPM package updates
  • Scroll previous/next spine item with mouse wheel and touch pad (including kinetic two-finger flick gesture)

Git revision info:

Git commit history:

Git diff:

1.8.0

Build environment: NodeJS 14.17.5, NPM 6.14.14

Changes:

  • Electron v13
  • Programmatic hyperlinks (InDesign style): "will-navigate" event intercept now works where no-HTTP streamer is used (in which case there is no HTML base transform)
  • Fixed-layout workaround: CSS 2D transform (scale + translate) bleeds body background color, this is prevented using a transparent image on HTML root element
  • Check that webview is still mounted after the async timeout (show/hide content mask IPC event)

Git revision info:

Git commit history:

Git diff:

1.7.4

Build environment: NodeJS 14.17.0, NPM 6.14.13

Changes:

  • automatically hide mouse cursor during inactivity (mouse move event detection, 1 second time window)

Git revision info:

Git commit history:

Git diff:

1.7.3

Build environment: NodeJS 14.17.0, NPM 6.14.13

Changes:

  • NPM updates
  • TTS sentence detection enable/disable
  • TTS skip sentence previous/next
  • SVG aria-label and title parse + render in captions/simplified view

Git revision info:

Git commit history:

Git diff:

1.7.2

Build environment: NodeJS 14.17.0, NPM 6.14.13

Changes:

Git revision info:

Git commit history:

Git diff:

1.7.1

Build environment: NodeJS 14.16.1, NPM 6.14.13

Changes:

  • NPM updates

Git revision info:

Git commit history:

Git diff:

1.7.0

Build environment: NodeJS 14.16.0, NPM 6.14.12

Changes:

  • TTS voice selection (override from default for language auto-detection)

Git revision info:

Git commit history:

Git diff:

1.6.0

Build environment: NodeJS 14.15.4, NPM 6.14.11

Changes:

  • Major NPM package update: Electron v11

Git revision info:

Git commit history:

Git diff:

1.5.3

Build environment: NodeJS 14.15.4, NPM 6.14.11

Changes:

  • NPM package updates
  • Removed dependency on remote Electron module (context menu and accessibility / screen reader detection)

Git revision info:

Git commit history:

Git diff:

1.5.2

Build environment: NodeJS 14.15.0, NPM 6.14.8

Changes:

  • NPM package updates
  • Fixed skippable page numbers edge case in Media Overlays SMIL playback

Git revision info:

Git commit history:

Git diff:

1.5.1

Build environment: NodeJS 14.15.0, NPM 6.14.8

Changes:

  • NPM package updates
  • Fixed popup footnotes, now checks that content is in current document
  • Fixed hyperlinking :target CSS style (DOM state during navigation)

Git revision info:

Git commit history:

Git diff:

1.5.0

Build environment: NodeJS 12.18.2, NPM 6.14.7

Changes:

  • NPM package updates, Electron 9

Git revision info:

Git commit history:

Git diff:

1.4.12

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.4.11

Build environment: NodeJS 12.18.1, NPM 6.14.5

Changes:

  • Linking to CSS Selector element now supports "inner" bounding client rectangle for scroll-into-view of highlighted text range (annotations, search results, etc.)

Git revision info:

Git commit history:

Git diff:

1.4.10

Build environment: NodeJS 12.18.1, NPM 6.14.5

Changes:

  • Fixed TTS readaloud issues: paginated doc with odd number of columns, last page of spread is left-aligned, but TTS playback and highlight was unshifting the page spread. Also fixed: when large sections of text are single HTML element => scroll-into-view did not show current sentence / work highlight.

Git revision info:

Git commit history:

Git diff:

1.4.9

Build environment: NodeJS 12.18.1, NPM 6.14.5

Changes:

  • Fixed Media Overlays and TTS readaloud bugs (page turning, playback resume, play/pause state)

Git revision info:

Git commit history:

Git diff:

1.4.8

Build environment: NodeJS 12.18.1, NPM 6.14.5

Changes:

  • Improved CSS pixel tolerance for Windows "page turn" edge case

Git revision info:

Git commit history:

Git diff:

1.4.7

Build environment: NodeJS 12.18.1, NPM 6.14.5

Changes:

  • NPM package updates
  • CSS pixel tolerance for Windows "page turn" edge case

Git revision info:

Git commit history:

Git diff:

1.4.6

Build environment: NodeJS 12.18.0, NPM 6.14.5

Changes:

  • Audiobooks with no cover image were crashing
  • Minor NPM package updates

Git revision info:

Git commit history:

Git diff:

1.4.5

Build environment: NodeJS 12.18.0, NPM 6.14.5

Changes:

Git revision info:

Git commit history:

Git diff:

1.4.4

Build environment: NodeJS 12.16.3, NPM 6.14.5

Changes:

  • TTS readaloud new mode: in-document highlighting, with smooth scroll-into-view, word-by-word underline emphasis during playback, and sentence-level navigation granularity (i.e. individual atomic TTS utterances), created from larger paragraph blocks of text. TTS utterances can be clicked to start playback (hit testing based on fragmented strings of characters / DOM ranges).
  • TTS readaloud simplified "overlay" view is now opt-in, default is in-document highlighting.

Git revision info:

Git commit history:

Git diff:

1.4.3

Build environment: NodeJS 12.16.3, NPM 6.14.5

Changes:

  • Fixed bug which prevented resources from loading, when URL path starts with any first characters of "/manifest.json" (incorrect URL resolution routine, bad character offset calculation, erroneous common root string)

Git revision info:

Git commit history:

Git diff:

1.4.2

Build environment: NodeJS 12.16.3, NPM 6.14.5

Changes:

  • EPUB3 Media Overlays / sync-media: "caption style" view switch does not automatically trigger pause/resume.

Git revision info:

Git commit history:

Git diff:

1.4.1

Build environment: NodeJS 12.16.2, NPM 6.14.4

Changes:

  • NPM package updates.
  • EPUB3 Media Overlays / sync-media: new "caption style" view.
  • TTS readaloud: improved presentation styles for sepia, night and normal modes.
  • TTS readaloud: new features, emphasis on heading levels, and inline display of images with "alt" attribute.
  • Annotations / highlights: vastly improved rendering performance (DocumentFragment to build DOM, then batch-append highlights "layer" into actual document, also better mouse interaction / hover detection).
  • Annotation / highlights: display improvement, using "mix blend mode" with opacity, yield better text legibility.
  • Annotation / highlights: SVG and HTML renderers now default to "background" drawing style, with "underline" / "strikethrough" optional choices (was hard-coded before, now in API).

Git revision info:

Git commit history:

Git diff:

1.4.0

Build environment: NodeJS 12.16.2, NPM 6.14.4

Changes:

  • NPM package updates
  • Support for fixed-layout / FXL two-page spread in EPUB publications, works for Media Overlays synchronized text/audio playback, concurrent reading locations depending on "active" focused page, selection / highlights, etc. (TTS readloud is currently not polished in two-page mode, needs to be mutually-exclusive per page)
  • Fixed Media Overlays night and sepia highlights
  • Fixed SVG xlink:href relative URL handling
  • Disabled FXL scroll during element focusing (mouse, keyboard interactions)
  • Workaround for fixed layout documents that do not size the body correctly (force width + height dimensions)
  • Visibility mask improved for fixed layout documents (smooth fade effect)

Git revision info:

Git commit history:

Git diff:

1.3.2

Build environment: NodeJS 12.16.2, NPM 6.14.4

Changes:

  • EPUB Media Overlays skippables fix

Git revision info:

Git commit history:

Git diff:

1.3.1

Build environment: NodeJS 12.16.2, NPM 6.14.4

Changes:

  • EPUB Media Overlays / W3C Sync Media playback rate needed reset across audio files switch

Git revision info:

Git commit history:

Git diff:

1.3.0

Build environment: NodeJS 12.16.2, NPM 6.14.4

Changes:

  • NPM updates
  • EPUB Media Overlays / W3C Sync Media playback
  • Highlights fixes in scroll mode (incorrect visual offsets due to CSS margins)
  • Fixed focus / refresh bugs in scroll and paginated views (sync of reading location)
  • Crushed a fixed layout scroll bug

Git revision info:

Git commit history:

Git diff:

1.2.0

Build environment: NodeJS 12.16.2, NPM 6.14.4

Changes:

  • NPM updates
  • TTS read aloud UI improvements (active utterance presentation, smooth scroll), added speech rate control API
  • disabled "will-quit" Electron app event handler for clearSessions()

Git revision info:

Git commit history:

Git diff:

1.1.57

Build environment: NodeJS 12.16.2, NPM 6.14.4

Changes:

  • NPM updates
  • Fix: XML namespaces in popup footnotes (e.g. epub:type attributes, MathML elements)

Git revision info:

Git commit history:

Git diff:

1.1.56

Build environment: NodeJS 12.16.2, NPM 6.14.4

Changes:

  • NPM updates
  • Audiobooks: improved progress slider timeline (input type range)

Git revision info:

Git commit history:

Git diff:

1.1.55

Build environment: NodeJS 12.16.1, NPM 6.14.4

Changes:

  • NPM updates
  • Audiobooks: skip title when non-existent
  • Correct license.lcpl path for LCP injection in EPUB and Readium audiobooks

Git revision info:

Git commit history:

Git diff:

1.1.54

Build environment: NodeJS 12.16.1, NPM 6.14.4

Changes:

  • NPM updates (minor, including Electron)
  • Fixed CSON-2-JSON build script
  • audiobook player improvements: SVG icons, time indicators, placeholders for localization (translatable titles), cover image play/pause button now reacts on mouse up event and only for left mouse button click (otherwise interferes with right click for context menu), added rate speed control

Git revision info:

Git commit history:

Git diff:

1.1.53

Build environment: NodeJS 12.16.1, NPM 6.14.4

Changes:

  • NPM updates (minor)
  • Fixed 'will-navigate' infinite loop introduced by HTML injection of <base href="HTTP_URL" />
  • ReadiumCSS is not applied to iframes
  • Improved invisibility "mask" techique, default when ReadiumCSS is HTML-injected, disabled at window.load event
  • Fixed handling of base@href (HTTP URL) vs. the root URL of ReadiumCSS assets

Git revision info:

Git commit history:

Git diff:

1.1.52

Build environment: NodeJS 12.16.1, NPM 6.14.4

Changes:

  • NPM updates (minor)
  • workaround for application/xhtml+xml not handled correctly in xmldom lib
  • support for audio/video autoplay (Electron command line switch)
  • support for audio background looping track (epub:type = ibooks:soundtrack)
  • in order to bypass Electron registerStreamProtocol() bugs: instead of static DOM patching of audio and video src URLs (replacement of custom URL protocol/scheme with direct HTTP streamer address), we now inject <base href="HTTP_URL"/> (this benefits all resolved absolute URLs, including scripted ones from mutated dynamic DOM, and does not affect the sandboxing of localStorage, IndexedDB etc. which is afforded by the custom URL protocol/scheme)
  • fixed handling of iframes inside publication HTML documents (forwarding of query params, and allows same-origin scripting by bypassing the aforementioned <base href="HTTP_URL"/> of the host document, recursively)

Git revision info:

Git commit history:

Git diff:

1.1.51

Build environment: NodeJS 12.16.1, NPM 6.14.4

Changes:

  • NPM updates
  • Electron getWebContents() WebView API deprecation (upcoming breaking change)
  • replaced registerStreamProtocol() with registerHttpProtocol() as the latter was hanging on large resource requests from the HTTP server / streamer
  • registerStreamProtocol() with self-signed certificate passthrough, and encrypted HTTP headers

Git revision info:

Git commit history:

Git diff:

1.1.50

Build environment: NodeJS 12.16.1, NPM 6.14.3

Changes:

  • in debug / development mode: context menu for "inspect element" at x,y coordinates, with automatic forced-focus on devtools window
  • audiobook error event now console logged in normal non-debug mode
  • in development mode with special audio debug enabled: the buffering tracking element (HTML canvas) is now centered correctly

Git revision info:

Git commit history:

Git diff:

1.1.49

Build environment: NodeJS 12.16.1, NPM 6.14.2

Changes:

  • fix: when there is a text selection, the reading location is the start container of the selection. Also added CFI indicator for start/end selection containers (in addition to existing CSS selector)
  • fix: role=doc-pagebreak in addition to epub:type=pagebreak, and pagebreak label now obtained from title and aria-label attributes in addition to element's textual descendant

Git revision info:

Git commit history:

Git diff:

1.1.48

Build environment: NodeJS 12.16.1, NPM 6.14.2

Changes:

  • NPM package updates (minor semantic version increments)
  • ReadiumCSS upgrade + fixed a subtle bug related to 'null' origin in the case of audio book (HTML template with data: URL + base) + API updates to allow app host to pass configuration instead of navigator "pulling" data as needed (this change is required for contextual / per-publication ReadiumCSS presets)
  • Performance: significant improvements in annotations / highlights rendering, ReadiumCSS background-color override, animated page scroll
  • Audiobooks: added debugging UI and console messages to help troubleshoot random playback break problems
  • Usability: avoid unnecessary reading location recording when scrolling, if currently-recorded element is already in the visible viewport (scroll and paginated modes)
  • Accessibility: consider that CSS selector link is equivalent to hash fragment identifier (e.g. typical TOC heading), for the purpose of setting the destination for the top-level skip-hyperlink (which restores previously-linked bookmarks, etc.)

Git revision info:

Git commit history:

Git diff:

1.1.47

Build environment: NodeJS 12.16.1, NPM 6.14.1

Changes:

  • NPM updates (minor)
  • tabbables now handled via focusin (hyperlinks traversal) => better performance, fewer keyboard-tabbing flashes / visual "bugs"
  • added top-level "skip link" to quickly keyboard-access the current URL hash fragment identifier or "active" target element (the link is CFI and CSS selector blacklisted) ... we need this because the iframe/webview cannot force focus when keyboard is in the app UI (the user must explicitely trigger the navigation)
  • fixed CFI blacklisting (even number element indexing calculations)
  • fixed style animation restart for element target (hyperlinking), added CSS "target" class to mimic the actual pseudo-class (for when URL fragment identifier is not used)

Git revision info:

Git commit history:

Git diff:

1.1.46

Build environment: NodeJS 12.16.1, NPM 6.14.1

Changes:

  • NPM updates (minor)
  • Fixed the keyboard event handler callback signature to include the element name and attributes used for blacklisting on the API's client side
  • Added EPUB epub:type=pagebreak info in reading location (nearest preceeding ancestor/sibling in document order)

Git revision info:

Git commit history:

Git diff:

1.1.45

Build environment: NodeJS 12.16.1, NPM 6.14.0

Changes:

  • NPM updates, including minor Electron
  • Added key-up event listener (to existing key-down), and target element name (for optional client-side blacklisting). Also now ensures "capture" in top-level document event listen.

Git revision info:

Git commit history:

Git diff:

1.1.44

Build environment: NodeJS 12.15.0, NPM 6.13.7

Changes:

  • NPM updates, notably: removed unused UUID package (breaking API change in newer version, so must avoid unnecessarily import here)
  • CSS fix: ReadiumCSS was taking precedence due to selector specificity (button border colour in night mode, audio player)

Git revision info:

Git commit history:

Git diff:

1.1.43

Build environment: NodeJS 12.15.0, NPM 6.13.7

Changes:

  • NPM updates
  • Bugfix: protection against publications without Resources
  • API improvement: readiumCssUpdate(rcss) now replaces readiumCssOnOff() which was misnamed and required out-of-line callback to fetch ReadiumCSS info.
  • 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 r2-shared, and of course r2-streamer.
  • Support for AudioBook serving/streaming, local-packed (zipped), local-exploded (unzipped), and remote-exploded.
  • Electron v8 (was v7)

Git revision info:

Git commit history:

Git diff:

1.1.42

Build environment: NodeJS 12.13.1, NPM 6.13.4

Changes:

  • NPM updates
  • ReadiumCSS update

Git revision info:

Git commit history:

Git diff:

1.1.41

Build environment: NodeJS 12.13.0, NPM 6.13.0

Changes:

  • Clipboard copy interceptor for LCP rights

Git revision info:

Git commit history:

Git diff:

1.1.40

Build environment: NodeJS 12.13.0, NPM 6.13.0

NOTE: this was mistakenly tagged as 1.0.40!

Changes:

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

Git revision info:

Git commit history:

Git diff:

1.1.39

Build environment: NodeJS 12.13.0, NPM 6.13.0

Changes:

  • NPM updates
  • MathJax "support" (blacklisting CSS selectors + CFI)
  • Added "refresh" function for webview (reloadContent()))

Git revision info:

Git commit history:

Git diff:

1.1.38

Build environment: NodeJS 12.13.0, NPM 6.12.0

Changes:

  • NPM updates
  • Removal of ResizeSensor, now using Chromium native Observer to detect HTML body dimensions changes (in order to re-paginate)

Git revision info:

Git commit history:

Git diff:

1.1.37

Build environment: NodeJS 12.13.0, NPM 6.12.0

Changes:

  • NPM updates, Electron v7

Git revision info:

Git commit history:

Git diff:

1.0.37

ELECTRON v6 moved to electron6 branch! (Electron v7 in develop)

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.36

Build environment: NodeJS 10.16.3, NPM 6.11.3

Changes:

  • Now allowing javascript: hyperlinks

Git revision info:

Git commit history:

Git diff:

1.0.35

Build environment: NodeJS 10.16.3, NPM 6.11.3

Changes:

  • Screen reader detection optionally triggers webview hard refresh

Git revision info:

Git commit history:

Git diff:

1.0.34

Build environment: NodeJS 10.16.3, NPM 6.11.3

Changes:

  • Added safeguard against erroneous inner-publication links (badly-authored EPUBs)

Git revision info:

Git commit history:

Git diff:

1.0.33

Build environment: NodeJS 10.16.3, NPM 6.11.3

Changes:

  • NPM updates

Git revision info:

Git commit history:

Git diff:

1.0.32

Build environment: NodeJS 10.16.3, NPM 6.11.3

Changes:

  • NPM updates
  • TypeScript sort import

Git revision info:

Git commit history:

Git diff:

1.0.31

Build environment: NodeJS 10.16.3, NPM 6.11.3

Changes:

  • NPM updates
  • Added API to forward keyboard key down press event to consumer app, useful for previous/next navigation at page or spine -level

Git revision info:

Git commit history:

Git diff:

1.0.30

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.29

Build environment: NodeJS 10.16.0, NPM 6.9.0

Changes:

  • TTS readaloud improvements and fixes (full screen utterances view, support for RTL text)

Git revision info:

Git commit history:

Git diff:

1.0.28

Build environment: NodeJS 10.16.0, NPM 6.9.0

Changes:

  • Fixed URI vs. URL bug (percent-escaped Unicode characters in path, was failing to match spine/readingOrder resource)
  • Document selection: DOM Range normalization (algorithm from Apache Annotator, ported to TypeScript)

Git revision info:

Git commit history:

Git diff:

1.0.27

Build environment: NodeJS 10.16.0, NPM 6.9.0

Changes:

  • NPM updates
  • Document selection: window.getSelection().collapseToStart() replaced with .removeAllRanges() (was failing silently inside IPC event listener)
  • Document highlighting: working SVG implementation (background, underline, and strikethrough). Works with reflow scroll and paginated, as well as scaled fixed layout. Exact same visuals as with HTML divs, just with SVG instead. Note: no well-defined API to expose total functionality, still work in progress.

Git revision info:

Git commit history:

Git diff:

1.0.26

Build environment: NodeJS 10.15.3, NPM 6.9.0

Changes:

  • Fix Electron/Chromium regression due to breaking changes in WebView (Out Of Process iFrame) lifecycle: resize and load events were creating unnecessary scroll adjustments in reflow column-paginated and scroll views.

Git revision info:

Git commit history:

Git diff:

1.0.25

Build environment: NodeJS 10.15.3, NPM 6.9.0

Changes:

  • NPM update: the css-element-queries package (ResizeSensor) is now fetched from NPM rather than GitHub (was a forked/patched dependency, some time ago ...)

Git revision info:

Git commit history:

Git diff:

1.0.24

Build environment: NodeJS 10.15.3, NPM 6.9.0

Changes:

  • NPM updates (including the ResizeSensor)
  • TTS renaming to "readaloud" (non-breaking internal API change)

Git revision info:

Git commit history:

Git diff:

1.0.23

Build environment: NodeJS 10.15.3, NPM 6.9.0

Changes:

  • NPM updates
  • Fixed left/right arrow key for page switch, when keyboard focus inside webview (Electron post-v1 regression)
  • Added highlights API (with minimal UI / UX in r2-testapp-js)
  • Fixed-layout documents (FXL) sometimes did not emit the load event, and did not scale correctly (browser engine bugs / edge cases). There are still rendering issues in Electron v3-v5. To be continued...

Git revision info:

Git commit history:

Git diff:

1.0.22

Build environment: NodeJS 10.15.3, NPM 6.9.0

Changes:

  • NPM updates

Git revision info:

Git commit history:

Git diff:

1.0.21

Build environment: NodeJS 8.15.1, NPM 6.4.1

Changes:

  • LCP LSD TypeScript model instead of JSON "any"
  • Added implementation document for selections/highlights
  • NPM updates

Git revision info:

Git commit history:

Git diff:

1.0.20

Build environment: NodeJS 8.15.1, NPM 6.4.1

Changes:

  • Latest ReadiumCSS
  • Fixed Electron v1+ window.document.scrollingElement regression, as well as IPC event send() dom-ready event check, and scroll offset coordinates in selection/highlights (still todo: keyboard focus handling)
  • NPM update r2-shared-js

Git revision info:

Git commit history:

Git diff:

1.0.19

Build environment: NodeJS 8.15.1, NPM 6.4.1

Changes:

  • NPM updates

Git revision info:

Git commit history:

Git diff:

1.0.18

Build environment: NodeJS 8.14.1, NPM 6.4.1

Changes:

  • NPM updates
  • Updated documentation (README)
  • Added support for two-page spreads with odd number of columns => empty "virtual" page at end of document.
  • Fixed reading location progression reporting bugs (paginated reflowable documents, right to left)
  • Added debugging feature for arbitrary visual reading locations
  • New prototype code (incomplete API) for user text selections/annotations/highlights.
  • Fixed ReadiumCSS for RTL (Hebrew, Arabic), was skipping some configuration
  • Added information data structures to reading location (pagination and document information)
  • Improved and fixed TTS / read aloud graphical user interface (minimal, but core to the user experience: modal popup text presenter with word-level highlighting and full ReadiumCSS support)

Git revision info:

Git commit history:

Git diff:

1.0.17

Build environment: NodeJS 8.14.1, NPM 6.4.1

Changes:

  • Fixed hyperlinking bug: nested a@href DOM fragments
  • Improved footnote rendering (extraction of note content)

Git revision info:

Git commit history:

Git diff:

1.0.16

Build environment: NodeJS 8.14.1, NPM 6.4.1

Changes:

  • Reading locator can now be set with progression percentage (not just CSS selector/DOM element), which is useful for linear navigation / slider-scrub UI.
  • Fixed "compute visibility" bug: CSS computed style "hidden" reported for scrolled-out columns!

Git revision info:

Git commit history:

Git diff:

1.0.15

Build environment: NodeJS 8.14.1, NPM 6.4.1

Changes:

  • Improved visible element detection algorithm, to automatically create the most appropriate CSS selector in reflow paginated and scroll views (reading location for page / spread)
  • Blacklist resize sensor in DOM traversal operations
  • Handling of non-visual page breaks (invisible DOM spans)

Git revision info:

Git commit history:

Git diff:

1.0.14

Build environment: NodeJS 8.14.1, NPM 6.4.1

Changes:

  • NPM updates
  • Fixed reflowable pagination bugs, inconsistent element selection based on visibility (HTML body fallback)

Git revision info:

Git commit history:

Git diff:

1.0.13

Build environment: NodeJS 8.14.1, NPM 6.4.1

Changes:

  • NPM updates
  • Reflowable pagination improvement: two-page spread with odd number of columns (i.e. empty/blank "virtual" trailing page), and more accurate element-level position reporting
  • Accessibility user setting "reduce motion", to disable animated page transitions
  • Popup footnotes: aside with epub:type (rear|foot|end)note is normally automatically hidden, but shown when no targetting link is detected (e.g. dedicated standalone document appendix for notes)
  • Content Security Policy for webview: allowed data: HTTP(S) protocols
  • The "current reading location" getter now populates the document title, so client apps can use this to render info label

Git revision info:

Git commit history:

Git diff:

1.0.12

Build environment: NodeJS 8.14.1, NPM 6.4.1

Changes:

  • NPM updates
  • Added documentation (README)
  • Improved keyboard handling, tab navigation
  • Added support for TTS read aloud (WebSpeech API)
  • Added support for popup footnotes (EPUB3)
  • Fixed ReadiumCSS injection bug (edge cases with some bad DOM, doctype)
  • Enabled loading of remote publications (was filtering local URL)
  • Allow loading of Readium webpubmanifest with different URL syntax than default streamer implementation
  • Disabled window.alert/confirm/prompt to avoid publication documents blocking the renderer thread
  • Fixed arrow keys capture issues (no page turn when used for interaction with text input, video/audio, slider, etc.)
  • Fixed scroll-to-view in the scroll view (now centering, was top edge)
  • Added visibility mask when navigating back into previous publication spine item (to eliminate visual flash due to first-render of document top)
  • Added blacklist of CSS class names and HTML element IDs for locators (CSS Selectors and CFI), to skip navigator-injected DOM markup)
  • Fixed hash-fragment ID reset problem (::active pseudo CSS class)

Git revision info:

Git commit history:

Git diff:

1.0.11

Build environment: NodeJS 8.14.1, NPM 6.4.1

Changes:

  • Fixed regression bug that affected apps with custom URL protocol handlers (schemes) due to Content Security Policy (now narrow scope by filtering requests)

Git revision info:

Git commit history:

Git diff:

1.0.10

Build environment: NodeJS 8.14.1, NPM 6.4.1

Changes:

  • Added visibility testing for locators (updated README documentation)
  • Improved timing of reading location restore, in case of layout delay due to heavy font faces, etc.
  • Fixed issues related to Electron4 support (webview resizing, Content Security Policy via HTTP headers, security params in webview creation interceptor, priviledged URL scheme / protocol for fetch in renderer process)

Git revision info:

Git commit history:

Git diff:

1.0.9

Build environment: NodeJS 8.14.1, NPM 6.4.1

Changes:

  • Updated documentation
  • Web console logging + shell output redirection
  • Added window-attached debug(true/false) function to switch visual debugging (setting is persistent in localStorage)
  • Code cleanup, better debug messages

Git revision info:

Git commit history:

Git diff:

1.0.8

Build environment: NodeJS 8.14.1, NPM 6.4.1

Changes:

  • Updated documentation
  • 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.7

Build environment: NodeJS 8.14.0, NPM 6.5.0

Changes:

  • NPM updates
  • API to provide epubReadingSystem info (name and version) changed slightly, now push-once rather than pull-many design pattern
  • Improved documentation (in progress)
  • Moved ReadiumCSS boilerplate code to here
  • Removed unused DOM event code (legacy mechanism to cater for slow rendering performance)
  • Console logging redirect for renderer process (not just webview isolated process)
  • Minor internal code reorganisation

Git revision info:

Git commit history:

Git diff:

1.0.6

Build environment: NodeJS 8.14.0, NPM 6.5.0

Changes:

  • Fixed regression bug due to the previous base64 pub ID encoding bugfix (slashes). Depending on what lib is used, URLs and URLs components do not necessarilly get automatically decoded/encoded (percent escape for base64 chars, e.g. = and /). We must be very careful because we pass around both full URLs, and URLs components that require encoding (thus the double-encoding issues). In the navigator component we also have the compound issue of URI authority/domain/origin (derived from the based64 encoding of the pub ID).

Git revision info:

Git commit history:

Git diff:

1.0.5

Build environment: NodeJS 8.14.0, NPM 6.5.0

Changes:

  • NPM updates (r2-xxx-js)
  • Fixed nasty Base64 encoding edge case with slash character in URLs
  • Moved "secure" HTTP code from navigator to streamer

Git revision info:

Git commit history:

Git diff:

1.0.4

Build environment: NodeJS 8.14.0, NPM 6.5.0

Changes:

  • NPM updates (r2-xxx-js packages)
  • Replaced deprecated RawGit URLs
  • ReadiumCSS readme (GitHub commit hash / revision)

Git revision info:

Git commit history:

Git diff:

1.0.3

Build environment: NodeJS 8.14.0, NPM 6.5.0

Changes:

  • Performance improvements in layout/rendering logic, now ReadiumCSS injected at streamer level (optionally, still works with regular DOM injection too)
  • Fixed scroll view bug: fast-switching was making document jump up
  • Fixed issue with back-navigation inside spine (delay in resynchronizing document position, in both scroll and paginated view modes)

Git revision info:

Git commit history:

Git diff:

1.0.2

Build environment: NodeJS 8.14.0, NPM 6.5.0

Changes:

  • Fixed code typo which was breaking some ReadiumCSS functionality.

Git revision info:

Git commit history:

Git diff:

1.0.1

Build environment: NodeJS 8.14.0, NPM 6.5.0

Changes:

  • Disabled debug mode (visuals)
  • Added missing license header
  • Removed unnecessary import aliases

Git revision info:

Git commit history:

Git diff:

1.0.0

Build environment: NodeJS 8.14.0, NPM 6.5.0

Changes:

  • Locator support (CFI, CSS Selectors, Progression(percent ratio), Position(placeholder))
  • Various fixes in reflow column-based pagination and scroll view, LTR and RTL (arabic), due to box-model and offsetTop innaccuracy (now getBoundingClientRect() with floating point accuracy)
  • ReadiumCSS added missing parameters, complete review of model + default values, based on current doc
  • Fixed disappearing scroll view scrollbar when switching modes
  • Adjusted focus and target CSS styles to transient display (timeout outline)
  • CSS Selector lib replacement (more robust uniqueness strategy)
  • NPM updates (minor)
  • ReadiumCSS updated to latest (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.7

Build environment: NodeJS 8.12.0, NPM 6.4.1

Changes:

  • NPM updates (minor)
  • ReadiumCSS updated to latest (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.6

Changes:

  • Dependency "ta-json" GitHub semver dependency becomes "ta-json-x" NPM package (fixes readium/r2-testapp-js#10 )
  • Fixed TypeScript regression bug (3.0.3 -> 3.1.1) related to XML / HTML DOM typings
  • 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.5

Changes:

  • NPM package 'debug' with explicity 'node' vs. 'browser' fix (console redirect)

Git revision info:

Git commit history:

Git diff:

1.0.0-alpha.4

Changes:

  • NPM updates (external dependencies)

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
  • @types/uuid
  • r2-streamer-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