@luigi-project/container 1.4.0 → 1.5.0-dev.202412100034

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.
@@ -209,15 +209,8 @@
209
209
  "name": "webcomponent",
210
210
  "type": {
211
211
  "text": "any"
212
- }
213
- },
214
- {
215
- "kind": "method",
216
- "name": "closeAlert"
217
- },
218
- {
219
- "kind": "method",
220
- "name": "sendCustomMessage"
212
+ },
213
+ "default": "undefined"
221
214
  },
222
215
  {
223
216
  "kind": "method",
@@ -225,11 +218,11 @@
225
218
  },
226
219
  {
227
220
  "kind": "method",
228
- "name": "attributeChangedCallback"
221
+ "name": "sendCustomMessage"
229
222
  },
230
223
  {
231
224
  "kind": "method",
232
- "name": "getNoShadow"
225
+ "name": "closeAlert"
233
226
  },
234
227
  {
235
228
  "kind": "method",
@@ -239,224 +232,224 @@
239
232
  "events": [
240
233
  {
241
234
  "name": "custom-message",
242
- "description": "A message emitted from the micro frontend when a custom message is sent.",
235
+ "description": "Event fired when the micro frontend sends a custom message.",
243
236
  "type": {
244
237
  "text": "Event"
245
238
  }
246
239
  },
247
240
  {
248
241
  "name": "get-context-request",
249
- "description": "A message emitted from the micro frontend when the context data is sent.",
242
+ "description": "Event fired when the micro frontend requests the context data.",
250
243
  "type": {
251
244
  "text": "Event"
252
245
  }
253
246
  },
254
247
  {
255
248
  "name": "navigation-request",
256
- "description": "A message emitted from the micro frontend when a navigation request is sent.",
249
+ "description": "Event fired when a navigation has been requested by the micro frontend.",
257
250
  "type": {
258
251
  "text": "Event"
259
252
  }
260
253
  },
261
254
  {
262
255
  "name": "show-alert-request",
263
- "description": "A message emitted from the micro frontend when a request to show an alert is sent.",
256
+ "description": "Event fired when the micro frontend requests to show an alert.",
264
257
  "type": {
265
258
  "text": "Event"
266
259
  }
267
260
  },
268
261
  {
269
262
  "name": "close-alert-request",
270
- "description": "A message emitted from the micro frontend when a request to close an alert is sent.",
263
+ "description": "Event fired when the micro frontend requests to close an alert.",
271
264
  "type": {
272
265
  "text": "Event"
273
266
  }
274
267
  },
275
268
  {
276
269
  "name": "initialized",
277
- "description": "A message emitted from the micro frontend when it is first initialized.",
270
+ "description": "Event fired when the micro frontend has been initialized.",
278
271
  "type": {
279
272
  "text": "Event"
280
273
  }
281
274
  },
282
275
  {
283
276
  "name": "add-search-params-request",
284
- "description": "A message emitted from the micro frontend to request adding search parameters to the URL.",
277
+ "description": "Event fired when the micro frontend requests the addition of search parameters to the URL.",
285
278
  "type": {
286
279
  "text": "Event"
287
280
  }
288
281
  },
289
282
  {
290
283
  "name": "add-node-params-request",
291
- "description": "A message emitted from the micro frontend to request adding node parameters to the URL.",
284
+ "description": "Event fired when the micro frontend requests the addition of node parameters to the URL.",
292
285
  "type": {
293
286
  "text": "Event"
294
287
  }
295
288
  },
296
289
  {
297
290
  "name": "show-confirmation-modal-request",
298
- "description": "A message emitted from the micro frontend when a request to show a confirmation modal is sent.",
291
+ "description": "Event fired when the micro frontend requests to show a confirmation modal.",
299
292
  "type": {
300
293
  "text": "Event"
301
294
  }
302
295
  },
303
296
  {
304
297
  "name": "show-loading-indicator-request",
305
- "description": "A message emitted from the micro frontend when a request to show a loading indicator is sent.",
298
+ "description": "Event fired when the micro frontend requests to show a loading indicator.",
306
299
  "type": {
307
300
  "text": "Event"
308
301
  }
309
302
  },
310
303
  {
311
304
  "name": "hide-loading-indicator-request",
312
- "description": "A message emitted from the micro frontend when a request to hide the loading indicator is sent.",
305
+ "description": "Event fired when the micro frontend requests to hide the loading indicator.",
313
306
  "type": {
314
307
  "text": "Event"
315
308
  }
316
309
  },
317
310
  {
318
311
  "name": "set-current-locale-request",
319
- "description": "A message emitted from the micro frontend when a request to set the current locale is sent.",
312
+ "description": "Event fired when the micro frontend requests to set the current locale.",
320
313
  "type": {
321
314
  "text": "Event"
322
315
  }
323
316
  },
324
317
  {
325
318
  "name": "set-storage-request",
326
- "description": "A message emitted from the micro frontend when a request to modify the local storage is sent.",
319
+ "description": "Event fired when the micro frontend requests to modify the local storage.",
327
320
  "type": {
328
321
  "text": "Event"
329
322
  }
330
323
  },
331
324
  {
332
325
  "name": "runtime-error-handling-request",
333
- "description": "A message emitted from the micro frontend when a request to handle an error during runtime is sent.",
326
+ "description": "Event fired when the micro frontend requests to handle errors that might happen during the runtime of the micro frontend.",
334
327
  "type": {
335
328
  "text": "Event"
336
329
  }
337
330
  },
338
331
  {
339
332
  "name": "set-anchor-request",
340
- "description": "A message emitted from the micro frontend when a request to set the anchor of the URL is sent.",
333
+ "description": "Event fired when the micro frontend requests to set the anchor of the URL.",
341
334
  "type": {
342
335
  "text": "Event"
343
336
  }
344
337
  },
345
338
  {
346
339
  "name": "set-third-party-cookies-request",
347
- "description": "A message emitted from the micro frontend when a request to set third-party cookies is sent.",
340
+ "description": "Event fired when the micro frontend requests to set third-party cookies.",
348
341
  "type": {
349
342
  "text": "Event"
350
343
  }
351
344
  },
352
345
  {
353
346
  "name": "navigate-back-request",
354
- "description": "A message emitted from the micro frontend when a request to navigate back is sent.",
347
+ "description": "Event fired when the micro frontend requests to navigate back.",
355
348
  "type": {
356
349
  "text": "Event"
357
350
  }
358
351
  },
359
352
  {
360
353
  "name": "get-current-route-request",
361
- "description": "A message emitted from the micro frontend when a request to receive the current app route is sent.",
354
+ "description": "Event fired when the micro frontend requests the current app route.",
362
355
  "type": {
363
356
  "text": "Event"
364
357
  }
365
358
  },
366
359
  {
367
360
  "name": "report-navigation-completed-request",
368
- "description": "A message emitted from the micro frontend to report that the navigation is completed.",
361
+ "description": "Event fired to report that the micro frontend's navigation has completed.",
369
362
  "type": {
370
363
  "text": "Event"
371
364
  }
372
365
  },
373
366
  {
374
367
  "name": "update-modal-path-data-request",
375
- "description": "A message emitted from the micro frontend when a request to update the modal path parameters is sent.",
368
+ "description": "Event fired when the micro frontend requests to update the modal path parameters.",
376
369
  "type": {
377
370
  "text": "Event"
378
371
  }
379
372
  },
380
373
  {
381
374
  "name": "check-path-exists-request",
382
- "description": "A message emitted from the micro frontend when a request to check the validity of a path is sent.",
375
+ "description": "Event fired when the micro frontend requests to check the validity of a path.",
383
376
  "type": {
384
377
  "text": "Event"
385
378
  }
386
379
  },
387
380
  {
388
381
  "name": "set-dirty-status-request",
389
- "description": "A message emitted from the micro frontend when a request to set the 'dirty status' is sent.",
382
+ "description": "Event fired when the micro frontend requests to set the 'dirty status' which, for example, avoids closing when there are any unsaved changes.",
390
383
  "type": {
391
384
  "text": "Event"
392
385
  }
393
386
  },
394
387
  {
395
388
  "name": "set-viewgroup-data-request",
396
- "description": "A message emitted from the micro frontend when a request to set the view group data is sent.",
389
+ "description": "Event fired when the micro frontend requests to set the view group data.",
397
390
  "type": {
398
391
  "text": "Event"
399
392
  }
400
393
  },
401
394
  {
402
395
  "name": "set-document-title-request",
403
- "description": "A message emitted from the micro frontend when a request to set the document title is sent.",
396
+ "description": "Event fired when the micro frontend requests to set the document title.",
404
397
  "type": {
405
398
  "text": "Event"
406
399
  }
407
400
  },
408
401
  {
409
402
  "name": "open-user-settings-request",
410
- "description": "A message emitted from the micro frontend when a request to open user settings is sent.",
403
+ "description": "Event fired when the micro frontend requests to open the user settings.",
411
404
  "type": {
412
405
  "text": "Event"
413
406
  }
414
407
  },
415
408
  {
416
409
  "name": "close-user-settings-request",
417
- "description": "A message emitted from the micro frontend when a request to close user settings is sent.",
410
+ "description": "Event fired when the micro frontend requests to close the user settings.",
418
411
  "type": {
419
412
  "text": "Event"
420
413
  }
421
414
  },
422
415
  {
423
416
  "name": "collapse-leftnav-request",
424
- "description": "A message emitted from the micro frontend when a request to collapse the left side navigation is sent.",
417
+ "description": "Event fired when the micro frontend requests to collapse left side navigation.",
425
418
  "type": {
426
419
  "text": "Event"
427
420
  }
428
421
  },
429
422
  {
430
423
  "name": "update-top-navigation-request",
431
- "description": "A message emitted from the micro frontend when a request to update the top navigation is sent.",
424
+ "description": "Event fired when the micro frontend requests to update the top navigation.",
432
425
  "type": {
433
426
  "text": "Event"
434
427
  }
435
428
  },
436
429
  {
437
430
  "name": "path-exists-request",
438
- "description": "A message emitted from the micro frontend when a request to check if a path exists is sent.",
431
+ "description": "Event fired when the micro frontend requests to check if the path exists.",
439
432
  "type": {
440
433
  "text": "Event"
441
434
  }
442
435
  },
443
436
  {
444
437
  "name": "go-back-request",
445
- "description": "A message emitted from the micro frontend when a request to navigate back is sent.",
438
+ "description": "Event fired when the micro frontend requests to navigate back.",
446
439
  "type": {
447
440
  "text": "Event"
448
441
  }
449
442
  },
450
443
  {
451
444
  "name": "has-back-request",
452
- "description": "A message emitted from the micro frontend to check if there is a back navigation option.",
445
+ "description": "Event fired when the micro frontend requests to check if there are any preserved views.",
453
446
  "type": {
454
447
  "text": "Event"
455
448
  }
456
449
  },
457
450
  {
458
451
  "name": "remove-backdrop-request",
459
- "description": "A message emitted from the micro frontend when a request to remove the backdrop is sent.",
452
+ "description": "Event fired when the micro frontend requests to remove the backdrop.",
460
453
  "type": {
461
454
  "text": "Event"
462
455
  }
@@ -648,20 +641,13 @@
648
641
  "name": "webcomponent",
649
642
  "type": {
650
643
  "text": "any"
651
- }
644
+ },
645
+ "default": "undefined"
652
646
  },
653
647
  {
654
648
  "kind": "method",
655
649
  "name": "updateContext"
656
650
  },
657
- {
658
- "kind": "method",
659
- "name": "attributeChangedCallback"
660
- },
661
- {
662
- "kind": "method",
663
- "name": "getNoShadow"
664
- },
665
651
  {
666
652
  "kind": "method",
667
653
  "name": "init"
@@ -670,224 +656,224 @@
670
656
  "events": [
671
657
  {
672
658
  "name": "custom-message",
673
- "description": "A message emitted from the micro frontend when a custom message is sent.",
659
+ "description": "Event fired when the micro frontend sends a custom message.",
674
660
  "type": {
675
661
  "text": "Event"
676
662
  }
677
663
  },
678
664
  {
679
665
  "name": "get-context-request",
680
- "description": "A message emitted from the micro frontend when the context data is sent.",
666
+ "description": "Event fired when the micro frontend requests the context data.",
681
667
  "type": {
682
668
  "text": "Event"
683
669
  }
684
670
  },
685
671
  {
686
672
  "name": "navigation-request",
687
- "description": "A message emitted from the micro frontend when a navigation request is sent.",
673
+ "description": "Event fired when a navigation has been requested by the micro frontend.",
688
674
  "type": {
689
675
  "text": "Event"
690
676
  }
691
677
  },
692
678
  {
693
679
  "name": "show-alert-request",
694
- "description": "A message emitted from the micro frontend when a request to show an alert is sent.",
680
+ "description": "Event fired when the micro frontend requests to show an alert.",
695
681
  "type": {
696
682
  "text": "Event"
697
683
  }
698
684
  },
699
685
  {
700
686
  "name": "close-alert-request",
701
- "description": "A message emitted from the micro frontend when a request to close an alert is sent.",
687
+ "description": "Event fired when the micro frontend requests to close an alert.",
702
688
  "type": {
703
689
  "text": "Event"
704
690
  }
705
691
  },
706
692
  {
707
693
  "name": "initialized",
708
- "description": "A message emitted from the micro frontend when it is first initialized.",
694
+ "description": "Event fired when the micro frontend has been initialized.",
709
695
  "type": {
710
696
  "text": "Event"
711
697
  }
712
698
  },
713
699
  {
714
700
  "name": "add-search-params-request",
715
- "description": "A message emitted from the micro frontend to request adding search parameters to the URL.",
701
+ "description": "Event fired when the micro frontend requests the addition of search parameters to the URL.",
716
702
  "type": {
717
703
  "text": "Event"
718
704
  }
719
705
  },
720
706
  {
721
707
  "name": "add-node-params-request",
722
- "description": "A message emitted from the micro frontend to request adding node parameters to the URL.",
708
+ "description": "Event fired when the micro frontend requests the addition of node parameters to the URL.",
723
709
  "type": {
724
710
  "text": "Event"
725
711
  }
726
712
  },
727
713
  {
728
714
  "name": "show-confirmation-modal-request",
729
- "description": "A message emitted from the micro frontend when a request to show a confirmation modal is sent.",
715
+ "description": "Event fired when the micro frontend requests to show a confirmation modal.",
730
716
  "type": {
731
717
  "text": "Event"
732
718
  }
733
719
  },
734
720
  {
735
721
  "name": "show-loading-indicator-request",
736
- "description": "A message emitted from the micro frontend when a request to show a loading indicator is sent.",
722
+ "description": "Event fired when the micro frontend requests to show a loading indicator.",
737
723
  "type": {
738
724
  "text": "Event"
739
725
  }
740
726
  },
741
727
  {
742
728
  "name": "hide-loading-indicator-request",
743
- "description": "A message emitted from the micro frontend when a request to hide the loading indicator is sent.",
729
+ "description": "Event fired when the micro frontend requests to hide the loading indicator.",
744
730
  "type": {
745
731
  "text": "Event"
746
732
  }
747
733
  },
748
734
  {
749
735
  "name": "set-current-locale-request",
750
- "description": "A message emitted from the micro frontend when a request to set the current locale is sent.",
736
+ "description": "Event fired when the micro frontend requests to set the current locale.",
751
737
  "type": {
752
738
  "text": "Event"
753
739
  }
754
740
  },
755
741
  {
756
742
  "name": "set-storage-request",
757
- "description": "A message emitted from the micro frontend when a request to modify the local storage is sent.",
743
+ "description": "Event fired when the micro frontend requests to modify the local storage.",
758
744
  "type": {
759
745
  "text": "Event"
760
746
  }
761
747
  },
762
748
  {
763
749
  "name": "runtime-error-handling-request",
764
- "description": "A message emitted from the micro frontend when a request to handle an error during runtime is sent.",
750
+ "description": "Event fired when the micro frontend requests to handle errors that might happen during the runtime of the micro frontend.",
765
751
  "type": {
766
752
  "text": "Event"
767
753
  }
768
754
  },
769
755
  {
770
756
  "name": "set-anchor-request",
771
- "description": "A message emitted from the micro frontend when a request to set the anchor of the URL is sent.",
757
+ "description": "Event fired when the micro frontend requests to set the anchor of the URL.",
772
758
  "type": {
773
759
  "text": "Event"
774
760
  }
775
761
  },
776
762
  {
777
763
  "name": "set-third-party-cookies-request",
778
- "description": "A message emitted from the micro frontend when a request to set third-party cookies is sent.",
764
+ "description": "Event fired when the micro frontend requests to set third-party cookies.",
779
765
  "type": {
780
766
  "text": "Event"
781
767
  }
782
768
  },
783
769
  {
784
770
  "name": "navigate-back-request",
785
- "description": "A message emitted from the micro frontend when a request to navigate back is sent.",
771
+ "description": "Event fired when the micro frontend requests to navigate back.",
786
772
  "type": {
787
773
  "text": "Event"
788
774
  }
789
775
  },
790
776
  {
791
777
  "name": "get-current-route-request",
792
- "description": "A message emitted from the micro frontend when a request to receive the current app route is sent.",
778
+ "description": "Event fired when the micro frontend requests the current app route.",
793
779
  "type": {
794
780
  "text": "Event"
795
781
  }
796
782
  },
797
783
  {
798
784
  "name": "report-navigation-completed-request",
799
- "description": "A message emitted from the micro frontend to report that the navigation is completed.",
785
+ "description": "Event fired to report that the micro frontend's navigation has completed.",
800
786
  "type": {
801
787
  "text": "Event"
802
788
  }
803
789
  },
804
790
  {
805
791
  "name": "update-modal-path-data-request",
806
- "description": "A message emitted from the micro frontend when a request to update the modal path parameters is sent.",
792
+ "description": "Event fired when the micro frontend requests to update the modal path parameters.",
807
793
  "type": {
808
794
  "text": "Event"
809
795
  }
810
796
  },
811
797
  {
812
798
  "name": "check-path-exists-request",
813
- "description": "A message emitted from the micro frontend when a request to check the validity of a path is sent.",
799
+ "description": "Event fired when the micro frontend requests to check the validity of a path.",
814
800
  "type": {
815
801
  "text": "Event"
816
802
  }
817
803
  },
818
804
  {
819
805
  "name": "set-dirty-status-request",
820
- "description": "A message emitted from the micro frontend when a request to set the 'dirty status' is sent.",
806
+ "description": "Event fired when the micro frontend requests to set the 'dirty status' which, for example, avoids closing when there are any unsaved changes.",
821
807
  "type": {
822
808
  "text": "Event"
823
809
  }
824
810
  },
825
811
  {
826
812
  "name": "set-viewgroup-data-request",
827
- "description": "A message emitted from the micro frontend when a request to set the view group data is sent.",
813
+ "description": "Event fired when the micro frontend requests to set the view group data.",
828
814
  "type": {
829
815
  "text": "Event"
830
816
  }
831
817
  },
832
818
  {
833
819
  "name": "set-document-title-request",
834
- "description": "A message emitted from the micro frontend when a request to set the document title is sent.",
820
+ "description": "Event fired when the micro frontend requests to set the document title.",
835
821
  "type": {
836
822
  "text": "Event"
837
823
  }
838
824
  },
839
825
  {
840
826
  "name": "open-user-settings-request",
841
- "description": "A message emitted from the micro frontend when a request to open user settings is sent.",
827
+ "description": "Event fired when the micro frontend requests to open the user settings.",
842
828
  "type": {
843
829
  "text": "Event"
844
830
  }
845
831
  },
846
832
  {
847
833
  "name": "close-user-settings-request",
848
- "description": "A message emitted from the micro frontend when a request to close user settings is sent.",
834
+ "description": "Event fired when the micro frontend requests to close the user settings.",
849
835
  "type": {
850
836
  "text": "Event"
851
837
  }
852
838
  },
853
839
  {
854
840
  "name": "collapse-leftnav-request",
855
- "description": "A message emitted from the micro frontend when a request to collapse the left side navigation is sent.",
841
+ "description": "Event fired when the micro frontend requests to collapse left side navigation.",
856
842
  "type": {
857
843
  "text": "Event"
858
844
  }
859
845
  },
860
846
  {
861
847
  "name": "update-top-navigation-request",
862
- "description": "A message emitted from the micro frontend when a request to update the top navigation is sent.",
848
+ "description": "Event fired when the micro frontend requests to update the top navigation.",
863
849
  "type": {
864
850
  "text": "Event"
865
851
  }
866
852
  },
867
853
  {
868
854
  "name": "path-exists-request",
869
- "description": "A message emitted from the micro frontend when a request to check if a path exists is sent.",
855
+ "description": "Event fired when the micro frontend requests to check if the path exists.",
870
856
  "type": {
871
857
  "text": "Event"
872
858
  }
873
859
  },
874
860
  {
875
861
  "name": "go-back-request",
876
- "description": "A message emitted from the micro frontend when a request to navigate back is sent.",
862
+ "description": "Event fired when the micro frontend requests to navigate back.",
877
863
  "type": {
878
864
  "text": "Event"
879
865
  }
880
866
  },
881
867
  {
882
868
  "name": "has-back-request",
883
- "description": "A message emitted from the micro frontend to check if there is a back navigation option.",
869
+ "description": "Event fired when the micro frontend requests to check if there are any preserved views.",
884
870
  "type": {
885
871
  "text": "Event"
886
872
  }
887
873
  },
888
874
  {
889
875
  "name": "remove-backdrop-request",
890
- "description": "A message emitted from the micro frontend when a request to remove the backdrop is sent.",
876
+ "description": "Event fired when the micro frontend requests to remove the backdrop.",
891
877
  "type": {
892
878
  "text": "Event"
893
879
  }
package/package.json CHANGED
@@ -1,24 +1,24 @@
1
1
  {
2
- "name": "@luigi-project/container",
3
- "description": "Javascript library enabling creation of microfrontends",
4
- "license": "Apache-2.0",
5
- "main": "bundle.js",
6
- "types": "index.d.ts",
7
- "repository": {
8
- "type": "git",
9
- "url": "ssh://github.com/SAP/luigi.git"
10
- },
11
- "customElements": "./dist/custom-elements.json",
12
- "publishConfig": {
13
- "tag": "luigi-container"
14
- },
15
- "keywords": [
16
- "luigi",
17
- "core",
18
- "UI",
19
- "extensibility",
20
- "micro-frontends",
21
- "microfrontends"
22
- ],
23
- "version": "1.4.0"
2
+ "name": "@luigi-project/container",
3
+ "description": "Javascript library enabling creation of microfrontends",
4
+ "license": "Apache-2.0",
5
+ "main": "bundle.js",
6
+ "types": "index.d.ts",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "ssh://github.com/SAP/luigi.git"
10
+ },
11
+ "customElements": "./dist/custom-elements.json",
12
+ "publishConfig": {
13
+ "tag": "luigi-container"
14
+ },
15
+ "keywords": [
16
+ "luigi",
17
+ "core",
18
+ "UI",
19
+ "extensibility",
20
+ "micro-frontends",
21
+ "microfrontends"
22
+ ],
23
+ "version": "1.5.0-dev.202412100034"
24
24
  }