@sudoplatform/sudo-common 6.1.0 → 6.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitignore +1 -0
- package/dependencies-report.json +117 -7
- package/docs/assets/highlight.css +1 -1
- package/docs/assets/main.js +2 -2
- package/docs/assets/search.js +1 -1
- package/docs/assets/style.css +29 -0
- package/docs/classes/AccountLockedError.html +3 -3
- package/docs/classes/AuthenticationError.html +3 -3
- package/docs/classes/Base64.html +2 -2
- package/docs/classes/Buffer.html +2 -2
- package/docs/classes/ConfigurationNotSetError.html +3 -3
- package/docs/classes/ConfigurationSetNotFoundError.html +3 -3
- package/docs/classes/DecodeError.html +3 -3
- package/docs/classes/DefaultConfigurationManager.html +13 -6
- package/docs/classes/DefaultLogger.html +7 -7
- package/docs/classes/DefaultSudoKeyArchive.html +13 -13
- package/docs/classes/DefaultSudoKeyManager.html +28 -28
- package/docs/classes/FatalError.html +3 -3
- package/docs/classes/IllegalArgumentError.html +3 -3
- package/docs/classes/IllegalStateError.html +3 -3
- package/docs/classes/InsufficientEntitlementsError.html +3 -3
- package/docs/classes/InvalidOwnershipProofError.html +3 -3
- package/docs/classes/InvalidTokenError.html +3 -3
- package/docs/classes/KeyArchiveDecodingError.html +3 -3
- package/docs/classes/KeyArchiveIncorrectPasswordError.html +3 -3
- package/docs/classes/KeyArchiveMissingError.html +3 -3
- package/docs/classes/KeyArchiveNoPasswordRequiredError.html +3 -3
- package/docs/classes/KeyArchivePasswordRequiredError.html +3 -3
- package/docs/classes/KeyArchiveTypeError.html +3 -3
- package/docs/classes/KeyArchiveUnknownKeyTypeError.html +3 -3
- package/docs/classes/KeyArchiveVersionError.html +3 -3
- package/docs/classes/KeyNotFoundError.html +3 -3
- package/docs/classes/KeyStoreNotExportableError.html +3 -3
- package/docs/classes/LimitExceededError.html +3 -3
- package/docs/classes/NoEntitlementsError.html +3 -3
- package/docs/classes/NotAuthorizedError.html +3 -3
- package/docs/classes/NotRegisteredError.html +3 -3
- package/docs/classes/NotSignedInError.html +3 -3
- package/docs/classes/OperationNotImplementedError.html +3 -3
- package/docs/classes/RegisterError.html +3 -3
- package/docs/classes/RequestFailedError.html +5 -5
- package/docs/classes/ServiceError.html +3 -3
- package/docs/classes/SignOutError.html +3 -3
- package/docs/classes/SudoCryptoProviderDefaults.html +1 -1
- package/docs/classes/UnknownGraphQLError.html +3 -3
- package/docs/classes/UnrecognizedAlgorithmError.html +3 -3
- package/docs/classes/UserNotConfirmedError.html +3 -3
- package/docs/classes/VersionMismatchError.html +3 -3
- package/docs/enums/CachePolicy.html +2 -2
- package/docs/enums/EncryptionAlgorithm.html +2 -2
- package/docs/enums/KeyArchiveKeyType.html +2 -2
- package/docs/enums/KeyDataKeyFormat.html +3 -3
- package/docs/enums/KeyDataKeyType.html +2 -2
- package/docs/enums/ListOperationResultStatus.html +4 -4
- package/docs/enums/PublicKeyFormat.html +1 -1
- package/docs/index.html +2 -2
- package/docs/interfaces/AsymmetricEncryptionOptions.html +2 -2
- package/docs/interfaces/BooleanFilter.html +2 -2
- package/docs/interfaces/ConfigurationManager.html +13 -6
- package/docs/interfaces/KeyData.html +2 -2
- package/docs/interfaces/ListOperationFailureResult.html +2 -2
- package/docs/interfaces/ListOperationPartialResult.html +4 -4
- package/docs/interfaces/ListOperationSuccessResult.html +3 -3
- package/docs/interfaces/ListOutput.html +2 -2
- package/docs/interfaces/Logger.html +7 -7
- package/docs/interfaces/Owner.html +1 -1
- package/docs/interfaces/PublicKey.html +1 -1
- package/docs/interfaces/ServiceCompatibilityInfo.html +17 -0
- package/docs/interfaces/StringFilter.html +2 -2
- package/docs/interfaces/SudoCryptoProvider.html +28 -28
- package/docs/interfaces/SudoKeyArchive.html +10 -10
- package/docs/interfaces/SudoKeyManager.html +28 -28
- package/docs/interfaces/SymmetricEncryptionOptions.html +2 -2
- package/docs/interfaces/ValidationResult.html +11 -0
- package/docs/modules.html +5 -5
- package/github/.gitignore +1 -0
- package/github/docs/assets/highlight.css +1 -1
- package/github/docs/assets/main.js +2 -2
- package/github/docs/assets/search.js +1 -1
- package/github/docs/assets/style.css +29 -0
- package/github/docs/classes/AccountLockedError.html +3 -3
- package/github/docs/classes/AuthenticationError.html +3 -3
- package/github/docs/classes/Base64.html +2 -2
- package/github/docs/classes/Buffer.html +2 -2
- package/github/docs/classes/ConfigurationNotSetError.html +3 -3
- package/github/docs/classes/ConfigurationSetNotFoundError.html +3 -3
- package/github/docs/classes/DecodeError.html +3 -3
- package/github/docs/classes/DefaultConfigurationManager.html +13 -6
- package/github/docs/classes/DefaultLogger.html +7 -7
- package/github/docs/classes/DefaultSudoKeyArchive.html +13 -13
- package/github/docs/classes/DefaultSudoKeyManager.html +28 -28
- package/github/docs/classes/FatalError.html +3 -3
- package/github/docs/classes/IllegalArgumentError.html +3 -3
- package/github/docs/classes/IllegalStateError.html +3 -3
- package/github/docs/classes/InsufficientEntitlementsError.html +3 -3
- package/github/docs/classes/InvalidOwnershipProofError.html +3 -3
- package/github/docs/classes/InvalidTokenError.html +3 -3
- package/github/docs/classes/KeyArchiveDecodingError.html +3 -3
- package/github/docs/classes/KeyArchiveIncorrectPasswordError.html +3 -3
- package/github/docs/classes/KeyArchiveMissingError.html +3 -3
- package/github/docs/classes/KeyArchiveNoPasswordRequiredError.html +3 -3
- package/github/docs/classes/KeyArchivePasswordRequiredError.html +3 -3
- package/github/docs/classes/KeyArchiveTypeError.html +3 -3
- package/github/docs/classes/KeyArchiveUnknownKeyTypeError.html +3 -3
- package/github/docs/classes/KeyArchiveVersionError.html +3 -3
- package/github/docs/classes/KeyNotFoundError.html +3 -3
- package/github/docs/classes/KeyStoreNotExportableError.html +3 -3
- package/github/docs/classes/LimitExceededError.html +3 -3
- package/github/docs/classes/NoEntitlementsError.html +3 -3
- package/github/docs/classes/NotAuthorizedError.html +3 -3
- package/github/docs/classes/NotRegisteredError.html +3 -3
- package/github/docs/classes/NotSignedInError.html +3 -3
- package/github/docs/classes/OperationNotImplementedError.html +3 -3
- package/github/docs/classes/RegisterError.html +3 -3
- package/github/docs/classes/RequestFailedError.html +5 -5
- package/github/docs/classes/ServiceError.html +3 -3
- package/github/docs/classes/SignOutError.html +3 -3
- package/github/docs/classes/SudoCryptoProviderDefaults.html +1 -1
- package/github/docs/classes/UnknownGraphQLError.html +3 -3
- package/github/docs/classes/UnrecognizedAlgorithmError.html +3 -3
- package/github/docs/classes/UserNotConfirmedError.html +3 -3
- package/github/docs/classes/VersionMismatchError.html +3 -3
- package/github/docs/enums/CachePolicy.html +2 -2
- package/github/docs/enums/EncryptionAlgorithm.html +2 -2
- package/github/docs/enums/KeyArchiveKeyType.html +2 -2
- package/github/docs/enums/KeyDataKeyFormat.html +3 -3
- package/github/docs/enums/KeyDataKeyType.html +2 -2
- package/github/docs/enums/ListOperationResultStatus.html +4 -4
- package/github/docs/enums/PublicKeyFormat.html +1 -1
- package/github/docs/index.html +2 -2
- package/github/docs/interfaces/AsymmetricEncryptionOptions.html +2 -2
- package/github/docs/interfaces/BooleanFilter.html +2 -2
- package/github/docs/interfaces/ConfigurationManager.html +13 -6
- package/github/docs/interfaces/KeyData.html +2 -2
- package/github/docs/interfaces/ListOperationFailureResult.html +2 -2
- package/github/docs/interfaces/ListOperationPartialResult.html +4 -4
- package/github/docs/interfaces/ListOperationSuccessResult.html +3 -3
- package/github/docs/interfaces/ListOutput.html +2 -2
- package/github/docs/interfaces/Logger.html +7 -7
- package/github/docs/interfaces/Owner.html +1 -1
- package/github/docs/interfaces/PublicKey.html +1 -1
- package/github/docs/interfaces/ServiceCompatibilityInfo.html +17 -0
- package/github/docs/interfaces/StringFilter.html +2 -2
- package/github/docs/interfaces/SudoCryptoProvider.html +28 -28
- package/github/docs/interfaces/SudoKeyArchive.html +10 -10
- package/github/docs/interfaces/SudoKeyManager.html +28 -28
- package/github/docs/interfaces/SymmetricEncryptionOptions.html +2 -2
- package/github/docs/interfaces/ValidationResult.html +11 -0
- package/github/docs/modules.html +5 -5
- package/github/package.json +27 -23
- package/github/src/configurationManager/defaultConfigurationManager.ts +156 -7
- package/github/test/integration/defaultConfigurationManager.spec.ts +85 -0
- package/github/test/unit/configurationManager/defaultConfigurationManager.spec.ts +506 -0
- package/{test → github/test/unit}/errors/error.spec.ts +1 -1
- package/github/test/{sudoKeyArchive → unit}/keyType.spec.ts +0 -0
- package/{test → github/test/unit}/logging/logger.spec.ts +1 -1
- package/github/test/{sudoKeyArchive → unit}/sudoKeyArchive.spec.ts +0 -0
- package/github/test/{sudoKeyManager → unit}/sudoKeyManager.spec.ts +0 -0
- package/github/test/{utils → unit/utils}/base64.spec.ts +1 -1
- package/github/test/{utils → unit/utils}/buffer.spec.ts +1 -1
- package/{test → github/test/unit}/utils/listOperationResult.spec.ts +1 -1
- package/github/tsconfig.test.json +3 -1
- package/github/yarn.lock +1628 -1299
- package/lib/configurationManager/defaultConfigurationManager.d.ts +57 -0
- package/lib/configurationManager/defaultConfigurationManager.js +102 -7
- package/package.json +27 -23
- package/src/configurationManager/defaultConfigurationManager.ts +156 -7
- package/test/integration/defaultConfigurationManager.spec.ts +85 -0
- package/test/unit/configurationManager/defaultConfigurationManager.spec.ts +506 -0
- package/{github/test → test/unit}/errors/error.spec.ts +1 -1
- package/test/{sudoKeyArchive → unit}/keyType.spec.ts +0 -0
- package/{github/test → test/unit}/logging/logger.spec.ts +1 -1
- package/test/{sudoKeyArchive → unit}/sudoKeyArchive.spec.ts +0 -0
- package/test/{sudoKeyManager → unit}/sudoKeyManager.spec.ts +0 -0
- package/test/{utils → unit/utils}/base64.spec.ts +1 -1
- package/test/{utils → unit/utils}/buffer.spec.ts +1 -1
- package/{github/test → test/unit}/utils/listOperationResult.spec.ts +1 -1
- package/tsconfig.test.json +3 -1
- package/yarn.lock +1628 -1299
- package/github/test/configurationManager/defaultConfigurationManager.spec.ts +0 -185
- package/test/configurationManager/defaultConfigurationManager.spec.ts +0 -185
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default
|
|
1
|
+
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SudoKeyArchive | @sudoplatform/sudo-common</title><meta name="description" content="Documentation for @sudoplatform/sudo-common"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@sudoplatform/sudo-common</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@sudoplatform/sudo-common</a></li><li><a href="SudoKeyArchive.html">SudoKeyArchive</a></li></ul><h1>Interface SudoKeyArchive</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SudoKeyArchive</span></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="../classes/DefaultSudoKeyArchive.html" class="tsd-signature-type" data-tsd-kind="Class">DefaultSudoKeyArchive</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#archive" class="tsd-kind-icon">archive</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#containsKey" class="tsd-kind-icon">contains<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#getExcludedKeyTypes" class="tsd-kind-icon">get<wbr/>Excluded<wbr/>Key<wbr/>Types</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#getExcludedKeys" class="tsd-kind-icon">get<wbr/>Excluded<wbr/>Keys</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#getKeyData" class="tsd-kind-icon">get<wbr/>Key<wbr/>Data</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#getMetaInfo" class="tsd-kind-icon">get<wbr/>Meta<wbr/>Info</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#loadKeys" class="tsd-kind-icon">load<wbr/>Keys</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#reset" class="tsd-kind-icon">reset</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#saveKeys" class="tsd-kind-icon">save<wbr/>Keys</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#unarchive" class="tsd-kind-icon">unarchive</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="archive" class="tsd-anchor"></a><h3 class="tsd-anchor-link">archive<a href="#archive" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">archive<span class="tsd-signature-symbol">(</span>password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:55</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
2
|
<p>Archives and encrypts the keys loaded into this archive.</p>
|
|
3
3
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>password: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
4
4
|
<p> The password to use to encrypt the archive. Or undefined if no password.
|
|
5
5
|
Choice to have no password must be explicit.</p>
|
|
6
6
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">></span></h4><div><p>Binary archive data.</p>
|
|
7
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="containsKey" class="tsd-anchor"></a><h3>contains<wbr/>Key
|
|
7
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="containsKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link">contains<wbr/>Key<a href="#containsKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">contains<wbr/>Key<span class="tsd-signature-symbol">(</span>namespace<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><a href="../enums/KeyArchiveKeyType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">KeyArchiveKeyType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:96</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
8
8
|
<p>Determines whether or not the archive contains the key with the
|
|
9
9
|
specified name and type. The archive must be unarchived before the
|
|
10
10
|
key can be searched.</p>
|
|
@@ -15,9 +15,9 @@ key can be searched.</p>
|
|
|
15
15
|
</div></div></li><li><h5>type: <a href="../enums/KeyArchiveKeyType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">KeyArchiveKeyType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
16
16
|
<p>the key type.</p>
|
|
17
17
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>true if the specified key exists in the archive.</p>
|
|
18
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getExcludedKeyTypes" class="tsd-anchor"></a><h3>get<wbr/>Excluded<wbr/>Key<wbr/>Types
|
|
19
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getExcludedKeys" class="tsd-anchor"></a><h3>get<wbr/>Excluded<wbr/>Keys
|
|
20
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getKeyData" class="tsd-anchor"></a><h3>get<wbr/>Key<wbr/>Data
|
|
18
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getExcludedKeyTypes" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Excluded<wbr/>Key<wbr/>Types<a href="#getExcludedKeyTypes" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Excluded<wbr/>Key<wbr/>Types<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReadonlySet</span><span class="tsd-signature-symbol"><</span><a href="../enums/KeyArchiveKeyType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">KeyArchiveKeyType</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:118</li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReadonlySet</span><span class="tsd-signature-symbol"><</span><a href="../enums/KeyArchiveKeyType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">KeyArchiveKeyType</a><span class="tsd-signature-symbol">></span></h4><div><p>the key types to exclude from the archive in an unmodifiable set.</p>
|
|
19
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getExcludedKeys" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Excluded<wbr/>Keys<a href="#getExcludedKeys" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Excluded<wbr/>Keys<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReadonlySet</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:121</li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReadonlySet</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><div><p>the key names to exclude from the archive in an unmodifiable set.</p>
|
|
20
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getKeyData" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Key<wbr/>Data<a href="#getKeyData" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Key<wbr/>Data<span class="tsd-signature-symbol">(</span>namespace<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><a href="../enums/KeyArchiveKeyType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">KeyArchiveKeyType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:111</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
21
21
|
<p>Retrieves the specified key data from the archive. The archive must
|
|
22
22
|
be unarchived before the key data can be retrieved.</p>
|
|
23
23
|
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><a href="../classes/KeyNotFoundError.html">KeyNotFoundError</a>
|
|
@@ -29,14 +29,14 @@ be unarchived before the key data can be retrieved.</p>
|
|
|
29
29
|
</div></div></li><li><h5>type: <a href="../enums/KeyArchiveKeyType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">KeyArchiveKeyType</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
30
30
|
<p>the key type</p>
|
|
31
31
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ArrayBuffer</span></h4><div><p>a byte array containing the specified key data or null if it was not found.</p>
|
|
32
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getMetaInfo" class="tsd-anchor"></a><h3>get<wbr/>Meta<wbr/>Info
|
|
33
|
-
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="loadKeys" class="tsd-anchor"></a><h3>load<wbr/>Keys
|
|
32
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getMetaInfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Meta<wbr/>Info<a href="#getMetaInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Meta<wbr/>Info<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReadonlyMap</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:124</li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReadonlyMap</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><div><p>the meta-information associated with this archive in an unmodifiable map.</p>
|
|
33
|
+
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="loadKeys" class="tsd-anchor"></a><h3 class="tsd-anchor-link">load<wbr/>Keys<a href="#loadKeys" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">load<wbr/>Keys<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:39</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
34
34
|
<p>Loads keys from the secure store into the archive.</p>
|
|
35
|
-
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="reset" class="tsd-anchor"></a><h3>reset
|
|
35
|
+
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="reset" class="tsd-anchor"></a><h3 class="tsd-anchor-link">reset<a href="#reset" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">reset<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:83</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
36
36
|
<p>Resets the archive by clearing loaded keys and archive data.</p>
|
|
37
|
-
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="saveKeys" class="tsd-anchor"></a><h3>save<wbr/>Keys
|
|
37
|
+
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="saveKeys" class="tsd-anchor"></a><h3 class="tsd-anchor-link">save<wbr/>Keys<a href="#saveKeys" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">save<wbr/>Keys<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:44</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
38
38
|
<p>Saves the keys in this archive to the secure store.</p>
|
|
39
|
-
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="unarchive" class="tsd-anchor"></a><h3>unarchive
|
|
39
|
+
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="unarchive" class="tsd-anchor"></a><h3 class="tsd-anchor-link">unarchive<a href="#unarchive" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">unarchive<span class="tsd-signature-symbol">(</span>password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:78</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
40
40
|
<p>Decrypts and unarchives the keys in this archive.</p>
|
|
41
41
|
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><a href="../classes/KeyArchiveDecodingError.html">KeyArchiveDecodingError</a>
|
|
42
42
|
If the archive is unable to be decoding according to the
|