@builder.io/sdk-react-nextjs 0.11.2 → 0.11.3

package/types/cjs/blocks/symbol/symbol.d.ts

@@ -1,26 +1,5 @@
 import * as React from "react";
-/**
- * This import is used by the Svelte SDK. Do not remove.
- */
-export interface SymbolInfo {
-    model?: string;
-    entry?: string;
-    data?: any;
-    content?: BuilderContent;
-    inline?: boolean;
-    dynamic?: boolean;
-}
-/**
- * This import is used by the Svelte SDK. Do not remove.
- */
-export interface SymbolProps extends BuilderComponentsProp {
-    symbol?: SymbolInfo;
-    dataOnly?: boolean;
-    dynamic?: boolean;
-    attributes?: any;
-    inheritState?: boolean;
-}
-import type { BuilderContent } from "../../types/builder-content.js";
-import type { BuilderComponentsProp, PropsWithBuilderData } from "../../types/builder-props.js";
+import type { PropsWithBuilderData } from "../../types/builder-props.js";
+import type { SymbolProps } from "./symbol.types.js";
 declare function Symbol(props: PropsWithBuilderData<SymbolProps>): Promise<React.JSX.Element>;
 export default Symbol;

package/types/cjs/blocks/symbol/symbol.types.d.ts

@@ -0,0 +1,18 @@
+import type { BuilderContent } from '../../types/builder-content.js';
+import type { BuilderComponentsProp } from '../../types/builder-props.js';
+interface SymbolInfo {
+    model?: string;
+    entry?: string;
+    data?: any;
+    content?: BuilderContent;
+    inline?: boolean;
+    dynamic?: boolean;
+}
+export interface SymbolProps extends BuilderComponentsProp {
+    symbol?: SymbolInfo;
+    dataOnly?: boolean;
+    dynamic?: boolean;
+    attributes?: any;
+    inheritState?: boolean;
+}
+export {};

package/types/cjs/blocks/text/text.d.ts

@@ -1,6 +1,4 @@
 import * as React from "react";
-export interface TextProps {
-    text?: string;
-}
+import type { TextProps } from "./text.types.js";
 declare function Text(props: TextProps): React.JSX.Element;
 export default Text;

package/types/cjs/blocks/text/text.types.d.ts

@@ -0,0 +1,3 @@
+export type TextProps = {
+    text?: string;
+};

package/types/cjs/blocks/video/video.d.ts

@@ -1,24 +1,4 @@
 import * as React from "react";
-export interface VideoProps {
-    attributes?: any;
-    video?: string;
-    autoPlay?: boolean;
-    controls?: boolean;
-    muted?: boolean;
-    loop?: boolean;
-    playsInline?: boolean;
-    aspectRatio?: number;
-    width?: number;
-    height?: number;
-    fit?: "contain" | "cover" | "fill";
-    preload?: "auto" | "metadata" | "none";
-    position?: "center" | "top" | "left" | "right" | "bottom" | "top left" | "top right" | "bottom left" | "bottom right";
-    posterImage?: string;
-    lazyLoad?: boolean;
-    children?: any;
-    fitContent?: boolean;
-    builderBlock?: BuilderBlock;
-}
-import type { BuilderBlock } from "../../types/builder-block.js";
+import type { VideoProps } from "./video.types.js";
 declare function Video(props: VideoProps): React.JSX.Element;
 export default Video;

package/types/cjs/blocks/video/video.types.d.ts

@@ -0,0 +1,21 @@
+import type { BuilderBlock } from '../../types/builder-block.js';
+export interface VideoProps {
+    attributes?: any;
+    video?: string;
+    autoPlay?: boolean;
+    controls?: boolean;
+    muted?: boolean;
+    loop?: boolean;
+    playsInline?: boolean;
+    aspectRatio?: number;
+    width?: number;
+    height?: number;
+    fit?: 'contain' | 'cover' | 'fill';
+    preload?: 'auto' | 'metadata' | 'none';
+    position?: 'center' | 'top' | 'left' | 'right' | 'bottom' | 'top left' | 'top right' | 'bottom left' | 'bottom right';
+    posterImage?: string;
+    lazyLoad?: boolean;
+    children?: any;
+    fitContent?: boolean;
+    builderBlock?: BuilderBlock;
+}

package/types/cjs/components/blocks/blocks.d.ts

@@ -1,9 +1,4 @@
 import * as React from "react";
-export type BlocksProps = Partial<Omit<BlocksWrapperProps, "BlocksWrapper" | "BlocksWrapperProps">> & {
-    context?: BuilderContextInterface;
-    registeredComponents?: RegisteredComponents;
-};
-import type { BuilderContextInterface, RegisteredComponents } from "../../context/types.js";
-import type { BlocksWrapperProps } from "./blocks-wrapper.js";
+import type { BlocksProps } from "./blocks.types.js";
 declare function Blocks(props: BlocksProps): React.JSX.Element;
 export default Blocks;

package/types/cjs/components/blocks/blocks.types.d.ts

@@ -0,0 +1,6 @@
+import type { BuilderContextInterface, RegisteredComponents } from '../../context/types.js';
+import type { BlocksWrapperProps } from './blocks-wrapper.js';
+export type BlocksProps = Partial<Omit<BlocksWrapperProps, 'BlocksWrapper' | 'BlocksWrapperProps'>> & {
+    context?: BuilderContextInterface;
+    registeredComponents?: RegisteredComponents;
+};

package/types/cjs/components/content-variants/content-variants.types.d.ts

@@ -3,19 +3,48 @@ import type { ApiVersion } from '../../types/api-version.js';
 import type { BuilderContent } from '../../types/builder-content.js';
 import type { Nullable } from '../../types/typescript.js';
 export interface ContentVariantsPrps {
+    /**
+     * The Builder content JSON to render (required).
+     */
     content?: Nullable<BuilderContent>;
+    /**
+     * The Builder content `model` to render (required).
+     */
     model?: string;
+    /**
+     * Additional data to inject into your Builder content (optional).
+     */
     data?: {
         [key: string]: any;
     };
+    /**
+     *
+     */
     context?: BuilderRenderContext;
+    /**
+     * Your API Key: needed to dynamically fetch symbols (required).
+     */
     apiKey: string;
     apiVersion?: ApiVersion;
+    /**
+     * An array of custom components to register (optional).
+     */
     customComponents?: RegisteredComponent[];
+    /**
+     * A boolean to enable or disable tracking (optional). Defaults to `true`.
+     */
     canTrack?: boolean;
+    /**
+     * If provided, the API will auto-resolve localized objects to the value of this `locale` key (optional).
+     */
     locale?: string;
-    /** @deprecated use `enrich` instead **/
+    /** @deprecated use `enrich` instead */
     includeRefs?: boolean;
+    /**
+     * A boolean to enable or disable enriching API content (optional).
+     *
+     * Enriching will Include multilevel references in the response. Defaults to `false`.
+     */
     enrich?: boolean;
     /**
      * The element that wraps your content. Defaults to `div` ('ScrollView' in React Native).

package/types/cjs/constants/sdk-version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.11.2";
+export declare const SDK_VERSION = "0.11.3";

package/types/cjs/functions/get-content/index.d.ts

@@ -1,7 +1,7 @@
 import type { BuilderContent } from '../../types/builder-content.js';
 import type { GetContentOptions } from './types.js';
 /**
- * Returns a the first entry that matches the given options.
+ * Returns the first content entry that matches the given options.
  */
 export declare function fetchOneEntry(options: GetContentOptions): Promise<BuilderContent | null>;
 /**

package/types/cjs/functions/get-content/types.d.ts

@@ -1,7 +1,7 @@
 export interface GetContentOptions {
-    /** The model to get content for */
+    /** The model to get content for (required) */
     model: string;
-    /** Your public API key */
+    /** Your public API key (required) */
     apiKey: string;
     /** Number of items to fetch. Default is 1 */
     limit?: number;

package/types/cjs/server-index.d.ts

@@ -1,4 +1,14 @@
 export * from './index-helpers/top-of-file.js';
+export type { ButtonProps } from './blocks/button/button.types.js';
+export type { ColumnProps } from './blocks/columns/columns.types.js';
+export type { FragmentProps } from './blocks/fragment/fragment.types.js';
+export type { ImageProps } from './blocks/image/image.types.js';
+export type { SectionProps } from './blocks/section/section.types.js';
+export type { SymbolProps } from './blocks/symbol/symbol.types.js';
+export type { TextProps } from './blocks/text/text.types.js';
+export type { VideoProps } from './blocks/video/video.types.js';
+export type { BlocksProps } from './components/blocks/blocks.types.js';
+export type { ContentVariantsPrps as ContentProps } from './components/content-variants/content-variants.types.js';
 export { isEditing } from './functions/is-editing.js';
 export { isPreviewing } from './functions/is-previewing.js';
 export { createRegisterComponentMessage } from './functions/register-component.js';
@@ -9,7 +19,6 @@ export type { Settings } from './functions/set-editor-settings.js';
 export { _processContentResult, fetchEntries, fetchOneEntry, getAllContent, getContent } from './functions/get-content/index.js';
 export { getBuilderSearchParams } from './functions/get-builder-search-params/index.js';
 export { track } from './functions/track/index.js';
-export type { ContentProps } from './components/content/content.types.js';
 export type { RegisteredComponent } from './context/types.js';
 export type { ComponentInfo } from './types/components.js';
 export { fetchBuilderProps } from './functions/fetch-builder-props.js';

package/types/esm/blocks/button/button.d.ts

@@ -1,12 +1,4 @@
 import * as React from "react";
-/**
- * This import is used by the Svelte SDK. Do not remove.
- */
-export interface ButtonProps {
-    attributes?: any;
-    text?: string;
-    link?: string;
-    openLinkInNewTab?: boolean;
-}
+import type { ButtonProps } from "./button.types.js";
 declare function Button(props: ButtonProps): React.JSX.Element;
 export default Button;

package/types/esm/blocks/button/button.types.d.ts

@@ -0,0 +1,6 @@
+export interface ButtonProps {
+    attributes?: any;
+    text?: string;
+    link?: string;
+    openLinkInNewTab?: boolean;
+}

package/types/esm/blocks/columns/columns.d.ts

@@ -1,17 +1,5 @@
 import * as React from "react";
-type Column = {
-    blocks: BuilderBlock[];
-    width?: number;
-};
-type StackColumnsAt = "tablet" | "mobile" | "never";
-export interface ColumnProps extends BuilderComponentsProp {
-    columns?: Column[];
-    builderBlock: BuilderBlock;
-    space?: number;
-    stackColumnsAt?: StackColumnsAt;
-    reverseColumnsWhenStacked?: boolean;
-}
-import type { BuilderBlock } from "../../types/builder-block.js";
-import type { BuilderComponentsProp, PropsWithBuilderData } from "../../types/builder-props.js";
+import type { PropsWithBuilderData } from "../../types/builder-props.js";
+import type { ColumnProps } from "./columns.types.js";
 declare function Columns(props: PropsWithBuilderData<ColumnProps>): React.JSX.Element;
 export default Columns;

package/types/esm/blocks/columns/columns.types.d.ts

@@ -0,0 +1,15 @@
+import type { BuilderBlock } from '../../types/builder-block.js';
+import type { BuilderComponentsProp } from '../../types/builder-props.js';
+type Column = {
+    blocks: BuilderBlock[];
+    width?: number;
+};
+type StackColumnsAt = 'tablet' | 'mobile' | 'never';
+export interface ColumnProps extends BuilderComponentsProp {
+    columns?: Column[];
+    builderBlock: BuilderBlock;
+    space?: number;
+    stackColumnsAt?: StackColumnsAt;
+    reverseColumnsWhenStacked?: boolean;
+}
+export {};

package/types/esm/blocks/fragment/fragment.d.ts

@@ -1,8 +1,4 @@
 import * as React from "react";
-export interface FragmentProps {
-    maxWidth?: number;
-    attributes?: any;
-    children?: any;
-}
+import type { FragmentProps } from "./fragment.types.js";
 declare function FragmentComponent(props: FragmentProps): React.JSX.Element;
 export default FragmentComponent;

package/types/esm/blocks/fragment/fragment.types.d.ts

@@ -0,0 +1,5 @@
+export interface FragmentProps {
+    maxWidth?: number;
+    attributes?: any;
+    children?: any;
+}

package/types/esm/blocks/image/image.d.ts

@@ -1,22 +1,4 @@
 import * as React from "react";
-export interface ImageProps {
-    className?: string;
-    image: string;
-    sizes?: string;
-    lazy?: boolean;
-    height?: number;
-    width?: number;
-    altText?: string;
-    backgroundSize?: "cover" | "contain";
-    backgroundPosition?: string;
-    srcset?: string;
-    aspectRatio?: number;
-    children?: any;
-    fitContent?: boolean;
-    builderBlock?: BuilderBlock;
-    noWebp?: boolean;
-    src?: string;
-}
-import type { BuilderBlock } from "../../types/builder-block.js";
+import type { ImageProps } from "./image.types.js";
 declare function Image(props: ImageProps): React.JSX.Element;
 export default Image;

package/types/esm/blocks/image/image.types.d.ts

@@ -0,0 +1,19 @@
+import type { BuilderBlock } from '../../types/builder-block.js';
+export interface ImageProps {
+    className?: string;
+    image: string;
+    sizes?: string;
+    lazy?: boolean;
+    height?: number;
+    width?: number;
+    altText?: string;
+    backgroundSize?: 'cover' | 'contain';
+    backgroundPosition?: string;
+    srcset?: string;
+    aspectRatio?: number;
+    children?: any;
+    fitContent?: boolean;
+    builderBlock?: BuilderBlock;
+    noWebp?: boolean;
+    src?: string;
+}

package/types/esm/blocks/section/section.d.ts

@@ -1,12 +1,4 @@
 import * as React from "react";
-/**
- * This import is used by the Svelte SDK. Do not remove.
- */
-export interface SectionProps {
-    maxWidth?: number;
-    attributes?: any;
-    children?: any;
-    builderBlock?: any;
-}
+import type { SectionProps } from "./section.types.js";
 declare function SectionComponent(props: SectionProps): React.JSX.Element;
 export default SectionComponent;

package/types/esm/blocks/section/section.types.d.ts

@@ -0,0 +1,6 @@
+export interface SectionProps {
+    maxWidth?: number;
+    attributes?: any;
+    children?: any;
+    builderBlock?: any;
+}

package/types/esm/blocks/symbol/symbol.d.ts

@@ -1,26 +1,5 @@
 import * as React from "react";
-/**
- * This import is used by the Svelte SDK. Do not remove.
- */
-export interface SymbolInfo {
-    model?: string;
-    entry?: string;
-    data?: any;
-    content?: BuilderContent;
-    inline?: boolean;
-    dynamic?: boolean;
-}
-/**
- * This import is used by the Svelte SDK. Do not remove.
- */
-export interface SymbolProps extends BuilderComponentsProp {
-    symbol?: SymbolInfo;
-    dataOnly?: boolean;
-    dynamic?: boolean;
-    attributes?: any;
-    inheritState?: boolean;
-}
-import type { BuilderContent } from "../../types/builder-content.js";
-import type { BuilderComponentsProp, PropsWithBuilderData } from "../../types/builder-props.js";
+import type { PropsWithBuilderData } from "../../types/builder-props.js";
+import type { SymbolProps } from "./symbol.types.js";
 declare function Symbol(props: PropsWithBuilderData<SymbolProps>): Promise<React.JSX.Element>;
 export default Symbol;

package/types/esm/blocks/symbol/symbol.types.d.ts

@@ -0,0 +1,18 @@
+import type { BuilderContent } from '../../types/builder-content.js';
+import type { BuilderComponentsProp } from '../../types/builder-props.js';
+interface SymbolInfo {
+    model?: string;
+    entry?: string;
+    data?: any;
+    content?: BuilderContent;
+    inline?: boolean;
+    dynamic?: boolean;
+}
+export interface SymbolProps extends BuilderComponentsProp {
+    symbol?: SymbolInfo;
+    dataOnly?: boolean;
+    dynamic?: boolean;
+    attributes?: any;
+    inheritState?: boolean;
+}
+export {};

package/types/esm/blocks/text/text.d.ts

@@ -1,6 +1,4 @@
 import * as React from "react";
-export interface TextProps {
-    text?: string;
-}
+import type { TextProps } from "./text.types.js";
 declare function Text(props: TextProps): React.JSX.Element;
 export default Text;

package/types/esm/blocks/text/text.types.d.ts

@@ -0,0 +1,3 @@
+export type TextProps = {
+    text?: string;
+};

package/types/esm/blocks/video/video.d.ts

@@ -1,24 +1,4 @@
 import * as React from "react";
-export interface VideoProps {
-    attributes?: any;
-    video?: string;
-    autoPlay?: boolean;
-    controls?: boolean;
-    muted?: boolean;
-    loop?: boolean;
-    playsInline?: boolean;
-    aspectRatio?: number;
-    width?: number;
-    height?: number;
-    fit?: "contain" | "cover" | "fill";
-    preload?: "auto" | "metadata" | "none";
-    position?: "center" | "top" | "left" | "right" | "bottom" | "top left" | "top right" | "bottom left" | "bottom right";
-    posterImage?: string;
-    lazyLoad?: boolean;
-    children?: any;
-    fitContent?: boolean;
-    builderBlock?: BuilderBlock;
-}
-import type { BuilderBlock } from "../../types/builder-block.js";
+import type { VideoProps } from "./video.types.js";
 declare function Video(props: VideoProps): React.JSX.Element;
 export default Video;

package/types/esm/blocks/video/video.types.d.ts

@@ -0,0 +1,21 @@
+import type { BuilderBlock } from '../../types/builder-block.js';
+export interface VideoProps {
+    attributes?: any;
+    video?: string;
+    autoPlay?: boolean;
+    controls?: boolean;
+    muted?: boolean;
+    loop?: boolean;
+    playsInline?: boolean;
+    aspectRatio?: number;
+    width?: number;
+    height?: number;
+    fit?: 'contain' | 'cover' | 'fill';
+    preload?: 'auto' | 'metadata' | 'none';
+    position?: 'center' | 'top' | 'left' | 'right' | 'bottom' | 'top left' | 'top right' | 'bottom left' | 'bottom right';
+    posterImage?: string;
+    lazyLoad?: boolean;
+    children?: any;
+    fitContent?: boolean;
+    builderBlock?: BuilderBlock;
+}

package/types/esm/components/blocks/blocks.d.ts

@@ -1,9 +1,4 @@
 import * as React from "react";
-export type BlocksProps = Partial<Omit<BlocksWrapperProps, "BlocksWrapper" | "BlocksWrapperProps">> & {
-    context?: BuilderContextInterface;
-    registeredComponents?: RegisteredComponents;
-};
-import type { BuilderContextInterface, RegisteredComponents } from "../../context/types.js";
-import type { BlocksWrapperProps } from "./blocks-wrapper.js";
+import type { BlocksProps } from "./blocks.types.js";
 declare function Blocks(props: BlocksProps): React.JSX.Element;
 export default Blocks;

package/types/esm/components/blocks/blocks.types.d.ts

@@ -0,0 +1,6 @@
+import type { BuilderContextInterface, RegisteredComponents } from '../../context/types.js';
+import type { BlocksWrapperProps } from './blocks-wrapper.js';
+export type BlocksProps = Partial<Omit<BlocksWrapperProps, 'BlocksWrapper' | 'BlocksWrapperProps'>> & {
+    context?: BuilderContextInterface;
+    registeredComponents?: RegisteredComponents;
+};

package/types/esm/components/content-variants/content-variants.types.d.ts

@@ -3,19 +3,48 @@ import type { ApiVersion } from '../../types/api-version.js';
 import type { BuilderContent } from '../../types/builder-content.js';
 import type { Nullable } from '../../types/typescript.js';
 export interface ContentVariantsPrps {
+    /**
+     * The Builder content JSON to render (required).
+     */
     content?: Nullable<BuilderContent>;
+    /**
+     * The Builder content `model` to render (required).
+     */
     model?: string;
+    /**
+     * Additional data to inject into your Builder content (optional).
+     */
     data?: {
         [key: string]: any;
     };
+    /**
+     *
+     */
     context?: BuilderRenderContext;
+    /**
+     * Your API Key: needed to dynamically fetch symbols (required).
+     */
     apiKey: string;
     apiVersion?: ApiVersion;
+    /**
+     * An array of custom components to register (optional).
+     */
     customComponents?: RegisteredComponent[];
+    /**
+     * A boolean to enable or disable tracking (optional). Defaults to `true`.
+     */
     canTrack?: boolean;
+    /**
+     * If provided, the API will auto-resolve localized objects to the value of this `locale` key (optional).
+     */
     locale?: string;
-    /** @deprecated use `enrich` instead **/
+    /** @deprecated use `enrich` instead */
     includeRefs?: boolean;
+    /**
+     * A boolean to enable or disable enriching API content (optional).
+     *
+     * Enriching will Include multilevel references in the response. Defaults to `false`.
+     */
     enrich?: boolean;
     /**
      * The element that wraps your content. Defaults to `div` ('ScrollView' in React Native).

package/types/esm/constants/sdk-version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.11.2";
+export declare const SDK_VERSION = "0.11.3";

package/types/esm/functions/get-content/index.d.ts

@@ -1,7 +1,7 @@
 import type { BuilderContent } from '../../types/builder-content.js';
 import type { GetContentOptions } from './types.js';
 /**
- * Returns a the first entry that matches the given options.
+ * Returns the first content entry that matches the given options.
  */
 export declare function fetchOneEntry(options: GetContentOptions): Promise<BuilderContent | null>;
 /**

package/types/esm/functions/get-content/types.d.ts

@@ -1,7 +1,7 @@
 export interface GetContentOptions {
-    /** The model to get content for */
+    /** The model to get content for (required) */
     model: string;
-    /** Your public API key */
+    /** Your public API key (required) */
     apiKey: string;
     /** Number of items to fetch. Default is 1 */
     limit?: number;

package/types/esm/server-index.d.ts

@@ -1,4 +1,14 @@
 export * from './index-helpers/top-of-file.js';
+export type { ButtonProps } from './blocks/button/button.types.js';
+export type { ColumnProps } from './blocks/columns/columns.types.js';
+export type { FragmentProps } from './blocks/fragment/fragment.types.js';
+export type { ImageProps } from './blocks/image/image.types.js';
+export type { SectionProps } from './blocks/section/section.types.js';
+export type { SymbolProps } from './blocks/symbol/symbol.types.js';
+export type { TextProps } from './blocks/text/text.types.js';
+export type { VideoProps } from './blocks/video/video.types.js';
+export type { BlocksProps } from './components/blocks/blocks.types.js';
+export type { ContentVariantsPrps as ContentProps } from './components/content-variants/content-variants.types.js';
 export { isEditing } from './functions/is-editing.js';
 export { isPreviewing } from './functions/is-previewing.js';
 export { createRegisterComponentMessage } from './functions/register-component.js';
@@ -9,7 +19,6 @@ export type { Settings } from './functions/set-editor-settings.js';
 export { _processContentResult, fetchEntries, fetchOneEntry, getAllContent, getContent } from './functions/get-content/index.js';
 export { getBuilderSearchParams } from './functions/get-builder-search-params/index.js';
 export { track } from './functions/track/index.js';
-export type { ContentProps } from './components/content/content.types.js';
 export type { RegisteredComponent } from './context/types.js';
 export type { ComponentInfo } from './types/components.js';
 export { fetchBuilderProps } from './functions/fetch-builder-props.js';