@contentful/experiences-live-preview 0.1.8

package/CHANGELOG.md

@@ -0,0 +1,68 @@
+## 0.1.8 (2026-09-22)
+
+### 🧱 Updated Dependencies
+
+- Updated client to 0.4.8
+
+## 0.1.7 (2026-09-22)
+
+### 🧱 Updated Dependencies
+
+- Updated client to 0.4.7
+- Updated core to 0.8.6
+
+## 0.1.6 (2026-09-22)
+
+### 🩹 Fixes
+
+- **live-preview:** accept payloads without viewports [SPA-5272] ([6db6fa7](https://github.com/contentful/experiences/commit/6db6fa7))
+
+### 🧱 Updated Dependencies
+
+- Updated client to 0.4.6
+- Updated core to 0.8.5
+
+## 0.1.5 (2026-09-22)
+
+### 🚀 Features
+
+- **live-preview:** expose connection errors [SPA-5151] ([#198](https://github.com/contentful/experiences/pull/198))
+
+## 0.1.4 (2026-09-21)
+
+### 🧱 Updated Dependencies
+
+- Updated client to 0.4.5
+- Updated core to 0.8.4
+
+## 0.1.3 (2026-09-21)
+
+### 🧱 Updated Dependencies
+
+- Updated client to 0.4.4
+
+## 0.1.2 (2026-09-18)
+
+### 🚀 Features
+
+- **live-preview:** support resource resolution [SPA-5369] ([#193](https://github.com/contentful/experiences/pull/193))
+
+## 0.1.1 (2026-09-11)
+
+### 🚀 Features
+
+- **live-preview:** expose preview status helper [SPA-5289] ([#170](https://github.com/contentful/experiences/pull/170))
+
+### 🧱 Updated Dependencies
+
+- Updated core to 0.8.3
+
+## 0.1.0 (2026-09-10)
+
+### 🚀 Features
+
+- **live-preview:** add live preview client [SPA-5151] ([#157](https://github.com/contentful/experiences/pull/157))
+
+### 🧱 Updated Dependencies
+
+- Updated core to 0.8.2

package/README.md

@@ -0,0 +1,138 @@
+# @contentful/experiences-live-preview
+
+Optional live preview for Contentful Experiences.
+
+## API
+
+```ts
+type PreviewSessionOptions = {
+  spaceId: string;
+  environmentId: string;
+  previewToken?: string;
+  sessionId?: string;
+  resourceResolution?: string;
+  sessionHost?: string;
+  debug?: boolean;
+};
+
+type PreviewSessionExperienceOptions = {
+  spaceId: string;
+  environmentId: string;
+  sessionId: string;
+  resourceResolution?: string;
+};
+
+type PreviewSessionClientOptions = {
+  previewToken: string;
+  host?: string;
+};
+
+type PreviewSessionResolveOptions = {
+  config: ResolverConfig;
+  metadata?: Record<string, unknown>;
+  debug?: boolean;
+  initialViewportId?: string;
+};
+
+fetchPreviewSession(
+  previewSessionOptions: PreviewSessionExperienceOptions,
+  clientOptions: PreviewSessionClientOptions,
+  resolveOptions: PreviewSessionResolveOptions,
+): Promise<PortableRenderPlan>;
+
+PreviewSessionFetchError;
+LivePreviewConnectionError;
+NotFoundError;
+PREVIEW_WEBSOCKET_HOST;
+
+type LivePreviewResult = {
+  data: ExperiencePayload | undefined;
+  error: Error | undefined;
+};
+
+type LivePreviewClient = {
+  getResult(): LivePreviewResult;
+  subscribe(listener: () => void): () => void;
+  subscribeStatus(listener: (status: LivePreviewStatus) => void): () => void;
+};
+
+createLivePreviewClient(
+  previewSessionOptions: PreviewSessionOptions,
+  initialPayload?: ExperiencePayload,
+): LivePreviewClient;
+
+sendPreviewStatus(status: LivePreviewStatus): void;
+```
+
+Use `fetchPreviewSession` for the initial render when the Contentful app
+provides a `preview_session_id`. It fetches the current Preview Session
+snapshot and resolves it into a `PortableRenderPlan`. Use `createLivePreviewClient`
+to receive subsequent WebSocket updates.
+
+```ts
+import { fetchPreviewSession } from '@contentful/experiences-live-preview';
+
+const plan = await fetchPreviewSession(
+  { spaceId, environmentId, sessionId },
+  { previewToken },
+  { config: experienceConfig }
+);
+```
+
+The request sends `previewToken` as a Bearer token in the `Authorization`
+header. `host` selects a compatible Preview Session API host and defaults to
+the production host. Pass the same encoded `resourceResolution` value in the
+`previewSessionOptions` passed to `fetchPreviewSession` and
+`createLivePreviewClient` when the session references resources from other
+spaces. A missing session throws `NotFoundError`. Other request and response
+failures throw `PreviewSessionFetchError`.
+
+## Usage
+
+`createLivePreviewClient` returns a data source for a Preview Session. It opens
+the socket when the first listener subscribes and publishes each valid `next`
+payload as received. If you pass `initialPayload`, `getResult().data` returns
+it until a valid update arrives. Without `initialPayload`, the data starts as
+`undefined`.
+
+`getResult().error` is set when the live-preview connection fails. The last
+valid data remains available in `getResult().data`.
+
+A valid payload may omit the deprecated `viewports` field while the APIs migrate
+to flat design-property values.
+
+`sessionId` and `previewToken` are optional. The package opens a socket only when
+both values are provided. The caller supplies the session ID through
+`PreviewSessionOptions`.
+
+`sessionHost` is an optional WebSocket URL for the Preview Session service. It
+defaults to the production Contentful Session service. The SDK uses the URL as
+supplied, appends the subscription route, and sends `previewToken` as the
+encoded `access_token` query parameter. When provided, `resourceResolution` is
+sent as the encoded `resource_resolution` query parameter.
+
+When you use the package directly in a Contentful preview, connect the client's
+status subscription to `sendPreviewStatus`:
+
+```ts
+import { createLivePreviewClient, sendPreviewStatus } from '@contentful/experiences-live-preview';
+
+const client = createLivePreviewClient(previewSessionOptions);
+const unsubscribeStatus = client.subscribeStatus(sendPreviewStatus);
+const unsubscribe = client.subscribe(() => {
+  const experience = client.getResult().data;
+  if (experience) updatePreview(experience);
+});
+```
+
+This tells the Contentful app how to coordinate updates with the SDK. The
+subscription is required for this integration. Framework adapters set it up for
+you. Keep both unsubscribe functions and call them when the preview no longer
+uses the client.
+
+A valid `next` message replaces the current data atomically. The client keeps
+the last valid data when it receives malformed messages, server errors, or
+transport interruptions. Unknown message types are ignored. The `next` payload
+contains an `Experience`. Adapters can build on this source and reuse its socket
+and message handling. Other frameworks can use the same framework-neutral
+client.

package/dist/errors.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Thrown by `fetchPreviewSession` for a Preview Session fetch failure other
+ * than a missing session.
+ */
+declare class PreviewSessionFetchError extends Error {
+    readonly spaceId: string;
+    readonly environmentId: string;
+    readonly sessionId: string;
+    constructor(message: string, options: {
+        spaceId: string;
+        environmentId: string;
+        sessionId: string;
+        cause?: unknown;
+    });
+}
+declare class LivePreviewConnectionError extends Error {
+    constructor();
+}
+
+export { LivePreviewConnectionError, PreviewSessionFetchError };

package/dist/errors.js

@@ -0,0 +1,23 @@
+class PreviewSessionFetchError extends Error {
+  spaceId;
+  environmentId;
+  sessionId;
+  constructor(message, options) {
+    super(message, options.cause !== void 0 ? { cause: options.cause } : void 0);
+    this.name = "PreviewSessionFetchError";
+    this.spaceId = options.spaceId;
+    this.environmentId = options.environmentId;
+    this.sessionId = options.sessionId;
+  }
+}
+class LivePreviewConnectionError extends Error {
+  constructor() {
+    super("Live Preview connection failed.");
+    this.name = "LivePreviewConnectionError";
+  }
+}
+export {
+  LivePreviewConnectionError,
+  PreviewSessionFetchError
+};
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/errors.ts"],"sourcesContent":["/**\n * Thrown by `fetchPreviewSession` for a Preview Session fetch failure other\n * than a missing session.\n */\nexport class PreviewSessionFetchError extends Error {\n  readonly spaceId: string;\n  readonly environmentId: string;\n  readonly sessionId: string;\n\n  constructor(\n    message: string,\n    options: {\n      spaceId: string;\n      environmentId: string;\n      sessionId: string;\n      cause?: unknown;\n    }\n  ) {\n    super(message, options.cause !== undefined ? { cause: options.cause } : undefined);\n    this.name = 'PreviewSessionFetchError';\n    this.spaceId = options.spaceId;\n    this.environmentId = options.environmentId;\n    this.sessionId = options.sessionId;\n  }\n}\n\nexport class LivePreviewConnectionError extends Error {\n  constructor() {\n    super('Live Preview connection failed.');\n    this.name = 'LivePreviewConnectionError';\n  }\n}\n"],"mappings":"AAIO,MAAM,iCAAiC,MAAM;AAAA,EACzC;AAAA,EACA;AAAA,EACA;AAAA,EAET,YACE,SACA,SAMA;AACA,UAAM,SAAS,QAAQ,UAAU,SAAY,EAAE,OAAO,QAAQ,MAAM,IAAI,MAAS;AACjF,SAAK,OAAO;AACZ,SAAK,UAAU,QAAQ;AACvB,SAAK,gBAAgB,QAAQ;AAC7B,SAAK,YAAY,QAAQ;AAAA,EAC3B;AACF;AAEO,MAAM,mCAAmC,MAAM;AAAA,EACpD,cAAc;AACZ,UAAM,iCAAiC;AACvC,SAAK,OAAO;AAAA,EACd;AACF;","names":[]}

package/dist/experience-payload.d.ts

@@ -0,0 +1,7 @@
+import { ExperiencePayload } from '@contentful/experiences-sdk-core';
+
+declare function isRecord(value: unknown): value is Record<string, unknown>;
+declare function isExperiencePayload(value: unknown): value is ExperiencePayload;
+declare function isErrorPayload(value: unknown): boolean;
+
+export { isErrorPayload, isExperiencePayload, isRecord };

package/dist/experience-payload.js

@@ -0,0 +1,20 @@
+function isRecord(value) {
+  return typeof value === "object" && value !== null;
+}
+function isExperiencePayload(value) {
+  if (!isRecord(value) || !Array.isArray(value.nodes) || value.viewports !== void 0 && !Array.isArray(value.viewports)) {
+    return false;
+  }
+  const sys = value.sys;
+  return isRecord(sys) && !Array.isArray(sys) && sys.type === "Experience";
+}
+function isErrorPayload(value) {
+  if (!isRecord(value) || !isRecord(value.sys) || Array.isArray(value.sys)) return false;
+  return value.sys.type === "Error" && typeof value.sys.id === "string";
+}
+export {
+  isErrorPayload,
+  isExperiencePayload,
+  isRecord
+};
+//# sourceMappingURL=experience-payload.js.map

package/dist/experience-payload.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/experience-payload.ts"],"sourcesContent":["import type { ExperiencePayload } from '@contentful/experiences-sdk-core';\n\nexport function isRecord(value: unknown): value is Record<string, unknown> {\n  return typeof value === 'object' && value !== null;\n}\n\nexport function isExperiencePayload(value: unknown): value is ExperiencePayload {\n  if (\n    !isRecord(value) ||\n    !Array.isArray(value.nodes) ||\n    (value.viewports !== undefined && !Array.isArray(value.viewports))\n  ) {\n    return false;\n  }\n\n  const sys = value.sys;\n  return isRecord(sys) && !Array.isArray(sys) && sys.type === 'Experience';\n}\n\nexport function isErrorPayload(value: unknown): boolean {\n  if (!isRecord(value) || !isRecord(value.sys) || Array.isArray(value.sys)) return false;\n  return value.sys.type === 'Error' && typeof value.sys.id === 'string';\n}\n"],"mappings":"AAEO,SAAS,SAAS,OAAkD;AACzE,SAAO,OAAO,UAAU,YAAY,UAAU;AAChD;AAEO,SAAS,oBAAoB,OAA4C;AAC9E,MACE,CAAC,SAAS,KAAK,KACf,CAAC,MAAM,QAAQ,MAAM,KAAK,KACzB,MAAM,cAAc,UAAa,CAAC,MAAM,QAAQ,MAAM,SAAS,GAChE;AACA,WAAO;AAAA,EACT;AAEA,QAAM,MAAM,MAAM;AAClB,SAAO,SAAS,GAAG,KAAK,CAAC,MAAM,QAAQ,GAAG,KAAK,IAAI,SAAS;AAC9D;AAEO,SAAS,eAAe,OAAyB;AACtD,MAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,MAAM,GAAG,KAAK,MAAM,QAAQ,MAAM,GAAG,EAAG,QAAO;AACjF,SAAO,MAAM,IAAI,SAAS,WAAW,OAAO,MAAM,IAAI,OAAO;AAC/D;","names":[]}

package/dist/fetch-preview-session.d.ts

@@ -0,0 +1,28 @@
+import { ResolverConfig, PortableRenderPlan } from '@contentful/experiences-sdk-core';
+
+type PreviewSessionExperienceOptions = {
+    spaceId: string;
+    environmentId: string;
+    sessionId: string;
+    /**
+     * Opaque encoded resource-resolution value for referenced spaces.
+     */
+    resourceResolution?: string;
+};
+type PreviewSessionClientOptions = {
+    previewToken: string;
+    host?: string;
+};
+type PreviewSessionResolveOptions = {
+    config: ResolverConfig;
+    metadata?: Record<string, unknown>;
+    debug?: boolean;
+    initialViewportId?: string;
+};
+/**
+ * Fetches the current hydrated Experience for a Preview Session and resolves
+ * it into the renderer's PortableRenderPlan.
+ */
+declare function fetchPreviewSession(previewSessionOptions: PreviewSessionExperienceOptions, clientOptions: PreviewSessionClientOptions, resolveOptions: PreviewSessionResolveOptions): Promise<PortableRenderPlan>;
+
+export { type PreviewSessionClientOptions, type PreviewSessionExperienceOptions, type PreviewSessionResolveOptions, fetchPreviewSession };

package/dist/fetch-preview-session.js

@@ -0,0 +1,55 @@
+import { createClient, NotFoundError, PREVIEW_HOST } from "@contentful/experiences-client";
+import {
+  createDebugLogger,
+  resolveExperience
+} from "@contentful/experiences-sdk-core";
+import { PreviewSessionFetchError } from "./errors.js";
+import { isExperiencePayload } from "./experience-payload.js";
+import { previewSessionGetExperienceUrl } from "./preview-session-url.js";
+async function fetchPreviewSession(previewSessionOptions, clientOptions, resolveOptions) {
+  const { spaceId, environmentId, sessionId, resourceResolution } = previewSessionOptions;
+  const { previewToken, host } = clientOptions;
+  const { config, metadata, debug, initialViewportId } = resolveOptions;
+  const log = createDebugLogger(debug, "live-preview");
+  const client = createClient({
+    accessToken: previewToken,
+    host: host ?? PREVIEW_HOST
+  });
+  log.log("fetching preview session experience", { spaceId, environmentId, sessionId });
+  let payload;
+  try {
+    const response = await client.fetch(
+      previewSessionGetExperienceUrl({ ...previewSessionOptions, resourceResolution })
+    );
+    if (response.status === 404) {
+      throw new NotFoundError();
+    }
+    if (!response.ok) {
+      throw new Error(`HTTP ${response.status}`);
+    }
+    const responsePayload = await response.json();
+    if (!isExperiencePayload(responsePayload)) {
+      throw new Error("Response was not a valid Experience payload");
+    }
+    payload = responsePayload;
+  } catch (error) {
+    if (error instanceof NotFoundError) {
+      throw error;
+    }
+    const reason = error instanceof Error ? error.message : String(error);
+    throw new PreviewSessionFetchError(
+      `Failed to fetch Preview Session "${sessionId}" (space "${spaceId}", environment "${environmentId}"): ${reason}`,
+      { spaceId, environmentId, sessionId, cause: error }
+    );
+  }
+  log.lazy("received raw payload", () => payload);
+  return resolveExperience(payload, config, {
+    metadata,
+    debug,
+    initialViewportId
+  });
+}
+export {
+  fetchPreviewSession
+};
+//# sourceMappingURL=fetch-preview-session.js.map

package/dist/fetch-preview-session.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/fetch-preview-session.ts"],"sourcesContent":["import { createClient, NotFoundError, PREVIEW_HOST } from '@contentful/experiences-client';\nimport {\n  createDebugLogger,\n  resolveExperience,\n  type ExperiencePayload,\n  type PortableRenderPlan,\n  type ResolverConfig,\n} from '@contentful/experiences-sdk-core';\nimport { PreviewSessionFetchError } from './errors.js';\nimport { isExperiencePayload } from './experience-payload.js';\nimport { previewSessionGetExperienceUrl } from './preview-session-url.js';\n\nexport type PreviewSessionExperienceOptions = {\n  spaceId: string;\n  environmentId: string;\n  sessionId: string;\n  /**\n   * Opaque encoded resource-resolution value for referenced spaces.\n   */\n  resourceResolution?: string;\n};\n\nexport type PreviewSessionClientOptions = {\n  previewToken: string;\n  host?: string;\n};\n\nexport type PreviewSessionResolveOptions = {\n  config: ResolverConfig;\n  metadata?: Record<string, unknown>;\n  debug?: boolean;\n  initialViewportId?: string;\n};\n\n/**\n * Fetches the current hydrated Experience for a Preview Session and resolves\n * it into the renderer's PortableRenderPlan.\n */\nexport async function fetchPreviewSession(\n  previewSessionOptions: PreviewSessionExperienceOptions,\n  clientOptions: PreviewSessionClientOptions,\n  resolveOptions: PreviewSessionResolveOptions\n): Promise<PortableRenderPlan> {\n  const { spaceId, environmentId, sessionId, resourceResolution } = previewSessionOptions;\n  const { previewToken, host } = clientOptions;\n  const { config, metadata, debug, initialViewportId } = resolveOptions;\n  const log = createDebugLogger(debug, 'live-preview');\n  const client = createClient({\n    accessToken: previewToken,\n    host: host ?? PREVIEW_HOST,\n  });\n\n  log.log('fetching preview session experience', { spaceId, environmentId, sessionId });\n\n  let payload: ExperiencePayload;\n  try {\n    const response = await client.fetch(\n      previewSessionGetExperienceUrl({ ...previewSessionOptions, resourceResolution })\n    );\n    if (response.status === 404) {\n      throw new NotFoundError();\n    }\n    if (!response.ok) {\n      throw new Error(`HTTP ${response.status}`);\n    }\n\n    const responsePayload: unknown = await response.json();\n    if (!isExperiencePayload(responsePayload)) {\n      throw new Error('Response was not a valid Experience payload');\n    }\n    payload = responsePayload;\n  } catch (error) {\n    if (error instanceof NotFoundError) {\n      throw error;\n    }\n    const reason = error instanceof Error ? error.message : String(error);\n    throw new PreviewSessionFetchError(\n      `Failed to fetch Preview Session \"${sessionId}\" (space \"${spaceId}\", environment ` +\n        `\"${environmentId}\"): ${reason}`,\n      { spaceId, environmentId, sessionId, cause: error }\n    );\n  }\n\n  log.lazy('received raw payload', () => payload);\n\n  return resolveExperience(payload, config, {\n    metadata,\n    debug,\n    initialViewportId,\n  });\n}\n"],"mappings":"AAAA,SAAS,cAAc,eAAe,oBAAoB;AAC1D;AAAA,EACE;AAAA,EACA;AAAA,OAIK;AACP,SAAS,gCAAgC;AACzC,SAAS,2BAA2B;AACpC,SAAS,sCAAsC;AA4B/C,eAAsB,oBACpB,uBACA,eACA,gBAC6B;AAC7B,QAAM,EAAE,SAAS,eAAe,WAAW,mBAAmB,IAAI;AAClE,QAAM,EAAE,cAAc,KAAK,IAAI;AAC/B,QAAM,EAAE,QAAQ,UAAU,OAAO,kBAAkB,IAAI;AACvD,QAAM,MAAM,kBAAkB,OAAO,cAAc;AACnD,QAAM,SAAS,aAAa;AAAA,IAC1B,aAAa;AAAA,IACb,MAAM,QAAQ;AAAA,EAChB,CAAC;AAED,MAAI,IAAI,uCAAuC,EAAE,SAAS,eAAe,UAAU,CAAC;AAEpF,MAAI;AACJ,MAAI;AACF,UAAM,WAAW,MAAM,OAAO;AAAA,MAC5B,+BAA+B,EAAE,GAAG,uBAAuB,mBAAmB,CAAC;AAAA,IACjF;AACA,QAAI,SAAS,WAAW,KAAK;AAC3B,YAAM,IAAI,cAAc;AAAA,IAC1B;AACA,QAAI,CAAC,SAAS,IAAI;AAChB,YAAM,IAAI,MAAM,QAAQ,SAAS,MAAM,EAAE;AAAA,IAC3C;AAEA,UAAM,kBAA2B,MAAM,SAAS,KAAK;AACrD,QAAI,CAAC,oBAAoB,eAAe,GAAG;AACzC,YAAM,IAAI,MAAM,6CAA6C;AAAA,IAC/D;AACA,cAAU;AAAA,EACZ,SAAS,OAAO;AACd,QAAI,iBAAiB,eAAe;AAClC,YAAM;AAAA,IACR;AACA,UAAM,SAAS,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;AACpE,UAAM,IAAI;AAAA,MACR,oCAAoC,SAAS,aAAa,OAAO,mBAC3D,aAAa,OAAO,MAAM;AAAA,MAChC,EAAE,SAAS,eAAe,WAAW,OAAO,MAAM;AAAA,IACpD;AAAA,EACF;AAEA,MAAI,KAAK,wBAAwB,MAAM,OAAO;AAE9C,SAAO,kBAAkB,SAAS,QAAQ;AAAA,IACxC;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AACH;","names":[]}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export { LivePreviewClient, LivePreviewResult, LivePreviewStatus, createLivePreviewClient } from './live-preview-client.js';
+export { sendPreviewStatus } from './preview-status.js';
+export { PreviewSessionClientOptions, PreviewSessionExperienceOptions, PreviewSessionResolveOptions, fetchPreviewSession } from './fetch-preview-session.js';
+export { LivePreviewConnectionError, PreviewSessionFetchError } from './errors.js';
+export { NotFoundError, PREVIEW_WEBSOCKET_HOST } from '@contentful/experiences-client';
+export { PreviewSessionOptions } from './preview-session.js';
+import '@contentful/experiences-sdk-core';

package/dist/index.js

@@ -0,0 +1,16 @@
+import { createLivePreviewClient } from "./live-preview-client.js";
+import { sendPreviewStatus } from "./preview-status.js";
+import { fetchPreviewSession } from "./fetch-preview-session.js";
+import { LivePreviewConnectionError, PreviewSessionFetchError } from "./errors.js";
+import { PREVIEW_WEBSOCKET_HOST } from "@contentful/experiences-client";
+import { NotFoundError } from "@contentful/experiences-client";
+export {
+  LivePreviewConnectionError,
+  NotFoundError,
+  PREVIEW_WEBSOCKET_HOST,
+  PreviewSessionFetchError,
+  createLivePreviewClient,
+  fetchPreviewSession,
+  sendPreviewStatus
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export { createLivePreviewClient } from './live-preview-client.js';\nexport { sendPreviewStatus } from './preview-status.js';\nexport { fetchPreviewSession } from './fetch-preview-session.js';\nexport { LivePreviewConnectionError, PreviewSessionFetchError } from './errors.js';\nexport { PREVIEW_WEBSOCKET_HOST } from '@contentful/experiences-client';\nexport type {\n  LivePreviewClient,\n  LivePreviewResult,\n  LivePreviewStatus,\n} from './live-preview-client.js';\nexport type { PreviewSessionOptions } from './preview-session.js';\nexport type {\n  PreviewSessionClientOptions,\n  PreviewSessionExperienceOptions,\n  PreviewSessionResolveOptions,\n} from './fetch-preview-session.js';\nexport { NotFoundError } from '@contentful/experiences-client';\n"],"mappings":"AAAA,SAAS,+BAA+B;AACxC,SAAS,yBAAyB;AAClC,SAAS,2BAA2B;AACpC,SAAS,4BAA4B,gCAAgC;AACrE,SAAS,8BAA8B;AAYvC,SAAS,qBAAqB;","names":[]}

package/dist/live-preview-client.d.ts

@@ -0,0 +1,19 @@
+import { ExperiencePayload } from '@contentful/experiences-sdk-core';
+import { PreviewSessionOptions } from './preview-session.js';
+import './errors.js';
+
+type LivePreviewStatus = 'live' | 'static';
+type LivePreviewResult = {
+    readonly data: ExperiencePayload | undefined;
+    readonly error: Error | undefined;
+};
+type LivePreviewClient = {
+    getResult(): LivePreviewResult;
+    /** @deprecated Use getResult().data instead. */
+    getSnapshot(): ExperiencePayload | undefined;
+    subscribe(listener: () => void): () => void;
+    subscribeStatus(listener: (status: LivePreviewStatus) => void): () => void;
+};
+declare function createLivePreviewClient(previewSessionOptions: PreviewSessionOptions, initialPayload?: ExperiencePayload): LivePreviewClient;
+
+export { type LivePreviewClient, type LivePreviewResult, type LivePreviewStatus, createLivePreviewClient };

package/dist/live-preview-client.js

@@ -0,0 +1,73 @@
+import { subscribeToPreviewSession } from "./preview-session.js";
+function createLivePreviewClient(previewSessionOptions, initialPayload) {
+  const listeners = /* @__PURE__ */ new Set();
+  const statusListeners = /* @__PURE__ */ new Set();
+  const notifyListeners = () => {
+    for (const { handler } of [...listeners]) handler();
+  };
+  const hasLivePreviewOptions = previewSessionOptions.sessionId !== void 0 && previewSessionOptions.previewToken !== void 0;
+  let currentStatus = hasLivePreviewOptions ? void 0 : "static";
+  let currentResult = { data: initialPayload, error: void 0 };
+  let unsubscribeFromSession;
+  const updateData = (data) => {
+    currentResult = { ...currentResult, data };
+    notifyListeners();
+  };
+  const updateError = (error) => {
+    currentResult = { ...currentResult, error };
+    updateStatus("static");
+    notifyListeners();
+  };
+  const updateStatus = (status) => {
+    if (status === "live" && currentResult.error !== void 0) {
+      currentResult = { ...currentResult, error: void 0 };
+      notifyListeners();
+    }
+    if (currentStatus === status) return;
+    currentStatus = status;
+    for (const { handler } of [...statusListeners]) handler(status);
+  };
+  const closeSession = () => {
+    unsubscribeFromSession?.();
+    unsubscribeFromSession = void 0;
+    if (hasLivePreviewOptions) currentStatus = void 0;
+  };
+  return {
+    getResult: () => currentResult,
+    getSnapshot: () => currentResult.data,
+    subscribe(listener) {
+      const subscription = { handler: listener };
+      const isFirstSubscriber = listeners.size === 0;
+      listeners.add(subscription);
+      if (isFirstSubscriber) {
+        try {
+          unsubscribeFromSession = subscribeToPreviewSession(previewSessionOptions, {
+            onOpen: () => updateStatus("live"),
+            onError: updateError,
+            onUpdate: updateData
+          });
+        } catch (error) {
+          listeners.delete(subscription);
+          closeSession();
+          throw error;
+        }
+      }
+      return () => {
+        if (!listeners.delete(subscription)) return;
+        if (listeners.size === 0) closeSession();
+      };
+    },
+    subscribeStatus(listener) {
+      const subscription = { handler: listener };
+      statusListeners.add(subscription);
+      if (currentStatus !== void 0) listener(currentStatus);
+      return () => {
+        statusListeners.delete(subscription);
+      };
+    }
+  };
+}
+export {
+  createLivePreviewClient
+};
+//# sourceMappingURL=live-preview-client.js.map

package/dist/live-preview-client.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/live-preview-client.ts"],"sourcesContent":["import type { ExperiencePayload } from '@contentful/experiences-sdk-core';\nimport { subscribeToPreviewSession, type PreviewSessionOptions } from './preview-session.js';\n\nexport type LivePreviewStatus = 'live' | 'static';\n\nexport type LivePreviewResult = {\n  readonly data: ExperiencePayload | undefined;\n  readonly error: Error | undefined;\n};\n\nexport type LivePreviewClient = {\n  getResult(): LivePreviewResult;\n  /** @deprecated Use getResult().data instead. */\n  getSnapshot(): ExperiencePayload | undefined;\n  subscribe(listener: () => void): () => void;\n  subscribeStatus(listener: (status: LivePreviewStatus) => void): () => void;\n};\n\nexport function createLivePreviewClient(\n  previewSessionOptions: PreviewSessionOptions,\n  initialPayload?: ExperiencePayload\n): LivePreviewClient {\n  const listeners = new Set<{ handler: () => void }>();\n  const statusListeners = new Set<{ handler: (status: LivePreviewStatus) => void }>();\n  const notifyListeners = (): void => {\n    for (const { handler } of [...listeners]) handler();\n  };\n\n  const hasLivePreviewOptions =\n    previewSessionOptions.sessionId !== undefined &&\n    previewSessionOptions.previewToken !== undefined;\n  let currentStatus: LivePreviewStatus | undefined = hasLivePreviewOptions ? undefined : 'static';\n  let currentResult: LivePreviewResult = { data: initialPayload, error: undefined };\n  let unsubscribeFromSession: (() => void) | undefined;\n\n  const updateData = (data: ExperiencePayload): void => {\n    currentResult = { ...currentResult, data };\n    notifyListeners();\n  };\n\n  const updateError = (error: Error): void => {\n    currentResult = { ...currentResult, error };\n    updateStatus('static');\n    notifyListeners();\n  };\n\n  const updateStatus = (status: LivePreviewStatus): void => {\n    if (status === 'live' && currentResult.error !== undefined) {\n      currentResult = { ...currentResult, error: undefined };\n      notifyListeners();\n    }\n    if (currentStatus === status) return;\n    currentStatus = status;\n    for (const { handler } of [...statusListeners]) handler(status);\n  };\n\n  const closeSession = (): void => {\n    unsubscribeFromSession?.();\n    unsubscribeFromSession = undefined;\n    if (hasLivePreviewOptions) currentStatus = undefined;\n  };\n\n  return {\n    getResult: () => currentResult,\n    getSnapshot: () => currentResult.data,\n    subscribe(listener) {\n      const subscription = { handler: listener };\n      const isFirstSubscriber = listeners.size === 0;\n      listeners.add(subscription);\n      if (isFirstSubscriber) {\n        try {\n          unsubscribeFromSession = subscribeToPreviewSession(previewSessionOptions, {\n            onOpen: () => updateStatus('live'),\n            onError: updateError,\n            onUpdate: updateData,\n          });\n        } catch (error: unknown) {\n          listeners.delete(subscription);\n          closeSession();\n          throw error;\n        }\n      }\n\n      return () => {\n        if (!listeners.delete(subscription)) return;\n        if (listeners.size === 0) closeSession();\n      };\n    },\n    subscribeStatus(listener) {\n      const subscription = { handler: listener };\n      statusListeners.add(subscription);\n      if (currentStatus !== undefined) listener(currentStatus);\n\n      return () => {\n        statusListeners.delete(subscription);\n      };\n    },\n  };\n}\n"],"mappings":"AACA,SAAS,iCAA6D;AAiB/D,SAAS,wBACd,uBACA,gBACmB;AACnB,QAAM,YAAY,oBAAI,IAA6B;AACnD,QAAM,kBAAkB,oBAAI,IAAsD;AAClF,QAAM,kBAAkB,MAAY;AAClC,eAAW,EAAE,QAAQ,KAAK,CAAC,GAAG,SAAS,EAAG,SAAQ;AAAA,EACpD;AAEA,QAAM,wBACJ,sBAAsB,cAAc,UACpC,sBAAsB,iBAAiB;AACzC,MAAI,gBAA+C,wBAAwB,SAAY;AACvF,MAAI,gBAAmC,EAAE,MAAM,gBAAgB,OAAO,OAAU;AAChF,MAAI;AAEJ,QAAM,aAAa,CAAC,SAAkC;AACpD,oBAAgB,EAAE,GAAG,eAAe,KAAK;AACzC,oBAAgB;AAAA,EAClB;AAEA,QAAM,cAAc,CAAC,UAAuB;AAC1C,oBAAgB,EAAE,GAAG,eAAe,MAAM;AAC1C,iBAAa,QAAQ;AACrB,oBAAgB;AAAA,EAClB;AAEA,QAAM,eAAe,CAAC,WAAoC;AACxD,QAAI,WAAW,UAAU,cAAc,UAAU,QAAW;AAC1D,sBAAgB,EAAE,GAAG,eAAe,OAAO,OAAU;AACrD,sBAAgB;AAAA,IAClB;AACA,QAAI,kBAAkB,OAAQ;AAC9B,oBAAgB;AAChB,eAAW,EAAE,QAAQ,KAAK,CAAC,GAAG,eAAe,EAAG,SAAQ,MAAM;AAAA,EAChE;AAEA,QAAM,eAAe,MAAY;AAC/B,6BAAyB;AACzB,6BAAyB;AACzB,QAAI,sBAAuB,iBAAgB;AAAA,EAC7C;AAEA,SAAO;AAAA,IACL,WAAW,MAAM;AAAA,IACjB,aAAa,MAAM,cAAc;AAAA,IACjC,UAAU,UAAU;AAClB,YAAM,eAAe,EAAE,SAAS,SAAS;AACzC,YAAM,oBAAoB,UAAU,SAAS;AAC7C,gBAAU,IAAI,YAAY;AAC1B,UAAI,mBAAmB;AACrB,YAAI;AACF,mCAAyB,0BAA0B,uBAAuB;AAAA,YACxE,QAAQ,MAAM,aAAa,MAAM;AAAA,YACjC,SAAS;AAAA,YACT,UAAU;AAAA,UACZ,CAAC;AAAA,QACH,SAAS,OAAgB;AACvB,oBAAU,OAAO,YAAY;AAC7B,uBAAa;AACb,gBAAM;AAAA,QACR;AAAA,MACF;AAEA,aAAO,MAAM;AACX,YAAI,CAAC,UAAU,OAAO,YAAY,EAAG;AACrC,YAAI,UAAU,SAAS,EAAG,cAAa;AAAA,MACzC;AAAA,IACF;AAAA,IACA,gBAAgB,UAAU;AACxB,YAAM,eAAe,EAAE,SAAS,SAAS;AACzC,sBAAgB,IAAI,YAAY;AAChC,UAAI,kBAAkB,OAAW,UAAS,aAAa;AAEvD,aAAO,MAAM;AACX,wBAAgB,OAAO,YAAY;AAAA,MACrC;AAAA,IACF;AAAA,EACF;AACF;","names":[]}

package/dist/preview-session-url.d.ts

@@ -0,0 +1,15 @@
+type PreviewSessionRouteOptions = {
+    spaceId: string;
+    environmentId: string;
+    sessionId: string;
+};
+declare function previewSessionGetExperienceUrl({ resourceResolution, ...options }: PreviewSessionRouteOptions & {
+    resourceResolution?: string;
+}): string;
+declare function previewSessionSubscribeUrl({ spaceId, environmentId, sessionId, sessionHost, previewToken, resourceResolution, }: PreviewSessionRouteOptions & {
+    sessionHost?: string;
+    previewToken: string;
+    resourceResolution?: string;
+}): string;
+
+export { previewSessionGetExperienceUrl, previewSessionSubscribeUrl };

package/dist/preview-session-url.js

@@ -0,0 +1,44 @@
+import { PREVIEW_WEBSOCKET_HOST } from "@contentful/experiences-client";
+function previewSessionPath(options) {
+  return [
+    "spaces",
+    encodeURIComponent(options.spaceId),
+    "environments",
+    encodeURIComponent(options.environmentId),
+    "preview_sessions",
+    encodeURIComponent(options.sessionId)
+  ].join("/");
+}
+function previewSessionGetExperienceUrl({
+  resourceResolution,
+  ...options
+}) {
+  const path = `/${previewSessionPath(options)}/experience`;
+  if (resourceResolution === void 0) return path;
+  const searchParams = new globalThis.URLSearchParams({
+    resource_resolution: resourceResolution
+  });
+  return `${path}?${searchParams.toString()}`;
+}
+function previewSessionSubscribeUrl({
+  spaceId,
+  environmentId,
+  sessionId,
+  sessionHost,
+  previewToken,
+  resourceResolution
+}) {
+  const url = new globalThis.URL(sessionHost ?? PREVIEW_WEBSOCKET_HOST);
+  const basePath = url.pathname.replace(/\/+$/, "");
+  url.pathname = `${basePath}/${previewSessionPath({ spaceId, environmentId, sessionId })}/subscribe`;
+  url.searchParams.set("access_token", previewToken);
+  if (resourceResolution !== void 0) {
+    url.searchParams.set("resource_resolution", resourceResolution);
+  }
+  return url.toString();
+}
+export {
+  previewSessionGetExperienceUrl,
+  previewSessionSubscribeUrl
+};
+//# sourceMappingURL=preview-session-url.js.map

package/dist/preview-session-url.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/preview-session-url.ts"],"sourcesContent":["import { PREVIEW_WEBSOCKET_HOST } from '@contentful/experiences-client';\n\ntype PreviewSessionRouteOptions = {\n  spaceId: string;\n  environmentId: string;\n  sessionId: string;\n};\n\nfunction previewSessionPath(options: PreviewSessionRouteOptions): string {\n  return [\n    'spaces',\n    encodeURIComponent(options.spaceId),\n    'environments',\n    encodeURIComponent(options.environmentId),\n    'preview_sessions',\n    encodeURIComponent(options.sessionId),\n  ].join('/');\n}\n\nexport function previewSessionGetExperienceUrl({\n  resourceResolution,\n  ...options\n}: PreviewSessionRouteOptions & { resourceResolution?: string }): string {\n  const path = `/${previewSessionPath(options)}/experience`;\n  if (resourceResolution === undefined) return path;\n\n  const searchParams = new globalThis.URLSearchParams({\n    resource_resolution: resourceResolution,\n  });\n  return `${path}?${searchParams.toString()}`;\n}\n\nexport function previewSessionSubscribeUrl({\n  spaceId,\n  environmentId,\n  sessionId,\n  sessionHost,\n  previewToken,\n  resourceResolution,\n}: PreviewSessionRouteOptions & {\n  sessionHost?: string;\n  previewToken: string;\n  resourceResolution?: string;\n}): string {\n  const url = new globalThis.URL(sessionHost ?? PREVIEW_WEBSOCKET_HOST);\n  const basePath = url.pathname.replace(/\\/+$/, '');\n  url.pathname = `${basePath}/${previewSessionPath({ spaceId, environmentId, sessionId })}/subscribe`;\n  url.searchParams.set('access_token', previewToken);\n  if (resourceResolution !== undefined) {\n    url.searchParams.set('resource_resolution', resourceResolution);\n  }\n\n  return url.toString();\n}\n"],"mappings":"AAAA,SAAS,8BAA8B;AAQvC,SAAS,mBAAmB,SAA6C;AACvE,SAAO;AAAA,IACL;AAAA,IACA,mBAAmB,QAAQ,OAAO;AAAA,IAClC;AAAA,IACA,mBAAmB,QAAQ,aAAa;AAAA,IACxC;AAAA,IACA,mBAAmB,QAAQ,SAAS;AAAA,EACtC,EAAE,KAAK,GAAG;AACZ;AAEO,SAAS,+BAA+B;AAAA,EAC7C;AAAA,EACA,GAAG;AACL,GAAyE;AACvE,QAAM,OAAO,IAAI,mBAAmB,OAAO,CAAC;AAC5C,MAAI,uBAAuB,OAAW,QAAO;AAE7C,QAAM,eAAe,IAAI,WAAW,gBAAgB;AAAA,IAClD,qBAAqB;AAAA,EACvB,CAAC;AACD,SAAO,GAAG,IAAI,IAAI,aAAa,SAAS,CAAC;AAC3C;AAEO,SAAS,2BAA2B;AAAA,EACzC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAIW;AACT,QAAM,MAAM,IAAI,WAAW,IAAI,eAAe,sBAAsB;AACpE,QAAM,WAAW,IAAI,SAAS,QAAQ,QAAQ,EAAE;AAChD,MAAI,WAAW,GAAG,QAAQ,IAAI,mBAAmB,EAAE,SAAS,eAAe,UAAU,CAAC,CAAC;AACvF,MAAI,aAAa,IAAI,gBAAgB,YAAY;AACjD,MAAI,uBAAuB,QAAW;AACpC,QAAI,aAAa,IAAI,uBAAuB,kBAAkB;AAAA,EAChE;AAEA,SAAO,IAAI,SAAS;AACtB;","names":[]}

package/dist/preview-session.d.ts

@@ -0,0 +1,27 @@
+import { ExperiencePayload } from '@contentful/experiences-sdk-core';
+import { LivePreviewConnectionError } from './errors.js';
+
+type PreviewSessionOptions = {
+    spaceId: string;
+    environmentId: string;
+    previewToken?: string;
+    sessionId?: string;
+    /**
+     * Opaque encoded resource-resolution value for referenced spaces.
+     */
+    resourceResolution?: string;
+    /**
+     * Custom WebSocket URL for Preview Session subscriptions (staging, proxy, per-region).
+     * Omit to use the production Preview Session WebSocket host.
+     */
+    sessionHost?: string;
+    debug?: boolean;
+};
+type PreviewSessionHandlers = {
+    onUpdate: (experience: ExperiencePayload) => void;
+    onOpen?: () => void;
+    onError?: (error: LivePreviewConnectionError) => void;
+};
+declare function subscribeToPreviewSession(options: PreviewSessionOptions, handlers: PreviewSessionHandlers): () => void;
+
+export { type PreviewSessionOptions, subscribeToPreviewSession };

package/dist/preview-session.js

@@ -0,0 +1,74 @@
+import { createDebugLogger } from "@contentful/experiences-sdk-core";
+import { isErrorPayload, isExperiencePayload, isRecord } from "./experience-payload.js";
+import { createWebSocketConnection } from "./websocket.js";
+import { previewSessionSubscribeUrl } from "./preview-session-url.js";
+import { LivePreviewConnectionError } from "./errors.js";
+const RETRY_DELAYS_MS = [100, 500, 1e3];
+function parseMessage(data) {
+  let message = data;
+  if (typeof data === "string") {
+    try {
+      message = JSON.parse(data);
+    } catch {
+      return { kind: "invalid" };
+    }
+  }
+  if (!isRecord(message) || typeof message.type !== "string") {
+    return { kind: "invalid" };
+  }
+  if (message.type === "next") {
+    return isExperiencePayload(message.data) ? { kind: "next", payload: message.data } : { kind: "invalid" };
+  }
+  if (message.type === "error") {
+    return isErrorPayload(message.data) ? { kind: "error" } : { kind: "invalid" };
+  }
+  return { kind: "unknown" };
+}
+function isSessionEnded(event) {
+  if (event.code !== 1e3) return false;
+  const reason = event.reason.trim().toLowerCase();
+  return reason === "deleted" || reason === "expired";
+}
+function subscribeToPreviewSession(options, handlers) {
+  const log = createDebugLogger(options.debug, "live-preview");
+  const { sessionId, previewToken } = options;
+  const { onError, onOpen, onUpdate } = handlers;
+  if (sessionId === void 0 || previewToken === void 0) return () => void 0;
+  const connection = createWebSocketConnection({
+    url: previewSessionSubscribeUrl({ ...options, sessionId, previewToken }),
+    retry: (failureCount, event) => {
+      const sessionEnded = isSessionEnded(event);
+      const hasExhaustedRetries = failureCount >= RETRY_DELAYS_MS.length;
+      const shouldRetry = !hasExhaustedRetries && !sessionEnded;
+      if (hasExhaustedRetries || sessionEnded) {
+        onError?.(new LivePreviewConnectionError());
+      }
+      return shouldRetry;
+    },
+    retryDelay: (retryAttempt) => RETRY_DELAYS_MS[retryAttempt] ?? RETRY_DELAYS_MS[RETRY_DELAYS_MS.length - 1] ?? 0,
+    onFailure: () => onError?.(new LivePreviewConnectionError())
+  });
+  const unsubscribeFromOpen = onOpen ? connection.onopen(() => onOpen()) : void 0;
+  const unsubscribe = connection.onmessage((event) => {
+    const message = parseMessage(event.data);
+    if (message.kind === "unknown") return;
+    if (message.kind === "error") {
+      log.log("Preview Session returned an error");
+      return;
+    }
+    if (message.kind === "invalid") {
+      log.log("ignored invalid Preview Session message");
+      return;
+    }
+    onUpdate(message.payload);
+  });
+  return () => {
+    unsubscribeFromOpen?.();
+    unsubscribe();
+    connection.close();
+  };
+}
+export {
+  subscribeToPreviewSession
+};
+//# sourceMappingURL=preview-session.js.map

package/dist/preview-session.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/preview-session.ts"],"sourcesContent":["import { createDebugLogger, type ExperiencePayload } from '@contentful/experiences-sdk-core';\nimport { isErrorPayload, isExperiencePayload, isRecord } from './experience-payload.js';\nimport { createWebSocketConnection, type WebSocketCloseEvent } from './websocket.js';\nimport { previewSessionSubscribeUrl } from './preview-session-url.js';\nimport { LivePreviewConnectionError } from './errors.js';\n\nconst RETRY_DELAYS_MS: readonly number[] = [100, 500, 1000];\n\nexport type PreviewSessionOptions = {\n  spaceId: string;\n  environmentId: string;\n  previewToken?: string;\n  sessionId?: string;\n  /**\n   * Opaque encoded resource-resolution value for referenced spaces.\n   */\n  resourceResolution?: string;\n  /**\n   * Custom WebSocket URL for Preview Session subscriptions (staging, proxy, per-region).\n   * Omit to use the production Preview Session WebSocket host.\n   */\n  sessionHost?: string;\n  debug?: boolean;\n};\n\ntype SessionMessage =\n  | { kind: 'next'; payload: ExperiencePayload }\n  | { kind: 'error' }\n  | { kind: 'unknown' }\n  | { kind: 'invalid' };\n\ntype PreviewSessionHandlers = {\n  onUpdate: (experience: ExperiencePayload) => void;\n  onOpen?: () => void;\n  onError?: (error: LivePreviewConnectionError) => void;\n};\n\nfunction parseMessage(data: unknown): SessionMessage {\n  let message: unknown = data;\n\n  if (typeof data === 'string') {\n    try {\n      message = JSON.parse(data);\n    } catch {\n      return { kind: 'invalid' };\n    }\n  }\n\n  if (!isRecord(message) || typeof message.type !== 'string') {\n    return { kind: 'invalid' };\n  }\n\n  if (message.type === 'next') {\n    return isExperiencePayload(message.data)\n      ? { kind: 'next', payload: message.data }\n      : { kind: 'invalid' };\n  }\n\n  if (message.type === 'error') {\n    return isErrorPayload(message.data) ? { kind: 'error' } : { kind: 'invalid' };\n  }\n\n  return { kind: 'unknown' };\n}\n\nfunction isSessionEnded(event: WebSocketCloseEvent): boolean {\n  if (event.code !== 1000) return false;\n  const reason = event.reason.trim().toLowerCase();\n  return reason === 'deleted' || reason === 'expired';\n}\n\nexport function subscribeToPreviewSession(\n  options: PreviewSessionOptions,\n  handlers: PreviewSessionHandlers\n): () => void {\n  const log = createDebugLogger(options.debug, 'live-preview');\n  const { sessionId, previewToken } = options;\n  const { onError, onOpen, onUpdate } = handlers;\n  if (sessionId === undefined || previewToken === undefined) return () => undefined;\n\n  const connection = createWebSocketConnection({\n    url: previewSessionSubscribeUrl({ ...options, sessionId, previewToken }),\n    retry: (failureCount, event) => {\n      const sessionEnded = isSessionEnded(event);\n      const hasExhaustedRetries = failureCount >= RETRY_DELAYS_MS.length;\n      const shouldRetry = !hasExhaustedRetries && !sessionEnded;\n      if (hasExhaustedRetries || sessionEnded) {\n        onError?.(new LivePreviewConnectionError());\n      }\n      return shouldRetry;\n    },\n    retryDelay: (retryAttempt) =>\n      RETRY_DELAYS_MS[retryAttempt] ?? RETRY_DELAYS_MS[RETRY_DELAYS_MS.length - 1] ?? 0,\n    onFailure: () => onError?.(new LivePreviewConnectionError()),\n  });\n\n  const unsubscribeFromOpen = onOpen ? connection.onopen(() => onOpen()) : undefined;\n  const unsubscribe = connection.onmessage((event) => {\n    const message = parseMessage(event.data);\n\n    if (message.kind === 'unknown') return;\n    if (message.kind === 'error') {\n      log.log('Preview Session returned an error');\n      return;\n    }\n    if (message.kind === 'invalid') {\n      log.log('ignored invalid Preview Session message');\n      return;\n    }\n\n    onUpdate(message.payload);\n  });\n\n  return () => {\n    unsubscribeFromOpen?.();\n    unsubscribe();\n    connection.close();\n  };\n}\n"],"mappings":"AAAA,SAAS,yBAAiD;AAC1D,SAAS,gBAAgB,qBAAqB,gBAAgB;AAC9D,SAAS,iCAA2D;AACpE,SAAS,kCAAkC;AAC3C,SAAS,kCAAkC;AAE3C,MAAM,kBAAqC,CAAC,KAAK,KAAK,GAAI;AA+B1D,SAAS,aAAa,MAA+B;AACnD,MAAI,UAAmB;AAEvB,MAAI,OAAO,SAAS,UAAU;AAC5B,QAAI;AACF,gBAAU,KAAK,MAAM,IAAI;AAAA,IAC3B,QAAQ;AACN,aAAO,EAAE,MAAM,UAAU;AAAA,IAC3B;AAAA,EACF;AAEA,MAAI,CAAC,SAAS,OAAO,KAAK,OAAO,QAAQ,SAAS,UAAU;AAC1D,WAAO,EAAE,MAAM,UAAU;AAAA,EAC3B;AAEA,MAAI,QAAQ,SAAS,QAAQ;AAC3B,WAAO,oBAAoB,QAAQ,IAAI,IACnC,EAAE,MAAM,QAAQ,SAAS,QAAQ,KAAK,IACtC,EAAE,MAAM,UAAU;AAAA,EACxB;AAEA,MAAI,QAAQ,SAAS,SAAS;AAC5B,WAAO,eAAe,QAAQ,IAAI,IAAI,EAAE,MAAM,QAAQ,IAAI,EAAE,MAAM,UAAU;AAAA,EAC9E;AAEA,SAAO,EAAE,MAAM,UAAU;AAC3B;AAEA,SAAS,eAAe,OAAqC;AAC3D,MAAI,MAAM,SAAS,IAAM,QAAO;AAChC,QAAM,SAAS,MAAM,OAAO,KAAK,EAAE,YAAY;AAC/C,SAAO,WAAW,aAAa,WAAW;AAC5C;AAEO,SAAS,0BACd,SACA,UACY;AACZ,QAAM,MAAM,kBAAkB,QAAQ,OAAO,cAAc;AAC3D,QAAM,EAAE,WAAW,aAAa,IAAI;AACpC,QAAM,EAAE,SAAS,QAAQ,SAAS,IAAI;AACtC,MAAI,cAAc,UAAa,iBAAiB,OAAW,QAAO,MAAM;AAExE,QAAM,aAAa,0BAA0B;AAAA,IAC3C,KAAK,2BAA2B,EAAE,GAAG,SAAS,WAAW,aAAa,CAAC;AAAA,IACvE,OAAO,CAAC,cAAc,UAAU;AAC9B,YAAM,eAAe,eAAe,KAAK;AACzC,YAAM,sBAAsB,gBAAgB,gBAAgB;AAC5D,YAAM,cAAc,CAAC,uBAAuB,CAAC;AAC7C,UAAI,uBAAuB,cAAc;AACvC,kBAAU,IAAI,2BAA2B,CAAC;AAAA,MAC5C;AACA,aAAO;AAAA,IACT;AAAA,IACA,YAAY,CAAC,iBACX,gBAAgB,YAAY,KAAK,gBAAgB,gBAAgB,SAAS,CAAC,KAAK;AAAA,IAClF,WAAW,MAAM,UAAU,IAAI,2BAA2B,CAAC;AAAA,EAC7D,CAAC;AAED,QAAM,sBAAsB,SAAS,WAAW,OAAO,MAAM,OAAO,CAAC,IAAI;AACzE,QAAM,cAAc,WAAW,UAAU,CAAC,UAAU;AAClD,UAAM,UAAU,aAAa,MAAM,IAAI;AAEvC,QAAI,QAAQ,SAAS,UAAW;AAChC,QAAI,QAAQ,SAAS,SAAS;AAC5B,UAAI,IAAI,mCAAmC;AAC3C;AAAA,IACF;AACA,QAAI,QAAQ,SAAS,WAAW;AAC9B,UAAI,IAAI,yCAAyC;AACjD;AAAA,IACF;AAEA,aAAS,QAAQ,OAAO;AAAA,EAC1B,CAAC;AAED,SAAO,MAAM;AACX,0BAAsB;AACtB,gBAAY;AACZ,eAAW,MAAM;AAAA,EACnB;AACF;","names":[]}

package/dist/preview-status.d.ts

@@ -0,0 +1,8 @@
+import { LivePreviewStatus } from './live-preview-client.js';
+import '@contentful/experiences-sdk-core';
+import './preview-session.js';
+import './errors.js';
+
+declare function sendPreviewStatus(status: LivePreviewStatus): void;
+
+export { sendPreviewStatus };

package/dist/preview-status.js

@@ -0,0 +1,18 @@
+const PREVIEW_STATUS_MESSAGE = {
+  source: "experiences/live-preview",
+  type: "status"
+};
+function sendPreviewStatus(status) {
+  if (typeof window === "undefined") return;
+  window.parent?.postMessage(
+    {
+      ...PREVIEW_STATUS_MESSAGE,
+      status
+    },
+    "*"
+  );
+}
+export {
+  sendPreviewStatus
+};
+//# sourceMappingURL=preview-status.js.map

package/dist/preview-status.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/preview-status.ts"],"sourcesContent":["import type { LivePreviewStatus } from './live-preview-client.js';\n\nconst PREVIEW_STATUS_MESSAGE = {\n  source: 'experiences/live-preview',\n  type: 'status',\n} as const;\n\nexport function sendPreviewStatus(status: LivePreviewStatus): void {\n  if (typeof window === 'undefined') return;\n\n  window.parent?.postMessage(\n    {\n      ...PREVIEW_STATUS_MESSAGE,\n      status,\n    },\n    '*'\n  );\n}\n"],"mappings":"AAEA,MAAM,yBAAyB;AAAA,EAC7B,QAAQ;AAAA,EACR,MAAM;AACR;AAEO,SAAS,kBAAkB,QAAiC;AACjE,MAAI,OAAO,WAAW,YAAa;AAEnC,SAAO,QAAQ;AAAA,IACb;AAAA,MACE,GAAG;AAAA,MACH;AAAA,IACF;AAAA,IACA;AAAA,EACF;AACF;","names":[]}

package/dist/websocket.d.ts

@@ -0,0 +1,31 @@
+type WebSocketCloseEvent = {
+    readonly code: number;
+    readonly reason: string;
+};
+type WebSocketOpenEvent = {
+    readonly type: string;
+};
+type WebSocketMessageEvent = {
+    readonly data: unknown;
+};
+type WebSocket = {
+    onopen: ((event: WebSocketOpenEvent) => void) | null;
+    onclose: ((event: WebSocketCloseEvent) => void) | null;
+    onmessage: ((event: WebSocketMessageEvent) => void) | null;
+    close(): void;
+};
+type WebSocketConstructor = new (url: string) => WebSocket;
+type WebSocketConnection = {
+    close(): void;
+    onopen(handler: (event: WebSocketOpenEvent) => void): () => void;
+    onmessage(handler: (event: WebSocketMessageEvent) => void): () => void;
+};
+declare function createWebSocketConnection(options: {
+    url: string;
+    retry?: number | ((failureCount: number, event: WebSocketCloseEvent) => boolean);
+    retryDelay?: number | ((retryAttempt: number, event: WebSocketCloseEvent) => number);
+    WebSocket?: WebSocketConstructor;
+    onFailure?: (error: unknown) => void;
+}): WebSocketConnection;
+
+export { type WebSocketCloseEvent, type WebSocketMessageEvent, type WebSocketOpenEvent, createWebSocketConnection };

package/dist/websocket.js

@@ -0,0 +1,128 @@
+function createWebSocketConnection(options) {
+  const WS = options.WebSocket ?? globalThis.WebSocket;
+  if (!WS) throw new Error("WebSocket constructor is not available in this runtime.");
+  let websocket;
+  let retryTimer;
+  let retryCount = 0;
+  let closed = false;
+  const openHandlers = /* @__PURE__ */ new Set();
+  const messageHandlers = /* @__PURE__ */ new Set();
+  const clearRetryTimer = () => {
+    if (retryTimer === void 0) return;
+    clearTimeout(retryTimer);
+    retryTimer = void 0;
+  };
+  const clearHandlers = () => {
+    openHandlers.clear();
+    messageHandlers.clear();
+  };
+  const detachSocketHandlers = (currentSocket) => {
+    currentSocket.onopen = null;
+    currentSocket.onmessage = null;
+    currentSocket.onclose = null;
+  };
+  const shouldRetry = (event) => {
+    if (closed) return false;
+    if (typeof options.retry === "number") return retryCount < options.retry;
+    if (typeof options.retry === "function") return options.retry(retryCount, event);
+    return false;
+  };
+  const getRetryDelay = (event) => {
+    if (typeof options.retryDelay === "function") {
+      return options.retryDelay(retryCount, event);
+    }
+    return options.retryDelay ?? 0;
+  };
+  const handleClose = (currentSocket, event) => {
+    if (websocket !== currentSocket) return;
+    websocket = void 0;
+    detachSocketHandlers(currentSocket);
+    if (closed || !shouldRetry(event)) {
+      closed = true;
+      clearHandlers();
+      return;
+    }
+    const delay = getRetryDelay(event);
+    retryCount += 1;
+    retryTimer = setTimeout(() => {
+      retryTimer = void 0;
+      if (closed) return;
+      try {
+        connect();
+      } catch (error) {
+        closed = true;
+        clearHandlers();
+        options.onFailure?.(error);
+      }
+    }, delay);
+  };
+  const connect = () => {
+    if (closed || websocket !== void 0 || retryTimer !== void 0) return;
+    const ws = new WS(options.url);
+    websocket = ws;
+    ws.onclose = (event) => handleClose(ws, event);
+    ws.onopen = (event) => {
+      if (websocket !== ws || closed) return;
+      let handlerError;
+      let hasHandlerError = false;
+      for (const handler of [...openHandlers]) {
+        try {
+          handler(event);
+        } catch (error) {
+          if (!hasHandlerError) handlerError = error;
+          hasHandlerError = true;
+        }
+      }
+      if (hasHandlerError) throw handlerError;
+    };
+    ws.onmessage = (event) => {
+      if (websocket !== ws || closed) return;
+      let handlerError;
+      let hasHandlerError = false;
+      for (const handler of [...messageHandlers]) {
+        try {
+          handler(event);
+        } catch (error) {
+          if (!hasHandlerError) handlerError = error;
+          hasHandlerError = true;
+        }
+      }
+      if (hasHandlerError) throw handlerError;
+    };
+  };
+  const connection = {
+    close() {
+      if (closed) return;
+      closed = true;
+      clearRetryTimer();
+      const currentSocket = websocket;
+      if (!currentSocket) {
+        clearHandlers();
+        return;
+      }
+      detachSocketHandlers(currentSocket);
+      clearHandlers();
+      currentSocket.close();
+    },
+    onopen(handler) {
+      if (closed) return () => void 0;
+      openHandlers.add(handler);
+      return () => {
+        openHandlers.delete(handler);
+      };
+    },
+    onmessage(handler) {
+      if (closed) return () => void 0;
+      messageHandlers.add(handler);
+      return () => {
+        messageHandlers.delete(handler);
+      };
+    }
+  };
+  connect();
+  return connection;
+}
+export {
+  createWebSocketConnection
+};
+//# sourceMappingURL=websocket.js.map

package/dist/websocket.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/websocket.ts"],"sourcesContent":["export type WebSocketCloseEvent = {\n  readonly code: number;\n  readonly reason: string;\n};\n\nexport type WebSocketOpenEvent = {\n  readonly type: string;\n};\n\nexport type WebSocketMessageEvent = {\n  readonly data: unknown;\n};\n\ntype WebSocket = {\n  onopen: ((event: WebSocketOpenEvent) => void) | null;\n  onclose: ((event: WebSocketCloseEvent) => void) | null;\n  onmessage: ((event: WebSocketMessageEvent) => void) | null;\n  close(): void;\n};\n\ntype WebSocketConstructor = new (url: string) => WebSocket;\n\ntype WebSocketConnection = {\n  close(): void;\n  onopen(handler: (event: WebSocketOpenEvent) => void): () => void;\n  onmessage(handler: (event: WebSocketMessageEvent) => void): () => void;\n};\n\nexport function createWebSocketConnection(options: {\n  url: string;\n  retry?: number | ((failureCount: number, event: WebSocketCloseEvent) => boolean);\n  retryDelay?: number | ((retryAttempt: number, event: WebSocketCloseEvent) => number);\n  WebSocket?: WebSocketConstructor;\n  onFailure?: (error: unknown) => void;\n}): WebSocketConnection {\n  const WS = options.WebSocket ?? (globalThis.WebSocket as WebSocketConstructor | undefined);\n  if (!WS) throw new Error('WebSocket constructor is not available in this runtime.');\n\n  let websocket: WebSocket | undefined;\n  let retryTimer: ReturnType<typeof setTimeout> | undefined;\n  let retryCount = 0;\n  let closed = false;\n\n  const openHandlers = new Set<(event: WebSocketOpenEvent) => void>();\n  const messageHandlers = new Set<(event: WebSocketMessageEvent) => void>();\n\n  const clearRetryTimer = () => {\n    if (retryTimer === undefined) return;\n    clearTimeout(retryTimer);\n    retryTimer = undefined;\n  };\n\n  const clearHandlers = () => {\n    openHandlers.clear();\n    messageHandlers.clear();\n  };\n\n  const detachSocketHandlers = (currentSocket: WebSocket) => {\n    currentSocket.onopen = null;\n    currentSocket.onmessage = null;\n    currentSocket.onclose = null;\n  };\n\n  const shouldRetry = (event: WebSocketCloseEvent) => {\n    if (closed) return false;\n    if (typeof options.retry === 'number') return retryCount < options.retry;\n    if (typeof options.retry === 'function') return options.retry(retryCount, event);\n    return false;\n  };\n\n  const getRetryDelay = (event: WebSocketCloseEvent) => {\n    if (typeof options.retryDelay === 'function') {\n      return options.retryDelay(retryCount, event);\n    }\n    return options.retryDelay ?? 0;\n  };\n\n  const handleClose = (currentSocket: WebSocket, event: WebSocketCloseEvent) => {\n    if (websocket !== currentSocket) return;\n\n    websocket = undefined;\n    detachSocketHandlers(currentSocket);\n\n    if (closed || !shouldRetry(event)) {\n      closed = true;\n      clearHandlers();\n      return;\n    }\n\n    const delay = getRetryDelay(event);\n    retryCount += 1;\n    retryTimer = setTimeout(() => {\n      retryTimer = undefined;\n      if (closed) return;\n      try {\n        connect();\n      } catch (error: unknown) {\n        closed = true;\n        clearHandlers();\n        options.onFailure?.(error);\n      }\n    }, delay);\n  };\n\n  const connect = () => {\n    if (closed || websocket !== undefined || retryTimer !== undefined) return;\n\n    const ws = new WS(options.url);\n    websocket = ws;\n    ws.onclose = (event) => handleClose(ws, event);\n    ws.onopen = (event) => {\n      if (websocket !== ws || closed) return;\n\n      let handlerError: unknown;\n      let hasHandlerError = false;\n\n      for (const handler of [...openHandlers]) {\n        try {\n          handler(event);\n        } catch (error: unknown) {\n          if (!hasHandlerError) handlerError = error;\n          hasHandlerError = true;\n        }\n      }\n\n      if (hasHandlerError) throw handlerError;\n    };\n    ws.onmessage = (event) => {\n      if (websocket !== ws || closed) return;\n\n      let handlerError: unknown;\n      let hasHandlerError = false;\n\n      for (const handler of [...messageHandlers]) {\n        try {\n          handler(event);\n        } catch (error: unknown) {\n          if (!hasHandlerError) handlerError = error;\n          hasHandlerError = true;\n        }\n      }\n\n      if (hasHandlerError) throw handlerError;\n    };\n  };\n\n  const connection: WebSocketConnection = {\n    close() {\n      if (closed) return;\n      closed = true;\n      clearRetryTimer();\n\n      const currentSocket = websocket;\n      if (!currentSocket) {\n        clearHandlers();\n        return;\n      }\n\n      detachSocketHandlers(currentSocket);\n      clearHandlers();\n      currentSocket.close();\n    },\n    onopen(handler) {\n      if (closed) return () => undefined;\n\n      openHandlers.add(handler);\n      return () => {\n        openHandlers.delete(handler);\n      };\n    },\n    onmessage(handler) {\n      if (closed) return () => undefined;\n\n      messageHandlers.add(handler);\n      return () => {\n        messageHandlers.delete(handler);\n      };\n    },\n  };\n\n  connect();\n  return connection;\n}\n"],"mappings":"AA4BO,SAAS,0BAA0B,SAMlB;AACtB,QAAM,KAAK,QAAQ,aAAc,WAAW;AAC5C,MAAI,CAAC,GAAI,OAAM,IAAI,MAAM,yDAAyD;AAElF,MAAI;AACJ,MAAI;AACJ,MAAI,aAAa;AACjB,MAAI,SAAS;AAEb,QAAM,eAAe,oBAAI,IAAyC;AAClE,QAAM,kBAAkB,oBAAI,IAA4C;AAExE,QAAM,kBAAkB,MAAM;AAC5B,QAAI,eAAe,OAAW;AAC9B,iBAAa,UAAU;AACvB,iBAAa;AAAA,EACf;AAEA,QAAM,gBAAgB,MAAM;AAC1B,iBAAa,MAAM;AACnB,oBAAgB,MAAM;AAAA,EACxB;AAEA,QAAM,uBAAuB,CAAC,kBAA6B;AACzD,kBAAc,SAAS;AACvB,kBAAc,YAAY;AAC1B,kBAAc,UAAU;AAAA,EAC1B;AAEA,QAAM,cAAc,CAAC,UAA+B;AAClD,QAAI,OAAQ,QAAO;AACnB,QAAI,OAAO,QAAQ,UAAU,SAAU,QAAO,aAAa,QAAQ;AACnE,QAAI,OAAO,QAAQ,UAAU,WAAY,QAAO,QAAQ,MAAM,YAAY,KAAK;AAC/E,WAAO;AAAA,EACT;AAEA,QAAM,gBAAgB,CAAC,UAA+B;AACpD,QAAI,OAAO,QAAQ,eAAe,YAAY;AAC5C,aAAO,QAAQ,WAAW,YAAY,KAAK;AAAA,IAC7C;AACA,WAAO,QAAQ,cAAc;AAAA,EAC/B;AAEA,QAAM,cAAc,CAAC,eAA0B,UAA+B;AAC5E,QAAI,cAAc,cAAe;AAEjC,gBAAY;AACZ,yBAAqB,aAAa;AAElC,QAAI,UAAU,CAAC,YAAY,KAAK,GAAG;AACjC,eAAS;AACT,oBAAc;AACd;AAAA,IACF;AAEA,UAAM,QAAQ,cAAc,KAAK;AACjC,kBAAc;AACd,iBAAa,WAAW,MAAM;AAC5B,mBAAa;AACb,UAAI,OAAQ;AACZ,UAAI;AACF,gBAAQ;AAAA,MACV,SAAS,OAAgB;AACvB,iBAAS;AACT,sBAAc;AACd,gBAAQ,YAAY,KAAK;AAAA,MAC3B;AAAA,IACF,GAAG,KAAK;AAAA,EACV;AAEA,QAAM,UAAU,MAAM;AACpB,QAAI,UAAU,cAAc,UAAa,eAAe,OAAW;AAEnE,UAAM,KAAK,IAAI,GAAG,QAAQ,GAAG;AAC7B,gBAAY;AACZ,OAAG,UAAU,CAAC,UAAU,YAAY,IAAI,KAAK;AAC7C,OAAG,SAAS,CAAC,UAAU;AACrB,UAAI,cAAc,MAAM,OAAQ;AAEhC,UAAI;AACJ,UAAI,kBAAkB;AAEtB,iBAAW,WAAW,CAAC,GAAG,YAAY,GAAG;AACvC,YAAI;AACF,kBAAQ,KAAK;AAAA,QACf,SAAS,OAAgB;AACvB,cAAI,CAAC,gBAAiB,gBAAe;AACrC,4BAAkB;AAAA,QACpB;AAAA,MACF;AAEA,UAAI,gBAAiB,OAAM;AAAA,IAC7B;AACA,OAAG,YAAY,CAAC,UAAU;AACxB,UAAI,cAAc,MAAM,OAAQ;AAEhC,UAAI;AACJ,UAAI,kBAAkB;AAEtB,iBAAW,WAAW,CAAC,GAAG,eAAe,GAAG;AAC1C,YAAI;AACF,kBAAQ,KAAK;AAAA,QACf,SAAS,OAAgB;AACvB,cAAI,CAAC,gBAAiB,gBAAe;AACrC,4BAAkB;AAAA,QACpB;AAAA,MACF;AAEA,UAAI,gBAAiB,OAAM;AAAA,IAC7B;AAAA,EACF;AAEA,QAAM,aAAkC;AAAA,IACtC,QAAQ;AACN,UAAI,OAAQ;AACZ,eAAS;AACT,sBAAgB;AAEhB,YAAM,gBAAgB;AACtB,UAAI,CAAC,eAAe;AAClB,sBAAc;AACd;AAAA,MACF;AAEA,2BAAqB,aAAa;AAClC,oBAAc;AACd,oBAAc,MAAM;AAAA,IACtB;AAAA,IACA,OAAO,SAAS;AACd,UAAI,OAAQ,QAAO,MAAM;AAEzB,mBAAa,IAAI,OAAO;AACxB,aAAO,MAAM;AACX,qBAAa,OAAO,OAAO;AAAA,MAC7B;AAAA,IACF;AAAA,IACA,UAAU,SAAS;AACjB,UAAI,OAAQ,QAAO,MAAM;AAEzB,sBAAgB,IAAI,OAAO;AAC3B,aAAO,MAAM;AACX,wBAAgB,OAAO,OAAO;AAAA,MAChC;AAAA,IACF;AAAA,EACF;AAEA,UAAQ;AACR,SAAO;AACT;","names":[]}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@contentful/experiences-live-preview",
+  "version": "0.1.8",
+  "description": "Optional live preview for Contentful Experiences",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/contentful/experiences.git",
+    "directory": "packages/live-preview"
+  },
+  "dependencies": {
+    "@contentful/experiences-client": "0.4.8",
+    "@contentful/experiences-sdk-core": "0.8.6"
+  }
+}