@rxap/ngx-user 18.0.3-dev.0 → 18.0.3-dev.2

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 (118) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +14 -1
  3. package/compodoc/changelog.html +4 -0
  4. package/compodoc/dependencies.html +5 -7
  5. package/compodoc/index.html +8 -1
  6. package/compodoc/injectables/UserProfileDataSource.html +1 -261
  7. package/compodoc/injectables/UserSettingsDarkModeService.html +17 -212
  8. package/compodoc/injectables/UserSettingsDataSource.html +1 -296
  9. package/compodoc/injectables/UserSettingsLanguageService.html +17 -200
  10. package/compodoc/injectables/UserSettingsService.html +9 -189
  11. package/compodoc/injectables/UserSettingsThemeService.html +26 -229
  12. package/compodoc/js/menu-wc.js +0 -6
  13. package/compodoc/js/menu-wc_es5.js +1 -1
  14. package/compodoc/js/search/search_index.js +2 -2
  15. package/compodoc/miscellaneous/functions.html +72 -1
  16. package/compodoc/overview.html +1 -1
  17. package/compodoc/properties.html +1 -1
  18. package/docs/assets/navigation.js +1 -1
  19. package/docs/assets/search.js +1 -1
  20. package/docs/classes/DarkModeControllerDisableRemoteMethod.html +13 -13
  21. package/docs/classes/DarkModeControllerEnableRemoteMethod.html +13 -13
  22. package/docs/classes/DarkModeControllerGetRemoteMethod.html +13 -13
  23. package/docs/classes/DarkModeControllerToggleRemoteMethod.html +13 -13
  24. package/docs/classes/LanguageControllerGetRemoteMethod.html +13 -13
  25. package/docs/classes/LanguageControllerSetRemoteMethod.html +13 -13
  26. package/docs/classes/ProfileControllerGetRemoteMethod.html +13 -13
  27. package/docs/classes/SettingsControllerClearPropertyRemoteMethod.html +13 -13
  28. package/docs/classes/SettingsControllerDecrementPropertyRemoteMethod.html +13 -13
  29. package/docs/classes/SettingsControllerGetPropertyRemoteMethod.html +13 -13
  30. package/docs/classes/SettingsControllerGetRemoteMethod.html +13 -13
  31. package/docs/classes/SettingsControllerIncrementPropertyRemoteMethod.html +13 -13
  32. package/docs/classes/SettingsControllerPopPropertyRemoteMethod.html +13 -13
  33. package/docs/classes/SettingsControllerPushPropertyRemoteMethod.html +13 -13
  34. package/docs/classes/SettingsControllerRemoveAtPropertyRemoteMethod.html +13 -13
  35. package/docs/classes/SettingsControllerRemovePropertyRemoteMethod.html +13 -13
  36. package/docs/classes/SettingsControllerSetPropertyRemoteMethod.html +13 -13
  37. package/docs/classes/SettingsControllerSetRemoteMethod.html +13 -13
  38. package/docs/classes/SettingsControllerShiftPropertyRemoteMethod.html +13 -13
  39. package/docs/classes/SettingsControllerTogglePropertyRemoteMethod.html +13 -13
  40. package/docs/classes/SettingsControllerUnshiftPropertyRemoteMethod.html +13 -13
  41. package/docs/classes/ThemeControllerGetRemoteMethod.html +13 -13
  42. package/docs/classes/ThemeControllerSetDensityRemoteMethod.html +13 -13
  43. package/docs/classes/ThemeControllerSetPresetRemoteMethod.html +13 -13
  44. package/docs/classes/ThemeControllerSetRemoteMethod.html +13 -13
  45. package/docs/classes/ThemeControllerSetTypographyRemoteMethod.html +13 -13
  46. package/docs/classes/UserProfileDataSource.html +12 -15
  47. package/docs/classes/UserSettingsDarkModeDataSource.html +13 -13
  48. package/docs/classes/UserSettingsDarkModeService.html +3 -7
  49. package/docs/classes/UserSettingsDataSource.html +12 -16
  50. package/docs/classes/UserSettingsLanguageDataSource.html +13 -13
  51. package/docs/classes/UserSettingsLanguageService.html +3 -7
  52. package/docs/classes/UserSettingsService.html +3 -7
  53. package/docs/classes/UserSettingsThemeDataSource.html +13 -13
  54. package/docs/classes/UserSettingsThemeService.html +3 -7
  55. package/docs/documentation.json +4600 -6153
  56. package/docs/enums/ThemeDensity.html +2 -2
  57. package/docs/functions/IsThemeDensity.html +1 -1
  58. package/docs/index.html +11 -2
  59. package/docs/interfaces/LanguageControllerSetParameter.html +2 -2
  60. package/docs/interfaces/SetDensityDto.html +2 -2
  61. package/docs/interfaces/SettingsControllerClearPropertyParameter.html +2 -2
  62. package/docs/interfaces/SettingsControllerDecrementPropertyParameter.html +2 -2
  63. package/docs/interfaces/SettingsControllerGetPropertyParameter.html +2 -2
  64. package/docs/interfaces/SettingsControllerIncrementPropertyParameter.html +2 -2
  65. package/docs/interfaces/SettingsControllerPopPropertyParameter.html +2 -2
  66. package/docs/interfaces/SettingsControllerPushPropertyParameter.html +2 -2
  67. package/docs/interfaces/SettingsControllerRemoveAtPropertyParameter.html +2 -2
  68. package/docs/interfaces/SettingsControllerRemovePropertyParameter.html +2 -2
  69. package/docs/interfaces/SettingsControllerSetPropertyParameter.html +2 -2
  70. package/docs/interfaces/SettingsControllerShiftPropertyParameter.html +2 -2
  71. package/docs/interfaces/SettingsControllerTogglePropertyParameter.html +2 -2
  72. package/docs/interfaces/SettingsControllerUnshiftPropertyParameter.html +2 -2
  73. package/docs/interfaces/StringValueDto.html +1 -1
  74. package/docs/interfaces/ThemeControllerSetDensityRequestBody.html +2 -2
  75. package/docs/interfaces/ThemeControllerSetPresetRequestBody.html +1 -1
  76. package/docs/interfaces/ThemeControllerSetTypographyRequestBody.html +1 -1
  77. package/docs/modules.html +1 -3
  78. package/docs/types/DarkModeControllerDisableResponse.html +1 -1
  79. package/docs/types/DarkModeControllerEnableResponse.html +1 -1
  80. package/docs/types/DarkModeControllerGetResponse.html +1 -1
  81. package/docs/types/DarkModeControllerToggleResponse.html +1 -1
  82. package/docs/types/LanguageControllerGetResponse.html +1 -1
  83. package/docs/types/ProfileControllerGetResponse.html +1 -1
  84. package/docs/types/SetLanguageHook.html +1 -1
  85. package/docs/types/SettingsControllerGetPropertyResponse.html +1 -1
  86. package/docs/types/SettingsControllerGetResponse.html +1 -1
  87. package/docs/types/SettingsControllerPopPropertyResponse.html +1 -1
  88. package/docs/types/SettingsControllerSetRequestBody.html +1 -1
  89. package/docs/types/SettingsControllerShiftPropertyResponse.html +1 -1
  90. package/docs/types/SettingsControllerUnshiftPropertyResponse.html +1 -1
  91. package/docs/types/ThemeControllerGetResponse.html +1 -1
  92. package/docs/types/ThemeControllerSetRequestBody.html +1 -1
  93. package/docs/types/UserSettings.html +1 -1
  94. package/esm2022/index.mjs +1 -3
  95. package/esm2022/lib/user-profile.data-source.mjs +2 -15
  96. package/esm2022/lib/user-settings-dark-mode.service.mjs +6 -34
  97. package/esm2022/lib/user-settings-language.service.mjs +5 -20
  98. package/esm2022/lib/user-settings-theme.service.mjs +6 -43
  99. package/esm2022/lib/user-settings.data-source.mjs +2 -17
  100. package/esm2022/lib/user-settings.service.mjs +4 -16
  101. package/fesm2022/rxap-ngx-user.mjs +20 -171
  102. package/fesm2022/rxap-ngx-user.mjs.map +1 -1
  103. package/index.d.ts +0 -2
  104. package/lib/user-profile.data-source.d.ts +0 -5
  105. package/lib/user-settings-dark-mode.service.d.ts +1 -4
  106. package/lib/user-settings-language.service.d.ts +1 -4
  107. package/lib/user-settings-theme.service.d.ts +1 -4
  108. package/lib/user-settings.data-source.d.ts +0 -7
  109. package/lib/user-settings.service.d.ts +1 -4
  110. package/package.json +23 -23
  111. package/theme.css +1 -1
  112. package/docs/classes/BaseUserSettingsService.html +0 -5
  113. package/docs/classes/UserSettingsOfflineService.html +0 -6
  114. package/docs/hierarchy.html +0 -1
  115. package/esm2022/lib/base-user-settings.service.mjs +0 -19
  116. package/esm2022/lib/user-settings-offline.service.mjs +0 -31
  117. package/lib/base-user-settings.service.d.ts +0 -9
  118. package/lib/user-settings-offline.service.d.ts +0 -11
@@ -128,65 +128,6 @@
128
128
  </p>
129
129
 
130
130
 
131
- <section data-compodoc="block-index">
132
- <h3 id="index">Index</h3>
133
- <table class="table table-sm table-bordered index-table">
134
- <tbody>
135
- <tr>
136
- <td class="col-md-4">
137
- <h6><b>Properties</b></h6>
138
- </td>
139
- </tr>
140
- <tr>
141
- <td class="col-md-4">
142
- <ul class="index-list">
143
- <li>
144
- <span class="modifier">Protected</span>
145
- <span class="modifier">Readonly</span>
146
- <a href="#auth" >auth</a>
147
- </li>
148
- <li>
149
- <span class="modifier">Protected</span>
150
- <span class="modifier">Readonly</span>
151
- <a href="#offline" >offline</a>
152
- </li>
153
- <li>
154
- <span class="modifier">Protected</span>
155
- <a href="#waitForAuthenticationTimeout" >waitForAuthenticationTimeout</a>
156
- </li>
157
- </ul>
158
- </td>
159
- </tr>
160
-
161
- <tr>
162
- <td class="col-md-4">
163
- <h6><b>Methods</b></h6>
164
- </td>
165
- </tr>
166
- <tr>
167
- <td class="col-md-4">
168
- <ul class="index-list">
169
- <li>
170
- <span class="modifier">Protected</span>
171
- <span class="modifier"></span>
172
- <span class="modifier">Async</span>
173
- <a href="#execute" >execute</a>
174
- </li>
175
- <li>
176
- <span class="modifier">Protected</span>
177
- <a href="#waitUntilAuthenticated" >waitUntilAuthenticated</a>
178
- </li>
179
- </ul>
180
- </td>
181
- </tr>
182
-
183
-
184
-
185
-
186
-
187
- </tbody>
188
- </table>
189
- </section>
190
131
 
191
132
  <section data-compodoc="block-constructor">
192
133
  <h3 id="constructor">Constructor</h3>
@@ -199,7 +140,7 @@
199
140
  </tr>
200
141
  <tr>
201
142
  <td class="col-md-4">
202
- <div class="io-line">Defined in <a href="" data-line="32" class="link-to-prism">src/lib/user-settings.data-source.ts:32</a></div>
143
+ <div class="io-line">Defined in <a href="" data-line="17" class="link-to-prism">src/lib/user-settings.data-source.ts:17</a></div>
203
144
  </td>
204
145
  </tr>
205
146
 
@@ -237,238 +178,22 @@
237
178
  </table>
238
179
  </section>
239
180
 
240
- <section data-compodoc="block-methods">
241
-
242
- <h3 id="methods">
243
- Methods
244
- </h3>
245
- <table class="table table-sm table-bordered">
246
- <tbody>
247
- <tr>
248
- <td class="col-md-4">
249
- <a name="execute"></a>
250
- <span class="name">
251
- <span class="modifier">Protected</span>
252
- <span class="modifier"></span>
253
- <span class="modifier">Async</span>
254
- <span ><b>execute</b></span>
255
- <a href="#execute"><span class="icon ion-ios-link"></span></a>
256
- </span>
257
- </td>
258
- </tr>
259
- <tr>
260
- <td class="col-md-4">
261
- <span class="modifier-icon icon ion-ios-reset"></span>
262
- <code>execute(parameters?: <a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank">void</a>)</code>
263
- </td>
264
- </tr>
265
-
266
-
267
- <tr>
268
- <td class="col-md-4">
269
- <div class="io-line">Defined in <a href="" data-line="48"
270
- class="link-to-prism">src/lib/user-settings.data-source.ts:48</a></div>
271
- </td>
272
- </tr>
273
-
274
-
275
- <tr>
276
- <td class="col-md-4">
277
-
278
- <div class="io-description">
279
- <b>Parameters :</b>
280
-
281
- <table class="params">
282
- <thead>
283
- <tr>
284
- <td>Name</td>
285
- <td>Type</td>
286
- <td>Optional</td>
287
- </tr>
288
- </thead>
289
- <tbody>
290
- <tr>
291
- <td>parameters</td>
292
- <td>
293
- <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
294
- </td>
295
-
296
- <td>
297
- Yes
298
- </td>
299
-
300
-
301
- </tr>
302
- </tbody>
303
- </table>
304
- </div>
305
- <div class="io-description">
306
- <b>Returns : </b> <code>unknown</code>
307
-
308
- </div>
309
- <div class="io-description">
310
-
311
- </div>
312
- </td>
313
- </tr>
314
- </tbody>
315
- </table>
316
- <table class="table table-sm table-bordered">
317
- <tbody>
318
- <tr>
319
- <td class="col-md-4">
320
- <a name="waitUntilAuthenticated"></a>
321
- <span class="name">
322
- <span class="modifier">Protected</span>
323
- <span ><b>waitUntilAuthenticated</b></span>
324
- <a href="#waitUntilAuthenticated"><span class="icon ion-ios-link"></span></a>
325
- </span>
326
- </td>
327
- </tr>
328
- <tr>
329
- <td class="col-md-4">
330
- <span class="modifier-icon icon ion-ios-reset"></span>
331
- <code>waitUntilAuthenticated()</code>
332
- </td>
333
- </tr>
334
-
335
-
336
- <tr>
337
- <td class="col-md-4">
338
- <div class="io-line">Defined in <a href="" data-line="41"
339
- class="link-to-prism">src/lib/user-settings.data-source.ts:41</a></div>
340
- </td>
341
- </tr>
342
-
343
-
344
- <tr>
345
- <td class="col-md-4">
346
-
347
- <div class="io-description">
348
- <b>Returns : </b> <code>Promise&lt;boolean&gt;</code>
349
-
350
- </div>
351
- </td>
352
- </tr>
353
- </tbody>
354
- </table>
355
- </section>
356
- <section data-compodoc="block-properties">
357
-
358
- <h3 id="inputs">
359
- Properties
360
- </h3>
361
- <table class="table table-sm table-bordered">
362
- <tbody>
363
- <tr>
364
- <td class="col-md-4">
365
- <a name="auth"></a>
366
- <span class="name">
367
- <span class="modifier">Protected</span>
368
- <span class="modifier">Readonly</span>
369
- <span ><b>auth</b></span>
370
- <a href="#auth"><span class="icon ion-ios-link"></span></a>
371
- </span>
372
- </td>
373
- </tr>
374
- <tr>
375
- <td class="col-md-4">
376
- <i>Default value : </i><code>inject(RxapAuthenticationService)</code>
377
- </td>
378
- </tr>
379
- <tr>
380
- <td class="col-md-4">
381
- <div class="io-line">Defined in <a href="" data-line="28" class="link-to-prism">src/lib/user-settings.data-source.ts:28</a></div>
382
- </td>
383
- </tr>
384
-
385
-
386
- </tbody>
387
- </table>
388
- <table class="table table-sm table-bordered">
389
- <tbody>
390
- <tr>
391
- <td class="col-md-4">
392
- <a name="offline"></a>
393
- <span class="name">
394
- <span class="modifier">Protected</span>
395
- <span class="modifier">Readonly</span>
396
- <span ><b>offline</b></span>
397
- <a href="#offline"><span class="icon ion-ios-link"></span></a>
398
- </span>
399
- </td>
400
- </tr>
401
- <tr>
402
- <td class="col-md-4">
403
- <i>Default value : </i><code>inject(UserSettingsOfflineService)</code>
404
- </td>
405
- </tr>
406
- <tr>
407
- <td class="col-md-4">
408
- <div class="io-line">Defined in <a href="" data-line="30" class="link-to-prism">src/lib/user-settings.data-source.ts:30</a></div>
409
- </td>
410
- </tr>
411
-
412
-
413
- </tbody>
414
- </table>
415
- <table class="table table-sm table-bordered">
416
- <tbody>
417
- <tr>
418
- <td class="col-md-4">
419
- <a name="waitForAuthenticationTimeout"></a>
420
- <span class="name">
421
- <span class="modifier">Protected</span>
422
- <span ><b>waitForAuthenticationTimeout</b></span>
423
- <a href="#waitForAuthenticationTimeout"><span class="icon ion-ios-link"></span></a>
424
- </span>
425
- </td>
426
- </tr>
427
- <tr>
428
- <td class="col-md-4">
429
- <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
430
-
431
- </td>
432
- </tr>
433
- <tr>
434
- <td class="col-md-4">
435
- <i>Default value : </i><code>10000</code>
436
- </td>
437
- </tr>
438
- <tr>
439
- <td class="col-md-4">
440
- <div class="io-line">Defined in <a href="" data-line="32" class="link-to-prism">src/lib/user-settings.data-source.ts:32</a></div>
441
- </td>
442
- </tr>
443
181
 
444
182
 
445
- </tbody>
446
- </table>
447
- </section>
448
-
449
183
  </div>
450
184
 
451
185
 
452
186
  <div class="tab-pane fade tab-source-code" id="source">
453
187
  <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import {
454
- inject,
455
188
  Inject,
456
189
  Injectable,
457
190
  } from &#x27;@angular/core&#x27;;
458
- import { RxapAuthenticationService } from &#x27;@rxap/authentication&#x27;;
459
191
  import {
460
192
  MethodDataSource,
461
193
  RxapDataSource,
462
194
  } from &#x27;@rxap/data-source&#x27;;
463
- import {
464
- filter,
465
- firstValueFrom,
466
- of,
467
- timeout,
468
- } from &#x27;rxjs&#x27;;
469
195
  import { SettingsControllerGetRemoteMethod } from &#x27;./openapi/remote-methods/settings-controller-get.remote-method&#x27;;
470
196
  import { SettingsControllerGetResponse } from &#x27;./openapi/responses/settings-controller-get.response&#x27;;
471
- import { UserSettingsOfflineService } from &#x27;./user-settings-offline.service&#x27;;
472
197
 
473
198
  @Injectable({ providedIn: &#x27;root&#x27; })
474
199
  @RxapDataSource({
@@ -477,12 +202,6 @@ import { UserSettingsOfflineService } from &#x27;./user-settings-offline.service
477
202
  })
478
203
  export class UserSettingsDataSource&lt;T&gt; extends MethodDataSource&lt;SettingsControllerGetResponse&lt;T&gt;, void&gt; {
479
204
 
480
- protected readonly auth &#x3D; inject(RxapAuthenticationService);
481
-
482
- protected readonly offline &#x3D; inject(UserSettingsOfflineService);
483
-
484
- protected waitForAuthenticationTimeout &#x3D; 10000;
485
-
486
205
  constructor(
487
206
  @Inject(SettingsControllerGetRemoteMethod)
488
207
  method: SettingsControllerGetRemoteMethod&lt;T&gt;,
@@ -490,20 +209,6 @@ export class UserSettingsDataSource&lt;T&gt; extends MethodDataSource&lt;Setting
490
209
  super(method, true);
491
210
  }
492
211
 
493
- protected waitUntilAuthenticated(): Promise&lt;boolean&gt; {
494
- return firstValueFrom(this.auth.isAuthenticated$.pipe(
495
- filter((isAuthenticated): isAuthenticated is boolean &#x3D;&gt; isAuthenticated &#x3D;&#x3D;&#x3D; true),
496
- timeout({ each: this.waitForAuthenticationTimeout, with: () &#x3D;&gt; of(false) }),
497
- ));
498
- }
499
-
500
- protected override async execute(parameters?: void) {
501
- if (await this.waitUntilAuthenticated()) {
502
- return super.execute(parameters);
503
- }
504
- return this.offline.get();
505
- }
506
-
507
212
  }
508
213
  </code></pre>
509
214
  </div>