@builder.io/sdk-react 2.0.23 → 2.0.24-1

package/types/cjs/functions/register.d.cts

@@ -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/types/cjs/functions/set-editor-settings.d.cts

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

package/types/cjs/functions/set.d.cts

@@ -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/types/cjs/functions/track/helpers.d.cts

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

package/types/cjs/functions/track/index.d.cts

@@ -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/types/cjs/functions/track/interaction.d.cts

@@ -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/types/cjs/functions/transform-block-properties.d.cts

@@ -0,0 +1,7 @@
+import type { BuilderContextInterface } from '../context/types.js';
+import type { BuilderBlock } from '../types/builder-block.js';
+export declare function transformBlockProperties<T>({ properties }: {
+    properties: T;
+    context: BuilderContextInterface;
+    block: BuilderBlock;
+}): T;

package/types/cjs/functions/transform-block.d.cts

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

package/types/cjs/functions/transform-style-property.d.cts

@@ -0,0 +1,7 @@
+import type { BuilderContextInterface } from '../context/types.js';
+import type { BuilderBlock } from '../types/builder-block.js';
+export declare function transformStyleProperty({ style }: {
+    style: Partial<CSSStyleDeclaration>;
+    context: BuilderContextInterface;
+    block: BuilderBlock;
+}): Partial<CSSStyleDeclaration>;

package/types/cjs/helpers/ab-tests.d.cts

@@ -0,0 +1,9 @@
+import type { BuilderContent } from '../types/builder-content.js';
+import type { CanTrack } from '../types/can-track.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/types/cjs/helpers/canTrack.d.cts

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

package/types/cjs/helpers/cookie.d.cts

@@ -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 {};

package/types/cjs/helpers/css.d.cts

@@ -0,0 +1,7 @@
+export declare const convertStyleMapToCSSArray: (style: Partial<CSSStyleDeclaration>) => string[];
+export declare const convertStyleMapToCSS: (style: Partial<CSSStyleDeclaration>) => string;
+export declare const createCssClass: ({ mediaQuery, className, styles }: {
+    mediaQuery?: string;
+    className: string;
+    styles: Partial<CSSStyleDeclaration>;
+}) => string;

package/types/cjs/helpers/flatten.d.cts

@@ -0,0 +1,16 @@
+/**
+ * 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;
+/**
+ * Flatten a nested MongoDB query object into a flat object with dot-separated keys.
+ * $ keys are not flattened and are left as is.
+ *
+ * { foo: { bar: { $gt: 5 }}} -> { 'foo.bar': { '$gt': 5 }}
+ * { foo: {'bar.id': { $elemMatch: { 'baz.id': { $in: ['abc', 'bcd'] }}}}} -> { 'foo.bar.id': { '$elemMatch': { 'baz.id': { '$in': ['abc', 'bcd'] }}}}
+ */
+export declare function flattenMongoQuery(obj: any, _current?: any, _res?: any): {
+    [key: string]: string;
+};

package/types/cjs/helpers/localStorage.d.cts

@@ -0,0 +1,9 @@
+import type { CanTrack } from '../types/can-track.js';
+import type { Nullable } from './nullable.js';
+export declare const getLocalStorageItem: ({ key, canTrack }: {
+    key: string;
+} & CanTrack) => Nullable<string>;
+export declare const setLocalStorageItem: ({ key, canTrack, value }: {
+    key: string;
+    value: string;
+} & CanTrack) => void;

package/types/cjs/helpers/logger.d.cts

@@ -0,0 +1,7 @@
+export declare const MSG_PREFIX = "[Builder.io]: ";
+export declare const logger: {
+    log: (...message: any[]) => void;
+    error: (...message: any[]) => void;
+    warn: (...message: any[]) => void;
+    debug: (...message: any[]) => void;
+};

package/types/cjs/helpers/nullable.d.cts

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

package/types/cjs/helpers/omit.d.cts

@@ -0,0 +1 @@
+export declare function omit<T extends object>(obj: T, ...values: (keyof T)[]): Partial<T>;

package/types/cjs/helpers/preview-lru-cache/get.d.cts

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

package/types/cjs/helpers/preview-lru-cache/helpers.d.cts

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

package/types/cjs/helpers/preview-lru-cache/init.d.cts

@@ -0,0 +1,6 @@
+/**
+ * This is an LRU cache to hold preview content on the server-side.
+ *
+ * Note: This logic is only used by the NextJS SDK.
+ */
+export declare function init(): void;

package/types/cjs/helpers/preview-lru-cache/set.d.cts

@@ -0,0 +1,7 @@
+import type { BuilderContent } from '../../types/builder-content.js';
+export declare function postPreviewContent({ key, value }: {
+    key: string;
+    value: BuilderContent;
+}): Promise<{
+    [x: string]: BuilderContent;
+}>;

package/types/cjs/helpers/preview-lru-cache/types.d.cts

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

package/types/cjs/helpers/search/search.d.cts

@@ -0,0 +1,5 @@
+export type QueryObject = Record<string, string | string[]>;
+export declare const convertSearchParamsToQueryObject: (searchParams: URLSearchParams) => QueryObject;
+export declare const normalizeSearchParams: (searchParams: QueryObject | URLSearchParams) => QueryObject;
+export type Search = URLSearchParams | string | QueryObject;
+export declare const getSearchString: (search: Search) => string;

package/types/cjs/helpers/sessionId.d.cts

@@ -0,0 +1,6 @@
+import type { CanTrack } from '../types/can-track.js';
+export declare const getSessionId: ({ canTrack }: CanTrack) => Promise<string | undefined>;
+export declare const createSessionId: () => string;
+export declare const setSessionId: ({ id, canTrack }: {
+    id: string;
+} & CanTrack) => Promise<void>;

package/types/cjs/helpers/subscribe-to-editor.d.cts

@@ -0,0 +1,35 @@
+import type { ContentProps } from '../components/content/content.types.js';
+import type { BuilderAnimation } from '../types/builder-block.js';
+import type { BuilderContent } from '../types/builder-content.js';
+type ContentListener = Required<Pick<ContentProps, 'model' | 'trustedHosts'>> & {
+    callbacks: {
+        contentUpdate: (updatedContent: BuilderContent) => void;
+        animation: (updatedContent: BuilderAnimation) => void;
+        configureSdk: (updatedContent: any) => void;
+    };
+};
+export declare const createEditorListener: ({ model, trustedHosts, callbacks }: ContentListener) => (event: MessageEvent<any>) => void;
+type SubscribeToEditor = (
+/**
+ * The Builder `model` to subscribe to
+ */
+model: string, 
+/**
+ * The callback function to call when the content is updated.
+ */
+callback: (updatedContent: BuilderContent) => void, 
+/**
+ * Extra options for the listener.
+ */
+options?: {
+    /**
+     * List of hosts to allow editing content from.
+     */
+    trustedHosts?: string[] | undefined;
+}) => () => void;
+/**
+ * Subscribes to the Builder editor and listens to `content` updates of a certain `model`.
+ * Sends the updated `content` to the `callback` function.
+ */
+export declare const subscribeToEditor: SubscribeToEditor;
+export {};

package/types/cjs/helpers/time.d.cts

@@ -0,0 +1 @@
+export declare const getCurrentDatePlusMinutes: (minutes?: number) => Date;

package/types/cjs/helpers/url.d.cts

@@ -0,0 +1,6 @@
+/**
+ * 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/types/cjs/helpers/uuid.d.cts

@@ -0,0 +1,8 @@
+/**
+ * @credit https://stackoverflow.com/a/2117523
+ */
+export declare function uuidv4(): string;
+/**
+ * Slightly cleaner and smaller UUIDs
+ */
+export declare function uuid(): string;

package/types/cjs/helpers/visitorId.d.cts

@@ -0,0 +1,6 @@
+import type { CanTrack } from '../types/can-track.js';
+export declare const getVisitorId: ({ canTrack }: CanTrack) => string | undefined;
+export declare const createVisitorId: () => string;
+export declare const setVisitorId: ({ id, canTrack }: {
+    id: string;
+} & CanTrack) => void;

package/types/cjs/index-helpers/blocks-exports.d.cts

@@ -0,0 +1,14 @@
+export { default as Button } from '../blocks/button/index.js';
+export { default as Columns } from '../blocks/columns/index.js';
+export { default as Fragment } from '../blocks/fragment/index.js';
+export { default as Image } from '../blocks/image/index.js';
+export { default as Section } from '../blocks/section/index.js';
+export { default as Symbol } from '../blocks/symbol/index.js';
+export { default as Text } from '../blocks/text/index.js';
+export { default as Video } from '../blocks/video/index.js';
+export { default as Blocks } from '../components/blocks/index.js';
+export { default as Content } from '../components/content-variants/index.js';
+/**
+ * Builder Context
+ */
+export { BuilderContext } from '../context/index.js';

package/types/cjs/index-helpers/top-of-file.d.cts

@@ -0,0 +1 @@
+export default undefined;

package/types/cjs/index.d.cts

@@ -0,0 +1,10 @@
+export * from './index-helpers/top-of-file.js';
+/**
+ * In the React SDK, this file is marked with `use client`.
+ */
+export * from './index-helpers/blocks-exports.js';
+/**
+ * In the React SDK, this file is not marked with `use client`, to allow
+ * NextJS App Directory to use the SDK helper functions without issues.
+ */
+export * from './server-index.js';

package/types/cjs/scripts/init-editing.d.cts

@@ -0,0 +1,7 @@
+export declare const registerInsertMenu: () => void;
+export declare const setupBrowserForEditing: (options?: {
+    enrich?: boolean;
+    includeRefs?: boolean;
+    locale?: string;
+    trustedHosts?: string[];
+}) => void;

package/types/cjs/server-index.d.cts

@@ -0,0 +1,39 @@
+export * from './index-helpers/top-of-file.js';
+/**
+ * Component Prop types
+ */
+export type { ButtonProps } from './blocks/button/button.types.js';
+export type { ColumnProps } from './blocks/columns/columns.types.js';
+export type { FragmentProps } from './blocks/fragment/fragment.types.js';
+export type { ImageProps } from './blocks/image/image.types.js';
+export type { SectionProps } from './blocks/section/section.types.js';
+export type { SymbolProps } from './blocks/symbol/symbol.types.js';
+export type { TextProps } from './blocks/text/text.types.js';
+export type { VideoProps } from './blocks/video/video.types.js';
+export type { BlocksProps } from './components/blocks/blocks.types.js';
+export type { ContentVariantsPrps as ContentProps } from './components/content-variants/content-variants.types.js';
+/**
+ * General Builder types
+ */
+export type { RegisteredComponent } from './context/types.js';
+export type { BuilderBlock } from './types/builder-block.js';
+export type { BuilderContent } from './types/builder-content.js';
+export type { ComponentInfo } from './types/components.js';
+/**
+ * Helper functions
+ */
+export { isEditing } from './functions/is-editing.js';
+export { isPreviewing } from './functions/is-previewing.js';
+export { createRegisterComponentMessage } from './functions/register-component.js';
+export { register } from './functions/register.js';
+export type { InsertMenuConfig, InsertMenuItem } from './functions/register.js';
+export { setEditorSettings } from './functions/set-editor-settings.js';
+export type { Settings } from './functions/set-editor-settings.js';
+export { getBuilderSearchParams } from './functions/get-builder-search-params/index.js';
+export { track } from './functions/track/index.js';
+export { subscribeToEditor } from './helpers/subscribe-to-editor.js';
+/**
+ * Content fetching
+ */
+export { fetchBuilderProps } from './functions/fetch-builder-props.js';
+export { _processContentResult, fetchEntries, fetchOneEntry } from './functions/get-content/index.js';

package/types/cjs/types/api-version.d.cts

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

package/types/cjs/types/builder-block.d.cts

@@ -0,0 +1,84 @@
+type JSONValue = string | number | boolean | JSONObject | JSONArray;
+interface JSONObject {
+    [x: string]: JSONValue;
+}
+interface JSONArray extends Array<JSONValue> {
+}
+export interface AnimationStep {
+    styles: {
+        [key: string]: string;
+    };
+    delay?: number;
+}
+export interface BuilderAnimation {
+    elementId: string;
+    trigger: string;
+    steps: AnimationStep[];
+    duration: number;
+    delay?: number;
+    easing?: string;
+    id?: string;
+    repeat?: boolean;
+    thresholdPercent?: number;
+}
+/** @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?: BuilderAnimation[];
+    style?: Partial<CSSStyleDeclaration>;
+    href?: string;
+    /**
+     * generated by the "Hide If" binding
+     */
+    hide?: boolean;
+    /**
+     * generated by the "Show If" binding
+     */
+    show?: boolean;
+}
+export {};

package/types/cjs/types/builder-content.d.cts

@@ -0,0 +1,44 @@
+import type { BuilderBlock } from './builder-block.js';
+import type { Input } from './input.js';
+import type { Nullable } from './typescript.js';
+export interface Breakpoints {
+    small: number;
+    medium: number;
+}
+export interface BuilderContentVariation {
+    data?: {
+        title?: string;
+        blocks?: BuilderBlock[];
+        inputs?: Input[];
+        state?: {
+            [key: string]: any;
+        };
+        jsCode?: string;
+        tsCode?: string;
+        httpRequests?: {
+            [key: string]: string;
+        };
+        [key: string]: any;
+    };
+    name?: string;
+    testRatio?: number;
+    id?: string;
+    meta?: {
+        breakpoints?: Nullable<Breakpoints>;
+        [key: string]: any;
+    };
+}
+export interface BuilderContent extends BuilderContentVariation {
+    '@version'?: number;
+    published?: 'published' | 'draft' | 'archived';
+    modelId?: string;
+    priority?: number;
+    lastUpdated?: number;
+    startDate?: number;
+    endDate?: number;
+    variations?: {
+        [id: string]: BuilderContentVariation;
+    };
+    testVariationId?: string;
+    testVariationName?: string;
+}

package/types/cjs/types/builder-props.d.cts

@@ -0,0 +1,12 @@
+import type { BuilderContextInterface, RegisteredComponents } from '../context/types.js';
+import type { BuilderBlock } from './builder-block.js';
+export type BuilderDataProps = {
+    builderBlock: BuilderBlock;
+    builderContext: BuilderContextInterface;
+};
+export type BuilderComponentsProp = {
+    builderComponents: RegisteredComponents;
+};
+export type BuilderLinkComponentProp = {
+    builderLinkComponent?: any;
+};

package/types/cjs/types/can-track.d.cts

@@ -0,0 +1,3 @@
+export type CanTrack = {
+    canTrack: boolean;
+};