siteplane 0.1.67 → 0.2.0-next.0

package/dist/internal/bridge-loader.js

@@ -0,0 +1,28 @@
+"use client";
+
+// src/bridge-loader.tsx
+import { usePathname, useRouter } from "next/navigation";
+import { useEffect, useRef } from "react";
+function BridgeLoader({ editorOrigin }) {
+  const router = useRouter();
+  const pathname = usePathname() ?? "/";
+  const path = useRef(pathname);
+  useEffect(() => {
+    path.current = pathname;
+  }, [pathname]);
+  useEffect(() => {
+    let active = true;
+    let stop;
+    void import("siteplane/internal/bridge").then(({ startBridge }) => {
+      if (active) stop = startBridge({ editorOrigin, refresh: () => router.refresh(), path: () => path.current });
+    });
+    return () => {
+      active = false;
+      stop?.();
+    };
+  }, [editorOrigin, router]);
+  return null;
+}
+export {
+  BridgeLoader
+};

package/dist/internal/bridge.js

@@ -0,0 +1 @@
+function L(t){return _(t)?t.type==="siteplane:refresh"?{type:"siteplane:refresh"}:t.type==="siteplane:highlight"&&(t.fieldId===null||O(t.fieldId))?{type:"siteplane:highlight",fieldId:t.fieldId}:null:null}function _(t){return typeof t=="object"&&t!==null}function O(t){return typeof t=="string"&&t.length>0&&t.length<=256}var r="data-siteplane-field",f="data-siteplane-selected",A="2px solid #2563eb",H="2px dashed #2563eb";function b(t){let c=t.parent??(window.parent===window?null:window.parent);if(!c)return()=>{};let s=new Map,o=null,E="",d,g=e=>c.postMessage(e,t.editorOrigin);function a(e){let n=e===void 0?`[${r}]`:`[${r}=${CSS.escape(e)}]`;return[...document.querySelectorAll(n)]}function l(e,n){if(n===null){let i=s.get(e);if(!i)return;e.style.outline=i.outline,e.style.outlineOffset=i.outlineOffset,s.delete(e);return}s.has(e)||s.set(e,{outline:e.style.outline,outlineOffset:e.style.outlineOffset}),e.style.outline=n,e.style.outlineOffset="2px"}function p(){for(let e of document.querySelectorAll(`[${f}]`))e.removeAttribute(f),l(e,null);if(o!==null)for(let e of a(o))e.setAttribute(f,""),l(e,A)}function m(){let e=[...new Set(a().map(M=>M.getAttribute(r)??""))],n=t.path(),i=JSON.stringify([n,e]);i!==E&&(E=i,g({type:"siteplane:page",version:1,path:n,fields:e.filter(Boolean)}))}let y=e=>e instanceof Element?e.closest(`[${r}]`):null;function T(e){let i=y(e.target)?.getAttribute(r);i&&(e.preventDefault(),e.stopPropagation(),g({type:"siteplane:select",version:1,fieldId:i}))}function u(e){let n=y(e.target);!n||n.hasAttribute(f)||l(n,e.type==="mouseover"?H:null)}function h(e){if(e.origin!==t.editorOrigin||e.source!==c)return;let n=L(e.data);n?.type==="siteplane:refresh"&&t.refresh(),n?.type==="siteplane:highlight"&&(o=n.fieldId,p())}let I=new MutationObserver(()=>{clearTimeout(d),d=setTimeout(()=>{m(),o!==null&&p()},150)});return document.addEventListener("click",T,!0),document.addEventListener("mouseover",u),document.addEventListener("mouseout",u),window.addEventListener("message",h),I.observe(document.documentElement,{childList:!0,subtree:!0,attributeFilter:[r]}),m(),()=>{clearTimeout(d),I.disconnect(),document.removeEventListener("click",T,!0),document.removeEventListener("mouseover",u),document.removeEventListener("mouseout",u),window.removeEventListener("message",h),o=null,p();for(let e of[...s.keys()])l(e,null)}}export{b as startBridge};

package/dist/next.cjs

@@ -0,0 +1,204 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/next.ts
+var next_exports = {};
+__export(next_exports, {
+  withSiteplane: () => withSiteplane
+});
+module.exports = __toCommonJS(next_exports);
+var import_node_fs = require("fs");
+var import_promises = require("fs/promises");
+var import_node_module = require("module");
+var import_node_path = require("path");
+
+// ../shared/dist/siteplane-config.js
+var SITEPLANE_CONFIG_FILE = "siteplane.config.json";
+var siteIdPattern = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/u;
+function readSiteplaneConfig(value) {
+  if (typeof value !== "object" || value === null)
+    return null;
+  const { siteId, apiOrigin, editorOrigins } = value;
+  if (typeof siteId !== "string" || !siteIdPattern.test(siteId) || !isWebOrigin(apiOrigin) || !Array.isArray(editorOrigins) || !editorOrigins.every(isWebOrigin)) {
+    return null;
+  }
+  return { siteId, apiOrigin, editorOrigins: [...editorOrigins] };
+}
+function isWebOrigin(value) {
+  if (typeof value !== "string")
+    return false;
+  try {
+    const url = new URL(value);
+    return (url.protocol === "https:" || url.protocol === "http:") && url.origin === value;
+  } catch {
+    return false;
+  }
+}
+
+// src/next.ts
+var DRAFT_MODE_COOKIE = { type: "cookie", key: "__prerender_bypass" };
+var siteIdPattern2 = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/iu;
+function withSiteplane(nextConfig, options = {}) {
+  return async (phase, context) => {
+    const base = await (typeof nextConfig === "function" ? nextConfig(phase, context) : nextConfig);
+    const projectDir = options.projectDir ?? process.cwd();
+    let config = base;
+    try {
+      const project = readProjectConfig(projectDir);
+      if (project) config = withEditor(config, project, { projectDir, admin: options.admin === true });
+    } catch (error) {
+      console.warn(
+        `[Siteplane] ${SITEPLANE_CONFIG_FILE} could not be read, so the website builds without Siteplane content: ${error instanceof Error ? error.message : String(error)}`
+      );
+    }
+    return options.booking ? await withBooking(config, options.booking.site, projectDir) : config;
+  };
+}
+function readProjectConfig(projectDir) {
+  const path = (0, import_node_path.join)(projectDir, SITEPLANE_CONFIG_FILE);
+  if (!(0, import_node_fs.existsSync)(path)) return null;
+  const config = readSiteplaneConfig(JSON.parse((0, import_node_fs.readFileSync)(path, "utf8")));
+  if (!config) throw new Error("run npx siteplane init to repair it");
+  return config;
+}
+function withEditor(config, project, options) {
+  const configPath = (0, import_node_path.join)(options.projectDir, SITEPLANE_CONFIG_FILE);
+  const next = { ...config, ...moduleAlias(config, options.projectDir) };
+  next.webpack = (webpackConfig, context) => {
+    webpackConfig.resolve ??= {};
+    const alias = webpackConfig.resolve.alias;
+    if (Array.isArray(alias)) alias.push({ name: "siteplane/config", alias: configPath, onlyModule: true });
+    else webpackConfig.resolve.alias = Object.assign(alias ?? {}, { "siteplane/config$": configPath });
+    return config.webpack ? config.webpack(webpackConfig, context) : webpackConfig;
+  };
+  const api = new URL(project.apiOrigin);
+  if (api.protocol === "https:") {
+    const pattern = { protocol: "https", hostname: api.hostname, pathname: "/**" };
+    const patterns = config.images?.remotePatterns ?? [];
+    const known = patterns.some((entry) => JSON.stringify(entry) === JSON.stringify(pattern));
+    next.images = { ...config.images, remotePatterns: known ? patterns : [...patterns, pattern] };
+  }
+  const websiteHeaders = config.headers;
+  if (websiteHeaders) {
+    next.headers = async () => {
+      const rules = await websiteHeaders();
+      return [...rules, ...draftFrameRules(rules, project.editorOrigins)];
+    };
+  }
+  if (options.admin) {
+    const portal = `${project.apiOrigin}/portal?site=${project.siteId}`;
+    const websiteRedirects = config.redirects;
+    next.redirects = async () => [
+      ...await websiteRedirects?.() ?? [],
+      { source: "/admin", destination: portal, permanent: false },
+      { source: "/admin/:path*", destination: portal, permanent: false }
+    ];
+  }
+  return next;
+}
+function moduleAlias(config, projectDir) {
+  const alias = { "siteplane/config": `./${SITEPLANE_CONFIG_FILE}` };
+  if (usesExperimentalTurbo(projectDir)) {
+    const turbo = config.experimental?.turbo;
+    return {
+      experimental: { ...config.experimental, turbo: { ...turbo, resolveAlias: { ...turbo?.resolveAlias, ...alias } } }
+    };
+  }
+  return { turbopack: { ...config.turbopack, resolveAlias: { ...config.turbopack?.resolveAlias, ...alias } } };
+}
+function usesExperimentalTurbo(projectDir) {
+  try {
+    const manifest = (0, import_node_module.createRequire)((0, import_node_path.join)(projectDir, "package.json")).resolve("next/package.json");
+    const [major = 0, minor = 0] = JSON.parse((0, import_node_fs.readFileSync)(manifest, "utf8")).version.split(".").map(Number);
+    return major < 15 || major === 15 && minor < 3;
+  } catch {
+    return false;
+  }
+}
+function draftFrameRules(rules, editorOrigins) {
+  const isCsp = (key) => key.toLowerCase() === "content-security-policy";
+  const isXfo = (key) => key.toLowerCase() === "x-frame-options";
+  const hasFrameOptions = rules.some((rule) => rule.headers.some((header) => isXfo(header.key)));
+  const draftRule = (rule, headers) => ({
+    ...rule,
+    has: [...rule.has ?? [], DRAFT_MODE_COOKIE],
+    headers
+  });
+  const optionsOnly = rules.filter((rule) => rule.headers.some((header) => isXfo(header.key)) && !rule.headers.some((header) => isCsp(header.key))).map(
+    (rule) => draftRule(rule, [
+      ...rule.headers,
+      { key: "Content-Security-Policy", value: `frame-ancestors 'self' ${editorOrigins.join(" ")}` }
+    ])
+  );
+  const policies = rules.filter(
+    (rule) => rule.headers.some((header) => isCsp(header.key) && (hasFrameOptions || /frame-ancestors/iu.test(header.value)))
+  ).map(
+    (rule) => draftRule(
+      rule,
+      rule.headers.map(
+        (header) => isCsp(header.key) ? { ...header, value: allowEditorFrames(header.value, editorOrigins) } : header
+      )
+    )
+  );
+  return [...optionsOnly, ...policies];
+}
+function allowEditorFrames(policy, editorOrigins) {
+  const directives = policy.split(";").map((directive) => directive.trim()).filter(Boolean);
+  const index = directives.findIndex((directive) => /^frame-ancestors(\s|$)/iu.test(directive));
+  if (index === -1) return [...directives, `frame-ancestors 'self' ${editorOrigins.join(" ")}`].join("; ");
+  const sources = (directives[index] ?? "").split(/\s+/u).slice(1);
+  const allowed = sources.includes("'none'") ? editorOrigins : [...sources, ...editorOrigins.filter((origin) => !sources.includes(origin))];
+  directives[index] = `frame-ancestors ${allowed.join(" ")}`;
+  return directives.join("; ");
+}
+function prependRewrites(rewrites, rules) {
+  return async () => {
+    const existing = await rewrites?.() ?? [];
+    const sections = Array.isArray(existing) ? { afterFiles: existing } : existing;
+    return {
+      beforeFiles: [...rules, ...sections.beforeFiles ?? []],
+      afterFiles: sections.afterFiles ?? [],
+      fallback: sections.fallback ?? []
+    };
+  };
+}
+async function withBooking(config, site, projectDir) {
+  if (!siteIdPattern2.test(site)) throw new Error("Siteplane booking.site must be the Site ID from Booking settings.");
+  for (const folder of ["app/booking", "src/app/booking"]) {
+    if (await (0, import_promises.access)((0, import_node_path.join)(projectDir, folder)).then(
+      () => true,
+      () => false
+    )) {
+      console.warn(
+        "[Siteplane] An app/booking route exists. The Booking beforeFiles rewrite takes precedence; move that route or remove the Booking integration."
+      );
+    }
+  }
+  return {
+    ...config,
+    rewrites: prependRewrites(config.rewrites, [
+      { source: "/booking", destination: `https://siteplane.io/booking?site=${site}` },
+      { source: "/booking/:path*", destination: `https://siteplane.io/booking/:path*?site=${site}` }
+    ])
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  withSiteplane
+});

package/dist/next.d.ts

@@ -1,121 +1,30 @@
-type HeaderRule = {
-  source: string;
-  headers: Array<{ key: string; value: string }>;
-};
-type NextRemoteImagePattern = {
-  protocol?: "http" | "https";
-  hostname: string;
-  port?: string;
-  pathname?: string;
-  search?: string;
-};
-type NextImageConfig = {
-  remotePatterns?: Array<NextRemoteImagePattern | URL>;
-  localPatterns?: Array<{ pathname?: string; search?: string }> | undefined;
-  maximumRedirects?: number;
-  loader?: string;
-  loaderFile?: string;
-};
-type RewriteRule = { source: string; destination: string };
-type Rewrites =
-  | RewriteRule[]
-  | {
-      beforeFiles?: RewriteRule[];
-      afterFiles?: RewriteRule[];
-      fallback?: RewriteRule[];
+import { NextConfig } from 'next';
+
+/** How Next calls a config function: with the phase and the default config. */
+type NextConfigFunction = (phase: string, context: {
+    defaultConfig: NextConfig;
+}) => NextConfig | Promise<NextConfig>;
+type SiteplaneNextOptions = {
+    /** Booking on `/booking`, unchanged since Plan 49. */
+    booking?: {
+        site: string;
     };
-type NextConfigLike = {
-  rewrites?: () => Rewrites | Promise<Rewrites>;
-  images?: NextImageConfig;
-  headers?: () => HeaderRule[] | Promise<HeaderRule[]>;
-  env?: Record<string, string | undefined>;
-};
-
-export type SiteplaneNextOptions = {
-  booking?: { site: string };
-  projectDir?: string;
-  buildRevision?: string;
-};
-
-export type SiteplaneFieldScanIssue = {
-  code: string;
-  message: string;
-  fieldId?: string;
-  filePath: string;
-};
-
-type SiteplaneSourceMapping = {
-  kind: "function";
-  filePath: string;
-  exportName?: string;
-  sourcePath?: string;
-  editTarget?: string;
-};
-
-type SiteplaneDomMapping = {
-  attribute: "data-siteplane-field-id";
-  previewStrategy: "dom" | "event";
-};
-
-type SiteplaneContractFieldBase = {
-  fieldId: string;
-  routeKey: string;
-  source: SiteplaneSourceMapping;
-  dom?: SiteplaneDomMapping;
-};
-
-export type SiteplaneSiteFieldContractV1 = {
-  version: 1;
-  fieldContractVersion: string;
-  scannerContractVersion: string;
-  fields: Array<
-    | (SiteplaneContractFieldBase & {
-        fieldType: "text" | "longText";
-        fallback: string;
-      })
-    | (SiteplaneContractFieldBase & {
-        fieldType: "link";
-        fallback: {
-          href: string;
-          label?: string;
-          target?: "_self" | "_blank";
-        };
-      })
-    | (SiteplaneContractFieldBase & {
-        fieldType: "image";
-        fallback: {
-          src: string;
-          alt: string;
-          width?: number;
-          height?: number;
-          crop?: {
-            x: number;
-            y: number;
-            zoom: number;
-            aspectRatio: number;
-          };
-        };
-      })
-  >;
-};
-
-export declare class SiteplaneNextContractError extends Error {
-  readonly code:
-    | "image_policy_conflict"
-    | "image_origin_missing"
-    | "field_contract_scan_failed"
-    | "build_identity_missing";
-}
-
-export declare function scanNextProjectFieldContract(projectDir: string): Promise<{
-  fieldContractHash: string;
-  contract: SiteplaneSiteFieldContractV1;
-  hardErrors: SiteplaneFieldScanIssue[];
-  warnings: SiteplaneFieldScanIssue[];
-  suggestions: SiteplaneFieldScanIssue[];
-}>;
-
-export declare function withSiteplane<TConfig extends NextConfigLike>(
-  nextConfig: TConfig,
-  options?: SiteplaneNextOptions
-): Promise<TConfig & { env: Record<string, string | undefined> }>;
+    /** Sends `/admin` to the portal of the site on Siteplane. */
+    admin?: boolean;
+    /** The project root; Next runs the config there, so it defaults to the working directory. */
+    projectDir?: string;
+};
+/**
+ * `next.config` wrapper (Vertrag 54 §6.5). With `siteplane.config.json` it adds
+ * only Siteplane's image host for `next/image`, Draft Mode variants of the
+ * website's own frame headers for the editor origins, the `siteplane/config`
+ * module for the runtime and, on request, `/admin`. A `basePath` needs nothing
+ * here: the website URL in Siteplane carries it, and the routes of this package
+ * live below it. The editor connection never scans code, sets no build
+ * variables and never stops a build; only an invalid `booking.site` is an error.
+ */
+declare function withSiteplane(nextConfig: NextConfig | Promise<NextConfig> | NextConfigFunction, options?: SiteplaneNextOptions): (phase: string, context: {
+    defaultConfig: NextConfig;
+}) => Promise<NextConfig>;
+
+export { type NextConfigFunction, type SiteplaneNextOptions, withSiteplane };