@genesislcap/foundation-comms 14.201.0 → 14.202.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (66) hide show
  1. package/dist/dts/connect/connect.d.ts +4 -3
  2. package/dist/dts/connect/connect.d.ts.map +1 -1
  3. package/dist/dts/connect/message.d.ts +14 -5
  4. package/dist/dts/connect/message.d.ts.map +1 -1
  5. package/dist/dts/datasource/datasource.d.ts +21 -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 +4 -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 +63 -32
  16. package/dist/esm/metadata/metadata.utils.js +2 -1
  17. package/dist/esm/testing/mocks/datasource/datasource.js +14 -2
  18. package/dist/foundation-comms.api.json +510 -93
  19. package/dist/foundation-comms.d.ts +105 -44
  20. package/docs/api/foundation-comms.connect.getmorerows.md +3 -2
  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.datasourcemetadata.customrequestfields.md +11 -0
  30. package/docs/api/foundation-comms.datasourcemetadata.md +1 -0
  31. package/docs/api/foundation-comms.datasourceoptions.criteria.md +5 -0
  32. package/docs/api/foundation-comms.datasourceoptions.disablepolling.md +5 -0
  33. package/docs/api/foundation-comms.datasourceoptions.fields.md +5 -0
  34. package/docs/api/foundation-comms.datasourceoptions.maxrows.md +5 -0
  35. package/docs/api/foundation-comms.datasourceoptions.maxview.md +5 -0
  36. package/docs/api/foundation-comms.datasourceoptions.md +2 -0
  37. package/docs/api/foundation-comms.datasourceoptions.movingview.md +5 -0
  38. package/docs/api/foundation-comms.datasourceoptions.orderby.md +5 -0
  39. package/docs/api/foundation-comms.datasourceoptions.request.md +5 -0
  40. package/docs/api/foundation-comms.datasourceoptions.requestautosetup.md +18 -0
  41. package/docs/api/foundation-comms.datasourceoptions.reverse.md +5 -0
  42. package/docs/api/foundation-comms.datasourceoptions.viewnumber.md +18 -0
  43. package/docs/api/foundation-comms.defaultconnect.getmorerows.md +2 -1
  44. package/docs/api/foundation-comms.defaultconnect.md +1 -1
  45. package/docs/api/foundation-comms.defaultdatasource.customrequestfields.md +12 -0
  46. package/docs/api/foundation-comms.defaultdatasource.destroy.md +5 -1
  47. package/docs/api/foundation-comms.defaultdatasource.init.md +2 -1
  48. package/docs/api/foundation-comms.defaultdatasource.md +6 -4
  49. package/docs/api/foundation-comms.defaultdatasource.snapshot.md +8 -1
  50. package/docs/api/{foundation-comms.defaultdatasource.deinit.md → foundation-comms.defaultdatasource.startstream.md} +4 -4
  51. package/docs/api/foundation-comms.defaultdatasource.startstreamrequired.md +12 -0
  52. package/docs/api/foundation-comms.defaultmessagebuilder.createmorerowsmessage.md +3 -2
  53. package/docs/api/foundation-comms.defaultmessagebuilder.md +1 -1
  54. package/docs/api/foundation-comms.md +2 -0
  55. package/docs/api/foundation-comms.messagebuilder.createmorerowsmessage.md +4 -3
  56. package/docs/api/foundation-comms.messagebuilder.createrequestmessage.md +2 -2
  57. package/docs/api/foundation-comms.messagebuilder.md +1 -1
  58. package/docs/api/foundation-comms.messagedetails.morerows.md +1 -0
  59. package/docs/api/foundation-comms.metadata.md +5 -2
  60. package/docs/api/foundation-comms.metadatadetail.md +3 -0
  61. package/docs/api/foundation-comms.replydetail.md +21 -0
  62. package/docs/api/foundation-comms.requestdetailsparam.md +15 -0
  63. package/docs/api/foundation-comms.requestparams.md +3 -1
  64. package/docs/api/foundation-comms.requestserverresult.md +5 -0
  65. package/docs/api-report.md +59 -17
  66. package/package.json +13 -13
@@ -1611,7 +1611,7 @@
1611
1611
  {
1612
1612
  "kind": "MethodSignature",
1613
1613
  "canonicalReference": "@genesislcap/foundation-comms!Connect#getMoreRows:member(1)",
1614
- "docComment": "/**\n * Requests additional rows of data for the specified source reference.\n *\n * @param sourceRef - The source reference to request more rows for.\n *\n * @returns A promise that resolves with the additional rows of data.\n *\n * @public\n */\n",
1614
+ "docComment": "/**\n * Requests additional rows of data for the specified source reference.\n *\n * @param sourceRef - An existing source reference to request more rows for.\n *\n * @param viewNumber - The specific view number to request more rows for. Default: previous view number result + 1.\n *\n * @returns A promise that resolves with the additional rows of data.\n *\n * @public\n */\n",
1615
1615
  "excerptTokens": [
1616
1616
  {
1617
1617
  "kind": "Content",
@@ -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",
@@ -8855,6 +8911,38 @@
8855
8911
  "endIndex": 3
8856
8912
  }
8857
8913
  },
8914
+ {
8915
+ "kind": "PropertySignature",
8916
+ "canonicalReference": "@genesislcap/foundation-comms!DatasourceMetadata#customRequestFields:member",
8917
+ "docComment": "",
8918
+ "excerptTokens": [
8919
+ {
8920
+ "kind": "Content",
8921
+ "text": "readonly customRequestFields: "
8922
+ },
8923
+ {
8924
+ "kind": "Reference",
8925
+ "text": "MetadataDetail",
8926
+ "canonicalReference": "@genesislcap/foundation-comms!MetadataDetail:type"
8927
+ },
8928
+ {
8929
+ "kind": "Content",
8930
+ "text": "[]"
8931
+ },
8932
+ {
8933
+ "kind": "Content",
8934
+ "text": ";"
8935
+ }
8936
+ ],
8937
+ "isReadonly": true,
8938
+ "isOptional": false,
8939
+ "releaseTag": "Public",
8940
+ "name": "customRequestFields",
8941
+ "propertyTypeTokenRange": {
8942
+ "startIndex": 1,
8943
+ "endIndex": 3
8944
+ }
8945
+ },
8858
8946
  {
8859
8947
  "kind": "PropertySignature",
8860
8948
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceMetadata#fetchMetadataRequired:member",
@@ -8999,7 +9087,7 @@
8999
9087
  {
9000
9088
  "kind": "PropertySignature",
9001
9089
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#criteria:member",
9002
- "docComment": "/**\n * The criteria used to filter data in the datasource.\n */\n",
9090
+ "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
9091
  "excerptTokens": [
9004
9092
  {
9005
9093
  "kind": "Content",
@@ -9026,7 +9114,7 @@
9026
9114
  {
9027
9115
  "kind": "PropertySignature",
9028
9116
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#disablePolling:member",
9029
- "docComment": "/**\n * Whether to disable polling when using request/reply\n */\n",
9117
+ "docComment": "/**\n * Whether to disable polling when using request/reply\n *\n * @remarks\n *\n * Only works with REQUEST_SERVER resources.\n */\n",
9030
9118
  "excerptTokens": [
9031
9119
  {
9032
9120
  "kind": "Content",
@@ -9053,7 +9141,7 @@
9053
9141
  {
9054
9142
  "kind": "PropertySignature",
9055
9143
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#fields:member",
9056
- "docComment": "/**\n * The fields to include in the returned data.\n */\n",
9144
+ "docComment": "/**\n * The fields to include in the returned data.\n *\n * @remarks\n *\n * Only works with DATASERVER resources.\n */\n",
9057
9145
  "excerptTokens": [
9058
9146
  {
9059
9147
  "kind": "Content",
@@ -9107,7 +9195,7 @@
9107
9195
  {
9108
9196
  "kind": "PropertySignature",
9109
9197
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#maxRows:member",
9110
- "docComment": "/**\n * The maximum number of rows to return from the datasource.\n */\n",
9198
+ "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
9199
  "excerptTokens": [
9112
9200
  {
9113
9201
  "kind": "Content",
@@ -9134,7 +9222,7 @@
9134
9222
  {
9135
9223
  "kind": "PropertySignature",
9136
9224
  "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",
9225
+ "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
9226
  "excerptTokens": [
9139
9227
  {
9140
9228
  "kind": "Content",
@@ -9161,7 +9249,7 @@
9161
9249
  {
9162
9250
  "kind": "PropertySignature",
9163
9251
  "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",
9252
+ "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
9253
  "excerptTokens": [
9166
9254
  {
9167
9255
  "kind": "Content",
@@ -9188,7 +9276,7 @@
9188
9276
  {
9189
9277
  "kind": "PropertySignature",
9190
9278
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#orderBy:member",
9191
- "docComment": "/**\n * The field to use for sorting the data.\n */\n",
9279
+ "docComment": "/**\n * The field to use for sorting the data.\n *\n * @remarks\n *\n * Only works with DATASERVER.\n */\n",
9192
9280
  "excerptTokens": [
9193
9281
  {
9194
9282
  "kind": "Content",
@@ -9242,7 +9330,7 @@
9242
9330
  {
9243
9331
  "kind": "PropertySignature",
9244
9332
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#request:member",
9245
- "docComment": "/**\n * The request to send to the server.\n */\n",
9333
+ "docComment": "/**\n * The request to send to the server.\n *\n * @remarks\n *\n * Only works with REQUEST_SERVER resources.\n */\n",
9246
9334
  "excerptTokens": [
9247
9335
  {
9248
9336
  "kind": "Content",
@@ -9266,6 +9354,33 @@
9266
9354
  "endIndex": 2
9267
9355
  }
9268
9356
  },
9357
+ {
9358
+ "kind": "PropertySignature",
9359
+ "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#requestAutoSetup:member",
9360
+ "docComment": "/**\n * Whether the Datasource service will setup RQUEST object based on metadata.\n *\n * @remarks\n *\n * Default is `true`. Only works with REQUEST_SERVER resources.\n */\n",
9361
+ "excerptTokens": [
9362
+ {
9363
+ "kind": "Content",
9364
+ "text": "requestAutoSetup?: "
9365
+ },
9366
+ {
9367
+ "kind": "Content",
9368
+ "text": "boolean"
9369
+ },
9370
+ {
9371
+ "kind": "Content",
9372
+ "text": ";"
9373
+ }
9374
+ ],
9375
+ "isReadonly": false,
9376
+ "isOptional": true,
9377
+ "releaseTag": "Public",
9378
+ "name": "requestAutoSetup",
9379
+ "propertyTypeTokenRange": {
9380
+ "startIndex": 1,
9381
+ "endIndex": 2
9382
+ }
9383
+ },
9269
9384
  {
9270
9385
  "kind": "PropertySignature",
9271
9386
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#resourceName:member",
@@ -9296,7 +9411,7 @@
9296
9411
  {
9297
9412
  "kind": "PropertySignature",
9298
9413
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#reverse:member",
9299
- "docComment": "/**\n * Whether to return the data in reverse order or not.\n */\n",
9414
+ "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
9415
  "excerptTokens": [
9301
9416
  {
9302
9417
  "kind": "Content",
@@ -9319,6 +9434,33 @@
9319
9434
  "startIndex": 1,
9320
9435
  "endIndex": 2
9321
9436
  }
9437
+ },
9438
+ {
9439
+ "kind": "PropertySignature",
9440
+ "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#viewNumber:member",
9441
+ "docComment": "/**\n * The current page/\"view\" number being displayed.\n *\n * @remarks\n *\n * Works with both DATASERVER and REQUEST_SERVER resources.\n */\n",
9442
+ "excerptTokens": [
9443
+ {
9444
+ "kind": "Content",
9445
+ "text": "viewNumber?: "
9446
+ },
9447
+ {
9448
+ "kind": "Content",
9449
+ "text": "number"
9450
+ },
9451
+ {
9452
+ "kind": "Content",
9453
+ "text": ";"
9454
+ }
9455
+ ],
9456
+ "isReadonly": false,
9457
+ "isOptional": true,
9458
+ "releaseTag": "Public",
9459
+ "name": "viewNumber",
9460
+ "propertyTypeTokenRange": {
9461
+ "startIndex": 1,
9462
+ "endIndex": 2
9463
+ }
9322
9464
  }
9323
9465
  ],
9324
9466
  "extendsTokenRanges": []
@@ -10767,6 +10909,14 @@
10767
10909
  "kind": "Content",
10768
10910
  "text": "string"
10769
10911
  },
10912
+ {
10913
+ "kind": "Content",
10914
+ "text": ", viewNumber?: "
10915
+ },
10916
+ {
10917
+ "kind": "Content",
10918
+ "text": "number"
10919
+ },
10770
10920
  {
10771
10921
  "kind": "Content",
10772
10922
  "text": "): "
@@ -10796,8 +10946,8 @@
10796
10946
  ],
10797
10947
  "isStatic": false,
10798
10948
  "returnTypeTokenRange": {
10799
- "startIndex": 3,
10800
- "endIndex": 7
10949
+ "startIndex": 5,
10950
+ "endIndex": 9
10801
10951
  },
10802
10952
  "releaseTag": "Public",
10803
10953
  "isProtected": false,
@@ -10810,6 +10960,14 @@
10810
10960
  "endIndex": 2
10811
10961
  },
10812
10962
  "isOptional": false
10963
+ },
10964
+ {
10965
+ "parameterName": "viewNumber",
10966
+ "parameterTypeTokenRange": {
10967
+ "startIndex": 3,
10968
+ "endIndex": 4
10969
+ },
10970
+ "isOptional": true
10813
10971
  }
10814
10972
  ],
10815
10973
  "isOptional": false,
@@ -13893,35 +14051,39 @@
13893
14051
  "isAbstract": false
13894
14052
  },
13895
14053
  {
13896
- "kind": "Method",
13897
- "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#deinit:member(1)",
13898
- "docComment": "",
14054
+ "kind": "Property",
14055
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#customRequestFields:member",
14056
+ "docComment": "/**\n * {@inheritDoc DatasourceMetadata.customRequestFields}\n */\n",
13899
14057
  "excerptTokens": [
13900
14058
  {
13901
14059
  "kind": "Content",
13902
- "text": "deinit(): "
14060
+ "text": "customRequestFields: "
14061
+ },
14062
+ {
14063
+ "kind": "Reference",
14064
+ "text": "MetadataDetail",
14065
+ "canonicalReference": "@genesislcap/foundation-comms!MetadataDetail:type"
13903
14066
  },
13904
14067
  {
13905
14068
  "kind": "Content",
13906
- "text": "void"
14069
+ "text": "[]"
13907
14070
  },
13908
14071
  {
13909
14072
  "kind": "Content",
13910
14073
  "text": ";"
13911
14074
  }
13912
14075
  ],
13913
- "isStatic": false,
13914
- "returnTypeTokenRange": {
14076
+ "isReadonly": false,
14077
+ "isOptional": false,
14078
+ "releaseTag": "Public",
14079
+ "name": "customRequestFields",
14080
+ "propertyTypeTokenRange": {
13915
14081
  "startIndex": 1,
13916
- "endIndex": 2
14082
+ "endIndex": 3
13917
14083
  },
13918
- "releaseTag": "Public",
14084
+ "isStatic": false,
13919
14085
  "isProtected": false,
13920
- "overloadIndex": 1,
13921
- "parameters": [],
13922
- "isOptional": false,
13923
- "isAbstract": false,
13924
- "name": "deinit"
14086
+ "isAbstract": false
13925
14087
  },
13926
14088
  {
13927
14089
  "kind": "Method",
@@ -14094,6 +14256,14 @@
14094
14256
  "kind": "Content",
14095
14257
  "text": "boolean"
14096
14258
  },
14259
+ {
14260
+ "kind": "Content",
14261
+ "text": ", startStream?: "
14262
+ },
14263
+ {
14264
+ "kind": "Content",
14265
+ "text": "boolean"
14266
+ },
14097
14267
  {
14098
14268
  "kind": "Content",
14099
14269
  "text": "): "
@@ -14114,8 +14284,8 @@
14114
14284
  ],
14115
14285
  "isStatic": false,
14116
14286
  "returnTypeTokenRange": {
14117
- "startIndex": 5,
14118
- "endIndex": 7
14287
+ "startIndex": 7,
14288
+ "endIndex": 9
14119
14289
  },
14120
14290
  "releaseTag": "Public",
14121
14291
  "isProtected": false,
@@ -14136,6 +14306,14 @@
14136
14306
  "endIndex": 4
14137
14307
  },
14138
14308
  "isOptional": true
14309
+ },
14310
+ {
14311
+ "parameterName": "startStream",
14312
+ "parameterTypeTokenRange": {
14313
+ "startIndex": 5,
14314
+ "endIndex": 6
14315
+ },
14316
+ "isOptional": true
14139
14317
  }
14140
14318
  ],
14141
14319
  "isOptional": false,
@@ -14402,7 +14580,15 @@
14402
14580
  "excerptTokens": [
14403
14581
  {
14404
14582
  "kind": "Content",
14405
- "text": "snapshot(): "
14583
+ "text": "snapshot(overrideParams?: "
14584
+ },
14585
+ {
14586
+ "kind": "Content",
14587
+ "text": "any"
14588
+ },
14589
+ {
14590
+ "kind": "Content",
14591
+ "text": "): "
14406
14592
  },
14407
14593
  {
14408
14594
  "kind": "Reference",
@@ -14429,13 +14615,22 @@
14429
14615
  ],
14430
14616
  "isStatic": false,
14431
14617
  "returnTypeTokenRange": {
14432
- "startIndex": 1,
14433
- "endIndex": 5
14618
+ "startIndex": 3,
14619
+ "endIndex": 7
14434
14620
  },
14435
14621
  "releaseTag": "Public",
14436
14622
  "isProtected": false,
14437
14623
  "overloadIndex": 1,
14438
- "parameters": [],
14624
+ "parameters": [
14625
+ {
14626
+ "parameterName": "overrideParams",
14627
+ "parameterTypeTokenRange": {
14628
+ "startIndex": 1,
14629
+ "endIndex": 2
14630
+ },
14631
+ "isOptional": true
14632
+ }
14633
+ ],
14439
14634
  "isOptional": false,
14440
14635
  "isAbstract": false,
14441
14636
  "name": "snapshot"
@@ -14493,6 +14688,72 @@
14493
14688
  "isAbstract": false,
14494
14689
  "name": "snapshotFiltered"
14495
14690
  },
14691
+ {
14692
+ "kind": "Method",
14693
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#startStream:member(1)",
14694
+ "docComment": "",
14695
+ "excerptTokens": [
14696
+ {
14697
+ "kind": "Content",
14698
+ "text": "startStream(): "
14699
+ },
14700
+ {
14701
+ "kind": "Reference",
14702
+ "text": "Promise",
14703
+ "canonicalReference": "!Promise:interface"
14704
+ },
14705
+ {
14706
+ "kind": "Content",
14707
+ "text": "<void>"
14708
+ },
14709
+ {
14710
+ "kind": "Content",
14711
+ "text": ";"
14712
+ }
14713
+ ],
14714
+ "isStatic": false,
14715
+ "returnTypeTokenRange": {
14716
+ "startIndex": 1,
14717
+ "endIndex": 3
14718
+ },
14719
+ "releaseTag": "Public",
14720
+ "isProtected": false,
14721
+ "overloadIndex": 1,
14722
+ "parameters": [],
14723
+ "isOptional": false,
14724
+ "isAbstract": false,
14725
+ "name": "startStream"
14726
+ },
14727
+ {
14728
+ "kind": "Property",
14729
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#startStreamRequired:member",
14730
+ "docComment": "/**\n * {@inheritDoc DatasourceMetadata.startStream}\n */\n",
14731
+ "excerptTokens": [
14732
+ {
14733
+ "kind": "Content",
14734
+ "text": "startStreamRequired: "
14735
+ },
14736
+ {
14737
+ "kind": "Content",
14738
+ "text": "boolean"
14739
+ },
14740
+ {
14741
+ "kind": "Content",
14742
+ "text": ";"
14743
+ }
14744
+ ],
14745
+ "isReadonly": false,
14746
+ "isOptional": false,
14747
+ "releaseTag": "Public",
14748
+ "name": "startStreamRequired",
14749
+ "propertyTypeTokenRange": {
14750
+ "startIndex": 1,
14751
+ "endIndex": 2
14752
+ },
14753
+ "isStatic": false,
14754
+ "isProtected": false,
14755
+ "isAbstract": false
14756
+ },
14496
14757
  {
14497
14758
  "kind": "Property",
14498
14759
  "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#status:member",
@@ -18091,6 +18352,14 @@
18091
18352
  "kind": "Content",
18092
18353
  "text": "string"
18093
18354
  },
18355
+ {
18356
+ "kind": "Content",
18357
+ "text": ", viewNumber?: "
18358
+ },
18359
+ {
18360
+ "kind": "Content",
18361
+ "text": "number"
18362
+ },
18094
18363
  {
18095
18364
  "kind": "Content",
18096
18365
  "text": "): "
@@ -18100,6 +18369,19 @@
18100
18369
  "text": "Message",
18101
18370
  "canonicalReference": "@genesislcap/foundation-comms!Message:type"
18102
18371
  },
18372
+ {
18373
+ "kind": "Content",
18374
+ "text": "<"
18375
+ },
18376
+ {
18377
+ "kind": "Reference",
18378
+ "text": "MessageDetails.MoreRows",
18379
+ "canonicalReference": "@genesislcap/foundation-comms!MessageDetails.MoreRows:type"
18380
+ },
18381
+ {
18382
+ "kind": "Content",
18383
+ "text": ">"
18384
+ },
18103
18385
  {
18104
18386
  "kind": "Content",
18105
18387
  "text": ";"
@@ -18107,8 +18389,8 @@
18107
18389
  ],
18108
18390
  "isStatic": false,
18109
18391
  "returnTypeTokenRange": {
18110
- "startIndex": 3,
18111
- "endIndex": 4
18392
+ "startIndex": 5,
18393
+ "endIndex": 9
18112
18394
  },
18113
18395
  "releaseTag": "Public",
18114
18396
  "isProtected": false,
@@ -18121,6 +18403,14 @@
18121
18403
  "endIndex": 2
18122
18404
  },
18123
18405
  "isOptional": false
18406
+ },
18407
+ {
18408
+ "parameterName": "viewNumber",
18409
+ "parameterTypeTokenRange": {
18410
+ "startIndex": 3,
18411
+ "endIndex": 4
18412
+ },
18413
+ "isOptional": true
18124
18414
  }
18125
18415
  ],
18126
18416
  "isOptional": false,
@@ -25128,7 +25418,7 @@
25128
25418
  {
25129
25419
  "kind": "MethodSignature",
25130
25420
  "canonicalReference": "@genesislcap/foundation-comms!MessageBuilder#createMoreRowsMessage:member(1)",
25131
- "docComment": "/**\n * Creates a message to request more rows.\n *\n * @remarks\n *\n * MORE_ROWS\n *\n * @param sourceRef - The source reference.\n *\n * @returns The more rows message.\n *\n * @public\n */\n",
25421
+ "docComment": "/**\n * Creates a message to request more rows.\n *\n * @remarks\n *\n * MORE_ROWS\n *\n * @param sourceRef - The unique source reference.\n *\n * @param viewNumber - The desired view number. Default:always the first view, if not spceified.\n *\n * @returns The more rows message.\n *\n * @public\n */\n",
25132
25422
  "excerptTokens": [
25133
25423
  {
25134
25424
  "kind": "Content",
@@ -25138,6 +25428,14 @@
25138
25428
  "kind": "Content",
25139
25429
  "text": "string"
25140
25430
  },
25431
+ {
25432
+ "kind": "Content",
25433
+ "text": ", viewNumber?: "
25434
+ },
25435
+ {
25436
+ "kind": "Content",
25437
+ "text": "number"
25438
+ },
25141
25439
  {
25142
25440
  "kind": "Content",
25143
25441
  "text": "): "
@@ -25147,6 +25445,19 @@
25147
25445
  "text": "Message",
25148
25446
  "canonicalReference": "@genesislcap/foundation-comms!Message:type"
25149
25447
  },
25448
+ {
25449
+ "kind": "Content",
25450
+ "text": "<"
25451
+ },
25452
+ {
25453
+ "kind": "Reference",
25454
+ "text": "MessageDetails.MoreRows",
25455
+ "canonicalReference": "@genesislcap/foundation-comms!MessageDetails.MoreRows:type"
25456
+ },
25457
+ {
25458
+ "kind": "Content",
25459
+ "text": ">"
25460
+ },
25150
25461
  {
25151
25462
  "kind": "Content",
25152
25463
  "text": ";"
@@ -25154,8 +25465,8 @@
25154
25465
  ],
25155
25466
  "isOptional": false,
25156
25467
  "returnTypeTokenRange": {
25157
- "startIndex": 3,
25158
- "endIndex": 4
25468
+ "startIndex": 5,
25469
+ "endIndex": 9
25159
25470
  },
25160
25471
  "releaseTag": "Public",
25161
25472
  "overloadIndex": 1,
@@ -25167,6 +25478,14 @@
25167
25478
  "endIndex": 2
25168
25479
  },
25169
25480
  "isOptional": false
25481
+ },
25482
+ {
25483
+ "parameterName": "viewNumber",
25484
+ "parameterTypeTokenRange": {
25485
+ "startIndex": 3,
25486
+ "endIndex": 4
25487
+ },
25488
+ "isOptional": true
25170
25489
  }
25171
25490
  ],
25172
25491
  "name": "createMoreRowsMessage"
@@ -25239,8 +25558,9 @@
25239
25558
  "text": ", params?: "
25240
25559
  },
25241
25560
  {
25242
- "kind": "Content",
25243
- "text": "any"
25561
+ "kind": "Reference",
25562
+ "text": "RequestParams",
25563
+ "canonicalReference": "@genesislcap/foundation-comms!RequestParams:type"
25244
25564
  },
25245
25565
  {
25246
25566
  "kind": "Content",
@@ -25778,7 +26098,7 @@
25778
26098
  },
25779
26099
  {
25780
26100
  "kind": "Content",
25781
- "text": "{\n SOURCE_REF: string;\n }"
26101
+ "text": "{\n SOURCE_REF: string;\n VIEW_NUMBER?: number;\n }"
25782
26102
  },
25783
26103
  {
25784
26104
  "kind": "Content",
@@ -26335,7 +26655,16 @@
26335
26655
  },
26336
26656
  {
26337
26657
  "kind": "Content",
26338
- "text": "{\n FIELD?: "
26658
+ "text": "{\n DEFINITIONS?: "
26659
+ },
26660
+ {
26661
+ "kind": "Reference",
26662
+ "text": "Record",
26663
+ "canonicalReference": "!Record:type"
26664
+ },
26665
+ {
26666
+ "kind": "Content",
26667
+ "text": "<string, any>;\n DESCRIPTION?: string;\n FIELD?: "
26339
26668
  },
26340
26669
  {
26341
26670
  "kind": "Reference",
@@ -26344,16 +26673,16 @@
26344
26673
  },
26345
26674
  {
26346
26675
  "kind": "Content",
26347
- "text": "[];\n INDEXES?: "
26676
+ "text": "[];\n REPLY?: "
26348
26677
  },
26349
26678
  {
26350
26679
  "kind": "Reference",
26351
- "text": "IndexDetail",
26352
- "canonicalReference": "@genesislcap/foundation-comms!IndexDetail:type"
26680
+ "text": "ReplyDetail",
26681
+ "canonicalReference": "@genesislcap/foundation-comms!ReplyDetail:type"
26353
26682
  },
26354
26683
  {
26355
26684
  "kind": "Content",
26356
- "text": "[];\n REPLY_FIELD?: "
26685
+ "text": ";\n REPLY_FIELD?: "
26357
26686
  },
26358
26687
  {
26359
26688
  "kind": "Reference",
@@ -26371,7 +26700,16 @@
26371
26700
  },
26372
26701
  {
26373
26702
  "kind": "Content",
26374
- "text": "[];\n NAME?: string;\n TYPE?: string;\n ERROR?: string;\n}"
26703
+ "text": "[];\n NAME?: string;\n TYPE?: string;\n INDEXES?: "
26704
+ },
26705
+ {
26706
+ "kind": "Reference",
26707
+ "text": "IndexDetail",
26708
+ "canonicalReference": "@genesislcap/foundation-comms!IndexDetail:type"
26709
+ },
26710
+ {
26711
+ "kind": "Content",
26712
+ "text": "[];\n ERROR?: string;\n}"
26375
26713
  },
26376
26714
  {
26377
26715
  "kind": "Content",
@@ -26383,7 +26721,7 @@
26383
26721
  "name": "Metadata",
26384
26722
  "typeTokenRange": {
26385
26723
  "startIndex": 1,
26386
- "endIndex": 10
26724
+ "endIndex": 14
26387
26725
  }
26388
26726
  },
26389
26727
  {
@@ -26609,7 +26947,7 @@
26609
26947
  },
26610
26948
  {
26611
26949
  "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}"
26950
+ "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
26951
  },
26614
26952
  {
26615
26953
  "kind": "Content",
@@ -27962,6 +28300,76 @@
27962
28300
  "endIndex": 2
27963
28301
  }
27964
28302
  },
28303
+ {
28304
+ "kind": "TypeAlias",
28305
+ "canonicalReference": "@genesislcap/foundation-comms!ReplyDetail:type",
28306
+ "docComment": "/**\n * Reply Detail definition.\n *\n * @public\n */\n",
28307
+ "excerptTokens": [
28308
+ {
28309
+ "kind": "Content",
28310
+ "text": "export type ReplyDetail = "
28311
+ },
28312
+ {
28313
+ "kind": "Content",
28314
+ "text": "{\n DEFINITIONS?: "
28315
+ },
28316
+ {
28317
+ "kind": "Reference",
28318
+ "text": "Record",
28319
+ "canonicalReference": "!Record:type"
28320
+ },
28321
+ {
28322
+ "kind": "Content",
28323
+ "text": "<string, any>;\n DESCRIPTION?: string;\n FIELD: "
28324
+ },
28325
+ {
28326
+ "kind": "Reference",
28327
+ "text": "MetadataDetail",
28328
+ "canonicalReference": "@genesislcap/foundation-comms!MetadataDetail:type"
28329
+ },
28330
+ {
28331
+ "kind": "Content",
28332
+ "text": "[];\n NAME: string;\n [key: string]: any;\n}"
28333
+ },
28334
+ {
28335
+ "kind": "Content",
28336
+ "text": ";"
28337
+ }
28338
+ ],
28339
+ "fileUrlPath": "src/metadata/metadata.types.ts",
28340
+ "releaseTag": "Public",
28341
+ "name": "ReplyDetail",
28342
+ "typeTokenRange": {
28343
+ "startIndex": 1,
28344
+ "endIndex": 6
28345
+ }
28346
+ },
28347
+ {
28348
+ "kind": "TypeAlias",
28349
+ "canonicalReference": "@genesislcap/foundation-comms!RequestDetailsParam:type",
28350
+ "docComment": "/**\n * @public\n */\n",
28351
+ "excerptTokens": [
28352
+ {
28353
+ "kind": "Content",
28354
+ "text": "export type RequestDetailsParam = "
28355
+ },
28356
+ {
28357
+ "kind": "Content",
28358
+ "text": "{\n MAX_ROWS?: number;\n CRITERIA_MATCH?: string;\n}"
28359
+ },
28360
+ {
28361
+ "kind": "Content",
28362
+ "text": ";"
28363
+ }
28364
+ ],
28365
+ "fileUrlPath": "src/connect/message.ts",
28366
+ "releaseTag": "Public",
28367
+ "name": "RequestDetailsParam",
28368
+ "typeTokenRange": {
28369
+ "startIndex": 1,
28370
+ "endIndex": 2
28371
+ }
28372
+ },
27965
28373
  {
27966
28374
  "kind": "TypeAlias",
27967
28375
  "canonicalReference": "@genesislcap/foundation-comms!RequestParams:type",
@@ -27973,7 +28381,16 @@
27973
28381
  },
27974
28382
  {
27975
28383
  "kind": "Content",
27976
- "text": "{\n DETAILS?: any;\n REQUEST?: any;\n}"
28384
+ "text": "{\n DETAILS?: "
28385
+ },
28386
+ {
28387
+ "kind": "Reference",
28388
+ "text": "RequestDetailsParam",
28389
+ "canonicalReference": "@genesislcap/foundation-comms!RequestDetailsParam:type"
28390
+ },
28391
+ {
28392
+ "kind": "Content",
28393
+ "text": " | any;\n REQUEST?: any;\n}"
27977
28394
  },
27978
28395
  {
27979
28396
  "kind": "Content",
@@ -27985,7 +28402,7 @@
27985
28402
  "name": "RequestParams",
27986
28403
  "typeTokenRange": {
27987
28404
  "startIndex": 1,
27988
- "endIndex": 2
28405
+ "endIndex": 4
27989
28406
  }
27990
28407
  },
27991
28408
  {
@@ -27999,7 +28416,7 @@
27999
28416
  },
28000
28417
  {
28001
28418
  "kind": "Content",
28002
- "text": "{\n SOURCE_REF?: string;\n REPLY: any[];\n MESSAGE_TYPE?: string;\n}"
28419
+ "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
28420
  },
28004
28421
  {
28005
28422
  "kind": "Content",