@plentymarkets/shop-api 0.168.1 → 0.170.0

package/server/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/server/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/server/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/server/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/server/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/server/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/server/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/server/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/server/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/server/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/server/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/server/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/server/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/server/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/server/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/server/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/server/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"}

package/server/getters/manufacturerGetters.d.ts

@@ -1,27 +1,147 @@
 import { Manufacturer, ProducingCountry } from '../types';
+/**
+ * Returns the logo URL of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The logo URL string, or an empty string if not set.
+ */
 declare function getManufacturerLogo(manufacturer: Manufacturer): string;
+/**
+ * Returns the internal name of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The name string, or an empty string if not set.
+ */
 declare function getManufacturerName(manufacturer: Manufacturer): string;
+/**
+ * Returns the external name of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The external name string, or an empty string if not set.
+ */
 declare function getManufacturerExternalName(manufacturer: Manufacturer): string;
+/**
+ * Returns the alternative external name of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The `nameExternal` string, or an empty string if not set.
+ */
 declare function getManufacturerNameExternal(manufacturer: Manufacturer): string;
+/**
+ * Returns the legal (registered) name of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The legal name string, or an empty string if not set.
+ */
 declare function getManufacturerLegalName(manufacturer: Manufacturer): string;
+/**
+ * Returns the contact page URL of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The contact URL string, or an empty string if not set.
+ */
 declare function getManufacturerContactUrl(manufacturer: Manufacturer): string;
+/**
+ * Returns the street address of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The street name string, or an empty string if not set.
+ */
 declare function getManufacturerStreet(manufacturer: Manufacturer): string;
+/**
+ * Returns the house number of the manufacturer's address.
+ * @param manufacturer - The manufacturer object.
+ * @returns The house number string, or an empty string if not set.
+ */
 declare function getManufacturerHouseNo(manufacturer: Manufacturer): string;
+/**
+ * Returns the postal code of the manufacturer's address.
+ * @param manufacturer - The manufacturer object.
+ * @returns The postcode string, or an empty string if not set.
+ */
 declare function getManufacturerPostCode(manufacturer: Manufacturer): string;
+/**
+ * Returns the town/city of the manufacturer's address.
+ * @param manufacturer - The manufacturer object.
+ * @returns The town string, or an empty string if not set.
+ */
 declare function getManufacturerTown(manufacturer: Manufacturer): string;
+/**
+ * Returns the producing country of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The {@link ProducingCountry} object, or an empty object cast to `ProducingCountry` if not set.
+ */
 declare function getManufacturerCountry(manufacturer: Manufacturer): ProducingCountry;
+/**
+ * Returns the email address of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The email string, or an empty string if not set.
+ */
 declare function getManufacturerEmail(manufacturer: Manufacturer): string;
+/**
+ * Returns the phone number of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The phone number string, or an empty string if not set.
+ */
 declare function getManufacturerPhoneNumber(manufacturer: Manufacturer): string;
+/**
+ * Returns the fax number of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The fax number string, or an empty string if not set.
+ */
 declare function getManufacturerFaxNumber(manufacturer: Manufacturer): string;
+/**
+ * Returns the website URL of the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The URL string, or an empty string if not set.
+ */
 declare function getManufacturerUrl(manufacturer: Manufacturer): string;
+/**
+ * Returns the name of the responsible person (EU representative) for the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The responsible person's name string, or an empty string if not set.
+ */
 declare function getManufacturerResponsibleName(manufacturer: Manufacturer): string;
+/**
+ * Returns the street address of the responsible person for the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The street string, or an empty string if not set.
+ */
 declare function getManufacturerResponsibleStreet(manufacturer: Manufacturer): string;
+/**
+ * Returns the house number of the responsible person's address for the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The house number string, or an empty string if not set.
+ */
 declare function getManufacturerResponsibleHouseNo(manufacturer: Manufacturer): string;
+/**
+ * Returns the postal code of the responsible person's address for the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The postcode string, or an empty string if not set.
+ */
 declare function getManufacturerResponsiblePostCode(manufacturer: Manufacturer): string;
+/**
+ * Returns the town/city of the responsible person's address for the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The town string, or an empty string if not set.
+ */
 declare function getManufacturerResponsibleTown(manufacturer: Manufacturer): string;
+/**
+ * Returns the country of the responsible person for the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The {@link ProducingCountry} object, or an empty object cast to `ProducingCountry` if not set.
+ */
 declare function getManufacturerResponsibleCountry(manufacturer: Manufacturer): ProducingCountry;
+/**
+ * Returns the email address of the responsible person for the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The email string, or an empty string if not set.
+ */
 declare function getManufacturerResponsibleEmail(manufacturer: Manufacturer): string;
+/**
+ * Returns the phone number of the responsible person for the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The phone number string, or an empty string if not set.
+ */
 declare function getManufacturerResponsiblePhoneNo(manufacturer: Manufacturer): string;
+/**
+ * Returns the contact URL of the responsible person for the manufacturer.
+ * @param manufacturer - The manufacturer object.
+ * @returns The contact URL string, or an empty string if not set.
+ */
 declare function getManufacturerResponsibleContactUrl(manufacturer: Manufacturer): string;
 export declare const manufacturerGetters: {
     getManufacturerLogo: typeof getManufacturerLogo;

package/server/getters/manufacturerGetters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"manufacturerGetters.d.ts","sourceRoot":"","sources":["../../src/getters/manufacturerGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE1D,iBAAS,mBAAmB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE/D;AAED,iBAAS,mBAAmB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE/D;AAED,iBAAS,2BAA2B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEvE;AAED,iBAAS,2BAA2B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEvE;AAED,iBAAS,wBAAwB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEpE;AAED,iBAAS,yBAAyB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAErE;AAED,iBAAS,qBAAqB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEjE;AAED,iBAAS,sBAAsB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAElE;AAED,iBAAS,uBAAuB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEnE;AAED,iBAAS,mBAAmB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE/D;AAED,iBAAS,sBAAsB,CAAC,YAAY,EAAE,YAAY,GAAG,gBAAgB,CAE5E;AAED,iBAAS,oBAAoB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEhE;AAED,iBAAS,0BAA0B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEtE;AAED,iBAAS,wBAAwB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEpE;AAED,iBAAS,kBAAkB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE9D;AAED,iBAAS,8BAA8B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE1E;AAED,iBAAS,gCAAgC,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE5E;AAED,iBAAS,iCAAiC,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE7E;AAED,iBAAS,kCAAkC,CACzC,YAAY,EAAE,YAAY,GACzB,MAAM,CAER;AAED,iBAAS,8BAA8B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE1E;AAED,iBAAS,iCAAiC,CACxC,YAAY,EAAE,YAAY,GACzB,gBAAgB,CAElB;AAED,iBAAS,+BAA+B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE3E;AAED,iBAAS,iCAAiC,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE7E;AAED,iBAAS,oCAAoC,CAC3C,YAAY,EAAE,YAAY,GACzB,MAAM,CAER;AAED,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;CAyB/B,CAAC"}
+{"version":3,"file":"manufacturerGetters.d.ts","sourceRoot":"","sources":["../../src/getters/manufacturerGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE1D;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE/D;AAED;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE/D;AAED;;;;GAIG;AACH,iBAAS,2BAA2B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEvE;AAED;;;;GAIG;AACH,iBAAS,2BAA2B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEvE;AAED;;;;GAIG;AACH,iBAAS,wBAAwB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEpE;AAED;;;;GAIG;AACH,iBAAS,yBAAyB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAErE;AAED;;;;GAIG;AACH,iBAAS,qBAAqB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEjE;AAED;;;;GAIG;AACH,iBAAS,sBAAsB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAElE;AAED;;;;GAIG;AACH,iBAAS,uBAAuB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEnE;AAED;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE/D;AAED;;;;GAIG;AACH,iBAAS,sBAAsB,CAAC,YAAY,EAAE,YAAY,GAAG,gBAAgB,CAE5E;AAED;;;;GAIG;AACH,iBAAS,oBAAoB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEhE;AAED;;;;GAIG;AACH,iBAAS,0BAA0B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEtE;AAED;;;;GAIG;AACH,iBAAS,wBAAwB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAEpE;AAED;;;;GAIG;AACH,iBAAS,kBAAkB,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE9D;AAED;;;;GAIG;AACH,iBAAS,8BAA8B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE1E;AAED;;;;GAIG;AACH,iBAAS,gCAAgC,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE5E;AAED;;;;GAIG;AACH,iBAAS,iCAAiC,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE7E;AAED;;;;GAIG;AACH,iBAAS,kCAAkC,CACzC,YAAY,EAAE,YAAY,GACzB,MAAM,CAER;AAED;;;;GAIG;AACH,iBAAS,8BAA8B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE1E;AAED;;;;GAIG;AACH,iBAAS,iCAAiC,CACxC,YAAY,EAAE,YAAY,GACzB,gBAAgB,CAElB;AAED;;;;GAIG;AACH,iBAAS,+BAA+B,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE3E;AAED;;;;GAIG;AACH,iBAAS,iCAAiC,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAE7E;AAED;;;;GAIG;AACH,iBAAS,oCAAoC,CAC3C,YAAY,EAAE,YAAY,GACzB,MAAM,CAER;AAED,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;CAyB/B,CAAC"}

package/server/getters/offerGetters.d.ts

@@ -1,18 +1,96 @@
 import { Offer, OrderItem, Product, type Address } from '../types';
+/**
+ * Returns the mapped shipping address from the offer, or `null` if not set.
+ * @param offer - The offer object.
+ * @returns The shipping {@link Address}, or `null` if delivery address data is not available.
+ */
 declare function getShippingAddress(offer: Offer): Address | null;
+/**
+ * Returns the mapped billing address from the offer, or `null` if not set.
+ * @param offer - The offer object.
+ * @returns The billing {@link Address}, or `null` if billing address data is not available.
+ */
 declare function getBillingAddress(offer: Offer): Address | null;
+/**
+ * Returns the display name of the payment method used in the offer.
+ * @param offer - The offer object.
+ * @returns The payment method name string.
+ */
 declare function getPaymentMethodName(offer: Offer): string;
+/**
+ * Returns the icon path/URL for the payment method used in the offer.
+ * @param offer - The offer object.
+ * @returns The payment method icon path string.
+ */
 declare function getPaymentMethodIconPath(offer: Offer): string;
+/**
+ * Returns the combined shipping method name in `"<profileName> - <providerName>"` format.
+ * @param offer - The offer object.
+ * @returns The combined shipping method name, or an empty string if either part is missing.
+ */
 declare function getShippingMethodName(offer: Offer): string;
+/**
+ * Returns the gross shipping costs for the offer.
+ * @param offer - The offer object.
+ * @returns The shipping gross amount as a number.
+ */
 declare function getShippingMethodCosts(offer: Offer): number;
+/**
+ * Returns the number of order items in the offer, excluding one reserved/administrative item.
+ * @param offer - The offer object.
+ * @returns The item count (at least `0`).
+ */
 declare function getOfferItemsCount(offer: Offer): number;
+/**
+ * Returns the original gross unit price of an offer item.
+ * @param offerItem - The offer order item.
+ * @returns The gross price as a number.
+ */
 declare function getOfferItemOriginalPrice(offerItem: OrderItem): number;
+/**
+ * Returns the display name (`name1`) of the product variation in an offer item.
+ * @param variation - The product variation object.
+ * @returns The variation name string, or an empty string if not set.
+ */
 declare function getOfferItemVariationName(variation: Product): string;
+/**
+ * Returns whether the offer is of type "offer" (type ID `7`).
+ * @param offer - The offer object.
+ * @returns `true` if the order type ID is `7`, otherwise `false`.
+ */
 declare function isTypeOffer(offer: Offer): boolean;
+/**
+ * Returns the quantity of an offer item.
+ * @param item - The offer order item.
+ * @returns The item quantity.
+ */
 declare function getOfferItemQty(item: OrderItem): number;
+/**
+ * Returns the total quantity of items in the offer (excluding the last administrative item).
+ * Returns `0` if the offer has fewer than two items.
+ * @param items - The array of offer order items.
+ * @returns The summed quantity of all items except the last one.
+ */
 declare function getItemsCountInOffer(items: OrderItem[]): number;
+/**
+ * Returns the gross line total (unit price × quantity) for an offer item.
+ * @param item - The offer order item.
+ * @returns The line total as a number.
+ */
 declare function getOfferItemOriginalPriceWithQuantity(item: OrderItem): number;
+/**
+ * Returns the email address from the offer's billing address, validated before returning.
+ * @param offer - The offer object.
+ * @returns A valid email address string, or an empty string if the email is invalid or not set.
+ */
 declare function getOfferEmail(offer: Offer): string;
+/**
+ * Returns the "valid until" date of the offer formatted as a localised date string.
+ * Uses the date with type ID `20` from the order dates.
+ * @param offer - The offer object.
+ * @param locale - The BCP 47 locale string to use for date formatting (defaults to `"en"`).
+ * @returns The formatted date string, or `null` if the valid-until date is not set.
+ */
 declare function getValidUntil(offer: Offer, locale?: string): string | null;
 export declare const offerGetters: {
     getShippingAddress: typeof getShippingAddress;

package/server/getters/offerGetters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"offerGetters.d.ts","sourceRoot":"","sources":["../../src/getters/offerGetters.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,UAAU,CAAC;AAGnE,iBAAS,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAIxD;AAED,iBAAS,iBAAiB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAIvD;AAED,iBAAS,oBAAoB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAElD;AAED,iBAAS,wBAAwB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAEtD;AAED,iBAAS,qBAAqB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAInD;AAED,iBAAS,sBAAsB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAEpD;AAED,iBAAS,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAIhD;AAED,iBAAS,yBAAyB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE/D;AAED,iBAAS,yBAAyB,CAAC,SAAS,EAAE,OAAO,GAAG,MAAM,CAE7D;AAED,iBAAS,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAE1C;AAED,iBAAS,eAAe,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAEhD;AAED,iBAAS,oBAAoB,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,MAAM,CAMxD;AAED,iBAAS,qCAAqC,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAEtE;AAED,iBAAS,aAAa,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAI3C;AAED,iBAAS,aAAa,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,GAAE,MAAa,GAAG,MAAM,GAAG,IAAI,CAQzE;AAED,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;CAgBxB,CAAC"}
+{"version":3,"file":"offerGetters.d.ts","sourceRoot":"","sources":["../../src/getters/offerGetters.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,UAAU,CAAC;AAGnE;;;;GAIG;AACH,iBAAS,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAIxD;AAED;;;;GAIG;AACH,iBAAS,iBAAiB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,GAAG,IAAI,CAIvD;AAED;;;;GAIG;AACH,iBAAS,oBAAoB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAElD;AAED;;;;GAIG;AACH,iBAAS,wBAAwB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAEtD;AAED;;;;GAIG;AACH,iBAAS,qBAAqB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAInD;AAED;;;;GAIG;AACH,iBAAS,sBAAsB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAEpD;AAED;;;;GAIG;AACH,iBAAS,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAIhD;AAED;;;;GAIG;AACH,iBAAS,yBAAyB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE/D;AAED;;;;GAIG;AACH,iBAAS,yBAAyB,CAAC,SAAS,EAAE,OAAO,GAAG,MAAM,CAE7D;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAE1C;AAED;;;;GAIG;AACH,iBAAS,eAAe,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAEhD;AAED;;;;;GAKG;AACH,iBAAS,oBAAoB,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,MAAM,CAMxD;AAED;;;;GAIG;AACH,iBAAS,qCAAqC,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAEtE;AAED;;;;GAIG;AACH,iBAAS,aAAa,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAI3C;AAED;;;;;;GAMG;AACH,iBAAS,aAAa,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,GAAE,MAAa,GAAG,MAAM,GAAG,IAAI,CAQzE;AAED,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;CAgBxB,CAAC"}

package/server/getters/orderConfirmationGetters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"orderConfirmationGetters.d.ts","sourceRoot":"","sources":["../../src/getters/orderConfirmationGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAiBlC,eAAO,MAAM,wBAAwB;wCAXM,KAAK,KAAG,OAAO;yBAO9B,KAAK,KAAG,OAAO;CAO1C,CAAC"}
+{"version":3,"file":"orderConfirmationGetters.d.ts","sourceRoot":"","sources":["../../src/getters/orderConfirmationGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAqBlC,eAAO,MAAM,wBAAwB;wCAbM,KAAK,KAAG,OAAO;yBAS9B,KAAK,KAAG,OAAO;CAO1C,CAAC"}

package/server/getters/orderDocumentGetters.d.ts

@@ -1,5 +1,15 @@
 import type { OrderDocument } from '../types';
+/**
+ * Returns the type of an order document (e.g. `"invoice"`, `"delivery_note"`).
+ * @param document - The order document object.
+ * @returns The document type string, or an empty string if not set.
+ */
 declare function getType(document: OrderDocument): string;
+/**
+ * Returns the document number with its type prefix (e.g. `"INV-12345"`).
+ * @param document - The order document object.
+ * @returns The number-with-prefix string, or an empty string if not set.
+ */
 declare function getNumberWithPrefix(document: OrderDocument): string;
 export declare const orderDocumentGetters: {
     getType: typeof getType;