@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
@@ -116,6 +116,10 @@ export type AnalysisResultUpdate = {
116
116
  version: Scalars['Int']['output'];
117
117
  virtualPresenceId: Scalars['ID']['output'];
118
118
  };
119
+ export type AuthCodeInput = {
120
+ authCode: Scalars['String']['input'];
121
+ redirectUri?: InputMaybe<Scalars['String']['input']>;
122
+ };
119
123
  export type CapabilitySignals = {
120
124
  sellsPersonalInformation: SignalValue;
121
125
  supportsAccountCreation: SignalValue;
@@ -139,8 +143,9 @@ export type CategorySignals = {
139
143
  userCanOptOut: SignalValue;
140
144
  };
141
145
  export type ConnectVirtualPresenceInput = {
142
- authCode?: InputMaybe<Scalars['String']['input']>;
146
+ authCode?: InputMaybe<AuthCodeInput>;
143
147
  refreshToken?: InputMaybe<RefreshTokenInput>;
148
+ relationshipProvider?: InputMaybe<RelationshipProvider>;
144
149
  };
145
150
  export type DataCategory = 'ACCOUNT_PROFILE' | 'AUTHENTICATION' | 'BACKGROUND' | 'BIOMETRIC' | 'COMMUNICATION' | 'CONTACTS' | 'DEMOGRAPHIC' | 'DEVICE_IDENTIFIER' | 'FINANCIAL' | 'GOVERNMENT_ISSUED' | 'HEALTH' | 'INFERENCES' | 'LOCATION' | 'OTHER' | 'PII' | 'THIRD_PARTY_DATA' | 'USAGE' | '%future added value';
146
151
  export type DataHolder = {
@@ -161,6 +166,25 @@ export type DataHolderConnection = {
161
166
  nextToken?: Maybe<Scalars['String']['output']>;
162
167
  };
163
168
  export type DataHolderProtectionState = 'ACTION_REQUESTED' | 'MONITORED' | 'RESOLVED' | '%future added value';
169
+ export type DataHolderScanSummary = {
170
+ categoryBreakdown: Scalars['AWSJSON']['output'];
171
+ dataHolderId: Scalars['ID']['output'];
172
+ emailCount: Scalars['Int']['output'];
173
+ marketingEmailCount: Scalars['Int']['output'];
174
+ marketingEmailOpened: Scalars['Int']['output'];
175
+ marketingOpenRate: Scalars['Float']['output'];
176
+ owner: Scalars['ID']['output'];
177
+ readCount: Scalars['Int']['output'];
178
+ readRate: Scalars['Float']['output'];
179
+ scanRangeFromEpochMs: Scalars['Float']['output'];
180
+ scanRangeToEpochMs: Scalars['Float']['output'];
181
+ scannedAtEpochMs: Scalars['Float']['output'];
182
+ uncategorizedCount: Scalars['Int']['output'];
183
+ };
184
+ export type DataHolderScanSummaryConnection = {
185
+ items: Array<DataHolderScanSummary>;
186
+ nextToken?: Maybe<Scalars['String']['output']>;
187
+ };
164
188
  export type DataHolderUpdateItem = {
165
189
  complianceConcern: Scalars['Boolean']['output'];
166
190
  createdAtEpochMs: Scalars['Float']['output'];
@@ -207,6 +231,18 @@ export type MutationRescanVirtualPresenceArgs = {
207
231
  id: Scalars['String']['input'];
208
232
  options?: InputMaybe<ScanOptionsInput>;
209
233
  };
234
+ export type OrganizationAnalysis = {
235
+ createdAtEpochMs: Scalars['Float']['output'];
236
+ data?: Maybe<AnalysisResultData>;
237
+ domain: Scalars['String']['output'];
238
+ id: Scalars['ID']['output'];
239
+ lastAnalyzedAtEpochMs: Scalars['Float']['output'];
240
+ owner: Scalars['ID']['output'];
241
+ status: AnalysisResultStatus;
242
+ updatedAtEpochMs: Scalars['Float']['output'];
243
+ version: Scalars['Int']['output'];
244
+ };
245
+ export type OrganizationAnalysisMode = 'ANALYZE' | 'FETCH' | '%future added value';
210
246
  export type OrganizationCategory = 'Automotive' | 'Communications' | 'CommunityAndCharity' | 'Cryptocurrency' | 'Dating' | 'Education' | 'Employment' | 'EnergyAndUtilities' | 'Entertainment' | 'Finance' | 'FoodAndDining' | 'Gambling' | 'Government' | 'Health' | 'Insurance' | 'Military' | 'News' | 'Other' | 'PersonalEmail' | 'PrivacyAndSecurity' | 'RealEstate' | 'ShippingAndDelivery' | 'Shopping' | 'SocialMedia' | 'SportsAndFitness' | 'Technology' | 'Transportation' | 'Travel' | 'VideoGames' | '%future added value';
211
247
  export type OrganizationIdentity = {
212
248
  brandName?: Maybe<Scalars['String']['output']>;
@@ -216,6 +252,7 @@ export type OrganizationIdentity = {
216
252
  };
217
253
  export type PrivacyScore = {
218
254
  breakdown: Array<ScoreContribution>;
255
+ coverage: ScoreCoverage;
219
256
  score: Scalars['Float']['output'];
220
257
  };
221
258
  export type PrivacySummary = {
@@ -223,14 +260,31 @@ export type PrivacySummary = {
223
260
  sourceLastUpdated?: Maybe<Scalars['String']['output']>;
224
261
  sourceUrl: Scalars['String']['output'];
225
262
  };
263
+ export type ProviderConfiguration = {
264
+ data: Scalars['ID']['output'];
265
+ };
226
266
  export type ProviderType = 'EMAIL' | '%future added value';
227
267
  export type Query = {
228
268
  /** Get a full analysis result by ID, including typed data. */
229
269
  getAnalysisResult?: Maybe<AnalysisResult>;
230
270
  /** Get a single data holder by ID */
231
271
  getDataHolder?: Maybe<DataHolder>;
272
+ /**
273
+ * Analyze (read-through) and return the shared, organization-generic analysis
274
+ * for a domain. Returns PENDING when an asynchronous source is still resolving;
275
+ * re-query for the terminal result. When mode is omitted, the behaviour is
276
+ * ANALYZE.
277
+ */
278
+ getOrganizationAnalysis?: Maybe<OrganizationAnalysis>;
279
+ /**
280
+ * Get the opaque provider configuration required by consumers to support
281
+ * the provider OAuth flow.
282
+ */
283
+ getProviderConfiguration: ProviderConfiguration;
232
284
  /** List analysis results for a virtual presence. */
233
285
  listAnalysisResults: AnalysisResultConnection;
286
+ /** List scan summaries for a data holder (most recent first) */
287
+ listDataHolderScanSummaries: DataHolderScanSummaryConnection;
234
288
  /** List data holders by virtual presence */
235
289
  listDataHolders: DataHolderConnection;
236
290
  /** List virtual presences for the authenticated user */
@@ -242,11 +296,20 @@ export type QueryGetAnalysisResultArgs = {
242
296
  export type QueryGetDataHolderArgs = {
243
297
  id: Scalars['ID']['input'];
244
298
  };
299
+ export type QueryGetOrganizationAnalysisArgs = {
300
+ domain: Scalars['String']['input'];
301
+ mode?: InputMaybe<OrganizationAnalysisMode>;
302
+ };
245
303
  export type QueryListAnalysisResultsArgs = {
246
304
  limit?: InputMaybe<Scalars['Int']['input']>;
247
305
  nextToken?: InputMaybe<Scalars['String']['input']>;
248
306
  virtualPresenceId: Scalars['ID']['input'];
249
307
  };
308
+ export type QueryListDataHolderScanSummariesArgs = {
309
+ dataHolderId: Scalars['ID']['input'];
310
+ limit?: InputMaybe<Scalars['Int']['input']>;
311
+ nextToken?: InputMaybe<Scalars['String']['input']>;
312
+ };
250
313
  export type QueryListDataHoldersArgs = {
251
314
  limit?: InputMaybe<Scalars['Int']['input']>;
252
315
  nextToken?: InputMaybe<Scalars['String']['input']>;
@@ -261,6 +324,7 @@ export type RefreshTokenInput = {
261
324
  refreshToken: Scalars['String']['input'];
262
325
  scopes?: InputMaybe<Array<Scalars['String']['input']>>;
263
326
  };
327
+ export type RelationshipProvider = 'GMAIL_PROVIDER' | 'TEST_PROVIDER' | '%future added value';
264
328
  export type RetentionInfo = {
265
329
  additionalInfo?: Maybe<Scalars['String']['output']>;
266
330
  style: RetentionStyle;
@@ -287,6 +351,10 @@ export type ScoreContribution = {
287
351
  aspect: Scalars['String']['output'];
288
352
  contribution: Scalars['Float']['output'];
289
353
  };
354
+ export type ScoreCoverage = {
355
+ evaluated: Scalars['Int']['output'];
356
+ total: Scalars['Int']['output'];
357
+ };
290
358
  export type ShareStyle = 'INFERENCE_SHARED' | 'NONE' | 'SHARED' | 'SHARED_WITH_CONSENT' | '%future added value';
291
359
  export type SignalValue = 'NO' | 'UNKNOWN' | 'YES' | '%future added value';
292
360
  export type Subscription = {
@@ -320,9 +388,11 @@ export type VirtualPresence = {
320
388
  createdAtEpochMs: Scalars['Float']['output'];
321
389
  id: Scalars['ID']['output'];
322
390
  identifier: Scalars['String']['output'];
391
+ lastScanFailureReason?: Maybe<Scalars['String']['output']>;
323
392
  lastScannedAtEpochMs: Scalars['Float']['output'];
324
393
  owner: Scalars['ID']['output'];
325
394
  providerType: ProviderType;
395
+ relationshipProvider?: Maybe<RelationshipProvider>;
326
396
  state: VirtualPresenceState;
327
397
  updatedAtEpochMs: Scalars['Float']['output'];
328
398
  version: Scalars['Int']['output'];
@@ -332,6 +402,66 @@ export type VirtualPresenceConnection = {
332
402
  nextToken?: Maybe<Scalars['String']['output']>;
333
403
  };
334
404
  export type VirtualPresenceState = 'CONNECTED' | 'ERROR' | 'INACTIVE' | 'NEEDS_REAUTH' | 'SCANNING' | '%future added value';
405
+ export type AnalysisResultDataFieldsFragment = {
406
+ attribution: Array<string>;
407
+ privacyScore?: {
408
+ score: number;
409
+ breakdown: Array<{
410
+ aspect: string;
411
+ contribution: number;
412
+ }>;
413
+ coverage: {
414
+ evaluated: number;
415
+ total: number;
416
+ };
417
+ } | null;
418
+ privacySummary: {
419
+ bulletPoints: Array<string>;
420
+ sourceUrl: string;
421
+ sourceLastUpdated?: string | null;
422
+ };
423
+ categories: Array<{
424
+ category: DataCategory;
425
+ collected: SignalValue;
426
+ dataLabels: Array<string>;
427
+ sharedWithThirdParties: ShareStyle;
428
+ monetized: SignalValue;
429
+ retained: SignalValue;
430
+ userCanOptOut: SignalValue;
431
+ requiredForService?: SignalValue | null;
432
+ requiredForLaw?: SignalValue | null;
433
+ retention?: {
434
+ style: RetentionStyle;
435
+ timeInDays?: number | null;
436
+ additionalInfo?: string | null;
437
+ } | null;
438
+ }>;
439
+ capabilities: {
440
+ supportsAccountCreation: SignalValue;
441
+ supportsAccountDeletion: SignalValue;
442
+ supportsDataDeletionRequests: SignalValue;
443
+ supportsDataExport: SignalValue;
444
+ supportsSubscriptions: SignalValue;
445
+ sellsPersonalInformation: SignalValue;
446
+ usesCookiesOrTracking: SignalValue;
447
+ supportsTwoFactorAuth: SignalValue;
448
+ };
449
+ riskIndicators: {
450
+ dataCollectionBreadth: number;
451
+ collectsSensitiveDataForNonEssentialPurposes: SignalValue;
452
+ sellsPersonalInformation: SignalValue;
453
+ maxRetentionDays?: number | null;
454
+ hasIndefiniteRetention: SignalValue;
455
+ encryptionPractices: SignalValue;
456
+ breachRisk: SignalValue;
457
+ };
458
+ organizationIdentity?: {
459
+ brandName?: string | null;
460
+ companyName?: string | null;
461
+ primaryCategory?: OrganizationCategory | null;
462
+ categories: Array<OrganizationCategory>;
463
+ } | null;
464
+ };
335
465
  export type AnalysisResultFieldsFragment = {
336
466
  id: string;
337
467
  virtualPresenceId: string;
@@ -350,6 +480,10 @@ export type AnalysisResultFieldsFragment = {
350
480
  aspect: string;
351
481
  contribution: number;
352
482
  }>;
483
+ coverage: {
484
+ evaluated: number;
485
+ total: number;
486
+ };
353
487
  } | null;
354
488
  privacySummary: {
355
489
  bulletPoints: Array<string>;
@@ -412,12 +546,98 @@ export type DataHolderFieldsFragment = {
412
546
  createdAtEpochMs: number;
413
547
  updatedAtEpochMs: number;
414
548
  };
549
+ export type DataHolderScanSummaryFieldsFragment = {
550
+ dataHolderId: string;
551
+ owner: string;
552
+ scannedAtEpochMs: number;
553
+ scanRangeFromEpochMs: number;
554
+ scanRangeToEpochMs: number;
555
+ emailCount: number;
556
+ readCount: number;
557
+ readRate: number;
558
+ marketingEmailCount: number;
559
+ marketingEmailOpened: number;
560
+ marketingOpenRate: number;
561
+ categoryBreakdown: any;
562
+ uncategorizedCount: number;
563
+ };
564
+ export type OrganizationAnalysisFieldsFragment = {
565
+ id: string;
566
+ domain: string;
567
+ status: AnalysisResultStatus;
568
+ lastAnalyzedAtEpochMs: number;
569
+ owner: string;
570
+ version: number;
571
+ createdAtEpochMs: number;
572
+ updatedAtEpochMs: number;
573
+ data?: {
574
+ attribution: Array<string>;
575
+ privacyScore?: {
576
+ score: number;
577
+ breakdown: Array<{
578
+ aspect: string;
579
+ contribution: number;
580
+ }>;
581
+ coverage: {
582
+ evaluated: number;
583
+ total: number;
584
+ };
585
+ } | null;
586
+ privacySummary: {
587
+ bulletPoints: Array<string>;
588
+ sourceUrl: string;
589
+ sourceLastUpdated?: string | null;
590
+ };
591
+ categories: Array<{
592
+ category: DataCategory;
593
+ collected: SignalValue;
594
+ dataLabels: Array<string>;
595
+ sharedWithThirdParties: ShareStyle;
596
+ monetized: SignalValue;
597
+ retained: SignalValue;
598
+ userCanOptOut: SignalValue;
599
+ requiredForService?: SignalValue | null;
600
+ requiredForLaw?: SignalValue | null;
601
+ retention?: {
602
+ style: RetentionStyle;
603
+ timeInDays?: number | null;
604
+ additionalInfo?: string | null;
605
+ } | null;
606
+ }>;
607
+ capabilities: {
608
+ supportsAccountCreation: SignalValue;
609
+ supportsAccountDeletion: SignalValue;
610
+ supportsDataDeletionRequests: SignalValue;
611
+ supportsDataExport: SignalValue;
612
+ supportsSubscriptions: SignalValue;
613
+ sellsPersonalInformation: SignalValue;
614
+ usesCookiesOrTracking: SignalValue;
615
+ supportsTwoFactorAuth: SignalValue;
616
+ };
617
+ riskIndicators: {
618
+ dataCollectionBreadth: number;
619
+ collectsSensitiveDataForNonEssentialPurposes: SignalValue;
620
+ sellsPersonalInformation: SignalValue;
621
+ maxRetentionDays?: number | null;
622
+ hasIndefiniteRetention: SignalValue;
623
+ encryptionPractices: SignalValue;
624
+ breachRisk: SignalValue;
625
+ };
626
+ organizationIdentity?: {
627
+ brandName?: string | null;
628
+ companyName?: string | null;
629
+ primaryCategory?: OrganizationCategory | null;
630
+ categories: Array<OrganizationCategory>;
631
+ } | null;
632
+ } | null;
633
+ };
415
634
  export type VirtualPresenceFieldsFragment = {
416
635
  id: string;
417
636
  providerType: ProviderType;
418
637
  identifier: string;
419
638
  state: VirtualPresenceState;
420
639
  lastScannedAtEpochMs: number;
640
+ lastScanFailureReason?: string | null;
421
641
  owner: string;
422
642
  version: number;
423
643
  createdAtEpochMs: number;
@@ -433,6 +653,7 @@ export type ConnectVirtualPresenceMutation = {
433
653
  identifier: string;
434
654
  state: VirtualPresenceState;
435
655
  lastScannedAtEpochMs: number;
656
+ lastScanFailureReason?: string | null;
436
657
  owner: string;
437
658
  version: number;
438
659
  createdAtEpochMs: number;
@@ -449,6 +670,7 @@ export type DisconnectVirtualPresenceMutation = {
449
670
  identifier: string;
450
671
  state: VirtualPresenceState;
451
672
  lastScannedAtEpochMs: number;
673
+ lastScanFailureReason?: string | null;
452
674
  owner: string;
453
675
  version: number;
454
676
  createdAtEpochMs: number;
@@ -466,12 +688,21 @@ export type RescanVirtualPresenceMutation = {
466
688
  identifier: string;
467
689
  state: VirtualPresenceState;
468
690
  lastScannedAtEpochMs: number;
691
+ lastScanFailureReason?: string | null;
469
692
  owner: string;
470
693
  version: number;
471
694
  createdAtEpochMs: number;
472
695
  updatedAtEpochMs: number;
473
696
  };
474
697
  };
698
+ export type GetProviderConfigurationQueryVariables = Exact<{
699
+ [key: string]: never;
700
+ }>;
701
+ export type GetProviderConfigurationQuery = {
702
+ getProviderConfiguration: {
703
+ data: string;
704
+ };
705
+ };
475
706
  export type ListVirtualPresencesQueryVariables = Exact<{
476
707
  input?: InputMaybe<ListVirtualPresencesInput>;
477
708
  }>;
@@ -484,6 +715,7 @@ export type ListVirtualPresencesQuery = {
484
715
  identifier: string;
485
716
  state: VirtualPresenceState;
486
717
  lastScannedAtEpochMs: number;
718
+ lastScanFailureReason?: string | null;
487
719
  owner: string;
488
720
  version: number;
489
721
  createdAtEpochMs: number;
@@ -554,6 +786,86 @@ export type GetAnalysisResultQuery = {
554
786
  aspect: string;
555
787
  contribution: number;
556
788
  }>;
789
+ coverage: {
790
+ evaluated: number;
791
+ total: number;
792
+ };
793
+ } | null;
794
+ privacySummary: {
795
+ bulletPoints: Array<string>;
796
+ sourceUrl: string;
797
+ sourceLastUpdated?: string | null;
798
+ };
799
+ categories: Array<{
800
+ category: DataCategory;
801
+ collected: SignalValue;
802
+ dataLabels: Array<string>;
803
+ sharedWithThirdParties: ShareStyle;
804
+ monetized: SignalValue;
805
+ retained: SignalValue;
806
+ userCanOptOut: SignalValue;
807
+ requiredForService?: SignalValue | null;
808
+ requiredForLaw?: SignalValue | null;
809
+ retention?: {
810
+ style: RetentionStyle;
811
+ timeInDays?: number | null;
812
+ additionalInfo?: string | null;
813
+ } | null;
814
+ }>;
815
+ capabilities: {
816
+ supportsAccountCreation: SignalValue;
817
+ supportsAccountDeletion: SignalValue;
818
+ supportsDataDeletionRequests: SignalValue;
819
+ supportsDataExport: SignalValue;
820
+ supportsSubscriptions: SignalValue;
821
+ sellsPersonalInformation: SignalValue;
822
+ usesCookiesOrTracking: SignalValue;
823
+ supportsTwoFactorAuth: SignalValue;
824
+ };
825
+ riskIndicators: {
826
+ dataCollectionBreadth: number;
827
+ collectsSensitiveDataForNonEssentialPurposes: SignalValue;
828
+ sellsPersonalInformation: SignalValue;
829
+ maxRetentionDays?: number | null;
830
+ hasIndefiniteRetention: SignalValue;
831
+ encryptionPractices: SignalValue;
832
+ breachRisk: SignalValue;
833
+ };
834
+ organizationIdentity?: {
835
+ brandName?: string | null;
836
+ companyName?: string | null;
837
+ primaryCategory?: OrganizationCategory | null;
838
+ categories: Array<OrganizationCategory>;
839
+ } | null;
840
+ } | null;
841
+ } | null;
842
+ };
843
+ export type GetOrganizationAnalysisQueryVariables = Exact<{
844
+ domain: Scalars['String']['input'];
845
+ mode?: InputMaybe<OrganizationAnalysisMode>;
846
+ }>;
847
+ export type GetOrganizationAnalysisQuery = {
848
+ getOrganizationAnalysis?: {
849
+ id: string;
850
+ domain: string;
851
+ status: AnalysisResultStatus;
852
+ lastAnalyzedAtEpochMs: number;
853
+ owner: string;
854
+ version: number;
855
+ createdAtEpochMs: number;
856
+ updatedAtEpochMs: number;
857
+ data?: {
858
+ attribution: Array<string>;
859
+ privacyScore?: {
860
+ score: number;
861
+ breakdown: Array<{
862
+ aspect: string;
863
+ contribution: number;
864
+ }>;
865
+ coverage: {
866
+ evaluated: number;
867
+ total: number;
868
+ };
557
869
  } | null;
558
870
  privacySummary: {
559
871
  bulletPoints: Array<string>;
@@ -630,6 +942,10 @@ export type ListAnalysisResultsQuery = {
630
942
  aspect: string;
631
943
  contribution: number;
632
944
  }>;
945
+ coverage: {
946
+ evaluated: number;
947
+ total: number;
948
+ };
633
949
  } | null;
634
950
  privacySummary: {
635
951
  bulletPoints: Array<string>;
@@ -681,6 +997,31 @@ export type ListAnalysisResultsQuery = {
681
997
  }>;
682
998
  };
683
999
  };
1000
+ export type ListDataHolderScanSummariesQueryVariables = Exact<{
1001
+ dataHolderId: Scalars['ID']['input'];
1002
+ limit?: InputMaybe<Scalars['Int']['input']>;
1003
+ nextToken?: InputMaybe<Scalars['String']['input']>;
1004
+ }>;
1005
+ export type ListDataHolderScanSummariesQuery = {
1006
+ listDataHolderScanSummaries: {
1007
+ nextToken?: string | null;
1008
+ items: Array<{
1009
+ dataHolderId: string;
1010
+ owner: string;
1011
+ scannedAtEpochMs: number;
1012
+ scanRangeFromEpochMs: number;
1013
+ scanRangeToEpochMs: number;
1014
+ emailCount: number;
1015
+ readCount: number;
1016
+ readRate: number;
1017
+ marketingEmailCount: number;
1018
+ marketingEmailOpened: number;
1019
+ marketingOpenRate: number;
1020
+ categoryBreakdown: any;
1021
+ uncategorizedCount: number;
1022
+ }>;
1023
+ };
1024
+ };
684
1025
  export type OnVirtualPresenceUpdateSubscriptionVariables = Exact<{
685
1026
  owner: Scalars['ID']['input'];
686
1027
  }>;
@@ -691,6 +1032,7 @@ export type OnVirtualPresenceUpdateSubscription = {
691
1032
  identifier: string;
692
1033
  state: VirtualPresenceState;
693
1034
  lastScannedAtEpochMs: number;
1035
+ lastScanFailureReason?: string | null;
694
1036
  owner: string;
695
1037
  version: number;
696
1038
  createdAtEpochMs: number;
@@ -734,17 +1076,23 @@ export type OnAnalysisResultUpdateSubscription = {
734
1076
  updatedAtEpochMs: number;
735
1077
  } | null;
736
1078
  };
1079
+ export declare const AnalysisResultDataFieldsFragmentDoc: DocumentNode<AnalysisResultDataFieldsFragment, unknown>;
737
1080
  export declare const AnalysisResultFieldsFragmentDoc: DocumentNode<AnalysisResultFieldsFragment, unknown>;
738
1081
  export declare const DataHolderFieldsFragmentDoc: DocumentNode<DataHolderFieldsFragment, unknown>;
1082
+ export declare const DataHolderScanSummaryFieldsFragmentDoc: DocumentNode<DataHolderScanSummaryFieldsFragment, unknown>;
1083
+ export declare const OrganizationAnalysisFieldsFragmentDoc: DocumentNode<OrganizationAnalysisFieldsFragment, unknown>;
739
1084
  export declare const VirtualPresenceFieldsFragmentDoc: DocumentNode<VirtualPresenceFieldsFragment, unknown>;
740
1085
  export declare const ConnectVirtualPresenceDocument: DocumentNode<ConnectVirtualPresenceMutation, ConnectVirtualPresenceMutationVariables>;
741
1086
  export declare const DisconnectVirtualPresenceDocument: DocumentNode<DisconnectVirtualPresenceMutation, DisconnectVirtualPresenceMutationVariables>;
742
1087
  export declare const RescanVirtualPresenceDocument: DocumentNode<RescanVirtualPresenceMutation, RescanVirtualPresenceMutationVariables>;
1088
+ export declare const GetProviderConfigurationDocument: DocumentNode<GetProviderConfigurationQuery, GetProviderConfigurationQueryVariables>;
743
1089
  export declare const ListVirtualPresencesDocument: DocumentNode<ListVirtualPresencesQuery, ListVirtualPresencesQueryVariables>;
744
1090
  export declare const GetDataHolderDocument: DocumentNode<GetDataHolderQuery, GetDataHolderQueryVariables>;
745
1091
  export declare const ListDataHoldersDocument: DocumentNode<ListDataHoldersQuery, ListDataHoldersQueryVariables>;
746
1092
  export declare const GetAnalysisResultDocument: DocumentNode<GetAnalysisResultQuery, GetAnalysisResultQueryVariables>;
1093
+ export declare const GetOrganizationAnalysisDocument: DocumentNode<GetOrganizationAnalysisQuery, GetOrganizationAnalysisQueryVariables>;
747
1094
  export declare const ListAnalysisResultsDocument: DocumentNode<ListAnalysisResultsQuery, ListAnalysisResultsQueryVariables>;
1095
+ export declare const ListDataHolderScanSummariesDocument: DocumentNode<ListDataHolderScanSummariesQuery, ListDataHolderScanSummariesQueryVariables>;
748
1096
  export declare const OnVirtualPresenceUpdateDocument: DocumentNode<OnVirtualPresenceUpdateSubscription, OnVirtualPresenceUpdateSubscriptionVariables>;
749
1097
  export declare const OnDataHoldersUpdateDocument: DocumentNode<OnDataHoldersUpdateSubscription, OnDataHoldersUpdateSubscriptionVariables>;
750
1098
  export declare const OnAnalysisResultUpdateDocument: DocumentNode<OnAnalysisResultUpdateSubscription, OnAnalysisResultUpdateSubscriptionVariables>;
@@ -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, ListVirtualPresencesInput, OnAnalysisResultUpdateSubscription, OnDataHoldersUpdateSubscription, OnVirtualPresenceUpdateSubscription, ScanOptionsInput, VirtualPresence, VirtualPresenceConnection } from '../../../gen/graphqlTypes';
8
+ import { AnalysisResult, AnalysisResultConnection, ConnectVirtualPresenceInput, DataHolder, DataHolderConnection, DataHolderScanSummaryConnection, OrganizationAnalysis, OrganizationAnalysisMode, ProviderConfiguration, ListVirtualPresencesInput, 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;
@@ -16,13 +16,23 @@ export declare class ApiClient {
16
16
  disconnectVirtualPresence(id: string): Promise<VirtualPresence>;
17
17
  rescanVirtualPresence(id: string, options?: ScanOptionsInput): Promise<VirtualPresence>;
18
18
  listVirtualPresences(input: ListVirtualPresencesInput): Promise<VirtualPresenceConnection>;
19
+ getProviderConfiguration(): Promise<ProviderConfiguration>;
19
20
  getDataHolder(id: string): Promise<DataHolder | undefined>;
20
21
  listDataHolders(input: {
21
22
  virtualPresenceId: string;
22
23
  limit?: number;
23
24
  nextToken?: string;
24
25
  }): Promise<DataHolderConnection>;
26
+ listDataHolderScanSummaries(input: {
27
+ dataHolderId: string;
28
+ limit?: number;
29
+ nextToken?: string;
30
+ }): Promise<DataHolderScanSummaryConnection>;
25
31
  getAnalysisResult(id: string): Promise<AnalysisResult | undefined>;
32
+ getOrganizationAnalysis(input: {
33
+ domain: string;
34
+ mode?: OrganizationAnalysisMode;
35
+ }): Promise<OrganizationAnalysis | undefined>;
26
36
  listAnalysisResults(input: {
27
37
  virtualPresenceId: string;
28
38
  limit?: number;
@@ -6,6 +6,11 @@
6
6
  import { Logger } from '@sudoplatform/sudo-common';
7
7
  import Observable from 'zen-observable';
8
8
  import { ConnectionState } from '../../../public/typings/subscription';
9
+ /**
10
+ * The shape of a subscription message delivered to a subscription observer's
11
+ * `next` handler. Mirrors Amplify v6's `GraphqlSubscriptionMessage<T>`, whose
12
+ * payload is carried under `data`.
13
+ */
9
14
  export type SubscriptionResult<T> = {
10
15
  data: T;
11
16
  };
@@ -4,15 +4,17 @@
4
4
  * SPDX-License-Identifier: Apache-2.0
5
5
  */
6
6
  import { DataHolderEntity } from '../../domain/entities/data-holder/dataHolderEntity';
7
- import { DataHolderService, ListDataHoldersInput, ListDataHoldersOutput, SubscribeToDataHoldersInput } from '../../domain/entities/data-holder/dataHolderService';
7
+ import { DataHolderService, ListDataHoldersInput, ListDataHoldersOutput, ListDataHolderScanSummariesInput, ListDataHolderScanSummariesOutput, SubscribeToDataHoldersInput } from '../../domain/entities/data-holder/dataHolderService';
8
8
  import { ApiClient } from '../common/apiClient';
9
9
  export declare class DefaultDataHolderService implements DataHolderService {
10
10
  private readonly appSync;
11
11
  private readonly dataHolderTransformer;
12
+ private readonly dataHolderScanSummaryTransformer;
12
13
  private readonly subscriptionManager;
13
14
  constructor(appSync: ApiClient);
14
15
  get(id: string): Promise<DataHolderEntity | undefined>;
15
16
  list(input: ListDataHoldersInput): Promise<ListDataHoldersOutput>;
17
+ listScanSummaries(input: ListDataHolderScanSummariesInput): Promise<ListDataHolderScanSummariesOutput>;
16
18
  subscribe(input: SubscribeToDataHoldersInput): Promise<void>;
17
19
  unsubscribe(subscriptionId: string): void;
18
20
  private setupUpdateSubscription;
@@ -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 { DataHolderScanSummary as DataHolderScanSummaryGraphQL } from '../../../../gen/graphqlTypes';
7
+ import { DataHolderScanSummary } from '../../../../public/typings/dataHolder';
8
+ import { DataHolderScanSummaryEntity } from '../../../domain/entities/data-holder/dataHolderEntity';
9
+ export declare class DataHolderScanSummaryTransformer {
10
+ fromGraphQLToEntity(data: DataHolderScanSummaryGraphQL): DataHolderScanSummaryEntity;
11
+ fromEntityToAPI(entity: DataHolderScanSummaryEntity): DataHolderScanSummary;
12
+ /**
13
+ * The `categoryBreakdown` field is an AWSJSON scalar, which is delivered as a
14
+ * JSON-encoded string. Parse it into a category-to-count map. Accepts an
15
+ * already-parsed object for resilience.
16
+ */
17
+ private parseCategoryBreakdown;
18
+ }
@@ -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 { OrganizationAnalysisEntity } from '../../domain/entities/organization-analysis/organizationAnalysisEntity';
7
+ import { GetOrganizationAnalysisInput, OrganizationAnalysisService } from '../../domain/entities/organization-analysis/organizationAnalysisService';
8
+ import { ApiClient } from '../common/apiClient';
9
+ export declare class DefaultOrganizationAnalysisService implements OrganizationAnalysisService {
10
+ private readonly appSync;
11
+ private readonly organizationAnalysisTransformer;
12
+ private readonly modeTransformer;
13
+ constructor(appSync: ApiClient);
14
+ getOrganizationAnalysis(input: GetOrganizationAnalysisInput): Promise<OrganizationAnalysisEntity | undefined>;
15
+ }
@@ -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 { OrganizationAnalysisMode as OrganizationAnalysisModeGraphQL } from '../../../../gen/graphqlTypes';
7
+ import { OrganizationAnalysisMode } from '../../../../public/typings/organizationAnalysis';
8
+ import { OrganizationAnalysisModeEntity } from '../../../domain/entities/organization-analysis/organizationAnalysisEntity';
9
+ export declare class OrganizationAnalysisModeTransformer {
10
+ fromAPIToEntity(mode: OrganizationAnalysisMode): OrganizationAnalysisModeEntity;
11
+ fromEntityToGraphQL(mode: OrganizationAnalysisModeEntity): OrganizationAnalysisModeGraphQL;
12
+ }
@@ -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 { OrganizationAnalysis as OrganizationAnalysisGraphQL } from '../../../../gen/graphqlTypes';
7
+ import { OrganizationAnalysis } from '../../../../public/typings/organizationAnalysis';
8
+ import { OrganizationAnalysisEntity } from '../../../domain/entities/organization-analysis/organizationAnalysisEntity';
9
+ export declare class OrganizationAnalysisTransformer {
10
+ private readonly statusTransformer;
11
+ private readonly dataTransformer;
12
+ fromGraphQLToEntity(data: OrganizationAnalysisGraphQL): OrganizationAnalysisEntity;
13
+ fromEntityToAPI(entity: OrganizationAnalysisEntity): OrganizationAnalysis;
14
+ }