@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,16 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { DataHolderEntity } from '../../entities/data-holder/dataHolderEntity';
7
+ import { DataHolderService } from '../../entities/data-holder/dataHolderService';
8
+ /**
9
+ * Application business logic for archiving a data holder.
10
+ */
11
+ export declare class ArchiveDataHolderUseCase {
12
+ private readonly dataHolderService;
13
+ private readonly log;
14
+ constructor(dataHolderService: DataHolderService);
15
+ execute(id: string): Promise<DataHolderEntity>;
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 { DataHolderEntity } from '../../entities/data-holder/dataHolderEntity';
7
+ import { DataHolderService } from '../../entities/data-holder/dataHolderService';
8
+ /**
9
+ * Application business logic for unarchiving a data holder.
10
+ */
11
+ export declare class UnarchiveDataHolderUseCase {
12
+ private readonly dataHolderService;
13
+ private readonly log;
14
+ constructor(dataHolderService: DataHolderService);
15
+ execute(id: string): Promise<DataHolderEntity>;
16
+ }
@@ -4,9 +4,9 @@
4
4
  * SPDX-License-Identifier: Apache-2.0
5
5
  */
6
6
  import { ListOutput } from '@sudoplatform/sudo-common';
7
- import { ConnectVirtualPresenceWithAuthCodeInput, ConnectVirtualPresenceWithRefreshTokenInput, GetDataHolderOptions, GetOrganizationAnalysisInput, ListAnalysisResultsInput, ListDataHolderScanSummariesInput, ListDataHoldersInput, ListVirtualPresencesInput, RescanVirtualPresenceInput } from './inputs';
7
+ import { ConnectVirtualPresenceWithAuthCodeInput, ConnectVirtualPresenceWithRefreshTokenInput, GetDataHolderOptions, GetOrganizationAnalysisInput, InitiateActionInput, ListAnalysisResultsInput, ListAvailableActionsInput, ListDataHolderScanSummariesInput, ListDataHoldersInput, ListVirtualPresencesInput, RescanVirtualPresenceInput } from './inputs';
8
8
  import { SudoPrivacyInteractionClient, SudoPrivacyInteractionClientOptions } from './sudoPrivacyInteractionClient';
9
- import { AnalysisResult, AnalysisResultSubscriber, DataHolder, DataHolderScanSummary, DataHolderSubscriber, OrganizationAnalysis, ProviderConfiguration, VirtualPresence, VirtualPresenceSubscriber } from './typings';
9
+ import { Action, AnalysisResult, AnalysisResultSubscriber, ActionSubscriber, AvailableAction, DataHolder, DataHolderScanSummary, DataHolderSubscriber, OrganizationAnalysis, ProviderConfiguration, VirtualPresence, VirtualPresenceSubscriber } from './typings';
10
10
  export declare class DefaultSudoPrivacyInteractionClient implements SudoPrivacyInteractionClient {
11
11
  private readonly apiClient;
12
12
  private readonly userClient;
@@ -15,6 +15,7 @@ export declare class DefaultSudoPrivacyInteractionClient implements SudoPrivacyI
15
15
  private readonly dataHolderService;
16
16
  private readonly analysisResultService;
17
17
  private readonly organizationAnalysisService;
18
+ private readonly actionService;
18
19
  private readonly providerConfigurationTransformer;
19
20
  private readonly virtualPresenceTransformer;
20
21
  private readonly relationshipProviderTransformer;
@@ -23,6 +24,11 @@ export declare class DefaultSudoPrivacyInteractionClient implements SudoPrivacyI
23
24
  private readonly analysisResultTransformer;
24
25
  private readonly organizationAnalysisTransformer;
25
26
  private readonly organizationAnalysisModeTransformer;
27
+ private readonly organizationAnalysisDomainResolutionTransformer;
28
+ private readonly actionTransformer;
29
+ private readonly availableActionTransformer;
30
+ private readonly actionIntentTransformer;
31
+ private readonly actionFulfilmentMethodTransformer;
26
32
  private readonly log;
27
33
  constructor(opts: SudoPrivacyInteractionClientOptions);
28
34
  getProviderConfiguration(): Promise<ProviderConfiguration[]>;
@@ -36,6 +42,8 @@ export declare class DefaultSudoPrivacyInteractionClient implements SudoPrivacyI
36
42
  getDataHolder(id: string, options?: GetDataHolderOptions): Promise<DataHolder | undefined>;
37
43
  listDataHolders(input: ListDataHoldersInput): Promise<ListOutput<DataHolder>>;
38
44
  listDataHolderScanSummaries(input: ListDataHolderScanSummariesInput): Promise<ListOutput<DataHolderScanSummary>>;
45
+ archiveDataHolder(id: string): Promise<DataHolder>;
46
+ unarchiveDataHolder(id: string): Promise<DataHolder>;
39
47
  subscribeToDataHolders(subscriptionId: string, subscriber: DataHolderSubscriber): Promise<void>;
40
48
  unsubscribeFromDataHolders(subscriptionId: string): void;
41
49
  getAnalysisResult(id: string): Promise<AnalysisResult | undefined>;
@@ -43,4 +51,10 @@ export declare class DefaultSudoPrivacyInteractionClient implements SudoPrivacyI
43
51
  subscribeToAnalysisResult(subscriptionId: string, subscriber: AnalysisResultSubscriber): Promise<void>;
44
52
  unsubscribeFromAnalysisResult(subscriptionId: string): void;
45
53
  getOrganizationAnalysis(input: GetOrganizationAnalysisInput): Promise<OrganizationAnalysis | undefined>;
54
+ initiateAction(input: InitiateActionInput): Promise<Action>;
55
+ getAction(id: string): Promise<Action | undefined>;
56
+ confirmActionOutcome(id: string): Promise<Action>;
57
+ listAvailableActions(input: ListAvailableActionsInput): Promise<ListOutput<AvailableAction>>;
58
+ subscribeToActions(subscriptionId: string, subscriber: ActionSubscriber): Promise<void>;
59
+ unsubscribeFromActions(subscriptionId: string): void;
46
60
  }
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { ActionFulfilmentMethod, ActionIntent } from '../typings/action';
7
+ /**
8
+ * Properties required to initiate an action against a data holder relationship.
9
+ *
10
+ * @interface InitiateActionInput
11
+ * @property {string} dataHolderId The data holder relationship to scope the action to.
12
+ * @property {ActionIntent} intent The intent of the action to initiate.
13
+ * @property {ActionFulfilmentMethod} fulfilmentMethod The fulfilment method the client
14
+ * was offered for this intent. Initiation fails if the server re-resolves a different
15
+ * method.
16
+ */
17
+ export interface InitiateActionInput {
18
+ dataHolderId: string;
19
+ intent: ActionIntent;
20
+ fulfilmentMethod: ActionFulfilmentMethod;
21
+ }
22
+ /**
23
+ * Properties required to list the actions available for a data holder relationship.
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
+ }
@@ -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';
@@ -3,16 +3,23 @@
3
3
  *
4
4
  * SPDX-License-Identifier: Apache-2.0
5
5
  */
6
- import { OrganizationAnalysisMode } from '../typings/organizationAnalysis';
6
+ import { OrganizationAnalysisDomainResolution, OrganizationAnalysisMode } from '../typings/organizationAnalysis';
7
7
  /**
8
8
  * Properties required to obtain an organization analysis.
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 {OrganizationAnalysisMode} mode How to obtain source results. When omitted, the
13
16
  * backend behaves as `Analyze` (read-through).
17
+ * @property {OrganizationAnalysisDomainResolution} resolution How the requested domain is treated
18
+ * before analysis. When omitted, defaults to `Exact` (the domain is analyzed verbatim).
14
19
  */
15
20
  export interface GetOrganizationAnalysisInput {
16
21
  domain: string;
22
+ name?: string;
17
23
  mode?: OrganizationAnalysisMode;
24
+ resolution?: OrganizationAnalysisDomainResolution;
18
25
  }
@@ -5,8 +5,8 @@
5
5
  */
6
6
  import { ListOutput } from '@sudoplatform/sudo-common';
7
7
  import { SudoUserClient } from '@sudoplatform/sudo-user';
8
- import { ConnectVirtualPresenceWithAuthCodeInput, ConnectVirtualPresenceWithRefreshTokenInput, GetDataHolderOptions, GetOrganizationAnalysisInput, ListAnalysisResultsInput, ListDataHolderScanSummariesInput, ListDataHoldersInput, ListVirtualPresencesInput, RescanVirtualPresenceInput } from './inputs';
9
- import { AnalysisResult, AnalysisResultSubscriber, DataHolder, DataHolderScanSummary, DataHolderSubscriber, OrganizationAnalysis, ProviderConfiguration, VirtualPresence, VirtualPresenceSubscriber } from './typings';
8
+ import { ConnectVirtualPresenceWithAuthCodeInput, ConnectVirtualPresenceWithRefreshTokenInput, GetDataHolderOptions, GetOrganizationAnalysisInput, InitiateActionInput, ListAnalysisResultsInput, ListAvailableActionsInput, ListDataHolderScanSummariesInput, ListDataHoldersInput, ListVirtualPresencesInput, RescanVirtualPresenceInput } from './inputs';
9
+ import { Action, AnalysisResult, AnalysisResultSubscriber, ActionSubscriber, AvailableAction, DataHolder, DataHolderScanSummary, DataHolderSubscriber, OrganizationAnalysis, ProviderConfiguration, VirtualPresence, VirtualPresenceSubscriber } from './typings';
10
10
  export interface SudoPrivacyInteractionClient {
11
11
  /**
12
12
  * Retrieve the provider configurations required by consumers to support
@@ -91,6 +91,22 @@ export interface SudoPrivacyInteractionClient {
91
91
  * search criteria.
92
92
  */
93
93
  listDataHolderScanSummaries(input: ListDataHolderScanSummariesInput): Promise<ListOutput<DataHolderScanSummary>>;
94
+ /**
95
+ * Archive a data holder, removing it from the user's active list.
96
+ *
97
+ * @param {string} id The unique identifier of the data holder to archive.
98
+ * @returns {DataHolder} The archived data holder.
99
+ */
100
+ archiveDataHolder(id: string): Promise<DataHolder>;
101
+ /**
102
+ * Unarchive a previously archived data holder, returning it to the
103
+ * `Monitored` state. Only a data holder in the `Archived` state may be
104
+ * unarchived.
105
+ *
106
+ * @param {string} id The unique identifier of the data holder to unarchive.
107
+ * @returns {DataHolder} The unarchived data holder.
108
+ */
109
+ unarchiveDataHolder(id: string): Promise<DataHolder>;
94
110
  /**
95
111
  * Subscribe to data holder state events. Emitted when data holders are discovered
96
112
  * or updated during scanning.
@@ -145,6 +161,56 @@ export interface SudoPrivacyInteractionClient {
145
161
  * @returns {OrganizationAnalysis | undefined} The organization analysis, or undefined if not found.
146
162
  */
147
163
  getOrganizationAnalysis(input: GetOrganizationAnalysisInput): Promise<OrganizationAnalysis | undefined>;
164
+ /**
165
+ * Initiate an action against a data holder relationship. Delegated actions are
166
+ * performed on the user's behalf; assisted actions return structured materials
167
+ * for the client to complete.
168
+ *
169
+ * @param {InitiateActionInput} input Parameters used to initiate the action.
170
+ * @returns {Action} The initiated action.
171
+ */
172
+ initiateAction(input: InitiateActionInput): Promise<Action>;
173
+ /**
174
+ * Read a single initiated action by id. Resolves an in-flight delegated
175
+ * action on read: if the action is still in progress, its outcome is polled
176
+ * and, once terminal, the action is updated to its verified result before
177
+ * being returned.
178
+ *
179
+ * @param {string} id The unique identifier of the action.
180
+ * @returns {Action | undefined} The action, or undefined if no action with the
181
+ * given id exists for the user.
182
+ */
183
+ getAction(id: string): Promise<Action | undefined>;
184
+ /**
185
+ * Confirm that an assisted or delegated action was completed, transitioning it
186
+ * from `CompletedUnverified` to `CompletedVerified`.
187
+ *
188
+ * @param {string} id The unique identifier of the action to confirm.
189
+ * @returns {Action} The confirmed action.
190
+ */
191
+ confirmActionOutcome(id: string): Promise<Action>;
192
+ /**
193
+ * List the actions currently available for a data holder relationship.
194
+ *
195
+ * @param {ListAvailableActionsInput} input Parameters used to list available actions.
196
+ * @returns {ListOutput<AvailableAction>} A list of available actions matching the
197
+ * search criteria.
198
+ */
199
+ listAvailableActions(input: ListAvailableActionsInput): Promise<ListOutput<AvailableAction>>;
200
+ /**
201
+ * Subscribe to action status events. Emitted each time an action's status changes.
202
+ *
203
+ * @param {string} subscriptionId A unique identifier for this subscription.
204
+ * @param {ActionSubscriber} subscriber Callback implementation to be invoked when
205
+ * an action event occurs.
206
+ */
207
+ subscribeToActions(subscriptionId: string, subscriber: ActionSubscriber): Promise<void>;
208
+ /**
209
+ * Unsubscribe from action status events.
210
+ *
211
+ * @param {string} subscriptionId The subscription identifier to unsubscribe.
212
+ */
213
+ unsubscribeFromActions(subscriptionId: string): void;
148
214
  }
149
215
  export type SudoPrivacyInteractionClientOptions = {
150
216
  /** Sudo User client to use. No default */
@@ -0,0 +1,185 @@
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 declare enum ActionIntent {
22
+ StopContact = "STOP_CONTACT",
23
+ AccessMyData = "ACCESS_MY_DATA",
24
+ DeleteMyData = "DELETE_MY_DATA",
25
+ LimitDataUse = "LIMIT_DATA_USE",
26
+ Other = "OTHER"
27
+ }
28
+ /**
29
+ * How an action is fulfilled from the user's perspective.
30
+ *
31
+ * @property ASSISTED The service returns structured materials for the client to
32
+ * complete the action.
33
+ * @property DELEGATED The service performs the action on the user's behalf.
34
+ *
35
+ * @enum
36
+ */
37
+ export declare enum ActionFulfilmentMethod {
38
+ Assisted = "ASSISTED",
39
+ Delegated = "DELEGATED"
40
+ }
41
+ /**
42
+ * Which source contributed an available action.
43
+ *
44
+ * @property STATIC Always-possible action for the virtual presence type.
45
+ * @property ANALYSIS Derived from an analysis source's reported actions.
46
+ * @property DISCOVERY Derived from a discovery scan (e.g. List-Unsubscribe).
47
+ *
48
+ * @enum
49
+ */
50
+ export declare enum ActionOrigin {
51
+ Static = "STATIC",
52
+ Analysis = "ANALYSIS",
53
+ Discovery = "DISCOVERY",
54
+ Unknown = "UNKNOWN"
55
+ }
56
+ /**
57
+ * Lifecycle status of a persisted action instance.
58
+ *
59
+ * @property PENDING The action has been created but not yet started.
60
+ * @property IN_PROGRESS The action is being performed.
61
+ * @property COMPLETED_UNVERIFIED The action completed but has not been verified.
62
+ * @property COMPLETED_VERIFIED The action completed and has been verified.
63
+ * @property FAILED The action failed to complete.
64
+ * @property REQUIRES_USER_INPUT The action requires further input from the user.
65
+ * @property CONTRADICTED Subsequent evidence contradicts the action's completion.
66
+ *
67
+ * @enum
68
+ */
69
+ export declare enum ActionStatus {
70
+ Pending = "PENDING",
71
+ InProgress = "IN_PROGRESS",
72
+ CompletedUnverified = "COMPLETED_UNVERIFIED",
73
+ CompletedVerified = "COMPLETED_VERIFIED",
74
+ Failed = "FAILED",
75
+ RequiresUserInput = "REQUIRES_USER_INPUT",
76
+ Contradicted = "CONTRADICTED",
77
+ Unknown = "UNKNOWN"
78
+ }
79
+ /**
80
+ * Contact materials for an assisted action.
81
+ *
82
+ * @interface ActionContact
83
+ * @property {string} email Contact email address, when available.
84
+ * @property {string} phone Contact phone number, when available.
85
+ * @property {string} address Contact postal address, when available.
86
+ */
87
+ export interface ActionContact {
88
+ email?: string;
89
+ phone?: string;
90
+ address?: string;
91
+ }
92
+ /**
93
+ * An email template returned for an assisted action. The body may contain
94
+ * placeholders (e.g. "{{fullName}}") for fields the user supplies client-side.
95
+ *
96
+ * @interface AssistedEmailTemplate
97
+ * @property {string} subject Subject line for the email, when available.
98
+ * @property {string} body Body of the email; may contain placeholders.
99
+ */
100
+ export interface AssistedEmailTemplate {
101
+ subject?: string;
102
+ body: string;
103
+ }
104
+ /**
105
+ * Materials for an assisted action. The service supplies the organisation
106
+ * contact points and any source-provided instructions, but never the user's own
107
+ * data.
108
+ *
109
+ * @interface AssistedPayload
110
+ * @property {string} toAddress Recipient address for an assisted email action.
111
+ * @property {string} unsubscribeUrl Unsubscribe URL, when available.
112
+ * @property {string} unsubscribeMailto Unsubscribe mailto link, when available.
113
+ * @property {ActionContact} contact Organisation contact points, when available.
114
+ * @property {string} jurisdiction Jurisdiction relevant to the action, when available.
115
+ * @property {string} instructions Free-text instructions, potentially provided
116
+ * verbatim by an analysis source.
117
+ * @property {AssistedEmailTemplate} emailTemplate An email template for the action,
118
+ * resolved from a deployment-time template store.
119
+ */
120
+ export interface AssistedPayload {
121
+ toAddress?: string;
122
+ unsubscribeUrl?: string;
123
+ unsubscribeMailto?: string;
124
+ contact?: ActionContact;
125
+ jurisdiction?: string;
126
+ instructions?: string;
127
+ emailTemplate?: AssistedEmailTemplate;
128
+ }
129
+ /**
130
+ * The Sudo Platform SDK representation of a persisted, initiated action instance
131
+ * scoped to a data holder relationship.
132
+ *
133
+ * @interface Action
134
+ * @property {string} id Unique identifier associated with the action.
135
+ * @property {string} virtualPresenceId The virtual presence this action belongs to.
136
+ * @property {string} dataHolderId The data holder relationship this action is scoped to.
137
+ * @property {ActionIntent} intent The user-facing intent of the action.
138
+ * @property {string} additionalInfo Additional info, populated when intent is `Other`.
139
+ * @property {ActionFulfilmentMethod} fulfilmentMethod How the action is fulfilled.
140
+ * @property {ActionStatus} status Current lifecycle status of the action.
141
+ * @property {AssistedPayload} assistedPayload Materials for an assisted action.
142
+ * Undefined for a delegated action.
143
+ * @property {Date} initiatedAt Date for when the action was initiated.
144
+ * @property {Date} completedAt Date for when the action completed.
145
+ * @property {string} owner Unique identifier of the user.
146
+ * @property {number} version Version of this entity. Increments on update.
147
+ * @property {Date} createdAt Date for when the action was created.
148
+ * @property {Date} updatedAt Date for when the action was last updated.
149
+ */
150
+ export interface Action {
151
+ id: string;
152
+ virtualPresenceId: string;
153
+ dataHolderId?: string;
154
+ intent: ActionIntent;
155
+ additionalInfo?: string;
156
+ fulfilmentMethod: ActionFulfilmentMethod;
157
+ status: ActionStatus;
158
+ assistedPayload?: AssistedPayload;
159
+ initiatedAt?: Date;
160
+ completedAt?: Date;
161
+ owner: string;
162
+ version: number;
163
+ createdAt: Date;
164
+ updatedAt: Date;
165
+ }
166
+ /**
167
+ * The Sudo Platform SDK representation of a derived, non-persisted action the
168
+ * user could take against a data holder.
169
+ *
170
+ * @interface AvailableAction
171
+ * @property {ActionIntent} intent The user-facing intent of the action.
172
+ * @property {string} additionalInfo Additional info, populated when intent is `Other`.
173
+ * @property {ActionFulfilmentMethod} fulfilmentMethod How the action is fulfilled.
174
+ * @property {ActionOrigin} origin Which source contributed this action.
175
+ * @property {string} title Short presentation hint for the action's title.
176
+ * @property {string} description Short presentation hint describing the action.
177
+ */
178
+ export interface AvailableAction {
179
+ intent: ActionIntent;
180
+ additionalInfo?: string;
181
+ fulfilmentMethod: ActionFulfilmentMethod;
182
+ origin: ActionOrigin;
183
+ title?: string;
184
+ description?: string;
185
+ }
@@ -260,7 +260,9 @@ export interface CategorySignals {
260
260
  * @property {SignalValue} supportsDataDeletionRequests Whether the organization supports data deletion requests.
261
261
  * @property {SignalValue} supportsDataExport Whether the organization supports data export.
262
262
  * @property {SignalValue} supportsSubscriptions Whether the organization supports subscription management.
263
+ * @property {SignalValue} supportsOptOutOfSale Whether the organization exposes an opt-out-of-sale control to users.
263
264
  * @property {SignalValue} sellsPersonalInformation Whether the organization sells personal information.
265
+ * @deprecated Use {@link CapabilitySignals.supportsOptOutOfSale} instead. Populated from `supportsOptOutOfSale`.
264
266
  * @property {SignalValue} usesCookiesOrTracking Whether the organization uses cookies or tracking.
265
267
  * @property {SignalValue} supportsTwoFactorAuth Whether the organization supports two-factor auth for logins.
266
268
  */
@@ -270,6 +272,11 @@ export interface CapabilitySignals {
270
272
  supportsDataDeletionRequests: SignalValue;
271
273
  supportsDataExport: SignalValue;
272
274
  supportsSubscriptions: SignalValue;
275
+ supportsOptOutOfSale: SignalValue;
276
+ /**
277
+ * @deprecated Use {@link CapabilitySignals.supportsOptOutOfSale} instead.
278
+ * Populated from the `supportsOptOutOfSale` value.
279
+ */
273
280
  sellsPersonalInformation: SignalValue;
274
281
  usesCookiesOrTracking: SignalValue;
275
282
  supportsTwoFactorAuth: SignalValue;
@@ -302,6 +309,7 @@ export interface RiskIndicators {
302
309
  * @enum
303
310
  */
304
311
  export declare enum OrganizationCategory {
312
+ AdultEntertainment = "AdultEntertainment",
305
313
  Automotive = "Automotive",
306
314
  Communications = "Communications",
307
315
  CommunityAndCharity = "CommunityAndCharity",
@@ -44,6 +44,7 @@ export interface DataHolder {
44
44
  * @property MONITORED The data holder is being monitored.
45
45
  * @property ACTION_REQUESTED An action has been requested against this data holder.
46
46
  * @property RESOLVED The data holder has been resolved.
47
+ * @property ARCHIVED The data holder has been archived by the user.
47
48
  *
48
49
  * @enum
49
50
  */
@@ -51,6 +52,7 @@ export declare enum DataHolderProtectionState {
51
52
  Monitored = "MONITORED",
52
53
  ActionRequested = "ACTION_REQUESTED",
53
54
  Resolved = "RESOLVED",
55
+ Archived = "ARCHIVED",
54
56
  Unknown = "UNKNOWN"
55
57
  }
56
58
  /**
@@ -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';
@@ -51,3 +51,18 @@ export declare enum OrganizationAnalysisMode {
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 OrganizationAnalysisDomainResolution {
66
+ Registrable = "REGISTRABLE",
67
+ Exact = "EXACT"
68
+ }
@@ -3,6 +3,7 @@
3
3
  *
4
4
  * SPDX-License-Identifier: Apache-2.0
5
5
  */
6
+ import { Action } from './action';
6
7
  import { AnalysisResultUpdate } from './analysisResult';
7
8
  import { DataHolder } from './dataHolder';
8
9
  import { VirtualPresence } from './virtualPresence';
@@ -84,3 +85,25 @@ export interface AnalysisResultSubscriber {
84
85
  */
85
86
  connectionStatusChanged(state: ConnectionState): void;
86
87
  }
88
+ /**
89
+ * Subscriber interface for receiving action status update events.
90
+ *
91
+ * @interface ActionSubscriber
92
+ */
93
+ export interface ActionSubscriber {
94
+ /**
95
+ * Notifies the subscriber of an action status update.
96
+ *
97
+ * @param {Action} action The updated action.
98
+ */
99
+ actionUpdated(action: Action): void;
100
+ /**
101
+ * Notifies the subscriber that the subscription connection state has changed.
102
+ * The subscriber won't be notified of action changes until the connection
103
+ * status changes to `ConnectionState.CONNECTED`. The subscriber will stop receiving
104
+ * action change notifications when the connection state changes to `ConnectionState.DISCONNECTED`.
105
+ *
106
+ * @param state The connection state.
107
+ */
108
+ connectionStatusChanged(state: ConnectionState): void;
109
+ }
@@ -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 {DataHolderCount} 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,32 @@ export interface VirtualPresence {
30
32
  state: VirtualPresenceState;
31
33
  lastScannedAt: Date;
32
34
  lastScanFailureReason?: string;
35
+ dataHolderCount: DataHolderCount;
33
36
  createdAt: Date;
34
37
  updatedAt: Date;
35
38
  }
39
+ /**
40
+ * Counts of a virtual presence's data holders, broken down by protection state.
41
+ *
42
+ * @interface DataHolderCount
43
+ * @property {number} count Active (non-archived) data holders: the sum of monitored,
44
+ * initiatedActions, and completedActions. Excludes archived.
45
+ * @property {number} monitored Data holders the system has identified
46
+ * (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
52
+ * (protection state Archived).
53
+ */
54
+ export interface DataHolderCount {
55
+ count: number;
56
+ monitored: number;
57
+ initiatedActions: number;
58
+ completedActions: number;
59
+ archived: number;
60
+ }
36
61
  /**
37
62
  * Enumeration that defines the provider type of the virtual presence.
38
63
  *