@scayle/storefront-core 8.8.0 → 8.10.0

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

@@ -5,6 +5,10 @@ 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 '../..';
+/**
+ * Parameters that can be included in the request context.
+ */
 export type WithParams = Partial<{
     basket: BasketWithOptions;
     wishlist: WishlistWithOptions;
@@ -15,11 +19,32 @@ export type WithParams = Partial<{
     searchV2: SearchV2With;
     variant: VariantWith;
 }>;
+/**
+ * Represents runtime configuration options.
+ */
 export interface RuntimeConfiguration {
     [key: string]: any;
 }
+/**
+ * Additional context information for RPC calls.
+ * AThis interface can be augmented to extend the `RpcContext` type and
+ * allows to adding custom properties to the RPC context.
+ *
+ * @example
+ * ```typescript
+ * // Augment AdditionalRpcContext type
+ * declare module '@scayle/storefront-core' {
+ *   interface AdditionalRpcContext {
+ *     myNewProp: string
+ *   }
+ * }
+ * ```
+ */
 export interface AdditionalRpcContext {
 }
+/**
+ * Context interface with session information.
+ */
 export interface ContextWithSession {
     wishlistKey: string;
     basketKey: string;
@@ -32,6 +57,9 @@ export interface ContextWithSession {
     updateUser: (user: ShopUser) => void;
     updateTokens: (tokens: OAuthTokens) => void;
 }
+/**
+ * Context interface without session information.
+ */
 export interface ContextWithoutSession {
     wishlistKey: undefined;
     basketKey: undefined;
@@ -44,21 +72,39 @@ export interface ContextWithoutSession {
     updateUser: undefined;
     updateTokens: undefined;
 }
+/**
+ * Information provided after a successful login.
+ */
 interface LoginInformation {
     shopId: number;
     user: ShopUser;
     authenticationType?: AuthenticationType;
     accessToken: string;
 }
+/**
+ * Information provided after a successful logout.
+ */
 interface LogoutInformation {
     shopId: number;
     user: ShopUser;
     authenticationType?: AuthenticationType;
 }
+/**
+ * Hooks for storefront events.
+ */
 export interface StorefrontHooks {
+    /**
+     * Hook called after a successful login.
+     */
     'storefront:afterLogin': (loginInfo: LoginInformation, context: RpcContext) => Promise<void> | void;
+    /**
+     * Hook called after a successful logout.
+     */
     'storefront:afterLogout': (logoutInfo: LogoutInformation, context: RpcContext) => Promise<void> | void;
 }
+/**
+ * The main RPC context interface, combining various properties.
+ */
 export type RpcContext = {
     locale: string;
     checkout: {
@@ -78,7 +124,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,8 +166,25 @@ export type RpcContext = {
     callHook?: Hookable<StorefrontHooks>['callHook'];
     callHookParallel?: Hookable<StorefrontHooks>['callHookParallel'];
     callHookWith?: Hookable<StorefrontHooks>['callHookWith'];
+    callRpc?: RpcMethodCall;
 } & AdditionalRpcContext & (ContextWithoutSession | ContextWithSession);
+/**
+ * RPC context type with guaranteed session information.
+ */
 export type RpcContextWithSession = RpcContext & ContextWithSession;
+/**
+ * Assertion function to narrow the type of `RpcContext` to `RpcContextWithSession`.
+ *
+ * @param context - The RPC context object.
+ *
+ * @throws {Error} If `context.sessionId` is not defined.
+ */
 export declare function assertSession(context: RpcContext): asserts context is RpcContextWithSession;
+/**
+ * Type guard function to check if the provided `RpcContext` has session information.
+ * @param context The RPC context object.
+ *
+ * @returns True if `context.sessionId` is defined, false otherwise.
+ */
 export declare function hasSession(context: RpcContext): context is RpcContextWithSession;
 export {};

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

@@ -1,4 +1,23 @@
 import type { RpcContext } from './context';
+/**
+ * Type for an RPC handler that accepts parameters.
+ *
+ * @template Params The type of the parameters object.
+ * @template ResponseType The type of the response.
+ */
 export type ParamRpcHandler<Params extends Record<string, any>, ResponseType> = (params: Params, context: RpcContext) => Promise<(ResponseType extends undefined ? void : ResponseType) | Response> | ResponseType | Response;
+/**
+ * Type for an RPC handler that does not accept parameters.
+ *
+ * @template ResponseType The type of the response.
+ */
 export type NoParamRpcHandler<ResponseType> = (context: RpcContext) => Promise<ResponseType | Response> | ResponseType | Response;
+/**
+ * Generic RPC handler type. Handles both cases with and without parameters.
+ *
+ * @template A The response type if no parameters are used, or the parameters type if parameters are used.
+ * @template B The response type if parameters are used.
+ * If `void`, no parameters are expected.
+ * This allows for defining RPC handlers that either accept parameters or not.
+ */
 export type RpcHandler<A, B = void> = B extends void ? NoParamRpcHandler<A> : ParamRpcHandler<A, B>;

package/dist/types/breadcrumb.d.ts

@@ -1,4 +1,13 @@
+/**
+ * Represents an item in a breadcrumb navigation.
+ */
 export interface BreadcrumbItem {
+    /**
+     * The displayed text for the breadcrumb item.
+     */
     value: string;
+    /**
+     * The navigation target (URL or route) for the breadcrumb item.
+     */
     to: string;
 }

package/dist/types/promises.d.ts

@@ -1,2 +1,12 @@
+/**
+ * Extracts the type resolved by a promise or promise-like value.
+ *
+ * @template T The input type, which can be a promise-like value.
+ */
 export type Awaited<T> = T extends PromiseLike<infer U> ? Awaited<U> : T;
+/**
+ * Extracts the return type of a promise-returning function, after the promise resolves.
+ *
+ * @template T The promise-returning function type.
+ */
 export type PromiseReturnType<T extends (...args: any) => Promise<any>> = Awaited<ReturnType<T>>;

package/dist/types/sapi/basket.d.ts

@@ -1,23 +1,48 @@
 import type { BasketItemDisplayData, BasketItemDisplayDataKey, BasketResponse, BasketResponseData, BasketWith, BasketItemDisplayDataItem, CreateBasketItemParameters, ItemGroup } from '@scayle/storefront-api';
+/**
+ * Represents custom data for a basket item. Corresponds to the `customData` property
+ * of `CreateBasketItemParameters`.
+ */
 export type BasketCustomData = Pick<CreateBasketItemParameters, 'customData'>;
+/**
+ * Represents display data for a basket item. Uses a partial record to allow flexibility in
+ * which display data keys are present.
+ */
 export type BasketDisplayData = Partial<Record<BasketItemDisplayDataKey, BasketItemDisplayDataItem>>;
-export type { BasketItemDisplayData, BasketItemDisplayDataItem, BasketResponseData, BasketWith, BasketResponse, ItemGroup, };
+/**
+ * Parameters for adding or updating an item in the basket.
+ */
 export interface AddOrUpdateItemType {
     variantId: number;
     quantity: number;
+    /** Display data for the item. */
     displayData?: BasketItemDisplayData;
+    /** Custom data for the item. */
     customData?: {
         [key: string | number]: any;
     };
+    /** Item group for the item. */
     itemGroup?: ItemGroup;
+    /** If the product is not in the "catalog" anymore, keep it in the basket */
     includeItemsWithoutProductData?: boolean;
     promotionId?: string | null;
 }
+/**
+ * Options for fetching a basket, extending the base `BasketWith` type.
+ */
 export interface BasketWithOptions extends BasketWith {
+    /** Key for filtering the price promotions */
     pricePromotionKey?: string;
+    /** if the product is not in the "catalog" anymore, keep it in the basket */
     includeItemsWithoutProductData?: boolean;
 }
+/**
+ * Parameters for the `useBasket` composable.
+ */
 export interface UseBasketParams {
+    /** Key for caching. */
     key?: string;
+    /** Data to include with the basket. */
     with: BasketWithOptions;
 }
+export type { BasketItemDisplayData, BasketItemDisplayDataItem, BasketResponseData, BasketWith, BasketResponse, ItemGroup, };

package/dist/types/sapi/filter.d.ts

@@ -2,31 +2,53 @@ import type { AttributeWithBooleanValueFilter, AttributeWithValuesFilter, Filter
 import type { Query } from './router';
 export type { AttributesFilterItemWithValues } from '@scayle/storefront-api';
 export type { AttributeWithBooleanValueFilter, AttributeWithValuesFilter, AttributeKey, } from '@scayle/storefront-api';
+/**
+ * Parameters for filtering products.
+ */
 export interface FilterParams {
     page?: number;
     perPage?: number;
+    /** The where clause for filtering. */
     where?: {
+        /** The search term. */
         term?: ProductSearchQuery['term'];
+        /** The minimum price. */
         minPrice?: ProductSearchQuery['minPrice'];
+        /** The maximum price. */
         maxPrice?: ProductSearchQuery['maxPrice'];
+        /** The attributes filter. */
         attributes?: ProductSearchQuery['attributes'];
+        /** Attributes to whitelist */
         whitelistAttributes?: ProductSearchQuery['attributes'];
     };
+    /** The sort configuration. */
     sort?: ProductSortConfig;
+    /** The OR filters operator. */
     orFiltersOperator?: ProductsSearchEndpointParameters['orFiltersOperator'];
 }
+/**
+ * Parameters for fetching filters.
+ */
 export type FetchFiltersParams = {
     includedFilters?: Array<string>;
+    /** where clause for prefiltering the filters */
     where?: {
+        /** The search term. */
         term?: ProductSearchQuery['term'];
+        /** The minimum price. */
         minPrice?: ProductSearchQuery['minPrice'];
+        /** The maximum price. */
         maxPrice?: ProductSearchQuery['maxPrice'];
+        /** The attributes filter. */
         attributes?: ProductSearchQuery['attributes'];
+        /** wether to disable fuzziness on term */
         disableFuzziness?: ProductSearchQuery['disableFuzziness'];
+        /** Attributes to whitelist */
         whitelistAttributes?: ProductSearchQuery['attributes'];
     };
     includeSoldOut?: boolean;
     includeSellableForFree?: boolean;
+    /** or operator for filters */
     orFiltersOperator?: ProductsSearchEndpointParameters['orFiltersOperator'];
 } & ({
     category?: string;
@@ -35,18 +57,33 @@ export type FetchFiltersParams = {
     categoryId: number;
     category?: undefined;
 });
+/**
+ * The response from fetching filters.
+ */
 export interface FetchFiltersResponse {
     filters: FiltersEndpointResponseData;
     unfilteredCount: number;
 }
+/**
+ * Represents a filter query.
+ */
 export interface FilterQuery {
     page?: Query;
     sort?: Query;
     term?: Query;
 }
+/**
+ * Filter setup type.
+ */
 export type FilterSetup = Record<string, unknown>;
+/**
+ * Parameters for sanitizing attributes.
+ */
 export interface SanitizeAttributesParams {
+    /** The attributes to sanitize. */
     attributes: (AttributeWithValuesFilter | AttributeWithBooleanValueFilter)[];
+    /** The filter keys. */
     filterKeys: string[];
+    /** included filter names */
     includedFilters?: string[];
 }

package/dist/types/sapi/navigation.d.ts

@@ -1,12 +1,24 @@
 import type { GetNavigationParameters, NavigationItems } from '@scayle/storefront-api';
 export type { NavigationItems, NavigationTree, NavigationItemExternal, NavigationItemPage, NavigationItemCategory, } from '@scayle/storefront-api';
+/**
+ * Represents a navigation tree item.
+ */
 export type NavigationTreeItem = NavigationItems[0];
+/**
+ * Parameters for fetching navigation trees.
+ */
 export interface FetchNavigationTreesParams {
     params?: GetNavigationParameters;
 }
-export type FetchNavigationTreeByIdParams = FetchNavigationTreesParams & {
+/**
+ * Parameters for fetching a navigation tree by ID.
+ */
+export interface FetchNavigationTreeByIdParams extends FetchNavigationTreesParams {
     treeId: number;
-};
-export type FetchNavigationTreeByNameParams = FetchNavigationTreesParams & {
+}
+/**
+ * Parameters for fetching a navigation tree by name.
+ */
+export interface FetchNavigationTreeByNameParams extends FetchNavigationTreesParams {
     treeName: string;
-};
+}