@sudoplatform/sudo-privacy-interaction 2.0.0 → 2.2.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 (168) hide show
  1. package/cjs/gen/graphqlTypes.js +2291 -780
  2. package/cjs/private/data/action/actionSubscriptionManager.js +25 -0
  3. package/cjs/private/data/action/defaultActionService.js +80 -0
  4. package/cjs/private/data/action/transformer/actionFulfilmentMethodTransformer.js +47 -0
  5. package/cjs/private/data/action/transformer/actionIntentTransformer.js +69 -0
  6. package/cjs/private/data/action/transformer/actionOriginTransformer.js +37 -0
  7. package/cjs/private/data/action/transformer/actionStatusTransformer.js +53 -0
  8. package/cjs/private/data/action/transformer/actionTransformer.js +85 -0
  9. package/cjs/private/data/action/transformer/availableActionTransformer.js +37 -0
  10. package/cjs/private/data/analysis-result/transformer/privacyScoreTransformer.js +8 -0
  11. package/cjs/private/data/common/apiClient.js +58 -0
  12. package/cjs/private/data/data-holder/defaultDataHolderService.js +12 -0
  13. package/cjs/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.js +56 -0
  14. package/cjs/private/data/organization-analysis/defaultOrganizationAnalysisService.js +31 -0
  15. package/cjs/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.js +29 -0
  16. package/cjs/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +45 -0
  17. package/cjs/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +2 -0
  18. package/cjs/private/domain/entities/action/actionEntity.js +86 -0
  19. package/cjs/private/domain/entities/action/actionService.js +7 -0
  20. package/cjs/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +24 -0
  21. package/cjs/private/domain/entities/organization-analysis/organizationAnalysisService.js +7 -0
  22. package/cjs/private/domain/use-cases/action/confirmActionOutcomeUseCase.js +25 -0
  23. package/cjs/private/domain/use-cases/action/initiateActionUseCase.js +26 -0
  24. package/cjs/private/domain/use-cases/action/listAvailableActionsUseCase.js +26 -0
  25. package/cjs/private/domain/use-cases/action/subscribeToActionUseCase.js +37 -0
  26. package/cjs/private/domain/use-cases/action/unsubscribeFromActionUseCase.js +27 -0
  27. package/cjs/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.js +29 -0
  28. package/cjs/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.js +25 -0
  29. package/cjs/public/defaultSudoPrivacyInteractionClient.js +133 -6
  30. package/cjs/public/inputs/action.js +7 -0
  31. package/cjs/public/inputs/index.js +2 -0
  32. package/cjs/public/inputs/organizationAnalysis.js +7 -0
  33. package/cjs/public/typings/action.js +85 -0
  34. package/cjs/public/typings/index.js +2 -0
  35. package/cjs/public/typings/organizationAnalysis.js +24 -0
  36. package/docs/assets/hierarchy.js +1 -1
  37. package/docs/assets/navigation.js +1 -1
  38. package/docs/assets/search.js +1 -1
  39. package/docs/classes/DefaultSudoPrivacyInteractionClient.html +176 -21
  40. package/docs/enums/ActionFulfilmentMethod.html +63 -0
  41. package/docs/enums/ActionIntent.html +84 -0
  42. package/docs/enums/ActionOrigin.html +75 -0
  43. package/docs/enums/ActionStatus.html +99 -0
  44. package/docs/enums/ConnectionState.html +3 -3
  45. package/docs/enums/DataCategory.html +18 -18
  46. package/docs/enums/DataHolderProtectionState.html +5 -5
  47. package/docs/enums/OrganizationAnalysisMode.html +70 -0
  48. package/docs/enums/OrganizationCategory.html +30 -30
  49. package/docs/enums/ProviderType.html +3 -3
  50. package/docs/enums/RetentionStyle.html +5 -5
  51. package/docs/enums/ShareStyle.html +6 -6
  52. package/docs/enums/SignalValue.html +4 -4
  53. package/docs/enums/VirtualPresenceState.html +7 -7
  54. package/docs/hierarchy.html +6 -5
  55. package/docs/interfaces/Action.html +167 -0
  56. package/docs/interfaces/ActionContact.html +77 -0
  57. package/docs/interfaces/ActionSubscriber.html +92 -0
  58. package/docs/interfaces/AnalysisResultSubscriber.html +3 -3
  59. package/docs/interfaces/AssistedEmailTemplate.html +70 -0
  60. package/docs/interfaces/AssistedPayload.html +113 -0
  61. package/docs/interfaces/AvailableAction.html +102 -0
  62. package/docs/interfaces/CapabilitySignals.html +9 -9
  63. package/docs/interfaces/CategorySignals.html +11 -11
  64. package/docs/interfaces/DataHolder.html +24 -14
  65. package/docs/interfaces/DataHolderScanSummary.html +158 -0
  66. package/docs/interfaces/DataHolderSubscriber.html +3 -3
  67. package/docs/interfaces/GetDataHolderOptions.html +63 -0
  68. package/docs/interfaces/GetOrganizationAnalysisInput.html +70 -0
  69. package/docs/interfaces/InitiateActionInput.html +79 -0
  70. package/docs/interfaces/ListAnalysisResultsInput.html +1 -1
  71. package/docs/interfaces/ListAvailableActionsInput.html +61 -0
  72. package/docs/interfaces/ListDataHolderScanSummariesInput.html +85 -0
  73. package/docs/interfaces/ListDataHoldersInput.html +1 -1
  74. package/docs/interfaces/ListVirtualPresencesInput.html +1 -1
  75. package/docs/interfaces/OrganizationAnalysis.html +131 -0
  76. package/docs/interfaces/OrganizationIdentity.html +5 -5
  77. package/docs/interfaces/Pagination.html +2 -1
  78. package/docs/interfaces/PrivacyScore.html +13 -5
  79. package/docs/interfaces/PrivacySummary.html +4 -4
  80. package/docs/interfaces/RetentionInfo.html +4 -4
  81. package/docs/interfaces/RiskIndicators.html +8 -8
  82. package/docs/interfaces/ScoreContribution.html +3 -3
  83. package/docs/interfaces/ScoreCoverage.html +70 -0
  84. package/docs/interfaces/SudoPrivacyInteractionClient.html +169 -21
  85. package/docs/interfaces/VirtualPresence.html +21 -12
  86. package/docs/interfaces/VirtualPresenceSubscriber.html +3 -3
  87. package/docs/modules.html +4 -4
  88. package/docs/types/SudoPrivacyInteractionClientOptions.html +2 -2
  89. package/lib/gen/graphqlTypes.js +2290 -779
  90. package/lib/private/data/action/actionSubscriptionManager.js +21 -0
  91. package/lib/private/data/action/defaultActionService.js +76 -0
  92. package/lib/private/data/action/transformer/actionFulfilmentMethodTransformer.js +43 -0
  93. package/lib/private/data/action/transformer/actionIntentTransformer.js +65 -0
  94. package/lib/private/data/action/transformer/actionOriginTransformer.js +33 -0
  95. package/lib/private/data/action/transformer/actionStatusTransformer.js +49 -0
  96. package/lib/private/data/action/transformer/actionTransformer.js +81 -0
  97. package/lib/private/data/action/transformer/availableActionTransformer.js +33 -0
  98. package/lib/private/data/analysis-result/transformer/privacyScoreTransformer.js +8 -0
  99. package/lib/private/data/common/apiClient.js +59 -1
  100. package/lib/private/data/data-holder/defaultDataHolderService.js +12 -0
  101. package/lib/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.js +52 -0
  102. package/lib/private/data/organization-analysis/defaultOrganizationAnalysisService.js +27 -0
  103. package/lib/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.js +25 -0
  104. package/lib/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +41 -0
  105. package/lib/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +2 -0
  106. package/lib/private/domain/entities/action/actionEntity.js +83 -0
  107. package/lib/private/domain/entities/action/actionService.js +6 -0
  108. package/lib/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +21 -0
  109. package/lib/private/domain/entities/organization-analysis/organizationAnalysisService.js +6 -0
  110. package/lib/private/domain/use-cases/action/confirmActionOutcomeUseCase.js +21 -0
  111. package/lib/private/domain/use-cases/action/initiateActionUseCase.js +22 -0
  112. package/lib/private/domain/use-cases/action/listAvailableActionsUseCase.js +22 -0
  113. package/lib/private/domain/use-cases/action/subscribeToActionUseCase.js +33 -0
  114. package/lib/private/domain/use-cases/action/unsubscribeFromActionUseCase.js +23 -0
  115. package/lib/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.js +25 -0
  116. package/lib/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.js +21 -0
  117. package/lib/public/defaultSudoPrivacyInteractionClient.js +133 -6
  118. package/lib/public/inputs/action.js +6 -0
  119. package/lib/public/inputs/index.js +2 -0
  120. package/lib/public/inputs/organizationAnalysis.js +6 -0
  121. package/lib/public/typings/action.js +82 -0
  122. package/lib/public/typings/index.js +2 -0
  123. package/lib/public/typings/organizationAnalysis.js +21 -0
  124. package/package.json +5 -3
  125. package/types/gen/graphqlTypes.d.ts +569 -1
  126. package/types/private/data/action/actionSubscriptionManager.d.ts +19 -0
  127. package/types/private/data/action/defaultActionService.d.ts +23 -0
  128. package/types/private/data/action/transformer/actionFulfilmentMethodTransformer.d.ts +14 -0
  129. package/types/private/data/action/transformer/actionIntentTransformer.d.ts +14 -0
  130. package/types/private/data/action/transformer/actionOriginTransformer.d.ts +12 -0
  131. package/types/private/data/action/transformer/actionStatusTransformer.d.ts +12 -0
  132. package/types/private/data/action/transformer/actionTransformer.d.ts +39 -0
  133. package/types/private/data/action/transformer/availableActionTransformer.d.ts +15 -0
  134. package/types/private/data/common/apiClient.d.ts +16 -1
  135. package/types/private/data/common/baseSubscriptionManager.d.ts +5 -0
  136. package/types/private/data/data-holder/defaultDataHolderService.d.ts +3 -1
  137. package/types/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.d.ts +18 -0
  138. package/types/private/data/organization-analysis/defaultOrganizationAnalysisService.d.ts +15 -0
  139. package/types/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.d.ts +12 -0
  140. package/types/private/data/organization-analysis/transformer/organizationAnalysisTransformer.d.ts +14 -0
  141. package/types/private/domain/entities/action/actionEntity.d.ts +187 -0
  142. package/types/private/domain/entities/action/actionService.d.ts +99 -0
  143. package/types/private/domain/entities/analysis-result/analysisResultEntity.d.ts +14 -0
  144. package/types/private/domain/entities/data-holder/dataHolderEntity.d.ts +34 -0
  145. package/types/private/domain/entities/data-holder/dataHolderService.d.ts +35 -1
  146. package/types/private/domain/entities/organization-analysis/organizationAnalysisEntity.d.ts +53 -0
  147. package/types/private/domain/entities/organization-analysis/organizationAnalysisService.d.ts +35 -0
  148. package/types/private/domain/entities/virtual-presence/virtualPresenceEntity.d.ts +3 -0
  149. package/types/private/domain/use-cases/action/confirmActionOutcomeUseCase.d.ts +16 -0
  150. package/types/private/domain/use-cases/action/initiateActionUseCase.d.ts +17 -0
  151. package/types/private/domain/use-cases/action/listAvailableActionsUseCase.d.ts +16 -0
  152. package/types/private/domain/use-cases/action/subscribeToActionUseCase.d.ts +27 -0
  153. package/types/private/domain/use-cases/action/unsubscribeFromActionUseCase.d.ts +15 -0
  154. package/types/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.d.ts +36 -0
  155. package/types/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.d.ts +16 -0
  156. package/types/public/defaultSudoPrivacyInteractionClient.d.ts +19 -3
  157. package/types/public/inputs/action.d.ts +30 -0
  158. package/types/public/inputs/dataHolder.d.ts +22 -0
  159. package/types/public/inputs/index.d.ts +2 -0
  160. package/types/public/inputs/organizationAnalysis.d.ts +18 -0
  161. package/types/public/sudoPrivacyInteractionClient.d.ts +64 -3
  162. package/types/public/typings/action.d.ts +185 -0
  163. package/types/public/typings/analysisResult.d.ts +14 -0
  164. package/types/public/typings/dataHolder.d.ts +38 -0
  165. package/types/public/typings/index.d.ts +2 -0
  166. package/types/public/typings/organizationAnalysis.d.ts +53 -0
  167. package/types/public/typings/subscription.d.ts +23 -0
  168. package/types/public/typings/virtualPresence.d.ts +3 -0
@@ -0,0 +1,41 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { AnalysisResultDataTransformer } from '../../analysis-result/transformer/analysisResultDataTransformer';
7
+ import { AnalysisResultStatusTransformer } from '../../analysis-result/transformer/analysisResultStatusTransformer';
8
+ export class OrganizationAnalysisTransformer {
9
+ statusTransformer = new AnalysisResultStatusTransformer();
10
+ dataTransformer = new AnalysisResultDataTransformer();
11
+ fromGraphQLToEntity(data) {
12
+ return {
13
+ id: data.id,
14
+ domain: data.domain,
15
+ status: this.statusTransformer.fromGraphQLToEntity(data.status),
16
+ lastAnalyzedAt: new Date(data.lastAnalyzedAtEpochMs),
17
+ data: data.data
18
+ ? this.dataTransformer.fromGraphQLToEntity(data.data)
19
+ : undefined,
20
+ owner: data.owner,
21
+ version: data.version,
22
+ createdAt: new Date(data.createdAtEpochMs),
23
+ updatedAt: new Date(data.updatedAtEpochMs),
24
+ };
25
+ }
26
+ fromEntityToAPI(entity) {
27
+ return {
28
+ id: entity.id,
29
+ domain: entity.domain,
30
+ status: this.statusTransformer.fromEntityToAPI(entity.status),
31
+ lastAnalyzedAt: entity.lastAnalyzedAt,
32
+ data: entity.data
33
+ ? this.dataTransformer.fromEntityToAPI(entity.data)
34
+ : undefined,
35
+ owner: entity.owner,
36
+ version: entity.version,
37
+ createdAt: entity.createdAt,
38
+ updatedAt: entity.updatedAt,
39
+ };
40
+ }
41
+ }
@@ -17,6 +17,7 @@ export class VirtualPresenceTransformer {
17
17
  identifier: entity.identifier,
18
18
  state: virtualPresenceStateTransformer.fromEntityToAPI(entity.state),
19
19
  lastScannedAt: entity.lastScannedAt,
20
+ lastScanFailureReason: entity.lastScanFailureReason,
20
21
  createdAt: entity.createdAt,
21
22
  updatedAt: entity.updatedAt,
22
23
  };
@@ -32,6 +33,7 @@ export class VirtualPresenceTransformer {
32
33
  identifier: data.identifier,
33
34
  state: virtualPresenceStateTransformer.fromGraphQLToEntity(data.state),
34
35
  lastScannedAt: new Date(data.lastScannedAtEpochMs),
36
+ lastScanFailureReason: data.lastScanFailureReason ?? undefined,
35
37
  createdAt: new Date(data.createdAtEpochMs),
36
38
  updatedAt: new Date(data.updatedAtEpochMs),
37
39
  };
@@ -0,0 +1,83 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ /**
7
+ * The user-facing intent of an action. This is a service-owned taxonomy,
8
+ * decoupled from any upstream provider's action vocabulary.
9
+ *
10
+ * Clients must tolerate unknown values: an unrecognised intent is represented
11
+ * as `Other` rather than failing, so newly added intents do not break existing
12
+ * clients.
13
+ *
14
+ * @property StopContact Unsubscribe / opt out of marketing communications.
15
+ * @property AccessMyData Data subject access / portability request.
16
+ * @property DeleteMyData Account deletion / data erasure.
17
+ * @property LimitDataUse Opt out of sale / tracking, manage consent.
18
+ * @property Other Anything unmapped; carries additionalInfo.
19
+ *
20
+ * @enum
21
+ */
22
+ export var ActionIntentEntity;
23
+ (function (ActionIntentEntity) {
24
+ ActionIntentEntity["StopContact"] = "STOP_CONTACT";
25
+ ActionIntentEntity["AccessMyData"] = "ACCESS_MY_DATA";
26
+ ActionIntentEntity["DeleteMyData"] = "DELETE_MY_DATA";
27
+ ActionIntentEntity["LimitDataUse"] = "LIMIT_DATA_USE";
28
+ ActionIntentEntity["Other"] = "OTHER";
29
+ })(ActionIntentEntity || (ActionIntentEntity = {}));
30
+ /**
31
+ * How an action is fulfilled from the user's perspective.
32
+ *
33
+ * @property Assisted The service returns structured materials for the client to
34
+ * complete the action.
35
+ * @property Delegated The service performs the action on the user's behalf.
36
+ *
37
+ * @enum
38
+ */
39
+ export var ActionFulfilmentMethodEntity;
40
+ (function (ActionFulfilmentMethodEntity) {
41
+ ActionFulfilmentMethodEntity["Assisted"] = "ASSISTED";
42
+ ActionFulfilmentMethodEntity["Delegated"] = "DELEGATED";
43
+ })(ActionFulfilmentMethodEntity || (ActionFulfilmentMethodEntity = {}));
44
+ /**
45
+ * Which source contributed an available action.
46
+ *
47
+ * @property Static Always-possible action for the virtual presence type.
48
+ * @property Analysis Derived from an analysis source's reported actions.
49
+ * @property Discovery Derived from a discovery scan (e.g. List-Unsubscribe).
50
+ *
51
+ * @enum
52
+ */
53
+ export var ActionOriginEntity;
54
+ (function (ActionOriginEntity) {
55
+ ActionOriginEntity["Static"] = "STATIC";
56
+ ActionOriginEntity["Analysis"] = "ANALYSIS";
57
+ ActionOriginEntity["Discovery"] = "DISCOVERY";
58
+ ActionOriginEntity["Unknown"] = "UNKNOWN";
59
+ })(ActionOriginEntity || (ActionOriginEntity = {}));
60
+ /**
61
+ * Lifecycle status of a persisted action instance.
62
+ *
63
+ * @property Pending The action has been created but not yet started.
64
+ * @property InProgress The action is being performed.
65
+ * @property CompletedUnverified The action completed but has not been verified.
66
+ * @property CompletedVerified The action completed and has been verified.
67
+ * @property Failed The action failed to complete.
68
+ * @property RequiresUserInput The action requires further input from the user.
69
+ * @property Contradicted Subsequent evidence contradicts the action's completion.
70
+ *
71
+ * @enum
72
+ */
73
+ export var ActionStatusEntity;
74
+ (function (ActionStatusEntity) {
75
+ ActionStatusEntity["Pending"] = "PENDING";
76
+ ActionStatusEntity["InProgress"] = "IN_PROGRESS";
77
+ ActionStatusEntity["CompletedUnverified"] = "COMPLETED_UNVERIFIED";
78
+ ActionStatusEntity["CompletedVerified"] = "COMPLETED_VERIFIED";
79
+ ActionStatusEntity["Failed"] = "FAILED";
80
+ ActionStatusEntity["RequiresUserInput"] = "REQUIRES_USER_INPUT";
81
+ ActionStatusEntity["Contradicted"] = "CONTRADICTED";
82
+ ActionStatusEntity["Unknown"] = "UNKNOWN";
83
+ })(ActionStatusEntity || (ActionStatusEntity = {}));
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ export {};
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ /**
7
+ * Controls how `getOrganizationAnalysis` obtains source results when the stored
8
+ * analysis is stale or absent.
9
+ *
10
+ * @property ANALYZE Read-through: request analysis from the sources, which may compute and
11
+ * leave the result PENDING until asynchronous work completes.
12
+ * @property FETCH Pull only the sources' existing values; never request new work. A stale
13
+ * domain with no existing source value is not moved to PENDING.
14
+ *
15
+ * @enum
16
+ */
17
+ export var OrganizationAnalysisModeEntity;
18
+ (function (OrganizationAnalysisModeEntity) {
19
+ OrganizationAnalysisModeEntity["Analyze"] = "ANALYZE";
20
+ OrganizationAnalysisModeEntity["Fetch"] = "FETCH";
21
+ })(OrganizationAnalysisModeEntity || (OrganizationAnalysisModeEntity = {}));
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ export {};
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { DefaultLogger } from '@sudoplatform/sudo-common';
7
+ /**
8
+ * Application business logic for confirming that an action was completed.
9
+ */
10
+ export class ConfirmActionOutcomeUseCase {
11
+ actionService;
12
+ log;
13
+ constructor(actionService) {
14
+ this.actionService = actionService;
15
+ this.log = new DefaultLogger(this.constructor.name);
16
+ }
17
+ async execute(id) {
18
+ this.log.debug(this.constructor.name, { id });
19
+ return await this.actionService.confirmOutcome(id);
20
+ }
21
+ }
@@ -0,0 +1,22 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { DefaultLogger } from '@sudoplatform/sudo-common';
7
+ /**
8
+ * Application business logic for initiating an action against a data holder
9
+ * relationship.
10
+ */
11
+ export class InitiateActionUseCase {
12
+ actionService;
13
+ log;
14
+ constructor(actionService) {
15
+ this.actionService = actionService;
16
+ this.log = new DefaultLogger(this.constructor.name);
17
+ }
18
+ async execute(input) {
19
+ this.log.debug(this.constructor.name, { input });
20
+ return await this.actionService.initiate(input);
21
+ }
22
+ }
@@ -0,0 +1,22 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { DefaultLogger } from '@sudoplatform/sudo-common';
7
+ /**
8
+ * Application business logic for listing the actions available for a data holder
9
+ * relationship.
10
+ */
11
+ export class ListAvailableActionsUseCase {
12
+ actionService;
13
+ log;
14
+ constructor(actionService) {
15
+ this.actionService = actionService;
16
+ this.log = new DefaultLogger(this.constructor.name);
17
+ }
18
+ async execute(input) {
19
+ this.log.debug(this.constructor.name, { input });
20
+ return await this.actionService.listAvailable(input);
21
+ }
22
+ }
@@ -0,0 +1,33 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { DefaultLogger, NotSignedInError, } from '@sudoplatform/sudo-common';
7
+ /**
8
+ * Application business logic for subscribing to action status events.
9
+ */
10
+ export class SubscribeToActionUseCase {
11
+ actionService;
12
+ sudoUserClient;
13
+ log;
14
+ constructor(actionService, sudoUserClient) {
15
+ this.actionService = actionService;
16
+ this.sudoUserClient = sudoUserClient;
17
+ this.log = new DefaultLogger(this.constructor.name);
18
+ }
19
+ async execute(input) {
20
+ this.log.debug(this.constructor.name, {
21
+ subscriptionId: input.subscriptionId,
22
+ });
23
+ const owner = await this.sudoUserClient.getSubject();
24
+ if (!owner) {
25
+ throw new NotSignedInError();
26
+ }
27
+ await this.actionService.subscribe({
28
+ subscriptionId: input.subscriptionId,
29
+ owner,
30
+ subscriber: input.subscriber,
31
+ });
32
+ }
33
+ }
@@ -0,0 +1,23 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { DefaultLogger } from '@sudoplatform/sudo-common';
7
+ /**
8
+ * Application business logic for unsubscribing from action status events.
9
+ */
10
+ export class UnsubscribeFromActionUseCase {
11
+ actionService;
12
+ log;
13
+ constructor(actionService) {
14
+ this.actionService = actionService;
15
+ this.log = new DefaultLogger(this.constructor.name);
16
+ }
17
+ execute(subscriptionId) {
18
+ this.log.debug(this.constructor.name, {
19
+ subscriptionId,
20
+ });
21
+ this.actionService.unsubscribe(subscriptionId);
22
+ }
23
+ }
@@ -0,0 +1,25 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { DefaultLogger } from '@sudoplatform/sudo-common';
7
+ /**
8
+ * Application business logic for listing scan summaries for a data holder.
9
+ */
10
+ export class ListDataHolderScanSummariesUseCase {
11
+ dataHolderService;
12
+ log;
13
+ constructor(dataHolderService) {
14
+ this.dataHolderService = dataHolderService;
15
+ this.log = new DefaultLogger(this.constructor.name);
16
+ }
17
+ async execute(input) {
18
+ this.log.debug(this.constructor.name, { input });
19
+ return await this.dataHolderService.listScanSummaries({
20
+ dataHolderId: input.dataHolderId,
21
+ limit: input.limit,
22
+ nextToken: input.nextToken,
23
+ });
24
+ }
25
+ }
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { DefaultLogger } from '@sudoplatform/sudo-common';
7
+ /**
8
+ * Application business logic for obtaining an organization analysis.
9
+ */
10
+ export class GetOrganizationAnalysisUseCase {
11
+ organizationAnalysisService;
12
+ log;
13
+ constructor(organizationAnalysisService) {
14
+ this.organizationAnalysisService = organizationAnalysisService;
15
+ this.log = new DefaultLogger(this.constructor.name);
16
+ }
17
+ async execute(input) {
18
+ this.log.debug(this.constructor.name, { input });
19
+ return await this.organizationAnalysisService.getOrganizationAnalysis(input);
20
+ }
21
+ }
@@ -4,22 +4,38 @@
4
4
  * SPDX-License-Identifier: Apache-2.0
5
5
  */
6
6
  import { DefaultLogger } from '@sudoplatform/sudo-common';
7
+ import { DefaultActionService } from '../private/data/action/defaultActionService';
8
+ import { ActionTransformer } from '../private/data/action/transformer/actionTransformer';
9
+ import { ActionFulfilmentMethodTransformer } from '../private/data/action/transformer/actionFulfilmentMethodTransformer';
10
+ import { ActionIntentTransformer } from '../private/data/action/transformer/actionIntentTransformer';
11
+ import { AvailableActionTransformer } from '../private/data/action/transformer/availableActionTransformer';
7
12
  import { DefaultAnalysisResultService } from '../private/data/analysis-result/defaultAnalysisResultService';
8
13
  import { AnalysisResultTransformer } from '../private/data/analysis-result/transformer/analysisResultTransformer';
9
14
  import { ApiClient } from '../private/data/common/apiClient';
10
15
  import { DefaultDataHolderService } from '../private/data/data-holder/defaultDataHolderService';
16
+ import { DataHolderScanSummaryTransformer } from '../private/data/data-holder/transformer/dataHolderScanSummaryTransformer';
11
17
  import { DataHolderTransformer } from '../private/data/data-holder/transformer/dataHolderTransformer';
12
18
  import { DefaultProviderConfigurationService } from '../private/data/provider-configuration/defaultProviderConfigurationService';
13
19
  import { ProviderConfigurationTransformer } from '../private/data/provider-configuration/transformer/providerConfigurationTransformer';
20
+ import { DefaultOrganizationAnalysisService } from '../private/data/organization-analysis/defaultOrganizationAnalysisService';
21
+ import { OrganizationAnalysisModeTransformer } from '../private/data/organization-analysis/transformer/organizationAnalysisModeTransformer';
22
+ import { OrganizationAnalysisTransformer } from '../private/data/organization-analysis/transformer/organizationAnalysisTransformer';
14
23
  import { DefaultVirtualPresenceService } from '../private/data/virtual-presence/defaultVirtualPresenceService';
15
24
  import { RelationshipProviderTransformer } from '../private/data/virtual-presence/transformer/relationshipProviderTransformer';
16
25
  import { VirtualPresenceTransformer } from '../private/data/virtual-presence/transformer/virtualPresenceTransformer';
17
26
  import { GetAnalysisResultUseCase } from '../private/domain/use-cases/analysis-result/getAnalysisResultUseCase';
27
+ import { ConfirmActionOutcomeUseCase } from '../private/domain/use-cases/action/confirmActionOutcomeUseCase';
28
+ import { InitiateActionUseCase } from '../private/domain/use-cases/action/initiateActionUseCase';
29
+ import { ListAvailableActionsUseCase } from '../private/domain/use-cases/action/listAvailableActionsUseCase';
30
+ import { SubscribeToActionUseCase } from '../private/domain/use-cases/action/subscribeToActionUseCase';
31
+ import { UnsubscribeFromActionUseCase } from '../private/domain/use-cases/action/unsubscribeFromActionUseCase';
18
32
  import { ListAnalysisResultsUseCase } from '../private/domain/use-cases/analysis-result/listAnalysisResultsUseCase';
19
33
  import { SubscribeToAnalysisResultUseCase } from '../private/domain/use-cases/analysis-result/subscribeToAnalysisResultUseCase';
20
34
  import { UnsubscribeFromAnalysisResultUseCase } from '../private/domain/use-cases/analysis-result/unsubscribeFromAnalysisResultUseCase';
21
35
  import { GetProviderConfigurationUseCase } from '../private/domain/use-cases/configuration/getProviderConfigurationUseCase';
36
+ import { GetOrganizationAnalysisUseCase } from '../private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase';
22
37
  import { GetDataHolderUseCase } from '../private/domain/use-cases/data-holder/getDataHolderUseCase';
38
+ import { ListDataHolderScanSummariesUseCase } from '../private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase';
23
39
  import { ListDataHoldersUseCase } from '../private/domain/use-cases/data-holder/listDataHoldersUseCase';
24
40
  import { SubscribeToDataHoldersUseCase } from '../private/domain/use-cases/data-holder/subscribeToDataHoldersUseCase';
25
41
  import { UnsubscribeFromDataHoldersUseCase } from '../private/domain/use-cases/data-holder/unsubscribeFromDataHoldersUseCase';
@@ -37,11 +53,20 @@ export class DefaultSudoPrivacyInteractionClient {
37
53
  virtualPresenceService;
38
54
  dataHolderService;
39
55
  analysisResultService;
56
+ organizationAnalysisService;
57
+ actionService;
40
58
  providerConfigurationTransformer;
41
59
  virtualPresenceTransformer;
42
60
  relationshipProviderTransformer;
43
61
  dataHolderTransformer;
62
+ dataHolderScanSummaryTransformer;
44
63
  analysisResultTransformer;
64
+ organizationAnalysisTransformer;
65
+ organizationAnalysisModeTransformer;
66
+ actionTransformer;
67
+ availableActionTransformer;
68
+ actionIntentTransformer;
69
+ actionFulfilmentMethodTransformer;
45
70
  log;
46
71
  constructor(opts) {
47
72
  this.log = new DefaultLogger(this.constructor.name);
@@ -52,12 +77,24 @@ export class DefaultSudoPrivacyInteractionClient {
52
77
  this.virtualPresenceService = new DefaultVirtualPresenceService(this.apiClient);
53
78
  this.dataHolderService = new DefaultDataHolderService(this.apiClient);
54
79
  this.analysisResultService = new DefaultAnalysisResultService(this.apiClient);
80
+ this.organizationAnalysisService = new DefaultOrganizationAnalysisService(this.apiClient);
81
+ this.actionService = new DefaultActionService(this.apiClient);
55
82
  this.providerConfigurationTransformer =
56
83
  new ProviderConfigurationTransformer();
57
84
  this.virtualPresenceTransformer = new VirtualPresenceTransformer();
58
85
  this.relationshipProviderTransformer = new RelationshipProviderTransformer();
59
86
  this.dataHolderTransformer = new DataHolderTransformer();
87
+ this.dataHolderScanSummaryTransformer =
88
+ new DataHolderScanSummaryTransformer();
60
89
  this.analysisResultTransformer = new AnalysisResultTransformer();
90
+ this.organizationAnalysisTransformer = new OrganizationAnalysisTransformer();
91
+ this.organizationAnalysisModeTransformer =
92
+ new OrganizationAnalysisModeTransformer();
93
+ this.actionTransformer = new ActionTransformer();
94
+ this.availableActionTransformer = new AvailableActionTransformer();
95
+ this.actionIntentTransformer = new ActionIntentTransformer();
96
+ this.actionFulfilmentMethodTransformer =
97
+ new ActionFulfilmentMethodTransformer();
61
98
  }
62
99
  async getProviderConfiguration() {
63
100
  this.log.debug(this.getProviderConfiguration.name);
@@ -129,14 +166,42 @@ export class DefaultSudoPrivacyInteractionClient {
129
166
  const useCase = new UnsubscribeFromVirtualPresenceUseCase(this.virtualPresenceService);
130
167
  useCase.execute(subscriptionId);
131
168
  }
132
- async getDataHolder(id) {
133
- this.log.debug(this.getDataHolder.name, { id });
134
- const useCase = new GetDataHolderUseCase(this.dataHolderService);
135
- const result = await useCase.execute(id);
136
- if (!result) {
169
+ async getDataHolder(id, options) {
170
+ this.log.debug(this.getDataHolder.name, { id, options });
171
+ const includeScanSummary = options?.includeScanSummary ?? true;
172
+ const getDataHolderUseCase = new GetDataHolderUseCase(this.dataHolderService);
173
+ // Fetch the data holder and (optionally) its latest scan summary concurrently
174
+ // to minimise latency. The scan summary is a best-effort convenience: if it
175
+ // fails, the data holder is still returned without a `latestScanSummary`.
176
+ const [dataHolderOutcome, scanSummariesOutcome] = await Promise.allSettled([
177
+ getDataHolderUseCase.execute(id),
178
+ includeScanSummary
179
+ ? new ListDataHolderScanSummariesUseCase(this.dataHolderService).execute({ dataHolderId: id, limit: 1 })
180
+ : Promise.resolve(undefined),
181
+ ]);
182
+ // The data holder is the primary result; propagate its error to the caller.
183
+ if (dataHolderOutcome.status === 'rejected') {
184
+ throw dataHolderOutcome.reason;
185
+ }
186
+ const dataHolderResult = dataHolderOutcome.value;
187
+ if (!dataHolderResult) {
137
188
  return undefined;
138
189
  }
139
- return this.dataHolderTransformer.fromEntityToAPI(result);
190
+ const dataHolder = this.dataHolderTransformer.fromEntityToAPI(dataHolderResult);
191
+ if (scanSummariesOutcome.status === 'fulfilled') {
192
+ const latestScanSummaryEntity = scanSummariesOutcome.value?.scanSummaries[0];
193
+ if (latestScanSummaryEntity) {
194
+ dataHolder.latestScanSummary =
195
+ this.dataHolderScanSummaryTransformer.fromEntityToAPI(latestScanSummaryEntity);
196
+ }
197
+ }
198
+ else {
199
+ this.log.error('Failed to fetch latest scan summary for data holder', {
200
+ id,
201
+ error: scanSummariesOutcome.reason,
202
+ });
203
+ }
204
+ return dataHolder;
140
205
  }
141
206
  async listDataHolders(input) {
142
207
  this.log.debug(this.listDataHolders.name, { input });
@@ -149,6 +214,17 @@ export class DefaultSudoPrivacyInteractionClient {
149
214
  const transformedDataHolders = dataHolders.map((dataHolder) => this.dataHolderTransformer.fromEntityToAPI(dataHolder));
150
215
  return { items: transformedDataHolders, nextToken: resultNextToken };
151
216
  }
217
+ async listDataHolderScanSummaries(input) {
218
+ this.log.debug(this.listDataHolderScanSummaries.name, { input });
219
+ const useCase = new ListDataHolderScanSummariesUseCase(this.dataHolderService);
220
+ const { scanSummaries, nextToken: resultNextToken } = await useCase.execute({
221
+ dataHolderId: input.dataHolderId,
222
+ limit: input.limit,
223
+ nextToken: input.nextToken,
224
+ });
225
+ const transformedScanSummaries = scanSummaries.map((scanSummary) => this.dataHolderScanSummaryTransformer.fromEntityToAPI(scanSummary));
226
+ return { items: transformedScanSummaries, nextToken: resultNextToken };
227
+ }
152
228
  async subscribeToDataHolders(subscriptionId, subscriber) {
153
229
  this.log.debug(this.subscribeToDataHolders.name, {
154
230
  subscriptionId,
@@ -197,4 +273,55 @@ export class DefaultSudoPrivacyInteractionClient {
197
273
  const useCase = new UnsubscribeFromAnalysisResultUseCase(this.analysisResultService);
198
274
  useCase.execute(subscriptionId);
199
275
  }
276
+ async getOrganizationAnalysis(input) {
277
+ this.log.debug(this.getOrganizationAnalysis.name, { input });
278
+ const useCase = new GetOrganizationAnalysisUseCase(this.organizationAnalysisService);
279
+ const result = await useCase.execute({
280
+ domain: input.domain,
281
+ mode: input.mode
282
+ ? this.organizationAnalysisModeTransformer.fromAPIToEntity(input.mode)
283
+ : undefined,
284
+ });
285
+ if (!result) {
286
+ return undefined;
287
+ }
288
+ return this.organizationAnalysisTransformer.fromEntityToAPI(result);
289
+ }
290
+ async initiateAction(input) {
291
+ this.log.debug(this.initiateAction.name, { input });
292
+ const useCase = new InitiateActionUseCase(this.actionService);
293
+ const result = await useCase.execute({
294
+ dataHolderId: input.dataHolderId,
295
+ intent: this.actionIntentTransformer.fromAPIToEntity(input.intent),
296
+ fulfilmentMethod: this.actionFulfilmentMethodTransformer.fromAPIToEntity(input.fulfilmentMethod),
297
+ });
298
+ return this.actionTransformer.fromEntityToAPI(result);
299
+ }
300
+ async confirmActionOutcome(id) {
301
+ this.log.debug(this.confirmActionOutcome.name, { id });
302
+ const useCase = new ConfirmActionOutcomeUseCase(this.actionService);
303
+ const result = await useCase.execute(id);
304
+ return this.actionTransformer.fromEntityToAPI(result);
305
+ }
306
+ async listAvailableActions(input) {
307
+ this.log.debug(this.listAvailableActions.name, { input });
308
+ const useCase = new ListAvailableActionsUseCase(this.actionService);
309
+ const { availableActions, nextToken: resultNextToken } = await useCase.execute({ dataHolderId: input.dataHolderId });
310
+ const transformedAvailableActions = availableActions.map((availableAction) => this.availableActionTransformer.fromEntityToAPI(availableAction));
311
+ return { items: transformedAvailableActions, nextToken: resultNextToken };
312
+ }
313
+ async subscribeToActions(subscriptionId, subscriber) {
314
+ this.log.debug(this.subscribeToActions.name, {
315
+ subscriptionId,
316
+ });
317
+ const useCase = new SubscribeToActionUseCase(this.actionService, this.userClient);
318
+ await useCase.execute({ subscriptionId, subscriber });
319
+ }
320
+ unsubscribeFromActions(subscriptionId) {
321
+ this.log.debug(this.unsubscribeFromActions.name, {
322
+ subscriptionId,
323
+ });
324
+ const useCase = new UnsubscribeFromActionUseCase(this.actionService);
325
+ useCase.execute(subscriptionId);
326
+ }
200
327
  }
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ export {};
@@ -3,7 +3,9 @@
3
3
  *
4
4
  * SPDX-License-Identifier: Apache-2.0
5
5
  */
6
+ export * from './action';
6
7
  export * from './analysisResult';
7
8
  export * from './common';
8
9
  export * from './dataHolder';
10
+ export * from './organizationAnalysis';
9
11
  export * from './virtualPresence';
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ export {};