@genesislcap/foundation-comms 14.199.2-alpha-1ab46f4.0 → 14.199.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (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 +4 -12
  4. package/dist/dts/connect/message.d.ts.map +1 -1
  5. package/dist/dts/datasource/datasource.d.ts +16 -18
  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 -3
  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 +33 -58
  16. package/dist/esm/metadata/metadata.utils.js +1 -2
  17. package/dist/esm/testing/mocks/datasource/datasource.js +2 -9
  18. package/dist/foundation-comms.api.json +108 -458
  19. package/dist/foundation-comms.d.ts +42 -97
  20. package/docs/api/foundation-comms.connect.getmorerows.md +1 -2
  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.datasourceoptions.criteria.md +0 -5
  30. package/docs/api/foundation-comms.datasourceoptions.disablepolling.md +0 -5
  31. package/docs/api/foundation-comms.datasourceoptions.fields.md +0 -5
  32. package/docs/api/foundation-comms.datasourceoptions.maxrows.md +0 -5
  33. package/docs/api/foundation-comms.datasourceoptions.maxview.md +0 -5
  34. package/docs/api/foundation-comms.datasourceoptions.md +0 -2
  35. package/docs/api/foundation-comms.datasourceoptions.movingview.md +0 -5
  36. package/docs/api/foundation-comms.datasourceoptions.orderby.md +0 -5
  37. package/docs/api/foundation-comms.datasourceoptions.request.md +0 -5
  38. package/docs/api/foundation-comms.datasourceoptions.reverse.md +0 -5
  39. package/docs/api/foundation-comms.defaultconnect.getmorerows.md +1 -2
  40. package/docs/api/foundation-comms.defaultconnect.md +1 -1
  41. package/docs/api/{foundation-comms.defaultdatasource.startstream.md → foundation-comms.defaultdatasource.deinit.md} +4 -4
  42. package/docs/api/foundation-comms.defaultdatasource.destroy.md +1 -5
  43. package/docs/api/foundation-comms.defaultdatasource.init.md +1 -2
  44. package/docs/api/foundation-comms.defaultdatasource.md +4 -5
  45. package/docs/api/foundation-comms.defaultdatasource.snapshot.md +1 -8
  46. package/docs/api/foundation-comms.defaultmessagebuilder.createmorerowsmessage.md +2 -3
  47. package/docs/api/foundation-comms.defaultmessagebuilder.md +1 -1
  48. package/docs/api/foundation-comms.md +0 -2
  49. package/docs/api/foundation-comms.messagebuilder.createmorerowsmessage.md +2 -3
  50. package/docs/api/foundation-comms.messagebuilder.createrequestmessage.md +2 -2
  51. package/docs/api/foundation-comms.messagebuilder.md +1 -1
  52. package/docs/api/foundation-comms.messagedetails.morerows.md +0 -1
  53. package/docs/api/foundation-comms.metadata.md +2 -5
  54. package/docs/api/foundation-comms.metadatadetail.md +0 -3
  55. package/docs/api/foundation-comms.requestparams.md +1 -3
  56. package/docs/api/foundation-comms.requestserverresult.md +0 -5
  57. package/docs/api-report.md +18 -54
  58. package/package.json +13 -13
  59. package/docs/api/foundation-comms.datasourceoptions.requestautosetup.md +0 -18
  60. package/docs/api/foundation-comms.datasourceoptions.viewnumber.md +0 -18
  61. package/docs/api/foundation-comms.defaultdatasource.startstreamrequired.md +0 -12
  62. package/docs/api/foundation-comms.replydetail.md +0 -21
  63. package/docs/api/foundation-comms.requestdetailsparam.md +0 -15
@@ -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",
@@ -9055,7 +8999,7 @@
9055
8999
  {
9056
9000
  "kind": "PropertySignature",
9057
9001
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#criteria:member",
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",
9002
+ "docComment": "/**\n * The criteria used to filter data in the datasource.\n */\n",
9059
9003
  "excerptTokens": [
9060
9004
  {
9061
9005
  "kind": "Content",
@@ -9082,7 +9026,7 @@
9082
9026
  {
9083
9027
  "kind": "PropertySignature",
9084
9028
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#disablePolling:member",
9085
- "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",
9086
9030
  "excerptTokens": [
9087
9031
  {
9088
9032
  "kind": "Content",
@@ -9109,7 +9053,7 @@
9109
9053
  {
9110
9054
  "kind": "PropertySignature",
9111
9055
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#fields:member",
9112
- "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",
9113
9057
  "excerptTokens": [
9114
9058
  {
9115
9059
  "kind": "Content",
@@ -9163,7 +9107,7 @@
9163
9107
  {
9164
9108
  "kind": "PropertySignature",
9165
9109
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#maxRows:member",
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",
9110
+ "docComment": "/**\n * The maximum number of rows to return from the datasource.\n */\n",
9167
9111
  "excerptTokens": [
9168
9112
  {
9169
9113
  "kind": "Content",
@@ -9190,7 +9134,7 @@
9190
9134
  {
9191
9135
  "kind": "PropertySignature",
9192
9136
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#maxView:member",
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",
9137
+ "docComment": "/**\n * The maximum number of rows to track as part of a client \"view\"\n */\n",
9194
9138
  "excerptTokens": [
9195
9139
  {
9196
9140
  "kind": "Content",
@@ -9217,7 +9161,7 @@
9217
9161
  {
9218
9162
  "kind": "PropertySignature",
9219
9163
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#movingView:member",
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",
9164
+ "docComment": "/**\n * Defines the behaviour of the client view when new rows are received in real time.\n */\n",
9221
9165
  "excerptTokens": [
9222
9166
  {
9223
9167
  "kind": "Content",
@@ -9244,7 +9188,7 @@
9244
9188
  {
9245
9189
  "kind": "PropertySignature",
9246
9190
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#orderBy:member",
9247
- "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",
9248
9192
  "excerptTokens": [
9249
9193
  {
9250
9194
  "kind": "Content",
@@ -9298,7 +9242,7 @@
9298
9242
  {
9299
9243
  "kind": "PropertySignature",
9300
9244
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#request:member",
9301
- "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",
9302
9246
  "excerptTokens": [
9303
9247
  {
9304
9248
  "kind": "Content",
@@ -9322,33 +9266,6 @@
9322
9266
  "endIndex": 2
9323
9267
  }
9324
9268
  },
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
- },
9352
9269
  {
9353
9270
  "kind": "PropertySignature",
9354
9271
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#resourceName:member",
@@ -9379,7 +9296,7 @@
9379
9296
  {
9380
9297
  "kind": "PropertySignature",
9381
9298
  "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#reverse:member",
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",
9299
+ "docComment": "/**\n * Whether to return the data in reverse order or not.\n */\n",
9383
9300
  "excerptTokens": [
9384
9301
  {
9385
9302
  "kind": "Content",
@@ -9402,33 +9319,6 @@
9402
9319
  "startIndex": 1,
9403
9320
  "endIndex": 2
9404
9321
  }
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
- }
9432
9322
  }
9433
9323
  ],
9434
9324
  "extendsTokenRanges": []
@@ -10877,14 +10767,6 @@
10877
10767
  "kind": "Content",
10878
10768
  "text": "string"
10879
10769
  },
10880
- {
10881
- "kind": "Content",
10882
- "text": ", viewNumber?: "
10883
- },
10884
- {
10885
- "kind": "Content",
10886
- "text": "number"
10887
- },
10888
10770
  {
10889
10771
  "kind": "Content",
10890
10772
  "text": "): "
@@ -10914,8 +10796,8 @@
10914
10796
  ],
10915
10797
  "isStatic": false,
10916
10798
  "returnTypeTokenRange": {
10917
- "startIndex": 5,
10918
- "endIndex": 9
10799
+ "startIndex": 3,
10800
+ "endIndex": 7
10919
10801
  },
10920
10802
  "releaseTag": "Public",
10921
10803
  "isProtected": false,
@@ -10928,14 +10810,6 @@
10928
10810
  "endIndex": 2
10929
10811
  },
10930
10812
  "isOptional": false
10931
- },
10932
- {
10933
- "parameterName": "viewNumber",
10934
- "parameterTypeTokenRange": {
10935
- "startIndex": 3,
10936
- "endIndex": 4
10937
- },
10938
- "isOptional": true
10939
10813
  }
10940
10814
  ],
10941
10815
  "isOptional": false,
@@ -14018,6 +13892,37 @@
14018
13892
  "isProtected": true,
14019
13893
  "isAbstract": false
14020
13894
  },
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
+ },
14021
13926
  {
14022
13927
  "kind": "Method",
14023
13928
  "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#destroy:member(1)",
@@ -14189,14 +14094,6 @@
14189
14094
  "kind": "Content",
14190
14095
  "text": "boolean"
14191
14096
  },
14192
- {
14193
- "kind": "Content",
14194
- "text": ", startStream?: "
14195
- },
14196
- {
14197
- "kind": "Content",
14198
- "text": "boolean"
14199
- },
14200
14097
  {
14201
14098
  "kind": "Content",
14202
14099
  "text": "): "
@@ -14217,8 +14114,8 @@
14217
14114
  ],
14218
14115
  "isStatic": false,
14219
14116
  "returnTypeTokenRange": {
14220
- "startIndex": 7,
14221
- "endIndex": 9
14117
+ "startIndex": 5,
14118
+ "endIndex": 7
14222
14119
  },
14223
14120
  "releaseTag": "Public",
14224
14121
  "isProtected": false,
@@ -14239,14 +14136,6 @@
14239
14136
  "endIndex": 4
14240
14137
  },
14241
14138
  "isOptional": true
14242
- },
14243
- {
14244
- "parameterName": "startStream",
14245
- "parameterTypeTokenRange": {
14246
- "startIndex": 5,
14247
- "endIndex": 6
14248
- },
14249
- "isOptional": true
14250
14139
  }
14251
14140
  ],
14252
14141
  "isOptional": false,
@@ -14513,15 +14402,7 @@
14513
14402
  "excerptTokens": [
14514
14403
  {
14515
14404
  "kind": "Content",
14516
- "text": "snapshot(overrideParams?: "
14517
- },
14518
- {
14519
- "kind": "Content",
14520
- "text": "any"
14521
- },
14522
- {
14523
- "kind": "Content",
14524
- "text": "): "
14405
+ "text": "snapshot(): "
14525
14406
  },
14526
14407
  {
14527
14408
  "kind": "Reference",
@@ -14548,22 +14429,13 @@
14548
14429
  ],
14549
14430
  "isStatic": false,
14550
14431
  "returnTypeTokenRange": {
14551
- "startIndex": 3,
14552
- "endIndex": 7
14432
+ "startIndex": 1,
14433
+ "endIndex": 5
14553
14434
  },
14554
14435
  "releaseTag": "Public",
14555
14436
  "isProtected": false,
14556
14437
  "overloadIndex": 1,
14557
- "parameters": [
14558
- {
14559
- "parameterName": "overrideParams",
14560
- "parameterTypeTokenRange": {
14561
- "startIndex": 1,
14562
- "endIndex": 2
14563
- },
14564
- "isOptional": true
14565
- }
14566
- ],
14438
+ "parameters": [],
14567
14439
  "isOptional": false,
14568
14440
  "isAbstract": false,
14569
14441
  "name": "snapshot"
@@ -14621,72 +14493,6 @@
14621
14493
  "isAbstract": false,
14622
14494
  "name": "snapshotFiltered"
14623
14495
  },
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
- },
14690
14496
  {
14691
14497
  "kind": "Property",
14692
14498
  "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#status:member",
@@ -18285,14 +18091,6 @@
18285
18091
  "kind": "Content",
18286
18092
  "text": "string"
18287
18093
  },
18288
- {
18289
- "kind": "Content",
18290
- "text": ", viewNumber?: "
18291
- },
18292
- {
18293
- "kind": "Content",
18294
- "text": "number"
18295
- },
18296
18094
  {
18297
18095
  "kind": "Content",
18298
18096
  "text": "): "
@@ -18302,19 +18100,6 @@
18302
18100
  "text": "Message",
18303
18101
  "canonicalReference": "@genesislcap/foundation-comms!Message:type"
18304
18102
  },
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
- },
18318
18103
  {
18319
18104
  "kind": "Content",
18320
18105
  "text": ";"
@@ -18322,8 +18107,8 @@
18322
18107
  ],
18323
18108
  "isStatic": false,
18324
18109
  "returnTypeTokenRange": {
18325
- "startIndex": 5,
18326
- "endIndex": 9
18110
+ "startIndex": 3,
18111
+ "endIndex": 4
18327
18112
  },
18328
18113
  "releaseTag": "Public",
18329
18114
  "isProtected": false,
@@ -18336,14 +18121,6 @@
18336
18121
  "endIndex": 2
18337
18122
  },
18338
18123
  "isOptional": false
18339
- },
18340
- {
18341
- "parameterName": "viewNumber",
18342
- "parameterTypeTokenRange": {
18343
- "startIndex": 3,
18344
- "endIndex": 4
18345
- },
18346
- "isOptional": true
18347
18124
  }
18348
18125
  ],
18349
18126
  "isOptional": false,
@@ -25361,14 +25138,6 @@
25361
25138
  "kind": "Content",
25362
25139
  "text": "string"
25363
25140
  },
25364
- {
25365
- "kind": "Content",
25366
- "text": ", viewNumber?: "
25367
- },
25368
- {
25369
- "kind": "Content",
25370
- "text": "number"
25371
- },
25372
25141
  {
25373
25142
  "kind": "Content",
25374
25143
  "text": "): "
@@ -25378,19 +25147,6 @@
25378
25147
  "text": "Message",
25379
25148
  "canonicalReference": "@genesislcap/foundation-comms!Message:type"
25380
25149
  },
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
- },
25394
25150
  {
25395
25151
  "kind": "Content",
25396
25152
  "text": ";"
@@ -25398,8 +25154,8 @@
25398
25154
  ],
25399
25155
  "isOptional": false,
25400
25156
  "returnTypeTokenRange": {
25401
- "startIndex": 5,
25402
- "endIndex": 9
25157
+ "startIndex": 3,
25158
+ "endIndex": 4
25403
25159
  },
25404
25160
  "releaseTag": "Public",
25405
25161
  "overloadIndex": 1,
@@ -25411,14 +25167,6 @@
25411
25167
  "endIndex": 2
25412
25168
  },
25413
25169
  "isOptional": false
25414
- },
25415
- {
25416
- "parameterName": "viewNumber",
25417
- "parameterTypeTokenRange": {
25418
- "startIndex": 3,
25419
- "endIndex": 4
25420
- },
25421
- "isOptional": true
25422
25170
  }
25423
25171
  ],
25424
25172
  "name": "createMoreRowsMessage"
@@ -25491,9 +25239,8 @@
25491
25239
  "text": ", params?: "
25492
25240
  },
25493
25241
  {
25494
- "kind": "Reference",
25495
- "text": "RequestParams",
25496
- "canonicalReference": "@genesislcap/foundation-comms!RequestParams:type"
25242
+ "kind": "Content",
25243
+ "text": "any"
25497
25244
  },
25498
25245
  {
25499
25246
  "kind": "Content",
@@ -26031,7 +25778,7 @@
26031
25778
  },
26032
25779
  {
26033
25780
  "kind": "Content",
26034
- "text": "{\n SOURCE_REF: string;\n VIEW_NUMBER?: number;\n }"
25781
+ "text": "{\n SOURCE_REF: string;\n }"
26035
25782
  },
26036
25783
  {
26037
25784
  "kind": "Content",
@@ -26588,16 +26335,7 @@
26588
26335
  },
26589
26336
  {
26590
26337
  "kind": "Content",
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?: "
26338
+ "text": "{\n FIELD?: "
26601
26339
  },
26602
26340
  {
26603
26341
  "kind": "Reference",
@@ -26606,16 +26344,16 @@
26606
26344
  },
26607
26345
  {
26608
26346
  "kind": "Content",
26609
- "text": "[];\n REPLY?: "
26347
+ "text": "[];\n INDEXES?: "
26610
26348
  },
26611
26349
  {
26612
26350
  "kind": "Reference",
26613
- "text": "ReplyDetail",
26614
- "canonicalReference": "@genesislcap/foundation-comms!ReplyDetail:type"
26351
+ "text": "IndexDetail",
26352
+ "canonicalReference": "@genesislcap/foundation-comms!IndexDetail:type"
26615
26353
  },
26616
26354
  {
26617
26355
  "kind": "Content",
26618
- "text": ";\n REPLY_FIELD?: "
26356
+ "text": "[];\n REPLY_FIELD?: "
26619
26357
  },
26620
26358
  {
26621
26359
  "kind": "Reference",
@@ -26633,16 +26371,7 @@
26633
26371
  },
26634
26372
  {
26635
26373
  "kind": "Content",
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}"
26374
+ "text": "[];\n NAME?: string;\n TYPE?: string;\n ERROR?: string;\n}"
26646
26375
  },
26647
26376
  {
26648
26377
  "kind": "Content",
@@ -26654,7 +26383,7 @@
26654
26383
  "name": "Metadata",
26655
26384
  "typeTokenRange": {
26656
26385
  "startIndex": 1,
26657
- "endIndex": 14
26386
+ "endIndex": 10
26658
26387
  }
26659
26388
  },
26660
26389
  {
@@ -26880,7 +26609,7 @@
26880
26609
  },
26881
26610
  {
26882
26611
  "kind": "Content",
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}"
26612
+ "text": "{\n NAME: string;\n TYPE: string;\n VALID_VALUES?: string;\n READ_ONLY?: boolean;\n OPTIONAL?: boolean;\n UI_LABEL?: string;\n}"
26884
26613
  },
26885
26614
  {
26886
26615
  "kind": "Content",
@@ -28233,76 +27962,6 @@
28233
27962
  "endIndex": 2
28234
27963
  }
28235
27964
  },
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
- },
28306
27965
  {
28307
27966
  "kind": "TypeAlias",
28308
27967
  "canonicalReference": "@genesislcap/foundation-comms!RequestParams:type",
@@ -28314,16 +27973,7 @@
28314
27973
  },
28315
27974
  {
28316
27975
  "kind": "Content",
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}"
27976
+ "text": "{\n DETAILS?: any;\n REQUEST?: any;\n}"
28327
27977
  },
28328
27978
  {
28329
27979
  "kind": "Content",
@@ -28335,7 +27985,7 @@
28335
27985
  "name": "RequestParams",
28336
27986
  "typeTokenRange": {
28337
27987
  "startIndex": 1,
28338
- "endIndex": 4
27988
+ "endIndex": 2
28339
27989
  }
28340
27990
  },
28341
27991
  {
@@ -28349,7 +27999,7 @@
28349
27999
  },
28350
28000
  {
28351
28001
  "kind": "Content",
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}"
28002
+ "text": "{\n SOURCE_REF?: string;\n REPLY: any[];\n MESSAGE_TYPE?: string;\n}"
28353
28003
  },
28354
28004
  {
28355
28005
  "kind": "Content",