@twin.org/dataspace-models 0.0.3-next.18 → 0.0.3-next.19

package/README.md

@@ -1,6 +1,8 @@
-# TWIN Dataspace Models
+# Dataspace Models
 
-Models which define the structure of the dataspace contracts and connectors.
+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
 
@@ -8,48 +10,6 @@ Models which define the structure of the dataspace contracts and connectors.
 npm install @twin.org/dataspace-models
 ```
 
-## Overview
-
-This package provides the core interfaces and entities for the TWIN Dataspace Connector, implementing the Eclipse Dataspace Protocol (DSP) specification.
-
-### Key Components
-
-#### Control Plane
-
-- `IDataspaceControlPlaneComponent` - Interface for DSP protocol operations (negotiation, transfer management)
-- `IDataspaceControlPlaneResolverComponent` - Interface for resolving `consumerPid` to transfer context
-- `ITransferContext` - Transfer context containing datasetId, agreement, and policies
-- `TransferProcessEntity` - Entity storage model for transfer processes
-
-#### Data Plane
-
-- `IDataspaceDataPlaneComponent` - Interface for data access operations (GET/query entities)
-- `IDataspaceApp` - Interface for Dataspace Apps that handle specific datasets
-
-#### Shared Entities
-
-- `TransferProcessEntity` - Shared between Control Plane and Data Plane via entity storage
-  - Primary key: `id` (consumerPid)
-  - Stores: state, datasetId, agreement, dataAddress, token expiration
-  - Used for `consumerPid` flow
-
-### Architecture
-
-```text
-Control Plane                    Data Plane
-     │                               │
-     │ Creates/Updates               │ Reads
-     │                               │
-     └───── TransferProcessEntity ───┘
-                (shared storage)
-```
-
-The unified architecture enables:
-
-- Transfer-based access via `consumerPid` parameter
-- Shared state without resolver API calls
-- Policy enforcement from agreements
-
 ## Examples
 
 Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)

package/dist/es/dataTypes/dataspaceDataTypes.js

@@ -21,7 +21,10 @@ export class DataspaceDataTypes {
                 schema: DataspaceActivitySchema
             }
         ];
-        DataTypeHelper.registerTypes(DataspaceContexts.JsonSchemaNamespace, DataspaceContexts.JsonSchemaNamespace, types);
+        DataTypeHelper.registerTypes(DataspaceContexts.JsonSchemaNamespace, undefined, types.map(t => ({
+            type: `Dataspace${t.type}`,
+            schema: t.schema
+        })));
     }
 }
 //# sourceMappingURL=dataspaceDataTypes.js.map

package/dist/es/dataTypes/dataspaceDataTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"dataspaceDataTypes.js","sourceRoot":"","sources":["../../../src/dataTypes/dataspaceDataTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,uBAAuB,MAAM,mCAAmC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAE9F;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAC9B;;OAEG;IACI,MAAM,CAAC,aAAa;QAC1B,wBAAwB,CAAC,iBAAiB,EAAE,CAAC;QAC7C,wBAAwB,CAAC,aAAa,EAAE,CAAC;QAEzC,MAAM,KAAK,GAAG;YACb;gBACC,IAAI,EAAE,cAAc,CAAC,QAAQ;gBAC7B,MAAM,EAAE,uBAAuB;aAC/B;SACD,CAAC;QAEF,cAAc,CAAC,aAAa,CAC3B,iBAAiB,CAAC,mBAAmB,EACrC,iBAAiB,CAAC,mBAAmB,EACrC,KAAK,CACL,CAAC;IACH,CAAC;CACD","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\nimport { DataTypeHelper } from \"@twin.org/data-core\";\nimport { ActivityStreamsDataTypes } from \"@twin.org/standards-w3c-activity-streams\";\nimport { DataspaceContexts } from \"../models/dataspaceContexts.js\";\nimport { DataspaceTypes } from \"../models/dataspaceTypes.js\";\nimport DataspaceActivitySchema from \"../schemas/DataspaceActivity.json\" with { type: \"json\" };\n\n/**\n * Dataspace datatypes.\n */\nexport class DataspaceDataTypes {\n\t/**\n\t * Register all the data types.\n\t */\n\tpublic static registerTypes(): void {\n\t\tActivityStreamsDataTypes.registerRedirects();\n\t\tActivityStreamsDataTypes.registerTypes();\n\n\t\tconst types = [\n\t\t\t{\n\t\t\t\ttype: DataspaceTypes.Activity,\n\t\t\t\tschema: DataspaceActivitySchema\n\t\t\t}\n\t\t];\n\n\t\tDataTypeHelper.registerTypes(\n\t\t\tDataspaceContexts.JsonSchemaNamespace,\n\t\t\tDataspaceContexts.JsonSchemaNamespace,\n\t\t\ttypes\n\t\t);\n\t}\n}\n"]}
+{"version":3,"file":"dataspaceDataTypes.js","sourceRoot":"","sources":["../../../src/dataTypes/dataspaceDataTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,uBAAuB,MAAM,mCAAmC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAE9F;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAC9B;;OAEG;IACI,MAAM,CAAC,aAAa;QAC1B,wBAAwB,CAAC,iBAAiB,EAAE,CAAC;QAC7C,wBAAwB,CAAC,aAAa,EAAE,CAAC;QAEzC,MAAM,KAAK,GAAG;YACb;gBACC,IAAI,EAAE,cAAc,CAAC,QAAQ;gBAC7B,MAAM,EAAE,uBAAuB;aAC/B;SACD,CAAC;QAEF,cAAc,CAAC,aAAa,CAC3B,iBAAiB,CAAC,mBAAmB,EACrC,SAAS,EACT,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACf,IAAI,EAAE,YAAY,CAAC,CAAC,IAAI,EAAE;YAC1B,MAAM,EAAE,CAAC,CAAC,MAAM;SAChB,CAAC,CAAC,CACH,CAAC;IACH,CAAC;CACD","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\nimport { DataTypeHelper } from \"@twin.org/data-core\";\nimport { ActivityStreamsDataTypes } from \"@twin.org/standards-w3c-activity-streams\";\nimport { DataspaceContexts } from \"../models/dataspaceContexts.js\";\nimport { DataspaceTypes } from \"../models/dataspaceTypes.js\";\nimport DataspaceActivitySchema from \"../schemas/DataspaceActivity.json\" with { type: \"json\" };\n\n/**\n * Dataspace datatypes.\n */\nexport class DataspaceDataTypes {\n\t/**\n\t * Register all the data types.\n\t */\n\tpublic static registerTypes(): void {\n\t\tActivityStreamsDataTypes.registerRedirects();\n\t\tActivityStreamsDataTypes.registerTypes();\n\n\t\tconst types = [\n\t\t\t{\n\t\t\t\ttype: DataspaceTypes.Activity,\n\t\t\t\tschema: DataspaceActivitySchema\n\t\t\t}\n\t\t];\n\n\t\tDataTypeHelper.registerTypes(\n\t\t\tDataspaceContexts.JsonSchemaNamespace,\n\t\t\tundefined,\n\t\t\ttypes.map(t => ({\n\t\t\t\ttype: `Dataspace${t.type}`,\n\t\t\t\tschema: t.schema\n\t\t\t}))\n\t\t);\n\t}\n}\n"]}

package/dist/es/models/dataspaceContexts.js

@@ -5,6 +5,9 @@
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const DataspaceContexts = {
+    /**
+     * The namespace location of the hosted version of the JSON Schema.
+     */
     JsonSchemaNamespace: "https://schema.twindev.org/dataspace/"
 };
 //# sourceMappingURL=dataspaceContexts.js.map

package/dist/es/models/dataspaceContexts.js.map

@@ -1 +1 @@
-{"version":3,"file":"dataspaceContexts.js","sourceRoot":"","sources":["../../../src/models/dataspaceContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAChC,mBAAmB,EAAE,uCAAuC;CACnD,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts related to Dataspace\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DataspaceContexts = {\n\tJsonSchemaNamespace: \"https://schema.twindev.org/dataspace/\"\n} as const;\n\n/**\n * The types concerning dataspace.\n */\nexport type DataspaceContexts = (typeof DataspaceContexts)[keyof typeof DataspaceContexts];\n"]}
+{"version":3,"file":"dataspaceContexts.js","sourceRoot":"","sources":["../../../src/models/dataspaceContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAChC;;OAEG;IACH,mBAAmB,EAAE,uCAAuC;CACnD,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts related to Dataspace\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DataspaceContexts = {\n\t/**\n\t * The namespace location of the hosted version of the JSON Schema.\n\t */\n\tJsonSchemaNamespace: \"https://schema.twindev.org/dataspace/\"\n} as const;\n\n/**\n * The types concerning dataspace.\n */\nexport type DataspaceContexts = (typeof DataspaceContexts)[keyof typeof DataspaceContexts];\n"]}

package/dist/types/models/dataspaceContexts.d.ts

@@ -2,6 +2,9 @@
  * The contexts related to Dataspace
  */
 export declare const DataspaceContexts: {
+    /**
+     * The namespace location of the hosted version of the JSON Schema.
+     */
     readonly JsonSchemaNamespace: "https://schema.twindev.org/dataspace/";
 };
 /**

package/docs/changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.0.3-next.19](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.18...dataspace-models-v0.0.3-next.19) (2026-03-12)
+
+
+### Features
+
+* improve validation ([#82](https://github.com/twinfoundation/dataspace/issues/82)) ([8bfaf7b](https://github.com/twinfoundation/dataspace/commit/8bfaf7b830f89b63575f8a51ee96bd8ac4da02f4))
+
 ## [0.0.3-next.18](https://github.com/twinfoundation/dataspace/compare/dataspace-models-v0.0.3-next.17...dataspace-models-v0.0.3-next.18) (2026-03-09)
 
 

package/docs/examples.md

@@ -1 +1,33 @@
-# @twin.org/dataspace-models - Examples
+# Models Examples
+
+Use these snippets to register dataspace data types and shape transfer process records for shared persistence.
+
+## DataspaceDataTypes
+
+```typescript
+import { DataspaceDataTypes } from '@twin.org/dataspace-models';
+
+DataspaceDataTypes.registerTypes();
+console.log('registered'); // registered
+```
+
+## TransferProcess
+
+```typescript
+import { TransferProcess } from '@twin.org/dataspace-models';
+
+const process = new TransferProcess();
+process.id = 'tp-001';
+process.consumerPid = 'consumer-process-id';
+process.providerPid = 'provider-process-id';
+process.agreementId = 'urn:agreement:001';
+process.datasetId = 'https://twin.example.org/data-service-1';
+process.offerId = 'urn:policy:test-offer-read-consignment';
+process.state = 'REQUESTED';
+process.dateCreated = new Date().toISOString();
+process.dateModified = process.dateCreated;
+process.callbackAddress = 'https://consumer.example/dsp/callback';
+
+console.log(process.consumerPid); // consumer-process-id
+console.log(process.state); // REQUESTED
+```

package/docs/reference/variables/DataspaceContexts.md

@@ -9,3 +9,5 @@ The contexts related to Dataspace
 ### JsonSchemaNamespace
 
 > `readonly` **JsonSchemaNamespace**: `"https://schema.twindev.org/dataspace/"` = `"https://schema.twindev.org/dataspace/"`
+
+The namespace location of the hosted version of the JSON Schema.

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/dataspace-models",
-	"version": "0.0.3-next.18",
-	"description": "Models which define the structure of the Dataspace (Control Plane and Data Plane)",
+	"version": "0.0.3-next.19",
+	"description": "Defines shared entities, interfaces, and data types used by control plane and data plane components.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/dataspace.git",