@sudoplatform/sudo-common 7.0.1 → 7.1.3

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 (315) hide show
  1. package/lib/configurationManager/defaultConfigurationManager.js +3 -5
  2. package/lib/sudoKeyManager/sudoCryptoProvider.d.ts +0 -16
  3. package/lib/sudoKeyManager/sudoKeyManager.d.ts +0 -18
  4. package/lib/sudoKeyManager/sudoKeyManager.js +2 -10
  5. package/lib/utils/base64.d.ts +35 -0
  6. package/lib/utils/base64.js +65 -0
  7. package/package.json +3 -4
  8. package/.babelrc +0 -10
  9. package/.eslintrc.js +0 -91
  10. package/.gitignore +0 -14
  11. package/.gitlab-ci.yml +0 -101
  12. package/.npmignore +0 -1
  13. package/.prettierignore +0 -3
  14. package/.prettierrc.js +0 -7
  15. package/.publisher.json +0 -7
  16. package/.vscode/settings.json +0 -5
  17. package/.yarn/releases/yarn-1.22.19.cjs +0 -147529
  18. package/.yarnrc +0 -5
  19. package/bin/outdated-with-suppression.sh +0 -203
  20. package/bin/suppress-audit.sh +0 -15
  21. package/bin/suppress-outdated.sh +0 -60
  22. package/bin/yarn-audit-with-suppression.sh +0 -19
  23. package/dependencies-report.json +0 -640
  24. package/docs/.nojekyll +0 -1
  25. package/docs/assets/highlight.css +0 -57
  26. package/docs/assets/main.js +0 -54
  27. package/docs/assets/search.js +0 -1
  28. package/docs/assets/style.css +0 -1224
  29. package/docs/assets/widgets.png +0 -0
  30. package/docs/assets/widgets@2x.png +0 -0
  31. package/docs/classes/AccountLockedError.html +0 -163
  32. package/docs/classes/AuthenticationError.html +0 -169
  33. package/docs/classes/Base64.html +0 -134
  34. package/docs/classes/Buffer.html +0 -158
  35. package/docs/classes/ConfigurationNotSetError.html +0 -164
  36. package/docs/classes/ConfigurationSetNotFoundError.html +0 -168
  37. package/docs/classes/DecodeError.html +0 -168
  38. package/docs/classes/DefaultConfigurationManager.html +0 -213
  39. package/docs/classes/DefaultLogger.html +0 -291
  40. package/docs/classes/DefaultSudoKeyArchive.html +0 -363
  41. package/docs/classes/DefaultSudoKeyManager.html +0 -858
  42. package/docs/classes/FatalError.html +0 -169
  43. package/docs/classes/IllegalArgumentError.html +0 -168
  44. package/docs/classes/IllegalStateError.html +0 -169
  45. package/docs/classes/InsufficientEntitlementsError.html +0 -164
  46. package/docs/classes/InvalidOwnershipProofError.html +0 -163
  47. package/docs/classes/InvalidTokenError.html +0 -163
  48. package/docs/classes/KeyArchiveDecodingError.html +0 -168
  49. package/docs/classes/KeyArchiveIncorrectPasswordError.html +0 -168
  50. package/docs/classes/KeyArchiveMissingError.html +0 -168
  51. package/docs/classes/KeyArchiveNoPasswordRequiredError.html +0 -168
  52. package/docs/classes/KeyArchivePasswordRequiredError.html +0 -168
  53. package/docs/classes/KeyArchiveTypeError.html +0 -168
  54. package/docs/classes/KeyArchiveUnknownKeyTypeError.html +0 -168
  55. package/docs/classes/KeyArchiveVersionError.html +0 -168
  56. package/docs/classes/KeyNotFoundError.html +0 -168
  57. package/docs/classes/KeyStoreNotExportableError.html +0 -168
  58. package/docs/classes/LimitExceededError.html +0 -164
  59. package/docs/classes/NoEntitlementsError.html +0 -163
  60. package/docs/classes/NotAuthorizedError.html +0 -169
  61. package/docs/classes/NotRegisteredError.html +0 -168
  62. package/docs/classes/NotSignedInError.html +0 -164
  63. package/docs/classes/OperationNotImplementedError.html +0 -168
  64. package/docs/classes/RegisterError.html +0 -169
  65. package/docs/classes/RequestFailedError.html +0 -189
  66. package/docs/classes/ServiceError.html +0 -170
  67. package/docs/classes/SignOutError.html +0 -168
  68. package/docs/classes/SudoCryptoProviderDefaults.html +0 -106
  69. package/docs/classes/UnknownGraphQLError.html +0 -169
  70. package/docs/classes/UnrecognizedAlgorithmError.html +0 -168
  71. package/docs/classes/UserNotConfirmedError.html +0 -164
  72. package/docs/classes/VersionMismatchError.html +0 -166
  73. package/docs/enums/CachePolicy.html +0 -72
  74. package/docs/enums/EncryptionAlgorithm.html +0 -80
  75. package/docs/enums/KeyArchiveKeyType.html +0 -86
  76. package/docs/enums/KeyDataKeyFormat.html +0 -92
  77. package/docs/enums/KeyDataKeyType.html +0 -85
  78. package/docs/enums/ListOperationResultStatus.html +0 -85
  79. package/docs/enums/PublicKeyFormat.html +0 -68
  80. package/docs/functions/isAppSyncNetworkError.html +0 -147
  81. package/docs/functions/isInsecureKeyArchive.html +0 -147
  82. package/docs/functions/isSecureKeyArchive.html +0 -147
  83. package/docs/functions/isUnrecognizedKeyArchive.html +0 -147
  84. package/docs/functions/keyArchiveInfoFromKeyData.html +0 -147
  85. package/docs/functions/keyArchiveKeyTypeFromKeyDataKeyType.html +0 -147
  86. package/docs/functions/mapGraphQLToClientError.html +0 -154
  87. package/docs/functions/mapNetworkErrorToClientError.html +0 -154
  88. package/docs/index.html +0 -146
  89. package/docs/interfaces/AsymmetricEncryptionOptions.html +0 -68
  90. package/docs/interfaces/BooleanFilter.html +0 -75
  91. package/docs/interfaces/ConfigurationManager.html +0 -200
  92. package/docs/interfaces/KeyData.html +0 -106
  93. package/docs/interfaces/ListOperationFailureResult.html +0 -76
  94. package/docs/interfaces/ListOperationPartialResult.html +0 -102
  95. package/docs/interfaces/ListOperationSuccessResult.html +0 -90
  96. package/docs/interfaces/ListOutput.html +0 -80
  97. package/docs/interfaces/Logger.html +0 -251
  98. package/docs/interfaces/Owner.html +0 -72
  99. package/docs/interfaces/PublicKey.html +0 -72
  100. package/docs/interfaces/ServiceCompatibilityInfo.html +0 -110
  101. package/docs/interfaces/StringFilter.html +0 -82
  102. package/docs/interfaces/SudoCryptoProvider.html +0 -907
  103. package/docs/interfaces/SudoKeyArchive.html +0 -257
  104. package/docs/interfaces/SudoKeyManager.html +0 -890
  105. package/docs/interfaces/SymmetricEncryptionOptions.html +0 -75
  106. package/docs/interfaces/ValidationResult.html +0 -83
  107. package/docs/modules.html +0 -248
  108. package/docs/types/AppSyncError.html +0 -138
  109. package/docs/types/AppSyncNetworkError.html +0 -138
  110. package/docs/types/InsecureKeyArchive.html +0 -138
  111. package/docs/types/KeyArchive.html +0 -138
  112. package/docs/types/KeyArchiveKeyInfo.html +0 -154
  113. package/docs/types/KeyArchiveKeyInfoDecoded.html +0 -138
  114. package/docs/types/ListOperationResult.html +0 -148
  115. package/docs/types/SecureKeyArchive.html +0 -138
  116. package/docs/types/Subset.html +0 -144
  117. package/docs/types/UnrecognizedKeyArchive.html +0 -138
  118. package/docs/variables/CURRENT_ARCHIVE_VERSION.html +0 -138
  119. package/docs/variables/InsecureKeyArchiveCodec.html +0 -138
  120. package/docs/variables/InsecureKeyArchiveType.html +0 -138
  121. package/docs/variables/KeyArchiveCodec.html +0 -138
  122. package/docs/variables/KeyArchiveKeyInfoArrayCodec.html +0 -138
  123. package/docs/variables/KeyArchiveKeyInfoCodec.html +0 -138
  124. package/docs/variables/KeyArchiveKeyTypeCodec.html +0 -138
  125. package/docs/variables/SecureKeyArchiveCodec.html +0 -138
  126. package/docs/variables/SecureKeyArchiveType.html +0 -138
  127. package/docs/variables/UnrecognizedKeyArchiveCodec.html +0 -138
  128. package/github/.babelrc +0 -10
  129. package/github/.eslintrc.js +0 -91
  130. package/github/.gitignore +0 -14
  131. package/github/.gitlab-ci.yml +0 -101
  132. package/github/.npmignore +0 -1
  133. package/github/.prettierignore +0 -3
  134. package/github/.prettierrc.js +0 -7
  135. package/github/.publisher.json +0 -7
  136. package/github/.vscode/settings.json +0 -5
  137. package/github/.yarn/releases/yarn-1.22.19.cjs +0 -147529
  138. package/github/.yarnrc +0 -5
  139. package/github/CHANGELOG.md +0 -51
  140. package/github/README.md +0 -8
  141. package/github/bin/outdated-with-suppression.sh +0 -203
  142. package/github/bin/suppress-audit.sh +0 -15
  143. package/github/bin/suppress-outdated.sh +0 -60
  144. package/github/bin/yarn-audit-with-suppression.sh +0 -19
  145. package/github/docs/.nojekyll +0 -1
  146. package/github/docs/assets/highlight.css +0 -57
  147. package/github/docs/assets/main.js +0 -54
  148. package/github/docs/assets/search.js +0 -1
  149. package/github/docs/assets/style.css +0 -1224
  150. package/github/docs/assets/widgets.png +0 -0
  151. package/github/docs/assets/widgets@2x.png +0 -0
  152. package/github/docs/classes/AccountLockedError.html +0 -163
  153. package/github/docs/classes/AuthenticationError.html +0 -169
  154. package/github/docs/classes/Base64.html +0 -134
  155. package/github/docs/classes/Buffer.html +0 -158
  156. package/github/docs/classes/ConfigurationNotSetError.html +0 -164
  157. package/github/docs/classes/ConfigurationSetNotFoundError.html +0 -168
  158. package/github/docs/classes/DecodeError.html +0 -168
  159. package/github/docs/classes/DefaultConfigurationManager.html +0 -213
  160. package/github/docs/classes/DefaultLogger.html +0 -291
  161. package/github/docs/classes/DefaultSudoKeyArchive.html +0 -363
  162. package/github/docs/classes/DefaultSudoKeyManager.html +0 -858
  163. package/github/docs/classes/FatalError.html +0 -169
  164. package/github/docs/classes/IllegalArgumentError.html +0 -168
  165. package/github/docs/classes/IllegalStateError.html +0 -169
  166. package/github/docs/classes/InsufficientEntitlementsError.html +0 -164
  167. package/github/docs/classes/InvalidOwnershipProofError.html +0 -163
  168. package/github/docs/classes/InvalidTokenError.html +0 -163
  169. package/github/docs/classes/KeyArchiveDecodingError.html +0 -168
  170. package/github/docs/classes/KeyArchiveIncorrectPasswordError.html +0 -168
  171. package/github/docs/classes/KeyArchiveMissingError.html +0 -168
  172. package/github/docs/classes/KeyArchiveNoPasswordRequiredError.html +0 -168
  173. package/github/docs/classes/KeyArchivePasswordRequiredError.html +0 -168
  174. package/github/docs/classes/KeyArchiveTypeError.html +0 -168
  175. package/github/docs/classes/KeyArchiveUnknownKeyTypeError.html +0 -168
  176. package/github/docs/classes/KeyArchiveVersionError.html +0 -168
  177. package/github/docs/classes/KeyNotFoundError.html +0 -168
  178. package/github/docs/classes/KeyStoreNotExportableError.html +0 -168
  179. package/github/docs/classes/LimitExceededError.html +0 -164
  180. package/github/docs/classes/NoEntitlementsError.html +0 -163
  181. package/github/docs/classes/NotAuthorizedError.html +0 -169
  182. package/github/docs/classes/NotRegisteredError.html +0 -168
  183. package/github/docs/classes/NotSignedInError.html +0 -164
  184. package/github/docs/classes/OperationNotImplementedError.html +0 -168
  185. package/github/docs/classes/RegisterError.html +0 -169
  186. package/github/docs/classes/RequestFailedError.html +0 -189
  187. package/github/docs/classes/ServiceError.html +0 -170
  188. package/github/docs/classes/SignOutError.html +0 -168
  189. package/github/docs/classes/SudoCryptoProviderDefaults.html +0 -106
  190. package/github/docs/classes/UnknownGraphQLError.html +0 -169
  191. package/github/docs/classes/UnrecognizedAlgorithmError.html +0 -168
  192. package/github/docs/classes/UserNotConfirmedError.html +0 -164
  193. package/github/docs/classes/VersionMismatchError.html +0 -166
  194. package/github/docs/enums/CachePolicy.html +0 -72
  195. package/github/docs/enums/EncryptionAlgorithm.html +0 -80
  196. package/github/docs/enums/KeyArchiveKeyType.html +0 -86
  197. package/github/docs/enums/KeyDataKeyFormat.html +0 -92
  198. package/github/docs/enums/KeyDataKeyType.html +0 -85
  199. package/github/docs/enums/ListOperationResultStatus.html +0 -85
  200. package/github/docs/enums/PublicKeyFormat.html +0 -68
  201. package/github/docs/functions/isAppSyncNetworkError.html +0 -147
  202. package/github/docs/functions/isInsecureKeyArchive.html +0 -147
  203. package/github/docs/functions/isSecureKeyArchive.html +0 -147
  204. package/github/docs/functions/isUnrecognizedKeyArchive.html +0 -147
  205. package/github/docs/functions/keyArchiveInfoFromKeyData.html +0 -147
  206. package/github/docs/functions/keyArchiveKeyTypeFromKeyDataKeyType.html +0 -147
  207. package/github/docs/functions/mapGraphQLToClientError.html +0 -154
  208. package/github/docs/functions/mapNetworkErrorToClientError.html +0 -154
  209. package/github/docs/index.html +0 -146
  210. package/github/docs/interfaces/AsymmetricEncryptionOptions.html +0 -68
  211. package/github/docs/interfaces/BooleanFilter.html +0 -75
  212. package/github/docs/interfaces/ConfigurationManager.html +0 -200
  213. package/github/docs/interfaces/KeyData.html +0 -106
  214. package/github/docs/interfaces/ListOperationFailureResult.html +0 -76
  215. package/github/docs/interfaces/ListOperationPartialResult.html +0 -102
  216. package/github/docs/interfaces/ListOperationSuccessResult.html +0 -90
  217. package/github/docs/interfaces/ListOutput.html +0 -80
  218. package/github/docs/interfaces/Logger.html +0 -251
  219. package/github/docs/interfaces/Owner.html +0 -72
  220. package/github/docs/interfaces/PublicKey.html +0 -72
  221. package/github/docs/interfaces/ServiceCompatibilityInfo.html +0 -110
  222. package/github/docs/interfaces/StringFilter.html +0 -82
  223. package/github/docs/interfaces/SudoCryptoProvider.html +0 -907
  224. package/github/docs/interfaces/SudoKeyArchive.html +0 -257
  225. package/github/docs/interfaces/SudoKeyManager.html +0 -890
  226. package/github/docs/interfaces/SymmetricEncryptionOptions.html +0 -75
  227. package/github/docs/interfaces/ValidationResult.html +0 -83
  228. package/github/docs/modules.html +0 -248
  229. package/github/docs/types/AppSyncError.html +0 -138
  230. package/github/docs/types/AppSyncNetworkError.html +0 -138
  231. package/github/docs/types/InsecureKeyArchive.html +0 -138
  232. package/github/docs/types/KeyArchive.html +0 -138
  233. package/github/docs/types/KeyArchiveKeyInfo.html +0 -154
  234. package/github/docs/types/KeyArchiveKeyInfoDecoded.html +0 -138
  235. package/github/docs/types/ListOperationResult.html +0 -148
  236. package/github/docs/types/SecureKeyArchive.html +0 -138
  237. package/github/docs/types/Subset.html +0 -144
  238. package/github/docs/types/UnrecognizedKeyArchive.html +0 -138
  239. package/github/docs/variables/CURRENT_ARCHIVE_VERSION.html +0 -138
  240. package/github/docs/variables/InsecureKeyArchiveCodec.html +0 -138
  241. package/github/docs/variables/InsecureKeyArchiveType.html +0 -138
  242. package/github/docs/variables/KeyArchiveCodec.html +0 -138
  243. package/github/docs/variables/KeyArchiveKeyInfoArrayCodec.html +0 -138
  244. package/github/docs/variables/KeyArchiveKeyInfoCodec.html +0 -138
  245. package/github/docs/variables/KeyArchiveKeyTypeCodec.html +0 -138
  246. package/github/docs/variables/SecureKeyArchiveCodec.html +0 -138
  247. package/github/docs/variables/SecureKeyArchiveType.html +0 -138
  248. package/github/docs/variables/UnrecognizedKeyArchiveCodec.html +0 -138
  249. package/github/jest.config.json +0 -14
  250. package/github/package.json +0 -91
  251. package/github/src/configurationManager/defaultConfigurationManager.ts +0 -281
  252. package/github/src/errors/error.ts +0 -469
  253. package/github/src/index.ts +0 -8
  254. package/github/src/logging/bunyanLogger.ts +0 -47
  255. package/github/src/logging/logger.ts +0 -164
  256. package/github/src/sudoKeyArchive/index.ts +0 -4
  257. package/github/src/sudoKeyArchive/keyArchive.ts +0 -120
  258. package/github/src/sudoKeyArchive/keyInfo.ts +0 -47
  259. package/github/src/sudoKeyArchive/keyType.ts +0 -50
  260. package/github/src/sudoKeyArchive/sudoKeyArchive.ts +0 -591
  261. package/github/src/sudoKeyManager/index.ts +0 -4
  262. package/github/src/sudoKeyManager/keyData.ts +0 -60
  263. package/github/src/sudoKeyManager/publicKey.ts +0 -9
  264. package/github/src/sudoKeyManager/sudoCryptoProvider.ts +0 -434
  265. package/github/src/sudoKeyManager/sudoKeyManager.ts +0 -635
  266. package/github/src/types/types.ts +0 -129
  267. package/github/src/utils/base64.ts +0 -21
  268. package/github/src/utils/buffer.ts +0 -39
  269. package/github/test/integration/defaultConfigurationManager.spec.ts +0 -85
  270. package/github/test/matchers.ts +0 -122
  271. package/github/test/unit/configurationManager/defaultConfigurationManager.spec.ts +0 -506
  272. package/github/test/unit/errors/error.spec.ts +0 -115
  273. package/github/test/unit/keyType.spec.ts +0 -54
  274. package/github/test/unit/logging/logger.spec.ts +0 -182
  275. package/github/test/unit/sudoKeyArchive.spec.ts +0 -1609
  276. package/github/test/unit/sudoKeyManager.spec.ts +0 -1086
  277. package/github/test/unit/utils/base64.spec.ts +0 -30
  278. package/github/test/unit/utils/buffer.spec.ts +0 -45
  279. package/github/test/unit/utils/listOperationResult.spec.ts +0 -84
  280. package/github/tsconfig.json +0 -20
  281. package/github/tsconfig.test.json +0 -7
  282. package/github/yarn.lock +0 -5922
  283. package/jest.config.json +0 -14
  284. package/src/configurationManager/defaultConfigurationManager.ts +0 -281
  285. package/src/errors/error.ts +0 -469
  286. package/src/index.ts +0 -8
  287. package/src/logging/bunyanLogger.ts +0 -47
  288. package/src/logging/logger.ts +0 -164
  289. package/src/sudoKeyArchive/index.ts +0 -4
  290. package/src/sudoKeyArchive/keyArchive.ts +0 -120
  291. package/src/sudoKeyArchive/keyInfo.ts +0 -47
  292. package/src/sudoKeyArchive/keyType.ts +0 -50
  293. package/src/sudoKeyArchive/sudoKeyArchive.ts +0 -591
  294. package/src/sudoKeyManager/index.ts +0 -4
  295. package/src/sudoKeyManager/keyData.ts +0 -60
  296. package/src/sudoKeyManager/publicKey.ts +0 -9
  297. package/src/sudoKeyManager/sudoCryptoProvider.ts +0 -434
  298. package/src/sudoKeyManager/sudoKeyManager.ts +0 -635
  299. package/src/types/types.ts +0 -129
  300. package/src/utils/base64.ts +0 -21
  301. package/src/utils/buffer.ts +0 -39
  302. package/test/integration/defaultConfigurationManager.spec.ts +0 -85
  303. package/test/matchers.ts +0 -122
  304. package/test/unit/configurationManager/defaultConfigurationManager.spec.ts +0 -506
  305. package/test/unit/errors/error.spec.ts +0 -115
  306. package/test/unit/keyType.spec.ts +0 -54
  307. package/test/unit/logging/logger.spec.ts +0 -182
  308. package/test/unit/sudoKeyArchive.spec.ts +0 -1609
  309. package/test/unit/sudoKeyManager.spec.ts +0 -1086
  310. package/test/unit/utils/base64.spec.ts +0 -30
  311. package/test/unit/utils/buffer.spec.ts +0 -45
  312. package/test/unit/utils/listOperationResult.spec.ts +0 -84
  313. package/tsconfig.json +0 -20
  314. package/tsconfig.test.json +0 -7
  315. package/yarn.lock +0 -5922
package/docs/interfaces/SudoKeyArchive.html DELETED
@@ -1,257 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><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.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
- <div class="tsd-toolbar-contents container">
3
- <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
- <ul class="results">
6
- <li class="state loading">Preparing search index...</li>
7
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@sudoplatform/sudo-common</a></div>
8
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
9
- <div class="container container-main">
10
- <div class="col-8 col-content">
11
- <div class="tsd-page-title">
12
- <ul class="tsd-breadcrumb">
13
- <li><a href="../modules.html">@sudoplatform/sudo-common</a></li>
14
- <li><a href="SudoKeyArchive.html">SudoKeyArchive</a></li></ul>
15
- <h1>Interface SudoKeyArchive</h1></div>
16
- <section class="tsd-panel tsd-hierarchy">
17
- <h4>Hierarchy</h4>
18
- <ul class="tsd-hierarchy">
19
- <li><span class="target">SudoKeyArchive</span></li></ul></section>
20
- <section class="tsd-panel">
21
- <h4>Implemented by</h4>
22
- <ul class="tsd-hierarchy">
23
- <li><a href="../classes/DefaultSudoKeyArchive.html" class="tsd-signature-type" data-tsd-kind="Class">DefaultSudoKeyArchive</a></li></ul></section><aside class="tsd-sources">
24
- <ul>
25
- <li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:35</li></ul></aside>
26
- <section class="tsd-panel-group tsd-index-group">
27
- <section class="tsd-panel tsd-index-panel">
28
- <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
29
- <h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
30
- <div class="tsd-accordion-details">
31
- <section class="tsd-index-section">
32
- <h3 class="tsd-index-heading">Methods</h3>
33
- <div class="tsd-index-list"><a href="SudoKeyArchive.html#archive" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>archive</span></a>
34
- <a href="SudoKeyArchive.html#containsKey" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>contains<wbr/>Key</span></a>
35
- <a href="SudoKeyArchive.html#getExcludedKeyTypes" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Excluded<wbr/>Key<wbr/>Types</span></a>
36
- <a href="SudoKeyArchive.html#getExcludedKeys" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Excluded<wbr/>Keys</span></a>
37
- <a href="SudoKeyArchive.html#getKeyData" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Key<wbr/>Data</span></a>
38
- <a href="SudoKeyArchive.html#getMetaInfo" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Meta<wbr/>Info</span></a>
39
- <a href="SudoKeyArchive.html#loadKeys" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>load<wbr/>Keys</span></a>
40
- <a href="SudoKeyArchive.html#reset" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>reset</span></a>
41
- <a href="SudoKeyArchive.html#saveKeys" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>save<wbr/>Keys</span></a>
42
- <a href="SudoKeyArchive.html#unarchive" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>unarchive</span></a>
43
- </div></section></div></details></section></section>
44
- <section class="tsd-panel-group tsd-member-group">
45
- <h2>Methods</h2>
46
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="archive" class="tsd-anchor"></a>
47
- <h3 class="tsd-anchor-link"><span>archive</span><a href="#archive" aria-label="Permalink" class="tsd-anchor-icon"><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" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></h3>
48
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
49
- <li class="tsd-signature tsd-anchor-link" id="archive.archive-1">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><a href="#archive.archive-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
50
- <li class="tsd-description">
51
- <div class="tsd-comment tsd-typography"><p>Archives and encrypts the keys loaded into this archive.</p>
52
-
53
- <h3>Returns</h3><p>Binary archive data.</p>
54
- </div>
55
- <div class="tsd-parameters">
56
- <h4 class="tsd-parameters-title">Parameters</h4>
57
- <ul class="tsd-parameter-list">
58
- <li>
59
- <h5>password: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span></h5>
60
- <div class="tsd-comment tsd-typography"><p>The password to use to encrypt the archive. Or undefined if no password.
61
- Choice to have no password must be explicit.</p>
62
- </div></li></ul></div>
63
- <h4 class="tsd-returns-title">Returns <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></h4><aside class="tsd-sources">
64
- <ul>
65
- <li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:55</li></ul></aside></li></ul></section>
66
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="containsKey" class="tsd-anchor"></a>
67
- <h3 class="tsd-anchor-link"><span>contains<wbr/>Key</span><a href="#containsKey" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
68
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
69
- <li class="tsd-signature tsd-anchor-link" id="containsKey.containsKey-1">contains<wbr/>Key<span class="tsd-signature-symbol">(</span>namespace<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><a href="../enums/KeyArchiveKeyType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">KeyArchiveKeyType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#containsKey.containsKey-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
70
- <li class="tsd-description">
71
- <div class="tsd-comment tsd-typography"><p>Determines whether or not the archive contains the key with the
72
- specified name and type. The archive must be unarchived before the
73
- key can be searched.</p>
74
-
75
- <h3>Returns</h3><p>true if the specified key exists in the archive.</p>
76
- </div>
77
- <div class="tsd-parameters">
78
- <h4 class="tsd-parameters-title">Parameters</h4>
79
- <ul class="tsd-parameter-list">
80
- <li>
81
- <h5>namespace: <span class="tsd-signature-type">string</span></h5>
82
- <div class="tsd-comment tsd-typography"><p>the namespace of the key</p>
83
- </div></li>
84
- <li>
85
- <h5>name: <span class="tsd-signature-type">string</span></h5>
86
- <div class="tsd-comment tsd-typography"><p>the key name.</p>
87
- </div></li>
88
- <li>
89
- <h5>type: <a href="../enums/KeyArchiveKeyType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">KeyArchiveKeyType</a></h5>
90
- <div class="tsd-comment tsd-typography"><p>the key type.</p>
91
- </div></li></ul></div>
92
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
93
- <ul>
94
- <li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:96</li></ul></aside></li></ul></section>
95
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getExcludedKeyTypes" class="tsd-anchor"></a>
96
- <h3 class="tsd-anchor-link"><span>get<wbr/>Excluded<wbr/>Key<wbr/>Types</span><a href="#getExcludedKeyTypes" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
97
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
98
- <li class="tsd-signature tsd-anchor-link" id="getExcludedKeyTypes.getExcludedKeyTypes-1">get<wbr/>Excluded<wbr/>Key<wbr/>Types<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReadonlySet</span><span class="tsd-signature-symbol">&lt;</span><a href="../enums/KeyArchiveKeyType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">KeyArchiveKeyType</a><span class="tsd-signature-symbol">&gt;</span><a href="#getExcludedKeyTypes.getExcludedKeyTypes-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
99
- <li class="tsd-description">
100
- <div class="tsd-comment tsd-typography">
101
- <h3>Returns</h3><p>the key types to exclude from the archive in an unmodifiable set.</p>
102
- </div>
103
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReadonlySet</span><span class="tsd-signature-symbol">&lt;</span><a href="../enums/KeyArchiveKeyType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">KeyArchiveKeyType</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
104
- <ul>
105
- <li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:118</li></ul></aside></li></ul></section>
106
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getExcludedKeys" class="tsd-anchor"></a>
107
- <h3 class="tsd-anchor-link"><span>get<wbr/>Excluded<wbr/>Keys</span><a href="#getExcludedKeys" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
108
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
109
- <li class="tsd-signature tsd-anchor-link" id="getExcludedKeys.getExcludedKeys-1">get<wbr/>Excluded<wbr/>Keys<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReadonlySet</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getExcludedKeys.getExcludedKeys-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
110
- <li class="tsd-description">
111
- <div class="tsd-comment tsd-typography">
112
- <h3>Returns</h3><p>the key names to exclude from the archive in an unmodifiable set.</p>
113
- </div>
114
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReadonlySet</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
115
- <ul>
116
- <li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:121</li></ul></aside></li></ul></section>
117
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getKeyData" class="tsd-anchor"></a>
118
- <h3 class="tsd-anchor-link"><span>get<wbr/>Key<wbr/>Data</span><a href="#getKeyData" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
119
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
120
- <li class="tsd-signature tsd-anchor-link" id="getKeyData.getKeyData-1">get<wbr/>Key<wbr/>Data<span class="tsd-signature-symbol">(</span>namespace<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, type<span class="tsd-signature-symbol">: </span><a href="../enums/KeyArchiveKeyType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">KeyArchiveKeyType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ArrayBuffer</span><a href="#getKeyData.getKeyData-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
121
- <li class="tsd-description">
122
- <div class="tsd-comment tsd-typography"><p>Retrieves the specified key data from the archive. The archive must
123
- be unarchived before the key data can be retrieved.</p>
124
-
125
- <h3>Returns</h3><p>a byte array containing the specified key data or null if it was not found.</p>
126
-
127
- <h3>Throws</h3><p><a href="../classes/KeyNotFoundError.html">KeyNotFoundError</a>
128
- If key is not present in the archive.</p>
129
- </div>
130
- <div class="tsd-parameters">
131
- <h4 class="tsd-parameters-title">Parameters</h4>
132
- <ul class="tsd-parameter-list">
133
- <li>
134
- <h5>namespace: <span class="tsd-signature-type">string</span></h5>
135
- <div class="tsd-comment tsd-typography"><p>the namespace of the key</p>
136
- </div></li>
137
- <li>
138
- <h5>name: <span class="tsd-signature-type">string</span></h5>
139
- <div class="tsd-comment tsd-typography"><p>the key name</p>
140
- </div></li>
141
- <li>
142
- <h5>type: <a href="../enums/KeyArchiveKeyType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">KeyArchiveKeyType</a></h5>
143
- <div class="tsd-comment tsd-typography"><p>the key type</p>
144
- </div></li></ul></div>
145
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ArrayBuffer</span></h4><aside class="tsd-sources">
146
- <ul>
147
- <li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:111</li></ul></aside></li></ul></section>
148
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getMetaInfo" class="tsd-anchor"></a>
149
- <h3 class="tsd-anchor-link"><span>get<wbr/>Meta<wbr/>Info</span><a href="#getMetaInfo" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
150
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
151
- <li class="tsd-signature tsd-anchor-link" id="getMetaInfo.getMetaInfo-1">get<wbr/>Meta<wbr/>Info<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ReadonlyMap</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#getMetaInfo.getMetaInfo-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
152
- <li class="tsd-description">
153
- <div class="tsd-comment tsd-typography">
154
- <h3>Returns</h3><p>the meta-information associated with this archive in an unmodifiable map.</p>
155
- </div>
156
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ReadonlyMap</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">string</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
157
- <ul>
158
- <li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:124</li></ul></aside></li></ul></section>
159
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="loadKeys" class="tsd-anchor"></a>
160
- <h3 class="tsd-anchor-link"><span>load<wbr/>Keys</span><a href="#loadKeys" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
161
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
162
- <li class="tsd-signature tsd-anchor-link" id="loadKeys.loadKeys-1">load<wbr/>Keys<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#loadKeys.loadKeys-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
163
- <li class="tsd-description">
164
- <div class="tsd-comment tsd-typography"><p>Loads keys from the secure store into the archive.</p>
165
- </div>
166
- <h4 class="tsd-returns-title">Returns <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></h4><aside class="tsd-sources">
167
- <ul>
168
- <li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:39</li></ul></aside></li></ul></section>
169
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="reset" class="tsd-anchor"></a>
170
- <h3 class="tsd-anchor-link"><span>reset</span><a href="#reset" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
171
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
172
- <li class="tsd-signature tsd-anchor-link" id="reset.reset-1">reset<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#reset.reset-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
173
- <li class="tsd-description">
174
- <div class="tsd-comment tsd-typography"><p>Resets the archive by clearing loaded keys and archive data.</p>
175
- </div>
176
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
177
- <ul>
178
- <li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:83</li></ul></aside></li></ul></section>
179
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="saveKeys" class="tsd-anchor"></a>
180
- <h3 class="tsd-anchor-link"><span>save<wbr/>Keys</span><a href="#saveKeys" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
181
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
182
- <li class="tsd-signature tsd-anchor-link" id="saveKeys.saveKeys-1">save<wbr/>Keys<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#saveKeys.saveKeys-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
183
- <li class="tsd-description">
184
- <div class="tsd-comment tsd-typography"><p>Saves the keys in this archive to the secure store.</p>
185
- </div>
186
- <h4 class="tsd-returns-title">Returns <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></h4><aside class="tsd-sources">
187
- <ul>
188
- <li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:44</li></ul></aside></li></ul></section>
189
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="unarchive" class="tsd-anchor"></a>
190
- <h3 class="tsd-anchor-link"><span>unarchive</span><a href="#unarchive" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
191
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
192
- <li class="tsd-signature tsd-anchor-link" id="unarchive.unarchive-1">unarchive<span class="tsd-signature-symbol">(</span>password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#unarchive.unarchive-1" aria-label="Permalink" class="tsd-anchor-icon"><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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
193
- <li class="tsd-description">
194
- <div class="tsd-comment tsd-typography"><p>Decrypts and unarchives the keys in this archive.</p>
195
-
196
- <h3>Throws</h3><p><a href="../classes/KeyArchiveDecodingError.html">KeyArchiveDecodingError</a>
197
- If the archive is unable to be decoding according to the
198
- required structure.</p>
199
-
200
- <h3>Throws</h3><p><a href="../classes/KeyArchiveIncorrectPasswordError.html">KeyArchiveIncorrectPasswordError</a>
201
- If the archive is a secure archive and the password is unable to be
202
- used to decrypt the encrypted keys.</p>
203
-
204
- <h3>Throws</h3><p><a href="../classes/KeyArchivePasswordRequiredError.html">KeyArchivePasswordRequiredError</a>
205
- If the archive is a secure archive but no password is provided.</p>
206
-
207
- <h3>Throws</h3><p><a href="../classes/KeyArchiveNoPasswordRequiredError.html">KeyArchiveNoPasswordRequiredError</a>
208
- If the archive is an insecure archive but a password is provided.</p>
209
- </div>
210
- <div class="tsd-parameters">
211
- <h4 class="tsd-parameters-title">Parameters</h4>
212
- <ul class="tsd-parameter-list">
213
- <li>
214
- <h5>password: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ArrayBuffer</span></h5>
215
- <div class="tsd-comment tsd-typography"><p>The password to use to decrypt the archive if its a secure archive
216
- otherwise must be undefined.</p>
217
- </div></li></ul></div>
218
- <h4 class="tsd-returns-title">Returns <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></h4><aside class="tsd-sources">
219
- <ul>
220
- <li>Defined in src/sudoKeyArchive/sudoKeyArchive.ts:78</li></ul></aside></li></ul></section></section></div>
221
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
222
- <div class="tsd-navigation settings">
223
- <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
224
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
225
- <div class="tsd-accordion-details">
226
- <div class="tsd-filter-visibility">
227
- <h4 class="uppercase">Member Visibility</h4><form>
228
- <ul id="tsd-filter-options">
229
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
230
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
231
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
232
- <div class="tsd-theme-toggle">
233
- <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
234
- <nav class="tsd-navigation primary">
235
- <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
236
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
237
- <div class="tsd-accordion-details">
238
- <ul>
239
- <li><a href="../modules.html">@sudoplatform/sudo-<wbr/>common</a>
240
- <ul></ul></li></ul></div></details></nav>
241
- <nav class="tsd-navigation secondary menu-sticky">
242
- <ul>
243
- <li class="current tsd-kind-interface"><a href="SudoKeyArchive.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Sudo<wbr/>Key<wbr/>Archive</span></a>
244
- <ul>
245
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#archive" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>archive</a></li>
246
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#containsKey" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>contains<wbr/>Key</a></li>
247
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#getExcludedKeyTypes" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Excluded<wbr/>Key<wbr/>Types</a></li>
248
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#getExcludedKeys" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Excluded<wbr/>Keys</a></li>
249
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#getKeyData" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Key<wbr/>Data</a></li>
250
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#getMetaInfo" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Meta<wbr/>Info</a></li>
251
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#loadKeys" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>load<wbr/>Keys</a></li>
252
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#reset" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>reset</a></li>
253
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#saveKeys" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>save<wbr/>Keys</a></li>
254
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="SudoKeyArchive.html#unarchive" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>unarchive</a></li></ul></li></ul></nav></div></div>
255
- <div class="container tsd-generator">
256
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
257
- <div class="overlay"></div><script src="../assets/main.js"></script></body></html>