@builder.io/sdk-qwik 0.4.3 → 0.4.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@builder.io/sdk-qwik",
-  "version": "0.4.3",
+  "version": "0.4.5",
   "description": "Builder.io Qwik SDK",
   "type": "module",
   "main": "./lib/index.qwik.cjs",

package/types/blocks/text/text.d.ts

@@ -1,5 +1,5 @@
 export interface TextProps {
-    text: string;
+    text?: string;
 }
 export declare const Text: import("@builder.io/qwik").Component<TextProps>;
 export default Text;

package/types/components/block/block.d.ts

@@ -0,0 +1,10 @@
+import { BuilderContextInterface, RegisteredComponent } from "../../context/types.js";
+import { BuilderBlock } from "../../types/builder-block.js";
+import { Dictionary } from "../../types/typescript.js";
+export type BlockProps = {
+    block: BuilderBlock;
+    context: BuilderContextInterface;
+    components: Dictionary<RegisteredComponent>;
+};
+export declare const Block: import("@builder.io/qwik").Component<BlockProps>;
+export default Block;

package/types/components/block/block.helpers.d.ts

@@ -0,0 +1,12 @@
+import type { BuilderContextInterface } from '../../context/types';
+import type { BuilderBlock } from '../../types/builder-block';
+import type { RepeatData } from './types';
+export declare const isEmptyHtmlElement: (tagName: unknown) => boolean;
+export declare const getComponent: ({ block, context, }: {
+    block: BuilderBlock;
+    context: BuilderContextInterface;
+}) => import("../../context/types").RegisteredComponent | null | undefined;
+export declare const getRepeatItemData: ({ block, context, }: {
+    block: BuilderBlock;
+    context: BuilderContextInterface;
+}) => RepeatData[] | undefined;

package/types/components/block/components/block-styles.d.ts

@@ -0,0 +1,8 @@
+import { BuilderContextInterface } from "../../../context/types.js";
+import { BuilderBlock } from "../../../types/builder-block.js";
+export type BlockStylesProps = {
+    block: BuilderBlock;
+    context: BuilderContextInterface;
+};
+export declare const BlockStyles: import("@builder.io/qwik").Component<BlockStylesProps>;
+export default BlockStyles;

package/types/components/block/components/component-ref.d.ts

@@ -0,0 +1,21 @@
+import { BuilderContextInterface, RegisteredComponent } from "../../../context/types.js";
+import { BuilderBlock } from "../../../types/builder-block.js";
+import { PropsWithBuilderData } from "../../../types/builder-props.js";
+import { Dictionary } from "../../../types/typescript.js";
+type ComponentOptions = PropsWithBuilderData<{
+    [index: string]: any;
+    attributes?: {
+        [index: string]: any;
+    };
+}>;
+export interface ComponentProps {
+    componentRef: any;
+    componentOptions: ComponentOptions;
+    blockChildren: BuilderBlock[];
+    context: BuilderContextInterface;
+    components: Dictionary<RegisteredComponent>;
+}
+export declare const ComponentRef: (props: ComponentProps & {
+    key?: any;
+}) => import("@builder.io/qwik/jsx-runtime").JSX.Element;
+export default ComponentRef;

package/types/components/block/components/component.d.ts

@@ -0,0 +1,21 @@
+import { BuilderContextInterface, RegisteredComponent } from "../../../context/types.js";
+import { BuilderBlock } from "../../../types/builder-block.js";
+import { PropsWithBuilderData } from "../../../types/builder-props.js";
+import { Dictionary } from "../../../types/typescript.js";
+type ComponentOptions = PropsWithBuilderData<{
+    [index: string]: any;
+    attributes?: {
+        [index: string]: any;
+    };
+}>;
+export interface ComponentProps {
+    componentRef: any;
+    componentOptions: ComponentOptions;
+    blockChildren: BuilderBlock[];
+    context: BuilderContextInterface;
+    components: Dictionary<RegisteredComponent>;
+}
+export declare const Component: (props: ComponentProps & {
+    key?: any;
+}) => import("@builder.io/qwik/jsx-runtime").JSX.Element;
+export default Component;

package/types/components/block/components/repeated-block.d.ts

@@ -0,0 +1,10 @@
+import { BuilderContextInterface, RegisteredComponent } from "../../../context/types.js";
+import { BuilderBlock } from "../../../types/builder-block";
+import { Dictionary } from "../../../types/typescript";
+type Props = {
+    block: BuilderBlock;
+    repeatContext: BuilderContextInterface;
+    components: Dictionary<RegisteredComponent>;
+};
+export declare const RepeatedBlock: import("@builder.io/qwik").Component<Props>;
+export default RepeatedBlock;

package/types/components/block/types.d.ts

@@ -0,0 +1,6 @@
+import type { BuilderContextInterface } from '../../context/types.js';
+import type { BuilderBlock } from '../../types/builder-block.js';
+export interface RepeatData {
+    block: BuilderBlock;
+    context: BuilderContextInterface;
+}

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

@@ -0,0 +1,15 @@
+import { BuilderBlock } from "../../types/builder-block.js";
+export type BlocksWrapperProps = {
+    blocks: BuilderBlock[] | undefined;
+    parent: string | undefined;
+    path: string | undefined;
+    styleProp: Record<string, any> | undefined;
+};
+type PropsWithChildren = BlocksWrapperProps & {
+    children?: any;
+};
+export declare const onClick: (props: any, state: any) => void;
+export declare const onMouseEnter: (props: any, state: any) => void;
+export declare const BlocksWrapper: import("@builder.io/qwik").Component<PropsWithChildren>;
+export default BlocksWrapper;
+export declare const STYLES = "\n.div-BlocksWrapper {\n  display: flex;\n  flex-direction: column;\n  align-items: stretch;\n}\n";

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

@@ -0,0 +1,9 @@
+import { BuilderContextInterface, RegisteredComponent } from "../../context/types.js";
+import { Dictionary } from "../../types/typescript";
+import { BlocksWrapperProps } from "./blocks-wrapper";
+export type BlocksProps = Partial<BlocksWrapperProps> & {
+    context: BuilderContextInterface;
+    components: Dictionary<RegisteredComponent>;
+};
+export declare const Blocks: import("@builder.io/qwik").Component<BlocksProps>;
+export default Blocks;

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

@@ -0,0 +1,23 @@
+import { BuilderContextInterface } from "../../context/types.js";
+import { BuilderContent } from "../../types/builder-content.js";
+import { ComponentInfo } from "../../types/components.js";
+import { Dictionary } from "../../types/typescript.js";
+import { RenderContentProps } from "./content.types.js";
+type BuilderEditorProps = Omit<RenderContentProps, "customComponents"> & {
+    customComponents: Dictionary<ComponentInfo>;
+    builderContextSignal: BuilderContextInterface;
+    children?: any;
+};
+export declare const mergeNewContent: (props: any, state: any, elementRef: any, newContent: BuilderContent) => void;
+export declare const processMessage: (props: any, state: any, elementRef: any, event: MessageEvent) => void;
+export declare const evaluateJsCode: (props: any, state: any, elementRef: any) => void;
+export declare const onClick: (props: any, state: any, elementRef: any, event: any) => void;
+export declare const evalExpression: (props: any, state: any, elementRef: any, expression: string) => string;
+export declare const handleRequest: (props: any, state: any, elementRef: any, { url, key, }: {
+    key: string;
+    url: string;
+}) => void;
+export declare const runHttpRequests: (props: any, state: any, elementRef: any) => void;
+export declare const emitStateUpdate: (props: any, state: any, elementRef: any) => void;
+export declare const BuilderEditing: import("@builder.io/qwik").Component<BuilderEditorProps>;
+export default BuilderEditing;

package/types/components/content/components/content-styles.d.ts

@@ -0,0 +1,8 @@
+import { CustomFont } from "./content-styles.helpers";
+interface Props {
+    cssCode?: string;
+    customFonts?: CustomFont[];
+    contentId?: string;
+}
+export declare const ContentStyles: import("@builder.io/qwik").Component<Props>;
+export default ContentStyles;

package/types/components/content/components/content-styles.helpers.d.ts

@@ -0,0 +1,15 @@
+export interface CustomFont {
+    family?: string;
+    kind?: string;
+    fileUrl?: string;
+    files?: {
+        [key: string]: string;
+    };
+}
+export declare const getFontCss: ({ customFonts }: {
+    customFonts?: CustomFont[] | undefined;
+}) => string;
+export declare const getCss: ({ cssCode, contentId, }: {
+    cssCode?: string | undefined;
+    contentId?: string | undefined;
+}) => string;

package/types/components/content/components/enable-editor.d.ts

@@ -0,0 +1,23 @@
+import { BuilderContextInterface } from "../../../context/types.js";
+import { BuilderContent } from "../../../types/builder-content.js";
+import { ComponentInfo } from "../../../types/components.js";
+import { Dictionary } from "../../../types/typescript.js";
+import { ContentProps } from "../content.types.js";
+type BuilderEditorProps = Omit<ContentProps, "customComponents"> & {
+    customComponents: Dictionary<ComponentInfo>;
+    builderContextSignal: BuilderContextInterface;
+    mergeNewContent: (newContent: BuilderContent) => void;
+    children?: any;
+};
+export declare const processMessage: (props: any, state: any, elementRef: any, event: MessageEvent) => void;
+export declare const evaluateJsCode: (props: any, state: any, elementRef: any) => void;
+export declare const onClick: (props: any, state: any, elementRef: any, event: any) => void;
+export declare const evalExpression: (props: any, state: any, elementRef: any, expression: string) => string;
+export declare const handleRequest: (props: any, state: any, elementRef: any, { url, key, }: {
+    key: string;
+    url: string;
+}) => void;
+export declare const runHttpRequests: (props: any, state: any, elementRef: any) => void;
+export declare const emitStateUpdate: (props: any, state: any, elementRef: any) => void;
+export declare const EnableEditor: import("@builder.io/qwik").Component<BuilderEditorProps>;
+export default EnableEditor;

package/types/components/content/components/render-styles.d.ts

@@ -0,0 +1,8 @@
+import { CustomFont } from "./render-styles.helpers";
+interface Props {
+    cssCode?: string;
+    customFonts?: CustomFont[];
+    contentId?: string;
+}
+export declare const RenderContentStyles: import("@builder.io/qwik").Component<Props>;
+export default RenderContentStyles;

package/types/components/content/components/render-styles.helpers.d.ts

@@ -0,0 +1,15 @@
+export interface CustomFont {
+    family?: string;
+    kind?: string;
+    fileUrl?: string;
+    files?: {
+        [key: string]: string;
+    };
+}
+export declare const getFontCss: ({ customFonts }: {
+    customFonts?: CustomFont[] | undefined;
+}) => string;
+export declare const getCss: ({ cssCode, contentId, }: {
+    cssCode?: string | undefined;
+    contentId?: string | undefined;
+}) => string;

package/types/components/content/content.d.ts

@@ -0,0 +1,7 @@
+import { BuilderRenderState } from "../../context/types.js";
+import { BuilderContent } from "../../types/builder-content.js";
+import { ContentProps } from "./content.types.js";
+export declare const mergeNewContent: (props: any, state: any, newContent: BuilderContent) => void;
+export declare const contentSetState: (props: any, state: any, newRootState: BuilderRenderState) => void;
+export declare const Content: import("@builder.io/qwik").Component<ContentProps>;
+export default Content;

package/types/components/content/content.helpers.d.ts

@@ -0,0 +1,7 @@
+import type { BuilderContent } from '../../types/builder-content';
+import type { Nullable } from '../../types/typescript';
+import type { ContentProps } from './content.types';
+export declare const getContextStateInitialValue: ({ content, data, locale, }: Pick<ContentProps, 'content' | 'data' | 'locale'>) => {
+    [x: string]: unknown;
+};
+export declare const getContentInitialValue: ({ content, data, }: Pick<ContentProps, 'content' | 'data'>) => Nullable<BuilderContent>;

package/types/components/content/content.types.d.ts

@@ -0,0 +1,38 @@
+import type { BuilderRenderContext, RegisteredComponent, BuilderRenderState } from '../../context/types';
+import type { BuilderContent } from '../../types/builder-content';
+import type { Nullable } from '../../types/typescript';
+import type { ApiVersion } from '../../types/api-version';
+export interface ContentProps {
+    content?: Nullable<BuilderContent>;
+    model?: string;
+    data?: {
+        [key: string]: any;
+    };
+    context?: BuilderRenderContext;
+    apiKey: string;
+    apiVersion?: ApiVersion;
+    customComponents?: RegisteredComponent[];
+    canTrack?: boolean;
+    locale?: string;
+    /** @deprecated use `enrich` instead **/
+    includeRefs?: boolean;
+    enrich?: boolean;
+    /**
+     * TO-DO: improve qwik generator to not remap this name for non-HTML tags, then name it `className`
+     */
+    classNameProp?: string;
+    hideContent?: boolean;
+    parentContentId?: string;
+    isSsrAbTest?: boolean;
+}
+export interface BuilderComponentStateChange {
+    state: BuilderRenderState;
+    ref: {
+        name?: string;
+        props?: {
+            builderBlock?: {
+                id?: string;
+            };
+        };
+    };
+}

package/types/components/content/index.d.ts

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

package/types/components/content/wrap-component-ref.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Apply target-specific transformations to the component reference.
+ *
+ * See overrides/* for examples.
+ */
+export declare const wrapComponentRef: (component: any) => any;

package/types/components/content-variants/content-variants.d.ts

@@ -0,0 +1,3 @@
+import { ContentProps } from "../content/content.types";
+export declare const RenderContentVariants: import("@builder.io/qwik").Component<ContentProps>;
+export default RenderContentVariants;

package/types/components/content-variants/helpers.d.ts

@@ -0,0 +1,17 @@
+import type { Nullable } from '../../helpers/nullable';
+import type { BuilderContent } from '../../types/builder-content';
+export declare const getVariants: (content: Nullable<BuilderContent>) => import("../../types/builder-content").BuilderContentVariation[];
+export declare const checkShouldRunVariants: ({ canTrack, content, }: {
+    canTrack: Nullable<boolean>;
+    content: Nullable<BuilderContent>;
+}) => boolean;
+type VariantData = {
+    id: string;
+    testRatio?: number;
+};
+export declare const getVariantsScriptString: (variants: VariantData[], contentId: string) => string;
+export declare const getRenderContentScriptString: ({ parentContentId, contentId, }: {
+    contentId: string;
+    parentContentId: string;
+}) => string;
+export {};

package/types/components/inlined-script.d.ts

@@ -0,0 +1,6 @@
+interface Props {
+    scriptStr: string;
+    id?: string;
+}
+export declare const InlinedScript: import("@builder.io/qwik").Component<Props>;
+export default InlinedScript;

package/types/components/inlined-styles.d.ts

@@ -0,0 +1,6 @@
+interface Props {
+    styles: string;
+    id?: string;
+}
+export declare const InlinedStyles: import("@builder.io/qwik").Component<Props>;
+export default InlinedStyles;

package/types/components/render-content/render-content.types.d.ts

@@ -1,30 +1,15 @@
-import type { BuilderRenderContext, RegisteredComponent, BuilderRenderState } from '../../context/types';
-import type { BuilderContent } from '../../types/builder-content';
-import type { Nullable } from '../../types/typescript';
-import type { ApiVersion } from '../../types/api-version';
-export interface RenderContentProps {
-    content?: Nullable<BuilderContent>;
-    model?: string;
-    data?: {
-        [key: string]: any;
-    };
-    context?: BuilderRenderContext;
-    apiKey: string;
-    apiVersion?: ApiVersion;
-    customComponents?: RegisteredComponent[];
-    canTrack?: boolean;
-    locale?: string;
-    /** @deprecated use `enrich` instead **/
-    includeRefs?: boolean;
-    enrich?: boolean;
+import type { BuilderRenderState } from '../../context/types';
+import type { EnforcePartials } from '../../types/enforced-partials';
+import type { RenderContentVariantsProps } from '../render-content-variants/render-content-variants.types';
+interface InternalRenderProps {
     /**
      * TO-DO: improve qwik generator to not remap this name for non-HTML tags, then name it `className`
      */
-    classNameProp?: string;
-    hideContent?: boolean;
-    parentContentId?: string;
-    isSsrAbTest?: boolean;
+    classNameProp: string | undefined;
+    showContent: boolean;
+    isSsrAbTest: boolean;
 }
+export type RenderContentProps = InternalRenderProps & EnforcePartials<RenderContentVariantsProps>;
 export interface BuilderComponentStateChange {
     state: BuilderRenderState;
     ref: {
@@ -36,3 +21,4 @@ export interface BuilderComponentStateChange {
         };
     };
 }
+export {};

package/types/components/render-content-variants/helpers.d.ts

@@ -1,6 +1,29 @@
 import type { Nullable } from '../../helpers/nullable';
 import type { BuilderContent } from '../../types/builder-content';
-export declare const getVariants: (content: Nullable<BuilderContent>) => import("../../types/builder-content").BuilderContentVariation[];
+export declare const getVariants: (content: Nullable<BuilderContent>) => {
+    testVariationId: string | undefined;
+    id: string | undefined;
+    data?: {
+        [key: string]: any;
+        title?: string | undefined;
+        blocks?: import("../../types/builder-block").BuilderBlock[] | undefined;
+        inputs?: import("../../types/input").Input[] | undefined;
+        state?: {
+            [key: string]: any;
+        } | undefined;
+        jsCode?: string | undefined;
+        tsCode?: string | undefined;
+        httpRequests?: {
+            [key: string]: string;
+        } | undefined;
+    } | undefined;
+    name?: string | undefined;
+    testRatio?: number | undefined;
+    meta?: {
+        [key: string]: any;
+        breakpoints?: import("../../types/typescript").Nullable<import("../../types/builder-content").Breakpoints>;
+    } | undefined;
+}[];
 export declare const checkShouldRunVariants: ({ canTrack, content, }: {
     canTrack: Nullable<boolean>;
     content: Nullable<BuilderContent>;
@@ -9,9 +32,10 @@ type VariantData = {
     id: string;
     testRatio?: number;
 };
+export declare const getScriptString: () => string;
 export declare const getVariantsScriptString: (variants: VariantData[], contentId: string) => string;
-export declare const getRenderContentScriptString: ({ parentContentId, contentId, }: {
+export declare const getRenderContentScriptString: ({ contentId, variationId, }: {
+    variationId: string;
     contentId: string;
-    parentContentId: string;
 }) => string;
 export {};

package/types/components/render-content-variants/render-content-variants.d.ts

@@ -1,3 +1,9 @@
-import { RenderContentProps } from "../render-content/render-content.types";
-export declare const RenderContentVariants: import("@builder.io/qwik").Component<RenderContentProps>;
+import { RenderContentVariantsProps } from "./render-content-variants.types";
+type VariantsProviderProps = RenderContentVariantsProps & {
+    /**
+     * For internal use only. Do not provide this prop.
+     */
+    __isNestedRender?: boolean;
+};
+export declare const RenderContentVariants: import("@builder.io/qwik").Component<VariantsProviderProps>;
 export default RenderContentVariants;

package/types/components/render-content-variants/render-content-variants.types.d.ts

@@ -0,0 +1,20 @@
+import type { BuilderRenderContext, RegisteredComponent } from '../../context/types';
+import type { ApiVersion } from '../../types/api-version';
+import type { BuilderContent } from '../../types/builder-content';
+import type { Nullable } from '../../types/typescript';
+export interface RenderContentVariantsProps {
+    content?: Nullable<BuilderContent>;
+    model?: string;
+    data?: {
+        [key: string]: any;
+    };
+    context?: BuilderRenderContext;
+    apiKey: string;
+    apiVersion?: ApiVersion;
+    customComponents?: RegisteredComponent[];
+    canTrack?: boolean;
+    locale?: string;
+    /** @deprecated use `enrich` instead **/
+    includeRefs?: boolean;
+    enrich?: boolean;
+}

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

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.4.3";
+export declare const SDK_VERSION = "0.4.5";

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

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

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

@@ -0,0 +1,21 @@
+import type { Prettify } from './typescript';
+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 {};

package/types/types/typescript.d.ts

@@ -3,3 +3,6 @@ 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];
+} & {};