@parhelia/editor-bridge-react 0.1.12889

package/README.md

@@ -0,0 +1,41 @@
+# Parhelia Editor Bridge React
+
+React helper for adding the Parhelia editor bridge script to rendering hosts.
+
+Render the full bridge script directly in Parhelia editing mode:
+
+```tsx
+import { ParheliaBridgeScript } from "@parhelia/editor-bridge-react";
+
+<ParheliaBridgeScript searchParams={searchParams} />
+```
+
+By default, `ParheliaBridgeScript` renders only for `?parhelia=1` and reads
+the Sitecore origin from `PARHELIA_SITECORE_ORIGIN` or
+`NEXT_PUBLIC_PARHELIA_SITECORE_ORIGIN`. When those are not set, it falls back
+to the managed Sitecore/XM Cloud host values `SITECORE_API_HOST` and
+`NEXT_PUBLIC_SITECORE_API_HOST`.
+
+You can pass the origin explicitly when env lookup is not available:
+
+```tsx
+<ParheliaBridgeScript
+  sitecoreOrigin="https://sitecore-authoring.example"
+  searchParams={searchParams}
+/>
+```
+
+For non-React editing-render routes, reuse the same predicate:
+
+```ts
+import { shouldRenderParheliaBridgeScript } from "@parhelia/editor-bridge-react";
+
+if (shouldRenderParheliaBridgeScript({ requestUrl: request.url })) {
+  // Inject /parhelia/editor-bridge/v1/parhelia-bridge.js from the Sitecore origin.
+}
+```
+
+The Sitecore origin should come from trusted server config or fixed application
+code. Do not source it from the query string or a parent-window message. For
+cross-origin rendering hosts, allow the Sitecore origin that serves this script
+in `script-src`.

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+import { type ReactElement, type ScriptHTMLAttributes } from "react";
+export type ParheliaBridgeSearchParams = URLSearchParams | Record<string, string | string[] | null | undefined>;
+export type ParheliaBridgeActivationOptions = {
+    enabled?: boolean;
+    queryParam?: string;
+    queryValue?: string | null;
+    requestUrl?: string | URL;
+    searchParams?: ParheliaBridgeSearchParams;
+};
+export declare const PARHELIA_BRIDGE_PATH = "/parhelia/editor-bridge/v1/parhelia-bridge.js";
+export type ParheliaBridgeScriptProps = ParheliaBridgeActivationOptions & {
+    sitecoreOrigin?: string;
+    id?: string;
+    nonce?: string;
+    async?: boolean;
+    defer?: boolean;
+    crossOrigin?: ScriptHTMLAttributes<HTMLScriptElement>["crossOrigin"];
+    integrity?: string;
+    referrerPolicy?: ScriptHTMLAttributes<HTMLScriptElement>["referrerPolicy"];
+};
+export declare function shouldRenderParheliaBridgeScript({ enabled, queryParam, queryValue, requestUrl, searchParams, }?: ParheliaBridgeActivationOptions): boolean;
+export declare function ParheliaBridgeScript({ sitecoreOrigin, id, nonce, async, defer, crossOrigin, integrity, referrerPolicy, ...activation }: ParheliaBridgeScriptProps): ReactElement | null;
+export declare function resolveParheliaBridgeUrl(sitecoreOrigin?: string): string | undefined;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,YAAY,EACjB,KAAK,oBAAoB,EAC1B,MAAM,OAAO,CAAC;AAEf,MAAM,MAAM,0BAA0B,GAClC,eAAe,GACf,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;AAEzD,MAAM,MAAM,+BAA+B,GAAG;IAC5C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IAC1B,YAAY,CAAC,EAAE,0BAA0B,CAAC;CAC3C,CAAC;AAEF,eAAO,MAAM,oBAAoB,kDACgB,CAAC;AAElD,MAAM,MAAM,yBAAyB,GAAG,+BAA+B,GAAG;IACxE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,oBAAoB,CAAC,iBAAiB,CAAC,CAAC,aAAa,CAAC,CAAC;IACrE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,oBAAoB,CAAC,iBAAiB,CAAC,CAAC,gBAAgB,CAAC,CAAC;CAC5E,CAAC;AAMF,wBAAgB,gCAAgC,CAAC,EAC/C,OAAO,EACP,UAAuB,EACvB,UAAgB,EAChB,UAAU,EACV,YAAY,GACb,GAAE,+BAAoC,GAAG,OAAO,CAmBhD;AAED,wBAAgB,oBAAoB,CAAC,EACnC,cAAc,EACd,EAAE,EACF,KAAK,EACL,KAAa,EACb,KAAY,EACZ,WAAW,EACX,SAAS,EACT,cAAc,EACd,GAAG,UAAU,EACd,EAAE,yBAAyB,GAAG,YAAY,GAAG,IAAI,CAqBjD;AAED,wBAAgB,wBAAwB,CAAC,cAAc,CAAC,EAAE,MAAM,sBAW/D"}

package/dist/index.js

@@ -0,0 +1,87 @@
+import { createElement, } from "react";
+export const PARHELIA_BRIDGE_PATH = "/parhelia/editor-bridge/v1/parhelia-bridge.js";
+export function shouldRenderParheliaBridgeScript({ enabled, queryParam = "parhelia", queryValue = "1", requestUrl, searchParams, } = {}) {
+    if (enabled !== undefined) {
+        return enabled;
+    }
+    const params = resolveSearchParams(requestUrl, searchParams);
+    if (!params) {
+        return false;
+    }
+    if (!params.has(queryParam)) {
+        return false;
+    }
+    if (queryValue === null) {
+        return true;
+    }
+    return params.getAll(queryParam).some((value) => value === queryValue);
+}
+export function ParheliaBridgeScript({ sitecoreOrigin, id, nonce, async = false, defer = true, crossOrigin, integrity, referrerPolicy, ...activation }) {
+    if (!shouldRenderParheliaBridgeScript(activation)) {
+        return null;
+    }
+    const bridgeUrl = resolveParheliaBridgeUrl(sitecoreOrigin);
+    if (!bridgeUrl) {
+        return null;
+    }
+    return createElement("script", {
+        id,
+        src: bridgeUrl,
+        async,
+        defer,
+        nonce,
+        crossOrigin,
+        integrity,
+        referrerPolicy,
+        "data-parhelia-editor-bridge": "runtime",
+    });
+}
+export function resolveParheliaBridgeUrl(sitecoreOrigin) {
+    const origin = sitecoreOrigin || readSitecoreOriginFromEnvironment();
+    if (!origin) {
+        return undefined;
+    }
+    try {
+        return new URL(PARHELIA_BRIDGE_PATH, origin).toString();
+    }
+    catch {
+        return undefined;
+    }
+}
+function resolveSearchParams(requestUrl, searchParams) {
+    if (searchParams instanceof URLSearchParams) {
+        return searchParams;
+    }
+    if (searchParams) {
+        const params = new URLSearchParams();
+        Object.entries(searchParams).forEach(([key, value]) => {
+            if (Array.isArray(value)) {
+                value.forEach((entry) => params.append(key, entry));
+                return;
+            }
+            if (value !== undefined && value !== null) {
+                params.append(key, value);
+            }
+        });
+        return params;
+    }
+    if (requestUrl) {
+        try {
+            return new URL(requestUrl).searchParams;
+        }
+        catch {
+            return new URL(requestUrl, "http://parhelia.local").searchParams;
+        }
+    }
+    if (typeof window !== "undefined") {
+        return new URLSearchParams(window.location.search);
+    }
+    return undefined;
+}
+function readSitecoreOriginFromEnvironment() {
+    const env = globalThis.process?.env;
+    return (env?.PARHELIA_SITECORE_ORIGIN ||
+        env?.NEXT_PUBLIC_PARHELIA_SITECORE_ORIGIN ||
+        env?.SITECORE_API_HOST ||
+        env?.NEXT_PUBLIC_SITECORE_API_HOST);
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@parhelia/editor-bridge-react",
+  "version": "0.1.12889",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "module",
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "build:native": "tsgo -p tsconfig.build.json",
+    "check-types": "tsc --noEmit -p tsconfig.build.json",
+    "check-types:native": "tsgo --noEmit -p tsconfig.build.json",
+    "test": "vitest run"
+  },
+  "peerDependencies": {
+    "react": ">=18"
+  },
+  "devDependencies": {
+    "@repo/typescript-config": "*",
+    "@types/react": "19.2.14",
+    "typescript": "5.8.2",
+    "vitest": "^4.1.5"
+  }
+}