@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
@@ -0,0 +1,38 @@
1
+ import type { BuilderBlock } from '../types/builder-block';
2
+ import { traverse } from './traverse';
3
+ function isLocalizedField(value: any) {
4
+ return value && typeof value === 'object' && value['@type'] === '@builder.io/core:LocalizedValue';
5
+ }
6
+ function containsLocalizedValues(data: Record<string, any>) {
7
+ if (!data || !Object.getOwnPropertyNames(data).length) {
8
+ return false;
9
+ }
10
+ let hasLocalizedValues = false;
11
+ traverse(data, value => {
12
+ if (isLocalizedField(value)) {
13
+ hasLocalizedValues = true;
14
+ return;
15
+ }
16
+ });
17
+ return hasLocalizedValues;
18
+ }
19
+ function extractLocalizedValues(data: Record<string, any>, locale: string) {
20
+ if (!data || !Object.getOwnPropertyNames(data).length) {
21
+ return {};
22
+ }
23
+ traverse(data, (value, update) => {
24
+ if (isLocalizedField(value)) {
25
+ update(value[locale] ?? undefined);
26
+ }
27
+ });
28
+ return data;
29
+ }
30
+ export function resolveLocalizedValues(block: BuilderBlock, locale: string | undefined) {
31
+ if (block.component?.options && containsLocalizedValues(block.component?.options)) {
32
+ if (!locale) {
33
+ 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');
34
+ }
35
+ block.component.options = extractLocalizedValues(block.component.options, locale ?? 'Default');
36
+ }
37
+ return block;
38
+ }
@@ -3,6 +3,7 @@ import type { BuilderContextInterface } from '../context/types';
3
3
  import { omit } from '../helpers/omit';
4
4
  import type { BuilderBlock } from '../types/builder-block';
5
5
  import { evaluate } from './evaluate/index';
6
+ import { resolveLocalizedValues } from './extract-localized-values';
6
7
  import { fastClone } from './fast-clone';
7
8
  import { set } from './set';
8
9
  import { transformBlock } from './transform-block';
@@ -96,7 +97,8 @@ export function getProcessedBlock({
96
97
  */
97
98
  shouldEvaluateBindings: boolean;
98
99
  } & Pick<BuilderContextInterface, 'localState' | 'context' | 'rootState' | 'rootSetState'>): BuilderBlock {
99
- const transformedBlock = transformBlock(block);
100
+ let transformedBlock = resolveLocalizedValues(block, (rootState.locale as string | undefined));
101
+ transformedBlock = transformBlock(transformedBlock);
100
102
  if (shouldEvaluateBindings) {
101
103
  return evaluateBindings({
102
104
  block: transformedBlock,
@@ -13,8 +13,11 @@ const serializeFn = (fnValue: Function) => {
13
13
  // 2. `name(args) => {code}`
14
14
  // 3. `(args) => {}`
15
15
  // 4. `args => {}`
16
+ // 5. `async function(args) {code}`
17
+ // 6. `async (args) => {}`
18
+ // 7. `async args => {}`
16
19
  const isArrowWithoutParens = /^[a-zA-Z0-9_]+\s*=>/i.test(fnStr);
17
- const appendFunction = !fnStr.startsWith('function') && !fnStr.startsWith('(') && !isArrowWithoutParens;
20
+ const appendFunction = !fnStr.startsWith('function') && !fnStr.startsWith('async') && !fnStr.startsWith('(') && !isArrowWithoutParens;
18
21
  return `return (${appendFunction ? 'function ' : ''}${fnStr}).apply(this, arguments)`;
19
22
  };
20
23
  export function serializeIncludingFunctions(info: ComponentInfo) {
@@ -0,0 +1,64 @@
1
+ type TraverseCallback = (value: any, update: (newValue: any) => void) => void;
2
+
3
+ /**
4
+ * Recursively traverses an object or array, invoking a callback on each value.
5
+ *
6
+ * @param {any} obj - The object or array to traverse. Can also handle primitives, null, or undefined.
7
+ * @param {TraverseCallback} callback - The function to invoke on each value. Receives the current value
8
+ * and an `update` function to modify the value in its parent container.
9
+ * @param {any} [parent=null] - The parent object or array of the current value. Used internally.
10
+ * @param {any} [key=null] - The key or index of the current value in its parent. Used internally.
11
+ * @param {WeakSet} [visited=new WeakSet()] - Tracks visited objects to handle circular references. Used internally.
12
+ *
13
+ * @example
14
+ * // Example: Doubling all numbers in an object
15
+ * const obj = { a: 1, b: [2, 3, { c: 4 }] };
16
+ * traverse(obj, (value, update) => {
17
+ * if (typeof value === 'number') {
18
+ * update(value * 2);
19
+ * }
20
+ * });
21
+ * console.log(obj); // { a: 2, b: [4, 6, { c: 8 }] }
22
+ *
23
+ * @example
24
+ * // Example: Handling circular references
25
+ * const obj = { a: 1 };
26
+ * obj.self = obj;
27
+ * traverse(obj, (value, update) => {
28
+ * if (typeof value === 'number') {
29
+ * update(value * 2);
30
+ * }
31
+ * });
32
+ * console.log(obj.a); // 2
33
+ */
34
+ export function traverse(obj: any, callback: TraverseCallback, parent: any = null, key: any = null, visited = new WeakSet()): void {
35
+ if (obj == null || typeof obj !== 'object') {
36
+ callback(obj, (newValue: any) => {
37
+ if (parent !== null && key !== null) {
38
+ parent[key] = newValue;
39
+ }
40
+ });
41
+ return;
42
+ }
43
+ if (visited.has(obj)) {
44
+ return;
45
+ }
46
+ visited.add(obj);
47
+ if (Array.isArray(obj)) {
48
+ obj.forEach((item, index) => {
49
+ const update = (newValue: any) => {
50
+ obj[index] = newValue;
51
+ };
52
+ callback(item, update);
53
+ traverse(item, callback, obj, index, visited);
54
+ });
55
+ } else {
56
+ Object.entries(obj).forEach(([key, value]) => {
57
+ const update = (newValue: any) => {
58
+ obj[key] = newValue;
59
+ };
60
+ callback(value, update);
61
+ traverse(value, callback, obj, key, visited);
62
+ });
63
+ }
64
+ }
@@ -161,5 +161,8 @@ export interface ComponentInfo {
161
161
  */
162
162
  builderLinkComponent?: boolean;
163
163
  };
164
+ meta?: {
165
+ [key: string]: any;
166
+ };
164
167
  }
165
168
  type Permission = 'read' | 'publish' | 'editCode' | 'editDesigns' | 'admin' | 'create'