@scayle/storefront-core 7.58.1 → 7.58.3

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @scayle/storefront-core
 
+## 7.58.3
+
+### Patch Changes
+
+- Upgrades to the new Wishlist from @scayle/storefront-api
+- `getDefaultFractionDigits` will return 2 if `maximumFractionDigits` is not defined
+- Updated dependencies
+  - @scayle/storefront-api@17.3.0
+
+## 7.58.2
+
+### Patch Changes
+
+- Adds the `X-Shop-Id` header to the request when revoking an access token.
+
 ## 7.58.1
 
 ### Patch Changes

package/dist/api/oauth.cjs

@@ -168,13 +168,14 @@ class OAuthClient {
    * Revoke an access token
    * @param accessToken
    */
-  async revokeToken(accessToken) {
+  async revokeToken(shopId, accessToken) {
     this.logger?.debug("Revoking access token");
     const decodedAccessToken = (0, _jose.decodeJwt)(accessToken);
     await fetch(`${this.baseURL}/oauth/tokens/${decodedAccessToken.jti}`, {
       method: "DELETE",
       headers: {
         ...this.headers,
+        "X-Shop-Id": `${shopId}`,
         Authorization: `Bearer ${accessToken}`
       }
     }).then(emptyOAuthResponseHandler);

package/dist/api/oauth.d.ts

@@ -62,7 +62,7 @@ export declare class OAuthClient {
      * Revoke an access token
      * @param accessToken
      */
-    revokeToken(accessToken: string): Promise<void>;
+    revokeToken(shopId: number, accessToken: string): Promise<void>;
     /**
      * Revoke all tokens for a user
      * @param userId

package/dist/api/oauth.mjs

@@ -153,13 +153,14 @@ export class OAuthClient {
    * Revoke an access token
    * @param accessToken
    */
-  async revokeToken(accessToken) {
+  async revokeToken(shopId, accessToken) {
     this.logger?.debug("Revoking access token");
     const decodedAccessToken = decodeJwt(accessToken);
     await fetch(`${this.baseURL}/oauth/tokens/${decodedAccessToken.jti}`, {
       method: "DELETE",
       headers: {
         ...this.headers,
+        "X-Shop-Id": `${shopId}`,
         Authorization: `Bearer ${accessToken}`
       }
     }).then(emptyOAuthResponseHandler);

package/dist/helpers/attributeHelpers.d.ts

@@ -2,4 +2,4 @@ import type { Attributes } from '@scayle/storefront-api';
 export declare const getFirstAttributeValue: (attributes: Attributes | undefined, attributeName: string) => import("@scayle/storefront-api").Value | undefined;
 export declare const getAttributeValue: (attributes: Attributes | undefined, attributeName: string) => string | undefined;
 export declare const getAttributeValueTuples: (attributes: Attributes | undefined, attributeName: string) => import("@scayle/storefront-api").Value[];
-export declare const getManyAttributeValueTuples: (attributes: Attributes | undefined, attributeNames: string[]) => (import("@scayle/storefront-api").Value | undefined)[];
+export declare const getManyAttributeValueTuples: (attributes: Attributes | undefined, attributeNames: string[]) => import("@scayle/storefront-api").Value[];

package/dist/helpers/filterHelper.d.ts

@@ -8,9 +8,9 @@ export interface TransformedFilter {
     whereCondition: Record<string, any>;
 }
 export declare const transformToWhereCondition: (conditions: Record<string, any>) => {
-    minPrice?: ProductSearchQuery['minPrice'];
-    maxPrice?: ProductSearchQuery['maxPrice'];
-    attributes: ProductSearchQuery['attributes'];
+    minPrice?: ProductSearchQuery["minPrice"];
+    maxPrice?: ProductSearchQuery["maxPrice"];
+    attributes: ProductSearchQuery["attributes"];
 };
 /**
  * Compute an array of filters that can be used to render the quick filters, for example.
@@ -68,7 +68,7 @@ export declare const transformSortToFilter: (sort: string) => {
 export declare const getGroupedFilterableValues: (keys: Array<string>, filterableValues: ProductFilter[], { sortable }?: {
     sortable: boolean;
 }) => Record<string, TransformedFilter[]>;
-export declare const getFilterablePriceValue: (filterableValues: Record<string, any>, key?: 'min' | 'max') => any;
+export declare const getFilterablePriceValue: (filterableValues: Record<string, any>, key?: "min" | "max") => any;
 export type SerializedFilter = Record<string, string>;
 export type Filter = Record<string, string | number | (string | number | null)[]>;
 /**

package/dist/helpers/imageHelpers.d.ts

@@ -1,4 +1,4 @@
 import type { ProductImageType } from '../constants/product';
 import type { Product, ProductImage } from '../index';
 export declare function isImageType(type: ProductImageType, image: ProductImage): boolean;
-export declare const getImageFromList: (images: Product['images'], imageType: string, imageView: string, fallback?: boolean) => ProductImage | null;
+export declare const getImageFromList: (images: Product["images"], imageType: string, imageView: string, fallback?: boolean) => ProductImage | null;

package/dist/helpers/localization.cjs

@@ -8,6 +8,6 @@ const getDefaultFractionDigits = (locale, currency) => {
   return new Intl.NumberFormat(locale, {
     style: "currency",
     currency
-  }).resolvedOptions().maximumFractionDigits;
+  }).resolvedOptions().maximumFractionDigits ?? 2;
 };
 exports.getDefaultFractionDigits = getDefaultFractionDigits;

package/dist/helpers/localization.mjs

@@ -2,5 +2,5 @@ export const getDefaultFractionDigits = (locale, currency) => {
   return new Intl.NumberFormat(locale, {
     style: "currency",
     currency
-  }).resolvedOptions().maximumFractionDigits;
+  }).resolvedOptions().maximumFractionDigits ?? 2;
 };

package/dist/helpers/orderHelpers.d.ts

@@ -1,67 +1,67 @@
 import type { Order } from '../types';
 export declare const getUniqueItemsFromOrder: (order: Order) => {
-    id?: number | undefined;
-    availableQuantity?: number | undefined;
-    currency?: string | undefined;
+    id?: import("../types").UniqueNumericIdentifierOfTheItem;
+    availableQuantity?: import("../types").AvailableQuantityInTheWarehouse;
+    currency?: import("../types").CharacterCurrencyCode1;
     customData?: {
         [k: string]: unknown;
-    } | undefined;
-    deliveryForecast?: import("../types").DeliveryForecastFromWarehouse | undefined;
-    isManuallyReturnedByCci?: boolean | undefined;
-    itemGroup?: {
+    };
+    deliveryForecast?: import("../types").DeliveryForecastFromWarehouse;
+    isManuallyReturnedByCci?: import("../types").TheReturnShipmentHasBeenTriggeredByCCI;
+    itemGroup?: null | {
         id: string;
         isMainItem: boolean;
         isRequired: boolean;
-    } | null | undefined;
-    key: string;
-    lowestPriorPrice?: {
+    };
+    key: import("../types").UniqueIdentifierOfTheItem;
+    lowestPriorPrice?: null | {
         relativeDifferenceToPrice: number;
         withTax: number;
-    } | null | undefined;
+    };
     merchant?: {
-        [k: string]: unknown;
         id: number;
-    } | undefined;
-    packageId: number;
+        [k: string]: unknown;
+    };
+    packageId: import("../types").PackageReference;
     price: {
         appliedReductions?: {
             amount: {
-                absoluteWithTax: number;
+                absoluteWithTax: import("../types").ThisFieldRepresentsTheDiscountAmountIncludingTheTaxes1;
                 relative: number;
             };
-            category: "voucher" | "sale" | "campaign";
-            code?: string | undefined;
-            type: "absolute" | "relative";
-        }[] | undefined;
-        overrideWithoutTax?: number | undefined;
-        overrideWithTax?: number | undefined;
+            category: "sale" | "campaign" | "voucher";
+            code?: string;
+            type: "relative" | "absolute";
+        }[];
+        overrideWithoutTax?: number;
+        overrideWithTax?: number;
         reference?: {
-            size?: string | undefined;
-            unit?: string | undefined;
-            withTax?: number | undefined;
-        } | undefined;
+            size?: string;
+            unit?: string;
+            withTax?: number;
+        };
         tax: {
             [k: string]: {
-                amount: number;
-                rate: number;
+                amount: import("../types").AbsoluteValueOfTheAppliedTax1;
+                rate: import("../types").RelativeValueOfTheAppliedTax;
             };
         };
-        undiscountedWithOutTax?: number | undefined;
-        undiscountedWithTax?: number | undefined;
-        withoutTax: number;
-        withTax: number;
+        undiscountedWithOutTax?: import("../types").UndiscountedItemPriceExcludingTaxes;
+        undiscountedWithTax?: import("../types").UndiscountedItemPriceIncludingTaxes;
+        withoutTax: import("../types").ItemPriceExcludingTaxes1;
+        withTax: import("../types").ItemPriceIncludingTaxes1;
     };
     product: {
         [k: string]: unknown;
     };
-    reservationKey?: string | undefined;
+    reservationKey?: string;
     status: "available" | "cancelled" | "delivered" | "returned" | "unavailable";
     variant: {
         [k: string]: unknown;
     };
-    warehouseId?: import("../types").PickingWarehouseId | undefined;
-    warehousePackageGroupId?: import("../types").WarehousePackageReference | undefined;
-    createdAt: string;
-    updatedAt: string;
+    warehouseId?: import("../types").PickingWarehouseId;
+    warehousePackageGroupId?: import("../types").WarehousePackageReference;
+    createdAt: import("../types").TimestampOfItemCreation;
+    updatedAt: import("../types").TimestampOfLastItemUpdate;
 }[] | undefined;
 export declare const getItemQuantityFromOrder: (order: Order, variantId: number) => number | undefined;

package/dist/helpers/productHelpers.d.ts

@@ -26,7 +26,7 @@ export declare const getTotalAppliedReductions: (price: {
     relative: number;
 };
 export declare const getLowestPrice: (variants: Variant[]) => VariantPrice;
-export declare const getAppliedReductionsByCategory: (price: VariantPrice | BasketItemPrice, category: AppliedReduction['category']) => AppliedReduction[];
+export declare const getAppliedReductionsByCategory: (price: VariantPrice | BasketItemPrice, category: AppliedReduction["category"]) => AppliedReduction[];
 export declare const getSizeFromVariant: (variant: Variant, attributeName?: string) => Value | undefined;
 export declare const getSizeFromSpecificVariant: (product: Product, variantId?: number) => Value | null | undefined;
 export declare const getVariant: (variants: Variant[], id: number) => Variant | undefined;
@@ -39,7 +39,7 @@ export declare const isVariantInStock: (variants: Variant[], size: Value, sizeAt
 export declare const getAttribute: (product: Product, key: string) => any;
 export declare const getProductPath: (product: Product) => string;
 export declare const getCategoriesByRoute: (product: Product | null, route: Route | null) => import("@scayle/storefront-api").ProductCategory[];
-export declare const getLatestCategory: (categories?: Product['categories']) => import("@scayle/storefront-api").ProductCategory | undefined;
+export declare const getLatestCategory: (categories?: Product["categories"]) => import("@scayle/storefront-api").ProductCategory | undefined;
 export declare const getProductAndSiblingsColors: (product: Product, colorAttributeName?: string) => Value[];
 export declare const getVariantCrosssellingValues: (variants: Variant[] | undefined) => (string | number)[];
 export {};

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

@@ -2,24 +2,24 @@ import type { AddOrUpdateItemError } from '@scayle/storefront-api';
 import type { AddOrUpdateItemType, BasketResponseData, BasketWithOptions, Product, RpcContext, Variant } from '../../../types';
 import { ExistingItemHandling } from '../../../constants';
 export declare const addItemToBasket: ({ variantId, promotionId, quantity, displayData, customData, existingItemHandling, itemGroup, with: _with, }: AddOrUpdateItemType & {
-    existingItemHandling?: 0 | 1 | 2 | 3 | undefined;
-    with?: BasketWithOptions | undefined;
+    existingItemHandling?: ExistingItemHandling;
+    with?: BasketWithOptions;
 }, context: RpcContext) => Promise<BasketResponseData<Product, Variant>>;
 export declare const addItemsToBasket: (params: {
     items: AddOrUpdateItemType[];
     existingItemHandling: ExistingItemHandling;
-    with?: BasketWithOptions | undefined;
+    with?: BasketWithOptions;
 }, context: RpcContext) => Promise<BasketResponseData<Product, Variant>>;
 export declare const getBasket: (options: BasketWithOptions | undefined, context: RpcContext) => Promise<BasketResponseData<Product, Variant>>;
 export declare const removeItemFromBasket: (options: {
     itemKey: string;
-    with?: BasketWithOptions | undefined;
+    with?: BasketWithOptions;
 }, context: RpcContext) => Promise<BasketResponseData<Product, Variant>>;
 export declare const clearBasket: (context: RpcContext) => Promise<boolean>;
 export declare const mergeBaskets: ({ fromBasketKey, toBasketKey, with: _with }: {
     fromBasketKey: string;
     toBasketKey: string;
-    with?: BasketWithOptions | undefined;
+    with?: BasketWithOptions;
 }, context: RpcContext) => Promise<{
     type: "failure";
     statusCode: number;

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

@@ -1,23 +1,23 @@
 import type { Category, ProductCategoryPropertyWith } from '../../types';
 export declare const getRootCategories: ({ children, includeHidden, properties }: {
-    children?: number | undefined;
-    includeHidden?: true | undefined;
-    properties?: ProductCategoryPropertyWith | undefined;
+    children?: number;
+    includeHidden?: true;
+    properties?: ProductCategoryPropertyWith;
 }, { cached, bapiClient }: import("../../types").RpcContext) => Promise<{
     categories: Category[];
     activeNode: undefined;
 }>;
 export declare const getCategoryByPath: ({ path, children, includeHidden, properties }: {
     path: string;
-    children?: number | undefined;
-    includeHidden?: true | undefined;
-    properties?: ProductCategoryPropertyWith | undefined;
+    children?: number;
+    includeHidden?: true;
+    properties?: ProductCategoryPropertyWith;
 }, context: import("../../types").RpcContext) => Promise<Category>;
 export declare const getCategoriesByPath: ({ path, children, includeHidden, properties }: {
     path: string;
-    children?: number | undefined;
-    includeHidden?: true | undefined;
-    properties?: ProductCategoryPropertyWith | undefined;
+    children?: number;
+    includeHidden?: true;
+    properties?: ProductCategoryPropertyWith;
 }, context: import("../../types").RpcContext) => Promise<{
     categories: Category[];
     activeNode: undefined;
@@ -27,7 +27,7 @@ export declare const getCategoriesByPath: ({ path, children, includeHidden, prop
 }>;
 export declare const getCategoryById: ({ id, children, includeHidden, properties }: {
     id: number;
-    children?: number | undefined;
-    includeHidden?: true | undefined;
-    properties?: ProductCategoryPropertyWith | undefined;
+    children?: number;
+    includeHidden?: true;
+    properties?: ProductCategoryPropertyWith;
 }, context: import("../../types").RpcContext) => Promise<Category>;

package/dist/rpc/methods/checkout/checkout.cjs

@@ -31,7 +31,7 @@ const getCheckoutToken = exports.getCheckoutToken = async function getCheckoutTo
     carrier,
     basketId: context.basketKey,
     campaignKey: context.campaignKey
-  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.58.0"}`).setProtectedHeader({
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.58.2"}`).setProtectedHeader({
     alg: "HS256",
     typ: "JWT"
   }).sign(secret);

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

@@ -21,7 +21,7 @@ export const getCheckoutToken = async function getCheckoutToken2(jwtPayload = {}
     carrier,
     basketId: context.basketKey,
     campaignKey: context.campaignKey
-  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.58.0"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"7.58.2"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
   return {
     accessToken: refreshedAccessToken,
     checkoutJwt

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

@@ -7,7 +7,7 @@ export declare const getProductsCount: ({ category, categoryId, where, includeSo
     count: number;
 }>;
 export declare const fetchAllFiltersForCategory: ({ includedFilters, category }: {
-    includedFilters?: string[] | undefined;
+    includedFilters?: string[];
     category: {
         slug: string;
         id: number;

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

@@ -4,9 +4,9 @@ type SearchWith = TypeaheadSuggestionsEndpointRequestParameters['with'];
 /** @deprecated `searchProducts` is deprecated. Please, use `getSuggestions` or `resolve` RPC methods */
 export declare const searchProducts: ({ term, slug, with: _with, productLimit }: {
     term: string;
-    slug?: string | undefined;
+    slug?: string;
     with?: SearchWith;
-    productLimit?: number | undefined;
+    productLimit?: number;
 }, { cached, bapiClient, withParams }: import("../../types").RpcContext) => Promise<TypeaheadSuggestionsEndpointResponseData>;
 export declare const getSearchSuggestions: ({ term, with: _with, categoryId }: SearchV2SuggestionsEndpointParameters, { bapiClient, withParams }: import("../../types").RpcContext) => Promise<SearchV2SuggestionsEndpointResponseData>;
 export declare const resolveSearch: ({ term, with: _with, categoryId }: SearchV2ResolveEndpointParameters, { cached, bapiClient, withParams }: import("../../types").RpcContext) => Promise<import("@scayle/storefront-api").SearchEntity | null>;

package/dist/rpc/methods/session.cjs

@@ -144,7 +144,7 @@ const oauthRevokeToken = async context => {
   const client = (0, _oauth.getOAuthClient)(context);
   await context.destroySession();
   try {
-    await client.revokeToken(accessToken);
+    await client.revokeToken(context.shopId, accessToken);
     return {
       result: true
     };

package/dist/rpc/methods/session.mjs

@@ -149,7 +149,7 @@ export const oauthRevokeToken = async (context) => {
   const client = getOAuthClient(context);
   await context.destroySession();
   try {
-    await client.revokeToken(accessToken);
+    await client.revokeToken(context.shopId, accessToken);
     return { result: true };
   } catch (error) {
     const res = convertErrorForRpcCall(error, [

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

@@ -17,6 +17,6 @@ declare const refreshUser: (context: RpcContext) => Promise<{
     user: ShopUser;
 }>;
 declare const getAccessToken: ({ forceTokenRefresh }: {
-    forceTokenRefresh?: boolean | undefined;
+    forceTokenRefresh?: boolean;
 }, context: RpcContext) => Promise<string | Response>;
 export { getUser, fetchUser, refreshUser, getAccessToken };

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "7.58.1",
+  "version": "7.58.3",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -59,9 +59,9 @@
     "test:ci": "vitest --run --passWithNoTests --coverage --reporter=default --reporter=junit"
   },
   "dependencies": {
-    "@scayle/storefront-api": "17.2.0",
+    "@scayle/storefront-api": "17.3.0",
     "crypto-js": "4.2.0",
-    "jose": "5.4.0",
+    "jose": "5.5.0",
     "radash": "12.1.0",
     "slugify": "1.6.6",
     "ufo": "1.5.3",
@@ -71,7 +71,7 @@
   "devDependencies": {
     "@scayle/eslint-config-storefront": "4.2.0",
     "@types/crypto-js": "4.2.2",
-    "@types/node": "20.14.5",
+    "@types/node": "20.14.9",
     "@types/webpack-env": "1.18.5",
     "@vitest/coverage-v8": "1.6.0",
     "dprint": "0.46.3",
@@ -80,7 +80,7 @@
     "publint": "0.2.8",
     "rimraf": "5.0.7",
     "ts-node": "10.9.2",
-    "typescript": "5.4.5",
+    "typescript": "5.5.2",
     "unbuild": "2.0.0",
     "unstorage": "1.10.2",
     "vitest": "1.6.0"