@scayle/storefront-core 8.8.0 → 8.10.0

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

@@ -1,7 +1,21 @@
 import type { AttributesFilterValue, FilterItemWithValues, IdentifierFilterValue } from '@scayle/storefront-api';
+/**
+ * Represents a product filter.
+ */
 export type ProductFilter = FilterItemWithValues;
+/**
+ * Represents the values of a product filter.
+ */
 export type ProductFilterValues = ProductFilter['values'];
+/**
+ * Represents a single value of a product filter. This can be a value of an attribute filter,
+ * a boolean value indicating a filter state (e.g., sale: true/false), or a value of an identifier filter.
+ *
+ * @see https://scayle.dev/en/developer-guide/products/product-filters#get-filter-values
+ */
 export type ProductFilterValue = AttributesFilterValue | {
+    /**  The boolean value of the filter, e.g. for a "sale" filter. */
     name: true | false;
+    /** The count of products associated with this value. */
     productCount: number;
 } | IdentifierFilterValue;

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

@@ -1 +1,4 @@
+/**
+ * Represents a search query. Can be a single string or an array of strings (or null).
+ */
 export type Query = string | (string | null)[];

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

@@ -5,20 +5,39 @@ export type { SearchV2With } from '@scayle/storefront-api';
 export type { SearchV2SuggestionsEndpointResponseData, SearchV2SuggestionsEndpointParameters, } from '@scayle/storefront-api';
 export type { SearchV2ResolveEndpointResponseData, SearchV2ResolveEndpointParameters, } from '@scayle/storefront-api';
 export type { SearchEntity, CategorySearchSuggestion, ProductSearchSuggestion, NavigationItemSuggestion, } from '@scayle/storefront-api';
+/**
+ * Represents the input for a search operation.
+ */
 export interface SearchInput {
     term?: Query;
     slug?: string;
+    /** The limit for the number of products. */
     productLimit?: number;
 }
+/**
+ * Options for including additional data with categories.
+ */
 export interface CategoryWith {
+    /** Whether to include all parent categories. */
     parents?: 'all';
+    /** The number of children to include. */
     children?: number;
 }
+/**
+ * Options for a search operation.
+ */
 export interface SearchOptions {
+    /** The search key. */
     key?: string;
+    /** Additional data to include with the search results. */
     with?: {
+        /** Additional product data to include. */
         products?: ProductWith;
+        /** Additional category data to include. */
         categories?: CategoryWith;
     };
 }
+/**
+ * Additional data to include with search results.
+ */
 export type SearchWith = TypeaheadSuggestionsEndpointRequestParameters['with'];

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

@@ -1,8 +1,15 @@
 import type { APISortOption, APISortOrder } from '@scayle/storefront-api';
 import type { SortName, SortQuery } from '../../constants';
+/**
+ * Represents the keys for available sorting values.
+ */
 export type SortingValueKey = 'topSeller' | 'dateNewest' | 'priceDesc' | 'priceAsc' | 'reductionDesc' | 'reductionAsc';
+/**
+ * Represents a sorting value.
+ */
 export interface SortValue {
     name: SortName;
+    /** The query string for the sorting option. */
     query: SortQuery;
     by: APISortOption;
     direction?: APISortOrder;

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

@@ -1,8 +1,14 @@
 import type { WishlistResponseData, WishlistWith } from '@scayle/storefront-api';
 export type { WishlistResponseData, WishlistWith };
+/**
+ * Wishlist with optional price promotion key.
+ */
 export interface WishlistWithOptions extends WishlistWith {
     pricePromotionKey?: string;
 }
+/**
+ * Parameters for useWishlist hook/function.
+ */
 export interface UseWishlistParams {
     key?: string;
     with: WishlistWithOptions;

package/dist/types/user.d.ts

@@ -1,98 +1,200 @@
 import type { UseBasketParams } from './sapi/basket';
 import type { UseWishlistParams } from './sapi/wishlist';
+/**
+ * Represents the gender of a user.
+ */
 export type Gender = 'm' | 'f' | 'd' | 'n';
+/**
+ * Parameters for updating a user's password.
+ */
 export interface UpdatePasswordParams {
+    /** The user's current password. */
     oldPassword: string;
+    /** The user's new password. */
     newPassword: string;
 }
+/**
+ * Parameters for fetching user data.
+ */
 export interface UseUserParams {
+    /** An optional key for caching or identifying the user. */
     key?: string;
+    /** Whether to automatically fetch user data. */
     autoFetch?: boolean;
 }
+/**
+ * Represents a member's role and associated privileges.
+ */
 interface MemberRole {
+    /** The discount visibility setting for the role. */
     discountVisibility: string;
+    /** The member's priority level. */
     memberPriority: number;
+    /** The SAP identifier for the member role. */
     memberRoleSap: string;
 }
+/**
+ * The type of authentication used by the user.
+ */
 export type AuthenticationType = 'password' | string;
+/**
+ * Represents the user's authentication information.
+ */
 interface UserAuthentication {
+    /** Data containing access token and user ID. */
     data?: {
+        /** The user's access token. */
         accessToken?: string;
+        /** The user's ID. */
         userId?: string;
     };
+    /** The type of authentication. */
     type: AuthenticationType;
 }
+/**
+ * Summary information about an order.
+ */
 export interface OrderSummary {
+    /** The order ID. */
     id: number;
+    /** The date and time the order was confirmed. */
     confirmedAt?: string;
+    /** The number of items in the order. */
     itemCount: number | undefined;
+    /** The ID of the shop associated with the order. */
     shopId: number;
+    /** The current status of the order. */
     status?: string;
 }
+/**
+ * Represents the status of a shop user.
+ */
 export interface ShopUserStatus {
+    /** Whether the user is active. */
     isActive: boolean;
+    /** Whether the user is a guest customer. */
     isGuestCustomer: boolean;
+    /** Whether the user is a test customer. */
     isTestCustomer: boolean;
 }
+/**
+ * Represents a shop user's address.
+ */
 export interface ShopUserAddress {
+    /** The address ID. */
     id: number;
+    /** An optional reference key for the address. */
     referenceKey?: string;
+    /** The street address. */
     street: string;
+    /** The house number. */
     houseNumber?: string;
+    /** Additional address information. */
     additional?: string;
+    /** The zip code. */
     zipCode: string;
+    /** The city. */
     city: string;
+    /** The country code. */
     countryCode: string;
+    /** Information about the collection point, if applicable. */
     collectionPoint?: {
+        /** The customer key for the collection point. */
         customerKey?: string;
+        /** A description of the collection point. */
         description?: string;
+        /** The key for the collection point. */
         key: string;
+        /** The type of collection point. */
         type: string;
     };
+    /** Whether this is the billing address. */
     isBillingAddress: boolean;
+    /** Whether this is the shipping address. */
     isShippingAddress: boolean;
+    /** Whether this is the default billing or shipping address. */
     isDefault: {
+        /** Whether this is the default billing address. */
         billing: boolean;
+        /** Whether this is the default shipping address.  */
         shipping: boolean;
     };
+    /** The recipient's information. */
     recipient: {
+        /** The recipient's first name. */
         firstName?: string;
+        /** The recipient's last name. */
         lastName: string;
+        /** The recipient's gender. */
         gender?: Gender;
+        /** The recipient's title (e.g., Mr., Mrs.). */
         title?: string;
     };
 }
+/**
+ * Represents a shop user.
+ */
 export interface ShopUser {
+    /** The app ID associated with the user. */
     app_id: number;
+    /** The number of completed orders. */
     completed_orders: number;
+    /** The date the user was created. */
     created_date?: Date;
+    /** The user's zip code. */
     zip_code?: number | undefined;
+    /** The user's authentication information. */
     authentication?: UserAuthentication;
+    /** The user's first name. */
     firstName: string;
+    /** The user's last name. */
     lastName?: string;
+    /** The groups the user belongs to. */
     groups?: string[];
+    /** The user's birth date. */
     birthDate?: string;
+    /** The user's phone number. */
     phone?: string;
+    /** The user's public key. */
     publicKey: string;
+    /** The user's reference key. */
     referenceKey: string;
+    /** The date the user was created in the system. */
     createdAt: string;
+    /** The date the user was last updated in the system. */
     updatedAt: string;
+    /** The user's email address. */
     email?: string;
+    /** Whether user has a connected facebook account*/
     fbook?: boolean;
+    /** The user's ID. */
     id: number;
+    /** Whether the user is a guest. */
     isGuest: boolean;
+    /** Whether the user is a returning customer. */
     isReturningCustomer: boolean;
+    /** The user's gender. */
     gender?: Gender;
+    /** A summary of the user's orders. */
     orderSummary?: OrderSummary[];
+    /** The user's status. */
     status?: ShopUserStatus;
+    /** The user's title (e.g., Mr., Mrs.). */
     title?: string;
+    /** Custom data associated with the user. */
     customData?: {
         memberRoles?: MemberRole[];
     };
 }
+/**
+ * Parameters for user facets.
+ */
 export interface UseUserFacetParams {
+    /** User-specific parameters. */
     userParams: UseUserParams;
+    /** Basket-related parameters. */
     basketParams: UseBasketParams;
+    /** Wishlist-related parameters. */
     wishlistParams: UseWishlistParams;
 }
 export {};

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.10.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"
   }
 }