@genesislcap/foundation-comms 14.199.0 → 14.199.2-alpha-6f7195d.0
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/dts/connect/connect.d.ts +2 -2
- package/dist/dts/connect/connect.d.ts.map +1 -1
- package/dist/dts/connect/message.d.ts +12 -4
- package/dist/dts/connect/message.d.ts.map +1 -1
- package/dist/dts/datasource/datasource.d.ts +18 -16
- package/dist/dts/datasource/datasource.d.ts.map +1 -1
- package/dist/dts/datasource/datasource.types.d.ts +37 -17
- package/dist/dts/datasource/datasource.types.d.ts.map +1 -1
- package/dist/dts/metadata/metadata.types.d.ts +23 -1
- package/dist/dts/metadata/metadata.types.d.ts.map +1 -1
- package/dist/dts/testing/mocks/datasource/datasource.d.ts +3 -2
- package/dist/dts/testing/mocks/datasource/datasource.d.ts.map +1 -1
- package/dist/esm/connect/connect.js +2 -2
- package/dist/esm/connect/message.js +2 -1
- package/dist/esm/datasource/datasource.js +58 -33
- package/dist/esm/metadata/metadata.utils.js +2 -1
- package/dist/esm/testing/mocks/datasource/datasource.js +9 -2
- package/dist/foundation-comms.api.json +458 -108
- package/dist/foundation-comms.d.ts +97 -42
- package/docs/api/foundation-comms.connect.getmorerows.md +2 -1
- package/docs/api/foundation-comms.connect.md +1 -1
- package/docs/api/foundation-comms.datasource.destroy.md +5 -1
- package/docs/api/foundation-comms.datasource.init.md +2 -1
- package/docs/api/foundation-comms.datasource.md +4 -4
- package/docs/api/foundation-comms.datasource.snapshot.md +3 -3
- package/docs/api/foundation-comms.datasource.snapshotfiltered.md +2 -2
- package/docs/api/{foundation-comms.datasource.deinit.md → foundation-comms.datasource.startstream.md} +5 -9
- package/docs/api/foundation-comms.datasource.validresourcename.md +5 -0
- package/docs/api/foundation-comms.datasourceoptions.criteria.md +5 -0
- package/docs/api/foundation-comms.datasourceoptions.disablepolling.md +5 -0
- package/docs/api/foundation-comms.datasourceoptions.fields.md +5 -0
- package/docs/api/foundation-comms.datasourceoptions.maxrows.md +5 -0
- package/docs/api/foundation-comms.datasourceoptions.maxview.md +5 -0
- package/docs/api/foundation-comms.datasourceoptions.md +2 -0
- package/docs/api/foundation-comms.datasourceoptions.movingview.md +5 -0
- package/docs/api/foundation-comms.datasourceoptions.orderby.md +5 -0
- package/docs/api/foundation-comms.datasourceoptions.request.md +5 -0
- package/docs/api/foundation-comms.datasourceoptions.requestautosetup.md +18 -0
- package/docs/api/foundation-comms.datasourceoptions.reverse.md +5 -0
- package/docs/api/foundation-comms.datasourceoptions.viewnumber.md +18 -0
- package/docs/api/foundation-comms.defaultconnect.getmorerows.md +2 -1
- package/docs/api/foundation-comms.defaultconnect.md +1 -1
- package/docs/api/foundation-comms.defaultdatasource.destroy.md +5 -1
- package/docs/api/foundation-comms.defaultdatasource.init.md +2 -1
- package/docs/api/foundation-comms.defaultdatasource.md +5 -4
- package/docs/api/foundation-comms.defaultdatasource.snapshot.md +8 -1
- package/docs/api/{foundation-comms.defaultdatasource.deinit.md → foundation-comms.defaultdatasource.startstream.md} +4 -4
- package/docs/api/foundation-comms.defaultdatasource.startstreamrequired.md +12 -0
- package/docs/api/foundation-comms.defaultmessagebuilder.createmorerowsmessage.md +3 -2
- package/docs/api/foundation-comms.defaultmessagebuilder.md +1 -1
- package/docs/api/foundation-comms.md +2 -0
- package/docs/api/foundation-comms.messagebuilder.createmorerowsmessage.md +3 -2
- package/docs/api/foundation-comms.messagebuilder.createrequestmessage.md +2 -2
- package/docs/api/foundation-comms.messagebuilder.md +1 -1
- package/docs/api/foundation-comms.messagedetails.morerows.md +1 -0
- package/docs/api/foundation-comms.metadata.md +5 -2
- package/docs/api/foundation-comms.metadatadetail.md +3 -0
- package/docs/api/foundation-comms.replydetail.md +21 -0
- package/docs/api/foundation-comms.requestdetailsparam.md +15 -0
- package/docs/api/foundation-comms.requestparams.md +3 -1
- package/docs/api/foundation-comms.requestserverresult.md +5 -0
- package/docs/api-report.md +54 -18
- package/package.json +13 -13
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
## DefaultDatasource.destroy() method
|
6
6
|
|
7
|
-
|
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
|
|
@@ -37,6 +37,7 @@ export declare class DefaultDatasource implements Datasource
|
|
37
37
|
| [requestFields](./foundation-comms.defaultdatasource.requestfields.md) | | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | |
|
38
38
|
| [resources](./foundation-comms.defaultdatasource.resources.md) | <code>protected</code> | [GenesisResources](./foundation-comms.genesisresources.md) | |
|
39
39
|
| [resourceType](./foundation-comms.defaultdatasource.resourcetype.md) | | [ResourceType](./foundation-comms.resourcetype.md) | |
|
40
|
+
| [startStreamRequired](./foundation-comms.defaultdatasource.startstreamrequired.md) | | boolean | |
|
40
41
|
| [status](./foundation-comms.defaultdatasource.status.md) | | [DatasourceStatus](./foundation-comms.datasourcestatus.md) | |
|
41
42
|
| [stream](./foundation-comms.defaultdatasource.stream.md) | | [SocketObservable](./foundation-comms.socketobservable.md)<!-- --><[FilteredDataServerResult](./foundation-comms.filtereddataserverresult.md) \| [RequestServerResult](./foundation-comms.requestserverresult.md)<!-- -->> | |
|
42
43
|
|
@@ -44,11 +45,11 @@ export declare class DefaultDatasource implements Datasource
|
|
44
45
|
|
45
46
|
| Method | Modifiers | Description |
|
46
47
|
| --- | --- | --- |
|
47
|
-
| [
|
48
|
-
| [destroy()](./foundation-comms.defaultdatasource.destroy.md) | | Destroy the datasource. |
|
48
|
+
| [destroy()](./foundation-comms.defaultdatasource.destroy.md) | | Destroys the datasource. |
|
49
49
|
| [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) | | |
|
50
|
+
| [init(options, fetchMeta, startStream)](./foundation-comms.defaultdatasource.init.md) | | |
|
51
|
+
| [snapshot(overrideParams)](./foundation-comms.defaultdatasource.snapshot.md) | | |
|
52
52
|
| [snapshotFiltered(rowId)](./foundation-comms.defaultdatasource.snapshotfiltered.md) | | |
|
53
|
+
| [startStream()](./foundation-comms.defaultdatasource.startstream.md) | | |
|
53
54
|
| [validResourceName(resourceName)](./foundation-comms.defaultdatasource.validresourcename.md) | | |
|
54
55
|
|
@@ -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<[Message](./foundation-comms.message.md)<!-- -->>
|
@@ -1,15 +1,15 @@
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
2
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DefaultDatasource](./foundation-comms.defaultdatasource.md) > [
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DefaultDatasource](./foundation-comms.defaultdatasource.md) > [startStream](./foundation-comms.defaultdatasource.startstream.md)
|
4
4
|
|
5
|
-
## DefaultDatasource.
|
5
|
+
## DefaultDatasource.startStream() method
|
6
6
|
|
7
7
|
**Signature:**
|
8
8
|
|
9
9
|
```typescript
|
10
|
-
|
10
|
+
startStream(): Promise<void>;
|
11
11
|
```
|
12
12
|
**Returns:**
|
13
13
|
|
14
|
-
void
|
14
|
+
Promise<void>
|
15
15
|
|
@@ -0,0 +1,12 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DefaultDatasource](./foundation-comms.defaultdatasource.md) > [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)<!-- --><[MessageDetails.MoreRows](./foundation-comms.messagedetails.morerows.md)<!-- -->>
|
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,7 +9,7 @@ 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
|
@@ -17,10 +17,11 @@ createMoreRowsMessage(sourceRef: string): Message;
|
|
17
17
|
| Parameter | Type | Description |
|
18
18
|
| --- | --- | --- |
|
19
19
|
| sourceRef | string | The source reference. |
|
20
|
+
| viewNumber | number | _(Optional)_ |
|
20
21
|
|
21
22
|
**Returns:**
|
22
23
|
|
23
|
-
[Message](./foundation-comms.message.md)
|
24
|
+
[Message](./foundation-comms.message.md)<!-- --><[MessageDetails.MoreRows](./foundation-comms.messagedetails.morerows.md)<!-- -->>
|
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?:
|
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 |
|
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. |
|
@@ -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
|
-
|
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) > [@genesislcap/foundation-comms](./foundation-comms.md) > [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) > [@genesislcap/foundation-comms](./foundation-comms.md) > [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
|
+
|
package/docs/api-report.md
CHANGED
@@ -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(
|
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
|
|
@@ -818,9 +819,11 @@ export class DatasourceMock implements Datasource {
|
|
818
819
|
setMetadata(meta: Metadata): void;
|
819
820
|
setStream(message: Message): void;
|
820
821
|
// (undocumented)
|
821
|
-
snapshot(params?: any):
|
822
|
+
snapshot(params?: any): Promise<Message<any>>;
|
822
823
|
// (undocumented)
|
823
|
-
snapshotFiltered(rowId?: string):
|
824
|
+
snapshotFiltered(rowId?: string): Promise<any[]>;
|
825
|
+
// (undocumented)
|
826
|
+
startStream(): Promise<void>;
|
824
827
|
// (undocumented)
|
825
828
|
status: DatasourceStatus;
|
826
829
|
// (undocumented)
|
@@ -849,8 +852,10 @@ export interface DatasourceOptions {
|
|
849
852
|
orderBy?: string;
|
850
853
|
pollingInterval?: number;
|
851
854
|
request?: any;
|
855
|
+
requestAutoSetup?: boolean;
|
852
856
|
resourceName?: string;
|
853
857
|
reverse?: boolean;
|
858
|
+
viewNumber?: number;
|
854
859
|
}
|
855
860
|
|
856
861
|
// @public
|
@@ -927,7 +932,7 @@ export class DefaultConnect implements Connect {
|
|
927
932
|
// (undocumented)
|
928
933
|
getMoreColumns(sourceRef: string): Promise<Message>;
|
929
934
|
// (undocumented)
|
930
|
-
getMoreRows(sourceRef: string): Promise<Message>;
|
935
|
+
getMoreRows(sourceRef: string, viewNumber?: number): Promise<Message>;
|
931
936
|
// (undocumented)
|
932
937
|
get host(): string;
|
933
938
|
// (undocumented)
|
@@ -1079,8 +1084,6 @@ export class DefaultDatasource implements Datasource {
|
|
1079
1084
|
protected config: DatasourceConfig;
|
1080
1085
|
// (undocumented)
|
1081
1086
|
protected connect: Connect;
|
1082
|
-
// (undocumented)
|
1083
|
-
deinit(): void;
|
1084
1087
|
// 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
1088
|
//
|
1086
1089
|
// (undocumented)
|
@@ -1092,7 +1095,7 @@ export class DefaultDatasource implements Datasource {
|
|
1092
1095
|
// (undocumented)
|
1093
1096
|
fieldMetadata: FieldMetadata[];
|
1094
1097
|
// (undocumented)
|
1095
|
-
init(options: DatasourceOptions, fetchMeta?: boolean): Promise<boolean>;
|
1098
|
+
init(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
|
1096
1099
|
// 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
1100
|
//
|
1098
1101
|
// (undocumented)
|
@@ -1116,9 +1119,15 @@ export class DefaultDatasource implements Datasource {
|
|
1116
1119
|
// (undocumented)
|
1117
1120
|
resourceType: ResourceType;
|
1118
1121
|
// (undocumented)
|
1119
|
-
snapshot(): Promise<Message>;
|
1122
|
+
snapshot(overrideParams?: any): Promise<Message>;
|
1120
1123
|
// (undocumented)
|
1121
1124
|
snapshotFiltered(rowId?: string): Promise<any[]>;
|
1125
|
+
// (undocumented)
|
1126
|
+
startStream(): Promise<void>;
|
1127
|
+
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: No member was found with name "startStream"
|
1128
|
+
//
|
1129
|
+
// (undocumented)
|
1130
|
+
startStreamRequired: boolean;
|
1122
1131
|
// 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
1132
|
//
|
1124
1133
|
// (undocumented)
|
@@ -1326,7 +1335,7 @@ export class DefaultMessageBuilder implements MessageBuilder {
|
|
1326
1335
|
// (undocumented)
|
1327
1336
|
createMoreColumnsMessage(sourceRef: string): Message;
|
1328
1337
|
// (undocumented)
|
1329
|
-
createMoreRowsMessage(sourceRef: string): Message
|
1338
|
+
createMoreRowsMessage(sourceRef: string, viewNumber?: number): Message<MessageDetails.MoreRows>;
|
1330
1339
|
// (undocumented)
|
1331
1340
|
createRefreshTokenMessage(): Message<MessageDetails.RefreshToken>;
|
1332
1341
|
// (undocumented)
|
@@ -1967,9 +1976,9 @@ export interface MessageBuilder {
|
|
1967
1976
|
createLogoutMessage(loginResult?: LoginResult): Message;
|
1968
1977
|
createMetaRequestMessage(resourceName: string, messageType?: EventMessageType): Message<MessageDetails.MetaRequest>;
|
1969
1978
|
createMoreColumnsMessage(sourceRef: string): Message;
|
1970
|
-
createMoreRowsMessage(sourceRef: string): Message
|
1979
|
+
createMoreRowsMessage(sourceRef: string, viewNumber?: number): Message<MessageDetails.MoreRows>;
|
1971
1980
|
createRefreshTokenMessage(): Message<MessageDetails.RefreshToken>;
|
1972
|
-
createRequestMessage<T = any>(resourceName: string, params?:
|
1981
|
+
createRequestMessage<T = any>(resourceName: string, params?: RequestParams): Message<T>;
|
1973
1982
|
createResourcesMessage<T = any>(params?: any): Message<T>;
|
1974
1983
|
}
|
1975
1984
|
|
@@ -2035,6 +2044,7 @@ export namespace MessageDetails {
|
|
2035
2044
|
};
|
2036
2045
|
export type MoreRows = {
|
2037
2046
|
SOURCE_REF: string;
|
2047
|
+
VIEW_NUMBER?: number;
|
2038
2048
|
};
|
2039
2049
|
export type RefreshToken = {
|
2040
2050
|
REFRESH_AUTH_TOKEN: string;
|
@@ -2105,12 +2115,15 @@ export const MetaCache: InterfaceSymbol<MetaCache>;
|
|
2105
2115
|
|
2106
2116
|
// @public
|
2107
2117
|
export type Metadata = {
|
2118
|
+
DEFINITIONS?: Record<string, any>;
|
2119
|
+
DESCRIPTION?: string;
|
2108
2120
|
FIELD?: MetadataDetail[];
|
2109
|
-
|
2121
|
+
REPLY?: ReplyDetail;
|
2110
2122
|
REPLY_FIELD?: MetadataDetail[];
|
2111
2123
|
REQUEST_FIELD?: MetadataDetail[];
|
2112
2124
|
NAME?: string;
|
2113
2125
|
TYPE?: string;
|
2126
|
+
INDEXES?: IndexDetail[];
|
2114
2127
|
ERROR?: string;
|
2115
2128
|
};
|
2116
2129
|
|
@@ -2126,9 +2139,12 @@ export interface MetadataCache {
|
|
2126
2139
|
export type MetadataDetail = {
|
2127
2140
|
NAME: string;
|
2128
2141
|
TYPE: string;
|
2142
|
+
DESCRIPTION?: string;
|
2143
|
+
JSON_TYPE?: string;
|
2129
2144
|
VALID_VALUES?: string;
|
2130
2145
|
READ_ONLY?: boolean;
|
2131
2146
|
OPTIONAL?: boolean;
|
2147
|
+
NULLABLE?: boolean;
|
2132
2148
|
UI_LABEL?: string;
|
2133
2149
|
};
|
2134
2150
|
|
@@ -2257,9 +2273,24 @@ export type RefreshCredentialsInput = {
|
|
2257
2273
|
mfaToken?: string;
|
2258
2274
|
};
|
2259
2275
|
|
2276
|
+
// @public
|
2277
|
+
export type ReplyDetail = {
|
2278
|
+
DEFINITIONS?: Record<string, any>;
|
2279
|
+
DESCRIPTION?: string;
|
2280
|
+
FIELD: MetadataDetail[];
|
2281
|
+
NAME: string;
|
2282
|
+
[key: string]: any;
|
2283
|
+
};
|
2284
|
+
|
2285
|
+
// @public (undocumented)
|
2286
|
+
export type RequestDetailsParam = {
|
2287
|
+
MAX_ROWS?: number;
|
2288
|
+
CRITERIA_MATCH?: string;
|
2289
|
+
};
|
2290
|
+
|
2260
2291
|
// @public
|
2261
2292
|
export type RequestParams = {
|
2262
|
-
DETAILS?: any;
|
2293
|
+
DETAILS?: RequestDetailsParam | any;
|
2263
2294
|
REQUEST?: any;
|
2264
2295
|
};
|
2265
2296
|
|
@@ -2268,6 +2299,11 @@ export type RequestServerResult = {
|
|
2268
2299
|
SOURCE_REF?: string;
|
2269
2300
|
REPLY: any[];
|
2270
2301
|
MESSAGE_TYPE?: string;
|
2302
|
+
MORE_ROWS?: boolean;
|
2303
|
+
NEXT_VIEW?: number;
|
2304
|
+
PARAMETRIC_TYPE?: string;
|
2305
|
+
ROWS_COUNT?: number;
|
2306
|
+
SEQUENCE_ID?: number;
|
2271
2307
|
};
|
2272
2308
|
|
2273
2309
|
// @public
|
@@ -2693,7 +2729,7 @@ export const WSConnect: InterfaceSymbol<Connect>;
|
|
2693
2729
|
|
2694
2730
|
// Warnings were encountered during analysis:
|
2695
2731
|
//
|
2696
|
-
// src/connect/message.ts:
|
2732
|
+
// 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
2733
|
|
2698
2734
|
// (No @packageDocumentation comment for this package)
|
2699
2735
|
|
package/package.json
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
{
|
2
2
|
"name": "@genesislcap/foundation-comms",
|
3
3
|
"description": "Genesis Foundation UI Comms",
|
4
|
-
"version": "14.199.0",
|
4
|
+
"version": "14.199.2-alpha-6f7195d.0",
|
5
5
|
"sideEffects": false,
|
6
6
|
"license": "SEE LICENSE IN license.txt",
|
7
7
|
"main": "dist/esm/index.js",
|
@@ -75,23 +75,23 @@
|
|
75
75
|
}
|
76
76
|
},
|
77
77
|
"devDependencies": {
|
78
|
-
"@genesislcap/foundation-testing": "14.199.0",
|
79
|
-
"@genesislcap/genx": "14.199.0",
|
80
|
-
"@genesislcap/rollup-builder": "14.199.0",
|
81
|
-
"@genesislcap/ts-builder": "14.199.0",
|
82
|
-
"@genesislcap/uvu-playwright-builder": "14.199.0",
|
83
|
-
"@genesislcap/vite-builder": "14.199.0",
|
84
|
-
"@genesislcap/webpack-builder": "14.199.0",
|
78
|
+
"@genesislcap/foundation-testing": "14.199.2-alpha-6f7195d.0",
|
79
|
+
"@genesislcap/genx": "14.199.2-alpha-6f7195d.0",
|
80
|
+
"@genesislcap/rollup-builder": "14.199.2-alpha-6f7195d.0",
|
81
|
+
"@genesislcap/ts-builder": "14.199.2-alpha-6f7195d.0",
|
82
|
+
"@genesislcap/uvu-playwright-builder": "14.199.2-alpha-6f7195d.0",
|
83
|
+
"@genesislcap/vite-builder": "14.199.2-alpha-6f7195d.0",
|
84
|
+
"@genesislcap/webpack-builder": "14.199.2-alpha-6f7195d.0",
|
85
85
|
"@types/js-cookie": "^3.0.2",
|
86
86
|
"@types/json-schema": "^7.0.11",
|
87
87
|
"@types/webappsec-credential-management": "^0.6.2",
|
88
88
|
"rimraf": "^5.0.0"
|
89
89
|
},
|
90
90
|
"dependencies": {
|
91
|
-
"@genesislcap/foundation-broadcast-channel": "14.199.0",
|
92
|
-
"@genesislcap/foundation-logger": "14.199.0",
|
93
|
-
"@genesislcap/foundation-user": "14.199.0",
|
94
|
-
"@genesislcap/foundation-utils": "14.199.0",
|
91
|
+
"@genesislcap/foundation-broadcast-channel": "14.199.2-alpha-6f7195d.0",
|
92
|
+
"@genesislcap/foundation-logger": "14.199.2-alpha-6f7195d.0",
|
93
|
+
"@genesislcap/foundation-user": "14.199.2-alpha-6f7195d.0",
|
94
|
+
"@genesislcap/foundation-utils": "14.199.2-alpha-6f7195d.0",
|
95
95
|
"@microsoft/fast-element": "^1.12.0",
|
96
96
|
"@microsoft/fast-foundation": "^2.49.4",
|
97
97
|
"analytics": "^0.8.0",
|
@@ -111,5 +111,5 @@
|
|
111
111
|
"publishConfig": {
|
112
112
|
"access": "public"
|
113
113
|
},
|
114
|
-
"gitHead": "
|
114
|
+
"gitHead": "15fcb453901f08beb9be68476f15db6f3892fde5"
|
115
115
|
}
|