@genesislcap/grid-pro 14.292.0 → 14.293.1

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 (48) hide show
  1. package/dist/custom-elements.json +651 -95
  2. package/dist/dts/datasource/base.datasource.d.ts +42 -11
  3. package/dist/dts/datasource/base.datasource.d.ts.map +1 -1
  4. package/dist/dts/datasource/base.types.d.ts +22 -0
  5. package/dist/dts/datasource/base.types.d.ts.map +1 -1
  6. package/dist/dts/datasource/error-handler.dialog.d.ts +3 -0
  7. package/dist/dts/datasource/error-handler.dialog.d.ts.map +1 -0
  8. package/dist/dts/datasource/server-side.datasource.d.ts.map +1 -1
  9. package/dist/dts/datasource/server-side.resource-base.d.ts +1 -0
  10. package/dist/dts/datasource/server-side.resource-base.d.ts.map +1 -1
  11. package/dist/dts/datasource/server-side.resource-dataserver.d.ts.map +1 -1
  12. package/dist/dts/datasource/server-side.resource-reqrep.d.ts.map +1 -1
  13. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts +0 -3
  14. package/dist/dts/grid-pro-genesis-datasource/grid-pro-genesis-datasource.d.ts.map +1 -1
  15. package/dist/dts/grid-pro.d.ts +9 -3
  16. package/dist/dts/grid-pro.d.ts.map +1 -1
  17. package/dist/dts/grid-pro.styles.d.ts.map +1 -1
  18. package/dist/dts/grid-pro.template.d.ts +1 -1
  19. package/dist/dts/grid-pro.template.d.ts.map +1 -1
  20. package/dist/esm/datasource/base.datasource.js +162 -1
  21. package/dist/esm/datasource/base.types.js +8 -1
  22. package/dist/esm/datasource/error-handler.dialog.js +116 -0
  23. package/dist/esm/datasource/server-side.datasource.js +15 -4
  24. package/dist/esm/datasource/server-side.resource-base.js +1 -0
  25. package/dist/esm/datasource/server-side.resource-dataserver.js +7 -0
  26. package/dist/esm/datasource/server-side.resource-reqrep.js +7 -0
  27. package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js +14 -48
  28. package/dist/esm/grid-pro.js +20 -3
  29. package/dist/esm/grid-pro.styles.js +2 -22
  30. package/dist/esm/grid-pro.template.js +3 -33
  31. package/dist/grid-pro.api.json +307 -79
  32. package/dist/grid-pro.d.ts +60 -17
  33. package/docs/api/grid-pro.genesisgriddatasourceelement.clearerrors.md +17 -0
  34. package/docs/api/grid-pro.genesisgriddatasourceelement.handleerrors.md +25 -0
  35. package/docs/api/grid-pro.genesisgriddatasourceelement.md +3 -0
  36. package/docs/api/grid-pro.genesisgriddatasourceelement.restartonreconnection.md +18 -0
  37. package/docs/api/grid-pro.gridprobasedatasource.connectionsub.md +11 -0
  38. package/docs/api/grid-pro.gridprobasedatasource.isdisconnected.md +17 -0
  39. package/docs/api/grid-pro.gridprobasedatasource.md +5 -0
  40. package/docs/api/grid-pro.gridprobasedatasource.setdisconnected.md +24 -0
  41. package/docs/api/grid-pro.gridprobasedatasource.subscribetoconnection.md +15 -0
  42. package/docs/api/grid-pro.gridprobasedatasource.unsubscribefromconnection.md +15 -0
  43. package/docs/api/grid-pro.gridprogenesisdatasource.md +0 -2
  44. package/docs/api/grid-pro.gridprotemplate.md +1 -1
  45. package/docs/api-report.md +15 -4
  46. package/package.json +13 -13
  47. package/docs/api/grid-pro.gridprogenesisdatasource.handleerrors.md +0 -22
  48. package/docs/api/grid-pro.gridprogenesisdatasource.restartonreconnection.md +0 -11
@@ -37,6 +37,7 @@ export declare class GenesisGridDatasourceElement extends GenesisGridDatasourceE
37
37
  | [request](./grid-pro.genesisgriddatasourceelement.request.md) | | any | |
38
38
  | [requestAutoSetup](./grid-pro.genesisgriddatasourceelement.requestautosetup.md) | | boolean | Attribute to set whether the REQUEST object should be automatically set up. |
39
39
  | [resourceName](./grid-pro.genesisgriddatasourceelement.resourcename.md) | | string | |
40
+ | [restartOnReconnection](./grid-pro.genesisgriddatasourceelement.restartonreconnection.md) | | boolean | Attribute to set whether the datasource should restart when it reconnects. |
40
41
  | [reverse](./grid-pro.genesisgriddatasourceelement.reverse.md) | | boolean | |
41
42
  | [rowDataMapper](./grid-pro.genesisgriddatasourceelement.rowdatamapper.md) | | Function | Allows grid data updates to be processed via and external function before applying in grid |
42
43
  | [rowId](./grid-pro.genesisgriddatasourceelement.rowid.md) | <p><code>protected</code></p><p><code>readonly</code></p> | string | |
@@ -48,8 +49,10 @@ export declare class GenesisGridDatasourceElement extends GenesisGridDatasourceE
48
49
 
49
50
  | Method | Modifiers | Description |
50
51
  | --- | --- | --- |
52
+ | [clearErrors()](./grid-pro.genesisgriddatasourceelement.clearerrors.md) | | Clears error state and emits connected event. |
51
53
  | [datasourceOptions()](./grid-pro.genesisgriddatasourceelement.datasourceoptions.md) | <code>protected</code> | |
52
54
  | [datasourceStatusChanged(prev, next)](./grid-pro.genesisgriddatasourceelement.datasourcestatuschanged.md) | | |
55
+ | [handleErrors(errors, type)](./grid-pro.genesisgriddatasourceelement.handleerrors.md) | | Handles errors and emits appropriate error events. |
53
56
  | [removeFilter(fieldName)](./grid-pro.genesisgriddatasourceelement.removefilter.md) | | |
54
57
  | [setFilter(fieldName, newFilter)](./grid-pro.genesisgriddatasourceelement.setfilter.md) | | |
55
58
 
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GenesisGridDatasourceElement](./grid-pro.genesisgriddatasourceelement.md) &gt; [restartOnReconnection](./grid-pro.genesisgriddatasourceelement.restartonreconnection.md)
4
+
5
+ ## GenesisGridDatasourceElement.restartOnReconnection property
6
+
7
+ Attribute to set whether the datasource should restart when it reconnects.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ restartOnReconnection: boolean;
13
+ ```
14
+
15
+ ## Remarks
16
+
17
+ Defaults to `true`<!-- -->.
18
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [connectionSub](./grid-pro.gridprobasedatasource.connectionsub.md)
4
+
5
+ ## GridProBaseDatasource.connectionSub property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected connectionSub: Subscription | undefined;
11
+ ```
@@ -0,0 +1,17 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [isDisconnected](./grid-pro.gridprobasedatasource.isdisconnected.md)
4
+
5
+ ## GridProBaseDatasource.isDisconnected() method
6
+
7
+ Returns true if the grid has the ds-disconnected attribute.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ isDisconnected(): boolean;
13
+ ```
14
+ **Returns:**
15
+
16
+ boolean
17
+
@@ -19,6 +19,7 @@ export declare class GridProBaseDatasource extends GenesisGridDatasourceElement
19
19
  | [agTransaction](./grid-pro.gridprobasedatasource.agtransaction.md) | <code>protected</code> | RowDataTransaction \| ServerSideTransaction | |
20
20
  | [applyAsyncFuncName](./grid-pro.gridprobasedatasource.applyasyncfuncname.md) | <code>protected</code> | string | |
21
21
  | [applyFuncName](./grid-pro.gridprobasedatasource.applyfuncname.md) | <code>protected</code> | string | |
22
+ | [connectionSub](./grid-pro.gridprobasedatasource.connectionsub.md) | <code>protected</code> | Subscription \| undefined | |
22
23
  | [dataSubWasLoggedOff](./grid-pro.gridprobasedatasource.datasubwasloggedoff.md) | <code>protected</code> | boolean | |
23
24
  | [pagination](./grid-pro.gridprobasedatasource.pagination.md) | <p><code>protected</code></p><p><code>readonly</code></p> | boolean | |
24
25
  | [rowData](./grid-pro.gridprobasedatasource.rowdata.md) | | Map&lt;string, any&gt; | |
@@ -36,7 +37,11 @@ export declare class GridProBaseDatasource extends GenesisGridDatasourceElement
36
37
  | [handleStreamDeletes(deletedRows)](./grid-pro.gridprobasedatasource.handlestreamdeletes.md) | <code>protected</code> | |
37
38
  | [handleStreamInserts(insertedRows, addIndex)](./grid-pro.gridprobasedatasource.handlestreaminserts.md) | <code>protected</code> | |
38
39
  | [handleStreamUpdates(updatedRows)](./grid-pro.gridprobasedatasource.handlestreamupdates.md) | <code>protected</code> | |
40
+ | [isDisconnected()](./grid-pro.gridprobasedatasource.isdisconnected.md) | | Returns true if the grid has the ds-disconnected attribute. |
39
41
  | [loadMore()](./grid-pro.gridprobasedatasource.loadmore.md) | | |
40
42
  | [reloadResourceData()](./grid-pro.gridprobasedatasource.reloadresourcedata.md) | | |
41
43
  | [restart()](./grid-pro.gridprobasedatasource.restart.md) | | |
44
+ | [setDisconnected(disconnected)](./grid-pro.gridprobasedatasource.setdisconnected.md) | | Sets or removes the ds-disconnected attribute on the grid element. |
45
+ | [subscribeToConnection()](./grid-pro.gridprobasedatasource.subscribetoconnection.md) | <code>protected</code> | |
46
+ | [unsubscribeFromConnection()](./grid-pro.gridprobasedatasource.unsubscribefromconnection.md) | <code>protected</code> | |
42
47
 
@@ -0,0 +1,24 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [setDisconnected](./grid-pro.gridprobasedatasource.setdisconnected.md)
4
+
5
+ ## GridProBaseDatasource.setDisconnected() method
6
+
7
+ Sets or removes the ds-disconnected attribute on the grid element.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ setDisconnected(disconnected: boolean): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | disconnected | boolean | true to set, false to remove |
20
+
21
+ **Returns:**
22
+
23
+ void
24
+
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [subscribeToConnection](./grid-pro.gridprobasedatasource.subscribetoconnection.md)
4
+
5
+ ## GridProBaseDatasource.subscribeToConnection() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected subscribeToConnection(): void;
11
+ ```
12
+ **Returns:**
13
+
14
+ void
15
+
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProBaseDatasource](./grid-pro.gridprobasedatasource.md) &gt; [unsubscribeFromConnection](./grid-pro.gridprobasedatasource.unsubscribefromconnection.md)
4
+
5
+ ## GridProBaseDatasource.unsubscribeFromConnection() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected unsubscribeFromConnection(): void;
11
+ ```
12
+ **Returns:**
13
+
14
+ void
15
+
@@ -24,7 +24,6 @@ Only supports Client-Side Row Model.
24
24
  | [applyAsyncFuncName](./grid-pro.gridprogenesisdatasource.applyasyncfuncname.md) | | string | |
25
25
  | [applyFuncName](./grid-pro.gridprogenesisdatasource.applyfuncname.md) | | string | |
26
26
  | [keepColDefsOnClearRowData](./grid-pro.gridprogenesisdatasource.keepcoldefsonclearrowdata.md) | | boolean | |
27
- | [restartOnReconnection](./grid-pro.gridprogenesisdatasource.restartonreconnection.md) | | boolean | |
28
27
 
29
28
  ## Methods
30
29
 
@@ -38,7 +37,6 @@ Only supports Client-Side Row Model.
38
37
  | [deinit()](./grid-pro.gridprogenesisdatasource.deinit.md) | | Deinitialises the datasource, resetting it to its initial state. |
39
38
  | [destroy()](./grid-pro.gridprogenesisdatasource.destroy.md) | | Destroys the datasource, resetting it to its initial state. |
40
39
  | [disconnectedCallback()](./grid-pro.gridprogenesisdatasource.disconnectedcallback.md) | | |
41
- | [handleErrors(errors)](./grid-pro.gridprogenesisdatasource.handleerrors.md) | | |
42
40
  | [handleStreamDeletes(deletes)](./grid-pro.gridprogenesisdatasource.handlestreamdeletes.md) | | Handles stream deletes by removing records from the grid. |
43
41
  | [handleStreamInserts(inserts)](./grid-pro.gridprogenesisdatasource.handlestreaminserts.md) | | |
44
42
  | [handleStreamUpdates(updates)](./grid-pro.gridprogenesisdatasource.handlestreamupdates.md) | | |
@@ -12,5 +12,5 @@ gridProTemplate: ViewTemplate
12
12
 
13
13
  ## Remarks
14
14
 
15
- HTML Element: &lt;<!-- -->foundation-grid-pro<!-- -->&gt;
15
+ HTML Element: <foundation-grid-pro>
16
16
 
@@ -52,6 +52,7 @@ import { RowNodeTransaction } from '@ag-grid-community/core';
52
52
  import type { ServerSideTransaction } from '@ag-grid-community/core';
53
53
  import { ServerSideTransactionResult } from '@ag-grid-community/core';
54
54
  import { Session } from '@genesislcap/foundation-comms';
55
+ import { Subscription } from 'rxjs';
55
56
  import { Swatch } from '@microsoft/fast-components';
56
57
  import { SwatchRGB } from '@microsoft/fast-components';
57
58
  import { TextField } from '@genesislcap/foundation-ui';
@@ -779,6 +780,7 @@ template: ViewTemplate<StringEditor, any>;
779
780
  export class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_base {
780
781
  // (undocumented)
781
782
  protected get agGrid(): GridPro | null;
783
+ clearErrors(): void;
782
784
  // (undocumented)
783
785
  connect: Connect;
784
786
  // (undocumented)
@@ -801,8 +803,12 @@ export class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_b
801
803
  disablePolling: boolean;
802
804
  // (undocumented)
803
805
  fields: string;
806
+ // Warning: (ae-forgotten-export) The symbol "BaseDatasourceErrorEventDetail" needs to be exported by the entry point index.d.ts
807
+ handleErrors(errors: string | any[], type?: BaseDatasourceErrorEventDetail['type']): void;
804
808
  // @internal
805
809
  protected get hasDefaultRowId(): boolean;
810
+ // @internal
811
+ protected initializeDatasource(options: DatasourceOptions, fetchMeta?: boolean, startStream?: boolean): Promise<boolean>;
806
812
  // (undocumented)
807
813
  get isRequestServer(): boolean;
808
814
  // (undocumented)
@@ -824,6 +830,7 @@ export class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_b
824
830
  requestAutoSetup: boolean;
825
831
  // (undocumented)
826
832
  resourceName: string;
833
+ restartOnReconnection: boolean;
827
834
  // (undocumented)
828
835
  reverse: boolean;
829
836
  rowDataMapper: Function;
@@ -1036,6 +1043,8 @@ export class GridProBaseDatasource extends GenesisGridDatasourceElement {
1036
1043
  // (undocumented)
1037
1044
  protected applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: any) => void): void;
1038
1045
  // (undocumented)
1046
+ protected connectionSub: Subscription | undefined;
1047
+ // (undocumented)
1039
1048
  protected dataSubWasLoggedOff: boolean;
1040
1049
  // (undocumented)
1041
1050
  destroy(): void;
@@ -1053,6 +1062,7 @@ export class GridProBaseDatasource extends GenesisGridDatasourceElement {
1053
1062
  protected handleStreamInserts(insertedRows: any[], addIndex?: number): void;
1054
1063
  // (undocumented)
1055
1064
  protected handleStreamUpdates(updatedRows: any[]): void;
1065
+ isDisconnected(): boolean;
1056
1066
  // (undocumented)
1057
1067
  loadMore(): void;
1058
1068
  // (undocumented)
@@ -1063,6 +1073,11 @@ export class GridProBaseDatasource extends GenesisGridDatasourceElement {
1063
1073
  restart(): void;
1064
1074
  // (undocumented)
1065
1075
  rowData: Map<string, any>;
1076
+ setDisconnected(disconnected: boolean): void;
1077
+ // (undocumented)
1078
+ protected subscribeToConnection(): void;
1079
+ // (undocumented)
1080
+ protected unsubscribeFromConnection(): void;
1066
1081
  }
1067
1082
 
1068
1083
  // @public
@@ -1194,8 +1209,6 @@ export class GridProGenesisDatasource extends GridProGenesisDatasource_base {
1194
1209
  destroy(): void;
1195
1210
  // (undocumented)
1196
1211
  disconnectedCallback(): void;
1197
- // (undocumented)
1198
- handleErrors(errors: string | any[]): void;
1199
1212
  handleStreamDeletes(deletes?: any[]): void;
1200
1213
  // (undocumented)
1201
1214
  handleStreamInserts(inserts?: any[]): void;
@@ -1218,8 +1231,6 @@ export class GridProGenesisDatasource extends GridProGenesisDatasource_base {
1218
1231
  resourceNameChanged(oldValue: string, newValue: string): void;
1219
1232
  restart(): Promise<void>;
1220
1233
  // (undocumented)
1221
- restartOnReconnection: boolean;
1222
- // (undocumented)
1223
1234
  setFilter(fieldName: string, newFilter: string): void;
1224
1235
  }
1225
1236
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/grid-pro",
3
3
  "description": "Genesis Foundation AG Grid",
4
- "version": "14.292.0",
4
+ "version": "14.293.1",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -38,20 +38,20 @@
38
38
  }
39
39
  },
40
40
  "devDependencies": {
41
- "@genesislcap/foundation-testing": "14.292.0",
42
- "@genesislcap/genx": "14.292.0",
43
- "@genesislcap/rollup-builder": "14.292.0",
44
- "@genesislcap/ts-builder": "14.292.0",
45
- "@genesislcap/uvu-playwright-builder": "14.292.0",
46
- "@genesislcap/vite-builder": "14.292.0",
47
- "@genesislcap/webpack-builder": "14.292.0",
41
+ "@genesislcap/foundation-testing": "14.293.1",
42
+ "@genesislcap/genx": "14.293.1",
43
+ "@genesislcap/rollup-builder": "14.293.1",
44
+ "@genesislcap/ts-builder": "14.293.1",
45
+ "@genesislcap/uvu-playwright-builder": "14.293.1",
46
+ "@genesislcap/vite-builder": "14.293.1",
47
+ "@genesislcap/webpack-builder": "14.293.1",
48
48
  "rimraf": "^5.0.0"
49
49
  },
50
50
  "dependencies": {
51
- "@genesislcap/foundation-comms": "14.292.0",
52
- "@genesislcap/foundation-logger": "14.292.0",
53
- "@genesislcap/foundation-ui": "14.292.0",
54
- "@genesislcap/foundation-utils": "14.292.0",
51
+ "@genesislcap/foundation-comms": "14.293.1",
52
+ "@genesislcap/foundation-logger": "14.293.1",
53
+ "@genesislcap/foundation-ui": "14.293.1",
54
+ "@genesislcap/foundation-utils": "14.293.1",
55
55
  "@microsoft/fast-colors": "5.3.1",
56
56
  "@microsoft/fast-components": "2.30.6",
57
57
  "@microsoft/fast-element": "1.14.0",
@@ -77,5 +77,5 @@
77
77
  "access": "public"
78
78
  },
79
79
  "customElements": "dist/custom-elements.json",
80
- "gitHead": "1f6610ae9f53c6ac06b8e2c4921bb6ff7a404902"
80
+ "gitHead": "79f870205c14e857233724904d5eb8e034d2a72e"
81
81
  }
@@ -1,22 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [handleErrors](./grid-pro.gridprogenesisdatasource.handleerrors.md)
4
-
5
- ## GridProGenesisDatasource.handleErrors() method
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- handleErrors(errors: string | any[]): void;
11
- ```
12
-
13
- ## Parameters
14
-
15
- | Parameter | Type | Description |
16
- | --- | --- | --- |
17
- | errors | string \| any\[\] | |
18
-
19
- **Returns:**
20
-
21
- void
22
-
@@ -1,11 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [restartOnReconnection](./grid-pro.gridprogenesisdatasource.restartonreconnection.md)
4
-
5
- ## GridProGenesisDatasource.restartOnReconnection property
6
-
7
- **Signature:**
8
-
9
- ```typescript
10
- restartOnReconnection: boolean;
11
- ```