@tallyui/connector-woocommerce 1.0.0 → 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Paul Kilmurray and TallyUI contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -32,9 +32,9 @@ type WooProductCheckpoint = {
 /**
  * Replication adapter for WooCommerce products.
  *
- * Implements pull (cursor-based pagination by date_modified_gmt) and push
- * (individual create/update via WC REST API v3). Designed for use with
- * RxDB's replicateRxCollection.
+ * Pull-only (cursor-based pagination by date_modified_gmt) for RxDB's
+ * replicateRxCollection. Catalogue data is server-owned; the POS never
+ * writes products.
  */
 declare const wooProductReplication: ReplicationAdapter<any, WooProductCheckpoint>;
 

package/dist/index.js

@@ -144,10 +144,29 @@ var wooProductSchema = {
 };
 
 // src/traits/product.ts
+import { moneyFromMajor } from "@tallyui/core";
+var WOO_STOCK_STATUS = {
+  instock: "in_stock",
+  outofstock: "out_of_stock",
+  onbackorder: "backorder"
+};
 var wooProductTraits = {
   getId: (doc) => String(doc.id),
   getName: (doc) => doc.name ?? "",
   getSku: (doc) => doc.sku || void 0,
+  getPrices: (doc, context) => {
+    const currency = context?.currency ?? "XXX";
+    const prices = [];
+    const base = moneyFromMajor(doc.regular_price || doc.price, currency);
+    if (base) prices.push({ ...base, kind: "base" });
+    const sale = doc.on_sale === true ? moneyFromMajor(doc.sale_price, currency) : void 0;
+    if (sale) prices.push({ ...sale, kind: "sale" });
+    return prices;
+  },
+  getStock: (doc) => ({
+    status: WOO_STOCK_STATUS[doc.stock_status] ?? "unknown",
+    quantity: doc.manage_stock === false ? void 0 : doc.stock_quantity ?? void 0
+  }),
   getPrice: (doc) => doc.price || void 0,
   getRegularPrice: (doc) => doc.regular_price || void 0,
   getSalePrice: (doc) => doc.sale_price || void 0,
@@ -164,6 +183,8 @@ var wooProductTraits = {
   },
   getStockQuantity: (doc) => doc.stock_quantity ?? null,
   hasVariants: (doc) => doc.type === "variable",
+  isSellable: (doc) => doc.status === void 0 || doc.status === "publish",
+  getVariantCount: (doc) => doc.type === "variable" ? doc.variations?.length ?? 0 : 1,
   getType: (doc) => doc.type ?? "simple",
   getBarcode: (doc) => doc.barcode || void 0,
   getCategoryNames: (doc) => (doc.categories ?? []).map((cat) => cat.name).filter(Boolean)
@@ -253,38 +274,6 @@ var wooProductReplication = {
       } : lastCheckpoint ?? { id: "", modified: "" };
       return { documents, checkpoint };
     }
-  },
-  push: {
-    async handler(changeRows, context) {
-      const conflicts = [];
-      for (const row of changeRows) {
-        const doc = row.newDocumentState;
-        try {
-          const isCreate = !row.assumedMasterState;
-          const method = isCreate ? "POST" : "PUT";
-          const url = isCreate ? `${context.baseUrl}/products` : `${context.baseUrl}/products/${doc.id}`;
-          const response = await fetch(url, {
-            method,
-            headers: {
-              ...context.headers,
-              "Content-Type": "application/json"
-            },
-            body: JSON.stringify(doc),
-            signal: context.signal
-          });
-          if (!response.ok) {
-            if (row.assumedMasterState) {
-              conflicts.push({ ...row.assumedMasterState, _deleted: false });
-            }
-          }
-        } catch {
-          if (row.assumedMasterState) {
-            conflicts.push({ ...row.assumedMasterState, _deleted: false });
-          }
-        }
-      }
-      return conflicts;
-    }
   }
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tallyui/connector-woocommerce",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "type": "module",
   "description": "WooCommerce connector for Tally UI",
   "main": "./dist/index.js",
@@ -15,11 +15,17 @@
   },
   "files": [
     "dist",
-    "src"
+    "src",
+    "!src/**/*.test.ts"
   ],
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TallyUI/tallyui.git",
+    "directory": "connectors/woocommerce"
+  },
   "peerDependencies": {
-    "@tallyui/core": "0.2.0"
+    "@tallyui/core": "2.0.0"
   },
   "devDependencies": {
     "rxdb": "16.21.1"

package/src/replication/products.ts

@@ -1,4 +1,4 @@
-import type { ReplicationAdapter, SyncContext } from '@tallyui/core';
+import type { ReplicationAdapter } from '@tallyui/core';
 
 export type WooProductCheckpoint = {
   id: string;
@@ -8,9 +8,9 @@ export type WooProductCheckpoint = {
 /**
  * Replication adapter for WooCommerce products.
  *
- * Implements pull (cursor-based pagination by date_modified_gmt) and push
- * (individual create/update via WC REST API v3). Designed for use with
- * RxDB's replicateRxCollection.
+ * Pull-only (cursor-based pagination by date_modified_gmt) for RxDB's
+ * replicateRxCollection. Catalogue data is server-owned; the POS never
+ * writes products.
  */
 export const wooProductReplication: ReplicationAdapter<any, WooProductCheckpoint> = {
   pull: {
@@ -50,44 +50,4 @@ export const wooProductReplication: ReplicationAdapter<any, WooProductCheckpoint
       return { documents, checkpoint };
     },
   },
-
-  push: {
-    async handler(changeRows, context) {
-      const conflicts: any[] = [];
-
-      for (const row of changeRows) {
-        const doc = row.newDocumentState as any;
-
-        try {
-          const isCreate = !row.assumedMasterState;
-          const method = isCreate ? 'POST' : 'PUT';
-          const url = isCreate
-            ? `${context.baseUrl}/products`
-            : `${context.baseUrl}/products/${doc.id}`;
-
-          const response = await fetch(url, {
-            method,
-            headers: {
-              ...context.headers,
-              'Content-Type': 'application/json',
-            },
-            body: JSON.stringify(doc),
-            signal: context.signal,
-          });
-
-          if (!response.ok) {
-            if (row.assumedMasterState) {
-              conflicts.push({ ...row.assumedMasterState, _deleted: false });
-            }
-          }
-        } catch {
-          if (row.assumedMasterState) {
-            conflicts.push({ ...row.assumedMasterState, _deleted: false });
-          }
-        }
-      }
-
-      return conflicts;
-    },
-  },
 };

package/src/traits/product.ts

@@ -1,4 +1,12 @@
-import type { ProductTraits } from '@tallyui/core';
+import { moneyFromMajor } from '@tallyui/core';
+import type { ProductPrice, ProductTraits, StockStatus } from '@tallyui/core';
+
+/** WooCommerce's stock_status strings, mapped to the neutral enum. */
+const WOO_STOCK_STATUS: Record<string, StockStatus> = {
+  instock: 'in_stock',
+  outofstock: 'out_of_stock',
+  onbackorder: 'backorder',
+};
 
 /**
  * WooCommerce product trait implementations.
@@ -13,6 +21,22 @@ export const wooProductTraits: ProductTraits = {
 
   getSku: (doc) => doc.sku || undefined,
 
+  getPrices: (doc, context) => {
+    // Woo prices are decimal strings with no currency; the store supplies it.
+    const currency = context?.currency ?? 'XXX';
+    const prices: ProductPrice[] = [];
+    const base = moneyFromMajor(doc.regular_price || doc.price, currency);
+    if (base) prices.push({ ...base, kind: 'base' });
+    const sale = doc.on_sale === true ? moneyFromMajor(doc.sale_price, currency) : undefined;
+    if (sale) prices.push({ ...sale, kind: 'sale' });
+    return prices;
+  },
+
+  getStock: (doc) => ({
+    status: WOO_STOCK_STATUS[doc.stock_status] ?? 'unknown',
+    quantity: doc.manage_stock === false ? undefined : doc.stock_quantity ?? undefined,
+  }),
+
   getPrice: (doc) => doc.price || undefined,
 
   getRegularPrice: (doc) => doc.regular_price || undefined,
@@ -39,6 +63,10 @@ export const wooProductTraits: ProductTraits = {
 
   hasVariants: (doc) => doc.type === 'variable',
 
+  isSellable: (doc) => doc.status === undefined || doc.status === 'publish',
+
+  getVariantCount: (doc) => doc.type === 'variable' ? doc.variations?.length ?? 0 : 1,
+
   getType: (doc) => doc.type ?? 'simple',
 
   getBarcode: (doc) => doc.barcode || undefined,

package/src/__tests__/product-traits.test.ts

@@ -1,191 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import { wooProductTraits } from '../traits/product';
-
-/**
- * Realistic WooCommerce product document, shaped like the REST API v3 response.
- */
-const fullProduct = {
-  id: 42,
-  name: 'Espresso Machine Pro',
-  slug: 'espresso-machine-pro',
-  type: 'simple',
-  status: 'publish',
-  sku: 'ESP-001',
-  price: '599.99',
-  regular_price: '599.99',
-  sale_price: '',
-  on_sale: false,
-  stock_status: 'instock',
-  stock_quantity: 15,
-  barcode: '1234567890123',
-  short_description: 'High-end espresso machine.',
-  description: 'Full description here.',
-  images: [
-    { id: 1, src: 'https://store.example/espresso.jpg', alt: 'Espresso Machine' },
-    { id: 2, src: 'https://store.example/espresso-side.jpg', alt: '' },
-  ],
-  categories: [
-    { id: 1, name: 'Equipment', slug: 'equipment' },
-    { id: 2, name: 'Coffee', slug: 'coffee' },
-  ],
-};
-
-const saleProduct = {
-  ...fullProduct,
-  id: 43,
-  price: '499.99',
-  sale_price: '499.99',
-  on_sale: true,
-};
-
-const variableProduct = {
-  ...fullProduct,
-  id: 44,
-  type: 'variable',
-  variations: [101, 102],
-};
-
-const minimalProduct = {
-  id: 99,
-};
-
-describe('WooCommerce product traits', () => {
-  describe('getId', () => {
-    it('returns the product id as a string', () => {
-      expect(wooProductTraits.getId(fullProduct)).toBe('42');
-    });
-  });
-
-  describe('getName', () => {
-    it('returns the product name', () => {
-      expect(wooProductTraits.getName(fullProduct)).toBe('Espresso Machine Pro');
-    });
-
-    it('returns empty string for missing name', () => {
-      expect(wooProductTraits.getName(minimalProduct)).toBe('');
-    });
-  });
-
-  describe('getSku', () => {
-    it('returns the SKU', () => {
-      expect(wooProductTraits.getSku(fullProduct)).toBe('ESP-001');
-    });
-
-    it('returns undefined when no SKU', () => {
-      expect(wooProductTraits.getSku(minimalProduct)).toBeUndefined();
-    });
-  });
-
-  describe('getPrice', () => {
-    it('returns the price string', () => {
-      expect(wooProductTraits.getPrice(fullProduct)).toBe('599.99');
-    });
-
-    it('returns undefined for missing price', () => {
-      expect(wooProductTraits.getPrice(minimalProduct)).toBeUndefined();
-    });
-  });
-
-  describe('getRegularPrice / getSalePrice / isOnSale', () => {
-    it('returns regular price', () => {
-      expect(wooProductTraits.getRegularPrice(fullProduct)).toBe('599.99');
-    });
-
-    it('detects non-sale product', () => {
-      expect(wooProductTraits.isOnSale(fullProduct)).toBe(false);
-      expect(wooProductTraits.getSalePrice(fullProduct)).toBeUndefined();
-    });
-
-    it('detects sale product', () => {
-      expect(wooProductTraits.isOnSale(saleProduct)).toBe(true);
-      expect(wooProductTraits.getSalePrice(saleProduct)).toBe('499.99');
-    });
-  });
-
-  describe('getImageUrl / getImageUrls', () => {
-    it('returns the first image src', () => {
-      expect(wooProductTraits.getImageUrl(fullProduct)).toBe('https://store.example/espresso.jpg');
-    });
-
-    it('returns all image URLs', () => {
-      expect(wooProductTraits.getImageUrls(fullProduct)).toEqual([
-        'https://store.example/espresso.jpg',
-        'https://store.example/espresso-side.jpg',
-      ]);
-    });
-
-    it('returns undefined / empty for missing images', () => {
-      expect(wooProductTraits.getImageUrl(minimalProduct)).toBeUndefined();
-      expect(wooProductTraits.getImageUrls(minimalProduct)).toEqual([]);
-    });
-  });
-
-  describe('getDescription', () => {
-    it('prefers short_description', () => {
-      expect(wooProductTraits.getDescription(fullProduct)).toBe('High-end espresso machine.');
-    });
-
-    it('falls back to description', () => {
-      const doc = { ...fullProduct, short_description: '' };
-      expect(wooProductTraits.getDescription(doc)).toBe('Full description here.');
-    });
-
-    it('returns undefined when neither exists', () => {
-      expect(wooProductTraits.getDescription(minimalProduct)).toBeUndefined();
-    });
-  });
-
-  describe('getStockStatus / getStockQuantity', () => {
-    it('returns instock status', () => {
-      expect(wooProductTraits.getStockStatus(fullProduct)).toBe('instock');
-    });
-
-    it('returns stock quantity', () => {
-      expect(wooProductTraits.getStockQuantity(fullProduct)).toBe(15);
-    });
-
-    it('returns unknown for unrecognised status', () => {
-      expect(wooProductTraits.getStockStatus({ ...fullProduct, stock_status: 'weird' })).toBe('unknown');
-    });
-
-    it('returns null quantity when missing', () => {
-      expect(wooProductTraits.getStockQuantity(minimalProduct)).toBeNull();
-    });
-  });
-
-  describe('hasVariants / getType', () => {
-    it('simple product has no variants', () => {
-      expect(wooProductTraits.hasVariants(fullProduct)).toBe(false);
-      expect(wooProductTraits.getType(fullProduct)).toBe('simple');
-    });
-
-    it('variable product has variants', () => {
-      expect(wooProductTraits.hasVariants(variableProduct)).toBe(true);
-      expect(wooProductTraits.getType(variableProduct)).toBe('variable');
-    });
-
-    it('defaults to simple for missing type', () => {
-      expect(wooProductTraits.getType(minimalProduct)).toBe('simple');
-    });
-  });
-
-  describe('getBarcode', () => {
-    it('returns barcode', () => {
-      expect(wooProductTraits.getBarcode(fullProduct)).toBe('1234567890123');
-    });
-
-    it('returns undefined when missing', () => {
-      expect(wooProductTraits.getBarcode(minimalProduct)).toBeUndefined();
-    });
-  });
-
-  describe('getCategoryNames', () => {
-    it('returns category name strings', () => {
-      expect(wooProductTraits.getCategoryNames(fullProduct)).toEqual(['Equipment', 'Coffee']);
-    });
-
-    it('returns empty array when no categories', () => {
-      expect(wooProductTraits.getCategoryNames(minimalProduct)).toEqual([]);
-    });
-  });
-});

package/src/replication/products.test.ts

@@ -1,189 +0,0 @@
-import { describe, it, expect, vi, beforeEach } from 'vitest';
-import type { SyncContext } from '@tallyui/core';
-
-import { wooProductReplication } from './products';
-
-const context: SyncContext = {
-  connectorId: 'woocommerce',
-  baseUrl: 'https://example.com/wp-json/wc/v3',
-  headers: { Authorization: 'Basic dGVzdDp0ZXN0' },
-};
-
-describe('wooProductReplication.pull.handler', () => {
-  beforeEach(() => {
-    vi.restoreAllMocks();
-  });
-
-  it('fetches products from initial checkpoint (undefined)', async () => {
-    const mockProducts = [
-      { id: 1, uuid: 'abc', name: 'Widget', date_modified_gmt: '2026-01-01T00:00:00' },
-      { id: 2, uuid: 'def', name: 'Gadget', date_modified_gmt: '2026-01-02T00:00:00' },
-    ];
-
-    vi.spyOn(globalThis, 'fetch').mockResolvedValueOnce(
-      new Response(JSON.stringify(mockProducts), { status: 200 }),
-    );
-
-    const result = await wooProductReplication.pull.handler(undefined, 100, context);
-
-    expect(result.documents).toHaveLength(2);
-    expect(result.documents[0]._deleted).toBe(false);
-    expect(result.checkpoint).toEqual({
-      id: 'def',
-      modified: '2026-01-02T00:00:00',
-    });
-  });
-
-  it('fetches products after a checkpoint', async () => {
-    vi.spyOn(globalThis, 'fetch').mockResolvedValueOnce(
-      new Response(JSON.stringify([]), { status: 200 }),
-    );
-
-    const checkpoint = { id: 'abc', modified: '2026-01-01T00:00:00' };
-    const result = await wooProductReplication.pull.handler(checkpoint, 100, context);
-
-    expect(result.documents).toHaveLength(0);
-
-    const calledUrl = (globalThis.fetch as any).mock.calls[0][0];
-    expect(calledUrl).toContain('modified_after=2026-01-01T00%3A00%3A00');
-    expect(calledUrl).toContain('orderby=modified');
-    expect(calledUrl).toContain('order=asc');
-  });
-
-  it('uses batchSize as per_page', async () => {
-    vi.spyOn(globalThis, 'fetch').mockResolvedValueOnce(
-      new Response(JSON.stringify([]), { status: 200 }),
-    );
-
-    await wooProductReplication.pull.handler(undefined, 25, context);
-
-    const calledUrl = (globalThis.fetch as any).mock.calls[0][0];
-    expect(calledUrl).toContain('per_page=25');
-  });
-
-  it('throws on non-OK response', async () => {
-    vi.spyOn(globalThis, 'fetch').mockResolvedValueOnce(
-      new Response('Internal Server Error', { status: 500 }),
-    );
-
-    await expect(
-      wooProductReplication.pull.handler(undefined, 100, context),
-    ).rejects.toThrow('WooCommerce API error: 500');
-  });
-
-  it('returns lastCheckpoint when no products are returned', async () => {
-    vi.spyOn(globalThis, 'fetch').mockResolvedValueOnce(
-      new Response(JSON.stringify([]), { status: 200 }),
-    );
-
-    const checkpoint = { id: 'abc', modified: '2026-01-01T00:00:00' };
-    const result = await wooProductReplication.pull.handler(checkpoint, 100, context);
-
-    expect(result.checkpoint).toEqual(checkpoint);
-  });
-
-  it('falls back to id when uuid is missing', async () => {
-    const mockProducts = [
-      { id: 42, name: 'No UUID', date_modified_gmt: '2026-03-01T00:00:00' },
-    ];
-
-    vi.spyOn(globalThis, 'fetch').mockResolvedValueOnce(
-      new Response(JSON.stringify(mockProducts), { status: 200 }),
-    );
-
-    const result = await wooProductReplication.pull.handler(undefined, 100, context);
-
-    expect(result.checkpoint.id).toBe('42');
-  });
-});
-
-describe('wooProductReplication.push.handler', () => {
-  beforeEach(() => {
-    vi.restoreAllMocks();
-  });
-
-  it('sends PUT for updates', async () => {
-    vi.spyOn(globalThis, 'fetch').mockResolvedValueOnce(
-      new Response(JSON.stringify({}), { status: 200 }),
-    );
-
-    const conflicts = await wooProductReplication.push!.handler(
-      [{
-        newDocumentState: { id: '1', name: 'Updated', _deleted: false } as any,
-        assumedMasterState: { id: '1', name: 'Old', _deleted: false } as any,
-      }],
-      context,
-    );
-
-    expect(conflicts).toHaveLength(0);
-    const [url, opts] = (globalThis.fetch as any).mock.calls[0];
-    expect(url).toContain('/products/1');
-    expect(opts.method).toBe('PUT');
-  });
-
-  it('sends POST for creates', async () => {
-    vi.spyOn(globalThis, 'fetch').mockResolvedValueOnce(
-      new Response(JSON.stringify({}), { status: 200 }),
-    );
-
-    const conflicts = await wooProductReplication.push!.handler(
-      [{
-        newDocumentState: { id: '1', name: 'New Product', _deleted: false } as any,
-        // No assumedMasterState = create
-      }],
-      context,
-    );
-
-    expect(conflicts).toHaveLength(0);
-    const [, opts] = (globalThis.fetch as any).mock.calls[0];
-    expect(opts.method).toBe('POST');
-  });
-
-  it('returns conflicts on server error', async () => {
-    vi.spyOn(globalThis, 'fetch').mockResolvedValueOnce(
-      new Response('conflict', { status: 409 }),
-    );
-
-    const conflicts = await wooProductReplication.push!.handler(
-      [{
-        newDocumentState: { id: '1', name: 'Updated', _deleted: false } as any,
-        assumedMasterState: { id: '1', name: 'Server Version', _deleted: false } as any,
-      }],
-      context,
-    );
-
-    expect(conflicts).toHaveLength(1);
-    expect(conflicts[0].name).toBe('Server Version');
-  });
-
-  it('returns conflicts on network failure', async () => {
-    vi.spyOn(globalThis, 'fetch').mockRejectedValueOnce(new Error('Network error'));
-
-    const conflicts = await wooProductReplication.push!.handler(
-      [{
-        newDocumentState: { id: '1', name: 'Updated', _deleted: false } as any,
-        assumedMasterState: { id: '1', name: 'Server Version', _deleted: false } as any,
-      }],
-      context,
-    );
-
-    expect(conflicts).toHaveLength(1);
-  });
-
-  it('does not return conflict for creates that fail', async () => {
-    vi.spyOn(globalThis, 'fetch').mockResolvedValueOnce(
-      new Response('error', { status: 500 }),
-    );
-
-    const conflicts = await wooProductReplication.push!.handler(
-      [{
-        newDocumentState: { id: '1', name: 'New Product', _deleted: false } as any,
-        // No assumedMasterState = create, so no conflict to report
-      }],
-      context,
-    );
-
-    // Creates without assumedMasterState don't produce conflicts
-    expect(conflicts).toHaveLength(0);
-  });
-});