@builder.io/sdk-react 2.0.22 → 2.0.24-0

package/types/cjs/types/element.d.cts

@@ -0,0 +1,59 @@
+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/cjs/types/enforced-partials.d.cts

@@ -0,0 +1,26 @@
+import type { Prettify } from './typescript.js';
+/**
+ * Lol Typescript
+ * https://stackoverflow.com/questions/49927523/disallow-call-with-any/49928360#49928360
+ */
+type IfAny<T, Y, N> = 0 extends 1 & T ? Y : N;
+type OptionalFieldsOnly<T> = {
+    [K in keyof T as T[K] extends Required<T>[K] ? IfAny<T[K], K, never> : K]: T[K];
+};
+type RequiredFieldsOnly<T> = {
+    [K in keyof T as T[K] extends Required<T>[K] ? IfAny<T[K], never, 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 {};

package/types/cjs/types/input.d.cts

@@ -0,0 +1,122 @@
+export interface Input {
+    /** This is the name of the component prop this input represents */
+    name: string;
+    /** A friendlier name to show in the UI if the component prop name is not ideal for end users */
+    friendlyName?: string;
+    /** @hidden @deprecated */
+    description?: string;
+    /** A default value to use */
+    defaultValue?: any;
+    /**
+     * The type of input to use, such as 'text'
+     *
+     * See all available inputs [here](https://www.builder.io/c/docs/custom-react-components#input-types)
+     * and you can create your own custom input types and associated editor UIs with [plugins](https://www.builder.io/c/docs/extending/plugins)
+     */
+    type: string;
+    /** Is this input mandatory or not */
+    required?: boolean;
+    /** @hidden */
+    autoFocus?: boolean;
+    subFields?: Input[];
+    /**
+     * Additional text to render in the UI to give guidance on how to use this
+     *
+     * @example
+     * ```js
+     * helperText: 'Be sure to use a proper URL, starting with "https://"'
+     * 111
+     */
+    helperText?: string;
+    /** @hidden */
+    allowedFileTypes?: string[];
+    /** @hidden */
+    imageHeight?: number;
+    /** @hidden */
+    imageWidth?: number;
+    /** @hidden */
+    mediaHeight?: number;
+    /** @hidden */
+    mediaWidth?: number;
+    /** @hidden */
+    hideFromUI?: boolean;
+    /** @hidden */
+    modelId?: string;
+    /**
+     * Number field type validation maximum accepted input
+     */
+    max?: number;
+    /**
+     * Number field type validation minimum accepted input
+     */
+    min?: number;
+    /**
+     * Number field type step size when using arrows
+     */
+    step?: number;
+    /**
+     * Set this to `true` to show the editor for this input when
+     * children of this component are selected. This is useful for things
+     * like Tabs, such that users may not always select the Tabs component
+     * directly but will still be looking for how to add additional tabs
+     */
+    broadcast?: boolean;
+    /**
+     * Set this to `true` to show the editor for this input when
+     * group locked parents of this component are selected. This is useful
+     * to bubble up important inputs for locked groups, like text and images
+     */
+    bubble?: boolean;
+    /**
+     * Set this to `true` if you want this component to be translatable
+     */
+    localized?: boolean;
+    /** @hidden */
+    options?: {
+        [key: string]: any;
+    };
+    /**
+     * For "text" input type, specifying an enum will show a dropdown of options instead
+     */
+    enum?: string[] | {
+        label: string;
+        value: any;
+        helperText?: string;
+    }[];
+    /** Regex field validation for all string types (text, longText, html, url, etc) */
+    regex?: {
+        /** pattern to test, like "^\/[a-z]$" */
+        pattern: string;
+        /** flags for the RegExp constructor, e.g. "gi"  */
+        options?: string;
+        /**
+         * Friendly message to display to end-users if the regex fails, e.g.
+         * "You must use a relative url starting with '/...' "
+         */
+        message: string;
+    };
+    /**
+     * Set this to `true` to put this under the "show more" section of
+     * the options editor. Useful for things that are more advanced
+     * or more rarely used and don't need to be too prominent
+     */
+    advanced?: boolean;
+    /** @hidden */
+    /** @hidden */
+    code?: boolean;
+    /** @hidden */
+    richText?: boolean;
+    /** @hidden */
+    showIf?: ((options: Map<string, any>) => boolean) | string;
+    /** @hidden */
+    copyOnAdd?: boolean;
+    /**
+     * Use optionally with inputs of type `reference`. Restricts the content entry picker to a specific model by name.
+     */
+    model?: string;
+    valueType?: {
+        type?: string;
+    };
+    onChange?: ((options: Map<string, any>) => void | Promise<void>) | string;
+    meta?: Record<string, any>;
+}

package/types/cjs/types/targets.d.cts

@@ -0,0 +1 @@
+export type Target = 'vue' | 'reactNative' | 'svelte' | 'qwik' | 'react' | 'solid' | 'rsc' | 'angular';

package/types/cjs/types/typescript.d.cts

@@ -0,0 +1,8 @@
+export type Nullable<T> = T | null | undefined;
+export type Dictionary<T> = {
+    [key: string]: T;
+};
+export type Overwrite<T, U> = keyof U extends keyof T ? Pick<T, Exclude<keyof T, keyof U>> & U : never;
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/types/components/blocks/blocks-wrapper.d.ts

@@ -13,6 +13,7 @@ export type BlocksWrapperProps = {
      */
     BlocksWrapperProps: any;
     children?: any;
+    classNameProp?: string;
 };
 import type { BuilderBlock } from "../../types/builder-block";
 declare function BlocksWrapper(props: BlocksWrapperProps): React.JSX.Element;

package/types/components/blocks/blocks.types.d.ts

@@ -1,7 +1,8 @@
 import type { BuilderContextInterface, RegisteredComponents } from '../../context/types';
 import type { BlocksWrapperProps } from './blocks-wrapper';
-export type BlocksProps = Partial<Omit<BlocksWrapperProps, 'BlocksWrapper' | 'BlocksWrapperProps'>> & {
+export type BlocksProps = Partial<Omit<BlocksWrapperProps, 'BlocksWrapper' | 'BlocksWrapperProps' | 'classNameProp'>> & {
     context?: BuilderContextInterface;
     registeredComponents?: RegisteredComponents;
     linkComponent?: any;
+    className?: string;
 };

package/types/constants/sdk-version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.0.22";
+export declare const SDK_VERSION = "2.0.23";

package/types/esm/blocks/BaseText.d.mts

@@ -0,0 +1,6 @@
+import * as React from "react";
+export interface BaseTextProps {
+    text: string;
+}
+declare function BaseText(props: BaseTextProps): React.JSX.Element;
+export default BaseText;

package/types/esm/blocks/button/button.d.mts

@@ -0,0 +1,4 @@
+import * as React from "react";
+import type { ButtonProps } from "./button.types.js";
+declare function Button(props: ButtonProps): React.JSX.Element;
+export default Button;

package/types/esm/blocks/button/button.types.d.mts

@@ -0,0 +1,7 @@
+import type { BuilderLinkComponentProp } from '../../types/builder-props.js';
+export interface ButtonProps extends BuilderLinkComponentProp {
+    attributes?: any;
+    text?: string;
+    link?: string;
+    openLinkInNewTab?: boolean;
+}

package/types/esm/blocks/button/component-info.d.mts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components.js';
+export declare const componentInfo: ComponentInfo;

package/types/esm/blocks/button/index.d.mts

@@ -0,0 +1 @@
+export { default } from './button.js';

package/types/esm/blocks/columns/columns.d.mts

@@ -0,0 +1,4 @@
+import * as React from "react";
+import type { ColumnProps } from "./columns.types.js";
+declare function Columns(props: ColumnProps): React.JSX.Element;
+export default Columns;

package/types/esm/blocks/columns/columns.types.d.mts

@@ -0,0 +1,15 @@
+import type { BuilderBlock } from '../../types/builder-block.js';
+import type { BuilderComponentsProp, BuilderDataProps, BuilderLinkComponentProp } from '../../types/builder-props.js';
+export type Column = {
+    blocks: BuilderBlock[];
+    width?: number;
+    link?: string;
+};
+type StackColumnsAt = 'tablet' | 'mobile' | 'never';
+export interface ColumnProps extends BuilderComponentsProp, BuilderLinkComponentProp, BuilderDataProps {
+    columns?: Column[];
+    space?: number;
+    stackColumnsAt?: StackColumnsAt;
+    reverseColumnsWhenStacked?: boolean;
+}
+export {};

package/types/esm/blocks/columns/component-info.d.mts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components.js';
+export declare const componentInfo: ComponentInfo;

package/types/esm/blocks/columns/helpers.d.mts

@@ -0,0 +1 @@
+export declare const getColumnsClass: (id?: string) => string;

package/types/esm/blocks/columns/index.d.mts

@@ -0,0 +1 @@
+export { default } from './columns.js';

package/types/esm/blocks/custom-code/component-info.d.mts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components.js';
+export declare const componentInfo: ComponentInfo;

package/types/esm/blocks/custom-code/custom-code.d.mts

@@ -0,0 +1,7 @@
+import * as React from "react";
+export interface CustomCodeProps {
+    code: string;
+    replaceNodes?: boolean;
+}
+declare function CustomCode(props: CustomCodeProps): React.JSX.Element;
+export default CustomCode;

package/types/esm/blocks/custom-code/index.d.mts

@@ -0,0 +1 @@
+export { default } from './custom-code.js';

package/types/esm/blocks/embed/component-info.d.mts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components.js';
+export declare const componentInfo: ComponentInfo;

package/types/esm/blocks/embed/embed.d.mts

@@ -0,0 +1,6 @@
+import * as React from "react";
+export interface EmbedProps {
+    content: string;
+}
+declare function Embed(props: EmbedProps): React.JSX.Element;
+export default Embed;

package/types/esm/blocks/embed/helpers.d.mts

@@ -0,0 +1 @@
+export declare const isJsScript: (script: HTMLScriptElement) => boolean;

package/types/esm/blocks/embed/index.d.mts

@@ -0,0 +1 @@
+export { default } from './embed.js';

package/types/esm/blocks/form/form/component-info.d.mts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../../types/components.js';
+export declare const componentInfo: ComponentInfo;

package/types/esm/blocks/form/form/form.d.mts

@@ -0,0 +1,33 @@
+import * as React from "react";
+/**
+ * This import is used by the Svelte SDK. Do not remove.
+ */
+export type FormProps = BuilderDataProps & BuilderComponentsProp & BuilderLinkComponentProp & {
+    attributes?: any;
+    name?: string;
+    action?: string;
+    validate?: boolean;
+    method?: string;
+    sendSubmissionsTo?: string;
+    sendSubmissionsToEmail?: string;
+    sendWithJs?: boolean;
+    contentType?: string;
+    customHeaders?: {
+        [key: string]: string;
+    };
+    successUrl?: string;
+    previewState?: FormState;
+    successMessage?: BuilderBlock[];
+    errorMessage?: BuilderBlock[];
+    sendingMessage?: BuilderBlock[];
+    resetFormOnSubmit?: boolean;
+    errorMessagePath?: string;
+};
+/**
+ * This import is used by the Svelte SDK. Do not remove.
+ */
+export type FormState = "unsubmitted" | "sending" | "success" | "error";
+import type { BuilderBlock } from "../../../types/builder-block.js";
+import type { BuilderComponentsProp, BuilderDataProps, BuilderLinkComponentProp } from "../../../types/builder-props.js";
+declare function FormComponent(props: FormProps): React.JSX.Element;
+export default FormComponent;

package/types/esm/blocks/form/form/index.d.mts

@@ -0,0 +1 @@
+export { default } from './form.js';

package/types/esm/blocks/form/input/component-info.d.mts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../../types/components.js';
+export declare const componentInfo: ComponentInfo;

package/types/esm/blocks/form/input/index.d.mts

@@ -0,0 +1 @@
+export { default } from './input.js';

package/types/esm/blocks/form/input/input.d.mts

@@ -0,0 +1,15 @@
+import * as React from "react";
+/**
+ * This import is used by the Svelte SDK. Do not remove.
+ */
+export interface FormInputProps {
+    type?: string;
+    attributes?: any;
+    name?: string;
+    value?: string;
+    placeholder?: string;
+    defaultValue?: string;
+    required?: boolean;
+}
+declare function FormInputComponent(props: FormInputProps): React.JSX.Element;
+export default FormInputComponent;

package/types/esm/blocks/form/select/component-info.d.mts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../../types/components.js';
+export declare const componentInfo: ComponentInfo;

package/types/esm/blocks/form/select/index.d.mts

@@ -0,0 +1 @@
+export { default } from './select.js';

package/types/esm/blocks/form/select/select.d.mts

@@ -0,0 +1,16 @@
+import * as React from "react";
+/**
+ * This import is used by the Svelte SDK. Do not remove.
+ */
+export interface FormSelectProps {
+    options?: {
+        name?: string;
+        value: string;
+    }[];
+    attributes?: any;
+    name?: string;
+    value?: string;
+    defaultValue?: string;
+}
+declare function SelectComponent(props: FormSelectProps): React.JSX.Element;
+export default SelectComponent;

package/types/esm/blocks/form/submit-button/component-info.d.mts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../../types/components.js';
+export declare const componentInfo: ComponentInfo;

package/types/esm/blocks/form/submit-button/index.d.mts

@@ -0,0 +1 @@
+export { default } from './submit-button.js';

package/types/esm/blocks/form/submit-button/submit-button.d.mts

@@ -0,0 +1,10 @@
+import * as React from "react";
+/**
+ * This import is used by the Svelte SDK. Do not remove.
+ */
+export interface ButtonProps {
+    attributes?: any;
+    text?: string;
+}
+declare function SubmitButton(props: ButtonProps): React.JSX.Element;
+export default SubmitButton;

package/types/esm/blocks/fragment/component-info.d.mts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components.js';
+export declare const componentInfo: ComponentInfo;

package/types/esm/blocks/fragment/fragment.d.mts

@@ -0,0 +1,4 @@
+import * as React from "react";
+import type { FragmentProps } from "./fragment.types.js";
+declare function FragmentComponent(props: FragmentProps): React.JSX.Element;
+export default FragmentComponent;

package/types/esm/blocks/fragment/fragment.types.d.mts

@@ -0,0 +1,5 @@
+export interface FragmentProps {
+    maxWidth?: number;
+    attributes?: any;
+    children?: any;
+}

package/types/esm/blocks/fragment/index.d.mts

@@ -0,0 +1 @@
+export { default } from './fragment.js';

package/types/esm/blocks/helpers.d.mts

@@ -0,0 +1,13 @@
+export declare function filterAttrs(attrs: {
+    [index: string]: any;
+}, prefix: string, isEvent: boolean): {
+    [index: string]: any;
+};
+/**
+ * Svelte SDK: workaround to dynamically provide event handlers to components/elements.
+ * https://svelte.dev/repl/1246699e266f41218a8eeb45b9b58b54?version=3.24.1
+ */
+export declare function setAttrs(node: HTMLElement, attrs?: Record<string, (event: Event) => void>): {
+    update(attrs?: {}): void;
+    destroy(): void;
+};

package/types/esm/blocks/image/component-info.d.mts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components.js';
+export declare const componentInfo: ComponentInfo;

package/types/esm/blocks/image/image.d.mts

@@ -0,0 +1,4 @@
+import * as React from "react";
+import type { ImageProps } from "./image.types.js";
+declare function Image(props: ImageProps): React.JSX.Element;
+export default Image;

package/types/esm/blocks/image/image.helpers.d.mts

@@ -0,0 +1 @@
+export declare function getSrcSet(url: string): string;

package/types/esm/blocks/image/image.types.d.mts

@@ -0,0 +1,19 @@
+import type { BuilderBlock } from '../../types/builder-block.js';
+export interface ImageProps {
+    className?: string;
+    image: string;
+    sizes?: string;
+    lazy?: boolean;
+    height?: number;
+    width?: number;
+    altText?: string;
+    backgroundSize?: 'cover' | 'contain';
+    backgroundPosition?: string;
+    srcset?: string;
+    aspectRatio?: number;
+    children?: any;
+    fitContent?: boolean;
+    builderBlock?: BuilderBlock;
+    noWebp?: boolean;
+    src?: string;
+}

package/types/esm/blocks/image/index.d.mts

@@ -0,0 +1 @@
+export { default } from './image.js';

package/types/esm/blocks/img/component-info.d.mts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components.js';
+export declare const componentInfo: ComponentInfo;

package/types/esm/blocks/img/img.d.mts

@@ -0,0 +1,14 @@
+import * as React from "react";
+/**
+ * This import is used by the Svelte SDK. Do not remove.
+ */
+export interface ImgProps {
+    attributes?: any;
+    imgSrc?: string;
+    image?: string;
+    altText?: string;
+    backgroundSize?: "cover" | "contain";
+    backgroundPosition?: "center" | "top" | "left" | "right" | "bottom" | "top left" | "top right" | "bottom left" | "bottom right";
+}
+declare function ImgComponent(props: ImgProps): React.JSX.Element;
+export default ImgComponent;

package/types/esm/blocks/img/index.d.mts

@@ -0,0 +1 @@
+export { default } from './img.js';

package/types/esm/blocks/raw-text/component-info.d.mts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components.js';
+export declare const componentInfo: ComponentInfo;

package/types/esm/blocks/raw-text/index.d.mts

@@ -0,0 +1 @@
+export { default } from './raw-text.js';

package/types/esm/blocks/raw-text/raw-text.d.mts

@@ -0,0 +1,7 @@
+import * as React from "react";
+export interface RawTextProps {
+    attributes?: any;
+    text?: string;
+}
+declare function RawText(props: RawTextProps): React.JSX.Element;
+export default RawText;

package/types/esm/blocks/section/component-info.d.mts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components.js';
+export declare const componentInfo: ComponentInfo;

package/types/esm/blocks/section/index.d.mts

@@ -0,0 +1 @@
+export { default } from './section.js';

package/types/esm/blocks/section/section.d.mts

@@ -0,0 +1,4 @@
+import * as React from "react";
+import type { SectionProps } from "./section.types.js";
+declare function SectionComponent(props: SectionProps): React.JSX.Element;
+export default SectionComponent;

package/types/esm/blocks/section/section.types.d.mts

@@ -0,0 +1,6 @@
+export interface SectionProps {
+    maxWidth?: number;
+    attributes?: any;
+    children?: any;
+    builderBlock?: any;
+}

package/types/esm/blocks/slot/component-info.d.mts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components.js';
+export declare const componentInfo: ComponentInfo;

package/types/esm/blocks/slot/index.d.mts

@@ -0,0 +1 @@
+export { default } from './slot.js';

package/types/esm/blocks/slot/slot.d.mts

@@ -0,0 +1,8 @@
+import * as React from "react";
+export type DropzoneProps = BuilderDataProps & {
+    name: string;
+    attributes: any;
+};
+import type { BuilderDataProps } from "../../types/builder-props.js";
+declare function Slot(props: DropzoneProps): React.JSX.Element;
+export default Slot;

package/types/esm/blocks/symbol/component-info.d.mts

@@ -0,0 +1,2 @@
+import type { ComponentInfo } from '../../types/components.js';
+export declare const componentInfo: ComponentInfo;

package/types/esm/blocks/symbol/index.d.mts

@@ -0,0 +1 @@
+export { default } from './symbol.js';

package/types/esm/blocks/symbol/symbol.d.mts

@@ -0,0 +1,4 @@
+import * as React from "react";
+import type { SymbolProps } from "./symbol.types.js";
+declare function Symbol(props: SymbolProps): React.JSX.Element;
+export default Symbol;

package/types/esm/blocks/symbol/symbol.helpers.d.mts

@@ -0,0 +1,14 @@
+import type { BuilderContextInterface } from '../../context/types.js';
+import type { BuilderContent } from '../../types/builder-content.js';
+export interface SymbolInfo {
+    model?: string;
+    entry?: string;
+    data?: any;
+    content?: BuilderContent;
+    inline?: boolean;
+    dynamic?: boolean;
+}
+export declare const fetchSymbolContent: ({ builderContextValue, symbol }: {
+    symbol: SymbolInfo | undefined;
+    builderContextValue: BuilderContextInterface;
+}) => Promise<any>;