@genesislcap/foundation-comms 14.321.1-alpha-ada81fd.0 → 14.321.1-alpha-c162d67.0

package/dist/foundation-comms.api.json

@@ -5203,34 +5203,6 @@
               ],
               "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)",
@@ -5560,34 +5532,6 @@
                 "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",
@@ -6052,51 +5996,6 @@
               ],
               "name": "updateItem"
             },
-            {
-              "kind": "MethodSignature",
-              "canonicalReference": "@genesislcap/foundation-comms!Datasource#updateLoadMoreCount:member(1)",
-              "docComment": "",
-              "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)",
@@ -6421,40 +6320,6 @@
               "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",
@@ -10442,37 +10307,10 @@
                 "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",
+              "docComment": "/**\n * The field to use for sorting the data.\n *\n * @remarks\n *\n * Only works with DATASERVER.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -15453,36 +15291,6 @@
               "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",
@@ -15783,36 +15591,6 @@
               "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",
@@ -30324,7 +30102,7 @@
             },
             {
               "kind": "Content",
-              "text": "[];\n    ERROR?: string;\n    CRITERIA_ONLY_REQUEST?: boolean;\n}"
+              "text": "[];\n    ERROR?: string;\n}"
             },
             {
               "kind": "Content",
@@ -31970,7 +31748,7 @@
             },
             {
               "kind": "Content",
-              "text": "{\n    CRITERIA_MATCH?: string;\n    MAX_ROWS?: number;\n    OFFSET?: number;\n    ORDER_BY?: string;\n    VIEW_NUMBER?: number;\n}"
+              "text": "{\n    MAX_ROWS?: number;\n    CRITERIA_MATCH?: string;\n    VIEW_NUMBER?: number;\n}"
             },
             {
               "kind": "Content",
@@ -32031,7 +31809,7 @@
             },
             {
               "kind": "Content",
-              "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}"
+              "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}"
             },
             {
               "kind": "Content",

package/dist/foundation-comms.d.ts

@@ -1088,17 +1088,6 @@ 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;
-    updateLoadMoreCount(count: number): void;
 }
 
 /**
@@ -1145,7 +1134,6 @@ 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;
 }
 
 /**
@@ -1614,9 +1602,6 @@ 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;
 }
 
 /**
@@ -1625,27 +1610,23 @@ export declare class DatasourceMock implements Datasource {
  */
 export declare interface DatasourceOptions {
     /**
-     * The criteria used to filter data in the datasource.
-     * @remarks Works with both DATASERVER and REQUEST_SERVER resources.
+     * The name of the resource to use for the datasource.
      */
-    criteria?: string;
+    resourceName?: string;
     /**
      * Whether the datasource is a snapshot or not.
      */
     isSnapshot?: boolean;
     /**
-     * The maximum number of rows to return from the datasource.
+     * The criteria used to filter data in the datasource.
      * @remarks Works with both DATASERVER and REQUEST_SERVER resources.
      */
-    maxRows?: number;
-    /**
-     * The field to use for sorting the data.
-     */
-    orderBy?: string;
+    criteria?: string;
     /**
-     * The name of the resource to use for the datasource.
+     * The maximum number of rows to return from the datasource.
+     * @remarks Works with both DATASERVER and REQUEST_SERVER resources.
      */
-    resourceName?: string;
+    maxRows?: number;
     /**
      * The current page/"view" number being displayed.
      * @remarks Works with both DATASERVER and REQUEST_SERVER resources.
@@ -1666,6 +1647,11 @@ 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.
@@ -1676,12 +1662,6 @@ 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.
@@ -1689,15 +1669,15 @@ export declare interface DatasourceOptions {
      */
     pollingInterval?: number;
     /**
-     * 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;
     /**
-     * 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[];
     /**
      * Whether the Datasource service will setup RQUEST object based on metadata.
      * @remarks Default is `true`. Only works with REQUEST_SERVER resources.
@@ -1965,10 +1945,6 @@ 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;
@@ -2000,16 +1976,6 @@ 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;
@@ -3874,7 +3840,6 @@ export declare type Metadata = {
     TYPE?: string;
     INDEXES?: IndexDetail[];
     ERROR?: string;
-    CRITERIA_ONLY_REQUEST?: boolean;
 };
 
 /**
@@ -4202,10 +4167,8 @@ export declare type ReplyDetail = {
  * @public
  */
 export declare type RequestDetailsParam = {
-    CRITERIA_MATCH?: string;
     MAX_ROWS?: number;
-    OFFSET?: number;
-    ORDER_BY?: string;
+    CRITERIA_MATCH?: string;
     VIEW_NUMBER?: number;
 };
 
@@ -4224,13 +4187,12 @@ 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.md

@@ -42,25 +42,6 @@ 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)
 
 
@@ -96,25 +77,6 @@ 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>
 
@@ -351,15 +313,6 @@ _(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>
-
-
 </td></tr>
 <tr><td>
 

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

@@ -76,27 +76,6 @@ 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.datasourceoptions.md

@@ -167,25 +167,6 @@ 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.orderby.md

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

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

@@ -163,24 +163,6 @@ Description
 </td><td>
 
 
-</td></tr>
-<tr><td>
-
-[criteriaOnlyRequest](./foundation-comms.defaultdatasource.criteriaonlyrequest.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-
-
 </td></tr>
 <tr><td>
 
@@ -256,25 +238,6 @@ 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,7 +20,6 @@ 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,10 +9,8 @@
 
 ```typescript
 export type RequestDetailsParam = {
-    CRITERIA_MATCH?: string;
     MAX_ROWS?: number;
-    OFFSET?: number;
-    ORDER_BY?: string;
+    CRITERIA_MATCH?: string;
     VIEW_NUMBER?: number;
 };
 ```