@rxap/config 19.3.0-dev.2 → 19.3.0-dev.4

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 (121) hide show
  1. package/CHANGELOG.md +63 -0
  2. package/README.md +53 -0
  3. package/compodoc/changelog.html +52 -0
  4. package/compodoc/dependencies.html +2 -2
  5. package/compodoc/js/search/search_index.js +2 -2
  6. package/compodoc/properties.html +1 -1
  7. package/docs/documentation.json +163 -163
  8. package/docs/html/classes/ConfigLoaderService.html +2 -2
  9. package/docs/html/classes/ConfigService.html +6 -6
  10. package/docs/html/classes/ConfigTestingService.html +2 -2
  11. package/docs/html/enums/ConfigLoadMethod.html +2 -2
  12. package/docs/html/enums/ConfigLoadingStrategy.html +2 -2
  13. package/docs/html/functions/ProvideConfig.html +1 -1
  14. package/docs/html/functions/dnsLookup.html +1 -1
  15. package/docs/html/functions/dnsResolver.html +1 -1
  16. package/docs/html/functions/fetchCidContent.html +1 -1
  17. package/docs/html/functions/fetchCidContentAsJson.html +1 -1
  18. package/docs/html/functions/fetchCidContentViaHttp.html +1 -1
  19. package/docs/html/functions/fetchContentViaHttp.html +1 -1
  20. package/docs/html/functions/localPathIpfsGateway.html +1 -1
  21. package/docs/html/functions/localSubDomainIpfsGateway.html +1 -1
  22. package/docs/html/functions/raceSuccess.html +2 -2
  23. package/docs/html/functions/storachaIpfsGateway.html +1 -1
  24. package/docs/html/functions/w3sIpfsGateway.html +1 -1
  25. package/docs/html/hierarchy.html +1 -1
  26. package/docs/html/index.html +2 -2
  27. package/docs/html/interfaces/AppsNavigationConfig.html +2 -2
  28. package/docs/html/interfaces/Config.html +2 -2
  29. package/docs/html/interfaces/ConfigLoadOptions.html +6 -6
  30. package/docs/html/interfaces/LogoConfig.html +2 -2
  31. package/docs/html/interfaces/NavigationConfig.html +2 -2
  32. package/docs/html/interfaces/Oauth2Config.html +2 -2
  33. package/docs/html/interfaces/i18nConfig.html +2 -2
  34. package/docs/html/modules.html +1 -1
  35. package/docs/html/types/AnySchema.html +1 -1
  36. package/docs/html/types/IpfsGatewayFunction.html +1 -1
  37. package/docs/html/types/Join.html +1 -1
  38. package/docs/html/types/LanguagesConfig.html +1 -1
  39. package/docs/html/types/Leaves.html +1 -1
  40. package/docs/html/types/NoInferType.html +1 -1
  41. package/docs/html/types/Paths.html +1 -1
  42. package/docs/html/variables/RXAP_CONFIG.html +1 -1
  43. package/docs/html/variables/defaultDnsServers.html +1 -1
  44. package/docs/html/variables/defaultIpfsGatewayServers.html +1 -1
  45. package/docs/markdown/README.md +1 -1
  46. package/docs/markdown/classes/ConfigLoaderService.md +7 -7
  47. package/docs/markdown/classes/ConfigService.md +22 -22
  48. package/docs/markdown/classes/ConfigTestingService.md +8 -8
  49. package/docs/markdown/enumerations/ConfigLoadMethod.md +6 -6
  50. package/docs/markdown/enumerations/ConfigLoadingStrategy.md +4 -4
  51. package/docs/markdown/functions/ProvideConfig.md +2 -2
  52. package/docs/markdown/functions/dnsLookup.md +2 -2
  53. package/docs/markdown/functions/dnsResolver.md +2 -2
  54. package/docs/markdown/functions/fetchCidContent.md +2 -2
  55. package/docs/markdown/functions/fetchCidContentAsJson.md +2 -2
  56. package/docs/markdown/functions/fetchCidContentViaHttp.md +2 -2
  57. package/docs/markdown/functions/fetchContentViaHttp.md +2 -2
  58. package/docs/markdown/functions/localPathIpfsGateway.md +2 -2
  59. package/docs/markdown/functions/localSubDomainIpfsGateway.md +2 -2
  60. package/docs/markdown/functions/raceSuccess.md +2 -2
  61. package/docs/markdown/functions/storachaIpfsGateway.md +2 -2
  62. package/docs/markdown/functions/w3sIpfsGateway.md +2 -2
  63. package/docs/markdown/globals.md +2 -2
  64. package/docs/markdown/interfaces/AppsNavigationConfig.md +12 -12
  65. package/docs/markdown/interfaces/Config.md +6 -6
  66. package/docs/markdown/interfaces/ConfigLoadOptions.md +15 -15
  67. package/docs/markdown/interfaces/LogoConfig.md +5 -5
  68. package/docs/markdown/interfaces/NavigationConfig.md +9 -9
  69. package/docs/markdown/interfaces/Oauth2Config.md +3 -3
  70. package/docs/markdown/interfaces/i18nConfig.md +4 -4
  71. package/docs/markdown/type-aliases/AnySchema.md +2 -2
  72. package/docs/markdown/type-aliases/IpfsGatewayFunction.md +2 -2
  73. package/docs/markdown/type-aliases/Join.md +2 -2
  74. package/docs/markdown/type-aliases/LanguagesConfig.md +2 -2
  75. package/docs/markdown/type-aliases/Leaves.md +2 -2
  76. package/docs/markdown/type-aliases/NoInferType.md +2 -2
  77. package/docs/markdown/type-aliases/Paths.md +2 -2
  78. package/docs/markdown/variables/RXAP_CONFIG.md +2 -2
  79. package/docs/markdown/variables/defaultDnsServers.md +2 -2
  80. package/docs/markdown/variables/defaultIpfsGatewayServers.md +2 -2
  81. package/docs/wiki/Class.ConfigLoaderService.md +6 -6
  82. package/docs/wiki/Class.ConfigService.md +21 -21
  83. package/docs/wiki/Class.ConfigTestingService.md +7 -7
  84. package/docs/wiki/Enumeration.ConfigLoadMethod.md +5 -5
  85. package/docs/wiki/Enumeration.ConfigLoadingStrategy.md +3 -3
  86. package/docs/wiki/Function.ProvideConfig.md +1 -1
  87. package/docs/wiki/Function.dnsLookup.md +1 -1
  88. package/docs/wiki/Function.dnsResolver.md +1 -1
  89. package/docs/wiki/Function.fetchCidContent.md +1 -1
  90. package/docs/wiki/Function.fetchCidContentAsJson.md +1 -1
  91. package/docs/wiki/Function.fetchCidContentViaHttp.md +1 -1
  92. package/docs/wiki/Function.fetchContentViaHttp.md +1 -1
  93. package/docs/wiki/Function.localPathIpfsGateway.md +1 -1
  94. package/docs/wiki/Function.localSubDomainIpfsGateway.md +1 -1
  95. package/docs/wiki/Function.raceSuccess.md +1 -1
  96. package/docs/wiki/Function.storachaIpfsGateway.md +1 -1
  97. package/docs/wiki/Function.w3sIpfsGateway.md +1 -1
  98. package/docs/wiki/Interface.AppsNavigationConfig.md +11 -11
  99. package/docs/wiki/Interface.Config.md +5 -5
  100. package/docs/wiki/Interface.ConfigLoadOptions.md +14 -14
  101. package/docs/wiki/Interface.LogoConfig.md +4 -4
  102. package/docs/wiki/Interface.NavigationConfig.md +8 -8
  103. package/docs/wiki/Interface.Oauth2Config.md +2 -2
  104. package/docs/wiki/Interface.i18nConfig.md +3 -3
  105. package/docs/wiki/TypeAlias.AnySchema.md +1 -1
  106. package/docs/wiki/TypeAlias.IpfsGatewayFunction.md +1 -1
  107. package/docs/wiki/TypeAlias.Join.md +1 -1
  108. package/docs/wiki/TypeAlias.LanguagesConfig.md +1 -1
  109. package/docs/wiki/TypeAlias.Leaves.md +1 -1
  110. package/docs/wiki/TypeAlias.NoInferType.md +1 -1
  111. package/docs/wiki/TypeAlias.Paths.md +1 -1
  112. package/docs/wiki/Variable.RXAP_CONFIG.md +1 -1
  113. package/docs/wiki/Variable.defaultDnsServers.md +1 -1
  114. package/docs/wiki/Variable.defaultIpfsGatewayServers.md +1 -1
  115. package/docs/wiki/globals.md +1 -1
  116. package/fesm2022/rxap-config.mjs +125 -70
  117. package/fesm2022/rxap-config.mjs.map +1 -1
  118. package/index.d.ts +1 -0
  119. package/lib/config-load-error.d.ts +41 -0
  120. package/lib/config.service.d.ts +24 -2
  121. package/package.json +5 -6
package/CHANGELOG.md CHANGED
@@ -1,3 +1,66 @@
1
+ ## 19.3.0-dev.4 (2026-09-25)
2
+
3
+ ### 🚀 Features
4
+
5
+ - **config:** allow a custom error handler for failed config requests
6
+
7
+ ### ❤️ Thank You
8
+
9
+ - Merzough Münker
10
+
11
+ ## 19.3.0-dev.3 (2026-06-19)
12
+
13
+ ### 🚀 Features
14
+
15
+ - **config:** add IPFS gateway support and simplify DNS server handling
16
+ - **config:** add configurable loading order for config sources
17
+ - **config:** add `strategy` option and FIFO handling for dynamic config loading
18
+ - **angular:** add DNS server handling for config loading
19
+ - **angular:** add storacha gateway for IPFS content fetching
20
+ - **angular:** allow custom fetch function for fetching CID content
21
+ - **layout:** make mobile query configurable in navigation config
22
+ - **config:** add support for loading configuration from DNS and CID
23
+ - add error handler concept
24
+ - add provide config
25
+ - support loading configuration from environment object
26
+ - support url functions
27
+
28
+ ### 🩹 Fixes
29
+
30
+ - **generators:** read package.json and node_modules from disk, not the virtual Tree
31
+ - **generators:** match package name with .some() in init devDependency coercion
32
+ - **config:** resolve subdomain parsing issue in `localSubDomainIpfsGateway`
33
+ - **utilities:** add cache control headers to DNS resolver
34
+ - **config:** add explicit `any` type to error in catch blocks
35
+ - **config:** include error message in logging for better clarity
36
+ - support config url paths
37
+ - change log level
38
+ - save race
39
+ - **config.service:** improve path handling and property access validation
40
+ - update package groups
41
+ - update package groups
42
+ - add oauth2 proxy config interface
43
+ - add config property
44
+ - add config interface
45
+ - add config interface
46
+ - add config interface
47
+ - add provide config
48
+ - overwrite config loading settings with environment object
49
+ - auto refresh application on config loading error
50
+ - improve error codes for config loading
51
+ - peer dependency issue
52
+ - ensure the project name is not included in the project tag list
53
+ - add licence file to publishable packages
54
+ - add browser-tailwind as imp dep if project has tailwind configuration
55
+ - add tailwind bundle build target and configurations
56
+ - support url option for config loading method
57
+ - update package dependency versions
58
+ - restructure and merge mono repos packages, schematics, plugins and nest
59
+
60
+ ### ❤️ Thank You
61
+
62
+ - Merzough Münker
63
+
1
64
  # Change Log
2
65
 
3
66
  All notable changes to this project will be documented in this file.
package/README.md CHANGED
@@ -8,6 +8,7 @@ Provides a configuration service for Angular applications, allowing you to load
8
8
  ![NPM](https://img.shields.io/npm/l/@rxap/config)
9
9
 
10
10
  - [Installation](#installation)
11
+ - [Guides](#guides)
11
12
  - [Generators](#generators)
12
13
  - [init](#init)
13
14
 
@@ -25,6 +26,58 @@ yarn add @angular/common @angular/core @rxap/environment @rxap/utilities rxjs
25
26
  ```bash
26
27
  yarn nx g @rxap/config:init
27
28
  ```
29
+ # Guides
30
+
31
+ ## Custom error handling for failed config requests
32
+
33
+ By default a failed required config url request shows an error overlay and reloads the page after
34
+ 30 s. Pass `errorHandler` in the `ConfigLoadOptions` to replace this behavior. The handler gets a
35
+ structured `ConfigLoadError`:
36
+
37
+ | `kind` | When |
38
+ |------------|-------------------------------------------------------------------------|
39
+ | `network` | `fetch()` rejected (offline, DNS, CORS without a redirect) |
40
+ | `redirect` | the response is an `opaqueredirect` (only with `redirect: 'manual'`) |
41
+ | `http` | the response is not ok (`status` and `response` are set) |
42
+ | `parse` | the response body is not valid JSON |
43
+ | `schema` | the schema validation failed |
44
+
45
+ `requestInit` is passed to every config url `fetch()` call. Use `{ redirect: 'manual' }` to detect a
46
+ redirect to a login page instead of getting a CORS error.
47
+
48
+ ```ts
49
+ import {
50
+ ConfigService,
51
+ defaultConfigLoadErrorHandler,
52
+ } from '@rxap/config';
53
+
54
+ await ConfigService.Load({
55
+ url: '/config.json',
56
+ requestInit: { redirect: 'manual' },
57
+ errorHandler: (error) => {
58
+ if (error.kind === 'redirect' || error.status === 401) {
59
+ location.href = '/oauth2/sign_in';
60
+ // never resolve - the browser navigates away
61
+ return new Promise<void>(() => undefined);
62
+ }
63
+ // fall back to the default overlay + reload
64
+ return defaultConfigLoadErrorHandler(error);
65
+ },
66
+ });
67
+ ```
68
+
69
+ - The handler is called **instead of** the default overlay and reload - no DOM changes, no reload.
70
+ - After the handler resolves a required url still throws and an optional url resolves with `null`.
71
+ - The `onError` / `onRequestError` subjects and the `onErrorFnc` / `onRequestErrorFnc` hooks are
72
+ still called for required urls.
73
+ - The handler and `requestInit` of the last `ConfigService.Load` call are also used by
74
+ `ConfigService.SideLoad`. Pass the fifth `options` argument of `SideLoad` to override them.
75
+ - The handler only covers config url sources (`url` / `fromUrls` and `SideLoad`). The CID and DNS
76
+ sources (`fromCid`, `fromDns`) fetch through their own paths, only log failures and never show the
77
+ overlay.
78
+ - `StandaloneApplication` from `@rxap/ngx-bootstrap` forwards its `configLoadOptions` unchanged, so
79
+ the options can be passed as its fourth constructor argument.
80
+
28
81
  # Generators
29
82
 
30
83
  ## init
@@ -82,6 +82,58 @@
82
82
  <div class="content getting-started">
83
83
  <div class="content-data">
84
84
 
85
+ <h2>19.3.0-dev.3 (2026-06-19)</h2>
86
+ <h3>🚀 Features</h3>
87
+ <ul>
88
+ <li><strong>config:</strong> add IPFS gateway support and simplify DNS server handling</li>
89
+ <li><strong>config:</strong> add configurable loading order for config sources</li>
90
+ <li><strong>config:</strong> add <code>strategy</code> option and FIFO handling for dynamic config loading</li>
91
+ <li><strong>angular:</strong> add DNS server handling for config loading</li>
92
+ <li><strong>angular:</strong> add storacha gateway for IPFS content fetching</li>
93
+ <li><strong>angular:</strong> allow custom fetch function for fetching CID content</li>
94
+ <li><strong>layout:</strong> make mobile query configurable in navigation config</li>
95
+ <li><strong>config:</strong> add support for loading configuration from DNS and CID</li>
96
+ <li>add error handler concept</li>
97
+ <li>add provide config</li>
98
+ <li>support loading configuration from environment object</li>
99
+ <li>support url functions</li>
100
+ </ul>
101
+ <h3>🩹 Fixes</h3>
102
+ <ul>
103
+ <li><strong>generators:</strong> read package.json and node_modules from disk, not the virtual Tree</li>
104
+ <li><strong>generators:</strong> match package name with .some() in init devDependency coercion</li>
105
+ <li><strong>config:</strong> resolve subdomain parsing issue in <code>localSubDomainIpfsGateway</code></li>
106
+ <li><strong>utilities:</strong> add cache control headers to DNS resolver</li>
107
+ <li><strong>config:</strong> add explicit <code>any</code> type to error in catch blocks</li>
108
+ <li><strong>config:</strong> include error message in logging for better clarity</li>
109
+ <li>support config url paths</li>
110
+ <li>change log level</li>
111
+ <li>save race</li>
112
+ <li><strong>config.service:</strong> improve path handling and property access validation</li>
113
+ <li>update package groups</li>
114
+ <li>update package groups</li>
115
+ <li>add oauth2 proxy config interface</li>
116
+ <li>add config property</li>
117
+ <li>add config interface</li>
118
+ <li>add config interface</li>
119
+ <li>add config interface</li>
120
+ <li>add provide config</li>
121
+ <li>overwrite config loading settings with environment object</li>
122
+ <li>auto refresh application on config loading error</li>
123
+ <li>improve error codes for config loading</li>
124
+ <li>peer dependency issue</li>
125
+ <li>ensure the project name is not included in the project tag list</li>
126
+ <li>add licence file to publishable packages</li>
127
+ <li>add browser-tailwind as imp dep if project has tailwind configuration</li>
128
+ <li>add tailwind bundle build target and configurations</li>
129
+ <li>support url option for config loading method</li>
130
+ <li>update package dependency versions</li>
131
+ <li>restructure and merge mono repos packages, schematics, plugins and nest</li>
132
+ </ul>
133
+ <h3>❤️ Thank You</h3>
134
+ <ul>
135
+ <li>Merzough Münker</li>
136
+ </ul>
85
137
  <h1>Change Log</h1>
86
138
  <p>All notable changes to this project will be documented in this file.
87
139
  See <a href="https://conventionalcommits.org">Conventional Commits</a> for commit guidelines.</p>
@@ -117,9 +117,9 @@
117
117
  <li>
118
118
  <b>@angular/core</b> : ^19.2.1</li>
119
119
  <li>
120
- <b>@rxap/environment</b> : ^19.1.0</li>
120
+ <b>@rxap/environment</b> : ^19.2.0-dev.0</li>
121
121
  <li>
122
- <b>@rxap/utilities</b> : ^16.5.1-dev.0</li>
122
+ <b>@rxap/utilities</b> : ^16.5.1-dev.1</li>
123
123
  <li>
124
124
  <b>rxjs</b> : ^7.8.1</li>
125
125
  </ul>