@redsift/ds-mcp-server 12.3.1-muiv6-alpha.2

package/data/docs/components/dashboard/DrilldownItem.json

@@ -0,0 +1,342 @@
+{
+  "name": "DrilldownItem",
+  "description": "DrilldownItem displays a numeric value with a legend label and an optional\nfilter icon. Designed for use inside DataCard.Listbox for filter-selection\ninteractions.\n\nWhen `onClick` is provided with `hasFilterIcon`, a filter icon is displayed\nto indicate the item can be used to drill down / filter data.",
+  "package": "@redsift/dashboard",
+  "filePath": "packages/dashboard/src/components/DrilldownItem/DrilldownItem.tsx",
+  "props": [
+    {
+      "name": "filterIcon",
+      "description": "Optional icon to display as the filter action indicator. When provided with onClick, shows a filter icon.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "hasFilterIcon",
+      "description": "Whether the filter action icon is visible. When true and onClick is provided, shows the filter icon.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "isCentered",
+      "description": "Whether the content is centered within the item.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "labelDecorator",
+      "description": "Optional transform function applied to the legend text before display.",
+      "type": "(label: string) => string",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "legend",
+      "description": "The label text displayed next to the number.",
+      "type": "string",
+      "required": true,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "size",
+      "description": "Size variant controlling font size, weight, and height.",
+      "type": [
+        "\"small\"",
+        "\"medium\"",
+        "\"large\""
+      ],
+      "required": false,
+      "defaultValue": "'medium'",
+      "category": "props"
+    },
+    {
+      "name": "value",
+      "description": "The numeric value to display.",
+      "type": "number",
+      "required": true,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "flex",
+      "description": "When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/flex\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "flexGrow",
+      "description": "When used in a flex layout, specifies how the element will grow to fit the space available. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/flex-grow\">MDN</a>.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "flexShrink",
+      "description": "When used in a flex layout, specifies how the element will shrink to fit the space available. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/flex-shrink\">MDN</a>.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "flexBasis",
+      "description": "When used in a flex layout, specifies the initial main size of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/flex_basis\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "alignSelf",
+      "description": "Overrides the alignItems property of a flex or grid container. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/align-self\">MDN</a>.",
+      "type": [
+        "\"center\"",
+        "\"auto\"",
+        "\"normal\"",
+        "\"start\"",
+        "\"end\"",
+        "\"flex-start\"",
+        "\"flex-end\"",
+        "\"self-start\"",
+        "\"self-end\"",
+        "\"baseline\"",
+        "\"stretch\""
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "justifySelf",
+      "description": "Specifies how the element is justified inside a flex or grid container. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/justify-self\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "order",
+      "description": "The layout order for the element within a flex or grid container. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/order\">MDN</a>.",
+      "type": "number",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridArea",
+      "description": "When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-area\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridColumn",
+      "description": "When used in a grid layout, specifies the column the element should be placed in within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridRow",
+      "description": "When used in a grid layout, specifies the row the element should be placed in within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridColumnStart",
+      "description": "When used in a grid layout, specifies the starting column to span within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column-start\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridColumnEnd",
+      "description": "When used in a grid layout, specifies the ending column to span within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-column-end\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridRowStart",
+      "description": "When used in a grid layout, specifies the starting row to span within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row-start\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "gridRowEnd",
+      "description": "When used in a grid layout, specifies the ending row to span within the grid. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/grid-row-end\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "layout"
+    },
+    {
+      "name": "margin",
+      "description": "The margin for all four sides of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/margin\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "marginBottom",
+      "description": "The margin for the bottom side of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/margin-bottom\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "marginLeft",
+      "description": "The margin for the left side of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/margin-left\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "marginRight",
+      "description": "The margin for the right side of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/margin-right\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "marginTop",
+      "description": "The margin for the top side of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/margin-top\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "spacing"
+    },
+    {
+      "name": "height",
+      "description": "The height of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/height\">MDN</a>.",
+      "type": [
+        "string",
+        "number"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "sizing"
+    },
+    {
+      "name": "maxHeight",
+      "description": "The maximum height of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/max-height\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "sizing"
+    },
+    {
+      "name": "maxWidth",
+      "description": "The maximum width of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/max-width\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "sizing"
+    },
+    {
+      "name": "minHeight",
+      "description": "The minimum height of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/min-height\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "sizing"
+    },
+    {
+      "name": "minWidth",
+      "description": "The minimum width of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/min-width\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "sizing"
+    },
+    {
+      "name": "width",
+      "description": "The width of the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/width\">MDN</a>.",
+      "type": [
+        "string",
+        "number"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "sizing"
+    },
+    {
+      "name": "position",
+      "description": "Specifies how the element is positioned. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/position\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "positioning"
+    },
+    {
+      "name": "top",
+      "description": "The top position for the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/top\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "positioning"
+    },
+    {
+      "name": "bottom",
+      "description": "The bottom position for the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/bottom\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "positioning"
+    },
+    {
+      "name": "left",
+      "description": "The left position for the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/left\">MDN</a>. Consider using start instead for RTL support.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "positioning"
+    },
+    {
+      "name": "right",
+      "description": "The right position for the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/right\">MDN</a>. Consider using start instead for RTL support.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "positioning"
+    },
+    {
+      "name": "zIndex",
+      "description": "The stacking order for the element. See <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/z-index\">MDN</a>.",
+      "type": "string",
+      "required": false,
+      "defaultValue": null,
+      "category": "positioning"
+    }
+  ],
+  "examples": [],
+  "tags": {}
+}

package/data/docs/components/dashboard/FilterableBarChart.json

@@ -0,0 +1,83 @@
+{
+  "name": "FilterableBarChart",
+  "description": "",
+  "package": "@redsift/dashboard",
+  "filePath": "packages/dashboard/src/components/WithFilters/FilterableBarChart.tsx",
+  "props": [
+    {
+      "name": "dimension",
+      "description": "Method that will be used by crossfilter to compute the dimensions of the charts.",
+      "type": "DimensionSelector",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "datagridCategoryDimFilter",
+      "description": "In case of a chart based on one dimension (category), which datagrid column the chart is filtering and using which operator.",
+      "type": "CategoryFilterType",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "datagridCoordinatesCategoryDimFilter",
+      "description": "In case of a chart based on two dimension coordinates (x, y), which datagrid columns the chart is filtering.",
+      "type": [
+        "[CoordinateFilterType, CoordinateFilterType]",
+        "[CoordinateFilterType, CoordinateFilterType, CategoryFilterType]"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "group",
+      "description": "Method that will be used by crossfilter to compute the groups of the charts.",
+      "type": "(d: Dimension) => Group",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "isDimensionArray",
+      "description": "Whether the dimension field is an array or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "isResetable",
+      "description": "Whether the reset button is hidden or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "localeText",
+      "description": "Overriden values for internal labels and texts.",
+      "type": "LocaleText",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "onFilter",
+      "description": "Method to call when a filter occured on the chart.",
+      "type": "(filters?: any) => void",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    }
+  ],
+  "examples": [],
+  "tags": {}
+}

package/data/docs/components/dashboard/FilterableDataGrid.json

@@ -0,0 +1,83 @@
+{
+  "name": "FilterableDataGrid",
+  "description": "",
+  "package": "@redsift/dashboard",
+  "filePath": "packages/dashboard/src/components/WithFilters/FilterableDataGrid.tsx",
+  "props": [
+    {
+      "name": "datagridCategoryDimFilter",
+      "description": "In case of a chart based on one dimension (category), which datagrid column the chart is filtering and using which operator.",
+      "type": "CategoryFilterType",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "datagridCoordinatesCategoryDimFilter",
+      "description": "In case of a chart based on two dimension coordinates (x, y), which datagrid columns the chart is filtering.",
+      "type": [
+        "[CoordinateFilterType, CoordinateFilterType]",
+        "[CoordinateFilterType, CoordinateFilterType, CategoryFilterType]"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "dimension",
+      "description": "Method that will be used by crossfilter to compute the dimensions of the charts.",
+      "type": "DimensionSelector",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "group",
+      "description": "Method that will be used by crossfilter to compute the groups of the charts.",
+      "type": "(d: Dimension) => Group",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "isDimensionArray",
+      "description": "Whether the dimension field is an array or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "isResetable",
+      "description": "Whether the reset button is hidden or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "localeText",
+      "description": "Overriden values for internal labels and texts.",
+      "type": "LocaleText",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "onFilter",
+      "description": "Method to call when a filter occured on the chart.",
+      "type": "(filters?: any) => void",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    }
+  ],
+  "examples": [],
+  "tags": {}
+}

package/data/docs/components/dashboard/FilterablePieChart.json

@@ -0,0 +1,83 @@
+{
+  "name": "FilterablePieChart",
+  "description": "",
+  "package": "@redsift/dashboard",
+  "filePath": "packages/dashboard/src/components/WithFilters/FilterablePieChart.tsx",
+  "props": [
+    {
+      "name": "dimension",
+      "description": "Method that will be used by crossfilter to compute the dimensions of the charts.",
+      "type": "DimensionSelector",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "datagridCategoryDimFilter",
+      "description": "In case of a chart based on one dimension (category), which datagrid column the chart is filtering and using which operator.",
+      "type": "CategoryFilterType",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "datagridCoordinatesCategoryDimFilter",
+      "description": "In case of a chart based on two dimension coordinates (x, y), which datagrid columns the chart is filtering.",
+      "type": [
+        "[CoordinateFilterType, CoordinateFilterType]",
+        "[CoordinateFilterType, CoordinateFilterType, CategoryFilterType]"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "group",
+      "description": "Method that will be used by crossfilter to compute the groups of the charts.",
+      "type": "(d: Dimension) => Group",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "isDimensionArray",
+      "description": "Whether the dimension field is an array or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "isResetable",
+      "description": "Whether the reset button is hidden or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "localeText",
+      "description": "Overriden values for internal labels and texts.",
+      "type": "LocaleText",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "onFilter",
+      "description": "Method to call when a filter occured on the chart.",
+      "type": "(filters?: any) => void",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    }
+  ],
+  "examples": [],
+  "tags": {}
+}

package/data/docs/components/dashboard/FilterableScatterPlot.json

@@ -0,0 +1,83 @@
+{
+  "name": "FilterableScatterPlot",
+  "description": "",
+  "package": "@redsift/dashboard",
+  "filePath": "packages/dashboard/src/components/WithFilters/FilterableScatterPlot.tsx",
+  "props": [
+    {
+      "name": "dimension",
+      "description": "Method that will be used by crossfilter to compute the dimensions of the charts.",
+      "type": "DimensionSelector",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "datagridCategoryDimFilter",
+      "description": "In case of a chart based on one dimension (category), which datagrid column the chart is filtering and using which operator.",
+      "type": "CategoryFilterType",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "datagridCoordinatesCategoryDimFilter",
+      "description": "In case of a chart based on two dimension coordinates (x, y), which datagrid columns the chart is filtering.",
+      "type": [
+        "[CoordinateFilterType, CoordinateFilterType]",
+        "[CoordinateFilterType, CoordinateFilterType, CategoryFilterType]"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "group",
+      "description": "Method that will be used by crossfilter to compute the groups of the charts.",
+      "type": "(d: Dimension) => Group",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "isDimensionArray",
+      "description": "Whether the dimension field is an array or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "isResetable",
+      "description": "Whether the reset button is hidden or not.",
+      "type": [
+        "false",
+        "true"
+      ],
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "localeText",
+      "description": "Overriden values for internal labels and texts.",
+      "type": "LocaleText",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    },
+    {
+      "name": "onFilter",
+      "description": "Method to call when a filter occured on the chart.",
+      "type": "(filters?: any) => void",
+      "required": false,
+      "defaultValue": null,
+      "category": "props"
+    }
+  ],
+  "examples": [],
+  "tags": {}
+}