|
| 1 | +# Thorium Reader v1.0.3 |
| 2 | + |
| 3 | +## Summary |
| 4 | + |
| 5 | +Version `1.0.3` was released on **05 September 2019**. |
| 6 | + |
| 7 | +This release includes the following (notable) new features, improvements and bug fixes: |
| 8 | + |
| 9 | +* Tweaked user interface / user experience, based on testers' feedback |
| 10 | +* Better support for assistive technology, including the following screen readers: |
| 11 | + * Narrator, JAWS and NVDA on Microsoft Windows |
| 12 | + * Voice Over on MacOS |
| 13 | + * (not tested on Linux) |
| 14 | +* Facilitated keyboard-based interaction, shortcuts and visual outlining |
| 15 | +* Improved OPDS support (online catalogs / publication feeds), including search, and error messaging (asynchronous HTTP requests, concurrent downloads) |
| 16 | +* Cleaned-up language resources (at the moment: English, French, German), to facilitate contributions / UI translations |
| 17 | +* Added a Command Line Interface (CLI) to import multiple publications, "open with" or double-click from the file explorer (registered EPUB file extension) |
| 18 | +* Better performance and security, latest NPM package dependencies wherever possible |
| 19 | +* Improved developer experience: |
| 20 | + * Stricter TypeScript compiler rules (static type checking) |
| 21 | + * Chromium developer tools with integrated Electron debugger, React and Redux extensions, Axe accessibility checker, and "inspect here" popup menu helper |
| 22 | + * Debugger configuration for Visual Studio Code, Electron main and renderer processes |
| 23 | + * Locales management: scripts and workflow to maintain JSON language resources |
| 24 | + |
| 25 | +## Full Change Log |
| 26 | + |
| 27 | +Git commit diff since `v1.0.2`: |
| 28 | +https://github.com/readium/readium-desktop/compare/v1.0.2...v1.0.3 |
| 29 | + |
| 30 | +=> **139** GitHub Pull Requests or high-level Git commits. |
| 31 | + |
| 32 | +Note that the changelog generated by the [standard-changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/standard-changelog) utility (`npx standard-changelog --first-release`) only contains a limited number of entries (`84` instead of `139`), so instead here is an exhaustive list of commits created by the following one-liner command line script: |
| 33 | +`git --no-pager log --decorate=short --pretty=oneline v1.0.2...v1.0.3 | cut -d " " -f 2- | sed -En "s/^(.*)$/* \1/p" | sed -En "s/^([^:]*):(.*)$/**\1:**\2/p"` |
| 34 | + |
| 35 | +*** (tag:** v1.0.3, origin/master, origin/HEAD, master) chore: version bump 1.0.3 |
| 36 | +*** fix(dev):** editorconfig linter was failing on Windows (glob file path) |
| 37 | +*** fix:** reader side menu, ARIA levels in TOC tree headings, aria-hidden on collapsed sections, list item containment (PR #670 Fixes #569 Fixes #672 Fixes #676) |
| 38 | +*** hotfix:** display settings radio buttons are not lists, Fixes #677 |
| 39 | +*** fix:** scrollbar extend in library view (PR #673 Fixes #505) |
| 40 | +*** hotfix:** redundant / duplicate nested list containers in TOC tree, Fixes #671 |
| 41 | +*** hotfix:** incorrect ARIA role on radio button, Fixes #675 |
| 42 | +*** hotfix:** PR #667 Screen readers have their own shortcut to activate hyperlinks (e.g. VoiceOver CTRL+OPT+SPACE), consistent focus handling |
| 43 | +*** fix:** CSS styles in reader view, font family, etc. (PR #674 Fixes #449) |
| 44 | +*** fix:** Keyboard-accessible and screen-reader friendly TOC navigation, and skip-to-main-content in reader view (PR #667 Fixes #565 Fixes #156) |
| 45 | +*** feature:** "go to page" in reader view, for EPUB pagelist navigation structure (PR #668 Fixes #82) |
| 46 | +*** hotfix:** follow-up to PR #653 ensures Publication Landmarks exist, Fixes #665 |
| 47 | +*** hotfix(dev):** DevTron dymamically-injected package needs to be in node-externals WebPack directive, Fixes #666 |
| 48 | +*** fix:** temporarily remove LCP support (PR #662, See #663) |
| 49 | +*** fix(ui):** reader options, pagination radio button (PR #661 Fixes #660) |
| 50 | +*** fix:** single Electron app instance, with CLI support (PR #606 Fixes #547) |
| 51 | +*** chore(dev):** display name in React Higher Order Component (PR #648) |
| 52 | +*** fix:** OPDS publication acquisition, check for duplicate / already-imported during download (PR #646 Fixes #538) |
| 53 | +*** chore(dev):** R2 package import aliases (PR #658 Fixes #657) |
| 54 | +*** hofix:** follow-up to PR #653 to replace TypeScript "any" with correct type. |
| 55 | +*** chore:** NPM package updates (minor semver) |
| 56 | +*** fix:** reader navigation menu, landmarks instead of list of illstrations (PR #653 Fixes #81) |
| 57 | +*** fix:** incorrect PostCSS autoprefixer statement (Fixes #654) |
| 58 | +*** fix:** revert console disabling (yargs) (PR #649, reverts PR #485) |
| 59 | +*** fix:** Thorium package and executable name (PR #651, related issue #411) |
| 60 | +*** fix(a11y):** accessible label for breadcrumb links (PR #650 Fixes #602) |
| 61 | +*** fix:** removed unnecessary pointer cursor on publication cover image (PR #652 Fixes #452) |
| 62 | +*** chore(dev):** OPDS API typings (PR #617) |
| 63 | +*** fix(l10n):** German locale names, script tool to create JSON data from CSV (PR #647 Fixes #430) |
| 64 | +*** fix:** OPDS feeds, async HTTP requests with timeouts and error handling, display info to user (PR #542 Fixes #419 Fixes #418) |
| 65 | +*** fix:** ensure non-supported CLI parameters (such a Electron/Chromium ones) are ignored during Yargs parsing (PR #607, see https://github.com/readium/readium-desktop/issues/547#issuecomment-520785137) |
| 66 | +*** fix:** OPDS feeds, conversion from relative to absolute URLs + handling of opds:// scheme (PR #639) |
| 67 | +*** fix(gui):** better focus outline thanks to additional padding (PR #637 Fixes #573) |
| 68 | +*** chore(doc):** CLI usage (PR #640 Fixes #584) |
| 69 | +*** chore(l10n):** follow-up to PR #641, removed unnecessary Toast code-scanning routine (in i18n-scan script) |
| 70 | +*** fix:** "toast" typing and upstream i18next message interpolation (PR #641 Fixes #534) |
| 71 | +*** fix:** Linux executable filename (PR #642 Fixes #411) |
| 72 | +*** chore(dev):** NPM packages maintenance, minor updates |
| 73 | +*** fix:** catalog refresh (recent publications) when reading location changes (PR #635 Fixes #555) |
| 74 | +*** fix(a11y):** publication grid view - title+author description on cover image, and dedicated label to announce menu button (PR #633 Fixes #586 Fixes #568) |
| 75 | +*** chore(doc, l10n):** README JSON locale scripts |
| 76 | +*** fix(ui):** dummy cover (CSS gradient), long title+author text overflow now contained (PR #619 Fixes #491 Fixes #409 partially) |
| 77 | +*** chore(dev):** removed unnecessary build step in dev mode (preload script for R2 navigator) |
| 78 | +*** chore(dev):** added missing "release" folder removal in clean task, and ensure eclint ignores the release folder (very time consuming lint!) |
| 79 | +*** chore(dev):** improved Visual Studio Code main and renderer process debugging (PR #632) |
| 80 | +*** chore(dev):** exclude dev-time packages from the production build (WebPack ignore plugin), as the define plugin + minification does not address this use-case (devtron, react-axe-a11y and the devtools extensions installer) |
| 81 | +*** chore(dev):** WebPack dev server with Hot Module Reload requires inline source maps (otherwise, no breakpoint debugging in the web inspectors of Electron BrowserWindows) |
| 82 | +*** chore(build):** minor hotfix for out-of-date version in package.json for ASAR |
| 83 | +*** fix(a11y):** remove incorrect ARIA labels in list of publications (PR #631 Fixes #600) |
| 84 | +*** chore(doc):** hotfix README typo (i18n / l10n task / script name) |
| 85 | +*** fix(a11y):** ARIA labels, descriptions for previous/next arrow buttons of cover images slider (PR #630, Fixes #585) |
| 86 | +*** chore(npm):** minor package updates, mostly patch updates (security, etc. no feature changes) (PR #629) |
| 87 | +*** fix(ui):** removed duplicate OPDS header (PR #627 Fixes #591) |
| 88 | +*** fix(l10n):** remove duplicated translations, OPDS import publication/sample (PR #628 Fixes #592) |
| 89 | +*** fix:** support for .epub3 extension (Fixes #544) |
| 90 | +*** fix(ui):** list of catalogs / OPDS feeds, top margin (PR #622 Fixes #609) |
| 91 | +*** fix(opds):** short search breadcrumb, root catalog context (PR #620 Fixes #616) |
| 92 | +*** fix(l10n):** French translation tweaks (PR #618) |
| 93 | +*** hotfix(l10n):** removed debug messages (Fixes #610) |
| 94 | +*** fix(a11y):** screen reader modal dialogs and popup menus (Fixes #605) |
| 95 | +*** fix(a11y,l10n):** changed untranslated french strings (Fixes #604) |
| 96 | +*** fix(a11y):** menu ARIA expanded, and menuitem roles (Fixes #599) |
| 97 | +*** fix(dev):** removed unused React component AddEntryForm (Fixes #597) |
| 98 | +*** fix:** React iterated key'ed markup, Toasts, Grid and List views (Fixes #562) |
| 99 | +*** fix(dev):** ensures React and Redux dev tools are loaded when the BrowserWindow contents are ready |
| 100 | +*** chore(dev):** added full WebPack config console debug when building in production |
| 101 | +*** chore(dev):** ensures lint task is always called for production builds |
| 102 | +*** chore(dev):** NodeJS TypeScript typings was incorrect version (Fixes #595) |
| 103 | +*** fix:** language locale applied to HTML document root (Fixes #587) |
| 104 | +*** chore(npm):** minor package updates |
| 105 | +*** chore(code):** OPDS feed parser lib updated with latest TypeScript typings fix (see https://github.com/NYPL-Simplified/opds-feed-parser/commit/d254de4130725bbe0314cfb731b4d87e79e3528b#r34665675 ) |
| 106 | +*** fix:** Redux Saga was using deprecated API coding style (now 1.* stable lib, was 0.* alpha) (PR #590) |
| 107 | +*** chore(code):** minor variable cleanup |
| 108 | +*** feat(dev):** Axe React a11y checker integrated in DEV mode (PR #589 Fixes #87) |
| 109 | +*** fix(a11y):** colour contrast, disabled buttons (PR #583 Fixes #574) |
| 110 | +*** feat(dev):** httpGet refactor, wrapper to fetch remote resources, with TypeScript typing, and error handling (PR #541) |
| 111 | +*** fix:** library list view, consistent line/row height, text ellipsis for long publication descriptions (PR #582 Fixes #553) |
| 112 | +*** chore(dev):** app debugging from Visual Studio Code, improved workflow and error reporting (PR #581) |
| 113 | +*** chore(doc):** added l10n developer information |
| 114 | +*** chore(doc):** fixed build status link |
| 115 | +*** chore(l10n):** tooling pass - sort, scan, typed, to sync locales with codebase and make canonical (PR #566) |
| 116 | +*** fix:** app/window menu consistent on Windows, Linux (dev utilities only, same as MacOS) (PR #564 Fixes #563) |
| 117 | +*** chore(dev):** eliminate Redux Saga deprecation warnings (all effect on array yield) |
| 118 | +*** chore(dev):** limit the number of file watchers during hot reloead dev server mode (Linux limited filesystem handles) |
| 119 | +*** fix:** MacOS CMD-W to close windows, other menus and dev tools (PR #560 Fixes #454) |
| 120 | +*** chore(typo):** MenuButton, Fixes #472 |
| 121 | +*** fix:** publication tags are normalized (trimmed, whitespace collapsed) Fixes #490 |
| 122 | +*** fix:** CSS user-select none, except for publication metadata (PR #559 Fixes #525) |
| 123 | +*** fix:** added support for .epub3 file extension (Fixes #544) |
| 124 | +*** feat(dev):** context menu to inspect element (PR #558 Fixes #545) |
| 125 | +*** feat(dev):** devtron integration (PR #557 Fixes #546) |
| 126 | +*** NPM update:** i18next (#556) |
| 127 | +*** feat:** OPDS feed search (PR #386 Fixes #296) |
| 128 | +*** fix:** library view, list mode, click-on-line to open reader (PR #548 Fixes #497) |
| 129 | +*** fix:** empty library view (no publications), drag-drop / import message (PR #549 Fixes #537) |
| 130 | +*** fix:** OPDS addition/import form (popup modal dialog), invoked from button (PR #550 Fixes #345) |
| 131 | +*** fix(a11y):** "skip to main" link style and position (PR #551 Fixes #470) |
| 132 | +*** fix:** toast notifications had html unicode escape sequences / charcodes (PR #552 Fixes #453) |
| 133 | +*** (leo/develop) chore(dev):** downloader TypeScript typings (PR #543) |
| 134 | +*** (pierre/develop) fix (arch):** pass boolean value into react props to indicate when api promise is rejected (known error or unexpected exception) (PR #539) |
| 135 | +*** fix:** window rectangle bounds, non-rounded decimal values crash DB backend (PR #536 Fixes #532) |
| 136 | +*** fix(l10n):** delete feed vs. publication (PR #533 Fixes #501) |
| 137 | +*** hotfix:** reference to Electron BrowserWindow (library view) maintained in new createWindows.ts file split from maint.ts (follow-up to PR #403) |
| 138 | +*** fix:** base64 encode / decode errors (PR #531 Fixes #522 Fixes #486) |
| 139 | +*** fix:** Fixes #530 confusing console error message for i18n language query from database (missing key) |
| 140 | +*** hotfix:** PR #471 duplicate configRepository.save() Fixes #529 |
| 141 | +*** hotfix:** window resize / move event handling, follow-up to #403 and #524 (bad merge, and uncaught debounce() coding error) |
| 142 | +*** chore:** refreshed package-lock.json which had been updated incrementally several times recently |
| 143 | +*** fix:** stricter TypeScript and TSLint code checks (PR #404) |
| 144 | +*** feat:** CLI Command Line Interface - import EPUBs, OPDS, read EPUBs (PR #403 Fixes #85) |
| 145 | +*** fix:** library and reader windows bounds / position + dimensions (PR #524 Fixes #492 Fixes #494) |
| 146 | +*** fix(10n):** updated codebase static analyzer to capture dynamic locale keys used in notification toasts (PR #527 Fixes #526) |
| 147 | +*** feat:** Microsoft Windows Store AppX images (PR #521) |
| 148 | +*** fix:** reader view, navigation (TOC), "title"-only headings should not be clickable, should be inert. (Fixes #520) |
| 149 | +*** fix:** updated r2-shared-js NPM package which addresses publications with no resources (only spine items) |
| 150 | +*** fix:** package.json version in about info (Fixes #473) |
| 151 | +*** fix(l10n):** publication languages shown in the user's locale (Fixes #519) |
| 152 | +*** fix:** application / product name in epubReadingSystem info (Fixes #510) |
| 153 | +*** chore(code):** consistent use of preprocessor directive / build-time constants (Fixes #511) |
| 154 | +*** fix(l10n):** replaced prefix/suffix bash shell script with wrap NodeJS code (Fixes #514) |
| 155 | +*** fix(l10n):** replace native shell utility for JSON sort with NodeJS script (Fixes #514) |
| 156 | +*** fix(l10n):** removed unused locale keys (static codebase analysis, i18next calls) (#516 Fixes #509) |
| 157 | +*** feat(l10n):** typings for i18next JSON locales (PR #518 PR #517) |
| 158 | +*** hotfix:** found typo in license header (`node ../r2-utils-js/tools/license_header.js src/`) |
| 159 | +*** fix:** JSON locales checking (discover missing and redundant keys) (PR #506 Fixes #397 Fixes #476) |
| 160 | +*** chore(code):** reader.tsx cleanup, queryParam, publication URL (PR #513) |
| 161 | +*** fix:** reader view, publication info button now works at first opening (PR #512 Fixes #292) |
| 162 | +*** fix:** css-hot-loader was in production build (Fixes #432) |
| 163 | +*** fix:** unused and misplaced NPM dependencies (PR #504 Fixes #499) |
| 164 | +*** fix:** flickering navbar (PR #498) |
| 165 | +*** chore:** R2 NPM packages updates (notably, consistent reflect-metadata version for ta-json) (PR #495) |
| 166 | +*** fix:** delete publication (in library view) => close opened readers (PR #489 Fixes #448) |
| 167 | +*** fix:** migrate deprecated "new Buffer()" API to "Buffer.from()" (PR #487) |
| 168 | +*** fix:** disable console functions in PACKAGED mode, in addition to debug() (PR #485) |
0 commit comments