@commercetools/nimbus-mcp 3.2.0 → 3.3.0

package/data/docs/types/ChatMessageAvatar.json

@@ -0,0 +1,140 @@
+{
+  "tags": {
+    "supportsStyleProps": ""
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "ChatMessage.Avatar - The sender's avatar.\n\nWraps the Nimbus `Avatar` (defaulting to `size=\"xs\"`, a 32px box per the\nFigma spec). Unless the consumer sets `variant` explicitly, the variant\ndefaults per `sender`: `solid` for the `agent` (a strong branded glyph) and\n`subtle` for the `user` (a softer surface that matches the user body's tint).\nThe color *palette* comes from the ChatMessage recipe (`primary`), so\nconsumers only supply the avatar content (initials via `firstName`/\n`lastName`, an image `src`, or a custom icon via `children`).\n\nAn **unconfigured** avatar (no content supplied) falls back to a\nsender-appropriate generic glyph: the AI `AutoAwesome` sparkle for the\n`agent`, and the `Avatar`'s built-in person icon for the `user`.\n\nProps flow to the **inner `Avatar`**, not to the grid-cell wrapper — the\nwrapper only exists to occupy the avatar column.\n\nAccessibility: the avatar is **decorative by default** (`aria-hidden`). A\nsender glyph duplicates information better conveyed by the message's\naccessible name and column, and a nameless `Avatar` would otherwise announce\na misleading generic label. Passing `firstName`/`lastName` or an explicit\n`aria-label` opts it back into the accessibility tree with a real name.",
+  "displayName": "ChatMessageAvatar",
+  "methods": [],
+  "props": {
+    "size": {
+      "defaultValue": {
+        "value": "xs"
+      },
+      "description": "Size variant of the avatar",
+      "name": "size",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/avatar/avatar.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ConditionalValue<\"md\" | \"2xs\" | \"xs\">"
+      }
+    },
+    "variant": {
+      "defaultValue": {
+        "value": "\"subtle\""
+      },
+      "description": "Visual style variant of the avatar",
+      "name": "variant",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/avatar/avatar.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ConditionalValue<\"solid\" | \"subtle\">"
+      }
+    },
+    "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"
+      }
+    },
+    "firstName": {
+      "defaultValue": null,
+      "description": "First name used to generate initials. Optional — empty,\nwhitespace-only, or omitted values are handled gracefully and the\ncomponent falls back to `lastName` (if usable) or to the `Person`\nicon when neither name yields a usable character.",
+      "name": "firstName",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/avatar/avatar.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "lastName": {
+      "defaultValue": null,
+      "description": "Last name used to generate initials. Optional — empty,\nwhitespace-only, or omitted values are handled gracefully and the\ncomponent falls back to `firstName` (if usable) or to the `Person`\nicon when neither name yields a usable character.",
+      "name": "lastName",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/avatar/avatar.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "src": {
+      "defaultValue": null,
+      "description": "Image source URL for the avatar",
+      "name": "src",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/avatar/avatar.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "alt": {
+      "defaultValue": null,
+      "description": "Alternative text for the avatar image",
+      "name": "alt",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/avatar/avatar.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "string"
+      }
+    },
+    "ref": {
+      "defaultValue": null,
+      "description": "Ref forwarding to the root element",
+      "name": "ref",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/avatar/avatar.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Ref<HTMLDivElement>"
+      }
+    }
+  },
+  "supportsStyleProps": true
+}

package/data/docs/types/ChatMessageBody.json

@@ -0,0 +1,42 @@
+{
+  "tags": {
+    "supportsStyleProps": ""
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "ChatMessage.Body - The rounded card that holds the message payload.\n\nStacks its children vertically; place `ChatMessage.Actions` as the last child\nto pin action buttons to the bottom of the body. Background, padding,\nborder-radius and max-width are set per `sender` by the recipe.",
+  "displayName": "ChatMessageBody",
+  "methods": [],
+  "props": {
+    "as": {
+      "defaultValue": null,
+      "description": "Override the rendered element (e.g. `as=\"section\"`). 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
+}

package/data/docs/types/ChatMessageList.json

@@ -0,0 +1,12 @@
+{
+  "tags": {
+    "see": "{@link https://nimbus-documentation.vercel.app/components/feedback/chat-message-list}",
+    "example": "```tsx\n<ChatMessageList.Root aria-label=\"Conversation with the agent\">\n  <ChatMessageList.Item>\n    <ChatMessage.Root sender=\"user\">\n      <ChatMessage.Body><Text>Summarise last week's orders?</Text></ChatMessage.Body>\n    </ChatMessage.Root>\n  </ChatMessageList.Item>\n  <ChatMessageList.Item>\n    <Box mx=\"auto\" textAlign=\"center\" color=\"neutral.11\" textStyle=\"sm\">\n      Conversation history was cleared.\n    </Box>\n  </ChatMessageList.Item>\n</ChatMessageList.Root>\n```"
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "ChatMessageList\n============================================================\nA compound component that presents a **scrollable sequence of chat messages**\nand owns transcript-level scroll and announcement behavior. It is the second\nprimitive in the `Chat*` family: `ChatMessage` renders one message,\n`ChatMessageList` arranges many into a conversation.\n\nA list is defined by its items, so `ChatMessageList` is a compound of a\n`Root` and its `Item`s — not a box that happens to contain children. The\n`Item` is the list-membership socket; a `ChatMessage` (or any other content)\nis what plugs into it.\n\n`Root` wraps the Nimbus `ScrollArea`, owns autoscroll / stick-to-bottom and\nthe \"jump to latest\" affordance, and is the single persistent\n`role=\"log\"` `aria-live=\"polite\"` region that announces appended and streamed\nreplies — the counterpart to `ChatMessage`'s `isStreaming` busy flag.",
+  "displayName": "ChatMessageList",
+  "methods": [],
+  "props": {},
+  "supportsStyleProps": false
+}

package/data/docs/types/ChatMessageListItem.json

@@ -0,0 +1,42 @@
+{
+  "tags": {
+    "supportsStyleProps": ""
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "ChatMessageList.Item - One member of the transcript.\n\nThe list-membership socket: it owns inter-item placement and the entry\npresentation of a newly appended member, and is content-agnostic — it holds a\n`ChatMessage` or any other content without reaching into it.\nThat child-agnosticism is what lets a system notice be a peer of a message\nrather than a message variant.\n\nIt deliberately does **not** assert `role=\"listitem\"`, which would conflict\nwith the `log` live-region semantics of `ChatMessageList.Root`; it provides\nDOM order and a structural styling hook only.",
+  "displayName": "ChatMessageListItem",
+  "methods": [],
+  "props": {
+    "as": {
+      "defaultValue": null,
+      "description": "Override the rendered element. Defaults to a `div`. Note: `Item`\ndeliberately does not assert `role=\"listitem\"` (it would conflict with the\n`log` container). `as=\"li\"` only yields real list semantics inside an\nactual `list`/`role=\"list\"` ancestor, which the transcript is not.",
+      "name": "as",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/chat-message-list/chat-message-list.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ElementType<any, keyof IntrinsicElements>"
+      }
+    },
+    "ref": {
+      "defaultValue": null,
+      "description": "Ref forwarding to the item element.",
+      "name": "ref",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/chat-message-list/chat-message-list.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Ref<HTMLDivElement>"
+      }
+    }
+  },
+  "supportsStyleProps": true
+}

package/data/docs/types/ChatMessageListRoot.json

@@ -0,0 +1,78 @@
+{
+  "tags": {
+    "supportsStyleProps": ""
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "ChatMessageList.Root - The scrollable transcript container.\n\nWraps the Nimbus `ScrollArea` for the viewport and owns transcript-level\nbehavior: autoscroll / stick-to-bottom (pins to the newest item while the\nuser is at the bottom, including during streaming, and releases when they\nscroll up), the \"jump to latest\" affordance, and the single persistent\n`role=\"log\"` `aria-live=\"polite\"` region that announces appended and streamed\nmessages. When there are no items it renders `emptyState`.\n\nThe list is content-agnostic: its `Item`s hold a `ChatMessage` or any other\ncontent and it never reaches into them. It renders one message's\nannouncement at the transcript level; the message itself only flags\n`aria-busy` while streaming (see `ChatMessage`).",
+  "displayName": "ChatMessageListRoot",
+  "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"
+      }
+    },
+    "autoScroll": {
+      "defaultValue": {
+        "value": "true"
+      },
+      "description": "Keep the viewport pinned to the newest item while the user is at the\nbottom (including while a reply streams and grows), releasing the pin\nwhen the user scrolls up to read history. Set to `false` to disable\nautomatic scrolling entirely and drive it yourself via the ref handle.",
+      "name": "autoScroll",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/chat-message-list/chat-message-list.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "boolean"
+      }
+    },
+    "emptyState": {
+      "defaultValue": null,
+      "description": "Content rendered when the list has no `Item` children — an onboarding\nprompt, suggested questions, or a simple \"No messages yet\" line.",
+      "name": "emptyState",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/chat-message-list/chat-message-list.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "ReactNode"
+      }
+    },
+    "ref": {
+      "defaultValue": null,
+      "description": "Imperative handle for programmatic scroll control.",
+      "name": "ref",
+      "declarations": [
+        {
+          "fileName": "nimbus/packages/nimbus/src/components/chat-message-list/chat-message-list.types.ts",
+          "name": "TypeLiteral"
+        }
+      ],
+      "required": false,
+      "type": {
+        "name": "Ref<ChatMessageListHandle>"
+      }
+    }
+  },
+  "supportsStyleProps": true
+}

package/data/docs/types/ChatMessageMeta.json

@@ -0,0 +1,42 @@
+{
+  "tags": {
+    "supportsStyleProps": ""
+  },
+  "filePath": "/home/runner/work/nimbus/nimbus/packages/nimbus/src/index.ts",
+  "description": "ChatMessage.Meta - Layout-only row rendered below the body.\n\nRenders a `space-between` flex row aligned with the body. Consumers provide\nthe content (timestamp, provenance/trust links, reaction icons). With a\nsingle child, `space-between` leaves it at the start of the row — pair it\nwith a spacer or a second element to push content to the end.",
+  "displayName": "ChatMessageMeta",
+  "methods": [],
+  "props": {
+    "as": {
+      "defaultValue": null,
+      "description": "Override the rendered element (e.g. `as=\"footer\"`). 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
+}

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
+}