@builder.io/sdk-svelte 3.0.0 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (97) hide show
  1. package/lib/browser/blocks/image/component-info.js +2 -1
  2. package/lib/browser/blocks/image/image.svelte +2 -1
  3. package/lib/browser/blocks/img/component-info.js +2 -1
  4. package/lib/browser/blocks/video/component-info.js +3 -2
  5. package/lib/browser/components/block/block.helpers.d.ts +6 -3
  6. package/lib/browser/components/block/block.helpers.js +16 -5
  7. package/lib/browser/components/block/block.svelte +2 -1
  8. package/lib/browser/components/content/components/enable-editor.helpers.d.ts +11 -0
  9. package/lib/browser/components/content/components/enable-editor.helpers.js +15 -0
  10. package/lib/browser/components/content/components/enable-editor.svelte +24 -3
  11. package/lib/browser/components/content/content.svelte +4 -15
  12. package/lib/browser/components/content/content.svelte.d.ts +1 -1
  13. package/lib/browser/constants/file-types.d.ts +2 -0
  14. package/lib/browser/constants/file-types.js +2 -0
  15. package/lib/browser/constants/sdk-version.d.ts +1 -1
  16. package/lib/browser/constants/sdk-version.js +1 -1
  17. package/lib/browser/context/builder.context.d.ts +1 -0
  18. package/lib/browser/context/builder.context.js +1 -0
  19. package/lib/browser/context/types.d.ts +1 -0
  20. package/lib/browser/functions/extract-localized-values.d.ts +2 -0
  21. package/lib/browser/functions/extract-localized-values.js +37 -0
  22. package/lib/browser/functions/get-processed-block.js +3 -1
  23. package/lib/browser/functions/register-component.js +4 -1
  24. package/lib/browser/functions/traverse.d.ts +34 -0
  25. package/lib/browser/functions/traverse.js +63 -0
  26. package/lib/browser/types/components.d.ts +3 -0
  27. package/lib/edge/blocks/image/component-info.js +2 -1
  28. package/lib/edge/blocks/image/image.svelte +2 -1
  29. package/lib/edge/blocks/img/component-info.js +2 -1
  30. package/lib/edge/blocks/video/component-info.js +3 -2
  31. package/lib/edge/components/block/block.helpers.d.ts +6 -3
  32. package/lib/edge/components/block/block.helpers.js +16 -5
  33. package/lib/edge/components/block/block.svelte +2 -1
  34. package/lib/edge/components/content/components/enable-editor.helpers.d.ts +11 -0
  35. package/lib/edge/components/content/components/enable-editor.helpers.js +15 -0
  36. package/lib/edge/components/content/components/enable-editor.svelte +24 -3
  37. package/lib/edge/components/content/content.svelte +4 -15
  38. package/lib/edge/components/content/content.svelte.d.ts +1 -1
  39. package/lib/edge/constants/file-types.d.ts +2 -0
  40. package/lib/edge/constants/file-types.js +2 -0
  41. package/lib/edge/constants/sdk-version.d.ts +1 -1
  42. package/lib/edge/constants/sdk-version.js +1 -1
  43. package/lib/edge/context/builder.context.d.ts +1 -0
  44. package/lib/edge/context/builder.context.js +1 -0
  45. package/lib/edge/context/types.d.ts +1 -0
  46. package/lib/edge/functions/extract-localized-values.d.ts +2 -0
  47. package/lib/edge/functions/extract-localized-values.js +37 -0
  48. package/lib/edge/functions/get-processed-block.js +3 -1
  49. package/lib/edge/functions/register-component.js +4 -1
  50. package/lib/edge/functions/traverse.d.ts +34 -0
  51. package/lib/edge/functions/traverse.js +63 -0
  52. package/lib/edge/types/components.d.ts +3 -0
  53. package/lib/node/blocks/image/component-info.js +2 -1
  54. package/lib/node/blocks/image/image.svelte +2 -1
  55. package/lib/node/blocks/img/component-info.js +2 -1
  56. package/lib/node/blocks/video/component-info.js +3 -2
  57. package/lib/node/components/block/block.helpers.d.ts +6 -3
  58. package/lib/node/components/block/block.helpers.js +16 -5
  59. package/lib/node/components/block/block.svelte +2 -1
  60. package/lib/node/components/content/components/enable-editor.helpers.d.ts +11 -0
  61. package/lib/node/components/content/components/enable-editor.helpers.js +15 -0
  62. package/lib/node/components/content/components/enable-editor.svelte +24 -3
  63. package/lib/node/components/content/content.svelte +4 -15
  64. package/lib/node/components/content/content.svelte.d.ts +1 -1
  65. package/lib/node/constants/file-types.d.ts +2 -0
  66. package/lib/node/constants/file-types.js +2 -0
  67. package/lib/node/constants/sdk-version.d.ts +1 -1
  68. package/lib/node/constants/sdk-version.js +1 -1
  69. package/lib/node/context/builder.context.d.ts +1 -0
  70. package/lib/node/context/builder.context.js +1 -0
  71. package/lib/node/context/types.d.ts +1 -0
  72. package/lib/node/functions/extract-localized-values.d.ts +2 -0
  73. package/lib/node/functions/extract-localized-values.js +37 -0
  74. package/lib/node/functions/get-processed-block.js +3 -1
  75. package/lib/node/functions/register-component.js +4 -1
  76. package/lib/node/functions/traverse.d.ts +34 -0
  77. package/lib/node/functions/traverse.js +63 -0
  78. package/lib/node/types/components.d.ts +3 -0
  79. package/package.json +1 -1
  80. package/src/blocks/image/component-info.ts +2 -1
  81. package/src/blocks/image/image.svelte +4 -1
  82. package/src/blocks/img/component-info.ts +2 -1
  83. package/src/blocks/video/component-info.ts +3 -2
  84. package/src/components/block/block.helpers.ts +18 -6
  85. package/src/components/block/block.svelte +6 -1
  86. package/src/components/content/components/enable-editor.helpers.ts +18 -0
  87. package/src/components/content/components/enable-editor.svelte +27 -3
  88. package/src/components/content/content.svelte +4 -11
  89. package/src/constants/file-types.ts +2 -0
  90. package/src/constants/sdk-version.ts +1 -1
  91. package/src/context/builder.context.ts +1 -0
  92. package/src/context/types.ts +1 -0
  93. package/src/functions/extract-localized-values.ts +38 -0
  94. package/src/functions/get-processed-block.ts +3 -1
  95. package/src/functions/register-component.ts +4 -1
  96. package/src/functions/traverse.ts +64 -0
  97. package/src/types/components.ts +3 -0
@@ -18,6 +18,7 @@ import { createEditorListener } from "../../../helpers/subscribe-to-editor";
18
18
  import { registerInsertMenu, setupBrowserForEditing, } from "../../../scripts/init-editing";
19
19
  import { triggerAnimation } from "../../block/animator";
20
20
  import "../../dynamic-div.svelte";
21
+ import { needsElementRefDivForEditing } from "./enable-editor.helpers";
21
22
  import { getWrapperClassName } from "./styles.helpers";
22
23
  export let isNestedRender = undefined;
23
24
  export let builderContextSignal;
@@ -34,6 +35,16 @@ export let showContent;
34
35
  export let contentWrapper = undefined;
35
36
  export let context = undefined;
36
37
  export let contentWrapperProps = undefined;
38
+ function stringifyStyles(stylesObj) {
39
+ let styles = "";
40
+ for (let key in stylesObj) {
41
+ const dashedKey = key.replace(/[A-Z]/g, function (match) {
42
+ return "-" + match.toLowerCase();
43
+ });
44
+ styles += dashedKey + ":" + stylesObj[key] + ";";
45
+ }
46
+ return styles;
47
+ }
37
48
  function mergeNewRootState(newData) {
38
49
  const combinedState = {
39
50
  ...$builderContextSignal.rootState,
@@ -178,8 +189,12 @@ function elementRef_onIniteditingbldr(event) {
178
189
  : {}),
179
190
  });
180
191
  Object.values($builderContextSignal.componentInfos).forEach((registeredComponent) => {
181
- const message = createRegisterComponentMessage(registeredComponent);
182
- window.parent?.postMessage(message, "*");
192
+ if (!model ||
193
+ !registeredComponent.models?.length ||
194
+ registeredComponent.models.includes(model)) {
195
+ const message = createRegisterComponentMessage(registeredComponent);
196
+ window.parent?.postMessage(message, "*");
197
+ }
183
198
  });
184
199
  window.addEventListener("builder:component:stateChangeListenerActivated", emitStateUpdate);
185
200
  }
@@ -293,9 +308,15 @@ onDestroy(() => {
293
308
  });
294
309
  </script>
295
310
 
296
- {#if $builderContextSignal.content}
311
+ {#if $builderContextSignal.content || needsElementRefDivForEditing()}
297
312
  <svelte:element
298
313
  this={ContentWrapper}
314
+ style={stringifyStyles({
315
+ display:
316
+ !$builderContextSignal.content && needsElementRefDivForEditing()
317
+ ? "none"
318
+ : undefined,
319
+ })}
299
320
  {...{}}
300
321
  bind:this={elementRef}
301
322
  on:click={(event) => {
@@ -18,7 +18,6 @@ export let apiKey;
18
18
  export let context = undefined;
19
19
  export let content = undefined;
20
20
  export let customComponents = undefined;
21
- export let model = undefined;
22
21
  export let data = undefined;
23
22
  export let locale = undefined;
24
23
  export let canTrack = undefined;
@@ -26,6 +25,7 @@ export let apiVersion = undefined;
26
25
  export let blocksWrapper = undefined;
27
26
  export let blocksWrapperProps = undefined;
28
27
  export let nonce = undefined;
28
+ export let model = undefined;
29
29
  export let apiHost = undefined;
30
30
  export let enrich = undefined;
31
31
  export let showContent;
@@ -46,13 +46,7 @@ let scriptStr = getUpdateVariantVisibilityScript({
46
46
  });
47
47
  let registeredComponents = [
48
48
  ...getDefaultRegisteredComponents(),
49
- ...(customComponents?.filter(({ models }) => {
50
- if (!models?.length)
51
- return true;
52
- if (!model)
53
- return true;
54
- return models.includes(model);
55
- }) || []),
49
+ ...(customComponents || []),
56
50
  ].reduce((acc, { component, ...info }) => ({
57
51
  ...acc,
58
52
  [info.name]: {
@@ -78,13 +72,7 @@ let builderContextSignal = writable({
78
72
  apiVersion: apiVersion,
79
73
  componentInfos: [
80
74
  ...getDefaultRegisteredComponents(),
81
- ...(customComponents?.filter(({ models }) => {
82
- if (!models?.length)
83
- return true;
84
- if (!model)
85
- return true;
86
- return models.includes(model);
87
- }) || []),
75
+ ...(customComponents || []),
88
76
  ].reduce((acc, { component: _, ...info }) => ({
89
77
  ...acc,
90
78
  [info.name]: serializeIncludingFunctions(info),
@@ -93,6 +81,7 @@ let builderContextSignal = writable({
93
81
  BlocksWrapper: blocksWrapper || "div",
94
82
  BlocksWrapperProps: blocksWrapperProps || {},
95
83
  nonce: nonce || "",
84
+ model: model || "",
96
85
  });
97
86
  if (!apiKey) {
98
87
  logger.error("No API key provided to `Content` component. This can cause issues. Please provide an API key using the `apiKey` prop.");
@@ -6,7 +6,6 @@ declare const __propDef: {
6
6
  context?: ContentProps["context"];
7
7
  content?: ContentProps["content"];
8
8
  customComponents?: ContentProps["customComponents"];
9
- model?: ContentProps["model"];
10
9
  data?: ContentProps["data"];
11
10
  locale?: ContentProps["locale"];
12
11
  canTrack?: ContentProps["canTrack"];
@@ -14,6 +13,7 @@ declare const __propDef: {
14
13
  blocksWrapper?: ContentProps["blocksWrapper"];
15
14
  blocksWrapperProps?: ContentProps["blocksWrapperProps"];
16
15
  nonce?: ContentProps["nonce"];
16
+ model?: ContentProps["model"];
17
17
  apiHost?: ContentProps["apiHost"];
18
18
  enrich?: ContentProps["enrich"];
19
19
  showContent: ContentProps["showContent"];
@@ -0,0 +1,2 @@
1
+ export declare const IMAGE_FILE_TYPES: string[];
2
+ export declare const VIDEO_FILE_TYPES: string[];
@@ -0,0 +1,2 @@
1
+ export const IMAGE_FILE_TYPES = ['jpeg', 'jpg', 'png', 'svg', 'webp', 'gif', 'jfif', 'pjpeg', 'pjp', 'apng', 'avif', 'tif', 'tiff', 'heif', 'bmp', 'eps', 'raw', 'cr2', 'nef', 'orf', 'sr2', 'psd', 'heic', 'dib', 'ai'];
2
+ export const VIDEO_FILE_TYPES = ['mp4', 'webm', 'mkv', 'flv', 'vob', 'ogv', 'ogg', 'drc', 'gif', 'gifv', 'mng', 'avi', 'mov', 'qt', 'mts', 'm2ts', 'ts', 'wmv', 'yuv', 'rm', 'rmvb', 'viv', 'asf', 'amv', 'm4p', 'mpeg', 'mpe', 'm2v', 'm4v', 'svi', '3gp', '3g2', 'mxf', 'roq', 'nsv', 'f4v', 'f4p', 'f4a', 'f4b'];
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "3.0.0";
1
+ export declare const SDK_VERSION = "3.0.1";
@@ -1 +1 @@
1
- export const SDK_VERSION = "3.0.0";
1
+ export const SDK_VERSION = "3.0.1";
@@ -13,6 +13,7 @@ declare const _default: {
13
13
  BlocksWrapper: string;
14
14
  BlocksWrapperProps: {};
15
15
  nonce: string;
16
+ model: string;
16
17
  }>;
17
18
  key: symbol;
18
19
  };
@@ -14,6 +14,7 @@ export default {
14
14
  BlocksWrapper: "div",
15
15
  BlocksWrapperProps: {},
16
16
  nonce: "",
17
+ model: "",
17
18
  }),
18
19
  key,
19
20
  };
@@ -36,5 +36,6 @@ export interface BuilderContextInterface extends Pick<BlocksWrapperProps, 'Block
36
36
  componentInfos: Dictionary<ComponentInfo>;
37
37
  inheritedStyles: Record<string, unknown>;
38
38
  nonce: string;
39
+ model: string;
39
40
  canTrack?: boolean;
40
41
  }
@@ -0,0 +1,2 @@
1
+ import type { BuilderBlock } from '../types/builder-block';
2
+ export declare function resolveLocalizedValues(block: BuilderBlock, locale: string | undefined): BuilderBlock;
@@ -0,0 +1,37 @@
1
+ import { traverse } from './traverse';
2
+ function isLocalizedField(value) {
3
+ return value && typeof value === 'object' && value['@type'] === '@builder.io/core:LocalizedValue';
4
+ }
5
+ function containsLocalizedValues(data) {
6
+ if (!data || !Object.getOwnPropertyNames(data).length) {
7
+ return false;
8
+ }
9
+ let hasLocalizedValues = false;
10
+ traverse(data, value => {
11
+ if (isLocalizedField(value)) {
12
+ hasLocalizedValues = true;
13
+ return;
14
+ }
15
+ });
16
+ return hasLocalizedValues;
17
+ }
18
+ function extractLocalizedValues(data, locale) {
19
+ if (!data || !Object.getOwnPropertyNames(data).length) {
20
+ return {};
21
+ }
22
+ traverse(data, (value, update) => {
23
+ if (isLocalizedField(value)) {
24
+ update(value[locale] ?? undefined);
25
+ }
26
+ });
27
+ return data;
28
+ }
29
+ export function resolveLocalizedValues(block, locale) {
30
+ if (block.component?.options && containsLocalizedValues(block.component?.options)) {
31
+ if (!locale) {
32
+ console.warn('[Builder.io] In order to use localized fields in Builder, you must pass a locale prop to the BuilderComponent or to options object while fetching the content to resolve localized fields. Learn more: https://www.builder.io/c/docs/localization-inline#targeting-and-inline-localization');
33
+ }
34
+ block.component.options = extractLocalizedValues(block.component.options, locale ?? 'Default');
35
+ }
36
+ return block;
37
+ }
@@ -1,6 +1,7 @@
1
1
  import { TARGET } from '../constants/target';
2
2
  import { omit } from '../helpers/omit';
3
3
  import { evaluate } from './evaluate/index';
4
+ import { resolveLocalizedValues } from './extract-localized-values';
4
5
  import { fastClone } from './fast-clone';
5
6
  import { set } from './set';
6
7
  import { transformBlock } from './transform-block';
@@ -72,7 +73,8 @@ const evaluateBindings = ({ block, context, localState, rootState, rootSetState
72
73
  return copied;
73
74
  };
74
75
  export function getProcessedBlock({ block, context, shouldEvaluateBindings, localState, rootState, rootSetState }) {
75
- const transformedBlock = transformBlock(block);
76
+ let transformedBlock = resolveLocalizedValues(block, rootState.locale);
77
+ transformedBlock = transformBlock(transformedBlock);
76
78
  if (shouldEvaluateBindings) {
77
79
  return evaluateBindings({
78
80
  block: transformedBlock,
@@ -10,8 +10,11 @@ const serializeFn = (fnValue) => {
10
10
  // 2. `name(args) => {code}`
11
11
  // 3. `(args) => {}`
12
12
  // 4. `args => {}`
13
+ // 5. `async function(args) {code}`
14
+ // 6. `async (args) => {}`
15
+ // 7. `async args => {}`
13
16
  const isArrowWithoutParens = /^[a-zA-Z0-9_]+\s*=>/i.test(fnStr);
14
- const appendFunction = !fnStr.startsWith('function') && !fnStr.startsWith('(') && !isArrowWithoutParens;
17
+ const appendFunction = !fnStr.startsWith('function') && !fnStr.startsWith('async') && !fnStr.startsWith('(') && !isArrowWithoutParens;
15
18
  return `return (${appendFunction ? 'function ' : ''}${fnStr}).apply(this, arguments)`;
16
19
  };
17
20
  export function serializeIncludingFunctions(info) {
@@ -0,0 +1,34 @@
1
+ type TraverseCallback = (value: any, update: (newValue: any) => void) => void;
2
+ /**
3
+ * Recursively traverses an object or array, invoking a callback on each value.
4
+ *
5
+ * @param {any} obj - The object or array to traverse. Can also handle primitives, null, or undefined.
6
+ * @param {TraverseCallback} callback - The function to invoke on each value. Receives the current value
7
+ * and an `update` function to modify the value in its parent container.
8
+ * @param {any} [parent=null] - The parent object or array of the current value. Used internally.
9
+ * @param {any} [key=null] - The key or index of the current value in its parent. Used internally.
10
+ * @param {WeakSet} [visited=new WeakSet()] - Tracks visited objects to handle circular references. Used internally.
11
+ *
12
+ * @example
13
+ * // Example: Doubling all numbers in an object
14
+ * const obj = { a: 1, b: [2, 3, { c: 4 }] };
15
+ * traverse(obj, (value, update) => {
16
+ * if (typeof value === 'number') {
17
+ * update(value * 2);
18
+ * }
19
+ * });
20
+ * console.log(obj); // { a: 2, b: [4, 6, { c: 8 }] }
21
+ *
22
+ * @example
23
+ * // Example: Handling circular references
24
+ * const obj = { a: 1 };
25
+ * obj.self = obj;
26
+ * traverse(obj, (value, update) => {
27
+ * if (typeof value === 'number') {
28
+ * update(value * 2);
29
+ * }
30
+ * });
31
+ * console.log(obj.a); // 2
32
+ */
33
+ export declare function traverse(obj: any, callback: TraverseCallback, parent?: any, key?: any, visited?: WeakSet<WeakKey>): void;
34
+ export {};
@@ -0,0 +1,63 @@
1
+ /**
2
+ * Recursively traverses an object or array, invoking a callback on each value.
3
+ *
4
+ * @param {any} obj - The object or array to traverse. Can also handle primitives, null, or undefined.
5
+ * @param {TraverseCallback} callback - The function to invoke on each value. Receives the current value
6
+ * and an `update` function to modify the value in its parent container.
7
+ * @param {any} [parent=null] - The parent object or array of the current value. Used internally.
8
+ * @param {any} [key=null] - The key or index of the current value in its parent. Used internally.
9
+ * @param {WeakSet} [visited=new WeakSet()] - Tracks visited objects to handle circular references. Used internally.
10
+ *
11
+ * @example
12
+ * // Example: Doubling all numbers in an object
13
+ * const obj = { a: 1, b: [2, 3, { c: 4 }] };
14
+ * traverse(obj, (value, update) => {
15
+ * if (typeof value === 'number') {
16
+ * update(value * 2);
17
+ * }
18
+ * });
19
+ * console.log(obj); // { a: 2, b: [4, 6, { c: 8 }] }
20
+ *
21
+ * @example
22
+ * // Example: Handling circular references
23
+ * const obj = { a: 1 };
24
+ * obj.self = obj;
25
+ * traverse(obj, (value, update) => {
26
+ * if (typeof value === 'number') {
27
+ * update(value * 2);
28
+ * }
29
+ * });
30
+ * console.log(obj.a); // 2
31
+ */
32
+ export function traverse(obj, callback, parent = null, key = null, visited = new WeakSet()) {
33
+ if (obj == null || typeof obj !== 'object') {
34
+ callback(obj, (newValue) => {
35
+ if (parent !== null && key !== null) {
36
+ parent[key] = newValue;
37
+ }
38
+ });
39
+ return;
40
+ }
41
+ if (visited.has(obj)) {
42
+ return;
43
+ }
44
+ visited.add(obj);
45
+ if (Array.isArray(obj)) {
46
+ obj.forEach((item, index) => {
47
+ const update = (newValue) => {
48
+ obj[index] = newValue;
49
+ };
50
+ callback(item, update);
51
+ traverse(item, callback, obj, index, visited);
52
+ });
53
+ }
54
+ else {
55
+ Object.entries(obj).forEach(([key, value]) => {
56
+ const update = (newValue) => {
57
+ obj[key] = newValue;
58
+ };
59
+ callback(value, update);
60
+ traverse(value, callback, obj, key, visited);
61
+ });
62
+ }
63
+ }
@@ -146,6 +146,9 @@ export interface ComponentInfo {
146
146
  */
147
147
  builderLinkComponent?: boolean;
148
148
  };
149
+ meta?: {
150
+ [key: string]: any;
151
+ };
149
152
  }
150
153
  type Permission = 'read' | 'publish' | 'editCode' | 'editDesigns' | 'admin' | 'create';
151
154
  export {};
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@builder.io/sdk-svelte",
3
3
  "description": "Builder.io SDK for Svelte",
4
- "version": "3.0.0",
4
+ "version": "3.0.1",
5
5
  "type": "module",
6
6
  "files": [
7
7
  "lib",
@@ -1,3 +1,4 @@
1
+ import { IMAGE_FILE_TYPES } from '../../constants/file-types';
1
2
  import type { ComponentInfo } from '../../types/components';
2
3
  export const componentInfo: ComponentInfo = {
3
4
  name: 'Image',
@@ -14,7 +15,7 @@ export const componentInfo: ComponentInfo = {
14
15
  name: 'image',
15
16
  type: 'file',
16
17
  bubble: true,
17
- allowedFileTypes: ['jpeg', 'jpg', 'png', 'svg', 'webp'],
18
+ allowedFileTypes: IMAGE_FILE_TYPES,
18
19
  required: true,
19
20
  defaultValue: 'https://cdn.builder.io/api/v1/image/assets%2FYJIGb4i01jvw0SRdL5Bt%2F72c80f114dc149019051b6852a9e3b7a',
20
21
  onChange: (options: Map<string, any>): void | Promise<void> => {
@@ -36,7 +36,10 @@
36
36
  !url ||
37
37
  // We can auto add srcset for cdn.builder.io and shopify
38
38
  // images, otherwise you can supply this prop manually
39
- !(url.match(/builder\.io/) || url.match(/cdn\.shopify\.com/))
39
+ !(
40
+ typeof url === "string" &&
41
+ (url.match(/builder\.io/) || url.match(/cdn\.shopify\.com/))
42
+ )
40
43
  ) {
41
44
  return srcset;
42
45
  }
@@ -1,3 +1,4 @@
1
+ import { IMAGE_FILE_TYPES } from '../../constants/file-types';
1
2
  import type { ComponentInfo } from '../../types/components';
2
3
  export const componentInfo: ComponentInfo = {
3
4
  // friendlyName?
@@ -8,7 +9,7 @@ export const componentInfo: ComponentInfo = {
8
9
  name: 'image',
9
10
  bubble: true,
10
11
  type: 'file',
11
- allowedFileTypes: ['jpeg', 'jpg', 'png', 'svg', 'gif', 'webp'],
12
+ allowedFileTypes: IMAGE_FILE_TYPES,
12
13
  required: true
13
14
  }],
14
15
  noWrap: true,
@@ -1,3 +1,4 @@
1
+ import { IMAGE_FILE_TYPES, VIDEO_FILE_TYPES } from '../../constants/file-types';
1
2
  import type { ComponentInfo } from '../../types/components';
2
3
  export const componentInfo: ComponentInfo = {
3
4
  name: 'Video',
@@ -10,14 +11,14 @@ export const componentInfo: ComponentInfo = {
10
11
  inputs: [{
11
12
  name: 'video',
12
13
  type: 'file',
13
- allowedFileTypes: ['mp4'],
14
+ allowedFileTypes: VIDEO_FILE_TYPES,
14
15
  bubble: true,
15
16
  defaultValue: 'https://cdn.builder.io/o/assets%2FYJIGb4i01jvw0SRdL5Bt%2Fd27731a526464deba0016216f5f9e570%2Fcompressed?apiKey=YJIGb4i01jvw0SRdL5Bt&token=d27731a526464deba0016216f5f9e570&alt=media&optimized=true',
16
17
  required: true
17
18
  }, {
18
19
  name: 'posterImage',
19
20
  type: 'file',
20
- allowedFileTypes: ['jpeg', 'png'],
21
+ allowedFileTypes: IMAGE_FILE_TYPES,
21
22
  helperText: 'Image to show before the video plays'
22
23
  }, {
23
24
  name: 'autoPlay',
@@ -5,19 +5,26 @@ import { extractTextStyles } from '../../functions/extract-text-styles';
5
5
  import { getStyle } from '../../functions/get-style';
6
6
  import type { BuilderBlock } from '../../types/builder-block';
7
7
  import type { RepeatData } from './types';
8
+ const checkIsComponentRestricted = (component: RegisteredComponent | null | undefined, model: string) => {
9
+ if (!component) return true;
10
+ if (!model) return false;
11
+ return component.models && component.models.length > 0 && !component.models.includes(model);
12
+ };
8
13
  export const getComponent = ({
9
14
  block,
10
- registeredComponents
15
+ registeredComponents,
16
+ model
11
17
  }: {
12
18
  block: BuilderBlock;
13
19
  registeredComponents: RegisteredComponents;
20
+ model: string;
14
21
  }) => {
15
22
  const componentName = block.component?.name;
16
23
  if (!componentName) {
17
24
  return null;
18
25
  }
19
26
  const ref = registeredComponents[componentName];
20
- if (!ref) {
27
+ if (!ref || checkIsComponentRestricted(ref, model)) {
21
28
  // TODO: Public doc page with more info about this message
22
29
  console.warn(`
23
30
  Could not find a registered component named "${componentName}".
@@ -94,10 +101,15 @@ export const provideLinkComponent = (block: RegisteredComponent | null | undefin
94
101
  };
95
102
  return {};
96
103
  };
97
- export const provideRegisteredComponents = (block: RegisteredComponent | null | undefined, registeredComponents: RegisteredComponents) => {
98
- if (block?.shouldReceiveBuilderProps?.builderComponents) return {
99
- builderComponents: registeredComponents
100
- };
104
+ export const provideRegisteredComponents = (block: RegisteredComponent | null | undefined, registeredComponents: RegisteredComponents, model: string) => {
105
+ if (block?.shouldReceiveBuilderProps?.builderComponents) {
106
+ const filteredRegisteredComponents = Object.fromEntries(Object.entries(registeredComponents).filter(([_, component]) => {
107
+ return !checkIsComponentRestricted(component, model);
108
+ }));
109
+ return {
110
+ builderComponents: filteredRegisteredComponents
111
+ };
112
+ }
101
113
  return {};
102
114
  };
103
115
  export const provideBuilderBlock = (block: RegisteredComponent | null | undefined, builderBlock: BuilderBlock) => {
@@ -65,6 +65,7 @@
65
65
  return getComponent({
66
66
  block: processedBlock(),
67
67
  registeredComponents: registeredComponents,
68
+ model: $context.model,
68
69
  });
69
70
  };
70
71
  $: Tag = () => {
@@ -110,7 +111,11 @@
110
111
  ...provideBuilderBlock(blockComponent(), processedBlock()),
111
112
  ...provideBuilderContext(blockComponent(), context),
112
113
  ...provideLinkComponent(blockComponent(), linkComponent),
113
- ...provideRegisteredComponents(blockComponent(), registeredComponents),
114
+ ...provideRegisteredComponents(
115
+ blockComponent(),
116
+ registeredComponents,
117
+ $context.model
118
+ ),
114
119
  },
115
120
  context: context,
116
121
  linkComponent: linkComponent,
@@ -0,0 +1,18 @@
1
+ import { TARGET } from '../../../constants/target';
2
+ import { isEditing } from '../../../functions/is-editing';
3
+ import { isPreviewing } from '../../../functions/is-previewing';
4
+ import type { Target } from '../../../types/targets';
5
+
6
+ /**
7
+ * SDKS that use the elementRef approach to enable visual editing.
8
+ * We don't need to render the div for other SDKs as they attach event listeners to the window.
9
+ */
10
+ export const SDKS_USING_ELEMENT_REF_APPROACH = (['svelte', 'qwik', 'vue'] as Target[]);
11
+
12
+ /**
13
+ * We need to attach this div only when content exists or isPreviewing/isEditing even when content is null,
14
+ * as we need to set the elementRef and allow previewing and visual editing
15
+ */
16
+ export const needsElementRefDivForEditing = () => {
17
+ return SDKS_USING_ELEMENT_REF_APPROACH.includes(TARGET) && (isEditing() || isPreviewing());
18
+ }
@@ -45,6 +45,7 @@
45
45
  BuilderComponentStateChange,
46
46
  ContentProps,
47
47
  } from "../content.types";
48
+ import { needsElementRefDivForEditing } from "./enable-editor.helpers";
48
49
  import { getWrapperClassName } from "./styles.helpers";
49
50
  import type { Writable } from "svelte/store";
50
51
 
@@ -65,6 +66,17 @@
65
66
  export let contentWrapperProps: BuilderEditorProps["contentWrapperProps"] =
66
67
  undefined;
67
68
 
69
+ function stringifyStyles(stylesObj) {
70
+ let styles = "";
71
+ for (let key in stylesObj) {
72
+ const dashedKey = key.replace(/[A-Z]/g, function (match) {
73
+ return "-" + match.toLowerCase();
74
+ });
75
+ styles += dashedKey + ":" + stylesObj[key] + ";";
76
+ }
77
+ return styles;
78
+ }
79
+
68
80
  function mergeNewRootState(newData: Dictionary<any>) {
69
81
  const combinedState = {
70
82
  ...$builderContextSignal.rootState,
@@ -220,8 +232,14 @@
220
232
  });
221
233
  Object.values<ComponentInfo>($builderContextSignal.componentInfos).forEach(
222
234
  (registeredComponent) => {
223
- const message = createRegisterComponentMessage(registeredComponent);
224
- window.parent?.postMessage(message, "*");
235
+ if (
236
+ !model ||
237
+ !registeredComponent.models?.length ||
238
+ registeredComponent.models.includes(model)
239
+ ) {
240
+ const message = createRegisterComponentMessage(registeredComponent);
241
+ window.parent?.postMessage(message, "*");
242
+ }
225
243
  }
226
244
  );
227
245
  window.addEventListener(
@@ -362,9 +380,15 @@
362
380
  });
363
381
  </script>
364
382
 
365
- {#if $builderContextSignal.content}
383
+ {#if $builderContextSignal.content || needsElementRefDivForEditing()}
366
384
  <svelte:element
367
385
  this={ContentWrapper}
386
+ style={stringifyStyles({
387
+ display:
388
+ !$builderContextSignal.content && needsElementRefDivForEditing()
389
+ ? "none"
390
+ : undefined,
391
+ })}
368
392
  {...{}}
369
393
  bind:this={elementRef}
370
394
  on:click={(event) => {
@@ -32,7 +32,6 @@
32
32
  export let context: ContentProps["context"] = undefined;
33
33
  export let content: ContentProps["content"] = undefined;
34
34
  export let customComponents: ContentProps["customComponents"] = undefined;
35
- export let model: ContentProps["model"] = undefined;
36
35
  export let data: ContentProps["data"] = undefined;
37
36
  export let locale: ContentProps["locale"] = undefined;
38
37
  export let canTrack: ContentProps["canTrack"] = undefined;
@@ -40,6 +39,7 @@
40
39
  export let blocksWrapper: ContentProps["blocksWrapper"] = undefined;
41
40
  export let blocksWrapperProps: ContentProps["blocksWrapperProps"] = undefined;
42
41
  export let nonce: ContentProps["nonce"] = undefined;
42
+ export let model: ContentProps["model"] = undefined;
43
43
  export let apiHost: ContentProps["apiHost"] = undefined;
44
44
  export let enrich: ContentProps["enrich"] = undefined;
45
45
  export let showContent: ContentProps["showContent"];
@@ -63,11 +63,7 @@
63
63
  });
64
64
  let registeredComponents = [
65
65
  ...getDefaultRegisteredComponents(),
66
- ...(customComponents?.filter(({ models }) => {
67
- if (!models?.length) return true;
68
- if (!model) return true;
69
- return models.includes(model);
70
- }) || []),
66
+ ...(customComponents || []),
71
67
  ].reduce<RegisteredComponents>(
72
68
  (acc, { component, ...info }) => ({
73
69
  ...acc,
@@ -96,11 +92,7 @@
96
92
  apiVersion: apiVersion,
97
93
  componentInfos: [
98
94
  ...getDefaultRegisteredComponents(),
99
- ...(customComponents?.filter(({ models }) => {
100
- if (!models?.length) return true;
101
- if (!model) return true;
102
- return models.includes(model);
103
- }) || []),
95
+ ...(customComponents || []),
104
96
  ].reduce<Dictionary<ComponentInfo>>(
105
97
  (acc, { component: _, ...info }) => ({
106
98
  ...acc,
@@ -112,6 +104,7 @@
112
104
  BlocksWrapper: blocksWrapper || "div",
113
105
  BlocksWrapperProps: blocksWrapperProps || {},
114
106
  nonce: nonce || "",
107
+ model: model || "",
115
108
  });
116
109
  if (!apiKey) {
117
110
  logger.error(
@@ -0,0 +1,2 @@
1
+ export const IMAGE_FILE_TYPES = ['jpeg', 'jpg', 'png', 'svg', 'webp', 'gif', 'jfif', 'pjpeg', 'pjp', 'apng', 'avif', 'tif', 'tiff', 'heif', 'bmp', 'eps', 'raw', 'cr2', 'nef', 'orf', 'sr2', 'psd', 'heic', 'dib', 'ai'];
2
+ export const VIDEO_FILE_TYPES = ['mp4', 'webm', 'mkv', 'flv', 'vob', 'ogv', 'ogg', 'drc', 'gif', 'gifv', 'mng', 'avi', 'mov', 'qt', 'mts', 'm2ts', 'ts', 'wmv', 'yuv', 'rm', 'rmvb', 'viv', 'asf', 'amv', 'm4p', 'mpeg', 'mpe', 'm2v', 'm4v', 'svi', '3gp', '3g2', 'mxf', 'roq', 'nsv', 'f4v', 'f4p', 'f4a', 'f4b']
@@ -1 +1 @@
1
- export const SDK_VERSION = "3.0.0"
1
+ export const SDK_VERSION = "3.0.1"
@@ -15,6 +15,7 @@ export default {
15
15
  BlocksWrapper: "div",
16
16
  BlocksWrapperProps: {},
17
17
  nonce: "",
18
+ model: "",
18
19
  }),
19
20
  key,
20
21
  };
@@ -37,5 +37,6 @@ export interface BuilderContextInterface extends Pick<BlocksWrapperProps, 'Block
37
37
  // Used to recursively store all CSS coming from a parent that would apply to a Text block
38
38
  inheritedStyles: Record<string, unknown>;
39
39
  nonce: string;
40
+ model: string;
40
41
  canTrack?: boolean;
41
42
  }