@twin.org/rights-management-plugins 0.0.3-next.9 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (150) hide show
  1. package/README.md +11 -3
  2. package/dist/es/index.js +20 -10
  3. package/dist/es/index.js.map +1 -1
  4. package/dist/es/models/IAutomationPolicyExecutionActionConfig.js +4 -0
  5. package/dist/es/models/IAutomationPolicyExecutionActionConfig.js.map +1 -0
  6. package/dist/es/models/IAutomationPolicyExecutionActionConstructorOptions.js +2 -0
  7. package/dist/es/models/IAutomationPolicyExecutionActionConstructorOptions.js.map +1 -0
  8. package/dist/es/models/{IExamplePolicyArbiterConstructorOptions.js → IDefaultPolicyArbiterConfig.js} +1 -1
  9. package/dist/es/models/IDefaultPolicyArbiterConfig.js.map +1 -0
  10. package/dist/es/models/{IExamplePolicyRequesterConstructorOptions.js → IDefaultPolicyArbiterConstructorOptions.js} +1 -1
  11. package/dist/es/models/IDefaultPolicyArbiterConstructorOptions.js.map +1 -0
  12. package/dist/es/models/{IExamplePolicyEnforcementProcessorConstructorOptions.js → IDefaultPolicyEnforcementProcessorConstructorOptions.js} +1 -1
  13. package/dist/es/models/IDefaultPolicyEnforcementProcessorConstructorOptions.js.map +1 -0
  14. package/dist/es/models/IIdentityPolicyInformationSourceConstructorOptions.js.map +1 -1
  15. package/dist/es/models/IIdentityProfilePolicyInformationSourceConstructorOptions.js +4 -0
  16. package/dist/es/models/IIdentityProfilePolicyInformationSourceConstructorOptions.js.map +1 -0
  17. package/dist/es/models/ILoggingPolicyExecutionActionConfig.js.map +1 -1
  18. package/dist/es/models/ILoggingPolicyExecutionActionConstructorOptions.js.map +1 -1
  19. package/dist/es/models/{IExampleDataAccessHandlerConstructorOptions.js → IPassThroughPolicyArbiterConstructorOptions.js} +1 -1
  20. package/dist/es/models/IPassThroughPolicyArbiterConstructorOptions.js.map +1 -0
  21. package/dist/es/models/IPassThroughPolicyEnforcementProcessorConstructorOptions.js +4 -0
  22. package/dist/es/models/IPassThroughPolicyEnforcementProcessorConstructorOptions.js.map +1 -0
  23. package/dist/es/models/IPassThroughPolicyNegotiatorConstructorOptions.js +4 -0
  24. package/dist/es/models/IPassThroughPolicyNegotiatorConstructorOptions.js.map +1 -0
  25. package/dist/es/models/IPassThroughPolicyObligationEnforcerConstructorOptions.js +4 -0
  26. package/dist/es/models/IPassThroughPolicyObligationEnforcerConstructorOptions.js.map +1 -0
  27. package/dist/es/models/{IExamplePolicyNegotiatorConstructorOptions.js → IPassThroughPolicyRequesterConstructorOptions.js} +1 -1
  28. package/dist/es/models/IPassThroughPolicyRequesterConstructorOptions.js.map +1 -0
  29. package/dist/es/models/IStaticPolicyInformationSource.js.map +1 -1
  30. package/dist/es/models/IStaticPolicyInformationSourceConstructorOptions.js.map +1 -1
  31. package/dist/es/policyArbiters/defaultPolicyArbiter.js +1790 -0
  32. package/dist/es/policyArbiters/defaultPolicyArbiter.js.map +1 -0
  33. package/dist/es/policyArbiters/passThroughPolicyArbiter.js +59 -0
  34. package/dist/es/policyArbiters/passThroughPolicyArbiter.js.map +1 -0
  35. package/dist/es/policyEnforcementProcessor/defaultPolicyEnforcementProcessor.js +147 -0
  36. package/dist/es/policyEnforcementProcessor/defaultPolicyEnforcementProcessor.js.map +1 -0
  37. package/dist/es/policyEnforcementProcessor/passThroughPolicyEnforcementProcessor.js +54 -0
  38. package/dist/es/policyEnforcementProcessor/passThroughPolicyEnforcementProcessor.js.map +1 -0
  39. package/dist/es/policyExecutionActions/automationPolicyExecutionAction.js +77 -0
  40. package/dist/es/policyExecutionActions/automationPolicyExecutionAction.js.map +1 -0
  41. package/dist/es/policyExecutionActions/loggingPolicyExecutionAction.js +22 -18
  42. package/dist/es/policyExecutionActions/loggingPolicyExecutionAction.js.map +1 -1
  43. package/dist/es/policyInformationSources/identityPolicyInformationSource.js +44 -32
  44. package/dist/es/policyInformationSources/identityPolicyInformationSource.js.map +1 -1
  45. package/dist/es/policyInformationSources/identityProfilePolicyInformationSource.js +112 -0
  46. package/dist/es/policyInformationSources/identityProfilePolicyInformationSource.js.map +1 -0
  47. package/dist/es/policyInformationSources/staticPolicyInformationSource.js +18 -16
  48. package/dist/es/policyInformationSources/staticPolicyInformationSource.js.map +1 -1
  49. package/dist/es/policyNegotiators/passThroughPolicyNegotiator.js +88 -0
  50. package/dist/es/policyNegotiators/passThroughPolicyNegotiator.js.map +1 -0
  51. package/dist/es/policyObligationEnforcers/passThroughPolicyObligationEnforcer.js +56 -0
  52. package/dist/es/policyObligationEnforcers/passThroughPolicyObligationEnforcer.js.map +1 -0
  53. package/dist/es/policyRequesters/passThroughPolicyRequester.js +103 -0
  54. package/dist/es/policyRequesters/passThroughPolicyRequester.js.map +1 -0
  55. package/dist/types/index.d.ts +20 -10
  56. package/dist/types/models/IAutomationPolicyExecutionActionConfig.d.ts +9 -0
  57. package/dist/types/models/IAutomationPolicyExecutionActionConstructorOptions.d.ts +15 -0
  58. package/dist/types/models/IDefaultPolicyArbiterConfig.d.ts +10 -0
  59. package/dist/types/models/IDefaultPolicyArbiterConstructorOptions.d.ts +19 -0
  60. package/dist/types/models/IDefaultPolicyEnforcementProcessorConstructorOptions.d.ts +9 -0
  61. package/dist/types/models/IIdentityPolicyInformationSourceConstructorOptions.d.ts +0 -1
  62. package/dist/types/models/IIdentityProfilePolicyInformationSourceConstructorOptions.d.ts +14 -0
  63. package/dist/types/models/ILoggingPolicyExecutionActionConfig.d.ts +2 -2
  64. package/dist/types/models/ILoggingPolicyExecutionActionConstructorOptions.d.ts +0 -1
  65. package/dist/types/models/IPassThroughPolicyArbiterConstructorOptions.d.ts +9 -0
  66. package/dist/types/models/IPassThroughPolicyEnforcementProcessorConstructorOptions.d.ts +9 -0
  67. package/dist/types/models/IPassThroughPolicyNegotiatorConstructorOptions.d.ts +9 -0
  68. package/dist/types/models/IPassThroughPolicyObligationEnforcerConstructorOptions.d.ts +9 -0
  69. package/dist/types/models/IPassThroughPolicyRequesterConstructorOptions.d.ts +9 -0
  70. package/dist/types/models/IStaticPolicyInformationSource.d.ts +8 -5
  71. package/dist/types/models/IStaticPolicyInformationSourceConstructorOptions.d.ts +0 -1
  72. package/dist/types/policyArbiters/defaultPolicyArbiter.d.ts +38 -0
  73. package/dist/types/policyArbiters/passThroughPolicyArbiter.d.ts +32 -0
  74. package/dist/types/policyEnforcementProcessor/defaultPolicyEnforcementProcessor.d.ts +32 -0
  75. package/dist/types/policyEnforcementProcessor/passThroughPolicyEnforcementProcessor.d.ts +32 -0
  76. package/dist/types/policyExecutionActions/automationPolicyExecutionAction.d.ts +45 -0
  77. package/dist/types/policyExecutionActions/loggingPolicyExecutionAction.d.ts +6 -18
  78. package/dist/types/policyInformationSources/identityPolicyInformationSource.d.ts +5 -6
  79. package/dist/types/policyInformationSources/identityProfilePolicyInformationSource.d.ts +31 -0
  80. package/dist/types/policyInformationSources/staticPolicyInformationSource.d.ts +5 -6
  81. package/dist/types/policyNegotiators/passThroughPolicyNegotiator.d.ts +47 -0
  82. package/dist/types/policyObligationEnforcers/passThroughPolicyObligationEnforcer.d.ts +32 -0
  83. package/dist/types/policyRequesters/passThroughPolicyRequester.d.ts +48 -0
  84. package/docs/changelog.md +1230 -10
  85. package/docs/examples.md +295 -1
  86. package/docs/reference/classes/AutomationPolicyExecutionAction.md +143 -0
  87. package/docs/reference/classes/DefaultPolicyArbiter.md +113 -0
  88. package/docs/reference/classes/DefaultPolicyEnforcementProcessor.md +107 -0
  89. package/docs/reference/classes/IdentityPolicyInformationSource.md +14 -14
  90. package/docs/reference/classes/IdentityProfilePolicyInformationSource.md +103 -0
  91. package/docs/reference/classes/LoggingPolicyExecutionAction.md +20 -20
  92. package/docs/reference/classes/PassThroughPolicyArbiter.md +103 -0
  93. package/docs/reference/classes/PassThroughPolicyEnforcementProcessor.md +107 -0
  94. package/docs/reference/classes/{ExamplePolicyNegotiator.md → PassThroughPolicyNegotiator.md} +27 -21
  95. package/docs/reference/classes/PassThroughPolicyObligationEnforcer.md +109 -0
  96. package/docs/reference/classes/{ExamplePolicyRequester.md → PassThroughPolicyRequester.md} +22 -40
  97. package/docs/reference/classes/StaticPolicyInformationSource.md +15 -15
  98. package/docs/reference/index.md +20 -10
  99. package/docs/reference/interfaces/IAutomationPolicyExecutionActionConfig.md +11 -0
  100. package/docs/reference/interfaces/IAutomationPolicyExecutionActionConstructorOptions.md +25 -0
  101. package/docs/reference/interfaces/IDefaultPolicyArbiterConfig.md +17 -0
  102. package/docs/reference/interfaces/IDefaultPolicyArbiterConstructorOptions.md +33 -0
  103. package/docs/reference/interfaces/IDefaultPolicyEnforcementProcessorConstructorOptions.md +11 -0
  104. package/docs/reference/interfaces/IIdentityPolicyInformationSourceConstructorOptions.md +4 -10
  105. package/docs/reference/interfaces/IIdentityProfilePolicyInformationSourceConstructorOptions.md +25 -0
  106. package/docs/reference/interfaces/ILoggingPolicyExecutionActionConfig.md +9 -9
  107. package/docs/reference/interfaces/ILoggingPolicyExecutionActionConstructorOptions.md +4 -10
  108. package/docs/reference/interfaces/IPassThroughPolicyArbiterConstructorOptions.md +11 -0
  109. package/docs/reference/interfaces/IPassThroughPolicyEnforcementProcessorConstructorOptions.md +11 -0
  110. package/docs/reference/interfaces/IPassThroughPolicyNegotiatorConstructorOptions.md +11 -0
  111. package/docs/reference/interfaces/IPassThroughPolicyObligationEnforcerConstructorOptions.md +11 -0
  112. package/docs/reference/interfaces/IPassThroughPolicyRequesterConstructorOptions.md +11 -0
  113. package/docs/reference/interfaces/IStaticPolicyInformationSource.md +21 -6
  114. package/docs/reference/interfaces/IStaticPolicyInformationSourceConfig.md +2 -2
  115. package/docs/reference/interfaces/IStaticPolicyInformationSourceConstructorOptions.md +4 -10
  116. package/locales/en.json +65 -6
  117. package/package.json +14 -11
  118. package/dist/es/dataAccessHandlers/examplePolicyRequester.js +0 -82
  119. package/dist/es/dataAccessHandlers/examplePolicyRequester.js.map +0 -1
  120. package/dist/es/models/IExampleDataAccessHandlerConstructorOptions.js.map +0 -1
  121. package/dist/es/models/IExamplePolicyArbiterConstructorOptions.js.map +0 -1
  122. package/dist/es/models/IExamplePolicyEnforcementProcessorConstructorOptions.js.map +0 -1
  123. package/dist/es/models/IExamplePolicyNegotiatorConstructorOptions.js.map +0 -1
  124. package/dist/es/models/IExamplePolicyRequesterConstructorOptions.js.map +0 -1
  125. package/dist/es/policyArbiters/examplePolicyArbiter.js +0 -50
  126. package/dist/es/policyArbiters/examplePolicyArbiter.js.map +0 -1
  127. package/dist/es/policyEnforcementProcessor/examplePolicyEnforcementProcessor.js +0 -42
  128. package/dist/es/policyEnforcementProcessor/examplePolicyEnforcementProcessor.js.map +0 -1
  129. package/dist/es/policyNegotiators/examplePolicyNegotiator.js +0 -61
  130. package/dist/es/policyNegotiators/examplePolicyNegotiator.js.map +0 -1
  131. package/dist/es/policyRequesters/examplePolicyRequester.js +0 -69
  132. package/dist/es/policyRequesters/examplePolicyRequester.js.map +0 -1
  133. package/dist/types/dataAccessHandlers/examplePolicyRequester.d.ts +0 -68
  134. package/dist/types/models/IExampleDataAccessHandlerConstructorOptions.d.ts +0 -10
  135. package/dist/types/models/IExamplePolicyArbiterConstructorOptions.d.ts +0 -10
  136. package/dist/types/models/IExamplePolicyEnforcementProcessorConstructorOptions.d.ts +0 -10
  137. package/dist/types/models/IExamplePolicyNegotiatorConstructorOptions.d.ts +0 -10
  138. package/dist/types/models/IExamplePolicyRequesterConstructorOptions.d.ts +0 -10
  139. package/dist/types/policyArbiters/examplePolicyArbiter.d.ts +0 -36
  140. package/dist/types/policyEnforcementProcessor/examplePolicyEnforcementProcessor.d.ts +0 -29
  141. package/dist/types/policyNegotiators/examplePolicyNegotiator.d.ts +0 -45
  142. package/dist/types/policyRequesters/examplePolicyRequester.d.ts +0 -53
  143. package/docs/reference/classes/ExampleDataAccessHandler.md +0 -243
  144. package/docs/reference/classes/ExamplePolicyArbiter.md +0 -121
  145. package/docs/reference/classes/ExamplePolicyEnforcementProcessor.md +0 -101
  146. package/docs/reference/interfaces/IExampleDataAccessHandlerConstructorOptions.md +0 -17
  147. package/docs/reference/interfaces/IExamplePolicyArbiterConstructorOptions.md +0 -17
  148. package/docs/reference/interfaces/IExamplePolicyEnforcementProcessorConstructorOptions.md +0 -17
  149. package/docs/reference/interfaces/IExamplePolicyNegotiatorConstructorOptions.md +0 -17
  150. package/docs/reference/interfaces/IExamplePolicyRequesterConstructorOptions.md +0 -17
@@ -1,101 +0,0 @@
1
- # Class: ExamplePolicyEnforcementProcessor
2
-
3
- Example Policy Enforcement Processor.
4
-
5
- ## Implements
6
-
7
- - `IPolicyEnforcementProcessor`
8
-
9
- ## Constructors
10
-
11
- ### Constructor
12
-
13
- > **new ExamplePolicyEnforcementProcessor**(`options?`): `ExamplePolicyEnforcementProcessor`
14
-
15
- Create a new instance of ExamplePolicyEnforcementProcessor.
16
-
17
- #### Parameters
18
-
19
- ##### options?
20
-
21
- [`IExamplePolicyEnforcementProcessorConstructorOptions`](../interfaces/IExamplePolicyEnforcementProcessorConstructorOptions.md)
22
-
23
- The options for the example policy enforcement processor.
24
-
25
- #### Returns
26
-
27
- `ExamplePolicyEnforcementProcessor`
28
-
29
- ## Properties
30
-
31
- ### CLASS\_NAME
32
-
33
- > `readonly` `static` **CLASS\_NAME**: `string`
34
-
35
- The class name of the Example Policy Enforcement Processor.
36
-
37
- ## Methods
38
-
39
- ### className()
40
-
41
- > **className**(): `string`
42
-
43
- Returns the class name of the component.
44
-
45
- #### Returns
46
-
47
- `string`
48
-
49
- The class name of the component.
50
-
51
- #### Implementation of
52
-
53
- `IPolicyEnforcementProcessor.className`
54
-
55
- ***
56
-
57
- ### process()
58
-
59
- > **process**\<`D`, `R`\>(`locator`, `decisions`, `data?`): `Promise`\<`R`\>
60
-
61
- Process the response from the policy decision point.
62
-
63
- #### Type Parameters
64
-
65
- ##### D
66
-
67
- `D` = `unknown`
68
-
69
- ##### R
70
-
71
- `R` = `D`
72
-
73
- #### Parameters
74
-
75
- ##### locator
76
-
77
- `IPolicyLocator`
78
-
79
- The locator to find relevant policies.
80
-
81
- ##### decisions
82
-
83
- `IPolicyDecision`[]
84
-
85
- The decisions made by the policy decision point.
86
-
87
- ##### data?
88
-
89
- `D`
90
-
91
- The data to process.
92
-
93
- #### Returns
94
-
95
- `Promise`\<`R`\>
96
-
97
- The data after processing.
98
-
99
- #### Implementation of
100
-
101
- `IPolicyEnforcementProcessor.process`
@@ -1,17 +0,0 @@
1
- # Interface: IExampleDataAccessHandlerConstructorOptions
2
-
3
- Options for the Example Data Access Handler.
4
-
5
- ## Properties
6
-
7
- ### loggingComponentType?
8
-
9
- > `optional` **loggingComponentType**: `string`
10
-
11
- The logging component for data access handler.
12
-
13
- #### Default
14
-
15
- ```ts
16
- logging
17
- ```
@@ -1,17 +0,0 @@
1
- # Interface: IExamplePolicyArbiterConstructorOptions
2
-
3
- Options for the Example Policy Arbiter.
4
-
5
- ## Properties
6
-
7
- ### loggingComponentType?
8
-
9
- > `optional` **loggingComponentType**: `string`
10
-
11
- The logging component for policy arbiter.
12
-
13
- #### Default
14
-
15
- ```ts
16
- logging
17
- ```
@@ -1,17 +0,0 @@
1
- # Interface: IExamplePolicyEnforcementProcessorConstructorOptions
2
-
3
- Options for the Example Policy Enforcement Processor.
4
-
5
- ## Properties
6
-
7
- ### loggingComponentType?
8
-
9
- > `optional` **loggingComponentType**: `string`
10
-
11
- The logging component for policy enforcement processor.
12
-
13
- #### Default
14
-
15
- ```ts
16
- logging
17
- ```
@@ -1,17 +0,0 @@
1
- # Interface: IExamplePolicyNegotiatorConstructorOptions
2
-
3
- Options for the Example Policy Negotiator.
4
-
5
- ## Properties
6
-
7
- ### loggingComponentType?
8
-
9
- > `optional` **loggingComponentType**: `string`
10
-
11
- The logging component for policy negotiator.
12
-
13
- #### Default
14
-
15
- ```ts
16
- logging
17
- ```
@@ -1,17 +0,0 @@
1
- # Interface: IExamplePolicyRequesterConstructorOptions
2
-
3
- Options for the Example Policy Requester.
4
-
5
- ## Properties
6
-
7
- ### loggingComponentType?
8
-
9
- > `optional` **loggingComponentType**: `string`
10
-
11
- The logging component for policy requester.
12
-
13
- #### Default
14
-
15
- ```ts
16
- logging
17
- ```