@scayle/storefront-core 8.8.0 → 8.10.0

package/dist/helpers/productDisruptorHelper.d.ts

@@ -1,10 +1,53 @@
+/**
+ * Calculates the row index for an item given its overall index and pagination options.
+ *
+ * @param index The overall index of the item.
+ * @param options Pagination options. Defaults to 2 columns, page 1, and 24 items per page.
+ * @param options.columns
+ * @param options.page
+ * @param options.perPage
+ *
+ * @returns The calculated row index.
+ *
+ * @deprecated Row Disruption and associated functionality should be handled within the Storefront project itself.
+ */
 export declare const getRowByIndex: (index: number, options?: {
     columns: number;
     page: number;
     perPage: number;
 }) => number;
+/**
+ * Filters disruptors for a specific row.
+ *
+ * @param row The row number.
+ * @param disruptors An array of disruptor objects.
+ *
+ * @returns An array of disruptors belonging to the specified row.
+ *
+ * @deprecated Row Disruption and associated functionality should be handled within the Storefront project itself.
+ */
 export declare const getDisruptorsForRow: (row: number, disruptors: {
     insert_in_row: string;
 }[]) => object[];
+/**
+ * Checks if the given index is the first index of a row.
+ *
+ * @param index The index to check.
+ * @param columns The number of columns.
+ *
+ * @returns True if the index is the first of a row, false otherwise.
+ *
+ * @deprecated Row Disruption and associated functionality should be handled within the Storefront project itself.
+ */
 export declare const isFirstIndexOfRow: (index: number, columns: number) => boolean;
+/**
+ * Checks if a disruptor exists at a specific row.
+ *
+ * @param row The row number.
+ * @param disruptorRows An array of disruptor row numbers as strings.
+ *
+ * @returns True if a disruptor exists at the specified row, false otherwise.
+ *
+ * @deprecated Row Disruption and associated functionality should be handled within the Storefront project itself.
+ */
 export declare const hasDisruptorAtRow: (row: number, disruptorRows: string[]) => boolean;

package/dist/helpers/productHelpers.d.ts

@@ -3,9 +3,37 @@ import type { ProductSibling } from '../types/sapi/product';
 interface Route {
     path?: string;
 }
+/**
+ * Generates a slug from a given URL string.
+ *
+ * @param url The URL string to slugify.
+ *
+ * @returns The slugified string.
+ */
 export declare const slugify: (url: string | undefined) => string;
+/**
+ * Retrieves the price of a variant.
+ *
+ * @param variant The variant object.
+ *
+ * @returns The variant price.
+ */
 export declare const getPrice: (variant: Variant) => VariantPrice;
+/**
+ * Retrieves the original price of a variant price.
+ *
+ * @param price The variant price object.
+ *
+ * @returns The original price.
+ */
 export declare const getOriginalPrice: (price: VariantPrice) => number;
+/**
+ * Calculates the total applied reductions from a price object.
+ *
+ * @param price The price object containing applied reductions.
+ *
+ * @returns The total applied reductions.
+ */
 export declare const getTotalAppliedReductions: (price: {
     appliedReductions: {
         amount: {
@@ -17,21 +45,162 @@ export declare const getTotalAppliedReductions: (price: {
     absoluteWithTax: number;
     relative: number;
 };
+/**
+ * Gets the lowest price from a list of variants.
+ *
+ * @param variants An array of variants.
+ *
+ * @returns The lowest variant price.
+ */
 export declare const getLowestPrice: (variants: Variant[]) => VariantPrice;
+/**
+ * Filters applied reductions by a specific category.
+ *
+ * @param price The price object.
+ * @param category The category to filter by.
+ *
+ * @returns An array of applied reductions matching the category.
+ */
 export declare const getAppliedReductionsByCategory: (price: VariantPrice | BasketItemPrice, category: AppliedReduction["category"]) => AppliedReduction[];
+/**
+ * Retrieves the size from a variant.
+ *
+ * @param variant The variant object.
+ * @param attributeName The name of the size attribute. Defaults to 'shopSize'.
+ *
+ * @returns The size value.
+ */
 export declare const getSizeFromVariant: (variant: Variant, attributeName?: string) => Value | undefined;
+/**
+ * Retrieves the size from a specific variant within a product.
+ *
+ * @param product The product object.
+ * @param variantId The ID of the variant.
+ *
+ * @returns The size value, or null if not found.
+ */
 export declare const getSizeFromSpecificVariant: (product: Product, variantId?: number) => Value | null | undefined;
+/**
+ * Retrieves a specific variant from a list of variants.
+ *
+ * @param variants An array of variants.
+ * @param id The ID of the variant to retrieve.
+ *
+ * @returns The variant object if found, otherwise undefined.
+ */
 export declare const getVariant: (variants: Variant[], id: number) => Variant | undefined;
+/**
+ * Retrieves all unique sizes from a list of variant attributes.
+ *
+ * @param variantsAttributes An array of variants.
+ * @param attributeName The name of the size attribute. Defaults to 'shopSize'.
+ *
+ * @returns An array of unique size values.
+ */
 export declare const getAllSizesFromVariants: (variantsAttributes: Variant[], attributeName?: string) => any[];
+/**
+ * Retrieves product siblings including the product itself.
+ * Filters out inactive siblings.
+ *
+ * @param product The product object. If null or undefined, returns an empty array.
+ * @param colorAttributeName The name of the attribute representing the product's color.
+ * Defaults to 'colorDetail'. This attribute is used to extract color information
+ * for each sibling using `getAttributeValueTuples`.
+ *
+ * @returns An array of simplified product sibling objects. Each object has the following structure:
+ *   - `id`: The ID of the product sibling.
+ *   - `image`: The URL of the product's bust image, front view. Retrieved using `getImageFromList`.
+ *      If no suitable image is found, this field may be null.
+ *   - `colors`: An array of color values extracted from the attribute specified by `colorAttributeName`.
+ *      This is the result of calling `getAttributeValueTuples` with the product's attributes and `colorAttributeName`.
+ *      If the attribute is not found, this will be an empty array.
+ */
 export declare const getProductSiblings: (product?: Product | null, colorAttributeName?: string) => ProductSibling[];
+/**
+ * Retrieves the colors of a product.
+ *
+ * @param product The product object.
+ * @param colorAttributeName The name of the color attribute. Defaults to 'colorDetail'.
+ *
+ * @returns An array of product color labels.
+ */
 export declare const getProductColors: (product: Product, colorAttributeName?: string) => string[];
+/**
+ * Retrieves a variant by its size.
+ *
+ * @param variants An array of variants.
+ * @param size The size value to search for.
+ * @param sizeAttributeName The name of the size attribute. Defaults to 'shopSize'.
+ *
+ * @returns The variant object if found, otherwise undefined.
+ */
 export declare const getVariantBySize: (variants: Variant[], size: Value, sizeAttributeName?: string) => Variant | undefined;
+/**
+ * Checks if a variant is in stock.
+ *
+ * @param variant The variant object.
+ *
+ * @returns True if the variant is in stock or sellable when out-of-stock, false otherwise.
+ */
 export declare const isInStock: (variant: Variant) => boolean;
+/**
+ * Checks if a variant with a specific size is in stock.
+ *
+ * @param variants An array of variants.
+ * @param size The size value to check.
+ * @param sizeAttributeName The name of the size attribute. Defaults to 'shopSize'.
+ *
+ * @returns True if the variant is in stock, false otherwise.
+ */
 export declare const isVariantInStock: (variants: Variant[], size: Value, sizeAttributeName?: string) => boolean;
+/**
+ * Retrieves an attribute value from a product.
+ *
+ * @param product The product object.
+ * @param key The attribute key.
+ *
+ * @returns  The attribute value.
+ */
 export declare const getAttribute: (product: Product, key: string) => any;
+/**
+ * Generates the product path based on product name and id
+ *
+ * @param product The product object
+ *
+ * @returns The product path as string
+ */
 export declare const getProductPath: (product: Product) => string;
+/**
+ *  Retrieves categories matching a given route from a product.
+ *
+ * @param product The product object
+ * @param route The route object containing path information.
+ *
+ * @returns An array of categories.
+ */
 export declare const getCategoriesByRoute: (product: Product | null, route: Route | null) => import("@scayle/storefront-api").ProductCategory[];
+/**
+ * Retrieves the latest/deepest category from product categories
+ *
+ * @param categories List of product categories
+ *
+ * @returns The latest category object or undefined
+ */
 export declare const getLatestCategory: (categories?: Product["categories"]) => import("@scayle/storefront-api").ProductCategory | undefined;
+/**
+ * Retrieves colors from a product and its siblings
+ *
+ * @param product The product data.
+ * @param colorAttributeName The name of the color attribute (default: 'colorDetail').
+ *
+ * @returns An array of color values.
+ */
 export declare const getProductAndSiblingsColors: (product: Product, colorAttributeName?: string) => Value[];
+/**
+ * Extracts unique crossselling values from variants' advanced attributes.
+ *
+ * @param variants An array of variants.
+ * @returns An array of unique crossselling values (strings or numbers).
+ */
 export declare const getVariantCrosssellingValues: (variants: Variant[] | undefined) => (string | number)[];
 export {};

package/dist/helpers/sanitizationHelpers.d.ts

@@ -1,4 +1,65 @@
+/**
+ * Removes the shop locale segment from a given path.
+ *
+ * @param locale The locale to remove (case-insensitive).
+ * @param path The path string.
+ * @param splitter The path separator. Defaults to '/'.
+ *
+ * @returns The path with the locale segment removed.
+ *
+ * @example
+ * ```typescript
+ * stripShopLocaleFromPath('en', '/en/products') // '/products'
+ * stripShopLocaleFromPath('de', '/de/category/shoes') // '/category/shoes'
+ * ```
+ */
 export declare const stripShopLocaleFromPath: (locale: string, path: string, splitter?: string) => string;
+/**
+ * Purifies a sensitive value by masking characters. Optionally shows the first and last characters.
+ *
+ * @param value The sensitive value to purify.
+ * @param showFirstAndLastChar Whether to show the first and last characters. Defaults to `false`.
+ *
+ * @returns The purified value.
+ *
+ * @example
+ * ```typescript
+ * purifySensitiveValue("secret") // "********"
+ * purifySensitiveValue("secret", true) // "s****t"
+ * purifySensitiveValue("ab", true) // "ab"  (doesn't mask if less than 3 characters)
+ * ```
+ */
 export declare const purifySensitiveValue: (value: string, showFirstAndLastChar?: boolean) => string;
+/**
+ * Purifies sensitive data from an object by masking values associated with blacklisted keys.
+ * Handles nested objects recursively.
+ *
+ * @param data The object containing potentially sensitive data.
+ * @param blacklistedKeys An array of keys to mask. Defaults to `['password']`.
+ * @param showFirstAndLastChar Whether to show the first and last characters of sensitive values. Defaults to `false`.
+ *
+ * @returns A new object with sensitive data purified.
+ *
+ * @example
+ * ```typescript
+ * const data = { name: "John", password: "mysecret", address: { street: "123 Main St", zip: "12345" } }
+ *
+ * const purified = purifySensitiveData(data) // { name: "John", password: "********", address: { street: "123 Main St", zip: "12345" } }
+ * const purifiedWithFirstLast = purifySensitiveData(data, ['password', 'zip'], true)  // { name: "John", password: "m****t", address: { street: "123 Main St", zip: "1****5" } }
+ * ```
+ */
 export declare const purifySensitiveData: (data?: Record<string, any>, blacklistedKeys?: string[], showFirstAndLastChar?: boolean) => Record<string, any>;
+/**
+ * Creates a Headers object from a record, filtering out undefined values.
+ *
+ * @param headers A partial record of header key-value pairs. Undefined values are ignored.
+ *
+ * @returns A new `Headers` object.
+ *
+ * @example
+ * ```typescript
+ * const headers = createAndPurifyHeaders({ 'Content-Type': 'application/json', Authorization: undefined })
+ * // headers now contains only the 'Content-Type' header
+ * ```
+ */
 export declare const createAndPurifyHeaders: (headers: Partial<Record<string, string | undefined>>) => Headers;

package/dist/helpers/sortingHelper.d.ts

@@ -1,4 +1,12 @@
 import type { Query, SortingValueKey } from '../index';
+/**
+ * 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.
+ *
+ * @param options An array of sorting value keys to include in the result. Defaults to all available keys.
+ *
+ * @returns An object mapping valid sorting keys to their configurations.
+ */
 export declare const getSortingValues: (options?: Array<SortingValueKey>) => {
     [k: string]: {
         by: "price";
@@ -31,6 +39,14 @@ export declare const getSortingValues: (options?: Array<SortingValueKey>) => {
         query: "reduction-asc";
     };
 };
+/**
+ * Retrieves the sorting configuration based on the provided query.
+ *
+ * @param query The sort query parameter.
+ * @param defaultSort The default sorting key to use if the query is not recognized. Defaults to 'dateNewest'.
+ *
+ * @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";

package/dist/helpers/stringHelpers.d.ts

@@ -1,2 +1,16 @@
+/**
+ * Splits a string by a separator and removes any empty strings from the resulting array.
+ *
+ * @param value The string to split.
+ * @param separator The separator to use. Defaults to '/'.
+ * @returns An array of non-empty strings.
+ *
+ * @example
+ * ```typescript
+ * splitAndRemoveEmpty("a/b/c") // ["a", "b", "c"]
+ * splitAndRemoveEmpty("a//b/c", "/") // ["a", "b", "c"]
+ * splitAndRemoveEmpty("a/b//", "/") // ["a", "b"]
+ * ```
+ */
 declare const splitAndRemoveEmpty: (value: string, separator?: string) => string[];
 export { splitAndRemoveEmpty };

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';
@@ -39,7 +40,7 @@ export type RpcMethods = {
  * added RPC methods from the SCAYLE Storefront application.
  *
  * @see https://github.com/microsoft/TypeScript/pull/42149#issuecomment-865385560
- * @
+ *
  * Without this workaround, the signature to `rpcCall` looks something like
  * `rpcCall(m: 'addItemToBasket' | 'addItemToWishlist'...)`.
  * But we need it to look like `rpcCall(m: RpcMethodName)` in order to include
@@ -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.d.ts

@@ -2,6 +2,24 @@ 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';
+/**
+ * Adds an item to the basket.
+ *
+ * @param params The parameters for adding a single item to a basket.
+ * @param params.variantId The ID of the variant to add.
+ * @param params.promotionId The ID of the promotion.
+ * @param params.quantity The quantity of the item to add.
+ * @param params.displayData Display data for the item.
+ * @param params.customData Custom data for the item.
+ * @param params.existingItemHandling How to handle existing items, default to `'AddQuantityToExisting'`.
+ * @param params.itemGroup The item group.
+ * @param params.with withParams for basket.
+ * @param params.orderCustomData Custom data for order.
+ * @param context The RPC context.
+ *
+ * @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 & {
     existingItemHandling?: ExistingItemHandling;
     with?: BasketWithOptions;
@@ -13,6 +31,19 @@ export declare const addItemToBasket: ({ variantId, promotionId, quantity, displ
     basket: BasketResponseData<Product, Variant>;
     errors: AddOrUpdateItemError[];
 }>;
+/**
+ * Adds multiple items to the basket.
+ *
+ * @param params The parameters for adding multiple items to a basket.
+ * @param params.items An array of items to add.
+ * @param params.existingItemHandling How to handle existing items.
+ * @param params.with withParams for basket.
+ * @param params.orderCustomData Order custom data.
+ * @param context The RPC context.
+ *
+ * @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: {
     items: AddOrUpdateItemType[];
     existingItemHandling: ExistingItemHandling;
@@ -25,11 +56,33 @@ export declare const addItemsToBasket: (params: {
     basket: BasketResponseData<Product, Variant>;
     errors: AddOrUpdateItemError[];
 }>;
+/**
+ * Retrieves the current basket.
+ *
+ * @param options The options for retrieving the basket.
+ * @param options.orderCustomData Custom data for the order.
+ * @param context The RPC context.
+ *
+ * @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 & {
     orderCustomData?: Record<string, unknown>;
 }) | undefined, context: RpcContext) => Promise<ErrorResponse | {
     basket: BasketResponseData<Product, Variant>;
 }>;
+/**
+ * Removes an item from the basket.
+ *
+ * @param options The options for removing the item.
+ * @param options.itemKey The key of the item to remove.
+ * @param options.with withParams for basket.
+ * @param options.orderCustomData Custom data for the order.
+ * @param context The RPC context.
+ *
+ * @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: {
     itemKey: string;
     with?: BasketWithOptions;
@@ -37,7 +90,27 @@ export declare const removeItemFromBasket: (options: {
 }, context: RpcContext) => Promise<ErrorResponse | {
     basket: BasketResponseData<Product, Variant>;
 }>;
+/**
+ * Clears the basket, removing all items.
+ *
+ * @param context The RPC context.
+ *
+ * @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>;
+/**
+ * Merges two baskets.
+ *
+ * @param params The parameters for merging baskets.
+ * @param params.fromBasketKey The key of the source basket.
+ * @param params.toBasketKey The key of the target basket.
+ * @param params.with withParams for basket.
+ * @param params.orderCustomData Custom data for the order.
+ * @param context The RPC context.
+ *
+ * @returns The new merged basket as result of the merge operation.
+ */
 export declare const mergeBaskets: ({ fromBasketKey, toBasketKey, with: _with, orderCustomData }: {
     fromBasketKey: string;
     toBasketKey: string;
@@ -56,29 +129,41 @@ export declare const mergeBaskets: ({ fromBasketKey, toBasketKey, with: _with, o
     readonly errors: AddOrUpdateItemError[];
 } | undefined>;
 /**
- * An object containing properties of a basket item than should be applied to the basket item during the update.
+ * Type defining an object containing properties of a basket item than should be
+ * applied to the basket item during the update.
  */
 export type BasketItemUpdateData = Partial<Omit<UpdateBasketItemQuantity, 'basketKey' | 'itemKey' | 'with' | 'quantity'>> & {
     quantity: number;
 };
+/**
+ *  Interface defining parameters for `UpdateBasketItemRequest`.
+ */
 export interface UpdateBasketItemRequestParameter {
-    /** key of the item to be updated. */
+    /**
+     * The key of the item to be updated.
+     */
     basketItemKey: string;
-    /** The update data that should be applied to the basket item- */
+    /**
+     * The update data that should be applied to the basket item.
+     */
     update: BasketItemUpdateData;
-    /** An object describing which data the returned basket should contain. */
+    /**
+     * An object describing which data the returned basket should contain.
+     */
     with?: BasketWithOptions;
 }
 /**
  * Applies the provided update data to a specific item in a basket.
  *
- * @param params - The request parameters.
- * @param params.basketItemKey  - The key of the item to be updated.
- * @param params.update - The update data that should be applied to the basket item.
- * @param params.with - An object describing which data the returned basket should contain.
- * @param context - The rpc context associated with the request.
+ * @param params The parameters for updating a basket item.
+ * @param params.basketItemKey The key of the item to be updated.
+ * @param params.update The update data that should be applied to the basket item.
+ * @param params.with An object describing which data the returned basket should contain.
+ * @param context The RPC context.
  *
- * @returns A promise that resolves with the updated basket. In case of an error the, the failure kind will be resolved.
+ * @returns A promise that resolves with the updated basket.
+ * 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 | {
     basket: BasketResponseData<Product, Variant>;

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

@@ -1,5 +1,31 @@
 import type { Brand, BrandsEndpointRequestParameters, BrandsEndpointResponseData } from '../../types';
+/**
+ * Retrieves a list of brands.
+ *
+ * This function uses the Storefront cache (`cached()`) with a `getBrands` key prefix to improve performance.
+ * Cached entries are returned if found; otherwise, data is fetched and cached.
+ *
+ * @param params The parameters for retrieving brands.
+ * @param params.pagination The pagination settings.
+ * @param params.pagination.page The desired page number.
+ * @param params.pagination.perPage The number of brands per page (optional, capped at `MAX_PER_PAGE`).
+ * @param context The RPC context.
+ *
+ * @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>;
+/**
+ * Retrieves a brand by its ID.
+ *
+ * This function uses the Storefront cache (`cached()`) with a `getBrandById-${brandId}` key prefix to improve performance.
+ * Cached entries are returned if found; otherwise, data is fetched and cached.
+ *
+ * @param params The parameters for retrieving a brand by its ID.
+ * @param params.brandId The ID of the brand to retrieve.
+ * @param context The RPC context.
+ *
+ * @returns The brand. It will return an `ErrorResponse` alternatively If the request fails.
+ */
 export declare const getBrandById: ({ brandId }: {
     brandId: number;
 }, { sapiClient, cached }: import("../../types").RpcContext) => Promise<Response | Brand>;

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

@@ -1,12 +1,16 @@
 import type { RpcContext } from '../../types';
 /**
- * RPC method to retrieve the current campaign key.
- * Used by other RPC methods which depend on a campaign key.
- * Will return the key for the earliest active campaign.
+ * Retrieves the active campaign key.
+ *
+ * This RPC method retrieves the key for the earliest active campaign. It first checks the `context`
+ * for an existing `campaignKey`. If not present, it fetches active campaigns from the SAPI
+ * `list-campaigns` endpoint using the `sapiClient`, caching the result for 5 minutes.
  *
- * Uses SAPI's list-campaigns endpoint
  * @see https://scayle.dev/en/api-guides/storefront-api/resources/campaigns/list-campaigns
  *
+ * This function uses the Storefront cache (`cached()`) with a `get-campaignKey` key prefix to improve performance.
+ * Cached entries are returned if found; otherwise, data is fetched and cached.
+ *
  * @param context The RPC Context
  * @returns The current active campaign key.
  */