@scayle/storefront-core 8.16.0 → 8.17.1

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @scayle/storefront-core
 
+## 8.17.1
+
+### Patch Changes
+
+- Ensure that the `getAttribute` helper function can handle multi-value attributes.
+
+## 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

package/dist/cache/cached.d.ts

@@ -55,7 +55,7 @@ export declare class Cached {
     /**
      * Whether caching is enabled.
      */
-    get isCacheEnabled(): boolean | undefined;
+    get isCacheEnabled(): boolean;
     /**
      * Executes a function and caches its result.
      *

package/dist/cache/cached.mjs

@@ -32,7 +32,7 @@ export class Cached {
    * Whether caching is enabled.
    */
   get isCacheEnabled() {
-    return this.enabled;
+    return this.enabled ?? false;
   }
   /**
    * Executes a function and caches its result.

package/dist/helpers/advancedAttributeHelpers.d.ts

@@ -6,9 +6,7 @@ import type { FieldSet, GroupSet } from '../types';
  *
  * @returns An array of flattened objects.
  */
-export declare const flattenFieldSet: (fieldSet: FieldSet) => {
-    [key: string]: string | number | null | undefined;
-}[][];
+export declare const flattenFieldSet: (fieldSet: FieldSet) => FieldSet;
 interface FlattenedMaterialComposition {
     materialGroupName?: string;
     values: {

package/dist/helpers/arrayHelpers.d.ts

@@ -1,8 +1,17 @@
+/**
+ * Recursive helper type to extract the innermost non-array element types from T.
+ * Handles nested arrays and unions of arrays/non-arrays.
+ */
+type FlattenElement<T> = T extends ReadonlyArray<infer U> ? FlattenElement<U> : T;
 /**
  * Flattens an array of arrays with unknown depth into a single-level array.
  *
- * @param array The array to flatten. Its depth will be treated as up to 20 levels due to current TypeScript limitations on inferring infinite depth.
+ * @template T The type of the potentially nested array. Must extend `readonly unknown[]`.
+ *
+ * @param array The array to flatten.
  *
- * @returns The flattened array.
+ * @returns A new, single-level array containing all the innermost elements
+ * extracted from the input array. The element type is inferred recursively.
  */
-export declare const flattenDeep: <T extends unknown[]>(array: T) => (T extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? /*elided*/ any : InnerArr : InnerArr : InnerArr : InnerArr : InnerArr : InnerArr : InnerArr : InnerArr : InnerArr : InnerArr : T)[];
+export declare const flattenDeep: <T extends ReadonlyArray<unknown>>(array: T) => FlattenElement<T>[];
+export {};

package/dist/helpers/attributeHelpers.d.ts

@@ -1,4 +1,4 @@
-import type { Attributes } from '@scayle/storefront-api';
+import type { Attributes, Value } from '@scayle/storefront-api';
 /**
  * Retrieves the first attribute value for a given attribute name from a set of attributes.
  *
@@ -7,7 +7,7 @@ import type { Attributes } from '@scayle/storefront-api';
  *
  * @returns The first attribute value, or undefined if not found.
  */
-export declare const getFirstAttributeValue: (attributes: Attributes | undefined, attributeName: string) => import("@scayle/storefront-api").Value | undefined;
+export declare const getFirstAttributeValue: (attributes: Attributes | undefined, attributeName: string) => Value | undefined;
 /**
  * Retrieves the value or label of the first attribute value for a given attribute name.
  *
@@ -25,7 +25,7 @@ export declare const getAttributeValue: (attributes: Attributes | undefined, att
  *
  * @returns An array of attribute values, or an empty array if not found.
  */
-export declare const getAttributeValueTuples: (attributes: Attributes | undefined, attributeName: string) => import("@scayle/storefront-api").Value[];
+export declare const getAttributeValueTuples: (attributes: Attributes | undefined, attributeName: string) => Value[];
 /**
  * Retrieves the first attribute value for multiple attribute names.
  *
@@ -34,4 +34,4 @@ export declare const getAttributeValueTuples: (attributes: Attributes | undefine
  *
  * @returns An array of attribute values, filtered to remove any null or undefined values.
  */
-export declare const getManyAttributeValueTuples: (attributes: Attributes | undefined, attributeNames: string[]) => import("@scayle/storefront-api").Value[];
+export declare const getManyAttributeValueTuples: (attributes: Attributes | undefined, attributeNames: string[]) => Value[];

package/dist/helpers/basketHelpers.d.ts

@@ -6,4 +6,4 @@ import type { BasketPackageInformation } from '@scayle/storefront-api';
  *
  * @returns A tuple containing the earliest and latest delivery dates, or null if no dates are found.
  */
-export declare const getShippingDates: (packages: BasketPackageInformation[]) => (string | null)[];
+export declare const getShippingDates: (packages: BasketPackageInformation[]) => [string | null, string | null];

package/dist/helpers/filterHelper.d.ts

@@ -1,5 +1,5 @@
 import type { CentAmount, ProductSearchQuery } from '@scayle/storefront-api';
-import type { ProductFilter } from '../types';
+import type { ProductFilter, SortValue } from '../types';
 export interface TransformedFilter {
     key: string;
     displayName: string;
@@ -50,7 +50,7 @@ export declare const groupFilterableValuesByKey: (filters: ProductFilter[], filt
  */
 export declare const transformStateToFilters: (state: {
     [key: string]: TransformedFilter[];
-}) => any;
+}) => Record<string, any>;
 /**
  * Merges an array of filters into a single filter object.
  *
@@ -67,7 +67,7 @@ export declare const mergeFilters: (filters: TransformedFilter[]) => Record<stri
  *
  * @returns True if the filter is active, false otherwise.
  */
-export declare const isFilterActive: (filters: Record<string, any>, filterToCheck: TransformedFilter) => any;
+export declare const isFilterActive: (filters: Record<string, any>, filterToCheck: TransformedFilter) => boolean;
 /**
  * Gets the active filters from a set of filters.
  *
@@ -100,36 +100,7 @@ export declare const transformMinAndMaxPriceToFilter: (prices: (CentAmount | und
  *
  * @returns The transformed sort value.
  */
-export declare const transformSortToFilter: (sort: string) => {
-    by: "price";
-    direction: "desc";
-    name: "topseller";
-    query: "topseller";
-} | {
-    by: "new";
-    name: "date_newest";
-    query: "date-newest";
-} | {
-    by: "price";
-    direction: "desc";
-    name: "price_desc";
-    query: "price-desc";
-} | {
-    by: "price";
-    direction: "asc";
-    name: "price_asc";
-    query: "price-asc";
-} | {
-    by: "reduction";
-    direction: "desc";
-    name: "reduction_desc";
-    query: "reduction-desc";
-} | {
-    by: "reduction";
-    direction: "asc";
-    name: "reduction_asc";
-    query: "reduction-asc";
-};
+export declare const transformSortToFilter: (sort: string) => SortValue;
 /**
  * Gets grouped filterable values by keys.
  *
@@ -151,7 +122,7 @@ export declare const getGroupedFilterableValues: (keys: Array<string>, filterabl
  *
  * @returns The min or max price value.
  */
-export declare const getFilterablePriceValue: (filterableValues: Record<string, any>, key?: "min" | "max") => any;
+export declare const getFilterablePriceValue: (filterableValues: Record<string, any>, key?: "min" | "max") => CentAmount;
 export type SerializedFilter = Record<string, string>;
 export type Filter = Record<string, string | number | (string | number | null)[]>;
 /**

package/dist/helpers/orderHelpers.d.ts

@@ -1,4 +1,4 @@
-import type { Order } from '../types';
+import type { Order, OrderItem } from '../types';
 /**
  * Retrieves unique items from an order based on variant ID.
  *
@@ -8,7 +8,7 @@ import type { Order } from '../types';
  *
  * @deprecated getting unique items from order should be handled within the Storefront project itself.
  */
-export declare const getUniqueItemsFromOrder: <P, V>(order: Order<P, V>) => import("../types").OrderItem<P, V>[] | undefined;
+export declare const getUniqueItemsFromOrder: <P, V>(order: Order<P, V>) => OrderItem<P, V>[] | undefined;
 /**
  * Gets the quantity of a specific item in an order based on its variant ID.
  *

package/dist/helpers/productHelpers.d.ts

@@ -1,4 +1,4 @@
-import type { AppliedReduction, BasketItemPrice, Product, Value, Variant, VariantPrice } from '@scayle/storefront-api';
+import type { AppliedReduction, BasketItemPrice, Product, ProductCategory, Value, Variant, VariantPrice } from '@scayle/storefront-api';
 import type { ProductSibling } from '../types/sapi/product';
 interface Route {
     path?: string;
@@ -97,7 +97,7 @@ export declare const getVariant: (variants: Variant[], id: number) => Variant |
  *
  * @returns An array of unique size values.
  */
-export declare const getAllSizesFromVariants: (variantsAttributes: Variant[], attributeName?: string) => any[];
+export declare const getAllSizesFromVariants: (variantsAttributes: Variant[], attributeName?: string) => Value[];
 /**
  * Retrieves product siblings including the product itself.
  * Filters out inactive siblings.
@@ -161,7 +161,7 @@ export declare const isVariantInStock: (variants: Variant[], size: Value, sizeAt
  *
  * @returns  The attribute value.
  */
-export declare const getAttribute: (product: Product, key: string) => any;
+export declare const getAttribute: (product: Product, key: string) => string | undefined;
 /**
  * Generates the product path based on product name and id
  *
@@ -178,7 +178,7 @@ export declare const getProductPath: (product: Product) => string;
  *
  * @returns An array of categories.
  */
-export declare const getCategoriesByRoute: (product: Product | null, route: Route | null) => import("@scayle/storefront-api").ProductCategory[];
+export declare const getCategoriesByRoute: (product: Product | null, route: Route | null) => ProductCategory[];
 /**
  * Retrieves the latest/deepest category from product categories
  *
@@ -186,7 +186,7 @@ export declare const getCategoriesByRoute: (product: Product | null, route: Rout
  *
  * @returns The latest category object or undefined
  */
-export declare const getLatestCategory: (categories?: Product["categories"]) => import("@scayle/storefront-api").ProductCategory | undefined;
+export declare const getLatestCategory: (categories?: Product["categories"]) => ProductCategory | undefined;
 /**
  * Retrieves colors from a product and its siblings
  *

package/dist/helpers/productHelpers.mjs

@@ -92,6 +92,12 @@ export const isVariantInStock = (variants, size, sizeAttributeName = "shopSize")
 };
 export const getAttribute = (product, key) => {
   const values = product.attributes?.[key]?.values;
+  if (!values) {
+    return;
+  }
+  if (Array.isArray(values)) {
+    return values[0]?.value ?? values[0]?.label;
+  }
   return values?.value ?? values?.label;
 };
 export const getProductPath = (product) => {

package/dist/helpers/sortingHelper.d.ts

@@ -1,4 +1,5 @@
-import type { Query, SortingValueKey } from '../index';
+import type { Query } from '../index';
+import type { SortingValueKey, SortValue } from '../types/sapi/sorting';
 /**
  * Retrieves a subset of sorting values based on the provided keys.
  * Filters out invalid keys and returns an object mapping valid keys to their sorting configurations.
@@ -7,38 +8,7 @@ import type { Query, SortingValueKey } from '../index';
  *
  * @returns An object mapping valid sorting keys to their configurations.
  */
-export declare const getSortingValues: (options?: Array<SortingValueKey>) => {
-    [k: string]: {
-        by: "price";
-        direction: "desc";
-        name: "topseller";
-        query: "topseller";
-    } | {
-        by: "new";
-        name: "date_newest";
-        query: "date-newest";
-    } | {
-        by: "price";
-        direction: "desc";
-        name: "price_desc";
-        query: "price-desc";
-    } | {
-        by: "price";
-        direction: "asc";
-        name: "price_asc";
-        query: "price-asc";
-    } | {
-        by: "reduction";
-        direction: "desc";
-        name: "reduction_desc";
-        query: "reduction-desc";
-    } | {
-        by: "reduction";
-        direction: "asc";
-        name: "reduction_asc";
-        query: "reduction-asc";
-    };
-};
+export declare const getSortingValues: (options?: SortingValueKey[]) => Record<SortingValueKey, SortValue>;
 /**
  * Retrieves the sorting configuration based on the provided query.
  *
@@ -47,33 +17,4 @@ export declare const getSortingValues: (options?: Array<SortingValueKey>) => {
  *
  * @returns The sorting configuration object corresponding to the query or the default sort.
  */
-export declare const getSortByValue: (query: Query, defaultSort?: SortingValueKey) => {
-    by: "price";
-    direction: "desc";
-    name: "topseller";
-    query: "topseller";
-} | {
-    by: "new";
-    name: "date_newest";
-    query: "date-newest";
-} | {
-    by: "price";
-    direction: "desc";
-    name: "price_desc";
-    query: "price-desc";
-} | {
-    by: "price";
-    direction: "asc";
-    name: "price_asc";
-    query: "price-asc";
-} | {
-    by: "reduction";
-    direction: "desc";
-    name: "reduction_desc";
-    query: "reduction-desc";
-} | {
-    by: "reduction";
-    direction: "asc";
-    name: "reduction_asc";
-    query: "reduction-asc";
-};
+export declare const getSortByValue: (query: Query, defaultSort?: SortingValueKey) => SortValue;

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/basket/basket.d.ts

@@ -1,5 +1,5 @@
 import { ExistingItemHandling } from '@scayle/storefront-api';
-import type { AddOrUpdateItemError, UpdateBasketItemQuantity } from '@scayle/storefront-api';
+import type { AddManyItemsBasketResponse, AddOrUpdateItemError, BasketResponse, UpdateBasketItemQuantity } from '@scayle/storefront-api';
 import { ErrorResponse } from '../../../errors';
 import type { AddOrUpdateItemType, BasketResponseData, BasketWithOptions, Product, RpcContext, Variant } from '../../../types';
 /**
@@ -116,18 +116,7 @@ export declare const mergeBaskets: ({ fromBasketKey, toBasketKey, with: _with, o
     toBasketKey: string;
     with?: BasketWithOptions;
     orderCustomData?: Record<string, unknown>;
-}, context: RpcContext) => Promise<{
-    type: "failure";
-    statusCode: number;
-    basket: BasketResponseData<Product, Variant>;
-} | {
-    readonly type: "success";
-    readonly basket: BasketResponseData<Product, Variant>;
-} | {
-    readonly type: "failure";
-    readonly basket: BasketResponseData<Product, Variant>;
-    readonly errors: AddOrUpdateItemError[];
-} | undefined>;
+}, context: RpcContext) => Promise<BasketResponse<Product, Variant> | AddManyItemsBasketResponse<Product, Variant> | undefined>;
 /**
  * Type defining an object containing properties of a basket item than should be
  * applied to the basket item during the update.

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.16.0"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.17.1"}`).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/dist/test/factories/user.d.ts

@@ -10,4 +10,4 @@ import type { ShopUser } from '../../types';
  * const multipleUsers = userFactory.buildList(5) // Generates an array of 5 ShopUser objects.
  * ```
  */
-export declare const userFactory: Factory<ShopUser, any, ShopUser>;
+export declare const userFactory: Factory<ShopUser>;

package/dist/utils/hash.d.ts

@@ -10,7 +10,7 @@
  *
  * @throws {Error} If SFC is built without MD5 support (SFC_OMIT_MD5 environment variable is set).
  */
-export declare const md5: (value: string) => Promise<any>;
+export declare const md5: (value: string) => Promise<string>;
 /**
  * Calculates the SHA256 hash of a string.
  *

package/dist/utils/log.d.ts

@@ -95,7 +95,7 @@ export declare class Log {
      *
      * @returns A Promise that resolves with the result of the timed function.
      */
-    time(message: string, func: () => any): Promise<any>;
+    time<T = any>(message: string, func: () => T): Promise<T>;
     /**
      * Attaches the log instance to a request object.
      * This is typically used in server middleware.

package/dist/utils/timeout.d.ts

@@ -5,7 +5,7 @@
  *
  * @returns A Promise that resolves after the specified delay.
  */
-export declare const wait: (ms: number) => Promise<unknown>;
+export declare const wait: (ms: number) => Promise<void>;
 /**
  * Wraps a promise with a timeout. Rejects the promise if it doesn't resolve within the given time.
  *

package/dist/utils/user.d.ts

@@ -1,4 +1,5 @@
-import type { BasketWithOptions, RpcContext } from '../types';
+import type { BasketResponse, AddManyItemsBasketResponse } from '@scayle/storefront-api';
+import type { BasketWithOptions, Product, RpcContext, Variant } from '../types';
 /**
  * Merges two baskets. Adds the items from the `fromBasketKey` basket to the `toBasketKey` basket
  * and then clears the `fromBasketKey` basket. Handles existing items by adding quantities.
@@ -12,18 +13,7 @@ import type { BasketWithOptions, RpcContext } from '../types';
  */
 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>;
-} | {
-    readonly type: "success";
-    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").BasketResponseData<import("@scayle/storefront-api").Product, import("@scayle/storefront-api").Variant>;
-    readonly errors: import("@scayle/storefront-api").AddOrUpdateItemError[];
-} | undefined>;
+}, context: RpcContext) => Promise<BasketResponse<Product, Variant> | AddManyItemsBasketResponse<Product, Variant> | undefined>;
 /**
  * Merges two wishlists.  Adds the items from the `fromWishlistKey` wishlist to the `toWishlistKey` wishlist
  * and then clears the `fromWishlistKey` wishlist.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.16.0",
+  "version": "8.17.1",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -80,12 +80,12 @@
     "@types/webpack-env": "1.18.8",
     "@vitest/coverage-v8": "2.1.9",
     "dprint": "0.49.1",
-    "eslint": "9.23.0",
+    "eslint": "9.24.0",
     "eslint-formatter-gitlab": "5.1.0",
     "fishery": "2.2.3",
     "publint": "0.2.12",
     "rimraf": "6.0.1",
-    "typescript": "5.8.2",
+    "typescript": "5.8.3",
     "unbuild": "3.5.0",
     "unstorage": "1.15.0",
     "vitest": "2.1.9"