@builder.io/sdk-react-nextjs 0.4.5

package/dist/functions/extract-text-styles.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Extract styles that apply to text from a style object.
+ */
+export declare const extractTextStyles: (styles: Partial<CSSStyleDeclaration>) => Partial<CSSStyleDeclaration>;

package/dist/functions/extract-text-styles.js

@@ -0,0 +1,21 @@
+const TEXT_STYLE_KEYS = ['color', 'whiteSpace', 'direction', 'hyphens', 'overflowWrap'];
+/**
+ * Check if the key represent a CSS style property that applies to text
+ * See MDN docs for refrence of what properties apply to text.
+ * https://developer.mozilla.org/en-US/docs/Learn/CSS/Styling_text/Fundamentals#summary
+ */
+const isTextStyle = (key) => {
+    return TEXT_STYLE_KEYS.includes(key) || key.startsWith('font') || key.startsWith('text') || key.startsWith('letter') || key.startsWith('line') || key.startsWith('word') || key.startsWith('writing');
+};
+/**
+ * Extract styles that apply to text from a style object.
+ */
+export const extractTextStyles = (styles) => {
+    const textStyles = {}; // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    Object.entries(styles).forEach(([key, value]) => {
+        if (isTextStyle(key)) {
+            textStyles[key] = value;
+        }
+    });
+    return textStyles;
+};

package/dist/functions/fast-clone.d.ts

@@ -0,0 +1,4 @@
+/**
+ * We need to serialize values to a string in case there are Proxy values, as is the case with SolidJS etc.
+ */
+export declare const fastClone: <T extends object>(obj: T) => T;

package/dist/functions/fast-clone.js

@@ -0,0 +1,4 @@
+/**
+ * We need to serialize values to a string in case there are Proxy values, as is the case with SolidJS etc.
+ */
+export const fastClone = (obj) => JSON.parse(JSON.stringify(obj));

package/dist/functions/get-block-actions-handler.d.ts

@@ -0,0 +1,8 @@
+import type { BuilderContextInterface } from '../context/types.js';
+import type { BuilderBlock } from '../types/builder-block.js';
+type Options = {
+    block: BuilderBlock;
+} & Pick<BuilderContextInterface, 'localState' | 'context' | 'rootState' | 'rootSetState'>;
+type EventHandler = (event: Event) => any;
+export declare const createEventHandler: (value: string, options: Options) => EventHandler;
+export {};

package/dist/functions/get-block-actions-handler.js

@@ -0,0 +1,10 @@
+import { evaluate } from './evaluate.js';
+export const createEventHandler = (value, options) => event => evaluate({
+    code: value,
+    context: options.context,
+    localState: options.localState,
+    rootState: options.rootState,
+    rootSetState: options.rootSetState,
+    event,
+    isExpression: false
+});

package/dist/functions/get-block-actions.d.ts

@@ -0,0 +1,10 @@
+import type { BuilderContextInterface } from '../context/types.js';
+import type { BuilderBlock } from '../types/builder-block.js';
+type Actions = {
+    [index: string]: (event: Event) => any;
+};
+export declare function getBlockActions(options: {
+    block: BuilderBlock;
+    stripPrefix?: boolean;
+} & Pick<BuilderContextInterface, 'localState' | 'context' | 'rootState' | 'rootSetState'>): Actions;
+export {};

package/dist/functions/get-block-actions.js

@@ -0,0 +1,28 @@
+import { TARGET } from '../constants/target.js';
+import { getEventHandlerName } from './event-handler-name.js';
+import { createEventHandler } from './get-block-actions-handler.js';
+export function getBlockActions(options) {
+    const obj = {};
+    const optionActions = options.block.actions ?? {};
+    for (const key in optionActions) {
+        // eslint-disable-next-line no-prototype-builtins
+        if (!optionActions.hasOwnProperty(key)) {
+            continue;
+        }
+        const value = optionActions[key];
+        let eventHandlerName = getEventHandlerName(key);
+        if (options.stripPrefix) {
+            switch (TARGET) {
+                case 'vue2':
+                case 'vue3':
+                    eventHandlerName = eventHandlerName.replace('v-on:', '');
+                    break;
+                case 'svelte':
+                    eventHandlerName = eventHandlerName.replace('on:', '');
+                    break;
+            }
+        }
+        obj[eventHandlerName] = createEventHandler(value, options);
+    }
+    return obj;
+}

package/dist/functions/get-block-component-options.d.ts

@@ -0,0 +1,2 @@
+import type { BuilderBlock } from '../types/builder-block.js';
+export declare function getBlockComponentOptions(block: BuilderBlock): any;

package/dist/functions/get-block-component-options.js

@@ -0,0 +1,8 @@
+export function getBlockComponentOptions(block) {
+    return { ...block.component?.options,
+        ...block.options,
+        /**
+         * Our built-in components frequently make use of the block, so we provide all of it under `builderBlock`
+         */
+        builderBlock: block };
+}

package/dist/functions/get-block-properties.d.ts

@@ -0,0 +1,6 @@
+import type { BuilderContextInterface } from '../context/types.js';
+import type { BuilderBlock } from '../types/builder-block.js';
+export declare function getBlockProperties({ block, context }: {
+    block: BuilderBlock;
+    context: BuilderContextInterface;
+}): any;

package/dist/functions/get-block-properties.js

@@ -0,0 +1,71 @@
+import { TARGET } from '../constants/target.js';
+import { convertStyleMapToCSSArray } from '../helpers/css.js';
+import { getReactNativeBlockStyles } from './get-react-native-block-styles.js';
+import { transformBlockProperties } from './transform-block-properties.js';
+const extractRelevantRootBlockProperties = (block) => {
+    // currently we are only spreading the `href` property
+    // TO-DO: potentially spread all properties from block, but only if they are not already defined by BuilderBlock
+    // const {
+    //   '@type': _type,
+    //   '@version': _version,
+    //   id: _id,
+    //   tagName: _tagName,
+    //   layerName: _layerName,
+    //   groupLocked: _groupLocked,
+    //   layerLocked: _layerLocked,
+    //   class: _class,
+    //   children: _children,
+    //   responsiveStyles: _responsiveStyles,
+    //   component: _component,
+    //   bindings: _bindings,
+    //   meta: _meta,
+    //   actions: _actions,
+    //   properties: _properties,
+    //   code: _code,
+    //   repeat: _repeat,
+    //   animations: _animations,
+    //   style: _style,
+    //   hide: _hide,
+    //   show: _show,
+    //   // anything set by dynamic bindings outside of predefined `BuilderBlock` properties
+    //   ...remainingBlockProperties
+    // } = block;
+    return {
+        href: block.href
+    };
+};
+export function getBlockProperties({ block, context }) {
+    const properties = { ...extractRelevantRootBlockProperties(block),
+        ...block.properties,
+        'builder-id': block.id,
+        style: block.style ? getStyleAttribute(block.style) : undefined,
+        class: [block.id, 'builder-block', block.class, block.properties?.class].filter(Boolean).join(' ')
+    };
+    if (TARGET === 'reactNative') {
+        properties.style = getReactNativeBlockStyles({
+            block,
+            context,
+            blockStyles: properties.style
+        });
+    }
+    return transformBlockProperties(properties);
+}
+/**
+ * Svelte does not support style attribute as an object so we need to flatten it.
+ *
+ * Additionally, Svelte, Vue and other frameworks use kebab-case styles, so we need to convert them.
+ */
+function getStyleAttribute(style) {
+    switch (TARGET) {
+        case 'svelte':
+        case 'vue2':
+        case 'vue3':
+        case 'solid':
+            return convertStyleMapToCSSArray(style).join(' ');
+        case 'qwik':
+        case 'reactNative':
+        case 'react':
+        case 'rsc':
+            return style;
+    }
+}

package/dist/functions/get-builder-search-params/index.d.ts

@@ -0,0 +1,12 @@
+type QueryObject = Record<string, string | string[]>;
+export declare const convertSearchParamsToQueryObject: (searchParams: URLSearchParams) => QueryObject;
+/**
+ * Receives a `URLSearchParams` object or a regular query object, and returns the subset of query params that are
+ * relevant to the Builder SDK.
+ *
+ * @returns
+ */
+export declare const getBuilderSearchParams: (_options: QueryObject | URLSearchParams | undefined) => QueryObject;
+export declare const getBuilderSearchParamsFromWindow: () => QueryObject;
+export declare const normalizeSearchParams: (searchParams: QueryObject | URLSearchParams) => QueryObject;
+export {};

package/dist/functions/get-builder-search-params/index.js

@@ -0,0 +1,38 @@
+import { isBrowser } from '../is-browser.js';
+const BUILDER_SEARCHPARAMS_PREFIX = 'builder.';
+const BUILDER_OPTIONS_PREFIX = 'options.';
+export const convertSearchParamsToQueryObject = (searchParams) => {
+    const options = {};
+    searchParams.forEach((value, key) => {
+        options[key] = value;
+    });
+    return options;
+};
+/**
+ * Receives a `URLSearchParams` object or a regular query object, and returns the subset of query params that are
+ * relevant to the Builder SDK.
+ *
+ * @returns
+ */
+export const getBuilderSearchParams = (_options) => {
+    if (!_options) {
+        return {};
+    }
+    const options = normalizeSearchParams(_options);
+    const newOptions = {};
+    Object.keys(options).forEach(key => {
+        if (key.startsWith(BUILDER_SEARCHPARAMS_PREFIX)) {
+            const trimmedKey = key.replace(BUILDER_SEARCHPARAMS_PREFIX, '').replace(BUILDER_OPTIONS_PREFIX, '');
+            newOptions[trimmedKey] = options[key];
+        }
+    });
+    return newOptions;
+};
+export const getBuilderSearchParamsFromWindow = () => {
+    if (!isBrowser()) {
+        return {};
+    }
+    const searchParams = new URLSearchParams(window.location.search);
+    return getBuilderSearchParams(searchParams);
+};
+export const normalizeSearchParams = (searchParams) => searchParams instanceof URLSearchParams ? convertSearchParamsToQueryObject(searchParams) : searchParams;

package/dist/functions/get-content/generate-content-url.d.ts

@@ -0,0 +1,2 @@
+import type { GetContentOptions } from './types.js';
+export declare const generateContentUrl: (options: GetContentOptions) => URL;

package/dist/functions/get-content/generate-content-url.js

@@ -0,0 +1,32 @@
+import { flatten } from '../../helpers/flatten.js';
+import { getBuilderSearchParamsFromWindow, normalizeSearchParams } from '../get-builder-search-params/index.js';
+import { DEFAULT_API_VERSION } from '../../types/api-version.js';
+export const generateContentUrl = (options) => {
+    const { limit = 30, userAttributes, query, noTraverse = false, model, apiKey, includeRefs = true, enrich, locale, apiVersion = DEFAULT_API_VERSION } = options;
+    if (!apiKey) {
+        throw new Error('Missing API key');
+    }
+    if (!['v2', 'v3'].includes(apiVersion)) {
+        throw new Error(`Invalid apiVersion: expected 'v2' or 'v3', received '${apiVersion}'`);
+    }
+    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 queryOptions = { ...getBuilderSearchParamsFromWindow(),
+        ...normalizeSearchParams(options.options || {})
+    };
+    const flattened = flatten(queryOptions);
+    for (const key in flattened) {
+        url.searchParams.set(key, String(flattened[key]));
+    }
+    if (userAttributes) {
+        url.searchParams.set('userAttributes', JSON.stringify(userAttributes));
+    }
+    if (query) {
+        const flattened = flatten({
+            query
+        });
+        for (const key in flattened) {
+            url.searchParams.set(key, JSON.stringify(flattened[key]));
+        }
+    }
+    return url;
+};

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

@@ -0,0 +1,16 @@
+import type { BuilderContent } from '../../types/builder-content.js';
+import type { GetContentOptions } from './types.js';
+export declare function getContent(options: GetContentOptions): Promise<BuilderContent | null>;
+type ContentResults = {
+    results: BuilderContent[];
+};
+type ContentResponse = ContentResults | {
+    status: number;
+    message: string;
+};
+/**
+ * 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<ContentResponse | null>;
+export {};

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

@@ -0,0 +1,82 @@
+import { TARGET } from '../../constants/target.js';
+import { handleABTesting } from '../../helpers/ab-tests.js';
+import { getDefaultCanTrack } from '../../helpers/canTrack.js';
+import { logger } from '../../helpers/logger.js';
+import { getPreviewContent } from '../../helpers/preview-lru-cache/get.js';
+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({ ...options,
+        limit: 1
+    });
+    if (allContent && checkContentHasResults(allContent)) {
+        return allContent.results[0] || null;
+    }
+    return null;
+}
+const fetchContent = async (options) => {
+    const url = generateContentUrl(options);
+    const res = await fetch(url.href);
+    const content = await res.json();
+    return content;
+};
+/**
+ * Exported only for testing purposes. Should not be used directly.
+ */
+export const processContentResult = async (options, content, url = generateContentUrl(options)) => {
+    const canTrack = getDefaultCanTrack(options.canTrack);
+    const isPreviewing = url.search.includes(`preview=`);
+    if (TARGET === 'rsc' && isPreviewing) {
+        const newResults = [];
+        for (const item of content.results) {
+            const previewContent = getPreviewContent(url.searchParams);
+            newResults.push(previewContent || item);
+        }
+        content.results = newResults;
+    }
+    if (!canTrack)
+        return content;
+    if (!(isBrowser() || TARGET === 'reactNative'))
+        return content;
+    /**
+     * For client-side navigations, it is ideal to handle AB testing at this point instead of using our
+     * complex multi-rendering variants approach, which is only needed for SSR'd content.
+     *
+     * This is also where react-native would handle AB testing.
+     */
+    try {
+        const newResults = [];
+        for (const item of content.results) {
+            newResults.push(await handleABTesting({
+                item,
+                canTrack
+            }));
+        }
+        content.results = newResults;
+    }
+    catch (e) {
+        logger.error('Could not process A/B tests. ', e);
+    }
+    return content;
+};
+export async function getAllContent(options) {
+    try {
+        const url = generateContentUrl(options);
+        const content = await fetchContent(options);
+        if (!checkContentHasResults(content)) {
+            logger.error('Error fetching data. ', {
+                url,
+                content,
+                options
+            });
+            return content;
+        }
+        return processContentResult(options, content);
+    }
+    catch (error) {
+        logger.error('Error fetching data. ', error);
+        return null;
+    }
+}

package/dist/functions/get-content/processCookies.d.ts

@@ -0,0 +1,2 @@
+import type { BuilderContent } from '../../types/builder-content';
+export declare const processCookies: (content: BuilderContent) => BuilderContent;

package/dist/functions/get-content/processCookies.js

@@ -0,0 +1,35 @@
+import { cookies } from 'next/headers';
+import { applyPatchWithMinimalMutationChain } from '../apply-patch-with-mutation';
+export const processCookies = (content) => {
+    const cookieStore = cookies();
+    const builderPatches = cookieStore
+        .getAll()
+        .filter((x) => x.name.startsWith('builder.patch.' + content.id + '.'))
+        .map((x) => {
+        // split into: `builder.patch.${contentId}.${blockId}.${index}`
+        const [, , , blockId, index] = x.name.split('.');
+        return {
+            blockId,
+            index: parseInt(index),
+            value: x.value,
+        };
+    })
+        .sort((a, b) => a.index - b.index);
+    if (!builderPatches.length)
+        return content;
+    let newContent = content;
+    for (const patchCookie of builderPatches) {
+        const { value } = patchCookie;
+        try {
+            const blockPatches = JSON.parse(value);
+            for (const patch of blockPatches) {
+                newContent = applyPatchWithMinimalMutationChain(newContent, patch, true);
+            }
+        }
+        catch (e) {
+            console.log('error parsing patch cookie', { value });
+            console.log('ignoring cookie');
+        }
+    }
+    return newContent;
+};

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

@@ -0,0 +1,51 @@
+export interface GetContentOptions {
+    /** The model to get content for */
+    model: string;
+    /** Your public API key */
+    apiKey: string;
+    /** Number of items to fetch. Default is 1 */
+    limit?: number;
+    /** User attributes to target on, such as { urlPath: '/foo', device: 'mobile', ...etc } */
+    userAttributes?: (Record<string, string> & {
+        urlPath?: string;
+    }) | null;
+    /** Custom query */
+    query?: Record<string, any>;
+    /**
+     * Any other API options.
+     * 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.
+     *
+     * Defaults to `true`.
+     */
+    canTrack?: boolean;
+    /**
+     * Include references in the response. Defaults to `true`.
+     * @deprecated use `enrich` instead
+     */
+    includeRefs?: boolean;
+    /**
+     * Include multilevel references in the response.
+     */
+    enrich?: boolean;
+    /**
+     * If provided, the API will auto-resolve localized objects to the value of this `locale` key.
+     */
+    locale?: string;
+    /**
+     * If provided, sets the Builder API version used to fetch content.
+     *
+     * Defaults to `v3`.
+     */
+    apiVersion?: 'v2' | 'v3';
+}

package/dist/functions/get-content/types.js

@@ -0,0 +1 @@
+export {};

package/dist/functions/get-fetch.d.ts

@@ -0,0 +1 @@
+export declare const fetch: typeof globalThis.fetch;

package/dist/functions/get-fetch.js

@@ -0,0 +1,11 @@
+import { getGlobalThis } from './get-global-this.js';
+function getFetch() {
+    const globalFetch = getGlobalThis().fetch;
+    if (typeof globalFetch === 'undefined') {
+        console.warn(`Builder SDK could not find a global fetch function. Make sure you have a polyfill for fetch in your project. 
+      For more information, read https://github.com/BuilderIO/this-package-uses-fetch`);
+        throw new Error('Builder SDK could not find a global `fetch` function');
+    }
+    return globalFetch;
+}
+export const fetch = getFetch();

package/dist/functions/get-global-this.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+type Global = typeof global | typeof window | typeof self | typeof globalThis;
+export declare function getGlobalThis(): Global;
+export {};

package/dist/functions/get-global-this.js

@@ -0,0 +1,15 @@
+export function getGlobalThis() {
+    if (typeof globalThis !== 'undefined') {
+        return globalThis;
+    }
+    if (typeof window !== 'undefined') {
+        return window;
+    }
+    if (typeof global !== 'undefined') {
+        return global;
+    }
+    if (typeof self !== 'undefined') {
+        return self;
+    }
+    return globalThis;
+}

package/dist/functions/get-processed-block.d.ts

@@ -0,0 +1,10 @@
+import type { BuilderContextInterface } from '../context/types.js';
+import type { BuilderBlock } from '../types/builder-block.js';
+export declare function getProcessedBlock({ block, context, shouldEvaluateBindings, localState, rootState, rootSetState }: {
+    block: BuilderBlock;
+    /**
+     * In some cases, we want to avoid evaluating bindings and only want framework-specific block transformation. It is
+     * also sometimes too early to consider bindings, e.g. when we might be looking at a repeated block.
+     */
+    shouldEvaluateBindings: boolean;
+} & Pick<BuilderContextInterface, 'localState' | 'context' | 'rootState' | 'rootSetState'>): BuilderBlock;

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

@@ -0,0 +1,43 @@
+import { evaluate } from './evaluate.js';
+import { fastClone } from './fast-clone.js';
+import { set } from './set.js';
+import { transformBlock } from './transform-block.js';
+const evaluateBindings = ({ block, context, localState, rootState, rootSetState }) => {
+    if (!block.bindings) {
+        return block;
+    }
+    const copy = fastClone(block);
+    const copied = { ...copy,
+        properties: { ...copy.properties
+        },
+        actions: { ...copy.actions
+        }
+    };
+    for (const binding in block.bindings) {
+        const expression = block.bindings[binding];
+        const value = evaluate({
+            code: expression,
+            localState,
+            rootState,
+            rootSetState,
+            context
+        });
+        set(copied, binding, value);
+    }
+    return copied;
+};
+export function getProcessedBlock({ block, context, shouldEvaluateBindings, localState, rootState, rootSetState }) {
+    const transformedBlock = transformBlock(block);
+    if (shouldEvaluateBindings) {
+        return evaluateBindings({
+            block: transformedBlock,
+            localState,
+            rootState,
+            rootSetState,
+            context
+        });
+    }
+    else {
+        return transformedBlock;
+    }
+}

package/dist/functions/get-react-native-block-styles.d.ts

@@ -0,0 +1,7 @@
+import type { BuilderContextInterface } from '../context/types.js';
+import type { BuilderBlock } from '../types/builder-block.js';
+export declare function getReactNativeBlockStyles({ block, context, blockStyles }: {
+    block: BuilderBlock;
+    context: BuilderContextInterface;
+    blockStyles: any;
+}): CSSStyleDeclaration | Record<string, string | undefined>;

package/dist/functions/get-react-native-block-styles.js

@@ -0,0 +1,16 @@
+import { sanitizeReactNativeBlockStyles } from './sanitize-react-native-block-styles.js';
+export function getReactNativeBlockStyles({ block, context, blockStyles }) {
+    const responsiveStyles = block.responsiveStyles;
+    if (!responsiveStyles) {
+        return {};
+    }
+    const styles = {
+        ...context.inheritedStyles,
+        ...(responsiveStyles.large || {}),
+        ...(responsiveStyles.medium || {}),
+        ...(responsiveStyles.small || {}),
+        ...blockStyles
+    };
+    const newStyles = sanitizeReactNativeBlockStyles(styles);
+    return newStyles;
+}

package/dist/functions/is-browser.d.ts

@@ -0,0 +1 @@
+export declare function isBrowser(): boolean;

package/dist/functions/is-browser.js

@@ -0,0 +1,3 @@
+export function isBrowser() {
+    return typeof window !== 'undefined' && typeof document !== 'undefined';
+}

package/dist/functions/is-editing.d.ts

@@ -0,0 +1 @@
+export declare function isEditing(): boolean;

package/dist/functions/is-editing.js

@@ -0,0 +1,5 @@
+import { TARGET } from '../constants/target.js';
+import { isIframe } from './is-iframe.js';
+export function isEditing() {
+    return isIframe() && (TARGET === 'reactNative' || window.location.search.indexOf('builder.frameEditing=') !== -1);
+}

package/dist/functions/is-iframe.d.ts

@@ -0,0 +1 @@
+export declare function isIframe(): boolean;

package/dist/functions/is-iframe.js

@@ -0,0 +1,4 @@
+import { isBrowser } from './is-browser.js';
+export function isIframe() {
+    return isBrowser() && window.self !== window.top;
+}

package/dist/functions/is-previewing.d.ts

@@ -0,0 +1 @@
+export declare function isPreviewing(): boolean;

package/dist/functions/is-previewing.js

@@ -0,0 +1,11 @@
+import { isBrowser } from './is-browser.js';
+import { isEditing } from './is-editing.js';
+export function isPreviewing() {
+    if (!isBrowser()) {
+        return false;
+    }
+    if (isEditing()) {
+        return false;
+    }
+    return Boolean(location.search.indexOf('builder.preview=') !== -1);
+}