@rxap/services 19.0.4 → 19.1.0-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 (35) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/compodoc/changelog.html +25 -0
  3. package/compodoc/dependencies.html +2 -2
  4. package/compodoc/js/menu-wc.js +5 -0
  5. package/compodoc/js/menu-wc_es5.js +1 -1
  6. package/compodoc/js/search/search_index.js +2 -2
  7. package/compodoc/properties.html +1 -1
  8. package/compodoc/todo.html +274 -0
  9. package/docs/documentation.json +47 -47
  10. package/docs/html/classes/AvatarImageService.html +2 -2
  11. package/docs/html/classes/ImageLoaderService.html +2 -2
  12. package/docs/html/classes/LoadingIndicatorService.html +3 -3
  13. package/docs/html/classes/ResetService.html +2 -2
  14. package/docs/html/classes/WindowContainerSidenavService.html +2 -2
  15. package/docs/html/index.html +2 -2
  16. package/docs/html/interfaces/ContainerComponent.html +2 -2
  17. package/docs/html/modules.html +1 -1
  18. package/docs/markdown/README.md +1 -1
  19. package/docs/markdown/classes/AvatarImageService.md +3 -3
  20. package/docs/markdown/classes/ImageLoaderService.md +3 -3
  21. package/docs/markdown/classes/LoadingIndicatorService.md +8 -8
  22. package/docs/markdown/classes/ResetService.md +7 -7
  23. package/docs/markdown/classes/WindowContainerSidenavService.md +7 -7
  24. package/docs/markdown/globals.md +2 -2
  25. package/docs/markdown/interfaces/ContainerComponent.md +8 -8
  26. package/docs/wiki/Class.AvatarImageService.md +2 -2
  27. package/docs/wiki/Class.ImageLoaderService.md +2 -2
  28. package/docs/wiki/Class.LoadingIndicatorService.md +7 -7
  29. package/docs/wiki/Class.ResetService.md +6 -6
  30. package/docs/wiki/Class.WindowContainerSidenavService.md +6 -6
  31. package/docs/wiki/Interface.ContainerComponent.md +7 -7
  32. package/docs/wiki/globals.md +1 -1
  33. package/fesm2022/rxap-services.mjs +15 -15
  34. package/fesm2022/rxap-services.mjs.map +1 -1
  35. package/package.json +7 -8
@@ -102,7 +102,7 @@
102
102
  </ol>
103
103
  <ul class="properties-list">
104
104
  <li>
105
- <b>Version</b> : 19.0.4</li>
105
+ <b>Version</b> : 19.1.0-dev.0</li>
106
106
  <li>
107
107
  <b>Description</b> : Provides Angular services for common tasks such as loading images, managing loading indicators, resetting data, and managing components in a window container sidenav. It also includes a service to generate avatar images. This package offers reusable services to simplify development in Angular applications.
108
108
  </li>
@@ -0,0 +1,274 @@
1
+ <!doctype html>
2
+ <html class="no-js" lang="">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="x-ua-compatible" content="ie=edge">
6
+ <title>angular-services</title>
7
+ <meta name="description" content="">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+
10
+ <link rel="icon" type="image/x-icon" href="./images/favicon.ico">
11
+ <link rel="stylesheet" href="./styles/style.css">
12
+ <link rel="stylesheet" href="./styles/dark.css">
13
+ </head>
14
+ <body>
15
+ <script>
16
+ // Blocking script to avoid flickering dark mode
17
+ // Dark mode toggle button
18
+ var useDark = window.matchMedia('(prefers-color-scheme: dark)');
19
+ var darkModeState = useDark.matches;
20
+ var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
21
+ var $darkModeToggles = document.querySelectorAll('.dark-mode-switch');
22
+ var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state');
23
+
24
+ function checkToggle(check) {
25
+ for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
26
+ $darkModeToggleSwitchers[i].checked = check;
27
+ }
28
+ }
29
+
30
+ function toggleDarkMode(state) {
31
+ if (window.localStorage) {
32
+ localStorage.setItem('compodoc_darkmode-state', state);
33
+ }
34
+
35
+ checkToggle(state);
36
+
37
+ const hasClass = document.body.classList.contains('dark');
38
+
39
+ if (state) {
40
+ for (var i = 0; i < $darkModeToggles.length; i++) {
41
+ $darkModeToggles[i].classList.add('dark');
42
+ }
43
+ if (!hasClass) {
44
+ document.body.classList.add('dark');
45
+ }
46
+ } else {
47
+ for (var i = 0; i < $darkModeToggles.length; i++) {
48
+ $darkModeToggles[i].classList.remove('dark');
49
+ }
50
+ if (hasClass) {
51
+ document.body.classList.remove('dark');
52
+ }
53
+ }
54
+ }
55
+
56
+ useDark.addEventListener('change', function (evt) {
57
+ toggleDarkMode(evt.matches);
58
+ });
59
+ if (darkModeStateLocal) {
60
+ darkModeState = darkModeStateLocal === 'true';
61
+ }
62
+ toggleDarkMode(darkModeState);
63
+ </script>
64
+
65
+ <div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
66
+ <div class="d-flex">
67
+ <a href="./" class="navbar-brand">angular-services</a>
68
+ <button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
69
+ </div>
70
+ </div>
71
+
72
+ <div class="xs-menu menu" id="mobile-menu">
73
+ <div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
74
+ </div>
75
+
76
+ <div class="container-fluid main">
77
+ <div class="row main">
78
+ <div class="d-none d-md-block menu">
79
+ <compodoc-menu mode="normal"></compodoc-menu>
80
+ </div>
81
+ <!-- START CONTENT -->
82
+ <div class="content getting-started">
83
+ <div class="content-data">
84
+
85
+ <h1>TODO List for @rxap/services</h1>
86
+ <p>This document outlines the findings from the project audit of <code>packages/angular/services</code>. It highlights critical bugs, architectural debt, library anti-patterns, and areas for improvement to align the package with modern Angular 19+ best practices and robust monorepo configurations.</p>
87
+ <hr>
88
+ <h2>1. Critical &amp; Functional Bugs</h2>
89
+ <h3>🚨 Old Component Instance Resource Leak in <code>WindowContainerSidenavService</code></h3>
90
+ <ul>
91
+ <li><strong>File:</strong> <a href="file:///mnt/mmuenker/Projects/rxap/packages/packages/angular/services/src/lib/window-container-sidenav.service.ts#L25-L31"><code>packages/angular/services/src/lib/window-container-sidenav.service.ts</code></a></li>
92
+ <li><strong>Issue:</strong> In the <code>add</code> method, if a component with the same <code>id</code> is already registered, the service correctly triggers a <code>remove$</code> event before overwriting it. However, it incorrectly emits the <strong>new</strong> component instance reference via the <code>remove$</code> stream rather than the <strong>old</strong> stored reference:<b>Example :</b><div><pre class="line-numbers"><code class="language-typescript">public add(component: ContainerComponent): void {
93
+ if (this.components.has(component.id)) {
94
+ this.remove$.next(component); // &lt;-- BUG: Emits the new component instance instead of the old one
95
+ }
96
+ this.components.set(component.id, component);
97
+ this.add$.next(component);
98
+ }</code></pre></div>This results in clean-up mechanisms (which listen to <code>remove$</code>) trying to destroy or clean up references on a component that hasn&#39;t even been initialized yet, while the actual old component&#39;s references (e.g., <code>viewContainerRef</code>, <code>injector</code>) are lost and leaked.</li>
99
+ <li><strong>Recommended Fix:</strong> Emit the old stored component instance prior to overwriting it in the map:<b>Example :</b><div><pre class="line-numbers"><code class="language-typescript">public add(component: ContainerComponent): void {
100
+ const existing = this.components.get(component.id);
101
+ if (existing) {
102
+ this.remove$.next(existing);
103
+ }
104
+ this.components.set(component.id, component);
105
+ this.add$.next(component);
106
+ }</code></pre></div></li>
107
+ </ul>
108
+ <hr>
109
+ <h2>2. Architectural Debt &amp; Design Anti-Patterns</h2>
110
+ <h3>⚠️ SSR Compatibility Issues (Browser-Only Globals)</h3>
111
+ <ul>
112
+ <li><strong>File:</strong> <a href="file:///mnt/mmuenker/Projects/rxap/packages/packages/angular/services/src/lib/image-loader.service.ts#L20"><code>packages/angular/services/src/lib/image-loader.service.ts</code></a></li>
113
+ <li><strong>Issue:</strong> <code>ImageLoaderService.load()</code> directly instantiates <code>new Image()</code>, which is a browser-only global API. During Server-Side Rendering (SSR) or Static Site Generation (Prerendering), this code will crash with a <code>ReferenceError: Image is not defined</code>.</li>
114
+ <li><strong>Recommended Fix:</strong> Inject Angular&#39;s <code>PLATFORM_ID</code> and use <code>isPlatformBrowser(platformId)</code> from <code>@angular/common</code> to bypass image instantiation on the server side:<b>Example :</b><div><pre class="line-numbers"><code class="language-typescript">import { Inject, Injectable, PLATFORM_ID } from &#39;&#64;angular/core&#39;;
115
+ import { isPlatformBrowser } from &#39;&#64;angular/common&#39;;
116
+
117
+ &#64;Injectable({ providedIn: &#39;root&#39; })
118
+ export class ImageLoaderService {
119
+ constructor(&#64;Inject(PLATFORM_ID) private platformId: object) {}
120
+
121
+ public load(imageSrc: string): Promise&lt;void&gt; {
122
+ if (!isPlatformBrowser(this.platformId)) {
123
+ return Promise.resolve();
124
+ }
125
+ // ... browser-only image loading logic ...
126
+ }
127
+ }</code></pre></div></li>
128
+ </ul>
129
+ <h3>⚠️ Deprecated Angular Features</h3>
130
+ <ul>
131
+ <li><strong>File:</strong> <a href="file:///mnt/mmuenker/Projects/rxap/packages/packages/angular/services/src/lib/window-container-sidenav.service.ts#L10-L16"><code>packages/angular/services/src/lib/window-container-sidenav.service.ts</code></a></li>
132
+ <li><strong>Issue:</strong> The service and <code>ContainerComponent</code> interface refer to <code>ComponentFactoryResolver</code> which has been deprecated since Angular 13.</li>
133
+ <li><strong>Recommended Fix:</strong> In modern Angular (19+), dynamic components should be instantiated directly via <code>ViewContainerRef.createComponent(ComponentClass)</code> without needing to resolve factories manually. Clean up the interface and remove references to <code>ComponentFactoryResolver</code>.</li>
134
+ </ul>
135
+ <h3>⚠️ Encapsulation Leaks (Exposing Raw Subjects)</h3>
136
+ <ul>
137
+ <li><strong>Files:</strong><ul>
138
+ <li><code>ResetService</code> (<code>view$</code>, <code>dataSource$</code>)</li>
139
+ <li><code>WindowContainerSidenavService</code> (<code>add$</code>, <code>remove$</code>)</li>
140
+ </ul>
141
+ </li>
142
+ <li><strong>Issue:</strong> Exposing raw <code>Subject</code> instances as <code>public</code> fields allows external consumers to bypass encapsulation and call <code>next()</code>, <code>error()</code>, or <code>complete()</code> directly.</li>
143
+ <li><strong>Recommended Fix:</strong> Keep subjects <code>private</code> (prefix with <code>_</code>) and expose them as read-only Observables via <code>.asObservable()</code>:<b>Example :</b><div><pre class="line-numbers"><code class="language-typescript">private readonly _view$ = new Subject&lt;void&gt;();
144
+ public readonly view$ = this._view$.asObservable();</code></pre></div></li>
145
+ </ul>
146
+ <h3>⚠️ Context Loss Risks in Subscription Callbacks</h3>
147
+ <ul>
148
+ <li><strong>File:</strong> <a href="file:///mnt/mmuenker/Projects/rxap/packages/packages/angular/services/src/lib/loading-indicator.service.ts#L28"><code>packages/angular/services/src/lib/loading-indicator.service.ts</code></a></li>
149
+ <li><strong>Issue:</strong> Passing <code>this.loading$.next</code> directly as a subscription callback can lead to execution context (<code>this</code>) loss under certain JavaScript environments, as standard RxJS Subject methods are not pre-bound:<b>Example :</b><div><pre class="line-numbers"><code class="language-typescript">loading$.pipe(map(Boolean), delay(0)).subscribe(this.loading$.next)</code></pre></div></li>
150
+ <li><strong>Recommended Fix:</strong> Wrap it in a safe arrow function or use <code>.bind</code>:<b>Example :</b><div><pre class="line-numbers"><code class="language-typescript">loading$.pipe(map(Boolean), delay(0)).subscribe((val) =&gt; this.loading$.next(val))</code></pre></div></li>
151
+ </ul>
152
+ <h3>⚠️ Reliance on Deferral Hacks (<code>setTimeout</code> &amp; <code>delay</code>)</h3>
153
+ <ul>
154
+ <li><strong>File:</strong> <a href="file:///mnt/mmuenker/Projects/rxap/packages/packages/angular/services/src/lib/loading-indicator.service.ts#L36-L46"><code>packages/angular/services/src/lib/loading-indicator.service.ts</code></a></li>
155
+ <li><strong>Issue:</strong> <code>LoadingIndicatorService</code> uses <code>setTimeout</code> inside <code>disable()</code> and <code>enable()</code>, and <code>delay(0)</code> inside <code>attachLoading</code> to avoid ExpressionChangedAfterItHasBeenCheckedError. In a modern zoneless or Signal-driven Angular application, relying heavily on macrotasks/microtasks is a code smell that should be replaced with native reactive flow structures or scheduler bindings.</li>
156
+ </ul>
157
+ <hr>
158
+ <h2>3. Lack of Modern Angular Features (Angular 19+)</h2>
159
+ <h3>💡 Implement Signals-based APIs</h3>
160
+ <ul>
161
+ <li><strong>Issue:</strong> Modern Angular apps heavily rely on Signals (<code>signal</code>, <code>computed</code>, <code>readonly</code>) for state management, as it avoids complex RxJS subscriptions and simplifies <code>OnPush</code> change detection and zone-less rendering.</li>
162
+ <li><strong>Opportunities:</strong><ul>
163
+ <li><strong><code>LoadingIndicatorService</code></strong>: Provide a read-only Signal representing the current loading state (<code>isLoading = signal(true).asReadonly()</code>).</li>
164
+ <li><strong><code>WindowContainerSidenavService</code></strong>: Store registered components in a Signal (<code>components = signal&lt;ContainerComponent[]&gt;([])</code>) so templates can render lists reactively and seamlessly without pipe async or manual subscription boilerplate.</li>
165
+ </ul>
166
+ </li>
167
+ </ul>
168
+ <hr>
169
+ <h2>4. Test Coverage &amp; Incomplete Implementation</h2>
170
+ <h3>🧪 Improve Test Coverage for <code>ImageLoaderService</code></h3>
171
+ <ul>
172
+ <li><strong>File:</strong> <a href="file:///mnt/mmuenker/Projects/rxap/packages/packages/angular/services/src/lib/image-loader.service.spec.ts"><code>packages/angular/services/src/lib/image-loader.service.spec.ts</code></a></li>
173
+ <li><strong>Issue:</strong> The <code>ImageLoaderService</code> has only a placeholder test verifying instantiation. The <code>load()</code> method has zero coverage, leaving critical state management and potential error conditions untested.</li>
174
+ <li><strong>Recommended Fix:</strong> Implement tests for <code>ImageLoaderService.load()</code>, mocking the global <code>Image</code> constructor to verify loading state logic (handling parallel loads, resolution caching, and error rejections).</li>
175
+ </ul>
176
+ <h3>🚧 Incomplete Feature in <code>ResetService</code></h3>
177
+ <ul>
178
+ <li><strong>File:</strong> <a href="file:///mnt/mmuenker/Projects/rxap/packages/packages/angular/services/src/lib/reset.service.ts#L15"><code>packages/angular/services/src/lib/reset.service.ts</code></a></li>
179
+ <li><strong>Issue:</strong> Contains a <code>// TODO : iterate over the list of active DataSources</code> comment and does not actually perform the data source reset on individual instances.</li>
180
+ <li><strong>Recommended Fix:</strong> Introduce a mechanism for active DataSources to register themselves in <code>ResetService</code> so that calling <code>resetDataSource()</code> can invoke their individual reset hooks.</li>
181
+ </ul>
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+ </div><div class="search-results">
204
+ <div class="has-results">
205
+ <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
206
+ <ul class="search-results-list"></ul>
207
+ </div>
208
+ <div class="no-results">
209
+ <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
210
+ </div>
211
+ </div>
212
+ </div>
213
+ <!-- END CONTENT -->
214
+ </div>
215
+ </div>
216
+
217
+ <label class="dark-mode-switch">
218
+ <input type="checkbox">
219
+ <span class="slider">
220
+ <svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
221
+ <path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
222
+ </svg>
223
+ </span>
224
+ </label>
225
+
226
+ <script>
227
+ var COMPODOC_CURRENT_PAGE_DEPTH = 0;
228
+ var COMPODOC_CURRENT_PAGE_CONTEXT = 'getting-started';
229
+ var COMPODOC_CURRENT_PAGE_URL = 'todo.html';
230
+ var MAX_SEARCH_RESULTS = 15;
231
+ </script>
232
+
233
+ <script>
234
+ $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
235
+ checkToggle(darkModeState);
236
+ if ($darkModeToggleSwitchers.length > 0) {
237
+ for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
238
+ $darkModeToggleSwitchers[i].addEventListener('change', function (event) {
239
+ darkModeState = !darkModeState;
240
+ toggleDarkMode(darkModeState);
241
+ });
242
+ }
243
+ }
244
+ </script>
245
+
246
+ <script src="./js/libs/custom-elements.min.js"></script>
247
+ <script src="./js/libs/lit-html.js"></script>
248
+
249
+ <script src="./js/menu-wc.js" defer></script>
250
+ <script nomodule src="./js/menu-wc_es5.js" defer></script>
251
+
252
+ <script src="./js/libs/bootstrap-native.js"></script>
253
+
254
+ <script src="./js/libs/es6-shim.min.js"></script>
255
+ <script src="./js/libs/EventDispatcher.js"></script>
256
+ <script src="./js/libs/promise.min.js"></script>
257
+ <script src="./js/libs/zepto.min.js"></script>
258
+
259
+ <script src="./js/compodoc.js"></script>
260
+
261
+ <script src="./js/tabs.js"></script>
262
+ <script src="./js/menu.js"></script>
263
+ <script src="./js/libs/clipboard.min.js"></script>
264
+ <script src="./js/libs/prism.js"></script>
265
+ <script src="./js/sourceCode.js"></script>
266
+ <script src="./js/search/search.js"></script>
267
+ <script src="./js/search/lunr.min.js"></script>
268
+ <script src="./js/search/search-lunr.js"></script>
269
+ <script src="./js/search/search_index.js"></script>
270
+ <script src="./js/lazy-load-graphs.js"></script>
271
+
272
+
273
+ </body>
274
+ </html>