@genesislcap/grid-pro 14.141.3 → 14.142.1-alpha-a84f41b.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.
@@ -0,0 +1,23 @@
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; [applyTransactionAsync](./grid-pro.gridprogenesisdatasource.applytransactionasync.md)
4
+
5
+ ## GridProGenesisDatasource.applyTransactionAsync() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: RowNodeTransaction) => void): void;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | agTransaction | RowDataTransaction | |
18
+ | callback | (res: RowNodeTransaction) =&gt; void | _(Optional)_ |
19
+
20
+ **Returns:**
21
+
22
+ void
23
+
@@ -21,19 +21,21 @@ Only supports Client-Side Row Model.
21
21
 
22
22
  | Property | Modifiers | Type | Description |
23
23
  | --- | --- | --- | --- |
24
+ | [applyAsyncFuncName](./grid-pro.gridprogenesisdatasource.applyasyncfuncname.md) | | string | |
25
+ | [applyFuncName](./grid-pro.gridprogenesisdatasource.applyfuncname.md) | | string | |
24
26
  | [auth](./grid-pro.gridprogenesisdatasource.auth.md) | | Auth | |
25
27
  | [datasource](./grid-pro.gridprogenesisdatasource.datasource.md) | | Datasource | |
26
28
  | [disablePolling](./grid-pro.gridprogenesisdatasource.disablepolling.md) | | boolean | |
27
29
  | [pollingInterval](./grid-pro.gridprogenesisdatasource.pollinginterval.md) | | number | |
28
30
  | [request](./grid-pro.gridprogenesisdatasource.request.md) | | any | |
29
31
  | [restartOnReconnection](./grid-pro.gridprogenesisdatasource.restartonreconnection.md) | | boolean | |
30
- | [rowDataMapper](./grid-pro.gridprogenesisdatasource.rowdatamapper.md) | | Function | Allows grid data updates to be processed via and external function before applying in grid |
31
- | [rowIdAttr](./grid-pro.gridprogenesisdatasource.rowidattr.md) | | any | <p>Attribute to set an unique identifier for the row.</p><p>Defaults to <code>ROW_REF</code> or <code>RECORD_ID</code> depending on the resource type.</p> |
32
32
 
33
33
  ## Methods
34
34
 
35
35
  | Method | Modifiers | Description |
36
36
  | --- | --- | --- |
37
+ | [applyTransaction(agTransaction)](./grid-pro.gridprogenesisdatasource.applytransaction.md) | | |
38
+ | [applyTransactionAsync(agTransaction, callback)](./grid-pro.gridprogenesisdatasource.applytransactionasync.md) | | |
37
39
  | [connectedCallback()](./grid-pro.gridprogenesisdatasource.connectedcallback.md) | | |
38
40
  | [criteriaChanged(oldCriteria, newCriteria)](./grid-pro.gridprogenesisdatasource.criteriachanged.md) | | |
39
41
  | [deepClone()](./grid-pro.gridprogenesisdatasource.deepclone.md) | | |
@@ -36,12 +36,18 @@ import { ICellRendererParams } from '@ag-grid-community/core';
36
36
  import { InterfaceSymbol } from '@microsoft/fast-foundation';
37
37
  import type { IServerSideDatasource } from '@ag-grid-community/core';
38
38
  import type { IServerSideGetRowsParams } from '@ag-grid-community/core';
39
+ import type { IServerSideRowModel } from '@ag-grid-community/core';
39
40
  import { ITooltipComp } from '@ag-grid-community/core';
40
41
  import { ITooltipParams } from '@ag-grid-community/core';
41
42
  import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
42
43
  import { Logger } from '@genesislcap/foundation-logger';
43
44
  import { MetadataDetail } from '@genesislcap/foundation-comms';
44
45
  import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
46
+ import type { RowDataTransaction } from '@ag-grid-community/core';
47
+ import type { RowNodeTransaction } from '@ag-grid-community/core';
48
+ import type { ServerSideTransaction } from '@ag-grid-community/core';
49
+ import type { ServerSideTransactionResult } from '@ag-grid-community/core';
50
+ import { Session } from '@genesislcap/foundation-comms';
45
51
  import { SocketObservable } from '@genesislcap/foundation-comms';
46
52
  import { Swatch } from '@microsoft/fast-components';
47
53
  import { SwatchRGB } from '@microsoft/fast-components';
@@ -894,6 +900,14 @@ export function gridProColumns<TSource = any>(itemsBinding: Binding<TSource, rea
894
900
  //
895
901
  // @public
896
902
  export class GridProGenesisDatasource extends GridProGenesisDatasource_base {
903
+ // (undocumented)
904
+ applyAsyncFuncName: string;
905
+ // (undocumented)
906
+ applyFuncName: string;
907
+ // (undocumented)
908
+ applyTransaction(agTransaction: RowDataTransaction): RowNodeTransaction | null | undefined;
909
+ // (undocumented)
910
+ applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: RowNodeTransaction) => void): void;
897
911
  // (undocumented)
898
912
  auth: Auth;
899
913
  // (undocumented)
@@ -926,8 +940,6 @@ export class GridProGenesisDatasource extends GridProGenesisDatasource_base {
926
940
  restart(): void;
927
941
  // (undocumented)
928
942
  restartOnReconnection: boolean;
929
- rowDataMapper: Function;
930
- rowIdAttr: any;
931
943
  // (undocumented)
932
944
  setFilter(fieldName: string, newFilter: string): void;
933
945
  }
@@ -962,6 +974,14 @@ export enum GridProRendererTypes {
962
974
  //
963
975
  // @alpha
964
976
  export class GridProServerSideDatasource extends GridProServerSideDatasource_base {
977
+ // (undocumented)
978
+ applyAsyncFuncName: string;
979
+ // (undocumented)
980
+ applyFuncName: string;
981
+ // (undocumented)
982
+ applyTransaction(agTransaction: RowDataTransaction): ServerSideTransactionResult;
983
+ // (undocumented)
984
+ applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: ServerSideTransactionResult) => void): void;
965
985
  // (undocumented)
966
986
  connectedCallback(): void;
967
987
  // (undocumented)
@@ -983,7 +1003,7 @@ export class GridProServerSideDatasource extends GridProServerSideDatasource_bas
983
1003
  // (undocumented)
984
1004
  restart(): void;
985
1005
  // (undocumented)
986
- rowId: string;
1006
+ get rowModel(): IServerSideRowModel;
987
1007
  }
988
1008
 
989
1009
  // @public
@@ -1077,18 +1097,6 @@ export interface NumberEditorParams extends ICellEditorParams {
1077
1097
  withFormatting: boolean;
1078
1098
  }
1079
1099
 
1080
- // Warning: (ae-internal-missing-underscore) The name "OperationType" should be prefixed with an underscore because the declaration is marked as @internal
1081
- //
1082
- // @internal
1083
- export enum OperationType {
1084
- // (undocumented)
1085
- Add = "add",
1086
- // (undocumented)
1087
- Remove = "remove",
1088
- // (undocumented)
1089
- Update = "update"
1090
- }
1091
-
1092
1100
  // @public
1093
1101
  export class SelectEditor extends FoundationElement implements ICellEditorComp {
1094
1102
  // (undocumented)
@@ -1153,11 +1161,15 @@ export class SelectRenderer extends FoundationElement implements ICellRendererCo
1153
1161
  value: string;
1154
1162
  }
1155
1163
 
1164
+ // Warning: (ae-forgotten-export) The symbol "StreamBaseDatasource" needs to be exported by the entry point index.d.ts
1165
+ //
1156
1166
  // @alpha
1157
- export class StreamDatasource implements IServerSideDatasource {
1167
+ export class StreamDatasource extends StreamBaseDatasource implements IServerSideDatasource {
1158
1168
  constructor(options: StreamDatasourceOptions);
1159
1169
  // (undocumented)
1160
1170
  auth: Auth;
1171
+ // @internal
1172
+ client_ROWS_COUNT: number;
1161
1173
  // (undocumented)
1162
1174
  connect: Connect;
1163
1175
  // (undocumented)
@@ -1166,6 +1178,8 @@ export class StreamDatasource implements IServerSideDatasource {
1166
1178
  getRows(params: IServerSideGetRowsParams): Promise<void>;
1167
1179
  // (undocumented)
1168
1180
  resourceParams: any;
1181
+ // @internal
1182
+ server_ROWS_COUNT: number;
1169
1183
  // (undocumented)
1170
1184
  streamSourceRef: string;
1171
1185
  }
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.141.3",
4
+ "version": "14.142.1-alpha-a84f41b.0",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -30,15 +30,15 @@
30
30
  "test:debug": "genx test --debug"
31
31
  },
32
32
  "devDependencies": {
33
- "@genesislcap/foundation-testing": "14.141.3",
34
- "@genesislcap/genx": "14.141.3",
33
+ "@genesislcap/foundation-testing": "14.142.1-alpha-a84f41b.0",
34
+ "@genesislcap/genx": "14.142.1-alpha-a84f41b.0",
35
35
  "rimraf": "^3.0.2"
36
36
  },
37
37
  "dependencies": {
38
- "@genesislcap/foundation-comms": "14.141.3",
39
- "@genesislcap/foundation-logger": "14.141.3",
40
- "@genesislcap/foundation-ui": "14.141.3",
41
- "@genesislcap/foundation-utils": "14.141.3",
38
+ "@genesislcap/foundation-comms": "14.142.1-alpha-a84f41b.0",
39
+ "@genesislcap/foundation-logger": "14.142.1-alpha-a84f41b.0",
40
+ "@genesislcap/foundation-ui": "14.142.1-alpha-a84f41b.0",
41
+ "@genesislcap/foundation-utils": "14.142.1-alpha-a84f41b.0",
42
42
  "@microsoft/fast-colors": "^5.3.1",
43
43
  "@microsoft/fast-components": "^2.30.6",
44
44
  "@microsoft/fast-element": "^1.12.0",
@@ -62,5 +62,5 @@
62
62
  "access": "public"
63
63
  },
64
64
  "customElements": "dist/custom-elements.json",
65
- "gitHead": "37b360922e11609ac87d08b72cb66de130732b8d"
65
+ "gitHead": "a443d58018c59c98076015aebe257fd898e365e3"
66
66
  }
@@ -1,13 +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; [rowDataMapper](./grid-pro.gridprogenesisdatasource.rowdatamapper.md)
4
-
5
- ## GridProGenesisDatasource.rowDataMapper property
6
-
7
- Allows grid data updates to be processed via and external function before applying in grid
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- rowDataMapper: Function;
13
- ```
@@ -1,15 +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; [rowIdAttr](./grid-pro.gridprogenesisdatasource.rowidattr.md)
4
-
5
- ## GridProGenesisDatasource.rowIdAttr property
6
-
7
- Attribute to set an unique identifier for the row.
8
-
9
- Defaults to `ROW_REF` or `RECORD_ID` depending on the resource type.
10
-
11
- **Signature:**
12
-
13
- ```typescript
14
- rowIdAttr: any;
15
- ```