@scayle/storefront-core 7.64.1 → 7.64.3

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @scayle/storefront-core
 
+## 7.64.3
+
+### Patch Changes
+
+- Add support for `orderCustomData` on the basket endpoints
+- Updated dependencies
+  - @scayle/storefront-api@17.6.0
+
+## 7.64.2
+
+### Patch Changes
+
+- Add more specific return type for `getFlattenedMaterialComposition`
+
 ## 7.64.1
 
 ### Patch Changes

package/dist/helpers/advancedAttributeHelpers.d.ts

@@ -2,10 +2,18 @@ import type { FieldSet, GroupSet } from '../types';
 export declare const flattenFieldSet: (fieldSet: FieldSet) => {
     [key: string]: string | number | null | undefined;
 }[][];
+interface FlattenedMaterialComposition {
+    materialGroupName?: string;
+    values: {
+        value: string | number;
+        unit: string;
+        material: string;
+    }[];
+}
 export declare const getFlattenedMaterialComposition: (materialCompositions: Array<{
     fieldSet: FieldSet;
     groupSet: GroupSet;
-}>) => object[];
+}>) => FlattenedMaterialComposition[];
 export declare const getFlattenedAdvancedAttribute: <T>(attributeGroup: Array<{
     fieldSet: FieldSet;
     groupSet: GroupSet;
@@ -14,3 +22,4 @@ export declare const getFlattenedVariantCrosssellings: <T>(variantCrosssellings:
     fieldSet: FieldSet;
     groupSet: GroupSet;
 }>) => T[];
+export {};

package/dist/rpc/methods/basket/basket.cjs

@@ -21,7 +21,8 @@ const addItemToBasket = exports.addItemToBasket = async function addItemToBasket
   customData,
   existingItemHandling = _constants.ExistingItemHandling.AddQuantityToExisting,
   itemGroup,
-  with: _with
+  with: _with,
+  orderCustomData
 }, context) {
   if (!(0, _types.hasSession)(context)) {
     return new _errors.ErrorResponse(_constants.HttpStatusCode.BAD_REQUEST, _constants.HttpStatusMessage.BAD_REQUEST, "No Session found");
@@ -48,7 +49,8 @@ const addItemToBasket = exports.addItemToBasket = async function addItemToBasket
       includeItemsWithoutProductData: resolvedWith?.includeItemsWithoutProductData
     }
   }], {
-    skipAvailabilityCheck: false
+    skipAvailabilityCheck: false,
+    orderCustomData
   }, {
     existingItemHandling
   });
@@ -94,7 +96,8 @@ const addItemsToBasket = exports.addItemsToBasket = async function addItemsToBas
   }));
   const result = await bapiClient.basket.addOrUpdateItems(basketKey, itemsToBeAddedOrUpdated, {
     skipAvailabilityCheck: false,
-    includeItemsWithoutProductData: resolvedWith?.includeItemsWithoutProductData
+    includeItemsWithoutProductData: resolvedWith?.includeItemsWithoutProductData,
+    orderCustomData: params.orderCustomData
   }, {
     existingItemHandling: params.existingItemHandling || _constants.ExistingItemHandling.AddQuantityToExisting
   });
@@ -129,7 +132,8 @@ const getBasket = exports.getBasket = async function getBasket2(options, context
   const response = await bapiClient.basket.get(basketKey, {
     with: resolvedWith,
     campaignKey,
-    includeItemsWithoutProductData: resolvedWith.includeItemsWithoutProductData
+    includeItemsWithoutProductData: resolvedWith.includeItemsWithoutProductData,
+    orderCustomData: options?.orderCustomData
   });
   if (response.type === "failure") {
     const {
@@ -155,7 +159,8 @@ const removeItemFromBasket = exports.removeItemFromBasket = async function remov
   return await bapiClient.basket.deleteItem(basketKey, options.itemKey, {
     with: resolvedWith,
     campaignKey,
-    includeItemsWithoutProductData: resolvedWith?.includeItemsWithoutProductData
+    includeItemsWithoutProductData: resolvedWith?.includeItemsWithoutProductData,
+    orderCustomData: options.orderCustomData
   });
 };
 const clearBasket = exports.clearBasket = async function clearBasket2(context) {
@@ -175,12 +180,16 @@ const clearBasket = exports.clearBasket = async function clearBasket2(context) {
 const mergeBaskets = exports.mergeBaskets = async function mergeBaskets2({
   fromBasketKey,
   toBasketKey,
-  with: _with
+  with: _with,
+  orderCustomData
 }, context) {
   const resolvedWith = getWithParams({
     with: _with
   }, context);
-  return await (0, _user.mergeBaskets)(fromBasketKey, toBasketKey, resolvedWith, context);
+  return await (0, _user.mergeBaskets)(fromBasketKey, toBasketKey, {
+    ...resolvedWith,
+    orderCustomData
+  }, context);
 };
 function parseBasketError(response) {
   const parsedError = {

package/dist/rpc/methods/basket/basket.d.ts

@@ -2,25 +2,31 @@ import type { AddOrUpdateItemError } from '@scayle/storefront-api';
 import { ErrorResponse } from '../../../errors';
 import type { AddOrUpdateItemType, BasketResponseData, BasketWithOptions, Product, RpcContext, Variant } from '../../../types';
 import { ExistingItemHandling } from '../../../constants';
-export declare const addItemToBasket: ({ variantId, promotionId, quantity, displayData, customData, existingItemHandling, itemGroup, with: _with, }: AddOrUpdateItemType & {
+export declare const addItemToBasket: ({ variantId, promotionId, quantity, displayData, customData, existingItemHandling, itemGroup, with: _with, orderCustomData, }: AddOrUpdateItemType & {
     existingItemHandling?: ExistingItemHandling;
     with?: BasketWithOptions;
+    orderCustomData?: Record<string, unknown>;
 }, context: RpcContext) => Promise<ErrorResponse | BasketResponseData<Product, Variant>>;
 export declare const addItemsToBasket: (params: {
     items: AddOrUpdateItemType[];
     existingItemHandling: ExistingItemHandling;
     with?: BasketWithOptions;
+    orderCustomData?: Record<string, unknown>;
 }, context: RpcContext) => Promise<ErrorResponse | BasketResponseData<Product, Variant>>;
-export declare const getBasket: (options: BasketWithOptions | undefined, context: RpcContext) => Promise<ErrorResponse | BasketResponseData<Product, Variant>>;
+export declare const getBasket: (options: (BasketWithOptions & {
+    orderCustomData?: Record<string, unknown>;
+}) | undefined, context: RpcContext) => Promise<ErrorResponse | BasketResponseData<Product, Variant>>;
 export declare const removeItemFromBasket: (options: {
     itemKey: string;
     with?: BasketWithOptions;
+    orderCustomData?: Record<string, unknown>;
 }, context: RpcContext) => Promise<ErrorResponse | BasketResponseData<Product, Variant>>;
 export declare const clearBasket: (context: RpcContext) => Promise<true | ErrorResponse>;
-export declare const mergeBaskets: ({ fromBasketKey, toBasketKey, with: _with }: {
+export declare const mergeBaskets: ({ fromBasketKey, toBasketKey, with: _with, orderCustomData }: {
     fromBasketKey: string;
     toBasketKey: string;
     with?: BasketWithOptions;
+    orderCustomData?: Record<string, unknown>;
 }, context: RpcContext) => Promise<{
     type: "failure";
     statusCode: number;

package/dist/rpc/methods/basket/basket.mjs

@@ -20,7 +20,8 @@ export const addItemToBasket = async function addItemToBasket2({
   customData,
   existingItemHandling = ExistingItemHandling.AddQuantityToExisting,
   itemGroup,
-  with: _with
+  with: _with,
+  orderCustomData
 }, context) {
   if (!hasSession(context)) {
     return new ErrorResponse(
@@ -53,7 +54,8 @@ export const addItemToBasket = async function addItemToBasket2({
       }
     ],
     {
-      skipAvailabilityCheck: false
+      skipAvailabilityCheck: false,
+      orderCustomData
     },
     {
       existingItemHandling
@@ -103,7 +105,8 @@ export const addItemsToBasket = async function addItemsToBasket2(params, context
     itemsToBeAddedOrUpdated,
     {
       skipAvailabilityCheck: false,
-      includeItemsWithoutProductData: resolvedWith?.includeItemsWithoutProductData
+      includeItemsWithoutProductData: resolvedWith?.includeItemsWithoutProductData,
+      orderCustomData: params.orderCustomData
     },
     {
       existingItemHandling: params.existingItemHandling || ExistingItemHandling.AddQuantityToExisting
@@ -143,7 +146,8 @@ export const getBasket = async function getBasket2(options, context) {
   const response = await bapiClient.basket.get(basketKey, {
     with: resolvedWith,
     campaignKey,
-    includeItemsWithoutProductData: resolvedWith.includeItemsWithoutProductData
+    includeItemsWithoutProductData: resolvedWith.includeItemsWithoutProductData,
+    orderCustomData: options?.orderCustomData
   });
   if (response.type === "failure") {
     const { statusCode, message } = parseBasketError(response);
@@ -171,7 +175,8 @@ export const removeItemFromBasket = async function removeItemFromBasket2(options
   return await bapiClient.basket.deleteItem(basketKey, options.itemKey, {
     with: resolvedWith,
     campaignKey,
-    includeItemsWithoutProductData: resolvedWith?.includeItemsWithoutProductData
+    includeItemsWithoutProductData: resolvedWith?.includeItemsWithoutProductData,
+    orderCustomData: options.orderCustomData
   });
 };
 export const clearBasket = async function clearBasket2(context) {
@@ -188,7 +193,7 @@ export const clearBasket = async function clearBasket2(context) {
   context.log.debug("The basket has been cleared");
   return true;
 };
-export const mergeBaskets = async function mergeBaskets2({ fromBasketKey, toBasketKey, with: _with }, context) {
+export const mergeBaskets = async function mergeBaskets2({ fromBasketKey, toBasketKey, with: _with, orderCustomData }, context) {
   const resolvedWith = getWithParams(
     { with: _with },
     context
@@ -196,7 +201,7 @@ export const mergeBaskets = async function mergeBaskets2({ fromBasketKey, toBask
   return await mergeBasketFunction(
     fromBasketKey,
     toBasketKey,
-    resolvedWith,
+    { ...resolvedWith, orderCustomData },
     context
   );
 };

package/dist/rpc/methods/checkout/checkout.cjs

@@ -33,7 +33,7 @@ const getCheckoutToken = exports.getCheckoutToken = async function getCheckoutTo
     carrier,
     basketId: context.basketKey,
     campaignKey: context.campaignKey
-  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.64.1"}`).setProtectedHeader({
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.64.3"}`).setProtectedHeader({
     alg: "HS256",
     typ: "JWT"
   }).sign(secret);

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

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

package/dist/utils/user.cjs

@@ -12,7 +12,8 @@ const mergeBaskets = async (fromBasketKey, toBasketKey, withOptions, context) =>
   } = context;
   const fromOriginBasket = await bapiClient.basket.get(fromBasketKey, {
     with: withOptions,
-    campaignKey
+    campaignKey,
+    orderCustomData: withOptions.orderCustomData
   });
   context.log.debug(`Merging basket ${fromBasketKey} to ${toBasketKey}`);
   if (fromBasketKey === toBasketKey) {
@@ -37,7 +38,8 @@ const mergeBaskets = async (fromBasketKey, toBasketKey, withOptions, context) =>
     const mergedBasket = await bapiClient.basket.addOrUpdateItems(toBasketKey, itemsToAddOrUpdate, {
       with: withOptions,
       campaignKey,
-      includeItemsWithoutProductData: withOptions?.includeItemsWithoutProductData
+      includeItemsWithoutProductData: withOptions?.includeItemsWithoutProductData,
+      orderCustomData: withOptions.orderCustomData
     }, {
       existingItemHandling: _constants.ExistingItemHandling.AddQuantityToExisting
     });

package/dist/utils/user.d.ts

@@ -1,5 +1,7 @@
 import type { BasketWithOptions, RpcContext } from '../types';
-export declare const mergeBaskets: (fromBasketKey: string, toBasketKey: string, withOptions: BasketWithOptions, context: RpcContext) => Promise<{
+export declare const mergeBaskets: (fromBasketKey: string, toBasketKey: string, withOptions: BasketWithOptions & {
+    orderCustomData?: Record<string, unknown>;
+}, context: RpcContext) => Promise<{
     type: "failure";
     statusCode: number;
     basket: import("@scayle/storefront-api").BasketResponseData<import("@scayle/storefront-api").Product, import("@scayle/storefront-api").Variant>;

package/dist/utils/user.mjs

@@ -3,7 +3,8 @@ export const mergeBaskets = async (fromBasketKey, toBasketKey, withOptions, cont
   const { bapiClient, campaignKey } = context;
   const fromOriginBasket = await bapiClient.basket.get(fromBasketKey, {
     with: withOptions,
-    campaignKey
+    campaignKey,
+    orderCustomData: withOptions.orderCustomData
   });
   context.log.debug(`Merging basket ${fromBasketKey} to ${toBasketKey}`);
   if (fromBasketKey === toBasketKey) {
@@ -28,7 +29,8 @@ export const mergeBaskets = async (fromBasketKey, toBasketKey, withOptions, cont
       {
         with: withOptions,
         campaignKey,
-        includeItemsWithoutProductData: withOptions?.includeItemsWithoutProductData
+        includeItemsWithoutProductData: withOptions?.includeItemsWithoutProductData,
+        orderCustomData: withOptions.orderCustomData
       },
       {
         existingItemHandling: ExistingItemHandling.AddQuantityToExisting

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "7.64.1",
+  "version": "7.64.3",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -59,7 +59,7 @@
     "test:ci": "vitest --run --passWithNoTests --coverage --reporter=default --reporter=junit"
   },
   "dependencies": {
-    "@scayle/storefront-api": "17.5.0",
+    "@scayle/storefront-api": "17.6.0",
     "crypto-js": "^4.2.0",
     "hookable": "^5.5.3",
     "jose": "^5.6.3",
@@ -72,13 +72,13 @@
   "devDependencies": {
     "@scayle/eslint-config-storefront": "4.3.0",
     "@types/crypto-js": "4.2.2",
-    "@types/node": "20.14.15",
+    "@types/node": "20.16.1",
     "@types/webpack-env": "1.18.5",
     "@vitest/coverage-v8": "2.0.5",
     "dprint": "0.47.2",
-    "eslint": "9.9.0",
+    "eslint": "9.9.1",
     "eslint-formatter-gitlab": "5.1.0",
-    "publint": "0.2.9",
+    "publint": "0.2.10",
     "rimraf": "6.0.1",
     "ts-node": "10.9.2",
     "typescript": "5.5.4",