@genesislcap/foundation-workspace 15.46.2-FUI-2628.3 → 15.46.2-FUI-2625.2

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.
@@ -175,7 +175,7 @@
175
175
  {
176
176
  "kind": "Class",
177
177
  "canonicalReference": "@genesislcap/foundation-workspace!DefaultFilterRegistry:class",
178
- "docComment": "/**\n * Default filter registry implementation.\n *\n * @remarks\n *\n * Keeps a store of every filter's last known value by key, so a workspace covers filters that aren't currently mounted (e.g. on another route): - `unregisterFilter` stores the filter's last value; `registerFilter` applies any stored value. - `applyFiltersValues` (workspace load) replaces the store with the loaded values and applies them to mounted filters; unmounted ones pick theirs up when they register. - `getAllFiltersValues` (workspace save) returns the store with mounted filters' live values on top, so a filter the user never visited keeps its loaded value rather than being dropped.\n *\n * @alpha\n */\n",
178
+ "docComment": "/**\n * @alpha\n */\n",
179
179
  "excerptTokens": [
180
180
  {
181
181
  "kind": "Content",
@@ -207,7 +207,7 @@
207
207
  {
208
208
  "kind": "Class",
209
209
  "canonicalReference": "@genesislcap/foundation-workspace!DefaultGridRegistry:class",
210
- "docComment": "/**\n * Default grid registry implementation.\n *\n * @remarks\n *\n * Keeps a store of every grid's last known column state and filter model by key, so a workspace covers grids that aren't currently mounted (e.g. on another route): - `unregisterGrid` stores the grid's last state; `registerGrid` applies any stored state. - `applyAllGridsSettings` (workspace load) replaces the store with the loaded settings and applies them to mounted grids; unmounted ones pick theirs up when they register. - `getAllGridsSettings` (workspace save) returns the store with mounted grids' live state on top, so a grid the user never visited keeps its loaded state rather than being dropped.\n *\n * Filters race with the grid's own start-up. grid-pro restores its persisted filter model (`persist-filter-model-key`) asynchronously, up to three times — at grid ready, once datasource-driven columns exist, and on the datasource's `filtersRestored` — and a restore with nothing stored applies `{}`, clearing every filter. A filter for a column that doesn't exist yet is dropped. So when the registry applies a filter model it: 1. writes it into the grid's own filter persistence first (`filterPersistence`), so grid-pro's later restores, including a datasource re-init long after start-up, return the workspace's model rather than an older one; 2. arms a guard that re-applies it if a programmatic filter change (e.g. a restore that read storage before step 1 landed, as KV storage can) replaces it, and when the grid's columns change (so filters on columns that arrive late apply). The guard ends as soon as the user changes a filter, once the grid has been quiet for `filterSettleMs` after its last start-up event, and in any case after `filterGuardMaxMs`, so it never fights app code for long. It re-applies at most `maxFilterReapplies` times per arming, so it cannot loop.\n *\n * A saved entry without `filterModel` (a workspace saved before filters were captured) leaves the grid's filters alone.\n *\n * @alpha\n */\n",
210
+ "docComment": "/**\n * @alpha\n */\n",
211
211
  "excerptTokens": [
212
212
  {
213
213
  "kind": "Content",
@@ -228,98 +228,7 @@
228
228
  "isAbstract": false,
229
229
  "name": "DefaultGridRegistry",
230
230
  "preserveMemberOrder": false,
231
- "members": [
232
- {
233
- "kind": "Property",
234
- "canonicalReference": "@genesislcap/foundation-workspace!DefaultGridRegistry#filterGuardMaxMs:member",
235
- "docComment": "/**\n * Longest the filter guard runs after it is armed, however often it is re-armed.\n */\n",
236
- "excerptTokens": [
237
- {
238
- "kind": "Content",
239
- "text": "filterGuardMaxMs: "
240
- },
241
- {
242
- "kind": "Content",
243
- "text": "number"
244
- },
245
- {
246
- "kind": "Content",
247
- "text": ";"
248
- }
249
- ],
250
- "isReadonly": false,
251
- "isOptional": false,
252
- "releaseTag": "Alpha",
253
- "name": "filterGuardMaxMs",
254
- "propertyTypeTokenRange": {
255
- "startIndex": 1,
256
- "endIndex": 2
257
- },
258
- "isStatic": false,
259
- "isProtected": false,
260
- "isAbstract": false
261
- },
262
- {
263
- "kind": "Property",
264
- "canonicalReference": "@genesislcap/foundation-workspace!DefaultGridRegistry#filterSettleMs:member",
265
- "docComment": "/**\n * Quiet period after the last start-up event before the filter guard ends.\n */\n",
266
- "excerptTokens": [
267
- {
268
- "kind": "Content",
269
- "text": "filterSettleMs: "
270
- },
271
- {
272
- "kind": "Content",
273
- "text": "number"
274
- },
275
- {
276
- "kind": "Content",
277
- "text": ";"
278
- }
279
- ],
280
- "isReadonly": false,
281
- "isOptional": false,
282
- "releaseTag": "Alpha",
283
- "name": "filterSettleMs",
284
- "propertyTypeTokenRange": {
285
- "startIndex": 1,
286
- "endIndex": 2
287
- },
288
- "isStatic": false,
289
- "isProtected": false,
290
- "isAbstract": false
291
- },
292
- {
293
- "kind": "Property",
294
- "canonicalReference": "@genesislcap/foundation-workspace!DefaultGridRegistry#maxFilterReapplies:member",
295
- "docComment": "/**\n * Most re-applies the filter guard makes per arming.\n */\n",
296
- "excerptTokens": [
297
- {
298
- "kind": "Content",
299
- "text": "maxFilterReapplies: "
300
- },
301
- {
302
- "kind": "Content",
303
- "text": "number"
304
- },
305
- {
306
- "kind": "Content",
307
- "text": ";"
308
- }
309
- ],
310
- "isReadonly": false,
311
- "isOptional": false,
312
- "releaseTag": "Alpha",
313
- "name": "maxFilterReapplies",
314
- "propertyTypeTokenRange": {
315
- "startIndex": 1,
316
- "endIndex": 2
317
- },
318
- "isStatic": false,
319
- "isProtected": false,
320
- "isAbstract": false
321
- }
322
- ],
231
+ "members": [],
323
232
  "implementsTokenRanges": [
324
233
  {
325
234
  "startIndex": 1,
@@ -330,7 +239,7 @@
330
239
  {
331
240
  "kind": "Class",
332
241
  "canonicalReference": "@genesislcap/foundation-workspace!DefaultLayoutRegistry:class",
333
- "docComment": "/**\n * Default layout registry implementation.\n *\n * @remarks\n *\n * Keeps a store of every layout's last known config by key, so a workspace covers layouts that aren't currently mounted (e.g. on another route): - `unregisterLayout` stores the layout's last config; `registerLayout` loads any stored config once the layout has finished its first load (so its declared or autosaved layout doesn't overwrite it). - `applySavedLayouts` (workspace load) replaces the store with the loaded configs and loads them into mounted layouts; unmounted ones pick theirs up when they register. - `getLayoutsConfigs` (workspace save) returns the store with mounted layouts' live configs on top, so a layout the user never visited keeps its loaded config rather than being dropped.\n *\n * @alpha\n */\n",
242
+ "docComment": "/**\n * Default layout registry implementation.\n *\n * @alpha\n */\n",
334
243
  "excerptTokens": [
335
244
  {
336
245
  "kind": "Content",
@@ -885,78 +794,10 @@
885
794
  "endIndex": 6
886
795
  }
887
796
  },
888
- {
889
- "kind": "Interface",
890
- "canonicalReference": "@genesislcap/foundation-workspace!GridFilterPersistence:interface",
891
- "docComment": "/**\n * The part of a grid element that persists its own filter model, e.g. grid-pro's `setFilterModel` (backed by `persist-filter-model-key`, or an in-memory cache without one).\n *\n * @alpha\n */\n",
892
- "excerptTokens": [
893
- {
894
- "kind": "Content",
895
- "text": "export interface GridFilterPersistence "
896
- }
897
- ],
898
- "fileUrlPath": "src/workspace/grid-registry.ts",
899
- "releaseTag": "Alpha",
900
- "name": "GridFilterPersistence",
901
- "preserveMemberOrder": false,
902
- "members": [
903
- {
904
- "kind": "MethodSignature",
905
- "canonicalReference": "@genesislcap/foundation-workspace!GridFilterPersistence#setFilterModel:member(1)",
906
- "docComment": "",
907
- "excerptTokens": [
908
- {
909
- "kind": "Content",
910
- "text": "setFilterModel(filterModel: "
911
- },
912
- {
913
- "kind": "Reference",
914
- "text": "Record",
915
- "canonicalReference": "!Record:type"
916
- },
917
- {
918
- "kind": "Content",
919
- "text": "<string, unknown>"
920
- },
921
- {
922
- "kind": "Content",
923
- "text": "): "
924
- },
925
- {
926
- "kind": "Content",
927
- "text": "unknown"
928
- },
929
- {
930
- "kind": "Content",
931
- "text": ";"
932
- }
933
- ],
934
- "isOptional": false,
935
- "returnTypeTokenRange": {
936
- "startIndex": 4,
937
- "endIndex": 5
938
- },
939
- "releaseTag": "Alpha",
940
- "overloadIndex": 1,
941
- "parameters": [
942
- {
943
- "parameterName": "filterModel",
944
- "parameterTypeTokenRange": {
945
- "startIndex": 1,
946
- "endIndex": 3
947
- },
948
- "isOptional": false
949
- }
950
- ],
951
- "name": "setFilterModel"
952
- }
953
- ],
954
- "extendsTokenRanges": []
955
- },
956
797
  {
957
798
  "kind": "Class",
958
799
  "canonicalReference": "@genesislcap/foundation-workspace!GridRegister:class",
959
- "docComment": "/**\n * Registers an AG Grid instance so workspace state can apply/load it. Registering applies the grid's stored column state (from the loaded workspace, or its last state this session) — see `DefaultGridRegistry`.\n *\n * @alpha\n */\n",
800
+ "docComment": "/**\n * Registers an AG Grid instance so workspace state can apply/load it.\n *\n * @alpha\n */\n",
960
801
  "excerptTokens": [
961
802
  {
962
803
  "kind": "Content",
@@ -1068,6 +909,37 @@
1068
909
  "isStatic": false,
1069
910
  "isProtected": false,
1070
911
  "isAbstract": false
912
+ },
913
+ {
914
+ "kind": "Property",
915
+ "canonicalReference": "@genesislcap/foundation-workspace!GridRegister#workspaceState:member",
916
+ "docComment": "",
917
+ "excerptTokens": [
918
+ {
919
+ "kind": "Content",
920
+ "text": "workspaceState: "
921
+ },
922
+ {
923
+ "kind": "Reference",
924
+ "text": "WorkspaceState",
925
+ "canonicalReference": "@genesislcap/foundation-workspace!WorkspaceState:interface"
926
+ },
927
+ {
928
+ "kind": "Content",
929
+ "text": ";"
930
+ }
931
+ ],
932
+ "isReadonly": false,
933
+ "isOptional": false,
934
+ "releaseTag": "Alpha",
935
+ "name": "workspaceState",
936
+ "propertyTypeTokenRange": {
937
+ "startIndex": 1,
938
+ "endIndex": 2
939
+ },
940
+ "isStatic": false,
941
+ "isProtected": false,
942
+ "isAbstract": false
1071
943
  }
1072
944
  ],
1073
945
  "extendsTokenRange": {
@@ -1119,34 +991,6 @@
1119
991
  "endIndex": 2
1120
992
  }
1121
993
  },
1122
- {
1123
- "kind": "PropertySignature",
1124
- "canonicalReference": "@genesislcap/foundation-workspace!GridRegistration#filterPersistence:member",
1125
- "docComment": "/**\n * The grid element's own filter persistence, when the grid has one (grid-pro does).\n */\n",
1126
- "excerptTokens": [
1127
- {
1128
- "kind": "Content",
1129
- "text": "filterPersistence?: "
1130
- },
1131
- {
1132
- "kind": "Reference",
1133
- "text": "GridFilterPersistence",
1134
- "canonicalReference": "@genesislcap/foundation-workspace!GridFilterPersistence:interface"
1135
- },
1136
- {
1137
- "kind": "Content",
1138
- "text": ";"
1139
- }
1140
- ],
1141
- "isReadonly": false,
1142
- "isOptional": true,
1143
- "releaseTag": "Alpha",
1144
- "name": "filterPersistence",
1145
- "propertyTypeTokenRange": {
1146
- "startIndex": 1,
1147
- "endIndex": 2
1148
- }
1149
- },
1150
994
  {
1151
995
  "kind": "PropertySignature",
1152
996
  "canonicalReference": "@genesislcap/foundation-workspace!GridRegistration#gridApi:member",
@@ -1454,15 +1298,6 @@
1454
1298
  "kind": "Content",
1455
1299
  "text": "unknown"
1456
1300
  },
1457
- {
1458
- "kind": "Content",
1459
- "text": ", filterPersistence?: "
1460
- },
1461
- {
1462
- "kind": "Reference",
1463
- "text": "GridFilterPersistence",
1464
- "canonicalReference": "@genesislcap/foundation-workspace!GridFilterPersistence:interface"
1465
- },
1466
1301
  {
1467
1302
  "kind": "Content",
1468
1303
  "text": "): "
@@ -1478,8 +1313,8 @@
1478
1313
  ],
1479
1314
  "isOptional": false,
1480
1315
  "returnTypeTokenRange": {
1481
- "startIndex": 9,
1482
- "endIndex": 10
1316
+ "startIndex": 7,
1317
+ "endIndex": 8
1483
1318
  },
1484
1319
  "releaseTag": "Alpha",
1485
1320
  "overloadIndex": 1,
@@ -1507,14 +1342,6 @@
1507
1342
  "endIndex": 6
1508
1343
  },
1509
1344
  "isOptional": false
1510
- },
1511
- {
1512
- "parameterName": "filterPersistence",
1513
- "parameterTypeTokenRange": {
1514
- "startIndex": 7,
1515
- "endIndex": 8
1516
- },
1517
- "isOptional": true
1518
1345
  }
1519
1346
  ],
1520
1347
  "name": "registerGrid"
@@ -2100,7 +1927,7 @@
2100
1927
  {
2101
1928
  "kind": "PropertySignature",
2102
1929
  "canonicalReference": "@genesislcap/foundation-workspace!SavedGridSettings#columnState:member",
2103
- "docComment": "/**\n * AG Grid column state; includes sort (`sort`/`sortIndex`) as well as order, width, visibility.\n */\n",
1930
+ "docComment": "",
2104
1931
  "excerptTokens": [
2105
1932
  {
2106
1933
  "kind": "Content",
@@ -2124,38 +1951,6 @@
2124
1951
  "endIndex": 2
2125
1952
  }
2126
1953
  },
2127
- {
2128
- "kind": "PropertySignature",
2129
- "canonicalReference": "@genesislcap/foundation-workspace!SavedGridSettings#filterModel:member",
2130
- "docComment": "/**\n * AG Grid filter model (`gridApi.getFilterModel()`); `{}` when no filters are set. Absent on workspaces saved before filters were captured, which then leave the grid's filters alone.\n */\n",
2131
- "excerptTokens": [
2132
- {
2133
- "kind": "Content",
2134
- "text": "filterModel?: "
2135
- },
2136
- {
2137
- "kind": "Reference",
2138
- "text": "Record",
2139
- "canonicalReference": "!Record:type"
2140
- },
2141
- {
2142
- "kind": "Content",
2143
- "text": "<string, unknown>"
2144
- },
2145
- {
2146
- "kind": "Content",
2147
- "text": ";"
2148
- }
2149
- ],
2150
- "isReadonly": false,
2151
- "isOptional": true,
2152
- "releaseTag": "Alpha",
2153
- "name": "filterModel",
2154
- "propertyTypeTokenRange": {
2155
- "startIndex": 1,
2156
- "endIndex": 3
2157
- }
2158
- },
2159
1954
  {
2160
1955
  "kind": "PropertySignature",
2161
1956
  "canonicalReference": "@genesislcap/foundation-workspace!SavedGridSettings#gridKey:member",
@@ -2774,235 +2569,6 @@
2774
2569
  "endIndex": 10
2775
2570
  }
2776
2571
  },
2777
- {
2778
- "kind": "Interface",
2779
- "canonicalReference": "@genesislcap/foundation-workspace!WorkspaceLayout:interface",
2780
- "docComment": "/**\n * What the layout registry needs from a registered layout. `rapid-layout` (`FoundationLayout`) satisfies it as-is; adapters make other layout libraries saveable, e.g. `useWorkspaceFlexLayout` in `@genesislcap/foundation-react-utils/workspace` for flexlayout-react.\n *\n * @alpha\n */\n",
2781
- "excerptTokens": [
2782
- {
2783
- "kind": "Content",
2784
- "text": "export interface WorkspaceLayout "
2785
- }
2786
- ],
2787
- "fileUrlPath": "src/workspace/layout-registry.ts",
2788
- "releaseTag": "Alpha",
2789
- "name": "WorkspaceLayout",
2790
- "preserveMemberOrder": false,
2791
- "members": [
2792
- {
2793
- "kind": "MethodSignature",
2794
- "canonicalReference": "@genesislcap/foundation-workspace!WorkspaceLayout#addEventListener:member(1)",
2795
- "docComment": "/**\n * Used to wait for `first-loaded` when `hasFirstLoaded` is still false.\n */\n",
2796
- "excerptTokens": [
2797
- {
2798
- "kind": "Content",
2799
- "text": "addEventListener(type: "
2800
- },
2801
- {
2802
- "kind": "Content",
2803
- "text": "string"
2804
- },
2805
- {
2806
- "kind": "Content",
2807
- "text": ", listener: "
2808
- },
2809
- {
2810
- "kind": "Content",
2811
- "text": "() => void"
2812
- },
2813
- {
2814
- "kind": "Content",
2815
- "text": ", options?: "
2816
- },
2817
- {
2818
- "kind": "Content",
2819
- "text": "{\n once?: boolean;\n }"
2820
- },
2821
- {
2822
- "kind": "Content",
2823
- "text": "): "
2824
- },
2825
- {
2826
- "kind": "Content",
2827
- "text": "void"
2828
- },
2829
- {
2830
- "kind": "Content",
2831
- "text": ";"
2832
- }
2833
- ],
2834
- "isOptional": false,
2835
- "returnTypeTokenRange": {
2836
- "startIndex": 7,
2837
- "endIndex": 8
2838
- },
2839
- "releaseTag": "Alpha",
2840
- "overloadIndex": 1,
2841
- "parameters": [
2842
- {
2843
- "parameterName": "type",
2844
- "parameterTypeTokenRange": {
2845
- "startIndex": 1,
2846
- "endIndex": 2
2847
- },
2848
- "isOptional": false
2849
- },
2850
- {
2851
- "parameterName": "listener",
2852
- "parameterTypeTokenRange": {
2853
- "startIndex": 3,
2854
- "endIndex": 4
2855
- },
2856
- "isOptional": false
2857
- },
2858
- {
2859
- "parameterName": "options",
2860
- "parameterTypeTokenRange": {
2861
- "startIndex": 5,
2862
- "endIndex": 6
2863
- },
2864
- "isOptional": true
2865
- }
2866
- ],
2867
- "name": "addEventListener"
2868
- },
2869
- {
2870
- "kind": "MethodSignature",
2871
- "canonicalReference": "@genesislcap/foundation-workspace!WorkspaceLayout#getLayout:member(1)",
2872
- "docComment": "/**\n * Returns the layout's current config (serialisable JSON) for a workspace to save.\n */\n",
2873
- "excerptTokens": [
2874
- {
2875
- "kind": "Content",
2876
- "text": "getLayout(): "
2877
- },
2878
- {
2879
- "kind": "Reference",
2880
- "text": "SerialisedLayout",
2881
- "canonicalReference": "@genesislcap/foundation-layout!SerialisedLayout:type"
2882
- },
2883
- {
2884
- "kind": "Content",
2885
- "text": ";"
2886
- }
2887
- ],
2888
- "isOptional": false,
2889
- "returnTypeTokenRange": {
2890
- "startIndex": 1,
2891
- "endIndex": 2
2892
- },
2893
- "releaseTag": "Alpha",
2894
- "overloadIndex": 1,
2895
- "parameters": [],
2896
- "name": "getLayout"
2897
- },
2898
- {
2899
- "kind": "PropertySignature",
2900
- "canonicalReference": "@genesislcap/foundation-workspace!WorkspaceLayout#hasFirstLoaded:member",
2901
- "docComment": "/**\n * Whether the layout has finished its first load; its config is only read after that.\n */\n",
2902
- "excerptTokens": [
2903
- {
2904
- "kind": "Content",
2905
- "text": "hasFirstLoaded: "
2906
- },
2907
- {
2908
- "kind": "Content",
2909
- "text": "boolean"
2910
- },
2911
- {
2912
- "kind": "Content",
2913
- "text": ";"
2914
- }
2915
- ],
2916
- "isReadonly": false,
2917
- "isOptional": false,
2918
- "releaseTag": "Alpha",
2919
- "name": "hasFirstLoaded",
2920
- "propertyTypeTokenRange": {
2921
- "startIndex": 1,
2922
- "endIndex": 2
2923
- }
2924
- },
2925
- {
2926
- "kind": "MethodSignature",
2927
- "canonicalReference": "@genesislcap/foundation-workspace!WorkspaceLayout#loadLayout:member(1)",
2928
- "docComment": "/**\n * Replaces the layout with a saved config.\n */\n",
2929
- "excerptTokens": [
2930
- {
2931
- "kind": "Content",
2932
- "text": "loadLayout(layout: "
2933
- },
2934
- {
2935
- "kind": "Reference",
2936
- "text": "SerialisedLayout",
2937
- "canonicalReference": "@genesislcap/foundation-layout!SerialisedLayout:type"
2938
- },
2939
- {
2940
- "kind": "Content",
2941
- "text": ", handleMissingItem?: "
2942
- },
2943
- {
2944
- "kind": "Content",
2945
- "text": "'placeholder' | 'error'"
2946
- },
2947
- {
2948
- "kind": "Content",
2949
- "text": ", disableCache?: "
2950
- },
2951
- {
2952
- "kind": "Content",
2953
- "text": "boolean"
2954
- },
2955
- {
2956
- "kind": "Content",
2957
- "text": "): "
2958
- },
2959
- {
2960
- "kind": "Content",
2961
- "text": "void"
2962
- },
2963
- {
2964
- "kind": "Content",
2965
- "text": ";"
2966
- }
2967
- ],
2968
- "isOptional": false,
2969
- "returnTypeTokenRange": {
2970
- "startIndex": 7,
2971
- "endIndex": 8
2972
- },
2973
- "releaseTag": "Alpha",
2974
- "overloadIndex": 1,
2975
- "parameters": [
2976
- {
2977
- "parameterName": "layout",
2978
- "parameterTypeTokenRange": {
2979
- "startIndex": 1,
2980
- "endIndex": 2
2981
- },
2982
- "isOptional": false
2983
- },
2984
- {
2985
- "parameterName": "handleMissingItem",
2986
- "parameterTypeTokenRange": {
2987
- "startIndex": 3,
2988
- "endIndex": 4
2989
- },
2990
- "isOptional": true
2991
- },
2992
- {
2993
- "parameterName": "disableCache",
2994
- "parameterTypeTokenRange": {
2995
- "startIndex": 5,
2996
- "endIndex": 6
2997
- },
2998
- "isOptional": true
2999
- }
3000
- ],
3001
- "name": "loadLayout"
3002
- }
3003
- ],
3004
- "extendsTokenRanges": []
3005
- },
3006
2572
  {
3007
2573
  "kind": "Class",
3008
2574
  "canonicalReference": "@genesislcap/foundation-workspace!WorkspaceManager:class",