@twin.org/rights-management-models 0.0.2-next.11 → 0.0.2-next.13

package/dist/types/models/pnp/IPolicyNegotiationPointComponent.d.ts

@@ -1,4 +1,5 @@
 import type { IComponent } from "@twin.org/core";
+import type { IIdentityAuthenticationActionRequest } from "@twin.org/identity-authentication";
 import type { IIdsContractAgreementMessage, IIdsContractAgreementVerificationMessage, IIdsContractNegotiation, IIdsContractNegotiationError, IIdsContractNegotiationEventMessage, IIdsContractNegotiationTerminationMessage, IIdsContractOfferMessage, IIdsContractRequestMessage } from "@twin.org/standards-ids-contract-negotiation";
 import type { IOdrlOffer } from "@twin.org/standards-w3c-odrl";
 import type { IPolicyNegotiator } from "./IPolicyNegotiator";
@@ -13,10 +14,10 @@ export interface IPolicyNegotiationPointComponent extends IComponent {
     /**
      * Get the current state of the negotiation.
      * @param id The id of the negotiation to retrieve.
-     * @param proofToken The proof provided by the requester to support the get.
+     * @param actionRequest The action request used in the verifiable credential.
      * @returns The current state of the negotiation or an error.
      */
-    getNegotiation(id: string, proofToken: string): Promise<IIdsContractNegotiation | IIdsContractNegotiationError>;
+    getNegotiation(id: string, actionRequest: IIdentityAuthenticationActionRequest): Promise<IIdsContractNegotiation | IIdsContractNegotiationError>;
     /**
      * Send a request to a provider.
      * @param url The url of the provider to send the request to.
@@ -28,47 +29,47 @@ export interface IPolicyNegotiationPointComponent extends IComponent {
     /**
      * Processes an incoming request on a provider from a consumer.
      * @param message The negotiation request.
-     * @param proofToken The proof provided by the requester to support the policy creation.
+     * @param actionRequest The action request used in the verifiable credential.
      * @returns The current state of the contract negotiation or an error.
      */
-    requestFromConsumer(message: IIdsContractRequestMessage, proofToken: string): Promise<IIdsContractNegotiation | IIdsContractNegotiationError>;
+    requestFromConsumer(message: IIdsContractRequestMessage, actionRequest: IIdentityAuthenticationActionRequest): Promise<IIdsContractNegotiation | IIdsContractNegotiationError>;
     /**
      * An offer has been received by a consumer.
      * @param message The offer being received by the consumer.
-     * @param proofToken The proof provided by the requester to support the offer.
+     * @param actionRequest The action request used in the verifiable credential.
      * @returns The current state of the contract negotiation or an error.
      */
-    offerFromProvider(message: IIdsContractOfferMessage, proofToken: string): Promise<IIdsContractNegotiation | IIdsContractNegotiationError>;
+    offerFromProvider(message: IIdsContractOfferMessage, actionRequest: IIdentityAuthenticationActionRequest): Promise<IIdsContractNegotiation | IIdsContractNegotiationError>;
     /**
      * An agreement has been received by a consumer.
      * @param message The agreement message to send.
-     * @param proofToken The proof provided by the requester to support the agreement.
+     * @param actionRequest The action request used in the verifiable credential.
      * @returns The error if there is one.
      */
-    agreementFromProvider(message: IIdsContractAgreementMessage, proofToken: string): Promise<IIdsContractNegotiationError | undefined>;
+    agreementFromProvider(message: IIdsContractAgreementMessage, actionRequest: IIdentityAuthenticationActionRequest): Promise<IIdsContractNegotiationError | undefined>;
     /**
      * An agreement verification has been received by a provider.
      * @param message The agreement verification message to send.
-     * @param proofToken The proof provided by the requester to support the agreement.
+     * @param actionRequest The action request used in the verifiable credential.
      * @returns The error if there is one.
      */
-    agreementVerificationFromConsumer(message: IIdsContractAgreementVerificationMessage, proofToken: string): Promise<IIdsContractNegotiationError | undefined>;
+    agreementVerificationFromConsumer(message: IIdsContractAgreementVerificationMessage, actionRequest: IIdentityAuthenticationActionRequest): Promise<IIdsContractNegotiationError | undefined>;
     /**
      * An event has been received by the provider or consumer.
      * @param message The event message to send.
      * @param destination The destination is provider or consumer.
-     * @param proofToken The proof provided by the requester to support the event.
+     * @param actionRequest The action request used in the verifiable credential.
      * @returns The error if there is one.
      */
-    event(message: IIdsContractNegotiationEventMessage, destination: "provider" | "consumer", proofToken: string): Promise<IIdsContractNegotiationError | undefined>;
+    event(message: IIdsContractNegotiationEventMessage, destination: "provider" | "consumer", actionRequest: IIdentityAuthenticationActionRequest): Promise<IIdsContractNegotiationError | undefined>;
     /**
      * A termination message has been received by the provider or consumer.
      * @param message The termination message to send.
      * @param destination The destination is provider or consumer.
-     * @param proofToken The proof provided by the requester to support the termination.
+     * @param actionRequest The action request used in the verifiable credential.
      * @returns The error if there is one.
      */
-    terminate(message: IIdsContractNegotiationTerminationMessage, destination: "provider" | "consumer", proofToken: string): Promise<IIdsContractNegotiationError | undefined>;
+    terminate(message: IIdsContractNegotiationTerminationMessage, destination: "provider" | "consumer", actionRequest: IIdentityAuthenticationActionRequest): Promise<IIdsContractNegotiationError | undefined>;
     /**
      * Register a negotiator to use for handling data.
      * @param negotiatorId The id of the negotiator to register.

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

@@ -2,10 +2,6 @@
  * The types of Rights Management data.
  */
 export declare const RightsManagementTypes: {
-    /**
-     * Represents policy request.
-     */
-    readonly PolicyRequest: "PolicyRequest";
     /**
      * Represents data access request.
      */

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # @twin.org/rights-management-models - Changelog
 
+## [0.0.2-next.13](https://github.com/twinfoundation/rights-management/compare/rights-management-models-v0.0.2-next.12...rights-management-models-v0.0.2-next.13) (2025-09-23)
+
+
+### Features
+
+* update to use built in vc authentication ([f982b86](https://github.com/twinfoundation/rights-management/commit/f982b8676a7d21add85195c73558ef4f0fd9be29))
+
+## [0.0.2-next.12](https://github.com/twinfoundation/rights-management/compare/rights-management-models-v0.0.2-next.11...rights-management-models-v0.0.2-next.12) (2025-09-22)
+
+
+### Miscellaneous Chores
+
+* **rights-management-models:** Synchronize repo versions
+
 ## [0.0.2-next.11](https://github.com/twinfoundation/rights-management/compare/rights-management-models-v0.0.2-next.10...rights-management-models-v0.0.2-next.11) (2025-09-19)
 
 

package/docs/reference/index.md

@@ -4,7 +4,6 @@
 
 - [LocatorHelper](classes/LocatorHelper.md)
 - [OdrlPolicyHelper](classes/OdrlPolicyHelper.md)
-- [RightsManagementTokenHelper](classes/RightsManagementTokenHelper.md)
 
 ## Interfaces
 
@@ -60,7 +59,6 @@
 - [IPolicyNegotiationPointComponent](interfaces/IPolicyNegotiationPointComponent.md)
 - [IPolicyNegotiator](interfaces/IPolicyNegotiator.md)
 - [IPolicyRequester](interfaces/IPolicyRequester.md)
-- [IPolicyRequest](interfaces/IPolicyRequest.md)
 - [IPolicyExecutionAction](interfaces/IPolicyExecutionAction.md)
 - [IPolicyExecutionPointComponent](interfaces/IPolicyExecutionPointComponent.md)
 

package/docs/reference/interfaces/IDapCreateRequest.md

@@ -14,9 +14,9 @@ The headers which can be used to determine the response data type.
 
 > `optional` **accept**: `"application/ld+json"` \| `"application/json"`
 
-#### authorization
+#### authorization?
 
-> **authorization**: `string`
+> `optional` **authorization**: `string`
 
 ***
 
@@ -39,3 +39,11 @@ The type of the item being created.
 > **body**: [`IDataAccessRequestWithObject`](IDataAccessRequestWithObject.md)
 
 The body parameters of the request.
+
+***
+
+### authentication
+
+> **authentication**: `IIdentityAuthenticationActionRequest`
+
+The action request used in the verifiable credential.

package/docs/reference/interfaces/IDapGetRequest.md

@@ -14,9 +14,9 @@ The headers which can be used to determine the response data type.
 
 > `optional` **accept**: `"application/ld+json"` \| `"application/json"`
 
-#### authorization
+#### authorization?
 
-> **authorization**: `string`
+> `optional` **authorization**: `string`
 
 ***
 
@@ -37,3 +37,11 @@ The type of the item being requested.
 > **id**: `string`
 
 The id of the item being requested.
+
+***
+
+### authentication
+
+> **authentication**: `IIdentityAuthenticationActionRequest`
+
+The action request used in the verifiable credential.

package/docs/reference/interfaces/IDapQueryRequest.md

@@ -14,9 +14,9 @@ The headers which can be used to determine the response data type.
 
 > `optional` **accept**: `"application/ld+json"` \| `"application/json"`
 
-#### authorization
+#### authorization?
 
-> **authorization**: `string`
+> `optional` **authorization**: `string`
 
 ***
 
@@ -39,3 +39,11 @@ The type of the item being requested.
 > **body**: [`IDataAccessQuery`](IDataAccessQuery.md)
 
 The body parameters of the request.
+
+***
+
+### authentication
+
+> **authentication**: `IIdentityAuthenticationActionRequest`
+
+The action request used in the verifiable credential.

package/docs/reference/interfaces/IDapRemoveRequest.md

@@ -14,9 +14,9 @@ The headers which can be used to determine the response data type.
 
 > `optional` **accept**: `"application/ld+json"` \| `"application/json"`
 
-#### authorization
+#### authorization?
 
-> **authorization**: `string`
+> `optional` **authorization**: `string`
 
 ***
 
@@ -37,3 +37,11 @@ The type of the item being removed.
 > **id**: `string`
 
 The id of the item being removed.
+
+***
+
+### authentication
+
+> **authentication**: `IIdentityAuthenticationActionRequest`
+
+The action request used in the verifiable credential.

package/docs/reference/interfaces/IDapUpdateRequest.md

@@ -14,9 +14,9 @@ The headers which can be used to determine the response data type.
 
 > `optional` **accept**: `"application/ld+json"` \| `"application/json"`
 
-#### authorization
+#### authorization?
 
-> **authorization**: `string`
+> `optional` **authorization**: `string`
 
 ***
 
@@ -45,3 +45,11 @@ The id of the item being updated.
 > **body**: [`IDataAccessRequestWithObject`](IDataAccessRequestWithObject.md)
 
 The body parameters of the updated.
+
+***
+
+### authentication
+
+> **authentication**: `IIdentityAuthenticationActionRequest`
+
+The action request used in the verifiable credential.

package/docs/reference/interfaces/IDataAccessPointComponent.md

@@ -13,7 +13,7 @@ The registered data handlers support specific asset types.
 
 ### create()
 
-> **create**(`assetType`, `item`, `proofToken`): `Promise`\<`string`\>
+> **create**(`assetType`, `item`, `actionRequest`): `Promise`\<`string`\>
 
 Create an item.
 
@@ -31,11 +31,11 @@ The type of the item to create.
 
 The item to create.
 
-##### proofToken
+##### actionRequest
 
-`string`
+`IIdentityAuthenticationActionRequest`
 
-The proof provided by the requester to support the creation.
+The action request used in the verifiable credential.
 
 #### Returns
 
@@ -47,7 +47,7 @@ The id of the item created, for some items this is supplied in the `item`.
 
 ### get()
 
-> **get**(`assetType`, `id`, `proofToken`): `Promise`\<`IJsonLdNodeObject`\>
+> **get**(`assetType`, `id`, `actionRequest`): `Promise`\<`IJsonLdNodeObject`\>
 
 Get an item.
 
@@ -65,11 +65,11 @@ The type of the item to retrieve.
 
 The ID of the item to retrieve.
 
-##### proofToken
+##### actionRequest
 
-`string`
+`IIdentityAuthenticationActionRequest`
 
-The proof provided by the requester to support the lookup.
+The action request used in the verifiable credential.
 
 #### Returns
 
@@ -81,7 +81,7 @@ The item retrieved if the policies allow it.
 
 ### update()
 
-> **update**(`assetType`, `item`, `proofToken`): `Promise`\<`void`\>
+> **update**(`assetType`, `item`, `actionRequest`): `Promise`\<`void`\>
 
 Update an item.
 
@@ -99,11 +99,11 @@ The type of the item to update.
 
 The item to update.
 
-##### proofToken
+##### actionRequest
 
-`string`
+`IIdentityAuthenticationActionRequest`
 
-The proof provided by the requester to support the update.
+The action request used in the verifiable credential.
 
 #### Returns
 
@@ -115,7 +115,7 @@ Nothing.
 
 ### remove()
 
-> **remove**(`assetType`, `id`, `proofToken`): `Promise`\<`void`\>
+> **remove**(`assetType`, `id`, `actionRequest`): `Promise`\<`void`\>
 
 Remove an item.
 
@@ -133,11 +133,11 @@ The type of the item to remove.
 
 The id of the item to remove.
 
-##### proofToken
+##### actionRequest
 
-`string`
+`IIdentityAuthenticationActionRequest`
 
-The proof provided by the requester to support the removal.
+The action request used in the verifiable credential.
 
 #### Returns
 
@@ -149,7 +149,7 @@ Nothing.
 
 ### query()
 
-> **query**(`assetType`, `conditions`, `cursor`, `options`, `proofToken`): `Promise`\<\{ `items`: `IJsonLdNodeObject`[]; `cursor?`: `string`; \}\>
+> **query**(`assetType`, `conditions`, `cursor`, `options`, `actionRequest`): `Promise`\<\{ `items`: `IJsonLdNodeObject`[]; `cursor?`: `string`; \}\>
 
 Query for items.
 
@@ -179,11 +179,11 @@ The cursor for pagination.
 
 Additional options which might be supported by the handler.
 
-##### proofToken
+##### actionRequest
 
-`string`
+`IIdentityAuthenticationActionRequest`
 
-The proof provided by the requester to support the query.
+The action request used in the verifiable credential.
 
 #### Returns
 

package/docs/reference/interfaces/IPnpAgreementRequest.md

@@ -14,9 +14,9 @@ The headers which can be used to determine the response data type.
 
 > `optional` **accept**: `"application/ld+json"` \| `"application/json"`
 
-#### authorization
+#### authorization?
 
-> **authorization**: `string`
+> `optional` **authorization**: `string`
 
 ***
 
@@ -39,3 +39,11 @@ The identifier of the negotiation to target.
 > **body**: `IIdsContractAgreementMessage`
 
 The body parameters of the request.
+
+***
+
+### authentication
+
+> **authentication**: `IIdentityAuthenticationActionRequest`
+
+The action request used in the verifiable credential.

package/docs/reference/interfaces/IPnpAgreementVerificationRequest.md

@@ -14,9 +14,9 @@ The headers which can be used to determine the response data type.
 
 > `optional` **accept**: `"application/ld+json"` \| `"application/json"`
 
-#### authorization
+#### authorization?
 
-> **authorization**: `string`
+> `optional` **authorization**: `string`
 
 ***
 
@@ -39,3 +39,11 @@ The identifier of the contract negotiation to be retrieved.
 > **body**: `IIdsContractAgreementVerificationMessage`
 
 The body parameters of the request.
+
+***
+
+### authentication
+
+> **authentication**: `IIdentityAuthenticationActionRequest`
+
+The action request used in the verifiable credential.

package/docs/reference/interfaces/IPnpEventRequest.md

@@ -14,9 +14,9 @@ The headers which can be used to determine the response data type.
 
 > `optional` **accept**: `"application/ld+json"` \| `"application/json"`
 
-#### authorization
+#### authorization?
 
-> **authorization**: `string`
+> `optional` **authorization**: `string`
 
 ***
 
@@ -39,3 +39,11 @@ The identifier of the negotiation to target.
 > **body**: `IIdsContractNegotiationEventMessage`
 
 The body parameters of the request.
+
+***
+
+### authentication
+
+> **authentication**: `IIdentityAuthenticationActionRequest`
+
+The action request used in the verifiable credential.

package/docs/reference/interfaces/IPnpNegotiateRequest.md

@@ -14,9 +14,9 @@ The headers which can be used to determine the response data type.
 
 > `optional` **accept**: `"application/ld+json"` \| `"application/json"`
 
-#### authorization
+#### authorization?
 
-> **authorization**: `string`
+> `optional` **authorization**: `string`
 
 ***
 
@@ -39,3 +39,11 @@ The identifier of the contract negotiation to be retrieved, can be undefined.
 > **body**: `IIdsContractRequestMessage`
 
 The body parameters of the request.
+
+***
+
+### authentication
+
+> **authentication**: `IIdentityAuthenticationActionRequest`
+
+The action request used in the verifiable credential.

package/docs/reference/interfaces/IPnpNegotiationGetRequest.md

@@ -14,9 +14,9 @@ The headers which can be used to determine the response data type.
 
 > `optional` **accept**: `"application/ld+json"` \| `"application/json"`
 
-#### authorization
+#### authorization?
 
-> **authorization**: `string`
+> `optional` **authorization**: `string`
 
 ***
 
@@ -31,3 +31,11 @@ The path parameters of the request.
 > **id**: `string`
 
 The identifier of the contract negotiation to be retrieved.
+
+***
+
+### authentication
+
+> **authentication**: `IIdentityAuthenticationActionRequest`
+
+The action request used in the verifiable credential.

package/docs/reference/interfaces/IPnpOfferRequest.md

@@ -14,9 +14,9 @@ The headers which can be used to determine the response data type.
 
 > `optional` **accept**: `"application/ld+json"` \| `"application/json"`
 
-#### authorization
+#### authorization?
 
-> **authorization**: `string`
+> `optional` **authorization**: `string`
 
 ***
 
@@ -39,3 +39,11 @@ The identifier of the consumer being offered, this can be undefined.
 > **body**: `IIdsContractOfferMessage`
 
 The body parameters of the request.
+
+***
+
+### authentication
+
+> **authentication**: `IIdentityAuthenticationActionRequest`
+
+The action request used in the verifiable credential.

package/docs/reference/interfaces/IPnpTerminateRequest.md

@@ -14,9 +14,9 @@ The headers which can be used to determine the response data type.
 
 > `optional` **accept**: `"application/ld+json"` \| `"application/json"`
 
-#### authorization
+#### authorization?
 
-> **authorization**: `string`
+> `optional` **authorization**: `string`
 
 ***
 
@@ -39,3 +39,11 @@ The identifier of the negotiation to target.
 > **body**: `IIdsContractNegotiationTerminationMessage`
 
 The body parameters of the request.
+
+***
+
+### authentication
+
+> **authentication**: `IIdentityAuthenticationActionRequest`
+
+The action request used in the verifiable credential.