@cronvello/shop-sdk 0.1.0 → 0.2.2

package/dist/openapi.json

@@ -30672,6 +30672,141 @@
         "x-transport": "https"
       }
     },
+    "/external-apps/service/rotate-key/:appId": {
+      "post": {
+        "operationId": "external_apps_service_rotate_key",
+        "tags": [
+          "external-apps"
+        ],
+        "summary": "Rotate external app api key (B2B zero-downtime)",
+        "description": "Rotates the API key of an external app. The previous key remains valid during the specified gracePeriodHours (default: 2h) to prevent downtime during deployments. Authenticated via backend-to-backend API key.",
+        "responses": {
+          "200": {
+            "description": "JSON response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "success": {
+                      "type": "boolean"
+                    },
+                    "message": {
+                      "anyOf": [
+                        {
+                          "type": "string"
+                        },
+                        {
+                          "type": "null"
+                        }
+                      ]
+                    },
+                    "data": {
+                      "anyOf": [
+                        {
+                          "type": "object",
+                          "properties": {
+                            "appId": {
+                              "type": "string"
+                            },
+                            "name": {
+                              "type": "string"
+                            },
+                            "newApiKey": {
+                              "type": "string"
+                            },
+                            "previousApiKeyMasked": {
+                              "anyOf": [
+                                {
+                                  "type": "string"
+                                },
+                                {
+                                  "type": "null"
+                                }
+                              ]
+                            },
+                            "previousApiKeyExpiresAt": {
+                              "anyOf": [
+                                {
+                                  "type": "string"
+                                },
+                                {
+                                  "type": "null"
+                                }
+                              ]
+                            },
+                            "gracePeriodHours": {
+                              "type": "number"
+                            }
+                          },
+                          "required": [
+                            "appId",
+                            "name",
+                            "newApiKey",
+                            "previousApiKeyMasked",
+                            "previousApiKeyExpiresAt",
+                            "gracePeriodHours"
+                          ],
+                          "additionalProperties": false
+                        },
+                        {
+                          "type": "null"
+                        }
+                      ]
+                    }
+                  },
+                  "required": [
+                    "success",
+                    "data"
+                  ],
+                  "additionalProperties": false
+                }
+              }
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "appId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "minLength": 1
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "newApiKey": {
+                    "type": "string",
+                    "minLength": 8
+                  },
+                  "gracePeriodHours": {
+                    "type": "number",
+                    "minimum": 0.1,
+                    "maximum": 168,
+                    "default": 2
+                  }
+                },
+                "additionalProperties": false
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "xApiKey": []
+          }
+        ],
+        "x-transport": "https"
+      }
+    },
     "/external-apps/service/delete/:appId": {
       "delete": {
         "operationId": "external_apps_service_delete",
@@ -30748,7 +30883,7 @@
           "external-apps"
         ],
         "summary": "Get external app registration status (B2B)",
-        "description": "Returns registration status for an app identified by its string appId. Used by AMP to discover existing connections.",
+        "description": "Returns registration status for an app identified by its string appId. Used by AMP to discover existing connections. Includes authMethod and, for OAuth apps, the oauth client_id we will present to that app plus a truncated SHA-256 fingerprint of the stored client secret, so the other side can prove a rotation actually landed here. Never the secret itself. Also reports the entitlement paths we have stored, because registration is an upsert: a caller that only wants to hand us new credentials must send these back unchanged, or it silently repoints where we fetch entitlements from.",
         "responses": {
           "200": {
             "description": "JSON response",
@@ -30803,6 +30938,56 @@
                                   "type": "null"
                                 }
                               ]
+                            },
+                            "authMethod": {
+                              "anyOf": [
+                                {
+                                  "type": "string"
+                                },
+                                {
+                                  "type": "null"
+                                }
+                              ]
+                            },
+                            "oauthClientId": {
+                              "anyOf": [
+                                {
+                                  "type": "string"
+                                },
+                                {
+                                  "type": "null"
+                                }
+                              ]
+                            },
+                            "oauthClientSecretFingerprint": {
+                              "anyOf": [
+                                {
+                                  "type": "string"
+                                },
+                                {
+                                  "type": "null"
+                                }
+                              ]
+                            },
+                            "entitlementPath": {
+                              "anyOf": [
+                                {
+                                  "type": "string"
+                                },
+                                {
+                                  "type": "null"
+                                }
+                              ]
+                            },
+                            "usageOveragePath": {
+                              "anyOf": [
+                                {
+                                  "type": "string"
+                                },
+                                {
+                                  "type": "null"
+                                }
+                              ]
                             }
                           },
                           "required": [
@@ -30810,7 +30995,12 @@
                             "isActive",
                             "isLive",
                             "lastFetchedAt",
-                            "lastFetchSuccess"
+                            "lastFetchSuccess",
+                            "authMethod",
+                            "oauthClientId",
+                            "oauthClientSecretFingerprint",
+                            "entitlementPath",
+                            "usageOveragePath"
                           ],
                           "additionalProperties": false
                         },
@@ -37402,7 +37592,7 @@
           "b2b"
         ],
         "summary": "Create B2B dynamic checkout session",
-        "description": "Creates a Stripe checkout session with dynamic price_data for trusted external apps. Supports mixed carts (one-time + recurring). Auth: Bearer BACKEND_TO_BACKEND_API_KEY.",
+        "description": "Creates a Stripe checkout session with dynamic price_data for trusted external apps. Supports mixed carts (one-time + recurring). Auth: Bearer BACKEND_TO_BACKEND_API_KEY or App-Scoped API Key.",
         "responses": {
           "200": {
             "description": "JSON response",

package/dist/server.cjs

@@ -498,7 +498,7 @@ var apiRoutes_b2b = {
     meta: {
       tags: ["b2b"],
       summary: "Create B2B dynamic checkout session",
-      description: "Creates a Stripe checkout session with dynamic price_data for trusted external apps. Supports mixed carts (one-time + recurring). Auth: Bearer BACKEND_TO_BACKEND_API_KEY.",
+      description: "Creates a Stripe checkout session with dynamic price_data for trusted external apps. Supports mixed carts (one-time + recurring). Auth: Bearer BACKEND_TO_BACKEND_API_KEY or App-Scoped API Key.",
       bodyContentType: "application/json",
       validated: { "params": false, "query": false, "body": true }
     },
@@ -1710,6 +1710,19 @@ var apiRoutes_external_apps = {
     },
     types: null
   },
+  "external_apps_service_rotate_key": {
+    method: "POST",
+    path: "/external-apps/service/rotate-key/:appId",
+    auth: { "type": "x_api_key_https" },
+    meta: {
+      tags: ["external-apps"],
+      summary: "Rotate external app api key (B2B zero-downtime)",
+      description: "Rotates the API key of an external app. The previous key remains valid during the specified gracePeriodHours (default: 2h) to prevent downtime during deployments. Authenticated via backend-to-backend API key.",
+      bodyContentType: "application/json",
+      validated: { "params": true, "query": true, "body": true }
+    },
+    types: null
+  },
   "external_apps_service_delete": {
     method: "DELETE",
     path: "/external-apps/service/delete/:appId",
@@ -1729,7 +1742,7 @@ var apiRoutes_external_apps = {
     meta: {
       tags: ["external-apps"],
       summary: "Get external app registration status (B2B)",
-      description: "Returns registration status for an app identified by its string appId. Used by AMP to discover existing connections."
+      description: "Returns registration status for an app identified by its string appId. Used by AMP to discover existing connections. Includes authMethod and, for OAuth apps, the oauth client_id we will present to that app plus a truncated SHA-256 fingerprint of the stored client secret, so the other side can prove a rotation actually landed here. Never the secret itself. Also reports the entitlement paths we have stored, because registration is an upsert: a caller that only wants to hand us new credentials must send these back unchanged, or it silently repoints where we fetch entitlements from."
     },
     types: null
   },
@@ -5272,7 +5285,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 +5307,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 +5384,102 @@ function createShopClient(options = {}) {
   return { baseUrl, request, requestText, requestRaw };
 }
 
+// src/contract-hash.ts
+var CONTRACT_SHA256 = "05f34929e71fb2fcb3a4c04707facca22ee46f8960a4cc47ce0a3f1a6df36056";
+
+// src/client/diagnose.ts
+var SDK_VERSION = "0.2.2" ;
+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/server.ts
 async function resolveSecret(provider) {
   const value = typeof provider === "function" ? await provider() : provider;
@@ -5431,10 +5540,12 @@ function createShopServerClientFromEnv(options = {}) {
   });
 }
 
+exports.CONTRACT_SHA256 = CONTRACT_SHA256;
 exports.SHOP_API_URL = SHOP_API_URL;
 exports.ShopApiError = ShopApiError;
 exports.ShopConfigurationError = ShopConfigurationError;
 exports.createShopServerClient = createShopServerClient;
 exports.createShopServerClientFromEnv = createShopServerClientFromEnv;
+exports.diagnoseShop = diagnoseShop;
 //# sourceMappingURL=server.cjs.map
 //# sourceMappingURL=server.cjs.map