@twin.org/rights-management-models 0.0.3-next.8 → 0.9.0-next.1
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/README.md +11 -3
- package/dist/es/factories/policyObligationEnforcerFactory.js +9 -0
- package/dist/es/factories/policyObligationEnforcerFactory.js.map +1 -0
- package/dist/es/index.js +19 -19
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/IRightsManagementAgreement.js +2 -0
- package/dist/es/models/IRightsManagementAgreement.js.map +1 -0
- package/dist/es/models/IRightsManagementInformation.js +4 -0
- package/dist/es/models/IRightsManagementInformation.js.map +1 -0
- package/dist/es/models/IRightsManagementOffer.js +2 -0
- package/dist/es/models/IRightsManagementOffer.js.map +1 -0
- package/dist/es/models/IRightsManagementPolicy.js +2 -0
- package/dist/es/models/IRightsManagementPolicy.js.map +1 -0
- package/dist/es/models/IRightsManagementPolicyMetadata.js +4 -0
- package/dist/es/models/IRightsManagementPolicyMetadata.js.map +1 -0
- package/dist/es/models/IRightsManagementPolicyTrust.js +2 -0
- package/dist/es/models/IRightsManagementPolicyTrust.js.map +1 -0
- package/dist/es/models/IRightsManagementSet.js +2 -0
- package/dist/es/models/IRightsManagementSet.js.map +1 -0
- package/dist/es/models/api/pap/IPapCreateRequest.js.map +1 -1
- package/dist/es/models/api/pap/IPapGetAgreementRequest.js +4 -0
- package/dist/es/models/api/pap/IPapGetAgreementRequest.js.map +1 -0
- package/dist/es/models/api/pap/IPapGetAgreementResponse.js +2 -0
- package/dist/es/models/api/pap/IPapGetAgreementResponse.js.map +1 -0
- package/dist/es/models/api/pap/IPapGetOfferRequest.js +4 -0
- package/dist/es/models/api/pap/IPapGetOfferRequest.js.map +1 -0
- package/dist/es/models/api/pap/IPapGetOfferResponse.js +2 -0
- package/dist/es/models/api/pap/IPapGetOfferResponse.js.map +1 -0
- package/dist/es/models/api/pap/IPapGetResponse.js.map +1 -1
- package/dist/es/models/{IPolicyLocator.js → api/pap/IPapGetSetRequest.js} +1 -1
- package/dist/es/models/api/pap/IPapGetSetRequest.js.map +1 -0
- package/dist/es/models/api/pap/IPapGetSetResponse.js +2 -0
- package/dist/es/models/api/pap/IPapGetSetResponse.js.map +1 -0
- package/dist/es/models/api/pap/IPapQueryRequest.js.map +1 -1
- package/dist/es/models/api/pap/IPapQueryResponse.js.map +1 -1
- package/dist/es/models/api/pap/IPapUpdateRequest.js.map +1 -1
- package/dist/es/models/api/pnap/IPnapCreateRequest.js +4 -0
- package/dist/es/models/api/pnap/IPnapCreateRequest.js.map +1 -0
- package/dist/es/models/api/pnap/IPnapQueryResponse.js.map +1 -1
- package/dist/es/models/odrlProfiles.js +21 -0
- package/dist/es/models/odrlProfiles.js.map +1 -0
- package/dist/es/models/pap/IPolicyAdministrationPointComponent.js.map +1 -1
- package/dist/es/models/pap/IPolicyLocator.js +2 -0
- package/dist/es/models/pap/IPolicyLocator.js.map +1 -0
- package/dist/es/models/pdp/IPolicyArbiter.js.map +1 -1
- package/dist/es/models/pdp/IPolicyDecision.js.map +1 -1
- package/dist/es/models/pdp/IPolicyDecisionPointComponent.js.map +1 -1
- package/dist/es/models/pdp/IPolicyObligationEnforcer.js +2 -0
- package/dist/es/models/pdp/IPolicyObligationEnforcer.js.map +1 -0
- package/dist/es/models/pdp/policyDecision.js +7 -3
- package/dist/es/models/pdp/policyDecision.js.map +1 -1
- package/dist/es/models/pep/IPolicyEnforcementPointComponent.js.map +1 -1
- package/dist/es/models/pep/IPolicyEnforcementProcessor.js.map +1 -1
- package/dist/es/models/pip/IPolicyInformationPointComponent.js.map +1 -1
- package/dist/es/models/pip/IPolicyInformationSource.js.map +1 -1
- package/dist/es/models/pmp/IPolicyManagementPointComponent.js.map +1 -1
- package/dist/es/models/pnp/IPolicyNegotiation.js.map +1 -1
- package/dist/es/models/pnp/IPolicyNegotiationAdminPointComponent.js.map +1 -1
- package/dist/es/models/pnp/IPolicyNegotiationPointComponent.js.map +1 -1
- package/dist/es/models/pnp/IPolicyNegotiator.js.map +1 -1
- package/dist/es/models/pnp/IPolicyRequester.js.map +1 -1
- package/dist/es/models/policyMetadataContext.js +17 -0
- package/dist/es/models/policyMetadataContext.js.map +1 -0
- package/dist/es/models/pxp/IPolicyExecutionAction.js.map +1 -1
- package/dist/es/models/pxp/IPolicyExecutionPointComponent.js.map +1 -1
- package/dist/es/utils/odrlPolicyHelper.js +212 -85
- package/dist/es/utils/odrlPolicyHelper.js.map +1 -1
- package/dist/types/factories/policyObligationEnforcerFactory.d.ts +6 -0
- package/dist/types/index.d.ts +19 -19
- package/dist/types/models/IRightsManagementAgreement.d.ts +8 -0
- package/dist/types/models/IRightsManagementInformation.d.ts +8 -0
- package/dist/types/models/IRightsManagementOffer.d.ts +8 -0
- package/dist/types/models/IRightsManagementPolicy.d.ts +8 -0
- package/dist/types/models/IRightsManagementPolicyMetadata.d.ts +13 -0
- package/dist/types/models/IRightsManagementPolicyTrust.d.ts +12 -0
- package/dist/types/models/IRightsManagementSet.d.ts +8 -0
- package/dist/types/models/api/pap/IPapCreateRequest.d.ts +4 -5
- package/dist/types/models/api/pap/IPapGetAgreementRequest.d.ts +14 -0
- package/dist/types/models/api/pap/IPapGetAgreementResponse.d.ts +10 -0
- package/dist/types/models/api/pap/IPapGetOfferRequest.d.ts +14 -0
- package/dist/types/models/api/pap/IPapGetOfferResponse.d.ts +10 -0
- package/dist/types/models/api/pap/IPapGetResponse.d.ts +2 -2
- package/dist/types/models/api/pap/IPapGetSetRequest.d.ts +14 -0
- package/dist/types/models/api/pap/IPapGetSetResponse.d.ts +10 -0
- package/dist/types/models/api/pap/IPapQueryRequest.d.ts +16 -0
- package/dist/types/models/api/pap/IPapQueryResponse.d.ts +9 -11
- package/dist/types/models/api/pap/IPapUpdateRequest.d.ts +2 -2
- package/dist/types/models/api/pnap/IPnapCreateRequest.d.ts +14 -0
- package/dist/types/models/api/pnap/IPnapQueryResponse.d.ts +8 -10
- package/dist/types/models/odrlProfiles.d.ts +21 -0
- package/dist/types/models/pap/IPolicyAdministrationPointComponent.d.ts +32 -10
- package/dist/types/models/pap/IPolicyLocator.d.ts +26 -0
- package/dist/types/models/pdp/IPolicyArbiter.d.ts +8 -12
- package/dist/types/models/pdp/IPolicyDecision.d.ts +6 -2
- package/dist/types/models/pdp/IPolicyDecisionPointComponent.d.ts +9 -3
- package/dist/types/models/pdp/IPolicyObligationEnforcer.d.ts +19 -0
- package/dist/types/models/pdp/policyDecision.d.ts +6 -2
- package/dist/types/models/pep/IPolicyEnforcementPointComponent.d.ts +34 -3
- package/dist/types/models/pep/IPolicyEnforcementProcessor.d.ts +5 -3
- package/dist/types/models/pip/IPolicyInformationPointComponent.d.ts +7 -7
- package/dist/types/models/pip/IPolicyInformationSource.d.ts +6 -6
- package/dist/types/models/pmp/IPolicyManagementPointComponent.d.ts +5 -6
- package/dist/types/models/pnp/IPolicyNegotiation.d.ts +21 -9
- package/dist/types/models/pnp/IPolicyNegotiationAdminPointComponent.d.ts +10 -3
- package/dist/types/models/pnp/IPolicyNegotiationPointComponent.d.ts +13 -3
- package/dist/types/models/pnp/IPolicyNegotiator.d.ts +8 -6
- package/dist/types/models/pnp/IPolicyRequester.d.ts +6 -10
- package/dist/types/models/policyMetadataContext.d.ts +14 -0
- package/dist/types/models/pxp/IPolicyExecutionAction.d.ts +6 -6
- package/dist/types/models/pxp/IPolicyExecutionPointComponent.d.ts +7 -7
- package/dist/types/utils/odrlPolicyHelper.d.ts +69 -37
- package/docs/changelog.md +892 -135
- package/docs/examples.md +81 -1
- package/docs/reference/classes/OdrlPolicyHelper.md +136 -85
- package/docs/reference/index.md +20 -19
- package/docs/reference/interfaces/IPapCreateRequest.md +3 -9
- package/docs/reference/interfaces/IPapGetAgreementRequest.md +17 -0
- package/docs/reference/interfaces/IPapGetAgreementResponse.md +11 -0
- package/docs/reference/interfaces/IPapGetOfferRequest.md +17 -0
- package/docs/reference/interfaces/IPapGetOfferResponse.md +11 -0
- package/docs/reference/interfaces/IPapGetRequest.md +1 -1
- package/docs/reference/interfaces/IPapGetResponse.md +2 -2
- package/docs/reference/interfaces/IPapGetSetRequest.md +17 -0
- package/docs/reference/interfaces/IPapGetSetResponse.md +11 -0
- package/docs/reference/interfaces/IPapQueryRequest.md +29 -5
- package/docs/reference/interfaces/IPapQueryResponse.md +9 -9
- package/docs/reference/interfaces/IPapRemoveRequest.md +1 -1
- package/docs/reference/interfaces/IPapUpdateRequest.md +3 -3
- package/docs/reference/interfaces/IPnapCreateRequest.md +17 -0
- package/docs/reference/interfaces/IPnapGetRequest.md +1 -1
- package/docs/reference/interfaces/IPnapGetResponse.md +1 -1
- package/docs/reference/interfaces/IPnapQueryRequest.md +4 -4
- package/docs/reference/interfaces/IPnapQueryResponse.md +9 -9
- package/docs/reference/interfaces/IPnapRemoveRequest.md +1 -1
- package/docs/reference/interfaces/IPnapSetRequest.md +2 -2
- package/docs/reference/interfaces/IPnpAgreementRequest.md +5 -5
- package/docs/reference/interfaces/IPnpAgreementVerificationRequest.md +5 -5
- package/docs/reference/interfaces/IPnpContractNegotiationResponse.md +5 -5
- package/docs/reference/interfaces/IPnpContractResponse.md +6 -6
- package/docs/reference/interfaces/IPnpEventRequest.md +5 -5
- package/docs/reference/interfaces/IPnpNegotiateRequest.md +7 -7
- package/docs/reference/interfaces/IPnpNegotiationGetRequest.md +4 -4
- package/docs/reference/interfaces/IPnpOfferRequest.md +7 -7
- package/docs/reference/interfaces/IPnpTerminateRequest.md +5 -5
- package/docs/reference/interfaces/IPolicyAdministrationPointComponent.md +86 -14
- package/docs/reference/interfaces/IPolicyArbiter.md +14 -27
- package/docs/reference/interfaces/IPolicyDecision.md +12 -4
- package/docs/reference/interfaces/IPolicyDecisionPointComponent.md +15 -5
- package/docs/reference/interfaces/IPolicyEnforcementPointComponent.md +124 -4
- package/docs/reference/interfaces/IPolicyEnforcementProcessor.md +11 -5
- package/docs/reference/interfaces/IPolicyExecutionAction.md +18 -18
- package/docs/reference/interfaces/IPolicyExecutionPointComponent.md +18 -18
- package/docs/reference/interfaces/IPolicyInformationPointComponent.md +13 -13
- package/docs/reference/interfaces/IPolicyInformationSource.md +12 -12
- package/docs/reference/interfaces/IPolicyLocator.md +20 -16
- package/docs/reference/interfaces/IPolicyManagementPointComponent.md +5 -17
- package/docs/reference/interfaces/IPolicyNegotiation.md +54 -81
- package/docs/reference/interfaces/IPolicyNegotiationAdminPointComponent.md +32 -6
- package/docs/reference/interfaces/IPolicyNegotiationPointComponent.md +59 -15
- package/docs/reference/interfaces/IPolicyNegotiator.md +17 -11
- package/docs/reference/interfaces/IPolicyObligationEnforcer.md +59 -0
- package/docs/reference/interfaces/IPolicyRequester.md +8 -22
- package/docs/reference/interfaces/IRightsManagementAgreement.md +47 -0
- package/docs/reference/interfaces/IRightsManagementInformation.md +9 -0
- package/docs/reference/interfaces/IRightsManagementOffer.md +47 -0
- package/docs/reference/interfaces/IRightsManagementPolicy.md +47 -0
- package/docs/reference/interfaces/IRightsManagementPolicyMetadata.md +26 -0
- package/docs/reference/interfaces/IRightsManagementPolicyTrust.md +22 -0
- package/docs/reference/interfaces/IRightsManagementSet.md +47 -0
- package/docs/reference/type-aliases/OdrlProfiles.md +5 -0
- package/docs/reference/variables/OdrlProfiles.md +23 -0
- package/docs/reference/variables/POLICY_METADATA_CONTEXT.md +20 -0
- package/docs/reference/variables/PolicyDecision.md +10 -4
- package/docs/reference/variables/PolicyDecisionStage.md +2 -2
- package/docs/reference/variables/PolicyInformationAccessMode.md +3 -3
- package/docs/reference/variables/PolicyObligationEnforcerFactory.md +5 -0
- package/docs/reference/variables/RightsManagementContexts.md +3 -3
- package/docs/reference/variables/RightsManagementNamespaces.md +2 -2
- package/docs/reference/variables/RightsManagementTypes.md +4 -4
- package/locales/en.json +8 -1
- package/package.json +15 -14
- package/dist/es/factories/dataAccessHandlerFactory.js +0 -9
- package/dist/es/factories/dataAccessHandlerFactory.js.map +0 -1
- package/dist/es/models/IPolicyLocator.js.map +0 -1
- package/dist/es/models/api/dap/IDapCreateRequest.js +0 -2
- package/dist/es/models/api/dap/IDapCreateRequest.js.map +0 -1
- package/dist/es/models/api/dap/IDapGetRequest.js +0 -2
- package/dist/es/models/api/dap/IDapGetRequest.js.map +0 -1
- package/dist/es/models/api/dap/IDapGetResponse.js +0 -2
- package/dist/es/models/api/dap/IDapGetResponse.js.map +0 -1
- package/dist/es/models/api/dap/IDapQueryRequest.js +0 -2
- package/dist/es/models/api/dap/IDapQueryRequest.js.map +0 -1
- package/dist/es/models/api/dap/IDapQueryResponse.js +0 -2
- package/dist/es/models/api/dap/IDapQueryResponse.js.map +0 -1
- package/dist/es/models/api/dap/IDapRemoveRequest.js +0 -2
- package/dist/es/models/api/dap/IDapRemoveRequest.js.map +0 -1
- package/dist/es/models/api/dap/IDapUpdateRequest.js +0 -2
- package/dist/es/models/api/dap/IDapUpdateRequest.js.map +0 -1
- package/dist/es/models/dap/IDataAccessHandler.js +0 -2
- package/dist/es/models/dap/IDataAccessHandler.js.map +0 -1
- package/dist/es/models/dap/IDataAccessPointComponent.js +0 -2
- package/dist/es/models/dap/IDataAccessPointComponent.js.map +0 -1
- package/dist/es/models/dap/IDataAccessRequestPointComponent.js +0 -2
- package/dist/es/models/dap/IDataAccessRequestPointComponent.js.map +0 -1
- package/dist/es/models/dap/jsonLd/IDataAccessQuery.js +0 -2
- package/dist/es/models/dap/jsonLd/IDataAccessQuery.js.map +0 -1
- package/dist/es/models/dap/jsonLd/IDataAccessQueryResponse.js +0 -2
- package/dist/es/models/dap/jsonLd/IDataAccessQueryResponse.js.map +0 -1
- package/dist/es/models/dap/jsonLd/IDataAccessRequest.js +0 -2
- package/dist/es/models/dap/jsonLd/IDataAccessRequest.js.map +0 -1
- package/dist/es/models/dap/jsonLd/IDataAccessRequestWithObject.js +0 -2
- package/dist/es/models/dap/jsonLd/IDataAccessRequestWithObject.js.map +0 -1
- package/dist/es/models/pip/IPolicyInformation.js +0 -2
- package/dist/es/models/pip/IPolicyInformation.js.map +0 -1
- package/dist/es/models/pip/IPolicyInformationItems.js +0 -2
- package/dist/es/models/pip/IPolicyInformationItems.js.map +0 -1
- package/dist/es/utils/locatorHelper.js +0 -56
- package/dist/es/utils/locatorHelper.js.map +0 -1
- package/dist/types/factories/dataAccessHandlerFactory.d.ts +0 -6
- package/dist/types/models/IPolicyLocator.d.ts +0 -21
- package/dist/types/models/api/dap/IDapCreateRequest.d.ts +0 -27
- package/dist/types/models/api/dap/IDapGetRequest.d.ts +0 -26
- package/dist/types/models/api/dap/IDapGetResponse.d.ts +0 -17
- package/dist/types/models/api/dap/IDapQueryRequest.d.ts +0 -27
- package/dist/types/models/api/dap/IDapQueryResponse.d.ts +0 -17
- package/dist/types/models/api/dap/IDapRemoveRequest.d.ts +0 -26
- package/dist/types/models/api/dap/IDapUpdateRequest.d.ts +0 -31
- package/dist/types/models/dap/IDataAccessHandler.d.ts +0 -53
- package/dist/types/models/dap/IDataAccessPointComponent.d.ts +0 -56
- package/dist/types/models/dap/IDataAccessRequestPointComponent.d.ts +0 -54
- package/dist/types/models/dap/jsonLd/IDataAccessQuery.d.ts +0 -33
- package/dist/types/models/dap/jsonLd/IDataAccessQueryResponse.d.ts +0 -24
- package/dist/types/models/dap/jsonLd/IDataAccessRequest.d.ts +0 -23
- package/dist/types/models/dap/jsonLd/IDataAccessRequestWithObject.d.ts +0 -24
- package/dist/types/models/pip/IPolicyInformation.d.ts +0 -7
- package/dist/types/models/pip/IPolicyInformationItems.d.ts +0 -5
- package/dist/types/utils/locatorHelper.d.ts +0 -26
- package/docs/reference/classes/LocatorHelper.md +0 -91
- package/docs/reference/interfaces/IDapCreateRequest.md +0 -41
- package/docs/reference/interfaces/IDapGetRequest.md +0 -39
- package/docs/reference/interfaces/IDapGetResponse.md +0 -23
- package/docs/reference/interfaces/IDapQueryRequest.md +0 -41
- package/docs/reference/interfaces/IDapQueryResponse.md +0 -23
- package/docs/reference/interfaces/IDapRemoveRequest.md +0 -39
- package/docs/reference/interfaces/IDapUpdateRequest.md +0 -47
- package/docs/reference/interfaces/IDataAccessHandler.md +0 -173
- package/docs/reference/interfaces/IDataAccessPointComponent.md +0 -192
- package/docs/reference/interfaces/IDataAccessQuery.md +0 -51
- package/docs/reference/interfaces/IDataAccessQueryResponse.md +0 -35
- package/docs/reference/interfaces/IDataAccessRequest.md +0 -35
- package/docs/reference/interfaces/IDataAccessRequestPointComponent.md +0 -190
- package/docs/reference/interfaces/IDataAccessRequestWithObject.md +0 -35
- package/docs/reference/interfaces/IPolicyInformation.md +0 -7
- package/docs/reference/type-aliases/IPolicyInformationItems.md +0 -5
- package/docs/reference/variables/DataAccessHandlerFactory.md +0 -5
package/README.md
CHANGED
|
@@ -1,12 +1,20 @@
|
|
|
1
1
|
# TWIN Rights Management Models
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
This package provides data model definitions for rights management policies, negotiations, and service contracts. It is intended to be used as a shared foundation for services and integrations across the repository.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
`shell
|
|
8
8
|
npm install @twin.org/rights-management-models
|
|
9
|
-
|
|
9
|
+
`
|
|
10
|
+
|
|
11
|
+
## Testing
|
|
12
|
+
|
|
13
|
+
Run the package test suite with:
|
|
14
|
+
|
|
15
|
+
`shell
|
|
16
|
+
npm test
|
|
17
|
+
`
|
|
10
18
|
|
|
11
19
|
## Examples
|
|
12
20
|
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
// Copyright 2025 IOTA Stiftung.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
+
import { Factory } from "@twin.org/core";
|
|
4
|
+
/**
|
|
5
|
+
* Factory for managing policy obligation enforcer registration and retrieval.
|
|
6
|
+
*/
|
|
7
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
8
|
+
export const PolicyObligationEnforcerFactory = Factory.createFactory("policy-obligation-enforcer");
|
|
9
|
+
//# sourceMappingURL=policyObligationEnforcerFactory.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"policyObligationEnforcerFactory.js","sourceRoot":"","sources":["../../../src/factories/policyObligationEnforcerFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,+BAA+B,GAAG,OAAO,CAAC,aAAa,CACnE,4BAA4B,CAC5B,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IPolicyObligationEnforcer } from \"../models/pdp/IPolicyObligationEnforcer.js\";\n\n/**\n * Factory for managing policy obligation enforcer registration and retrieval.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const PolicyObligationEnforcerFactory = Factory.createFactory<IPolicyObligationEnforcer>(\n\t\"policy-obligation-enforcer\"\n);\n"]}
|
package/dist/es/index.js
CHANGED
|
@@ -1,26 +1,26 @@
|
|
|
1
1
|
// Copyright 2025 IOTA Stiftung.
|
|
2
2
|
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
-
export * from "./factories/dataAccessHandlerFactory.js";
|
|
4
3
|
export * from "./factories/policyArbiterFactory.js";
|
|
5
4
|
export * from "./factories/policyEnforcementProcessorFactory.js";
|
|
6
5
|
export * from "./factories/policyExecutionActionFactory.js";
|
|
7
6
|
export * from "./factories/policyInformationSourceFactory.js";
|
|
8
7
|
export * from "./factories/policyNegotiatorFactory.js";
|
|
8
|
+
export * from "./factories/policyObligationEnforcerFactory.js";
|
|
9
9
|
export * from "./factories/policyRequesterFactory.js";
|
|
10
|
-
export * from "./models/api/dap/IDapCreateRequest.js";
|
|
11
|
-
export * from "./models/api/dap/IDapGetRequest.js";
|
|
12
|
-
export * from "./models/api/dap/IDapGetResponse.js";
|
|
13
|
-
export * from "./models/api/dap/IDapQueryRequest.js";
|
|
14
|
-
export * from "./models/api/dap/IDapQueryResponse.js";
|
|
15
|
-
export * from "./models/api/dap/IDapRemoveRequest.js";
|
|
16
|
-
export * from "./models/api/dap/IDapUpdateRequest.js";
|
|
17
10
|
export * from "./models/api/pap/IPapCreateRequest.js";
|
|
11
|
+
export * from "./models/api/pap/IPapGetAgreementRequest.js";
|
|
12
|
+
export * from "./models/api/pap/IPapGetAgreementResponse.js";
|
|
13
|
+
export * from "./models/api/pap/IPapGetOfferRequest.js";
|
|
14
|
+
export * from "./models/api/pap/IPapGetOfferResponse.js";
|
|
18
15
|
export * from "./models/api/pap/IPapGetRequest.js";
|
|
19
16
|
export * from "./models/api/pap/IPapGetResponse.js";
|
|
17
|
+
export * from "./models/api/pap/IPapGetSetRequest.js";
|
|
18
|
+
export * from "./models/api/pap/IPapGetSetResponse.js";
|
|
20
19
|
export * from "./models/api/pap/IPapQueryRequest.js";
|
|
21
20
|
export * from "./models/api/pap/IPapQueryResponse.js";
|
|
22
21
|
export * from "./models/api/pap/IPapRemoveRequest.js";
|
|
23
22
|
export * from "./models/api/pap/IPapUpdateRequest.js";
|
|
23
|
+
export * from "./models/api/pnap/IPnapCreateRequest.js";
|
|
24
24
|
export * from "./models/api/pnap/IPnapGetRequest.js";
|
|
25
25
|
export * from "./models/api/pnap/IPnapGetResponse.js";
|
|
26
26
|
export * from "./models/api/pnap/IPnapQueryRequest.js";
|
|
@@ -36,24 +36,24 @@ export * from "./models/api/pnp/IPnpNegotiateRequest.js";
|
|
|
36
36
|
export * from "./models/api/pnp/IPnpNegotiationGetRequest.js";
|
|
37
37
|
export * from "./models/api/pnp/IPnpOfferRequest.js";
|
|
38
38
|
export * from "./models/api/pnp/IPnpTerminateRequest.js";
|
|
39
|
-
export * from "./models/
|
|
40
|
-
export * from "./models/
|
|
41
|
-
export * from "./models/
|
|
42
|
-
export * from "./models/
|
|
43
|
-
export * from "./models/
|
|
44
|
-
export * from "./models/
|
|
45
|
-
export * from "./models/
|
|
46
|
-
export * from "./models/
|
|
39
|
+
export * from "./models/IRightsManagementAgreement.js";
|
|
40
|
+
export * from "./models/IRightsManagementInformation.js";
|
|
41
|
+
export * from "./models/IRightsManagementOffer.js";
|
|
42
|
+
export * from "./models/IRightsManagementPolicy.js";
|
|
43
|
+
export * from "./models/IRightsManagementPolicyMetadata.js";
|
|
44
|
+
export * from "./models/IRightsManagementPolicyTrust.js";
|
|
45
|
+
export * from "./models/IRightsManagementSet.js";
|
|
46
|
+
export * from "./models/odrlProfiles.js";
|
|
47
47
|
export * from "./models/pap/IPolicyAdministrationPointComponent.js";
|
|
48
|
+
export * from "./models/pap/IPolicyLocator.js";
|
|
48
49
|
export * from "./models/pdp/IPolicyArbiter.js";
|
|
49
50
|
export * from "./models/pdp/IPolicyDecision.js";
|
|
50
51
|
export * from "./models/pdp/IPolicyDecisionPointComponent.js";
|
|
52
|
+
export * from "./models/pdp/IPolicyObligationEnforcer.js";
|
|
51
53
|
export * from "./models/pdp/policyDecision.js";
|
|
52
54
|
export * from "./models/pdp/policyDecisionStage.js";
|
|
53
55
|
export * from "./models/pep/IPolicyEnforcementPointComponent.js";
|
|
54
56
|
export * from "./models/pep/IPolicyEnforcementProcessor.js";
|
|
55
|
-
export * from "./models/pip/IPolicyInformation.js";
|
|
56
|
-
export * from "./models/pip/IPolicyInformationItems.js";
|
|
57
57
|
export * from "./models/pip/IPolicyInformationPointComponent.js";
|
|
58
58
|
export * from "./models/pip/IPolicyInformationSource.js";
|
|
59
59
|
export * from "./models/pip/policyInformationAccessMode.js";
|
|
@@ -63,11 +63,11 @@ export * from "./models/pnp/IPolicyNegotiationAdminPointComponent.js";
|
|
|
63
63
|
export * from "./models/pnp/IPolicyNegotiationPointComponent.js";
|
|
64
64
|
export * from "./models/pnp/IPolicyNegotiator.js";
|
|
65
65
|
export * from "./models/pnp/IPolicyRequester.js";
|
|
66
|
+
export * from "./models/policyMetadataContext.js";
|
|
66
67
|
export * from "./models/pxp/IPolicyExecutionAction.js";
|
|
67
68
|
export * from "./models/pxp/IPolicyExecutionPointComponent.js";
|
|
68
69
|
export * from "./models/rightsManagementContexts.js";
|
|
69
70
|
export * from "./models/rightsManagementNamespaces.js";
|
|
70
71
|
export * from "./models/rightsManagementTypes.js";
|
|
71
|
-
export * from "./utils/locatorHelper.js";
|
|
72
72
|
export * from "./utils/odrlPolicyHelper.js";
|
|
73
73
|
//# sourceMappingURL=index.js.map
|
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,
|
|
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,0CAA0C,CAAC;AACzD,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,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/IRightsManagementInformation.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/pap/IPolicyLocator.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"]}
|
|
@@ -0,0 +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\";\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"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IRightsManagementInformation.js","sourceRoot":"","sources":["../../../src/models/IRightsManagementInformation.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Named objects available to the rights management components during policy evaluation.\n * Values are accessed via JSONPath and may be any type - structured JSON-LD nodes,\n * plain objects, or scalar primitives.\n */\nexport interface IRightsManagementInformation {\n\t[id: string]: unknown;\n}\n"]}
|
|
@@ -0,0 +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\";\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"]}
|
|
@@ -0,0 +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 { 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":"IRightsManagementPolicyMetadata.js","sourceRoot":"","sources":["../../../src/models/IRightsManagementPolicyMetadata.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * PAP-managed metadata attached to stored and returned ODRL policies.\n */\nexport interface IRightsManagementPolicyMetadata {\n\t/**\n\t * schema.org dateCreated — ISO 8601 date-time set by PAP on create.\n\t */\n\tdateCreated?: string;\n\n\t/**\n\t * schema.org dateModified — ISO 8601 date-time set by PAP on create and update.\n\t */\n\tdateModified?: string;\n}\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"]}
|
|
@@ -0,0 +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\";\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":"IPapCreateRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pap/IPapCreateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {
|
|
1
|
+
{"version":3,"file":"IPapCreateRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pap/IPapCreateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { JsonLdObjectWithOptionalAtId } from \"@twin.org/data-json-ld\";\nimport type { IRightsManagementPolicy } from \"../../IRightsManagementPolicy.js\";\n\n/**\n * The request structure for creating a policy.\n */\nexport interface IPapCreateRequest {\n\t/**\n\t * The body of the request - the policy to create (id will be auto-generated if not provided).\n\t */\n\tbody: JsonLdObjectWithOptionalAtId<IRightsManagementPolicy>;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IPapGetAgreementRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pap/IPapGetAgreementRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The request structure for getting an agreement.\n */\nexport interface IPapGetAgreementRequest {\n\t/**\n\t * The path parameters of the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The ID of the agreement to get.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IPapGetAgreementResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/pap/IPapGetAgreementResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRightsManagementAgreement } from \"../../IRightsManagementAgreement.js\";\n\n/**\n * The response structure for getting an agreement.\n */\nexport interface IPapGetAgreementResponse {\n\t/**\n\t * The body of the response.\n\t */\n\tbody: IRightsManagementAgreement;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IPapGetOfferRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pap/IPapGetOfferRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The request structure for getting an offer.\n */\nexport interface IPapGetOfferRequest {\n\t/**\n\t * The path parameters of the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The ID of the offer to get.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IPapGetOfferResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/pap/IPapGetOfferResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRightsManagementOffer } from \"../../IRightsManagementOffer.js\";\n\n/**\n * The response structure for getting an offer.\n */\nexport interface IPapGetOfferResponse {\n\t/**\n\t * The body of the response.\n\t */\n\tbody: IRightsManagementOffer;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPapGetResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/pap/IPapGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {
|
|
1
|
+
{"version":3,"file":"IPapGetResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/pap/IPapGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRightsManagementPolicy } from \"../../IRightsManagementPolicy.js\";\n\n/**\n * The response structure for getting a policy.\n */\nexport interface IPapGetResponse {\n\t/**\n\t * The body of the response.\n\t */\n\tbody: IRightsManagementPolicy;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IPapGetSetRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pap/IPapGetSetRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The request structure for getting a set.\n */\nexport interface IPapGetSetRequest {\n\t/**\n\t * The path parameters of the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The ID of the set to get.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IPapGetSetResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/pap/IPapGetSetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRightsManagementSet } from \"../../IRightsManagementSet.js\";\n\n/**\n * The response structure for getting a set.\n */\nexport interface IPapGetSetResponse {\n\t/**\n\t * The body of the response.\n\t */\n\tbody: IRightsManagementSet;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPapQueryRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pap/IPapQueryRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The request structure for querying policies.\n */\nexport interface IPapQueryRequest {\n\t/**\n\t * The query parameters of the request.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The condition for the query.\n\t\t */\n\t\tconditions?: string;\n\n\t\t/**\n\t\t * Limit the number of entities to return.\n\t\t */\n\t\tlimit?: string;\n\n\t\t/**\n\t\t * The cursor to get next chunk of data, returned in previous response.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}
|
|
1
|
+
{"version":3,"file":"IPapQueryRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pap/IPapQueryRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The request structure for querying policies.\n */\nexport interface IPapQueryRequest {\n\t/**\n\t * The query parameters of the request.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The assigner to filter by.\n\t\t */\n\t\tassigner?: string;\n\n\t\t/**\n\t\t * The assignee to filter by.\n\t\t */\n\t\tassignee?: string;\n\n\t\t/**\n\t\t * The action to filter by.\n\t\t */\n\t\taction?: string;\n\n\t\t/**\n\t\t * The target to filter by.\n\t\t */\n\t\ttarget?: string;\n\n\t\t/**\n\t\t * The condition for the query.\n\t\t */\n\t\tconditions?: string;\n\n\t\t/**\n\t\t * Limit the number of entities to return.\n\t\t */\n\t\tlimit?: string;\n\n\t\t/**\n\t\t * The cursor to get next chunk of data, returned in previous response.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPapQueryResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/pap/IPapQueryResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {
|
|
1
|
+
{"version":3,"file":"IPapQueryResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/pap/IPapQueryResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes } from \"@twin.org/web\";\nimport type { IRightsManagementPolicy } from \"../../IRightsManagementPolicy.js\";\n\n/**\n * The response structure for querying policies.\n */\nexport interface IPapQueryResponse {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Link]?: string | string[];\n\t};\n\n\t/**\n\t * The body of the response.\n\t */\n\tbody: IRightsManagementPolicy[];\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPapUpdateRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pap/IPapUpdateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {
|
|
1
|
+
{"version":3,"file":"IPapUpdateRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pap/IPapUpdateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRightsManagementPolicy } from \"../../IRightsManagementPolicy.js\";\n\n/**\n * The request structure for updating a policy.\n */\nexport interface IPapUpdateRequest {\n\t/**\n\t * The path parameters of the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The ID of the policy to update.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The body of the request.\n\t */\n\tbody: IRightsManagementPolicy;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IPnapCreateRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/pnap/IPnapCreateRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The request structure for creating a policy negotiation entry.\n */\nexport interface IPnapCreateRequest {\n\t/**\n\t * The partial negotiation to pre-register.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The consumer-side negotiation identifier (DSP consumerPid).\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPnapQueryResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/pnap/IPnapQueryResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IPolicyNegotiation } from \"../../pnp/IPolicyNegotiation.js\";\n\n/**\n * The response structure for querying manual policy negotiations.\n */\nexport interface IPnapQueryResponse {\n\t/**\n\t * The
|
|
1
|
+
{"version":3,"file":"IPnapQueryResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/pnap/IPnapQueryResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes } from \"@twin.org/web\";\nimport type { IPolicyNegotiation } from \"../../pnp/IPolicyNegotiation.js\";\n\n/**\n * The response structure for querying manual policy negotiations.\n */\nexport interface IPnapQueryResponse {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Link]?: string | string[];\n\t};\n\n\t/**\n\t * The body of the response.\n\t */\n\tbody: IPolicyNegotiation[];\n}\n"]}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
// Copyright 2025 IOTA Stiftung.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
+
/**
|
|
4
|
+
* Well-known ODRL profile URIs used by the TWIN platform.
|
|
5
|
+
*/
|
|
6
|
+
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
7
|
+
export const OdrlProfiles = {
|
|
8
|
+
/**
|
|
9
|
+
* The TWIN platform ODRL profile URI.
|
|
10
|
+
* Policies carrying this profile may use TWIN-specific vocabulary extensions
|
|
11
|
+
* (e.g. canonical twin:jsonPath + twin:jsonPathExpression operands).
|
|
12
|
+
* https://schema.twindev.org/odrl/v1/
|
|
13
|
+
*/
|
|
14
|
+
Twin: "https://schema.twindev.org/odrl/v1/profile",
|
|
15
|
+
/**
|
|
16
|
+
* The TWIN platform ODRL vocabulary context URL.
|
|
17
|
+
* Used as the second entry in the `@context` array when policy extensions are used.
|
|
18
|
+
*/
|
|
19
|
+
TwinVocabContext: "https://schema.twindev.org/odrl/v1/"
|
|
20
|
+
};
|
|
21
|
+
//# sourceMappingURL=odrlProfiles.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"odrlProfiles.js","sourceRoot":"","sources":["../../../src/models/odrlProfiles.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B;;;;;OAKG;IACH,IAAI,EAAE,4CAA4C;IAElD;;;OAGG;IACH,gBAAgB,EAAE,qCAAqC;CAC9C,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Well-known ODRL profile URIs used by the TWIN platform.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const OdrlProfiles = {\n\t/**\n\t * The TWIN platform ODRL profile URI.\n\t * Policies carrying this profile may use TWIN-specific vocabulary extensions\n\t * (e.g. canonical twin:jsonPath + twin:jsonPathExpression operands).\n\t * https://schema.twindev.org/odrl/v1/\n\t */\n\tTwin: \"https://schema.twindev.org/odrl/v1/profile\",\n\n\t/**\n\t * The TWIN platform ODRL vocabulary context URL.\n\t * Used as the second entry in the `@context` array when policy extensions are used.\n\t */\n\tTwinVocabContext: \"https://schema.twindev.org/odrl/v1/\"\n} as const;\n\n/**\n * The ODRL profiles.\n */\nexport type OdrlProfiles = (typeof OdrlProfiles)[keyof typeof OdrlProfiles];\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPolicyAdministrationPointComponent.js","sourceRoot":"","sources":["../../../../src/models/pap/IPolicyAdministrationPointComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type {
|
|
1
|
+
{"version":3,"file":"IPolicyAdministrationPointComponent.js","sourceRoot":"","sources":["../../../../src/models/pap/IPolicyAdministrationPointComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { JsonLdObjectWithOptionalAtId } from \"@twin.org/data-json-ld\";\nimport type { EntityCondition } from \"@twin.org/entity\";\nimport type { IRightsManagementAgreement } from \"../IRightsManagementAgreement.js\";\nimport type { IRightsManagementOffer } from \"../IRightsManagementOffer.js\";\nimport type { IRightsManagementPolicy } from \"../IRightsManagementPolicy.js\";\nimport type { IRightsManagementSet } from \"../IRightsManagementSet.js\";\nimport type { IPolicyLocator } from \"./IPolicyLocator.js\";\n\n/**\n * Interface describing a Policy Administration Point (PAP) component that manages ODRL policies.\n */\nexport interface IPolicyAdministrationPointComponent extends IComponent {\n\t/**\n\t * Create a new policy with auto-generated UID.\n\t * @param policy The policy to create (uid will be auto-generated).\n\t * @returns The UID of the created policy.\n\t */\n\tcreate(policy: JsonLdObjectWithOptionalAtId<IRightsManagementPolicy>): Promise<string>;\n\n\t/**\n\t * Update an existing policy.\n\t * @param policy The policy to update (must include uid).\n\t * @returns A promise that resolves when the policy has been updated.\n\t */\n\tupdate(policy: IRightsManagementPolicy): Promise<void>;\n\n\t/**\n\t * Get a policy.\n\t * @param policyId The id of the policy to get.\n\t * @returns The policy.\n\t */\n\tget(policyId: string): Promise<IRightsManagementPolicy>;\n\n\t/**\n\t * Get an agreement.\n\t * @param agreementId The id of the agreement to get.\n\t * @returns The agreement.\n\t */\n\tgetAgreement(agreementId: string): Promise<IRightsManagementAgreement>;\n\n\t/**\n\t * Get a set.\n\t * @param setId The id of the set to get.\n\t * @returns The set.\n\t */\n\tgetSet(setId: string): Promise<IRightsManagementSet>;\n\n\t/**\n\t * Get an offer.\n\t * @param offerId The id of the offer to get.\n\t * @returns The offer.\n\t */\n\tgetOffer(offerId: string): Promise<IRightsManagementOffer>;\n\n\t/**\n\t * Remove a policy.\n\t * @param policyId The id of the policy to remove.\n\t * @returns A promise that resolves when the policy has been removed.\n\t */\n\tremove(policyId: string): Promise<void>;\n\n\t/**\n\t * Query the policies using the specified conditions.\n\t * @param locator Optional locator to filter by type, assigner, assignee, target, or action.\n\t * @param conditions The conditions to use for the query.\n\t * @param cursor The cursor to use for pagination.\n\t * @param limit The number of results to return per page.\n\t * @returns Cursor for next page of results and the policies matching the query.\n\t */\n\tquery(\n\t\tlocator?: IPolicyLocator,\n\t\tconditions?: EntityCondition<IRightsManagementPolicy>,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The cursor for the next page of results.\n\t\t */\n\t\tcursor?: string;\n\n\t\t/**\n\t\t * The policies that match the query.\n\t\t */\n\t\tpolicies: IRightsManagementPolicy[];\n\t}>;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IPolicyLocator.js","sourceRoot":"","sources":["../../../../src/models/pap/IPolicyLocator.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { OdrlPolicyType } from \"@twin.org/standards-w3c-odrl\";\n\n/**\n * Interface describing criteria for locating policies.\n */\nexport interface IPolicyLocator {\n\t/**\n\t * The type of policy to filter by.\n\t */\n\ttype?: OdrlPolicyType;\n\n\t/**\n\t * The assigner to filter by.\n\t */\n\tassigner?: string;\n\n\t/**\n\t * The assignee to filter by.\n\t */\n\tassignee?: string;\n\n\t/**\n\t * The target to filter by.\n\t */\n\ttarget?: string;\n\n\t/**\n\t * The action to filter by.\n\t */\n\taction?: string;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPolicyArbiter.js","sourceRoot":"","sources":["../../../../src/models/pdp/IPolicyArbiter.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type {
|
|
1
|
+
{"version":3,"file":"IPolicyArbiter.js","sourceRoot":"","sources":["../../../../src/models/pdp/IPolicyArbiter.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 { IRightsManagementInformation } from \"../IRightsManagementInformation.js\";\nimport type { IPolicyDecision } from \"./IPolicyDecision.js\";\n\n/**\n * Interface describing a Policy Arbiter.\n */\nexport interface IPolicyArbiter extends IComponent {\n\t/**\n\t * Makes decisions regarding policy access to data.\n\t * @param agreement The agreement to evaluate.\n\t * @param information Named objects available to the arbiter during evaluation. Values are accessed\n\t * via JSONPath and may be any type - structured JSON-LD nodes, plain objects, or scalar primitives.\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 arbiter will evaluate all actions in the agreement.\n\t * @returns The decisions about access to the data.\n\t */\n\tdecide<D = unknown>(\n\t\tagreement: IDataspaceProtocolAgreement,\n\t\tinformation?: IRightsManagementInformation,\n\t\tdata?: D,\n\t\taction?: OdrlActionType | string\n\t): Promise<IPolicyDecision[]>;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPolicyDecision.js","sourceRoot":"","sources":["../../../../src/models/pdp/IPolicyDecision.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { PolicyDecision } from \"./policyDecision.js\";\n\n/**\n * The information regarding a policy decision.\n */\nexport interface IPolicyDecision {\n\t/**\n\t * The target object for the decision.\n\t */\n\ttarget: string;\n\n\t/**\n\t * The
|
|
1
|
+
{"version":3,"file":"IPolicyDecision.js","sourceRoot":"","sources":["../../../../src/models/pdp/IPolicyDecision.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { PolicyDecision } from \"./policyDecision.js\";\n\n/**\n * The information regarding a policy decision.\n */\nexport interface IPolicyDecision {\n\t/**\n\t * The target object for the decision, using JSON-path syntax.\n\t */\n\ttarget: string;\n\n\t/**\n\t * The outcome of the policy decision.\n\t */\n\tdecision: PolicyDecision;\n\n\t/**\n\t * The value to replace with, if decision is Replace.\n\t */\n\treplaceValue?: unknown;\n}\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 {
|
|
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"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IPolicyObligationEnforcer.js","sourceRoot":"","sources":["../../../../src/models/pdp/IPolicyObligationEnforcer.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { OdrlActionType, IOdrlDuty } from \"@twin.org/standards-w3c-odrl\";\nimport type { IRightsManagementInformation } from \"../IRightsManagementInformation.js\";\nimport type { IRightsManagementPolicy } from \"../IRightsManagementPolicy.js\";\n\n/**\n * Interface describing a Policy Obligation Enforcer.\n */\nexport interface IPolicyObligationEnforcer extends IComponent {\n\t/**\n\t * Enforces obligations regarding policy access to data.\n\t * @param policy The policy to evaluate.\n\t * @param duty The duty to enforce.\n\t * @param information Information provided by the requester to determine if a policy can be created.\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 enforcer will evaluate all actions in the duty.\n\t * @returns Whether the obligations were successfully enforced.\n\t */\n\tenforce<D = unknown>(\n\t\tpolicy: IRightsManagementPolicy,\n\t\tduty: IOdrlDuty,\n\t\tinformation?: IRightsManagementInformation,\n\t\tdata?: D,\n\t\taction?: OdrlActionType | string\n\t): Promise<boolean>;\n}\n"]}
|
|
@@ -6,12 +6,16 @@
|
|
|
6
6
|
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
7
7
|
export const PolicyDecision = {
|
|
8
8
|
/**
|
|
9
|
-
* Granted.
|
|
9
|
+
* Granted - the property in the original data can be accessed.
|
|
10
10
|
*/
|
|
11
11
|
Granted: "Granted",
|
|
12
12
|
/**
|
|
13
|
-
* Denied.
|
|
13
|
+
* Denied - the property in the original data can not be accessed.
|
|
14
14
|
*/
|
|
15
|
-
Denied: "Denied"
|
|
15
|
+
Denied: "Denied",
|
|
16
|
+
/**
|
|
17
|
+
* Replace - the property should be replaced with a new value.
|
|
18
|
+
*/
|
|
19
|
+
Replace: "Replace"
|
|
16
20
|
};
|
|
17
21
|
//# sourceMappingURL=policyDecision.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"policyDecision.js","sourceRoot":"","sources":["../../../../src/models/pdp/policyDecision.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,cAAc,GAAG;IAC7B;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,MAAM,EAAE,QAAQ;
|
|
1
|
+
{"version":3,"file":"policyDecision.js","sourceRoot":"","sources":["../../../../src/models/pdp/policyDecision.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,cAAc,GAAG;IAC7B;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,OAAO,EAAE,SAAS;CACT,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The type of decision from a Policy Decision Point (PDP).\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const PolicyDecision = {\n\t/**\n\t * Granted - the property in the original data can be accessed.\n\t */\n\tGranted: \"Granted\",\n\n\t/**\n\t * Denied - the property in the original data can not be accessed.\n\t */\n\tDenied: \"Denied\",\n\n\t/**\n\t * Replace - the property should be replaced with a new value.\n\t */\n\tReplace: \"Replace\"\n} as const;\n\n/**\n * The type of decision from a Policy Decision Point (PDP).\n */\nexport type PolicyDecision = (typeof PolicyDecision)[keyof typeof PolicyDecision];\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 {
|
|
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"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPolicyEnforcementProcessor.js","sourceRoot":"","sources":["../../../../src/models/pep/IPolicyEnforcementProcessor.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type {
|
|
1
|
+
{"version":3,"file":"IPolicyEnforcementProcessor.js","sourceRoot":"","sources":["../../../../src/models/pep/IPolicyEnforcementProcessor.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 \"../pdp/IPolicyDecision.js\";\n\n/**\n * Interface for policy enforcement processors.\n */\nexport interface IPolicyEnforcementProcessor extends IComponent {\n\t/**\n\t * Process the response from the policy decision point.\n\t * @param agreement The agreement to process.\n\t * @param decisions The decisions made by the policy decision point.\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 data after processing.\n\t */\n\tprocess<D = unknown, R = D>(\n\t\tagreement: IDataspaceProtocolAgreement,\n\t\tdecisions: IPolicyDecision[],\n\t\tdata?: D,\n\t\taction?: OdrlActionType | string\n\t): Promise<R>;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPolicyInformationPointComponent.js","sourceRoot":"","sources":["../../../../src/models/pip/IPolicyInformationPointComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type {
|
|
1
|
+
{"version":3,"file":"IPolicyInformationPointComponent.js","sourceRoot":"","sources":["../../../../src/models/pip/IPolicyInformationPointComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { OdrlActionType } from \"@twin.org/standards-w3c-odrl\";\nimport type { IRightsManagementInformation } from \"../IRightsManagementInformation.js\";\nimport type { IRightsManagementPolicy } from \"../IRightsManagementPolicy.js\";\nimport type { PolicyInformationAccessMode } from \"./policyInformationAccessMode.js\";\n\n/**\n * Interface describing a Policy Information Point (PIP) contract.\n * Provides additional information to the Policy Decision Point (PDP) when\n * it is making decisions.\n */\nexport interface IPolicyInformationPointComponent extends IComponent {\n\t/**\n\t * Retrieve additional information which is relevant in the PDP decision making.\n\t * @param policy The policy to retrieve the information for if available.\n\t * @param accessMode The access mode to use for the retrieval.\n\t * @param data The data to get any additional information for.\n\t * @param action Optional action to make a decision on, if not provided, the PIP will evaluate all actions in the policy.\n\t * @returns Returns additional information based on the data and identities.\n\t */\n\tretrieve<D = unknown>(\n\t\tpolicy: IRightsManagementPolicy | undefined,\n\t\taccessMode: PolicyInformationAccessMode,\n\t\tdata?: D,\n\t\taction?: OdrlActionType | string\n\t): Promise<IRightsManagementInformation>;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPolicyInformationSource.js","sourceRoot":"","sources":["../../../../src/models/pip/IPolicyInformationSource.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type {
|
|
1
|
+
{"version":3,"file":"IPolicyInformationSource.js","sourceRoot":"","sources":["../../../../src/models/pip/IPolicyInformationSource.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { OdrlActionType } from \"@twin.org/standards-w3c-odrl\";\nimport type { IRightsManagementInformation } from \"../IRightsManagementInformation.js\";\nimport type { IRightsManagementPolicy } from \"../IRightsManagementPolicy.js\";\nimport type { PolicyInformationAccessMode } from \"./policyInformationAccessMode.js\";\n\n/**\n * Interface for policy information sources.\n */\nexport interface IPolicyInformationSource extends IComponent {\n\t/**\n\t * Retrieve information from the sources.\n\t * @param policy The policy to retrieve information for if available.\n\t * @param accessMode The access mode to use for the retrieval.\n\t * @param data The data to process.\n\t * @param action Optional action to make a decision on, if not provided, the PIP will evaluate all actions in the policy.\n\t * @returns The objects containing relevant information or undefined if nothing relevant is found.\n\t */\n\tretrieve<D = unknown>(\n\t\tpolicy: IRightsManagementPolicy | undefined,\n\t\taccessMode: PolicyInformationAccessMode,\n\t\tdata?: D,\n\t\taction?: OdrlActionType | string\n\t): Promise<IRightsManagementInformation | undefined>;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPolicyManagementPointComponent.js","sourceRoot":"","sources":["../../../../src/models/pmp/IPolicyManagementPointComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type {
|
|
1
|
+
{"version":3,"file":"IPolicyManagementPointComponent.js","sourceRoot":"","sources":["../../../../src/models/pmp/IPolicyManagementPointComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IRightsManagementPolicy } from \"../IRightsManagementPolicy.js\";\nimport type { IPolicyLocator } from \"../pap/IPolicyLocator.js\";\n\n/**\n * Interface describing a Policy Management Point (PMP) contract.\n * Provide the policies to the Policy Decision Point (PDP) based on the data and identities.\n */\nexport interface IPolicyManagementPointComponent extends IComponent {\n\t/**\n\t * Get the policies from a PAP based on the data and identities.\n\t * @param locator Optional locator to filter by type, assigner, assignee, target, or action.\n\t * @param cursor An optional cursor to continue a previous query.\n\t * @returns Returns the policies which apply to the data and identities so that the PDP can make a decision.\n\t */\n\tretrieve(\n\t\tlocator?: IPolicyLocator,\n\t\tcursor?: string\n\t): Promise<{\n\t\tpolicies: IRightsManagementPolicy[];\n\t\tcursor?: string;\n\t}>;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IPolicyNegotiation.js","sourceRoot":"","sources":["../../../../src/models/pnp/IPolicyNegotiation.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {
|
|
1
|
+
{"version":3,"file":"IPolicyNegotiation.js","sourceRoot":"","sources":["../../../../src/models/pnp/IPolicyNegotiation.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { 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 * Organization identity.\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"]}
|