@twin.org/dataspace-models 0.0.3-next.21 → 0.0.3-next.23

package/dist/es/models/control-plane/IDataspaceControlPlaneResolverComponent.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IDataspaceControlPlaneResolverComponent.js","sourceRoot":"","sources":["../../../../src/models/control-plane/IDataspaceControlPlaneResolverComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { ITransferContext } from \"./ITransferContext.js\";\n\n/**\n * Dataspace Control Plane Resolver Component interface.\n * Provides methods for resolving transfer process information.\n * Used by dataspace-data-plane to retrieve dataset and policy information for data access.\n *\n * These methods are NOT part of the Eclipse Dataspace Protocol specification.\n * They are TWIN-specific extensions for internal service communication.\n *\n * IMPORTANT: This interface has NO REST client implementation - methods are only\n * accessible via ComponentFactory.get() for local, in-process service access.\n */\nexport interface IDataspaceControlPlaneResolverComponent extends IComponent {\n\t/**\n\t * Resolve consumerPid to Transfer Context.\n\t * Returns Transfer Context with Agreement, datasetId, and Transfer Process metadata.\n\t * Validates that Agreement assigner matches current organization ID for security.\n\t * This method is called by the dataspace-data-plane to resolve a consumerPid\n\t * to the corresponding Agreement and dataset information for data retrieval (pull mode).\n\t *\n\t * This method is only available via ComponentFactory.get().\n\t * There is no REST client implementation.\n\t *\n\t * @param consumerPid Consumer Process ID from the transfer request.\n\t * @param trustPayload Trust payload containing authorization information (JWT, VC, etc.).\n\t * The trust service handles verification and extracts identity and token.\n\t * @returns Transfer Context with Agreement, datasetId, and Transfer Process metadata.\n\t * @throws NotFoundError if Transfer Process not found.\n\t * @throws UnauthorizedError if trust verification fails or Agreement assigner doesn't match current organization.\n\t * @throws GeneralError if Transfer Process is terminated or Agreement lookup fails.\n\t */\n\tresolveConsumerPid(consumerPid: string, trustPayload: unknown): Promise<ITransferContext>;\n\n\t/**\n\t * Resolve providerPid to Transfer Context.\n\t * Returns Transfer Context with Agreement, datasetId, and Transfer Process metadata.\n\t * Used for push mode data transfer where Provider needs to push data to Consumer via Activity Stream.\n\t * Validates that Agreement assigner matches current organization ID and assignee matches expected consumer for security.\n\t *\n\t * This method is called by the Provider's dataspace-data-plane when it receives an Activity\n\t * referencing a providerPid and needs to resolve it to get Agreement, dataset, and consumer's dataAddress.\n\t *\n\t * This method is only available via ComponentFactory.get().\n\t * There is no REST client implementation.\n\t *\n\t * @param providerPid Provider Process ID from the transfer process.\n\t * @param trustPayload Trust payload containing authorization information (JWT, VC, etc.).\n\t * The trust service handles verification and extracts identity and token.\n\t * @returns Transfer Context with Agreement, datasetId, and Transfer Process metadata.\n\t * @throws NotFoundError if Transfer Process not found.\n\t * @throws UnauthorizedError if trust verification fails, Agreement assigner doesn't match current organization, or assignee doesn't match expected consumer.\n\t * @throws GeneralError if Transfer Process is terminated or Agreement lookup fails.\n\t */\n\tresolveProviderPid(providerPid: string, trustPayload: unknown): Promise<ITransferContext>;\n}\n"]}

package/dist/es/models/control-plane/INegotiationCallback.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"INegotiationCallback.js","sourceRoot":"","sources":["../../../../src/models/control-plane/INegotiationCallback.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tDataspaceProtocolContractNegotiationStateType,\n\tIDataspaceProtocolAgreement,\n\tIDataspaceProtocolOffer\n} from \"@twin.org/standards-dataspace-protocol\";\n\n/**\n * Callback interface for negotiation state change notifications.\n * Upstream modules register an implementation of this interface\n * via IDataspaceControlPlaneComponent.registerNegotiationCallback()\n * to be notified when PNP callbacks fire.\n */\nexport interface INegotiationCallback {\n\t/**\n\t * Called when the negotiation state changes (offer received, agreement received).\n\t * @param negotiationId The negotiation ID.\n\t * @param state The new state.\n\t * @param data Optional data associated with the state change.\n\t * @param data.offer The offer received from the provider.\n\t * @param data.agreement The agreement received from the provider.\n\t * @returns Nothing.\n\t */\n\tonStateChanged(\n\t\tnegotiationId: string,\n\t\tstate: DataspaceProtocolContractNegotiationStateType,\n\t\tdata?: { offer?: IDataspaceProtocolOffer; agreement?: IDataspaceProtocolAgreement }\n\t): Promise<void>;\n\n\t/**\n\t * Called when the negotiation completes successfully (finalized).\n\t * @param negotiationId The negotiation ID.\n\t * @param agreementId The agreement ID (from agreement.uid).\n\t * @returns Nothing.\n\t */\n\tonCompleted(negotiationId: string, agreementId: string): Promise<void>;\n\n\t/**\n\t * Called when the negotiation fails (terminated or stalled).\n\t * @param negotiationId The negotiation ID.\n\t * @param reason The failure reason.\n\t * @returns Nothing.\n\t */\n\tonFailed(negotiationId: string, reason: string): Promise<void>;\n}\n"]}

package/dist/es/models/control-plane/ITransferContext.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ITransferContext.js","sourceRoot":"","sources":["../../../../src/models/control-plane/ITransferContext.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tDataspaceProtocolTransferProcessStateType,\n\tIDataspaceProtocolAgreement,\n\tIDataspaceProtocolDataAddress\n} from \"@twin.org/standards-dataspace-protocol\";\n\n/**\n * Transfer Context data structure.\n * Contains all information needed by DSC to execute queries.\n * This is NOT part of the DSP protocol - it's a TWIN internal API\n * used by dataspace-control-plane to resolve consumerPid to datasetId and policies.\n */\nexport interface ITransferContext {\n\t/**\n\t * Consumer Process ID.\n\t */\n\tconsumerPid: string;\n\n\t/**\n\t * Provider Process ID.\n\t */\n\tproviderPid: string;\n\n\t/**\n\t * Agreement associated with this Transfer Process.\n\t * Contains permissions, obligations, and prohibitions that DSC uses for runtime policy enforcement.\n\t */\n\tagreement: IDataspaceProtocolAgreement;\n\n\t/**\n\t * Dataset ID - what the DSC needs to execute the query.\n\t * Convenience field extracted from agreement.target for quick access.\n\t */\n\tdatasetId: string;\n\n\t/**\n\t * Offer ID.\n\t */\n\tofferId: string;\n\n\t/**\n\t * Current Transfer Process state.\n\t * DSC should only allow queries if state is STARTED.\n\t */\n\tstate: DataspaceProtocolTransferProcessStateType;\n\n\t/**\n\t * Consumer identity (for auditing).\n\t */\n\tconsumerIdentity?: string;\n\n\t/**\n\t * Provider identity (for auditing).\n\t * Extracted from Agreement's assigner field.\n\t */\n\tproviderIdentity?: string;\n\n\t/**\n\t * Data address for push mode transfers.\n\t * Contains endpoint information where data should be pushed (for Activity Stream push mode).\n\t * Only present when format is Http-Push-Activity-Stream-Format or Http-Post-Activity-Stream-Format.\n\t */\n\tdataAddress?: IDataspaceProtocolDataAddress;\n}\n"]}

package/dist/es/models/control-plane/ITransferProcess.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ITransferProcess.js","sourceRoot":"","sources":["../../../../src/models/control-plane/ITransferProcess.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tDataspaceProtocolTransferProcessStateType,\n\tIDataspaceProtocolDataAddress,\n\tIDataspaceProtocolPolicy\n} from \"@twin.org/standards-dataspace-protocol\";\n\n/**\n * Transfer Process for internal storage.\n * Combines DSP protocol fields with internal TWIN fields.\n * This is NOT the DSP wire format (use ITransferProcess from standards for that).\n */\nexport interface ITransferProcess {\n\t/**\n\t * Internal UUID (primary key for entity storage).\n\t */\n\tid: string;\n\n\t// === DSP Protocol fields (public) ===\n\n\t/**\n\t * Consumer Process ID from the DSP protocol.\n\t * Refers to the transfer identifier on the Consumer side.\n\t */\n\tconsumerPid: string;\n\n\t/**\n\t * Provider Process ID from the DSP protocol.\n\t * Refers to the transfer identifier on the Provider side.\n\t */\n\tproviderPid: 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\tstate: DataspaceProtocolTransferProcessStateType;\n\n\t// === Internal TWIN fields (NOT in DSP protocol) ===\n\n\t/**\n\t * Agreement ID linking to the rights-management Agreement.\n\t * Used to resolve policies and permissions.\n\t */\n\tagreementId: string;\n\n\t/**\n\t * Dataset ID for DSC resolution.\n\t * Identifies the dataset being transferred.\n\t */\n\tdatasetId: string;\n\n\t/**\n\t * Offer ID from the original Catalog offer.\n\t */\n\tofferId: string;\n\n\t/**\n\t * Policies from the Agreement.\n\t * Used by DSC for runtime policy enforcement.\n\t */\n\tpolicies?: IDataspaceProtocolPolicy[];\n\n\t/**\n\t * Consumer identity (DID or URI).\n\t * Used for auditing and access control.\n\t */\n\tconsumerIdentity?: string;\n\n\t/**\n\t * Provider identity (DID or URI).\n\t * Used for auditing.\n\t */\n\tproviderIdentity?: string;\n\n\t/**\n\t * Callback address for Consumer notifications.\n\t * URI where messages to the Consumer should be sent.\n\t */\n\tcallbackAddress?: string;\n\n\t/**\n\t * Data format from the Dataset Distribution.\n\t * Specified by a Distribution for the Dataset associated with the Agreement.\n\t */\n\tformat?: string;\n\n\t/**\n\t * Data address for push mode transfers.\n\t * Contains endpoint information where data should be pushed (for Activity Stream push mode).\n\t * Only present when format is Http-Push-Activity-Stream-Format or Http-Post-Activity-Stream-Format.\n\t */\n\tdataAddress?: IDataspaceProtocolDataAddress;\n\n\t/**\n\t * Creation timestamp.\n\t */\n\tdateCreated: Date;\n\n\t/**\n\t * Last update timestamp.\n\t */\n\tdateModified: Date;\n}\n"]}

package/dist/es/models/control-plane/api/ITransferContextResponse.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ITransferContextResponse.js","sourceRoot":"","sources":["../../../../../src/models/control-plane/api/ITransferContextResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ITransferContext } from \"../ITransferContext.js\";\n\n/**\n * Transfer Context Response (INTERNAL API for DSC).\n * This is NOT part of the DSP protocol - it's a TWIN internal API\n * used by dataspace-control-plane to resolve consumerPid to datasetId and policies.\n */\nexport interface ITransferContextResponse {\n\t/**\n\t * Request body\n\t */\n\tbody: ITransferContext;\n}\n"]}

package/dist/es/models/control-plane/transferProcessRole.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"transferProcessRole.js","sourceRoot":"","sources":["../../../../src/models/control-plane/transferProcessRole.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;;GAGG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG;IAClC;;OAEG;IACH,QAAQ,EAAE,UAAU;IAEpB;;OAEG;IACH,QAAQ,EAAE,UAAU;CACX,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The role of a participant in a Transfer Process.\n * Determines whether the party is acting as Consumer or Provider.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const TransferProcessRole = {\n\t/**\n\t * Consumer role - the party requesting data.\n\t */\n\tConsumer: \"consumer\",\n\n\t/**\n\t * Provider role - the party providing data.\n\t */\n\tProvider: \"provider\"\n} as const;\n\n/**\n * Type for TransferProcessRole values.\n */\nexport type TransferProcessRole = (typeof TransferProcessRole)[keyof typeof TransferProcessRole];\n"]}

package/dist/es/models/data-plane/IDataspaceDataPlaneComponent.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IDataspaceDataPlaneComponent.js","sourceRoot":"","sources":["../../../../src/models/data-plane/IDataspaceDataPlaneComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\nimport type { IActivityStreamsActivity } from \"@twin.org/standards-w3c-activity-streams\";\nimport type { IActivityLogEntry } from \"../IActivityLogEntry.js\";\nimport type { IActivityLogStatusNotification } from \"../IActivityLogStatusNotification.js\";\nimport type { IDataAssetItemListResult } from \"../IDataAssetItemListResult.js\";\nimport type { IEntitySet } from \"../IEntitySet.js\";\nimport type { IFilteringQuery } from \"../IFilteringQuery.js\";\n\n/**\n * Dataspace Data Plane component interface.\n * Implements the Data Plane functionality for the Eclipse Dataspace Protocol.\n */\nexport interface IDataspaceDataPlaneComponent extends IComponent {\n\t/**\n\t * Notify an Activity to the Dataspace Data Plane Activity Stream.\n\t * @param activity The Activity notified.\n\t * @returns The Activity's identifier.\n\t */\n\tnotifyActivity(activity: IActivityStreamsActivity): Promise<string>;\n\n\t/**\n\t * Subscribes to the activity log.\n\t * @param callback The callback to be called when Activity Log is called.\n\t * @param subscriptionId The subscription Id.\n\t * @returns The subscription Id.\n\t */\n\tsubscribeToActivityLog(\n\t\tcallback: (notification: IActivityLogStatusNotification) => Promise<void>,\n\t\tsubscriptionId?: string\n\t): Promise<string>;\n\n\t/**\n\t * Unsubscribes to the activity log.\n\t * @param subscriptionId The subscription Id.\n\t * @returns The subscription Id.\n\t */\n\tunSubscribeToActivityLog(subscriptionId: string): Promise<void>;\n\n\t/**\n\t * Returns Activity Log Entry which contains the Activity processing details.\n\t * @param logEntryId The Id of the Activity Log Entry (a URI).\n\t * @returns the Activity Log Entry with the processing details.\n\t * @throws NotFoundError if activity log entry is not known.\n\t */\n\tgetActivityLogEntry(logEntryId: string): Promise<IActivityLogEntry>;\n\n\t/**\n\t * Get Data Asset entities. Allows to retrieve entities by their type or id.\n\t * @param entitySet The set of entities to be retrieved.\n\t * @param entitySet.jsonLdContext The JSON-LD Context to be used to expand the referred entityType.\n\t * @param consumerPid The consumer Process ID from the DSP Transfer Process.\n\t * Used to resolve datasetId from the Transfer Process.\n\t * @param cursor Pagination details - cursor.\n\t * @param limit Pagination details - max number of entities.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns The item list and optional cursor for pagination via Link headers.\n\t */\n\tgetDataAssetEntities(\n\t\tentitySet: IEntitySet & {\n\t\t\tjsonLdContext?: IJsonLdContextDefinitionElement[];\n\t\t},\n\t\tconsumerPid: string,\n\t\tcursor?: string,\n\t\tlimit?: number,\n\t\ttrustPayload?: unknown\n\t): Promise<IDataAssetItemListResult>;\n\n\t/**\n\t * Queries a data asset controlled by this Dataspace App.\n\t * @param consumerPid The consumer Process ID from the DSP Transfer Process.\n\t * Used to resolve datasetId from the Transfer Process.\n\t * @param query The filtering query.\n\t * @param cursor Pagination details - cursor.\n\t * @param limit Pagination details - max number of entities.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns The item list and optional cursor for pagination via Link headers.\n\t */\n\tqueryDataAsset(\n\t\tconsumerPid: string,\n\t\tquery: IFilteringQuery,\n\t\tcursor?: string,\n\t\tlimit?: number,\n\t\ttrustPayload?: unknown\n\t): Promise<IDataAssetItemListResult>;\n}\n"]}