@ikas/code-components-mcp 1.4.0-beta.176 → 1.4.0-beta.177
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/storefront-api.json +67 -7
- package/data/storefront-types.json +79 -54
- package/package.json +1 -1
package/data/storefront-api.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"generatedAt": "2026-08-
|
|
2
|
+
"generatedAt": "2026-08-28T13:39:31.656Z",
|
|
3
3
|
"functions": [
|
|
4
4
|
{
|
|
5
5
|
"name": "apiListProductBrand",
|
|
@@ -101,16 +101,16 @@
|
|
|
101
101
|
},
|
|
102
102
|
{
|
|
103
103
|
"name": "apiListLoyaltyProgramPointHistory",
|
|
104
|
-
"signature": "async function apiListLoyaltyProgramPointHistory(params: ListLoyaltyProgramPointHistoryQueryParams): Promise<APIResponse<
|
|
104
|
+
"signature": "async function apiListLoyaltyProgramPointHistory(params: ListLoyaltyProgramPointHistoryQueryParams): Promise<APIResponse<IkasLoyaltyProgramPointHistory[]>>",
|
|
105
105
|
"description": "",
|
|
106
106
|
"params": [],
|
|
107
|
-
"returnType": "Promise<APIResponse<
|
|
107
|
+
"returnType": "Promise<APIResponse<IkasLoyaltyProgramPointHistory[]>>",
|
|
108
108
|
"categories": [],
|
|
109
109
|
"related": [],
|
|
110
110
|
"isAsync": true,
|
|
111
111
|
"isClass": false,
|
|
112
112
|
"parameterTypes": [
|
|
113
|
-
"
|
|
113
|
+
"IkasLoyaltyProgramPointHistory"
|
|
114
114
|
]
|
|
115
115
|
},
|
|
116
116
|
{
|
|
@@ -3085,6 +3085,35 @@
|
|
|
3085
3085
|
"IkasOrderGiftPackageLine"
|
|
3086
3086
|
]
|
|
3087
3087
|
},
|
|
3088
|
+
{
|
|
3089
|
+
"name": "getIkasOrderGiftCardTotalPrice",
|
|
3090
|
+
"displayName": "getGiftCardTotalPrice",
|
|
3091
|
+
"signature": "function getIkasOrderGiftCardTotalPrice(order: IkasOrder): number",
|
|
3092
|
+
"description": "Returns the total amount covered by the gift cards (and store credits) applied to the order or cart.\n\nThis is a derived value, the API does not return it: it sums `amount` over `order.giftCardLines`.\nSubtract it from `order.totalFinalPrice` to get the amount still due.",
|
|
3093
|
+
"params": [
|
|
3094
|
+
{
|
|
3095
|
+
"name": "order",
|
|
3096
|
+
"description": "- The IkasOrder or IkasCart holding the gift card lines"
|
|
3097
|
+
}
|
|
3098
|
+
],
|
|
3099
|
+
"returns": "The summed gift card amount, or 0 when no gift card is applied",
|
|
3100
|
+
"returnType": "number",
|
|
3101
|
+
"example": "```typescript\nimport { getIkasOrderGiftCardTotalPrice } from \"@ikas/bp-storefront\";\n\nconst giftCardTotal = getIkasOrderGiftCardTotalPrice(cart);\nconst remainingPrice = cart.totalFinalPrice - giftCardTotal;\n```",
|
|
3102
|
+
"categories": [
|
|
3103
|
+
"Order",
|
|
3104
|
+
"Cart"
|
|
3105
|
+
],
|
|
3106
|
+
"related": [
|
|
3107
|
+
"removeGiftCardLine",
|
|
3108
|
+
"saveCouponCode"
|
|
3109
|
+
],
|
|
3110
|
+
"isAsync": false,
|
|
3111
|
+
"isClass": false,
|
|
3112
|
+
"parameterTypes": [
|
|
3113
|
+
"IkasOrderGiftCardTotalPrice",
|
|
3114
|
+
"IkasOrder"
|
|
3115
|
+
]
|
|
3116
|
+
},
|
|
3088
3117
|
{
|
|
3089
3118
|
"name": "getIkasOrderDistinctItemCount",
|
|
3090
3119
|
"displayName": "getDistinctItemCount",
|
|
@@ -13168,6 +13197,37 @@
|
|
|
13168
13197
|
"IkasCartOperationResult"
|
|
13169
13198
|
]
|
|
13170
13199
|
},
|
|
13200
|
+
{
|
|
13201
|
+
"name": "removeGiftCardLine",
|
|
13202
|
+
"signature": "async function removeGiftCardLine(cart: IkasCart, giftCardId?: string | null): Promise<IkasCartOperationResult>",
|
|
13203
|
+
"description": "Remove a gift card (or store credit) line from the cart.\n\nGift cards are applied through `saveCouponCode` with the gift card code, and the applied\ncards are listed on `cart.giftCardLines`. Pass the `giftCardId` of the line to remove; when\nomitted, every gift card line is removed from the cart.",
|
|
13204
|
+
"params": [
|
|
13205
|
+
{
|
|
13206
|
+
"name": "cart",
|
|
13207
|
+
"description": "- The cart object"
|
|
13208
|
+
},
|
|
13209
|
+
{
|
|
13210
|
+
"name": "giftCardId",
|
|
13211
|
+
"description": "- The gift card to remove, or null/undefined to remove all of them"
|
|
13212
|
+
}
|
|
13213
|
+
],
|
|
13214
|
+
"returns": "Result with success flag",
|
|
13215
|
+
"returnType": "Promise<IkasCartOperationResult>",
|
|
13216
|
+
"example": "```typescript\nimport { cartStore, removeGiftCardLine } from \"@ikas/bp-storefront\";\n\nasync function handleRemoveGiftCard(giftCardId: string) {\n if (!cartStore.cart) return;\n\n const result = await removeGiftCardLine(cartStore.cart, giftCardId);\n if (result.success) {\n showToast(\"Gift card removed\");\n }\n}\n```",
|
|
13217
|
+
"categories": [
|
|
13218
|
+
"Cart"
|
|
13219
|
+
],
|
|
13220
|
+
"related": [
|
|
13221
|
+
"saveCouponCode",
|
|
13222
|
+
"getIkasOrderGiftCardTotalPrice"
|
|
13223
|
+
],
|
|
13224
|
+
"isAsync": true,
|
|
13225
|
+
"isClass": false,
|
|
13226
|
+
"parameterTypes": [
|
|
13227
|
+
"IkasCart",
|
|
13228
|
+
"IkasCartOperationResult"
|
|
13229
|
+
]
|
|
13230
|
+
},
|
|
13171
13231
|
{
|
|
13172
13232
|
"name": "getCart",
|
|
13173
13233
|
"signature": "async function getCart(): Promise<void>",
|
|
@@ -14435,17 +14495,17 @@
|
|
|
14435
14495
|
{
|
|
14436
14496
|
"name": "cs_listLoyaltyProgramPointHistory",
|
|
14437
14497
|
"displayName": "listLoyaltyProgramPointHistory",
|
|
14438
|
-
"signature": "async function cs_listLoyaltyProgramPointHistory(customerStore: IkasCustomerStore, params: ListLoyaltyProgramPointHistoryQueryParams): Promise<
|
|
14498
|
+
"signature": "async function cs_listLoyaltyProgramPointHistory(customerStore: IkasCustomerStore, params: ListLoyaltyProgramPointHistoryQueryParams): Promise<IkasLoyaltyProgramPointHistory[] | undefined>",
|
|
14439
14499
|
"description": "",
|
|
14440
14500
|
"params": [],
|
|
14441
|
-
"returnType": "Promise<
|
|
14501
|
+
"returnType": "Promise<IkasLoyaltyProgramPointHistory[] | undefined>",
|
|
14442
14502
|
"categories": [],
|
|
14443
14503
|
"related": [],
|
|
14444
14504
|
"isAsync": true,
|
|
14445
14505
|
"isClass": false,
|
|
14446
14506
|
"parameterTypes": [
|
|
14447
14507
|
"IkasCustomerStore",
|
|
14448
|
-
"
|
|
14508
|
+
"IkasLoyaltyProgramPointHistory"
|
|
14449
14509
|
]
|
|
14450
14510
|
},
|
|
14451
14511
|
{
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"generatedAt": "2026-08-
|
|
2
|
+
"generatedAt": "2026-08-28T13:39:31.696Z",
|
|
3
3
|
"types": [
|
|
4
4
|
{
|
|
5
5
|
"name": "TextElementTagTypes",
|
|
@@ -2467,6 +2467,7 @@
|
|
|
2467
2467
|
"findExistingCartItemWithProduct",
|
|
2468
2468
|
"saveCouponCode",
|
|
2469
2469
|
"removeCouponCode",
|
|
2470
|
+
"removeGiftCardLine",
|
|
2470
2471
|
"setCart"
|
|
2471
2472
|
]
|
|
2472
2473
|
},
|
|
@@ -5370,16 +5371,6 @@
|
|
|
5370
5371
|
"type": "number",
|
|
5371
5372
|
"optional": false
|
|
5372
5373
|
},
|
|
5373
|
-
{
|
|
5374
|
-
"name": "baseAmount",
|
|
5375
|
-
"type": "number | null",
|
|
5376
|
-
"optional": false
|
|
5377
|
-
},
|
|
5378
|
-
{
|
|
5379
|
-
"name": "baseQuantity",
|
|
5380
|
-
"type": "number | null",
|
|
5381
|
-
"optional": false
|
|
5382
|
-
},
|
|
5383
5374
|
{
|
|
5384
5375
|
"name": "createdAt",
|
|
5385
5376
|
"type": "any | null",
|
|
@@ -5430,16 +5421,6 @@
|
|
|
5430
5421
|
"type": "string | null",
|
|
5431
5422
|
"optional": false
|
|
5432
5423
|
},
|
|
5433
|
-
{
|
|
5434
|
-
"name": "refundTransactionId",
|
|
5435
|
-
"type": "string | null",
|
|
5436
|
-
"optional": false
|
|
5437
|
-
},
|
|
5438
|
-
{
|
|
5439
|
-
"name": "retroactiveCalculationId",
|
|
5440
|
-
"type": "string | null",
|
|
5441
|
-
"optional": false
|
|
5442
|
-
},
|
|
5443
5424
|
{
|
|
5444
5425
|
"name": "type",
|
|
5445
5426
|
"type": "LoyaltyProgramPointHistoryTypeEnum",
|
|
@@ -5451,39 +5432,6 @@
|
|
|
5451
5432
|
"optional": false
|
|
5452
5433
|
}
|
|
5453
5434
|
],
|
|
5454
|
-
"filePath": "loyalty-program/point-history/index.ts"
|
|
5455
|
-
},
|
|
5456
|
-
{
|
|
5457
|
-
"name": "IkasLoyaltyProgramPointHistoryPaginationResponse",
|
|
5458
|
-
"kind": "type",
|
|
5459
|
-
"domain": "loyalty-program",
|
|
5460
|
-
"properties": [
|
|
5461
|
-
{
|
|
5462
|
-
"name": "count",
|
|
5463
|
-
"type": "number",
|
|
5464
|
-
"optional": false
|
|
5465
|
-
},
|
|
5466
|
-
{
|
|
5467
|
-
"name": "data",
|
|
5468
|
-
"type": "IkasLoyaltyProgramPointHistory[]",
|
|
5469
|
-
"optional": false
|
|
5470
|
-
},
|
|
5471
|
-
{
|
|
5472
|
-
"name": "hasNext",
|
|
5473
|
-
"type": "boolean",
|
|
5474
|
-
"optional": false
|
|
5475
|
-
},
|
|
5476
|
-
{
|
|
5477
|
-
"name": "limit",
|
|
5478
|
-
"type": "number",
|
|
5479
|
-
"optional": false
|
|
5480
|
-
},
|
|
5481
|
-
{
|
|
5482
|
-
"name": "page",
|
|
5483
|
-
"type": "number",
|
|
5484
|
-
"optional": false
|
|
5485
|
-
}
|
|
5486
|
-
],
|
|
5487
5435
|
"filePath": "loyalty-program/point-history/index.ts",
|
|
5488
5436
|
"relatedFunctions": [
|
|
5489
5437
|
"apiListLoyaltyProgramPointHistory",
|
|
@@ -6373,6 +6321,77 @@
|
|
|
6373
6321
|
"hasIkasOrderCustomer"
|
|
6374
6322
|
]
|
|
6375
6323
|
},
|
|
6324
|
+
{
|
|
6325
|
+
"name": "IkasOrderGiftCardLine",
|
|
6326
|
+
"kind": "type",
|
|
6327
|
+
"domain": "order",
|
|
6328
|
+
"properties": [
|
|
6329
|
+
{
|
|
6330
|
+
"name": "id",
|
|
6331
|
+
"type": "string",
|
|
6332
|
+
"optional": false
|
|
6333
|
+
},
|
|
6334
|
+
{
|
|
6335
|
+
"name": "amount",
|
|
6336
|
+
"type": "number",
|
|
6337
|
+
"optional": false
|
|
6338
|
+
},
|
|
6339
|
+
{
|
|
6340
|
+
"name": "code",
|
|
6341
|
+
"type": "string",
|
|
6342
|
+
"optional": false
|
|
6343
|
+
},
|
|
6344
|
+
{
|
|
6345
|
+
"name": "giftCardId",
|
|
6346
|
+
"type": "string",
|
|
6347
|
+
"optional": false
|
|
6348
|
+
},
|
|
6349
|
+
{
|
|
6350
|
+
"name": "type",
|
|
6351
|
+
"type": "IkasGiftCardType | null",
|
|
6352
|
+
"optional": false
|
|
6353
|
+
},
|
|
6354
|
+
{
|
|
6355
|
+
"name": "appliedTransactions",
|
|
6356
|
+
"type": "IkasOrderGiftCardLineAppliedTransaction[]",
|
|
6357
|
+
"optional": false
|
|
6358
|
+
}
|
|
6359
|
+
],
|
|
6360
|
+
"filePath": "order/gift-card-line/index.ts"
|
|
6361
|
+
},
|
|
6362
|
+
{
|
|
6363
|
+
"name": "IkasOrderGiftCardLineAppliedTransaction",
|
|
6364
|
+
"kind": "type",
|
|
6365
|
+
"domain": "order",
|
|
6366
|
+
"properties": [
|
|
6367
|
+
{
|
|
6368
|
+
"name": "id",
|
|
6369
|
+
"type": "string",
|
|
6370
|
+
"optional": false
|
|
6371
|
+
},
|
|
6372
|
+
{
|
|
6373
|
+
"name": "amount",
|
|
6374
|
+
"type": "number",
|
|
6375
|
+
"optional": false
|
|
6376
|
+
},
|
|
6377
|
+
{
|
|
6378
|
+
"name": "type",
|
|
6379
|
+
"type": "IkasTransactionType",
|
|
6380
|
+
"optional": false
|
|
6381
|
+
}
|
|
6382
|
+
],
|
|
6383
|
+
"filePath": "order/gift-card-line/index.ts"
|
|
6384
|
+
},
|
|
6385
|
+
{
|
|
6386
|
+
"name": "IkasGiftCardType",
|
|
6387
|
+
"kind": "type",
|
|
6388
|
+
"domain": "order",
|
|
6389
|
+
"unionValues": [
|
|
6390
|
+
"GIFT_CARD",
|
|
6391
|
+
"STORE_CREDIT"
|
|
6392
|
+
],
|
|
6393
|
+
"filePath": "order/gift-card-line/index.ts"
|
|
6394
|
+
},
|
|
6376
6395
|
{
|
|
6377
6396
|
"name": "IkasOrderGiftPackageLine",
|
|
6378
6397
|
"kind": "type",
|
|
@@ -6464,6 +6483,11 @@
|
|
|
6464
6483
|
"type": "string | null",
|
|
6465
6484
|
"optional": false
|
|
6466
6485
|
},
|
|
6486
|
+
{
|
|
6487
|
+
"name": "giftCardLines",
|
|
6488
|
+
"type": "IkasOrderGiftCardLine[] | null",
|
|
6489
|
+
"optional": false
|
|
6490
|
+
},
|
|
6467
6491
|
{
|
|
6468
6492
|
"name": "giftPackageLines",
|
|
6469
6493
|
"type": "IkasOrderGiftPackageLine[] | null",
|
|
@@ -6577,6 +6601,7 @@
|
|
|
6577
6601
|
],
|
|
6578
6602
|
"filePath": "order/index.ts",
|
|
6579
6603
|
"relatedFunctions": [
|
|
6604
|
+
"getIkasOrderGiftCardTotalPrice",
|
|
6580
6605
|
"getIkasOrderDistinctItemCount",
|
|
6581
6606
|
"getIkasOrderTotalItemCount",
|
|
6582
6607
|
"getIkasOrderDisplayedPackages",
|