@builder.io/sdk-qwik 0.3.1 → 0.4.0

package/package.json

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

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

@@ -1,5 +1,6 @@
 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>;
@@ -9,4 +10,8 @@ type VariantData = {
     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-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

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

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/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/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/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;