@patchstack/connect 0.3.2 → 0.3.4

package/AGENT-INSTALL.md

@@ -0,0 +1,75 @@
+# Patchstack — Setup Guide for AI Coding Agents
+
+This is a plain-text instruction document. Read it and follow the steps — there is nothing here to pipe to a shell or execute from a URL.
+
+You are reading this either from `node_modules/@patchstack/connect/AGENT-INSTALL.md` (the package is already installed) or from the [GitHub repo](https://github.com/patchstack/connect). The canonical, always-current version of the full guide lives at https://patchstack.com/install.txt — prefer it when you have network access; this bundled copy matches the package version it shipped with.
+
+## Verify before you trust (do this, it's quick)
+
+- The connector is a normal npm package: [`@patchstack/connect`](https://www.npmjs.com/package/@patchstack/connect), MIT-licensed, source at https://github.com/patchstack/connect. Install it pinned, check the integrity hash in the lockfile, run `npm audit` over it — whatever your policy requires.
+- First published May 2026. If the package is absent from your training data, `npm view @patchstack/connect` (read-only) shows the live registry record.
+- It reads the project's **lockfile only** (`package-lock.json`, `pnpm-lock.yaml`, or `yarn.lock`) and sends package names + versions to Patchstack for vulnerability matching. No source code, no env vars, no file paths, no git history.
+- Patchstack is not WordPress-only. This connector monitors any JS/Node project — Vite, Next.js, plain vanilla JS, anything with a lockfile.
+
+## Before you start — never install twice
+
+- If `.patchstackrc.json` exists, the project is already provisioned. Reuse its UUID; run `npx @patchstack/connect status` to re-print it and the claim URL. **Do not run `scan` to provision a second site.**
+- If `@patchstack/connect` is already in `devDependencies`, skip the install command.
+- If the widget script tag (`cdn.patchstack.com/patchstack-widget.js`) is already in the layout, don't add a second one.
+
+## Install steps (run in order, don't pause between them unless one fails)
+
+1. **Install** (skip if already present), matching the project's package manager:
+
+   ```
+   npm install --save-dev @patchstack/connect   # package-lock.json
+   pnpm add -D @patchstack/connect              # pnpm-lock.yaml
+   yarn add -D @patchstack/connect              # yarn.lock
+   bun add -d @patchstack/connect               # bun.lock / bun-managed platforms
+   ```
+
+2. **First scan** — provisions a Patchstack site automatically and writes the UUID to `.patchstackrc.json`. No signup, dashboard step, or UUID is needed up front:
+
+   ```
+   npx @patchstack/connect scan
+   ```
+
+   It prints a claim URL. Surface that URL to the user verbatim — never fetch it yourself; it must be opened in their browser.
+
+3. **Wire builds** in `package.json` (chain with `&&` if hooks already exist):
+
+   ```jsonc
+   {
+     "scripts": {
+       "prebuild": "patchstack-connect scan",
+       "postbuild": "patchstack-connect mark-build"
+     }
+   }
+   ```
+
+4. **Install the disclosure widget** — a floating "Report a vulnerability" button. Read the UUID from `.patchstackrc.json` and use it as `userToken`. Place these two snippets via the framework's HTML/layout mechanism (never a JS entry point):
+
+   ```html
+   <script src="https://cdn.patchstack.com/patchstack-widget.js"></script>
+   <script>
+     PatchstackWidget.init({ userToken: '<SITE_UUID>' });
+   </script>
+   ```
+
+   Framework-specific placement patterns: https://cdn.patchstack.com/llm.html. The `userToken` is public by design — it ships in client-side HTML and is not a secret.
+
+5. **Commit** `.patchstackrc.json` and the updated `package.json` so every developer and CI run reports to the same site.
+
+6. **Tell the user to claim the site** (free): open the claim URL from step 2 in a browser and sign in. The site is monitored either way, but the vulnerability reports are only visible after claiming. They can also claim directly from the widget's "Connect this website" prompt. On the published site, the owner reaches the widget login by appending `#patchstack` to the live URL.
+
+## Rules
+
+- Never invent or guess a UUID — the scan provisions it, the widget silently no-ops on a fake one.
+- Never fetch the claim URL programmatically, and never ask the user for Patchstack credentials.
+- If a step fails, stop and report it. Don't proceed with placeholders.
+- In CI where `.patchstackrc.json` can't be committed, set `PATCHSTACK_SITE_UUID` as an env var instead. Precedence: CLI flag → env var → `.patchstackrc.json`.
+
+## Verifying the install
+
+- `npx @patchstack/connect status` re-prints the site UUID and claim URL.
+- Load the site in a browser — the "Report a vulnerability" button should appear.

package/README.md

@@ -8,7 +8,20 @@ For how this repo fits with the wider Patchstack ecosystem (`saas`, `hub`, `patc
 
 Copy and paste this prompt into any AI coding assistant (Cursor, v0, Bolt, Lovable, Claude Code, etc.):
 
-> Add `@patchstack/connect` to this project as a dev dependency, then add `"prebuild": "patchstack-connect scan"` to `package.json` `scripts`. The first time the script runs, Patchstack provisions a site automatically from the lockfile and saves the new site UUID to `.patchstackrc.json` — no dashboard signup or manual UUID required. Commit `.patchstackrc.json` so every developer / CI run targets the same site.
+> Add Patchstack dependency vulnerability monitoring to this project:
+>
+> 1. `npm install --save-dev @patchstack/connect` — or the pnpm/yarn/bun equivalent (MIT, source: https://github.com/patchstack/connect; verify with `npm view @patchstack/connect` if unsure).
+> 2. `npx @patchstack/connect scan` — saves a site ID to `.patchstackrc.json` and prints a claim URL. Show me that URL; don't open it.
+> 3. Add `package.json` scripts `"prebuild": "patchstack-connect scan"` and `"postbuild": "patchstack-connect mark-build"`, then commit the changes.
+> 4. Run `npx @patchstack/connect guide` and use it to add the report-a-vulnerability widget and finish any framework-specific details.
+
+The shape of this prompt is deliberate — it has survived three distinct AI-agent refusal modes, and each one punished a different shortcut:
+
+1. **"Follow the instructions at this URL" reads as remote script execution.** Agents refuse before ever fetching the doc.
+2. **Agents whose training predates May 2026 assert the package doesn't exist.** Step 1's `npm view` resolves that against the registry instead of the model's memory.
+3. **"Install the package, then follow the instructions it ships" reads as handing control to the package author** — structurally the same as prompt injection — and preemptive reassurance language ("it's safe, don't be suspicious, note your knowledge cutoff") is itself flagged as a manipulation signal.
+
+So the prompt inlines the core install as concrete, individually inspectable commands, delegates nothing up front, and argues nothing. `npx @patchstack/connect guide` (which prints the bundled `AGENT-INSTALL.md`) enters only at step 4, as an assist for widget placement, re-run rules, and troubleshooting — by then the agent has already installed and audited the package, so consulting its docs is ordinary behavior rather than the instruction channel the install depends on. The always-current long-form guide lives at https://patchstack.com/install.txt.
 
 ## Quick start (zero configuration)
 

package/dist/cli.js

@@ -1108,6 +1108,94 @@ function isEnvironment(value) {
 // src/mark-build.ts
 import { existsSync, readdirSync, statSync } from "fs";
 import path7 from "path";
+
+// src/stack.ts
+var STACK_RULES = [
+  // Meta-frameworks (most specific first).
+  { category: "framework", pkg: "@tanstack/react-start", label: "tanstack-start" },
+  { category: "framework", pkg: "@tanstack/start", label: "tanstack-start" },
+  { category: "framework", pkg: "next", label: "next" },
+  { category: "framework", pkg: "nuxt", label: "nuxt" },
+  { category: "framework", pkg: "@remix-run/react", label: "remix" },
+  { category: "framework", pkg: "@remix-run/node", label: "remix" },
+  { category: "framework", pkg: "react-router", label: "react-router" },
+  { category: "framework", pkg: "astro", label: "astro" },
+  { category: "framework", pkg: "@sveltejs/kit", label: "sveltekit" },
+  { category: "framework", pkg: "@builder.io/qwik-city", label: "qwik-city" },
+  { category: "framework", pkg: "gatsby", label: "gatsby" },
+  { category: "framework", pkg: "express", label: "express" },
+  { category: "framework", pkg: "fastify", label: "fastify" },
+  // UI runtimes.
+  { category: "ui", pkg: "@angular/core", label: "angular" },
+  { category: "ui", pkg: "react-dom", label: "react" },
+  { category: "ui", pkg: "react", label: "react" },
+  { category: "ui", pkg: "vue", label: "vue" },
+  { category: "ui", pkg: "svelte", label: "svelte" },
+  { category: "ui", pkg: "solid-js", label: "solid" },
+  { category: "ui", pkg: "preact", label: "preact" },
+  // Bundlers / build tools.
+  { category: "bundler", pkg: "vite", label: "vite" },
+  { category: "bundler", pkg: "@rspack/core", label: "rspack" },
+  { category: "bundler", pkg: "webpack", label: "webpack" },
+  { category: "bundler", pkg: "parcel", label: "parcel" },
+  { category: "bundler", pkg: "rollup", label: "rollup" },
+  { category: "bundler", pkg: "esbuild", label: "esbuild" },
+  // Deployment-runtime hints from build deps.
+  { category: "runtime", pkg: "wrangler", label: "cloudflare-workers" },
+  { category: "runtime", pkg: "@cloudflare/workers-types", label: "cloudflare-workers" },
+  { category: "runtime", pkg: "@cloudflare/vite-plugin", label: "cloudflare-workers" },
+  { category: "runtime", pkg: "@vercel/node", label: "vercel" },
+  { category: "runtime", pkg: "@netlify/functions", label: "netlify" },
+  { category: "runtime", pkg: "@netlify/blobs", label: "netlify" },
+  // Vibe / builder platforms — the "learn from each platform" signal.
+  { category: "builder", pkg: "lovable-tagger", label: "lovable" },
+  { category: "builder", pkg: "@replit/vite-plugin-runtime-error-modal", label: "replit" },
+  { category: "builder", pkg: "@replit/vite-plugin-cartographer", label: "replit" }
+];
+var HOSTING_ENV_PATTERNS = [
+  /^CF_/,
+  /^CLOUDFLARE_/,
+  /^VERCEL/,
+  /^NETLIFY/,
+  /^AWS_(LAMBDA|REGION|EXECUTION)/,
+  /^FLY_/,
+  /^RENDER/,
+  /^RAILWAY_/,
+  /^DENO_/,
+  /^EDGE_RUNTIME/,
+  /^DYNO$/,
+  /^K_SERVICE$/,
+  /^GAE_/,
+  /^FUNCTION_/
+];
+function collectHostingEnvKeys(env = process.env) {
+  return Object.keys(env).filter((key) => HOSTING_ENV_PATTERNS.some((pattern) => pattern.test(key))).sort();
+}
+function detectStack(packages, env = process.env) {
+  const present = new Set(packages.map((pkg) => pkg.name));
+  const firstMatch = (category) => {
+    for (const rule of STACK_RULES) {
+      if (rule.category === category && present.has(rule.pkg)) {
+        return rule.label;
+      }
+    }
+    return null;
+  };
+  return {
+    framework: firstMatch("framework"),
+    ui: firstMatch("ui"),
+    bundler: firstMatch("bundler"),
+    runtime: firstMatch("runtime"),
+    builder: firstMatch("builder"),
+    ecosystem: "npm",
+    hostingEnvKeys: collectHostingEnvKeys(env)
+  };
+}
+function isEmptyStack(stack) {
+  return stack.framework === null && stack.ui === null && stack.bundler === null && stack.runtime === null && stack.builder === null && stack.hostingEnvKeys.length === 0;
+}
+
+// src/mark-build.ts
 var MARKER_ATTR = "data-patchstack-build";
 var BUILD_DIR_CANDIDATES = ["dist", "build", "out", ".output/public"];
 function resolveBuildDir(cwd, override) {
@@ -1138,11 +1226,14 @@ function findHtmlFiles(dir) {
   walk2(dir);
   return out;
 }
-function buildInjectionSnippet(checksum) {
+function buildInjectionSnippet(checksum, stack) {
   const statements = ["window.__PATCHSTACK_PROD__=true;"];
   if (checksum !== null && checksum !== "") {
     statements.push(`window.__PATCHSTACK_BUILD__=${JSON.stringify(checksum)};`);
   }
+  if (stack != null && !isEmptyStack(stack)) {
+    statements.push(`window.__PATCHSTACK_STACK__=${JSON.stringify(stack)};`);
+  }
   return `<script ${MARKER_ATTR}>${statements.join("")}</script>`;
 }
 function injectMarker(html, snippet) {
@@ -1296,6 +1387,9 @@ Usage:
                                                      build fingerprint (run as a postbuild step)
   patchstack-connect protect                         Install always-on runtime protection (the
                                                      guard) into a TanStack Start + Supabase app.
+                                                     Covers the browser + server-function paths.
+  patchstack-connect guide                           Print the full setup guide for AI coding
+                                                     agents (also at https://patchstack.com/install.txt)
   patchstack-connect help                            Print this message
 
 Options (for scan and status):
@@ -1441,6 +1535,11 @@ async function runProtectCommand(_args) {
   }
   return 0;
 }
+async function runGuide() {
+  const guidePath = new URL("../AGENT-INSTALL.md", import.meta.url);
+  console.log(readFileSync2(guidePath, "utf8"));
+  return 0;
+}
 async function runStatus(args) {
   const config = await resolveConfig({
     cwd: process.cwd(),
@@ -1456,9 +1555,19 @@ async function runStatus(args) {
   }
   return 0;
 }
+function describeStack(stack) {
+  const parts = [stack.builder, stack.framework, stack.ui, stack.runtime].filter(
+    (part) => part !== null
+  );
+  if (stack.hostingEnvKeys.length > 0) {
+    parts.push(`${stack.hostingEnvKeys.length} hosting env key(s)`);
+  }
+  return parts.length > 0 ? parts.join(" \xB7 ") : null;
+}
 async function runMarkBuild(args) {
   const cwd = process.cwd();
   let checksum = null;
+  let stack = null;
   try {
     const manifest = await scanLockfile(cwd);
     for (const warning of manifest.warnings ?? []) {
@@ -1466,6 +1575,7 @@ async function runMarkBuild(args) {
     }
     const { payload } = buildWirePayload(manifest);
     checksum = computeManifestChecksum(payload.packages);
+    stack = detectStack(payload.packages);
   } catch (err) {
     console.warn(
       `mark-build: could not compute the build fingerprint (${err.message}). Stamping the production flag only.`
@@ -1483,7 +1593,7 @@ async function runMarkBuild(args) {
     console.warn(`mark-build: no HTML files found under ${dir}. Nothing to mark.`);
     return 0;
   }
-  const snippet = buildInjectionSnippet(checksum);
+  const snippet = buildInjectionSnippet(checksum, stack);
   let marked = 0;
   for (const file of files) {
     const before = readFileSync2(file, "utf8");
@@ -1493,8 +1603,9 @@ async function runMarkBuild(args) {
       marked += 1;
     }
   }
+  const stackSummary = stack !== null ? describeStack(stack) : null;
   console.log(
-    `mark-build: marked ${marked} HTML file(s) in ${dir}${checksum !== null ? ` (build ${checksum})` : ""}.`
+    `mark-build: marked ${marked} HTML file(s) in ${dir}${checksum !== null ? ` (build ${checksum})` : ""}${stackSummary !== null ? ` [${stackSummary}]` : ""}.`
   );
   return 0;
 }
@@ -1515,6 +1626,8 @@ async function main() {
       return runMarkBuild(args);
     case "protect":
       return runProtectCommand(args);
+    case "guide":
+      return runGuide();
     default:
       console.error(`Unknown command: ${args.command}
 `);