@twin.org/rights-management-models 0.0.3-next.50 → 0.0.3-next.52
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/index.js +8 -7
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/IRightsManagementAgreement.js.map +1 -1
- package/dist/es/models/IRightsManagementOffer.js.map +1 -1
- package/dist/es/models/IRightsManagementPolicy.js.map +1 -1
- package/dist/es/models/IRightsManagementPolicyTrust.js +2 -0
- package/dist/es/models/IRightsManagementPolicyTrust.js.map +1 -0
- package/dist/es/models/IRightsManagementSet.js.map +1 -1
- package/dist/es/models/pdp/IPolicyDecisionPointComponent.js.map +1 -1
- package/dist/es/models/pep/IPolicyEnforcementPointComponent.js.map +1 -1
- package/dist/types/index.d.ts +8 -7
- package/dist/types/models/IRightsManagementAgreement.d.ts +3 -1
- package/dist/types/models/IRightsManagementOffer.d.ts +3 -1
- package/dist/types/models/IRightsManagementPolicy.d.ts +3 -4
- package/dist/types/models/IRightsManagementPolicyTrust.d.ts +12 -0
- package/dist/types/models/IRightsManagementSet.d.ts +3 -1
- package/dist/types/models/pdp/IPolicyDecisionPointComponent.d.ts +5 -1
- package/dist/types/models/pep/IPolicyEnforcementPointComponent.d.ts +5 -1
- package/docs/changelog.md +14 -0
- package/docs/reference/classes/OdrlPolicyHelper.md +4 -4
- package/docs/reference/index.md +5 -4
- package/docs/reference/interfaces/IPapCreateRequest.md +1 -1
- package/docs/reference/interfaces/IPapGetAgreementResponse.md +1 -1
- package/docs/reference/interfaces/IPapGetOfferResponse.md +1 -1
- package/docs/reference/interfaces/IPapGetResponse.md +1 -1
- package/docs/reference/interfaces/IPapGetSetResponse.md +1 -1
- package/docs/reference/interfaces/IPapQueryResponse.md +1 -1
- package/docs/reference/interfaces/IPapUpdateRequest.md +1 -1
- package/docs/reference/interfaces/IPolicyAdministrationPointComponent.md +13 -13
- package/docs/reference/interfaces/IPolicyDecisionPointComponent.md +5 -1
- package/docs/reference/interfaces/IPolicyEnforcementPointComponent.md +5 -1
- package/docs/reference/interfaces/IPolicyExecutionAction.md +1 -1
- package/docs/reference/interfaces/IPolicyExecutionPointComponent.md +1 -1
- package/docs/reference/interfaces/IPolicyInformationPointComponent.md +1 -1
- package/docs/reference/interfaces/IPolicyInformationSource.md +1 -1
- package/docs/reference/interfaces/IPolicyManagementPointComponent.md +2 -2
- package/docs/reference/interfaces/IPolicyObligationEnforcer.md +1 -1
- package/docs/reference/interfaces/IRightsManagementAgreement.md +47 -0
- package/docs/reference/interfaces/IRightsManagementOffer.md +47 -0
- package/docs/reference/interfaces/IRightsManagementPolicy.md +47 -0
- package/docs/reference/interfaces/IRightsManagementPolicyMetadata.md +7 -0
- package/docs/reference/interfaces/IRightsManagementPolicyTrust.md +22 -0
- package/docs/reference/interfaces/IRightsManagementSet.md +47 -0
- package/package.json +1 -1
- package/docs/reference/type-aliases/IRightsManagementAgreement.md +0 -5
- package/docs/reference/type-aliases/IRightsManagementOffer.md +0 -5
- package/docs/reference/type-aliases/IRightsManagementPolicy.md +0 -11
- package/docs/reference/type-aliases/IRightsManagementSet.md +0 -5
package/dist/es/index.js
CHANGED
|
@@ -10,13 +10,6 @@ export * from "./factories/policyRequesterFactory.js";
|
|
|
10
10
|
export * from "./models/api/pap/IPapCreateRequest.js";
|
|
11
11
|
export * from "./models/api/pap/IPapGetAgreementRequest.js";
|
|
12
12
|
export * from "./models/api/pap/IPapGetAgreementResponse.js";
|
|
13
|
-
export * from "./models/IRightsManagementAgreement.js";
|
|
14
|
-
export * from "./models/IRightsManagementOffer.js";
|
|
15
|
-
export * from "./models/IRightsManagementPolicy.js";
|
|
16
|
-
export * from "./models/IRightsManagementPolicyMetadata.js";
|
|
17
|
-
export * from "./models/policyMetadataContext.js";
|
|
18
|
-
export * from "./models/IRightsManagementSet.js";
|
|
19
|
-
export * from "./models/odrlProfiles.js";
|
|
20
13
|
export * from "./models/api/pap/IPapGetOfferRequest.js";
|
|
21
14
|
export * from "./models/api/pap/IPapGetOfferResponse.js";
|
|
22
15
|
export * from "./models/api/pap/IPapGetRequest.js";
|
|
@@ -43,6 +36,13 @@ export * from "./models/api/pnp/IPnpNegotiateRequest.js";
|
|
|
43
36
|
export * from "./models/api/pnp/IPnpNegotiationGetRequest.js";
|
|
44
37
|
export * from "./models/api/pnp/IPnpOfferRequest.js";
|
|
45
38
|
export * from "./models/api/pnp/IPnpTerminateRequest.js";
|
|
39
|
+
export * from "./models/IRightsManagementAgreement.js";
|
|
40
|
+
export * from "./models/IRightsManagementOffer.js";
|
|
41
|
+
export * from "./models/IRightsManagementPolicy.js";
|
|
42
|
+
export * from "./models/IRightsManagementPolicyMetadata.js";
|
|
43
|
+
export * from "./models/IRightsManagementPolicyTrust.js";
|
|
44
|
+
export * from "./models/IRightsManagementSet.js";
|
|
45
|
+
export * from "./models/odrlProfiles.js";
|
|
46
46
|
export * from "./models/pap/IPolicyAdministrationPointComponent.js";
|
|
47
47
|
export * from "./models/pdp/IPolicyArbiter.js";
|
|
48
48
|
export * from "./models/pdp/IPolicyDecision.js";
|
|
@@ -61,6 +61,7 @@ export * from "./models/pnp/IPolicyNegotiationAdminPointComponent.js";
|
|
|
61
61
|
export * from "./models/pnp/IPolicyNegotiationPointComponent.js";
|
|
62
62
|
export * from "./models/pnp/IPolicyNegotiator.js";
|
|
63
63
|
export * from "./models/pnp/IPolicyRequester.js";
|
|
64
|
+
export * from "./models/policyMetadataContext.js";
|
|
64
65
|
export * from "./models/pxp/IPolicyExecutionAction.js";
|
|
65
66
|
export * from "./models/pxp/IPolicyExecutionPointComponent.js";
|
|
66
67
|
export * from "./models/rightsManagementContexts.js";
|
package/dist/es/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,qCAAqC,CAAC;AACpD,cAAc,kDAAkD,CAAC;AACjE,cAAc,6CAA6C,CAAC;AAC5D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,wCAAwC,CAAC;AACvD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AACtD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,qCAAqC,CAAC;AACpD,cAAc,kDAAkD,CAAC;AACjE,cAAc,6CAA6C,CAAC;AAC5D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,wCAAwC,CAAC;AACvD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AACtD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AACzD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AACtD,cAAc,uCAAuC,CAAC;AACtD,cAAc,yCAAyC,CAAC;AACxD,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,yCAAyC,CAAC;AACxD,cAAc,sCAAsC,CAAC;AACrD,cAAc,0CAA0C,CAAC;AACzD,cAAc,sDAAsD,CAAC;AACrE,cAAc,qDAAqD,CAAC;AACpE,cAAc,0CAA0C,CAAC;AACzD,cAAc,sCAAsC,CAAC;AACrD,cAAc,0CAA0C,CAAC;AACzD,cAAc,+CAA+C,CAAC;AAC9D,cAAc,sCAAsC,CAAC;AACrD,cAAc,0CAA0C,CAAC;AACzD,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0CAA0C,CAAC;AACzD,cAAc,kCAAkC,CAAC;AACjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,qDAAqD,CAAC;AACpE,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,+CAA+C,CAAC;AAC9D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,kDAAkD,CAAC;AACjE,cAAc,6CAA6C,CAAC;AAC5D,cAAc,kDAAkD,CAAC;AACjE,cAAc,0CAA0C,CAAC;AACzD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,iDAAiD,CAAC;AAChE,cAAc,oCAAoC,CAAC;AACnD,cAAc,uDAAuD,CAAC;AACtE,cAAc,kDAAkD,CAAC;AACjE,cAAc,mCAAmC,CAAC;AAClD,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,wCAAwC,CAAC;AACvD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,sCAAsC,CAAC;AACrD,cAAc,wCAAwC,CAAC;AACvD,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/policyArbiterFactory.js\";\nexport * from \"./factories/policyEnforcementProcessorFactory.js\";\nexport * from \"./factories/policyExecutionActionFactory.js\";\nexport * from \"./factories/policyInformationSourceFactory.js\";\nexport * from \"./factories/policyNegotiatorFactory.js\";\nexport * from \"./factories/policyObligationEnforcerFactory.js\";\nexport * from \"./factories/policyRequesterFactory.js\";\nexport * from \"./models/api/pap/IPapCreateRequest.js\";\nexport * from \"./models/api/pap/IPapGetAgreementRequest.js\";\nexport * from \"./models/api/pap/IPapGetAgreementResponse.js\";\nexport * from \"./models/api/pap/IPapGetOfferRequest.js\";\nexport * from \"./models/api/pap/IPapGetOfferResponse.js\";\nexport * from \"./models/api/pap/IPapGetRequest.js\";\nexport * from \"./models/api/pap/IPapGetResponse.js\";\nexport * from \"./models/api/pap/IPapGetSetRequest.js\";\nexport * from \"./models/api/pap/IPapGetSetResponse.js\";\nexport * from \"./models/api/pap/IPapQueryRequest.js\";\nexport * from \"./models/api/pap/IPapQueryResponse.js\";\nexport * from \"./models/api/pap/IPapRemoveRequest.js\";\nexport * from \"./models/api/pap/IPapUpdateRequest.js\";\nexport * from \"./models/api/pnap/IPnapCreateRequest.js\";\nexport * from \"./models/api/pnap/IPnapGetRequest.js\";\nexport * from \"./models/api/pnap/IPnapGetResponse.js\";\nexport * from \"./models/api/pnap/IPnapQueryRequest.js\";\nexport * from \"./models/api/pnap/IPnapQueryResponse.js\";\nexport * from \"./models/api/pnap/IPnapRemoveRequest.js\";\nexport * from \"./models/api/pnap/IPnapSetRequest.js\";\nexport * from \"./models/api/pnp/IPnpAgreementRequest.js\";\nexport * from \"./models/api/pnp/IPnpAgreementVerificationRequest.js\";\nexport * from \"./models/api/pnp/IPnpContractNegotiationResponse.js\";\nexport * from \"./models/api/pnp/IPnpContractResponse.js\";\nexport * from \"./models/api/pnp/IPnpEventRequest.js\";\nexport * from \"./models/api/pnp/IPnpNegotiateRequest.js\";\nexport * from \"./models/api/pnp/IPnpNegotiationGetRequest.js\";\nexport * from \"./models/api/pnp/IPnpOfferRequest.js\";\nexport * from \"./models/api/pnp/IPnpTerminateRequest.js\";\nexport * from \"./models/IRightsManagementAgreement.js\";\nexport * from \"./models/IRightsManagementOffer.js\";\nexport * from \"./models/IRightsManagementPolicy.js\";\nexport * from \"./models/IRightsManagementPolicyMetadata.js\";\nexport * from \"./models/IRightsManagementPolicyTrust.js\";\nexport * from \"./models/IRightsManagementSet.js\";\nexport * from \"./models/odrlProfiles.js\";\nexport * from \"./models/pap/IPolicyAdministrationPointComponent.js\";\nexport * from \"./models/pdp/IPolicyArbiter.js\";\nexport * from \"./models/pdp/IPolicyDecision.js\";\nexport * from \"./models/pdp/IPolicyDecisionPointComponent.js\";\nexport * from \"./models/pdp/IPolicyObligationEnforcer.js\";\nexport * from \"./models/pdp/policyDecision.js\";\nexport * from \"./models/pdp/policyDecisionStage.js\";\nexport * from \"./models/pep/IPolicyEnforcementPointComponent.js\";\nexport * from \"./models/pep/IPolicyEnforcementProcessor.js\";\nexport * from \"./models/pip/IPolicyInformationPointComponent.js\";\nexport * from \"./models/pip/IPolicyInformationSource.js\";\nexport * from \"./models/pip/policyInformationAccessMode.js\";\nexport * from \"./models/pmp/IPolicyManagementPointComponent.js\";\nexport * from \"./models/pnp/IPolicyNegotiation.js\";\nexport * from \"./models/pnp/IPolicyNegotiationAdminPointComponent.js\";\nexport * from \"./models/pnp/IPolicyNegotiationPointComponent.js\";\nexport * from \"./models/pnp/IPolicyNegotiator.js\";\nexport * from \"./models/pnp/IPolicyRequester.js\";\nexport * from \"./models/policyMetadataContext.js\";\nexport * from \"./models/pxp/IPolicyExecutionAction.js\";\nexport * from \"./models/pxp/IPolicyExecutionPointComponent.js\";\nexport * from \"./models/rightsManagementContexts.js\";\nexport * from \"./models/rightsManagementNamespaces.js\";\nexport * from \"./models/rightsManagementTypes.js\";\nexport * from \"./utils/odrlPolicyHelper.js\";\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IRightsManagementAgreement.js","sourceRoot":"","sources":["../../../src/models/IRightsManagementAgreement.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolAgreement } from \"@twin.org/standards-dataspace-protocol\";\nimport type { IRightsManagementPolicyMetadata } from \"./IRightsManagementPolicyMetadata.js\";\n\n/**\n * Agreement policy returned by PAP, including optional PAP-managed lifecycle metadata.\n */\nexport
|
|
1
|
+
{"version":3,"file":"IRightsManagementAgreement.js","sourceRoot":"","sources":["../../../src/models/IRightsManagementAgreement.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolAgreement } from \"@twin.org/standards-dataspace-protocol\";\nimport type { IRightsManagementPolicyMetadata } from \"./IRightsManagementPolicyMetadata.js\";\nimport type { IRightsManagementPolicyTrust } from \"./IRightsManagementPolicyTrust.js\";\n\n/**\n * Agreement policy returned by PAP, including optional PAP-managed lifecycle metadata.\n */\nexport interface IRightsManagementAgreement\n\textends\n\t\tIDataspaceProtocolAgreement,\n\t\tIRightsManagementPolicyMetadata,\n\t\tIRightsManagementPolicyTrust {}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IRightsManagementOffer.js","sourceRoot":"","sources":["../../../src/models/IRightsManagementOffer.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolOffer } from \"@twin.org/standards-dataspace-protocol\";\nimport type { IRightsManagementPolicyMetadata } from \"./IRightsManagementPolicyMetadata.js\";\n\n/**\n * Offer policy returned by PAP, including optional PAP-managed lifecycle metadata.\n */\nexport
|
|
1
|
+
{"version":3,"file":"IRightsManagementOffer.js","sourceRoot":"","sources":["../../../src/models/IRightsManagementOffer.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolOffer } from \"@twin.org/standards-dataspace-protocol\";\nimport type { IRightsManagementPolicyMetadata } from \"./IRightsManagementPolicyMetadata.js\";\nimport type { IRightsManagementPolicyTrust } from \"./IRightsManagementPolicyTrust.js\";\n\n/**\n * Offer policy returned by PAP, including optional PAP-managed lifecycle metadata.\n */\nexport interface IRightsManagementOffer\n\textends IDataspaceProtocolOffer, IRightsManagementPolicyMetadata, IRightsManagementPolicyTrust {}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IRightsManagementPolicy.js","sourceRoot":"","sources":["../../../src/models/IRightsManagementPolicy.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolPolicy } from \"@twin.org/standards-dataspace-protocol\";\nimport type {
|
|
1
|
+
{"version":3,"file":"IRightsManagementPolicy.js","sourceRoot":"","sources":["../../../src/models/IRightsManagementPolicy.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolPolicy } from \"@twin.org/standards-dataspace-protocol\";\nimport type { IRightsManagementPolicyMetadata } from \"./IRightsManagementPolicyMetadata.js\";\nimport type { IRightsManagementPolicyTrust } from \"./IRightsManagementPolicyTrust.js\";\n\n/**\n * Base type for any ODRL policy stored and managed by the TWIN rights-management PAP.\n */\nexport interface IRightsManagementPolicy\n\textends IDataspaceProtocolPolicy, IRightsManagementPolicyMetadata, IRightsManagementPolicyTrust {}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IRightsManagementPolicyTrust.js","sourceRoot":"","sources":["../../../src/models/IRightsManagementPolicyTrust.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * PAP-managed trust data attached to stored and returned ODRL policies.\n */\nexport interface IRightsManagementPolicyTrust {\n\t/**\n\t * Trust verification data captured at the beginning of the negotiation.\n\t */\n\ttrustData?: { [key: string]: IJsonLdNodeObject };\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IRightsManagementSet.js","sourceRoot":"","sources":["../../../src/models/IRightsManagementSet.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolSet } from \"@twin.org/standards-dataspace-protocol\";\nimport type { IRightsManagementPolicyMetadata } from \"./IRightsManagementPolicyMetadata.js\";\n\n/**\n * Set policy returned by PAP, including optional PAP-managed lifecycle metadata.\n */\nexport
|
|
1
|
+
{"version":3,"file":"IRightsManagementSet.js","sourceRoot":"","sources":["../../../src/models/IRightsManagementSet.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceProtocolSet } from \"@twin.org/standards-dataspace-protocol\";\nimport type { IRightsManagementPolicyMetadata } from \"./IRightsManagementPolicyMetadata.js\";\nimport type { IRightsManagementPolicyTrust } from \"./IRightsManagementPolicyTrust.js\";\n\n/**\n * Set policy returned by PAP, including optional PAP-managed lifecycle metadata.\n */\nexport interface IRightsManagementSet\n\textends IDataspaceProtocolSet, IRightsManagementPolicyMetadata, IRightsManagementPolicyTrust {}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPolicyDecisionPointComponent.js","sourceRoot":"","sources":["../../../../src/models/pdp/IPolicyDecisionPointComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IDataspaceProtocolAgreement } from \"@twin.org/standards-dataspace-protocol\";\nimport type { OdrlActionType } from \"@twin.org/standards-w3c-odrl\";\nimport type { IPolicyDecision } from \"./IPolicyDecision.js\";\n\n/**\n * Interface describing a Policy Decision Point (PDP) contract.\n * Decides if a party can be granted access to a resource, will retrieve policies\n * from the Policy Management Point (PMP) and any additional information from the\n * Policy Information Point (PIP). When a decision is made, the Policy Execution\n * Point (PEP) will execute any registered actions.\n */\nexport interface IPolicyDecisionPointComponent extends IComponent {\n\t/**\n\t * Evaluate requests from a Policy Enforcement Point (PEP).\n\t * Uses the Policy Management Point (PMP) to retrieve the policies and the\n\t * Policy Information Point (PIP) to retrieve additional information.\n\t * Executes any actions on the Policy Execution Point (PXP) before and after decision is made.\n\t * @param agreement The agreement to evaluate.\n\t * @param data The data to make a decision on.\n\t * @param action Optional action to make a decision on, if not provided, the PDP will evaluate all actions in the agreement.\n\t * @returns Returns the policy decisions which apply to the data so that the PEP\n\t * can manipulate the data accordingly.\n\t */\n\tevaluate<D = unknown>(\n\t\tagreement: IDataspaceProtocolAgreement,\n\t\tdata?: D,\n\t\taction?: OdrlActionType | string\n\t): Promise<IPolicyDecision[]>;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"IPolicyDecisionPointComponent.js","sourceRoot":"","sources":["../../../../src/models/pdp/IPolicyDecisionPointComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { IDataspaceProtocolAgreement } from \"@twin.org/standards-dataspace-protocol\";\nimport type { OdrlActionType } from \"@twin.org/standards-w3c-odrl\";\nimport type { IPolicyDecision } from \"./IPolicyDecision.js\";\n\n/**\n * Interface describing a Policy Decision Point (PDP) contract.\n * Decides if a party can be granted access to a resource, will retrieve policies\n * from the Policy Management Point (PMP) and any additional information from the\n * Policy Information Point (PIP). When a decision is made, the Policy Execution\n * Point (PEP) will execute any registered actions.\n */\nexport interface IPolicyDecisionPointComponent extends IComponent {\n\t/**\n\t * Evaluate requests from a Policy Enforcement Point (PEP).\n\t * Uses the Policy Management Point (PMP) to retrieve the policies and the\n\t * Policy Information Point (PIP) to retrieve additional information.\n\t * Executes any actions on the Policy Execution Point (PXP) before and after decision is made.\n\t * @param agreement The agreement to evaluate.\n\t * @param data The data to make a decision on.\n\t * @param action Optional action to make a decision on, if not provided, the PDP will evaluate all actions in the agreement.\n\t * @param trustData Trust verification data to merge with PIP-retrieved information before arbitration.\n\t * @returns Returns the policy decisions which apply to the data so that the PEP\n\t * can manipulate the data accordingly.\n\t */\n\tevaluate<D = unknown>(\n\t\tagreement: IDataspaceProtocolAgreement,\n\t\tdata?: D,\n\t\taction?: OdrlActionType | string,\n\t\ttrustData?: { [key: string]: IJsonLdNodeObject }\n\t): Promise<IPolicyDecision[]>;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPolicyEnforcementPointComponent.js","sourceRoot":"","sources":["../../../../src/models/pep/IPolicyEnforcementPointComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IDataspaceProtocolAgreement } from \"@twin.org/standards-dataspace-protocol\";\nimport type { OdrlActionType } from \"@twin.org/standards-w3c-odrl\";\n\n/**\n * Interface describing a Policy Enforcement Point (PEP) contract.\n * Intercepts data and uses the Policy Decision Point (PDP) to make decisions on\n * access to a resource, based on the decision a manipulated data object can\n * be returned.\n */\nexport interface IPolicyEnforcementPointComponent extends IComponent {\n\t/**\n\t * Process the data using Policy Decision Point (PDP) and return the manipulated data.\n\t * @param agreement The agreement to enforce.\n\t * @param data The data to process.\n\t * @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.\n\t * @returns The manipulated data with any policies applied.\n\t */\n\tinterceptWithPolicy<D = unknown, R = D>(\n\t\tagreement: IDataspaceProtocolAgreement,\n\t\tdata?: D,\n\t\taction?: OdrlActionType | string\n\t): Promise<R>;\n\n\t/**\n\t * Process the data using Policy Decision Point (PDP) and return the manipulated data.\n\t * @param uid The uid of the agreement to look up.\n\t * @param data The data to process.\n\t * @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.\n\t * @returns The manipulated data with any policies applied.\n\t */\n\tinterceptWithId<D = unknown, R = D>(\n\t\tuid: string,\n\t\tdata?: D,\n\t\taction?: OdrlActionType | string\n\t): Promise<R>;\n\n\t/**\n\t * Process the data using Policy Decision Point (PDP) and return the manipulated data.\n\t * @param locator The match criteria to look up agreements.\n\t * @param locator.assigner The assigner attribute to match.\n\t * @param locator.assignee The assignee attribute to match.\n\t * @param locator.target The target attribute to match.\n\t * @param locator.action The action attribute to match.\n\t * @param data The data to process.\n\t * @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.\n\t * @returns The manipulated data with any policies applied.\n\t */\n\tinterceptWithLocator<D = unknown, R = D>(\n\t\tlocator: {\n\t\t\tassigner?: string;\n\t\t\tassignee?: string;\n\t\t\ttarget?: string;\n\t\t\taction?: string;\n\t\t},\n\t\tdata?: D,\n\t\taction?: OdrlActionType | string\n\t): Promise<R>;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"IPolicyEnforcementPointComponent.js","sourceRoot":"","sources":["../../../../src/models/pep/IPolicyEnforcementPointComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { IDataspaceProtocolAgreement } from \"@twin.org/standards-dataspace-protocol\";\nimport type { OdrlActionType } from \"@twin.org/standards-w3c-odrl\";\n\n/**\n * Interface describing a Policy Enforcement Point (PEP) contract.\n * Intercepts data and uses the Policy Decision Point (PDP) to make decisions on\n * access to a resource, based on the decision a manipulated data object can\n * be returned.\n */\nexport interface IPolicyEnforcementPointComponent extends IComponent {\n\t/**\n\t * Process the data using Policy Decision Point (PDP) and return the manipulated data.\n\t * @param agreement The agreement to enforce.\n\t * @param data The data to process.\n\t * @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.\n\t * @param trustData Trust verification data to pass to the PDP alongside PIP-retrieved information.\n\t * @returns The manipulated data with any policies applied.\n\t */\n\tinterceptWithPolicy<D = unknown, R = D>(\n\t\tagreement: IDataspaceProtocolAgreement,\n\t\tdata?: D,\n\t\taction?: OdrlActionType | string,\n\t\ttrustData?: { [key: string]: IJsonLdNodeObject }\n\t): Promise<R>;\n\n\t/**\n\t * Process the data using Policy Decision Point (PDP) and return the manipulated data.\n\t * @param uid The uid of the agreement to look up.\n\t * @param data The data to process.\n\t * @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.\n\t * @returns The manipulated data with any policies applied.\n\t */\n\tinterceptWithId<D = unknown, R = D>(\n\t\tuid: string,\n\t\tdata?: D,\n\t\taction?: OdrlActionType | string\n\t): Promise<R>;\n\n\t/**\n\t * Process the data using Policy Decision Point (PDP) and return the manipulated data.\n\t * @param locator The match criteria to look up agreements.\n\t * @param locator.assigner The assigner attribute to match.\n\t * @param locator.assignee The assignee attribute to match.\n\t * @param locator.target The target attribute to match.\n\t * @param locator.action The action attribute to match.\n\t * @param data The data to process.\n\t * @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.\n\t * @returns The manipulated data with any policies applied.\n\t */\n\tinterceptWithLocator<D = unknown, R = D>(\n\t\tlocator: {\n\t\t\tassigner?: string;\n\t\t\tassignee?: string;\n\t\t\ttarget?: string;\n\t\t\taction?: string;\n\t\t},\n\t\tdata?: D,\n\t\taction?: OdrlActionType | string\n\t): Promise<R>;\n}\n"]}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -8,13 +8,6 @@ export * from "./factories/policyRequesterFactory.js";
|
|
|
8
8
|
export * from "./models/api/pap/IPapCreateRequest.js";
|
|
9
9
|
export * from "./models/api/pap/IPapGetAgreementRequest.js";
|
|
10
10
|
export * from "./models/api/pap/IPapGetAgreementResponse.js";
|
|
11
|
-
export * from "./models/IRightsManagementAgreement.js";
|
|
12
|
-
export * from "./models/IRightsManagementOffer.js";
|
|
13
|
-
export * from "./models/IRightsManagementPolicy.js";
|
|
14
|
-
export * from "./models/IRightsManagementPolicyMetadata.js";
|
|
15
|
-
export * from "./models/policyMetadataContext.js";
|
|
16
|
-
export * from "./models/IRightsManagementSet.js";
|
|
17
|
-
export * from "./models/odrlProfiles.js";
|
|
18
11
|
export * from "./models/api/pap/IPapGetOfferRequest.js";
|
|
19
12
|
export * from "./models/api/pap/IPapGetOfferResponse.js";
|
|
20
13
|
export * from "./models/api/pap/IPapGetRequest.js";
|
|
@@ -41,6 +34,13 @@ export * from "./models/api/pnp/IPnpNegotiateRequest.js";
|
|
|
41
34
|
export * from "./models/api/pnp/IPnpNegotiationGetRequest.js";
|
|
42
35
|
export * from "./models/api/pnp/IPnpOfferRequest.js";
|
|
43
36
|
export * from "./models/api/pnp/IPnpTerminateRequest.js";
|
|
37
|
+
export * from "./models/IRightsManagementAgreement.js";
|
|
38
|
+
export * from "./models/IRightsManagementOffer.js";
|
|
39
|
+
export * from "./models/IRightsManagementPolicy.js";
|
|
40
|
+
export * from "./models/IRightsManagementPolicyMetadata.js";
|
|
41
|
+
export * from "./models/IRightsManagementPolicyTrust.js";
|
|
42
|
+
export * from "./models/IRightsManagementSet.js";
|
|
43
|
+
export * from "./models/odrlProfiles.js";
|
|
44
44
|
export * from "./models/pap/IPolicyAdministrationPointComponent.js";
|
|
45
45
|
export * from "./models/pdp/IPolicyArbiter.js";
|
|
46
46
|
export * from "./models/pdp/IPolicyDecision.js";
|
|
@@ -59,6 +59,7 @@ export * from "./models/pnp/IPolicyNegotiationAdminPointComponent.js";
|
|
|
59
59
|
export * from "./models/pnp/IPolicyNegotiationPointComponent.js";
|
|
60
60
|
export * from "./models/pnp/IPolicyNegotiator.js";
|
|
61
61
|
export * from "./models/pnp/IPolicyRequester.js";
|
|
62
|
+
export * from "./models/policyMetadataContext.js";
|
|
62
63
|
export * from "./models/pxp/IPolicyExecutionAction.js";
|
|
63
64
|
export * from "./models/pxp/IPolicyExecutionPointComponent.js";
|
|
64
65
|
export * from "./models/rightsManagementContexts.js";
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import type { IDataspaceProtocolAgreement } from "@twin.org/standards-dataspace-protocol";
|
|
2
2
|
import type { IRightsManagementPolicyMetadata } from "./IRightsManagementPolicyMetadata.js";
|
|
3
|
+
import type { IRightsManagementPolicyTrust } from "./IRightsManagementPolicyTrust.js";
|
|
3
4
|
/**
|
|
4
5
|
* Agreement policy returned by PAP, including optional PAP-managed lifecycle metadata.
|
|
5
6
|
*/
|
|
6
|
-
export
|
|
7
|
+
export interface IRightsManagementAgreement extends IDataspaceProtocolAgreement, IRightsManagementPolicyMetadata, IRightsManagementPolicyTrust {
|
|
8
|
+
}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import type { IDataspaceProtocolOffer } from "@twin.org/standards-dataspace-protocol";
|
|
2
2
|
import type { IRightsManagementPolicyMetadata } from "./IRightsManagementPolicyMetadata.js";
|
|
3
|
+
import type { IRightsManagementPolicyTrust } from "./IRightsManagementPolicyTrust.js";
|
|
3
4
|
/**
|
|
4
5
|
* Offer policy returned by PAP, including optional PAP-managed lifecycle metadata.
|
|
5
6
|
*/
|
|
6
|
-
export
|
|
7
|
+
export interface IRightsManagementOffer extends IDataspaceProtocolOffer, IRightsManagementPolicyMetadata, IRightsManagementPolicyTrust {
|
|
8
|
+
}
|
|
@@ -1,9 +1,8 @@
|
|
|
1
1
|
import type { IDataspaceProtocolPolicy } from "@twin.org/standards-dataspace-protocol";
|
|
2
|
-
import type { OdrlPolicyType } from "@twin.org/standards-w3c-odrl";
|
|
3
2
|
import type { IRightsManagementPolicyMetadata } from "./IRightsManagementPolicyMetadata.js";
|
|
3
|
+
import type { IRightsManagementPolicyTrust } from "./IRightsManagementPolicyTrust.js";
|
|
4
4
|
/**
|
|
5
5
|
* Base type for any ODRL policy stored and managed by the TWIN rights-management PAP.
|
|
6
6
|
*/
|
|
7
|
-
export
|
|
8
|
-
|
|
9
|
-
};
|
|
7
|
+
export interface IRightsManagementPolicy extends IDataspaceProtocolPolicy, IRightsManagementPolicyMetadata, IRightsManagementPolicyTrust {
|
|
8
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
|
|
2
|
+
/**
|
|
3
|
+
* PAP-managed trust data attached to stored and returned ODRL policies.
|
|
4
|
+
*/
|
|
5
|
+
export interface IRightsManagementPolicyTrust {
|
|
6
|
+
/**
|
|
7
|
+
* Trust verification data captured at the beginning of the negotiation.
|
|
8
|
+
*/
|
|
9
|
+
trustData?: {
|
|
10
|
+
[key: string]: IJsonLdNodeObject;
|
|
11
|
+
};
|
|
12
|
+
}
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import type { IDataspaceProtocolSet } from "@twin.org/standards-dataspace-protocol";
|
|
2
2
|
import type { IRightsManagementPolicyMetadata } from "./IRightsManagementPolicyMetadata.js";
|
|
3
|
+
import type { IRightsManagementPolicyTrust } from "./IRightsManagementPolicyTrust.js";
|
|
3
4
|
/**
|
|
4
5
|
* Set policy returned by PAP, including optional PAP-managed lifecycle metadata.
|
|
5
6
|
*/
|
|
6
|
-
export
|
|
7
|
+
export interface IRightsManagementSet extends IDataspaceProtocolSet, IRightsManagementPolicyMetadata, IRightsManagementPolicyTrust {
|
|
8
|
+
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { IComponent } from "@twin.org/core";
|
|
2
|
+
import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
|
|
2
3
|
import type { IDataspaceProtocolAgreement } from "@twin.org/standards-dataspace-protocol";
|
|
3
4
|
import type { OdrlActionType } from "@twin.org/standards-w3c-odrl";
|
|
4
5
|
import type { IPolicyDecision } from "./IPolicyDecision.js";
|
|
@@ -18,8 +19,11 @@ export interface IPolicyDecisionPointComponent extends IComponent {
|
|
|
18
19
|
* @param agreement The agreement to evaluate.
|
|
19
20
|
* @param data The data to make a decision on.
|
|
20
21
|
* @param action Optional action to make a decision on, if not provided, the PDP will evaluate all actions in the agreement.
|
|
22
|
+
* @param trustData Trust verification data to merge with PIP-retrieved information before arbitration.
|
|
21
23
|
* @returns Returns the policy decisions which apply to the data so that the PEP
|
|
22
24
|
* can manipulate the data accordingly.
|
|
23
25
|
*/
|
|
24
|
-
evaluate<D = unknown>(agreement: IDataspaceProtocolAgreement, data?: D, action?: OdrlActionType | string
|
|
26
|
+
evaluate<D = unknown>(agreement: IDataspaceProtocolAgreement, data?: D, action?: OdrlActionType | string, trustData?: {
|
|
27
|
+
[key: string]: IJsonLdNodeObject;
|
|
28
|
+
}): Promise<IPolicyDecision[]>;
|
|
25
29
|
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { IComponent } from "@twin.org/core";
|
|
2
|
+
import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
|
|
2
3
|
import type { IDataspaceProtocolAgreement } from "@twin.org/standards-dataspace-protocol";
|
|
3
4
|
import type { OdrlActionType } from "@twin.org/standards-w3c-odrl";
|
|
4
5
|
/**
|
|
@@ -13,9 +14,12 @@ export interface IPolicyEnforcementPointComponent extends IComponent {
|
|
|
13
14
|
* @param agreement The agreement to enforce.
|
|
14
15
|
* @param data The data to process.
|
|
15
16
|
* @param action Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
|
|
17
|
+
* @param trustData Trust verification data to pass to the PDP alongside PIP-retrieved information.
|
|
16
18
|
* @returns The manipulated data with any policies applied.
|
|
17
19
|
*/
|
|
18
|
-
interceptWithPolicy<D = unknown, R = D>(agreement: IDataspaceProtocolAgreement, data?: D, action?: OdrlActionType | string
|
|
20
|
+
interceptWithPolicy<D = unknown, R = D>(agreement: IDataspaceProtocolAgreement, data?: D, action?: OdrlActionType | string, trustData?: {
|
|
21
|
+
[key: string]: IJsonLdNodeObject;
|
|
22
|
+
}): Promise<R>;
|
|
19
23
|
/**
|
|
20
24
|
* Process the data using Policy Decision Point (PDP) and return the manipulated data.
|
|
21
25
|
* @param uid The uid of the agreement to look up.
|
package/docs/changelog.md
CHANGED
|
@@ -6,6 +6,20 @@
|
|
|
6
6
|
|
|
7
7
|
* remove EcosystemPolicy models/DTOs and standardize policy typing on `OdrlPolicyType` for v2.
|
|
8
8
|
|
|
9
|
+
## [0.0.3-next.52](https://github.com/iotaledger/twin-rights-management/compare/rights-management-models-v0.0.3-next.51...rights-management-models-v0.0.3-next.52) (2026-06-17)
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
### Features
|
|
13
|
+
|
|
14
|
+
* persist trust data ([#198](https://github.com/iotaledger/twin-rights-management/issues/198)) ([af94704](https://github.com/iotaledger/twin-rights-management/commit/af94704e366122f57ff6d664d3c51a371edfb043))
|
|
15
|
+
|
|
16
|
+
## [0.0.3-next.51](https://github.com/iotaledger/twin-rights-management/compare/rights-management-models-v0.0.3-next.50...rights-management-models-v0.0.3-next.51) (2026-06-16)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Miscellaneous Chores
|
|
20
|
+
|
|
21
|
+
* **rights-management-models:** Synchronize repo versions
|
|
22
|
+
|
|
9
23
|
## [0.0.3-next.50](https://github.com/iotaledger/twin-rights-management/compare/rights-management-models-v0.0.3-next.49...rights-management-models-v0.0.3-next.50) (2026-06-15)
|
|
10
24
|
|
|
11
25
|
|
|
@@ -151,7 +151,7 @@ Get the dataset targets from policy.
|
|
|
151
151
|
|
|
152
152
|
##### policy
|
|
153
153
|
|
|
154
|
-
[`IRightsManagementPolicy`](../
|
|
154
|
+
[`IRightsManagementPolicy`](../interfaces/IRightsManagementPolicy.md)
|
|
155
155
|
|
|
156
156
|
The policy to extract the dataset targets from.
|
|
157
157
|
|
|
@@ -176,7 +176,7 @@ their target exclusively on a rule are correctly indexed for query().
|
|
|
176
176
|
|
|
177
177
|
##### policy
|
|
178
178
|
|
|
179
|
-
[`IRightsManagementPolicy`](../
|
|
179
|
+
[`IRightsManagementPolicy`](../interfaces/IRightsManagementPolicy.md)
|
|
180
180
|
|
|
181
181
|
The policy to extract the targets from.
|
|
182
182
|
|
|
@@ -201,7 +201,7 @@ their action exclusively on a rule are correctly indexed for query().
|
|
|
201
201
|
|
|
202
202
|
##### policy
|
|
203
203
|
|
|
204
|
-
[`IRightsManagementPolicy`](../
|
|
204
|
+
[`IRightsManagementPolicy`](../interfaces/IRightsManagementPolicy.md)
|
|
205
205
|
|
|
206
206
|
The policy to extract the actions from.
|
|
207
207
|
|
|
@@ -223,7 +223,7 @@ Does the policy match.
|
|
|
223
223
|
|
|
224
224
|
##### policy
|
|
225
225
|
|
|
226
|
-
[`IRightsManagementPolicy`](../
|
|
226
|
+
[`IRightsManagementPolicy`](../interfaces/IRightsManagementPolicy.md) \| `undefined`
|
|
227
227
|
|
|
228
228
|
The policy to try and match.
|
|
229
229
|
|
package/docs/reference/index.md
CHANGED
|
@@ -6,7 +6,12 @@
|
|
|
6
6
|
|
|
7
7
|
## Interfaces
|
|
8
8
|
|
|
9
|
+
- [IRightsManagementAgreement](interfaces/IRightsManagementAgreement.md)
|
|
10
|
+
- [IRightsManagementOffer](interfaces/IRightsManagementOffer.md)
|
|
11
|
+
- [IRightsManagementPolicy](interfaces/IRightsManagementPolicy.md)
|
|
9
12
|
- [IRightsManagementPolicyMetadata](interfaces/IRightsManagementPolicyMetadata.md)
|
|
13
|
+
- [IRightsManagementPolicyTrust](interfaces/IRightsManagementPolicyTrust.md)
|
|
14
|
+
- [IRightsManagementSet](interfaces/IRightsManagementSet.md)
|
|
10
15
|
- [IPapCreateRequest](interfaces/IPapCreateRequest.md)
|
|
11
16
|
- [IPapGetAgreementRequest](interfaces/IPapGetAgreementRequest.md)
|
|
12
17
|
- [IPapGetAgreementResponse](interfaces/IPapGetAgreementResponse.md)
|
|
@@ -56,10 +61,6 @@
|
|
|
56
61
|
|
|
57
62
|
## Type Aliases
|
|
58
63
|
|
|
59
|
-
- [IRightsManagementAgreement](type-aliases/IRightsManagementAgreement.md)
|
|
60
|
-
- [IRightsManagementOffer](type-aliases/IRightsManagementOffer.md)
|
|
61
|
-
- [IRightsManagementPolicy](type-aliases/IRightsManagementPolicy.md)
|
|
62
|
-
- [IRightsManagementSet](type-aliases/IRightsManagementSet.md)
|
|
63
64
|
- [OdrlProfiles](type-aliases/OdrlProfiles.md)
|
|
64
65
|
- [PolicyDecision](type-aliases/PolicyDecision.md)
|
|
65
66
|
- [PolicyDecisionStage](type-aliases/PolicyDecisionStage.md)
|
|
@@ -6,6 +6,6 @@ The request structure for creating a policy.
|
|
|
6
6
|
|
|
7
7
|
### body {#body}
|
|
8
8
|
|
|
9
|
-
> **body**: `JsonLdObjectWithOptionalAtId`\<[`IRightsManagementPolicy`](
|
|
9
|
+
> **body**: `JsonLdObjectWithOptionalAtId`\<[`IRightsManagementPolicy`](IRightsManagementPolicy.md)\>
|
|
10
10
|
|
|
11
11
|
The body of the request - the policy to create (id will be auto-generated if not provided).
|
|
@@ -6,6 +6,6 @@ The response structure for getting an agreement.
|
|
|
6
6
|
|
|
7
7
|
### body {#body}
|
|
8
8
|
|
|
9
|
-
> **body**: [`IRightsManagementAgreement`](
|
|
9
|
+
> **body**: [`IRightsManagementAgreement`](IRightsManagementAgreement.md)
|
|
10
10
|
|
|
11
11
|
The body of the response.
|
|
@@ -18,6 +18,6 @@ The headers which can be used to determine the response data type.
|
|
|
18
18
|
|
|
19
19
|
### body {#body}
|
|
20
20
|
|
|
21
|
-
> **body**: [`IRightsManagementPolicy`](
|
|
21
|
+
> **body**: [`IRightsManagementPolicy`](IRightsManagementPolicy.md)[]
|
|
22
22
|
|
|
23
23
|
The body of the response.
|
|
@@ -18,7 +18,7 @@ Create a new policy with auto-generated UID.
|
|
|
18
18
|
|
|
19
19
|
##### policy
|
|
20
20
|
|
|
21
|
-
`JsonLdObjectWithOptionalAtId`\<[`IRightsManagementPolicy`](
|
|
21
|
+
`JsonLdObjectWithOptionalAtId`\<[`IRightsManagementPolicy`](IRightsManagementPolicy.md)\>
|
|
22
22
|
|
|
23
23
|
The policy to create (uid will be auto-generated).
|
|
24
24
|
|
|
@@ -40,7 +40,7 @@ Update an existing policy.
|
|
|
40
40
|
|
|
41
41
|
##### policy
|
|
42
42
|
|
|
43
|
-
[`IRightsManagementPolicy`](
|
|
43
|
+
[`IRightsManagementPolicy`](IRightsManagementPolicy.md)
|
|
44
44
|
|
|
45
45
|
The policy to update (must include uid).
|
|
46
46
|
|
|
@@ -54,7 +54,7 @@ A promise that resolves when the policy has been updated.
|
|
|
54
54
|
|
|
55
55
|
### get() {#get}
|
|
56
56
|
|
|
57
|
-
> **get**(`policyId`): `Promise`\<[`IRightsManagementPolicy`](
|
|
57
|
+
> **get**(`policyId`): `Promise`\<[`IRightsManagementPolicy`](IRightsManagementPolicy.md)\>
|
|
58
58
|
|
|
59
59
|
Get a policy.
|
|
60
60
|
|
|
@@ -68,7 +68,7 @@ The id of the policy to get.
|
|
|
68
68
|
|
|
69
69
|
#### Returns
|
|
70
70
|
|
|
71
|
-
`Promise`\<[`IRightsManagementPolicy`](
|
|
71
|
+
`Promise`\<[`IRightsManagementPolicy`](IRightsManagementPolicy.md)\>
|
|
72
72
|
|
|
73
73
|
The policy.
|
|
74
74
|
|
|
@@ -76,7 +76,7 @@ The policy.
|
|
|
76
76
|
|
|
77
77
|
### getAgreement() {#getagreement}
|
|
78
78
|
|
|
79
|
-
> **getAgreement**(`agreementId`): `Promise`\<[`IRightsManagementAgreement`](
|
|
79
|
+
> **getAgreement**(`agreementId`): `Promise`\<[`IRightsManagementAgreement`](IRightsManagementAgreement.md)\>
|
|
80
80
|
|
|
81
81
|
Get an agreement.
|
|
82
82
|
|
|
@@ -90,7 +90,7 @@ The id of the agreement to get.
|
|
|
90
90
|
|
|
91
91
|
#### Returns
|
|
92
92
|
|
|
93
|
-
`Promise`\<[`IRightsManagementAgreement`](
|
|
93
|
+
`Promise`\<[`IRightsManagementAgreement`](IRightsManagementAgreement.md)\>
|
|
94
94
|
|
|
95
95
|
The agreement.
|
|
96
96
|
|
|
@@ -98,7 +98,7 @@ The agreement.
|
|
|
98
98
|
|
|
99
99
|
### getSet() {#getset}
|
|
100
100
|
|
|
101
|
-
> **getSet**(`setId`): `Promise`\<[`IRightsManagementSet`](
|
|
101
|
+
> **getSet**(`setId`): `Promise`\<[`IRightsManagementSet`](IRightsManagementSet.md)\>
|
|
102
102
|
|
|
103
103
|
Get a set.
|
|
104
104
|
|
|
@@ -112,7 +112,7 @@ The id of the set to get.
|
|
|
112
112
|
|
|
113
113
|
#### Returns
|
|
114
114
|
|
|
115
|
-
`Promise`\<[`IRightsManagementSet`](
|
|
115
|
+
`Promise`\<[`IRightsManagementSet`](IRightsManagementSet.md)\>
|
|
116
116
|
|
|
117
117
|
The set.
|
|
118
118
|
|
|
@@ -120,7 +120,7 @@ The set.
|
|
|
120
120
|
|
|
121
121
|
### getOffer() {#getoffer}
|
|
122
122
|
|
|
123
|
-
> **getOffer**(`offerId`): `Promise`\<[`IRightsManagementOffer`](
|
|
123
|
+
> **getOffer**(`offerId`): `Promise`\<[`IRightsManagementOffer`](IRightsManagementOffer.md)\>
|
|
124
124
|
|
|
125
125
|
Get an offer.
|
|
126
126
|
|
|
@@ -134,7 +134,7 @@ The id of the offer to get.
|
|
|
134
134
|
|
|
135
135
|
#### Returns
|
|
136
136
|
|
|
137
|
-
`Promise`\<[`IRightsManagementOffer`](
|
|
137
|
+
`Promise`\<[`IRightsManagementOffer`](IRightsManagementOffer.md)\>
|
|
138
138
|
|
|
139
139
|
The offer.
|
|
140
140
|
|
|
@@ -164,7 +164,7 @@ A promise that resolves when the policy has been removed.
|
|
|
164
164
|
|
|
165
165
|
### query() {#query}
|
|
166
166
|
|
|
167
|
-
> **query**(`options?`, `conditions?`, `cursor?`, `limit?`): `Promise`\<\{ `cursor?`: `string`; `policies`: [`IRightsManagementPolicy`](
|
|
167
|
+
> **query**(`options?`, `conditions?`, `cursor?`, `limit?`): `Promise`\<\{ `cursor?`: `string`; `policies`: [`IRightsManagementPolicy`](IRightsManagementPolicy.md)[]; \}\>
|
|
168
168
|
|
|
169
169
|
Query the policies using the specified conditions.
|
|
170
170
|
|
|
@@ -200,7 +200,7 @@ The action to filter by.
|
|
|
200
200
|
|
|
201
201
|
##### conditions?
|
|
202
202
|
|
|
203
|
-
`EntityCondition`\<[`IRightsManagementPolicy`](
|
|
203
|
+
`EntityCondition`\<[`IRightsManagementPolicy`](IRightsManagementPolicy.md)\>
|
|
204
204
|
|
|
205
205
|
The conditions to use for the query.
|
|
206
206
|
|
|
@@ -218,6 +218,6 @@ The number of results to return per page.
|
|
|
218
218
|
|
|
219
219
|
#### Returns
|
|
220
220
|
|
|
221
|
-
`Promise`\<\{ `cursor?`: `string`; `policies`: [`IRightsManagementPolicy`](
|
|
221
|
+
`Promise`\<\{ `cursor?`: `string`; `policies`: [`IRightsManagementPolicy`](IRightsManagementPolicy.md)[]; \}\>
|
|
222
222
|
|
|
223
223
|
Cursor for next page of results and the policies matching the query.
|
|
@@ -14,7 +14,7 @@ Point (PEP) will execute any registered actions.
|
|
|
14
14
|
|
|
15
15
|
### evaluate() {#evaluate}
|
|
16
16
|
|
|
17
|
-
> **evaluate**\<`D`\>(`agreement`, `data?`, `action?`): `Promise`\<[`IPolicyDecision`](IPolicyDecision.md)[]\>
|
|
17
|
+
> **evaluate**\<`D`\>(`agreement`, `data?`, `action?`, `trustData?`): `Promise`\<[`IPolicyDecision`](IPolicyDecision.md)[]\>
|
|
18
18
|
|
|
19
19
|
Evaluate requests from a Policy Enforcement Point (PEP).
|
|
20
20
|
Uses the Policy Management Point (PMP) to retrieve the policies and the
|
|
@@ -47,6 +47,10 @@ The data to make a decision on.
|
|
|
47
47
|
|
|
48
48
|
Optional action to make a decision on, if not provided, the PDP will evaluate all actions in the agreement.
|
|
49
49
|
|
|
50
|
+
##### trustData?
|
|
51
|
+
|
|
52
|
+
Trust verification data to merge with PIP-retrieved information before arbitration.
|
|
53
|
+
|
|
50
54
|
#### Returns
|
|
51
55
|
|
|
52
56
|
`Promise`\<[`IPolicyDecision`](IPolicyDecision.md)[]\>
|
|
@@ -13,7 +13,7 @@ be returned.
|
|
|
13
13
|
|
|
14
14
|
### interceptWithPolicy() {#interceptwithpolicy}
|
|
15
15
|
|
|
16
|
-
> **interceptWithPolicy**\<`D`, `R`\>(`agreement`, `data?`, `action?`): `Promise`\<`R`\>
|
|
16
|
+
> **interceptWithPolicy**\<`D`, `R`\>(`agreement`, `data?`, `action?`, `trustData?`): `Promise`\<`R`\>
|
|
17
17
|
|
|
18
18
|
Process the data using Policy Decision Point (PDP) and return the manipulated data.
|
|
19
19
|
|
|
@@ -47,6 +47,10 @@ The data to process.
|
|
|
47
47
|
|
|
48
48
|
Optional action to make a decision on, if not provided, the arbiter will evaluate all actions in the agreement.
|
|
49
49
|
|
|
50
|
+
##### trustData?
|
|
51
|
+
|
|
52
|
+
Trust verification data to pass to the PDP alongside PIP-retrieved information.
|
|
53
|
+
|
|
50
54
|
#### Returns
|
|
51
55
|
|
|
52
56
|
`Promise`\<`R`\>
|
|
@@ -26,7 +26,7 @@ Retrieve additional information which is relevant in the PDP decision making.
|
|
|
26
26
|
|
|
27
27
|
##### policy
|
|
28
28
|
|
|
29
|
-
[`IRightsManagementPolicy`](
|
|
29
|
+
[`IRightsManagementPolicy`](IRightsManagementPolicy.md) \| `undefined`
|
|
30
30
|
|
|
31
31
|
The policy to retrieve the information for if available.
|
|
32
32
|
|
|
@@ -24,7 +24,7 @@ Retrieve information from the sources.
|
|
|
24
24
|
|
|
25
25
|
##### policy
|
|
26
26
|
|
|
27
|
-
[`IRightsManagementPolicy`](
|
|
27
|
+
[`IRightsManagementPolicy`](IRightsManagementPolicy.md) \| `undefined`
|
|
28
28
|
|
|
29
29
|
The policy to retrieve information for if available.
|
|
30
30
|
|
|
@@ -11,7 +11,7 @@ Provide the policies to the Policy Decision Point (PDP) based on the data and id
|
|
|
11
11
|
|
|
12
12
|
### retrieve() {#retrieve}
|
|
13
13
|
|
|
14
|
-
> **retrieve**(`options?`, `cursor?`): `Promise`\<\{ `policies`: [`IRightsManagementPolicy`](
|
|
14
|
+
> **retrieve**(`options?`, `cursor?`): `Promise`\<\{ `policies`: [`IRightsManagementPolicy`](IRightsManagementPolicy.md)[]; `cursor?`: `string`; \}\>
|
|
15
15
|
|
|
16
16
|
Get the policies from a PAP based on the data and identities.
|
|
17
17
|
|
|
@@ -53,6 +53,6 @@ An optional cursor to continue a previous query.
|
|
|
53
53
|
|
|
54
54
|
#### Returns
|
|
55
55
|
|
|
56
|
-
`Promise`\<\{ `policies`: [`IRightsManagementPolicy`](
|
|
56
|
+
`Promise`\<\{ `policies`: [`IRightsManagementPolicy`](IRightsManagementPolicy.md)[]; `cursor?`: `string`; \}\>
|
|
57
57
|
|
|
58
58
|
Returns the policies which apply to the data and identities so that the PDP can make a decision.
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# Interface: IRightsManagementAgreement
|
|
2
|
+
|
|
3
|
+
Agreement policy returned by PAP, including optional PAP-managed lifecycle metadata.
|
|
4
|
+
|
|
5
|
+
## Extends
|
|
6
|
+
|
|
7
|
+
- `IDataspaceProtocolAgreement`.[`IRightsManagementPolicyMetadata`](IRightsManagementPolicyMetadata.md).[`IRightsManagementPolicyTrust`](IRightsManagementPolicyTrust.md)
|
|
8
|
+
|
|
9
|
+
## Properties
|
|
10
|
+
|
|
11
|
+
### dateCreated? {#datecreated}
|
|
12
|
+
|
|
13
|
+
> `optional` **dateCreated?**: `string`
|
|
14
|
+
|
|
15
|
+
schema.org dateCreated — ISO 8601 date-time set by PAP on create.
|
|
16
|
+
|
|
17
|
+
#### Inherited from
|
|
18
|
+
|
|
19
|
+
[`IRightsManagementPolicyMetadata`](IRightsManagementPolicyMetadata.md).[`dateCreated`](IRightsManagementPolicyMetadata.md#datecreated)
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
23
|
+
### dateModified? {#datemodified}
|
|
24
|
+
|
|
25
|
+
> `optional` **dateModified?**: `string`
|
|
26
|
+
|
|
27
|
+
schema.org dateModified — ISO 8601 date-time set by PAP on create and update.
|
|
28
|
+
|
|
29
|
+
#### Inherited from
|
|
30
|
+
|
|
31
|
+
[`IRightsManagementPolicyMetadata`](IRightsManagementPolicyMetadata.md).[`dateModified`](IRightsManagementPolicyMetadata.md#datemodified)
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### trustData? {#trustdata}
|
|
36
|
+
|
|
37
|
+
> `optional` **trustData?**: `object`
|
|
38
|
+
|
|
39
|
+
Trust verification data captured at the beginning of the negotiation.
|
|
40
|
+
|
|
41
|
+
#### Index Signature
|
|
42
|
+
|
|
43
|
+
\[`key`: `string`\]: `IJsonLdNodeObject`
|
|
44
|
+
|
|
45
|
+
#### Inherited from
|
|
46
|
+
|
|
47
|
+
[`IRightsManagementPolicyTrust`](IRightsManagementPolicyTrust.md).[`trustData`](IRightsManagementPolicyTrust.md#trustdata)
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# Interface: IRightsManagementOffer
|
|
2
|
+
|
|
3
|
+
Offer policy returned by PAP, including optional PAP-managed lifecycle metadata.
|
|
4
|
+
|
|
5
|
+
## Extends
|
|
6
|
+
|
|
7
|
+
- `IDataspaceProtocolOffer`.[`IRightsManagementPolicyMetadata`](IRightsManagementPolicyMetadata.md).[`IRightsManagementPolicyTrust`](IRightsManagementPolicyTrust.md)
|
|
8
|
+
|
|
9
|
+
## Properties
|
|
10
|
+
|
|
11
|
+
### dateCreated? {#datecreated}
|
|
12
|
+
|
|
13
|
+
> `optional` **dateCreated?**: `string`
|
|
14
|
+
|
|
15
|
+
schema.org dateCreated — ISO 8601 date-time set by PAP on create.
|
|
16
|
+
|
|
17
|
+
#### Inherited from
|
|
18
|
+
|
|
19
|
+
[`IRightsManagementPolicyMetadata`](IRightsManagementPolicyMetadata.md).[`dateCreated`](IRightsManagementPolicyMetadata.md#datecreated)
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
23
|
+
### dateModified? {#datemodified}
|
|
24
|
+
|
|
25
|
+
> `optional` **dateModified?**: `string`
|
|
26
|
+
|
|
27
|
+
schema.org dateModified — ISO 8601 date-time set by PAP on create and update.
|
|
28
|
+
|
|
29
|
+
#### Inherited from
|
|
30
|
+
|
|
31
|
+
[`IRightsManagementPolicyMetadata`](IRightsManagementPolicyMetadata.md).[`dateModified`](IRightsManagementPolicyMetadata.md#datemodified)
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### trustData? {#trustdata}
|
|
36
|
+
|
|
37
|
+
> `optional` **trustData?**: `object`
|
|
38
|
+
|
|
39
|
+
Trust verification data captured at the beginning of the negotiation.
|
|
40
|
+
|
|
41
|
+
#### Index Signature
|
|
42
|
+
|
|
43
|
+
\[`key`: `string`\]: `IJsonLdNodeObject`
|
|
44
|
+
|
|
45
|
+
#### Inherited from
|
|
46
|
+
|
|
47
|
+
[`IRightsManagementPolicyTrust`](IRightsManagementPolicyTrust.md).[`trustData`](IRightsManagementPolicyTrust.md#trustdata)
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# Interface: IRightsManagementPolicy
|
|
2
|
+
|
|
3
|
+
Base type for any ODRL policy stored and managed by the TWIN rights-management PAP.
|
|
4
|
+
|
|
5
|
+
## Extends
|
|
6
|
+
|
|
7
|
+
- `IDataspaceProtocolPolicy`.[`IRightsManagementPolicyMetadata`](IRightsManagementPolicyMetadata.md).[`IRightsManagementPolicyTrust`](IRightsManagementPolicyTrust.md)
|
|
8
|
+
|
|
9
|
+
## Properties
|
|
10
|
+
|
|
11
|
+
### dateCreated? {#datecreated}
|
|
12
|
+
|
|
13
|
+
> `optional` **dateCreated?**: `string`
|
|
14
|
+
|
|
15
|
+
schema.org dateCreated — ISO 8601 date-time set by PAP on create.
|
|
16
|
+
|
|
17
|
+
#### Inherited from
|
|
18
|
+
|
|
19
|
+
[`IRightsManagementPolicyMetadata`](IRightsManagementPolicyMetadata.md).[`dateCreated`](IRightsManagementPolicyMetadata.md#datecreated)
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
23
|
+
### dateModified? {#datemodified}
|
|
24
|
+
|
|
25
|
+
> `optional` **dateModified?**: `string`
|
|
26
|
+
|
|
27
|
+
schema.org dateModified — ISO 8601 date-time set by PAP on create and update.
|
|
28
|
+
|
|
29
|
+
#### Inherited from
|
|
30
|
+
|
|
31
|
+
[`IRightsManagementPolicyMetadata`](IRightsManagementPolicyMetadata.md).[`dateModified`](IRightsManagementPolicyMetadata.md#datemodified)
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### trustData? {#trustdata}
|
|
36
|
+
|
|
37
|
+
> `optional` **trustData?**: `object`
|
|
38
|
+
|
|
39
|
+
Trust verification data captured at the beginning of the negotiation.
|
|
40
|
+
|
|
41
|
+
#### Index Signature
|
|
42
|
+
|
|
43
|
+
\[`key`: `string`\]: `IJsonLdNodeObject`
|
|
44
|
+
|
|
45
|
+
#### Inherited from
|
|
46
|
+
|
|
47
|
+
[`IRightsManagementPolicyTrust`](IRightsManagementPolicyTrust.md).[`trustData`](IRightsManagementPolicyTrust.md#trustdata)
|
|
@@ -2,6 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
PAP-managed metadata attached to stored and returned ODRL policies.
|
|
4
4
|
|
|
5
|
+
## Extended by
|
|
6
|
+
|
|
7
|
+
- [`IRightsManagementAgreement`](IRightsManagementAgreement.md)
|
|
8
|
+
- [`IRightsManagementOffer`](IRightsManagementOffer.md)
|
|
9
|
+
- [`IRightsManagementPolicy`](IRightsManagementPolicy.md)
|
|
10
|
+
- [`IRightsManagementSet`](IRightsManagementSet.md)
|
|
11
|
+
|
|
5
12
|
## Properties
|
|
6
13
|
|
|
7
14
|
### dateCreated? {#datecreated}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Interface: IRightsManagementPolicyTrust
|
|
2
|
+
|
|
3
|
+
PAP-managed trust data attached to stored and returned ODRL policies.
|
|
4
|
+
|
|
5
|
+
## Extended by
|
|
6
|
+
|
|
7
|
+
- [`IRightsManagementAgreement`](IRightsManagementAgreement.md)
|
|
8
|
+
- [`IRightsManagementOffer`](IRightsManagementOffer.md)
|
|
9
|
+
- [`IRightsManagementPolicy`](IRightsManagementPolicy.md)
|
|
10
|
+
- [`IRightsManagementSet`](IRightsManagementSet.md)
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### trustData? {#trustdata}
|
|
15
|
+
|
|
16
|
+
> `optional` **trustData?**: `object`
|
|
17
|
+
|
|
18
|
+
Trust verification data captured at the beginning of the negotiation.
|
|
19
|
+
|
|
20
|
+
#### Index Signature
|
|
21
|
+
|
|
22
|
+
\[`key`: `string`\]: `IJsonLdNodeObject`
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# Interface: IRightsManagementSet
|
|
2
|
+
|
|
3
|
+
Set policy returned by PAP, including optional PAP-managed lifecycle metadata.
|
|
4
|
+
|
|
5
|
+
## Extends
|
|
6
|
+
|
|
7
|
+
- `IDataspaceProtocolSet`.[`IRightsManagementPolicyMetadata`](IRightsManagementPolicyMetadata.md).[`IRightsManagementPolicyTrust`](IRightsManagementPolicyTrust.md)
|
|
8
|
+
|
|
9
|
+
## Properties
|
|
10
|
+
|
|
11
|
+
### dateCreated? {#datecreated}
|
|
12
|
+
|
|
13
|
+
> `optional` **dateCreated?**: `string`
|
|
14
|
+
|
|
15
|
+
schema.org dateCreated — ISO 8601 date-time set by PAP on create.
|
|
16
|
+
|
|
17
|
+
#### Inherited from
|
|
18
|
+
|
|
19
|
+
[`IRightsManagementPolicyMetadata`](IRightsManagementPolicyMetadata.md).[`dateCreated`](IRightsManagementPolicyMetadata.md#datecreated)
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
23
|
+
### dateModified? {#datemodified}
|
|
24
|
+
|
|
25
|
+
> `optional` **dateModified?**: `string`
|
|
26
|
+
|
|
27
|
+
schema.org dateModified — ISO 8601 date-time set by PAP on create and update.
|
|
28
|
+
|
|
29
|
+
#### Inherited from
|
|
30
|
+
|
|
31
|
+
[`IRightsManagementPolicyMetadata`](IRightsManagementPolicyMetadata.md).[`dateModified`](IRightsManagementPolicyMetadata.md#datemodified)
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### trustData? {#trustdata}
|
|
36
|
+
|
|
37
|
+
> `optional` **trustData?**: `object`
|
|
38
|
+
|
|
39
|
+
Trust verification data captured at the beginning of the negotiation.
|
|
40
|
+
|
|
41
|
+
#### Index Signature
|
|
42
|
+
|
|
43
|
+
\[`key`: `string`\]: `IJsonLdNodeObject`
|
|
44
|
+
|
|
45
|
+
#### Inherited from
|
|
46
|
+
|
|
47
|
+
[`IRightsManagementPolicyTrust`](IRightsManagementPolicyTrust.md).[`trustData`](IRightsManagementPolicyTrust.md#trustdata)
|
package/package.json
CHANGED
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
# Type Alias: IRightsManagementAgreement
|
|
2
|
-
|
|
3
|
-
> **IRightsManagementAgreement** = `IDataspaceProtocolAgreement` & [`IRightsManagementPolicyMetadata`](../interfaces/IRightsManagementPolicyMetadata.md)
|
|
4
|
-
|
|
5
|
-
Agreement policy returned by PAP, including optional PAP-managed lifecycle metadata.
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
# Type Alias: IRightsManagementPolicy
|
|
2
|
-
|
|
3
|
-
> **IRightsManagementPolicy** = `Omit`\<`IDataspaceProtocolPolicy`, `"@type"`\> & [`IRightsManagementPolicyMetadata`](../interfaces/IRightsManagementPolicyMetadata.md) & `object`
|
|
4
|
-
|
|
5
|
-
Base type for any ODRL policy stored and managed by the TWIN rights-management PAP.
|
|
6
|
-
|
|
7
|
-
## Type Declaration
|
|
8
|
-
|
|
9
|
-
### @type
|
|
10
|
-
|
|
11
|
-
> **@type**: `OdrlPolicyType`
|