@sudoplatform/sudo-common 6.2.0 → 6.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (168) hide show
  1. package/.yarn/releases/yarn-1.22.18.cjs +147520 -0
  2. package/.yarnrc +5 -0
  3. package/dependencies-report.json +1 -1
  4. package/docs/assets/main.js +2 -2
  5. package/docs/assets/search.js +1 -1
  6. package/docs/assets/style.css +3 -2
  7. package/docs/classes/AccountLockedError.html +1 -1
  8. package/docs/classes/AuthenticationError.html +1 -1
  9. package/docs/classes/Base64.html +1 -1
  10. package/docs/classes/Buffer.html +1 -1
  11. package/docs/classes/ConfigurationNotSetError.html +1 -1
  12. package/docs/classes/ConfigurationSetNotFoundError.html +1 -1
  13. package/docs/classes/DecodeError.html +1 -1
  14. package/docs/classes/DefaultConfigurationManager.html +1 -1
  15. package/docs/classes/DefaultLogger.html +1 -1
  16. package/docs/classes/DefaultSudoKeyArchive.html +1 -1
  17. package/docs/classes/DefaultSudoKeyManager.html +12 -12
  18. package/docs/classes/FatalError.html +1 -1
  19. package/docs/classes/IllegalArgumentError.html +1 -1
  20. package/docs/classes/IllegalStateError.html +1 -1
  21. package/docs/classes/InsufficientEntitlementsError.html +1 -1
  22. package/docs/classes/InvalidOwnershipProofError.html +1 -1
  23. package/docs/classes/InvalidTokenError.html +1 -1
  24. package/docs/classes/KeyArchiveDecodingError.html +1 -1
  25. package/docs/classes/KeyArchiveIncorrectPasswordError.html +1 -1
  26. package/docs/classes/KeyArchiveMissingError.html +1 -1
  27. package/docs/classes/KeyArchiveNoPasswordRequiredError.html +1 -1
  28. package/docs/classes/KeyArchivePasswordRequiredError.html +1 -1
  29. package/docs/classes/KeyArchiveTypeError.html +1 -1
  30. package/docs/classes/KeyArchiveUnknownKeyTypeError.html +1 -1
  31. package/docs/classes/KeyArchiveVersionError.html +1 -1
  32. package/docs/classes/KeyNotFoundError.html +1 -1
  33. package/docs/classes/KeyStoreNotExportableError.html +1 -1
  34. package/docs/classes/LimitExceededError.html +1 -1
  35. package/docs/classes/NoEntitlementsError.html +1 -1
  36. package/docs/classes/NotAuthorizedError.html +1 -1
  37. package/docs/classes/NotRegisteredError.html +1 -1
  38. package/docs/classes/NotSignedInError.html +1 -1
  39. package/docs/classes/OperationNotImplementedError.html +1 -1
  40. package/docs/classes/RegisterError.html +1 -1
  41. package/docs/classes/RequestFailedError.html +1 -1
  42. package/docs/classes/ServiceError.html +1 -1
  43. package/docs/classes/SignOutError.html +1 -1
  44. package/docs/classes/SudoCryptoProviderDefaults.html +1 -1
  45. package/docs/classes/UnknownGraphQLError.html +1 -1
  46. package/docs/classes/UnrecognizedAlgorithmError.html +1 -1
  47. package/docs/classes/UserNotConfirmedError.html +1 -1
  48. package/docs/classes/VersionMismatchError.html +1 -1
  49. package/docs/enums/CachePolicy.html +1 -1
  50. package/docs/enums/EncryptionAlgorithm.html +2 -2
  51. package/docs/enums/KeyArchiveKeyType.html +1 -1
  52. package/docs/enums/KeyDataKeyFormat.html +1 -1
  53. package/docs/enums/KeyDataKeyType.html +1 -1
  54. package/docs/enums/ListOperationResultStatus.html +4 -4
  55. package/docs/enums/PublicKeyFormat.html +1 -1
  56. package/docs/index.html +1 -1
  57. package/docs/interfaces/AsymmetricEncryptionOptions.html +1 -1
  58. package/docs/interfaces/BooleanFilter.html +1 -1
  59. package/docs/interfaces/ConfigurationManager.html +1 -1
  60. package/docs/interfaces/KeyData.html +1 -1
  61. package/docs/interfaces/ListOperationFailureResult.html +2 -2
  62. package/docs/interfaces/ListOperationPartialResult.html +4 -4
  63. package/docs/interfaces/ListOperationSuccessResult.html +3 -3
  64. package/docs/interfaces/ListOutput.html +1 -1
  65. package/docs/interfaces/Logger.html +1 -1
  66. package/docs/interfaces/Owner.html +1 -1
  67. package/docs/interfaces/PublicKey.html +1 -1
  68. package/docs/interfaces/ServiceCompatibilityInfo.html +1 -1
  69. package/docs/interfaces/StringFilter.html +1 -1
  70. package/docs/interfaces/SudoCryptoProvider.html +1 -1
  71. package/docs/interfaces/SudoKeyArchive.html +1 -1
  72. package/docs/interfaces/SudoKeyManager.html +1 -1
  73. package/docs/interfaces/SymmetricEncryptionOptions.html +1 -1
  74. package/docs/interfaces/ValidationResult.html +1 -1
  75. package/docs/modules.html +5 -5
  76. package/github/.yarn/releases/yarn-1.22.18.cjs +147520 -0
  77. package/github/.yarnrc +5 -0
  78. package/github/docs/assets/main.js +2 -2
  79. package/github/docs/assets/search.js +1 -1
  80. package/github/docs/assets/style.css +3 -2
  81. package/github/docs/classes/AccountLockedError.html +1 -1
  82. package/github/docs/classes/AuthenticationError.html +1 -1
  83. package/github/docs/classes/Base64.html +1 -1
  84. package/github/docs/classes/Buffer.html +1 -1
  85. package/github/docs/classes/ConfigurationNotSetError.html +1 -1
  86. package/github/docs/classes/ConfigurationSetNotFoundError.html +1 -1
  87. package/github/docs/classes/DecodeError.html +1 -1
  88. package/github/docs/classes/DefaultConfigurationManager.html +1 -1
  89. package/github/docs/classes/DefaultLogger.html +1 -1
  90. package/github/docs/classes/DefaultSudoKeyArchive.html +1 -1
  91. package/github/docs/classes/DefaultSudoKeyManager.html +12 -12
  92. package/github/docs/classes/FatalError.html +1 -1
  93. package/github/docs/classes/IllegalArgumentError.html +1 -1
  94. package/github/docs/classes/IllegalStateError.html +1 -1
  95. package/github/docs/classes/InsufficientEntitlementsError.html +1 -1
  96. package/github/docs/classes/InvalidOwnershipProofError.html +1 -1
  97. package/github/docs/classes/InvalidTokenError.html +1 -1
  98. package/github/docs/classes/KeyArchiveDecodingError.html +1 -1
  99. package/github/docs/classes/KeyArchiveIncorrectPasswordError.html +1 -1
  100. package/github/docs/classes/KeyArchiveMissingError.html +1 -1
  101. package/github/docs/classes/KeyArchiveNoPasswordRequiredError.html +1 -1
  102. package/github/docs/classes/KeyArchivePasswordRequiredError.html +1 -1
  103. package/github/docs/classes/KeyArchiveTypeError.html +1 -1
  104. package/github/docs/classes/KeyArchiveUnknownKeyTypeError.html +1 -1
  105. package/github/docs/classes/KeyArchiveVersionError.html +1 -1
  106. package/github/docs/classes/KeyNotFoundError.html +1 -1
  107. package/github/docs/classes/KeyStoreNotExportableError.html +1 -1
  108. package/github/docs/classes/LimitExceededError.html +1 -1
  109. package/github/docs/classes/NoEntitlementsError.html +1 -1
  110. package/github/docs/classes/NotAuthorizedError.html +1 -1
  111. package/github/docs/classes/NotRegisteredError.html +1 -1
  112. package/github/docs/classes/NotSignedInError.html +1 -1
  113. package/github/docs/classes/OperationNotImplementedError.html +1 -1
  114. package/github/docs/classes/RegisterError.html +1 -1
  115. package/github/docs/classes/RequestFailedError.html +1 -1
  116. package/github/docs/classes/ServiceError.html +1 -1
  117. package/github/docs/classes/SignOutError.html +1 -1
  118. package/github/docs/classes/SudoCryptoProviderDefaults.html +1 -1
  119. package/github/docs/classes/UnknownGraphQLError.html +1 -1
  120. package/github/docs/classes/UnrecognizedAlgorithmError.html +1 -1
  121. package/github/docs/classes/UserNotConfirmedError.html +1 -1
  122. package/github/docs/classes/VersionMismatchError.html +1 -1
  123. package/github/docs/enums/CachePolicy.html +1 -1
  124. package/github/docs/enums/EncryptionAlgorithm.html +2 -2
  125. package/github/docs/enums/KeyArchiveKeyType.html +1 -1
  126. package/github/docs/enums/KeyDataKeyFormat.html +1 -1
  127. package/github/docs/enums/KeyDataKeyType.html +1 -1
  128. package/github/docs/enums/ListOperationResultStatus.html +4 -4
  129. package/github/docs/enums/PublicKeyFormat.html +1 -1
  130. package/github/docs/index.html +1 -1
  131. package/github/docs/interfaces/AsymmetricEncryptionOptions.html +1 -1
  132. package/github/docs/interfaces/BooleanFilter.html +1 -1
  133. package/github/docs/interfaces/ConfigurationManager.html +1 -1
  134. package/github/docs/interfaces/KeyData.html +1 -1
  135. package/github/docs/interfaces/ListOperationFailureResult.html +2 -2
  136. package/github/docs/interfaces/ListOperationPartialResult.html +4 -4
  137. package/github/docs/interfaces/ListOperationSuccessResult.html +3 -3
  138. package/github/docs/interfaces/ListOutput.html +1 -1
  139. package/github/docs/interfaces/Logger.html +1 -1
  140. package/github/docs/interfaces/Owner.html +1 -1
  141. package/github/docs/interfaces/PublicKey.html +1 -1
  142. package/github/docs/interfaces/ServiceCompatibilityInfo.html +1 -1
  143. package/github/docs/interfaces/StringFilter.html +1 -1
  144. package/github/docs/interfaces/SudoCryptoProvider.html +1 -1
  145. package/github/docs/interfaces/SudoKeyArchive.html +1 -1
  146. package/github/docs/interfaces/SudoKeyManager.html +1 -1
  147. package/github/docs/interfaces/SymmetricEncryptionOptions.html +1 -1
  148. package/github/docs/interfaces/ValidationResult.html +1 -1
  149. package/github/docs/modules.html +5 -5
  150. package/github/package.json +17 -16
  151. package/github/src/errors/error.ts +5 -1
  152. package/github/src/sudoKeyManager/sudoKeyManager.ts +12 -20
  153. package/github/src/types/types.ts +1 -0
  154. package/github/test/unit/errors/error.spec.ts +3 -18
  155. package/github/test/unit/sudoKeyManager.spec.ts +18 -18
  156. package/github/yarn.lock +410 -229
  157. package/lib/errors/error.d.ts +1 -1
  158. package/lib/errors/error.js +3 -0
  159. package/lib/sudoKeyManager/sudoKeyManager.js +12 -4
  160. package/lib/types/types.d.ts +1 -0
  161. package/lib/types/types.js +1 -0
  162. package/package.json +18 -17
  163. package/src/errors/error.ts +5 -1
  164. package/src/sudoKeyManager/sudoKeyManager.ts +12 -20
  165. package/src/types/types.ts +1 -0
  166. package/test/unit/errors/error.spec.ts +3 -18
  167. package/test/unit/sudoKeyManager.spec.ts +18 -18
  168. package/yarn.lock +410 -229
package/docs/interfaces/ListOutput.html CHANGED
@@ -1,3 +1,3 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ListOutput | @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="ListOutput.html">ListOutput</a></li></ul><h1>Interface ListOutput&lt;T&gt;</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ListOutput | @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="ListOutput.html">ListOutput</a></li></ul><h1>Interface ListOutput&lt;T&gt; </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
2
  <p>Generic type for paginated results from list queries</p>
3
3
  </div></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ListOutput</span></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ListOutput.html#items" class="tsd-kind-icon">items</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ListOutput.html#nextToken" class="tsd-kind-icon">next<wbr/>Token</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="items" class="tsd-anchor"></a><h3 class="tsd-anchor-link">items<a href="#items" 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><div class="tsd-signature tsd-kind-icon">items<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in src/types/types.ts:5</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="nextToken" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> next<wbr/>Token<a href="#nextToken" 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><div class="tsd-signature tsd-kind-icon">next<wbr/>Token<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/types/types.ts:6</li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-has-type-parameter"><a href="ListOutput.html" class="tsd-kind-icon">List<wbr/>Output</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ListOutput.html#items" class="tsd-kind-icon">items</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ListOutput.html#nextToken" class="tsd-kind-icon">next<wbr/>Token</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/interfaces/Logger.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Logger | @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="Logger.html">Logger</a></li></ul><h1>Interface Logger</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Logger | @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="Logger.html">Logger</a></li></ul><h1>Interface Logger </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
2
  <p>Interface encapsulating logger functions.</p>
3
3
  </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Logger</span></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="../classes/DefaultLogger.html" class="tsd-signature-type" data-tsd-kind="Class">DefaultLogger</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="Logger.html#debug" class="tsd-kind-icon">debug</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="Logger.html#error" class="tsd-kind-icon">error</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="Logger.html#fatal" class="tsd-kind-icon">fatal</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="Logger.html#info" class="tsd-kind-icon">info</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="Logger.html#trace" class="tsd-kind-icon">trace</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="Logger.html#warn" class="tsd-kind-icon">warn</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="debug" class="tsd-anchor"></a><h3 class="tsd-anchor-link">debug<a href="#debug" 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">debug<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-signature tsd-kind-icon">debug<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, fields<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</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/logging/logger.ts:22</li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>Whether or not debug level logging is enabled</p>
4
4
  </div></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/logging/logger.ts:29</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
package/docs/interfaces/Owner.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Owner | @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="Owner.html">Owner</a></li></ul><h1>Interface Owner</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">Owner</span></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Owner.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Owner.html#issuer" class="tsd-kind-icon">issuer</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link">id<a href="#id" 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><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/types/types.ts:21</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="issuer" class="tsd-anchor"></a><h3 class="tsd-anchor-link">issuer<a href="#issuer" 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><div class="tsd-signature tsd-kind-icon">issuer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/types/types.ts:22</li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="Owner.html" class="tsd-kind-icon">Owner</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Owner.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Owner.html#issuer" class="tsd-kind-icon">issuer</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Owner | @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="Owner.html">Owner</a></li></ul><h1>Interface Owner </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">Owner</span></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Owner.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Owner.html#issuer" class="tsd-kind-icon">issuer</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link">id<a href="#id" 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><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/types/types.ts:21</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="issuer" class="tsd-anchor"></a><h3 class="tsd-anchor-link">issuer<a href="#issuer" 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><div class="tsd-signature tsd-kind-icon">issuer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/types/types.ts:22</li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="Owner.html" class="tsd-kind-icon">Owner</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Owner.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Owner.html#issuer" class="tsd-kind-icon">issuer</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/interfaces/PublicKey.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PublicKey | @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="PublicKey.html">PublicKey</a></li></ul><h1>Interface PublicKey</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">PublicKey</span></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PublicKey.html#keyData" class="tsd-kind-icon">key<wbr/>Data</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PublicKey.html#keyFormat" class="tsd-kind-icon">key<wbr/>Format</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="keyData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> key<wbr/>Data<a href="#keyData" 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><div class="tsd-signature tsd-kind-icon">key<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ArrayBuffer</span></div><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/publicKey.ts:7</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="keyFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> key<wbr/>Format<a href="#keyFormat" 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><div class="tsd-signature tsd-kind-icon">key<wbr/>Format<span class="tsd-signature-symbol">:</span> <a href="../enums/PublicKeyFormat.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PublicKeyFormat</a></div><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/publicKey.ts:8</li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="PublicKey.html" class="tsd-kind-icon">Public<wbr/>Key</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PublicKey.html#keyData" class="tsd-kind-icon">key<wbr/>Data</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PublicKey.html#keyFormat" class="tsd-kind-icon">key<wbr/>Format</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PublicKey | @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="PublicKey.html">PublicKey</a></li></ul><h1>Interface PublicKey </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">PublicKey</span></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PublicKey.html#keyData" class="tsd-kind-icon">key<wbr/>Data</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PublicKey.html#keyFormat" class="tsd-kind-icon">key<wbr/>Format</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="keyData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> key<wbr/>Data<a href="#keyData" 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><div class="tsd-signature tsd-kind-icon">key<wbr/>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ArrayBuffer</span></div><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/publicKey.ts:7</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="keyFormat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> key<wbr/>Format<a href="#keyFormat" 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><div class="tsd-signature tsd-kind-icon">key<wbr/>Format<span class="tsd-signature-symbol">:</span> <a href="../enums/PublicKeyFormat.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PublicKeyFormat</a></div><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/publicKey.ts:8</li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="PublicKey.html" class="tsd-kind-icon">Public<wbr/>Key</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PublicKey.html#keyData" class="tsd-kind-icon">key<wbr/>Data</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="PublicKey.html#keyFormat" class="tsd-kind-icon">key<wbr/>Format</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/interfaces/ServiceCompatibilityInfo.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServiceCompatibilityInfo | @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="ServiceCompatibilityInfo.html">ServiceCompatibilityInfo</a></li></ul><h1>Interface ServiceCompatibilityInfo</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServiceCompatibilityInfo | @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="ServiceCompatibilityInfo.html">ServiceCompatibilityInfo</a></li></ul><h1>Interface ServiceCompatibilityInfo </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
2
  <p>Service compatibility information.</p>
3
3
  </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ServiceCompatibilityInfo</span></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ServiceCompatibilityInfo.html#configVersion" class="tsd-kind-icon">config<wbr/>Version</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ServiceCompatibilityInfo.html#deprecatedVersion" class="tsd-kind-icon">deprecated<wbr/>Version</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ServiceCompatibilityInfo.html#deprecationGrace" class="tsd-kind-icon">deprecation<wbr/>Grace</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ServiceCompatibilityInfo.html#minSupportedVersion" class="tsd-kind-icon">min<wbr/>Supported<wbr/>Version</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ServiceCompatibilityInfo.html#name" class="tsd-kind-icon">name</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="configVersion" class="tsd-anchor"></a><h3 class="tsd-anchor-link">config<wbr/>Version<a href="#configVersion" 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><div class="tsd-signature tsd-kind-icon">config<wbr/>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in src/configurationManager/defaultConfigurationManager.ts:30</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4
4
  <p>The version of the service config present in sudoplatformconfig.json. It defaults
package/docs/interfaces/StringFilter.html CHANGED
@@ -1,3 +1,3 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StringFilter | @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="StringFilter.html">StringFilter</a></li></ul><h1>Interface StringFilter</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StringFilter | @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="StringFilter.html">StringFilter</a></li></ul><h1>Interface StringFilter </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
2
  <p>A filter to use on string fields when listing items in a repository</p>
3
3
  </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">StringFilter</span></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="StringFilter.html#beginsWith" class="tsd-kind-icon">begins<wbr/>With</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="StringFilter.html#eq" class="tsd-kind-icon">eq</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="StringFilter.html#ne" class="tsd-kind-icon">ne</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="beginsWith" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> begins<wbr/>With<a href="#beginsWith" 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><div class="tsd-signature tsd-kind-icon">begins<wbr/>With<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/types/types.ts:31</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="eq" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> eq<a href="#eq" 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><div class="tsd-signature tsd-kind-icon">eq<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/types/types.ts:30</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ne" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ne<a href="#ne" 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><div class="tsd-signature tsd-kind-icon">ne<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/types/types.ts:29</li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="StringFilter.html" class="tsd-kind-icon">String<wbr/>Filter</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="StringFilter.html#beginsWith" class="tsd-kind-icon">begins<wbr/>With</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="StringFilter.html#eq" class="tsd-kind-icon">eq</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="StringFilter.html#ne" class="tsd-kind-icon">ne</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/interfaces/SudoCryptoProvider.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SudoCryptoProvider | @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="SudoCryptoProvider.html">SudoCryptoProvider</a></li></ul><h1>Interface SudoCryptoProvider</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SudoCryptoProvider | @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="SudoCryptoProvider.html">SudoCryptoProvider</a></li></ul><h1>Interface SudoCryptoProvider </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
2
  <p>CryptoProvider instance interface</p>
3
3
  </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SudoCryptoProvider</span></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="SudoCryptoProvider.html#addPassword" class="tsd-kind-icon">add<wbr/>Password</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#addPrivateKey" class="tsd-kind-icon">add<wbr/>Private<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#addPublicKey" class="tsd-kind-icon">add<wbr/>Public<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#addSymmetricKey" class="tsd-kind-icon">add<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#decryptWithPrivateKey" class="tsd-kind-icon">decrypt<wbr/>With<wbr/>Private<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#decryptWithSymmetricKey" class="tsd-kind-icon">decrypt<wbr/>With<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#decryptWithSymmetricKeyName" class="tsd-kind-icon">decrypt<wbr/>With<wbr/>Symmetric<wbr/>Key<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#deleteKeyPair" class="tsd-kind-icon">delete<wbr/>Key<wbr/>Pair</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#deletePassword" class="tsd-kind-icon">delete<wbr/>Password</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#deleteSymmetricKey" class="tsd-kind-icon">delete<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#doesPrivateKeyExists" class="tsd-kind-icon">does<wbr/>Private<wbr/>Key<wbr/>Exists</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#doesSymmetricKeyExists" class="tsd-kind-icon">does<wbr/>Symmetric<wbr/>Key<wbr/>Exists</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#encryptWithPublicKey" class="tsd-kind-icon">encrypt<wbr/>With<wbr/>Public<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#encryptWithSymmetricKey" class="tsd-kind-icon">encrypt<wbr/>With<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#encryptWithSymmetricKeyName" class="tsd-kind-icon">encrypt<wbr/>With<wbr/>Symmetric<wbr/>Key<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#exportKeys" class="tsd-kind-icon">export<wbr/>Keys</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#generateHash" class="tsd-kind-icon">generate<wbr/>Hash</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#generateKeyPair" class="tsd-kind-icon">generate<wbr/>Key<wbr/>Pair</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#generateRandomData" class="tsd-kind-icon">generate<wbr/>Random<wbr/>Data</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#generateSymmetricKey" class="tsd-kind-icon">generate<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#generateSymmetricKeyFromPassword" class="tsd-kind-icon">generate<wbr/>Symmetric<wbr/>Key<wbr/>From<wbr/>Password</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#getNamespace" class="tsd-kind-icon">get<wbr/>Namespace</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#getPassword" class="tsd-kind-icon">get<wbr/>Password</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#getPrivateKey" class="tsd-kind-icon">get<wbr/>Private<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#getPublicKey" class="tsd-kind-icon">get<wbr/>Public<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#getServiceName" class="tsd-kind-icon">get<wbr/>Service<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#getSymmetricKey" class="tsd-kind-icon">get<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#removeAllKeys" class="tsd-kind-icon">remove<wbr/>All<wbr/>Keys</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoCryptoProvider.html#updatePassword" class="tsd-kind-icon">update<wbr/>Password</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="addPassword" class="tsd-anchor"></a><h3 class="tsd-anchor-link">add<wbr/>Password<a href="#addPassword" 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">add<wbr/>Password<span class="tsd-signature-symbol">(</span>password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, name<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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:45</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4
4
  <p>Adds as password to the secure store.</p>
package/docs/interfaces/SudoKeyArchive.html CHANGED
@@ -1,4 +1,4 @@
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">&lt;</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">&gt;</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">
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">&lt;</span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">&gt;</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.
package/docs/interfaces/SudoKeyManager.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SudoKeyManager | @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="SudoKeyManager.html">SudoKeyManager</a></li></ul><h1>Interface SudoKeyManager</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SudoKeyManager | @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="SudoKeyManager.html">SudoKeyManager</a></li></ul><h1>Interface SudoKeyManager </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
2
  <p>Interface for a set of methods for securely storing keys and performing
3
3
  cryptographic operations.</p>
4
4
  </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SudoKeyManager</span></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="../classes/DefaultSudoKeyManager.html" class="tsd-signature-type" data-tsd-kind="Class">DefaultSudoKeyManager</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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SudoKeyManager.html#namespace" class="tsd-kind-icon">namespace</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SudoKeyManager.html#serviceName" class="tsd-kind-icon">service<wbr/>Name</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#addPassword" class="tsd-kind-icon">add<wbr/>Password</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#addPrivateKey" class="tsd-kind-icon">add<wbr/>Private<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#addPublicKey" class="tsd-kind-icon">add<wbr/>Public<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#addSymmetricKey" class="tsd-kind-icon">add<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#decryptWithPrivateKey" class="tsd-kind-icon">decrypt<wbr/>With<wbr/>Private<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#decryptWithSymmetricKey" class="tsd-kind-icon">decrypt<wbr/>With<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#decryptWithSymmetricKeyName" class="tsd-kind-icon">decrypt<wbr/>With<wbr/>Symmetric<wbr/>Key<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#deleteKeyPair" class="tsd-kind-icon">delete<wbr/>Key<wbr/>Pair</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#deletePassword" class="tsd-kind-icon">delete<wbr/>Password</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#deleteSymmetricKey" class="tsd-kind-icon">delete<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#doesPrivateKeyExists" class="tsd-kind-icon">does<wbr/>Private<wbr/>Key<wbr/>Exists</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#doesSymmetricKeyExists" class="tsd-kind-icon">does<wbr/>Symmetric<wbr/>Key<wbr/>Exists</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#encryptWithPublicKey" class="tsd-kind-icon">encrypt<wbr/>With<wbr/>Public<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#encryptWithSymmetricKey" class="tsd-kind-icon">encrypt<wbr/>With<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#encryptWithSymmetricKeyName" class="tsd-kind-icon">encrypt<wbr/>With<wbr/>Symmetric<wbr/>Key<wbr/>Name</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#exportKeys" class="tsd-kind-icon">export<wbr/>Keys</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#generateHash" class="tsd-kind-icon">generate<wbr/>Hash</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#generateKeyPair" class="tsd-kind-icon">generate<wbr/>Key<wbr/>Pair</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#generateRandomData" class="tsd-kind-icon">generate<wbr/>Random<wbr/>Data</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#generateSymmetricKey" class="tsd-kind-icon">generate<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#generateSymmetricKeyFromPassword" class="tsd-kind-icon">generate<wbr/>Symmetric<wbr/>Key<wbr/>From<wbr/>Password</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#getPassword" class="tsd-kind-icon">get<wbr/>Password</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#getPrivateKey" class="tsd-kind-icon">get<wbr/>Private<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#getPublicKey" class="tsd-kind-icon">get<wbr/>Public<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#getSymmetricKey" class="tsd-kind-icon">get<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#removeAllKeys" class="tsd-kind-icon">remove<wbr/>All<wbr/>Keys</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyManager.html#updatePassword" class="tsd-kind-icon">update<wbr/>Password</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="namespace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> namespace<a href="#namespace" 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><div class="tsd-signature tsd-kind-icon">namespace<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoKeyManager.ts:15</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="serviceName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagReadonly">Readonly</span> service<wbr/>Name<a href="#serviceName" 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><div class="tsd-signature tsd-kind-icon">service<wbr/>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoKeyManager.ts:16</li></ul></aside></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="addPassword" class="tsd-anchor"></a><h3 class="tsd-anchor-link">add<wbr/>Password<a href="#addPassword" 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">add<wbr/>Password<span class="tsd-signature-symbol">(</span>password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span>, name<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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoKeyManager.ts:23</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
package/docs/interfaces/SymmetricEncryptionOptions.html CHANGED
@@ -1,3 +1,3 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SymmetricEncryptionOptions | @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="SymmetricEncryptionOptions.html">SymmetricEncryptionOptions</a></li></ul><h1>Interface SymmetricEncryptionOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SymmetricEncryptionOptions | @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="SymmetricEncryptionOptions.html">SymmetricEncryptionOptions</a></li></ul><h1>Interface SymmetricEncryptionOptions </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
2
  <p>Optional arguments for symmetric encryption..</p>
3
3
  </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SymmetricEncryptionOptions</span></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SymmetricEncryptionOptions.html#algorithm" class="tsd-kind-icon">algorithm</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SymmetricEncryptionOptions.html#iv" class="tsd-kind-icon">iv</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="algorithm" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> algorithm<a href="#algorithm" 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><div class="tsd-signature tsd-kind-icon">algorithm<span class="tsd-signature-symbol">?:</span> <a href="../enums/EncryptionAlgorithm.html" class="tsd-signature-type" data-tsd-kind="Enumeration">EncryptionAlgorithm</a></div><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:20</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="iv" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> iv<a href="#iv" 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><div class="tsd-signature tsd-kind-icon">iv<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ArrayBuffer</span></div><aside class="tsd-sources"><ul><li>Defined in src/sudoKeyManager/sudoCryptoProvider.ts:17</li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="SymmetricEncryptionOptions.html" class="tsd-kind-icon">Symmetric<wbr/>Encryption<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SymmetricEncryptionOptions.html#algorithm" class="tsd-kind-icon">algorithm</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SymmetricEncryptionOptions.html#iv" class="tsd-kind-icon">iv</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/interfaces/ValidationResult.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ValidationResult | @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="ValidationResult.html">ValidationResult</a></li></ul><h1>Interface ValidationResult</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
1
+ <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ValidationResult | @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="ValidationResult.html">ValidationResult</a></li></ul><h1>Interface ValidationResult </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
2
  <p>Result returned by <code>validateConfig</code> API if an incompatible client config is found when compared
3
3
  to the deployed backend services.</p>
4
4
  </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ValidationResult</span></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ValidationResult.html#deprecated" class="tsd-kind-icon">deprecated</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ValidationResult.html#incompatible" class="tsd-kind-icon">incompatible</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="deprecated" class="tsd-anchor"></a><h3 class="tsd-anchor-link">deprecated<a href="#deprecated" 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><div class="tsd-signature tsd-kind-icon">deprecated<span class="tsd-signature-symbol">:</span> <a href="ServiceCompatibilityInfo.html" class="tsd-signature-type" data-tsd-kind="Interface">ServiceCompatibilityInfo</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in src/configurationManager/defaultConfigurationManager.ts:62</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">