@bacano/sdk 1.0.0

package/types.d.ts

@@ -0,0 +1,991 @@
+export interface BacanoClientConfig {
+    /** Bacano public API URL (e.g., https://api.bacanoerp.com) */
+    apiUrl: string;
+    /** Website slug — required tenant context for every storefront request. */
+    websiteSlug: string;
+    /** Cart session storage strategy (default: 'localStorage') */
+    tokenStorage?: "localStorage" | "cookie" | "memory";
+    /**
+     * Returns the current buyer access token.
+     *
+     * For Clerk storefronts pass `() => getToken()`. The SDK invokes this
+     * provider for every request, so token refresh remains owned by Clerk and
+     * passwords never pass through Bacano.
+     */
+    getAccessToken?: AccessTokenProvider;
+}
+export type AccessTokenProvider = () => string | null | Promise<string | null>;
+export interface WebsitePublicConfig {
+    websiteId: string;
+    companyId: string;
+    slug: string;
+    name: string;
+    domain: string | null;
+    buyerAccountsEnabled: boolean;
+    clerkPublishableKey: string | null;
+    customerIdentification: WebsiteCustomerIdentificationPolicy;
+}
+export type WebsiteCustomerIdentifierType = "AUTO" | "EMAIL" | "PHONE" | "DOCUMENT";
+export interface WebsiteCustomerDocumentType {
+    code: string;
+    name: string;
+    shortLabel: string;
+    isDefault: boolean;
+}
+export interface WebsiteCustomerIdentificationPolicy {
+    primaryIdentifier: WebsiteCustomerIdentifierType;
+    requireEmail: boolean;
+    requirePhone: boolean;
+    requireDocument: boolean;
+    documentTypes: WebsiteCustomerDocumentType[];
+}
+export interface GetWebsitePublicConfigOptions {
+    /** Bacano public API URL (e.g., https://api.bacanoerp.com). */
+    apiUrl: string;
+    /** Website slug configured in Bacano. */
+    websiteSlug: string;
+    /**
+     * Storefront origin. Required during SSR; browsers send their Origin
+     * header automatically and should omit this option.
+     */
+    origin?: string;
+}
+export interface BacanoClientContext {
+    websiteId: string;
+    companyId: string;
+    chainId: string | null;
+    name: string;
+    slug: string;
+    domain: string | null;
+    config: Record<string, unknown> | null;
+}
+export interface Product {
+    id: string;
+    name: string;
+    description: string | null;
+    longDescription: Record<string, unknown> | null;
+    slug: string | null;
+    seoTitle: string | null;
+    seoDescription: string | null;
+    seoImage: ProductMedia | null;
+    color: string | null;
+    category: string;
+    subcategory: string | null;
+    brand: {
+        id: string;
+        name: string;
+    } | null;
+    measurementUnit: string | null;
+    createdAt: string;
+    updatedAt: string;
+    variants: ProductVariant[];
+    media: ProductMedia[];
+    attributes: ProductAttribute[];
+    relatedProducts: ProductRelatedProduct[];
+}
+export interface ProductRelatedProduct {
+    id: string;
+    productId: string;
+    slug: string | null;
+    name: string;
+    sku: string | null;
+    displayLabel: string | null;
+    sortOrder: number;
+    media: ProductMedia[];
+}
+export interface ProductVariant {
+    id: string;
+    sku: string;
+    barcode: string | null;
+    order: number;
+    weight: number | null;
+    depth: number | null;
+    height: number | null;
+    length: number | null;
+    prices: ProductPrice[];
+    /** Storefront-ready price interpretation for this website and chain. */
+    pricing: ProductVariantPricing;
+    attributes: VariantAttribute[];
+}
+export type ProductPriceType = "CLIENT" | "SALE" | "WHOLESALE" | "WHOLESALE_2";
+export interface ProductPrice {
+    id: string;
+    price: number;
+    priceType: ProductPriceType;
+    chainId: string | null;
+}
+export interface ProductVariantPricing {
+    /** Price Bacano will use for a regular public checkout. */
+    currentPrice: number | null;
+    /** Regular CLIENT price before a valid offer. */
+    regularPrice: number | null;
+    /** Valid SALE price, only when it is lower than regularPrice. */
+    salePrice: number | null;
+    hasDiscount: boolean;
+    discountPercentage: number | null;
+    /** Optional company-enabled wholesale tiers; informational for now. */
+    wholesalePrice: number | null;
+    wholesale2Price: number | null;
+}
+export type ProductMediaKind = "image" | "video" | "document" | "file";
+export interface ProductMedia {
+    id: string;
+    fileId: string;
+    order: number;
+    /** @deprecated Use originalUrl/cardUrl/detailUrl based on the rendering context. */
+    url: string;
+    originalUrl: string;
+    thumbnailUrl: string;
+    cardUrl: string;
+    detailUrl: string;
+    mediaKind: ProductMediaKind;
+    mimeType: string | null;
+    fileName: string | null;
+    alt: string | null;
+}
+export interface ProductAttribute {
+    id: string;
+    /** Public label ready for storefront UI, e.g. "Talla". */
+    name: string;
+    /** Public value label ready for storefront UI, e.g. "6 a 12 meses". */
+    value: string;
+    attributeValueId?: string | null;
+    /** Technical attribute code/name, e.g. "CLOTHING_SIZE". */
+    code?: string | null;
+    /** Technical attribute value code, e.g. "SIX_TWELVE_MONTHS". */
+    valueCode?: string | null;
+    metadata?: Record<string, unknown> | null;
+    sortOrder?: number | null;
+}
+export interface VariantAttribute {
+    id: string;
+    /** Public label ready for storefront UI, e.g. "Talla". */
+    name: string;
+    /** Public value label ready for storefront UI, e.g. "6 a 12 meses". */
+    value: string;
+    order: number | null;
+    attributeValueId?: string | null;
+    /** Technical attribute code/name, e.g. "CLOTHING_SIZE". */
+    code?: string | null;
+    /** Technical attribute value code, e.g. "SIX_TWELVE_MONTHS". */
+    valueCode?: string | null;
+    metadata?: Record<string, unknown> | null;
+    sortOrder?: number | null;
+}
+export interface ProductCategory {
+    name: string;
+    description: string | null;
+    subcategories: ProductSubcategory[];
+}
+export interface ProductSubcategory {
+    id: string;
+    name: string;
+    description: string | null;
+}
+export type CatalogCategoryListItemSourceType = "category" | "subcategory";
+export interface CatalogCategoryListItem {
+    id: string;
+    sourceType: CatalogCategoryListItemSourceType;
+    productCategory: string | null;
+    productSubcategoryId: string | null;
+    label: string;
+    slug: string;
+    sortOrder: number;
+    category: {
+        name: string;
+        description: string | null;
+    } | null;
+    subcategory: {
+        id: string;
+        name: string;
+        description: string | null;
+        category: string;
+    } | null;
+    /**
+     * Present for subcategory items. It points to the parent category item in the
+     * same public list, so storefronts do not need to infer hierarchy by order.
+     */
+    parentCategory: string | null;
+    parentId: string | null;
+    parentSlug: string | null;
+}
+export interface CatalogCategoryListCategory {
+    id: string;
+    productCategory: string | null;
+    label: string;
+    slug: string;
+    sortOrder: number;
+    category: {
+        name: string;
+        description: string | null;
+    } | null;
+    subcategories: CatalogCategoryListItem[];
+}
+export interface CatalogCategoryList {
+    id: string;
+    key: string;
+    name: string;
+    description: string | null;
+    status: "published";
+    items: CatalogCategoryListItem[];
+    categories: CatalogCategoryListCategory[];
+}
+export interface GetCategoryListOptions {
+    key: string;
+    /**
+     * When true, Bacano returns only categories/subcategories with active,
+     * available products in the current website catalog context.
+     */
+    onlyApplicable?: boolean;
+    filters?: CatalogCategoryListFilters;
+}
+export interface CatalogCategoryListFilters {
+    tags?: string[];
+    search?: string;
+    brandId?: string;
+    minPrice?: number;
+    maxPrice?: number;
+    attributes?: Record<string, string[]>;
+}
+export interface CatalogAttributeListValue {
+    id: string;
+    attributeValueId: string;
+    code: string;
+    label: string;
+    slug: string;
+    sortOrder: number;
+    metadata: Record<string, unknown> | null;
+}
+export interface CatalogAttributeListItem {
+    id: string;
+    attributeId: string;
+    attributeName: string;
+    attributeType: string;
+    label: string;
+    slug: string;
+    sortOrder: number;
+    values: CatalogAttributeListValue[];
+}
+export interface CatalogAttributeList {
+    id: string;
+    key: string;
+    name: string;
+    description: string | null;
+    status: "published";
+    items: CatalogAttributeListItem[];
+}
+export interface CatalogAttributeListFilters {
+    categoryName?: string;
+    subcategoryId?: string;
+    tags?: string[];
+    search?: string;
+    brandId?: string;
+    minPrice?: number;
+    maxPrice?: number;
+}
+export interface GetAttributeListOptions {
+    key: string;
+    /**
+     * When true, Bacano returns only attributes/values with active, available
+     * products in the current website catalog context.
+     */
+    onlyApplicable?: boolean;
+    filters?: CatalogAttributeListFilters;
+}
+export interface Brand {
+    id: string;
+    name: string;
+}
+export interface ProductAvailability {
+    productVariantId: string;
+    inStock: boolean;
+    label: string;
+}
+export type ProductSortBy = "name_asc" | "name_desc" | "price_asc" | "price_desc" | "newest";
+export interface GetProductsOptions {
+    categoryName?: string;
+    subcategoryId?: string;
+    brandId?: string;
+    search?: string;
+    limit?: number;
+    offset?: number;
+    /** Filter by color values (any match) */
+    colors?: string[];
+    /** Minimum price across any variant's CLIENT/SALE prices */
+    minPrice?: number;
+    /** Maximum price across any variant's CLIENT/SALE prices */
+    maxPrice?: number;
+    /** Only products with stock > 0 */
+    inStock?: boolean;
+    /** Filter by reusable tag keys, e.g. ['bebe-nina'] */
+    tags?: string[];
+    /** Filter by dynamic attributes, e.g. { Size: ['M', 'L'], Material: ['Cotton'] } */
+    attributes?: Record<string, string[]>;
+    /** Sort order */
+    sortBy?: ProductSortBy;
+}
+export interface AttributeFilter {
+    id: string;
+    name: string;
+    values: Array<{
+        value: string;
+        count: number;
+        attributeValueId?: string | null;
+        code?: string | null;
+        metadata?: Record<string, unknown> | null;
+        sortOrder?: number | null;
+    }>;
+}
+export interface ProductFilters {
+    categories: Array<{
+        name: string;
+        count: number;
+    }>;
+    brands: Array<{
+        id: string;
+        name: string;
+        count: number;
+    }>;
+    colors: Array<{
+        value: string;
+        count: number;
+    }>;
+    priceRange: {
+        min: number;
+        max: number;
+    };
+    /** Category-specific dynamic attributes — populated when categoryName is provided */
+    attributes: AttributeFilter[];
+}
+export interface GetProductFiltersOptions {
+    /** When set, includes category-specific attribute facets */
+    categoryName?: string;
+    /** When set with categoryName, narrows subcategory-specific facets and counts */
+    subcategoryId?: string;
+    /**
+     * Public catalog attribute list used to resolve attribute filter labels.
+     * Defaults to "atributos".
+     */
+    attributeListKey?: string;
+}
+export interface CatalogPageIncludeOptions {
+    products?: boolean;
+    categories?: boolean;
+    attributes?: boolean;
+    filters?: boolean;
+    brands?: boolean;
+    debug?: boolean;
+}
+export interface GetCatalogPageOptions {
+    categoryListKey: string;
+    attributeListKey: string;
+    categorySlug?: string;
+    subcategorySlug?: string;
+    tags?: string[];
+    search?: string;
+    brandId?: string;
+    minPrice?: number;
+    maxPrice?: number;
+    attributesBySlug?: Record<string, string[]>;
+    sortBy?: ProductSortBy;
+    limit?: number;
+    offset?: number;
+    include?: CatalogPageIncludeOptions;
+}
+export interface GetProductSeoEntriesOptions {
+    /**
+     * Number of entries to load. The SDK fetches one extra item internally to
+     * calculate hasMore without requiring GraphQL aggregate permissions.
+     */
+    limit?: number;
+    offset?: number;
+}
+export interface ProductSeoEntry {
+    id: string;
+    name: string;
+    slug: string;
+    createdAt: string;
+    updatedAt: string;
+    seoTitle: string | null;
+    seoDescription: string | null;
+    seoImage: ProductMedia | null;
+    primaryImage: ProductMedia | null;
+    category: string;
+    subcategory: string | null;
+}
+export interface ProductSeoEntriesResult {
+    entries: ProductSeoEntry[];
+    pagination: {
+        limit: number;
+        offset: number;
+        hasMore: boolean;
+    };
+}
+export interface CatalogPagePagination {
+    limit: number;
+    offset: number;
+    total: number;
+    hasMore: boolean;
+}
+export interface CatalogPageDebug {
+    timings?: Record<string, number>;
+    availabilityChecks?: number;
+    candidateProducts?: number;
+    candidateVariants?: number;
+}
+export interface CatalogPageResult {
+    products: Product[];
+    categories: CatalogCategoryList | null;
+    attributes: CatalogAttributeList | null;
+    filters: ProductFilters | null;
+    brands: Brand[];
+    pagination: CatalogPagePagination;
+    appliedFilters: Record<string, unknown>;
+    debug: CatalogPageDebug | null;
+}
+export type ProductRecommendationSource = "manual" | "subcategory" | "category" | "attributes" | "fallback";
+export interface ProductRecommendationPricing {
+    currentPriceMin: number;
+    currentPriceMax: number;
+    regularPriceMin: number;
+    regularPriceMax: number;
+    hasDiscount: boolean;
+}
+export interface ProductRecommendation {
+    id: string;
+    name: string;
+    slug: string;
+    category: string;
+    subcategory: string | null;
+    brand: Brand | null;
+    primaryImage: ProductMedia | null;
+    pricing: ProductRecommendationPricing;
+    source: ProductRecommendationSource;
+}
+export interface GetProductRecommendationsOptions {
+    productId: string;
+    /** Number of recommendations. Defaults to 16; maximum is 32. */
+    limit?: number;
+}
+export interface ProductRecommendationsResult {
+    products: ProductRecommendation[];
+    strategy: string;
+}
+export interface ContentMedia {
+    fileId: string;
+    name: string | null;
+    mediaKind: ProductMediaKind;
+    mimeType: string | null;
+    sizeBytes: number | null;
+    alt?: string | null;
+    originalUrl?: string | null;
+    thumbnailUrl?: string | null;
+    cardUrl?: string | null;
+    detailUrl?: string | null;
+    /** @deprecated Use originalUrl/cardUrl/detailUrl based on the rendering context. */
+    url?: string | null;
+}
+export type ContentJson = Record<string, unknown>;
+export type ContentResolvedFields = Record<string, unknown>;
+export type ContentLink = {
+    type: "link";
+    href: string;
+    openInNewTab: boolean;
+} | {
+    type: "email";
+    email: string;
+    href: string;
+} | {
+    type: "phone";
+    phone: string;
+    href: string;
+} | {
+    type: "whatsapp";
+    phone: string;
+    message?: string;
+    href: string;
+};
+/** `YYYY-MM-DD` for dates or an ISO-8601 UTC string for date-times. */
+export type ContentDateValue = string;
+export interface ContentProductReference {
+    referenceId: string;
+    type: "product";
+    id: string;
+    label: string;
+    name: string;
+    slug: string | null;
+    sku: string | null;
+    priceRange: {
+        min: number;
+        max: number;
+    };
+    media: ProductMedia[];
+}
+export interface ContentEntryReference {
+    referenceId: string;
+    type: "content_entry";
+    id: string;
+    key: string;
+    label: string;
+    categoryKey: string;
+    contentTypeKey: string;
+    contentTypeName: string;
+    status: string;
+}
+export interface ContentTypeSummary {
+    id: string;
+    key: string;
+    name: string;
+    kind: "entry" | "component";
+}
+export interface ContentEntry {
+    id: string;
+    key: string | null;
+    categoryKey: string;
+    name: string;
+    locale: string;
+    /** Public Content APIs only return published entries. */
+    status: "published";
+    tags: string[];
+    contentJson: ContentJson;
+    /**
+     * Public labels resolved by Bacano for fields that store technical values,
+     * such as select fields backed by reusable option lists.
+     */
+    resolvedFields: ContentResolvedFields;
+    publishedAt: string | null;
+    updatedAt: string;
+    contentType: ContentTypeSummary;
+}
+export interface ProductContentBlock {
+    id: string;
+    productId: string;
+    locale: string;
+    contentJson: ContentJson;
+    resolvedFields: ContentResolvedFields;
+    sortOrder: number;
+    updatedAt: string;
+    contentType: ContentTypeSummary;
+}
+export interface GetContentOptions {
+    locale?: string;
+}
+export interface SearchSuggestion {
+    type: "product" | "brand" | "category";
+    text: string;
+    /** Product or brand ID when applicable */
+    id?: string;
+}
+export interface GetSearchSuggestionsOptions {
+    query: string;
+    /** Maximum number of suggestions (default: 8) */
+    limit?: number;
+}
+export interface Cart {
+    id: string;
+    cartToken?: string;
+    items: CartItem[];
+    totals: {
+        subtotal: number;
+        tax: number;
+        discount: number;
+        total: number;
+    };
+    status: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CartItem {
+    id: string;
+    productVariantId: string;
+    quantity: number;
+    productVariant: {
+        sku: string;
+        product: {
+            id: string;
+            name: string;
+        };
+        prices: ProductPrice[];
+    };
+}
+export interface WebsiteGuestContact {
+    name?: string;
+    firstName?: string;
+    lastName?: string;
+    email?: string;
+    phone?: string;
+    cellphone?: string;
+    documentType?: string;
+    documentNumber?: string;
+    address?: Record<string, unknown>;
+}
+export type WebsiteFulfillmentFamily = "PICKUP" | "SHIPPING";
+export interface WebsiteCheckoutItem {
+    productVariantId: string;
+    quantity: number;
+}
+export interface StartGuestCheckoutInput {
+    contact: WebsiteGuestContact;
+    items: WebsiteCheckoutItem[];
+    fulfillmentFamily?: WebsiteFulfillmentFamily;
+}
+export interface CheckoutSubmission {
+    contact: WebsiteGuestContact;
+    fulfillmentFamily?: WebsiteFulfillmentFamily;
+    address?: WebsiteCheckoutAddress;
+    shippingQuoteId?: string;
+    paymentMode?: WebsitePaymentMode;
+    paymentMethodId?: string;
+    /**
+     * Request an account activation email after Bacano creates a valid guest order.
+     * Delivery does not depend on the order being paid.
+     * Ignored when the buyer already has an authenticated Clerk session.
+     */
+    buyerAccountOptIn?: boolean;
+    initialPayment?: {
+        amount: number;
+        paymentMethodId: string;
+    };
+}
+export interface WebsiteCheckoutAddress {
+    departmentId?: string;
+    departmentName?: string;
+    municipalityId?: string;
+    municipalityName?: string;
+    line1?: string;
+    line2?: string;
+    notes?: string;
+}
+export interface WebsiteMunicipalityOption {
+    municipalityId: string;
+    municipalityName: string;
+    municipalityCode: string;
+    departmentId: string;
+    departmentCode: string;
+}
+export interface WebsiteDepartmentOption {
+    departmentId: string;
+    departmentName: string;
+    departmentCode: string;
+    municipalities: WebsiteMunicipalityOption[];
+}
+export interface WebsiteLocationOptions {
+    countryCode: string | null;
+    departments: WebsiteDepartmentOption[];
+}
+export interface WebsitePickupInfo {
+    label: string;
+    address: string | null;
+    schedule: string | null;
+    notes: string | null;
+}
+export interface WebsiteDeliveryOption {
+    id: "shipping" | "pickup" | string;
+    fulfillmentFamily: WebsiteFulfillmentFamily;
+    label: string;
+    description: string | null;
+    isEnabled: boolean;
+    pickupInfo: WebsitePickupInfo | null;
+}
+export interface WebsiteShippingQuote {
+    quoteId: string;
+    shippingServiceId: string;
+    label: string;
+    serviceName: string;
+    baseAmount: number;
+    amount: number;
+    currency: string;
+    collectionMode: string;
+    totalPolicy: string;
+    estimatedDelivery: string | null;
+    freeShippingEligible: boolean;
+    freeShippingApplied: boolean;
+    freeShippingThreshold: number | null;
+    freeShippingRemaining: number | null;
+    freeShippingEligibleSubtotal: number | null;
+}
+export interface WebsiteShippingPolicy {
+    freeShippingEnabled: boolean;
+    freeShippingThreshold: number | null;
+    currency: string;
+}
+export interface WebsiteFreeShippingProgress {
+    enabled: boolean;
+    threshold: number | null;
+    remaining: number | null;
+    eligibleSubtotal: number | null;
+    thresholdReached: boolean;
+    currency: string;
+}
+export interface WebsitePaymentMethod {
+    id: string;
+    code: string;
+    label: string;
+    paymentMethodType: string;
+    gatewayCode: string | null;
+    description: string | null;
+    isEnabled: boolean;
+    sortOrder: number;
+    requiresPaymentSession: boolean;
+    publicConfig: Record<string, unknown> | null;
+}
+export type WebsitePaymentMode = "pay_now" | "partial" | "pay_later" | "cash_on_delivery";
+export type WebsiteInitialPaymentPolicy = "none" | "optional" | "required";
+export interface WebsitePaymentOptionMethod {
+    id: string;
+    paymentMethodId: string;
+    code: string;
+    label: string;
+    paymentMethodType: string;
+    gatewayCode: string | null;
+    description: string | null;
+    instructions: string | null;
+    qrFileId: string | null;
+    requiresPaymentSession: boolean;
+    publicConfig: Record<string, unknown>;
+    sortOrder: number;
+}
+export interface WebsitePaymentOption {
+    id: string;
+    mode: WebsitePaymentMode;
+    fulfillmentFamily: WebsiteFulfillmentFamily;
+    label: string;
+    description: string | null;
+    requiresPaymentMethod: boolean;
+    allowsInitialPayment: boolean;
+    initialPaymentPolicy: WebsiteInitialPaymentPolicy;
+    requiresInitialPayment: boolean;
+    minInitialAmount: number | null;
+    suggestedInitialAmount: number | null;
+    sortOrder: number;
+    methods: WebsitePaymentOptionMethod[];
+}
+export interface WebsiteCouponActionResult {
+    success: boolean;
+    orderId: string | null;
+    couponId: string | null;
+    code: string | null;
+    name: string | null;
+    couponType: string | null;
+    discountAmount: number;
+    eligibleSubtotal: number;
+    message: string | null;
+    cart: Cart | null;
+    errors: string[] | null;
+}
+export interface WebsitePaymentSessionResult {
+    success: boolean;
+    orderId: string | null;
+    paymentMethodId: string | null;
+    paymentSessionId: string | null;
+    gatewayCode: string | null;
+    integrationMode: "redirect" | null;
+    status: string | null;
+    redirectUrl: string | null;
+    /** @deprecated Provider-specific checkout payloads are no longer public. */
+    publicPayload: Record<string, unknown> | null;
+    errors: string[] | null;
+}
+export interface CheckoutResult {
+    success: boolean;
+    orderId: string | null;
+    orderNumber: string | null;
+    paymentMethodId: string | null;
+    publicOrderToken: string | null;
+    requiresPaymentSession: boolean;
+    buyerAccountInvitationRequested: boolean;
+    errors: string[] | null;
+}
+export interface PublicOrderLookupInput {
+    orderId: string;
+    token: string;
+}
+export interface WaitForPublicOrderPaymentInput extends PublicOrderLookupInput {
+    intervalMs?: number;
+    timeoutMs?: number;
+}
+export interface PublicOrderDeliverySummary {
+    fulfillmentFamily: WebsiteFulfillmentFamily | string;
+    shipping: {
+        label: string | null;
+        amount: number;
+        methodType: string;
+        collectionMode: string;
+        totalPolicy: string;
+        address: Record<string, unknown> | null;
+    } | null;
+    pickup: {
+        label: string;
+    } | null;
+}
+export interface PublicOrderPaymentSummary {
+    mode: WebsitePaymentMode | string | null;
+    label: string | null;
+    method: {
+        id: string | null;
+        label: string | null;
+        paymentMethodType: string | null;
+        gatewayCode: string | null;
+        requiresPaymentSession: boolean;
+    } | null;
+    requiresPaymentSession: boolean;
+    nextAction: PublicOrderPaymentNextAction;
+    initialPayment: {
+        amount: number;
+        paymentMethodId: string | null;
+        methodLabel: string | null;
+        paymentMethodType: string | null;
+        gatewayCode: string | null;
+        requiresPaymentSession: boolean;
+    } | null;
+    session: {
+        id: string;
+        gatewayCode: string;
+        integrationMode: string;
+        status: string;
+        reference: string;
+        amount: number;
+        currency: string;
+        gatewayTransactionId: string | null;
+        errorMessage: string | null;
+        expiresAt: string;
+        createdAt: string;
+        updatedAt: string;
+    } | null;
+}
+export type PublicOrderPaymentNextAction = "NONE" | "CREATE_PAYMENT_SESSION" | "WAIT_FOR_PAYMENT" | "RETRY_PAYMENT" | "PAY_ON_DELIVERY" | "PAY_AT_PICKUP" | "WAIT_FOR_ORDER_CONFIRMATION";
+export interface PublicOrderItem {
+    id: string;
+    productVariantId: string;
+    sku: string;
+    name: string;
+    imageFileId: string | null;
+    quantity: number;
+    unitPrice: number | null;
+    lineTotal: number | null;
+}
+export interface PublicOrder {
+    orderId: string;
+    orderNumber: string | null;
+    status: string;
+    paymentStatus: string;
+    fulfillmentFamily: WebsiteFulfillmentFamily | string;
+    delivery: PublicOrderDeliverySummary;
+    payment: PublicOrderPaymentSummary;
+    totals: {
+        subtotal: number;
+        tax: number;
+        discount: number;
+        total: number;
+        totalWithDiscount: number;
+    };
+    items: PublicOrderItem[];
+    nextSteps: string[];
+    createdAt: string;
+    updatedAt: string;
+}
+export interface Order {
+    id: string;
+    orderNumber: string | null;
+    status: string;
+    fulfillmentFamily: string;
+    discount: number;
+    tax: number;
+    subtotal: number;
+    total: number;
+    totalWithDiscount: number;
+    items: OrderItem[];
+    createdAt: string;
+    updatedAt: string;
+}
+export interface OrderItem {
+    id: string;
+    productVariantId: string;
+    quantity: number;
+    productVariant: {
+        sku: string;
+        product: {
+            id: string;
+            name: string;
+        };
+    };
+}
+export interface GetOrdersOptions {
+    limit?: number;
+    offset?: number;
+}
+export type CustomerAddressType = "PRIMARY" | "SHIPPING";
+export interface CustomerAddress {
+    /**
+     * Bacano source identifier. For PRIMARY this is the business party id; for
+     * SHIPPING it is the saved shipping-address id.
+     */
+    id: string;
+    type: CustomerAddressType;
+    label: string | null;
+    /**
+     * Recommended checkout default. A saved primary shipping address wins;
+     * otherwise a complete commercial profile address is the fallback.
+     */
+    isPrimary: boolean;
+    recipientName: string | null;
+    cellphone: string | null;
+    line1: string;
+    line2: string | null;
+    notes: string | null;
+    countryCode: string;
+    countryName: string;
+    /** Canonical geographic code accepted by checkout quote requests. */
+    departmentId: string;
+    departmentCode: string;
+    departmentName: string;
+    /** Canonical geographic code accepted by checkout quote requests. */
+    municipalityId: string;
+    municipalityCode: string;
+    municipalityName: string;
+}
+export interface CustomerProfile {
+    id: string;
+    name: string | null;
+    lastname: string | null;
+    /** Verified primary email synchronized from Clerk. Read-only in Bacano. */
+    email: string | null;
+    /** Canonical mobile/WhatsApp contact in E.164 format, e.g. +573001234567. */
+    cellphone: string | null;
+    /** Optional secondary or national-format phone number. */
+    phone: string | null;
+    address: string | null;
+    city: string | null;
+    state: string | null;
+    country: string | null;
+    birthday: string | null;
+    companyName: string | null;
+}
+export interface CustomerProfileUpdate {
+    name?: string;
+    lastname?: string;
+    /** Canonical mobile/WhatsApp contact in E.164 format, e.g. +573001234567. */
+    cellphone?: string;
+    /** Optional secondary or national-format phone number. */
+    phone?: string;
+    address?: string;
+    addressComplement?: string;
+    /** Canonical country code, normally `CO`. */
+    countryCode?: string;
+    /** Canonical department code returned by checkout location options. */
+    departmentId?: string;
+    /** Canonical municipality code returned by checkout location options. */
+    municipalityId?: string;
+    /** @deprecated Display text is read-only; use municipalityId instead. */
+    city?: string;
+    /** @deprecated Display text is read-only; use departmentId instead. */
+    state?: string;
+    /** @deprecated Display text is read-only; use countryCode instead. */
+    country?: string;
+    birthday?: string;
+}
+export interface AsyncState<T> {
+    data: T | null;
+    loading: boolean;
+    error: Error | null;
+}