@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
@@ -166,6 +166,25 @@ export type DataHolderConnection = {
166
166
  nextToken?: Maybe<Scalars['String']['output']>;
167
167
  };
168
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
+ };
169
188
  export type DataHolderUpdateItem = {
170
189
  complianceConcern: Scalars['Boolean']['output'];
171
190
  createdAtEpochMs: Scalars['Float']['output'];
@@ -212,6 +231,18 @@ export type MutationRescanVirtualPresenceArgs = {
212
231
  id: Scalars['String']['input'];
213
232
  options?: InputMaybe<ScanOptionsInput>;
214
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';
215
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';
216
247
  export type OrganizationIdentity = {
217
248
  brandName?: Maybe<Scalars['String']['output']>;
@@ -221,6 +252,7 @@ export type OrganizationIdentity = {
221
252
  };
222
253
  export type PrivacyScore = {
223
254
  breakdown: Array<ScoreContribution>;
255
+ coverage: ScoreCoverage;
224
256
  score: Scalars['Float']['output'];
225
257
  };
226
258
  export type PrivacySummary = {
@@ -237,6 +269,13 @@ export type Query = {
237
269
  getAnalysisResult?: Maybe<AnalysisResult>;
238
270
  /** Get a single data holder by ID */
239
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>;
240
279
  /**
241
280
  * Get the opaque provider configuration required by consumers to support
242
281
  * the provider OAuth flow.
@@ -244,6 +283,8 @@ export type Query = {
244
283
  getProviderConfiguration: ProviderConfiguration;
245
284
  /** List analysis results for a virtual presence. */
246
285
  listAnalysisResults: AnalysisResultConnection;
286
+ /** List scan summaries for a data holder (most recent first) */
287
+ listDataHolderScanSummaries: DataHolderScanSummaryConnection;
247
288
  /** List data holders by virtual presence */
248
289
  listDataHolders: DataHolderConnection;
249
290
  /** List virtual presences for the authenticated user */
@@ -255,11 +296,20 @@ export type QueryGetAnalysisResultArgs = {
255
296
  export type QueryGetDataHolderArgs = {
256
297
  id: Scalars['ID']['input'];
257
298
  };
299
+ export type QueryGetOrganizationAnalysisArgs = {
300
+ domain: Scalars['String']['input'];
301
+ mode?: InputMaybe<OrganizationAnalysisMode>;
302
+ };
258
303
  export type QueryListAnalysisResultsArgs = {
259
304
  limit?: InputMaybe<Scalars['Int']['input']>;
260
305
  nextToken?: InputMaybe<Scalars['String']['input']>;
261
306
  virtualPresenceId: Scalars['ID']['input'];
262
307
  };
308
+ export type QueryListDataHolderScanSummariesArgs = {
309
+ dataHolderId: Scalars['ID']['input'];
310
+ limit?: InputMaybe<Scalars['Int']['input']>;
311
+ nextToken?: InputMaybe<Scalars['String']['input']>;
312
+ };
263
313
  export type QueryListDataHoldersArgs = {
264
314
  limit?: InputMaybe<Scalars['Int']['input']>;
265
315
  nextToken?: InputMaybe<Scalars['String']['input']>;
@@ -301,6 +351,10 @@ export type ScoreContribution = {
301
351
  aspect: Scalars['String']['output'];
302
352
  contribution: Scalars['Float']['output'];
303
353
  };
354
+ export type ScoreCoverage = {
355
+ evaluated: Scalars['Int']['output'];
356
+ total: Scalars['Int']['output'];
357
+ };
304
358
  export type ShareStyle = 'INFERENCE_SHARED' | 'NONE' | 'SHARED' | 'SHARED_WITH_CONSENT' | '%future added value';
305
359
  export type SignalValue = 'NO' | 'UNKNOWN' | 'YES' | '%future added value';
306
360
  export type Subscription = {
@@ -334,6 +388,7 @@ export type VirtualPresence = {
334
388
  createdAtEpochMs: Scalars['Float']['output'];
335
389
  id: Scalars['ID']['output'];
336
390
  identifier: Scalars['String']['output'];
391
+ lastScanFailureReason?: Maybe<Scalars['String']['output']>;
337
392
  lastScannedAtEpochMs: Scalars['Float']['output'];
338
393
  owner: Scalars['ID']['output'];
339
394
  providerType: ProviderType;
@@ -347,6 +402,66 @@ export type VirtualPresenceConnection = {
347
402
  nextToken?: Maybe<Scalars['String']['output']>;
348
403
  };
349
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
+ };
350
465
  export type AnalysisResultFieldsFragment = {
351
466
  id: string;
352
467
  virtualPresenceId: string;
@@ -365,6 +480,10 @@ export type AnalysisResultFieldsFragment = {
365
480
  aspect: string;
366
481
  contribution: number;
367
482
  }>;
483
+ coverage: {
484
+ evaluated: number;
485
+ total: number;
486
+ };
368
487
  } | null;
369
488
  privacySummary: {
370
489
  bulletPoints: Array<string>;
@@ -427,12 +546,98 @@ export type DataHolderFieldsFragment = {
427
546
  createdAtEpochMs: number;
428
547
  updatedAtEpochMs: number;
429
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
+ };
430
634
  export type VirtualPresenceFieldsFragment = {
431
635
  id: string;
432
636
  providerType: ProviderType;
433
637
  identifier: string;
434
638
  state: VirtualPresenceState;
435
639
  lastScannedAtEpochMs: number;
640
+ lastScanFailureReason?: string | null;
436
641
  owner: string;
437
642
  version: number;
438
643
  createdAtEpochMs: number;
@@ -448,6 +653,7 @@ export type ConnectVirtualPresenceMutation = {
448
653
  identifier: string;
449
654
  state: VirtualPresenceState;
450
655
  lastScannedAtEpochMs: number;
656
+ lastScanFailureReason?: string | null;
451
657
  owner: string;
452
658
  version: number;
453
659
  createdAtEpochMs: number;
@@ -464,6 +670,7 @@ export type DisconnectVirtualPresenceMutation = {
464
670
  identifier: string;
465
671
  state: VirtualPresenceState;
466
672
  lastScannedAtEpochMs: number;
673
+ lastScanFailureReason?: string | null;
467
674
  owner: string;
468
675
  version: number;
469
676
  createdAtEpochMs: number;
@@ -481,6 +688,7 @@ export type RescanVirtualPresenceMutation = {
481
688
  identifier: string;
482
689
  state: VirtualPresenceState;
483
690
  lastScannedAtEpochMs: number;
691
+ lastScanFailureReason?: string | null;
484
692
  owner: string;
485
693
  version: number;
486
694
  createdAtEpochMs: number;
@@ -507,6 +715,7 @@ export type ListVirtualPresencesQuery = {
507
715
  identifier: string;
508
716
  state: VirtualPresenceState;
509
717
  lastScannedAtEpochMs: number;
718
+ lastScanFailureReason?: string | null;
510
719
  owner: string;
511
720
  version: number;
512
721
  createdAtEpochMs: number;
@@ -577,6 +786,86 @@ export type GetAnalysisResultQuery = {
577
786
  aspect: string;
578
787
  contribution: number;
579
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
+ };
580
869
  } | null;
581
870
  privacySummary: {
582
871
  bulletPoints: Array<string>;
@@ -653,6 +942,10 @@ export type ListAnalysisResultsQuery = {
653
942
  aspect: string;
654
943
  contribution: number;
655
944
  }>;
945
+ coverage: {
946
+ evaluated: number;
947
+ total: number;
948
+ };
656
949
  } | null;
657
950
  privacySummary: {
658
951
  bulletPoints: Array<string>;
@@ -704,6 +997,31 @@ export type ListAnalysisResultsQuery = {
704
997
  }>;
705
998
  };
706
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
+ };
707
1025
  export type OnVirtualPresenceUpdateSubscriptionVariables = Exact<{
708
1026
  owner: Scalars['ID']['input'];
709
1027
  }>;
@@ -714,6 +1032,7 @@ export type OnVirtualPresenceUpdateSubscription = {
714
1032
  identifier: string;
715
1033
  state: VirtualPresenceState;
716
1034
  lastScannedAtEpochMs: number;
1035
+ lastScanFailureReason?: string | null;
717
1036
  owner: string;
718
1037
  version: number;
719
1038
  createdAtEpochMs: number;
@@ -757,8 +1076,11 @@ export type OnAnalysisResultUpdateSubscription = {
757
1076
  updatedAtEpochMs: number;
758
1077
  } | null;
759
1078
  };
1079
+ export declare const AnalysisResultDataFieldsFragmentDoc: DocumentNode<AnalysisResultDataFieldsFragment, unknown>;
760
1080
  export declare const AnalysisResultFieldsFragmentDoc: DocumentNode<AnalysisResultFieldsFragment, unknown>;
761
1081
  export declare const DataHolderFieldsFragmentDoc: DocumentNode<DataHolderFieldsFragment, unknown>;
1082
+ export declare const DataHolderScanSummaryFieldsFragmentDoc: DocumentNode<DataHolderScanSummaryFieldsFragment, unknown>;
1083
+ export declare const OrganizationAnalysisFieldsFragmentDoc: DocumentNode<OrganizationAnalysisFieldsFragment, unknown>;
762
1084
  export declare const VirtualPresenceFieldsFragmentDoc: DocumentNode<VirtualPresenceFieldsFragment, unknown>;
763
1085
  export declare const ConnectVirtualPresenceDocument: DocumentNode<ConnectVirtualPresenceMutation, ConnectVirtualPresenceMutationVariables>;
764
1086
  export declare const DisconnectVirtualPresenceDocument: DocumentNode<DisconnectVirtualPresenceMutation, DisconnectVirtualPresenceMutationVariables>;
@@ -768,7 +1090,9 @@ export declare const ListVirtualPresencesDocument: DocumentNode<ListVirtualPrese
768
1090
  export declare const GetDataHolderDocument: DocumentNode<GetDataHolderQuery, GetDataHolderQueryVariables>;
769
1091
  export declare const ListDataHoldersDocument: DocumentNode<ListDataHoldersQuery, ListDataHoldersQueryVariables>;
770
1092
  export declare const GetAnalysisResultDocument: DocumentNode<GetAnalysisResultQuery, GetAnalysisResultQueryVariables>;
1093
+ export declare const GetOrganizationAnalysisDocument: DocumentNode<GetOrganizationAnalysisQuery, GetOrganizationAnalysisQueryVariables>;
771
1094
  export declare const ListAnalysisResultsDocument: DocumentNode<ListAnalysisResultsQuery, ListAnalysisResultsQueryVariables>;
1095
+ export declare const ListDataHolderScanSummariesDocument: DocumentNode<ListDataHolderScanSummariesQuery, ListDataHolderScanSummariesQueryVariables>;
772
1096
  export declare const OnVirtualPresenceUpdateDocument: DocumentNode<OnVirtualPresenceUpdateSubscription, OnVirtualPresenceUpdateSubscriptionVariables>;
773
1097
  export declare const OnDataHoldersUpdateDocument: DocumentNode<OnDataHoldersUpdateSubscription, OnDataHoldersUpdateSubscriptionVariables>;
774
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, ProviderConfiguration, 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;
@@ -23,7 +23,16 @@ export declare class ApiClient {
23
23
  limit?: number;
24
24
  nextToken?: string;
25
25
  }): Promise<DataHolderConnection>;
26
+ listDataHolderScanSummaries(input: {
27
+ dataHolderId: string;
28
+ limit?: number;
29
+ nextToken?: string;
30
+ }): Promise<DataHolderScanSummaryConnection>;
26
31
  getAnalysisResult(id: string): Promise<AnalysisResult | undefined>;
32
+ getOrganizationAnalysis(input: {
33
+ domain: string;
34
+ mode?: OrganizationAnalysisMode;
35
+ }): Promise<OrganizationAnalysis | undefined>;
27
36
  listAnalysisResults(input: {
28
37
  virtualPresenceId: string;
29
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
+ }
@@ -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.
@@ -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
+ }