@scayle/storefront-core 8.9.0 → 8.10.0

package/CHANGELOG.md

@@ -1,5 +1,66 @@
 # @scayle/storefront-core
 
+## 8.10.0
+
+### Minor Changes
+
+- Simplified exported `Order` interface by relying directly on primitive types instead of having multiple intermediate types that resolve to primitives.
+
+  The following formerly exported intermediate types have been replaces by primitive types:
+
+  - resolving to `string` now
+    - `TimestampOfOrderConfirmation`
+    - `CharacterCurrencyCode`
+    - `UniqueIdentifierOfTheState`
+    - `NameOfTheState`
+    - `UniqueIdentifierOfTheState1`
+    - `NameOfTheState1`
+    - `UniqueIdentifierOfTheState2`
+    - `NameOfTheState2`
+    - `TimestampOfOrderInvoice`
+    - `CharacterCurrencyCode1`
+    - `UniqueIdentifierOfTheItem`
+    - `TimestampOfItemCreation`
+    - `TimestampOfLastItemUpdate`
+    - `CarrierShippingTheItem`
+    - `LatestExpectedDeliveryDate`
+    - `EarliestExpectedDeliveryDate`
+    - `ShipmentKeyOfTheItem`
+    - `TimestampOfOrderCreation`
+    - `TimestampOfLastOrderUpdate`
+  - resolving to `number` now
+    - `ThisFieldRepresentsTheAdditionalFeesExcludingTheTaxes`
+    - `ThisFieldRepresentsTheAdditionalFeesIncludingTheTaxes`
+    - `TheIncludedVATAmount`
+    - `TheIncludedVATRateInPercentAsIntegerRepresentation`
+    - `ThisFieldRepresentsTheDiscountAmountIncludingTheTaxes`
+    - `AbsoluteValueOfTheAppliedTax`
+    - `UniqueNumericIdentifierOfTheItem`
+    - `AvailableQuantityInTheWarehouse`
+    - `ThisFieldRepresentsTheDiscountAmountIncludingTheTaxes1`
+    - `AbsoluteValueOfTheAppliedTax1`
+    - `RelativeValueOfTheAppliedTax`
+    - `UndiscountedItemPriceExcludingTaxes`
+    - `UndiscountedItemPriceIncludingTaxes`
+    - `ItemPriceExcludingTaxes1`
+    - `ItemPriceIncludingTaxes1`
+    - `ReferenceByWhichThePackageIsIdentified`
+    - `ItemPriceExcludingTaxes`
+    - `ItemPriceIncludingTaxes`
+    - `NumberOfInstallmentsChosenByTheCustomerForTheOrder`
+  - resolving to `boolean` now
+    - `TheReturnShipmentHasBeenTriggeredByCCI`
+    - `WhetherThePaymentMethodIsAGiftCard`
+    - `IfTrueTheCustomerElectedToHaveADelayInPaymentCapture`
+  - resolving to `null | number` now
+    - `PickingWarehouseId`
+    - `WarehousePackageReference`
+  - resolving to `null | string` now
+    - `ReturnIdentCodeOfTheItem`
+
+  The interface `ThisFieldHoldsDetailsAboutTheIncludedVATTax` has been removed and `amount: number` and `rate: number` have been directly specified under `Order.cost.appliedFees.tax.vat: {amount: number, rate: number}`.
+  Additionally we have introduce the types `OrderAddressRecipientGender` and `OrderAddressRecipientType`, as well as the interfaces `OrderAddress` and `OrderForwardingAddress`.
+
 ## 8.9.0
 
 ### Minor Changes

package/dist/helpers/advancedAttributeHelpers.d.ts

@@ -1,4 +1,11 @@
 import type { FieldSet, GroupSet } from '../types';
+/**
+ * Flattens each object within a FieldSet.
+ *
+ * @param fieldSet The FieldSet to flatten.
+ *
+ * @returns An array of flattened objects.
+ */
 export declare const flattenFieldSet: (fieldSet: FieldSet) => {
     [key: string]: string | number | null | undefined;
 }[][];
@@ -10,14 +17,34 @@ interface FlattenedMaterialComposition {
         material: string;
     }[];
 }
+/**
+ * Transforms an array of material compositions into a flattened structure.
+ *
+ * @param materialCompositions The material compositions to flatten.
+ *
+ * @returns An array of flattened material compositions.
+ */
 export declare const getFlattenedMaterialComposition: (materialCompositions: Array<{
     fieldSet: FieldSet;
     groupSet: GroupSet;
 }>) => FlattenedMaterialComposition[];
+/**
+ * Flattens an attribute group into a generic array.
+ *
+ * @param attributeGroup The attribute group to flatten.
+ *
+ * @returns  A generically typed array of flattened attributes.
+ */
 export declare const getFlattenedAdvancedAttribute: <T>(attributeGroup: Array<{
     fieldSet: FieldSet;
     groupSet: GroupSet;
 }>) => T[];
+/**
+ * Flattens variant cross-selling data into a generic array. This function uses the `getFlattenedAdvancedAttribute` internally.
+ *
+ * @param variantCrosssellings The variant cross-selling data to flatten.
+ * @returns A generically typed array of flattened variant cross-selling data.
+ */
 export declare const getFlattenedVariantCrosssellings: <T>(variantCrosssellings: Array<{
     fieldSet: FieldSet;
     groupSet: GroupSet;

package/dist/helpers/arrayHelpers.d.ts

@@ -1 +1,8 @@
+/**
+ * Flattens an array of arrays with unknown depth into a single-level array.
+ *
+ * @param array The array to flatten. Its depth will be treated as up to 20 levels due to current TypeScript limitations on inferring infinite depth.
+ *
+ * @returns The flattened array.
+ */
 export declare const flattenDeep: <T extends unknown[]>(array: T) => (T extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? InnerArr extends readonly (infer InnerArr)[] ? /*elided*/ any : InnerArr : InnerArr : InnerArr : InnerArr : InnerArr : InnerArr : InnerArr : InnerArr : InnerArr : InnerArr : T)[];

package/dist/helpers/attributeHelpers.d.ts

@@ -1,5 +1,37 @@
 import type { Attributes } from '@scayle/storefront-api';
+/**
+ * Retrieves the first attribute value for a given attribute name from a set of attributes.
+ *
+ * @param attributes The set of attributes.
+ * @param attributeName The name of the attribute to retrieve.
+ *
+ * @returns The first attribute value, or undefined if not found.
+ */
 export declare const getFirstAttributeValue: (attributes: Attributes | undefined, attributeName: string) => import("@scayle/storefront-api").Value | undefined;
+/**
+ * Retrieves the value or label of the first attribute value for a given attribute name.
+ *
+ * @param attributes The set of attributes.
+ * @param attributeName The name of the attribute to retrieve.
+ *
+ * @returns The value or label of the first attribute value, or null if not found.
+ */
 export declare const getAttributeValue: (attributes: Attributes | undefined, attributeName: string) => string | undefined;
+/**
+ * Retrieves all attribute values for a given attribute name.
+ *
+ * @param attributes The set of attributes.
+ * @param attributeName The name of the attribute to retrieve.
+ *
+ * @returns An array of attribute values, or an empty array if not found.
+ */
 export declare const getAttributeValueTuples: (attributes: Attributes | undefined, attributeName: string) => import("@scayle/storefront-api").Value[];
+/**
+ * Retrieves the first attribute value for multiple attribute names.
+ *
+ * @param attributes The set of attributes.
+ * @param attributeNames An array of attribute names to retrieve.
+ *
+ * @returns An array of attribute values, filtered to remove any null or undefined values.
+ */
 export declare const getManyAttributeValueTuples: (attributes: Attributes | undefined, attributeNames: string[]) => import("@scayle/storefront-api").Value[];

package/dist/helpers/basketHelpers.d.ts

@@ -1,2 +1,9 @@
 import type { BasketPackageInformation } from '@scayle/storefront-api';
+/**
+ * Extracts the earliest and latest delivery dates from an array of basket package information.
+ *
+ * @param packages An array of basket package information objects.
+ *
+ * @returns A tuple containing the earliest and latest delivery dates, or null if no dates are found.
+ */
 export declare const getShippingDates: (packages: BasketPackageInformation[]) => (string | null)[];

package/dist/helpers/categoryHelper.d.ts

@@ -1,7 +1,45 @@
 import type { Category, ProductCategory } from '../types/sapi/category';
 import type { BreadcrumbItem } from '../types/breadcrumb';
+/**
+ * Generates breadcrumb items from an array of product categories.
+ *
+ * @param categories An array of product categories.
+ *
+ * @returns An array of breadcrumb items.
+ */
 export declare const getBreadcrumbsFromProductCategories: (categories: ProductCategory[] | Category[]) => BreadcrumbItem[];
+/**
+ * Generates breadcrumb items from a category object, optionally highlighting an active node.
+ *
+ * @param category The root category object.
+ * @param activeNode The currently active category (optional).
+ *
+ * @returns An array of breadcrumb items.
+ */
 export declare const getBreadcrumbsFromCategory: (category: Category, activeNode?: Category) => BreadcrumbItem[];
+/**
+ * Generates breadcrumb items from a path string.
+ *
+ * @param path The path string.
+ * @param shopLocale The shop locale (optional).
+ *
+ * @returns An array of breadcrumb items.
+ */
 export declare const getBreadcrumbsFromPath: (path?: string, shopLocale?: string) => BreadcrumbItem[];
+/**
+ * Generates breadcrumb items based on either product categories or a single category object.
+ *
+ * @param categories An array of product categories or a single category object.
+ * @param activeNode The currently active category (optional, used only when categories is a single Category object).
+ *
+ * @returns An array of breadcrumb items.
+ */
 export declare const getBreadcrumbs: (categories: ProductCategory[] | Category, activeNode?: Category) => BreadcrumbItem[];
+/**
+ * Extracts the back URL from an array of breadcrumb items.
+ *
+ * @param breadcrumbs An array of breadcrumb items.
+ *
+ * @returns The back URL or '/' if breadcrumbs is undefined or empty.
+ */
 export declare const getBackurlFromBreadcrumbs: (breadcrumbs?: BreadcrumbItem[]) => string;

package/dist/helpers/filterHelper.d.ts

@@ -7,34 +7,99 @@ export interface TransformedFilter {
     value: string | number;
     whereCondition: Record<string, any>;
 }
+/**
+ * Transforms a set of filter conditions into a where clause suitable for product search queries.
+ *
+ * @param conditions - The filter conditions to transform.
+ *
+ * @returns A where clause object.
+ */
 export declare const transformToWhereCondition: (conditions: Record<string, any>) => {
     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.
- *
- * This method transforms attribute filters with multiple possible values into a flattened
- * list of filters with one filter entry per possible attribute value
+ * Computes an array of filters for rendering quick filters.
+ * Transforms attribute filters with multiple values into a flattened list.
  *
- * By providing filterableKeys you can limit the generated list of filters to specific
- * keys you would like to filter by.
+ * @param filters The available product filters.
+ * @param filterableKeys Optional array of keys to limit the generated filters.
+ * @param options Options object.
+ * @param options.sortable Whether to sort the filters alphabetically by display name. Defaults to true.
  *
- * @param filters
- * @param filterableKeys
+ * @returns An array of transformed filters.
  */
 export declare const groupFilterableValuesByKey: (filters: ProductFilter[], filterableKeys?: string[], { sortable }?: {
     sortable: boolean;
 }) => TransformedFilter[];
+/**
+ * Merges an array of transformed filters into a single filter object.
+ * This function iterates through the provided filter state, which is an object
+ * where each key is a string and the value is an array of `TransformedFilter`
+ * objects. It then merges all the transformed filters into a single object,
+ * presumably used for querying or filtering data.  This implementation
+ * addresses a previous issue where array values were not appended correctly,
+ * ensuring proper merging of filter criteria.
+ *
+ * @param state An object representing the filter state. Each key is a string,
+ * and the value is an array of `TransformedFilter` objects.
+ *
+ * @returns A single filter object containing the merged filter criteria from all
+ * the provided `TransformedFilter` arrays.
+ */
 export declare const transformStateToFilters: (state: {
     [key: string]: TransformedFilter[];
 }) => any;
+/**
+ * Merges an array of filters into a single filter object.
+ *
+ * @param filters The filters to merge.
+ *
+ * @returns A merged filter object.
+ */
 export declare const mergeFilters: (filters: TransformedFilter[]) => Record<string, any>;
+/**
+ * Checks if a filter is active.
+ *
+ * @param filters The active filters.
+ * @param filterToCheck The filter to check.
+ *
+ * @returns True if the filter is active, false otherwise.
+ */
 export declare const isFilterActive: (filters: Record<string, any>, filterToCheck: TransformedFilter) => any;
+/**
+ * Gets the active filters from a set of filters.
+ *
+ * @param filters All available filters.
+ * @param activeFilters The currently active filters.
+ *
+ * @returns  An array of active filters.
+ */
 export declare const getActiveFilters: (filters: Record<string, any>, activeFilters: Record<string, any>) => TransformedFilter[];
+/**
+ * Groups filters by key.
+ *
+ * @param filters The filters to group.
+ *
+ * @returns A record of grouped filters.
+ */
 export declare const groupFiltersByKey: (filters: TransformedFilter[]) => [string, TransformedFilter[]][];
+/**
+ * Transforms min and max prices into a filter object.
+ *
+ * @param prices An array containing the min and max prices.
+ *
+ * @returns A filter object with minPrice and maxPrice.
+ */
 export declare const transformMinAndMaxPriceToFilter: (prices: (CentAmount | undefined)[]) => any;
+/**
+ * Transforms a sort string into a filter value.
+ *
+ * @param sort The sort string.
+ *
+ * @returns The transformed sort value.
+ */
 export declare const transformSortToFilter: (sort: string) => {
     by: "price";
     direction: "desc";
@@ -65,21 +130,42 @@ export declare const transformSortToFilter: (sort: string) => {
     name: "reduction_asc";
     query: "reduction-asc";
 };
+/**
+ * Gets grouped filterable values by keys.
+ *
+ * @param keys Array of filter keys.
+ * @param filterableValues The filterable values for products.
+ * @param options Options object.
+ * @param options.sortable Whether to sort the values. Defaults to `true`.
+ *
+ * @returns A record of grouped filterable values.
+ */
 export declare const getGroupedFilterableValues: (keys: Array<string>, filterableValues: ProductFilter[], { sortable }?: {
     sortable: boolean;
 }) => Record<string, TransformedFilter[]>;
+/**
+ * Gets the filterable price value (min or max).
+ *
+ * @param filterableValues The filterable values.
+ * @param key Whether to retrieve 'min' or 'max' value. Defaults to 'min'.
+ *
+ * @returns The min or max price value.
+ */
 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)[]>;
 /**
  * Converts filter values, within a filter object, into their string representation.
  *
- * @param filter
+ * @param filter The filter object to serialize.
+ *
+ * @returns A serialized filter object or undefined if the input filter is empty.
  */
 export declare const serializeFilters: (filter: Filter) => SerializedFilter | undefined;
 /**
  * Converts filter values back into their original data type.
  *
- * @param serializedFilter
+ * @param serializedFilter The serialized filter object.
+ * @returns The deserialized filter object.
  */
 export declare const deserializeFilters: (serializedFilter: SerializedFilter) => Filter;

package/dist/helpers/formHelpers.d.ts

@@ -1,48 +1,81 @@
 /**
- * Returns date in YYYY-MM-DD format
- * @param date in DD.MM.YYYY format
- * @returns formatted date string
+ * Converts a date string from DD.MM.YYYY to YYYY-MM-DD format.
+ *
+ * @param date Date string in DD.MM.YYYY format.
+ *
+ * @returns Date string in YYYY-MM-DD format, or undefined if input is undefined.
+ *
+ * @deprecated Validation should be handled within the Storefront project itself.
  */
 export declare const getPayloadDate: (date: string | undefined) => string | undefined;
 /**
- * Validates a date string
- * @param date in DD.MM.YYYY format
- * @returns boolean
+ * Validates a date string in DD.MM.YYYY format.
+ *
+ * @param date Date string in DD.MM.YYYY format.
+ *
+ * @returns True if the date is valid, false otherwise.
+ *
+ * @deprecated Validation should be handled within the Storefront project itself.
  */
 export declare const dateValidator: (date: string | undefined) => boolean;
 /**
- * @param date in YYYY-MM-DD or YYYY-MM-DDThh:mm:ss+xx:yy format
- * @returns formatted date string in DD.MM.YYYY format
+ * Formats a date string from YYYY-MM-DD or YYYY-MM-DDThh:mm:ss+xx:yy to DD.MM.YYYY format.
+ *
+ * @param date Date string in YYYY-MM-DD or YYYY-MM-DDThh:mm:ss+xx:yy format.
+ *
+ * @returns Formatted date string in DD.MM.YYYY format, or an empty string if input is undefined or invalid.
+ *
+ * @deprecated Validation should be handled within the Storefront project itself.
  */
 export declare const formatDate: (date: string | undefined) => string;
 /**
- * Returns formatted date after adding 0 padding to day and month
- * @param date in in DD.MM.YYYY format
- * @returns formatted date string
+ * Formats a date string in DD.MM.YYYY format, adding zero padding to day and month.
+ *
+ * @param date Date string in DD.MM.YYYY format.
+ *
+ * @returns Formatted date string, or an empty string if input is undefined or invalid.
+ *
+ * @deprecated Validation should be handled within the Storefront project itself.
  */
 export declare const convertDate: (date: string | undefined) => string;
 /**
- * Returns phone number in 0000/1234567890 format
- * @param phone in +00 1234 567890 format
- * @returns formatted phone number string
+ * Converts a phone number from +00 1234 567890 format to 0000/1234567890 format.
+ *
+ * @param phone Phone number in +00 1234 567890 format.
+ *
+ * @returns Formatted phone number string, or undefined if input is undefined.
+ *
+ * @deprecated Validation should be handled within the Storefront project itself.
  */
 export declare const getPayloadPhone: (phone: string | undefined) => string | undefined;
 /**
- * Returns phone number in 0000/1234567890 format
- * @param phone in +00 1234 567890 format
- * @returns formatted phone number string
+ * Validates a phone number in +00 1234 567890 format.
+ *
+ * @param phone Phone number string.
+ *
+ * @returns True if the phone number is valid, false otherwise.
+ *
+ * @deprecated Validation should be handled within the Storefront project itself.
  */
 export declare const phoneValidator: (phone: string | undefined) => boolean;
 /**
- * Returns phone number in +00 1234 567890 format
- * @param phone in 0000/1234567890 format
- * @returns formatted phone number string
+ * Formats a phone number from 0000/1234567890 format to +00 1234 567890 format.
+ *
+ * @param phone Phone number in 0000/1234567890 format.
+ *
+ * @returns Formatted phone number string.
+ *
+ * @deprecated Validation should be handled within the Storefront project itself.
  */
 export declare const formatPhone: (phone: string | undefined) => string;
 /**
- * Returns phone number in +00 1234 567890 format
- * @param phone in unknown format
- * @param internationalPrefix international dial code, defaults to 49 (Germany)
- * @returns formatted phone number string
+ * Converts a phone number to +00 1234 567890 format.
+ *
+ * @param phone Phone number in unknown format.
+ * @param internationalPrefix International dial code (defaults to 49 for Germany).
+ *
+ * @returns Formatted phone number string, or undefined if input is undefined.
+ *
+ * @deprecated Validation should be handled within the Storefront project itself.
  */
 export declare const convertPhone: (phone: string | undefined, internationalPrefix?: string) => string | undefined;

package/dist/helpers/imageHelpers.d.ts

@@ -1,4 +1,22 @@
 import type { ProductImageType } from '../constants/product';
 import type { Product, ProductImage } from '../index';
+/**
+ * Checks if a product image matches a specific image type.
+ *
+ * @param type The image type to check against.
+ * @param image The product image.
+ *
+ * @returns True if the image matches the type, false otherwise.
+ */
 export declare function isImageType(type: ProductImageType, image: ProductImage): boolean;
+/**
+ * Retrieves an image from a list of product images based on image type and view.
+ *
+ * @param images The list of product images.
+ * @param imageType The desired image type.
+ * @param imageView The desired image view.
+ * @param fallback Whether to return the first image if no match is found. Defaults to true.
+ *
+ * @returns The matching product image, the first image if fallback is true and no match is found, or null otherwise.
+ */
 export declare const getImageFromList: (images: Product["images"], imageType: string, imageView: string, fallback?: boolean) => ProductImage | null;

package/dist/helpers/localization.d.ts

@@ -1,7 +1,9 @@
 /**
- * Get default number of fraction digits of a currency
- * @param locale {String} - Locale, eg 'en-GB', 'de-DE', 'cs-CZ'
- * @param currency {String} - Currency like 'EUR', 'USD', 'INR'
- * @returns number
+ * Gets the default number of fraction digits for a given currency and locale.
+ *
+ * @param locale The locale (e.g., 'en-GB', 'de-DE', 'cs-CZ').
+ * @param currency The currency code (e.g., 'EUR', 'USD', 'INR').
+ *
+ * @returns The default number of fraction digits. Defaults to 2 if not resolvable.
  */
 export declare const getDefaultFractionDigits: (locale: string, currency: string) => number;

package/dist/helpers/objectHelpers.d.ts

@@ -1 +1,8 @@
+/**
+ * Flattens a nested object into a single-level object.
+ *
+ * @param object The object to flatten.
+ *
+ * @returns The flattened object.
+ */
 export declare const flattenObject: <T extends Record<string, any>>(object: T) => T;

package/dist/helpers/orderHelpers.d.ts

@@ -1,19 +1,26 @@
 import type { Order } from '../types';
+/**
+ * Retrieves unique items from an order based on variant ID.
+ *
+ * @param order The order object.
+ *
+ * @returns An array of unique order items.
+ */
 export declare const getUniqueItemsFromOrder: (order: Order) => {
-    id?: import("../types").UniqueNumericIdentifierOfTheItem;
-    availableQuantity?: import("../types").AvailableQuantityInTheWarehouse;
-    currency?: import("../types").CharacterCurrencyCode1;
+    id?: string;
+    availableQuantity?: number;
+    currency?: string;
     customData?: {
         [k: string]: unknown;
     };
     deliveryForecast?: import("../types").DeliveryForecastFromWarehouse;
-    isManuallyReturnedByCci?: import("../types").TheReturnShipmentHasBeenTriggeredByCCI;
+    isManuallyReturnedByCci?: boolean;
     itemGroup?: null | {
         id: string;
         isMainItem: boolean;
         isRequired: boolean;
     };
-    key: import("../types").UniqueIdentifierOfTheItem;
+    key: string;
     lowestPriorPrice?: null | {
         relativeDifferenceToPrice: number;
         withTax: number;
@@ -26,7 +33,7 @@ export declare const getUniqueItemsFromOrder: (order: Order) => {
     price: {
         appliedReductions?: {
             amount: {
-                absoluteWithTax: import("../types").ThisFieldRepresentsTheDiscountAmountIncludingTheTaxes1;
+                absoluteWithTax: number;
                 relative: number;
             };
             category: "sale" | "campaign" | "voucher";
@@ -42,14 +49,14 @@ export declare const getUniqueItemsFromOrder: (order: Order) => {
         };
         tax: {
             [k: string]: {
-                amount: import("../types").AbsoluteValueOfTheAppliedTax1;
-                rate: import("../types").RelativeValueOfTheAppliedTax;
+                amount: number;
+                rate: number;
             };
         };
-        undiscountedWithOutTax?: import("../types").UndiscountedItemPriceExcludingTaxes;
-        undiscountedWithTax?: import("../types").UndiscountedItemPriceIncludingTaxes;
-        withoutTax: import("../types").ItemPriceExcludingTaxes1;
-        withTax: import("../types").ItemPriceIncludingTaxes1;
+        undiscountedWithOutTax?: number;
+        undiscountedWithTax?: number;
+        withoutTax: number;
+        withTax: number;
     };
     product: {
         [k: string]: unknown;
@@ -59,9 +66,17 @@ export declare const getUniqueItemsFromOrder: (order: Order) => {
     variant: {
         [k: string]: unknown;
     };
-    warehouseId?: import("../types").PickingWarehouseId;
-    warehousePackageGroupId?: import("../types").WarehousePackageReference;
-    createdAt: import("../types").TimestampOfItemCreation;
-    updatedAt: import("../types").TimestampOfLastItemUpdate;
+    warehouseId?: null | number;
+    warehousePackageGroupId?: null | number;
+    createdAt: string;
+    updatedAt: string;
 }[] | undefined;
+/**
+ * Gets the quantity of a specific item in an order based on its variant ID.
+ *
+ * @param order The order object.
+ * @param variantId The ID of the variant to count.
+ *
+ * @returns The quantity of the item in the order, or undefined if the order or items are undefined.
+ */
 export declare const getItemQuantityFromOrder: (order: Order, variantId: number) => number | undefined;

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;