@scayle/storefront-core 8.17.0 → 8.18.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @scayle/storefront-core
 
+## 8.18.0
+
+### Minor Changes
+
+- Update RPC methods to use explicit typing. This is an internal change to enable Typescript's `isolatedDeclarations` option. It will not impact regular usage of RPC methods, however if you are importing one of the functions directly, the explicit rather than inferred type will be used.
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/storefront-api@18.2.2
+
+## 8.17.1
+
+### Patch Changes
+
+- Ensure that the `getAttribute` helper function can handle multi-value attributes.
+
 ## 8.17.0
 
 ### Minor Changes

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

@@ -1,7 +1,6 @@
 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 type { AddOrUpdateItemType, BasketResponseData, BasketWithOptions, Product, RpcHandler, Variant } from '../../../types';
 /**
  * Adds an item to the basket.
  *
@@ -20,16 +19,13 @@ import type { AddOrUpdateItemType, BasketResponseData, BasketWithOptions, Produc
  * @returns The updated basket, potentially with errors. It will return
  * an `ErrorResponse` if no session is found or adding to basket fails.
  */
-export declare const addItemToBasket: ({ variantId, promotionId, quantity, displayData, customData, existingItemHandling, itemGroup, with: _with, orderCustomData, }: AddOrUpdateItemType & {
+export declare const addItemToBasket: RpcHandler<AddOrUpdateItemType & {
     existingItemHandling?: ExistingItemHandling;
     with?: BasketWithOptions;
     orderCustomData?: Record<string, unknown>;
-}, context: RpcContext) => Promise<ErrorResponse | {
+}, {
     basket: BasketResponseData<Product, Variant>;
-    errors?: undefined;
-} | {
-    basket: BasketResponseData<Product, Variant>;
-    errors: AddOrUpdateItemError[];
+    errors?: AddOrUpdateItemError[];
 }>;
 /**
  * Adds multiple items to the basket.
@@ -44,17 +40,14 @@ export declare const addItemToBasket: ({ variantId, promotionId, quantity, displ
  * @returns The updated basket, potentially with errors. It will return
  * an `ErrorResponse` if no session is found or adding to basket fails.
  */
-export declare const addItemsToBasket: (params: {
+export declare const addItemsToBasket: RpcHandler<{
     items: AddOrUpdateItemType[];
     existingItemHandling: ExistingItemHandling;
     with?: BasketWithOptions;
     orderCustomData?: Record<string, unknown>;
-}, context: RpcContext) => Promise<ErrorResponse | {
-    basket: BasketResponseData<Product, Variant>;
-    errors?: undefined;
-} | {
+}, {
     basket: BasketResponseData<Product, Variant>;
-    errors: AddOrUpdateItemError[];
+    errors?: AddOrUpdateItemError[];
 }>;
 /**
  * Retrieves the current basket.
@@ -66,9 +59,9 @@ export declare const addItemsToBasket: (params: {
  * @returns The basket data. It will return an `ErrorResponse` alternatively
  * if no session is found or retrieving the basket fails.
  */
-export declare const getBasket: (options: (BasketWithOptions & {
+export declare const getBasket: RpcHandler<BasketWithOptions & {
     orderCustomData?: Record<string, unknown>;
-}) | undefined, context: RpcContext) => Promise<ErrorResponse | {
+} | undefined, {
     basket: BasketResponseData<Product, Variant>;
 }>;
 /**
@@ -83,11 +76,11 @@ export declare const getBasket: (options: (BasketWithOptions & {
  * @returns The updated basket. It will return an `ErrorResponse` alternatively
  * if no session is found or removing the item fails.
  */
-export declare const removeItemFromBasket: (options: {
+export declare const removeItemFromBasket: RpcHandler<{
     itemKey: string;
     with?: BasketWithOptions;
     orderCustomData?: Record<string, unknown>;
-}, context: RpcContext) => Promise<ErrorResponse | {
+}, {
     basket: BasketResponseData<Product, Variant>;
 }>;
 /**
@@ -98,7 +91,7 @@ export declare const removeItemFromBasket: (options: {
  * @returns True if the basket was cleared successfully. It will return
  * an `ErrorResponse` alternatively iIf an error occurs during basket clearing.
  */
-export declare const clearBasket: (context: RpcContext) => Promise<true | ErrorResponse>;
+export declare const clearBasket: RpcHandler<boolean>;
 /**
  * Merges two baskets.
  *
@@ -111,23 +104,12 @@ export declare const clearBasket: (context: RpcContext) => Promise<true | ErrorR
  *
  * @returns The new merged basket as result of the merge operation.
  */
-export declare const mergeBaskets: ({ fromBasketKey, toBasketKey, with: _with, orderCustomData }: {
+export declare const mergeBaskets: RpcHandler<{
     fromBasketKey: string;
     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>;
+}, any>;
 /**
  * Type defining an object containing properties of a basket item than should be
  * applied to the basket item during the update.
@@ -165,6 +147,6 @@ export interface UpdateBasketItemRequestParameter {
  * In case of an error the, the failure kind will be resolved.
  * It will return an `ErrorResponse` if no session is found or update operation fails.
  */
-export declare const updateBasketItem: ({ basketItemKey, update, with: _with }: UpdateBasketItemRequestParameter, context: RpcContext) => Promise<ErrorResponse | {
+export declare const updateBasketItem: RpcHandler<UpdateBasketItemRequestParameter, {
     basket: BasketResponseData<Product, Variant>;
 }>;

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

@@ -1,4 +1,4 @@
-import type { Brand, BrandsEndpointRequestParameters, BrandsEndpointResponseData } from '../../types';
+import type { Brand, BrandsEndpointRequestParameters, BrandsEndpointResponseData, RpcHandler } from '../../types';
 /**
  * Retrieves a list of brands.
  *
@@ -13,7 +13,7 @@ import type { Brand, BrandsEndpointRequestParameters, BrandsEndpointResponseData
  *
  * @returns The list of brands. It will return an `ErrorResponse` if the request fails.
  */
-export declare const getBrands: ({ pagination }: BrandsEndpointRequestParameters, { sapiClient, cached }: import("../../types").RpcContext) => Promise<Response | BrandsEndpointResponseData>;
+export declare const getBrands: RpcHandler<BrandsEndpointRequestParameters, BrandsEndpointResponseData>;
 /**
  * Retrieves a brand by its ID.
  *
@@ -26,6 +26,6 @@ export declare const getBrands: ({ pagination }: BrandsEndpointRequestParameters
  *
  * @returns The brand. It will return an `ErrorResponse` alternatively If the request fails.
  */
-export declare const getBrandById: ({ brandId }: {
+export declare const getBrandById: RpcHandler<{
     brandId: number;
-}, { sapiClient, cached }: import("../../types").RpcContext) => Promise<Response | Brand>;
+}, Brand>;

package/dist/rpc/methods/brands.mjs

@@ -11,7 +11,10 @@ export const getBrands = async function getBrands2({ pagination }, { sapiClient,
   });
 };
 export const getBrandById = async function getBrandById2({ brandId }, { sapiClient, cached }) {
-  return await cached(mapSAPIFetchErrorToResponse(sapiClient.brands.getById), {
-    cacheKeyPrefix: `getBrandById-${brandId}`
-  })(brandId);
+  return await cached(
+    mapSAPIFetchErrorToResponse(sapiClient.brands.getById),
+    {
+      cacheKeyPrefix: `getBrandById-${brandId}`
+    }
+  )(brandId);
 };

package/dist/rpc/methods/campaign.mjs

@@ -3,7 +3,7 @@ import {
   sortCampaignsByDateAscending,
   isCampaignActive
 } from "../../utils/campaign.mjs";
-export const getCampaignKey = async (context) => {
+export const getCampaignKey = async function getCampaignKey2(context) {
   if (context.campaignKey) {
     return context.campaignKey;
   }

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

@@ -1,4 +1,4 @@
-import type { Category, ProductCategoryPropertyWith, RpcContext } from '../../types';
+import type { Category, ProductCategoryPropertyWith, RpcHandler } from '../../types';
 /**
  * Retrieves the root categories.
  *
@@ -13,11 +13,11 @@ import type { Category, ProductCategoryPropertyWith, RpcContext } from '../../ty
  *
  * @returns The root categories and the active node (undefined).
  */
-export declare const getRootCategories: ({ children, includeHidden, properties }: {
+export declare const getRootCategories: RpcHandler<{
     children?: number;
     includeHidden?: true;
     properties?: ProductCategoryPropertyWith;
-}, context: RpcContext) => Promise<{
+}, {
     categories: Category[];
     activeNode: undefined;
 }>;
@@ -37,12 +37,12 @@ export declare const getRootCategories: ({ children, includeHidden, properties }
  * @returns The category or undefined if not found.
  * It will return an `ErrorResponse` if an error occurs during the API call.
  */
-export declare const getCategoryByPath: ({ path, children, includeHidden, properties }: {
+export declare const getCategoryByPath: RpcHandler<{
     path: string;
     children?: number;
     includeHidden?: true;
     properties?: ProductCategoryPropertyWith;
-}, context: RpcContext) => Promise<Response | Category>;
+}, Category | undefined>;
 /**
  * Retrieves categories by path.
  *
@@ -58,17 +58,14 @@ export declare const getCategoryByPath: ({ path, children, includeHidden, proper
  *
  * @returns The categories data.
  */
-export declare const getCategoriesByPath: ({ path, children, includeHidden, properties }: {
+export declare const getCategoriesByPath: RpcHandler<{
     path: string;
     children?: number;
     includeHidden?: true;
     properties?: ProductCategoryPropertyWith;
-}, context: RpcContext) => Promise<{
-    categories: Category[];
-    activeNode: undefined;
-} | {
-    categories: Category;
-    activeNode: Category;
+}, {
+    categories: Category[] | Category;
+    activeNode?: Category;
 }>;
 /**
  * Retrieves a category by ID.
@@ -85,9 +82,9 @@ export declare const getCategoriesByPath: ({ path, children, includeHidden, prop
  *
  * @returns The category. It will return an `ErrorResponse` if category retrieval fails.
  */
-export declare const getCategoryById: ({ id, children, includeHidden, properties }: {
+export declare const getCategoryById: RpcHandler<{
     id: number;
     children?: number;
     includeHidden?: true;
     properties?: ProductCategoryPropertyWith;
-}, context: RpcContext) => Promise<Response | Category>;
+}, Category>;

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

@@ -1,5 +1,4 @@
-import { ErrorResponse } from '../../errors';
-import type { Order, RpcContext } from '../../types';
+import type { Order, RpcHandler } from '../../types';
 /**
  * Retrieves order data using a CBD token.
  *
@@ -10,6 +9,6 @@ import type { Order, RpcContext } from '../../types';
  * @returns The order data. It will return an `ErrorResponse` alternatively if
  * the CBD token is invalid, expired, or if an error occurs during the order retrieval.
  */
-export declare const getOrderDataByCbd: ({ cbdToken }: {
+export declare const getOrderDataByCbd: RpcHandler<{
     cbdToken: string;
-}, context: RpcContext) => Promise<ErrorResponse | Order<Record<string, unknown>, Record<string, unknown>>>;
+}, Order>;

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

package/dist/rpc/methods/checkout/order.d.ts

@@ -1,5 +1,4 @@
-import { ErrorResponse } from '../../../errors';
-import type { Order } from '../../../types';
+import type { Order, RpcHandler } from '../../../types';
 /**
  * Retrieves an order by its ID.
  *
@@ -12,6 +11,6 @@ import type { Order } from '../../../types';
  * the order does not belong to the current user, the order is not found,
  * or an unknown error occurs.
  */
-export declare const getOrderById: ({ orderId }: {
+export declare const getOrderById: RpcHandler<{
     orderId: number;
-}, context: import("../../../types").RpcContext) => Promise<ErrorResponse | Order<Record<string, unknown>, Record<string, unknown>>>;
+}, Order>;

package/dist/rpc/methods/checkout/shopUser.d.ts

@@ -1,5 +1,4 @@
-import { ErrorResponse } from '../../../errors';
-import type { ShopUser, UpdatePasswordParams } from '../../../types';
+import type { RpcHandler, ShopUser, UpdatePasswordParams } from '../../../types';
 /**
  * Updates the shop user.
  *
@@ -9,7 +8,7 @@ import type { ShopUser, UpdatePasswordParams } from '../../../types';
  * @returns The updated user. It will return an `ErrorResponse` alternatively
  * if updating user information fails.
  */
-export declare const updateShopUser: (payload: Partial<ShopUser>, context: import("../../../types").RpcContext) => Promise<ErrorResponse | {
+export declare const updateShopUser: RpcHandler<Partial<ShopUser>, {
     user: ShopUser;
 }>;
 /**
@@ -23,6 +22,6 @@ export declare const updateShopUser: (payload: Partial<ShopUser>, context: impor
  * @returns The user object (or undefined if an error occurs and shopUser is undefined).
  * It will return an `ErrorResponse` if updating the password fails.
  */
-export declare const updatePassword: ({ oldPassword, newPassword }: UpdatePasswordParams, context: import("../../../types").RpcContext) => Promise<ErrorResponse | {
-    user: ShopUser | undefined;
+export declare const updatePassword: RpcHandler<UpdatePasswordParams, {
+    user?: ShopUser;
 }>;

package/dist/rpc/methods/checkout/shopUserAddresses.d.ts

@@ -1,4 +1,4 @@
-import type { ShopUserAddress } from '../../../types';
+import type { RpcHandler, ShopUserAddress } from '../../../types';
 /**
  * Retrieves the shop user addresses.
  *
@@ -6,5 +6,5 @@ import type { ShopUserAddress } from '../../../types';
  *
  * @returns The shop user addresses.
  */
-declare const getShopUserAddresses: (context: import("../../../types").RpcContext) => Promise<ShopUserAddress[]>;
+declare const getShopUserAddresses: RpcHandler<ShopUserAddress[]>;
 export { getShopUserAddresses };

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

@@ -1,6 +1,5 @@
 import type { NavigationAllEndpointResponseData, NavigationTree } from '@scayle/storefront-api';
-import type { FetchNavigationTreeByIdParams, FetchNavigationTreeByNameParams, FetchNavigationTreesParams } from '../../types';
-import { ErrorResponse } from '../../errors';
+import type { FetchNavigationTreeByIdParams, FetchNavigationTreeByNameParams, FetchNavigationTreesParams, RpcHandler } from '../../types';
 /**
  * Fetches all navigation trees.
  *
@@ -14,7 +13,7 @@ import { ErrorResponse } from '../../errors';
  * @returns The navigation trees data. It will return an `ErrorResponse`
  * if an error occurs during fetching.
  */
-export declare const fetchAllNavigationTrees: ({ params }: FetchNavigationTreesParams, { sapiClient: { navigation }, cached }: import("../../types").RpcContext) => Promise<NavigationAllEndpointResponseData>;
+export declare const fetchAllNavigationTrees: RpcHandler<FetchNavigationTreesParams, NavigationAllEndpointResponseData>;
 /**
  * Fetches a navigation tree by its ID.
  *
@@ -29,5 +28,5 @@ export declare const fetchAllNavigationTrees: ({ params }: FetchNavigationTreesP
  * @returns The navigation tree data. It will return an `ErrorResponse`
  * if an error occurs during fetching.
  */
-export declare const fetchNavigationTreeById: ({ treeId, params }: FetchNavigationTreeByIdParams, { sapiClient: { navigation }, cached }: import("../../types").RpcContext) => Promise<NavigationTree>;
-export declare const fetchNavigationTreeByName: ({ treeName, params }: FetchNavigationTreeByNameParams, { sapiClient: { navigation }, cached }: import("../../types").RpcContext) => Promise<ErrorResponse | NavigationTree>;
+export declare const fetchNavigationTreeById: RpcHandler<FetchNavigationTreeByIdParams, NavigationTree>;
+export declare const fetchNavigationTreeByName: RpcHandler<FetchNavigationTreeByNameParams, NavigationTree>;

package/dist/rpc/methods/oauth/idp.d.ts

@@ -1,5 +1,4 @@
-import { ErrorResponse } from '../../../errors';
-import type { RpcContext } from '../../../types';
+import type { RpcHandler } from '../../../types';
 /**
  * Retrieves external IDP redirect URLs.
  *
@@ -13,11 +12,9 @@ import type { RpcContext } from '../../../types';
  * or an ErrorResponse if an error occurs. It will return an `ErrorResponse`
  * if JWT signing fails or another unexpected error occurs.
  */
-export declare const getExternalIdpRedirect: ({ queryParams }: {
+export declare const getExternalIdpRedirect: RpcHandler<{
     queryParams?: Record<string, string>;
-}, context: RpcContext) => Promise<ErrorResponse | {
-    [k: string]: string;
-}>;
+}, Record<string, string>>;
 /**
  * Handles the IDP login callback.
  *
@@ -29,8 +26,8 @@ export declare const getExternalIdpRedirect: ({ queryParams }: {
  *
  * @returns A success message, or an `ErrorResponse` an error during login occurs.
  */
-export declare const handleIDPLoginCallback: (payload: {
+export declare const handleIDPLoginCallback: RpcHandler<{
     code: string;
-}, context: RpcContext) => Promise<ErrorResponse | {
+}, {
     message: string;
 }>;

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

@@ -20,8 +20,8 @@ export declare function resolveCategoryIdFromParams(context: RpcContext, params:
     categoryId: number;
     category?: undefined;
 }): Promise<{
-    category: string | undefined;
-    categoryId: number | undefined;
+    category?: string;
+    categoryId?: number;
 }>;
 /**
  * Retrieves a product by its ID.

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

@@ -1,4 +1,4 @@
-import type { PromotionsParams, RpcContext } from '../../types';
+import type { PromotionsParams, PromotionsResponseData, RpcHandler } from '../../types';
 /**
  * Retrieves promotions based on provided parameters.
  *
@@ -14,7 +14,7 @@ import type { PromotionsParams, RpcContext } from '../../types';
  * @returns A Promise that resolves with the promotion data.
  * It will return an `ErrorResponse` if the The Storefront API request fails.
  */
-export declare const getPromotions: (params: Omit<PromotionsParams, "ids"> | undefined, context: RpcContext) => Promise<any>;
+export declare const getPromotions: RpcHandler<Omit<PromotionsParams, 'ids'>, PromotionsResponseData>;
 /**
  * Retrieves currently active promotions.
  *
@@ -30,7 +30,7 @@ export declare const getPromotions: (params: Omit<PromotionsParams, "ids"> | und
  * @returns A Promise that resolves with the current promotion data.
  * It will return an `ErrorResponse` if the The Storefront API request fails.
  */
-export declare const getCurrentPromotions: (params: Omit<PromotionsParams, "ids" | "activeAt"> | undefined, context: RpcContext) => Promise<any>;
+export declare const getCurrentPromotions: RpcHandler<Omit<PromotionsParams, 'ids' | 'activeAt'>, PromotionsResponseData>;
 /**
  * Retrieves promotions by their IDs.
  *
@@ -43,4 +43,4 @@ export declare const getCurrentPromotions: (params: Omit<PromotionsParams, "ids"
  * @returns A Promise that resolves with the promotion data.
  * It will return an `ErrorResponse` if the The Storefront API request fails.
  */
-export declare const getPromotionsByIds: (ids: string[], context: RpcContext) => Promise<any>;
+export declare const getPromotionsByIds: RpcHandler<string[], PromotionsResponseData>;

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

@@ -1,5 +1,5 @@
-import type { SearchEntity, SearchV2ResolveEndpointParameters, SearchV2SuggestionsEndpointParameters, SearchV2SuggestionsEndpointResponseData } from '../../types/sapi/search';
-import type { RpcContext } from '../../types';
+import type { SearchV2ResolveEndpointParameters, SearchV2ResolveEndpointResponseData, SearchV2SuggestionsEndpointParameters, SearchV2SuggestionsEndpointResponseData } from '../../types/sapi/search';
+import type { RpcHandler } from '../../types';
 /**
  * Fetches search suggestions for a given term.
  *
@@ -12,7 +12,7 @@ import type { RpcContext } from '../../types';
  * @returns A promise that resolves to a list of search suggestions.
  * It will return an `ErrorResponse` if the request fails.
  */
-export declare const getSearchSuggestions: ({ term, with: _with, categoryId }: SearchV2SuggestionsEndpointParameters, context: RpcContext) => Promise<Response | SearchV2SuggestionsEndpointResponseData>;
+export declare const getSearchSuggestions: RpcHandler<SearchV2SuggestionsEndpointParameters, SearchV2SuggestionsEndpointResponseData>;
 /**
  * Resolves a search query and returns the resolved entity.
  *
@@ -27,4 +27,4 @@ export declare const getSearchSuggestions: ({ term, with: _with, categoryId }: S
  *
  * @returns A promise that resolves to the resolved entity or null if no entity is found.
  */
-export declare const resolveSearch: ({ term, with: _with, categoryId }: SearchV2ResolveEndpointParameters, context: RpcContext) => Promise<SearchEntity | null>;
+export declare const resolveSearch: RpcHandler<SearchV2ResolveEndpointParameters, Promise<SearchV2ResolveEndpointResponseData | null>>;

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

@@ -1,5 +1,5 @@
 import type { Optional } from 'utility-types';
-import type { GuestRequest, LoginRequest, Oauth, RegisterRequest, RpcContext, RpcContextWithSession, ShopUser, UpdatePasswordByHashRequest } from '../../types';
+import type { GuestRequest, LoginRequest, Oauth, ParamRpcHandler, RegisterRequest, RpcContextWithSession, RpcHandler, UpdatePasswordByHashRequest } from '../../types';
 import { ErrorResponse } from '../../errors';
 /**
  * Handles the post-login logic, including fetching user data, updating tokens,
@@ -11,7 +11,7 @@ import { ErrorResponse } from '../../errors';
  * @returns The result of the post login operation. It will return
  * an `ErrorResponse` if fetching the user or merging baskets/wishlists fails.
  */
-export declare function postLogin(context: RpcContextWithSession, tokens: Oauth): Promise<(ShopUser & ErrorResponse) | undefined>;
+export declare function postLogin(context: RpcContextWithSession, tokens: Oauth): Promise<ErrorResponse | undefined>;
 /**
  * Handles OAuth login requests.
  *
@@ -21,7 +21,7 @@ export declare function postLogin(context: RpcContextWithSession, tokens: Oauth)
  * @returns A Response object indicating the login status. It will return
  * an `ErrorResponse` if login fails.
  */
-export declare const oauthLogin: (login: Optional<LoginRequest, "shop_id">, context: RpcContext) => Promise<Response>;
+export declare const oauthLogin: ParamRpcHandler<Optional<LoginRequest, 'shop_id'>, undefined>;
 /**
  * Handles OAuth user registration requests.
  *
@@ -31,7 +31,7 @@ export declare const oauthLogin: (login: Optional<LoginRequest, "shop_id">, cont
  * @returns A Response object indicating the registration status. It will return
  * an `ErrorResponse` if registration fails.
  */
-export declare const oauthRegister: (register: Optional<RegisterRequest, "shop_id">, context: RpcContext) => Promise<Response>;
+export declare const oauthRegister: ParamRpcHandler<Optional<RegisterRequest, 'shop_id'>, undefined>;
 /**
  * Handles OAuth guest login requests.
  *
@@ -41,7 +41,7 @@ export declare const oauthRegister: (register: Optional<RegisterRequest, "shop_i
  * @returns A Response object indicating the login status. It will return
  * an `ErrorResponse` if guest login fails.
  */
-export declare const oauthGuestLogin: (guest: Optional<GuestRequest, "shop_id">, context: RpcContext) => Promise<Response>;
+export declare const oauthGuestLogin: ParamRpcHandler<Optional<GuestRequest, 'shop_id'>, undefined>;
 /**
  * Refreshes the access token using the refresh token.
  *
@@ -50,10 +50,8 @@ export declare const oauthGuestLogin: (guest: Optional<GuestRequest, "shop_id">,
  * @returns An object indicating the success status of the refresh operation.
  *  It will return an `ErrorResponse` if refreshing the token fails.
  */
-export declare const refreshAccessToken: (context: RpcContext) => Promise<Response | {
-    success: true;
-} | {
-    success: false;
+export declare const refreshAccessToken: RpcHandler<{
+    success: boolean;
 }>;
 /**
  * Revokes the current access token and destroys the session.
@@ -63,10 +61,8 @@ export declare const refreshAccessToken: (context: RpcContext) => Promise<Respon
  * @returns An object indicating the result of the revocation.
  * It will return an `ErrorResponse` if revoking the token fails.
  */
-export declare const oauthRevokeToken: (context: RpcContext) => Promise<Response | {
-    result: true;
-} | {
-    result: false;
+export declare const oauthRevokeToken: RpcHandler<{
+    result: boolean;
 }>;
 /**
  * Sends a password reset email to the specified email address.
@@ -77,12 +73,10 @@ export declare const oauthRevokeToken: (context: RpcContext) => Promise<Response
  * @returns An object indicating the success status of the operation.
  * It will return an `ErrorResponse` if sending the password reset email fails.
  */
-export declare const oauthForgetPassword: ({ email }: {
+export declare const oauthForgetPassword: RpcHandler<{
     email: string;
-}, context: RpcContext) => Promise<Response | {
-    success: true;
-} | {
-    success: false;
+}, {
+    success: boolean;
 }>;
 /**
  * Updates the password using a password hash.
@@ -93,4 +87,4 @@ export declare const oauthForgetPassword: ({ email }: {
  * @returns A Response object indicating the status of the password update.
  * It will return an `ErrorResponse` if updating the password fails.
  */
-export declare const updatePasswordByHash: (passwordHash: Optional<UpdatePasswordByHashRequest, "shop_id">, context: RpcContext) => Promise<Response>;
+export declare const updatePasswordByHash: ParamRpcHandler<Optional<UpdatePasswordByHashRequest, 'shop_id'>, undefined>;

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

@@ -1,5 +1,5 @@
 import type { ShopConfiguration } from '@scayle/storefront-api';
-import type { RpcContext } from '../../types';
+import type { RpcHandler } from '../../types';
 /**
  * Retrieves the shop configuration.
  *
@@ -11,5 +11,5 @@ import type { RpcContext } from '../../types';
  * @returns The shop configuration. It will return an `ErrorResponse` alternatively
  * if the Storefront API request fails.
  */
-declare const getShopConfiguration: (context: RpcContext) => Promise<Response | ShopConfiguration>;
+declare const getShopConfiguration: RpcHandler<ShopConfiguration>;
 export { getShopConfiguration };

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

@@ -1,5 +1,4 @@
-import type { RpcContext, ShopUser } from '../../types';
-import { ErrorResponse } from '../../errors';
+import type { RpcContext, RpcHandler, ShopUser } from '../../types';
 /**
  * Retrieves the user from the context.
  *
@@ -7,9 +6,9 @@ import { ErrorResponse } from '../../errors';
  *
  * @returns An object containing the user object, or undefined if not logged in.
  */
-declare const getUser: (context: RpcContext) => {
-    user: ShopUser | undefined;
-};
+declare const getUser: RpcHandler<{
+    user?: ShopUser;
+}>;
 /**
  * Fetches user data using the provided access token.
  *
@@ -32,10 +31,8 @@ declare const fetchUser: ({ accessToken }: {
  * @returns An object containing the user object, or undefined if session is destroyed.
  * It will return an `ErrorResponse` if no session is found or other errors occur.
  */
-declare const refreshUser: (context: RpcContext) => Promise<ErrorResponse | {
-    user: undefined;
-} | {
-    user: ShopUser;
+declare const refreshUser: RpcHandler<{
+    user?: ShopUser;
 }>;
 /**
  * Retrieves or refreshes the access token.
@@ -47,7 +44,7 @@ declare const refreshUser: (context: RpcContext) => Promise<ErrorResponse | {
  * @returns The access token. It will return an `ErrorResponse` alternatively
  * if no session, access token, or refresh token is found.
  */
-declare const getAccessToken: ({ forceTokenRefresh }: {
+declare const getAccessToken: RpcHandler<{
     forceTokenRefresh?: boolean;
-} | undefined, context: RpcContext) => Promise<string | ErrorResponse>;
+}, string>;
 export { getUser, fetchUser, refreshUser, getAccessToken };

package/dist/rpc/methods/user.mjs

@@ -42,7 +42,10 @@ const refreshUser = async function refreshUser2(context) {
     return { user: void 0 };
   }
   try {
-    const user = await fetchUser({ accessToken }, context);
+    const user = await context.callRpc?.("fetchUser", { accessToken });
+    if (!user) {
+      return { user: void 0 };
+    }
     context.updateUser(user);
     return { user };
   } catch {

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.17.0",
+  "version": "8.18.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -63,7 +63,7 @@
     "fishery": "^2.2.3"
   },
   "dependencies": {
-    "@scayle/storefront-api": "18.2.1",
+    "@scayle/storefront-api": "18.2.2",
     "@scayle/unstorage-scayle-kv-driver": "0.1.1",
     "crypto-js": "^4.2.0",
     "hookable": "^5.5.3",
@@ -80,14 +80,17 @@
     "@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"
+  },
+  "volta": {
+    "node": "22.14.0"
   }
 }