@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
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { AvailableAction as AvailableActionGraphQL } from '../../../../gen/graphqlTypes';
7
+ import { AvailableAction } from '../../../../public/typings/action';
8
+ import { AvailableActionEntity } from '../../../domain/entities/action/actionEntity';
9
+ export declare class AvailableActionTransformer {
10
+ private readonly intentTransformer;
11
+ private readonly fulfilmentMethodTransformer;
12
+ private readonly originTransformer;
13
+ fromGraphQLToEntity(data: AvailableActionGraphQL): AvailableActionEntity;
14
+ fromEntityToAPI(entity: AvailableActionEntity): AvailableAction;
15
+ }
@@ -5,7 +5,7 @@
5
5
  */
6
6
  import { ApiClientManager } from '@sudoplatform/sudo-api-client';
7
7
  import Observable from 'zen-observable';
8
- import { AnalysisResult, AnalysisResultConnection, ConnectVirtualPresenceInput, DataHolder, DataHolderConnection, DataHolderScanSummaryConnection, OrganizationAnalysis, OrganizationAnalysisMode, ProviderConfiguration, ListVirtualPresencesInput, OnAnalysisResultUpdateSubscription, OnDataHoldersUpdateSubscription, OnVirtualPresenceUpdateSubscription, ScanOptionsInput, VirtualPresence, VirtualPresenceConnection } from '../../../gen/graphqlTypes';
8
+ import { AnalysisResult, AnalysisResultConnection, Action, AvailableActionConnection, ConnectVirtualPresenceInput, DataHolder, DataHolderConnection, DataHolderScanSummaryConnection, InitiateActionInput, OrganizationAnalysis, OrganizationAnalysisDomainResolution, OrganizationAnalysisMode, ProviderConfiguration, ListVirtualPresencesInput, OnActionStatusUpdateSubscription, OnAnalysisResultUpdateSubscription, OnDataHoldersUpdateSubscription, OnVirtualPresenceUpdateSubscription, ScanOptionsInput, VirtualPresence, VirtualPresenceConnection } from '../../../gen/graphqlTypes';
9
9
  import { SubscriptionResult } from './baseSubscriptionManager';
10
10
  export declare class ApiClient {
11
11
  private readonly log;
@@ -28,19 +28,30 @@ export declare class ApiClient {
28
28
  limit?: number;
29
29
  nextToken?: string;
30
30
  }): Promise<DataHolderScanSummaryConnection>;
31
+ archiveDataHolder(id: string): Promise<DataHolder>;
32
+ unarchiveDataHolder(id: string): Promise<DataHolder>;
31
33
  getAnalysisResult(id: string): Promise<AnalysisResult | undefined>;
32
34
  getOrganizationAnalysis(input: {
33
35
  domain: string;
36
+ name?: string;
34
37
  mode?: OrganizationAnalysisMode;
38
+ resolution?: OrganizationAnalysisDomainResolution;
35
39
  }): Promise<OrganizationAnalysis | undefined>;
36
40
  listAnalysisResults(input: {
37
41
  virtualPresenceId: string;
38
42
  limit?: number;
39
43
  nextToken?: string;
40
44
  }): Promise<AnalysisResultConnection>;
45
+ initiateAction(input: InitiateActionInput): Promise<Action>;
46
+ confirmActionOutcome(id: string): Promise<Action>;
47
+ getAction(id: string): Promise<Action | undefined>;
48
+ listAvailableActions(input: {
49
+ dataHolderId: string;
50
+ }): Promise<AvailableActionConnection>;
41
51
  onVirtualPresenceUpdated(owner: string): Promise<Observable<SubscriptionResult<OnVirtualPresenceUpdateSubscription>>>;
42
52
  onDataHoldersUpdated(owner: string): Promise<Observable<SubscriptionResult<OnDataHoldersUpdateSubscription>>>;
43
53
  onAnalysisResultUpdated(owner: string): Promise<Observable<SubscriptionResult<OnAnalysisResultUpdateSubscription>>>;
54
+ onActionStatusUpdated(owner: string): Promise<Observable<SubscriptionResult<OnActionStatusUpdateSubscription>>>;
44
55
  private performQuery;
45
56
  private performMutation;
46
57
  private performSubscription;
@@ -15,6 +15,8 @@ export declare class DefaultDataHolderService implements DataHolderService {
15
15
  get(id: string): Promise<DataHolderEntity | undefined>;
16
16
  list(input: ListDataHoldersInput): Promise<ListDataHoldersOutput>;
17
17
  listScanSummaries(input: ListDataHolderScanSummariesInput): Promise<ListDataHolderScanSummariesOutput>;
18
+ archive(id: string): Promise<DataHolderEntity>;
19
+ unarchive(id: string): Promise<DataHolderEntity>;
18
20
  subscribe(input: SubscribeToDataHoldersInput): Promise<void>;
19
21
  unsubscribe(subscriptionId: string): void;
20
22
  private setupUpdateSubscription;
@@ -10,6 +10,7 @@ export declare class DefaultOrganizationAnalysisService implements OrganizationA
10
10
  private readonly appSync;
11
11
  private readonly organizationAnalysisTransformer;
12
12
  private readonly modeTransformer;
13
+ private readonly resolutionTransformer;
13
14
  constructor(appSync: ApiClient);
14
15
  getOrganizationAnalysis(input: GetOrganizationAnalysisInput): Promise<OrganizationAnalysisEntity | undefined>;
15
16
  }
@@ -0,0 +1,12 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { OrganizationAnalysisDomainResolution as OrganizationAnalysisDomainResolutionGraphQL } from '../../../../gen/graphqlTypes';
7
+ import { OrganizationAnalysisDomainResolution } from '../../../../public/typings/organizationAnalysis';
8
+ import { OrganizationAnalysisDomainResolutionEntity } from '../../../domain/entities/organization-analysis/organizationAnalysisEntity';
9
+ export declare class OrganizationAnalysisDomainResolutionTransformer {
10
+ fromAPIToEntity(resolution: OrganizationAnalysisDomainResolution): OrganizationAnalysisDomainResolutionEntity;
11
+ fromEntityToGraphQL(resolution: OrganizationAnalysisDomainResolutionEntity): OrganizationAnalysisDomainResolutionGraphQL;
12
+ }
@@ -0,0 +1,187 @@
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 declare enum ActionIntentEntity {
23
+ StopContact = "STOP_CONTACT",
24
+ AccessMyData = "ACCESS_MY_DATA",
25
+ DeleteMyData = "DELETE_MY_DATA",
26
+ LimitDataUse = "LIMIT_DATA_USE",
27
+ Other = "OTHER"
28
+ }
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 declare enum ActionFulfilmentMethodEntity {
39
+ Assisted = "ASSISTED",
40
+ Delegated = "DELEGATED"
41
+ }
42
+ /**
43
+ * Which source contributed an available action.
44
+ *
45
+ * @property Static Always-possible action for the virtual presence type.
46
+ * @property Analysis Derived from an analysis source's reported actions.
47
+ * @property Discovery Derived from a discovery scan (e.g. List-Unsubscribe).
48
+ *
49
+ * @enum
50
+ */
51
+ export declare enum ActionOriginEntity {
52
+ Static = "STATIC",
53
+ Analysis = "ANALYSIS",
54
+ Discovery = "DISCOVERY",
55
+ Unknown = "UNKNOWN"
56
+ }
57
+ /**
58
+ * Lifecycle status of a persisted action instance.
59
+ *
60
+ * @property Pending The action has been created but not yet started.
61
+ * @property InProgress The action is being performed.
62
+ * @property CompletedUnverified The action completed but has not been verified.
63
+ * @property CompletedVerified The action completed and has been verified.
64
+ * @property Failed The action failed to complete.
65
+ * @property RequiresUserInput The action requires further input from the user.
66
+ * @property Contradicted Subsequent evidence contradicts the action's completion.
67
+ *
68
+ * @enum
69
+ */
70
+ export declare enum ActionStatusEntity {
71
+ Pending = "PENDING",
72
+ InProgress = "IN_PROGRESS",
73
+ CompletedUnverified = "COMPLETED_UNVERIFIED",
74
+ CompletedVerified = "COMPLETED_VERIFIED",
75
+ Failed = "FAILED",
76
+ RequiresUserInput = "REQUIRES_USER_INPUT",
77
+ Contradicted = "CONTRADICTED",
78
+ Unknown = "UNKNOWN"
79
+ }
80
+ /**
81
+ * Contact materials for an assisted action.
82
+ *
83
+ * @interface ActionContactEntity
84
+ * @property {string} email Contact email address, when available.
85
+ * @property {string} phone Contact phone number, when available.
86
+ * @property {string} address Contact postal address, when available.
87
+ */
88
+ export interface ActionContactEntity {
89
+ email?: string;
90
+ phone?: string;
91
+ address?: string;
92
+ }
93
+ /**
94
+ * An email template returned for an assisted action. The body may contain
95
+ * placeholders (e.g. "{{fullName}}") for fields the user supplies client-side.
96
+ *
97
+ * @interface AssistedEmailTemplateEntity
98
+ * @property {string} subject Subject line for the email, when available.
99
+ * @property {string} body Body of the email; may contain placeholders.
100
+ */
101
+ export interface AssistedEmailTemplateEntity {
102
+ subject?: string;
103
+ body: string;
104
+ }
105
+ /**
106
+ * Materials for an assisted action. The service supplies the organisation
107
+ * contact points and any source-provided instructions, but never the user's own
108
+ * data.
109
+ *
110
+ * @interface AssistedPayloadEntity
111
+ * @property {string} toAddress Recipient address for an assisted email action.
112
+ * @property {string} unsubscribeUrl Unsubscribe URL, when available.
113
+ * @property {string} unsubscribeMailto Unsubscribe mailto link, when available.
114
+ * @property {ActionContactEntity} contact Organisation contact points, when available.
115
+ * @property {string} jurisdiction Jurisdiction relevant to the action, when available.
116
+ * @property {string} instructions Free-text instructions, potentially provided
117
+ * verbatim by an analysis source.
118
+ * @property {AssistedEmailTemplateEntity} emailTemplate An email template for the
119
+ * action, resolved from a deployment-time template store.
120
+ */
121
+ export interface AssistedPayloadEntity {
122
+ toAddress?: string;
123
+ unsubscribeUrl?: string;
124
+ unsubscribeMailto?: string;
125
+ contact?: ActionContactEntity;
126
+ jurisdiction?: string;
127
+ instructions?: string;
128
+ emailTemplate?: AssistedEmailTemplateEntity;
129
+ }
130
+ /**
131
+ * Core entity representation of a persisted, initiated action instance scoped to
132
+ * a data holder relationship.
133
+ *
134
+ * @interface ActionEntity
135
+ * @property {string} id Unique identifier associated with the action.
136
+ * @property {string} virtualPresenceId The virtual presence this action belongs to.
137
+ * @property {string} dataHolderId The data holder relationship this action is scoped to.
138
+ * @property {ActionIntentEntity} intent The user-facing intent of the action.
139
+ * @property {string} additionalInfo Additional info, populated when intent is `Other`.
140
+ * @property {ActionFulfilmentMethodEntity} fulfilmentMethod How the action is fulfilled.
141
+ * @property {ActionStatusEntity} status Current lifecycle status of the action.
142
+ * @property {AssistedPayloadEntity} assistedPayload Materials for an assisted action.
143
+ * Undefined for a delegated action.
144
+ * @property {Date} initiatedAt Date for when the action was initiated.
145
+ * @property {Date} completedAt Date for when the action completed.
146
+ * @property {string} owner Unique identifier of the user.
147
+ * @property {number} version Version of this entity. Increments on update.
148
+ * @property {Date} createdAt Date for when the action was created.
149
+ * @property {Date} updatedAt Date for when the action was last updated.
150
+ */
151
+ export interface ActionEntity {
152
+ id: string;
153
+ virtualPresenceId: string;
154
+ dataHolderId?: string;
155
+ intent: ActionIntentEntity;
156
+ additionalInfo?: string;
157
+ fulfilmentMethod: ActionFulfilmentMethodEntity;
158
+ status: ActionStatusEntity;
159
+ assistedPayload?: AssistedPayloadEntity;
160
+ initiatedAt?: Date;
161
+ completedAt?: Date;
162
+ owner: string;
163
+ version: number;
164
+ createdAt: Date;
165
+ updatedAt: Date;
166
+ }
167
+ /**
168
+ * Core entity representation of a derived, non-persisted action the user could
169
+ * take against a data holder. Produced at query time by merging static,
170
+ * analysis, and discovery sources.
171
+ *
172
+ * @interface AvailableActionEntity
173
+ * @property {ActionIntentEntity} intent The user-facing intent of the action.
174
+ * @property {string} additionalInfo Additional info, populated when intent is `Other`.
175
+ * @property {ActionFulfilmentMethodEntity} fulfilmentMethod How the action is fulfilled.
176
+ * @property {ActionOriginEntity} origin Which source contributed this action.
177
+ * @property {string} title Short presentation hint for the action's title.
178
+ * @property {string} description Short presentation hint describing the action.
179
+ */
180
+ export interface AvailableActionEntity {
181
+ intent: ActionIntentEntity;
182
+ additionalInfo?: string;
183
+ fulfilmentMethod: ActionFulfilmentMethodEntity;
184
+ origin: ActionOriginEntity;
185
+ title?: string;
186
+ description?: string;
187
+ }
@@ -0,0 +1,110 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { ActionSubscriber } from '../../../../public/typings/subscription';
7
+ import { ActionEntity, ActionFulfilmentMethodEntity, ActionIntentEntity, AvailableActionEntity } from './actionEntity';
8
+ /**
9
+ * Input for `ActionService.initiate` method.
10
+ *
11
+ * @interface InitiateActionInput
12
+ * @property {string} dataHolderId The data holder relationship to scope the action to.
13
+ * @property {ActionIntentEntity} intent The intent of the action to initiate.
14
+ * @property {ActionFulfilmentMethodEntity} fulfilmentMethod The fulfilment method the
15
+ * client was offered for this intent.
16
+ */
17
+ export interface InitiateActionInput {
18
+ dataHolderId: string;
19
+ intent: ActionIntentEntity;
20
+ fulfilmentMethod: ActionFulfilmentMethodEntity;
21
+ }
22
+ /**
23
+ * Input for `ActionService.listAvailable` method.
24
+ *
25
+ * @interface ListAvailableActionsInput
26
+ * @property {string} dataHolderId The data holder relationship to list available actions for.
27
+ */
28
+ export interface ListAvailableActionsInput {
29
+ dataHolderId: string;
30
+ }
31
+ /**
32
+ * Output for `ActionService.listAvailable` method.
33
+ *
34
+ * @interface ListAvailableActionsOutput
35
+ * @property {AvailableActionEntity[]} availableActions The list of available actions
36
+ * retrieved in this query.
37
+ * @property {string} nextToken A token generated by a previous call. This allows for pagination.
38
+ */
39
+ export interface ListAvailableActionsOutput {
40
+ availableActions: AvailableActionEntity[];
41
+ nextToken?: string;
42
+ }
43
+ /**
44
+ * Input for `ActionService.subscribe` method.
45
+ *
46
+ * @interface SubscribeToActionsInput
47
+ * @property {string} subscriptionId A unique identifier for this subscription.
48
+ * @property {string} owner The identifier of the owner to subscribe for.
49
+ * @property {ActionSubscriber} subscriber The subscriber to receive events.
50
+ */
51
+ export interface SubscribeToActionsInput {
52
+ subscriptionId: string;
53
+ owner: string;
54
+ subscriber: ActionSubscriber;
55
+ }
56
+ /**
57
+ * Core entity representation of an action service used in business logic.
58
+ * Used to initiate, confirm, and list actions against data holder relationships.
59
+ *
60
+ * @interface ActionService
61
+ */
62
+ export interface ActionService {
63
+ /**
64
+ * Initiate an action against a data holder relationship.
65
+ *
66
+ * @param {InitiateActionInput} input Parameters used to initiate the action.
67
+ * @returns {ActionEntity} The initiated action.
68
+ */
69
+ initiate(input: InitiateActionInput): Promise<ActionEntity>;
70
+ /**
71
+ * Read a single initiated action by id. Resolves an in-flight delegated
72
+ * action on read: if the action is still in progress, its outcome is polled
73
+ * and, once terminal, the action is updated to its verified result before
74
+ * being returned.
75
+ *
76
+ * @param {string} id The unique identifier of the action.
77
+ * @returns {ActionEntity | undefined} The action, or undefined if no action
78
+ * with the given id exists for the user.
79
+ */
80
+ get(id: string): Promise<ActionEntity | undefined>;
81
+ /**
82
+ * Confirm that an assisted or delegated action was completed, transitioning it
83
+ * from `CompletedUnverified` to `CompletedVerified`.
84
+ *
85
+ * @param {string} id The unique identifier of the action to confirm.
86
+ * @returns {ActionEntity} The confirmed action.
87
+ */
88
+ confirmOutcome(id: string): Promise<ActionEntity>;
89
+ /**
90
+ * Retrieve the list of actions currently available for a data holder relationship.
91
+ *
92
+ * @param {ListAvailableActionsInput} input Parameters used to list available actions.
93
+ * @returns {ListAvailableActionsOutput} A list of available actions. Can be empty if
94
+ * no actions are available.
95
+ */
96
+ listAvailable(input: ListAvailableActionsInput): Promise<ListAvailableActionsOutput>;
97
+ /**
98
+ * Subscribe to action status events.
99
+ *
100
+ * @param {SubscribeToActionsInput} input Parameters used to subscribe to action
101
+ * status events.
102
+ */
103
+ subscribe(input: SubscribeToActionsInput): Promise<void>;
104
+ /**
105
+ * Unsubscribe from action status events.
106
+ *
107
+ * @param {string} subscriptionId The unique identifier of the subscription to unsubscribe from.
108
+ */
109
+ unsubscribe(subscriptionId: string): void;
110
+ }
@@ -235,7 +235,7 @@ export interface CategorySignalsEntity {
235
235
  * @property {SignalValueEntity} supportsDataDeletionRequests Whether the organization supports data deletion requests.
236
236
  * @property {SignalValueEntity} supportsDataExport Whether the organization supports data export.
237
237
  * @property {SignalValueEntity} supportsSubscriptions Whether the organization supports subscription management.
238
- * @property {SignalValueEntity} sellsPersonalInformation Whether the organization sells personal information.
238
+ * @property {SignalValueEntity} supportsOptOutOfSale Whether the organization exposes an opt-out-of-sale control to users.
239
239
  * @property {SignalValueEntity} usesCookiesOrTracking Whether the organization uses cookies or tracking.
240
240
  * @property {SignalValueEntity} supportsTwoFactorAuth Whether the organization supports two-factor auth for logins.
241
241
  */
@@ -245,7 +245,7 @@ export interface CapabilitySignalsEntity {
245
245
  supportsDataDeletionRequests: SignalValueEntity;
246
246
  supportsDataExport: SignalValueEntity;
247
247
  supportsSubscriptions: SignalValueEntity;
248
- sellsPersonalInformation: SignalValueEntity;
248
+ supportsOptOutOfSale: SignalValueEntity;
249
249
  usesCookiesOrTracking: SignalValueEntity;
250
250
  supportsTwoFactorAuth: SignalValueEntity;
251
251
  }
@@ -277,6 +277,7 @@ export interface RiskIndicatorsEntity {
277
277
  * @enum
278
278
  */
279
279
  export declare enum OrganizationCategoryEntity {
280
+ AdultEntertainment = "AdultEntertainment",
280
281
  Automotive = "Automotive",
281
282
  Communications = "Communications",
282
283
  CommunityAndCharity = "CommunityAndCharity",
@@ -40,6 +40,7 @@ export interface DataHolderEntity {
40
40
  * @property MONITORED The data holder is being monitored.
41
41
  * @property ACTION_REQUESTED An action has been requested against this data holder.
42
42
  * @property RESOLVED The data holder has been resolved.
43
+ * @property ARCHIVED The data holder has been archived by the user.
43
44
  *
44
45
  * @enum
45
46
  */
@@ -47,6 +48,7 @@ export declare enum DataHolderProtectionStateEntity {
47
48
  Monitored = "MONITORED",
48
49
  ActionRequested = "ACTION_REQUESTED",
49
50
  Resolved = "RESOLVED",
51
+ Archived = "ARCHIVED",
50
52
  Unknown = "UNKNOWN"
51
53
  }
52
54
  /**
@@ -99,6 +99,22 @@ export interface DataHolderService {
99
99
  * search criteria. Can be empty if no scan summaries found.
100
100
  */
101
101
  listScanSummaries(input: ListDataHolderScanSummariesInput): Promise<ListDataHolderScanSummariesOutput>;
102
+ /**
103
+ * Archive a data holder, removing it from the user's active list.
104
+ *
105
+ * @param {string} id The unique identifier of the data holder to archive.
106
+ * @returns {DataHolderEntity} The archived data holder.
107
+ */
108
+ archive(id: string): Promise<DataHolderEntity>;
109
+ /**
110
+ * Unarchive a previously archived data holder, returning it to the
111
+ * `Monitored` state. Only a data holder in the `Archived` state may be
112
+ * unarchived.
113
+ *
114
+ * @param {string} id The unique identifier of the data holder to unarchive.
115
+ * @returns {DataHolderEntity} The unarchived data holder.
116
+ */
117
+ unarchive(id: string): Promise<DataHolderEntity>;
102
118
  /**
103
119
  * Subscribe to data holder state events.
104
120
  *
@@ -51,3 +51,18 @@ export declare enum OrganizationAnalysisModeEntity {
51
51
  Analyze = "ANALYZE",
52
52
  Fetch = "FETCH"
53
53
  }
54
+ /**
55
+ * Controls how `getOrganizationAnalysis` treats the requested domain before
56
+ * sources query their backing services.
57
+ *
58
+ * @property REGISTRABLE Reduce the domain to its registrable (eTLD+1) form before analysis,
59
+ * e.g. `mail.sub.example.co.uk` becomes `example.co.uk`.
60
+ * @property EXACT Analyze the domain verbatim, without reducing it to a registrable domain.
61
+ * Used to analyze a specific host/subdomain rather than the organization.
62
+ *
63
+ * @enum
64
+ */
65
+ export declare enum OrganizationAnalysisDomainResolutionEntity {
66
+ Registrable = "REGISTRABLE",
67
+ Exact = "EXACT"
68
+ }
@@ -3,18 +3,25 @@
3
3
  *
4
4
  * SPDX-License-Identifier: Apache-2.0
5
5
  */
6
- import { OrganizationAnalysisEntity, OrganizationAnalysisModeEntity } from './organizationAnalysisEntity';
6
+ import { OrganizationAnalysisDomainResolutionEntity, OrganizationAnalysisEntity, OrganizationAnalysisModeEntity } from './organizationAnalysisEntity';
7
7
  /**
8
8
  * Input for `OrganizationAnalysisService.getOrganizationAnalysis` method.
9
9
  *
10
10
  * @interface GetOrganizationAnalysisInput
11
11
  * @property {string} domain The domain to analyze.
12
+ * @property {string} name Organization name to analyze (e.g. "amazon", "stripe"). When it resolves
13
+ * to a domain it takes precedence over `domain`; `domain` remains required and is used as the
14
+ * fallback when the name cannot be resolved.
12
15
  * @property {OrganizationAnalysisModeEntity} mode How to obtain source results. When omitted,
13
16
  * the backend behaves as ANALYZE.
17
+ * @property {OrganizationAnalysisDomainResolutionEntity} resolution How the requested domain is
18
+ * treated before analysis.
14
19
  */
15
20
  export interface GetOrganizationAnalysisInput {
16
21
  domain: string;
22
+ name?: string;
17
23
  mode?: OrganizationAnalysisModeEntity;
24
+ resolution?: OrganizationAnalysisDomainResolutionEntity;
18
25
  }
19
26
  /**
20
27
  * Core entity representation of an organization analysis service used in business logic.
@@ -18,6 +18,8 @@
18
18
  * @property {Date} lastScannedAt Date for when the virtual presence was last scanned.
19
19
  * @property {string} lastScanFailureReason Reason the most recent completed scan failed (an error/exception name).
20
20
  * Undefined when the most recent completed scan succeeded (or none has completed).
21
+ * @property {DataHolderCountEntity} dataHolderCount Counts of this virtual presence's data holders,
22
+ * broken down by protection state.
21
23
  * @property {Date} createdAt Date for when the virtual presence was created.
22
24
  * @property {Date} updatedAt Date for when the virtual presence was last updated.
23
25
  */
@@ -30,9 +32,31 @@ export interface VirtualPresenceEntity {
30
32
  state: VirtualPresenceStateEntity;
31
33
  lastScannedAt: Date;
32
34
  lastScanFailureReason?: string;
35
+ dataHolderCount: DataHolderCountEntity;
33
36
  createdAt: Date;
34
37
  updatedAt: Date;
35
38
  }
39
+ /**
40
+ * Core entity representation of a virtual presence's data holder counts,
41
+ * broken down by protection state.
42
+ *
43
+ * @interface DataHolderCountEntity
44
+ * @property {number} count Active (non-archived) data holders: the sum of monitored,
45
+ * initiatedActions, and completedActions. Excludes archived.
46
+ * @property {number} monitored Data holders the system has identified (protection state Monitored).
47
+ * @property {number} initiatedActions Data holders with an action in progress
48
+ * (protection state ActionRequested).
49
+ * @property {number} completedActions Data holders whose action has completed
50
+ * (protection state Resolved).
51
+ * @property {number} archived Data holders the user has archived (protection state Archived).
52
+ */
53
+ export interface DataHolderCountEntity {
54
+ count: number;
55
+ monitored: number;
56
+ initiatedActions: number;
57
+ completedActions: number;
58
+ archived: number;
59
+ }
36
60
  /**
37
61
  * Enumeration that defines the provider type of the virtual presence.
38
62
  *
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { ActionEntity } from '../../entities/action/actionEntity';
7
+ import { ActionService } from '../../entities/action/actionService';
8
+ /**
9
+ * Application business logic for confirming that an action was completed.
10
+ */
11
+ export declare class ConfirmActionOutcomeUseCase {
12
+ private readonly actionService;
13
+ private readonly log;
14
+ constructor(actionService: ActionService);
15
+ execute(id: string): Promise<ActionEntity>;
16
+ }
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { ActionEntity } from '../../entities/action/actionEntity';
7
+ import { ActionService } from '../../entities/action/actionService';
8
+ /**
9
+ * Application business logic for retrieving a single action.
10
+ */
11
+ export declare class GetActionUseCase {
12
+ private readonly actionService;
13
+ private readonly log;
14
+ constructor(actionService: ActionService);
15
+ execute(id: string): Promise<ActionEntity | undefined>;
16
+ }
@@ -0,0 +1,17 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { ActionEntity } from '../../entities/action/actionEntity';
7
+ import { ActionService, InitiateActionInput } from '../../entities/action/actionService';
8
+ /**
9
+ * Application business logic for initiating an action against a data holder
10
+ * relationship.
11
+ */
12
+ export declare class InitiateActionUseCase {
13
+ private readonly actionService;
14
+ private readonly log;
15
+ constructor(actionService: ActionService);
16
+ execute(input: InitiateActionInput): Promise<ActionEntity>;
17
+ }
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { ActionService, ListAvailableActionsInput, ListAvailableActionsOutput } from '../../entities/action/actionService';
7
+ /**
8
+ * Application business logic for listing the actions available for a data holder
9
+ * relationship.
10
+ */
11
+ export declare class ListAvailableActionsUseCase {
12
+ private readonly actionService;
13
+ private readonly log;
14
+ constructor(actionService: ActionService);
15
+ execute(input: ListAvailableActionsInput): Promise<ListAvailableActionsOutput>;
16
+ }
@@ -0,0 +1,27 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { SudoUserClient } from '@sudoplatform/sudo-user';
7
+ import { ActionSubscriber } from '../../../../public/typings/subscription';
8
+ import { ActionService } from '../../entities/action/actionService';
9
+ /**
10
+ * Input for `SubscribeToActionUseCase`.
11
+ *
12
+ * @interface SubscribeToActionUseCaseInput
13
+ */
14
+ export interface SubscribeToActionUseCaseInput {
15
+ subscriptionId: string;
16
+ subscriber: ActionSubscriber;
17
+ }
18
+ /**
19
+ * Application business logic for subscribing to action status events.
20
+ */
21
+ export declare class SubscribeToActionUseCase {
22
+ private readonly actionService;
23
+ private readonly sudoUserClient;
24
+ private readonly log;
25
+ constructor(actionService: ActionService, sudoUserClient: SudoUserClient);
26
+ execute(input: SubscribeToActionUseCaseInput): Promise<void>;
27
+ }
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { ActionService } from '../../entities/action/actionService';
7
+ /**
8
+ * Application business logic for unsubscribing from action status events.
9
+ */
10
+ export declare class UnsubscribeFromActionUseCase {
11
+ private readonly actionService;
12
+ private readonly log;
13
+ constructor(actionService: ActionService);
14
+ execute(subscriptionId: string): void;
15
+ }