@twin.org/dataspace-models 0.0.3-next.15

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,63 @@
+# TWIN Dataspace Models
+
+Models which define the structure of the dataspace contracts and connectors.
+
+## Installation
+
+```shell
+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)
+
+## 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)

package/dist/es/entities/transferProcess.js

@@ -0,0 +1,137 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { entity, property, SortDirection } from "@twin.org/entity";
+/**
+ * Transfer Process for shared storage between Control Plane and Data Plane.
+ * This entity is the persistent representation of ITransferProcess.
+ */
+let TransferProcess = class TransferProcess {
+    /**
+     * The consumer PID is the primary key.
+     * Used for direct lookup by consumerPid.
+     */
+    consumerPid;
+    /**
+     * Internal UUID for storage (secondary key for providerPid lookup).
+     */
+    id;
+    /**
+     * Provider Process ID from the DSP protocol.
+     * Indexed for lookup by providerPid.
+     */
+    providerPid;
+    /**
+     * Agreement ID linking to the rights-management Agreement.
+     */
+    agreementId;
+    /**
+     * Transfer Process state from the DSP protocol.
+     * One of: REQUESTED, STARTED, COMPLETED, SUSPENDED, TERMINATED.
+     */
+    state;
+    /**
+     * Dataset ID for DSC resolution.
+     */
+    datasetId;
+    /**
+     * Offer ID from the original Catalog offer.
+     */
+    offerId;
+    /**
+     * Consumer identity (DID or URI).
+     */
+    consumerIdentity;
+    /**
+     * Provider identity (DID or URI).
+     */
+    providerIdentity;
+    /**
+     * Data format from the Dataset Distribution.
+     */
+    format;
+    /**
+     * Callback address for Consumer notifications.
+     */
+    callbackAddress;
+    /**
+     * Creation timestamp (ISO string format).
+     */
+    dateCreated;
+    /**
+     * Last update timestamp (ISO string format).
+     */
+    dateModified;
+    /**
+     * Policies from the Agreement (stored as JSON).
+     */
+    policies;
+    /**
+     * Data address for push mode transfers (stored as JSON).
+     */
+    dataAddress;
+};
+__decorate([
+    property({ type: "string", isPrimary: true }),
+    __metadata("design:type", String)
+], TransferProcess.prototype, "consumerPid", void 0);
+__decorate([
+    property({ type: "string" }),
+    __metadata("design:type", String)
+], TransferProcess.prototype, "id", void 0);
+__decorate([
+    property({ type: "string", isSecondary: true }),
+    __metadata("design:type", String)
+], TransferProcess.prototype, "providerPid", void 0);
+__decorate([
+    property({ type: "string" }),
+    __metadata("design:type", String)
+], TransferProcess.prototype, "agreementId", void 0);
+__decorate([
+    property({ type: "string" }),
+    __metadata("design:type", String)
+], TransferProcess.prototype, "state", void 0);
+__decorate([
+    property({ type: "string" }),
+    __metadata("design:type", String)
+], TransferProcess.prototype, "datasetId", void 0);
+__decorate([
+    property({ type: "string" }),
+    __metadata("design:type", String)
+], TransferProcess.prototype, "offerId", void 0);
+__decorate([
+    property({ type: "string", optional: true }),
+    __metadata("design:type", String)
+], TransferProcess.prototype, "consumerIdentity", void 0);
+__decorate([
+    property({ type: "string", optional: true }),
+    __metadata("design:type", String)
+], TransferProcess.prototype, "providerIdentity", void 0);
+__decorate([
+    property({ type: "string", optional: true }),
+    __metadata("design:type", String)
+], TransferProcess.prototype, "format", void 0);
+__decorate([
+    property({ type: "string", optional: true }),
+    __metadata("design:type", String)
+], TransferProcess.prototype, "callbackAddress", void 0);
+__decorate([
+    property({ type: "string", format: "date-time", sortDirection: SortDirection.Descending }),
+    __metadata("design:type", String)
+], TransferProcess.prototype, "dateCreated", void 0);
+__decorate([
+    property({ type: "string", format: "date-time" }),
+    __metadata("design:type", String)
+], TransferProcess.prototype, "dateModified", void 0);
+__decorate([
+    property({ type: "array", format: "json", optional: true }),
+    __metadata("design:type", Array)
+], TransferProcess.prototype, "policies", void 0);
+__decorate([
+    property({ type: "object", format: "json", optional: true }),
+    __metadata("design:type", Object)
+], TransferProcess.prototype, "dataAddress", void 0);
+TransferProcess = __decorate([
+    entity()
+], TransferProcess);
+export { TransferProcess };
+//# sourceMappingURL=transferProcess.js.map

package/dist/es/entities/transferProcess.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transferProcess.js","sourceRoot":"","sources":["../../../src/entities/transferProcess.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAOnE;;;GAGG;AAEI,IAAM,eAAe,GAArB,MAAM,eAAe;IAC3B;;;OAGG;IAEI,WAAW,CAAU;IAE5B;;OAEG;IAEI,EAAE,CAAU;IAEnB;;;OAGG;IAEI,WAAW,CAAU;IAE5B;;OAEG;IAEI,WAAW,CAAU;IAE5B;;;OAGG;IAEI,KAAK,CAA6C;IAEzD;;OAEG;IAEI,SAAS,CAAU;IAE1B;;OAEG;IAEI,OAAO,CAAU;IAExB;;OAEG;IAEI,gBAAgB,CAAU;IAEjC;;OAEG;IAEI,gBAAgB,CAAU;IAEjC;;OAEG;IAEI,MAAM,CAAU;IAEvB;;OAEG;IAEI,eAAe,CAAU;IAEhC;;OAEG;IAEI,WAAW,CAAU;IAE5B;;OAEG;IAEI,YAAY,CAAU;IAE7B;;OAEG;IAEI,QAAQ,CAAiB;IAEhC;;OAEG;IAEI,WAAW,CAAiC;CACnD,CAAA;AAvFO;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;;oDAClB;AAMrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;2CACV;AAOZ;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;;oDACpB;AAMrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;oDACD;AAOrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;8CAC4B;AAMlD;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;kDACH;AAMnB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;gDACL;AAMjB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yDACZ;AAM1B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yDACZ;AAM1B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+CACtB;AAMhB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;wDACb;AAMzB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,CAAC,UAAU,EAAE,CAAC;;oDAC/D;AAMrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;;qDACrB;AAMtB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDAC5B;AAMzB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDACV;AA5FvC,eAAe;IAD3B,MAAM,EAAE;GACI,eAAe,CA6F3B","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { entity, property, SortDirection } from \"@twin.org/entity\";\nimport type {\n\tDataspaceProtocolTransferProcessStateType,\n\tIDataspaceProtocolDataAddress\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { IOdrlPolicy } from \"@twin.org/standards-w3c-odrl\";\n\n/**\n * Transfer Process for shared storage between Control Plane and Data Plane.\n * This entity is the persistent representation of ITransferProcess.\n */\n@entity()\nexport class TransferProcess {\n\t/**\n\t * The consumer PID is the primary key.\n\t * Used for direct lookup by consumerPid.\n\t */\n\t@property({ type: \"string\", isPrimary: true })\n\tpublic consumerPid!: string;\n\n\t/**\n\t * Internal UUID for storage (secondary key for providerPid lookup).\n\t */\n\t@property({ type: \"string\" })\n\tpublic id!: string;\n\n\t/**\n\t * Provider Process ID from the DSP protocol.\n\t * Indexed for lookup by providerPid.\n\t */\n\t@property({ type: \"string\", isSecondary: true })\n\tpublic providerPid!: string;\n\n\t/**\n\t * Agreement ID linking to the rights-management Agreement.\n\t */\n\t@property({ type: \"string\" })\n\tpublic agreementId!: string;\n\n\t/**\n\t * Transfer Process state from the DSP protocol.\n\t * One of: REQUESTED, STARTED, COMPLETED, SUSPENDED, TERMINATED.\n\t */\n\t@property({ type: \"string\" })\n\tpublic state!: DataspaceProtocolTransferProcessStateType;\n\n\t/**\n\t * Dataset ID for DSC resolution.\n\t */\n\t@property({ type: \"string\" })\n\tpublic datasetId!: string;\n\n\t/**\n\t * Offer ID from the original Catalog offer.\n\t */\n\t@property({ type: \"string\" })\n\tpublic offerId!: string;\n\n\t/**\n\t * Consumer identity (DID or URI).\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic consumerIdentity?: string;\n\n\t/**\n\t * Provider identity (DID or URI).\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic providerIdentity?: string;\n\n\t/**\n\t * Data format from the Dataset Distribution.\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic format?: string;\n\n\t/**\n\t * Callback address for Consumer notifications.\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic callbackAddress?: string;\n\n\t/**\n\t * Creation timestamp (ISO string format).\n\t */\n\t@property({ type: \"string\", format: \"date-time\", sortDirection: SortDirection.Descending })\n\tpublic dateCreated!: string;\n\n\t/**\n\t * Last update timestamp (ISO string format).\n\t */\n\t@property({ type: \"string\", format: \"date-time\" })\n\tpublic dateModified!: string;\n\n\t/**\n\t * Policies from the Agreement (stored as JSON).\n\t */\n\t@property({ type: \"array\", format: \"json\", optional: true })\n\tpublic policies?: IOdrlPolicy[];\n\n\t/**\n\t * Data address for push mode transfers (stored as JSON).\n\t */\n\t@property({ type: \"object\", format: \"json\", optional: true })\n\tpublic dataAddress?: IDataspaceProtocolDataAddress;\n}\n"]}

package/dist/es/factories/dataspaceAppFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@twin.org/core";
+/**
+ * Factory for creating dataspace apps.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const DataspaceAppFactory = Factory.createFactory("dataspace-app");
+//# sourceMappingURL=dataspaceAppFactory.js.map

package/dist/es/factories/dataspaceAppFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataspaceAppFactory.js","sourceRoot":"","sources":["../../../src/factories/dataspaceAppFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG,OAAO,CAAC,aAAa,CAAgB,eAAe,CAAC,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IDataspaceApp } from \"../models/app/IDataspaceApp.js\";\n\n/**\n * Factory for creating dataspace apps.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DataspaceAppFactory = Factory.createFactory<IDataspaceApp>(\"dataspace-app\");\n"]}

package/dist/es/index.js

@@ -0,0 +1,58 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+// Entity exports
+export * from "./entities/transferProcess.js";
+// Control Plane exports
+export * from "./models/control-plane/IDataspaceControlPlaneComponent.js";
+export * from "./models/control-plane/IDataspaceControlPlaneResolverComponent.js";
+export * from "./models/control-plane/INegotiationCallback.js";
+export * from "./models/control-plane/ITransferProcess.js";
+export * from "./models/control-plane/transferProcessRole.js";
+export * from "./models/control-plane/ITransferContext.js";
+export * from "./models/control-plane/api/ITransferContextResponse.js";
+// Data Plane exports
+export * from "./models/data-plane/IDataspaceDataPlaneComponent.js";
+// App exports
+export * from "./factories/dataspaceAppFactory.js";
+export * from "./models/app/IDataspaceApp.js";
+// Other exports
+export * from "./models/activityProcessingStatus.js";
+export * from "./models/api/IActivityLogEntryGetRequest.js";
+export * from "./models/api/IActivityLogEntryGetResponse.js";
+export * from "./models/api/IActivityLogStatusNotificationPayload.js";
+export * from "./models/api/IActivityLogStatusRequest.js";
+export * from "./models/api/IActivityStreamNotifyRequest.js";
+export * from "./models/api/IDataAssetEntitiesResponse.js";
+export * from "./models/api/IDataAssetGetEntitiesRequest.js";
+export * from "./models/api/IDataAssetQueryRequest.js";
+// Control Plane API exports - Transfer Process Protocol
+export * from "./models/api/control-plane/IRequestTransferRequest.js";
+export * from "./models/api/control-plane/IRequestTransferResponse.js";
+export * from "./models/api/control-plane/IStartTransferRequest.js";
+export * from "./models/api/control-plane/IStartTransferResponse.js";
+export * from "./models/api/control-plane/ICompleteTransferRequest.js";
+export * from "./models/api/control-plane/ICompleteTransferResponse.js";
+export * from "./models/api/control-plane/ISuspendTransferRequest.js";
+export * from "./models/api/control-plane/ISuspendTransferResponse.js";
+export * from "./models/api/control-plane/ITerminateTransferRequest.js";
+export * from "./models/api/control-plane/ITerminateTransferResponse.js";
+export * from "./models/api/control-plane/IGetTransferProcessRequest.js";
+export * from "./models/api/control-plane/IGetTransferProcessResponse.js";
+export * from "./models/app/dataRequestType.js";
+export * from "./models/app/IActivityQuery.js";
+export * from "./models/app/IDataAssetEntitiesRequest.js";
+export * from "./models/app/IDataAssetQuery.js";
+export * from "./models/app/IQueryDataAssetRequest.js";
+export * from "./models/app/IDataRequest.js";
+export * from "./models/IActivityLogDates.js";
+export * from "./models/IActivityLogDetails.js";
+export * from "./models/IActivityLogEntry.js";
+export * from "./models/IActivityLogStatusNotification.js";
+export * from "./models/IActivityTask.js";
+export * from "./models/IDataAssetItemList.js";
+export * from "./models/IDataAssetItemListResult.js";
+export * from "./models/IEntitySet.js";
+export * from "./models/IExecutionPayload.js";
+export * from "./models/IFilteringQuery.js";
+export * from "./models/ITaskApp.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC,iBAAiB;AACjB,cAAc,+BAA+B,CAAC;AAE9C,wBAAwB;AACxB,cAAc,2DAA2D,CAAC;AAC1E,cAAc,mEAAmE,CAAC;AAClF,cAAc,gDAAgD,CAAC;AAC/D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,wDAAwD,CAAC;AAEvE,qBAAqB;AACrB,cAAc,qDAAqD,CAAC;AAEpE,cAAc;AACd,cAAc,oCAAoC,CAAC;AACnD,cAAc,+BAA+B,CAAC;AAE9C,gBAAgB;AAChB,cAAc,sCAAsC,CAAC;AACrD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,uDAAuD,CAAC;AACtE,cAAc,2CAA2C,CAAC;AAC1D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,wCAAwC,CAAC;AAEvD,wDAAwD;AACxD,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,qDAAqD,CAAC;AACpE,cAAc,sDAAsD,CAAC;AACrE,cAAc,wDAAwD,CAAC;AACvE,cAAc,yDAAyD,CAAC;AACxE,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,yDAAyD,CAAC;AACxE,cAAc,0DAA0D,CAAC;AACzE,cAAc,0DAA0D,CAAC;AACzE,cAAc,2DAA2D,CAAC;AAE1E,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,2CAA2C,CAAC;AAC1D,cAAc,iCAAiC,CAAC;AAChD,cAAc,wCAAwC,CAAC;AACvD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sCAAsC,CAAC;AACrD,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sBAAsB,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n// Entity exports\nexport * from \"./entities/transferProcess.js\";\n\n// Control Plane exports\nexport * from \"./models/control-plane/IDataspaceControlPlaneComponent.js\";\nexport * from \"./models/control-plane/IDataspaceControlPlaneResolverComponent.js\";\nexport * from \"./models/control-plane/INegotiationCallback.js\";\nexport * from \"./models/control-plane/ITransferProcess.js\";\nexport * from \"./models/control-plane/transferProcessRole.js\";\nexport * from \"./models/control-plane/ITransferContext.js\";\nexport * from \"./models/control-plane/api/ITransferContextResponse.js\";\n\n// Data Plane exports\nexport * from \"./models/data-plane/IDataspaceDataPlaneComponent.js\";\n\n// App exports\nexport * from \"./factories/dataspaceAppFactory.js\";\nexport * from \"./models/app/IDataspaceApp.js\";\n\n// Other exports\nexport * from \"./models/activityProcessingStatus.js\";\nexport * from \"./models/api/IActivityLogEntryGetRequest.js\";\nexport * from \"./models/api/IActivityLogEntryGetResponse.js\";\nexport * from \"./models/api/IActivityLogStatusNotificationPayload.js\";\nexport * from \"./models/api/IActivityLogStatusRequest.js\";\nexport * from \"./models/api/IActivityStreamNotifyRequest.js\";\nexport * from \"./models/api/IDataAssetEntitiesResponse.js\";\nexport * from \"./models/api/IDataAssetGetEntitiesRequest.js\";\nexport * from \"./models/api/IDataAssetQueryRequest.js\";\n\n// Control Plane API exports - Transfer Process Protocol\nexport * from \"./models/api/control-plane/IRequestTransferRequest.js\";\nexport * from \"./models/api/control-plane/IRequestTransferResponse.js\";\nexport * from \"./models/api/control-plane/IStartTransferRequest.js\";\nexport * from \"./models/api/control-plane/IStartTransferResponse.js\";\nexport * from \"./models/api/control-plane/ICompleteTransferRequest.js\";\nexport * from \"./models/api/control-plane/ICompleteTransferResponse.js\";\nexport * from \"./models/api/control-plane/ISuspendTransferRequest.js\";\nexport * from \"./models/api/control-plane/ISuspendTransferResponse.js\";\nexport * from \"./models/api/control-plane/ITerminateTransferRequest.js\";\nexport * from \"./models/api/control-plane/ITerminateTransferResponse.js\";\nexport * from \"./models/api/control-plane/IGetTransferProcessRequest.js\";\nexport * from \"./models/api/control-plane/IGetTransferProcessResponse.js\";\n\nexport * from \"./models/app/dataRequestType.js\";\nexport * from \"./models/app/IActivityQuery.js\";\nexport * from \"./models/app/IDataAssetEntitiesRequest.js\";\nexport * from \"./models/app/IDataAssetQuery.js\";\nexport * from \"./models/app/IQueryDataAssetRequest.js\";\nexport * from \"./models/app/IDataRequest.js\";\nexport * from \"./models/IActivityLogDates.js\";\nexport * from \"./models/IActivityLogDetails.js\";\nexport * from \"./models/IActivityLogEntry.js\";\nexport * from \"./models/IActivityLogStatusNotification.js\";\nexport * from \"./models/IActivityTask.js\";\nexport * from \"./models/IDataAssetItemList.js\";\nexport * from \"./models/IDataAssetItemListResult.js\";\nexport * from \"./models/IEntitySet.js\";\nexport * from \"./models/IExecutionPayload.js\";\nexport * from \"./models/IFilteringQuery.js\";\nexport * from \"./models/ITaskApp.js\";\n"]}

package/dist/es/models/IActivityLogDates.js

@@ -0,0 +1,4 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IActivityLogDates.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IActivityLogDates.js","sourceRoot":"","sources":["../../../src/models/IActivityLogDates.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Activity log dates.\n */\nexport interface IActivityLogDates {\n\t/**\n\t * Task processing start timestamp\n\t */\n\tstartDate: string;\n\n\t/**\n\t * Task processing end timestamp\n\t */\n\tendDate?: string;\n}\n"]}

package/dist/es/models/IActivityLogDetails.js

@@ -0,0 +1,4 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IActivityLogDetails.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IActivityLogDetails.js","sourceRoot":"","sources":["../../../src/models/IActivityLogDetails.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The details related to the processing of an Activity\n */\nexport interface IActivityLogDetails {\n\t/**\n\t * The Id of the Activity Log entry.\n\t */\n\tid: string;\n\n\t/**\n\t * The activity Id that this entry refers to.\n\t */\n\tactivityId?: string;\n\n\t/**\n\t * The identity of the Activity's generator.\n\t */\n\tgenerator: string;\n\n\t/**\n\t * The creation date of this object.\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The last update date of this object.\n\t */\n\tdateModified: string;\n\n\t/**\n\t * Number of times this activity has been retried.\n\t */\n\tretryCount?: number;\n}\n"]}

package/dist/es/models/IActivityLogEntry.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IActivityLogEntry.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IActivityLogEntry.js","sourceRoot":"","sources":["../../../src/models/IActivityLogEntry.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IError } from \"@twin.org/core\";\nimport type { ActivityProcessingStatus } from \"./activityProcessingStatus.js\";\nimport type { IActivityLogDates } from \"./IActivityLogDates.js\";\nimport type { IActivityLogDetails } from \"./IActivityLogDetails.js\";\nimport type { ITaskApp } from \"./ITaskApp.js\";\n\n/**\n * The details related to the processing of an Activity\n */\nexport interface IActivityLogEntry extends IActivityLogDetails {\n\t/**\n\t * Status of the Activity Processing.\n\t */\n\tstatus: ActivityProcessingStatus;\n\t/**\n\t * The pending tasks that have to be run to process the Activity.\n\t */\n\tpendingTasks?: ITaskApp[];\n\n\t/**\n\t * The running tasks that are processing the Activity.\n\t */\n\trunningTasks?: (ITaskApp & IActivityLogDates)[];\n\n\t/**\n\t * The tasks that have already finalized.\n\t */\n\tfinalizedTasks?: (ITaskApp &\n\t\tIActivityLogDates & {\n\t\t\t/**\n\t\t\t * The task result.\n\t\t\t */\n\t\t\tresult: string;\n\t\t})[];\n\n\t/**\n\t * The tasks that are in error.\n\t */\n\tinErrorTasks?: (ITaskApp & {\n\t\t/**\n\t\t * The error that happened\n\t\t */\n\t\terror: IError;\n\t})[];\n}\n"]}

package/dist/es/models/IActivityLogStatusNotification.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IActivityLogStatusNotification.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IActivityLogStatusNotification.js","sourceRoot":"","sources":["../../../src/models/IActivityLogStatusNotification.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { TaskStatus } from \"@twin.org/background-task-models\";\n\n/**\n * The status supplied to clients of the Dataspace Data Plane\n */\nexport interface IActivityLogStatusNotification {\n\t/**\n\t * The activity log entry id.\n\t */\n\tactivityLogEntryId: string;\n\n\t/**\n\t * The activity Id.\n\t */\n\tactivityId?: string;\n\n\t/**\n\t * The activity processing status through the associated tasks.\n\t */\n\ttaskProcessingStatus: {\n\t\t/**\n\t\t * The task reported.\n\t\t */\n\t\ttaskId: string;\n\n\t\t/**\n\t\t * The Dataspace App.\n\t\t */\n\t\tdataspaceAppId: string;\n\n\t\t/**\n\t\t * The status of the task reported. Only terminated and error are reported.\n\t\t */\n\t\ttaskStatus: TaskStatus;\n\t};\n}\n"]}

package/dist/es/models/IActivityTask.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IActivityTask.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IActivityTask.js","sourceRoot":"","sources":["../../../src/models/IActivityTask.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ITaskApp } from \"./ITaskApp.js\";\n\n/**\n * Denotes a task associated with an Activity\n */\nexport interface IActivityTask {\n\t/**\n\t * The activity log entry.\n\t */\n\tactivityLogEntryId: string;\n\n\t/**\n\t * The associated tasks\n\t */\n\tassociatedTasks: ITaskApp[];\n}\n"]}

package/dist/es/models/IDataAssetItemList.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDataAssetItemList.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDataAssetItemList.js","sourceRoot":"","sources":["../../../src/models/IDataAssetItemList.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { SchemaOrgContexts, SchemaOrgTypes } from \"@twin.org/standards-schema-org\";\n\n/**\n * Interface describing a list of entities that are within a Data Asset.\n * Pagination is handled via HTTP Link headers.\n */\nexport interface IDataAssetItemList {\n\t/**\n\t * The LD Context.\n\t */\n\t\"@context\": typeof SchemaOrgContexts.Context;\n\n\t/**\n\t * The type\n\t */\n\ttype: typeof SchemaOrgTypes.ItemList;\n\n\t/**\n\t * The components of the Collection\n\t *\n\t */\n\t[SchemaOrgTypes.ItemListElement]: IJsonLdNodeObject[];\n}\n"]}

package/dist/es/models/IDataAssetItemListResult.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDataAssetItemListResult.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IDataAssetItemListResult.js","sourceRoot":"","sources":["../../../src/models/IDataAssetItemListResult.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataAssetItemList } from \"./IDataAssetItemList.js\";\n\n/**\n * Result containing the data asset item list and optional pagination cursor.\n * The cursor is returned via HTTP Link headers (RFC 8288), not in the response body.\n */\nexport interface IDataAssetItemListResult {\n\t/**\n\t * The item list data.\n\t */\n\titemList: IDataAssetItemList;\n\n\t/**\n\t * Pagination cursor for retrieving the next page.\n\t * This is used to generate the Link header, not included in the response body.\n\t */\n\tcursor?: string;\n}\n"]}

package/dist/es/models/IEntitySet.js

@@ -0,0 +1,4 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IEntitySet.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IEntitySet.js","sourceRoot":"","sources":["../../../src/models/IEntitySet.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Part of the Data Request interface to represent a set of entities either by id or by type\n */\nexport interface IEntitySet {\n\t/**\n\t * Entity Id.\n\t */\n\tentityId?: string[];\n\n\t/**\n\t * The entity type.\n\t */\n\tentityType: string;\n}\n"]}

package/dist/es/models/IExecutionPayload.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IExecutionPayload.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IExecutionPayload.js","sourceRoot":"","sources":["../../../src/models/IExecutionPayload.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IActivityStreamsActivity } from \"@twin.org/standards-w3c-activity-streams\";\n\n/**\n * Execution payload.\n */\nexport interface IExecutionPayload {\n\t/**\n\t * The Activity Log Entry Id.\n\t */\n\tactivityLogEntryId: string;\n\n\t/**\n\t * The activity\n\t */\n\tactivity: IActivityStreamsActivity;\n\n\t/**\n\t * The executor App.\n\t */\n\texecutorApp: string;\n}\n"]}

package/dist/es/models/IFilteringQuery.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IFilteringQuery.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IFilteringQuery.js","sourceRoot":"","sources":["../../../src/models/IFilteringQuery.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\n\n/**\n * A query over a data asset that to be processed by a Dataspace Data Plane App.\n */\nexport interface IFilteringQuery {\n\t/**\n\t * The query type.\n\t */\n\ttype: string;\n\n\t/**\n\t * The representation of the query.\n\t */\n\tq: unknown;\n\n\t/**\n\t * The JSON-LD context to be applied over the query terms.\n\t */\n\tjsonLdContext?: IJsonLdContextDefinitionElement[];\n}\n"]}

package/dist/es/models/ITaskApp.js

@@ -0,0 +1,4 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ITaskApp.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ITaskApp.js","sourceRoot":"","sources":["../../../src/models/ITaskApp.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Denotes a task associated with a Dataspace App\n */\nexport interface ITaskApp {\n\t/**\n\t * Task Id.\n\t */\n\ttaskId: string;\n\n\t/**\n\t * Dataspace App Id.\n\t */\n\tdataspaceAppId: string;\n}\n"]}

package/dist/es/models/activityProcessingStatus.js

@@ -0,0 +1,29 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Activity processing statuses.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const ActivityProcessingStatus = {
+    /**
+     * Pending: Activity Processing has not started yet.
+     */
+    Pending: "pending",
+    /**
+     * Running Activity processing is running.
+     */
+    Running: "running",
+    /**
+     * Completed: Activity processing completed without error.
+     */
+    Completed: "completed",
+    /**
+     * Error: Activity processing cannot be performed and marked as in error. (Depends on application).
+     */
+    Error: "error",
+    /**
+     * Transient state. The background tasks associated with the activity are still being registered.
+     */
+    Registering: "registering"
+};
+//# sourceMappingURL=activityProcessingStatus.js.map