@builder.io/sdk-solid 0.13.4 → 0.14.0

package/dist/index.d.ts

@@ -639,8 +639,6 @@ interface ContentVariantsPrps {
      * If provided, the API will auto-resolve localized objects to the value of this `locale` key (optional).
      */
     locale?: string;
-    /** @deprecated use `enrich` instead */
-    includeRefs?: boolean;
     /**
      * A boolean to enable or disable enriching API content (optional).
      *
@@ -678,15 +676,6 @@ type VariantsProviderProps = ContentVariantsPrps & {
 
 declare function ContentVariants(props: VariantsProviderProps): solid_js.JSX.Element;
 
-/**
- * @deprecated Renamed to `Blocks`.
- */
-declare const RenderBlocks: typeof Blocks;
-/**
- * @deprecated Renamed to `Content`.
- */
-declare const RenderContent: typeof ContentVariants;
-
 declare function isEditing(): boolean;
 
 declare function isPreviewing(): boolean;
@@ -849,12 +838,6 @@ interface GetContentOptions {
      * Accepts both a key/value object or a `URLSearchParams` instance
      * */
     options?: Record<string, any> | URLSearchParams;
-    /**
-     * If set to `true`, it will lazy load symbols/references.
-     * If set to `false`, it will render the entire content tree eagerly.
-     * @deprecated use `enrich` instead
-     */
-    noTraverse?: boolean;
     /**
      * If set to `false`, it will not use cookies to target content. Therefore, A/B Testing will be disabled and
      * only the default variation will be returned to every user.
@@ -862,11 +845,6 @@ interface GetContentOptions {
      * Defaults to `true`.
      */
     canTrack?: boolean;
-    /**
-     * Include content of references in the response. Defaults to `true`.
-     * @deprecated use `enrich` instead
-     */
-    includeRefs?: boolean;
     /**
      * Include multilevel references in the response.
      */
@@ -997,12 +975,6 @@ declare const fetchBuilderProps: (_args: GetBuilderPropsOptions) => Promise<Cont
  * Returns the first content entry that matches the given options.
  */
 declare function fetchOneEntry(options: GetContentOptions): Promise<BuilderContent | null>;
-/**
- * @deprecated `getContent` was renamed to `fetchOneEntry`. This is a temporary alias to avoid breaking changes.
- *
- * NOTE: consider using `fetchBuilderProps` instead for easier setup.
- */
-declare const getContent: typeof fetchOneEntry;
 type ContentResults = {
     results: BuilderContent[];
 };
@@ -1014,9 +986,5 @@ declare const _processContentResult: (options: GetContentOptions, content: Conte
  * Returns a paginated array of entries that match the given options.
  */
 declare function fetchEntries(options: GetContentOptions): Promise<BuilderContent[]>;
-/**
- * @deprecated `getAllContent` was renamed to `fetchEntries`. This is a temporary alias to avoid breaking changes.
- */
-declare const getAllContent: typeof fetchEntries;
 
-export { Blocks, BlocksProps, BuilderBlock, BuilderContent, Button, ButtonProps, ColumnProps, Columns, ComponentInfo, ContentVariants as Content, ContentVariantsPrps as ContentProps, FragmentComponent as Fragment, FragmentProps, Image, ImageProps, InsertMenuConfig, InsertMenuItem, RegisteredComponent, RenderBlocks, RenderContent, SectionComponent as Section, SectionProps, Settings, Symbol, SymbolProps, Text, TextProps, Video, VideoProps, _processContentResult, createRegisterComponentMessage, fetchBuilderProps, fetchEntries, fetchOneEntry, getAllContent, getBuilderSearchParams, getContent, isEditing, isPreviewing, register, setEditorSettings, subscribeToEditor, track };
+export { Blocks, BlocksProps, BuilderBlock, BuilderContent, Button, ButtonProps, ColumnProps, Columns, ComponentInfo, ContentVariants as Content, ContentVariantsPrps as ContentProps, FragmentComponent as Fragment, FragmentProps, Image, ImageProps, InsertMenuConfig, InsertMenuItem, RegisteredComponent, SectionComponent as Section, SectionProps, Settings, Symbol, SymbolProps, Text, TextProps, Video, VideoProps, _processContentResult, createRegisterComponentMessage, fetchBuilderProps, fetchEntries, fetchOneEntry, getBuilderSearchParams, isEditing, isPreviewing, register, setEditorSettings, subscribeToEditor, track };

package/lib/browser/dev.js

@@ -3818,7 +3818,6 @@ var getDefaultRegisteredComponents = () => [{
 }, ...getExtraComponents()];
 
 // src/functions/register-component.ts
-var components = [];
 var createRegisterComponentMessage = (info) => ({
   type: "builder.registerComponent",
   data: serializeComponentInfo(info)
@@ -3992,16 +3991,12 @@ var normalizeSearchParams = (searchParams) => searchParams instanceof URLSearchP
 // src/functions/get-content/generate-content-url.ts
 var isPositiveNumber = (thing) => typeof thing === "number" && !isNaN(thing) && thing >= 0;
 var generateContentUrl = (options) => {
-  let {
-    noTraverse = false
-  } = options;
   const {
     limit = 30,
     userAttributes,
     query,
     model,
     apiKey,
-    includeRefs = true,
     enrich,
     locale,
     apiVersion = DEFAULT_API_VERSION,
@@ -4019,10 +4014,16 @@ var generateContentUrl = (options) => {
   if (!["v3"].includes(apiVersion)) {
     throw new Error(`Invalid apiVersion: expected 'v3', received '${apiVersion}'`);
   }
-  if ((options.limit === void 0 || options.limit > 1) && !("noTraverse" in options)) {
-    noTraverse = true;
-  }
-  const url = new URL(`https://cdn.builder.io/api/${apiVersion}/content/${model}?apiKey=${apiKey}&limit=${limit}&noTraverse=${noTraverse}&includeRefs=${includeRefs}${locale ? `&locale=${locale}` : ""}${enrich ? `&enrich=${enrich}` : ""}`);
+  const noTraverse = limit !== 1;
+  const url = new URL(`https://cdn.builder.io/api/${apiVersion}/content/${model}`);
+  url.searchParams.set("apiKey", apiKey);
+  url.searchParams.set("limit", String(limit));
+  url.searchParams.set("noTraverse", String(noTraverse));
+  url.searchParams.set("includeRefs", String(true));
+  if (locale)
+    url.searchParams.set("locale", locale);
+  if (enrich)
+    url.searchParams.set("enrich", String(enrich));
   url.searchParams.set("omit", omit || "meta.componentsUsed");
   if (fields) {
     url.searchParams.set("fields", fields);
@@ -4081,7 +4082,6 @@ async function fetchOneEntry(options) {
   }
   return null;
 }
-var getContent = fetchOneEntry;
 var _fetchContent = async (options) => {
   const url = generateContentUrl(options);
   const res = await fetch2(url.href);
@@ -4135,7 +4135,6 @@ async function fetchEntries(options) {
     return null;
   }
 }
-var getAllContent = fetchEntries;
 
 // src/functions/is-previewing.ts
 function isPreviewing() {
@@ -4395,7 +4394,7 @@ function isFromTrustedHost(trustedHosts, e) {
 }
 
 // src/constants/sdk-version.ts
-var SDK_VERSION = "0.13.4";
+var SDK_VERSION = "0.14.0";
 
 // src/functions/register.ts
 var registry = {};
@@ -4755,9 +4754,6 @@ function EnableEditor(props) {
           ...props.locale ? {
             locale: props.locale
           } : {},
-          ...props.includeRefs ? {
-            includeRefs: props.includeRefs
-          } : {},
           ...props.enrich ? {
             enrich: props.enrich
           } : {},
@@ -5028,16 +5024,7 @@ function ContentComponent(props) {
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion, @typescript-eslint/no-non-null-asserted-optional-chain
     contentId: props.content?.id
   }));
-  const [registeredComponents, setRegisteredComponents] = createSignal([
-    ...getDefaultRegisteredComponents(),
-    // While this `components` object is deprecated, we must maintain support for it.
-    // Since users are able to override our default components, we need to make sure that we do not break such
-    // existing usage.
-    // This is why we spread `components` after the default Builder.io components, but before the `props.customComponents`,
-    // which is the new standard way of providing custom components, and must therefore take precedence.
-    ...components,
-    ...props.customComponents || []
-  ].reduce((acc, {
+  const [registeredComponents, setRegisteredComponents] = createSignal([...getDefaultRegisteredComponents(), ...props.customComponents || []].reduce((acc, {
     component,
     ...info
   }) => ({
@@ -5062,16 +5049,7 @@ function ContentComponent(props) {
     context: props.context || {},
     apiKey: props.apiKey,
     apiVersion: props.apiVersion,
-    componentInfos: [
-      ...getDefaultRegisteredComponents(),
-      // While this `components` object is deprecated, we must maintain support for it.
-      // Since users are able to override our default components, we need to make sure that we do not break such
-      // existing usage.
-      // This is why we spread `components` after the default Builder.io components, but before the `props.customComponents`,
-      // which is the new standard way of providing custom components, and must therefore take precedence.
-      ...components,
-      ...props.customComponents || []
-    ].reduce((acc, {
+    componentInfos: [...getDefaultRegisteredComponents(), ...props.customComponents || []].reduce((acc, {
       component: _,
       ...info
     }) => ({
@@ -5117,9 +5095,6 @@ function ContentComponent(props) {
         get locale() {
           return props.locale;
         },
-        get includeRefs() {
-          return props.includeRefs;
-        },
         get enrich() {
           return props.enrich;
         },
@@ -5285,9 +5260,6 @@ function ContentVariants(props) {
             get locale() {
               return props.locale;
             },
-            get includeRefs() {
-              return props.includeRefs;
-            },
             get enrich() {
               return props.enrich;
             },
@@ -5345,9 +5317,6 @@ function ContentVariants(props) {
     get locale() {
       return props.locale;
     },
-    get includeRefs() {
-      return props.includeRefs;
-    },
     get enrich() {
       return props.enrich;
     },
@@ -5469,10 +5438,6 @@ function Symbol(props) {
 }
 var symbol_default = Symbol;
 
-// src/index-helpers/blocks-exports.ts
-var RenderBlocks = blocks_default;
-var RenderContent = content_variants_default;
-
 // src/functions/set-editor-settings.ts
 var settings = {};
 function setEditorSettings(newSettings) {
@@ -5508,4 +5473,4 @@ var fetchBuilderProps = async (_args) => {
   };
 };
 
-export { blocks_default as Blocks, button_default as Button, columns_default as Columns, content_variants_default as Content, fragment_default as Fragment, image_default as Image, RenderBlocks, RenderContent, section_default as Section, symbol_default as Symbol, text_default as Text, video_default as Video, _processContentResult, createRegisterComponentMessage, fetchBuilderProps, fetchEntries, fetchOneEntry, getAllContent, getBuilderSearchParams, getContent, isEditing, isPreviewing, register, setEditorSettings, subscribeToEditor, track };
+export { blocks_default as Blocks, button_default as Button, columns_default as Columns, content_variants_default as Content, fragment_default as Fragment, image_default as Image, section_default as Section, symbol_default as Symbol, text_default as Text, video_default as Video, _processContentResult, createRegisterComponentMessage, fetchBuilderProps, fetchEntries, fetchOneEntry, getBuilderSearchParams, isEditing, isPreviewing, register, setEditorSettings, subscribeToEditor, track };

package/lib/browser/dev.jsx

@@ -3398,7 +3398,6 @@ var getDefaultRegisteredComponents = () => [{
 }, ...getExtraComponents()];
 
 // src/functions/register-component.ts
-var components = [];
 var createRegisterComponentMessage = (info) => ({
   type: "builder.registerComponent",
   data: serializeComponentInfo(info)
@@ -3565,16 +3564,12 @@ var normalizeSearchParams = (searchParams) => searchParams instanceof URLSearchP
 // src/functions/get-content/generate-content-url.ts
 var isPositiveNumber = (thing) => typeof thing === "number" && !isNaN(thing) && thing >= 0;
 var generateContentUrl = (options) => {
-  let {
-    noTraverse = false
-  } = options;
   const {
     limit = 30,
     userAttributes,
     query,
     model,
     apiKey,
-    includeRefs = true,
     enrich,
     locale,
     apiVersion = DEFAULT_API_VERSION,
@@ -3592,10 +3587,16 @@ var generateContentUrl = (options) => {
   if (!["v3"].includes(apiVersion)) {
     throw new Error(`Invalid apiVersion: expected 'v3', received '${apiVersion}'`);
   }
-  if ((options.limit === void 0 || options.limit > 1) && !("noTraverse" in options)) {
-    noTraverse = true;
-  }
-  const url = new URL(`https://cdn.builder.io/api/${apiVersion}/content/${model}?apiKey=${apiKey}&limit=${limit}&noTraverse=${noTraverse}&includeRefs=${includeRefs}${locale ? `&locale=${locale}` : ""}${enrich ? `&enrich=${enrich}` : ""}`);
+  const noTraverse = limit !== 1;
+  const url = new URL(`https://cdn.builder.io/api/${apiVersion}/content/${model}`);
+  url.searchParams.set("apiKey", apiKey);
+  url.searchParams.set("limit", String(limit));
+  url.searchParams.set("noTraverse", String(noTraverse));
+  url.searchParams.set("includeRefs", String(true));
+  if (locale)
+    url.searchParams.set("locale", locale);
+  if (enrich)
+    url.searchParams.set("enrich", String(enrich));
   url.searchParams.set("omit", omit || "meta.componentsUsed");
   if (fields) {
     url.searchParams.set("fields", fields);
@@ -3654,7 +3655,6 @@ async function fetchOneEntry(options) {
   }
   return null;
 }
-var getContent = fetchOneEntry;
 var _fetchContent = async (options) => {
   const url = generateContentUrl(options);
   const res = await fetch2(url.href);
@@ -3708,7 +3708,6 @@ async function fetchEntries(options) {
     return null;
   }
 }
-var getAllContent = fetchEntries;
 
 // src/functions/is-previewing.ts
 function isPreviewing() {
@@ -3968,7 +3967,7 @@ function isFromTrustedHost(trustedHosts, e) {
 }
 
 // src/constants/sdk-version.ts
-var SDK_VERSION = "0.13.4";
+var SDK_VERSION = "0.14.0";
 
 // src/functions/register.ts
 var registry = {};
@@ -4332,9 +4331,6 @@ function EnableEditor(props) {
           ...props.locale ? {
             locale: props.locale
           } : {},
-          ...props.includeRefs ? {
-            includeRefs: props.includeRefs
-          } : {},
           ...props.enrich ? {
             enrich: props.enrich
           } : {},
@@ -4599,12 +4595,6 @@ function ContentComponent(props) {
   const [registeredComponents, setRegisteredComponents] = createSignal13(
     [
       ...getDefaultRegisteredComponents(),
-      // While this `components` object is deprecated, we must maintain support for it.
-      // Since users are able to override our default components, we need to make sure that we do not break such
-      // existing usage.
-      // This is why we spread `components` after the default Builder.io components, but before the `props.customComponents`,
-      // which is the new standard way of providing custom components, and must therefore take precedence.
-      ...components,
       ...props.customComponents || []
     ].reduce(
       (acc, { component, ...info }) => ({
@@ -4634,12 +4624,6 @@ function ContentComponent(props) {
     apiVersion: props.apiVersion,
     componentInfos: [
       ...getDefaultRegisteredComponents(),
-      // While this `components` object is deprecated, we must maintain support for it.
-      // Since users are able to override our default components, we need to make sure that we do not break such
-      // existing usage.
-      // This is why we spread `components` after the default Builder.io components, but before the `props.customComponents`,
-      // which is the new standard way of providing custom components, and must therefore take precedence.
-      ...components,
       ...props.customComponents || []
     ].reduce(
       (acc, { component: _, ...info }) => ({
@@ -4670,7 +4654,6 @@ function ContentComponent(props) {
     apiKey={props.apiKey}
     canTrack={props.canTrack}
     locale={props.locale}
-    includeRefs={props.includeRefs}
     enrich={props.enrich}
     showContent={props.showContent}
     builderContextSignal={builderContextSignal()}
@@ -4755,7 +4738,6 @@ function ContentVariants(props) {
           linkComponent={props.linkComponent}
           canTrack={props.canTrack}
           locale={props.locale}
-          includeRefs={props.includeRefs}
           enrich={props.enrich}
           isSsrAbTest={shouldRenderVariants()}
           blocksWrapper={props.blocksWrapper}
@@ -4779,7 +4761,6 @@ function ContentVariants(props) {
       linkComponent={props.linkComponent}
       canTrack={props.canTrack}
       locale={props.locale}
-      includeRefs={props.includeRefs}
       enrich={props.enrich}
       isSsrAbTest={shouldRenderVariants()}
       blocksWrapper={props.blocksWrapper}
@@ -4867,10 +4848,6 @@ function Symbol(props) {
 }
 var symbol_default = Symbol;
 
-// src/index-helpers/blocks-exports.ts
-var RenderBlocks = Blocks_default;
-var RenderContent = Content_variants_default;
-
 // src/functions/set-editor-settings.ts
 var settings = {};
 function setEditorSettings(newSettings) {
@@ -4912,8 +4889,6 @@ export {
   Content_variants_default as Content,
   fragment_default as Fragment,
   image_default as Image,
-  RenderBlocks,
-  RenderContent,
   section_default as Section,
   symbol_default as Symbol,
   text_default as Text,
@@ -4923,9 +4898,7 @@ export {
   fetchBuilderProps,
   fetchEntries,
   fetchOneEntry,
-  getAllContent,
   getBuilderSearchParams,
-  getContent,
   isEditing,
   isPreviewing,
   register,

package/lib/browser/index.js

@@ -3808,7 +3808,6 @@ var getDefaultRegisteredComponents = () => [{
 }, ...getExtraComponents()];
 
 // src/functions/register-component.ts
-var components = [];
 var createRegisterComponentMessage = (info) => ({
   type: "builder.registerComponent",
   data: serializeComponentInfo(info)
@@ -3980,16 +3979,12 @@ var normalizeSearchParams = (searchParams) => searchParams instanceof URLSearchP
 // src/functions/get-content/generate-content-url.ts
 var isPositiveNumber = (thing) => typeof thing === "number" && !isNaN(thing) && thing >= 0;
 var generateContentUrl = (options) => {
-  let {
-    noTraverse = false
-  } = options;
   const {
     limit = 30,
     userAttributes,
     query,
     model,
     apiKey,
-    includeRefs = true,
     enrich,
     locale,
     apiVersion = DEFAULT_API_VERSION,
@@ -4007,10 +4002,16 @@ var generateContentUrl = (options) => {
   if (!["v3"].includes(apiVersion)) {
     throw new Error(`Invalid apiVersion: expected 'v3', received '${apiVersion}'`);
   }
-  if ((options.limit === void 0 || options.limit > 1) && !("noTraverse" in options)) {
-    noTraverse = true;
-  }
-  const url = new URL(`https://cdn.builder.io/api/${apiVersion}/content/${model}?apiKey=${apiKey}&limit=${limit}&noTraverse=${noTraverse}&includeRefs=${includeRefs}${locale ? `&locale=${locale}` : ""}${enrich ? `&enrich=${enrich}` : ""}`);
+  const noTraverse = limit !== 1;
+  const url = new URL(`https://cdn.builder.io/api/${apiVersion}/content/${model}`);
+  url.searchParams.set("apiKey", apiKey);
+  url.searchParams.set("limit", String(limit));
+  url.searchParams.set("noTraverse", String(noTraverse));
+  url.searchParams.set("includeRefs", String(true));
+  if (locale)
+    url.searchParams.set("locale", locale);
+  if (enrich)
+    url.searchParams.set("enrich", String(enrich));
   url.searchParams.set("omit", omit || "meta.componentsUsed");
   if (fields) {
     url.searchParams.set("fields", fields);
@@ -4069,7 +4070,6 @@ async function fetchOneEntry(options) {
   }
   return null;
 }
-var getContent = fetchOneEntry;
 var _fetchContent = async (options) => {
   const url = generateContentUrl(options);
   const res = await fetch2(url.href);
@@ -4123,7 +4123,6 @@ async function fetchEntries(options) {
     return null;
   }
 }
-var getAllContent = fetchEntries;
 
 // src/functions/is-previewing.ts
 function isPreviewing() {
@@ -4380,7 +4379,7 @@ function isFromTrustedHost(trustedHosts, e) {
 }
 
 // src/constants/sdk-version.ts
-var SDK_VERSION = "0.13.4";
+var SDK_VERSION = "0.14.0";
 
 // src/functions/register.ts
 var registry = {};
@@ -4738,9 +4737,6 @@ function EnableEditor(props) {
           ...props.locale ? {
             locale: props.locale
           } : {},
-          ...props.includeRefs ? {
-            includeRefs: props.includeRefs
-          } : {},
           ...props.enrich ? {
             enrich: props.enrich
           } : {},
@@ -5011,16 +5007,7 @@ function ContentComponent(props) {
     // eslint-disable-next-line @typescript-eslint/no-non-null-assertion, @typescript-eslint/no-non-null-asserted-optional-chain
     contentId: props.content?.id
   }));
-  const [registeredComponents, setRegisteredComponents] = createSignal([
-    ...getDefaultRegisteredComponents(),
-    // While this `components` object is deprecated, we must maintain support for it.
-    // Since users are able to override our default components, we need to make sure that we do not break such
-    // existing usage.
-    // This is why we spread `components` after the default Builder.io components, but before the `props.customComponents`,
-    // which is the new standard way of providing custom components, and must therefore take precedence.
-    ...components,
-    ...props.customComponents || []
-  ].reduce((acc, {
+  const [registeredComponents, setRegisteredComponents] = createSignal([...getDefaultRegisteredComponents(), ...props.customComponents || []].reduce((acc, {
     component,
     ...info
   }) => ({
@@ -5045,16 +5032,7 @@ function ContentComponent(props) {
     context: props.context || {},
     apiKey: props.apiKey,
     apiVersion: props.apiVersion,
-    componentInfos: [
-      ...getDefaultRegisteredComponents(),
-      // While this `components` object is deprecated, we must maintain support for it.
-      // Since users are able to override our default components, we need to make sure that we do not break such
-      // existing usage.
-      // This is why we spread `components` after the default Builder.io components, but before the `props.customComponents`,
-      // which is the new standard way of providing custom components, and must therefore take precedence.
-      ...components,
-      ...props.customComponents || []
-    ].reduce((acc, {
+    componentInfos: [...getDefaultRegisteredComponents(), ...props.customComponents || []].reduce((acc, {
       component: _,
       ...info
     }) => ({
@@ -5100,9 +5078,6 @@ function ContentComponent(props) {
         get locale() {
           return props.locale;
         },
-        get includeRefs() {
-          return props.includeRefs;
-        },
         get enrich() {
           return props.enrich;
         },
@@ -5268,9 +5243,6 @@ function ContentVariants(props) {
             get locale() {
               return props.locale;
             },
-            get includeRefs() {
-              return props.includeRefs;
-            },
             get enrich() {
               return props.enrich;
             },
@@ -5328,9 +5300,6 @@ function ContentVariants(props) {
     get locale() {
       return props.locale;
     },
-    get includeRefs() {
-      return props.includeRefs;
-    },
     get enrich() {
       return props.enrich;
     },
@@ -5452,10 +5421,6 @@ function Symbol(props) {
 }
 var symbol_default = Symbol;
 
-// src/index-helpers/blocks-exports.ts
-var RenderBlocks = blocks_default;
-var RenderContent = content_variants_default;
-
 // src/functions/set-editor-settings.ts
 var settings = {};
 function setEditorSettings(newSettings) {
@@ -5491,4 +5456,4 @@ var fetchBuilderProps = async (_args) => {
   };
 };
 
-export { blocks_default as Blocks, button_default as Button, columns_default as Columns, content_variants_default as Content, fragment_default as Fragment, image_default as Image, RenderBlocks, RenderContent, section_default as Section, symbol_default as Symbol, text_default as Text, video_default as Video, _processContentResult, createRegisterComponentMessage, fetchBuilderProps, fetchEntries, fetchOneEntry, getAllContent, getBuilderSearchParams, getContent, isEditing, isPreviewing, register, setEditorSettings, subscribeToEditor, track };
+export { blocks_default as Blocks, button_default as Button, columns_default as Columns, content_variants_default as Content, fragment_default as Fragment, image_default as Image, section_default as Section, symbol_default as Symbol, text_default as Text, video_default as Video, _processContentResult, createRegisterComponentMessage, fetchBuilderProps, fetchEntries, fetchOneEntry, getBuilderSearchParams, isEditing, isPreviewing, register, setEditorSettings, subscribeToEditor, track };