@drawbridge/drawbridge-utils 0.0.142 → 0.0.144

package/dist/connections/index.cjs

@@ -3366,6 +3366,26 @@ var toCanonicalEmail = (value) => {
   return local + "@" + domain;
 };
 
+// lib/encrypt.js
+var import_crypto = __toESM(require("crypto"), 1);
+var ALGORITHM = "aes-256-gcm";
+var getKey = () => Buffer.from(process.env.ENCRYPT_CONNECTION_SECRET, "hex");
+var decrypt = (value) => {
+  if (typeof value !== "string") return value;
+  const [ivHex, tagHex, dataHex] = value.split(":");
+  const decipher = import_crypto.default.createDecipheriv(
+    ALGORITHM,
+    getKey(),
+    Buffer.from(ivHex, "hex")
+  );
+  decipher.setAuthTag(Buffer.from(tagHex, "hex"));
+  const result = Buffer.concat([
+    decipher.update(Buffer.from(dataHex, "hex")),
+    decipher.final()
+  ]);
+  return JSON.parse(result.toString("utf8"));
+};
+
 // lib/slugify.js
 var import_slugify = __toESM(require("slugify"), 1);
 var slugify = (value, nochars = false) => {
@@ -3420,6 +3440,8 @@ var generateDiscountCode = (0, import_nanoid2.customAlphabet)("0123456789ABCDEFG
 var ORDER_EVENT_HANDLE = slugify("drawbridge-orders");
 var REFRESH_TOKEN_FRESHNESS_BUFFER_MS = 5 * 24 * 60 * 60 * 1e3;
 var OAUTH_ERROR_SOURCE = "oauth";
+var BILLING_ERROR_SOURCE = "billing";
+var BILLING_ERROR_MESSAGE = "Order billing isn't set up for this store \u2014 reselect and approve the plan from the Shopify connection page.";
 var OAUTH_GRANT_REVOKED_CODES = ["application_cannot_be_found", "invalid_grant"];
 var inbound = {
   headers: {
@@ -3940,6 +3962,9 @@ var shopify_default2 = {
           }
         }
         const billable = (org == null ? void 0 : org.billingProvider) === "shopify" && fee > 0 && !backfill;
+        const providerRow = billable ? await read.get({ collection: "provider", query: { slug: "shopify" } }) : null;
+        const { orderEventHandle } = (providerRow == null ? void 0 : providerRow.settings) ? decrypt(providerRow.settings) : {};
+        const handle = typeof orderEventHandle === "string" && slugify(orderEventHandle) || ORDER_EVENT_HANDLE;
         if (billable && !((_f = connection2 == null ? void 0 : connection2.source) == null ? void 0 : _f.id)) {
           (_g = logger2 == null ? void 0 : logger2.error) == null ? void 0 : _g.call(logger2, new Error(
             "shopify.usage.billing.skipped on order " + orderId + ": " + Math.round(fee * 100) + " cents not billed \u2014 connection " + (connection2 == null ? void 0 : connection2.id) + " has no source.id"
@@ -3958,7 +3983,7 @@ var shopify_default2 = {
             // verify it against the transaction prefix and refuse a
             // drifted pair — idempotency keys are permanent, so a
             // mistraceable event can never be resent under its own key.
-            handle: ORDER_EVENT_HANDLE,
+            handle,
             idempotencyKey: String(orderId),
             orderDocId,
             orderId: String(orderId),
@@ -3968,7 +3993,7 @@ var shopify_default2 = {
             // here — the event handle plus the order id — and sent as the
             // event's `reference`. queue/usage.js stamps the same id onto
             // the order as billed.transaction.
-            transaction: ORDER_EVENT_HANDLE + "." + orderId,
+            transaction: handle + "." + orderId,
             value: Math.round(fee * 100)
           },
           name: "billing",
@@ -4112,7 +4137,7 @@ var shopify_default2 = {
       // against the ones the app now needs, and queues a webhook
       // reconciliation.
       health: async ({ connection: connection2, workflow }, { adminToken, logger: logger2, read, reconcileScopes, resolveSettings, rotateToken, shopify } = {}) => {
-        var _a, _b;
+        var _a, _b, _c;
         const request2 = {
           connectionId: workflow.connection,
           organizationId: workflow.organization,
@@ -4134,7 +4159,7 @@ var shopify_default2 = {
           const writes = [];
           let source = connection2.source || null;
           let sourceRepaired = false;
-          let metered = (source == null ? void 0 : source.metered) ?? null;
+          let metered;
           let shopCurrency = null;
           let billingProbeFailed = false;
           try {
@@ -4153,25 +4178,65 @@ var shopify_default2 = {
               domain: connection2.shop
             });
             if (subscriptions.length && subscriptions.every((subscription) => typeof subscription.metered === "boolean")) {
-              metered = subscriptions.some((subscription) => subscription.metered);
+              metered = ((_a = subscriptions.find((subscription) => subscription.usageLineItemId)) == null ? void 0 : _a.usageLineItemId) || null;
             }
           } catch (probeError) {
             billingProbeFailed = true;
-            (_a = logger2 == null ? void 0 : logger2.warn) == null ? void 0 : _a.call(logger2, "shopify.health.billing.probe.failed", {
+            (_b = logger2 == null ? void 0 : logger2.warn) == null ? void 0 : _b.call(logger2, "shopify.health.billing.probe.failed", {
               connectionId: connection2.id,
               message: probeError == null ? void 0 : probeError.message,
               shop: connection2.shop
             });
           }
-          if (sourceRepaired || metered !== null && metered !== (((_b = connection2.source) == null ? void 0 : _b.metered) ?? null)) {
+          if (sourceRepaired || metered !== void 0 && metered !== (((_c = connection2.source) == null ? void 0 : _c.metered) ?? void 0)) {
+            writes.push({
+              collection: "connection",
+              data: {
+                $set: sourceRepaired ? { source: { ...source, ...metered !== void 0 && { metered } } } : { "source.metered": metered }
+              },
+              operation: "update",
+              query: { id: connection2.id }
+            });
+          }
+          const hasBillingIssue = (connection2.errors || []).some((entry) => entry.source === BILLING_ERROR_SOURCE);
+          if (metered === null && !hasBillingIssue) {
+            writes.push({
+              collection: "connection",
+              data: {
+                $push: {
+                  errors: {
+                    message: BILLING_ERROR_MESSAGE,
+                    source: BILLING_ERROR_SOURCE
+                  }
+                }
+              },
+              operation: "update",
+              query: { id: connection2.id }
+            });
+          }
+          if (typeof metered === "string" && hasBillingIssue) {
             writes.push({
               collection: "connection",
               data: {
-                $set: sourceRepaired ? { source: { ...source, ...metered !== null && { metered } } } : { "source.metered": metered }
+                $pull: {
+                  errors: { source: BILLING_ERROR_SOURCE }
+                }
               },
               operation: "update",
               query: { id: connection2.id }
             });
+            writes.push({
+              collection: "connection",
+              data: {
+                $set: { status: "active" }
+              },
+              operation: "update",
+              query: {
+                id: connection2.id,
+                status: "error",
+                "errors.0": { $exists: false }
+              }
+            });
           }
           return {
             writes,
@@ -4187,11 +4252,12 @@ var shopify_default2 = {
               options: { jobId: "connection.update.register." + workflow.connection + "." + (0, import_node_crypto5.randomUUID)() },
               queue: "connection"
             }],
-            message: ((scopesMissing == null ? void 0 : scopesMissing.length) ? "Health check: ping ok, webhooks reconciled \u2014 connection errored, granted scopes are missing: " + scopesMissing.join(", ") + "." : refreshTokenRotated ? "Health check passed \u2014 refresh token rotated, ping ok, webhooks reconciled." : "Health check passed \u2014 ping ok, webhooks reconciled.") + (sourceRepaired ? " Billing source repaired from the live shop." : "") + (metered === false ? " No usage line on the store's approved plan \u2014 order billing needs the merchant to approve the updated plan." : ""),
+            message: ((scopesMissing == null ? void 0 : scopesMissing.length) ? "Health check: ping ok, webhooks reconciled \u2014 connection errored, granted scopes are missing: " + scopesMissing.join(", ") + "." : refreshTokenRotated ? "Health check passed \u2014 refresh token rotated, ping ok, webhooks reconciled." : "Health check passed \u2014 ping ok, webhooks reconciled.") + (sourceRepaired ? " Billing source repaired from the live shop." : "") + (metered === null ? " No usage line on the store's approved plan \u2014 order billing needs the merchant to approve the updated plan." : ""),
             request: request2,
             response: {
               billingProbeFailed,
-              metered,
+              metered: metered ?? null,
+              meterProbed: metered !== void 0,
               pingedAt: /* @__PURE__ */ new Date(),
               refreshTokenExpiresAt: refreshTokenExpiresAt || null,
               refreshTokenRotated,
@@ -4336,7 +4402,15 @@ var shopify_default2 = {
       { input: "text", key: "apiKey", credential: "SHOPIFY_API_KEY", label: "API key", required: true },
       { input: "password", key: "apiSecret", credential: "SHOPIFY_API_SECRET", label: "API secret", redact: true, required: true },
       { input: "text", key: "appHandle", credential: "SHOPIFY_APP_HANDLE", label: "App handle", required: true },
-      { input: "text", key: "listingUrl", credential: "SHOPIFY_APP_LISTING_URL", label: "App listing URL", required: true }
+      { input: "text", key: "listingUrl", credential: "SHOPIFY_APP_LISTING_URL", label: "App listing URL", required: true },
+      // The usage meter's event handle, when the plan config's meter ever
+      // changes: stored value overrides the built-in default
+      // (events.order.handle) at the mint point, and `format : 'slug'`
+      // normalizes it on save — a handle can carry no spaces or capitals,
+      // and classification against it is case-sensitive. Optional: empty
+      // means the default, and the sender still refuses any handle that
+      // disagrees with the transaction it minted.
+      { format: "slug", input: "text", key: "orderEventHandle", label: "Order event handle", required: false, setting: true }
     ]
   },
   // A pre-launch integration: it only surfaces once the App Store listing
@@ -4478,20 +4552,24 @@ var shopify_default2 = {
       ...(data2 == null ? void 0 : data2.status) === "pending" ? [
         {
           action: "billing",
-          message: "Approve the Drawbridge plan to activate this connection. You'll confirm the pricing on Shopify, then everything else happens here.",
-          title: "Approve your plan"
+          message: "Approve the Drawbridge plan to activate this connection. You'll be asked to select a plan on Shopify, then everything else happens here.",
+          title: "Approve your plan",
+          type: "warning"
         }
       ] : [],
       // The store's ACTIVE approval carries no usage component — stamped by
-      // the daily health check and the approval webhook (`source.metered`).
-      // Approved pricing is never retroactive, so the fix is a fresh approval.
-      // Gated on an EXPLICIT false — a connection the probe hasn't reached
-      // (or couldn't read) shows nothing rather than nagging on silence.
-      ...(data2 == null ? void 0 : data2.status) === "active" && ((_a = data2 == null ? void 0 : data2.source) == null ? void 0 : _a.metered) === false ? [
+      // the daily health check and the approval webhook (`source.metered`:
+      // the usage line's id when present, null when probed-and-absent).
+      // Approved pricing is never retroactive, so the fix is a fresh
+      // approval. Gated on an EXPLICIT null — a connection the probe hasn't
+      // reached (or couldn't read) has no key and shows nothing rather than
+      // nagging on silence.
+      ...(data2 == null ? void 0 : data2.status) === "active" && ((_a = data2 == null ? void 0 : data2.source) == null ? void 0 : _a.metered) === null ? [
         {
           action: "billing",
-          message: "Order billing isn't set up for this store, so campaign-attributed orders aren't being charged. Approve the updated plan to fix it \u2014 one click here, one confirmation on Shopify.",
-          title: "Fix order billing"
+          message: "Order billing isn't set up for this store, so campaign-attributed orders aren't being charged. You'll need to reselect your plan on Shopify and approve it to fix this.",
+          title: "Fix order billing",
+          type: "error"
         }
       ] : []
     ];

package/dist/connections/index.d.cts

@@ -7,6 +7,7 @@ import { channels } from '../pricing.cjs';
 import { customAlphabet } from 'nanoid';
 import { toCanonicalEmail } from '../email.cjs';
 import { conversionRate } from '../plans.cjs';
+import { decrypt } from '../encrypt.cjs';
 import { slugify } from '../slugify.cjs';
 import { safeRequest } from '../safe-http.cjs';
 import 'libphonenumber-js';
@@ -19,6 +20,8 @@ import '../index.cjs';
 import 'currency-codes';
 import '../color.cjs';
 import 'tinycolor2';
+import 'crypto';
+import '../token.cjs';
 import 'slugify';
 import 'dns';
 import 'node:http';
@@ -3869,6 +3872,13 @@ const REFRESH_TOKEN_FRESHNESS_BUFFER_MS = 5 * 24 * 60 * 60 * 1000;
 
 const OAUTH_ERROR_SOURCE = 'oauth';
 
+// The billing Issue a probed-unmetered store carries in its connection
+// errors, written and cleared beside the source.metered stamp (health check
+// and drawbridge-sync's approval restamp share the source tag). One string,
+// used by both writers, so the entries dedupe and $pull cleanly.
+const BILLING_ERROR_SOURCE = 'billing';
+const BILLING_ERROR_MESSAGE = 'Order billing isn\'t set up for this store — reselect and approve the plan from the Shopify connection page.';
+
 // What Shopify says when the merchant has uninstalled or revoked. Neither is
 // retryable and both mean the same thing to a merchant: reconnect.
 const OAUTH_GRANT_REVOKED_CODES = [ 'application_cannot_be_found', 'invalid_grant' ];
@@ -4592,6 +4602,22 @@ var shopify = {
 				// roll back.
 				const billable = org?.billingProvider === 'shopify' && fee > 0 && ! backfill;
 
+				// THE EFFECTIVE METER HANDLE. The provider row's orderEventHandle
+				// (admin-editable, for the day the plan config's meter changes)
+				// overrides the built-in default; slugified again on read as belt
+				// and braces with the save-side formatter, since a drifted stored
+				// value would mint transactions no meter classifies. Read directly
+				// (not via providerSettings — that module imports this one) and
+				// only for a billable order, which keeps the cost off every
+				// ordinary redemption.
+				const providerRow = billable
+					? await read.get({ collection : 'provider', query : { slug : 'shopify' } })
+					: null;
+
+				const { orderEventHandle } = providerRow?.settings ? decrypt( providerRow.settings ) : {};
+
+				const handle = ( typeof orderEventHandle === 'string' && slugify( orderEventHandle ) ) || ORDER_EVENT_HANDLE;
+
 				// A billable order with no shop id is revenue lost SILENTLY — the
 				// gate below just yields no job, the order records normally, and the
 				// connection looks healthy. An Error (not a warn) because this is
@@ -4622,7 +4648,7 @@ var shopify = {
 							// verify it against the transaction prefix and refuse a
 							// drifted pair — idempotency keys are permanent, so a
 							// mistraceable event can never be resent under its own key.
-							handle : ORDER_EVENT_HANDLE,
+							handle,
 							idempotencyKey : String( orderId ),
 							orderDocId,
 							orderId : String( orderId ),
@@ -4632,7 +4658,7 @@ var shopify = {
 							// here — the event handle plus the order id — and sent as the
 							// event's `reference`. queue/usage.js stamps the same id onto
 							// the order as billed.transaction.
-							transaction : ORDER_EVENT_HANDLE + '.' + orderId,
+							transaction : handle + '.' + orderId,
 							value : Math.round( fee * 100 )
 						},
 						name : 'billing',
@@ -4866,14 +4892,18 @@ var shopify = {
 					// holds a live admin token, so a missing source is one lookup away
 					// from fixed.
 					//
-					// `metered` rides on the same pass: whether the merchant's ACTIVE
-					// approval carries a usage line item. A meter added to the app's
-					// pricing config is never retroactive — it bills only from the
-					// moment the merchant approves the plan version that carries it —
-					// so an approval with no usage line means every order's usage event
-					// is 202-accepted and silently never billed. Stamped on the
-					// connection so tasks() can tell the merchant to re-approve, and
-					// probed every run so a re-approval clears the card within a day.
+					// `metered` rides on the same pass: the usage LINE ITEM ID from the
+					// merchant's ACTIVE approval — an id is proof of WHICH approval
+					// carries the meter, where a boolean was only an assertion. Three
+					// states: a gid string (probed, usage line present), null (probed
+					// and absent — the unbillable state tasks() nags on), or no key at
+					// all (never probed — silence, never treated as evidence). A meter
+					// added to the app's pricing config is never retroactive — it
+					// bills only from the moment the merchant approves the plan
+					// version that carries it — so a null here means every order's
+					// usage event is 202-accepted and silently never billed. Probed
+					// every run, so a re-approval both clears the card within a day
+					// and refreshes the id it re-minted.
 					//
 					// Best-effort by design: the ping above already proved access, so a
 					// blip in either lookup must not error a healthy connection — the
@@ -4886,7 +4916,9 @@ var shopify = {
 
 					let source = connection.source || null;
 					let sourceRepaired = false;
-					let metered = source?.metered ?? null;
+					// undefined = no verdict this run; a string/null verdict comes
+					// only from a successful probe of an ACTIVE approval.
+					let metered;
 					let shopCurrency = null;
 					let billingProbeFailed = false;
 
@@ -4913,14 +4945,16 @@ var shopify = {
 
 						// Only an ACTIVE approval says anything about metering — no
 						// subscriptions (mid-install, plan pending) leaves the stamp
-						// untouched rather than asserting false from silence. The
+						// untouched rather than asserting null from silence. The
 						// every-boolean guard is version skew insurance: an older
-						// @drawbridge/shopify returns subscriptions without the flag,
-						// and reading that silence as false would nag every healthy
-						// merchant to re-approve a plan that is fine.
+						// @drawbridge/shopify returns subscriptions without the flag
+						// (and without usageLineItemId), and reading that silence as
+						// unmetered would nag every healthy merchant to re-approve a
+						// plan that is fine — the flag being boolean proves an SDK
+						// that also reports the line id.
 						if( subscriptions.length && subscriptions.every( ( subscription ) => typeof subscription.metered === 'boolean' ) ){
 
-							metered = subscriptions.some( ( subscription ) => subscription.metered );
+							metered = subscriptions.find( ( subscription ) => subscription.usageLineItemId )?.usageLineItemId || null;
 
 						}
 
@@ -4936,13 +4970,16 @@ var shopify = {
 
 					}
 
-					if( sourceRepaired || ( metered !== null && metered !== ( connection.source?.metered ?? null ) ) ){
+					// A verdict writes only when it CHANGES the stored one — the daily
+					// run stays idempotent, and undefined (no verdict) never touches
+					// the stamp.
+					if( sourceRepaired || ( metered !== undefined && metered !== ( connection.source?.metered ?? undefined ) ) ){
 
 						writes.push({
 							collection : 'connection',
 							data : {
 								$set : sourceRepaired
-									? { source : { ...source, ...( metered !== null && { metered }) } }
+									? { source : { ...source, ...( metered !== undefined && { metered }) } }
 									: { 'source.metered' : metered }
 							},
 							operation : 'update',
@@ -4951,6 +4988,63 @@ var shopify = {
 
 					}
 
+					// THE ISSUE MARKER rides beside the stamp: a probed-unmetered
+					// store carries a billing entry in the connection's own errors —
+					// the Issues surface a merchant already knows — and a metered
+					// verdict clears it. Keyed on PRESENCE rather than the verdict
+					// changing, so a connection stamped before this writer existed
+					// still gains its entry on the next run. Status is deliberately
+					// untouched on the way in (orders must keep recording), and the
+					// way out mirrors the resume idiom: reactivate only a connection
+					// that is errored with nothing else wrong.
+					const hasBillingIssue = ( connection.errors || [] ).some( ( entry ) => entry.source === BILLING_ERROR_SOURCE );
+
+					if( metered === null && ! hasBillingIssue ){
+
+						writes.push({
+							collection : 'connection',
+							data : {
+								$push : {
+									errors : {
+										message : BILLING_ERROR_MESSAGE,
+										source : BILLING_ERROR_SOURCE
+									}
+								}
+							},
+							operation : 'update',
+							query : { id : connection.id }
+						});
+
+					}
+
+					if( typeof metered === 'string' && hasBillingIssue ){
+
+						writes.push({
+							collection : 'connection',
+							data : {
+								$pull : {
+									errors : { source : BILLING_ERROR_SOURCE }
+								}
+							},
+							operation : 'update',
+							query : { id : connection.id }
+						});
+
+						writes.push({
+							collection : 'connection',
+							data : {
+								$set : { status : 'active' }
+							},
+							operation : 'update',
+							query : {
+								id : connection.id,
+								status : 'error',
+								'errors.0' : { $exists : false }
+							}
+						});
+
+					}
+
 					return {
 						writes,
 						enqueues : [ {
@@ -4972,11 +5066,12 @@ var shopify = {
 								: 'Health check passed — ping ok, webhooks reconciled.'
 						)
 							+ ( sourceRepaired ? ' Billing source repaired from the live shop.' : '' )
-							+ ( metered === false ? ' No usage line on the store\'s approved plan — order billing needs the merchant to approve the updated plan.' : '' ),
+							+ ( metered === null ? ' No usage line on the store\'s approved plan — order billing needs the merchant to approve the updated plan.' : '' ),
 						request,
 						response : {
 							billingProbeFailed,
-							metered,
+							metered : metered ?? null,
+							meterProbed : metered !== undefined,
 							pingedAt : new Date(),
 							refreshTokenExpiresAt : refreshTokenExpiresAt || null,
 							refreshTokenRotated,
@@ -5162,7 +5257,15 @@ var shopify = {
 			{ input : 'text', key : 'apiKey', credential : 'SHOPIFY_API_KEY', label : 'API key', required : true },
 			{ input : 'password', key : 'apiSecret', credential : 'SHOPIFY_API_SECRET', label : 'API secret', redact : true, required : true },
 			{ input : 'text', key : 'appHandle', credential : 'SHOPIFY_APP_HANDLE', label : 'App handle', required : true },
-			{ input : 'text', key : 'listingUrl', credential : 'SHOPIFY_APP_LISTING_URL', label : 'App listing URL', required : true }
+			{ input : 'text', key : 'listingUrl', credential : 'SHOPIFY_APP_LISTING_URL', label : 'App listing URL', required : true },
+			// The usage meter's event handle, when the plan config's meter ever
+			// changes: stored value overrides the built-in default
+			// (events.order.handle) at the mint point, and `format : 'slug'`
+			// normalizes it on save — a handle can carry no spaces or capitals,
+			// and classification against it is case-sensitive. Optional: empty
+			// means the default, and the sender still refuses any handle that
+			// disagrees with the transaction it minted.
+			{ format : 'slug', input : 'text', key : 'orderEventHandle', label : 'Order event handle', required : false, setting : true }
 		]
 	},
 	// A pre-launch integration: it only surfaces once the App Store listing
@@ -5314,23 +5417,27 @@ var shopify = {
 			? [
 				{
 					action : 'billing',
-					message : 'Approve the Drawbridge plan to activate this connection. You\'ll confirm the pricing on Shopify, then everything else happens here.',
-					title : 'Approve your plan'
+					message : 'Approve the Drawbridge plan to activate this connection. You\'ll be asked to select a plan on Shopify, then everything else happens here.',
+					title : 'Approve your plan',
+					type : 'warning'
 				}
 			]
 			: []
 		),
 		// The store's ACTIVE approval carries no usage component — stamped by
-		// the daily health check and the approval webhook (`source.metered`).
-		// Approved pricing is never retroactive, so the fix is a fresh approval.
-		// Gated on an EXPLICIT false — a connection the probe hasn't reached
-		// (or couldn't read) shows nothing rather than nagging on silence.
-		...( data?.status === 'active' && data?.source?.metered === false
+		// the daily health check and the approval webhook (`source.metered`:
+		// the usage line's id when present, null when probed-and-absent).
+		// Approved pricing is never retroactive, so the fix is a fresh
+		// approval. Gated on an EXPLICIT null — a connection the probe hasn't
+		// reached (or couldn't read) has no key and shows nothing rather than
+		// nagging on silence.
+		...( data?.status === 'active' && data?.source?.metered === null
 			? [
 				{
 					action : 'billing',
-					message : 'Order billing isn\'t set up for this store, so campaign-attributed orders aren\'t being charged. Approve the updated plan to fix it — one click here, one confirmation on Shopify.',
-					title : 'Fix order billing'
+					message : 'Order billing isn\'t set up for this store, so campaign-attributed orders aren\'t being charged. You\'ll need to reselect your plan on Shopify and approve it to fix this.',
+					title : 'Fix order billing',
+					type : 'error'
 				}
 			]
 			: []