@tallyui/connector-vendure 1.0.0

package/src/schemas/products.ts

@@ -0,0 +1,110 @@
+import type { RxJsonSchema } from 'rxdb';
+
+/**
+ * RxDB schema for Vendure products.
+ *
+ * Mirrors the Vendure GraphQL Admin API product shape. Key differences:
+ * - Uses `name` (like WooCommerce, unlike Medusa's `title`)
+ * - Prices are integers in cents on `variants[].priceWithTax`
+ * - Images use `assets[].preview` and `featuredAsset.preview`
+ * - Categories are `collections[].name`
+ * - Stock level is a string (`IN_STOCK`, `OUT_OF_STOCK`, `LOW_STOCK`)
+ * - No native barcode field (custom fields only)
+ */
+export const vendureProductSchema: RxJsonSchema<any> = {
+  version: 0,
+  primaryKey: 'id',
+  type: 'object',
+  properties: {
+    id: { type: 'string', maxLength: 100 },
+    name: { type: 'string' },
+    slug: { type: 'string', maxLength: 255 },
+    description: { type: 'string' },
+    enabled: { type: 'boolean' },
+    featuredAsset: {
+      type: ['object', 'null'],
+      properties: {
+        id: { type: 'string' },
+        preview: { type: 'string' },
+      },
+    },
+    assets: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          id: { type: 'string' },
+          preview: { type: 'string' },
+        },
+      },
+    },
+    collections: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          id: { type: 'string' },
+          name: { type: 'string' },
+          slug: { type: 'string' },
+        },
+      },
+    },
+    facetValues: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          id: { type: 'string' },
+          name: { type: 'string' },
+          code: { type: 'string' },
+          facet: {
+            type: 'object',
+            properties: {
+              id: { type: 'string' },
+              name: { type: 'string' },
+            },
+          },
+        },
+      },
+    },
+    variants: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          id: { type: 'string' },
+          name: { type: 'string' },
+          sku: { type: 'string' },
+          price: { type: 'number' },
+          priceWithTax: { type: 'number' },
+          currencyCode: { type: 'string' },
+          stockLevel: { type: 'string' },
+          stockOnHand: { type: 'number' },
+          trackInventory: { type: 'string' },
+          featuredAsset: {
+            type: ['object', 'null'],
+            properties: {
+              id: { type: 'string' },
+              preview: { type: 'string' },
+            },
+          },
+          options: {
+            type: 'array',
+            items: {
+              type: 'object',
+              properties: {
+                id: { type: 'string' },
+                name: { type: 'string' },
+                code: { type: 'string' },
+              },
+            },
+          },
+          customFields: { type: 'object' },
+        },
+      },
+    },
+    updatedAt: { type: 'string', maxLength: 50 },
+  },
+  required: ['id'],
+  indexes: ['slug', 'updatedAt'],
+};

package/src/sync/products.ts

@@ -0,0 +1,154 @@
+import type { CollectionSync, SyncContext } from '@tallyui/core';
+
+/**
+ * GraphQL query fragments used by the Vendure sync.
+ */
+const PRODUCT_LIST_QUERY = `
+  query GetProducts($options: ProductListOptions) {
+    products(options: $options) {
+      items {
+        id
+        updatedAt
+      }
+      totalItems
+    }
+  }
+`;
+
+const PRODUCT_DETAIL_QUERY = `
+  query GetProduct($id: ID!) {
+    product(id: $id) {
+      id
+      createdAt
+      updatedAt
+      name
+      slug
+      description
+      enabled
+      featuredAsset { id preview }
+      assets { id preview }
+      collections { id name slug }
+      facetValues { id name code facet { id name } }
+      variants {
+        id
+        name
+        sku
+        price
+        priceWithTax
+        currencyCode
+        stockLevel
+        stockOnHand
+        trackInventory
+        featuredAsset { id preview }
+        options { id name code }
+        customFields
+      }
+    }
+  }
+`;
+
+/**
+ * Vendure product sync implementation.
+ *
+ * Uses the Admin GraphQL API. Vendure uses offset-based pagination
+ * with `take` and `skip` options.
+ */
+export const vendureProductSync: CollectionSync = {
+  fetchAllIds: async (context: SyncContext) => {
+    const entries: { id: string; dateModified?: string }[] = [];
+    const take = 100;
+    let skip = 0;
+    let totalItems = Infinity;
+
+    while (skip < totalItems) {
+      const res = await gql(context, PRODUCT_LIST_QUERY, {
+        options: { take, skip },
+      });
+
+      const data = res.data?.products;
+      if (!data) break;
+
+      totalItems = data.totalItems;
+      for (const item of data.items ?? []) {
+        entries.push({
+          id: String(item.id),
+          dateModified: item.updatedAt,
+        });
+      }
+
+      skip += take;
+    }
+
+    return entries;
+  },
+
+  fetchByIds: async (ids: string[], context: SyncContext) => {
+    const products: any[] = [];
+    // Vendure doesn't support batch-by-IDs natively, so fetch individually
+    for (const id of ids) {
+      const res = await gql(context, PRODUCT_DETAIL_QUERY, { id });
+      if (res.data?.product) {
+        products.push(res.data.product);
+      }
+    }
+    return products;
+  },
+
+  fetchModifiedAfter: async (date: string, context: SyncContext) => {
+    const products: any[] = [];
+    const take = 100;
+    let skip = 0;
+    let totalItems = Infinity;
+
+    while (skip < totalItems) {
+      const res = await gql(context, PRODUCT_LIST_QUERY, {
+        options: {
+          take,
+          skip,
+          filter: {
+            updatedAt: { after: date },
+          },
+        },
+      });
+
+      const data = res.data?.products;
+      if (!data) break;
+
+      totalItems = data.totalItems;
+
+      // Fetch full details for each modified product
+      for (const item of data.items ?? []) {
+        const detail = await gql(context, PRODUCT_DETAIL_QUERY, { id: item.id });
+        if (detail.data?.product) {
+          products.push(detail.data.product);
+        }
+      }
+
+      skip += take;
+    }
+
+    return products;
+  },
+};
+
+/**
+ * Helper to execute a GraphQL query against the Vendure Admin API.
+ */
+async function gql(
+  context: SyncContext,
+  query: string,
+  variables?: Record<string, any>,
+): Promise<any> {
+  const res = await fetch(`${context.baseUrl}/admin-api`, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      ...context.headers,
+    },
+    body: JSON.stringify({ query, variables }),
+    signal: context.signal,
+  });
+
+  if (!res.ok) throw new Error(`Vendure API error: ${res.status}`);
+  return res.json();
+}

package/src/traits/product.ts

@@ -0,0 +1,91 @@
+import type { ProductTraits } from '@tallyui/core';
+
+/**
+ * Vendure product trait implementations.
+ *
+ * Key differences from other connectors:
+ * - Product name is `name` (same as WooCommerce, unlike Medusa's `title`)
+ * - Price is on `variants[].priceWithTax` (integer cents, like Medusa)
+ * - Images use `featuredAsset.preview` and `assets[].preview`
+ * - Stock status is a string from the Shop API: 'IN_STOCK', 'OUT_OF_STOCK', 'LOW_STOCK'
+ * - Categories are `collections[].name` (Vendure's equivalent of categories)
+ * - No native sale price — Vendure handles sales via promotions at checkout
+ * - No native barcode field — uses custom fields if configured
+ */
+export const vendureProductTraits: ProductTraits = {
+  getId: (doc) => String(doc.id),
+
+  getName: (doc) => doc.name ?? '',
+
+  getSku: (doc) => doc.variants?.[0]?.sku || undefined,
+
+  getPrice: (doc) => {
+    // Vendure stores prices as integers in smallest currency unit (cents)
+    const amount = doc.variants?.[0]?.priceWithTax;
+    if (amount == null) return undefined;
+    return (amount / 100).toFixed(2);
+  },
+
+  getRegularPrice: (doc) => {
+    // Vendure has no separate regular/sale price — promotions happen at checkout
+    const amount = doc.variants?.[0]?.priceWithTax;
+    if (amount == null) return undefined;
+    return (amount / 100).toFixed(2);
+  },
+
+  getSalePrice: () => {
+    // Vendure handles sales via promotions at the order level
+    return undefined;
+  },
+
+  isOnSale: () => {
+    // No product-level sale flag in Vendure
+    return false;
+  },
+
+  getImageUrl: (doc) =>
+    doc.featuredAsset?.preview || doc.assets?.[0]?.preview || undefined,
+
+  getImageUrls: (doc) =>
+    (doc.assets ?? []).map((a: any) => a.preview).filter(Boolean),
+
+  getDescription: (doc) => doc.description || undefined,
+
+  getStockStatus: (doc) => {
+    const variant = doc.variants?.[0];
+    if (!variant) return 'unknown';
+
+    // Vendure Shop API returns stockLevel as a string
+    const level = variant.stockLevel;
+    if (level === 'IN_STOCK' || level === 'LOW_STOCK') return 'instock';
+    if (level === 'OUT_OF_STOCK') return 'outofstock';
+
+    // Fall back to Admin API stockOnHand if available
+    if (variant.stockOnHand != null) {
+      return variant.stockOnHand > 0 ? 'instock' : 'outofstock';
+    }
+
+    return 'unknown';
+  },
+
+  getStockQuantity: (doc) => {
+    // stockOnHand is available from Admin API; Shop API only has the string stockLevel
+    return doc.variants?.[0]?.stockOnHand ?? null;
+  },
+
+  hasVariants: (doc) => (doc.variants?.length ?? 0) > 1,
+
+  getType: (doc) => {
+    // Vendure has no native product type field
+    if ((doc.variants?.length ?? 0) > 1) return 'variable';
+    return 'simple';
+  },
+
+  getBarcode: (doc) => {
+    // Vendure has no native barcode — check custom fields
+    return doc.variants?.[0]?.customFields?.barcode || undefined;
+  },
+
+  getCategoryNames: (doc) =>
+    (doc.collections ?? []).map((c: any) => c.name).filter(Boolean),
+};