@sudoplatform/sudo-privacy-interaction 1.1.0 → 2.1.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 (143) hide show
  1. package/cjs/gen/graphqlTypes.js +1750 -770
  2. package/cjs/private/data/analysis-result/transformer/privacyScoreTransformer.js +8 -0
  3. package/cjs/private/data/common/apiClient.js +31 -0
  4. package/cjs/private/data/data-holder/defaultDataHolderService.js +12 -0
  5. package/cjs/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.js +56 -0
  6. package/cjs/private/data/organization-analysis/defaultOrganizationAnalysisService.js +31 -0
  7. package/cjs/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.js +29 -0
  8. package/cjs/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +45 -0
  9. package/cjs/private/data/provider-configuration/defaultProviderConfigurationService.js +23 -0
  10. package/cjs/private/data/provider-configuration/transformer/providerConfigurationTransformer.js +52 -0
  11. package/cjs/private/data/virtual-presence/defaultVirtualPresenceService.js +11 -1
  12. package/cjs/private/data/virtual-presence/transformer/relationshipProviderTransformer.js +29 -0
  13. package/cjs/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +2 -0
  14. package/cjs/private/domain/entities/configuration/providerConfigurationEntity.js +7 -0
  15. package/cjs/private/domain/entities/configuration/providerConfigurationService.js +7 -0
  16. package/cjs/private/domain/entities/inputs/relationshipProviderEntity.js +21 -0
  17. package/cjs/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +24 -0
  18. package/cjs/private/domain/entities/organization-analysis/organizationAnalysisService.js +7 -0
  19. package/cjs/private/domain/use-cases/configuration/getProviderConfigurationUseCase.js +25 -0
  20. package/cjs/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.js +29 -0
  21. package/cjs/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.js +25 -0
  22. package/cjs/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithAuthCodeUseCase.js +6 -2
  23. package/cjs/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithRefreshTokenUseCase.js +7 -1
  24. package/cjs/public/defaultSudoPrivacyInteractionClient.js +109 -9
  25. package/cjs/public/inputs/index.js +1 -0
  26. package/cjs/public/inputs/organizationAnalysis.js +7 -0
  27. package/cjs/public/inputs/virtualPresence.js +14 -0
  28. package/cjs/public/typings/index.js +2 -0
  29. package/cjs/public/typings/organizationAnalysis.js +24 -0
  30. package/cjs/public/typings/providerConfiguration.js +7 -0
  31. package/docs/assets/hierarchy.js +1 -1
  32. package/docs/assets/navigation.js +1 -1
  33. package/docs/assets/search.js +1 -1
  34. package/docs/classes/DefaultSudoPrivacyInteractionClient.html +86 -22
  35. package/docs/enums/DataCategory.html +18 -18
  36. package/docs/enums/DataHolderProtectionState.html +5 -5
  37. package/docs/enums/OrganizationAnalysisMode.html +70 -0
  38. package/docs/enums/OrganizationCategory.html +30 -30
  39. package/docs/enums/ProviderType.html +3 -3
  40. package/docs/enums/RelationshipProvider.html +63 -0
  41. package/docs/enums/RetentionStyle.html +5 -5
  42. package/docs/enums/ShareStyle.html +6 -6
  43. package/docs/enums/SignalValue.html +4 -4
  44. package/docs/enums/VirtualPresenceState.html +7 -7
  45. package/docs/hierarchy.html +6 -5
  46. package/docs/interfaces/CapabilitySignals.html +9 -9
  47. package/docs/interfaces/CategorySignals.html +11 -11
  48. package/docs/interfaces/ConnectVirtualPresenceWithAuthCodeInput.html +79 -0
  49. package/docs/interfaces/ConnectVirtualPresenceWithRefreshTokenInput.html +16 -7
  50. package/docs/interfaces/DataHolder.html +24 -14
  51. package/docs/interfaces/DataHolderScanSummary.html +158 -0
  52. package/docs/interfaces/GetDataHolderOptions.html +63 -0
  53. package/docs/interfaces/GetOrganizationAnalysisInput.html +70 -0
  54. package/docs/interfaces/ListAnalysisResultsInput.html +1 -1
  55. package/docs/interfaces/ListDataHolderScanSummariesInput.html +85 -0
  56. package/docs/interfaces/ListDataHoldersInput.html +1 -1
  57. package/docs/interfaces/ListVirtualPresencesInput.html +2 -2
  58. package/docs/interfaces/OrganizationAnalysis.html +131 -0
  59. package/docs/interfaces/OrganizationIdentity.html +5 -5
  60. package/docs/interfaces/Pagination.html +2 -1
  61. package/docs/interfaces/PrivacyScore.html +13 -5
  62. package/docs/interfaces/PrivacySummary.html +4 -4
  63. package/docs/interfaces/ProviderConfiguration.html +80 -0
  64. package/docs/interfaces/RescanVirtualPresenceInput.html +3 -3
  65. package/docs/interfaces/RetentionInfo.html +4 -4
  66. package/docs/interfaces/RiskIndicators.html +8 -8
  67. package/docs/interfaces/ScanOptions.html +6 -6
  68. package/docs/interfaces/ScoreContribution.html +3 -3
  69. package/docs/interfaces/ScoreCoverage.html +70 -0
  70. package/docs/interfaces/SudoPrivacyInteractionClient.html +83 -22
  71. package/docs/interfaces/VirtualPresence.html +21 -12
  72. package/docs/modules.html +4 -4
  73. package/docs/types/SudoPrivacyInteractionClientOptions.html +2 -2
  74. package/lib/gen/graphqlTypes.js +1749 -769
  75. package/lib/private/data/analysis-result/transformer/privacyScoreTransformer.js +8 -0
  76. package/lib/private/data/common/apiClient.js +32 -1
  77. package/lib/private/data/data-holder/defaultDataHolderService.js +12 -0
  78. package/lib/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.js +52 -0
  79. package/lib/private/data/organization-analysis/defaultOrganizationAnalysisService.js +27 -0
  80. package/lib/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.js +25 -0
  81. package/lib/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +41 -0
  82. package/lib/private/data/provider-configuration/defaultProviderConfigurationService.js +19 -0
  83. package/lib/private/data/provider-configuration/transformer/providerConfigurationTransformer.js +48 -0
  84. package/lib/private/data/virtual-presence/defaultVirtualPresenceService.js +11 -1
  85. package/lib/private/data/virtual-presence/transformer/relationshipProviderTransformer.js +25 -0
  86. package/lib/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +2 -0
  87. package/lib/private/domain/entities/configuration/providerConfigurationEntity.js +6 -0
  88. package/lib/private/domain/entities/configuration/providerConfigurationService.js +6 -0
  89. package/lib/private/domain/entities/inputs/relationshipProviderEntity.js +18 -0
  90. package/lib/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +21 -0
  91. package/lib/private/domain/entities/organization-analysis/organizationAnalysisService.js +6 -0
  92. package/lib/private/domain/use-cases/configuration/getProviderConfigurationUseCase.js +21 -0
  93. package/lib/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.js +25 -0
  94. package/lib/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.js +21 -0
  95. package/lib/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithAuthCodeUseCase.js +6 -2
  96. package/lib/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithRefreshTokenUseCase.js +7 -1
  97. package/lib/public/defaultSudoPrivacyInteractionClient.js +109 -9
  98. package/lib/public/inputs/index.js +1 -0
  99. package/lib/public/inputs/organizationAnalysis.js +6 -0
  100. package/lib/public/inputs/virtualPresence.js +13 -1
  101. package/lib/public/typings/index.js +2 -0
  102. package/lib/public/typings/organizationAnalysis.js +21 -0
  103. package/lib/public/typings/providerConfiguration.js +6 -0
  104. package/package.json +9 -5
  105. package/types/gen/graphqlTypes.d.ts +349 -1
  106. package/types/private/data/common/apiClient.d.ts +11 -1
  107. package/types/private/data/common/baseSubscriptionManager.d.ts +5 -0
  108. package/types/private/data/data-holder/defaultDataHolderService.d.ts +3 -1
  109. package/types/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.d.ts +18 -0
  110. package/types/private/data/organization-analysis/defaultOrganizationAnalysisService.d.ts +15 -0
  111. package/types/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.d.ts +12 -0
  112. package/types/private/data/organization-analysis/transformer/organizationAnalysisTransformer.d.ts +14 -0
  113. package/types/private/data/provider-configuration/defaultProviderConfigurationService.d.ts +14 -0
  114. package/types/private/data/provider-configuration/transformer/providerConfigurationTransformer.d.ts +19 -0
  115. package/types/private/data/virtual-presence/defaultVirtualPresenceService.d.ts +1 -0
  116. package/types/private/data/virtual-presence/transformer/relationshipProviderTransformer.d.ts +12 -0
  117. package/types/private/domain/entities/analysis-result/analysisResultEntity.d.ts +14 -0
  118. package/types/private/domain/entities/configuration/providerConfigurationEntity.d.ts +23 -0
  119. package/types/private/domain/entities/configuration/providerConfigurationService.d.ts +21 -0
  120. package/types/private/domain/entities/data-holder/dataHolderEntity.d.ts +34 -0
  121. package/types/private/domain/entities/data-holder/dataHolderService.d.ts +35 -1
  122. package/types/private/domain/entities/inputs/relationshipProviderEntity.d.ts +17 -0
  123. package/types/private/domain/entities/organization-analysis/organizationAnalysisEntity.d.ts +53 -0
  124. package/types/private/domain/entities/organization-analysis/organizationAnalysisService.d.ts +35 -0
  125. package/types/private/domain/entities/virtual-presence/virtualPresenceEntity.d.ts +3 -0
  126. package/types/private/domain/entities/virtual-presence/virtualPresenceService.d.ts +17 -2
  127. package/types/private/domain/use-cases/configuration/getProviderConfigurationUseCase.d.ts +16 -0
  128. package/types/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.d.ts +36 -0
  129. package/types/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.d.ts +16 -0
  130. package/types/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithAuthCodeUseCase.d.ts +13 -1
  131. package/types/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithRefreshTokenUseCase.d.ts +2 -0
  132. package/types/public/defaultSudoPrivacyInteractionClient.d.ts +14 -4
  133. package/types/public/inputs/dataHolder.d.ts +22 -0
  134. package/types/public/inputs/index.d.ts +1 -0
  135. package/types/public/inputs/organizationAnalysis.d.ts +18 -0
  136. package/types/public/inputs/virtualPresence.d.ts +30 -0
  137. package/types/public/sudoPrivacyInteractionClient.d.ts +34 -5
  138. package/types/public/typings/analysisResult.d.ts +14 -0
  139. package/types/public/typings/dataHolder.d.ts +38 -0
  140. package/types/public/typings/index.d.ts +2 -0
  141. package/types/public/typings/organizationAnalysis.d.ts +53 -0
  142. package/types/public/typings/providerConfiguration.d.ts +23 -0
  143. package/types/public/typings/virtualPresence.d.ts +3 -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 { ProviderConfigurationEntity } from '../../domain/entities/configuration/providerConfigurationEntity';
7
+ import { ProviderConfigurationService } from '../../domain/entities/configuration/providerConfigurationService';
8
+ import { ApiClient } from '../common/apiClient';
9
+ export declare class DefaultProviderConfigurationService implements ProviderConfigurationService {
10
+ private readonly appSync;
11
+ private readonly providerConfigurationTransformer;
12
+ constructor(appSync: ApiClient);
13
+ get(): Promise<ProviderConfigurationEntity[]>;
14
+ }
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { ProviderConfiguration } from '../../../../public/typings/providerConfiguration';
7
+ import { ProviderConfigurationEntity } from '../../../domain/entities/configuration/providerConfigurationEntity';
8
+ export declare class ProviderConfigurationTransformer {
9
+ private readonly providerTypeTransformer;
10
+ /**
11
+ * Decodes the opaque, base-64 encoded provider configuration data into a
12
+ * list of domain entities.
13
+ *
14
+ * @param {string} data The base-64 encoded provider configuration data.
15
+ * @returns {ProviderConfigurationEntity[]} The decoded provider configurations.
16
+ */
17
+ fromGraphQLToEntity(data: string): ProviderConfigurationEntity[];
18
+ fromEntityToAPI(entity: ProviderConfigurationEntity): ProviderConfiguration;
19
+ }
@@ -9,6 +9,7 @@ import { ApiClient } from '../common/apiClient';
9
9
  export declare class DefaultVirtualPresenceService implements VirtualPresenceService {
10
10
  private readonly appSync;
11
11
  private readonly virtualPresenceTransformer;
12
+ private readonly relationshipProviderTransformer;
12
13
  private readonly subscriptionManager;
13
14
  constructor(appSync: ApiClient);
14
15
  connect(input: ConnectVirtualPresenceInput): Promise<VirtualPresenceEntity>;
@@ -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 { RelationshipProvider as RelationshipProviderGraphQL } from '../../../../gen/graphqlTypes';
7
+ import { RelationshipProvider } from '../../../../public/inputs/virtualPresence';
8
+ import { RelationshipProviderEntity } from '../../../domain/entities/inputs/relationshipProviderEntity';
9
+ export declare class RelationshipProviderTransformer {
10
+ fromEntityToGraphQL(entity: RelationshipProviderEntity): RelationshipProviderGraphQL;
11
+ fromAPIToEntity(data: RelationshipProvider): RelationshipProviderEntity;
12
+ }
@@ -76,10 +76,24 @@ export interface AnalysisResultDataEntity {
76
76
  * @interface PrivacyScoreEntity
77
77
  * @property {number} score Numeric score (0-100). Higher is better.
78
78
  * @property {ScoreContributionEntity[]} breakdown Breakdown of how each aspect contributed to the score.
79
+ * @property {ScoreCoverageEntity} coverage How much of the scoring-relevant input had a known value.
79
80
  */
80
81
  export interface PrivacyScoreEntity {
81
82
  score: number;
82
83
  breakdown: ScoreContributionEntity[];
84
+ coverage: ScoreCoverageEntity;
85
+ }
86
+ /**
87
+ * How much of the scoring-relevant input had a known value. A low ratio means the
88
+ * score rests on few known signals and should be treated as lower-confidence.
89
+ *
90
+ * @interface ScoreCoverageEntity
91
+ * @property {number} evaluated Scoring aspects with a known value.
92
+ * @property {number} total Total scoring aspects the calculator considers.
93
+ */
94
+ export interface ScoreCoverageEntity {
95
+ evaluated: number;
96
+ total: number;
83
97
  }
84
98
  /**
85
99
  * A single scoring aspect and its contribution to the overall score.
@@ -0,0 +1,23 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { ProviderTypeEntity } from '../virtual-presence/virtualPresenceEntity';
7
+ /**
8
+ * Core entity representation of a provider configuration.
9
+ *
10
+ * Contains the configuration required by consumers to support the provider
11
+ * OAuth flow. This is the decoded form of the opaque configuration data
12
+ * returned by the service.
13
+ *
14
+ * @interface ProviderConfigurationEntity
15
+ * @property {string} name Human-readable provider name (e.g. 'google').
16
+ * @property {ProviderTypeEntity} providerType The kind of virtual presence this provider backs (e.g. EMAIL).
17
+ * @property {string} clientId OAuth client id.
18
+ */
19
+ export interface ProviderConfigurationEntity {
20
+ name: string;
21
+ providerType: ProviderTypeEntity;
22
+ clientId: string;
23
+ }
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { ProviderConfigurationEntity } from './providerConfigurationEntity';
7
+ /**
8
+ * Core entity representation of a configuration service used in business logic.
9
+ * Used to retrieve service configuration.
10
+ *
11
+ * @interface ProviderConfigurationService
12
+ */
13
+ export interface ProviderConfigurationService {
14
+ /**
15
+ * Retrieve the provider configurations required by consumers to support
16
+ * the provider OAuth flow.
17
+ *
18
+ * @returns {ProviderConfigurationEntity[]} The decoded provider configurations.
19
+ */
20
+ get(): Promise<ProviderConfigurationEntity[]>;
21
+ }
@@ -49,3 +49,37 @@ export declare enum DataHolderProtectionStateEntity {
49
49
  Resolved = "RESOLVED",
50
50
  Unknown = "UNKNOWN"
51
51
  }
52
+ /**
53
+ * Core entity representation of email interaction metrics captured during a
54
+ * single scan for a specific data holder.
55
+ *
56
+ * @interface DataHolderScanSummaryEntity
57
+ * @property {string} dataHolderId The data holder these metrics apply to.
58
+ * @property {string} owner Unique identifier of the user.
59
+ * @property {Date} scannedAt Date for when the scan was performed.
60
+ * @property {Date} scanRangeFrom Start of the scanned time range.
61
+ * @property {Date} scanRangeTo End of the scanned time range.
62
+ * @property {number} emailCount Total number of emails observed in the scan range.
63
+ * @property {number} readCount Number of emails that were read.
64
+ * @property {number} readRate Ratio of read emails to total emails.
65
+ * @property {number} marketingEmailCount Number of marketing emails observed.
66
+ * @property {number} marketingEmailOpened Number of marketing emails that were opened.
67
+ * @property {number} marketingOpenRate Ratio of opened marketing emails to marketing emails.
68
+ * @property {Record<string, number>} categoryBreakdown Count of emails per category.
69
+ * @property {number} uncategorizedCount Number of emails that could not be categorized.
70
+ */
71
+ export interface DataHolderScanSummaryEntity {
72
+ dataHolderId: string;
73
+ owner: string;
74
+ scannedAt: Date;
75
+ scanRangeFrom: Date;
76
+ scanRangeTo: Date;
77
+ emailCount: number;
78
+ readCount: number;
79
+ readRate: number;
80
+ marketingEmailCount: number;
81
+ marketingEmailOpened: number;
82
+ marketingOpenRate: number;
83
+ categoryBreakdown: Record<string, number>;
84
+ uncategorizedCount: number;
85
+ }
@@ -4,7 +4,7 @@
4
4
  * SPDX-License-Identifier: Apache-2.0
5
5
  */
6
6
  import { DataHolderSubscriber } from '../../../../public/typings/subscription';
7
- import { DataHolderEntity } from './dataHolderEntity';
7
+ import { DataHolderEntity, DataHolderScanSummaryEntity } from './dataHolderEntity';
8
8
  /**
9
9
  * Input for `DataHolderService.list` method.
10
10
  *
@@ -30,6 +30,32 @@ export interface ListDataHoldersOutput {
30
30
  dataHolders: DataHolderEntity[];
31
31
  nextToken?: string;
32
32
  }
33
+ /**
34
+ * Input for `DataHolderService.listScanSummaries` method.
35
+ *
36
+ * @interface ListDataHolderScanSummariesInput
37
+ * @property {string} dataHolderId The data holder to list scan summaries for.
38
+ * @property {number} limit Number of records to return.
39
+ * @property {string} nextToken A token generated by a previous call to
40
+ * `DataHolderService.listScanSummaries`. This allows for pagination.
41
+ */
42
+ export interface ListDataHolderScanSummariesInput {
43
+ dataHolderId: string;
44
+ limit?: number;
45
+ nextToken?: string;
46
+ }
47
+ /**
48
+ * Output for `DataHolderService.listScanSummaries` method.
49
+ *
50
+ * @interface ListDataHolderScanSummariesOutput
51
+ * @property {DataHolderScanSummaryEntity[]} scanSummaries The list of scan summaries
52
+ * retrieved in this query.
53
+ * @property {string} nextToken A token generated by a previous call. This allows for pagination.
54
+ */
55
+ export interface ListDataHolderScanSummariesOutput {
56
+ scanSummaries: DataHolderScanSummaryEntity[];
57
+ nextToken?: string;
58
+ }
33
59
  /**
34
60
  * Input for `DataHolderService.subscribe` method.
35
61
  *
@@ -65,6 +91,14 @@ export interface DataHolderService {
65
91
  * Can be empty if no data holders found.
66
92
  */
67
93
  list(input: ListDataHoldersInput): Promise<ListDataHoldersOutput>;
94
+ /**
95
+ * Retrieve a list of scan summaries for a data holder (most recent first).
96
+ *
97
+ * @param {ListDataHolderScanSummariesInput} input Parameters used to list scan summaries.
98
+ * @returns {ListDataHolderScanSummariesOutput} A list of scan summaries matching the
99
+ * search criteria. Can be empty if no scan summaries found.
100
+ */
101
+ listScanSummaries(input: ListDataHolderScanSummariesInput): Promise<ListDataHolderScanSummariesOutput>;
68
102
  /**
69
103
  * Subscribe to data holder state events.
70
104
  *
@@ -0,0 +1,17 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ /**
7
+ * Enumeration of the relationship providers that back a virtual presence connection.
8
+ *
9
+ * @property GMAIL_PROVIDER The Gmail relationship provider.
10
+ * @property TEST_PROVIDER The test relationship provider.
11
+ *
12
+ * @enum
13
+ */
14
+ export declare enum RelationshipProviderEntity {
15
+ GmailProvider = "GMAIL_PROVIDER",
16
+ TestProvider = "TEST_PROVIDER"
17
+ }
@@ -0,0 +1,53 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { AnalysisResultDataEntity, AnalysisResultStatusEntity } from '../analysis-result/analysisResultEntity';
7
+ /**
8
+ * Core entity representation of a shared, domain-keyed privacy analysis of an
9
+ * organization.
10
+ *
11
+ * The same underlying analysis is returned to every caller asking about the same
12
+ * domain; it carries only organization-generic signals. `id` equals the analyzed
13
+ * domain and `owner` is the requesting caller.
14
+ *
15
+ * @interface OrganizationAnalysisEntity
16
+ * @property {string} id Identifies the shared analysis. Equal to the analyzed domain.
17
+ * @property {string} domain The analyzed domain (equal to id).
18
+ * @property {AnalysisResultStatusEntity} status Aggregate status. PENDING while an asynchronous
19
+ * source is still resolving; re-query for the terminal result.
20
+ * @property {Date} lastAnalyzedAt When the aggregate was last derived.
21
+ * @property {AnalysisResultDataEntity} data Structured analysis payload. Populated when status
22
+ * is COMPLETE or PARTIAL.
23
+ * @property {string} owner The caller who requested this view. The underlying analysis is shared.
24
+ * @property {number} version Version of this entity. Increments on update.
25
+ * @property {Date} createdAt Date for when the analysis was created.
26
+ * @property {Date} updatedAt Date for when the analysis was last updated.
27
+ */
28
+ export interface OrganizationAnalysisEntity {
29
+ id: string;
30
+ domain: string;
31
+ status: AnalysisResultStatusEntity;
32
+ lastAnalyzedAt: Date;
33
+ data?: AnalysisResultDataEntity;
34
+ owner: string;
35
+ version: number;
36
+ createdAt: Date;
37
+ updatedAt: Date;
38
+ }
39
+ /**
40
+ * Controls how `getOrganizationAnalysis` obtains source results when the stored
41
+ * analysis is stale or absent.
42
+ *
43
+ * @property ANALYZE Read-through: request analysis from the sources, which may compute and
44
+ * leave the result PENDING until asynchronous work completes.
45
+ * @property FETCH Pull only the sources' existing values; never request new work. A stale
46
+ * domain with no existing source value is not moved to PENDING.
47
+ *
48
+ * @enum
49
+ */
50
+ export declare enum OrganizationAnalysisModeEntity {
51
+ Analyze = "ANALYZE",
52
+ Fetch = "FETCH"
53
+ }
@@ -0,0 +1,35 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { OrganizationAnalysisEntity, OrganizationAnalysisModeEntity } from './organizationAnalysisEntity';
7
+ /**
8
+ * Input for `OrganizationAnalysisService.getOrganizationAnalysis` method.
9
+ *
10
+ * @interface GetOrganizationAnalysisInput
11
+ * @property {string} domain The domain to analyze.
12
+ * @property {OrganizationAnalysisModeEntity} mode How to obtain source results. When omitted,
13
+ * the backend behaves as ANALYZE.
14
+ */
15
+ export interface GetOrganizationAnalysisInput {
16
+ domain: string;
17
+ mode?: OrganizationAnalysisModeEntity;
18
+ }
19
+ /**
20
+ * Core entity representation of an organization analysis service used in business logic.
21
+ *
22
+ * @interface OrganizationAnalysisService
23
+ */
24
+ export interface OrganizationAnalysisService {
25
+ /**
26
+ * Analyze (read-through) and return the shared, organization-generic analysis for a domain.
27
+ * Returns a result with PENDING status when an asynchronous source is still resolving;
28
+ * re-query for the terminal result.
29
+ *
30
+ * @param {GetOrganizationAnalysisInput} input Parameters used to obtain the analysis.
31
+ * @returns {OrganizationAnalysisEntity | undefined} The organization analysis, or undefined
32
+ * if not found.
33
+ */
34
+ getOrganizationAnalysis(input: GetOrganizationAnalysisInput): Promise<OrganizationAnalysisEntity | undefined>;
35
+ }
@@ -16,6 +16,8 @@
16
16
  * @property {string} identifier The presence identifier (e.g. email address).
17
17
  * @property {VirtualPresenceStateEntity} state The current state of the virtual presence.
18
18
  * @property {Date} lastScannedAt Date for when the virtual presence was last scanned.
19
+ * @property {string} lastScanFailureReason Reason the most recent completed scan failed (an error/exception name).
20
+ * Undefined when the most recent completed scan succeeded (or none has completed).
19
21
  * @property {Date} createdAt Date for when the virtual presence was created.
20
22
  * @property {Date} updatedAt Date for when the virtual presence was last updated.
21
23
  */
@@ -27,6 +29,7 @@ export interface VirtualPresenceEntity {
27
29
  identifier: string;
28
30
  state: VirtualPresenceStateEntity;
29
31
  lastScannedAt: Date;
32
+ lastScanFailureReason?: string;
30
33
  createdAt: Date;
31
34
  updatedAt: Date;
32
35
  }
@@ -4,8 +4,20 @@
4
4
  * SPDX-License-Identifier: Apache-2.0
5
5
  */
6
6
  import { VirtualPresenceSubscriber } from '../../../../public/typings/subscription';
7
+ import { RelationshipProviderEntity } from '../inputs/relationshipProviderEntity';
7
8
  import { ScanOptionsEntity } from '../inputs/scanOptionsEntity';
8
9
  import { VirtualPresenceEntity } from './virtualPresenceEntity';
10
+ /**
11
+ * Auth code input for connecting a virtual presence.
12
+ *
13
+ * @interface AuthCodeInput
14
+ * @property {string} authCode The auth code value.
15
+ * @property {string} redirectUri The optional redirect URI value.
16
+ */
17
+ export interface AuthCodeInput {
18
+ authCode: string;
19
+ redirectUri?: string;
20
+ }
9
21
  /**
10
22
  * Refresh token credential input for connecting a virtual presence.
11
23
  *
@@ -25,12 +37,15 @@ export interface RefreshTokenInput {
25
37
  * Input for `VirtualPresenceService.connect` method.
26
38
  *
27
39
  * @interface ConnectVirtualPresenceInput
28
- * @property {string} authCode An authorization code obtained from the OAuth flow.
40
+ * @property {AuthCodeInput} authCode An authorization code obtained from the OAuth flow.
29
41
  * @property {RefreshTokenInput} refreshToken A pre-obtained refresh token credential.
42
+ * @property {RelationshipProviderEntity} relationshipProvider The relationship provider
43
+ * to associate with the connection.
30
44
  */
31
45
  export interface ConnectVirtualPresenceInput {
32
- authCode?: string;
46
+ authCode?: AuthCodeInput;
33
47
  refreshToken?: RefreshTokenInput;
48
+ relationshipProvider?: RelationshipProviderEntity;
34
49
  }
35
50
  /**
36
51
  * Input for `VirtualPresenceService.list` method.
@@ -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 { ProviderConfigurationEntity } from '../../entities/configuration/providerConfigurationEntity';
7
+ import { ProviderConfigurationService } from '../../entities/configuration/providerConfigurationService';
8
+ /**
9
+ * Application business logic for retrieving the provider configuration.
10
+ */
11
+ export declare class GetProviderConfigurationUseCase {
12
+ private readonly providerConfigurationService;
13
+ private readonly log;
14
+ constructor(providerConfigurationService: ProviderConfigurationService);
15
+ execute(): Promise<ProviderConfigurationEntity[]>;
16
+ }
@@ -0,0 +1,36 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { DataHolderScanSummaryEntity } from '../../entities/data-holder/dataHolderEntity';
7
+ import { DataHolderService } from '../../entities/data-holder/dataHolderService';
8
+ /**
9
+ * Input for `ListDataHolderScanSummariesUseCase`.
10
+ *
11
+ * @interface ListDataHolderScanSummariesUseCaseInput
12
+ */
13
+ interface ListDataHolderScanSummariesUseCaseInput {
14
+ dataHolderId: string;
15
+ limit?: number | undefined;
16
+ nextToken?: string | undefined;
17
+ }
18
+ /**
19
+ * Output for `ListDataHolderScanSummariesUseCase`.
20
+ *
21
+ * @interface ListDataHolderScanSummariesUseCaseOutput
22
+ */
23
+ interface ListDataHolderScanSummariesUseCaseOutput {
24
+ scanSummaries: DataHolderScanSummaryEntity[];
25
+ nextToken?: string;
26
+ }
27
+ /**
28
+ * Application business logic for listing scan summaries for a data holder.
29
+ */
30
+ export declare class ListDataHolderScanSummariesUseCase {
31
+ private readonly dataHolderService;
32
+ private readonly log;
33
+ constructor(dataHolderService: DataHolderService);
34
+ execute(input: ListDataHolderScanSummariesUseCaseInput): Promise<ListDataHolderScanSummariesUseCaseOutput>;
35
+ }
36
+ export {};
@@ -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 { OrganizationAnalysisEntity } from '../../entities/organization-analysis/organizationAnalysisEntity';
7
+ import { GetOrganizationAnalysisInput, OrganizationAnalysisService } from '../../entities/organization-analysis/organizationAnalysisService';
8
+ /**
9
+ * Application business logic for obtaining an organization analysis.
10
+ */
11
+ export declare class GetOrganizationAnalysisUseCase {
12
+ private readonly organizationAnalysisService;
13
+ private readonly log;
14
+ constructor(organizationAnalysisService: OrganizationAnalysisService);
15
+ execute(input: GetOrganizationAnalysisInput): Promise<OrganizationAnalysisEntity | undefined>;
16
+ }
@@ -3,8 +3,19 @@
3
3
  *
4
4
  * SPDX-License-Identifier: Apache-2.0
5
5
  */
6
+ import { RelationshipProviderEntity } from '../../entities/inputs/relationshipProviderEntity';
6
7
  import { VirtualPresenceEntity } from '../../entities/virtual-presence/virtualPresenceEntity';
7
8
  import { VirtualPresenceService } from '../../entities/virtual-presence/virtualPresenceService';
9
+ /**
10
+ * Input for `ConnectVirtualPresenceWithAuthCodeUseCase`.
11
+ *
12
+ * @interface ConnectVirtualPresenceWithAuthCodeUseCaseInput
13
+ */
14
+ interface ConnectVirtualPresenceWithAuthCodeUseCaseInput {
15
+ authCode: string;
16
+ redirectUri?: string;
17
+ relationshipProvider?: RelationshipProviderEntity;
18
+ }
8
19
  /**
9
20
  * Application business logic for connecting a virtual presence using an authorization code.
10
21
  */
@@ -12,5 +23,6 @@ export declare class ConnectVirtualPresenceWithAuthCodeUseCase {
12
23
  private readonly virtualPresenceService;
13
24
  private readonly log;
14
25
  constructor(virtualPresenceService: VirtualPresenceService);
15
- execute(authCode: string): Promise<VirtualPresenceEntity>;
26
+ execute(input: ConnectVirtualPresenceWithAuthCodeUseCaseInput): Promise<VirtualPresenceEntity>;
16
27
  }
28
+ export {};
@@ -3,6 +3,7 @@
3
3
  *
4
4
  * SPDX-License-Identifier: Apache-2.0
5
5
  */
6
+ import { RelationshipProviderEntity } from '../../entities/inputs/relationshipProviderEntity';
6
7
  import { VirtualPresenceEntity } from '../../entities/virtual-presence/virtualPresenceEntity';
7
8
  import { VirtualPresenceService } from '../../entities/virtual-presence/virtualPresenceService';
8
9
  /**
@@ -15,6 +16,7 @@ interface ConnectVirtualPresenceWithRefreshTokenUseCaseInput {
15
16
  providerIdentity: string;
16
17
  scopes?: string[];
17
18
  expiresInEpochMs?: number;
19
+ relationshipProvider?: RelationshipProviderEntity;
18
20
  }
19
21
  /**
20
22
  * Application business logic for connecting a virtual presence with a pre-obtained refresh token.
@@ -4,33 +4,43 @@
4
4
  * SPDX-License-Identifier: Apache-2.0
5
5
  */
6
6
  import { ListOutput } from '@sudoplatform/sudo-common';
7
- import { ConnectVirtualPresenceWithRefreshTokenInput, ListAnalysisResultsInput, ListDataHoldersInput, ListVirtualPresencesInput, RescanVirtualPresenceInput } from './inputs';
7
+ import { ConnectVirtualPresenceWithAuthCodeInput, ConnectVirtualPresenceWithRefreshTokenInput, GetDataHolderOptions, GetOrganizationAnalysisInput, ListAnalysisResultsInput, ListDataHolderScanSummariesInput, ListDataHoldersInput, ListVirtualPresencesInput, RescanVirtualPresenceInput } from './inputs';
8
8
  import { SudoPrivacyInteractionClient, SudoPrivacyInteractionClientOptions } from './sudoPrivacyInteractionClient';
9
- import { AnalysisResult, AnalysisResultSubscriber, DataHolder, DataHolderSubscriber, VirtualPresence, VirtualPresenceSubscriber } from './typings';
9
+ import { AnalysisResult, AnalysisResultSubscriber, 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;
13
+ private readonly providerConfigurationService;
13
14
  private readonly virtualPresenceService;
14
15
  private readonly dataHolderService;
15
16
  private readonly analysisResultService;
17
+ private readonly organizationAnalysisService;
18
+ private readonly providerConfigurationTransformer;
16
19
  private readonly virtualPresenceTransformer;
20
+ private readonly relationshipProviderTransformer;
17
21
  private readonly dataHolderTransformer;
22
+ private readonly dataHolderScanSummaryTransformer;
18
23
  private readonly analysisResultTransformer;
24
+ private readonly organizationAnalysisTransformer;
25
+ private readonly organizationAnalysisModeTransformer;
19
26
  private readonly log;
20
27
  constructor(opts: SudoPrivacyInteractionClientOptions);
21
- connectVirtualPresenceWithAuthCode(authCode: string): Promise<VirtualPresence>;
28
+ getProviderConfiguration(): Promise<ProviderConfiguration[]>;
29
+ connectVirtualPresenceWithAuthCode(input: ConnectVirtualPresenceWithAuthCodeInput): Promise<VirtualPresence>;
22
30
  connectVirtualPresenceWithRefreshToken(input: ConnectVirtualPresenceWithRefreshTokenInput): Promise<VirtualPresence>;
23
31
  disconnectVirtualPresence(id: string): Promise<VirtualPresence>;
24
32
  rescanVirtualPresence(input: RescanVirtualPresenceInput): Promise<VirtualPresence>;
25
33
  listVirtualPresences(input: ListVirtualPresencesInput): Promise<ListOutput<VirtualPresence>>;
26
34
  subscribeToVirtualPresence(subscriptionId: string, subscriber: VirtualPresenceSubscriber): Promise<void>;
27
35
  unsubscribeFromVirtualPresence(subscriptionId: string): void;
28
- getDataHolder(id: string): Promise<DataHolder | undefined>;
36
+ getDataHolder(id: string, options?: GetDataHolderOptions): Promise<DataHolder | undefined>;
29
37
  listDataHolders(input: ListDataHoldersInput): Promise<ListOutput<DataHolder>>;
38
+ listDataHolderScanSummaries(input: ListDataHolderScanSummariesInput): Promise<ListOutput<DataHolderScanSummary>>;
30
39
  subscribeToDataHolders(subscriptionId: string, subscriber: DataHolderSubscriber): Promise<void>;
31
40
  unsubscribeFromDataHolders(subscriptionId: string): void;
32
41
  getAnalysisResult(id: string): Promise<AnalysisResult | undefined>;
33
42
  listAnalysisResults(input: ListAnalysisResultsInput): Promise<ListOutput<AnalysisResult>>;
34
43
  subscribeToAnalysisResult(subscriptionId: string, subscriber: AnalysisResultSubscriber): Promise<void>;
35
44
  unsubscribeFromAnalysisResult(subscriptionId: string): void;
45
+ getOrganizationAnalysis(input: GetOrganizationAnalysisInput): Promise<OrganizationAnalysis | undefined>;
36
46
  }
@@ -15,3 +15,25 @@ import { Pagination } from './common';
15
15
  export interface ListDataHoldersInput extends Pagination {
16
16
  virtualPresenceId: string;
17
17
  }
18
+ /**
19
+ * Properties required to list scan summaries for a data holder.
20
+ *
21
+ * @interface ListDataHolderScanSummariesInput
22
+ * @property {string} dataHolderId The identifier of the data holder to list scan summaries for.
23
+ * @property {number} limit Number of items to return.
24
+ * @property {string} nextToken A token generated by a previous call.
25
+ */
26
+ export interface ListDataHolderScanSummariesInput extends Pagination {
27
+ dataHolderId: string;
28
+ }
29
+ /**
30
+ * Options to control what `getDataHolder` returns.
31
+ *
32
+ * @interface GetDataHolderOptions
33
+ * @property {boolean} includeScanSummary Whether to also fetch and attach the most recent
34
+ * scan summary to the returned data holder. Defaults to `true`. When `true`, the data holder
35
+ * and its latest scan summary are fetched concurrently.
36
+ */
37
+ export interface GetDataHolderOptions {
38
+ includeScanSummary?: boolean;
39
+ }
@@ -6,4 +6,5 @@
6
6
  export * from './analysisResult';
7
7
  export * from './common';
8
8
  export * from './dataHolder';
9
+ export * from './organizationAnalysis';
9
10
  export * from './virtualPresence';
@@ -0,0 +1,18 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { OrganizationAnalysisMode } from '../typings/organizationAnalysis';
7
+ /**
8
+ * Properties required to obtain an organization analysis.
9
+ *
10
+ * @interface GetOrganizationAnalysisInput
11
+ * @property {string} domain The domain to analyze.
12
+ * @property {OrganizationAnalysisMode} mode How to obtain source results. When omitted, the
13
+ * backend behaves as `Analyze` (read-through).
14
+ */
15
+ export interface GetOrganizationAnalysisInput {
16
+ domain: string;
17
+ mode?: OrganizationAnalysisMode;
18
+ }