@amplifyup/sdk 0.1.60 → 0.1.62

package/dist/{query-BqApXxQi.d.ts → query-3AXnQgzO.d.ts}

@@ -60,6 +60,7 @@ declare function selectVariants(options: SelectVariantsOptions): Promise<SelectV
  * Page resolve covers data known at Deploy. Visitor-triggered data — search,
  * load more, pickers — runs here: the browser asks AmplifyUp, AmplifyUp asks
  * the CMS. Only entities published with the page can be queried.
+ * Results are plain CMS rows, not Field envelopes, and are not canvas-editable.
  */
 
 type QueryFilterOp = 'eq' | 'neq' | 'in' | 'nin' | 'gt' | 'gte' | 'lt' | 'lte' | 'contains' | 'exists';

package/dist/{query-DaJlqU-Z.d.mts → query-DIZjc7st.d.mts}

@@ -60,6 +60,7 @@ declare function selectVariants(options: SelectVariantsOptions): Promise<SelectV
  * Page resolve covers data known at Deploy. Visitor-triggered data — search,
  * load more, pickers — runs here: the browser asks AmplifyUp, AmplifyUp asks
  * the CMS. Only entities published with the page can be queried.
+ * Results are plain CMS rows, not Field envelopes, and are not canvas-editable.
  */
 
 type QueryFilterOp = 'eq' | 'neq' | 'in' | 'nin' | 'gt' | 'gte' | 'lt' | 'lte' | 'contains' | 'exists';

package/dist/react.d.mts

@@ -2,15 +2,16 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import { P as PageConfig, c as AmplifyUpConfig, e as AmplifyPageContextInput, C as ContentSource, A as AmplifyContentMeta } from './types-Db_eLrfU.mjs';
 export { Z as ZoneConfig } from './types-Db_eLrfU.mjs';
 import React__default, { ReactNode } from 'react';
-export { AmplifyRenderer } from './AmplifyRenderer.mjs';
-export { Q as QueryContentError, e as QueryContentOptions, k as QueryFilter, l as QueryFilterOp, i as QueryPagination, h as QueryResult, m as QuerySort, j as QuerySpec, S as SelectVariantsError, a as SelectVariantsOptions, b as SelectVariantsResult, n as nextPageSpec, q as queryContent, d as searchSpec, s as selectVariants } from './query-DaJlqU-Z.mjs';
+import { L as LayoutComponentProps, F as Field$1 } from './AmplifyRenderer-W7eqltSj.mjs';
+export { A as AmplifyRenderer, b as Fields, I as ImageValue, a as isBrandedFields, i as isFieldEnvelope, t as toFieldEnvelopes } from './AmplifyRenderer-W7eqltSj.mjs';
+export { Q as QueryContentError, e as QueryContentOptions, k as QueryFilter, l as QueryFilterOp, i as QueryPagination, h as QueryResult, m as QuerySort, j as QuerySpec, S as SelectVariantsError, a as SelectVariantsOptions, b as SelectVariantsResult, n as nextPageSpec, q as queryContent, d as searchSpec, s as selectVariants } from './query-DIZjc7st.mjs';
 export { i as isComposerPreview, a as isPreviewRequest, b as isWorkingContentRequest } from './preview-_vHmzRen.mjs';
 
 type RenderComponentContext = {
     /** Unique layout-tree node id — required when multiple instances share a component type. */
     layoutNodeId: string;
 };
-type RenderComponentFn = (componentId: string, props: Record<string, any>, slots?: Record<string, ReactNode>, context?: RenderComponentContext) => ReactNode;
+type RenderComponentFn = (componentId: string, props: LayoutComponentProps, slots?: Record<string, ReactNode>, context?: RenderComponentContext) => ReactNode;
 interface AmplifyPageContentProps {
     /**
      * Native page content shown to visitors when no AmplifyUp layout is configured.
@@ -43,12 +44,6 @@ interface AmplifyPageContentProps {
  */
 declare function AmplifyPageContent({ fallback, renderComponent, pageConfig: pageConfigProp, forceComposerPreview, previewLoadingComponent, previewEmptyComponent, loadingComponent, emptyComponent, errorComponent, }: AmplifyPageContentProps): react_jsx_runtime.JSX.Element | null;
 
-declare function useLiveComposerProps(layoutNodeId: string | undefined, props: Record<string, any>): Record<string, any>;
-/**
- * Live props for this layout node (CMS fields + settings).
- * Same values `<Field>` reads — use this when you want to render yourself.
- */
-declare function useComponentProps<T extends Record<string, any> = Record<string, any>>(): T;
 declare function ComponentContextProvider({ children, slots, props, layoutNodeId, componentId, }: {
     children: ReactNode;
     slots?: Record<string, ReactNode>;
@@ -87,44 +82,39 @@ declare function Slot({ name, className, }: {
     className?: string;
 }): react_jsx_runtime.JSX.Element | null;
 declare function Field(props: {
-    /** Field value from your component props. Do not also pass `name`. */
+    /** Envelope from `props.fields` (`{ value, name }`). */
+    field?: Field$1<unknown>;
+    /** Computed value — requires `name`. */
     value?: unknown;
-    /**
-     * @deprecated Prefer `value={…}`. Still used as the Composer save key when
-     * the same value appears on more than one prop.
-     */
+    /** Required with `value` for computed values. */
     name?: string;
-    fallback?: ReactNode;
     className?: string;
     render?: (value: any) => ReactNode;
 }): string | number | true | Iterable<React__default.ReactNode> | react_jsx_runtime.JSX.Element | null;
 /**
  * RichText - Renders a markdown (or HTML string) value as formatted HTML.
  *
- * Pass the field value from your component props (`value={body}`). Values are
- * Markdown for portability across CMS platforms.
+ * Pass a field envelope: `<RichText field={fields.body} />`.
+ * Values are Markdown for portability across CMS platforms.
  *
  * @example
  * ```tsx
- * function Article({ title, body }: { title: string; body: string }) {
+ * function Article({ fields }: { fields: Fields<{ title: string; body: string }> }) {
  *   return (
  *     <article>
- *       <h1><Field value={title} /></h1>
- *       <RichText value={body} className="prose" />
+ *       <h1><Field field={fields.title} /></h1>
+ *       <RichText field={fields.body} className="prose" />
  *     </article>
  *   );
  * }
  * ```
  */
 declare function RichText(props: {
-    /** Markdown (or HTML) string from your component props. Do not also pass `name`. */
+    field?: Field$1<string | null>;
+    /** Computed markdown — requires `name`. */
     value?: string | null;
-    /**
-     * @deprecated Prefer `value={…}`. Still used as the Composer save key when
-     * the same value appears on more than one prop.
-     */
+    /** Required with `value` for computed values. */
     name?: string;
-    fallback?: ReactNode;
     className?: string;
     as?: keyof JSX.IntrinsicElements;
     /** String children are treated as the markdown value (same as `value`). */
@@ -133,29 +123,37 @@ declare function RichText(props: {
 /**
  * Image — renders a provider-backed image value as `<img>`.
  *
- * Pass the portable `{ url, alt?, width?, height? }` (or URL string) from your
- * component props via `value`. AmplifyUp does not host image files.
+ * Pass a field envelope: `<Image field={fields.backgroundImage} />`.
+ * AmplifyUp does not host image files.
  *
  * @example
  * ```tsx
- * function Hero({ backgroundImage }: { backgroundImage: { url: string } }) {
+ * function Hero({ fields }: { fields: Fields<{ backgroundImage: ImageValue }> }) {
  *   return (
- *     <Image value={backgroundImage} className="h-full w-full object-cover" />
+ *     <Image field={fields.backgroundImage} className="h-full w-full object-cover" />
  *   );
  * }
  * ```
  */
 declare function Image(props: {
-    /** Portable image or URL string from your component props. Do not also pass `name`. */
+    field?: Field$1<unknown>;
+    /** Computed image — requires `name`. */
     value?: unknown;
-    /**
-     * @deprecated Will be removed. Use `value={…}` and omit `name`.
-     * Do not pass `name` together with `value`.
-     */
+    /** Required with `value` for computed values. */
     name?: string;
     alt?: string;
 } & Omit<React__default.ImgHTMLAttributes<HTMLImageElement>, 'src' | 'alt' | 'name'>): react_jsx_runtime.JSX.Element | null;
 
+declare function ComposerProvider({ layoutNodeId, children, }: {
+    layoutNodeId?: string;
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function MaybeComposerProvider({ enabled, layoutNodeId, children, }: {
+    enabled: boolean;
+    layoutNodeId?: string;
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
 interface AmplifyUpContextType {
     pageConfig: PageConfig | null;
     loading: boolean;
@@ -175,4 +173,4 @@ interface AmplifyUpProviderProps {
 declare function AmplifyUpProvider({ children, config, pageContext, }: AmplifyUpProviderProps): react_jsx_runtime.JSX.Element;
 declare function useAmplifyUp(): AmplifyUpContextType;
 
-export { AmplifyContentMeta, AmplifyPageContent, AmplifyUpProvider, ComponentContextProvider, ContentSource, Field, Image, PageConfig, RichText, Slot, useAmplifyUp, useComponentProps, useLiveComposerProps };
+export { AmplifyContentMeta, AmplifyPageContent, AmplifyUpProvider, ComponentContextProvider, ComposerProvider, ContentSource, Field, Field$1 as FieldEnvelope, Image, LayoutComponentProps, MaybeComposerProvider, PageConfig, RichText, Slot, useAmplifyUp };

package/dist/react.d.ts

@@ -2,15 +2,16 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import { P as PageConfig, c as AmplifyUpConfig, e as AmplifyPageContextInput, C as ContentSource, A as AmplifyContentMeta } from './types-Db_eLrfU.js';
 export { Z as ZoneConfig } from './types-Db_eLrfU.js';
 import React__default, { ReactNode } from 'react';
-export { AmplifyRenderer } from './AmplifyRenderer.js';
-export { Q as QueryContentError, e as QueryContentOptions, k as QueryFilter, l as QueryFilterOp, i as QueryPagination, h as QueryResult, m as QuerySort, j as QuerySpec, S as SelectVariantsError, a as SelectVariantsOptions, b as SelectVariantsResult, n as nextPageSpec, q as queryContent, d as searchSpec, s as selectVariants } from './query-BqApXxQi.js';
+import { L as LayoutComponentProps, F as Field$1 } from './AmplifyRenderer-BQ8-H2H4.js';
+export { A as AmplifyRenderer, b as Fields, I as ImageValue, a as isBrandedFields, i as isFieldEnvelope, t as toFieldEnvelopes } from './AmplifyRenderer-BQ8-H2H4.js';
+export { Q as QueryContentError, e as QueryContentOptions, k as QueryFilter, l as QueryFilterOp, i as QueryPagination, h as QueryResult, m as QuerySort, j as QuerySpec, S as SelectVariantsError, a as SelectVariantsOptions, b as SelectVariantsResult, n as nextPageSpec, q as queryContent, d as searchSpec, s as selectVariants } from './query-3AXnQgzO.js';
 export { i as isComposerPreview, a as isPreviewRequest, b as isWorkingContentRequest } from './preview-_vHmzRen.js';
 
 type RenderComponentContext = {
     /** Unique layout-tree node id — required when multiple instances share a component type. */
     layoutNodeId: string;
 };
-type RenderComponentFn = (componentId: string, props: Record<string, any>, slots?: Record<string, ReactNode>, context?: RenderComponentContext) => ReactNode;
+type RenderComponentFn = (componentId: string, props: LayoutComponentProps, slots?: Record<string, ReactNode>, context?: RenderComponentContext) => ReactNode;
 interface AmplifyPageContentProps {
     /**
      * Native page content shown to visitors when no AmplifyUp layout is configured.
@@ -43,12 +44,6 @@ interface AmplifyPageContentProps {
  */
 declare function AmplifyPageContent({ fallback, renderComponent, pageConfig: pageConfigProp, forceComposerPreview, previewLoadingComponent, previewEmptyComponent, loadingComponent, emptyComponent, errorComponent, }: AmplifyPageContentProps): react_jsx_runtime.JSX.Element | null;
 
-declare function useLiveComposerProps(layoutNodeId: string | undefined, props: Record<string, any>): Record<string, any>;
-/**
- * Live props for this layout node (CMS fields + settings).
- * Same values `<Field>` reads — use this when you want to render yourself.
- */
-declare function useComponentProps<T extends Record<string, any> = Record<string, any>>(): T;
 declare function ComponentContextProvider({ children, slots, props, layoutNodeId, componentId, }: {
     children: ReactNode;
     slots?: Record<string, ReactNode>;
@@ -87,44 +82,39 @@ declare function Slot({ name, className, }: {
     className?: string;
 }): react_jsx_runtime.JSX.Element | null;
 declare function Field(props: {
-    /** Field value from your component props. Do not also pass `name`. */
+    /** Envelope from `props.fields` (`{ value, name }`). */
+    field?: Field$1<unknown>;
+    /** Computed value — requires `name`. */
     value?: unknown;
-    /**
-     * @deprecated Prefer `value={…}`. Still used as the Composer save key when
-     * the same value appears on more than one prop.
-     */
+    /** Required with `value` for computed values. */
     name?: string;
-    fallback?: ReactNode;
     className?: string;
     render?: (value: any) => ReactNode;
 }): string | number | true | Iterable<React__default.ReactNode> | react_jsx_runtime.JSX.Element | null;
 /**
  * RichText - Renders a markdown (or HTML string) value as formatted HTML.
  *
- * Pass the field value from your component props (`value={body}`). Values are
- * Markdown for portability across CMS platforms.
+ * Pass a field envelope: `<RichText field={fields.body} />`.
+ * Values are Markdown for portability across CMS platforms.
  *
  * @example
  * ```tsx
- * function Article({ title, body }: { title: string; body: string }) {
+ * function Article({ fields }: { fields: Fields<{ title: string; body: string }> }) {
  *   return (
  *     <article>
- *       <h1><Field value={title} /></h1>
- *       <RichText value={body} className="prose" />
+ *       <h1><Field field={fields.title} /></h1>
+ *       <RichText field={fields.body} className="prose" />
  *     </article>
  *   );
  * }
  * ```
  */
 declare function RichText(props: {
-    /** Markdown (or HTML) string from your component props. Do not also pass `name`. */
+    field?: Field$1<string | null>;
+    /** Computed markdown — requires `name`. */
     value?: string | null;
-    /**
-     * @deprecated Prefer `value={…}`. Still used as the Composer save key when
-     * the same value appears on more than one prop.
-     */
+    /** Required with `value` for computed values. */
     name?: string;
-    fallback?: ReactNode;
     className?: string;
     as?: keyof JSX.IntrinsicElements;
     /** String children are treated as the markdown value (same as `value`). */
@@ -133,29 +123,37 @@ declare function RichText(props: {
 /**
  * Image — renders a provider-backed image value as `<img>`.
  *
- * Pass the portable `{ url, alt?, width?, height? }` (or URL string) from your
- * component props via `value`. AmplifyUp does not host image files.
+ * Pass a field envelope: `<Image field={fields.backgroundImage} />`.
+ * AmplifyUp does not host image files.
  *
  * @example
  * ```tsx
- * function Hero({ backgroundImage }: { backgroundImage: { url: string } }) {
+ * function Hero({ fields }: { fields: Fields<{ backgroundImage: ImageValue }> }) {
  *   return (
- *     <Image value={backgroundImage} className="h-full w-full object-cover" />
+ *     <Image field={fields.backgroundImage} className="h-full w-full object-cover" />
  *   );
  * }
  * ```
  */
 declare function Image(props: {
-    /** Portable image or URL string from your component props. Do not also pass `name`. */
+    field?: Field$1<unknown>;
+    /** Computed image — requires `name`. */
     value?: unknown;
-    /**
-     * @deprecated Will be removed. Use `value={…}` and omit `name`.
-     * Do not pass `name` together with `value`.
-     */
+    /** Required with `value` for computed values. */
     name?: string;
     alt?: string;
 } & Omit<React__default.ImgHTMLAttributes<HTMLImageElement>, 'src' | 'alt' | 'name'>): react_jsx_runtime.JSX.Element | null;
 
+declare function ComposerProvider({ layoutNodeId, children, }: {
+    layoutNodeId?: string;
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function MaybeComposerProvider({ enabled, layoutNodeId, children, }: {
+    enabled: boolean;
+    layoutNodeId?: string;
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
 interface AmplifyUpContextType {
     pageConfig: PageConfig | null;
     loading: boolean;
@@ -175,4 +173,4 @@ interface AmplifyUpProviderProps {
 declare function AmplifyUpProvider({ children, config, pageContext, }: AmplifyUpProviderProps): react_jsx_runtime.JSX.Element;
 declare function useAmplifyUp(): AmplifyUpContextType;
 
-export { AmplifyContentMeta, AmplifyPageContent, AmplifyUpProvider, ComponentContextProvider, ContentSource, Field, Image, PageConfig, RichText, Slot, useAmplifyUp, useComponentProps, useLiveComposerProps };
+export { AmplifyContentMeta, AmplifyPageContent, AmplifyUpProvider, ComponentContextProvider, ComposerProvider, ContentSource, Field, Field$1 as FieldEnvelope, Image, LayoutComponentProps, MaybeComposerProvider, PageConfig, RichText, Slot, useAmplifyUp };