@patchstack/connect 0.5.3 → 0.5.4

package/dist/protect.cjs

@@ -158,6 +158,46 @@ var init_types = __esm({
       }
       code;
       cause;
+      /**
+       * For a `VALIDATION_ERROR`, the request fields the server refused, as it named them. Read from the
+       * structured `errors` object a validation response carries, so a caller deciding what to do about a
+       * refusal keys on the field rather than on the wording of a sentence.
+       */
+      fields = [];
+    };
+  }
+});
+
+// src/hosting.ts
+function detectHostingPlatform(env = process.env) {
+  for (const rule of RULES) {
+    const evidence = rule.any.filter((name) => present(env, name));
+    if (evidence.length > 0) {
+      return { platform: rule.platform, evidence };
+    }
+  }
+  return { platform: null, evidence: [] };
+}
+var RULES, present;
+var init_hosting = __esm({
+  "src/hosting.ts"() {
+    "use strict";
+    RULES = [
+      { platform: "netlify", any: ["NETLIFY", "NETLIFY_BUILD_BASE", "DEPLOY_PRIME_URL"] },
+      { platform: "vercel", any: ["VERCEL", "VERCEL_ENV", "VERCEL_URL"] },
+      { platform: "cloudflare", any: ["CF_PAGES", "CF_PAGES_URL", "CLOUDFLARE_ACCOUNT_ID"] },
+      { platform: "aws", any: ["AWS_APP_ID", "AWS_LAMBDA_FUNCTION_NAME", "AWS_EXECUTION_ENV"] },
+      { platform: "render", any: ["RENDER", "RENDER_SERVICE_ID", "RENDER_EXTERNAL_URL"] },
+      { platform: "railway", any: ["RAILWAY_ENVIRONMENT", "RAILWAY_ENVIRONMENT_NAME", "RAILWAY_PROJECT_ID"] },
+      { platform: "fly", any: ["FLY_APP_NAME", "FLY_REGION", "FLY_ALLOC_ID"] },
+      { platform: "heroku", any: ["DYNO", "HEROKU_APP_NAME"] },
+      { platform: "google-cloud", any: ["K_SERVICE", "GAE_APPLICATION", "GAE_SERVICE"] },
+      { platform: "deno-deploy", any: ["DENO_DEPLOYMENT_ID"] },
+      { platform: "azure", any: ["WEBSITE_SITE_NAME", "WEBSITE_INSTANCE_ID"] }
+    ];
+    present = (env, name) => {
+      const value = env[name];
+      return value !== void 0 && value !== "";
     };
   }
 });
@@ -183,14 +223,22 @@ function authFailureMessage(status, config) {
   }
   return null;
 }
-function buildManifestBody(config, payload) {
+function buildManifestBody(config, payload, env = process.env) {
+  const hosting = config.environment === "local" ? null : detectHostingPlatform(env);
   return {
     ...payload,
     environment: config.environment,
     ...typeof config.siteUrl === "string" && config.siteUrl !== "" ? { url: config.siteUrl } : {},
-    ...typeof config.siteName === "string" && config.siteName !== "" ? { name: config.siteName } : {}
+    ...typeof config.siteName === "string" && config.siteName !== "" ? { name: config.siteName } : {},
+    ...hosting !== null && hosting.platform !== null ? { hosting } : {}
   };
 }
+function validationFields(body) {
+  if (typeof body !== "object" || body === null) return [];
+  const errors = body.errors;
+  if (typeof errors !== "object" || errors === null || Array.isArray(errors)) return [];
+  return Object.keys(errors);
+}
 async function postManifest(config, payload) {
   const url = buildEndpointUrl(config.endpoint, config.siteUuid);
   const timeoutMs = config.timeoutMs;
@@ -235,10 +283,12 @@ async function postManifest(config, payload) {
     );
   }
   if (response.status === 422) {
-    throw new PatchstackError(
+    const refused2 = new PatchstackError(
       body?.message ?? "Patchstack rejected the manifest payload (validation failed).",
       "VALIDATION_ERROR"
     );
+    refused2.fields = validationFields(body);
+    throw refused2;
   }
   const refused = authFailureMessage(response.status, config);
   if (refused !== null) {
@@ -266,6 +316,7 @@ var init_client = __esm({
   "src/client.ts"() {
     "use strict";
     init_types();
+    init_hosting();
     init_pulse_token();
     init_build_id();
     DEFAULT_ENDPOINT = "https://api.patchstack.com/monitor/pulse/manifest";
@@ -274,6 +325,54 @@ var init_client = __esm({
   }
 });
 
+// src/environment.ts
+function inferEnvironment(env = process.env) {
+  for (const discriminator of DISCRIMINATORS) {
+    const verdict = discriminator.read(env);
+    if (verdict !== null) {
+      return { environment: verdict.environment, evidence: [`${discriminator.platform}: ${verdict.evidence}`] };
+    }
+  }
+  return { environment: "local", evidence: [] };
+}
+var set, DISCRIMINATORS;
+var init_environment = __esm({
+  "src/environment.ts"() {
+    "use strict";
+    set = (value) => value !== void 0 && value !== "";
+    DISCRIMINATORS = [
+      {
+        platform: "vercel",
+        read: (env) => {
+          if (!set(env.VERCEL) || !set(env.VERCEL_ENV)) return null;
+          return env.VERCEL_ENV === "production" ? { environment: "production", evidence: "VERCEL_ENV=production" } : { environment: "sandbox", evidence: `VERCEL_ENV=${env.VERCEL_ENV}` };
+        }
+      },
+      {
+        platform: "netlify",
+        read: (env) => {
+          if (env.NETLIFY !== "true" || !set(env.CONTEXT)) return null;
+          return env.CONTEXT === "production" ? { environment: "production", evidence: "CONTEXT=production" } : { environment: "sandbox", evidence: `CONTEXT=${env.CONTEXT}` };
+        }
+      },
+      {
+        platform: "render",
+        read: (env) => {
+          if (env.RENDER !== "true") return null;
+          return env.IS_PULL_REQUEST === "true" ? { environment: "sandbox", evidence: "IS_PULL_REQUEST=true" } : { environment: "production", evidence: "RENDER=true, not a pull request" };
+        }
+      },
+      {
+        platform: "railway",
+        read: (env) => {
+          if (!set(env.RAILWAY_ENVIRONMENT_NAME)) return null;
+          return env.RAILWAY_ENVIRONMENT_NAME === "production" ? { environment: "production", evidence: "RAILWAY_ENVIRONMENT_NAME=production" } : { environment: "sandbox", evidence: `RAILWAY_ENVIRONMENT_NAME=${env.RAILWAY_ENVIRONMENT_NAME}` };
+        }
+      }
+    ];
+  }
+});
+
 // src/site-url.ts
 function isUnpublishableHost(hostname) {
   const host = hostname.toLowerCase().replace(/\.+$/, "");
@@ -485,11 +584,13 @@ async function resolveConfig(options) {
   const environmentRaw = fromEnv.environment ?? fromFile.environment;
   if (environmentRaw !== void 0 && !isEnvironment(environmentRaw)) {
     throw new PatchstackError(
-      `Environment must be "production" or "sandbox"; got "${environmentRaw}".`,
+      `Environment must be "production", "sandbox" or "local"; got "${environmentRaw}".`,
       "CONFIG_INVALID"
     );
   }
-  const environment = environmentRaw ?? DEFAULT_ENVIRONMENT;
+  const inferred = environmentRaw === void 0 ? inferEnvironment(process.env) : null;
+  const environment = environmentRaw ?? inferred.environment;
+  const environmentEvidence = inferred?.evidence ?? [];
   if (siteUuid !== null && siteUuid.length > 0 && !isUuid(siteUuid)) {
     throw new PatchstackError(
       `Site UUID "${siteUuid}" does not look like a valid UUID.`,
@@ -515,6 +616,7 @@ async function resolveConfig(options) {
     endpoint,
     timeoutMs,
     environment,
+    environmentEvidence,
     widget: fromFile.widget !== false,
     claimToken
   };
@@ -580,9 +682,9 @@ function isUuid(value) {
   return /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i.test(value);
 }
 function isEnvironment(value) {
-  return value === "production" || value === "sandbox";
+  return value === "production" || value === "sandbox" || value === "local";
 }
-var import_promises2, import_node_path2, CONFIG_FILENAME, SECRET_FILENAME, DEFAULT_ENVIRONMENT;
+var import_promises2, import_node_path2, CONFIG_FILENAME, SECRET_FILENAME;
 var init_config = __esm({
   "src/config.ts"() {
     "use strict";
@@ -590,11 +692,11 @@ var init_config = __esm({
     import_node_path2 = __toESM(require("path"), 1);
     init_types();
     init_client();
+    init_environment();
     init_site_url();
     init_site_name();
     CONFIG_FILENAME = ".patchstackrc.json";
     SECRET_FILENAME = ".patchstackrc.local.json";
-    DEFAULT_ENVIRONMENT = "production";
   }
 });
 
@@ -631,8 +733,8 @@ async function readDeclaredDependencyNames(cwd) {
   return [...names];
 }
 function missingDependencies(declared, packages) {
-  const present = new Set(packages.map((entry) => entry.name));
-  return declared.filter((name) => !present.has(name));
+  const present2 = new Set(packages.map((entry) => entry.name));
+  return declared.filter((name) => !present2.has(name));
 }
 function disagreements(packages, other) {
   const otherVersions = /* @__PURE__ */ new Map();
@@ -6985,8 +7087,8 @@ async function createProtection(options = {}) {
       hardened = true;
       try {
         if (res.headersSent || typeof res.setHeader !== "function") return null;
-        const set = typeof res.getHeaders === "function" ? res.getHeaders() : {};
-        const headers = effective && effective.headers ? { ...set, ...effective.headers } : set;
+        const set2 = typeof res.getHeaders === "function" ? res.getHeaders() : {};
+        const headers = effective && effective.headers ? { ...set2, ...effective.headers } : set2;
         const status = effective && effective.status !== void 0 ? effective.status : res.statusCode;
         const r = screenText("", { status, headers }, reqCtx, hardensWithoutBody);
         answeredWithoutBody = true;
@@ -7698,8 +7800,8 @@ function applyHeaderMutation(headers, rule) {
     const ensure = rule.ensure === true;
     for (const [name, value] of Object.entries(rule.set_headers ?? {})) {
       const key = String(name).toLowerCase();
-      const present = headers[key] != null && headers[key] !== "";
-      if (ensure && present) continue;
+      const present2 = headers[key] != null && headers[key] !== "";
+      if (ensure && present2) continue;
       headers[key] = String(value);
     }
     return;