@builder.io/sdk-qwik 0.3.0 → 0.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@builder.io/sdk-qwik",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Builder.io Qwik SDK",
   "type": "module",
   "main": "./lib/index.qwik.cjs",
@@ -22,13 +22,10 @@
   },
   "scripts": {
     "typecheck": "tsc --noEmit",
-    "build": "tsc && vite build --mode lib",
-    "release:patch": "yarn run build && npm version patch && npm publish",
-    "release:minor": "yarn run build && npm version minor && npm publish",
-    "release:dev": "yarn run build && npm version prerelease && npm publish --tag dev"
+    "build": "tsc && vite build --mode lib"
   },
   "devDependencies": {
-    "@builder.io/qwik": "^0.101.0",
+    "@builder.io/qwik": "^1.0.0",
     "@types/node": "latest",
     "typescript": "^4",
     "vite": "^3.0.4"

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

@@ -10,4 +10,3 @@ export declare const getRepeatItemData: ({ block, context, }: {
     block: BuilderBlock;
     context: BuilderContextInterface;
 }) => RepeatData[] | undefined;
-export declare const getProxyState: (context: BuilderContextInterface) => BuilderContextInterface['state'];

package/types/components/render-block/render-component-with-context.d.ts

@@ -0,0 +1,3 @@
+import type { RenderComponentProps } from "./render-component";
+export declare const RenderComponentWithContext: import("@builder.io/qwik").Component<RenderComponentProps>;
+export default RenderComponentWithContext;

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

@@ -3,7 +3,7 @@ import { Breakpoints, BuilderContent } from "../../types/builder-content.js";
 import { RenderContentProps } from "./render-content.types.js";
 export declare const mergeNewContent: (props: any, state: any, elementRef: any, newContent: BuilderContent) => void;
 export declare const setBreakpoints: (props: any, state: any, elementRef: any, breakpoints: Breakpoints) => void;
-export declare const setContextState: (props: any, state: any, elementRef: any, newState: BuilderRenderState) => void;
+export declare const contentSetState: (props: any, state: any, elementRef: any, newRootState: BuilderRenderState) => 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;

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

@@ -2,7 +2,7 @@ import type { BuilderRenderContext, RegisteredComponent, BuilderRenderState } fr
 import type { BuilderContent } from '../../types/builder-content';
 import type { Nullable } from '../../types/typescript';
 import type { ApiVersion } from '../../types/api-version';
-export type RenderContentProps = {
+export interface RenderContentProps {
     content?: Nullable<BuilderContent>;
     model?: string;
     data?: {
@@ -14,8 +14,17 @@ export type RenderContentProps = {
     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: {

package/types/components/render-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/render-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/render-content-variants/render-content-variants.d.ts

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

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

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

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

@@ -0,0 +1 @@
+export declare const SDK_VERSION = "0.4.0";

package/types/context/types.d.ts

@@ -11,8 +11,23 @@ export type BuilderRenderContext = Record<string, unknown>;
 export interface BuilderContextInterface {
     content: Nullable<BuilderContent>;
     context: BuilderRenderContext;
-    state: BuilderRenderState;
-    setState?: (state: BuilderRenderState) => void;
+    /**
+     * The state of the application.
+     *
+     * NOTE: see `localState` below to understand how it is different from `rootState`.
+     */
+    rootState: BuilderRenderState;
+    /**
+     * Some frameworks have a `setState` function which needs to be invoked to notify
+     * the framework of state change. (other frameworks don't in which case it is `undefined')
+     */
+    rootSetState: ((rootState: BuilderRenderState) => void) | undefined;
+    /**
+     * The local state of the current component. This is different from `rootState` in that
+     * it can be a child state created by a repeater containing local state.
+     * The `rootState` is where all of the state mutations are actually stored.
+     */
+    localState: BuilderRenderState | undefined;
     apiKey: string | null;
     apiVersion: ApiVersion | undefined;
     registeredComponents: RegisteredComponents;

package/types/functions/convert-style-object.d.ts

@@ -0,0 +1 @@
+export declare const convertStyleObject: (obj: Partial<CSSStyleDeclaration>) => Partial<CSSStyleDeclaration>;

package/types/functions/evaluate.d.ts

@@ -1,6 +1,7 @@
-import type { BuilderContextInterface } from '../context/types.js';
-export declare function evaluate({ code, context, state, event, isExpression, }: {
+import type { BuilderContextInterface, BuilderRenderState } from '../context/types.js';
+export declare function evaluate({ code, context, localState, rootState, rootSetState, event, isExpression, }: {
     code: string;
     event?: Event;
     isExpression?: boolean;
-} & Pick<BuilderContextInterface, 'state' | 'context'>): any;
+} & Pick<BuilderContextInterface, 'localState' | 'context' | 'rootState' | 'rootSetState'>): any;
+export declare function flattenState(rootState: Record<string | symbol, any>, localState: Record<string | symbol, any> | undefined, rootSetState: ((rootState: BuilderRenderState) => void) | undefined): BuilderRenderState;

package/types/functions/evaluate.test.d.ts

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

package/types/functions/get-block-actions-handler.d.ts

@@ -2,4 +2,4 @@ import type { BuilderContextInterface } from '../context/types.js';
 import type { BuilderBlock } from '../types/builder-block.js';
 export declare function createEventHandler(value: string, options: {
     block: BuilderBlock;
-} & Pick<BuilderContextInterface, 'state' | 'context'>): (event: Event) => any;
+} & Pick<BuilderContextInterface, 'localState' | 'context' | 'rootState' | 'rootSetState'>): (event: Event) => any;

package/types/functions/get-block-actions.d.ts

@@ -5,5 +5,5 @@ type Actions = {
 };
 export declare function getBlockActions(options: {
     block: BuilderBlock;
-} & Pick<BuilderContextInterface, 'state' | 'context'>): Actions;
+} & Pick<BuilderContextInterface, 'localState' | 'context' | 'rootState' | 'rootSetState'>): Actions;
 export {};

package/types/functions/get-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 getBlockStyles({ block, context, }: {
+    block: BuilderBlock;
+    context: BuilderContextInterface;
+}): Partial<CSSStyleDeclaration>;

package/types/functions/get-block-tag.d.ts

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

package/types/functions/get-content/fn.test.d.ts

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

package/types/functions/get-content/index.d.ts

@@ -1,11 +1,16 @@
 import type { BuilderContent } from '../../types/builder-content.js';
 import type { GetContentOptions } from './types.js';
 export declare function getContent(options: GetContentOptions): Promise<BuilderContent | null>;
-type ContentResponse = {
+type ContentResults = {
     results: BuilderContent[];
-} | {
+};
+type ContentResponse = ContentResults | {
     status: number;
     message: string;
 };
+/**
+ * Exported only for testing purposes. Should not be used directly.
+ */
+export declare const processContentResult: (options: GetContentOptions, content: ContentResults) => Promise<ContentResults>;
 export declare function getAllContent(options: GetContentOptions): Promise<ContentResponse | null>;
 export {};

package/types/functions/get-content/types.d.ts

@@ -19,6 +19,7 @@ export interface GetContentOptions {
     /**
      * If set to `true`, it will lazy load symbols/references.
      * If set to `false`, it will render the entire content tree eagerly.
+     * @deprecated use `enrich` instead
      */
     noTraverse?: boolean;
     /**
@@ -30,8 +31,13 @@ export interface GetContentOptions {
     canTrack?: boolean;
     /**
      * Include references in the response. Defaults to `true`.
+     * @deprecated use `enrich` instead
      */
     includeRefs?: boolean;
+    /**
+     * Include multilevel references in the response.
+     */
+    enrich?: boolean;
     /**
      * If provided, the API will auto-resolve localized objects to the value of this `locale` key.
      */

package/types/functions/get-processed-block.d.ts

@@ -1,10 +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, }: {
+export declare function getProcessedBlock({ block, context, shouldEvaluateBindings, localState, rootState, rootSetState, }: {
     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;
+} & Pick<BuilderContextInterface, 'localState' | 'context' | 'rootState' | 'rootSetState'>): BuilderBlock;

package/types/functions/mark-mutable.d.ts

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

package/types/functions/sanitize-styles.d.ts

@@ -0,0 +1,4 @@
+/**
+ * No-op function, sanitize on a per-framework basis by overriding.
+ */
+export declare const sanitizeBlockStyles: (styles: Partial<CSSStyleDeclaration>) => Partial<CSSStyleDeclaration>;

package/types/functions/track.d.ts

@@ -0,0 +1,56 @@
+import type { CanTrack } from '../types/can-track.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;
+        /**
+         * Stringified JSON object containing any additional metadata you want to track.
+         */
+        metadata?: string;
+        /**
+         * 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;
+    };
+}
+declare type EventProperties = Pick<Event, 'type'> & Pick<Event['data'], 'contentId' | 'variationId'> & {
+    /**
+     * Your organization's API key.
+     */
+    apiKey: Event['data']['ownerId'];
+    /**
+     * (Optional) metadata that you want to provide with your event.
+     */
+    metadata?: {
+        [index: string]: any;
+    };
+    /**
+     * (Optional) Any additional (non-metadata) properties to add to the event.
+     */
+    [index: string]: any;
+};
+export declare 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/helpers/ab-tests.d.ts

@@ -1,8 +1,9 @@
 import type { CanTrack } from '../types/can-track.js';
-export declare const getContentVariationCookie: ({ contentId, canTrack, }: {
-    contentId: string;
-} & CanTrack) => Promise<string | undefined>;
-export declare const setContentVariationCookie: ({ contentId, canTrack, value, }: {
-    contentId: string;
-    value: string;
-} & CanTrack) => Promise<void>;
+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

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

package/types/helpers/cookie.d.ts

@@ -1,10 +1,13 @@
 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: ({ name, canTrack, }: {
-    name: string;
-} & CanTrack) => Promise<string | undefined>;
+export declare const getCookie: (args: GetCookieArgs) => Promise<string | undefined>;
 /**
  * NOTE: This function is `async` because its react-native override is async. Do not remove the `async` keyword!
  */
@@ -13,3 +16,4 @@ export declare const setCookie: ({ name, value, expires, canTrack, }: {
     value: string;
     expires?: Date | undefined;
 } & CanTrack) => Promise<void>;
+export {};

package/types/helpers/logger.d.ts

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

package/types/index-helpers/blocks-exports.d.ts

@@ -3,8 +3,8 @@ 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 RenderBlocks } from '../components/render-blocks';
-export { default as RenderContent } from '../components/render-content/render-content';
 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';
+export { default as RenderContent } from '../components/render-content-variants/render-content-variants';

package/types/index.d.ts

@@ -1,12 +1,13 @@
 export * from './index-helpers/top-of-file.js';
 export * from './index-helpers/blocks-exports.js';
-export * from './functions/is-editing.js';
-export * from './functions/is-previewing.js';
-export * from './functions/register-component.js';
-export * from './functions/register.js';
-export * from './functions/set-editor-settings.js';
-export * from './functions/get-content/index.js';
-export * from './functions/get-builder-search-params/index.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 { getAllContent, getContent, processContentResult, } from './functions/get-content/index.js';
 export { track } from './functions/track/index.js';
 export type { RegisteredComponent } from './context/types';
 export type { ComponentInfo } from './types/components';

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

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

package/types/talk/generators-updated.d.ts

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

package/types/talk/generators.d.ts

@@ -0,0 +1,6 @@
+declare const ON_MOUNT_CODE: "\n  Object.values(props.customComponents).forEach((registeredComponent) => {\n    sendComponentToVisualEditor(registeredComponent);\n  });\n";
+declare const REACT_CODE: string;
+declare const VUE_CODE: string;
+declare const SVELTE_CODE: string;
+declare const SOLIDJS_CODE: string;
+declare const QWIK_CODE: string;

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

@@ -30,8 +30,6 @@ export interface BuilderContentVariation {
 }
 export interface BuilderContent extends BuilderContentVariation {
     '@version'?: number;
-    id?: string;
-    name?: string;
     published?: 'published' | 'draft' | 'archived';
     modelId?: string;
     priority?: number;
@@ -39,7 +37,7 @@ export interface BuilderContent extends BuilderContentVariation {
     startDate?: number;
     endDate?: number;
     variations?: {
-        [id: string]: BuilderContentVariation | undefined;
+        [id: string]: BuilderContentVariation;
     };
     testVariationId?: string;
     testVariationName?: string;