@sudoplatform/sudo-privacy-interaction 2.1.0 → 2.3.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 (162) hide show
  1. package/cjs/gen/graphqlTypes.js +1111 -132
  2. package/cjs/gen/schema-types.js +2 -0
  3. package/cjs/private/data/action/actionSubscriptionManager.js +25 -0
  4. package/cjs/private/data/action/defaultActionService.js +87 -0
  5. package/cjs/private/data/action/transformer/actionFulfilmentMethodTransformer.js +47 -0
  6. package/cjs/private/data/action/transformer/actionIntentTransformer.js +69 -0
  7. package/cjs/private/data/action/transformer/actionOriginTransformer.js +37 -0
  8. package/cjs/private/data/action/transformer/actionStatusTransformer.js +53 -0
  9. package/cjs/private/data/action/transformer/actionTransformer.js +85 -0
  10. package/cjs/private/data/action/transformer/availableActionTransformer.js +37 -0
  11. package/cjs/private/data/analysis-result/transformer/capabilitySignalsTransformer.js +5 -2
  12. package/cjs/private/data/analysis-result/transformer/organizationCategoryTransformer.js +4 -0
  13. package/cjs/private/data/common/apiClient.js +64 -1
  14. package/cjs/private/data/data-holder/defaultDataHolderService.js +8 -0
  15. package/cjs/private/data/data-holder/transformer/dataHolderProtectionStateTransformer.js +4 -0
  16. package/cjs/private/data/organization-analysis/defaultOrganizationAnalysisService.js +6 -0
  17. package/cjs/private/data/organization-analysis/transformer/organizationAnalysisDomainResolutionTransformer.js +29 -0
  18. package/cjs/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +8 -0
  19. package/cjs/private/domain/entities/action/actionEntity.js +86 -0
  20. package/cjs/private/domain/entities/action/actionService.js +7 -0
  21. package/cjs/private/domain/entities/analysis-result/analysisResultEntity.js +1 -0
  22. package/cjs/private/domain/entities/data-holder/dataHolderEntity.js +2 -0
  23. package/cjs/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +17 -1
  24. package/cjs/private/domain/use-cases/action/confirmActionOutcomeUseCase.js +25 -0
  25. package/cjs/private/domain/use-cases/action/getActionUseCase.js +25 -0
  26. package/cjs/private/domain/use-cases/action/initiateActionUseCase.js +26 -0
  27. package/cjs/private/domain/use-cases/action/listAvailableActionsUseCase.js +26 -0
  28. package/cjs/private/domain/use-cases/action/subscribeToActionUseCase.js +37 -0
  29. package/cjs/private/domain/use-cases/action/unsubscribeFromActionUseCase.js +27 -0
  30. package/cjs/private/domain/use-cases/data-holder/archiveDataHolderUseCase.js +25 -0
  31. package/cjs/private/domain/use-cases/data-holder/unarchiveDataHolderUseCase.js +25 -0
  32. package/cjs/public/defaultSudoPrivacyInteractionClient.js +89 -0
  33. package/cjs/public/inputs/action.js +7 -0
  34. package/cjs/public/inputs/index.js +1 -0
  35. package/cjs/public/typings/action.js +85 -0
  36. package/cjs/public/typings/analysisResult.js +1 -0
  37. package/cjs/public/typings/dataHolder.js +2 -0
  38. package/cjs/public/typings/index.js +1 -0
  39. package/cjs/public/typings/organizationAnalysis.js +17 -1
  40. package/docs/assets/hierarchy.js +1 -1
  41. package/docs/assets/navigation.js +1 -1
  42. package/docs/assets/search.js +1 -1
  43. package/docs/classes/DefaultSudoPrivacyInteractionClient.html +194 -22
  44. package/docs/enums/ActionFulfilmentMethod.html +63 -0
  45. package/docs/enums/ActionIntent.html +84 -0
  46. package/docs/enums/ActionOrigin.html +75 -0
  47. package/docs/enums/ActionStatus.html +99 -0
  48. package/docs/enums/ConnectionState.html +3 -3
  49. package/docs/enums/DataHolderProtectionState.html +12 -6
  50. package/docs/enums/OrganizationAnalysisDomainResolution.html +70 -0
  51. package/docs/enums/OrganizationCategory.html +38 -32
  52. package/docs/enums/ProviderType.html +3 -3
  53. package/docs/enums/VirtualPresenceState.html +7 -7
  54. package/docs/hierarchy.html +6 -6
  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 +41 -29
  63. package/docs/interfaces/DataHolderCount.html +98 -0
  64. package/docs/interfaces/DataHolderScanSummary.html +14 -14
  65. package/docs/interfaces/DataHolderSubscriber.html +3 -3
  66. package/docs/interfaces/GetOrganizationAnalysisInput.html +24 -5
  67. package/docs/interfaces/InitiateActionInput.html +79 -0
  68. package/docs/interfaces/ListAnalysisResultsInput.html +1 -1
  69. package/docs/interfaces/ListAvailableActionsInput.html +61 -0
  70. package/docs/interfaces/ListDataHolderScanSummariesInput.html +1 -1
  71. package/docs/interfaces/ListDataHoldersInput.html +1 -1
  72. package/docs/interfaces/ListVirtualPresencesInput.html +1 -1
  73. package/docs/interfaces/OrganizationIdentity.html +5 -5
  74. package/docs/interfaces/Pagination.html +1 -1
  75. package/docs/interfaces/RiskIndicators.html +8 -8
  76. package/docs/interfaces/SudoPrivacyInteractionClient.html +186 -22
  77. package/docs/interfaces/VirtualPresence.html +22 -13
  78. package/docs/interfaces/VirtualPresenceSubscriber.html +3 -3
  79. package/docs/modules.html +4 -4
  80. package/docs/types/SudoPrivacyInteractionClientOptions.html +2 -2
  81. package/lib/gen/graphqlTypes.js +1109 -131
  82. package/lib/gen/schema-types.js +1 -0
  83. package/lib/private/data/action/actionSubscriptionManager.js +21 -0
  84. package/lib/private/data/action/defaultActionService.js +83 -0
  85. package/lib/private/data/action/transformer/actionFulfilmentMethodTransformer.js +43 -0
  86. package/lib/private/data/action/transformer/actionIntentTransformer.js +65 -0
  87. package/lib/private/data/action/transformer/actionOriginTransformer.js +33 -0
  88. package/lib/private/data/action/transformer/actionStatusTransformer.js +49 -0
  89. package/lib/private/data/action/transformer/actionTransformer.js +81 -0
  90. package/lib/private/data/action/transformer/availableActionTransformer.js +33 -0
  91. package/lib/private/data/analysis-result/transformer/capabilitySignalsTransformer.js +5 -2
  92. package/lib/private/data/analysis-result/transformer/organizationCategoryTransformer.js +4 -0
  93. package/lib/private/data/common/apiClient.js +65 -2
  94. package/lib/private/data/data-holder/defaultDataHolderService.js +8 -0
  95. package/lib/private/data/data-holder/transformer/dataHolderProtectionStateTransformer.js +4 -0
  96. package/lib/private/data/organization-analysis/defaultOrganizationAnalysisService.js +6 -0
  97. package/lib/private/data/organization-analysis/transformer/organizationAnalysisDomainResolutionTransformer.js +25 -0
  98. package/lib/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +8 -0
  99. package/lib/private/domain/entities/action/actionEntity.js +83 -0
  100. package/lib/private/domain/entities/action/actionService.js +6 -0
  101. package/lib/private/domain/entities/analysis-result/analysisResultEntity.js +1 -0
  102. package/lib/private/domain/entities/data-holder/dataHolderEntity.js +2 -0
  103. package/lib/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +16 -0
  104. package/lib/private/domain/use-cases/action/confirmActionOutcomeUseCase.js +21 -0
  105. package/lib/private/domain/use-cases/action/getActionUseCase.js +21 -0
  106. package/lib/private/domain/use-cases/action/initiateActionUseCase.js +22 -0
  107. package/lib/private/domain/use-cases/action/listAvailableActionsUseCase.js +22 -0
  108. package/lib/private/domain/use-cases/action/subscribeToActionUseCase.js +33 -0
  109. package/lib/private/domain/use-cases/action/unsubscribeFromActionUseCase.js +23 -0
  110. package/lib/private/domain/use-cases/data-holder/archiveDataHolderUseCase.js +21 -0
  111. package/lib/private/domain/use-cases/data-holder/unarchiveDataHolderUseCase.js +21 -0
  112. package/lib/public/defaultSudoPrivacyInteractionClient.js +89 -0
  113. package/lib/public/inputs/action.js +6 -0
  114. package/lib/public/inputs/index.js +1 -0
  115. package/lib/public/typings/action.js +82 -0
  116. package/lib/public/typings/analysisResult.js +1 -0
  117. package/lib/public/typings/dataHolder.js +2 -0
  118. package/lib/public/typings/index.js +1 -0
  119. package/lib/public/typings/organizationAnalysis.js +16 -0
  120. package/package.json +20 -24
  121. package/types/gen/graphqlTypes.d.ts +427 -497
  122. package/types/gen/schema-types.d.ts +521 -0
  123. package/types/private/data/action/actionSubscriptionManager.d.ts +19 -0
  124. package/types/private/data/action/defaultActionService.d.ts +24 -0
  125. package/types/private/data/action/transformer/actionFulfilmentMethodTransformer.d.ts +14 -0
  126. package/types/private/data/action/transformer/actionIntentTransformer.d.ts +14 -0
  127. package/types/private/data/action/transformer/actionOriginTransformer.d.ts +12 -0
  128. package/types/private/data/action/transformer/actionStatusTransformer.d.ts +12 -0
  129. package/types/private/data/action/transformer/actionTransformer.d.ts +39 -0
  130. package/types/private/data/action/transformer/availableActionTransformer.d.ts +15 -0
  131. package/types/private/data/common/apiClient.d.ts +12 -1
  132. package/types/private/data/data-holder/defaultDataHolderService.d.ts +2 -0
  133. package/types/private/data/organization-analysis/defaultOrganizationAnalysisService.d.ts +1 -0
  134. package/types/private/data/organization-analysis/transformer/organizationAnalysisDomainResolutionTransformer.d.ts +12 -0
  135. package/types/private/domain/entities/action/actionEntity.d.ts +187 -0
  136. package/types/private/domain/entities/action/actionService.d.ts +110 -0
  137. package/types/private/domain/entities/analysis-result/analysisResultEntity.d.ts +3 -2
  138. package/types/private/domain/entities/data-holder/dataHolderEntity.d.ts +2 -0
  139. package/types/private/domain/entities/data-holder/dataHolderService.d.ts +16 -0
  140. package/types/private/domain/entities/organization-analysis/organizationAnalysisEntity.d.ts +15 -0
  141. package/types/private/domain/entities/organization-analysis/organizationAnalysisService.d.ts +8 -1
  142. package/types/private/domain/entities/virtual-presence/virtualPresenceEntity.d.ts +24 -0
  143. package/types/private/domain/use-cases/action/confirmActionOutcomeUseCase.d.ts +16 -0
  144. package/types/private/domain/use-cases/action/getActionUseCase.d.ts +16 -0
  145. package/types/private/domain/use-cases/action/initiateActionUseCase.d.ts +17 -0
  146. package/types/private/domain/use-cases/action/listAvailableActionsUseCase.d.ts +16 -0
  147. package/types/private/domain/use-cases/action/subscribeToActionUseCase.d.ts +27 -0
  148. package/types/private/domain/use-cases/action/unsubscribeFromActionUseCase.d.ts +15 -0
  149. package/types/private/domain/use-cases/data-holder/archiveDataHolderUseCase.d.ts +16 -0
  150. package/types/private/domain/use-cases/data-holder/unarchiveDataHolderUseCase.d.ts +16 -0
  151. package/types/public/defaultSudoPrivacyInteractionClient.d.ts +16 -2
  152. package/types/public/inputs/action.d.ts +30 -0
  153. package/types/public/inputs/index.d.ts +1 -0
  154. package/types/public/inputs/organizationAnalysis.d.ts +8 -1
  155. package/types/public/sudoPrivacyInteractionClient.d.ts +68 -2
  156. package/types/public/typings/action.d.ts +185 -0
  157. package/types/public/typings/analysisResult.d.ts +8 -0
  158. package/types/public/typings/dataHolder.d.ts +2 -0
  159. package/types/public/typings/index.d.ts +1 -0
  160. package/types/public/typings/organizationAnalysis.d.ts +15 -0
  161. package/types/public/typings/subscription.d.ts +23 -0
  162. package/types/public/typings/virtualPresence.d.ts +25 -0
@@ -18,6 +18,7 @@ export class VirtualPresenceTransformer {
18
18
  state: virtualPresenceStateTransformer.fromEntityToAPI(entity.state),
19
19
  lastScannedAt: entity.lastScannedAt,
20
20
  lastScanFailureReason: entity.lastScanFailureReason,
21
+ dataHolderCount: { ...entity.dataHolderCount },
21
22
  createdAt: entity.createdAt,
22
23
  updatedAt: entity.updatedAt,
23
24
  };
@@ -34,6 +35,13 @@ export class VirtualPresenceTransformer {
34
35
  state: virtualPresenceStateTransformer.fromGraphQLToEntity(data.state),
35
36
  lastScannedAt: new Date(data.lastScannedAtEpochMs),
36
37
  lastScanFailureReason: data.lastScanFailureReason ?? undefined,
38
+ dataHolderCount: {
39
+ count: data.dataHolderCount.count,
40
+ monitored: data.dataHolderCount.monitored,
41
+ initiatedActions: data.dataHolderCount.initiatedActions,
42
+ completedActions: data.dataHolderCount.completedActions,
43
+ archived: data.dataHolderCount.archived,
44
+ },
37
45
  createdAt: new Date(data.createdAtEpochMs),
38
46
  updatedAt: new Date(data.updatedAtEpochMs),
39
47
  };
@@ -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 {};
@@ -100,6 +100,7 @@ export var RetentionStyleEntity;
100
100
  */
101
101
  export var OrganizationCategoryEntity;
102
102
  (function (OrganizationCategoryEntity) {
103
+ OrganizationCategoryEntity["AdultEntertainment"] = "AdultEntertainment";
103
104
  OrganizationCategoryEntity["Automotive"] = "Automotive";
104
105
  OrganizationCategoryEntity["Communications"] = "Communications";
105
106
  OrganizationCategoryEntity["CommunityAndCharity"] = "CommunityAndCharity";
@@ -9,6 +9,7 @@
9
9
  * @property MONITORED The data holder is being monitored.
10
10
  * @property ACTION_REQUESTED An action has been requested against this data holder.
11
11
  * @property RESOLVED The data holder has been resolved.
12
+ * @property ARCHIVED The data holder has been archived by the user.
12
13
  *
13
14
  * @enum
14
15
  */
@@ -17,5 +18,6 @@ export var DataHolderProtectionStateEntity;
17
18
  DataHolderProtectionStateEntity["Monitored"] = "MONITORED";
18
19
  DataHolderProtectionStateEntity["ActionRequested"] = "ACTION_REQUESTED";
19
20
  DataHolderProtectionStateEntity["Resolved"] = "RESOLVED";
21
+ DataHolderProtectionStateEntity["Archived"] = "ARCHIVED";
20
22
  DataHolderProtectionStateEntity["Unknown"] = "UNKNOWN";
21
23
  })(DataHolderProtectionStateEntity || (DataHolderProtectionStateEntity = {}));
@@ -19,3 +19,19 @@ export var OrganizationAnalysisModeEntity;
19
19
  OrganizationAnalysisModeEntity["Analyze"] = "ANALYZE";
20
20
  OrganizationAnalysisModeEntity["Fetch"] = "FETCH";
21
21
  })(OrganizationAnalysisModeEntity || (OrganizationAnalysisModeEntity = {}));
22
+ /**
23
+ * Controls how `getOrganizationAnalysis` treats the requested domain before
24
+ * sources query their backing services.
25
+ *
26
+ * @property REGISTRABLE Reduce the domain to its registrable (eTLD+1) form before analysis,
27
+ * e.g. `mail.sub.example.co.uk` becomes `example.co.uk`.
28
+ * @property EXACT Analyze the domain verbatim, without reducing it to a registrable domain.
29
+ * Used to analyze a specific host/subdomain rather than the organization.
30
+ *
31
+ * @enum
32
+ */
33
+ export var OrganizationAnalysisDomainResolutionEntity;
34
+ (function (OrganizationAnalysisDomainResolutionEntity) {
35
+ OrganizationAnalysisDomainResolutionEntity["Registrable"] = "REGISTRABLE";
36
+ OrganizationAnalysisDomainResolutionEntity["Exact"] = "EXACT";
37
+ })(OrganizationAnalysisDomainResolutionEntity || (OrganizationAnalysisDomainResolutionEntity = {}));
@@ -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,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 retrieving a single action.
9
+ */
10
+ export class GetActionUseCase {
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.get(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,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 archiving a data holder.
9
+ */
10
+ export class ArchiveDataHolderUseCase {
11
+ dataHolderService;
12
+ log;
13
+ constructor(dataHolderService) {
14
+ this.dataHolderService = dataHolderService;
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.dataHolderService.archive(id);
20
+ }
21
+ }
@@ -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 unarchiving a data holder.
9
+ */
10
+ export class UnarchiveDataHolderUseCase {
11
+ dataHolderService;
12
+ log;
13
+ constructor(dataHolderService) {
14
+ this.dataHolderService = dataHolderService;
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.dataHolderService.unarchive(id);
20
+ }
21
+ }
@@ -4,6 +4,11 @@
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';
@@ -14,17 +19,26 @@ import { DefaultProviderConfigurationService } from '../private/data/provider-co
14
19
  import { ProviderConfigurationTransformer } from '../private/data/provider-configuration/transformer/providerConfigurationTransformer';
15
20
  import { DefaultOrganizationAnalysisService } from '../private/data/organization-analysis/defaultOrganizationAnalysisService';
16
21
  import { OrganizationAnalysisModeTransformer } from '../private/data/organization-analysis/transformer/organizationAnalysisModeTransformer';
22
+ import { OrganizationAnalysisDomainResolutionTransformer } from '../private/data/organization-analysis/transformer/organizationAnalysisDomainResolutionTransformer';
17
23
  import { OrganizationAnalysisTransformer } from '../private/data/organization-analysis/transformer/organizationAnalysisTransformer';
18
24
  import { DefaultVirtualPresenceService } from '../private/data/virtual-presence/defaultVirtualPresenceService';
19
25
  import { RelationshipProviderTransformer } from '../private/data/virtual-presence/transformer/relationshipProviderTransformer';
20
26
  import { VirtualPresenceTransformer } from '../private/data/virtual-presence/transformer/virtualPresenceTransformer';
21
27
  import { GetAnalysisResultUseCase } from '../private/domain/use-cases/analysis-result/getAnalysisResultUseCase';
28
+ import { ConfirmActionOutcomeUseCase } from '../private/domain/use-cases/action/confirmActionOutcomeUseCase';
29
+ import { GetActionUseCase } from '../private/domain/use-cases/action/getActionUseCase';
30
+ import { InitiateActionUseCase } from '../private/domain/use-cases/action/initiateActionUseCase';
31
+ import { ListAvailableActionsUseCase } from '../private/domain/use-cases/action/listAvailableActionsUseCase';
32
+ import { SubscribeToActionUseCase } from '../private/domain/use-cases/action/subscribeToActionUseCase';
33
+ import { UnsubscribeFromActionUseCase } from '../private/domain/use-cases/action/unsubscribeFromActionUseCase';
22
34
  import { ListAnalysisResultsUseCase } from '../private/domain/use-cases/analysis-result/listAnalysisResultsUseCase';
23
35
  import { SubscribeToAnalysisResultUseCase } from '../private/domain/use-cases/analysis-result/subscribeToAnalysisResultUseCase';
24
36
  import { UnsubscribeFromAnalysisResultUseCase } from '../private/domain/use-cases/analysis-result/unsubscribeFromAnalysisResultUseCase';
25
37
  import { GetProviderConfigurationUseCase } from '../private/domain/use-cases/configuration/getProviderConfigurationUseCase';
26
38
  import { GetOrganizationAnalysisUseCase } from '../private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase';
27
39
  import { GetDataHolderUseCase } from '../private/domain/use-cases/data-holder/getDataHolderUseCase';
40
+ import { ArchiveDataHolderUseCase } from '../private/domain/use-cases/data-holder/archiveDataHolderUseCase';
41
+ import { UnarchiveDataHolderUseCase } from '../private/domain/use-cases/data-holder/unarchiveDataHolderUseCase';
28
42
  import { ListDataHolderScanSummariesUseCase } from '../private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase';
29
43
  import { ListDataHoldersUseCase } from '../private/domain/use-cases/data-holder/listDataHoldersUseCase';
30
44
  import { SubscribeToDataHoldersUseCase } from '../private/domain/use-cases/data-holder/subscribeToDataHoldersUseCase';
@@ -36,6 +50,7 @@ import { ListVirtualPresencesUseCase } from '../private/domain/use-cases/virtual
36
50
  import { RescanVirtualPresenceUseCase } from '../private/domain/use-cases/virtual-presence/rescanVirtualPresenceUseCase';
37
51
  import { SubscribeToVirtualPresenceUseCase } from '../private/domain/use-cases/virtual-presence/subscribeToVirtualPresenceUseCase';
38
52
  import { UnsubscribeFromVirtualPresenceUseCase } from '../private/domain/use-cases/virtual-presence/unsubscribeFromVirtualPresenceUseCase';
53
+ import { OrganizationAnalysisDomainResolution, } from './typings';
39
54
  export class DefaultSudoPrivacyInteractionClient {
40
55
  apiClient;
41
56
  userClient;
@@ -44,6 +59,7 @@ export class DefaultSudoPrivacyInteractionClient {
44
59
  dataHolderService;
45
60
  analysisResultService;
46
61
  organizationAnalysisService;
62
+ actionService;
47
63
  providerConfigurationTransformer;
48
64
  virtualPresenceTransformer;
49
65
  relationshipProviderTransformer;
@@ -52,6 +68,11 @@ export class DefaultSudoPrivacyInteractionClient {
52
68
  analysisResultTransformer;
53
69
  organizationAnalysisTransformer;
54
70
  organizationAnalysisModeTransformer;
71
+ organizationAnalysisDomainResolutionTransformer;
72
+ actionTransformer;
73
+ availableActionTransformer;
74
+ actionIntentTransformer;
75
+ actionFulfilmentMethodTransformer;
55
76
  log;
56
77
  constructor(opts) {
57
78
  this.log = new DefaultLogger(this.constructor.name);
@@ -63,6 +84,7 @@ export class DefaultSudoPrivacyInteractionClient {
63
84
  this.dataHolderService = new DefaultDataHolderService(this.apiClient);
64
85
  this.analysisResultService = new DefaultAnalysisResultService(this.apiClient);
65
86
  this.organizationAnalysisService = new DefaultOrganizationAnalysisService(this.apiClient);
87
+ this.actionService = new DefaultActionService(this.apiClient);
66
88
  this.providerConfigurationTransformer =
67
89
  new ProviderConfigurationTransformer();
68
90
  this.virtualPresenceTransformer = new VirtualPresenceTransformer();
@@ -74,6 +96,13 @@ export class DefaultSudoPrivacyInteractionClient {
74
96
  this.organizationAnalysisTransformer = new OrganizationAnalysisTransformer();
75
97
  this.organizationAnalysisModeTransformer =
76
98
  new OrganizationAnalysisModeTransformer();
99
+ this.organizationAnalysisDomainResolutionTransformer =
100
+ new OrganizationAnalysisDomainResolutionTransformer();
101
+ this.actionTransformer = new ActionTransformer();
102
+ this.availableActionTransformer = new AvailableActionTransformer();
103
+ this.actionIntentTransformer = new ActionIntentTransformer();
104
+ this.actionFulfilmentMethodTransformer =
105
+ new ActionFulfilmentMethodTransformer();
77
106
  }
78
107
  async getProviderConfiguration() {
79
108
  this.log.debug(this.getProviderConfiguration.name);
@@ -204,6 +233,18 @@ export class DefaultSudoPrivacyInteractionClient {
204
233
  const transformedScanSummaries = scanSummaries.map((scanSummary) => this.dataHolderScanSummaryTransformer.fromEntityToAPI(scanSummary));
205
234
  return { items: transformedScanSummaries, nextToken: resultNextToken };
206
235
  }
236
+ async archiveDataHolder(id) {
237
+ this.log.debug(this.archiveDataHolder.name, { id });
238
+ const useCase = new ArchiveDataHolderUseCase(this.dataHolderService);
239
+ const result = await useCase.execute(id);
240
+ return this.dataHolderTransformer.fromEntityToAPI(result);
241
+ }
242
+ async unarchiveDataHolder(id) {
243
+ this.log.debug(this.unarchiveDataHolder.name, { id });
244
+ const useCase = new UnarchiveDataHolderUseCase(this.dataHolderService);
245
+ const result = await useCase.execute(id);
246
+ return this.dataHolderTransformer.fromEntityToAPI(result);
247
+ }
207
248
  async subscribeToDataHolders(subscriptionId, subscriber) {
208
249
  this.log.debug(this.subscribeToDataHolders.name, {
209
250
  subscriptionId,
@@ -257,13 +298,61 @@ export class DefaultSudoPrivacyInteractionClient {
257
298
  const useCase = new GetOrganizationAnalysisUseCase(this.organizationAnalysisService);
258
299
  const result = await useCase.execute({
259
300
  domain: input.domain,
301
+ name: input.name,
260
302
  mode: input.mode
261
303
  ? this.organizationAnalysisModeTransformer.fromAPIToEntity(input.mode)
262
304
  : undefined,
305
+ resolution: this.organizationAnalysisDomainResolutionTransformer.fromAPIToEntity(input.resolution ?? OrganizationAnalysisDomainResolution.Exact),
263
306
  });
264
307
  if (!result) {
265
308
  return undefined;
266
309
  }
267
310
  return this.organizationAnalysisTransformer.fromEntityToAPI(result);
268
311
  }
312
+ async initiateAction(input) {
313
+ this.log.debug(this.initiateAction.name, { input });
314
+ const useCase = new InitiateActionUseCase(this.actionService);
315
+ const result = await useCase.execute({
316
+ dataHolderId: input.dataHolderId,
317
+ intent: this.actionIntentTransformer.fromAPIToEntity(input.intent),
318
+ fulfilmentMethod: this.actionFulfilmentMethodTransformer.fromAPIToEntity(input.fulfilmentMethod),
319
+ });
320
+ return this.actionTransformer.fromEntityToAPI(result);
321
+ }
322
+ async getAction(id) {
323
+ this.log.debug(this.getAction.name, { id });
324
+ const useCase = new GetActionUseCase(this.actionService);
325
+ const result = await useCase.execute(id);
326
+ if (!result) {
327
+ return undefined;
328
+ }
329
+ return this.actionTransformer.fromEntityToAPI(result);
330
+ }
331
+ async confirmActionOutcome(id) {
332
+ this.log.debug(this.confirmActionOutcome.name, { id });
333
+ const useCase = new ConfirmActionOutcomeUseCase(this.actionService);
334
+ const result = await useCase.execute(id);
335
+ return this.actionTransformer.fromEntityToAPI(result);
336
+ }
337
+ async listAvailableActions(input) {
338
+ this.log.debug(this.listAvailableActions.name, { input });
339
+ const useCase = new ListAvailableActionsUseCase(this.actionService);
340
+ const { availableActions, nextToken: resultNextToken } = await useCase.execute({ dataHolderId: input.dataHolderId });
341
+ const transformedAvailableActions = availableActions.map((availableAction) => this.availableActionTransformer.fromEntityToAPI(availableAction));
342
+ return { items: transformedAvailableActions, nextToken: resultNextToken };
343
+ }
344
+ async subscribeToActions(subscriptionId, subscriber) {
345
+ this.log.debug(this.subscribeToActions.name, {
346
+ subscriptionId,
347
+ });
348
+ const useCase = new SubscribeToActionUseCase(this.actionService, this.userClient);
349
+ await useCase.execute({ subscriptionId, subscriber });
350
+ }
351
+ unsubscribeFromActions(subscriptionId) {
352
+ this.log.debug(this.unsubscribeFromActions.name, {
353
+ subscriptionId,
354
+ });
355
+ const useCase = new UnsubscribeFromActionUseCase(this.actionService);
356
+ useCase.execute(subscriptionId);
357
+ }
269
358
  }
@@ -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,6 +3,7 @@
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';
@@ -0,0 +1,82 @@
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.
8
+ *
9
+ * Clients must tolerate unknown values: an unrecognised intent is represented
10
+ * as `Other` rather than failing, so newly added intents do not break existing
11
+ * clients.
12
+ *
13
+ * @property STOP_CONTACT Unsubscribe / opt out of marketing communications.
14
+ * @property ACCESS_MY_DATA Data subject access / portability request.
15
+ * @property DELETE_MY_DATA Account deletion / data erasure.
16
+ * @property LIMIT_DATA_USE Opt out of sale / tracking, manage consent.
17
+ * @property OTHER Anything unmapped; carries additionalInfo.
18
+ *
19
+ * @enum
20
+ */
21
+ export var ActionIntent;
22
+ (function (ActionIntent) {
23
+ ActionIntent["StopContact"] = "STOP_CONTACT";
24
+ ActionIntent["AccessMyData"] = "ACCESS_MY_DATA";
25
+ ActionIntent["DeleteMyData"] = "DELETE_MY_DATA";
26
+ ActionIntent["LimitDataUse"] = "LIMIT_DATA_USE";
27
+ ActionIntent["Other"] = "OTHER";
28
+ })(ActionIntent || (ActionIntent = {}));
29
+ /**
30
+ * How an action is fulfilled from the user's perspective.
31
+ *
32
+ * @property ASSISTED The service returns structured materials for the client to
33
+ * complete the action.
34
+ * @property DELEGATED The service performs the action on the user's behalf.
35
+ *
36
+ * @enum
37
+ */
38
+ export var ActionFulfilmentMethod;
39
+ (function (ActionFulfilmentMethod) {
40
+ ActionFulfilmentMethod["Assisted"] = "ASSISTED";
41
+ ActionFulfilmentMethod["Delegated"] = "DELEGATED";
42
+ })(ActionFulfilmentMethod || (ActionFulfilmentMethod = {}));
43
+ /**
44
+ * Which source contributed an available action.
45
+ *
46
+ * @property STATIC Always-possible action for the virtual presence type.
47
+ * @property ANALYSIS Derived from an analysis source's reported actions.
48
+ * @property DISCOVERY Derived from a discovery scan (e.g. List-Unsubscribe).
49
+ *
50
+ * @enum
51
+ */
52
+ export var ActionOrigin;
53
+ (function (ActionOrigin) {
54
+ ActionOrigin["Static"] = "STATIC";
55
+ ActionOrigin["Analysis"] = "ANALYSIS";
56
+ ActionOrigin["Discovery"] = "DISCOVERY";
57
+ ActionOrigin["Unknown"] = "UNKNOWN";
58
+ })(ActionOrigin || (ActionOrigin = {}));
59
+ /**
60
+ * Lifecycle status of a persisted action instance.
61
+ *
62
+ * @property PENDING The action has been created but not yet started.
63
+ * @property IN_PROGRESS The action is being performed.
64
+ * @property COMPLETED_UNVERIFIED The action completed but has not been verified.
65
+ * @property COMPLETED_VERIFIED The action completed and has been verified.
66
+ * @property FAILED The action failed to complete.
67
+ * @property REQUIRES_USER_INPUT The action requires further input from the user.
68
+ * @property CONTRADICTED Subsequent evidence contradicts the action's completion.
69
+ *
70
+ * @enum
71
+ */
72
+ export var ActionStatus;
73
+ (function (ActionStatus) {
74
+ ActionStatus["Pending"] = "PENDING";
75
+ ActionStatus["InProgress"] = "IN_PROGRESS";
76
+ ActionStatus["CompletedUnverified"] = "COMPLETED_UNVERIFIED";
77
+ ActionStatus["CompletedVerified"] = "COMPLETED_VERIFIED";
78
+ ActionStatus["Failed"] = "FAILED";
79
+ ActionStatus["RequiresUserInput"] = "REQUIRES_USER_INPUT";
80
+ ActionStatus["Contradicted"] = "CONTRADICTED";
81
+ ActionStatus["Unknown"] = "UNKNOWN";
82
+ })(ActionStatus || (ActionStatus = {}));
@@ -100,6 +100,7 @@ export var RetentionStyle;
100
100
  */
101
101
  export var OrganizationCategory;
102
102
  (function (OrganizationCategory) {
103
+ OrganizationCategory["AdultEntertainment"] = "AdultEntertainment";
103
104
  OrganizationCategory["Automotive"] = "Automotive";
104
105
  OrganizationCategory["Communications"] = "Communications";
105
106
  OrganizationCategory["CommunityAndCharity"] = "CommunityAndCharity";
@@ -9,6 +9,7 @@
9
9
  * @property MONITORED The data holder is being monitored.
10
10
  * @property ACTION_REQUESTED An action has been requested against this data holder.
11
11
  * @property RESOLVED The data holder has been resolved.
12
+ * @property ARCHIVED The data holder has been archived by the user.
12
13
  *
13
14
  * @enum
14
15
  */
@@ -17,5 +18,6 @@ export var DataHolderProtectionState;
17
18
  DataHolderProtectionState["Monitored"] = "MONITORED";
18
19
  DataHolderProtectionState["ActionRequested"] = "ACTION_REQUESTED";
19
20
  DataHolderProtectionState["Resolved"] = "RESOLVED";
21
+ DataHolderProtectionState["Archived"] = "ARCHIVED";
20
22
  DataHolderProtectionState["Unknown"] = "UNKNOWN";
21
23
  })(DataHolderProtectionState || (DataHolderProtectionState = {}));
@@ -3,6 +3,7 @@
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 './dataHolder';
8
9
  export * from './organizationAnalysis';