@sudoplatform/sudo-privacy-interaction 2.3.0 → 2.4.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 (50) hide show
  1. package/cjs/gen/graphqlTypes.js +9 -0
  2. package/cjs/private/data/analysis-result/defaultAnalysisResultService.js +6 -0
  3. package/cjs/private/data/analysis-result/transformer/analysisResultStatusReasonTransformer.js +45 -0
  4. package/cjs/private/data/analysis-result/transformer/analysisResultTransformer.js +6 -0
  5. package/cjs/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +6 -0
  6. package/cjs/private/domain/entities/analysis-result/analysisResultEntity.js +20 -1
  7. package/cjs/public/typings/analysisResult.js +20 -1
  8. package/docs/assets/navigation.js +1 -1
  9. package/docs/assets/search.js +1 -1
  10. package/docs/enums/AnalysisResultStatus.html +6 -6
  11. package/docs/enums/AnalysisResultStatusReason.html +81 -0
  12. package/docs/enums/DataCategory.html +18 -18
  13. package/docs/enums/OrganizationAnalysisDomainResolution.html +3 -3
  14. package/docs/enums/OrganizationAnalysisMode.html +3 -3
  15. package/docs/enums/OrganizationCategory.html +31 -31
  16. package/docs/enums/RetentionStyle.html +5 -5
  17. package/docs/enums/ShareStyle.html +6 -6
  18. package/docs/enums/SignalValue.html +4 -4
  19. package/docs/interfaces/AnalysisResult.html +21 -13
  20. package/docs/interfaces/AnalysisResultData.html +8 -8
  21. package/docs/interfaces/AnalysisResultUpdate.html +20 -12
  22. package/docs/interfaces/CapabilitySignals.html +10 -10
  23. package/docs/interfaces/CategorySignals.html +11 -11
  24. package/docs/interfaces/OrganizationAnalysis.html +20 -12
  25. package/docs/interfaces/OrganizationIdentity.html +5 -5
  26. package/docs/interfaces/PrivacyScore.html +4 -4
  27. package/docs/interfaces/PrivacySummary.html +4 -4
  28. package/docs/interfaces/RetentionInfo.html +4 -4
  29. package/docs/interfaces/RiskIndicators.html +8 -8
  30. package/docs/interfaces/ScoreContribution.html +3 -3
  31. package/docs/interfaces/ScoreCoverage.html +3 -3
  32. package/docs/modules.html +2 -2
  33. package/lib/gen/graphqlTypes.js +9 -0
  34. package/lib/private/data/analysis-result/defaultAnalysisResultService.js +6 -0
  35. package/lib/private/data/analysis-result/transformer/analysisResultStatusReasonTransformer.js +41 -0
  36. package/lib/private/data/analysis-result/transformer/analysisResultTransformer.js +6 -0
  37. package/lib/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +6 -0
  38. package/lib/private/domain/entities/analysis-result/analysisResultEntity.js +19 -0
  39. package/lib/public/typings/analysisResult.js +19 -0
  40. package/package.json +1 -1
  41. package/types/gen/graphqlTypes.d.ts +7 -0
  42. package/types/gen/schema-types.d.ts +4 -0
  43. package/types/private/data/analysis-result/defaultAnalysisResultService.d.ts +1 -0
  44. package/types/private/data/analysis-result/transformer/analysisResultStatusReasonTransformer.d.ts +12 -0
  45. package/types/private/data/analysis-result/transformer/analysisResultTransformer.d.ts +1 -0
  46. package/types/private/data/organization-analysis/transformer/organizationAnalysisTransformer.d.ts +1 -0
  47. package/types/private/domain/entities/analysis-result/analysisResultEntity.d.ts +20 -0
  48. package/types/private/domain/entities/organization-analysis/organizationAnalysisEntity.d.ts +3 -1
  49. package/types/public/typings/analysisResult.d.ts +22 -0
  50. package/types/public/typings/organizationAnalysis.d.ts +3 -1
@@ -3,7 +3,7 @@
3
3
  *
4
4
  * SPDX-License-Identifier: Apache-2.0
5
5
  */
6
- import { AnalysisResultData, AnalysisResultStatus } from './analysisResult';
6
+ import { AnalysisResultData, AnalysisResultStatus, AnalysisResultStatusReason } from './analysisResult';
7
7
  /**
8
8
  * The Sudo Platform SDK representation of a shared, domain-keyed privacy analysis
9
9
  * of an organization.
@@ -17,6 +17,7 @@ import { AnalysisResultData, AnalysisResultStatus } from './analysisResult';
17
17
  * @property {string} domain The analyzed domain (equal to id).
18
18
  * @property {AnalysisResultStatus} status Aggregate status. Pending while an asynchronous
19
19
  * source is still resolving; re-query for the terminal result.
20
+ * @property {AnalysisResultStatusReason} statusReason Reason explaining the aggregate status, when one applies.
20
21
  * @property {Date} lastAnalyzedAt When the aggregate was last derived.
21
22
  * @property {AnalysisResultData} data Structured analysis payload. Populated when status is
22
23
  * Complete or Partial.
@@ -29,6 +30,7 @@ export interface OrganizationAnalysis {
29
30
  id: string;
30
31
  domain: string;
31
32
  status: AnalysisResultStatus;
33
+ statusReason?: AnalysisResultStatusReason;
32
34
  lastAnalyzedAt: Date;
33
35
  data?: AnalysisResultData;
34
36
  owner: string;