hookwright 1.7.0 → 1.9.0

package/dist/cli.js

@@ -24,7 +24,7 @@ var init_package = __esm({
   "package.json"() {
     package_default = {
       name: "hookwright",
-      version: "1.7.0",
+      version: "1.9.0",
       description: "Build real, signed e-commerce webhooks from a live Shopify catalogue \u2014 interactive terminal UI, no backend",
       keywords: [
         "webhook",
@@ -163,6 +163,9 @@ var DEFAULT_CONFIG = {
   shopify: {
     domain: "",
     accessToken: "",
+    // Storefront API token. Creating a checkout needs one: the admin checkout API
+    // was removed, so a fresh checkout can only be minted through the storefront.
+    storefrontAccessToken: "",
     apiVersion: "2024-10",
     // cached from the last successful connection, for display only
     shop: null
@@ -1153,7 +1156,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,7 +1176,8 @@ 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[].price", target: "\u2014 (ranking only)", note: "a zero price marks the line a freebie" },
-  { source: "line_items[].quantity", target: "cart.quantity" },
+  { 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: "pricing.totalPrice" },
   { source: "subtotal_price", target: "pricing.subtotal" },
   { source: "total_discount", target: "pricing.totalDiscount" },
@@ -1183,7 +1193,9 @@ 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],
@@ -1194,6 +1206,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" }
   ]
 };
@@ -1241,7 +1255,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();
@@ -1260,7 +1274,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}` }
       },
@@ -1277,7 +1291,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),
@@ -1302,7 +1316,7 @@ function buildPayload4(ctx) {
   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()}`,
@@ -1324,12 +1338,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()
   };
@@ -1479,12 +1494,13 @@ function nationalNumber(raw, regionCode) {
 // src/providers/flexype.mjs
 var GATE_PATH3 = "event_type";
 var GATE_VALUE2 = "ABANDONED_CHECKOUT";
+var DEFAULT_EVENT3 = GATE_VALUE2;
 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" },
@@ -1493,7 +1509,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" },
@@ -1501,6 +1518,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" }
 ];
@@ -1521,7 +1541,7 @@ 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 } = ctx;
   const now = ctx.now ?? /* @__PURE__ */ new Date();
   const currency = ctx.currency || config.defaults.currency;
   const domain = config.shopify.domain;
@@ -1541,7 +1561,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()}`,
@@ -1576,8 +1596,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
       }
     }
@@ -1618,6 +1638,7 @@ var flexype_default = {
   urlKey: "flexype",
   label: "FlexyPe",
   eventType: "flexype_abandoned_checkout",
+  defaultEvent: DEFAULT_EVENT3,
   gate: { path: GATE_PATH3, value: GATE_VALUE2 },
   signatureScheme: "static shared secret in the header (no body signature)",
   signatureHeader: "x-flexype-authorization",
@@ -1644,8 +1665,8 @@ 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);
+var DEFAULT_EVENT4 = "return_requested";
+var eventDef2 = (eventName) => EVENTS3.find((e) => e.eventName === eventName) ?? EVENTS3.find((e) => e.eventName === DEFAULT_EVENT4);
 function eventFromPayload3(payload) {
   const request = payload?.request ?? payload ?? {};
   if (!request.request_type || !request.status) return void 0;
@@ -1700,13 +1721,13 @@ 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 eventName = ctx.eventName ?? DEFAULT_EVENT4;
   const def = eventDef2(eventName);
   const now = ctx.now ?? /* @__PURE__ */ new Date();
   const currency = ctx.currency || config.defaults.currency;
@@ -1910,7 +1931,7 @@ var return_prime_default = {
   urlKey: "return_prime",
   label: "Return Prime",
   events: EVENTS3,
-  defaultEvent: DEFAULT_EVENT3,
+  defaultEvent: DEFAULT_EVENT4,
   eventType: "return_prime_return_requested",
   gate: { path: "request.request_type", value: "return" },
   gateFor: (eventName) => ({ path: "request.status", value: eventDef2(eventName).status }),
@@ -2493,6 +2514,33 @@ var ShopifyClient = class {
     const { json } = await this.request("/checkouts.json", { query: { limit } });
     return json?.checkouts ?? [];
   }
+  /**
+   * Creates a real checkout through the storefront API and returns its recovery
+   * link. The admin checkout API was removed, so this is the only way to mint a
+   * new one; it needs a storefront token, which is separate from the admin one.
+   */
+  async createCheckout({ storefrontAccessToken, lineItems, email }) {
+    if (!storefrontAccessToken) throw new ShopifyError("Storefront access token missing", { hint: "run `hookwright configure` and add it, or the checkout event reuses an existing checkout" });
+    const mutation = `mutation checkoutCreate($input: CheckoutCreateInput!) {
+      checkoutCreate(input: $input) {
+        checkout { id webUrl totalPrice { amount currencyCode } }
+        checkoutUserErrors { field message }
+      }
+    }`;
+    const input = { lineItems: lineItems.map(({ variantId, quantity }) => ({ variantId: `gid://shopify/ProductVariant/${variantId}`, quantity })) };
+    if (email) input.email = email;
+    const res = await fetch(`https://${this.domain}/api/2024-01/graphql.json`, {
+      method: "POST",
+      headers: { "Content-Type": "application/json", "X-Shopify-Storefront-Access-Token": storefrontAccessToken },
+      body: JSON.stringify({ query: mutation, variables: { input } })
+    });
+    const body = await res.json();
+    const errors = body.errors ?? body.data?.checkoutCreate?.checkoutUserErrors;
+    if (errors?.length) throw new ShopifyError(`Shopify rejected the checkout: ${errors.map((e) => e.message).join("; ")}`, { hint: "the storefront token needs unauthenticated_write_checkouts" });
+    const checkout = body.data?.checkoutCreate?.checkout;
+    if (!checkout) throw new ShopifyError("Shopify returned no checkout", { hint: "check the storefront token and api version" });
+    return checkout;
+  }
   /** Orders, newest first. */
   async orders({ limit = 10, status = "any" } = {}) {
     const { json } = await this.request("/orders.json", { query: { limit, status } });
@@ -2978,7 +3026,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;
@@ -2991,6 +3043,19 @@ function clientFor(config) {
   });
 }
 async function liveCheckout({ config, items = [], client = clientFor(config) }) {
+  const storefrontAccessToken = config.shopify?.storefrontAccessToken;
+  const lineItems = items.map(({ variant, product, quantity }) => ({ variantId: Number(variant?.id ?? product?.id), quantity: Number(quantity) || 1 })).filter((l) => Number.isFinite(l.variantId) && l.variantId > 0);
+  if (storefrontAccessToken && lineItems.length) {
+    const checkout2 = await client.createCheckout({ storefrontAccessToken, lineItems, email: config.customer?.email || void 0 });
+    return {
+      kind: "checkout",
+      created: true,
+      url: checkout2.webUrl,
+      cartValue: money2(checkout2.totalPrice?.amount ?? 0).toFixed(2),
+      cartToken: /\/checkouts\/([^/?]+)/.exec(checkout2.webUrl ?? "")?.[1],
+      lineItems: []
+    };
+  }
   const checkouts = await client.abandonedCheckouts({ limit: 20 });
   if (checkouts.length === 0) return null;
   const wanted = new Set(items.map(({ variant }) => Number(variant?.id)).filter(Boolean));
@@ -2998,6 +3063,7 @@ async function liveCheckout({ config, items = [], client = clientFor(config) })
   const checkout = matching ?? checkouts[0];
   return {
     kind: "checkout",
+    created: false,
     url: checkout.abandoned_checkout_url,
     cartValue: money2(checkout.total_price ?? 0).toFixed(2),
     cartToken: checkout.cart_token,
@@ -3046,8 +3112,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.7.0",
+  "version": "1.9.0",
   "description": "Build real, signed e-commerce webhooks from a live Shopify catalogue — interactive terminal UI, no backend",
   "keywords": [
     "webhook",