@genesislcap/foundation-comms 14.200.1-alpha-e974201.0 → 14.202.0

package/dist/foundation-comms.d.ts

@@ -288,10 +288,11 @@ export declare interface Connect {
     /**
      * Requests additional rows of data for the specified source reference.
      * @public
-     * @param sourceRef - The source reference to request more rows for.
+     * @param sourceRef - An existing source reference to request more rows for.
+     * @param viewNumber - The specific view number to request more rows for. Default: previous view number result + 1.
      * @returns A promise that resolves with the additional rows of data.
      */
-    getMoreRows(sourceRef: string): Promise<Message>;
+    getMoreRows(sourceRef: string, viewNumber?: number): Promise<Message>;
     /**
      * Requests additional columns for the specified source reference.
      * @public
@@ -855,6 +856,7 @@ export declare interface Datasource extends DatasourceMetadata {
     /**
      * Indicates whether the resourceName is valid or not.
      * @public
+     * @deprecated - Please use {@link (GenesisResources:interface).isValidResource} instead.
      */
     validResourceName(resourceName: string): boolean;
     /**
@@ -862,15 +864,21 @@ export declare interface Datasource extends DatasourceMetadata {
      * @public
      * @param options - The options to initialize the datasource with.
      * @param fetchMeta - Optional flag to fetch metadata for the datasource. Defaults to true.
+     * @param startStream - Optional flag to start the data stream. Defaults to true.
      * @returns A promise that resolves with a boolean indicating whether the initialization was successful.
      */
-    init(options: DatasourceOptions, fetchMeta?: boolean): Promise<boolean>;
+    init(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
+    /**
+     * Starts the data stream for the datasource.
+     * @public
+     */
+    startStream(): Promise<void>;
     /**
-     * Deinitializes the datasource.
+     * Destroys the datasource.
      * @remarks This should be called to clean up any resources when the datasource is no longer needed.
      * @public
      */
-    deinit(): any;
+    destroy(): void;
     /**
      * Fetches metadata for the specified resource name.
      * @public
@@ -881,15 +889,15 @@ export declare interface Datasource extends DatasourceMetadata {
     /**
      * Takes a snapshot of the data in the datasource.
      * @public
-     * @param params - Optional parameters for taking the snapshot.
+     * @param overrideParams - Optional parameters for taking the snapshot.
      */
-    snapshot(params?: any): any;
+    snapshot(overrideParams?: any): Promise<Message>;
     /**
      * Takes a filtered snapshot of the data in the datasource.
      * @public
      * @param rowId - Optional ID of the row to filter.
      */
-    snapshotFiltered(rowId?: string): any;
+    snapshotFiltered(rowId?: string): Promise<any[]>;
     /**
      * Updates the data in the datasource with the specified data.
      * @public
@@ -954,13 +962,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>;
-    /**
-     * Destroy the datasource.
-     * @privateRemarks
-     * I suspect we may need to call this from datasource disconnectedCallbacks etc to ensure we fully clean up.
-     * @public
-     */
-    destroy(): void;
 }
 
 /**
@@ -1383,6 +1384,7 @@ export declare interface DatasourceMetadata {
     readonly originalFieldDef: MetadataDetail[];
     readonly fieldMetadata: FieldMetadata[];
     readonly requestFields: MetadataDetail[];
+    readonly customRequestFields: MetadataDetail[];
 }
 
 /**
@@ -1395,12 +1397,14 @@ export declare class DatasourceMock implements Datasource {
     originalFieldDef: MetadataDetail[];
     fieldMetadata: FieldMetadata[];
     requestFields: MetadataDetail[];
+    customRequestFields: MetadataDetail[];
     availableIndexes: IndexDetail[];
     initialized: boolean;
     readOnly: boolean;
     resourceType: ResourceType;
     stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
     init(options: DatasourceOptions, fetchMeta: boolean): Promise<boolean>;
+    startStream(): Promise<void>;
     /**
      * Convenience method to avoid you having to prime connect etc.
      * @param meta - The metadata to set.
@@ -1417,8 +1421,8 @@ export declare class DatasourceMock implements Datasource {
     destroy(): void;
     validResourceName(resourceName: string): boolean;
     getMetadata?(resourceName: string): Promise<FieldMetadata[]>;
-    snapshot(params?: any): void;
-    snapshotFiltered(rowId?: string): void;
+    snapshot(params?: any): Promise<Message<any>>;
+    snapshotFiltered(rowId?: string): Promise<any[]>;
     updateData?(data: any[]): Promise<void>;
     dataHandler?(data: any[]): any[];
     addView?(view: Dataview): void;
@@ -1436,54 +1440,74 @@ export declare class DatasourceMock implements Datasource {
  */
 export declare interface DatasourceOptions {
     /**
-     * The criteria used to filter data in the datasource.
-     */
-    criteria?: string;
-    /**
-     * The fields to include in the returned data.
+     * The name of the resource to use for the datasource.
      */
-    fields?: string;
+    resourceName?: 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 current page/"view" number being displayed.
+     * @remarks Works with both DATASERVER and REQUEST_SERVER resources.
+     */
+    viewNumber?: number;
+    /**
+     * The fields to include in the returned data.
+     * @remarks Only works with DATASERVER resources.
+     */
+    fields?: string;
     /**
      * The maximum number of rows to track as part of a client "view"
+     * @remarks Only works with DATASERVER resources.
      */
     maxView?: number;
     /**
      * Defines the behaviour of the client view when new rows are received in real time.
+     * @remarks Only works with DATASERVER resources.
      */
     movingView?: boolean;
     /**
-     * The polling interval to use when using request/reply.
-     * @remarks in milliseconds
+     * The field to use for sorting the data.
+     * @remarks Only works with DATASERVER.
      */
-    pollingInterval?: number;
+    orderBy?: string;
+    /**
+     * Whether to return the data in reverse order or not.
+     * @remarks Only works with DATASERVER resources.
+     */
+    reverse?: boolean;
     /**
      * Whether to disable polling when using request/reply
+     * @remarks Only works with REQUEST_SERVER resources.
      */
     disablePolling?: boolean;
     /**
-     * The field to use for sorting the data.
+     * The polling interval to use when using request/reply.
+     * @remarks Only works with REQUEST_SERVER resources.
+     * @remarks in milliseconds
      */
-    orderBy?: string;
+    pollingInterval?: number;
     /**
      * The request to send to the server.
+     * @remarks Only works with REQUEST_SERVER resources.
      */
     request?: any;
     /**
-     * The name of the resource to use for the datasource.
-     */
-    resourceName?: string;
-    /**
-     * Whether to return the data in reverse order or not.
+     * Whether the Datasource service will setup RQUEST object based on metadata.
+     * @remarks Default is `true`. Only works with REQUEST_SERVER resources.
      */
-    reverse?: boolean;
+    requestAutoSetup?: boolean;
 }
 
 /**
@@ -1616,7 +1640,7 @@ export declare class DefaultConnect implements Connect {
     stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
     streamState(resourceName: string, onMessage?: Function, onError?: Function, params?: any, initialState?: any[]): Observable<any[]>;
     streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
-    getMoreRows(sourceRef: string): Promise<Message>;
+    getMoreRows(sourceRef: string, viewNumber?: number): Promise<Message>;
     getMoreColumns(sourceRef: string): Promise<Message>;
     dataLogoff(streamSourceRef: string): Promise<Message>;
     getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
@@ -1727,12 +1751,16 @@ export declare class DefaultDatasource implements Datasource {
     status: DatasourceStatus;
     /** {@inheritDoc DatasourceMetadata.fetchMetadataRequired} */
     fetchMetadataRequired: boolean;
+    /** {@inheritDoc DatasourceMetadata.startStream} */
+    startStreamRequired: boolean;
     /** {@inheritDoc DatasourceMetadata.originalFieldDef} */
     originalFieldDef: MetadataDetail[];
     /** {@inheritDoc DatasourceMetadata.fieldMetadata} */
     fieldMetadata: FieldMetadata[];
     /** {@inheritDoc DatasourceMetadata.requestFields} */
     requestFields: MetadataDetail[];
+    /** {@inheritDoc DatasourceMetadata.customRequestFields} */
+    customRequestFields: MetadataDetail[];
     /** {@inheritDoc DatasourceMetadata.availableIndexes} */
     availableIndexes: IndexDetail[];
     /** {@inheritDoc Datasource.initialized} */
@@ -1746,12 +1774,12 @@ export declare class DefaultDatasource implements Datasource {
      * @deprecated - Please use {@link (GenesisResources:interface).isValidResource} instead.
      */
     validResourceName(resourceName: string): boolean;
-    init(options: DatasourceOptions, fetchMeta?: boolean): Promise<boolean>;
-    deinit(): void;
+    init(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
+    startStream(): Promise<void>;
     /** {@inheritDoc Datasource.destroy} */
     destroy(): void;
     get params(): any;
-    snapshot(): Promise<Message>;
+    snapshot(overrideParams?: any): Promise<Message>;
     snapshotFiltered(rowId?: string): Promise<any[]>;
     private createStream;
     private createDataserverStream;
@@ -2027,7 +2055,7 @@ export declare class DefaultMessageBuilder implements MessageBuilder {
     createChangePasswordMessage(username: string, oldPassword: string, newPassword: string): Message<MessageDetails.ChangePassword>;
     createForgotPasswordMessage(username: string, returnUrl: string, requester?: string): Message<MessageDetails.ForgotPassword>;
     createForgotPasswordTokenMessage(username: string, resetToken: string, newPassword: string, requester?: string): Message<MessageDetails.ForgotPasswordToken>;
-    createMoreRowsMessage(sourceRef: string): Message;
+    createMoreRowsMessage(sourceRef: string, viewNumber?: number): Message<MessageDetails.MoreRows>;
     createMoreColumnsMessage(sourceRef: string): Message;
     createHTTPHeadersFromMessage(message: Message, contentType?: string): HeadersInit;
     /** {@inheritDoc MessageBuilder.createHeartbeatPingMessage} */
@@ -3251,10 +3279,11 @@ export declare interface MessageBuilder {
      *
      * @remarks MORE_ROWS
      * @public
-     * @param sourceRef - The source reference.
+     * @param sourceRef - The unique source reference.
+     * @param viewNumber - The desired view number. Default:always the first view, if not spceified.
      * @returns The more rows message.
      */
-    createMoreRowsMessage(sourceRef: string): Message;
+    createMoreRowsMessage(sourceRef: string, viewNumber?: number): Message<MessageDetails.MoreRows>;
     /**
      * Creates a message to request more columns.
      *
@@ -3274,7 +3303,7 @@ export declare interface MessageBuilder {
      * @param params - The additional parameters.
      * @returns The request message.
      */
-    createRequestMessage<T = any>(resourceName: string, params?: any): Message<T>;
+    createRequestMessage<T = any>(resourceName: string, params?: RequestParams): Message<T>;
     /**
      * Creates a message for getting list of resources.
      *
@@ -3459,6 +3488,7 @@ export declare namespace MessageDetails {
      */
     export type MoreRows = {
         SOURCE_REF: string;
+        VIEW_NUMBER?: number;
     };
     /**
      * Details type to update columns
@@ -3569,12 +3599,15 @@ export declare const MetaCache: InterfaceSymbol<MetaCache>;
  * @public
  */
 export declare type Metadata = {
+    DEFINITIONS?: Record<string, any>;
+    DESCRIPTION?: string;
     FIELD?: MetadataDetail[];
-    INDEXES?: IndexDetail[];
+    REPLY?: ReplyDetail;
     REPLY_FIELD?: MetadataDetail[];
     REQUEST_FIELD?: MetadataDetail[];
     NAME?: string;
     TYPE?: string;
+    INDEXES?: IndexDetail[];
     ERROR?: string;
 };
 
@@ -3618,9 +3651,12 @@ export declare interface MetadataCache {
 export declare type MetadataDetail = {
     NAME: string;
     TYPE: string;
+    DESCRIPTION?: string;
+    JSON_TYPE?: string;
     VALID_VALUES?: string;
     READ_ONLY?: boolean;
     OPTIONAL?: boolean;
+    NULLABLE?: boolean;
     UI_LABEL?: string;
 };
 
@@ -3876,12 +3912,32 @@ export declare type RefreshCredentialsInput = {
     mfaToken?: string;
 };
 
+/**
+ * Reply Detail definition.
+ * @public
+ */
+export declare type ReplyDetail = {
+    DEFINITIONS?: Record<string, any>;
+    DESCRIPTION?: string;
+    FIELD: MetadataDetail[];
+    NAME: string;
+    [key: string]: any;
+};
+
+/**
+ * @public
+ */
+export declare type RequestDetailsParam = {
+    MAX_ROWS?: number;
+    CRITERIA_MATCH?: string;
+};
+
 /**
  * Parameters for a REQUEST message
  * @public
  */
 export declare type RequestParams = {
-    DETAILS?: any;
+    DETAILS?: RequestDetailsParam | any;
     REQUEST?: any;
 };
 
@@ -3893,6 +3949,11 @@ export declare type RequestServerResult = {
     SOURCE_REF?: string;
     REPLY: any[];
     MESSAGE_TYPE?: string;
+    MORE_ROWS?: boolean;
+    NEXT_VIEW?: number;
+    PARAMETRIC_TYPE?: string;
+    ROWS_COUNT?: number;
+    SEQUENCE_ID?: number;
 };
 
 declare type RESOURCE_DETAILS = {

package/docs/api/foundation-comms.connect.getmorerows.md

@@ -9,14 +9,15 @@ Requests additional rows of data for the specified source reference.
 **Signature:**
 
 ```typescript
-getMoreRows(sourceRef: string): Promise<Message>;
+getMoreRows(sourceRef: string, viewNumber?: number): Promise<Message>;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  sourceRef | string | The source reference to request more rows for. |
+|  sourceRef | string | An existing source reference to request more rows for. |
+|  viewNumber | number | _(Optional)_ The specific view number to request more rows for. Default: previous view number result + 1. |
 
 **Returns:**
 

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

@@ -34,7 +34,7 @@ export interface Connect
 |  [getJSONSchema(resourceName)](./foundation-comms.connect.getjsonschema.md) | Retrieves the JSON schema for the specified resource. |
 |  [getMetadata(resourceName, useCache)](./foundation-comms.connect.getmetadata.md) | Retrieves the metadata for the specified resource. |
 |  [getMoreColumns(sourceRef)](./foundation-comms.connect.getmorecolumns.md) | Requests additional columns for the specified source reference. |
-|  [getMoreRows(sourceRef)](./foundation-comms.connect.getmorerows.md) | Requests additional rows of data for the specified source reference. |
+|  [getMoreRows(sourceRef, viewNumber)](./foundation-comms.connect.getmorerows.md) | Requests additional rows of data for the specified source reference. |
 |  [request(resourceName, params)](./foundation-comms.connect.request.md) | Sends a request to the server to retrieve data or perform an action. |
 |  [snapshot(resourceName, params)](./foundation-comms.connect.snapshot.md) | Retrieves a snapshot of data for the specified resource. |
 |  [stream(resourceName, onMessage, onError, params)](./foundation-comms.connect.stream.md) | Starts listening for updates on the specified resource. |

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

@@ -4,7 +4,7 @@
 
 ## Datasource.destroy() method
 
-Destroy the datasource.
+Destroys the datasource.
 
 **Signature:**
 
@@ -15,3 +15,7 @@ destroy(): void;
 
 void
 
+## Remarks
+
+This should be called to clean up any resources when the datasource is no longer needed.
+

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

@@ -9,7 +9,7 @@ Initializes the datasource with the given options and fetches metadata if specif
 **Signature:**
 
 ```typescript
-init(options: DatasourceOptions, fetchMeta?: boolean): Promise<boolean>;
+init(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
 ```
 
 ## Parameters
@@ -18,6 +18,7 @@ init(options: DatasourceOptions, fetchMeta?: boolean): Promise<boolean>;
 |  --- | --- | --- |
 |  options | [DatasourceOptions](./foundation-comms.datasourceoptions.md) | The options to initialize the datasource with. |
 |  fetchMeta | boolean | _(Optional)_ Optional flag to fetch metadata for the datasource. Defaults to true. |
+|  startStream | boolean | _(Optional)_ Optional flag to start the data stream. Defaults to true. |
 
 **Returns:**
 

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

@@ -35,15 +35,15 @@ The public interface available on the injected store fragment.
 |  [clearFilter(name)?](./foundation-comms.datasource.clearfilter.md) | _(Optional)_ Clears the filter with the specified name from the datasource. |
 |  [createItem(data)?](./foundation-comms.datasource.createitem.md) | _(Optional)_ Creates a new item in the datasource with the specified data. |
 |  [dataHandler(data)?](./foundation-comms.datasource.datahandler.md) | _(Optional)_ Handles the specified data and returns it. |
-|  [deinit()](./foundation-comms.datasource.deinit.md) | Deinitializes the datasource. |
 |  [deleteItem(itemId)?](./foundation-comms.datasource.deleteitem.md) | _(Optional)_ Deletes an item with the given ID from the datasource. |
-|  [destroy()](./foundation-comms.datasource.destroy.md) | Destroy the datasource. |
+|  [destroy()](./foundation-comms.datasource.destroy.md) | Destroys the datasource. |
 |  [dropView(view)?](./foundation-comms.datasource.dropview.md) | _(Optional)_ Removes the specified dataview from the datasource. |
 |  [getMetadata(resourceName)?](./foundation-comms.datasource.getmetadata.md) | _(Optional)_ Fetches metadata for the specified resource name. |
-|  [init(options, fetchMeta)](./foundation-comms.datasource.init.md) | Initializes the datasource with the given options and fetches metadata if specified. |
+|  [init(options, fetchMeta, startStream)](./foundation-comms.datasource.init.md) | Initializes the datasource with the given options and fetches metadata if specified. |
 |  [setFilter(name, value, type)?](./foundation-comms.datasource.setfilter.md) | _(Optional)_ Sets a filter on the datasource with the specified name, value, and type. |
-|  [snapshot(params)](./foundation-comms.datasource.snapshot.md) | Takes a snapshot of the data in the datasource. |
+|  [snapshot(overrideParams)](./foundation-comms.datasource.snapshot.md) | Takes a snapshot of the data in the datasource. |
 |  [snapshotFiltered(rowId)](./foundation-comms.datasource.snapshotfiltered.md) | Takes a filtered snapshot of the data in the datasource. |
+|  [startStream()](./foundation-comms.datasource.startstream.md) | Starts the data stream for the datasource. |
 |  [updateData(data)?](./foundation-comms.datasource.updatedata.md) | _(Optional)_ Updates the data in the datasource with the specified data. |
 |  [updateItem(itemId, data)?](./foundation-comms.datasource.updateitem.md) | _(Optional)_ Updates an item in the datasource with the given ID and data. |
 |  [validResourceName(resourceName)](./foundation-comms.datasource.validresourcename.md) | Indicates whether the resourceName is valid or not. |

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

@@ -9,16 +9,16 @@ Takes a snapshot of the data in the datasource.
 **Signature:**
 
 ```typescript
-snapshot(params?: any): any;
+snapshot(overrideParams?: any): Promise<Message>;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  params | any | _(Optional)_ Optional parameters for taking the snapshot. |
+|  overrideParams | any | _(Optional)_ Optional parameters for taking the snapshot. |
 
 **Returns:**
 
-any
+Promise&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
 

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

@@ -9,7 +9,7 @@ Takes a filtered snapshot of the data in the datasource.
 **Signature:**
 
 ```typescript
-snapshotFiltered(rowId?: string): any;
+snapshotFiltered(rowId?: string): Promise<any[]>;
 ```
 
 ## Parameters
@@ -20,5 +20,5 @@ snapshotFiltered(rowId?: string): any;
 
 **Returns:**
 
-any
+Promise&lt;any\[\]&gt;
 

package/docs/api/{foundation-comms.datasource.deinit.md → foundation-comms.datasource.startstream.md}

@@ -1,21 +1,17 @@
 <!-- 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; [deinit](./foundation-comms.datasource.deinit.md)
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [Datasource](./foundation-comms.datasource.md) &gt; [startStream](./foundation-comms.datasource.startstream.md)
 
-## Datasource.deinit() method
+## Datasource.startStream() method
 
-Deinitializes the datasource.
+Starts the data stream for the datasource.
 
 **Signature:**
 
 ```typescript
-deinit(): any;
+startStream(): Promise<void>;
 ```
 **Returns:**
 
-any
-
-## Remarks
-
-This should be called to clean up any resources when the datasource is no longer needed.
+Promise&lt;void&gt;
 

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

@@ -4,6 +4,11 @@
 
 ## Datasource.validResourceName() method
 
+> Warning: This API is now obsolete.
+> 
+> - Please use [GenesisResources.isValidResource](./foundation-comms.genesisresources.isvalidresource.md) instead.
+> 
+
 Indicates whether the resourceName is valid or not.
 
 **Signature:**

package/docs/api/foundation-comms.datasourcemetadata.customrequestfields.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; [customRequestFields](./foundation-comms.datasourcemetadata.customrequestfields.md)
+
+## DatasourceMetadata.customRequestFields property
+
+**Signature:**
+
+```typescript
+readonly customRequestFields: MetadataDetail[];
+```

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

@@ -17,6 +17,7 @@ export interface DatasourceMetadata
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [availableIndexes](./foundation-comms.datasourcemetadata.availableindexes.md) | <code>readonly</code> | [IndexDetail](./foundation-comms.indexdetail.md)<!-- -->\[\] |  |
+|  [customRequestFields](./foundation-comms.datasourcemetadata.customrequestfields.md) | <code>readonly</code> | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] |  |
 |  [fetchMetadataRequired](./foundation-comms.datasourcemetadata.fetchmetadatarequired.md) |  | boolean |  |
 |  [fieldMetadata](./foundation-comms.datasourcemetadata.fieldmetadata.md) | <code>readonly</code> | [FieldMetadata](./foundation-comms.fieldmetadata.md)<!-- -->\[\] |  |
 |  [originalFieldDef](./foundation-comms.datasourcemetadata.originalfielddef.md) | <code>readonly</code> | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] |  |

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

@@ -11,3 +11,8 @@ The criteria used to filter data in the datasource.
 ```typescript
 criteria?: string;
 ```
+
+## Remarks
+
+Works with both DATASERVER and REQUEST\_SERVER resources.
+

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

@@ -11,3 +11,8 @@ Whether to disable polling when using request/reply
 ```typescript
 disablePolling?: boolean;
 ```
+
+## Remarks
+
+Only works with REQUEST\_SERVER resources.
+

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

@@ -11,3 +11,8 @@ The fields to include in the returned data.
 ```typescript
 fields?: string;
 ```
+
+## Remarks
+
+Only works with DATASERVER resources.
+

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

@@ -11,3 +11,8 @@ The maximum number of rows to return from the datasource.
 ```typescript
 maxRows?: number;
 ```
+
+## Remarks
+
+Works with both DATASERVER and REQUEST\_SERVER resources.
+

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

@@ -11,3 +11,8 @@ The maximum number of rows to track as part of a client "view"
 ```typescript
 maxView?: number;
 ```
+
+## Remarks
+
+Only works with DATASERVER resources.
+

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

@@ -26,6 +26,8 @@ export interface DatasourceOptions
 |  [orderBy?](./foundation-comms.datasourceoptions.orderby.md) |  | string | _(Optional)_ The field to use for sorting the data. |
 |  [pollingInterval?](./foundation-comms.datasourceoptions.pollinginterval.md) |  | number | _(Optional)_ The polling interval to use when using request/reply. |
 |  [request?](./foundation-comms.datasourceoptions.request.md) |  | any | _(Optional)_ The request to send to the server. |
+|  [requestAutoSetup?](./foundation-comms.datasourceoptions.requestautosetup.md) |  | boolean | _(Optional)_ Whether the Datasource service will setup RQUEST object based on metadata. |
 |  [resourceName?](./foundation-comms.datasourceoptions.resourcename.md) |  | string | _(Optional)_ The name of the resource to use for the datasource. |
 |  [reverse?](./foundation-comms.datasourceoptions.reverse.md) |  | boolean | _(Optional)_ Whether to return the data in reverse order or not. |
+|  [viewNumber?](./foundation-comms.datasourceoptions.viewnumber.md) |  | number | _(Optional)_ The current page/"view" number being displayed. |
 

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

@@ -11,3 +11,8 @@ Defines the behaviour of the client view when new rows are received in real time
 ```typescript
 movingView?: boolean;
 ```
+
+## Remarks
+
+Only works with DATASERVER resources.
+

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.datasourceoptions.request.md

@@ -11,3 +11,8 @@ The request to send to the server.
 ```typescript
 request?: any;
 ```
+
+## Remarks
+
+Only works with REQUEST\_SERVER resources.
+

package/docs/api/foundation-comms.datasourceoptions.requestautosetup.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; [requestAutoSetup](./foundation-comms.datasourceoptions.requestautosetup.md)
+
+## DatasourceOptions.requestAutoSetup property
+
+Whether the Datasource service will setup RQUEST object based on metadata.
+
+**Signature:**
+
+```typescript
+requestAutoSetup?: boolean;
+```
+
+## Remarks
+
+Default is `true`<!-- -->. Only works with REQUEST\_SERVER resources.
+

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

@@ -11,3 +11,8 @@ Whether to return the data in reverse order or not.
 ```typescript
 reverse?: boolean;
 ```
+
+## Remarks
+
+Only works with DATASERVER resources.
+