@behio/storefront-sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,566 @@
+interface BehioStorefrontConfig {
+    /** API key (public: pk_live_xxx or private: sk_live_xxx) */
+    apiKey: string;
+    /** Backend base URL. Default: https://api.behio.com */
+    baseUrl?: string;
+    /** Default locale for catalog requests. Default: none (uses shop default) */
+    locale?: string;
+    /** Default currency for price resolution. Default: none (uses shop default) */
+    currency?: string;
+    /** Custom fetch implementation (for Node.js < 18 or testing) */
+    fetch?: typeof fetch;
+    /** Request timeout in milliseconds. Default: 30000 (30s) */
+    timeout?: number;
+    /** Number of retries on network/5xx errors. Default: 1 */
+    retries?: number;
+    /** Base delay between retries in ms (multiplied by attempt). Default: 1000 */
+    retryDelay?: number;
+}
+interface PaginatedResponse<T> {
+    items: T[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+}
+interface MessageResponse {
+    message: string;
+}
+interface ShopInfo {
+    id: string;
+    name: string;
+    domain: string;
+    logo?: string;
+    favicon?: string;
+    isActive: boolean;
+    defaultLanguage: string;
+    supportedLanguages: string[];
+    defaultCurrency: string;
+    supportedCurrencies: string[];
+    metaTitle?: string;
+    metaDescription?: string;
+    allowGuestCheckout: boolean;
+}
+interface ProductPrice {
+    amount: number;
+    currency: string;
+    compareAtPrice?: number | null;
+}
+interface ProductVolumePrice {
+    minQuantity: number;
+    price: number;
+    currency?: string;
+}
+interface ProductVariant {
+    id: string;
+    sku: string;
+    name: string;
+    attributes: Record<string, string>;
+    price: ProductPrice;
+    inStock: boolean;
+    stockQuantity?: number;
+}
+interface ProductLabel {
+    id: string;
+    slug: string;
+    name: string;
+    color?: string;
+}
+interface ProductListItem {
+    id: string;
+    slug: string;
+    name: string;
+    shortDescription?: string;
+    sku: string;
+    gtin?: string;
+    price: ProductPrice;
+    inStock: boolean;
+    stockQuantity?: number;
+    image?: string | null;
+    labels: ProductLabel[];
+    isFeatured: boolean;
+}
+interface ProductDetail extends ProductListItem {
+    longDescription?: string;
+    images: Array<{
+        url: string;
+        alt?: string;
+        order: number;
+    }>;
+    categories: Array<{
+        id: string;
+        slug: string;
+        name: string;
+    }>;
+    variants: ProductVariant[];
+    volumePricing: ProductVolumePrice[];
+    customFields: Record<string, unknown>;
+    seo: {
+        title?: string | null;
+        description?: string | null;
+        keywords?: string | null;
+    };
+    productGroups?: Array<{
+        slug: string;
+        name: string;
+        products: ProductListItem[];
+    }>;
+    /** Product weight (from warehouse item) */
+    weight?: number | null;
+    /** Weight unit: GRAM, KILOGRAM, TONNE */
+    weightUnit?: string | null;
+}
+interface Category {
+    id: string;
+    slug: string;
+    name: string;
+    description?: string;
+    imageUrl?: string;
+    children: Category[];
+    productCount?: number;
+}
+interface CategoryDetail extends Category {
+    seoTitle?: string;
+    seoDescription?: string;
+}
+type DataGroupFieldType = "TEXT" | "NUMBER" | "DECIMAL" | "BOOLEAN" | "DATE" | "TIME" | "DATETIME" | "PERCENTAGE" | "MONEY" | "ASSET" | "ITEM_LIST" | "DYNAMIC_NUMBER_CALCULATION_FROM_OTHERS";
+interface FilterField {
+    key: string;
+    name: string;
+    type: DataGroupFieldType | string;
+    groupKey: string;
+    groupName: string;
+    values?: string[];
+}
+declare const ProductSort: {
+    readonly PRICE_ASC: "price_asc";
+    readonly PRICE_DESC: "price_desc";
+    readonly NAME_ASC: "name_asc";
+    readonly NAME_DESC: "name_desc";
+    readonly NEWEST: "newest";
+    readonly FEATURED: "featured";
+};
+type ProductSortValue = (typeof ProductSort)[keyof typeof ProductSort];
+declare const OrderStatuses: {
+    readonly PENDING: "PENDING";
+    readonly CONFIRMED: "CONFIRMED";
+    readonly PROCESSING: "PROCESSING";
+    readonly SHIPPED: "SHIPPED";
+    readonly DELIVERED: "DELIVERED";
+    readonly CANCELLED: "CANCELLED";
+    readonly REFUNDED: "REFUNDED";
+};
+declare const PaymentStatuses: {
+    readonly UNPAID: "UNPAID";
+    readonly PAID: "PAID";
+    readonly PARTIALLY_REFUNDED: "PARTIALLY_REFUNDED";
+    readonly REFUNDED: "REFUNDED";
+};
+declare const FulfillmentStatuses: {
+    readonly UNFULFILLED: "UNFULFILLED";
+    readonly PARTIALLY_FULFILLED: "PARTIALLY_FULFILLED";
+    readonly FULFILLED: "FULFILLED";
+};
+declare const AddressTypes: {
+    readonly SHIPPING: "SHIPPING";
+    readonly BILLING: "BILLING";
+};
+type AddressType = (typeof AddressTypes)[keyof typeof AddressTypes];
+interface ProductsQuery {
+    page?: number;
+    limit?: number;
+    category?: string;
+    label?: string;
+    priceMin?: number;
+    priceMax?: number;
+    currency?: string;
+    locale?: string;
+    sort?: ProductSortValue;
+    inStock?: boolean;
+    search?: string;
+    customFields?: Record<string, unknown>;
+}
+interface AuthTokens {
+    accessToken: string;
+    refreshToken: string;
+}
+interface RegisterInput {
+    email: string;
+    password: string;
+    firstName?: string;
+    lastName?: string;
+}
+interface LoginInput {
+    email: string;
+    password: string;
+}
+interface CartItemProduct {
+    slug: string;
+    name: string;
+    sku: string;
+    imageUrl?: string;
+    inStock: boolean;
+    currentPrice: number;
+}
+interface CartItem {
+    id: string;
+    product: CartItemProduct;
+    quantity: number;
+    unitPrice: number;
+    totalPrice: number;
+    priceChanged: boolean;
+    volumePriceApplied: boolean;
+}
+interface CartDiscount {
+    code: string;
+    type: string;
+    value: number;
+}
+interface Cart {
+    id: string;
+    sessionToken?: string;
+    items: CartItem[];
+    subtotal: number;
+    discountTotal: number;
+    discount?: CartDiscount;
+    grandTotal: number;
+    currency: string;
+    itemCount: number;
+}
+interface AddToCartInput {
+    /** Product ID (eshop product ID or warehouse item ID) */
+    productId: string;
+    quantity: number;
+}
+interface CheckoutAddress {
+    firstName: string;
+    lastName: string;
+    company?: string;
+    street: string;
+    city: string;
+    zip: string;
+    country: string;
+    phone?: string;
+}
+interface CheckoutInput {
+    shippingAddress: CheckoutAddress;
+    billingAddress: CheckoutAddress;
+    email: string;
+    phone?: string;
+    customerNote?: string;
+}
+type OrderStatus = (typeof OrderStatuses)[keyof typeof OrderStatuses];
+type PaymentStatus = (typeof PaymentStatuses)[keyof typeof PaymentStatuses];
+type FulfillmentStatus = (typeof FulfillmentStatuses)[keyof typeof FulfillmentStatuses];
+interface OrderListItem {
+    id: string;
+    orderNumber: string;
+    status: OrderStatus;
+    paymentStatus: PaymentStatus;
+    grandTotal: number;
+    currency: string;
+    itemCount: number;
+    createdAt: number;
+}
+interface OrderItem {
+    productName: string;
+    sku: string;
+    imageUrl?: string;
+    quantity: number;
+    unitPrice: number;
+    totalPrice: number;
+    totalPriceWithTax: number;
+}
+interface OrderStatusHistory {
+    fromStatus?: OrderStatus;
+    toStatus: OrderStatus;
+    note?: string;
+    changedBy?: string;
+    createdAt: number;
+}
+interface OrderDetail extends OrderListItem {
+    items: OrderItem[];
+    shippingAddress: CheckoutAddress;
+    billingAddress: CheckoutAddress;
+    email: string;
+    phone?: string;
+    customerNote?: string;
+    subtotal: number;
+    taxTotal: number;
+    shippingTotal: number;
+    discountTotal: number;
+    fulfillmentStatus: FulfillmentStatus;
+    statusHistory: OrderStatusHistory[];
+    trackingToken?: string;
+}
+interface CustomerProfile {
+    id: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    emailVerified: boolean;
+}
+interface CustomerAddress {
+    id: string;
+    type: AddressType;
+    isDefault: boolean;
+    firstName: string;
+    lastName: string;
+    company?: string;
+    street: string;
+    city: string;
+    zip: string;
+    country: string;
+    phone?: string;
+}
+interface Page {
+    slug: string;
+    title: string;
+    isActive: boolean;
+}
+interface PageDetail {
+    slug: string;
+    title: string;
+    content: unknown;
+    seoTitle?: string;
+    seoDescription?: string;
+}
+type BehioErrorCode = "UNAUTHORIZED" | "FORBIDDEN" | "NOT_FOUND" | "VALIDATION_ERROR" | "CONFLICT" | "RATE_LIMITED" | "CART_EMPTY" | "PRODUCT_NOT_FOUND" | "INVALID_CREDENTIALS" | "INVALID_DISCOUNT" | "DISCOUNT_EXPIRED" | "TOKEN_EXPIRED" | "TOKEN_INVALID" | "EMAIL_ALREADY_EXISTS" | "ORDER_NOT_CANCELLABLE" | "INTERNAL_ERROR" | "NETWORK_ERROR" | "TIMEOUT" | "UNKNOWN";
+declare class BehioApiError extends Error {
+    readonly code: BehioErrorCode;
+    readonly status: number;
+    readonly body: unknown;
+    readonly isRetryable: boolean;
+    constructor(status: number, body: unknown, message?: string);
+    static resolveCode(status: number, body: unknown): BehioErrorCode;
+    /** Check if this is a specific error type */
+    is(code: BehioErrorCode): boolean;
+}
+declare class BehioNetworkError extends Error {
+    readonly code: "NETWORK_ERROR" | "TIMEOUT";
+    readonly isRetryable = true;
+    constructor(message: string, isTimeout?: boolean);
+}
+type BehioEventType = "auth:login" | "auth:logout" | "auth:token-refresh" | "auth:token-refresh-failed" | "cart:updated" | "cart:cleared" | "order:created" | "error" | "request" | "response" | "rate-limit-warning";
+type BehioEventHandler = (data?: unknown) => void;
+interface RequestInterceptorConfig {
+    url: string;
+    method: string;
+    headers: Record<string, string>;
+    body?: string;
+}
+interface RequestInterceptor {
+    (config: RequestInterceptorConfig): RequestInterceptorConfig | Promise<RequestInterceptorConfig>;
+}
+interface ResponseInterceptorData {
+    status: number;
+    data: unknown;
+    headers: Headers;
+}
+interface ResponseInterceptor {
+    (response: ResponseInterceptorData): void | Promise<void>;
+}
+
+declare class BehioStorefront {
+    private baseUrl;
+    private apiKey;
+    private defaultLocale?;
+    private defaultCurrency?;
+    private fetchFn;
+    private timeout;
+    private retries;
+    private retryDelay;
+    private accessToken?;
+    private refreshToken?;
+    private isRefreshing;
+    private refreshPromise;
+    private cartSession?;
+    private listeners;
+    private requestInterceptors;
+    private responseInterceptors;
+    private rateLimitRemaining;
+    private rateLimitReset;
+    constructor(config: BehioStorefrontConfig);
+    readonly catalog: CatalogModule;
+    readonly auth: AuthModule;
+    readonly cart: CartModule;
+    readonly checkout: CheckoutModule;
+    readonly orders: OrdersModule;
+    readonly customer: CustomerModule;
+    readonly pages: PagesModule;
+    /** Get basic shop info */
+    getShopInfo(): Promise<ShopInfo>;
+    /** Set auth tokens (e.g. from localStorage) */
+    setTokens(tokens: {
+        accessToken: string;
+        refreshToken: string;
+    }): void;
+    /** Clear auth tokens */
+    clearTokens(): void;
+    /** Get current access token */
+    getAccessToken(): string | undefined;
+    /** Get current refresh token */
+    getRefreshToken(): string | undefined;
+    /** Set cart session token (e.g. from cookie) */
+    setCartSession(token: string): void;
+    /** Get cart session token */
+    getCartSession(): string | undefined;
+    /** Clear cart session */
+    clearCartSession(): void;
+    /** Subscribe to SDK events. Returns an unsubscribe function. */
+    on(event: BehioEventType, handler: BehioEventHandler): () => void;
+    /** @internal Emit an event (fire-and-forget, handler errors are swallowed) */
+    emit(event: BehioEventType, data?: unknown): void;
+    /** Add a request interceptor. Returns an unsubscribe function. */
+    addRequestInterceptor(fn: RequestInterceptor): () => void;
+    /** Add a response interceptor. Returns an unsubscribe function. */
+    addResponseInterceptor(fn: ResponseInterceptor): () => void;
+    /** Get current rate limit info from latest response headers */
+    getRateLimitInfo(): {
+        remaining: number | null;
+        reset: number | null;
+    };
+    private handleTokenRefresh;
+    /** @internal */
+    request<T>(method: string, path: string, options?: {
+        body?: unknown;
+        query?: Record<string, string | number | boolean | undefined>;
+        auth?: boolean;
+        signal?: AbortSignal;
+        /** @internal Prevents infinite refresh loops */
+        _isRetryAfterRefresh?: boolean;
+    }): Promise<T>;
+}
+declare class CatalogModule {
+    private client;
+    constructor(client: BehioStorefront);
+    /** List products with filtering, pagination, search */
+    getProducts(query?: ProductsQuery): Promise<PaginatedResponse<ProductListItem>>;
+    /** Get product detail by slug */
+    getProduct(slug: string, options?: {
+        locale?: string;
+        currency?: string;
+    }): Promise<ProductDetail>;
+    /** Get category tree */
+    getCategories(locale?: string): Promise<{
+        categories: Category[];
+    }>;
+    /** Get category detail by slug */
+    getCategory(slug: string, locale?: string): Promise<CategoryDetail>;
+    /** Get products in a category */
+    getCategoryProducts(slug: string, query?: ProductsQuery): Promise<PaginatedResponse<ProductListItem>>;
+    /** Get all labels */
+    getLabels(locale?: string): Promise<{
+        labels: ProductLabel[];
+    }>;
+    /** Get featured products */
+    getFeatured(options?: {
+        locale?: string;
+        currency?: string;
+    }): Promise<PaginatedResponse<ProductListItem>>;
+    /** Get available filter fields for dynamic filter UI */
+    getFilters(): Promise<{
+        filters: FilterField[];
+    }>;
+    /** Search products */
+    search(query: string, options?: {
+        page?: number;
+        limit?: number;
+    }): Promise<PaginatedResponse<ProductListItem>>;
+}
+declare class AuthModule {
+    private client;
+    constructor(client: BehioStorefront);
+    /** Register a new customer */
+    register(input: RegisterInput): Promise<AuthTokens>;
+    /** Login with email and password */
+    login(input: LoginInput): Promise<AuthTokens>;
+    /** Refresh access token using refresh token */
+    refresh(refreshToken?: string): Promise<AuthTokens>;
+    /** Logout (invalidate refresh token) */
+    logout(refreshToken?: string): Promise<MessageResponse>;
+    /** Request password reset email */
+    forgotPassword(email: string): Promise<MessageResponse>;
+    /** Reset password with token */
+    resetPassword(token: string, newPassword: string): Promise<MessageResponse>;
+    /** Verify email with token */
+    verifyEmail(token: string): Promise<MessageResponse>;
+    /** Check if user is logged in (has access token) */
+    isLoggedIn(): boolean;
+}
+declare class CartModule {
+    private client;
+    constructor(client: BehioStorefront);
+    /** Get current cart */
+    get(): Promise<Cart>;
+    /** Add item to cart */
+    addItem(input: AddToCartInput): Promise<Cart & {
+        newSessionToken?: string;
+    }>;
+    /** Update item quantity */
+    updateQuantity(itemId: string, quantity: number): Promise<Cart>;
+    /** Remove item from cart */
+    removeItem(itemId: string): Promise<Cart>;
+    /** Clear entire cart */
+    clear(): Promise<void>;
+    /** Merge anonymous cart into authenticated customer cart */
+    merge(): Promise<Cart>;
+    /** Apply discount code */
+    applyDiscount(code: string): Promise<Cart>;
+    /** Remove discount code */
+    removeDiscount(): Promise<Cart>;
+}
+declare class CheckoutModule {
+    private client;
+    constructor(client: BehioStorefront);
+    /** Create order from cart */
+    createOrder(input: CheckoutInput): Promise<OrderDetail>;
+}
+declare class OrdersModule {
+    private client;
+    constructor(client: BehioStorefront);
+    /** List customer orders (requires auth) */
+    list(options?: {
+        page?: number;
+        limit?: number;
+    }): Promise<PaginatedResponse<OrderListItem>>;
+    /** Get order detail (requires auth) */
+    get(orderNumber: string): Promise<OrderDetail>;
+    /** Cancel a PENDING order (requires auth) */
+    cancel(orderNumber: string): Promise<OrderDetail>;
+    /** Track order by tracking token (no auth required) */
+    track(trackingToken: string): Promise<OrderDetail>;
+}
+declare class CustomerModule {
+    private client;
+    constructor(client: BehioStorefront);
+    /** Get customer profile */
+    getProfile(): Promise<CustomerProfile>;
+    /** Update customer profile */
+    updateProfile(data: Partial<Pick<CustomerProfile, "firstName" | "lastName" | "phone">>): Promise<CustomerProfile>;
+    /** Change password */
+    changePassword(currentPassword: string, newPassword: string): Promise<MessageResponse>;
+    /** List addresses */
+    getAddresses(): Promise<{
+        items: CustomerAddress[];
+    }>;
+    /** Create address */
+    createAddress(address: Omit<CustomerAddress, "id">): Promise<CustomerAddress>;
+    /** Update address */
+    updateAddress(addressId: string, data: Partial<CustomerAddress>): Promise<CustomerAddress>;
+    /** Delete address */
+    deleteAddress(addressId: string): Promise<void>;
+}
+declare class PagesModule {
+    private client;
+    constructor(client: BehioStorefront);
+    /** List CMS pages */
+    list(locale?: string): Promise<{
+        pages: Page[];
+    }>;
+    /** Get page by slug */
+    get(slug: string, locale?: string): Promise<PageDetail>;
+}
+
+export { type AddToCartInput, type AddressType, AddressTypes, type AuthTokens, BehioApiError, type BehioErrorCode, type BehioEventHandler, type BehioEventType, BehioNetworkError, BehioStorefront, type BehioStorefrontConfig, type Cart, type CartDiscount, type CartItem, type CartItemProduct, type Category, type CategoryDetail, type CheckoutAddress, type CheckoutInput, type CustomerAddress, type CustomerProfile, type DataGroupFieldType, type FilterField, type FulfillmentStatus, FulfillmentStatuses, type LoginInput, type MessageResponse, type OrderDetail, type OrderItem, type OrderListItem, type OrderStatus, type OrderStatusHistory, OrderStatuses, type Page, type PageDetail, type PaginatedResponse, type PaymentStatus, PaymentStatuses, type ProductDetail, type ProductLabel, type ProductListItem, type ProductPrice, ProductSort, type ProductSortValue, type ProductVariant, type ProductVolumePrice, type ProductsQuery, type RegisterInput, type RequestInterceptor, type RequestInterceptorConfig, type ResponseInterceptor, type ResponseInterceptorData, type ShopInfo };

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+
+
+
+
+
+var _chunk26WZOAWPjs = require('./chunk-26WZOAWP.js');
+
+
+
+
+
+
+
+
+
+exports.AddressTypes = _chunk26WZOAWPjs.AddressTypes; exports.BehioApiError = _chunk26WZOAWPjs.BehioApiError; exports.BehioNetworkError = _chunk26WZOAWPjs.BehioNetworkError; exports.BehioStorefront = _chunk26WZOAWPjs.BehioStorefront; exports.FulfillmentStatuses = _chunk26WZOAWPjs.FulfillmentStatuses; exports.OrderStatuses = _chunk26WZOAWPjs.OrderStatuses; exports.PaymentStatuses = _chunk26WZOAWPjs.PaymentStatuses; exports.ProductSort = _chunk26WZOAWPjs.ProductSort;

package/dist/index.mjs

@@ -0,0 +1,20 @@
+import {
+  AddressTypes,
+  BehioApiError,
+  BehioNetworkError,
+  BehioStorefront,
+  FulfillmentStatuses,
+  OrderStatuses,
+  PaymentStatuses,
+  ProductSort
+} from "./chunk-3OJEEMLI.mjs";
+export {
+  AddressTypes,
+  BehioApiError,
+  BehioNetworkError,
+  BehioStorefront,
+  FulfillmentStatuses,
+  OrderStatuses,
+  PaymentStatuses,
+  ProductSort
+};