@genesislcap/foundation-comms 14.321.1-alpha-ada81fd.0 → 14.321.1-alpha-c162d67.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 (34) hide show
  1. package/dist/dts/connect/message.d.ts +1 -3
  2. package/dist/dts/connect/message.d.ts.map +1 -1
  3. package/dist/dts/datasource/datasource.config.d.ts +0 -1
  4. package/dist/dts/datasource/datasource.config.d.ts.map +1 -1
  5. package/dist/dts/datasource/datasource.d.ts +0 -25
  6. package/dist/dts/datasource/datasource.d.ts.map +1 -1
  7. package/dist/dts/datasource/datasource.types.d.ts +16 -21
  8. package/dist/dts/datasource/datasource.types.d.ts.map +1 -1
  9. package/dist/dts/metadata/metadata.types.d.ts +2 -4
  10. package/dist/dts/metadata/metadata.types.d.ts.map +1 -1
  11. package/dist/dts/testing/mocks/datasource/datasource.d.ts +1 -4
  12. package/dist/dts/testing/mocks/datasource/datasource.d.ts.map +1 -1
  13. package/dist/esm/datasource/datasource.config.js +0 -1
  14. package/dist/esm/datasource/datasource.js +15 -56
  15. package/dist/esm/testing/mocks/datasource/datasource.js +0 -7
  16. package/dist/foundation-comms.api.json +4 -226
  17. package/dist/foundation-comms.d.ts +19 -57
  18. package/docs/api/foundation-comms.datasource.md +0 -47
  19. package/docs/api/foundation-comms.datasourcedefaults.md +0 -21
  20. package/docs/api/foundation-comms.datasourceoptions.md +0 -19
  21. package/docs/api/foundation-comms.datasourceoptions.orderby.md +5 -0
  22. package/docs/api/foundation-comms.defaultdatasource.md +0 -37
  23. package/docs/api/foundation-comms.metadata.md +0 -1
  24. package/docs/api/foundation-comms.requestdetailsparam.md +1 -3
  25. package/docs/api/foundation-comms.requestserverresult.md +2 -3
  26. package/docs/api-report.md.api.md +3 -27
  27. package/package.json +13 -13
  28. package/docs/api/foundation-comms.datasource.dataserveronlyparams.md +0 -13
  29. package/docs/api/foundation-comms.datasource.requestonlyparams.md +0 -13
  30. package/docs/api/foundation-comms.datasource.updateloadmorecount.md +0 -50
  31. package/docs/api/foundation-comms.datasourcedefaults.default_req_rep_offset.md +0 -11
  32. package/docs/api/foundation-comms.datasourceoptions.offset.md +0 -18
  33. package/docs/api/foundation-comms.defaultdatasource.criteriaonlyrequest.md +0 -12
  34. package/docs/api/foundation-comms.defaultdatasource.loadmorecount.md +0 -13
@@ -10,13 +10,12 @@ 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[];
13
15
  MESSAGE_TYPE?: string;
14
16
  MORE_ROWS?: boolean;
15
- NEXT_OFFSET?: number;
16
17
  NEXT_VIEW?: number;
17
18
  PARAMETRIC_TYPE?: string;
18
- REPLY: any[];
19
- SOURCE_REF?: string;
20
19
  ROWS_COUNT?: number;
21
20
  SEQUENCE_ID?: number;
22
21
  };
@@ -468,7 +468,6 @@ 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;
472
471
  deleteItem?(itemId: string): Promise<void>;
473
472
  destroy(): void;
474
473
  dropView?(view: Dataview): void;
@@ -476,7 +475,6 @@ export interface Datasource extends DatasourceMetadata {
476
475
  init(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
477
476
  initialized: boolean;
478
477
  readOnly: boolean;
479
- requestOnlyParams: RequestParams;
480
478
  resourceType: ResourceType;
481
479
  setFilter?(name: string, value: any, type?: string): Promise<void>;
482
480
  snapshot(overrideParams?: any): Promise<Message>;
@@ -487,8 +485,6 @@ export interface Datasource extends DatasourceMetadata {
487
485
  stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
488
486
  updateData?(data: Array<any>): Promise<void>;
489
487
  updateItem?(itemId: string, data: any): Promise<void>;
490
- // (undocumented)
491
- updateLoadMoreCount(count: number): void;
492
488
  // @deprecated
493
489
  validResourceName(resourceName: string): boolean;
494
490
  }
@@ -519,8 +515,6 @@ export class DatasourceDefaults {
519
515
  // (undocumented)
520
516
  static readonly DEFAULT_PAGINATION_PAGE_SIZE = 25;
521
517
  // (undocumented)
522
- static readonly DEFAULT_REQ_REP_OFFSET = 0;
523
- // (undocumented)
524
518
  static readonly MAX_ROWS_250 = 250;
525
519
  // (undocumented)
526
520
  static readonly MAX_VIEW_1000 = 1000;
@@ -929,8 +923,6 @@ export class DatasourceMock implements Datasource {
929
923
  // (undocumented)
930
924
  dataHandler?(data: any[]): any[];
931
925
  // (undocumented)
932
- get dataserverOnlyParams(): DataserverParams;
933
- // (undocumented)
934
926
  deinit(): void;
935
927
  // (undocumented)
936
928
  deleteItem?(itemId: string): Promise<void>;
@@ -957,8 +949,6 @@ export class DatasourceMock implements Datasource {
957
949
  // (undocumented)
958
950
  requestFields: MetadataDetail[];
959
951
  // (undocumented)
960
- get requestOnlyParams(): RequestParams;
961
- // (undocumented)
962
952
  resourceType: ResourceType;
963
953
  // (undocumented)
964
954
  setFilter?(name: string, value: any, type?: string): Promise<void>;
@@ -985,8 +975,6 @@ export class DatasourceMock implements Datasource {
985
975
  // (undocumented)
986
976
  updateItem?(itemId: string, data: any): Promise<void>;
987
977
  // (undocumented)
988
- updateLoadMoreCount(count: number): void;
989
- // (undocumented)
990
978
  validResourceName(resourceName: string): boolean;
991
979
  }
992
980
 
@@ -999,7 +987,6 @@ export interface DatasourceOptions {
999
987
  maxRows?: number;
1000
988
  maxView?: number;
1001
989
  movingView?: boolean;
1002
- offset?: number;
1003
990
  orderBy?: string;
1004
991
  pollingInterval?: number;
1005
992
  pollTriggerEvents?: string[];
@@ -1250,10 +1237,6 @@ export class DefaultDatasource implements Datasource {
1250
1237
  protected connect: Connect;
1251
1238
  // (undocumented)
1252
1239
  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;
1257
1240
  // (undocumented)
1258
1241
  customRequestFields: MetadataDetail[];
1259
1242
  // @internal (undocumented)
@@ -1274,7 +1257,6 @@ export class DefaultDatasource implements Datasource {
1274
1257
  //
1275
1258
  // (undocumented)
1276
1259
  get initialized(): boolean;
1277
- loadMoreCount: number;
1278
1260
  // @internal (undocumented)
1279
1261
  protected normaliseStatus(status: Partial<DatasourceStatus>): DatasourceStatus;
1280
1262
  // (undocumented)
@@ -1307,8 +1289,6 @@ export class DefaultDatasource implements Datasource {
1307
1289
  status: DatasourceStatus;
1308
1290
  // (undocumented)
1309
1291
  stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
1310
- // @internal
1311
- updateLoadMoreCount(count: number): void;
1312
1292
  // @deprecated (undocumented)
1313
1293
  validResourceName(resourceName: string): boolean;
1314
1294
  }
@@ -2316,7 +2296,6 @@ export type Metadata = {
2316
2296
  TYPE?: string;
2317
2297
  INDEXES?: IndexDetail[];
2318
2298
  ERROR?: string;
2319
- CRITERIA_ONLY_REQUEST?: boolean;
2320
2299
  };
2321
2300
 
2322
2301
  // @public
@@ -2476,10 +2455,8 @@ export type ReplyDetail = {
2476
2455
 
2477
2456
  // @public (undocumented)
2478
2457
  export type RequestDetailsParam = {
2479
- CRITERIA_MATCH?: string;
2480
2458
  MAX_ROWS?: number;
2481
- OFFSET?: number;
2482
- ORDER_BY?: string;
2459
+ CRITERIA_MATCH?: string;
2483
2460
  VIEW_NUMBER?: number;
2484
2461
  };
2485
2462
 
@@ -2492,13 +2469,12 @@ export type RequestParams = {
2492
2469
 
2493
2470
  // @public
2494
2471
  export type RequestServerResult = {
2472
+ SOURCE_REF?: string;
2473
+ REPLY: any[];
2495
2474
  MESSAGE_TYPE?: string;
2496
2475
  MORE_ROWS?: boolean;
2497
- NEXT_OFFSET?: number;
2498
2476
  NEXT_VIEW?: number;
2499
2477
  PARAMETRIC_TYPE?: string;
2500
- REPLY: any[];
2501
- SOURCE_REF?: string;
2502
2478
  ROWS_COUNT?: number;
2503
2479
  SEQUENCE_ID?: number;
2504
2480
  };
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.321.1-alpha-ada81fd.0",
4
+ "version": "14.321.1-alpha-c162d67.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.321.1-alpha-ada81fd.0",
79
- "@genesislcap/genx": "14.321.1-alpha-ada81fd.0",
80
- "@genesislcap/rollup-builder": "14.321.1-alpha-ada81fd.0",
81
- "@genesislcap/ts-builder": "14.321.1-alpha-ada81fd.0",
82
- "@genesislcap/uvu-playwright-builder": "14.321.1-alpha-ada81fd.0",
83
- "@genesislcap/vite-builder": "14.321.1-alpha-ada81fd.0",
84
- "@genesislcap/webpack-builder": "14.321.1-alpha-ada81fd.0",
78
+ "@genesislcap/foundation-testing": "14.321.1-alpha-c162d67.0",
79
+ "@genesislcap/genx": "14.321.1-alpha-c162d67.0",
80
+ "@genesislcap/rollup-builder": "14.321.1-alpha-c162d67.0",
81
+ "@genesislcap/ts-builder": "14.321.1-alpha-c162d67.0",
82
+ "@genesislcap/uvu-playwright-builder": "14.321.1-alpha-c162d67.0",
83
+ "@genesislcap/vite-builder": "14.321.1-alpha-c162d67.0",
84
+ "@genesislcap/webpack-builder": "14.321.1-alpha-c162d67.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.321.1-alpha-ada81fd.0",
92
- "@genesislcap/foundation-logger": "14.321.1-alpha-ada81fd.0",
93
- "@genesislcap/foundation-user": "14.321.1-alpha-ada81fd.0",
94
- "@genesislcap/foundation-utils": "14.321.1-alpha-ada81fd.0",
91
+ "@genesislcap/foundation-broadcast-channel": "14.321.1-alpha-c162d67.0",
92
+ "@genesislcap/foundation-logger": "14.321.1-alpha-c162d67.0",
93
+ "@genesislcap/foundation-user": "14.321.1-alpha-c162d67.0",
94
+ "@genesislcap/foundation-utils": "14.321.1-alpha-c162d67.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": "ce9c62abcd74697999a8f16bea51c82277f8749d"
113
+ "gitHead": "0c6c774a8adb3afab97e19801ebda9b7f5ebdd7d"
114
114
  }
@@ -1,13 +0,0 @@
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; [Datasource](./foundation-comms.datasource.md) &gt; [dataserverOnlyParams](./foundation-comms.datasource.dataserveronlyparams.md)
4
-
5
- ## Datasource.dataserverOnlyParams property
6
-
7
- Returns the datasource parameters that are only relevant for the data server.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- dataserverOnlyParams: DataserverParams;
13
- ```
@@ -1,13 +0,0 @@
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; [Datasource](./foundation-comms.datasource.md) &gt; [requestOnlyParams](./foundation-comms.datasource.requestonlyparams.md)
4
-
5
- ## Datasource.requestOnlyParams property
6
-
7
- Returns the request-only parameters for the datasource.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- requestOnlyParams: RequestParams;
13
- ```
@@ -1,50 +0,0 @@
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; [Datasource](./foundation-comms.datasource.md) &gt; [updateLoadMoreCount](./foundation-comms.datasource.updateloadmorecount.md)
4
-
5
- ## Datasource.updateLoadMoreCount() method
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- updateLoadMoreCount(count: number): void;
11
- ```
12
-
13
- ## Parameters
14
-
15
- <table><thead><tr><th>
16
-
17
- Parameter
18
-
19
-
20
- </th><th>
21
-
22
- Type
23
-
24
-
25
- </th><th>
26
-
27
- Description
28
-
29
-
30
- </th></tr></thead>
31
- <tbody><tr><td>
32
-
33
- count
34
-
35
-
36
- </td><td>
37
-
38
- number
39
-
40
-
41
- </td><td>
42
-
43
-
44
- </td></tr>
45
- </tbody></table>
46
-
47
- **Returns:**
48
-
49
- void
50
-
@@ -1,11 +0,0 @@
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; [DatasourceDefaults](./foundation-comms.datasourcedefaults.md) &gt; [DEFAULT\_REQ\_REP\_OFFSET](./foundation-comms.datasourcedefaults.default_req_rep_offset.md)
4
-
5
- ## DatasourceDefaults.DEFAULT\_REQ\_REP\_OFFSET property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- static readonly DEFAULT_REQ_REP_OFFSET = 0;
11
- ```
@@ -1,18 +0,0 @@
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; [offset](./foundation-comms.datasourceoptions.offset.md)
4
-
5
- ## DatasourceOptions.offset property
6
-
7
- The offset to use when fetching data.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- offset?: number;
13
- ```
14
-
15
- ## Remarks
16
-
17
- relates to MAX\_ROWS.
18
-
@@ -1,12 +0,0 @@
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; [criteriaOnlyRequest](./foundation-comms.defaultdatasource.criteriaonlyrequest.md)
4
-
5
- ## DefaultDatasource.criteriaOnlyRequest property
6
-
7
-
8
- **Signature:**
9
-
10
- ```typescript
11
- criteriaOnlyRequest: boolean;
12
- ```
@@ -1,13 +0,0 @@
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; [loadMoreCount](./foundation-comms.defaultdatasource.loadmorecount.md)
4
-
5
- ## DefaultDatasource.loadMoreCount property
6
-
7
- Track load more count for RequestServer temporary MAX\_ROWS calculation
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- loadMoreCount: number;
13
- ```