@genesislcap/grid-pro 14.201.0 → 14.202.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/README.md +117 -111
  2. package/dist/custom-elements.json +2742 -840
  3. package/dist/dts/datasource/base.datasource.d.ts +22 -6
  4. package/dist/dts/datasource/base.datasource.d.ts.map +1 -1
  5. package/dist/dts/datasource/base.types.d.ts +22 -0
  6. package/dist/dts/datasource/base.types.d.ts.map +1 -0
  7. package/dist/dts/datasource/server-side.datasource.d.ts +27 -83
  8. package/dist/dts/datasource/server-side.datasource.d.ts.map +1 -1
  9. package/dist/dts/datasource/server-side.grid-definitions.d.ts.map +1 -1
  10. package/dist/dts/datasource/server-side.resource-base.d.ts +55 -0
  11. package/dist/dts/datasource/server-side.resource-base.d.ts.map +1 -0
  12. package/dist/dts/datasource/server-side.resource-dataserver.d.ts +20 -0
  13. package/dist/dts/datasource/server-side.resource-dataserver.d.ts.map +1 -0
  14. package/dist/dts/datasource/server-side.resource-reqrep.d.ts +17 -0
  15. package/dist/dts/datasource/server-side.resource-reqrep.d.ts.map +1 -0
  16. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts +13 -13
  17. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
  18. package/dist/dts/grid-pro.d.ts +16 -2
  19. package/dist/dts/grid-pro.d.ts.map +1 -1
  20. package/dist/esm/datasource/base.datasource.js +79 -9
  21. package/dist/esm/datasource/base.types.js +1 -0
  22. package/dist/esm/datasource/client-side.grid-definitions.js +1 -1
  23. package/dist/esm/datasource/server-side.datasource.js +220 -396
  24. package/dist/esm/datasource/server-side.grid-definitions.js +42 -7
  25. package/dist/esm/datasource/server-side.resource-base.js +285 -0
  26. package/dist/esm/datasource/server-side.resource-dataserver.js +132 -0
  27. package/dist/esm/datasource/server-side.resource-reqrep.js +131 -0
  28. package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +55 -61
  29. package/dist/esm/grid-pro.js +7 -4
  30. package/dist/grid-pro.api.json +21 -142
  31. package/dist/grid-pro.d.ts +77 -112
  32. package/docs/api/grid-pro.gridpro.addeventlistener.md +2 -2
  33. package/docs/api/grid-pro.gridpro.md +1 -1
  34. package/docs/api/grid-pro.gridprogenesisdatasource.deinit.md +5 -0
  35. package/docs/api/{grid-pro.gridprogenesisdatasource.auth.md → grid-pro.gridprogenesisdatasource.destroy.md} +9 -3
  36. package/docs/api/grid-pro.gridprogenesisdatasource.handleerrors.md +2 -2
  37. package/docs/api/grid-pro.gridprogenesisdatasource.md +2 -6
  38. package/docs/api/grid-pro.gridprogenesisdatasource.reset.md +1 -1
  39. package/docs/api-report.md +19 -68
  40. package/package.json +13 -13
  41. package/docs/api/grid-pro.gridprogenesisdatasource.datasource.md +0 -11
  42. package/docs/api/grid-pro.gridprogenesisdatasource.disablepolling.md +0 -11
  43. package/docs/api/grid-pro.gridprogenesisdatasource.pollinginterval.md +0 -11
  44. package/docs/api/grid-pro.gridprogenesisdatasource.request.md +0 -11
@@ -1,5 +1,5 @@
1
1
  import { ActionMenuItem } from '@genesislcap/foundation-ui';
2
- import { Auth } from '@genesislcap/foundation-comms';
2
+ import { BehaviorSubject } from 'rxjs';
3
3
  import { Binding } from '@microsoft/fast-element';
4
4
  import { CaptureType } from '@microsoft/fast-element';
5
5
  import { ColDef } from '@ag-grid-community/core';
@@ -18,7 +18,6 @@ import { DatasourceStatusChangedEvent } from '@genesislcap/foundation-comms';
18
18
  import { DOMContainer } from '@genesislcap/foundation-utils';
19
19
  import { ElementStyles } from '@microsoft/fast-element';
20
20
  import { FieldMetadata } from '@genesislcap/foundation-comms';
21
- import { FilteredDataServerResult } from '@genesislcap/foundation-comms';
22
21
  import { FoundationElement } from '@microsoft/fast-foundation';
23
22
  import { FoundationElementRegistry } from '@microsoft/fast-foundation';
24
23
  import { FoundationLayoutContainer } from '@genesislcap/foundation-utils';
@@ -32,23 +31,19 @@ import { ICellRendererComp } from '@ag-grid-community/core';
32
31
  import { ICellRendererFunc } from '@ag-grid-community/core';
33
32
  import { ICellRendererParams } from '@ag-grid-community/core';
34
33
  import { InterfaceSymbol } from '@microsoft/fast-foundation';
35
- import type { IServerSideDatasource } from '@ag-grid-community/core';
36
- import type { IServerSideGetRowsParams } from '@ag-grid-community/core';
37
- import type { IServerSideRowModel } from '@ag-grid-community/core';
34
+ import { IServerSideRowModel } from '@ag-grid-community/core';
38
35
  import { ITooltipComp } from '@ag-grid-community/core';
39
36
  import { ITooltipParams } from '@ag-grid-community/core';
40
37
  import { KVStorage } from '@genesislcap/foundation-comms';
41
38
  import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
42
39
  import { Logger } from '@genesislcap/foundation-logger';
43
- import { MetadataDetail } from '@genesislcap/foundation-comms';
44
40
  import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
45
- import type { RowDataTransaction } from '@ag-grid-community/core';
46
- import type { RowNodeTransaction } from '@ag-grid-community/core';
41
+ import { PaginationChangedEvent } from '@ag-grid-community/core';
42
+ import { RowDataTransaction } from '@ag-grid-community/core';
43
+ import { RowNodeTransaction } from '@ag-grid-community/core';
47
44
  import type { ServerSideTransaction } from '@ag-grid-community/core';
48
- import type { ServerSideTransactionResult } from '@ag-grid-community/core';
45
+ import { ServerSideTransactionResult } from '@ag-grid-community/core';
49
46
  import { Session } from '@genesislcap/foundation-comms';
50
- import { SocketObservable } from '@genesislcap/foundation-comms';
51
- import { SocketSubscription } from '@genesislcap/foundation-comms';
52
47
  import { Swatch } from '@microsoft/fast-components';
53
48
  import { SwatchRGB } from '@microsoft/fast-components';
54
49
  import { TextField } from '@genesislcap/foundation-ui';
@@ -978,6 +973,7 @@ declare interface FuiCellRendererParams extends ICellRendererParams {
978
973
 
979
974
  declare class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_base {
980
975
  connect: Connect;
976
+ datasource: Datasource;
981
977
  deferredGridOptions: GridOptions;
982
978
  deferredColumnStates: ColumnState[];
983
979
  /**
@@ -993,6 +989,16 @@ declare class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_
993
989
  orderBy: string;
994
990
  resourceName: string;
995
991
  reverse: boolean;
992
+ viewNumber: number;
993
+ pollingInterval: number;
994
+ disablePolling: boolean;
995
+ request: any;
996
+ /**
997
+ * Attribute to set whether the REQUEST object should be automatically set up.
998
+ * @remarks Defaults to `true`. Only applies to REQUEST_SERVER (REQ-REP) resources.
999
+ * @privateRemarks To avoid breaking changes for now, once V15 is out this will be removed and the default behavior will be the same as `false` here.
1000
+ */
1001
+ requestAutoSetup: boolean;
996
1002
  /**
997
1003
  * Attribute to set an unique identifier for the row.
998
1004
  *
@@ -1007,7 +1013,13 @@ declare class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_
1007
1013
  */
1008
1014
  protected get hasDefaultRowId(): boolean;
1009
1015
  protected get defaultRowIdByResourceType(): string;
1010
- protected isRequestServer: boolean;
1016
+ protected criteriaFromFilters: Map<string, string>;
1017
+ protected update: BehaviorSubject<Map<string, string>>;
1018
+ protected datasourceOptions(): DatasourceOptions;
1019
+ private buildCriteria;
1020
+ setFilter(fieldName: string, newFilter: string): void;
1021
+ removeFilter(fieldName: string): void;
1022
+ get isRequestServer(): boolean;
1011
1023
  datasourceStatusChanged(prev: DatasourceStatus, next: DatasourceStatus): void;
1012
1024
  protected get agGrid(): GridPro | null;
1013
1025
  }
@@ -1637,7 +1649,7 @@ export declare class GridPro extends GridPro_base {
1637
1649
  */
1638
1650
  gridOptionsConfig: GridOptionsConfig;
1639
1651
  constructor();
1640
- addEventListener(type: any, listener: any, options?: boolean | AddEventListenerOptions): void;
1652
+ addEventListener(eventType: string, listener: any, options?: boolean | AddEventListenerOptions): void;
1641
1653
  private addGridEventListener;
1642
1654
  private handleError;
1643
1655
  hideDatasourceError(): void;
@@ -1911,7 +1923,12 @@ declare const GridPro_base: (new (...args: any[]) => {
1911
1923
  ariaValueNow: string;
1912
1924
  ariaValueText: string;
1913
1925
  role: string;
1914
- animate(keyframes: PropertyIndexedKeyframes | Keyframe[], options?: number | KeyframeAnimationOptions): Animation;
1926
+ animate(keyframes: PropertyIndexedKeyframes | Keyframe[], options?: number | KeyframeAnimationOptions): Animation; /**
1927
+ * Gets the saved grid ColumnState[] from storage
1928
+ * @remarks This is used to restore the grid state when the grid is rehydrated
1929
+ * @privateRemarks Not using `columnApi.get|setColumnState()` for these flows as it doesn't work setting new columnDefs vs different ordering.
1930
+ * @public
1931
+ */
1915
1932
  getAnimations(options?: GetAnimationsOptions): Animation[];
1916
1933
  after(...nodes: (string | Node)[]): void;
1917
1934
  before(...nodes: (string | Node)[]): void;
@@ -2004,6 +2021,15 @@ declare const GridPro_base: (new (...args: any[]) => {
2004
2021
  onprogress: (this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any;
2005
2022
  onratechange: (this: GlobalEventHandlers, ev: Event) => any;
2006
2023
  onreset: (this: GlobalEventHandlers, ev: Event) => any;
2024
+ /**
2025
+ * Will merge templated column definitions with `columnDefs` plus localStorage's column state or `deferredColumnStates`.
2026
+ * @public
2027
+ * @remarks This will favor the column state from the browser's local storage over the `deferredColumnStates` property on the `grid-pro-genesis-datasource` element.
2028
+ * @param columnDefs - The column definitions to apply to the grid.
2029
+ * @param deferredColumnDefsOrState - If true, will merge the column definitions with the saved column state or the `deferredColumnStates` property
2030
+ * on the `grid-pro-genesis-datasource` element. Defaults to false but `grid-pro-genesis-datasource` will set this to true.
2031
+ * @returns The merged column definitions.
2032
+ */
2007
2033
  onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
2008
2034
  onscroll: (this: GlobalEventHandlers, ev: Event) => any;
2009
2035
  onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
@@ -2514,14 +2540,9 @@ export declare type GridProEventsListeners = {
2514
2540
  * @public
2515
2541
  */
2516
2542
  export declare class GridProGenesisDatasource extends GridProGenesisDatasource_base {
2517
- auth: Auth;
2518
- datasource: Datasource;
2519
2543
  applyFuncName: string;
2520
2544
  applyAsyncFuncName: string;
2521
2545
  criteriaChanged(oldCriteria: string, newCriteria: string): void;
2522
- pollingInterval: number;
2523
- disablePolling: boolean;
2524
- request: any;
2525
2546
  requestChanged(oldRequest: string, newRequest: string): void;
2526
2547
  resourceNameChanged(oldValue: string, newValue: string): void;
2527
2548
  restartOnReconnection: boolean;
@@ -2530,8 +2551,6 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
2530
2551
  private updateSub;
2531
2552
  private connectionSub;
2532
2553
  private requiresFullRowDataAndColDefs;
2533
- private criteriaFromFilters;
2534
- private update;
2535
2554
  connectedCallback(): void;
2536
2555
  disconnectedCallback(): void;
2537
2556
  deepClone(): Node;
@@ -2544,15 +2563,21 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
2544
2563
  * @remarks This method is called automatically when the element is connected to the DOM.
2545
2564
  */
2546
2565
  init(columnDefinitions?: ColDef[], columnStates?: ColumnState[]): Promise<void>;
2566
+ /**
2567
+ * Destroys the datasource, resetting it to its initial state.
2568
+ * @public
2569
+ */
2570
+ destroy(): void;
2547
2571
  /**
2548
2572
  * Deinitialises the datasource, resetting it to its initial state.
2573
+ * @deprecated Use `destroy` instead
2549
2574
  * @public
2550
2575
  */
2551
2576
  deinit(): void;
2552
2577
  /**
2553
2578
  * Resets the datasource to its initial state.
2554
2579
  * @public
2555
- * @deprecated Use `deinit` instead
2580
+ * @deprecated Use `destroy` instead
2556
2581
  */
2557
2582
  reset(): void;
2558
2583
  /**
@@ -2593,13 +2618,11 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
2593
2618
  */
2594
2619
  private loadResourceData;
2595
2620
  private handleSnapshot;
2596
- handleErrors(message: string): void;
2597
- private datasourceOptions;
2621
+ handleErrors(errors: string | any[]): void;
2598
2622
  private handleStreamResult;
2599
2623
  private applyRequestServerData;
2600
2624
  private applyDataserverData;
2601
2625
  private getAgColumnDefs;
2602
- private buildCriteria;
2603
2626
  setFilter(fieldName: string, newFilter: string): void;
2604
2627
  removeFilter(fieldName: string): void;
2605
2628
  applyTransaction(agTransaction: RowDataTransaction): RowNodeTransaction | null | undefined;
@@ -2652,6 +2675,10 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
2652
2675
  readonly classList: DOMTokenList;
2653
2676
  className: string;
2654
2677
  readonly clientHeight: number;
2678
+ /**
2679
+ * Destroys the datasource, resetting it to its initial state.
2680
+ * @public
2681
+ */
2655
2682
  readonly clientLeft: number;
2656
2683
  readonly clientTop: number;
2657
2684
  readonly clientWidth: number;
@@ -2983,30 +3010,42 @@ export declare enum GridProRendererTypes {
2983
3010
  export declare class GridProServerSideDatasource extends GridProServerSideDatasource_base {
2984
3011
  applyFuncName: string;
2985
3012
  applyAsyncFuncName: string;
2986
- criteriaChanged(oldCriteria: string, newCriteria: string): void;
3013
+ pagination: boolean;
2987
3014
  /**
2988
- * Resets the grid data while keeping columnDefs and sends a DATA_LOGOFF message if it's a stream.
2989
- * @remarks This is used when the grid is already initialized and we want to reload the data due to a criteria/filter change.
2990
- * @internal
3015
+ * The starting VIEW_NUMBER of the data to be fetched.
3016
+ * @remarks The VIEW_NUMBER isincremented by the grid as the user scrolls or changes pages.
2991
3017
  */
2992
- private reloadResourceData;
2993
- resourceNameChanged(oldValue: string, newValue: string): void;
2994
- pagination: boolean;
3018
+ zeroBasedViewNumber: boolean;
3019
+ /**
3020
+ * Enable live updates for the grid.
3021
+ * @remarks Only works with DATASERVER resources (StreamDatasource) right now.
3022
+ */
3023
+ liveUpdates: boolean;
3024
+ request: any;
2995
3025
  private indexes;
2996
3026
  private ssrmDatasource;
2997
- private originalFieldDef;
3027
+ private liveUpdatesStream;
3028
+ resourceNameChanged(oldValue: string, newValue: string): void;
3029
+ criteriaChanged(oldCriteria: string, newCriteria: string): void;
2998
3030
  connectedCallback(): void;
2999
3031
  disconnectedCallback(): void;
3000
3032
  deepClone(): Node;
3001
- deinit(): void;
3002
- init(): void;
3003
- restart(): void;
3033
+ /**
3034
+ * Resets the grid data while keeping columnDefs and sends a DATA_LOGOFF message if it's a stream.
3035
+ * @remarks This is used when the grid is already initialized and we want to reload the data due to a criteria/filter change.
3036
+ * @internal
3037
+ */
3038
+ private reloadResourceData;
3039
+ init(): Promise<void>;
3040
+ onPaginationChanged(event: PaginationChangedEvent): void;
3041
+ destroy(): Promise<void>;
3042
+ restart(): Promise<void>;
3004
3043
  private clearRowData;
3005
3044
  private getResourceIndexes;
3006
3045
  get params(): any;
3007
3046
  get rowModel(): IServerSideRowModel;
3047
+ private createReqRepRequest;
3008
3048
  private createDataserverStream;
3009
- private handleStreamDeletesTemp;
3010
3049
  private getAgColumnDefs;
3011
3050
  applyTransaction(agTransaction: RowDataTransaction): ServerSideTransactionResult;
3012
3051
  applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: ServerSideTransactionResult) => void): void;
@@ -3221,11 +3260,7 @@ declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
3221
3260
  readonly children: HTMLCollection;
3222
3261
  readonly firstElementChild: Element;
3223
3262
  readonly lastElementChild: Element;
3224
- append(...nodes: (string | Node)[]): void; /**
3225
- * Resets the grid data while keeping columnDefs and sends a DATA_LOGOFF message if it's a stream.
3226
- * @remarks This is used when the grid is already initialized and we want to reload the data due to a criteria/filter change.
3227
- * @internal
3228
- */
3263
+ append(...nodes: (string | Node)[]): void;
3229
3264
  prepend(...nodes: (string | Node)[]): void;
3230
3265
  querySelector<K_6 extends keyof HTMLElementTagNameMap>(selectors: K_6): HTMLElementTagNameMap[K_6];
3231
3266
  querySelector<K_7 extends keyof SVGElementTagNameMap>(selectors: K_7): SVGElementTagNameMap[K_7];
@@ -3584,76 +3619,6 @@ export declare interface StatePersistence {
3584
3619
  */
3585
3620
  export declare const StatePersistence: InterfaceSymbol<StatePersistence>;
3586
3621
 
3587
- declare class StreamBaseDatasource {
3588
- protected rowId: string;
3589
- rowData: Map<string, any>;
3590
- }
3591
-
3592
- /**
3593
- * The IServerSideDatasource implementation, used for SSRM (Server-Side Row Model) in the grid.
3594
- * @alpha
3595
- */
3596
- export declare class StreamDatasource extends StreamBaseDatasource implements IServerSideDatasource {
3597
- auth: Auth;
3598
- connect: Connect;
3599
- dataserverStream: SocketObservable<FilteredDataServerResult>;
3600
- dataserverStreamSubscription: SocketSubscription;
3601
- createDataserverStreamFunc: (existingParams?: any) => Promise<SocketObservable<FilteredDataServerResult>>;
3602
- private resourceName;
3603
- resourceParams: any;
3604
- private resourceIndexes;
3605
- private resourceColDefs;
3606
- private maxRows;
3607
- private maxView;
3608
- private pagination;
3609
- streamSourceRef: string;
3610
- /**
3611
- * The number of rows in the grid. THIS DO NOT CONSIDER CRITERIA_MATCH scenarios.
3612
- * @internal
3613
- */
3614
- server_ROWS_COUNT: number;
3615
- /**
3616
- * The number of rows in the grid. THIS IS A LOCAL COUNT CONSIDERING CONSIDER CRITERIA_MATCH scenarios.
3617
- * @internal
3618
- */
3619
- client_ROWS_COUNT: number;
3620
- private moreRows;
3621
- private calculatedRowsCount;
3622
- private lastSequenceId;
3623
- private currentFilterModel;
3624
- private originalCriteriaMatch;
3625
- private currentSortModel;
3626
- constructor(options: StreamDatasourceOptions);
3627
- getRows(params: IServerSideGetRowsParams): Promise<void>;
3628
- private applyServerSideData;
3629
- private sortMapByNumericKey;
3630
- deinit(): Promise<void>;
3631
- private refreshDatasource;
3632
- private getOrderByAndToBeSortedColIds;
3633
- private handleCurrentStreamLoad;
3634
- private buildCriteriaMatchFromFilters;
3635
- private criteriaFromFilters;
3636
- private getFiltersByType;
3637
- }
3638
-
3639
- /**
3640
- * Type definition for configuration options used for streams.
3641
- * @remarks
3642
- * Used by {@link @genesislcap/grid-pro#StreamDatasource} constructor to configure options for the stream.
3643
- * @alpha
3644
- */
3645
- export declare type StreamDatasourceOptions = {
3646
- createDataserverStreamFunc: (existingParams?: any) => Promise<SocketObservable<FilteredDataServerResult>>;
3647
- resourceName: string;
3648
- resourceParams?: any;
3649
- resourceIndexes?: Map<string, [string]>;
3650
- resourceColDefs?: MetadataDetail[];
3651
- maxRows?: number;
3652
- maxView?: number;
3653
- rowId?: string;
3654
- pagination?: boolean;
3655
- };
3656
-
3657
3622
  /**
3658
3623
  * The AG String Editor element.
3659
3624
  * @public
@@ -7,14 +7,14 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- addEventListener(type: any, listener: any, options?: boolean | AddEventListenerOptions): void;
10
+ addEventListener(eventType: string, listener: any, options?: boolean | AddEventListenerOptions): void;
11
11
  ```
12
12
 
13
13
  ## Parameters
14
14
 
15
15
  | Parameter | Type | Description |
16
16
  | --- | --- | --- |
17
- | type | any | |
17
+ | eventType | string | |
18
18
  | listener | any | |
19
19
  | options | boolean \| AddEventListenerOptions | _(Optional)_ |
20
20
 
@@ -69,7 +69,7 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
69
69
 
70
70
  | Method | Modifiers | Description |
71
71
  | --- | --- | --- |
72
- | [addEventListener(type, listener, options)](./grid-pro.gridpro.addeventlistener.md) | | |
72
+ | [addEventListener(eventType, listener, options)](./grid-pro.gridpro.addeventlistener.md) | | |
73
73
  | [agAttributeChangedCallback(attName, oldValue, newValue)](./grid-pro.gridpro.agattributechangedcallback.md) | | |
74
74
  | [applyTemplateDefinitions(columnDefs, deferredColumnDefsOrState)](./grid-pro.gridpro.applytemplatedefinitions.md) | | Will merge templated column definitions with <code>columnDefs</code> plus localStorage's column state or <code>deferredColumnStates</code>. |
75
75
  | [combineAllGridComponents(gridOptionsComponents)](./grid-pro.gridpro.combineallgridcomponents.md) | | |
@@ -4,6 +4,11 @@
4
4
 
5
5
  ## GridProGenesisDatasource.deinit() method
6
6
 
7
+ > Warning: This API is now obsolete.
8
+ >
9
+ > Use `destroy` instead
10
+ >
11
+
7
12
  Deinitialises the datasource, resetting it to its initial state.
8
13
 
9
14
  **Signature:**
@@ -1,11 +1,17 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [auth](./grid-pro.gridprogenesisdatasource.auth.md)
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [destroy](./grid-pro.gridprogenesisdatasource.destroy.md)
4
4
 
5
- ## GridProGenesisDatasource.auth property
5
+ ## GridProGenesisDatasource.destroy() method
6
+
7
+ Destroys the datasource, resetting it to its initial state.
6
8
 
7
9
  **Signature:**
8
10
 
9
11
  ```typescript
10
- auth: Auth;
12
+ destroy(): void;
11
13
  ```
14
+ **Returns:**
15
+
16
+ void
17
+
@@ -7,14 +7,14 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- handleErrors(message: string): void;
10
+ handleErrors(errors: string | any[]): void;
11
11
  ```
12
12
 
13
13
  ## Parameters
14
14
 
15
15
  | Parameter | Type | Description |
16
16
  | --- | --- | --- |
17
- | message | string | |
17
+ | errors | string \| any\[\] | |
18
18
 
19
19
  **Returns:**
20
20
 
@@ -23,12 +23,7 @@ Only supports Client-Side Row Model.
23
23
  | --- | --- | --- | --- |
24
24
  | [applyAsyncFuncName](./grid-pro.gridprogenesisdatasource.applyasyncfuncname.md) | | string | |
25
25
  | [applyFuncName](./grid-pro.gridprogenesisdatasource.applyfuncname.md) | | string | |
26
- | [auth](./grid-pro.gridprogenesisdatasource.auth.md) | | Auth | |
27
- | [datasource](./grid-pro.gridprogenesisdatasource.datasource.md) | | Datasource | |
28
- | [disablePolling](./grid-pro.gridprogenesisdatasource.disablepolling.md) | | boolean | |
29
26
  | [keepColDefsOnClearRowData](./grid-pro.gridprogenesisdatasource.keepcoldefsonclearrowdata.md) | | boolean | |
30
- | [pollingInterval](./grid-pro.gridprogenesisdatasource.pollinginterval.md) | | number | |
31
- | [request](./grid-pro.gridprogenesisdatasource.request.md) | | any | |
32
27
  | [restartOnReconnection](./grid-pro.gridprogenesisdatasource.restartonreconnection.md) | | boolean | |
33
28
 
34
29
  ## Methods
@@ -41,8 +36,9 @@ Only supports Client-Side Row Model.
41
36
  | [criteriaChanged(oldCriteria, newCriteria)](./grid-pro.gridprogenesisdatasource.criteriachanged.md) | | |
42
37
  | [deepClone()](./grid-pro.gridprogenesisdatasource.deepclone.md) | | |
43
38
  | [deinit()](./grid-pro.gridprogenesisdatasource.deinit.md) | | Deinitialises the datasource, resetting it to its initial state. |
39
+ | [destroy()](./grid-pro.gridprogenesisdatasource.destroy.md) | | Destroys the datasource, resetting it to its initial state. |
44
40
  | [disconnectedCallback()](./grid-pro.gridprogenesisdatasource.disconnectedcallback.md) | | |
45
- | [handleErrors(message)](./grid-pro.gridprogenesisdatasource.handleerrors.md) | | |
41
+ | [handleErrors(errors)](./grid-pro.gridprogenesisdatasource.handleerrors.md) | | |
46
42
  | [init(columnDefinitions, columnStates)](./grid-pro.gridprogenesisdatasource.init.md) | | Initializes the datasource. |
47
43
  | [refreshRows()](./grid-pro.gridprogenesisdatasource.refreshrows.md) | | Force the grid to redispatch the current rows |
48
44
  | [removeFilter(fieldName)](./grid-pro.gridprogenesisdatasource.removefilter.md) | | |
@@ -6,7 +6,7 @@
6
6
 
7
7
  > Warning: This API is now obsolete.
8
8
  >
9
- > Use `deinit` instead
9
+ > Use `destroy` instead
10
10
  >
11
11
 
12
12
  Resets the datasource to its initial state.
@@ -5,7 +5,7 @@
5
5
  ```ts
6
6
 
7
7
  import { ActionMenuItem } from '@genesislcap/foundation-ui';
8
- import { Auth } from '@genesislcap/foundation-comms';
8
+ import { BehaviorSubject } from 'rxjs';
9
9
  import { Binding } from '@microsoft/fast-element';
10
10
  import { CaptureType } from '@microsoft/fast-element';
11
11
  import { ColDef } from '@ag-grid-community/core';
@@ -24,7 +24,6 @@ import { DatasourceStatusChangedEvent } from '@genesislcap/foundation-comms';
24
24
  import { DOMContainer } from '@genesislcap/foundation-utils';
25
25
  import { ElementStyles } from '@microsoft/fast-element';
26
26
  import { FieldMetadata } from '@genesislcap/foundation-comms';
27
- import { FilteredDataServerResult } from '@genesislcap/foundation-comms';
28
27
  import { FoundationElement } from '@microsoft/fast-foundation';
29
28
  import { FoundationElementRegistry } from '@microsoft/fast-foundation';
30
29
  import { FoundationLayoutContainer } from '@genesislcap/foundation-utils';
@@ -38,23 +37,19 @@ import { ICellRendererComp } from '@ag-grid-community/core';
38
37
  import { ICellRendererFunc } from '@ag-grid-community/core';
39
38
  import { ICellRendererParams } from '@ag-grid-community/core';
40
39
  import { InterfaceSymbol } from '@microsoft/fast-foundation';
41
- import type { IServerSideDatasource } from '@ag-grid-community/core';
42
- import type { IServerSideGetRowsParams } from '@ag-grid-community/core';
43
- import type { IServerSideRowModel } from '@ag-grid-community/core';
40
+ import { IServerSideRowModel } from '@ag-grid-community/core';
44
41
  import { ITooltipComp } from '@ag-grid-community/core';
45
42
  import { ITooltipParams } from '@ag-grid-community/core';
46
43
  import { KVStorage } from '@genesislcap/foundation-comms';
47
44
  import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
48
45
  import { Logger } from '@genesislcap/foundation-logger';
49
- import { MetadataDetail } from '@genesislcap/foundation-comms';
50
46
  import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
51
- import type { RowDataTransaction } from '@ag-grid-community/core';
52
- import type { RowNodeTransaction } from '@ag-grid-community/core';
47
+ import { PaginationChangedEvent } from '@ag-grid-community/core';
48
+ import { RowDataTransaction } from '@ag-grid-community/core';
49
+ import { RowNodeTransaction } from '@ag-grid-community/core';
53
50
  import type { ServerSideTransaction } from '@ag-grid-community/core';
54
- import type { ServerSideTransactionResult } from '@ag-grid-community/core';
51
+ import { ServerSideTransactionResult } from '@ag-grid-community/core';
55
52
  import { Session } from '@genesislcap/foundation-comms';
56
- import { SocketObservable } from '@genesislcap/foundation-comms';
57
- import { SocketSubscription } from '@genesislcap/foundation-comms';
58
53
  import { Swatch } from '@microsoft/fast-components';
59
54
  import { SwatchRGB } from '@microsoft/fast-components';
60
55
  import { TextField } from '@genesislcap/foundation-ui';
@@ -809,7 +804,7 @@ export const GridOptionsConfig: InterfaceSymbol<GridOptionsConfig>;
809
804
  export class GridPro extends GridPro_base {
810
805
  constructor();
811
806
  // (undocumented)
812
- addEventListener(type: any, listener: any, options?: boolean | AddEventListenerOptions): void;
807
+ addEventListener(eventType: string, listener: any, options?: boolean | AddEventListenerOptions): void;
813
808
  addIndex: number;
814
809
  // (undocumented)
815
810
  agAttributeChangedCallback(attName: any, oldValue: any, newValue: any): void;
@@ -1028,33 +1023,25 @@ export class GridProGenesisDatasource extends GridProGenesisDatasource_base {
1028
1023
  // (undocumented)
1029
1024
  applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: RowNodeTransaction) => void): void;
1030
1025
  // (undocumented)
1031
- auth: Auth;
1032
- // (undocumented)
1033
1026
  connectedCallback(): void;
1034
1027
  // (undocumented)
1035
1028
  criteriaChanged(oldCriteria: string, newCriteria: string): void;
1036
1029
  // (undocumented)
1037
- datasource: Datasource;
1038
- // (undocumented)
1039
1030
  deepClone(): Node;
1031
+ // @deprecated
1040
1032
  deinit(): void;
1041
- // (undocumented)
1042
- disablePolling: boolean;
1033
+ destroy(): void;
1043
1034
  // (undocumented)
1044
1035
  disconnectedCallback(): void;
1045
1036
  // (undocumented)
1046
- handleErrors(message: string): void;
1037
+ handleErrors(errors: string | any[]): void;
1047
1038
  init(columnDefinitions?: ColDef[], columnStates?: ColumnState[]): Promise<void>;
1048
1039
  // (undocumented)
1049
1040
  keepColDefsOnClearRowData: boolean;
1050
- // (undocumented)
1051
- pollingInterval: number;
1052
1041
  refreshRows(): void;
1053
1042
  // (undocumented)
1054
1043
  removeFilter(fieldName: string): void;
1055
1044
  // (undocumented)
1056
- request: any;
1057
- // (undocumented)
1058
1045
  requestChanged(oldRequest: string, newRequest: string): void;
1059
1046
  // @deprecated
1060
1047
  reset(): void;
@@ -1127,21 +1114,27 @@ export class GridProServerSideDatasource extends GridProServerSideDatasource_bas
1127
1114
  // (undocumented)
1128
1115
  deepClone(): Node;
1129
1116
  // (undocumented)
1130
- deinit(): void;
1117
+ destroy(): Promise<void>;
1131
1118
  // (undocumented)
1132
1119
  disconnectedCallback(): void;
1133
1120
  // (undocumented)
1134
- init(): void;
1121
+ init(): Promise<void>;
1122
+ liveUpdates: boolean;
1123
+ // (undocumented)
1124
+ onPaginationChanged(event: PaginationChangedEvent): void;
1135
1125
  // (undocumented)
1136
1126
  pagination: boolean;
1137
1127
  // (undocumented)
1138
1128
  get params(): any;
1139
1129
  // (undocumented)
1130
+ request: any;
1131
+ // (undocumented)
1140
1132
  resourceNameChanged(oldValue: string, newValue: string): void;
1141
1133
  // (undocumented)
1142
- restart(): void;
1134
+ restart(): Promise<void>;
1143
1135
  // (undocumented)
1144
1136
  get rowModel(): IServerSideRowModel;
1137
+ zeroBasedViewNumber: boolean;
1145
1138
  }
1146
1139
 
1147
1140
  // @public (undocumented)
@@ -1365,48 +1358,6 @@ export interface StatePersistence {
1365
1358
  // @internal
1366
1359
  export const StatePersistence: InterfaceSymbol<StatePersistence>;
1367
1360
 
1368
- // Warning: (ae-forgotten-export) The symbol "StreamBaseDatasource" needs to be exported by the entry point index.d.ts
1369
- //
1370
- // @alpha
1371
- export class StreamDatasource extends StreamBaseDatasource implements IServerSideDatasource {
1372
- constructor(options: StreamDatasourceOptions);
1373
- // (undocumented)
1374
- auth: Auth;
1375
- // @internal
1376
- client_ROWS_COUNT: number;
1377
- // (undocumented)
1378
- connect: Connect;
1379
- // (undocumented)
1380
- createDataserverStreamFunc: (existingParams?: any) => Promise<SocketObservable<FilteredDataServerResult>>;
1381
- // (undocumented)
1382
- dataserverStream: SocketObservable<FilteredDataServerResult>;
1383
- // (undocumented)
1384
- dataserverStreamSubscription: SocketSubscription;
1385
- // (undocumented)
1386
- deinit(): Promise<void>;
1387
- // (undocumented)
1388
- getRows(params: IServerSideGetRowsParams): Promise<void>;
1389
- // (undocumented)
1390
- resourceParams: any;
1391
- // @internal
1392
- server_ROWS_COUNT: number;
1393
- // (undocumented)
1394
- streamSourceRef: string;
1395
- }
1396
-
1397
- // @alpha
1398
- export type StreamDatasourceOptions = {
1399
- createDataserverStreamFunc: (existingParams?: any) => Promise<SocketObservable<FilteredDataServerResult>>;
1400
- resourceName: string;
1401
- resourceParams?: any;
1402
- resourceIndexes?: Map<string, [string]>;
1403
- resourceColDefs?: MetadataDetail[];
1404
- maxRows?: number;
1405
- maxView?: number;
1406
- rowId?: string;
1407
- pagination?: boolean;
1408
- };
1409
-
1410
1361
  // @public
1411
1362
  export class StringEditor extends FoundationElement implements ICellEditorComp {
1412
1363
  // (undocumented)