@builder.io/sdk-react-nextjs 0.4.5

package/dist/functions/register-component.d.ts

@@ -0,0 +1,15 @@
+import type { RegisteredComponent } from '../context/types.js';
+import type { ComponentInfo } from '../types/components.js';
+/**
+ * @deprecated.  Use the `customComponents` prop in RenderContent instead to provide your custom components to the builder SDK.
+ */
+export declare const components: RegisteredComponent[];
+/**
+ * @deprecated.  Use the `customComponents` prop in RenderContent instead to provide your custom components to the builder SDK.
+ */
+export declare function registerComponent(component: any, info: ComponentInfo): void;
+export declare const createRegisterComponentMessage: (info: ComponentInfo) => {
+    type: string;
+    data: ComponentInfo;
+};
+export declare const serializeComponentInfo: ({ inputs, ...info }: ComponentInfo) => ComponentInfo;

package/dist/functions/register-component.js

@@ -0,0 +1,34 @@
+import { fastClone } from './fast-clone.js';
+/**
+ * @deprecated.  Use the `customComponents` prop in RenderContent instead to provide your custom components to the builder SDK.
+ */
+export const components = [];
+/**
+ * @deprecated.  Use the `customComponents` prop in RenderContent instead to provide your custom components to the builder SDK.
+ */
+export function registerComponent(component, info) {
+    components.push({
+        component,
+        ...info
+    });
+    console.warn('registerComponent is deprecated. Use the `customComponents` prop in RenderContent instead to provide your custom components to the builder SDK.');
+    return component;
+}
+export const createRegisterComponentMessage = (info) => ({
+    type: 'builder.registerComponent',
+    data: info
+}); // eslint-disable-next-line @typescript-eslint/ban-types
+const serializeFn = (fnValue) => {
+    const fnStr = fnValue.toString().trim(); // we need to account for a few different fn syntaxes:
+    // 1. `function name(args) => {code}`
+    // 2. `name(args) => {code}`
+    // 3. `(args) => {}`
+    const appendFunction = !fnStr.startsWith('function') && !fnStr.startsWith('(');
+    return `return (${appendFunction ? 'function ' : ''}${fnStr}).apply(this, arguments)`;
+};
+const serializeValue = (value) => typeof value === 'function' ? serializeFn(value) : fastClone(value);
+export const serializeComponentInfo = ({ inputs, ...info }) => ({ ...fastClone(info),
+    inputs: inputs?.map(input => Object.entries(input).reduce((acc, [key, value]) => ({ ...acc,
+        [key]: serializeValue(value)
+    }), {}))
+});

package/dist/functions/register.d.ts

@@ -0,0 +1,16 @@
+import type { BuilderBlock } from '../types/builder-block.js';
+import type { DeepPartial } from '../types/deep-partial.js';
+export interface InsertMenuItem {
+    name: string;
+    icon?: string;
+    item: DeepPartial<BuilderBlock>;
+}
+export interface InsertMenuConfig {
+    name: string;
+    priority?: number;
+    persist?: boolean;
+    advanced?: boolean;
+    items: InsertMenuItem[];
+}
+export declare function register(type: 'insertMenu', info: InsertMenuConfig): void;
+export declare function register(type: string, info: any): void;

package/dist/functions/register.js

@@ -0,0 +1,27 @@
+import { isBrowser } from './is-browser.js';
+const registry = {};
+export function register(type, info) {
+    let typeList = registry[type];
+    if (!typeList) {
+        typeList = registry[type] = [];
+    }
+    typeList.push(info);
+    if (isBrowser()) {
+        const message = {
+            type: 'builder.register',
+            data: {
+                type,
+                info
+            }
+        };
+        try {
+            parent.postMessage(message, '*');
+            if (parent !== window) {
+                window.postMessage(message, '*');
+            }
+        }
+        catch (err) {
+            console.debug('Could not postmessage', err);
+        }
+    }
+}

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

@@ -0,0 +1,3 @@
+type Styles = Record<string, string | number>;
+export declare const sanitizeReactNativeBlockStyles: (styles: Styles) => Styles;
+export {};

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

@@ -0,0 +1,58 @@
+const propertiesThatMustBeNumber = new Set(['lineHeight']);
+const displayValues = new Set(['flex', 'none']);
+const SHOW_WARNINGS = false;
+const normalizeNumber = (value) => {
+    if (Number.isNaN(value)) {
+        return undefined;
+    }
+    else if (value < 0) {
+        // TODO: why are negative values not allowed?
+        return 0;
+    }
+    else {
+        return value;
+    }
+};
+export const sanitizeReactNativeBlockStyles = (styles) => {
+    return Object.keys(styles).reduce((acc, key) => {
+        const propertyValue = styles[key];
+        if (key === 'display' && !displayValues.has(propertyValue)) {
+            if (SHOW_WARNINGS) {
+                console.warn(`Style value for key "display" must be "flex" or "none" but had ${propertyValue}`);
+            }
+            return acc;
+        }
+        if (propertiesThatMustBeNumber.has(key) && typeof propertyValue !== 'number') {
+            if (SHOW_WARNINGS) {
+                console.warn(`Style key ${key} must be a number, but had value \`${styles[key]}\``);
+            }
+            return acc;
+        }
+        if (typeof propertyValue === 'string') {
+            // `px` units need to be stripped and replaced with numbers
+            // https://regexr.com/6ualn
+            const isPixelUnit = propertyValue.match(/^-?(\d*)(\.?)(\d*)*px$/);
+            if (isPixelUnit) {
+                const newValue = parseFloat(propertyValue);
+                const normalizedValue = normalizeNumber(newValue);
+                if (normalizedValue) {
+                    return { ...acc,
+                        [key]: normalizedValue
+                    };
+                }
+                else {
+                    return acc;
+                }
+            }
+            else if (propertyValue === '0') {
+                // 0 edge case needs to be handled
+                return { ...acc,
+                    [key]: 0
+                };
+            }
+        }
+        return { ...acc,
+            [key]: propertyValue
+        };
+    }, {});
+};

package/dist/functions/set-editor-settings.d.ts

@@ -0,0 +1,4 @@
+export type Settings = {
+    customInsertMenu?: boolean;
+};
+export declare function setEditorSettings(newSettings: Settings): void;

package/dist/functions/set-editor-settings.js

@@ -0,0 +1,12 @@
+import { isBrowser } from './is-browser.js';
+const settings = {};
+export function setEditorSettings(newSettings) {
+    if (isBrowser()) {
+        Object.assign(settings, newSettings);
+        const message = {
+            type: 'builder.settingsChange',
+            data: settings
+        };
+        parent.postMessage(message, '*');
+    }
+}

package/dist/functions/set.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Minimal implementation of lodash's _.set
+ * https://lodash.com/docs/4.17.15#set
+ *
+ * See ./set.test.ts for usage examples
+ */
+export declare const set: (obj: any, _path: string | string[], value: any) => any;

package/dist/functions/set.js

@@ -0,0 +1,14 @@
+/**
+ * Minimal implementation of lodash's _.set
+ * https://lodash.com/docs/4.17.15#set
+ *
+ * See ./set.test.ts for usage examples
+ */
+export const set = (obj, _path, value) => {
+    if (Object(obj) !== obj) {
+        return obj;
+    }
+    const path = Array.isArray(_path) ? _path : _path.toString().match(/[^.[\]]+/g);
+    path.slice(0, -1).reduce((a, c, i) => Object(a[c]) === a[c] ? a[c] : a[c] = Math.abs(Number(path[i + 1])) >> 0 === +path[i + 1] ? [] : {}, obj)[path[path.length - 1]] = value;
+    return obj;
+};

package/dist/functions/track/helpers.d.ts

@@ -0,0 +1,5 @@
+export declare const getUserAttributes: () => {
+    urlPath: string;
+    host: string;
+    device: string;
+};

package/dist/functions/track/helpers.js

@@ -0,0 +1,50 @@
+import { TARGET } from '../../constants/target.js';
+import { isBrowser } from '../is-browser.js';
+const getLocation = () => {
+    if (TARGET === 'reactNative') {
+        return null;
+    }
+    else if (isBrowser()) {
+        const parsedLocation = new URL(location.href); // IE11 bug with parsed path being empty string
+        // causes issues with our user targeting
+        if (parsedLocation.pathname === '') {
+            parsedLocation.pathname = '/';
+        }
+        return parsedLocation;
+    }
+    else {
+        console.warn('Cannot get location for tracking in non-browser environment');
+        return null;
+    }
+};
+const getUserAgent = () => typeof navigator === 'object' && navigator.userAgent || '';
+export const getUserAttributes = () => {
+    const userAgent = getUserAgent();
+    const isMobile = {
+        Android() {
+            return userAgent.match(/Android/i);
+        },
+        BlackBerry() {
+            return userAgent.match(/BlackBerry/i);
+        },
+        iOS() {
+            return userAgent.match(/iPhone|iPod/i);
+        },
+        Opera() {
+            return userAgent.match(/Opera Mini/i);
+        },
+        Windows() {
+            return userAgent.match(/IEMobile/i) || userAgent.match(/WPDesktop/i);
+        },
+        any() {
+            return isMobile.Android() || isMobile.BlackBerry() || isMobile.iOS() || isMobile.Opera() || isMobile.Windows() || TARGET === 'reactNative';
+        }
+    };
+    const isTablet = userAgent.match(/Tablet|iPad/i);
+    const url = getLocation();
+    return {
+        urlPath: url?.pathname,
+        host: url?.host || url?.hostname,
+        device: isTablet ? 'tablet' : isMobile.any() ? 'mobile' : 'desktop'
+    };
+};

package/dist/functions/track/index.d.ts

@@ -0,0 +1,51 @@
+import type { CanTrack } from '../../types/can-track.js';
+import type { Dictionary } from '../../types/typescript.js';
+interface Event {
+    /**
+     * The type of your event.
+     *
+     * Examples: `click`, `conversion`, `pageview`, `impression`
+     */
+    type: string;
+    data: {
+        /**
+         * (Optional) The content's ID. Useful if this event pertains to a specific piece of content.
+         */
+        contentId?: string;
+        /**
+         * This is the ID of the space that the content belongs to.
+         */
+        ownerId: string;
+        /**
+         * (Optional) metadata that you want to provide with your event.
+         */
+        metadata?: Dictionary<any>;
+        /**
+         * Session ID of the user. This is provided by the SDK by checking session storage.
+         */
+        sessionId: string | undefined;
+        /**
+         * Visitor ID of the user. This is provided by the SDK by checking cookies.
+         */
+        visitorId: string | undefined;
+        /**
+         * (Optional) If running an A/B test, the ID of the variation that the user is in.
+         */
+        variationId?: string;
+        [index: string]: any;
+    };
+}
+type EventProperties = Pick<Event, 'type'> & Pick<Event['data'], 'contentId' | 'variationId' | 'metadata'> & {
+    /**
+     * Your organization's API key.
+     */
+    apiKey: Event['data']['ownerId'];
+    /**
+     * (Optional) Any additional (non-metadata) properties to add to the event.
+     */
+    [index: string]: any;
+};
+export type EventProps = EventProperties & CanTrack;
+export declare function _track(eventProps: EventProps): Promise<void | Response>;
+export declare const track: (args: EventProperties) => Promise<void | Response>;
+export {};

package/dist/functions/track/index.js

@@ -0,0 +1,69 @@
+import { TARGET } from '../../constants/target.js';
+import { logger } from '../../helpers/logger.js';
+import { getSessionId } from '../../helpers/sessionId.js';
+import { getVisitorId } from '../../helpers/visitorId.js';
+import { isBrowser } from '../is-browser.js';
+import { isEditing } from '../is-editing.js';
+import { getUserAttributes } from './helpers.js';
+const getTrackingEventData = async ({ canTrack }) => {
+    if (!canTrack) {
+        return {
+            visitorId: undefined,
+            sessionId: undefined
+        };
+    }
+    const sessionId = await getSessionId({
+        canTrack
+    });
+    const visitorId = getVisitorId({
+        canTrack
+    });
+    return {
+        sessionId,
+        visitorId
+    };
+};
+const createEvent = async ({ type: eventType, canTrack, apiKey, metadata, ...properties }) => ({
+    type: eventType,
+    data: { ...properties,
+        metadata: {
+            url: location.href,
+            ...metadata
+        },
+        ...(await getTrackingEventData({
+            canTrack
+        })),
+        userAttributes: getUserAttributes(),
+        ownerId: apiKey
+    }
+});
+export async function _track(eventProps) {
+    if (!eventProps.apiKey) {
+        logger.error('Missing API key for track call. Please provide your API key.');
+        return;
+    }
+    if (!eventProps.canTrack) {
+        return;
+    }
+    if (isEditing()) {
+        return;
+    }
+    if (!(isBrowser() || TARGET === 'reactNative')) {
+        return;
+    }
+    return fetch(`https://cdn.builder.io/api/v1/track`, {
+        method: 'POST',
+        body: JSON.stringify({
+            events: [await createEvent(eventProps)]
+        }),
+        headers: {
+            'content-type': 'application/json'
+        },
+        mode: 'cors'
+    }).catch(err => {
+        console.error('Failed to track: ', err);
+    });
+}
+export const track = (args) => _track({ ...args,
+    canTrack: true
+});

package/dist/functions/track/interaction.d.ts

@@ -0,0 +1,13 @@
+type Offset = {
+    x: number;
+    y: number;
+};
+export declare const getInteractionPropertiesForEvent: (event: MouseEvent) => {
+    targetBuilderElement: string;
+    metadata: {
+        targetOffset: Offset;
+        builderTargetOffset: Offset;
+        builderElementIndex: any;
+    };
+};
+export {};

package/dist/functions/track/interaction.js

@@ -0,0 +1,53 @@
+function round(num) {
+    return Math.round(num * 1000) / 1000;
+}
+const findParentElement = (target, callback, checkElement = true) => {
+    if (!(target instanceof HTMLElement)) {
+        return null;
+    }
+    let parent = checkElement ? target : target.parentElement;
+    do {
+        if (!parent) {
+            return null;
+        }
+        const matches = callback(parent);
+        if (matches) {
+            return parent;
+        }
+    } while (parent = parent.parentElement);
+    return null;
+};
+const findBuilderParent = (target) => findParentElement(target, el => {
+    const id = el.getAttribute('builder-id') || el.id;
+    return Boolean(id?.indexOf('builder-') === 0);
+});
+const computeOffset = ({ event, target }) => {
+    const targetRect = target.getBoundingClientRect();
+    const xOffset = event.clientX - targetRect.left;
+    const yOffset = event.clientY - targetRect.top;
+    const xRatio = round(xOffset / targetRect.width);
+    const yRatio = round(yOffset / targetRect.height);
+    return {
+        x: xRatio,
+        y: yRatio
+    };
+};
+export const getInteractionPropertiesForEvent = (event) => {
+    const target = event.target;
+    const targetBuilderElement = target && findBuilderParent(target);
+    const builderId = targetBuilderElement?.getAttribute('builder-id') || targetBuilderElement?.id;
+    return {
+        targetBuilderElement: builderId || undefined,
+        metadata: {
+            targetOffset: target ? computeOffset({
+                event,
+                target
+            }) : undefined,
+            builderTargetOffset: targetBuilderElement ? computeOffset({
+                event,
+                target: targetBuilderElement
+            }) : undefined,
+            builderElementIndex: targetBuilderElement && builderId ? [].slice.call(document.getElementsByClassName(builderId)).indexOf(targetBuilderElement) : undefined
+        }
+    };
+};

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

@@ -0,0 +1 @@
+export declare function transformBlockProperties(properties: any): any;

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

@@ -0,0 +1,5 @@
+export function transformBlockProperties(properties) {
+    properties.className = properties.class;
+    delete properties.class;
+    return properties;
+}

package/dist/functions/transform-block.d.ts

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

package/dist/functions/transform-block.js

@@ -0,0 +1,3 @@
+export function transformBlock(block) {
+    return block;
+}

package/dist/helpers/ab-tests.d.ts

@@ -0,0 +1,9 @@
+import type { CanTrack } from '../types/can-track.js';
+import type { BuilderContent } from '../types/builder-content.js';
+import type { Nullable } from '../types/typescript.js';
+export declare const handleABTestingSync: ({ item, canTrack }: {
+    item: Nullable<BuilderContent>;
+} & CanTrack) => Nullable<BuilderContent>;
+export declare const handleABTesting: ({ item, canTrack }: {
+    item: BuilderContent;
+} & CanTrack) => Promise<BuilderContent>;

package/dist/helpers/ab-tests.js

@@ -0,0 +1,116 @@
+import { getCookie, getCookieSync, setCookie } from './cookie.js';
+import { checkIsDefined } from '../helpers/nullable.js';
+import { logger } from './logger.js';
+import { TARGET } from '../constants/target.js';
+const BUILDER_STORE_PREFIX = 'builder.tests';
+const getContentTestKey = (id) => `${BUILDER_STORE_PREFIX}.${id}`;
+const getContentVariationCookie = ({ contentId }) => getCookie({
+    name: getContentTestKey(contentId),
+    canTrack: true
+});
+const getContentVariationCookieSync = ({ contentId }) => getCookieSync({
+    name: getContentTestKey(contentId),
+    canTrack: true
+});
+const setContentVariationCookie = ({ contentId, value }) => setCookie({
+    name: getContentTestKey(contentId),
+    value,
+    canTrack: true
+});
+const checkIsBuilderContentWithVariations = (item) => checkIsDefined(item.id) && checkIsDefined(item.variations) && Object.keys(item.variations).length > 0;
+/**
+ * Randomly assign a variation to a user
+ */
+const getRandomVariationId = ({ id, variations }) => {
+    let n = 0;
+    const random = Math.random(); // loop over variations test ratios, incrementing a counter,
+    // until we find the variation that this user should be assigned to
+    for (const id in variations) {
+        const testRatio = variations[id]?.testRatio;
+        n += testRatio;
+        if (random < n) {
+            return id;
+        }
+    } // the variations array does not include the default variation.
+    // if we arrive here, then it means that the random number fits in the default variation bucket.
+    return id;
+};
+const getAndSetVariantId = (args) => {
+    // if variation not found in storage, assign a random variation to this user
+    const randomVariationId = getRandomVariationId(args); // store variation in cookies/storage
+    setContentVariationCookie({
+        contentId: args.id,
+        value: randomVariationId
+    }).catch(err => {
+        logger.error('could not store A/B test variation: ', err);
+    });
+    return randomVariationId;
+};
+const getTestFields = ({ item, testGroupId }) => {
+    const variationValue = item.variations[testGroupId];
+    if (testGroupId === item.id || // handle edge-case where `testGroupId` points to non-existing variation
+        !variationValue) {
+        return {
+            testVariationId: item.id,
+            testVariationName: 'Default'
+        };
+    }
+    else {
+        return {
+            data: variationValue.data,
+            testVariationId: variationValue.id,
+            testVariationName: variationValue.name || (variationValue.id === item.id ? 'Default' : '')
+        };
+    }
+};
+export const handleABTestingSync = ({ item, canTrack }) => {
+    /**
+     * We cannot SSR in React-Native.
+     */
+    if (TARGET === 'reactNative')
+        return item;
+    if (!canTrack) {
+        return item;
+    }
+    if (!item) {
+        return undefined;
+    }
+    if (!checkIsBuilderContentWithVariations(item)) {
+        return item;
+    }
+    const testGroupId = getContentVariationCookieSync({
+        contentId: item.id
+    }) || getAndSetVariantId({
+        variations: item.variations,
+        id: item.id
+    });
+    const variationValue = getTestFields({
+        item,
+        testGroupId
+    });
+    return { ...item,
+        ...variationValue
+    };
+};
+export const handleABTesting = async ({ item, canTrack }) => {
+    if (!canTrack) {
+        return item;
+    }
+    if (!checkIsBuilderContentWithVariations(item)) {
+        return item;
+    }
+    const cookieValue = await getContentVariationCookie({
+        contentId: item.id
+    });
+    const testGroupId = cookieValue || getAndSetVariantId({
+        variations: item.variations,
+        id: item.id
+    });
+    const variationValue = getTestFields({
+        item,
+        testGroupId
+    });
+    return { ...item,
+        ...variationValue
+    };
+};

package/dist/helpers/canTrack.d.ts

@@ -0,0 +1 @@
+export declare const getDefaultCanTrack: (canTrack?: boolean) => boolean;

package/dist/helpers/canTrack.js

@@ -0,0 +1,2 @@
+import { checkIsDefined } from './nullable.js';
+export const getDefaultCanTrack = (canTrack) => checkIsDefined(canTrack) ? canTrack : true;

package/dist/helpers/cookie.d.ts

@@ -0,0 +1,19 @@
+import type { CanTrack } from '../types/can-track.js';
+type GetCookieArgs = {
+    name: string;
+} & CanTrack;
+export declare const getCookieSync: ({ name, canTrack }: GetCookieArgs) => string | undefined;
+/**
+ * NOTE: This function is `async` because its react-native override is async. Do not remove the `async` keyword!
+ * The sync version is only safe to use in code blocks that `react-native` is guaranteed not to not run.
+ */
+export declare const getCookie: (args: GetCookieArgs) => Promise<string>;
+/**
+ * NOTE: This function is `async` because its react-native override is async. Do not remove the `async` keyword!
+ */
+export declare const setCookie: ({ name, value, expires, canTrack }: {
+    name: string;
+    value: string;
+    expires?: Date;
+} & CanTrack) => Promise<void>;
+export {};