@scayle/storefront-core 8.5.0 → 8.6.1

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @scayle/storefront-core
 
+## 8.6.1
+
+### Patch Changes
+
+- Remove duplicated export of `PromotionEffectType`. It was previously defined within `@scayle/storefront-core` and reexported from `@scayle/storefront-api`. Now only the the object literal and type from `@scayle/storefront-api` are exported.
+
+## 8.6.0
+
+### Minor Changes
+
+- Reexport `ExistingItemHandling`,`AddToBasketFailureKind`,`UpdateBasketItemFailureKind`,`AddToWishlistFailureKind`,`PromotionEffectType` and `FilterTypes` from `@scayle/storefront-api`, instead of redefining them in `@scayle/storefront-core`
+- Remove `package.json` and `server` exports.
+- The CommonJS export format will be removed in this version. All exports are provided through ES Modules (`import`/`export`) exclusively
+
+  This change will primarily affect users who are currently using the CommonJS format of this package. To update your code, you should replace `require` statements with `import` statements and update your build tooling if necessary.
+
+  ```TypeScript
+  const { ... } = require('@scayle/storefront-core');
+
+  // will become
+
+  import { ... } from '@scayle/storefront-core';
+  ```
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-api@18.0.0
+
 ## 8.5.0
 
 ### Minor Changes

package/dist/constants/index.d.ts

@@ -1,6 +1,5 @@
 export * from './withParameters';
 export * from './cache';
-export * from './basket';
 export * from './httpStatus';
 export * from './sorting';
 export * from './product';

package/dist/constants/index.mjs

@@ -1,6 +1,5 @@
 export * from "./withParameters.mjs";
 export * from "./cache.mjs";
-export * from "./basket.mjs";
 export * from "./httpStatus.mjs";
 export * from "./sorting.mjs";
 export * from "./product.mjs";

package/dist/constants/promotion.d.ts

@@ -1,8 +1,2 @@
-import type { PromotionEffect } from '../types';
 export declare const PROMOTION_PAGE_DEFAULT = 1;
 export declare const PROMOTION_PER_PAGE_DEFAULT = 100;
-export declare const PromotionEffectType: {
-    readonly AUTOMATIC_DISCOUNT: "automatic_discount";
-    readonly BUY_X_GET_Y: "buy_x_get_y";
-};
-export type PromotionEffectType = PromotionEffect['type'];

package/dist/constants/promotion.mjs

@@ -1,6 +1,2 @@
 export const PROMOTION_PAGE_DEFAULT = 1;
 export const PROMOTION_PER_PAGE_DEFAULT = 100;
-export const PromotionEffectType = {
-  AUTOMATIC_DISCOUNT: "automatic_discount",
-  BUY_X_GET_Y: "buy_x_get_y"
-};

package/dist/helpers/filterHelper.d.ts

@@ -36,32 +36,32 @@ export declare const getActiveFilters: (filters: Record<string, any>, activeFilt
 export declare const groupFiltersByKey: (filters: TransformedFilter[]) => [string, TransformedFilter[]][];
 export declare const transformMinAndMaxPriceToFilter: (prices: (CentAmount | undefined)[]) => any;
 export declare const transformSortToFilter: (sort: string) => {
-    by: import("@scayle/storefront-api").APISortOption;
-    direction: import("@scayle/storefront-api").APISortOrder;
+    by: "price";
+    direction: "desc";
     name: "topseller";
     query: "topseller";
 } | {
-    by: import("@scayle/storefront-api").APISortOption;
+    by: "new";
     name: "date_newest";
     query: "date-newest";
 } | {
-    by: import("@scayle/storefront-api").APISortOption;
-    direction: import("@scayle/storefront-api").APISortOrder;
+    by: "price";
+    direction: "desc";
     name: "price_desc";
     query: "price-desc";
 } | {
-    by: import("@scayle/storefront-api").APISortOption;
-    direction: import("@scayle/storefront-api").APISortOrder;
+    by: "price";
+    direction: "asc";
     name: "price_asc";
     query: "price-asc";
 } | {
-    by: import("@scayle/storefront-api").APISortOption;
-    direction: import("@scayle/storefront-api").APISortOrder;
+    by: "reduction";
+    direction: "desc";
     name: "reduction_desc";
     query: "reduction-desc";
 } | {
-    by: import("@scayle/storefront-api").APISortOption;
-    direction: import("@scayle/storefront-api").APISortOrder;
+    by: "reduction";
+    direction: "asc";
     name: "reduction_asc";
     query: "reduction-asc";
 };

package/dist/helpers/sortingHelper.d.ts

@@ -1,64 +1,63 @@
-import { APISortOption, APISortOrder } from '@scayle/storefront-api';
 import type { Query, SortingValueKey } from '../index';
 export declare const getSortingValues: (options?: Array<SortingValueKey>) => {
     [k: string]: {
-        by: APISortOption;
-        direction: APISortOrder;
+        by: "price";
+        direction: "desc";
         name: "topseller";
         query: "topseller";
     } | {
-        by: APISortOption;
+        by: "new";
         name: "date_newest";
         query: "date-newest";
     } | {
-        by: APISortOption;
-        direction: APISortOrder;
+        by: "price";
+        direction: "desc";
         name: "price_desc";
         query: "price-desc";
     } | {
-        by: APISortOption;
-        direction: APISortOrder;
+        by: "price";
+        direction: "asc";
         name: "price_asc";
         query: "price-asc";
     } | {
-        by: APISortOption;
-        direction: APISortOrder;
+        by: "reduction";
+        direction: "desc";
         name: "reduction_desc";
         query: "reduction-desc";
     } | {
-        by: APISortOption;
-        direction: APISortOrder;
+        by: "reduction";
+        direction: "asc";
         name: "reduction_asc";
         query: "reduction-asc";
     };
 };
 export declare const getSortByValue: (query: Query, defaultSort?: SortingValueKey) => {
-    by: APISortOption;
-    direction: APISortOrder;
+    by: "price";
+    direction: "desc";
     name: "topseller";
     query: "topseller";
 } | {
-    by: APISortOption;
+    by: "new";
     name: "date_newest";
     query: "date-newest";
 } | {
-    by: APISortOption;
-    direction: APISortOrder;
+    by: "price";
+    direction: "desc";
     name: "price_desc";
     query: "price-desc";
 } | {
-    by: APISortOption;
-    direction: APISortOrder;
+    by: "price";
+    direction: "asc";
     name: "price_asc";
     query: "price-asc";
 } | {
-    by: APISortOption;
-    direction: APISortOrder;
+    by: "reduction";
+    direction: "desc";
     name: "reduction_desc";
     query: "reduction-desc";
 } | {
-    by: APISortOption;
-    direction: APISortOrder;
+    by: "reduction";
+    direction: "asc";
     name: "reduction_asc";
     query: "reduction-asc";
 };

package/dist/helpers/sortingHelper.mjs

@@ -2,37 +2,37 @@ import { APISortOption, APISortOrder } from "@scayle/storefront-api";
 import { SortName, SortQuery } from "../constants/sorting.mjs";
 const SORTING_VALUES = {
   topSeller: {
-    by: APISortOption.Price,
-    direction: APISortOrder.Descending,
+    by: APISortOption.PRICE,
+    direction: APISortOrder.DESCENDING,
     name: SortName.TOPSELLER,
     query: SortQuery.TOPSELLER
   },
   dateNewest: {
-    by: APISortOption.DateAdded,
+    by: APISortOption.DATE_ADDED,
     name: SortName.DATE_NEWEST,
     query: SortQuery.DATE_NEWEST
   },
   priceDesc: {
-    by: APISortOption.Price,
-    direction: APISortOrder.Descending,
+    by: APISortOption.PRICE,
+    direction: APISortOrder.DESCENDING,
     name: SortName.PRICE_DESC,
     query: SortQuery.PRICE_DESC
   },
   priceAsc: {
-    by: APISortOption.Price,
-    direction: APISortOrder.Ascending,
+    by: APISortOption.PRICE,
+    direction: APISortOrder.ASCENDING,
     name: SortName.PRICE_ASC,
     query: SortQuery.PRICE_ASC
   },
   reductionDesc: {
-    by: APISortOption.Reduction,
-    direction: APISortOrder.Descending,
+    by: APISortOption.REDUCTION,
+    direction: APISortOrder.DESCENDING,
     name: SortName.REDUCTION_DESC,
     query: SortQuery.REDUCTION_DESC
   },
   reductionAsc: {
-    by: APISortOption.Reduction,
-    direction: APISortOrder.Ascending,
+    by: APISortOption.REDUCTION,
+    direction: APISortOrder.ASCENDING,
     name: SortName.REDUCTION_ASC,
     query: SortQuery.REDUCTION_ASC
   }

package/dist/index.d.ts

@@ -17,4 +17,4 @@ export type RpcMethodName = Resolve<keyof RpcMethods>;
 export type RpcMethod<N extends RpcMethodName> = RpcMethods[N];
 export type RpcMethodParameters<N extends RpcMethodName> = Parameters<RpcMethod<N>>[0];
 export type RpcMethodReturnType<N extends RpcMethodName> = ReturnType<RpcMethod<N>>;
-export { APISortOption, APISortOrder, type ProductSortConfig, } from '@scayle/storefront-api';
+export { ExistingItemHandling, AddToBasketFailureKind, UpdateBasketItemFailureKind, AddToWishlistFailureKind, PromotionEffectType, FilterTypes, APISortOption, APISortOrder, type ProductSortConfig, } from '@scayle/storefront-api';

package/dist/index.mjs

@@ -7,6 +7,12 @@ export * from "./cache/index.mjs";
 export * from "./helpers/index.mjs";
 export * from "./types/index.mjs";
 export {
+  ExistingItemHandling,
+  AddToBasketFailureKind,
+  UpdateBasketItemFailureKind,
+  AddToWishlistFailureKind,
+  PromotionEffectType,
+  FilterTypes,
   APISortOption,
   APISortOrder
 } from "@scayle/storefront-api";

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

@@ -1,7 +1,7 @@
+import { ExistingItemHandling } from '@scayle/storefront-api';
 import type { AddOrUpdateItemError, UpdateBasketItemQuantity } 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, orderCustomData, }: AddOrUpdateItemType & {
     existingItemHandling?: ExistingItemHandling;
     with?: BasketWithOptions;

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

@@ -1,7 +1,7 @@
+import { ExistingItemHandling } from "@scayle/storefront-api";
 import { ErrorResponse } from "../../../errors/index.mjs";
 import { hasSession } from "../../../types/index.mjs";
 import {
-  ExistingItemHandling,
   HttpStatusCode,
   HttpStatusMessage,
   MIN_WITH_PARAMS_BASKET
@@ -19,7 +19,7 @@ export const addItemToBasket = async function addItemToBasket2({
   quantity,
   displayData,
   customData,
-  existingItemHandling = ExistingItemHandling.AddQuantityToExisting,
+  existingItemHandling = ExistingItemHandling.ADD_QUANTITY_TO_EXISTING,
   itemGroup,
   with: _with,
   orderCustomData
@@ -116,7 +116,7 @@ export const addItemsToBasket = async function addItemsToBasket2(params, context
       orderCustomData: params.orderCustomData
     },
     {
-      existingItemHandling: params.existingItemHandling || ExistingItemHandling.AddQuantityToExisting
+      existingItemHandling: params.existingItemHandling || ExistingItemHandling.ADD_QUANTITY_TO_EXISTING
     }
   );
   if (result.type === "success") {

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

@@ -35,7 +35,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"}@${"8.5.0"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.6.1"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
   return {
     accessToken: refreshedAccessToken,
     checkoutJwt

package/dist/utils/basket.mjs

@@ -1,12 +1,12 @@
 import {
   AddToBasketFailureKind,
   UpdateBasketItemFailureKind
-} from "../constants/index.mjs";
+} from "@scayle/storefront-api";
 export const wasAddedWithReducedQuantity = (errors) => {
   if (!errors) {
     return false;
   }
   return errors.every(
-    (error) => error.operation === "add" && error.kind === AddToBasketFailureKind.ItemAddedWithReducedQuantity || error.operation === "update" && error.kind === UpdateBasketItemFailureKind.ItemAddedWithReducedQuantity
+    (error) => error.operation === "add" && error.kind === AddToBasketFailureKind.ITEM_ADDED_WITH_REDUCED_QUANTITY || error.operation === "update" && error.kind === UpdateBasketItemFailureKind.ITEM_ADDED_WITH_REDUCED_QUANTITY
   );
 };

package/dist/utils/user.d.ts

@@ -4,13 +4,13 @@ export declare const mergeBaskets: (fromBasketKey: string, toBasketKey: string,
 }, context: RpcContext) => Promise<{
     type: "failure";
     statusCode: number;
-    basket: import("@scayle/storefront-api/dist/shared/storefront-api.B70Ru0Qh").f<import("@scayle/storefront-api/dist/shared/storefront-api.B70Ru0Qh").a, import("@scayle/storefront-api/dist/shared/storefront-api.B70Ru0Qh").d>;
+    basket: import("@scayle/storefront-api").BasketResponseData<import("@scayle/storefront-api").Product, import("@scayle/storefront-api").Variant>;
 } | {
     readonly type: "success";
-    readonly basket: import("@scayle/storefront-api/dist/shared/storefront-api.B70Ru0Qh").f<import("@scayle/storefront-api/dist/shared/storefront-api.B70Ru0Qh").a, import("@scayle/storefront-api/dist/shared/storefront-api.B70Ru0Qh").d>;
+    readonly basket: import("@scayle/storefront-api").BasketResponseData<import("@scayle/storefront-api").Product, import("@scayle/storefront-api").Variant>;
 } | {
     readonly type: "failure";
-    readonly basket: import("@scayle/storefront-api/dist/shared/storefront-api.B70Ru0Qh").f<import("@scayle/storefront-api/dist/shared/storefront-api.B70Ru0Qh").a, import("@scayle/storefront-api/dist/shared/storefront-api.B70Ru0Qh").d>;
+    readonly basket: import("@scayle/storefront-api").BasketResponseData<import("@scayle/storefront-api").Product, import("@scayle/storefront-api").Variant>;
     readonly errors: import("@scayle/storefront-api").AddOrUpdateItemError[];
 } | undefined>;
 export declare const mergeWishlists: (fromWishlistKey: string, toWishlistKey: string, withOptions: BasketWithOptions, context: RpcContext) => Promise<void>;

package/dist/utils/user.mjs

@@ -1,4 +1,4 @@
-import { ExistingItemHandling } from "../constants/index.mjs";
+import { ExistingItemHandling } from "@scayle/storefront-api";
 export const mergeBaskets = async (fromBasketKey, toBasketKey, withOptions, context) => {
   const { sapiClient, campaignKey } = context;
   const fromOriginBasket = await sapiClient.basket.get(fromBasketKey, {
@@ -33,7 +33,7 @@ export const mergeBaskets = async (fromBasketKey, toBasketKey, withOptions, cont
         orderCustomData: withOptions.orderCustomData
       },
       {
-        existingItemHandling: ExistingItemHandling.AddQuantityToExisting
+        existingItemHandling: ExistingItemHandling.ADD_QUANTITY_TO_EXISTING
       }
     );
     fromBasket.items.map(async (item) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.5.0",
+  "version": "8.6.1",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -11,15 +11,10 @@
   "website": "https://scayle.dev/en/storefront-guide/developer-guide/getting-started/about-storefront",
   "sideEffects": false,
   "exports": {
-    "./package.json": "./package.json",
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.mjs"
     },
-    "./server": {
-      "types": "./dist/server.d.ts",
-      "default": "./dist/server.mjs"
-    },
     "./dist/test/factories": {
       "types": "./dist/test/factories/index.d.ts",
       "default": "./dist/test/factories/index.mjs"
@@ -61,7 +56,7 @@
     "test:ci": "vitest --run --passWithNoTests --coverage --reporter=default --reporter=junit --outputFile=./coverage/junit.xml"
   },
   "dependencies": {
-    "@scayle/storefront-api": "17.18.0",
+    "@scayle/storefront-api": "18.0.0",
     "crypto-js": "^4.2.0",
     "hookable": "^5.5.3",
     "jose": "^5.6.3",
@@ -73,7 +68,7 @@
   "devDependencies": {
     "@scayle/eslint-config-storefront": "4.4.1",
     "@types/crypto-js": "4.2.2",
-    "@types/node": "22.13.2",
+    "@types/node": "22.13.4",
     "@types/webpack-env": "1.18.8",
     "@vitest/coverage-v8": "2.1.9",
     "dprint": "0.49.0",

package/dist/constants/basket.d.ts

@@ -1,24 +0,0 @@
-import type { ValuesType } from 'utility-types';
-export declare const ExistingItemHandling: {
-    readonly KeepExisting: 0;
-    readonly AddQuantityToExisting: 1;
-    readonly ReplaceExisting: 2;
-    readonly ReplaceExistingWithCombinedQuantity: 3;
-};
-export type ExistingItemHandling = ValuesType<typeof ExistingItemHandling>;
-export declare const AddToBasketFailureKind: {
-    readonly VariantAlreadyPresent: "VariantAlreadyPresent";
-    readonly ItemUnvailable: "ItemUnvailable";
-    readonly MaximumItemCountReached: "MaximumItemCountReached";
-    readonly ItemDataNotFound: "ItemDataNotFound";
-    readonly ItemAddedWithReducedQuantity: "ItemAddedWithReducedQuantity";
-    readonly Unknown: "Unknown";
-};
-export type AddToBasketFailureKind = ValuesType<typeof AddToBasketFailureKind>;
-export declare const UpdateBasketItemFailureKind: {
-    readonly ItemUnvailable: "ItemUnvailable";
-    readonly BasketItemNotFound: "BasketItemNotFound";
-    readonly ItemAddedWithReducedQuantity: "ItemAddedWithReducedQuantity";
-    readonly Unknown: "Unknown";
-};
-export type UpdateBasketItemFailureKind = ValuesType<typeof UpdateBasketItemFailureKind>;

package/dist/constants/basket.mjs

@@ -1,20 +0,0 @@
-export const ExistingItemHandling = {
-  KeepExisting: 0,
-  AddQuantityToExisting: 1,
-  ReplaceExisting: 2,
-  ReplaceExistingWithCombinedQuantity: 3
-};
-export const AddToBasketFailureKind = {
-  VariantAlreadyPresent: "VariantAlreadyPresent",
-  ItemUnvailable: "ItemUnvailable",
-  MaximumItemCountReached: "MaximumItemCountReached",
-  ItemDataNotFound: "ItemDataNotFound",
-  ItemAddedWithReducedQuantity: "ItemAddedWithReducedQuantity",
-  Unknown: "Unknown"
-};
-export const UpdateBasketItemFailureKind = {
-  ItemUnvailable: "ItemUnvailable",
-  BasketItemNotFound: "BasketItemNotFound",
-  ItemAddedWithReducedQuantity: "ItemAddedWithReducedQuantity",
-  Unknown: "Unknown"
-};