@ikas/code-components-mcp 1.4.0-beta.212 → 1.4.0-beta.213

package/data/storefront-api.json

@@ -1,5 +1,5 @@
 {
-  "generatedAt": "2026-10-07T09:21:22.416Z",
+  "generatedAt": "2026-10-07T09:44:31.465Z",
   "functions": [
     {
       "name": "apiListProductBrand",
@@ -3220,14 +3220,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": [
@@ -3236,7 +3236,8 @@
       ],
       "related": [
         "isIkasOrderRefundable",
-        "getIkasOrderRefundedItems"
+        "getIkasOrderRefundedItems",
+        "getIkasOrderRefundReasons"
       ],
       "isAsync": false,
       "isClass": false,
@@ -3246,6 +3247,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",
@@ -13718,6 +13902,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>",
@@ -13743,6 +13965,7 @@
         "Customer"
       ],
       "related": [
+        "createRefundRequest",
         "getOrder",
         "getOrders",
         "getOrderRefundSettings"

package/data/storefront-types.json

@@ -1,5 +1,5 @@
 {
-  "generatedAt": "2026-10-07T09:21:22.445Z",
+  "generatedAt": "2026-10-07T09:44:31.494Z",
   "types": [
     {
       "name": "TextElementTagTypes",
@@ -6625,6 +6625,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",
@@ -6634,6 +6659,12 @@
         "getIkasOrderTotalItemCount",
         "getIkasOrderDisplayedPackages",
         "getIkasOrderRefundableItems",
+        "getIkasOrderRefundReasonId",
+        "setIkasOrderRefundReasonId",
+        "getIkasOrderRefundReason",
+        "setIkasOrderRefundReason",
+        "getIkasOrderRefundReasons",
+        "getIkasOrderReturnMethodDescription",
         "isIkasOrderRefundable",
         "getIkasOrderUnfullfilledItems",
         "getIkasOrderRefundedItems",
@@ -6656,6 +6687,7 @@
         "getIkasOrderHref",
         "getIkasOrderVariantNames",
         "submitOrderTrackingForm",
+        "createRefundRequest",
         "refundOrder",
         "getOrders",
         "getOrder",
@@ -7036,6 +7068,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",
@@ -7886,6 +7938,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",
@@ -7909,6 +8073,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",
@@ -15175,7 +15357,7 @@
         },
         {
           "name": "width",
-          "type": "number",
+          "type": "number | string",
           "optional": true
         }
       ],

package/package.json

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