@contentful/experiences-client 0.2.1 → 0.3.1

package/CHANGELOG.md

@@ -1,3 +1,104 @@
+## 0.3.1 (2026-08-07)
+
+### 🚀 Features
+
+- server-side design pre-resolution against a fallback viewport [AIS-386] ([#119](https://github.com/contentful/experiences/pull/119))
+
+### 🧱 Updated Dependencies
+
+- Updated core to 0.7.1
+
+## 0.3.0 (2026-08-07)
+
+### 🩹 Fixes
+
+- ⚠️  bump @contentful/experience-delivery to 1.0.0-dev.6 + migrate to renamed API [AIS-339] ([#120](https://github.com/contentful/experiences/pull/120))
+
+### ⚠️  Breaking Changes
+
+- bump @contentful/experience-delivery to 1.0.0-dev.6 + migrate to renamed API [AIS-339]  ([#120](https://github.com/contentful/experiences/pull/120))
+  the public API uses the component / experienceTemplate vocabulary.
+  - `registration.componentTypeId` -> `registration.componentId`
+  - `plan.template` -> `plan.experienceTemplate`
+  - `PortableTemplate` -> `PortableExperienceTemplate` (`templateId` ->
+    `experienceTemplateId`)
+  - `Config.templates` -> `Config.experienceTemplates`; `Templates` ->
+    `ExperienceTemplates`
+  - `defineTemplate` -> `defineExperienceTemplate`; `TemplateConfig` ->
+    `ExperienceTemplateConfig`; `TemplateRegistration` ->
+    `ExperienceTemplateRegistration`; `normalizeTemplateRegistration` ->
+    `normalizeExperienceTemplateRegistration`
+  - `useContentfulTemplate()` / `getContentfulTemplate()` ->
+    `useContentfulExperienceTemplate()` / `getContentfulExperienceTemplate()`;
+    `ContentfulTemplate` -> `ContentfulExperienceTemplate`
+  - `MissingComponentProps.componentTypeId` -> `componentId`
+  - Core payload types: `ComponentTypeNode`/`ComponentTypeRef` ->
+    `ComponentNode`/`ComponentRef`; `TemplateNode`/`TemplateRef` ->
+    `ExperienceTemplateNode`/`ExperienceTemplateRef`
+  `packages/core` stays zero-dep, so its payload types are hand-mirrored from the
+  delivery package rather than imported; each carries a doc comment naming its
+  upstream counterpart, and `client:typecheck` catches drift when the delivery SDK
+  regenerates. Documented in AGENTS.md.
+  `examples/scripts/` is intentionally unchanged: it targets the management SDK
+  (`contentful-management`), which has its own entity-type surface, and adopting it
+  would require changing that dependency. The seed script therefore still
+  provisions the shapes that SDK produces.
+  Verified: build, typecheck, and 157 tests pass across all five packages.
+  Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
+  * docs: describe current state only in comments and docs
+  Drop ticket ids, tracker links, and before/after narrative from doc comments and
+  prose so they explain what the code does now rather than how it got here.
+  - `alpha-feature.ts`: state what the header selects and why it is required,
+    without the two-shapes-in-transition framing or the removal timeline.
+  - `core/src/types.ts`: keep each type's upstream counterpart in
+    `@contentful/experience-delivery` (load-bearing for maintenance) but drop the
+    "formerly known as" and old-link-type asides.
+  - README: replace the rename migration table with a description of the
+    alpha-feature header and when a caller needs to send it.
+  - AGENTS.md: reframe the rationale entries that opened on prior designs to state
+    the current design and its reason.
+  - Drop stale option-shape asides ("was nested under ...") and a test name that
+    described superseded behaviour.
+  Generated CHANGELOG.md files are untouched — they are release history.
+  Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
+  * feat!: migrate bootstrap fixture script to component/experienceTemplate entities
+  contentful-management@12.14.0 exposes the renamed ExO entities (Component,
+  ExperienceTemplate) alongside the deprecated ComponentType/Template ones. Adopt
+  the renamed shapes throughout examples/scripts so a freshly bootstrapped demo
+  Experience uses the same entity vocabulary the delivery-consuming packages now
+  read.
+  - Bump contentful-management to ^12.14.0 (existing dependency, version only —
+    no new packages).
+  - fixture/component-types.ts -> fixture/components.ts: ComponentTypeFixture ->
+    ComponentFixture.
+  - fixture/templates.ts -> fixture/experience-templates.ts:
+    TemplateFixture -> ExperienceTemplateFixture, TemplateTreeNode ->
+    ExperienceTemplateTreeNode.
+  - fixture/types.ts, fixture/experience.ts: ExperienceFixture.templateId ->
+    experienceTemplateId; node nodeType 'InlineFragment' ->
+    'InlineExperienceFragment' with componentTypeId -> componentId, matching
+    contentful-management's InlineExperienceFragmentNode.
+  - fixture/data-assemblies.ts: dataAssemblyComponentTypeLinks ->
+    dataAssemblyComponentLinks (componentTypeId -> componentId).
+  - bootstrap-example.ts: cma.componentType -> cma.component,
+    cma.template -> cma.experienceTemplate; sys.type 'ComponentType' ->
+    'Component', 'Template' -> 'ExperienceTemplate'; resource-link types
+    Contentful:ComponentType -> Contentful:Component and Contentful:Template ->
+    Contentful:ExperienceTemplate; URN segments components/ and
+    experienceTemplates/; seedComponentType -> seedComponent, seedTemplate ->
+    seedExperienceTemplate, linkDataAssembliesToComponentTypes ->
+    linkDataAssembliesToComponents.
+  The metadata.annotations.Template composed/coded-implementation marker is
+  unrelated to this rename (identical shape in 12.10.0 and 12.14.0) and is left
+  untouched.
+  Verified: examples/scripts typechecks clean; the main workspace's build,
+  typecheck, and 157 tests are unaffected.
+  Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
+
+### 🧱 Updated Dependencies
+
+- Updated core to 0.7.0
+
 ## 0.2.1 (2026-08-06)
 
 ### 🧱 Updated Dependencies

package/dist/alpha-feature.d.ts

@@ -0,0 +1,6 @@
+declare const ALPHA_FEATURE_HEADER = "x-contentful-enable-alpha-feature";
+declare const NEW_EXO_ENTITY_TYPES = "new-exo-entity-types";
+/** Ready-to-spread header bag selecting the ExO entity shapes this SDK reads. */
+declare const NEW_EXO_ENTITY_TYPES_HEADERS: Record<string, string>;
+
+export { ALPHA_FEATURE_HEADER, NEW_EXO_ENTITY_TYPES, NEW_EXO_ENTITY_TYPES_HEADERS };

package/dist/alpha-feature.js

@@ -0,0 +1,11 @@
+const ALPHA_FEATURE_HEADER = "x-contentful-enable-alpha-feature";
+const NEW_EXO_ENTITY_TYPES = "new-exo-entity-types";
+const NEW_EXO_ENTITY_TYPES_HEADERS = {
+  [ALPHA_FEATURE_HEADER]: NEW_EXO_ENTITY_TYPES
+};
+export {
+  ALPHA_FEATURE_HEADER,
+  NEW_EXO_ENTITY_TYPES,
+  NEW_EXO_ENTITY_TYPES_HEADERS
+};
+//# sourceMappingURL=alpha-feature.js.map

package/dist/alpha-feature.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/alpha-feature.ts"],"sourcesContent":["/*\n * The Experience Delivery API gates the ExO entity shapes this SDK reads —\n * nodes linking `component` / `experienceTemplate`, and `sys.experienceTemplate`\n * for the page-level reference — behind an alpha-feature header. A request\n * without the header gets a different shape, which this SDK does not parse.\n *\n * The header is therefore required, not optional, and is sent from two places:\n * `createClient` sets it as a client default, and `fetchExperience` sends it\n * per request so a caller-supplied client is covered too.\n *\n * It also makes the response type unambiguous: the delivery client types\n * `GetExperienceResponse` as a union of the shapes the endpoint can return,\n * because it cannot know which header the caller sent. Sending the header is\n * what lets `fetch-experience.ts` narrow to `HydratedExperienceView`.\n */\n\nexport const ALPHA_FEATURE_HEADER = 'x-contentful-enable-alpha-feature';\n\nexport const NEW_EXO_ENTITY_TYPES = 'new-exo-entity-types';\n\n/** Ready-to-spread header bag selecting the ExO entity shapes this SDK reads. */\nexport const NEW_EXO_ENTITY_TYPES_HEADERS: Record<string, string> = {\n  [ALPHA_FEATURE_HEADER]: NEW_EXO_ENTITY_TYPES,\n};\n"],"mappings":"AAgBO,MAAM,uBAAuB;AAE7B,MAAM,uBAAuB;AAG7B,MAAM,+BAAuD;AAAA,EAClE,CAAC,oBAAoB,GAAG;AAC1B;","names":[]}

package/dist/create-client.js

@@ -1,10 +1,17 @@
 import { ContentfulViewDeliveryClient } from "@contentful/experience-delivery";
+import { ALPHA_FEATURE_HEADER, NEW_EXO_ENTITY_TYPES } from "./alpha-feature.js";
 function createClient(options) {
-  const { accessToken, host, ...rest } = options;
+  const { accessToken, host, headers, ...rest } = options;
   return new ContentfulViewDeliveryClient({
     ...rest,
     token: accessToken,
-    baseUrl: host
+    baseUrl: host,
+    // Selects the ExO entity shapes this SDK reads (`component` /
+    // `experienceTemplate` links). Set as a client default so direct
+    // `client.experience.get(...)` calls get them too, not just
+    // `fetchExperience`. A caller-supplied `headers` entry for the same key
+    // wins, so a caller can pin a different alpha-feature set if they need to.
+    headers: { [ALPHA_FEATURE_HEADER]: NEW_EXO_ENTITY_TYPES, ...headers }
   });
 }
 export {

package/dist/create-client.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/create-client.ts"],"sourcesContent":["import { ContentfulViewDeliveryClient } from '@contentful/experience-delivery';\n\nexport type CreateClientOptions = {\n  accessToken: string;\n  /**\n   * Base URL for the delivery client. Defaults to `DELIVERY_HOST` when omitted.\n   * Pass `PREVIEW_HOST` for preview mode, or any custom URL (staging, proxy,\n   * per-region). Both constants are exported from this package.\n   */\n  host?: string;\n} & Omit<ContentfulViewDeliveryClient.Options, 'token' | 'baseUrl'>;\n\nexport function createClient(options: CreateClientOptions): ContentfulViewDeliveryClient {\n  const { accessToken, host, ...rest } = options;\n  return new ContentfulViewDeliveryClient({\n    ...rest,\n    token: accessToken,\n    baseUrl: host,\n  });\n}\n"],"mappings":"AAAA,SAAS,oCAAoC;AAYtC,SAAS,aAAa,SAA4D;AACvF,QAAM,EAAE,aAAa,MAAM,GAAG,KAAK,IAAI;AACvC,SAAO,IAAI,6BAA6B;AAAA,IACtC,GAAG;AAAA,IACH,OAAO;AAAA,IACP,SAAS;AAAA,EACX,CAAC;AACH;","names":[]}
+{"version":3,"sources":["../src/create-client.ts"],"sourcesContent":["import { ContentfulViewDeliveryClient } from '@contentful/experience-delivery';\n\nimport { ALPHA_FEATURE_HEADER, NEW_EXO_ENTITY_TYPES } from './alpha-feature.js';\n\nexport type CreateClientOptions = {\n  accessToken: string;\n  /**\n   * Base URL for the delivery client. Defaults to `DELIVERY_HOST` when omitted.\n   * Pass `PREVIEW_HOST` for preview mode, or any custom URL (staging, proxy,\n   * per-region). Both constants are exported from this package.\n   */\n  host?: string;\n} & Omit<ContentfulViewDeliveryClient.Options, 'token' | 'baseUrl'>;\n\nexport function createClient(options: CreateClientOptions): ContentfulViewDeliveryClient {\n  const { accessToken, host, headers, ...rest } = options;\n  return new ContentfulViewDeliveryClient({\n    ...rest,\n    token: accessToken,\n    baseUrl: host,\n    // Selects the ExO entity shapes this SDK reads (`component` /\n    // `experienceTemplate` links). Set as a client default so direct\n    // `client.experience.get(...)` calls get them too, not just\n    // `fetchExperience`. A caller-supplied `headers` entry for the same key\n    // wins, so a caller can pin a different alpha-feature set if they need to.\n    headers: { [ALPHA_FEATURE_HEADER]: NEW_EXO_ENTITY_TYPES, ...headers },\n  });\n}\n"],"mappings":"AAAA,SAAS,oCAAoC;AAE7C,SAAS,sBAAsB,4BAA4B;AAYpD,SAAS,aAAa,SAA4D;AACvF,QAAM,EAAE,aAAa,MAAM,SAAS,GAAG,KAAK,IAAI;AAChD,SAAO,IAAI,6BAA6B;AAAA,IACtC,GAAG;AAAA,IACH,OAAO;AAAA,IACP,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAMT,SAAS,EAAE,CAAC,oBAAoB,GAAG,sBAAsB,GAAG,QAAQ;AAAA,EACtE,CAAC;AACH;","names":[]}

package/dist/fetch-experience.d.ts

@@ -35,8 +35,7 @@ type ResolveOptions = {
     /**
      * Arbitrary per-render metadata exposed to every resolver as
      * `ctx.experience.metadata` and readable at render time via the framework
-     * adapter's `useExperience()` / `getExperience()`. Flattened to a top-level
-     * option (previously nested under `context.metadata`).
+     * adapter's `useExperience()` / `getExperience()`.
      */
     metadata?: Record<string, unknown>;
     /**
@@ -46,6 +45,12 @@ type ResolveOptions = {
      * debug fallback). A single boolean across fetch + resolve + render.
      */
     debug?: boolean;
+    /**
+     * Per-request fallback viewport for server-side design pre-resolution. Pass
+     * the same id you seed the renderer's `initialViewportId` with (e.g. a
+     * User-Agent-derived viewport) so SSR paints correct design on first render.
+     */
+    initialViewportId?: string;
 };
 declare function fetchExperience(experienceOptions: ExperienceOptions, clientOptions: ClientOptions, resolveOptions: ResolveOptions): Promise<PortableRenderPlan>;
 

package/dist/fetch-experience.js

@@ -1,9 +1,10 @@
 import { createDebugLogger, resolveExperience } from "@contentful/experiences-sdk-core";
+import { NEW_EXO_ENTITY_TYPES_HEADERS } from "./alpha-feature.js";
 import { createClient } from "./create-client.js";
 import { PREVIEW_HOST } from "./hosts.js";
 async function fetchExperience(experienceOptions, clientOptions, resolveOptions) {
   const { spaceId, environmentId, experienceId, locale } = experienceOptions;
-  const { config, metadata, debug } = resolveOptions;
+  const { config, metadata, debug, initialViewportId } = resolveOptions;
   const log = createDebugLogger(debug, "client");
   let client;
   if ("client" in clientOptions) {
@@ -24,11 +25,20 @@ async function fetchExperience(experienceOptions, clientOptions, resolveOptions)
     log.log("created delivery client", { preview: Boolean(preview), host: resolvedHost });
   }
   log.log("fetching experience", { spaceId, environmentId, experienceId, locale });
-  const payload = await client.view.getExperience(spaceId, environmentId, experienceId, {
-    locale
-  });
+  const response = await client.experience.get(
+    spaceId,
+    environmentId,
+    experienceId,
+    { locale },
+    { headers: NEW_EXO_ENTITY_TYPES_HEADERS }
+  );
+  const payload = response;
   log.lazy("received raw payload", () => payload);
-  return resolveExperience(payload, config, { metadata, debug });
+  return resolveExperience(payload, config, {
+    metadata,
+    debug,
+    initialViewportId
+  });
 }
 export {
   fetchExperience

package/dist/fetch-experience.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/fetch-experience.ts"],"sourcesContent":["import type { ContentfulViewDeliveryClient } from '@contentful/experience-delivery';\nimport { createDebugLogger, resolveExperience } from '@contentful/experiences-sdk-core';\nimport type {\n  ExperiencePayload,\n  PortableRenderPlan,\n  ResolverConfig,\n} from '@contentful/experiences-sdk-core';\nimport { createClient } from './create-client.js';\nimport { PREVIEW_HOST } from './hosts.js';\n\nexport type ExperienceOptions = {\n  spaceId: string;\n  environmentId: string;\n  experienceId: string;\n  locale?: string;\n};\n\nexport type ClientOptions =\n  | {\n      accessToken: string;\n      /**\n       * Preview access token. Required when calling with `preview: true`.\n       */\n      previewToken?: string;\n      /**\n       * Flip between delivery (default) and preview at request time. When\n       * `true`, `fetchExperience` uses `previewToken` and the preview host;\n       * when `false` or unset, it uses `accessToken` and the delivery host.\n       * Ignored when a pre-made `client` is passed instead of inline creds.\n       */\n      preview?: boolean;\n      /**\n       * Custom base URL for the delivery client (staging, proxy, per-region).\n       * Wins over the `preview`-derived default host — combine `host` with\n       * `preview: true` to point preview mode at a non-prod endpoint.\n       * Omit for the standard delivery / preview hosts.\n       */\n      host?: string;\n    }\n  | { client: ContentfulViewDeliveryClient };\n\nexport type ResolveOptions = {\n  config: ResolverConfig;\n  /**\n   * Arbitrary per-render metadata exposed to every resolver as\n   * `ctx.experience.metadata` and readable at render time via the framework\n   * adapter's `useExperience()` / `getExperience()`. Flattened to a top-level\n   * option (previously nested under `context.metadata`).\n   */\n  metadata?: Record<string, unknown>;\n  /**\n   * Observability switch. When on: logs the fetch (host, ids) and the raw\n   * payload here, and threads through to `resolveExperience` (resolution steps\n   * + `resolveData` timings) and the renderer (visible missing-component box,\n   * debug fallback). A single boolean across fetch + resolve + render.\n   */\n  debug?: boolean;\n};\n\nexport async function fetchExperience(\n  experienceOptions: ExperienceOptions,\n  clientOptions: ClientOptions,\n  resolveOptions: ResolveOptions\n): Promise<PortableRenderPlan> {\n  const { spaceId, environmentId, experienceId, locale } = experienceOptions;\n  const { config, metadata, debug } = resolveOptions;\n  const log = createDebugLogger(debug, 'client');\n\n  let client: ContentfulViewDeliveryClient;\n  if ('client' in clientOptions) {\n    client = clientOptions.client;\n    log.log('using caller-supplied delivery client');\n  } else {\n    const { accessToken, previewToken, preview, host } = clientOptions;\n    if (preview && !previewToken) {\n      throw new Error(\n        'fetchExperience() called with preview: true but no previewToken was provided'\n      );\n    }\n    const resolvedHost = host ?? (preview ? PREVIEW_HOST : undefined);\n    client = createClient({\n      accessToken: preview ? (previewToken as string) : accessToken,\n      host: resolvedHost,\n    });\n    log.log('created delivery client', { preview: Boolean(preview), host: resolvedHost });\n  }\n\n  log.log('fetching experience', { spaceId, environmentId, experienceId, locale });\n\n  // Response from the experience delivery client is structurally compatible with ExperiencePayload (superset)\n  const payload = (await client.view.getExperience(spaceId, environmentId, experienceId, {\n    locale,\n  })) as unknown as ExperiencePayload;\n\n  log.lazy('received raw payload', () => payload);\n\n  return resolveExperience(payload, config, { metadata, debug });\n}\n"],"mappings":"AACA,SAAS,mBAAmB,yBAAyB;AAMrD,SAAS,oBAAoB;AAC7B,SAAS,oBAAoB;AAmD7B,eAAsB,gBACpB,mBACA,eACA,gBAC6B;AAC7B,QAAM,EAAE,SAAS,eAAe,cAAc,OAAO,IAAI;AACzD,QAAM,EAAE,QAAQ,UAAU,MAAM,IAAI;AACpC,QAAM,MAAM,kBAAkB,OAAO,QAAQ;AAE7C,MAAI;AACJ,MAAI,YAAY,eAAe;AAC7B,aAAS,cAAc;AACvB,QAAI,IAAI,uCAAuC;AAAA,EACjD,OAAO;AACL,UAAM,EAAE,aAAa,cAAc,SAAS,KAAK,IAAI;AACrD,QAAI,WAAW,CAAC,cAAc;AAC5B,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AACA,UAAM,eAAe,SAAS,UAAU,eAAe;AACvD,aAAS,aAAa;AAAA,MACpB,aAAa,UAAW,eAA0B;AAAA,MAClD,MAAM;AAAA,IACR,CAAC;AACD,QAAI,IAAI,2BAA2B,EAAE,SAAS,QAAQ,OAAO,GAAG,MAAM,aAAa,CAAC;AAAA,EACtF;AAEA,MAAI,IAAI,uBAAuB,EAAE,SAAS,eAAe,cAAc,OAAO,CAAC;AAG/E,QAAM,UAAW,MAAM,OAAO,KAAK,cAAc,SAAS,eAAe,cAAc;AAAA,IACrF;AAAA,EACF,CAAC;AAED,MAAI,KAAK,wBAAwB,MAAM,OAAO;AAE9C,SAAO,kBAAkB,SAAS,QAAQ,EAAE,UAAU,MAAM,CAAC;AAC/D;","names":[]}
+{"version":3,"sources":["../src/fetch-experience.ts"],"sourcesContent":["import type {\n  ContentfulViewDelivery,\n  ContentfulViewDeliveryClient,\n} from '@contentful/experience-delivery';\nimport { createDebugLogger, resolveExperience } from '@contentful/experiences-sdk-core';\nimport type {\n  ExperiencePayload,\n  PortableRenderPlan,\n  ResolverConfig,\n} from '@contentful/experiences-sdk-core';\nimport { NEW_EXO_ENTITY_TYPES_HEADERS } from './alpha-feature.js';\nimport { createClient } from './create-client.js';\nimport { PREVIEW_HOST } from './hosts.js';\n\nexport type ExperienceOptions = {\n  spaceId: string;\n  environmentId: string;\n  experienceId: string;\n  locale?: string;\n};\n\nexport type ClientOptions =\n  | {\n      accessToken: string;\n      /**\n       * Preview access token. Required when calling with `preview: true`.\n       */\n      previewToken?: string;\n      /**\n       * Flip between delivery (default) and preview at request time. When\n       * `true`, `fetchExperience` uses `previewToken` and the preview host;\n       * when `false` or unset, it uses `accessToken` and the delivery host.\n       * Ignored when a pre-made `client` is passed instead of inline creds.\n       */\n      preview?: boolean;\n      /**\n       * Custom base URL for the delivery client (staging, proxy, per-region).\n       * Wins over the `preview`-derived default host — combine `host` with\n       * `preview: true` to point preview mode at a non-prod endpoint.\n       * Omit for the standard delivery / preview hosts.\n       */\n      host?: string;\n    }\n  | { client: ContentfulViewDeliveryClient };\n\nexport type ResolveOptions = {\n  config: ResolverConfig;\n  /**\n   * Arbitrary per-render metadata exposed to every resolver as\n   * `ctx.experience.metadata` and readable at render time via the framework\n   * adapter's `useExperience()` / `getExperience()`.\n   */\n  metadata?: Record<string, unknown>;\n  /**\n   * Observability switch. When on: logs the fetch (host, ids) and the raw\n   * payload here, and threads through to `resolveExperience` (resolution steps\n   * + `resolveData` timings) and the renderer (visible missing-component box,\n   * debug fallback). A single boolean across fetch + resolve + render.\n   */\n  debug?: boolean;\n  /**\n   * Per-request fallback viewport for server-side design pre-resolution. Pass\n   * the same id you seed the renderer's `initialViewportId` with (e.g. a\n   * User-Agent-derived viewport) so SSR paints correct design on first render.\n   */\n  initialViewportId?: string;\n};\n\nexport async function fetchExperience(\n  experienceOptions: ExperienceOptions,\n  clientOptions: ClientOptions,\n  resolveOptions: ResolveOptions\n): Promise<PortableRenderPlan> {\n  const { spaceId, environmentId, experienceId, locale } = experienceOptions;\n  const { config, metadata, debug, initialViewportId } = resolveOptions;\n  const log = createDebugLogger(debug, 'client');\n\n  let client: ContentfulViewDeliveryClient;\n  if ('client' in clientOptions) {\n    client = clientOptions.client;\n    log.log('using caller-supplied delivery client');\n  } else {\n    const { accessToken, previewToken, preview, host } = clientOptions;\n    if (preview && !previewToken) {\n      throw new Error(\n        'fetchExperience() called with preview: true but no previewToken was provided'\n      );\n    }\n    const resolvedHost = host ?? (preview ? PREVIEW_HOST : undefined);\n    client = createClient({\n      accessToken: preview ? (previewToken as string) : accessToken,\n      host: resolvedHost,\n    });\n    log.log('created delivery client', { preview: Boolean(preview), host: resolvedHost });\n  }\n\n  log.log('fetching experience', { spaceId, environmentId, experienceId, locale });\n\n  // The alpha-feature header goes on the request as well as on clients built by\n  // `createClient`, so a caller-supplied `{ client }` also gets the ExO entity\n  // shapes this SDK reads.\n  const response = await client.experience.get(\n    spaceId,\n    environmentId,\n    experienceId,\n    { locale },\n    { headers: NEW_EXO_ENTITY_TYPES_HEADERS }\n  );\n\n  // `GetExperienceResponse` is a union of the shapes the endpoint can return;\n  // the header above pins it to `HydratedExperienceView`, which is a structural\n  // superset of `ExperiencePayload`.\n  const payload = response as ContentfulViewDelivery.HydratedExperienceView as ExperiencePayload;\n\n  log.lazy('received raw payload', () => payload);\n\n  return resolveExperience(payload, config, {\n    metadata,\n    debug,\n    initialViewportId,\n  });\n}\n"],"mappings":"AAIA,SAAS,mBAAmB,yBAAyB;AAMrD,SAAS,oCAAoC;AAC7C,SAAS,oBAAoB;AAC7B,SAAS,oBAAoB;AAwD7B,eAAsB,gBACpB,mBACA,eACA,gBAC6B;AAC7B,QAAM,EAAE,SAAS,eAAe,cAAc,OAAO,IAAI;AACzD,QAAM,EAAE,QAAQ,UAAU,OAAO,kBAAkB,IAAI;AACvD,QAAM,MAAM,kBAAkB,OAAO,QAAQ;AAE7C,MAAI;AACJ,MAAI,YAAY,eAAe;AAC7B,aAAS,cAAc;AACvB,QAAI,IAAI,uCAAuC;AAAA,EACjD,OAAO;AACL,UAAM,EAAE,aAAa,cAAc,SAAS,KAAK,IAAI;AACrD,QAAI,WAAW,CAAC,cAAc;AAC5B,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AACA,UAAM,eAAe,SAAS,UAAU,eAAe;AACvD,aAAS,aAAa;AAAA,MACpB,aAAa,UAAW,eAA0B;AAAA,MAClD,MAAM;AAAA,IACR,CAAC;AACD,QAAI,IAAI,2BAA2B,EAAE,SAAS,QAAQ,OAAO,GAAG,MAAM,aAAa,CAAC;AAAA,EACtF;AAEA,MAAI,IAAI,uBAAuB,EAAE,SAAS,eAAe,cAAc,OAAO,CAAC;AAK/E,QAAM,WAAW,MAAM,OAAO,WAAW;AAAA,IACvC;AAAA,IACA;AAAA,IACA;AAAA,IACA,EAAE,OAAO;AAAA,IACT,EAAE,SAAS,6BAA6B;AAAA,EAC1C;AAKA,QAAM,UAAU;AAEhB,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

@@ -1,6 +1,7 @@
 import { ContentfulViewDelivery } from '@contentful/experience-delivery';
 export { ContentfulViewDelivery, ContentfulViewDeliveryClient } from '@contentful/experience-delivery';
 export { CreateClientOptions, createClient } from './create-client.js';
+export { ALPHA_FEATURE_HEADER, NEW_EXO_ENTITY_TYPES, NEW_EXO_ENTITY_TYPES_HEADERS } from './alpha-feature.js';
 export { ClientOptions, ExperienceOptions, ResolveOptions, fetchExperience } from './fetch-experience.js';
 export { DELIVERY_HOST, PREVIEW_HOST } from './hosts.js';
 import '@contentful/experiences-sdk-core';

package/dist/index.js

@@ -5,12 +5,20 @@ import {
 } from "@contentful/experience-delivery";
 const NotFoundError = ContentfulViewDelivery.NotFoundError;
 import { createClient } from "./create-client.js";
+import {
+  ALPHA_FEATURE_HEADER,
+  NEW_EXO_ENTITY_TYPES,
+  NEW_EXO_ENTITY_TYPES_HEADERS
+} from "./alpha-feature.js";
 import { fetchExperience } from "./fetch-experience.js";
 import { DELIVERY_HOST, PREVIEW_HOST } from "./hosts.js";
 export {
+  ALPHA_FEATURE_HEADER,
   ContentfulViewDelivery2 as ContentfulViewDelivery,
   ContentfulViewDeliveryClient,
   DELIVERY_HOST,
+  NEW_EXO_ENTITY_TYPES,
+  NEW_EXO_ENTITY_TYPES_HEADERS,
   NotFoundError,
   PREVIEW_HOST,
   createClient,

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { ContentfulViewDelivery } from '@contentful/experience-delivery';\n\nexport {\n  ContentfulViewDelivery,\n  ContentfulViewDeliveryClient,\n} from '@contentful/experience-delivery';\nexport const NotFoundError = ContentfulViewDelivery.NotFoundError;\nexport type NotFoundError = InstanceType<typeof ContentfulViewDelivery.NotFoundError>;\nexport { createClient } from './create-client.js';\nexport type { CreateClientOptions } from './create-client.js';\nexport { fetchExperience } from './fetch-experience.js';\nexport type { ExperienceOptions, ClientOptions, ResolveOptions } from './fetch-experience.js';\nexport { DELIVERY_HOST, PREVIEW_HOST } from './hosts.js';\n"],"mappings":"AAAA,SAAS,8BAA8B;AAEvC;AAAA,EACE,0BAAAA;AAAA,EACA;AAAA,OACK;AACA,MAAM,gBAAgB,uBAAuB;AAEpD,SAAS,oBAAoB;AAE7B,SAAS,uBAAuB;AAEhC,SAAS,eAAe,oBAAoB;","names":["ContentfulViewDelivery"]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { ContentfulViewDelivery } from '@contentful/experience-delivery';\n\nexport {\n  ContentfulViewDelivery,\n  ContentfulViewDeliveryClient,\n} from '@contentful/experience-delivery';\nexport const NotFoundError = ContentfulViewDelivery.NotFoundError;\nexport type NotFoundError = InstanceType<typeof ContentfulViewDelivery.NotFoundError>;\nexport { createClient } from './create-client.js';\nexport type { CreateClientOptions } from './create-client.js';\n// Exported so customers who drive `ContentfulViewDeliveryClient` themselves and\n// call `resolveExperience` on the raw payload can select the same ExO entity\n// shapes this SDK expects. `createClient` / `fetchExperience` send it for you.\nexport {\n  ALPHA_FEATURE_HEADER,\n  NEW_EXO_ENTITY_TYPES,\n  NEW_EXO_ENTITY_TYPES_HEADERS,\n} from './alpha-feature.js';\nexport { fetchExperience } from './fetch-experience.js';\nexport type { ExperienceOptions, ClientOptions, ResolveOptions } from './fetch-experience.js';\nexport { DELIVERY_HOST, PREVIEW_HOST } from './hosts.js';\n"],"mappings":"AAAA,SAAS,8BAA8B;AAEvC;AAAA,EACE,0BAAAA;AAAA,EACA;AAAA,OACK;AACA,MAAM,gBAAgB,uBAAuB;AAEpD,SAAS,oBAAoB;AAK7B;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,uBAAuB;AAEhC,SAAS,eAAe,oBAAoB;","names":["ContentfulViewDelivery"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/experiences-client",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "description": "Delivery client + fetchExperience for Contentful Experiences",
   "license": "MIT",
   "type": "module",
@@ -30,7 +30,7 @@
     "directory": "packages/client"
   },
   "dependencies": {
-    "@contentful/experience-delivery": "1.0.0-dev.3",
-    "@contentful/experiences-sdk-core": "0.6.1"
+    "@contentful/experience-delivery": "1.0.0-dev.6",
+    "@contentful/experiences-sdk-core": "0.7.1"
   }
 }