@sudoplatform/sudo-privacy-interaction 1.1.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/gen/graphqlTypes.js +1750 -770
- package/cjs/private/data/analysis-result/transformer/privacyScoreTransformer.js +8 -0
- package/cjs/private/data/common/apiClient.js +31 -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/provider-configuration/defaultProviderConfigurationService.js +23 -0
- package/cjs/private/data/provider-configuration/transformer/providerConfigurationTransformer.js +52 -0
- package/cjs/private/data/virtual-presence/defaultVirtualPresenceService.js +11 -1
- package/cjs/private/data/virtual-presence/transformer/relationshipProviderTransformer.js +29 -0
- package/cjs/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +2 -0
- package/cjs/private/domain/entities/configuration/providerConfigurationEntity.js +7 -0
- package/cjs/private/domain/entities/configuration/providerConfigurationService.js +7 -0
- package/cjs/private/domain/entities/inputs/relationshipProviderEntity.js +21 -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/configuration/getProviderConfigurationUseCase.js +25 -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/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithAuthCodeUseCase.js +6 -2
- package/cjs/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithRefreshTokenUseCase.js +7 -1
- package/cjs/public/defaultSudoPrivacyInteractionClient.js +109 -9
- package/cjs/public/inputs/index.js +1 -0
- package/cjs/public/inputs/organizationAnalysis.js +7 -0
- package/cjs/public/inputs/virtualPresence.js +14 -0
- package/cjs/public/typings/index.js +2 -0
- package/cjs/public/typings/organizationAnalysis.js +24 -0
- package/cjs/public/typings/providerConfiguration.js +7 -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 +86 -22
- 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/RelationshipProvider.html +63 -0
- 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/CapabilitySignals.html +9 -9
- package/docs/interfaces/CategorySignals.html +11 -11
- package/docs/interfaces/ConnectVirtualPresenceWithAuthCodeInput.html +79 -0
- package/docs/interfaces/ConnectVirtualPresenceWithRefreshTokenInput.html +16 -7
- package/docs/interfaces/DataHolder.html +24 -14
- package/docs/interfaces/DataHolderScanSummary.html +158 -0
- package/docs/interfaces/GetDataHolderOptions.html +63 -0
- package/docs/interfaces/GetOrganizationAnalysisInput.html +70 -0
- package/docs/interfaces/ListAnalysisResultsInput.html +1 -1
- package/docs/interfaces/ListDataHolderScanSummariesInput.html +85 -0
- package/docs/interfaces/ListDataHoldersInput.html +1 -1
- package/docs/interfaces/ListVirtualPresencesInput.html +2 -2
- 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/ProviderConfiguration.html +80 -0
- package/docs/interfaces/RescanVirtualPresenceInput.html +3 -3
- package/docs/interfaces/RetentionInfo.html +4 -4
- package/docs/interfaces/RiskIndicators.html +8 -8
- package/docs/interfaces/ScanOptions.html +6 -6
- package/docs/interfaces/ScoreContribution.html +3 -3
- package/docs/interfaces/ScoreCoverage.html +70 -0
- package/docs/interfaces/SudoPrivacyInteractionClient.html +83 -22
- package/docs/interfaces/VirtualPresence.html +21 -12
- package/docs/modules.html +4 -4
- package/docs/types/SudoPrivacyInteractionClientOptions.html +2 -2
- package/lib/gen/graphqlTypes.js +1749 -769
- package/lib/private/data/analysis-result/transformer/privacyScoreTransformer.js +8 -0
- package/lib/private/data/common/apiClient.js +32 -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/provider-configuration/defaultProviderConfigurationService.js +19 -0
- package/lib/private/data/provider-configuration/transformer/providerConfigurationTransformer.js +48 -0
- package/lib/private/data/virtual-presence/defaultVirtualPresenceService.js +11 -1
- package/lib/private/data/virtual-presence/transformer/relationshipProviderTransformer.js +25 -0
- package/lib/private/data/virtual-presence/transformer/virtualPresenceTransformer.js +2 -0
- package/lib/private/domain/entities/configuration/providerConfigurationEntity.js +6 -0
- package/lib/private/domain/entities/configuration/providerConfigurationService.js +6 -0
- package/lib/private/domain/entities/inputs/relationshipProviderEntity.js +18 -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/configuration/getProviderConfigurationUseCase.js +21 -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/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithAuthCodeUseCase.js +6 -2
- package/lib/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithRefreshTokenUseCase.js +7 -1
- package/lib/public/defaultSudoPrivacyInteractionClient.js +109 -9
- package/lib/public/inputs/index.js +1 -0
- package/lib/public/inputs/organizationAnalysis.js +6 -0
- package/lib/public/inputs/virtualPresence.js +13 -1
- package/lib/public/typings/index.js +2 -0
- package/lib/public/typings/organizationAnalysis.js +21 -0
- package/lib/public/typings/providerConfiguration.js +6 -0
- package/package.json +9 -5
- package/types/gen/graphqlTypes.d.ts +349 -1
- package/types/private/data/common/apiClient.d.ts +11 -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/data/provider-configuration/defaultProviderConfigurationService.d.ts +14 -0
- package/types/private/data/provider-configuration/transformer/providerConfigurationTransformer.d.ts +19 -0
- package/types/private/data/virtual-presence/defaultVirtualPresenceService.d.ts +1 -0
- package/types/private/data/virtual-presence/transformer/relationshipProviderTransformer.d.ts +12 -0
- package/types/private/domain/entities/analysis-result/analysisResultEntity.d.ts +14 -0
- package/types/private/domain/entities/configuration/providerConfigurationEntity.d.ts +23 -0
- package/types/private/domain/entities/configuration/providerConfigurationService.d.ts +21 -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/inputs/relationshipProviderEntity.d.ts +17 -0
- 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/entities/virtual-presence/virtualPresenceService.d.ts +17 -2
- package/types/private/domain/use-cases/configuration/getProviderConfigurationUseCase.d.ts +16 -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/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithAuthCodeUseCase.d.ts +13 -1
- package/types/private/domain/use-cases/virtual-presence/connectVirtualPresenceWithRefreshTokenUseCase.d.ts +2 -0
- package/types/public/defaultSudoPrivacyInteractionClient.d.ts +14 -4
- package/types/public/inputs/dataHolder.d.ts +22 -0
- package/types/public/inputs/index.d.ts +1 -0
- package/types/public/inputs/organizationAnalysis.d.ts +18 -0
- package/types/public/inputs/virtualPresence.d.ts +30 -0
- package/types/public/sudoPrivacyInteractionClient.d.ts +34 -5
- 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/providerConfiguration.d.ts +23 -0
- package/types/public/typings/virtualPresence.d.ts +3 -0
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ProviderConfiguration | @sudoplatform/sudo-privacy-interaction</title><meta name="description" content="Documentation for @sudoplatform/sudo-privacy-interaction"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@sudoplatform/sudo-privacy-interaction</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">ProviderConfiguration</a></li></ul>
|
|
12
|
+
<h1>Interface ProviderConfiguration</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>The Sudo Platform SDK representation of a provider client configuration.</p>
|
|
15
|
+
<p>Contains the configuration required by consumers to support the provider
|
|
16
|
+
OAuth flow. This is the decoded form of the opaque configuration data
|
|
17
|
+
returned by the service.</p>
|
|
18
|
+
<p>ProviderConfiguration</p>
|
|
19
|
+
</div></section>
|
|
20
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ProviderConfiguration</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#clientid">clientId</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#providertype">providerType</a><span class="tsd-signature-symbol">:</span> <a href="../enums/ProviderType.html" class="tsd-signature-type tsd-kind-enum">ProviderType</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
21
|
+
<ul>
|
|
22
|
+
<li>Defined in src/public/typings/providerConfiguration.ts:21</li></ul></aside>
|
|
23
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
24
|
+
<section class="tsd-panel tsd-index-panel">
|
|
25
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
26
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
27
|
+
<div class="tsd-accordion-details">
|
|
28
|
+
<section class="tsd-index-section">
|
|
29
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
30
|
+
<div class="tsd-index-list"><a href="#clientid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Id</span></a>
|
|
31
|
+
<a href="#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a>
|
|
32
|
+
<a href="#providertype" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>provider<wbr/>Type</span></a>
|
|
33
|
+
</div></section></div></details></section></section>
|
|
34
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
35
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
36
|
+
<section>
|
|
37
|
+
<section class="tsd-panel tsd-member">
|
|
38
|
+
<h3 class="tsd-anchor-link" id="clientid"><span>client<wbr/>Id</span><a href="#clientid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
39
|
+
<div class="tsd-signature"><span class="tsd-kind-property">clientId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
40
|
+
<div class="tsd-comment tsd-typography"><p>OAuth client id.</p>
|
|
41
|
+
</div><aside class="tsd-sources">
|
|
42
|
+
<ul>
|
|
43
|
+
<li>Defined in src/public/typings/providerConfiguration.ts:24</li></ul></aside></section>
|
|
44
|
+
<section class="tsd-panel tsd-member">
|
|
45
|
+
<h3 class="tsd-anchor-link" id="name"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
46
|
+
<div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
47
|
+
<div class="tsd-comment tsd-typography"><p>Human-readable provider name (e.g. 'google').</p>
|
|
48
|
+
</div><aside class="tsd-sources">
|
|
49
|
+
<ul>
|
|
50
|
+
<li>Defined in src/public/typings/providerConfiguration.ts:22</li></ul></aside></section>
|
|
51
|
+
<section class="tsd-panel tsd-member">
|
|
52
|
+
<h3 class="tsd-anchor-link" id="providertype"><span>provider<wbr/>Type</span><a href="#providertype" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
53
|
+
<div class="tsd-signature"><span class="tsd-kind-property">providerType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/ProviderType.html" class="tsd-signature-type tsd-kind-enum">ProviderType</a></div>
|
|
54
|
+
<div class="tsd-comment tsd-typography"><p>The kind of virtual presence this provider backs (e.g. EMAIL).</p>
|
|
55
|
+
</div><aside class="tsd-sources">
|
|
56
|
+
<ul>
|
|
57
|
+
<li>Defined in src/public/typings/providerConfiguration.ts:23</li></ul></aside></section></section></details></div>
|
|
58
|
+
<div class="col-sidebar">
|
|
59
|
+
<div class="page-menu">
|
|
60
|
+
<div class="tsd-navigation settings">
|
|
61
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
62
|
+
<h3>Settings</h3></summary>
|
|
63
|
+
<div class="tsd-accordion-details">
|
|
64
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
65
|
+
<ul id="tsd-filter-options">
|
|
66
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
67
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
68
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
69
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
70
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
71
|
+
<h3>On This Page</h3></summary>
|
|
72
|
+
<div class="tsd-accordion-details">
|
|
73
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
74
|
+
<div><a href="#clientid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>client<wbr/>Id</span></a><a href="#name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#providertype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>provider<wbr/>Type</span></a></div></details></div></details></div>
|
|
75
|
+
<div class="site-menu">
|
|
76
|
+
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
77
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
78
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
79
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
80
|
+
<div class="overlay"></div></body></html>
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RescanVirtualPresenceInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#options">options</a><span class="tsd-signature-symbol">?:</span> <a href="ScanOptions.html" class="tsd-signature-type tsd-kind-interface">ScanOptions</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
18
18
|
<ul>
|
|
19
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
19
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:74</li></ul></aside>
|
|
20
20
|
<section class="tsd-panel-group tsd-index-group">
|
|
21
21
|
<section class="tsd-panel tsd-index-panel">
|
|
22
22
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -36,14 +36,14 @@
|
|
|
36
36
|
<div class="tsd-comment tsd-typography"><p>The unique identifier of the virtual presence to rescan.</p>
|
|
37
37
|
</div><aside class="tsd-sources">
|
|
38
38
|
<ul>
|
|
39
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
39
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:75</li></ul></aside></section>
|
|
40
40
|
<section class="tsd-panel tsd-member">
|
|
41
41
|
<h3 class="tsd-anchor-link" id="options"><code class="tsd-tag">Optional</code><span>options</span><a href="#options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
42
42
|
<div class="tsd-signature"><span class="tsd-kind-property">options</span><span class="tsd-signature-symbol">?:</span> <a href="ScanOptions.html" class="tsd-signature-type tsd-kind-interface">ScanOptions</a></div>
|
|
43
43
|
<div class="tsd-comment tsd-typography"><p>Optional scan options to control the rescan behavior.</p>
|
|
44
44
|
</div><aside class="tsd-sources">
|
|
45
45
|
<ul>
|
|
46
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
46
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:76</li></ul></aside></section></section></details></div>
|
|
47
47
|
<div class="col-sidebar">
|
|
48
48
|
<div class="page-menu">
|
|
49
49
|
<div class="tsd-navigation settings">
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RetentionInfo</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#additionalinfo">additionalInfo</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#style">style</a><span class="tsd-signature-symbol">:</span> <a href="../enums/RetentionStyle.html" class="tsd-signature-type tsd-kind-enum">RetentionStyle</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#timeindays">timeInDays</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
18
18
|
<ul>
|
|
19
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
19
|
+
<li>Defined in src/public/typings/analysisResult.ts:235</li></ul></aside>
|
|
20
20
|
<section class="tsd-panel-group tsd-index-group">
|
|
21
21
|
<section class="tsd-panel tsd-index-panel">
|
|
22
22
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -37,21 +37,21 @@
|
|
|
37
37
|
<div class="tsd-comment tsd-typography"><p>Free-text clarification from the policy.</p>
|
|
38
38
|
</div><aside class="tsd-sources">
|
|
39
39
|
<ul>
|
|
40
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
40
|
+
<li>Defined in src/public/typings/analysisResult.ts:238</li></ul></aside></section>
|
|
41
41
|
<section class="tsd-panel tsd-member">
|
|
42
42
|
<h3 class="tsd-anchor-link" id="style"><span>style</span><a href="#style" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
43
43
|
<div class="tsd-signature"><span class="tsd-kind-property">style</span><span class="tsd-signature-symbol">:</span> <a href="../enums/RetentionStyle.html" class="tsd-signature-type tsd-kind-enum">RetentionStyle</a></div>
|
|
44
44
|
<div class="tsd-comment tsd-typography"><p>How the retention period is expressed.</p>
|
|
45
45
|
</div><aside class="tsd-sources">
|
|
46
46
|
<ul>
|
|
47
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
47
|
+
<li>Defined in src/public/typings/analysisResult.ts:236</li></ul></aside></section>
|
|
48
48
|
<section class="tsd-panel tsd-member">
|
|
49
49
|
<h3 class="tsd-anchor-link" id="timeindays"><code class="tsd-tag">Optional</code><span>time<wbr/>In<wbr/>Days</span><a href="#timeindays" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
50
50
|
<div class="tsd-signature"><span class="tsd-kind-property">timeInDays</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
51
51
|
<div class="tsd-comment tsd-typography"><p>Retention period in days, when specified.</p>
|
|
52
52
|
</div><aside class="tsd-sources">
|
|
53
53
|
<ul>
|
|
54
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
54
|
+
<li>Defined in src/public/typings/analysisResult.ts:237</li></ul></aside></section></section></details></div>
|
|
55
55
|
<div class="col-sidebar">
|
|
56
56
|
<div class="page-menu">
|
|
57
57
|
<div class="tsd-navigation settings">
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">RiskIndicators</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#breachrisk">breachRisk</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#collectssensitivedatafornonessentialpurposes">collectsSensitiveDataForNonEssentialPurposes</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#datacollectionbreadth">dataCollectionBreadth</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#encryptionpractices">encryptionPractices</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hasindefiniteretention">hasIndefiniteRetention</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#maxretentiondays">maxRetentionDays</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#sellspersonalinformation">sellsPersonalInformation</a><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
18
18
|
<ul>
|
|
19
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
19
|
+
<li>Defined in src/public/typings/analysisResult.ts:306</li></ul></aside>
|
|
20
20
|
<section class="tsd-panel-group tsd-index-group">
|
|
21
21
|
<section class="tsd-panel tsd-index-panel">
|
|
22
22
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -41,7 +41,7 @@
|
|
|
41
41
|
<div class="tsd-comment tsd-typography"><p>Whether there is an elevated risk of data breach.</p>
|
|
42
42
|
</div><aside class="tsd-sources">
|
|
43
43
|
<ul>
|
|
44
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
44
|
+
<li>Defined in src/public/typings/analysisResult.ts:313</li></ul></aside></section>
|
|
45
45
|
<section class="tsd-panel tsd-member">
|
|
46
46
|
<h3 class="tsd-anchor-link" id="collectssensitivedatafornonessentialpurposes"><span>collects<wbr/>Sensitive<wbr/>Data<wbr/>For<wbr/>Non<wbr/>Essential<wbr/>Purposes</span><a href="#collectssensitivedatafornonessentialpurposes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
47
47
|
<div class="tsd-signature"><span class="tsd-kind-property">collectsSensitiveDataForNonEssentialPurposes</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
@@ -49,42 +49,42 @@
|
|
|
49
49
|
are collected for non-essential purposes.</p>
|
|
50
50
|
</div><aside class="tsd-sources">
|
|
51
51
|
<ul>
|
|
52
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
52
|
+
<li>Defined in src/public/typings/analysisResult.ts:308</li></ul></aside></section>
|
|
53
53
|
<section class="tsd-panel tsd-member">
|
|
54
54
|
<h3 class="tsd-anchor-link" id="datacollectionbreadth"><span>data<wbr/>Collection<wbr/>Breadth</span><a href="#datacollectionbreadth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
55
55
|
<div class="tsd-signature"><span class="tsd-kind-property">dataCollectionBreadth</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
56
56
|
<div class="tsd-comment tsd-typography"><p>Total number of data categories collected.</p>
|
|
57
57
|
</div><aside class="tsd-sources">
|
|
58
58
|
<ul>
|
|
59
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
59
|
+
<li>Defined in src/public/typings/analysisResult.ts:307</li></ul></aside></section>
|
|
60
60
|
<section class="tsd-panel tsd-member">
|
|
61
61
|
<h3 class="tsd-anchor-link" id="encryptionpractices"><span>encryption<wbr/>Practices</span><a href="#encryptionpractices" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
62
62
|
<div class="tsd-signature"><span class="tsd-kind-property">encryptionPractices</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
63
63
|
<div class="tsd-comment tsd-typography"><p>Whether strong encryption practices are in place.</p>
|
|
64
64
|
</div><aside class="tsd-sources">
|
|
65
65
|
<ul>
|
|
66
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
66
|
+
<li>Defined in src/public/typings/analysisResult.ts:312</li></ul></aside></section>
|
|
67
67
|
<section class="tsd-panel tsd-member">
|
|
68
68
|
<h3 class="tsd-anchor-link" id="hasindefiniteretention"><span>has<wbr/>Indefinite<wbr/>Retention</span><a href="#hasindefiniteretention" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
69
69
|
<div class="tsd-signature"><span class="tsd-kind-property">hasIndefiniteRetention</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
70
70
|
<div class="tsd-comment tsd-typography"><p>Whether any category has indefinite retention.</p>
|
|
71
71
|
</div><aside class="tsd-sources">
|
|
72
72
|
<ul>
|
|
73
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
73
|
+
<li>Defined in src/public/typings/analysisResult.ts:311</li></ul></aside></section>
|
|
74
74
|
<section class="tsd-panel tsd-member">
|
|
75
75
|
<h3 class="tsd-anchor-link" id="maxretentiondays"><code class="tsd-tag">Optional</code><span>max<wbr/>Retention<wbr/>Days</span><a href="#maxretentiondays" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
76
76
|
<div class="tsd-signature"><span class="tsd-kind-property">maxRetentionDays</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
77
77
|
<div class="tsd-comment tsd-typography"><p>Longest known retention period in days across all categories.</p>
|
|
78
78
|
</div><aside class="tsd-sources">
|
|
79
79
|
<ul>
|
|
80
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
80
|
+
<li>Defined in src/public/typings/analysisResult.ts:310</li></ul></aside></section>
|
|
81
81
|
<section class="tsd-panel tsd-member">
|
|
82
82
|
<h3 class="tsd-anchor-link" id="sellspersonalinformation"><span>sells<wbr/>Personal<wbr/>Information</span><a href="#sellspersonalinformation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
83
83
|
<div class="tsd-signature"><span class="tsd-kind-property">sellsPersonalInformation</span><span class="tsd-signature-symbol">:</span> <a href="../enums/SignalValue.html" class="tsd-signature-type tsd-kind-enum">SignalValue</a></div>
|
|
84
84
|
<div class="tsd-comment tsd-typography"><p>Whether data selling is indicated.</p>
|
|
85
85
|
</div><aside class="tsd-sources">
|
|
86
86
|
<ul>
|
|
87
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
87
|
+
<li>Defined in src/public/typings/analysisResult.ts:309</li></ul></aside></section></section></details></div>
|
|
88
88
|
<div class="col-sidebar">
|
|
89
89
|
<div class="page-menu">
|
|
90
90
|
<div class="tsd-navigation settings">
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ScanOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#earliestscandate">earliestScanDate</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#excludecategories">excludeCategories</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#excludedomains">excludeDomains</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#latestscandate">latestScanDate</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#maximumitemsprocessed">maximumItemsProcessed</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
18
18
|
<ul>
|
|
19
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
19
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:89</li></ul></aside>
|
|
20
20
|
<section class="tsd-panel-group tsd-index-group">
|
|
21
21
|
<section class="tsd-panel tsd-index-panel">
|
|
22
22
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -39,35 +39,35 @@
|
|
|
39
39
|
<div class="tsd-comment tsd-typography"><p>Earliest date boundary for the scan (ISO 8601 string).</p>
|
|
40
40
|
</div><aside class="tsd-sources">
|
|
41
41
|
<ul>
|
|
42
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
42
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:91</li></ul></aside></section>
|
|
43
43
|
<section class="tsd-panel tsd-member">
|
|
44
44
|
<h3 class="tsd-anchor-link" id="excludecategories"><code class="tsd-tag">Optional</code><span>exclude<wbr/>Categories</span><a href="#excludecategories" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
45
45
|
<div class="tsd-signature"><span class="tsd-kind-property">excludeCategories</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
46
46
|
<div class="tsd-comment tsd-typography"><p>Categories to exclude from the scan.</p>
|
|
47
47
|
</div><aside class="tsd-sources">
|
|
48
48
|
<ul>
|
|
49
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
49
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:94</li></ul></aside></section>
|
|
50
50
|
<section class="tsd-panel tsd-member">
|
|
51
51
|
<h3 class="tsd-anchor-link" id="excludedomains"><code class="tsd-tag">Optional</code><span>exclude<wbr/>Domains</span><a href="#excludedomains" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
52
52
|
<div class="tsd-signature"><span class="tsd-kind-property">excludeDomains</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
53
53
|
<div class="tsd-comment tsd-typography"><p>Domains to exclude from the scan.</p>
|
|
54
54
|
</div><aside class="tsd-sources">
|
|
55
55
|
<ul>
|
|
56
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
56
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:93</li></ul></aside></section>
|
|
57
57
|
<section class="tsd-panel tsd-member">
|
|
58
58
|
<h3 class="tsd-anchor-link" id="latestscandate"><code class="tsd-tag">Optional</code><span>latest<wbr/>Scan<wbr/>Date</span><a href="#latestscandate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
59
59
|
<div class="tsd-signature"><span class="tsd-kind-property">latestScanDate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
60
60
|
<div class="tsd-comment tsd-typography"><p>Latest date boundary for the scan (ISO 8601 string).</p>
|
|
61
61
|
</div><aside class="tsd-sources">
|
|
62
62
|
<ul>
|
|
63
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
63
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:92</li></ul></aside></section>
|
|
64
64
|
<section class="tsd-panel tsd-member">
|
|
65
65
|
<h3 class="tsd-anchor-link" id="maximumitemsprocessed"><code class="tsd-tag">Optional</code><span>maximum<wbr/>Items<wbr/>Processed</span><a href="#maximumitemsprocessed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
66
66
|
<div class="tsd-signature"><span class="tsd-kind-property">maximumItemsProcessed</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
67
67
|
<div class="tsd-comment tsd-typography"><p>Maximum number of items to process during the scan.</p>
|
|
68
68
|
</div><aside class="tsd-sources">
|
|
69
69
|
<ul>
|
|
70
|
-
<li>Defined in src/public/inputs/virtualPresence.ts:
|
|
70
|
+
<li>Defined in src/public/inputs/virtualPresence.ts:90</li></ul></aside></section></section></details></div>
|
|
71
71
|
<div class="col-sidebar">
|
|
72
72
|
<div class="page-menu">
|
|
73
73
|
<div class="tsd-navigation settings">
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
</div></section>
|
|
17
17
|
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ScoreContribution</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#aspect">aspect</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#contribution">contribution</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
18
18
|
<ul>
|
|
19
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
19
|
+
<li>Defined in src/public/typings/analysisResult.ts:137</li></ul></aside>
|
|
20
20
|
<section class="tsd-panel-group tsd-index-group">
|
|
21
21
|
<section class="tsd-panel tsd-index-panel">
|
|
22
22
|
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
@@ -36,14 +36,14 @@
|
|
|
36
36
|
<div class="tsd-comment tsd-typography"><p>Identifier for the scoring aspect (e.g. 'dataCollection', 'dataSharing').</p>
|
|
37
37
|
</div><aside class="tsd-sources">
|
|
38
38
|
<ul>
|
|
39
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
39
|
+
<li>Defined in src/public/typings/analysisResult.ts:138</li></ul></aside></section>
|
|
40
40
|
<section class="tsd-panel tsd-member">
|
|
41
41
|
<h3 class="tsd-anchor-link" id="contribution"><span>contribution</span><a href="#contribution" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
42
42
|
<div class="tsd-signature"><span class="tsd-kind-property">contribution</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
43
43
|
<div class="tsd-comment tsd-typography"><p>Numeric contribution to the score (negative = penalty, positive = bonus).</p>
|
|
44
44
|
</div><aside class="tsd-sources">
|
|
45
45
|
<ul>
|
|
46
|
-
<li>Defined in src/public/typings/analysisResult.ts:
|
|
46
|
+
<li>Defined in src/public/typings/analysisResult.ts:139</li></ul></aside></section></section></details></div>
|
|
47
47
|
<div class="col-sidebar">
|
|
48
48
|
<div class="page-menu">
|
|
49
49
|
<div class="tsd-navigation settings">
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ScoreCoverage | @sudoplatform/sudo-privacy-interaction</title><meta name="description" content="Documentation for @sudoplatform/sudo-privacy-interaction"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@sudoplatform/sudo-privacy-interaction</a>
|
|
3
|
+
<div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">ScoreCoverage</a></li></ul>
|
|
12
|
+
<h1>Interface ScoreCoverage</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>How much of the scoring-relevant input had a known value. A low ratio means the
|
|
15
|
+
score rests on few known signals and should be treated as lower-confidence.</p>
|
|
16
|
+
<p>ScoreCoverage</p>
|
|
17
|
+
</div></section>
|
|
18
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ScoreCoverage</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#evaluated">evaluated</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#total">total</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
|
|
19
|
+
<ul>
|
|
20
|
+
<li>Defined in src/public/typings/analysisResult.ts:125</li></ul></aside>
|
|
21
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
22
|
+
<section class="tsd-panel tsd-index-panel">
|
|
23
|
+
<details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
24
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
25
|
+
<div class="tsd-accordion-details">
|
|
26
|
+
<section class="tsd-index-section">
|
|
27
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
28
|
+
<div class="tsd-index-list"><a href="#evaluated" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>evaluated</span></a>
|
|
29
|
+
<a href="#total" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total</span></a>
|
|
30
|
+
</div></section></div></details></section></section>
|
|
31
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
32
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
|
|
33
|
+
<section>
|
|
34
|
+
<section class="tsd-panel tsd-member">
|
|
35
|
+
<h3 class="tsd-anchor-link" id="evaluated"><span>evaluated</span><a href="#evaluated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
36
|
+
<div class="tsd-signature"><span class="tsd-kind-property">evaluated</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
37
|
+
<div class="tsd-comment tsd-typography"><p>Scoring aspects with a known value.</p>
|
|
38
|
+
</div><aside class="tsd-sources">
|
|
39
|
+
<ul>
|
|
40
|
+
<li>Defined in src/public/typings/analysisResult.ts:126</li></ul></aside></section>
|
|
41
|
+
<section class="tsd-panel tsd-member">
|
|
42
|
+
<h3 class="tsd-anchor-link" id="total"><span>total</span><a href="#total" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
|
|
43
|
+
<div class="tsd-signature"><span class="tsd-kind-property">total</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
44
|
+
<div class="tsd-comment tsd-typography"><p>Total scoring aspects the calculator considers.</p>
|
|
45
|
+
</div><aside class="tsd-sources">
|
|
46
|
+
<ul>
|
|
47
|
+
<li>Defined in src/public/typings/analysisResult.ts:127</li></ul></aside></section></section></details></div>
|
|
48
|
+
<div class="col-sidebar">
|
|
49
|
+
<div class="page-menu">
|
|
50
|
+
<div class="tsd-navigation settings">
|
|
51
|
+
<details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
52
|
+
<h3>Settings</h3></summary>
|
|
53
|
+
<div class="tsd-accordion-details">
|
|
54
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
55
|
+
<ul id="tsd-filter-options">
|
|
56
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
57
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
58
|
+
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div>
|
|
59
|
+
<div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
60
|
+
<details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
61
|
+
<h3>On This Page</h3></summary>
|
|
62
|
+
<div class="tsd-accordion-details">
|
|
63
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
|
|
64
|
+
<div><a href="#evaluated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>evaluated</span></a><a href="#total"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>total</span></a></div></details></div></details></div>
|
|
65
|
+
<div class="site-menu">
|
|
66
|
+
<nav class="tsd-navigation"><a href="../modules.html">@sudoplatform/sudo-privacy-interaction</a>
|
|
67
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
68
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
69
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
70
|
+
<div class="overlay"></div></body></html>
|