@plentymarkets/shop-api 0.168.1 → 0.169.0

package/lib/getters/categoryGetters.d.ts

@@ -1,18 +1,93 @@
-import type { Category, CategoryDetails } from '../types';
+import type { Category, CategoryDetails, SubCategory } from '../types';
+/**
+ * Returns the numeric ID of a category.
+ * @param category - The category object.
+ * @returns The category ID, or `0` if not set.
+ */
 declare function getId(category: Category): number;
+/**
+ * Returns the numeric ID of the parent category.
+ * @param category - The category object.
+ * @returns The parent category ID, or `0` if not set.
+ */
 declare function getParentId(category: Category): number;
+/**
+ * Returns the first localised details entry of a category.
+ * @param category - The category object.
+ * @returns The first {@link CategoryDetails} entry, or `null` if none exist.
+ */
 declare function getCategoryDetails(category: Category): CategoryDetails | null;
+/**
+ * Returns the first long description of the category.
+ * @param category - The category object.
+ * @returns The first description string, or an empty string if not set.
+ */
 declare function getCategoryDescription1(category: Category): string;
+/**
+ * Returns the second long description of the category.
+ * @param category - The category object.
+ * @returns The second description string, or an empty string if not set.
+ */
 declare function getCategoryDescription2(category: Category): string;
+/**
+ * Returns the short description of the category.
+ * @param category - The category object.
+ * @returns The short description string, or an empty string if not set.
+ */
 declare function getCategoryShortDescription(category: Category): string;
+/**
+ * Returns the SEO meta title of the category.
+ * @param category - The category object.
+ * @returns The meta title string, or an empty string if not set.
+ */
 declare function getMetaTitle(category: Category): string;
+/**
+ * Returns the SEO meta description of the category.
+ * @param category - The category object.
+ * @returns The meta description string, or an empty string if not set.
+ */
 declare function getMetaDescription(category: Category): string;
+/**
+ * Returns the SEO meta keywords of the category.
+ * @param category - The category object.
+ * @returns The meta keywords string, or an empty string if not set.
+ */
 declare function getMetaKeywords(category: Category): string;
+/**
+ * Returns the display name of the category from its first details entry.
+ * @param category - The category object.
+ * @returns The category name string, or an empty string if details are not available.
+ */
 declare function getCategoryName(category: Category): string;
+/**
+ * Returns the type of the category (e.g. `"item"`, `"content"`, `"container"`).
+ * @param category - The category object.
+ * @returns The category type string, or an empty string if not set.
+ */
 declare function getCategoryType(category: Category): string;
+/**
+ * Returns the access right of the category (e.g. `"all"`, `"customer"`).
+ * @param category - The category object.
+ * @returns The right string, or an empty string if not set.
+ */
 declare function getCategoryRight(category: Category): string;
+/**
+ * Returns whether the category requires a customer login to access.
+ * @param category - The category object.
+ * @returns `true` if the category right is `"customer"`, otherwise `false`.
+ */
 declare function hasCustomerRight(category: Category): boolean;
+/**
+ * Returns the robots meta tag setting for the category.
+ * @param category - The category object.
+ * @returns The robots string (e.g. `"ALL"`, `"NOINDEX"`), or an empty string if not set.
+ */
 declare function getCategoryRobots(category: Category): string;
+declare function getSubCategories(category: Category): SubCategory[];
+declare function getSubCategoryName(subcategory: SubCategory): string;
+declare function getSubCategoryId(subcategory: SubCategory): number;
+declare function getSubCategoryNameUrl(subcategory: SubCategory): string;
+declare function getSubCategoryItemCount(subcategory: SubCategory): number;
 export declare const categoryGetters: {
     getId: typeof getId;
     getParentId: typeof getParentId;
@@ -28,6 +103,11 @@ export declare const categoryGetters: {
     getCategoryDescription1: typeof getCategoryDescription1;
     getCategoryDescription2: typeof getCategoryDescription2;
     getCategoryShortDescription: typeof getCategoryShortDescription;
+    getSubCategories: typeof getSubCategories;
+    getSubCategoryName: typeof getSubCategoryName;
+    getSubCategoryId: typeof getSubCategoryId;
+    getSubCategoryNameUrl: typeof getSubCategoryNameUrl;
+    getSubCategoryItemCount: typeof getSubCategoryItemCount;
 };
 export {};
 //# sourceMappingURL=categoryGetters.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"categoryGetters.d.ts","sourceRoot":"","sources":["../../src/getters/categoryGetters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE1D,iBAAS,KAAK,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAEzC;AAED,iBAAS,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAE/C;AACD,iBAAS,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,GAAG,eAAe,GAAG,IAAI,CAEtE;AAED,iBAAS,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAE3D;AAED,iBAAS,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAE3D;AAED,iBAAS,2BAA2B,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAE/D;AAED,iBAAS,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAEhD;AAED,iBAAS,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAEtD;AAED,iBAAS,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAEnD;AAED,iBAAS,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAEnD;AAED,iBAAS,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAEnD;AAED,iBAAS,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAEpD;AAED,iBAAS,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAErD;AAED,iBAAS,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAErD;AAED,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;CAe3B,CAAC"}
+{"version":3,"file":"categoryGetters.d.ts","sourceRoot":"","sources":["../../src/getters/categoryGetters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvE;;;;GAIG;AACH,iBAAS,KAAK,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAEzC;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAE/C;AAED;;;;GAIG;AACH,iBAAS,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,GAAG,eAAe,GAAG,IAAI,CAEtE;AAED;;;;GAIG;AACH,iBAAS,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAE3D;AAED;;;;GAIG;AACH,iBAAS,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAE3D;AAED;;;;GAIG;AACH,iBAAS,2BAA2B,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAE/D;AAED;;;;GAIG;AACH,iBAAS,YAAY,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAEhD;AAED;;;;GAIG;AACH,iBAAS,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAEtD;AAED;;;;GAIG;AACH,iBAAS,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAEnD;AAED;;;;GAIG;AACH,iBAAS,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAEnD;AAED;;;;GAIG;AACH,iBAAS,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAEnD;AAED;;;;GAIG;AACH,iBAAS,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAEpD;AAED;;;;GAIG;AACH,iBAAS,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAErD;AAED;;;;GAIG;AACH,iBAAS,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAErD;AAED,iBAAS,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG,WAAW,EAAE,CAE3D;AAED,iBAAS,kBAAkB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAE5D;AAED,iBAAS,gBAAgB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAE1D;AAED,iBAAS,qBAAqB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAE/D;AAED,iBAAS,uBAAuB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAEjE;AAED,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;CAoB3B,CAAC"}

package/lib/getters/categoryTreeGetters.d.ts

@@ -1,19 +1,117 @@
 import type { CategoryTreeItemDetails, CategoryTreeItem, Breadcrumb } from '../types';
+/**
+ * Builds a filtered and normalised category tree from the raw category list.
+ * Only entries with valid details are included; children are processed recursively.
+ * @param categories - The flat or nested array of raw category tree items.
+ * @returns An array of {@link CategoryTreeItem} objects forming the visible tree.
+ */
 declare function getTree(categories: CategoryTreeItem[]): CategoryTreeItem[];
+/**
+ * Returns the numeric ID of a category tree item.
+ * @param categoryTreeItem - The category tree item.
+ * @returns The category ID.
+ */
 declare function getId(categoryTreeItem: CategoryTreeItem): number;
+/**
+ * Returns a normalised tree item for the given category, or `null` if the category has no valid details.
+ * Recursively processes children and updates the `childCount` property.
+ * @param category - The raw category tree item.
+ * @returns The normalised {@link CategoryTreeItem}, or `null` if details are missing.
+ */
 declare function getTreeItem(category: CategoryTreeItem): CategoryTreeItem | null;
+/**
+ * Searches the category tree for the first category whose `nameUrl` matches the given slug.
+ * Performs a depth-first recursive search through children.
+ * @param categories - The array of category tree items to search.
+ * @param slug - The URL slug to match against each category's `nameUrl`.
+ * @returns The matching {@link CategoryTreeItem}, or `null` if not found.
+ */
 declare function findCategoryBySlug(categories: CategoryTreeItem[], slug: string): CategoryTreeItem | null;
+/**
+ * Searches the category tree for a category with the given numeric ID.
+ * Performs a depth-first recursive search through children.
+ * @param categories - The array of category tree items to search.
+ * @param categoryId - The numeric ID of the category to find.
+ * @returns The matching {@link CategoryTreeItem}, or `null` if not found.
+ */
 declare function findCategoryById(categories: CategoryTreeItem[], categoryId: number): CategoryTreeItem | null;
+/**
+ * Returns the full ancestry path (from root to the target category) for the category with the given ID.
+ * Performs a depth-first recursive search and accumulates the path of ancestors.
+ * @param categories - The array of category tree items to search.
+ * @param id - The numeric ID of the target category.
+ * @param path - The accumulated path of ancestors so far (used in recursion).
+ * @returns An array of {@link CategoryTreeItem} objects from root to the target, or an empty array if not found.
+ */
 declare function findCategoriesPathByCategoryId(categories: CategoryTreeItem[], id: number, path?: CategoryTreeItem[]): CategoryTreeItem[];
+/**
+ * Generates the full URL path for a category node within a tree.
+ * Traverses the ancestry path and concatenates each category's slug.
+ * @param tree - The full category tree.
+ * @param node - The target category tree item.
+ * @param startStr - An optional prefix to prepend to the generated path (defaults to `""`).
+ * @returns The full URL path string for the category.
+ */
 declare function generateCategoryLink(tree: CategoryTreeItem[], node: CategoryTreeItem, startStr?: string): string;
+/**
+ * Finds a category by matching successive URL slugs through nested children.
+ * Each element in `slugs` corresponds to a level in the category hierarchy.
+ * @param categories - The array of category tree items to search at the current level.
+ * @param slugs - An ordered array of URL slugs representing the category path.
+ * @returns The matching {@link CategoryTreeItem}, or `undefined` if not found.
+ */
 declare function findCategoryBySlugs(categories: CategoryTreeItem[], slugs: string[]): CategoryTreeItem | undefined;
+/**
+ * Generates an array of breadcrumb entries from the root to the category with the given ID.
+ * Each breadcrumb contains the category name and its full URL link.
+ * @param tree - The full category tree.
+ * @param categoryId - The numeric ID of the target category.
+ * @returns An array of {@link Breadcrumb} objects ordered from root to the target category.
+ */
 declare function generateBreadcrumbFromCategory(tree: CategoryTreeItem[], categoryId: number): Breadcrumb[];
+/**
+ * Returns the first details entry of a category tree item.
+ * @param details - The array of {@link CategoryTreeItemDetails} objects.
+ * @returns The first {@link CategoryTreeItemDetails}, or `null` if the array is empty or not provided.
+ */
 declare function getCategoryDetails(details: CategoryTreeItemDetails[]): CategoryTreeItemDetails | null;
+/**
+ * Returns the item count for a category tree item.
+ * @param category - The category tree item.
+ * @returns The numeric item count, or `0` if not available.
+ */
 declare function getCount(category: CategoryTreeItem): number;
+/**
+ * Returns the display name of a category tree item from its first details entry.
+ * @param category - The category tree item.
+ * @returns The category name string, or an empty string if details are not available.
+ */
 declare function getName(category: CategoryTreeItem): string;
+/**
+ * Returns the URL slug (`nameUrl`) of a category tree item from its first details entry.
+ * @param category - The category tree item.
+ * @returns The slug string, or an empty string if details are not available.
+ */
 declare function getSlug(category: CategoryTreeItem): string;
+/**
+ * Returns the child categories of a category tree item.
+ * @param category - The category tree item.
+ * @returns An array of child {@link CategoryTreeItem} objects, or an empty array if none exist.
+ */
 declare function getItems(category: CategoryTreeItem): CategoryTreeItem[];
+/**
+ * Returns the access right of a category tree item (e.g. `"all"`, `"customer"`).
+ * @param category - The category tree item.
+ * @returns The right string, defaulting to `"all"` if not set.
+ */
 declare function getCategoryRight(category: CategoryTreeItem): string;
+/**
+ * Returns an array of breadcrumbs for the given category ID, each with name and prefixed link.
+ * @param categories - The full category tree.
+ * @param categoryId - The numeric ID of the target category.
+ * @param prefix - An optional URL prefix to prepend to each breadcrumb link (defaults to `""`).
+ * @returns An array of {@link Breadcrumb} objects ordered from root to the target category.
+ */
 declare function getMappedBreadcrumbs(categories: CategoryTreeItem[], categoryId: number, prefix?: string): Breadcrumb[];
 export declare const categoryTreeGetters: {
     getId: typeof getId;

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

@@ -1 +1 @@
-{"version":3,"file":"categoryTreeGetters.d.ts","sourceRoot":"","sources":["../../src/getters/categoryTreeGetters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uBAAuB,EACvB,gBAAgB,EAChB,UAAU,EACX,MAAM,UAAU,CAAC;AAElB,iBAAS,OAAO,CAAC,UAAU,EAAE,gBAAgB,EAAE,GAAG,gBAAgB,EAAE,CAYnE;AAED,iBAAS,KAAK,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,MAAM,CAEzD;AAED,iBAAS,WAAW,CAAC,QAAQ,EAAE,gBAAgB,GAAG,gBAAgB,GAAG,IAAI,CAYxE;AAED,iBAAS,kBAAkB,CACzB,UAAU,EAAE,gBAAgB,EAAE,EAC9B,IAAI,EAAE,MAAM,GACX,gBAAgB,GAAG,IAAI,CAczB;AAED,iBAAS,gBAAgB,CACvB,UAAU,EAAE,gBAAgB,EAAE,EAC9B,UAAU,EAAE,MAAM,GACjB,gBAAgB,GAAG,IAAI,CAczB;AAED,iBAAS,8BAA8B,CACrC,UAAU,EAAE,gBAAgB,EAAE,EAC9B,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,gBAAgB,EAAO,GAC5B,gBAAgB,EAAE,CAiBpB;AAED,iBAAS,oBAAoB,CAC3B,IAAI,EAAE,gBAAgB,EAAE,EACxB,IAAI,EAAE,gBAAgB,EACtB,QAAQ,SAAK,GACZ,MAAM,CASR;AAED,iBAAS,mBAAmB,CAC1B,UAAU,EAAE,gBAAgB,EAAE,EAC9B,KAAK,EAAE,MAAM,EAAE,GACd,gBAAgB,GAAG,SAAS,CAO9B;AAED,iBAAS,8BAA8B,CACrC,IAAI,EAAE,gBAAgB,EAAE,EACxB,UAAU,EAAE,MAAM,GACjB,UAAU,EAAE,CAkBd;AAED,iBAAS,kBAAkB,CACzB,OAAO,EAAE,uBAAuB,EAAE,GACjC,uBAAuB,GAAG,IAAI,CAEhC;AAED,iBAAS,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAEpD;AAED,iBAAS,OAAO,CAAC,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAInD;AAED,iBAAS,OAAO,CAAC,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAInD;AAED,iBAAS,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,GAAG,gBAAgB,EAAE,CAEhE;AAED,iBAAS,gBAAgB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAE5D;AAED,iBAAS,oBAAoB,CAC3B,UAAU,EAAE,gBAAgB,EAAE,EAC9B,UAAU,EAAE,MAAM,EAClB,MAAM,GAAE,MAAW,GAClB,UAAU,EAAE,CAWd;AAED,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;CAiB/B,CAAC"}
+{"version":3,"file":"categoryTreeGetters.d.ts","sourceRoot":"","sources":["../../src/getters/categoryTreeGetters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uBAAuB,EACvB,gBAAgB,EAChB,UAAU,EACX,MAAM,UAAU,CAAC;AAElB;;;;;GAKG;AACH,iBAAS,OAAO,CAAC,UAAU,EAAE,gBAAgB,EAAE,GAAG,gBAAgB,EAAE,CAYnE;AAED;;;;GAIG;AACH,iBAAS,KAAK,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,MAAM,CAEzD;AAED;;;;;GAKG;AACH,iBAAS,WAAW,CAAC,QAAQ,EAAE,gBAAgB,GAAG,gBAAgB,GAAG,IAAI,CAYxE;AAED;;;;;;GAMG;AACH,iBAAS,kBAAkB,CACzB,UAAU,EAAE,gBAAgB,EAAE,EAC9B,IAAI,EAAE,MAAM,GACX,gBAAgB,GAAG,IAAI,CAczB;AAED;;;;;;GAMG;AACH,iBAAS,gBAAgB,CACvB,UAAU,EAAE,gBAAgB,EAAE,EAC9B,UAAU,EAAE,MAAM,GACjB,gBAAgB,GAAG,IAAI,CAczB;AAED;;;;;;;GAOG;AACH,iBAAS,8BAA8B,CACrC,UAAU,EAAE,gBAAgB,EAAE,EAC9B,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,gBAAgB,EAAO,GAC5B,gBAAgB,EAAE,CAiBpB;AAED;;;;;;;GAOG;AACH,iBAAS,oBAAoB,CAC3B,IAAI,EAAE,gBAAgB,EAAE,EACxB,IAAI,EAAE,gBAAgB,EACtB,QAAQ,SAAK,GACZ,MAAM,CASR;AAED;;;;;;GAMG;AACH,iBAAS,mBAAmB,CAC1B,UAAU,EAAE,gBAAgB,EAAE,EAC9B,KAAK,EAAE,MAAM,EAAE,GACd,gBAAgB,GAAG,SAAS,CAO9B;AAED;;;;;;GAMG;AACH,iBAAS,8BAA8B,CACrC,IAAI,EAAE,gBAAgB,EAAE,EACxB,UAAU,EAAE,MAAM,GACjB,UAAU,EAAE,CAkBd;AAED;;;;GAIG;AACH,iBAAS,kBAAkB,CACzB,OAAO,EAAE,uBAAuB,EAAE,GACjC,uBAAuB,GAAG,IAAI,CAEhC;AAED;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAEpD;AAED;;;;GAIG;AACH,iBAAS,OAAO,CAAC,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAInD;AAED;;;;GAIG;AACH,iBAAS,OAAO,CAAC,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAInD;AAED;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,GAAG,gBAAgB,EAAE,CAEhE;AAED;;;;GAIG;AACH,iBAAS,gBAAgB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAE5D;AAED;;;;;;GAMG;AACH,iBAAS,oBAAoB,CAC3B,UAAU,EAAE,gBAAgB,EAAE,EAC9B,UAAU,EAAE,MAAM,EAClB,MAAM,GAAE,MAAW,GAClB,UAAU,EAAE,CAWd;AAED,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;CAiB/B,CAAC"}

package/lib/getters/companyGetters.d.ts

@@ -1,7 +1,27 @@
 import { CompanyDetails } from '../types';
+/**
+ * Returns the name of the company.
+ * @param company - The company details object.
+ * @returns The company name string, or an empty string if not set.
+ */
 declare function getName(company: CompanyDetails): string;
+/**
+ * Returns the street address of the company.
+ * @param company - The company details object.
+ * @returns The street string, or an empty string if not set.
+ */
 declare function getStreet(company: CompanyDetails): string;
+/**
+ * Returns the city of the company.
+ * @param company - The company details object.
+ * @returns The city string, or an empty string if not set.
+ */
 declare function getCity(company: CompanyDetails): string;
+/**
+ * Returns the email address of the company.
+ * @param company - The company details object.
+ * @returns The email string, or an empty string if not set.
+ */
 declare function getEmail(company: CompanyDetails): string;
 export declare const companyGetters: {
     getName: typeof getName;

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

@@ -1 +1 @@
-{"version":3,"file":"companyGetters.d.ts","sourceRoot":"","sources":["../../src/getters/companyGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAE1C,iBAAS,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,MAAM,CAEhD;AAED,iBAAS,SAAS,CAAC,OAAO,EAAE,cAAc,GAAG,MAAM,CAElD;AAED,iBAAS,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,MAAM,CAEhD;AAED,iBAAS,QAAQ,CAAC,OAAO,EAAE,cAAc,GAAG,MAAM,CAEjD;AAED,eAAO,MAAM,cAAc;;;;;CAK1B,CAAC"}
+{"version":3,"file":"companyGetters.d.ts","sourceRoot":"","sources":["../../src/getters/companyGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAE1C;;;;GAIG;AACH,iBAAS,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,MAAM,CAEhD;AAED;;;;GAIG;AACH,iBAAS,SAAS,CAAC,OAAO,EAAE,cAAc,GAAG,MAAM,CAElD;AAED;;;;GAIG;AACH,iBAAS,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,MAAM,CAEhD;AAED;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,OAAO,EAAE,cAAc,GAAG,MAAM,CAEjD;AAED,eAAO,MAAM,cAAc;;;;;CAK1B,CAAC"}

package/lib/getters/cookieBarGetters.d.ts

@@ -16,13 +16,53 @@ export interface CookieGroups {
     barDescription: string;
     groups: CookieGroup[];
 }
+/**
+ * Returns the title shown in the cookie consent bar.
+ * @param CookieGroups - The cookie groups configuration object.
+ * @returns The bar title string.
+ */
 declare function getBarTitle(CookieGroups: CookieGroups): string;
+/**
+ * Returns the description text shown in the cookie consent bar.
+ * @param cookieGroups - The cookie groups configuration object.
+ * @returns The bar description string.
+ */
 declare function getBarDescription(cookieGroups: CookieGroups): string;
+/**
+ * Returns the display name of a cookie group.
+ * @param CookieGroup - The cookie group object.
+ * @returns The group name string, or an empty string if not set.
+ */
 declare function getCookieGroupName(CookieGroup: CookieGroup): string;
+/**
+ * Returns the description of a cookie group.
+ * @param CookieGroup - The cookie group object.
+ * @returns The group description string, or an empty string if not set.
+ */
 declare function getCookieGroupDescription(CookieGroup: CookieGroup): string;
+/**
+ * Returns the display name of a cookie.
+ * @param Cookie - The cookie object.
+ * @returns The cookie name string, or an empty string if not set.
+ */
 declare function getCookieName(Cookie: Cookie): string;
+/**
+ * Returns the display name of a cookie group with its cookie count appended in parentheses.
+ * @param CookieGroup - The cookie group object.
+ * @returns A string in the format `"<name> (<count>)"`.
+ */
 declare function getCookieGroupNameWithCount(CookieGroup: CookieGroup): string;
+/**
+ * Returns the list of cookies belonging to a cookie group.
+ * @param CookieGroup - The cookie group object.
+ * @returns An array of {@link Cookie} objects.
+ */
 declare function getCookiesList(CookieGroup: CookieGroup): Cookie[];
+/**
+ * Returns whether the cookie group's details are currently expanded (show more).
+ * @param CookieGroup - The cookie group object.
+ * @returns `true` if the group is expanded, otherwise `false`.
+ */
 declare function getShowMore(CookieGroup: CookieGroup): boolean;
 export declare const cookieBarGetters: {
     getBarTitle: typeof getBarTitle;

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

@@ -1 +1 @@
-{"version":3,"file":"cookieBarGetters.d.ts","sourceRoot":"","sources":["../../src/getters/cookieBarGetters.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AACD,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,WAAW,EAAE,CAAC;CACvB;AAED,iBAAS,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEvD;AAED,iBAAS,iBAAiB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE7D;AAED,iBAAS,kBAAkB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAE5D;AAED,iBAAS,yBAAyB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAEnE;AAED,iBAAS,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAE7C;AAED,iBAAS,2BAA2B,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAErE;AAED,iBAAS,cAAc,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,EAAE,CAE1D;AAED,iBAAS,WAAW,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAEtD;AAED,eAAO,MAAM,gBAAgB;;;;;;;;;CAS5B,CAAC"}
+{"version":3,"file":"cookieBarGetters.d.ts","sourceRoot":"","sources":["../../src/getters/cookieBarGetters.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AACD,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,WAAW,EAAE,CAAC;CACvB;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEvD;AAED;;;;GAIG;AACH,iBAAS,iBAAiB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE7D;AAED;;;;GAIG;AACH,iBAAS,kBAAkB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAE5D;AAED;;;;GAIG;AACH,iBAAS,yBAAyB,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAEnE;AAED;;;;GAIG;AACH,iBAAS,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAE7C;AAED;;;;GAIG;AACH,iBAAS,2BAA2B,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAErE;AAED;;;;GAIG;AACH,iBAAS,cAAc,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,EAAE,CAE1D;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAEtD;AAED,eAAO,MAAM,gBAAgB;;;;;;;;;CAS5B,CAAC"}

package/lib/getters/countryGetters.d.ts

@@ -1,11 +1,53 @@
 import { type Country, type State } from '../types';
+/**
+ * Returns the numeric ID of a country as a string.
+ * @param country - The country object.
+ * @returns The country ID string, or an empty string if not set.
+ */
 declare function getCountryId(country: Country): string;
+/**
+ * Returns the display name of a country.
+ * @param country - The country object.
+ * @returns The country name string, or an empty string if not set.
+ */
 declare function getCountryName(country: Country): string;
+/**
+ * Returns the ISO 3166-1 alpha-2 country code.
+ * @param country - The country object.
+ * @returns The two-letter ISO code string (e.g. `"DE"`), or an empty string if not set.
+ */
 declare function getCountryIsoCode(country: Country): string;
+/**
+ * Returns the list of states/regions for a country.
+ * @param country - The country object.
+ * @returns An array of {@link State} objects, or an empty array if none exist.
+ */
 declare function getStates(country: Country): State[];
+/**
+ * Returns the numeric ID of a state as a string.
+ * @param state - The state object.
+ * @returns The state ID string, or an empty string if not set.
+ */
 declare function getStateId(state: State): string;
+/**
+ * Returns the display name of a state.
+ * @param state - The state object.
+ * @returns The state name string, or an empty string if not set.
+ */
 declare function getStateName(state: State): string;
+/**
+ * Finds a country by its numeric ID in a list of countries.
+ * @param countries - The array of available countries.
+ * @param countryId - The numeric or string ID of the country to find.
+ * @returns The matching {@link Country} object, or `null` if not found or the list is empty.
+ */
 declare function getCountryById(countries: Country[], countryId: string): Country | null;
+/**
+ * Finds a state by its numeric ID within a country's state list.
+ * @param country - The country object containing the state list.
+ * @param stateId - The numeric or string ID of the state to find.
+ * @returns The matching {@link State} object, or `null` if not found or the country has no states.
+ */
 declare function getStateById(country: Country, stateId: string): State | null;
 export declare const countryGetters: {
     getStates: typeof getStates;

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

@@ -1 +1 @@
-{"version":3,"file":"countryGetters.d.ts","sourceRoot":"","sources":["../../src/getters/countryGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,UAAU,CAAC;AAEpD,iBAAS,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE9C;AAED,iBAAS,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEhD;AAED,iBAAS,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEnD;AACD,iBAAS,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,KAAK,EAAE,CAE5C;AAED,iBAAS,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAExC;AAED,iBAAS,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAE1C;AAED,iBAAS,cAAc,CACrB,SAAS,EAAE,OAAO,EAAE,EACpB,SAAS,EAAE,MAAM,GAChB,OAAO,GAAG,IAAI,CAShB;AAED,iBAAS,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI,CASrE;AAED,eAAO,MAAM,cAAc;;;;;;;;;CAS1B,CAAC"}
+{"version":3,"file":"countryGetters.d.ts","sourceRoot":"","sources":["../../src/getters/countryGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,UAAU,CAAC;AAEpD;;;;GAIG;AACH,iBAAS,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAE9C;AAED;;;;GAIG;AACH,iBAAS,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEhD;AAED;;;;GAIG;AACH,iBAAS,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEnD;AAED;;;;GAIG;AACH,iBAAS,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,KAAK,EAAE,CAE5C;AAED;;;;GAIG;AACH,iBAAS,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAExC;AAED;;;;GAIG;AACH,iBAAS,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAE1C;AAED;;;;;GAKG;AACH,iBAAS,cAAc,CACrB,SAAS,EAAE,OAAO,EAAE,EACpB,SAAS,EAAE,MAAM,GAChB,OAAO,GAAG,IAAI,CAShB;AAED;;;;;GAKG;AACH,iBAAS,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI,CASrE;AAED,eAAO,MAAM,cAAc;;;;;;;;;CAS1B,CAAC"}

package/lib/getters/facetGetters.d.ts

@@ -1,17 +1,78 @@
 import { FacetSearchResult, AgnosticPagination, AgnosticSort, AgnosticFacet } from './agnostic';
 import type { Category, Facet, FacetSearchCriteria, Product } from '../types';
 import { Filter, FilterGroup } from '../types';
+/**
+ * @deprecated Not yet implemented — always returns an empty array.
+ * @param params - The facet search result (currently unused).
+ * @param criteria - Optional search criteria (currently unused).
+ * @returns An empty array.
+ */
 declare function getAll(params: FacetSearchResult<Facet>, criteria?: FacetSearchCriteria): AgnosticFacet[];
+/**
+ * Returns the category associated with a facet search result.
+ * @param params - The facet search result.
+ * @returns The {@link Category} object from the search data.
+ */
 declare function getCategory(params: FacetSearchResult<Facet>): Category;
+/**
+ * Returns the available sort options for a facet search, with the currently selected option marked.
+ * @param params - The facet search result containing the selected sort input.
+ * @returns An {@link AgnosticSort} object with an array of sort options and the currently selected option ID.
+ */
 declare function getSortOptions(params: FacetSearchResult<Facet>): AgnosticSort;
+/**
+ * Returns the list of products from a facet search result.
+ * @param searchData - The facet search result.
+ * @returns An array of {@link Product} objects, or an empty array if none exist.
+ */
 declare function getProducts(searchData: FacetSearchResult<Facet>): Product[];
+/**
+ * Returns the display name of a filter group.
+ * @param filterGroup - The filter group object.
+ * @returns The filter group name string, or an empty string if not set.
+ */
 declare function getName(filterGroup: FilterGroup): string;
+/**
+ * Returns the type of a filter group (e.g. `"price"`, `"attribute"`, `"availability"`).
+ * @param filterGroup - The filter group object.
+ * @returns The filter group type string, or an empty string if not set.
+ */
 declare function getType(filterGroup: FilterGroup): string;
+/**
+ * Returns the individual filter values within a filter group.
+ * @param filterGroup - The filter group object.
+ * @returns An array of {@link Filter} objects, or an empty array if none exist.
+ */
 declare function getFilters(filterGroup: FilterGroup): Filter[];
+/**
+ * Returns whether the given filter group list contains at least one group.
+ * @param filterGroup - The array of filter group objects.
+ * @returns `true` if there is at least one filter group, otherwise `false`.
+ */
 declare function hasFilters(filterGroup: FilterGroup[]): boolean;
+/**
+ * Returns the CSS class associated with a filter value.
+ * @param filter - The filter object.
+ * @returns The CSS class string, or an empty string if not set.
+ */
 declare function getCssClass(filter: Filter): string;
+/**
+ * Returns the display name of a filter value.
+ * @param filter - The filter object.
+ * @returns The filter name string, or an empty string if not set.
+ */
 declare function getFilterName(filter: Filter): string;
+/**
+ * Returns the item count associated with a filter value.
+ * @param filter - The filter object.
+ * @returns The item count, or `0` if not set.
+ */
 declare function getFilterCount(filter: Filter): number;
+/**
+ * Returns the pagination data for a facet search result.
+ * @param params - The facet search result containing pagination and input data.
+ * @returns An {@link AgnosticPagination} object with current page, total pages, total items, items per page, and page options.
+ */
 declare function getPagination(params: FacetSearchResult<Facet>): AgnosticPagination;
 export declare const facetGetters: {
     getAll: typeof getAll;

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

@@ -1 +1 @@
-{"version":3,"file":"facetGetters.d.ts","sourceRoot":"","sources":["../../src/getters/facetGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,YAAY,EACZ,aAAa,EACd,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAE9E,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAE/C,iBAAS,MAAM,CAEb,MAAM,EAAE,iBAAiB,CAAC,KAAK,CAAC,EAEhC,QAAQ,CAAC,EAAE,mBAAmB,GAC7B,aAAa,EAAE,CAEjB;AAED,iBAAS,WAAW,CAAC,MAAM,EAAE,iBAAiB,CAAC,KAAK,CAAC,GAAG,QAAQ,CAE/D;AAED,iBAAS,cAAc,CAAC,MAAM,EAAE,iBAAiB,CAAC,KAAK,CAAC,GAAG,YAAY,CA2BtE;AAED,iBAAS,WAAW,CAAC,UAAU,EAAE,iBAAiB,CAAC,KAAK,CAAC,GAAG,OAAO,EAAE,CAEpE;AAED,iBAAS,OAAO,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAEjD;AAED,iBAAS,OAAO,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAEjD;AAED,iBAAS,UAAU,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,EAAE,CAEtD;AAED,iBAAS,UAAU,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,OAAO,CAEvD;AAED,iBAAS,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED,iBAAS,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAE7C;AAED,iBAAS,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAE9C;AAUD,iBAAS,aAAa,CAAC,MAAM,EAAE,iBAAiB,CAAC,KAAK,CAAC,GAAG,kBAAkB,CAa3E;AAED,eAAO,MAAM,YAAY;;;;;;;;;;;;;CAaxB,CAAC"}
+{"version":3,"file":"facetGetters.d.ts","sourceRoot":"","sources":["../../src/getters/facetGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,YAAY,EACZ,aAAa,EACd,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAE9E,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAE/C;;;;;GAKG;AACH,iBAAS,MAAM,CAEb,MAAM,EAAE,iBAAiB,CAAC,KAAK,CAAC,EAEhC,QAAQ,CAAC,EAAE,mBAAmB,GAC7B,aAAa,EAAE,CAEjB;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,MAAM,EAAE,iBAAiB,CAAC,KAAK,CAAC,GAAG,QAAQ,CAE/D;AAED;;;;GAIG;AACH,iBAAS,cAAc,CAAC,MAAM,EAAE,iBAAiB,CAAC,KAAK,CAAC,GAAG,YAAY,CA2BtE;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,UAAU,EAAE,iBAAiB,CAAC,KAAK,CAAC,GAAG,OAAO,EAAE,CAEpE;AAED;;;;GAIG;AACH,iBAAS,OAAO,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAEjD;AAED;;;;GAIG;AACH,iBAAS,OAAO,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAEjD;AAED;;;;GAIG;AACH,iBAAS,UAAU,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,EAAE,CAEtD;AAED;;;;GAIG;AACH,iBAAS,UAAU,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,OAAO,CAEvD;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED;;;;GAIG;AACH,iBAAS,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAE7C;AAED;;;;GAIG;AACH,iBAAS,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAE9C;AAgBD;;;;GAIG;AACH,iBAAS,aAAa,CAAC,MAAM,EAAE,iBAAiB,CAAC,KAAK,CAAC,GAAG,kBAAkB,CAa3E;AAED,eAAO,MAAM,YAAY;;;;;;;;;;;;;CAaxB,CAAC"}

package/lib/getters/forgotPasswordGetters.d.ts

@@ -1,5 +1,15 @@
 import type { PasswordResetResult } from '../types';
+/**
+ * @deprecated Not yet implemented — always returns an empty string.
+ * @param result - The password reset result (currently unused).
+ * @returns An empty string.
+ */
 declare function getResetPasswordToken(result: PasswordResetResult): string;
+/**
+ * @deprecated Not yet implemented — always returns `true`.
+ * @param result - The password reset result (currently unused).
+ * @returns Always `true`.
+ */
 declare function isPasswordChanged(result: PasswordResetResult): boolean;
 export declare const forgotPasswordGetters: {
     getResetPasswordToken: typeof getResetPasswordToken;

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

@@ -1 +1 @@
-{"version":3,"file":"forgotPasswordGetters.d.ts","sourceRoot":"","sources":["../../src/getters/forgotPasswordGetters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAGpD,iBAAS,qBAAqB,CAAC,MAAM,EAAE,mBAAmB,GAAG,MAAM,CAElE;AAGD,iBAAS,iBAAiB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAE/D;AAED,eAAO,MAAM,qBAAqB;;;CAGjC,CAAC"}
+{"version":3,"file":"forgotPasswordGetters.d.ts","sourceRoot":"","sources":["../../src/getters/forgotPasswordGetters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEpD;;;;GAIG;AAEH,iBAAS,qBAAqB,CAAC,MAAM,EAAE,mBAAmB,GAAG,MAAM,CAElE;AAED;;;;GAIG;AAEH,iBAAS,iBAAiB,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAE/D;AAED,eAAO,MAAM,qBAAqB;;;CAGjC,CAAC"}

package/lib/getters/heroesGetters.d.ts

@@ -5,10 +5,35 @@ export type Hero = {
     image: string;
     className: string;
 };
+/**
+ * Returns the title of a hero banner.
+ * @param banner - The hero banner object.
+ * @returns The title string, or an empty string if not set.
+ */
 declare function getTitle(banner: Hero): string;
+/**
+ * Returns the subtitle of a hero banner.
+ * @param banner - The hero banner object.
+ * @returns The subtitle string, or an empty string if not set.
+ */
 declare function getSubTitle(banner: Hero): string;
+/**
+ * Returns the background value of a hero banner (e.g. a color or image URL).
+ * @param banner - The hero banner object.
+ * @returns The background string, or an empty string if not set.
+ */
 declare function getBackground(banner: Hero): string;
+/**
+ * Returns the image URL of a hero banner.
+ * @param banner - The hero banner object.
+ * @returns The image URL string, or an empty string if not set.
+ */
 declare function getImage(banner: Hero): string;
+/**
+ * Returns the CSS class name applied to a hero banner.
+ * @param banner - The hero banner object.
+ * @returns The CSS class name string, or an empty string if not set.
+ */
 declare function getClassName(banner: Hero): string;
 export declare const heroesGetters: {
     getTitle: typeof getTitle;

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

@@ -1 +1 @@
-{"version":3,"file":"heroesGetters.d.ts","sourceRoot":"","sources":["../../src/getters/heroesGetters.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,IAAI,GAAG;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,iBAAS,QAAQ,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM,CAEtC;AAED,iBAAS,WAAW,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM,CAEzC;AAED,iBAAS,aAAa,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM,CAE3C;AAED,iBAAS,QAAQ,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM,CAEtC;AAED,iBAAS,YAAY,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM,CAE1C;AAED,eAAO,MAAM,aAAa;;;;;;CAMzB,CAAC"}
+{"version":3,"file":"heroesGetters.d.ts","sourceRoot":"","sources":["../../src/getters/heroesGetters.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,IAAI,GAAG;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM,CAEtC;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM,CAEzC;AAED;;;;GAIG;AACH,iBAAS,aAAa,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM,CAE3C;AAED;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM,CAEtC;AAED;;;;GAIG;AACH,iBAAS,YAAY,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM,CAE1C;AAED,eAAO,MAAM,aAAa;;;;;;CAMzB,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"itemSearchAutocompleteGetters.d.ts","sourceRoot":"","sources":["../../src/getters/itemSearchAutocompleteGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AAmCvD,eAAO,MAAM,6BAA6B;qBAjClB,0BAA0B,KAAG,MAAM;8BAI1B,0BAA0B,KAAG,MAAM;4BAIrC,0BAA0B,KAAG,MAAM,GAAG,IAAI;qCAIjC,0BAA0B,KAAG,MAAM;+BAIzC,0BAA0B,KAAG,OAAO;CAuBrE,CAAC"}
+{"version":3,"file":"itemSearchAutocompleteGetters.d.ts","sourceRoot":"","sources":["../../src/getters/itemSearchAutocompleteGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AA6DvD,eAAO,MAAM,6BAA6B;qBAtDlB,0BAA0B,KAAG,MAAM;8BAS1B,0BAA0B,KAAG,MAAM;4BASrC,0BAA0B,KAAG,MAAM,GAAG,IAAI;qCASjC,0BAA0B,KAAG,MAAM;+BAUzC,0BAA0B,KAAG,OAAO;CAuBrE,CAAC"}

package/lib/getters/legalGetters.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Returns the HTML content of a legal text type, falling back to the plain text if no HTML is available.
+ * @param type - An object containing `htmlText` and `plainText` properties.
+ * @returns The HTML string if non-empty, otherwise the plain text string, or an empty string if neither is set.
+ */
 declare function getHtml(type: {
     htmlText: string;
     plainText: string;

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

@@ -1 +1 @@
-{"version":3,"file":"legalGetters.d.ts","sourceRoot":"","sources":["../../src/getters/legalGetters.ts"],"names":[],"mappings":"AAAA,iBAAS,OAAO,CAAC,IAAI,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAEtE;AACD,eAAO,MAAM,YAAY;;CAExB,CAAC"}
+{"version":3,"file":"legalGetters.d.ts","sourceRoot":"","sources":["../../src/getters/legalGetters.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,iBAAS,OAAO,CAAC,IAAI,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAEtE;AACD,eAAO,MAAM,YAAY;;CAExB,CAAC"}

package/lib/getters/localesGetters.d.ts

@@ -2,7 +2,17 @@ export interface Locale {
     code: string;
     label: string;
 }
+/**
+ * Returns the BCP 47 language code of a locale.
+ * @param locale - The locale object.
+ * @returns The locale code string (e.g. `"en"`, `"de"`), defaulting to `"en"` if not set.
+ */
 declare function getCode(locale: Locale): string;
+/**
+ * Returns the human-readable label of a locale.
+ * @param locale - The locale object.
+ * @returns The locale label string (e.g. `"English"`, `"Deutsch"`), defaulting to `"en"` if not set.
+ */
 declare function getLabel(locale: Locale): string;
 export declare const localesGetters: {
     getCode: typeof getCode;

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

@@ -1 +1 @@
-{"version":3,"file":"localesGetters.d.ts","sourceRoot":"","sources":["../../src/getters/localesGetters.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,iBAAS,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEvC;AACD,iBAAS,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAExC;AAED,eAAO,MAAM,cAAc;;;CAG1B,CAAC"}
+{"version":3,"file":"localesGetters.d.ts","sourceRoot":"","sources":["../../src/getters/localesGetters.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,iBAAS,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEvC;AAED;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAExC;AAED,eAAO,MAAM,cAAc;;;CAG1B,CAAC"}