@sudoplatform/sudo-privacy-interaction 2.0.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 (100) hide show
  1. package/cjs/gen/graphqlTypes.js +1727 -772
  2. package/cjs/private/data/analysis-result/transformer/privacyScoreTransformer.js +8 -0
  3. package/cjs/private/data/common/apiClient.js +23 -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/virtual-presence/transformer/virtualPresenceTransformer.js +2 -0
  10. package/cjs/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +24 -0
  11. package/cjs/private/domain/entities/organization-analysis/organizationAnalysisService.js +7 -0
  12. package/cjs/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.js +29 -0
  13. package/cjs/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.js +25 -0
  14. package/cjs/public/defaultSudoPrivacyInteractionClient.js +75 -6
  15. package/cjs/public/inputs/index.js +1 -0
  16. package/cjs/public/inputs/organizationAnalysis.js +7 -0
  17. package/cjs/public/typings/index.js +1 -0
  18. package/cjs/public/typings/organizationAnalysis.js +24 -0
  19. package/docs/assets/hierarchy.js +1 -1
  20. package/docs/assets/navigation.js +1 -1
  21. package/docs/assets/search.js +1 -1
  22. package/docs/classes/DefaultSudoPrivacyInteractionClient.html +69 -20
  23. package/docs/enums/DataCategory.html +18 -18
  24. package/docs/enums/DataHolderProtectionState.html +5 -5
  25. package/docs/enums/OrganizationAnalysisMode.html +70 -0
  26. package/docs/enums/OrganizationCategory.html +30 -30
  27. package/docs/enums/ProviderType.html +3 -3
  28. package/docs/enums/RetentionStyle.html +5 -5
  29. package/docs/enums/ShareStyle.html +6 -6
  30. package/docs/enums/SignalValue.html +4 -4
  31. package/docs/enums/VirtualPresenceState.html +7 -7
  32. package/docs/hierarchy.html +6 -5
  33. package/docs/interfaces/CapabilitySignals.html +9 -9
  34. package/docs/interfaces/CategorySignals.html +11 -11
  35. package/docs/interfaces/DataHolder.html +24 -14
  36. package/docs/interfaces/DataHolderScanSummary.html +158 -0
  37. package/docs/interfaces/GetDataHolderOptions.html +63 -0
  38. package/docs/interfaces/GetOrganizationAnalysisInput.html +70 -0
  39. package/docs/interfaces/ListAnalysisResultsInput.html +1 -1
  40. package/docs/interfaces/ListDataHolderScanSummariesInput.html +85 -0
  41. package/docs/interfaces/ListDataHoldersInput.html +1 -1
  42. package/docs/interfaces/ListVirtualPresencesInput.html +1 -1
  43. package/docs/interfaces/OrganizationAnalysis.html +131 -0
  44. package/docs/interfaces/OrganizationIdentity.html +5 -5
  45. package/docs/interfaces/Pagination.html +2 -1
  46. package/docs/interfaces/PrivacyScore.html +13 -5
  47. package/docs/interfaces/PrivacySummary.html +4 -4
  48. package/docs/interfaces/RetentionInfo.html +4 -4
  49. package/docs/interfaces/RiskIndicators.html +8 -8
  50. package/docs/interfaces/ScoreContribution.html +3 -3
  51. package/docs/interfaces/ScoreCoverage.html +70 -0
  52. package/docs/interfaces/SudoPrivacyInteractionClient.html +67 -20
  53. package/docs/interfaces/VirtualPresence.html +21 -12
  54. package/docs/modules.html +4 -4
  55. package/docs/types/SudoPrivacyInteractionClientOptions.html +2 -2
  56. package/lib/gen/graphqlTypes.js +1726 -771
  57. package/lib/private/data/analysis-result/transformer/privacyScoreTransformer.js +8 -0
  58. package/lib/private/data/common/apiClient.js +24 -1
  59. package/lib/private/data/data-holder/defaultDataHolderService.js +12 -0
  60. package/lib/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.js +52 -0
  61. package/lib/private/data/organization-analysis/defaultOrganizationAnalysisService.js +27 -0
  62. package/lib/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.js +25 -0
  63. package/lib/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +41 -0
  64. package/lib/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +2 -0
  65. package/lib/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +21 -0
  66. package/lib/private/domain/entities/organization-analysis/organizationAnalysisService.js +6 -0
  67. package/lib/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.js +25 -0
  68. package/lib/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.js +21 -0
  69. package/lib/public/defaultSudoPrivacyInteractionClient.js +75 -6
  70. package/lib/public/inputs/index.js +1 -0
  71. package/lib/public/inputs/organizationAnalysis.js +6 -0
  72. package/lib/public/typings/index.js +1 -0
  73. package/lib/public/typings/organizationAnalysis.js +21 -0
  74. package/package.json +4 -2
  75. package/types/gen/graphqlTypes.d.ts +324 -0
  76. package/types/private/data/common/apiClient.d.ts +10 -1
  77. package/types/private/data/common/baseSubscriptionManager.d.ts +5 -0
  78. package/types/private/data/data-holder/defaultDataHolderService.d.ts +3 -1
  79. package/types/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.d.ts +18 -0
  80. package/types/private/data/organization-analysis/defaultOrganizationAnalysisService.d.ts +15 -0
  81. package/types/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.d.ts +12 -0
  82. package/types/private/data/organization-analysis/transformer/organizationAnalysisTransformer.d.ts +14 -0
  83. package/types/private/domain/entities/analysis-result/analysisResultEntity.d.ts +14 -0
  84. package/types/private/domain/entities/data-holder/dataHolderEntity.d.ts +34 -0
  85. package/types/private/domain/entities/data-holder/dataHolderService.d.ts +35 -1
  86. package/types/private/domain/entities/organization-analysis/organizationAnalysisEntity.d.ts +53 -0
  87. package/types/private/domain/entities/organization-analysis/organizationAnalysisService.d.ts +35 -0
  88. package/types/private/domain/entities/virtual-presence/virtualPresenceEntity.d.ts +3 -0
  89. package/types/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.d.ts +36 -0
  90. package/types/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.d.ts +16 -0
  91. package/types/public/defaultSudoPrivacyInteractionClient.d.ts +9 -3
  92. package/types/public/inputs/dataHolder.d.ts +22 -0
  93. package/types/public/inputs/index.d.ts +1 -0
  94. package/types/public/inputs/organizationAnalysis.d.ts +18 -0
  95. package/types/public/sudoPrivacyInteractionClient.d.ts +25 -3
  96. package/types/public/typings/analysisResult.d.ts +14 -0
  97. package/types/public/typings/dataHolder.d.ts +38 -0
  98. package/types/public/typings/index.d.ts +1 -0
  99. package/types/public/typings/organizationAnalysis.d.ts +53 -0
  100. package/types/public/typings/virtualPresence.d.ts +3 -0
@@ -11,6 +11,10 @@ export class PrivacyScoreTransformer {
11
11
  aspect: b.aspect,
12
12
  contribution: b.contribution,
13
13
  })),
14
+ coverage: {
15
+ evaluated: data.coverage.evaluated,
16
+ total: data.coverage.total,
17
+ },
14
18
  };
15
19
  }
16
20
  fromEntityToAPI(entity) {
@@ -20,6 +24,10 @@ export class PrivacyScoreTransformer {
20
24
  aspect: b.aspect,
21
25
  contribution: b.contribution,
22
26
  })),
27
+ coverage: {
28
+ evaluated: entity.coverage.evaluated,
29
+ total: entity.coverage.total,
30
+ },
23
31
  };
24
32
  }
25
33
  }
@@ -5,7 +5,7 @@
5
5
  */
6
6
  import { DefaultApiClientManager, } from '@sudoplatform/sudo-api-client';
7
7
  import { DefaultLogger, FatalError, UnknownGraphQLError, isGraphQLNetworkError, mapNetworkErrorToClientError, } from '@sudoplatform/sudo-common';
8
- import { ConnectVirtualPresenceDocument, DisconnectVirtualPresenceDocument, GetAnalysisResultDocument, GetDataHolderDocument, GetProviderConfigurationDocument, ListAnalysisResultsDocument, ListDataHoldersDocument, ListVirtualPresencesDocument, OnAnalysisResultUpdateDocument, OnDataHoldersUpdateDocument, OnVirtualPresenceUpdateDocument, RescanVirtualPresenceDocument, } from '../../../gen/graphqlTypes';
8
+ import { ConnectVirtualPresenceDocument, DisconnectVirtualPresenceDocument, GetAnalysisResultDocument, GetDataHolderDocument, GetProviderConfigurationDocument, GetOrganizationAnalysisDocument, ListAnalysisResultsDocument, ListDataHolderScanSummariesDocument, ListDataHoldersDocument, ListVirtualPresencesDocument, OnAnalysisResultUpdateDocument, OnDataHoldersUpdateDocument, OnVirtualPresenceUpdateDocument, RescanVirtualPresenceDocument, } from '../../../gen/graphqlTypes';
9
9
  import { ErrorTransformer } from './transformer/errorTransformer';
10
10
  export class ApiClient {
11
11
  log;
@@ -79,6 +79,18 @@ export class ApiClient {
79
79
  });
80
80
  return data.listDataHolders;
81
81
  }
82
+ async listDataHolderScanSummaries(input) {
83
+ const data = await this.performQuery({
84
+ query: ListDataHolderScanSummariesDocument,
85
+ variables: {
86
+ dataHolderId: input.dataHolderId,
87
+ limit: input.limit,
88
+ nextToken: input.nextToken,
89
+ },
90
+ calleeName: this.listDataHolderScanSummaries.name,
91
+ });
92
+ return data.listDataHolderScanSummaries;
93
+ }
82
94
  async getAnalysisResult(id) {
83
95
  const data = await this.performQuery({
84
96
  query: GetAnalysisResultDocument,
@@ -87,6 +99,17 @@ export class ApiClient {
87
99
  });
88
100
  return data.getAnalysisResult ?? undefined;
89
101
  }
102
+ async getOrganizationAnalysis(input) {
103
+ const data = await this.performQuery({
104
+ query: GetOrganizationAnalysisDocument,
105
+ variables: {
106
+ domain: input.domain,
107
+ mode: input.mode,
108
+ },
109
+ calleeName: this.getOrganizationAnalysis.name,
110
+ });
111
+ return data.getOrganizationAnalysis ?? undefined;
112
+ }
90
113
  async listAnalysisResults(input) {
91
114
  const data = await this.performQuery({
92
115
  query: ListAnalysisResultsDocument,
@@ -5,14 +5,18 @@
5
5
  */
6
6
  import { ConnectionState, } from '../../../public/typings/subscription';
7
7
  import { DataHolderSubscriptionManager } from './dataHolderSubscriptionManager';
8
+ import { DataHolderScanSummaryTransformer } from './transformer/dataHolderScanSummaryTransformer';
8
9
  import { DataHolderTransformer } from './transformer/dataHolderTransformer';
9
10
  export class DefaultDataHolderService {
10
11
  appSync;
11
12
  dataHolderTransformer;
13
+ dataHolderScanSummaryTransformer;
12
14
  subscriptionManager;
13
15
  constructor(appSync) {
14
16
  this.appSync = appSync;
15
17
  this.dataHolderTransformer = new DataHolderTransformer();
18
+ this.dataHolderScanSummaryTransformer =
19
+ new DataHolderScanSummaryTransformer();
16
20
  this.subscriptionManager = new DataHolderSubscriptionManager();
17
21
  }
18
22
  async get(id) {
@@ -33,6 +37,14 @@ export class DefaultDataHolderService {
33
37
  nextToken: result.nextToken ?? undefined,
34
38
  };
35
39
  }
40
+ async listScanSummaries(input) {
41
+ const result = await this.appSync.listDataHolderScanSummaries(input);
42
+ const scanSummaries = (result.items ?? []).map((item) => this.dataHolderScanSummaryTransformer.fromGraphQLToEntity(item));
43
+ return {
44
+ scanSummaries,
45
+ nextToken: result.nextToken ?? undefined,
46
+ };
47
+ }
36
48
  async subscribe(input) {
37
49
  this.subscriptionManager.subscribe(input.subscriptionId, input.subscriber);
38
50
  if (!this.subscriptionManager.getWatcher()) {
@@ -0,0 +1,52 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ export class DataHolderScanSummaryTransformer {
7
+ fromGraphQLToEntity(data) {
8
+ return {
9
+ dataHolderId: data.dataHolderId,
10
+ owner: data.owner,
11
+ scannedAt: new Date(data.scannedAtEpochMs),
12
+ scanRangeFrom: new Date(data.scanRangeFromEpochMs),
13
+ scanRangeTo: new Date(data.scanRangeToEpochMs),
14
+ emailCount: data.emailCount,
15
+ readCount: data.readCount,
16
+ readRate: data.readRate,
17
+ marketingEmailCount: data.marketingEmailCount,
18
+ marketingEmailOpened: data.marketingEmailOpened,
19
+ marketingOpenRate: data.marketingOpenRate,
20
+ categoryBreakdown: this.parseCategoryBreakdown(data.categoryBreakdown),
21
+ uncategorizedCount: data.uncategorizedCount,
22
+ };
23
+ }
24
+ fromEntityToAPI(entity) {
25
+ return {
26
+ dataHolderId: entity.dataHolderId,
27
+ owner: entity.owner,
28
+ scannedAt: entity.scannedAt,
29
+ scanRangeFrom: entity.scanRangeFrom,
30
+ scanRangeTo: entity.scanRangeTo,
31
+ emailCount: entity.emailCount,
32
+ readCount: entity.readCount,
33
+ readRate: entity.readRate,
34
+ marketingEmailCount: entity.marketingEmailCount,
35
+ marketingEmailOpened: entity.marketingEmailOpened,
36
+ marketingOpenRate: entity.marketingOpenRate,
37
+ categoryBreakdown: { ...entity.categoryBreakdown },
38
+ uncategorizedCount: entity.uncategorizedCount,
39
+ };
40
+ }
41
+ /**
42
+ * The `categoryBreakdown` field is an AWSJSON scalar, which is delivered as a
43
+ * JSON-encoded string. Parse it into a category-to-count map. Accepts an
44
+ * already-parsed object for resilience.
45
+ */
46
+ parseCategoryBreakdown(value) {
47
+ if (typeof value === 'string') {
48
+ return JSON.parse(value);
49
+ }
50
+ return value ?? {};
51
+ }
52
+ }
@@ -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 { OrganizationAnalysisModeTransformer } from './transformer/organizationAnalysisModeTransformer';
7
+ import { OrganizationAnalysisTransformer } from './transformer/organizationAnalysisTransformer';
8
+ export class DefaultOrganizationAnalysisService {
9
+ appSync;
10
+ organizationAnalysisTransformer = new OrganizationAnalysisTransformer();
11
+ modeTransformer = new OrganizationAnalysisModeTransformer();
12
+ constructor(appSync) {
13
+ this.appSync = appSync;
14
+ }
15
+ async getOrganizationAnalysis(input) {
16
+ const result = await this.appSync.getOrganizationAnalysis({
17
+ domain: input.domain,
18
+ mode: input.mode
19
+ ? this.modeTransformer.fromEntityToGraphQL(input.mode)
20
+ : undefined,
21
+ });
22
+ if (!result) {
23
+ return undefined;
24
+ }
25
+ return this.organizationAnalysisTransformer.fromGraphQLToEntity(result);
26
+ }
27
+ }
@@ -0,0 +1,25 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { OrganizationAnalysisMode } from '../../../../public/typings/organizationAnalysis';
7
+ import { OrganizationAnalysisModeEntity } from '../../../domain/entities/organization-analysis/organizationAnalysisEntity';
8
+ export class OrganizationAnalysisModeTransformer {
9
+ fromAPIToEntity(mode) {
10
+ switch (mode) {
11
+ case OrganizationAnalysisMode.Analyze:
12
+ return OrganizationAnalysisModeEntity.Analyze;
13
+ case OrganizationAnalysisMode.Fetch:
14
+ return OrganizationAnalysisModeEntity.Fetch;
15
+ }
16
+ }
17
+ fromEntityToGraphQL(mode) {
18
+ switch (mode) {
19
+ case OrganizationAnalysisModeEntity.Analyze:
20
+ return 'ANALYZE';
21
+ case OrganizationAnalysisModeEntity.Fetch:
22
+ return 'FETCH';
23
+ }
24
+ }
25
+ }
@@ -0,0 +1,41 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { AnalysisResultDataTransformer } from '../../analysis-result/transformer/analysisResultDataTransformer';
7
+ import { AnalysisResultStatusTransformer } from '../../analysis-result/transformer/analysisResultStatusTransformer';
8
+ export class OrganizationAnalysisTransformer {
9
+ statusTransformer = new AnalysisResultStatusTransformer();
10
+ dataTransformer = new AnalysisResultDataTransformer();
11
+ fromGraphQLToEntity(data) {
12
+ return {
13
+ id: data.id,
14
+ domain: data.domain,
15
+ status: this.statusTransformer.fromGraphQLToEntity(data.status),
16
+ lastAnalyzedAt: new Date(data.lastAnalyzedAtEpochMs),
17
+ data: data.data
18
+ ? this.dataTransformer.fromGraphQLToEntity(data.data)
19
+ : undefined,
20
+ owner: data.owner,
21
+ version: data.version,
22
+ createdAt: new Date(data.createdAtEpochMs),
23
+ updatedAt: new Date(data.updatedAtEpochMs),
24
+ };
25
+ }
26
+ fromEntityToAPI(entity) {
27
+ return {
28
+ id: entity.id,
29
+ domain: entity.domain,
30
+ status: this.statusTransformer.fromEntityToAPI(entity.status),
31
+ lastAnalyzedAt: entity.lastAnalyzedAt,
32
+ data: entity.data
33
+ ? this.dataTransformer.fromEntityToAPI(entity.data)
34
+ : undefined,
35
+ owner: entity.owner,
36
+ version: entity.version,
37
+ createdAt: entity.createdAt,
38
+ updatedAt: entity.updatedAt,
39
+ };
40
+ }
41
+ }
@@ -17,6 +17,7 @@ export class VirtualPresenceTransformer {
17
17
  identifier: entity.identifier,
18
18
  state: virtualPresenceStateTransformer.fromEntityToAPI(entity.state),
19
19
  lastScannedAt: entity.lastScannedAt,
20
+ lastScanFailureReason: entity.lastScanFailureReason,
20
21
  createdAt: entity.createdAt,
21
22
  updatedAt: entity.updatedAt,
22
23
  };
@@ -32,6 +33,7 @@ export class VirtualPresenceTransformer {
32
33
  identifier: data.identifier,
33
34
  state: virtualPresenceStateTransformer.fromGraphQLToEntity(data.state),
34
35
  lastScannedAt: new Date(data.lastScannedAtEpochMs),
36
+ lastScanFailureReason: data.lastScanFailureReason ?? undefined,
35
37
  createdAt: new Date(data.createdAtEpochMs),
36
38
  updatedAt: new Date(data.updatedAtEpochMs),
37
39
  };
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ /**
7
+ * Controls how `getOrganizationAnalysis` obtains source results when the stored
8
+ * analysis is stale or absent.
9
+ *
10
+ * @property ANALYZE Read-through: request analysis from the sources, which may compute and
11
+ * leave the result PENDING until asynchronous work completes.
12
+ * @property FETCH Pull only the sources' existing values; never request new work. A stale
13
+ * domain with no existing source value is not moved to PENDING.
14
+ *
15
+ * @enum
16
+ */
17
+ export var OrganizationAnalysisModeEntity;
18
+ (function (OrganizationAnalysisModeEntity) {
19
+ OrganizationAnalysisModeEntity["Analyze"] = "ANALYZE";
20
+ OrganizationAnalysisModeEntity["Fetch"] = "FETCH";
21
+ })(OrganizationAnalysisModeEntity || (OrganizationAnalysisModeEntity = {}));
@@ -0,0 +1,6 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ export {};
@@ -0,0 +1,25 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { DefaultLogger } from '@sudoplatform/sudo-common';
7
+ /**
8
+ * Application business logic for listing scan summaries for a data holder.
9
+ */
10
+ export class ListDataHolderScanSummariesUseCase {
11
+ dataHolderService;
12
+ log;
13
+ constructor(dataHolderService) {
14
+ this.dataHolderService = dataHolderService;
15
+ this.log = new DefaultLogger(this.constructor.name);
16
+ }
17
+ async execute(input) {
18
+ this.log.debug(this.constructor.name, { input });
19
+ return await this.dataHolderService.listScanSummaries({
20
+ dataHolderId: input.dataHolderId,
21
+ limit: input.limit,
22
+ nextToken: input.nextToken,
23
+ });
24
+ }
25
+ }
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ import { DefaultLogger } from '@sudoplatform/sudo-common';
7
+ /**
8
+ * Application business logic for obtaining an organization analysis.
9
+ */
10
+ export class GetOrganizationAnalysisUseCase {
11
+ organizationAnalysisService;
12
+ log;
13
+ constructor(organizationAnalysisService) {
14
+ this.organizationAnalysisService = organizationAnalysisService;
15
+ this.log = new DefaultLogger(this.constructor.name);
16
+ }
17
+ async execute(input) {
18
+ this.log.debug(this.constructor.name, { input });
19
+ return await this.organizationAnalysisService.getOrganizationAnalysis(input);
20
+ }
21
+ }
@@ -8,9 +8,13 @@ import { DefaultAnalysisResultService } from '../private/data/analysis-result/de
8
8
  import { AnalysisResultTransformer } from '../private/data/analysis-result/transformer/analysisResultTransformer';
9
9
  import { ApiClient } from '../private/data/common/apiClient';
10
10
  import { DefaultDataHolderService } from '../private/data/data-holder/defaultDataHolderService';
11
+ import { DataHolderScanSummaryTransformer } from '../private/data/data-holder/transformer/dataHolderScanSummaryTransformer';
11
12
  import { DataHolderTransformer } from '../private/data/data-holder/transformer/dataHolderTransformer';
12
13
  import { DefaultProviderConfigurationService } from '../private/data/provider-configuration/defaultProviderConfigurationService';
13
14
  import { ProviderConfigurationTransformer } from '../private/data/provider-configuration/transformer/providerConfigurationTransformer';
15
+ import { DefaultOrganizationAnalysisService } from '../private/data/organization-analysis/defaultOrganizationAnalysisService';
16
+ import { OrganizationAnalysisModeTransformer } from '../private/data/organization-analysis/transformer/organizationAnalysisModeTransformer';
17
+ import { OrganizationAnalysisTransformer } from '../private/data/organization-analysis/transformer/organizationAnalysisTransformer';
14
18
  import { DefaultVirtualPresenceService } from '../private/data/virtual-presence/defaultVirtualPresenceService';
15
19
  import { RelationshipProviderTransformer } from '../private/data/virtual-presence/transformer/relationshipProviderTransformer';
16
20
  import { VirtualPresenceTransformer } from '../private/data/virtual-presence/transformer/virtualPresenceTransformer';
@@ -19,7 +23,9 @@ import { ListAnalysisResultsUseCase } from '../private/domain/use-cases/analysis
19
23
  import { SubscribeToAnalysisResultUseCase } from '../private/domain/use-cases/analysis-result/subscribeToAnalysisResultUseCase';
20
24
  import { UnsubscribeFromAnalysisResultUseCase } from '../private/domain/use-cases/analysis-result/unsubscribeFromAnalysisResultUseCase';
21
25
  import { GetProviderConfigurationUseCase } from '../private/domain/use-cases/configuration/getProviderConfigurationUseCase';
26
+ import { GetOrganizationAnalysisUseCase } from '../private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase';
22
27
  import { GetDataHolderUseCase } from '../private/domain/use-cases/data-holder/getDataHolderUseCase';
28
+ import { ListDataHolderScanSummariesUseCase } from '../private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase';
23
29
  import { ListDataHoldersUseCase } from '../private/domain/use-cases/data-holder/listDataHoldersUseCase';
24
30
  import { SubscribeToDataHoldersUseCase } from '../private/domain/use-cases/data-holder/subscribeToDataHoldersUseCase';
25
31
  import { UnsubscribeFromDataHoldersUseCase } from '../private/domain/use-cases/data-holder/unsubscribeFromDataHoldersUseCase';
@@ -37,11 +43,15 @@ export class DefaultSudoPrivacyInteractionClient {
37
43
  virtualPresenceService;
38
44
  dataHolderService;
39
45
  analysisResultService;
46
+ organizationAnalysisService;
40
47
  providerConfigurationTransformer;
41
48
  virtualPresenceTransformer;
42
49
  relationshipProviderTransformer;
43
50
  dataHolderTransformer;
51
+ dataHolderScanSummaryTransformer;
44
52
  analysisResultTransformer;
53
+ organizationAnalysisTransformer;
54
+ organizationAnalysisModeTransformer;
45
55
  log;
46
56
  constructor(opts) {
47
57
  this.log = new DefaultLogger(this.constructor.name);
@@ -52,12 +62,18 @@ export class DefaultSudoPrivacyInteractionClient {
52
62
  this.virtualPresenceService = new DefaultVirtualPresenceService(this.apiClient);
53
63
  this.dataHolderService = new DefaultDataHolderService(this.apiClient);
54
64
  this.analysisResultService = new DefaultAnalysisResultService(this.apiClient);
65
+ this.organizationAnalysisService = new DefaultOrganizationAnalysisService(this.apiClient);
55
66
  this.providerConfigurationTransformer =
56
67
  new ProviderConfigurationTransformer();
57
68
  this.virtualPresenceTransformer = new VirtualPresenceTransformer();
58
69
  this.relationshipProviderTransformer = new RelationshipProviderTransformer();
59
70
  this.dataHolderTransformer = new DataHolderTransformer();
71
+ this.dataHolderScanSummaryTransformer =
72
+ new DataHolderScanSummaryTransformer();
60
73
  this.analysisResultTransformer = new AnalysisResultTransformer();
74
+ this.organizationAnalysisTransformer = new OrganizationAnalysisTransformer();
75
+ this.organizationAnalysisModeTransformer =
76
+ new OrganizationAnalysisModeTransformer();
61
77
  }
62
78
  async getProviderConfiguration() {
63
79
  this.log.debug(this.getProviderConfiguration.name);
@@ -129,14 +145,42 @@ export class DefaultSudoPrivacyInteractionClient {
129
145
  const useCase = new UnsubscribeFromVirtualPresenceUseCase(this.virtualPresenceService);
130
146
  useCase.execute(subscriptionId);
131
147
  }
132
- async getDataHolder(id) {
133
- this.log.debug(this.getDataHolder.name, { id });
134
- const useCase = new GetDataHolderUseCase(this.dataHolderService);
135
- const result = await useCase.execute(id);
136
- if (!result) {
148
+ async getDataHolder(id, options) {
149
+ this.log.debug(this.getDataHolder.name, { id, options });
150
+ const includeScanSummary = options?.includeScanSummary ?? true;
151
+ const getDataHolderUseCase = new GetDataHolderUseCase(this.dataHolderService);
152
+ // Fetch the data holder and (optionally) its latest scan summary concurrently
153
+ // to minimise latency. The scan summary is a best-effort convenience: if it
154
+ // fails, the data holder is still returned without a `latestScanSummary`.
155
+ const [dataHolderOutcome, scanSummariesOutcome] = await Promise.allSettled([
156
+ getDataHolderUseCase.execute(id),
157
+ includeScanSummary
158
+ ? new ListDataHolderScanSummariesUseCase(this.dataHolderService).execute({ dataHolderId: id, limit: 1 })
159
+ : Promise.resolve(undefined),
160
+ ]);
161
+ // The data holder is the primary result; propagate its error to the caller.
162
+ if (dataHolderOutcome.status === 'rejected') {
163
+ throw dataHolderOutcome.reason;
164
+ }
165
+ const dataHolderResult = dataHolderOutcome.value;
166
+ if (!dataHolderResult) {
137
167
  return undefined;
138
168
  }
139
- return this.dataHolderTransformer.fromEntityToAPI(result);
169
+ const dataHolder = this.dataHolderTransformer.fromEntityToAPI(dataHolderResult);
170
+ if (scanSummariesOutcome.status === 'fulfilled') {
171
+ const latestScanSummaryEntity = scanSummariesOutcome.value?.scanSummaries[0];
172
+ if (latestScanSummaryEntity) {
173
+ dataHolder.latestScanSummary =
174
+ this.dataHolderScanSummaryTransformer.fromEntityToAPI(latestScanSummaryEntity);
175
+ }
176
+ }
177
+ else {
178
+ this.log.error('Failed to fetch latest scan summary for data holder', {
179
+ id,
180
+ error: scanSummariesOutcome.reason,
181
+ });
182
+ }
183
+ return dataHolder;
140
184
  }
141
185
  async listDataHolders(input) {
142
186
  this.log.debug(this.listDataHolders.name, { input });
@@ -149,6 +193,17 @@ export class DefaultSudoPrivacyInteractionClient {
149
193
  const transformedDataHolders = dataHolders.map((dataHolder) => this.dataHolderTransformer.fromEntityToAPI(dataHolder));
150
194
  return { items: transformedDataHolders, nextToken: resultNextToken };
151
195
  }
196
+ async listDataHolderScanSummaries(input) {
197
+ this.log.debug(this.listDataHolderScanSummaries.name, { input });
198
+ const useCase = new ListDataHolderScanSummariesUseCase(this.dataHolderService);
199
+ const { scanSummaries, nextToken: resultNextToken } = await useCase.execute({
200
+ dataHolderId: input.dataHolderId,
201
+ limit: input.limit,
202
+ nextToken: input.nextToken,
203
+ });
204
+ const transformedScanSummaries = scanSummaries.map((scanSummary) => this.dataHolderScanSummaryTransformer.fromEntityToAPI(scanSummary));
205
+ return { items: transformedScanSummaries, nextToken: resultNextToken };
206
+ }
152
207
  async subscribeToDataHolders(subscriptionId, subscriber) {
153
208
  this.log.debug(this.subscribeToDataHolders.name, {
154
209
  subscriptionId,
@@ -197,4 +252,18 @@ export class DefaultSudoPrivacyInteractionClient {
197
252
  const useCase = new UnsubscribeFromAnalysisResultUseCase(this.analysisResultService);
198
253
  useCase.execute(subscriptionId);
199
254
  }
255
+ async getOrganizationAnalysis(input) {
256
+ this.log.debug(this.getOrganizationAnalysis.name, { input });
257
+ const useCase = new GetOrganizationAnalysisUseCase(this.organizationAnalysisService);
258
+ const result = await useCase.execute({
259
+ domain: input.domain,
260
+ mode: input.mode
261
+ ? this.organizationAnalysisModeTransformer.fromAPIToEntity(input.mode)
262
+ : undefined,
263
+ });
264
+ if (!result) {
265
+ return undefined;
266
+ }
267
+ return this.organizationAnalysisTransformer.fromEntityToAPI(result);
268
+ }
200
269
  }
@@ -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,6 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ export {};
@@ -5,6 +5,7 @@
5
5
  */
6
6
  export * from './analysisResult';
7
7
  export * from './dataHolder';
8
+ export * from './organizationAnalysis';
8
9
  export * from './providerConfiguration';
9
10
  export * from './subscription';
10
11
  export * from './virtualPresence';
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
3
+ *
4
+ * SPDX-License-Identifier: Apache-2.0
5
+ */
6
+ /**
7
+ * Controls how `getOrganizationAnalysis` obtains source results when the stored
8
+ * analysis is stale or absent.
9
+ *
10
+ * @property Analyze Read-through: request analysis from the sources, which may compute and
11
+ * leave the result pending until asynchronous work completes.
12
+ * @property Fetch Pull only the sources' existing values; never request new work. A stale
13
+ * domain with no existing source value is not moved to pending.
14
+ *
15
+ * @enum
16
+ */
17
+ export var OrganizationAnalysisMode;
18
+ (function (OrganizationAnalysisMode) {
19
+ OrganizationAnalysisMode["Analyze"] = "ANALYZE";
20
+ OrganizationAnalysisMode["Fetch"] = "FETCH";
21
+ })(OrganizationAnalysisMode || (OrganizationAnalysisMode = {}));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sudoplatform/sudo-privacy-interaction",
3
- "version": "2.0.0",
3
+ "version": "2.1.0",
4
4
  "author": "Anonyome Labs, Inc.",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {
@@ -84,6 +84,7 @@
84
84
  "@sudoplatform/sudo-entitlements-admin": "^13.0.2",
85
85
  "@sudoplatform/sudo-user": "^17.1.1",
86
86
  "@types/uuid": "^10.0.0",
87
+ "@types/ws": "^8.18.1",
87
88
  "@typescript-eslint/eslint-plugin": "^8.26.1",
88
89
  "@typescript-eslint/parser": "^8.26.1",
89
90
  "@vitest/coverage-v8": "^4.1.11",
@@ -104,7 +105,8 @@
104
105
  "typescript": "^5.9.2",
105
106
  "uuid": "^11.1.0",
106
107
  "vitest": "^4.1.11",
107
- "wait-for-expect": "^4.0.0"
108
+ "wait-for-expect": "^4.0.0",
109
+ "ws": "^8.21.3"
108
110
  },
109
111
  "packageManager": "yarn@4.9.2+sha256.ca4310f8ba997b4643a000ce512d9772e01c1485df35511114b325315960acb7",
110
112
  "auditSuppressions": {