Skip to content

Latest commit

 

History

History
406 lines (274 loc) · 16.2 KB

CHANGELOG.md

File metadata and controls

406 lines (274 loc) · 16.2 KB
Raw

CHANGE LOG

1.9.0

Remediation Project Update

Adds

  • Adds AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY as example env vars needed in .env-sample. They are required for building Docker images.
  • Adds Dockerfile and instructions on how to use it locally.
  • Adds the following npm packages: sass, webpack-dev-middleware

Updates

  • Updates .nvmrc to use Node 20.
  • Updates the logger file.
  • Updates npm scripts to be more conventional with build and dev.
  • Updates how the webpack dev server is implemented.
  • Updates how the react-number-format package is used in the FieldsetDate component.
  • Updates implementation of the focus-trap-react package.
  • Updates node's Buffer implementation for KMS package usage.
  • Updates the following npm packages: @babel/preset-env, @babel/preset-react, @babel/preset-register, @nypl/nypl-core-objects, @nypl/nypl-data-api-client, @typescript-eslint/eslint-plugin, axios, babel-plugin-module-resolver, body-parser, chai, clean-webpack-plugin, compression, cookie-parser, cross-env, css-loader, doctoc, dotenv, ejs, enzyme-adapter-react-16, eslint, eslint-config-airbnb, eslint-config-prettier, eslint-plugin-import, eslint-plugin-jsx-a11y, eslint-plugin-prettier, eslint-plugin-react, eslint-plugin-react-hooks, express, file-loader, focus-trap-react, jsonwebtoken, mini-css-extract-plugin, mocha, mock-local-storage, nock, react, react-autosuggest, react-dom, react-number-format, react-redux, redux, redux-thunk, prettier, sass-loader, sinon, sinon-chai, style-loader, supertest, typescript, webpack, webpack-cli, winston, underscore, url-parse, validator

Removals

  • Removes the .ebextensions folder since this repos should no longer deploy to ElasticBeanstalk.
  • Removes the .travis.yml file to not use Travis CI.
  • Removes the Procfile since this we don't use Heroku.
  • Removes the following npm packages: @babel/core, @babel/polyfill, @nypl/dgx-header-component, @nypl/dgx-react-footer, @typescript-eslint/parser, node-sass, node-sass-glob-importer, react-router-scroll, webpack-bundle-analyzer, webpack-dev-server, webpack-merge

1.8.2

Updates

  • Updates Circulating Link paths to match those expected by the new borrow.nypl.org domain.

1.8.1

Adds

  • Adds styling necessary to fix broken UIs after the @nypl/design-toolkit package was removed.

Updates

  • Updates the following npm packages
    • axios to 0.27.2
    • axios-mock-adapter to 1.21.2
    • babel-loader to 8.2.5
    • babel-plugin-module-resolver to 4.1.0
    • babel-register to @babel/register
    • core-js to 3.23.3
    • css-loader to 1.0.0
    • ejs to 3.1.6
    • enzyme to 3.11.0
    • enzyme-adapter-react-16 to 1.15.6
    • nightwatch to 2.3.0
    • nyc to 15.1.0
    • prop-types 15.8.1
    • sinon to 9.2.4
    • style-loader to 1.0.0
    • underscore 1.10.0
    • validator to 13.7.0
    • webpack-bundle-analyzer to 4.5.0
    • webpack-dev-server to 3.0.0
    • webpack-merge to 5.8.0

Removals

  • Removes the @nypl/design-toolkit package.
  • Removes the following packages:
    • babel-core
    • babel-plugin-instanbul
    • babel-preset-env
    • babel-preset-react
    • babel-register
    • brace-expansion
    • classnames
    • create-react-class
    • esdoc
    • react-addons-test-utils
    • react-doc-meta
    • react-onclickout
    • react-tappable
    • regenerator-runtime
    • scroll-behavior
    • webpack-visualizer-plugin

1.8.0

Updates

  • Updates the Reservoir Design System to version 1.0.5 from version 0.21.0. This updates minor UI elements throughout the app such as Headings, Buttons, and form-related components. Updates include:
    • Removing enum types LinkTypes, ButtonTypes, and IconNames.
    • Update props for the Breadcrumbs, Button, Checkbox, Heading, HelperErrorText, Icon, Label, Link, SearchBar, Select, and SkeletonLoader components.
    • Updates the Input component implementation to TextInput.
    • Refactors form-related component combination for the Label component, <input> HTML element, and HelperErrorText component.
    • Updates layout styles from previous DS class rules.
    • Tweaks style rules so that pages render appropriately.
    • Updates unit tests accordingly.
    • Removes the "nypl-ds" class name.
    • Removes the Modal component but replaces it with the old Modal component implementation CSS for the CancelConfirmationModal.jsx, ItemFiltersMobile.jsx, and TimedLogoutModal.jsx components.
    • Updated all CSS variable names to have the --nypl prefix.

1.7.1

  • Security Update: change CDN URL to point to ux-static.nypl.org.

1.7.0

  • Replace Alt with Redux for state management

1.6.7

  • Adding Journal Title as option in search dropdown

1.6.6

  • Updating @nypl/dgx-react-footer to 0.5.6.

1.6.5

  • Updating @nypl/dgx-react-footer to 0.5.5.

1.6.4

  • Updating @nypl/dgx-header-component to 2.6.0

1.6.3

  • Add new Scholar rooms, mal17 and mal23, to locations.js

1.6.2

  • Updating @nypl/dgx-header-component to 2.5.8

1.6.1

  • Subject heading "explosion": Subject headings on bib pages contain multiple hierarchical filtered search links.
  • Updating @nypl/dgx-header-component to 2.5.6

1.6.0

  • Updating to add more checks to see if the bib detail fields include subject headings. If so, it will then call the additional string methods to generate new texts and URLs for the link.

1.5.9

  • Updating the filters to include subject literal as a possible filter type
  • Fix bugs relating to browser navigation

1.5.8

  • Updating @nypl/dgx-react-footer to 0.5.2.

1.5.7

  • Updating @nypl/dgx-header-component to 2.4.19.

1.5.6

  • Updating @nypl/dgx-header-component to 2.4.15 and checking for QA in APP_ENV.

1.5.5

  • Updating @nypl/dgx-header-component to 2.4.14 and setting APP_ENV.

1.5.4

  • Updating @nypl/dgx-header-component to 2.4.13.

1.5.3

  • Updating @nypl/dgx-header-component to 2.4.12.

1.5.2

  • Updating the instructions for EDD form.

1.5.1

  • Updating the Header component to v2.4.11 and the Footer component to v0.5.1.
  • Remove componentDidMount from BibPage component to fix log in and seeing Delivery Locations issues.

1.5.0

1.4.3

  • Documentation: Revised DEPLOYMENT.md to remove dev-eb-deploy, simplify strategy
  • Added deploy-* scripts to package.json

1.4.2

  • Updating @nypl/dgx-react-footer version to 0.5.0 and @nypl/dgx-header-component to 2.4.8.

1.4.1

  • Change how Notes are rendred: Render notes grouped by noteType, with noteType shown at root level of hierarchy.
  • Add support for rendering Contents (tableOfContents)

1.4.0

  • Adding OptinMonster script and updating header to 2.4.7.
  • Updating Travis CI configuration for CD to AWS Elastic Beanstalk.

1.3.1

  • Removing hold request notification due to inclement weather (again).

1.3.0

ReCAP 1.2 Release

The main goal for this release was to add more delivery locations options for Hold Requests, to get more fields exposed for bib information in the UI, and to release a dropdown form for selecting filters for searching.

  • The Design Toolkit was updated and that include layout and style updates on the Search Results page, Hold Request page, and Electronic Document Delivery page.
  • The omnisearch on the Search Results page has a new mobile design for better usability.
  • Accessibility updates were added throughout the page. This included minor heading and label changes, but also big ones for better screenreader usability.
  • New bib fields were rendered on the Bib Page, including Publication (update to publicationStatement), Publication Date, Uniform Title, Alternative Title, Genre/Form, Contents (updated notes). Some field attributes have not change but more data is being rendered since updates were made in the metadata and API side.
  • This was the second attempt at releasing Filters. Since the first iteration months ago, bugs were fixed, components refactored, and the design was changed. Many of the existing CSS DOM and class names have not changed from "modal"/"popup" to "dropdown" but we're working on updating both this repo and the Design Toolkit (where the class names come from). Users can select filter options from the Format, Date, and Language categories, remove them one by one or all at once, and adjust existing selections.
  • The biggest hurdle in this deployment was the accessibility update necessary to make the filter and search work for screenreaders. Multiple combinations of aria-live and javascript focus scripts were used. It's not perfect but we're at a good stable place where, after searching or applying any number of filters, the screen reader announces that the page is 1) loading, 2) that they are currently on an h2 heading, and 3) how many search results have returned.
  • Deploying with 78% code coverage.

1.2.10

  • Small hold request content notification for inclement weather.

1.2.9

  • Deploying logic check to make sure that an item really is available before placing a hold request on it. Mostly for the situation where a patron comes from the catalog.

1.2.8

  • Update to Header component v2.4.5.

1.2.7

  • Removing notifications from Hold Request page.

1.2.6

  • Update to Header component v2.4.3 (small hotfix) and update to Notification on Hold Request Page.

1.2.5

  • Update to Header component v2.4.2 and ejs package update.

1.2.4

  • Update the Header and Footer npm components to v2.4.1 and v0.4.1, respectively.

1.2.3

  • Updated Notification on Hold Request component in support of hours of operation changes for January 2018.

1.2.2

  • Added Notification on Hold Request component for 2017 holiday closings.

1.2.1

  • Update Header component version to 2.4.0.

1.2.0

  • Update dgx-react-ga related functions for Header Component and dgx-react-ga updates.

1.1.7

  • New version of the header just in time for the Fundraising Banner! 😒

1.1.6

  • Update the header to version v2.1.1.

1.1.5

  • Hotfix to remove the MARC link on bib detail page as the link to Webpack is not working.

1.1.4

  • Hotfix to display the publisher field which went from publisher to publisherLiteral in the Search Results.

1.1.3

  • Hotfix to display the publisher field which went from publisher to publisherLiteral.

1.1.2

  • Small updates:
  • Update the display text for electronic resources to use label instead of prefLabel.
  • Added better error messages with more information to check in Cloudwatch.
  • Added a few more tests to the util functions.

1.1.1

  • Added Google Analytics events throughout the app.
  • Added new Google Form for the feedback widget and refactored it so it's always rendered on the page. Otherwise, the dynamic rendering of the form caused it to not submit any new submissions.
  • New Design-Toolkit upgrade.

1.1.0

  • Added more unit tests for React Components.
  • Added a11y updates to the animation layer and the feedback widget by adding a focus trap when they are opened.
  • Cleaned up CSS and JS.
  • Capitalization update on some headings.
  • Fix to the updated supplementary content property from the API.

1.0.0

  • 🚀!
  • First release of Discovery/Shared Collection Catalog.
  • Updated the accessibility for the loading layer animation screen including aria labels and better focus.
  • Updated the DOM structure of the EDD form page.
  • Updated npm package versions.
  • Updated the accessibility for the feedback form, removing required attributed for aria-required and adding a Cancel button.
  • Updated the Google Analytics ID.
  • Updated the Hold Confirmation copy.

0.8.2

  • Small pre-launch update.
  • Added tests for more components.
  • Added a 'partOf' field for a bib.
  • Fixed a server issue where the bib did not exist. Now it redirects to the 404 page.
  • Fixed a bug where links did not go back to a search for that linked value.
  • Displaying electronic resources on the bib page.
  • Updating logic for 'Publication' information that broke a few pages.

0.8.1 - Cache hotfix

  • Removed caching from API calls from the nypl-data-api-client module.

0.8.0 - QA v2

  • The second sprint before we public launch. This released focused on NYPL's Production Readiness standards and fixing a11y issues.
  • OAuth credentials and AWS KMS keys were better handled and configured in Elastic Beanstalk for our development, qa, and production instances.
  • The header structure on each page was updated.
  • A 404 page was introduced.
  • Copy changes were made in the Hold Confirmation page, the Search Results page, and the omnisearch placeholder.
  • The bib record page was restructured to include two definition lists and the MARC record is outside those lists now. Supplementary Content is now displayed if available.
  • Logic for requestability and non-ReCAP NYPL items were improved.
  • Configurations were made to set up the UI for development and production API platforms.
  • Logging and an alarm in AWS Cloudwatch was set up.
  • The confirmation page can now link back to the Classic Catalog if that's where the patron came from.
  • Other general accessibility updates were made in the omnisearch, breadcrumbs, and hold confirmation page.

0.7.0 - QA v1

  • This was the first of two sprints before we go from Internal Beta to Public Beta. YAY! 🚀 📚
  • A lot of accessibility, QA, and feedback fixes were completed this sprint.
    • Each page was checked through a11y tools.
    • Page titles, duplicate IDs, color contrast, valid HTML, and other fixes were completed.
    • The complete hold request for physical and EDD workflow works without Javascript enabled.
  • The EDD form went through another iteration with updated content, input validation, and error checking.
    • This includes listing the errors and making them links to the input fields.
  • Also not allowing to place a request if EDD is not available or if there are no delivery locations.
  • Adding badges to the README to better know the status of our repo.
    • Moving the version syntax to 0.7.0 without the v in the front.
  • The default option for a Hold Request is now the first option, which is usually EDD.
  • There's a link on the Hold Confirmation page that leads back to the Search Results page, only if you got to that page from making a search.
  • Better error handling for the Hold Request page when the API is down, or there are no delivery locations.
  • Context for search results when clicking on a link from the Catalog Record (bib) page. E.g. 100 results for author Shakespeare.

v0.6.0 - Internal Beta Release

  • Better workflow for placing a hold on physical items.
  • Electronic Delivery is now working.
  • Updated homepage, app name, and app styling.
  • Updated fields to display on a Catalog Record page.
  • Accessibility updates.
  • Removed filters for this release.
  • Updated to the Design-Toolkit included.
  • Big update to include reverse proxy integration on NYPL site.
  • More smaller updates to make it all come together!

v0.5.0 - New Design v1

  • v2 of the bib page which added pagination for items but still includes the no-js fallback.
  • A lot more no-js fallbacks.
  • Bigger refactor of components.
  • v1 of the second iteration from the Design Toolkit - new design - for the bib page.
  • Added back item detail in search results but only if each bib has one item.
  • Added more static mockups for the Hold Request page - multiple delivery location.
  • Added Travis for better test workflow when we commit code.

v0.4.0 - Hold Request

  • This update includes the Hold Request workflow which was decided to be brought back in. From the bib page, you can click on the "Request" button to place a Hold Request.
  • Fixed a lot of bugs regarding functionality for searching and filtering.
  • Refactored components and added a few tests.
  • v1 of the bib page which includes no-js fallback.

v0.3.0 - Design Toolkit Beta

  • Next biggest update that uses the NYPL Design Toolkit for the search results and bib page.

v0.2.0

  • Upgrading to React v15.