@genesislcap/foundation-comms 14.201.0 → 14.202.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (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
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DatasourceOptions](./foundation-comms.datasourceoptions.md) &gt; [viewNumber](./foundation-comms.datasourceoptions.viewnumber.md)
4
+
5
+ ## DatasourceOptions.viewNumber property
6
+
7
+ The current page/"view" number being displayed.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ viewNumber?: number;
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ Works with both DATASERVER and REQUEST\_SERVER resources.
18
+
@@ -7,7 +7,7 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- getMoreRows(sourceRef: string): Promise<Message>;
10
+ getMoreRows(sourceRef: string, viewNumber?: number): Promise<Message>;
11
11
  ```
12
12
 
13
13
  ## Parameters
@@ -15,6 +15,7 @@ getMoreRows(sourceRef: string): Promise<Message>;
15
15
  | Parameter | Type | Description |
16
16
  | --- | --- | --- |
17
17
  | sourceRef | string | |
18
+ | viewNumber | number | _(Optional)_ |
18
19
 
19
20
  **Returns:**
20
21
 
@@ -42,7 +42,7 @@ export declare class DefaultConnect implements Connect
42
42
  | [getJSONSchema(resourceName, useCache)](./foundation-comms.defaultconnect.getjsonschema.md) | | |
43
43
  | [getMetadata(resourceName, useCache)](./foundation-comms.defaultconnect.getmetadata.md) | | |
44
44
  | [getMoreColumns(sourceRef)](./foundation-comms.defaultconnect.getmorecolumns.md) | | |
45
- | [getMoreRows(sourceRef)](./foundation-comms.defaultconnect.getmorerows.md) | | |
45
+ | [getMoreRows(sourceRef, viewNumber)](./foundation-comms.defaultconnect.getmorerows.md) | | |
46
46
  | [httpMode()](./foundation-comms.defaultconnect.httpmode.md) | | |
47
47
  | [request(resourceName, params)](./foundation-comms.defaultconnect.request.md) | | |
48
48
  | [send(message, needsHandling)](./foundation-comms.defaultconnect.send.md) | | |
@@ -0,0 +1,12 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultDatasource](./foundation-comms.defaultdatasource.md) &gt; [customRequestFields](./foundation-comms.defaultdatasource.customrequestfields.md)
4
+
5
+ ## DefaultDatasource.customRequestFields property
6
+
7
+
8
+ **Signature:**
9
+
10
+ ```typescript
11
+ customRequestFields: MetadataDetail[];
12
+ ```
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## DefaultDatasource.destroy() method
6
6
 
7
- Destroy the datasource.
7
+ Destroys the datasource.
8
8
 
9
9
  **Signature:**
10
10
 
@@ -15,3 +15,7 @@ destroy(): void;
15
15
 
16
16
  void
17
17
 
18
+ ## Remarks
19
+
20
+ This should be called to clean up any resources when the datasource is no longer needed.
21
+
@@ -7,7 +7,7 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- init(options: DatasourceOptions, fetchMeta?: boolean): Promise<boolean>;
10
+ init(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
11
11
  ```
12
12
 
13
13
  ## Parameters
@@ -16,6 +16,7 @@ init(options: DatasourceOptions, fetchMeta?: boolean): Promise<boolean>;
16
16
  | --- | --- | --- |
17
17
  | options | [DatasourceOptions](./foundation-comms.datasourceoptions.md) | |
18
18
  | fetchMeta | boolean | _(Optional)_ |
19
+ | startStream | boolean | _(Optional)_ |
19
20
 
20
21
  **Returns:**
21
22
 
@@ -27,6 +27,7 @@ export declare class DefaultDatasource implements Datasource
27
27
  | [availableIndexes](./foundation-comms.defaultdatasource.availableindexes.md) | | [IndexDetail](./foundation-comms.indexdetail.md)<!-- -->\[\] | |
28
28
  | [config](./foundation-comms.defaultdatasource.config.md) | <code>protected</code> | [DatasourceConfig](./foundation-comms.datasourceconfig.md) | |
29
29
  | [connect](./foundation-comms.defaultdatasource.connect.md) | <code>protected</code> | [Connect](./foundation-comms.connect.md) | |
30
+ | [customRequestFields](./foundation-comms.defaultdatasource.customrequestfields.md) | | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | |
30
31
  | [fetchMetadataRequired](./foundation-comms.defaultdatasource.fetchmetadatarequired.md) | | boolean | |
31
32
  | [fieldMetadata](./foundation-comms.defaultdatasource.fieldmetadata.md) | | [FieldMetadata](./foundation-comms.fieldmetadata.md)<!-- -->\[\] | |
32
33
  | [initialized](./foundation-comms.defaultdatasource.initialized.md) | <code>readonly</code> | boolean | Indicates whether the datasource has been initialized. |
@@ -37,6 +38,7 @@ export declare class DefaultDatasource implements Datasource
37
38
  | [requestFields](./foundation-comms.defaultdatasource.requestfields.md) | | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | |
38
39
  | [resources](./foundation-comms.defaultdatasource.resources.md) | <code>protected</code> | [GenesisResources](./foundation-comms.genesisresources.md) | |
39
40
  | [resourceType](./foundation-comms.defaultdatasource.resourcetype.md) | | [ResourceType](./foundation-comms.resourcetype.md) | |
41
+ | [startStreamRequired](./foundation-comms.defaultdatasource.startstreamrequired.md) | | boolean | |
40
42
  | [status](./foundation-comms.defaultdatasource.status.md) | | [DatasourceStatus](./foundation-comms.datasourcestatus.md) | |
41
43
  | [stream](./foundation-comms.defaultdatasource.stream.md) | | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;[FilteredDataServerResult](./foundation-comms.filtereddataserverresult.md) \| [RequestServerResult](./foundation-comms.requestserverresult.md)<!-- -->&gt; | |
42
44
 
@@ -44,11 +46,11 @@ export declare class DefaultDatasource implements Datasource
44
46
 
45
47
  | Method | Modifiers | Description |
46
48
  | --- | --- | --- |
47
- | [deinit()](./foundation-comms.defaultdatasource.deinit.md) | | |
48
- | [destroy()](./foundation-comms.defaultdatasource.destroy.md) | | Destroy the datasource. |
49
+ | [destroy()](./foundation-comms.defaultdatasource.destroy.md) | | Destroys the datasource. |
49
50
  | [fetchAndApplyMetadata(resourceName)](./foundation-comms.defaultdatasource.fetchandapplymetadata.md) | <code>protected</code> | |
50
- | [init(options, fetchMeta)](./foundation-comms.defaultdatasource.init.md) | | |
51
- | [snapshot()](./foundation-comms.defaultdatasource.snapshot.md) | | |
51
+ | [init(options, fetchMeta, startStream)](./foundation-comms.defaultdatasource.init.md) | | |
52
+ | [snapshot(overrideParams)](./foundation-comms.defaultdatasource.snapshot.md) | | |
52
53
  | [snapshotFiltered(rowId)](./foundation-comms.defaultdatasource.snapshotfiltered.md) | | |
54
+ | [startStream()](./foundation-comms.defaultdatasource.startstream.md) | | |
53
55
  | [validResourceName(resourceName)](./foundation-comms.defaultdatasource.validresourcename.md) | | |
54
56
 
@@ -7,8 +7,15 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- snapshot(): Promise<Message>;
10
+ snapshot(overrideParams?: any): Promise<Message>;
11
11
  ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | overrideParams | any | _(Optional)_ |
18
+
12
19
  **Returns:**
13
20
 
14
21
  Promise&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
@@ -1,15 +1,15 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultDatasource](./foundation-comms.defaultdatasource.md) &gt; [deinit](./foundation-comms.defaultdatasource.deinit.md)
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultDatasource](./foundation-comms.defaultdatasource.md) &gt; [startStream](./foundation-comms.defaultdatasource.startstream.md)
4
4
 
5
- ## DefaultDatasource.deinit() method
5
+ ## DefaultDatasource.startStream() method
6
6
 
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- deinit(): void;
10
+ startStream(): Promise<void>;
11
11
  ```
12
12
  **Returns:**
13
13
 
14
- void
14
+ Promise&lt;void&gt;
15
15
 
@@ -0,0 +1,12 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultDatasource](./foundation-comms.defaultdatasource.md) &gt; [startStreamRequired](./foundation-comms.defaultdatasource.startstreamrequired.md)
4
+
5
+ ## DefaultDatasource.startStreamRequired property
6
+
7
+
8
+ **Signature:**
9
+
10
+ ```typescript
11
+ startStreamRequired: boolean;
12
+ ```
@@ -7,7 +7,7 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- createMoreRowsMessage(sourceRef: string): Message;
10
+ createMoreRowsMessage(sourceRef: string, viewNumber?: number): Message<MessageDetails.MoreRows>;
11
11
  ```
12
12
 
13
13
  ## Parameters
@@ -15,8 +15,9 @@ createMoreRowsMessage(sourceRef: string): Message;
15
15
  | Parameter | Type | Description |
16
16
  | --- | --- | --- |
17
17
  | sourceRef | string | |
18
+ | viewNumber | number | _(Optional)_ |
18
19
 
19
20
  **Returns:**
20
21
 
21
- [Message](./foundation-comms.message.md)
22
+ [Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.MoreRows](./foundation-comms.messagedetails.morerows.md)<!-- -->&gt;
22
23
 
@@ -35,7 +35,7 @@ export declare class DefaultMessageBuilder implements MessageBuilder
35
35
  | [createLogoutMessage(loginResult)](./foundation-comms.defaultmessagebuilder.createlogoutmessage.md) | | |
36
36
  | [createMetaRequestMessage(resourceName, messageType)](./foundation-comms.defaultmessagebuilder.createmetarequestmessage.md) | | |
37
37
  | [createMoreColumnsMessage(sourceRef)](./foundation-comms.defaultmessagebuilder.createmorecolumnsmessage.md) | | |
38
- | [createMoreRowsMessage(sourceRef)](./foundation-comms.defaultmessagebuilder.createmorerowsmessage.md) | | |
38
+ | [createMoreRowsMessage(sourceRef, viewNumber)](./foundation-comms.defaultmessagebuilder.createmorerowsmessage.md) | | |
39
39
  | [createRefreshTokenMessage()](./foundation-comms.defaultmessagebuilder.createrefreshtokenmessage.md) | | |
40
40
  | [createRequestMessage(resourceName, params)](./foundation-comms.defaultmessagebuilder.createrequestmessage.md) | | |
41
41
  | [createResourcesMessage(params)](./foundation-comms.defaultmessagebuilder.createresourcesmessage.md) | | |
@@ -177,6 +177,8 @@
177
177
  | [RawDataServerResult](./foundation-comms.rawdataserverresult.md) | Raw result from a DATASERVER data fetch. |
178
178
  | [RefreshAuthInfo](./foundation-comms.refreshauthinfo.md) | Represents refresh token authentication information. |
179
179
  | [RefreshCredentialsInput](./foundation-comms.refreshcredentialsinput.md) | Represents refresh credentials for a user. |
180
+ | [ReplyDetail](./foundation-comms.replydetail.md) | Reply Detail definition. |
181
+ | [RequestDetailsParam](./foundation-comms.requestdetailsparam.md) | |
180
182
  | [RequestParams](./foundation-comms.requestparams.md) | Parameters for a REQUEST message |
181
183
  | [RequestServerResult](./foundation-comms.requestserverresult.md) | Raw result from a REQUEST\_SERVER data fetch. |
182
184
  | [ResourceHealth](./foundation-comms.resourcehealth.md) | ResourceHealth. |
@@ -9,18 +9,19 @@ Creates a message to request more rows.
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- createMoreRowsMessage(sourceRef: string): Message;
12
+ createMoreRowsMessage(sourceRef: string, viewNumber?: number): Message<MessageDetails.MoreRows>;
13
13
  ```
14
14
 
15
15
  ## Parameters
16
16
 
17
17
  | Parameter | Type | Description |
18
18
  | --- | --- | --- |
19
- | sourceRef | string | The source reference. |
19
+ | sourceRef | string | The unique source reference. |
20
+ | viewNumber | number | _(Optional)_ The desired view number. Default:always the first view, if not spceified. |
20
21
 
21
22
  **Returns:**
22
23
 
23
- [Message](./foundation-comms.message.md)
24
+ [Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.MoreRows](./foundation-comms.messagedetails.morerows.md)<!-- -->&gt;
24
25
 
25
26
  The more rows message.
26
27
 
@@ -9,7 +9,7 @@ Creates a request message.
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- createRequestMessage<T = any>(resourceName: string, params?: any): Message<T>;
12
+ createRequestMessage<T = any>(resourceName: string, params?: RequestParams): Message<T>;
13
13
  ```
14
14
 
15
15
  ## Parameters
@@ -17,7 +17,7 @@ createRequestMessage<T = any>(resourceName: string, params?: any): Message<T>;
17
17
  | Parameter | Type | Description |
18
18
  | --- | --- | --- |
19
19
  | resourceName | string | The resource name. |
20
- | params | any | _(Optional)_ The additional parameters. |
20
+ | params | [RequestParams](./foundation-comms.requestparams.md) | _(Optional)_ The additional parameters. |
21
21
 
22
22
  **Returns:**
23
23
 
@@ -28,7 +28,7 @@ export interface MessageBuilder
28
28
  | [createLogoutMessage(loginResult)](./foundation-comms.messagebuilder.createlogoutmessage.md) | Creates a logout message. |
29
29
  | [createMetaRequestMessage(resourceName, messageType)](./foundation-comms.messagebuilder.createmetarequestmessage.md) | Creates a metadata fetch message. |
30
30
  | [createMoreColumnsMessage(sourceRef)](./foundation-comms.messagebuilder.createmorecolumnsmessage.md) | Creates a message to request more columns. |
31
- | [createMoreRowsMessage(sourceRef)](./foundation-comms.messagebuilder.createmorerowsmessage.md) | Creates a message to request more rows. |
31
+ | [createMoreRowsMessage(sourceRef, viewNumber)](./foundation-comms.messagebuilder.createmorerowsmessage.md) | Creates a message to request more rows. |
32
32
  | [createRefreshTokenMessage()](./foundation-comms.messagebuilder.createrefreshtokenmessage.md) | Creates an auth message specific for token refresh. |
33
33
  | [createRequestMessage(resourceName, params)](./foundation-comms.messagebuilder.createrequestmessage.md) | Creates a request message. |
34
34
  | [createResourcesMessage(params)](./foundation-comms.messagebuilder.createresourcesmessage.md) | Creates a message for getting list of resources. |
@@ -11,5 +11,6 @@ Details type to request more rows
11
11
  ```typescript
12
12
  type MoreRows = {
13
13
  SOURCE_REF: string;
14
+ VIEW_NUMBER?: number;
14
15
  };
15
16
  ```
@@ -10,14 +10,17 @@ Metadata definition for a given resource.
10
10
 
11
11
  ```typescript
12
12
  export type Metadata = {
13
+ DEFINITIONS?: Record<string, any>;
14
+ DESCRIPTION?: string;
13
15
  FIELD?: MetadataDetail[];
14
- INDEXES?: IndexDetail[];
16
+ REPLY?: ReplyDetail;
15
17
  REPLY_FIELD?: MetadataDetail[];
16
18
  REQUEST_FIELD?: MetadataDetail[];
17
19
  NAME?: string;
18
20
  TYPE?: string;
21
+ INDEXES?: IndexDetail[];
19
22
  ERROR?: string;
20
23
  };
21
24
  ```
22
- **References:** [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->, [IndexDetail](./foundation-comms.indexdetail.md)
25
+ **References:** [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->, [ReplyDetail](./foundation-comms.replydetail.md)<!-- -->, [IndexDetail](./foundation-comms.indexdetail.md)
23
26
 
@@ -12,9 +12,12 @@ Metadata Detail definition.
12
12
  export type MetadataDetail = {
13
13
  NAME: string;
14
14
  TYPE: string;
15
+ DESCRIPTION?: string;
16
+ JSON_TYPE?: string;
15
17
  VALID_VALUES?: string;
16
18
  READ_ONLY?: boolean;
17
19
  OPTIONAL?: boolean;
20
+ NULLABLE?: boolean;
18
21
  UI_LABEL?: string;
19
22
  };
20
23
  ```
@@ -0,0 +1,21 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [ReplyDetail](./foundation-comms.replydetail.md)
4
+
5
+ ## ReplyDetail type
6
+
7
+ Reply Detail definition.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type ReplyDetail = {
13
+ DEFINITIONS?: Record<string, any>;
14
+ DESCRIPTION?: string;
15
+ FIELD: MetadataDetail[];
16
+ NAME: string;
17
+ [key: string]: any;
18
+ };
19
+ ```
20
+ **References:** [MetadataDetail](./foundation-comms.metadatadetail.md)
21
+
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [RequestDetailsParam](./foundation-comms.requestdetailsparam.md)
4
+
5
+ ## RequestDetailsParam type
6
+
7
+
8
+ **Signature:**
9
+
10
+ ```typescript
11
+ export type RequestDetailsParam = {
12
+ MAX_ROWS?: number;
13
+ CRITERIA_MATCH?: string;
14
+ };
15
+ ```
@@ -10,7 +10,9 @@ Parameters for a REQUEST message
10
10
 
11
11
  ```typescript
12
12
  export type RequestParams = {
13
- DETAILS?: any;
13
+ DETAILS?: RequestDetailsParam | any;
14
14
  REQUEST?: any;
15
15
  };
16
16
  ```
17
+ **References:** [RequestDetailsParam](./foundation-comms.requestdetailsparam.md)
18
+
@@ -13,5 +13,10 @@ export type RequestServerResult = {
13
13
  SOURCE_REF?: string;
14
14
  REPLY: any[];
15
15
  MESSAGE_TYPE?: string;
16
+ MORE_ROWS?: boolean;
17
+ NEXT_VIEW?: number;
18
+ PARAMETRIC_TYPE?: string;
19
+ ROWS_COUNT?: number;
20
+ SEQUENCE_ID?: number;
16
21
  };
17
22
  ```
@@ -159,7 +159,7 @@ export interface Connect {
159
159
  getJSONSchema(resourceName: string): Promise<SchemaResponse>;
160
160
  getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
161
161
  getMoreColumns(sourceRef: string): Promise<Message>;
162
- getMoreRows(sourceRef: string): Promise<Message>;
162
+ getMoreRows(sourceRef: string, viewNumber?: number): Promise<Message>;
163
163
  // (undocumented)
164
164
  host: string;
165
165
  // @internal
@@ -381,23 +381,24 @@ export interface Datasource extends DatasourceMetadata {
381
381
  clearFilter?(name: string): Promise<void>;
382
382
  createItem?(data: any): Promise<string>;
383
383
  dataHandler?(data: Array<any>): Array<any>;
384
- deinit(): any;
385
384
  deleteItem?(itemId: string): Promise<void>;
386
385
  destroy(): void;
387
386
  dropView?(view: Dataview): void;
388
387
  getMetadata?(resourceName: string): Promise<Array<FieldMetadata>>;
389
- init(options: DatasourceOptions, fetchMeta?: boolean): Promise<boolean>;
388
+ init(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
390
389
  initialized: boolean;
391
390
  readOnly: boolean;
392
391
  resourceType: ResourceType;
393
392
  setFilter?(name: string, value: any, type?: string): Promise<void>;
394
- snapshot(params?: any): any;
395
- snapshotFiltered(rowId?: string): any;
393
+ snapshot(overrideParams?: any): Promise<Message>;
394
+ snapshotFiltered(rowId?: string): Promise<any[]>;
395
+ startStream(): Promise<void>;
396
396
  // (undocumented)
397
397
  status: Partial<DatasourceStatus>;
398
398
  stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
399
399
  updateData?(data: Array<any>): Promise<void>;
400
400
  updateItem?(itemId: string, data: any): Promise<void>;
401
+ // @deprecated
401
402
  validResourceName(resourceName: string): boolean;
402
403
  }
403
404
 
@@ -762,6 +763,8 @@ export interface DatasourceMetadata {
762
763
  // (undocumented)
763
764
  readonly availableIndexes: IndexDetail[];
764
765
  // (undocumented)
766
+ readonly customRequestFields: MetadataDetail[];
767
+ // (undocumented)
765
768
  fetchMetadataRequired: boolean;
766
769
  // (undocumented)
767
770
  readonly fieldMetadata: FieldMetadata[];
@@ -784,6 +787,8 @@ export class DatasourceMock implements Datasource {
784
787
  // (undocumented)
785
788
  createItem?(data: any): Promise<string>;
786
789
  // (undocumented)
790
+ customRequestFields: MetadataDetail[];
791
+ // (undocumented)
787
792
  dataHandler?(data: any[]): any[];
788
793
  // (undocumented)
789
794
  deinit(): void;
@@ -818,9 +823,11 @@ export class DatasourceMock implements Datasource {
818
823
  setMetadata(meta: Metadata): void;
819
824
  setStream(message: Message): void;
820
825
  // (undocumented)
821
- snapshot(params?: any): void;
826
+ snapshot(params?: any): Promise<Message<any>>;
827
+ // (undocumented)
828
+ snapshotFiltered(rowId?: string): Promise<any[]>;
822
829
  // (undocumented)
823
- snapshotFiltered(rowId?: string): void;
830
+ startStream(): Promise<void>;
824
831
  // (undocumented)
825
832
  status: DatasourceStatus;
826
833
  // (undocumented)
@@ -849,8 +856,10 @@ export interface DatasourceOptions {
849
856
  orderBy?: string;
850
857
  pollingInterval?: number;
851
858
  request?: any;
859
+ requestAutoSetup?: boolean;
852
860
  resourceName?: string;
853
861
  reverse?: boolean;
862
+ viewNumber?: number;
854
863
  }
855
864
 
856
865
  // @public
@@ -927,7 +936,7 @@ export class DefaultConnect implements Connect {
927
936
  // (undocumented)
928
937
  getMoreColumns(sourceRef: string): Promise<Message>;
929
938
  // (undocumented)
930
- getMoreRows(sourceRef: string): Promise<Message>;
939
+ getMoreRows(sourceRef: string, viewNumber?: number): Promise<Message>;
931
940
  // (undocumented)
932
941
  get host(): string;
933
942
  // (undocumented)
@@ -1080,7 +1089,7 @@ export class DefaultDatasource implements Datasource {
1080
1089
  // (undocumented)
1081
1090
  protected connect: Connect;
1082
1091
  // (undocumented)
1083
- deinit(): void;
1092
+ customRequestFields: MetadataDetail[];
1084
1093
  // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "Datasource" has more than one declaration; you need to add a TSDoc member reference selector
1085
1094
  //
1086
1095
  // (undocumented)
@@ -1092,7 +1101,7 @@ export class DefaultDatasource implements Datasource {
1092
1101
  // (undocumented)
1093
1102
  fieldMetadata: FieldMetadata[];
1094
1103
  // (undocumented)
1095
- init(options: DatasourceOptions, fetchMeta?: boolean): Promise<boolean>;
1104
+ init(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
1096
1105
  // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "Datasource" has more than one declaration; you need to add a TSDoc member reference selector
1097
1106
  //
1098
1107
  // (undocumented)
@@ -1116,9 +1125,15 @@ export class DefaultDatasource implements Datasource {
1116
1125
  // (undocumented)
1117
1126
  resourceType: ResourceType;
1118
1127
  // (undocumented)
1119
- snapshot(): Promise<Message>;
1128
+ snapshot(overrideParams?: any): Promise<Message>;
1120
1129
  // (undocumented)
1121
1130
  snapshotFiltered(rowId?: string): Promise<any[]>;
1131
+ // (undocumented)
1132
+ startStream(): Promise<void>;
1133
+ // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: No member was found with name "startStream"
1134
+ //
1135
+ // (undocumented)
1136
+ startStreamRequired: boolean;
1122
1137
  // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "Datasource" has more than one declaration; you need to add a TSDoc member reference selector
1123
1138
  //
1124
1139
  // (undocumented)
@@ -1326,7 +1341,7 @@ export class DefaultMessageBuilder implements MessageBuilder {
1326
1341
  // (undocumented)
1327
1342
  createMoreColumnsMessage(sourceRef: string): Message;
1328
1343
  // (undocumented)
1329
- createMoreRowsMessage(sourceRef: string): Message;
1344
+ createMoreRowsMessage(sourceRef: string, viewNumber?: number): Message<MessageDetails.MoreRows>;
1330
1345
  // (undocumented)
1331
1346
  createRefreshTokenMessage(): Message<MessageDetails.RefreshToken>;
1332
1347
  // (undocumented)
@@ -1967,9 +1982,9 @@ export interface MessageBuilder {
1967
1982
  createLogoutMessage(loginResult?: LoginResult): Message;
1968
1983
  createMetaRequestMessage(resourceName: string, messageType?: EventMessageType): Message<MessageDetails.MetaRequest>;
1969
1984
  createMoreColumnsMessage(sourceRef: string): Message;
1970
- createMoreRowsMessage(sourceRef: string): Message;
1985
+ createMoreRowsMessage(sourceRef: string, viewNumber?: number): Message<MessageDetails.MoreRows>;
1971
1986
  createRefreshTokenMessage(): Message<MessageDetails.RefreshToken>;
1972
- createRequestMessage<T = any>(resourceName: string, params?: any): Message<T>;
1987
+ createRequestMessage<T = any>(resourceName: string, params?: RequestParams): Message<T>;
1973
1988
  createResourcesMessage<T = any>(params?: any): Message<T>;
1974
1989
  }
1975
1990
 
@@ -2035,6 +2050,7 @@ export namespace MessageDetails {
2035
2050
  };
2036
2051
  export type MoreRows = {
2037
2052
  SOURCE_REF: string;
2053
+ VIEW_NUMBER?: number;
2038
2054
  };
2039
2055
  export type RefreshToken = {
2040
2056
  REFRESH_AUTH_TOKEN: string;
@@ -2105,12 +2121,15 @@ export const MetaCache: InterfaceSymbol<MetaCache>;
2105
2121
 
2106
2122
  // @public
2107
2123
  export type Metadata = {
2124
+ DEFINITIONS?: Record<string, any>;
2125
+ DESCRIPTION?: string;
2108
2126
  FIELD?: MetadataDetail[];
2109
- INDEXES?: IndexDetail[];
2127
+ REPLY?: ReplyDetail;
2110
2128
  REPLY_FIELD?: MetadataDetail[];
2111
2129
  REQUEST_FIELD?: MetadataDetail[];
2112
2130
  NAME?: string;
2113
2131
  TYPE?: string;
2132
+ INDEXES?: IndexDetail[];
2114
2133
  ERROR?: string;
2115
2134
  };
2116
2135
 
@@ -2126,9 +2145,12 @@ export interface MetadataCache {
2126
2145
  export type MetadataDetail = {
2127
2146
  NAME: string;
2128
2147
  TYPE: string;
2148
+ DESCRIPTION?: string;
2149
+ JSON_TYPE?: string;
2129
2150
  VALID_VALUES?: string;
2130
2151
  READ_ONLY?: boolean;
2131
2152
  OPTIONAL?: boolean;
2153
+ NULLABLE?: boolean;
2132
2154
  UI_LABEL?: string;
2133
2155
  };
2134
2156
 
@@ -2257,9 +2279,24 @@ export type RefreshCredentialsInput = {
2257
2279
  mfaToken?: string;
2258
2280
  };
2259
2281
 
2282
+ // @public
2283
+ export type ReplyDetail = {
2284
+ DEFINITIONS?: Record<string, any>;
2285
+ DESCRIPTION?: string;
2286
+ FIELD: MetadataDetail[];
2287
+ NAME: string;
2288
+ [key: string]: any;
2289
+ };
2290
+
2291
+ // @public (undocumented)
2292
+ export type RequestDetailsParam = {
2293
+ MAX_ROWS?: number;
2294
+ CRITERIA_MATCH?: string;
2295
+ };
2296
+
2260
2297
  // @public
2261
2298
  export type RequestParams = {
2262
- DETAILS?: any;
2299
+ DETAILS?: RequestDetailsParam | any;
2263
2300
  REQUEST?: any;
2264
2301
  };
2265
2302
 
@@ -2268,6 +2305,11 @@ export type RequestServerResult = {
2268
2305
  SOURCE_REF?: string;
2269
2306
  REPLY: any[];
2270
2307
  MESSAGE_TYPE?: string;
2308
+ MORE_ROWS?: boolean;
2309
+ NEXT_VIEW?: number;
2310
+ PARAMETRIC_TYPE?: string;
2311
+ ROWS_COUNT?: number;
2312
+ SEQUENCE_ID?: number;
2271
2313
  };
2272
2314
 
2273
2315
  // @public
@@ -2693,7 +2735,7 @@ export const WSConnect: InterfaceSymbol<Connect>;
2693
2735
 
2694
2736
  // Warnings were encountered during analysis:
2695
2737
  //
2696
- // src/connect/message.ts:289:3 - (ae-forgotten-export) The symbol "RESOURCE_DETAILS" needs to be exported by the entry point index.d.ts
2738
+ // src/connect/message.ts:290:3 - (ae-forgotten-export) The symbol "RESOURCE_DETAILS" needs to be exported by the entry point index.d.ts
2697
2739
 
2698
2740
  // (No @packageDocumentation comment for this package)
2699
2741