@builder.io/sdk-svelte 0.11.2 → 0.11.3

package/src/blocks/fragment/fragment.svelte

@@ -1,12 +1,5 @@
-<script context="module" lang="ts">
-  export interface FragmentProps {
-    maxWidth?: number;
-    attributes?: any;
-    children?: any;
-  }
-</script>
-
 <script lang="ts">
+  import type { FragmentProps } from "./fragment.types.js";
 </script>
 
 <span><slot /></span>

package/src/blocks/fragment/fragment.types.ts

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

package/src/blocks/image/image.svelte

@@ -1,27 +1,6 @@
-<script context="module" lang="ts">
-  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;
-  }
-</script>
-
 <script lang="ts">
-  import type { BuilderBlock } from "../../types/builder-block.js";
   import { getSrcSet } from "./image.helpers.js";
+  import type { ImageProps } from "./image.types.js";
 
   export let image: ImageProps["image"];
   export let src: ImageProps["src"] = undefined;

package/src/blocks/image/image.types.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/src/blocks/section/section.svelte

@@ -1,18 +1,6 @@
-<script context="module" lang="ts">
-  /**
-   * This import is used by the Svelte SDK. Do not remove.
-   */
-
-  export interface SectionProps {
-    maxWidth?: number;
-    attributes?: any;
-    children?: any;
-    builderBlock?: any;
-  }
-</script>
-
 <script lang="ts">
   import { filterAttrs } from "../helpers.js";
+  import type { SectionProps } from "./section.types.js";
   import { setAttrs } from "../helpers.js";
 
   export let attributes: SectionProps["attributes"] = undefined;

package/src/blocks/section/section.types.ts

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

package/src/blocks/symbol/symbol.svelte

@@ -1,43 +1,14 @@
-<script context="module" lang="ts">
-  /**
-   * 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;
-  }
-</script>
-
 <script lang="ts">
   import { onMount } from "svelte";
 
   import ContentVariants from "../../components/content-variants/content-variants.svelte";
   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 { filterAttrs } from "../helpers.js";
   import type { Nullable } from "../../types/typescript.js";
   import { setAttrs } from "../helpers.js";
   import { fetchSymbolContent } from "./symbol.helpers.js";
+  import type { SymbolProps } from "./symbol.types.js";
 
   export let js: PropsWithBuilderData<SymbolProps>["js"];
   export let attributes: PropsWithBuilderData<SymbolProps>["attributes"] =

package/src/blocks/symbol/symbol.types.ts

@@ -0,0 +1,17 @@
+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;
+}

package/src/blocks/text/text.svelte

@@ -1,10 +1,6 @@
-<script context="module" lang="ts">
-  export interface TextProps {
-    text?: string;
-  }
-</script>
-
 <script lang="ts">
+  import type { TextProps } from "./text.types.js";
+
   export let text: TextProps["text"] = undefined;
 
   function mitosis_styling(node, vars) {

package/src/blocks/text/text.types.ts

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

package/src/blocks/video/video.svelte

@@ -1,37 +1,5 @@
-<script context="module" lang="ts">
-  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;
-  }
-</script>
-
 <script lang="ts">
-  import type { BuilderBlock } from "../../types/builder-block.js";
+  import type { VideoProps } from "./video.types.js";
 
   export let autoPlay: VideoProps["autoPlay"] = undefined;
   export let muted: VideoProps["muted"] = undefined;

package/src/blocks/video/video.types.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/src/components/block/block.svelte

@@ -112,6 +112,8 @@
 </script>
 
 {#if canShowBlock()}
+  <BlockStyles {block} context={$context} />
+
   {#if !blockComponent?.()?.noWrap}
     {#if isEmptyHtmlElement(Tag())}
       <BlockWrapper
@@ -150,17 +152,13 @@
           isInteractive={componentRefProps().isInteractive}
         />
 
-        {#each childrenWithoutParentComponent() as child ("block-" + child.id)}
+        {#each childrenWithoutParentComponent() as child (child.id)}
           <svelte:self
             block={child}
             context={childrenContext}
             {registeredComponents}
           />
         {/each}
-
-        {#each childrenWithoutParentComponent() as child ("block-style-" + child.id)}
-          <BlockStyles block={child} context={$childrenContext} />
-        {/each}
       </BlockWrapper>
     {/if}
   {:else}

package/src/components/block/components/component-ref/component-ref.svelte

@@ -1,7 +1,6 @@
 <script lang="ts">
   import { wrapComponentRef } from "../../../content/wrap-component-ref.js";
   import Block from "../../block.svelte";
-  import BlockStyles from "../block-styles.svelte";
   import InteractiveElement from "../interactive-element.svelte";
   import type { ComponentProps } from "./component-ref.helpers.js";
   import { getWrapperProps } from "./component-ref.helpers.js";
@@ -31,12 +30,8 @@
       contextValue: $context,
     })}
   >
-    {#each blockChildren as child ("block-" + child.id)}
+    {#each blockChildren as child (child.id)}
       <Block block={child} {context} {registeredComponents} />
     {/each}
-
-    {#each blockChildren as child ("block-style-" + child.id)}
-      <BlockStyles block={child} context={$context} />
-    {/each}
   </svelte:component>
 {/if}

package/src/components/blocks/blocks.svelte

@@ -1,26 +1,11 @@
-<script context="module" lang="ts">
-  export type BlocksProps = Partial<
-    Omit<BlocksWrapperProps, "BlocksWrapper" | "BlocksWrapperProps">
-  > & {
-    context?: Writable<BuilderContextInterface>;
-    registeredComponents?: RegisteredComponents;
-  };
-</script>
-
 <script lang="ts">
   import { getContext } from "svelte";
 
   import BuilderContext from "../../context/builder.context.js";
   import ComponentsContext from "../../context/components.context.js";
-  import type {
-    BuilderContextInterface,
-    RegisteredComponents,
-  } from "../../context/types.js";
   import Block from "../block/block.svelte";
-  import BlockStyles from "../block/components/block-styles.svelte";
-  import type { BlocksWrapperProps } from "./blocks-wrapper.svelte";
   import BlocksWrapper from "./blocks-wrapper.svelte";
-  import type { Writable } from "svelte/store";
+  import type { BlocksProps } from "./blocks.types.js";
 
   export let blocks: BlocksProps["blocks"];
   export let parent: BlocksProps["parent"];
@@ -43,7 +28,7 @@
   BlocksWrapperProps={$context?.BlocksWrapperProps}
 >
   {#if blocks}
-    {#each blocks as block ("render-block-" + block.id)}
+    {#each blocks as block (block.id)}
       <Block
         {block}
         context={context || builderContext}
@@ -52,10 +37,4 @@
       />
     {/each}
   {/if}
-
-  {#if blocks}
-    {#each blocks as block ("block-style-" + block.id)}
-      <BlockStyles {block} context={$context || $builderContext} />
-    {/each}
-  {/if}
 </BlocksWrapper>

package/src/components/blocks/blocks.types.ts

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

package/src/components/content-variants/content-variants.types.ts

@@ -3,32 +3,74 @@ 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).
    */
   contentWrapper?: any;
+
   /**
    * Additonal props to pass to `contentWrapper`. Defaults to `{}`.
    */
   contentWrapperProps?: any;
+
   /**
    * The element that wraps your blocks. Defaults to `div` ('ScrollView' in React Native).
    */
   blocksWrapper?: any;
+
   /**
    * Additonal props to pass to `blocksWrapper`. Defaults to `{}`.
    */

package/src/constants/sdk-version.ts

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

package/src/functions/get-content/index.ts

@@ -11,7 +11,7 @@ import type { GetContentOptions } from './types.js';
 const checkContentHasResults = (content: ContentResponse): content is ContentResults => 'results' in content;
 
 /**
- * Returns a the first entry that matches the given options.
+ * Returns the first content entry that matches the given options.
  */
 export async function fetchOneEntry(options: GetContentOptions): Promise<BuilderContent | null> {
   const allContent = await fetchEntries({

package/src/functions/get-content/types.ts

@@ -1,8 +1,8 @@
 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 */

package/src/server-index.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'