@twin.org/rights-management-models 0.0.3-next.36 → 0.0.3-next.38

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.
Files changed (5) hide show
  1. package/dist/es/models/pnp/IPolicyNegotiation.js.map +1 -1
  2. package/dist/types/models/pnp/IPolicyNegotiation.d.ts +7 -2
  3. package/docs/changelog.md +80 -0
  4. package/docs/reference/interfaces/IPolicyNegotiation.md +12 -3
  5. package/package.json +3 -3
package/dist/es/models/pnp/IPolicyNegotiation.js.map CHANGED
@@ -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 { IError } from \"@twin.org/core\";\nimport type {\n\tDataspaceProtocolContractNegotiationStateType,\n\tIDataspaceProtocolAgreement,\n\tIDataspaceProtocolOffer\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { ITrustVerificationInfo } from \"@twin.org/trust-models\";\n\n/**\n * Interface describing a rights management policy negotiation.\n */\nexport interface IPolicyNegotiation {\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 public origin of the server that initiated or received this negotiation.\n\t * Used to construct callback URLs in subsequent async messages.\n\t */\n\tpublicOrigin?: string;\n\n\t/**\n\t * The tenant id this negotiation belongs to.\n\t */\n\ttenantId?: string;\n\n\t/**\n\t * Organization identity to be used when sending trust payloads.\n\t */\n\torganizationIdentity: string;\n\n\t/**\n\t * The offer being requested.\n\t */\n\toffer?: IDataspaceProtocolOffer;\n\n\t/**\n\t * The agreement being established if the negotiation was successful.\n\t */\n\tagreement?: IDataspaceProtocolAgreement;\n\n\t/**\n\t * The information from the trust provider.\n\t */\n\ttrustVerificationInfo?: ITrustVerificationInfo;\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 * Any additional error details that don't fit in the reason or description fields.\n\t */\n\terrorDetails?: IError;\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
+ {"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 { IError } from \"@twin.org/core\";\nimport type {\n\tDataspaceProtocolContractNegotiationStateType,\n\tIDataspaceProtocolAgreement,\n\tIDataspaceProtocolOffer\n} from \"@twin.org/standards-dataspace-protocol\";\nimport type { ITrustVerificationInfo } from \"@twin.org/trust-models\";\n\n/**\n * Interface describing a rights management policy negotiation.\n */\nexport interface IPolicyNegotiation {\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 public origin of the server that initiated or received this negotiation.\n\t * Used to construct callback URLs in subsequent async messages.\n\t */\n\tpublicOrigin?: string;\n\n\t/**\n\t * The tenant id this negotiation belongs to.\n\t */\n\ttenantId?: string;\n\n\t/**\n\t * The node identity (DID) used to sign trust payloads.\n\t */\n\tnodeIdentity: string;\n\n\t/**\n\t * Organization identity (the org DID of the user who initiated or received\n\t * the negotiation, when a user context was available).\n\t */\n\torganizationIdentity?: string;\n\n\t/**\n\t * The offer being requested.\n\t */\n\toffer?: IDataspaceProtocolOffer;\n\n\t/**\n\t * The agreement being established if the negotiation was successful.\n\t */\n\tagreement?: IDataspaceProtocolAgreement;\n\n\t/**\n\t * The information from the trust provider.\n\t */\n\ttrustVerificationInfo?: ITrustVerificationInfo;\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 * Any additional error details that don't fit in the reason or description fields.\n\t */\n\terrorDetails?: IError;\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"]}
package/dist/types/models/pnp/IPolicyNegotiation.d.ts CHANGED
@@ -43,9 +43,14 @@ export interface IPolicyNegotiation {
43
43
  */
44
44
  tenantId?: string;
45
45
  /**
46
- * Organization identity to be used when sending trust payloads.
46
+ * The node identity (DID) used to sign trust payloads.
47
47
  */
48
- organizationIdentity: string;
48
+ nodeIdentity: string;
49
+ /**
50
+ * Organization identity (the org DID of the user who initiated or received
51
+ * the negotiation, when a user context was available).
52
+ */
53
+ organizationIdentity?: string;
49
54
  /**
50
55
  * The offer being requested.
51
56
  */
package/docs/changelog.md CHANGED
@@ -6,6 +6,86 @@
6
6
 
7
7
  * remove EcosystemPolicy models/DTOs and standardize policy typing on `OdrlPolicyType` for v2.
8
8
 
9
+ ## [0.0.3-next.38](https://github.com/iotaledger/twin-rights-management/compare/rights-management-models-v0.0.3-next.37...rights-management-models-v0.0.3-next.38) (2026-06-02)
10
+
11
+
12
+ ### Miscellaneous Chores
13
+
14
+ * **rights-management-models:** Synchronize repo versions
15
+
16
+ ## [0.0.3-next.37](https://github.com/iotaledger/twin-rights-management/compare/rights-management-models-v0.0.3-next.36...rights-management-models-v0.0.3-next.37) (2026-05-26)
17
+
18
+
19
+ ### Features
20
+
21
+ * add canonical twin:jsonPath operand support with legacy compatibility ([#126](https://github.com/iotaledger/twin-rights-management/issues/126)) ([3ab8078](https://github.com/iotaledger/twin-rights-management/commit/3ab8078cacc47a09202e73d66d788276ae218025))
22
+ * add context id features ([#51](https://github.com/iotaledger/twin-rights-management/issues/51)) ([239922c](https://github.com/iotaledger/twin-rights-management/commit/239922c82a7fa94b66c8ee0e924bc58ddaaba395))
23
+ * add DAP (Data Access Point) ([#40](https://github.com/iotaledger/twin-rights-management/issues/40)) ([f3e684b](https://github.com/iotaledger/twin-rights-management/commit/f3e684ba1f9a934394c64635f393fbb6709ff480))
24
+ * add default enforcement processor ([#73](https://github.com/iotaledger/twin-rights-management/issues/73)) ([0c64d49](https://github.com/iotaledger/twin-rights-management/commit/0c64d49bab363b3da6d197536a605f7929a7c584))
25
+ * add default policy arbiter ([#76](https://github.com/iotaledger/twin-rights-management/issues/76)) ([b62ff9c](https://github.com/iotaledger/twin-rights-management/commit/b62ff9ce1b3400c4a95909da01863af47f430dbf))
26
+ * add EcosystemPolicy typed getter across PAP stack ([#114](https://github.com/iotaledger/twin-rights-management/issues/114)) ([2a8e941](https://github.com/iotaledger/twin-rights-management/commit/2a8e941bbea229fb74f81dc869ce1f85c66c300d))
27
+ * add factory pattern ([d26b4c0](https://github.com/iotaledger/twin-rights-management/commit/d26b4c08a2f3ba5758df66a1c48203b8d8e3638e))
28
+ * add JSON-LD types for negotiation ([6be61f8](https://github.com/iotaledger/twin-rights-management/commit/6be61f890537cb9d22d4fad90092b858de2c9c2d))
29
+ * add PEP ([#31](https://github.com/iotaledger/twin-rights-management/issues/31)) ([34c7c29](https://github.com/iotaledger/twin-rights-management/commit/34c7c2965e5c0c2be24460628f83cdae0aa7f0d6))
30
+ * add PIP static source ([#30](https://github.com/iotaledger/twin-rights-management/issues/30)) ([ace4150](https://github.com/iotaledger/twin-rights-management/commit/ace4150df9b529b03e8a3d66a0ce4cbc35744bc4))
31
+ * add policy decision stage ([b3eb5a9](https://github.com/iotaledger/twin-rights-management/commit/b3eb5a96f6270247d198b57c07deca4eeb5cc0bb))
32
+ * add policy information point ([#27](https://github.com/iotaledger/twin-rights-management/issues/27)) ([61a1cd1](https://github.com/iotaledger/twin-rights-management/commit/61a1cd18f0c2c4a847c0a30da70de6814c777e29))
33
+ * add policy management point PMP ([#38](https://github.com/iotaledger/twin-rights-management/issues/38)) ([f7b55f7](https://github.com/iotaledger/twin-rights-management/commit/f7b55f728336a0cacb1aa0ed7866242962915d0e))
34
+ * add policy negotiation point PNP, PNAP and PNRP ([#32](https://github.com/iotaledger/twin-rights-management/issues/32)) ([90f0659](https://github.com/iotaledger/twin-rights-management/commit/90f06593a1126df3c2f4ca23cf95a08260fd6415))
35
+ * add publish workflows ([9f4db27](https://github.com/iotaledger/twin-rights-management/commit/9f4db27cccc724a5061f944b29ed7ed5317c9bbf))
36
+ * add scaffold for other services ([de25f34](https://github.com/iotaledger/twin-rights-management/commit/de25f34c40fb65b6d73df98965ea4e368019da84))
37
+ * add validate-locales ([78f30cf](https://github.com/iotaledger/twin-rights-management/commit/78f30cf61054655c815e5fc42972ee39502e3687))
38
+ * additional pap features ([66cc2db](https://github.com/iotaledger/twin-rights-management/commit/66cc2db71facab2572f55d540dd71398c174d480))
39
+ * additional pap features ([50e60e6](https://github.com/iotaledger/twin-rights-management/commit/50e60e68c2c86a020fef3edc71b16bad85a9f87c))
40
+ * additional pap features ([#69](https://github.com/iotaledger/twin-rights-management/issues/69)) ([a80d511](https://github.com/iotaledger/twin-rights-management/commit/a80d511ace8fad9fbf4c02cb82ead261a5944b34))
41
+ * adopt node/tenant identifier model in PNP + IPolicyNegotiation ([#145](https://github.com/iotaledger/twin-rights-management/issues/145)) ([0911bfc](https://github.com/iotaledger/twin-rights-management/commit/0911bfc6b59d1067958cb3a70d2fae823c9f2359))
42
+ * capture organization identity ([#88](https://github.com/iotaledger/twin-rights-management/issues/88)) ([8fcee6e](https://github.com/iotaledger/twin-rights-management/commit/8fcee6e676bb5a9a344d83c50567066e447aca76))
43
+ * change callback url to callback path ([#65](https://github.com/iotaledger/twin-rights-management/issues/65)) ([f02ceaf](https://github.com/iotaledger/twin-rights-management/commit/f02ceaf0a53083f088690c7d3a384045b1061821))
44
+ * consistent uid usage ([#83](https://github.com/iotaledger/twin-rights-management/issues/83)) ([bdfb9f9](https://github.com/iotaledger/twin-rights-management/commit/bdfb9f92777cbfdb65b5b7df5660b70d869ed19d))
45
+ * engine compatibility updates ([490e015](https://github.com/iotaledger/twin-rights-management/commit/490e015901d6a5ac6563da484a18fc5f285556b1))
46
+ * eslint migration to flat config ([23a0c08](https://github.com/iotaledger/twin-rights-management/commit/23a0c085e7fc2e522c8d85d325dc5844b9c3fd8e))
47
+ * implementing the schedule cleanup ([#85](https://github.com/iotaledger/twin-rights-management/issues/85)) ([cf44bc7](https://github.com/iotaledger/twin-rights-management/commit/cf44bc79c0df9a0a1e60e35849bd46253ce5c8bf))
48
+ * international dataspaces contract negotiation ([#41](https://github.com/iotaledger/twin-rights-management/issues/41)) ([41ed515](https://github.com/iotaledger/twin-rights-management/commit/41ed5154d6cef48bc99db3158dbde6ec88523a0b))
49
+ * introduce context for additional environment input ([e1d0392](https://github.com/iotaledger/twin-rights-management/commit/e1d0392622e5a018b695644f423c5b23cc40d3b7))
50
+ * move create and verify proofs to helper ([a4e1f4a](https://github.com/iotaledger/twin-rights-management/commit/a4e1f4afe01ea12c36f29672197128e65819c875))
51
+ * pap create, update methods ([#13](https://github.com/iotaledger/twin-rights-management/issues/13)) ([edb6c9e](https://github.com/iotaledger/twin-rights-management/commit/edb6c9efcfda55ac96f7594253bf831b4f0e5993))
52
+ * pdp add ([#39](https://github.com/iotaledger/twin-rights-management/issues/39)) ([68b9a8a](https://github.com/iotaledger/twin-rights-management/commit/68b9a8a7a3cf2902f9eecb590ca3316c6b1671f0))
53
+ * pnp callback encryption, getDatasetTargets helper, engine-driven callbackPath ([#132](https://github.com/iotaledger/twin-rights-management/issues/132)) ([e642154](https://github.com/iotaledger/twin-rights-management/commit/e6421546336bfa73a7c0a9fe102beeaa518249dd))
54
+ * policy execution point ([#26](https://github.com/iotaledger/twin-rights-management/issues/26)) ([d930f10](https://github.com/iotaledger/twin-rights-management/commit/d930f104006a0d815cdf222b87d11d749351fb84))
55
+ * policy negotiator callback ([#77](https://github.com/iotaledger/twin-rights-management/issues/77)) ([6566ed0](https://github.com/iotaledger/twin-rights-management/commit/6566ed0e2186b6445f1669f9b2f88a6ce059ab83))
56
+ * refactor models structure ([a19faba](https://github.com/iotaledger/twin-rights-management/commit/a19faba2580d65a9348ae7107e3e930ec37ce48f))
57
+ * remove data access point ([#67](https://github.com/iotaledger/twin-rights-management/issues/67)) ([8573676](https://github.com/iotaledger/twin-rights-management/commit/8573676862c9f1634a66a0677b225b4de16a89cd))
58
+ * remove element factories ([8cb4af8](https://github.com/iotaledger/twin-rights-management/commit/8cb4af85a5c9c01e3b68ecc7109cf701b914ea9a))
59
+ * rename pap entity storage to pap service ([38a2c14](https://github.com/iotaledger/twin-rights-management/commit/38a2c14d8f63a86e398820166c83437be5aca1b8))
60
+ * rights management pap ([#4](https://github.com/iotaledger/twin-rights-management/issues/4)) ([d1165a9](https://github.com/iotaledger/twin-rights-management/commit/d1165a92f57128731cfb308d977832e28cf33493))
61
+ * separate rest routes ([538b86b](https://github.com/iotaledger/twin-rights-management/commit/538b86be26b46711279101aa01fec119419d8149))
62
+ * switch execution callback to class/factory pattern ([60db8cf](https://github.com/iotaledger/twin-rights-management/commit/60db8cfa213d7d4432396b196442d592a5dab6a6))
63
+ * switch execution callback to class/factory pattern ([a6b5660](https://github.com/iotaledger/twin-rights-management/commit/a6b56602aad98652de06961c436c76d52bf42665))
64
+ * switch execution callback to class/factory pattern ([8294daf](https://github.com/iotaledger/twin-rights-management/commit/8294daf933b74a1f90f1a34f206b215e59d76810))
65
+ * typescript 6 update ([18f6f1e](https://github.com/iotaledger/twin-rights-management/commit/18f6f1edba890462c068ba0b76ae6dd005e798be))
66
+ * update contexts ([#63](https://github.com/iotaledger/twin-rights-management/issues/63)) ([e55200f](https://github.com/iotaledger/twin-rights-management/commit/e55200f9929eaced6c446be25969dbe0f95ee909))
67
+ * update dependencies ([5bfbb30](https://github.com/iotaledger/twin-rights-management/commit/5bfbb302bb245c8cd8015ff497db3793077d43cd))
68
+ * update dependencies ([dd0a553](https://github.com/iotaledger/twin-rights-management/commit/dd0a553020b0dc5c41fb6865a2e36bd26045b0b9))
69
+ * update dspace dependencies ([072917b](https://github.com/iotaledger/twin-rights-management/commit/072917bcfa052a6d61e6cd3676e275ba7fc4ec25))
70
+ * update framework core ([d0ffcba](https://github.com/iotaledger/twin-rights-management/commit/d0ffcba9cf1dc2b562193ee298f099612d100ce8))
71
+ * update generated schema external references ([7069a5f](https://github.com/iotaledger/twin-rights-management/commit/7069a5fa517cc1161773a727131a91a79432e26c))
72
+ * update generated schema external references ([8df169f](https://github.com/iotaledger/twin-rights-management/commit/8df169f7008abfd572d866f228f260344bf01a78))
73
+ * update models based on feedback ([1f11df3](https://github.com/iotaledger/twin-rights-management/commit/1f11df32bdae5e0a9119e3eee9346b970c5fd345))
74
+ * update namespaces and contexts ([#61](https://github.com/iotaledger/twin-rights-management/issues/61)) ([033446b](https://github.com/iotaledger/twin-rights-management/commit/033446b91ccf0c7664061afda9a1ad49d3c671ec))
75
+ * update processors ([#71](https://github.com/iotaledger/twin-rights-management/issues/71)) ([d6e8c1e](https://github.com/iotaledger/twin-rights-management/commit/d6e8c1e593acb28556674d5180123f220766eb6b))
76
+ * update standards packages ([db0740b](https://github.com/iotaledger/twin-rights-management/commit/db0740b1d8925fcb3bf4204641e0dc573af40f2b))
77
+ * update to more specific ds odrl types ([c56dc49](https://github.com/iotaledger/twin-rights-management/commit/c56dc4991d4e1e8ca3beb737d2a70dddf6f5cd44))
78
+ * update to use built in vc authentication ([f982b86](https://github.com/iotaledger/twin-rights-management/commit/f982b8676a7d21add85195c73558ef4f0fd9be29))
79
+ * use shared store mechanism ([#2](https://github.com/iotaledger/twin-rights-management/issues/2)) ([21c086d](https://github.com/iotaledger/twin-rights-management/commit/21c086d7be3989858ee28bedb7a1e7b97d65b752))
80
+
81
+
82
+ ### Bug Fixes
83
+
84
+ * correct PXP naming in comments ([1cd9053](https://github.com/iotaledger/twin-rights-management/commit/1cd9053eaa1c56a53d3cc52e75ea4d242bbe2654))
85
+ * query params force coercion ([8590a0d](https://github.com/iotaledger/twin-rights-management/commit/8590a0da92584c04b67e73c448319f96f70c34a5))
86
+ * resolve 5 bugs preventing PNP contract negotiation callbacks ([#98](https://github.com/iotaledger/twin-rights-management/issues/98)) ([4a065d6](https://github.com/iotaledger/twin-rights-management/commit/4a065d669440f47dc44c3602abe7efa1ea9d45ff))
87
+ * typos ([a969249](https://github.com/iotaledger/twin-rights-management/commit/a969249cc3c8d9680880be4379a4bb546c48e935))
88
+
9
89
  ## [0.0.3-next.36](https://github.com/iotaledger/twin-rights-management/compare/rights-management-models-v0.0.3-next.35...rights-management-models-v0.0.3-next.36) (2026-05-20)
10
90
 
11
91
 
package/docs/reference/interfaces/IPolicyNegotiation.md CHANGED
@@ -77,11 +77,20 @@ The tenant id this negotiation belongs to.
77
77
 
78
78
  ***
79
79
 
80
- ### organizationIdentity {#organizationidentity}
80
+ ### nodeIdentity {#nodeidentity}
81
81
 
82
- > **organizationIdentity**: `string`
82
+ > **nodeIdentity**: `string`
83
83
 
84
- Organization identity to be used when sending trust payloads.
84
+ The node identity (DID) used to sign trust payloads.
85
+
86
+ ***
87
+
88
+ ### organizationIdentity? {#organizationidentity}
89
+
90
+ > `optional` **organizationIdentity?**: `string`
91
+
92
+ Organization identity (the org DID of the user who initiated or received
93
+ the negotiation, when a user context was available).
85
94
 
86
95
  ***
87
96
 
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/rights-management-models",
3
- "version": "0.0.3-next.36",
3
+ "version": "0.0.3-next.38",
4
4
  "description": "Data model definitions for rights management policies, negotiations, and service contracts.",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "git+https://github.com/iotaledger/rights-management.git",
7
+ "url": "git+https://github.com/iotaledger/twin-rights-management.git",
8
8
  "directory": "packages/rights-management-models"
9
9
  },
10
10
  "author": "martyn.janes@iota.org",
@@ -54,7 +54,7 @@
54
54
  "schemas"
55
55
  ],
56
56
  "bugs": {
57
- "url": "git+https://github.com/iotaledger/rights-management/issues"
57
+ "url": "git+https://github.com/iotaledger/twin-rights-management/issues"
58
58
  },
59
59
  "homepage": "https://twindev.org"
60
60
  }