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

package/dist/foundation-comms.api.json

@@ -5203,6 +5203,34 @@
               ],
               "name": "dataHandler"
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-comms!Datasource#dataserverOnlyParams:member",
+              "docComment": "/**\n * Returns the datasource parameters that are only relevant for the data server.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "dataserverOnlyParams: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "DataserverParams",
+                  "canonicalReference": "@genesislcap/foundation-comms!DataserverParams:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "dataserverOnlyParams",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@genesislcap/foundation-comms!Datasource#deleteItem:member(1)",
@@ -5532,6 +5560,34 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-comms!Datasource#requestOnlyParams:member",
+              "docComment": "/**\n * Returns the request-only parameters for the datasource.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "requestOnlyParams: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RequestParams",
+                  "canonicalReference": "@genesislcap/foundation-comms!RequestParams:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "requestOnlyParams",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@genesislcap/foundation-comms!Datasource#resourceType:member",
@@ -5996,6 +6052,51 @@
               ],
               "name": "updateItem"
             },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-comms!Datasource#updateLoadMoreCount:member(1)",
+              "docComment": "/**\n * Updates the load more (how many times user manually requested more data) count for the datasource.\n *\n * @param count - The new load more count.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "updateLoadMoreCount(count: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "count",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "updateLoadMoreCount"
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@genesislcap/foundation-comms!Datasource#validResourceName:member(1)",
@@ -6320,6 +6421,40 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-comms!DatasourceDefaults.DEFAULT_REQ_REP_OFFSET:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "static readonly DEFAULT_REQ_REP_OFFSET = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "0"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "DEFAULT_REQ_REP_OFFSET",
+              "propertyTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              },
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": true,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-comms!DatasourceDefaults.MAX_ROWS_250:member",
@@ -9918,6 +10053,33 @@
                 "endIndex": 3
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-comms!DatasourceMetadata#criteriaOnlyRequest:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly criteriaOnlyRequest: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "criteriaOnlyRequest",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@genesislcap/foundation-comms!DatasourceMetadata#customRequestFields:member",
@@ -10080,7 +10242,7 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "startStreamRequired: "
+                  "text": "readonly startStreamRequired: "
                 },
                 {
                   "kind": "Content",
@@ -10091,7 +10253,7 @@
                   "text": ";"
                 }
               ],
-              "isReadonly": false,
+              "isReadonly": true,
               "isOptional": false,
               "releaseTag": "Public",
               "name": "startStreamRequired",
@@ -10307,10 +10469,37 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#offset:member",
+              "docComment": "/**\n * The offset to use when fetching data.\n *\n * @remarks\n *\n * relates to MAX_ROWS.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "offset?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "offset",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions#orderBy:member",
-              "docComment": "/**\n * The field to use for sorting the data.\n *\n * @remarks\n *\n * Only works with DATASERVER.\n */\n",
+              "docComment": "/**\n * The field to use for sorting the data.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -15291,6 +15480,36 @@
               "isProtected": true,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#criteriaOnlyRequest:member",
+              "docComment": "/**\n * {@inheritDoc DatasourceMetadata.criteriaOnlyRequest}\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "criteriaOnlyRequest: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "criteriaOnlyRequest",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#customRequestFields:member",
@@ -15591,6 +15810,36 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#loadMoreCount:member",
+              "docComment": "/**\n * Track load more count for RequestServer temporary MAX_ROWS calculation\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "loadMoreCount: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "loadMoreCount",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-comms!DefaultDatasource#options:member",
@@ -30102,7 +30351,7 @@
             },
             {
               "kind": "Content",
-              "text": "[];\n    ERROR?: string;\n}"
+              "text": "[];\n    ERROR?: string;\n    CRITERIA_ONLY_REQUEST?: boolean;\n}"
             },
             {
               "kind": "Content",
@@ -31748,7 +31997,7 @@
             },
             {
               "kind": "Content",
-              "text": "{\n    MAX_ROWS?: number;\n    CRITERIA_MATCH?: string;\n    VIEW_NUMBER?: number;\n}"
+              "text": "{\n    CRITERIA_MATCH?: string;\n    MAX_ROWS?: number;\n    OFFSET?: number;\n    ORDER_BY?: string;\n    VIEW_NUMBER?: number;\n}"
             },
             {
               "kind": "Content",
@@ -31809,7 +32058,7 @@
             },
             {
               "kind": "Content",
-              "text": "{\n    SOURCE_REF?: string;\n    REPLY: any[];\n    MESSAGE_TYPE?: string;\n    MORE_ROWS?: boolean;\n    NEXT_VIEW?: number;\n    PARAMETRIC_TYPE?: string;\n    ROWS_COUNT?: number;\n    SEQUENCE_ID?: number;\n}"
+              "text": "{\n    MESSAGE_TYPE?: string;\n    MORE_ROWS?: boolean;\n    NEXT_OFFSET?: number;\n    NEXT_VIEW?: number;\n    PARAMETRIC_TYPE?: string;\n    REPLY: any[];\n    SOURCE_REF?: string;\n    ROWS_COUNT?: number;\n    SEQUENCE_ID?: number;\n}"
             },
             {
               "kind": "Content",

package/dist/foundation-comms.d.ts

@@ -1088,6 +1088,21 @@ export declare interface Datasource extends DatasourceMetadata {
      * @returns A promise that resolves when the item has been updated.
      */
     updateItem?(itemId: string, data: any): Promise<void>;
+    /**
+     * Returns the datasource parameters that are only relevant for the data server.
+     * @public
+     */
+    dataserverOnlyParams: DataserverParams;
+    /**
+     * Returns the request-only parameters for the datasource.
+     * @public
+     */
+    requestOnlyParams: RequestParams;
+    /**
+     * Updates the load more (how many times user manually requested more data) count for the datasource.
+     * @param count - The new load more count.
+     */
+    updateLoadMoreCount(count: number): void;
 }
 
 /**
@@ -1134,6 +1149,7 @@ export declare class DatasourceDefaults {
     static readonly DATASERVER_ROW_ID = "ROW_REF";
     static readonly REQUEST_SERVER_ROW_ID = "RECORD_ID";
     static readonly DEFAULT_PAGINATION_PAGE_SIZE = 25;
+    static readonly DEFAULT_REQ_REP_OFFSET = 0;
 }
 
 /**
@@ -1553,7 +1569,8 @@ export declare interface DatasourceMetadata {
     readonly fieldMetadata: FieldMetadata[];
     readonly requestFields: MetadataDetail[];
     readonly customRequestFields: MetadataDetail[];
-    startStreamRequired: boolean;
+    readonly startStreamRequired: boolean;
+    readonly criteriaOnlyRequest: boolean;
 }
 
 /**
@@ -1568,6 +1585,7 @@ export declare class DatasourceMock implements Datasource {
     requestFields: MetadataDetail[];
     customRequestFields: MetadataDetail[];
     availableIndexes: IndexDetail[];
+    criteriaOnlyRequest: boolean;
     startStreamRequired: boolean;
     initialized: boolean;
     readOnly: boolean;
@@ -1602,6 +1620,9 @@ export declare class DatasourceMock implements Datasource {
     createItem?(data: any): Promise<string>;
     deleteItem?(itemId: string): Promise<void>;
     updateItem?(itemId: string, data: any): Promise<void>;
+    get dataserverOnlyParams(): DataserverParams;
+    get requestOnlyParams(): RequestParams;
+    updateLoadMoreCount(count: number): void;
 }
 
 /**
@@ -1610,23 +1631,27 @@ export declare class DatasourceMock implements Datasource {
  */
 export declare interface DatasourceOptions {
     /**
-     * The name of the resource to use for the datasource.
+     * The criteria used to filter data in the datasource.
+     * @remarks Works with both DATASERVER and REQUEST_SERVER resources.
      */
-    resourceName?: string;
+    criteria?: string;
     /**
      * Whether the datasource is a snapshot or not.
      */
     isSnapshot?: boolean;
-    /**
-     * The criteria used to filter data in the datasource.
-     * @remarks Works with both DATASERVER and REQUEST_SERVER resources.
-     */
-    criteria?: string;
     /**
      * The maximum number of rows to return from the datasource.
      * @remarks Works with both DATASERVER and REQUEST_SERVER resources.
      */
     maxRows?: number;
+    /**
+     * The field to use for sorting the data.
+     */
+    orderBy?: string;
+    /**
+     * The name of the resource to use for the datasource.
+     */
+    resourceName?: string;
     /**
      * The current page/"view" number being displayed.
      * @remarks Works with both DATASERVER and REQUEST_SERVER resources.
@@ -1647,11 +1672,6 @@ export declare interface DatasourceOptions {
      * @remarks Only works with DATASERVER resources.
      */
     movingView?: boolean;
-    /**
-     * The field to use for sorting the data.
-     * @remarks Only works with DATASERVER.
-     */
-    orderBy?: string;
     /**
      * Whether to return the data in reverse order or not.
      * @remarks Only works with DATASERVER resources.
@@ -1662,6 +1682,12 @@ export declare interface DatasourceOptions {
      * @remarks Only works with REQUEST_SERVER resources.
      */
     disablePolling?: boolean;
+    /**
+     * The offset to use when fetching data.
+     * @remarks Only works with REQUEST_SERVER resources.
+     * @remarks relates to MAX_ROWS.
+     */
+    offset?: number;
     /**
      * The polling interval to use when using request/reply.
      * @remarks Only works with REQUEST_SERVER resources.
@@ -1669,15 +1695,15 @@ export declare interface DatasourceOptions {
      */
     pollingInterval?: number;
     /**
-     * The request to send to the server.
+     * Array of event names that will trigger an additional poll.
      * @remarks Only works with REQUEST_SERVER resources.
      */
-    request?: any;
+    pollTriggerEvents?: string[];
     /**
-     * Array of event names that will trigger an additional poll.
+     * The request to send to the server.
      * @remarks Only works with REQUEST_SERVER resources.
      */
-    pollTriggerEvents?: string[];
+    request?: any;
     /**
      * Whether the Datasource service will setup RQUEST object based on metadata.
      * @remarks Default is `true`. Only works with REQUEST_SERVER resources.
@@ -1945,6 +1971,10 @@ export declare class DefaultDatasource implements Datasource {
     customRequestFields: MetadataDetail[];
     /** {@inheritDoc DatasourceMetadata.availableIndexes} */
     availableIndexes: IndexDetail[];
+    /** {@inheritDoc DatasourceMetadata.criteriaOnlyRequest} */
+    criteriaOnlyRequest: boolean;
+    /** Track load more count for RequestServer temporary MAX_ROWS calculation */
+    loadMoreCount: number;
     /** {@inheritDoc Datasource.initialized} */
     get initialized(): boolean;
     readOnly: boolean;
@@ -1976,6 +2006,16 @@ export declare class DefaultDatasource implements Datasource {
      * @internal
      */
     get requestOnlyParams(): RequestParams;
+    /**
+     * @internal
+     * Builds REQUEST fields object for auto-setup scenarios.
+     */
+    private buildRequestFields;
+    /**
+     * Updates the load more count for RequestServer scenarios
+     * @internal
+     */
+    updateLoadMoreCount(count: number): void;
     snapshot(overrideParams?: any): Promise<Message>;
     snapshotFiltered(rowId?: string): Promise<any[]>;
     private createStream;
@@ -3840,6 +3880,7 @@ export declare type Metadata = {
     TYPE?: string;
     INDEXES?: IndexDetail[];
     ERROR?: string;
+    CRITERIA_ONLY_REQUEST?: boolean;
 };
 
 /**
@@ -4167,8 +4208,10 @@ export declare type ReplyDetail = {
  * @public
  */
 export declare type RequestDetailsParam = {
-    MAX_ROWS?: number;
     CRITERIA_MATCH?: string;
+    MAX_ROWS?: number;
+    OFFSET?: number;
+    ORDER_BY?: string;
     VIEW_NUMBER?: number;
 };
 
@@ -4187,12 +4230,13 @@ export declare type RequestParams = {
  * @public
  */
 export declare 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/foundation-comms.datasource.dataserveronlyparams.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; [Datasource](./foundation-comms.datasource.md) &gt; [dataserverOnlyParams](./foundation-comms.datasource.dataserveronlyparams.md)
+
+## Datasource.dataserverOnlyParams property
+
+Returns the datasource parameters that are only relevant for the data server.
+
+**Signature:**
+
+```typescript
+dataserverOnlyParams: DataserverParams;
+```

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

@@ -42,6 +42,25 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[dataserverOnlyParams](./foundation-comms.datasource.dataserveronlyparams.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[DataserverParams](./foundation-comms.dataserverparams.md)
+
+
+</td><td>
+
+Returns the datasource parameters that are only relevant for the data server.
+
+
+</td></tr>
+<tr><td>
+
 [initialized](./foundation-comms.datasource.initialized.md)
 
 
@@ -77,6 +96,25 @@ boolean
 Indicates whether the datasource is read-only. TODO: Should have is prefix
 
 
+</td></tr>
+<tr><td>
+
+[requestOnlyParams](./foundation-comms.datasource.requestonlyparams.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[RequestParams](./foundation-comms.requestparams.md)
+
+
+</td><td>
+
+Returns the request-only parameters for the datasource.
+
+
 </td></tr>
 <tr><td>
 
@@ -313,6 +351,17 @@ _(Optional)_ Updates the data in the datasource with the specified data.
 _(Optional)_ Updates an item in the datasource with the given ID and data.
 
 
+</td></tr>
+<tr><td>
+
+[updateLoadMoreCount(count)](./foundation-comms.datasource.updateloadmorecount.md)
+
+
+</td><td>
+
+Updates the load more (how many times user manually requested more data) count for the datasource.
+
+
 </td></tr>
 <tr><td>
 

package/docs/api/foundation-comms.datasource.requestonlyparams.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; [Datasource](./foundation-comms.datasource.md) &gt; [requestOnlyParams](./foundation-comms.datasource.requestonlyparams.md)
+
+## Datasource.requestOnlyParams property
+
+Returns the request-only parameters for the datasource.
+
+**Signature:**
+
+```typescript
+requestOnlyParams: RequestParams;
+```