omni-sync-sdk 0.6.0 → 0.6.2

package/README.md

@@ -65,6 +65,7 @@ console.log('Order created:', order.orderId);
 ### Option 1: Local Cart (Guest Users) - RECOMMENDED
 
 For guest users, the cart is stored in **localStorage** - exactly like Amazon, Shopify, and other major platforms do. This means:
+
 - ✅ No API calls when browsing/adding to cart
 - ✅ Cart persists across page refreshes
 - ✅ Single API call at checkout
@@ -91,6 +92,7 @@ const order = await omni.submitGuestOrder();
 ### Option 2: Server Cart (Registered Users)
 
 For logged-in customers, use server-side cart:
+
 - ✅ Cart syncs across devices
 - ✅ Abandoned cart recovery
 - ✅ Customer history tracking
@@ -210,6 +212,7 @@ interface Product {
   id: string;
   name: string;
   description?: string | null;
+  descriptionFormat?: 'text' | 'html' | 'markdown'; // Format of description content
   sku: string;
   basePrice: number;
   salePrice?: number | null;
@@ -247,6 +250,30 @@ interface InventoryInfo {
 }
 ```
 
+#### Rendering Product Descriptions
+
+**IMPORTANT**: Product descriptions may contain HTML (from Shopify/WooCommerce) or plain text. Always check `descriptionFormat` before rendering:
+
+```tsx
+// Correct way to render product descriptions
+{product.description && (
+  product.descriptionFormat === 'html' ? (
+    // HTML content from Shopify/WooCommerce - render as HTML
+    <div dangerouslySetInnerHTML={{ __html: product.description }} />
+  ) : (
+    // Plain text - render normally
+    <p>{product.description}</p>
+  )
+)}
+```
+
+| Source Platform | descriptionFormat | Rendering |
+|-----------------|-------------------|-----------|
+| Shopify | `'html'` | Use `dangerouslySetInnerHTML` |
+| WooCommerce | `'html'` | Use `dangerouslySetInnerHTML` |
+| TikTok | `'text'` | Render as plain text |
+| Manual entry | `'text'` | Render as plain text |
+
 ---
 
 ### Local Cart (Guest Users) - RECOMMENDED
@@ -259,11 +286,11 @@ The local cart stores everything in **localStorage** until checkout. This is the
 // Add item with product info (for display)
 omni.addToLocalCart({
   productId: 'prod_123',
-  variantId: 'var_456',  // Optional: for products with variants
+  variantId: 'var_456', // Optional: for products with variants
   quantity: 2,
-  name: 'Cool T-Shirt',  // Optional: for cart display
-  price: '29.99',        // Optional: for cart display
-  image: 'https://...',  // Optional: for cart display
+  name: 'Cool T-Shirt', // Optional: for cart display
+  price: '29.99', // Optional: for cart display
+  image: 'https://...', // Optional: for cart display
 });
 ```
 
@@ -272,10 +299,10 @@ omni.addToLocalCart({
 ```typescript
 const cart = omni.getLocalCart();
 
-console.log(cart.items);           // Array of cart items
-console.log(cart.customer);        // Customer info (if set)
+console.log(cart.items); // Array of cart items
+console.log(cart.customer); // Customer info (if set)
 console.log(cart.shippingAddress); // Shipping address (if set)
-console.log(cart.couponCode);      // Applied coupon (if any)
+console.log(cart.couponCode); // Applied coupon (if any)
 ```
 
 #### Update Item Quantity
@@ -308,10 +335,10 @@ omni.clearLocalCart();
 
 ```typescript
 omni.setLocalCartCustomer({
-  email: 'customer@example.com',  // Required
-  firstName: 'John',              // Optional
-  lastName: 'Doe',                // Optional
-  phone: '+1234567890',           // Optional
+  email: 'customer@example.com', // Required
+  firstName: 'John', // Optional
+  lastName: 'Doe', // Optional
+  phone: '+1234567890', // Optional
 });
 ```
 
@@ -322,9 +349,9 @@ omni.setLocalCartShippingAddress({
   firstName: 'John',
   lastName: 'Doe',
   line1: '123 Main St',
-  line2: 'Apt 4B',      // Optional
+  line2: 'Apt 4B', // Optional
   city: 'New York',
-  region: 'NY',         // Optional: State/Province
+  region: 'NY', // Optional: State/Province
   postalCode: '10001',
   country: 'US',
   phone: '+1234567890', // Optional
@@ -383,7 +410,9 @@ interface LocalCart {
     country: string;
     phone?: string;
   };
-  billingAddress?: { /* same as shipping */ };
+  billingAddress?: {
+    /* same as shipping */
+  };
   notes?: string;
   updatedAt: string;
 }
@@ -410,11 +439,11 @@ Submit the local cart as an order with a **single API call**:
 // Make sure cart has items, customer email, and shipping address
 const order = await omni.submitGuestOrder();
 
-console.log(order.orderId);     // 'order_abc123...'
+console.log(order.orderId); // 'order_abc123...'
 console.log(order.orderNumber); // 'ORD-12345'
-console.log(order.status);      // 'pending'
-console.log(order.total);       // 59.98
-console.log(order.message);     // 'Order created successfully'
+console.log(order.status); // 'pending'
+console.log(order.total); // 59.98
+console.log(order.message); // 'Order created successfully'
 
 // Cart is automatically cleared after successful order
 ```
@@ -976,8 +1005,13 @@ export default function ProductPage({ params }: { params: { id: string } }) {
           ${product.salePrice || product.basePrice}
         </p>
 
+        {/* Render description based on format (HTML from Shopify/WooCommerce, text otherwise) */}
         {product.description && (
-          <p className="mt-4 text-gray-600">{product.description}</p>
+          product.descriptionFormat === 'html' ? (
+            <div className="mt-4 text-gray-600" dangerouslySetInnerHTML={{ __html: product.description }} />
+          ) : (
+            <p className="mt-4 text-gray-600">{product.description}</p>
+          )
         )}
 
         {/* Variant Selection */}
@@ -1828,6 +1862,7 @@ When building a store, implement these pages:
 - Handle loading states and errors
 - Persist cart ID in localStorage
 - Persist customer token after login
+- **Check `descriptionFormat` and render HTML with `dangerouslySetInnerHTML` when format is `'html'`**
 
 ### DON'T:
 
@@ -1836,6 +1871,7 @@ When building a store, implement these pages:
 - Skip implementing required pages
 - Write `const products = [...]` - use the API!
 - Use `@apply group` in CSS - Tailwind doesn't allow 'group' in @apply. Use `className="group"` on the element instead
+- **Render `product.description` as plain text without checking `descriptionFormat` - HTML will show as raw tags!**
 
 ---
 

package/dist/index.d.mts

@@ -69,6 +69,7 @@ interface Product {
     id: string;
     name: string;
     description?: string | null;
+    descriptionFormat?: 'text' | 'html' | 'markdown';
     sku: string;
     basePrice: number;
     salePrice?: number | null;
@@ -925,6 +926,63 @@ interface PublishProductResponse {
         error?: string;
     }>;
 }
+type CustomApiAuthType = 'api_key' | 'bearer' | 'basic' | 'oauth2';
+type CustomApiSyncDirection = 'inbound' | 'outbound' | 'bidirectional';
+type CustomApiConnectionStatus = 'CONNECTED' | 'DISCONNECTED' | 'PAUSED' | 'ERROR';
+interface CustomApiCredentials {
+    apiKey?: string;
+    bearerToken?: string;
+    username?: string;
+    password?: string;
+    headerName?: string;
+}
+interface CustomApiSyncConfig {
+    products?: boolean;
+    orders?: boolean;
+    inventory?: boolean;
+}
+interface CustomApiIntegration {
+    id: string;
+    storeId: string;
+    name: string;
+    description?: string | null;
+    baseUrl: string;
+    authType: CustomApiAuthType;
+    credentials?: CustomApiCredentials;
+    status: CustomApiConnectionStatus;
+    enabled: boolean;
+    syncDirection: CustomApiSyncDirection;
+    syncConfig?: CustomApiSyncConfig | null;
+    lastSyncAt?: string | null;
+    lastError?: string | null;
+    lastErrorAt?: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateCustomApiDto {
+    name: string;
+    description?: string;
+    baseUrl: string;
+    authType: CustomApiAuthType;
+    credentials?: CustomApiCredentials;
+    syncDirection?: CustomApiSyncDirection;
+    syncConfig?: CustomApiSyncConfig;
+}
+interface UpdateCustomApiDto {
+    name?: string;
+    description?: string;
+    baseUrl?: string;
+    authType?: CustomApiAuthType;
+    credentials?: CustomApiCredentials;
+    enabled?: boolean;
+    syncDirection?: CustomApiSyncDirection;
+    syncConfig?: CustomApiSyncConfig;
+}
+interface CustomApiTestResult {
+    success: boolean;
+    latency?: number;
+    error?: string;
+}
 interface OmniSyncApiError {
     statusCode: number;
     message: string;
@@ -2001,6 +2059,92 @@ declare class OmniSyncClient {
      * Only available in storefront mode
      */
     getMyCart(): Promise<Cart>;
+    /**
+     * Get all Custom API integrations for a store
+     * Requires Admin mode (apiKey)
+     *
+     * @example
+     * ```typescript
+     * const integrations = await omni.getCustomApiIntegrations();
+     * integrations.forEach(api => {
+     *   console.log(`${api.name}: ${api.status}`);
+     * });
+     * ```
+     */
+    getCustomApiIntegrations(): Promise<CustomApiIntegration[]>;
+    /**
+     * Get a single Custom API integration by ID
+     * Requires Admin mode (apiKey)
+     *
+     * @example
+     * ```typescript
+     * const api = await omni.getCustomApiIntegration('api_123');
+     * console.log(`API: ${api.name}, URL: ${api.baseUrl}`);
+     * ```
+     */
+    getCustomApiIntegration(integrationId: string): Promise<CustomApiIntegration>;
+    /**
+     * Create a new Custom API integration
+     * Requires Admin mode (apiKey)
+     *
+     * @example
+     * ```typescript
+     * const api = await omni.createCustomApiIntegration({
+     *   name: 'My External API',
+     *   baseUrl: 'https://api.example.com',
+     *   authType: 'api_key',
+     *   credentials: {
+     *     apiKey: 'sk_123...',
+     *     headerName: 'X-API-Key',
+     *   },
+     *   syncDirection: 'bidirectional',
+     *   syncConfig: {
+     *     products: true,
+     *     orders: true,
+     *     inventory: true,
+     *   },
+     * });
+     * ```
+     */
+    createCustomApiIntegration(data: CreateCustomApiDto): Promise<CustomApiIntegration>;
+    /**
+     * Update a Custom API integration
+     * Requires Admin mode (apiKey)
+     *
+     * @example
+     * ```typescript
+     * const api = await omni.updateCustomApiIntegration('api_123', {
+     *   enabled: false,
+     *   syncConfig: { products: true, orders: false, inventory: true },
+     * });
+     * ```
+     */
+    updateCustomApiIntegration(integrationId: string, data: UpdateCustomApiDto): Promise<CustomApiIntegration>;
+    /**
+     * Delete a Custom API integration
+     * Requires Admin mode (apiKey)
+     *
+     * @example
+     * ```typescript
+     * await omni.deleteCustomApiIntegration('api_123');
+     * ```
+     */
+    deleteCustomApiIntegration(integrationId: string): Promise<void>;
+    /**
+     * Test connection to a Custom API
+     * Requires Admin mode (apiKey)
+     *
+     * @example
+     * ```typescript
+     * const result = await omni.testCustomApiConnection('api_123');
+     * if (result.success) {
+     *   console.log(`Connection OK, latency: ${result.latency}ms`);
+     * } else {
+     *   console.error(`Connection failed: ${result.error}`);
+     * }
+     * ```
+     */
+    testCustomApiConnection(integrationId: string): Promise<CustomApiTestResult>;
 }
 /**
  * Custom error class for Omni-Sync API errors
@@ -2068,4 +2212,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 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 CreateCustomerDto, type CreateGuestOrderDto, type CreateOrderDto, type CreateProductDto, type CreateRefundDto, type CreateVariantDto, type Customer, type CustomerAddress, type CustomerAuthResponse, type CustomerProfile, type CustomerQueryParams, type DraftLineItem, type EditInventoryDto, type FulfillOrderDto, type GuestOrderResponse, type InventoryInfo, type InventorySyncStatus, type LocalCart, type LocalCartItem, type MergeCartsDto, 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 ProductVariant, type PublishProductResponse, type ReconcileInventoryResponse, type Refund, type RefundLineItem, type RefundLineItemResponse, type RefundType, type RegisterCustomerDto, type SelectShippingMethodDto, type SendInvoiceDto, type SetBillingAddressDto, type SetCheckoutCustomerDto, type SetShippingAddressDto, type SetShippingAddressResponse, type ShippingLine, type ShippingRate, type StoreInfo, type SyncJob, type UpdateAddressDto, type UpdateCartItemDto, type UpdateCouponDto, 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 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 CustomerProfile, type CustomerQueryParams, type DraftLineItem, type EditInventoryDto, type FulfillOrderDto, type GuestOrderResponse, type InventoryInfo, type InventorySyncStatus, type LocalCart, type LocalCartItem, type MergeCartsDto, 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 ProductVariant, type PublishProductResponse, type ReconcileInventoryResponse, type Refund, type RefundLineItem, type RefundLineItemResponse, type RefundType, type RegisterCustomerDto, type SelectShippingMethodDto, type SendInvoiceDto, type SetBillingAddressDto, type SetCheckoutCustomerDto, type SetShippingAddressDto, type SetShippingAddressResponse, type ShippingLine, type ShippingRate, 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 };

package/dist/index.d.ts

@@ -69,6 +69,7 @@ interface Product {
     id: string;
     name: string;
     description?: string | null;
+    descriptionFormat?: 'text' | 'html' | 'markdown';
     sku: string;
     basePrice: number;
     salePrice?: number | null;
@@ -925,6 +926,63 @@ interface PublishProductResponse {
         error?: string;
     }>;
 }
+type CustomApiAuthType = 'api_key' | 'bearer' | 'basic' | 'oauth2';
+type CustomApiSyncDirection = 'inbound' | 'outbound' | 'bidirectional';
+type CustomApiConnectionStatus = 'CONNECTED' | 'DISCONNECTED' | 'PAUSED' | 'ERROR';
+interface CustomApiCredentials {
+    apiKey?: string;
+    bearerToken?: string;
+    username?: string;
+    password?: string;
+    headerName?: string;
+}
+interface CustomApiSyncConfig {
+    products?: boolean;
+    orders?: boolean;
+    inventory?: boolean;
+}
+interface CustomApiIntegration {
+    id: string;
+    storeId: string;
+    name: string;
+    description?: string | null;
+    baseUrl: string;
+    authType: CustomApiAuthType;
+    credentials?: CustomApiCredentials;
+    status: CustomApiConnectionStatus;
+    enabled: boolean;
+    syncDirection: CustomApiSyncDirection;
+    syncConfig?: CustomApiSyncConfig | null;
+    lastSyncAt?: string | null;
+    lastError?: string | null;
+    lastErrorAt?: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreateCustomApiDto {
+    name: string;
+    description?: string;
+    baseUrl: string;
+    authType: CustomApiAuthType;
+    credentials?: CustomApiCredentials;
+    syncDirection?: CustomApiSyncDirection;
+    syncConfig?: CustomApiSyncConfig;
+}
+interface UpdateCustomApiDto {
+    name?: string;
+    description?: string;
+    baseUrl?: string;
+    authType?: CustomApiAuthType;
+    credentials?: CustomApiCredentials;
+    enabled?: boolean;
+    syncDirection?: CustomApiSyncDirection;
+    syncConfig?: CustomApiSyncConfig;
+}
+interface CustomApiTestResult {
+    success: boolean;
+    latency?: number;
+    error?: string;
+}
 interface OmniSyncApiError {
     statusCode: number;
     message: string;
@@ -2001,6 +2059,92 @@ declare class OmniSyncClient {
      * Only available in storefront mode
      */
     getMyCart(): Promise<Cart>;
+    /**
+     * Get all Custom API integrations for a store
+     * Requires Admin mode (apiKey)
+     *
+     * @example
+     * ```typescript
+     * const integrations = await omni.getCustomApiIntegrations();
+     * integrations.forEach(api => {
+     *   console.log(`${api.name}: ${api.status}`);
+     * });
+     * ```
+     */
+    getCustomApiIntegrations(): Promise<CustomApiIntegration[]>;
+    /**
+     * Get a single Custom API integration by ID
+     * Requires Admin mode (apiKey)
+     *
+     * @example
+     * ```typescript
+     * const api = await omni.getCustomApiIntegration('api_123');
+     * console.log(`API: ${api.name}, URL: ${api.baseUrl}`);
+     * ```
+     */
+    getCustomApiIntegration(integrationId: string): Promise<CustomApiIntegration>;
+    /**
+     * Create a new Custom API integration
+     * Requires Admin mode (apiKey)
+     *
+     * @example
+     * ```typescript
+     * const api = await omni.createCustomApiIntegration({
+     *   name: 'My External API',
+     *   baseUrl: 'https://api.example.com',
+     *   authType: 'api_key',
+     *   credentials: {
+     *     apiKey: 'sk_123...',
+     *     headerName: 'X-API-Key',
+     *   },
+     *   syncDirection: 'bidirectional',
+     *   syncConfig: {
+     *     products: true,
+     *     orders: true,
+     *     inventory: true,
+     *   },
+     * });
+     * ```
+     */
+    createCustomApiIntegration(data: CreateCustomApiDto): Promise<CustomApiIntegration>;
+    /**
+     * Update a Custom API integration
+     * Requires Admin mode (apiKey)
+     *
+     * @example
+     * ```typescript
+     * const api = await omni.updateCustomApiIntegration('api_123', {
+     *   enabled: false,
+     *   syncConfig: { products: true, orders: false, inventory: true },
+     * });
+     * ```
+     */
+    updateCustomApiIntegration(integrationId: string, data: UpdateCustomApiDto): Promise<CustomApiIntegration>;
+    /**
+     * Delete a Custom API integration
+     * Requires Admin mode (apiKey)
+     *
+     * @example
+     * ```typescript
+     * await omni.deleteCustomApiIntegration('api_123');
+     * ```
+     */
+    deleteCustomApiIntegration(integrationId: string): Promise<void>;
+    /**
+     * Test connection to a Custom API
+     * Requires Admin mode (apiKey)
+     *
+     * @example
+     * ```typescript
+     * const result = await omni.testCustomApiConnection('api_123');
+     * if (result.success) {
+     *   console.log(`Connection OK, latency: ${result.latency}ms`);
+     * } else {
+     *   console.error(`Connection failed: ${result.error}`);
+     * }
+     * ```
+     */
+    testCustomApiConnection(integrationId: string): Promise<CustomApiTestResult>;
 }
 /**
  * Custom error class for Omni-Sync API errors
@@ -2068,4 +2212,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 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 CreateCustomerDto, type CreateGuestOrderDto, type CreateOrderDto, type CreateProductDto, type CreateRefundDto, type CreateVariantDto, type Customer, type CustomerAddress, type CustomerAuthResponse, type CustomerProfile, type CustomerQueryParams, type DraftLineItem, type EditInventoryDto, type FulfillOrderDto, type GuestOrderResponse, type InventoryInfo, type InventorySyncStatus, type LocalCart, type LocalCartItem, type MergeCartsDto, 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 ProductVariant, type PublishProductResponse, type ReconcileInventoryResponse, type Refund, type RefundLineItem, type RefundLineItemResponse, type RefundType, type RegisterCustomerDto, type SelectShippingMethodDto, type SendInvoiceDto, type SetBillingAddressDto, type SetCheckoutCustomerDto, type SetShippingAddressDto, type SetShippingAddressResponse, type ShippingLine, type ShippingRate, type StoreInfo, type SyncJob, type UpdateAddressDto, type UpdateCartItemDto, type UpdateCouponDto, 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 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 CustomerProfile, type CustomerQueryParams, type DraftLineItem, type EditInventoryDto, type FulfillOrderDto, type GuestOrderResponse, type InventoryInfo, type InventorySyncStatus, type LocalCart, type LocalCartItem, type MergeCartsDto, 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 ProductVariant, type PublishProductResponse, type ReconcileInventoryResponse, type Refund, type RefundLineItem, type RefundLineItemResponse, type RefundType, type RegisterCustomerDto, type SelectShippingMethodDto, type SendInvoiceDto, type SetBillingAddressDto, type SetCheckoutCustomerDto, type SetShippingAddressDto, type SetShippingAddressResponse, type ShippingLine, type ShippingRate, 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 };

package/dist/index.js

@@ -1893,6 +1893,113 @@ var OmniSyncClient = class {
     }
     return this.storefrontRequest("GET", "/customers/me/cart");
   }
+  // -------------------- Custom API Integrations --------------------
+  // These methods require Admin mode (apiKey)
+  /**
+   * Get all Custom API integrations for a store
+   * Requires Admin mode (apiKey)
+   *
+   * @example
+   * ```typescript
+   * const integrations = await omni.getCustomApiIntegrations();
+   * integrations.forEach(api => {
+   *   console.log(`${api.name}: ${api.status}`);
+   * });
+   * ```
+   */
+  async getCustomApiIntegrations() {
+    return this.adminRequest("GET", "/api/v1/custom-api");
+  }
+  /**
+   * Get a single Custom API integration by ID
+   * Requires Admin mode (apiKey)
+   *
+   * @example
+   * ```typescript
+   * const api = await omni.getCustomApiIntegration('api_123');
+   * console.log(`API: ${api.name}, URL: ${api.baseUrl}`);
+   * ```
+   */
+  async getCustomApiIntegration(integrationId) {
+    return this.adminRequest("GET", `/api/v1/custom-api/${integrationId}`);
+  }
+  /**
+   * Create a new Custom API integration
+   * Requires Admin mode (apiKey)
+   *
+   * @example
+   * ```typescript
+   * const api = await omni.createCustomApiIntegration({
+   *   name: 'My External API',
+   *   baseUrl: 'https://api.example.com',
+   *   authType: 'api_key',
+   *   credentials: {
+   *     apiKey: 'sk_123...',
+   *     headerName: 'X-API-Key',
+   *   },
+   *   syncDirection: 'bidirectional',
+   *   syncConfig: {
+   *     products: true,
+   *     orders: true,
+   *     inventory: true,
+   *   },
+   * });
+   * ```
+   */
+  async createCustomApiIntegration(data) {
+    return this.adminRequest("POST", "/api/v1/custom-api", data);
+  }
+  /**
+   * Update a Custom API integration
+   * Requires Admin mode (apiKey)
+   *
+   * @example
+   * ```typescript
+   * const api = await omni.updateCustomApiIntegration('api_123', {
+   *   enabled: false,
+   *   syncConfig: { products: true, orders: false, inventory: true },
+   * });
+   * ```
+   */
+  async updateCustomApiIntegration(integrationId, data) {
+    return this.adminRequest(
+      "PATCH",
+      `/api/v1/custom-api/${integrationId}`,
+      data
+    );
+  }
+  /**
+   * Delete a Custom API integration
+   * Requires Admin mode (apiKey)
+   *
+   * @example
+   * ```typescript
+   * await omni.deleteCustomApiIntegration('api_123');
+   * ```
+   */
+  async deleteCustomApiIntegration(integrationId) {
+    await this.adminRequest("DELETE", `/api/v1/custom-api/${integrationId}`);
+  }
+  /**
+   * Test connection to a Custom API
+   * Requires Admin mode (apiKey)
+   *
+   * @example
+   * ```typescript
+   * const result = await omni.testCustomApiConnection('api_123');
+   * if (result.success) {
+   *   console.log(`Connection OK, latency: ${result.latency}ms`);
+   * } else {
+   *   console.error(`Connection failed: ${result.error}`);
+   * }
+   * ```
+   */
+  async testCustomApiConnection(integrationId) {
+    return this.adminRequest(
+      "POST",
+      `/api/v1/custom-api/${integrationId}/test`
+    );
+  }
 };
 var OmniSyncError = class extends Error {
   constructor(message, statusCode, details) {

package/dist/index.mjs

@@ -1868,6 +1868,113 @@ var OmniSyncClient = class {
     }
     return this.storefrontRequest("GET", "/customers/me/cart");
   }
+  // -------------------- Custom API Integrations --------------------
+  // These methods require Admin mode (apiKey)
+  /**
+   * Get all Custom API integrations for a store
+   * Requires Admin mode (apiKey)
+   *
+   * @example
+   * ```typescript
+   * const integrations = await omni.getCustomApiIntegrations();
+   * integrations.forEach(api => {
+   *   console.log(`${api.name}: ${api.status}`);
+   * });
+   * ```
+   */
+  async getCustomApiIntegrations() {
+    return this.adminRequest("GET", "/api/v1/custom-api");
+  }
+  /**
+   * Get a single Custom API integration by ID
+   * Requires Admin mode (apiKey)
+   *
+   * @example
+   * ```typescript
+   * const api = await omni.getCustomApiIntegration('api_123');
+   * console.log(`API: ${api.name}, URL: ${api.baseUrl}`);
+   * ```
+   */
+  async getCustomApiIntegration(integrationId) {
+    return this.adminRequest("GET", `/api/v1/custom-api/${integrationId}`);
+  }
+  /**
+   * Create a new Custom API integration
+   * Requires Admin mode (apiKey)
+   *
+   * @example
+   * ```typescript
+   * const api = await omni.createCustomApiIntegration({
+   *   name: 'My External API',
+   *   baseUrl: 'https://api.example.com',
+   *   authType: 'api_key',
+   *   credentials: {
+   *     apiKey: 'sk_123...',
+   *     headerName: 'X-API-Key',
+   *   },
+   *   syncDirection: 'bidirectional',
+   *   syncConfig: {
+   *     products: true,
+   *     orders: true,
+   *     inventory: true,
+   *   },
+   * });
+   * ```
+   */
+  async createCustomApiIntegration(data) {
+    return this.adminRequest("POST", "/api/v1/custom-api", data);
+  }
+  /**
+   * Update a Custom API integration
+   * Requires Admin mode (apiKey)
+   *
+   * @example
+   * ```typescript
+   * const api = await omni.updateCustomApiIntegration('api_123', {
+   *   enabled: false,
+   *   syncConfig: { products: true, orders: false, inventory: true },
+   * });
+   * ```
+   */
+  async updateCustomApiIntegration(integrationId, data) {
+    return this.adminRequest(
+      "PATCH",
+      `/api/v1/custom-api/${integrationId}`,
+      data
+    );
+  }
+  /**
+   * Delete a Custom API integration
+   * Requires Admin mode (apiKey)
+   *
+   * @example
+   * ```typescript
+   * await omni.deleteCustomApiIntegration('api_123');
+   * ```
+   */
+  async deleteCustomApiIntegration(integrationId) {
+    await this.adminRequest("DELETE", `/api/v1/custom-api/${integrationId}`);
+  }
+  /**
+   * Test connection to a Custom API
+   * Requires Admin mode (apiKey)
+   *
+   * @example
+   * ```typescript
+   * const result = await omni.testCustomApiConnection('api_123');
+   * if (result.success) {
+   *   console.log(`Connection OK, latency: ${result.latency}ms`);
+   * } else {
+   *   console.error(`Connection failed: ${result.error}`);
+   * }
+   * ```
+   */
+  async testCustomApiConnection(integrationId) {
+    return this.adminRequest(
+      "POST",
+      `/api/v1/custom-api/${integrationId}/test`
+    );
+  }
 };
 var OmniSyncError = class extends Error {
   constructor(message, statusCode, details) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "omni-sync-sdk",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "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",