@drawbridge/drawbridge-utils 0.0.165 → 0.0.167

package/dist/sendgrid.cjs

@@ -116,6 +116,7 @@ var sendgridRequest = ({ apiKey, body, method, path, query, request: request2 =
 var dnsRows = (dns) => Object.values(dns || {}).filter((row) => (row == null ? void 0 : row.host) && (row == null ? void 0 : row.type)).map((row) => ({
   data: String(row.data ?? ""),
   host: String(row.host),
+  reason: row.reason ? String(row.reason) : null,
   type: String(row.type),
   valid: typeof row.valid === "boolean" ? row.valid : null
 }));
@@ -141,14 +142,27 @@ var domain = {
   // Asks SendGrid to look the records up now. `records` carries per-record
   // validity so a UI can say WHICH record has not landed rather than only that
   // something has not; `valid` is the whole domain's verdict.
+  //
+  // TWO CALLS, because SendGrid splits the answer. POST …/validate is what
+  // makes it look DNS up now, and it answers per KEY with only `valid` and
+  // `reason` — no host, type or data (docs: validation_results.mail_cname /
+  // dkim1 / dkim2 / spf, each { valid, reason }). The rows themselves live on
+  // the domain, GET …/domains/:id, keyed the same way with host/type/data
+  // (and a `valid` of its own, which the validate verdict overrides). Feeding
+  // validation_results straight to dnsRows filtered every entry out for want
+  // of a host, so this returned `records : []` and no check ever updated a
+  // record — the verdicts on screen were the ones from registration.
   validate: async ({ apiKey, reference, via = sendgridRequest }) => {
-    const result = await via({
-      apiKey,
-      method: "POST",
-      path: "/v3/whitelabel/domains/" + encodeURIComponent(reference) + "/validate"
-    });
+    const path = "/v3/whitelabel/domains/" + encodeURIComponent(reference);
+    const result = await via({ apiKey, method: "POST", path: path + "/validate" });
+    const doc = await via({ apiKey, method: "GET", path });
+    const verdicts = (result == null ? void 0 : result.validation_results) || {};
+    const merged = Object.fromEntries(Object.entries((doc == null ? void 0 : doc.dns) || {}).map(([key, row]) => [
+      key,
+      { ...row, ...verdicts[key] && { reason: verdicts[key].reason, valid: verdicts[key].valid } }
+    ]));
     return {
-      records: dnsRows(result == null ? void 0 : result.validation_results),
+      records: dnsRows(merged),
       valid: Boolean(result == null ? void 0 : result.valid)
     };
   }

package/dist/sendgrid.d.cts

@@ -115,11 +115,20 @@ const sendgridRequest = ({ apiKey, body, method, path, query, request: request$1
 // flattened to the rows the identity schema stores — the UI then renders
 // whatever came back instead of naming roles it would have to keep in step
 // with.
+//
+// `reason` is SendGrid's own sentence for a record that does not validate —
+// "Expected your MX record to be … but found …" — and null when it does. It
+// is what tells a merchant their VALUE is wrong (a typo, a proxied CNAME)
+// rather than that DNS is still propagating, so it is kept verbatim and shown
+// beside the record. Never classified: the docs define it only as a
+// description, and a badge that pattern-matched vendor prose would be right
+// until a sentence changed.
 const dnsRows = ( dns ) => Object.values( dns || {} )
 	.filter( ( row ) => row?.host && row?.type )
 	.map( ( row ) => ({
 		data : String( row.data ?? '' ),
 		host : String( row.host ),
+		reason : row.reason ? String( row.reason ) : null,
 		type : String( row.type ),
 		valid : typeof row.valid === 'boolean' ? row.valid : null
 	}) );
@@ -160,16 +169,33 @@ const domain = {
 	// Asks SendGrid to look the records up now. `records` carries per-record
 	// validity so a UI can say WHICH record has not landed rather than only that
 	// something has not; `valid` is the whole domain's verdict.
+	//
+	// TWO CALLS, because SendGrid splits the answer. POST …/validate is what
+	// makes it look DNS up now, and it answers per KEY with only `valid` and
+	// `reason` — no host, type or data (docs: validation_results.mail_cname /
+	// dkim1 / dkim2 / spf, each { valid, reason }). The rows themselves live on
+	// the domain, GET …/domains/:id, keyed the same way with host/type/data
+	// (and a `valid` of its own, which the validate verdict overrides). Feeding
+	// validation_results straight to dnsRows filtered every entry out for want
+	// of a host, so this returned `records : []` and no check ever updated a
+	// record — the verdicts on screen were the ones from registration.
 	validate : async ({ apiKey, reference, via = sendgridRequest }) => {
 
-		const result = await via({
-			apiKey,
-			method : 'POST',
-			path : '/v3/whitelabel/domains/' + encodeURIComponent( reference ) + '/validate'
-		});
+		const path = '/v3/whitelabel/domains/' + encodeURIComponent( reference );
+
+		const result = await via({ apiKey, method : 'POST', path : path + '/validate' });
+		const doc = await via({ apiKey, method : 'GET', path });
+
+		const verdicts = result?.validation_results || {};
+
+		// `spf` has a verdict but no row; the host/type filter in dnsRows drops it.
+		const merged = Object.fromEntries( Object.entries( doc?.dns || {} ).map( ( [ key, row ] ) => [
+			key,
+			{ ...row, ...( verdicts[ key ] && { reason : verdicts[ key ].reason, valid : verdicts[ key ].valid } ) }
+		] ) );
 
 		return {
-			records : dnsRows( result?.validation_results ),
+			records : dnsRows( merged ),
 			valid : Boolean( result?.valid )
 		};
 

package/dist/sendgrid.d.ts

@@ -115,11 +115,20 @@ const sendgridRequest = ({ apiKey, body, method, path, query, request: request$1
 // flattened to the rows the identity schema stores — the UI then renders
 // whatever came back instead of naming roles it would have to keep in step
 // with.
+//
+// `reason` is SendGrid's own sentence for a record that does not validate —
+// "Expected your MX record to be … but found …" — and null when it does. It
+// is what tells a merchant their VALUE is wrong (a typo, a proxied CNAME)
+// rather than that DNS is still propagating, so it is kept verbatim and shown
+// beside the record. Never classified: the docs define it only as a
+// description, and a badge that pattern-matched vendor prose would be right
+// until a sentence changed.
 const dnsRows = ( dns ) => Object.values( dns || {} )
 	.filter( ( row ) => row?.host && row?.type )
 	.map( ( row ) => ({
 		data : String( row.data ?? '' ),
 		host : String( row.host ),
+		reason : row.reason ? String( row.reason ) : null,
 		type : String( row.type ),
 		valid : typeof row.valid === 'boolean' ? row.valid : null
 	}) );
@@ -160,16 +169,33 @@ const domain = {
 	// Asks SendGrid to look the records up now. `records` carries per-record
 	// validity so a UI can say WHICH record has not landed rather than only that
 	// something has not; `valid` is the whole domain's verdict.
+	//
+	// TWO CALLS, because SendGrid splits the answer. POST …/validate is what
+	// makes it look DNS up now, and it answers per KEY with only `valid` and
+	// `reason` — no host, type or data (docs: validation_results.mail_cname /
+	// dkim1 / dkim2 / spf, each { valid, reason }). The rows themselves live on
+	// the domain, GET …/domains/:id, keyed the same way with host/type/data
+	// (and a `valid` of its own, which the validate verdict overrides). Feeding
+	// validation_results straight to dnsRows filtered every entry out for want
+	// of a host, so this returned `records : []` and no check ever updated a
+	// record — the verdicts on screen were the ones from registration.
 	validate : async ({ apiKey, reference, via = sendgridRequest }) => {
 
-		const result = await via({
-			apiKey,
-			method : 'POST',
-			path : '/v3/whitelabel/domains/' + encodeURIComponent( reference ) + '/validate'
-		});
+		const path = '/v3/whitelabel/domains/' + encodeURIComponent( reference );
+
+		const result = await via({ apiKey, method : 'POST', path : path + '/validate' });
+		const doc = await via({ apiKey, method : 'GET', path });
+
+		const verdicts = result?.validation_results || {};
+
+		// `spf` has a verdict but no row; the host/type filter in dnsRows drops it.
+		const merged = Object.fromEntries( Object.entries( doc?.dns || {} ).map( ( [ key, row ] ) => [
+			key,
+			{ ...row, ...( verdicts[ key ] && { reason : verdicts[ key ].reason, valid : verdicts[ key ].valid } ) }
+		] ) );
 
 		return {
-			records : dnsRows( result?.validation_results ),
+			records : dnsRows( merged ),
 			valid : Boolean( result?.valid )
 		};
 

package/dist/sendgrid.js

@@ -87,6 +87,7 @@ var sendgridRequest = ({ apiKey, body, method, path, query, request: request2 =
 var dnsRows = (dns) => Object.values(dns || {}).filter((row) => (row == null ? void 0 : row.host) && (row == null ? void 0 : row.type)).map((row) => ({
   data: String(row.data ?? ""),
   host: String(row.host),
+  reason: row.reason ? String(row.reason) : null,
   type: String(row.type),
   valid: typeof row.valid === "boolean" ? row.valid : null
 }));
@@ -112,14 +113,27 @@ var domain = {
   // Asks SendGrid to look the records up now. `records` carries per-record
   // validity so a UI can say WHICH record has not landed rather than only that
   // something has not; `valid` is the whole domain's verdict.
+  //
+  // TWO CALLS, because SendGrid splits the answer. POST …/validate is what
+  // makes it look DNS up now, and it answers per KEY with only `valid` and
+  // `reason` — no host, type or data (docs: validation_results.mail_cname /
+  // dkim1 / dkim2 / spf, each { valid, reason }). The rows themselves live on
+  // the domain, GET …/domains/:id, keyed the same way with host/type/data
+  // (and a `valid` of its own, which the validate verdict overrides). Feeding
+  // validation_results straight to dnsRows filtered every entry out for want
+  // of a host, so this returned `records : []` and no check ever updated a
+  // record — the verdicts on screen were the ones from registration.
   validate: async ({ apiKey, reference, via = sendgridRequest }) => {
-    const result = await via({
-      apiKey,
-      method: "POST",
-      path: "/v3/whitelabel/domains/" + encodeURIComponent(reference) + "/validate"
-    });
+    const path = "/v3/whitelabel/domains/" + encodeURIComponent(reference);
+    const result = await via({ apiKey, method: "POST", path: path + "/validate" });
+    const doc = await via({ apiKey, method: "GET", path });
+    const verdicts = (result == null ? void 0 : result.validation_results) || {};
+    const merged = Object.fromEntries(Object.entries((doc == null ? void 0 : doc.dns) || {}).map(([key, row]) => [
+      key,
+      { ...row, ...verdicts[key] && { reason: verdicts[key].reason, valid: verdicts[key].valid } }
+    ]));
     return {
-      records: dnsRows(result == null ? void 0 : result.validation_results),
+      records: dnsRows(merged),
       valid: Boolean(result == null ? void 0 : result.valid)
     };
   }

package/package.json

@@ -226,5 +226,5 @@
     "prepublishOnly": ". \"$HOME/.nvm/nvm.sh\" && nvm use && tsup && node --test"
   },
   "types": "dist/index.d.ts",
-  "version": "0.0.165"
+  "version": "0.0.167"
 }