CDS Type Definition Library

Overview

This fork of the DefinitelyTyped repository contains specialised type definitions for the Consumer Data Standards (CDS) to support TypeScript projects within the CDR ecosystem. These definitions are aligned with the published Consumer Data Standards, ensuring accurate interface representations for CDR API structures.

Using the Type Definitions

The Data Standards Body publishes the Type Definitions as a npm package. To use these type definitions in your TypeScript projects, you can install them via npm as part of your development dependencies. Please refer to the Quick Start Guide section below for more information.

This tool:

is maintained regularly to ensure compatibility with the latest Consumer Data Standards.
assists Data Holders with regulatory adherence by providing TypeScript type enforcement that reduces errors, increases code quality, and improves development efficiency.

Quick Start Guide

Please follow these steps to integrate the CDR-specific type definitions into your TypeScript projects:

Install via npm or Yarn: Depending on your preference, you can use npm or Yarn to install the CDS type definitions package published to npm.
bash
```
npm install @types/consumer-data-standards
```
Or
bash
```
yarn install @types/consumer-data-standards
```

Usage: Utilise the types in your TypeScript code as needed:

tsx

import { YourType } from "your-package";

function processData(data: YourType) {
    // your code here
}

Stay Updated: Regularly check for updates to ensure you have the latest type definitions.

Reporting Issues

Encountered an issue? We're here to help. Please visit our issue reporting guidelines for submitting an issue.

Stay Updated

Join our newsletter to receive the latest updates, release notes, and alerts. Subscribe here.

Disclaimer

The artefacts in this repository are offered without warranty or liability, in accordance with the MIT licence.

The Data Standards Body (DSB) develops these artefacts in the course of its work, in order to perform quality assurance on the Australian Consumer Data Right Standards (Data Standards).

The DSB makes this repository, and its artefacts, public on a non-commercial basis in the interest of supporting the participants in the CDR ecosystem.

The resources of the DSB are primarily directed towards assisting the Data Standards Chair for developing the Data Standards.

Consequently, the development work provided on the artefacts in this repository is on a best-effort basis, and the DSB acknowledges the use of these tools alone is not sufficient for, nor should they be relied upon with respect to accreditation, conformance, or compliance purposes.