@builder.io/sdk-qwik 0.0.16 → 0.0.17

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

@@ -0,0 +1,3 @@
+import { GetContentOptions } from './types.js';
+import { BuilderContent } from '../../types/builder-content.js';
+export declare const handleABTesting: (item: BuilderContent, testGroups: NonNullable<GetContentOptions['testGroups']>) => void;

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

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

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

@@ -0,0 +1,9 @@
+import { 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/types/functions/get-content/types.d.ts

@@ -0,0 +1,26 @@
+export interface GetContentOptions {
+    /** The model to get content for */
+    model: string;
+    /** Your public API key */
+    apiKey: string;
+    /** A/B test groups the current visitor is in. Key is the content ID, value is the variation ID */
+    testGroups?: Record<string, string> | null;
+    /** 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;
+}

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

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

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

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

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

@@ -0,0 +1,10 @@
+import type { BuilderContextInterface } from '../context/types.js';
+import { 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/types/functions/get-processed-block.test.d.ts

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

package/types/functions/if-target.d.ts

@@ -0,0 +1,7 @@
+declare type Target = import('../types/targets').Target;
+export declare function ifTarget<A, B>({ targets, doThing, elseThing, }: {
+    targets: Target[];
+    doThing: () => A;
+    elseThing?: () => B;
+}): A | B | undefined;
+export {};

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

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

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

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

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

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

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

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

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/on-change.d.ts

@@ -0,0 +1,7 @@
+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/functions/on-change.test.d.ts

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

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

@@ -0,0 +1,14 @@
+import { 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/types/functions/register.d.ts

@@ -0,0 +1,16 @@
+import { BuilderBlock } from '../types/builder-block.js';
+import { 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/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>) => void;

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

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

package/types/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/types/functions/set.test.d.ts

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

package/types/functions/track.d.ts

@@ -0,0 +1,21 @@
+import { 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 {};

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

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

package/types/helpers/cookie.d.ts

@@ -0,0 +1,9 @@
+import { CanTrack } from '../types/can-track.js';
+export declare const getCookie: ({ name, canTrack, }: {
+    name: string;
+} & CanTrack) => string | undefined;
+export declare const setCookie: ({ name, value, expires, canTrack, }: {
+    name: string;
+    value: string;
+    expires?: Date | undefined;
+} & CanTrack) => undefined;

package/types/helpers/css.d.ts

@@ -0,0 +1 @@
+export declare const convertStyleMaptoCSS: (style: Partial<CSSStyleDeclaration>) => string;

package/types/helpers/flatten.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 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/helpers/localStorage.d.ts

@@ -0,0 +1,9 @@
+export declare const getLocalStorageItem: ({ key, canTrack, }: {
+    key: string;
+    canTrack: boolean;
+}) => string | null | undefined;
+export declare const setLocalStorageItem: ({ key, canTrack, value, }: {
+    key: string;
+    value: string;
+    canTrack: boolean;
+}) => void;

package/types/helpers/nullable.d.ts

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

package/types/helpers/sessionId.d.ts

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

package/types/helpers/time.d.ts

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

package/types/helpers/url.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 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/helpers/url.test.d.ts

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

package/types/helpers/uuid.d.ts

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

package/types/helpers/visitorId.d.ts

@@ -0,0 +1,8 @@
+export declare const getVisitorId: ({ canTrack }: {
+    canTrack: boolean;
+}) => string | undefined;
+export declare const createVisitorId: () => string;
+export declare const setVisitorId: ({ id, canTrack, }: {
+    id: string;
+    canTrack: boolean;
+}) => void;

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

@@ -0,0 +1,10 @@
+export { default as Columns } from '../blocks/columns/columns.jsx';
+export { default as Image } from '../blocks/image/image.jsx';
+export { default as Text } from '../blocks/text/text.jsx';
+export { default as Video } from '../blocks/video/video.jsx';
+export { default as Symbol } from '../blocks/symbol/symbol.jsx';
+export { default as Button } from '../blocks/button/button.jsx';
+export { default as Section } from '../blocks/section/section.jsx';
+export { default as Fragment } from '../blocks/fragment/fragment.jsx';
+export { default as RenderContent } from '../components/render-content/render-content.jsx';
+export { default as RenderBlocks } from '../components/render-blocks.jsx';

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

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

package/types/index.d.ts

@@ -0,0 +1,10 @@
+import './index-helpers/top-of-file.js';
+import './scripts/init-editing.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';

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

@@ -0,0 +1,2 @@
+export declare const registerInsertMenu: () => void;
+export declare const setupBrowserForEditing: () => void;

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

@@ -0,0 +1,57 @@
+declare 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[];
+}
+export {};

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

@@ -0,0 +1,38 @@
+import { BuilderBlock } from './builder-block.js';
+declare type Input = any;
+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;
+}
+export interface BuilderContent extends BuilderContentVariation {
+    '@version'?: number;
+    id?: string;
+    name?: string;
+    published?: 'published' | 'draft' | 'archived';
+    modelId?: string;
+    priority?: number;
+    lastUpdated?: number;
+    startDate?: number;
+    endDate?: number;
+    variations?: {
+        [id: string]: BuilderContentVariation | undefined;
+    };
+    testVariationId?: string;
+    testVariationName?: string;
+}
+export {};

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

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

package/types/types/components.d.ts

@@ -0,0 +1,177 @@
+import type { BuilderElement } from './element';
+export interface Input {
+    name: string;
+    friendlyName?: string;
+    description?: string;
+    defaultValue?: any;
+    type: string;
+    valueType?: {
+        type?: string;
+    };
+    required?: boolean;
+    autoFocus?: boolean;
+    subFields?: Input[];
+    helperText?: string;
+    allowedFileTypes?: string[];
+    imageHeight?: number;
+    imageWidth?: number;
+    mediaHeight?: number;
+    mediaWidth?: number;
+    hideFromUI?: boolean;
+    modelId?: string;
+    /**
+     * Number field type validation maximum accepted input
+     */
+    max?: number;
+    /**
+     * Number field type validation minimum accepted input
+     */
+    min?: number;
+    /**
+     * Number field type step size when using arrows
+     */
+    step?: number;
+    /**
+     * Set this to `true` to show the editor for this input when
+     * children of this component are selected. This is useful for things
+     * like Tabs, such that users may not always select the Tabs component
+     * directly but will still be looking for how to add additional tabs
+     */
+    broadcast?: boolean;
+    /**
+     * Set this to `true` to show the editor for this input when
+     * group locked parents of this component are selected. This is useful
+     * to bubble up important inputs for locked groups, like text and images
+     */
+    bubble?: boolean;
+    options?: {
+        [key: string]: any;
+    };
+    enum?: string[] | {
+        label: string;
+        value: any;
+        helperText?: string;
+    }[];
+    /** Regex field validation for all string types (text, longText, html, url, etc) */
+    regex?: {
+        /** pattern to test, like "^\/[a-z]$" */
+        pattern: string;
+        /** flags for the RegExp constructor, e.g. "gi"  */
+        options?: string;
+        /**
+         * Friendly message to display to end-users if the regex fails, e.g.
+         * "You must use a relative url starting with '/...' "
+         */
+        message: string;
+    };
+    advanced?: boolean;
+    onChange?: ((options: Map<string, any>) => void | Promise<void>) | string;
+    code?: boolean;
+    richText?: boolean;
+    showIf?: ((options: Map<string, any>) => boolean) | string;
+    copyOnAdd?: boolean;
+}
+export interface ComponentInfo {
+    /**
+     * Name your component something unique, e.g. 'MyButton'. You can override built-in components
+     * by registering a component with the same name, e.g. 'Text', to replace the built-in text component
+     */
+    name: string;
+    description?: string;
+    /**
+     * Link to a documentation page for this component
+     */
+    docsLink?: string;
+    image?: string;
+    /**
+     * Input schema for your component for users to fill in the options
+     */
+    inputs?: Input[];
+    class?: any;
+    type?: 'angular' | 'webcomponent' | 'react' | 'vue';
+    defaultStyles?: {
+        [key: string]: string;
+    };
+    /**
+     * Turn on if your component can accept children. Be sure to use in combination with
+     * withChildren(YourComponent) like here
+     * github.com/BuilderIO/builder/blob/master/examples/react-design-system/src/components/HeroWithChildren/HeroWithChildren.builder.js#L5
+     */
+    canHaveChildren?: boolean;
+    fragment?: boolean;
+    /**
+     * Do not wrap a component in a dom element. Be sure to use {...props.attributes} with this option
+     * like here github.com/BuilderIO/builder/blob/master/packages/react/src/blocks/forms/Input.tsx#L34
+     */
+    noWrap?: boolean;
+    /**
+     * Default children
+     */
+    defaultChildren?: BuilderElement[];
+    defaults?: Partial<BuilderElement>;
+    hooks?: {
+        [key: string]: string | Function;
+    };
+    /**
+     * Hide your component in editor, useful for gradually deprecating components
+     */
+    hideFromInsertMenu?: boolean;
+    tag?: string;
+    static?: boolean;
+    /**
+     * Passing a list of model names will restrict using the component to only the models listed here, otherwise it'll be available for all models
+     */
+    models?: string[];
+    builtIn: true;
+    /**
+     * Specify restrictions direct children must match
+     */
+    childRequirements?: {
+        /** Message to show when this doesn't match, e.g. "Children of 'Columns' must be a 'Column'" */
+        message: string;
+        /** Simple way to say children must be a specific component name */
+        component?: string;
+        /**
+         * More advanced - specify a MongoDB-style query (using sift.js github.com/crcn/sift.js)
+         * of what the children objects should match, e.g.
+         *
+         * @example
+         *  query: {
+         *    // Child of this element must be a 'Button' or 'Text' component
+         *    'component.name': { $in: ['Button', 'Text'] }
+         *  }
+         */
+        query?: any;
+    };
+    /**
+     * Specify restrictions any parent must match
+     */
+    requiresParent?: {
+        /** Message to show when this doesn't match, e.g. "'Add to cart' buttons must be within a 'Product box'" */
+        message: string;
+        /** Simple way to say a parent must be a specific component name, e.g. 'Product box' */
+        component?: string;
+        /**
+         * More advanced - specify a MongoDB-style query (using sift.js github.com/crcn/sift.js)
+         * of what at least one parent in the parents hierarchy should match, e.g.
+         *
+         * @example
+         *  query: {
+         *    // Thils element must be somewhere inside either a 'Product box' or 'Collection' component
+         *    'component.name': { $in: ['Product Box', 'Collection'] }
+         *  }
+         */
+        query?: any;
+    };
+    /** not yet implemented */
+    friendlyName?: string;
+    /**
+     * Use to restrict access to your component based on a the current user permissions
+     * By default components will show to all users
+     * for more information on permissions in builder check https://www.builder.io/c/docs/guides/roles-and-permissions
+     */
+    requiredPermissions?: Array<Permission>;
+    hidden?: boolean;
+}
+declare type Permission = 'read' | 'publish' | 'editCode' | 'editDesigns' | 'admin' | 'create';
+export {};

package/types/types/deep-partial.d.ts

@@ -0,0 +1,3 @@
+export declare type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends Array<infer U> ? Array<DeepPartial<U>> : T[P] extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : DeepPartial<T[P]>;
+};

package/types/types/element.d.ts

@@ -0,0 +1,59 @@
+declare type JSONValue = string | number | boolean | JSONObject | JSONArray;
+interface JSONObject {
+    [x: string]: JSONValue;
+}
+interface JSONArray extends Array<JSONValue> {
+}
+/** @todo typedoc this */
+export interface BuilderElement {
+    '@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?: BuilderElement[];
+    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?: Animation[];
+}
+interface Animation {
+}
+export {};

package/types/types/targets.d.ts

@@ -0,0 +1,3 @@
+declare type MitosisTargets = import('@builder.io/mitosis').Target;
+export declare type Target = Extract<MitosisTargets, 'vue3' | 'vue2' | 'reactNative' | 'svelte'>;
+export {};

package/types/types/typescript.d.ts

@@ -0,0 +1,4 @@
+export declare type Nullable<T> = T | null | undefined;
+export declare type Dictionary<T> = {
+    [key: string]: T;
+};