@revyse/next 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,19 @@
-# Temporary Holding Version
+# @revyse/next
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Next.js integration for Revyse: in development builds only, tags elements with their source
+location and injects the Revyse overlay served by the local agent (`npx revyse dev`). A
+production build is untouched; a test proves it.
+
+```ts
+// next.config.ts
+import { withRevyse } from "@revyse/next";
+
+export default withRevyse({/* your config */});
+```
+
+`npx revyse init` makes this edit for you as a diff you approve. Works with the App Router
+and the Pages Router, webpack and Turbopack, Next 14 to 16.
+
+## License
+
+Proprietary (`UNLICENSED`). Use is governed by the Revyse terms: https://revyse.dev/terms

package/dist/client.cjs

@@ -0,0 +1,11 @@
+"use strict";
+
+// src/client.ts
+var url = decodeURIComponent(__resourceQuery.slice(1));
+if (typeof document !== "undefined" && url && !document.querySelector(`script[src="${url}"]`)) {
+  const script = document.createElement("script");
+  script.type = "module";
+  script.async = true;
+  script.src = url;
+  document.head.append(script);
+}

package/dist/client.js

@@ -0,0 +1,9 @@
+// src/client.ts
+var url = decodeURIComponent(__resourceQuery.slice(1));
+if (typeof document !== "undefined" && url && !document.querySelector(`script[src="${url}"]`)) {
+  const script = document.createElement("script");
+  script.type = "module";
+  script.async = true;
+  script.src = url;
+  document.head.append(script);
+}

package/dist/index.cjs

@@ -0,0 +1,189 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  DEFAULT_AGENT_PORT: () => DEFAULT_AGENT_PORT,
+  DEFAULT_APP_URL: () => DEFAULT_APP_URL,
+  LOCATIONS_DIR: () => LOCATIONS_DIR,
+  liveLoaderScript: () => liveLoaderScript,
+  pagesRouterOf: () => pagesRouterOf,
+  withRevyse: () => withRevyse
+});
+module.exports = __toCommonJS(src_exports);
+
+// ../../node_modules/.pnpm/tsup@9.0.0_jiti@2.7.0_postcss@8.5.31_tsx@4.23.15_typescript@6.0.3/node_modules/tsup/assets/cjs_shims.js
+var getImportMetaUrl = () => typeof document === "undefined" ? new URL(`file:${__filename}`).href : document.currentScript && document.currentScript.tagName.toUpperCase() === "SCRIPT" ? document.currentScript.src : new URL("main.js", document.baseURI).href;
+var importMetaUrl = /* @__PURE__ */ getImportMetaUrl();
+
+// src/index.ts
+var import_node_fs = require("fs");
+var import_node_module = require("module");
+var import_node_path = __toESM(require("path"), 1);
+var LOCATIONS_DIR = import_node_path.default.join("revyse", "locations");
+var DEFAULT_AGENT_PORT = 4545;
+var DEFAULT_APP_URL = "https://revyse.dev";
+var PHASE_DEVELOPMENT_SERVER = "phase-development-server";
+var PHASE_PRODUCTION_BUILD = "phase-production-build";
+var require_ = (0, import_node_module.createRequire)(importMetaUrl);
+function pagesRouterOf(root) {
+  for (const dir of ["pages", "src/pages"]) {
+    if (!(0, import_node_fs.existsSync)(import_node_path.default.join(root, dir))) continue;
+    const hasDocument = ["tsx", "jsx", "ts", "js"].some(
+      (ext) => (0, import_node_fs.existsSync)(import_node_path.default.join(root, dir, `_document.${ext}`))
+    );
+    return { dir, hasDocument };
+  }
+  return null;
+}
+var withImport = (entry, add) => {
+  const list = (v) => Array.isArray(v) ? v : [v];
+  if (typeof entry === "object" && !Array.isArray(entry))
+    return { ...entry, import: [...list(entry.import), add] };
+  return [...list(entry), add];
+};
+function liveLoaderScript(live) {
+  if (!/^pk_live_[0-9a-f]{32}$/.test(live.projectKey))
+    throw new Error(
+      "[revyse] live.projectKey must be the project's public key (pk_live_\u2026) from the Revyse project page"
+    );
+  const appUrl = live.appUrl ?? process.env.REVYSE_APP_URL ?? DEFAULT_APP_URL;
+  return { src: `${new URL(appUrl).origin}/live.js`, projectKey: live.projectKey };
+}
+function withRevyse(config = {}, options = {}) {
+  return async (phase, ctx) => {
+    const resolved = typeof config === "function" ? await config(phase, ctx) : config;
+    if (phase === PHASE_PRODUCTION_BUILD && options.live) {
+      return withLiveLoader(resolved, options.projectRoot ?? process.cwd(), options.live);
+    }
+    if (phase !== PHASE_DEVELOPMENT_SERVER || process.env.NODE_ENV === "production") {
+      return resolved;
+    }
+    const projectRoot = options.projectRoot ?? process.cwd();
+    const overlayScriptUrl = `http://127.0.0.1:${options.agentPort ?? DEFAULT_AGENT_PORT}/overlay.js`;
+    const loader = {
+      loader: require_.resolve("@revyse/next/loader"),
+      options: { projectRoot, overlayScriptUrl }
+    };
+    const pages = pagesRouterOf(projectRoot);
+    if (pages && !pages.hasDocument && process.env.TURBOPACK) {
+      console.warn(
+        `[revyse] ${pages.dir}/ has no custom _document, so with Turbopack Revyse can't load its overlay on Pages Router pages. Add ${pages.dir}/_document.tsx (Next's default document is fine), or run next dev with --webpack.`
+      );
+    }
+    const rule = {
+      loaders: [loader],
+      // Development only, and never third-party code.
+      condition: { all: ["development", { not: "foreign" }] }
+    };
+    const userWebpack = resolved.webpack;
+    return {
+      ...resolved,
+      turbopack: {
+        ...resolved.turbopack,
+        rules: { ...resolved.turbopack?.rules, "*.tsx": rule, "*.jsx": rule }
+      },
+      webpack(webpackConfig, context) {
+        const out = userWebpack ? userWebpack(webpackConfig, context) : webpackConfig;
+        if (context.dev) {
+          out.module.rules.unshift({
+            test: /\.(t|j)sx$/,
+            exclude: /node_modules/,
+            enforce: "pre",
+            use: [loader]
+          });
+          if (pages && !context.isServer) {
+            const client = `${require_.resolve("@revyse/next/client")}?${encodeURIComponent(overlayScriptUrl)}`;
+            const original = out.entry;
+            out.entry = async () => {
+              const entries = await (typeof original === "function" ? original() : original);
+              if (entries.main) entries.main = withImport(entries.main, client);
+              return entries;
+            };
+          }
+        }
+        return out;
+      }
+    };
+  };
+}
+function withLiveLoader(resolved, projectRoot, live) {
+  const token = process.env.REVYSE_BUILD_TOKEN;
+  if (live.locations && !token?.startsWith("rvb_"))
+    console.warn(
+      "[revyse] live.locations is on but REVYSE_BUILD_TOKEN isn't set, so this build has no exact locations. Create a build token on the project's Live site tab and set it where the site builds."
+    );
+  const locations = live.locations && token?.startsWith("rvb_") ? {
+    token,
+    manifestDir: import_node_path.default.join(projectRoot, resolved.distDir ?? ".next", LOCATIONS_DIR)
+  } : void 0;
+  const loader = {
+    loader: require_.resolve("@revyse/next/loader"),
+    options: {
+      projectRoot,
+      liveScript: liveLoaderScript(live),
+      ...locations ? { locations } : {}
+    }
+  };
+  const pages = pagesRouterOf(projectRoot);
+  if (pages && !pages.hasDocument) {
+    console.warn(
+      `[revyse] ${pages.dir}/ has no custom _document, so the live overlay's loader can't be added to Pages Router pages. Add ${pages.dir}/_document.tsx (Next's default document is fine).`
+    );
+  }
+  const rule = { loaders: [loader], condition: { not: "foreign" } };
+  const userWebpack = resolved.webpack;
+  return {
+    ...resolved,
+    turbopack: {
+      ...resolved.turbopack,
+      rules: { ...resolved.turbopack?.rules, "*.tsx": rule, "*.jsx": rule }
+    },
+    webpack(webpackConfig, context) {
+      const out = userWebpack ? userWebpack(webpackConfig, context) : webpackConfig;
+      out.module.rules.unshift({
+        test: /\.(t|j)sx$/,
+        exclude: /node_modules/,
+        enforce: "pre",
+        use: [loader]
+      });
+      return out;
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DEFAULT_AGENT_PORT,
+  DEFAULT_APP_URL,
+  LOCATIONS_DIR,
+  liveLoaderScript,
+  pagesRouterOf,
+  withRevyse
+});

package/dist/index.d.cts

@@ -0,0 +1,57 @@
+import { NextConfig } from 'next';
+
+interface RevyseNextOptions {
+    /** Port of the local Revyse agent started by `revyse dev`. */
+    agentPort?: number;
+    /** Project root; defaults to the directory Next runs in. */
+    projectRoot?: string;
+    /**
+     * The live overlay on the deployed site (ADR 0032): production builds get one `async`
+     * script tag for the Revyse loader, carrying the project's public key from the project page.
+     * The loader is inert for visitors; members activate it from Revyse. Without this option a
+     * production build contains no Revyse code at all.
+     */
+    live?: {
+        /** The project's public key (`pk_live_…`), shown on the project page. */
+        projectKey: string;
+        /** The Revyse app serving the loader; defaults to `REVYSE_APP_URL` or https://revyse.dev. */
+        appUrl?: string;
+        /**
+         * Exact locations (W8, ADR 0032 §6): elements get opaque `data-rv` ids keyed with the
+         * project's build token (`REVYSE_BUILD_TOKEN` in the build environment), and the build
+         * writes the manifest (id → file:line:col) under its output directory for
+         * `revyse live upload`. No path is in the pages. Without the token the build goes on
+         * without locations, and says so.
+         */
+        locations?: boolean;
+    };
+}
+/** Where a build with exact locations writes its manifest, inside Next's output directory. */
+declare const LOCATIONS_DIR: string;
+declare const DEFAULT_AGENT_PORT = 4545;
+declare const DEFAULT_APP_URL = "https://revyse.dev";
+type ConfigInput = NextConfig | ((phase: string, ctx: {
+    defaultConfig: NextConfig;
+}) => NextConfig | Promise<NextConfig>);
+/** The Pages Router directory and whether it has a custom `_document`, if the app has one. */
+declare function pagesRouterOf(root: string): {
+    dir: string;
+    hasDocument: boolean;
+} | null;
+/** The loader tag for a production build with the `live` option (ADR 0032 §1). */
+declare function liveLoaderScript(live: NonNullable<RevyseNextOptions["live"]>): {
+    src: string;
+    projectKey: string;
+};
+/**
+ * Wraps a Next.js config. In `next dev` it adds a JSX loader (webpack and Turbopack) that tags
+ * host elements with their source location and loads the Revyse overlay. In every other phase
+ * — including `next build` — the config is returned untouched, so nothing ships to production,
+ * with one opt-in exception: `live` adds the live overlay's loader tag to production builds.
+ */
+declare function withRevyse(config?: ConfigInput, options?: RevyseNextOptions): (phase: string, ctx: {
+    defaultConfig: NextConfig;
+}) => Promise<NextConfig>;
+
+export { DEFAULT_AGENT_PORT, DEFAULT_APP_URL, LOCATIONS_DIR, liveLoaderScript, pagesRouterOf, withRevyse };
+export type { RevyseNextOptions };

package/dist/index.d.ts

@@ -0,0 +1,57 @@
+import { NextConfig } from 'next';
+
+interface RevyseNextOptions {
+    /** Port of the local Revyse agent started by `revyse dev`. */
+    agentPort?: number;
+    /** Project root; defaults to the directory Next runs in. */
+    projectRoot?: string;
+    /**
+     * The live overlay on the deployed site (ADR 0032): production builds get one `async`
+     * script tag for the Revyse loader, carrying the project's public key from the project page.
+     * The loader is inert for visitors; members activate it from Revyse. Without this option a
+     * production build contains no Revyse code at all.
+     */
+    live?: {
+        /** The project's public key (`pk_live_…`), shown on the project page. */
+        projectKey: string;
+        /** The Revyse app serving the loader; defaults to `REVYSE_APP_URL` or https://revyse.dev. */
+        appUrl?: string;
+        /**
+         * Exact locations (W8, ADR 0032 §6): elements get opaque `data-rv` ids keyed with the
+         * project's build token (`REVYSE_BUILD_TOKEN` in the build environment), and the build
+         * writes the manifest (id → file:line:col) under its output directory for
+         * `revyse live upload`. No path is in the pages. Without the token the build goes on
+         * without locations, and says so.
+         */
+        locations?: boolean;
+    };
+}
+/** Where a build with exact locations writes its manifest, inside Next's output directory. */
+declare const LOCATIONS_DIR: string;
+declare const DEFAULT_AGENT_PORT = 4545;
+declare const DEFAULT_APP_URL = "https://revyse.dev";
+type ConfigInput = NextConfig | ((phase: string, ctx: {
+    defaultConfig: NextConfig;
+}) => NextConfig | Promise<NextConfig>);
+/** The Pages Router directory and whether it has a custom `_document`, if the app has one. */
+declare function pagesRouterOf(root: string): {
+    dir: string;
+    hasDocument: boolean;
+} | null;
+/** The loader tag for a production build with the `live` option (ADR 0032 §1). */
+declare function liveLoaderScript(live: NonNullable<RevyseNextOptions["live"]>): {
+    src: string;
+    projectKey: string;
+};
+/**
+ * Wraps a Next.js config. In `next dev` it adds a JSX loader (webpack and Turbopack) that tags
+ * host elements with their source location and loads the Revyse overlay. In every other phase
+ * — including `next build` — the config is returned untouched, so nothing ships to production,
+ * with one opt-in exception: `live` adds the live overlay's loader tag to production builds.
+ */
+declare function withRevyse(config?: ConfigInput, options?: RevyseNextOptions): (phase: string, ctx: {
+    defaultConfig: NextConfig;
+}) => Promise<NextConfig>;
+
+export { DEFAULT_AGENT_PORT, DEFAULT_APP_URL, LOCATIONS_DIR, liveLoaderScript, pagesRouterOf, withRevyse };
+export type { RevyseNextOptions };

package/dist/index.js

@@ -0,0 +1,143 @@
+// src/index.ts
+import { existsSync } from "fs";
+import { createRequire } from "module";
+import path from "path";
+var LOCATIONS_DIR = path.join("revyse", "locations");
+var DEFAULT_AGENT_PORT = 4545;
+var DEFAULT_APP_URL = "https://revyse.dev";
+var PHASE_DEVELOPMENT_SERVER = "phase-development-server";
+var PHASE_PRODUCTION_BUILD = "phase-production-build";
+var require_ = createRequire(import.meta.url);
+function pagesRouterOf(root) {
+  for (const dir of ["pages", "src/pages"]) {
+    if (!existsSync(path.join(root, dir))) continue;
+    const hasDocument = ["tsx", "jsx", "ts", "js"].some(
+      (ext) => existsSync(path.join(root, dir, `_document.${ext}`))
+    );
+    return { dir, hasDocument };
+  }
+  return null;
+}
+var withImport = (entry, add) => {
+  const list = (v) => Array.isArray(v) ? v : [v];
+  if (typeof entry === "object" && !Array.isArray(entry))
+    return { ...entry, import: [...list(entry.import), add] };
+  return [...list(entry), add];
+};
+function liveLoaderScript(live) {
+  if (!/^pk_live_[0-9a-f]{32}$/.test(live.projectKey))
+    throw new Error(
+      "[revyse] live.projectKey must be the project's public key (pk_live_\u2026) from the Revyse project page"
+    );
+  const appUrl = live.appUrl ?? process.env.REVYSE_APP_URL ?? DEFAULT_APP_URL;
+  return { src: `${new URL(appUrl).origin}/live.js`, projectKey: live.projectKey };
+}
+function withRevyse(config = {}, options = {}) {
+  return async (phase, ctx) => {
+    const resolved = typeof config === "function" ? await config(phase, ctx) : config;
+    if (phase === PHASE_PRODUCTION_BUILD && options.live) {
+      return withLiveLoader(resolved, options.projectRoot ?? process.cwd(), options.live);
+    }
+    if (phase !== PHASE_DEVELOPMENT_SERVER || process.env.NODE_ENV === "production") {
+      return resolved;
+    }
+    const projectRoot = options.projectRoot ?? process.cwd();
+    const overlayScriptUrl = `http://127.0.0.1:${options.agentPort ?? DEFAULT_AGENT_PORT}/overlay.js`;
+    const loader = {
+      loader: require_.resolve("@revyse/next/loader"),
+      options: { projectRoot, overlayScriptUrl }
+    };
+    const pages = pagesRouterOf(projectRoot);
+    if (pages && !pages.hasDocument && process.env.TURBOPACK) {
+      console.warn(
+        `[revyse] ${pages.dir}/ has no custom _document, so with Turbopack Revyse can't load its overlay on Pages Router pages. Add ${pages.dir}/_document.tsx (Next's default document is fine), or run next dev with --webpack.`
+      );
+    }
+    const rule = {
+      loaders: [loader],
+      // Development only, and never third-party code.
+      condition: { all: ["development", { not: "foreign" }] }
+    };
+    const userWebpack = resolved.webpack;
+    return {
+      ...resolved,
+      turbopack: {
+        ...resolved.turbopack,
+        rules: { ...resolved.turbopack?.rules, "*.tsx": rule, "*.jsx": rule }
+      },
+      webpack(webpackConfig, context) {
+        const out = userWebpack ? userWebpack(webpackConfig, context) : webpackConfig;
+        if (context.dev) {
+          out.module.rules.unshift({
+            test: /\.(t|j)sx$/,
+            exclude: /node_modules/,
+            enforce: "pre",
+            use: [loader]
+          });
+          if (pages && !context.isServer) {
+            const client = `${require_.resolve("@revyse/next/client")}?${encodeURIComponent(overlayScriptUrl)}`;
+            const original = out.entry;
+            out.entry = async () => {
+              const entries = await (typeof original === "function" ? original() : original);
+              if (entries.main) entries.main = withImport(entries.main, client);
+              return entries;
+            };
+          }
+        }
+        return out;
+      }
+    };
+  };
+}
+function withLiveLoader(resolved, projectRoot, live) {
+  const token = process.env.REVYSE_BUILD_TOKEN;
+  if (live.locations && !token?.startsWith("rvb_"))
+    console.warn(
+      "[revyse] live.locations is on but REVYSE_BUILD_TOKEN isn't set, so this build has no exact locations. Create a build token on the project's Live site tab and set it where the site builds."
+    );
+  const locations = live.locations && token?.startsWith("rvb_") ? {
+    token,
+    manifestDir: path.join(projectRoot, resolved.distDir ?? ".next", LOCATIONS_DIR)
+  } : void 0;
+  const loader = {
+    loader: require_.resolve("@revyse/next/loader"),
+    options: {
+      projectRoot,
+      liveScript: liveLoaderScript(live),
+      ...locations ? { locations } : {}
+    }
+  };
+  const pages = pagesRouterOf(projectRoot);
+  if (pages && !pages.hasDocument) {
+    console.warn(
+      `[revyse] ${pages.dir}/ has no custom _document, so the live overlay's loader can't be added to Pages Router pages. Add ${pages.dir}/_document.tsx (Next's default document is fine).`
+    );
+  }
+  const rule = { loaders: [loader], condition: { not: "foreign" } };
+  const userWebpack = resolved.webpack;
+  return {
+    ...resolved,
+    turbopack: {
+      ...resolved.turbopack,
+      rules: { ...resolved.turbopack?.rules, "*.tsx": rule, "*.jsx": rule }
+    },
+    webpack(webpackConfig, context) {
+      const out = userWebpack ? userWebpack(webpackConfig, context) : webpackConfig;
+      out.module.rules.unshift({
+        test: /\.(t|j)sx$/,
+        exclude: /node_modules/,
+        enforce: "pre",
+        use: [loader]
+      });
+      return out;
+    }
+  };
+}
+export {
+  DEFAULT_AGENT_PORT,
+  DEFAULT_APP_URL,
+  LOCATIONS_DIR,
+  liveLoaderScript,
+  pagesRouterOf,
+  withRevyse
+};