@sudoplatform/sudo-privacy-interaction 2.1.0 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (98) hide show
  1. package/cjs/gen/graphqlTypes.js +557 -1
  2. package/cjs/private/data/action/actionSubscriptionManager.js +25 -0
  3. package/cjs/private/data/action/defaultActionService.js +80 -0
  4. package/cjs/private/data/action/transformer/actionFulfilmentMethodTransformer.js +47 -0
  5. package/cjs/private/data/action/transformer/actionIntentTransformer.js +69 -0
  6. package/cjs/private/data/action/transformer/actionOriginTransformer.js +37 -0
  7. package/cjs/private/data/action/transformer/actionStatusTransformer.js +53 -0
  8. package/cjs/private/data/action/transformer/actionTransformer.js +85 -0
  9. package/cjs/private/data/action/transformer/availableActionTransformer.js +37 -0
  10. package/cjs/private/data/common/apiClient.js +35 -0
  11. package/cjs/private/domain/entities/action/actionEntity.js +86 -0
  12. package/cjs/private/domain/entities/action/actionService.js +7 -0
  13. package/cjs/private/domain/use-cases/action/confirmActionOutcomeUseCase.js +25 -0
  14. package/cjs/private/domain/use-cases/action/initiateActionUseCase.js +26 -0
  15. package/cjs/private/domain/use-cases/action/listAvailableActionsUseCase.js +26 -0
  16. package/cjs/private/domain/use-cases/action/subscribeToActionUseCase.js +37 -0
  17. package/cjs/private/domain/use-cases/action/unsubscribeFromActionUseCase.js +27 -0
  18. package/cjs/public/defaultSudoPrivacyInteractionClient.js +58 -0
  19. package/cjs/public/inputs/action.js +7 -0
  20. package/cjs/public/inputs/index.js +1 -0
  21. package/cjs/public/typings/action.js +85 -0
  22. package/cjs/public/typings/index.js +1 -0
  23. package/docs/assets/hierarchy.js +1 -1
  24. package/docs/assets/navigation.js +1 -1
  25. package/docs/assets/search.js +1 -1
  26. package/docs/classes/DefaultSudoPrivacyInteractionClient.html +128 -22
  27. package/docs/enums/ActionFulfilmentMethod.html +63 -0
  28. package/docs/enums/ActionIntent.html +84 -0
  29. package/docs/enums/ActionOrigin.html +75 -0
  30. package/docs/enums/ActionStatus.html +99 -0
  31. package/docs/enums/ConnectionState.html +3 -3
  32. package/docs/hierarchy.html +6 -6
  33. package/docs/interfaces/Action.html +167 -0
  34. package/docs/interfaces/ActionContact.html +77 -0
  35. package/docs/interfaces/ActionSubscriber.html +92 -0
  36. package/docs/interfaces/AnalysisResultSubscriber.html +3 -3
  37. package/docs/interfaces/AssistedEmailTemplate.html +70 -0
  38. package/docs/interfaces/AssistedPayload.html +113 -0
  39. package/docs/interfaces/AvailableAction.html +102 -0
  40. package/docs/interfaces/DataHolderSubscriber.html +3 -3
  41. package/docs/interfaces/InitiateActionInput.html +79 -0
  42. package/docs/interfaces/ListAnalysisResultsInput.html +1 -1
  43. package/docs/interfaces/ListAvailableActionsInput.html +61 -0
  44. package/docs/interfaces/ListDataHolderScanSummariesInput.html +1 -1
  45. package/docs/interfaces/ListDataHoldersInput.html +1 -1
  46. package/docs/interfaces/ListVirtualPresencesInput.html +1 -1
  47. package/docs/interfaces/Pagination.html +1 -1
  48. package/docs/interfaces/SudoPrivacyInteractionClient.html +123 -22
  49. package/docs/interfaces/VirtualPresenceSubscriber.html +3 -3
  50. package/docs/modules.html +4 -4
  51. package/docs/types/SudoPrivacyInteractionClientOptions.html +2 -2
  52. package/lib/gen/graphqlTypes.js +556 -0
  53. package/lib/private/data/action/actionSubscriptionManager.js +21 -0
  54. package/lib/private/data/action/defaultActionService.js +76 -0
  55. package/lib/private/data/action/transformer/actionFulfilmentMethodTransformer.js +43 -0
  56. package/lib/private/data/action/transformer/actionIntentTransformer.js +65 -0
  57. package/lib/private/data/action/transformer/actionOriginTransformer.js +33 -0
  58. package/lib/private/data/action/transformer/actionStatusTransformer.js +49 -0
  59. package/lib/private/data/action/transformer/actionTransformer.js +81 -0
  60. package/lib/private/data/action/transformer/availableActionTransformer.js +33 -0
  61. package/lib/private/data/common/apiClient.js +36 -1
  62. package/lib/private/domain/entities/action/actionEntity.js +83 -0
  63. package/lib/private/domain/entities/action/actionService.js +6 -0
  64. package/lib/private/domain/use-cases/action/confirmActionOutcomeUseCase.js +21 -0
  65. package/lib/private/domain/use-cases/action/initiateActionUseCase.js +22 -0
  66. package/lib/private/domain/use-cases/action/listAvailableActionsUseCase.js +22 -0
  67. package/lib/private/domain/use-cases/action/subscribeToActionUseCase.js +33 -0
  68. package/lib/private/domain/use-cases/action/unsubscribeFromActionUseCase.js +23 -0
  69. package/lib/public/defaultSudoPrivacyInteractionClient.js +58 -0
  70. package/lib/public/inputs/action.js +6 -0
  71. package/lib/public/inputs/index.js +1 -0
  72. package/lib/public/typings/action.js +82 -0
  73. package/lib/public/typings/index.js +1 -0
  74. package/package.json +2 -2
  75. package/types/gen/graphqlTypes.d.ts +245 -1
  76. package/types/private/data/action/actionSubscriptionManager.d.ts +19 -0
  77. package/types/private/data/action/defaultActionService.d.ts +23 -0
  78. package/types/private/data/action/transformer/actionFulfilmentMethodTransformer.d.ts +14 -0
  79. package/types/private/data/action/transformer/actionIntentTransformer.d.ts +14 -0
  80. package/types/private/data/action/transformer/actionOriginTransformer.d.ts +12 -0
  81. package/types/private/data/action/transformer/actionStatusTransformer.d.ts +12 -0
  82. package/types/private/data/action/transformer/actionTransformer.d.ts +39 -0
  83. package/types/private/data/action/transformer/availableActionTransformer.d.ts +15 -0
  84. package/types/private/data/common/apiClient.d.ts +7 -1
  85. package/types/private/domain/entities/action/actionEntity.d.ts +187 -0
  86. package/types/private/domain/entities/action/actionService.d.ts +99 -0
  87. package/types/private/domain/use-cases/action/confirmActionOutcomeUseCase.d.ts +16 -0
  88. package/types/private/domain/use-cases/action/initiateActionUseCase.d.ts +17 -0
  89. package/types/private/domain/use-cases/action/listAvailableActionsUseCase.d.ts +16 -0
  90. package/types/private/domain/use-cases/action/subscribeToActionUseCase.d.ts +27 -0
  91. package/types/private/domain/use-cases/action/unsubscribeFromActionUseCase.d.ts +15 -0
  92. package/types/public/defaultSudoPrivacyInteractionClient.d.ts +12 -2
  93. package/types/public/inputs/action.d.ts +30 -0
  94. package/types/public/inputs/index.d.ts +1 -0
  95. package/types/public/sudoPrivacyInteractionClient.d.ts +41 -2
  96. package/types/public/typings/action.d.ts +185 -0
  97. package/types/public/typings/index.d.ts +1 -0
  98. package/types/public/typings/subscription.d.ts +23 -0
@@ -0,0 +1,14 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { ActionIntent as ActionIntentGraphQL } from '../../../../gen/graphqlTypes';
7
+ import { ActionIntent } from '../../../../public';
8
+ import { ActionIntentEntity } from '../../../domain/entities/action/actionEntity';
9
+ export declare class ActionIntentTransformer {
10
+ fromEntityToAPI(entity: ActionIntentEntity): ActionIntent;
11
+ fromAPIToEntity(data: ActionIntent): ActionIntentEntity;
12
+ fromGraphQLToEntity(data: ActionIntentGraphQL): ActionIntentEntity;
13
+ fromEntityToGraphQL(entity: ActionIntentEntity): ActionIntentGraphQL;
14
+ }
@@ -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 { ActionOrigin as ActionOriginGraphQL } from '../../../../gen/graphqlTypes';
7
+ import { ActionOrigin } from '../../../../public';
8
+ import { ActionOriginEntity } from '../../../domain/entities/action/actionEntity';
9
+ export declare class ActionOriginTransformer {
10
+ fromEntityToAPI(entity: ActionOriginEntity): ActionOrigin;
11
+ fromGraphQLToEntity(data: ActionOriginGraphQL): ActionOriginEntity;
12
+ }
@@ -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 { ActionStatus as ActionStatusGraphQL } from '../../../../gen/graphqlTypes';
7
+ import { ActionStatus } from '../../../../public';
8
+ import { ActionStatusEntity } from '../../../domain/entities/action/actionEntity';
9
+ export declare class ActionStatusTransformer {
10
+ fromEntityToAPI(entity: ActionStatusEntity): ActionStatus;
11
+ fromGraphQLToEntity(data: ActionStatusGraphQL): ActionStatusEntity;
12
+ }
@@ -0,0 +1,39 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { ActionFulfilmentMethod as ActionFulfilmentMethodGraphQL, ActionIntent as ActionIntentGraphQL, ActionStatus as ActionStatusGraphQL, AssistedPayload as AssistedPayloadGraphQL } from '../../../../gen/graphqlTypes';
7
+ import { Action } from '../../../../public/typings/action';
8
+ import { ActionEntity } from '../../../domain/entities/action/actionEntity';
9
+ /**
10
+ * Structural shape of the GraphQL `Action` fields consumed by this transformer.
11
+ * Kept intentionally narrow so it accepts both the full mutation/query result
12
+ * and the scalar-only subscription result (which omits `assistedPayload`).
13
+ */
14
+ export interface ActionGraphQLLike {
15
+ id: string;
16
+ virtualPresenceId: string;
17
+ dataHolderId?: string | null;
18
+ intent: ActionIntentGraphQL;
19
+ additionalInfo?: string | null;
20
+ fulfilmentMethod: ActionFulfilmentMethodGraphQL;
21
+ status: ActionStatusGraphQL;
22
+ assistedPayload?: AssistedPayloadGraphQL | null;
23
+ initiatedAtEpochMs?: number | null;
24
+ completedAtEpochMs?: number | null;
25
+ owner: string;
26
+ version: number;
27
+ createdAtEpochMs: number;
28
+ updatedAtEpochMs: number;
29
+ }
30
+ export declare class ActionTransformer {
31
+ private readonly intentTransformer;
32
+ private readonly fulfilmentMethodTransformer;
33
+ private readonly statusTransformer;
34
+ fromGraphQLToEntity(data: ActionGraphQLLike): ActionEntity;
35
+ fromEntityToAPI(entity: ActionEntity): Action;
36
+ private assistedPayloadFromGraphQL;
37
+ private contactFromGraphQL;
38
+ private emailTemplateFromGraphQL;
39
+ }
@@ -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, 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;
@@ -38,9 +38,15 @@ export declare class ApiClient {
38
38
  limit?: number;
39
39
  nextToken?: string;
40
40
  }): Promise<AnalysisResultConnection>;
41
+ initiateAction(input: InitiateActionInput): Promise<Action>;
42
+ confirmActionOutcome(id: string): Promise<Action>;
43
+ listAvailableActions(input: {
44
+ dataHolderId: string;
45
+ }): Promise<AvailableActionConnection>;
41
46
  onVirtualPresenceUpdated(owner: string): Promise<Observable<SubscriptionResult<OnVirtualPresenceUpdateSubscription>>>;
42
47
  onDataHoldersUpdated(owner: string): Promise<Observable<SubscriptionResult<OnDataHoldersUpdateSubscription>>>;
43
48
  onAnalysisResultUpdated(owner: string): Promise<Observable<SubscriptionResult<OnAnalysisResultUpdateSubscription>>>;
49
+ onActionStatusUpdated(owner: string): Promise<Observable<SubscriptionResult<OnActionStatusUpdateSubscription>>>;
44
50
  private performQuery;
45
51
  private performMutation;
46
52
  private performSubscription;
@@ -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,99 @@
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
+ * Confirm that an assisted or delegated action was completed, transitioning it
72
+ * from `CompletedUnverified` to `CompletedVerified`.
73
+ *
74
+ * @param {string} id The unique identifier of the action to confirm.
75
+ * @returns {ActionEntity} The confirmed action.
76
+ */
77
+ confirmOutcome(id: string): Promise<ActionEntity>;
78
+ /**
79
+ * Retrieve the list of actions currently available for a data holder relationship.
80
+ *
81
+ * @param {ListAvailableActionsInput} input Parameters used to list available actions.
82
+ * @returns {ListAvailableActionsOutput} A list of available actions. Can be empty if
83
+ * no actions are available.
84
+ */
85
+ listAvailable(input: ListAvailableActionsInput): Promise<ListAvailableActionsOutput>;
86
+ /**
87
+ * Subscribe to action status events.
88
+ *
89
+ * @param {SubscribeToActionsInput} input Parameters used to subscribe to action
90
+ * status events.
91
+ */
92
+ subscribe(input: SubscribeToActionsInput): Promise<void>;
93
+ /**
94
+ * Unsubscribe from action status events.
95
+ *
96
+ * @param {string} subscriptionId The unique identifier of the subscription to unsubscribe from.
97
+ */
98
+ unsubscribe(subscriptionId: string): void;
99
+ }
@@ -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,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
+ }
@@ -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,10 @@ export declare class DefaultSudoPrivacyInteractionClient implements SudoPrivacyI
23
24
  private readonly analysisResultTransformer;
24
25
  private readonly organizationAnalysisTransformer;
25
26
  private readonly organizationAnalysisModeTransformer;
27
+ private readonly actionTransformer;
28
+ private readonly availableActionTransformer;
29
+ private readonly actionIntentTransformer;
30
+ private readonly actionFulfilmentMethodTransformer;
26
31
  private readonly log;
27
32
  constructor(opts: SudoPrivacyInteractionClientOptions);
28
33
  getProviderConfiguration(): Promise<ProviderConfiguration[]>;
@@ -43,4 +48,9 @@ export declare class DefaultSudoPrivacyInteractionClient implements SudoPrivacyI
43
48
  subscribeToAnalysisResult(subscriptionId: string, subscriber: AnalysisResultSubscriber): Promise<void>;
44
49
  unsubscribeFromAnalysisResult(subscriptionId: string): void;
45
50
  getOrganizationAnalysis(input: GetOrganizationAnalysisInput): Promise<OrganizationAnalysis | undefined>;
51
+ initiateAction(input: InitiateActionInput): Promise<Action>;
52
+ confirmActionOutcome(id: string): Promise<Action>;
53
+ listAvailableActions(input: ListAvailableActionsInput): Promise<ListOutput<AvailableAction>>;
54
+ subscribeToActions(subscriptionId: string, subscriber: ActionSubscriber): Promise<void>;
55
+ unsubscribeFromActions(subscriptionId: string): void;
46
56
  }
@@ -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';
@@ -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
@@ -145,6 +145,45 @@ export interface SudoPrivacyInteractionClient {
145
145
  * @returns {OrganizationAnalysis | undefined} The organization analysis, or undefined if not found.
146
146
  */
147
147
  getOrganizationAnalysis(input: GetOrganizationAnalysisInput): Promise<OrganizationAnalysis | undefined>;
148
+ /**
149
+ * Initiate an action against a data holder relationship. Delegated actions are
150
+ * performed on the user's behalf; assisted actions return structured materials
151
+ * for the client to complete.
152
+ *
153
+ * @param {InitiateActionInput} input Parameters used to initiate the action.
154
+ * @returns {Action} The initiated action.
155
+ */
156
+ initiateAction(input: InitiateActionInput): Promise<Action>;
157
+ /**
158
+ * Confirm that an assisted or delegated action was completed, transitioning it
159
+ * from `CompletedUnverified` to `CompletedVerified`.
160
+ *
161
+ * @param {string} id The unique identifier of the action to confirm.
162
+ * @returns {Action} The confirmed action.
163
+ */
164
+ confirmActionOutcome(id: string): Promise<Action>;
165
+ /**
166
+ * List the actions currently available for a data holder relationship.
167
+ *
168
+ * @param {ListAvailableActionsInput} input Parameters used to list available actions.
169
+ * @returns {ListOutput<AvailableAction>} A list of available actions matching the
170
+ * search criteria.
171
+ */
172
+ listAvailableActions(input: ListAvailableActionsInput): Promise<ListOutput<AvailableAction>>;
173
+ /**
174
+ * Subscribe to action status events. Emitted each time an action's status changes.
175
+ *
176
+ * @param {string} subscriptionId A unique identifier for this subscription.
177
+ * @param {ActionSubscriber} subscriber Callback implementation to be invoked when
178
+ * an action event occurs.
179
+ */
180
+ subscribeToActions(subscriptionId: string, subscriber: ActionSubscriber): Promise<void>;
181
+ /**
182
+ * Unsubscribe from action status events.
183
+ *
184
+ * @param {string} subscriptionId The subscription identifier to unsubscribe.
185
+ */
186
+ unsubscribeFromActions(subscriptionId: string): void;
148
187
  }
149
188
  export type SudoPrivacyInteractionClientOptions = {
150
189
  /** Sudo User client to use. No default */