@cronvello/shop-sdk 0.1.0 → 0.2.0

package/README.md

@@ -107,6 +107,40 @@ try {
 }
 ```
 
+## Is the contract still the right one?
+
+Pinning a version fixes *which* contract you compiled against. It does not tell you whether the
+node-shop you actually call still speaks it — and nothing else will: your types are green, your
+build is green, and the first thing that fails is a real request in production.
+
+`diagnoseShop()` closes that gap by asking the deployment itself:
+
+```ts
+import { diagnoseShop } from "@cronvello/shop-sdk";
+
+const report = await diagnoseShop({ client: shop }); // or { baseUrl }
+
+report.ok;               // true only when the match was VERIFIED
+report.contract.status;  // "match" | "drift" | "unknown"
+report.contract.sdk;     // hash this package was built against
+report.contract.live;    // hash the deployment reports
+report.sdkVersion;
+report.problems;         // plain sentences, empty when ok
+```
+
+`unknown` (offline, or a node-shop too old to serve `GET /health/contract`) is deliberately not
+`ok`. A green light that means "could not check" is the exact failure this exists to remove.
+
+It never throws for an operational reason — an unreachable shop is a result, not an exception — so
+it is safe to put behind your own health endpoint and let a monitor pull it:
+
+```ts
+export async function GET() {
+  const report = await diagnoseShop({ client: shop });
+  return Response.json(report, { status: report.ok ? 200 : 503 });
+}
+```
+
 ## Updating the contract
 
 node-shop remains the producer. From this repository, after regenerating node-shop's contract:

package/dist/browser.cjs

@@ -5272,7 +5272,7 @@ function createShopClient(options = {}) {
   const defaultTimeoutMs = options.timeoutMs ?? 3e4;
   const defaultRetries = options.retries ?? 2;
   const retryDelayMs = options.retryDelayMs ?? 250;
-  async function resolveBaseUrl() {
+  async function resolveBaseUrl2() {
     const value = typeof baseUrl === "function" ? await baseUrl() : baseUrl;
     return normalizeBaseUrl(value);
   }
@@ -5294,7 +5294,7 @@ function createShopClient(options = {}) {
     const body = hasBody ? JSON.stringify(values.body) : void 0;
     const retries = Math.max(0, requestOptions.retries ?? defaultRetries);
     const canRetry = SAFE_METHODS.has(route.method) || requestOptions.retryUnsafe === true;
-    const resolvedBaseUrl = await resolveBaseUrl();
+    const resolvedBaseUrl = await resolveBaseUrl2();
     for (let attempt = 0; ; attempt += 1) {
       const timeout = createRequestSignal(requestOptions.signal, requestOptions.timeoutMs ?? defaultTimeoutMs);
       try {
@@ -5371,6 +5371,102 @@ function createShopClient(options = {}) {
   return { baseUrl, request, requestText, requestRaw };
 }
 
+// src/contract-hash.ts
+var CONTRACT_SHA256 = "335eed391a2786a4f7f010b056d2a6a5b49d9e1244960a15516a5d77b93693b5";
+
+// src/client/diagnose.ts
+var SDK_VERSION = "0.2.0" ;
+async function resolveBaseUrl(options) {
+  const provider = options.client?.baseUrl ?? options.baseUrl ?? SHOP_API_URL;
+  const value = typeof provider === "function" ? await provider() : provider;
+  return normalizeBaseUrl(value);
+}
+async function diagnoseShop(options = {}) {
+  const checkedAt = (/* @__PURE__ */ new Date()).toISOString();
+  const baseUrl = await resolveBaseUrl(options);
+  const doFetch = options.fetch ?? globalThis.fetch;
+  const timeoutMs = options.timeoutMs ?? 5e3;
+  const base = {
+    ok: false,
+    baseUrl,
+    sdkVersion: SDK_VERSION,
+    reachable: false,
+    contract: { status: "unknown", sdk: CONTRACT_SHA256, live: null, files: null },
+    problems: [],
+    checkedAt
+  };
+  if (typeof doFetch !== "function") {
+    return { ...base, problems: ["No fetch implementation available; pass `fetch` explicitly."] };
+  }
+  const controller = new AbortController();
+  const onAbort = () => controller.abort(options.signal?.reason);
+  options.signal?.addEventListener("abort", onAbort, { once: true });
+  if (options.signal?.aborted) controller.abort(options.signal.reason);
+  const timer = setTimeout(() => controller.abort(new Error(`Contract probe timed out after ${timeoutMs}ms`)), timeoutMs);
+  let response;
+  try {
+    response = await doFetch(`${baseUrl}/health/contract`, {
+      method: "GET",
+      headers: { accept: "application/json" },
+      signal: controller.signal
+    });
+  } catch (error) {
+    const detail = error instanceof Error ? error.message : String(error);
+    return { ...base, problems: [`node-shop at ${baseUrl} could not be reached: ${detail}`] };
+  } finally {
+    clearTimeout(timer);
+    options.signal?.removeEventListener("abort", onAbort);
+  }
+  if (response.status === 404) {
+    return {
+      ...base,
+      reachable: true,
+      problems: [
+        `node-shop at ${baseUrl} does not serve GET /health/contract, so the contract cannot be verified. Deploy a node-shop that includes it.`
+      ]
+    };
+  }
+  if (!response.ok) {
+    return {
+      ...base,
+      reachable: true,
+      problems: [`node-shop at ${baseUrl} answered ${response.status} for GET /health/contract; contract not verified.`]
+    };
+  }
+  let body;
+  try {
+    body = await response.json();
+  } catch {
+    return { ...base, reachable: true, problems: [`node-shop at ${baseUrl} returned a non-JSON contract fingerprint.`] };
+  }
+  const live = typeof body.contractSha256 === "string" && body.contractSha256 ? body.contractSha256 : null;
+  const files = typeof body.files === "number" ? body.files : null;
+  if (!live) {
+    return {
+      ...base,
+      reachable: true,
+      contract: { ...base.contract, files },
+      problems: [`node-shop at ${baseUrl} could not compute its own contract fingerprint; contract not verified.`]
+    };
+  }
+  if (live !== CONTRACT_SHA256) {
+    return {
+      ...base,
+      reachable: true,
+      contract: { status: "drift", sdk: CONTRACT_SHA256, live, files },
+      problems: [
+        `Contract drift: node-shop at ${baseUrl} speaks ${live.slice(0, 12)}, @cronvello/shop-sdk ${SDK_VERSION} was built against ${CONTRACT_SHA256.slice(0, 12)}. Pin a newer SDK version, or deploy the node-shop the SDK was built from.`
+      ]
+    };
+  }
+  return {
+    ...base,
+    ok: true,
+    reachable: true,
+    contract: { status: "match", sdk: CONTRACT_SHA256, live, files }
+  };
+}
+
 // src/browser.ts
 function createShopBrowserClient(options = {}) {
   const configured = options.headers;
@@ -5387,9 +5483,11 @@ function createShopBrowserClient(options = {}) {
   });
 }
 
+exports.CONTRACT_SHA256 = CONTRACT_SHA256;
 exports.SHOP_API_URL = SHOP_API_URL;
 exports.ShopApiError = ShopApiError;
 exports.ShopConfigurationError = ShopConfigurationError;
 exports.createShopBrowserClient = createShopBrowserClient;
+exports.diagnoseShop = diagnoseShop;
 //# sourceMappingURL=browser.cjs.map
 //# sourceMappingURL=browser.cjs.map