@amplifyup/sdk 0.1.62 → 0.1.63

package/dist/react.d.mts

@@ -1,9 +1,9 @@
 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';
-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';
+import react__default, { ReactNode } from 'react';
+import { L as LayoutComponentProps, F as Field$1, C as CollectionField, a as Fields } from './AmplifyRenderer-TawbUIKZ.mjs';
+export { A as AmplifyRenderer, I as ImageValue, P as PortableRef, b as isBrandedFields, i as isFieldEnvelope, t as toFieldEnvelopes } from './AmplifyRenderer-TawbUIKZ.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';
 
@@ -81,16 +81,50 @@ declare function Slot({ name, className, }: {
     name: string;
     className?: string;
 }): react_jsx_runtime.JSX.Element | null;
-declare function Field(props: {
-    /** Envelope from `props.fields` (`{ value, name }`). */
-    field?: Field$1<unknown>;
+type RejectArray<T> = [T] extends [readonly unknown[]] ? never : T;
+/**
+ * Field Component
+ *
+ * Pass a field envelope: `<Field field={fields.title} />`.
+ * For a computed value, pass `value` and `name`.
+ *
+ * For markdown / rich text fields, use {@link RichText} instead.
+ * List fields use {@link Collection} (repeaters) or `.value` (reference lists).
+ *
+ * @example
+ * ```tsx
+ * function Hero({ fields }: { fields: Fields<{ title: string; description: string }> }) {
+ *   return (
+ *     <section className="hero">
+ *       <h1>
+ *         <Field field={fields.title} />
+ *       </h1>
+ *       <p>{fields.description.value}</p>
+ *     </section>
+ *   );
+ * }
+ * ```
+ */
+declare function Field<T = unknown>(props: {
+    /** Envelope from `props.fields` (`{ value, name }`). Arrays are not allowed. */
+    field?: Field$1<RejectArray<T>>;
     /** Computed value — requires `name`. */
-    value?: unknown;
+    value?: RejectArray<T>;
     /** Required with `value` for computed values. */
     name?: string;
     className?: string;
-    render?: (value: any) => ReactNode;
-}): string | number | true | Iterable<React__default.ReactNode> | react_jsx_runtime.JSX.Element | null;
+}): react_jsx_runtime.JSX.Element | null;
+/**
+ * Repeater (inline-authored list). Inside Composer: empty placeholder plus
+ * add / remove / reorder. Outside Composer: children only.
+ *
+ * Reference lists are not canvas-bound — map `fields.posts.value` instead.
+ */
+declare function Collection<T extends Record<string, unknown>>({ field, children, className, }: {
+    field: CollectionField<T> | Field$1<T[]>;
+    children: (item: Fields<T>, index: number) => ReactNode;
+    className?: string;
+}): react_jsx_runtime.JSX.Element | null;
 /**
  * RichText - Renders a markdown (or HTML string) value as formatted HTML.
  *
@@ -142,7 +176,7 @@ declare function Image(props: {
     /** Required with `value` for computed values. */
     name?: string;
     alt?: string;
-} & Omit<React__default.ImgHTMLAttributes<HTMLImageElement>, 'src' | 'alt' | 'name'>): react_jsx_runtime.JSX.Element | null;
+} & Omit<react__default.ImgHTMLAttributes<HTMLImageElement>, 'src' | 'alt' | 'name'>): react_jsx_runtime.JSX.Element | null;
 
 declare function ComposerProvider({ layoutNodeId, children, }: {
     layoutNodeId?: string;
@@ -173,4 +207,4 @@ interface AmplifyUpProviderProps {
 declare function AmplifyUpProvider({ children, config, pageContext, }: AmplifyUpProviderProps): react_jsx_runtime.JSX.Element;
 declare function useAmplifyUp(): AmplifyUpContextType;
 
-export { AmplifyContentMeta, AmplifyPageContent, AmplifyUpProvider, ComponentContextProvider, ComposerProvider, ContentSource, Field, Field$1 as FieldEnvelope, Image, LayoutComponentProps, MaybeComposerProvider, PageConfig, RichText, Slot, useAmplifyUp };
+export { AmplifyContentMeta, AmplifyPageContent, AmplifyUpProvider, Collection, CollectionField, ComponentContextProvider, ComposerProvider, ContentSource, Field, Field$1 as FieldEnvelope, Fields, Image, LayoutComponentProps, MaybeComposerProvider, PageConfig, RichText, Slot, useAmplifyUp };

package/dist/react.d.ts

@@ -1,9 +1,9 @@
 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';
-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';
+import react__default, { ReactNode } from 'react';
+import { L as LayoutComponentProps, F as Field$1, C as CollectionField, a as Fields } from './AmplifyRenderer-Bwob7ICJ.js';
+export { A as AmplifyRenderer, I as ImageValue, P as PortableRef, b as isBrandedFields, i as isFieldEnvelope, t as toFieldEnvelopes } from './AmplifyRenderer-Bwob7ICJ.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';
 
@@ -81,16 +81,50 @@ declare function Slot({ name, className, }: {
     name: string;
     className?: string;
 }): react_jsx_runtime.JSX.Element | null;
-declare function Field(props: {
-    /** Envelope from `props.fields` (`{ value, name }`). */
-    field?: Field$1<unknown>;
+type RejectArray<T> = [T] extends [readonly unknown[]] ? never : T;
+/**
+ * Field Component
+ *
+ * Pass a field envelope: `<Field field={fields.title} />`.
+ * For a computed value, pass `value` and `name`.
+ *
+ * For markdown / rich text fields, use {@link RichText} instead.
+ * List fields use {@link Collection} (repeaters) or `.value` (reference lists).
+ *
+ * @example
+ * ```tsx
+ * function Hero({ fields }: { fields: Fields<{ title: string; description: string }> }) {
+ *   return (
+ *     <section className="hero">
+ *       <h1>
+ *         <Field field={fields.title} />
+ *       </h1>
+ *       <p>{fields.description.value}</p>
+ *     </section>
+ *   );
+ * }
+ * ```
+ */
+declare function Field<T = unknown>(props: {
+    /** Envelope from `props.fields` (`{ value, name }`). Arrays are not allowed. */
+    field?: Field$1<RejectArray<T>>;
     /** Computed value — requires `name`. */
-    value?: unknown;
+    value?: RejectArray<T>;
     /** Required with `value` for computed values. */
     name?: string;
     className?: string;
-    render?: (value: any) => ReactNode;
-}): string | number | true | Iterable<React__default.ReactNode> | react_jsx_runtime.JSX.Element | null;
+}): react_jsx_runtime.JSX.Element | null;
+/**
+ * Repeater (inline-authored list). Inside Composer: empty placeholder plus
+ * add / remove / reorder. Outside Composer: children only.
+ *
+ * Reference lists are not canvas-bound — map `fields.posts.value` instead.
+ */
+declare function Collection<T extends Record<string, unknown>>({ field, children, className, }: {
+    field: CollectionField<T> | Field$1<T[]>;
+    children: (item: Fields<T>, index: number) => ReactNode;
+    className?: string;
+}): react_jsx_runtime.JSX.Element | null;
 /**
  * RichText - Renders a markdown (or HTML string) value as formatted HTML.
  *
@@ -142,7 +176,7 @@ declare function Image(props: {
     /** Required with `value` for computed values. */
     name?: string;
     alt?: string;
-} & Omit<React__default.ImgHTMLAttributes<HTMLImageElement>, 'src' | 'alt' | 'name'>): react_jsx_runtime.JSX.Element | null;
+} & Omit<react__default.ImgHTMLAttributes<HTMLImageElement>, 'src' | 'alt' | 'name'>): react_jsx_runtime.JSX.Element | null;
 
 declare function ComposerProvider({ layoutNodeId, children, }: {
     layoutNodeId?: string;
@@ -173,4 +207,4 @@ interface AmplifyUpProviderProps {
 declare function AmplifyUpProvider({ children, config, pageContext, }: AmplifyUpProviderProps): react_jsx_runtime.JSX.Element;
 declare function useAmplifyUp(): AmplifyUpContextType;
 
-export { AmplifyContentMeta, AmplifyPageContent, AmplifyUpProvider, ComponentContextProvider, ComposerProvider, ContentSource, Field, Field$1 as FieldEnvelope, Image, LayoutComponentProps, MaybeComposerProvider, PageConfig, RichText, Slot, useAmplifyUp };
+export { AmplifyContentMeta, AmplifyPageContent, AmplifyUpProvider, Collection, CollectionField, ComponentContextProvider, ComposerProvider, ContentSource, Field, Field$1 as FieldEnvelope, Fields, Image, LayoutComponentProps, MaybeComposerProvider, PageConfig, RichText, Slot, useAmplifyUp };