@contentful/experiences-svelte 0.3.1

package/dist/component-props.d.ts

@@ -0,0 +1,18 @@
+import type { Component } from 'svelte';
+import type { ExperienceContext, PortableRenderPlan } from '@contentful/experiences-core';
+import type { Config } from './types.js';
+export interface ServerExperienceRendererProps {
+    experience: PortableRenderPlan | null | undefined;
+    config: Config;
+    initialViewportId?: string;
+    context?: Partial<ExperienceContext>;
+    renderUnknown?: RenderUnknown;
+}
+export type ClientExperienceRendererProps = ServerExperienceRendererProps;
+export interface MissingComponentProps {
+    componentTypeId: string;
+    /** Optional — only present when the payload supplied an id for this node. */
+    nodeId?: string;
+}
+export type RenderUnknown = Component<MissingComponentProps>;
+//# sourceMappingURL=component-props.d.ts.map

package/dist/component-props.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"component-props.d.ts","sourceRoot":"","sources":["../src/component-props.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAExC,OAAO,KAAK,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAE1F,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,WAAW,6BAA6B;IAC5C,UAAU,EAAE,kBAAkB,GAAG,IAAI,GAAG,SAAS,CAAC;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACrC,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED,MAAM,MAAM,6BAA6B,GAAG,6BAA6B,CAAC;AAE1E,MAAM,WAAW,qBAAqB;IACpC,eAAe,EAAE,MAAM,CAAC;IACxB,6EAA6E;IAC7E,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,MAAM,aAAa,GAAG,SAAS,CAAC,qBAAqB,CAAC,CAAC"}

package/dist/component-props.js

@@ -0,0 +1,13 @@
+/*
+ * Public prop-shape types for the renderer components. They're declared
+ * here (rather than inside `<script module>` blocks of the .svelte files)
+ * so that:
+ *
+ *  - `tsc --noEmit` typechecks the package without the Svelte language
+ *    server. tsc can't see exports inside a .svelte module block;
+ *    `svelte-check` can. Keeping prop types in plain TS keeps both happy.
+ *  - `index.ts` re-exports them with `export type`, which compiles cleanly.
+ *
+ * The .svelte files import these and use them as their `$props()` type.
+ */
+export {};

package/dist/context.d.ts

@@ -0,0 +1,20 @@
+import type { ContentfulComponent, ContentfulTemplate, RenderContext } from './types.js';
+export declare function setExperience(ctx: RenderContext): void;
+export declare function setContentfulComponent(node: ContentfulComponent): void;
+export declare function setContentfulTemplate(tpl: ContentfulTemplate): void;
+/**
+ * Publish the resolved design values for the enclosing node/template. Takes a
+ * getter (not a snapshot) so callers reading it inside a `$derived` stay
+ * reactive across viewport changes.
+ */
+export declare function setResolvedDesign(getDesign: () => Record<string, unknown>): void;
+export declare function getExperience(): RenderContext;
+export declare function getContentfulComponent(): ContentfulComponent | undefined;
+export declare function getContentfulTemplate(): ContentfulTemplate | undefined;
+/**
+ * Read the design values the renderer resolved for the enclosing node or
+ * template. Returns `undefined` outside a rendered node/template, which
+ * `getDesignValues` treats as "nothing to read."
+ */
+export declare function getResolvedDesign(): Record<string, unknown> | undefined;
+//# sourceMappingURL=context.d.ts.map

package/dist/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAoBA,OAAO,KAAK,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAOzF,wBAAgB,aAAa,CAAC,GAAG,EAAE,aAAa,GAAG,IAAI,CAEtD;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,mBAAmB,GAAG,IAAI,CAEtE;AAED,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,kBAAkB,GAAG,IAAI,CAEnE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAEhF;AAED,wBAAgB,aAAa,IAAI,aAAa,CAQ7C;AAED,wBAAgB,sBAAsB,IAAI,mBAAmB,GAAG,SAAS,CAExE;AAED,wBAAgB,qBAAqB,IAAI,kBAAkB,GAAG,SAAS,CAEtE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAGvE"}

package/dist/context.js

@@ -0,0 +1,61 @@
+/*
+ * Svelte context keys + helpers that expose runtime context and the raw
+ * Contentful payload to descendants of a rendered Experience. Customer
+ * components receive only their declared props via the renderer; anything
+ * that needs the Experience runtime context or the underlying payload calls
+ * the helper from the top of its `<script>` block.
+ *
+ * Reactivity: the client renderer stores a `$state` proxy in context, so
+ * reads through the returned object (`exp.activeViewport`, from the
+ * template or a `$derived`) stay reactive across viewport changes.
+ * Destructuring the return of `getExperience()` loses that reactivity —
+ * same rule as Svelte 5 `$props()`.
+ *
+ * `getContext` / `setContext` must be called during synchronous component
+ * initialization (top of the `<script>` block), not inside async callbacks
+ * or event handlers.
+ */
+import { getContext, setContext } from 'svelte';
+const EXPERIENCE_KEY = Symbol('@contentful/experiences-svelte::experience');
+const COMPONENT_KEY = Symbol('@contentful/experiences-svelte::contentful-component');
+const TEMPLATE_KEY = Symbol('@contentful/experiences-svelte::contentful-template');
+const RESOLVED_DESIGN_KEY = Symbol('@contentful/experiences-svelte::resolved-design');
+export function setExperience(ctx) {
+    setContext(EXPERIENCE_KEY, ctx);
+}
+export function setContentfulComponent(node) {
+    setContext(COMPONENT_KEY, node);
+}
+export function setContentfulTemplate(tpl) {
+    setContext(TEMPLATE_KEY, tpl);
+}
+/**
+ * Publish the resolved design values for the enclosing node/template. Takes a
+ * getter (not a snapshot) so callers reading it inside a `$derived` stay
+ * reactive across viewport changes.
+ */
+export function setResolvedDesign(getDesign) {
+    setContext(RESOLVED_DESIGN_KEY, getDesign);
+}
+export function getExperience() {
+    const ctx = getContext(EXPERIENCE_KEY);
+    if (!ctx) {
+        throw new Error('getExperience() must be called inside a <ServerExperienceRenderer> or <ClientExperienceRenderer> subtree.');
+    }
+    return ctx;
+}
+export function getContentfulComponent() {
+    return getContext(COMPONENT_KEY);
+}
+export function getContentfulTemplate() {
+    return getContext(TEMPLATE_KEY);
+}
+/**
+ * Read the design values the renderer resolved for the enclosing node or
+ * template. Returns `undefined` outside a rendered node/template, which
+ * `getDesignValues` treats as "nothing to read."
+ */
+export function getResolvedDesign() {
+    const getDesign = getContext(RESOLVED_DESIGN_KEY);
+    return getDesign?.();
+}

package/dist/design-utils.d.ts

@@ -0,0 +1,16 @@
+export interface ToCssOptions {
+    /** Keys to skip, matched against the original record key. */
+    exclude?: string[];
+    /** When set, only these keys pass through (still whitelist-filtered). */
+    include?: string[];
+}
+/**
+ * Convert a design record into a plain style object, keeping only keys that
+ * normalize to a known CSS property. Non-CSS keys (`variant`, `as`, …) and
+ * non-scalar values are dropped; read those off the `getDesignValues()`
+ * record directly.
+ *
+ *   toCss({ fontSize: '20px', variant: 'h1' }) //=> { fontSize: '20px' }
+ */
+export declare function toCss(design: object, { include, exclude }?: ToCssOptions): Record<string, string | number>;
+//# sourceMappingURL=design-utils.d.ts.map

package/dist/design-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"design-utils.d.ts","sourceRoot":"","sources":["../src/design-utils.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,YAAY;IAC3B,6DAA6D;IAC7D,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,yEAAyE;IACzE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CACnB,MAAM,EAAE,MAAM,EACd,EAAE,OAAO,EAAE,OAAO,EAAE,GAAE,YAAiB,GACtC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAYjC"}

package/dist/design-utils.js

@@ -0,0 +1,27 @@
+import { isCssProperty, toCssKey } from '@contentful/experiences-design';
+/**
+ * Convert a design record into a plain style object, keeping only keys that
+ * normalize to a known CSS property. Non-CSS keys (`variant`, `as`, …) and
+ * non-scalar values are dropped; read those off the `getDesignValues()`
+ * record directly.
+ *
+ *   toCss({ fontSize: '20px', variant: 'h1' }) //=> { fontSize: '20px' }
+ */
+export function toCss(design, { include, exclude } = {}) {
+    const out = {};
+    for (const [key, value] of Object.entries(design)) {
+        if (include && !include.includes(key))
+            continue;
+        if (exclude?.includes(key))
+            continue;
+        if (value === undefined || value === null)
+            continue;
+        if (typeof value !== 'string' && typeof value !== 'number')
+            continue;
+        const cssKey = toCssKey(key);
+        if (!isCssProperty(cssKey))
+            continue;
+        out[cssKey] = value;
+    }
+    return out;
+}

package/dist/get-design-values.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Read the current node's resolved design values (viewport-cascaded +
+ * token-resolved). Returns `{}` when there's no design in scope. Read it
+ * inside a `$derived` to stay current across viewport changes.
+ *
+ * Pass a type argument to shape the bag:
+ *
+ *   const design = $derived(getDesignValues<{ as?: 'h1' | 'h2' }>());
+ *
+ * `T` is a convenience assertion, not validated at runtime — treat keys as
+ * possibly `undefined`.
+ */
+export declare function getDesignValues<T extends object = Record<string, unknown>>(): T;
+//# sourceMappingURL=get-design-values.d.ts.map

package/dist/get-design-values.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-design-values.d.ts","sourceRoot":"","sources":["../src/get-design-values.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,CAE/E"}

package/dist/get-design-values.js

@@ -0,0 +1,16 @@
+import { getResolvedDesign } from './context.js';
+/**
+ * Read the current node's resolved design values (viewport-cascaded +
+ * token-resolved). Returns `{}` when there's no design in scope. Read it
+ * inside a `$derived` to stay current across viewport changes.
+ *
+ * Pass a type argument to shape the bag:
+ *
+ *   const design = $derived(getDesignValues<{ as?: 'h1' | 'h2' }>());
+ *
+ * `T` is a convenience assertion, not validated at runtime — treat keys as
+ * possibly `undefined`.
+ */
+export function getDesignValues() {
+    return (getResolvedDesign() ?? {});
+}

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+export { default as ClientExperienceRenderer } from './ClientExperienceRenderer.svelte';
+export { default as ExperienceRenderer } from './ClientExperienceRenderer.svelte';
+export { default as ServerExperienceRenderer } from './ServerExperienceRenderer.svelte';
+export { default as MissingComponent } from './MissingComponent.svelte';
+export { default as NodesRenderer } from './NodesRenderer.svelte';
+export { useActiveViewport } from './use-active-viewport.svelte.js';
+export type { UseActiveViewportResult } from './use-active-viewport.svelte.js';
+export { getExperience, getContentfulComponent, getContentfulTemplate } from './context.js';
+export { getDesignValues } from './get-design-values.js';
+export { toCss } from './design-utils.js';
+export type { ToCssOptions } from './design-utils.js';
+export type { ClientExperienceRendererProps, ClientExperienceRendererProps as ExperienceRendererProps, MissingComponentProps, RenderUnknown, ServerExperienceRendererProps, } from './component-props.js';
+export { defineComponent, defineTemplate, normalizeComponentRegistration, normalizeTemplateRegistration, } from './types.js';
+export type { ComponentConfig, Components, Config, ContentfulComponent, ContentfulTemplate, Registration, RenderContext, ResolveToken, TemplateConfig, TemplateRegistration, Templates, } from './types.js';
+export { resolveExperience } from '@contentful/experiences-core';
+export type { ResolverConfig, ResolveExperienceOptions } from '@contentful/experiences-core';
+export type { ComponentTypeNode, ComponentTypeRef, DesignPropValue, DesignToken, ExperienceContext, ExperienceNode, ExperiencePayload, ExperienceSys, ManualDesignValue, PortableRegistration, PortableRenderNode, PortableRenderPlan, PortableTemplate, ResolveContext, TemplateNode, TemplateRef, ValuesByViewport, ViewportDef, } from '@contentful/experiences-core';
+export { CSS_PROPERTIES, getValueForViewport, getViewportIndex, isCssProperty, resolveDesignProperties, toCssKey, toCssMediaQuery, } from '@contentful/experiences-design';
+export { ContentfulViewDelivery, ContentfulViewDeliveryClient, NotFoundError, createClient, fetchExperience, } from '@contentful/experiences-client';
+export type { ClientOptions, CreateClientOptions, ExperienceOptions, ResolveOptions, } from '@contentful/experiences-client';
+//# 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":"AAeA,OAAO,EAAE,OAAO,IAAI,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AACxF,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,EAAE,OAAO,IAAI,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AACxF,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAIxE,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAElE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,YAAY,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAG/E,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAC5F,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAItD,YAAY,EACV,6BAA6B,EAC7B,6BAA6B,IAAI,uBAAuB,EACxD,qBAAqB,EACrB,aAAa,EACb,6BAA6B,GAC9B,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EACL,eAAe,EACf,cAAc,EACd,8BAA8B,EAC9B,6BAA6B,GAC9B,MAAM,YAAY,CAAC;AACpB,YAAY,EACV,eAAe,EACf,UAAU,EACV,MAAM,EACN,mBAAmB,EACnB,kBAAkB,EAClB,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,cAAc,EACd,oBAAoB,EACpB,SAAS,GACV,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,YAAY,EAAE,cAAc,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AAG7F,YAAY,EACV,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,WAAW,EACX,iBAAiB,EACjB,cAAc,EACd,iBAAiB,EACjB,aAAa,EACb,iBAAiB,EACjB,oBAAoB,EACpB,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,WAAW,EACX,gBAAgB,EAChB,WAAW,GACZ,MAAM,8BAA8B,CAAC;AAGtC,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,gBAAgB,EAChB,aAAa,EACb,uBAAuB,EACvB,QAAQ,EACR,eAAe,GAChB,MAAM,gCAAgC,CAAC;AAGxC,OAAO,EACL,sBAAsB,EACtB,4BAA4B,EAC5B,aAAa,EACb,YAAY,EACZ,eAAe,GAChB,MAAM,gCAAgC,CAAC;AACxC,YAAY,EACV,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,cAAc,GACf,MAAM,gCAAgC,CAAC"}

package/dist/index.js

@@ -0,0 +1,34 @@
+/*
+ * Public API surface for `@contentful/experiences-svelte`.
+ *
+ * Customers add ONLY this package to their app's dependencies. Everything
+ * needed to render an Experience — types, the resolver, viewport utilities,
+ * the renderer components, the authoring helpers — is re-exported from here.
+ * The internal `@contentful/experiences-core` and
+ * `@contentful/experiences-design` packages are workspace-only implementation
+ * details; they are not part of the public API.
+ *
+ * `ExperienceRenderer` is an alias for `ClientExperienceRenderer`; SSR
+ * consumers explicitly import `ServerExperienceRenderer`.
+ */
+// ─── Renderers ─────────────────────────────────────────────────────────────
+export { default as ClientExperienceRenderer } from './ClientExperienceRenderer.svelte';
+export { default as ExperienceRenderer } from './ClientExperienceRenderer.svelte';
+export { default as ServerExperienceRenderer } from './ServerExperienceRenderer.svelte';
+export { default as MissingComponent } from './MissingComponent.svelte';
+// Exposed so advanced customers can render non-`children` slots manually:
+// e.g. `<NodesRenderer nodes={contentful.slots.header as PortableRenderNode[]} ... />`.
+export { default as NodesRenderer } from './NodesRenderer.svelte';
+export { useActiveViewport } from './use-active-viewport.svelte.js';
+// ─── Runtime context helpers ─────────────────────────────────────────────
+export { getExperience, getContentfulComponent, getContentfulTemplate } from './context.js';
+export { getDesignValues } from './get-design-values.js';
+export { toCss } from './design-utils.js';
+// ─── Authoring helpers + Config types ─────────────────────────────────────
+export { defineComponent, defineTemplate, normalizeComponentRegistration, normalizeTemplateRegistration, } from './types.js';
+// ─── Resolver (re-exported from render-core) ──────────────────────────────
+export { resolveExperience } from '@contentful/experiences-core';
+// ─── Design utilities (re-exported from design) ───────────────────────────
+export { CSS_PROPERTIES, getValueForViewport, getViewportIndex, isCssProperty, resolveDesignProperties, toCssKey, toCssMediaQuery, } from '@contentful/experiences-design';
+// ─── Delivery client + fetchExperience ────────────────────────────────────
+export { ContentfulViewDelivery, ContentfulViewDeliveryClient, NotFoundError, createClient, fetchExperience, } from '@contentful/experiences-client';

package/dist/server-renderer.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=server-renderer.test.d.ts.map

package/dist/server-renderer.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server-renderer.test.d.ts","sourceRoot":"","sources":["../src/server-renderer.test.ts"],"names":[],"mappings":""}