@rxap/remote-method 19.1.0 โ†’ 19.2.0-dev.1

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 (45) hide show
  1. package/CHANGELOG.md +34 -0
  2. package/compodoc/changelog.html +32 -0
  3. package/compodoc/dependencies.html +3 -3
  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 +242 -0
  9. package/docs/documentation.json +129 -129
  10. package/docs/html/classes/BaseRemoteMethod.html +10 -10
  11. package/docs/html/classes/ProxyRemoteMethod.html +10 -10
  12. package/docs/html/classes/RemoteMethodLoader.html +2 -2
  13. package/docs/html/classes/RxapRemoteMethodError.html +5 -5
  14. package/docs/html/functions/RxapRemoteMethod.html +1 -1
  15. package/docs/html/hierarchy.html +1 -1
  16. package/docs/html/index.html +2 -2
  17. package/docs/html/interfaces/BaseRemoteMethodMetadata.html +2 -2
  18. package/docs/html/modules.html +1 -1
  19. package/docs/html/variables/REMOTE_METHOD_META_DATA.html +1 -1
  20. package/docs/html/variables/RXAP_PROXY_REMOTE_METHOD_TARGET.html +1 -1
  21. package/docs/markdown/README.md +1 -1
  22. package/docs/markdown/classes/BaseRemoteMethod.md +31 -31
  23. package/docs/markdown/classes/ProxyRemoteMethod.md +32 -32
  24. package/docs/markdown/classes/RemoteMethodLoader.md +5 -5
  25. package/docs/markdown/classes/RxapRemoteMethodError.md +13 -13
  26. package/docs/markdown/functions/RxapRemoteMethod.md +2 -2
  27. package/docs/markdown/globals.md +2 -2
  28. package/docs/markdown/interfaces/BaseRemoteMethodMetadata.md +4 -4
  29. package/docs/markdown/variables/REMOTE_METHOD_META_DATA.md +2 -2
  30. package/docs/markdown/variables/RXAP_PROXY_REMOTE_METHOD_TARGET.md +2 -2
  31. package/docs/wiki/Class.BaseRemoteMethod.md +30 -30
  32. package/docs/wiki/Class.ProxyRemoteMethod.md +31 -31
  33. package/docs/wiki/Class.RemoteMethodLoader.md +4 -4
  34. package/docs/wiki/Class.RxapRemoteMethodError.md +12 -12
  35. package/docs/wiki/Function.RxapRemoteMethod.md +1 -1
  36. package/docs/wiki/Interface.BaseRemoteMethodMetadata.md +3 -3
  37. package/docs/wiki/Variable.REMOTE_METHOD_META_DATA.md +1 -1
  38. package/docs/wiki/Variable.RXAP_PROXY_REMOTE_METHOD_TARGET.md +1 -1
  39. package/docs/wiki/globals.md +1 -1
  40. package/fesm2022/rxap-remote-method-directive.mjs +6 -3
  41. package/fesm2022/rxap-remote-method-directive.mjs.map +1 -1
  42. package/fesm2022/rxap-remote-method-http.mjs +1 -0
  43. package/fesm2022/rxap-remote-method-http.mjs.map +1 -1
  44. package/http/lib/base-http.remote-method.d.ts +3 -25
  45. package/package.json +8 -9
@@ -102,7 +102,7 @@
102
102
  </ol>
103
103
  <ul class="properties-list">
104
104
  <li>
105
- <b>Version</b> : 19.1.0</li>
105
+ <b>Version</b> : 19.2.0-dev.1</li>
106
106
  <li>
107
107
  <b>Description</b> : This package provides abstractions for defining and executing remote methods in Angular applications. It includes features such as automatic refreshing, proxying, and error handling. It offers a structured way to manage remote calls and their dependencies.
108
108
  </li>
@@ -0,0 +1,242 @@
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-remote-method</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-remote-method</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: @rxap/remote-method Auditing &amp; Refactoring Plan</h1>
86
+ <p>This file outlines the critical bugs, architectural debt, library anti-patterns, and test coverage improvements identified during the project audit of <code>@rxap/remote-method</code>.</p>
87
+ <hr>
88
+ <h2>๐Ÿ› ๏ธ Design Issues &amp; Library Anti-Patterns</h2>
89
+ <h3>1. Hardcoded limits and Falsy Ignores in <code>ContenteditableDirective</code></h3>
90
+ <ul>
91
+ <li><strong>File:</strong> <a href="file:///mnt/mmuenker/Projects/rxap/packages/packages/angular/remote-method/http/directive/src/lib/contenteditable.directive.ts#L48-L54">contenteditable.directive.ts</a></li>
92
+ <li><strong>Description:</strong> The directive limits input saves based on arbitrary checks:<ul>
93
+ <li><code>value.length &gt; 3</code> is hardcoded. It prevents saving short inputs (e.g. <code>UK</code>, <code>ID</code>, <code>Yes</code>, <code>No</code>).</li>
94
+ <li>If the input is cleared (<code>value</code> is empty), it is treated as falsy, meaning the cleared state is never synchronized with the backend.</li>
95
+ <li><code>@DebounceCall(1000)</code> modifies the class prototype and may share debouncing queues/timers across all directive instances on the page instead of debouncing per-element.</li>
96
+ </ul>
97
+ </li>
98
+ <li><strong>Recommended Fix:</strong> Convert the input listener to an RxJS stream (<code>Subject</code> or modern Angular signals / Reactive forms integration) where the debounce is instance-specific, and allow clearing values or configuration of the minimum length.</li>
99
+ </ul>
100
+ <h3>2. Implicit Click Capturing in <code>RemoteMethodDirective</code></h3>
101
+ <ul>
102
+ <li><strong>File:</strong> <a href="file:///mnt/mmuenker/Projects/rxap/packages/packages/angular/remote-method/directive/src/lib/remote-method.directive.ts#L100-L107">remote-method.directive.ts</a></li>
103
+ <li><strong>Description:</strong> The directive listens to clicks on whatever element it is attached to via <code>@HostListener(&#39;click&#39;)</code>.</li>
104
+ <li><strong>Impact:</strong> If <code>rxapRemoteMethod</code> is placed on a parent container to expose its context via <code>exportAs=&quot;rxapRemoteMethod&quot;</code>, clicking <em>anywhere</em> inside that container will unexpectedly trigger the remote method. There is no flag to disable the automatic click binding.</li>
105
+ <li><strong>Recommended Fix:</strong> Add a configuration input like <code>@Input() rxapClickTrigger = true</code> and check it inside the <code>onClick()</code> listener before executing.</li>
106
+ </ul>
107
+ <hr>
108
+ <h2>๐Ÿ“‰ Code Quality, Deprecations &amp; Modernization</h2>
109
+ <h3>1. Deprecated <code>InjectFlags</code> Usage</h3>
110
+ <ul>
111
+ <li><strong>Files:</strong> <ul>
112
+ <li><a href="file:///mnt/mmuenker/Projects/rxap/packages/packages/angular/remote-method/src/lib/base.remote-method.ts#L112">base.remote-method.ts</a></li>
113
+ <li><a href="file:///mnt/mmuenker/Projects/rxap/packages/packages/angular/remote-method/src/lib/remote-method-loader.ts#L24">remote-method-loader.ts</a></li>
114
+ <li><a href="file:///mnt/mmuenker/Projects/rxap/packages/packages/angular/remote-method/http/src/lib/http-remote-method.loader.ts#L31">http-remote-method.loader.ts</a></li>
115
+ </ul>
116
+ </li>
117
+ <li><strong>Description:</strong> Uses <code>InjectFlags.Optional</code> inside <code>injector.get()</code>.</li>
118
+ <li><strong>Recommended Fix:</strong> Replace with modern options object syntax: <code>{ optional: true }</code>.</li>
119
+ </ul>
120
+ <h3>2. Deprecated RxJS <code>timeout</code> Signatures</h3>
121
+ <ul>
122
+ <li><strong>File:</strong> <a href="file:///mnt/mmuenker/Projects/rxap/packages/packages/angular/remote-method/http/src/lib/http.remote-method.ts#L81">http.remote-method.ts</a></li>
123
+ <li><strong>Description:</strong> <code>timeout(this.timeout)</code> is deprecated in RxJS 7+.</li>
124
+ <li><strong>Recommended Fix:</strong> Convert to object syntax: <code>timeout({ each: this.timeout })</code>.</li>
125
+ </ul>
126
+ <h3>3. Modernize Output Emitters with Angular 19+ Signal APIs</h3>
127
+ <ul>
128
+ <li><strong>Files:</strong> <code>RemoteMethodDirective</code> and <code>RemoteMethodTemplateDirective</code>.</li>
129
+ <li><strong>Description:</strong> Replace standard <code>@Output() x = new EventEmitter()</code> with modern Angular 19 <code>output()</code> APIs or <code>outputFromObservable()</code>.</li>
130
+ </ul>
131
+ <h3>4. Typo in Error Messages</h3>
132
+ <ul>
133
+ <li><strong>File:</strong> <a href="file:///mnt/mmuenker/Projects/rxap/packages/packages/angular/remote-method/http/src/lib/base-http.remote-method.ts#L78">base-http.remote-method.ts</a></li>
134
+ <li><strong>Description:</strong> &quot;HttpClinent&quot; instead of &quot;HttpClient&quot;.</li>
135
+ </ul>
136
+ <hr>
137
+ <h2>๐Ÿงช Test Coverage Gap</h2>
138
+ <ul>
139
+ <li><strong>Status:</strong> Extremely Low Test Coverage (only 1 test in the entire project).</li>
140
+ <li><strong>Missing Tests:</strong><ul>
141
+ <li><code>BaseRemoteMethod</code>: Lifecycle, execution counts, pause/resume behavior, refresh triggers.</li>
142
+ <li><code>ProxyRemoteMethod</code>: Parameter mapping and execution routing.</li>
143
+ <li><code>RemoteMethodLoader</code>: Dynamic loading mechanics.</li>
144
+ <li><code>RemoteMethodTemplateDirective</code> / <code>RemoteMethodTemplateCollectionDirective</code>: Renders, error templates, loading states, list diffs.</li>
145
+ <li><code>HttpRemoteMethod</code> / <code>HttpRemoteMethodLoader</code>: Event routing, parameter translation, response transforming.</li>
146
+ <li><code>ContenteditableDirective</code>: Debounce logic, saving, ignored inputs.</li>
147
+ </ul>
148
+ </li>
149
+ </ul>
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ </div><div class="search-results">
172
+ <div class="has-results">
173
+ <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
174
+ <ul class="search-results-list"></ul>
175
+ </div>
176
+ <div class="no-results">
177
+ <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
178
+ </div>
179
+ </div>
180
+ </div>
181
+ <!-- END CONTENT -->
182
+ </div>
183
+ </div>
184
+
185
+ <label class="dark-mode-switch">
186
+ <input type="checkbox">
187
+ <span class="slider">
188
+ <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">
189
+ <path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
190
+ </svg>
191
+ </span>
192
+ </label>
193
+
194
+ <script>
195
+ var COMPODOC_CURRENT_PAGE_DEPTH = 0;
196
+ var COMPODOC_CURRENT_PAGE_CONTEXT = 'getting-started';
197
+ var COMPODOC_CURRENT_PAGE_URL = 'todo.html';
198
+ var MAX_SEARCH_RESULTS = 15;
199
+ </script>
200
+
201
+ <script>
202
+ $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
203
+ checkToggle(darkModeState);
204
+ if ($darkModeToggleSwitchers.length > 0) {
205
+ for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
206
+ $darkModeToggleSwitchers[i].addEventListener('change', function (event) {
207
+ darkModeState = !darkModeState;
208
+ toggleDarkMode(darkModeState);
209
+ });
210
+ }
211
+ }
212
+ </script>
213
+
214
+ <script src="./js/libs/custom-elements.min.js"></script>
215
+ <script src="./js/libs/lit-html.js"></script>
216
+
217
+ <script src="./js/menu-wc.js" defer></script>
218
+ <script nomodule src="./js/menu-wc_es5.js" defer></script>
219
+
220
+ <script src="./js/libs/bootstrap-native.js"></script>
221
+
222
+ <script src="./js/libs/es6-shim.min.js"></script>
223
+ <script src="./js/libs/EventDispatcher.js"></script>
224
+ <script src="./js/libs/promise.min.js"></script>
225
+ <script src="./js/libs/zepto.min.js"></script>
226
+
227
+ <script src="./js/compodoc.js"></script>
228
+
229
+ <script src="./js/tabs.js"></script>
230
+ <script src="./js/menu.js"></script>
231
+ <script src="./js/libs/clipboard.min.js"></script>
232
+ <script src="./js/libs/prism.js"></script>
233
+ <script src="./js/sourceCode.js"></script>
234
+ <script src="./js/search/search.js"></script>
235
+ <script src="./js/search/lunr.min.js"></script>
236
+ <script src="./js/search/search-lunr.js"></script>
237
+ <script src="./js/search/search_index.js"></script>
238
+ <script src="./js/lazy-load-graphs.js"></script>
239
+
240
+
241
+ </body>
242
+ </html>