@genesislcap/foundation-workspace 15.72.0 → 15.73.0-FUI-2628.4

package/dist/custom-elements.json

@@ -64,7 +64,7 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "",
+          "description": "Default filter registry implementation.",
           "name": "DefaultFilterRegistry",
           "members": [
             {
@@ -76,6 +76,15 @@
               "privacy": "private",
               "default": "new Map()"
             },
+            {
+              "kind": "field",
+              "name": "stored",
+              "type": {
+                "text": "Map<string, SavedFilterValue>"
+              },
+              "privacy": "private",
+              "default": "new Map()"
+            },
             {
               "kind": "method",
               "name": "registerFilter",
@@ -147,6 +156,24 @@
                   }
                 }
               ]
+            },
+            {
+              "kind": "method",
+              "name": "readValue",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "SavedFilterValue"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "registration",
+                  "type": {
+                    "text": "FilterRegistration"
+                  }
+                }
+              ]
             }
           ]
         },
@@ -181,9 +208,36 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "",
+          "description": "Default grid registry implementation.",
           "name": "DefaultGridRegistry",
           "members": [
+            {
+              "kind": "field",
+              "name": "filterSettleMs",
+              "default": "1500",
+              "description": "Quiet period after the last start-up event before the filter guard ends.",
+              "type": {
+                "text": "number"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "filterGuardMaxMs",
+              "default": "10000",
+              "description": "Longest the filter guard runs after it is armed, however often it is re-armed.",
+              "type": {
+                "text": "number"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "maxFilterReapplies",
+              "default": "3",
+              "description": "Most re-applies the filter guard makes per arming.",
+              "type": {
+                "text": "number"
+              }
+            },
             {
               "kind": "field",
               "name": "grids",
@@ -195,13 +249,25 @@
             },
             {
               "kind": "field",
-              "name": "cachedSettings",
+              "name": "stored",
               "type": {
                 "text": "Map<string, SavedGridSettings>"
               },
               "privacy": "private",
               "default": "new Map()"
             },
+            {
+              "kind": "field",
+              "name": "listeners",
+              "privacy": "private",
+              "default": "new Map<GridRegistration, [string, GridEventListener][]>()"
+            },
+            {
+              "kind": "field",
+              "name": "guards",
+              "privacy": "private",
+              "default": "new Map<GridRegistration, FilterGuard>()"
+            },
             {
               "kind": "method",
               "name": "registerGrid",
@@ -228,9 +294,42 @@
                   "type": {
                     "text": "unknown"
                   }
+                },
+                {
+                  "name": "filterPersistence",
+                  "optional": true,
+                  "type": {
+                    "text": "GridFilterPersistence"
+                  }
                 }
               ]
             },
+            {
+              "kind": "method",
+              "name": "applyStoredSettings",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "registration",
+                  "type": {
+                    "text": "GridRegistration"
+                  }
+                },
+                {
+                  "name": "options",
+                  "optional": true,
+                  "type": {
+                    "text": "{ applyFilters?: boolean }"
+                  }
+                }
+              ],
+              "description": "Applies the stored settings for a grid, unless it already has exactly that state."
+            },
             {
               "kind": "method",
               "name": "getGrid",
@@ -312,12 +411,257 @@
                   "type": {
                     "text": "SavedGridSettings[]"
                   }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "applyFilterModel",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "registration",
+                  "type": {
+                    "text": "GridRegistration"
+                  }
                 },
                 {
-                  "name": "maxRetries",
-                  "default": "3",
+                  "name": "filterModel",
                   "type": {
-                    "text": "number"
+                    "text": "Record<string, unknown>"
+                  }
+                }
+              ],
+              "description": "Writes a filter model into the grid's own persistence, then onto the grid, and records what\nthe grid reports back so the guard can tell a later replacement from AG Grid's normalisation."
+            },
+            {
+              "kind": "method",
+              "name": "reapplyStoredFilter",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "registration",
+                  "type": {
+                    "text": "GridRegistration"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "filterWasReplaced",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "registration",
+                  "type": {
+                    "text": "GridRegistration"
+                  }
+                }
+              ],
+              "description": "Whether the grid's filter model moved away from what the registry last applied — a stale\nrestore or other programmatic change, rather than AG Grid normalising the applied model (which\nreads back the same each time)."
+            },
+            {
+              "kind": "method",
+              "name": "armFilterGuard",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "registration",
+                  "type": {
+                    "text": "GridRegistration"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "touchFilterGuard",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "registration",
+                  "type": {
+                    "text": "GridRegistration"
+                  }
+                }
+              ],
+              "description": "Restarts the settle timer: the grid just did something that can precede a stale restore."
+            },
+            {
+              "kind": "method",
+              "name": "guardActive",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "registration",
+                  "type": {
+                    "text": "GridRegistration"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "endFilterGuard",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "registration",
+                  "type": {
+                    "text": "GridRegistration"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "addListener",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "registration",
+                  "type": {
+                    "text": "GridRegistration"
+                  }
+                },
+                {
+                  "name": "type",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "listener",
+                  "type": {
+                    "text": "GridEventListener"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "removeListener",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "registration",
+                  "type": {
+                    "text": "GridRegistration"
+                  }
+                },
+                {
+                  "name": "type",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "listener",
+                  "type": {
+                    "text": "GridEventListener"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "detach",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "registration",
+                  "type": {
+                    "text": "GridRegistration"
+                  }
+                }
+              ],
+              "description": "Removes a registration's grid listeners and stops its filter guard."
+            },
+            {
+              "kind": "method",
+              "name": "hasSettings",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "grid",
+                  "type": {
+                    "text": "GridRegistration"
+                  }
+                },
+                {
+                  "name": "settings",
+                  "type": {
+                    "text": "SavedGridSettings"
+                  }
+                }
+              ],
+              "description": "Whether the grid already has exactly these settings, so re-applying them is a no-op."
+            },
+            {
+              "kind": "method",
+              "name": "readFilterModel",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "string"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "grid",
+                  "type": {
+                    "text": "GridRegistration"
                   }
                 }
               ]
@@ -457,7 +801,16 @@
               "kind": "field",
               "name": "layouts",
               "type": {
-                "text": "Map<string, FoundationLayout>"
+                "text": "Map<string, WorkspaceLayout>"
+              },
+              "privacy": "private",
+              "default": "new Map()"
+            },
+            {
+              "kind": "field",
+              "name": "stored",
+              "type": {
+                "text": "Map<string, SerialisedLayout>"
               },
               "privacy": "private",
               "default": "new Map()"
@@ -480,7 +833,7 @@
                 {
                   "name": "layout",
                   "type": {
-                    "text": "FoundationLayout"
+                    "text": "WorkspaceLayout"
                   }
                 }
               ]
@@ -527,6 +880,49 @@
                   }
                 }
               ]
+            },
+            {
+              "kind": "method",
+              "name": "readLayout",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "SerialisedLayout | null"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "layout",
+                  "type": {
+                    "text": "WorkspaceLayout"
+                  }
+                }
+              ],
+              "description": "A layout's config is only meaningful once it has finished its first load; before that it has\nno panes yet, and storing that would wipe the saved config."
+            },
+            {
+              "kind": "method",
+              "name": "whenFirstLoaded",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "layout",
+                  "type": {
+                    "text": "WorkspaceLayout"
+                  }
+                },
+                {
+                  "name": "callback",
+                  "type": {
+                    "text": "() => void"
+                  }
+                }
+              ]
             }
           ]
         },
@@ -1236,7 +1632,8 @@
                     "text": "SavedWorkspace"
                   }
                 }
-              ]
+              ],
+              "description": "Seeds every registry's store with the workspace's entries (replacing whatever was stored,\neven when a list is empty) and applies them to what's mounted; unmounted grids, layouts and\nfilters pick theirs up when they register. Grids and filters are seeded before layouts:\nloading a layout rebuilds its panes, and the grids/filters inside re-register straight away."
             },
             {
               "kind": "method",
@@ -1696,7 +2093,7 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "Registers an AG Grid instance so workspace state can apply/load it.",
+          "description": "Registers an AG Grid instance so workspace state can apply/load it. Registering applies the\ngrid's stored column state (from the loaded workspace, or its last state this session) — see\n`DefaultGridRegistry`.",
           "name": "GridRegister",
           "members": [
             {
@@ -1721,13 +2118,6 @@
                 "text": "GridRegistry"
               }
             },
-            {
-              "kind": "field",
-              "name": "workspaceState",
-              "type": {
-                "text": "WorkspaceState"
-              }
-            },
             {
               "kind": "field",
               "name": "gridElement",
@@ -1793,46 +2183,6 @@
                 }
               }
             },
-            {
-              "kind": "method",
-              "name": "loadWorkspaceSettings",
-              "privacy": "private",
-              "return": {
-                "type": {
-                  "text": "Promise<void>"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "options",
-                  "optional": true,
-                  "type": {
-                    "text": "{ applyColumns?: boolean }"
-                  }
-                }
-              ]
-            },
-            {
-              "kind": "method",
-              "name": "readColumnState",
-              "privacy": "private",
-              "return": {
-                "type": {
-                  "text": "ColumnState[]"
-                }
-              },
-              "description": "Column state comes from `gridApi` on AG Grid v36 and from `columnApi` on v29; mirrors the\nfallback `GridRegistry` uses when saving."
-            },
-            {
-              "kind": "method",
-              "name": "loadWorkspaceColumnState",
-              "privacy": "private",
-              "return": {
-                "type": {
-                  "text": "Promise<void>"
-                }
-              }
-            },
             {
               "kind": "field",
               "name": "_presentation",

package/dist/dts/workspace/filter-registry.d.ts

@@ -17,14 +17,26 @@ export interface FilterRegistration {
     setFilterValue: (value: string) => void;
 }
 /**
+ * Default filter registry implementation.
+ *
+ * @remarks
+ * 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.
  * @alpha
  */
 export declare class DefaultFilterRegistry implements FilterRegistry {
     private filters;
+    private stored;
     registerFilter(filterKey: string, getFilterValue: () => SavedFilterValue | null, setFilterValue: (value: string) => void): void;
     unregisterFilter(filterKey: string): void;
     getAllFiltersValues(): SavedFilterValue[];
     applyFiltersValues(filtersValues: SavedFilterValue[]): void;
+    private readValue;
 }
 /**
  * DI token for filter registry.

package/dist/dts/workspace/filter-registry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"filter-registry.d.ts","sourceRoot":"","sources":["../../../src/workspace/filter-registry.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,MAAM,gBAAgB,GAAG,IAAI,EAC7C,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,GACtC,IAAI,CAAC;IACR,mBAAmB,IAAI,gBAAgB,EAAE,CAAC;IAC1C,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,kBAAkB,CAAC,YAAY,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,gBAAgB,GAAG,IAAI,CAAC;IAC9C,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;CACzC;AAED;;GAEG;AACH,qBAAa,qBAAsB,YAAW,cAAc;IAC1D,OAAO,CAAC,OAAO,CAA8C;IAE7D,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,MAAM,gBAAgB,GAAG,IAAI,EAC7C,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,GACtC,IAAI;IAQP,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAIzC,mBAAmB,IAAI,gBAAgB,EAAE;IAYzC,kBAAkB,CAAC,aAAa,EAAE,gBAAgB,EAAE,GAAG,IAAI;CAU5D;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,sEAE1B,CAAC"}
+{"version":3,"file":"filter-registry.d.ts","sourceRoot":"","sources":["../../../src/workspace/filter-registry.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,MAAM,gBAAgB,GAAG,IAAI,EAC7C,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,GACtC,IAAI,CAAC;IACR,mBAAmB,IAAI,gBAAgB,EAAE,CAAC;IAC1C,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,kBAAkB,CAAC,YAAY,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,gBAAgB,GAAG,IAAI,CAAC;IAC9C,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;CACzC;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,qBAAsB,YAAW,cAAc;IAC1D,OAAO,CAAC,OAAO,CAA8C;IAC7D,OAAO,CAAC,MAAM,CAA4C;IAE1D,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,MAAM,gBAAgB,GAAG,IAAI,EAC7C,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,GACtC,IAAI;IAUP,gBAAgB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAQzC,mBAAmB,IAAI,gBAAgB,EAAE;IAOzC,kBAAkB,CAAC,aAAa,EAAE,gBAAgB,EAAE,GAAG,IAAI;IAO3D,OAAO,CAAC,SAAS;CAGlB;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,sEAE1B,CAAC"}

package/dist/dts/workspace/grid-register/grid-register.d.ts

@@ -1,15 +1,15 @@
 import { FoundationElement } from '@genesislcap/web-core';
 import { GridRegistry } from '../grid-registry';
-import { WorkspaceState } from '../workspace-state';
 /**
- * Registers an AG Grid instance so workspace state can apply/load it.
+ * 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`.
  * @alpha
  */
 export declare class GridRegister extends FoundationElement {
     gridKey: string;
     designSystemPrefix: string;
     gridRegistry: GridRegistry;
-    workspaceState: WorkspaceState;
     /** `<prefix>-grid-pro` is the AG Grid v36 `GridPro` by default; `GridProLegacy` is the v29 grid. */
     private gridElement;
     private gridApi;
@@ -21,12 +21,5 @@ export declare class GridRegister extends FoundationElement {
     private readonly handleGridReady;
     private attachToGridApis;
     private detachFromGridApis;
-    private loadWorkspaceSettings;
-    /**
-     * Column state comes from `gridApi` on AG Grid v36 and from `columnApi` on v29; mirrors the
-     * fallback `GridRegistry` uses when saving.
-     */
-    private readColumnState;
-    private loadWorkspaceColumnState;
 }
 //# sourceMappingURL=grid-register.d.ts.map

package/dist/dts/workspace/grid-register/grid-register.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"grid-register.d.ts","sourceRoot":"","sources":["../../../../src/workspace/grid-register/grid-register.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAuB,MAAM,uBAAuB,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAGpD;;;GAGG;AACH,qBAIa,YAAa,SAAQ,iBAAiB;IAChB,OAAO,EAAE,MAAM,CAAC;IACJ,kBAAkB,EAAE,MAAM,CAAW;IAEpE,YAAY,EAAE,YAAY,CAAC;IACzB,cAAc,EAAE,cAAc,CAAC;IAE/C,oGAAoG;IACpG,OAAO,CAAC,WAAW,CAAwC;IAC3D,OAAO,CAAC,OAAO,CAA8D;IAC7E,sFAAsF;IACtF,OAAO,CAAC,SAAS,CAA0B;IAE3C,iBAAiB,IAAI,IAAI;IAKzB,oBAAoB,IAAI,IAAI;IAS5B,OAAO,CAAC,mBAAmB;IAqB3B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAE9B;IAEF,OAAO,CAAC,gBAAgB;IA4BxB,OAAO,CAAC,kBAAkB;YAUZ,qBAAqB;IAmCnC;;;OAGG;IACH,OAAO,CAAC,eAAe;YAKT,wBAAwB;CAGvC"}
+{"version":3,"file":"grid-register.d.ts","sourceRoot":"","sources":["../../../../src/workspace/grid-register/grid-register.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAuB,MAAM,uBAAuB,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAGhD;;;;;GAKG;AACH,qBAIa,YAAa,SAAQ,iBAAiB;IAChB,OAAO,EAAE,MAAM,CAAC;IACJ,kBAAkB,EAAE,MAAM,CAAW;IAEpE,YAAY,EAAE,YAAY,CAAC;IAEzC,oGAAoG;IACpG,OAAO,CAAC,WAAW,CAAwC;IAC3D,OAAO,CAAC,OAAO,CAA8D;IAC7E,sFAAsF;IACtF,OAAO,CAAC,SAAS,CAA0B;IAE3C,iBAAiB,IAAI,IAAI;IAKzB,oBAAoB,IAAI,IAAI;IAS5B,OAAO,CAAC,mBAAmB;IAqB3B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAE9B;IAEF,OAAO,CAAC,gBAAgB;IA0BxB,OAAO,CAAC,kBAAkB;CAS3B"}