@sudoplatform/sudo-common 5.6.0 → 5.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (197) hide show
  1. package/CHANGELOG.md +5 -1
  2. package/bin/yarn-audit-with-suppression.sh +1 -1
  3. package/dependencies-report.json +2 -2
  4. package/docs/.nojekyll +1 -0
  5. package/docs/assets/highlight.css +57 -0
  6. package/docs/assets/icons.css +1043 -0
  7. package/docs/assets/{images/icons.png → icons.png} +0 -0
  8. package/docs/assets/{images/icons@2x.png → icons@2x.png} +0 -0
  9. package/docs/assets/main.js +52 -0
  10. package/docs/assets/search.js +1 -0
  11. package/docs/assets/style.css +1384 -0
  12. package/docs/assets/{images/widgets.png → widgets.png} +0 -0
  13. package/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
  14. package/docs/classes/AccountLockedError.html +7 -332
  15. package/docs/classes/AuthenticationError.html +8 -339
  16. package/docs/classes/Base64.html +3 -283
  17. package/docs/classes/Buffer.html +3 -324
  18. package/docs/classes/ConfigurationNotSetError.html +8 -333
  19. package/docs/classes/ConfigurationSetNotFoundError.html +7 -338
  20. package/docs/classes/DecodeError.html +7 -338
  21. package/docs/classes/DefaultConfigurationManager.html +18 -333
  22. package/docs/classes/DefaultLogger.html +19 -417
  23. package/docs/classes/DefaultSudoKeyArchive.html +61 -598
  24. package/docs/classes/DefaultSudoKeyManager.html +60 -1110
  25. package/docs/classes/FatalError.html +8 -339
  26. package/docs/classes/IllegalArgumentError.html +7 -338
  27. package/docs/classes/IllegalStateError.html +8 -339
  28. package/docs/classes/InsufficientEntitlementsError.html +8 -333
  29. package/docs/classes/InvalidOwnershipProofError.html +7 -332
  30. package/docs/classes/InvalidTokenError.html +7 -332
  31. package/docs/classes/KeyArchiveDecodingError.html +7 -338
  32. package/docs/classes/KeyArchiveIncorrectPasswordError.html +7 -338
  33. package/docs/classes/KeyArchiveMissingError.html +7 -338
  34. package/docs/classes/KeyArchiveNoPasswordRequiredError.html +7 -338
  35. package/docs/classes/KeyArchivePasswordRequiredError.html +7 -338
  36. package/docs/classes/KeyArchiveTypeError.html +7 -338
  37. package/docs/classes/KeyArchiveUnknownKeyTypeError.html +7 -338
  38. package/docs/classes/KeyArchiveVersionError.html +7 -338
  39. package/docs/classes/KeyNotFoundError.html +7 -338
  40. package/docs/classes/KeyStoreNotExportableError.html +7 -338
  41. package/docs/classes/LimitExceededError.html +8 -333
  42. package/docs/classes/NoEntitlementsError.html +7 -332
  43. package/docs/classes/NotAuthorizedError.html +8 -339
  44. package/docs/classes/NotRegisteredError.html +7 -338
  45. package/docs/classes/NotSignedInError.html +8 -333
  46. package/docs/classes/OperationNotImplementedError.html +7 -338
  47. package/docs/classes/RegisterError.html +8 -339
  48. package/docs/classes/RequestFailedError.html +12 -380
  49. package/docs/classes/ServiceError.html +9 -340
  50. package/docs/classes/SignOutError.html +7 -338
  51. package/docs/classes/SudoCryptoProviderDefaults.html +1 -224
  52. package/docs/classes/UnknownGraphQLError.html +7 -338
  53. package/docs/classes/UnrecognizedAlgorithmError.html +7 -0
  54. package/docs/classes/UserNotConfirmedError.html +8 -333
  55. package/docs/classes/VersionMismatchError.html +10 -335
  56. package/docs/enums/CachePolicy.html +4 -170
  57. package/docs/enums/EncryptionAlgorithm.html +5 -171
  58. package/docs/enums/KeyArchiveKeyType.html +4 -198
  59. package/docs/enums/KeyDataKeyFormat.html +18 -202
  60. package/docs/enums/KeyDataKeyType.html +3 -197
  61. package/docs/enums/ListOperationResultStatus.html +10 -0
  62. package/docs/enums/PublicKeyFormat.html +1 -162
  63. package/docs/index.html +14 -369
  64. package/docs/interfaces/AsymmetricEncryptionOptions.html +3 -163
  65. package/docs/interfaces/BooleanFilter.html +3 -177
  66. package/docs/interfaces/ConfigurationManager.html +37 -349
  67. package/docs/interfaces/KeyData.html +8 -236
  68. package/docs/interfaces/ListOperationFailureResult.html +5 -0
  69. package/docs/interfaces/ListOperationPartialResult.html +10 -0
  70. package/docs/interfaces/ListOperationSuccessResult.html +7 -0
  71. package/docs/interfaces/ListOutput.html +3 -185
  72. package/docs/interfaces/Logger.html +39 -401
  73. package/docs/interfaces/Owner.html +1 -170
  74. package/docs/interfaces/PublicKey.html +1 -170
  75. package/docs/interfaces/StringFilter.html +3 -191
  76. package/docs/interfaces/SudoCryptoProvider.html +172 -1305
  77. package/docs/interfaces/SudoKeyArchive.html +54 -490
  78. package/docs/interfaces/SudoKeyManager.html +167 -1298
  79. package/docs/interfaces/SymmetricEncryptionOptions.html +3 -177
  80. package/docs/modules.html +33 -895
  81. package/github/CHANGELOG.md +5 -1
  82. package/github/bin/yarn-audit-with-suppression.sh +1 -1
  83. package/github/docs/.nojekyll +1 -0
  84. package/github/docs/assets/highlight.css +57 -0
  85. package/github/docs/assets/icons.css +1043 -0
  86. package/github/docs/assets/{images/icons.png → icons.png} +0 -0
  87. package/github/docs/assets/{images/icons@2x.png → icons@2x.png} +0 -0
  88. package/github/docs/assets/main.js +52 -0
  89. package/github/docs/assets/search.js +1 -0
  90. package/github/docs/assets/style.css +1384 -0
  91. package/github/docs/assets/{images/widgets.png → widgets.png} +0 -0
  92. package/github/docs/assets/{images/widgets@2x.png → widgets@2x.png} +0 -0
  93. package/github/docs/classes/AccountLockedError.html +7 -332
  94. package/github/docs/classes/AuthenticationError.html +8 -339
  95. package/github/docs/classes/Base64.html +3 -283
  96. package/github/docs/classes/Buffer.html +3 -324
  97. package/github/docs/classes/ConfigurationNotSetError.html +8 -333
  98. package/github/docs/classes/ConfigurationSetNotFoundError.html +7 -338
  99. package/github/docs/classes/DecodeError.html +7 -338
  100. package/github/docs/classes/DefaultConfigurationManager.html +18 -333
  101. package/github/docs/classes/DefaultLogger.html +19 -417
  102. package/github/docs/classes/DefaultSudoKeyArchive.html +61 -598
  103. package/github/docs/classes/DefaultSudoKeyManager.html +60 -1110
  104. package/github/docs/classes/FatalError.html +8 -339
  105. package/github/docs/classes/IllegalArgumentError.html +7 -338
  106. package/github/docs/classes/IllegalStateError.html +8 -339
  107. package/github/docs/classes/InsufficientEntitlementsError.html +8 -333
  108. package/github/docs/classes/InvalidOwnershipProofError.html +7 -332
  109. package/github/docs/classes/InvalidTokenError.html +7 -332
  110. package/github/docs/classes/KeyArchiveDecodingError.html +7 -338
  111. package/github/docs/classes/KeyArchiveIncorrectPasswordError.html +7 -338
  112. package/github/docs/classes/KeyArchiveMissingError.html +7 -338
  113. package/github/docs/classes/KeyArchiveNoPasswordRequiredError.html +7 -338
  114. package/github/docs/classes/KeyArchivePasswordRequiredError.html +7 -338
  115. package/github/docs/classes/KeyArchiveTypeError.html +7 -338
  116. package/github/docs/classes/KeyArchiveUnknownKeyTypeError.html +7 -338
  117. package/github/docs/classes/KeyArchiveVersionError.html +7 -338
  118. package/github/docs/classes/KeyNotFoundError.html +7 -338
  119. package/github/docs/classes/KeyStoreNotExportableError.html +7 -338
  120. package/github/docs/classes/LimitExceededError.html +8 -333
  121. package/github/docs/classes/NoEntitlementsError.html +7 -332
  122. package/github/docs/classes/NotAuthorizedError.html +8 -339
  123. package/github/docs/classes/NotRegisteredError.html +7 -338
  124. package/github/docs/classes/NotSignedInError.html +8 -333
  125. package/github/docs/classes/OperationNotImplementedError.html +7 -338
  126. package/github/docs/classes/RegisterError.html +8 -339
  127. package/github/docs/classes/RequestFailedError.html +12 -380
  128. package/github/docs/classes/ServiceError.html +9 -340
  129. package/github/docs/classes/SignOutError.html +7 -338
  130. package/github/docs/classes/SudoCryptoProviderDefaults.html +1 -224
  131. package/github/docs/classes/UnknownGraphQLError.html +7 -338
  132. package/github/docs/classes/UnrecognizedAlgorithmError.html +7 -0
  133. package/github/docs/classes/UserNotConfirmedError.html +8 -333
  134. package/github/docs/classes/VersionMismatchError.html +10 -335
  135. package/github/docs/enums/CachePolicy.html +4 -170
  136. package/github/docs/enums/EncryptionAlgorithm.html +5 -171
  137. package/github/docs/enums/KeyArchiveKeyType.html +4 -198
  138. package/github/docs/enums/KeyDataKeyFormat.html +18 -202
  139. package/github/docs/enums/KeyDataKeyType.html +3 -197
  140. package/github/docs/enums/ListOperationResultStatus.html +10 -0
  141. package/github/docs/enums/PublicKeyFormat.html +1 -162
  142. package/github/docs/index.html +14 -369
  143. package/github/docs/interfaces/AsymmetricEncryptionOptions.html +3 -163
  144. package/github/docs/interfaces/BooleanFilter.html +3 -177
  145. package/github/docs/interfaces/ConfigurationManager.html +37 -349
  146. package/github/docs/interfaces/KeyData.html +8 -236
  147. package/github/docs/interfaces/ListOperationFailureResult.html +5 -0
  148. package/github/docs/interfaces/ListOperationPartialResult.html +10 -0
  149. package/github/docs/interfaces/ListOperationSuccessResult.html +7 -0
  150. package/github/docs/interfaces/ListOutput.html +3 -185
  151. package/github/docs/interfaces/Logger.html +39 -401
  152. package/github/docs/interfaces/Owner.html +1 -170
  153. package/github/docs/interfaces/PublicKey.html +1 -170
  154. package/github/docs/interfaces/StringFilter.html +3 -191
  155. package/github/docs/interfaces/SudoCryptoProvider.html +172 -1305
  156. package/github/docs/interfaces/SudoKeyArchive.html +54 -490
  157. package/github/docs/interfaces/SudoKeyManager.html +167 -1298
  158. package/github/docs/interfaces/SymmetricEncryptionOptions.html +3 -177
  159. package/github/docs/modules.html +33 -895
  160. package/github/package.json +19 -16
  161. package/github/src/errors/error.ts +10 -0
  162. package/github/src/sudoKeyArchive/sudoKeyArchive.ts +1 -1
  163. package/github/src/sudoKeyManager/sudoCryptoProvider.ts +12 -0
  164. package/github/src/sudoKeyManager/sudoKeyManager.ts +12 -0
  165. package/github/src/types/types.ts +78 -0
  166. package/github/test/utils/listOperationResult.spec.ts +84 -0
  167. package/github/yarn.lock +871 -1264
  168. package/lib/errors/error.d.ts +6 -0
  169. package/lib/errors/error.js +16 -2
  170. package/lib/logging/bunyanLogger.js +1 -1
  171. package/lib/sudoKeyArchive/keyArchive.js +2 -2
  172. package/lib/sudoKeyArchive/keyInfo.js +1 -1
  173. package/lib/sudoKeyArchive/sudoKeyArchive.d.ts +1 -2
  174. package/lib/sudoKeyArchive/sudoKeyArchive.js +1 -1
  175. package/lib/sudoKeyManager/keyData.js +1 -1
  176. package/lib/sudoKeyManager/sudoCryptoProvider.d.ts +12 -0
  177. package/lib/sudoKeyManager/sudoKeyManager.d.ts +12 -0
  178. package/lib/types/types.d.ts +71 -0
  179. package/lib/types/types.js +14 -2
  180. package/package.json +20 -17
  181. package/src/errors/error.ts +10 -0
  182. package/src/sudoKeyArchive/sudoKeyArchive.ts +1 -1
  183. package/src/sudoKeyManager/sudoCryptoProvider.ts +12 -0
  184. package/src/sudoKeyManager/sudoKeyManager.ts +12 -0
  185. package/src/types/types.ts +78 -0
  186. package/test/utils/listOperationResult.spec.ts +84 -0
  187. package/yarn.lock +871 -1264
  188. package/docs/assets/css/main.css +0 -2660
  189. package/docs/assets/js/main.js +0 -248
  190. package/docs/assets/js/search.js +0 -1
  191. package/github/docs/assets/css/main.css +0 -2660
  192. package/github/docs/assets/js/main.js +0 -248
  193. package/github/docs/assets/js/search.js +0 -1
  194. package/github/src/sudoKeyManager/encryptionAlgorithmTransformer.ts +0 -21
  195. package/lib/sudoKeyManager/encryptionAlgorithmTransformer.d.ts +0 -9
  196. package/lib/sudoKeyManager/encryptionAlgorithmTransformer.js +0 -28
  197. package/src/sudoKeyManager/encryptionAlgorithmTransformer.ts +0 -21
package/docs/interfaces/ConfigurationManager.html CHANGED
@@ -1,349 +1,37 @@
1
- <!doctype html>
2
- <html class="default no-js">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>ConfigurationManager | @sudoplatform/sudo-common</title>
7
- <meta name="description" content="Documentation for @sudoplatform/sudo-common">
8
- <meta name="viewport" content="width=device-width, initial-scale=1">
9
- <link rel="stylesheet" href="../assets/css/main.css">
10
- <script async src="../assets/js/search.js" id="search-script"></script>
11
- </head>
12
- <body>
13
- <header>
14
- <div class="tsd-page-toolbar">
15
- <div class="container">
16
- <div class="table-wrap">
17
- <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
- <div class="field">
19
- <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
- <input id="tsd-search-field" type="text" />
21
- </div>
22
- <ul class="results">
23
- <li class="state loading">Preparing search index...</li>
24
- <li class="state failure">The search index is not available</li>
25
- </ul>
26
- <a href="../index.html" class="title">@sudoplatform/sudo-common</a>
27
- </div>
28
- <div class="table-cell" id="tsd-widgets">
29
- <div id="tsd-filter">
30
- <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
- <div class="tsd-filter-group">
32
- <div class="tsd-select" id="tsd-filter-visibility">
33
- <span class="tsd-select-label">All</span>
34
- <ul class="tsd-select-list">
35
- <li data-value="public">Public</li>
36
- <li data-value="protected">Public/Protected</li>
37
- <li data-value="private" class="selected">All</li>
38
- </ul>
39
- </div>
40
- <input type="checkbox" id="tsd-filter-inherited" checked />
41
- <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
- <input type="checkbox" id="tsd-filter-externals" checked />
43
- <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
- </div>
45
- </div>
46
- <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
- </div>
48
- </div>
49
- </div>
50
- </div>
51
- <div class="tsd-page-title">
52
- <div class="container">
53
- <ul class="tsd-breadcrumb">
54
- <li>
55
- <a href="../modules.html">@sudoplatform/sudo-common</a>
56
- </li>
57
- <li>
58
- <a href="ConfigurationManager.html">ConfigurationManager</a>
59
- </li>
60
- </ul>
61
- <h1>Interface ConfigurationManager</h1>
62
- </div>
63
- </div>
64
- </header>
65
- <div class="container container-main">
66
- <div class="row">
67
- <div class="col-8 col-content">
68
- <section class="tsd-panel tsd-comment">
69
- <div class="tsd-comment tsd-typography">
70
- <div class="lead">
71
- <p>Interface that encapsulates the APIs common to all configuration manager implementations.
72
- A configuration manager should be a singleton that holds reference to a parsed config
73
- and returns the configuration set specific to a given namespace.</p>
74
- </div>
75
- </div>
76
- </section>
77
- <section class="tsd-panel tsd-hierarchy">
78
- <h3>Hierarchy</h3>
79
- <ul class="tsd-hierarchy">
80
- <li>
81
- <span class="target">ConfigurationManager</span>
82
- </li>
83
- </ul>
84
- </section>
85
- <section class="tsd-panel">
86
- <h3>Implemented by</h3>
87
- <ul class="tsd-hierarchy">
88
- <li><a href="../classes/DefaultConfigurationManager.html" class="tsd-signature-type" data-tsd-kind="Class">DefaultConfigurationManager</a></li>
89
- </ul>
90
- </section>
91
- <section class="tsd-panel-group tsd-index-group">
92
- <h2>Index</h2>
93
- <section class="tsd-panel tsd-index-panel">
94
- <div class="tsd-index-content">
95
- <section class="tsd-index-section ">
96
- <h3>Methods</h3>
97
- <ul class="tsd-index-list">
98
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a href="ConfigurationManager.html#bind" class="tsd-kind-icon">bind</a></li>
99
- <li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a href="ConfigurationManager.html#bindConfigSet" class="tsd-kind-icon">bind<wbr>Config<wbr>Set</a></li>
100
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="ConfigurationManager.html#getConfigSet" class="tsd-kind-icon">get<wbr>Config<wbr>Set</a></li>
101
- <li class="tsd-kind-method tsd-parent-kind-interface"><a href="ConfigurationManager.html#setConfig" class="tsd-kind-icon">set<wbr>Config</a></li>
102
- </ul>
103
- </section>
104
- </div>
105
- </section>
106
- </section>
107
- <section class="tsd-panel-group tsd-member-group ">
108
- <h2>Methods</h2>
109
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter">
110
- <a name="bind" class="tsd-anchor"></a>
111
- <h3>bind</h3>
112
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter">
113
- <li class="tsd-signature tsd-kind-icon">bind&lt;T&gt;<span class="tsd-signature-symbol">(</span>configSet<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span>, codec<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Mixed</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></li>
114
- </ul>
115
- <ul class="tsd-descriptions">
116
- <li class="tsd-description">
117
- <aside class="tsd-sources">
118
- <ul>
119
- <li>Defined in src/configurationManager/defaultConfigurationManager.ts:47</li>
120
- </ul>
121
- </aside>
122
- <div class="tsd-comment tsd-typography">
123
- <div class="lead">
124
- <p>Decode a configuration set to a given type</p>
125
- </div>
126
- <dl class="tsd-comment-tags">
127
- <dt>throws</dt>
128
- <dd><p><a href="../classes/DecodeError.html">DecodeError</a></p>
129
- </dd>
130
- </dl>
131
- </div>
132
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
133
- <ul class="tsd-type-parameters">
134
- <li>
135
- <h4>T</h4>
136
- </li>
137
- </ul>
138
- <h4 class="tsd-parameters-title">Parameters</h4>
139
- <ul class="tsd-parameters">
140
- <li>
141
- <h5>configSet: <span class="tsd-signature-type">unknown</span></h5>
142
- <div class="tsd-comment tsd-typography">
143
- <p>Configuration set specific to a given namespace</p>
144
- </div>
145
- </li>
146
- <li>
147
- <h5>codec: <span class="tsd-signature-type">Mixed</span></h5>
148
- <div class="tsd-comment tsd-typography">
149
- <p>The codec to bind the configuration set to</p>
150
- </div>
151
- </li>
152
- </ul>
153
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
154
- <p>Configuration as a given type</p>
155
- </li>
156
- </ul>
157
- </section>
158
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter">
159
- <a name="bindConfigSet" class="tsd-anchor"></a>
160
- <h3>bind<wbr>Config<wbr>Set</h3>
161
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter">
162
- <li class="tsd-signature tsd-kind-icon">bind<wbr>Config<wbr>Set&lt;T&gt;<span class="tsd-signature-symbol">(</span>codec<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Mixed</span>, namespace<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">T</span></li>
163
- </ul>
164
- <ul class="tsd-descriptions">
165
- <li class="tsd-description">
166
- <aside class="tsd-sources">
167
- <ul>
168
- <li>Defined in src/configurationManager/defaultConfigurationManager.ts:64</li>
169
- </ul>
170
- </aside>
171
- <div class="tsd-comment tsd-typography">
172
- <div class="lead">
173
- <p>Get a configuration by namespace and decode and validate
174
- that configuration set to a given type. If no namespace
175
- provided, try and use the whole configuration object
176
- to bind to the given type.</p>
177
- </div>
178
- <dl class="tsd-comment-tags">
179
- <dt>throws</dt>
180
- <dd><p><a href="../classes/ConfigurationNotSetError.html">ConfigurationNotSetError</a></p>
181
- </dd>
182
- <dt>throws</dt>
183
- <dd><p><a href="../classes/ConfigurationSetNotFoundError.html">ConfigurationSetNotFoundError</a></p>
184
- </dd>
185
- <dt>throws</dt>
186
- <dd><p><a href="../classes/DecodeError.html">DecodeError</a></p>
187
- </dd>
188
- </dl>
189
- </div>
190
- <h4 class="tsd-type-parameters-title">Type parameters</h4>
191
- <ul class="tsd-type-parameters">
192
- <li>
193
- <h4>T</h4>
194
- </li>
195
- </ul>
196
- <h4 class="tsd-parameters-title">Parameters</h4>
197
- <ul class="tsd-parameters">
198
- <li>
199
- <h5>codec: <span class="tsd-signature-type">Mixed</span></h5>
200
- <div class="tsd-comment tsd-typography">
201
- <p>The codec to bind the configuration set to</p>
202
- </div>
203
- </li>
204
- <li>
205
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> namespace: <span class="tsd-signature-type">string</span></h5>
206
- <div class="tsd-comment tsd-typography">
207
- <p>The key for the nested json object or undefined</p>
208
- </div>
209
- </li>
210
- </ul>
211
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span></h4>
212
- <p>Configuration as a given type</p>
213
- </li>
214
- </ul>
215
- </section>
216
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
217
- <a name="getConfigSet" class="tsd-anchor"></a>
218
- <h3>get<wbr>Config<wbr>Set</h3>
219
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
220
- <li class="tsd-signature tsd-kind-icon">get<wbr>Config<wbr>Set<span class="tsd-signature-symbol">(</span>namespace<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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li>
221
- </ul>
222
- <ul class="tsd-descriptions">
223
- <li class="tsd-description">
224
- <aside class="tsd-sources">
225
- <ul>
226
- <li>Defined in src/configurationManager/defaultConfigurationManager.ts:35</li>
227
- </ul>
228
- </aside>
229
- <div class="tsd-comment tsd-typography">
230
- <div class="lead">
231
- <p>Get a subset of configuration by namespace</p>
232
- </div>
233
- <dl class="tsd-comment-tags">
234
- <dt>throws</dt>
235
- <dd><p><a href="../classes/ConfigurationNotSetError.html">ConfigurationNotSetError</a></p>
236
- </dd>
237
- </dl>
238
- </div>
239
- <h4 class="tsd-parameters-title">Parameters</h4>
240
- <ul class="tsd-parameters">
241
- <li>
242
- <h5><span class="tsd-flag ts-flagOptional">Optional</span> namespace: <span class="tsd-signature-type">string</span></h5>
243
- <div class="tsd-comment tsd-typography">
244
- <p>The key for the nested json object</p>
245
- </div>
246
- </li>
247
- </ul>
248
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4>
249
- <p>Configuration set specific to a given namespace</p>
250
- </li>
251
- </ul>
252
- </section>
253
- <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
254
- <a name="setConfig" class="tsd-anchor"></a>
255
- <h3>set<wbr>Config</h3>
256
- <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
257
- <li class="tsd-signature tsd-kind-icon">set<wbr>Config<span class="tsd-signature-symbol">(</span>config<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><a href="ConfigurationManager.html" class="tsd-signature-type" data-tsd-kind="Interface">ConfigurationManager</a></li>
258
- </ul>
259
- <ul class="tsd-descriptions">
260
- <li class="tsd-description">
261
- <aside class="tsd-sources">
262
- <ul>
263
- <li>Defined in src/configurationManager/defaultConfigurationManager.ts:24</li>
264
- </ul>
265
- </aside>
266
- <div class="tsd-comment tsd-typography">
267
- <div class="lead">
268
- <p>Set config that will be parsed as JSON</p>
269
- </div>
270
- </div>
271
- <h4 class="tsd-parameters-title">Parameters</h4>
272
- <ul class="tsd-parameters">
273
- <li>
274
- <h5>config: <span class="tsd-signature-type">string</span></h5>
275
- <div class="tsd-comment tsd-typography">
276
- <p>A string representation of configuration</p>
277
- </div>
278
- </li>
279
- </ul>
280
- <h4 class="tsd-returns-title">Returns <a href="ConfigurationManager.html" class="tsd-signature-type" data-tsd-kind="Interface">ConfigurationManager</a></h4>
281
- <p>ConfigurationManager</p>
282
- </li>
283
- </ul>
284
- </section>
285
- </section>
286
- </div>
287
- <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
288
- <nav class="tsd-navigation primary">
289
- <ul>
290
- <li class=" ">
291
- <a href="../modules.html">Exports</a>
292
- </li>
293
- </ul>
294
- </nav>
295
- <nav class="tsd-navigation secondary menu-sticky">
296
- <ul class="before-current">
297
- </ul>
298
- <ul class="current">
299
- <li class="current tsd-kind-interface">
300
- <a href="ConfigurationManager.html" class="tsd-kind-icon">Configuration<wbr>Manager</a>
301
- <ul>
302
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter">
303
- <a href="ConfigurationManager.html#bind" class="tsd-kind-icon">bind</a>
304
- </li>
305
- <li class=" tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter">
306
- <a href="ConfigurationManager.html#bindConfigSet" class="tsd-kind-icon">bind<wbr>Config<wbr>Set</a>
307
- </li>
308
- <li class=" tsd-kind-method tsd-parent-kind-interface">
309
- <a href="ConfigurationManager.html#getConfigSet" class="tsd-kind-icon">get<wbr>Config<wbr>Set</a>
310
- </li>
311
- <li class=" tsd-kind-method tsd-parent-kind-interface">
312
- <a href="ConfigurationManager.html#setConfig" class="tsd-kind-icon">set<wbr>Config</a>
313
- </li>
314
- </ul>
315
- </li>
316
- </ul>
317
- <ul class="after-current">
318
- </ul>
319
- </nav>
320
- </div>
321
- </div>
322
- </div>
323
- <footer class="with-border-bottom">
324
- <div class="container">
325
- <h2>Legend</h2>
326
- <div class="tsd-legend-group">
327
- <ul class="tsd-legend">
328
- <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
329
- <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
330
- <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
331
- </ul>
332
- <ul class="tsd-legend">
333
- <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
334
- <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
335
- </ul>
336
- <ul class="tsd-legend">
337
- <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
338
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
339
- </ul>
340
- </div>
341
- </div>
342
- </footer>
343
- <div class="container tsd-generator">
344
- <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
345
- </div>
346
- <div class="overlay"></div>
347
- <script src="../assets/js/main.js"></script>
348
- </body>
349
- </html>
1
+ <!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>ConfigurationManager | @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><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="ConfigurationManager.html">ConfigurationManager</a></li></ul><h1>Interface ConfigurationManager</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
+ <p>Interface that encapsulates the APIs common to all configuration manager implementations.
3
+ A configuration manager should be a singleton that holds reference to a parsed config
4
+ and returns the configuration set specific to a given namespace.</p>
5
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ConfigurationManager</span></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="../classes/DefaultConfigurationManager.html" class="tsd-signature-type" data-tsd-kind="Class">DefaultConfigurationManager</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 tsd-has-type-parameter"><a href="ConfigurationManager.html#bind" class="tsd-kind-icon">bind</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a href="ConfigurationManager.html#bindConfigSet" class="tsd-kind-icon">bind<wbr/>Config<wbr/>Set</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="ConfigurationManager.html#getConfigSet" class="tsd-kind-icon">get<wbr/>Config<wbr/>Set</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="ConfigurationManager.html#setConfig" class="tsd-kind-icon">set<wbr/>Config</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 tsd-has-type-parameter"><a name="bind" class="tsd-anchor"></a><h3>bind</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">bind&lt;T&gt;<span class="tsd-signature-symbol">(</span>configSet<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span>, codec<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Mixed</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/configurationManager/defaultConfigurationManager.ts:47</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6
+ <p>Decode a configuration set to a given type</p>
7
+ </div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><a href="../classes/DecodeError.html">DecodeError</a></p>
8
+ </dd></dl></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>configSet: <span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
9
+ <p>Configuration set specific to a given namespace</p>
10
+ </div></div></li><li><h5>codec: <span class="tsd-signature-type">Mixed</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
11
+ <p>The codec to bind the configuration set to</p>
12
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h4><div><p>Configuration as a given type</p>
13
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a name="bindConfigSet" class="tsd-anchor"></a><h3>bind<wbr/>Config<wbr/>Set</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">bind<wbr/>Config<wbr/>Set&lt;T&gt;<span class="tsd-signature-symbol">(</span>codec<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Mixed</span>, namespace<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" data-tsd-kind="Type parameter">T</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/configurationManager/defaultConfigurationManager.ts:64</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
14
+ <p>Get a configuration by namespace and decode and validate
15
+ that configuration set to a given type. If no namespace
16
+ provided, try and use the whole configuration object
17
+ to bind to the given type.</p>
18
+ </div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><a href="../classes/ConfigurationNotSetError.html">ConfigurationNotSetError</a></p>
19
+ </dd><dt>throws</dt><dd><p><a href="../classes/ConfigurationSetNotFoundError.html">ConfigurationSetNotFoundError</a></p>
20
+ </dd><dt>throws</dt><dd><p><a href="../classes/DecodeError.html">DecodeError</a></p>
21
+ </dd></dl></div><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>codec: <span class="tsd-signature-type">Mixed</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
22
+ <p>The codec to bind the configuration set to</p>
23
+ </div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> namespace: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
24
+ <p>The key for the nested json object or undefined</p>
25
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h4><div><p>Configuration as a given type</p>
26
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="getConfigSet" class="tsd-anchor"></a><h3>get<wbr/>Config<wbr/>Set</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Config<wbr/>Set<span class="tsd-signature-symbol">(</span>namespace<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">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/configurationManager/defaultConfigurationManager.ts:35</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
27
+ <p>Get a subset of configuration by namespace</p>
28
+ </div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p><a href="../classes/ConfigurationNotSetError.html">ConfigurationNotSetError</a></p>
29
+ </dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> namespace: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
30
+ <p>The key for the nested json object</p>
31
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4><div><p>Configuration set specific to a given namespace</p>
32
+ </div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a name="setConfig" class="tsd-anchor"></a><h3>set<wbr/>Config</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">set<wbr/>Config<span class="tsd-signature-symbol">(</span>config<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><a href="ConfigurationManager.html" class="tsd-signature-type" data-tsd-kind="Interface">ConfigurationManager</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in src/configurationManager/defaultConfigurationManager.ts:24</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
33
+ <p>Set config that will be parsed as JSON</p>
34
+ </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>config: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
35
+ <p>A string representation of configuration</p>
36
+ </div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ConfigurationManager.html" class="tsd-signature-type" data-tsd-kind="Interface">ConfigurationManager</a></h4><div><p>ConfigurationManager</p>
37
+ </div></li></ul></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="ConfigurationManager.html" class="tsd-kind-icon">Configuration<wbr/>Manager</a><ul><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a href="ConfigurationManager.html#bind" class="tsd-kind-icon">bind</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-has-type-parameter"><a href="ConfigurationManager.html#bindConfigSet" class="tsd-kind-icon">bind<wbr/>Config<wbr/>Set</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="ConfigurationManager.html#getConfigSet" class="tsd-kind-icon">get<wbr/>Config<wbr/>Set</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="ConfigurationManager.html#setConfig" class="tsd-kind-icon">set<wbr/>Config</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>