@genesislcap/foundation-comms 14.320.1 → 14.320.2-alpha-1f01931fd.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.
- package/dist/dts/connect/message.d.ts +3 -1
- package/dist/dts/connect/message.d.ts.map +1 -1
- package/dist/dts/datasource/datasource.config.d.ts +1 -0
- package/dist/dts/datasource/datasource.config.d.ts.map +1 -1
- package/dist/dts/datasource/datasource.d.ts +25 -0
- package/dist/dts/datasource/datasource.d.ts.map +1 -1
- package/dist/dts/datasource/datasource.types.d.ts +6 -0
- package/dist/dts/datasource/datasource.types.d.ts.map +1 -1
- package/dist/dts/metadata/metadata.types.d.ts +4 -2
- package/dist/dts/metadata/metadata.types.d.ts.map +1 -1
- package/dist/dts/testing/mocks/datasource/datasource.d.ts +4 -1
- package/dist/dts/testing/mocks/datasource/datasource.d.ts.map +1 -1
- package/dist/esm/datasource/datasource.config.js +1 -0
- package/dist/esm/datasource/datasource.js +54 -14
- package/dist/esm/testing/mocks/datasource/datasource.js +7 -0
- package/dist/foundation-comms.api.json +225 -3
- package/dist/foundation-comms.d.ts +42 -3
- package/docs/api/foundation-comms.datasource.dataserveronlyparams.md +13 -0
- package/docs/api/foundation-comms.datasource.md +47 -0
- package/docs/api/foundation-comms.datasource.requestonlyparams.md +13 -0
- package/docs/api/foundation-comms.datasource.updateloadmorecount.md +50 -0
- package/docs/api/foundation-comms.datasourcedefaults.default_req_rep_offset.md +11 -0
- package/docs/api/foundation-comms.datasourcedefaults.md +21 -0
- package/docs/api/foundation-comms.datasourceoptions.md +19 -0
- package/docs/api/foundation-comms.datasourceoptions.offset.md +18 -0
- package/docs/api/foundation-comms.defaultdatasource.criteriaonlyrequest.md +12 -0
- package/docs/api/foundation-comms.defaultdatasource.loadmorecount.md +13 -0
- package/docs/api/foundation-comms.defaultdatasource.md +37 -0
- package/docs/api/foundation-comms.metadata.md +1 -0
- package/docs/api/foundation-comms.requestdetailsparam.md +3 -1
- package/docs/api/foundation-comms.requestserverresult.md +3 -2
- package/docs/api-report.md.api.md +27 -3
- package/package.json +13 -13
@@ -163,6 +163,24 @@ Description
|
|
163
163
|
</td><td>
|
164
164
|
|
165
165
|
|
166
|
+
</td></tr>
|
167
|
+
<tr><td>
|
168
|
+
|
169
|
+
[criteriaOnlyRequest](./foundation-comms.defaultdatasource.criteriaonlyrequest.md)
|
170
|
+
|
171
|
+
|
172
|
+
</td><td>
|
173
|
+
|
174
|
+
|
175
|
+
</td><td>
|
176
|
+
|
177
|
+
boolean
|
178
|
+
|
179
|
+
|
180
|
+
</td><td>
|
181
|
+
|
182
|
+
|
183
|
+
|
166
184
|
</td></tr>
|
167
185
|
<tr><td>
|
168
186
|
|
@@ -238,6 +256,25 @@ boolean
|
|
238
256
|
Indicates whether the datasource has been initialized.
|
239
257
|
|
240
258
|
|
259
|
+
</td></tr>
|
260
|
+
<tr><td>
|
261
|
+
|
262
|
+
[loadMoreCount](./foundation-comms.defaultdatasource.loadmorecount.md)
|
263
|
+
|
264
|
+
|
265
|
+
</td><td>
|
266
|
+
|
267
|
+
|
268
|
+
</td><td>
|
269
|
+
|
270
|
+
number
|
271
|
+
|
272
|
+
|
273
|
+
</td><td>
|
274
|
+
|
275
|
+
Track load more count for RequestServer temporary MAX\_ROWS calculation
|
276
|
+
|
277
|
+
|
241
278
|
</td></tr>
|
242
279
|
<tr><td>
|
243
280
|
|
@@ -20,6 +20,7 @@ export type Metadata = {
|
|
20
20
|
TYPE?: string;
|
21
21
|
INDEXES?: IndexDetail[];
|
22
22
|
ERROR?: string;
|
23
|
+
CRITERIA_ONLY_REQUEST?: boolean;
|
23
24
|
};
|
24
25
|
```
|
25
26
|
**References:** [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->, [ReplyDetail](./foundation-comms.replydetail.md)<!-- -->, [IndexDetail](./foundation-comms.indexdetail.md)
|
@@ -10,12 +10,13 @@ Raw result from a REQUEST\_SERVER data fetch.
|
|
10
10
|
|
11
11
|
```typescript
|
12
12
|
export type RequestServerResult = {
|
13
|
-
SOURCE_REF?: string;
|
14
|
-
REPLY: any[];
|
15
13
|
MESSAGE_TYPE?: string;
|
16
14
|
MORE_ROWS?: boolean;
|
15
|
+
NEXT_OFFSET?: number;
|
17
16
|
NEXT_VIEW?: number;
|
18
17
|
PARAMETRIC_TYPE?: string;
|
18
|
+
REPLY: any[];
|
19
|
+
SOURCE_REF?: string;
|
19
20
|
ROWS_COUNT?: number;
|
20
21
|
SEQUENCE_ID?: number;
|
21
22
|
};
|
@@ -468,6 +468,7 @@ export interface Datasource extends DatasourceMetadata {
|
|
468
468
|
clearFilter?(name: string): Promise<void>;
|
469
469
|
createItem?(data: any): Promise<string>;
|
470
470
|
dataHandler?(data: Array<any>): Array<any>;
|
471
|
+
dataserverOnlyParams: DataserverParams;
|
471
472
|
deleteItem?(itemId: string): Promise<void>;
|
472
473
|
destroy(): void;
|
473
474
|
dropView?(view: Dataview): void;
|
@@ -475,6 +476,7 @@ export interface Datasource extends DatasourceMetadata {
|
|
475
476
|
init(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
|
476
477
|
initialized: boolean;
|
477
478
|
readOnly: boolean;
|
479
|
+
requestOnlyParams: RequestParams;
|
478
480
|
resourceType: ResourceType;
|
479
481
|
setFilter?(name: string, value: any, type?: string): Promise<void>;
|
480
482
|
snapshot(overrideParams?: any): Promise<Message>;
|
@@ -485,6 +487,8 @@ export interface Datasource extends DatasourceMetadata {
|
|
485
487
|
stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
|
486
488
|
updateData?(data: Array<any>): Promise<void>;
|
487
489
|
updateItem?(itemId: string, data: any): Promise<void>;
|
490
|
+
// (undocumented)
|
491
|
+
updateLoadMoreCount(count: number): void;
|
488
492
|
// @deprecated
|
489
493
|
validResourceName(resourceName: string): boolean;
|
490
494
|
}
|
@@ -515,6 +519,8 @@ export class DatasourceDefaults {
|
|
515
519
|
// (undocumented)
|
516
520
|
static readonly DEFAULT_PAGINATION_PAGE_SIZE = 25;
|
517
521
|
// (undocumented)
|
522
|
+
static readonly DEFAULT_REQ_REP_OFFSET = 0;
|
523
|
+
// (undocumented)
|
518
524
|
static readonly MAX_ROWS_250 = 250;
|
519
525
|
// (undocumented)
|
520
526
|
static readonly MAX_VIEW_1000 = 1000;
|
@@ -923,6 +929,8 @@ export class DatasourceMock implements Datasource {
|
|
923
929
|
// (undocumented)
|
924
930
|
dataHandler?(data: any[]): any[];
|
925
931
|
// (undocumented)
|
932
|
+
get dataserverOnlyParams(): DataserverParams;
|
933
|
+
// (undocumented)
|
926
934
|
deinit(): void;
|
927
935
|
// (undocumented)
|
928
936
|
deleteItem?(itemId: string): Promise<void>;
|
@@ -949,6 +957,8 @@ export class DatasourceMock implements Datasource {
|
|
949
957
|
// (undocumented)
|
950
958
|
requestFields: MetadataDetail[];
|
951
959
|
// (undocumented)
|
960
|
+
get requestOnlyParams(): RequestParams;
|
961
|
+
// (undocumented)
|
952
962
|
resourceType: ResourceType;
|
953
963
|
// (undocumented)
|
954
964
|
setFilter?(name: string, value: any, type?: string): Promise<void>;
|
@@ -975,6 +985,8 @@ export class DatasourceMock implements Datasource {
|
|
975
985
|
// (undocumented)
|
976
986
|
updateItem?(itemId: string, data: any): Promise<void>;
|
977
987
|
// (undocumented)
|
988
|
+
updateLoadMoreCount(count: number): void;
|
989
|
+
// (undocumented)
|
978
990
|
validResourceName(resourceName: string): boolean;
|
979
991
|
}
|
980
992
|
|
@@ -987,6 +999,7 @@ export interface DatasourceOptions {
|
|
987
999
|
maxRows?: number;
|
988
1000
|
maxView?: number;
|
989
1001
|
movingView?: boolean;
|
1002
|
+
offset?: number;
|
990
1003
|
orderBy?: string;
|
991
1004
|
pollingInterval?: number;
|
992
1005
|
pollTriggerEvents?: string[];
|
@@ -1237,6 +1250,10 @@ export class DefaultDatasource implements Datasource {
|
|
1237
1250
|
protected connect: Connect;
|
1238
1251
|
// (undocumented)
|
1239
1252
|
protected connectEvents: ConnectEvents;
|
1253
|
+
// Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: No member was found with name "criteriaOnlyRequest"
|
1254
|
+
//
|
1255
|
+
// (undocumented)
|
1256
|
+
criteriaOnlyRequest: boolean;
|
1240
1257
|
// (undocumented)
|
1241
1258
|
customRequestFields: MetadataDetail[];
|
1242
1259
|
// @internal (undocumented)
|
@@ -1257,6 +1274,7 @@ export class DefaultDatasource implements Datasource {
|
|
1257
1274
|
//
|
1258
1275
|
// (undocumented)
|
1259
1276
|
get initialized(): boolean;
|
1277
|
+
loadMoreCount: number;
|
1260
1278
|
// @internal (undocumented)
|
1261
1279
|
protected normaliseStatus(status: Partial<DatasourceStatus>): DatasourceStatus;
|
1262
1280
|
// (undocumented)
|
@@ -1289,6 +1307,8 @@ export class DefaultDatasource implements Datasource {
|
|
1289
1307
|
status: DatasourceStatus;
|
1290
1308
|
// (undocumented)
|
1291
1309
|
stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
|
1310
|
+
// @internal
|
1311
|
+
updateLoadMoreCount(count: number): void;
|
1292
1312
|
// @deprecated (undocumented)
|
1293
1313
|
validResourceName(resourceName: string): boolean;
|
1294
1314
|
}
|
@@ -2296,6 +2316,7 @@ export type Metadata = {
|
|
2296
2316
|
TYPE?: string;
|
2297
2317
|
INDEXES?: IndexDetail[];
|
2298
2318
|
ERROR?: string;
|
2319
|
+
CRITERIA_ONLY_REQUEST?: boolean;
|
2299
2320
|
};
|
2300
2321
|
|
2301
2322
|
// @public
|
@@ -2455,8 +2476,10 @@ export type ReplyDetail = {
|
|
2455
2476
|
|
2456
2477
|
// @public (undocumented)
|
2457
2478
|
export type RequestDetailsParam = {
|
2458
|
-
MAX_ROWS?: number;
|
2459
2479
|
CRITERIA_MATCH?: string;
|
2480
|
+
MAX_ROWS?: number;
|
2481
|
+
OFFSET?: number;
|
2482
|
+
ORDER_BY?: string;
|
2460
2483
|
VIEW_NUMBER?: number;
|
2461
2484
|
};
|
2462
2485
|
|
@@ -2469,12 +2492,13 @@ export type RequestParams = {
|
|
2469
2492
|
|
2470
2493
|
// @public
|
2471
2494
|
export type RequestServerResult = {
|
2472
|
-
SOURCE_REF?: string;
|
2473
|
-
REPLY: any[];
|
2474
2495
|
MESSAGE_TYPE?: string;
|
2475
2496
|
MORE_ROWS?: boolean;
|
2497
|
+
NEXT_OFFSET?: number;
|
2476
2498
|
NEXT_VIEW?: number;
|
2477
2499
|
PARAMETRIC_TYPE?: string;
|
2500
|
+
REPLY: any[];
|
2501
|
+
SOURCE_REF?: string;
|
2478
2502
|
ROWS_COUNT?: number;
|
2479
2503
|
SEQUENCE_ID?: number;
|
2480
2504
|
};
|
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.320.
|
4
|
+
"version": "14.320.2-alpha-1f01931fd.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.320.
|
79
|
-
"@genesislcap/genx": "14.320.
|
80
|
-
"@genesislcap/rollup-builder": "14.320.
|
81
|
-
"@genesislcap/ts-builder": "14.320.
|
82
|
-
"@genesislcap/uvu-playwright-builder": "14.320.
|
83
|
-
"@genesislcap/vite-builder": "14.320.
|
84
|
-
"@genesislcap/webpack-builder": "14.320.
|
78
|
+
"@genesislcap/foundation-testing": "14.320.2-alpha-1f01931fd.0",
|
79
|
+
"@genesislcap/genx": "14.320.2-alpha-1f01931fd.0",
|
80
|
+
"@genesislcap/rollup-builder": "14.320.2-alpha-1f01931fd.0",
|
81
|
+
"@genesislcap/ts-builder": "14.320.2-alpha-1f01931fd.0",
|
82
|
+
"@genesislcap/uvu-playwright-builder": "14.320.2-alpha-1f01931fd.0",
|
83
|
+
"@genesislcap/vite-builder": "14.320.2-alpha-1f01931fd.0",
|
84
|
+
"@genesislcap/webpack-builder": "14.320.2-alpha-1f01931fd.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
|
"sinon": "^17.0.1"
|
89
89
|
},
|
90
90
|
"dependencies": {
|
91
|
-
"@genesislcap/foundation-broadcast-channel": "14.320.
|
92
|
-
"@genesislcap/foundation-logger": "14.320.
|
93
|
-
"@genesislcap/foundation-user": "14.320.
|
94
|
-
"@genesislcap/foundation-utils": "14.320.
|
91
|
+
"@genesislcap/foundation-broadcast-channel": "14.320.2-alpha-1f01931fd.0",
|
92
|
+
"@genesislcap/foundation-logger": "14.320.2-alpha-1f01931fd.0",
|
93
|
+
"@genesislcap/foundation-user": "14.320.2-alpha-1f01931fd.0",
|
94
|
+
"@genesislcap/foundation-utils": "14.320.2-alpha-1f01931fd.0",
|
95
95
|
"@microsoft/fast-element": "1.14.0",
|
96
96
|
"@microsoft/fast-foundation": "2.49.6",
|
97
97
|
"analytics": "0.8.16",
|
@@ -110,5 +110,5 @@
|
|
110
110
|
"publishConfig": {
|
111
111
|
"access": "public"
|
112
112
|
},
|
113
|
-
"gitHead": "
|
113
|
+
"gitHead": "6692280bff8fbf45e015dc662bdd3eacf863e74a"
|
114
114
|
}
|