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

package/dist/composables/vue/useProductInfo.d.ts

@@ -0,0 +1,33 @@
+import { Ref, ComputedRef } from 'vue';
+import { GraphQLClient, Product, Cluster, Contact, Customer, MediaImageProductSearchInput, TransformationsInput } from '@propeller-commerce/propeller-sdk-v2';
+export interface UseProductInfoOptions {
+    graphqlClient: GraphQLClient;
+    language?: Ref<string>;
+    taxZone?: string;
+    user?: Ref<Contact | Customer | null>;
+    companyId?: Ref<number | undefined>;
+    /** Attribute names to include in attributeResultSearchInput (productTrackAttributes). */
+    productTrackAttributes?: string[];
+    configuration?: {
+        imageSearchFiltersGrid?: MediaImageProductSearchInput;
+        /** Used for products (ProductInfo). */
+        imageVariantFiltersLarge?: TransformationsInput;
+        /** Used for clusters (ClusterInfo). */
+        imageVariantFiltersMedium?: TransformationsInput;
+        /** Alias: some configs use imageVariantFiltersSmall for product images. */
+        imageVariantFiltersSmall?: TransformationsInput;
+    };
+}
+export interface UseProductInfoReturn {
+    product: Ref<Product | null>;
+    cluster: Ref<Cluster | null>;
+    loading: Ref<boolean>;
+    error: Ref<string | null>;
+    fetchProduct: (productId: number, imageSearchFilters?: MediaImageProductSearchInput, imageVariantFilters?: TransformationsInput) => Promise<void>;
+    fetchCluster: (clusterId: number, imageSearchFilters?: MediaImageProductSearchInput, imageVariantFilters?: TransformationsInput) => Promise<void>;
+    clusterName: ComputedRef<string>;
+    clusterSku: ComputedRef<string>;
+    clusterPrice: ComputedRef<number | null>;
+    clusterImageUrl: ComputedRef<string>;
+}
+export declare function useProductInfo(options: UseProductInfoOptions): UseProductInfoReturn;

package/dist/composables/vue/useProductSearch.d.ts

@@ -0,0 +1,49 @@
+import { Ref, ComputedRef } from 'vue';
+import { GraphQLClient, Product, Cluster, Contact, Customer, ProductsResponse, AttributeFilter, ProductTextFilterInput, Category, MediaImageProductSearchInput, TransformationsInput } from '@propeller-commerce/propeller-sdk-v2';
+export interface UseProductSearchOptions {
+    graphqlClient?: GraphQLClient;
+    /** Controlled mode: pass products in, skip internal fetch */
+    products?: Ref<(Product | Cluster)[] | undefined>;
+    categoryId?: Ref<number | undefined>;
+    term?: Ref<string | undefined>;
+    brand?: Ref<string | undefined>;
+    language?: Ref<string>;
+    taxZone?: string;
+    user?: Ref<Contact | Customer | null>;
+    companyId?: Ref<number | undefined>;
+    textFilters?: Ref<ProductTextFilterInput[] | undefined>;
+    priceFilterMin?: Ref<number | undefined>;
+    priceFilterMax?: Ref<number | undefined>;
+    sortField?: Ref<string | undefined>;
+    sortOrder?: Ref<string | undefined>;
+    page?: Ref<number | undefined>;
+    pageSize?: Ref<number>;
+    configuration: {
+        baseCategoryId?: number;
+        imageSearchFiltersGrid?: MediaImageProductSearchInput;
+        imageVariantFiltersMedium?: TransformationsInput;
+    };
+    onFiltersChange?: (filters: AttributeFilter[]) => void;
+    onPriceBoundsChange?: (min: number, max: number) => void;
+    onItemsFoundChange?: (count: number) => void;
+    onPageChange?: (page: number) => void;
+    onProductsResponse?: (products: ProductsResponse) => void;
+    onCategoryChange?: (category: Category) => void;
+}
+export interface UseProductSearchReturn {
+    displayProducts: ComputedRef<(Product | Cluster)[]>;
+    itemsFound: Ref<number>;
+    isLoading: ComputedRef<boolean>;
+    currentSortField: Ref<string>;
+    currentSortOrder: Ref<string>;
+    currentPage: Ref<number>;
+    totalPages: Ref<number>;
+    searchTerm: Ref<string>;
+    searchResults: Ref<(Product | Cluster)[]>;
+    searchItemsFound: Ref<number>;
+    searchLoading: Ref<boolean>;
+    fetchProducts: () => Promise<void>;
+    search: (term: string) => void;
+    goToPage: (page: number) => void;
+}
+export declare function useProductSearch(options: UseProductSearchOptions): UseProductSearchReturn;

package/dist/composables/vue/useProductSlider.d.ts

@@ -0,0 +1,31 @@
+import { Ref } from 'vue';
+import { CrossupsellType, GraphQLClient, Product, Cluster, Contact, Customer, MediaImageProductSearchInput, TransformationsInput } from '@propeller-commerce/propeller-sdk-v2';
+export interface FetchCrossupsellsInput {
+    productId?: number;
+    clusterId?: number;
+    types?: CrossupsellType[];
+}
+export interface UseProductSliderOptions {
+    graphqlClient: GraphQLClient;
+    language?: Ref<string>;
+    taxZone?: string;
+    user?: Ref<Contact | Customer | null>;
+    companyId?: Ref<number | undefined>;
+    configuration?: {
+        imageSearchFiltersGrid?: MediaImageProductSearchInput;
+        imageVariantFiltersMedium?: TransformationsInput;
+    };
+}
+export interface UseProductSliderReturn {
+    products: Ref<(Product | Cluster)[]>;
+    loading: Ref<boolean>;
+    error: Ref<string | null>;
+    canScrollLeft: Ref<boolean>;
+    canScrollRight: Ref<boolean>;
+    fetchCrossupsells: (input: FetchCrossupsellsInput) => Promise<void>;
+    fetchProducts: (productIds: number[], clusterIds?: number[]) => Promise<void>;
+    scrollLeft: (containerEl: HTMLElement, itemWidth?: number) => void;
+    scrollRight: (containerEl: HTMLElement, itemWidth?: number) => void;
+    onScroll: (containerEl: HTMLElement) => void;
+}
+export declare function useProductSlider(options: UseProductSliderOptions): UseProductSliderReturn;

package/dist/composables/vue/useProductSpecs.d.ts

@@ -0,0 +1,24 @@
+import { Ref } from 'vue';
+import { GraphQLClient, AttributeResult } from '@propeller-commerce/propeller-sdk-v2';
+export interface AttributeGroup {
+    name: string;
+    attributes: AttributeDisplayItem[];
+}
+export interface AttributeDisplayItem {
+    name: string;
+    displayName: string;
+    values: string[];
+    type: string;
+}
+export interface UseProductSpecsOptions {
+    graphqlClient: GraphQLClient;
+    language?: Ref<string>;
+}
+export interface UseProductSpecsReturn {
+    attributes: Ref<AttributeResult[]>;
+    groupedAttributes: Ref<AttributeGroup[]>;
+    loading: Ref<boolean>;
+    error: Ref<string | null>;
+    fetchSpecs: (productId: number) => Promise<void>;
+}
+export declare function useProductSpecs(options: UseProductSpecsOptions): UseProductSpecsReturn;

package/dist/composables/vue/usePurchaseAuthorization.d.ts

@@ -0,0 +1,102 @@
+import { Ref, ComputedRef } from 'vue';
+import { GraphQLClient, Company, Cart, CartMainItem, Contact, Customer, PurchaseAuthorizationConfig, PurchaseAuthorizationConfigCreateInput, RegisterContactInput } from '@propeller-commerce/propeller-sdk-v2';
+export interface RowEdit {
+    role: string;
+    limit: number | undefined;
+    dirty: boolean;
+}
+export interface AddContactFormState {
+    gender: string;
+    email: string;
+    firstName: string;
+    middleName: string;
+    lastName: string;
+    phone: string;
+}
+export interface UsePurchaseAuthorizationConfiguratorOptions {
+    graphqlClient: GraphQLClient;
+    user: Ref<Contact | Customer | null>;
+    companyId: Ref<number>;
+    /** Rows per page (default 10) */
+    pageOffset?: number;
+    beforeContactCreate?: (input: RegisterContactInput) => void;
+    onContactCreate?: (input: RegisterContactInput) => void;
+    afterContactCreate?: (contact: Contact) => void;
+    onPurchaseAuthorizationCreate?: (pac: PurchaseAuthorizationConfigCreateInput) => void;
+    afterPurchaseAuthorizationCreate?: (pac: PurchaseAuthorizationConfig) => void;
+    onPurchaseAuthorizationUpdate?: (pac: PurchaseAuthorizationConfig) => void;
+    afterPurchaseAuthorizationUpdate?: (pac: PurchaseAuthorizationConfig) => void;
+    onPurchaseAuthorizationDelete?: (pac: PurchaseAuthorizationConfig) => void;
+    afterPurchaseAuthorizationDelete?: (deleted: boolean) => void;
+}
+export interface UsePurchaseAuthorizationConfiguratorReturn {
+    company: Ref<Company | null>;
+    loading: Ref<boolean>;
+    contacts: ComputedRef<Contact[]>;
+    totalPages: ComputedRef<number>;
+    currentPage: Ref<number>;
+    isAuthManager: ComputedRef<boolean>;
+    rowEdits: Ref<Record<number, RowEdit>>;
+    pacMap: Ref<Record<number, PurchaseAuthorizationConfig>>;
+    actionLoading: Ref<Record<number, boolean>>;
+    showAddContactModal: Ref<boolean>;
+    addContactForm: Ref<AddContactFormState>;
+    addContactLoading: Ref<boolean>;
+    addContactError: Ref<string>;
+    hasPac: (contactId: number) => boolean;
+    isCurrentUser: (contactId: number) => boolean;
+    isRowDirty: (contactId: number) => boolean;
+    getRowRole: (contactId: number) => string;
+    getRowLimit: (contactId: number) => number | undefined;
+    isRowLoading: (contactId: number) => boolean;
+    loadCompany: (page: number) => Promise<void>;
+    handleRoleChange: (contactId: number, role: string) => void;
+    handleLimitChange: (contactId: number, value: string) => void;
+    handleCreate: (contactId: number) => Promise<void>;
+    handleSave: (contactId: number) => Promise<void>;
+    handleDelete: (contactId: number) => Promise<void>;
+    handlePageChange: (page: number) => void;
+    openAddContactModal: () => void;
+    closeAddContactModal: () => void;
+    handleAddContactSubmit: () => Promise<void>;
+}
+export declare function usePurchaseAuthorizationConfigurator(options: UsePurchaseAuthorizationConfiguratorOptions): UsePurchaseAuthorizationConfiguratorReturn;
+export interface UsePurchaseAuthorizationRequestsOptions {
+    graphqlClient: GraphQLClient;
+    user: Ref<Contact | Customer | null>;
+    companyId: Ref<number>;
+    configuration?: {
+        language?: string;
+        imageSearchFiltersGrid?: any;
+        imageVariantFiltersSmall?: any;
+    };
+    onAcceptRequest?: (cartId: string) => void;
+    afterAcceptRequest?: (cart: Cart) => void;
+    /**
+     * Called BEFORE deleting; receives the cart id. Lets the host short-circuit
+     * the SDK call and run its own deletion logic, following the same pattern as
+     * onAcceptRequest.
+     */
+    onDeleteRequest?: (cartId: string) => void;
+    /** Called AFTER a successful delete. Receives the deleted cart's id. */
+    afterDeleteRequest?: (cartId: string) => void;
+    onError?: (err: Error) => void;
+}
+export interface UsePurchaseAuthorizationRequestsReturn {
+    carts: Ref<Cart[]>;
+    loading: Ref<boolean>;
+    selectedCart: Ref<Cart | null>;
+    modalLoading: Ref<boolean>;
+    acceptLoading: Ref<boolean>;
+    deleteLoading: Ref<boolean>;
+    isAuthManager: ComputedRef<boolean>;
+    getTotalQuantity: (cart: Cart) => number;
+    getContactName: (contact: Contact | null | undefined) => string;
+    getModalItems: () => CartMainItem[];
+    loadCarts: () => Promise<void>;
+    handleViewCart: (cart: Cart) => Promise<void>;
+    handleAcceptRequest: () => Promise<void>;
+    handleDeleteRequest: () => Promise<void>;
+    closeModal: () => void;
+}
+export declare function usePurchaseAuthorizationRequests(options: UsePurchaseAuthorizationRequestsOptions): UsePurchaseAuthorizationRequestsReturn;

package/dist/composables/vue/useResolvedProps.d.ts

@@ -0,0 +1,42 @@
+import { ProductGridConfig } from '../../context/ProductGridContext';
+import { PropellerInfra } from '../../context/PropellerContext';
+/**
+ * Declarative resolver for the two-tier prop precedence used by
+ * `ProductCard` / `ClusterCard`:
+ *
+ *   explicit prop  >  ProductGrid context (Tier 2)  >  Propeller infra (Tier 1)  >  default
+ *
+ * Without this, each card hand-writes a ~25–40 line object literal of
+ * `props.x ?? grid?.x ?? infra.x ?? d` lines — easy to get the precedence
+ * order wrong per key and impossible to scan. This collapses it to a spec
+ * table. It internally calls the same non-throwing `useInfraProps` and
+ * `useProductGridConfig`, so standalone usage (no provider) still works.
+ *
+ * Spec per key:
+ *   - `infra`  : fall back to PropellerInfra[key] (Tier 1)
+ *   - `grid`   : fall back to ProductGridConfig[key] (Tier 2)
+ *   - `default`: final fallback when nothing else resolved
+ *   - `transform(gridValue)`: when the grid value needs wrapping before use
+ *
+ * A key absent from the spec passes through unchanged.
+ */
+type InfraKey = keyof PropellerInfra;
+type GridKey = keyof ProductGridConfig;
+interface ResolveSpecEntry {
+    /** Tier-1 infra key to fall back to (after the explicit prop). */
+    infra?: InfraKey;
+    /** Tier-2 grid-config key to fall back to (after the explicit prop). */
+    grid?: GridKey;
+    /** Final fallback when neither explicit prop nor context resolved a value. */
+    default?: unknown;
+    /** Optional adapter applied to the grid value when it is the one chosen. */
+    transform?: (gridValue: NonNullable<ProductGridConfig[GridKey]>) => unknown;
+}
+export type ResolveSpec<P> = Partial<Record<keyof P, ResolveSpecEntry>>;
+/**
+ * Resolve `rawProps` against the spec. Call inside `setup()` (it injects the
+ * grid + infra contexts). Wrap the call in a `computed` if the resolved
+ * result must track prop changes.
+ */
+export declare function useResolvedProps<P extends object>(rawProps: P, spec: ResolveSpec<P>): P;
+export {};

package/dist/composables/vue/useServices.d.ts

@@ -0,0 +1,13 @@
+import { Services } from '@propeller-commerce/propeller-v2-core-ui';
+/**
+ * Read the SDK services bundle from the Propeller plugin.
+ *
+ * The package ships no default `graphqlClient` / `services`. The consumer
+ * constructs both at app startup and installs them via
+ * `app.use(propellerVue, { graphqlClient, services, ... })`. Anything in
+ * the app tree calls `useServices()` to get the bundle.
+ *
+ * Throws when the plugin wasn't installed — that's an integration error the
+ * consumer fixes at app startup, not something to paper over with a singleton.
+ */
+export declare function useServices(): Services;

package/dist/context/ProductGridContext.d.ts

@@ -0,0 +1,59 @@
+import { InjectionKey, Component } from 'vue';
+import { Cart, CartMainItem, Product, Cluster } from '@propeller-commerce/propeller-sdk-v2';
+/**
+ * Tier 2 grid config context. Collapses the feature-flag / display and
+ * callback props that `ProductGrid` otherwise cascades through
+ * `ProductCard` / `ClusterCard` down to `AddToCart` / `ItemStock`.
+ * `ProductGrid` is the provider; the card subtree consumes via
+ * `useProductGridConfig()` instead of receiving ~20 threaded props.
+ */
+export interface ProductGridConfig {
+    columns: number;
+    showPrice?: boolean;
+    showStock?: boolean;
+    showAvailability?: boolean;
+    enableAddFavorite?: boolean;
+    allowAddToCart?: boolean;
+    createCart?: boolean;
+    showModal?: boolean;
+    allowIncrDecr?: boolean;
+    enableStockValidation?: boolean;
+    cartId?: string;
+    childItems?: number[];
+    notes?: string;
+    price?: number;
+    stockLabels?: Record<string, string>;
+    priceLabels?: Record<string, string>;
+    addToCartLabels?: Record<string, string>;
+    onCartCreated?: (cart: Cart) => void;
+    afterAddToCart?: (cart: Cart, item?: CartMainItem) => void;
+    onProceedToCheckout?: () => void;
+    onRequestQuoteClick?: (cart: Cart) => void;
+    onToggleFavorite?: (item: Product | Cluster, isFavorite: boolean) => void;
+    onProductClick?: (product: Product) => void;
+    onClusterClick?: (cluster: Cluster) => void;
+    priceComponent?: Component;
+    stockComponent?: Component;
+    addToCartComponent?: Component;
+    imageComponent?: Component;
+    badgesComponent?: Component;
+    favoriteComponent?: Component;
+    bundlesComponent?: Component;
+    bulkPricesComponent?: Component;
+    surchargesComponent?: Component;
+    productCardComponent?: Component;
+    clusterCardComponent?: Component;
+}
+/** Injection key for the Tier 2 grid config. Symbol-keyed, collision-free. */
+export declare const ProductGridInjectionKey: InjectionKey<ProductGridConfig>;
+/**
+ * Install the grid config for the card subtree. `ProductGrid` calls this in
+ * its `setup()`; `ProductCard` / `ClusterCard` and their children read it.
+ */
+export declare function provideProductGridConfig(value: ProductGridConfig): void;
+/**
+ * Non-throwing: `ProductCard` / `ClusterCard` used outside a grid
+ * (`ProductSlider`, standalone, tests) get `null` and fall back to explicit
+ * props / defaults.
+ */
+export declare function useProductGridConfig(): ProductGridConfig | null;

package/dist/context/PropellerContext.d.ts

@@ -0,0 +1,51 @@
+import { InjectionKey } from 'vue';
+import { Contact, Customer } from '@propeller-commerce/propeller-sdk-v2';
+import { ShopMode, UserMode } from '@propeller-commerce/propeller-v2-core-ui';
+import { PropellerDeps } from '../plugin';
+/**
+ * Tier 2 — per-scope state. Bound by `<PropellerProvider>` and replaceable
+ * by nesting a second provider deeper in the tree (for impersonation,
+ * multi-cart, multi-language widgets, …). Distinct from the Tier 1 deps
+ * installed by the `propellerVue` plugin.
+ */
+export interface PropellerScope {
+    user: Contact | Customer | null;
+    companyId: number | undefined;
+    language: string;
+    includeTax: boolean;
+    portalMode: string;
+    /**
+     * Shop mode declared in `propeller.json`. Combined with `user` to derive
+     * `userMode` on the composite context. Defaults to `'hybrid'` when omitted
+     * so existing call sites keep their current branching semantics.
+     */
+    shopMode?: ShopMode;
+}
+/** Symbol-keyed scope injection — never collides with consumer keys. */
+export declare const PropellerScopeKey: InjectionKey<PropellerScope>;
+/**
+ * Composite read of Tier 1 deps + Tier 2 scope. Mirrors the previous
+ * `PropellerInfra` shape so existing consumers (cards, useResolvedProps,
+ * useInfraProps) keep working unchanged.
+ *
+ * Composables that only need services should call `useServices()` /
+ * `usePropellerDeps()` instead — they don't depend on a scope provider.
+ */
+export interface PropellerInfra extends PropellerDeps, PropellerScope {
+    userMode: UserMode;
+}
+/**
+ * Non-throwing accessor: returns `null` if either tier is missing so
+ * components stay usable standalone / in tests.
+ */
+export declare function usePropellerContext(): PropellerInfra | null;
+/**
+ * Throwing accessor — call when both tiers are required and a missing
+ * provider is an integration bug, not a render-standalone scenario.
+ */
+export declare function useRequiredPropellerContext(): PropellerInfra;
+/**
+ * Read the active `userMode` directly. Returns `'anonymous'` outside the
+ * provider so components stay usable standalone / in tests.
+ */
+export declare function useUserMode(): UserMode;