@builder.io/sdk-qwik 0.6.5-4 → 0.7.0

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

@@ -1,51 +0,0 @@
-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.
-     * @deprecated use `enrich` instead
-     */
-    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;
-    /**
-     * 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.
-     */
-    locale?: string;
-    /**
-     * If provided, sets the Builder API version used to fetch content.
-     *
-     * Defaults to `v3`.
-     */
-    apiVersion?: 'v2' | 'v3';
-}

package/types/src/functions/get-fetch.d.ts

@@ -1 +0,0 @@
-export declare const fetch: typeof globalThis.fetch;

package/types/src/functions/get-global-this.d.ts

@@ -1,4 +0,0 @@
-/// <reference types="node" />
-type Global = typeof global | typeof window | typeof self | typeof globalThis;
-export declare function getGlobalThis(): Global;
-export {};

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

@@ -1,10 +0,0 @@
-import type { BuilderContextInterface } from '../context/types.js';
-import type { BuilderBlock } from '../types/builder-block.js';
-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, 'localState' | 'context' | 'rootState' | 'rootSetState'>): BuilderBlock;

package/types/src/functions/get-react-native-block-styles.d.ts

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

package/types/src/functions/is-browser.d.ts

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

package/types/src/functions/is-edge-runtime.d.ts

@@ -1,4 +0,0 @@
-/**
- * Identifies edge runtimes (edge, workers, serverless, etc.)
- */
-export declare function isEdgeRuntime(): boolean;

package/types/src/functions/is-editing.d.ts

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

package/types/src/functions/is-iframe.d.ts

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

package/types/src/functions/is-non-node-server.d.ts

@@ -1,4 +0,0 @@
-/**
- * Identifies non-node server runtimes (edge, workers, serverless, etc.)
- */
-export declare function isNonNodeServer(): boolean;

package/types/src/functions/is-previewing.d.ts

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

package/types/src/functions/on-change.d.ts

@@ -1,7 +0,0 @@
-export declare const onChangeProxySymbol: unique symbol;
-/**
- * Deeply observe an object and run a callback when it changes
- *
- * See ./on-change.test.ts for more info
- */
-export declare function onChange<T extends object = any>(obj: T, cb: () => void): T;

package/types/src/functions/register-component.d.ts

@@ -1,15 +0,0 @@
-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: (info: ComponentInfo) => {
-    type: string;
-    data: ComponentInfo;
-};
-export declare const serializeComponentInfo: ({ inputs, ...info }: ComponentInfo) => ComponentInfo;

package/types/src/functions/register.d.ts

@@ -1,16 +0,0 @@
-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/types/src/functions/sanitize-react-native-block-styles.d.ts

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

package/types/src/functions/set-editor-settings.d.ts

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

package/types/src/functions/set.d.ts

@@ -1,7 +0,0 @@
-/**
- * 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/types/src/functions/track/helpers.d.ts

@@ -1,5 +0,0 @@
-export declare const getUserAttributes: () => {
-    urlPath: string | undefined;
-    host: string | undefined;
-    device: string;
-};

package/types/src/functions/track/index.d.ts

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

@@ -1,13 +0,0 @@
-type Offset = {
-    x: number;
-    y: number;
-};
-export declare const getInteractionPropertiesForEvent: (event: MouseEvent) => {
-    targetBuilderElement: string | undefined;
-    metadata: {
-        targetOffset: Offset | undefined;
-        builderTargetOffset: Offset | undefined;
-        builderElementIndex: number | undefined;
-    };
-};
-export {};

package/types/src/functions/transform-block-properties.d.ts

@@ -1 +0,0 @@
-export declare function transformBlockProperties<T>(properties: T): T;

package/types/src/functions/transform-block.d.ts

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

package/types/src/helpers/ab-tests.d.ts

@@ -1,9 +0,0 @@
-import type { CanTrack } from '../types/can-track.js';
-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/src/helpers/canTrack.d.ts

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

package/types/src/helpers/cookie.d.ts

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

package/types/src/helpers/css.d.ts

@@ -1,7 +0,0 @@
-export declare const convertStyleMapToCSSArray: (style: Partial<CSSStyleDeclaration>) => string[];
-export declare const convertStyleMapToCSS: (style: Partial<CSSStyleDeclaration>) => string;
-export declare const createCssClass: ({ mediaQuery, className, styles }: {
-    mediaQuery?: string | undefined;
-    className: string;
-    styles: Partial<CSSStyleDeclaration>;
-}) => string;

package/types/src/helpers/flatten.d.ts

@@ -1,6 +0,0 @@
-/**
- * Convert deep object to a flat object with dots
- *
- * { foo: { bar: 'baz' }} -> { 'foo.bar': 'baz' }
- */
-export declare function flatten<T extends Record<string, any>>(object: T, path?: string | null, separator?: string): T;

package/types/src/helpers/localStorage.d.ts

@@ -1,9 +0,0 @@
-import type { CanTrack } from '../types/can-track.js';
-import type { Nullable } from './nullable.js';
-export declare const getLocalStorageItem: ({ key, canTrack }: {
-    key: string;
-} & CanTrack) => Nullable<string>;
-export declare const setLocalStorageItem: ({ key, canTrack, value }: {
-    key: string;
-    value: string;
-} & CanTrack) => void;

package/types/src/helpers/logger.d.ts

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

package/types/src/helpers/nullable.d.ts

@@ -1,2 +0,0 @@
-export type Nullable<T> = T | null | undefined;
-export declare const checkIsDefined: <T>(maybeT: Nullable<T>) => maybeT is T;

package/types/src/helpers/preview-lru-cache/get.d.ts

@@ -1,2 +0,0 @@
-import type { BuilderContent } from '../../types/builder-content.js';
-export declare function getPreviewContent(_searchParams: URLSearchParams): BuilderContent | undefined;

package/types/src/helpers/preview-lru-cache/init.d.ts

@@ -1,6 +0,0 @@
-/**
- * This is an LRU cache to hold preview content on the server-side.
- *
- * Note: This logic is only used by the NextJS SDK.
- */
-export declare function init(): void;

package/types/src/helpers/preview-lru-cache/set.d.ts

@@ -1,7 +0,0 @@
-import type { BuilderContent } from '../../types/builder-content.js';
-export declare function postPreviewContent({ key, value }: {
-    key: string;
-    value: BuilderContent;
-}): Promise<{
-    [x: string]: BuilderContent;
-}>;

package/types/src/helpers/sessionId.d.ts

@@ -1,6 +0,0 @@
-import type { CanTrack } from '../types/can-track.js';
-export declare const getSessionId: ({ canTrack }: CanTrack) => Promise<string | undefined>;
-export declare const createSessionId: () => string;
-export declare const setSessionId: ({ id, canTrack }: {
-    id: string;
-} & CanTrack) => Promise<void>;

package/types/src/helpers/time.d.ts

@@ -1 +0,0 @@
-export declare const getCurrentDatePlusMinutes: (minutes?: number) => Date;

package/types/src/helpers/url.d.ts

@@ -1,6 +0,0 @@
-/**
- * Only gets one level up from hostname
- * wwww.example.com -> example.com
- * www.example.co.uk -> example.co.uk
- */
-export declare const getTopLevelDomain: (host: string) => string;

package/types/src/helpers/uuid.d.ts

@@ -1,8 +0,0 @@
-/**
- * @credit https://stackoverflow.com/a/2117523
- */
-export declare function uuidv4(): string;
-/**
- * Slightly cleaner and smaller UUIDs
- */
-export declare function uuid(): string;

package/types/src/helpers/visitorId.d.ts

@@ -1,6 +0,0 @@
-import type { CanTrack } from '../types/can-track.js';
-export declare const getVisitorId: ({ canTrack }: CanTrack) => string | undefined;
-export declare const createVisitorId: () => string;
-export declare const setVisitorId: ({ id, canTrack }: {
-    id: string;
-} & CanTrack) => void;

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

@@ -1,21 +0,0 @@
-export { default as Button } from '../blocks/button/button.jsx';
-export { default as Columns } from '../blocks/columns/columns.jsx';
-export { default as Fragment } from '../blocks/fragment/fragment.jsx';
-export { default as Image } from '../blocks/image/image.jsx';
-export { default as Section } from '../blocks/section/section.jsx';
-export { default as Symbol } from '../blocks/symbol/symbol.jsx';
-export { default as Text } from '../blocks/text/text.jsx';
-export { default as Video } from '../blocks/video/video.jsx';
-import { default as Blocks } from '../components/blocks/blocks.jsx';
-import { default as Content } from '../components/content-variants/content-variants.jsx';
-export { Blocks, Content };
-/**
- * @deprecated Renamed to `Blocks`.
- */
-export declare const RenderBlocks: import("@builder.io/qwik").Component<import("../components/blocks/blocks.jsx").BlocksProps>;
-/**
- * @deprecated Renamed to `Content`.
- */
-export declare const RenderContent: import("@builder.io/qwik").Component<import("../components/content-variants/content-variants.types.js").ContentVariantsPrps & {
-    __isNestedRender?: boolean | undefined;
-}>;

package/types/src/index-helpers/top-of-file.d.ts

@@ -1 +0,0 @@
-export default undefined;

package/types/src/index.d.ts

@@ -1,7 +0,0 @@
-export * from './index-helpers/top-of-file.js';
-export * from './index-helpers/blocks-exports.js';
-/**
- * We have a separate entry point to the SDKs that guarantees no components are being imported. This is useful
- * for React SDK, which would break in the NextJS App directory because the component imports have `use client` in them.
- */
-export * from './server-index.js';

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

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

package/types/src/server-index.d.ts

@@ -1,15 +0,0 @@
-export * from './index-helpers/top-of-file.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 { fetchEntries, fetchOneEntry, getAllContent, getContent, _processContentResult } from './functions/get-content/index.js';
-export { getBuilderSearchParams } from './functions/get-builder-search-params/index.js';
-export { track } from './functions/track/index.js';
-export type { RegisteredComponent } from './context/types.js';
-export type { ComponentInfo } from './types/components.js';
-export type { ContentProps } from './components/content/content.types.js';
-export { fetchBuilderProps } from './functions/fetch-builder-props.js';

package/types/src/types/api-version.d.ts

@@ -1,2 +0,0 @@
-export type ApiVersion = 'v2' | 'v3';
-export declare const DEFAULT_API_VERSION: ApiVersion;

package/types/src/types/builder-block.d.ts

@@ -1,66 +0,0 @@
-type JSONValue = string | number | boolean | JSONObject | JSONArray;
-interface JSONObject {
-    [x: string]: JSONValue;
-}
-interface JSONArray extends Array<JSONValue> {
-}
-/** @todo typedoc this */
-export interface BuilderBlock {
-    '@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?: BuilderBlock[];
-    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?: any[];
-    style?: Partial<CSSStyleDeclaration>;
-    /**
-     * generated by the "Hide If" binding
-     */
-    hide?: boolean;
-    /**
-     * generated by the "Show If" binding
-     */
-    show?: boolean;
-}
-export {};

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

@@ -1,44 +0,0 @@
-import type { BuilderBlock } from './builder-block.js';
-import type { Input } from './input.js';
-import type { Nullable } from './typescript.js';
-export interface Breakpoints {
-    small: number;
-    medium: number;
-}
-export interface BuilderContentVariation {
-    data?: {
-        title?: string;
-        blocks?: BuilderBlock[];
-        inputs?: Input[];
-        state?: {
-            [key: string]: any;
-        };
-        jsCode?: string;
-        tsCode?: string;
-        httpRequests?: {
-            [key: string]: string;
-        };
-        [key: string]: any;
-    };
-    name?: string;
-    testRatio?: number;
-    id?: string;
-    meta?: {
-        breakpoints?: Nullable<Breakpoints>;
-        [key: string]: any;
-    };
-}
-export interface BuilderContent extends BuilderContentVariation {
-    '@version'?: number;
-    published?: 'published' | 'draft' | 'archived';
-    modelId?: string;
-    priority?: number;
-    lastUpdated?: number;
-    startDate?: number;
-    endDate?: number;
-    variations?: {
-        [id: string]: BuilderContentVariation;
-    };
-    testVariationId?: string;
-    testVariationName?: string;
-}

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

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

package/types/src/types/can-track.d.ts

@@ -1,3 +0,0 @@
-export type CanTrack = {
-    canTrack: boolean;
-};