@genesislcap/grid-pro 14.107.0 → 14.107.1-alpha-afbc4d7.0

package/docs/api/grid-pro.md

@@ -19,10 +19,12 @@
 |  [GridProClientSideDatasource](./grid-pro.gridproclientsidedatasource.md) | The Genesis Datasource element, for client-side \| CSRM-compatible data fetching and used exclusively by the GridPro element. |
 |  [GridProColumn](./grid-pro.gridprocolumn.md) | The Grid Pro Column element. |
 |  [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) | The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element. |
+|  [GridProServerSideDatasource](./grid-pro.gridproserversidedatasource.md) | **_(ALPHA)_** A Genesis Datasource element, for server-side \| SSRM-compatible data fetching and used exclusively by the GridPro element. |
 |  [MultiselectEditor](./grid-pro.multiselecteditor.md) | The AG Multiselect Editor element. |
 |  [NumberEditor](./grid-pro.numbereditor.md) | The AG Number Editor element. |
 |  [SelectEditor](./grid-pro.selecteditor.md) | The AG Select Editor element. |
 |  [SelectRenderer](./grid-pro.selectrenderer.md) | The AG Select Renderer element. |
+|  [StreamDatasource](./grid-pro.streamdatasource.md) | **_(ALPHA)_** The IServerSideDatasource implementation, used for SSRM (Server-Side Row Model) in the grid. |
 
 ## Enumerations
 
@@ -38,6 +40,10 @@
 |  --- | --- |
 |  [dateTimeValueFormatter({ value })](./grid-pro.datetimevalueformatter.md) | Returns a formatted date time value from the Grid Pro cell value. |
 |  [dateValueFormatter({ value })](./grid-pro.datevalueformatter.md) | Returns a formatted date value from the Grid Pro cell value. |
+|  [formatDateExtra(epoch)](./grid-pro.formatdateextra.md) | **_(ALPHA)_** Returns a formatted date value from an epoch number. |
+|  [getColumnType(metadataType)](./grid-pro.getcolumntype.md) | **_(ALPHA)_** Return a column type base on each field's metadata from the selected resource. |
+|  [getFilterByFieldType(type)](./grid-pro.getfilterbyfieldtype.md) | **_(ALPHA)_** Returns a filter type based on the Grid Pro field/column type. |
+|  [getFilterParamsByFieldType(type)](./grid-pro.getfilterparamsbyfieldtype.md) | **_(ALPHA)_** Returns the filter params based on the Grid Pro field/column type. |
 |  [gridProColumns(itemsBinding, includeRenderers)](./grid-pro.gridprocolumns.md) | A directive that renders a set of grid-pro-column elements from a given input binding |
 |  [mergeAndDedupColDefWithColumnState(colDefs, columnStates)](./grid-pro.mergeanddedupcoldefwithcolumnstate.md) | Merges two arrays, one of <code>ColDef</code> and one of <code>ColumnState</code>, and deduplicates them. |
 
@@ -116,4 +122,5 @@
 |  [ActionRendererParams](./grid-pro.actionrendererparams.md) | Parameters for the [GridPro](./grid-pro.gridpro.md) action renderer. |
 |  [AgThemeFontFaceMap](./grid-pro.agthemefontfacemap.md) | Type for mapping of a [AgGridTheme](./grid-pro.aggridtheme.md) to a font face. |
 |  [GridComponents](./grid-pro.gridcomponents.md) | Grid Pro Components type, used to define the custom components that will be registered in the grid |
+|  [StreamDatasourceOptions](./grid-pro.streamdatasourceoptions.md) | **_(ALPHA)_** Type definition for configuration options used for streams. |
 

package/docs/api/grid-pro.streamdatasource._constructor_.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md) &gt; [(constructor)](./grid-pro.streamdatasource._constructor_.md)
+
+## StreamDatasource.(constructor)
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Constructs a new instance of the `StreamDatasource` class
+
+**Signature:**
+
+```typescript
+constructor(options: StreamDatasourceOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | [StreamDatasourceOptions](./grid-pro.streamdatasourceoptions.md) |  |
+

package/docs/api/grid-pro.streamdatasource.auth.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md) &gt; [auth](./grid-pro.streamdatasource.auth.md)
+
+## StreamDatasource.auth property
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+auth: Auth;
+```

package/docs/api/grid-pro.streamdatasource.connect.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md) &gt; [connect](./grid-pro.streamdatasource.connect.md)
+
+## StreamDatasource.connect property
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+connect: Connect;
+```

package/docs/api/grid-pro.streamdatasource.dataserverstream.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md) &gt; [dataserverStream](./grid-pro.streamdatasource.dataserverstream.md)
+
+## StreamDatasource.dataserverStream property
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+dataserverStream: SocketObservable<FilteredDataServerResult>;
+```

package/docs/api/grid-pro.streamdatasource.md

@@ -0,0 +1,34 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md)
+
+## StreamDatasource class
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+The IServerSideDatasource implementation, used for SSRM (Server-Side Row Model) in the grid.
+
+**Signature:**
+
+```typescript
+export declare class StreamDatasource implements IServerSideDatasource 
+```
+**Implements:** IServerSideDatasource
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(options)](./grid-pro.streamdatasource._constructor_.md) |  | **_(ALPHA)_** Constructs a new instance of the <code>StreamDatasource</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [auth](./grid-pro.streamdatasource.auth.md) |  | Auth | **_(ALPHA)_** |
+|  [connect](./grid-pro.streamdatasource.connect.md) |  | Connect | **_(ALPHA)_** |
+|  [dataserverStream](./grid-pro.streamdatasource.dataserverstream.md) |  | SocketObservable&lt;FilteredDataServerResult&gt; | **_(ALPHA)_** |
+|  [resourceParams](./grid-pro.streamdatasource.resourceparams.md) |  | any | **_(ALPHA)_** |
+|  [streamSourceRef](./grid-pro.streamdatasource.streamsourceref.md) |  | string | **_(ALPHA)_** |
+

package/docs/api/grid-pro.streamdatasource.resourceparams.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md) &gt; [resourceParams](./grid-pro.streamdatasource.resourceparams.md)
+
+## StreamDatasource.resourceParams property
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+resourceParams: any;
+```

package/docs/api/grid-pro.streamdatasource.streamsourceref.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasource](./grid-pro.streamdatasource.md) &gt; [streamSourceRef](./grid-pro.streamdatasource.streamsourceref.md)
+
+## StreamDatasource.streamSourceRef property
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+**Signature:**
+
+```typescript
+streamSourceRef: string;
+```

package/docs/api/grid-pro.streamdatasourceoptions.md

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StreamDatasourceOptions](./grid-pro.streamdatasourceoptions.md)
+
+## StreamDatasourceOptions type
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+Type definition for configuration options used for streams.
+
+**Signature:**
+
+```typescript
+export type StreamDatasourceOptions = {
+    stream: SocketObservable<FilteredDataServerResult>;
+    resourceName: string;
+    resourceParams?: any;
+    resourceIndexes?: Map<string, [string]>;
+    resourceColDefs?: MetadataDetail[];
+    maxRows?: number;
+    maxView?: number;
+    rowId?: string;
+    pagination?: boolean;
+};
+```
+
+## Remarks
+
+Used by [StreamDatasource](./grid-pro.streamdatasource.md) constructor to configure options for the stream.
+

package/docs/api-report.md

@@ -4,6 +4,8 @@
 
 ```ts
 
+/// <reference types="node" />
+
 import { ActionMenuItem } from '@genesislcap/foundation-ui';
 import { Auth } from '@genesislcap/foundation-comms';
 import { Binding } from '@microsoft/fast-element';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/grid-pro",
   "description": "Genesis Foundation AG Grid",
-  "version": "14.107.0",
+  "version": "14.107.1-alpha-afbc4d7.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -30,15 +30,15 @@
     "test:debug": "genx test --debug"
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.107.0",
-    "@genesislcap/genx": "14.107.0",
+    "@genesislcap/foundation-testing": "14.107.1-alpha-afbc4d7.0",
+    "@genesislcap/genx": "14.107.1-alpha-afbc4d7.0",
     "rimraf": "^3.0.2"
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "14.107.0",
-    "@genesislcap/foundation-logger": "14.107.0",
-    "@genesislcap/foundation-ui": "14.107.0",
-    "@genesislcap/foundation-utils": "14.107.0",
+    "@genesislcap/foundation-comms": "14.107.1-alpha-afbc4d7.0",
+    "@genesislcap/foundation-logger": "14.107.1-alpha-afbc4d7.0",
+    "@genesislcap/foundation-ui": "14.107.1-alpha-afbc4d7.0",
+    "@genesislcap/foundation-utils": "14.107.1-alpha-afbc4d7.0",
     "@microsoft/fast-colors": "^5.1.4",
     "@microsoft/fast-components": "^2.21.3",
     "@microsoft/fast-element": "^1.7.0",
@@ -46,7 +46,7 @@
     "@microsoft/fast-web-utilities": "^5.0.2",
     "dayjs": "^1.11.7",
     "rxjs": "^7.5.4",
-    "tslib": "^2.3.1"
+    "tslib": "^2.6.2"
   },
   "peerDependencies": {
     "@ag-grid-community/client-side-row-model": "29.2.0",
@@ -62,5 +62,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "688b8fadf0d82d432478cbac8762c93d649c1580"
+  "gitHead": "bb64624e9bb6cea2cad088305e8c82d088f20da4"
 }