@propeller-commerce/propeller-v2-vue-ui 0.3.14

package/dist/components/AddToCart.vue.d.ts

@@ -0,0 +1,122 @@
+import { Component } from 'vue';
+import { CartChildItemInput, GraphQLClient, Product, Cart, Contact, Customer, TransformationsInput, MediaImageProductSearchInput, CartMainItem, Cluster } from '@propeller-commerce/propeller-sdk-v2';
+export interface AddToCartProps {
+    /** GraphQL client for the Propeller SDK */
+    graphqlClient: GraphQLClient;
+    /** The authenticated user (Contact or Customer) */
+    user: Contact | Customer | null;
+    /** The product to be added to cart */
+    product: Product;
+    /** Currency symbol to display. Defaults to '€'. */
+    currency?: string;
+    /** Cart ID — required when onAddToCart is not provided */
+    cartId?: string;
+    /** The cluster to be added to cart */
+    cluster?: Cluster;
+    /** IDs of the cluster child items, e.g. cluster options */
+    childItems?: number[];
+    /** Called before adding to cart. Return false to abort (e.g. failed validation). */
+    beforeAddToCart?: () => boolean;
+    /** Notes for the cart item */
+    notes?: string;
+    /** Custom price for the product (overrides calculated price) */
+    price?: number;
+    /** Label overrides for UI strings
+     *
+     * available labels:
+     * - outOfStock
+     * - noCartId
+     * - errorAdding
+     * - addedToCart
+     * - modalTitle
+     * - quantity
+     * - continueShopping
+     * - proceedToCheckout
+     * - requestQuoteButton
+     * - add
+     * - adding
+     */
+    labels?: Record<string, string>;
+    /**
+     * If true a new cart is created if no cart ID is provided.
+     * Defaults to false.
+     */
+    createCart?: boolean;
+    /**
+     * Callback to handle a new cart being created.
+     * WARNING: If not provided the component create new carts on every add-to-cart.
+     */
+    onCartCreated?: (cart: Cart) => void;
+    /**
+     * Callback to handle adding the product to cart.
+     * If not provided the component calls CartService.addItemToCart internally.
+     */
+    onAddToCart?: (product: Product, clusterId?: number, quantity?: number, childItems?: CartChildItemInput[], notes?: string, price?: number, showModal?: boolean) => Cart;
+    /**
+     * Callback triggered after adding the product to cart.
+     */
+    afterAddToCart?: (cart: Cart, item?: CartMainItem) => void;
+    /**
+     * When true a modal popup is shown after a successful add-to-cart
+     * with buttons to continue shopping or proceed to checkout.
+     * Defaults to false (only a brief inline success message is shown).
+     */
+    showModal?: boolean;
+    /**
+     * Renders − and + buttons beside the quantity input.
+     * Defaults to true.
+     */
+    allowIncrDecr?: boolean;
+    /**
+     * Validates available stock via InventoryService before adding.
+     * Defaults to false.
+     */
+    enableStockValidation?: boolean;
+    /** Language code passed to CartService operations. Defaults to 'en'. */
+    language?: string;
+    /** Additional CSS class for the root element */
+    className?: string;
+    /** Callback fired when the "Proceed to checkout" modal button is clicked */
+    onProceedToCheckout?: () => void;
+    /** Callback fired when the "Request a Quote" modal button is clicked */
+    onRequestQuoteClick?: (cart: Cart) => void;
+    /** Configuration object passed to the component */
+    configuration?: {
+        language?: string;
+        imageSearchFiltersGrid?: MediaImageProductSearchInput;
+        imageVariantFiltersSmall?: TransformationsInput;
+        urls?: {
+            getProductUrl: (product: Product, language?: string) => string;
+        };
+    };
+    /** Active company ID from the company switcher. Overrides user's default company for cart creation and lookup. */
+    companyId?: number;
+    /**
+     * When true, tax-inclusive price (net) is shown.
+     * When false, tax-exclusive price (gross) is shown.
+     * Defaults to false.
+     */
+    includeTax?: boolean;
+    priceComponent?: Component;
+    stockComponent?: Component;
+}
+/**
+ * Cart query variables interface Variables for the cart query
+ */
+/**
+ * Cart query variables interface Variables for the cart query
+ */
+export interface CartQueryVariables {
+    /** Cart ID to fetch */
+    cartId: string;
+    /** Language for localized content */
+    language: string;
+    /** Image search filters */
+    imageSearchFilters: MediaImageProductSearchInput;
+    /** Image transformation filters */
+    imageVariantFilters: TransformationsInput;
+}
+declare const _default: import('vue').DefineComponent<AddToCartProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<AddToCartProps> & Readonly<{}>, {
+    allowIncrDecr: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/components/AddToFavorite.vue.d.ts

@@ -0,0 +1,19 @@
+import { GraphQLClient, Contact, Customer } from '@propeller-commerce/propeller-sdk-v2';
+export interface AddToFavoriteProps {
+    /** The initialized GraphQL Client instance */
+    graphqlClient: GraphQLClient;
+    /** The authenticated user */
+    user: Contact | Customer | null;
+    /** Product ID to add/remove from favorites (for products) */
+    productId?: number;
+    /** Cluster ID to add/remove from favorites (for clusters) */
+    clusterId?: number;
+    /** Extra CSS class applied to the root button */
+    className?: string;
+    /** UI string overrides */
+    labels?: Record<string, string>;
+    /** Called after a favorite list mutation (add/remove) succeeds */
+    onFavoriteChanged?: () => void;
+}
+declare const _default: import('vue').DefineComponent<AddToFavoriteProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<AddToFavoriteProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/AddressCard.vue.d.ts

@@ -0,0 +1,169 @@
+import { Address, CartAddress, Gender, GraphQLClient, OrderAddress, WarehouseAddress, YesNo } from '@propeller-commerce/propeller-sdk-v2';
+export interface AddressCardProps {
+    /** GraphQL client for the Propeller SDK (only needed when editing) */
+    graphqlClient?: GraphQLClient;
+    /** The address to display (Address | CartAddress | WarehouseAddress | OrderAddress) */
+    address: Address | CartAddress | WarehouseAddress | OrderAddress | null;
+    /** Display company name @default true */
+    showCompanyName?: boolean;
+    /** Display salutation (Mr./Mrs.) @default true */
+    showSalutation?: boolean;
+    /** Display full name @default true */
+    showFullName?: boolean;
+    /** Display street @default true */
+    showStreet?: boolean;
+    /** Display house number and extension @default true */
+    showNumberExtension?: boolean;
+    /** Display postal code @default true */
+    showPostalCode?: boolean;
+    /** Display city @default true */
+    showCity?: boolean;
+    /** Display country name @default true */
+    showCountry?: boolean;
+    /** Display email @default false */
+    showEmail?: boolean;
+    /** Display phone @default false */
+    showPhone?: boolean;
+    /** Display action buttons (edit, delete, set default) @default true */
+    enableActions?: boolean;
+    /** Display Edit button @default true */
+    enableEdit?: boolean;
+    /** Display Delete button @default true */
+    enableDelete?: boolean;
+    /** Display Set Default button @default true */
+    enableSetDefault?: boolean;
+    /** Display the "Default ... Address" badge @default false */
+    showDefaultBadge?: boolean;
+    /** Called when address is edited; receives the updated address object */
+    onEdit?: (address: Address) => void | Promise<void>;
+    /** Called after address edit completes */
+    afterEdit?: (address: Address) => void | Promise<void>;
+    /** Called when address is deleted; receives the address ID */
+    onDelete?: (addressId: Address) => void;
+    /** Called after address deletion completes */
+    afterDelete?: (addressId: Address) => void;
+    /** Called when address is set as default */
+    onSetDefault?: (address: Address) => void;
+    /** Called after address is set as default */
+    afterSetDefault?: (address: Address) => void;
+    /** List of countries for the country dropdown [{code: 'NL', name: 'Netherlands'}, ...] */
+    countries?: {
+        code: string;
+        name: string;
+    }[];
+    /** When true, renders in "new address" mode: auto-opens the edit form, hides the card body */
+    isNew?: boolean;
+    /** Called when the form is cancelled in new mode */
+    onCancel?: () => void;
+    /** When true, renders the form inline instead of in a modal overlay. @default false */
+    inline?: boolean;
+    /** Address type for new addresses (e.g., 'DELIVERY', 'INVOICE'). Used when creating, not editing. */
+    addressType?: string;
+    /** Show ICP/ICS (intra-community supply) checkbox. @default false */
+    showIcp?: boolean;
+    /** Title for the form or section */
+    title?: string;
+    /** Labels for form fields and buttons */
+    labels?: Record<string, string>;
+    /** Called before save starts */
+    beforeSave?: () => void;
+}
+interface AddressCardState {
+    showEditModal: boolean;
+    showDeleteConfirm: boolean;
+    localAddress: any;
+    editCompany: string;
+    editGender: Gender;
+    editFirstName: string;
+    editMiddleName: string;
+    editLastName: string;
+    editStreet: string;
+    editNumber: string;
+    editNumberExtension: string;
+    editPostalCode: string;
+    editCity: string;
+    editCountry: string;
+    editEmail: string;
+    editPhone: string;
+    editNotes: string;
+    editIcp: YesNo;
+    saving: boolean;
+    getLabel: (key: string, fallback: string) => string;
+    getCountryName: (code: string) => string;
+    addr: any;
+    showCard: boolean;
+    formTitle: string;
+    openEditModal: () => void;
+    handleSaveEdit: (e: any) => Promise<void>;
+    confirmDelete: () => void;
+    handleSetDefault: () => void;
+    closeEditModal: () => void;
+}
+declare function openEditModal(): ReturnType<AddressCardState["openEditModal"]>;
+declare function handleSetDefault(): ReturnType<AddressCardState["handleSetDefault"]>;
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        typeBadge?(_: {
+            address: any;
+            addressType: string;
+            addressTypeLabel: string;
+        }): any;
+        name?(_: {
+            address: any;
+            fullName: string;
+            salutation: any;
+        }): any;
+        addressLines?(_: {
+            address: any;
+            streetLine: string;
+            cityLine: string;
+        }): any;
+        country?(_: {
+            address: any;
+            countryName: string;
+        }): any;
+        defaultBadge?(_: {
+            address: any;
+            isDefault: boolean;
+            addressType: any;
+        }): any;
+        actions?(_: {
+            address: any;
+            onEdit: typeof openEditModal;
+            onDelete: () => void;
+            onSetDefault: typeof handleSetDefault;
+            saving: boolean;
+        }): any;
+    };
+    refs: {};
+    rootEl: HTMLDivElement;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<AddressCardProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<AddressCardProps> & Readonly<{}>, {
+    showCompanyName: boolean;
+    showSalutation: boolean;
+    showFullName: boolean;
+    showStreet: boolean;
+    showNumberExtension: boolean;
+    showPostalCode: boolean;
+    showCity: boolean;
+    showCountry: boolean;
+    showEmail: boolean;
+    showPhone: boolean;
+    enableActions: boolean;
+    enableEdit: boolean;
+    enableDelete: boolean;
+    enableSetDefault: boolean;
+    showDefaultBadge: boolean;
+    isNew: boolean;
+    inline: boolean;
+    showIcp: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/AddressSelector.vue.d.ts

@@ -0,0 +1,30 @@
+import { Component } from 'vue';
+import { Address, Contact, Customer } from '@propeller-commerce/propeller-sdk-v2';
+export interface AddressSelectorProps {
+    /** Authenticated user — addresses are derived from their profile. */
+    user: Contact | Customer | null;
+    /**
+     * Active company ID (for Contact users).
+     * Pass the value from the company switcher so the correct company's addresses are listed.
+     */
+    companyId?: number;
+    /**
+     * Filter addresses to this type.
+     * Defaults to AddressType.delivery.
+     */
+    addressType?: string;
+    /** Called when the user picks an address from the modal. Supports async. */
+    onAddressSelected?: (address: Address) => void | Promise<void>;
+    /** Country list forwarded to AddressCard [{code: 'NL', name: 'Netherlands'}, ...] */
+    countries?: {
+        code: string;
+        name: string;
+    }[];
+    /** Label overrides. Keys: chooseAddress, modalTitle, noAddresses */
+    labels?: Record<string, string>;
+    /** Extra CSS class on the root element. */
+    className?: string;
+    addressCardComponent?: Component;
+}
+declare const _default: import('vue').DefineComponent<AddressSelectorProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<AddressSelectorProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/components/Breadcrumbs.vue.d.ts

@@ -0,0 +1,69 @@
+import { Category } from '@propeller-commerce/propeller-sdk-v2';
+export interface BreadcrumbsProps {
+    /**
+     * The category path from the category, product or cluster response.
+     * Obtain from `category.categoryPath` or `product.category.categoryPath`.
+     */
+    categoryPath: Category[];
+    /**
+     * When true (default), the last item in the path is displayed as the
+     * current page (non-clickable, aria-current="page").
+     * When false, the last item is omitted.
+     * Ignored when `currentLabel` is provided — the extra crumb becomes
+     * the current page instead.
+     */
+    showCurrent?: boolean;
+    /**
+     * The category of the current page. When provided and not already
+     * the last item in `categoryPath`, it is appended automatically so
+     * the trail always ends at the current category. This makes the
+     * component correct whether the API's categoryPath includes the
+     * current category or only its ancestors.
+     */
+    currentCategory?: Category;
+    /**
+     * Optional trailing crumb appended after the category path — typically
+     * the name of the current product or cluster on a detail page.
+     * When provided, this crumb is marked as the current page and the
+     * last category becomes a normal link.
+     */
+    currentLabel?: string;
+    /**
+     * Optional URL for the trailing `currentLabel` crumb. When omitted,
+     * the crumb is rendered as a non-link `<span>`.
+     */
+    currentUrl?: string;
+    /**
+     * When true (default), a "Home" link is prepended to the trail.
+     */
+    showHome?: boolean;
+    /**
+     * URL for the Home link. Defaults to '/'.
+     */
+    homeUrl?: string;
+    /**
+     * Language code used to resolve localised category names and slugs.
+     * Defaults to 'NL'.
+     */
+    language?: string;
+    /**
+     * Custom URL builder for category links.
+     * Receives the Category object and its zero-based index in the path.
+     * When omitted, URLs default to `/category/{categoryId}/{slug}`.
+     */
+    getUrl?: (category: Category, index: number) => string;
+    /**
+     * Override any UI string.
+     * Available keys: home, separator
+     */
+    labels?: Record<string, string>;
+    /** Extra CSS class applied to the root element. */
+    className?: string;
+    /** Configuration object passed to the component */
+    configuration?: any;
+}
+declare const _default: import('vue').DefineComponent<BreadcrumbsProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<BreadcrumbsProps> & Readonly<{}>, {
+    showCurrent: boolean;
+    showHome: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLElement>;
+export default _default;

package/dist/components/CartBonusItems.vue.d.ts

@@ -0,0 +1,21 @@
+import { Cart, CartBaseItem } from '@propeller-commerce/propeller-sdk-v2';
+export interface CartBonusItemsProps {
+    /** Cart whose `bonusItems` (free items added via incentives) are displayed. */
+    cart?: Cart | null;
+    /** Pre-resolved bonus items. When omitted, `cart.bonusItems` is used. */
+    bonusItems?: CartBaseItem[];
+    /** When true, the tax-inclusive total (`totalPriceNet`) is shown. Resolved from the Propeller provider when omitted; defaults to false. */
+    includeTax?: boolean;
+    /** Currency symbol for prices. Resolved from the Propeller provider when omitted; defaults to '€'. */
+    currency?: string;
+    /** Active language for localized product names. Resolved from the Propeller provider when omitted. */
+    language?: string;
+    /** Additional CSS class for the root element. */
+    className?: string;
+    /** Label overrides. Keys: `title` ('Bonus items'), `sku` ('SKU'). */
+    labels?: Record<string, string>;
+}
+declare const _default: import('vue').DefineComponent<CartBonusItemsProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<CartBonusItemsProps> & Readonly<{}>, {
+    cart: Cart | null;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/CartCarriers.vue.d.ts

@@ -0,0 +1,24 @@
+import { Cart, CartCarrier } from '@propeller-commerce/propeller-sdk-v2';
+export interface CartCarriersProps {
+    /** Shopping cart object from which the carriers will be displayed */
+    cart: Cart;
+    /** Currency symbol to display. Defaults to '€'. */
+    currency?: string;
+    /** The CSS class for the carriers container */
+    carriersContainerClass?: string;
+    /** Display the carrier logo */
+    showCarrierLogo?: boolean;
+    /** Action when a carrier is selected */
+    onCarrierSelect?: (carrier: CartCarrier) => void;
+    /** Custom price formatting function */
+    formatPrice?: (price: number) => string;
+    /** Show carrier price (default: true) */
+    showPrice?: boolean;
+    /** Labels for the component */
+    labels?: Record<string, string>;
+}
+declare const _default: import('vue').DefineComponent<CartCarriersProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<CartCarriersProps> & Readonly<{}>, {
+    showPrice: boolean;
+    showCarrierLogo: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/dist/components/CartIconAndSidebar.vue.d.ts

@@ -0,0 +1,104 @@
+import { Component } from 'vue';
+import { Cart, Contact, Customer, GraphQLClient } from '@propeller-commerce/propeller-sdk-v2';
+export interface CartIconAndSidebarProps {
+    /**
+     * Shopping cart that this component will operate with.
+     * Should be passed from a cart state.
+     */
+    cart: Cart | null;
+    /** Currency symbol to display. Defaults to '€'. */
+    currency?: string;
+    /**
+     * Icon for the cart icon in header.
+     * @default 'default-cart-icon'
+     */
+    icon?: string;
+    /**
+     * Shows item count badge on the cart icon.
+     * @default true
+     */
+    showBadge?: boolean;
+    /**
+     * Shows the totals of the shopping cart beneath the icon when hovered.
+     * @default false
+     */
+    showTotals?: boolean;
+    /**
+     * Show cart sidebar at the right side of the screen when cart icon is clicked.
+     * If false it will fire onCartIconClick() instead.
+     * @default true
+     */
+    showCartSidebarOnClick?: boolean;
+    /**
+     * Fires a click event when showCartSidebarOnClick is set to false.
+     */
+    onCartIconClick?: (cart: Cart) => void;
+    /**
+     * Title for the shopping cart sidebar.
+     * @default 'Shopping cart'
+     */
+    cartSidebarTitle?: string;
+    /**
+     * Show checkout button in cart sidebar for immediate checkout.
+     * @default true
+     */
+    cartCheckoutButton?: boolean;
+    /**
+     * Fires a click event when the checkout button in the sidebar is clicked.
+     */
+    onCheckoutButtonClick?: (cart: Cart) => void;
+    /**
+     * Show shopping cart page button in cart sidebar.
+     * @default true
+     */
+    cartPageButton?: boolean;
+    /**
+     * Fires a click event when the shopping cart button in the sidebar is clicked.
+     */
+    onCartPageButtonClick?: (cart: Cart) => void;
+    /**
+     * Labels for the component.
+     * Available keys: cartIconLabel, totalLabel, itemsLabel, emptyCart,
+     * continueShopping, qty, total, checkoutButton, cartPageButton, closeLabel
+     */
+    labels?: Record<string, string>;
+    /** Logged-in user — used to determine purchaser role and authorization limit */
+    user?: Contact | Customer;
+    /** Active company ID — used to look up the user's PAC for this company */
+    companyId?: number;
+    /** Action handler when the "Request a Quote" button is clicked */
+    onRequestQuoteClick?: (cart: Cart) => void;
+    /** GraphQL client — used for internal CartService calls (e.g. purchase authorization) */
+    graphqlClient?: GraphQLClient;
+    /** Override the internal request purchase authorization call */
+    onRequestAuthorization?: (cart: Cart) => void;
+    /** Fires after a successful purchase authorization request with the updated cart */
+    afterRequestAuthorization?: (cart: Cart) => void;
+    /** Error handler for authorization request failures */
+    onError?: (error: Error) => void;
+    /**
+     * Additional class name for the shopping cart icon.
+     */
+    iconClassName?: string;
+    /**
+     * Additional class name for the shopping cart sidebar.
+     */
+    sidebarClassName?: string;
+    /** Configuration object for image filters */
+    configuration?: any;
+    /** Language used to build localized URLs for cart-item links. Defaults to 'NL'. */
+    language?: string;
+    /**
+     * Replaces each cart row rendered inside the drawer with a custom CartItem.
+     * The drawer composes CartItem with cardFrame=false, showDelete=false,
+     * readOnlyQuantity, and onTitleClick wired to close the sidebar.
+     */
+    cartItemComponent?: Component;
+    cartBonusItemsComponent?: Component;
+}
+declare const _default: import('vue').DefineComponent<CartIconAndSidebarProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<CartIconAndSidebarProps> & Readonly<{}>, {
+    showBadge: boolean;
+    showCartSidebarOnClick: boolean;
+    cartPageButton: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;