@fayz-ai/shop 0.7.0 → 0.8.2

package/README.md

@@ -5,6 +5,8 @@
 [![npm](https://img.shields.io/npm/v/@fayz-ai/shop.svg)](https://www.npmjs.com/package/@fayz-ai/shop)
 [![license](https://img.shields.io/npm/l/@fayz-ai/shop.svg)](https://github.com/FayaLabs/fayz-sdk/blob/main/LICENSE)
 
+**Status:** beta — published to npm and used across Fayz dogfood apps. Pre-1.0: minor APIs may change before 1.0.
+
 `@fayz-ai/shop` is the headless ecommerce engine: a `ShopProvider` contract plus the domain types for products, carts, orders, customers, discounts, and shipping. It owns *what commerce means* so the storefront (`@fayz-ai/storefront`) and admin surfaces only have to render it.
 
 It's provider-first by design. Ship a demo on `createMockShopProvider`, then drop in `createSupabaseShopProvider` (or your own `ShopProvider`) for real data — the UI doesn't change. Tenancy is resolved through a pluggable resolver, so the same engine serves one store or a marketplace of thousands.

package/dist/index.cjs

@@ -390,6 +390,11 @@ var MockShopProvider = class {
       customerEmail: input.customerEmail ?? null,
       discountCode: input.discountCode ?? null,
       notes: input.notes ?? null,
+      shippingAddress: null,
+      // CreateOrderInput has no payment method — that is a PlaceOrderInput
+      // concern; the mock records none rather than inventing one.
+      paymentMethodKind: null,
+      paidAt: null,
       items: input.items.map((i) => ({ id: uid(), orderId, productId: i.productId ?? null, name: i.name, sku: i.sku ?? null, quantity: i.quantity, unitPrice: i.unitPrice, total: Math.round(i.quantity * i.unitPrice * 100) / 100, imageUrl: i.imageUrl ?? null })),
       createdAt: now(),
       updatedAt: now()
@@ -651,6 +656,21 @@ function getShopTenantId() {
   }
 }
 
+// src/tables.ts
+var T = {
+  products: "plg_shop_products",
+  productImages: "plg_shop_product_images",
+  categories: "plg_shop_categories",
+  orders: "plg_shop_orders",
+  orderItems: "plg_shop_order_items",
+  customers: "plg_shop_customers",
+  discounts: "plg_shop_discounts",
+  // Core, not plg_shop_*: a delivery zone is a fact about the business, and
+  // fulfilment and financial read it too. Same reasoning as addresses and
+  // orders — see migration 0021.
+  shippingZones: "shipping_zones"
+};
+
 // src/supabase-provider.ts
 function getDb() {
   const supabase = core.getSupabaseClientOptional();
@@ -665,6 +685,40 @@ function asUuid(value) {
   if (!value) return null;
   return /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(value) ? value : null;
 }
+function toPostalDigits(value) {
+  const digits = String(value ?? "").replace(/\D/g, "");
+  return digits ? digits.padStart(8, "0").slice(0, 8) : void 0;
+}
+function rowToShippingZone(row) {
+  return {
+    id: row.id,
+    tenantId: row.tenant_id,
+    name: row.name,
+    carrier: row.carrier ?? null,
+    postalFrom: String(row.postal_from ?? "").trim(),
+    postalTo: String(row.postal_to ?? "").trim(),
+    rate: Number(row.rate ?? 0),
+    freeAbove: row.free_above == null ? null : Number(row.free_above),
+    etaMinDays: row.eta_min_days ?? null,
+    etaMaxDays: row.eta_max_days ?? null,
+    active: row.active ?? true,
+    sortOrder: row.sort_order ?? 0
+  };
+}
+function shippingZonePayload(input) {
+  const payload = {};
+  if (input.name !== void 0) payload.name = input.name;
+  if (input.carrier !== void 0) payload.carrier = input.carrier || null;
+  if (input.postalFrom !== void 0) payload.postal_from = toPostalDigits(input.postalFrom);
+  if (input.postalTo !== void 0) payload.postal_to = toPostalDigits(input.postalTo);
+  if (input.rate !== void 0) payload.rate = input.rate;
+  if (input.freeAbove !== void 0) payload.free_above = input.freeAbove ?? null;
+  if (input.etaMinDays !== void 0) payload.eta_min_days = input.etaMinDays ?? null;
+  if (input.etaMaxDays !== void 0) payload.eta_max_days = input.etaMaxDays ?? null;
+  if (input.active !== void 0) payload.active = input.active;
+  if (input.sortOrder !== void 0) payload.sort_order = input.sortOrder;
+  return payload;
+}
 function rowToProduct(row) {
   return {
     id: row.id,
@@ -713,6 +767,19 @@ function rowToCategory(row) {
     createdAt: row.created_at
   };
 }
+function rowToOrderItem(row) {
+  return {
+    id: row.id,
+    orderId: row.order_id,
+    productId: row.product_id ?? null,
+    name: row.name,
+    sku: row.sku ?? null,
+    quantity: row.quantity ?? 0,
+    unitPrice: row.unit_price ?? 0,
+    total: row.total ?? 0,
+    imageUrl: row.image_url ?? null
+  };
+}
 function rowToOrder(row) {
   return {
     id: row.id,
@@ -732,7 +799,10 @@ function rowToOrder(row) {
     customerEmail: row.customer_email,
     discountCode: row.discount_code,
     notes: row.notes,
-    items: Array.isArray(row.items) ? row.items : [],
+    shippingAddress: row.shipping_address ?? null,
+    paymentMethodKind: row.payment_method_kind ?? null,
+    paidAt: row.paid_at ?? null,
+    items: Array.isArray(row.items) ? row.items.map(rowToOrderItem) : [],
     createdAt: row.created_at,
     updatedAt: row.updated_at
   };
@@ -778,7 +848,7 @@ var SupabaseShopProvider = class {
   async listProducts(options) {
     const db = getDb();
     const tenantId = getTenantId();
-    let q = db.from("shop_products").select("*, images:shop_product_images(*)");
+    let q = db.from(T.products).select(`*, images:${T.productImages}(*)`);
     if (tenantId) q = q.eq("tenant_id", tenantId);
     if (options?.status) q = q.eq("status", options.status);
     if (options?.categoryId) q = q.eq("category_id", options.categoryId);
@@ -793,14 +863,14 @@ var SupabaseShopProvider = class {
   }
   async getProduct(id) {
     const db = getDb();
-    const { data, error } = await db.from("shop_products").select("*, images:shop_product_images(*)").eq("id", id).maybeSingle();
+    const { data, error } = await db.from(T.products).select(`*, images:${T.productImages}(*)`).eq("id", id).maybeSingle();
     if (error) throw error;
     return data ? rowToProduct(data) : null;
   }
   async createProduct(input) {
     const db = getDb();
     const tenantId = getTenantId();
-    const { data, error } = await db.from("shop_products").insert({
+    const { data, error } = await db.from(T.products).insert({
       tenant_id: tenantId,
       name: input.name,
       slug: input.slug ?? slugify(input.name),
@@ -817,7 +887,7 @@ var SupabaseShopProvider = class {
       is_physical: input.isPhysical ?? true,
       weight: input.weight ?? null,
       weight_unit: input.weightUnit ?? "kg"
-    }).select("*, images:shop_product_images(*)").single();
+    }).select(`*, images:${T.productImages}(*)`).single();
     if (error) throw error;
     return rowToProduct(data);
   }
@@ -839,12 +909,12 @@ var SupabaseShopProvider = class {
     if (input.categoryId !== void 0) updates.category_id = input.categoryId;
     if (input.isPhysical !== void 0) updates.is_physical = input.isPhysical;
     if (input.weight !== void 0) updates.weight = input.weight;
-    const { data, error } = await db.from("shop_products").update(updates).eq("id", id).select("*, images:shop_product_images(*)").single();
+    const { data, error } = await db.from(T.products).update(updates).eq("id", id).select(`*, images:${T.productImages}(*)`).single();
     if (error) throw error;
     return rowToProduct(data);
   }
   async deleteProduct(id) {
-    const { error } = await getDb().from("shop_products").delete().eq("id", id);
+    const { error } = await getDb().from(T.products).delete().eq("id", id);
     if (error) throw error;
   }
   async uploadProductImage(productId, file) {
@@ -854,12 +924,37 @@ var SupabaseShopProvider = class {
     const { error: uploadErr } = await db.storage.from("shop-images").upload(path, file);
     if (uploadErr) throw uploadErr;
     const { data: { publicUrl } } = db.storage.from("shop-images").getPublicUrl(path);
-    const { data, error } = await db.from("shop_product_images").insert({ product_id: productId, tenant_id: tenantId, url: publicUrl, sort_order: 0, is_primary: false }).select().single();
+    const { data: existing } = await db.from(T.productImages).select("id,sort_order").eq("product_id", productId).order("sort_order", { ascending: false }).limit(1);
+    const first = !existing || existing.length === 0;
+    const nextOrder = first ? 0 : (existing[0].sort_order ?? 0) + 1;
+    const { data, error } = await db.from(T.productImages).insert({
+      product_id: productId,
+      tenant_id: tenantId,
+      url: publicUrl,
+      sort_order: nextOrder,
+      is_primary: first
+    }).select().single();
+    if (error) throw error;
+    return rowToImage(data);
+  }
+  async updateProductImage(imageId, input) {
+    const db = getDb();
+    const updates = {};
+    if (input.sortOrder !== void 0) updates.sort_order = input.sortOrder;
+    if (input.altText !== void 0) updates.alt_text = input.altText;
+    if (input.isPrimary !== void 0) updates.is_primary = input.isPrimary;
+    if (input.isPrimary) {
+      const { data: target } = await db.from(T.productImages).select("product_id").eq("id", imageId).single();
+      if (target?.product_id) {
+        await db.from(T.productImages).update({ is_primary: false }).eq("product_id", target.product_id).neq("id", imageId);
+      }
+    }
+    const { data, error } = await db.from(T.productImages).update(updates).eq("id", imageId).select().single();
     if (error) throw error;
     return rowToImage(data);
   }
   async deleteProductImage(imageId) {
-    const { error } = await getDb().from("shop_product_images").delete().eq("id", imageId);
+    const { error } = await getDb().from(T.productImages).delete().eq("id", imageId);
     if (error) throw error;
   }
   // ---------------------------------------------------------------------------
@@ -868,7 +963,7 @@ var SupabaseShopProvider = class {
   async listCategories() {
     const db = getDb();
     const tenantId = getTenantId();
-    let q = db.from("shop_categories").select("*").order("sort_order", { ascending: true });
+    let q = db.from(T.categories).select("*").order("sort_order", { ascending: true });
     if (tenantId) q = q.eq("tenant_id", tenantId);
     const { data, error } = await q;
     if (error) throw error;
@@ -876,7 +971,7 @@ var SupabaseShopProvider = class {
   }
   async createCategory(input) {
     const db = getDb();
-    const { data, error } = await db.from("shop_categories").insert({ tenant_id: getTenantId(), name: input.name, slug: input.slug ?? slugify(input.name), description: input.description ?? null, parent_id: input.parentId ?? null, sort_order: input.sortOrder ?? 0 }).select().single();
+    const { data, error } = await db.from(T.categories).insert({ tenant_id: getTenantId(), name: input.name, slug: input.slug ?? slugify(input.name), description: input.description ?? null, parent_id: input.parentId ?? null, sort_order: input.sortOrder ?? 0 }).select().single();
     if (error) throw error;
     return rowToCategory(data);
   }
@@ -888,12 +983,12 @@ var SupabaseShopProvider = class {
     if (input.description !== void 0) updates.description = input.description;
     if (input.parentId !== void 0) updates.parent_id = input.parentId;
     if (input.sortOrder !== void 0) updates.sort_order = input.sortOrder;
-    const { data, error } = await db.from("shop_categories").update(updates).eq("id", id).select().single();
+    const { data, error } = await db.from(T.categories).update(updates).eq("id", id).select().single();
     if (error) throw error;
     return rowToCategory(data);
   }
   async deleteCategory(id) {
-    const { error } = await getDb().from("shop_categories").delete().eq("id", id);
+    const { error } = await getDb().from(T.categories).delete().eq("id", id);
     if (error) throw error;
   }
   // ---------------------------------------------------------------------------
@@ -902,7 +997,7 @@ var SupabaseShopProvider = class {
   async listOrders(options) {
     const db = getDb();
     const tenantId = getTenantId();
-    let q = db.from("shop_orders").select("*, items:shop_order_items(*)");
+    let q = db.from(T.orders).select(`*, items:${T.orderItems}(*)`);
     if (tenantId) q = q.eq("tenant_id", tenantId);
     if (options?.status) q = q.eq("status", options.status);
     if (options?.financialStatus) q = q.eq("financial_status", options.financialStatus);
@@ -917,7 +1012,7 @@ var SupabaseShopProvider = class {
     return (data ?? []).map(rowToOrder);
   }
   async getOrder(id) {
-    const { data, error } = await getDb().from("shop_orders").select("*, items:shop_order_items(*)").eq("id", id).maybeSingle();
+    const { data, error } = await getDb().from(T.orders).select(`*, items:${T.orderItems}(*)`).eq("id", id).maybeSingle();
     if (error) throw error;
     return data ? rowToOrder(data) : null;
   }
@@ -928,10 +1023,10 @@ var SupabaseShopProvider = class {
     const discountTotal = input.discountTotal ?? 0;
     const shippingTotal = input.shippingTotal ?? 0;
     const total = Math.round((subtotal - discountTotal + shippingTotal) * 100) / 100;
-    const { data: order, error: orderErr } = await db.from("shop_orders").insert({ tenant_id: tenantId, customer_id: input.customerId ?? null, customer_name: input.customerName ?? null, customer_email: input.customerEmail ?? null, currency: input.currency ?? "BRL", notes: input.notes ?? null, subtotal, discount_total: discountTotal, shipping_total: shippingTotal, discount_code: input.discountCode ?? null, total, status: "open", financial_status: "pending", fulfillment_status: "unfulfilled" }).select().single();
+    const { data: order, error: orderErr } = await db.from(T.orders).insert({ tenant_id: tenantId, customer_id: input.customerId ?? null, customer_name: input.customerName ?? null, customer_email: input.customerEmail ?? null, currency: input.currency ?? "BRL", notes: input.notes ?? null, subtotal, discount_total: discountTotal, shipping_total: shippingTotal, discount_code: input.discountCode ?? null, total, status: "open", financial_status: "pending", fulfillment_status: "unfulfilled" }).select().single();
     if (orderErr) throw orderErr;
     const items = input.items.map((i) => ({ order_id: order.id, product_id: asUuid(i.productId), name: i.name, sku: i.sku ?? null, quantity: i.quantity, unit_price: i.unitPrice, total: i.quantity * i.unitPrice, image_url: i.imageUrl ?? null }));
-    await db.from("shop_order_items").insert(items);
+    await db.from(T.orderItems).insert(items);
     return this.getOrder(order.id);
   }
   async updateOrder(id, input) {
@@ -940,7 +1035,53 @@ var SupabaseShopProvider = class {
     if (input.financialStatus !== void 0) updates.financial_status = input.financialStatus;
     if (input.fulfillmentStatus !== void 0) updates.fulfillment_status = input.fulfillmentStatus;
     if (input.notes !== void 0) updates.notes = input.notes;
-    const { error } = await getDb().from("shop_orders").update(updates).eq("id", id);
+    const { error } = await getDb().from(T.orders).update(updates).eq("id", id);
+    if (error) throw error;
+    return this.getOrder(id);
+  }
+  // -------------------------------------------------------------------------
+  // Delivery zones
+  //
+  // Postal codes are stored as 8 bare digits so the range test in
+  // shop_quote_shipping is a plain BETWEEN. Accepting '22.041-001' from the
+  // form and normalising here means the merchant never has to think about it.
+  // -------------------------------------------------------------------------
+  async listShippingZones() {
+    const tenantId = getTenantId();
+    const { data, error } = await getDb().from(T.shippingZones).select("*").eq("tenant_id", tenantId).order("sort_order", { ascending: true }).order("postal_from", { ascending: true });
+    if (error) throw error;
+    return (data ?? []).map(rowToShippingZone);
+  }
+  async createShippingZone(input) {
+    const tenantId = getTenantId();
+    if (!tenantId) throw new Error("@fayz-ai/shop: createShippingZone requires a tenant id.");
+    const { data, error } = await getDb().from(T.shippingZones).insert({ tenant_id: tenantId, ...shippingZonePayload(input) }).select().single();
+    if (error) throw error;
+    return rowToShippingZone(data);
+  }
+  async updateShippingZone(id, input) {
+    const { data, error } = await getDb().from(T.shippingZones).update(shippingZonePayload(input)).eq("id", id).select().single();
+    if (error) throw error;
+    return rowToShippingZone(data);
+  }
+  async deleteShippingZone(id) {
+    const { error } = await getDb().from(T.shippingZones).delete().eq("id", id);
+    if (error) throw error;
+  }
+  /**
+   * Settle a pending order: the merchant confirming that the money arrived.
+   *
+   * Goes through the RPC rather than an UPDATE so the payment ledger row in
+   * public.transactions closes in the same transaction as the order — set
+   * financial_status by hand and the order says paid while the ledger still
+   * says pending. Since 0019 the RPC also enforces who may call it: a member of
+   * the owning tenant, or a PSP webhook with the service role.
+   */
+  async confirmPayment(id, reference) {
+    const { error } = await getDb().rpc("shop_confirm_payment", {
+      p_order_id: id,
+      p_reference: reference ?? null
+    });
     if (error) throw error;
     return this.getOrder(id);
   }
@@ -959,6 +1100,22 @@ var SupabaseShopProvider = class {
       p_currency: input.currency ?? "BRL",
       p_discount_code: input.discountCode ?? null,
       p_shipping_total: input.shippingTotal ?? 0,
+      // snake_case keys on purpose: the RPC freezes this jsonb onto the
+      // order and public.addresses uses these exact column names.
+      p_shipping_address: input.shippingAddress ? {
+        postal_code: input.shippingAddress.postalCode,
+        street: input.shippingAddress.street,
+        number: input.shippingAddress.number ?? null,
+        complement: input.shippingAddress.complement ?? null,
+        district: input.shippingAddress.district ?? null,
+        city: input.shippingAddress.city,
+        state: input.shippingAddress.state,
+        country: input.shippingAddress.country ?? "BR",
+        recipient: input.shippingAddress.recipient ?? null,
+        phone: input.shippingAddress.phone ?? null,
+        label: input.shippingAddress.label ?? null
+      } : null,
+      p_payment_method: input.paymentMethod ?? null,
       p_notes: input.notes ?? null
     });
     if (error) throw error;
@@ -973,7 +1130,7 @@ var SupabaseShopProvider = class {
   async listCustomers(options) {
     const db = getDb();
     const tenantId = getTenantId();
-    let q = db.from("shop_customers").select("*").order("first_name", { ascending: true });
+    let q = db.from(T.customers).select("*").order("first_name", { ascending: true });
     if (tenantId) q = q.eq("tenant_id", tenantId);
     if (options?.search) q = q.or(`first_name.ilike.%${options.search}%,last_name.ilike.%${options.search}%,email.ilike.%${options.search}%`);
     if (options?.limit) q = q.limit(options.limit);
@@ -982,12 +1139,12 @@ var SupabaseShopProvider = class {
     return (data ?? []).map(rowToCustomer);
   }
   async getCustomer(id) {
-    const { data, error } = await getDb().from("shop_customers").select("*").eq("id", id).maybeSingle();
+    const { data, error } = await getDb().from(T.customers).select("*").eq("id", id).maybeSingle();
     if (error) throw error;
     return data ? rowToCustomer(data) : null;
   }
   async createCustomer(input) {
-    const { data, error } = await getDb().from("shop_customers").insert({ tenant_id: getTenantId(), first_name: input.firstName, last_name: input.lastName ?? "", email: input.email ?? null, phone: input.phone ?? null, notes: input.notes ?? null }).select().single();
+    const { data, error } = await getDb().from(T.customers).insert({ tenant_id: getTenantId(), first_name: input.firstName, last_name: input.lastName ?? "", email: input.email ?? null, phone: input.phone ?? null, notes: input.notes ?? null }).select().single();
     if (error) throw error;
     return rowToCustomer(data);
   }
@@ -998,12 +1155,12 @@ var SupabaseShopProvider = class {
     if (input.email !== void 0) updates.email = input.email;
     if (input.phone !== void 0) updates.phone = input.phone;
     if (input.notes !== void 0) updates.notes = input.notes;
-    const { data, error } = await getDb().from("shop_customers").update(updates).eq("id", id).select().single();
+    const { data, error } = await getDb().from(T.customers).update(updates).eq("id", id).select().single();
     if (error) throw error;
     return rowToCustomer(data);
   }
   async deleteCustomer(id) {
-    const { error } = await getDb().from("shop_customers").delete().eq("id", id);
+    const { error } = await getDb().from(T.customers).delete().eq("id", id);
     if (error) throw error;
   }
   // Find-or-create + link to auth.uid server-side (SECURITY DEFINER RPC), so the
@@ -1028,7 +1185,7 @@ var SupabaseShopProvider = class {
   async listDiscounts(options) {
     const db = getDb();
     const tenantId = getTenantId();
-    let q = db.from("shop_discounts").select("*").order("created_at", { ascending: false });
+    let q = db.from(T.discounts).select("*").order("created_at", { ascending: false });
     if (tenantId) q = q.eq("tenant_id", tenantId);
     if (options?.status) q = q.eq("status", options.status);
     if (options?.type) q = q.eq("type", options.type);
@@ -1039,12 +1196,12 @@ var SupabaseShopProvider = class {
     return (data ?? []).map(rowToDiscount);
   }
   async getDiscount(id) {
-    const { data, error } = await getDb().from("shop_discounts").select("*").eq("id", id).maybeSingle();
+    const { data, error } = await getDb().from(T.discounts).select("*").eq("id", id).maybeSingle();
     if (error) throw error;
     return data ? rowToDiscount(data) : null;
   }
   async createDiscount(input) {
-    const { data, error } = await getDb().from("shop_discounts").insert({ tenant_id: getTenantId(), title: input.title, code: input.code ?? null, type: input.type, method: input.method ?? "code", value: input.value, usage_limit: input.usageLimit ?? null, once_per_customer: input.oncePerCustomer ?? false, starts_at: input.startsAt ?? (/* @__PURE__ */ new Date()).toISOString(), ends_at: input.endsAt ?? null, status: input.status ?? "active", times_used: 0 }).select().single();
+    const { data, error } = await getDb().from(T.discounts).insert({ tenant_id: getTenantId(), title: input.title, code: input.code ?? null, type: input.type, method: input.method ?? "code", value: input.value, usage_limit: input.usageLimit ?? null, once_per_customer: input.oncePerCustomer ?? false, starts_at: input.startsAt ?? (/* @__PURE__ */ new Date()).toISOString(), ends_at: input.endsAt ?? null, status: input.status ?? "active", times_used: 0 }).select().single();
     if (error) throw error;
     return rowToDiscount(data);
   }
@@ -1057,12 +1214,12 @@ var SupabaseShopProvider = class {
     if (input.usageLimit !== void 0) updates.usage_limit = input.usageLimit;
     if (input.status !== void 0) updates.status = input.status;
     if (input.endsAt !== void 0) updates.ends_at = input.endsAt;
-    const { data, error } = await getDb().from("shop_discounts").update(updates).eq("id", id).select().single();
+    const { data, error } = await getDb().from(T.discounts).update(updates).eq("id", id).select().single();
     if (error) throw error;
     return rowToDiscount(data);
   }
   async deleteDiscount(id) {
-    const { error } = await getDb().from("shop_discounts").delete().eq("id", id);
+    const { error } = await getDb().from(T.discounts).delete().eq("id", id);
     if (error) throw error;
   }
 };