@rxap/ngx-localize 19.1.0-dev.8 → 19.1.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 (52) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/compodoc/changelog.html +4 -0
  3. package/compodoc/dependencies.html +2 -4
  4. package/compodoc/js/menu-wc.js +3 -0
  5. package/compodoc/js/menu-wc_es5.js +1 -1
  6. package/compodoc/js/search/search_index.js +2 -2
  7. package/compodoc/miscellaneous/functions.html +53 -307
  8. package/compodoc/miscellaneous/typealiases.html +235 -0
  9. package/compodoc/properties.html +1 -1
  10. package/docs/documentation.json +616 -246
  11. package/docs/html/assets/navigation.js +1 -1
  12. package/docs/html/assets/search.js +1 -1
  13. package/docs/html/classes/I18nService.html +3 -3
  14. package/docs/html/classes/LanguageSelectorService.html +4 -4
  15. package/docs/html/functions/LanguageInterceptor.html +2 -2
  16. package/docs/html/functions/defaultLoadModule.html +4 -0
  17. package/docs/html/functions/loadI18nBootstrapHook.html +1 -4
  18. package/docs/html/functions/loadLanguages.html +4 -3
  19. package/docs/html/index.html +2 -2
  20. package/docs/html/modules.html +1 -1
  21. package/docs/html/types/FetchTranslationsFunction.html +1 -0
  22. package/docs/html/types/LoadModuleFunction.html +1 -0
  23. package/docs/markdown/README.md +1 -1
  24. package/docs/markdown/classes/I18nService.md +5 -5
  25. package/docs/markdown/classes/LanguageSelectorService.md +7 -7
  26. package/docs/markdown/functions/LanguageInterceptor.md +2 -2
  27. package/docs/markdown/functions/defaultLoadModule.md +27 -0
  28. package/docs/markdown/functions/loadI18nBootstrapHook.md +21 -11
  29. package/docs/markdown/functions/loadLanguages.md +10 -4
  30. package/docs/markdown/globals.md +8 -3
  31. package/docs/markdown/type-aliases/FetchTranslationsFunction.md +29 -0
  32. package/docs/markdown/type-aliases/LoadModuleFunction.md +21 -0
  33. package/docs/wiki/Class.I18nService.md +4 -4
  34. package/docs/wiki/Class.LanguageSelectorService.md +6 -6
  35. package/docs/wiki/Function.LanguageInterceptor.md +1 -1
  36. package/docs/wiki/Function.defaultLoadModule.md +23 -0
  37. package/docs/wiki/Function.loadI18nBootstrapHook.md +20 -10
  38. package/docs/wiki/Function.loadLanguages.md +9 -3
  39. package/docs/wiki/TypeAlias.FetchTranslationsFunction.md +25 -0
  40. package/docs/wiki/TypeAlias.LoadModuleFunction.md +17 -0
  41. package/docs/wiki/_Sidebar.md +6 -1
  42. package/docs/wiki/globals.md +7 -2
  43. package/fesm2022/rxap-ngx-localize.mjs +19 -131
  44. package/fesm2022/rxap-ngx-localize.mjs.map +1 -1
  45. package/index.d.ts +0 -1
  46. package/lib/load-i18n-bootstrap-hook.d.ts +2 -7
  47. package/lib/load-languages.d.ts +14 -1
  48. package/package.json +19 -20
  49. package/docs/html/functions/xliffToJson.html +0 -4
  50. package/docs/markdown/functions/xliffToJson.md +0 -27
  51. package/docs/wiki/Function.xliffToJson.md +0 -23
  52. package/lib/xliff-to-json.d.ts +0 -7
@@ -114,18 +114,9 @@
114
114
  <li>
115
115
  <a href="#defaultLoadModule" title="src/lib/load-languages.ts" ><b>defaultLoadModule</b>&nbsp;&nbsp;&nbsp;(src/.../load-languages.ts)</a>
116
116
  </li>
117
- <li>
118
- <a href="#fetchTranslation" title="src/lib/load-languages.ts" ><b>fetchTranslation</b>&nbsp;&nbsp;&nbsp;(src/.../load-languages.ts)</a>
119
- </li>
120
- <li>
121
- <a href="#fetchTranslations" title="src/lib/load-languages.ts" ><b>fetchTranslations</b>&nbsp;&nbsp;&nbsp;(src/.../load-languages.ts)</a>
122
- </li>
123
117
  <li>
124
118
  <a href="#initGenerator" title="src/generators/init/generator.ts" ><b>initGenerator</b>&nbsp;&nbsp;&nbsp;(src/.../generator.ts)</a>
125
119
  </li>
126
- <li>
127
- <a href="#isTranslationXml" title="src/lib/load-languages.ts" ><b>isTranslationXml</b>&nbsp;&nbsp;&nbsp;(src/.../load-languages.ts)</a>
128
- </li>
129
120
  <li>
130
121
  <a href="#LanguageInterceptor" title="src/lib/language-interceptor.ts" ><b>LanguageInterceptor</b>&nbsp;&nbsp;&nbsp;(src/.../language-interceptor.ts)</a>
131
122
  </li>
@@ -135,9 +126,6 @@
135
126
  <li>
136
127
  <a href="#loadLanguages" title="src/lib/load-languages.ts" ><b>loadLanguages</b>&nbsp;&nbsp;&nbsp;(src/.../load-languages.ts)</a>
137
128
  </li>
138
- <li>
139
- <a href="#xliffToJson" title="src/lib/xliff-to-json.ts" ><b>xliffToJson</b>&nbsp;&nbsp;&nbsp;(src/.../xliff-to-json.ts)</a>
140
- </li>
141
129
  </ul>
142
130
  </td>
143
131
  </tr>
@@ -214,88 +202,16 @@
214
202
  <tbody>
215
203
  <tr>
216
204
  <td class="col-md-4">
217
- <a name="fetchTranslation"></a>
218
- <span class="name">
219
- <span ><b>fetchTranslation</b></span>
220
- <a href="#fetchTranslation"><span class="icon ion-ios-link"></span></a>
221
- </span>
222
- </td>
223
- </tr>
224
- <tr>
225
- <td class="col-md-4">
226
- <code>fetchTranslation(locale: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
227
- </td>
228
- </tr>
229
-
230
-
231
-
232
-
233
- <tr>
234
- <td class="col-md-4">
235
- <div class="io-description"><p>Fetches the translation file for the specified locale in XLIFF format.</p>
236
- </div>
237
-
238
- <div class="io-description">
239
- <b>Parameters :</b>
240
-
241
- <table class="params">
242
- <thead>
243
- <tr>
244
- <td>Name</td>
245
- <td>Type</td>
246
- <td>Optional</td>
247
- <td>Description</td>
248
- </tr>
249
- </thead>
250
- <tbody>
251
- <tr>
252
- <td>locale</td>
253
- <td>
254
- <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
255
- </td>
256
-
257
- <td>
258
- No
259
- </td>
260
-
261
-
262
- <td>
263
- <ul>
264
- <li>The locale identifier for which the translation file should be fetched.</li>
265
- </ul>
266
-
267
- </td>
268
- </tr>
269
- </tbody>
270
- </table>
271
- </div>
272
- <div class="io-description">
273
- <b>Returns : </b> <code>Promise&lt;string | null&gt;</code>
274
-
275
- </div>
276
- <div class="io-description">
277
- <p>A promise that resolves to the XLIFF translation file as a string
278
- if successfully fetched and valid, or null if the file is invalid or could not be fetched.</p>
279
-
280
- </div>
281
- </td>
282
- </tr>
283
- </tbody>
284
- </table>
285
- <table class="table table-sm table-bordered">
286
- <tbody>
287
- <tr>
288
- <td class="col-md-4">
289
- <a name="fetchTranslations"></a>
205
+ <a name="loadLanguages"></a>
290
206
  <span class="name">
291
- <span ><b>fetchTranslations</b></span>
292
- <a href="#fetchTranslations"><span class="icon ion-ios-link"></span></a>
207
+ <span ><b>loadLanguages</b></span>
208
+ <a href="#loadLanguages"><span class="icon ion-ios-link"></span></a>
293
209
  </span>
294
210
  </td>
295
211
  </tr>
296
212
  <tr>
297
213
  <td class="col-md-4">
298
- <code>fetchTranslations(locale: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, preferredLanguages, fallback: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
214
+ <code>loadLanguages(fetchTranslations: <a href="../undefineds/FetchTranslationsFunction.html" target="_self">FetchTranslationsFunction</a>, loadModule: <a href="../undefineds/LoadModuleFunction.html" target="_self">LoadModuleFunction</a>, locale: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, preferredLanguages, fallback: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
299
215
  </td>
300
216
  </tr>
301
217
 
@@ -304,8 +220,9 @@ if successfully fetched and valid, or null if the file is invalid or could not b
304
220
 
305
221
  <tr>
306
222
  <td class="col-md-4">
307
- <div class="io-description"><p>Fetches translations for a specified locale, attempts to use preferred languages or a fallback if necessary.
308
- The function retrieves and parses translation data from XLIFF files.</p>
223
+ <div class="io-description"><p>Loads language translations and sets the locale for the application.
224
+ This function fetches the translations based on the specified locale, preferred languages,
225
+ and a fallback, then initializes the translations and optionally loads additional modules.</p>
309
226
  </div>
310
227
 
311
228
  <div class="io-description">
@@ -317,183 +234,35 @@ The function retrieves and parses translation data from XLIFF files.</p>
317
234
  <td>Name</td>
318
235
  <td>Type</td>
319
236
  <td>Optional</td>
237
+ <td>Default value</td>
320
238
  <td>Description</td>
321
239
  </tr>
322
240
  </thead>
323
241
  <tbody>
324
242
  <tr>
325
- <td>locale</td>
326
- <td>
327
- <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
328
- </td>
329
-
330
- <td>
331
- No
332
- </td>
333
-
334
-
335
- <td>
336
- <ul>
337
- <li>The primary locale for which to fetch translations.</li>
338
- </ul>
339
-
340
- </td>
341
- </tr>
342
- <tr>
343
- <td>preferredLanguages</td>
243
+ <td>fetchTranslations</td>
344
244
  <td>
245
+ <code><a href="../miscellaneous/typealiases.html#FetchTranslationsFunction" target="_self" >FetchTranslationsFunction</a></code>
345
246
  </td>
346
247
 
347
248
  <td>
348
249
  No
349
250
  </td>
350
251
 
351
-
352
252
  <td>
353
- <ul>
354
- <li>An array of preferred fallback locales to try if the primary locale fails.</li>
355
- </ul>
356
-
357
- </td>
358
- </tr>
359
- <tr>
360
- <td>fallback</td>
361
- <td>
362
- <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
363
253
  </td>
364
254
 
365
- <td>
366
- No
367
- </td>
368
-
369
-
370
255
  <td>
371
256
  <ul>
372
- <li>The fallback locale to be used if both the primary and preferred locales fail.</li>
257
+ <li>A function to fetch the translation json map</li>
373
258
  </ul>
374
259
 
375
260
  </td>
376
261
  </tr>
377
- </tbody>
378
- </table>
379
- </div>
380
- <div class="io-description">
381
- <b>Returns : </b> <code>Promise&lt;literal type | null&gt;</code>
382
-
383
- </div>
384
- <div class="io-description">
385
- <p>A promise resolving to an object containing the parsed translation data (json) and the effective locale, or null if loading fails.</p>
386
-
387
- </div>
388
- </td>
389
- </tr>
390
- </tbody>
391
- </table>
392
- <table class="table table-sm table-bordered">
393
- <tbody>
394
- <tr>
395
- <td class="col-md-4">
396
- <a name="isTranslationXml"></a>
397
- <span class="name">
398
- <span ><b>isTranslationXml</b></span>
399
- <a href="#isTranslationXml"><span class="icon ion-ios-link"></span></a>
400
- </span>
401
- </td>
402
- </tr>
403
- <tr>
404
- <td class="col-md-4">
405
- <code>isTranslationXml(xml: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
406
- </td>
407
- </tr>
408
-
409
-
410
-
411
-
412
- <tr>
413
- <td class="col-md-4">
414
-
415
- <div class="io-description">
416
- <b>Parameters :</b>
417
-
418
- <table class="params">
419
- <thead>
420
- <tr>
421
- <td>Name</td>
422
- <td>Type</td>
423
- <td>Optional</td>
424
- </tr>
425
- </thead>
426
- <tbody>
427
- <tr>
428
- <td>xml</td>
429
- <td>
430
- <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
431
- </td>
432
-
433
- <td>
434
- No
435
- </td>
436
-
437
-
438
- </tr>
439
- </tbody>
440
- </table>
441
- </div>
442
- <div class="io-description">
443
- <b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code>
444
-
445
- </div>
446
- <div class="io-description">
447
-
448
- </div>
449
- </td>
450
- </tr>
451
- </tbody>
452
- </table>
453
- <table class="table table-sm table-bordered">
454
- <tbody>
455
- <tr>
456
- <td class="col-md-4">
457
- <a name="loadLanguages"></a>
458
- <span class="name">
459
- <span ><b>loadLanguages</b></span>
460
- <a href="#loadLanguages"><span class="icon ion-ios-link"></span></a>
461
- </span>
462
- </td>
463
- </tr>
464
- <tr>
465
- <td class="col-md-4">
466
- <code>loadLanguages(loadModule, locale: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, preferredLanguages, fallback: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
467
- </td>
468
- </tr>
469
-
470
-
471
-
472
-
473
- <tr>
474
- <td class="col-md-4">
475
- <div class="io-description"><p>Loads language translations and sets the locale for the application.
476
- This function fetches the translations based on the specified locale, preferred languages,
477
- and a fallback, then initializes the translations and optionally loads additional modules.</p>
478
- </div>
479
-
480
- <div class="io-description">
481
- <b>Parameters :</b>
482
-
483
- <table class="params">
484
- <thead>
485
- <tr>
486
- <td>Name</td>
487
- <td>Type</td>
488
- <td>Optional</td>
489
- <td>Default value</td>
490
- <td>Description</td>
491
- </tr>
492
- </thead>
493
- <tbody>
494
262
  <tr>
495
263
  <td>loadModule</td>
496
264
  <td>
265
+ <code><a href="../miscellaneous/typealiases.html#LoadModuleFunction" target="_self" >LoadModuleFunction</a></code>
497
266
  </td>
498
267
 
499
268
  <td>
@@ -754,7 +523,7 @@ and a fallback, then initializes the translations and optionally loads additiona
754
523
  </tr>
755
524
  <tr>
756
525
  <td class="col-md-4">
757
- <code>loadI18nBootstrapHook(options: Partial)</code>
526
+ <code>loadI18nBootstrapHook(fetchTranslations: <a href="../undefineds/FetchTranslationsFunction.html" target="_self">FetchTranslationsFunction</a>, loadModule: <a href="../undefineds/LoadModuleFunction.html" target="_self">LoadModuleFunction</a>, locale?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, preferredLanguages?, fallback?: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
758
527
  </td>
759
528
  </tr>
760
529
 
@@ -763,8 +532,6 @@ and a fallback, then initializes the translations and optionally loads additiona
763
532
 
764
533
  <tr>
765
534
  <td class="col-md-4">
766
- <div class="io-description"><p>Loads internationalization (i18n) bootstrap settings for the application.</p>
767
- </div>
768
535
 
769
536
  <div class="io-description">
770
537
  <b>Parameters :</b>
@@ -775,100 +542,79 @@ and a fallback, then initializes the translations and optionally loads additiona
775
542
  <td>Name</td>
776
543
  <td>Type</td>
777
544
  <td>Optional</td>
778
- <td>Description</td>
545
+ <td>Default value</td>
779
546
  </tr>
780
547
  </thead>
781
548
  <tbody>
782
549
  <tr>
783
- <td>options</td>
550
+ <td>fetchTranslations</td>
784
551
  <td>
785
- <code>Partial</code>
552
+ <code><a href="../miscellaneous/typealiases.html#FetchTranslationsFunction" target="_self" >FetchTranslationsFunction</a></code>
786
553
  </td>
787
554
 
788
555
  <td>
789
556
  No
790
557
  </td>
791
558
 
559
+ <td>
560
+ </td>
792
561
 
562
+ </tr>
563
+ <tr>
564
+ <td>loadModule</td>
793
565
  <td>
794
- <ul>
795
- <li>The application configuration options.</li>
796
- </ul>
566
+ <code><a href="../miscellaneous/typealiases.html#LoadModuleFunction" target="_self" >LoadModuleFunction</a></code>
567
+ </td>
797
568
 
569
+ <td>
570
+ No
798
571
  </td>
799
- </tr>
800
- </tbody>
801
- </table>
802
- </div>
803
- <div class="io-description">
804
- <b>Returns : </b> <code>Promise&lt;void&gt;</code>
805
572
 
806
- </div>
807
- <div class="io-description">
808
- <p>A promise that resolves when the i18n bootstrap process completes.</p>
573
+ <td>
574
+ <code>defaultLoadModule</code>
575
+ </td>
809
576
 
810
- </div>
811
- </td>
812
- </tr>
813
- </tbody>
814
- </table>
815
- </section> <h3>src/lib/xliff-to-json.ts</h3>
816
- <section data-compodoc="block-methods">
817
- <h3></h3> <table class="table table-sm table-bordered">
818
- <tbody>
819
- <tr>
820
- <td class="col-md-4">
821
- <a name="xliffToJson"></a>
822
- <span class="name">
823
- <span ><b>xliffToJson</b></span>
824
- <a href="#xliffToJson"><span class="icon ion-ios-link"></span></a>
825
- </span>
826
- </td>
827
- </tr>
828
- <tr>
829
- <td class="col-md-4">
830
- <code>xliffToJson(translations: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code>
831
- </td>
832
- </tr>
577
+ </tr>
578
+ <tr>
579
+ <td>locale</td>
580
+ <td>
581
+ <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
582
+ </td>
833
583
 
584
+ <td>
585
+ Yes
586
+ </td>
834
587
 
588
+ <td>
589
+ </td>
835
590
 
591
+ </tr>
592
+ <tr>
593
+ <td>preferredLanguages</td>
594
+ <td>
595
+ </td>
836
596
 
837
- <tr>
838
- <td class="col-md-4">
839
- <div class="io-description"><p>Converts an XLIFF translation string into a JSON object with translation keys and their corresponding values.</p>
840
- </div>
597
+ <td>
598
+ Yes
599
+ </td>
600
+
601
+ <td>
602
+ </td>
841
603
 
842
- <div class="io-description">
843
- <b>Parameters :</b>
844
-
845
- <table class="params">
846
- <thead>
847
- <tr>
848
- <td>Name</td>
849
- <td>Type</td>
850
- <td>Optional</td>
851
- <td>Description</td>
852
604
  </tr>
853
- </thead>
854
- <tbody>
855
605
  <tr>
856
- <td>translations</td>
606
+ <td>fallback</td>
857
607
  <td>
858
608
  <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code>
859
609
  </td>
860
610
 
861
611
  <td>
862
- No
612
+ Yes
863
613
  </td>
864
614
 
865
-
866
615
  <td>
867
- <ul>
868
- <li>A string in XLIFF format containing translations to be parsed and transformed.</li>
869
- </ul>
870
-
871
616
  </td>
617
+
872
618
  </tr>
873
619
  </tbody>
874
620
  </table>