@builder.io/sdk-vue 0.7.1-1 → 0.7.1

package/vue3/lib/edge/functions/get-content/index.d.ts

@@ -1,28 +0,0 @@
-import type { BuilderContent } from '../../types/builder-content.js';
-import type { GetContentOptions } from './types.js';
-/**
- * Returns a the first entry that matches the given options.
- */
-export declare function fetchOneEntry(options: GetContentOptions): Promise<BuilderContent | null>;
-/**
- * @deprecated `getContent` was renamed to `fetchOneEntry`. This is a temporary alias to avoid breaking changes.
- *
- * NOTE: consider using `fetchBuilderProps` instead for easier setup.
- */
-export declare const getContent: typeof fetchOneEntry;
-type ContentResults = {
-    results: BuilderContent[];
-};
-/**
- * @internal Exported only for testing purposes. Do not use.
- */
-export declare const _processContentResult: (options: GetContentOptions, content: ContentResults, url?: URL) => Promise<ContentResults>;
-/**
- * Returns a paginated array of entries that match the given options.
- */
-export declare function fetchEntries(options: GetContentOptions): Promise<ContentResults | null>;
-/**
- * @deprecated `getAllContent` was renamed to `fetchEntries`. This is a temporary alias to avoid breaking changes.
- */
-export declare const getAllContent: typeof fetchEntries;
-export {};

package/vue3/lib/edge/functions/get-content/types.d.ts

@@ -1,142 +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;
-    /**
-     * Use to specify an offset for pagination of results. The default is 0.
-     */
-    offset?: number;
-    /**
-     * User attribute key value pairs to be used for targeting
-     * https://www.builder.io/c/docs/custom-targeting-attributes
-     *
-     * e.g.
-     * ```js
-     * userAttributes: {
-     *   urlPath: '/',
-     *   returnVisitor: true,
-     *   device: 'mobile'
-     * }
-     * ```
-     */
-    userAttributes?: (Record<string, string> & {
-        urlPath?: string;
-    }) | null;
-    /**
-     * Mongodb style query of your data. E.g.:
-     *
-     * ```js
-     * query: {
-     *  id: 'abc123',
-     *  data: {
-     *    myCustomField: { $gt: 20 },
-     *  }
-     * }
-     * ```
-     *
-     * See more info on MongoDB's query operators and format.
-     *
-     * @see {@link https://docs.mongodb.com/manual/reference/operator/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 content of 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';
-    /**
-     * Only include these fields.
-     * Note: 'omit' takes precedence over 'fields'
-     *
-     * @example
-     * ```
-     * fields: 'id, name, data.customField'
-     * ```
-     */
-    fields?: string;
-    /**
-     * Omit only these fields.
-     * Note: 'omit' takes precedence over 'fields'
-     *
-     * @example
-     * ```
-     * omit: 'data.bigField,data.blocks'
-     * ```
-     */
-    omit?: string;
-    /**
-     * Seconds to cache content. Sets the max-age of the cache-control header
-     * response header.
-     *
-     * Use a higher value for better performance, lower for content that will change more frequently
-     *
-     * @see {@link https://www.builder.io/c/docs/query-api#__next:~:text=%26includeRefs%3Dtrue-,cacheSeconds,-No}
-     */
-    cacheSeconds?: number;
-    /**
-     * Builder.io uses stale-while-revalidate caching at the CDN level. This means we always serve
-     * from edge cache and update caches in the background for maximum possible performance. This also
-     * means that the more frequently content is requested, the more fresh it will be. The longest we
-     * will ever hold something in stale cache is 1 day by default, and you can set this to be shorter
-     * yourself as well. We suggest keeping this high unless you have content that must change rapidly
-     * and gets very little traffic.
-     *
-     * @see {@link https://www.fastly.com/blog/prevent-application-network-instability-serve-stale-content}
-     */
-    staleCacheSeconds?: number;
-    /**
-     * Property to order results by.
-     * Use 1 for ascending and -1 for descending.
-     *
-     * The key is what you're sorting on, so the following example sorts by createdDate
-     * and because the value is 1, the sort is ascending.
-     *
-     * @example
-     * ```
-     * createdDate: 1
-     * ```
-     */
-    sort?: {
-        [key: string]: 1 | -1;
-    };
-    /**
-     * Include content entries in a response that are still in
-     * draft mode and un-archived. Default is false.
-     */
-    includeUnpublished?: boolean;
-}

package/vue3/lib/edge/functions/get-fetch.d.ts

@@ -1 +0,0 @@
-export declare const fetch: any;

package/vue3/lib/edge/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/vue3/lib/edge/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/vue3/lib/edge/functions/is-browser.d.ts

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

package/vue3/lib/edge/functions/is-edge-runtime.d.ts

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

package/vue3/lib/edge/functions/is-editing.d.ts

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

package/vue3/lib/edge/functions/is-iframe.d.ts

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

package/vue3/lib/edge/functions/is-node-runtime.d.ts

@@ -1,4 +0,0 @@
-/**
- * Identifies node runtime
- */
-export declare function isNodeRuntime(): boolean;

package/vue3/lib/edge/functions/is-previewing.d.ts

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

package/vue3/lib/edge/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/vue3/lib/edge/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/vue3/lib/edge/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/vue3/lib/edge/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/vue3/lib/edge/functions/set-editor-settings.d.ts

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

package/vue3/lib/edge/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/vue3/lib/edge/functions/track/helpers.d.ts

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

package/vue3/lib/edge/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/vue3/lib/edge/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/vue3/lib/edge/functions/transform-block-properties.d.ts

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

package/vue3/lib/edge/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/vue3/lib/edge/get-block-actions.407fbfa9.cjs

@@ -1 +0,0 @@
-"use strict";const o=require("./index.8bdc4716.cjs");function i(e){const t={};if(typeof e!="string")return t;const r=e.trim().split(/\\s+/);for(const s of r)t[s]=!0;return t}function l(e){return e.class=i(e.class),e}const u=e=>({href:e.href});function f({block:e,context:t}){var s;const r={...u(e),...e.properties,"builder-id":e.id,style:e.style?v(e.style):void 0,class:[e.id,"builder-block",e.class,(s=e.properties)==null?void 0:s.class].filter(Boolean).join(" ")};return l(r)}function v(e){switch(o.TARGET){case"svelte":case"vue2":case"vue3":case"solid":return o.convertStyleMapToCSSArray(e).join(" ");case"qwik":case"reactNative":case"react":case"rsc":return e}}const d=e=>`v-on:${e.toLowerCase()}`,p=(e,t)=>r=>o.evaluate({code:e,context:t.context,localState:t.localState,rootState:t.rootState,rootSetState:t.rootSetState,event:r,isExpression:!1});function S(e){var s;const t={},r=(s=e.block.actions)!=null?s:{};for(const n in r){if(!r.hasOwnProperty(n))continue;const a=r[n];let c=d(n);if(e.stripPrefix)switch(o.TARGET){case"vue2":case"vue3":c=c.replace("v-on:","");break;case"svelte":c=c.replace("on:","");break}t[c]=p(a,e)}return t}exports.getBlockActions=S;exports.getBlockProperties=f;

package/vue3/lib/edge/get-block-actions.b460cca3.js

@@ -1,79 +0,0 @@
-import { T as n, c as i, e as l } from "./index.a8ffb479.js";
-function u(e) {
-  const t = {};
-  if (typeof e != "string")
-    return t;
-  const r = e.trim().split(/\\s+/);
-  for (const s of r)
-    t[s] = !0;
-  return t;
-}
-function f(e) {
-  return e.class = u(e.class), e;
-}
-const v = (e) => ({
-  href: e.href
-});
-function y({
-  block: e,
-  context: t
-}) {
-  var s;
-  const r = {
-    ...v(e),
-    ...e.properties,
-    "builder-id": e.id,
-    style: e.style ? p(e.style) : void 0,
-    class: [e.id, "builder-block", e.class, (s = e.properties) == null ? void 0 : s.class].filter(Boolean).join(" ")
-  };
-  return f(r);
-}
-function p(e) {
-  switch (n) {
-    case "svelte":
-    case "vue2":
-    case "vue3":
-    case "solid":
-      return i(e).join(" ");
-    case "qwik":
-    case "reactNative":
-    case "react":
-    case "rsc":
-      return e;
-  }
-}
-const S = (e) => `v-on:${e.toLowerCase()}`, d = (e, t) => (r) => l({
-  code: e,
-  context: t.context,
-  localState: t.localState,
-  rootState: t.rootState,
-  rootSetState: t.rootSetState,
-  event: r,
-  isExpression: !1
-});
-function g(e) {
-  var s;
-  const t = {}, r = (s = e.block.actions) != null ? s : {};
-  for (const o in r) {
-    if (!r.hasOwnProperty(o))
-      continue;
-    const c = r[o];
-    let a = S(o);
-    if (e.stripPrefix)
-      switch (n) {
-        case "vue2":
-        case "vue3":
-          a = a.replace("v-on:", "");
-          break;
-        case "svelte":
-          a = a.replace("on:", "");
-          break;
-      }
-    t[a] = d(c, e);
-  }
-  return t;
-}
-export {
-  y as a,
-  g
-};

package/vue3/lib/edge/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/vue3/lib/edge/helpers/canTrack.d.ts

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

package/vue3/lib/edge/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/vue3/lib/edge/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/vue3/lib/edge/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/vue3/lib/edge/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/vue3/lib/edge/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/vue3/lib/edge/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/vue3/lib/edge/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/vue3/lib/edge/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/vue3/lib/edge/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/vue3/lib/edge/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/vue3/lib/edge/helpers/time.d.ts

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

package/vue3/lib/edge/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/vue3/lib/edge/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/vue3/lib/edge/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;