@builder.io/sdk-react-nextjs 0.7.1-2 → 0.7.1-4

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

@@ -1,51 +0,0 @@
-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/functions/track/interaction.d.ts

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

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

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

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

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

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

@@ -1,9 +0,0 @@
-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/types/helpers/canTrack.d.ts

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

package/types/helpers/cookie.d.ts

@@ -1,19 +0,0 @@
-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/helpers/css.d.ts

@@ -1,7 +0,0 @@
-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/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/types/helpers/localStorage.d.ts

@@ -1,9 +0,0 @@
-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/helpers/logger.d.ts

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

package/types/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/types/helpers/preview-lru-cache/get.d.ts

@@ -1 +0,0 @@
-export declare function getPreviewContent(searchParams: URLSearchParams): import("../../types/builder-content").BuilderContent;

package/types/helpers/preview-lru-cache/helpers.d.ts

@@ -1 +0,0 @@
-export declare const getIdFromSearchParams: (searchParams: URLSearchParams) => string;

package/types/helpers/preview-lru-cache/init.d.ts

@@ -1,6 +0,0 @@
-/**
- * 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/helpers/preview-lru-cache/set.d.ts

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

package/types/helpers/preview-lru-cache/types.d.ts

@@ -1,12 +0,0 @@
-/**
- * This is an LRU cache to hold preview content on the server-side.
- *
- * Note: This logic is only used by the NextJS SDK.
- */
-import type { LRUCache } from 'lru-cache';
-import type { BuilderContent } from '../../types/builder-content';
-type BuilderLRUCache = LRUCache<string, BuilderContent>;
-export type GlobalWCache = typeof globalThis & {
-    _BUILDER_PREVIEW_LRU_CACHE: BuilderLRUCache;
-};
-export {};

package/types/helpers/sessionId.d.ts

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

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

package/types/helpers/visitorId.d.ts

@@ -1,6 +0,0 @@
-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/index-helpers/blocks-exports.d.ts

@@ -1,19 +0,0 @@
-export { default as Button } from '../blocks/button/button';
-export { default as Columns } from '../blocks/columns/columns';
-export { default as Fragment } from '../blocks/fragment/fragment';
-export { default as Image } from '../blocks/image/image';
-export { default as Section } from '../blocks/section/section';
-export { default as Symbol } from '../blocks/symbol/symbol';
-export { default as Text } from '../blocks/text/text';
-export { default as Video } from '../blocks/video/video';
-import { default as Blocks } from '../components/blocks/blocks';
-import { default as Content } from '../components/content-variants/content-variants';
-export { Blocks, Content };
-/**
- * @deprecated Renamed to `Blocks`.
- */
-export declare const RenderBlocks: typeof Blocks;
-/**
- * @deprecated Renamed to `Content`.
- */
-export declare const RenderContent: typeof Content;

package/types/index-helpers/top-of-file.d.ts

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

package/types/index.d.ts

@@ -1,7 +0,0 @@
-export * from './index-helpers/top-of-file.js';
-export * from './index-helpers/blocks-exports.js';
-/**
- * We have a separate entry point to the SDKs that guarantees no components are being imported. This is useful
- * for React SDK, which would break in the NextJS App directory because the component imports have `use client` in them.
- */
-export * from './server-index.js';

package/types/scripts/init-editing.d.ts

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

package/types/server-index.d.ts

@@ -1,15 +0,0 @@
-export * from './index-helpers/top-of-file.js';
-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 { fetchEntries, fetchOneEntry, getAllContent, getContent, _processContentResult } from './functions/get-content/index.js';
-export { getBuilderSearchParams } from './functions/get-builder-search-params/index.js';
-export { track } from './functions/track/index.js';
-export type { RegisteredComponent } from './context/types.js';
-export type { ComponentInfo } from './types/components.js';
-export type { ContentProps } from './components/content/content.types.js';
-export { fetchBuilderProps } from './functions/fetch-builder-props.js';

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

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

package/types/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 {};

package/types/types/builder-content.d.ts

@@ -1,44 +0,0 @@
-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/types/builder-props.d.ts

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

package/types/types/can-track.d.ts

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

package/types/types/components.d.ts

@@ -1,110 +0,0 @@
-import type { BuilderElement } from './element.js';
-import type { Input } from './input.js';
-export interface ComponentInfo {
-    /**
-     * Name your component something unique, e.g. 'MyButton'. You can override built-in components
-     * by registering a component with the same name, e.g. 'Text', to replace the built-in text component
-     */
-    name: string;
-    description?: string;
-    /**
-     * Link to a documentation page for this component
-     */
-    docsLink?: string;
-    image?: string;
-    /**
-     * Input schema for your component for users to fill in the options
-     */
-    inputs?: Input[];
-    class?: any;
-    type?: 'angular' | 'webcomponent' | 'react' | 'vue';
-    defaultStyles?: {
-        [key: string]: string;
-    };
-    /**
-     * Turn on if your component can accept children. Be sure to use in combination with
-     * withChildren(YourComponent) like here
-     * github.com/BuilderIO/builder/blob/master/examples/react-design-system/src/components/HeroWithChildren/HeroWithChildren.builder.js#L5
-     */
-    canHaveChildren?: boolean;
-    fragment?: boolean;
-    /**
-     * Do not wrap a component in a dom element. Be sure to use {...props.attributes} with this option
-     * like here github.com/BuilderIO/builder/blob/master/packages/react/src/blocks/forms/Input.tsx#L34
-     */
-    noWrap?: boolean;
-    /**
-     * TO-DO: make this optional only for RSC SDK.
-     *
-     * Set this to `true` if your component is a React Server Component (RSC).
-     */
-    isRSC?: boolean;
-    /**
-     * Default children
-     */
-    defaultChildren?: BuilderElement[];
-    defaults?: Partial<BuilderElement>;
-    hooks?: {
-        [key: string]: string | Function;
-    };
-    /**
-     * Hide your component in editor, useful for gradually deprecating components
-     */
-    hideFromInsertMenu?: boolean;
-    tag?: string;
-    static?: boolean;
-    /**
-     * Passing a list of model names will restrict using the component to only the models listed here, otherwise it'll be available for all models
-     */
-    models?: string[];
-    /**
-     * Specify restrictions direct children must match
-     */
-    childRequirements?: {
-        /** Message to show when this doesn't match, e.g. "Children of 'Columns' must be a 'Column'" */
-        message: string;
-        /** Simple way to say children must be a specific component name */
-        component?: string;
-        /**
-         * More advanced - specify a MongoDB-style query (using sift.js github.com/crcn/sift.js)
-         * of what the children objects should match, e.g.
-         *
-         * @example
-         *  query: {
-         *    // Child of this element must be a 'Button' or 'Text' component
-         *    'component.name': { $in: ['Button', 'Text'] }
-         *  }
-         */
-        query?: any;
-    };
-    /**
-     * Specify restrictions any parent must match
-     */
-    requiresParent?: {
-        /** Message to show when this doesn't match, e.g. "'Add to cart' buttons must be within a 'Product box'" */
-        message: string;
-        /** Simple way to say a parent must be a specific component name, e.g. 'Product box' */
-        component?: string;
-        /**
-         * More advanced - specify a MongoDB-style query (using sift.js github.com/crcn/sift.js)
-         * of what at least one parent in the parents hierarchy should match, e.g.
-         *
-         * @example
-         *  query: {
-         *    // Thils element must be somewhere inside either a 'Product box' or 'Collection' component
-         *    'component.name': { $in: ['Product Box', 'Collection'] }
-         *  }
-         */
-        query?: any;
-    };
-    friendlyName?: string;
-    /**
-     * Use to restrict access to your component based on a the current user permissions
-     * By default components will show to all users
-     * for more information on permissions in builder check https://www.builder.io/c/docs/guides/roles-and-permissions
-     */
-    requiredPermissions?: Array<Permission>;
-    hidden?: boolean;
-}
-type Permission = 'read' | 'publish' | 'editCode' | 'editDesigns' | 'admin' | 'create';
-export {};

package/types/types/deep-partial.d.ts

@@ -1,3 +0,0 @@
-export type DeepPartial<T> = {
-    [P in keyof T]?: T[P] extends Array<infer U> ? Array<DeepPartial<U>> : T[P] extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : DeepPartial<T[P]>;
-};

package/types/types/element.d.ts

@@ -1,59 +0,0 @@
-type JSONValue = string | number | boolean | JSONObject | JSONArray;
-interface JSONObject {
-    [x: string]: JSONValue;
-}
-interface JSONArray extends Array<JSONValue> {
-}
-/** @todo typedoc this */
-export interface BuilderElement {
-    '@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?: BuilderElement[];
-    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?: Animation[];
-}
-interface Animation {
-}
-export {};

package/types/types/enforced-partials.d.ts

@@ -1,21 +0,0 @@
-import type { Prettify } from './typescript.js';
-type OptionalFieldsOnly<T> = {
-    [K in keyof T as T[K] extends Required<T>[K] ? never : K]: T[K];
-};
-type RequiredFieldsOnly<T> = {
-    [K in keyof T as T[K] extends Required<T>[K] ? K : never]: T[K];
-};
-type Enforced<T> = {
-    [K in keyof T]-?: T[K];
-};
-type AndUndefined<T> = {
-    [K in keyof T]: T[K] | undefined;
-};
-/**
- * Enforce that all optional fields are undefined
- * @example
- * type Foo = { a: string, b?: number }
- * type Bar = EnforcePartials<Foo> // { a: string, b: number | undefined }
- */
-export type EnforcePartials<From> = Prettify<AndUndefined<Enforced<OptionalFieldsOnly<From>>> & RequiredFieldsOnly<From>>;
-export {};