@genesislcap/foundation-utils 14.214.4 → 14.215.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (2) hide show
  1. package/dist/custom-elements.json +603 -603
  2. package/package.json +10 -10
package/dist/custom-elements.json CHANGED
@@ -365,29 +365,6 @@
365
365
  }
366
366
  ]
367
367
  },
368
- {
369
- "kind": "javascript-module",
370
- "path": "src/directives/index.ts",
371
- "declarations": [],
372
- "exports": [
373
- {
374
- "kind": "js",
375
- "name": "*",
376
- "declaration": {
377
- "name": "*",
378
- "package": "./sync"
379
- }
380
- },
381
- {
382
- "kind": "js",
383
- "name": "*",
384
- "declaration": {
385
- "name": "*",
386
- "package": "./when-else"
387
- }
388
- }
389
- ]
390
- },
391
368
  {
392
369
  "kind": "javascript-module",
393
370
  "path": "src/decorators/index.ts",
@@ -443,772 +420,795 @@
443
420
  },
444
421
  {
445
422
  "kind": "javascript-module",
446
- "path": "src/env/index.ts",
447
- "declarations": [],
423
+ "path": "src/design-system/design-system.ts",
424
+ "declarations": [
425
+ {
426
+ "kind": "function",
427
+ "name": "assureDesignSystem",
428
+ "return": {
429
+ "type": {
430
+ "text": "DesignSystemModule"
431
+ }
432
+ },
433
+ "parameters": [
434
+ {
435
+ "name": "module",
436
+ "type": {
437
+ "text": "DesignSystemModule"
438
+ }
439
+ }
440
+ ],
441
+ "description": "assureDesignSystem.",
442
+ "privacy": "public"
443
+ }
444
+ ],
448
445
  "exports": [
449
446
  {
450
447
  "kind": "js",
451
- "name": "*",
448
+ "name": "assureDesignSystem",
452
449
  "declaration": {
453
- "name": "*",
454
- "package": "./is-dev"
450
+ "name": "assureDesignSystem",
451
+ "module": "src/design-system/design-system.ts"
455
452
  }
456
- },
453
+ }
454
+ ]
455
+ },
456
+ {
457
+ "kind": "javascript-module",
458
+ "path": "src/design-system/index.ts",
459
+ "declarations": [],
460
+ "exports": [
457
461
  {
458
462
  "kind": "js",
459
463
  "name": "*",
460
464
  "declaration": {
461
465
  "name": "*",
462
- "package": "./variables"
466
+ "package": "./design-system"
463
467
  }
464
468
  }
465
469
  ]
466
470
  },
467
471
  {
468
472
  "kind": "javascript-module",
469
- "path": "src/env/is-dev.ts",
473
+ "path": "src/error/errorMap.ts",
470
474
  "declarations": [
475
+ {
476
+ "kind": "class",
477
+ "description": "",
478
+ "name": "DefaultErrorMap",
479
+ "members": [
480
+ {
481
+ "kind": "field",
482
+ "name": "map",
483
+ "privacy": "private",
484
+ "default": "new Map<keyof TErrorDetailMap, Error>()"
485
+ },
486
+ {
487
+ "kind": "field",
488
+ "name": "lastError",
489
+ "type": {
490
+ "text": "Error"
491
+ },
492
+ "description": "{@inheritDoc ErrorMap.lastError}"
493
+ },
494
+ {
495
+ "kind": "method",
496
+ "name": "set",
497
+ "return": {
498
+ "type": {
499
+ "text": "void"
500
+ }
501
+ },
502
+ "parameters": [
503
+ {
504
+ "name": "key",
505
+ "type": {
506
+ "text": "keyof TErrorDetailMap"
507
+ }
508
+ },
509
+ {
510
+ "name": "error",
511
+ "type": {
512
+ "text": "Error"
513
+ }
514
+ }
515
+ ],
516
+ "description": "{@inheritDoc ErrorMap.set}"
517
+ },
518
+ {
519
+ "kind": "method",
520
+ "name": "get",
521
+ "return": {
522
+ "type": {
523
+ "text": ""
524
+ }
525
+ },
526
+ "parameters": [
527
+ {
528
+ "name": "key",
529
+ "type": {
530
+ "text": "keyof TErrorDetailMap"
531
+ },
532
+ "description": "The key."
533
+ }
534
+ ],
535
+ "description": "Get an error by key.",
536
+ "privacy": "public"
537
+ },
538
+ {
539
+ "kind": "method",
540
+ "name": "has",
541
+ "return": {
542
+ "type": {
543
+ "text": ""
544
+ }
545
+ },
546
+ "parameters": [
547
+ {
548
+ "name": "key",
549
+ "type": {
550
+ "text": "keyof TErrorDetailMap"
551
+ },
552
+ "description": "The key."
553
+ }
554
+ ],
555
+ "description": "Has an error for key.",
556
+ "privacy": "public"
557
+ },
558
+ {
559
+ "kind": "method",
560
+ "name": "delete",
561
+ "return": {
562
+ "type": {
563
+ "text": ""
564
+ }
565
+ },
566
+ "parameters": [
567
+ {
568
+ "name": "key",
569
+ "type": {
570
+ "text": "keyof TErrorDetailMap"
571
+ },
572
+ "description": "The key."
573
+ }
574
+ ],
575
+ "description": "Delete an error.",
576
+ "privacy": "public"
577
+ },
578
+ {
579
+ "kind": "method",
580
+ "name": "clear",
581
+ "description": "Clear errors.",
582
+ "privacy": "public"
583
+ },
584
+ {
585
+ "kind": "field",
586
+ "name": "size",
587
+ "type": {
588
+ "text": "number"
589
+ },
590
+ "description": "The size of the error map.",
591
+ "return": {
592
+ "type": {
593
+ "text": ""
594
+ }
595
+ },
596
+ "privacy": "public",
597
+ "readonly": true
598
+ },
599
+ {
600
+ "kind": "method",
601
+ "name": "values",
602
+ "privacy": "public"
603
+ },
604
+ {
605
+ "kind": "field",
606
+ "name": "messages",
607
+ "type": {
608
+ "text": "string"
609
+ },
610
+ "description": "{@inheritDoc ErrorMap.messages}",
611
+ "readonly": true
612
+ }
613
+ ]
614
+ },
471
615
  {
472
616
  "kind": "function",
473
- "name": "isDev",
474
- "description": "Determines if the current environment is a development environment.",
617
+ "name": "createErrorMap",
618
+ "return": {
619
+ "type": {
620
+ "text": ""
621
+ }
622
+ },
623
+ "parameters": [
624
+ {
625
+ "name": "logger",
626
+ "type": {
627
+ "text": "ErrorMapLogger"
628
+ },
629
+ "description": "A logger error method reference."
630
+ }
631
+ ],
632
+ "description": "A factory to create the error map.",
475
633
  "privacy": "public"
476
634
  }
477
635
  ],
478
636
  "exports": [
479
637
  {
480
638
  "kind": "js",
481
- "name": "isDev",
639
+ "name": "DefaultErrorMap",
482
640
  "declaration": {
483
- "name": "isDev",
484
- "module": "src/env/is-dev.ts"
641
+ "name": "DefaultErrorMap",
642
+ "module": "src/error/errorMap.ts"
643
+ }
644
+ },
645
+ {
646
+ "kind": "js",
647
+ "name": "createErrorMap",
648
+ "declaration": {
649
+ "name": "createErrorMap",
650
+ "module": "src/error/errorMap.ts"
485
651
  }
486
652
  }
487
653
  ]
488
654
  },
489
655
  {
490
656
  "kind": "javascript-module",
491
- "path": "src/env/variables.ts",
492
- "declarations": [
657
+ "path": "src/error/index.ts",
658
+ "declarations": [],
659
+ "exports": [
493
660
  {
494
- "kind": "variable",
495
- "name": "SOCKET_EXT",
496
- "type": {
497
- "text": "string"
661
+ "kind": "js",
662
+ "name": "*",
663
+ "declaration": {
664
+ "name": "*",
665
+ "package": "./errorMap"
498
666
  }
499
- },
500
- {
501
- "kind": "variable",
502
- "name": "_SOCKET_EXT",
503
- "type": {
504
- "text": "string"
505
- },
506
- "default": "'gwf'",
507
- "description": "The sub-path used for WebSocket connections when API_HOST is not set",
508
- "privacy": "public"
509
- },
510
- {
511
- "kind": "variable",
512
- "name": "FORCE_HTTP",
513
- "type": {
514
- "text": "string"
515
- }
516
- },
517
- {
518
- "kind": "variable",
519
- "name": "_FORCE_HTTP",
520
- "type": {
521
- "text": "string"
522
- },
523
- "description": "The path to a JSON config file for the HTTP mode.",
524
- "privacy": "public"
525
- },
526
- {
527
- "kind": "variable",
528
- "name": "GENESIS_SOCKET_URL",
529
- "default": "`${location.protocol.replace('http', 'ws')}//${location.host}/${_SOCKET_EXT}/`",
530
- "description": "Genesis Socket URL",
531
- "privacy": "public"
532
- },
533
- {
534
- "kind": "variable",
535
- "name": "API_HOST",
536
- "type": {
537
- "text": "string"
538
- }
539
- },
540
- {
541
- "kind": "variable",
542
- "name": "_API_HOST",
543
- "type": {
544
- "text": "string"
545
- },
546
- "default": "`${PROTOCOL}//${location.host}/${_SOCKET_EXT}/`",
547
- "description": "The Genesis Server URL (WebSocket or HTTP).",
548
- "privacy": "public"
549
- },
550
- {
551
- "kind": "variable",
552
- "name": "HTTP_CONFIG",
553
- "type": {
554
- "text": "string"
555
- }
556
- },
667
+ }
668
+ ]
669
+ },
670
+ {
671
+ "kind": "javascript-module",
672
+ "path": "src/formatters/datetime.ts",
673
+ "declarations": [
557
674
  {
558
- "kind": "variable",
559
- "name": "_HTTP_CONFIG",
560
- "type": {
561
- "text": "string"
675
+ "kind": "function",
676
+ "name": "formatDateTimestamp",
677
+ "return": {
678
+ "type": {
679
+ "text": "string"
680
+ }
562
681
  },
563
- "description": "Configuration settings for HTTP, used in http connect flow [`genesislcap-foundation-comms.HttpConnectConfig`](https://link-to-docs).",
682
+ "parameters": [
683
+ {
684
+ "name": "timestamp",
685
+ "type": {
686
+ "text": "number"
687
+ }
688
+ }
689
+ ],
690
+ "description": "Formats [DATE] UNIX Timestamps (without time) to readable strings",
564
691
  "privacy": "public"
565
692
  },
566
693
  {
567
- "kind": "variable",
568
- "name": "DEFAULT_ORGANISATION",
569
- "type": {
570
- "text": "string"
571
- }
572
- },
573
- {
574
- "kind": "variable",
575
- "name": "_DEFAULT_ORGANISATION",
576
- "type": {
577
- "text": "string"
694
+ "kind": "function",
695
+ "name": "formatDateTimeTimestamp",
696
+ "return": {
697
+ "type": {
698
+ "text": "string"
699
+ }
578
700
  },
579
- "description": "The default Organisation value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).",
701
+ "parameters": [
702
+ {
703
+ "name": "timestamp",
704
+ "type": {
705
+ "text": "number"
706
+ }
707
+ }
708
+ ],
709
+ "description": "Formats [DATETIME] UNIX Timestamps (with time) to readable strings",
580
710
  "privacy": "public"
581
711
  },
582
712
  {
583
- "kind": "variable",
584
- "name": "DEFAULT_PASSWORD",
585
- "type": {
586
- "text": "string"
587
- }
588
- },
589
- {
590
- "kind": "variable",
591
- "name": "_DEFAULT_PASSWORD",
592
- "type": {
593
- "text": "string"
713
+ "kind": "function",
714
+ "name": "formatTimestamp",
715
+ "return": {
716
+ "type": {
717
+ "text": "string"
718
+ }
594
719
  },
595
- "description": "The default Password value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).",
720
+ "parameters": [
721
+ {
722
+ "name": "timestamp",
723
+ "type": {
724
+ "text": "number"
725
+ },
726
+ "description": "The UNIX Timestamp."
727
+ },
728
+ {
729
+ "name": "withTime",
730
+ "type": {
731
+ "text": "boolean"
732
+ },
733
+ "description": "The flag to determine if formatted value should contain 'time' info."
734
+ }
735
+ ],
736
+ "description": "Formats [DATE|DATETIME] Unix Timestamps to readable strings",
596
737
  "privacy": "public"
597
738
  },
598
739
  {
599
- "kind": "variable",
600
- "name": "DEFAULT_USER",
601
- "type": {
602
- "text": "string"
603
- }
604
- },
605
- {
606
- "kind": "variable",
607
- "name": "_DEFAULT_USER",
608
- "type": {
609
- "text": "string"
610
- },
611
- "description": "The default Username value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).",
740
+ "kind": "function",
741
+ "name": "getDateFormatter",
742
+ "parameters": [
743
+ {
744
+ "name": "locale",
745
+ "default": "'en-GB'",
746
+ "type": {
747
+ "text": "string"
748
+ }
749
+ },
750
+ {
751
+ "name": "options",
752
+ "default": "defaultDateOptions",
753
+ "type": {
754
+ "text": "Intl.DateTimeFormatOptions"
755
+ }
756
+ }
757
+ ],
612
758
  "privacy": "public"
613
759
  }
614
760
  ],
615
761
  "exports": [
616
762
  {
617
763
  "kind": "js",
618
- "name": "SOCKET_EXT",
619
- "declaration": {
620
- "name": "_SOCKET_EXT",
621
- "module": "src/env/variables.ts"
622
- }
623
- },
624
- {
625
- "kind": "js",
626
- "name": "FORCE_HTTP",
627
- "declaration": {
628
- "name": "_FORCE_HTTP",
629
- "module": "src/env/variables.ts"
630
- }
631
- },
632
- {
633
- "kind": "js",
634
- "name": "GENESIS_SOCKET_URL",
635
- "declaration": {
636
- "name": "GENESIS_SOCKET_URL",
637
- "module": "src/env/variables.ts"
638
- }
639
- },
640
- {
641
- "kind": "js",
642
- "name": "API_HOST",
643
- "declaration": {
644
- "name": "_API_HOST",
645
- "module": "src/env/variables.ts"
646
- }
647
- },
648
- {
649
- "kind": "js",
650
- "name": "HTTP_CONFIG",
764
+ "name": "formatDateTimestamp",
651
765
  "declaration": {
652
- "name": "_HTTP_CONFIG",
653
- "module": "src/env/variables.ts"
766
+ "name": "formatDateTimestamp",
767
+ "module": "src/formatters/datetime.ts"
654
768
  }
655
769
  },
656
770
  {
657
771
  "kind": "js",
658
- "name": "DEFAULT_ORGANISATION",
772
+ "name": "formatDateTimeTimestamp",
659
773
  "declaration": {
660
- "name": "_DEFAULT_ORGANISATION",
661
- "module": "src/env/variables.ts"
774
+ "name": "formatDateTimeTimestamp",
775
+ "module": "src/formatters/datetime.ts"
662
776
  }
663
777
  },
664
778
  {
665
779
  "kind": "js",
666
- "name": "DEFAULT_PASSWORD",
780
+ "name": "formatTimestamp",
667
781
  "declaration": {
668
- "name": "_DEFAULT_PASSWORD",
669
- "module": "src/env/variables.ts"
782
+ "name": "formatTimestamp",
783
+ "module": "src/formatters/datetime.ts"
670
784
  }
671
785
  },
672
786
  {
673
787
  "kind": "js",
674
- "name": "DEFAULT_USER",
788
+ "name": "getDateFormatter",
675
789
  "declaration": {
676
- "name": "_DEFAULT_USER",
677
- "module": "src/env/variables.ts"
790
+ "name": "getDateFormatter",
791
+ "module": "src/formatters/datetime.ts"
678
792
  }
679
793
  }
680
794
  ]
681
795
  },
682
796
  {
683
797
  "kind": "javascript-module",
684
- "path": "src/design-system/design-system.ts",
685
- "declarations": [
686
- {
687
- "kind": "function",
688
- "name": "assureDesignSystem",
689
- "return": {
690
- "type": {
691
- "text": "DesignSystemModule"
692
- }
693
- },
694
- "parameters": [
695
- {
696
- "name": "module",
697
- "type": {
698
- "text": "DesignSystemModule"
699
- }
700
- }
701
- ],
702
- "description": "assureDesignSystem.",
703
- "privacy": "public"
704
- }
705
- ],
798
+ "path": "src/formatters/index.ts",
799
+ "declarations": [],
706
800
  "exports": [
707
801
  {
708
802
  "kind": "js",
709
- "name": "assureDesignSystem",
803
+ "name": "*",
710
804
  "declaration": {
711
- "name": "assureDesignSystem",
712
- "module": "src/design-system/design-system.ts"
805
+ "name": "*",
806
+ "package": "./datetime"
713
807
  }
714
- }
715
- ]
716
- },
717
- {
718
- "kind": "javascript-module",
719
- "path": "src/design-system/index.ts",
720
- "declarations": [],
721
- "exports": [
808
+ },
722
809
  {
723
810
  "kind": "js",
724
811
  "name": "*",
725
812
  "declaration": {
726
813
  "name": "*",
727
- "package": "./design-system"
814
+ "package": "./localeNumberParser"
815
+ }
816
+ },
817
+ {
818
+ "kind": "js",
819
+ "name": "*",
820
+ "declaration": {
821
+ "name": "*",
822
+ "package": "./number"
728
823
  }
729
824
  }
730
825
  ]
731
826
  },
732
827
  {
733
828
  "kind": "javascript-module",
734
- "path": "src/error/errorMap.ts",
829
+ "path": "src/formatters/localeNumberParser.ts",
735
830
  "declarations": [
736
831
  {
737
832
  "kind": "class",
738
833
  "description": "",
739
- "name": "DefaultErrorMap",
834
+ "name": "NumberParser",
740
835
  "members": [
741
836
  {
742
837
  "kind": "field",
743
- "name": "map",
838
+ "name": "_decimal",
839
+ "type": {
840
+ "text": "RegExp"
841
+ },
744
842
  "privacy": "private",
745
- "default": "new Map<keyof TErrorDetailMap, Error>()"
843
+ "default": "new RegExp(`[${parts.find((d) => d.type === 'decimal').value}]`)"
746
844
  },
747
845
  {
748
846
  "kind": "field",
749
- "name": "lastError",
847
+ "name": "_separator",
750
848
  "type": {
751
- "text": "Error"
849
+ "text": "RegExp"
752
850
  },
753
- "description": "{@inheritDoc ErrorMap.lastError}"
851
+ "privacy": "private",
852
+ "default": "new RegExp(\n `[$${parts.find((d) => d.type === 'decimal').value}](?:0*$|[^0]0+$)`,\n )"
754
853
  },
755
854
  {
756
- "kind": "method",
757
- "name": "set",
758
- "return": {
759
- "type": {
760
- "text": "void"
761
- }
855
+ "kind": "field",
856
+ "name": "_numeral",
857
+ "type": {
858
+ "text": "RegExp"
762
859
  },
763
- "parameters": [
764
- {
765
- "name": "key",
766
- "type": {
767
- "text": "keyof TErrorDetailMap"
768
- }
769
- },
770
- {
771
- "name": "error",
772
- "type": {
773
- "text": "Error"
774
- }
775
- }
776
- ],
777
- "description": "{@inheritDoc ErrorMap.set}"
860
+ "privacy": "private",
861
+ "default": "new RegExp(`[${numerals.join('')}]`, 'g')"
778
862
  },
779
863
  {
780
- "kind": "method",
781
- "name": "get",
782
- "return": {
783
- "type": {
784
- "text": ""
785
- }
864
+ "kind": "field",
865
+ "name": "_index",
866
+ "type": {
867
+ "text": "any"
786
868
  },
787
- "parameters": [
788
- {
789
- "name": "key",
790
- "type": {
791
- "text": "keyof TErrorDetailMap"
792
- },
793
- "description": "The key."
794
- }
795
- ],
796
- "description": "Get an error by key.",
797
- "privacy": "public"
869
+ "privacy": "private"
798
870
  },
799
871
  {
800
872
  "kind": "method",
801
- "name": "has",
802
- "return": {
803
- "type": {
804
- "text": ""
805
- }
806
- },
873
+ "name": "parse",
807
874
  "parameters": [
808
875
  {
809
- "name": "key",
876
+ "name": "localeNumber",
810
877
  "type": {
811
- "text": "keyof TErrorDetailMap"
812
- },
813
- "description": "The key."
878
+ "text": "string"
879
+ }
814
880
  }
815
- ],
816
- "description": "Has an error for key.",
817
- "privacy": "public"
881
+ ]
818
882
  },
819
883
  {
820
884
  "kind": "method",
821
- "name": "delete",
885
+ "name": "hasSeparator",
822
886
  "return": {
823
887
  "type": {
824
- "text": ""
888
+ "text": "boolean"
825
889
  }
826
890
  },
827
891
  "parameters": [
828
892
  {
829
- "name": "key",
893
+ "name": "localeNumber",
830
894
  "type": {
831
- "text": "keyof TErrorDetailMap"
832
- },
833
- "description": "The key."
834
- }
835
- ],
836
- "description": "Delete an error.",
837
- "privacy": "public"
838
- },
839
- {
840
- "kind": "method",
841
- "name": "clear",
842
- "description": "Clear errors.",
843
- "privacy": "public"
844
- },
845
- {
846
- "kind": "field",
847
- "name": "size",
848
- "type": {
849
- "text": "number"
850
- },
851
- "description": "The size of the error map.",
852
- "return": {
853
- "type": {
854
- "text": ""
895
+ "text": "string"
896
+ }
855
897
  }
856
- },
857
- "privacy": "public",
858
- "readonly": true
859
- },
860
- {
861
- "kind": "method",
862
- "name": "values",
863
- "privacy": "public"
898
+ ]
864
899
  },
865
900
  {
866
901
  "kind": "field",
867
- "name": "messages",
868
- "type": {
869
- "text": "string"
870
- },
871
- "description": "{@inheritDoc ErrorMap.messages}",
872
- "readonly": true
902
+ "name": "_group",
903
+ "default": "new RegExp(`[${parts.find((d) => d.type === 'group').value}]`, 'g')"
873
904
  }
874
905
  ]
875
- },
906
+ }
907
+ ],
908
+ "exports": [
909
+ {
910
+ "kind": "js",
911
+ "name": "NumberParser",
912
+ "declaration": {
913
+ "name": "NumberParser",
914
+ "module": "src/formatters/localeNumberParser.ts"
915
+ }
916
+ }
917
+ ]
918
+ },
919
+ {
920
+ "kind": "javascript-module",
921
+ "path": "src/formatters/number.ts",
922
+ "declarations": [
876
923
  {
877
924
  "kind": "function",
878
- "name": "createErrorMap",
879
- "return": {
880
- "type": {
881
- "text": ""
882
- }
883
- },
925
+ "name": "getNumberFormatter",
884
926
  "parameters": [
885
927
  {
886
- "name": "logger",
928
+ "name": "format",
887
929
  "type": {
888
- "text": "ErrorMapLogger"
889
- },
890
- "description": "A logger error method reference."
930
+ "text": "string"
931
+ }
932
+ },
933
+ {
934
+ "name": "locale",
935
+ "optional": true,
936
+ "type": {
937
+ "text": "string | null"
938
+ }
891
939
  }
892
940
  ],
893
- "description": "A factory to create the error map.",
894
941
  "privacy": "public"
895
942
  }
896
943
  ],
897
944
  "exports": [
898
945
  {
899
946
  "kind": "js",
900
- "name": "DefaultErrorMap",
947
+ "name": "getNumberFormatter",
901
948
  "declaration": {
902
- "name": "DefaultErrorMap",
903
- "module": "src/error/errorMap.ts"
949
+ "name": "getNumberFormatter",
950
+ "module": "src/formatters/number.ts"
951
+ }
952
+ }
953
+ ]
954
+ },
955
+ {
956
+ "kind": "javascript-module",
957
+ "path": "src/env/index.ts",
958
+ "declarations": [],
959
+ "exports": [
960
+ {
961
+ "kind": "js",
962
+ "name": "*",
963
+ "declaration": {
964
+ "name": "*",
965
+ "package": "./is-dev"
904
966
  }
905
967
  },
906
968
  {
907
969
  "kind": "js",
908
- "name": "createErrorMap",
970
+ "name": "*",
909
971
  "declaration": {
910
- "name": "createErrorMap",
911
- "module": "src/error/errorMap.ts"
972
+ "name": "*",
973
+ "package": "./variables"
912
974
  }
913
975
  }
914
976
  ]
915
977
  },
916
978
  {
917
979
  "kind": "javascript-module",
918
- "path": "src/error/index.ts",
919
- "declarations": [],
980
+ "path": "src/env/is-dev.ts",
981
+ "declarations": [
982
+ {
983
+ "kind": "function",
984
+ "name": "isDev",
985
+ "description": "Determines if the current environment is a development environment.",
986
+ "privacy": "public"
987
+ }
988
+ ],
920
989
  "exports": [
921
990
  {
922
991
  "kind": "js",
923
- "name": "*",
992
+ "name": "isDev",
924
993
  "declaration": {
925
- "name": "*",
926
- "package": "./errorMap"
994
+ "name": "isDev",
995
+ "module": "src/env/is-dev.ts"
927
996
  }
928
997
  }
929
998
  ]
930
999
  },
931
1000
  {
932
1001
  "kind": "javascript-module",
933
- "path": "src/formatters/datetime.ts",
1002
+ "path": "src/env/variables.ts",
934
1003
  "declarations": [
935
1004
  {
936
- "kind": "function",
937
- "name": "formatDateTimestamp",
938
- "return": {
939
- "type": {
940
- "text": "string"
941
- }
1005
+ "kind": "variable",
1006
+ "name": "SOCKET_EXT",
1007
+ "type": {
1008
+ "text": "string"
1009
+ }
1010
+ },
1011
+ {
1012
+ "kind": "variable",
1013
+ "name": "_SOCKET_EXT",
1014
+ "type": {
1015
+ "text": "string"
942
1016
  },
943
- "parameters": [
944
- {
945
- "name": "timestamp",
946
- "type": {
947
- "text": "number"
948
- }
949
- }
950
- ],
951
- "description": "Formats [DATE] UNIX Timestamps (without time) to readable strings",
1017
+ "default": "'gwf'",
1018
+ "description": "The sub-path used for WebSocket connections when API_HOST is not set",
952
1019
  "privacy": "public"
953
1020
  },
954
1021
  {
955
- "kind": "function",
956
- "name": "formatDateTimeTimestamp",
957
- "return": {
958
- "type": {
959
- "text": "string"
960
- }
1022
+ "kind": "variable",
1023
+ "name": "FORCE_HTTP",
1024
+ "type": {
1025
+ "text": "string"
1026
+ }
1027
+ },
1028
+ {
1029
+ "kind": "variable",
1030
+ "name": "_FORCE_HTTP",
1031
+ "type": {
1032
+ "text": "string"
961
1033
  },
962
- "parameters": [
963
- {
964
- "name": "timestamp",
965
- "type": {
966
- "text": "number"
967
- }
968
- }
969
- ],
970
- "description": "Formats [DATETIME] UNIX Timestamps (with time) to readable strings",
1034
+ "description": "The path to a JSON config file for the HTTP mode.",
971
1035
  "privacy": "public"
972
1036
  },
973
1037
  {
974
- "kind": "function",
975
- "name": "formatTimestamp",
976
- "return": {
977
- "type": {
978
- "text": "string"
979
- }
1038
+ "kind": "variable",
1039
+ "name": "GENESIS_SOCKET_URL",
1040
+ "default": "`${location.protocol.replace('http', 'ws')}//${location.host}/${_SOCKET_EXT}/`",
1041
+ "description": "Genesis Socket URL",
1042
+ "privacy": "public"
1043
+ },
1044
+ {
1045
+ "kind": "variable",
1046
+ "name": "API_HOST",
1047
+ "type": {
1048
+ "text": "string"
1049
+ }
1050
+ },
1051
+ {
1052
+ "kind": "variable",
1053
+ "name": "_API_HOST",
1054
+ "type": {
1055
+ "text": "string"
980
1056
  },
981
- "parameters": [
982
- {
983
- "name": "timestamp",
984
- "type": {
985
- "text": "number"
986
- },
987
- "description": "The UNIX Timestamp."
988
- },
989
- {
990
- "name": "withTime",
991
- "type": {
992
- "text": "boolean"
993
- },
994
- "description": "The flag to determine if formatted value should contain 'time' info."
995
- }
996
- ],
997
- "description": "Formats [DATE|DATETIME] Unix Timestamps to readable strings",
1057
+ "default": "`${PROTOCOL}//${location.host}/${_SOCKET_EXT}/`",
1058
+ "description": "The Genesis Server URL (WebSocket or HTTP).",
998
1059
  "privacy": "public"
999
1060
  },
1000
1061
  {
1001
- "kind": "function",
1002
- "name": "getDateFormatter",
1003
- "parameters": [
1004
- {
1005
- "name": "locale",
1006
- "default": "'en-GB'",
1007
- "type": {
1008
- "text": "string"
1009
- }
1010
- },
1011
- {
1012
- "name": "options",
1013
- "default": "defaultDateOptions",
1014
- "type": {
1015
- "text": "Intl.DateTimeFormatOptions"
1016
- }
1017
- }
1018
- ],
1062
+ "kind": "variable",
1063
+ "name": "HTTP_CONFIG",
1064
+ "type": {
1065
+ "text": "string"
1066
+ }
1067
+ },
1068
+ {
1069
+ "kind": "variable",
1070
+ "name": "_HTTP_CONFIG",
1071
+ "type": {
1072
+ "text": "string"
1073
+ },
1074
+ "description": "Configuration settings for HTTP, used in http connect flow [`genesislcap-foundation-comms.HttpConnectConfig`](https://link-to-docs).",
1075
+ "privacy": "public"
1076
+ },
1077
+ {
1078
+ "kind": "variable",
1079
+ "name": "DEFAULT_ORGANISATION",
1080
+ "type": {
1081
+ "text": "string"
1082
+ }
1083
+ },
1084
+ {
1085
+ "kind": "variable",
1086
+ "name": "_DEFAULT_ORGANISATION",
1087
+ "type": {
1088
+ "text": "string"
1089
+ },
1090
+ "description": "The default Organisation value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).",
1091
+ "privacy": "public"
1092
+ },
1093
+ {
1094
+ "kind": "variable",
1095
+ "name": "DEFAULT_PASSWORD",
1096
+ "type": {
1097
+ "text": "string"
1098
+ }
1099
+ },
1100
+ {
1101
+ "kind": "variable",
1102
+ "name": "_DEFAULT_PASSWORD",
1103
+ "type": {
1104
+ "text": "string"
1105
+ },
1106
+ "description": "The default Password value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).",
1107
+ "privacy": "public"
1108
+ },
1109
+ {
1110
+ "kind": "variable",
1111
+ "name": "DEFAULT_USER",
1112
+ "type": {
1113
+ "text": "string"
1114
+ }
1115
+ },
1116
+ {
1117
+ "kind": "variable",
1118
+ "name": "_DEFAULT_USER",
1119
+ "type": {
1120
+ "text": "string"
1121
+ },
1122
+ "description": "The default Username value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).",
1019
1123
  "privacy": "public"
1020
1124
  }
1021
1125
  ],
1022
1126
  "exports": [
1023
1127
  {
1024
1128
  "kind": "js",
1025
- "name": "formatDateTimestamp",
1129
+ "name": "SOCKET_EXT",
1026
1130
  "declaration": {
1027
- "name": "formatDateTimestamp",
1028
- "module": "src/formatters/datetime.ts"
1131
+ "name": "_SOCKET_EXT",
1132
+ "module": "src/env/variables.ts"
1029
1133
  }
1030
1134
  },
1031
1135
  {
1032
1136
  "kind": "js",
1033
- "name": "formatDateTimeTimestamp",
1137
+ "name": "FORCE_HTTP",
1034
1138
  "declaration": {
1035
- "name": "formatDateTimeTimestamp",
1036
- "module": "src/formatters/datetime.ts"
1139
+ "name": "_FORCE_HTTP",
1140
+ "module": "src/env/variables.ts"
1141
+ }
1142
+ },
1143
+ {
1144
+ "kind": "js",
1145
+ "name": "GENESIS_SOCKET_URL",
1146
+ "declaration": {
1147
+ "name": "GENESIS_SOCKET_URL",
1148
+ "module": "src/env/variables.ts"
1037
1149
  }
1038
1150
  },
1039
1151
  {
1040
1152
  "kind": "js",
1041
- "name": "formatTimestamp",
1153
+ "name": "API_HOST",
1042
1154
  "declaration": {
1043
- "name": "formatTimestamp",
1044
- "module": "src/formatters/datetime.ts"
1155
+ "name": "_API_HOST",
1156
+ "module": "src/env/variables.ts"
1045
1157
  }
1046
1158
  },
1047
1159
  {
1048
1160
  "kind": "js",
1049
- "name": "getDateFormatter",
1161
+ "name": "HTTP_CONFIG",
1050
1162
  "declaration": {
1051
- "name": "getDateFormatter",
1052
- "module": "src/formatters/datetime.ts"
1163
+ "name": "_HTTP_CONFIG",
1164
+ "module": "src/env/variables.ts"
1053
1165
  }
1054
- }
1055
- ]
1056
- },
1057
- {
1058
- "kind": "javascript-module",
1059
- "path": "src/formatters/index.ts",
1060
- "declarations": [],
1061
- "exports": [
1166
+ },
1062
1167
  {
1063
1168
  "kind": "js",
1064
- "name": "*",
1169
+ "name": "DEFAULT_ORGANISATION",
1065
1170
  "declaration": {
1066
- "name": "*",
1067
- "package": "./datetime"
1171
+ "name": "_DEFAULT_ORGANISATION",
1172
+ "module": "src/env/variables.ts"
1068
1173
  }
1069
1174
  },
1070
1175
  {
1071
1176
  "kind": "js",
1072
- "name": "*",
1177
+ "name": "DEFAULT_PASSWORD",
1073
1178
  "declaration": {
1074
- "name": "*",
1075
- "package": "./localeNumberParser"
1179
+ "name": "_DEFAULT_PASSWORD",
1180
+ "module": "src/env/variables.ts"
1076
1181
  }
1077
1182
  },
1078
1183
  {
1079
1184
  "kind": "js",
1080
- "name": "*",
1185
+ "name": "DEFAULT_USER",
1081
1186
  "declaration": {
1082
- "name": "*",
1083
- "package": "./number"
1187
+ "name": "_DEFAULT_USER",
1188
+ "module": "src/env/variables.ts"
1084
1189
  }
1085
1190
  }
1086
1191
  ]
1087
1192
  },
1088
1193
  {
1089
1194
  "kind": "javascript-module",
1090
- "path": "src/formatters/localeNumberParser.ts",
1091
- "declarations": [
1092
- {
1093
- "kind": "class",
1094
- "description": "",
1095
- "name": "NumberParser",
1096
- "members": [
1097
- {
1098
- "kind": "field",
1099
- "name": "_decimal",
1100
- "type": {
1101
- "text": "RegExp"
1102
- },
1103
- "privacy": "private",
1104
- "default": "new RegExp(`[${parts.find((d) => d.type === 'decimal').value}]`)"
1105
- },
1106
- {
1107
- "kind": "field",
1108
- "name": "_separator",
1109
- "type": {
1110
- "text": "RegExp"
1111
- },
1112
- "privacy": "private",
1113
- "default": "new RegExp(\n `[$${parts.find((d) => d.type === 'decimal').value}](?:0*$|[^0]0+$)`,\n )"
1114
- },
1115
- {
1116
- "kind": "field",
1117
- "name": "_numeral",
1118
- "type": {
1119
- "text": "RegExp"
1120
- },
1121
- "privacy": "private",
1122
- "default": "new RegExp(`[${numerals.join('')}]`, 'g')"
1123
- },
1124
- {
1125
- "kind": "field",
1126
- "name": "_index",
1127
- "type": {
1128
- "text": "any"
1129
- },
1130
- "privacy": "private"
1131
- },
1132
- {
1133
- "kind": "method",
1134
- "name": "parse",
1135
- "parameters": [
1136
- {
1137
- "name": "localeNumber",
1138
- "type": {
1139
- "text": "string"
1140
- }
1141
- }
1142
- ]
1143
- },
1144
- {
1145
- "kind": "method",
1146
- "name": "hasSeparator",
1147
- "return": {
1148
- "type": {
1149
- "text": "boolean"
1150
- }
1151
- },
1152
- "parameters": [
1153
- {
1154
- "name": "localeNumber",
1155
- "type": {
1156
- "text": "string"
1157
- }
1158
- }
1159
- ]
1160
- },
1161
- {
1162
- "kind": "field",
1163
- "name": "_group",
1164
- "default": "new RegExp(`[${parts.find((d) => d.type === 'group').value}]`, 'g')"
1165
- }
1166
- ]
1167
- }
1168
- ],
1195
+ "path": "src/directives/index.ts",
1196
+ "declarations": [],
1169
1197
  "exports": [
1170
1198
  {
1171
1199
  "kind": "js",
1172
- "name": "NumberParser",
1200
+ "name": "*",
1173
1201
  "declaration": {
1174
- "name": "NumberParser",
1175
- "module": "src/formatters/localeNumberParser.ts"
1202
+ "name": "*",
1203
+ "package": "./sync"
1176
1204
  }
1177
- }
1178
- ]
1179
- },
1180
- {
1181
- "kind": "javascript-module",
1182
- "path": "src/formatters/number.ts",
1183
- "declarations": [
1184
- {
1185
- "kind": "function",
1186
- "name": "getNumberFormatter",
1187
- "parameters": [
1188
- {
1189
- "name": "format",
1190
- "type": {
1191
- "text": "string"
1192
- }
1193
- },
1194
- {
1195
- "name": "locale",
1196
- "optional": true,
1197
- "type": {
1198
- "text": "string | null"
1199
- }
1200
- }
1201
- ],
1202
- "privacy": "public"
1203
- }
1204
- ],
1205
- "exports": [
1205
+ },
1206
1206
  {
1207
1207
  "kind": "js",
1208
- "name": "getNumberFormatter",
1208
+ "name": "*",
1209
1209
  "declaration": {
1210
- "name": "getNumberFormatter",
1211
- "module": "src/formatters/number.ts"
1210
+ "name": "*",
1211
+ "package": "./when-else"
1212
1212
  }
1213
1213
  }
1214
1214
  ]
@@ -1339,7 +1339,7 @@
1339
1339
  },
1340
1340
  {
1341
1341
  "kind": "javascript-module",
1342
- "path": "src/observer/index.ts",
1342
+ "path": "src/promise/index.ts",
1343
1343
  "declarations": [],
1344
1344
  "exports": [
1345
1345
  {
@@ -1347,71 +1347,55 @@
1347
1347
  "name": "*",
1348
1348
  "declaration": {
1349
1349
  "name": "*",
1350
- "package": "./observer"
1350
+ "package": "./resolveAfter"
1351
1351
  }
1352
1352
  }
1353
1353
  ]
1354
1354
  },
1355
1355
  {
1356
1356
  "kind": "javascript-module",
1357
- "path": "src/observer/observer.ts",
1357
+ "path": "src/promise/resolveAfter.ts",
1358
1358
  "declarations": [
1359
1359
  {
1360
1360
  "kind": "function",
1361
- "name": "createObserver",
1361
+ "name": "resolveAfter",
1362
1362
  "return": {
1363
1363
  "type": {
1364
- "text": "Observer<EventType>"
1364
+ "text": "Promise<T>"
1365
1365
  }
1366
1366
  },
1367
- "description": "Creates a new event observer instance.",
1368
- "privacy": "public"
1369
- },
1370
- {
1371
- "kind": "function",
1372
- "name": "respondToVisibility",
1373
1367
  "parameters": [
1374
1368
  {
1375
- "name": "element",
1369
+ "name": "ms",
1376
1370
  "type": {
1377
- "text": "HTMLElement"
1378
- },
1379
- "description": "HTMLElement to observe"
1371
+ "text": "number"
1372
+ }
1380
1373
  },
1381
1374
  {
1382
- "name": "callback",
1375
+ "name": "valueCreator",
1383
1376
  "type": {
1384
- "text": "(arg0: boolean) => any"
1385
- },
1386
- "description": "any function called when the visibility changes"
1377
+ "text": "() => T"
1378
+ }
1387
1379
  }
1388
1380
  ],
1389
- "description": "Setup an `IntersectionObserver` which will activate a callback function when an element becomes visible on screen",
1381
+ "description": "Resolve a promise after a timeout.",
1390
1382
  "privacy": "public"
1391
1383
  }
1392
1384
  ],
1393
1385
  "exports": [
1394
1386
  {
1395
1387
  "kind": "js",
1396
- "name": "createObserver",
1397
- "declaration": {
1398
- "name": "createObserver",
1399
- "module": "src/observer/observer.ts"
1400
- }
1401
- },
1402
- {
1403
- "kind": "js",
1404
- "name": "respondToVisibility",
1388
+ "name": "resolveAfter",
1405
1389
  "declaration": {
1406
- "name": "respondToVisibility",
1407
- "module": "src/observer/observer.ts"
1390
+ "name": "resolveAfter",
1391
+ "module": "src/promise/resolveAfter.ts"
1408
1392
  }
1409
1393
  }
1410
1394
  ]
1411
1395
  },
1412
1396
  {
1413
1397
  "kind": "javascript-module",
1414
- "path": "src/promise/index.ts",
1398
+ "path": "src/observer/index.ts",
1415
1399
  "declarations": [],
1416
1400
  "exports": [
1417
1401
  {
@@ -1419,48 +1403,64 @@
1419
1403
  "name": "*",
1420
1404
  "declaration": {
1421
1405
  "name": "*",
1422
- "package": "./resolveAfter"
1406
+ "package": "./observer"
1423
1407
  }
1424
1408
  }
1425
1409
  ]
1426
1410
  },
1427
1411
  {
1428
1412
  "kind": "javascript-module",
1429
- "path": "src/promise/resolveAfter.ts",
1413
+ "path": "src/observer/observer.ts",
1430
1414
  "declarations": [
1431
1415
  {
1432
1416
  "kind": "function",
1433
- "name": "resolveAfter",
1417
+ "name": "createObserver",
1434
1418
  "return": {
1435
1419
  "type": {
1436
- "text": "Promise<T>"
1420
+ "text": "Observer<EventType>"
1437
1421
  }
1438
1422
  },
1423
+ "description": "Creates a new event observer instance.",
1424
+ "privacy": "public"
1425
+ },
1426
+ {
1427
+ "kind": "function",
1428
+ "name": "respondToVisibility",
1439
1429
  "parameters": [
1440
1430
  {
1441
- "name": "ms",
1431
+ "name": "element",
1442
1432
  "type": {
1443
- "text": "number"
1444
- }
1433
+ "text": "HTMLElement"
1434
+ },
1435
+ "description": "HTMLElement to observe"
1445
1436
  },
1446
1437
  {
1447
- "name": "valueCreator",
1438
+ "name": "callback",
1448
1439
  "type": {
1449
- "text": "() => T"
1450
- }
1440
+ "text": "(arg0: boolean) => any"
1441
+ },
1442
+ "description": "any function called when the visibility changes"
1451
1443
  }
1452
1444
  ],
1453
- "description": "Resolve a promise after a timeout.",
1445
+ "description": "Setup an `IntersectionObserver` which will activate a callback function when an element becomes visible on screen",
1454
1446
  "privacy": "public"
1455
1447
  }
1456
1448
  ],
1457
1449
  "exports": [
1458
1450
  {
1459
1451
  "kind": "js",
1460
- "name": "resolveAfter",
1452
+ "name": "createObserver",
1461
1453
  "declaration": {
1462
- "name": "resolveAfter",
1463
- "module": "src/promise/resolveAfter.ts"
1454
+ "name": "createObserver",
1455
+ "module": "src/observer/observer.ts"
1456
+ }
1457
+ },
1458
+ {
1459
+ "kind": "js",
1460
+ "name": "respondToVisibility",
1461
+ "declaration": {
1462
+ "name": "respondToVisibility",
1463
+ "module": "src/observer/observer.ts"
1464
1464
  }
1465
1465
  }
1466
1466
  ]