# Dataspace Models

This package defines the shared contracts and data types used across control plane and data plane components. It provides the common language that keeps request payloads, transfer records, and activity structures aligned between services and clients.

The exported interfaces and entities are designed to support consistent integration behaviour across the repository, reducing mismatch risks when components evolve.

## Installation

```shell
npm install @twin.org/dataspace-models
```

## Examples

Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)

## Reference

Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)

## Changelog

The changes between each version can be found in [docs/changelog.md](docs/changelog.md)