@tallyui/connector-vendure 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,69 @@
+import { ProductTraits, CollectionSync, ReplicationAdapter, TallyConnector } from '@tallyui/core';
+import { 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)
+ */
+declare const vendureProductSchema: RxJsonSchema<any>;
+
+/**
+ * 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
+ */
+declare const vendureProductTraits: ProductTraits;
+
+/**
+ * Vendure product sync implementation.
+ *
+ * Uses the Admin GraphQL API. Vendure uses offset-based pagination
+ * with `take` and `skip` options.
+ */
+declare const vendureProductSync: CollectionSync;
+
+type VendureProductCheckpoint = {
+    skip: number;
+    updatedAt: string;
+};
+/**
+ * Replication adapter for Vendure products.
+ *
+ * Implements pull (GraphQL query with offset pagination and updatedAt
+ * filtering) and push (GraphQL updateProduct mutation). Designed for
+ * use with RxDB's replicateRxCollection.
+ */
+declare const vendureProductReplication: ReplicationAdapter<any, VendureProductCheckpoint>;
+
+/**
+ * Vendure connector for Tally UI.
+ *
+ * Connects to Vendure backends via the Admin GraphQL API.
+ * Products are stored in RxDB using a schema that mirrors the Vendure API shape.
+ *
+ * ```ts
+ * import { vendureConnector } from '@tallyui/connector-vendure';
+ * import { ConnectorProvider } from '@tallyui/core';
+ *
+ * <ConnectorProvider connector={vendureConnector}>
+ *   <App />
+ * </ConnectorProvider>
+ * ```
+ */
+declare const vendureConnector: TallyConnector;
+
+export { vendureConnector, vendureProductReplication, vendureProductSchema, vendureProductSync, vendureProductTraits };

package/dist/index.js

@@ -0,0 +1,423 @@
+// src/schemas/products.ts
+var vendureProductSchema = {
+  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"]
+};
+
+// src/traits/product.ts
+var vendureProductTraits = {
+  getId: (doc) => String(doc.id),
+  getName: (doc) => doc.name ?? "",
+  getSku: (doc) => doc.variants?.[0]?.sku || void 0,
+  getPrice: (doc) => {
+    const amount = doc.variants?.[0]?.priceWithTax;
+    if (amount == null) return void 0;
+    return (amount / 100).toFixed(2);
+  },
+  getRegularPrice: (doc) => {
+    const amount = doc.variants?.[0]?.priceWithTax;
+    if (amount == null) return void 0;
+    return (amount / 100).toFixed(2);
+  },
+  getSalePrice: () => {
+    return void 0;
+  },
+  isOnSale: () => {
+    return false;
+  },
+  getImageUrl: (doc) => doc.featuredAsset?.preview || doc.assets?.[0]?.preview || void 0,
+  getImageUrls: (doc) => (doc.assets ?? []).map((a) => a.preview).filter(Boolean),
+  getDescription: (doc) => doc.description || void 0,
+  getStockStatus: (doc) => {
+    const variant = doc.variants?.[0];
+    if (!variant) return "unknown";
+    const level = variant.stockLevel;
+    if (level === "IN_STOCK" || level === "LOW_STOCK") return "instock";
+    if (level === "OUT_OF_STOCK") return "outofstock";
+    if (variant.stockOnHand != null) {
+      return variant.stockOnHand > 0 ? "instock" : "outofstock";
+    }
+    return "unknown";
+  },
+  getStockQuantity: (doc) => {
+    return doc.variants?.[0]?.stockOnHand ?? null;
+  },
+  hasVariants: (doc) => (doc.variants?.length ?? 0) > 1,
+  getType: (doc) => {
+    if ((doc.variants?.length ?? 0) > 1) return "variable";
+    return "simple";
+  },
+  getBarcode: (doc) => {
+    return doc.variants?.[0]?.customFields?.barcode || void 0;
+  },
+  getCategoryNames: (doc) => (doc.collections ?? []).map((c) => c.name).filter(Boolean)
+};
+
+// src/sync/products.ts
+var PRODUCT_LIST_QUERY = `
+  query GetProducts($options: ProductListOptions) {
+    products(options: $options) {
+      items {
+        id
+        updatedAt
+      }
+      totalItems
+    }
+  }
+`;
+var 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
+      }
+    }
+  }
+`;
+var vendureProductSync = {
+  fetchAllIds: async (context) => {
+    const entries = [];
+    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, context) => {
+    const products = [];
+    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, context) => {
+    const products = [];
+    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;
+      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;
+  }
+};
+async function gql(context, query, variables) {
+  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();
+}
+
+// src/replication/products.ts
+var PRODUCT_LIST_QUERY2 = `
+  query GetProducts($options: ProductListOptions) {
+    products(options: $options) {
+      items {
+        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
+        }
+      }
+      totalItems
+    }
+  }
+`;
+var UPDATE_PRODUCT_MUTATION = `
+  mutation UpdateProduct($input: UpdateProductInput!) {
+    updateProduct(input: $input) {
+      id
+      updatedAt
+    }
+  }
+`;
+async function gql2(context, query, variables) {
+  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();
+}
+var vendureProductReplication = {
+  pull: {
+    async handler(lastCheckpoint, batchSize, context) {
+      const options = {
+        take: batchSize,
+        skip: lastCheckpoint?.skip ?? 0
+      };
+      if (lastCheckpoint?.updatedAt) {
+        options.filter = {
+          updatedAt: { after: lastCheckpoint.updatedAt }
+        };
+      }
+      const res = await gql2(context, PRODUCT_LIST_QUERY2, { options });
+      if (res.errors?.length) {
+        throw new Error(`Vendure GraphQL error: ${res.errors[0].message}`);
+      }
+      const data = res.data?.products;
+      const products = data?.items ?? [];
+      const documents = products.map((p) => ({ ...p, _deleted: false }));
+      const nextSkip = products.length < batchSize ? 0 : (lastCheckpoint?.skip ?? 0) + products.length;
+      const checkpoint = products.length > 0 ? {
+        skip: nextSkip,
+        updatedAt: products[products.length - 1].updatedAt
+      } : lastCheckpoint ?? { skip: 0, updatedAt: "" };
+      return { documents, checkpoint };
+    }
+  },
+  push: {
+    async handler(changeRows, context) {
+      const conflicts = [];
+      for (const row of changeRows) {
+        const doc = row.newDocumentState;
+        try {
+          const res = await gql2(context, UPDATE_PRODUCT_MUTATION, {
+            input: doc
+          });
+          if (res.errors?.length) {
+            if (row.assumedMasterState) {
+              conflicts.push({ ...row.assumedMasterState, _deleted: false });
+            }
+          }
+        } catch {
+          if (row.assumedMasterState) {
+            conflicts.push({ ...row.assumedMasterState, _deleted: false });
+          }
+        }
+      }
+      return conflicts;
+    }
+  }
+};
+
+// src/index.ts
+var vendureConnector = {
+  id: "vendure",
+  name: "Vendure",
+  description: "Connect to Vendure backends via the Admin GraphQL API",
+  icon: void 0,
+  auth: {
+    type: "Vendure Admin API",
+    fields: [
+      {
+        key: "url",
+        label: "Backend URL",
+        type: "url",
+        placeholder: "https://my-vendure-server.com",
+        required: true
+      },
+      {
+        key: "auth_token",
+        label: "Auth Token",
+        type: "password",
+        placeholder: "vendure-auth-token from login",
+        required: true
+      }
+    ],
+    getHeaders: (credentials) => ({
+      Authorization: `Bearer ${credentials.auth_token}`
+    })
+  },
+  schemas: {
+    products: vendureProductSchema
+  },
+  traits: {
+    product: vendureProductTraits
+  },
+  sync: {
+    products: vendureProductSync
+  },
+  replication: {
+    products: vendureProductReplication
+  }
+};
+export {
+  vendureConnector,
+  vendureProductReplication,
+  vendureProductSchema,
+  vendureProductSync,
+  vendureProductTraits
+};

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@tallyui/connector-vendure",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "Vendure connector for Tally UI",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "source": "./src/index.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "source": "./src/index.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "license": "MIT",
+  "peerDependencies": {
+    "@tallyui/core": "0.2.0"
+  },
+  "devDependencies": {
+    "rxdb": "16.21.1"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "test": "echo \"no tests yet\""
+  }
+}