omni-sync-sdk 0.18.1 → 0.18.3

package/dist/index.d.mts

@@ -113,20 +113,26 @@ interface CustomerProfile {
     updatedAt: string;
 }
 interface ProductMetafield {
-    id?: string;
-    definitionId?: string;
-    /** Key from definition (alias: definitionKey) */
-    key: string;
-    /** Alias for key from backend */
-    definitionKey?: string;
+    id: string;
+    definitionId: string;
+    /** Key from the metafield definition */
+    definitionKey: string;
+    /** Display name from the metafield definition */
+    definitionName: string;
+    /** Metafield type (e.g., 'text', 'number', 'boolean') */
+    type: string;
+    /** The metafield value */
     value: string;
-    /** Display name (maps to definitionName in backend) */
-    name?: string;
-    /** Alias for name from backend */
-    definitionName?: string;
-    type?: string;
     /** Variant ID if this metafield is variant-specific */
     variantId?: string | null;
+    /**
+     * @deprecated Use `definitionKey` instead. Alias for backwards compatibility.
+     */
+    key?: string;
+    /**
+     * @deprecated Use `definitionName` instead. Alias for backwards compatibility.
+     */
+    name?: string;
 }
 interface Product {
     id: string;
@@ -141,7 +147,8 @@ interface Product {
     salePrice?: string | null;
     /** Cost price as string. Use parseFloat() for calculations. */
     costPrice?: string | null;
-    status?: string | null;
+    /** Product status (active, draft, archived). Always returned by backend. */
+    status: string;
     type: 'SIMPLE' | 'VARIABLE';
     isDownloadable?: boolean;
     images?: ProductImage[];
@@ -162,6 +169,10 @@ interface Product {
     channels?: Record<string, Record<string, unknown>>;
     /** Shopify product ID (admin mode only) */
     shopifyProductId?: string | null;
+    /** WooCommerce product ID (admin mode only) */
+    woocommerceProductId?: string | null;
+    /** Meta/Facebook Item Group ID (admin mode only) */
+    metaItemGroupId?: string | null;
     /** Whether product needs sync to platforms (admin mode only) */
     needsSync?: boolean;
     /** Last sync timestamp (admin mode only) */
@@ -201,6 +212,20 @@ interface ProductImage {
     isMain?: boolean;
     /** Alt text for accessibility */
     alt?: string;
+    /** Image ID (admin mode only) */
+    id?: string;
+    /** Storage key (admin mode only) */
+    key?: string;
+    /** Thumbnail URL for previews (admin mode only) */
+    thumbnailUrl?: string;
+    /** Image width in pixels (admin mode only) */
+    width?: number;
+    /** Image height in pixels (admin mode only) */
+    height?: number;
+    /** File size in bytes (admin mode only) */
+    size?: number;
+    /** MIME type (admin mode only) */
+    mimeType?: string;
 }
 interface ProductVariant {
     id: string;
@@ -216,7 +241,10 @@ interface ProductVariant {
     attributes?: Record<string, unknown> | null;
     inventory?: InventoryInfo | null;
     /** Variant image URL or image object */
-    image?: unknown | null;
+    image?: string | {
+        url: string;
+        thumbnailUrl?: string;
+    } | null;
     /** Display position/order for sorting variants */
     position: number;
     /** Variant status */
@@ -246,7 +274,7 @@ interface InventoryInfo {
      * - All DISABLED → DISABLED
      * - Mixed → TRACKED
      */
-    trackingMode?: InventoryTrackingMode;
+    trackingMode: InventoryTrackingMode;
     /**
      * Whether the item is in stock.
      * Pre-calculated by backend - USE THIS instead of checking `available > 0`!
@@ -1824,9 +1852,12 @@ interface UpdateVariantInventoryDto {
     reason?: string;
 }
 interface VariantInventoryResponse {
+    trackingMode: InventoryTrackingMode;
     total: number;
     reserved: number;
     available: number;
+    inStock: boolean;
+    canPurchase: boolean;
     lastInventorySyncAt?: string | null;
 }
 type RefundType = 'full' | 'partial';

package/dist/index.d.ts

@@ -113,20 +113,26 @@ interface CustomerProfile {
     updatedAt: string;
 }
 interface ProductMetafield {
-    id?: string;
-    definitionId?: string;
-    /** Key from definition (alias: definitionKey) */
-    key: string;
-    /** Alias for key from backend */
-    definitionKey?: string;
+    id: string;
+    definitionId: string;
+    /** Key from the metafield definition */
+    definitionKey: string;
+    /** Display name from the metafield definition */
+    definitionName: string;
+    /** Metafield type (e.g., 'text', 'number', 'boolean') */
+    type: string;
+    /** The metafield value */
     value: string;
-    /** Display name (maps to definitionName in backend) */
-    name?: string;
-    /** Alias for name from backend */
-    definitionName?: string;
-    type?: string;
     /** Variant ID if this metafield is variant-specific */
     variantId?: string | null;
+    /**
+     * @deprecated Use `definitionKey` instead. Alias for backwards compatibility.
+     */
+    key?: string;
+    /**
+     * @deprecated Use `definitionName` instead. Alias for backwards compatibility.
+     */
+    name?: string;
 }
 interface Product {
     id: string;
@@ -141,7 +147,8 @@ interface Product {
     salePrice?: string | null;
     /** Cost price as string. Use parseFloat() for calculations. */
     costPrice?: string | null;
-    status?: string | null;
+    /** Product status (active, draft, archived). Always returned by backend. */
+    status: string;
     type: 'SIMPLE' | 'VARIABLE';
     isDownloadable?: boolean;
     images?: ProductImage[];
@@ -162,6 +169,10 @@ interface Product {
     channels?: Record<string, Record<string, unknown>>;
     /** Shopify product ID (admin mode only) */
     shopifyProductId?: string | null;
+    /** WooCommerce product ID (admin mode only) */
+    woocommerceProductId?: string | null;
+    /** Meta/Facebook Item Group ID (admin mode only) */
+    metaItemGroupId?: string | null;
     /** Whether product needs sync to platforms (admin mode only) */
     needsSync?: boolean;
     /** Last sync timestamp (admin mode only) */
@@ -201,6 +212,20 @@ interface ProductImage {
     isMain?: boolean;
     /** Alt text for accessibility */
     alt?: string;
+    /** Image ID (admin mode only) */
+    id?: string;
+    /** Storage key (admin mode only) */
+    key?: string;
+    /** Thumbnail URL for previews (admin mode only) */
+    thumbnailUrl?: string;
+    /** Image width in pixels (admin mode only) */
+    width?: number;
+    /** Image height in pixels (admin mode only) */
+    height?: number;
+    /** File size in bytes (admin mode only) */
+    size?: number;
+    /** MIME type (admin mode only) */
+    mimeType?: string;
 }
 interface ProductVariant {
     id: string;
@@ -216,7 +241,10 @@ interface ProductVariant {
     attributes?: Record<string, unknown> | null;
     inventory?: InventoryInfo | null;
     /** Variant image URL or image object */
-    image?: unknown | null;
+    image?: string | {
+        url: string;
+        thumbnailUrl?: string;
+    } | null;
     /** Display position/order for sorting variants */
     position: number;
     /** Variant status */
@@ -246,7 +274,7 @@ interface InventoryInfo {
      * - All DISABLED → DISABLED
      * - Mixed → TRACKED
      */
-    trackingMode?: InventoryTrackingMode;
+    trackingMode: InventoryTrackingMode;
     /**
      * Whether the item is in stock.
      * Pre-calculated by backend - USE THIS instead of checking `available > 0`!
@@ -1824,9 +1852,12 @@ interface UpdateVariantInventoryDto {
     reason?: string;
 }
 interface VariantInventoryResponse {
+    trackingMode: InventoryTrackingMode;
     total: number;
     reserved: number;
     available: number;
+    inStock: boolean;
+    canPurchase: boolean;
     lastInventorySyncAt?: string | null;
 }
 type RefundType = 'full' | 'partial';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "omni-sync-sdk",
-  "version": "0.18.1",
+  "version": "0.18.3",
   "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,6 +16,14 @@
     "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",
@@ -64,12 +72,5 @@
     "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"
   }
-}
+}