@commercetools/nimbus-mcp 3.1.0 → 3.3.0

package/data/docs/types/ChatMessageRoot.json

@@ -0,0 +1,119 @@
+{
+  "tags": {
+    "supportsStyleProps": ""
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "ChatMessage.Root - The grid container for a single chat message.\n\nEstablishes the styling context and lays out the avatar, body and optional\nmeta row. The `sender` prop selects the layout direction (avatar leading for\n`\"agent\"`, trailing for `\"user\"`) and the sender-specific styling;\n`tone=\"error\"` tints the body for a failed generation.\n\nRenders a semantic `<article>` by default (a feed item, per the ARIA APG) so\na message is a discrete node in the accessibility tree. This is a *default*,\nnot a mandate: override the element with `as` (e.g. `as=\"li\"` inside a list)\nand name the message for assistive tech with `aria-label`/`aria-labelledby`.\nThe surrounding feed / live region is the consumer's to compose — see the\naccessibility docs.",
+  "displayName": "ChatMessageRoot",
+  "methods": [],
+  "props": {
+    "unstyled": {
+      "defaultValue": null,
+      "description": "If `true`, the element will opt out of the theme styles.",
+      "name": "unstyled",
+      "parent": {
+        "fileName": "nimbus/node_modules/.pnpm/@chakra-ui+react@3.36.1_@emotion+react@11.14.0_@types+react@19.2.17_react@19.2.0__react_481d5ee5504b18c9383bebdcb4b66737/node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts",
+        "name": "UnstyledProp"
+      },
+      "declarations": [
+        {
+          "fileName": "nimbus/node_modules/.pnpm/@chakra-ui+react@3.36.1_@emotion+react@11.14.0_@types+react@19.2.17_react@19.2.0__react_481d5ee5504b18c9383bebdcb4b66737/node_modules/@chakra-ui/react/dist/types/styled-system/factory.types.d.ts",
+          "name": "UnstyledProp"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "tone": {
+      "defaultValue": {
+        "value": "\"neutral\""
+      },
+      "description": "Status overlay, orthogonal to `sender`. `\"error\"` tints the body with the\ncritical palette to flag a failed generation — an *agent* message can fail,\nso error is a tone rather than a sender.",
+      "name": "tone",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/chat-message/chat-message.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ConditionalValue<\"neutral\" | \"error\">"
+      }
+    },
+    "sender": {
+      "defaultValue": {
+        "value": "\"agent\""
+      },
+      "description": "Which participant sent the message — drives the layout direction and the\nper-sender styling. A single value only: a message's sender is fixed, so\nresponsive/conditional values are intentionally not accepted (they would\nstyle the body per breakpoint while the avatar defaults could not follow).",
+      "name": "sender",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/chat-message/chat-message.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "enum",
+        "raw": "ChatMessageSender",
+        "value": [
+          {
+            "value": "\"user\""
+          },
+          {
+            "value": "\"agent\""
+          }
+        ]
+      }
+    },
+    "as": {
+      "defaultValue": null,
+      "description": "Override the rendered element. Defaults to `\"article\"` (a feed item, per\nthe ARIA APG); set e.g. `as=\"li\"` when composing the message into a list.",
+      "name": "as",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/chat-message/chat-message.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ElementType<any, keyof IntrinsicElements>"
+      }
+    },
+    "isStreaming": {
+      "defaultValue": null,
+      "description": "Marks the message as still being generated. Sets `aria-busy` on the root so\nassistive tech knows the content is in flux. The live-region announcement\n(e.g. wrapping the feed in `role=\"log\" aria-live=\"polite\"`) stays the\nconsumer's responsibility — see the accessibility docs.",
+      "name": "isStreaming",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/chat-message/chat-message.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "ref": {
+      "defaultValue": null,
+      "description": "",
+      "name": "ref",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/chat-message/chat-message.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Ref<HTMLDivElement>"
+      }
+    }
+  },
+  "supportsStyleProps": true
+}

package/data/docs/types/ChatMessageTyping.json

@@ -0,0 +1,42 @@
+{
+  "tags": {
+    "supportsStyleProps": ""
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "ChatMessage.Typing - Animated \"generating…\" indicator for a streaming reply.\n\nRenders the Nimbus `ActivityIndicator` (three bouncing dots) inside the\nbody while a response streams. Place it as the body's payload and swap it\nfor the real content once the stream settles.\n\nAccessibility: the dots are decorative (`ActivityIndicator` is always\n`aria-hidden`). Pass a visible label as `children` (e.g. \"Agent is\ntyping…\") for a per-message affordance, and/or set `isStreaming` on\n`ChatMessage.Root` (which sets `aria-busy`) — the coalesced live-region\nannouncement stays with the consumer's feed/turn container.",
+  "displayName": "ChatMessageTyping",
+  "methods": [],
+  "props": {
+    "as": {
+      "defaultValue": null,
+      "description": "Override the rendered element. Defaults to a `div`.",
+      "name": "as",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/chat-message/chat-message.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ElementType<any, keyof IntrinsicElements>"
+      }
+    },
+    "ref": {
+      "defaultValue": null,
+      "description": "",
+      "name": "ref",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/chat-message/chat-message.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Ref<HTMLDivElement>"
+      }
+    }
+  },
+  "supportsStyleProps": true
+}