@bacano/sdk 1.0.0

package/client.d.ts

@@ -0,0 +1,96 @@
+import type { BacanoClientConfig, BacanoClientContext, Brand, Cart, CartItem, CatalogAttributeList, CatalogPageResult, CatalogCategoryList, CheckoutResult, CheckoutSubmission, ContentEntry, ProductContentBlock, CustomerAddress, CustomerProfile, CustomerProfileUpdate, GetAttributeListOptions, GetCatalogPageOptions, GetCategoryListOptions, GetContentOptions, GetOrdersOptions, GetProductFiltersOptions, GetProductSeoEntriesOptions, GetProductRecommendationsOptions, ProductRecommendationsResult, GetProductsOptions, GetSearchSuggestionsOptions, Order, Product, ProductAvailability, ProductCategory, ProductFilters, ProductSeoEntriesResult, PublicOrder, PublicOrderLookupInput, WaitForPublicOrderPaymentInput, SearchSuggestion, StartGuestCheckoutInput, WebsiteCheckoutAddress, WebsiteCheckoutItem, WebsiteCouponActionResult, WebsiteDeliveryOption, WebsiteFreeShippingProgress, WebsiteFulfillmentFamily, WebsiteGuestContact, WebsiteLocationOptions, WebsitePaymentMethod, WebsitePaymentOption, WebsitePaymentSessionResult, WebsiteShippingQuote, WebsiteShippingPolicy } from "./types";
+export interface BacanoClient {
+    /** Initialize the client and resolve its website context. */
+    init(): Promise<void>;
+    /** Get the resolved website context (company_id, chain_id, etc.) */
+    getContext(): BacanoClientContext;
+    auth: {
+        /** Returns the current token supplied by the storefront auth provider. */
+        getAccessToken(): Promise<string | null>;
+        /** Resolves whether the storefront currently has a buyer token. */
+        isAuthenticated(): Promise<boolean>;
+    };
+    catalog: {
+        getCatalogPage(opts: GetCatalogPageOptions): Promise<CatalogPageResult>;
+        getProductSeoEntries(opts?: GetProductSeoEntriesOptions): Promise<ProductSeoEntriesResult>;
+        getProductRecommendations(opts: GetProductRecommendationsOptions): Promise<ProductRecommendationsResult>;
+        getProducts(opts?: GetProductsOptions): Promise<Product[]>;
+        getProduct(productId: string): Promise<Product | null>;
+        getProductBySlug(slug: string): Promise<Product | null>;
+        getCategories(): Promise<ProductCategory[]>;
+        getCategoryList(opts: GetCategoryListOptions): Promise<CatalogCategoryList | null>;
+        getAttributeList(opts: GetAttributeListOptions): Promise<CatalogAttributeList | null>;
+        getBrands(): Promise<Brand[]>;
+        getProductFilters(opts?: GetProductFiltersOptions): Promise<ProductFilters>;
+        getSearchSuggestions(opts: GetSearchSuggestionsOptions): Promise<SearchSuggestion[]>;
+        checkAvailability(productVariantIds: string[]): Promise<ProductAvailability[]>;
+    };
+    content: {
+        getByKey(key: string, opts?: GetContentOptions): Promise<ContentEntry | null>;
+        getByCategory(categoryKey: string, opts?: GetContentOptions): Promise<ContentEntry[]>;
+        getByTag(tag: string, opts?: GetContentOptions): Promise<ContentEntry[]>;
+        getForProduct(productId: string, opts?: GetContentOptions): Promise<ProductContentBlock[]>;
+    };
+    cart: {
+        getOrCreate(contact?: WebsiteGuestContact, fulfillmentFamily?: WebsiteFulfillmentFamily): Promise<Cart>;
+        startCheckout(input: StartGuestCheckoutInput): Promise<Cart>;
+        get(): Promise<Cart | null>;
+        setItem(productVariantId: string, quantity: number): Promise<Cart>;
+        addItem(productVariantId: string, quantity: number): Promise<CartItem>;
+        updateItem(cartItemId: string, quantity: number): Promise<{
+            id: string;
+            quantity: number;
+        }>;
+        removeItem(cartItemId: string): Promise<Cart>;
+    };
+    checkout: {
+        getLocationOptions(): Promise<WebsiteLocationOptions>;
+        getDeliveryOptions(): Promise<WebsiteDeliveryOption[]>;
+        getShippingQuotes(input: {
+            address: WebsiteCheckoutAddress;
+            items?: WebsiteCheckoutItem[];
+        }): Promise<WebsiteShippingQuote[]>;
+        getShippingPolicy(): Promise<WebsiteShippingPolicy>;
+        getFreeShippingProgress(input: {
+            items: WebsiteCheckoutItem[];
+        }): Promise<WebsiteFreeShippingProgress>;
+        getPaymentMethods(): Promise<WebsitePaymentMethod[]>;
+        getPaymentOptions(input: {
+            fulfillmentFamily: "PICKUP" | "SHIPPING";
+        }): Promise<WebsitePaymentOption[]>;
+        validateCoupon(input: {
+            code: string;
+        }): Promise<WebsiteCouponActionResult>;
+        applyCoupon(input: {
+            code: string;
+        }): Promise<WebsiteCouponActionResult>;
+        removeCoupon(input: {
+            couponId: string;
+        }): Promise<WebsiteCouponActionResult>;
+        submit(input: CheckoutSubmission): Promise<CheckoutResult>;
+        createPaymentSession(input: {
+            orderId?: string;
+            publicOrderToken?: string;
+            paymentMethodId: string;
+            returnUrl: string;
+        }): Promise<WebsitePaymentSessionResult>;
+        reconcilePaymentSession(input: {
+            orderId: string;
+            publicOrderToken: string;
+            paymentSessionId: string;
+            gatewayTransactionId: string;
+        }): Promise<WebsitePaymentSessionResult>;
+    };
+    orders: {
+        list(opts?: GetOrdersOptions): Promise<Order[]>;
+        get(orderId: string): Promise<Order | null>;
+        getPublicOrder(input: PublicOrderLookupInput): Promise<PublicOrder | null>;
+        waitForPayment(input: WaitForPublicOrderPaymentInput): Promise<PublicOrder>;
+    };
+    profile: {
+        get(): Promise<CustomerProfile>;
+        getAddresses(): Promise<CustomerAddress[]>;
+        update(data: CustomerProfileUpdate): Promise<CustomerProfile>;
+    };
+}
+export declare function createBacanoClient(config: BacanoClientConfig): BacanoClient;

package/errors.d.ts

@@ -0,0 +1,24 @@
+export declare class WebsiteError extends Error {
+    readonly code: string;
+    constructor(message: string, code?: string);
+}
+export declare class NotInitializedError extends WebsiteError {
+    constructor();
+}
+export declare class AuthError extends WebsiteError {
+    constructor(message: string);
+}
+export declare class CheckoutError extends WebsiteError {
+    readonly errors: string[];
+    constructor(errors: string[]);
+}
+export declare class GraphQLRequestError extends WebsiteError {
+    readonly graphqlErrors: Array<{
+        message: string;
+        extensions?: Record<string, unknown>;
+    }>;
+    constructor(errors: Array<{
+        message: string;
+        extensions?: Record<string, unknown>;
+    }>);
+}