@genesislcap/foundation-comms 14.199.0 → 14.199.2-alpha-6f7195d.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (63) hide show
  1. package/dist/dts/connect/connect.d.ts +2 -2
  2. package/dist/dts/connect/connect.d.ts.map +1 -1
  3. package/dist/dts/connect/message.d.ts +12 -4
  4. package/dist/dts/connect/message.d.ts.map +1 -1
  5. package/dist/dts/datasource/datasource.d.ts +18 -16
  6. package/dist/dts/datasource/datasource.d.ts.map +1 -1
  7. package/dist/dts/datasource/datasource.types.d.ts +37 -17
  8. package/dist/dts/datasource/datasource.types.d.ts.map +1 -1
  9. package/dist/dts/metadata/metadata.types.d.ts +23 -1
  10. package/dist/dts/metadata/metadata.types.d.ts.map +1 -1
  11. package/dist/dts/testing/mocks/datasource/datasource.d.ts +3 -2
  12. package/dist/dts/testing/mocks/datasource/datasource.d.ts.map +1 -1
  13. package/dist/esm/connect/connect.js +2 -2
  14. package/dist/esm/connect/message.js +2 -1
  15. package/dist/esm/datasource/datasource.js +58 -33
  16. package/dist/esm/metadata/metadata.utils.js +2 -1
  17. package/dist/esm/testing/mocks/datasource/datasource.js +9 -2
  18. package/dist/foundation-comms.api.json +458 -108
  19. package/dist/foundation-comms.d.ts +97 -42
  20. package/docs/api/foundation-comms.connect.getmorerows.md +2 -1
  21. package/docs/api/foundation-comms.connect.md +1 -1
  22. package/docs/api/foundation-comms.datasource.destroy.md +5 -1
  23. package/docs/api/foundation-comms.datasource.init.md +2 -1
  24. package/docs/api/foundation-comms.datasource.md +4 -4
  25. package/docs/api/foundation-comms.datasource.snapshot.md +3 -3
  26. package/docs/api/foundation-comms.datasource.snapshotfiltered.md +2 -2
  27. package/docs/api/{foundation-comms.datasource.deinit.md → foundation-comms.datasource.startstream.md} +5 -9
  28. package/docs/api/foundation-comms.datasource.validresourcename.md +5 -0
  29. package/docs/api/foundation-comms.datasourceoptions.criteria.md +5 -0
  30. package/docs/api/foundation-comms.datasourceoptions.disablepolling.md +5 -0
  31. package/docs/api/foundation-comms.datasourceoptions.fields.md +5 -0
  32. package/docs/api/foundation-comms.datasourceoptions.maxrows.md +5 -0
  33. package/docs/api/foundation-comms.datasourceoptions.maxview.md +5 -0
  34. package/docs/api/foundation-comms.datasourceoptions.md +2 -0
  35. package/docs/api/foundation-comms.datasourceoptions.movingview.md +5 -0
  36. package/docs/api/foundation-comms.datasourceoptions.orderby.md +5 -0
  37. package/docs/api/foundation-comms.datasourceoptions.request.md +5 -0
  38. package/docs/api/foundation-comms.datasourceoptions.requestautosetup.md +18 -0
  39. package/docs/api/foundation-comms.datasourceoptions.reverse.md +5 -0
  40. package/docs/api/foundation-comms.datasourceoptions.viewnumber.md +18 -0
  41. package/docs/api/foundation-comms.defaultconnect.getmorerows.md +2 -1
  42. package/docs/api/foundation-comms.defaultconnect.md +1 -1
  43. package/docs/api/foundation-comms.defaultdatasource.destroy.md +5 -1
  44. package/docs/api/foundation-comms.defaultdatasource.init.md +2 -1
  45. package/docs/api/foundation-comms.defaultdatasource.md +5 -4
  46. package/docs/api/foundation-comms.defaultdatasource.snapshot.md +8 -1
  47. package/docs/api/{foundation-comms.defaultdatasource.deinit.md → foundation-comms.defaultdatasource.startstream.md} +4 -4
  48. package/docs/api/foundation-comms.defaultdatasource.startstreamrequired.md +12 -0
  49. package/docs/api/foundation-comms.defaultmessagebuilder.createmorerowsmessage.md +3 -2
  50. package/docs/api/foundation-comms.defaultmessagebuilder.md +1 -1
  51. package/docs/api/foundation-comms.md +2 -0
  52. package/docs/api/foundation-comms.messagebuilder.createmorerowsmessage.md +3 -2
  53. package/docs/api/foundation-comms.messagebuilder.createrequestmessage.md +2 -2
  54. package/docs/api/foundation-comms.messagebuilder.md +1 -1
  55. package/docs/api/foundation-comms.messagedetails.morerows.md +1 -0
  56. package/docs/api/foundation-comms.metadata.md +5 -2
  57. package/docs/api/foundation-comms.metadatadetail.md +3 -0
  58. package/docs/api/foundation-comms.replydetail.md +21 -0
  59. package/docs/api/foundation-comms.requestdetailsparam.md +15 -0
  60. package/docs/api/foundation-comms.requestparams.md +3 -1
  61. package/docs/api/foundation-comms.requestserverresult.md +5 -0
  62. package/docs/api-report.md +54 -18
  63. package/package.json +13 -13
@@ -1621,6 +1621,14 @@
1621
1621
  "kind": "Content",
1622
1622
  "text": "string"
1623
1623
  },
1624
+ {
1625
+ "kind": "Content",
1626
+ "text": ", viewNumber?: "
1627
+ },
1628
+ {
1629
+ "kind": "Content",
1630
+ "text": "number"
1631
+ },
1624
1632
  {
1625
1633
  "kind": "Content",
1626
1634
  "text": "): "
@@ -1650,8 +1658,8 @@
1650
1658
  ],
1651
1659
  "isOptional": false,
1652
1660
  "returnTypeTokenRange": {
1653
- "startIndex": 3,
1654
- "endIndex": 7
1661
+ "startIndex": 5,
1662
+ "endIndex": 9
1655
1663
  },
1656
1664
  "releaseTag": "Public",
1657
1665
  "overloadIndex": 1,
@@ -1663,6 +1671,14 @@
1663
1671
  "endIndex": 2
1664
1672
  },
1665
1673
  "isOptional": false
1674
+ },
1675
+ {
1676
+ "parameterName": "viewNumber",
1677
+ "parameterTypeTokenRange": {
1678
+ "startIndex": 3,
1679
+ "endIndex": 4
1680
+ },
1681
+ "isOptional": true
1666
1682
  }
1667
1683
  ],
1668
1684
  "name": "getMoreRows"
@@ -4696,34 +4712,6 @@
4696
4712
  ],
4697
4713
  "name": "dataHandler"
4698
4714
  },
4699
- {
4700
- "kind": "MethodSignature",
4701
- "canonicalReference": "@genesislcap/foundation-comms!Datasource#deinit:member(1)",
4702
- "docComment": "/**\n * Deinitializes the datasource.\n *\n * @remarks\n *\n * This should be called to clean up any resources when the datasource is no longer needed.\n *\n * @public\n */\n",
4703
- "excerptTokens": [
4704
- {
4705
- "kind": "Content",
4706
- "text": "deinit(): "
4707
- },
4708
- {
4709
- "kind": "Content",
4710
- "text": "any"
4711
- },
4712
- {
4713
- "kind": "Content",
4714
- "text": ";"
4715
- }
4716
- ],
4717
- "isOptional": false,
4718
- "returnTypeTokenRange": {
4719
- "startIndex": 1,
4720
- "endIndex": 2
4721
- },
4722
- "releaseTag": "Public",
4723
- "overloadIndex": 1,
4724
- "parameters": [],
4725
- "name": "deinit"
4726
- },
4727
4715
  {
4728
4716
  "kind": "MethodSignature",
4729
4717
  "canonicalReference": "@genesislcap/foundation-comms!Datasource#deleteItem:member(1)",
@@ -4777,7 +4765,7 @@
4777
4765
  {
4778
4766
  "kind": "MethodSignature",
4779
4767
  "canonicalReference": "@genesislcap/foundation-comms!Datasource#destroy:member(1)",
4780
- "docComment": "/**\n * Destroy the datasource.\n *\n * @public\n */\n",
4768
+ "docComment": "/**\n * Destroys the datasource.\n *\n * @remarks\n *\n * This should be called to clean up any resources when the datasource is no longer needed.\n *\n * @public\n */\n",
4781
4769
  "excerptTokens": [
4782
4770
  {
4783
4771
  "kind": "Content",
@@ -4919,7 +4907,7 @@
4919
4907
  {
4920
4908
  "kind": "MethodSignature",
4921
4909
  "canonicalReference": "@genesislcap/foundation-comms!Datasource#init:member(1)",
4922
- "docComment": "/**\n * Initializes the datasource with the given options and fetches metadata if specified.\n *\n * @param options - The options to initialize the datasource with.\n *\n * @param fetchMeta - Optional flag to fetch metadata for the datasource. Defaults to true.\n *\n * @returns A promise that resolves with a boolean indicating whether the initialization was successful.\n *\n * @public\n */\n",
4910
+ "docComment": "/**\n * Initializes the datasource with the given options and fetches metadata if specified.\n *\n * @param options - The options to initialize the datasource with.\n *\n * @param fetchMeta - Optional flag to fetch metadata for the datasource. Defaults to true.\n *\n * @param startStream - Optional flag to start the data stream. Defaults to true.\n *\n * @returns A promise that resolves with a boolean indicating whether the initialization was successful.\n *\n * @public\n */\n",
4923
4911
  "excerptTokens": [
4924
4912
  {
4925
4913
  "kind": "Content",
@@ -4938,6 +4926,14 @@
4938
4926
  "kind": "Content",
4939
4927
  "text": "boolean"
4940
4928
  },
4929
+ {
4930
+ "kind": "Content",
4931
+ "text": ", startStream?: "
4932
+ },
4933
+ {
4934
+ "kind": "Content",
4935
+ "text": "boolean"
4936
+ },
4941
4937
  {
4942
4938
  "kind": "Content",
4943
4939
  "text": "): "
@@ -4958,8 +4954,8 @@
4958
4954
  ],
4959
4955
  "isOptional": false,
4960
4956
  "returnTypeTokenRange": {
4961
- "startIndex": 5,
4962
- "endIndex": 7
4957
+ "startIndex": 7,
4958
+ "endIndex": 9
4963
4959
  },
4964
4960
  "releaseTag": "Public",
4965
4961
  "overloadIndex": 1,
@@ -4979,6 +4975,14 @@
4979
4975
  "endIndex": 4
4980
4976
  },
4981
4977
  "isOptional": true
4978
+ },
4979
+ {
4980
+ "parameterName": "startStream",
4981
+ "parameterTypeTokenRange": {
4982
+ "startIndex": 5,
4983
+ "endIndex": 6
4984
+ },
4985
+ "isOptional": true
4982
4986
  }
4983
4987
  ],
4984
4988
  "name": "init"
@@ -5150,11 +5154,11 @@
5150
5154
  {
5151
5155
  "kind": "MethodSignature",
5152
5156
  "canonicalReference": "@genesislcap/foundation-comms!Datasource#snapshot:member(1)",
5153
- "docComment": "/**\n * Takes a snapshot of the data in the datasource.\n *\n * @param params - Optional parameters for taking the snapshot.\n *\n * @public\n */\n",
5157
+ "docComment": "/**\n * Takes a snapshot of the data in the datasource.\n *\n * @param overrideParams - Optional parameters for taking the snapshot.\n *\n * @public\n */\n",
5154
5158
  "excerptTokens": [
5155
5159
  {
5156
5160
  "kind": "Content",
5157
- "text": "snapshot(params?: "
5161
+ "text": "snapshot(overrideParams?: "
5158
5162
  },
5159
5163
  {
5160
5164
  "kind": "Content",
@@ -5164,9 +5168,23 @@
5164
5168
  "kind": "Content",
5165
5169
  "text": "): "
5166
5170
  },
5171
+ {
5172
+ "kind": "Reference",
5173
+ "text": "Promise",
5174
+ "canonicalReference": "!Promise:interface"
5175
+ },
5167
5176
  {
5168
5177
  "kind": "Content",
5169
- "text": "any"
5178
+ "text": "<"
5179
+ },
5180
+ {
5181
+ "kind": "Reference",
5182
+ "text": "Message",
5183
+ "canonicalReference": "@genesislcap/foundation-comms!Message:type"
5184
+ },
5185
+ {
5186
+ "kind": "Content",
5187
+ "text": ">"
5170
5188
  },
5171
5189
  {
5172
5190
  "kind": "Content",
@@ -5176,13 +5194,13 @@
5176
5194
  "isOptional": false,
5177
5195
  "returnTypeTokenRange": {
5178
5196
  "startIndex": 3,
5179
- "endIndex": 4
5197
+ "endIndex": 7
5180
5198
  },
5181
5199
  "releaseTag": "Public",
5182
5200
  "overloadIndex": 1,
5183
5201
  "parameters": [
5184
5202
  {
5185
- "parameterName": "params",
5203
+ "parameterName": "overrideParams",
5186
5204
  "parameterTypeTokenRange": {
5187
5205
  "startIndex": 1,
5188
5206
  "endIndex": 2
@@ -5209,9 +5227,14 @@
5209
5227
  "kind": "Content",
5210
5228
  "text": "): "
5211
5229
  },
5230
+ {
5231
+ "kind": "Reference",
5232
+ "text": "Promise",
5233
+ "canonicalReference": "!Promise:interface"
5234
+ },
5212
5235
  {
5213
5236
  "kind": "Content",
5214
- "text": "any"
5237
+ "text": "<any[]>"
5215
5238
  },
5216
5239
  {
5217
5240
  "kind": "Content",
@@ -5221,7 +5244,7 @@
5221
5244
  "isOptional": false,
5222
5245
  "returnTypeTokenRange": {
5223
5246
  "startIndex": 3,
5224
- "endIndex": 4
5247
+ "endIndex": 5
5225
5248
  },
5226
5249
  "releaseTag": "Public",
5227
5250
  "overloadIndex": 1,
@@ -5237,6 +5260,39 @@
5237
5260
  ],
5238
5261
  "name": "snapshotFiltered"
5239
5262
  },
5263
+ {
5264
+ "kind": "MethodSignature",
5265
+ "canonicalReference": "@genesislcap/foundation-comms!Datasource#startStream:member(1)",
5266
+ "docComment": "/**\n * Starts the data stream for the datasource.\n *\n * @public\n */\n",
5267
+ "excerptTokens": [
5268
+ {
5269
+ "kind": "Content",
5270
+ "text": "startStream(): "
5271
+ },
5272
+ {
5273
+ "kind": "Reference",
5274
+ "text": "Promise",
5275
+ "canonicalReference": "!Promise:interface"
5276
+ },
5277
+ {
5278
+ "kind": "Content",
5279
+ "text": "<void>"
5280
+ },
5281
+ {
5282
+ "kind": "Content",
5283
+ "text": ";"
5284
+ }
5285
+ ],
5286
+ "isOptional": false,
5287
+ "returnTypeTokenRange": {
5288
+ "startIndex": 1,
5289
+ "endIndex": 3
5290
+ },
5291
+ "releaseTag": "Public",
5292
+ "overloadIndex": 1,
5293
+ "parameters": [],
5294
+ "name": "startStream"
5295
+ },
5240
5296
  {
5241
5297
  "kind": "PropertySignature",
5242
5298
  "canonicalReference": "@genesislcap/foundation-comms!Datasource#status:member",
@@ -5452,7 +5508,7 @@
5452
5508
  {
5453
5509
  "kind": "MethodSignature",
5454
5510
  "canonicalReference": "@genesislcap/foundation-comms!Datasource#validResourceName:member(1)",
5455
- "docComment": "/**\n * Indicates whether the resourceName is valid or not.\n *\n * @public\n */\n",
5511
+ "docComment": "/**\n * Indicates whether the resourceName is valid or not.\n *\n * @deprecated\n *\n * - Please use {@link (GenesisResources:interface).isValidResource} instead.\n *\n * @public\n */\n",
5456
5512
  "excerptTokens": [
5457
5513
  {
5458
5514
  "kind": "Content",
@@ -8999,7 +9055,7 @@
8999
9055
  {
9000
9056
  "kind": "PropertySignature",
9001
9057
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#criteria:member",
9002
- "docComment": "/**\n * The criteria used to filter data in the datasource.\n */\n",
9058
+ "docComment": "/**\n * The criteria used to filter data in the datasource.\n *\n * @remarks\n *\n * Works with both DATASERVER and REQUEST_SERVER resources.\n */\n",
9003
9059
  "excerptTokens": [
9004
9060
  {
9005
9061
  "kind": "Content",
@@ -9026,7 +9082,7 @@
9026
9082
  {
9027
9083
  "kind": "PropertySignature",
9028
9084
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#disablePolling:member",
9029
- "docComment": "/**\n * Whether to disable polling when using request/reply\n */\n",
9085
+ "docComment": "/**\n * Whether to disable polling when using request/reply\n *\n * @remarks\n *\n * Only works with REQUEST_SERVER resources.\n */\n",
9030
9086
  "excerptTokens": [
9031
9087
  {
9032
9088
  "kind": "Content",
@@ -9053,7 +9109,7 @@
9053
9109
  {
9054
9110
  "kind": "PropertySignature",
9055
9111
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#fields:member",
9056
- "docComment": "/**\n * The fields to include in the returned data.\n */\n",
9112
+ "docComment": "/**\n * The fields to include in the returned data.\n *\n * @remarks\n *\n * Only works with DATASERVER resources.\n */\n",
9057
9113
  "excerptTokens": [
9058
9114
  {
9059
9115
  "kind": "Content",
@@ -9107,7 +9163,7 @@
9107
9163
  {
9108
9164
  "kind": "PropertySignature",
9109
9165
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#maxRows:member",
9110
- "docComment": "/**\n * The maximum number of rows to return from the datasource.\n */\n",
9166
+ "docComment": "/**\n * The maximum number of rows to return from the datasource.\n *\n * @remarks\n *\n * Works with both DATASERVER and REQUEST_SERVER resources.\n */\n",
9111
9167
  "excerptTokens": [
9112
9168
  {
9113
9169
  "kind": "Content",
@@ -9134,7 +9190,7 @@
9134
9190
  {
9135
9191
  "kind": "PropertySignature",
9136
9192
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#maxView:member",
9137
- "docComment": "/**\n * The maximum number of rows to track as part of a client \"view\"\n */\n",
9193
+ "docComment": "/**\n * The maximum number of rows to track as part of a client \"view\"\n *\n * @remarks\n *\n * Only works with DATASERVER resources.\n */\n",
9138
9194
  "excerptTokens": [
9139
9195
  {
9140
9196
  "kind": "Content",
@@ -9161,7 +9217,7 @@
9161
9217
  {
9162
9218
  "kind": "PropertySignature",
9163
9219
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#movingView:member",
9164
- "docComment": "/**\n * Defines the behaviour of the client view when new rows are received in real time.\n */\n",
9220
+ "docComment": "/**\n * Defines the behaviour of the client view when new rows are received in real time.\n *\n * @remarks\n *\n * Only works with DATASERVER resources.\n */\n",
9165
9221
  "excerptTokens": [
9166
9222
  {
9167
9223
  "kind": "Content",
@@ -9188,7 +9244,7 @@
9188
9244
  {
9189
9245
  "kind": "PropertySignature",
9190
9246
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#orderBy:member",
9191
- "docComment": "/**\n * The field to use for sorting the data.\n */\n",
9247
+ "docComment": "/**\n * The field to use for sorting the data.\n *\n * @remarks\n *\n * Only works with DATASERVER.\n */\n",
9192
9248
  "excerptTokens": [
9193
9249
  {
9194
9250
  "kind": "Content",
@@ -9242,7 +9298,7 @@
9242
9298
  {
9243
9299
  "kind": "PropertySignature",
9244
9300
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#request:member",
9245
- "docComment": "/**\n * The request to send to the server.\n */\n",
9301
+ "docComment": "/**\n * The request to send to the server.\n *\n * @remarks\n *\n * Only works with REQUEST_SERVER resources.\n */\n",
9246
9302
  "excerptTokens": [
9247
9303
  {
9248
9304
  "kind": "Content",
@@ -9266,6 +9322,33 @@
9266
9322
  "endIndex": 2
9267
9323
  }
9268
9324
  },
9325
+ {
9326
+ "kind": "PropertySignature",
9327
+ "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#requestAutoSetup:member",
9328
+ "docComment": "/**\n * Whether the Datasource service will setup RQUEST object based on metadata.\n *\n * @remarks\n *\n * Only works with REQUEST_SERVER resources.\n */\n",
9329
+ "excerptTokens": [
9330
+ {
9331
+ "kind": "Content",
9332
+ "text": "requestAutoSetup?: "
9333
+ },
9334
+ {
9335
+ "kind": "Content",
9336
+ "text": "boolean"
9337
+ },
9338
+ {
9339
+ "kind": "Content",
9340
+ "text": ";"
9341
+ }
9342
+ ],
9343
+ "isReadonly": false,
9344
+ "isOptional": true,
9345
+ "releaseTag": "Public",
9346
+ "name": "requestAutoSetup",
9347
+ "propertyTypeTokenRange": {
9348
+ "startIndex": 1,
9349
+ "endIndex": 2
9350
+ }
9351
+ },
9269
9352
  {
9270
9353
  "kind": "PropertySignature",
9271
9354
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#resourceName:member",
@@ -9296,7 +9379,7 @@
9296
9379
  {
9297
9380
  "kind": "PropertySignature",
9298
9381
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#reverse:member",
9299
- "docComment": "/**\n * Whether to return the data in reverse order or not.\n */\n",
9382
+ "docComment": "/**\n * Whether to return the data in reverse order or not.\n *\n * @remarks\n *\n * Only works with DATASERVER resources.\n */\n",
9300
9383
  "excerptTokens": [
9301
9384
  {
9302
9385
  "kind": "Content",
@@ -9319,6 +9402,33 @@
9319
9402
  "startIndex": 1,
9320
9403
  "endIndex": 2
9321
9404
  }
9405
+ },
9406
+ {
9407
+ "kind": "PropertySignature",
9408
+ "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#viewNumber:member",
9409
+ "docComment": "/**\n * The current page/\"view\" number being displayed.\n *\n * @remarks\n *\n * Works with both DATASERVER and REQUEST_SERVER resources.\n */\n",
9410
+ "excerptTokens": [
9411
+ {
9412
+ "kind": "Content",
9413
+ "text": "viewNumber?: "
9414
+ },
9415
+ {
9416
+ "kind": "Content",
9417
+ "text": "number"
9418
+ },
9419
+ {
9420
+ "kind": "Content",
9421
+ "text": ";"
9422
+ }
9423
+ ],
9424
+ "isReadonly": false,
9425
+ "isOptional": true,
9426
+ "releaseTag": "Public",
9427
+ "name": "viewNumber",
9428
+ "propertyTypeTokenRange": {
9429
+ "startIndex": 1,
9430
+ "endIndex": 2
9431
+ }
9322
9432
  }
9323
9433
  ],
9324
9434
  "extendsTokenRanges": []
@@ -10767,6 +10877,14 @@
10767
10877
  "kind": "Content",
10768
10878
  "text": "string"
10769
10879
  },
10880
+ {
10881
+ "kind": "Content",
10882
+ "text": ", viewNumber?: "
10883
+ },
10884
+ {
10885
+ "kind": "Content",
10886
+ "text": "number"
10887
+ },
10770
10888
  {
10771
10889
  "kind": "Content",
10772
10890
  "text": "): "
@@ -10796,8 +10914,8 @@
10796
10914
  ],
10797
10915
  "isStatic": false,
10798
10916
  "returnTypeTokenRange": {
10799
- "startIndex": 3,
10800
- "endIndex": 7
10917
+ "startIndex": 5,
10918
+ "endIndex": 9
10801
10919
  },
10802
10920
  "releaseTag": "Public",
10803
10921
  "isProtected": false,
@@ -10810,6 +10928,14 @@
10810
10928
  "endIndex": 2
10811
10929
  },
10812
10930
  "isOptional": false
10931
+ },
10932
+ {
10933
+ "parameterName": "viewNumber",
10934
+ "parameterTypeTokenRange": {
10935
+ "startIndex": 3,
10936
+ "endIndex": 4
10937
+ },
10938
+ "isOptional": true
10813
10939
  }
10814
10940
  ],
10815
10941
  "isOptional": false,
@@ -13892,37 +14018,6 @@
13892
14018
  "isProtected": true,
13893
14019
  "isAbstract": false
13894
14020
  },
13895
- {
13896
- "kind": "Method",
13897
- "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#deinit:member(1)",
13898
- "docComment": "",
13899
- "excerptTokens": [
13900
- {
13901
- "kind": "Content",
13902
- "text": "deinit(): "
13903
- },
13904
- {
13905
- "kind": "Content",
13906
- "text": "void"
13907
- },
13908
- {
13909
- "kind": "Content",
13910
- "text": ";"
13911
- }
13912
- ],
13913
- "isStatic": false,
13914
- "returnTypeTokenRange": {
13915
- "startIndex": 1,
13916
- "endIndex": 2
13917
- },
13918
- "releaseTag": "Public",
13919
- "isProtected": false,
13920
- "overloadIndex": 1,
13921
- "parameters": [],
13922
- "isOptional": false,
13923
- "isAbstract": false,
13924
- "name": "deinit"
13925
- },
13926
14021
  {
13927
14022
  "kind": "Method",
13928
14023
  "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#destroy:member(1)",
@@ -14094,6 +14189,14 @@
14094
14189
  "kind": "Content",
14095
14190
  "text": "boolean"
14096
14191
  },
14192
+ {
14193
+ "kind": "Content",
14194
+ "text": ", startStream?: "
14195
+ },
14196
+ {
14197
+ "kind": "Content",
14198
+ "text": "boolean"
14199
+ },
14097
14200
  {
14098
14201
  "kind": "Content",
14099
14202
  "text": "): "
@@ -14114,8 +14217,8 @@
14114
14217
  ],
14115
14218
  "isStatic": false,
14116
14219
  "returnTypeTokenRange": {
14117
- "startIndex": 5,
14118
- "endIndex": 7
14220
+ "startIndex": 7,
14221
+ "endIndex": 9
14119
14222
  },
14120
14223
  "releaseTag": "Public",
14121
14224
  "isProtected": false,
@@ -14136,6 +14239,14 @@
14136
14239
  "endIndex": 4
14137
14240
  },
14138
14241
  "isOptional": true
14242
+ },
14243
+ {
14244
+ "parameterName": "startStream",
14245
+ "parameterTypeTokenRange": {
14246
+ "startIndex": 5,
14247
+ "endIndex": 6
14248
+ },
14249
+ "isOptional": true
14139
14250
  }
14140
14251
  ],
14141
14252
  "isOptional": false,
@@ -14402,7 +14513,15 @@
14402
14513
  "excerptTokens": [
14403
14514
  {
14404
14515
  "kind": "Content",
14405
- "text": "snapshot(): "
14516
+ "text": "snapshot(overrideParams?: "
14517
+ },
14518
+ {
14519
+ "kind": "Content",
14520
+ "text": "any"
14521
+ },
14522
+ {
14523
+ "kind": "Content",
14524
+ "text": "): "
14406
14525
  },
14407
14526
  {
14408
14527
  "kind": "Reference",
@@ -14429,13 +14548,22 @@
14429
14548
  ],
14430
14549
  "isStatic": false,
14431
14550
  "returnTypeTokenRange": {
14432
- "startIndex": 1,
14433
- "endIndex": 5
14551
+ "startIndex": 3,
14552
+ "endIndex": 7
14434
14553
  },
14435
14554
  "releaseTag": "Public",
14436
14555
  "isProtected": false,
14437
14556
  "overloadIndex": 1,
14438
- "parameters": [],
14557
+ "parameters": [
14558
+ {
14559
+ "parameterName": "overrideParams",
14560
+ "parameterTypeTokenRange": {
14561
+ "startIndex": 1,
14562
+ "endIndex": 2
14563
+ },
14564
+ "isOptional": true
14565
+ }
14566
+ ],
14439
14567
  "isOptional": false,
14440
14568
  "isAbstract": false,
14441
14569
  "name": "snapshot"
@@ -14493,6 +14621,72 @@
14493
14621
  "isAbstract": false,
14494
14622
  "name": "snapshotFiltered"
14495
14623
  },
14624
+ {
14625
+ "kind": "Method",
14626
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#startStream:member(1)",
14627
+ "docComment": "",
14628
+ "excerptTokens": [
14629
+ {
14630
+ "kind": "Content",
14631
+ "text": "startStream(): "
14632
+ },
14633
+ {
14634
+ "kind": "Reference",
14635
+ "text": "Promise",
14636
+ "canonicalReference": "!Promise:interface"
14637
+ },
14638
+ {
14639
+ "kind": "Content",
14640
+ "text": "<void>"
14641
+ },
14642
+ {
14643
+ "kind": "Content",
14644
+ "text": ";"
14645
+ }
14646
+ ],
14647
+ "isStatic": false,
14648
+ "returnTypeTokenRange": {
14649
+ "startIndex": 1,
14650
+ "endIndex": 3
14651
+ },
14652
+ "releaseTag": "Public",
14653
+ "isProtected": false,
14654
+ "overloadIndex": 1,
14655
+ "parameters": [],
14656
+ "isOptional": false,
14657
+ "isAbstract": false,
14658
+ "name": "startStream"
14659
+ },
14660
+ {
14661
+ "kind": "Property",
14662
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#startStreamRequired:member",
14663
+ "docComment": "/**\n * {@inheritDoc DatasourceMetadata.startStream}\n */\n",
14664
+ "excerptTokens": [
14665
+ {
14666
+ "kind": "Content",
14667
+ "text": "startStreamRequired: "
14668
+ },
14669
+ {
14670
+ "kind": "Content",
14671
+ "text": "boolean"
14672
+ },
14673
+ {
14674
+ "kind": "Content",
14675
+ "text": ";"
14676
+ }
14677
+ ],
14678
+ "isReadonly": false,
14679
+ "isOptional": false,
14680
+ "releaseTag": "Public",
14681
+ "name": "startStreamRequired",
14682
+ "propertyTypeTokenRange": {
14683
+ "startIndex": 1,
14684
+ "endIndex": 2
14685
+ },
14686
+ "isStatic": false,
14687
+ "isProtected": false,
14688
+ "isAbstract": false
14689
+ },
14496
14690
  {
14497
14691
  "kind": "Property",
14498
14692
  "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#status:member",
@@ -18091,6 +18285,14 @@
18091
18285
  "kind": "Content",
18092
18286
  "text": "string"
18093
18287
  },
18288
+ {
18289
+ "kind": "Content",
18290
+ "text": ", viewNumber?: "
18291
+ },
18292
+ {
18293
+ "kind": "Content",
18294
+ "text": "number"
18295
+ },
18094
18296
  {
18095
18297
  "kind": "Content",
18096
18298
  "text": "): "
@@ -18100,6 +18302,19 @@
18100
18302
  "text": "Message",
18101
18303
  "canonicalReference": "@genesislcap/foundation-comms!Message:type"
18102
18304
  },
18305
+ {
18306
+ "kind": "Content",
18307
+ "text": "<"
18308
+ },
18309
+ {
18310
+ "kind": "Reference",
18311
+ "text": "MessageDetails.MoreRows",
18312
+ "canonicalReference": "@genesislcap/foundation-comms!MessageDetails.MoreRows:type"
18313
+ },
18314
+ {
18315
+ "kind": "Content",
18316
+ "text": ">"
18317
+ },
18103
18318
  {
18104
18319
  "kind": "Content",
18105
18320
  "text": ";"
@@ -18107,8 +18322,8 @@
18107
18322
  ],
18108
18323
  "isStatic": false,
18109
18324
  "returnTypeTokenRange": {
18110
- "startIndex": 3,
18111
- "endIndex": 4
18325
+ "startIndex": 5,
18326
+ "endIndex": 9
18112
18327
  },
18113
18328
  "releaseTag": "Public",
18114
18329
  "isProtected": false,
@@ -18121,6 +18336,14 @@
18121
18336
  "endIndex": 2
18122
18337
  },
18123
18338
  "isOptional": false
18339
+ },
18340
+ {
18341
+ "parameterName": "viewNumber",
18342
+ "parameterTypeTokenRange": {
18343
+ "startIndex": 3,
18344
+ "endIndex": 4
18345
+ },
18346
+ "isOptional": true
18124
18347
  }
18125
18348
  ],
18126
18349
  "isOptional": false,
@@ -25138,6 +25361,14 @@
25138
25361
  "kind": "Content",
25139
25362
  "text": "string"
25140
25363
  },
25364
+ {
25365
+ "kind": "Content",
25366
+ "text": ", viewNumber?: "
25367
+ },
25368
+ {
25369
+ "kind": "Content",
25370
+ "text": "number"
25371
+ },
25141
25372
  {
25142
25373
  "kind": "Content",
25143
25374
  "text": "): "
@@ -25147,6 +25378,19 @@
25147
25378
  "text": "Message",
25148
25379
  "canonicalReference": "@genesislcap/foundation-comms!Message:type"
25149
25380
  },
25381
+ {
25382
+ "kind": "Content",
25383
+ "text": "<"
25384
+ },
25385
+ {
25386
+ "kind": "Reference",
25387
+ "text": "MessageDetails.MoreRows",
25388
+ "canonicalReference": "@genesislcap/foundation-comms!MessageDetails.MoreRows:type"
25389
+ },
25390
+ {
25391
+ "kind": "Content",
25392
+ "text": ">"
25393
+ },
25150
25394
  {
25151
25395
  "kind": "Content",
25152
25396
  "text": ";"
@@ -25154,8 +25398,8 @@
25154
25398
  ],
25155
25399
  "isOptional": false,
25156
25400
  "returnTypeTokenRange": {
25157
- "startIndex": 3,
25158
- "endIndex": 4
25401
+ "startIndex": 5,
25402
+ "endIndex": 9
25159
25403
  },
25160
25404
  "releaseTag": "Public",
25161
25405
  "overloadIndex": 1,
@@ -25167,6 +25411,14 @@
25167
25411
  "endIndex": 2
25168
25412
  },
25169
25413
  "isOptional": false
25414
+ },
25415
+ {
25416
+ "parameterName": "viewNumber",
25417
+ "parameterTypeTokenRange": {
25418
+ "startIndex": 3,
25419
+ "endIndex": 4
25420
+ },
25421
+ "isOptional": true
25170
25422
  }
25171
25423
  ],
25172
25424
  "name": "createMoreRowsMessage"
@@ -25239,8 +25491,9 @@
25239
25491
  "text": ", params?: "
25240
25492
  },
25241
25493
  {
25242
- "kind": "Content",
25243
- "text": "any"
25494
+ "kind": "Reference",
25495
+ "text": "RequestParams",
25496
+ "canonicalReference": "@genesislcap/foundation-comms!RequestParams:type"
25244
25497
  },
25245
25498
  {
25246
25499
  "kind": "Content",
@@ -25778,7 +26031,7 @@
25778
26031
  },
25779
26032
  {
25780
26033
  "kind": "Content",
25781
- "text": "{\n SOURCE_REF: string;\n }"
26034
+ "text": "{\n SOURCE_REF: string;\n VIEW_NUMBER?: number;\n }"
25782
26035
  },
25783
26036
  {
25784
26037
  "kind": "Content",
@@ -26335,7 +26588,16 @@
26335
26588
  },
26336
26589
  {
26337
26590
  "kind": "Content",
26338
- "text": "{\n FIELD?: "
26591
+ "text": "{\n DEFINITIONS?: "
26592
+ },
26593
+ {
26594
+ "kind": "Reference",
26595
+ "text": "Record",
26596
+ "canonicalReference": "!Record:type"
26597
+ },
26598
+ {
26599
+ "kind": "Content",
26600
+ "text": "<string, any>;\n DESCRIPTION?: string;\n FIELD?: "
26339
26601
  },
26340
26602
  {
26341
26603
  "kind": "Reference",
@@ -26344,16 +26606,16 @@
26344
26606
  },
26345
26607
  {
26346
26608
  "kind": "Content",
26347
- "text": "[];\n INDEXES?: "
26609
+ "text": "[];\n REPLY?: "
26348
26610
  },
26349
26611
  {
26350
26612
  "kind": "Reference",
26351
- "text": "IndexDetail",
26352
- "canonicalReference": "@genesislcap/foundation-comms!IndexDetail:type"
26613
+ "text": "ReplyDetail",
26614
+ "canonicalReference": "@genesislcap/foundation-comms!ReplyDetail:type"
26353
26615
  },
26354
26616
  {
26355
26617
  "kind": "Content",
26356
- "text": "[];\n REPLY_FIELD?: "
26618
+ "text": ";\n REPLY_FIELD?: "
26357
26619
  },
26358
26620
  {
26359
26621
  "kind": "Reference",
@@ -26371,7 +26633,16 @@
26371
26633
  },
26372
26634
  {
26373
26635
  "kind": "Content",
26374
- "text": "[];\n NAME?: string;\n TYPE?: string;\n ERROR?: string;\n}"
26636
+ "text": "[];\n NAME?: string;\n TYPE?: string;\n INDEXES?: "
26637
+ },
26638
+ {
26639
+ "kind": "Reference",
26640
+ "text": "IndexDetail",
26641
+ "canonicalReference": "@genesislcap/foundation-comms!IndexDetail:type"
26642
+ },
26643
+ {
26644
+ "kind": "Content",
26645
+ "text": "[];\n ERROR?: string;\n}"
26375
26646
  },
26376
26647
  {
26377
26648
  "kind": "Content",
@@ -26383,7 +26654,7 @@
26383
26654
  "name": "Metadata",
26384
26655
  "typeTokenRange": {
26385
26656
  "startIndex": 1,
26386
- "endIndex": 10
26657
+ "endIndex": 14
26387
26658
  }
26388
26659
  },
26389
26660
  {
@@ -26609,7 +26880,7 @@
26609
26880
  },
26610
26881
  {
26611
26882
  "kind": "Content",
26612
- "text": "{\n NAME: string;\n TYPE: string;\n VALID_VALUES?: string;\n READ_ONLY?: boolean;\n OPTIONAL?: boolean;\n UI_LABEL?: string;\n}"
26883
+ "text": "{\n NAME: string;\n TYPE: string;\n DESCRIPTION?: string;\n JSON_TYPE?: string;\n VALID_VALUES?: string;\n READ_ONLY?: boolean;\n OPTIONAL?: boolean;\n NULLABLE?: boolean;\n UI_LABEL?: string;\n}"
26613
26884
  },
26614
26885
  {
26615
26886
  "kind": "Content",
@@ -27962,6 +28233,76 @@
27962
28233
  "endIndex": 2
27963
28234
  }
27964
28235
  },
28236
+ {
28237
+ "kind": "TypeAlias",
28238
+ "canonicalReference": "@genesislcap/foundation-comms!ReplyDetail:type",
28239
+ "docComment": "/**\n * Reply Detail definition.\n *\n * @public\n */\n",
28240
+ "excerptTokens": [
28241
+ {
28242
+ "kind": "Content",
28243
+ "text": "export type ReplyDetail = "
28244
+ },
28245
+ {
28246
+ "kind": "Content",
28247
+ "text": "{\n DEFINITIONS?: "
28248
+ },
28249
+ {
28250
+ "kind": "Reference",
28251
+ "text": "Record",
28252
+ "canonicalReference": "!Record:type"
28253
+ },
28254
+ {
28255
+ "kind": "Content",
28256
+ "text": "<string, any>;\n DESCRIPTION?: string;\n FIELD: "
28257
+ },
28258
+ {
28259
+ "kind": "Reference",
28260
+ "text": "MetadataDetail",
28261
+ "canonicalReference": "@genesislcap/foundation-comms!MetadataDetail:type"
28262
+ },
28263
+ {
28264
+ "kind": "Content",
28265
+ "text": "[];\n NAME: string;\n [key: string]: any;\n}"
28266
+ },
28267
+ {
28268
+ "kind": "Content",
28269
+ "text": ";"
28270
+ }
28271
+ ],
28272
+ "fileUrlPath": "src/metadata/metadata.types.ts",
28273
+ "releaseTag": "Public",
28274
+ "name": "ReplyDetail",
28275
+ "typeTokenRange": {
28276
+ "startIndex": 1,
28277
+ "endIndex": 6
28278
+ }
28279
+ },
28280
+ {
28281
+ "kind": "TypeAlias",
28282
+ "canonicalReference": "@genesislcap/foundation-comms!RequestDetailsParam:type",
28283
+ "docComment": "/**\n * @public\n */\n",
28284
+ "excerptTokens": [
28285
+ {
28286
+ "kind": "Content",
28287
+ "text": "export type RequestDetailsParam = "
28288
+ },
28289
+ {
28290
+ "kind": "Content",
28291
+ "text": "{\n MAX_ROWS?: number;\n CRITERIA_MATCH?: string;\n}"
28292
+ },
28293
+ {
28294
+ "kind": "Content",
28295
+ "text": ";"
28296
+ }
28297
+ ],
28298
+ "fileUrlPath": "src/connect/message.ts",
28299
+ "releaseTag": "Public",
28300
+ "name": "RequestDetailsParam",
28301
+ "typeTokenRange": {
28302
+ "startIndex": 1,
28303
+ "endIndex": 2
28304
+ }
28305
+ },
27965
28306
  {
27966
28307
  "kind": "TypeAlias",
27967
28308
  "canonicalReference": "@genesislcap/foundation-comms!RequestParams:type",
@@ -27973,7 +28314,16 @@
27973
28314
  },
27974
28315
  {
27975
28316
  "kind": "Content",
27976
- "text": "{\n DETAILS?: any;\n REQUEST?: any;\n}"
28317
+ "text": "{\n DETAILS?: "
28318
+ },
28319
+ {
28320
+ "kind": "Reference",
28321
+ "text": "RequestDetailsParam",
28322
+ "canonicalReference": "@genesislcap/foundation-comms!RequestDetailsParam:type"
28323
+ },
28324
+ {
28325
+ "kind": "Content",
28326
+ "text": " | any;\n REQUEST?: any;\n}"
27977
28327
  },
27978
28328
  {
27979
28329
  "kind": "Content",
@@ -27985,7 +28335,7 @@
27985
28335
  "name": "RequestParams",
27986
28336
  "typeTokenRange": {
27987
28337
  "startIndex": 1,
27988
- "endIndex": 2
28338
+ "endIndex": 4
27989
28339
  }
27990
28340
  },
27991
28341
  {
@@ -27999,7 +28349,7 @@
27999
28349
  },
28000
28350
  {
28001
28351
  "kind": "Content",
28002
- "text": "{\n SOURCE_REF?: string;\n REPLY: any[];\n MESSAGE_TYPE?: string;\n}"
28352
+ "text": "{\n SOURCE_REF?: string;\n REPLY: any[];\n MESSAGE_TYPE?: string;\n MORE_ROWS?: boolean;\n NEXT_VIEW?: number;\n PARAMETRIC_TYPE?: string;\n ROWS_COUNT?: number;\n SEQUENCE_ID?: number;\n}"
28003
28353
  },
28004
28354
  {
28005
28355
  "kind": "Content",