@commercengine/js 0.3.4 → 0.4.0

package/dist/index.d.cts

@@ -1,456 +0,0 @@
-//#region src/types.d.ts
-/**
- * Commerce Engine Checkout - Type Definitions
- *
- * @commercengine/js
- *
- * This is the single source of truth for checkout configuration.
- * The checkout app parses these from URL parameters.
- */
-/**
- * Authentication mode
- * - 'managed': Checkout manages token lifecycle (refresh, storage)
- * - 'provided': Parent manages tokens. Checkout uses in-memory only, syncs via events
- */
-type AuthMode = "managed" | "provided";
-/**
- * Item to add to cart
- */
-interface AddToCartItem {
-  /**
-   * Product ID (required)
-   */
-  productId: string;
-  /**
-   * Variant ID (required, null for non-variant products)
-   */
-  variantId: string | null;
-  /**
-   * Quantity to add
-   * @default 1
-   */
-  quantity?: number;
-}
-/**
- * Quick buy configuration for initialization
- * Adds a product to cart when checkout initializes
- */
-interface QuickBuyConfig {
-  /**
-   * Product ID (required)
-   */
-  productId: string;
-  /**
-   * Variant ID (required, null for non-variant products)
-   */
-  variantId: string | null;
-  /**
-   * Quantity to add
-   * @default 1
-   */
-  quantity?: number;
-}
-/**
- * Session behavior mode
- * - 'continue-existing': Add quick-buy item to existing cart (default)
- * - 'force-new': Clear cart and start fresh
- */
-type SessionMode = "continue-existing" | "force-new";
-/**
- * Feature flags for checkout
- * All features are enabled by default
- */
-interface CheckoutFeatures {
-  /**
-   * Enable loyalty points redemption
-   * @default true
-   */
-  loyalty?: boolean;
-  /**
-   * Enable coupon/promo codes
-   * @default true
-   */
-  coupons?: boolean;
-  /**
-   * Enable collect-in-store option
-   * @default false
-   */
-  collectInStore?: boolean;
-  /**
-   * Enable free shipping progress tracker in cart
-   * @default true
-   */
-  freeShippingProgress?: boolean;
-  /**
-   * Enable product recommendations in cart
-   * @default true
-   */
-  productRecommendations?: boolean;
-}
-/**
- * Environment for checkout
- * - 'production': Uses checkout.commercengine.com
- * - 'staging': Uses checkout.staging.commercengine.com
- */
-type Environment = "production" | "staging";
-/**
- * Configuration for initializing checkout
- *
- * Either provide `url` directly (for local development) or
- * provide `storeId` + `apiKey` (for production).
- */
-interface CheckoutConfig {
-  /**
-   * Environment to use for checkout URL resolution
-   * - 'production': checkout.commercengine.com (default)
-   * - 'staging': staging.checkout.commercengine.com
-   *
-   * For local development, use the `url` option instead.
-   */
-  environment?: Environment;
-  /**
-   * Direct checkout URL (overrides environment detection)
-   * If provided, storeId and apiKey are optional.
-   * @example "http://localhost:8080"
-   */
-  url?: string;
-  /**
-   * Your Commerce Engine Store ID
-   * Required if `url` is not provided.
-   * @example "store_abc123"
-   */
-  storeId?: string;
-  /**
-   * Your Commerce Engine API Key
-   * Required if `url` is not provided.
-   * @example "ak_test_xyz789"
-   */
-  apiKey?: string;
-  /**
-   * Theme preference
-   * @default "system"
-   */
-  theme?: "light" | "dark" | "system";
-  /**
-   * Appearance customization
-   */
-  appearance?: {
-    /**
-     * Z-index for the checkout overlay
-     * @default 99999
-     */
-    zIndex?: number;
-  };
-  /**
-   * Authentication mode
-   * - 'managed': Checkout manages token lifecycle (default)
-   * - 'provided': Parent manages tokens, checkout uses in-memory only
-   * @default "managed"
-   */
-  authMode?: AuthMode;
-  /**
-   * Initial access token (if user already logged in on parent site)
-   */
-  accessToken?: string;
-  /**
-   * Initial refresh token
-   */
-  refreshToken?: string;
-  /**
-   * Quick buy configuration for "Buy Now" flows
-   * When provided, adds the product to cart on initialization
-   */
-  quickBuy?: QuickBuyConfig;
-  /**
-   * Session behavior when quick buy is used
-   * @default "continue-existing"
-   */
-  sessionMode?: SessionMode;
-  /**
-   * Auto-detect quick buy params from parent page URL
-   * When enabled, SDK parses window.location.search for:
-   * - product_id, variant_id, qty/quantity, session_mode
-   * Useful for ad-driven traffic to embedded checkout pages
-   * @default false
-   */
-  autoDetectQuickBuy?: boolean;
-  /**
-   * Feature flags to enable/disable checkout features
-   * All features are enabled by default
-   */
-  features?: CheckoutFeatures;
-  /**
-   * Called when checkout iframe is loaded and ready
-   */
-  onReady?: () => void;
-  /**
-   * Called when checkout drawer is opened
-   */
-  onOpen?: () => void;
-  /**
-   * Called when checkout is closed (all drawers closed)
-   */
-  onClose?: () => void;
-  /**
-   * Called when order is completed successfully
-   */
-  onComplete?: (order: OrderData) => void;
-  /**
-   * Called when cart state changes (items added/removed/updated)
-   * Use this to update cart badge count on parent site
-   */
-  onCartUpdate?: (cart: CartData) => void;
-  /**
-   * Called when user logs in via checkout
-   */
-  onLogin?: (data: AuthLoginData) => void;
-  /**
-   * Called when user logs out (receives new anonymous tokens)
-   */
-  onLogout?: (data: AuthLogoutData) => void;
-  /**
-   * Called when tokens are auto-refreshed by SDK
-   */
-  onTokenRefresh?: (data: AuthRefreshData) => void;
-  /**
-   * Called when session is corrupted and SDK clears all tokens.
-   * User needs to re-authenticate.
-   */
-  onSessionError?: () => void;
-  /**
-   * Called when checkout encounters a configuration error
-   * This happens when credentials are missing or invalid.
-   * The error drawer will still be shown, but you can use this
-   * callback to log the error or show custom UI.
-   */
-  onError?: (error: ErrorData) => void;
-}
-/**
- * Channel information from token
- */
-interface Channel {
-  id: string;
-  name: string;
-  type: string;
-}
-/**
- * User information decoded from JWT token
- * Matches @commercengine/storefront-sdk UserInfo 1:1
- */
-interface UserInfo {
-  id: string;
-  email: string | null;
-  phone: string | null;
-  username: string;
-  firstName: string | null;
-  lastName: string | null;
-  storeId: string;
-  isLoggedIn: boolean;
-  isAnonymous: boolean;
-  customerId: string | null;
-  customerGroupId: string | null;
-  anonymousId: string;
-  channel: Channel;
-  tokenExpiry: Date;
-  tokenIssuedAt: Date;
-}
-/**
- * Login method used for authentication
- */
-type LoginMethod = "whatsapp" | "phone" | "email";
-/**
- * Cart state data emitted on cart:updated event
- */
-interface CartData {
-  /** Number of items in cart */
-  count: number;
-  /** Cart subtotal amount */
-  total: number;
-  /** Currency code (e.g., "INR", "USD") */
-  currency: string;
-}
-/**
- * Order data emitted on checkout:complete event
- */
-interface OrderData {
-  /** Order ID */
-  id: string;
-  /** Human-readable order number */
-  orderNumber: string;
-}
-/**
- * Data emitted on login event
- */
-interface AuthLoginData {
-  accessToken: string;
-  refreshToken?: string;
-  user?: UserInfo;
-  loginMethod?: LoginMethod;
-}
-/**
- * Data emitted on logout event
- */
-interface AuthLogoutData {
-  accessToken: string;
-  refreshToken?: string;
-  user?: UserInfo;
-}
-/**
- * Data emitted on token refresh event
- */
-interface AuthRefreshData {
-  accessToken: string;
-  refreshToken?: string;
-}
-/**
- * Error data emitted on checkout:error event
- */
-interface ErrorData {
-  /** Error message */
-  message: string;
-}
-/**
- * Events emitted by checkout
- */
-type CheckoutEventType = "ready" | "open" | "close" | "complete" | "error" | "cart:updated" | "auth:login" | "auth:logout" | "auth:refresh" | "auth:session-error";
-/**
- * Event listener function type
- */
-type EventListener<T = unknown> = (data: T) => void;
-//#endregion
-//#region src/events.d.ts
-declare class EventEmitter {
-  private listeners;
-  /**
-   * Subscribe to an event
-   */
-  on<T = unknown>(event: CheckoutEventType, listener: EventListener<T>): void;
-  /**
-   * Unsubscribe from an event
-   */
-  off<T = unknown>(event: CheckoutEventType, listener: EventListener<T>): void;
-  /**
-   * Subscribe to an event (once)
-   */
-  once<T = unknown>(event: CheckoutEventType, listener: EventListener<T>): void;
-  /**
-   * Emit an event to all subscribers
-   */
-  protected emit<T = unknown>(event: CheckoutEventType, data?: T): void;
-  /**
-   * Remove all listeners
-   */
-  protected removeAllListeners(): void;
-}
-//#endregion
-//#region src/checkout.d.ts
-declare class Checkout extends EventEmitter {
-  private config;
-  private iframe;
-  private isReady;
-  private isOpen;
-  private cartState;
-  private boundMessageHandler;
-  private hasQuickBuyParams;
-  constructor(config: CheckoutConfig);
-  private initialize;
-  /**
-   * Remove quick buy params from the parent URL to prevent duplicate adds on refresh
-   * Uses replaceState to avoid adding to browser history
-   */
-  private cleanQuickBuyParamsFromUrl;
-  private handleMessage;
-  private handleReady;
-  private handleError;
-  private handleOpen;
-  private handleClose;
-  private handleComplete;
-  private handleCartUpdate;
-  private handleLogin;
-  private handleLogout;
-  private handleTokenRefresh;
-  private handleSessionError;
-  /**
-   * Open the cart drawer
-   */
-  openCart(): void;
-  /**
-   * Open the checkout drawer directly (e.g., for Buy Now flow)
-   */
-  openCheckout(): void;
-  /**
-   * Close the checkout overlay
-   */
-  close(): void;
-  /**
-   * Update authentication tokens
-   * Use this when user logs in/out on the parent site
-   */
-  updateTokens(accessToken: string, refreshToken?: string): void;
-  /**
-   * Add an item to cart and open the cart drawer
-   *
-   * @param productId - Product ID (required)
-   * @param variantId - Variant ID (required, null for non-variant products)
-   * @param quantity - Quantity to add (default: 1)
-   */
-  addToCart(productId: string, variantId: string | null, quantity?: number): void;
-  /**
-   * Get current cart state
-   */
-  getCart(): CartData;
-  /**
-   * Check if checkout is ready
-   */
-  get ready(): boolean;
-  /**
-   * Check if checkout overlay is currently open
-   */
-  get open(): boolean;
-  /**
-   * Subscribe to an event
-   * @override EventEmitter.on with typed overloads
-   */
-  on(event: "ready", listener: EventListener<void>): void;
-  on(event: "open", listener: EventListener<void>): void;
-  on(event: "close", listener: EventListener<void>): void;
-  on(event: "complete", listener: EventListener<OrderData>): void;
-  on(event: "cart:updated", listener: EventListener<CartData>): void;
-  on(event: "auth:login", listener: EventListener<AuthLoginData>): void;
-  on(event: "auth:logout", listener: EventListener<AuthLogoutData>): void;
-  on(event: "auth:refresh", listener: EventListener<AuthRefreshData>): void;
-  on(event: "auth:session-error", listener: EventListener<void>): void;
-  /**
-   * Destroy the checkout instance
-   * Removes iframe and cleans up event listeners
-   */
-  destroy(): void;
-}
-//#endregion
-//#region src/index.d.ts
-/**
- * Global Commercengine object interface
- */
-interface CommercengineGlobal {
-  /**
-   * Initialize checkout with configuration
-   * @returns Promise that resolves to Checkout instance
-   */
-  init: (config: CheckoutConfig) => Promise<Checkout>;
-  /**
-   * Callback invoked when script has loaded
-   * Set this BEFORE including the script to be notified when ready
-   */
-  onLoad?: () => void;
-  /**
-   * Current checkout instance (if initialized)
-   */
-  instance?: Checkout;
-}
-/**
- * Global Commercengine namespace
- */
-declare const Commercengine: CommercengineGlobal;
-//#endregion
-export { type AddToCartItem, type AuthLoginData, type AuthLogoutData, type AuthMode, type AuthRefreshData, type CartData, type Channel, Checkout, type CheckoutConfig, type CheckoutEventType, type CheckoutFeatures, Commercengine, Commercengine as default, type Environment, type ErrorData, type LoginMethod, type OrderData, type QuickBuyConfig, type SessionMode, type UserInfo };
-//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/types.ts","../src/events.ts","../src/checkout.ts","../src/index.ts"],"mappings":";;AAkBA;;;;;AASA;;;;;;;KATY,QAAA;;AA+BZ;;UAtBiB,aAAA;EAsBc;;;EAlB7B,SAAA;EAiCQ;;AAYV;EAxCE,SAAA;;;;AAkDF;EA5CE,QAAA;AAAA;;;;;UAOe,cAAA;EAkEf;;;EA9DA,SAAA;EA0EqB;;;EArErB,SAAA;EA6Ee;;;;EAvEf,QAAA;AAAA;;;;;;KAYU,WAAA;;;;;UAUK,gBAAA;EA6DD;;;;EAxDd,OAAA;EA4FA;;;;EAtFA,OAAA;EAkHA;;;;EA5GA,cAAA;EAqIA;;;;EA/HA,oBAAA;EA4JA;;;;EAtJA,sBAAA;AAAA;;;;;;KAYU,WAAA;;;;;;;UAQK,cAAA;EA0KJ;;;AAUb;;;;EAxKE,WAAA,GAAc,WAAA;EA0Kd;;;;AAQF;EA3KE,GAAA;;;;;;EAOA,OAAA;EAqKA;;;;;EA9JA,MAAA;EAoKA;;;;EA1JA,KAAA;EA+JA;;;EA1JA,UAAA;IA4Ja;;;;IAvJX,MAAA;EAAA;EA8JmB;;;;AAKvB;;EAtJE,QAAA,GAAW,QAAA;EAsJY;;;EAjJvB,WAAA;EAuJQ;;AAMV;EAxJE,YAAA;;;;AAkKF;EAxJE,QAAA,GAAW,cAAA;;;;;EAMX,WAAA,GAAc,WAAA;EAqJP;;;;;AAOT;;EAnJE,kBAAA;EAsJe;;;;EA5If,QAAA,GAAW,gBAAA;EA4II;;AAMjB;EAzIE,OAAA;;;;EAKA,MAAA;EA4IwB;;;EAvIxB,OAAA;EAmJU;;;EA9IV,UAAA,IAAc,KAAA,EAAO,SAAA;EA8IM;AAe7B;;;EAvJE,YAAA,IAAgB,IAAA,EAAM,QAAA;EAuJE;;;EAlJxB,OAAA,IAAW,IAAA,EAAM,aAAA;EAkJ8B;;;EA7I/C,QAAA,IAAY,IAAA,EAAM,cAAA;ECtRP;;;ED2RX,cAAA,IAAkB,IAAA,EAAM,eAAA;ECrR0C;;;;ED2RlE,cAAA;ECvQyB;;;;;;ED+QzB,OAAA,IAAW,KAAA,EAAO,SAAA;AAAA;;;;UAUH,OAAA;EACf,EAAA;EACA,IAAA;EACA,IAAA;AAAA;;;;;UAOe,QAAA;EACf,EAAA;EACA,KAAA;EACA,KAAA;EACA,QAAA;EACA,SAAA;EACA,QAAA;EACA,OAAA;EACA,UAAA;EACA,WAAA;EACA,UAAA;EACA,eAAA;EACA,WAAA;EACA,OAAA,EAAS,OAAA;EACT,WAAA,EAAa,IAAA;EACb,aAAA,EAAe,IAAA;AAAA;;;;KAML,WAAA;AE9SZ;;;AAAA,UFmTiB,QAAA;EEqEJ;EFnEX,KAAA;EE0F4B;EFxF5B,KAAA;EE0F8C;EFxF9C,QAAA;AAAA;;;;UAMe,SAAA;EEqFoB;EFnFnC,EAAA;EEoFoC;EFlFpC,WAAA;AAAA;;;;UAMe,aAAA;EACf,WAAA;EACA,YAAA;EACA,IAAA,GAAO,QAAA;EACP,WAAA,GAAc,WAAA;AAAA;;;;UAMC,cAAA;EACf,WAAA;EACA,YAAA;EACA,IAAA,GAAO,QAAA;AAAA;;;;UAMQ,eAAA;EACf,WAAA;EACA,YAAA;AAAA;;;;UAMe,SAAA;EEzBf;EF2BA,OAAA;AAAA;;;;KAUU,iBAAA;;;;KAeA,aAAA,iBAA8B,IAAA,EAAM,CAAA;;;cCnanC,YAAA;EAAA,QACH,SAAA;;;;EAKR,EAAA,aAAA,CAAgB,KAAA,EAAO,iBAAA,EAAmB,QAAA,EAAU,aAAA,CAAc,CAAA;ED4BlE;;;EClBA,GAAA,aAAA,CAAiB,KAAA,EAAO,iBAAA,EAAmB,QAAA,EAAU,aAAA,CAAc,CAAA;EDyBtC;;;ECf7B,IAAA,aAAA,CAAkB,KAAA,EAAO,iBAAA,EAAmB,QAAA,EAAU,aAAA,CAAc,CAAA;EDwBpE;;;EAAA,UCbU,IAAA,aAAA,CAAkB,KAAA,EAAO,iBAAA,EAAmB,IAAA,GAAO,CAAA;ED+BnD;;;EAAA,UCdA,kBAAA,CAAA;AAAA;;;cClBC,QAAA,SAAiB,YAAA;EAAA,QACpB,MAAA;EAAA,QACA,MAAA;EAAA,QACA,OAAA;EAAA,QACA,MAAA;EAAA,QACA,SAAA;EAAA,QACA,mBAAA;EAAA,QACA,iBAAA;cAEI,MAAA,EAAQ,cAAA;EAAA,QAYZ,UAAA;EFhBqB;;;;EAAA,QEsJrB,0BAAA;EAAA,QAuBA,aAAA;EAAA,QAqDA,WAAA;EAAA,QAWA,WAAA;EAAA,QAOA,UAAA;EAAA,QAOA,WAAA;EAAA,QAOA,cAAA;EAAA,QAKA,gBAAA;EAAA,QAMA,WAAA;EAAA,QAKA,YAAA;EAAA,QAKA,kBAAA;EAAA,QAKA,kBAAA;EF5OR;;;EEwPA,QAAA,CAAA;EFtOsB;;AAYxB;EEyOE,YAAA,CAAA;;;;EAeA,KAAA,CAAA;EFhP6B;;;;EE0P7B,YAAA,CAAa,WAAA,UAAqB,YAAA;EF9JpB;;;;;;;EEgLd,SAAA,CAAU,SAAA,UAAmB,SAAA,iBAA0B,QAAA;EFlG5B;;;EEmH3B,OAAA,CAAA,GAAW,QAAA;EF1QX;;;EAAA,IEiRI,KAAA,CAAA;EFpPJ;;;EAAA,IE2PI,IAAA,CAAA;EFpOJ;;;;EE4OA,EAAA,CAAG,KAAA,WAAgB,QAAA,EAAU,aAAA;EAC7B,EAAA,CAAG,KAAA,UAAe,QAAA,EAAU,aAAA;EAC5B,EAAA,CAAG,KAAA,WAAgB,QAAA,EAAU,aAAA;EAC7B,EAAA,CAAG,KAAA,cAAmB,QAAA,EAAU,aAAA,CAAc,SAAA;EAC9C,EAAA,CAAG,KAAA,kBAAuB,QAAA,EAAU,aAAA,CAAc,QAAA;EAClD,EAAA,CAAG,KAAA,gBAAqB,QAAA,EAAU,aAAA,CAAc,aAAA;EAChD,EAAA,CAAG,KAAA,iBAAsB,QAAA,EAAU,aAAA,CAAc,cAAA;EACjD,EAAA,CAAG,KAAA,kBAAuB,QAAA,EAAU,aAAA,CAAc,eAAA;EAClD,EAAA,CAAG,KAAA,wBAA6B,QAAA,EAAU,aAAA;EFpLrB;;;;EE6LrB,OAAA,CAAA;AAAA;;;;AF5UF;;UG1DU,mBAAA;EH0Da;;AAQvB;;EG7DE,IAAA,GAAO,MAAA,EAAQ,cAAA,KAAmB,OAAA,CAAQ,QAAA;EHyE5B;;;;EGnEd,MAAA;EH8LqB;;;EGzLrB,QAAA,GAAW,QAAA;AAAA;;;;cAMP,aAAA,EAAe,mBAAA"}