@genesislcap/foundation-comms 14.200.1-alpha-eb310c6.0 → 14.200.1-alpha-e974201.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 +3 -4
- package/dist/dts/connect/connect.d.ts.map +1 -1
- package/dist/dts/connect/message.d.ts +5 -14
- package/dist/dts/connect/message.d.ts.map +1 -1
- package/dist/dts/datasource/datasource.d.ts +16 -21
- package/dist/dts/datasource/datasource.d.ts.map +1 -1
- package/dist/dts/datasource/datasource.types.d.ts +17 -37
- package/dist/dts/datasource/datasource.types.d.ts.map +1 -1
- package/dist/dts/metadata/metadata.types.d.ts +1 -23
- package/dist/dts/metadata/metadata.types.d.ts.map +1 -1
- package/dist/dts/testing/mocks/datasource/datasource.d.ts +2 -4
- 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 +1 -2
- package/dist/esm/datasource/datasource.js +32 -63
- package/dist/esm/metadata/metadata.utils.js +1 -2
- package/dist/esm/testing/mocks/datasource/datasource.js +2 -14
- package/dist/foundation-comms.api.json +93 -510
- package/dist/foundation-comms.d.ts +44 -105
- package/docs/api/foundation-comms.connect.getmorerows.md +2 -3
- package/docs/api/foundation-comms.connect.md +1 -1
- package/docs/api/{foundation-comms.datasource.startstream.md → foundation-comms.datasource.deinit.md} +9 -5
- package/docs/api/foundation-comms.datasource.destroy.md +1 -5
- package/docs/api/foundation-comms.datasource.init.md +1 -2
- 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.validresourcename.md +0 -5
- package/docs/api/foundation-comms.datasourcemetadata.md +0 -1
- package/docs/api/foundation-comms.datasourceoptions.criteria.md +0 -5
- package/docs/api/foundation-comms.datasourceoptions.disablepolling.md +0 -5
- package/docs/api/foundation-comms.datasourceoptions.fields.md +0 -5
- package/docs/api/foundation-comms.datasourceoptions.maxrows.md +0 -5
- package/docs/api/foundation-comms.datasourceoptions.maxview.md +0 -5
- package/docs/api/foundation-comms.datasourceoptions.md +0 -2
- package/docs/api/foundation-comms.datasourceoptions.movingview.md +0 -5
- package/docs/api/foundation-comms.datasourceoptions.orderby.md +0 -5
- package/docs/api/foundation-comms.datasourceoptions.request.md +0 -5
- package/docs/api/foundation-comms.datasourceoptions.reverse.md +0 -5
- package/docs/api/foundation-comms.defaultconnect.getmorerows.md +1 -2
- package/docs/api/foundation-comms.defaultconnect.md +1 -1
- package/docs/api/{foundation-comms.defaultdatasource.startstream.md → foundation-comms.defaultdatasource.deinit.md} +4 -4
- package/docs/api/foundation-comms.defaultdatasource.destroy.md +1 -5
- package/docs/api/foundation-comms.defaultdatasource.init.md +1 -2
- package/docs/api/foundation-comms.defaultdatasource.md +4 -6
- package/docs/api/foundation-comms.defaultdatasource.snapshot.md +1 -8
- package/docs/api/foundation-comms.defaultmessagebuilder.createmorerowsmessage.md +2 -3
- package/docs/api/foundation-comms.defaultmessagebuilder.md +1 -1
- package/docs/api/foundation-comms.md +0 -2
- package/docs/api/foundation-comms.messagebuilder.createmorerowsmessage.md +3 -4
- 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 +0 -1
- package/docs/api/foundation-comms.metadata.md +2 -5
- package/docs/api/foundation-comms.metadatadetail.md +0 -3
- package/docs/api/foundation-comms.requestparams.md +1 -3
- package/docs/api/foundation-comms.requestserverresult.md +0 -5
- package/docs/api-report.md +17 -59
- package/package.json +13 -13
- package/docs/api/foundation-comms.datasourcemetadata.customrequestfields.md +0 -11
- package/docs/api/foundation-comms.datasourceoptions.requestautosetup.md +0 -18
- package/docs/api/foundation-comms.datasourceoptions.viewnumber.md +0 -18
- package/docs/api/foundation-comms.defaultdatasource.customrequestfields.md +0 -12
- package/docs/api/foundation-comms.defaultdatasource.startstreamrequired.md +0 -12
- package/docs/api/foundation-comms.replydetail.md +0 -21
- package/docs/api/foundation-comms.requestdetailsparam.md +0 -15
@@ -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) > [deinit](./foundation-comms.defaultdatasource.deinit.md)
|
4
4
|
|
5
|
-
## DefaultDatasource.
|
5
|
+
## DefaultDatasource.deinit() method
|
6
6
|
|
7
7
|
**Signature:**
|
8
8
|
|
9
9
|
```typescript
|
10
|
-
|
10
|
+
deinit(): void;
|
11
11
|
```
|
12
12
|
**Returns:**
|
13
13
|
|
14
|
-
|
14
|
+
void
|
15
15
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
## DefaultDatasource.destroy() method
|
6
6
|
|
7
|
-
|
7
|
+
Destroy the datasource.
|
8
8
|
|
9
9
|
**Signature:**
|
10
10
|
|
@@ -15,7 +15,3 @@ 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
|
10
|
+
init(options: DatasourceOptions, fetchMeta?: boolean): Promise<boolean>;
|
11
11
|
```
|
12
12
|
|
13
13
|
## Parameters
|
@@ -16,7 +16,6 @@ init(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Pr
|
|
16
16
|
| --- | --- | --- |
|
17
17
|
| options | [DatasourceOptions](./foundation-comms.datasourceoptions.md) | |
|
18
18
|
| fetchMeta | boolean | _(Optional)_ |
|
19
|
-
| startStream | boolean | _(Optional)_ |
|
20
19
|
|
21
20
|
**Returns:**
|
22
21
|
|
@@ -27,7 +27,6 @@ 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)<!-- -->\[\] | |
|
31
30
|
| [fetchMetadataRequired](./foundation-comms.defaultdatasource.fetchmetadatarequired.md) | | boolean | |
|
32
31
|
| [fieldMetadata](./foundation-comms.defaultdatasource.fieldmetadata.md) | | [FieldMetadata](./foundation-comms.fieldmetadata.md)<!-- -->\[\] | |
|
33
32
|
| [initialized](./foundation-comms.defaultdatasource.initialized.md) | <code>readonly</code> | boolean | Indicates whether the datasource has been initialized. |
|
@@ -38,7 +37,6 @@ export declare class DefaultDatasource implements Datasource
|
|
38
37
|
| [requestFields](./foundation-comms.defaultdatasource.requestfields.md) | | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | |
|
39
38
|
| [resources](./foundation-comms.defaultdatasource.resources.md) | <code>protected</code> | [GenesisResources](./foundation-comms.genesisresources.md) | |
|
40
39
|
| [resourceType](./foundation-comms.defaultdatasource.resourcetype.md) | | [ResourceType](./foundation-comms.resourcetype.md) | |
|
41
|
-
| [startStreamRequired](./foundation-comms.defaultdatasource.startstreamrequired.md) | | boolean | |
|
42
40
|
| [status](./foundation-comms.defaultdatasource.status.md) | | [DatasourceStatus](./foundation-comms.datasourcestatus.md) | |
|
43
41
|
| [stream](./foundation-comms.defaultdatasource.stream.md) | | [SocketObservable](./foundation-comms.socketobservable.md)<!-- --><[FilteredDataServerResult](./foundation-comms.filtereddataserverresult.md) \| [RequestServerResult](./foundation-comms.requestserverresult.md)<!-- -->> | |
|
44
42
|
|
@@ -46,11 +44,11 @@ export declare class DefaultDatasource implements Datasource
|
|
46
44
|
|
47
45
|
| Method | Modifiers | Description |
|
48
46
|
| --- | --- | --- |
|
49
|
-
| [
|
47
|
+
| [deinit()](./foundation-comms.defaultdatasource.deinit.md) | | |
|
48
|
+
| [destroy()](./foundation-comms.defaultdatasource.destroy.md) | | Destroy the datasource. |
|
50
49
|
| [fetchAndApplyMetadata(resourceName)](./foundation-comms.defaultdatasource.fetchandapplymetadata.md) | <code>protected</code> | |
|
51
|
-
| [init(options, fetchMeta
|
52
|
-
| [snapshot(
|
50
|
+
| [init(options, fetchMeta)](./foundation-comms.defaultdatasource.init.md) | | |
|
51
|
+
| [snapshot()](./foundation-comms.defaultdatasource.snapshot.md) | | |
|
53
52
|
| [snapshotFiltered(rowId)](./foundation-comms.defaultdatasource.snapshotfiltered.md) | | |
|
54
|
-
| [startStream()](./foundation-comms.defaultdatasource.startstream.md) | | |
|
55
53
|
| [validResourceName(resourceName)](./foundation-comms.defaultdatasource.validresourcename.md) | | |
|
56
54
|
|
@@ -7,15 +7,8 @@
|
|
7
7
|
**Signature:**
|
8
8
|
|
9
9
|
```typescript
|
10
|
-
snapshot(
|
10
|
+
snapshot(): Promise<Message>;
|
11
11
|
```
|
12
|
-
|
13
|
-
## Parameters
|
14
|
-
|
15
|
-
| Parameter | Type | Description |
|
16
|
-
| --- | --- | --- |
|
17
|
-
| overrideParams | any | _(Optional)_ |
|
18
|
-
|
19
12
|
**Returns:**
|
20
13
|
|
21
14
|
Promise<[Message](./foundation-comms.message.md)<!-- -->>
|
@@ -7,7 +7,7 @@
|
|
7
7
|
**Signature:**
|
8
8
|
|
9
9
|
```typescript
|
10
|
-
createMoreRowsMessage(sourceRef: string
|
10
|
+
createMoreRowsMessage(sourceRef: string): Message;
|
11
11
|
```
|
12
12
|
|
13
13
|
## Parameters
|
@@ -15,9 +15,8 @@ createMoreRowsMessage(sourceRef: string, viewNumber?: number): Message<MessageDe
|
|
15
15
|
| Parameter | Type | Description |
|
16
16
|
| --- | --- | --- |
|
17
17
|
| sourceRef | string | |
|
18
|
-
| viewNumber | number | _(Optional)_ |
|
19
18
|
|
20
19
|
**Returns:**
|
21
20
|
|
22
|
-
[Message](./foundation-comms.message.md)
|
21
|
+
[Message](./foundation-comms.message.md)
|
23
22
|
|
@@ -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
|
38
|
+
| [createMoreRowsMessage(sourceRef)](./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,8 +177,6 @@
|
|
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) | |
|
182
180
|
| [RequestParams](./foundation-comms.requestparams.md) | Parameters for a REQUEST message |
|
183
181
|
| [RequestServerResult](./foundation-comms.requestserverresult.md) | Raw result from a REQUEST\_SERVER data fetch. |
|
184
182
|
| [ResourceHealth](./foundation-comms.resourcehealth.md) | ResourceHealth. |
|
@@ -9,19 +9,18 @@ Creates a message to request more rows.
|
|
9
9
|
**Signature:**
|
10
10
|
|
11
11
|
```typescript
|
12
|
-
createMoreRowsMessage(sourceRef: string
|
12
|
+
createMoreRowsMessage(sourceRef: string): Message;
|
13
13
|
```
|
14
14
|
|
15
15
|
## Parameters
|
16
16
|
|
17
17
|
| Parameter | Type | Description |
|
18
18
|
| --- | --- | --- |
|
19
|
-
| sourceRef | string | The
|
20
|
-
| viewNumber | number | _(Optional)_ The desired view number. Default:always the first view, if not spceified. |
|
19
|
+
| sourceRef | string | The source reference. |
|
21
20
|
|
22
21
|
**Returns:**
|
23
22
|
|
24
|
-
[Message](./foundation-comms.message.md)
|
23
|
+
[Message](./foundation-comms.message.md)
|
25
24
|
|
26
25
|
The more rows message.
|
27
26
|
|
@@ -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?: any): Message<T>;
|
13
13
|
```
|
14
14
|
|
15
15
|
## Parameters
|
@@ -17,7 +17,7 @@ createRequestMessage<T = any>(resourceName: string, params?: RequestParams): Mes
|
|
17
17
|
| Parameter | Type | Description |
|
18
18
|
| --- | --- | --- |
|
19
19
|
| resourceName | string | The resource name. |
|
20
|
-
| params |
|
20
|
+
| params | any | _(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
|
31
|
+
| [createMoreRowsMessage(sourceRef)](./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,17 +10,14 @@ Metadata definition for a given resource.
|
|
10
10
|
|
11
11
|
```typescript
|
12
12
|
export type Metadata = {
|
13
|
-
DEFINITIONS?: Record<string, any>;
|
14
|
-
DESCRIPTION?: string;
|
15
13
|
FIELD?: MetadataDetail[];
|
16
|
-
|
14
|
+
INDEXES?: IndexDetail[];
|
17
15
|
REPLY_FIELD?: MetadataDetail[];
|
18
16
|
REQUEST_FIELD?: MetadataDetail[];
|
19
17
|
NAME?: string;
|
20
18
|
TYPE?: string;
|
21
|
-
INDEXES?: IndexDetail[];
|
22
19
|
ERROR?: string;
|
23
20
|
};
|
24
21
|
```
|
25
|
-
**References:** [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->, [
|
22
|
+
**References:** [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->, [IndexDetail](./foundation-comms.indexdetail.md)
|
26
23
|
|
@@ -12,12 +12,9 @@ Metadata Detail definition.
|
|
12
12
|
export type MetadataDetail = {
|
13
13
|
NAME: string;
|
14
14
|
TYPE: string;
|
15
|
-
DESCRIPTION?: string;
|
16
|
-
JSON_TYPE?: string;
|
17
15
|
VALID_VALUES?: string;
|
18
16
|
READ_ONLY?: boolean;
|
19
17
|
OPTIONAL?: boolean;
|
20
|
-
NULLABLE?: boolean;
|
21
18
|
UI_LABEL?: string;
|
22
19
|
};
|
23
20
|
```
|
@@ -10,9 +10,7 @@ Parameters for a REQUEST message
|
|
10
10
|
|
11
11
|
```typescript
|
12
12
|
export type RequestParams = {
|
13
|
-
DETAILS?:
|
13
|
+
DETAILS?: 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
|
162
|
+
getMoreRows(sourceRef: string): Promise<Message>;
|
163
163
|
// (undocumented)
|
164
164
|
host: string;
|
165
165
|
// @internal
|
@@ -381,24 +381,23 @@ 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;
|
384
385
|
deleteItem?(itemId: string): Promise<void>;
|
385
386
|
destroy(): void;
|
386
387
|
dropView?(view: Dataview): void;
|
387
388
|
getMetadata?(resourceName: string): Promise<Array<FieldMetadata>>;
|
388
|
-
init(options: DatasourceOptions, fetchMeta?: boolean
|
389
|
+
init(options: DatasourceOptions, fetchMeta?: boolean): Promise<boolean>;
|
389
390
|
initialized: boolean;
|
390
391
|
readOnly: boolean;
|
391
392
|
resourceType: ResourceType;
|
392
393
|
setFilter?(name: string, value: any, type?: string): Promise<void>;
|
393
|
-
snapshot(
|
394
|
-
snapshotFiltered(rowId?: string):
|
395
|
-
startStream(): Promise<void>;
|
394
|
+
snapshot(params?: any): any;
|
395
|
+
snapshotFiltered(rowId?: string): any;
|
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
|
402
401
|
validResourceName(resourceName: string): boolean;
|
403
402
|
}
|
404
403
|
|
@@ -763,8 +762,6 @@ export interface DatasourceMetadata {
|
|
763
762
|
// (undocumented)
|
764
763
|
readonly availableIndexes: IndexDetail[];
|
765
764
|
// (undocumented)
|
766
|
-
readonly customRequestFields: MetadataDetail[];
|
767
|
-
// (undocumented)
|
768
765
|
fetchMetadataRequired: boolean;
|
769
766
|
// (undocumented)
|
770
767
|
readonly fieldMetadata: FieldMetadata[];
|
@@ -787,8 +784,6 @@ export class DatasourceMock implements Datasource {
|
|
787
784
|
// (undocumented)
|
788
785
|
createItem?(data: any): Promise<string>;
|
789
786
|
// (undocumented)
|
790
|
-
customRequestFields: MetadataDetail[];
|
791
|
-
// (undocumented)
|
792
787
|
dataHandler?(data: any[]): any[];
|
793
788
|
// (undocumented)
|
794
789
|
deinit(): void;
|
@@ -823,11 +818,9 @@ export class DatasourceMock implements Datasource {
|
|
823
818
|
setMetadata(meta: Metadata): void;
|
824
819
|
setStream(message: Message): void;
|
825
820
|
// (undocumented)
|
826
|
-
snapshot(params?: any):
|
827
|
-
// (undocumented)
|
828
|
-
snapshotFiltered(rowId?: string): Promise<any[]>;
|
821
|
+
snapshot(params?: any): void;
|
829
822
|
// (undocumented)
|
830
|
-
|
823
|
+
snapshotFiltered(rowId?: string): void;
|
831
824
|
// (undocumented)
|
832
825
|
status: DatasourceStatus;
|
833
826
|
// (undocumented)
|
@@ -856,10 +849,8 @@ export interface DatasourceOptions {
|
|
856
849
|
orderBy?: string;
|
857
850
|
pollingInterval?: number;
|
858
851
|
request?: any;
|
859
|
-
requestAutoSetup?: boolean;
|
860
852
|
resourceName?: string;
|
861
853
|
reverse?: boolean;
|
862
|
-
viewNumber?: number;
|
863
854
|
}
|
864
855
|
|
865
856
|
// @public
|
@@ -936,7 +927,7 @@ export class DefaultConnect implements Connect {
|
|
936
927
|
// (undocumented)
|
937
928
|
getMoreColumns(sourceRef: string): Promise<Message>;
|
938
929
|
// (undocumented)
|
939
|
-
getMoreRows(sourceRef: string
|
930
|
+
getMoreRows(sourceRef: string): Promise<Message>;
|
940
931
|
// (undocumented)
|
941
932
|
get host(): string;
|
942
933
|
// (undocumented)
|
@@ -1089,7 +1080,7 @@ export class DefaultDatasource implements Datasource {
|
|
1089
1080
|
// (undocumented)
|
1090
1081
|
protected connect: Connect;
|
1091
1082
|
// (undocumented)
|
1092
|
-
|
1083
|
+
deinit(): void;
|
1093
1084
|
// 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
|
1094
1085
|
//
|
1095
1086
|
// (undocumented)
|
@@ -1101,7 +1092,7 @@ export class DefaultDatasource implements Datasource {
|
|
1101
1092
|
// (undocumented)
|
1102
1093
|
fieldMetadata: FieldMetadata[];
|
1103
1094
|
// (undocumented)
|
1104
|
-
init(options: DatasourceOptions, fetchMeta?: boolean
|
1095
|
+
init(options: DatasourceOptions, fetchMeta?: boolean): Promise<boolean>;
|
1105
1096
|
// 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
|
1106
1097
|
//
|
1107
1098
|
// (undocumented)
|
@@ -1125,15 +1116,9 @@ export class DefaultDatasource implements Datasource {
|
|
1125
1116
|
// (undocumented)
|
1126
1117
|
resourceType: ResourceType;
|
1127
1118
|
// (undocumented)
|
1128
|
-
snapshot(
|
1119
|
+
snapshot(): Promise<Message>;
|
1129
1120
|
// (undocumented)
|
1130
1121
|
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;
|
1137
1122
|
// 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
|
1138
1123
|
//
|
1139
1124
|
// (undocumented)
|
@@ -1341,7 +1326,7 @@ export class DefaultMessageBuilder implements MessageBuilder {
|
|
1341
1326
|
// (undocumented)
|
1342
1327
|
createMoreColumnsMessage(sourceRef: string): Message;
|
1343
1328
|
// (undocumented)
|
1344
|
-
createMoreRowsMessage(sourceRef: string
|
1329
|
+
createMoreRowsMessage(sourceRef: string): Message;
|
1345
1330
|
// (undocumented)
|
1346
1331
|
createRefreshTokenMessage(): Message<MessageDetails.RefreshToken>;
|
1347
1332
|
// (undocumented)
|
@@ -1982,9 +1967,9 @@ export interface MessageBuilder {
|
|
1982
1967
|
createLogoutMessage(loginResult?: LoginResult): Message;
|
1983
1968
|
createMetaRequestMessage(resourceName: string, messageType?: EventMessageType): Message<MessageDetails.MetaRequest>;
|
1984
1969
|
createMoreColumnsMessage(sourceRef: string): Message;
|
1985
|
-
createMoreRowsMessage(sourceRef: string
|
1970
|
+
createMoreRowsMessage(sourceRef: string): Message;
|
1986
1971
|
createRefreshTokenMessage(): Message<MessageDetails.RefreshToken>;
|
1987
|
-
createRequestMessage<T = any>(resourceName: string, params?:
|
1972
|
+
createRequestMessage<T = any>(resourceName: string, params?: any): Message<T>;
|
1988
1973
|
createResourcesMessage<T = any>(params?: any): Message<T>;
|
1989
1974
|
}
|
1990
1975
|
|
@@ -2050,7 +2035,6 @@ export namespace MessageDetails {
|
|
2050
2035
|
};
|
2051
2036
|
export type MoreRows = {
|
2052
2037
|
SOURCE_REF: string;
|
2053
|
-
VIEW_NUMBER?: number;
|
2054
2038
|
};
|
2055
2039
|
export type RefreshToken = {
|
2056
2040
|
REFRESH_AUTH_TOKEN: string;
|
@@ -2121,15 +2105,12 @@ export const MetaCache: InterfaceSymbol<MetaCache>;
|
|
2121
2105
|
|
2122
2106
|
// @public
|
2123
2107
|
export type Metadata = {
|
2124
|
-
DEFINITIONS?: Record<string, any>;
|
2125
|
-
DESCRIPTION?: string;
|
2126
2108
|
FIELD?: MetadataDetail[];
|
2127
|
-
|
2109
|
+
INDEXES?: IndexDetail[];
|
2128
2110
|
REPLY_FIELD?: MetadataDetail[];
|
2129
2111
|
REQUEST_FIELD?: MetadataDetail[];
|
2130
2112
|
NAME?: string;
|
2131
2113
|
TYPE?: string;
|
2132
|
-
INDEXES?: IndexDetail[];
|
2133
2114
|
ERROR?: string;
|
2134
2115
|
};
|
2135
2116
|
|
@@ -2145,12 +2126,9 @@ export interface MetadataCache {
|
|
2145
2126
|
export type MetadataDetail = {
|
2146
2127
|
NAME: string;
|
2147
2128
|
TYPE: string;
|
2148
|
-
DESCRIPTION?: string;
|
2149
|
-
JSON_TYPE?: string;
|
2150
2129
|
VALID_VALUES?: string;
|
2151
2130
|
READ_ONLY?: boolean;
|
2152
2131
|
OPTIONAL?: boolean;
|
2153
|
-
NULLABLE?: boolean;
|
2154
2132
|
UI_LABEL?: string;
|
2155
2133
|
};
|
2156
2134
|
|
@@ -2279,24 +2257,9 @@ export type RefreshCredentialsInput = {
|
|
2279
2257
|
mfaToken?: string;
|
2280
2258
|
};
|
2281
2259
|
|
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
|
-
|
2297
2260
|
// @public
|
2298
2261
|
export type RequestParams = {
|
2299
|
-
DETAILS?:
|
2262
|
+
DETAILS?: any;
|
2300
2263
|
REQUEST?: any;
|
2301
2264
|
};
|
2302
2265
|
|
@@ -2305,11 +2268,6 @@ export type RequestServerResult = {
|
|
2305
2268
|
SOURCE_REF?: string;
|
2306
2269
|
REPLY: any[];
|
2307
2270
|
MESSAGE_TYPE?: string;
|
2308
|
-
MORE_ROWS?: boolean;
|
2309
|
-
NEXT_VIEW?: number;
|
2310
|
-
PARAMETRIC_TYPE?: string;
|
2311
|
-
ROWS_COUNT?: number;
|
2312
|
-
SEQUENCE_ID?: number;
|
2313
2271
|
};
|
2314
2272
|
|
2315
2273
|
// @public
|
@@ -2735,7 +2693,7 @@ export const WSConnect: InterfaceSymbol<Connect>;
|
|
2735
2693
|
|
2736
2694
|
// Warnings were encountered during analysis:
|
2737
2695
|
//
|
2738
|
-
// src/connect/message.ts:
|
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
|
2739
2697
|
|
2740
2698
|
// (No @packageDocumentation comment for this package)
|
2741
2699
|
|
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.200.1-alpha-
|
4
|
+
"version": "14.200.1-alpha-e974201.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.200.1-alpha-
|
79
|
-
"@genesislcap/genx": "14.200.1-alpha-
|
80
|
-
"@genesislcap/rollup-builder": "14.200.1-alpha-
|
81
|
-
"@genesislcap/ts-builder": "14.200.1-alpha-
|
82
|
-
"@genesislcap/uvu-playwright-builder": "14.200.1-alpha-
|
83
|
-
"@genesislcap/vite-builder": "14.200.1-alpha-
|
84
|
-
"@genesislcap/webpack-builder": "14.200.1-alpha-
|
78
|
+
"@genesislcap/foundation-testing": "14.200.1-alpha-e974201.0",
|
79
|
+
"@genesislcap/genx": "14.200.1-alpha-e974201.0",
|
80
|
+
"@genesislcap/rollup-builder": "14.200.1-alpha-e974201.0",
|
81
|
+
"@genesislcap/ts-builder": "14.200.1-alpha-e974201.0",
|
82
|
+
"@genesislcap/uvu-playwright-builder": "14.200.1-alpha-e974201.0",
|
83
|
+
"@genesislcap/vite-builder": "14.200.1-alpha-e974201.0",
|
84
|
+
"@genesislcap/webpack-builder": "14.200.1-alpha-e974201.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.200.1-alpha-
|
92
|
-
"@genesislcap/foundation-logger": "14.200.1-alpha-
|
93
|
-
"@genesislcap/foundation-user": "14.200.1-alpha-
|
94
|
-
"@genesislcap/foundation-utils": "14.200.1-alpha-
|
91
|
+
"@genesislcap/foundation-broadcast-channel": "14.200.1-alpha-e974201.0",
|
92
|
+
"@genesislcap/foundation-logger": "14.200.1-alpha-e974201.0",
|
93
|
+
"@genesislcap/foundation-user": "14.200.1-alpha-e974201.0",
|
94
|
+
"@genesislcap/foundation-utils": "14.200.1-alpha-e974201.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": "a42390bcae28079e43be4926f54c6504e42ba8b7"
|
115
115
|
}
|
@@ -1,11 +0,0 @@
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
-
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DatasourceMetadata](./foundation-comms.datasourcemetadata.md) > [customRequestFields](./foundation-comms.datasourcemetadata.customrequestfields.md)
|
4
|
-
|
5
|
-
## DatasourceMetadata.customRequestFields property
|
6
|
-
|
7
|
-
**Signature:**
|
8
|
-
|
9
|
-
```typescript
|
10
|
-
readonly customRequestFields: MetadataDetail[];
|
11
|
-
```
|
@@ -1,18 +0,0 @@
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
-
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DatasourceOptions](./foundation-comms.datasourceoptions.md) > [requestAutoSetup](./foundation-comms.datasourceoptions.requestautosetup.md)
|
4
|
-
|
5
|
-
## DatasourceOptions.requestAutoSetup property
|
6
|
-
|
7
|
-
Whether the Datasource service will setup RQUEST object based on metadata.
|
8
|
-
|
9
|
-
**Signature:**
|
10
|
-
|
11
|
-
```typescript
|
12
|
-
requestAutoSetup?: boolean;
|
13
|
-
```
|
14
|
-
|
15
|
-
## Remarks
|
16
|
-
|
17
|
-
Only works with REQUEST\_SERVER resources.
|
18
|
-
|
@@ -1,18 +0,0 @@
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
-
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DatasourceOptions](./foundation-comms.datasourceoptions.md) > [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
|
-
|
@@ -1,12 +0,0 @@
|
|
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) > [customRequestFields](./foundation-comms.defaultdatasource.customrequestfields.md)
|
4
|
-
|
5
|
-
## DefaultDatasource.customRequestFields property
|
6
|
-
|
7
|
-
|
8
|
-
**Signature:**
|
9
|
-
|
10
|
-
```typescript
|
11
|
-
customRequestFields: MetadataDetail[];
|
12
|
-
```
|
@@ -1,12 +0,0 @@
|
|
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
|
-
```
|
@@ -1,21 +0,0 @@
|
|
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
|
-
|