@scayle/storefront-core 8.8.0 → 8.9.0

package/CHANGELOG.md

@@ -1,11 +1,35 @@
 # @scayle/storefront-core
 
+## 8.9.0
+
+### Minor Changes
+
+- Extend `RpcContext` with an `rpcCall` property. This is a utility function that can be used within RPC methods to invoke another RPC method.
+
 ## 8.8.0
 
 ### Minor Changes
 
 - Deprecate `RpcContext.campaignKey`. The `getCampaignKey` RPC should be used instead.
 
+To get the default campaign key, you can call the RPC method:
+
+```typescript
+// Before
+async function rpcMethod(context) {
+  const campaignKey = { context }
+  // ...
+}
+// After
+async function rpcMethod(context) {
+  const campaignKey = await context.callRpc?.('getCampaignKey')
+  // ...
+}
+```
+
+To override the default campaign key, override the getCampaignKey RPC with your own implementation.
+See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/rpc-methods#overriding-core-rpc-methods) for more.
+
 ## 8.7.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import * as rpcMethods from './rpc/methods';
+import type { RpcContext } from './types';
 export { rpcMethods };
 export * from './errors';
 export * from './utils';
@@ -65,4 +66,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 { ExistingItemHandling, AddToBasketFailureKind, UpdateBasketItemFailureKind, AddToWishlistFailureKind, PromotionEffectType, FilterTypes, APISortOption, APISortOrder, type ProductSortConfig, } from '@scayle/storefront-api';

package/dist/rpc/methods/basket/basket.mjs

@@ -9,7 +9,6 @@ import {
 import { mergeBaskets as mergeBasketFunction } from "../../../utils/user.mjs";
 import { unwrap } from "../../../utils/response.mjs";
 import { wasAddedWithReducedQuantity } from "../../../utils/index.mjs";
-import { getCampaignKey } from "../campaign.mjs";
 const SAPI_ERROR_NAME = "SAPI ERROR";
 function getWithParams(params, context) {
   return params.with ?? context.withParams?.basket ?? MIN_WITH_PARAMS_BASKET;
@@ -33,7 +32,7 @@ export const addItemToBasket = async function addItemToBasket2({
     );
   }
   const { sapiClient, basketKey } = context;
-  const campaignKey = await getCampaignKey(context);
+  const campaignKey = await context.callRpc?.("getCampaignKey");
   const resolvedWith = getWithParams(
     { with: _with },
     context
@@ -94,7 +93,7 @@ export const addItemsToBasket = async function addItemsToBasket2(params, context
     );
   }
   const { sapiClient, basketKey } = context;
-  const campaignKey = await getCampaignKey(context);
+  const campaignKey = await context.callRpc?.("getCampaignKey");
   const resolvedWith = getWithParams(params, context);
   const itemsToBeAddedOrUpdated = params.items.map((item) => ({
     variantId: item.variantId,
@@ -155,7 +154,7 @@ export const getBasket = async function getBasket2(options, context) {
     );
   }
   const { sapiClient, basketKey } = context;
-  const campaignKey = await getCampaignKey(context);
+  const campaignKey = await context.callRpc?.("getCampaignKey");
   const resolvedWith = getWithParams(
     { with: options },
     context
@@ -188,7 +187,7 @@ export const removeItemFromBasket = async function removeItemFromBasket2(options
     );
   }
   const { sapiClient, basketKey } = context;
-  const campaignKey = await getCampaignKey(context);
+  const campaignKey = await context.callRpc?.("getCampaignKey");
   const resolvedWith = getWithParams(options, context);
   const basket = await sapiClient.basket.deleteItem(
     basketKey,

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

@@ -1,5 +1,4 @@
-import { ErrorResponse } from '../../../errors';
-import type { RpcContext } from '../../../types';
+import type { RpcHandler } from '../../../types';
 interface CheckoutJwtPayload {
     voucher?: string;
     customData?: Record<string, unknown>;
@@ -9,7 +8,7 @@ interface CheckoutJwtPayload {
     };
     carrier?: string;
 }
-export declare const getCheckoutToken: (jwtPayload: CheckoutJwtPayload | undefined, context: RpcContext) => Promise<ErrorResponse | {
+export declare const getCheckoutToken: RpcHandler<CheckoutJwtPayload | undefined, {
     accessToken: string;
     checkoutJwt: string;
 }>;

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

@@ -3,7 +3,6 @@ import { hasSession } from "../../../types/index.mjs";
 import { ErrorResponse } from "../../../errors/index.mjs";
 import { HttpStatusCode, HttpStatusMessage } from "../../../constants/index.mjs";
 import { getAccessToken } from "../user.mjs";
-import { getCampaignKey } from "../campaign.mjs";
 export const getCheckoutToken = async function getCheckoutToken2(jwtPayload = {}, context) {
   if (!hasSession(context)) {
     return new ErrorResponse(
@@ -29,7 +28,7 @@ export const getCheckoutToken = async function getCheckoutToken2(jwtPayload = {}
   const secret = new TextEncoder().encode(context.checkout.secret);
   const now = /* @__PURE__ */ new Date();
   const { voucher, customData, preferredCollectionPoint, carrier } = jwtPayload;
-  const campaignKey = await getCampaignKey(context);
+  const campaignKey = await context.callRpc?.("getCampaignKey");
   const checkoutJwt = await new SignJWT({
     voucher,
     customData,
@@ -37,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.8.0"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.9.0"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
   return {
     accessToken: refreshedAccessToken,
     checkoutJwt

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

@@ -1,6 +1,4 @@
-import type { FiltersEndpointResponseData } from '@scayle/storefront-api';
-import type { FetchFiltersParams, FetchProductParams, FetchProductsByCategoryParams, FetchProductsByIdsParams, FetchProductsByReferenceKeysParams, FetchProductsCountParams, Product, RpcContext } from '../../types';
-import { ErrorResponse } from '../../errors';
+import type { FetchFiltersParams, FetchFiltersResponse, FetchProductParams, FetchProductsByCategoryParams, FetchProductsByCategoryResponse, FetchProductsByIdsParams, FetchProductsByReferenceKeysParams, FetchProductsCountParams, FetchProductsCountResponse, Product, RpcContext, RpcHandler } from '../../types';
 /**
  * For functions which accept either a category path or category ID,
  * this function can resolve the ID which is necessary for the calling
@@ -20,32 +18,15 @@ export declare function resolveCategoryIdFromParams(context: RpcContext, params:
     category: string | undefined;
     categoryId: number | undefined;
 }>;
-export declare const getProductById: (options: FetchProductParams, context: RpcContext) => Promise<Response | Product>;
-export declare const getProductsByIds: (options: FetchProductsByIdsParams, context: RpcContext) => Promise<Response | Product[]>;
-export declare const getProductsByReferenceKeys: (options: FetchProductsByReferenceKeysParams, context: RpcContext) => Promise<Response | Product[]>;
-export declare const getProductsCount: (params: FetchProductsCountParams, context: RpcContext) => Promise<(string[] & ErrorResponse) | {
-    count: number;
-}>;
-export declare const fetchAllFiltersForCategory: ({ includedFilters, category }: {
+export declare const getProductById: RpcHandler<FetchProductParams, Product>;
+export declare const getProductsByIds: RpcHandler<FetchProductsByIdsParams, Product[]>;
+export declare const getProductsByReferenceKeys: RpcHandler<FetchProductsByReferenceKeysParams, Product[]>;
+export declare const getProductsCount: RpcHandler<FetchProductsCountParams, FetchProductsCountResponse>;
+export declare const fetchAllFiltersForCategory: RpcHandler<{
     includedFilters?: string[];
     category: {
         id?: number;
     };
-}, context: RpcContext) => Promise<string[]>;
-export declare const getFilters: (params: FetchFiltersParams, context: RpcContext) => Promise<(string[] & ErrorResponse) | {
-    filters: FiltersEndpointResponseData;
-    unfilteredCount: number;
-}>;
-export declare const getProductsByCategory: (params: FetchProductsByCategoryParams, context: RpcContext) => Promise<(string[] & ErrorResponse) | {
-    products: Product[];
-    pagination: {
-        current: number;
-        total: number;
-        perPage: number;
-        page: number;
-        first: number;
-        prev: number;
-        next: number;
-        last: number;
-    };
-}>;
+}, string[]>;
+export declare const getFilters: RpcHandler<FetchFiltersParams, FetchFiltersResponse>;
+export declare const getProductsByCategory: RpcHandler<FetchProductsByCategoryParams, FetchProductsByCategoryResponse>;

package/dist/rpc/methods/products.mjs

@@ -4,7 +4,6 @@ import { MINUTE } from "../../cache/index.mjs";
 import { unwrap } from "../../utils/response.mjs";
 import { mapSAPIFetchErrorToResponse } from "../../utils/sapi.mjs";
 import { ErrorResponse } from "../../errors/index.mjs";
-import { getCampaignKey } from "./campaign.mjs";
 const MAX_PER_PAGE = 100;
 const sanitizeAttributesForSAPI = ({
   attributes,
@@ -37,7 +36,7 @@ export async function resolveCategoryIdFromParams(context, params) {
 }
 export const getProductById = async function getProductById2(options, context) {
   const { sapiClient, cached, withParams } = context;
-  const campaignKey = await getCampaignKey(context);
+  const campaignKey = await context.callRpc?.("getCampaignKey");
   return await cached(
     mapSAPIFetchErrorToResponse(sapiClient.products.getById),
     {
@@ -53,7 +52,7 @@ export const getProductById = async function getProductById2(options, context) {
 };
 export const getProductsByIds = async function getProductsByIds2(options, context) {
   const { sapiClient, cached, withParams } = context;
-  const campaignKey = await getCampaignKey(context);
+  const campaignKey = await context.callRpc?.("getCampaignKey");
   return await cached(
     mapSAPIFetchErrorToResponse(sapiClient.products.getByIds),
     {
@@ -68,7 +67,7 @@ export const getProductsByIds = async function getProductsByIds2(options, contex
 };
 export const getProductsByReferenceKeys = async function getProductsByReferenceKeys2(options, context) {
   const { sapiClient, cached, withParams } = context;
-  const campaignKey = await getCampaignKey(context);
+  const campaignKey = await context.callRpc?.("getCampaignKey");
   return await cached(
     mapSAPIFetchErrorToResponse(sapiClient.products.getByReferenceKeys),
     {
@@ -90,7 +89,7 @@ export const getProductsCount = async function getProductsCount2(params, context
     orFiltersOperator = void 0
   } = params;
   const { cached, sapiClient } = context;
-  const campaignKey = await getCampaignKey(context);
+  const campaignKey = await context.callRpc?.("getCampaignKey");
   const { categoryId } = await resolveCategoryIdFromParams(context, params);
   const response = await getSanitizedAttributes(
     context,
@@ -131,7 +130,7 @@ export const getProductsCount = async function getProductsCount2(params, context
 };
 export const fetchAllFiltersForCategory = async function fetchAllFiltersForCategory2({ includedFilters = [], category }, context) {
   const { cached, sapiClient } = context;
-  const campaignKey = await getCampaignKey(context);
+  const campaignKey = await context.callRpc?.("getCampaignKey");
   const fetchAndMapFiltersToSlugs = async () => {
     const filtersFromSAPI = await cached(sapiClient.filters.get)({
       where: { categoryId: category.id },
@@ -173,7 +172,7 @@ export const getFilters = async function getFilters2(params, context) {
     orFiltersOperator
   } = params;
   const { cached, sapiClient } = context;
-  const campaignKey = await getCampaignKey(context);
+  const campaignKey = await context.callRpc?.("getCampaignKey");
   const { category, categoryId } = await resolveCategoryIdFromParams(
     context,
     params
@@ -253,7 +252,7 @@ export const getProductsByCategory = async function getProductsByCategory2(param
     trackSearchAnalyticsEvent = void 0
   } = params;
   const { cached, sapiClient } = context;
-  const campaignKey = await getCampaignKey(context);
+  const campaignKey = await context.callRpc?.("getCampaignKey");
   const { category, categoryId } = await resolveCategoryIdFromParams(
     context,
     params

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

@@ -1,8 +1,8 @@
 import type { ProductWith, VariantDetail } from '@scayle/storefront-api';
-import type { RpcContext } from '../../types';
+import type { RpcHandler } from '../../types';
 export interface FetchVariantsParams {
     ids: number[];
     include?: ProductWith;
     pricePromotionKey?: string;
 }
-export declare const getVariantById: ({ ids, include, pricePromotionKey }: FetchVariantsParams, context: RpcContext) => Promise<Response | VariantDetail[]>;
+export declare const getVariantById: RpcHandler<FetchVariantsParams, VariantDetail[]>;

package/dist/rpc/methods/variants.mjs

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

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

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

package/dist/rpc/methods/wishlist.mjs

@@ -7,7 +7,6 @@ import {
 import { unwrap } from "../../utils/response.mjs";
 import { ErrorResponse } from "../../errors/index.mjs";
 import { mapSAPIFetchErrorToResponse } from "../../utils/sapi.mjs";
-import { getCampaignKey } from "./campaign.mjs";
 function getWithParams(params, context) {
   return params.with ?? context.withParams?.wishlist ?? MIN_WITH_PARAMS_WISHLIST;
 }
@@ -20,7 +19,7 @@ export const getWishlist = async function getWishlist2(options, context) {
     );
   }
   const { sapiClient, wishlistKey } = context;
-  const campaignKey = await getCampaignKey(context);
+  const campaignKey = await context.callRpc?.("getCampaignKey");
   const resolvedWith = getWithParams({ with: options }, context);
   return await mapSAPIFetchErrorToResponse(sapiClient.wishlist.get)(
     wishlistKey,
@@ -40,7 +39,7 @@ export const addItemToWishlist = async function addItemToWishlist2(options, cont
     );
   }
   const { sapiClient, wishlistKey } = context;
-  const campaignKey = await getCampaignKey(context);
+  const campaignKey = await context.callRpc?.("getCampaignKey");
   const { productId, variantId } = options;
   const resolvedWith = getWithParams(options, context);
   const pricePromotionKey = resolvedWith?.pricePromotionKey ?? "";
@@ -77,7 +76,7 @@ export const removeItemFromWishlist = async function removeItemFromWishlist2(opt
     );
   }
   const { sapiClient, wishlistKey } = context;
-  const campaignKey = await getCampaignKey(context);
+  const campaignKey = await context.callRpc?.("getCampaignKey");
   const resolvedWith = getWithParams(options, context);
   return await mapSAPIFetchErrorToResponse(sapiClient.wishlist.deleteItem)(
     wishlistKey,

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

@@ -5,6 +5,7 @@ import type { CachedType } from '../../cache/cached';
 import type { AuthenticationType, ShopUser } from '../user';
 import type { BasketWithOptions, CategoryWith, ProductCategoryWith, ProductWith, SearchV2With, SearchWith, VariantWith, WishlistWithOptions } from '../';
 import type { IDPConfig, OAuthTokens } from './auth';
+import type { RpcMethodCall } from '../..';
 export type WithParams = Partial<{
     basket: BasketWithOptions;
     wishlist: WishlistWithOptions;
@@ -78,7 +79,25 @@ export type RpcContext = {
     domain?: string;
     withParams?: WithParams;
     /**
-     * @deprecated Use the `getCampaignKey` RPC method instead.
+     * @deprecated The `getCampaignKey` RPC method should be used instead to retrieve the default campaign key.
+     *
+     * @example
+     *
+     * ```typescript
+     * // Before
+     * async function rpcMethod(context) {
+     *    const campaignKey = { context }
+     *    // ...
+     * }
+     * // After
+     * async function rpcMethod(context) {
+     *    const campaignKey = await context.callRpc?.('getCampaignKey')
+     *    // ...
+     * }
+     * ```
+     *
+     * To override the default campaign key, override the getCampaignKey RPC with your own implementation
+     * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/rpc-methods#overriding-core-rpc-methods
      */
     campaignKey?: string;
     destroySessionsForUserId: (userId: number, sessionsToKeep?: string[]) => Promise<void>;
@@ -102,6 +121,7 @@ export type RpcContext = {
     callHook?: Hookable<StorefrontHooks>['callHook'];
     callHookParallel?: Hookable<StorefrontHooks>['callHookParallel'];
     callHookWith?: Hookable<StorefrontHooks>['callHookWith'];
+    callRpc?: RpcMethodCall;
 } & AdditionalRpcContext & (ContextWithoutSession | ContextWithSession);
 export type RpcContextWithSession = RpcContext & ContextWithSession;
 export declare function assertSession(context: RpcContext): asserts context is RpcContextWithSession;

package/dist/utils/campaign.d.ts

@@ -1,23 +1,38 @@
 import type { Campaign } from '@scayle/storefront-api';
 /**
- * Determine if a campaign is active for the current date
+ * Checks if a given campaign is currently active.
  *
- * @param campaign the campaign to test
- * @returns True when the current datetime is within the campaign's timeframe, false otherwise
+ * Determines if the current time falls within the campaign's start and end dates.
+ *
+ * @see https://scayle.dev/en/user-guide/shops/promotions/discounts-and-offers/price-campaigns
+ *
+ * @param campaign The campaign to check.
+ *
+ * @returns True if the campaign is active, false otherwise.
  */
 export declare const isCampaignActive: (campaign?: Campaign) => boolean;
 /**
- * Determine if a campaign has ended based on the current datetime
+ * Checks if a given campaign has not yet ended.
+ *
+ * Compares the campaign's end date with the current time.
+ *
+ * @see https://scayle.dev/en/user-guide/shops/promotions/discounts-and-offers/price-campaigns
  *
- * @param campaign
- * @returns True if the campaign's end date is later than the current datetime, false otherwise
+ * @param campaign The campaign to check.
+ *
+ * @returns True if the campaign has not ended, false otherwise.
  */
 export declare const campaignHasNotEnded: (campaign: Campaign) => boolean;
 /**
- * Comparison function for campaigns based on their start date. To be used with Array.prototype.sort()
+ * Sorts campaigns by their start date in ascending order.
+ *
+ * Uses the difference between start times to determine order.
+ *
+ * @see https://scayle.dev/en/user-guide/shops/promotions/discounts-and-offers/price-campaigns
+ *
+ * @param a The first campaign to compare.
+ * @param b The second campaign to compare.
  *
- * @param a The first campaign for comparison
- * @param b The second campaign for comparison
- * @returns A positive value when a should come before b, negative value when b should come before a, or 0 when they are considered equal
+ * @returns A negative number if `a` starts before `b`, a positive number if `a` starts after `b`, and 0 if they start at the same time.
  */
 export declare const sortCampaignsByDateAscending: (a: Campaign, b: Campaign) => number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.8.0",
+  "version": "8.9.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -68,17 +68,17 @@
   "devDependencies": {
     "@scayle/eslint-config-storefront": "4.4.1",
     "@types/crypto-js": "4.2.2",
-    "@types/node": "22.13.4",
+    "@types/node": "22.13.5",
     "@types/webpack-env": "1.18.8",
     "@vitest/coverage-v8": "2.1.9",
     "dprint": "0.49.0",
-    "eslint": "9.20.1",
+    "eslint": "9.21.0",
     "eslint-formatter-gitlab": "5.1.0",
     "publint": "0.2.12",
     "rimraf": "6.0.1",
     "typescript": "5.7.3",
     "unbuild": "3.3.1",
-    "unstorage": "1.14.4",
+    "unstorage": "1.15.0",
     "vitest": "2.1.9"
   }
 }