omni-sync-sdk 0.4.0 → 0.4.1

package/README.md

@@ -109,15 +109,15 @@ import type { Product, PaginatedResponse } from 'omni-sync-sdk';
 const response: PaginatedResponse<Product> = await omni.getProducts({
   page: 1,
   limit: 12,
-  search: 'shirt',        // Optional: search by name
-  status: 'active',       // Optional: 'active' | 'draft' | 'archived'
-  type: 'SIMPLE',         // Optional: 'SIMPLE' | 'VARIABLE'
-  sortBy: 'createdAt',    // Optional: 'name' | 'createdAt' | 'updatedAt' | 'basePrice'
-  sortOrder: 'desc',      // Optional: 'asc' | 'desc'
+  search: 'shirt', // Optional: search by name
+  status: 'active', // Optional: 'active' | 'draft' | 'archived'
+  type: 'SIMPLE', // Optional: 'SIMPLE' | 'VARIABLE'
+  sortBy: 'createdAt', // Optional: 'name' | 'createdAt' | 'updatedAt' | 'basePrice'
+  sortOrder: 'desc', // Optional: 'asc' | 'desc'
 });
 
-console.log(response.data);          // Product[]
-console.log(response.meta.total);    // Total number of products
+console.log(response.data); // Product[]
+console.log(response.meta.total); // Total number of products
 console.log(response.meta.totalPages); // Total pages
 ```
 
@@ -128,10 +128,10 @@ const product: Product = await omni.getProduct('product_id');
 
 console.log(product.name);
 console.log(product.basePrice);
-console.log(product.salePrice);      // null if no sale
-console.log(product.images);         // ProductImage[]
-console.log(product.variants);       // ProductVariant[] (for VARIABLE products)
-console.log(product.inventory);      // { total, reserved, available }
+console.log(product.salePrice); // null if no sale
+console.log(product.images); // ProductImage[]
+console.log(product.variants); // ProductVariant[] (for VARIABLE products)
+console.log(product.inventory); // { total, reserved, available }
 ```
 
 #### Product Type Definition
@@ -195,9 +195,9 @@ setCartId(cart.id); // Save to localStorage
 const cartId = getCartId();
 if (cartId) {
   const cart = await omni.getCart(cartId);
-  console.log(cart.items);       // CartItem[]
-  console.log(cart.itemCount);   // Total items
-  console.log(cart.subtotal);    // Subtotal amount
+  console.log(cart.items); // CartItem[]
+  console.log(cart.itemCount); // Total items
+  console.log(cart.subtotal); // Subtotal amount
 }
 ```
 
@@ -206,7 +206,7 @@ if (cartId) {
 ```typescript
 const cart = await omni.addToCart(cartId, {
   productId: 'product_id',
-  variantId: 'variant_id',  // Optional: for VARIABLE products
+  variantId: 'variant_id', // Optional: for VARIABLE products
   quantity: 2,
   notes: 'Gift wrap please', // Optional
 });
@@ -231,7 +231,7 @@ const cart = await omni.removeCartItem(cartId, itemId);
 ```typescript
 const cart = await omni.applyCoupon(cartId, 'SAVE20');
 console.log(cart.discountAmount); // Discount applied
-console.log(cart.couponCode);     // 'SAVE20'
+console.log(cart.couponCode); // 'SAVE20'
 ```
 
 #### Remove Coupon
@@ -310,12 +310,12 @@ const { checkout, rates } = await omni.setShippingAddress(checkoutId, {
   firstName: 'John',
   lastName: 'Doe',
   line1: '123 Main St',
-  line2: 'Apt 4B',        // Optional
+  line2: 'Apt 4B', // Optional
   city: 'New York',
-  region: 'NY',           // State/Province
+  region: 'NY', // State/Province
   postalCode: '10001',
   country: 'US',
-  phone: '+1234567890',   // Optional
+  phone: '+1234567890', // Optional
 });
 
 // rates contains available shipping options
@@ -368,12 +368,7 @@ interface Checkout {
   availableShippingRates?: ShippingRate[];
 }
 
-type CheckoutStatus =
-  | 'PENDING'
-  | 'SHIPPING_SET'
-  | 'PAYMENT_PENDING'
-  | 'COMPLETED'
-  | 'FAILED';
+type CheckoutStatus = 'PENDING' | 'SHIPPING_SET' | 'PAYMENT_PENDING' | 'COMPLETED' | 'FAILED';
 
 interface ShippingRate {
   id: string;
@@ -498,7 +493,7 @@ await omni.deleteMyAddress(addressId);
 ```typescript
 const store = await omni.getStoreInfo();
 
-console.log(store.name);     // Store name
+console.log(store.name); // Store name
 console.log(store.currency); // 'USD', 'ILS', etc.
 console.log(store.language); // 'en', 'he', etc.
 ```
@@ -1318,15 +1313,15 @@ export async function POST(req: Request) {
 
 ### Webhook Events
 
-| Event | Description |
-|-------|-------------|
-| `product.created` | New product created |
-| `product.updated` | Product details changed |
-| `product.deleted` | Product removed |
-| `inventory.updated` | Stock levels changed |
-| `order.created` | New order received |
-| `order.updated` | Order status changed |
-| `cart.abandoned` | Cart abandoned (no activity) |
+| Event                | Description                     |
+| -------------------- | ------------------------------- |
+| `product.created`    | New product created             |
+| `product.updated`    | Product details changed         |
+| `product.deleted`    | Product removed                 |
+| `inventory.updated`  | Stock levels changed            |
+| `order.created`      | New order received              |
+| `order.updated`      | Order status changed            |
+| `cart.abandoned`     | Cart abandoned (no activity)    |
 | `checkout.completed` | Checkout completed successfully |
 
 ---
@@ -1411,6 +1406,7 @@ When building a store, implement these pages:
 ## Important Rules
 
 ### DO:
+
 - Install `omni-sync-sdk` and use it for ALL data
 - Import types from the SDK
 - Handle loading states and errors
@@ -1418,10 +1414,12 @@ When building a store, implement these pages:
 - Persist customer token after login
 
 ### DON'T:
+
 - Create mock/hardcoded product data
 - Use localStorage for products
 - 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
 
 ---
 

package/package.json

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