hookwright 1.12.2 → 1.13.0

package/dist/cli.js

@@ -24,7 +24,7 @@ var init_package = __esm({
   "package.json"() {
     package_default = {
       name: "hookwright",
-      version: "1.12.2",
+      version: "1.13.0",
       description: "Build real, signed e-commerce webhooks from a live Shopify catalogue \u2014 interactive terminal UI, no backend",
       keywords: [
         "webhook",
@@ -178,7 +178,9 @@ var DEFAULT_CONFIG = {
     shopflo: { webhookUrl: "", webhookSecret: "" },
     flexype: { webhookUrl: "", webhookSecret: "" },
     "return-prime": { webhookUrl: "", webhookSecret: "" },
-    fastrr: { webhookUrl: "", webhookSecret: "" }
+    fastrr: { webhookUrl: "", webhookSecret: "" },
+    gokwik: { webhookUrl: "", webhookSecret: "" },
+    ecom360: { webhookUrl: "", webhookSecret: "" }
   },
   customer: {
     firstName: "",
@@ -2258,6 +2260,423 @@ var fastrr_default = {
   summarize: summarize7
 };
 
+// src/providers/gokwik.mjs
+var GATE_PATH5 = "abc_url";
+var GATE_VALUE4 = "";
+var fieldMap8 = [
+  { source: "abc_url", target: "\xABgate\xBB + checkout_link", required: true, note: "absent and the event is dropped; its origin builds every other link" },
+  { source: "customer.phone / address.phone", target: "customer.phone", required: true },
+  { source: "sa_localization", target: "phone region", required: true, note: 'address.country says "India", which the parser cannot use' },
+  { source: "customer.firstname", target: "customer.firstName" },
+  { source: "customer.lastname", target: "customer.lastName" },
+  { source: "customer.email / address.email", target: "customer.email" },
+  { source: "items[].title", target: "product_details", required: true, note: "the first PAID line wins; freebies rank last" },
+  { source: "items[].product_title", target: "product_name" },
+  { source: "items[].image", target: "product_image_url", note: "read off the featured line only" },
+  { source: "items[].url", target: "product_url", note: "relative \u2014 resolved against the abc_url origin" },
+  { source: "items[].final_price", target: "product_price", note: "PAISE \u2014 the consumer divides by 100" },
+  { source: "items[].sku", target: "product_sku" },
+  { source: "items[].product_type", target: "product_type" },
+  { source: "items[].variant_id", target: "cart_link", note: "joined as variant:quantity" },
+  { source: "items[].quantity", target: "total_quantity", note: "summed across the cart" },
+  { source: "item_count", target: "item_count", note: "gokwik's own count is kept over the line count" },
+  { source: "total_price", target: "total_price", note: "RUPEE string, unlike the line prices" },
+  { source: "original_total_price", target: "original_total_price" },
+  { source: "items_subtotal_price", target: "subtotal_price" },
+  { source: "total_discount", target: "total_discount" },
+  { source: "currency", target: "currency" },
+  { source: "request_id", target: "request_id" },
+  { source: "token", target: "token" },
+  { source: "drop_stage", target: "drop_stage" },
+  { source: "rto_risk_flag", target: "rto_risk_flag" },
+  { source: "brand_order_count", target: "brand_order_count" },
+  { source: "mkt_source", target: "mkt_source" },
+  { source: "mkt_medium", target: "mkt_medium" },
+  { source: "mkt_campaign", target: "mkt_campaign" },
+  { source: "mkt_content", target: "mkt_content" },
+  { source: "mkt_term", target: "mkt_term" },
+  { source: "mkt_fbclid", target: "mkt_fbclid" },
+  { source: "landing_page", target: "landing_page" },
+  { source: "orig_referrer", target: "orig_referrer" },
+  { source: "address.city", target: "address.city" },
+  { source: "address.state", target: "address.state" },
+  { source: "address.pincode", target: "address.pincode" },
+  { source: "address.country", target: "address.country" },
+  { source: "address.address", target: "address.address" },
+  { source: "shipping.price", target: "shipping.price" },
+  { source: "city", target: "city", note: "the ip city, not the delivery city" },
+  { source: "isp", target: "isp" },
+  { source: "user_agent", target: "user_agent" },
+  { source: "updated_at", target: "eventTime" }
+];
+var editableFields8 = [
+  { group: "Checkout", path: "request_id", label: "Request id" },
+  { group: "Checkout", path: "token", label: "Token" },
+  { group: "Checkout", path: "abc_url", label: "Recovery URL", hint: "gates the event; its origin builds the product and cart links" },
+  { group: "Checkout", path: "drop_stage", label: "Drop stage" },
+  { group: "Checkout", path: "rto_risk_flag", label: "RTO risk flag" },
+  { group: "Checkout", path: "gokwik_source_channel", label: "Source channel" },
+  { group: "Pricing", path: "total_price", label: "Total price", hint: "rupee string, unlike the line prices" },
+  { group: "Pricing", path: "total_discount", label: "Discount" },
+  { group: "Pricing", path: "currency", label: "Currency" },
+  { group: "Customer", path: "customer.firstname", label: "First name" },
+  { group: "Customer", path: "customer.lastname", label: "Last name" },
+  { group: "Customer", path: "customer.email", label: "Email" },
+  { group: "Customer", path: "customer.phone", label: "Phone" },
+  { group: "Customer", path: "brand_order_count", label: "Brand order count", type: "number" },
+  { group: "Customer", path: "sa_localization", label: "Localization", hint: "two letter region used to parse the phone" },
+  { group: "Shipping", path: "address.address", label: "Address line" },
+  { group: "Shipping", path: "address.city", label: "City" },
+  { group: "Shipping", path: "address.state", label: "State" },
+  { group: "Shipping", path: "address.pincode", label: "Pincode", type: "number" },
+  { group: "Attribution", path: "mkt_source", label: "UTM source" },
+  { group: "Attribution", path: "mkt_medium", label: "UTM medium" },
+  { group: "Attribution", path: "mkt_campaign", label: "UTM campaign" },
+  { group: "Attribution", path: "landing_page", label: "Landing page" },
+  { group: "Attribution", path: "orig_referrer", label: "Referrer" }
+];
+function paise(rupees) {
+  return Math.round(money2(rupees) * 100);
+}
+function buildPayload8(ctx) {
+  const { config, items, phone } = ctx;
+  const now = ctx.now ?? /* @__PURE__ */ new Date();
+  const currency = ctx.currency || config.defaults.currency;
+  const domain = config.shopify.domain;
+  const cust = config.customer;
+  const utm = config.defaults.utm ?? {};
+  const lineItems = (items ?? []).map(({ product, variant, quantity }) => {
+    const unit = money2(variant?.price ?? 0);
+    return {
+      id: Number(variant?.id ?? 0),
+      sku: variant?.sku || "",
+      url: `/products/${product.handle}?variant=${variant?.id ?? ""}`,
+      grams: 500,
+      image: imageForVariant(product, variant),
+      price: paise(unit),
+      title: `${product.title}${variant?.title ? ` - ${variant.title}` : ""}`,
+      vendor: product.vendor ?? "",
+      taxable: true,
+      quantity,
+      gift_card: false,
+      line_price: paise(unit * quantity),
+      product_id: Number(product.id),
+      variant_id: Number(variant?.id ?? 0),
+      final_price: paise(unit),
+      product_type: product.productType ?? "",
+      product_title: product.title,
+      original_price: paise(unit),
+      total_discount: 0,
+      final_line_price: paise(unit * quantity),
+      requires_shipping: true
+    };
+  });
+  const subtotal = money2(lineItems.reduce((sum, li) => sum + li.final_line_price / 100, 0));
+  const discount = money2(Math.min(ctx.discount ?? 0, subtotal));
+  const total = money2(subtotal - discount);
+  const requestId = ctx.requestId ?? `gk-${now.getTime()}`;
+  const abcUrl = `https://${domain}?mrid=${requestId}`;
+  return {
+    request_id: requestId,
+    token: `${requestId}?key=${now.getTime().toString(36)}`,
+    note: null,
+    attributes: "{}",
+    original_total_price: subtotal.toFixed(4),
+    total_price: total.toFixed(4),
+    total_discount: discount.toFixed(4),
+    total_weight: "500.0000",
+    is_abandoned: true,
+    item_count: lineItems.length,
+    items: lineItems,
+    requires_shipping: true,
+    currency,
+    items_subtotal_price: String(subtotal),
+    cart_level_discount_applications: [],
+    discount: null,
+    shipping: {
+      id: 1,
+      name: "Shipping",
+      price: ctx.shippingPrice ?? 0,
+      title: "Shipping",
+      base_price: 0,
+      cod_charges: 0,
+      prepaid_price: 0,
+      payment_options: "all",
+      discounted_price: 0
+    },
+    abc_url: abcUrl,
+    created_at: now.toISOString(),
+    updated_at: now.toISOString(),
+    city: cust.city,
+    isp: "Test ISP",
+    ip: "203.0.113.10",
+    mkt_source: utm.utm_source ?? "direct",
+    mkt_medium: utm.utm_medium ?? null,
+    mkt_campaign: utm.utm_campaign ?? null,
+    mkt_content: utm.utm_content ?? null,
+    mkt_term: utm.utm_term ?? null,
+    mkt_fbclid: utm.fbclid ?? null,
+    gift_card_total: "0",
+    payment_methods: ["upi", "cc", "dc", "netbanking"],
+    drop_stage: "Payment Page",
+    checkout_url: null,
+    note_text: "",
+    landing_page: "/",
+    orig_referrer: `https://${domain}/`,
+    gokwik_source_channel: "shopify_checkout",
+    store_source: "web",
+    store_platform: null,
+    rto_risk_flag: "Control",
+    sa_localization: cust.countryCode,
+    shopifysessionid: `gk-session-${now.getTime()}`,
+    user_agent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 Chrome/151.0.0.0 Safari/537.36",
+    notify_customer: false,
+    brand_order_count: 2,
+    address: {
+      firstname: cust.firstName,
+      lastname: cust.lastName,
+      city: cust.city,
+      pincode: Number(cust.zip) || 0,
+      state: cust.province,
+      country: cust.country,
+      email: cust.email,
+      phone,
+      default_address: 0,
+      addresstype: "home",
+      partial_address: false,
+      total_order_count: 1,
+      deliver_order_count: 0,
+      address: cust.address1
+    },
+    customer: {
+      firstname: cust.firstName,
+      lastname: cust.lastName,
+      email: cust.email,
+      phone
+    }
+  };
+}
+function sign8() {
+  return { signature: null, timestamp: null, headers: { "content-type": "application/json" } };
+}
+function webhookUrl8(config) {
+  return String(targetFor(config, "gokwik").webhookUrl ?? "").trim();
+}
+function webhookSecret8(config) {
+  return String(targetFor(config, "gokwik").webhookSecret ?? "");
+}
+function summarize8(payload) {
+  const items = Array.isArray(payload?.items) ? payload.items : [];
+  let store;
+  try {
+    store = payload?.abc_url ? new URL(payload.abc_url).host : void 0;
+  } catch {
+    store = payload?.abc_url;
+  }
+  return {
+    event: "abandoned checkout",
+    store,
+    customer: `${payload?.customer?.firstname ?? ""} ${payload?.customer?.lastname ?? ""} \xB7 ${payload?.customer?.phone ?? ""}`.trim(),
+    items: items.map((i) => `${i.title} x${i.quantity}`).join(", "),
+    total: payload?.total_price,
+    currency: payload?.currency,
+    extra: `stage ${payload?.drop_stage}, rto ${payload?.rto_risk_flag}`,
+    link: payload?.abc_url
+  };
+}
+var gokwik_default = {
+  id: "gokwik",
+  urlKey: "gokwik",
+  label: "GoKwik",
+  eventType: "gokwik_abandoned_checkout",
+  gate: { path: GATE_PATH5, value: GATE_VALUE4 },
+  signatureScheme: "none documented \u2014 every request is accepted",
+  signatureHeader: null,
+  fieldMap: fieldMap8,
+  editableFields: editableFields8,
+  buildPayload: buildPayload8,
+  sign: sign8,
+  webhookUrl: webhookUrl8,
+  webhookSecret: webhookSecret8,
+  summarize: summarize8
+};
+
+// src/providers/ecom360.mjs
+import crypto4 from "crypto";
+var GATE_PATH6 = "event";
+var GATE_VALUE5 = "ABANDONED_CHECKOUT";
+var fieldMap9 = [
+  { source: "event", target: "\xABgate\xBB", required: true, note: "must be ABANDONED_CHECKOUT or the event is dropped" },
+  { source: "data.phone / data.customer.shipping_address.phone", target: "customer.phone", required: true },
+  { source: "data.customer.shipping_address.country_code", target: "phone region" },
+  { source: "data.customer.first_name", target: "customer.firstName" },
+  { source: "data.customer.last_name", target: "customer.lastName" },
+  { source: "data.email / data.customer.email", target: "customer.email" },
+  { source: "data.abandoned_checkout_url", target: "checkout_link", required: true },
+  { source: "data.store_url", target: "store_url + cart_link", required: true, note: "the cart link is built from it; no lookup needed" },
+  { source: "data.line_items[].title", target: "product_details", required: true, note: "the first PAID line wins; freebies rank last" },
+  { source: "data.line_items[].sku", target: "product_sku" },
+  { source: "data.line_items[].price", target: "product_price", note: "also ranks the lines; a zero marks a freebie" },
+  { source: "data.line_items[].variant_id", target: "cart_link", note: "joined as variant:quantity" },
+  { source: "data.line_items[].quantity", target: "total_quantity", note: "summed across the cart" },
+  { source: "data.line_items[]", target: "item_count", note: "the line count" },
+  { source: "\u2014 (no handle is sent)", target: "product_url", note: "the consumer builds none, by design" },
+  { source: "data.total_price", target: "total_price" },
+  { source: "data.original_total_price", target: "original_total_price" },
+  { source: "data.total_discount", target: "total_discount" },
+  { source: "data.promotions[0].code", target: "coupon_code" },
+  { source: "data.promotions[0].value", target: "coupon_value" },
+  { source: "data.cart_id", target: "cart_id" },
+  { source: "data.cart_token", target: "cart_token" },
+  { source: "data.platform", target: "platform" },
+  { source: "data.utm_parameters.utm_source", target: "utm_parameters.utm_source" },
+  { source: "data.utm_parameters.utm_medium", target: "utm_parameters.utm_medium" },
+  { source: "data.utm_parameters.utm_campaign", target: "utm_parameters.utm_campaign" },
+  { source: "data.utm_parameters.fbclid", target: "utm_parameters.fbclid" },
+  { source: "data.customer.shipping_address.city", target: "shipping_address.city" },
+  { source: "data.customer.shipping_address.province", target: "shipping_address.province" },
+  { source: "data.customer.shipping_address.zip", target: "shipping_address.zip" },
+  { source: "data.customer.shipping_address.country", target: "shipping_address.country" }
+];
+var editableFields9 = [
+  { group: "Checkout", path: "data.cart_id", label: "Cart id" },
+  { group: "Checkout", path: "data.cart_token", label: "Cart token" },
+  { group: "Checkout", path: "data.abandoned_checkout_url", label: "Checkout URL", hint: "the link the shopper is sent back to" },
+  { group: "Checkout", path: "data.store_url", label: "Store domain", hint: "the cart link is built from this" },
+  { group: "Checkout", path: "data.platform", label: "Platform" },
+  { group: "Pricing", path: "data.total_price", label: "Total price", type: "number" },
+  { group: "Pricing", path: "data.original_total_price", label: "Original total", type: "number" },
+  { group: "Pricing", path: "data.total_discount", label: "Discount", type: "number" },
+  { group: "Customer", path: "data.customer.first_name", label: "First name" },
+  { group: "Customer", path: "data.customer.last_name", label: "Last name" },
+  { group: "Customer", path: "data.email", label: "Email" },
+  { group: "Customer", path: "data.phone", label: "Phone" },
+  { group: "Shipping", path: "data.customer.shipping_address.address1", label: "Address line 1" },
+  { group: "Shipping", path: "data.customer.shipping_address.city", label: "City" },
+  { group: "Shipping", path: "data.customer.shipping_address.province", label: "State" },
+  { group: "Shipping", path: "data.customer.shipping_address.zip", label: "Zip / postcode" },
+  { group: "Shipping", path: "data.customer.shipping_address.country_code", label: "Country code", hint: "region used to parse the phone" },
+  { group: "Attribution", path: "data.utm_parameters.utm_source", label: "UTM source" },
+  { group: "Attribution", path: "data.utm_parameters.utm_campaign", label: "UTM campaign" },
+  { group: "Attribution", path: "data.utm_parameters.fbclid", label: "FBCLID" }
+];
+function buildPayload9(ctx) {
+  const { config, items, phone } = ctx;
+  const now = ctx.now ?? /* @__PURE__ */ new Date();
+  const domain = config.shopify.domain;
+  const cust = config.customer;
+  const utm = config.defaults.utm ?? {};
+  const lineItems = (items ?? []).map(({ product, variant, quantity }) => ({
+    product_id: String(product.id),
+    variant_id: String(variant?.id ?? ""),
+    sku: variant?.sku || "",
+    price: money2(variant?.price ?? 0),
+    quantity,
+    gram: 200,
+    title: `${product.title}${variant?.title ? ` - ${variant.title}` : ""}`
+  }));
+  const subtotal = money2(lineItems.reduce((sum, li) => sum + li.price * li.quantity, 0));
+  const discount = money2(Math.min(ctx.discount ?? 0, subtotal));
+  const total = money2(subtotal - discount);
+  const cartToken = ctx.cartToken ?? `ec-${now.getTime()}`;
+  const shippingAddress = {
+    first_name: cust.firstName,
+    last_name: cust.lastName,
+    address1: cust.address1,
+    address2: "",
+    city: cust.city,
+    province: cust.province,
+    country: cust.country,
+    zip: cust.zip,
+    phone,
+    name: `${cust.firstName} ${cust.lastName}`.trim(),
+    province_code: cust.provinceCode ?? "",
+    country_code: cust.countryCode
+  };
+  return {
+    event: GATE_VALUE5,
+    data: {
+      cart_id: `cart_${now.getTime()}`,
+      store_url: domain,
+      platform: "SHOPIFY",
+      cart_token: cartToken,
+      email: cust.email,
+      phone,
+      abandoned_checkout_url: `https://${domain}/checkouts/${cartToken}`,
+      original_total_price: subtotal,
+      total_price: total,
+      total_discount: discount,
+      utm_parameters: {
+        fbclid: utm.fbclid ?? void 0,
+        utm_source: utm.utm_source ?? void 0,
+        utm_medium: utm.utm_medium ?? void 0,
+        utm_campaign: utm.utm_campaign ?? void 0,
+        utm_content: utm.utm_content ?? void 0,
+        utm_term: utm.utm_term ?? void 0
+      },
+      line_items: lineItems,
+      promotions: ctx.couponCode ? [{ code: ctx.couponCode, value: discount }] : [],
+      customer: {
+        email: cust.email,
+        first_name: cust.firstName,
+        last_name: cust.lastName,
+        shipping_address: shippingAddress
+      }
+    }
+  };
+}
+function sign9({ body, secret }) {
+  const signature = crypto4.createHmac("sha256", String(secret)).update(body).digest("base64");
+  return {
+    timestamp: null,
+    signature,
+    headers: {
+      "content-type": "application/json",
+      "x-webhook-signature": signature,
+      "x-webhook-topic": "abandonedCheckout",
+      "x-webhook-version": "v1",
+      "user-agent": "Ecom360-v1"
+    }
+  };
+}
+function webhookUrl9(config) {
+  return String(targetFor(config, "ecom360").webhookUrl ?? "").trim();
+}
+function webhookSecret9(config) {
+  return String(targetFor(config, "ecom360").webhookSecret ?? "");
+}
+function summarize9(payload) {
+  const d = payload?.data ?? {};
+  const items = Array.isArray(d.line_items) ? d.line_items : [];
+  const c2 = d.customer ?? {};
+  return {
+    event: "abandoned checkout",
+    store: d.store_url,
+    customer: `${c2.first_name ?? ""} ${c2.last_name ?? ""} \xB7 ${d.phone ?? ""}`.trim(),
+    items: items.map((i) => `${i.title} x${i.quantity}`).join(", "),
+    total: d.total_price,
+    currency: void 0,
+    extra: `platform ${d.platform}`,
+    link: d.abandoned_checkout_url
+  };
+}
+var ecom360_default = {
+  id: "ecom360",
+  urlKey: "ecom360",
+  label: "Ecom 360",
+  eventType: "ecom360_abandoned_checkout",
+  gate: { path: GATE_PATH6, value: GATE_VALUE5 },
+  signatureScheme: "base64 HMAC-SHA256 over the body",
+  signatureHeader: "x-webhook-signature",
+  fieldMap: fieldMap9,
+  editableFields: editableFields9,
+  buildPayload: buildPayload9,
+  sign: sign9,
+  webhookUrl: webhookUrl9,
+  webhookSecret: webhookSecret9,
+  summarize: summarize9
+};
+
 // src/providers/index.mjs
 var PROVIDER_META = [
   {
@@ -2311,6 +2730,20 @@ var PROVIDER_META = [
     signature: "none documented \u2014 every request is accepted",
     header: null,
     available: true
+  },
+  {
+    id: "gokwik",
+    label: "GoKwik",
+    signature: "none documented \u2014 every request is accepted",
+    header: null,
+    available: true
+  },
+  {
+    id: "ecom360",
+    label: "Ecom 360",
+    signature: "base64 HMAC-SHA256 over the body",
+    header: "x-webhook-signature",
+    available: true
   }
 ];
 var providers = {
@@ -2320,7 +2753,9 @@ var providers = {
   [shopflo_default.id]: shopflo_default,
   [flexype_default.id]: flexype_default,
   [return_prime_default.id]: return_prime_default,
-  [fastrr_default.id]: fastrr_default
+  [fastrr_default.id]: fastrr_default,
+  [gokwik_default.id]: gokwik_default,
+  [ecom360_default.id]: ecom360_default
 };
 function getProvider(id) {
   const provider = providers[id];
@@ -2980,8 +3415,8 @@ function resolveSource(payload, source) {
   }
   return void 0;
 }
-function coverage(payload, fieldMap8) {
-  return fieldMap8.map((f) => {
+function coverage(payload, fieldMap10) {
+  return fieldMap10.map((f) => {
     const value = resolveSource(payload, f.source);
     const present = value !== void 0 && value !== null && value !== "";
     return {
@@ -3146,7 +3581,7 @@ function applyEdits(payload, fields, edits) {
   }
   return payload;
 }
-async function buildPayload8({ cfg, providerId = "cashfree-occ", items = [], discount = 0, phone, checkImageUrls = true, payload: prebuilt, eventName, collection, envelope, live, delta }) {
+async function buildPayload10({ cfg, providerId = "cashfree-occ", items = [], discount = 0, phone, checkImageUrls = true, payload: prebuilt, eventName, collection, envelope, live, delta }) {
   const provider0 = getProvider(providerId);
   const needsItems = !provider0.selectionFor || ["cart", "product"].includes(provider0.selectionFor(eventName ?? provider0.defaultEvent));
   if (needsItems && !items.length) throw new ConfigError("no products selected");
@@ -3693,7 +4128,7 @@ function Build({ config, providerId = "cashfree-occ", onDone }) {
   const onDiscount = (raw) => startReview(Math.max(0, Number.parseFloat(raw) || 0));
   const finalise = (payload) => {
     setStep(STEP.BUILDING);
-    buildPayload8({ cfg: config, providerId, items, discount: draft.discount, payload, eventName, collection, live: draft.live, delta: draft.delta }).then(async (result) => {
+    buildPayload10({ cfg: config, providerId, items, discount: draft.discount, payload, eventName, collection, live: draft.live, delta: draft.delta }).then(async (result) => {
       setBuilt(result);
       let req = null;
       let command = "";
@@ -4964,7 +5399,7 @@ async function cmdBuild(args, config) {
     else if (live?.kind === "order") log.ok(`order ${live.name} (${live.id})`);
     else log.warn("no live record available \u2014 falling back to a generated one");
   }
-  const built = await buildPayload8({
+  const built = await buildPayload10({
     cfg: config,
     providerId,
     eventName,

package/package.json

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