@genesislcap/grid-pro 15.21.1 → 15.22.1

package/dist/custom-elements.json

@@ -3385,6 +3385,14 @@
             "package": "./column"
           }
         },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./column-filters"
+          }
+        },
         {
           "kind": "js",
           "name": "*",
@@ -8113,6 +8121,792 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/column-filters/enum-column.filter.ts",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "createEnumValueLabelFormatter",
+          "return": {
+            "type": {
+              "text": "(value: string | null) => string"
+            }
+          },
+          "parameters": [
+            {
+              "name": "params",
+              "type": {
+                "text": "| (Pick<EnumColumnFilterParams, 'valueFormatter'> &\n        Partial<\n          Pick<EnumColumnFilterValueFormatterParams, 'api' | 'colDef' | 'column' | 'context'>\n        >)\n    | undefined"
+              }
+            }
+          ],
+          "description": "Builds the value-to-label formatter for an enum filter, honouring `valueFormatter` from the\nfilter params and labelling `null` (blanks) consistently.",
+          "privacy": "public"
+        },
+        {
+          "kind": "function",
+          "name": "formatEnumFilterModelAsString",
+          "return": {
+            "type": {
+              "text": "string"
+            }
+          },
+          "parameters": [
+            {
+              "name": "model",
+              "type": {
+                "text": "EnumColumnFilterModel | null"
+              }
+            },
+            {
+              "name": "formatLabel",
+              "type": {
+                "text": "(value: string | null) => string"
+              }
+            }
+          ],
+          "description": "Renders an enum filter model as a short summary, e.g. `(2) Active, Pending`.",
+          "privacy": "public"
+        },
+        {
+          "kind": "class",
+          "description": "An Excel AutoFilter-inspired set filter for enum columns, built on AG Grid Community only.",
+          "name": "EnumColumnFilter",
+          "members": [
+            {
+              "kind": "field",
+              "name": "params",
+              "type": {
+                "text": "IFilterParams & EnumColumnFilterParams"
+              },
+              "privacy": "protected"
+            },
+            {
+              "kind": "field",
+              "name": "eGui",
+              "type": {
+                "text": "HTMLElement"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "eRoot",
+              "type": {
+                "text": "ShadowRoot"
+              },
+              "privacy": "private",
+              "description": "The GUI's shadow root — hosts the content and the shared FAST stylesheet."
+            },
+            {
+              "kind": "field",
+              "name": "eSearch",
+              "type": {
+                "text": "HTMLInputElement"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "eSelectAll",
+              "type": {
+                "text": "HTMLInputElement"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "eList",
+              "type": {
+                "text": "HTMLElement"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "itemInputs",
+              "privacy": "private",
+              "default": "new Map<string | null, HTMLInputElement>()",
+              "description": "Rendered value checkboxes keyed by value; `null` keys the blanks entry."
+            },
+            {
+              "kind": "field",
+              "name": "allValues",
+              "type": {
+                "text": "string[]"
+              },
+              "privacy": "private",
+              "default": "[]",
+              "description": "All selectable values, in the order the metadata/getter provided them."
+            },
+            {
+              "kind": "field",
+              "name": "includeBlanks",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "true",
+              "description": "Whether the `(Blanks)` entry is offered — on unless `filterParams.blanks` is `false`."
+            },
+            {
+              "kind": "field",
+              "name": "valuesRequestId",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "private",
+              "default": "0",
+              "description": "Guards async values resolution against out-of-date responses and use after destroy."
+            },
+            {
+              "kind": "field",
+              "name": "loading",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "ownsHeaderTooltip",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false",
+              "description": "Whether this instance installed the header tooltip getter (so destroy removes only its own)."
+            },
+            {
+              "kind": "field",
+              "name": "formatLabel",
+              "type": {
+                "text": "(value: string | null) => string"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "model",
+              "type": {
+                "text": "(string | null)[] | null"
+              },
+              "privacy": "private",
+              "default": "null",
+              "description": "`null` while inactive (everything passes); otherwise the selected values, with `null`\nstanding for blanks. May contain values absent from `allValues` (e.g. a restored model\nreferencing rows not loaded yet) — those are preserved and rendered as extra list entries\nso restoring a persisted model never silently narrows it, while still letting the user\ndeselect them."
+            },
+            {
+              "kind": "field",
+              "name": "searchTerm",
+              "type": {
+                "text": "string"
+              },
+              "privacy": "private",
+              "default": "''"
+            },
+            {
+              "kind": "method",
+              "name": "init",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "params",
+                  "type": {
+                    "text": "IFilterParams & EnumColumnFilterParams"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "getGui",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "HTMLElement"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "isFilterActive",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "doesFilterPass",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "params",
+                  "type": {
+                    "text": "IDoesFilterPassParams"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "getModel",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "EnumColumnFilterModel | null"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "setModel",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "model",
+                  "type": {
+                    "text": "EnumColumnFilterModel | null"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "getModelAsString",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "string"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "model",
+                  "type": {
+                    "text": "EnumColumnFilterModel | null"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "clear",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Clears the filter back to inactive and notifies the grid; used by the floating filter."
+            },
+            {
+              "kind": "method",
+              "name": "installHeaderTooltip",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Surfaces the active selection in the column's header tooltip (alongside AG's native header\nfilter icon), so the filter state is inspectable from the header without the layout-changing\nfloating filter row. Installed as a `headerTooltipValueGetter`, which AG evaluates lazily on\nhover — no header refresh needed when the model changes. While inactive it returns\n`undefined`, which falls back to the consumer's own `headerTooltip`; when active, that\ntooltip is kept as the prefix. A consumer-provided getter is left untouched."
+            },
+            {
+              "kind": "method",
+              "name": "afterGuiAttached",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "params",
+                  "optional": true,
+                  "type": {
+                    "text": "{ suppressFocus?: boolean }"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "refresh",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "params",
+                  "type": {
+                    "text": "IFilterParams & EnumColumnFilterParams"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "destroy",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "resolveState",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Resolves the option list (values array or getter) and re-renders."
+            },
+            {
+              "kind": "method",
+              "name": "loadAsyncValues",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "getValues",
+                  "type": {
+                    "text": "EnumColumnFilterValuesGetter"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "getCellValue",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "unknown"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "node",
+                  "type": {
+                    "text": "any"
+                  }
+                }
+              ],
+              "description": "The raw field read covers params without `getValue` (e.g. stripped-down test params)."
+            },
+            {
+              "kind": "method",
+              "name": "extraModelValues",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "string[]"
+                }
+              },
+              "description": "Model values that are not in the option list, e.g. from a restored persisted model."
+            },
+            {
+              "kind": "method",
+              "name": "allKeys",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "(string | null)[]"
+                }
+              },
+              "description": "All offered entry keys: the option list, then any off-list model values (rendered so they can\nbe deselected rather than being stuck in the model forever), then `null` (blanks) last like\nExcel. The blanks entry is also offered whenever the model references it, so a restored\nblanks selection stays visible and removable even before blank rows are detected."
+            },
+            {
+              "kind": "method",
+              "name": "isSelected",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "key",
+                  "type": {
+                    "text": "string | null"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "visibleKeys",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "(string | null)[]"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "updateSelection",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "selected",
+                  "type": {
+                    "text": "Set<string | null>"
+                  }
+                }
+              ],
+              "description": "Applies a new selection. Collapses back to the inactive (`null`) model when every offered\nentry is selected, so a fully re-selected filter reports inactive exactly like the\nenterprise set filter. Selected values beyond the offered keys don't restrict anything an\ninactive filter would pass, so a superset selection collapses too."
+            },
+            {
+              "kind": "method",
+              "name": "currentSelection",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "Set<string | null>"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "toggleValue",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "key",
+                  "type": {
+                    "text": "string | null"
+                  }
+                },
+                {
+                  "name": "checked",
+                  "type": {
+                    "text": "boolean"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "toggleAllVisible",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "checked",
+                  "type": {
+                    "text": "boolean"
+                  }
+                }
+              ],
+              "description": "Select-all acts on the searched subset only, mirroring Excel's AutoFilter."
+            },
+            {
+              "kind": "method",
+              "name": "createGui",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "createItem",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "{ label: HTMLLabelElement; input: HTMLInputElement }"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "text",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "renderList",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Rebuilds the value list; used when the values or the search term change."
+            },
+            {
+              "kind": "method",
+              "name": "syncCheckedStates",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Refreshes checkbox states in place, preserving DOM (and keyboard focus) on toggles."
+            },
+            {
+              "kind": "method",
+              "name": "focusables",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "HTMLElement[]"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "handleKeyDown",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "event",
+                  "type": {
+                    "text": "KeyboardEvent"
+                  }
+                }
+              ],
+              "description": "Arrow keys walk search box, \"(Select All)\" and the visible entries; Enter toggles the\nfocused entry (Space is the checkbox's native toggle). Tab wraps within the popup: AG's own\npopup focus trap collects focusable elements with `querySelectorAll`, which does not pierce\nthe shadow root, so the trap must live here."
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "createEnumValueLabelFormatter",
+          "declaration": {
+            "name": "createEnumValueLabelFormatter",
+            "module": "src/column-filters/enum-column.filter.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "formatEnumFilterModelAsString",
+          "declaration": {
+            "name": "formatEnumFilterModelAsString",
+            "module": "src/column-filters/enum-column.filter.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "EnumColumnFilter",
+          "declaration": {
+            "name": "EnumColumnFilter",
+            "module": "src/column-filters/enum-column.filter.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/column-filters/enum-column.floating-filter.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Floating filter companion for EnumColumnFilter: shows the current selection as a\ncompact summary (e.g. `(2) Active, Pending`), opens the parent filter on click, and offers a\none-click clear. Set via `ColDef.floatingFilterComponent` (see\nGridProFilterTypes.enumFloatingFilter); shown when the column enables `floatingFilter`.",
+          "name": "EnumColumnFloatingFilter",
+          "members": [
+            {
+              "kind": "field",
+              "name": "params",
+              "type": {
+                "text": "IFloatingFilterParams"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "eGui",
+              "type": {
+                "text": "HTMLElement"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "eRoot",
+              "type": {
+                "text": "ShadowRoot"
+              },
+              "privacy": "private",
+              "description": "The GUI's shadow root — hosts the content and the shared FAST stylesheet."
+            },
+            {
+              "kind": "field",
+              "name": "eSummary",
+              "type": {
+                "text": "HTMLElement"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "eClear",
+              "type": {
+                "text": "HTMLButtonElement"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "formatLabel",
+              "type": {
+                "text": "(value: string | null) => string"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "init",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "params",
+                  "type": {
+                    "text": "IFloatingFilterParams"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "getGui",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "HTMLElement"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "onParentModelChanged",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "model",
+                  "type": {
+                    "text": "EnumColumnFilterModel | null"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "destroy",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "EnumColumnFloatingFilter",
+          "declaration": {
+            "name": "EnumColumnFloatingFilter",
+            "module": "src/column-filters/enum-column.floating-filter.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/column-filters/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./enum-column.filter"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./enum-column.floating-filter"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/datasource/base.datasource.ts",