@plentymarkets/shop-api 0.168.1 → 0.170.0

package/server/getters/cartGetters.d.ts

@@ -1,54 +1,304 @@
 import { AgnosticCoupon, AgnosticDiscount, AgnosticAttribute, AgnosticTotals } from './agnostic';
 import { type BasketItemOrderParam, type Cart, CartItem, PlentyAgnosticTotals, Product, ProductProperty, type TotalVat } from '../types';
 import { type ProductBundleComponent } from '../types/api/product';
+/**
+ * Returns all items in the cart.
+ * @param cart - The cart object.
+ * @returns An array of {@link CartItem} objects, or an empty array if the cart has no items.
+ */
 declare function getItems(cart: Cart): CartItem[];
+/**
+ * Returns the invoice address ID associated with the cart.
+ * @param cart - The cart object.
+ * @returns The customer invoice address ID, or `null` if not set.
+ */
 declare function getCustomerInvoiceAddressId(cart: Cart): number | null;
+/**
+ * Returns the shipping address ID associated with the cart.
+ * @param cart - The cart object.
+ * @returns The customer shipping address ID, or `null` if not set.
+ */
 declare function getCustomerShippingAddressId(cart: Cart): number | null;
+/**
+ * Returns the unit price of a cart item.
+ * @param item - The cart item.
+ * @returns The item price as a number.
+ */
 declare function getCartItemPrice(item: CartItem): number;
+/**
+ * Returns the display name of the product associated with a cart item.
+ * @param item - The cart item.
+ * @returns The product name, or an empty string if the variation is not set.
+ */
 declare function getItemName(item: CartItem): string;
+/**
+ * Returns the small-size cover image URL for the product in a cart item.
+ * @param item - The cart item.
+ * @returns The cover image preview URL, or an empty string if the variation is not set.
+ */
 declare function getItemImage(item: CartItem): string;
+/**
+ * Returns the unit price of the product in a cart item.
+ * @param item - The cart item.
+ * @returns The price as a number, or `null` if the variation is not set.
+ */
 declare function getItemPrice(item: CartItem): number | null;
+/**
+ * Returns the quantity of a cart item.
+ * @param item - The cart item.
+ * @returns The quantity, defaulting to `1` if not set.
+ */
 declare function getItemQty(item: CartItem): number;
+/**
+ * Returns the attributes of the product variation in a cart item as agnostic attribute objects.
+ * @param item - The cart item.
+ * @returns An array of {@link AgnosticAttribute} objects, or an empty array if no attributes are set.
+ */
 declare function getItemAttributes(item: CartItem): AgnosticAttribute[];
+/**
+ * @deprecated Not yet implemented — always returns an empty string.
+ * @param item - The cart item (currently unused).
+ * @returns An empty string.
+ */
 declare function getItemSku(item: CartItem): string;
+/**
+ * Returns the unique ID of the cart item.
+ * @param item - The cart item.
+ * @returns The cart item ID, or `0` if not set.
+ */
 declare function getItemId(item: CartItem): number;
+/**
+ * Returns the product variation associated with a cart item.
+ * @param item - The cart item.
+ * @returns The {@link Product} object, or `null` if not set.
+ */
 declare function getVariation(item: CartItem): Product | null;
+/**
+ * Returns the basket item order parameters (order properties) for a cart item.
+ * @param item - The cart item.
+ * @returns An array of {@link BasketItemOrderParam} objects.
+ */
 declare function getBasketItemOrderParams(item: CartItem): BasketItemOrderParam[];
+/**
+ * Returns the bundle components of the product variation in a cart item.
+ * @param item - The cart item.
+ * @returns An array of {@link ProductBundleComponent} objects, or `null` if none are set.
+ */
 declare function getVariationBundleComponents(item: CartItem): ProductBundleComponent[] | null;
+/**
+ * Returns the variation ID of a cart item.
+ * @param item - The cart item.
+ * @returns The variation ID, or `0` if not set.
+ */
 declare function getVariationId(item: CartItem): number;
+/**
+ * Returns the aggregated totals for the cart.
+ * @param cart - The cart object.
+ * @returns An {@link AgnosticTotals} object with total, subtotal, shipping, rebate, coupon discount, VATs, and the amount to be paid.
+ */
 declare function getTotals(cart: Cart): AgnosticTotals;
+/**
+ * Returns the VAT value (rate) from a cart VAT entry.
+ * @param totalVat - A cart VAT entry.
+ * @returns The VAT value, or `0` if not set.
+ */
 declare function getTotalVatValue(totalVat: TotalVat): number;
+/**
+ * Returns the VAT amount (monetary value) from a cart VAT entry.
+ * @param totalVat - A cart VAT entry.
+ * @returns The VAT amount, or `0` if not set.
+ */
 declare function getTotalVatAmount(totalVat: TotalVat): number;
+/**
+ * Returns the subtotal (item sum) from an agnostic totals object.
+ * @param total - The agnostic totals object.
+ * @returns The subtotal, or `0` if not set.
+ */
 declare function getSubTotal(total: AgnosticTotals): number;
+/**
+ * Returns the shipping amount from an agnostic totals object.
+ * @param total - The agnostic totals object.
+ * @returns The shipping amount, or `0` if not set.
+ */
 declare function getShippingAmount(total: PlentyAgnosticTotals): number;
+/**
+ * Returns the VAT amount from an agnostic totals object.
+ * @param total - The agnostic totals object.
+ * @returns The VAT amount, or `0` if not set.
+ */
 declare function getVatAmount(total: PlentyAgnosticTotals): number;
+/**
+ * Returns the net basket amount of the cart (excluding VAT).
+ * @param cart - The cart object.
+ * @returns The net basket amount, or `0` if not set.
+ */
 declare function getBasketAmountNet(cart: Cart): number;
+/**
+ * Returns the net shipping amount of the cart (excluding VAT).
+ * @param cart - The cart object.
+ * @returns The net shipping amount, or `0` if not set.
+ */
 declare function getShippingAmountNet(cart: Cart): number;
+/**
+ * Returns the net item sum of the cart (excluding VAT).
+ * @param cart - The cart object.
+ * @returns The net item sum, or `0` if not set.
+ */
 declare function getItemSumNet(cart: Cart): number;
+/**
+ * Returns the gross total from an agnostic totals object.
+ * @param total - The agnostic totals object.
+ * @returns The total, or `0` if not set.
+ */
 declare function getTotal(total: AgnosticTotals): number;
+/**
+ * Returns the coupon discount amount applied to the cart.
+ * @param cart - The cart object.
+ * @returns The coupon discount, or `0` if not set.
+ */
 declare function getCouponDiscount(cart: Cart): number;
+/**
+ * Returns the coupon code applied to the cart.
+ * @param cart - The cart object.
+ * @returns The coupon code string, or an empty string if not set.
+ */
 declare function getCouponCode(cart: Cart): string;
+/**
+ * Returns the VAT value (rate) from an agnostic totals object.
+ * @param total - The agnostic totals object.
+ * @returns The VAT value, or `0` if not set.
+ */
 declare function getVatValue(total: PlentyAgnosticTotals): number;
+/**
+ * Returns the amount yet to be paid from an agnostic totals object.
+ * @param total - The agnostic totals object.
+ * @returns The amount to be paid, or `0` if not set.
+ */
 declare function getToBePayed(total: PlentyAgnosticTotals): number;
+/**
+ * Returns the shipping price of the cart.
+ * @param cart - The cart object.
+ * @returns The shipping amount, or `0` if not set.
+ */
 declare function getShippingPrice(cart: Cart): number;
+/**
+ * Returns the shipping country ID set on the cart.
+ * @param cart - The cart object (optional).
+ * @returns The shipping country ID, or `0` if not set.
+ */
 declare function getShippingCountryId(cart?: Cart): number;
+/**
+ * Returns the shop country ID set on the cart.
+ * @param cart - The cart object (optional).
+ * @returns The shop country ID, or `0` if not set.
+ */
 declare function getShopCountryId(cart?: Cart): number;
+/**
+ * Returns the total number of distinct line items in the cart.
+ * @param cart - The cart object.
+ * @returns The number of cart items, or `0` if the cart is empty.
+ */
 declare function getTotalItems(cart: Cart): number;
+/**
+ * @deprecated Not yet implemented — always returns an empty string.
+ * @param price - The price to format (currently unused).
+ * @returns An empty string.
+ */
 declare function getFormattedPrice(price: number): string;
+/**
+ * @deprecated Not yet implemented — always returns an empty array.
+ * @param cart - The cart object (currently unused).
+ * @returns An empty array.
+ */
 declare function getCoupons(cart: Cart): AgnosticCoupon[];
+/**
+ * @deprecated Not yet implemented — always returns an empty array.
+ * @param cart - The cart object (currently unused).
+ * @returns An empty array.
+ */
 declare function getDiscounts(cart: Cart): AgnosticDiscount[];
+/**
+ * Returns the currency code used in the cart.
+ * @param cart - The cart object.
+ * @returns The ISO 4217 currency code string (e.g. `"EUR"`).
+ */
 declare function getCurrency(cart: Cart): string;
+/**
+ * Returns the URL path to the product page for a cart item.
+ * Supports the legacy Callisto URL pattern when `useCallistoPattern` is `true`.
+ * @param item - The cart item.
+ * @param useCallistoPattern - When `true`, appends the item ID using the Callisto pattern (`/a-{itemId}`); otherwise uses the Ceres pattern (`_{itemId}_{variationId}`).
+ * @returns The product URL path, or an empty string if the variation URL path is not set.
+ */
 declare function getProductPath(item: CartItem, useCallistoPattern?: boolean): string;
+/**
+ * Returns the product property with the given ID from a cart item's variation.
+ * @param item - The cart item.
+ * @param propertyId - The numeric ID of the property to look up.
+ * @returns The matching {@link ProductProperty}, or `null` if not found.
+ */
 declare function getPropertyFromCartItem(item: CartItem, propertyId: number): ProductProperty | null;
+/**
+ * Returns all basket item order parameters for the cart that have a `"plus"` surcharge type
+ * (i.e. order properties whose surcharge is shown separately, without VAT).
+ * @param cart - The cart object.
+ * @returns An array of {@link BasketItemOrderParam} objects with aggregated prices.
+ */
 declare function getOrderPropertiesWithoutVat(cart: Cart): BasketItemOrderParam[];
+/**
+ * Returns all basket item order parameters for the cart that are marked as additional costs
+ * and have a `"incl"` surcharge type (i.e. their surcharge includes VAT).
+ * @param cart - The cart object.
+ * @returns An array of {@link BasketItemOrderParam} objects with aggregated prices.
+ */
 declare function getOrderPropertiesAdditionalCostsWithVat(cart: Cart): BasketItemOrderParam[];
+/**
+ * Returns the display name of a basket item order parameter.
+ * @param item - The basket item order parameter.
+ * @returns The name string.
+ */
 declare function getBasketItemOrderParamName(item: BasketItemOrderParam): string;
+/**
+ * Returns the price of a basket item order parameter.
+ * @param item - The basket item order parameter.
+ * @returns The price as a number.
+ */
 declare function getBasketItemOrderParamPrice(item: BasketItemOrderParam): number;
+/**
+ * Returns the value of a basket item order parameter.
+ * @param item - The basket item order parameter.
+ * @returns The value string.
+ */
 declare function getBasketItemOrderParamValue(item: BasketItemOrderParam): string;
+/**
+ * Returns the type of a basket item order parameter (e.g. `"text"`, `"file"`, `"selection"`).
+ * @param item - The basket item order parameter.
+ * @returns The type string.
+ */
 declare function getBasketItemOrderParamType(item: BasketItemOrderParam): string;
+/**
+ * Returns the cart item ID that the basket item order parameter belongs to.
+ * @param item - The basket item order parameter.
+ * @returns The basket item ID as a number.
+ */
 declare function getBasketItemOrderParamBasketItemId(item: BasketItemOrderParam): number;
+/**
+ * Returns the property ID of a basket item order parameter.
+ * @param item - The basket item order parameter.
+ * @returns The property ID string.
+ */
 declare function getBasketItemOrderParamPropertyId(item: BasketItemOrderParam): string;
+/**
+ * Returns the coupon campaign type applied to the cart.
+ * @param cart - The cart object.
+ * @returns The coupon campaign type string, or an empty string if not set.
+ */
 declare function getCouponCampaignType(cart: Cart): string;
+/**
+ * Returns the outstanding open amount for the cart.
+ * @param cart - The cart object.
+ * @returns The open amount, or `null` if not set.
+ */
 declare function getOpenAmount(cart: Cart): number | null;
 export declare const cartGetters: {
     getCustomerInvoiceAddressId: typeof getCustomerInvoiceAddressId;

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

@@ -1 +1 @@
-{"version":3,"file":"cartGetters.d.ts","sourceRoot":"","sources":["../../src/getters/cartGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EACf,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,IAAI,EACT,QAAQ,EACR,oBAAoB,EACpB,OAAO,EACP,eAAe,EACf,KAAK,QAAQ,EACd,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAEnE,iBAAS,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,QAAQ,EAAE,CAExC;AAED,iBAAS,2BAA2B,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAE9D;AAED,iBAAS,4BAA4B,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAE/D;AAED,iBAAS,gBAAgB,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAEhD;AAED,iBAAS,WAAW,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAE3C;AAED,iBAAS,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAI5C;AAED,iBAAS,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,IAAI,CAEnD;AAED,iBAAS,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAE1C;AAED,iBAAS,iBAAiB,CAAC,IAAI,EAAE,QAAQ,GAAG,iBAAiB,EAAE,CAS9D;AAGD,iBAAS,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAE1C;AAED,iBAAS,SAAS,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAEzC;AAED,iBAAS,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,GAAG,IAAI,CAEpD;AAED,iBAAS,wBAAwB,CAAC,IAAI,EAAE,QAAQ,GAAG,oBAAoB,EAAE,CAExE;AAED,iBAAS,4BAA4B,CACnC,IAAI,EAAE,QAAQ,GACb,sBAAsB,EAAE,GAAG,IAAI,CAEjC;AAED,iBAAS,cAAc,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAE9C;AAED,iBAAS,SAAS,CAAC,IAAI,EAAE,IAAI,GAAG,cAAc,CAW7C;AAED,iBAAS,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAEpD;AAED,iBAAS,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAErD;AAED,iBAAS,WAAW,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM,CAElD;AAED,iBAAS,iBAAiB,CAAC,KAAK,EAAE,oBAAoB,GAAG,MAAM,CAE9D;AAED,iBAAS,YAAY,CAAC,KAAK,EAAE,oBAAoB,GAAG,MAAM,CAEzD;AAED,iBAAS,kBAAkB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAE9C;AAED,iBAAS,oBAAoB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEhD;AAED,iBAAS,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEzC;AAED,iBAAS,QAAQ,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM,CAE/C;AAED,iBAAS,iBAAiB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAE7C;AAED,iBAAS,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEzC;AAED,iBAAS,WAAW,CAAC,KAAK,EAAE,oBAAoB,GAAG,MAAM,CAExD;AAED,iBAAS,YAAY,CAAC,KAAK,EAAE,oBAAoB,GAAG,MAAM,CAEzD;AAED,iBAAS,gBAAgB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAE5C;AAED,iBAAS,oBAAoB,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,MAAM,CAEjD;AAED,iBAAS,gBAAgB,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,MAAM,CAE7C;AAED,iBAAS,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEzC;AAGD,iBAAS,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEhD;AAGD,iBAAS,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,cAAc,EAAE,CAEhD;AAGD,iBAAS,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,gBAAgB,EAAE,CAEpD;AAED,iBAAS,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEvC;AAED,iBAAS,cAAc,CAAC,IAAI,EAAE,QAAQ,EAAE,kBAAkB,UAAQ,GAAG,MAAM,CAS1E;AAED,iBAAS,uBAAuB,CAC9B,IAAI,EAAE,QAAQ,EACd,UAAU,EAAE,MAAM,GACjB,eAAe,GAAG,IAAI,CAMxB;AAuBD,iBAAS,4BAA4B,CAAC,IAAI,EAAE,IAAI,GAAG,oBAAoB,EAAE,CAkBxE;AAED,iBAAS,wCAAwC,CAC/C,IAAI,EAAE,IAAI,GACT,oBAAoB,EAAE,CAmBxB;AAED,iBAAS,2BAA2B,CAAC,IAAI,EAAE,oBAAoB,GAAG,MAAM,CAEvE;AAED,iBAAS,4BAA4B,CAAC,IAAI,EAAE,oBAAoB,GAAG,MAAM,CAExE;AAED,iBAAS,4BAA4B,CAAC,IAAI,EAAE,oBAAoB,GAAG,MAAM,CAExE;AAED,iBAAS,2BAA2B,CAAC,IAAI,EAAE,oBAAoB,GAAG,MAAM,CAEvE;AAED,iBAAS,mCAAmC,CAC1C,IAAI,EAAE,oBAAoB,GACzB,MAAM,CAER;AAED,iBAAS,iCAAiC,CAAC,IAAI,EAAE,oBAAoB,GAAG,MAAM,CAE7E;AAED,iBAAS,qBAAqB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEjD;AAED,iBAAS,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAEhD;AAWD,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+BARhB,IAAI,oBACQ,MAAM,KACvB,MAAM,GAAG,IAAI;;;CAyDf,CAAC"}
+{"version":3,"file":"cartGetters.d.ts","sourceRoot":"","sources":["../../src/getters/cartGetters.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,cAAc,EACf,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,IAAI,EACT,QAAQ,EACR,oBAAoB,EACpB,OAAO,EACP,eAAe,EACf,KAAK,QAAQ,EACd,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAEnE;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,QAAQ,EAAE,CAExC;AAED;;;;GAIG;AACH,iBAAS,2BAA2B,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAE9D;AAED;;;;GAIG;AACH,iBAAS,4BAA4B,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAE/D;AAED;;;;GAIG;AACH,iBAAS,gBAAgB,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAEhD;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAE3C;AAED;;;;GAIG;AACH,iBAAS,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAI5C;AAED;;;;GAIG;AACH,iBAAS,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,IAAI,CAEnD;AAED;;;;GAIG;AACH,iBAAS,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAE1C;AAED;;;;GAIG;AACH,iBAAS,iBAAiB,CAAC,IAAI,EAAE,QAAQ,GAAG,iBAAiB,EAAE,CAS9D;AAED;;;;GAIG;AAEH,iBAAS,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAE1C;AAED;;;;GAIG;AACH,iBAAS,SAAS,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAEzC;AAED;;;;GAIG;AACH,iBAAS,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,GAAG,IAAI,CAEpD;AAED;;;;GAIG;AACH,iBAAS,wBAAwB,CAAC,IAAI,EAAE,QAAQ,GAAG,oBAAoB,EAAE,CAExE;AAED;;;;GAIG;AACH,iBAAS,4BAA4B,CACnC,IAAI,EAAE,QAAQ,GACb,sBAAsB,EAAE,GAAG,IAAI,CAEjC;AAED;;;;GAIG;AACH,iBAAS,cAAc,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAE9C;AAED;;;;GAIG;AACH,iBAAS,SAAS,CAAC,IAAI,EAAE,IAAI,GAAG,cAAc,CAW7C;AAED;;;;GAIG;AACH,iBAAS,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAEpD;AAED;;;;GAIG;AACH,iBAAS,iBAAiB,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAErD;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM,CAElD;AAED;;;;GAIG;AACH,iBAAS,iBAAiB,CAAC,KAAK,EAAE,oBAAoB,GAAG,MAAM,CAE9D;AAED;;;;GAIG;AACH,iBAAS,YAAY,CAAC,KAAK,EAAE,oBAAoB,GAAG,MAAM,CAEzD;AAED;;;;GAIG;AACH,iBAAS,kBAAkB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAE9C;AAED;;;;GAIG;AACH,iBAAS,oBAAoB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEhD;AAED;;;;GAIG;AACH,iBAAS,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEzC;AAED;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM,CAE/C;AAED;;;;GAIG;AACH,iBAAS,iBAAiB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAE7C;AAED;;;;GAIG;AACH,iBAAS,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEzC;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,KAAK,EAAE,oBAAoB,GAAG,MAAM,CAExD;AAED;;;;GAIG;AACH,iBAAS,YAAY,CAAC,KAAK,EAAE,oBAAoB,GAAG,MAAM,CAEzD;AAED;;;;GAIG;AACH,iBAAS,gBAAgB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAE5C;AAED;;;;GAIG;AACH,iBAAS,oBAAoB,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,MAAM,CAEjD;AAED;;;;GAIG;AACH,iBAAS,gBAAgB,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,MAAM,CAE7C;AAED;;;;GAIG;AACH,iBAAS,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEzC;AAED;;;;GAIG;AAEH,iBAAS,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED;;;;GAIG;AAEH,iBAAS,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,cAAc,EAAE,CAEhD;AAED;;;;GAIG;AAEH,iBAAS,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,gBAAgB,EAAE,CAEpD;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEvC;AAED;;;;;;GAMG;AACH,iBAAS,cAAc,CAAC,IAAI,EAAE,QAAQ,EAAE,kBAAkB,UAAQ,GAAG,MAAM,CAS1E;AAED;;;;;GAKG;AACH,iBAAS,uBAAuB,CAC9B,IAAI,EAAE,QAAQ,EACd,UAAU,EAAE,MAAM,GACjB,eAAe,GAAG,IAAI,CAMxB;AA+BD;;;;;GAKG;AACH,iBAAS,4BAA4B,CAAC,IAAI,EAAE,IAAI,GAAG,oBAAoB,EAAE,CAkBxE;AAED;;;;;GAKG;AACH,iBAAS,wCAAwC,CAC/C,IAAI,EAAE,IAAI,GACT,oBAAoB,EAAE,CAmBxB;AAED;;;;GAIG;AACH,iBAAS,2BAA2B,CAAC,IAAI,EAAE,oBAAoB,GAAG,MAAM,CAEvE;AAED;;;;GAIG;AACH,iBAAS,4BAA4B,CAAC,IAAI,EAAE,oBAAoB,GAAG,MAAM,CAExE;AAED;;;;GAIG;AACH,iBAAS,4BAA4B,CAAC,IAAI,EAAE,oBAAoB,GAAG,MAAM,CAExE;AAED;;;;GAIG;AACH,iBAAS,2BAA2B,CAAC,IAAI,EAAE,oBAAoB,GAAG,MAAM,CAEvE;AAED;;;;GAIG;AACH,iBAAS,mCAAmC,CAC1C,IAAI,EAAE,oBAAoB,GACzB,MAAM,CAER;AAED;;;;GAIG;AACH,iBAAS,iCAAiC,CAAC,IAAI,EAAE,oBAAoB,GAAG,MAAM,CAE7E;AAED;;;;GAIG;AACH,iBAAS,qBAAqB,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAEjD;AAED;;;;GAIG;AACH,iBAAS,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAEhD;AAiBD,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+BARhB,IAAI,oBACQ,MAAM,KACvB,MAAM,GAAG,IAAI;;;CAyDf,CAAC"}

package/server/getters/categoryEntryGetters.d.ts

@@ -1,18 +1,93 @@
 import type { CategoryDetails, CategoryEntry, client, ItemCount } from '../types';
+/**
+ * Returns the number of child categories for a category entry.
+ * @param categoryEntry - The category entry object.
+ * @returns The child count, or `0` if not set.
+ */
 declare function getChildCount(categoryEntry: CategoryEntry): number;
+/**
+ * Returns the child category entries of a category entry.
+ * @param categoryEntry - The category entry object.
+ * @returns An array of child {@link CategoryEntry} objects, or an empty array if none exist.
+ */
 declare function getChildren(categoryEntry: CategoryEntry): CategoryEntry[];
+/**
+ * Returns the list of webstore clients associated with a category entry.
+ * @param categoryEntry - The category entry object.
+ * @returns An array of {@link client} objects, or an empty array if none exist.
+ */
 declare function getClients(categoryEntry: CategoryEntry): client[];
+/**
+ * Returns the localised details of a category entry.
+ * @param categoryEntry - The category entry object.
+ * @returns An array of {@link CategoryDetails} objects, or an empty array if none exist.
+ */
 declare function getDetails(categoryEntry: CategoryEntry): CategoryDetails[];
+/**
+ * Returns the numeric ID of a category entry.
+ * @param categoryEntry - The category entry object.
+ * @returns The category ID, or `0` if not set.
+ */
 declare function getId(categoryEntry: CategoryEntry): number;
+/**
+ * Returns the item count entries for a category entry.
+ * @param categoryEntry - The category entry object.
+ * @returns An array of {@link ItemCount} objects, or an empty array if not set.
+ */
 declare function getItemCount(categoryEntry: CategoryEntry): ItemCount[];
+/**
+ * Returns the nesting level of a category entry in the category tree.
+ * @param categoryEntry - The category entry object.
+ * @returns The level number, or `0` if not set.
+ */
 declare function getLevel(categoryEntry: CategoryEntry): number;
+/**
+ * Returns whether the category is displayed as a link list in the frontend.
+ * @param categoryEntry - The category entry object.
+ * @returns The linklist flag string (e.g. `"Y"` or `"N"`), or an empty string if not set.
+ */
 declare function getLinklist(categoryEntry: CategoryEntry): string;
+/**
+ * Returns the ID of the parent category for a category entry.
+ * @param categoryEntry - The category entry object.
+ * @returns The parent category ID, or `0` if the category is a root category.
+ */
 declare function getParentCategoryId(categoryEntry: CategoryEntry): number;
+/**
+ * Returns the access right of a category entry (e.g. `"all"`, `"customer"`).
+ * @param categoryEntry - The category entry object.
+ * @returns The right string, or an empty string if not set.
+ */
 declare function getRight(categoryEntry: CategoryEntry): string;
+/**
+ * Returns the sitemap inclusion setting for a category entry.
+ * @param categoryEntry - The category entry object.
+ * @returns The sitemap flag string, or an empty string if not set.
+ */
 declare function getSitemap(categoryEntry: CategoryEntry): string;
+/**
+ * Returns the type of a category entry (e.g. `"item"`, `"container"`, `"content"`).
+ * @param categoryEntry - The category entry object.
+ * @returns The category type string, or an empty string if not set.
+ */
 declare function getType(categoryEntry: CategoryEntry): string;
+/**
+ * Returns the robots meta tag setting for a category entry.
+ * @param categoryEntry - The category entry object.
+ * @returns The robots string (e.g. `"ALL"`, `"NOINDEX"`), or an empty string if not set.
+ */
 declare function getRobots(categoryEntry: CategoryEntry): string;
+/**
+ * Returns whether the category entry is linked to the active webstore.
+ * @param categoryEntry - The category entry object.
+ * @returns `true` if linked to the webstore, otherwise `false`.
+ */
 declare function isLinkedToWebstore(categoryEntry: CategoryEntry): boolean;
+/**
+ * Returns whether the category entry has child categories.
+ * @param categoryEntry - The category entry object.
+ * @returns `true` if the category has children, otherwise `false`.
+ */
 declare function hasChildren(categoryEntry: CategoryEntry): boolean;
 export declare const categoryEntryGetters: {
     getChildCount: typeof getChildCount;

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

@@ -1 +1 @@
-{"version":3,"file":"categoryEntryGetters.d.ts","sourceRoot":"","sources":["../../src/getters/categoryEntryGetters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,aAAa,EACb,MAAM,EACN,SAAS,EACV,MAAM,UAAU,CAAC;AAElB,iBAAS,aAAa,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAE3D;AAED,iBAAS,WAAW,CAAC,aAAa,EAAE,aAAa,GAAG,aAAa,EAAE,CAElE;AAED,iBAAS,UAAU,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,EAAE,CAE1D;AAED,iBAAS,UAAU,CAAC,aAAa,EAAE,aAAa,GAAG,eAAe,EAAE,CAEnE;AAED,iBAAS,KAAK,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAEnD;AAED,iBAAS,YAAY,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,EAAE,CAE/D;AAED,iBAAS,QAAQ,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAEtD;AAED,iBAAS,WAAW,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAEzD;AAED,iBAAS,mBAAmB,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAEjE;AAED,iBAAS,QAAQ,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAEtD;AAED,iBAAS,UAAU,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAExD;AAED,iBAAS,OAAO,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAErD;AAED,iBAAS,SAAS,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAEvD;AAED,iBAAS,kBAAkB,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAEjE;AAED,iBAAS,WAAW,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAE1D;AAED,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;CAgBhC,CAAC"}
+{"version":3,"file":"categoryEntryGetters.d.ts","sourceRoot":"","sources":["../../src/getters/categoryEntryGetters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,aAAa,EACb,MAAM,EACN,SAAS,EACV,MAAM,UAAU,CAAC;AAElB;;;;GAIG;AACH,iBAAS,aAAa,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAE3D;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,aAAa,EAAE,aAAa,GAAG,aAAa,EAAE,CAElE;AAED;;;;GAIG;AACH,iBAAS,UAAU,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,EAAE,CAE1D;AAED;;;;GAIG;AACH,iBAAS,UAAU,CAAC,aAAa,EAAE,aAAa,GAAG,eAAe,EAAE,CAEnE;AAED;;;;GAIG;AACH,iBAAS,KAAK,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAEnD;AAED;;;;GAIG;AACH,iBAAS,YAAY,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,EAAE,CAE/D;AAED;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAEtD;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAEzD;AAED;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAEjE;AAED;;;;GAIG;AACH,iBAAS,QAAQ,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAEtD;AAED;;;;GAIG;AACH,iBAAS,UAAU,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAExD;AAED;;;;GAIG;AACH,iBAAS,OAAO,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAErD;AAED;;;;GAIG;AACH,iBAAS,SAAS,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAEvD;AAED;;;;GAIG;AACH,iBAAS,kBAAkB,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAEjE;AAED;;;;GAIG;AACH,iBAAS,WAAW,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAE1D;AAED,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;CAgBhC,CAAC"}

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