payload-live-preview 1.0.0

package/dist/preview-request-DAvxm18T.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Server-side preview-request detection.
+ *
+ * The live-preview runtime only ever activates inside the Payload
+ * admin's iframe, but the *server* still has to decide whether to
+ * inject the (sizeable) inline script into a given HTML response.
+ * Injecting it into every page for every visitor buffers every
+ * response and ships dead bytes to production traffic — so adapters
+ * gate injection on this predicate by default, and consumers with
+ * hand-rolled middleware can import it directly.
+ *
+ * A request counts as a preview when any of these hold:
+ *
+ *   1. A preview query parameter is present (`?preview=true`,
+ *      `?draft=true`, `?livePreview=true` — configurable).
+ *   2. `Sec-Fetch-Dest: iframe` — the document is being loaded as an
+ *      iframe, which is exactly how the Payload admin embeds it.
+ *      (Sent by all evergreen browsers; absence never *excludes* a
+ *      request, presence includes it.)
+ *   3. The `Referer` points at one of the given admin origins.
+ *
+ * @module @adapters/shared/preview-request
+ */
+/** The individual signals the predicate can consider. */
+type PreviewSignal = 'query' | 'fetch-dest' | 'referer';
+interface PreviewRequestOptions {
+    /**
+     * Which signals count as "this is a preview request". Default: all
+     * three. High-security setups that must never relax framing headers
+     * for unsolicited iframe loads can restrict to `['query']` — then
+     * only an explicit `?preview=true` (e.g. from `buildLivePreviewUrl`)
+     * activates preview handling.
+     */
+    readonly signals?: readonly PreviewSignal[];
+    /**
+     * Query parameters (with values `true` or `1`) that mark a request
+     * as a preview. Default: `['preview', 'draft', 'livePreview']`.
+     */
+    readonly queryParams?: readonly string[];
+    /**
+     * Treat `Sec-Fetch-Dest: iframe` as a preview signal. Default `true`.
+     * Legacy alias for excluding `'fetch-dest'` from `signals`.
+     */
+    readonly checkFetchDest?: boolean;
+    /**
+     * Admin origins whose `Referer` marks a request as a preview,
+     * e.g. `['https://cms.example.com']`.
+     */
+    readonly adminOrigins?: readonly string[];
+}
+/**
+ * The minimal request surface the predicate needs. The standard
+ * `Request` satisfies it structurally, and server frameworks without
+ * fetch-style requests (e.g. Nitro/H3) can supply a tiny shim.
+ */
+interface PreviewRequestLike {
+    readonly url: string;
+    readonly headers: {
+        get(name: string): string | null;
+    };
+}
+/**
+ * Decide whether `request` is a live-preview request. See the module
+ * docblock for the exact signals.
+ */
+declare function isPreviewRequest(request: PreviewRequestLike, options?: PreviewRequestOptions): boolean;
+
+export { type PreviewRequestLike as P, type PreviewRequestOptions as a, isPreviewRequest as i };

package/package.json

@@ -0,0 +1,186 @@
+{
+  "name": "payload-live-preview",
+  "version": "1.0.0",
+  "description": "Framework-agnostic live preview for Payload CMS — Astro-first; works with Next.js, SvelteKit, Nuxt, and plain HTML.",
+  "author": "relative23",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./core": {
+      "import": {
+        "types": "./dist/core.d.ts",
+        "default": "./dist/core.js"
+      },
+      "require": {
+        "types": "./dist/core.d.cts",
+        "default": "./dist/core.cjs"
+      }
+    },
+    "./astro": {
+      "import": {
+        "types": "./dist/adapters/astro/index.d.ts",
+        "default": "./dist/adapters/astro/index.js"
+      }
+    },
+    "./nextjs": {
+      "import": {
+        "types": "./dist/adapters/nextjs/index.d.ts",
+        "default": "./dist/adapters/nextjs/index.js"
+      }
+    },
+    "./sveltekit": {
+      "import": {
+        "types": "./dist/adapters/sveltekit/index.d.ts",
+        "default": "./dist/adapters/sveltekit/index.js"
+      }
+    },
+    "./nuxt": {
+      "import": {
+        "types": "./dist/adapters/nuxt/index.d.ts",
+        "default": "./dist/adapters/nuxt/index.js"
+      }
+    },
+    "./codegen": {
+      "import": {
+        "types": "./dist/codegen.d.ts",
+        "default": "./dist/codegen.js"
+      },
+      "require": {
+        "types": "./dist/codegen.d.cts",
+        "default": "./dist/codegen.cjs"
+      }
+    },
+    "./codegen/astro": {
+      "import": {
+        "types": "./dist/codegen-astro.d.ts",
+        "default": "./dist/codegen-astro.js"
+      }
+    },
+    "./payload": {
+      "import": {
+        "types": "./dist/payload.d.ts",
+        "default": "./dist/payload.js"
+      },
+      "require": {
+        "types": "./dist/payload.d.cts",
+        "default": "./dist/payload.cjs"
+      }
+    },
+    "./astro/RichText.astro": "./dist/adapters/astro/RichText.astro",
+    "./astro/middleware-entry": {
+      "import": {
+        "types": "./dist/adapters/astro/middleware-entry.d.ts",
+        "default": "./dist/adapters/astro/middleware-entry.js"
+      }
+    }
+  },
+  "bin": {
+    "pll-codegen": "./dist/codegen-cli.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "prepare": "npm run build:runtime",
+    "build:runtime": "tsx scripts/build-runtime.ts",
+    "build": "npm run build:runtime && tsup && npm run build:assets",
+    "build:assets": "node -e \"require('node:fs').copyFileSync('src/adapters/astro/RichText.astro','dist/adapters/astro/RichText.astro')\"",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:unit": "vitest run tests/unit",
+    "test:integration": "vitest run tests/integration",
+    "test:e2e": "playwright test",
+    "test:bench": "vitest bench tests/benchmarks",
+    "test:coverage": "vitest run --coverage",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "format:check": "prettier --check \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "check": "npm run typecheck && npm run lint && npm run test",
+    "prepublishOnly": "npm run check && npm run build",
+    "changeset": "changeset",
+    "version": "changeset version",
+    "release": "npm run build && changeset publish"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.31.0",
+    "@eslint/js": "^10.0.1",
+    "@playwright/test": "^1.61.1",
+    "@types/node": "^22.20.1",
+    "@vitest/coverage-v8": "^4.1.10",
+    "esbuild": "^0.28.1",
+    "eslint": "^10.7.0",
+    "globals": "^17.7.0",
+    "jsdom": "^29.1.1",
+    "prettier": "^3.9.5",
+    "ts-morph": "^28.0.0",
+    "tsup": "^8.5.1",
+    "tsx": "^4.23.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.63.0",
+    "vitest": "^4.1.10"
+  },
+  "keywords": [
+    "payload",
+    "payload-cms",
+    "payload-live-preview",
+    "live-preview",
+    "cms",
+    "headless",
+    "astro",
+    "nextjs",
+    "sveltekit",
+    "nuxt",
+    "vue",
+    "svelte",
+    "schema-driven",
+    "lexical",
+    "csp-safe",
+    "framework-agnostic"
+  ],
+  "peerDependencies": {
+    "astro": ">=4.0.0 <8.0.0",
+    "ts-morph": "^28.0.0"
+  },
+  "peerDependenciesMeta": {
+    "astro": {
+      "optional": true
+    },
+    "ts-morph": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/relative23/payload-live-preview.git"
+  },
+  "bugs": {
+    "url": "https://github.com/relative23/payload-live-preview/issues"
+  },
+  "homepage": "https://github.com/relative23/payload-live-preview#readme"
+}