@rxap/config 19.3.0-dev.4 → 21.0.1-dev.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 (161) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/compodoc/changelog.html +26 -0
  3. package/compodoc/dependencies.html +6 -6
  4. package/compodoc/index.html +69 -1
  5. package/compodoc/injectables/ConfigService.html +210 -102
  6. package/compodoc/interfaces/ConfigLoadError.html +610 -0
  7. package/compodoc/interfaces/ConfigLoadOptions.html +213 -66
  8. package/compodoc/js/menu-wc.js +3 -0
  9. package/compodoc/js/menu-wc_es5.js +1 -1
  10. package/compodoc/js/search/search_index.js +2 -2
  11. package/compodoc/miscellaneous/functions.html +130 -1
  12. package/compodoc/miscellaneous/typealiases.html +78 -0
  13. package/compodoc/overview.html +1 -1
  14. package/compodoc/properties.html +1 -1
  15. package/docs/documentation.json +2445 -1297
  16. package/docs/html/assets/hierarchy.js +1 -1
  17. package/docs/html/assets/highlight.css +42 -0
  18. package/docs/html/assets/navigation.js +1 -1
  19. package/docs/html/assets/search.js +1 -1
  20. package/docs/html/classes/ConfigLoaderService.html +2 -2
  21. package/docs/html/classes/ConfigService.html +8 -6
  22. package/docs/html/classes/ConfigTestingService.html +2 -2
  23. package/docs/html/enums/ConfigLoadMethod.html +2 -2
  24. package/docs/html/enums/ConfigLoadingStrategy.html +2 -2
  25. package/docs/html/functions/ProvideConfig.html +1 -1
  26. package/docs/html/functions/defaultConfigLoadErrorHandler.html +4 -0
  27. package/docs/html/functions/dnsLookup.html +1 -1
  28. package/docs/html/functions/dnsResolver.html +1 -1
  29. package/docs/html/functions/fetchCidContent.html +1 -1
  30. package/docs/html/functions/fetchCidContentAsJson.html +1 -1
  31. package/docs/html/functions/fetchCidContentViaHttp.html +1 -1
  32. package/docs/html/functions/fetchContentViaHttp.html +1 -1
  33. package/docs/html/functions/localPathIpfsGateway.html +1 -1
  34. package/docs/html/functions/localSubDomainIpfsGateway.html +1 -1
  35. package/docs/html/functions/raceSuccess.html +2 -2
  36. package/docs/html/functions/showConfigLoadError.html +2 -0
  37. package/docs/html/functions/storachaIpfsGateway.html +1 -1
  38. package/docs/html/functions/w3sIpfsGateway.html +1 -1
  39. package/docs/html/hierarchy.html +1 -1
  40. package/docs/html/index.html +54 -2
  41. package/docs/html/interfaces/AppsNavigationConfig.html +2 -2
  42. package/docs/html/interfaces/Config.html +2 -2
  43. package/docs/html/interfaces/ConfigLoadError.html +11 -0
  44. package/docs/html/interfaces/ConfigLoadOptions.html +13 -6
  45. package/docs/html/interfaces/LogoConfig.html +2 -2
  46. package/docs/html/interfaces/NavigationConfig.html +2 -2
  47. package/docs/html/interfaces/Oauth2Config.html +2 -2
  48. package/docs/html/interfaces/i18nConfig.html +2 -2
  49. package/docs/html/modules.html +1 -1
  50. package/docs/html/types/AnySchema.html +1 -1
  51. package/docs/html/types/ConfigLoadErrorHandler.html +2 -0
  52. package/docs/html/types/ConfigLoadErrorKind.html +9 -0
  53. package/docs/html/types/ConfigRequestOptions.html +1 -0
  54. package/docs/html/types/IpfsGatewayFunction.html +1 -1
  55. package/docs/html/types/Join.html +1 -1
  56. package/docs/html/types/LanguagesConfig.html +1 -1
  57. package/docs/html/types/Leaves.html +1 -1
  58. package/docs/html/types/NoInferType.html +1 -1
  59. package/docs/html/types/Paths.html +1 -1
  60. package/docs/html/variables/RXAP_CONFIG.html +1 -1
  61. package/docs/html/variables/defaultDnsServers.html +1 -1
  62. package/docs/html/variables/defaultIpfsGatewayServers.html +1 -1
  63. package/docs/markdown/README.md +54 -1
  64. package/docs/markdown/classes/ConfigLoaderService.md +7 -7
  65. package/docs/markdown/classes/ConfigService.md +37 -23
  66. package/docs/markdown/classes/ConfigTestingService.md +8 -8
  67. package/docs/markdown/enumerations/ConfigLoadMethod.md +6 -6
  68. package/docs/markdown/enumerations/ConfigLoadingStrategy.md +4 -4
  69. package/docs/markdown/functions/ProvideConfig.md +2 -2
  70. package/docs/markdown/functions/defaultConfigLoadErrorHandler.md +26 -0
  71. package/docs/markdown/functions/dnsLookup.md +2 -2
  72. package/docs/markdown/functions/dnsResolver.md +2 -2
  73. package/docs/markdown/functions/fetchCidContent.md +2 -2
  74. package/docs/markdown/functions/fetchCidContentAsJson.md +2 -2
  75. package/docs/markdown/functions/fetchCidContentViaHttp.md +2 -2
  76. package/docs/markdown/functions/fetchContentViaHttp.md +2 -2
  77. package/docs/markdown/functions/localPathIpfsGateway.md +2 -2
  78. package/docs/markdown/functions/localSubDomainIpfsGateway.md +2 -2
  79. package/docs/markdown/functions/raceSuccess.md +2 -2
  80. package/docs/markdown/functions/showConfigLoadError.md +23 -0
  81. package/docs/markdown/functions/storachaIpfsGateway.md +2 -2
  82. package/docs/markdown/functions/w3sIpfsGateway.md +2 -2
  83. package/docs/markdown/globals.md +8 -2
  84. package/docs/markdown/interfaces/AppsNavigationConfig.md +12 -12
  85. package/docs/markdown/interfaces/Config.md +6 -6
  86. package/docs/markdown/interfaces/ConfigLoadError.md +70 -0
  87. package/docs/markdown/interfaces/ConfigLoadOptions.md +39 -15
  88. package/docs/markdown/interfaces/LogoConfig.md +5 -5
  89. package/docs/markdown/interfaces/NavigationConfig.md +9 -9
  90. package/docs/markdown/interfaces/Oauth2Config.md +3 -3
  91. package/docs/markdown/interfaces/i18nConfig.md +4 -4
  92. package/docs/markdown/type-aliases/AnySchema.md +2 -2
  93. package/docs/markdown/type-aliases/ConfigLoadErrorHandler.md +23 -0
  94. package/docs/markdown/type-aliases/ConfigLoadErrorKind.md +19 -0
  95. package/docs/markdown/type-aliases/ConfigRequestOptions.md +11 -0
  96. package/docs/markdown/type-aliases/IpfsGatewayFunction.md +2 -2
  97. package/docs/markdown/type-aliases/Join.md +2 -2
  98. package/docs/markdown/type-aliases/LanguagesConfig.md +2 -2
  99. package/docs/markdown/type-aliases/Leaves.md +2 -2
  100. package/docs/markdown/type-aliases/NoInferType.md +2 -2
  101. package/docs/markdown/type-aliases/Paths.md +2 -2
  102. package/docs/markdown/variables/RXAP_CONFIG.md +2 -2
  103. package/docs/markdown/variables/defaultDnsServers.md +2 -2
  104. package/docs/markdown/variables/defaultIpfsGatewayServers.md +2 -2
  105. package/docs/wiki/Class.ConfigLoaderService.md +6 -6
  106. package/docs/wiki/Class.ConfigService.md +36 -22
  107. package/docs/wiki/Class.ConfigTestingService.md +7 -7
  108. package/docs/wiki/Enumeration.ConfigLoadMethod.md +5 -5
  109. package/docs/wiki/Enumeration.ConfigLoadingStrategy.md +3 -3
  110. package/docs/wiki/Function.ProvideConfig.md +1 -1
  111. package/docs/wiki/Function.defaultConfigLoadErrorHandler.md +22 -0
  112. package/docs/wiki/Function.dnsLookup.md +1 -1
  113. package/docs/wiki/Function.dnsResolver.md +1 -1
  114. package/docs/wiki/Function.fetchCidContent.md +1 -1
  115. package/docs/wiki/Function.fetchCidContentAsJson.md +1 -1
  116. package/docs/wiki/Function.fetchCidContentViaHttp.md +1 -1
  117. package/docs/wiki/Function.fetchContentViaHttp.md +1 -1
  118. package/docs/wiki/Function.localPathIpfsGateway.md +1 -1
  119. package/docs/wiki/Function.localSubDomainIpfsGateway.md +1 -1
  120. package/docs/wiki/Function.raceSuccess.md +1 -1
  121. package/docs/wiki/Function.showConfigLoadError.md +19 -0
  122. package/docs/wiki/Function.storachaIpfsGateway.md +1 -1
  123. package/docs/wiki/Function.w3sIpfsGateway.md +1 -1
  124. package/docs/wiki/Home.md +53 -0
  125. package/docs/wiki/Interface.AppsNavigationConfig.md +11 -11
  126. package/docs/wiki/Interface.Config.md +5 -5
  127. package/docs/wiki/Interface.ConfigLoadError.md +66 -0
  128. package/docs/wiki/Interface.ConfigLoadOptions.md +38 -14
  129. package/docs/wiki/Interface.LogoConfig.md +4 -4
  130. package/docs/wiki/Interface.NavigationConfig.md +8 -8
  131. package/docs/wiki/Interface.Oauth2Config.md +2 -2
  132. package/docs/wiki/Interface.i18nConfig.md +3 -3
  133. package/docs/wiki/TypeAlias.AnySchema.md +1 -1
  134. package/docs/wiki/TypeAlias.ConfigLoadErrorHandler.md +19 -0
  135. package/docs/wiki/TypeAlias.ConfigLoadErrorKind.md +15 -0
  136. package/docs/wiki/TypeAlias.ConfigRequestOptions.md +7 -0
  137. package/docs/wiki/TypeAlias.IpfsGatewayFunction.md +1 -1
  138. package/docs/wiki/TypeAlias.Join.md +1 -1
  139. package/docs/wiki/TypeAlias.LanguagesConfig.md +1 -1
  140. package/docs/wiki/TypeAlias.Leaves.md +1 -1
  141. package/docs/wiki/TypeAlias.NoInferType.md +1 -1
  142. package/docs/wiki/TypeAlias.Paths.md +1 -1
  143. package/docs/wiki/Variable.RXAP_CONFIG.md +1 -1
  144. package/docs/wiki/Variable.defaultDnsServers.md +1 -1
  145. package/docs/wiki/Variable.defaultIpfsGatewayServers.md +1 -1
  146. package/docs/wiki/_Sidebar.md +6 -0
  147. package/docs/wiki/globals.md +7 -1
  148. package/fesm2022/rxap-config.mjs +10 -10
  149. package/fesm2022/rxap-config.mjs.map +1 -1
  150. package/package.json +15 -14
  151. package/types/rxap-config.d.ts +298 -0
  152. package/index.d.ts +0 -9
  153. package/lib/config-load-error.d.ts +0 -41
  154. package/lib/config-loader.service.d.ts +0 -12
  155. package/lib/config-testing-service.d.ts +0 -12
  156. package/lib/config.d.ts +0 -41
  157. package/lib/config.service.d.ts +0 -129
  158. package/lib/provide-config.d.ts +0 -4
  159. package/lib/tokens.d.ts +0 -2
  160. package/lib/types.d.ts +0 -34
  161. package/lib/utilities.d.ts +0 -19
@@ -111,6 +111,9 @@
111
111
  <tr>
112
112
  <td class="col-md-4">
113
113
  <ul class="index-list">
114
+ <li>
115
+ <a href="#defaultConfigLoadErrorHandler" title="src/lib/config-load-error.ts" ><b>defaultConfigLoadErrorHandler</b>&nbsp;&nbsp;&nbsp;(src/.../config-load-error.ts)</a>
116
+ </li>
114
117
  <li>
115
118
  <a href="#dnsLookup" title="src/lib/utilities.ts" ><b>dnsLookup</b>&nbsp;&nbsp;&nbsp;(src/.../utilities.ts)</a>
116
119
  </li>
@@ -138,6 +141,9 @@
138
141
  <li>
139
142
  <a href="#raceSuccess" title="src/lib/utilities.ts" ><b>raceSuccess</b>&nbsp;&nbsp;&nbsp;(src/.../utilities.ts)</a>
140
143
  </li>
144
+ <li>
145
+ <a href="#showConfigLoadError" title="src/lib/config-load-error.ts" ><b>showConfigLoadError</b>&nbsp;&nbsp;&nbsp;(src/.../config-load-error.ts)</a>
146
+ </li>
141
147
  </ul>
142
148
  </td>
143
149
  </tr>
@@ -145,7 +151,130 @@
145
151
  </table>
146
152
  </section>
147
153
 
148
- <h3>src/lib/utilities.ts</h3>
154
+ <h3>src/lib/config-load-error.ts</h3>
155
+ <section data-compodoc="block-methods">
156
+ <h3></h3> <table class="table table-sm table-bordered">
157
+ <tbody>
158
+ <tr>
159
+ <td class="col-md-4">
160
+ <a name="defaultConfigLoadErrorHandler"></a>
161
+ <span class="name">
162
+ <span ><b>defaultConfigLoadErrorHandler</b></span>
163
+ <a href="#defaultConfigLoadErrorHandler"><span class="icon ion-ios-link"></span></a>
164
+ </span>
165
+ </td>
166
+ </tr>
167
+ <tr>
168
+ <td class="col-md-4">
169
+ <code>defaultConfigLoadErrorHandler(error: <a href="../interfaces/ConfigLoadError.html" target="_self">ConfigLoadError</a>)</code>
170
+ </td>
171
+ </tr>
172
+
173
+
174
+
175
+
176
+ <tr>
177
+ <td class="col-md-4">
178
+ <div class="io-description"><p>The default config load error handler. Shows the error message in an overlay and reloads the
179
+ page after 30 s for required config urls. Logs a warning for optional config urls.</p>
180
+ <p>Can be used as fallback in a custom error handler for error kinds it does not handle.</p>
181
+ </div>
182
+
183
+ <div class="io-description">
184
+ <b>Parameters :</b>
185
+
186
+ <table class="params">
187
+ <thead>
188
+ <tr>
189
+ <td>Name</td>
190
+ <td>Type</td>
191
+ <td>Optional</td>
192
+ </tr>
193
+ </thead>
194
+ <tbody>
195
+ <tr>
196
+ <td>error</td>
197
+ <td>
198
+ <code><a href="../interfaces/ConfigLoadError.html" target="_self" >ConfigLoadError</a></code>
199
+ </td>
200
+
201
+ <td>
202
+ No
203
+ </td>
204
+
205
+
206
+ </tr>
207
+ </tbody>
208
+ </table>
209
+ </div>
210
+ <div class="io-description">
211
+ <b>Returns : </b> <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
212
+
213
+ </div>
214
+ <div class="io-description">
215
+
216
+ </div>
217
+ </td>
218
+ </tr>
219
+ </tbody>
220
+ </table>
221
+ <table class="table table-sm table-bordered">
222
+ <tbody>
223
+ <tr>
224
+ <td class="col-md-4">
225
+ <a name="showConfigLoadError"></a>
226
+ <span class="name">
227
+ <span ><b>showConfigLoadError</b></span>
228
+ <a href="#showConfigLoadError"><span class="icon ion-ios-link"></span></a>
229
+ </span>
230
+ </td>
231
+ </tr>
232
+ <tr>
233
+ <td class="col-md-4">
234
+ <code>showConfigLoadError(message: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
235
+ </td>
236
+ </tr>
237
+
238
+
239
+
240
+
241
+ <tr>
242
+ <td class="col-md-4">
243
+ <div class="io-description"><p>Appends the message to the config error overlay and schedules a page reload in 30 s.</p>
244
+ </div>
245
+
246
+ <div class="io-description">
247
+ <b>Parameters :</b>
248
+
249
+ <table class="params">
250
+ <thead>
251
+ <tr>
252
+ <td>Name</td>
253
+ <td>Type</td>
254
+ <td>Optional</td>
255
+ </tr>
256
+ </thead>
257
+ <tbody>
258
+ <tr>
259
+ <td>message</td>
260
+ <td>
261
+ <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
262
+ </td>
263
+
264
+ <td>
265
+ No
266
+ </td>
267
+
268
+
269
+ </tr>
270
+ </tbody>
271
+ </table>
272
+ </div>
273
+ </td>
274
+ </tr>
275
+ </tbody>
276
+ </table>
277
+ </section> <h3>src/lib/utilities.ts</h3>
149
278
  <section data-compodoc="block-methods">
150
279
  <h3></h3> <table class="table table-sm table-bordered">
151
280
  <tbody>
@@ -114,6 +114,15 @@
114
114
  <li>
115
115
  <a href="#AnySchema" title="src/lib/config.service.ts" ><b>AnySchema</b>&nbsp;&nbsp;&nbsp;(src/.../config.service.ts)</a>
116
116
  </li>
117
+ <li>
118
+ <a href="#ConfigLoadErrorHandler" title="src/lib/config-load-error.ts" ><b>ConfigLoadErrorHandler</b>&nbsp;&nbsp;&nbsp;(src/.../config-load-error.ts)</a>
119
+ </li>
120
+ <li>
121
+ <a href="#ConfigLoadErrorKind" title="src/lib/config-load-error.ts" ><b>ConfigLoadErrorKind</b>&nbsp;&nbsp;&nbsp;(src/.../config-load-error.ts)</a>
122
+ </li>
123
+ <li>
124
+ <a href="#ConfigRequestOptions" title="src/lib/config.service.ts" ><b>ConfigRequestOptions</b>&nbsp;&nbsp;&nbsp;(src/.../config.service.ts)</a>
125
+ </li>
117
126
  <li>
118
127
  <a href="#IpfsGatewayFunction" title="src/lib/utilities.ts" ><b>IpfsGatewayFunction</b>&nbsp;&nbsp;&nbsp;(src/.../utilities.ts)</a>
119
128
  </li>
@@ -155,6 +164,75 @@
155
164
  <tr>
156
165
  <td class="col-md-4">
157
166
  <code> <code>literal type</code>
167
+ </code>
168
+ </td>
169
+ </tr>
170
+ </tbody>
171
+ </table>
172
+ <table class="table table-sm table-bordered">
173
+ <tbody>
174
+ <tr>
175
+ <td class="col-md-4">
176
+ <a name="ConfigRequestOptions"></a>
177
+ <span class="name "><b>ConfigRequestOptions</b><a href="#ConfigRequestOptions"><span class="icon ion-ios-link"></span></a></span>
178
+ </td>
179
+ </tr>
180
+ <tr>
181
+ <td class="col-md-4">
182
+ <code> <code>Pick&lt;ConfigLoadOptions | &quot;errorHandler&quot; | &quot;requestInit&quot;&gt;</code>
183
+ </code>
184
+ </td>
185
+ </tr>
186
+ </tbody>
187
+ </table>
188
+ </section> <h3>src/lib/config-load-error.ts</h3>
189
+ <section data-compodoc="block-typealias">
190
+ <table class="table table-sm table-bordered">
191
+ <tbody>
192
+ <tr>
193
+ <td class="col-md-4">
194
+ <a name="ConfigLoadErrorHandler"></a>
195
+ <span class="name "><b>ConfigLoadErrorHandler</b><a href="#ConfigLoadErrorHandler"><span class="icon ion-ios-link"></span></a></span>
196
+ </td>
197
+ </tr>
198
+ <tr>
199
+ <td class="col-md-4">
200
+ <div class="io-description"><p>Called for every failed config url request. May never resolve, e.g. if it navigates away.</p>
201
+ </div>
202
+ </td>
203
+ </tr>
204
+ <tr>
205
+ <td class="col-md-4">
206
+ <code> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/function" target="_blank" >function</a></code>
207
+ </code>
208
+ </td>
209
+ </tr>
210
+ </tbody>
211
+ </table>
212
+ <table class="table table-sm table-bordered">
213
+ <tbody>
214
+ <tr>
215
+ <td class="col-md-4">
216
+ <a name="ConfigLoadErrorKind"></a>
217
+ <span class="name "><b>ConfigLoadErrorKind</b><a href="#ConfigLoadErrorKind"><span class="icon ion-ios-link"></span></a></span>
218
+ </td>
219
+ </tr>
220
+ <tr>
221
+ <td class="col-md-4">
222
+ <div class="io-description"><p>The kind of failure that happened while loading a config url.</p>
223
+ <ul>
224
+ <li><code>network</code>: <code>fetch()</code> rejected (offline, DNS, CORS without a redirect)</li>
225
+ <li><code>redirect</code>: the response is an <code>opaqueredirect</code> (only with <code>requestInit.redirect === &#39;manual&#39;</code>)</li>
226
+ <li><code>http</code>: the response is not ok - <code>status</code> and <code>response</code> are available</li>
227
+ <li><code>parse</code>: the response body is not valid JSON</li>
228
+ <li><code>schema</code>: the schema validation failed</li>
229
+ </ul>
230
+ </div>
231
+ </td>
232
+ </tr>
233
+ <tr>
234
+ <td class="col-md-4">
235
+ <code> <code>&quot;network&quot; | &quot;redirect&quot; | &quot;http&quot; | &quot;parse&quot; | &quot;schema&quot;</code>
158
236
  </code>
159
237
  </td>
160
238
  </tr>
@@ -101,7 +101,7 @@
101
101
  <div class="card text-center">
102
102
  <div class="card-block">
103
103
  <h4 class="card-title"><span class="icon ion-md-information-circle-outline"></span></h4>
104
- <p class="card-text">7 Interfaces</p>
104
+ <p class="card-text">8 Interfaces</p>
105
105
  </div>
106
106
  </div>
107
107
  </div>
@@ -102,7 +102,7 @@
102
102
  </ol>
103
103
  <ul class="properties-list">
104
104
  <li>
105
- <b>Version</b> : 19.3.0-dev.3</li>
105
+ <b>Version</b> : 21.0.1-dev.0</li>
106
106
  <li>
107
107
  <b>Description</b> : Provides a configuration service for Angular applications, allowing you to load and manage application settings from various sources such as static files, URLs, local storage, and URL parameters. It supports schema validation and provides utilities for accessing configuration values. This package also includes testing utilities for mocking and managing configurations in test environments.
108
108
  </li>