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