@builder.io/sdk-svelte 0.5.5 → 0.5.7

package/package/--package.json

@@ -1,7 +1,7 @@
 {
   "name": "@builder.io/sdk-svelte",
   "description": "Builder.io SDK for Svelte",
-  "version": "0.5.5",
+  "version": "0.5.7",
   "type": "module",
   "files": [
     "package",
@@ -107,6 +107,7 @@
     "./functions/event-handler-name": "./functions/event-handler-name.js",
     "./functions/extract-text-styles": "./functions/extract-text-styles.js",
     "./functions/fast-clone": "./functions/fast-clone.js",
+    "./functions/fetch-builder-props": "./functions/fetch-builder-props.js",
     "./functions/get-block-actions-handler": "./functions/get-block-actions-handler.js",
     "./functions/get-block-actions": "./functions/get-block-actions.js",
     "./functions/get-block-component-options": "./functions/get-block-component-options.js",
@@ -119,7 +120,6 @@
     "./functions/get-global-this": "./functions/get-global-this.js",
     "./functions/get-processed-block": "./functions/get-processed-block.js",
     "./functions/get-react-native-block-styles": "./functions/get-react-native-block-styles.js",
-    "./functions/if-target": "./functions/if-target.js",
     "./functions/is-browser": "./functions/is-browser.js",
     "./functions/is-editing": "./functions/is-editing.js",
     "./functions/is-iframe": "./functions/is-iframe.js",
@@ -190,6 +190,10 @@
     ],
     "targets": {
       "build": {
+        "dependsOn": [
+          "^build:svelte",
+          "^build"
+        ],
         "outputs": [
           "{projectRoot}/package"
         ]

package/package/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 0.5.7
+
+- No Changes.
+
+### 0.5.6
+
+- No Changes.
+
 ### 0.5.5
 
 - Fix: remove `lru-cache` import and usage.

package/package/blocks/BaseText.svelte

@@ -1,7 +1,7 @@
 <script context="module"></script>
 
 <script>import { getContext } from "svelte";
-import BuilderContext from "../context/builder.context";
+import BuilderContext from "../context/builder.context.js";
 export let text;
 function mitosis_styling(node, vars) {
     Object.entries(vars || {}).forEach(([p, v]) => {

package/package/blocks/symbol/symbol.helpers.d.ts

@@ -8,7 +8,7 @@ export interface SymbolInfo {
     inline?: boolean;
     dynamic?: boolean;
 }
-export declare const fetchContent: ({ builderContextValue, symbol }: {
+export declare const fetchSymbolContent: ({ builderContextValue, symbol }: {
     symbol: SymbolInfo | undefined;
     builderContextValue: BuilderContextInterface;
 }) => Promise<BuilderContent | null | undefined>;

package/package/blocks/symbol/symbol.helpers.js

@@ -1,6 +1,6 @@
-import { getContent } from '../../functions/get-content/index.js';
 import { logger } from '../../helpers/logger.js';
-export const fetchContent = async ({ builderContextValue, symbol }) => {
+import { fetchOneEntry } from '../../index.js';
+export const fetchSymbolContent = async ({ builderContextValue, symbol }) => {
     /**
      * If:
      * - we have a symbol prop
@@ -13,7 +13,7 @@ export const fetchContent = async ({ builderContextValue, symbol }) => {
     if (symbol?.model &&
         // This is a hack, we should not need to check for this, but it is needed for Svelte.
         builderContextValue?.apiKey) {
-        return getContent({
+        return fetchOneEntry({
             model: symbol.model,
             apiKey: builderContextValue.apiKey,
             apiVersion: builderContextValue.apiVersion,

package/package/blocks/symbol/symbol.svelte

@@ -4,7 +4,7 @@
 import ContentVariants from "../../components/content-variants/content-variants.svelte";
 import { filterAttrs } from "../helpers.js";
 import { setAttrs } from "../helpers.js";
-import { fetchContent } from "./symbol.helpers.js";
+import { fetchSymbolContent } from "./symbol.helpers.js";
 export let js;
 export let attributes;
 export let symbol;
@@ -14,7 +14,7 @@ export let builderComponents;
 function setContent() {
     if (contentToUse)
         return;
-    fetchContent({
+    fetchSymbolContent({
         symbol: symbol,
         builderContextValue: $builderContext,
     }).then((newContent) => {

package/package/components/block/block.helpers.js

@@ -1,4 +1,4 @@
-import { evaluate } from '../../functions/evaluate';
+import { evaluate } from '../../functions/evaluate/index.js';
 import { getProcessedBlock } from '../../functions/get-processed-block.js';
 /**
  * https://developer.mozilla.org/en-US/docs/Glossary/Empty_element

package/package/components/block/components/repeated-block.svelte

@@ -2,7 +2,7 @@
 
 <script>import { setContext } from "svelte";
 import { writable } from "svelte/store";
-import BuilderContext from "../../../context/builder.context";
+import BuilderContext from "../../../context/builder.context.js";
 import Block from "../block.svelte";
 export let repeatContext;
 export let block;

package/package/components/blocks/blocks.svelte

@@ -4,8 +4,8 @@
 import BlockStyles from "../block/components/block-styles.svelte";
 import Block from "../block/block.svelte";
 import BlocksWrapper from "./blocks-wrapper.svelte";
-import BuilderContext from "../../context/builder.context";
-import ComponentsContext from "../../context/components.context";
+import BuilderContext from "../../context/builder.context.js";
+import ComponentsContext from "../../context/components.context.js";
 export let blocks;
 export let parent;
 export let path;

package/package/components/content/components/enable-editor.svelte

@@ -1,18 +1,18 @@
 <script context="module"></script>
 
 <script>import { onDestroy, onMount, setContext } from "svelte";
-import { evaluate } from "../../../functions/evaluate";
+import { evaluate } from "../../../functions/evaluate/index.js";
 import { fetch } from "../../../functions/get-fetch.js";
 import { isBrowser } from "../../../functions/is-browser.js";
 import { isEditing } from "../../../functions/is-editing.js";
 import { createRegisterComponentMessage } from "../../../functions/register-component.js";
 import { _track } from "../../../functions/track/index.js";
-import builderContext from "../../../context/builder.context";
+import builderContext from "../../../context/builder.context.js";
 import { registerInsertMenu, setupBrowserForEditing, } from "../../../scripts/init-editing.js";
 import { checkIsDefined } from "../../../helpers/nullable.js";
 import { getInteractionPropertiesForEvent } from "../../../functions/track/interaction.js";
 import { logger } from "../../../helpers/logger.js";
-import { getContent } from "../../../functions/get-content/index.js";
+import { fetchOneEntry } from "../../../functions/get-content/index.js";
 import { isPreviewing } from "../../../functions/is-previewing.js";
 import "../../../helpers/preview-lru-cache/set.js";
 export let canTrack;
@@ -226,7 +226,7 @@ onMount(() => {
             if (searchParamPreviewModel === model &&
                 previewApiKey === apiKey &&
                 (!content || searchParamPreviewId === content.id)) {
-                getContent({
+                fetchOneEntry({
                     model: model,
                     apiKey: apiKey,
                     apiVersion: $builderContextSignal.apiVersion,

package/package/components/content/content.svelte

@@ -10,7 +10,7 @@ import { getRenderContentScriptString } from "../content-variants/helpers.js";
 import EnableEditor from "./components/enable-editor.svelte";
 import InlinedScript from "../inlined-script.svelte";
 import "./wrap-component-ref.js";
-import ComponentsContext from "../../context/components.context";
+import ComponentsContext from "../../context/components.context.js";
 export let content;
 export let customComponents;
 export let data;

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

@@ -1 +1 @@
-export declare const SDK_VERSION = "UNKNOWN_VERSION";
+export declare const SDK_VERSION = "0.5.7";

package/package/constants/sdk-version.js

@@ -1 +1 @@
-export const SDK_VERSION = 'UNKNOWN_VERSION';
+export const SDK_VERSION = "0.5.7";

package/package/constants/target.d.ts

@@ -1,2 +1,2 @@
 /** This file should be overriden for each framework. Ideally this would be implemented in Mitosis.  */
-export declare const TARGET: import("../types/targets").Target;
+export declare const TARGET: import("../types/targets.js").Target;

package/package/functions/fetch-builder-props.d.ts

@@ -0,0 +1,39 @@
+import type { ContentVariantsProps } from '../components/content-variants/content-variants.types.js';
+import type { Dictionary } from '../types/typescript.js';
+import type { GetContentOptions } from './get-content/types.js';
+type GetBuilderPropsOptions = (Omit<GetContentOptions, 'model'> & {
+    model?: string;
+}) & ({
+    /**
+     * The current URL path. Used to determine the `urlPath` for targeting content.
+     *
+     * Cannot be used with `url`.
+     */
+    path: string;
+    /**
+     * The current URL search params. Used to parse the `searchParams` for targeting content.
+     *
+     * Cannot be used with `url`.
+     */
+    searchParams?: URLSearchParams | Dictionary<string | string[]>;
+    url?: undefined;
+} | {
+    /**
+     * The current URL. Used to determine the `urlPath` for targeting content and
+     * to parse the `searchParams` for targeting content.
+     *
+     * Cannot be used with `path` or `searchParams`.
+     */
+    url: URL;
+    path?: undefined;
+    searchParams?: undefined;
+} | {
+    url?: undefined;
+    path?: undefined;
+    searchParams?: undefined;
+});
+/**
+ * Fetches builder content, and returns it along with sensible defaults for other props that `Content` needs to render.
+ */
+export declare const fetchBuilderProps: (_args: GetBuilderPropsOptions) => Promise<ContentVariantsProps>;
+export {};

package/package/functions/fetch-builder-props.js

@@ -0,0 +1,25 @@
+import { getBuilderSearchParams } from './get-builder-search-params/index.js';
+import { fetchOneEntry } from './get-content/index.js';
+/**
+ * Fetches builder content, and returns it along with sensible defaults for other props that `Content` needs to render.
+ */
+export const fetchBuilderProps = async (_args) => {
+    const urlPath = _args.path || _args.url?.pathname || _args.userAttributes?.urlPath;
+    const getContentArgs = {
+        ..._args,
+        apiKey: _args.apiKey,
+        model: _args.model || 'page',
+        userAttributes: {
+            ..._args.userAttributes,
+            ...(urlPath ? {
+                urlPath
+            } : {})
+        },
+        options: getBuilderSearchParams(_args.searchParams || _args.url?.searchParams || _args.options)
+    };
+    return {
+        apiKey: getContentArgs.apiKey,
+        model: getContentArgs.model,
+        content: await fetchOneEntry(getContentArgs)
+    };
+};

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

@@ -1,12 +1,29 @@
 import type { BuilderContent } from '../../types/builder-content.js';
 import type { GetContentOptions } from './types.js';
-export declare function getContent(options: GetContentOptions): Promise<BuilderContent | null>;
+/**
+ * Returns a the first entry that matches the given options.
+ */
+export declare function fetchOneEntry(options: GetContentOptions): Promise<BuilderContent | null>;
+/**
+ * @deprecated
+ * Consider using `fetchBuilderProps` instead for easier setup.
+ *
+ * NOTE: `getContent` was renamed to `fetchOneEntry` and will be removed in a future release.
+ */
+export declare const getContent: typeof fetchOneEntry;
 type ContentResults = {
     results: BuilderContent[];
 };
 /**
  * Exported only for testing purposes. Should not be used directly.
  */
-export declare const processContentResult: (options: GetContentOptions, content: ContentResults, url?: URL) => Promise<ContentResults>;
-export declare function getAllContent(options: GetContentOptions): Promise<ContentResults | null>;
+export declare const _processContentResult: (options: GetContentOptions, content: ContentResults, url?: URL) => Promise<ContentResults>;
+/**
+ * Returns a paginated array of entries that match the given options.
+ */
+export declare function fetchEntries(options: GetContentOptions): Promise<ContentResults | null>;
+/**
+ * @deprecated Use `fetchEntries` instead.
+ */
+export declare const getAllContent: typeof fetchEntries;
 export {};

package/package/functions/get-content/index.js

@@ -7,8 +7,11 @@ import { fetch } from '../get-fetch.js';
 import { isBrowser } from '../is-browser.js';
 import { generateContentUrl } from './generate-content-url.js';
 const checkContentHasResults = (content) => 'results' in content;
-export async function getContent(options) {
-    const allContent = await getAllContent({
+/**
+ * Returns a the first entry that matches the given options.
+ */
+export async function fetchOneEntry(options) {
+    const allContent = await fetchEntries({
         ...options,
         limit: 1
     });
@@ -17,7 +20,14 @@ export async function getContent(options) {
     }
     return null;
 }
-const fetchContent = async (options) => {
+/**
+ * @deprecated
+ * Consider using `fetchBuilderProps` instead for easier setup.
+ *
+ * NOTE: `getContent` was renamed to `fetchOneEntry` and will be removed in a future release.
+ */
+export const getContent = fetchOneEntry;
+const _fetchContent = async (options) => {
     const url = generateContentUrl(options);
     const res = await fetch(url.href);
     const content = await res.json();
@@ -26,7 +36,7 @@ const fetchContent = async (options) => {
 /**
  * Exported only for testing purposes. Should not be used directly.
  */
-export const processContentResult = async (options, content, url = generateContentUrl(options)) => {
+export const _processContentResult = async (options, content, url = generateContentUrl(options)) => {
     const canTrack = getDefaultCanTrack(options.canTrack);
     const isPreviewing = url.search.includes(`preview=`);
     if (TARGET === 'rsc' && isPreviewing) {
@@ -62,10 +72,13 @@ export const processContentResult = async (options, content, url = generateConte
     }
     return content;
 };
-export async function getAllContent(options) {
+/**
+ * Returns a paginated array of entries that match the given options.
+ */
+export async function fetchEntries(options) {
     try {
         const url = generateContentUrl(options);
-        const content = await fetchContent(options);
+        const content = await _fetchContent(options);
         if (!checkContentHasResults(content)) {
             logger.error('Error fetching data. ', {
                 url,
@@ -74,10 +87,14 @@ export async function getAllContent(options) {
             });
             return null;
         }
-        return processContentResult(options, content);
+        return _processContentResult(options, content);
     }
     catch (error) {
         logger.error('Error fetching data. ', error);
         return null;
     }
 }
+/**
+ * @deprecated Use `fetchEntries` instead.
+ */
+export const getAllContent = fetchEntries;

package/package/functions/get-processed-block.js

@@ -1,4 +1,4 @@
-import { evaluate } from './evaluate';
+import { evaluate } from './evaluate/index.js';
 import { fastClone } from './fast-clone.js';
 import { set } from './set.js';
 import { transformBlock } from './transform-block.js';

package/package/functions/is-non-node-server.js

@@ -1,4 +1,4 @@
-import { isBrowser } from './is-browser';
+import { isBrowser } from './is-browser.js';
 /**
  * Identifies non-node server runtimes (edge, workers, serverless, etc.)
  */

package/package/helpers/preview-lru-cache/get.d.ts

@@ -1,2 +1,2 @@
-import type { BuilderContent } from '../../types/builder-content';
+import type { BuilderContent } from '../../types/builder-content.js';
 export declare function getPreviewContent(_searchParams: URLSearchParams): BuilderContent | undefined;

package/package/helpers/preview-lru-cache/set.d.ts

@@ -1,4 +1,4 @@
-import type { BuilderContent } from '../../types/builder-content';
+import type { BuilderContent } from '../../types/builder-content.js';
 export declare function postPreviewContent({ key, value }: {
     key: string;
     value: BuilderContent;

package/package/index-helpers/blocks-exports.d.ts

@@ -2,9 +2,18 @@ export { default as Button } from '../blocks/button/button.svelte';
 export { default as Columns } from '../blocks/columns/columns.svelte';
 export { default as Fragment } from '../blocks/fragment/fragment.svelte';
 export { default as Image } from '../blocks/image/image.svelte';
-export { default as RenderBlocks } from '../components/blocks/blocks.svelte';
 export { default as Section } from '../blocks/section/section.svelte';
 export { default as Symbol } from '../blocks/symbol/symbol.svelte';
 export { default as Text } from '../blocks/text/text.svelte';
 export { default as Video } from '../blocks/video/video.svelte';
-export { default as RenderContent } from '../components/content-variants/content-variants.svelte';
+import { default as Blocks } from '../components/blocks/blocks.svelte';
+import { default as Content } from '../components/content-variants/content-variants.svelte';
+export { Blocks, Content };
+/**
+ * @deprecated Use `Blocks` instead.
+ */
+export declare const RenderBlocks: typeof Blocks;
+/**
+ * @deprecated Use `Content` instead.
+ */
+export declare const RenderContent: typeof Content;

package/package/index-helpers/blocks-exports.js

@@ -2,9 +2,18 @@ export { default as Button } from '../blocks/button/button.svelte';
 export { default as Columns } from '../blocks/columns/columns.svelte';
 export { default as Fragment } from '../blocks/fragment/fragment.svelte';
 export { default as Image } from '../blocks/image/image.svelte';
-export { default as RenderBlocks } from '../components/blocks/blocks.svelte';
 export { default as Section } from '../blocks/section/section.svelte';
 export { default as Symbol } from '../blocks/symbol/symbol.svelte';
 export { default as Text } from '../blocks/text/text.svelte';
 export { default as Video } from '../blocks/video/video.svelte';
-export { default as RenderContent } from '../components/content-variants/content-variants.svelte';
+import { default as Blocks } from '../components/blocks/blocks.svelte';
+import { default as Content } from '../components/content-variants/content-variants.svelte';
+export { Blocks, Content };
+/**
+ * @deprecated Use `Blocks` instead.
+ */
+export const RenderBlocks = Blocks;
+/**
+ * @deprecated Use `Content` instead.
+ */
+export const RenderContent = Content;

package/package/index.d.ts

@@ -7,9 +7,10 @@ export { register } from './functions/register.js';
 export type { InsertMenuConfig, InsertMenuItem } from './functions/register.js';
 export { setEditorSettings } from './functions/set-editor-settings.js';
 export type { Settings } from './functions/set-editor-settings.js';
-export { getAllContent, getContent, processContentResult } from './functions/get-content/index.js';
+export { fetchEntries, fetchOneEntry, getAllContent, getContent, _processContentResult } 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 { RegisteredComponent } from './context/types';
-export type { ComponentInfo } from './types/components';
+export type { RegisteredComponent } from './context/types.js';
+export type { ComponentInfo } from './types/components.js';
 export type { ContentProps } from './components/content/content.types.js';
+export { fetchBuilderProps } from './functions/fetch-builder-props.js';

package/package/index.js

@@ -5,6 +5,7 @@ export { isPreviewing } from './functions/is-previewing.js';
 export { createRegisterComponentMessage } from './functions/register-component.js';
 export { register } from './functions/register.js';
 export { setEditorSettings } from './functions/set-editor-settings.js';
-export { getAllContent, getContent, processContentResult } from './functions/get-content/index.js';
+export { fetchEntries, fetchOneEntry, getAllContent, getContent, _processContentResult } from './functions/get-content/index.js';
 export { getBuilderSearchParams } from './functions/get-builder-search-params/index.js';
 export { track } from './functions/track/index.js';
+export { fetchBuilderProps } from './functions/fetch-builder-props.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@builder.io/sdk-svelte",
   "description": "Builder.io SDK for Svelte",
-  "version": "0.5.5",
+  "version": "0.5.7",
   "type": "module",
   "files": [
     "package",
@@ -52,6 +52,10 @@
     ],
     "targets": {
       "build": {
+        "dependsOn": [
+          "^build:svelte",
+          "^build"
+        ],
         "outputs": [
           "{projectRoot}/package"
         ]

package/src/blocks/BaseText.svelte

@@ -7,7 +7,7 @@
 <script lang="ts">
   import { getContext } from "svelte";
 
-  import BuilderContext from "../context/builder.context";
+  import BuilderContext from "../context/builder.context.js";
 
   export let text: BaseTextProps["text"];
 

package/src/blocks/symbol/symbol.helpers.ts

@@ -1,6 +1,6 @@
 import type { BuilderContextInterface } from '../../context/types.js';
-import { getContent } from '../../functions/get-content/index.js';
 import { logger } from '../../helpers/logger.js';
+import { fetchOneEntry } from '../../index.js';
 import type { BuilderContent } from '../../types/builder-content.js';
 export interface SymbolInfo {
   model?: string;
@@ -10,7 +10,7 @@ export interface SymbolInfo {
   inline?: boolean;
   dynamic?: boolean;
 }
-export const fetchContent = async ({
+export const fetchSymbolContent = async ({
   builderContextValue,
   symbol
 }: {
@@ -29,7 +29,7 @@ export const fetchContent = async ({
   if (symbol?.model &&
   // This is a hack, we should not need to check for this, but it is needed for Svelte.
   builderContextValue?.apiKey) {
-    return getContent({
+    return fetchOneEntry({
       model: symbol.model,
       apiKey: builderContextValue.apiKey,
       apiVersion: builderContextValue.apiVersion,

package/src/blocks/symbol/symbol.svelte

@@ -34,7 +34,7 @@
   } from "../../types/builder-props.js";
   import { filterAttrs } from "../helpers.js";
   import { setAttrs } from "../helpers.js";
-  import { fetchContent } from "./symbol.helpers.js";
+  import { fetchSymbolContent } from "./symbol.helpers.js";
   import type { Nullable } from "../../types/typescript.js";
 
   export let js: PropsWithBuilderData<SymbolProps>["js"];
@@ -46,7 +46,7 @@
 
   function setContent() {
     if (contentToUse) return;
-    fetchContent({
+    fetchSymbolContent({
       symbol: symbol,
       builderContextValue: $builderContext,
     }).then((newContent) => {

package/src/components/block/block.helpers.ts

@@ -1,5 +1,5 @@
 import type { BuilderContextInterface, RegisteredComponents } from '../../context/types.js';
-import { evaluate } from '../../functions/evaluate';
+import { evaluate } from '../../functions/evaluate/index.js';
 import { getProcessedBlock } from '../../functions/get-processed-block.js';
 import type { BuilderBlock } from '../../types/builder-block.js';
 import type { RepeatData } from './types.js';

package/src/components/block/components/repeated-block.svelte

@@ -10,7 +10,7 @@
   import { setContext } from "svelte";
   import { writable } from "svelte/store";
 
-  import BuilderContext from "../../../context/builder.context";
+  import BuilderContext from "../../../context/builder.context.js";
   import type {
     BuilderContextInterface,
     RegisteredComponents,

package/src/components/blocks/blocks.svelte

@@ -16,8 +16,8 @@
     BuilderContextInterface,
     RegisteredComponents,
   } from "../../context/types.js";
-  import BuilderContext from "../../context/builder.context";
-  import ComponentsContext from "../../context/components.context";
+  import BuilderContext from "../../context/builder.context.js";
+  import ComponentsContext from "../../context/components.context.js";
   import type { Writable } from "svelte/store";
 
   export let blocks: BlocksProps["blocks"];

package/src/components/content/components/enable-editor.svelte

@@ -13,13 +13,13 @@
   import { onDestroy, onMount, setContext } from "svelte";
 
   import type { BuilderContextInterface } from "../../../context/types.js";
-  import { evaluate } from "../../../functions/evaluate";
+  import { evaluate } from "../../../functions/evaluate/index.js";
   import { fetch } from "../../../functions/get-fetch.js";
   import { isBrowser } from "../../../functions/is-browser.js";
   import { isEditing } from "../../../functions/is-editing.js";
   import { createRegisterComponentMessage } from "../../../functions/register-component.js";
   import { _track } from "../../../functions/track/index.js";
-  import builderContext from "../../../context/builder.context";
+  import builderContext from "../../../context/builder.context.js";
   import {
     registerInsertMenu,
     setupBrowserForEditing,
@@ -32,7 +32,7 @@
   } from "../content.types.js";
   import { logger } from "../../../helpers/logger.js";
   import type { ComponentInfo } from "../../../types/components.js";
-  import { getContent } from "../../../functions/get-content/index.js";
+  import { fetchOneEntry } from "../../../functions/get-content/index.js";
   import { isPreviewing } from "../../../functions/is-previewing.js";
   import type { BuilderContent } from "../../../types/builder-content.js";
   import { postPreviewContent } from "../../../helpers/preview-lru-cache/set.js";
@@ -279,7 +279,7 @@
           previewApiKey === apiKey &&
           (!content || searchParamPreviewId === content.id)
         ) {
-          getContent({
+          fetchOneEntry({
             model: model,
             apiKey: apiKey,
             apiVersion: $builderContextSignal.apiVersion,

package/src/components/content/content.svelte

@@ -26,7 +26,7 @@
   import { wrapComponentRef } from "./wrap-component-ref.js";
   import type { ComponentInfo } from "../../types/components.js";
   import type { Dictionary } from "../../types/typescript.js";
-  import ComponentsContext from "../../context/components.context";
+  import ComponentsContext from "../../context/components.context.js";
 
   export let content: ContentProps["content"];
   export let customComponents: ContentProps["customComponents"];

package/src/constants/sdk-version.ts

@@ -1 +1 @@
-export const SDK_VERSION = 'UNKNOWN_VERSION'
+export const SDK_VERSION = "0.5.7"

package/src/constants/target.ts

@@ -1,4 +1,4 @@
-type Target = import('../types/targets').Target;
+type Target = import('../types/targets.js').Target;
 
 /** This file should be overriden for each framework. Ideally this would be implemented in Mitosis.  */
 export const TARGET = 'svelte' as Target;

package/src/functions/fetch-builder-props.ts

@@ -0,0 +1,61 @@
+import { getBuilderSearchParams } from './get-builder-search-params/index.js';
+import type { ContentVariantsProps } from '../components/content-variants/content-variants.types.js';
+import type { Dictionary } from '../types/typescript.js';
+import { fetchOneEntry } from './get-content/index.js';
+import type { GetContentOptions } from './get-content/types.js';
+type GetBuilderPropsOptions = (Omit<GetContentOptions, 'model'> & {
+  model?: string;
+}) & ({
+  /**
+   * The current URL path. Used to determine the `urlPath` for targeting content.
+   *
+   * Cannot be used with `url`.
+   */
+  path: string;
+
+  /**
+   * The current URL search params. Used to parse the `searchParams` for targeting content.
+   *
+   * Cannot be used with `url`.
+   */
+  searchParams?: URLSearchParams | Dictionary<string | string[]>;
+  url?: undefined;
+} | {
+  /**
+   * The current URL. Used to determine the `urlPath` for targeting content and
+   * to parse the `searchParams` for targeting content.
+   *
+   * Cannot be used with `path` or `searchParams`.
+   */
+  url: URL;
+  path?: undefined;
+  searchParams?: undefined;
+} | {
+  url?: undefined;
+  path?: undefined;
+  searchParams?: undefined;
+});
+
+/**
+ * Fetches builder content, and returns it along with sensible defaults for other props that `Content` needs to render.
+ */
+export const fetchBuilderProps = async (_args: GetBuilderPropsOptions): Promise<ContentVariantsProps> => {
+  const urlPath = _args.path || _args.url?.pathname || _args.userAttributes?.urlPath;
+  const getContentArgs: GetContentOptions = {
+    ..._args,
+    apiKey: _args.apiKey,
+    model: _args.model || 'page',
+    userAttributes: {
+      ..._args.userAttributes,
+      ...(urlPath ? {
+        urlPath
+      } : {})
+    },
+    options: getBuilderSearchParams(_args.searchParams || _args.url?.searchParams || _args.options)
+  };
+  return {
+    apiKey: getContentArgs.apiKey,
+    model: getContentArgs.model,
+    content: await fetchOneEntry(getContentArgs)
+  };
+}

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

@@ -9,8 +9,12 @@ import { isBrowser } from '../is-browser.js';
 import { generateContentUrl } from './generate-content-url.js';
 import type { GetContentOptions } from './types.js';
 const checkContentHasResults = (content: ContentResponse): content is ContentResults => 'results' in content;
-export async function getContent(options: GetContentOptions): Promise<BuilderContent | null> {
-  const allContent = await getAllContent({
+
+/**
+ * Returns a the first entry that matches the given options.
+ */
+export async function fetchOneEntry(options: GetContentOptions): Promise<BuilderContent | null> {
+  const allContent = await fetchEntries({
     ...options,
     limit: 1
   });
@@ -19,6 +23,14 @@ export async function getContent(options: GetContentOptions): Promise<BuilderCon
   }
   return null;
 }
+
+/**
+ * @deprecated
+ * Consider using `fetchBuilderProps` instead for easier setup.
+ *
+ * NOTE: `getContent` was renamed to `fetchOneEntry` and will be removed in a future release.
+ */
+export const getContent = fetchOneEntry;
 type ContentResults = {
   results: BuilderContent[];
 };
@@ -26,7 +38,7 @@ type ContentResponse = ContentResults | {
   status: number;
   message: string;
 };
-const fetchContent = async (options: GetContentOptions) => {
+const _fetchContent = async (options: GetContentOptions) => {
   const url = generateContentUrl(options);
   const res = await fetch(url.href);
   const content = await (res.json() as Promise<ContentResponse>);
@@ -36,7 +48,7 @@ const fetchContent = async (options: GetContentOptions) => {
 /**
  * Exported only for testing purposes. Should not be used directly.
  */
-export const processContentResult = async (options: GetContentOptions, content: ContentResults, url: URL = generateContentUrl(options)) => {
+export const _processContentResult = async (options: GetContentOptions, content: ContentResults, url: URL = generateContentUrl(options)) => {
   const canTrack = getDefaultCanTrack(options.canTrack);
   const isPreviewing = url.search.includes(`preview=`);
   if (TARGET === 'rsc' && isPreviewing) {
@@ -70,10 +82,14 @@ export const processContentResult = async (options: GetContentOptions, content:
   }
   return content;
 };
-export async function getAllContent(options: GetContentOptions) {
+
+/**
+ * Returns a paginated array of entries that match the given options.
+ */
+export async function fetchEntries(options: GetContentOptions) {
   try {
     const url = generateContentUrl(options);
-    const content = await fetchContent(options);
+    const content = await _fetchContent(options);
     if (!checkContentHasResults(content)) {
       logger.error('Error fetching data. ', {
         url,
@@ -82,9 +98,14 @@ export async function getAllContent(options: GetContentOptions) {
       });
       return null;
     }
-    return processContentResult(options, content);
+    return _processContentResult(options, content);
   } catch (error) {
     logger.error('Error fetching data. ', error);
     return null;
   }
-}
+}
+
+/**
+ * @deprecated Use `fetchEntries` instead.
+ */
+export const getAllContent = fetchEntries

package/src/functions/get-processed-block.ts

@@ -1,6 +1,6 @@
 import type { BuilderContextInterface } from '../context/types.js';
 import type { BuilderBlock } from '../types/builder-block.js';
-import { evaluate } from './evaluate';
+import { evaluate } from './evaluate/index.js';
 import { fastClone } from './fast-clone.js';
 import { set } from './set.js';
 import { transformBlock } from './transform-block.js';

package/src/functions/is-non-node-server.ts

@@ -1,4 +1,4 @@
-import { isBrowser } from './is-browser';
+import { isBrowser } from './is-browser.js';
 
 /**
  * Identifies non-node server runtimes (edge, workers, serverless, etc.)

package/src/helpers/preview-lru-cache/get.ts

@@ -1,4 +1,4 @@
-import type { BuilderContent } from '../../types/builder-content';
+import type { BuilderContent } from '../../types/builder-content.js';
 export function getPreviewContent(_searchParams: URLSearchParams): BuilderContent | undefined {
   return undefined;
 }

package/src/helpers/preview-lru-cache/set.ts

@@ -1,4 +1,4 @@
-import type { BuilderContent } from '../../types/builder-content';
+import type { BuilderContent } from '../../types/builder-content.js';
 export async function postPreviewContent({
   key,
   value

package/src/index-helpers/blocks-exports.ts

@@ -2,9 +2,19 @@ export { default as Button } from '../blocks/button/button.svelte';
 export { default as Columns } from '../blocks/columns/columns.svelte';
 export { default as Fragment } from '../blocks/fragment/fragment.svelte';
 export { default as Image } from '../blocks/image/image.svelte';
-export { default as RenderBlocks } from '../components/blocks/blocks.svelte';
 export { default as Section } from '../blocks/section/section.svelte';
 export { default as Symbol } from '../blocks/symbol/symbol.svelte';
 export { default as Text } from '../blocks/text/text.svelte';
 export { default as Video } from '../blocks/video/video.svelte';
-export { default as RenderContent } from '../components/content-variants/content-variants.svelte'
+import { default as Blocks } from '../components/blocks/blocks.svelte';
+import { default as Content } from '../components/content-variants/content-variants.svelte';
+export { Blocks, Content };
+
+/**
+ * @deprecated Use `Blocks` instead.
+ */
+export const RenderBlocks = Blocks;
+/**
+ * @deprecated Use `Content` instead.
+ */
+export const RenderContent = Content

package/src/index.ts

@@ -7,9 +7,10 @@ export { register } from './functions/register.js';
 export type { InsertMenuConfig, InsertMenuItem } from './functions/register.js';
 export { setEditorSettings } from './functions/set-editor-settings.js';
 export type { Settings } from './functions/set-editor-settings.js';
-export { getAllContent, getContent, processContentResult } from './functions/get-content/index.js';
+export { fetchEntries, fetchOneEntry, getAllContent, getContent, _processContentResult } 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 { RegisteredComponent } from './context/types';
-export type { ComponentInfo } from './types/components';
-export type { ContentProps } from './components/content/content.types.js'
+export type { RegisteredComponent } from './context/types.js';
+export type { ComponentInfo } from './types/components.js';
+export type { ContentProps } from './components/content/content.types.js';
+export { fetchBuilderProps } from './functions/fetch-builder-props.js'

package/package/functions/if-target.d.ts

@@ -1,7 +0,0 @@
-type Target = import('../types/targets').Target;
-export declare function ifTarget<A, B>({ targets, doThing, elseThing }: {
-    targets: Target[];
-    doThing: () => A;
-    elseThing?: () => B;
-}): A | B | undefined;
-export {};

package/package/functions/if-target.js

@@ -1,10 +0,0 @@
-import { TARGET } from '../constants/target.js';
-// TODO: babel compile to include certain code only if the target matches
-export function ifTarget({ targets, doThing, elseThing }) {
-    if (TARGET && targets.includes(TARGET)) {
-        return doThing();
-    }
-    else {
-        return elseThing?.();
-    }
-}

package/src/functions/if-target.ts

@@ -1,19 +0,0 @@
-import { TARGET } from '../constants/target.js';
-type Target = import('../types/targets').Target;
-
-// TODO: babel compile to include certain code only if the target matches
-export function ifTarget<A, B>({
-  targets,
-  doThing,
-  elseThing
-}: {
-  targets: Target[];
-  doThing: () => A;
-  elseThing?: () => B;
-}) {
-  if (TARGET && targets.includes(TARGET)) {
-    return doThing();
-  } else {
-    return elseThing?.();
-  }
-}