@genesislcap/foundation-comms 14.291.2-alpha-f8334d9.0 → 14.291.2-alpha-39f1157.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 (50) hide show
  1. package/dist/dts/connect/connect.d.ts.map +1 -1
  2. package/dist/dts/connect/connect.events.d.ts +64 -0
  3. package/dist/dts/connect/connect.events.d.ts.map +1 -1
  4. package/dist/dts/connect/http.connect.d.ts.map +1 -1
  5. package/dist/dts/datasource/datasource.config.d.ts.map +1 -1
  6. package/dist/dts/datasource/datasource.d.ts +12 -15
  7. package/dist/dts/datasource/datasource.d.ts.map +1 -1
  8. package/dist/dts/datasource/datasource.types.d.ts +5 -0
  9. package/dist/dts/datasource/datasource.types.d.ts.map +1 -1
  10. package/dist/dts/testing/mocks/datasource/datasource.d.ts +1 -0
  11. package/dist/dts/testing/mocks/datasource/datasource.d.ts.map +1 -1
  12. package/dist/esm/connect/connect.events.js +42 -0
  13. package/dist/esm/connect/connect.js +5 -1
  14. package/dist/esm/connect/http.connect.js +4 -3
  15. package/dist/esm/connect/http.connect.types.js +3 -3
  16. package/dist/esm/datasource/datasource.config.js +1 -0
  17. package/dist/esm/datasource/datasource.js +39 -46
  18. package/dist/esm/testing/mocks/datasource/datasource.js +3 -0
  19. package/dist/foundation-comms.api.json +977 -68
  20. package/dist/foundation-comms.d.ts +87 -14
  21. package/docs/api/foundation-comms.commitackevent.md +14 -0
  22. package/docs/api/foundation-comms.commitackeventdetail.md +17 -0
  23. package/docs/api/foundation-comms.commitackeventtype.md +12 -0
  24. package/docs/api/foundation-comms.commitresponseevent.md +14 -0
  25. package/docs/api/foundation-comms.commitresponseeventdetail.md +17 -0
  26. package/docs/api/foundation-comms.commitresponseeventtype.md +12 -0
  27. package/docs/api/foundation-comms.connectevents.addcommitacklistener.md +24 -0
  28. package/docs/api/foundation-comms.connectevents.addcommitresponselistener.md +24 -0
  29. package/docs/api/foundation-comms.connectevents.md +2 -0
  30. package/docs/api/foundation-comms.connecteventsemitter.md +2 -0
  31. package/docs/api/foundation-comms.connecteventsemitter.oncommitackevent.md +25 -0
  32. package/docs/api/foundation-comms.connecteventsemitter.oncommitresponseevent.md +25 -0
  33. package/docs/api/foundation-comms.datasource.md +1 -0
  34. package/docs/api/foundation-comms.datasource.triggerpoll.md +17 -0
  35. package/docs/api/foundation-comms.datasourceoptions.md +1 -0
  36. package/docs/api/foundation-comms.datasourceoptions.polltriggerevents.md +18 -0
  37. package/docs/api/foundation-comms.defaultconnectevents.addcommitacklistener.md +24 -0
  38. package/docs/api/foundation-comms.defaultconnectevents.addcommitresponselistener.md +24 -0
  39. package/docs/api/foundation-comms.defaultconnectevents.md +4 -0
  40. package/docs/api/foundation-comms.defaultconnectevents.oncommitackevent.md +25 -0
  41. package/docs/api/foundation-comms.defaultconnectevents.oncommitresponseevent.md +25 -0
  42. package/docs/api/foundation-comms.defaultdatasource.allparams.md +11 -0
  43. package/docs/api/foundation-comms.defaultdatasource.connectevents.md +11 -0
  44. package/docs/api/foundation-comms.defaultdatasource.dataserverparams.md +11 -0
  45. package/docs/api/foundation-comms.defaultdatasource.md +5 -0
  46. package/docs/api/foundation-comms.defaultdatasource.requestparams.md +11 -0
  47. package/docs/api/foundation-comms.defaultdatasource.triggerpoll.md +15 -0
  48. package/docs/api/foundation-comms.md +6 -0
  49. package/docs/api-report.md +62 -6
  50. package/package.json +13 -13
package/dist/foundation-comms.api.json CHANGED
@@ -999,6 +999,108 @@
999
999
  "endIndex": 2
1000
1000
  }
1001
1001
  },
1002
+ {
1003
+ "kind": "TypeAlias",
1004
+ "canonicalReference": "@genesislcap/foundation-comms!CommitAckEvent:type",
1005
+ "docComment": "/**\n * @public\n */\n",
1006
+ "excerptTokens": [
1007
+ {
1008
+ "kind": "Content",
1009
+ "text": "export type CommitAckEvent = "
1010
+ },
1011
+ {
1012
+ "kind": "Reference",
1013
+ "text": "CustomEvent",
1014
+ "canonicalReference": "!CustomEvent:interface"
1015
+ },
1016
+ {
1017
+ "kind": "Content",
1018
+ "text": "<"
1019
+ },
1020
+ {
1021
+ "kind": "Reference",
1022
+ "text": "CommitAckEventDetail",
1023
+ "canonicalReference": "@genesislcap/foundation-comms!CommitAckEventDetail:type"
1024
+ },
1025
+ {
1026
+ "kind": "Content",
1027
+ "text": ">"
1028
+ },
1029
+ {
1030
+ "kind": "Content",
1031
+ "text": ";"
1032
+ }
1033
+ ],
1034
+ "fileUrlPath": "src/connect/connect.events.ts",
1035
+ "releaseTag": "Public",
1036
+ "name": "CommitAckEvent",
1037
+ "typeTokenRange": {
1038
+ "startIndex": 1,
1039
+ "endIndex": 5
1040
+ }
1041
+ },
1042
+ {
1043
+ "kind": "TypeAlias",
1044
+ "canonicalReference": "@genesislcap/foundation-comms!CommitAckEventDetail:type",
1045
+ "docComment": "/**\n * @public\n */\n",
1046
+ "excerptTokens": [
1047
+ {
1048
+ "kind": "Content",
1049
+ "text": "export type CommitAckEventDetail = "
1050
+ },
1051
+ {
1052
+ "kind": "Content",
1053
+ "text": "{\n eventName: string;\n ack: "
1054
+ },
1055
+ {
1056
+ "kind": "Reference",
1057
+ "text": "Message",
1058
+ "canonicalReference": "@genesislcap/foundation-comms!Message:type"
1059
+ },
1060
+ {
1061
+ "kind": "Content",
1062
+ "text": ";\n}"
1063
+ },
1064
+ {
1065
+ "kind": "Content",
1066
+ "text": ";"
1067
+ }
1068
+ ],
1069
+ "fileUrlPath": "src/connect/connect.events.ts",
1070
+ "releaseTag": "Public",
1071
+ "name": "CommitAckEventDetail",
1072
+ "typeTokenRange": {
1073
+ "startIndex": 1,
1074
+ "endIndex": 4
1075
+ }
1076
+ },
1077
+ {
1078
+ "kind": "Variable",
1079
+ "canonicalReference": "@genesislcap/foundation-comms!CommitAckEventType:var",
1080
+ "docComment": "/**\n * @public\n */\n",
1081
+ "excerptTokens": [
1082
+ {
1083
+ "kind": "Content",
1084
+ "text": "CommitAckEventType = "
1085
+ },
1086
+ {
1087
+ "kind": "Content",
1088
+ "text": "\"connect-commit-ack-event\""
1089
+ }
1090
+ ],
1091
+ "fileUrlPath": "src/connect/connect.events.ts",
1092
+ "initializerTokenRange": {
1093
+ "startIndex": 1,
1094
+ "endIndex": 2
1095
+ },
1096
+ "isReadonly": true,
1097
+ "releaseTag": "Public",
1098
+ "name": "CommitAckEventType",
1099
+ "variableTypeTokenRange": {
1100
+ "startIndex": 0,
1101
+ "endIndex": 0
1102
+ }
1103
+ },
1002
1104
  {
1003
1105
  "kind": "TypeAlias",
1004
1106
  "canonicalReference": "@genesislcap/foundation-comms!CommitEvent:type",
@@ -1127,6 +1229,108 @@
1127
1229
  "endIndex": 2
1128
1230
  }
1129
1231
  },
1232
+ {
1233
+ "kind": "TypeAlias",
1234
+ "canonicalReference": "@genesislcap/foundation-comms!CommitResponseEvent:type",
1235
+ "docComment": "/**\n * @public\n */\n",
1236
+ "excerptTokens": [
1237
+ {
1238
+ "kind": "Content",
1239
+ "text": "export type CommitResponseEvent = "
1240
+ },
1241
+ {
1242
+ "kind": "Reference",
1243
+ "text": "CustomEvent",
1244
+ "canonicalReference": "!CustomEvent:interface"
1245
+ },
1246
+ {
1247
+ "kind": "Content",
1248
+ "text": "<"
1249
+ },
1250
+ {
1251
+ "kind": "Reference",
1252
+ "text": "CommitResponseEventDetail",
1253
+ "canonicalReference": "@genesislcap/foundation-comms!CommitResponseEventDetail:type"
1254
+ },
1255
+ {
1256
+ "kind": "Content",
1257
+ "text": ">"
1258
+ },
1259
+ {
1260
+ "kind": "Content",
1261
+ "text": ";"
1262
+ }
1263
+ ],
1264
+ "fileUrlPath": "src/connect/connect.events.ts",
1265
+ "releaseTag": "Public",
1266
+ "name": "CommitResponseEvent",
1267
+ "typeTokenRange": {
1268
+ "startIndex": 1,
1269
+ "endIndex": 5
1270
+ }
1271
+ },
1272
+ {
1273
+ "kind": "TypeAlias",
1274
+ "canonicalReference": "@genesislcap/foundation-comms!CommitResponseEventDetail:type",
1275
+ "docComment": "/**\n * @public\n */\n",
1276
+ "excerptTokens": [
1277
+ {
1278
+ "kind": "Content",
1279
+ "text": "export type CommitResponseEventDetail = "
1280
+ },
1281
+ {
1282
+ "kind": "Content",
1283
+ "text": "{\n eventName: string;\n response: "
1284
+ },
1285
+ {
1286
+ "kind": "Reference",
1287
+ "text": "Message",
1288
+ "canonicalReference": "@genesislcap/foundation-comms!Message:type"
1289
+ },
1290
+ {
1291
+ "kind": "Content",
1292
+ "text": ";\n}"
1293
+ },
1294
+ {
1295
+ "kind": "Content",
1296
+ "text": ";"
1297
+ }
1298
+ ],
1299
+ "fileUrlPath": "src/connect/connect.events.ts",
1300
+ "releaseTag": "Public",
1301
+ "name": "CommitResponseEventDetail",
1302
+ "typeTokenRange": {
1303
+ "startIndex": 1,
1304
+ "endIndex": 4
1305
+ }
1306
+ },
1307
+ {
1308
+ "kind": "Variable",
1309
+ "canonicalReference": "@genesislcap/foundation-comms!CommitResponseEventType:var",
1310
+ "docComment": "/**\n * @public\n */\n",
1311
+ "excerptTokens": [
1312
+ {
1313
+ "kind": "Content",
1314
+ "text": "CommitResponseEventType = "
1315
+ },
1316
+ {
1317
+ "kind": "Content",
1318
+ "text": "\"connect-commit-response-event\""
1319
+ }
1320
+ ],
1321
+ "fileUrlPath": "src/connect/connect.events.ts",
1322
+ "initializerTokenRange": {
1323
+ "startIndex": 1,
1324
+ "endIndex": 2
1325
+ },
1326
+ "isReadonly": true,
1327
+ "releaseTag": "Public",
1328
+ "name": "CommitResponseEventType",
1329
+ "variableTypeTokenRange": {
1330
+ "startIndex": 0,
1331
+ "endIndex": 0
1332
+ }
1333
+ },
1130
1334
  {
1131
1335
  "kind": "Interface",
1132
1336
  "canonicalReference": "@genesislcap/foundation-comms!Connect:interface",
@@ -2327,6 +2531,65 @@
2327
2531
  "name": "ConnectEvents",
2328
2532
  "preserveMemberOrder": false,
2329
2533
  "members": [
2534
+ {
2535
+ "kind": "MethodSignature",
2536
+ "canonicalReference": "@genesislcap/foundation-comms!ConnectEvents#addCommitAckListener:member(1)",
2537
+ "docComment": "/**\n * Add a commit ack listener.\n *\n * @param listener - A listener callback function.\n */\n",
2538
+ "excerptTokens": [
2539
+ {
2540
+ "kind": "Content",
2541
+ "text": "addCommitAckListener(listener: "
2542
+ },
2543
+ {
2544
+ "kind": "Reference",
2545
+ "text": "Listener",
2546
+ "canonicalReference": "@genesislcap/foundation-utils!Listener:type"
2547
+ },
2548
+ {
2549
+ "kind": "Content",
2550
+ "text": "<"
2551
+ },
2552
+ {
2553
+ "kind": "Reference",
2554
+ "text": "CommitAckEvent",
2555
+ "canonicalReference": "@genesislcap/foundation-comms!CommitAckEvent:type"
2556
+ },
2557
+ {
2558
+ "kind": "Content",
2559
+ "text": ">"
2560
+ },
2561
+ {
2562
+ "kind": "Content",
2563
+ "text": "): "
2564
+ },
2565
+ {
2566
+ "kind": "Content",
2567
+ "text": "() => void"
2568
+ },
2569
+ {
2570
+ "kind": "Content",
2571
+ "text": ";"
2572
+ }
2573
+ ],
2574
+ "isOptional": false,
2575
+ "returnTypeTokenRange": {
2576
+ "startIndex": 6,
2577
+ "endIndex": 7
2578
+ },
2579
+ "releaseTag": "Public",
2580
+ "overloadIndex": 1,
2581
+ "parameters": [
2582
+ {
2583
+ "parameterName": "listener",
2584
+ "parameterTypeTokenRange": {
2585
+ "startIndex": 1,
2586
+ "endIndex": 5
2587
+ },
2588
+ "isOptional": false
2589
+ }
2590
+ ],
2591
+ "name": "addCommitAckListener"
2592
+ },
2330
2593
  {
2331
2594
  "kind": "MethodSignature",
2332
2595
  "canonicalReference": "@genesislcap/foundation-comms!ConnectEvents#addCommitListener:member(1)",
@@ -2386,6 +2649,65 @@
2386
2649
  ],
2387
2650
  "name": "addCommitListener"
2388
2651
  },
2652
+ {
2653
+ "kind": "MethodSignature",
2654
+ "canonicalReference": "@genesislcap/foundation-comms!ConnectEvents#addCommitResponseListener:member(1)",
2655
+ "docComment": "/**\n * Add a commit response listener (fires for both ack and nack).\n *\n * @param listener - A listener callback function.\n */\n",
2656
+ "excerptTokens": [
2657
+ {
2658
+ "kind": "Content",
2659
+ "text": "addCommitResponseListener(listener: "
2660
+ },
2661
+ {
2662
+ "kind": "Reference",
2663
+ "text": "Listener",
2664
+ "canonicalReference": "@genesislcap/foundation-utils!Listener:type"
2665
+ },
2666
+ {
2667
+ "kind": "Content",
2668
+ "text": "<"
2669
+ },
2670
+ {
2671
+ "kind": "Reference",
2672
+ "text": "CommitResponseEvent",
2673
+ "canonicalReference": "@genesislcap/foundation-comms!CommitResponseEvent:type"
2674
+ },
2675
+ {
2676
+ "kind": "Content",
2677
+ "text": ">"
2678
+ },
2679
+ {
2680
+ "kind": "Content",
2681
+ "text": "): "
2682
+ },
2683
+ {
2684
+ "kind": "Content",
2685
+ "text": "() => void"
2686
+ },
2687
+ {
2688
+ "kind": "Content",
2689
+ "text": ";"
2690
+ }
2691
+ ],
2692
+ "isOptional": false,
2693
+ "returnTypeTokenRange": {
2694
+ "startIndex": 6,
2695
+ "endIndex": 7
2696
+ },
2697
+ "releaseTag": "Public",
2698
+ "overloadIndex": 1,
2699
+ "parameters": [
2700
+ {
2701
+ "parameterName": "listener",
2702
+ "parameterTypeTokenRange": {
2703
+ "startIndex": 1,
2704
+ "endIndex": 5
2705
+ },
2706
+ "isOptional": false
2707
+ }
2708
+ ],
2709
+ "name": "addCommitResponseListener"
2710
+ },
2389
2711
  {
2390
2712
  "kind": "MethodSignature",
2391
2713
  "canonicalReference": "@genesislcap/foundation-comms!ConnectEvents#addMetadataListener:member(1)",
@@ -2486,35 +2808,194 @@
2486
2808
  "text": "<"
2487
2809
  },
2488
2810
  {
2489
- "kind": "Reference",
2490
- "text": "StreamCompleteEvent",
2491
- "canonicalReference": "@genesislcap/foundation-comms!StreamCompleteEvent:type"
2492
- },
2811
+ "kind": "Reference",
2812
+ "text": "StreamCompleteEvent",
2813
+ "canonicalReference": "@genesislcap/foundation-comms!StreamCompleteEvent:type"
2814
+ },
2815
+ {
2816
+ "kind": "Content",
2817
+ "text": ">"
2818
+ },
2819
+ {
2820
+ "kind": "Content",
2821
+ "text": ", error: "
2822
+ },
2823
+ {
2824
+ "kind": "Reference",
2825
+ "text": "Listener",
2826
+ "canonicalReference": "@genesislcap/foundation-utils!Listener:type"
2827
+ },
2828
+ {
2829
+ "kind": "Content",
2830
+ "text": "<"
2831
+ },
2832
+ {
2833
+ "kind": "Reference",
2834
+ "text": "StreamErrorEvent",
2835
+ "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEvent:type"
2836
+ },
2837
+ {
2838
+ "kind": "Content",
2839
+ "text": ">"
2840
+ },
2841
+ {
2842
+ "kind": "Content",
2843
+ "text": "): "
2844
+ },
2845
+ {
2846
+ "kind": "Content",
2847
+ "text": "() => void"
2848
+ },
2849
+ {
2850
+ "kind": "Content",
2851
+ "text": ";"
2852
+ }
2853
+ ],
2854
+ "isOptional": false,
2855
+ "returnTypeTokenRange": {
2856
+ "startIndex": 16,
2857
+ "endIndex": 17
2858
+ },
2859
+ "releaseTag": "Public",
2860
+ "overloadIndex": 1,
2861
+ "parameters": [
2862
+ {
2863
+ "parameterName": "listener",
2864
+ "parameterTypeTokenRange": {
2865
+ "startIndex": 1,
2866
+ "endIndex": 5
2867
+ },
2868
+ "isOptional": false
2869
+ },
2870
+ {
2871
+ "parameterName": "complete",
2872
+ "parameterTypeTokenRange": {
2873
+ "startIndex": 6,
2874
+ "endIndex": 10
2875
+ },
2876
+ "isOptional": false
2877
+ },
2878
+ {
2879
+ "parameterName": "error",
2880
+ "parameterTypeTokenRange": {
2881
+ "startIndex": 11,
2882
+ "endIndex": 15
2883
+ },
2884
+ "isOptional": false
2885
+ }
2886
+ ],
2887
+ "name": "addStreamListener"
2888
+ }
2889
+ ],
2890
+ "extendsTokenRanges": []
2891
+ },
2892
+ {
2893
+ "kind": "Interface",
2894
+ "canonicalReference": "@genesislcap/foundation-comms!ConnectEventsEmitter:interface",
2895
+ "docComment": "/**\n * `ConnectEventsEmitter` provide event emitting hooks to Connect.\n *\n * @public\n */\n",
2896
+ "excerptTokens": [
2897
+ {
2898
+ "kind": "Content",
2899
+ "text": "export interface ConnectEventsEmitter extends "
2900
+ },
2901
+ {
2902
+ "kind": "Reference",
2903
+ "text": "ConnectEvents",
2904
+ "canonicalReference": "@genesislcap/foundation-comms!ConnectEvents:interface"
2905
+ },
2906
+ {
2907
+ "kind": "Content",
2908
+ "text": " "
2909
+ }
2910
+ ],
2911
+ "fileUrlPath": "src/connect/connect.events.ts",
2912
+ "releaseTag": "Public",
2913
+ "name": "ConnectEventsEmitter",
2914
+ "preserveMemberOrder": false,
2915
+ "members": [
2916
+ {
2917
+ "kind": "MethodSignature",
2918
+ "canonicalReference": "@genesislcap/foundation-comms!ConnectEventsEmitter#onCommitAckEvent:member(1)",
2919
+ "docComment": "/**\n * Called by Connect when a commit ack is received.\n *\n * @param eventName - The name of the event.\n *\n * @param ack - The ack message from the server.\n */\n",
2920
+ "excerptTokens": [
2921
+ {
2922
+ "kind": "Content",
2923
+ "text": "onCommitAckEvent(eventName: "
2924
+ },
2925
+ {
2926
+ "kind": "Content",
2927
+ "text": "string"
2928
+ },
2929
+ {
2930
+ "kind": "Content",
2931
+ "text": ", ack: "
2932
+ },
2933
+ {
2934
+ "kind": "Reference",
2935
+ "text": "Message",
2936
+ "canonicalReference": "@genesislcap/foundation-comms!Message:type"
2937
+ },
2938
+ {
2939
+ "kind": "Content",
2940
+ "text": "): "
2941
+ },
2942
+ {
2943
+ "kind": "Content",
2944
+ "text": "void"
2945
+ },
2946
+ {
2947
+ "kind": "Content",
2948
+ "text": ";"
2949
+ }
2950
+ ],
2951
+ "isOptional": false,
2952
+ "returnTypeTokenRange": {
2953
+ "startIndex": 5,
2954
+ "endIndex": 6
2955
+ },
2956
+ "releaseTag": "Public",
2957
+ "overloadIndex": 1,
2958
+ "parameters": [
2959
+ {
2960
+ "parameterName": "eventName",
2961
+ "parameterTypeTokenRange": {
2962
+ "startIndex": 1,
2963
+ "endIndex": 2
2964
+ },
2965
+ "isOptional": false
2966
+ },
2967
+ {
2968
+ "parameterName": "ack",
2969
+ "parameterTypeTokenRange": {
2970
+ "startIndex": 3,
2971
+ "endIndex": 4
2972
+ },
2973
+ "isOptional": false
2974
+ }
2975
+ ],
2976
+ "name": "onCommitAckEvent"
2977
+ },
2978
+ {
2979
+ "kind": "MethodSignature",
2980
+ "canonicalReference": "@genesislcap/foundation-comms!ConnectEventsEmitter#onCommitEvent:member(1)",
2981
+ "docComment": "/**\n * Called by Connect.\n *\n * @param eventName - The name of the event.\n *\n * @param message - The message.\n */\n",
2982
+ "excerptTokens": [
2493
2983
  {
2494
2984
  "kind": "Content",
2495
- "text": ">"
2985
+ "text": "onCommitEvent(eventName: "
2496
2986
  },
2497
2987
  {
2498
2988
  "kind": "Content",
2499
- "text": ", error: "
2500
- },
2501
- {
2502
- "kind": "Reference",
2503
- "text": "Listener",
2504
- "canonicalReference": "@genesislcap/foundation-utils!Listener:type"
2989
+ "text": "string"
2505
2990
  },
2506
2991
  {
2507
2992
  "kind": "Content",
2508
- "text": "<"
2993
+ "text": ", message: "
2509
2994
  },
2510
2995
  {
2511
2996
  "kind": "Reference",
2512
- "text": "StreamErrorEvent",
2513
- "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEvent:type"
2514
- },
2515
- {
2516
- "kind": "Content",
2517
- "text": ">"
2997
+ "text": "Message",
2998
+ "canonicalReference": "@genesislcap/foundation-comms!Message:type"
2518
2999
  },
2519
3000
  {
2520
3001
  "kind": "Content",
@@ -2522,7 +3003,7 @@
2522
3003
  },
2523
3004
  {
2524
3005
  "kind": "Content",
2525
- "text": "() => void"
3006
+ "text": "void"
2526
3007
  },
2527
3008
  {
2528
3009
  "kind": "Content",
@@ -2531,74 +3012,39 @@
2531
3012
  ],
2532
3013
  "isOptional": false,
2533
3014
  "returnTypeTokenRange": {
2534
- "startIndex": 16,
2535
- "endIndex": 17
3015
+ "startIndex": 5,
3016
+ "endIndex": 6
2536
3017
  },
2537
3018
  "releaseTag": "Public",
2538
3019
  "overloadIndex": 1,
2539
3020
  "parameters": [
2540
3021
  {
2541
- "parameterName": "listener",
3022
+ "parameterName": "eventName",
2542
3023
  "parameterTypeTokenRange": {
2543
3024
  "startIndex": 1,
2544
- "endIndex": 5
2545
- },
2546
- "isOptional": false
2547
- },
2548
- {
2549
- "parameterName": "complete",
2550
- "parameterTypeTokenRange": {
2551
- "startIndex": 6,
2552
- "endIndex": 10
3025
+ "endIndex": 2
2553
3026
  },
2554
3027
  "isOptional": false
2555
3028
  },
2556
3029
  {
2557
- "parameterName": "error",
3030
+ "parameterName": "message",
2558
3031
  "parameterTypeTokenRange": {
2559
- "startIndex": 11,
2560
- "endIndex": 15
3032
+ "startIndex": 3,
3033
+ "endIndex": 4
2561
3034
  },
2562
3035
  "isOptional": false
2563
3036
  }
2564
3037
  ],
2565
- "name": "addStreamListener"
2566
- }
2567
- ],
2568
- "extendsTokenRanges": []
2569
- },
2570
- {
2571
- "kind": "Interface",
2572
- "canonicalReference": "@genesislcap/foundation-comms!ConnectEventsEmitter:interface",
2573
- "docComment": "/**\n * `ConnectEventsEmitter` provide event emitting hooks to Connect.\n *\n * @public\n */\n",
2574
- "excerptTokens": [
2575
- {
2576
- "kind": "Content",
2577
- "text": "export interface ConnectEventsEmitter extends "
2578
- },
2579
- {
2580
- "kind": "Reference",
2581
- "text": "ConnectEvents",
2582
- "canonicalReference": "@genesislcap/foundation-comms!ConnectEvents:interface"
3038
+ "name": "onCommitEvent"
2583
3039
  },
2584
- {
2585
- "kind": "Content",
2586
- "text": " "
2587
- }
2588
- ],
2589
- "fileUrlPath": "src/connect/connect.events.ts",
2590
- "releaseTag": "Public",
2591
- "name": "ConnectEventsEmitter",
2592
- "preserveMemberOrder": false,
2593
- "members": [
2594
3040
  {
2595
3041
  "kind": "MethodSignature",
2596
- "canonicalReference": "@genesislcap/foundation-comms!ConnectEventsEmitter#onCommitEvent:member(1)",
2597
- "docComment": "/**\n * Called by Connect.\n *\n * @param eventName - The name of the event.\n *\n * @param message - The message.\n */\n",
3042
+ "canonicalReference": "@genesislcap/foundation-comms!ConnectEventsEmitter#onCommitResponseEvent:member(1)",
3043
+ "docComment": "/**\n * Called by Connect when a commit response (ack or nack) is received.\n *\n * @param eventName - The name of the event.\n *\n * @param response - The response message from the server (ack or nack).\n */\n",
2598
3044
  "excerptTokens": [
2599
3045
  {
2600
3046
  "kind": "Content",
2601
- "text": "onCommitEvent(eventName: "
3047
+ "text": "onCommitResponseEvent(eventName: "
2602
3048
  },
2603
3049
  {
2604
3050
  "kind": "Content",
@@ -2606,7 +3052,7 @@
2606
3052
  },
2607
3053
  {
2608
3054
  "kind": "Content",
2609
- "text": ", message: "
3055
+ "text": ", response: "
2610
3056
  },
2611
3057
  {
2612
3058
  "kind": "Reference",
@@ -2643,7 +3089,7 @@
2643
3089
  "isOptional": false
2644
3090
  },
2645
3091
  {
2646
- "parameterName": "message",
3092
+ "parameterName": "response",
2647
3093
  "parameterTypeTokenRange": {
2648
3094
  "startIndex": 3,
2649
3095
  "endIndex": 4
@@ -2651,7 +3097,7 @@
2651
3097
  "isOptional": false
2652
3098
  }
2653
3099
  ],
2654
- "name": "onCommitEvent"
3100
+ "name": "onCommitResponseEvent"
2655
3101
  },
2656
3102
  {
2657
3103
  "kind": "MethodSignature",
@@ -5413,6 +5859,34 @@
5413
5859
  "endIndex": 7
5414
5860
  }
5415
5861
  },
5862
+ {
5863
+ "kind": "MethodSignature",
5864
+ "canonicalReference": "@genesislcap/foundation-comms!Datasource#triggerPoll:member(1)",
5865
+ "docComment": "/**\n * Triggers a manual poll of the data source.\n *\n * @public\n */\n",
5866
+ "excerptTokens": [
5867
+ {
5868
+ "kind": "Content",
5869
+ "text": "triggerPoll(): "
5870
+ },
5871
+ {
5872
+ "kind": "Content",
5873
+ "text": "void"
5874
+ },
5875
+ {
5876
+ "kind": "Content",
5877
+ "text": ";"
5878
+ }
5879
+ ],
5880
+ "isOptional": false,
5881
+ "returnTypeTokenRange": {
5882
+ "startIndex": 1,
5883
+ "endIndex": 2
5884
+ },
5885
+ "releaseTag": "Public",
5886
+ "overloadIndex": 1,
5887
+ "parameters": [],
5888
+ "name": "triggerPoll"
5889
+ },
5416
5890
  {
5417
5891
  "kind": "MethodSignature",
5418
5892
  "canonicalReference": "@genesislcap/foundation-comms!Datasource#updateData:member(1)",
@@ -9417,6 +9891,33 @@
9417
9891
  "endIndex": 2
9418
9892
  }
9419
9893
  },
9894
+ {
9895
+ "kind": "PropertySignature",
9896
+ "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#pollTriggerEvents:member",
9897
+ "docComment": "/**\n * Array of event names that will trigger an additional poll.\n *\n * @remarks\n *\n * Only works with REQUEST_SERVER resources.\n */\n",
9898
+ "excerptTokens": [
9899
+ {
9900
+ "kind": "Content",
9901
+ "text": "pollTriggerEvents?: "
9902
+ },
9903
+ {
9904
+ "kind": "Content",
9905
+ "text": "string[]"
9906
+ },
9907
+ {
9908
+ "kind": "Content",
9909
+ "text": ";"
9910
+ }
9911
+ ],
9912
+ "isReadonly": false,
9913
+ "isOptional": true,
9914
+ "releaseTag": "Public",
9915
+ "name": "pollTriggerEvents",
9916
+ "propertyTypeTokenRange": {
9917
+ "startIndex": 1,
9918
+ "endIndex": 2
9919
+ }
9920
+ },
9420
9921
  {
9421
9922
  "kind": "PropertySignature",
9422
9923
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#request:member",
@@ -11983,6 +12484,68 @@
11983
12484
  "name": "DefaultConnectEvents",
11984
12485
  "preserveMemberOrder": false,
11985
12486
  "members": [
12487
+ {
12488
+ "kind": "Method",
12489
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultConnectEvents#addCommitAckListener:member(1)",
12490
+ "docComment": "/**\n * {@inheritDoc ConnectEvents.addCommitAckListener}\n */\n",
12491
+ "excerptTokens": [
12492
+ {
12493
+ "kind": "Content",
12494
+ "text": "addCommitAckListener(listener: "
12495
+ },
12496
+ {
12497
+ "kind": "Reference",
12498
+ "text": "Listener",
12499
+ "canonicalReference": "@genesislcap/foundation-utils!Listener:type"
12500
+ },
12501
+ {
12502
+ "kind": "Content",
12503
+ "text": "<"
12504
+ },
12505
+ {
12506
+ "kind": "Reference",
12507
+ "text": "CommitAckEvent",
12508
+ "canonicalReference": "@genesislcap/foundation-comms!CommitAckEvent:type"
12509
+ },
12510
+ {
12511
+ "kind": "Content",
12512
+ "text": ">"
12513
+ },
12514
+ {
12515
+ "kind": "Content",
12516
+ "text": "): "
12517
+ },
12518
+ {
12519
+ "kind": "Content",
12520
+ "text": "() => void"
12521
+ },
12522
+ {
12523
+ "kind": "Content",
12524
+ "text": ";"
12525
+ }
12526
+ ],
12527
+ "isStatic": false,
12528
+ "returnTypeTokenRange": {
12529
+ "startIndex": 6,
12530
+ "endIndex": 7
12531
+ },
12532
+ "releaseTag": "Public",
12533
+ "isProtected": false,
12534
+ "overloadIndex": 1,
12535
+ "parameters": [
12536
+ {
12537
+ "parameterName": "listener",
12538
+ "parameterTypeTokenRange": {
12539
+ "startIndex": 1,
12540
+ "endIndex": 5
12541
+ },
12542
+ "isOptional": false
12543
+ }
12544
+ ],
12545
+ "isOptional": false,
12546
+ "isAbstract": false,
12547
+ "name": "addCommitAckListener"
12548
+ },
11986
12549
  {
11987
12550
  "kind": "Method",
11988
12551
  "canonicalReference": "@genesislcap/foundation-comms!DefaultConnectEvents#addCommitListener:member(1)",
@@ -12045,6 +12608,68 @@
12045
12608
  "isAbstract": false,
12046
12609
  "name": "addCommitListener"
12047
12610
  },
12611
+ {
12612
+ "kind": "Method",
12613
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultConnectEvents#addCommitResponseListener:member(1)",
12614
+ "docComment": "/**\n * {@inheritDoc ConnectEvents.addCommitResponseListener}\n */\n",
12615
+ "excerptTokens": [
12616
+ {
12617
+ "kind": "Content",
12618
+ "text": "addCommitResponseListener(listener: "
12619
+ },
12620
+ {
12621
+ "kind": "Reference",
12622
+ "text": "Listener",
12623
+ "canonicalReference": "@genesislcap/foundation-utils!Listener:type"
12624
+ },
12625
+ {
12626
+ "kind": "Content",
12627
+ "text": "<"
12628
+ },
12629
+ {
12630
+ "kind": "Reference",
12631
+ "text": "CommitResponseEvent",
12632
+ "canonicalReference": "@genesislcap/foundation-comms!CommitResponseEvent:type"
12633
+ },
12634
+ {
12635
+ "kind": "Content",
12636
+ "text": ">"
12637
+ },
12638
+ {
12639
+ "kind": "Content",
12640
+ "text": "): "
12641
+ },
12642
+ {
12643
+ "kind": "Content",
12644
+ "text": "() => void"
12645
+ },
12646
+ {
12647
+ "kind": "Content",
12648
+ "text": ";"
12649
+ }
12650
+ ],
12651
+ "isStatic": false,
12652
+ "returnTypeTokenRange": {
12653
+ "startIndex": 6,
12654
+ "endIndex": 7
12655
+ },
12656
+ "releaseTag": "Public",
12657
+ "isProtected": false,
12658
+ "overloadIndex": 1,
12659
+ "parameters": [
12660
+ {
12661
+ "parameterName": "listener",
12662
+ "parameterTypeTokenRange": {
12663
+ "startIndex": 1,
12664
+ "endIndex": 5
12665
+ },
12666
+ "isOptional": false
12667
+ }
12668
+ ],
12669
+ "isOptional": false,
12670
+ "isAbstract": false,
12671
+ "name": "addCommitResponseListener"
12672
+ },
12048
12673
  {
12049
12674
  "kind": "Method",
12050
12675
  "canonicalReference": "@genesislcap/foundation-comms!DefaultConnectEvents#addMetadataListener:member(1)",
@@ -12229,6 +12854,71 @@
12229
12854
  "isAbstract": false,
12230
12855
  "name": "addStreamListener"
12231
12856
  },
12857
+ {
12858
+ "kind": "Method",
12859
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultConnectEvents#onCommitAckEvent:member(1)",
12860
+ "docComment": "/**\n * {@inheritDoc ConnectEventsEmitter.onCommitAckEvent}\n */\n",
12861
+ "excerptTokens": [
12862
+ {
12863
+ "kind": "Content",
12864
+ "text": "onCommitAckEvent(eventName: "
12865
+ },
12866
+ {
12867
+ "kind": "Content",
12868
+ "text": "string"
12869
+ },
12870
+ {
12871
+ "kind": "Content",
12872
+ "text": ", ack: "
12873
+ },
12874
+ {
12875
+ "kind": "Reference",
12876
+ "text": "Message",
12877
+ "canonicalReference": "@genesislcap/foundation-comms!Message:type"
12878
+ },
12879
+ {
12880
+ "kind": "Content",
12881
+ "text": "): "
12882
+ },
12883
+ {
12884
+ "kind": "Content",
12885
+ "text": "void"
12886
+ },
12887
+ {
12888
+ "kind": "Content",
12889
+ "text": ";"
12890
+ }
12891
+ ],
12892
+ "isStatic": false,
12893
+ "returnTypeTokenRange": {
12894
+ "startIndex": 5,
12895
+ "endIndex": 6
12896
+ },
12897
+ "releaseTag": "Public",
12898
+ "isProtected": false,
12899
+ "overloadIndex": 1,
12900
+ "parameters": [
12901
+ {
12902
+ "parameterName": "eventName",
12903
+ "parameterTypeTokenRange": {
12904
+ "startIndex": 1,
12905
+ "endIndex": 2
12906
+ },
12907
+ "isOptional": false
12908
+ },
12909
+ {
12910
+ "parameterName": "ack",
12911
+ "parameterTypeTokenRange": {
12912
+ "startIndex": 3,
12913
+ "endIndex": 4
12914
+ },
12915
+ "isOptional": false
12916
+ }
12917
+ ],
12918
+ "isOptional": false,
12919
+ "isAbstract": false,
12920
+ "name": "onCommitAckEvent"
12921
+ },
12232
12922
  {
12233
12923
  "kind": "Method",
12234
12924
  "canonicalReference": "@genesislcap/foundation-comms!DefaultConnectEvents#onCommitEvent:member(1)",
@@ -12294,6 +12984,71 @@
12294
12984
  "isAbstract": false,
12295
12985
  "name": "onCommitEvent"
12296
12986
  },
12987
+ {
12988
+ "kind": "Method",
12989
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultConnectEvents#onCommitResponseEvent:member(1)",
12990
+ "docComment": "/**\n * {@inheritDoc ConnectEventsEmitter.onCommitResponseEvent}\n */\n",
12991
+ "excerptTokens": [
12992
+ {
12993
+ "kind": "Content",
12994
+ "text": "onCommitResponseEvent(eventName: "
12995
+ },
12996
+ {
12997
+ "kind": "Content",
12998
+ "text": "string"
12999
+ },
13000
+ {
13001
+ "kind": "Content",
13002
+ "text": ", response: "
13003
+ },
13004
+ {
13005
+ "kind": "Reference",
13006
+ "text": "Message",
13007
+ "canonicalReference": "@genesislcap/foundation-comms!Message:type"
13008
+ },
13009
+ {
13010
+ "kind": "Content",
13011
+ "text": "): "
13012
+ },
13013
+ {
13014
+ "kind": "Content",
13015
+ "text": "void"
13016
+ },
13017
+ {
13018
+ "kind": "Content",
13019
+ "text": ";"
13020
+ }
13021
+ ],
13022
+ "isStatic": false,
13023
+ "returnTypeTokenRange": {
13024
+ "startIndex": 5,
13025
+ "endIndex": 6
13026
+ },
13027
+ "releaseTag": "Public",
13028
+ "isProtected": false,
13029
+ "overloadIndex": 1,
13030
+ "parameters": [
13031
+ {
13032
+ "parameterName": "eventName",
13033
+ "parameterTypeTokenRange": {
13034
+ "startIndex": 1,
13035
+ "endIndex": 2
13036
+ },
13037
+ "isOptional": false
13038
+ },
13039
+ {
13040
+ "parameterName": "response",
13041
+ "parameterTypeTokenRange": {
13042
+ "startIndex": 3,
13043
+ "endIndex": 4
13044
+ },
13045
+ "isOptional": false
13046
+ }
13047
+ ],
13048
+ "isOptional": false,
13049
+ "isAbstract": false,
13050
+ "name": "onCommitResponseEvent"
13051
+ },
12297
13052
  {
12298
13053
  "kind": "Method",
12299
13054
  "canonicalReference": "@genesislcap/foundation-comms!DefaultConnectEvents#onMetadataEvent:member(1)",
@@ -14017,6 +14772,36 @@
14017
14772
  }
14018
14773
  ]
14019
14774
  },
14775
+ {
14776
+ "kind": "Property",
14777
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#allParams:member",
14778
+ "docComment": "",
14779
+ "excerptTokens": [
14780
+ {
14781
+ "kind": "Content",
14782
+ "text": "get allParams(): "
14783
+ },
14784
+ {
14785
+ "kind": "Content",
14786
+ "text": "any"
14787
+ },
14788
+ {
14789
+ "kind": "Content",
14790
+ "text": ";"
14791
+ }
14792
+ ],
14793
+ "isReadonly": true,
14794
+ "isOptional": false,
14795
+ "releaseTag": "Public",
14796
+ "name": "allParams",
14797
+ "propertyTypeTokenRange": {
14798
+ "startIndex": 1,
14799
+ "endIndex": 2
14800
+ },
14801
+ "isStatic": false,
14802
+ "isProtected": false,
14803
+ "isAbstract": false
14804
+ },
14020
14805
  {
14021
14806
  "kind": "Property",
14022
14807
  "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#auth:member",
@@ -14145,6 +14930,37 @@
14145
14930
  "isProtected": true,
14146
14931
  "isAbstract": false
14147
14932
  },
14933
+ {
14934
+ "kind": "Property",
14935
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#connectEvents:member",
14936
+ "docComment": "",
14937
+ "excerptTokens": [
14938
+ {
14939
+ "kind": "Content",
14940
+ "text": "protected connectEvents: "
14941
+ },
14942
+ {
14943
+ "kind": "Reference",
14944
+ "text": "ConnectEvents",
14945
+ "canonicalReference": "@genesislcap/foundation-comms!ConnectEvents:interface"
14946
+ },
14947
+ {
14948
+ "kind": "Content",
14949
+ "text": ";"
14950
+ }
14951
+ ],
14952
+ "isReadonly": false,
14953
+ "isOptional": false,
14954
+ "releaseTag": "Public",
14955
+ "name": "connectEvents",
14956
+ "propertyTypeTokenRange": {
14957
+ "startIndex": 1,
14958
+ "endIndex": 2
14959
+ },
14960
+ "isStatic": false,
14961
+ "isProtected": true,
14962
+ "isAbstract": false
14963
+ },
14148
14964
  {
14149
14965
  "kind": "Property",
14150
14966
  "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#customRequestFields:member",
@@ -14180,6 +14996,37 @@
14180
14996
  "isProtected": false,
14181
14997
  "isAbstract": false
14182
14998
  },
14999
+ {
15000
+ "kind": "Property",
15001
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#dataserverParams:member",
15002
+ "docComment": "",
15003
+ "excerptTokens": [
15004
+ {
15005
+ "kind": "Content",
15006
+ "text": "get dataserverParams(): "
15007
+ },
15008
+ {
15009
+ "kind": "Reference",
15010
+ "text": "DataserverParams",
15011
+ "canonicalReference": "@genesislcap/foundation-comms!DataserverParams:type"
15012
+ },
15013
+ {
15014
+ "kind": "Content",
15015
+ "text": ";"
15016
+ }
15017
+ ],
15018
+ "isReadonly": true,
15019
+ "isOptional": false,
15020
+ "releaseTag": "Public",
15021
+ "name": "dataserverParams",
15022
+ "propertyTypeTokenRange": {
15023
+ "startIndex": 1,
15024
+ "endIndex": 2
15025
+ },
15026
+ "isStatic": false,
15027
+ "isProtected": false,
15028
+ "isAbstract": false
15029
+ },
14183
15030
  {
14184
15031
  "kind": "Method",
14185
15032
  "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#destroy:member(1)",
@@ -14576,6 +15423,37 @@
14576
15423
  "isProtected": false,
14577
15424
  "isAbstract": false
14578
15425
  },
15426
+ {
15427
+ "kind": "Property",
15428
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#requestParams:member",
15429
+ "docComment": "",
15430
+ "excerptTokens": [
15431
+ {
15432
+ "kind": "Content",
15433
+ "text": "get requestParams(): "
15434
+ },
15435
+ {
15436
+ "kind": "Reference",
15437
+ "text": "RequestParams",
15438
+ "canonicalReference": "@genesislcap/foundation-comms!RequestParams:type"
15439
+ },
15440
+ {
15441
+ "kind": "Content",
15442
+ "text": ";"
15443
+ }
15444
+ ],
15445
+ "isReadonly": true,
15446
+ "isOptional": false,
15447
+ "releaseTag": "Public",
15448
+ "name": "requestParams",
15449
+ "propertyTypeTokenRange": {
15450
+ "startIndex": 1,
15451
+ "endIndex": 2
15452
+ },
15453
+ "isStatic": false,
15454
+ "isProtected": false,
15455
+ "isAbstract": false
15456
+ },
14579
15457
  {
14580
15458
  "kind": "Property",
14581
15459
  "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#resources:member",
@@ -14903,6 +15781,37 @@
14903
15781
  "isProtected": false,
14904
15782
  "isAbstract": false
14905
15783
  },
15784
+ {
15785
+ "kind": "Method",
15786
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#triggerPoll:member(1)",
15787
+ "docComment": "",
15788
+ "excerptTokens": [
15789
+ {
15790
+ "kind": "Content",
15791
+ "text": "triggerPoll(): "
15792
+ },
15793
+ {
15794
+ "kind": "Content",
15795
+ "text": "void"
15796
+ },
15797
+ {
15798
+ "kind": "Content",
15799
+ "text": ";"
15800
+ }
15801
+ ],
15802
+ "isStatic": false,
15803
+ "returnTypeTokenRange": {
15804
+ "startIndex": 1,
15805
+ "endIndex": 2
15806
+ },
15807
+ "releaseTag": "Public",
15808
+ "isProtected": false,
15809
+ "overloadIndex": 1,
15810
+ "parameters": [],
15811
+ "isOptional": false,
15812
+ "isAbstract": false,
15813
+ "name": "triggerPoll"
15814
+ },
14906
15815
  {
14907
15816
  "kind": "Method",
14908
15817
  "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#validResourceName:member(1)",