@twin.org/rights-management-models 0.0.3-next.4 → 0.0.3-next.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/es/models/api/pnap/IPnapQueryRequest.js.map +1 -1
- package/dist/es/models/api/pnp/IPnpAgreementRequest.js.map +1 -1
- package/dist/es/models/api/pnp/IPnpAgreementVerificationRequest.js.map +1 -1
- package/dist/es/models/api/pnp/IPnpContractNegotiationResponse.js.map +1 -1
- package/dist/es/models/api/pnp/IPnpContractResponse.js.map +1 -1
- package/dist/es/models/api/pnp/IPnpEventRequest.js.map +1 -1
- package/dist/es/models/api/pnp/IPnpNegotiateRequest.js.map +1 -1
- package/dist/es/models/api/pnp/IPnpOfferRequest.js.map +1 -1
- package/dist/es/models/api/pnp/IPnpTerminateRequest.js.map +1 -1
- package/dist/es/models/pnp/IPolicyNegotiation.js.map +1 -1
- package/dist/es/models/pnp/IPolicyNegotiationAdminPointComponent.js.map +1 -1
- package/dist/es/models/pnp/IPolicyNegotiationPointComponent.js.map +1 -1
- package/dist/types/models/api/pnap/IPnapQueryRequest.d.ts +2 -2
- package/dist/types/models/api/pnp/IPnpAgreementRequest.d.ts +2 -2
- package/dist/types/models/api/pnp/IPnpAgreementVerificationRequest.d.ts +2 -2
- package/dist/types/models/api/pnp/IPnpContractNegotiationResponse.d.ts +2 -2
- package/dist/types/models/api/pnp/IPnpContractResponse.d.ts +2 -2
- package/dist/types/models/api/pnp/IPnpEventRequest.d.ts +2 -2
- package/dist/types/models/api/pnp/IPnpNegotiateRequest.d.ts +2 -2
- package/dist/types/models/api/pnp/IPnpOfferRequest.d.ts +2 -2
- package/dist/types/models/api/pnp/IPnpTerminateRequest.d.ts +2 -2
- package/dist/types/models/pnp/IPolicyNegotiation.d.ts +2 -2
- package/dist/types/models/pnp/IPolicyNegotiationAdminPointComponent.d.ts +2 -2
- package/dist/types/models/pnp/IPolicyNegotiationPointComponent.d.ts +8 -8
- package/docs/changelog.md +14 -0
- package/docs/reference/interfaces/IPnapQueryRequest.md +1 -1
- package/docs/reference/interfaces/IPnpAgreementRequest.md +1 -1
- package/docs/reference/interfaces/IPnpAgreementVerificationRequest.md +1 -1
- package/docs/reference/interfaces/IPnpContractNegotiationResponse.md +1 -1
- package/docs/reference/interfaces/IPnpContractResponse.md +1 -1
- package/docs/reference/interfaces/IPnpEventRequest.md +1 -1
- package/docs/reference/interfaces/IPnpNegotiateRequest.md +1 -1
- package/docs/reference/interfaces/IPnpOfferRequest.md +1 -1
- package/docs/reference/interfaces/IPnpTerminateRequest.md +1 -1
- package/docs/reference/interfaces/IPolicyNegotiation.md +1 -1
- package/docs/reference/interfaces/IPolicyNegotiationAdminPointComponent.md +1 -1
- package/docs/reference/interfaces/IPolicyNegotiationPointComponent.md +20 -20
- package/package.json +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPnapQueryRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pnap/IPnapQueryRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {
|
|
1
|
+
{"version":3,"file":"IPnapQueryRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pnap/IPnapQueryRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { DataspaceProtocolContractNegotiationStateType } from \"@twin.org/standards-dataspace-protocol\";\n\n/**\n * The request structure for querying manual policy negotiations.\n */\nexport interface IPnapQueryRequest {\n\t/**\n\t * The query parameters of the request.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The state of the policy negotiations.\n\t\t */\n\t\tstate?: DataspaceProtocolContractNegotiationStateType;\n\n\t\t/**\n\t\t * The cursor for pagination.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPnpAgreementRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pnp/IPnpAgreementRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {
|
|
1
|
+
{"version":3,"file":"IPnpAgreementRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pnp/IPnpAgreementRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolContractAgreementMessage } from \"@twin.org/standards-dataspace-protocol\";\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * The request structure for sending a contract negotiation agreement.\n */\nexport interface IPnpAgreementRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders: {\n\t\t[HeaderTypes.Accept]?: typeof MimeTypes.JsonLd | typeof MimeTypes.Json;\n\t\t[HeaderTypes.Authorization]?: string;\n\t};\n\n\t/**\n\t * The path parameters of the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The identifier of the negotiation to target.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The body parameters of the request.\n\t */\n\tbody: IDataspaceProtocolContractAgreementMessage;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPnpAgreementVerificationRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pnp/IPnpAgreementVerificationRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {
|
|
1
|
+
{"version":3,"file":"IPnpAgreementVerificationRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pnp/IPnpAgreementVerificationRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolContractAgreementVerificationMessage } from \"@twin.org/standards-dataspace-protocol\";\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * The request structure for sending a contract negotiation agreement verification.\n */\nexport interface IPnpAgreementVerificationRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders: {\n\t\t[HeaderTypes.Accept]?: typeof MimeTypes.JsonLd | typeof MimeTypes.Json;\n\t\t[HeaderTypes.Authorization]?: string;\n\t};\n\n\t/**\n\t * The path parameters of the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The identifier of the contract negotiation to be retrieved.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The body parameters of the request.\n\t */\n\tbody: IDataspaceProtocolContractAgreementVerificationMessage;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPnpContractNegotiationResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/pnp/IPnpContractNegotiationResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\
|
|
1
|
+
{"version":3,"file":"IPnpContractNegotiationResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/pnp/IPnpContractNegotiationResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tIDataspaceProtocolContractNegotiation,\n\tIDataspaceProtocolContractNegotiationError\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { HeaderTypes, HttpStatusCode, MimeTypes } from \"@twin.org/web\";\n\n/**\n * The response structure for negotiating a policy.\n */\nexport interface IPnpContractNegotiationResponse {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.JsonLd | typeof MimeTypes.Json;\n\t};\n\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode?: HttpStatusCode;\n\n\t/**\n\t * The state of the policy or an error.\n\t */\n\tbody: IDataspaceProtocolContractNegotiation | IDataspaceProtocolContractNegotiationError;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPnpContractResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/pnp/IPnpContractResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {
|
|
1
|
+
{"version":3,"file":"IPnpContractResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/pnp/IPnpContractResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolContractNegotiationError } from \"@twin.org/standards-dataspace-protocol\";\nimport type { HeaderTypes, HttpStatusCode, MimeTypes } from \"@twin.org/web\";\n\n/**\n * The response structure for negotiating a policy.\n */\nexport interface IPnpContractResponse {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.JsonLd | typeof MimeTypes.Json;\n\t};\n\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode?: HttpStatusCode;\n\n\t/**\n\t * The error if there was one.\n\t */\n\tbody?: IDataspaceProtocolContractNegotiationError;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPnpEventRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pnp/IPnpEventRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {
|
|
1
|
+
{"version":3,"file":"IPnpEventRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pnp/IPnpEventRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolContractNegotiationEventMessage } from \"@twin.org/standards-dataspace-protocol\";\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * The request structure for requesting a contract negotiation event.\n */\nexport interface IPnpEventRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders: {\n\t\t[HeaderTypes.Accept]?: typeof MimeTypes.JsonLd | typeof MimeTypes.Json;\n\t\t[HeaderTypes.Authorization]?: string;\n\t};\n\n\t/**\n\t * The path parameters of the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The identifier of the negotiation to target.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The body parameters of the request.\n\t */\n\tbody: IDataspaceProtocolContractNegotiationEventMessage;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPnpNegotiateRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pnp/IPnpNegotiateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {
|
|
1
|
+
{"version":3,"file":"IPnpNegotiateRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pnp/IPnpNegotiateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolContractRequestMessage } from \"@twin.org/standards-dataspace-protocol\";\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * The request structure for requesting a contract negotiation.\n */\nexport interface IPnpNegotiateRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders: {\n\t\t[HeaderTypes.Accept]?: typeof MimeTypes.JsonLd | typeof MimeTypes.Json;\n\t\t[HeaderTypes.Authorization]?: string;\n\t};\n\n\t/**\n\t * The path parameters of the request.\n\t */\n\tpathParams?: {\n\t\t/**\n\t\t * The identifier of the contract negotiation to be retrieved, can be undefined.\n\t\t */\n\t\tid?: string;\n\t};\n\n\t/**\n\t * The body parameters of the request.\n\t */\n\tbody: IDataspaceProtocolContractRequestMessage;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPnpOfferRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pnp/IPnpOfferRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {
|
|
1
|
+
{"version":3,"file":"IPnpOfferRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pnp/IPnpOfferRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolContractOfferMessage } from \"@twin.org/standards-dataspace-protocol\";\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * The request structure for sending a contract negotiation offer.\n */\nexport interface IPnpOfferRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders: {\n\t\t[HeaderTypes.Accept]?: typeof MimeTypes.JsonLd | typeof MimeTypes.Json;\n\t\t[HeaderTypes.Authorization]?: string;\n\t};\n\n\t/**\n\t * The path parameters of the request.\n\t */\n\tpathParams?: {\n\t\t/**\n\t\t * The identifier of the consumer being offered, this can be undefined.\n\t\t */\n\t\tid?: string;\n\t};\n\n\t/**\n\t * The body parameters of the request.\n\t */\n\tbody: IDataspaceProtocolContractOfferMessage;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPnpTerminateRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pnp/IPnpTerminateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {
|
|
1
|
+
{"version":3,"file":"IPnpTerminateRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pnp/IPnpTerminateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolContractNegotiationTerminationMessage } from \"@twin.org/standards-dataspace-protocol\";\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * The request structure for requesting a contract negotiation termination.\n */\nexport interface IPnpTerminateRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders: {\n\t\t[HeaderTypes.Accept]?: typeof MimeTypes.JsonLd | typeof MimeTypes.Json;\n\t\t[HeaderTypes.Authorization]?: string;\n\t};\n\n\t/**\n\t * The path parameters of the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The identifier of the negotiation to target.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The body parameters of the request.\n\t */\n\tbody: IDataspaceProtocolContractNegotiationTerminationMessage;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPolicyNegotiation.js","sourceRoot":"","sources":["../../../../src/models/pnp/IPolicyNegotiation.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {
|
|
1
|
+
{"version":3,"file":"IPolicyNegotiation.js","sourceRoot":"","sources":["../../../../src/models/pnp/IPolicyNegotiation.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { DataspaceProtocolContractNegotiationStateType } from \"@twin.org/standards-dataspace-protocol\";\nimport type { IOdrlAgreement, IOdrlOffer } from \"@twin.org/standards-w3c-odrl\";\nimport type { IPolicyLocator } from \"../IPolicyLocator.js\";\nimport type { IPolicyInformation } from \"../pip/IPolicyInformation.js\";\n\n/**\n * Interface describing a rights management policy negotiation.\n */\nexport interface IPolicyNegotiation extends IPolicyLocator {\n\t/**\n\t * The primary id used by the provider.\n\t */\n\tid: string;\n\n\t/**\n\t * This is used by the other side of the negotiation.\n\t */\n\tcorrelationId: string;\n\n\t/**\n\t * The unique identifier for the policy.\n\t */\n\tpolicyId?: string;\n\n\t/**\n\t * The date and time when the negotiation was created.\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The expiration time for the policy negotiation if it's a manual process.\n\t */\n\texpires?: number;\n\n\t/**\n\t * The status of the negotiation.\n\t */\n\tstate: DataspaceProtocolContractNegotiationStateType;\n\n\t/**\n\t * The callback address to send updates to the requester.\n\t */\n\tcallbackAddress?: string;\n\n\t/**\n\t * The offer being requested.\n\t */\n\toffer?: IOdrlOffer;\n\n\t/**\n\t * The agreement being established if the negotiation was successful.\n\t */\n\tagreement?: IOdrlAgreement;\n\n\t/**\n\t * Additional information supplied by the consumer to help with negotiation.\n\t */\n\tinformation?: IPolicyInformation;\n\n\t/**\n\t * A reason code for when the negotiation errors.\n\t */\n\tcode?: string;\n\n\t/**\n\t * A more detailed reason for the negotiation error.\n\t */\n\treason?: {\n\t\t\"@value\": string;\n\t\t\"@language\"?: string;\n\t}[];\n\n\t/**\n\t * A more detailed reason for the negotiation error.\n\t */\n\tdescription?: {\n\t\t\"@value\": string;\n\t\t\"@language\"?: string;\n\t}[];\n\n\t/**\n\t * The id of the handler, on provider side this is the negotiator, on consumer side this is the requester.\n\t */\n\thandlerId?: string;\n\n\t/**\n\t * Is manual intervention required to complete the negotiation?\n\t */\n\tinterventionRequired?: boolean;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPolicyNegotiationAdminPointComponent.js","sourceRoot":"","sources":["../../../../src/models/pnp/IPolicyNegotiationAdminPointComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type {
|
|
1
|
+
{"version":3,"file":"IPolicyNegotiationAdminPointComponent.js","sourceRoot":"","sources":["../../../../src/models/pnp/IPolicyNegotiationAdminPointComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { DataspaceProtocolContractNegotiationStateType } from \"@twin.org/standards-dataspace-protocol\";\nimport type { IPolicyNegotiation } from \"./IPolicyNegotiation.js\";\n\n/**\n * Interface describing a Policy Negotiation Admin Point (PNAP) contract.\n * Components performs administration tasks on the policy negotiations.\n * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#negotiation-protocol\n */\nexport interface IPolicyNegotiationAdminPointComponent extends IComponent {\n\t/**\n\t * Retrieves a policy negotiation.\n\t * @param id The ID of the policy to retrieve the negotiation for.\n\t * @returns The policy negotiation.\n\t */\n\tget(id: string): Promise<IPolicyNegotiation>;\n\n\t/**\n\t * Sets a policy negotiation.\n\t * @param negotiation The updated policy negotiation.\n\t * @returns Nothing.\n\t */\n\tset(negotiation: IPolicyNegotiation): Promise<void>;\n\n\t/**\n\t * Cancels an ongoing negotiation for a resource.\n\t * @param policyId The ID of the policy to cancel.\n\t * @returns Nothing.\n\t */\n\tremove(policyId: string): Promise<void>;\n\n\t/**\n\t * Get a list of the negotiations.\n\t * @param status The state of the negotiations to retrieve.\n\t * @param cursor The cursor to use for pagination.\n\t * @returns A list of negotiations and cursor if there are more entries.\n\t */\n\tquery(\n\t\tstatus?: DataspaceProtocolContractNegotiationStateType,\n\t\tcursor?: string\n\t): Promise<{ items: IPolicyNegotiation[]; cursor?: string }>;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPolicyNegotiationPointComponent.js","sourceRoot":"","sources":["../../../../src/models/pnp/IPolicyNegotiationPointComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type {\n\
|
|
1
|
+
{"version":3,"file":"IPolicyNegotiationPointComponent.js","sourceRoot":"","sources":["../../../../src/models/pnp/IPolicyNegotiationPointComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type {\n\tIDataspaceProtocolContractAgreementMessage,\n\tIDataspaceProtocolContractAgreementVerificationMessage,\n\tIDataspaceProtocolContractNegotiation,\n\tIDataspaceProtocolContractNegotiationError,\n\tIDataspaceProtocolContractNegotiationEventMessage,\n\tIDataspaceProtocolContractNegotiationTerminationMessage,\n\tIDataspaceProtocolContractOfferMessage,\n\tIDataspaceProtocolContractRequestMessage\n} from \"@twin.org/standards-dataspace-protocol\";\n\n/**\n * Interface describing a Policy Negotiation Point (PNP) contract.\n * When receiving a request from another component, the PNP will negotiate the terms\n * of the request and determine the appropriate policies to create.\n * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#negotiation-protocol\n */\nexport interface IPolicyNegotiationPointComponent extends IComponent {\n\t/**\n\t * Get the current state of the negotiation.\n\t * @param id The id of the negotiation to retrieve.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns The current state of the negotiation or an error.\n\t */\n\tgetNegotiation(\n\t\tid: string,\n\t\ttrustPayload: unknown\n\t): Promise<IDataspaceProtocolContractNegotiation | IDataspaceProtocolContractNegotiationError>;\n\n\t/**\n\t * Send a request to a provider.\n\t * @param url The url of the provider to send the request to.\n\t * @param requesterId The id of the requester to use for the request, will use the registered requester to provide update.\n\t * @param odrlOfferId The id of the offer to request.\n\t * @returns The negotiation id.\n\t */\n\tsendRequestToProvider(url: string, requesterId: string, odrlOfferId: string): Promise<string>;\n\n\t/**\n\t * Processes an incoming request on a provider from a consumer.\n\t * @param message The negotiation request.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns The current state of the contract negotiation or an error.\n\t */\n\trequestFromConsumer(\n\t\tmessage: IDataspaceProtocolContractRequestMessage,\n\t\ttrustPayload: unknown\n\t): Promise<IDataspaceProtocolContractNegotiation | IDataspaceProtocolContractNegotiationError>;\n\n\t/**\n\t * An offer has been received by a consumer.\n\t * @param message The offer being received by the consumer.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns The current state of the contract negotiation or an error.\n\t */\n\tofferFromProvider(\n\t\tmessage: IDataspaceProtocolContractOfferMessage,\n\t\ttrustPayload: unknown\n\t): Promise<IDataspaceProtocolContractNegotiation | IDataspaceProtocolContractNegotiationError>;\n\n\t/**\n\t * An agreement has been received by a consumer.\n\t * @param message The agreement message to send.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns The error if there is one.\n\t */\n\tagreementFromProvider(\n\t\tmessage: IDataspaceProtocolContractAgreementMessage,\n\t\ttrustPayload: unknown\n\t): Promise<IDataspaceProtocolContractNegotiationError | undefined>;\n\n\t/**\n\t * An agreement verification has been received by a provider.\n\t * @param message The agreement verification message to send.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns The error if there is one.\n\t */\n\tagreementVerificationFromConsumer(\n\t\tmessage: IDataspaceProtocolContractAgreementVerificationMessage,\n\t\ttrustPayload: unknown\n\t): Promise<IDataspaceProtocolContractNegotiationError | undefined>;\n\n\t/**\n\t * An event has been received by the provider or consumer.\n\t * @param message The event message to send.\n\t * @param destination The destination is provider or consumer.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns The error if there is one.\n\t */\n\tevent(\n\t\tmessage: IDataspaceProtocolContractNegotiationEventMessage,\n\t\tdestination: \"provider\" | \"consumer\",\n\t\ttrustPayload: unknown\n\t): Promise<IDataspaceProtocolContractNegotiationError | undefined>;\n\n\t/**\n\t * A termination message has been received by the provider or consumer.\n\t * @param message The termination message to send.\n\t * @param destination The destination is provider or consumer.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns The error if there is one.\n\t */\n\tterminate(\n\t\tmessage: IDataspaceProtocolContractNegotiationTerminationMessage,\n\t\tdestination: \"provider\" | \"consumer\",\n\t\ttrustPayload: unknown\n\t): Promise<IDataspaceProtocolContractNegotiationError | undefined>;\n}\n"]}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { DataspaceProtocolContractNegotiationStateType } from "@twin.org/standards-dataspace-protocol";
|
|
2
2
|
/**
|
|
3
3
|
* The request structure for querying manual policy negotiations.
|
|
4
4
|
*/
|
|
@@ -10,7 +10,7 @@ export interface IPnapQueryRequest {
|
|
|
10
10
|
/**
|
|
11
11
|
* The state of the policy negotiations.
|
|
12
12
|
*/
|
|
13
|
-
state?:
|
|
13
|
+
state?: DataspaceProtocolContractNegotiationStateType;
|
|
14
14
|
/**
|
|
15
15
|
* The cursor for pagination.
|
|
16
16
|
*/
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { IDataspaceProtocolContractAgreementMessage } from "@twin.org/standards-dataspace-protocol";
|
|
2
2
|
import type { HeaderTypes, MimeTypes } from "@twin.org/web";
|
|
3
3
|
/**
|
|
4
4
|
* The request structure for sending a contract negotiation agreement.
|
|
@@ -23,5 +23,5 @@ export interface IPnpAgreementRequest {
|
|
|
23
23
|
/**
|
|
24
24
|
* The body parameters of the request.
|
|
25
25
|
*/
|
|
26
|
-
body:
|
|
26
|
+
body: IDataspaceProtocolContractAgreementMessage;
|
|
27
27
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { IDataspaceProtocolContractAgreementVerificationMessage } from "@twin.org/standards-dataspace-protocol";
|
|
2
2
|
import type { HeaderTypes, MimeTypes } from "@twin.org/web";
|
|
3
3
|
/**
|
|
4
4
|
* The request structure for sending a contract negotiation agreement verification.
|
|
@@ -23,5 +23,5 @@ export interface IPnpAgreementVerificationRequest {
|
|
|
23
23
|
/**
|
|
24
24
|
* The body parameters of the request.
|
|
25
25
|
*/
|
|
26
|
-
body:
|
|
26
|
+
body: IDataspaceProtocolContractAgreementVerificationMessage;
|
|
27
27
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { IDataspaceProtocolContractNegotiation, IDataspaceProtocolContractNegotiationError } from "@twin.org/standards-dataspace-protocol";
|
|
2
2
|
import type { HeaderTypes, HttpStatusCode, MimeTypes } from "@twin.org/web";
|
|
3
3
|
/**
|
|
4
4
|
* The response structure for negotiating a policy.
|
|
@@ -17,5 +17,5 @@ export interface IPnpContractNegotiationResponse {
|
|
|
17
17
|
/**
|
|
18
18
|
* The state of the policy or an error.
|
|
19
19
|
*/
|
|
20
|
-
body:
|
|
20
|
+
body: IDataspaceProtocolContractNegotiation | IDataspaceProtocolContractNegotiationError;
|
|
21
21
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { IDataspaceProtocolContractNegotiationError } from "@twin.org/standards-dataspace-protocol";
|
|
2
2
|
import type { HeaderTypes, HttpStatusCode, MimeTypes } from "@twin.org/web";
|
|
3
3
|
/**
|
|
4
4
|
* The response structure for negotiating a policy.
|
|
@@ -17,5 +17,5 @@ export interface IPnpContractResponse {
|
|
|
17
17
|
/**
|
|
18
18
|
* The error if there was one.
|
|
19
19
|
*/
|
|
20
|
-
body?:
|
|
20
|
+
body?: IDataspaceProtocolContractNegotiationError;
|
|
21
21
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { IDataspaceProtocolContractNegotiationEventMessage } from "@twin.org/standards-dataspace-protocol";
|
|
2
2
|
import type { HeaderTypes, MimeTypes } from "@twin.org/web";
|
|
3
3
|
/**
|
|
4
4
|
* The request structure for requesting a contract negotiation event.
|
|
@@ -23,5 +23,5 @@ export interface IPnpEventRequest {
|
|
|
23
23
|
/**
|
|
24
24
|
* The body parameters of the request.
|
|
25
25
|
*/
|
|
26
|
-
body:
|
|
26
|
+
body: IDataspaceProtocolContractNegotiationEventMessage;
|
|
27
27
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { IDataspaceProtocolContractRequestMessage } from "@twin.org/standards-dataspace-protocol";
|
|
2
2
|
import type { HeaderTypes, MimeTypes } from "@twin.org/web";
|
|
3
3
|
/**
|
|
4
4
|
* The request structure for requesting a contract negotiation.
|
|
@@ -23,5 +23,5 @@ export interface IPnpNegotiateRequest {
|
|
|
23
23
|
/**
|
|
24
24
|
* The body parameters of the request.
|
|
25
25
|
*/
|
|
26
|
-
body:
|
|
26
|
+
body: IDataspaceProtocolContractRequestMessage;
|
|
27
27
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { IDataspaceProtocolContractOfferMessage } from "@twin.org/standards-dataspace-protocol";
|
|
2
2
|
import type { HeaderTypes, MimeTypes } from "@twin.org/web";
|
|
3
3
|
/**
|
|
4
4
|
* The request structure for sending a contract negotiation offer.
|
|
@@ -23,5 +23,5 @@ export interface IPnpOfferRequest {
|
|
|
23
23
|
/**
|
|
24
24
|
* The body parameters of the request.
|
|
25
25
|
*/
|
|
26
|
-
body:
|
|
26
|
+
body: IDataspaceProtocolContractOfferMessage;
|
|
27
27
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { IDataspaceProtocolContractNegotiationTerminationMessage } from "@twin.org/standards-dataspace-protocol";
|
|
2
2
|
import type { HeaderTypes, MimeTypes } from "@twin.org/web";
|
|
3
3
|
/**
|
|
4
4
|
* The request structure for requesting a contract negotiation termination.
|
|
@@ -23,5 +23,5 @@ export interface IPnpTerminateRequest {
|
|
|
23
23
|
/**
|
|
24
24
|
* The body parameters of the request.
|
|
25
25
|
*/
|
|
26
|
-
body:
|
|
26
|
+
body: IDataspaceProtocolContractNegotiationTerminationMessage;
|
|
27
27
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { DataspaceProtocolContractNegotiationStateType } from "@twin.org/standards-dataspace-protocol";
|
|
2
2
|
import type { IOdrlAgreement, IOdrlOffer } from "@twin.org/standards-w3c-odrl";
|
|
3
3
|
import type { IPolicyLocator } from "../IPolicyLocator.js";
|
|
4
4
|
import type { IPolicyInformation } from "../pip/IPolicyInformation.js";
|
|
@@ -29,7 +29,7 @@ export interface IPolicyNegotiation extends IPolicyLocator {
|
|
|
29
29
|
/**
|
|
30
30
|
* The status of the negotiation.
|
|
31
31
|
*/
|
|
32
|
-
state:
|
|
32
|
+
state: DataspaceProtocolContractNegotiationStateType;
|
|
33
33
|
/**
|
|
34
34
|
* The callback address to send updates to the requester.
|
|
35
35
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { IComponent } from "@twin.org/core";
|
|
2
|
-
import type {
|
|
2
|
+
import type { DataspaceProtocolContractNegotiationStateType } from "@twin.org/standards-dataspace-protocol";
|
|
3
3
|
import type { IPolicyNegotiation } from "./IPolicyNegotiation.js";
|
|
4
4
|
/**
|
|
5
5
|
* Interface describing a Policy Negotiation Admin Point (PNAP) contract.
|
|
@@ -31,7 +31,7 @@ export interface IPolicyNegotiationAdminPointComponent extends IComponent {
|
|
|
31
31
|
* @param cursor The cursor to use for pagination.
|
|
32
32
|
* @returns A list of negotiations and cursor if there are more entries.
|
|
33
33
|
*/
|
|
34
|
-
query(status?:
|
|
34
|
+
query(status?: DataspaceProtocolContractNegotiationStateType, cursor?: string): Promise<{
|
|
35
35
|
items: IPolicyNegotiation[];
|
|
36
36
|
cursor?: string;
|
|
37
37
|
}>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { IComponent } from "@twin.org/core";
|
|
2
|
-
import type {
|
|
2
|
+
import type { IDataspaceProtocolContractAgreementMessage, IDataspaceProtocolContractAgreementVerificationMessage, IDataspaceProtocolContractNegotiation, IDataspaceProtocolContractNegotiationError, IDataspaceProtocolContractNegotiationEventMessage, IDataspaceProtocolContractNegotiationTerminationMessage, IDataspaceProtocolContractOfferMessage, IDataspaceProtocolContractRequestMessage } from "@twin.org/standards-dataspace-protocol";
|
|
3
3
|
/**
|
|
4
4
|
* Interface describing a Policy Negotiation Point (PNP) contract.
|
|
5
5
|
* When receiving a request from another component, the PNP will negotiate the terms
|
|
@@ -13,7 +13,7 @@ export interface IPolicyNegotiationPointComponent extends IComponent {
|
|
|
13
13
|
* @param trustPayload Trust payload to verify the requesters identity.
|
|
14
14
|
* @returns The current state of the negotiation or an error.
|
|
15
15
|
*/
|
|
16
|
-
getNegotiation(id: string, trustPayload: unknown): Promise<
|
|
16
|
+
getNegotiation(id: string, trustPayload: unknown): Promise<IDataspaceProtocolContractNegotiation | IDataspaceProtocolContractNegotiationError>;
|
|
17
17
|
/**
|
|
18
18
|
* Send a request to a provider.
|
|
19
19
|
* @param url The url of the provider to send the request to.
|
|
@@ -28,28 +28,28 @@ export interface IPolicyNegotiationPointComponent extends IComponent {
|
|
|
28
28
|
* @param trustPayload Trust payload to verify the requesters identity.
|
|
29
29
|
* @returns The current state of the contract negotiation or an error.
|
|
30
30
|
*/
|
|
31
|
-
requestFromConsumer(message:
|
|
31
|
+
requestFromConsumer(message: IDataspaceProtocolContractRequestMessage, trustPayload: unknown): Promise<IDataspaceProtocolContractNegotiation | IDataspaceProtocolContractNegotiationError>;
|
|
32
32
|
/**
|
|
33
33
|
* An offer has been received by a consumer.
|
|
34
34
|
* @param message The offer being received by the consumer.
|
|
35
35
|
* @param trustPayload Trust payload to verify the requesters identity.
|
|
36
36
|
* @returns The current state of the contract negotiation or an error.
|
|
37
37
|
*/
|
|
38
|
-
offerFromProvider(message:
|
|
38
|
+
offerFromProvider(message: IDataspaceProtocolContractOfferMessage, trustPayload: unknown): Promise<IDataspaceProtocolContractNegotiation | IDataspaceProtocolContractNegotiationError>;
|
|
39
39
|
/**
|
|
40
40
|
* An agreement has been received by a consumer.
|
|
41
41
|
* @param message The agreement message to send.
|
|
42
42
|
* @param trustPayload Trust payload to verify the requesters identity.
|
|
43
43
|
* @returns The error if there is one.
|
|
44
44
|
*/
|
|
45
|
-
agreementFromProvider(message:
|
|
45
|
+
agreementFromProvider(message: IDataspaceProtocolContractAgreementMessage, trustPayload: unknown): Promise<IDataspaceProtocolContractNegotiationError | undefined>;
|
|
46
46
|
/**
|
|
47
47
|
* An agreement verification has been received by a provider.
|
|
48
48
|
* @param message The agreement verification message to send.
|
|
49
49
|
* @param trustPayload Trust payload to verify the requesters identity.
|
|
50
50
|
* @returns The error if there is one.
|
|
51
51
|
*/
|
|
52
|
-
agreementVerificationFromConsumer(message:
|
|
52
|
+
agreementVerificationFromConsumer(message: IDataspaceProtocolContractAgreementVerificationMessage, trustPayload: unknown): Promise<IDataspaceProtocolContractNegotiationError | undefined>;
|
|
53
53
|
/**
|
|
54
54
|
* An event has been received by the provider or consumer.
|
|
55
55
|
* @param message The event message to send.
|
|
@@ -57,7 +57,7 @@ export interface IPolicyNegotiationPointComponent extends IComponent {
|
|
|
57
57
|
* @param trustPayload Trust payload to verify the requesters identity.
|
|
58
58
|
* @returns The error if there is one.
|
|
59
59
|
*/
|
|
60
|
-
event(message:
|
|
60
|
+
event(message: IDataspaceProtocolContractNegotiationEventMessage, destination: "provider" | "consumer", trustPayload: unknown): Promise<IDataspaceProtocolContractNegotiationError | undefined>;
|
|
61
61
|
/**
|
|
62
62
|
* A termination message has been received by the provider or consumer.
|
|
63
63
|
* @param message The termination message to send.
|
|
@@ -65,5 +65,5 @@ export interface IPolicyNegotiationPointComponent extends IComponent {
|
|
|
65
65
|
* @param trustPayload Trust payload to verify the requesters identity.
|
|
66
66
|
* @returns The error if there is one.
|
|
67
67
|
*/
|
|
68
|
-
terminate(message:
|
|
68
|
+
terminate(message: IDataspaceProtocolContractNegotiationTerminationMessage, destination: "provider" | "consumer", trustPayload: unknown): Promise<IDataspaceProtocolContractNegotiationError | undefined>;
|
|
69
69
|
}
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# @twin.org/rights-management-models - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.6](https://github.com/twinfoundation/rights-management/compare/rights-management-models-v0.0.3-next.5...rights-management-models-v0.0.3-next.6) (2026-01-12)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Miscellaneous Chores
|
|
7
|
+
|
|
8
|
+
* **rights-management-models:** Synchronize repo versions
|
|
9
|
+
|
|
10
|
+
## [0.0.3-next.5](https://github.com/twinfoundation/rights-management/compare/rights-management-models-v0.0.3-next.4...rights-management-models-v0.0.3-next.5) (2026-01-06)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* update dspace dependencies ([072917b](https://github.com/twinfoundation/rights-management/commit/072917bcfa052a6d61e6cd3676e275ba7fc4ec25))
|
|
16
|
+
|
|
3
17
|
## [0.0.3-next.4](https://github.com/twinfoundation/rights-management/compare/rights-management-models-v0.0.3-next.3...rights-management-models-v0.0.3-next.4) (2025-12-04)
|
|
4
18
|
|
|
5
19
|
|
|
@@ -13,7 +13,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#nego
|
|
|
13
13
|
|
|
14
14
|
### getNegotiation()
|
|
15
15
|
|
|
16
|
-
> **getNegotiation**(`id`, `trustPayload`): `Promise`\<`
|
|
16
|
+
> **getNegotiation**(`id`, `trustPayload`): `Promise`\<`IDataspaceProtocolContractNegotiation` \| `IDataspaceProtocolContractNegotiationError`\>
|
|
17
17
|
|
|
18
18
|
Get the current state of the negotiation.
|
|
19
19
|
|
|
@@ -33,7 +33,7 @@ Trust payload to verify the requesters identity.
|
|
|
33
33
|
|
|
34
34
|
#### Returns
|
|
35
35
|
|
|
36
|
-
`Promise`\<`
|
|
36
|
+
`Promise`\<`IDataspaceProtocolContractNegotiation` \| `IDataspaceProtocolContractNegotiationError`\>
|
|
37
37
|
|
|
38
38
|
The current state of the negotiation or an error.
|
|
39
39
|
|
|
@@ -75,7 +75,7 @@ The negotiation id.
|
|
|
75
75
|
|
|
76
76
|
### requestFromConsumer()
|
|
77
77
|
|
|
78
|
-
> **requestFromConsumer**(`message`, `trustPayload`): `Promise`\<`
|
|
78
|
+
> **requestFromConsumer**(`message`, `trustPayload`): `Promise`\<`IDataspaceProtocolContractNegotiation` \| `IDataspaceProtocolContractNegotiationError`\>
|
|
79
79
|
|
|
80
80
|
Processes an incoming request on a provider from a consumer.
|
|
81
81
|
|
|
@@ -83,7 +83,7 @@ Processes an incoming request on a provider from a consumer.
|
|
|
83
83
|
|
|
84
84
|
##### message
|
|
85
85
|
|
|
86
|
-
`
|
|
86
|
+
`IDataspaceProtocolContractRequestMessage`
|
|
87
87
|
|
|
88
88
|
The negotiation request.
|
|
89
89
|
|
|
@@ -95,7 +95,7 @@ Trust payload to verify the requesters identity.
|
|
|
95
95
|
|
|
96
96
|
#### Returns
|
|
97
97
|
|
|
98
|
-
`Promise`\<`
|
|
98
|
+
`Promise`\<`IDataspaceProtocolContractNegotiation` \| `IDataspaceProtocolContractNegotiationError`\>
|
|
99
99
|
|
|
100
100
|
The current state of the contract negotiation or an error.
|
|
101
101
|
|
|
@@ -103,7 +103,7 @@ The current state of the contract negotiation or an error.
|
|
|
103
103
|
|
|
104
104
|
### offerFromProvider()
|
|
105
105
|
|
|
106
|
-
> **offerFromProvider**(`message`, `trustPayload`): `Promise`\<`
|
|
106
|
+
> **offerFromProvider**(`message`, `trustPayload`): `Promise`\<`IDataspaceProtocolContractNegotiation` \| `IDataspaceProtocolContractNegotiationError`\>
|
|
107
107
|
|
|
108
108
|
An offer has been received by a consumer.
|
|
109
109
|
|
|
@@ -111,7 +111,7 @@ An offer has been received by a consumer.
|
|
|
111
111
|
|
|
112
112
|
##### message
|
|
113
113
|
|
|
114
|
-
`
|
|
114
|
+
`IDataspaceProtocolContractOfferMessage`
|
|
115
115
|
|
|
116
116
|
The offer being received by the consumer.
|
|
117
117
|
|
|
@@ -123,7 +123,7 @@ Trust payload to verify the requesters identity.
|
|
|
123
123
|
|
|
124
124
|
#### Returns
|
|
125
125
|
|
|
126
|
-
`Promise`\<`
|
|
126
|
+
`Promise`\<`IDataspaceProtocolContractNegotiation` \| `IDataspaceProtocolContractNegotiationError`\>
|
|
127
127
|
|
|
128
128
|
The current state of the contract negotiation or an error.
|
|
129
129
|
|
|
@@ -131,7 +131,7 @@ The current state of the contract negotiation or an error.
|
|
|
131
131
|
|
|
132
132
|
### agreementFromProvider()
|
|
133
133
|
|
|
134
|
-
> **agreementFromProvider**(`message`, `trustPayload`): `Promise`\<`
|
|
134
|
+
> **agreementFromProvider**(`message`, `trustPayload`): `Promise`\<`IDataspaceProtocolContractNegotiationError` \| `undefined`\>
|
|
135
135
|
|
|
136
136
|
An agreement has been received by a consumer.
|
|
137
137
|
|
|
@@ -139,7 +139,7 @@ An agreement has been received by a consumer.
|
|
|
139
139
|
|
|
140
140
|
##### message
|
|
141
141
|
|
|
142
|
-
`
|
|
142
|
+
`IDataspaceProtocolContractAgreementMessage`
|
|
143
143
|
|
|
144
144
|
The agreement message to send.
|
|
145
145
|
|
|
@@ -151,7 +151,7 @@ Trust payload to verify the requesters identity.
|
|
|
151
151
|
|
|
152
152
|
#### Returns
|
|
153
153
|
|
|
154
|
-
`Promise`\<`
|
|
154
|
+
`Promise`\<`IDataspaceProtocolContractNegotiationError` \| `undefined`\>
|
|
155
155
|
|
|
156
156
|
The error if there is one.
|
|
157
157
|
|
|
@@ -159,7 +159,7 @@ The error if there is one.
|
|
|
159
159
|
|
|
160
160
|
### agreementVerificationFromConsumer()
|
|
161
161
|
|
|
162
|
-
> **agreementVerificationFromConsumer**(`message`, `trustPayload`): `Promise`\<`
|
|
162
|
+
> **agreementVerificationFromConsumer**(`message`, `trustPayload`): `Promise`\<`IDataspaceProtocolContractNegotiationError` \| `undefined`\>
|
|
163
163
|
|
|
164
164
|
An agreement verification has been received by a provider.
|
|
165
165
|
|
|
@@ -167,7 +167,7 @@ An agreement verification has been received by a provider.
|
|
|
167
167
|
|
|
168
168
|
##### message
|
|
169
169
|
|
|
170
|
-
`
|
|
170
|
+
`IDataspaceProtocolContractAgreementVerificationMessage`
|
|
171
171
|
|
|
172
172
|
The agreement verification message to send.
|
|
173
173
|
|
|
@@ -179,7 +179,7 @@ Trust payload to verify the requesters identity.
|
|
|
179
179
|
|
|
180
180
|
#### Returns
|
|
181
181
|
|
|
182
|
-
`Promise`\<`
|
|
182
|
+
`Promise`\<`IDataspaceProtocolContractNegotiationError` \| `undefined`\>
|
|
183
183
|
|
|
184
184
|
The error if there is one.
|
|
185
185
|
|
|
@@ -187,7 +187,7 @@ The error if there is one.
|
|
|
187
187
|
|
|
188
188
|
### event()
|
|
189
189
|
|
|
190
|
-
> **event**(`message`, `destination`, `trustPayload`): `Promise`\<`
|
|
190
|
+
> **event**(`message`, `destination`, `trustPayload`): `Promise`\<`IDataspaceProtocolContractNegotiationError` \| `undefined`\>
|
|
191
191
|
|
|
192
192
|
An event has been received by the provider or consumer.
|
|
193
193
|
|
|
@@ -195,7 +195,7 @@ An event has been received by the provider or consumer.
|
|
|
195
195
|
|
|
196
196
|
##### message
|
|
197
197
|
|
|
198
|
-
`
|
|
198
|
+
`IDataspaceProtocolContractNegotiationEventMessage`
|
|
199
199
|
|
|
200
200
|
The event message to send.
|
|
201
201
|
|
|
@@ -213,7 +213,7 @@ Trust payload to verify the requesters identity.
|
|
|
213
213
|
|
|
214
214
|
#### Returns
|
|
215
215
|
|
|
216
|
-
`Promise`\<`
|
|
216
|
+
`Promise`\<`IDataspaceProtocolContractNegotiationError` \| `undefined`\>
|
|
217
217
|
|
|
218
218
|
The error if there is one.
|
|
219
219
|
|
|
@@ -221,7 +221,7 @@ The error if there is one.
|
|
|
221
221
|
|
|
222
222
|
### terminate()
|
|
223
223
|
|
|
224
|
-
> **terminate**(`message`, `destination`, `trustPayload`): `Promise`\<`
|
|
224
|
+
> **terminate**(`message`, `destination`, `trustPayload`): `Promise`\<`IDataspaceProtocolContractNegotiationError` \| `undefined`\>
|
|
225
225
|
|
|
226
226
|
A termination message has been received by the provider or consumer.
|
|
227
227
|
|
|
@@ -229,7 +229,7 @@ A termination message has been received by the provider or consumer.
|
|
|
229
229
|
|
|
230
230
|
##### message
|
|
231
231
|
|
|
232
|
-
`
|
|
232
|
+
`IDataspaceProtocolContractNegotiationTerminationMessage`
|
|
233
233
|
|
|
234
234
|
The termination message to send.
|
|
235
235
|
|
|
@@ -247,6 +247,6 @@ Trust payload to verify the requesters identity.
|
|
|
247
247
|
|
|
248
248
|
#### Returns
|
|
249
249
|
|
|
250
|
-
`Promise`\<`
|
|
250
|
+
`Promise`\<`IDataspaceProtocolContractNegotiationError` \| `undefined`\>
|
|
251
251
|
|
|
252
252
|
The error if there is one.
|
package/package.json
CHANGED