omni-sync-sdk 0.12.1 → 0.13.0

package/dist/index.d.mts

@@ -52,6 +52,26 @@ interface StoreInfo {
     name: string;
     currency: string;
     language: string;
+    /** Connection ID (vibe-coded mode only) */
+    connectionId?: string;
+    /** Store name (vibe-coded mode only - same as name) */
+    storeName?: string;
+    /** Connection status (vibe-coded mode only) */
+    status?: string;
+    /** Allowed API scopes (vibe-coded mode only) */
+    allowedScopes?: string[];
+    /** Whether orders can be created (vibe-coded mode only) */
+    ordersWriteEnabled?: boolean;
+    /** Whether guest checkout is tracked (vibe-coded mode only) */
+    guestCheckoutTracking?: boolean;
+    /**
+     * Whether new customer registrations require email verification.
+     * If true, your site MUST implement an email verification flow:
+     * 1. After registerCustomer(), check if response.requiresVerification is true
+     * 2. Show a verification code input to the user
+     * 3. Call verifyEmail(code) with the code they received via email
+     */
+    requireEmailVerification?: boolean;
 }
 interface CustomerProfile {
     id: string;
@@ -109,18 +129,61 @@ interface ProductVariant {
 }
 interface InventoryInfo {
     total: number;
-    reserved: number;
+    reserved?: number;
     available: number;
+    /**
+     * Whether the item is in stock (available > 0)
+     * Always present in vibe-coded API responses
+     */
+    inStock?: boolean;
 }
+/**
+ * Get a human-readable stock status string
+ * @param inventory - The inventory info object
+ * @param options - Optional configuration for the status text
+ * @returns A string like "In Stock", "Out of Stock", or "Low Stock"
+ *
+ * @example
+ * ```typescript
+ * const product = await omni.getProduct('prod_123');
+ * const status = getStockStatus(product.inventory);
+ * // Returns "In Stock" or "Out of Stock"
+ *
+ * // With custom threshold:
+ * const status = getStockStatus(product.inventory, { lowStockThreshold: 5 });
+ * // Returns "Low Stock" if available <= 5
+ * ```
+ */
+declare function getStockStatus(inventory: InventoryInfo | null | undefined, options?: {
+    /** Threshold for "Low Stock" status. Set to 0 to disable. Default: 0 (disabled) */
+    lowStockThreshold?: number;
+    /** Custom text for in stock. Default: "In Stock" */
+    inStockText?: string;
+    /** Custom text for out of stock. Default: "Out of Stock" */
+    outOfStockText?: string;
+    /** Custom text for low stock. Default: "Low Stock" */
+    lowStockText?: string;
+}): string;
 interface ProductQueryParams {
     page?: number;
     limit?: number;
     search?: string;
     status?: 'active' | 'draft' | 'archived';
+    /** Filter by category IDs (comma-separated or array) */
+    categories?: string | string[];
+    /** Filter by brand IDs (comma-separated or array) */
+    brands?: string | string[];
+    /** Filter by tag IDs (comma-separated or array) */
+    tags?: string | string[];
+    /** Minimum price filter */
+    minPrice?: number;
+    /** Maximum price filter */
+    maxPrice?: number;
+    /** Sort by field (default: menuOrder) */
+    sortBy?: 'name' | 'price' | 'createdAt';
+    sortOrder?: 'asc' | 'desc';
     type?: 'SIMPLE' | 'VARIABLE';
     isDownloadable?: boolean;
-    sortBy?: 'name' | 'createdAt' | 'updatedAt' | 'basePrice';
-    sortOrder?: 'asc' | 'desc';
 }
 /**
  * Product suggestion for autocomplete
@@ -1189,8 +1252,23 @@ declare class OmniSyncClient {
      */
     getStoreInfo(): Promise<StoreInfo>;
     /**
-     * Get a list of products with pagination
+     * Get a list of products with pagination and filtering
      * Works in vibe-coded, storefront (public), and admin mode
+     *
+     * @example
+     * ```typescript
+     * // Basic usage
+     * const products = await omni.getProducts({ page: 1, limit: 20 });
+     *
+     * // With filters (vibe-coded mode)
+     * const filtered = await omni.getProducts({
+     *   categories: ['cat_123', 'cat_456'],
+     *   minPrice: 10,
+     *   maxPrice: 100,
+     *   sortBy: 'price',
+     *   sortOrder: 'asc'
+     * });
+     * ```
      */
     getProducts(params?: ProductQueryParams): Promise<PaginatedResponse<Product>>;
     /**
@@ -1198,6 +1276,56 @@ declare class OmniSyncClient {
      * Works in vibe-coded, storefront (public), and admin mode
      */
     getProduct(productId: string): Promise<Product>;
+    /**
+     * Get available categories for filtering products
+     * Works in vibe-coded mode
+     *
+     * @example
+     * ```typescript
+     * const { categories } = await omni.getCategories();
+     * // categories is a tree structure with children
+     * ```
+     */
+    getCategories(): Promise<{
+        categories: Array<{
+            id: string;
+            name: string;
+            parentId?: string;
+            children?: unknown[];
+        }>;
+    }>;
+    /**
+     * Get available brands for filtering products
+     * Works in vibe-coded mode
+     *
+     * @example
+     * ```typescript
+     * const { brands } = await omni.getBrands();
+     * // Use brand IDs in getProducts({ brands: ['brand_id'] })
+     * ```
+     */
+    getBrands(): Promise<{
+        brands: Array<{
+            id: string;
+            name: string;
+        }>;
+    }>;
+    /**
+     * Get available tags for filtering products
+     * Works in vibe-coded mode
+     *
+     * @example
+     * ```typescript
+     * const { tags } = await omni.getTags();
+     * // Use tag IDs in getProducts({ tags: ['tag_id'] })
+     * ```
+     */
+    getTags(): Promise<{
+        tags: Array<{
+            id: string;
+            name: string;
+        }>;
+    }>;
     /**
      * Get search suggestions for autocomplete
      * Returns matching products and categories for quick search UI
@@ -2608,4 +2736,4 @@ declare function isWebhookEventType(event: WebhookEvent, type: WebhookEventType)
  */
 declare function createWebhookHandler(handlers: Partial<Record<WebhookEventType, (event: WebhookEvent) => Promise<void>>>): (payload: unknown) => Promise<void>;
 
-export { type AddToCartDto, type AppliedDiscount, type ApplyCouponDto, type BulkInventoryResponse, type BulkSaveVariantsDto, type BulkSaveVariantsResponse, type BulkVariantInput, type Cart, type CartItem, type CartStatus, type CategorySuggestion, type Checkout, type CheckoutAddress, type CheckoutLineItem, type CheckoutStatus, type CompleteCheckoutResponse, type CompleteDraftDto, type ConnectorPlatform, type Coupon, type CouponCreateResponse, type CouponQueryParams, type CouponStatus, type CouponType, type CouponValidationWarning, type CreateAddressDto, type CreateCheckoutDto, type CreateCouponDto, type CreateCustomApiDto, type CreateCustomerDto, type CreateGuestOrderDto, type CreateOrderDto, type CreateProductDto, type CreateRefundDto, type CreateVariantDto, type CustomApiAuthType, type CustomApiConnectionStatus, type CustomApiCredentials, type CustomApiIntegration, type CustomApiSyncConfig, type CustomApiSyncDirection, type CustomApiTestResult, type Customer, type CustomerAddress, type CustomerAuthResponse, type CustomerOAuthProvider, type CustomerProfile, type CustomerQueryParams, type DraftLineItem, type EditInventoryDto, type EmailVerificationResponse, type FulfillOrderDto, type GuestCheckoutStartResponse, type GuestOrderResponse, type InsufficientStockError, type InventoryInfo, type InventorySyncStatus, type LocalCart, type LocalCartItem, type MergeCartsDto, type OAuthAuthorizeResponse, type OAuthCallbackResponse, type OAuthConnection, type OAuthConnectionsResponse, type OAuthProvidersResponse, type OmniSyncApiError, OmniSyncClient, type OmniSyncClientOptions, OmniSyncError, type Order, type OrderAddress, type OrderCustomer, type OrderItem, type OrderQueryParams, type OrderStatus, type PaginatedResponse, type PlatformCouponCapabilities, type Product, type ProductAttributeInput, type ProductImage, type ProductQueryParams, type ProductSuggestion, type ProductVariant, type PublishProductResponse, type ReconcileInventoryResponse, type Refund, type RefundLineItem, type RefundLineItemResponse, type RefundType, type RegisterCustomerDto, type SearchSuggestions, type SelectShippingMethodDto, type SendInvoiceDto, type SetBillingAddressDto, type SetCheckoutCustomerDto, type SetShippingAddressDto, type SetShippingAddressResponse, type ShippingLine, type ShippingRate, type StockAvailabilityRequest, type StockAvailabilityResponse, type StockAvailabilityResult, type StoreInfo, type SyncJob, type UpdateAddressDto, type UpdateCartItemDto, type UpdateCouponDto, type UpdateCustomApiDto, type UpdateCustomerDto, type UpdateDraftDto, type UpdateInventoryDto, type UpdateOrderDto, type UpdateOrderShippingDto, type UpdateProductDto, type UpdateVariantDto, type UpdateVariantInventoryDto, type VariantInventoryResponse, type VariantPlatformOverlay, type VariantStatus, type WebhookEvent, type WebhookEventType, createWebhookHandler, isCouponApplicableToProduct, isWebhookEventType, parseWebhookEvent, verifyWebhook };
+export { type AddToCartDto, type AppliedDiscount, type ApplyCouponDto, type BulkInventoryResponse, type BulkSaveVariantsDto, type BulkSaveVariantsResponse, type BulkVariantInput, type Cart, type CartItem, type CartStatus, type CategorySuggestion, type Checkout, type CheckoutAddress, type CheckoutLineItem, type CheckoutStatus, type CompleteCheckoutResponse, type CompleteDraftDto, type ConnectorPlatform, type Coupon, type CouponCreateResponse, type CouponQueryParams, type CouponStatus, type CouponType, type CouponValidationWarning, type CreateAddressDto, type CreateCheckoutDto, type CreateCouponDto, type CreateCustomApiDto, type CreateCustomerDto, type CreateGuestOrderDto, type CreateOrderDto, type CreateProductDto, type CreateRefundDto, type CreateVariantDto, type CustomApiAuthType, type CustomApiConnectionStatus, type CustomApiCredentials, type CustomApiIntegration, type CustomApiSyncConfig, type CustomApiSyncDirection, type CustomApiTestResult, type Customer, type CustomerAddress, type CustomerAuthResponse, type CustomerOAuthProvider, type CustomerProfile, type CustomerQueryParams, type DraftLineItem, type EditInventoryDto, type EmailVerificationResponse, type FulfillOrderDto, type GuestCheckoutStartResponse, type GuestOrderResponse, type InsufficientStockError, type InventoryInfo, type InventorySyncStatus, type LocalCart, type LocalCartItem, type MergeCartsDto, type OAuthAuthorizeResponse, type OAuthCallbackResponse, type OAuthConnection, type OAuthConnectionsResponse, type OAuthProvidersResponse, type OmniSyncApiError, OmniSyncClient, type OmniSyncClientOptions, OmniSyncError, type Order, type OrderAddress, type OrderCustomer, type OrderItem, type OrderQueryParams, type OrderStatus, type PaginatedResponse, type PlatformCouponCapabilities, type Product, type ProductAttributeInput, type ProductImage, type ProductQueryParams, type ProductSuggestion, type ProductVariant, type PublishProductResponse, type ReconcileInventoryResponse, type Refund, type RefundLineItem, type RefundLineItemResponse, type RefundType, type RegisterCustomerDto, type SearchSuggestions, type SelectShippingMethodDto, type SendInvoiceDto, type SetBillingAddressDto, type SetCheckoutCustomerDto, type SetShippingAddressDto, type SetShippingAddressResponse, type ShippingLine, type ShippingRate, type StockAvailabilityRequest, type StockAvailabilityResponse, type StockAvailabilityResult, type StoreInfo, type SyncJob, type UpdateAddressDto, type UpdateCartItemDto, type UpdateCouponDto, type UpdateCustomApiDto, type UpdateCustomerDto, type UpdateDraftDto, type UpdateInventoryDto, type UpdateOrderDto, type UpdateOrderShippingDto, type UpdateProductDto, type UpdateVariantDto, type UpdateVariantInventoryDto, type VariantInventoryResponse, type VariantPlatformOverlay, type VariantStatus, type WebhookEvent, type WebhookEventType, createWebhookHandler, getStockStatus, isCouponApplicableToProduct, isWebhookEventType, parseWebhookEvent, verifyWebhook };

package/dist/index.d.ts

@@ -52,6 +52,26 @@ interface StoreInfo {
     name: string;
     currency: string;
     language: string;
+    /** Connection ID (vibe-coded mode only) */
+    connectionId?: string;
+    /** Store name (vibe-coded mode only - same as name) */
+    storeName?: string;
+    /** Connection status (vibe-coded mode only) */
+    status?: string;
+    /** Allowed API scopes (vibe-coded mode only) */
+    allowedScopes?: string[];
+    /** Whether orders can be created (vibe-coded mode only) */
+    ordersWriteEnabled?: boolean;
+    /** Whether guest checkout is tracked (vibe-coded mode only) */
+    guestCheckoutTracking?: boolean;
+    /**
+     * Whether new customer registrations require email verification.
+     * If true, your site MUST implement an email verification flow:
+     * 1. After registerCustomer(), check if response.requiresVerification is true
+     * 2. Show a verification code input to the user
+     * 3. Call verifyEmail(code) with the code they received via email
+     */
+    requireEmailVerification?: boolean;
 }
 interface CustomerProfile {
     id: string;
@@ -109,18 +129,61 @@ interface ProductVariant {
 }
 interface InventoryInfo {
     total: number;
-    reserved: number;
+    reserved?: number;
     available: number;
+    /**
+     * Whether the item is in stock (available > 0)
+     * Always present in vibe-coded API responses
+     */
+    inStock?: boolean;
 }
+/**
+ * Get a human-readable stock status string
+ * @param inventory - The inventory info object
+ * @param options - Optional configuration for the status text
+ * @returns A string like "In Stock", "Out of Stock", or "Low Stock"
+ *
+ * @example
+ * ```typescript
+ * const product = await omni.getProduct('prod_123');
+ * const status = getStockStatus(product.inventory);
+ * // Returns "In Stock" or "Out of Stock"
+ *
+ * // With custom threshold:
+ * const status = getStockStatus(product.inventory, { lowStockThreshold: 5 });
+ * // Returns "Low Stock" if available <= 5
+ * ```
+ */
+declare function getStockStatus(inventory: InventoryInfo | null | undefined, options?: {
+    /** Threshold for "Low Stock" status. Set to 0 to disable. Default: 0 (disabled) */
+    lowStockThreshold?: number;
+    /** Custom text for in stock. Default: "In Stock" */
+    inStockText?: string;
+    /** Custom text for out of stock. Default: "Out of Stock" */
+    outOfStockText?: string;
+    /** Custom text for low stock. Default: "Low Stock" */
+    lowStockText?: string;
+}): string;
 interface ProductQueryParams {
     page?: number;
     limit?: number;
     search?: string;
     status?: 'active' | 'draft' | 'archived';
+    /** Filter by category IDs (comma-separated or array) */
+    categories?: string | string[];
+    /** Filter by brand IDs (comma-separated or array) */
+    brands?: string | string[];
+    /** Filter by tag IDs (comma-separated or array) */
+    tags?: string | string[];
+    /** Minimum price filter */
+    minPrice?: number;
+    /** Maximum price filter */
+    maxPrice?: number;
+    /** Sort by field (default: menuOrder) */
+    sortBy?: 'name' | 'price' | 'createdAt';
+    sortOrder?: 'asc' | 'desc';
     type?: 'SIMPLE' | 'VARIABLE';
     isDownloadable?: boolean;
-    sortBy?: 'name' | 'createdAt' | 'updatedAt' | 'basePrice';
-    sortOrder?: 'asc' | 'desc';
 }
 /**
  * Product suggestion for autocomplete
@@ -1189,8 +1252,23 @@ declare class OmniSyncClient {
      */
     getStoreInfo(): Promise<StoreInfo>;
     /**
-     * Get a list of products with pagination
+     * Get a list of products with pagination and filtering
      * Works in vibe-coded, storefront (public), and admin mode
+     *
+     * @example
+     * ```typescript
+     * // Basic usage
+     * const products = await omni.getProducts({ page: 1, limit: 20 });
+     *
+     * // With filters (vibe-coded mode)
+     * const filtered = await omni.getProducts({
+     *   categories: ['cat_123', 'cat_456'],
+     *   minPrice: 10,
+     *   maxPrice: 100,
+     *   sortBy: 'price',
+     *   sortOrder: 'asc'
+     * });
+     * ```
      */
     getProducts(params?: ProductQueryParams): Promise<PaginatedResponse<Product>>;
     /**
@@ -1198,6 +1276,56 @@ declare class OmniSyncClient {
      * Works in vibe-coded, storefront (public), and admin mode
      */
     getProduct(productId: string): Promise<Product>;
+    /**
+     * Get available categories for filtering products
+     * Works in vibe-coded mode
+     *
+     * @example
+     * ```typescript
+     * const { categories } = await omni.getCategories();
+     * // categories is a tree structure with children
+     * ```
+     */
+    getCategories(): Promise<{
+        categories: Array<{
+            id: string;
+            name: string;
+            parentId?: string;
+            children?: unknown[];
+        }>;
+    }>;
+    /**
+     * Get available brands for filtering products
+     * Works in vibe-coded mode
+     *
+     * @example
+     * ```typescript
+     * const { brands } = await omni.getBrands();
+     * // Use brand IDs in getProducts({ brands: ['brand_id'] })
+     * ```
+     */
+    getBrands(): Promise<{
+        brands: Array<{
+            id: string;
+            name: string;
+        }>;
+    }>;
+    /**
+     * Get available tags for filtering products
+     * Works in vibe-coded mode
+     *
+     * @example
+     * ```typescript
+     * const { tags } = await omni.getTags();
+     * // Use tag IDs in getProducts({ tags: ['tag_id'] })
+     * ```
+     */
+    getTags(): Promise<{
+        tags: Array<{
+            id: string;
+            name: string;
+        }>;
+    }>;
     /**
      * Get search suggestions for autocomplete
      * Returns matching products and categories for quick search UI
@@ -2608,4 +2736,4 @@ declare function isWebhookEventType(event: WebhookEvent, type: WebhookEventType)
  */
 declare function createWebhookHandler(handlers: Partial<Record<WebhookEventType, (event: WebhookEvent) => Promise<void>>>): (payload: unknown) => Promise<void>;
 
-export { type AddToCartDto, type AppliedDiscount, type ApplyCouponDto, type BulkInventoryResponse, type BulkSaveVariantsDto, type BulkSaveVariantsResponse, type BulkVariantInput, type Cart, type CartItem, type CartStatus, type CategorySuggestion, type Checkout, type CheckoutAddress, type CheckoutLineItem, type CheckoutStatus, type CompleteCheckoutResponse, type CompleteDraftDto, type ConnectorPlatform, type Coupon, type CouponCreateResponse, type CouponQueryParams, type CouponStatus, type CouponType, type CouponValidationWarning, type CreateAddressDto, type CreateCheckoutDto, type CreateCouponDto, type CreateCustomApiDto, type CreateCustomerDto, type CreateGuestOrderDto, type CreateOrderDto, type CreateProductDto, type CreateRefundDto, type CreateVariantDto, type CustomApiAuthType, type CustomApiConnectionStatus, type CustomApiCredentials, type CustomApiIntegration, type CustomApiSyncConfig, type CustomApiSyncDirection, type CustomApiTestResult, type Customer, type CustomerAddress, type CustomerAuthResponse, type CustomerOAuthProvider, type CustomerProfile, type CustomerQueryParams, type DraftLineItem, type EditInventoryDto, type EmailVerificationResponse, type FulfillOrderDto, type GuestCheckoutStartResponse, type GuestOrderResponse, type InsufficientStockError, type InventoryInfo, type InventorySyncStatus, type LocalCart, type LocalCartItem, type MergeCartsDto, type OAuthAuthorizeResponse, type OAuthCallbackResponse, type OAuthConnection, type OAuthConnectionsResponse, type OAuthProvidersResponse, type OmniSyncApiError, OmniSyncClient, type OmniSyncClientOptions, OmniSyncError, type Order, type OrderAddress, type OrderCustomer, type OrderItem, type OrderQueryParams, type OrderStatus, type PaginatedResponse, type PlatformCouponCapabilities, type Product, type ProductAttributeInput, type ProductImage, type ProductQueryParams, type ProductSuggestion, type ProductVariant, type PublishProductResponse, type ReconcileInventoryResponse, type Refund, type RefundLineItem, type RefundLineItemResponse, type RefundType, type RegisterCustomerDto, type SearchSuggestions, type SelectShippingMethodDto, type SendInvoiceDto, type SetBillingAddressDto, type SetCheckoutCustomerDto, type SetShippingAddressDto, type SetShippingAddressResponse, type ShippingLine, type ShippingRate, type StockAvailabilityRequest, type StockAvailabilityResponse, type StockAvailabilityResult, type StoreInfo, type SyncJob, type UpdateAddressDto, type UpdateCartItemDto, type UpdateCouponDto, type UpdateCustomApiDto, type UpdateCustomerDto, type UpdateDraftDto, type UpdateInventoryDto, type UpdateOrderDto, type UpdateOrderShippingDto, type UpdateProductDto, type UpdateVariantDto, type UpdateVariantInventoryDto, type VariantInventoryResponse, type VariantPlatformOverlay, type VariantStatus, type WebhookEvent, type WebhookEventType, createWebhookHandler, isCouponApplicableToProduct, isWebhookEventType, parseWebhookEvent, verifyWebhook };
+export { type AddToCartDto, type AppliedDiscount, type ApplyCouponDto, type BulkInventoryResponse, type BulkSaveVariantsDto, type BulkSaveVariantsResponse, type BulkVariantInput, type Cart, type CartItem, type CartStatus, type CategorySuggestion, type Checkout, type CheckoutAddress, type CheckoutLineItem, type CheckoutStatus, type CompleteCheckoutResponse, type CompleteDraftDto, type ConnectorPlatform, type Coupon, type CouponCreateResponse, type CouponQueryParams, type CouponStatus, type CouponType, type CouponValidationWarning, type CreateAddressDto, type CreateCheckoutDto, type CreateCouponDto, type CreateCustomApiDto, type CreateCustomerDto, type CreateGuestOrderDto, type CreateOrderDto, type CreateProductDto, type CreateRefundDto, type CreateVariantDto, type CustomApiAuthType, type CustomApiConnectionStatus, type CustomApiCredentials, type CustomApiIntegration, type CustomApiSyncConfig, type CustomApiSyncDirection, type CustomApiTestResult, type Customer, type CustomerAddress, type CustomerAuthResponse, type CustomerOAuthProvider, type CustomerProfile, type CustomerQueryParams, type DraftLineItem, type EditInventoryDto, type EmailVerificationResponse, type FulfillOrderDto, type GuestCheckoutStartResponse, type GuestOrderResponse, type InsufficientStockError, type InventoryInfo, type InventorySyncStatus, type LocalCart, type LocalCartItem, type MergeCartsDto, type OAuthAuthorizeResponse, type OAuthCallbackResponse, type OAuthConnection, type OAuthConnectionsResponse, type OAuthProvidersResponse, type OmniSyncApiError, OmniSyncClient, type OmniSyncClientOptions, OmniSyncError, type Order, type OrderAddress, type OrderCustomer, type OrderItem, type OrderQueryParams, type OrderStatus, type PaginatedResponse, type PlatformCouponCapabilities, type Product, type ProductAttributeInput, type ProductImage, type ProductQueryParams, type ProductSuggestion, type ProductVariant, type PublishProductResponse, type ReconcileInventoryResponse, type Refund, type RefundLineItem, type RefundLineItemResponse, type RefundType, type RegisterCustomerDto, type SearchSuggestions, type SelectShippingMethodDto, type SendInvoiceDto, type SetBillingAddressDto, type SetCheckoutCustomerDto, type SetShippingAddressDto, type SetShippingAddressResponse, type ShippingLine, type ShippingRate, type StockAvailabilityRequest, type StockAvailabilityResponse, type StockAvailabilityResult, type StoreInfo, type SyncJob, type UpdateAddressDto, type UpdateCartItemDto, type UpdateCouponDto, type UpdateCustomApiDto, type UpdateCustomerDto, type UpdateDraftDto, type UpdateInventoryDto, type UpdateOrderDto, type UpdateOrderShippingDto, type UpdateProductDto, type UpdateVariantDto, type UpdateVariantInventoryDto, type VariantInventoryResponse, type VariantPlatformOverlay, type VariantStatus, type WebhookEvent, type WebhookEventType, createWebhookHandler, getStockStatus, isCouponApplicableToProduct, isWebhookEventType, parseWebhookEvent, verifyWebhook };

package/dist/index.js

@@ -23,6 +23,7 @@ __export(index_exports, {
   OmniSyncClient: () => OmniSyncClient,
   OmniSyncError: () => OmniSyncError,
   createWebhookHandler: () => createWebhookHandler,
+  getStockStatus: () => getStockStatus,
   isCouponApplicableToProduct: () => isCouponApplicableToProduct,
   isWebhookEventType: () => isWebhookEventType,
   parseWebhookEvent: () => parseWebhookEvent,
@@ -308,18 +309,42 @@ var OmniSyncClient = class {
   }
   // -------------------- Products --------------------
   /**
-   * Get a list of products with pagination
+   * Get a list of products with pagination and filtering
    * Works in vibe-coded, storefront (public), and admin mode
+   *
+   * @example
+   * ```typescript
+   * // Basic usage
+   * const products = await omni.getProducts({ page: 1, limit: 20 });
+   *
+   * // With filters (vibe-coded mode)
+   * const filtered = await omni.getProducts({
+   *   categories: ['cat_123', 'cat_456'],
+   *   minPrice: 10,
+   *   maxPrice: 100,
+   *   sortBy: 'price',
+   *   sortOrder: 'asc'
+   * });
+   * ```
    */
   async getProducts(params) {
+    const categories = Array.isArray(params?.categories) ? params.categories.join(",") : params?.categories;
+    const brands = Array.isArray(params?.brands) ? params.brands.join(",") : params?.brands;
+    const tags = Array.isArray(params?.tags) ? params.tags.join(",") : params?.tags;
     const queryParams = {
       page: params?.page,
       limit: params?.limit,
       search: params?.search,
       status: params?.status,
-      type: params?.type,
+      categories,
+      brands,
+      tags,
+      minPrice: params?.minPrice,
+      maxPrice: params?.maxPrice,
       sortBy: params?.sortBy,
-      sortOrder: params?.sortOrder
+      sortOrder: params?.sortOrder,
+      // Admin-only params
+      type: params?.type
     };
     if (this.isVibeCodedMode()) {
       return this.vibeCodedRequest(
@@ -357,6 +382,54 @@ var OmniSyncClient = class {
     }
     return this.adminRequest("GET", `/api/v1/products/${productId}`);
   }
+  /**
+   * Get available categories for filtering products
+   * Works in vibe-coded mode
+   *
+   * @example
+   * ```typescript
+   * const { categories } = await omni.getCategories();
+   * // categories is a tree structure with children
+   * ```
+   */
+  async getCategories() {
+    if (this.isVibeCodedMode()) {
+      return this.vibeCodedRequest("GET", "/categories");
+    }
+    throw new OmniSyncError("getCategories is only available in vibe-coded mode", 400);
+  }
+  /**
+   * Get available brands for filtering products
+   * Works in vibe-coded mode
+   *
+   * @example
+   * ```typescript
+   * const { brands } = await omni.getBrands();
+   * // Use brand IDs in getProducts({ brands: ['brand_id'] })
+   * ```
+   */
+  async getBrands() {
+    if (this.isVibeCodedMode()) {
+      return this.vibeCodedRequest("GET", "/brands");
+    }
+    throw new OmniSyncError("getBrands is only available in vibe-coded mode", 400);
+  }
+  /**
+   * Get available tags for filtering products
+   * Works in vibe-coded mode
+   *
+   * @example
+   * ```typescript
+   * const { tags } = await omni.getTags();
+   * // Use tag IDs in getProducts({ tags: ['tag_id'] })
+   * ```
+   */
+  async getTags() {
+    if (this.isVibeCodedMode()) {
+      return this.vibeCodedRequest("GET", "/tags");
+    }
+    throw new OmniSyncError("getTags is only available in vibe-coded mode", 400);
+  }
   /**
    * Get search suggestions for autocomplete
    * Returns matching products and categories for quick search UI
@@ -2684,6 +2757,21 @@ function createWebhookHandler(handlers) {
 }
 
 // src/types.ts
+function getStockStatus(inventory, options) {
+  if (!inventory) {
+    return options?.outOfStockText ?? "Out of Stock";
+  }
+  const available = inventory.available;
+  const inStock = inventory.inStock ?? available > 0;
+  const lowStockThreshold = options?.lowStockThreshold ?? 0;
+  if (!inStock || available <= 0) {
+    return options?.outOfStockText ?? "Out of Stock";
+  }
+  if (lowStockThreshold > 0 && available <= lowStockThreshold) {
+    return options?.lowStockText ?? "Low Stock";
+  }
+  return options?.inStockText ?? "In Stock";
+}
 function isCouponApplicableToProduct(coupon, productId, productCategoryIds) {
   if (coupon.excludedProducts?.includes(productId)) {
     return false;
@@ -2708,6 +2796,7 @@ function isCouponApplicableToProduct(coupon, productId, productCategoryIds) {
   OmniSyncClient,
   OmniSyncError,
   createWebhookHandler,
+  getStockStatus,
   isCouponApplicableToProduct,
   isWebhookEventType,
   parseWebhookEvent,

package/dist/index.mjs

@@ -283,18 +283,42 @@ var OmniSyncClient = class {
   }
   // -------------------- Products --------------------
   /**
-   * Get a list of products with pagination
+   * Get a list of products with pagination and filtering
    * Works in vibe-coded, storefront (public), and admin mode
+   *
+   * @example
+   * ```typescript
+   * // Basic usage
+   * const products = await omni.getProducts({ page: 1, limit: 20 });
+   *
+   * // With filters (vibe-coded mode)
+   * const filtered = await omni.getProducts({
+   *   categories: ['cat_123', 'cat_456'],
+   *   minPrice: 10,
+   *   maxPrice: 100,
+   *   sortBy: 'price',
+   *   sortOrder: 'asc'
+   * });
+   * ```
    */
   async getProducts(params) {
+    const categories = Array.isArray(params?.categories) ? params.categories.join(",") : params?.categories;
+    const brands = Array.isArray(params?.brands) ? params.brands.join(",") : params?.brands;
+    const tags = Array.isArray(params?.tags) ? params.tags.join(",") : params?.tags;
     const queryParams = {
       page: params?.page,
       limit: params?.limit,
       search: params?.search,
       status: params?.status,
-      type: params?.type,
+      categories,
+      brands,
+      tags,
+      minPrice: params?.minPrice,
+      maxPrice: params?.maxPrice,
       sortBy: params?.sortBy,
-      sortOrder: params?.sortOrder
+      sortOrder: params?.sortOrder,
+      // Admin-only params
+      type: params?.type
     };
     if (this.isVibeCodedMode()) {
       return this.vibeCodedRequest(
@@ -332,6 +356,54 @@ var OmniSyncClient = class {
     }
     return this.adminRequest("GET", `/api/v1/products/${productId}`);
   }
+  /**
+   * Get available categories for filtering products
+   * Works in vibe-coded mode
+   *
+   * @example
+   * ```typescript
+   * const { categories } = await omni.getCategories();
+   * // categories is a tree structure with children
+   * ```
+   */
+  async getCategories() {
+    if (this.isVibeCodedMode()) {
+      return this.vibeCodedRequest("GET", "/categories");
+    }
+    throw new OmniSyncError("getCategories is only available in vibe-coded mode", 400);
+  }
+  /**
+   * Get available brands for filtering products
+   * Works in vibe-coded mode
+   *
+   * @example
+   * ```typescript
+   * const { brands } = await omni.getBrands();
+   * // Use brand IDs in getProducts({ brands: ['brand_id'] })
+   * ```
+   */
+  async getBrands() {
+    if (this.isVibeCodedMode()) {
+      return this.vibeCodedRequest("GET", "/brands");
+    }
+    throw new OmniSyncError("getBrands is only available in vibe-coded mode", 400);
+  }
+  /**
+   * Get available tags for filtering products
+   * Works in vibe-coded mode
+   *
+   * @example
+   * ```typescript
+   * const { tags } = await omni.getTags();
+   * // Use tag IDs in getProducts({ tags: ['tag_id'] })
+   * ```
+   */
+  async getTags() {
+    if (this.isVibeCodedMode()) {
+      return this.vibeCodedRequest("GET", "/tags");
+    }
+    throw new OmniSyncError("getTags is only available in vibe-coded mode", 400);
+  }
   /**
    * Get search suggestions for autocomplete
    * Returns matching products and categories for quick search UI
@@ -2659,6 +2731,21 @@ function createWebhookHandler(handlers) {
 }
 
 // src/types.ts
+function getStockStatus(inventory, options) {
+  if (!inventory) {
+    return options?.outOfStockText ?? "Out of Stock";
+  }
+  const available = inventory.available;
+  const inStock = inventory.inStock ?? available > 0;
+  const lowStockThreshold = options?.lowStockThreshold ?? 0;
+  if (!inStock || available <= 0) {
+    return options?.outOfStockText ?? "Out of Stock";
+  }
+  if (lowStockThreshold > 0 && available <= lowStockThreshold) {
+    return options?.lowStockText ?? "Low Stock";
+  }
+  return options?.inStockText ?? "In Stock";
+}
 function isCouponApplicableToProduct(coupon, productId, productCategoryIds) {
   if (coupon.excludedProducts?.includes(productId)) {
     return false;
@@ -2682,6 +2769,7 @@ export {
   OmniSyncClient,
   OmniSyncError,
   createWebhookHandler,
+  getStockStatus,
   isCouponApplicableToProduct,
   isWebhookEventType,
   parseWebhookEvent,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "omni-sync-sdk",
-  "version": "0.12.1",
+  "version": "0.13.0",
   "description": "Official SDK for building e-commerce storefronts with OmniSync Platform. Perfect for vibe-coded sites, AI-built stores (Cursor, Lovable, v0), and custom storefronts.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -16,14 +16,6 @@
     "dist",
     "README.md"
   ],
-  "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --dts",
-    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
-    "lint": "eslint \"src/**/*.ts\"",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "prepublishOnly": "pnpm build"
-  },
   "keywords": [
     "omni-sync",
     "e-commerce",
@@ -72,5 +64,12 @@
     "typescript": {
       "optional": true
     }
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "lint": "eslint \"src/**/*.ts\"",
+    "test": "vitest run",
+    "test:watch": "vitest"
   }
-}
+}