Skip to content

Latest commit

 

History

History
1547 lines (833 loc) · 51.5 KB

CHANGELOG.md

File metadata and controls

1547 lines (833 loc) · 51.5 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[6.9.0] - 2024-10-20

Fixed

  • bold text in info elements not readable in tool tips

Added

  • Comprehensive validation errors toast
  • FormElementFile open files in a new tab

[6.8.0] - 2024-10-08

Changed

  • Tooltip a tags to be white in colour, and slightly grey when already visited
  • Evaluate predicates and disable form submission based on enableSubmission form property

[6.7.0] - 2024-09-30

Changed

  • Prohibited user input directly through text field on the Date element

Added

  • support for invisible ReCAPTCHA

[6.6.0] - 2024-09-25

Added

  • support for WCAG 1.3.1 - Info and Relationships
  • autocompleteAttributes to input, options and date based elements
  • support for WCAG 4.1.3 - Status Messages

Changed

  • dropdown styling to wrap text instead of being horizontally scrollable

Dependencies

[6.5.0] - 2024-09-03

Added

  • onSuccess and onError options to useSignUp hook

Dependencies

[6.4.0] - 2024-08-16

Added

  • Retry Lookup button for automatic lookup elements

[6.3.0] - 2024-08-13

Added

  • isHidden functionality to form elements
  • processPendingQueue on EDIT_CANCELLED pending queue event

Dependencies

[6.2.3] - 2024-08-07

Fixed

  • onBlur validation for boolean, camera, checkboxes, files, location and radio elements
  • elements with options allowing empty strings
  • threeDS2 in quickstream trusted frame

Dependencies

[6.2.2] - 2024-07-10

Added

  • bottom collapse button to sections

[6.2.1] - 2024-07-01

Changed

  • aria-describedby for Radio elements

[6.2.0] - 2024-06-21

Added

  • useLoadDataEffect() hook

Removed

  • Westpac QuickWeb

Dependencies

[6.1.1] - 2024-06-13

Fixed

  • accessibility attributes for checkbox and radio labels
  • auto save occurring while form is disabled

[6.1.0] - 2024-06-04

Fixed

  • injected options referenced from another page not being injected into HTML
  • ArcGIS web map layer panel showing if map is loaded on another page
  • reverse geocode not supporting sections

Added

  • <FormElementGoogleAddress />
  • useGoogleJsApiLoader() hook

Changed

  • blur activeElement after switching pages

Dependencies

[6.0.0] - 2024-05-20

Changed

  • useDrafts() hook to cater for versions

Fixed

  • ArcGIS web map layer panel showing on other pages

[5.14.0] - 2024-05-10

Added

  • optional formsAppId parameter to useLogin hook for the forgot password flow
  • ROUND_UP and ROUND_DOWN commands to calculation elements

[5.13.0] - 2024-04-30

Added

  • <ReverseGeocode />

Dependencies

[5.12.2] - 2024-04-10

Changed

  • No longer auto focusing first element on the first page of a form
  • No longer fetch dyamic options in read only forms if element contains options

Fixed

  • table cells using wrong date formats
  • requiredAll options validation when options are hidden
  • date format across timezones in data manager
  • recaptcha elements not resetting after a submission

Dependencies

[5.12.1] - 2024-03-25

Fixed

  • tooltip hint not displaying on hover by changing back MaterialIcon to an i tag

[5.12.0] - 2024-03-14

Added

  • Screen reader support for hints
  • Alt text to be hidden for decorative images

Fixed

  • screen readers reading icon names aloud when used as decorative images by setting aria-hidden attribute

Changed

  • location form element to support selecting a position as well as dragging a pin to a position
  • Changed placeholder text colour and styled to italics

Dependencies

[5.11.0] - 2024-03-06

Added

  • support for injectable option label and value
  • build tool chunking examples to docs
  • loading spinner to ArcGIS Web Map element
  • bulma icon styles

Dependencies

[5.10.0] - 2024-02-21

Added

  • Injectable options logic
  • portal to CopyToClipboardIconButton snackbar

Dependencies

[5.9.0] - 2024-02-18

Added

  • ArcGIS Web Map element

Dependencies

[5.8.0] - 2024-02-07

Changed

  • Some @media queries to @container queries to account for the preview in the console.

Fixed

  • repeatable set elements not being treated as readonly inside the <OneBlinkReadOnlyForm /> component

Dependencies

[5.7.0] - 2024-01-30

Fixed

  • DateTime element not showing validation message

Changed

  • Modal component to use MUI Modal component for handling focus

Added

  • <PaymentForm /> component

Dependencies

[5.6.0] - 2024-01-18

Removed

  • All instances of disableRipple on MUI components. This prop was responsible for disabling visual feedback when focusing an element

Added

  • API NSW Liquor Licence Element
  • Section element header to tabindex
  • Focusing of first element on a page when Next button is focused and used to nav forwards
  • role attribute to <DropdownMenu /> component for accessibility
  • alt attribute to file image previews for accessibility
  • focus-visible for buttons and number slider to make tabbing more prominent

Dependencies

[5.5.0] - 2023-12-12

Fixed

  • forms app accessibility contrast issues

Added

  • optional prop label to useFlatpickr
  • RadioGroup to place radio buttons in groups for accessibility tabbing
  • aria-label for failure lookup close button

[5.4.0] - 2023-11-20

Added

  • onUploadAttachment has been added as an optional prop to OneBlinkForms
  • continueWithAutosave automatic autosave population in OneBlinkAutoSaveForm

Changed

  • NodeJS to version 20
  • NPM to version 10

Removed

  • Switch Camera button from barcode scanner

Dependencies

[5.3.0] - 2023-11-01

Added

  • task, taskGroup and taskGroupInstance props to <OneBlinkForm />
  • excluding definition conditionally to dynamic lookup calls

Changed

  • Use lookup button label for required validation message if configured

Fixed

  • 'Lookup is Required' message showing while lookup is running

Dependencies

[5.2.0] - 2023-10-25

Added

  • calculations on dates

[5.1.4] - 2023-10-23

Dependencies

[5.1.3] - 2023-10-15

Changed

  • Stopped form navigate away prompts from displaying when in preview mode
  • ordering of lookup validation

[5.1.2] - 2023-09-22

Changed

  • useLoadDataState() and useLoadResourcesState() to always pass an AbortSignal

Added

  • has-margin-right-* and has-margin-left-* classes
  • data-cypress prop to <ErrorMessage /> component Try Again button

[5.1.1] - 2023-09-07

Changed

  • DraftsContextValue type

[5.1.0] - 2023-08-29

Fixed

  • types allowing definition in data manager record
  • draw form element canvas not having correct height when parent <div /> is resized

Dependencies

[5.0.1] - 2023-08-11

Fixed

  • pages lookup not setting lookup has executed

[5.0.0] - 2023-08-10

Changed

  • [BREAKING] executedLookups is now a required prop of the <OneBlinkFormControlled /> component.

Fixed

  • consider lookup has not having run if input changes
  • auto lookup not running for switch with false value
  • calculation element not rounding floating point numbers correctly

[4.4.0] - 2023-08-01

Added

  • Support for Static Lookups to work offline

[4.3.0] - 2023-07-26

Fixed

  • Autocomplete element not clearing on lookup returning undefined on value

Added

  • support for runLookupOnClear to allow running lookups on empty values
  • useLoadResourcesState() hook

Changed

  • blur autocomplete when an option is clicked
  • form element to display options as soon as possible instead of wait for all dynamic options to be loaded
  • allow scrolling page on number elements

Dependencies

[4.2.0] - 2023-07-12

Removed

  • MuiV4 Compatible Picker interface

Changed

  • Only update lastElementUpdated when it is triggered via a user input

[4.1.0] - 2023-07-03

Added

  • lookupButtonConfig to lookupButton to allow for different labels and icons

[4.0.0] - 2023-06-23

Added

  • useDrafts() hook
  • usePendingSubmissions() hook

Changed

  • [BREAKING] allowSubmitWithPendingAttachments prop for <OneBlinkForm /> component to isPendingQueueEnabled to prevent offline submissions. The functionality regarding attachments from the previous allowSubmitWithPendingAttachments prop have not changed.
  • Payment Receipt Items returned from @oneblink/apps instead of generated in PaymentReceipt.tsx
  • FormNotification to handle static data lookup type
  • unwindRepeatableSets parameter stored in localStorage

Fixed

  • lookups running in a loop if the lookup is triggered while currently running

Dependencies

[3.1.0] - 2023-06-05

Added

  • useSignUp hook

Dependencies

[3.0.0] - 2023-05-26

Changed

  • [BREAKING] useLogin() returns a isMfaCodeRequired, isSubmittingMfaCode and submitMfaCode which should be implemented to ensure login attempts support MFA

Added

  • options sets that support passing a querystring parameter to filter options server side

Fixed

  • HTML sanitization not running after element inputs are replaced

[2.14.2] - 2023-05-12

Fixed

  • data manager sorting error on form change
  • sanitized HTML not including classes and styles
  • time AM/PM picker not triggering change on keyboard input

[2.14.1] - 2023-05-08

Fixed

  • default value for date not catering for timezone
  • replaceable dates not catering for timezones
  • freshdesk dependent elements not validating correctly

Dependencies

[2.14.0] - 2023-05-02

Added

  • autocomplete option that always displays

Fixed

  • isDirty validation for Checkbox Element

[2.13.0] - 2023-04-27

Added

  • Repeatable set min/max entries based on another element

Changed

  • Prevent default behaviour of mouse wheel for number element

[2.12.0] - 2023-04-20

Added

  • @microsoft/eslint-plugin-sdl eslint plugin

Fixed

  • section validation inside repeatable sets and nested forms

[2.11.0] - 2023-04-14

Added

  • date validation based on another form element

Fixed

  • Unvisited pages not displaying validation when clicking submit
  • styles.css source map file pointing to ../src directory

Dependencies

[2.10.0] - 2023-04-02

Added

  • add class to elements for validation css

[2.9.0] - 2023-03-26

Added

  • Replaceable HTML values for hints
  • Multiple positions for Hint text to render
  • resumeAtElement prop to Form components

Changed

  • title prop to optional for <Modal /> component
  • store and retrieve lastElementUpdated in local storage when autosave runs and draft is saved
  • resume form at lastElementUpdated when autosave is continued

[2.8.0] - 2023-03-13

Fixed

  • Margin on buttons from CSS

Added

  • element to lookup payload
  • Peer dependencies to documentation
  • requiredAll to checkbox form elements

[2.7.0] - 2023-03-03

Added

  • CSS Classes for Radio/Checkbox containers
  • Mustache rendering to Info Elements

Changed

  • ABN prefill to no longer require a name

Dependencies

[2.6.0] - 2023-02-16

Fixed

  • Prefill of option elements that depend on a dynamic option element
  • V4DateTimePicker not using minDate or maxDate passed in

Added

  • isInfoPage prop
  • new PaymentReceipt.tsx component

Changed

  • Data Manager query string management to merge instead of replace

Fixed

  • Autosave form not discarding autosave
  • Summary and Calculation Elements not showing on read only forms
  • number input not allowing zeros

Dependencies

[2.5.2] - 2023-01-16

Fixed

  • passed the correct function signature to useFormElementOptions in FormElementAutocomplete.tsx

[2.5.1] - 2022-12-12

Fixed

  • number input clearing when entering a decimal point on iOS 16

[2.5.0] - 2022-11-24

Changed

  • Form Store table to load results from a button instead of scrolling to the bottom of the window
  • Treat all attachment downloads as private storage type

Added

  • isManual option to useInfiniteScrollDataLoad()
  • Disabled validation for read only forms

[2.4.0] - 2022-10-19

Changed

  • Signature element button "done" to "save signature" and validation message

[2.3.0] - 2022-10-12

Added

  • Progress Bar to Attachment uploads
  • Add prompt to allow continuing submission whilst attachments are uploading

Fixed

  • Data Manager crashing if submission data does not match form element

[2.2.0] - 2022-09-27

Fixed

  • Former Repeatable Set elements crashing Data Manager

[2.1.0] - 2022-09-13

Fixed

  • Section element's custom css class names not showing

Changed

  • Copy Button on read only elements

Dependencies

[2.0.0] - 2022-08-26

Removed

  • legacy storage type for form elements

Dependencies

[1.2.5] - 2022-08-16

Added

  • requireMessage to form element validation
  • append any customCssClasses to ob-element container

[1.2.4] - 2022-07-29

Dependencies

Fixed

  • Camera element timestamp watermark being too small on high resolution images
  • Fix BSB Element validation for empty values
  • Autocomplete Dropdown now handles regex special characters
  • Float repeatable set remove button instead of absolute positioning
  • Generation of default data for ABN element where ABN is an array

[1.2.3] - 2022-07-10

Fixed

  • Generation of default data for ABN form element

[1.2.2] - 2022-06-29

Added

  • onReplace() to useInfiniteScrollDataLoad()

[1.2.1] - 2022-06-17

Added

  • freshdeskDependentField form element

Dependencies

[1.2.0] - 2022-06-02

Added

  • unwindRepeatableSets parameter to form store

[1.1.1] - 2022-05-31

Changed

Fixed

  • calculation element not working with compliance element types

[1.1.0] - 2022-05-05

Added

  • removeAutoSaveDataBeforeSubmit and removeAutoSaveDataBeforeSaveDraft parameters to useFormSubmissionAutoSaveState() and <OneBlinkAutoSaveForm />

Fixed

  • colour variant for <LargeIconMessage /> title

[1.0.0] - 2022-05-03

Added

  • MuiV4CompatibleDatePicker
  • MuiV4CompatibleDateTimePicker
  • MuiV4CompatibleTimePicker

Dependencies

[0.6.2] - 2022-04-19

Dependencies

[0.6.1] - 2022-04-13

Dependencies

[0.6.0] - 2022-03-29

Fixed

  • elements under a section in repeatable sets not being pre-filled

Peer Dependencies

Dependencies

[0.5.8] - 2022-03-02

Added

  • added conditional ob-section__valid class to section element
  • Trimming to user input element types

Changed

  • import generateFormElementsConditionallyShown and flattenFormElements from @oneblink/sdk-core

Dependencies

[0.5.7] - 2022-01-27

Fixed

  • Image Attachments not updating when deleting Repeatable Set Entries

Added

  • attachmentRetentionInDays prop to <OneBlinkForm />

Changed

  • steps to have a scroll bar horizontally on multi-page forms on larger screens

[0.5.6] - 2022-01-19

Fixed

  • input icons not being centered

[0.5.5] - 2021-12-21

Dependencies

[0.5.4] - 2021-12-09

Added

  • ABN form element

Dependencies

[0.5.3] - 2021-12-06

Fixed

  • number slider rendering incorrectly when starting on non-active page

[0.5.2] - 2021-12-02

Added

  • freshdesk fields to dynamic options sets

Dependencies

[0.5.1] - 2021-11-24

Added

  • Validation for allowing extensionless attachments

Fixed

  • Year being returned from Intl date formatter as only digits in iOS15

Dependencies

[0.5.0] - 2021-11-15

Dependencies

[0.4.20] - 2021-11-01

Added

  • lookups to files elements

Fixed

  • summary element not working inside repeatable set

[0.4.19] - 2021-10-19

Fixed

  • Date display in summary element and date element clipboard copy in USA time

[0.4.18] - 2021-10-15

Fixed

  • Date display in summary element and date element clipboard copy in USA time

[0.4.17] - 2021-09-24

Added

  • BSB form element

Dependencies

[0.4.16] - 2021-09-20

Dependencies

Changed

  • file extension restrictions to be case insensitive

[0.4.15] - 2021-09-09

Fixed

  • attachments in section elements not preventing submissions while uploading

[0.4.14] - 2021-09-08

Added

  • setResult to result from userLoadDataState() hook

Fixed

  • return type for useNullableState() hook

Dependencies

[0.4.13] - 2021-09-01

Dependencies

[0.4.12] - 2021-08-20

Fixed

  • date only going back a day in New York timezone after lookup

[0.4.11] - 2021-08-12

Fixed

  • reCAPTCHA token being included in submission

[0.4.10] - 2021-08-04

Fixed

  • date format in US locale

[0.4.9] - 2021-08-03

Fixed

  • date only formatting
  • draw form element drawing offset on multi page forms

[0.4.8] - 2021-07-20

Fixed

  • logging with Sentry errors
  • OneBlinkReadOnlyForm component crashing when trying to render a form with nested elements

Dependencies

[0.4.7] - 2021-07-19

Fixed

  • location elements with lookups looping due to reference changes

Dependencies

[0.4.6] - 2021-07-07

Fixed

  • calculations being reset after lookup

Dependencies

[0.4.5] - 2021-07-05

Fixed

  • validation on nested forms not trigging until form has a value in submission

[0.4.4] - 2021-06-30

FAQ

Added

Fixed

  • conditional logic referencing elements inside nested sections

Dependencies

[0.4.3] - 2021-06-26

Fixed

  • date only parsing in timezones behind UTC

[0.4.2] - 2021-06-25

Fixed

  • reCAPTCHA tokens being duplicated when cleaning submission data

[0.4.1] - 2021-06-23

Added

  • definition to POST payload for lookup requests
  • civicaNameRecord form element
  • civicaStreetName form element
  • boolean form element
  • section form element

Fixed

  • Barcode Scanner element auto lookup not sending relevant data

Dependencies

[0.4.0] - 2021-06-06

Added

  • Toggle all button to Checkbox and Select (multi only) element

Changed

  • Barcode Scanner lookups to run automatically on scan
  • [BREAKING] radio and checkbox inputs to Material UI

[0.3.3] - 2021-06-02

Added

  • Support for customisable buttons
  • Support for custom regex validation
  • validation for camera form element to ensure an image is selected
  • replaceable parameter {INDEX} in HTML elements nested in repeatable sets

Changed

  • Hide Add button if repeatable set already has max number of entries

Fixed

  • prefill data on multiple pages overriding parsing of prefill data in subsequent pages

[0.3.2] - 2021-05-26

Added

  • icons to right side of inputs for form elements:
    • 'number'
    • 'barcodeScanner'
    • 'telephone'
    • 'email'
    • 'date'
    • 'datetime'
    • 'time'

Changed

  • Only capture date from date element
  • days offset to date and datetime

Dependencies

[0.3.1] - 2021-05-19

Fixed

  • conditional logic loop false positives

[0.3.0] - 2021-05-13

Fixed

  • auto save data being saved after submission

Added

  • Support for private and public file storage types
  • Support for displayAsCurrency prop in calculation element

Changed

  • [BREAKING] draw form element to require Done button press before the drawing is added to the submission data

Dependencies

[0.2.4] - 2021-04-27

Added

  • zoom property to location form elements submission data

Fixed

  • orientation of images uploading to files form elements

Added

  • Captured exceptions for certain element failures with Sentry
  • required * to files and repeatableSet form element labels

Fixed

  • options sets with invalid options never finishing loading
  • autocomplete with search url
    • not URL encoding search parameters
    • not validating options returned from request

[0.2.3] - 2021-04-15

Changed

  • Tooltip library to use material-ui tooltip

Added

  • Point Address element

Fixed

  • inputs in sub forms in repeatable sets having duplicate id properties, causing a bug with date, datetime, time elements not setting the value selected on the submission data

Dependencies

[0.2.2] - 2021-03-31

Fixed

  • validation class on telephone element not consistent with other elements

Dependencies

[0.2.1] - 2021-03-23

Added

  • Compliance element type
  • hint to form elements with a label displayed

Dependencies

[0.2.0] - 2021-03-17

Fixed

  • calculations inside repeatable sets using values from all entries

Changed

  • scroll behavior when changing pages

Removed

  • [BREAKING] position: fixed CSS from multiple page form navigation on mobile screen sizes

[0.1.14] - 2021-03-11

Fixed

  • location element loading styles
  • Auto lookups no longer run in read only forms

Dependencies

[0.1.13] - 2021-03-03

Added

[0.1.12] - 2021-02-18

Fixed

  • Files not being able to be re-added to files and camera element after being removed
  • inconsistent margin for form element error messages
  • Handled error when attempting to convert file to image in Camera element

[0.1.11] - 2021-02-15

Changed

  • bulma toasts and flatpickr pickers to be appended to elements inside the <OneBlinkForm /> component instead of appended to document.body.

[0.1.10] - 2021-02-09

Fixed

  • styling for add files button
  • styling for invisible pages on forms
  • Email element showing label twice

[0.1.9] - 2020-01-18

Added

  • geoscapeAddress form element type

[0.1.8] - 2020-12-22

Added

  • Checkbox and radio button contrast text determination

[0.1.7] - 2020-12-11

Fixed

  • Hyperlinks not being clickable and Images not displaying in HTML elements
  • barcode scanner on iOS by using navigator.mediaDevices.getUserMedia() instead of navigator.getUserMedia()

Dependencies

[0.1.6] - 2020-12-02

Fixed

  • data lookups in repeatable sets not updating elements that already contain data
  • element lookups on multi page forms duplicating all elements
  • styles from HTML form elements not being consistent with Forms Builder

[0.1.5] - 2020-11-24

Added

  • sending userToken with requests

[0.1.4] - 2020-11-12

Added

  • isInteger validation to number type form elements
  • minLength and maxLength validation to text and textarea type form elements
  • Support for includeTimestampWatermark for camera form element type

Changed

  • source from Flow to TypeScript

Fixed

  • auto save icon not getting position fixed styling

Dependencies

[0.1.3] - 2020-11-05

Added

  • BETWEEN conditional logic for numeric form elements

Fixed

  • checkboxes button not using option colour
  • number element inputs not allow decimal in Safari

[0.1.2] - 2020-10-30

Added

  • Disabled prop to forms to stop multiple submissions

[0.1.1] - 2020-10-15

Added

  • data-ob-name attr to elements
  • useLogin() hook to help with implementing a custom login screen
  • useAuth() hook and <AuthContextProvider /> component

Fixed

  • date / datetime format error in validation
  • Scroll service targeting class that wasn't present on DOM

Removed

  • CSS not being used

[0.1.0] - 2020-08-26

Initial release