@builder.io/sdk-react 0.4.5 → 0.5.0

package/dist/sdk/types/builder-props.d.ts

@@ -1,10 +0,0 @@
-import type { BuilderContextInterface, RegisteredComponent } from '../context/types';
-import type { BuilderBlock } from './builder-block';
-import type { Dictionary } from './typescript';
-export type PropsWithBuilderData<T> = T & {
-    builderBlock: BuilderBlock;
-    builderContext: BuilderContextInterface;
-};
-export type BuilderComponentsProp = {
-    builderComponents: Dictionary<RegisteredComponent>;
-};

package/dist/sdk/types/targets.d.ts

@@ -1,3 +0,0 @@
-type MitosisTargets = import('@builder.io/mitosis').Target;
-export type Target = Extract<MitosisTargets, 'vue3' | 'vue2' | 'reactNative' | 'svelte' | 'qwik' | 'react' | 'solid'>;
-export {};

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

@@ -1,6 +0,0 @@
-type QueryObject = Record<string, string | string[]>;
-export declare const convertSearchParamsToQueryObject: (searchParams: URLSearchParams) => QueryObject;
-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/server/functions/get-builder-search-params/index.js

@@ -1,36 +0,0 @@
-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;
-};
-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/server/functions/get-content/ab-testing.d.ts

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

package/dist/server/functions/get-content/ab-testing.js

@@ -1,78 +0,0 @@
-import { getContentVariationCookie, setContentVariationCookie, } from '../../helpers/ab-tests.js';
-import { checkIsDefined } from '../../helpers/nullable.js';
-const checkIsBuilderContentWithVariations = (item) => checkIsDefined(item.id) &&
-    checkIsDefined(item.variations) &&
-    Object.keys(item.variations).length > 0;
-/**
- * Randomly assign a variation to this user and store it in cookies/storage
- */
-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;
-        }
-    }
-    // `item.variations` 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 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' : ''),
-        };
-    }
-};
-const getContentVariation = async ({ item, canTrack, }) => {
-    // try to find test variation in cookies/storage
-    const testGroupId = await getContentVariationCookie({
-        canTrack,
-        contentId: item.id,
-    });
-    const testFields = testGroupId
-        ? getTestFields({ item, testGroupId })
-        : undefined;
-    if (testFields) {
-        return testFields;
-    }
-    else {
-        // if variation not found in storage, assign a random variation to this user
-        const randomVariationId = getRandomVariationId({
-            variations: item.variations,
-            id: item.id,
-        });
-        // store variation in cookies/storage
-        setContentVariationCookie({
-            contentId: item.id,
-            value: randomVariationId,
-            canTrack,
-        }).catch((err) => {
-            console.error('could not store A/B test variation: ', err);
-        });
-        return getTestFields({ item, testGroupId: randomVariationId });
-    }
-};
-export const handleABTesting = async ({ item, canTrack, }) => {
-    if (!checkIsBuilderContentWithVariations(item)) {
-        return;
-    }
-    const variationValue = await getContentVariation({ item, canTrack });
-    Object.assign(item, variationValue);
-};

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

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

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

@@ -1,31 +0,0 @@
-import { flatten } from '../../helpers/flatten.js';
-import { getBuilderSearchParamsFromWindow, normalizeSearchParams, } from '../get-builder-search-params/index.js';
-import { DEFAULT_API_VERSION } from '../../types/api-version';
-export const generateContentUrl = (options) => {
-    const { limit = 30, userAttributes, query, noTraverse = false, model, apiKey, includeRefs = true, 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}` : ''}`);
-    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/server/functions/get-content/generate-content-url.test.d.ts

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

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

@@ -1,82 +0,0 @@
-import { generateContentUrl } from './generate-content-url';
-const testKey = 'YJIGb4i01jvw0SRdL5Bt';
-const testModel = 'page';
-const testId = 'c1b81bab59704599b997574eb0736def';
-const options = {
-    cachebust: 'true',
-    noCache: 'true',
-    'overrides.037948e52eaf4743afed464f02c70da4': '037948e52eaf4743afed464f02c70da4',
-    'overrides.page': '037948e52eaf4743afed464f02c70da4',
-    'overrides.page:/': '037948e52eaf4743afed464f02c70da4',
-    preview: 'page',
-};
-describe('Generate Content URL', () => {
-    test('generates the proper value for a simple query', () => {
-        const output = generateContentUrl({
-            apiKey: testKey,
-            model: testModel,
-            query: { id: testId },
-        });
-        expect(output).toMatchSnapshot();
-    });
-    test('Handles overrides correctly', () => {
-        const output = generateContentUrl({
-            apiKey: testKey,
-            model: testModel,
-            query: { id: testId },
-            options,
-        });
-        expect(output).toMatchSnapshot();
-    });
-    test('generate content url with apiVersion as default', () => {
-        const output = generateContentUrl({
-            apiKey: testKey,
-            model: testModel,
-            query: { id: testId },
-            options,
-        });
-        expect(output).toMatchSnapshot();
-    });
-    test('generate content url with apiVersion as v2', () => {
-        const output = generateContentUrl({
-            apiKey: testKey,
-            model: testModel,
-            query: { id: testId },
-            options,
-            apiVersion: 'v2',
-        });
-        expect(output).toMatchSnapshot();
-    });
-    test('generate content url with apiVersion as v3', () => {
-        const output = generateContentUrl({
-            apiKey: testKey,
-            model: testModel,
-            query: { id: testId },
-            options,
-            apiVersion: 'v3',
-        });
-        expect(output).toMatchSnapshot();
-    });
-    test('throw error when trying to generate content url with apiVersion as v1', () => {
-        expect(() => {
-            generateContentUrl({
-                apiKey: testKey,
-                model: testModel,
-                query: { id: testId },
-                options,
-                apiVersion: 'v1',
-            });
-        }).toThrow(`Invalid apiVersion: expected 'v2' or 'v3', received 'v1'`);
-    });
-    test('throw error when trying to generate content url with an invalid apiVersion value', () => {
-        expect(() => {
-            generateContentUrl({
-                apiKey: testKey,
-                model: testModel,
-                query: { id: testId },
-                options,
-                apiVersion: 'INVALID_API_VERSION',
-            });
-        }).toThrow(`Invalid apiVersion: expected 'v2' or 'v3', received 'INVALID_API_VERSION'`);
-    });
-});

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

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

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

@@ -1,40 +0,0 @@
-import { logger } from '../../helpers/logger.js';
-import { fetch } from '../get-fetch.js';
-import { handleABTesting } from './ab-testing.js';
-import { generateContentUrl } from './generate-content-url.js';
-export async function getContent(options) {
-    const allContent = await getAllContent({ ...options, limit: 1 });
-    if (allContent && 'results' in allContent) {
-        return allContent?.results[0] || null;
-    }
-    return null;
-}
-export async function getAllContent(options) {
-    try {
-        const url = generateContentUrl(options);
-        const res = await fetch(url.href);
-        const content = await res.json();
-        if ('status' in content && !('results' in content)) {
-            logger.error('Error fetching data. ', { url, content, options });
-            return content;
-        }
-        const canTrack = options.canTrack !== false;
-        try {
-            if (canTrack &&
-                // This makes sure we have a non-error response with the results array.
-                Array.isArray(content.results)) {
-                for (const item of content.results) {
-                    await handleABTesting({ item, canTrack });
-                }
-            }
-        }
-        catch (e) {
-            logger.error('Could not setup A/B testing. ', e);
-        }
-        return content;
-    }
-    catch (error) {
-        logger.error('Error fetching data. ', error);
-        return null;
-    }
-}

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

@@ -1,45 +0,0 @@
-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.
-     */
-    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`.
-     */
-    includeRefs?: 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/server/functions/get-fetch.d.ts

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

package/dist/server/functions/get-fetch.js

@@ -1,11 +0,0 @@
-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/server/functions/get-global-this.d.ts

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

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

@@ -1,15 +0,0 @@
-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/server/functions/is-browser.d.ts

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

package/dist/server/functions/is-browser.js

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

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

@@ -1,8 +0,0 @@
-import type { CanTrack } from '../types/can-track.js';
-export declare const getContentVariationCookie: ({ contentId, canTrack, }: {
-    contentId: string;
-} & CanTrack) => Promise<string>;
-export declare const setContentVariationCookie: ({ contentId, canTrack, value, }: {
-    contentId: string;
-    value: string;
-} & CanTrack) => Promise<void>;

package/dist/server/helpers/ab-tests.js

@@ -1,5 +0,0 @@
-import { getCookie, setCookie } from './cookie.js';
-const BUILDER_STORE_PREFIX = 'builderio.variations';
-const getContentTestKey = (id) => `${BUILDER_STORE_PREFIX}.${id}`;
-export const getContentVariationCookie = ({ contentId, canTrack, }) => getCookie({ name: getContentTestKey(contentId), canTrack });
-export const setContentVariationCookie = ({ contentId, canTrack, value, }) => setCookie({ name: getContentTestKey(contentId), value, canTrack });

package/dist/server/helpers/cookie.d.ts

@@ -1,15 +0,0 @@
-import type { CanTrack } from '../types/can-track.js';
-/**
- * NOTE: This function is `async` because its react-native override is async. Do not remove the `async` keyword!
- */
-export declare const getCookie: ({ name, canTrack, }: {
-    name: string;
-} & CanTrack) => Promise<string | undefined>;
-/**
- * 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>;

package/dist/server/helpers/cookie.js

@@ -1,65 +0,0 @@
-import { isBrowser } from '../functions/is-browser.js';
-import { checkIsDefined } from './nullable.js';
-import { getTopLevelDomain } from './url.js';
-/**
- * NOTE: This function is `async` because its react-native override is async. Do not remove the `async` keyword!
- */
-export const getCookie = async ({ name, canTrack, }) => {
-    try {
-        if (!canTrack) {
-            return undefined;
-        }
-        /**
-         * Extracted from MDN docs
-         * https://developer.mozilla.org/en-US/docs/Web/API/Document/cookie#example_2_get_a_sample_cookie_named_test2
-         */
-        return document.cookie
-            .split('; ')
-            .find((row) => row.startsWith(`${name}=`))
-            ?.split('=')[1];
-    }
-    catch (err) {
-        console.debug('[COOKIE] GET error: ', err);
-        return undefined;
-    }
-};
-const stringifyCookie = (cookie) => cookie
-    .map(([key, value]) => (value ? `${key}=${value}` : key))
-    .filter(checkIsDefined)
-    .join('; ');
-const SECURE_CONFIG = [
-    ['secure', ''],
-    ['SameSite', 'None'],
-];
-const createCookieString = ({ name, value, expires, }) => {
-    const secure = isBrowser() ? location.protocol === 'https:' : true;
-    const secureObj = secure ? SECURE_CONFIG : [[]];
-    // TODO: need to know if secure server side
-    const expiresObj = expires
-        ? [['expires', expires.toUTCString()]]
-        : [[]];
-    const cookieValue = [
-        [name, value],
-        ...expiresObj,
-        ['path', '/'],
-        ['domain', getTopLevelDomain(window.location.hostname)],
-        ...secureObj,
-    ];
-    const cookie = stringifyCookie(cookieValue);
-    return cookie;
-};
-/**
- * NOTE: This function is `async` because its react-native override is async. Do not remove the `async` keyword!
- */
-export const setCookie = async ({ name, value, expires, canTrack, }) => {
-    try {
-        if (!canTrack) {
-            return;
-        }
-        const cookie = createCookieString({ name, value, expires });
-        document.cookie = cookie;
-    }
-    catch (err) {
-        console.warn('[COOKIE] SET error: ', err);
-    }
-};

package/dist/server/helpers/flatten.d.ts

@@ -1,6 +0,0 @@
-/**
- * Convert deep object to a flat object with dots
- *
- * { foo: { bar: 'baz' }} -> { 'foo.bar': 'baz' }
- */
-export declare function flatten<T extends Record<string, any>>(object: T, path?: string | null, separator?: string): T;

package/dist/server/helpers/flatten.js

@@ -1,19 +0,0 @@
-/**
- * Convert deep object to a flat object with dots
- *
- * { foo: { bar: 'baz' }} -> { 'foo.bar': 'baz' }
- */
-export function flatten(object, path = null, separator = '.') {
-    return Object.keys(object).reduce((acc, key) => {
-        const value = object[key];
-        const newPath = [path, key].filter(Boolean).join(separator);
-        const isObject = [
-            typeof value === 'object',
-            value !== null,
-            !(Array.isArray(value) && value.length === 0),
-        ].every(Boolean);
-        return isObject
-            ? { ...acc, ...flatten(value, newPath, separator) }
-            : { ...acc, [newPath]: value };
-    }, {});
-}

package/dist/server/helpers/logger.d.ts

@@ -1,5 +0,0 @@
-export declare const logger: {
-    log: (...message: any[]) => void;
-    error: (...message: any[]) => void;
-    warn: (...message: any[]) => void;
-};

package/dist/server/helpers/logger.js

@@ -1,6 +0,0 @@
-const MSG_PREFIX = '[Builder.io]: ';
-export const logger = {
-    log: (...message) => console.log(MSG_PREFIX, ...message),
-    error: (...message) => console.error(MSG_PREFIX, ...message),
-    warn: (...message) => console.warn(MSG_PREFIX, ...message),
-};

package/dist/server/helpers/nullable.d.ts

@@ -1,2 +0,0 @@
-export type Nullable<T> = T | null | undefined;
-export declare const checkIsDefined: <T>(maybeT: T) => maybeT is T;

package/dist/server/helpers/nullable.js

@@ -1 +0,0 @@
-export const checkIsDefined = (maybeT) => maybeT !== null && maybeT !== undefined;

package/dist/server/helpers/url.d.ts

@@ -1,6 +0,0 @@
-/**
- * Only gets one level up from hostname
- * wwww.example.com -> example.com
- * www.example.co.uk -> example.co.uk
- */
-export declare const getTopLevelDomain: (host: string) => string;

package/dist/server/helpers/url.js

@@ -1,15 +0,0 @@
-/**
- * Only gets one level up from hostname
- * wwww.example.com -> example.com
- * www.example.co.uk -> example.co.uk
- */
-export const getTopLevelDomain = (host) => {
-    if (host === 'localhost' || host === '127.0.0.1') {
-        return host;
-    }
-    const parts = host.split('.');
-    if (parts.length > 2) {
-        return parts.slice(1).join('.');
-    }
-    return host;
-};

package/dist/server/types/api-version.d.ts

@@ -1,2 +0,0 @@
-export type ApiVersion = 'v2' | 'v3';
-export declare const DEFAULT_API_VERSION: ApiVersion;

package/dist/server/types/api-version.js

@@ -1 +0,0 @@
-export const DEFAULT_API_VERSION = 'v3';

package/dist/server/types/builder-block.d.ts

@@ -1,66 +0,0 @@
-type JSONValue = string | number | boolean | JSONObject | JSONArray;
-interface JSONObject {
-    [x: string]: JSONValue;
-}
-interface JSONArray extends Array<JSONValue> {
-}
-/** @todo typedoc this */
-export interface BuilderBlock {
-    '@type': '@builder.io/sdk:Element';
-    '@version'?: number;
-    id?: string;
-    tagName?: string;
-    layerName?: string;
-    groupLocked?: boolean;
-    layerLocked?: boolean;
-    /** @todo make alias for properties.class */
-    class?: string;
-    children?: BuilderBlock[];
-    responsiveStyles?: {
-        large?: Partial<CSSStyleDeclaration>;
-        medium?: Partial<CSSStyleDeclaration>;
-        small?: Partial<CSSStyleDeclaration>;
-        /** @deprecated */
-        xsmall?: Partial<CSSStyleDeclaration>;
-    };
-    component?: {
-        name: string;
-        options?: any;
-        tag?: string;
-    };
-    bindings?: {
-        [key: string]: string;
-    };
-    meta?: {
-        [key: string]: JSONValue;
-    };
-    actions?: {
-        [key: string]: string;
-    };
-    properties?: {
-        [key: string]: string;
-    };
-    code?: {
-        bindings?: {
-            [key: string]: string;
-        };
-        actions?: {
-            [key: string]: string;
-        };
-    };
-    repeat?: {
-        collection: string;
-        itemName?: string;
-    } | null;
-    animations?: any[];
-    style?: Partial<CSSStyleDeclaration>;
-    /**
-     * generated by the "Hide If" binding
-     */
-    hide?: boolean;
-    /**
-     * generated by the "Show If" binding
-     */
-    show?: boolean;
-}
-export {};