@builder.io/sdk-vue 0.0.3-1 → 0.0.3

package/packages/_vue2/dist/src/components/render-content/render-content.vue.d.ts

@@ -0,0 +1,368 @@
+import type { BuilderRenderContext, RegisteredComponent } from "../../context/types.js";
+import type { BuilderContent } from "../../types/builder-content.js";
+import type { Nullable } from "../../types/typescript.js";
+export declare type RenderContentProps = {
+    content?: Nullable<BuilderContent>;
+    model?: string;
+    data?: {
+        [key: string]: any;
+    };
+    context?: BuilderRenderContext;
+    apiKey: string;
+    customComponents?: RegisteredComponent[];
+    canTrack?: boolean;
+};
+import { markMutable } from "../../functions/mark-mutable.js";
+declare const _sfc_main: {
+    name: string;
+    components: {
+        RenderContentStyles: () => Promise<{
+            name: string;
+            components: {
+                RenderInlinedStyles: () => Promise<{
+                    name: string;
+                    props: string[];
+                    data: () => {
+                        TARGET: string;
+                    };
+                    computed: {
+                        injectedStyleScript(): any;
+                        tagName(): string;
+                    };
+                }>;
+            };
+            props: string[];
+            computed: {
+                injectedStyles(): any;
+            };
+            methods: {
+                getCssFromFont(font: any): string;
+                getFontCss({ customFonts }: {
+                    customFonts: any;
+                }): any;
+            };
+        }>;
+        RenderBlocks: () => Promise<{
+            name: string;
+            components: {
+                RenderBlock: () => Promise<{
+                    name: string;
+                    components: {
+                        RenderRepeatedBlock: () => Promise<{
+                            name: string;
+                            components: {
+                                RenderBlock: () => Promise<any>;
+                            };
+                            props: string[];
+                            provide(): {
+                                BuilderContext: {
+                                    readonly content: any;
+                                    readonly state: any;
+                                    readonly context: any;
+                                    readonly apiKey: any;
+                                    readonly registeredComponents: any;
+                                    readonly inheritedStyles: any;
+                                };
+                            };
+                        }>;
+                        BlockStyles: () => Promise<{
+                            name: string;
+                            components: {
+                                RenderInlinedStyles: () => Promise<{
+                                    name: string;
+                                    props: string[];
+                                    data: () => {
+                                        TARGET: string;
+                                    };
+                                    computed: {
+                                        injectedStyleScript(): any;
+                                        tagName(): string;
+                                    };
+                                }>;
+                            };
+                            props: string[];
+                            data: () => {
+                                TARGET: string;
+                            };
+                            computed: {
+                                useBlock(): any;
+                                css(): any;
+                            };
+                        }>;
+                        RenderComponentWithContext: () => Promise<{
+                            name: string;
+                            components: {
+                                RenderComponent: () => Promise<{
+                                    name: string;
+                                    components: {
+                                        RenderBlock: () => Promise<any>;
+                                        BlockStyles: () => Promise<{
+                                            name: string;
+                                            components: {
+                                                RenderInlinedStyles: () => Promise<{
+                                                    name: string;
+                                                    props: string[];
+                                                    data: () => {
+                                                        TARGET: string;
+                                                    };
+                                                    computed: {
+                                                        injectedStyleScript(): any;
+                                                        tagName(): string;
+                                                    };
+                                                }>;
+                                            };
+                                            props: string[];
+                                            data: () => {
+                                                TARGET: string;
+                                            };
+                                            computed: {
+                                                useBlock(): any;
+                                                css(): any;
+                                            };
+                                        }>;
+                                    };
+                                    props: string[];
+                                    data: () => {
+                                        markPropsMutable: typeof import("../../functions/mark-mutable.js").markPropsMutable;
+                                    };
+                                }>;
+                            };
+                            props: string[];
+                            provide(): {
+                                BuilderContext: {
+                                    readonly content: any;
+                                    readonly state: any;
+                                    readonly context: any;
+                                    readonly apiKey: any;
+                                    readonly registeredComponents: any;
+                                    readonly inheritedStyles: any;
+                                };
+                            };
+                        }>;
+                        RenderComponent: () => Promise<{
+                            name: string;
+                            components: {
+                                RenderBlock: () => Promise<any>;
+                                BlockStyles: () => Promise<{
+                                    name: string;
+                                    components: {
+                                        RenderInlinedStyles: () => Promise<{
+                                            name: string;
+                                            props: string[];
+                                            data: () => {
+                                                TARGET: string;
+                                            };
+                                            computed: {
+                                                injectedStyleScript(): any;
+                                                tagName(): string;
+                                            };
+                                        }>;
+                                    };
+                                    props: string[];
+                                    data: () => {
+                                        TARGET: string;
+                                    };
+                                    computed: {
+                                        useBlock(): any;
+                                        css(): any;
+                                    };
+                                }>;
+                            };
+                            props: string[];
+                            data: () => {
+                                markPropsMutable: typeof import("../../functions/mark-mutable.js").markPropsMutable;
+                            };
+                        }>;
+                    };
+                    props: string[];
+                    data: () => {
+                        isEmptyHtmlElement: (tagName: unknown) => boolean;
+                    };
+                    computed: {
+                        component(): any;
+                        tagName(): any;
+                        useBlock(): any;
+                        attributes(): any;
+                        shouldWrap(): any;
+                        renderComponentProps(): any;
+                        children(): any;
+                        childrenWithoutParentComponent(): any;
+                        repeatItemData(): any;
+                        inheritedTextStyles(): Partial<CSSStyleDeclaration>;
+                        childrenContext(): any;
+                        renderComponentTag(): (() => Promise<{
+                            name: string;
+                            components: {
+                                RenderComponent: () => Promise<{
+                                    name: string;
+                                    components: {
+                                        RenderBlock: () => Promise<any>;
+                                        BlockStyles: () => Promise<{
+                                            name: string;
+                                            components: {
+                                                RenderInlinedStyles: () => Promise<{
+                                                    name: string;
+                                                    props: string[];
+                                                    data: () => {
+                                                        TARGET: string;
+                                                    };
+                                                    computed: {
+                                                        injectedStyleScript(): any;
+                                                        tagName(): string;
+                                                    };
+                                                }>;
+                                            };
+                                            props: string[];
+                                            data: () => {
+                                                TARGET: string;
+                                            };
+                                            computed: {
+                                                useBlock(): any;
+                                                css(): any;
+                                            };
+                                        }>;
+                                    };
+                                    props: string[];
+                                    data: () => {
+                                        markPropsMutable: typeof import("../../functions/mark-mutable.js").markPropsMutable;
+                                    };
+                                }>;
+                            };
+                            props: string[];
+                            provide(): {
+                                BuilderContext: {
+                                    readonly content: any;
+                                    readonly state: any;
+                                    readonly context: any;
+                                    readonly apiKey: any;
+                                    readonly registeredComponents: any;
+                                    readonly inheritedStyles: any;
+                                };
+                            };
+                        }>) | (() => Promise<{
+                            name: string;
+                            components: {
+                                RenderBlock: () => Promise<any>;
+                                BlockStyles: () => Promise<{
+                                    name: string;
+                                    components: {
+                                        RenderInlinedStyles: () => Promise<{
+                                            name: string;
+                                            props: string[];
+                                            data: () => {
+                                                TARGET: string;
+                                            };
+                                            computed: {
+                                                injectedStyleScript(): any;
+                                                tagName(): string;
+                                            };
+                                        }>;
+                                    };
+                                    props: string[];
+                                    data: () => {
+                                        TARGET: string;
+                                    };
+                                    computed: {
+                                        useBlock(): any;
+                                        css(): any;
+                                    };
+                                }>;
+                            };
+                            props: string[];
+                            data: () => {
+                                markPropsMutable: typeof import("../../functions/mark-mutable.js").markPropsMutable;
+                            };
+                        }>) | "RenderComponent";
+                    };
+                }>;
+                BlockStyles: () => Promise<{
+                    name: string;
+                    components: {
+                        RenderInlinedStyles: () => Promise<{
+                            name: string;
+                            props: string[];
+                            data: () => {
+                                TARGET: string;
+                            };
+                            computed: {
+                                injectedStyleScript(): any;
+                                tagName(): string;
+                            };
+                        }>;
+                    };
+                    props: string[];
+                    data: () => {
+                        TARGET: string;
+                    };
+                    computed: {
+                        useBlock(): any;
+                        css(): any;
+                    };
+                }>;
+            };
+            props: string[];
+            inject: {
+                builderContext: string;
+            };
+            computed: {
+                className(): any;
+            };
+            methods: {
+                onClick(): void;
+                onMouseEnter(): void;
+                _classStringToObject(str: any): {};
+            };
+        }>;
+    };
+    props: string[];
+    data: () => {
+        forceReRenderCount: number;
+        overrideContent: null;
+        update: number;
+        overrideState: {};
+        markMutable: typeof markMutable;
+    };
+    provide(): {
+        BuilderContext: {
+            readonly content: any;
+            readonly state: any;
+            readonly context: any;
+            readonly apiKey: any;
+            readonly registeredComponents: any;
+        };
+    };
+    mounted(): void;
+    watch: {
+        onUpdateHook0(): void;
+        onUpdateHook1(): void;
+        onUpdateHook2(): void;
+    };
+    unmounted(): void;
+    computed: {
+        useContent(): any;
+        canTrackToUse(): any;
+        contentState(): any;
+        contextContext(): any;
+        allRegisteredComponents(): any;
+        httpReqsData(): {};
+        shouldRenderContentStyles(): any;
+        onUpdateHook0(): any;
+        onUpdateHook1(): any;
+        onUpdateHook2(): {
+            0: () => any;
+        };
+    };
+    methods: {
+        processMessage(event: any): void;
+        evaluateJsCode(): void;
+        onClick(_event: any): void;
+        evalExpression(expression: any): any;
+        handleRequest({ url, key }: {
+            url: any;
+            key: any;
+        }): void;
+        runHttpRequests(): void;
+        emitStateUpdate(): void;
+    };
+};
+export default _sfc_main;

package/packages/_vue2/dist/src/components/render-inlined-styles.vue.d.ts

@@ -0,0 +1,12 @@
+declare const _sfc_main: {
+    name: string;
+    props: string[];
+    data: () => {
+        TARGET: string;
+    };
+    computed: {
+        injectedStyleScript(): any;
+        tagName(): string;
+    };
+};
+export default _sfc_main;

package/packages/_vue2/dist/src/constants/builder-registered-components.d.ts

@@ -0,0 +1,6 @@
+import type { RegisteredComponent } from '../context/types.js';
+/**
+ * Returns a list of all registered components.
+ * NOTE: This needs to be a function to work around ESM circular dependencies.
+ */
+export declare const getDefaultRegisteredComponents: () => RegisteredComponent[];

package/packages/_vue2/dist/src/constants/device-sizes.d.ts

@@ -0,0 +1,2 @@
+export declare type SizeName = 'large' | 'medium' | 'small';
+export declare const getMaxWidthQueryForSize: (size: SizeName) => string;

package/packages/_vue2/dist/src/constants/target.d.ts

@@ -0,0 +1,2 @@
+/** This file should be overriden for each framework. Ideally this would be implemented in Mitosis.  */
+export declare const TARGET = "vue2";

package/packages/_vue2/dist/src/context/builder.context.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/packages/_vue2/dist/src/context/types.d.ts

@@ -0,0 +1,17 @@
+import type { BuilderContent } from '../types/builder-content.js';
+import type { ComponentInfo } from '../types/components.js';
+import type { Dictionary, Nullable } from '../types/typescript.js';
+export declare type RegisteredComponent = ComponentInfo & {
+    component: any;
+};
+export declare type RegisteredComponents = Dictionary<RegisteredComponent>;
+export declare type BuilderRenderState = Record<string, unknown>;
+export declare type BuilderRenderContext = Record<string, unknown>;
+export interface BuilderContextInterface {
+    content: Nullable<BuilderContent>;
+    context: BuilderRenderContext;
+    state: BuilderRenderState;
+    apiKey: string | null;
+    registeredComponents: RegisteredComponents;
+    inheritedStyles: Record<string, unknown>;
+}

package/packages/_vue2/dist/src/functions/camel-to-kebab-case.d.ts

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

package/packages/_vue2/dist/src/functions/evaluate.d.ts

@@ -0,0 +1,5 @@
+import type { BuilderContextInterface } from '../context/types.js';
+export declare function evaluate({ code, context, state, event, }: {
+    code: string;
+    event?: Event;
+} & Pick<BuilderContextInterface, 'state' | 'context'>): any;

package/packages/_vue2/dist/src/functions/event-handler-name.d.ts

@@ -0,0 +1 @@
+export declare const getEventHandlerName: (key: string) => string;

package/packages/_vue2/dist/src/functions/extract-text-styles.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Extract styles that apply to text from a style object.
+ */
+export declare const extractTextStyles: (styles: Partial<CSSStyleDeclaration>) => Partial<CSSStyleDeclaration>;

package/packages/_vue2/dist/src/functions/fast-clone.d.ts

@@ -0,0 +1,4 @@
+/**
+ * We need to serialize values to a string in case there are Proxy values, as is the case with SolidJS etc.
+ */
+export declare const fastClone: <T extends object>(obj: T) => T;

package/packages/_vue2/dist/src/functions/get-block-actions-handler.d.ts

@@ -0,0 +1,5 @@
+import type { BuilderContextInterface } from '../context/types.js';
+import type { BuilderBlock } from '../types/builder-block.js';
+export declare function crateEventHandler(value: string, options: {
+    block: BuilderBlock;
+} & Pick<BuilderContextInterface, 'state' | 'context'>): (event: Event) => any;

package/packages/_vue2/dist/src/functions/get-block-actions.d.ts

@@ -0,0 +1,9 @@
+import type { BuilderContextInterface } from '../context/types.js';
+import type { BuilderBlock } from '../types/builder-block.js';
+declare type Actions = {
+    [index: string]: (event: Event) => any;
+};
+export declare function getBlockActions(options: {
+    block: BuilderBlock;
+} & Pick<BuilderContextInterface, 'state' | 'context'>): Actions;
+export {};

package/packages/_vue2/dist/src/functions/get-block-component-options.d.ts

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

package/packages/_vue2/dist/src/functions/get-block-properties.d.ts

@@ -0,0 +1,5 @@
+import type { BuilderBlock } from '../types/builder-block.js';
+export declare function getBlockProperties(block: BuilderBlock): {
+    'builder-id': string | undefined;
+    class: {};
+};

package/packages/_vue2/dist/src/functions/get-block-tag.d.ts

@@ -0,0 +1,3 @@
+import type { BuilderBlock } from '../types/builder-block.js';
+export declare type TagName = string;
+export declare function getBlockTag(block: BuilderBlock): TagName;

package/packages/_vue2/dist/src/functions/get-builder-search-params/index.d.ts

@@ -0,0 +1,6 @@
+declare type QueryObject = Record<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/packages/_vue2/dist/src/functions/get-content/ab-testing.d.ts

@@ -0,0 +1,5 @@
+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/packages/_vue2/dist/src/functions/get-content/index.d.ts

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

package/packages/_vue2/dist/src/functions/get-content/types.d.ts

@@ -0,0 +1,31 @@
+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;
+}

package/packages/_vue2/dist/src/functions/get-fetch.d.ts

@@ -0,0 +1 @@
+export declare function getFetch(): Promise<typeof global.fetch>;

package/packages/_vue2/dist/src/functions/get-global-this.d.ts

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

package/packages/_vue2/dist/src/functions/get-processed-block.d.ts

@@ -0,0 +1,10 @@
+import type { BuilderContextInterface } from '../context/types.js';
+import type { BuilderBlock } from '../types/builder-block.js';
+export declare function getProcessedBlock({ block, context, shouldEvaluateBindings, state, }: {
+    block: BuilderBlock;
+    /**
+     * In some cases, we want to avoid evaluating bindings and only want framework-specific block transformation. It is
+     * also sometimes too early to consider bindings, e.g. when we might be looking at a repeated block.
+     */
+    shouldEvaluateBindings: boolean;
+} & Pick<BuilderContextInterface, 'state' | 'context'>): BuilderBlock;

package/packages/_vue2/dist/src/functions/get-react-native-block-styles.d.ts

@@ -0,0 +1,6 @@
+import type { BuilderContextInterface } from '../context/types.js';
+import type { BuilderBlock } from '../types/builder-block.js';
+export declare function getReactNativeBlockStyles({ block, context, }: {
+    block: BuilderBlock;
+    context: BuilderContextInterface;
+}): CSSStyleDeclaration | Record<string, string | undefined>;

package/packages/_vue2/dist/src/functions/is-browser.d.ts

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

package/packages/_vue2/dist/src/functions/is-editing.d.ts

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

package/packages/_vue2/dist/src/functions/is-iframe.d.ts

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

package/packages/_vue2/dist/src/functions/is-previewing.d.ts

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

package/packages/_vue2/dist/src/functions/mark-mutable.d.ts

@@ -0,0 +1,2 @@
+export declare function markMutable<T = any>(value: T): T;
+export declare function markPropsMutable<T = any>(props: T): T;

package/packages/_vue2/dist/src/functions/register-component.d.ts

@@ -0,0 +1,14 @@
+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: ({ component: _, ...info }: RegisteredComponent) => {
+    type: string;
+    data: ComponentInfo;
+};

package/packages/_vue2/dist/src/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/packages/_vue2/dist/src/functions/sanitize-react-native-block-styles.d.ts

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

package/packages/_vue2/dist/src/functions/set-editor-settings.d.ts

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

package/packages/_vue2/dist/src/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/packages/_vue2/dist/src/functions/track.d.ts

@@ -0,0 +1,21 @@
+import type { CanTrack } from '../types/can-track.js';
+interface Event {
+    type: 'click' | 'impression';
+    data: {
+        contentId?: string;
+        ownerId: string;
+        metadata?: string;
+        sessionId: string | undefined;
+        visitorId: string | undefined;
+        [index: string]: any;
+    };
+}
+declare type EventProperties = {
+    type: Event['type'];
+    orgId: Event['data']['ownerId'];
+    contentId: Event['data']['contentId'];
+    [index: string]: any;
+};
+export declare type EventProps = EventProperties & CanTrack;
+export declare function track(eventProps: EventProps): Promise<void | Response>;
+export {};