hookwright 1.8.0 → 1.10.0

package/dist/cli.js

@@ -24,7 +24,7 @@ var init_package = __esm({
   "package.json"() {
     package_default = {
       name: "hookwright",
-      version: "1.8.0",
+      version: "1.10.0",
       description: "Build real, signed e-commerce webhooks from a live Shopify catalogue \u2014 interactive terminal UI, no backend",
       keywords: [
         "webhook",
@@ -1142,7 +1142,6 @@ var EVENTS2 = [
   { eventName: "collection_page_viewed", type: "shopflo_collection_page_viewed", label: "Collection Page View", selection: "collection", subject: "one collection", envelope: "data" },
   { eventName: "product_page_viewed", type: "shopflo_product_page_viewed", label: "Product Page View", selection: "product", subject: "one product", envelope: "data" },
   { eventName: "added_to_cart_ui", type: "shopflo_added_to_cart", label: "Added To Cart", selection: "cart", subject: "cart contents", envelope: "root" },
-  { eventName: "checkout_clicked", type: "shopflo_checkout_clicked", label: "Checkout Clicked", selection: "cart", subject: "cart contents", envelope: "root" },
   { eventName: "checkout_abandoned", type: "shopflo_checkout_abandoned", label: "Abandoned Checkout", selection: "cart", subject: "cart contents", envelope: "root" },
   { eventName: "order_completed", type: "shopflo_order_completed", label: "Order Completed", selection: "cart", subject: "ordered items", envelope: "root" }
 ];
@@ -1156,7 +1155,13 @@ function selectionFor2(eventName) {
 }
 var COMMON_FIELDS2 = [
   { source: "event_name / eventName", target: "\xABgate\xBB", required: true, note: "the schema matches EITHER spelling" },
-  { source: "customer.phone / user_data.phone", target: "phone", required: true, note: "missing phone is rejected on every event" }
+  { source: "customer.phone / user_data.phone", target: "customer.phone", required: true, note: "missing phone is rejected on every event" },
+  { source: "customer.first_name / user_data.firstName", target: "customer.firstName" },
+  { source: "customer.last_name / user_data.lastName", target: "customer.lastName" },
+  { source: "\u2014 (first + last)", target: "customer.fullName", note: "built by the consumer, not sent" },
+  { source: "customer.email / user_data.email", target: "customer.email" },
+  { source: "channel", target: "channel" },
+  { source: "timestamp / created_at", target: "eventTime" }
 ];
 var BROWSING_FIELDS = [
   { source: "uiData.pageUrl / data.page_url", target: "page.url" },
@@ -1167,15 +1172,20 @@ var BROWSING_FIELDS = [
   { source: "session_id", target: "sessionId" }
 ];
 var CART_FIELDS = [
-  { source: "line_items[].title", target: "cart.productName", required: true, note: "the first PAID line wins; freebies rank last" },
-  { source: "line_items[].product_image", target: "cart.image" },
+  { source: "line_items[].title", target: "cart.productDetails", required: true, note: "the first PAID line wins; freebies rank last" },
+  { source: "line_items[].title", target: "cart.productName", note: 'the featured line alone, without the "and N more"' },
+  { source: "line_items[].image", target: "cart.image", note: "looked up from product_id when the line has none" },
+  { source: "\u2014 (store domain + handle)", target: "cart.productUrl", note: "resolved, not sent" },
+  { source: "\u2014 (store domain + line ids)", target: "cartLink", note: "resolved, not sent" },
+  { source: "\u2014 (company shopify integration)", target: "storeUrl", note: "resolved, not sent" },
   { source: "line_items[].price", target: "\u2014 (ranking only)", note: "a zero price marks the line a freebie" },
-  { source: "line_items[].quantity", target: "cart.quantity" },
-  { source: "total_price", target: "pricing.totalPrice" },
-  { source: "subtotal_price", target: "pricing.subtotal" },
-  { source: "total_discount", target: "pricing.totalDiscount" },
-  { source: "currency", target: "pricing.currency" },
-  { source: "note_attributes[shopflo_checkout_url]", target: "checkoutUrl", note: "checkout_abandoned puts the link here, not in token_id" }
+  { source: "line_items[].quantity", target: "cart.quantity", note: "summed across the cart" },
+  { source: "line_items[]", target: "cart.itemCount", note: "the line count, not the quantity" },
+  { source: "total_price", target: "total_price", note: "the body is stored as sent" },
+  { source: "subtotal_price", target: "subtotal_price" },
+  { source: "total_discount", target: "total_discount" },
+  { source: "currency", target: "currency" },
+  { source: "abandoned_checkout_url", target: "checkoutUrl", required: true, note: "token_id is a bare uuid, only usable once built into a link" }
 ];
 var FIELD_MAPS2 = {
   store_page_view: [...COMMON_FIELDS2, ...BROWSING_FIELDS],
@@ -1186,10 +1196,11 @@ var FIELD_MAPS2 = {
     { source: "data.product_name", target: "product.name" },
     { source: "data.product_image", target: "product.image" },
     { source: "data.product_url", target: "product.url" },
-    { source: "data.product_price", target: "product.price" }
+    { source: "data.product_price", target: "product.price" },
+    { source: "data.product_compare_at_price", target: "product.compareAtPrice" },
+    { source: "data.product_type", target: "product.type" }
   ],
   added_to_cart_ui: [...COMMON_FIELDS2, ...CART_FIELDS],
-  checkout_clicked: [...COMMON_FIELDS2, ...CART_FIELDS],
   checkout_abandoned: [...COMMON_FIELDS2, ...CART_FIELDS],
   order_completed: [
     ...COMMON_FIELDS2,
@@ -1197,6 +1208,8 @@ var FIELD_MAPS2 = {
     { source: "order_id", target: "order.id" },
     { source: "order_name", target: "order.name" },
     { source: "payment_mode", target: "order.paymentMode" },
+    { source: "total_shipping", target: "order.totalShipping" },
+    { source: "total_tax", target: "order.totalTax" },
     { source: "total_payable", target: "order.totalPayable" }
   ]
 };
@@ -1244,7 +1257,7 @@ function editableFieldsFor2(eventName) {
 }
 var editableFields4 = editableFieldsFor2(DEFAULT_EVENT2);
 function buildPayload4(ctx) {
-  const { config, items, phone, collection } = ctx;
+  const { config, items, phone, collection, live } = ctx;
   const eventName = ctx.eventName ?? DEFAULT_EVENT2;
   const def = eventDef(eventName);
   const now = ctx.now ?? /* @__PURE__ */ new Date();
@@ -1263,7 +1276,7 @@ function buildPayload4(ctx) {
           pageUrl: `https://${domain}/`,
           pageTitle: config.shopify.shop?.name ?? domain,
           landingPageUrl: `https://${domain}/`,
-          referrerPageUrl: ""
+          referrerPageUrl: ctx.referrer ?? "https://www.google.com/"
         },
         clientData: { brandUrl: `https://${domain}` }
       },
@@ -1280,7 +1293,7 @@ function buildPayload4(ctx) {
         page_url: isProduct ? `https://${domain}/products/${first?.product?.handle ?? ""}` : `https://${domain}/collections/${collection?.handle ?? "all"}`,
         page_title: isProduct ? first?.product?.title : collection?.title,
         landing_page_url: `https://${domain}/`,
-        referrer_page_url: "",
+        referrer_page_url: ctx.referrer ?? "https://www.google.com/",
         ...isProduct ? {
           product_name: first?.product?.title,
           product_image: imageForVariant(first?.product, first?.variant),
@@ -1300,26 +1313,47 @@ function buildPayload4(ctx) {
     title: product.title,
     price: money2(variant?.price ?? 0).toFixed(2),
     quantity,
-    product_image: imageForVariant(product, variant)
+    image: imageForVariant(product, variant)
   }));
   const subtotal = money2(lineItems.reduce((sum, li) => sum + Number(li.price) * li.quantity, 0));
   const discount = money2(Math.min(ctx.discount ?? 0, subtotal));
   const total = money2(subtotal - discount);
-  const checkoutUrl = cartPermalink(domain, (items ?? []).map(({ variant, quantity }) => ({ variantId: variant?.id, quantity })));
+  const checkoutUrl = live?.kind === "checkout" && live.url ? live.url : cartPermalink(domain, (items ?? []).map(({ variant, quantity }) => ({ variantId: variant?.id, quantity })));
   return {
     event_name: eventName,
     session_id: ctx.sessionId ?? `sf-${now.getTime()}`,
-    token_id: checkoutUrl,
+    token_id: `sf-${now.getTime()}`,
+    abandoned_checkout_url: checkoutUrl,
     source: "shopflo",
     channel: "web",
     email: cust.email,
     phone,
     created_at: now.toISOString(),
-    // checkout_abandoned carries the recovery link here; the consumer prefers it
+    // the live note_attributes carry utm and the landing page, never a checkout url
     note_attributes: [
       { name: "landing_page", value: `/products/${items?.[0]?.product?.handle ?? ""}` },
-      { name: "shopflo_checkout_url", value: checkoutUrl }
+      { name: "utm_source", value: "ig" },
+      { name: "customer_type", value: "NEW" }
     ],
+    utm_params: {
+      utm_source: "ig",
+      utm_medium: "Instagram_Feed",
+      utm_campaign: "hookwright",
+      utm_content: "hookwright",
+      utm_term: "0",
+      landing_page: `/products/${items?.[0]?.product?.handle ?? ""}`,
+      landing_page_url: `https://${domain}/products/${items?.[0]?.product?.handle ?? ""}`
+    },
+    shipping_address: {
+      city: "Bangalore",
+      province: "Karnataka",
+      province_code: "KA",
+      zip: "560024",
+      country: "India",
+      country_code: "IN",
+      phone,
+      email: cust.email
+    },
     line_items: lineItems,
     customer: { uid: "sf-user", first_name: cust.firstName, last_name: cust.lastName, email: cust.email, phone },
     currency,
@@ -1327,12 +1361,13 @@ function buildPayload4(ctx) {
     total_discount: discount,
     total_price: total,
     ...eventName === "order_completed" ? {
-      order_id: ctx.orderId ?? Math.floor(now.getTime() / 1e3),
-      order_name: ctx.orderName ?? `#${String(now.getTime()).slice(-5)}`,
+      // a real order id is what the receiver would look up
+      order_id: live?.kind === "order" ? live.id : ctx.orderId ?? Math.floor(now.getTime() / 1e3),
+      order_name: live?.kind === "order" ? live.name : ctx.orderName ?? `#${String(now.getTime()).slice(-5)}`,
       payment_mode: "prepaid",
       total_shipping: 0,
       total_tax: 0,
-      total_payable: total
+      total_payable: live?.kind === "order" ? Number(live.price) : total
     } : {},
     timestamp: now.getTime()
   };
@@ -1348,7 +1383,7 @@ function webhookSecret4(config) {
 }
 function storeOf(payload) {
   const brandUrl = payload?.eventPayload?.clientData?.brandUrl;
-  const candidate = brandUrl ?? payload?.token_id;
+  const candidate = brandUrl ?? payload?.utm_params?.landing_page_url ?? payload?.data?.page_url;
   if (!candidate) return void 0;
   try {
     return new URL(candidate).host;
@@ -1482,12 +1517,25 @@ function nationalNumber(raw, regionCode) {
 // src/providers/flexype.mjs
 var GATE_PATH3 = "event_type";
 var GATE_VALUE2 = "ABANDONED_CHECKOUT";
+var EVENTS3 = [
+  { eventName: "ABANDONED_CHECKOUT", type: "flexype_abandoned_checkout", label: "Abandoned Checkout", selection: "cart", subject: "cart contents" },
+  { eventName: "COLLECTION_VIEWED", type: "flexype_collection_viewed", label: "Collection Viewed", selection: "collection", subject: "one collection" },
+  { eventName: "PRODUCT_VIEWED", type: "flexype_product_viewed", label: "Product Viewed", selection: "product", subject: "one product" }
+];
+var DEFAULT_EVENT3 = GATE_VALUE2;
+var eventDef2 = (eventName) => EVENTS3.find((e) => e.eventName === eventName) ?? EVENTS3[0];
+function eventFromPayload3(payload) {
+  return payload?.event_type;
+}
+function selectionFor3(eventName) {
+  return eventDef2(eventName).selection;
+}
 var fieldMap5 = [
   { source: "event_type", target: "\xABgate\xBB", required: true, note: "must be ABANDONED_CHECKOUT or the event is dropped" },
   { source: "payload.user.phone_with_dial_code", target: "phone", required: true, note: "falls back to dial_code + phone" },
   { source: "payload.user.first_name", target: "customer.firstName" },
   { source: "payload.user.last_name", target: "customer.lastName" },
-  { source: "payload.user.full_name", target: "customer.name" },
+  { source: "payload.user.full_name", target: "customer.fullName", note: "falls back to first + last name" },
   { source: "payload.user.email", target: "customer.email" },
   { source: "payload.checkout_url", target: "checkoutUrl", required: true },
   { source: "payload.session_id", target: "sessionId" },
@@ -1496,7 +1544,8 @@ var fieldMap5 = [
   { source: "payload.cart_items[].image", target: "cart.image" },
   { source: "payload.cart_items[].total_price", target: "pricing.totalPrice", note: "summed across the cart" },
   { source: "payload.cart_items[].total_discount", target: "pricing.totalDiscount", note: "summed across the cart" },
-  { source: "payload.cart_items[].quantity", target: "cart.quantity" },
+  { source: "payload.cart_items[].quantity", target: "cart.quantity", note: "summed across the cart" },
+  { source: "payload.cart_items[]", target: "cart.itemCount", note: "the line count, not the quantity" },
   { source: "payload.coupons[0].code", target: "pricing.couponCode" },
   { source: "payload.checkout_context.presentment_currency", target: "pricing.currency" },
   { source: "payload.checkout_context.presentment_country", target: "phone region" },
@@ -1504,6 +1553,9 @@ var fieldMap5 = [
   { source: "payload.metadata.landing_page", target: "attribution.landingPage" },
   { source: "store.shopify_domain", target: "storeUrl" },
   { source: "store.name", target: "store.name" },
+  { source: "store.main_domain", target: "store.mainDomain" },
+  { source: "payload.checkout_context.store_country", target: "store.country" },
+  { source: "payload.metadata.orig_referer", target: "attribution.referrer" },
   { source: "event_id", target: "eventId" },
   { source: "event_time", target: "eventTime" }
 ];
@@ -1524,12 +1576,64 @@ var editableFields5 = [
   { group: "Attribution", path: "payload.metadata.landing_page", label: "Landing page", optional: true }
 ];
 function buildPayload5(ctx) {
-  const { config, items, phone } = ctx;
+  const { config, items, phone, live, collection } = ctx;
+  const eventName = ctx.eventName ?? DEFAULT_EVENT3;
   const now = ctx.now ?? /* @__PURE__ */ new Date();
   const currency = ctx.currency || config.defaults.currency;
   const domain = config.shopify.domain;
   const cust = config.customer;
   const { dialCode, national } = splitPhone(phone, cust.countryCode);
+  const envelope = {
+    event_id: `fx-${now.getTime()}`,
+    event_type: eventName,
+    event_time: now.toISOString(),
+    store: {
+      id: 1,
+      name: config.shopify.shop?.name ?? config.shopify.domain,
+      shopify_domain: config.shopify.domain,
+      main_domain: config.shopify.domain
+    }
+  };
+  const user = {
+    email: config.customer.email,
+    full_name: `${config.customer.firstName} ${config.customer.lastName}`.trim(),
+    first_name: config.customer.firstName,
+    last_name: config.customer.lastName,
+    dial_code: splitPhone(phone, config.customer.countryCode).dialCode,
+    phone: splitPhone(phone, config.customer.countryCode).national,
+    phone_with_dial_code: phone
+  };
+  if (eventName === "COLLECTION_VIEWED") {
+    return {
+      ...envelope,
+      payload: {
+        user,
+        collection_viewed: {
+          collection_id: Number(collection?.id) || 0,
+          name: collection?.title ?? "",
+          handle: collection?.handle ?? "",
+          image: collection?.image?.src ?? "",
+          timestamp: now.toISOString()
+        }
+      }
+    };
+  }
+  if (eventName === "PRODUCT_VIEWED") {
+    const first = items?.[0];
+    return {
+      ...envelope,
+      payload: {
+        user,
+        product_viewed: {
+          product_id: Number(first?.product?.id) || 0,
+          title: first?.product?.title ?? "",
+          handle: first?.product?.handle ?? "",
+          image: imageForVariant(first?.product, first?.variant) ?? "",
+          timestamp: now.toISOString()
+        }
+      }
+    };
+  }
   const cartItems = (items ?? []).map(({ product, variant, quantity }) => {
     const unit = money2(variant?.price ?? 0);
     return {
@@ -1544,7 +1648,7 @@ function buildPayload5(ctx) {
       sku: variant?.sku || null
     };
   });
-  const checkoutUrl = cartPermalink(domain, (items ?? []).map(({ variant, quantity }) => ({ variantId: variant?.id, quantity })));
+  const checkoutUrl = live?.kind === "checkout" && live.url ? live.url : cartPermalink(domain, (items ?? []).map(({ variant, quantity }) => ({ variantId: variant?.id, quantity })));
   const utm = Object.entries(config.defaults.utm ?? {}).map(([name, value]) => ({ name, value }));
   return {
     event_id: `fx-${now.getTime()}`,
@@ -1579,8 +1683,8 @@ function buildPayload5(ctx) {
       coupons: ctx.couponCode ? [{ code: ctx.couponCode }] : [],
       metadata: {
         landing_page: `https://${domain}/products/${items?.[0]?.product?.handle ?? ""}`,
-        orig_referer: "",
-        referer_host: "",
+        orig_referer: ctx.referrer ?? "https://www.google.com/",
+        referer_host: "www.google.com",
         utm
       }
     }
@@ -1621,6 +1725,11 @@ var flexype_default = {
   urlKey: "flexype",
   label: "FlexyPe",
   eventType: "flexype_abandoned_checkout",
+  events: EVENTS3,
+  defaultEvent: DEFAULT_EVENT3,
+  gateFor: (eventName) => ({ path: GATE_PATH3, value: eventName }),
+  selectionFor: selectionFor3,
+  eventFromPayload: eventFromPayload3,
   gate: { path: GATE_PATH3, value: GATE_VALUE2 },
   signatureScheme: "static shared secret in the header (no body signature)",
   signatureHeader: "x-flexype-authorization",
@@ -1636,7 +1745,7 @@ var flexype_default = {
 // src/providers/return-prime.mjs
 var STATUSES = ["requested", "approved", "received", "inspected", "rejected"];
 var titleCase = (v) => v.charAt(0).toUpperCase() + v.slice(1);
-var EVENTS3 = ["return", "exchange"].flatMap(
+var EVENTS4 = ["return", "exchange"].flatMap(
   (requestType) => STATUSES.map((status) => ({
     eventName: `${requestType}_${status}`,
     requestType,
@@ -1647,15 +1756,15 @@ var EVENTS3 = ["return", "exchange"].flatMap(
     subject: requestType === "exchange" ? "the returned product and its replacement" : "the returned product"
   }))
 );
-var DEFAULT_EVENT3 = "return_requested";
-var eventDef2 = (eventName) => EVENTS3.find((e) => e.eventName === eventName) ?? EVENTS3.find((e) => e.eventName === DEFAULT_EVENT3);
-function eventFromPayload3(payload) {
+var DEFAULT_EVENT4 = "return_requested";
+var eventDef3 = (eventName) => EVENTS4.find((e) => e.eventName === eventName) ?? EVENTS4.find((e) => e.eventName === DEFAULT_EVENT4);
+function eventFromPayload4(payload) {
   const request = payload?.request ?? payload ?? {};
   if (!request.request_type || !request.status) return void 0;
   return `${request.request_type}_${request.status}`;
 }
-function selectionFor3(eventName) {
-  return eventDef2(eventName).selection;
+function selectionFor4(eventName) {
+  return eventDef3(eventName).selection;
 }
 var COMMON_FIELDS3 = [
   { source: "request_type", target: "\xABgate\xBB + requestType", required: true, note: "return or exchange" },
@@ -1681,10 +1790,10 @@ var EXCHANGE_FIELDS = [
 ];
 var fieldMap6 = COMMON_FIELDS3;
 function fieldMapFor(eventName) {
-  return eventDef2(eventName).requestType === "exchange" ? [...COMMON_FIELDS3, ...EXCHANGE_FIELDS] : COMMON_FIELDS3;
+  return eventDef3(eventName).requestType === "exchange" ? [...COMMON_FIELDS3, ...EXCHANGE_FIELDS] : COMMON_FIELDS3;
 }
 function editableFieldsFor3(eventName) {
-  const def = eventDef2(eventName);
+  const def = eventDef3(eventName);
   const p = (path6) => def.envelope === "root" ? path6 : `request.${path6}`;
   return [
     { group: "Request", path: p("request_number"), label: "Request number" },
@@ -1703,14 +1812,14 @@ function editableFieldsFor3(eventName) {
     { group: "Pricing", path: p("line_items.0.presentment_price.currency"), label: "Currency" }
   ];
 }
-var editableFields6 = editableFieldsFor3(DEFAULT_EVENT3);
+var editableFields6 = editableFieldsFor3(DEFAULT_EVENT4);
 function statusBlock(reached, at, comment = null) {
   return { status: reached, comment, created_at: reached ? at : null };
 }
 function buildPayload6(ctx) {
   const { config, items, phone } = ctx;
-  const eventName = ctx.eventName ?? DEFAULT_EVENT3;
-  const def = eventDef2(eventName);
+  const eventName = ctx.eventName ?? DEFAULT_EVENT4;
+  const def = eventDef3(eventName);
   const now = ctx.now ?? /* @__PURE__ */ new Date();
   const currency = ctx.currency || config.defaults.currency;
   const cust = config.customer;
@@ -1912,19 +2021,19 @@ var return_prime_default = {
   id: "return-prime",
   urlKey: "return_prime",
   label: "Return Prime",
-  events: EVENTS3,
-  defaultEvent: DEFAULT_EVENT3,
+  events: EVENTS4,
+  defaultEvent: DEFAULT_EVENT4,
   eventType: "return_prime_return_requested",
   gate: { path: "request.request_type", value: "return" },
-  gateFor: (eventName) => ({ path: "request.status", value: eventDef2(eventName).status }),
+  gateFor: (eventName) => ({ path: "request.status", value: eventDef3(eventName).status }),
   signatureScheme: "none documented \u2014 every request is accepted",
   signatureHeader: null,
   fieldMap: fieldMap6,
   fieldMapFor,
   editableFields: editableFields6,
   editableFieldsFor: editableFieldsFor3,
-  selectionFor: selectionFor3,
-  eventFromPayload: eventFromPayload3,
+  selectionFor: selectionFor4,
+  eventFromPayload: eventFromPayload4,
   buildPayload: buildPayload6,
   sign: sign6,
   webhookUrl: webhookUrl6,
@@ -3008,7 +3117,11 @@ async function buildPayload8({ cfg, providerId = "cashfree-occ", items = [], dis
 
 // src/shopify/live.mjs
 var LIVE_EVENTS = {
-  nitro: /* @__PURE__ */ new Set(["checkout", "orders/create", "orders/updated"])
+  nitro: /* @__PURE__ */ new Set(["checkout", "orders/create", "orders/updated"]),
+  // shopflo's recovery link and order id are looked up the same way
+  shopflo: /* @__PURE__ */ new Set(["checkout_abandoned", "checkout_clicked", "order_completed"]),
+  // flexype sends one event and it is a recovery link
+  flexype: /* @__PURE__ */ new Set(["ABANDONED_CHECKOUT"])
 };
 function needsLive(providerId, eventName) {
   return LIVE_EVENTS[providerId]?.has(eventName) ?? false;
@@ -3090,8 +3203,9 @@ async function liveOrder({ config, items = [], phone, client = clientFor(config)
 async function resolveLive({ config, providerId, eventName, items, phone, client }) {
   if (!needsLive(providerId, eventName)) return null;
   if (!config?.shopify?.domain || !config?.shopify?.accessToken) return null;
-  if (eventName === "checkout") return await liveCheckout({ config, items, ...client ? { client } : {} });
-  return await liveOrder({ config, items, phone, ...client ? { client } : {} });
+  const wantsOrder = eventName === "orders/create" || eventName === "orders/updated" || eventName === "order_completed";
+  if (wantsOrder) return await liveOrder({ config, items, phone, ...client ? { client } : {} });
+  return await liveCheckout({ config, items, ...client ? { client } : {} });
 }
 
 // src/core/send.mjs

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hookwright",
-  "version": "1.8.0",
+  "version": "1.10.0",
   "description": "Build real, signed e-commerce webhooks from a live Shopify catalogue — interactive terminal UI, no backend",
   "keywords": [
     "webhook",