@ikas/code-components-mcp 2.10.0 → 2.11.0

package/data/storefront-api.json

@@ -1,5 +1,5 @@
 {
-  "generatedAt": "2026-10-07T14:11:43.016Z",
+  "generatedAt": "2026-10-14T08:11:46.617Z",
   "functions": [
     {
       "name": "apiListProductBrand",
@@ -13507,6 +13507,171 @@
         "IkasCustomerStore"
       ]
     },
+    {
+      "name": "milesSmilesBind",
+      "signature": "async function milesSmilesBind(customerStore: IkasCustomerStore, redirect?: string | null): Promise<MilesSmilesBindResult>",
+      "description": "Start the Turkish Airlines Miles&Smiles account bind flow for the logged-in customer.\nOpens the THY login page in a popup; once THY confirms, the browser is sent to the\nikas bind callback and lands back on `redirect` with `milesSmilesStatus` query params\n(see handleMilesSmilesBind). Binding is required before miles can be spent at checkout.",
+      "params": [
+        {
+          "name": "customerStore",
+          "description": "- The customer store instance (customer must be logged in)"
+        },
+        {
+          "name": "redirect",
+          "description": "- Relative store path to land on after bind, e.g. \"/account\" or \"/checkout?id=...&step=payment\""
+        }
+      ],
+      "returns": "`isSuccess: true` when the bind hand-off started; otherwise an `errorCode`\nsuch as \"AUTHORIZATION_REQUIRED\" or \"MILES_SMILES_LOGIN_CANCELLED_OR_FAILED\"",
+      "returnType": "Promise<MilesSmilesBindResult>",
+      "example": "```typescript\nimport { customerStore, milesSmilesBind } from \"@ikas/bp-storefront\";\n\nasync function onLinkClick() {\n  const result = await milesSmilesBind(customerStore, \"/account\");\n  if (!result.isSuccess) showToast(result.errorCode || \"UNEXPECTED_ERROR\");\n}\n```",
+      "categories": [
+        "Customer",
+        "Miles&Smiles"
+      ],
+      "related": [
+        "handleMilesSmilesBind",
+        "getMilesSmilesLink",
+        "unlinkMilesSmiles",
+        "getMilesSmilesDetails"
+      ],
+      "isAsync": true,
+      "isClass": false,
+      "parameterTypes": [
+        "IkasCustomerStore"
+      ]
+    },
+    {
+      "name": "handleMilesSmilesBind",
+      "signature": "function handleMilesSmilesBind(clear: boolean = true): HandleMilesSmilesBindReturnType | null",
+      "description": "Read the Miles&Smiles bind result from the current URL after THY redirects back\n(`?milesSmilesStatus=success` or `?milesSmilesStatus=fail&milesSmilesError=CODE`).\nCall this on the landing page (account or checkout). The params are removed from the\nURL so a refresh does not repeat the same message.",
+      "params": [
+        {
+          "name": "clear",
+          "description": "- Remove the params from the URL with history.replaceState (default: true)"
+        }
+      ],
+      "returns": "The landing result, or null when the URL carries no bind result",
+      "returnType": "HandleMilesSmilesBindReturnType | null",
+      "example": "```typescript\nimport { handleMilesSmilesBind } from \"@ikas/bp-storefront\";\n\nuseEffect(() => {\n  const result = handleMilesSmilesBind();\n  if (result?.status === \"success\") showToast(\"Miles&Smiles account linked\");\n  if (result?.status === \"fail\") showToast(result.errorCode || \"Bind failed\");\n}, []);\n```",
+      "categories": [
+        "Customer",
+        "Miles&Smiles"
+      ],
+      "related": [
+        "milesSmilesBind",
+        "getMilesSmilesLink"
+      ],
+      "isAsync": false,
+      "isClass": false
+    },
+    {
+      "name": "getMilesSmilesLink",
+      "signature": "async function getMilesSmilesLink(customerStore: IkasCustomerStore): Promise<APIResponse<ExternalAccountLink | null>>",
+      "description": "Get the customer's durable Miles&Smiles link (TK membership number and link date).\nA link does not guarantee a live checkout session; when getMilesSmilesDetails returns\nMILES_SMILES_LOGIN_REQUIRED, run milesSmilesBind again.",
+      "params": [
+        {
+          "name": "customerStore",
+          "description": "- The customer store instance"
+        }
+      ],
+      "returns": "API response whose data is the link, or null when not linked",
+      "returnType": "Promise<APIResponse<ExternalAccountLink | null>>",
+      "example": "```typescript\nimport { customerStore, getMilesSmilesLink } from \"@ikas/bp-storefront\";\n\nconst response = await getMilesSmilesLink(customerStore);\nconst tkNumber = response.data?.externalId;\n```",
+      "categories": [
+        "Customer",
+        "Miles&Smiles"
+      ],
+      "related": [
+        "milesSmilesBind",
+        "unlinkMilesSmiles"
+      ],
+      "isAsync": true,
+      "isClass": false,
+      "parameterTypes": [
+        "IkasCustomerStore"
+      ]
+    },
+    {
+      "name": "unlinkMilesSmiles",
+      "signature": "async function unlinkMilesSmiles(customerStore: IkasCustomerStore): Promise<APIResponse<boolean>>",
+      "description": "Remove the customer's Miles&Smiles link. Also clears the server-side checkout\nsession token, so miles cannot be spent until the customer binds again.",
+      "params": [
+        {
+          "name": "customerStore",
+          "description": "- The customer store instance"
+        }
+      ],
+      "returns": "API response whose data is true on success",
+      "returnType": "Promise<APIResponse<boolean>>",
+      "example": "```typescript\nimport { customerStore, unlinkMilesSmiles } from \"@ikas/bp-storefront\";\n\nconst response = await unlinkMilesSmiles(customerStore);\nif (response.isSuccess) showToast(\"Miles&Smiles link removed\");\n```",
+      "categories": [
+        "Customer",
+        "Miles&Smiles"
+      ],
+      "related": [
+        "milesSmilesBind",
+        "getMilesSmilesLink"
+      ],
+      "isAsync": true,
+      "isClass": false,
+      "parameterTypes": [
+        "IkasCustomerStore"
+      ]
+    },
+    {
+      "name": "getMilesSmilesDetails",
+      "signature": "async function getMilesSmilesDetails(customerStore: IkasCustomerStore): Promise<APIResponse<MilesSmilesDetailsResponse | undefined>>",
+      "description": "Get the Miles&Smiles balance and member details for the payment step.\nRequires a recent bind; MILES_SMILES_LOGIN_REQUIRED means the short-lived session\nexpired and milesSmilesBind should be run again. MILES_SMILES_NOT_ENABLED and\nPAYMENT_GATEWAY_NOT_FOUND mean the Miles UI should be hidden.",
+      "params": [
+        {
+          "name": "customerStore",
+          "description": "- The customer store instance"
+        }
+      ],
+      "returns": "API response whose data holds availableMiles, memberId, firstName and lastName",
+      "returnType": "Promise<APIResponse<MilesSmilesDetailsResponse | undefined>>",
+      "example": "```typescript\nimport { customerStore, getMilesSmilesDetails } from \"@ikas/bp-storefront\";\n\nconst response = await getMilesSmilesDetails(customerStore);\nif (response.errorCodes.includes(\"MILES_SMILES_LOGIN_REQUIRED\")) {\n  await milesSmilesBind(customerStore, window.location.pathname + window.location.search);\n} else if (response.data) {\n  console.log(\"Available miles:\", response.data.availableMiles);\n}\n```",
+      "categories": [
+        "Customer",
+        "Miles&Smiles"
+      ],
+      "related": [
+        "milesSmilesBind",
+        "getMilesSmilesLink"
+      ],
+      "isAsync": true,
+      "isClass": false,
+      "parameterTypes": [
+        "IkasCustomerStore"
+      ]
+    },
+    {
+      "name": "isMilesSmilesTransaction",
+      "signature": "function isMilesSmilesTransaction(transaction: IkasOrderTransaction): boolean",
+      "description": "Check whether an order transaction is the Miles&Smiles leg of a multi-tender payment.\nSuch rows are written on the synthetic MILES_SMILES gateway and are not refundable from the storefront.",
+      "params": [
+        {
+          "name": "transaction",
+          "description": "- The order transaction to check"
+        }
+      ],
+      "returns": "True when the transaction is a Miles&Smiles SALE",
+      "returnType": "boolean",
+      "example": "```typescript\nimport { isMilesSmilesTransaction } from \"@ikas/bp-storefront\";\n\nconst label = isMilesSmilesTransaction(tx) ? \"Miles&Smiles\" : tx.paymentGatewayName;\n```",
+      "categories": [
+        "Customer",
+        "Orders",
+        "Miles&Smiles"
+      ],
+      "related": [
+        "getOrderTransactions"
+      ],
+      "isAsync": false,
+      "isClass": false,
+      "parameterTypes": [
+        "IkasOrderTransaction"
+      ]
+    },
     {
       "name": "deleteCustomerAddress",
       "signature": "async function deleteCustomerAddress(customerStore: IkasCustomerStore, address: IkasCustomerAddress): Promise<boolean>",

package/data/storefront-types.json

@@ -1,5 +1,5 @@
 {
-  "generatedAt": "2026-10-07T14:11:43.044Z",
+  "generatedAt": "2026-10-14T08:11:46.690Z",
   "types": [
     {
       "name": "TextElementTagTypes",
@@ -8078,6 +8078,7 @@
       "relatedFunctions": [
         "getOrderTransactionFormattedAmount",
         "getOrderTransactionPaymentMethodTranslation",
+        "isMilesSmilesTransaction",
         "getOrderTransactions"
       ]
     },
@@ -8319,6 +8320,12 @@
           "type": "string | null",
           "optional": false
         },
+        {
+          "name": "milesSmilesEnabled",
+          "type": "boolean | null",
+          "optional": true,
+          "description": "True when Miles&Smiles can be redeemed on this (TK_PAY) gateway."
+        },
         {
           "name": "name",
           "type": "string",

package/package.json

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