@sudoplatform/sudo-privacy-interaction 2.0.0 → 2.2.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/cjs/gen/graphqlTypes.js +2291 -780
- package/cjs/private/data/action/actionSubscriptionManager.js +25 -0
- package/cjs/private/data/action/defaultActionService.js +80 -0
- package/cjs/private/data/action/transformer/actionFulfilmentMethodTransformer.js +47 -0
- package/cjs/private/data/action/transformer/actionIntentTransformer.js +69 -0
- package/cjs/private/data/action/transformer/actionOriginTransformer.js +37 -0
- package/cjs/private/data/action/transformer/actionStatusTransformer.js +53 -0
- package/cjs/private/data/action/transformer/actionTransformer.js +85 -0
- package/cjs/private/data/action/transformer/availableActionTransformer.js +37 -0
- package/cjs/private/data/analysis-result/transformer/privacyScoreTransformer.js +8 -0
- package/cjs/private/data/common/apiClient.js +58 -0
- package/cjs/private/data/data-holder/defaultDataHolderService.js +12 -0
- package/cjs/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.js +56 -0
- package/cjs/private/data/organization-analysis/defaultOrganizationAnalysisService.js +31 -0
- package/cjs/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.js +29 -0
- package/cjs/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +45 -0
- package/cjs/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +2 -0
- package/cjs/private/domain/entities/action/actionEntity.js +86 -0
- package/cjs/private/domain/entities/action/actionService.js +7 -0
- package/cjs/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +24 -0
- package/cjs/private/domain/entities/organization-analysis/organizationAnalysisService.js +7 -0
- package/cjs/private/domain/use-cases/action/confirmActionOutcomeUseCase.js +25 -0
- package/cjs/private/domain/use-cases/action/initiateActionUseCase.js +26 -0
- package/cjs/private/domain/use-cases/action/listAvailableActionsUseCase.js +26 -0
- package/cjs/private/domain/use-cases/action/subscribeToActionUseCase.js +37 -0
- package/cjs/private/domain/use-cases/action/unsubscribeFromActionUseCase.js +27 -0
- package/cjs/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.js +29 -0
- package/cjs/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.js +25 -0
- package/cjs/public/defaultSudoPrivacyInteractionClient.js +133 -6
- package/cjs/public/inputs/action.js +7 -0
- package/cjs/public/inputs/index.js +2 -0
- package/cjs/public/inputs/organizationAnalysis.js +7 -0
- package/cjs/public/typings/action.js +85 -0
- package/cjs/public/typings/index.js +2 -0
- package/cjs/public/typings/organizationAnalysis.js +24 -0
- package/docs/assets/hierarchy.js +1 -1
- package/docs/assets/navigation.js +1 -1
- package/docs/assets/search.js +1 -1
- package/docs/classes/DefaultSudoPrivacyInteractionClient.html +176 -21
- package/docs/enums/ActionFulfilmentMethod.html +63 -0
- package/docs/enums/ActionIntent.html +84 -0
- package/docs/enums/ActionOrigin.html +75 -0
- package/docs/enums/ActionStatus.html +99 -0
- package/docs/enums/ConnectionState.html +3 -3
- package/docs/enums/DataCategory.html +18 -18
- package/docs/enums/DataHolderProtectionState.html +5 -5
- package/docs/enums/OrganizationAnalysisMode.html +70 -0
- package/docs/enums/OrganizationCategory.html +30 -30
- package/docs/enums/ProviderType.html +3 -3
- package/docs/enums/RetentionStyle.html +5 -5
- package/docs/enums/ShareStyle.html +6 -6
- package/docs/enums/SignalValue.html +4 -4
- package/docs/enums/VirtualPresenceState.html +7 -7
- package/docs/hierarchy.html +6 -5
- package/docs/interfaces/Action.html +167 -0
- package/docs/interfaces/ActionContact.html +77 -0
- package/docs/interfaces/ActionSubscriber.html +92 -0
- package/docs/interfaces/AnalysisResultSubscriber.html +3 -3
- package/docs/interfaces/AssistedEmailTemplate.html +70 -0
- package/docs/interfaces/AssistedPayload.html +113 -0
- package/docs/interfaces/AvailableAction.html +102 -0
- package/docs/interfaces/CapabilitySignals.html +9 -9
- package/docs/interfaces/CategorySignals.html +11 -11
- package/docs/interfaces/DataHolder.html +24 -14
- package/docs/interfaces/DataHolderScanSummary.html +158 -0
- package/docs/interfaces/DataHolderSubscriber.html +3 -3
- package/docs/interfaces/GetDataHolderOptions.html +63 -0
- package/docs/interfaces/GetOrganizationAnalysisInput.html +70 -0
- package/docs/interfaces/InitiateActionInput.html +79 -0
- package/docs/interfaces/ListAnalysisResultsInput.html +1 -1
- package/docs/interfaces/ListAvailableActionsInput.html +61 -0
- package/docs/interfaces/ListDataHolderScanSummariesInput.html +85 -0
- package/docs/interfaces/ListDataHoldersInput.html +1 -1
- package/docs/interfaces/ListVirtualPresencesInput.html +1 -1
- package/docs/interfaces/OrganizationAnalysis.html +131 -0
- package/docs/interfaces/OrganizationIdentity.html +5 -5
- package/docs/interfaces/Pagination.html +2 -1
- package/docs/interfaces/PrivacyScore.html +13 -5
- package/docs/interfaces/PrivacySummary.html +4 -4
- package/docs/interfaces/RetentionInfo.html +4 -4
- package/docs/interfaces/RiskIndicators.html +8 -8
- package/docs/interfaces/ScoreContribution.html +3 -3
- package/docs/interfaces/ScoreCoverage.html +70 -0
- package/docs/interfaces/SudoPrivacyInteractionClient.html +169 -21
- package/docs/interfaces/VirtualPresence.html +21 -12
- package/docs/interfaces/VirtualPresenceSubscriber.html +3 -3
- package/docs/modules.html +4 -4
- package/docs/types/SudoPrivacyInteractionClientOptions.html +2 -2
- package/lib/gen/graphqlTypes.js +2290 -779
- package/lib/private/data/action/actionSubscriptionManager.js +21 -0
- package/lib/private/data/action/defaultActionService.js +76 -0
- package/lib/private/data/action/transformer/actionFulfilmentMethodTransformer.js +43 -0
- package/lib/private/data/action/transformer/actionIntentTransformer.js +65 -0
- package/lib/private/data/action/transformer/actionOriginTransformer.js +33 -0
- package/lib/private/data/action/transformer/actionStatusTransformer.js +49 -0
- package/lib/private/data/action/transformer/actionTransformer.js +81 -0
- package/lib/private/data/action/transformer/availableActionTransformer.js +33 -0
- package/lib/private/data/analysis-result/transformer/privacyScoreTransformer.js +8 -0
- package/lib/private/data/common/apiClient.js +59 -1
- package/lib/private/data/data-holder/defaultDataHolderService.js +12 -0
- package/lib/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.js +52 -0
- package/lib/private/data/organization-analysis/defaultOrganizationAnalysisService.js +27 -0
- package/lib/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.js +25 -0
- package/lib/private/data/organization-analysis/transformer/organizationAnalysisTransformer.js +41 -0
- package/lib/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +2 -0
- package/lib/private/domain/entities/action/actionEntity.js +83 -0
- package/lib/private/domain/entities/action/actionService.js +6 -0
- package/lib/private/domain/entities/organization-analysis/organizationAnalysisEntity.js +21 -0
- package/lib/private/domain/entities/organization-analysis/organizationAnalysisService.js +6 -0
- package/lib/private/domain/use-cases/action/confirmActionOutcomeUseCase.js +21 -0
- package/lib/private/domain/use-cases/action/initiateActionUseCase.js +22 -0
- package/lib/private/domain/use-cases/action/listAvailableActionsUseCase.js +22 -0
- package/lib/private/domain/use-cases/action/subscribeToActionUseCase.js +33 -0
- package/lib/private/domain/use-cases/action/unsubscribeFromActionUseCase.js +23 -0
- package/lib/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.js +25 -0
- package/lib/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.js +21 -0
- package/lib/public/defaultSudoPrivacyInteractionClient.js +133 -6
- package/lib/public/inputs/action.js +6 -0
- package/lib/public/inputs/index.js +2 -0
- package/lib/public/inputs/organizationAnalysis.js +6 -0
- package/lib/public/typings/action.js +82 -0
- package/lib/public/typings/index.js +2 -0
- package/lib/public/typings/organizationAnalysis.js +21 -0
- package/package.json +5 -3
- package/types/gen/graphqlTypes.d.ts +569 -1
- package/types/private/data/action/actionSubscriptionManager.d.ts +19 -0
- package/types/private/data/action/defaultActionService.d.ts +23 -0
- package/types/private/data/action/transformer/actionFulfilmentMethodTransformer.d.ts +14 -0
- package/types/private/data/action/transformer/actionIntentTransformer.d.ts +14 -0
- package/types/private/data/action/transformer/actionOriginTransformer.d.ts +12 -0
- package/types/private/data/action/transformer/actionStatusTransformer.d.ts +12 -0
- package/types/private/data/action/transformer/actionTransformer.d.ts +39 -0
- package/types/private/data/action/transformer/availableActionTransformer.d.ts +15 -0
- package/types/private/data/common/apiClient.d.ts +16 -1
- package/types/private/data/common/baseSubscriptionManager.d.ts +5 -0
- package/types/private/data/data-holder/defaultDataHolderService.d.ts +3 -1
- package/types/private/data/data-holder/transformer/dataHolderScanSummaryTransformer.d.ts +18 -0
- package/types/private/data/organization-analysis/defaultOrganizationAnalysisService.d.ts +15 -0
- package/types/private/data/organization-analysis/transformer/organizationAnalysisModeTransformer.d.ts +12 -0
- package/types/private/data/organization-analysis/transformer/organizationAnalysisTransformer.d.ts +14 -0
- package/types/private/domain/entities/action/actionEntity.d.ts +187 -0
- package/types/private/domain/entities/action/actionService.d.ts +99 -0
- package/types/private/domain/entities/analysis-result/analysisResultEntity.d.ts +14 -0
- package/types/private/domain/entities/data-holder/dataHolderEntity.d.ts +34 -0
- package/types/private/domain/entities/data-holder/dataHolderService.d.ts +35 -1
- package/types/private/domain/entities/organization-analysis/organizationAnalysisEntity.d.ts +53 -0
- package/types/private/domain/entities/organization-analysis/organizationAnalysisService.d.ts +35 -0
- package/types/private/domain/entities/virtual-presence/virtualPresenceEntity.d.ts +3 -0
- package/types/private/domain/use-cases/action/confirmActionOutcomeUseCase.d.ts +16 -0
- package/types/private/domain/use-cases/action/initiateActionUseCase.d.ts +17 -0
- package/types/private/domain/use-cases/action/listAvailableActionsUseCase.d.ts +16 -0
- package/types/private/domain/use-cases/action/subscribeToActionUseCase.d.ts +27 -0
- package/types/private/domain/use-cases/action/unsubscribeFromActionUseCase.d.ts +15 -0
- package/types/private/domain/use-cases/data-holder/listDataHolderScanSummariesUseCase.d.ts +36 -0
- package/types/private/domain/use-cases/organization-analysis/getOrganizationAnalysisUseCase.d.ts +16 -0
- package/types/public/defaultSudoPrivacyInteractionClient.d.ts +19 -3
- package/types/public/inputs/action.d.ts +30 -0
- package/types/public/inputs/dataHolder.d.ts +22 -0
- package/types/public/inputs/index.d.ts +2 -0
- package/types/public/inputs/organizationAnalysis.d.ts +18 -0
- package/types/public/sudoPrivacyInteractionClient.d.ts +64 -3
- package/types/public/typings/action.d.ts +185 -0
- package/types/public/typings/analysisResult.d.ts +14 -0
- package/types/public/typings/dataHolder.d.ts +38 -0
- package/types/public/typings/index.d.ts +2 -0
- package/types/public/typings/organizationAnalysis.d.ts +53 -0
- package/types/public/typings/subscription.d.ts +23 -0
- package/types/public/typings/virtualPresence.d.ts +3 -0
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
|
|
3
|
+
*
|
|
4
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* The user-facing intent of an action.
|
|
8
|
+
*
|
|
9
|
+
* Clients must tolerate unknown values: an unrecognised intent is represented
|
|
10
|
+
* as `Other` rather than failing, so newly added intents do not break existing
|
|
11
|
+
* clients.
|
|
12
|
+
*
|
|
13
|
+
* @property STOP_CONTACT Unsubscribe / opt out of marketing communications.
|
|
14
|
+
* @property ACCESS_MY_DATA Data subject access / portability request.
|
|
15
|
+
* @property DELETE_MY_DATA Account deletion / data erasure.
|
|
16
|
+
* @property LIMIT_DATA_USE Opt out of sale / tracking, manage consent.
|
|
17
|
+
* @property OTHER Anything unmapped; carries additionalInfo.
|
|
18
|
+
*
|
|
19
|
+
* @enum
|
|
20
|
+
*/
|
|
21
|
+
export var ActionIntent;
|
|
22
|
+
(function (ActionIntent) {
|
|
23
|
+
ActionIntent["StopContact"] = "STOP_CONTACT";
|
|
24
|
+
ActionIntent["AccessMyData"] = "ACCESS_MY_DATA";
|
|
25
|
+
ActionIntent["DeleteMyData"] = "DELETE_MY_DATA";
|
|
26
|
+
ActionIntent["LimitDataUse"] = "LIMIT_DATA_USE";
|
|
27
|
+
ActionIntent["Other"] = "OTHER";
|
|
28
|
+
})(ActionIntent || (ActionIntent = {}));
|
|
29
|
+
/**
|
|
30
|
+
* How an action is fulfilled from the user's perspective.
|
|
31
|
+
*
|
|
32
|
+
* @property ASSISTED The service returns structured materials for the client to
|
|
33
|
+
* complete the action.
|
|
34
|
+
* @property DELEGATED The service performs the action on the user's behalf.
|
|
35
|
+
*
|
|
36
|
+
* @enum
|
|
37
|
+
*/
|
|
38
|
+
export var ActionFulfilmentMethod;
|
|
39
|
+
(function (ActionFulfilmentMethod) {
|
|
40
|
+
ActionFulfilmentMethod["Assisted"] = "ASSISTED";
|
|
41
|
+
ActionFulfilmentMethod["Delegated"] = "DELEGATED";
|
|
42
|
+
})(ActionFulfilmentMethod || (ActionFulfilmentMethod = {}));
|
|
43
|
+
/**
|
|
44
|
+
* Which source contributed an available action.
|
|
45
|
+
*
|
|
46
|
+
* @property STATIC Always-possible action for the virtual presence type.
|
|
47
|
+
* @property ANALYSIS Derived from an analysis source's reported actions.
|
|
48
|
+
* @property DISCOVERY Derived from a discovery scan (e.g. List-Unsubscribe).
|
|
49
|
+
*
|
|
50
|
+
* @enum
|
|
51
|
+
*/
|
|
52
|
+
export var ActionOrigin;
|
|
53
|
+
(function (ActionOrigin) {
|
|
54
|
+
ActionOrigin["Static"] = "STATIC";
|
|
55
|
+
ActionOrigin["Analysis"] = "ANALYSIS";
|
|
56
|
+
ActionOrigin["Discovery"] = "DISCOVERY";
|
|
57
|
+
ActionOrigin["Unknown"] = "UNKNOWN";
|
|
58
|
+
})(ActionOrigin || (ActionOrigin = {}));
|
|
59
|
+
/**
|
|
60
|
+
* Lifecycle status of a persisted action instance.
|
|
61
|
+
*
|
|
62
|
+
* @property PENDING The action has been created but not yet started.
|
|
63
|
+
* @property IN_PROGRESS The action is being performed.
|
|
64
|
+
* @property COMPLETED_UNVERIFIED The action completed but has not been verified.
|
|
65
|
+
* @property COMPLETED_VERIFIED The action completed and has been verified.
|
|
66
|
+
* @property FAILED The action failed to complete.
|
|
67
|
+
* @property REQUIRES_USER_INPUT The action requires further input from the user.
|
|
68
|
+
* @property CONTRADICTED Subsequent evidence contradicts the action's completion.
|
|
69
|
+
*
|
|
70
|
+
* @enum
|
|
71
|
+
*/
|
|
72
|
+
export var ActionStatus;
|
|
73
|
+
(function (ActionStatus) {
|
|
74
|
+
ActionStatus["Pending"] = "PENDING";
|
|
75
|
+
ActionStatus["InProgress"] = "IN_PROGRESS";
|
|
76
|
+
ActionStatus["CompletedUnverified"] = "COMPLETED_UNVERIFIED";
|
|
77
|
+
ActionStatus["CompletedVerified"] = "COMPLETED_VERIFIED";
|
|
78
|
+
ActionStatus["Failed"] = "FAILED";
|
|
79
|
+
ActionStatus["RequiresUserInput"] = "REQUIRES_USER_INPUT";
|
|
80
|
+
ActionStatus["Contradicted"] = "CONTRADICTED";
|
|
81
|
+
ActionStatus["Unknown"] = "UNKNOWN";
|
|
82
|
+
})(ActionStatus || (ActionStatus = {}));
|
|
@@ -3,8 +3,10 @@
|
|
|
3
3
|
*
|
|
4
4
|
* SPDX-License-Identifier: Apache-2.0
|
|
5
5
|
*/
|
|
6
|
+
export * from './action';
|
|
6
7
|
export * from './analysisResult';
|
|
7
8
|
export * from './dataHolder';
|
|
9
|
+
export * from './organizationAnalysis';
|
|
8
10
|
export * from './providerConfiguration';
|
|
9
11
|
export * from './subscription';
|
|
10
12
|
export * from './virtualPresence';
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Copyright © 2026 Anonyome Labs, Inc. All rights reserved.
|
|
3
|
+
*
|
|
4
|
+
* SPDX-License-Identifier: Apache-2.0
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* Controls how `getOrganizationAnalysis` obtains source results when the stored
|
|
8
|
+
* analysis is stale or absent.
|
|
9
|
+
*
|
|
10
|
+
* @property Analyze Read-through: request analysis from the sources, which may compute and
|
|
11
|
+
* leave the result pending until asynchronous work completes.
|
|
12
|
+
* @property Fetch Pull only the sources' existing values; never request new work. A stale
|
|
13
|
+
* domain with no existing source value is not moved to pending.
|
|
14
|
+
*
|
|
15
|
+
* @enum
|
|
16
|
+
*/
|
|
17
|
+
export var OrganizationAnalysisMode;
|
|
18
|
+
(function (OrganizationAnalysisMode) {
|
|
19
|
+
OrganizationAnalysisMode["Analyze"] = "ANALYZE";
|
|
20
|
+
OrganizationAnalysisMode["Fetch"] = "FETCH";
|
|
21
|
+
})(OrganizationAnalysisMode || (OrganizationAnalysisMode = {}));
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sudoplatform/sudo-privacy-interaction",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.2.0",
|
|
4
4
|
"author": "Anonyome Labs, Inc.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"repository": {
|
|
@@ -84,6 +84,7 @@
|
|
|
84
84
|
"@sudoplatform/sudo-entitlements-admin": "^13.0.2",
|
|
85
85
|
"@sudoplatform/sudo-user": "^17.1.1",
|
|
86
86
|
"@types/uuid": "^10.0.0",
|
|
87
|
+
"@types/ws": "^8.18.1",
|
|
87
88
|
"@typescript-eslint/eslint-plugin": "^8.26.1",
|
|
88
89
|
"@typescript-eslint/parser": "^8.26.1",
|
|
89
90
|
"@vitest/coverage-v8": "^4.1.11",
|
|
@@ -104,9 +105,10 @@
|
|
|
104
105
|
"typescript": "^5.9.2",
|
|
105
106
|
"uuid": "^11.1.0",
|
|
106
107
|
"vitest": "^4.1.11",
|
|
107
|
-
"wait-for-expect": "^4.0.0"
|
|
108
|
+
"wait-for-expect": "^4.0.0",
|
|
109
|
+
"ws": "^8.21.3"
|
|
108
110
|
},
|
|
109
|
-
"packageManager": "yarn@4.
|
|
111
|
+
"packageManager": "yarn@4.18.1+sha512.b2e1e7524f654f2749d32b4ebcb4622473cb5bcbc485df2007e12a154e50162a4d795526768bc5f5b8f81717bfd79deb2472813d86fb5ae2eb551fa9c872b08f",
|
|
110
112
|
"auditSuppressions": {
|
|
111
113
|
"1120607": {
|
|
112
114
|
"until": 1797004800,
|