@scayle/storefront-core 8.15.1 → 8.17.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scayle/storefront-core
 
+## 8.17.0
+
+### Minor Changes
+
+- Fix return type of `RpcMethodCall` to reflect that it returns a `Promise<TResult>` instead of `TResult`. This change emphasizes that `callRpc` in `RpcContext` is indeed an asynchronous operation.
+
+### Patch Changes
+
+- Ensure that `pricePromotionKey` set in the right place when calling the deletion wishlist item operation of SAPI.
+
+## 8.16.0
+
 ## 8.15.1
 
 ### Patch Changes
@@ -200,12 +212,12 @@ To get the default campaign key, you can call the RPC method:
 ```typescript
 // Before
 async function rpcMethod(context) {
-  const campaignKey = { context };
+  const campaignKey = { context }
   // ...
 }
 // After
 async function rpcMethod(context) {
-  const campaignKey = await context.callRpc?.("getCampaignKey");
+  const campaignKey = await context.callRpc?.('getCampaignKey')
   // ...
 }
 ```
@@ -394,43 +406,43 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
 
     ```ts
     const BadgeLabel = {
-      NEW: "new",
-      SOLD_OUT: "sold_out",
-      ONLINE_EXCLUSIVE: "online_exclusive",
-      SUSTAINABLE: "sustainable",
-      PREMIUM: "premium",
-      DEFAULT: "",
-    } as const;
+      NEW: 'new',
+      SOLD_OUT: 'sold_out',
+      ONLINE_EXCLUSIVE: 'online_exclusive',
+      SUSTAINABLE: 'sustainable',
+      PREMIUM: 'premium',
+      DEFAULT: '',
+    } as const
 
     type BadgeLabelParamsKeys =
-      | "isNew"
-      | "isSoldOut"
-      | "isOnlineOnly"
-      | "isSustainable"
-      | "isPremium";
-    type BadgeLabelParams = Partial<Record<BadgeLabelParamsKeys, boolean>>;
+      | 'isNew'
+      | 'isSoldOut'
+      | 'isOnlineOnly'
+      | 'isSustainable'
+      | 'isPremium'
+    type BadgeLabelParams = Partial<Record<BadgeLabelParamsKeys, boolean>>
 
     const getBadgeLabel = (params: BadgeLabelParams = {}): string => {
       if (!params) {
-        return BadgeLabel.DEFAULT;
+        return BadgeLabel.DEFAULT
       }
       const { isNew, isSoldOut, isOnlineOnly, isSustainable, isPremium } =
-        params;
+        params
 
       if (isNew) {
-        return BadgeLabel.NEW;
+        return BadgeLabel.NEW
       } else if (isSoldOut) {
-        return BadgeLabel.SOLD_OUT;
+        return BadgeLabel.SOLD_OUT
       } else if (isOnlineOnly) {
-        return BadgeLabel.ONLINE_EXCLUSIVE;
+        return BadgeLabel.ONLINE_EXCLUSIVE
       } else if (isSustainable) {
-        return BadgeLabel.SUSTAINABLE;
+        return BadgeLabel.SUSTAINABLE
       } else if (isPremium) {
-        return BadgeLabel.PREMIUM;
+        return BadgeLabel.PREMIUM
       } else {
-        return BadgeLabel.DEFAULT;
+        return BadgeLabel.DEFAULT
       }
-    };
+    }
     ```
 
 - **\[💥 BREAKING\]** We've standardized our configuration to use `sapi` (Storefront API) throughout the codebase, replacing the deprecated `bapi` keyword. This change improves clarity and consistency by removing the `initBapi` function, replacing the `bapiClient` property with `sapiClient` within the `RPCContext`, and updating all code references accordingly. `BapiConfig` is not exported anymore and has been superseded by `SapiConfig`.
@@ -446,15 +458,15 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
         storefront: {
           // ...
           bapi: {
-            host: "...",
-            token: "...",
+            host: '...',
+            token: '...',
           },
           // ...
         },
         // ...
       },
       // ...
-    };
+    }
     ```
 
   - _Legacy Environment Variables:_
@@ -474,15 +486,15 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
         storefront: {
           // ...
           sapi: {
-            host: "...",
-            token: "...",
+            host: '...',
+            token: '...',
           },
           // ...
         },
         // ...
       },
       // ...
-    };
+    }
     ```
 
   - _New Environment Variables:_
@@ -500,19 +512,19 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
 
     ```ts
     const { data, fetching, fetch, error, status } = useUser(
-      "getUser"
+      'getUser',
       // ...
-    );
-    data.value.user.authentication.storefrontAccessToken;
+    )
+    data.value.user.authentication.storefrontAccessToken
     ```
 
   - _Current Usage of dedicated `getAccessToken` RPC method:_
 
     ```ts
     const { data: accessToken } = useRpc(
-      "getAccessToken"
+      'getAccessToken',
       // ...
-    );
+    )
     ```
 
 - **\[💥 BREAKING\]** We've enhanced security for basket and wishlist keys by switching the default hashing algorithm from MD5 to the more robust SHA256.
@@ -535,7 +547,7 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
         // ...
       },
       // ...
-    });
+    })
     ```
 
 - **\[💥 BREAKING\]** The attribute `loginShopId` is removed from the `ShopUser` interface as the shop now uses session cookies.
@@ -544,23 +556,23 @@ See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/develop
   - _Previous Usage of `searchProducts` RPC method:_
 
     ```ts
-    const getSearchSuggestionsRpc = useRpcCall("searchProducts");
+    const getSearchSuggestionsRpc = useRpcCall('searchProducts')
 
     data.value = await searchProducts({
       term: String(searchQuery.value),
       ...params,
-    });
+    })
     ```
 
   - _Current Usage of `getSearchSuggestions` RPC method:_
 
     ```ts
-    const getSearchSuggestionsRpc = useRpcCall("getSearchSuggestions");
+    const getSearchSuggestionsRpc = useRpcCall('getSearchSuggestions')
 
     data.value = await getSearchSuggestionsRpc({
       term: String(searchQuery.value),
       ...params,
-    });
+    })
     ```
 
 - **\[💥 BREAKING\]** Improved basket updating: Adding an item to your basket with a reduced quantity will now correctly update the basket contents.

package/dist/index.d.ts

@@ -67,5 +67,5 @@ export type RpcMethodParameters<N extends RpcMethodName> = Parameters<RpcMethod<
  * @template N The name of the RPC method.
  */
 export type RpcMethodReturnType<N extends RpcMethodName> = ReturnType<RpcMethod<N>>;
-export type RpcMethodCall = <N extends RpcMethodName, P extends RpcMethodParameters<N>, TResult extends Exclude<Awaited<RpcMethodReturnType<N>>, Response>>(...args: P extends RpcContext ? [N] : [N, P]) => TResult;
+export type RpcMethodCall = <N extends RpcMethodName, P extends RpcMethodParameters<N>, TResult extends Exclude<Awaited<RpcMethodReturnType<N>>, Response>>(...args: P extends RpcContext ? [N] : [N, P]) => Promise<TResult>;
 export { ExistingItemHandling, AddToBasketFailureKind, UpdateBasketItemFailureKind, AddToWishlistFailureKind, PromotionEffectType, FilterTypes, APISortOption, APISortOrder, type ProductSortConfig, } from '@scayle/storefront-api';

package/dist/rpc/methods/checkout/checkout.mjs

@@ -36,7 +36,7 @@ export const getCheckoutToken = async function getCheckoutToken2(jwtPayload = {}
     carrier,
     basketId: context.basketKey,
     campaignKey
-  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.15.1"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.17.0"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
   return {
     accessToken: refreshedAccessToken,
     checkoutJwt

package/dist/rpc/methods/wishlist.mjs

@@ -20,13 +20,15 @@ export const getWishlist = async function getWishlist2(options, context) {
   }
   const { sapiClient, wishlistKey } = context;
   const campaignKey = await context.callRpc?.("getCampaignKey");
-  const resolvedWith = getWithParams({ with: options }, context);
+  const { pricePromotionKey, ...resolvedWith } = getWithParams({
+    with: options
+  }, context);
   return await mapSAPIFetchErrorToResponse(sapiClient.wishlist.get)(
     wishlistKey,
     {
       with: resolvedWith,
       campaignKey,
-      pricePromotionKey: resolvedWith?.pricePromotionKey ?? ""
+      pricePromotionKey: pricePromotionKey ?? ""
     }
   );
 };
@@ -41,8 +43,7 @@ export const addItemToWishlist = async function addItemToWishlist2(options, cont
   const { sapiClient, wishlistKey } = context;
   const campaignKey = await context.callRpc?.("getCampaignKey");
   const { productId, variantId } = options;
-  const resolvedWith = getWithParams(options, context);
-  const pricePromotionKey = resolvedWith?.pricePromotionKey ?? "";
+  const { pricePromotionKey, ...resolvedWith } = getWithParams(options, context);
   if (!productId && !variantId) {
     return new ErrorResponse(
       HttpStatusCode.BAD_REQUEST,
@@ -56,7 +57,7 @@ export const addItemToWishlist = async function addItemToWishlist2(options, cont
     {
       with: resolvedWith,
       campaignKey,
-      pricePromotionKey
+      pricePromotionKey: pricePromotionKey ?? ""
     }
   );
   if (result.type === "success") {
@@ -77,13 +78,14 @@ export const removeItemFromWishlist = async function removeItemFromWishlist2(opt
   }
   const { sapiClient, wishlistKey } = context;
   const campaignKey = await context.callRpc?.("getCampaignKey");
-  const resolvedWith = getWithParams(options, context);
+  const { pricePromotionKey, ...resolvedWith } = getWithParams(options, context);
   return await mapSAPIFetchErrorToResponse(sapiClient.wishlist.deleteItem)(
     wishlistKey,
     options.itemKey,
     {
       with: resolvedWith,
-      campaignKey
+      campaignKey,
+      pricePromotionKey: pricePromotionKey ?? ""
     }
   );
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.15.1",
+  "version": "8.17.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -76,7 +76,7 @@
   "devDependencies": {
     "@scayle/eslint-config-storefront": "4.5.0",
     "@types/crypto-js": "4.2.2",
-    "@types/node": "22.13.16",
+    "@types/node": "22.14.0",
     "@types/webpack-env": "1.18.8",
     "@vitest/coverage-v8": "2.1.9",
     "dprint": "0.49.1",

package/dist/helpers/product.fixture.d.ts

@@ -1,415 +0,0 @@
-export declare const product: {
-    id: number;
-    isActive: boolean;
-    isSoldOut: boolean;
-    isNew: boolean;
-    createdAt: string;
-    updatedAt: string;
-    masterKey: string;
-    referenceKey: string;
-    firstLiveAt: string;
-    attributes: {
-        color: {
-            id: number;
-            key: string;
-            label: string;
-            type: string;
-            multiSelect: boolean;
-            values: {
-                id: number;
-                label: string;
-                value: string;
-            };
-        };
-        brand: {
-            id: number;
-            key: string;
-            label: string;
-            type: string;
-            multiSelect: boolean;
-            values: {
-                id: number;
-                label: string;
-                value: string;
-            };
-        };
-        name: {
-            id: number;
-            key: string;
-            label: string;
-            type: null;
-            multiSelect: boolean;
-            values: {
-                label: string;
-            };
-        };
-    };
-    lowestPriorPrice: {
-        withTax: null;
-        relativeDifferenceToPrice: null;
-    };
-    images: {
-        hash: string;
-        attributes: {};
-    }[];
-    variants: {
-        id: number;
-        referenceKey: string;
-        firstLiveAt: string;
-        createdAt: string;
-        updatedAt: string;
-        price: {
-            currencyCode: string;
-            withTax: number;
-            withoutTax: number;
-            appliedReductions: never[];
-            recommendedRetailPrice: null;
-            tax: {
-                vat: {
-                    amount: number;
-                    rate: number;
-                };
-            };
-        };
-        stock: {
-            supplierId: number;
-            warehouseId: number;
-            quantity: number;
-            isSellableWithoutStock: boolean;
-        };
-        attributes: {
-            shopSize: {
-                id: number;
-                key: string;
-                label: string;
-                type: string;
-                multiSelect: boolean;
-                values: {
-                    id: number;
-                    label: string;
-                    value: string;
-                };
-            };
-        };
-    }[];
-    siblings: never[];
-    priceRange: {
-        min: {
-            currencyCode: string;
-            withTax: number;
-            withoutTax: number;
-            appliedReductions: never[];
-            recommendedRetailPrice: null;
-            tax: {
-                vat: {
-                    amount: number;
-                    rate: number;
-                };
-            };
-        };
-        max: {
-            currencyCode: string;
-            withTax: number;
-            withoutTax: number;
-            appliedReductions: never[];
-            recommendedRetailPrice: null;
-            tax: {
-                vat: {
-                    amount: number;
-                    rate: number;
-                };
-            };
-        };
-    };
-    categories: {
-        categoryId: number;
-        categoryName: string;
-        categorySlug: string;
-        categoryUrl: string;
-        categoryHidden: boolean;
-        categoryProperties: never[];
-    }[][];
-};
-export declare const productFromEDT: {
-    id: number;
-    isActive: boolean;
-    isSoldOut: boolean;
-    isNew: boolean;
-    createdAt: string;
-    updatedAt: string;
-    masterKey: string;
-    referenceKey: string;
-    firstLiveAt: string;
-    attributes: {
-        brand: {
-            id: number;
-            key: string;
-            label: string;
-            type: string;
-            multiSelect: boolean;
-            values: {
-                id: number;
-                label: string;
-                value: string;
-            };
-        };
-        colorDetail: {
-            id: number;
-            key: string;
-            label: string;
-            type: string;
-            multiSelect: boolean;
-            values: {
-                id: number;
-                label: string;
-                value: string;
-            }[];
-        };
-        name: {
-            id: number;
-            key: string;
-            label: string;
-            type: string;
-            multiSelect: boolean;
-            values: {
-                id: number;
-                label: string;
-                value: string;
-            };
-        };
-    };
-    lowestPriorPrice: {
-        withTax: null;
-        relativeDifferenceToPrice: null;
-    };
-    images: ({
-        hash: string;
-        attributes: {
-            imageBackground: {
-                id: number;
-                key: string;
-                label: string;
-                type: string;
-                multiSelect: boolean;
-                values: {
-                    id: number;
-                    label: string;
-                    value: string;
-                };
-            };
-            imageKind: {
-                id: number;
-                key: string;
-                label: string;
-                type: string;
-                multiSelect: boolean;
-                values: {
-                    id: number;
-                    label: string;
-                    value: string;
-                };
-            };
-            imageView: {
-                id: number;
-                key: string;
-                label: string;
-                type: string;
-                multiSelect: boolean;
-                values: {
-                    id: number;
-                    label: string;
-                    value: string;
-                };
-            };
-            imageType: {
-                id: number;
-                key: string;
-                label: string;
-                type: string;
-                multiSelect: boolean;
-                values: {
-                    id: number;
-                    label: string;
-                    value: string;
-                };
-            };
-        };
-    } | {
-        hash: string;
-        attributes: {
-            imageBackground: {
-                id: number;
-                key: string;
-                label: string;
-                type: string;
-                multiSelect: boolean;
-                values: {
-                    id: number;
-                    label: string;
-                    value: string;
-                };
-            };
-            imageKind: {
-                id: number;
-                key: string;
-                label: string;
-                type: string;
-                multiSelect: boolean;
-                values: {
-                    id: number;
-                    label: string;
-                    value: string;
-                };
-            };
-            imageType: {
-                id: number;
-                key: string;
-                label: string;
-                type: string;
-                multiSelect: boolean;
-                values: {
-                    id: number;
-                    label: string;
-                    value: string;
-                };
-            };
-            imageView?: undefined;
-        };
-    })[];
-    variants: {
-        id: number;
-        referenceKey: string;
-        firstLiveAt: string;
-        createdAt: string;
-        updatedAt: string;
-        price: {
-            currencyCode: string;
-            withTax: number;
-            withoutTax: number;
-            appliedReductions: {
-                category: string;
-                type: string;
-                amount: {
-                    relative: number;
-                    absoluteWithTax: number;
-                };
-            }[];
-            recommendedRetailPrice: null;
-            tax: {
-                vat: {
-                    amount: number;
-                    rate: number;
-                };
-            };
-        };
-        stock: {
-            supplierId: number;
-            warehouseId: number;
-            quantity: number;
-            isSellableWithoutStock: boolean;
-        };
-        attributes: {};
-        advancedAttributes: {
-            variantCrosssellings: {
-                id: number;
-                key: string;
-                label: string;
-                type: string;
-                values: {
-                    fieldSet: {
-                        value: string;
-                    }[][];
-                    groupSet: never[];
-                }[];
-            };
-        };
-        lowestPriorPrice: {
-            withTax: null;
-            relativeDifferenceToPrice: null;
-        };
-    }[];
-    siblings: never[];
-    priceRange: {
-        min: {
-            currencyCode: string;
-            withTax: number;
-            withoutTax: number;
-            appliedReductions: {
-                category: string;
-                type: string;
-                amount: {
-                    relative: number;
-                    absoluteWithTax: number;
-                };
-            }[];
-            recommendedRetailPrice: null;
-            tax: {
-                vat: {
-                    amount: number;
-                    rate: number;
-                };
-            };
-        };
-        max: {
-            currencyCode: string;
-            withTax: number;
-            withoutTax: number;
-            appliedReductions: {
-                category: string;
-                type: string;
-                amount: {
-                    relative: number;
-                    absoluteWithTax: number;
-                };
-            }[];
-            recommendedRetailPrice: null;
-            tax: {
-                vat: {
-                    amount: number;
-                    rate: number;
-                };
-            };
-        };
-    };
-    categories: {
-        categoryId: number;
-        categoryName: string;
-        categorySlug: string;
-        categoryUrl: string;
-        categoryHidden: boolean;
-        categoryProperties: never[];
-    }[][];
-};
-export declare const priceFixture: {
-    currencyCode: string;
-    withTax: number;
-    withoutTax: number;
-    appliedReductions: never[];
-    recommendedRetailPrice: null;
-    tax: {
-        vat: {
-            amount: number;
-            rate: number;
-        };
-    };
-};
-export declare const priceFixtureWithReductions: {
-    currencyCode: string;
-    withTax: number;
-    withoutTax: number;
-    appliedReductions: {
-        category: string;
-        type: string;
-        amount: {
-            relative: number;
-            absoluteWithTax: number;
-        };
-    }[];
-    recommendedRetailPrice: null;
-    tax: {
-        vat: {
-            amount: number;
-            rate: number;
-        };
-    };
-};