@plentymarkets/shop-api 0.168.0 → 0.169.0

package/lib/getters/reviewGetters.d.ts

@@ -1,26 +1,136 @@
 import { AgnosticRateCount } from './agnostic';
 import type { Review, ReviewItem, ReviewCounts } from '../types';
 import { ReviewPagination } from '../types';
+/**
+ * Returns all review feedback items from a review object.
+ * @param review - The review object.
+ * @returns An array of {@link ReviewItem} objects, or an empty array if none exist.
+ */
 declare function getReviewItems(review: Review): ReviewItem[];
+/**
+ * Returns the unique ID of a review item as a string.
+ * @param item - The review item.
+ * @returns The review ID string, or an empty string if not set.
+ */
 declare function getReviewId(item: ReviewItem): string;
+/**
+ * Returns the title of a review item.
+ * @param item - The review item.
+ * @returns The review title string, or an empty string if not set.
+ */
 declare function getReviewTitle(item: ReviewItem): string;
+/**
+ * Returns whether a review item is publicly visible.
+ * @param item - The review item.
+ * @returns `true` if the review is visible, otherwise `false`.
+ */
 declare function getReviewVisibility(item: ReviewItem): boolean;
+/**
+ * Returns whether the review is from a verified purchaser.
+ * A review is considered verified if any of its source relations has type `"orderItem"`.
+ * @param item - The review item.
+ * @returns `true` if the reviewer made a verified purchase, otherwise `false`.
+ */
 declare function getVerifiedPurchase(item: ReviewItem): boolean;
+/**
+ * Returns the author name of a review item.
+ * @param item - The review item.
+ * @returns The author name string, or an empty string if not set.
+ */
 declare function getReviewAuthor(item: ReviewItem): string;
+/**
+ * Returns the text message of a review item.
+ * @param item - The review item.
+ * @returns The review message string, or an empty string if not set.
+ */
 declare function getReviewMessage(item: ReviewItem): string;
+/**
+ * Returns the numeric star rating of a review item.
+ * @param item - The review item.
+ * @returns The rating value (typically 1–5), or `0` if not set.
+ */
 declare function getReviewRating(item: ReviewItem): number;
+/**
+ * Returns the creation date of a review item as a formatted date string.
+ * Falls back to the current date if the date is not parseable.
+ * @param item - The review item.
+ * @returns The formatted date string (e.g. `"Mon Jan 01 2024"`).
+ */
 declare function getReviewDate(item: ReviewItem): string;
+/**
+ * Returns the reply items (responses) for a review item.
+ * @param item - The review item.
+ * @returns An array of reply {@link ReviewItem} objects.
+ */
 declare function getReviewReplies(item: ReviewItem): ReviewItem[];
+/**
+ * Returns the author name of a review reply.
+ * @param replyItem - The reply review item.
+ * @returns The reply author name string.
+ */
 declare function getReplyAuthor(replyItem: ReviewItem): string;
+/**
+ * Returns the text message of a review reply.
+ * @param replyItem - The reply review item.
+ * @returns The reply message string.
+ */
 declare function getReplyMessage(replyItem: ReviewItem): string;
+/**
+ * Returns the creation date of a review reply as a formatted date string.
+ * Falls back to the current date if the date is not parseable.
+ * @param replyItem - The reply review item.
+ * @returns The formatted date string (e.g. `"Mon Jan 01 2024"`).
+ */
 declare function getReplyDate(replyItem: ReviewItem): string;
+/**
+ * Returns the target relation ID of a review reply (the ID of the review being replied to).
+ * @param replyItem - The reply review item.
+ * @returns The target relation ID as a number.
+ */
 declare function getReplyTargetId(replyItem: ReviewItem): number;
+/**
+ * Returns the total number of reviews from a review counts object.
+ * @param counts - The review counts object.
+ * @returns The total review count, or `0` if not set.
+ */
 declare function getTotalReviews(counts: ReviewCounts): number;
+/**
+ * Returns the average rating value from a review counts object.
+ * @param counts - The review counts object.
+ * @param roundOption - Optional rounding strategy: `'half'` rounds to the nearest 0.5, `'tenth'` rounds to the nearest 0.1.
+ * @returns The average rating as a number, or `0` if not set.
+ */
 declare function getAverageRating(counts: ReviewCounts, roundOption?: 'half' | 'tenth'): number;
+/**
+ * Returns the review counts (or percentages) per star rating in descending order (5 stars to 1 star).
+ * @param reviewCounts - The review counts object.
+ * @param returnPercentage - When `true`, returns percentages relative to the total; otherwise returns raw counts.
+ * @returns An array of five numbers `[5-star, 4-star, 3-star, 2-star, 1-star]` as counts or percentages.
+ */
 declare function getReviewCountsOrPercentagesByRatingDesc(reviewCounts: ReviewCounts, returnPercentage?: boolean): number[];
+/**
+ * @deprecated Not yet implemented — always returns an empty array.
+ * @param review - The review object (currently unused).
+ * @returns An empty array.
+ */
 declare function getRatesCount(review: Review): AgnosticRateCount[];
+/**
+ * Returns the current page number from the review pagination data.
+ * @param review - The review object.
+ * @returns The current page number as a number.
+ */
 declare function getCurrentReviewsPage(review: Review): number;
+/**
+ * Returns the pagination data from a review object.
+ * @param review - The review object.
+ * @returns The {@link ReviewPagination} object.
+ */
 declare function getReviewPagination(review: Review): ReviewPagination;
+/**
+ * Returns the review counts summary from a review object.
+ * @param review - The review object.
+ * @returns The {@link ReviewCounts} object containing rating totals and averages.
+ */
 declare function getReviewCounts(review: Review): ReviewCounts;
 export declare const reviewGetters: {
     getReviewItems: typeof getReviewItems;

package/lib/getters/reviewGetters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reviewGetters.d.ts","sourceRoot":"","sources":["../../src/getters/reviewGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAEjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C,iBAAS,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,EAAE,CAEpD;AAED,iBAAS,WAAW,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAE7C;AAED,iBAAS,cAAc,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAEhD;AAED,iBAAS,mBAAmB,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAEtD;AAED,iBAAS,mBAAmB,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAItD;AAED,iBAAS,eAAe,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAEjD;AAED,iBAAS,gBAAgB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAElD;AAED,iBAAS,eAAe,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAEjD;AAED,iBAAS,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAK/C;AAED,iBAAS,gBAAgB,CAAC,IAAI,EAAE,UAAU,GAAG,UAAU,EAAE,CAExD;AAED,iBAAS,cAAc,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAErD;AAED,iBAAS,eAAe,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAEtD;AAED,iBAAS,YAAY,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAInD;AAED,iBAAS,gBAAgB,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAEvD;AAED,iBAAS,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAErD;AAED,iBAAS,gBAAgB,CACvB,MAAM,EAAE,YAAY,EACpB,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,GAC7B,MAAM,CAER;AAED,iBAAS,wCAAwC,CAC/C,YAAY,EAAE,YAAY,EAC1B,gBAAgB,GAAE,OAAe,GAChC,MAAM,EAAE,CAcV;AAGD,iBAAS,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,iBAAiB,EAAE,CAE1D;AAED,iBAAS,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAErD;AAED,iBAAS,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAE7D;AAED,iBAAS,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAErD;AAED,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;CAsBzB,CAAC"}
+{"version":3,"file":"reviewGetters.d.ts","sourceRoot":"","sources":["../../src/getters/reviewGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAEjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C;;;;GAIG;AACH,iBAAS,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,EAAE,CAEpD;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAE7C;AAED;;;;GAIG;AACH,iBAAS,cAAc,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAEhD;AAED;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAEtD;AAED;;;;;GAKG;AACH,iBAAS,mBAAmB,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAItD;AAED;;;;GAIG;AACH,iBAAS,eAAe,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAEjD;AAED;;;;GAIG;AACH,iBAAS,gBAAgB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAElD;AAED;;;;GAIG;AACH,iBAAS,eAAe,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAEjD;AAED;;;;;GAKG;AACH,iBAAS,aAAa,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAK/C;AAED;;;;GAIG;AACH,iBAAS,gBAAgB,CAAC,IAAI,EAAE,UAAU,GAAG,UAAU,EAAE,CAExD;AAED;;;;GAIG;AACH,iBAAS,cAAc,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAErD;AAED;;;;GAIG;AACH,iBAAS,eAAe,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAEtD;AAED;;;;;GAKG;AACH,iBAAS,YAAY,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAInD;AAED;;;;GAIG;AACH,iBAAS,gBAAgB,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAEvD;AAED;;;;GAIG;AACH,iBAAS,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAErD;AAED;;;;;GAKG;AACH,iBAAS,gBAAgB,CACvB,MAAM,EAAE,YAAY,EACpB,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,GAC7B,MAAM,CAER;AAED;;;;;GAKG;AACH,iBAAS,wCAAwC,CAC/C,YAAY,EAAE,YAAY,EAC1B,gBAAgB,GAAE,OAAe,GAChC,MAAM,EAAE,CAcV;AAED;;;;GAIG;AAEH,iBAAS,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,iBAAiB,EAAE,CAE1D;AAED;;;;GAIG;AACH,iBAAS,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAErD;AAED;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAE7D;AAED;;;;GAIG;AACH,iBAAS,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,CAErD;AAED,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;CAsBzB,CAAC"}

package/lib/getters/robotGetters.d.ts

@@ -1,12 +1,57 @@
 import { RobotsStaticPages } from '../types';
+/**
+ * Returns the robots directive for the homepage.
+ * @param robots - The robots static pages configuration object.
+ * @returns The robots directive string, defaulting to `"ALL"` if not set.
+ */
 declare function getRobotsHomepage(robots: RobotsStaticPages): string;
+/**
+ * Returns the robots directive for the contact page.
+ * @param robots - The robots static pages configuration object.
+ * @returns The robots directive string, defaulting to `"ALL"` if not set.
+ */
 declare function getRobotsContactPage(robots: RobotsStaticPages): string;
+/**
+ * Returns the robots directive for the cancellation rights page.
+ * @param robots - The robots static pages configuration object.
+ * @returns The robots directive string, defaulting to `"ALL"` if not set.
+ */
 declare function getRobotsCancellationRights(robots: RobotsStaticPages): string;
+/**
+ * Returns the robots directive for the cancellation form page.
+ * @param robots - The robots static pages configuration object.
+ * @returns The robots directive string, defaulting to `"ALL"` if not set.
+ */
 declare function getRobotsCancellationForm(robots: RobotsStaticPages): string;
+/**
+ * Returns the robots directive for the legal disclosure page.
+ * @param robots - The robots static pages configuration object.
+ * @returns The robots directive string, defaulting to `"ALL"` if not set.
+ */
 declare function getRobotsLegalDisclosure(robots: RobotsStaticPages): string;
+/**
+ * Returns the robots directive for the privacy policy page.
+ * @param robots - The robots static pages configuration object.
+ * @returns The robots directive string, defaulting to `"ALL"` if not set.
+ */
 declare function getRobotsPrivacyPolicy(robots: RobotsStaticPages): string;
+/**
+ * Returns the robots directive for the terms and conditions page.
+ * @param robots - The robots static pages configuration object.
+ * @returns The robots directive string, defaulting to `"ALL"` if not set.
+ */
 declare function getRobotsTermsAndConditions(robots: RobotsStaticPages): string;
+/**
+ * Returns the robots directive for the search results page.
+ * @param robots - The robots static pages configuration object.
+ * @returns The robots directive string, defaulting to `"ALL"` if not set.
+ */
 declare function getRobotsSearchResult(robots: RobotsStaticPages): string;
+/**
+ * Returns the robots directive for the accessibility declaration page.
+ * @param robots - The robots static pages configuration object.
+ * @returns The robots directive string, defaulting to `"ALL"` if not set.
+ */
 declare function getRobotsAccessibilityDeclarationResult(robots: RobotsStaticPages): string;
 export declare const robotGetters: {
     getRobotsHomepage: typeof getRobotsHomepage;

package/lib/getters/robotGetters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"robotGetters.d.ts","sourceRoot":"","sources":["../../src/getters/robotGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAI7C,iBAAS,iBAAiB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAE5D;AAED,iBAAS,oBAAoB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAE/D;AAED,iBAAS,2BAA2B,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAEtE;AAED,iBAAS,yBAAyB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAEpE;AAED,iBAAS,wBAAwB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAEnE;AAED,iBAAS,sBAAsB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAEjE;AAED,iBAAS,2BAA2B,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAEtE;AAED,iBAAS,qBAAqB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAEhE;AACD,iBAAS,uCAAuC,CAC9C,MAAM,EAAE,iBAAiB,GACxB,MAAM,CAER;AAED,eAAO,MAAM,YAAY;;;;;;;;;;CAUxB,CAAC"}
+{"version":3,"file":"robotGetters.d.ts","sourceRoot":"","sources":["../../src/getters/robotGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAI7C;;;;GAIG;AACH,iBAAS,iBAAiB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAE5D;AAED;;;;GAIG;AACH,iBAAS,oBAAoB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAE/D;AAED;;;;GAIG;AACH,iBAAS,2BAA2B,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAEtE;AAED;;;;GAIG;AACH,iBAAS,yBAAyB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAEpE;AAED;;;;GAIG;AACH,iBAAS,wBAAwB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAEnE;AAED;;;;GAIG;AACH,iBAAS,sBAAsB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAEjE;AAED;;;;GAIG;AACH,iBAAS,2BAA2B,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAEtE;AAED;;;;GAIG;AACH,iBAAS,qBAAqB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAEhE;AAED;;;;GAIG;AACH,iBAAS,uCAAuC,CAC9C,MAAM,EAAE,iBAAiB,GACxB,MAAM,CAER;AAED,eAAO,MAAM,YAAY;;;;;;;;;;CAUxB,CAAC"}

package/lib/getters/shippingProviderGetters.d.ts

@@ -1,12 +1,57 @@
 import { Cart, ShippingMethod, ShippingPrivacyInformation, ShippingProvider } from '../types';
+/**
+ * Returns the list of available shipping methods from a shipping provider.
+ * @param shippingProvider - The shipping provider object.
+ * @returns An array of {@link ShippingMethod} objects, or an empty array if none exist.
+ */
 declare function getShippingProviders(shippingProvider: ShippingProvider): ShippingMethod[];
+/**
+ * Returns the combined shipping method name in `"<parcelServiceName> - <parcelServicePresetName>"` format.
+ * @param shippingMethod - The shipping method object.
+ * @returns The combined name string.
+ */
 declare function getShippingMethodName(shippingMethod: ShippingMethod): string;
+/**
+ * @deprecated Not yet implemented — always returns a placeholder image URL.
+ * @param shippingMethod - The shipping method (currently unused).
+ * @returns A placeholder image URL string.
+ */
 declare function getShippingMethodImage(shippingMethod: ShippingMethod): string;
+/**
+ * Returns the first privacy information entry for a shipping method.
+ * @param shippingMethod - The shipping method object.
+ * @returns The first {@link ShippingPrivacyInformation} object.
+ */
 declare function getShippingPrivacyInformation(shippingMethod: ShippingMethod): ShippingPrivacyInformation;
+/**
+ * Returns whether the data privacy agreement hint should be shown for a shipping method.
+ * @param shippingMethod - The shipping method object.
+ * @returns `true` if the data privacy hint should be displayed, otherwise `false`.
+ */
 declare function getDataPrivacyAgreementHint(shippingMethod: ShippingMethod): boolean;
+/**
+ * Returns the shipping amount for a shipping method as a string.
+ * @param shippingMethod - The shipping method object.
+ * @returns The shipping amount string, or `"0"` if not set.
+ */
 declare function getShippingAmount(shippingMethod: ShippingMethod): string;
+/**
+ * Returns the shipping method object itself (used when the full object is needed as a value).
+ * @param shippingMethod - The shipping method object.
+ * @returns The same {@link ShippingMethod} object.
+ */
 declare function getValue(shippingMethod: ShippingMethod): ShippingMethod;
+/**
+ * Returns the parcel service preset ID of a shipping method as a string.
+ * @param shippingMethod - The shipping method object.
+ * @returns The preset ID string, or `"0"` if not set.
+ */
 declare function getParcelServicePresetId(shippingMethod: ShippingMethod): string;
+/**
+ * Returns the active shipping profile ID from the cart as a string.
+ * @param cart - The cart object.
+ * @returns The shipping profile ID string.
+ */
 declare function getShippingProfileId(cart: Cart): string;
 export declare const shippingProviderGetters: {
     getShippingMethodName: typeof getShippingMethodName;

package/lib/getters/shippingProviderGetters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shippingProviderGetters.d.ts","sourceRoot":"","sources":["../../src/getters/shippingProviderGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EACJ,cAAc,EACd,0BAA0B,EAC1B,gBAAgB,EACjB,MAAM,UAAU,CAAC;AAElB,iBAAS,oBAAoB,CAC3B,gBAAgB,EAAE,gBAAgB,GACjC,cAAc,EAAE,CAElB;AAED,iBAAS,qBAAqB,CAAC,cAAc,EAAE,cAAc,GAAG,MAAM,CAErE;AAGD,iBAAS,sBAAsB,CAAC,cAAc,EAAE,cAAc,GAAG,MAAM,CAGtE;AAED,iBAAS,6BAA6B,CACpC,cAAc,EAAE,cAAc,GAC7B,0BAA0B,CAE5B;AAED,iBAAS,2BAA2B,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAG5E;AAED,iBAAS,iBAAiB,CAAC,cAAc,EAAE,cAAc,GAAG,MAAM,CAEjE;AAED,iBAAS,QAAQ,CAAC,cAAc,EAAE,cAAc,GAAG,cAAc,CAEhE;AAED,iBAAS,wBAAwB,CAAC,cAAc,EAAE,cAAc,GAAG,MAAM,CAExE;AAED,iBAAS,oBAAoB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEhD;AAED,eAAO,MAAM,uBAAuB;;;;;;;;;;CAUnC,CAAC"}
+{"version":3,"file":"shippingProviderGetters.d.ts","sourceRoot":"","sources":["../../src/getters/shippingProviderGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EACJ,cAAc,EACd,0BAA0B,EAC1B,gBAAgB,EACjB,MAAM,UAAU,CAAC;AAElB;;;;GAIG;AACH,iBAAS,oBAAoB,CAC3B,gBAAgB,EAAE,gBAAgB,GACjC,cAAc,EAAE,CAElB;AAED;;;;GAIG;AACH,iBAAS,qBAAqB,CAAC,cAAc,EAAE,cAAc,GAAG,MAAM,CAErE;AAED;;;;GAIG;AAEH,iBAAS,sBAAsB,CAAC,cAAc,EAAE,cAAc,GAAG,MAAM,CAGtE;AAED;;;;GAIG;AACH,iBAAS,6BAA6B,CACpC,cAAc,EAAE,cAAc,GAC7B,0BAA0B,CAE5B;AAED;;;;GAIG;AACH,iBAAS,2BAA2B,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAG5E;AAED;;;;GAIG;AACH,iBAAS,iBAAiB,CAAC,cAAc,EAAE,cAAc,GAAG,MAAM,CAEjE;AAED;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,cAAc,EAAE,cAAc,GAAG,cAAc,CAEhE;AAED;;;;GAIG;AACH,iBAAS,wBAAwB,CAAC,cAAc,EAAE,cAAc,GAAG,MAAM,CAExE;AAED;;;;GAIG;AACH,iBAAS,oBAAoB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEhD;AAED,eAAO,MAAM,uBAAuB;;;;;;;;;;CAUnC,CAAC"}

package/lib/getters/tagGetters.d.ts

@@ -1,9 +1,40 @@
 import type { Product, ProductTag } from '../types';
+/**
+ * Returns the list of tags associated with a product, filtered to exclude tags with empty names.
+ * @param product - The product object.
+ * @returns An array of {@link ProductTag} objects with non-empty names, or an empty array if none exist.
+ */
 declare function getTags(product: Product): ProductTag[];
+/**
+ * Returns the numeric ID of a product tag as a string.
+ * @param tag - The product tag object.
+ * @returns The tag ID string.
+ */
 declare function getTagId(tag: ProductTag): string;
+/**
+ * Returns the display name of a product tag.
+ * @param tag - The product tag object.
+ * @returns The tag name string, or an empty string if not set.
+ */
 declare function getTagName(tag: ProductTag): string;
+/**
+ * Returns the background color of a product tag.
+ * @param tag - The product tag object.
+ * @returns The hex color string (e.g. `"#ff0000"`), defaulting to `"#ffffff"` if not set.
+ */
 declare function getTagBackgroundColor(tag: ProductTag): string;
+/**
+ * Returns whether the tag's background color is considered dark, meaning light text should be used.
+ * Uses the luminance formula to determine perceived brightness from the background hex color.
+ * @param tag - The product tag object.
+ * @returns `true` if the background color is dark (luminance > 128), otherwise `false`.
+ */
 declare function getTagTextColorIsDark(tag: ProductTag): boolean;
+/**
+ * Returns a CSS class name derived from the tag ID (e.g. `"tag-42"`).
+ * @param tag - The product tag object.
+ * @returns The CSS class name string.
+ */
 declare function getAgenciesTagCLass(tag: ProductTag): string;
 export declare const tagGetters: {
     getTags: typeof getTags;

package/lib/getters/tagGetters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tagGetters.d.ts","sourceRoot":"","sources":["../../src/getters/tagGetters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEpD,iBAAS,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,EAAE,CAI/C;AAED,iBAAS,QAAQ,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,CAEzC;AAED,iBAAS,UAAU,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,CAE3C;AAED,iBAAS,qBAAqB,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,CAEtD;AAED,iBAAS,qBAAqB,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAgBvD;AAED,iBAAS,mBAAmB,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,CAEpD;AAED,eAAO,MAAM,UAAU;;;;;;;CAOtB,CAAC"}
+{"version":3,"file":"tagGetters.d.ts","sourceRoot":"","sources":["../../src/getters/tagGetters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEpD;;;;GAIG;AACH,iBAAS,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,EAAE,CAI/C;AAED;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,CAEzC;AAED;;;;GAIG;AACH,iBAAS,UAAU,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,CAE3C;AAED;;;;GAIG;AACH,iBAAS,qBAAqB,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,CAEtD;AAED;;;;;GAKG;AACH,iBAAS,qBAAqB,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAgBvD;AAED;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM,CAEpD;AAED,eAAO,MAAM,UAAU;;;;;;;CAOtB,CAAC"}

package/lib/getters/userAddressGetters.d.ts

@@ -1,25 +1,136 @@
 import type { Address, UserShippingAddressSearchCriteria, Country } from '../types';
+/**
+ * Returns the list of addresses, optionally filtered by the given criteria.
+ * @param addresses - The array of address objects.
+ * @param criteria - Optional search criteria (currently unused in filtering logic).
+ * @returns The original addresses array, or an empty array if not provided.
+ */
 declare function getAddresses(addresses: Address[], criteria?: UserShippingAddressSearchCriteria): Address[];
+/**
+ * Returns the birthday of the address holder.
+ * @param address - The address object.
+ * @returns The birthday string, or an empty string if not set.
+ */
 declare function getBirthday(address: Address): string;
+/**
+ * Returns the primary (default) address from a list of addresses.
+ * @param addresses - The array of address objects.
+ * @returns The first address marked as primary, or `null` if none is found.
+ */
 declare function getDefault(addresses: Address[]): Address | null;
+/**
+ * Returns the total number of addresses in the list.
+ * @param addresses - The array of address objects.
+ * @returns The number of addresses, or `0` if the array is empty.
+ */
 declare function getTotal(addresses: Address[]): number;
+/**
+ * Returns the postal code of the address.
+ * @param address - The address object.
+ * @returns The zip code string, or an empty string if not set.
+ */
 declare function getPostCode(address: Address): string;
+/**
+ * Returns the post number (Packstation identifier) of the address.
+ * @param address - The address object.
+ * @returns The post number string, or an empty string if not set.
+ */
 declare function getPostNumber(address: Address): string;
+/**
+ * Returns the street name of the address.
+ * @param address - The address object.
+ * @returns The street name string, or an empty string if not set.
+ */
 declare function getStreetName(address: Address): string;
+/**
+ * Returns the street/house number (apartment field) of the address.
+ * @param address - The address object.
+ * @returns The apartment/house number, or an empty string if not set.
+ */
 declare function getStreetNumber(address: Address): string | number;
+/**
+ * Returns the city of the address.
+ * @param address - The address object.
+ * @returns The city string, or an empty string if not set.
+ */
 declare function getCity(address: Address): string;
+/**
+ * Returns the first name of the address holder.
+ * @param address - The address object.
+ * @returns The first name string, or an empty string if not set.
+ */
 declare function getFirstName(address: Address): string;
+/**
+ * Returns the last name of the address holder.
+ * @param address - The address object.
+ * @returns The last name string, or an empty string if not set.
+ */
 declare function getLastName(address: Address): string;
+/**
+ * Returns the phone number of the address holder.
+ * @param address - The address object.
+ * @returns The phone number string, or an empty string if not set.
+ */
 declare function getPhone(address: Address): string;
+/**
+ * Returns the email address of the address holder.
+ * @param address - The address object.
+ * @returns The email string, or an empty string if not set.
+ */
 declare function getEmail(address: Address): string;
+/**
+ * Returns the province or state of the address.
+ * @param address - The address object.
+ * @returns The state string, or an empty string if not set.
+ */
 declare function getProvince(address: Address): string;
+/**
+ * Returns the company name of the address holder.
+ * @param address - The address object.
+ * @returns The company name string, or an empty string if not set.
+ */
 declare function getCompanyName(address: Address): string;
+/**
+ * Returns the VAT number of the address holder.
+ * @param address - The address object.
+ * @returns The VAT number string, or an empty string if not set.
+ */
 declare function getVatNumber(address: Address): string;
+/**
+ * Returns the unique ID of the address as a string.
+ * @param address - The address object.
+ * @returns The address ID string, or an empty string if not set.
+ */
 declare function getId(address: Address): string;
+/**
+ * Returns the apartment/house number of the address.
+ * @param address - The address object.
+ * @returns The apartment value, or `0` if not set.
+ */
 declare function getApartmentNumber(address: Address): string | number;
+/**
+ * Returns whether the address is marked as the primary (default) address.
+ * @param address - The address object.
+ * @returns `true` if the `primary` flag is a positive number, otherwise `false`.
+ */
 declare function isDefault(address: Address): boolean;
+/**
+ * Removes the `id` field from the address and returns the modified address.
+ * @param address - The address object.
+ * @returns The address object with the `id` property deleted.
+ */
 declare function getAddressWithoutId(address: Address): Address;
+/**
+ * Returns the country ID of the address as a string.
+ * @param address - The address object.
+ * @returns The country ID string, or `"0"` if not set.
+ */
 declare function getCountryId(address: Address): string;
+/**
+ * Returns the state ID of the address as a string.
+ * @param address - The address object.
+ * @returns The state ID string, or `"0"` if not set.
+ */
 declare function getStateId(address: Address): string;
 export declare const userAddressGetters: {
     getAddresses: typeof getAddresses;

package/lib/getters/userAddressGetters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"userAddressGetters.d.ts","sourceRoot":"","sources":["../../src/getters/userAddressGetters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,iCAAiC,EACjC,OAAO,EACR,MAAM,UAAU,CAAC;AAGlB,iBAAS,YAAY,CACnB,SAAS,EAAE,OAAO,EAAE,EAEpB,QAAQ,CAAC,EAAE,iCAAiC,GAC3C,OAAO,EAAE,CAEX;AAED,iBAAS,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE7C;AAED,iBAAS,UAAU,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,OAAO,GAAG,IAAI,CAExD;AAED,iBAAS,QAAQ,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,CAE9C;AAED,iBAAS,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE7C;AAED,iBAAS,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE/C;AAED,iBAAS,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE/C;AAED,iBAAS,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAE1D;AAED,iBAAS,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEzC;AAED,iBAAS,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE9C;AAED,iBAAS,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE7C;AAED,iBAAS,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE1C;AAED,iBAAS,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE1C;AAED,iBAAS,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE7C;AAED,iBAAS,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEhD;AAED,iBAAS,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE9C;AAED,iBAAS,KAAK,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEvC;AAED,iBAAS,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAE7D;AAED,iBAAS,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE5C;AAED,iBAAS,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAGtD;AAED,iBAAS,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE9C;AAED,iBAAS,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE5C;AAwBD,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;8BAtBE,OAAO,aAAa,OAAO,EAAE,KAAG,MAAM;4BASxC,OAAO,aAAa,OAAO,EAAE,KAAG,MAAM;CAsCpE,CAAC"}
+{"version":3,"file":"userAddressGetters.d.ts","sourceRoot":"","sources":["../../src/getters/userAddressGetters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,iCAAiC,EACjC,OAAO,EACR,MAAM,UAAU,CAAC;AAGlB;;;;;GAKG;AACH,iBAAS,YAAY,CACnB,SAAS,EAAE,OAAO,EAAE,EAEpB,QAAQ,CAAC,EAAE,iCAAiC,GAC3C,OAAO,EAAE,CAEX;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE7C;AAED;;;;GAIG;AACH,iBAAS,UAAU,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,OAAO,GAAG,IAAI,CAExD;AAED;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,CAE9C;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE7C;AAED;;;;GAIG;AACH,iBAAS,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE/C;AAED;;;;GAIG;AACH,iBAAS,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE/C;AAED;;;;GAIG;AACH,iBAAS,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAE1D;AAED;;;;GAIG;AACH,iBAAS,OAAO,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEzC;AAED;;;;GAIG;AACH,iBAAS,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE9C;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE7C;AAED;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE1C;AAED;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE1C;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE7C;AAED;;;;GAIG;AACH,iBAAS,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEhD;AAED;;;;GAIG;AACH,iBAAS,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE9C;AAED;;;;GAIG;AACH,iBAAS,KAAK,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEvC;AAED;;;;GAIG;AACH,iBAAS,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAE7D;AAED;;;;GAIG;AACH,iBAAS,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAE5C;AAED;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAGtD;AAED;;;;GAIG;AACH,iBAAS,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE9C;AAED;;;;GAIG;AACH,iBAAS,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE5C;AAqCD,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;8BA7BE,OAAO,aAAa,OAAO,EAAE,KAAG,MAAM;4BAgBxC,OAAO,aAAa,OAAO,EAAE,KAAG,MAAM;CAsCpE,CAAC"}

package/lib/getters/userGetters.d.ts

@@ -1,8 +1,33 @@
 import type { User } from '../types';
+/**
+ * Returns the first name of a user.
+ * @param user - The user object.
+ * @returns The first name string, or an empty string if not set.
+ */
 declare function getFirstName(user: User): string;
+/**
+ * Returns the last name of a user.
+ * @param user - The user object.
+ * @returns The last name string, or an empty string if not set.
+ */
 declare function getLastName(user: User): string;
+/**
+ * Returns the full name of a user.
+ * @param user - The user object.
+ * @returns The full name string, or an empty string if not set.
+ */
 declare function getFullName(user: User): string;
+/**
+ * Returns the email address of a user.
+ * @param user - The user object.
+ * @returns The email address string, or an empty string if not set.
+ */
 declare function getEmailAddress(user: User): string;
+/**
+ * Validates whether the given string is a properly formatted email address.
+ * @param email - The email string to validate.
+ * @returns `true` if the email is valid, otherwise `false`.
+ */
 declare function isValidEmailAddress(email: string): boolean;
 export declare const userGetters: {
     getFirstName: typeof getFirstName;

package/lib/getters/userGetters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"userGetters.d.ts","sourceRoot":"","sources":["../../src/getters/userGetters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAGrC,iBAAS,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAExC;AAED,iBAAS,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEvC;AAED,iBAAS,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEvC;AAED,iBAAS,eAAe,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAE3C;AAED,iBAAS,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,eAAO,MAAM,WAAW;;;;;;CAMvB,CAAC"}
+{"version":3,"file":"userGetters.d.ts","sourceRoot":"","sources":["../../src/getters/userGetters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAGrC;;;;GAIG;AACH,iBAAS,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAExC;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEvC;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEvC;AAED;;;;GAIG;AACH,iBAAS,eAAe,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAE3C;AAED;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,eAAO,MAAM,WAAW;;;;;;CAMvB,CAAC"}

package/lib/getters/wishlistGetters.d.ts

@@ -1,28 +1,111 @@
 import { AgnosticAttribute, AgnosticTotals } from './agnostic';
 import type { WishlistItem } from '../types';
+/**
+ * Returns all items in the wishlist.
+ * @param wishlist - The wishlist object containing an items array.
+ * @returns An array of {@link WishlistItem} objects, or an empty array if none exist.
+ */
 declare function getItems(wishlist: {
     items: WishlistItem[];
 }): WishlistItem[];
+/**
+ * @deprecated Not yet implemented — always returns zero totals.
+ * @param wishlist - The wishlist object (currently unused).
+ * @returns An {@link AgnosticTotals} object with `total` and `subtotal` both set to `0`.
+ */
 declare function getTotals(wishlist: {
     items: WishlistItem[];
 }): AgnosticTotals;
+/**
+ * Returns the display name (`name1`) of a wishlist item.
+ * @param item - The wishlist item.
+ * @returns The name string, or an empty string if not set.
+ */
 declare function getItemName(item: WishlistItem): string;
+/**
+ * @deprecated Not yet implemented — always returns an empty string.
+ * @returns An empty string.
+ */
 declare function getItemImage(): string;
+/**
+ * Returns the default unit price of a wishlist item.
+ * @param item - The wishlist item.
+ * @returns The price as a number, or `null` if not set.
+ */
 declare function getItemPrice(item: WishlistItem): number | null;
+/**
+ * Returns the special (sale) price of a wishlist item.
+ * @param item - The wishlist item.
+ * @returns The special price value, or `0` if not set.
+ */
 declare function getSpecialItemPrice(item: WishlistItem): number;
+/**
+ * Returns the regular (RRP) price of a wishlist item.
+ * @param item - The wishlist item.
+ * @returns The RRP price value, or `0` if not set.
+ */
 declare function getRegularItemPrice(item: WishlistItem): number;
+/**
+ * @deprecated Not yet implemented — always returns `1`.
+ * @param item - The wishlist item (currently unused).
+ * @returns Always `1`.
+ */
 declare function getItemQty(item: WishlistItem): number;
+/**
+ * @deprecated Not yet implemented — always returns a placeholder color attribute.
+ * @param item - The wishlist item (currently unused).
+ * @param filters - Optional attribute filter list (currently unused).
+ * @returns A record containing a placeholder `"color"` attribute set to `"red"`.
+ */
 declare function getItemAttributes(item: WishlistItem, filters?: string[]): Record<string, AgnosticAttribute | string>;
+/**
+ * @deprecated Not yet implemented — always returns an empty string.
+ * @param item - The wishlist item (currently unused).
+ * @returns An empty string.
+ */
 declare function getItemSku(item: WishlistItem): string;
+/**
+ * Returns the variation ID of a wishlist item as a string.
+ * @param product - The wishlist item.
+ * @returns The variation ID string, or an empty string if not set.
+ */
 declare function getId(product: WishlistItem): string;
+/**
+ * @deprecated Not yet implemented — always returns `0`.
+ * @param wishlist - The wishlist object (currently unused).
+ * @returns Always `0`.
+ */
 declare function getShippingPrice(wishlist: {
     items: WishlistItem[];
 }): number;
+/**
+ * Returns the total number of items in the wishlist.
+ * @param wishlist - The wishlist object.
+ * @returns The number of wishlist items, or `0` if the wishlist is empty.
+ */
 declare function getTotalItems(wishlist: {
     items: WishlistItem[];
 }): number;
+/**
+ * Returns the price as a formatted string.
+ * @param price - The numeric price value.
+ * @returns The price as a string, or an empty string if the value is falsy.
+ */
 declare function getFormattedPrice(price: number): string;
+/**
+ * Returns whether a wishlist item can be added directly to the cart without further user interaction.
+ * Returns `true` only when the item is salable, has no order properties, is not a set item,
+ * has a minimum quantity of `1`, an interval quantity of `1`, has the `canDirectlyAddToCart` flag set,
+ * and has no graduated prices.
+ * @param wishlistItem - The wishlist item.
+ * @returns `true` if the item can be directly added to the cart, otherwise `false`.
+ */
 declare function canDirectlyAddToCart(wishlistItem: WishlistItem): boolean;
+/**
+ * Returns the raw `canDirectlyAddToCart` flag value from a wishlist item.
+ * @param wishlistItem - The wishlist item.
+ * @returns The numeric flag value, or `0` if not set.
+ */
 declare function getCanDirectlyAddToCart(wishlistItem: WishlistItem): number;
 export declare const wishlistGetters: {
     getItems: typeof getItems;

package/lib/getters/wishlistGetters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wishlistGetters.d.ts","sourceRoot":"","sources":["../../src/getters/wishlistGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAM7C,iBAAS,QAAQ,CAAC,QAAQ,EAAE;IAAE,KAAK,EAAE,YAAY,EAAE,CAAA;CAAE,GAAG,YAAY,EAAE,CAErE;AAGD,iBAAS,SAAS,CAAC,QAAQ,EAAE;IAAE,KAAK,EAAE,YAAY,EAAE,CAAA;CAAE,GAAG,cAAc,CAKtE;AAED,iBAAS,WAAW,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,CAE/C;AAED,iBAAS,YAAY,IAAI,MAAM,CAI9B;AAED,iBAAS,YAAY,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,GAAG,IAAI,CAEvD;AAED,iBAAS,mBAAmB,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,CAEvD;AAED,iBAAS,mBAAmB,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,CAEvD;AAGD,iBAAS,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,CAE9C;AAED,iBAAS,iBAAiB,CAExB,IAAI,EAAE,YAAY,EAElB,OAAO,CAAC,EAAE,MAAM,EAAE,GACjB,MAAM,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAAC,CAI5C;AAGD,iBAAS,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,CAE9C;AAED,iBAAS,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,MAAM,CAE5C;AAGD,iBAAS,gBAAgB,CAAC,QAAQ,EAAE;IAAE,KAAK,EAAE,YAAY,EAAE,CAAA;CAAE,GAAG,MAAM,CAErE;AAED,iBAAS,aAAa,CAAC,QAAQ,EAAE;IAAE,KAAK,EAAE,YAAY,EAAE,CAAA;CAAE,GAAG,MAAM,CAElE;AAED,iBAAS,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED,iBAAS,oBAAoB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAejE;AAED,iBAAS,uBAAuB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEnE;AAED,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;CAiB3B,CAAC"}
+{"version":3,"file":"wishlistGetters.d.ts","sourceRoot":"","sources":["../../src/getters/wishlistGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAM7C;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,QAAQ,EAAE;IAAE,KAAK,EAAE,YAAY,EAAE,CAAA;CAAE,GAAG,YAAY,EAAE,CAErE;AAED;;;;GAIG;AAEH,iBAAS,SAAS,CAAC,QAAQ,EAAE;IAAE,KAAK,EAAE,YAAY,EAAE,CAAA;CAAE,GAAG,cAAc,CAKtE;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,CAE/C;AAED;;;GAGG;AACH,iBAAS,YAAY,IAAI,MAAM,CAI9B;AAED;;;;GAIG;AACH,iBAAS,YAAY,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,GAAG,IAAI,CAEvD;AAED;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,CAEvD;AAED;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,CAEvD;AAED;;;;GAIG;AAEH,iBAAS,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,CAE9C;AAED;;;;;GAKG;AACH,iBAAS,iBAAiB,CAExB,IAAI,EAAE,YAAY,EAElB,OAAO,CAAC,EAAE,MAAM,EAAE,GACjB,MAAM,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAAC,CAI5C;AAED;;;;GAIG;AAEH,iBAAS,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,CAE9C;AAED;;;;GAIG;AACH,iBAAS,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,MAAM,CAE5C;AAED;;;;GAIG;AAEH,iBAAS,gBAAgB,CAAC,QAAQ,EAAE;IAAE,KAAK,EAAE,YAAY,EAAE,CAAA;CAAE,GAAG,MAAM,CAErE;AAED;;;;GAIG;AACH,iBAAS,aAAa,CAAC,QAAQ,EAAE;IAAE,KAAK,EAAE,YAAY,EAAE,CAAA;CAAE,GAAG,MAAM,CAElE;AAED;;;;GAIG;AACH,iBAAS,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED;;;;;;;GAOG;AACH,iBAAS,oBAAoB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAejE;AAED;;;;GAIG;AACH,iBAAS,uBAAuB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEnE;AAED,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;CAiB3B,CAAC"}