@ikas/code-components-mcp 2.11.0 → 2.11.1

package/data/framework.json

@@ -4,7 +4,7 @@
     "project-structure": {
       "title": "Project Structure",
       "description": "How an ikas code components project is organized",
-      "content": "An ikas code components project follows this structure:\n\n```\nmy-project/\n├── src/\n│   ├── global.css              # Optional: project-wide unscoped CSS (variables, resets)\n│   └── components/\n│       ├── MyComponent/\n│       │   ├── index.tsx      # Component implementation (Preact)\n│       │   ├── types.ts       # TypeScript props interface\n│       │   └── styles.css     # Scoped component styles\n│       └── index.ts           # Component exports barrel\n├── ikas.config.json           # Component definitions, props, metadata\n├── package.json\n├── tsconfig.json\n└── vite.config.ts\n```\n\nEach component lives in its own directory under `src/components/`. The component's entry point is `index.tsx`, which exports a default Preact function component. The `types.ts` file defines the props interface matching the props declared in `ikas.config.json`. The `styles.css` file contains CSS that is automatically scoped to the component.\n\n### Project with Sub-Components\n\nWhen components grow complex, extract sub-components into `src/sub-components/`. See `get_framework_guide(\"sub-component-patterns\")` for full details.\n\n```\nmy-project/\n├── src/\n│   ├── components/\n│   │   ├── ProductList/\n│   │   │   ├── index.tsx         # Imports from ../../sub-components/...\n│   │   │   ├── types.ts          # Auto-generated (CLI-managed)\n│   │   │   └── styles.css        # component styles (sub-component styles.css collected automatically)\n│   │   └── index.ts\n│   └── sub-components/\n│       ├── ProductCard/\n│       │   ├── index.tsx          # Sub-component with inline Props\n│       │   └── styles.css         # Sub-component styles\n│       └── FilterSidebar/\n│           ├── index.tsx\n│           └── styles.css\n├── ikas.config.json\n├── package.json\n├── tsconfig.json\n└── vite.config.ts\n```\n\n**Key:** `src/components/` = registered components (in ikas.config.json). `src/sub-components/` = internal helpers (NOT in ikas.config.json).",
+      "content": "An ikas code components project follows this structure:\n\n```\nmy-project/\n├── src/\n│   ├── global.css              # Optional: project-wide CSS, scoped to this project (variables, fonts, resets)\n│   └── components/\n│       ├── MyComponent/\n│       │   ├── index.tsx      # Component implementation (Preact)\n│       │   ├── types.ts       # TypeScript props interface\n│       │   └── styles.css     # Scoped component styles\n│       └── index.ts           # Component exports barrel\n├── ikas.config.json           # Component definitions, props, metadata\n├── package.json\n├── tsconfig.json\n└── vite.config.ts\n```\n\nEach component lives in its own directory under `src/components/`. The component's entry point is `index.tsx`, which exports a default Preact function component. The `types.ts` file defines the props interface matching the props declared in `ikas.config.json`. The `styles.css` file contains CSS that is automatically scoped to the component.\n\n### Project with Sub-Components\n\nWhen components grow complex, extract sub-components into `src/sub-components/`. See `get_framework_guide(\"sub-component-patterns\")` for full details.\n\n```\nmy-project/\n├── src/\n│   ├── components/\n│   │   ├── ProductList/\n│   │   │   ├── index.tsx         # Imports from ../../sub-components/...\n│   │   │   ├── types.ts          # Auto-generated (CLI-managed)\n│   │   │   └── styles.css        # component styles (sub-component styles.css collected automatically)\n│   │   └── index.ts\n│   └── sub-components/\n│       ├── ProductCard/\n│       │   ├── index.tsx          # Sub-component with inline Props\n│       │   └── styles.css         # Sub-component styles\n│       └── FilterSidebar/\n│           ├── index.tsx\n│           └── styles.css\n├── ikas.config.json\n├── package.json\n├── tsconfig.json\n└── vite.config.ts\n```\n\n**Key:** `src/components/` = registered components (in ikas.config.json). `src/sub-components/` = internal helpers (NOT in ikas.config.json).",
       "tags": [
         "structure",
         "project",
@@ -109,7 +109,7 @@
     "css-scoping": {
       "title": "CSS Scoping Rules",
       "description": "How CSS is scoped to prevent conflicts between components",
-      "content": "CSS files referenced in `ikas.config.json` are automatically scoped at build time.\n\n### How it works:\n- Each component's CSS selectors are prefixed with a unique scope identifier\n- `.my-class` becomes `.[scope]-my-class` in the output\n- This prevents style conflicts between different components on the same page\n\n### Best practices:\n- Use class selectors (`.my-class`) rather than element selectors (`div`, `h1`)\n- Avoid using `!important` - scoping handles isolation\n- Don't use global selectors or `@global` - they won't be scoped\n- Keep CSS in the component's `styles.css` file referenced in config, or in a sub-component's sibling `styles.css` — both are collected and scoped automatically on `dev`/`publish`\n- Nested selectors work: `.parent .child` both get scoped\n\n### Example:\n```css\n/* What you write */\n.product-card {\n  padding: 16px;\n  border: 1px solid #eee;\n}\n\n.product-card .title {\n  font-size: 18px;\n  font-weight: bold;\n}\n\n.product-card .price {\n  color: #e53e3e;\n}\n```\n\nThe build system transforms this so your `.product-card`, `.title`, and `.price` classes are unique to your component and won't clash with any other component or theme styles.\n\n### Global CSS Exception\n\nThe one intentional exception to scoping is **Global CSS** — project-wide styles defined in `src/global.css` that are loaded unscoped before any component CSS. Global CSS is ideal for CSS custom properties (variables), resets, and shared utility classes. The loading order is: **Global CSS → Shared chunk CSS → Component CSS**, so global styles have the lowest specificity and component styles always win.\n\nSee `get_framework_guide(\"global-css\")` for full details on global CSS setup and usage.",
+      "content": "CSS files referenced in `ikas.config.json` are automatically scoped at build time.\n\n### How it works:\n- Each component's CSS selectors are prefixed with a unique scope identifier\n- `.my-class` becomes `.[scope]-my-class` in the output\n- This prevents style conflicts between different components on the same page\n\n### Best practices:\n- Use class selectors (`.my-class`) rather than element selectors (`div`, `h1`)\n- Avoid using `!important` - scoping handles isolation\n- Don't use global selectors or `@global` - they won't be scoped\n- Keep CSS in the component's `styles.css` file referenced in config, or in a sub-component's sibling `styles.css` — both are collected and scoped automatically on `dev`/`publish`\n- Nested selectors work: `.parent .child` both get scoped\n\n### Example:\n```css\n/* What you write */\n.product-card {\n  padding: 16px;\n  border: 1px solid #eee;\n}\n\n.product-card .title {\n  font-size: 18px;\n  font-weight: bold;\n}\n\n.product-card .price {\n  color: #e53e3e;\n}\n```\n\nThe build system transforms this so your `.product-card`, `.title`, and `.price` classes are unique to your component and won't clash with any other component or theme styles.\n\n### Global CSS Exception\n\nThe one intentional exception to component scoping is **Global CSS** — project-wide styles defined in `src/global.css`. It gets no `.cc_{componentId}` prefix, but it is still isolated to your project: every rule is wrapped in `:where([data-cc-scope~=\"<projectId>\"])`, and `@font-face` / `@keyframes` / `@counter-style` names declared there are prefixed with `cc_<projectId>_` (references in component CSS are rewritten to match automatically). Global CSS is ideal for CSS custom properties (variables), fonts, resets, and shared utility classes. The loading order is: **Global CSS → Shared chunk CSS → Component CSS**, so global styles have the lowest specificity and component styles always win.\n\nSee `get_framework_guide(\"global-css\")` for full details on global CSS setup and usage.",
       "tags": [
         "css",
         "scoping",
@@ -121,8 +121,8 @@
     },
     "global-css": {
       "title": "Global CSS",
-      "description": "Project-wide unscoped CSS for variables, resets, and shared utilities",
-      "content": "## Global CSS\n\nGlobal CSS lets you define project-wide styles that are shared across all components — without scoping. This is ideal for:\n\n- **CSS custom properties (variables)** — colors, spacing, typography tokens\n- **CSS resets** — normalize/reset base styles\n- **Base typography** — font-family, line-height defaults\n- **Utility classes** — common layout helpers\n\n### Setup\n\n1. Create a `src/global.css` file in your project root:\n\n```css\n/* src/global.css */\n:root {\n  --color-primary: #2563eb;\n  --color-secondary: #7c3aed;\n  --color-text: #1f2937;\n  --color-text-muted: #6b7280;\n  --color-border: #e5e7eb;\n  --color-background: #ffffff;\n\n  --spacing-xs: 4px;\n  --spacing-sm: 8px;\n  --spacing-md: 16px;\n  --spacing-lg: 24px;\n  --spacing-xl: 48px;\n\n  --font-sans: system-ui, -apple-system, sans-serif;\n  --font-mono: ui-monospace, monospace;\n\n  --radius-sm: 4px;\n  --radius-md: 8px;\n  --radius-lg: 16px;\n}\n```\n\n2. Add the `globalStyles` field to `ikas.config.json`:\n\n```json\n{\n  \"name\": \"my-project\",\n  \"version\": \"1.0.0\",\n  \"globalStyles\": \"./src/global.css\",\n  \"components\": [...]\n}\n```\n\n### Using Global CSS Variables in Components\n\nOnce defined in `global.css`, CSS custom properties are available in any component's `styles.css`:\n\n```css\n/* src/components/ProductCard/styles.css */\n.product-card {\n  border: 1px solid var(--color-border);\n  border-radius: var(--radius-md);\n  padding: var(--spacing-md);\n  font-family: var(--font-sans);\n}\n\n.product-card .title {\n  color: var(--color-text);\n}\n\n.product-card .price {\n  color: var(--color-primary);\n}\n```\n\n### Loading Order\n\nCSS is loaded in this order, from lowest to highest specificity:\n\n1. **Global CSS** (`global.css`) — unscoped, loaded first\n2. **Shared chunk CSS** — scoped styles from shared internal components (their sibling `styles.css` files, collected automatically)\n3. **Component CSS** (`styles.css`) — scoped per-component styles\n\nBecause global CSS loads first and is unscoped, component-scoped styles will always override global styles when selectors conflict. This means you can safely define base defaults in `global.css` and override them in component `styles.css` files.\n\n### Key Differences from Component CSS\n\n| | Global CSS | Component CSS |\n|---|---|---|\n| **File** | `src/global.css` | `src/components/X/styles.css` |\n| **Scoping** | NOT scoped (no `.cc_` prefix) | Scoped with `.cc_{componentId}` prefix |\n| **Config** | `globalStyles` in ikas.config.json | `styles` on each component |\n| **Purpose** | CSS variables, resets, utilities | Component-specific styles |\n| **Load order** | First (lowest specificity) | Last (highest specificity) |\n\n### Best Practices\n\n- **Use CSS custom properties** for design tokens (colors, spacing, fonts) — they cascade naturally and components can reference them\n- **Keep global CSS minimal** — only put truly shared values here. Component-specific styles belong in the component's `styles.css`\n- **Avoid class selectors in global CSS** that target component internals — use custom properties instead for themeable values\n- **Don't duplicate** — if a style only applies to one component, put it in that component's `styles.css`\n\n### Project Structure with Global CSS\n\n```\nmy-project/\n├── src/\n│   ├── global.css              # Project-wide unscoped CSS\n│   └── components/\n│       ├── ProductCard/\n│       │   ├── index.tsx\n│       │   ├── types.ts\n│       │   └── styles.css      # Uses var(--color-primary) etc.\n│       └── index.ts\n├── ikas.config.json            # Has globalStyles: \"./src/global.css\"\n├── package.json\n└── tsconfig.json\n```\n\nSee `get_framework_guide(\"css-scoping\")` for details on how component CSS scoping works.",
+      "description": "Project-wide CSS (scoped to your project) for variables, fonts, resets, and shared utilities",
+      "content": "## Global CSS\n\nGlobal CSS lets you define project-wide styles that are shared across all components of your project. It is isolated per project at build time (every rule is wrapped in `:where([data-cc-scope~=\"<projectId>\"])`), but not per component. This is ideal for:\n\n- **CSS custom properties (variables)** — colors, spacing, typography tokens\n- **CSS resets** — normalize/reset base styles\n- **Base typography** — font-family, line-height defaults\n- **Utility classes** — common layout helpers\n\n### Setup\n\n1. Create a `src/global.css` file in your project root:\n\n```css\n/* src/global.css */\n:root {\n  --color-primary: #2563eb;\n  --color-secondary: #7c3aed;\n  --color-text: #1f2937;\n  --color-text-muted: #6b7280;\n  --color-border: #e5e7eb;\n  --color-background: #ffffff;\n\n  --spacing-xs: 4px;\n  --spacing-sm: 8px;\n  --spacing-md: 16px;\n  --spacing-lg: 24px;\n  --spacing-xl: 48px;\n\n  --font-sans: system-ui, -apple-system, sans-serif;\n  --font-mono: ui-monospace, monospace;\n\n  --radius-sm: 4px;\n  --radius-md: 8px;\n  --radius-lg: 16px;\n}\n```\n\n2. Add the `globalStyles` field to `ikas.config.json`:\n\n```json\n{\n  \"name\": \"my-project\",\n  \"version\": \"1.0.0\",\n  \"globalStyles\": \"./src/global.css\",\n  \"components\": [...]\n}\n```\n\n### Using Global CSS Variables in Components\n\nOnce defined in `global.css`, CSS custom properties are available in any component's `styles.css`:\n\n```css\n/* src/components/ProductCard/styles.css */\n.product-card {\n  border: 1px solid var(--color-border);\n  border-radius: var(--radius-md);\n  padding: var(--spacing-md);\n  font-family: var(--font-sans);\n}\n\n.product-card .title {\n  color: var(--color-text);\n}\n\n.product-card .price {\n  color: var(--color-primary);\n}\n```\n\n### Fonts, Keyframes and Counter Styles\n\n`@font-face`, `@keyframes` and `@counter-style` names live in a document-global namespace, so the build (editor preview and publish alike) prefixes every name declared in `global.css` with `cc_<projectId>_` — `\"Tanker\"` becomes `\"cc_<projectId>_Tanker\"`. You keep writing the plain name; references are rewritten to match automatically in:\n\n- component and shared-chunk CSS: `font`, `font-family`, `animation`, `animation-name`, `list-style`, `list-style-type`, `counter()` / `counters()`\n- CSS custom properties, for **font names only**: `--font-display: \"Tanker\", serif` is rewritten, so `font-family: var(--font-display)` works\n\n```css\n/* src/global.css */\n@font-face {\n  font-family: \"Tanker\";\n  /* absolute URL — local font files are not shipped with the project */\n  src: url(\"https://cdn.example.com/tanker.woff2\") format(\"woff2\");\n  font-display: swap;\n}\n\n:root {\n  --font-display: \"Tanker\", Georgia, serif;\n}\n```\n\n```css\n/* src/components/Hero/styles.css */\n.hero-headline {\n  font-family: var(--font-display); /* or: font-family: \"Tanker\", Georgia, serif; */\n}\n```\n\nNot rewritten — avoid these for names declared in `global.css`:\n\n- inline JS styles (`style={{ fontFamily: \"Tanker\" }}`) — use a class instead\n- keyframe / counter-style names inside custom properties (`--anim: fade`) — reference them from `animation` / `list-style` declarations directly\n- top-level `body { }` / `html { }` rules — they are dropped; style the elements you render (`.hero`, `img`, `[data-x]`)\n\nFonts that come from an external stylesheet (`@import url(\"https://fonts.googleapis.com/...\")` as the first rule of `global.css`) or from the theme's typography tokens (see `get_framework_guide(\"theme-globals\")`) keep their original names and need no rewriting.\n\n### Loading Order\n\nCSS is loaded in this order, from lowest to highest specificity:\n\n1. **Global CSS** (`global.css`) — project-scoped, loaded first\n2. **Shared chunk CSS** — scoped styles from shared internal components (their sibling `styles.css` files, collected automatically)\n3. **Component CSS** (`styles.css`) — scoped per-component styles\n\nBecause global CSS loads first and has the lowest specificity, component-scoped styles will always override global styles when selectors conflict. This means you can safely define base defaults in `global.css` and override them in component `styles.css` files.\n\n### Key Differences from Component CSS\n\n| | Global CSS | Component CSS |\n|---|---|---|\n| **File** | `src/global.css` | `src/components/X/styles.css` |\n| **Scoping** | Scoped per project (`[data-cc-scope]`); no `.cc_{componentId}` prefix | Scoped with `.cc_{componentId}` prefix |\n| **Config** | `globalStyles` in ikas.config.json | `styles` on each component |\n| **Purpose** | CSS variables, resets, utilities | Component-specific styles |\n| **Load order** | First (lowest specificity) | Last (highest specificity) |\n\n### Best Practices\n\n- **Use CSS custom properties** for design tokens (colors, spacing, fonts) — they cascade naturally and components can reference them (font names declared with `@font-face` in `global.css` are rewritten inside custom properties too — see \"Fonts, Keyframes and Counter Styles\")\n- **Keep global CSS minimal** — only put truly shared values here. Component-specific styles belong in the component's `styles.css`\n- **Avoid class selectors in global CSS** that target component internals — use custom properties instead for themeable values\n- **Don't duplicate** — if a style only applies to one component, put it in that component's `styles.css`\n\n### Project Structure with Global CSS\n\n```\nmy-project/\n├── src/\n│   ├── global.css              # Project-wide CSS (scoped to the project)\n│   └── components/\n│       ├── ProductCard/\n│       │   ├── index.tsx\n│       │   ├── types.ts\n│       │   └── styles.css      # Uses var(--color-primary) etc.\n│       └── index.ts\n├── ikas.config.json            # Has globalStyles: \"./src/global.css\"\n├── package.json\n└── tsconfig.json\n```\n\nSee `get_framework_guide(\"css-scoping\")` for details on how component CSS scoping works.",
       "tags": [
         "css",
         "global",
@@ -131,7 +131,11 @@
         "reset",
         "utilities",
         "global.css",
-        "globalStyles"
+        "globalStyles",
+        "font-face",
+        "fonts",
+        "keyframes",
+        "counter-style"
       ]
     },
     "dev-server": {

package/data/storefront-api.json

@@ -1,5 +1,5 @@
 {
-  "generatedAt": "2026-10-14T08:11:46.617Z",
+  "generatedAt": "2026-10-14T12:31:12.919Z",
   "functions": [
     {
       "name": "apiListProductBrand",
@@ -3206,14 +3206,14 @@
       "name": "getIkasOrderRefundableItems",
       "displayName": "getRefundableItems",
       "signature": "function getIkasOrderRefundableItems(order: IkasOrder): IkasOrderLineItem[]",
-      "description": "Returns order line items that are eligible for refund based on item status and the merchant's refund day limit settings.",
+      "description": "Returns order line items that are eligible for refund, based on the refundable lines returned by the API for the order.",
       "params": [
         {
           "name": "order",
           "description": "- The IkasOrder to retrieve refundable items from"
         }
       ],
-      "returns": "An array of order line items eligible for refund, or an empty array if refunds are disabled",
+      "returns": "An array of order line items eligible for refund, or an empty array if refundable lines are not loaded",
       "returnType": "IkasOrderLineItem[]",
       "example": "```typescript\nimport { getIkasOrderRefundableItems } from \"@ikas/bp-storefront\";\nconst refundableItems = getIkasOrderRefundableItems(order);\n```",
       "categories": [
@@ -3222,7 +3222,8 @@
       ],
       "related": [
         "isIkasOrderRefundable",
-        "getIkasOrderRefundedItems"
+        "getIkasOrderRefundedItems",
+        "getIkasOrderRefundReasons"
       ],
       "isAsync": false,
       "isClass": false,
@@ -3232,6 +3233,189 @@
         "IkasOrderLineItem"
       ]
     },
+    {
+      "name": "getIkasOrderRefundReasonId",
+      "displayName": "getRefundReasonId",
+      "signature": "function getIkasOrderRefundReasonId(order: IkasOrder): string | null",
+      "description": "Returns the selected refund reason id for the order's refund request.",
+      "params": [
+        {
+          "name": "order",
+          "description": "- The IkasOrder to read the selected refund reason id from"
+        }
+      ],
+      "returns": "The selected refund reason id, or null if none is selected",
+      "returnType": "string | null",
+      "example": "```typescript\nimport { getIkasOrderRefundReasonId } from \"@ikas/bp-storefront\";\nconst refundReasonId = getIkasOrderRefundReasonId(order);\n```",
+      "categories": [
+        "Order",
+        "Payment"
+      ],
+      "related": [
+        "setIkasOrderRefundReasonId",
+        "getIkasOrderRefundReasons"
+      ],
+      "isAsync": false,
+      "isClass": false,
+      "parameterTypes": [
+        "IkasOrderRefundReasonId",
+        "IkasOrder"
+      ]
+    },
+    {
+      "name": "setIkasOrderRefundReasonId",
+      "displayName": "setRefundReasonId",
+      "signature": "function setIkasOrderRefundReasonId(order: IkasOrder, value: string | null): void",
+      "description": "Sets the selected refund reason id that will be sent with the order's refund request.",
+      "params": [
+        {
+          "name": "order",
+          "description": "- The IkasOrder to set the refund reason id on"
+        },
+        {
+          "name": "value",
+          "description": "- The id of one of the reasons returned by getIkasOrderRefundReasons, or null to clear it"
+        }
+      ],
+      "returnType": "void",
+      "example": "```typescript\nimport { setIkasOrderRefundReasonId, getIkasOrderRefundReasons } from \"@ikas/bp-storefront\";\nconst [firstReason] = getIkasOrderRefundReasons(order);\nsetIkasOrderRefundReasonId(order, firstReason?.id || null);\n```",
+      "categories": [
+        "Order",
+        "Payment"
+      ],
+      "related": [
+        "getIkasOrderRefundReasonId",
+        "getIkasOrderRefundReasons",
+        "refundOrder"
+      ],
+      "isAsync": false,
+      "isClass": false,
+      "parameterTypes": [
+        "IkasOrderRefundReasonId",
+        "IkasOrder"
+      ]
+    },
+    {
+      "name": "getIkasOrderRefundReason",
+      "displayName": "getRefundReason",
+      "signature": "function getIkasOrderRefundReason(order: IkasOrder): string | null",
+      "description": "Returns the free-text refund reason written by the customer for the order's refund request.",
+      "params": [
+        {
+          "name": "order",
+          "description": "- The IkasOrder to read the refund reason note from"
+        }
+      ],
+      "returns": "The refund reason note, or null if none is set",
+      "returnType": "string | null",
+      "example": "```typescript\nimport { getIkasOrderRefundReason } from \"@ikas/bp-storefront\";\nconst reason = getIkasOrderRefundReason(order);\n```",
+      "categories": [
+        "Order",
+        "Payment"
+      ],
+      "related": [
+        "setIkasOrderRefundReason",
+        "getIkasOrderRefundReasonId"
+      ],
+      "isAsync": false,
+      "isClass": false,
+      "parameterTypes": [
+        "IkasOrderRefundReason",
+        "IkasOrder"
+      ]
+    },
+    {
+      "name": "setIkasOrderRefundReason",
+      "displayName": "setRefundReason",
+      "signature": "function setIkasOrderRefundReason(order: IkasOrder, value: string | null): void",
+      "description": "Sets the free-text refund reason that will be sent with the order's refund request.",
+      "params": [
+        {
+          "name": "order",
+          "description": "- The IkasOrder to set the refund reason note on"
+        },
+        {
+          "name": "value",
+          "description": "- The refund reason note, or null to clear it"
+        }
+      ],
+      "returnType": "void",
+      "example": "```typescript\nimport { setIkasOrderRefundReason } from \"@ikas/bp-storefront\";\nsetIkasOrderRefundReason(order, \"The product arrived damaged\");\n```",
+      "categories": [
+        "Order",
+        "Payment"
+      ],
+      "related": [
+        "getIkasOrderRefundReason",
+        "setIkasOrderRefundReasonId",
+        "refundOrder"
+      ],
+      "isAsync": false,
+      "isClass": false,
+      "parameterTypes": [
+        "IkasOrderRefundReason",
+        "IkasOrder"
+      ]
+    },
+    {
+      "name": "getIkasOrderRefundReasons",
+      "displayName": "getRefundReasons",
+      "signature": "function getIkasOrderRefundReasons(order: IkasOrder): IkasOrderRefundReason[]",
+      "description": "Returns the refund reasons the customer can choose from, with titles translated to the current locale.",
+      "params": [
+        {
+          "name": "order",
+          "description": "- The IkasOrder to get refund reasons for"
+        }
+      ],
+      "returns": "An array of refund reasons with localized titles, or an empty array if refundable lines are not loaded",
+      "returnType": "IkasOrderRefundReason[]",
+      "example": "```typescript\nimport { getIkasOrderRefundReasons } from \"@ikas/bp-storefront\";\nconst reasons = getIkasOrderRefundReasons(order);\nreasons.forEach(reason => console.log(reason.id, reason.title));\n```",
+      "categories": [
+        "Order",
+        "Payment"
+      ],
+      "related": [
+        "setIkasOrderRefundReasonId",
+        "getIkasOrderRefundableItems"
+      ],
+      "isAsync": false,
+      "isClass": false,
+      "parameterTypes": [
+        "IkasOrderRefundReasons",
+        "IkasOrder",
+        "IkasOrderRefundReason"
+      ]
+    },
+    {
+      "name": "getIkasOrderReturnMethodDescription",
+      "displayName": "getReturnMethodDescription",
+      "signature": "function getIkasOrderReturnMethodDescription(order: IkasOrder): string | null",
+      "description": "Returns the merchant's return method description for the current locale.",
+      "params": [
+        {
+          "name": "order",
+          "description": "- The IkasOrder to get the return method description for"
+        }
+      ],
+      "returns": "The return method description for the current locale, or null if none exists",
+      "returnType": "string | null",
+      "example": "```typescript\nimport { getIkasOrderReturnMethodDescription } from \"@ikas/bp-storefront\";\nconst description = getIkasOrderReturnMethodDescription(order);\n```",
+      "categories": [
+        "Order",
+        "Payment"
+      ],
+      "related": [
+        "getIkasOrderRefundReasons",
+        "getIkasOrderRefundableItems"
+      ],
+      "isAsync": false,
+      "isClass": false,
+      "parameterTypes": [
+        "IkasOrderReturnMethodDescription",
+        "IkasOrder"
+      ]
+    },
     {
       "name": "isIkasOrderRefundable",
       "displayName": "isRefundable",
@@ -13704,6 +13888,44 @@
         "IkasCustomerAddress"
       ]
     },
+    {
+      "name": "createRefundRequest",
+      "signature": "async function createRefundRequest(customerStore: IkasCustomerStore, order: IkasOrder, email?: string | null): Promise<IkasRefundRequestResult>",
+      "description": "Submit a refund request for an order based on the refund quantities set on each line item,\nalong with the selected refund reason id and refund reason note set on the order.",
+      "params": [
+        {
+          "name": "customerStore",
+          "description": "- The customer store instance"
+        },
+        {
+          "name": "order",
+          "description": "- The order to request a refund for"
+        },
+        {
+          "name": "email",
+          "description": "- Optional email address for guest order refunds"
+        }
+      ],
+      "returns": "Object with isSuccess flag, errorCode on failure and the not allowed lines for REFUND_NOT_ALLOWED",
+      "returnType": "Promise<IkasRefundRequestResult>",
+      "example": "```typescript\nimport { customerStore, createRefundRequest, getOrder } from \"@ikas/bp-storefront\";\n\nasync function handleRefundRequest(orderId: string) {\n  const order = await getOrder(customerStore, orderId);\n  if (!order) return;\n\n  const result = await createRefundRequest(customerStore, order);\n  if (result.isSuccess) {\n    showToast(\"Refund request submitted\");\n  } else if (result.errorCode === \"REFUND_REASON_REQUIRED\") {\n    showToast(\"Please select a refund reason\");\n  } else {\n    showToast(\"Refund request failed\");\n  }\n}\n```",
+      "categories": [
+        "Customer"
+      ],
+      "related": [
+        "refundOrder",
+        "getOrder",
+        "setIkasOrderRefundReasonId",
+        "setIkasOrderRefundReason"
+      ],
+      "isAsync": true,
+      "isClass": false,
+      "parameterTypes": [
+        "IkasCustomerStore",
+        "IkasOrder",
+        "IkasRefundRequestResult"
+      ]
+    },
     {
       "name": "refundOrder",
       "signature": "async function refundOrder(customerStore: IkasCustomerStore, order: IkasOrder, email?: string | null): Promise<boolean>",
@@ -13729,6 +13951,7 @@
         "Customer"
       ],
       "related": [
+        "createRefundRequest",
         "getOrder",
         "getOrders",
         "getOrderRefundSettings"

package/data/storefront-types.json

@@ -1,5 +1,5 @@
 {
-  "generatedAt": "2026-10-14T08:11:46.690Z",
+  "generatedAt": "2026-10-14T12:31:12.962Z",
   "types": [
     {
       "name": "TextElementTagTypes",
@@ -6597,6 +6597,31 @@
           "name": "transactions",
           "type": "IkasOrderTransaction[]",
           "optional": true
+        },
+        {
+          "name": "_refundableLines",
+          "type": "IkasRefundableLine[] | null",
+          "optional": true
+        },
+        {
+          "name": "_refundReasons",
+          "type": "IkasOrderRefundReason[] | null",
+          "optional": true
+        },
+        {
+          "name": "_refundTranslations",
+          "type": "IkasOrderRefundSettingsTranslation[] | null",
+          "optional": true
+        },
+        {
+          "name": "_refundReasonId",
+          "type": "string | null",
+          "optional": true
+        },
+        {
+          "name": "_refundReason",
+          "type": "string | null",
+          "optional": true
         }
       ],
       "filePath": "order/index.ts",
@@ -6606,6 +6631,12 @@
         "getIkasOrderTotalItemCount",
         "getIkasOrderDisplayedPackages",
         "getIkasOrderRefundableItems",
+        "getIkasOrderRefundReasonId",
+        "setIkasOrderRefundReasonId",
+        "getIkasOrderRefundReason",
+        "setIkasOrderRefundReason",
+        "getIkasOrderRefundReasons",
+        "getIkasOrderReturnMethodDescription",
         "isIkasOrderRefundable",
         "getIkasOrderUnfullfilledItems",
         "getIkasOrderRefundedItems",
@@ -6628,6 +6659,7 @@
         "getIkasOrderHref",
         "getIkasOrderVariantNames",
         "submitOrderTrackingForm",
+        "createRefundRequest",
         "refundOrder",
         "getOrders",
         "getOrder",
@@ -7008,6 +7040,26 @@
           "type": "number",
           "optional": false
         },
+        {
+          "name": "flow",
+          "type": "IkasOrderRefundFlow | null",
+          "optional": true
+        },
+        {
+          "name": "autoApprove",
+          "type": "boolean",
+          "optional": true
+        },
+        {
+          "name": "isCancellable",
+          "type": "boolean",
+          "optional": true
+        },
+        {
+          "name": "isRefundable",
+          "type": "boolean",
+          "optional": true
+        },
         {
           "name": "_refundQuantity",
           "type": "number | null",
@@ -7858,6 +7910,118 @@
       ],
       "filePath": "order/refund/line-item/index.ts"
     },
+    {
+      "name": "IkasOrderRefundReason",
+      "kind": "type",
+      "domain": "order",
+      "properties": [
+        {
+          "name": "id",
+          "type": "string",
+          "optional": false
+        },
+        {
+          "name": "title",
+          "type": "string",
+          "optional": false
+        },
+        {
+          "name": "translations",
+          "type": "IkasOrderRefundReasonTranslation[] | null",
+          "optional": false
+        }
+      ],
+      "filePath": "order/refund/reason/index.ts",
+      "relatedFunctions": [
+        "getIkasOrderRefundReason",
+        "setIkasOrderRefundReason",
+        "getIkasOrderRefundReasons"
+      ]
+    },
+    {
+      "name": "IkasOrderRefundReasonTranslation",
+      "kind": "type",
+      "domain": "order",
+      "properties": [
+        {
+          "name": "locale",
+          "type": "string",
+          "optional": false
+        },
+        {
+          "name": "title",
+          "type": "string | null",
+          "optional": false
+        }
+      ],
+      "filePath": "order/refund/reason/translation/index.ts"
+    },
+    {
+      "name": "IkasOrderRefundFlow",
+      "kind": "type",
+      "domain": "order",
+      "unionValues": [
+        "CANCEL",
+        "RETURN"
+      ],
+      "filePath": "order/refund/refundable-line/index.ts"
+    },
+    {
+      "name": "IkasRefundableLine",
+      "kind": "type",
+      "domain": "order",
+      "properties": [
+        {
+          "name": "autoApprove",
+          "type": "boolean",
+          "optional": false
+        },
+        {
+          "name": "flow",
+          "type": "IkasOrderRefundFlow | null",
+          "optional": false
+        },
+        {
+          "name": "isCancellable",
+          "type": "boolean",
+          "optional": false
+        },
+        {
+          "name": "isRefundable",
+          "type": "boolean",
+          "optional": false
+        },
+        {
+          "name": "orderLineItemId",
+          "type": "string",
+          "optional": false
+        }
+      ],
+      "filePath": "order/refund/refundable-line/index.ts"
+    },
+    {
+      "name": "IkasRefundableLines",
+      "kind": "type",
+      "domain": "order",
+      "properties": [
+        {
+          "name": "orderLineItems",
+          "type": "IkasRefundableLine[]",
+          "optional": false
+        },
+        {
+          "name": "refundReasons",
+          "type": "IkasOrderRefundReason[]",
+          "optional": false
+        },
+        {
+          "name": "translations",
+          "type": "IkasOrderRefundSettingsTranslation[]",
+          "optional": false
+        }
+      ],
+      "filePath": "order/refund/refundable-lines/index.ts"
+    },
     {
       "name": "IkasOrderRefundSettings",
       "kind": "type",
@@ -7881,6 +8045,24 @@
       ],
       "filePath": "order/refund/settings/index.ts"
     },
+    {
+      "name": "IkasOrderRefundSettingsTranslation",
+      "kind": "type",
+      "domain": "order",
+      "properties": [
+        {
+          "name": "locale",
+          "type": "string",
+          "optional": false
+        },
+        {
+          "name": "returnMethodDescription",
+          "type": "string | null",
+          "optional": false
+        }
+      ],
+      "filePath": "order/refund/settings/translation/index.ts"
+    },
     {
       "name": "IkasOrderShippingLine",
       "kind": "type",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ikas/code-components-mcp",
-  "version": "2.11.0",
+  "version": "2.11.1",
   "description": "MCP server for ikas code components documentation",
   "type": "module",
   "main": "dist/index.js",