Release v1.5.1

Roll back patch, replaces deprecated v1.5.0

This patch rolls back a few changes made in v1.5.0, bringing us back to a stable state, with a few outstanding bugs that will need to be re-patched.

✨ New Features

• ea4bb7f - auto-update the browserslist db on dev branches (commit by @joanise)

🔧 Chores

• f587a0f - update browserslist db (commit by @github-actions[bot])
• 4b857c6 - prepare v1.5.1 (commit by @joanise)
• b637b1d - update web-component bundle for v1.5.1 (commit by @joanise)

Release v1.5.0

Deprecated, use v1.5.1 instead

A few recent commits caused the editor to fail to save edited words and alignments. Consequently, we are deprecating this release. We released 1.5.1 that takes us back to a stable state, but with a few bugs un-fixed.

Original release notes

This release primarily integrates the ReadAlong Studio's Editor functionality into the main application, making it easier to fix alignment errors and update previously created readalongs.

It also adds the ability to have multiple annotation layers in a read along.

✨ New Features

• 0e48b7c - display annotated sentences (commit by @deltork)
• c141ed6 - shepherd tour for editor (commit by @deltork)
• 30a523f - add French translations for the Editor tour (commit by @joanise)
• 93c63df - finish the Spanish translations of the Editor tour (commit by @joanise)
• abda7aa - add navbar navigation (commit by @roedoejet)
• ebb7d70 - preserve state in editor (commit by @roedoejet)
• 27db387 - preserve state in studio (commit by @roedoejet)
• 1fcfe58 - create and manage annotation layers in read along studio (commit by @deltork)

🐛 Bug Fixes

• 23e676d - publish: fix hyperlinks on npmjs READMEs (PR #312 by @joanise)
  • ↘️ fixes issue #311 opened by @joanise
• c11d909 - improve the name of the files in the web bundle (commit by @roedoejet)
• 57277be - updated editor tour steps based on feedback (commit by @deltork)
• 73869bf - removed scroll bars from editor (commit by @deltork)
• 949217c - editor spacing adjusted to match studio (commit by @deltork)
• d2ea35c - made the studio link open in new tab (commit by @deltork)
• c894678 - small clarification in fr & es Editor tour (commit by @joanise)
• e561f10 - editor: return standard xml instead of html (commit by @roedoejet)
• b4f9c14 - studio: put dialog in center (commit by @roedoejet)
• fd589b3 - i18n: add translations (commit by @roedoejet)
• 58f1349 - test: fix unit tests (commit by @roedoejet)
• e276125 - i18n: localize title and subtitle again (commit by @roedoejet)
• 8a1bc02 - slots: fix slot reloading (commit by @roedoejet)
• 4d5a862 - reduce how much real estate is spent on studio&editor headers (PR #332 by @joanise)
• 90151e9 - #333 made the studio step two header, mobile friendly (PR #334 by @deltork)
• 65ee73e - minor adjustment to translations/annotations menu button state (commit by @deltork)
• a96581b - display of annotations icon in non edit mode (PR #341 by @deltork)

♻️ Refactors

• aa3f438 - move editor logic to service (commit by @roedoejet)
• e42a83f - move studio logic into service (commit by @roedoejet)
• 35ae243 - move shared download button logic into parent components (commit by @roedoejet)

🔧 Chores

• 15ff18b - prepare v1.5.0 (commit by @joanise)
• 1e81a8c - update web-component bundle for v1.5.0 (commit by @joanise)

Release v1.4.1

✨ New Features

• b83ffa2 - added version information in the interface and outputs (commit by @deltork)

🐛 Bug Fixes

• a1c9d84 - ci: previews and deploy need content write permission (commit by @joanise)
• c5273b8 - issue 268. single word read-along now highlights every time (commit by @deltork)
• 859f685 - update unidecode (commit by @roedoejet)
• ad7834e - blank out ancient file from dependabot dependency graph (commit by @joanise)
• f9e5c9d - ci: write permission required for deploy too (commit by @joanise)

🔧 Chores

• 127e548 - delete package-lock.json as next step in work-around (commit by @joanise)
• 0f9ff5c - prepare v1.4.1 (commit by @joanise)
• a385fd1 - update bundle (PR #308 by @github-actions[bot])

Release v1.4.0

✨ New Features

• 3733977 - created a settings dialog, allows end-users to override the configuration of a read along (commit by @deltork)
• 435efe7 - translations and message tweaks for the gear menu (commit by @joanise)

🐛 Bug Fixes

• 3bbad6b - write audio to wav (commit by @roedoejet)
• df993cd - skip animation for empty play_id (commit by @deltork)
• bd0aef3 - added listener for full screen and (commit by @deltork)
• a517f65 - small grammar and formatting changes (commit by @joanise)
• f824714 - web-c: better Fr trans for "upload an image for this page" (commit by @joanise)
• 8e19744 - bump nx to 18.3.4 so it works on windows again (commit by @joanise)
• 64cf95f - theme toggle in setting (PR #282 by @deltork)
• 438998b - allows the ability to highlight the word using the progress bar (PR #286 by @deltork)
  • ↘️ fixes issue #266 opened by @marctessier
  • ↘️ fixes issue #275 opened by @joanise
• 4871f05 - replace slugify function with library (commit by @roedoejet)

♻️ Refactors

• 298b740 - rename publish.yml to the better self-documenting deploy.yml (commit by @joanise)
• 49cdcd5 - remove dead scripts from web-component (commit by @joanise)

🔧 Chores

• 6bc6e1b - update package-lock.json by running npm install (commit by @joanise)
• 3713278 - release (commit by @roedoejet)

Release v1.3.0

✨ New Features

• 3783603 - a plugin to load scripts needed for read along wep app deployed on word-press powered site (commit by @deltork)
• d957070 - add basic version of editor (commit by @roedoejet)
• e5e87e0 - display readalong in editor as well (commit by @roedoejet)
• d73491f - added alignment and label editing to editor (commit by @roedoejet)
• dbe9fec - only allow uploading of single-file HTML (commit by @roedoejet)
• 0f1b828 - add editable.html to web bundle (commit by @roedoejet)
• 8423d1b - scroll and center wavesurfer element when ras element changes (commit by @roedoejet)
• ee0ca40 - automate adding new studio-web message translation keys (commit by @joanise)
• 2604892 - add check for versions in sync (commit by @dhdaines)

🐛 Bug Fixes

• dd01cbe - deps: correct versions to make the packages installable with Angular 15 (commit by @dhdaines)
• d62aa78 - build: add loader to make this importable from npm package (fixes #259) (commit by @dhdaines)
• a1b0c87 - correct path to capitaine haddock (commit by @dhdaines)
• 2ed19c1 - deps: anti-patterns all the way down (commit by @dhdaines)
• 058867a - deps: update package-lock.json (commit by @dhdaines)
• 2375d5e - test: use a different port as 5000 is used by MacOS stuff (commit by @dhdaines)
• 6b72496 - deps: run npm install to hopefully synchronize lock file etc (commit by @dhdaines)
• e05f31f - remove wordpress info from readme until its ready (commit by @roedoejet)
• 3ace3ec - bundle: await the translations to be updated (commit by @roedoejet)
• d2d77e5 - test: fix spec tests (commit by @roedoejet)
• 06bed58 - test: only load the download button if the proper inputs are available (commit by @roedoejet)
• 4dec160 - update xml labels and alignments as well as demo ras element (commit by @roedoejet)
• fe920db - i18n: remove redundant line (commit by @roedoejet)
• 05f66ae - output translations and images (commit by @roedoejet)
• 0d59271 - studio: update downloaded content with edited slots (commit by @roedoejet)
• 170b401 - studio: alignments use start/duration not start/end (commit by @roedoejet)
• 1fda094 - write b64 audio to web bundle (commit by @roedoejet)
• 0ce0404 - pages: force to check the full path for the empty route home page (commit by @roedoejet)
• ac94984 - ci: the bundle is not actually stable, cannot validate with cmp (commit by @joanise)
• 3f3dd76 - ci: use hash routing (commit by @roedoejet)

♻️ Refactors

• 62f86c7 - move download logic out to its own component (commit by @roedoejet)
• 59571a6 - extract new studio-web i18n and reorder messages.{es,fr} too (commit by @joanise)

✅ Tests

• a79031a - stabilized auto-pause test (commit by @deltork)

🔧 Chores

• f247699 - deps: migrate all the things to nx 18 and angular 17 (commit by @dhdaines)
• a012032 - ci: update everything to node 20 (commit by @dhdaines)
• d767eaf - word-press plugin refactored for submission to wordpress.org (commit by @deltork)
• dc8f915 - bump minor (commit by @roedoejet)
• 3287c04 - update package-lock.json (commit by @joanise)
• 22fcc84 - build bundle (commit by @roedoejet)

v1.2.1

What's Changed

v1.2.0 introduced a breaking change. This version allows both use-assets-folder and image-assets-folder to be used.

• fix: re-enable deprecated useAssetsFolder by @roedoejet in #253

Full Changelog: v1.2.0...v1.2.1

v1.2.0

What's Changed

BREAKING CHANGES

• use-assets-folder (Boolean) has been replaced by image-assets-folder (string). by @roedoejet in #243

New Features

• feat: auto-pause at the of each page. by @deltork in #246
• feat: add web bundle as download option by @roedoejet in #241
• feat: increase the text file size limits by @joanise in #233

Minor changes

• Changes by create-pull-request action by @github-actions in #230
• build(deps): bump axios from 1.3.4 to 1.6.1 by @dependabot in #232
• build(deps-dev): bump follow-redirects from 1.15.2 to 1.15.4 by @dependabot in #234
• docs: add citation by @roedoejet in #235
• build(deps-dev): bump ip from 2.0.0 to 2.0.1 by @dependabot in #236
• ci: bump actions to the supported node 20 versions by @joanise in #237
• ci: bump production node version to 18 since 16 is eol by @joanise in #238
• build(deps-dev): bump follow-redirects from 1.15.4 to 1.15.6 by @dependabot in #242
• build(deps-dev): bump webpack-dev-middleware from 5.3.3 to 5.3.4 by @dependabot in #245

Full Changelog: v1.1.1...v1.2.0

Release v1.1.1

1.1.1 (2023-10-23)

Documentation

• update the npm publish instructions to refer to release.yml (2c30289)

Build Systems

• deps-dev: bump @babel/traverse from 7.21.3 to 7.23.2 (#226) (25557fa)

Release 1.1.0

What's Changed

• feat(es): add spanish thanks to Jorge Rosés Labrada by @roedoejet in #192
• ci: bump gh pages action to use node 16 by @joanise in #194
• Fix release workflow by @joanise in #195
• Web-Component read strings from i18n/messages.*.json by @joanise in #196
• feat(fonts): use bc sans by default by @roedoejet in #197
• misc small improvements by @joanise in #198
• build(deps-dev): bump webpack from 5.75.0 to 5.76.0 by @dependabot in #199
• fix(deps): bump angular to 15.2.4 and update all dependencies possible by @joanise in #202
• build(deps): bump engine.io from 6.4.1 to 6.4.2 by @dependabot in #204
• fix: handle g2p errors with the updated g2p handling in web_api by @joanise in #205
• build(deps): bump socket.io-parser from 4.2.2 to 4.2.3 by @dependabot in #206
• feat: add aligner fallback settings for difficult alignments by @roedoejet in #207
• clean up package.json and project.json for studio-web by @joanise in #208
• docs: it is better to use "npx nx" than "npm install -g nx" by @joanise in #210
• feat: simplify language selection by @roedoejet in #209
• Dev.fix by @roedoejet in #212
• Close the microphone stream when done recording (fixes #213) by @dhdaines in #214
• Limit height of image to page height by @dhdaines in #217
• fix: use relative URLs for all assets by @joanise in #219
• Three small changes: play/pause tooltip, mat icon typo, aria recommendation by @joanise in #220
• build(deps-dev): bump word-wrap from 1.2.3 to 1.2.4 by @dependabot in #221
• fix: upgrade cypress to fix several CVEs by @joanise in #222
• feat: allow embedded ReadAlong in element by @dhdaines in #203
• chore: bump ngx version though not strictly necessary by @dhdaines in #223

Full Changelog: v1.0.2...v1.1.0

Release v1.0.2

1.0.2 (2023-02-28)

Features

• add analytics for file downloads and events (709f4d6)
• add caveat about not using the browser back button (e3ff851)
• add download option for various output formats (247df8f)
• add error page (03a508f)
• add French translations (8b4a776)
• add icons instead of add-line text (6bb4ba5)
• add opt-out for analytics (2fe0051)
• add plausible analytics (41033d0)
• add routing for errors (171886c)
• add scroll-behaviour attribute to allow non-animated page trans (a62355f)
• add stop button while playing back recording (8f16cec)
• add the contact the devs info to the error page too (6f49402)
• add versioning to single file bundle (90a81dc)
• build french site as well (2edc2f7)
• change recording button text when recording happens (c261695), closes #132
• detect failed alignments (da80f7c)
• disable recording button while we are trying to start to record (18279f0)
• filter und from the list of languages (c76c10d)
• French l10n for download options (8a9a91a)
• French translation for web analytics policy (172812c)
• greatly simplify the microphone service (9fced0b)
• handle langs failure better (50d70a9)
• i18n the error page messages (e70e9cf)
• make an observable for soundswallower init so we can wait for it and catch errors (f9735ca)
• meta tags for social media and search engines (c17d98a)
• move error handling to a single place and handle more errors (bb05513)
• move UI error reporting to UI code (09adfe3)
• nobody is listening to modelLoaded, it can be a normal attribute (6ca6078)
• option to control playback rate range (31e3562)
• option to hide translations at load time (10d869c)
• ping images before using them (791e275)
• playback-rate-range is now a number (06cefa0)
• rename Save button to Save a copy for better clarity (719b343)
• report all the things (4d30762)
• report failed alignments (d914a63)
• switch .ras to .readalong (8dc952d)
• tour: add tour for step 2 (e5b1236)
• polyfill mediarecorder for older safari (262a155)
• preload the model (fixes #130) (1cbf2d0)
• remove page title editing from interface (a13a66c)
• report /langs failure on load (c08516c)
• report fatal errors fatally (2bec766)
• report g2p warnings (71919a2)
• shepherd tour describes the export formats (9fedc46)
• tell the user what the max size is (b938d31)
• translate component UI (thanks monorepo!) (f9e7f2f)
• translate component UI (thanks monorepo!) (6bfe277)
• translate no model loaded message (dff26a2)
• translate the overwrite your data warning in the tour (739cf9b)
• use ESM in TypeScript, needed for next SoundSwallower (25b1f99)
• use jsonly soundswallower (to be in 0.6.2) (d7d0aa8)
• use our new email address in the contact us links (38f75df)
• warn user if they're about to leave page after dirtying the form (d8d7a7c)
• warn user if they're about to leave page after dirtying the form (1e316a6)
• analytics: add custom event for download (5e6f9cb)

Bug Fixes

• translations: add and remove translations when ras file already contains them (9377a8a)
• translations: add various suggested fixes (f60f89c)
• add correct type for convertRasFormat$ (1d8dbcf)
• add different error messages (da6b415)
• add fixed bundle to studio-web (2eccde5)
• add limit to text upload files (94a9b97)
• add primary colouring to agree button (665bd6a)
• add some padding left of the save text icon (ecc15e2)
• add specific aligner error message (59ce352)
• add specific targets for serve and remove specific targets for build (05e2c13)
• add title as html page title on download ([9d2...