@commercetools/nimbus-mcp 0.1.0 → 2.11.0

package/data/docs/types/toast.json

@@ -0,0 +1,234 @@
+{
+  "tags": {
+    "example": "```tsx\n// Create toast\nconst id = toast({ title: \"Success\", description: \"Operation completed\", type: \"success\" });\n\n// Convenience methods\ntoast.info({ title: \"Information\", description: \"Something happened\" });\ntoast.success({ title: \"Success\", description: \"Operation completed\" });\ntoast.warning({ title: \"Warning\", description: \"Please review\" });\ntoast.error({ title: \"Error\", description: \"Something went wrong\" });\n\n// With variant (default is \"solid\")\ntoast.info({ title: \"Subtle info\", description: \"Additional context\", variant: \"subtle\" });\ntoast.success({ title: \"Bold success\", description: \"Changes saved\", variant: \"solid\" });\n\n// With close button (off by default)\ntoast.info({ title: \"Closable\", description: \"Can be dismissed\", closable: true });\n\n// With action button\ntoast({\n  title: \"Action required\",\n  description: \"File was deleted\",\n  action: { label: \"Undo\", onPress: () => {} }\n});\n\n// Promise pattern\ntoast.promise(fetchData(), {\n  loading: { title: \"Loading...\", description: \"Please wait\" },\n  success: { title: \"Done!\", description: \"Data loaded\" },\n  error: { title: \"Failed!\", description: \"Could not load data\" }\n});\n\n// Dismiss\ntoast.dismiss(id);\ntoast.dismiss(); // Dismiss all\n\n// Remove immediately\ntoast.remove(id);\ntoast.remove(); // Remove all\n```"
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "Imperative toast API.",
+  "displayName": "toast",
+  "methods": [],
+  "props": {
+    "type": {
+      "defaultValue": null,
+      "description": "Toast type determines styling and ARIA role",
+      "name": "type",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/toast/toast.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "enum",
+        "raw": "ToastType",
+        "value": [
+          {
+            "value": "\"info\""
+          },
+          {
+            "value": "\"warning\""
+          },
+          {
+            "value": "\"error\""
+          },
+          {
+            "value": "\"success\""
+          },
+          {
+            "value": "\"loading\""
+          }
+        ]
+      }
+    },
+    "variant": {
+      "defaultValue": null,
+      "description": "Visual variant (default: \"accent-start\")",
+      "name": "variant",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/toast/toast.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "enum",
+        "raw": "ToastVariant",
+        "value": [
+          {
+            "value": "\"solid\""
+          },
+          {
+            "value": "\"subtle\""
+          },
+          {
+            "value": "\"accent-start\""
+          }
+        ]
+      }
+    },
+    "title": {
+      "defaultValue": null,
+      "description": "Title text",
+      "name": "title",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/toast/toast.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": true,
+      "type": {
+        "name": "string"
+      }
+    },
+    "description": {
+      "defaultValue": null,
+      "description": "Description text providing additional context",
+      "name": "description",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/toast/toast.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "action": {
+      "defaultValue": null,
+      "description": "Optional action button",
+      "name": "action",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/toast/toast.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ToastAction"
+      }
+    },
+    "icon": {
+      "defaultValue": null,
+      "description": "Custom icon element that replaces the default type-based icon",
+      "name": "icon",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/toast/toast.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ReactElement<unknown, string | JSXElementConstructor<any>>"
+      }
+    },
+    "duration": {
+      "defaultValue": null,
+      "description": "Auto-dismiss duration in milliseconds (default: 6000, Infinity = never)",
+      "name": "duration",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/toast/toast.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "number"
+      }
+    },
+    "placement": {
+      "defaultValue": null,
+      "description": "Placement on screen (default: \"top-end\")",
+      "name": "placement",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/toast/toast.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "enum",
+        "raw": "ToastPlacement",
+        "value": [
+          {
+            "value": "\"top-start\""
+          },
+          {
+            "value": "\"top-end\""
+          },
+          {
+            "value": "\"bottom-start\""
+          },
+          {
+            "value": "\"bottom-end\""
+          }
+        ]
+      }
+    },
+    "closable": {
+      "defaultValue": null,
+      "description": "Whether the close button is visible (default: false)",
+      "name": "closable",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/toast/toast.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "pauseOnInteraction": {
+      "defaultValue": null,
+      "description": "Pause auto-dismiss on hover/focus (default: true)",
+      "name": "pauseOnInteraction",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/toast/toast.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "aria-live": {
+      "defaultValue": null,
+      "description": "Override the default `aria-live` politeness level.\nBy default, `error` toasts use `\"assertive\"` and all others use `\"polite\"`.",
+      "name": "aria-live",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/toast/toast.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "enum",
+        "raw": "\"off\" | \"assertive\" | \"polite\"",
+        "value": [
+          {
+            "value": "\"off\""
+          },
+          {
+            "value": "\"assertive\""
+          },
+          {
+            "value": "\"polite\""
+          }
+        ]
+      }
+    }
+  },
+  "supportsStyleProps": false
+}

package/data/docs/types/useColorMode.json

@@ -0,0 +1,13 @@
+{
+  "tags": {
+    "experimental": "This hook is experimental and may change in future versions.\n\nThis hook provides access to the current color mode and functions to change it.\nIt integrates with the next-themes library to handle theme persistence and system preference detection.",
+    "returns": "An object containing:\n- `colorMode`: The current resolved theme ('light' | 'dark' | 'system' | undefined)\n- `setColorMode`: Function to set a specific color mode\n- `toggleColorMode`: Function to toggle between light and dark modes",
+    "example": "```tsx\nfunction ThemeToggle() {\n  const { colorMode, toggleColorMode } = useColorMode();\n\n  return (\n    <button onClick={toggleColorMode}>\n      Current mode: {colorMode}\n    </button>\n  );\n}\n```"
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "Hook for managing color mode (light/dark theme) state.",
+  "displayName": "useColorMode",
+  "methods": [],
+  "props": {},
+  "supportsStyleProps": false
+}

package/data/docs/types/useColorModeValue.json

@@ -0,0 +1,13 @@
+{
+  "tags": {
+    "experimental": "This hook is experimental and may change in future versions.",
+    "param": "light - The value to return when the color mode is light\ndark - The value to return when the color mode is dark",
+    "returns": "The appropriate value based on the current color mode"
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "Hook that returns a value based on the current color mode.",
+  "displayName": "useColorModeValue",
+  "methods": [],
+  "props": {},
+  "supportsStyleProps": false
+}

package/data/docs/types/useColorScheme.json

@@ -0,0 +1,12 @@
+{
+  "tags": {
+    "experimental": "This hook is experimental and may change in future versions.\n\nThis hook monitors the color-scheme CSS property on the document's HTML element\nand returns the current value. It automatically updates when the color scheme changes,\neither through direct style changes or theme updates stored in localStorage.\n\nThe hook observes mutations to the HTML element's style attribute to detect\ncolor scheme changes and re-renders the component when changes occur.",
+    "returns": "The current color scheme value as a string ('light', 'dark')"
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "Hook that provides access to the current color scheme value.",
+  "displayName": "useColorScheme",
+  "methods": [],
+  "props": {},
+  "supportsStyleProps": false
+}

package/data/docs/types/useLocalizedStringFormatter.json

@@ -0,0 +1,14 @@
+{
+  "tags": {
+    "param": "strings - A mapping of locales to localized strings by key (LocalizedStrings object)",
+    "returns": "A formatter object with a `format` method for accessing localized messages",
+    "throws": "Never throws - returns empty string on errors or missing messages",
+    "example": "```tsx\nimport { useLocalizedStringFormatter } from \"@/hooks\";\nimport { alertMessagesStrings } from \"./alert.messages\";\n\nexport const AlertDismissButton = () => {\n  const msg = useLocalizedStringFormatter(alertMessagesStrings);\n\n  return (\n    <button aria-label={msg.format(\"dismiss\")}>\n      ...\n    </button>\n  );\n};\n```\n```tsx\n// With variables\nconst msg = useLocalizedStringFormatter(avatarMessagesStrings);\nconst label = msg.format(\"avatarLabel\", { fullName: \"John Doe\" });\n```"
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "Provides localized string formatting for the current locale. Automatically updates when the locale changes.\n\nThis hook is similar to React Aria's `useLocalizedStringFormatter` but adapted for Nimbus's\nmessage dictionary structure with locale normalization.",
+  "displayName": "useLocalizedStringFormatter",
+  "methods": [],
+  "props": {},
+  "supportsStyleProps": false
+}