@scayle/storefront-core 7.69.3 → 8.0.0

package/CHANGELOG.md

@@ -1,5 +1,192 @@
 # @scayle/storefront-core
 
+## 8.0.0
+
+### Major Changes
+
+- **\[💥 BREAKING\]** The `getBadgeLabel` helper function has been removed, giving you more control over badge label display.
+
+  - **Note:** This change doesn't affect projects using SCAYLE Storefront Boilerplate v1.0 or later.
+  - For applications based on older versions or using `getBadgeLabel`, you can refer to the previous implementation below:
+
+    ```ts
+    const BadgeLabel = {
+      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>>
+
+    const getBadgeLabel = (params: BadgeLabelParams = {}): string => {
+      if (!params) {
+        return BadgeLabel.DEFAULT
+      }
+      const { isNew, isSoldOut, isOnlineOnly, isSustainable, isPremium } =
+        params
+
+      if (isNew) {
+        return BadgeLabel.NEW
+      } else if (isSoldOut) {
+        return BadgeLabel.SOLD_OUT
+      } else if (isOnlineOnly) {
+        return BadgeLabel.ONLINE_EXCLUSIVE
+      } else if (isSustainable) {
+        return BadgeLabel.SUSTAINABLE
+      } else if (isPremium) {
+        return BadgeLabel.PREMIUM
+      } else {
+        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`.
+
+  - **NOTE:** These changes impact your environment variables used for deployments. Please check your infrastructure and deployment setup and adapt accordingly!
+  - _Previous `bapi` Configuration in `nuxt.config.ts`_
+
+    ```ts
+    export default {
+      // ...
+      runtimeConfig: {
+        // ...
+        storefront: {
+          // ...
+          bapi: {
+            host: '...',
+            token: '...',
+          },
+          // ...
+        },
+        // ...
+      },
+      // ...
+    }
+    ```
+
+  - _Legacy Environment Variables:_
+
+    ```env
+    NUXT_STOREFRONT_BAPI_HOST='...'
+    NUXT_STOREFRONT_BAPI_TOKEN='...'
+    ```
+
+  - _Current `sapi` Configuration in `nuxt.config.ts`_
+
+    ```ts
+    export default {
+      // ...
+      runtimeConfig: {
+        // ...
+        storefront: {
+          // ...
+          sapi: {
+            host: '...',
+            token: '...',
+          },
+          // ...
+        },
+        // ...
+      },
+      // ...
+    }
+    ```
+
+  - _New Environment Variables:_
+
+    ```env
+    NUXT_STOREFRONT_SAPI_HOST='...'
+    NUXT_STOREFRONT_SAPI_TOKEN='...'
+    ```
+
+- **\[💥 BREAKING\]** We've streamlined cache management by replacing the outdated `AY_CACHE_DISABLED` environment variable. Now, you can effortlessly control caching using either the `NUXT_STOREFRONT_CACHE_ENABLED` environment variable or the `storefront.cache.enabled` option within your `nuxt.config.ts` file, providing a more user-friendly experience.
+- **\[💥 BREAKING\]** This release removes the `RedisCache` provider. We now use `UnstorageCache` which also supports Redis as a backing store.
+- **\[💥 BREAKING\]** To improve security and streamline token management, we've updated how you access user `accessToken`. Instead of directly accessing the `storefrontAccessToken` field on the `UserAuthentication` interface, you'll now use the dedicated `getAccessToken` RPC. This change ensures a more secure and controlled method for handling sensitive user data within your application.
+
+  - _Previous Usage of `user.authentication.storefrontAccessToken`:_
+
+    ```ts
+    const { data, fetching, fetch, error, status } = useUser(
+      'getUser',
+      // ...
+    )
+    data.value.user.authentication.storefrontAccessToken
+    ```
+
+  - _Current Usage of dedicated `getAccessToken` RPC method:_
+
+    ```ts
+    const { data: accessToken } = useRpc(
+      'getAccessToken',
+      // ...
+    )
+    ```
+
+- **\[💥 BREAKING\]** We've enhanced security for basket and wishlist keys by switching the default hashing algorithm from MD5 to the more robust SHA256.
+
+  - _Overriding default `hashAlgorithm` in `nuxt.config.ts`:_
+
+    ```ts
+    export default defineNuxtConfig({
+      // ...
+      runtimeConfig: {
+        // ...
+        storefront: {
+          // ...
+          appKeys: {
+            // ...
+            hashAlgorithm: HashAlgorithm.MD5, // HashAlgorithm.SHA256
+          },
+          // ...
+        },
+        // ...
+      },
+      // ...
+    })
+    ```
+
+- **\[💥 BREAKING\]** The attribute `loginShopId` is removed from the `ShopUser` interface as the shop now uses session cookies.
+- **\[💥 BREAKING\]** We're streamlining the search experience as we transition to SCAYLE Search v2, focusing on a category-centric approach. To achieve this, we're consolidating search functionality. This means we're replacing the `searchProducts` RPC method with `getSearchSuggestions`, which provides both product suggestions (triggered by product IDs) and category suggestions (triggered by category-like terms, leading to filtered category pages).
+
+  - _Previous Usage of `searchProducts` RPC method:_
+
+    ```ts
+    const getSearchSuggestionsRpc = useRpcCall('searchProducts')
+
+    data.value = await searchProducts({
+      term: String(searchQuery.value),
+      ...params,
+    })
+    ```
+
+  - _Current Usage of `getSearchSuggestions` RPC method:_
+
+    ```ts
+    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.
+- **\[💥 BREAKING\]** The methods `getBasket`, `removeItemFromBasket`, `addItemsToBasket`, and `addItemToBasket` have been updated. Instead of returning the basket object directly, the basket will now be accessible as a property within the response body. Furthermore, errors occurring during`addItemToBasket` and `addItemsToBasket` will from now on return HTTP 400. The error kind can be identified by checking the `error` property of the response.
+
+### Patch Changes
+
+- Default `forceTokenRefresh` to `false` when no payload is passed to `getAccessToken`
+
 ## 7.69.3
 
 ### Patch Changes

package/dist/cache/cached.cjs

@@ -15,7 +15,7 @@ class Cached {
   log;
   prefix;
   enabled;
-  constructor(cache, log, prefix = "", enabled = process.env.AY_CACHE_DISABLED !== "true") {
+  constructor(cache, log, prefix = "", enabled) {
     if (!cache) {
       log.error(CACHE_NOT_INITIALIZED_MSG);
       throw new Error(CACHE_NOT_INITIALIZED_MSG);

package/dist/cache/cached.d.ts

@@ -13,7 +13,7 @@ export declare class Cached {
     private log;
     private prefix;
     private enabled;
-    constructor(cache: CacheInterface, log: Log, prefix?: string | number, enabled?: boolean);
+    constructor(cache: CacheInterface, log: Log, prefix: (string | number) | undefined, enabled: boolean);
     get isCacheEnabled(): boolean | undefined;
     execute<TArgs extends unknown[], TResult>(fn: Fn<TArgs, TResult>, options?: CacheOptions): Awaited<Fn<TArgs, TResult>>;
     private getCacheValue;

package/dist/cache/cached.mjs

@@ -9,7 +9,7 @@ export class Cached {
   log;
   prefix;
   enabled;
-  constructor(cache, log, prefix = "", enabled = process.env.AY_CACHE_DISABLED !== "true") {
+  constructor(cache, log, prefix = "", enabled) {
     if (!cache) {
       log.error(CACHE_NOT_INITIALIZED_MSG);
       throw new Error(CACHE_NOT_INITIALIZED_MSG);

package/dist/constants/basket.cjs

@@ -3,10 +3,24 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.ExistingItemHandling = void 0;
+exports.UpdateBasketItemFailureKind = exports.ExistingItemHandling = exports.AddToBasketFailureKind = void 0;
 const ExistingItemHandling = exports.ExistingItemHandling = {
   KeepExisting: 0,
   AddQuantityToExisting: 1,
   ReplaceExisting: 2,
   ReplaceExistingWithCombinedQuantity: 3
+};
+const AddToBasketFailureKind = exports.AddToBasketFailureKind = {
+  VariantAlreadyPresent: "VariantAlreadyPresent",
+  ItemUnvailable: "ItemUnvailable",
+  MaximumItemCountReached: "MaximumItemCountReached",
+  ItemDataNotFound: "ItemDataNotFound",
+  ItemAddedWithReducedQuantity: "ItemAddedWithReducedQuantity",
+  Unknown: "Unknown"
+};
+const UpdateBasketItemFailureKind = exports.UpdateBasketItemFailureKind = {
+  ItemUnvailable: "ItemUnvailable",
+  BasketItemNotFound: "BasketItemNotFound",
+  ItemAddedWithReducedQuantity: "ItemAddedWithReducedQuantity",
+  Unknown: "Unknown"
 };

package/dist/constants/basket.d.ts

@@ -6,3 +6,19 @@ export declare const ExistingItemHandling: {
     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

@@ -4,3 +4,17 @@ export const ExistingItemHandling = {
   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"
+};

package/dist/errors/errorResponse.d.ts

@@ -2,7 +2,7 @@ interface ErrorResponseDetails {
     detail?: string;
     instance?: string;
     type?: string;
-    [s: string]: string | undefined;
+    [s: string]: unknown | undefined;
 }
 export declare class ErrorResponse extends Response {
     title: string;

package/dist/errors/index.cjs

@@ -3,28 +3,6 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-var _BAPIError = require("./BAPIError.cjs");
-Object.keys(_BAPIError).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _BAPIError[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _BAPIError[key];
-    }
-  });
-});
-var _baseError = require("./baseError.cjs");
-Object.keys(_baseError).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _baseError[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _baseError[key];
-    }
-  });
-});
 var _errorResponse = require("./errorResponse.cjs");
 Object.keys(_errorResponse).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;

package/dist/errors/index.d.ts

@@ -1,3 +1 @@
-export * from './BAPIError';
-export * from './baseError';
 export * from './errorResponse';

package/dist/errors/index.mjs

@@ -1,3 +1 @@
-export * from "./BAPIError.mjs";
-export * from "./baseError.mjs";
 export * from "./errorResponse.mjs";

package/dist/helpers/productHelpers.cjs

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.slugify = exports.isVariantInStock = exports.isInStock = exports.getVariantCrosssellingValues = exports.getVariantBySize = exports.getVariant = exports.getTotalAppliedReductions = exports.getSizeFromVariant = exports.getSizeFromSpecificVariant = exports.getProductSiblings = exports.getProductPath = exports.getProductColors = exports.getProductAndSiblingsColors = exports.getPrice = exports.getOriginalPrice = exports.getLowestPrice = exports.getLatestCategory = exports.getCategoriesByRoute = exports.getBadgeLabel = exports.getAttribute = exports.getAppliedReductionsByCategory = exports.getAllSizesFromVariants = void 0;
+exports.slugify = exports.isVariantInStock = exports.isInStock = exports.getVariantCrosssellingValues = exports.getVariantBySize = exports.getVariant = exports.getTotalAppliedReductions = exports.getSizeFromVariant = exports.getSizeFromSpecificVariant = exports.getProductSiblings = exports.getProductPath = exports.getProductColors = exports.getProductAndSiblingsColors = exports.getPrice = exports.getOriginalPrice = exports.getLowestPrice = exports.getLatestCategory = exports.getCategoriesByRoute = exports.getAttribute = exports.getAppliedReductionsByCategory = exports.getAllSizesFromVariants = void 0;
 var _storefrontApi = require("@scayle/storefront-api");
 var _slugify = _interopRequireDefault(require("slugify"));
 var _product = require("../constants/product.cjs");
@@ -18,42 +18,8 @@ const slugify = url => {
   });
 };
 exports.slugify = slugify;
-const BadgeLabel = {
-  NEW: "new",
-  SOLD_OUT: "sold_out",
-  ONLINE_EXCLUSIVE: "online_exclusive",
-  SUSTAINABLE: "sustainable",
-  PREMIUM: "premium",
-  DEFAULT: ""
-};
 const getPrice = variant => variant.price;
 exports.getPrice = getPrice;
-const getBadgeLabel = (params = {}) => {
-  if (!params) {
-    return BadgeLabel.DEFAULT;
-  }
-  const {
-    isNew,
-    isSoldOut,
-    isOnlineOnly,
-    isSustainable,
-    isPremium
-  } = params;
-  if (isNew) {
-    return BadgeLabel.NEW;
-  } else if (isSoldOut) {
-    return BadgeLabel.SOLD_OUT;
-  } else if (isOnlineOnly) {
-    return BadgeLabel.ONLINE_EXCLUSIVE;
-  } else if (isSustainable) {
-    return BadgeLabel.SUSTAINABLE;
-  } else if (isPremium) {
-    return BadgeLabel.PREMIUM;
-  } else {
-    return BadgeLabel.DEFAULT;
-  }
-};
-exports.getBadgeLabel = getBadgeLabel;
 const getOriginalPrice = price => {
   return price.appliedReductions.length > 0 ? price.appliedReductions[0].amount.absoluteWithTax + price.withTax : price.withTax;
 };

package/dist/helpers/productHelpers.d.ts

@@ -5,14 +5,6 @@ interface Route {
 }
 export declare const slugify: (url: string | undefined) => string;
 export declare const getPrice: (variant: Variant) => VariantPrice;
-type BadgeLabelParamsKeys = 'isNew' | 'isSoldOut' | 'isOnlineOnly' | 'isSustainable' | 'isPremium';
-type BadgeLabelParams = Partial<Record<BadgeLabelParamsKeys, boolean>>;
-/**
- * getBadgeLabel is deprecated as this is application logic and should be handled per project.
- *
- * @deprecated
- */
-export declare const getBadgeLabel: (params?: BadgeLabelParams) => string;
 export declare const getOriginalPrice: (price: VariantPrice) => number;
 export declare const getTotalAppliedReductions: (price: {
     appliedReductions: {

package/dist/helpers/productHelpers.mjs

@@ -10,34 +10,7 @@ export const slugify = (url) => {
     remove: /[*+~.()'"!:@/#?]/g
   });
 };
-const BadgeLabel = {
-  NEW: "new",
-  SOLD_OUT: "sold_out",
-  ONLINE_EXCLUSIVE: "online_exclusive",
-  SUSTAINABLE: "sustainable",
-  PREMIUM: "premium",
-  DEFAULT: ""
-};
 export const getPrice = (variant) => variant.price;
-export const getBadgeLabel = (params = {}) => {
-  if (!params) {
-    return BadgeLabel.DEFAULT;
-  }
-  const { isNew, isSoldOut, isOnlineOnly, isSustainable, isPremium } = params;
-  if (isNew) {
-    return BadgeLabel.NEW;
-  } else if (isSoldOut) {
-    return BadgeLabel.SOLD_OUT;
-  } else if (isOnlineOnly) {
-    return BadgeLabel.ONLINE_EXCLUSIVE;
-  } else if (isSustainable) {
-    return BadgeLabel.SUSTAINABLE;
-  } else if (isPremium) {
-    return BadgeLabel.PREMIUM;
-  } else {
-    return BadgeLabel.DEFAULT;
-  }
-};
 export const getOriginalPrice = (price) => {
   return price.appliedReductions.length > 0 ? price.appliedReductions[0].amount.absoluteWithTax + price.withTax : price.withTax;
 };

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

@@ -9,6 +9,7 @@ var _types = require("../../../types/index.cjs");
 var _constants = require("../../../constants/index.cjs");
 var _user = require("../../../utils/user.cjs");
 var _response = require("../../../utils/response.cjs");
+var _utils = require("../../../utils/index.cjs");
 const SAPI_ERROR_NAME = "SAPI ERROR";
 function getWithParams(params, context) {
   return params.with ?? context.withParams?.basket ?? _constants.MIN_WITH_PARAMS_BASKET;
@@ -55,7 +56,14 @@ const addItemToBasket = exports.addItemToBasket = async function addItemToBasket
     existingItemHandling
   });
   if (result.type === "success") {
-    return result.basket;
+    return {
+      basket: result.basket
+    };
+  } else if (result.type === "failure" && (0, _utils.wasAddedWithReducedQuantity)(result.errors)) {
+    return {
+      basket: result.basket,
+      errors: result.errors
+    };
   } else {
     const {
       message,
@@ -65,8 +73,9 @@ const addItemToBasket = exports.addItemToBasket = async function addItemToBasket
       message,
       statusCode
     });
-    return new _errors.ErrorResponse(statusCode, SAPI_ERROR_NAME, "Adding item to basket failed", {
-      detail: message
+    return new _errors.ErrorResponse(_constants.HttpStatusCode.BAD_REQUEST, SAPI_ERROR_NAME, "Adding item to basket failed", {
+      detail: message,
+      errors: result.errors
     });
   }
 };
@@ -102,7 +111,14 @@ const addItemsToBasket = exports.addItemsToBasket = async function addItemsToBas
     existingItemHandling: params.existingItemHandling || _constants.ExistingItemHandling.AddQuantityToExisting
   });
   if (result.type === "success") {
-    return result.basket;
+    return {
+      basket: result.basket
+    };
+  } else if (result.type === "failure" && (0, _utils.wasAddedWithReducedQuantity)(result.errors)) {
+    return {
+      basket: result.basket,
+      errors: result.errors
+    };
   } else {
     const {
       statusCode,
@@ -112,8 +128,9 @@ const addItemsToBasket = exports.addItemsToBasket = async function addItemsToBas
       statusCode,
       message
     });
-    return new _errors.ErrorResponse(statusCode, SAPI_ERROR_NAME, "Adding one or more items to basket failed", {
-      detail: message
+    return new _errors.ErrorResponse(_constants.HttpStatusCode.BAD_REQUEST, SAPI_ERROR_NAME, "Adding one or more items to basket failed", {
+      detail: message,
+      errors: result.errors
     });
   }
 };
@@ -144,7 +161,9 @@ const getBasket = exports.getBasket = async function getBasket2(options, context
       detail: message
     });
   }
-  return response.basket;
+  return {
+    basket: response.basket
+  };
 };
 const removeItemFromBasket = exports.removeItemFromBasket = async function removeItemFromBasket2(options, context) {
   if (!(0, _types.hasSession)(context)) {
@@ -156,19 +175,24 @@ const removeItemFromBasket = exports.removeItemFromBasket = async function remov
     basketKey
   } = context;
   const resolvedWith = getWithParams(options, context);
-  return await sapiClient.basket.deleteItem(basketKey, options.itemKey, {
+  const basket = await sapiClient.basket.deleteItem(basketKey, options.itemKey, {
     with: resolvedWith,
     campaignKey,
     includeItemsWithoutProductData: resolvedWith?.includeItemsWithoutProductData,
     orderCustomData: options.orderCustomData
   });
+  return {
+    basket
+  };
 };
 const clearBasket = exports.clearBasket = async function clearBasket2(context) {
   const getBasketResponse = await getBasket({}, context);
   if (getBasketResponse instanceof _errors.ErrorResponse) {
     return getBasketResponse;
   }
-  const basket = await (0, _response.unwrap)(getBasketResponse);
+  const {
+    basket
+  } = await (0, _response.unwrap)(getBasketResponse);
   await Promise.all(basket.items.map(async item => {
     await removeItemFromBasket({
       itemKey: item.key

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

@@ -6,21 +6,37 @@ export declare const addItemToBasket: ({ variantId, promotionId, quantity, displ
     existingItemHandling?: ExistingItemHandling;
     with?: BasketWithOptions;
     orderCustomData?: Record<string, unknown>;
-}, context: RpcContext) => Promise<ErrorResponse | BasketResponseData<Product, Variant>>;
+}, context: RpcContext) => Promise<ErrorResponse | {
+    basket: BasketResponseData<Product, Variant>;
+    errors?: undefined;
+} | {
+    basket: BasketResponseData<Product, Variant>;
+    errors: AddOrUpdateItemError[];
+}>;
 export declare const addItemsToBasket: (params: {
     items: AddOrUpdateItemType[];
     existingItemHandling: ExistingItemHandling;
     with?: BasketWithOptions;
     orderCustomData?: Record<string, unknown>;
-}, context: RpcContext) => Promise<ErrorResponse | BasketResponseData<Product, Variant>>;
+}, context: RpcContext) => Promise<ErrorResponse | {
+    basket: BasketResponseData<Product, Variant>;
+    errors?: undefined;
+} | {
+    basket: BasketResponseData<Product, Variant>;
+    errors: AddOrUpdateItemError[];
+}>;
 export declare const getBasket: (options: (BasketWithOptions & {
     orderCustomData?: Record<string, unknown>;
-}) | undefined, context: RpcContext) => Promise<ErrorResponse | BasketResponseData<Product, Variant>>;
+}) | undefined, context: RpcContext) => Promise<ErrorResponse | {
+    basket: BasketResponseData<Product, Variant>;
+}>;
 export declare const removeItemFromBasket: (options: {
     itemKey: string;
     with?: BasketWithOptions;
     orderCustomData?: Record<string, unknown>;
-}, context: RpcContext) => Promise<ErrorResponse | BasketResponseData<Product, Variant>>;
+}, context: RpcContext) => Promise<ErrorResponse | {
+    basket: BasketResponseData<Product, Variant>;
+}>;
 export declare const clearBasket: (context: RpcContext) => Promise<true | ErrorResponse>;
 export declare const mergeBaskets: ({ fromBasketKey, toBasketKey, with: _with, orderCustomData }: {
     fromBasketKey: string;