Skip to content

Releases: ConsumerDataStandardsAustralia/js-holder-sdk

v2.1.0

13 Sep 07:29
a6d4c17
Compare
Choose a tag to compare

What's New:

This Minor release includes some new enhancements to our SDK:

Enhancements:

  • Pagination Support (Issue #22): To simplify the integration of pagination in the applications, we've introduced new utility functions.
  • Error Handling Support (Issue #21): To enhance error management capabilities, with our new helper class or functions, designed to generate standardised JSON error structures.

Bugfixes:

  • Fixed up some issues in the package lock file

v2.0.4

28 May 00:45
1faaae1
Compare
Choose a tag to compare

What's New:

  • Enhanced Documentation: Updated the README file to provide a clearer and more comprehensive overview, including detailed sections on middleware functions, how to use the SDK, and streamlined installation and testing instructions. The update also incorporates direct links to the npm package and GitHub repository for easier access.
  • Note: This update is backward compatible and focuses primarily on documentation enhancements.

v2.0.2

22 Feb 23:37
68d7c2b
Compare
Choose a tag to compare

What's Changed

This patch release includes some bug fixes and more unit tests.

Bugfixes

  • Fixed #16: This issue caused the cdrResourceValidator to always interpret POST request as to no consent was given to any provided resource ids in the post body.
  • Fixed #15: The .map files were not published therefore the package was not usuable as-is for any pure Javascript development.
  • Fixed the links to images in ReadMe file when package is published.

v2.0.1

21 Feb 23:28
Compare
Choose a tag to compare

What's Changed

This patch release includes some bug fixes, enhancements and more unit tests.

Enhancements:

  • #5: added additional functions cdrScopeValidator, cdrEndpointValidator, cdrResourceValidator by refactoring some existing ones.
  • #11: use of a callback mechanism to get information re scopes and accounts ids. This decouples the the middleware from the IdP and allows for an alternative use case. cdrScopeValidator and cdrJwtScopes functions are still in place

Bugfixes

  • fixed #10: Middleware was getting hanged for some API calls

Full Changelog: v2.0.0...v2.0.1

v2.0.0

22 Jan 23:40
Compare
Choose a tag to compare

What's New

This major update provides a robust, error-resistant, and easily integrable middleware solution for handling API endpoint requirements in compliance with CDR standards.

  • Enhanced Functionality: Introduction of new functions cdrScopeValidator, cdrEndpointValidator, and cdrResourceValidator for more granular control (#5).
  • Improved Flexibility: Implementation of a callback mechanism for scope and account ID information, decoupling the middleware from the Identity Provider (IdP) and facilitating alternative use cases. The existing cdrScopeValidator and cdrJwtScopes functions are maintained (#11).
  • Bug Fix: Resolution of a critical issue where middleware would hang on certain API calls (#10).
  • Refactoring: Break up of functions for improved clarity and efficiency.
  • Expanded Testing: Addition of unit tests for recent changes, including tests using the basePath parameter in configuration files.

Explore the latest features and improvements by visiting our npm package page here.

Full Changelog: v1.3.0...v2.0.0

v1.3.0

30 Nov 01:24
8c00f97
Compare
Choose a tag to compare

What's New:

Improvements:

  • Enhanced Compilation and Publishing: Revised package.json and tsconfig.json for better compilation and publishing, including type generation and source code filtering to prevent client-side compilation issues.

New Features:

  • Non-CDR APIs Toggle: Added configuration to enable or disable non-CDR APIs, enhancing flexibility in API combinations.
  • Base Path Configuration: Introduced a new config option to set a base path, moving away from the default assumption of root path hosting for endpoints.

v1.2.0

04 Oct 22:23
6c38694
Compare
Choose a tag to compare

What's Changed

Our latest minor release includes updates to align this artefact with version 1.26.0 of the Consumer Data Standards.

v1.1.0

03 Jul 01:02
06f689b
Compare
Choose a tag to compare

What's Changed

Our latest minor release includes updates to align this artefact with version 1.24.0 of the Consumer Data Standards.

v1.0.1

24 Feb 03:03
8d70a26
Compare
Choose a tag to compare

What's Changed

The update in this version includes some bug fixes regarding common APIs and urls with query parameters.

Bugfixes

  • Fixed #3 : The current implementation creates error messages in the cdrHeaderValidator function when a non-CDR endpoint is hit. Some of the Common APIs (e.g. Get Customer Detail) was not in that list and therefore an error was being returned.
  • Fixed #4 : Incorrect error messages were being returned for some API urls with query parameters.

v1.0.0

24 Feb 03:02
a1258c6
Compare
Choose a tag to compare

Hello World!

The Data Standards Body are thrilled to announce the release of the JS Holder SDK.

In line with the Australian Consumer Data Rights legislation the Data Standards Body defines a number of technical requirements on API endpoints for various industry sector. In particular the standard defines error payloads to be a specific format, containing specific error codes, etc. Because these error handling requirements across a large number of endpoints, coding these can be repetitive and therefore error prone.

This packages is a boilerplate implementation of these common requirements and it can be used in any NodeJS / ExpressJS application as middleware.

📚 Useful Resources
Please check out the package on the npm registry to learn more about this software development kit.