Skip to content

Latest commit

 

History

History
1165 lines (633 loc) · 44.8 KB

CHANGELOG.md

File metadata and controls

1165 lines (633 loc) · 44.8 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]

Added

  • successfulFormSubmissionPayment to approvalsService.getFormSubmissionApproval() function response
  • paymentService.getDisplayDetailsFromFormSubmissionPayment()

Changed

  • [BREAKING] updated FormSubmissionApprovalsResponse type

[15.0.0] - 2024-09-03

Added

  • formSlug property to formService.getForm() options to allow retrieving a form with a slug and formsAppId

Changed

  • [BREAKING] formService.getForm() parameters to an options object

    -const form = await formService.getForm(formId, formsAppId, abortSignal)
+const form = await formService.getForm({ formId, formsAppId, abortSignal })

Dependencies

[14.1.0] - 2024-08-13

Added

  • submissionService.editPendingQueueSubmission
  • submissionService.cancelEditingPendingQueueSubmission

Dependencies

[14.0.1] - 2024-08-07

Dependencies

[14.0.0] - 2024-07-10

Added

  • submission to external id generation request payload

Changed

  • form submissions and draft downloads to use storage endpoints

Removed

  • [BREAKING] approvalsService.getFormApprovalFlowInstanceSubmission() (use submissionService.getSubmissionData())
  • [BREAKING] approvalsService.getFormSubmissionApprovalSubmission() (use submissionService.getSubmissionData())

Dependencies

[13.0.0] - 2024-06-21

Removed

  • [BREAKING] Westpac QuickWeb payment event

Dependencies

[12.0.1] - 2024-06-04

Changed

  • authService.getCurrentFormsAppUser() to call API regardless of isSAMLUser

Fixed

  • autosave data not being removed after saving a draft offline
  • drafts sync process throwing errors while offline
  • drafts deleted offline not being removed from drafts if the request to get synced drafts is returned from cache and includes the deleted draft

Dependencies

[12.0.0] - 2024-05-20

Changed

  • [BREAKING] drafts to use versioning

Dependencies

[11.2.0] - 2024-05-10

Changed

  • update searchCivicPlusHCMSContentItems to call HCMS directly

Added

  • Support for the formsAppId as an optional second property in the authService.forgotPassword() function
  • formService.deleteCivicPlusHCMSContentItem
  • formService.publishHCMSContentItem
  • formService.draftHCMSContentItem

Changed

  • update searchCivicPlusHCMSContentItems to call HCMS directly

[11.1.0] - 2024-04-30

Added

  • formService.getGeoscapeReverseGeocoding()

Changed

  • s3 uploads to @oneblink/storage

Dependencies

[11.0.1] - 2024-03-14

Changed

  • When preparing submission, default attachments with unknown type ("") to contentType: "application/octet-stream" to match AWS S3's default Content-Type

Dependencies

[11.0.0] - 2024-03-06

Added

  • formService.CivicPlusHCMSContentItemsResult type
  • formService.CivicPlusHCMSContentItem type
  • formService.searchCivicPlusHCMSContentItems() type

Changed

  • [BREAKING] localisationService.replaceInjectablesWithElementValues() and localisationService.replaceInjectablesWithSubmissionValues() return value to be an object with a hadAllInjectablesReplaced property

Dependencies

[10.1.0] - 2024-02-18

Dependencies

[10.0.0] - 2024-02-07

Added

  • submissionService.getSubmissionData()

Removed

  • [BREAKING] formSubmissionService service (getSubmissionData is now exported from submissionService, other exports have been removed)

[9.0.0] - 2024-01-30

Added

  • paymentService.westpacQuickStream
  • [BREAKING] paymentFormUrl option to submissionService.submit()
  • formSubmissionService service

Dependencies

[8.1.0] - 2024-01-18

Added

  • formService.searchAPINSWLiquorLicences()
  • formService.getAPINSWLiquorLicence()

Dependencies

[8.0.0] - 2023-12-12

Changed

  • [BREAKING] scheduledTasksService.getTasksForFormsApp() function signature. Made date argument required and changed result.
  • [BREAKING] scheduledTasksService.getTaskGroupInstanceTasks() function signature. Made date argument required and changed result.
  • [BREAKING] scheduledTasksService.getTaskGroupInstances() result.

Added

  • taskActionId to payload to complete scheduled task request
  • shortYearlessDate and longYearlessDate to localisationService

[7.0.1] - 2023-11-20

Changed

  • UploadAttachmentConfiguration.data to Blob type

Dependencies

[7.0.0] - 2023-11-01

Added

  • taskCompletion to FormSubmission type

Added

  • {TASK_NAME}, {TASK_GROUP_NAME} and {TASK_GROUP_INSTANCE_LABEL} to replaceable parameters

Dependencies

[6.8.0] - 2023-10-25

Changed

  • date parsing to use date-fns
  • forgot password flow to use API instead of AWS

[6.7.0] - 2023-10-23

Added

  • scheduledTasksService.deleteCompletedTask()

[6.6.0] - 2023-10-15

Added

  • scheduledTasksService.getTaskGroupInstanceTasks
  • scheduledTasksService.getTaskGroupInstances
  • taskCompletion to executeCancelAction

Changed

  • include taskGroupId and taskGroupInstanceId in scheduledTasksService.completeTask() and submission credentials request body

[6.5.1] - 2023-10-03

Added

  • actions to TaskResponse

[6.5.0] - 2023-09-22

Added

  • include taskId in submission credentials request body
  • scheduledTasksService.getTasksForFormsApp()
  • scheduledTasksService.completeTask()
  • scheduledTasksUrl option to submissionService.submit()

[6.4.0] - 2023-09-07

Added

  • HCMS_CATEGORIES form element options set type
  • createdBy and updatedBy to drafts

Fixed

  • uploads to S3 being corrupted if a single part fails in the multi-part upload process by setting leavePartsOnError

[6.3.0] - 2023-08-28

Added

  • autosaveService.deleteAllAutosaveData()
  • autoSaveService.getAutoSaveKeys()

[6.2.0] - 2023-08-10

Added

  • submissionTitle to approvalsService.getFormSubmissionAdministrationApprovals()

Changed

  • localisationService.formatNumber() to return up to the maximum number of fractional digits as per Intl.NumberFormat

[6.1.0] - 2023-08-01

Added

  • search for Form Element Lookups on App open

[6.0.0] - 2023-07-26

Added

  • formService.FormElementOptionsSetResult type
  • formService.parseFormElementOptions()
  • formService.getFormElementOptionsSets()
  • formService.getFreshdeskFields()
  • formService.parseFreshdeskFieldFormElementOptions()
  • formService.getFormElementOptionsSetOptions()
  • formService.loadFormElementDynamicOptions()
  • runLookupOnClear and records to response from formService.getFormElementLookups()
  • formService.FormElementLookupResult type

Changed

  • Submission Error handling to place submissions in pending queue if user has gone offline

Removed

  • [BREAKING] formService.getFormElementDynamicOptions()
  • [BREAKING] formService.LoadFormElementOptionsResult type

Dependencies

[5.2.0] - 2023-07-12

Changed

  • Use AWS SDK V3 for s3Submit service

Dependencies

[5.1.0] - 2023-07-03

Changed

  • Error handling when retrieving pre-fill credentials
  • Make title optional in OneBlinkAppsError and remove default of Whoops

[5.0.0] - 2023-06-23

Added

  • STATIC_DATA form element lookup type
  • payment prevention based on approval clarification request
  • support for GovPay Payments

Changed

  • [BREAKING] paymentService.handlePaymentQuerystring() return object has changed to support receiptItems
  • [BREAKING] submissionService.submit() function requires more parameters to handle server validation and external ID generation within the function
  • [BREAKING] submissionService.submit() now requires a isPendingQueueEnabled to have submissions added to the pending queue
  • options set to list

Dependencies

[4.1.0] - 2023-06-05

Added

  • authService.signUp()

Dependencies

[4.0.0] - 2023-05-26

Changed

  • [BREAKING] formService.getFormElementDynamicOptions() function result has changed to accommodate options sets that support passing a querystring parameter to filter options server side

Added

  • support for MFA to cognito logins
  • authService.setupMfa()
  • authService.disableMfa()

Fixed

  • optionIds not being set for dynamic options set filtering

[3.2.0] - 2023-05-08

Added

  • localisationService.generateDate()
  • localisationService.replaceSubmissionValues()
  • localisationService.replaceSubmissionResultValues()

Dependencies

[3.1.2] - 2023-04-20

Added

  • @microsoft/eslint-plugin-sdl eslint plugin

[3.1.1] - 2023-04-14

Dependencies

[3.1.0] - 2023-03-26

Added

  • downloadSubmissionPdfUrl to return type of submissionService.submit
  • generateExternalId to formService
  • lastElementUpdated to NewDraftSubmission
  • lastElementUpdated to draftService.getDraftAndData()

Changed

  • externalId to be stored in S3 object instead of S3 tags

Dependencies

[3.0.4] - 2023-03-03

Added

  • formApprovalFlowInstanceId to approvalsService.getFormSubmissionAdministrationApprovals()

[3.0.3] - 2022-12-13

Fixed

  • checking incorrect property for successful CP Pay transactions

[3.0.2] - 2022-12-12

Changed

  • CP Pay redirect to handle v2 query parameters

Fixed

  • time formatting for older iOS devices. Prevents date from repeating.

Dependencies

[3.0.1] - 2022-10-26

Changed

  • test environment domains to .test.

[3.0.0] - 2022-10-12

Added

  • An onProgress handler option to attachment upload, draft and submission functions
  • attachmentsService

Changed

  • Reduced default queueSize for S3 uploads to cater for slower internet connections, set dynamically if connection type is available
  • [BREAKING] draftService.addDraft() function to single argument
  • [BREAKING] draftService.updateDraft() function to single argument

Removed

  • [BREAKING] submissionService.uploadAttachment() function. Replaced by attachmentsService.uploadAttachment()

[2.1.0] - 2022-09-13

Added

  • approvalsService.closeFormApprovalFlowInstance()
  • approvalsService.reopenFormApprovalFlowInstance()

Deprecated

  • approvalsService.reopenFormSubmissionApproval()

Dependencies

[2.0.0] - 2022-08-28

Removed

  • legacy storage type for form elements

[1.2.6] - 2022-08-16

Changed

  • Form element dynamic options to support STATIC option sets

[1.2.5] - 2022-07-29

Added

  • notificationService.getEmailSubscriptions()
  • notificationService.updateEmailSubscriptions()

Changed

  • username to lowercase before sending to Cognito

Dependencies

[1.2.4] - 2022-07-04

Changed

  • form submission result being removed from local storage when handling payment query string

[1.2.3] - 2022-06-29

Added

  • approvalsService.createApprovalAdditionalNote()
  • approvalsService.updateApprovalAdditionalNote()
  • approvalsService.deleteApprovalAdditionalNote()
  • authService.getCurrentFormsAppUser()

[1.2.2] - 2022-06-23

Added

  • integration environment/gateway id to payment requests

[1.2.1] - 2022-06-17

Added

  • nested options to Freshdesk options

Dependencies

[1.2.0] - 2022-06-02

Added

  • unwindRepeatableSets to form store

Fixed

  • duplicate "An unknown error has occurred. Please contact support if the problem persists." error being reported to Sentry
  • redundant "Access Denied" being reported to Sentry

[1.1.0] - 2022-05-05

Added

  • autoSaveKey property to submissionService.submit() options
  • autoSaveKey property to approvalsService.submitApprovalForm() options
  • autoSaveKey argument to draftService.addDraft()
  • autoSaveKey argument to draftService.updateDraft()

Fixed

  • Unsynced offline drafts disappearing when being saved

[1.0.0] - 2022-05-03

Added

  • formStoreService
  • localisationService.getLocale()
  • localisationService.getFlatpickrFormats()
  • localisationService.getDateFnsFormats()
  • abortSignal param to formService.getForms(), formService.getForm(), formService.getFormElementLookups() and formService.getFormElementLookupById()

Changed

  • JSON parsing and stringifing to use JSON instead of big-json

Removed

  • [BREAKING] localisationService.locale function. Replaced by localisationService.getLocale()
  • [BREAKING] localisationService.flatpickrDateFormat function. Replaced by localisationService.getFlatpickrFormats().shortDate
  • [BREAKING] localisationService.flatpickrTimeFormat function. Replaced by localisationService.getFlatpickrFormats().time
  • [BREAKING] localisationService.flatpickrDatetimeFormat function. Replaced by localisationService.getFlatpickrFormats().shortDateTime

Dependencies

[0.12.11] - 2022-04-19

Dependencies

[0.12.10] - 2022-04-13

Added

  • createdAt on drafts being set by client

[0.12.9] - 2022-03-29

Changed

  • code to now use validatePaymentAmount() and getRootElementValueById() from SDK-core

Dependencies

[0.12.8] - 2022-03-02

Fixed

  • updatedAt being set on drafts before sync

[0.12.7] - 2022-01-24

Changed

  • uploadAttachment now returns uploadedAt string
  • contentDisposition changed to be a SDK-Core function

Dependencies

[0.12.6] - 2022-01-19

Added

[0.12.5] - 2021-12-21

Dependencies

Changed

  • Logic in handling scheduling and payment submission events

[0.12.4] - 2021-12-02

Added

  • freshdesk fields to dynamic options sets

[0.12.3] - 2021-11-19

Dependencies

[0.12.1] - 2021-11-18

Added

[0.12.0] - 2021-11-15

Fixed

  • getForms() not setting injectForms to true

Dependencies

[0.11.7] - 2021-10-14

Added

Changed

  • authService to handle forms app logic

[0.11.6] - 2021-09-24

Added

[0.11.5] - 2021-09-20

Dependencies

[0.11.4] - 2021-09-08

Changed

  • to use userService from SDK for parsing JWT payload

Dependencies

[0.11.3] - 2021-09-01

Added

  • previousFormSubmissionApprovalId to replaceable values

Dependencies

[0.11.2] - 2021-08-31

Added

Changed

  • the notifications errors that are sent to Sentry

Dependencies

[0.11.1] - 2021-08-25

Deprecated

[0.11.0] - 2021-08-23

Added

Removed

  • [BREAKING] approvalsService.retrieveFormSubmissionApprovalSubmission()

[0.10.1] - 2021-08-11

Added

  • getFormApprovalFlows to approvals service
  • getFormSubmissionAdministrationApprovals to approvals service
  • isAdministrator to auth service

[0.10.0] - 2021-07-20

Added

Removed

  • [BREAKING] paymentService.handlePaymentSubmissionEvent()
  • [BREAKING] formService.forEachFormElementWithOptions() moved to @oneblink/sdk-core
  • [BREAKING] formService.forEachFormElement() moved to @oneblink/sdk-core
  • [BREAKING] formService.forEachFormElement() moved to @oneblink/sdk-core
  • [BREAKING] formService.parseFormElementOptionsSet() moved to @oneblink/sdk-core

Dependencies

[0.9.4] - 2021-07-02

Fixed

  • attachments in sections not uploading for offline submissions

[0.9.3] - 2021-06-23

Added

  • searchCivicaStreetNames to forms service
  • getCivicaTitleCodes to forms service

Fixed

  • check for successful Westpac QuickWeb payments

Dependencies

[0.9.2] - 2021-06-06

Added

  • Support for WESTPAC Quick Web Payments

[0.9.1] - 2021-06-02

Fixed

  • time skew error when devices time is incorrect
  • Content-Disposition header for attachments

Dependencies

[0.9.0] - 2021-05-26

Removed

  • [BREAKING] formService.cancelForm()

Added

Dependencies

[0.8.2] - 2021-05-19

Fixed

  • formsAppId not being sent in request to get form submission credentials

Dependencies

[0.8.1] - 2021-05-13

Added

Dependencies

[0.8.0] - 2021-04-27

Changed

Added

Dependencies

[0.7.2] - 2020-04-15

Added

Dependencies

[0.7.1] - 2020-03-31

Fixed

  • OneBlinkAppsError.httpStatusCode not being set

[0.7.0] - 2020-03-30

Changed

  • [BREAKING] Updated approvals-service docs

Fixed

  • OneBlinkAppsError.httpStatusCode not being set

[0.6.1] - 2020-03-23

Dependencies

[0.6.0] - 2020-03-11

Changed

[0.5.3] - 2020-03-03

Added

  • approvalsService
  • previousFormSubmissionApprovalId to S3 tags on submission upload

Dependencies

[0.5.2] - 2020-02-15

Fixed

  • Invalid Option set properties not being converted to strings

[0.5.1] - 2020-02-03

Fixed

  • null as POST request payload when generating draft data credentials

[0.5.0] - 2020-01-18

Changed

  • [BREAKING] formService.getForm() arguments: formId is now the first argument and formsAppId is the second. formsAppId has been changed to optional.

Added

[0.4.3] - 2020-12-22

Added

  • crn2 and crn3 to BPOINT payment configuration

[0.4.2] - 2020-11-25

Fixed

  • X-OneBlink-User-Token header not being sent if Authorization header is sent with requests

[0.4.1] - 2020-11-24

Added

  • Include X-OneBlink-User-Token if userToken is provided

[0.4.0] - 2020-11-17

Changed

[0.3.1] - 2020-11-12

Changed

  • source from Flow to TypeScript

Dependencies

[0.3.0] - 2020-11-30

Changed

Added

Fixed

  • hard coded formsAppId on draft submissions

[0.2.0] - 2020-10-15

Added

Removed

Fixed

  • types for submissions

[0.1.0] - 2020-08-24

Initial release