@builder.io/sdk-vue 0.5.9 → 0.6.1-0

package/vue2/src/blocks/img/img.vue

@@ -0,0 +1,59 @@
+<template>
+  <img
+    :style="{
+      objectFit: backgroundSize || 'cover',
+      objectPosition: backgroundPosition || 'center',
+    }"
+    :key="(isEditing() && imgSrc) || 'default-key'"
+    :alt="altText"
+    :src="imgSrc || image"
+    v-bind="filterAttrs(attributes, 'v-on:', false)"
+    v-on="filterAttrs(attributes, 'v-on:', true)"
+  />
+</template>
+
+<script lang="ts">
+import { defineComponent } from "vue";
+
+import { isEditing } from "../../functions/is-editing.js";
+import { filterAttrs } from "../helpers.js";
+import { setAttrs } from "../helpers.js";
+
+/**
+ * This import is used by the Svelte SDK. Do not remove.
+ */ // eslint-disable-next-line unused-imports/no-unused-imports, @typescript-eslint/no-unused-vars
+export interface ImgProps {
+  attributes?: any;
+  imgSrc?: string; // TODO(misko): I think this is unused
+  image?: string;
+  altText?: string;
+  backgroundSize?: "cover" | "contain";
+  backgroundPosition?:
+    | "center"
+    | "top"
+    | "left"
+    | "right"
+    | "bottom"
+    | "top left"
+    | "top right"
+    | "bottom left"
+    | "bottom right";
+}
+
+export default defineComponent({
+  name: "builder-img-component",
+
+  props: [
+    "backgroundSize",
+    "backgroundPosition",
+    "imgSrc",
+    "altText",
+    "image",
+    "attributes",
+  ],
+
+  data() {
+    return { isEditing, filterAttrs };
+  },
+});
+</script>

package/vue2/src/blocks/input/component-info.ts

@@ -0,0 +1,47 @@
+import type { ComponentInfo } from '../../types/components.js';
+export const componentInfo: ComponentInfo = {
+  name: 'Form:Input',
+  image: 'https://cdn.builder.io/api/v1/image/assets%2FIsxPKMo2gPRRKeakUztj1D6uqed2%2Fad6f37889d9e40bbbbc72cdb5875d6ca',
+  inputs: [{
+    name: 'type',
+    type: 'text',
+    enum: ['text', 'number', 'email', 'url', 'checkbox', 'radio', 'range', 'date', 'datetime-local', 'search', 'tel', 'time', 'file', 'month', 'week', 'password', 'color', 'hidden'],
+    defaultValue: 'text'
+  }, {
+    name: 'name',
+    type: 'string',
+    required: true,
+    helperText: 'Every input in a form needs a unique name describing what it takes, e.g. "email"'
+  }, {
+    name: 'placeholder',
+    type: 'string',
+    defaultValue: 'Hello there',
+    helperText: 'Text to display when there is no value'
+  },
+  // TODO: handle value vs default value automatically like ng-model
+  {
+    name: 'defaultValue',
+    type: 'string'
+  }, {
+    name: 'value',
+    type: 'string',
+    advanced: true
+  }, {
+    name: 'required',
+    type: 'boolean',
+    helperText: 'Is this input required to be filled out to submit a form',
+    defaultValue: false
+  }],
+  noWrap: true,
+  static: true,
+  defaultStyles: {
+    paddingTop: '10px',
+    paddingBottom: '10px',
+    paddingLeft: '10px',
+    paddingRight: '10px',
+    borderRadius: '3px',
+    borderWidth: '1px',
+    borderStyle: 'solid',
+    borderColor: '#ccc'
+  }
+}

package/vue2/src/blocks/input/input.vue

@@ -0,0 +1,52 @@
+<template>
+  <input
+    :key="isEditing() && defaultValue ? defaultValue : 'default-key'"
+    :placeholder="placeholder"
+    :type="type"
+    :name="name"
+    :value="value"
+    :defaultValue="defaultValue"
+    :required="required"
+    v-bind="filterAttrs(attributes, 'v-on:', false)"
+    v-on="filterAttrs(attributes, 'v-on:', true)"
+  />
+</template>
+
+<script lang="ts">
+import { defineComponent } from "vue";
+
+import { isEditing } from "../../functions/is-editing.js";
+import { filterAttrs } from "../helpers.js";
+import { setAttrs } from "../helpers.js";
+
+/**
+ * This import is used by the Svelte SDK. Do not remove.
+ */ // eslint-disable-next-line unused-imports/no-unused-imports, @typescript-eslint/no-unused-vars
+export interface FormInputProps {
+  type?: string;
+  attributes?: any;
+  name?: string;
+  value?: string;
+  placeholder?: string;
+  defaultValue?: string;
+  required?: boolean;
+}
+
+export default defineComponent({
+  name: "builder-form-input-component",
+
+  props: [
+    "attributes",
+    "defaultValue",
+    "placeholder",
+    "type",
+    "name",
+    "value",
+    "required",
+  ],
+
+  data() {
+    return { isEditing, filterAttrs };
+  },
+});
+</script>

package/vue2/src/blocks/raw-text/component-info.ts

@@ -0,0 +1,11 @@
+import type { ComponentInfo } from '../../types/components.js';
+export const componentInfo: ComponentInfo = {
+  name: 'Builder:RawText',
+  hideFromInsertMenu: true,
+  inputs: [{
+    name: 'text',
+    bubble: true,
+    type: 'longText',
+    required: true
+  }]
+}

package/vue2/src/blocks/raw-text/raw-text.vue

@@ -0,0 +1,35 @@
+<template>
+  <span
+    v-html="text?.toString() || ''"
+    :class="_classStringToObject(attributes.class)"
+  ></span>
+</template>
+
+<script lang="ts">
+import { defineComponent } from "vue";
+
+export interface RawTextProps {
+  attributes?: any;
+  text?: string;
+}
+
+export default defineComponent({
+  name: "builder-raw-text",
+
+  props: ["text", "attributes"],
+
+  methods: {
+    _classStringToObject(str: string) {
+      const obj: Record<string, boolean> = {};
+      if (typeof str !== "string") {
+        return obj;
+      }
+      const classNames = str.trim().split(/\s+/);
+      for (const name of classNames) {
+        obj[name] = true;
+      }
+      return obj;
+    },
+  },
+});
+</script>

package/vue2/src/blocks/section/component-info.ts

@@ -0,0 +1,41 @@
+import type { ComponentInfo } from '../../types/components.js';
+export const componentInfo: ComponentInfo = {
+  name: 'Core:Section',
+  static: true,
+  image: 'https://cdn.builder.io/api/v1/image/assets%2FIsxPKMo2gPRRKeakUztj1D6uqed2%2F682efef23ace49afac61748dd305c70a',
+  inputs: [{
+    name: 'maxWidth',
+    type: 'number',
+    defaultValue: 1200
+  }, {
+    name: 'lazyLoad',
+    type: 'boolean',
+    defaultValue: false,
+    advanced: true,
+    description: 'Only render this section when in view'
+  }],
+  defaultStyles: {
+    paddingLeft: '20px',
+    paddingRight: '20px',
+    paddingTop: '50px',
+    paddingBottom: '50px',
+    marginTop: '0px',
+    width: '100vw',
+    marginLeft: 'calc(50% - 50vw)'
+  },
+  canHaveChildren: true,
+  defaultChildren: [{
+    '@type': '@builder.io/sdk:Element',
+    responsiveStyles: {
+      large: {
+        textAlign: 'center'
+      }
+    },
+    component: {
+      name: 'Text',
+      options: {
+        text: "<p><b>I am a section! My content keeps from getting too wide, so that it's easy to read even on big screens.</b></p><p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur</p>"
+      }
+    }
+  }]
+}

package/vue2/src/blocks/section/section.vue

@@ -0,0 +1,47 @@
+<template>
+  <section
+    :style="{
+      width: '100%',
+      alignSelf: 'stretch',
+      flexGrow: 1,
+      boxSizing: 'border-box',
+      maxWidth: maxWidth || 1200,
+      display: 'flex',
+      flexDirection: 'column',
+      alignItems: 'stretch',
+      marginLeft: 'auto',
+      marginRight: 'auto',
+    }"
+    v-bind="filterAttrs(attributes, 'v-on:', false)"
+    v-on="filterAttrs(attributes, 'v-on:', true)"
+  >
+    <slot />
+  </section>
+</template>
+
+<script lang="ts">
+import { defineComponent } from "vue";
+
+import { filterAttrs } from "../helpers.js";
+import { setAttrs } from "../helpers.js";
+
+/**
+ * This import is used by the Svelte SDK. Do not remove.
+ */ // eslint-disable-next-line unused-imports/no-unused-imports, @typescript-eslint/no-unused-vars
+export interface SectionProps {
+  maxWidth?: number;
+  attributes?: any;
+  children?: any;
+  builderBlock?: any;
+}
+
+export default defineComponent({
+  name: "builder-section-component",
+
+  props: ["attributes", "maxWidth"],
+
+  data() {
+    return { filterAttrs };
+  },
+});
+</script>

package/vue2/src/blocks/select/component-info.ts

@@ -0,0 +1,44 @@
+import type { ComponentInfo } from '../../types/components.js';
+export const componentInfo: ComponentInfo = {
+  name: 'Form:Select',
+  image: 'https://cdn.builder.io/api/v1/image/assets%2FIsxPKMo2gPRRKeakUztj1D6uqed2%2F83acca093fb24aaf94dee136e9a4b045',
+  defaultStyles: {
+    alignSelf: 'flex-start'
+  },
+  inputs: [{
+    name: 'options',
+    type: 'list',
+    required: true,
+    subFields: [{
+      name: 'value',
+      type: 'text',
+      required: true
+    }, {
+      name: 'name',
+      type: 'text'
+    }],
+    defaultValue: [{
+      value: 'option 1'
+    }, {
+      value: 'option 2'
+    }]
+  }, {
+    name: 'name',
+    type: 'string',
+    required: true,
+    helperText: 'Every select in a form needs a unique name describing what it gets, e.g. "email"'
+  }, {
+    name: 'defaultValue',
+    type: 'string'
+  }, {
+    name: 'value',
+    type: 'string',
+    advanced: true
+  }, {
+    name: 'required',
+    type: 'boolean',
+    defaultValue: false
+  }],
+  static: true,
+  noWrap: true
+}

package/vue2/src/blocks/select/select.vue

@@ -0,0 +1,50 @@
+<template>
+  <select
+    :value="value"
+    :key="isEditing() && defaultValue ? defaultValue : 'default-key'"
+    :defaultValue="defaultValue"
+    :name="name"
+    v-bind="filterAttrs(attributes, 'v-on:', false)"
+    v-on="filterAttrs(attributes, 'v-on:', true)"
+  >
+    <option
+      v-for="(option, index) in options"
+      :value="option.value"
+      :key="index"
+    >
+      {{ option.name || option.value }}
+    </option>
+  </select>
+</template>
+
+<script lang="ts">
+import { defineComponent } from "vue";
+
+import { isEditing } from "../../functions/is-editing.js";
+import { filterAttrs } from "../helpers.js";
+import { setAttrs } from "../helpers.js";
+
+/**
+ * This import is used by the Svelte SDK. Do not remove.
+ */ // eslint-disable-next-line unused-imports/no-unused-imports, @typescript-eslint/no-unused-vars
+export interface FormSelectProps {
+  options?: {
+    name?: string;
+    value: string;
+  }[];
+  attributes?: any;
+  name?: string;
+  value?: string;
+  defaultValue?: string;
+}
+
+export default defineComponent({
+  name: "builder-select-component",
+
+  props: ["attributes", "value", "defaultValue", "name", "options"],
+
+  data() {
+    return { isEditing, filterAttrs };
+  },
+});
+</script>

package/vue2/src/blocks/submit-button/component-info.ts

@@ -0,0 +1,27 @@
+import type { ComponentInfo } from '../../types/components.js';
+export const componentInfo: ComponentInfo = {
+  name: 'Form:SubmitButton',
+  image: 'https://cdn.builder.io/api/v1/image/assets%2FIsxPKMo2gPRRKeakUztj1D6uqed2%2Fdf2820ffed1f4349a94c40b3221f5b98',
+  defaultStyles: {
+    appearance: 'none',
+    paddingTop: '15px',
+    paddingBottom: '15px',
+    paddingLeft: '25px',
+    paddingRight: '25px',
+    backgroundColor: '#3898EC',
+    color: 'white',
+    borderRadius: '4px',
+    cursor: 'pointer'
+  },
+  inputs: [{
+    name: 'text',
+    type: 'text',
+    defaultValue: 'Click me'
+  }],
+  static: true,
+  noWrap: true
+  // TODO: optional children? maybe as optional form input
+  // that only shows if advanced setting is flipped
+  // TODO: defaultChildren
+  // canHaveChildren: true,
+}

package/vue2/src/blocks/submit-button/submit-button.vue

@@ -0,0 +1,34 @@
+<template>
+  <button
+    type="submit"
+    v-bind="filterAttrs(attributes, 'v-on:', false)"
+    v-on="filterAttrs(attributes, 'v-on:', true)"
+  >
+    {{ text }}
+  </button>
+</template>
+
+<script lang="ts">
+import { defineComponent } from "vue";
+
+import { filterAttrs } from "../helpers.js";
+import { setAttrs } from "../helpers.js";
+
+/**
+ * This import is used by the Svelte SDK. Do not remove.
+ */ // eslint-disable-next-line unused-imports/no-unused-imports, @typescript-eslint/no-unused-vars
+export interface ButtonProps {
+  attributes?: any;
+  text?: string;
+}
+
+export default defineComponent({
+  name: "builder-submit-button",
+
+  props: ["attributes", "text"],
+
+  data() {
+    return { filterAttrs };
+  },
+});
+</script>

package/vue2/src/blocks/symbol/component-info.ts

@@ -0,0 +1,35 @@
+import type { ComponentInfo } from '../../types/components.js';
+export const componentInfo: ComponentInfo = {
+  name: 'Symbol',
+  noWrap: true,
+  static: true,
+  isRSC: true,
+  inputs: [{
+    name: 'symbol',
+    type: 'uiSymbol'
+  }, {
+    name: 'dataOnly',
+    helperText: "Make this a data symbol that doesn't display any UI",
+    type: 'boolean',
+    defaultValue: false,
+    advanced: true,
+    hideFromUI: true
+  }, {
+    name: 'inheritState',
+    helperText: 'Inherit the parent component state and data',
+    type: 'boolean',
+    defaultValue: false,
+    advanced: true
+  }, {
+    name: 'renderToLiquid',
+    helperText: 'Render this symbols contents to liquid. Turn off to fetch with javascript and use custom targeting',
+    type: 'boolean',
+    defaultValue: false,
+    advanced: true,
+    hideFromUI: true
+  }, {
+    name: 'useChildren',
+    hideFromUI: true,
+    type: 'boolean'
+  }]
+}

package/vue2/src/blocks/symbol/symbol.helpers.ts

@@ -0,0 +1,47 @@
+import type { BuilderContextInterface } from '../../context/types.js';
+import { logger } from '../../helpers/logger.js';
+import { fetchOneEntry } from '../../index.js';
+import type { BuilderContent } from '../../types/builder-content.js';
+export interface SymbolInfo {
+  model?: string;
+  entry?: string;
+  data?: any;
+  content?: BuilderContent;
+  inline?: boolean;
+  dynamic?: boolean;
+}
+export const fetchSymbolContent = async ({
+  builderContextValue,
+  symbol
+}: {
+  symbol: SymbolInfo | undefined;
+  builderContextValue: BuilderContextInterface;
+}) => {
+  /**
+   * If:
+   * - we have a symbol prop
+   * - yet it does not have any content
+   * - and we have not already stored content from before
+   * - and it has a model name
+   *
+   * then we want to re-fetch the symbol content.
+   */
+  if (symbol?.model &&
+  // This is a hack, we should not need to check for this, but it is needed for Svelte.
+  builderContextValue?.apiKey) {
+    return fetchOneEntry({
+      model: symbol.model,
+      apiKey: builderContextValue.apiKey,
+      apiVersion: builderContextValue.apiVersion,
+      ...(symbol?.entry && {
+        query: {
+          id: symbol.entry
+        }
+      })
+    }).catch(err => {
+      logger.error('Could not fetch symbol content: ', err);
+      return undefined;
+    });
+  }
+  return undefined;
+}

package/vue2/src/blocks/symbol/symbol.vue

@@ -0,0 +1,143 @@
+<template>
+  <div
+    :class="_classStringToObject(className)"
+    v-bind="{ ...filterAttrs(attributes, 'v-on:', false), ...{} }"
+    v-on="filterAttrs(attributes, 'v-on:', true)"
+  >
+    <content-variants
+      :__isNestedRender="true"
+      :apiVersion="builderContext.apiVersion"
+      :apiKey="builderContext.apiKey"
+      :context="builderContext.context"
+      :customComponents="Object.values(builderComponents)"
+      :data="{
+        ...symbol?.data,
+        ...builderContext.localState,
+        ...contentToUse?.data?.state,
+      }"
+      :model="symbol?.model"
+      :content="contentToUse"
+    ></content-variants>
+  </div>
+</template>
+
+<script lang="ts">
+import { defineComponent } from "vue";
+
+const ContentVariants = () =>
+  import("../../components/content-variants/content-variants.vue")
+    .then((x) => x.default)
+    .catch((err) => {
+      console.error(
+        "Error while attempting to dynamically import component ContentVariants at ../../components/content-variants/content-variants.vue",
+        err
+      );
+      throw err;
+    });
+import type { BuilderContent } from "../../types/builder-content.js";
+import type {
+  BuilderComponentsProp,
+  PropsWithBuilderData,
+} from "../../types/builder-props.js";
+import { filterAttrs } from "../helpers.js";
+import { setAttrs } from "../helpers.js";
+import { fetchSymbolContent } from "./symbol.helpers.js";
+import type { Nullable } from "../../types/typescript.js";
+
+/**
+ * This import is used by the Svelte SDK. Do not remove.
+ */ // eslint-disable-next-line unused-imports/no-unused-imports, @typescript-eslint/no-unused-vars
+export interface SymbolInfo {
+  model?: string;
+  entry?: string;
+  data?: any;
+  content?: BuilderContent;
+  inline?: boolean;
+  dynamic?: boolean;
+}
+/**
+ * This import is used by the Svelte SDK. Do not remove.
+ */ // eslint-disable-next-line unused-imports/no-unused-imports, @typescript-eslint/no-unused-vars
+export interface SymbolProps extends BuilderComponentsProp {
+  symbol?: SymbolInfo;
+  dataOnly?: boolean;
+  dynamic?: boolean;
+  attributes?: any;
+  inheritState?: boolean;
+}
+
+export default defineComponent({
+  name: "builder-symbol",
+  components: { "content-variants": ContentVariants },
+  props: [
+    "js",
+    "attributes",
+    "symbol",
+    "dynamic",
+    "builderContext",
+    "builderComponents",
+  ],
+
+  data() {
+    return { contentToUse: this.symbol?.content, filterAttrs };
+  },
+
+  mounted() {
+    this.setContent();
+  },
+
+  watch: {
+    onUpdateHook0: {
+      handler() {
+        this.setContent();
+      },
+      immediate: true,
+    },
+  },
+
+  computed: {
+    className() {
+      return [
+        ...Object.keys(this.attributes.class),
+        "builder-symbol",
+        this.symbol?.inline ? "builder-inline-symbol" : undefined,
+        this.symbol?.dynamic || this.dynamic
+          ? "builder-dynamic-symbol"
+          : undefined,
+      ]
+        .filter(Boolean)
+        .join(" ");
+    },
+    onUpdateHook0() {
+      return {
+        0: this.symbol,
+      };
+    },
+  },
+
+  methods: {
+    setContent() {
+      if (this.contentToUse) return;
+      fetchSymbolContent({
+        symbol: this.symbol,
+        builderContextValue: this.builderContext,
+      }).then((newContent) => {
+        if (newContent) {
+          this.contentToUse = newContent;
+        }
+      });
+    },
+    _classStringToObject(str: string) {
+      const obj: Record<string, boolean> = {};
+      if (typeof str !== "string") {
+        return obj;
+      }
+      const classNames = str.trim().split(/\s+/);
+      for (const name of classNames) {
+        obj[name] = true;
+      }
+      return obj;
+    },
+  },
+});
+</script>