@redsift/ds-mcp-server 12.5.13-muiv6 → 12.5.13

package/data/docs/components/table-pro/GridToolbarFilterSemanticField.json

@@ -0,0 +1,69 @@
+{
+  "name": "GridToolbarFilterSemanticField",
+  "description": "The GridToolbarFilterSemanticField component.",
+  "package": "@redsift/table-pro",
+  "filePath": "packages/table-pro/src/components/GridToolbarFilterSemanticField/GridToolbarFilterSemanticField.tsx",
+  "props": [
+    {
+      "name": "nlpFilterConfig",
+      "description": "",
+      "type": "FilterConfig",
+      "required": true,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "onFilterModelChange",
+      "description": "",
+      "type": "(filterModel: GridFilterModel) => void",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "dateFormat",
+      "description": "",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "defaultModel",
+      "description": "",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "defaultFilter",
+      "description": "",
+      "type": "CompletionResponse",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "disablePower",
+      "description": "",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "localeText",
+      "description": "",
+      "type": "LocaleText",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    }
+  ],
+  "examples": [],
+  "tags": {}
+}

package/data/docs/components/table-pro/ServerSideControlledPagination.json

@@ -0,0 +1,9 @@
+{
+  "name": "ServerSideControlledPagination",
+  "description": "",
+  "package": "@redsift/table-pro",
+  "filePath": "packages/table-pro/src/components/Pagination/ServerSideControlledPagination.tsx",
+  "props": [],
+  "examples": [],
+  "tags": {}
+}

package/data/docs/components/table-pro/StatefulDataGrid.json

@@ -0,0 +1,135 @@
+{
+  "name": "StatefulDataGrid",
+  "description": "StatefulDataGrid extends DataGrid with automatic state persistence to localStorage.\nPreserves filters, sorting, pagination, column visibility, and column widths\nacross page refreshes.\n\nUse when users need persistent table preferences. Requires unique `localStorageKey`.",
+  "package": "@redsift/table-pro",
+  "filePath": "packages/table-pro/src/components/StatefulDataGrid/StatefulDataGrid.tsx",
+  "props": [
+    {
+      "name": "useRouter",
+      "description": "Hook returning pathname, search params and a method to update query params.",
+      "type": "() => { pathname: string; search: string; historyReplace: (newSearch: string, options?: { authoritative?: boolean | undefined; } | undefined) => void; }",
+      "required": true,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "localStorageVersion",
+      "description": "Local Storage version, to upgrade when we want to force a clean out.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "previousLocalStorageVersions",
+      "description": "Previous Local Storage versions to clean out when a new one is released.",
+      "type": "number[]",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "license",
+      "description": "License key for MUI Datagrid Pro.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "height",
+      "description": "Height. A default one is set to prevent rendering all rows.",
+      "type": "string",
+      "required": false,
+      "defaultValue": "'500px'",
+      "category": "props"
+    },
+    {
+      "name": "toolbar",
+      "description": "Toolbar. A default one is provided but every button from this default Toolbar can be customized and the entire Toolbar can be replaced.",
+      "type": "ReactNode",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "hideToolbar",
+      "description": "Whether the Toolbar is displayed or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "paginationPlacement",
+      "description": "Indicates where to render the pagination controls (the \"Rows per page\" + page\nnavigation bar). Independent of `selectionBannerPlacement`.\n\n- `'top'` / `'bottom'` / `'both'` — above / below / both sides of the grid body.\n- `'none'` — no pager controls.\n- `'belowToolbar'` — in a row directly below the toolbar (right-aligned). Pair\n  with `selectionBannerPlacement=\"belowToolbar\"` to get the banner on the left\n  and the pager on the right in the same row. Only applies when `pagination` is enabled.",
+      "type": [
+        "\"top\"",
+        "\"bottom\"",
+        "\"both\"",
+        "\"none\"",
+        "\"belowToolbar\""
+      ],
+      "required": false,
+      "defaultValue": "'both'",
+      "category": "props"
+    },
+    {
+      "name": "selectionBannerPlacement",
+      "description": "Where to render the row-selection banner (the \"All N rows on this page are\nselected…\" line). Independent of `paginationPlacement` — the latter only\ncontrols the pager controls.\n\n- `'top'` — above the toolbar (default, current behaviour).\n- `'bottom'` — in the footer, alongside the bottom pager.\n- `'belowToolbar'` — between the toolbar and the grid body. Rendered via\n  the toolbar slot, so the toolbar slot is forced to render even when\n  `hideToolbar` is set (the toolbar itself stays hidden, only the banner shows).\n  Combine with `paginationPlacement=\"belowToolbar\"` for a banner-left / pager-right\n  row. Only applies when `pagination` is enabled.",
+      "type": [
+        "\"top\"",
+        "\"bottom\"",
+        "\"belowToolbar\""
+      ],
+      "required": false,
+      "defaultValue": "'top'",
+      "category": "props"
+    },
+    {
+      "name": "paginationProps",
+      "description": "Props to forward to the pagination component.",
+      "type": "Omit<TablePaginationProps, \"paginationMode\" | \"component\" | \"count\" | \"onPageChange\" | \"onRowsPerPageChange\" | \"page\" | \"rowsPerPage\" | \"rowsPerPageOptions\">",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "theme",
+      "description": "Theme.",
+      "type": [
+        "\"light\"",
+        "\"dark\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "getTreeDataPath",
+      "description": "Determines the path of a row in the tree data.\nFor instance, a row with the path [\"A\", \"B\"] is the child of the row with the path [\"A\"].\nNote that all paths must contain at least one element.\n@template R\n@param row The row from which we want the path.\n@returns The path to the row.",
+      "type": "(row: any) => readonly string[]",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "setTreeDataPath",
+      "description": "Updates the tree path in a row model.\nUsed when reordering rows across different parents in tree data.\n@template R\n@param path The new path for the row.\n@param row The row model to update.\n@returns The updated row model with the new path.",
+      "type": "(path: string[], row: any) => any",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    }
+  ],
+  "examples": [],
+  "tags": {},
+  "keywords": [
+    "stateful table",
+    "managed grid",
+    "server grid"
+  ]
+}

package/data/docs/components/table-pro/TextCell.json

@@ -0,0 +1,118 @@
+{
+  "name": "TextCell",
+  "description": "The Cell component.",
+  "package": "@redsift/table-pro",
+  "filePath": "packages/table-pro/src/components/TextCell/TextCell.tsx",
+  "props": [
+    {
+      "name": "badge",
+      "description": "Including Badge Component.",
+      "type": "ReactNode",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "leftIcon",
+      "description": "Can be a string or an array of strings containing `d` property of the `path` SVG element.<br />\nCan also be a ReactElement.",
+      "type": [
+        "string",
+        "string[]",
+        "ReactElement<any, string | JSXElementConstructor<any>>"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "leftIconColor",
+      "description": "Left Icon Color variant.",
+      "type": [
+        "\"primary\"",
+        "\"secondary\"",
+        "\"error\"",
+        "\"success\"",
+        "\"warning\"",
+        "\"info\"",
+        "\"question\"",
+        "\"no-data\"",
+        "\"asm\"",
+        "\"brand-trust\"",
+        "\"certificates\"",
+        "\"ondmarc\"",
+        "\"pulse\"",
+        "\"radar\"",
+        "\"rojo-ds\"",
+        "\"vendor-secure\"",
+        "\"website\"",
+        "string & {}"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "rightIcon",
+      "description": "Can be a string or an array of strings containing `d` property of the `path` SVG element.<br />\nCan also be a ReactElement.",
+      "type": [
+        "string",
+        "string[]",
+        "ReactElement<any, string | JSXElementConstructor<any>>"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "rightIconColor",
+      "description": "Right Icon Color variant.",
+      "type": [
+        "\"primary\"",
+        "\"secondary\"",
+        "\"error\"",
+        "\"success\"",
+        "\"warning\"",
+        "\"info\"",
+        "\"question\"",
+        "\"no-data\"",
+        "\"asm\"",
+        "\"brand-trust\"",
+        "\"certificates\"",
+        "\"ondmarc\"",
+        "\"pulse\"",
+        "\"radar\"",
+        "\"rojo-ds\"",
+        "\"vendor-secure\"",
+        "\"website\"",
+        "string & {}"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "shieldVariant",
+      "description": "Shield variant.",
+      "type": [
+        "\"success\"",
+        "\"warning\"",
+        "\"question\"",
+        "\"successLocked\"",
+        "\"successUnlocked\"",
+        "\"fail\"",
+        "\"failLocked\"",
+        "\"failUnlocked\"",
+        "\"warningLocked\"",
+        "\"warningUnlocked\"",
+        "\"ignored\"",
+        "\"noData\"",
+        "\"email\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    }
+  ],
+  "examples": [],
+  "tags": {}
+}

package/data/docs/components/table-pro/Toolbar.json

@@ -0,0 +1,151 @@
+{
+  "name": "Toolbar",
+  "description": "------",
+  "package": "@redsift/table-pro",
+  "filePath": "packages/table-pro/src/components/Toolbar/Toolbar.tsx",
+  "props": [
+    {
+      "name": "columnsButtonProps",
+      "description": "Props to forward to the column button.",
+      "type": [
+        "GridToolbarColumnsButtonProps",
+        "GridToolbarColumnsButtonProps & RefAttributes<HTMLButtonElement>"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "columnsButtonRef",
+      "description": "Column button ref.",
+      "type": "RefObject<HTMLButtonElement>",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "densityButtonProps",
+      "description": "Props to forward to the density button.",
+      "type": [
+        "GridToolbarDensitySelectorProps",
+        "GridToolbarDensitySelectorProps & RefAttributes<HTMLButtonElement>"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "densityButtonRef",
+      "description": "Density button ref.",
+      "type": "RefObject<HTMLButtonElement>",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "exportButtonProps",
+      "description": "Props to forward to the export button.",
+      "type": "GridToolbarExportProps",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "exportButtonRef",
+      "description": "Export button ref.",
+      "type": "RefObject<HTMLButtonElement>",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "filterButtonProps",
+      "description": "Props to forward to the filter button.",
+      "type": "GridToolbarFilterButtonProps",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "filterButtonRef",
+      "description": "Filter button ref.",
+      "type": "RefObject<HTMLButtonElement>",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "hasColumnsButton",
+      "description": "Whether the columns button is displayed or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "hasDensityButton",
+      "description": "Whether the density button is displayed or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "hasExportButton",
+      "description": "Whether the export button is displayed or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "hasFilterButton",
+      "description": "Whether the filter button is displayed or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "onFilterModelChange",
+      "description": "Configuration object for NLP filter. undefined if disabled.",
+      "type": "(filterModel: GridFilterModel) => void",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "semanticFilterProps",
+      "description": "",
+      "type": "GridToolbarFilterSemanticProps",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "showQuickFilter",
+      "description": "Whether you want to show the quick filter or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    }
+  ],
+  "examples": [],
+  "tags": {}
+}

package/data/docs/components/table-pro/ToolbarWrapper.json

@@ -0,0 +1,9 @@
+{
+  "name": "ToolbarWrapper",
+  "description": "Renders a toolbar followed by a row that can contain the selection banner (left)\nand/or the pager controls (right), so they sit between the toolbar and the grid body\n(`selectionBannerPlacement=\"belowToolbar\"` and/or `paginationPlacement=\"belowToolbar\"`).\nThe banner/pager visibility is driven by `displaySelection` / `displayPagination`.\nThe row gets a top margin matching the banner's built-in bottom margin so the spacing\nabove and below it is symmetric.",
+  "package": "@redsift/table-pro",
+  "filePath": "packages/table-pro/src/components/ToolbarWrapper/ToolbarWrapper.tsx",
+  "props": [],
+  "examples": [],
+  "tags": {}
+}

package/data/docs/components-index.json

@@ -1115,6 +1115,75 @@
     "propsCount": 0,
     "hasExamples": false
   },
+  {
+    "name": "DataGrid",
+    "package": "@redsift/table-pro",
+    "description": "DataGrid displays tabular data with sorting, filtering, pagination, and row selection.",
+    "propsCount": 10,
+    "hasExamples": false,
+    "keywords": [
+      "data grid",
+      "data table",
+      "table",
+      "grid view",
+      "list view",
+      "spreadsheet"
+    ]
+  },
+  {
+    "name": "GridToolbarFilterSemanticField",
+    "package": "@redsift/table-pro",
+    "description": "The GridToolbarFilterSemanticField component.",
+    "propsCount": 7,
+    "hasExamples": false
+  },
+  {
+    "name": "ControlledPagination",
+    "package": "@redsift/table-pro",
+    "description": "",
+    "propsCount": 0,
+    "hasExamples": false
+  },
+  {
+    "name": "ServerSideControlledPagination",
+    "package": "@redsift/table-pro",
+    "description": "",
+    "propsCount": 0,
+    "hasExamples": false
+  },
+  {
+    "name": "StatefulDataGrid",
+    "package": "@redsift/table-pro",
+    "description": "StatefulDataGrid extends DataGrid with automatic state persistence to localStorage.",
+    "propsCount": 13,
+    "hasExamples": false,
+    "keywords": [
+      "stateful table",
+      "managed grid",
+      "server grid"
+    ]
+  },
+  {
+    "name": "TextCell",
+    "package": "@redsift/table-pro",
+    "description": "The Cell component.",
+    "propsCount": 6,
+    "hasExamples": false
+  },
+  {
+    "name": "Toolbar",
+    "package": "@redsift/table-pro",
+    "description": "------",
+    "propsCount": 15,
+    "hasExamples": false
+  },
+  {
+    "name": "ToolbarWrapper",
+    "package": "@redsift/table-pro",
+    "description": "Renders a toolbar followed by a row that can contain the selection banner (left)",
+    "propsCount": 0,
+    "hasExamples": false
+  },
   {
     "name": "ChartEmptyState",
     "package": "@redsift/dashboard",