@sudoplatform/sudo-privacy-interaction 0.0.0-placeholder → 1.0.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.
- package/LICENSE +13 -0
- package/README.md +30 -0
- package/cjs/gen/graphqlTypes.js +1785 -0
- package/cjs/index.js +10 -0
- package/cjs/private/data/analysis-result/analysisResultSubscriptionManager.js +25 -0
- package/cjs/private/data/analysis-result/defaultAnalysisResultService.js +83 -0
- package/cjs/private/data/analysis-result/transformer/analysisResultDataTransformer.js +57 -0
- package/cjs/private/data/analysis-result/transformer/analysisResultStatusTransformer.js +43 -0
- package/cjs/private/data/analysis-result/transformer/analysisResultTransformer.js +47 -0
- package/cjs/private/data/analysis-result/transformer/capabilitySignalsTransformer.js +35 -0
- package/cjs/private/data/analysis-result/transformer/categorySignalsTransformer.js +51 -0
- package/cjs/private/data/analysis-result/transformer/dataCategoryTransformer.js +91 -0
- package/cjs/private/data/analysis-result/transformer/organizationCategoryTransformer.js +139 -0
- package/cjs/private/data/analysis-result/transformer/organizationIdentityTransformer.js +29 -0
- package/cjs/private/data/analysis-result/transformer/privacyScoreTransformer.js +29 -0
- package/cjs/private/data/analysis-result/transformer/privacySummaryTransformer.js +25 -0
- package/cjs/private/data/analysis-result/transformer/retentionInfoTransformer.js +27 -0
- package/cjs/private/data/analysis-result/transformer/retentionStyleTransformer.js +39 -0
- package/cjs/private/data/analysis-result/transformer/riskIndicatorsTransformer.js +35 -0
- package/cjs/private/data/analysis-result/transformer/shareStyleTransformer.js +41 -0
- package/cjs/private/data/analysis-result/transformer/signalValueTransformer.js +35 -0
- package/cjs/private/data/common/apiClient.js +209 -0
- package/cjs/private/data/common/baseSubscriptionManager.js +73 -0
- package/cjs/private/data/common/config.js +23 -0
- package/cjs/private/data/common/privateSudoPrivacyInteractionClientOptions.js +7 -0
- package/cjs/private/data/common/transformer/errorTransformer.js +30 -0
- package/cjs/private/data/data-holder/dataHolderSubscriptionManager.js +25 -0
- package/cjs/private/data/data-holder/defaultDataHolderService.js +72 -0
- package/cjs/private/data/data-holder/transformer/dataHolderProtectionStateTransformer.js +37 -0
- package/cjs/private/data/data-holder/transformer/dataHolderTransformer.js +44 -0
- package/cjs/private/data/virtual-presence/defaultVirtualPresenceService.js +74 -0
- package/cjs/private/data/virtual-presence/transformer/providerTypeTransformer.js +29 -0
- package/cjs/private/data/virtual-presence/transformer/virtualPresenceStateTransformer.js +45 -0
- package/cjs/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +43 -0
- package/cjs/private/data/virtual-presence/virtualPresenceSubscriptionManager.js +25 -0
- package/cjs/private/domain/entities/analysis-result/analysisResultEntity.js +135 -0
- package/cjs/private/domain/entities/analysis-result/analysisResultService.js +7 -0
- package/cjs/private/domain/entities/data-holder/dataHolderEntity.js +24 -0
- package/cjs/private/domain/entities/data-holder/dataHolderService.js +7 -0
- package/cjs/private/domain/entities/inputs/scanOptionsEntity.js +7 -0
- package/cjs/private/domain/entities/virtual-presence/virtualPresenceEntity.js +38 -0
- package/cjs/private/domain/entities/virtual-presence/virtualPresenceService.js +7 -0
- package/cjs/private/domain/use-cases/analysis-result/getAnalysisResultUseCase.js +25 -0
- package/cjs/private/domain/use-cases/analysis-result/listAnalysisResultsUseCase.js +29 -0
- package/cjs/private/domain/use-cases/analysis-result/subscribeToAnalysisResultUseCase.js +37 -0
- package/cjs/private/domain/use-cases/analysis-result/unsubscribeFromAnalysisResultUseCase.js +27 -0
- package/cjs/private/domain/use-cases/data-holder/getDataHolderUseCase.js +25 -0
- package/cjs/private/domain/use-cases/data-holder/listDataHoldersUseCase.js +29 -0
- package/cjs/private/domain/use-cases/data-holder/subscribeToDataHoldersUseCase.js +37 -0
- package/cjs/private/domain/use-cases/data-holder/unsubscribeFromDataHoldersUseCase.js +27 -0
- package/cjs/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithAuthCodeUseCase.js +27 -0
- package/cjs/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithRefreshTokenUseCase.js +27 -0
- package/cjs/private/domain/use-cases/virtual-presence/disconnectVirtualPresenceUseCase.js +25 -0
- package/cjs/private/domain/use-cases/virtual-presence/listVirtualPresencesUseCase.js +30 -0
- package/cjs/private/domain/use-cases/virtual-presence/rescanVirtualPresenceUseCase.js +25 -0
- package/cjs/private/domain/use-cases/virtual-presence/subscribeToVirtualPresenceUseCase.js +37 -0
- package/cjs/private/domain/use-cases/virtual-presence/unsubscribeFromVirtualPresenceUseCase.js +27 -0
- package/cjs/public/defaultSudoPrivacyInteractionClient.js +173 -0
- package/cjs/public/errors.js +29 -0
- package/cjs/public/index.js +13 -0
- package/cjs/public/inputs/analysisResult.js +7 -0
- package/cjs/public/inputs/common.js +7 -0
- package/cjs/public/inputs/dataHolder.js +7 -0
- package/cjs/public/inputs/index.js +12 -0
- package/cjs/public/inputs/virtualPresence.js +7 -0
- package/cjs/public/sudoPrivacyInteractionClient.js +7 -0
- package/cjs/public/typings/analysisResult.js +135 -0
- package/cjs/public/typings/dataHolder.js +24 -0
- package/cjs/public/typings/index.js +12 -0
- package/cjs/public/typings/subscription.js +21 -0
- package/cjs/public/typings/virtualPresence.js +38 -0
- package/docs/.nojekyll +1 -0
- package/docs/assets/hierarchy.js +1 -0
- package/docs/assets/highlight.css +78 -0
- package/docs/assets/icons.js +18 -0
- package/docs/assets/icons.svg +1 -0
- package/docs/assets/main.js +60 -0
- package/docs/assets/navigation.js +1 -0
- package/docs/assets/search.js +1 -0
- package/docs/assets/style.css +1648 -0
- package/docs/classes/DefaultSudoPrivacyInteractionClient.html +383 -0
- package/docs/classes/InvalidArgumentError.html +181 -0
- package/docs/classes/PrivacyInteractionServiceConfigNotFoundError.html +181 -0
- package/docs/enums/AnalysisResultStatus.html +81 -0
- package/docs/enums/ConnectionState.html +67 -0
- package/docs/enums/DataCategory.html +153 -0
- package/docs/enums/DataHolderProtectionState.html +75 -0
- package/docs/enums/OrganizationCategory.html +225 -0
- package/docs/enums/ProviderType.html +63 -0
- package/docs/enums/RetentionStyle.html +75 -0
- package/docs/enums/ShareStyle.html +81 -0
- package/docs/enums/SignalValue.html +69 -0
- package/docs/enums/VirtualPresenceState.html +87 -0
- package/docs/hierarchy.html +39 -0
- package/docs/index.html +79 -0
- package/docs/interfaces/AnalysisResult.html +133 -0
- package/docs/interfaces/AnalysisResultData.html +102 -0
- package/docs/interfaces/AnalysisResultSubscriber.html +92 -0
- package/docs/interfaces/AnalysisResultUpdate.html +125 -0
- package/docs/interfaces/CapabilitySignals.html +109 -0
- package/docs/interfaces/CategorySignals.html +133 -0
- package/docs/interfaces/ConnectVirtualPresenceWithRefreshTokenInput.html +85 -0
- package/docs/interfaces/DataHolder.html +142 -0
- package/docs/interfaces/DataHolderSubscriber.html +92 -0
- package/docs/interfaces/ListAnalysisResultsInput.html +85 -0
- package/docs/interfaces/ListDataHoldersInput.html +85 -0
- package/docs/interfaces/ListVirtualPresencesInput.html +77 -0
- package/docs/interfaces/OrganizationIdentity.html +85 -0
- package/docs/interfaces/Pagination.html +77 -0
- package/docs/interfaces/PrivacyScore.html +69 -0
- package/docs/interfaces/PrivacySummary.html +77 -0
- package/docs/interfaces/RescanVirtualPresenceInput.html +69 -0
- package/docs/interfaces/RetentionInfo.html +77 -0
- package/docs/interfaces/RiskIndicators.html +110 -0
- package/docs/interfaces/ScanOptions.html +93 -0
- package/docs/interfaces/ScoreContribution.html +69 -0
- package/docs/interfaces/SudoPrivacyInteractionClient.html +347 -0
- package/docs/interfaces/VirtualPresence.html +126 -0
- package/docs/interfaces/VirtualPresenceSubscriber.html +92 -0
- package/docs/modules.html +48 -0
- package/docs/types/SudoPrivacyInteractionClientOptions.html +57 -0
- package/lib/gen/graphqlTypes.js +1782 -0
- package/lib/index.js +7 -0
- package/lib/private/data/analysis-result/analysisResultSubscriptionManager.js +21 -0
- package/lib/private/data/analysis-result/defaultAnalysisResultService.js +79 -0
- package/lib/private/data/analysis-result/transformer/analysisResultDataTransformer.js +53 -0
- package/lib/private/data/analysis-result/transformer/analysisResultStatusTransformer.js +39 -0
- package/lib/private/data/analysis-result/transformer/analysisResultTransformer.js +43 -0
- package/lib/private/data/analysis-result/transformer/capabilitySignalsTransformer.js +31 -0
- package/lib/private/data/analysis-result/transformer/categorySignalsTransformer.js +47 -0
- package/lib/private/data/analysis-result/transformer/dataCategoryTransformer.js +87 -0
- package/lib/private/data/analysis-result/transformer/organizationCategoryTransformer.js +135 -0
- package/lib/private/data/analysis-result/transformer/organizationIdentityTransformer.js +25 -0
- package/lib/private/data/analysis-result/transformer/privacyScoreTransformer.js +25 -0
- package/lib/private/data/analysis-result/transformer/privacySummaryTransformer.js +21 -0
- package/lib/private/data/analysis-result/transformer/retentionInfoTransformer.js +23 -0
- package/lib/private/data/analysis-result/transformer/retentionStyleTransformer.js +35 -0
- package/lib/private/data/analysis-result/transformer/riskIndicatorsTransformer.js +31 -0
- package/lib/private/data/analysis-result/transformer/shareStyleTransformer.js +37 -0
- package/lib/private/data/analysis-result/transformer/signalValueTransformer.js +31 -0
- package/lib/private/data/common/apiClient.js +205 -0
- package/lib/private/data/common/baseSubscriptionManager.js +69 -0
- package/lib/private/data/common/config.js +18 -0
- package/lib/private/data/common/privateSudoPrivacyInteractionClientOptions.js +6 -0
- package/lib/private/data/common/transformer/errorTransformer.js +26 -0
- package/lib/private/data/data-holder/dataHolderSubscriptionManager.js +21 -0
- package/lib/private/data/data-holder/defaultDataHolderService.js +68 -0
- package/lib/private/data/data-holder/transformer/dataHolderProtectionStateTransformer.js +33 -0
- package/lib/private/data/data-holder/transformer/dataHolderTransformer.js +40 -0
- package/lib/private/data/virtual-presence/defaultVirtualPresenceService.js +70 -0
- package/lib/private/data/virtual-presence/transformer/providerTypeTransformer.js +25 -0
- package/lib/private/data/virtual-presence/transformer/virtualPresenceStateTransformer.js +41 -0
- package/lib/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +39 -0
- package/lib/private/data/virtual-presence/virtualPresenceSubscriptionManager.js +21 -0
- package/lib/private/domain/entities/analysis-result/analysisResultEntity.js +132 -0
- package/lib/private/domain/entities/analysis-result/analysisResultService.js +6 -0
- package/lib/private/domain/entities/data-holder/dataHolderEntity.js +21 -0
- package/lib/private/domain/entities/data-holder/dataHolderService.js +6 -0
- package/lib/private/domain/entities/inputs/scanOptionsEntity.js +6 -0
- package/lib/private/domain/entities/virtual-presence/virtualPresenceEntity.js +35 -0
- package/lib/private/domain/entities/virtual-presence/virtualPresenceService.js +6 -0
- package/lib/private/domain/use-cases/analysis-result/getAnalysisResultUseCase.js +21 -0
- package/lib/private/domain/use-cases/analysis-result/listAnalysisResultsUseCase.js +25 -0
- package/lib/private/domain/use-cases/analysis-result/subscribeToAnalysisResultUseCase.js +33 -0
- package/lib/private/domain/use-cases/analysis-result/unsubscribeFromAnalysisResultUseCase.js +23 -0
- package/lib/private/domain/use-cases/data-holder/getDataHolderUseCase.js +21 -0
- package/lib/private/domain/use-cases/data-holder/listDataHoldersUseCase.js +25 -0
- package/lib/private/domain/use-cases/data-holder/subscribeToDataHoldersUseCase.js +33 -0
- package/lib/private/domain/use-cases/data-holder/unsubscribeFromDataHoldersUseCase.js +23 -0
- package/lib/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithAuthCodeUseCase.js +23 -0
- package/lib/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithRefreshTokenUseCase.js +23 -0
- package/lib/private/domain/use-cases/virtual-presence/disconnectVirtualPresenceUseCase.js +21 -0
- package/lib/private/domain/use-cases/virtual-presence/listVirtualPresencesUseCase.js +26 -0
- package/lib/private/domain/use-cases/virtual-presence/rescanVirtualPresenceUseCase.js +21 -0
- package/lib/private/domain/use-cases/virtual-presence/subscribeToVirtualPresenceUseCase.js +33 -0
- package/lib/private/domain/use-cases/virtual-presence/unsubscribeFromVirtualPresenceUseCase.js +23 -0
- package/lib/public/defaultSudoPrivacyInteractionClient.js +169 -0
- package/lib/public/errors.js +24 -0
- package/lib/public/index.js +10 -0
- package/lib/public/inputs/analysisResult.js +6 -0
- package/lib/public/inputs/common.js +6 -0
- package/lib/public/inputs/dataHolder.js +6 -0
- package/lib/public/inputs/index.js +9 -0
- package/lib/public/inputs/virtualPresence.js +6 -0
- package/lib/public/sudoPrivacyInteractionClient.js +6 -0
- package/lib/public/typings/analysisResult.js +132 -0
- package/lib/public/typings/dataHolder.js +21 -0
- package/lib/public/typings/index.js +9 -0
- package/lib/public/typings/subscription.js +18 -0
- package/lib/public/typings/virtualPresence.js +35 -0
- package/package.json +117 -8
- package/types/gen/graphqlTypes.d.ts +742 -0
- package/types/index.d.ts +6 -0
- package/types/private/data/analysis-result/analysisResultSubscriptionManager.d.ts +19 -0
- package/types/private/data/analysis-result/defaultAnalysisResultService.d.ts +20 -0
- package/types/private/data/analysis-result/transformer/analysisResultDataTransformer.d.ts +18 -0
- package/types/private/data/analysis-result/transformer/analysisResultStatusTransformer.d.ts +12 -0
- package/types/private/data/analysis-result/transformer/analysisResultTransformer.d.ts +14 -0
- package/types/private/data/analysis-result/transformer/capabilitySignalsTransformer.d.ts +13 -0
- package/types/private/data/analysis-result/transformer/categorySignalsTransformer.d.ts +16 -0
- package/types/private/data/analysis-result/transformer/dataCategoryTransformer.d.ts +12 -0
- package/types/private/data/analysis-result/transformer/organizationCategoryTransformer.d.ts +12 -0
- package/types/private/data/analysis-result/transformer/organizationIdentityTransformer.d.ts +13 -0
- package/types/private/data/analysis-result/transformer/privacyScoreTransformer.d.ts +12 -0
- package/types/private/data/analysis-result/transformer/privacySummaryTransformer.d.ts +12 -0
- package/types/private/data/analysis-result/transformer/retentionInfoTransformer.d.ts +13 -0
- package/types/private/data/analysis-result/transformer/retentionStyleTransformer.d.ts +12 -0
- package/types/private/data/analysis-result/transformer/riskIndicatorsTransformer.d.ts +13 -0
- package/types/private/data/analysis-result/transformer/shareStyleTransformer.d.ts +12 -0
- package/types/private/data/analysis-result/transformer/signalValueTransformer.d.ts +12 -0
- package/types/private/data/common/apiClient.d.ts +38 -0
- package/types/private/data/common/baseSubscriptionManager.d.ts +46 -0
- package/types/private/data/common/config.d.ts +13 -0
- package/types/private/data/common/privateSudoPrivacyInteractionClientOptions.d.ts +18 -0
- package/types/private/data/common/transformer/errorTransformer.d.ts +15 -0
- package/types/private/data/data-holder/dataHolderSubscriptionManager.d.ts +19 -0
- package/types/private/data/data-holder/defaultDataHolderService.d.ts +19 -0
- package/types/private/data/data-holder/transformer/dataHolderProtectionStateTransformer.d.ts +12 -0
- package/types/private/data/data-holder/transformer/dataHolderTransformer.d.ts +12 -0
- package/types/private/data/virtual-presence/defaultVirtualPresenceService.d.ts +21 -0
- package/types/private/data/virtual-presence/transformer/providerTypeTransformer.d.ts +12 -0
- package/types/private/data/virtual-presence/transformer/virtualPresenceStateTransformer.d.ts +12 -0
- package/types/private/data/virtual-presence/transformer/virtualPresenceTransformer.d.ts +12 -0
- package/types/private/data/virtual-presence/virtualPresenceSubscriptionManager.d.ts +18 -0
- package/types/private/domain/entities/analysis-result/analysisResultEntity.d.ts +306 -0
- package/types/private/domain/entities/analysis-result/analysisResultService.d.ts +81 -0
- package/types/private/domain/entities/data-holder/dataHolderEntity.d.ts +51 -0
- package/types/private/domain/entities/data-holder/dataHolderService.d.ts +81 -0
- package/types/private/domain/entities/inputs/scanOptionsEntity.d.ts +22 -0
- package/types/private/domain/entities/virtual-presence/virtualPresenceEntity.d.ts +60 -0
- package/types/private/domain/entities/virtual-presence/virtualPresenceService.d.ts +131 -0
- package/types/private/domain/use-cases/analysis-result/getAnalysisResultUseCase.d.ts +16 -0
- package/types/private/domain/use-cases/analysis-result/listAnalysisResultsUseCase.d.ts +36 -0
- package/types/private/domain/use-cases/analysis-result/subscribeToAnalysisResultUseCase.d.ts +27 -0
- package/types/private/domain/use-cases/analysis-result/unsubscribeFromAnalysisResultUseCase.d.ts +15 -0
- package/types/private/domain/use-cases/data-holder/getDataHolderUseCase.d.ts +16 -0
- package/types/private/domain/use-cases/data-holder/listDataHoldersUseCase.d.ts +36 -0
- package/types/private/domain/use-cases/data-holder/subscribeToDataHoldersUseCase.d.ts +27 -0
- package/types/private/domain/use-cases/data-holder/unsubscribeFromDataHoldersUseCase.d.ts +15 -0
- package/types/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithAuthCodeUseCase.d.ts +16 -0
- package/types/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithRefreshTokenUseCase.d.ts +28 -0
- package/types/private/domain/use-cases/virtual-presence/disconnectVirtualPresenceUseCase.d.ts +16 -0
- package/types/private/domain/use-cases/virtual-presence/listVirtualPresencesUseCase.d.ts +35 -0
- package/types/private/domain/use-cases/virtual-presence/rescanVirtualPresenceUseCase.d.ts +27 -0
- package/types/private/domain/use-cases/virtual-presence/subscribeToVirtualPresenceUseCase.d.ts +27 -0
- package/types/private/domain/use-cases/virtual-presence/unsubscribeFromVirtualPresenceUseCase.d.ts +15 -0
- package/types/public/defaultSudoPrivacyInteractionClient.d.ts +36 -0
- package/types/public/errors.d.ts +15 -0
- package/types/public/index.d.ts +10 -0
- package/types/public/inputs/analysisResult.d.ts +17 -0
- package/types/public/inputs/common.d.ts +16 -0
- package/types/public/inputs/dataHolder.d.ts +17 -0
- package/types/public/inputs/index.d.ts +9 -0
- package/types/public/inputs/virtualPresence.d.ts +58 -0
- package/types/public/sudoPrivacyInteractionClient.d.ts +123 -0
- package/types/public/typings/analysisResult.d.ts +331 -0
- package/types/public/typings/dataHolder.d.ts +51 -0
- package/types/public/typings/index.d.ts +9 -0
- package/types/public/typings/subscription.d.ts +86 -0
- package/types/public/typings/virtualPresence.d.ts +60 -0
|
@@ -0,0 +1,306 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
|
|
3
|
+
*
|
|
4
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* Core entity representation of an analysis result.
|
|
8
|
+
*
|
|
9
|
+
* @interface AnalysisResultEntity
|
|
10
|
+
* @property {string} id Unique identifier associated with the analysis result.
|
|
11
|
+
* @property {string} owner Unique identifier of the user.
|
|
12
|
+
* @property {string} virtualPresenceId The virtual presence this analysis is associated with.
|
|
13
|
+
* @property {string} dataHolderIdentifier The data holder domain that this analysis is about.
|
|
14
|
+
* @property {AnalysisResultStatusEntity} status Current status of the analysis.
|
|
15
|
+
* @property {Date} lastAnalyzedAt Date for when the analysis was last performed.
|
|
16
|
+
* @property {AnalysisResultDataEntity} data Structured analysis data. Populated when status is COMPLETE or PARTIAL.
|
|
17
|
+
* @property {number} version Version of this entity. Increments on update.
|
|
18
|
+
* @property {Date} createdAt Date for when the analysis result was created.
|
|
19
|
+
* @property {Date} updatedAt Date for when the analysis result was last updated.
|
|
20
|
+
*/
|
|
21
|
+
export interface AnalysisResultEntity {
|
|
22
|
+
id: string;
|
|
23
|
+
virtualPresenceId: string;
|
|
24
|
+
dataHolderIdentifier: string;
|
|
25
|
+
status: AnalysisResultStatusEntity;
|
|
26
|
+
lastAnalyzedAt: Date;
|
|
27
|
+
data?: AnalysisResultDataEntity;
|
|
28
|
+
owner: string;
|
|
29
|
+
version: number;
|
|
30
|
+
createdAt: Date;
|
|
31
|
+
updatedAt: Date;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* The status of an analysis result.
|
|
35
|
+
*
|
|
36
|
+
* @property PENDING The analysis is queued but has not yet started.
|
|
37
|
+
* @property COMPLETE The analysis has completed successfully with full data.
|
|
38
|
+
* @property PARTIAL The analysis has completed with partial data available.
|
|
39
|
+
* @property FAILED The analysis encountered an error and could not complete.
|
|
40
|
+
* @property UNAVAILABLE The analysis data is not available for this data holder.
|
|
41
|
+
*
|
|
42
|
+
* @enum
|
|
43
|
+
*/
|
|
44
|
+
export declare enum AnalysisResultStatusEntity {
|
|
45
|
+
Pending = "PENDING",
|
|
46
|
+
Complete = "COMPLETE",
|
|
47
|
+
Partial = "PARTIAL",
|
|
48
|
+
Failed = "FAILED",
|
|
49
|
+
Unavailable = "UNAVAILABLE"
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* The structured data payload for an analysis result.
|
|
53
|
+
*
|
|
54
|
+
* @interface AnalysisResultDataEntity
|
|
55
|
+
* @property {PrivacyScoreEntity} privacyScore Overall privacy score.
|
|
56
|
+
* Undefined when scoring is disabled.
|
|
57
|
+
* @property {PrivacySummaryEntity} privacySummary Concise human-readable summary of privacy findings.
|
|
58
|
+
* @property {CategorySignalsEntity[]} categories Per-category signal breakdown.
|
|
59
|
+
* @property {CapabilitySignalsEntity} capabilities Action-derived capability signals.
|
|
60
|
+
* @property {RiskIndicatorsEntity} riskIndicators Aggregated risk indicators.
|
|
61
|
+
* @property {OrganizationIdentityEntity} organizationIdentity Organization identity (brand, company, business categories).
|
|
62
|
+
*/
|
|
63
|
+
export interface AnalysisResultDataEntity {
|
|
64
|
+
privacyScore?: PrivacyScoreEntity;
|
|
65
|
+
privacySummary: PrivacySummaryEntity;
|
|
66
|
+
categories: CategorySignalsEntity[];
|
|
67
|
+
capabilities: CapabilitySignalsEntity;
|
|
68
|
+
riskIndicators: RiskIndicatorsEntity;
|
|
69
|
+
organizationIdentity?: OrganizationIdentityEntity;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* Overall privacy score for an organization.
|
|
73
|
+
*
|
|
74
|
+
* @interface PrivacyScoreEntity
|
|
75
|
+
* @property {number} score Numeric score (0-100). Higher is better.
|
|
76
|
+
* @property {ScoreContributionEntity[]} breakdown Breakdown of how each aspect contributed to the score.
|
|
77
|
+
*/
|
|
78
|
+
export interface PrivacyScoreEntity {
|
|
79
|
+
score: number;
|
|
80
|
+
breakdown: ScoreContributionEntity[];
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* A single scoring aspect and its contribution to the overall score.
|
|
84
|
+
*
|
|
85
|
+
* @interface ScoreContributionEntity
|
|
86
|
+
* @property {string} aspect Identifier for the scoring aspect (e.g. 'dataCollection', 'dataSharing').
|
|
87
|
+
* @property {number} contribution Numeric contribution to the score (negative = penalty, positive = bonus).
|
|
88
|
+
*/
|
|
89
|
+
export interface ScoreContributionEntity {
|
|
90
|
+
aspect: string;
|
|
91
|
+
contribution: number;
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* Concise human-readable summary of privacy-related findings.
|
|
95
|
+
*
|
|
96
|
+
* @interface PrivacySummaryEntity
|
|
97
|
+
* @property {string[]} bulletPoints Up to 5 key takeaways, deterministically generated.
|
|
98
|
+
* @property {string} sourceUrl URL of the source material that was analyzed.
|
|
99
|
+
* @property {string} sourceLastUpdated When the source material was last updated (as reported by the organization).
|
|
100
|
+
*/
|
|
101
|
+
export interface PrivacySummaryEntity {
|
|
102
|
+
bulletPoints: string[];
|
|
103
|
+
sourceUrl: string;
|
|
104
|
+
sourceLastUpdated?: string;
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* Tri-state signal value representing confidence in a determination.
|
|
108
|
+
*
|
|
109
|
+
* @enum
|
|
110
|
+
*/
|
|
111
|
+
export declare enum SignalValueEntity {
|
|
112
|
+
Yes = "YES",
|
|
113
|
+
No = "NO",
|
|
114
|
+
Unknown = "UNKNOWN"
|
|
115
|
+
}
|
|
116
|
+
/**
|
|
117
|
+
* Describes how data in a category is shared with third parties.
|
|
118
|
+
*
|
|
119
|
+
* @property Shared Data is shared with third parties.
|
|
120
|
+
* @property SharedWithConsent Data is shared with third parties only with user consent.
|
|
121
|
+
* @property InferenceShared Inferred data is shared with third parties.
|
|
122
|
+
* @property None Data is not shared with third parties.
|
|
123
|
+
*
|
|
124
|
+
* @enum
|
|
125
|
+
*/
|
|
126
|
+
export declare enum ShareStyleEntity {
|
|
127
|
+
Shared = "SHARED",
|
|
128
|
+
SharedWithConsent = "SHARED_WITH_CONSENT",
|
|
129
|
+
InferenceShared = "INFERENCE_SHARED",
|
|
130
|
+
None = "NONE",
|
|
131
|
+
Unknown = "UNKNOWN"
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* Categories of personal data as identified in a privacy policy.
|
|
135
|
+
*
|
|
136
|
+
* @enum
|
|
137
|
+
*/
|
|
138
|
+
export declare enum DataCategoryEntity {
|
|
139
|
+
AccountProfile = "ACCOUNT_PROFILE",
|
|
140
|
+
Authentication = "AUTHENTICATION",
|
|
141
|
+
Background = "BACKGROUND",
|
|
142
|
+
Biometric = "BIOMETRIC",
|
|
143
|
+
Communication = "COMMUNICATION",
|
|
144
|
+
Contacts = "CONTACTS",
|
|
145
|
+
Demographic = "DEMOGRAPHIC",
|
|
146
|
+
DeviceIdentifier = "DEVICE_IDENTIFIER",
|
|
147
|
+
Financial = "FINANCIAL",
|
|
148
|
+
GovernmentIssued = "GOVERNMENT_ISSUED",
|
|
149
|
+
Health = "HEALTH",
|
|
150
|
+
Inferences = "INFERENCES",
|
|
151
|
+
Location = "LOCATION",
|
|
152
|
+
Other = "OTHER",
|
|
153
|
+
Pii = "PII",
|
|
154
|
+
ThirdPartyData = "THIRD_PARTY_DATA",
|
|
155
|
+
Usage = "USAGE"
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* Enumeration depicting how the data retention period is measured.
|
|
159
|
+
*
|
|
160
|
+
* @property INDEFINITE Data is retained indefinitely with no defined end date.
|
|
161
|
+
* @property RELATIVE_TO_ACCOUNT_CLOSURE_TIME Retention period starts when the account is closed.
|
|
162
|
+
* @property RELATIVE_TO_DATA_STORAGE_TIME Retention period starts when the data is stored.
|
|
163
|
+
* @property OTHER Retention policy does not fit standard categories.
|
|
164
|
+
*
|
|
165
|
+
* @enum
|
|
166
|
+
*/
|
|
167
|
+
export declare enum RetentionStyleEntity {
|
|
168
|
+
Indefinite = "INDEFINITE",
|
|
169
|
+
RelativeToAccountClosureTime = "RELATIVE_TO_ACCOUNT_CLOSURE_TIME",
|
|
170
|
+
RelativeToDataStorageTime = "RELATIVE_TO_DATA_STORAGE_TIME",
|
|
171
|
+
Other = "OTHER"
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* Retention details for a specific data category.
|
|
175
|
+
*
|
|
176
|
+
* @interface RetentionInfoEntity
|
|
177
|
+
* @property {RetentionStyleEntity} style How the retention period is expressed.
|
|
178
|
+
* @property {number} timeInDays Retention period in days, when specified.
|
|
179
|
+
* @property {string} additionalInfo Free-text clarification from the policy.
|
|
180
|
+
*/
|
|
181
|
+
export interface RetentionInfoEntity {
|
|
182
|
+
style: RetentionStyleEntity;
|
|
183
|
+
timeInDays?: number;
|
|
184
|
+
additionalInfo?: string;
|
|
185
|
+
}
|
|
186
|
+
/**
|
|
187
|
+
* Privacy signals specific to a single data category.
|
|
188
|
+
*
|
|
189
|
+
* @interface CategorySignalsEntity
|
|
190
|
+
* @property {DataCategoryEntity} category The data category these signals apply to.
|
|
191
|
+
* @property {SignalValueEntity} collected Whether this category of data is collected.
|
|
192
|
+
* @property {string[]} dataLabels Descriptive labels for the collected data within this category.
|
|
193
|
+
* @property {ShareStyleEntity} sharedWithThirdParties How this category is shared with third parties.
|
|
194
|
+
* @property {SignalValueEntity} usedForAdvertising Whether this category is used for advertising or monetization.
|
|
195
|
+
* @property {SignalValueEntity} retained Whether this category is retained.
|
|
196
|
+
* @property {RetentionInfoEntity} retention Retention details when data is retained.
|
|
197
|
+
* @property {SignalValueEntity} userCanOptOut Whether the user can opt out of this category's collection.
|
|
198
|
+
* @property {SignalValueEntity} requiredForService Whether this data is required for the core service to function.
|
|
199
|
+
* @property {SignalValueEntity} requiredForLaw Whether this data is collected to comply with legal requirements.
|
|
200
|
+
*/
|
|
201
|
+
export interface CategorySignalsEntity {
|
|
202
|
+
category: DataCategoryEntity;
|
|
203
|
+
collected: SignalValueEntity;
|
|
204
|
+
dataLabels: string[];
|
|
205
|
+
sharedWithThirdParties: ShareStyleEntity;
|
|
206
|
+
usedForAdvertising: SignalValueEntity;
|
|
207
|
+
retained: SignalValueEntity;
|
|
208
|
+
retention?: RetentionInfoEntity;
|
|
209
|
+
userCanOptOut: SignalValueEntity;
|
|
210
|
+
requiredForService: SignalValueEntity;
|
|
211
|
+
requiredForLaw: SignalValueEntity;
|
|
212
|
+
}
|
|
213
|
+
/**
|
|
214
|
+
* Signals derived from privacy actions and capabilities offered by the organization.
|
|
215
|
+
*
|
|
216
|
+
* @interface CapabilitySignalsEntity
|
|
217
|
+
* @property {SignalValueEntity} supportsAccountCreation Whether the organization supports creating an account.
|
|
218
|
+
* @property {SignalValueEntity} supportsAccountDeletion Whether the organization supports account deletion.
|
|
219
|
+
* @property {SignalValueEntity} supportsDataDeletionRequests Whether the organization supports data deletion requests.
|
|
220
|
+
* @property {SignalValueEntity} supportsDataExport Whether the organization supports data export.
|
|
221
|
+
* @property {SignalValueEntity} supportsSubscriptions Whether the organization supports subscription management.
|
|
222
|
+
* @property {SignalValueEntity} sellsPersonalInformation Whether the organization sells personal information.
|
|
223
|
+
* @property {SignalValueEntity} usesCookiesOrTracking Whether the organization uses cookies or tracking.
|
|
224
|
+
*/
|
|
225
|
+
export interface CapabilitySignalsEntity {
|
|
226
|
+
supportsAccountCreation: SignalValueEntity;
|
|
227
|
+
supportsAccountDeletion: SignalValueEntity;
|
|
228
|
+
supportsDataDeletionRequests: SignalValueEntity;
|
|
229
|
+
supportsDataExport: SignalValueEntity;
|
|
230
|
+
supportsSubscriptions: SignalValueEntity;
|
|
231
|
+
sellsPersonalInformation: SignalValueEntity;
|
|
232
|
+
usesCookiesOrTracking: SignalValueEntity;
|
|
233
|
+
}
|
|
234
|
+
/**
|
|
235
|
+
* Aggregated risk indicators derived from categories and capabilities.
|
|
236
|
+
*
|
|
237
|
+
* @interface RiskIndicatorsEntity
|
|
238
|
+
* @property {number} dataCollectionBreadth Total number of data categories collected.
|
|
239
|
+
* @property {SignalValueEntity} collectsSensitiveDataForNonEssentialPurposes Whether sensitive categories
|
|
240
|
+
* are collected for non-essential purposes.
|
|
241
|
+
* @property {SignalValueEntity} sellsPersonalInformation Whether data selling is indicated.
|
|
242
|
+
* @property {number} maxRetentionDays Longest known retention period in days across all categories.
|
|
243
|
+
* @property {SignalValueEntity} hasIndefiniteRetention Whether any category has indefinite retention.
|
|
244
|
+
* @property {SignalValueEntity} encryptionPractices Whether strong encryption practices are in place.
|
|
245
|
+
* @property {SignalValueEntity} breachRisk Whether there is an elevated risk of data breach.
|
|
246
|
+
*/
|
|
247
|
+
export interface RiskIndicatorsEntity {
|
|
248
|
+
dataCollectionBreadth: number;
|
|
249
|
+
collectsSensitiveDataForNonEssentialPurposes: SignalValueEntity;
|
|
250
|
+
sellsPersonalInformation: SignalValueEntity;
|
|
251
|
+
maxRetentionDays?: number;
|
|
252
|
+
hasIndefiniteRetention: SignalValueEntity;
|
|
253
|
+
encryptionPractices: SignalValueEntity;
|
|
254
|
+
breachRisk: SignalValueEntity;
|
|
255
|
+
}
|
|
256
|
+
/**
|
|
257
|
+
* The business category of an organization as classified by the analysis.
|
|
258
|
+
*
|
|
259
|
+
* @enum
|
|
260
|
+
*/
|
|
261
|
+
export declare enum OrganizationCategoryEntity {
|
|
262
|
+
Automotive = "Automotive",
|
|
263
|
+
Communications = "Communications",
|
|
264
|
+
CommunityAndCharity = "CommunityAndCharity",
|
|
265
|
+
Cryptocurrency = "Cryptocurrency",
|
|
266
|
+
Dating = "Dating",
|
|
267
|
+
Education = "Education",
|
|
268
|
+
Employment = "Employment",
|
|
269
|
+
EnergyAndUtilities = "EnergyAndUtilities",
|
|
270
|
+
Entertainment = "Entertainment",
|
|
271
|
+
Finance = "Finance",
|
|
272
|
+
FoodAndDining = "FoodAndDining",
|
|
273
|
+
Gambling = "Gambling",
|
|
274
|
+
Government = "Government",
|
|
275
|
+
Health = "Health",
|
|
276
|
+
Insurance = "Insurance",
|
|
277
|
+
Military = "Military",
|
|
278
|
+
News = "News",
|
|
279
|
+
Other = "Other",
|
|
280
|
+
PersonalEmail = "PersonalEmail",
|
|
281
|
+
PrivacyAndSecurity = "PrivacyAndSecurity",
|
|
282
|
+
RealEstate = "RealEstate",
|
|
283
|
+
ShippingAndDelivery = "ShippingAndDelivery",
|
|
284
|
+
Shopping = "Shopping",
|
|
285
|
+
SocialMedia = "SocialMedia",
|
|
286
|
+
SportsAndFitness = "SportsAndFitness",
|
|
287
|
+
Technology = "Technology",
|
|
288
|
+
Transportation = "Transportation",
|
|
289
|
+
Travel = "Travel",
|
|
290
|
+
VideoGames = "VideoGames"
|
|
291
|
+
}
|
|
292
|
+
/**
|
|
293
|
+
* Identifies the organization behind a data holder.
|
|
294
|
+
*
|
|
295
|
+
* @interface OrganizationIdentityEntity
|
|
296
|
+
* @property {string} brandName The consumer-facing brand name of the organization.
|
|
297
|
+
* @property {string} companyName The legal or corporate name of the organization.
|
|
298
|
+
* @property {OrganizationCategoryEntity} primaryCategory The primary business category of the organization.
|
|
299
|
+
* @property {OrganizationCategoryEntity[]} categories All business categories the organization belongs to.
|
|
300
|
+
*/
|
|
301
|
+
export interface OrganizationIdentityEntity {
|
|
302
|
+
brandName: string;
|
|
303
|
+
companyName: string;
|
|
304
|
+
primaryCategory: OrganizationCategoryEntity;
|
|
305
|
+
categories: OrganizationCategoryEntity[];
|
|
306
|
+
}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
|
|
3
|
+
*
|
|
4
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
*/
|
|
6
|
+
import { AnalysisResultSubscriber } from '../../../../public/typings/subscription';
|
|
7
|
+
import { AnalysisResultEntity } from './analysisResultEntity';
|
|
8
|
+
/**
|
|
9
|
+
* Input for `AnalysisResultService.list` method.
|
|
10
|
+
*
|
|
11
|
+
* @interface ListAnalysisResultsInput
|
|
12
|
+
* @property {string} virtualPresenceId The virtual presence to list analysis results for.
|
|
13
|
+
* @property {number} limit Number of records to return.
|
|
14
|
+
* @property {string} nextToken A token generated by a previous call to `AnalysisResultService.list`.
|
|
15
|
+
* This allows for pagination.
|
|
16
|
+
*/
|
|
17
|
+
export interface ListAnalysisResultsInput {
|
|
18
|
+
virtualPresenceId: string;
|
|
19
|
+
limit?: number;
|
|
20
|
+
nextToken?: string;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Output for `AnalysisResultService.list` method.
|
|
24
|
+
*
|
|
25
|
+
* @interface ListAnalysisResultsOutput
|
|
26
|
+
* @property {AnalysisResultEntity[]} analysisResults The list of analysis results retrieved in this query.
|
|
27
|
+
* @property {string} nextToken A token generated by a previous call. This allows for pagination.
|
|
28
|
+
*/
|
|
29
|
+
export interface ListAnalysisResultsOutput {
|
|
30
|
+
analysisResults: AnalysisResultEntity[];
|
|
31
|
+
nextToken?: string;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Input for `AnalysisResultService.subscribe` method.
|
|
35
|
+
*
|
|
36
|
+
* @interface SubscribeToAnalysisResultInput
|
|
37
|
+
* @property {string} subscriptionId A unique identifier for this subscription.
|
|
38
|
+
* @property {string} owner The identifier of the owner to subscribe for.
|
|
39
|
+
* @property {AnalysisResultSubscriber} subscriber The subscriber to receive events.
|
|
40
|
+
*/
|
|
41
|
+
export interface SubscribeToAnalysisResultInput {
|
|
42
|
+
subscriptionId: string;
|
|
43
|
+
owner: string;
|
|
44
|
+
subscriber: AnalysisResultSubscriber;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Core entity representation of an analysis result service used in business logic.
|
|
48
|
+
* Used to perform CRUD operations for analysis results.
|
|
49
|
+
*
|
|
50
|
+
* @interface AnalysisResultService
|
|
51
|
+
*/
|
|
52
|
+
export interface AnalysisResultService {
|
|
53
|
+
/**
|
|
54
|
+
* Retrieve a single analysis result by ID.
|
|
55
|
+
*
|
|
56
|
+
* @param {string} id The unique identifier of the analysis result.
|
|
57
|
+
* @returns {AnalysisResultEntity | undefined} The analysis result, or undefined if not found.
|
|
58
|
+
*/
|
|
59
|
+
get(id: string): Promise<AnalysisResultEntity | undefined>;
|
|
60
|
+
/**
|
|
61
|
+
* Retrieve a list of analysis results for a virtual presence.
|
|
62
|
+
*
|
|
63
|
+
* @param {ListAnalysisResultsInput} input Parameters used to list analysis results.
|
|
64
|
+
* @returns {ListAnalysisResultsOutput} A list of analysis results matching the search criteria.
|
|
65
|
+
* Can be empty if no analysis results found.
|
|
66
|
+
*/
|
|
67
|
+
list(input: ListAnalysisResultsInput): Promise<ListAnalysisResultsOutput>;
|
|
68
|
+
/**
|
|
69
|
+
* Subscribe to analysis result state events.
|
|
70
|
+
*
|
|
71
|
+
* @param {SubscribeToAnalysisResultInput} input Parameters used to subscribe to
|
|
72
|
+
* analysis result state events.
|
|
73
|
+
*/
|
|
74
|
+
subscribe(input: SubscribeToAnalysisResultInput): Promise<void>;
|
|
75
|
+
/**
|
|
76
|
+
* Unsubscribe from analysis result state events.
|
|
77
|
+
*
|
|
78
|
+
* @param {string} subscriptionId The unique identifier of the subscription to unsubscribe from.
|
|
79
|
+
*/
|
|
80
|
+
unsubscribe(subscriptionId: string): void;
|
|
81
|
+
}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
|
|
3
|
+
*
|
|
4
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* Core entity representation of a data holder.
|
|
8
|
+
*
|
|
9
|
+
* A data holder is an organization that holds data associated with a user's virtual presence.
|
|
10
|
+
*
|
|
11
|
+
* @interface DataHolderEntity
|
|
12
|
+
* @property {string} id Unique identifier associated with the data holder.
|
|
13
|
+
* @property {string} virtualPresenceId The virtual presence this data holder is associated with.
|
|
14
|
+
* @property {string} domainName Domain name of the data holder.
|
|
15
|
+
* @property {string} name Display name of the data holder.
|
|
16
|
+
* @property {DataHolderProtectionStateEntity} protectionState Current protection state.
|
|
17
|
+
* @property {boolean} complianceConcern Whether there is a compliance concern.
|
|
18
|
+
* @property {Date} mostRecentInteractionAt Date of the most recent interaction.
|
|
19
|
+
* @property {string} owner Unique identifier of the user.
|
|
20
|
+
* @property {number} version Version of this entity. Increments on update.
|
|
21
|
+
* @property {Date} createdAt Date for when the data holder was created.
|
|
22
|
+
* @property {Date} updatedAt Date for when the data holder was last updated.
|
|
23
|
+
*/
|
|
24
|
+
export interface DataHolderEntity {
|
|
25
|
+
id: string;
|
|
26
|
+
virtualPresenceId: string;
|
|
27
|
+
domainName: string;
|
|
28
|
+
name: string;
|
|
29
|
+
protectionState: DataHolderProtectionStateEntity;
|
|
30
|
+
complianceConcern: boolean;
|
|
31
|
+
mostRecentInteractionAt: Date;
|
|
32
|
+
owner: string;
|
|
33
|
+
version: number;
|
|
34
|
+
createdAt: Date;
|
|
35
|
+
updatedAt: Date;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Enumeration that defines the protection state of a data holder.
|
|
39
|
+
*
|
|
40
|
+
* @property MONITORED The data holder is being monitored.
|
|
41
|
+
* @property ACTION_REQUESTED An action has been requested against this data holder.
|
|
42
|
+
* @property RESOLVED The data holder has been resolved.
|
|
43
|
+
*
|
|
44
|
+
* @enum
|
|
45
|
+
*/
|
|
46
|
+
export declare enum DataHolderProtectionStateEntity {
|
|
47
|
+
Monitored = "MONITORED",
|
|
48
|
+
ActionRequested = "ACTION_REQUESTED",
|
|
49
|
+
Resolved = "RESOLVED",
|
|
50
|
+
Unknown = "UNKNOWN"
|
|
51
|
+
}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
|
|
3
|
+
*
|
|
4
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
*/
|
|
6
|
+
import { DataHolderSubscriber } from '../../../../public/typings/subscription';
|
|
7
|
+
import { DataHolderEntity } from './dataHolderEntity';
|
|
8
|
+
/**
|
|
9
|
+
* Input for `DataHolderService.list` method.
|
|
10
|
+
*
|
|
11
|
+
* @interface ListDataHoldersInput
|
|
12
|
+
* @property {string} virtualPresenceId The virtual presence to list data holders for.
|
|
13
|
+
* @property {number} limit Number of records to return.
|
|
14
|
+
* @property {string} nextToken A token generated by a previous call to `DataHolderService.list`.
|
|
15
|
+
* This allows for pagination.
|
|
16
|
+
*/
|
|
17
|
+
export interface ListDataHoldersInput {
|
|
18
|
+
virtualPresenceId: string;
|
|
19
|
+
limit?: number;
|
|
20
|
+
nextToken?: string;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Output for `DataHolderService.list` method.
|
|
24
|
+
*
|
|
25
|
+
* @interface ListDataHoldersOutput
|
|
26
|
+
* @property {DataHolderEntity[]} dataHolders The list of data holders retrieved in this query.
|
|
27
|
+
* @property {string} nextToken A token generated by a previous call. This allows for pagination.
|
|
28
|
+
*/
|
|
29
|
+
export interface ListDataHoldersOutput {
|
|
30
|
+
dataHolders: DataHolderEntity[];
|
|
31
|
+
nextToken?: string;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Input for `DataHolderService.subscribe` method.
|
|
35
|
+
*
|
|
36
|
+
* @interface SubscribeToDataHolderInput
|
|
37
|
+
* @property {string} subscriptionId A unique identifier for this subscription.
|
|
38
|
+
* @property {string} owner The identifier of the owner to subscribe for.
|
|
39
|
+
* @property {DataHolderSubscriber} subscriber The subscriber to receive events.
|
|
40
|
+
*/
|
|
41
|
+
export interface SubscribeToDataHoldersInput {
|
|
42
|
+
subscriptionId: string;
|
|
43
|
+
owner: string;
|
|
44
|
+
subscriber: DataHolderSubscriber;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Core entity representation of a data holder service used in business logic.
|
|
48
|
+
* Used to perform CRUD operations for data holders.
|
|
49
|
+
*
|
|
50
|
+
* @interface DataHolderService
|
|
51
|
+
*/
|
|
52
|
+
export interface DataHolderService {
|
|
53
|
+
/**
|
|
54
|
+
* Retrieve a single data holder by ID.
|
|
55
|
+
*
|
|
56
|
+
* @param {string} id The unique identifier of the data holder.
|
|
57
|
+
* @returns {DataHolderEntity | undefined} The data holder, or undefined if not found.
|
|
58
|
+
*/
|
|
59
|
+
get(id: string): Promise<DataHolderEntity | undefined>;
|
|
60
|
+
/**
|
|
61
|
+
* Retrieve a list of data holders for a virtual presence.
|
|
62
|
+
*
|
|
63
|
+
* @param {ListDataHoldersInput} input Parameters used to list data holders.
|
|
64
|
+
* @returns {ListDataHoldersOutput} A list of data holders matching the search criteria.
|
|
65
|
+
* Can be empty if no data holders found.
|
|
66
|
+
*/
|
|
67
|
+
list(input: ListDataHoldersInput): Promise<ListDataHoldersOutput>;
|
|
68
|
+
/**
|
|
69
|
+
* Subscribe to data holder state events.
|
|
70
|
+
*
|
|
71
|
+
* @param {SubscribeToDataHoldersInput} input Parameters used to subscribe to data
|
|
72
|
+
* holder state events.
|
|
73
|
+
*/
|
|
74
|
+
subscribe(input: SubscribeToDataHoldersInput): Promise<void>;
|
|
75
|
+
/**
|
|
76
|
+
* Unsubscribe from data holder state events.
|
|
77
|
+
*
|
|
78
|
+
* @param {string} subscriptionId The unique identifier of the subscription to unsubscribe from.
|
|
79
|
+
*/
|
|
80
|
+
unsubscribe(subscriptionId: string): void;
|
|
81
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
|
|
3
|
+
*
|
|
4
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* Options to control a rescan operation.
|
|
8
|
+
*
|
|
9
|
+
* @interface ScanOptionsEntity
|
|
10
|
+
* @property {number} maximumItemsProcessed Maximum number of items to process during the scan.
|
|
11
|
+
* @property {string} earliestScanDate Earliest date boundary for the scan (ISO 8601 string).
|
|
12
|
+
* @property {string} latestScanDate Latest date boundary for the scan (ISO 8601 string).
|
|
13
|
+
* @property {string[]} excludeDomains Domains to exclude from the scan.
|
|
14
|
+
* @property {string[]} excludeCategories Categories to exclude from the scan.
|
|
15
|
+
*/
|
|
16
|
+
export interface ScanOptionsEntity {
|
|
17
|
+
maximumItemsProcessed?: number;
|
|
18
|
+
earliestScanDate?: string;
|
|
19
|
+
latestScanDate?: string;
|
|
20
|
+
excludeDomains?: string[];
|
|
21
|
+
excludeCategories?: string[];
|
|
22
|
+
}
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
|
|
3
|
+
*
|
|
4
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* Core entity representation of a virtual presence business rule.
|
|
8
|
+
*
|
|
9
|
+
* A virtual presence is a user's identity on an external platform.
|
|
10
|
+
*
|
|
11
|
+
* @interface VirtualPresenceEntity
|
|
12
|
+
* @property {string} id Unique identifier associated with the virtual presence.
|
|
13
|
+
* @property {string} owner Unique identifier of the user associated with the virtual presence.
|
|
14
|
+
* @property {number} version Version of this entity. Increments on update.
|
|
15
|
+
* @property {ProviderTypeEntity} providerType The provider type for this virtual presence.
|
|
16
|
+
* @property {string} identifier The presence identifier (e.g. email address).
|
|
17
|
+
* @property {VirtualPresenceStateEntity} state The current state of the virtual presence.
|
|
18
|
+
* @property {Date} lastScannedAt Date for when the virtual presence was last scanned.
|
|
19
|
+
* @property {Date} createdAt Date for when the virtual presence was created.
|
|
20
|
+
* @property {Date} updatedAt Date for when the virtual presence was last updated.
|
|
21
|
+
*/
|
|
22
|
+
export interface VirtualPresenceEntity {
|
|
23
|
+
id: string;
|
|
24
|
+
owner: string;
|
|
25
|
+
version: number;
|
|
26
|
+
providerType: ProviderTypeEntity;
|
|
27
|
+
identifier: string;
|
|
28
|
+
state: VirtualPresenceStateEntity;
|
|
29
|
+
lastScannedAt: Date;
|
|
30
|
+
createdAt: Date;
|
|
31
|
+
updatedAt: Date;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Enumeration that defines the provider type of the virtual presence.
|
|
35
|
+
*
|
|
36
|
+
* @enum
|
|
37
|
+
*/
|
|
38
|
+
export declare enum ProviderTypeEntity {
|
|
39
|
+
Email = "EMAIL",
|
|
40
|
+
Unknown = "UNKNOWN"
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Enumeration that defines the possible states of a virtual presence.
|
|
44
|
+
*
|
|
45
|
+
* @property CONNECTED: The virtual presence is active and connected to the provider.
|
|
46
|
+
* @property SCANNING: The virtual presence is currently being scanned.
|
|
47
|
+
* @property NEEDS_REAUTH: The virtual presence requires re-authentication with the provider.
|
|
48
|
+
* @property ERROR: The virtual presence encountered an error and is in a failed state.
|
|
49
|
+
* @property INACTIVE: The virtual presence is no longer active.
|
|
50
|
+
*
|
|
51
|
+
* @enum
|
|
52
|
+
*/
|
|
53
|
+
export declare enum VirtualPresenceStateEntity {
|
|
54
|
+
Connected = "CONNECTED",
|
|
55
|
+
Scanning = "SCANNING",
|
|
56
|
+
NeedsReauth = "NEEDS_REAUTH",
|
|
57
|
+
Error = "ERROR",
|
|
58
|
+
Inactive = "INACTIVE",
|
|
59
|
+
Unknown = "UNKNOWN"
|
|
60
|
+
}
|