@scayle/storefront-core 7.69.3 → 8.1.0

package/dist/rpc/methods/user.cjs

@@ -12,16 +12,12 @@ var _errors = require("../../errors/index.cjs");
 var _fetch = require("../../utils/fetch.cjs");
 const getUser = exports.getUser = function getUser2(context) {
   const {
-    user,
-    accessToken,
-    shopId
+    user
   } = context;
   if (user) {
     user.authentication = user.authentication ?? {
       type: "idp"
     };
-    user.authentication.storefrontAccessToken = accessToken;
-    user.loginShopId = shopId;
   }
   return {
     user
@@ -40,8 +36,6 @@ const fetchUser = exports.fetchUser = async function fetchUser2({
       type: "idp"
     };
   }
-  user.authentication.storefrontAccessToken = accessToken;
-  user.loginShopId = shopId;
   return user;
 };
 const refreshUser = exports.refreshUser = async function refreshUser2(context) {
@@ -73,6 +67,8 @@ const refreshUser = exports.refreshUser = async function refreshUser2(context) {
 };
 const getAccessToken = exports.getAccessToken = async function getAccessToken2({
   forceTokenRefresh = false
+} = {
+  forceTokenRefresh: false
 }, context) {
   if (!(0, _types.hasSession)(context)) {
     return new _errors.ErrorResponse(_constants.HttpStatusCode.BAD_REQUEST, _constants.HttpStatusMessage.BAD_REQUEST, "No Session found");
@@ -94,14 +90,6 @@ const getAccessToken = exports.getAccessToken = async function getAccessToken2({
         accessToken: tokens.access_token,
         refreshToken: tokens.refresh_token
       });
-      try {
-        const user = await fetchUser({
-          accessToken: tokens.access_token
-        }, context);
-        context.updateUser(user);
-      } catch {
-        context.log.debug("Failed to update user");
-      }
     } catch (e) {
       if (e instanceof _fetch.FetchError && e.response.status === _constants.HttpStatusCode.UNAUTHORIZED) {
         context.log.debug("Failed to refresh Checkout Token due to invalid refresh token. Deleting session");

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

@@ -19,5 +19,5 @@ declare const refreshUser: (context: RpcContext) => Promise<ErrorResponse | {
 }>;
 declare const getAccessToken: ({ forceTokenRefresh }: {
     forceTokenRefresh?: boolean;
-}, context: RpcContext) => Promise<string | ErrorResponse>;
+} | undefined, context: RpcContext) => Promise<string | ErrorResponse>;
 export { getUser, fetchUser, refreshUser, getAccessToken };

package/dist/rpc/methods/user.mjs

@@ -5,13 +5,11 @@ import { HttpStatusCode, HttpStatusMessage } from "../../constants/index.mjs";
 import { ErrorResponse } from "../../errors/index.mjs";
 import { FetchError } from "../../utils/fetch.mjs";
 const getUser = function getUser2(context) {
-  const { user, accessToken, shopId } = context;
+  const { user } = context;
   if (user) {
     user.authentication = user.authentication ?? {
       type: "idp"
     };
-    user.authentication.storefrontAccessToken = accessToken;
-    user.loginShopId = shopId;
   }
   return {
     user
@@ -26,8 +24,6 @@ const fetchUser = async function fetchUser2({ accessToken }, context) {
       type: "idp"
     };
   }
-  user.authentication.storefrontAccessToken = accessToken;
-  user.loginShopId = shopId;
   return user;
 };
 const refreshUser = async function refreshUser2(context) {
@@ -51,7 +47,7 @@ const refreshUser = async function refreshUser2(context) {
     return { user: void 0 };
   }
 };
-const getAccessToken = async function getAccessToken2({ forceTokenRefresh = false }, context) {
+const getAccessToken = async function getAccessToken2({ forceTokenRefresh = false } = { forceTokenRefresh: false }, context) {
   if (!hasSession(context)) {
     return new ErrorResponse(
       HttpStatusCode.BAD_REQUEST,
@@ -84,15 +80,6 @@ const getAccessToken = async function getAccessToken2({ forceTokenRefresh = fals
         accessToken: tokens.access_token,
         refreshToken: tokens.refresh_token
       });
-      try {
-        const user = await fetchUser(
-          { accessToken: tokens.access_token },
-          context
-        );
-        context.updateUser(user);
-      } catch {
-        context.log.debug("Failed to update user");
-      }
     } catch (e) {
       if (e instanceof FetchError && e.response.status === HttpStatusCode.UNAUTHORIZED) {
         context.log.debug(

package/dist/rpc/methods/variants.cjs

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getVariantById = void 0;
+var _sapi = require("../../utils/sapi.cjs");
 const defaultWith = {
   attributes: "all"
 };
@@ -18,7 +19,7 @@ const getVariantById = exports.getVariantById = async function getVariantById2({
   withParams
 }) {
   const resolvedWith = include ?? withParams?.variant ?? defaultWith;
-  return await cached(sapiClient.variants.getByIds, {
+  return await cached((0, _sapi.mapSAPIFetchErrorToResponse)(sapiClient.variants.getByIds), {
     cacheKeyPrefix: "getByIds-variants"
   })(ids, include ? {
     with: resolvedWith,

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

@@ -5,4 +5,4 @@ export interface FetchVariantsParams {
     include?: ProductWith;
     pricePromotionKey?: string;
 }
-export declare const getVariantById: ({ ids, include, pricePromotionKey }: FetchVariantsParams, { sapiClient, cached, campaignKey, withParams }: RpcContext) => Promise<VariantDetail[]>;
+export declare const getVariantById: ({ ids, include, pricePromotionKey }: FetchVariantsParams, { sapiClient, cached, campaignKey, withParams }: RpcContext) => Promise<Response | VariantDetail[]>;

package/dist/rpc/methods/variants.mjs

@@ -1,11 +1,15 @@
+import { mapSAPIFetchErrorToResponse } from "../../utils/sapi.mjs";
 const defaultWith = {
   attributes: "all"
 };
 export const getVariantById = async function getVariantById2({ ids, include = defaultWith, pricePromotionKey = "default" }, { sapiClient, cached, campaignKey, withParams }) {
   const resolvedWith = include ?? withParams?.variant ?? defaultWith;
-  return await cached(sapiClient.variants.getByIds, {
-    cacheKeyPrefix: "getByIds-variants"
-  })(
+  return await cached(
+    mapSAPIFetchErrorToResponse(sapiClient.variants.getByIds),
+    {
+      cacheKeyPrefix: "getByIds-variants"
+    }
+  )(
     ids,
     include ? { with: resolvedWith, campaignKey, pricePromotionKey } : void 0
   );

package/dist/rpc/methods/wishlist.cjs

@@ -8,6 +8,7 @@ var _types = require("../../types/index.cjs");
 var _constants = require("../../constants/index.cjs");
 var _response = require("../../utils/response.cjs");
 var _errors = require("../../errors/index.cjs");
+var _sapi = require("../../utils/sapi.cjs");
 function getWithParams(params, context) {
   return params.with ?? context.withParams?.wishlist ?? _constants.MIN_WITH_PARAMS_WISHLIST;
 }
@@ -23,7 +24,7 @@ const getWishlist = exports.getWishlist = async function getWishlist2(options, c
   const resolvedWith = getWithParams({
     with: options
   }, context);
-  return await sapiClient.wishlist.get(wishlistKey, {
+  return await (0, _sapi.mapSAPIFetchErrorToResponse)(sapiClient.wishlist.get)(wishlistKey, {
     with: resolvedWith,
     campaignKey,
     pricePromotionKey: resolvedWith?.pricePromotionKey ?? ""
@@ -83,7 +84,7 @@ const removeItemFromWishlist = exports.removeItemFromWishlist = async function r
     wishlistKey
   } = context;
   const resolvedWith = getWithParams(options, context);
-  return await sapiClient.wishlist.deleteItem(wishlistKey, options.itemKey, {
+  return await (0, _sapi.mapSAPIFetchErrorToResponse)(sapiClient.wishlist.deleteItem)(wishlistKey, options.itemKey, {
     with: resolvedWith,
     campaignKey
   });

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

@@ -1,7 +1,6 @@
 import type { Wishlist } from '@scayle/storefront-api';
 import type { RpcContext, WishlistWithOptions } from '../../types';
-import { ErrorResponse } from '../../errors';
-export declare const getWishlist: (options: WishlistWithOptions | undefined, context: RpcContext) => Promise<ErrorResponse | Wishlist>;
+export declare const getWishlist: (options: WishlistWithOptions | undefined, context: RpcContext) => Promise<Response | Wishlist>;
 export declare const addItemToWishlist: (options: {
     variantId?: number;
     productId?: number;
@@ -10,5 +9,5 @@ export declare const addItemToWishlist: (options: {
 export declare const removeItemFromWishlist: (options: {
     itemKey: string;
     with?: WishlistWithOptions;
-}, context: RpcContext) => Promise<ErrorResponse | Wishlist>;
-export declare const clearWishlist: (context: RpcContext) => Promise<ErrorResponse | Wishlist>;
+}, context: RpcContext) => Promise<Response | Wishlist>;
+export declare const clearWishlist: (context: RpcContext) => Promise<Response | Wishlist>;

package/dist/rpc/methods/wishlist.mjs

@@ -6,6 +6,7 @@ import {
 } from "../../constants/index.mjs";
 import { unwrap } from "../../utils/response.mjs";
 import { ErrorResponse } from "../../errors/index.mjs";
+import { mapSAPIFetchErrorToResponse } from "../../utils/sapi.mjs";
 function getWithParams(params, context) {
   return params.with ?? context.withParams?.wishlist ?? MIN_WITH_PARAMS_WISHLIST;
 }
@@ -19,11 +20,14 @@ export const getWishlist = async function getWishlist2(options, context) {
   }
   const { sapiClient, campaignKey, wishlistKey } = context;
   const resolvedWith = getWithParams({ with: options }, context);
-  return await sapiClient.wishlist.get(wishlistKey, {
-    with: resolvedWith,
-    campaignKey,
-    pricePromotionKey: resolvedWith?.pricePromotionKey ?? ""
-  });
+  return await mapSAPIFetchErrorToResponse(sapiClient.wishlist.get)(
+    wishlistKey,
+    {
+      with: resolvedWith,
+      campaignKey,
+      pricePromotionKey: resolvedWith?.pricePromotionKey ?? ""
+    }
+  );
 };
 export const addItemToWishlist = async function addItemToWishlist2(options, context) {
   if (!hasSession(context)) {
@@ -71,10 +75,14 @@ export const removeItemFromWishlist = async function removeItemFromWishlist2(opt
   }
   const { sapiClient, campaignKey, wishlistKey } = context;
   const resolvedWith = getWithParams(options, context);
-  return await sapiClient.wishlist.deleteItem(wishlistKey, options.itemKey, {
-    with: resolvedWith,
-    campaignKey
-  });
+  return await mapSAPIFetchErrorToResponse(sapiClient.wishlist.deleteItem)(
+    wishlistKey,
+    options.itemKey,
+    {
+      with: resolvedWith,
+      campaignKey
+    }
+  );
 };
 export const clearWishlist = async function clearWishlist2(context) {
   const wishlistResponse = await getWishlist({}, context);

package/dist/server.cjs

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 var _exportNames = {
-  createClient: true,
-  RedisCache: true,
   UnstorageCache: true,
-  CACHE_TIMEOUT: true,
-  initBapi: true
+  CACHE_TIMEOUT: true
 };
 Object.defineProperty(exports, "CACHE_TIMEOUT", {
   enumerable: true,
@@ -16,34 +13,14 @@ Object.defineProperty(exports, "CACHE_TIMEOUT", {
     return _cache.CACHE_TIMEOUT;
   }
 });
-Object.defineProperty(exports, "RedisCache", {
-  enumerable: true,
-  get: function () {
-    return _redis.RedisCache;
-  }
-});
 Object.defineProperty(exports, "UnstorageCache", {
   enumerable: true,
   get: function () {
     return _unstorage.UnstorageCache;
   }
 });
-Object.defineProperty(exports, "createClient", {
-  enumerable: true,
-  get: function () {
-    return _redis.createClient;
-  }
-});
-Object.defineProperty(exports, "initBapi", {
-  enumerable: true,
-  get: function () {
-    return _init.init;
-  }
-});
-var _redis = require("./cache/providers/redis.cjs");
 var _unstorage = require("./cache/providers/unstorage.cjs");
 var _cache = require("./constants/cache.cjs");
-var _init = require("./bapi/init.cjs");
 var _customer = require("./api/customer.cjs");
 Object.keys(_customer).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;

package/dist/server.d.ts

@@ -1,7 +1,4 @@
-export { createClient, RedisCache } from './cache/providers/redis';
 export { UnstorageCache } from './cache/providers/unstorage';
 export { CACHE_TIMEOUT } from './constants/cache';
-export type { RedisOptions } from './cache/providers/redis';
-export { init as initBapi } from './bapi/init';
 export * from './api/customer';
 export * from './api/oauth';

package/dist/server.mjs

@@ -1,6 +1,4 @@
-export { createClient, RedisCache } from "./cache/providers/redis.mjs";
 export { UnstorageCache } from "./cache/providers/unstorage.mjs";
 export { CACHE_TIMEOUT } from "./constants/cache.mjs";
-export { init as initBapi } from "./bapi/init.mjs";
 export * from "./api/customer.mjs";
 export * from "./api/oauth.mjs";

package/dist/types/api/auth.d.ts

@@ -1,13 +1,4 @@
 import type { Gender } from '../user';
-/**
- * @deprecated
- */
-export interface AuthConfig {
-    callback: string;
-    scopes?: string[];
-    accessToken?: string;
-    customData?: unknown;
-}
 export interface OAuthTokens {
     accessToken: string;
     refreshToken: string;

package/dist/types/api/context.d.ts

@@ -72,16 +72,8 @@ export type RpcContext = {
          */
         cbdExpiration?: number;
     };
-    /**
-     * @deprecated bapiClient got renamed. Use  {@link RpcContext.sapiClient} from now on.
-     */
-    bapiClient: StorefrontAPIClient;
     sapiClient: StorefrontAPIClient;
     cached: CachedType;
-    /**
-     * @deprecated this flag will be removed in a future release.
-     */
-    isCmsPreview: boolean;
     shopId: number;
     domain: string;
     withParams?: WithParams;
@@ -89,10 +81,6 @@ export type RpcContext = {
     destroySessionsForUserId: (userId: number, sessionsToKeep?: string[]) => Promise<void>;
     generateBasketKeyForUserId: (userId: string) => Promise<string>;
     generateWishlistKeyForUserId: (userId: string) => Promise<string>;
-    /**
-     * @deprecated storeCampaignKeyword will be removed in a future release.
-     */
-    storeCampaignKeyword?: string;
     routerBasePath?: string;
     ip?: string | undefined;
     log: Log;

package/dist/types/user.d.ts

@@ -20,8 +20,6 @@ interface UserAuthentication {
         accessToken?: string;
         userId?: string;
     };
-    /** @deprecated use `getAccessToken` RPC instead */
-    storefrontAccessToken?: string;
     type: AuthenticationType;
 }
 export interface OrderSummary {
@@ -91,8 +89,6 @@ export interface ShopUser {
     customData?: {
         memberRoles?: MemberRole[];
     };
-    /** @deprecated `loginShopId` is no longer needed, because each shop now has it's own session cookie */
-    loginShopId?: number;
 }
 export interface UseUserFacetParams {
     userParams: UseUserParams;

package/dist/utils/basket.cjs

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.wasAddedWithReducedQuantity = void 0;
+var _constants = require("../constants/index.cjs");
+const wasAddedWithReducedQuantity = errors => {
+  if (!errors) {
+    return false;
+  }
+  return errors.every(error => error.operation === "add" && error.kind === _constants.AddToBasketFailureKind.ItemAddedWithReducedQuantity || error.operation === "update" && error.kind === _constants.UpdateBasketItemFailureKind.ItemAddedWithReducedQuantity);
+};
+exports.wasAddedWithReducedQuantity = wasAddedWithReducedQuantity;

package/dist/utils/basket.d.ts

@@ -0,0 +1,2 @@
+import type { AddOrUpdateItemError } from '@scayle/storefront-api';
+export declare const wasAddedWithReducedQuantity: (errors?: AddOrUpdateItemError[]) => boolean;

package/dist/utils/basket.mjs

@@ -0,0 +1,12 @@
+import {
+  AddToBasketFailureKind,
+  UpdateBasketItemFailureKind
+} from "../constants/index.mjs";
+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
+  );
+};

package/dist/utils/index.cjs

@@ -35,4 +35,15 @@ Object.keys(_fetch).forEach(function (key) {
       return _fetch[key];
     }
   });
+});
+var _basket = require("./basket.cjs");
+Object.keys(_basket).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _basket[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _basket[key];
+    }
+  });
 });

package/dist/utils/index.d.ts

@@ -1,3 +1,4 @@
 export * from './timeout';
 export * from './log';
 export * from './fetch';
+export * from './basket';

package/dist/utils/index.mjs

@@ -1,3 +1,4 @@
 export * from "./timeout.mjs";
 export * from "./log.mjs";
 export * from "./fetch.mjs";
+export * from "./basket.mjs";

package/dist/utils/keys.cjs

@@ -8,7 +8,7 @@ var _hash = require("../constants/hash.cjs");
 var _hash2 = require("./hash.cjs");
 const generateKey = async ({
   keyTemplate,
-  hashAlgorithm = _hash.HashAlgorithm.MD5,
+  hashAlgorithm = _hash.HashAlgorithm.SHA256,
   shopId,
   userId,
   log
@@ -35,7 +35,7 @@ const generateKey = async ({
 exports.generateKey = generateKey;
 const generateWishlistKey = async ({
   keyTemplate,
-  hashAlgorithm = _hash.HashAlgorithm.MD5,
+  hashAlgorithm = _hash.HashAlgorithm.SHA256,
   shopId,
   userId,
   log
@@ -51,7 +51,7 @@ const generateWishlistKey = async ({
 exports.generateWishlistKey = generateWishlistKey;
 const generateBasketKey = async ({
   keyTemplate,
-  hashAlgorithm = _hash.HashAlgorithm.MD5,
+  hashAlgorithm = _hash.HashAlgorithm.SHA256,
   shopId,
   userId,
   log

package/dist/utils/keys.mjs

@@ -2,7 +2,7 @@ import { HashAlgorithm } from "../constants/hash.mjs";
 import { md5, sha256 } from "./hash.mjs";
 export const generateKey = async ({
   keyTemplate,
-  hashAlgorithm = HashAlgorithm.MD5,
+  hashAlgorithm = HashAlgorithm.SHA256,
   shopId,
   userId,
   log
@@ -26,7 +26,7 @@ export const generateKey = async ({
 };
 export const generateWishlistKey = async ({
   keyTemplate,
-  hashAlgorithm = HashAlgorithm.MD5,
+  hashAlgorithm = HashAlgorithm.SHA256,
   shopId,
   userId,
   log
@@ -41,7 +41,7 @@ export const generateWishlistKey = async ({
 };
 export const generateBasketKey = async ({
   keyTemplate,
-  hashAlgorithm = HashAlgorithm.MD5,
+  hashAlgorithm = HashAlgorithm.SHA256,
   shopId,
   userId,
   log

package/dist/utils/sapi.cjs

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.mapSAPIFetchErrorToResponse = mapSAPIFetchErrorToResponse;
+var _storefrontApi = require("@scayle/storefront-api");
+function mapSAPIFetchErrorToResponse(func) {
+  return async (...args) => {
+    try {
+      return await func(...args);
+    } catch (e) {
+      if (e instanceof _storefrontApi.FetchError) {
+        return e.response;
+      }
+      throw e;
+    }
+  };
+}

package/dist/utils/sapi.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Wrap a SAPI API function, catching any SAPI FetchErrors thrown
+ * and translating them to a Response return
+ */
+export declare function mapSAPIFetchErrorToResponse<T extends (...args: any) => any>(func: T): (...args: Parameters<T>) => Promise<Awaited<ReturnType<T>> | Response>;

package/dist/utils/sapi.mjs

@@ -0,0 +1,13 @@
+import { FetchError } from "@scayle/storefront-api";
+export function mapSAPIFetchErrorToResponse(func) {
+  return async (...args) => {
+    try {
+      return await func(...args);
+    } catch (e) {
+      if (e instanceof FetchError) {
+        return e.response;
+      }
+      throw e;
+    }
+  };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "7.69.3",
+  "version": "8.1.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -83,20 +83,17 @@
   "devDependencies": {
     "@scayle/eslint-config-storefront": "4.3.2",
     "@types/crypto-js": "4.2.2",
-    "@types/node": "22.10.0",
+    "@types/node": "22.10.1",
     "@types/webpack-env": "1.18.5",
-    "@vitest/coverage-v8": "2.1.6",
-    "dprint": "0.47.5",
-    "eslint": "9.15.0",
+    "@vitest/coverage-v8": "2.1.8",
+    "dprint": "0.47.6",
+    "eslint": "9.16.0",
     "eslint-formatter-gitlab": "5.1.0",
     "publint": "0.2.12",
     "rimraf": "6.0.1",
     "typescript": "5.6.3",
     "unbuild": "2.0.0",
     "unstorage": "1.13.1",
-    "vitest": "2.1.6"
-  },
-  "optionalDependencies": {
-    "redis": "4"
+    "vitest": "2.1.8"
   }
 }

package/dist/bapi/init.cjs

@@ -1,19 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.init = void 0;
-var _storefrontApi = require("@scayle/storefront-api");
-const init = config => {
-  return new _storefrontApi.StorefrontAPIClient({
-    host: config.host,
-    shopId: config.shopId,
-    auth: {
-      type: config.authentication,
-      token: config.token
-    },
-    additionalHeaders: config.additionalHeaders
-  });
-};
-exports.init = init;

package/dist/bapi/init.d.ts

@@ -1,15 +0,0 @@
-import { StorefrontAPIClient } from '@scayle/storefront-api';
-interface StorefrontAPIConfig {
-    host: string;
-    shopId: number;
-    authentication: 'token';
-    token: string;
-    additionalHeaders: HeadersInit;
-}
-/**
- * Create a new Storefront API Client.
- *
- * @deprecated
- */
-export declare const init: (config: StorefrontAPIConfig) => StorefrontAPIClient;
-export {};

package/dist/bapi/init.mjs

@@ -1,12 +0,0 @@
-import { StorefrontAPIClient } from "@scayle/storefront-api";
-export const init = (config) => {
-  return new StorefrontAPIClient({
-    host: config.host,
-    shopId: config.shopId,
-    auth: {
-      type: config.authentication,
-      token: config.token
-    },
-    additionalHeaders: config.additionalHeaders
-  });
-};