@genesislcap/foundation-comms 14.323.0 → 14.324.1-alpha-1049010.0

package/docs/api/foundation-comms.datasource.updateloadmorecount.md

@@ -0,0 +1,54 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [Datasource](./foundation-comms.datasource.md) &gt; [updateLoadMoreCount](./foundation-comms.datasource.updateloadmorecount.md)
+
+## Datasource.updateLoadMoreCount() method
+
+Updates the load more (how many times user manually requested more data) count for the datasource.
+
+**Signature:**
+
+```typescript
+updateLoadMoreCount(count: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+count
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The new load more count.
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.datasourcedefaults.default_req_rep_offset.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[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)
+
+## DatasourceDefaults.DEFAULT\_REQ\_REP\_OFFSET property
+
+**Signature:**
+
+```typescript
+static readonly DEFAULT_REQ_REP_OFFSET = 0;
+```

package/docs/api/foundation-comms.datasourcedefaults.md

@@ -76,6 +76,27 @@ Description
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[DEFAULT\_REQ\_REP\_OFFSET](./foundation-comms.datasourcedefaults.default_req_rep_offset.md)
+
+
+</td><td>
+
+`static`
+
+`readonly`
+
+
+</td><td>
+
+(not declared)
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/api/foundation-comms.datasourcemetadata.criteriaonlyrequest.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DatasourceMetadata](./foundation-comms.datasourcemetadata.md) &gt; [criteriaOnlyRequest](./foundation-comms.datasourcemetadata.criteriaonlyrequest.md)
+
+## DatasourceMetadata.criteriaOnlyRequest property
+
+**Signature:**
+
+```typescript
+readonly criteriaOnlyRequest: boolean;
+```

package/docs/api/foundation-comms.datasourcemetadata.md

@@ -53,6 +53,25 @@ Description
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[criteriaOnlyRequest](./foundation-comms.datasourcemetadata.criteriaonlyrequest.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 
@@ -154,6 +173,8 @@ boolean
 
 </td><td>
 
+`readonly`
+
 
 </td><td>
 

package/docs/api/foundation-comms.datasourcemetadata.startstreamrequired.md

@@ -7,5 +7,5 @@
 **Signature:**
 
 ```typescript
-startStreamRequired: boolean;
+readonly startStreamRequired: boolean;
 ```

package/docs/api/foundation-comms.datasourceoptions.md

@@ -167,6 +167,25 @@ boolean
 _(Optional)_ Defines the behaviour of the client view when new rows are received in real time.
 
 
+</td></tr>
+<tr><td>
+
+[offset?](./foundation-comms.datasourceoptions.offset.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The offset to use when fetching data.
+
+
 </td></tr>
 <tr><td>
 

package/docs/api/foundation-comms.datasourceoptions.offset.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DatasourceOptions](./foundation-comms.datasourceoptions.md) &gt; [offset](./foundation-comms.datasourceoptions.offset.md)
+
+## DatasourceOptions.offset property
+
+The offset to use when fetching data.
+
+**Signature:**
+
+```typescript
+offset?: number;
+```
+
+## Remarks
+
+relates to MAX\_ROWS.
+

package/docs/api/foundation-comms.datasourceoptions.orderby.md

@@ -11,8 +11,3 @@ The field to use for sorting the data.
 ```typescript
 orderBy?: string;
 ```
-
-## Remarks
-
-Only works with DATASERVER.
-

package/docs/api/foundation-comms.defaultdatasource.criteriaonlyrequest.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultDatasource](./foundation-comms.defaultdatasource.md) &gt; [criteriaOnlyRequest](./foundation-comms.defaultdatasource.criteriaonlyrequest.md)
+
+## DefaultDatasource.criteriaOnlyRequest property
+
+
+**Signature:**
+
+```typescript
+criteriaOnlyRequest: boolean;
+```

package/docs/api/foundation-comms.defaultdatasource.loadmorecount.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultDatasource](./foundation-comms.defaultdatasource.md) &gt; [loadMoreCount](./foundation-comms.defaultdatasource.loadmorecount.md)
+
+## DefaultDatasource.loadMoreCount property
+
+Track load more count for RequestServer temporary MAX\_ROWS calculation
+
+**Signature:**
+
+```typescript
+loadMoreCount: number;
+```

package/docs/api/foundation-comms.defaultdatasource.md

@@ -163,6 +163,24 @@ Description
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[criteriaOnlyRequest](./foundation-comms.defaultdatasource.criteriaonlyrequest.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+
 </td></tr>
 <tr><td>
 
@@ -238,6 +256,25 @@ boolean
 Indicates whether the datasource has been initialized.
 
 
+</td></tr>
+<tr><td>
+
+[loadMoreCount](./foundation-comms.defaultdatasource.loadmorecount.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+Track load more count for RequestServer temporary MAX\_ROWS calculation
+
+
 </td></tr>
 <tr><td>
 

package/docs/api/foundation-comms.metadata.md

@@ -20,6 +20,7 @@ export type Metadata = {
     TYPE?: string;
     INDEXES?: IndexDetail[];
     ERROR?: string;
+    CRITERIA_ONLY_REQUEST?: boolean;
 };
 ```
 **References:** [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->, [ReplyDetail](./foundation-comms.replydetail.md)<!-- -->, [IndexDetail](./foundation-comms.indexdetail.md)

package/docs/api/foundation-comms.requestdetailsparam.md

@@ -9,8 +9,10 @@
 
 ```typescript
 export type RequestDetailsParam = {
-    MAX_ROWS?: number;
     CRITERIA_MATCH?: string;
+    MAX_ROWS?: number;
+    OFFSET?: number;
+    ORDER_BY?: string;
     VIEW_NUMBER?: number;
 };
 ```

package/docs/api/foundation-comms.requestserverresult.md

@@ -10,12 +10,13 @@ Raw result from a REQUEST\_SERVER data fetch.
 
 ```typescript
 export type RequestServerResult = {
-    SOURCE_REF?: string;
-    REPLY: any[];
     MESSAGE_TYPE?: string;
     MORE_ROWS?: boolean;
+    NEXT_OFFSET?: number;
     NEXT_VIEW?: number;
     PARAMETRIC_TYPE?: string;
+    REPLY: any[];
+    SOURCE_REF?: string;
     ROWS_COUNT?: number;
     SEQUENCE_ID?: number;
 };

package/docs/api-report.md.api.md

@@ -468,6 +468,7 @@ export interface Datasource extends DatasourceMetadata {
     clearFilter?(name: string): Promise<void>;
     createItem?(data: any): Promise<string>;
     dataHandler?(data: Array<any>): Array<any>;
+    dataserverOnlyParams: DataserverParams;
     deleteItem?(itemId: string): Promise<void>;
     destroy(): void;
     dropView?(view: Dataview): void;
@@ -475,6 +476,7 @@ export interface Datasource extends DatasourceMetadata {
     init(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
     initialized: boolean;
     readOnly: boolean;
+    requestOnlyParams: RequestParams;
     resourceType: ResourceType;
     setFilter?(name: string, value: any, type?: string): Promise<void>;
     snapshot(overrideParams?: any): Promise<Message>;
@@ -485,6 +487,7 @@ export interface Datasource extends DatasourceMetadata {
     stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
     updateData?(data: Array<any>): Promise<void>;
     updateItem?(itemId: string, data: any): Promise<void>;
+    updateLoadMoreCount(count: number): void;
     // @deprecated
     validResourceName(resourceName: string): boolean;
 }
@@ -515,6 +518,8 @@ export class DatasourceDefaults {
     // (undocumented)
     static readonly DEFAULT_PAGINATION_PAGE_SIZE = 25;
     // (undocumented)
+    static readonly DEFAULT_REQ_REP_OFFSET = 0;
+    // (undocumented)
     static readonly MAX_ROWS_250 = 250;
     // (undocumented)
     static readonly MAX_VIEW_1000 = 1000;
@@ -893,6 +898,8 @@ export interface DatasourceMetadata {
     // (undocumented)
     readonly availableIndexes: IndexDetail[];
     // (undocumented)
+    readonly criteriaOnlyRequest: boolean;
+    // (undocumented)
     readonly customRequestFields: MetadataDetail[];
     // (undocumented)
     fetchMetadataRequired: boolean;
@@ -903,7 +910,7 @@ export interface DatasourceMetadata {
     // (undocumented)
     readonly requestFields: MetadataDetail[];
     // (undocumented)
-    startStreamRequired: boolean;
+    readonly startStreamRequired: boolean;
 }
 
 // Warning: (ae-internal-missing-underscore) The name "DatasourceMock" should be prefixed with an underscore because the declaration is marked as @internal
@@ -919,10 +926,14 @@ export class DatasourceMock implements Datasource {
     // (undocumented)
     createItem?(data: any): Promise<string>;
     // (undocumented)
+    criteriaOnlyRequest: boolean;
+    // (undocumented)
     customRequestFields: MetadataDetail[];
     // (undocumented)
     dataHandler?(data: any[]): any[];
     // (undocumented)
+    get dataserverOnlyParams(): DataserverParams;
+    // (undocumented)
     deinit(): void;
     // (undocumented)
     deleteItem?(itemId: string): Promise<void>;
@@ -949,6 +960,8 @@ export class DatasourceMock implements Datasource {
     // (undocumented)
     requestFields: MetadataDetail[];
     // (undocumented)
+    get requestOnlyParams(): RequestParams;
+    // (undocumented)
     resourceType: ResourceType;
     // (undocumented)
     setFilter?(name: string, value: any, type?: string): Promise<void>;
@@ -975,6 +988,8 @@ export class DatasourceMock implements Datasource {
     // (undocumented)
     updateItem?(itemId: string, data: any): Promise<void>;
     // (undocumented)
+    updateLoadMoreCount(count: number): void;
+    // (undocumented)
     validResourceName(resourceName: string): boolean;
 }
 
@@ -987,6 +1002,7 @@ export interface DatasourceOptions {
     maxRows?: number;
     maxView?: number;
     movingView?: boolean;
+    offset?: number;
     orderBy?: string;
     pollingInterval?: number;
     pollTriggerEvents?: string[];
@@ -1238,6 +1254,8 @@ export class DefaultDatasource implements Datasource {
     // (undocumented)
     protected connectEvents: ConnectEvents;
     // (undocumented)
+    criteriaOnlyRequest: boolean;
+    // (undocumented)
     customRequestFields: MetadataDetail[];
     // @internal (undocumented)
     get dataserverOnlyParams(): DataserverParams;
@@ -1257,6 +1275,7 @@ export class DefaultDatasource implements Datasource {
     //
     // (undocumented)
     get initialized(): boolean;
+    loadMoreCount: number;
     // @internal (undocumented)
     protected normaliseStatus(status: Partial<DatasourceStatus>): DatasourceStatus;
     // (undocumented)
@@ -1289,6 +1308,8 @@ export class DefaultDatasource implements Datasource {
     status: DatasourceStatus;
     // (undocumented)
     stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
+    // @internal
+    updateLoadMoreCount(count: number): void;
     // @deprecated (undocumented)
     validResourceName(resourceName: string): boolean;
 }
@@ -2296,6 +2317,7 @@ export type Metadata = {
     TYPE?: string;
     INDEXES?: IndexDetail[];
     ERROR?: string;
+    CRITERIA_ONLY_REQUEST?: boolean;
 };
 
 // @public
@@ -2455,8 +2477,10 @@ export type ReplyDetail = {
 
 // @public (undocumented)
 export type RequestDetailsParam = {
-    MAX_ROWS?: number;
     CRITERIA_MATCH?: string;
+    MAX_ROWS?: number;
+    OFFSET?: number;
+    ORDER_BY?: string;
     VIEW_NUMBER?: number;
 };
 
@@ -2469,12 +2493,13 @@ export type RequestParams = {
 
 // @public
 export type RequestServerResult = {
-    SOURCE_REF?: string;
-    REPLY: any[];
     MESSAGE_TYPE?: string;
     MORE_ROWS?: boolean;
+    NEXT_OFFSET?: number;
     NEXT_VIEW?: number;
     PARAMETRIC_TYPE?: string;
+    REPLY: any[];
+    SOURCE_REF?: string;
     ROWS_COUNT?: number;
     SEQUENCE_ID?: number;
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-comms",
   "description": "Genesis Foundation UI Comms",
-  "version": "14.323.0",
+  "version": "14.324.1-alpha-1049010.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -75,23 +75,23 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.323.0",
-    "@genesislcap/genx": "14.323.0",
-    "@genesislcap/rollup-builder": "14.323.0",
-    "@genesislcap/ts-builder": "14.323.0",
-    "@genesislcap/uvu-playwright-builder": "14.323.0",
-    "@genesislcap/vite-builder": "14.323.0",
-    "@genesislcap/webpack-builder": "14.323.0",
+    "@genesislcap/foundation-testing": "14.324.1-alpha-1049010.0",
+    "@genesislcap/genx": "14.324.1-alpha-1049010.0",
+    "@genesislcap/rollup-builder": "14.324.1-alpha-1049010.0",
+    "@genesislcap/ts-builder": "14.324.1-alpha-1049010.0",
+    "@genesislcap/uvu-playwright-builder": "14.324.1-alpha-1049010.0",
+    "@genesislcap/vite-builder": "14.324.1-alpha-1049010.0",
+    "@genesislcap/webpack-builder": "14.324.1-alpha-1049010.0",
     "@types/js-cookie": "^3.0.2",
     "@types/json-schema": "^7.0.11",
     "@types/webappsec-credential-management": "^0.6.2",
     "sinon": "^17.0.1"
   },
   "dependencies": {
-    "@genesislcap/foundation-broadcast-channel": "14.323.0",
-    "@genesislcap/foundation-logger": "14.323.0",
-    "@genesislcap/foundation-user": "14.323.0",
-    "@genesislcap/foundation-utils": "14.323.0",
+    "@genesislcap/foundation-broadcast-channel": "14.324.1-alpha-1049010.0",
+    "@genesislcap/foundation-logger": "14.324.1-alpha-1049010.0",
+    "@genesislcap/foundation-user": "14.324.1-alpha-1049010.0",
+    "@genesislcap/foundation-utils": "14.324.1-alpha-1049010.0",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.49.6",
     "analytics": "0.8.16",
@@ -110,5 +110,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "08b2db7efcbbcc6498844c18a39c03187afa7cca"
+  "gitHead": "240ba3390b0cb59275850cc25e2a3604a852da5e"
 }