@genesislcap/foundation-comms 14.200.1-alpha-eb310c6.0 → 14.201.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 +3 -4
  2. package/dist/dts/connect/connect.d.ts.map +1 -1
  3. package/dist/dts/connect/message.d.ts +5 -14
  4. package/dist/dts/connect/message.d.ts.map +1 -1
  5. package/dist/dts/datasource/datasource.d.ts +16 -21
  6. package/dist/dts/datasource/datasource.d.ts.map +1 -1
  7. package/dist/dts/datasource/datasource.types.d.ts +17 -37
  8. package/dist/dts/datasource/datasource.types.d.ts.map +1 -1
  9. package/dist/dts/metadata/metadata.types.d.ts +1 -23
  10. package/dist/dts/metadata/metadata.types.d.ts.map +1 -1
  11. package/dist/dts/testing/mocks/datasource/datasource.d.ts +2 -4
  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 +1 -2
  15. package/dist/esm/datasource/datasource.js +32 -63
  16. package/dist/esm/metadata/metadata.utils.js +1 -2
  17. package/dist/esm/testing/mocks/datasource/datasource.js +2 -14
  18. package/dist/foundation-comms.api.json +93 -510
  19. package/dist/foundation-comms.d.ts +44 -105
  20. package/docs/api/foundation-comms.connect.getmorerows.md +2 -3
  21. package/docs/api/foundation-comms.connect.md +1 -1
  22. package/docs/api/{foundation-comms.datasource.startstream.md → foundation-comms.datasource.deinit.md} +9 -5
  23. package/docs/api/foundation-comms.datasource.destroy.md +1 -5
  24. package/docs/api/foundation-comms.datasource.init.md +1 -2
  25. package/docs/api/foundation-comms.datasource.md +4 -4
  26. package/docs/api/foundation-comms.datasource.snapshot.md +3 -3
  27. package/docs/api/foundation-comms.datasource.snapshotfiltered.md +2 -2
  28. package/docs/api/foundation-comms.datasource.validresourcename.md +0 -5
  29. package/docs/api/foundation-comms.datasourcemetadata.md +0 -1
  30. package/docs/api/foundation-comms.datasourceoptions.criteria.md +0 -5
  31. package/docs/api/foundation-comms.datasourceoptions.disablepolling.md +0 -5
  32. package/docs/api/foundation-comms.datasourceoptions.fields.md +0 -5
  33. package/docs/api/foundation-comms.datasourceoptions.maxrows.md +0 -5
  34. package/docs/api/foundation-comms.datasourceoptions.maxview.md +0 -5
  35. package/docs/api/foundation-comms.datasourceoptions.md +0 -2
  36. package/docs/api/foundation-comms.datasourceoptions.movingview.md +0 -5
  37. package/docs/api/foundation-comms.datasourceoptions.orderby.md +0 -5
  38. package/docs/api/foundation-comms.datasourceoptions.request.md +0 -5
  39. package/docs/api/foundation-comms.datasourceoptions.reverse.md +0 -5
  40. package/docs/api/foundation-comms.defaultconnect.getmorerows.md +1 -2
  41. package/docs/api/foundation-comms.defaultconnect.md +1 -1
  42. package/docs/api/{foundation-comms.defaultdatasource.startstream.md → foundation-comms.defaultdatasource.deinit.md} +4 -4
  43. package/docs/api/foundation-comms.defaultdatasource.destroy.md +1 -5
  44. package/docs/api/foundation-comms.defaultdatasource.init.md +1 -2
  45. package/docs/api/foundation-comms.defaultdatasource.md +4 -6
  46. package/docs/api/foundation-comms.defaultdatasource.snapshot.md +1 -8
  47. package/docs/api/foundation-comms.defaultmessagebuilder.createmorerowsmessage.md +2 -3
  48. package/docs/api/foundation-comms.defaultmessagebuilder.md +1 -1
  49. package/docs/api/foundation-comms.md +0 -2
  50. package/docs/api/foundation-comms.messagebuilder.createmorerowsmessage.md +3 -4
  51. package/docs/api/foundation-comms.messagebuilder.createrequestmessage.md +2 -2
  52. package/docs/api/foundation-comms.messagebuilder.md +1 -1
  53. package/docs/api/foundation-comms.messagedetails.morerows.md +0 -1
  54. package/docs/api/foundation-comms.metadata.md +2 -5
  55. package/docs/api/foundation-comms.metadatadetail.md +0 -3
  56. package/docs/api/foundation-comms.requestparams.md +1 -3
  57. package/docs/api/foundation-comms.requestserverresult.md +0 -5
  58. package/docs/api-report.md +17 -59
  59. package/package.json +13 -13
  60. package/docs/api/foundation-comms.datasourcemetadata.customrequestfields.md +0 -11
  61. package/docs/api/foundation-comms.datasourceoptions.requestautosetup.md +0 -18
  62. package/docs/api/foundation-comms.datasourceoptions.viewnumber.md +0 -18
  63. package/docs/api/foundation-comms.defaultdatasource.customrequestfields.md +0 -12
  64. package/docs/api/foundation-comms.defaultdatasource.startstreamrequired.md +0 -12
  65. package/docs/api/foundation-comms.replydetail.md +0 -21
  66. package/docs/api/foundation-comms.requestdetailsparam.md +0 -15
@@ -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 - 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",
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",
1615
1615
  "excerptTokens": [
1616
1616
  {
1617
1617
  "kind": "Content",
@@ -1621,14 +1621,6 @@
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
- },
1632
1624
  {
1633
1625
  "kind": "Content",
1634
1626
  "text": "): "
@@ -1658,8 +1650,8 @@
1658
1650
  ],
1659
1651
  "isOptional": false,
1660
1652
  "returnTypeTokenRange": {
1661
- "startIndex": 5,
1662
- "endIndex": 9
1653
+ "startIndex": 3,
1654
+ "endIndex": 7
1663
1655
  },
1664
1656
  "releaseTag": "Public",
1665
1657
  "overloadIndex": 1,
@@ -1671,14 +1663,6 @@
1671
1663
  "endIndex": 2
1672
1664
  },
1673
1665
  "isOptional": false
1674
- },
1675
- {
1676
- "parameterName": "viewNumber",
1677
- "parameterTypeTokenRange": {
1678
- "startIndex": 3,
1679
- "endIndex": 4
1680
- },
1681
- "isOptional": true
1682
1666
  }
1683
1667
  ],
1684
1668
  "name": "getMoreRows"
@@ -4712,6 +4696,34 @@
4712
4696
  ],
4713
4697
  "name": "dataHandler"
4714
4698
  },
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
+ },
4715
4727
  {
4716
4728
  "kind": "MethodSignature",
4717
4729
  "canonicalReference": "@genesislcap/foundation-comms!Datasource#deleteItem:member(1)",
@@ -4765,7 +4777,7 @@
4765
4777
  {
4766
4778
  "kind": "MethodSignature",
4767
4779
  "canonicalReference": "@genesislcap/foundation-comms!Datasource#destroy:member(1)",
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",
4780
+ "docComment": "/**\n * Destroy the datasource.\n *\n * @public\n */\n",
4769
4781
  "excerptTokens": [
4770
4782
  {
4771
4783
  "kind": "Content",
@@ -4907,7 +4919,7 @@
4907
4919
  {
4908
4920
  "kind": "MethodSignature",
4909
4921
  "canonicalReference": "@genesislcap/foundation-comms!Datasource#init:member(1)",
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",
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",
4911
4923
  "excerptTokens": [
4912
4924
  {
4913
4925
  "kind": "Content",
@@ -4926,14 +4938,6 @@
4926
4938
  "kind": "Content",
4927
4939
  "text": "boolean"
4928
4940
  },
4929
- {
4930
- "kind": "Content",
4931
- "text": ", startStream?: "
4932
- },
4933
- {
4934
- "kind": "Content",
4935
- "text": "boolean"
4936
- },
4937
4941
  {
4938
4942
  "kind": "Content",
4939
4943
  "text": "): "
@@ -4954,8 +4958,8 @@
4954
4958
  ],
4955
4959
  "isOptional": false,
4956
4960
  "returnTypeTokenRange": {
4957
- "startIndex": 7,
4958
- "endIndex": 9
4961
+ "startIndex": 5,
4962
+ "endIndex": 7
4959
4963
  },
4960
4964
  "releaseTag": "Public",
4961
4965
  "overloadIndex": 1,
@@ -4975,14 +4979,6 @@
4975
4979
  "endIndex": 4
4976
4980
  },
4977
4981
  "isOptional": true
4978
- },
4979
- {
4980
- "parameterName": "startStream",
4981
- "parameterTypeTokenRange": {
4982
- "startIndex": 5,
4983
- "endIndex": 6
4984
- },
4985
- "isOptional": true
4986
4982
  }
4987
4983
  ],
4988
4984
  "name": "init"
@@ -5154,11 +5150,11 @@
5154
5150
  {
5155
5151
  "kind": "MethodSignature",
5156
5152
  "canonicalReference": "@genesislcap/foundation-comms!Datasource#snapshot:member(1)",
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",
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",
5158
5154
  "excerptTokens": [
5159
5155
  {
5160
5156
  "kind": "Content",
5161
- "text": "snapshot(overrideParams?: "
5157
+ "text": "snapshot(params?: "
5162
5158
  },
5163
5159
  {
5164
5160
  "kind": "Content",
@@ -5168,23 +5164,9 @@
5168
5164
  "kind": "Content",
5169
5165
  "text": "): "
5170
5166
  },
5171
- {
5172
- "kind": "Reference",
5173
- "text": "Promise",
5174
- "canonicalReference": "!Promise:interface"
5175
- },
5176
5167
  {
5177
5168
  "kind": "Content",
5178
- "text": "<"
5179
- },
5180
- {
5181
- "kind": "Reference",
5182
- "text": "Message",
5183
- "canonicalReference": "@genesislcap/foundation-comms!Message:type"
5184
- },
5185
- {
5186
- "kind": "Content",
5187
- "text": ">"
5169
+ "text": "any"
5188
5170
  },
5189
5171
  {
5190
5172
  "kind": "Content",
@@ -5194,13 +5176,13 @@
5194
5176
  "isOptional": false,
5195
5177
  "returnTypeTokenRange": {
5196
5178
  "startIndex": 3,
5197
- "endIndex": 7
5179
+ "endIndex": 4
5198
5180
  },
5199
5181
  "releaseTag": "Public",
5200
5182
  "overloadIndex": 1,
5201
5183
  "parameters": [
5202
5184
  {
5203
- "parameterName": "overrideParams",
5185
+ "parameterName": "params",
5204
5186
  "parameterTypeTokenRange": {
5205
5187
  "startIndex": 1,
5206
5188
  "endIndex": 2
@@ -5227,14 +5209,9 @@
5227
5209
  "kind": "Content",
5228
5210
  "text": "): "
5229
5211
  },
5230
- {
5231
- "kind": "Reference",
5232
- "text": "Promise",
5233
- "canonicalReference": "!Promise:interface"
5234
- },
5235
5212
  {
5236
5213
  "kind": "Content",
5237
- "text": "<any[]>"
5214
+ "text": "any"
5238
5215
  },
5239
5216
  {
5240
5217
  "kind": "Content",
@@ -5244,7 +5221,7 @@
5244
5221
  "isOptional": false,
5245
5222
  "returnTypeTokenRange": {
5246
5223
  "startIndex": 3,
5247
- "endIndex": 5
5224
+ "endIndex": 4
5248
5225
  },
5249
5226
  "releaseTag": "Public",
5250
5227
  "overloadIndex": 1,
@@ -5260,39 +5237,6 @@
5260
5237
  ],
5261
5238
  "name": "snapshotFiltered"
5262
5239
  },
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
- },
5296
5240
  {
5297
5241
  "kind": "PropertySignature",
5298
5242
  "canonicalReference": "@genesislcap/foundation-comms!Datasource#status:member",
@@ -5508,7 +5452,7 @@
5508
5452
  {
5509
5453
  "kind": "MethodSignature",
5510
5454
  "canonicalReference": "@genesislcap/foundation-comms!Datasource#validResourceName:member(1)",
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",
5455
+ "docComment": "/**\n * Indicates whether the resourceName is valid or not.\n *\n * @public\n */\n",
5512
5456
  "excerptTokens": [
5513
5457
  {
5514
5458
  "kind": "Content",
@@ -8911,38 +8855,6 @@
8911
8855
  "endIndex": 3
8912
8856
  }
8913
8857
  },
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
- },
8946
8858
  {
8947
8859
  "kind": "PropertySignature",
8948
8860
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceMetadata#fetchMetadataRequired:member",
@@ -9087,7 +8999,7 @@
9087
8999
  {
9088
9000
  "kind": "PropertySignature",
9089
9001
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#criteria:member",
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",
9002
+ "docComment": "/**\n * The criteria used to filter data in the datasource.\n */\n",
9091
9003
  "excerptTokens": [
9092
9004
  {
9093
9005
  "kind": "Content",
@@ -9114,7 +9026,7 @@
9114
9026
  {
9115
9027
  "kind": "PropertySignature",
9116
9028
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#disablePolling:member",
9117
- "docComment": "/**\n * Whether to disable polling when using request/reply\n *\n * @remarks\n *\n * Only works with REQUEST_SERVER resources.\n */\n",
9029
+ "docComment": "/**\n * Whether to disable polling when using request/reply\n */\n",
9118
9030
  "excerptTokens": [
9119
9031
  {
9120
9032
  "kind": "Content",
@@ -9141,7 +9053,7 @@
9141
9053
  {
9142
9054
  "kind": "PropertySignature",
9143
9055
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#fields:member",
9144
- "docComment": "/**\n * The fields to include in the returned data.\n *\n * @remarks\n *\n * Only works with DATASERVER resources.\n */\n",
9056
+ "docComment": "/**\n * The fields to include in the returned data.\n */\n",
9145
9057
  "excerptTokens": [
9146
9058
  {
9147
9059
  "kind": "Content",
@@ -9195,7 +9107,7 @@
9195
9107
  {
9196
9108
  "kind": "PropertySignature",
9197
9109
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#maxRows:member",
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",
9110
+ "docComment": "/**\n * The maximum number of rows to return from the datasource.\n */\n",
9199
9111
  "excerptTokens": [
9200
9112
  {
9201
9113
  "kind": "Content",
@@ -9222,7 +9134,7 @@
9222
9134
  {
9223
9135
  "kind": "PropertySignature",
9224
9136
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#maxView:member",
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",
9137
+ "docComment": "/**\n * The maximum number of rows to track as part of a client \"view\"\n */\n",
9226
9138
  "excerptTokens": [
9227
9139
  {
9228
9140
  "kind": "Content",
@@ -9249,7 +9161,7 @@
9249
9161
  {
9250
9162
  "kind": "PropertySignature",
9251
9163
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#movingView:member",
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",
9164
+ "docComment": "/**\n * Defines the behaviour of the client view when new rows are received in real time.\n */\n",
9253
9165
  "excerptTokens": [
9254
9166
  {
9255
9167
  "kind": "Content",
@@ -9276,7 +9188,7 @@
9276
9188
  {
9277
9189
  "kind": "PropertySignature",
9278
9190
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#orderBy:member",
9279
- "docComment": "/**\n * The field to use for sorting the data.\n *\n * @remarks\n *\n * Only works with DATASERVER.\n */\n",
9191
+ "docComment": "/**\n * The field to use for sorting the data.\n */\n",
9280
9192
  "excerptTokens": [
9281
9193
  {
9282
9194
  "kind": "Content",
@@ -9330,7 +9242,7 @@
9330
9242
  {
9331
9243
  "kind": "PropertySignature",
9332
9244
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#request:member",
9333
- "docComment": "/**\n * The request to send to the server.\n *\n * @remarks\n *\n * Only works with REQUEST_SERVER resources.\n */\n",
9245
+ "docComment": "/**\n * The request to send to the server.\n */\n",
9334
9246
  "excerptTokens": [
9335
9247
  {
9336
9248
  "kind": "Content",
@@ -9354,33 +9266,6 @@
9354
9266
  "endIndex": 2
9355
9267
  }
9356
9268
  },
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 * 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
- },
9384
9269
  {
9385
9270
  "kind": "PropertySignature",
9386
9271
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#resourceName:member",
@@ -9411,7 +9296,7 @@
9411
9296
  {
9412
9297
  "kind": "PropertySignature",
9413
9298
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#reverse:member",
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",
9299
+ "docComment": "/**\n * Whether to return the data in reverse order or not.\n */\n",
9415
9300
  "excerptTokens": [
9416
9301
  {
9417
9302
  "kind": "Content",
@@ -9434,33 +9319,6 @@
9434
9319
  "startIndex": 1,
9435
9320
  "endIndex": 2
9436
9321
  }
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
- }
9464
9322
  }
9465
9323
  ],
9466
9324
  "extendsTokenRanges": []
@@ -10909,14 +10767,6 @@
10909
10767
  "kind": "Content",
10910
10768
  "text": "string"
10911
10769
  },
10912
- {
10913
- "kind": "Content",
10914
- "text": ", viewNumber?: "
10915
- },
10916
- {
10917
- "kind": "Content",
10918
- "text": "number"
10919
- },
10920
10770
  {
10921
10771
  "kind": "Content",
10922
10772
  "text": "): "
@@ -10946,8 +10796,8 @@
10946
10796
  ],
10947
10797
  "isStatic": false,
10948
10798
  "returnTypeTokenRange": {
10949
- "startIndex": 5,
10950
- "endIndex": 9
10799
+ "startIndex": 3,
10800
+ "endIndex": 7
10951
10801
  },
10952
10802
  "releaseTag": "Public",
10953
10803
  "isProtected": false,
@@ -10960,14 +10810,6 @@
10960
10810
  "endIndex": 2
10961
10811
  },
10962
10812
  "isOptional": false
10963
- },
10964
- {
10965
- "parameterName": "viewNumber",
10966
- "parameterTypeTokenRange": {
10967
- "startIndex": 3,
10968
- "endIndex": 4
10969
- },
10970
- "isOptional": true
10971
10813
  }
10972
10814
  ],
10973
10815
  "isOptional": false,
@@ -14051,39 +13893,35 @@
14051
13893
  "isAbstract": false
14052
13894
  },
14053
13895
  {
14054
- "kind": "Property",
14055
- "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#customRequestFields:member",
14056
- "docComment": "/**\n * {@inheritDoc DatasourceMetadata.customRequestFields}\n */\n",
13896
+ "kind": "Method",
13897
+ "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#deinit:member(1)",
13898
+ "docComment": "",
14057
13899
  "excerptTokens": [
14058
13900
  {
14059
13901
  "kind": "Content",
14060
- "text": "customRequestFields: "
14061
- },
14062
- {
14063
- "kind": "Reference",
14064
- "text": "MetadataDetail",
14065
- "canonicalReference": "@genesislcap/foundation-comms!MetadataDetail:type"
13902
+ "text": "deinit(): "
14066
13903
  },
14067
13904
  {
14068
13905
  "kind": "Content",
14069
- "text": "[]"
13906
+ "text": "void"
14070
13907
  },
14071
13908
  {
14072
13909
  "kind": "Content",
14073
13910
  "text": ";"
14074
13911
  }
14075
13912
  ],
14076
- "isReadonly": false,
14077
- "isOptional": false,
14078
- "releaseTag": "Public",
14079
- "name": "customRequestFields",
14080
- "propertyTypeTokenRange": {
13913
+ "isStatic": false,
13914
+ "returnTypeTokenRange": {
14081
13915
  "startIndex": 1,
14082
- "endIndex": 3
13916
+ "endIndex": 2
14083
13917
  },
14084
- "isStatic": false,
13918
+ "releaseTag": "Public",
14085
13919
  "isProtected": false,
14086
- "isAbstract": false
13920
+ "overloadIndex": 1,
13921
+ "parameters": [],
13922
+ "isOptional": false,
13923
+ "isAbstract": false,
13924
+ "name": "deinit"
14087
13925
  },
14088
13926
  {
14089
13927
  "kind": "Method",
@@ -14256,14 +14094,6 @@
14256
14094
  "kind": "Content",
14257
14095
  "text": "boolean"
14258
14096
  },
14259
- {
14260
- "kind": "Content",
14261
- "text": ", startStream?: "
14262
- },
14263
- {
14264
- "kind": "Content",
14265
- "text": "boolean"
14266
- },
14267
14097
  {
14268
14098
  "kind": "Content",
14269
14099
  "text": "): "
@@ -14284,8 +14114,8 @@
14284
14114
  ],
14285
14115
  "isStatic": false,
14286
14116
  "returnTypeTokenRange": {
14287
- "startIndex": 7,
14288
- "endIndex": 9
14117
+ "startIndex": 5,
14118
+ "endIndex": 7
14289
14119
  },
14290
14120
  "releaseTag": "Public",
14291
14121
  "isProtected": false,
@@ -14306,14 +14136,6 @@
14306
14136
  "endIndex": 4
14307
14137
  },
14308
14138
  "isOptional": true
14309
- },
14310
- {
14311
- "parameterName": "startStream",
14312
- "parameterTypeTokenRange": {
14313
- "startIndex": 5,
14314
- "endIndex": 6
14315
- },
14316
- "isOptional": true
14317
14139
  }
14318
14140
  ],
14319
14141
  "isOptional": false,
@@ -14580,15 +14402,7 @@
14580
14402
  "excerptTokens": [
14581
14403
  {
14582
14404
  "kind": "Content",
14583
- "text": "snapshot(overrideParams?: "
14584
- },
14585
- {
14586
- "kind": "Content",
14587
- "text": "any"
14588
- },
14589
- {
14590
- "kind": "Content",
14591
- "text": "): "
14405
+ "text": "snapshot(): "
14592
14406
  },
14593
14407
  {
14594
14408
  "kind": "Reference",
@@ -14615,22 +14429,13 @@
14615
14429
  ],
14616
14430
  "isStatic": false,
14617
14431
  "returnTypeTokenRange": {
14618
- "startIndex": 3,
14619
- "endIndex": 7
14432
+ "startIndex": 1,
14433
+ "endIndex": 5
14620
14434
  },
14621
14435
  "releaseTag": "Public",
14622
14436
  "isProtected": false,
14623
14437
  "overloadIndex": 1,
14624
- "parameters": [
14625
- {
14626
- "parameterName": "overrideParams",
14627
- "parameterTypeTokenRange": {
14628
- "startIndex": 1,
14629
- "endIndex": 2
14630
- },
14631
- "isOptional": true
14632
- }
14633
- ],
14438
+ "parameters": [],
14634
14439
  "isOptional": false,
14635
14440
  "isAbstract": false,
14636
14441
  "name": "snapshot"
@@ -14688,72 +14493,6 @@
14688
14493
  "isAbstract": false,
14689
14494
  "name": "snapshotFiltered"
14690
14495
  },
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
- },
14757
14496
  {
14758
14497
  "kind": "Property",
14759
14498
  "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#status:member",
@@ -18352,14 +18091,6 @@
18352
18091
  "kind": "Content",
18353
18092
  "text": "string"
18354
18093
  },
18355
- {
18356
- "kind": "Content",
18357
- "text": ", viewNumber?: "
18358
- },
18359
- {
18360
- "kind": "Content",
18361
- "text": "number"
18362
- },
18363
18094
  {
18364
18095
  "kind": "Content",
18365
18096
  "text": "): "
@@ -18369,19 +18100,6 @@
18369
18100
  "text": "Message",
18370
18101
  "canonicalReference": "@genesislcap/foundation-comms!Message:type"
18371
18102
  },
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
- },
18385
18103
  {
18386
18104
  "kind": "Content",
18387
18105
  "text": ";"
@@ -18389,8 +18107,8 @@
18389
18107
  ],
18390
18108
  "isStatic": false,
18391
18109
  "returnTypeTokenRange": {
18392
- "startIndex": 5,
18393
- "endIndex": 9
18110
+ "startIndex": 3,
18111
+ "endIndex": 4
18394
18112
  },
18395
18113
  "releaseTag": "Public",
18396
18114
  "isProtected": false,
@@ -18403,14 +18121,6 @@
18403
18121
  "endIndex": 2
18404
18122
  },
18405
18123
  "isOptional": false
18406
- },
18407
- {
18408
- "parameterName": "viewNumber",
18409
- "parameterTypeTokenRange": {
18410
- "startIndex": 3,
18411
- "endIndex": 4
18412
- },
18413
- "isOptional": true
18414
18124
  }
18415
18125
  ],
18416
18126
  "isOptional": false,
@@ -25418,7 +25128,7 @@
25418
25128
  {
25419
25129
  "kind": "MethodSignature",
25420
25130
  "canonicalReference": "@genesislcap/foundation-comms!MessageBuilder#createMoreRowsMessage:member(1)",
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",
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",
25422
25132
  "excerptTokens": [
25423
25133
  {
25424
25134
  "kind": "Content",
@@ -25428,14 +25138,6 @@
25428
25138
  "kind": "Content",
25429
25139
  "text": "string"
25430
25140
  },
25431
- {
25432
- "kind": "Content",
25433
- "text": ", viewNumber?: "
25434
- },
25435
- {
25436
- "kind": "Content",
25437
- "text": "number"
25438
- },
25439
25141
  {
25440
25142
  "kind": "Content",
25441
25143
  "text": "): "
@@ -25445,19 +25147,6 @@
25445
25147
  "text": "Message",
25446
25148
  "canonicalReference": "@genesislcap/foundation-comms!Message:type"
25447
25149
  },
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
- },
25461
25150
  {
25462
25151
  "kind": "Content",
25463
25152
  "text": ";"
@@ -25465,8 +25154,8 @@
25465
25154
  ],
25466
25155
  "isOptional": false,
25467
25156
  "returnTypeTokenRange": {
25468
- "startIndex": 5,
25469
- "endIndex": 9
25157
+ "startIndex": 3,
25158
+ "endIndex": 4
25470
25159
  },
25471
25160
  "releaseTag": "Public",
25472
25161
  "overloadIndex": 1,
@@ -25478,14 +25167,6 @@
25478
25167
  "endIndex": 2
25479
25168
  },
25480
25169
  "isOptional": false
25481
- },
25482
- {
25483
- "parameterName": "viewNumber",
25484
- "parameterTypeTokenRange": {
25485
- "startIndex": 3,
25486
- "endIndex": 4
25487
- },
25488
- "isOptional": true
25489
25170
  }
25490
25171
  ],
25491
25172
  "name": "createMoreRowsMessage"
@@ -25558,9 +25239,8 @@
25558
25239
  "text": ", params?: "
25559
25240
  },
25560
25241
  {
25561
- "kind": "Reference",
25562
- "text": "RequestParams",
25563
- "canonicalReference": "@genesislcap/foundation-comms!RequestParams:type"
25242
+ "kind": "Content",
25243
+ "text": "any"
25564
25244
  },
25565
25245
  {
25566
25246
  "kind": "Content",
@@ -26098,7 +25778,7 @@
26098
25778
  },
26099
25779
  {
26100
25780
  "kind": "Content",
26101
- "text": "{\n SOURCE_REF: string;\n VIEW_NUMBER?: number;\n }"
25781
+ "text": "{\n SOURCE_REF: string;\n }"
26102
25782
  },
26103
25783
  {
26104
25784
  "kind": "Content",
@@ -26655,16 +26335,7 @@
26655
26335
  },
26656
26336
  {
26657
26337
  "kind": "Content",
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?: "
26338
+ "text": "{\n FIELD?: "
26668
26339
  },
26669
26340
  {
26670
26341
  "kind": "Reference",
@@ -26673,16 +26344,16 @@
26673
26344
  },
26674
26345
  {
26675
26346
  "kind": "Content",
26676
- "text": "[];\n REPLY?: "
26347
+ "text": "[];\n INDEXES?: "
26677
26348
  },
26678
26349
  {
26679
26350
  "kind": "Reference",
26680
- "text": "ReplyDetail",
26681
- "canonicalReference": "@genesislcap/foundation-comms!ReplyDetail:type"
26351
+ "text": "IndexDetail",
26352
+ "canonicalReference": "@genesislcap/foundation-comms!IndexDetail:type"
26682
26353
  },
26683
26354
  {
26684
26355
  "kind": "Content",
26685
- "text": ";\n REPLY_FIELD?: "
26356
+ "text": "[];\n REPLY_FIELD?: "
26686
26357
  },
26687
26358
  {
26688
26359
  "kind": "Reference",
@@ -26700,16 +26371,7 @@
26700
26371
  },
26701
26372
  {
26702
26373
  "kind": "Content",
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}"
26374
+ "text": "[];\n NAME?: string;\n TYPE?: string;\n ERROR?: string;\n}"
26713
26375
  },
26714
26376
  {
26715
26377
  "kind": "Content",
@@ -26721,7 +26383,7 @@
26721
26383
  "name": "Metadata",
26722
26384
  "typeTokenRange": {
26723
26385
  "startIndex": 1,
26724
- "endIndex": 14
26386
+ "endIndex": 10
26725
26387
  }
26726
26388
  },
26727
26389
  {
@@ -26947,7 +26609,7 @@
26947
26609
  },
26948
26610
  {
26949
26611
  "kind": "Content",
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}"
26612
+ "text": "{\n NAME: string;\n TYPE: string;\n VALID_VALUES?: string;\n READ_ONLY?: boolean;\n OPTIONAL?: boolean;\n UI_LABEL?: string;\n}"
26951
26613
  },
26952
26614
  {
26953
26615
  "kind": "Content",
@@ -28300,76 +27962,6 @@
28300
27962
  "endIndex": 2
28301
27963
  }
28302
27964
  },
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
- },
28373
27965
  {
28374
27966
  "kind": "TypeAlias",
28375
27967
  "canonicalReference": "@genesislcap/foundation-comms!RequestParams:type",
@@ -28381,16 +27973,7 @@
28381
27973
  },
28382
27974
  {
28383
27975
  "kind": "Content",
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}"
27976
+ "text": "{\n DETAILS?: any;\n REQUEST?: any;\n}"
28394
27977
  },
28395
27978
  {
28396
27979
  "kind": "Content",
@@ -28402,7 +27985,7 @@
28402
27985
  "name": "RequestParams",
28403
27986
  "typeTokenRange": {
28404
27987
  "startIndex": 1,
28405
- "endIndex": 4
27988
+ "endIndex": 2
28406
27989
  }
28407
27990
  },
28408
27991
  {
@@ -28416,7 +27999,7 @@
28416
27999
  },
28417
28000
  {
28418
28001
  "kind": "Content",
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}"
28002
+ "text": "{\n SOURCE_REF?: string;\n REPLY: any[];\n MESSAGE_TYPE?: string;\n}"
28420
28003
  },
28421
28004
  {
28422
28005
  "kind": "Content",