Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.
TypeScript accessibilityalternativecloudflarecloudflare-workersdesignfreefrontendopen-sourceradix-uireactremixweb-developmentwebflowwebsite-builderwebsite-developmentwebsiteswebstudio
feat: Allow Collection component to accept both - arrays and objects (#5570)
Oleg Isonen770d6c2fe3cc
diff --git a/apps/builder/app/builder/features/navigator/navigator-tree.tsx b/apps/builder/app/builder/features/navigator/navigator-tree.tsxindex d72cd03eeb..7e01d86bf5 100644--- a/apps/builder/app/builder/features/navigator/navigator-tree.tsx+++ b/apps/builder/app/builder/features/navigator/navigator-tree.tsx@@ -19,7 +19,7 @@ import {TreeSortableItem,type TreeDropTarget,} from "@webstudio-is/design-system";-import { showAttribute } from "@webstudio-is/react-sdk";+import { showAttribute, getCollectionEntries } from "@webstudio-is/react-sdk";import {ROOT_INSTANCE_ID,collectionComponent,@@ -194,33 +194,39 @@ export const $flatTree = computed(// render same children for each collection item in dataif (instance.component === collectionComponent && treeItem.isExpanded) {- const data = propValues?.get("data");- // create items only when collection has content- if (Array.isArray(data) && instance.children.length > 0) {- data.forEach((_item, dataIndex) => {- for (let index = 0; index < instance.children.length; index += 1) {- const child = instance.children[index];- if (child.type === "id") {- const isLastChild = index === instance.children.length - 1;- const lastDescendentItem = traverse(- child.value,- [+ const originalData = propValues?.get("data");+ if (originalData && instance.children.length > 0) {+ const entries = getCollectionEntries(originalData);+ if (entries.length > 0) {+ entries.forEach(([key], entryIndex) => {+ for (+ let index = 0;+ index < instance.children.length;+ index += 1+ ) {+ const child = instance.children[index];+ if (child.type === "id") {+ const isLastChild = index === instance.children.length - 1;+ const lastDescendentItem = traverse(child.value,- getIndexedInstanceId(instance.id, dataIndex),- ...selector,- ],- visibleAncestors,- isHidden,- isReusable,- isLastChild,- instance.children.length * dataIndex + index- );- if (lastDescendentItem) {- lastItem = lastDescendentItem;+ [+ child.value,+ getIndexedInstanceId(instance.id, key),+ ...selector,+ ],+ visibleAncestors,+ isHidden,+ isReusable,+ isLastChild,+ instance.children.length * entryIndex + index+ );+ if (lastDescendentItem) {+ lastItem = lastDescendentItem;+ }}}- }- });+ });+ }}} else if (level === 0 || treeItem.isExpanded) {for (let index = 0; index < instance.children.length; index += 1) {diff --git a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsxindex dedbdcb35b..b48be2e277 100644--- a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx+++ b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx@@ -38,6 +38,7 @@ import {type AnyComponent,textContentAttribute,standardAttributesToReactProps,+ getCollectionEntries,} from "@webstudio-is/react-sdk";import { rawTheme } from "@webstudio-is/design-system";import { Input, Select, Textarea } from "@webstudio-is/sdk-components-react";@@ -504,23 +505,16 @@ export const WebstudioComponentCanvas = forwardRef<}if (instance.component === collectionComponent) {- const data = instanceProps.data;- if (data && Array.isArray(data) === false) {- Component = InvalidCollectionDataStub as AnyComponent;- } else if (- // render stub component when no data or children- Array.isArray(data) &&- data.length > 0 &&- instance.children.length > 0- ) {- return data.map((_item, index) => {- return (- <Fragment key={index}>+ const originalData = instanceProps.data;+ if (originalData && instance.children.length > 0) {+ const entries = getCollectionEntries(originalData);+ if (entries.length > 0) {+ return entries.map(([key]) => (+ <Fragment key={key}>{createInstanceChildrenElements({instances,- // create fake indexed id to distinct items for select and hoverinstanceSelector: [- getIndexedInstanceId(instance.id, index),+ getIndexedInstanceId(instance.id, key),...instanceSelector,],children: instance.children,@@ -528,11 +522,10 @@ export const WebstudioComponentCanvas = forwardRef<components,})}</Fragment>- );- });- } else {- Component = DroppableComponentStub as AnyComponent;+ ));+ }}+ Component = DroppableComponentStub as AnyComponent;}if (instance.component === descendantComponent) {@@ -660,21 +653,16 @@ export const WebstudioComponentPreview = forwardRef<}if (instance.component === collectionComponent) {- const data = instanceProps.data;- // render nothing when no data or children- if (- Array.isArray(data) &&- data.length > 0 &&- instance.children.length > 0- ) {- return data.map((_item, index) => {- return (- <Fragment key={index}>+ const originalData = instanceProps.data;+ if (originalData && instance.children.length > 0) {+ const entries = getCollectionEntries(originalData);+ if (entries.length > 0) {+ return entries.map(([key]) => (+ <Fragment key={key}>{createInstanceChildrenElements({instances,- // create fake indexed id to distinct items for select and hoverinstanceSelector: [- getIndexedInstanceId(instance.id, index),+ getIndexedInstanceId(instance.id, key),...instanceSelector,],children: instance.children,@@ -682,8 +670,8 @@ export const WebstudioComponentPreview = forwardRef<components,})}</Fragment>- );- });+ ));+ }}}diff --git a/apps/builder/app/shared/nano-states/props.test.tsx b/apps/builder/app/shared/nano-states/props.test.tsxindex 2134b94d37..f81079ceec 100644--- a/apps/builder/app/shared/nano-states/props.test.tsx+++ b/apps/builder/app/shared/nano-states/props.test.tsx@@ -375,6 +375,72 @@ test("compute expression from collection items", () => {cleanStores($propValuesByInstanceSelector);});+test("compute expression from object collection items", () => {+ const dataVariable = new Variable("dataVariable", {+ first: "orange",+ second: "apple",+ third: "banana",+ });+ const collectionItem = new Parameter("Collection Item");+ const data = renderData(+ <$.Body ws:id="bodyId">+ <ws.collection+ ws:id="collectionId"+ data={expression`${dataVariable}`}+ item={collectionItem}+ >+ <$.Box ws:id="boxId" ariaLabel={expression`${collectionItem}`}></$.Box>+ </ws.collection>+ </$.Body>+ );+ $instances.set(data.instances);+ $dataSources.set(data.dataSources);+ $props.set(data.props);+ selectPageRoot("bodyId");+ $dataSourceVariables.set(new Map([]));++ expect($propValuesByInstanceSelector.get()).toEqual(+ new Map([+ [getInstanceKey(["bodyId"]), new Map<string, unknown>([])],+ [+ getInstanceKey(["collectionId", "bodyId"]),+ new Map<string, unknown>([+ ["data", { first: "orange", second: "apple", third: "banana" }],+ ]),+ ],+ [+ getInstanceKey([+ "boxId",+ "collectionId[first]",+ "collectionId",+ "bodyId",+ ]),+ new Map<string, unknown>([["ariaLabel", "orange"]]),+ ],+ [+ getInstanceKey([+ "boxId",+ "collectionId[second]",+ "collectionId",+ "bodyId",+ ]),+ new Map<string, unknown>([["ariaLabel", "apple"]]),+ ],+ [+ getInstanceKey([+ "boxId",+ "collectionId[third]",+ "collectionId",+ "bodyId",+ ]),+ new Map<string, unknown>([["ariaLabel", "banana"]]),+ ],+ ])+ );++ cleanStores($propValuesByInstanceSelector);+});+test("access parameter value from variables values", () => {$instances.set(toMap([@@ -794,6 +860,124 @@ test("compute item values for collection", () => {).toEqual("orange");});+test("compute item values for collection with object data", () => {+ const dataVariable = new Variable("dataVariable", {+ first: "apple",+ second: "banana",+ third: "orange",+ });+ const collectionItem = new Parameter("Collection Item");+ const data = renderData(+ <$.Body ws:id="bodyId">+ <ws.collection+ ws:id="collectionId"+ data={expression`${dataVariable}`}+ item={collectionItem}+ >+ <$.Box ws:id="boxId"></$.Box>+ </ws.collection>+ </$.Body>+ );+ $instances.set(data.instances);+ $dataSources.set(data.dataSources);+ $props.set(data.props);+ const [_dataVariableId, itemParameterId] = data.dataSources.keys();+ selectPageRoot("bodyId");+ $dataSourceVariables.set(new Map([]));+ const values = $variableValuesByInstanceSelector.get();+ expect(+ values+ .get(+ getInstanceKey([+ "boxId",+ "collectionId[first]",+ "collectionId",+ "bodyId",+ ROOT_INSTANCE_ID,+ ])+ )+ ?.get(itemParameterId)+ ).toEqual("apple");+ expect(+ values+ .get(+ getInstanceKey([+ "boxId",+ "collectionId[second]",+ "collectionId",+ "bodyId",+ ROOT_INSTANCE_ID,+ ])+ )+ ?.get(itemParameterId)+ ).toEqual("banana");+ expect(+ values+ .get(+ getInstanceKey([+ "boxId",+ "collectionId[third]",+ "collectionId",+ "bodyId",+ ROOT_INSTANCE_ID,+ ])+ )+ ?.get(itemParameterId)+ ).toEqual("orange");+});++test("compute item values for collection with nested object data", () => {+ const dataVariable = new Variable("dataVariable", {+ user1: { name: "Alice", age: 30 },+ user2: { name: "Bob", age: 25 },+ });+ const collectionItem = new Parameter("Collection Item");+ const data = renderData(+ <$.Body ws:id="bodyId">+ <ws.collection+ ws:id="collectionId"+ data={expression`${dataVariable}`}+ item={collectionItem}+ >+ <$.Box ws:id="boxId"></$.Box>+ </ws.collection>+ </$.Body>+ );+ $instances.set(data.instances);+ $dataSources.set(data.dataSources);+ $props.set(data.props);+ const [_dataVariableId, itemParameterId] = data.dataSources.keys();+ selectPageRoot("bodyId");+ $dataSourceVariables.set(new Map([]));+ const values = $variableValuesByInstanceSelector.get();+ expect(+ values+ .get(+ getInstanceKey([+ "boxId",+ "collectionId[user1]",+ "collectionId",+ "bodyId",+ ROOT_INSTANCE_ID,+ ])+ )+ ?.get(itemParameterId)+ ).toEqual({ name: "Alice", age: 30 });+ expect(+ values+ .get(+ getInstanceKey([+ "boxId",+ "collectionId[user2]",+ "collectionId",+ "bodyId",+ ROOT_INSTANCE_ID,+ ])+ )+ ?.get(itemParameterId)+ ).toEqual({ name: "Bob", age: 25 });+});+test("compute resource variable values", () => {const resourceVariable = new ResourceValue("resourceVariable", {url: expression`""`,diff --git a/apps/builder/app/shared/nano-states/props.ts b/apps/builder/app/shared/nano-states/props.tsindex 287a707d8c..06022730a3 100644--- a/apps/builder/app/shared/nano-states/props.ts+++ b/apps/builder/app/shared/nano-states/props.ts@@ -16,7 +16,11 @@ import {SYSTEM_VARIABLE_ID,findTreeInstanceIds,} from "@webstudio-is/sdk";-import { normalizeProps, textContentAttribute } from "@webstudio-is/react-sdk";+import {+ normalizeProps,+ textContentAttribute,+ getCollectionEntries,+} from "@webstudio-is/react-sdk";import { mapGroupBy } from "~/shared/shim";import { $instances } from "./instances";import {@@ -46,7 +50,7 @@ export const assetBaseUrl = "/cgi/asset/";export const getIndexedInstanceId = (instanceId: Instance["id"],- index: number+ index: number | string) => `${instanceId}[${index}]`;/**@@ -315,18 +319,18 @@ export const $propValuesByInstanceSelector = computed();if (instance.component === collectionComponent) {- const data = propValues.get("data");+ const originalData = propValues.get("data");const itemVariableId = parameters.get("item");- if (Array.isArray(data) && itemVariableId !== undefined) {- data.forEach((item, index) => {- variableValues.set(itemVariableId, item);+ if (itemVariableId !== undefined && originalData) {+ for (const [key, value] of getCollectionEntries(originalData)) {+ variableValues.set(itemVariableId, value);for (const child of instance.children) {if (child.type === "id") {- const indexId = getIndexedInstanceId(instanceId, index);+ const indexId = getIndexedInstanceId(instanceId, key);traverseInstances([child.value, indexId, ...instanceSelector]);}}- });+ }}return;}@@ -515,27 +519,27 @@ export const $variableValuesByInstanceSelector = computed(}if (instance.component === collectionComponent) {- const data = propValues.get("data");+ const originalData = propValues.get("data");const itemVariableId = parameters.get("item");if (itemVariableId === undefined) {return;}// prevent accessing item from collectionvariableValues.delete(itemVariableId);- if (Array.isArray(data)) {- data.forEach((item, index) => {+ if (originalData) {+ for (const [key, value] of getCollectionEntries(originalData)) {const itemVariableValues = new Map(variableValues);- itemVariableValues.set(itemVariableId, item);+ itemVariableValues.set(itemVariableId, value);for (const child of instance.children) {if (child.type === "id") {- const indexId = getIndexedInstanceId(instanceId, index);+ const indexId = getIndexedInstanceId(instanceId, key);traverseInstances([child.value, indexId, ...instanceSelector],itemVariableValues);}}- });+ }}return;}diff --git a/fixtures/webstudio-features/app/__generated__/[resources]._index.tsx b/fixtures/webstudio-features/app/__generated__/[resources]._index.tsxindex 192cf2722b..36d64ee640 100644--- a/fixtures/webstudio-features/app/__generated__/[resources]._index.tsx+++ b/fixtures/webstudio-features/app/__generated__/[resources]._index.tsx@@ -33,7 +33,10 @@ const Page = (_props: { system: any }) => {let list = useResource("list_1");return (<Body className={`w-body`}>- {list?.data?.map?.((collectionItem: any, index: number) => (+ {Object.entries(+ // @ts-ignore+ list?.data ?? {}+ ).map(([index, collectionItem]: any) => (<Fragment key={index}><Box className={`w-box`}><HtmlEmbed code={collectionItem?.name} className={`w-html-embed`} />diff --git a/fixtures/webstudio-features/app/__generated__/[sitemap.xml]._index.tsx b/fixtures/webstudio-features/app/__generated__/[sitemap.xml]._index.tsxindex 0f8741f09b..dc0cc8f357 100644--- a/fixtures/webstudio-features/app/__generated__/[sitemap.xml]._index.tsx+++ b/fixtures/webstudio-features/app/__generated__/[sitemap.xml]._index.tsx@@ -36,16 +36,19 @@ const Page = (_props: { system: any }) => {xmlns={"http://www.sitemaps.org/schemas/sitemap/0.9"}xmlns:xhtml={"http://www.w3.org/TR/xhtml11/xhtml11_schema.html"}>- {[- {- path: "/",- lastModified: "2024-05-07",- },- {- path: "/olegs-test",- lastModified: "2024-05-07",- },- ]?.map?.((url: any, index: number) => (+ {Object.entries(+ // @ts-ignore+ [+ {+ path: "/",+ lastModified: "2024-05-07",+ },+ {+ path: "/olegs-test",+ lastModified: "2024-05-07",+ },+ ] ?? {}+ ).map(([index, url]: any) => (<Fragment key={index}><XmlNode tag={"url"}><XmlNode tag={"loc"}>diff --git a/packages/react-sdk/src/collection-utils.test.ts b/packages/react-sdk/src/collection-utils.test.tsnew file mode 100644index 0000000000..2a52872d2e--- /dev/null+++ b/packages/react-sdk/src/collection-utils.test.ts@@ -0,0 +1,106 @@+import { expect, test } from "vitest";+import {+ getCollectionEntries,+ generateCollectionIterationCode,+} from "./collection-utils";++test("getCollectionEntries handles arrays", () => {+ expect(getCollectionEntries(["a", "b", "c"])).toEqual([+ ["0", "a"],+ ["1", "b"],+ ["2", "c"],+ ]);+});++test("getCollectionEntries handles objects", () => {+ expect(getCollectionEntries({ first: "a", second: "b" })).toEqual([+ ["first", "a"],+ ["second", "b"],+ ]);+});++test("getCollectionEntries handles null/undefined", () => {+ expect(getCollectionEntries(null)).toEqual([]);+ expect(getCollectionEntries(undefined)).toEqual([]);+});++test("getCollectionEntries handles non-objects", () => {+ expect(getCollectionEntries(42)).toEqual([]);+ expect(getCollectionEntries("string")).toEqual([]);+ expect(getCollectionEntries(true)).toEqual([]);+});++test("generateCollectionIterationCode produces correct template", () => {+ const code = generateCollectionIterationCode({+ dataExpression: "myData",+ keyVariable: "index",+ itemVariable: "item",+ });++ expect(code).toBe(`Object.entries(+ // @ts-ignore+ myData ?? {}+).map(([index, item]: any)`);+});++test("generated code works with arrays at runtime", () => {+ // @ts-expect-error - used in eval below+ const data = ["apple", "banana", "orange"];+ const result: Array<[string, string]> = [];++ // Simulate generated code+ eval(`+ Object.entries(data ?? {}).map(([index, item]) => {+ result.push([index, item]);+ });+ `);++ expect(result).toEqual([+ ["0", "apple"],+ ["1", "banana"],+ ["2", "orange"],+ ]);+});++test("generated code works with objects at runtime", () => {+ // @ts-expect-error - used in eval below+ const data = { first: "apple", second: "banana" };+ const result: Array<[string, string]> = [];++ // Simulate generated code+ eval(`+ Object.entries(data ?? {}).map(([index, item]) => {+ result.push([index, item]);+ });+ `);++ expect(result).toEqual([+ ["first", "apple"],+ ["second", "banana"],+ ]);+});++test("generated code handles null/undefined", () => {+ // @ts-expect-error - used in eval below+ let data: null | undefined = null;+ const resultNull: Array<[string, unknown]> = [];++ eval(`+ Object.entries(data ?? {}).map(([index, item]) => {+ resultNull.push([index, item]);+ });+ `);++ expect(resultNull).toEqual([]);++ data = undefined;+ const resultUndefined: Array<[string, unknown]> = [];++ eval(`+ Object.entries(data ?? {}).map(([index, item]) => {+ resultUndefined.push([index, item]);+ });+ `);++ expect(resultUndefined).toEqual([]);+});diff --git a/packages/react-sdk/src/collection-utils.ts b/packages/react-sdk/src/collection-utils.tsnew file mode 100644index 0000000000..f853c170e0--- /dev/null+++ b/packages/react-sdk/src/collection-utils.ts@@ -0,0 +1,44 @@+/**+ * Shared collection iteration logic for both builder and published sites.+ *+ * Collections support both arrays and objects:+ * - Arrays: [item1, item2] -> entries are [["0", item1], ["1", item2]]+ * - Objects: {key1: val1, key2: val2} -> entries are [["key1", val1], ["key2", val2]]+ *+ * Using Object.entries() unifies both cases since arrays are objects with numeric keys.+ */++/**+ * Normalize collection data to entries format [key, value][].+ * Returns empty array if data is not iterable.+ */+export const getCollectionEntries = (+ data: unknown+): Array<[string, unknown]> => {+ if (data === null || data === undefined) {+ return [];+ }+ if (typeof data !== "object") {+ return [];+ }+ return Object.entries(data);+};++/**+ * Template for generated code that iterates over collections.+ * Used by component-generator.ts to ensure consistency.+ */+export const generateCollectionIterationCode = ({+ dataExpression,+ keyVariable,+ itemVariable,+}: {+ dataExpression: string;+ keyVariable: string;+ itemVariable: string;+}) => {+ return `Object.entries(+ // @ts-ignore+ ${dataExpression} ?? {}+).map(([${keyVariable}, ${itemVariable}]: any)`;+};diff --git a/packages/react-sdk/src/component-generator.test.tsx b/packages/react-sdk/src/component-generator.test.tsxindex 19cb23f238..1443d1b9e6 100644--- a/packages/react-sdk/src/component-generator.test.tsx+++ b/packages/react-sdk/src/component-generator.test.tsx@@ -462,7 +462,10 @@ test("generate collection component as map", () => {).toEqual(validateJSX(clear(`- {data?.map?.((element: any, index: number) =>+ {Object.entries(+ // @ts-ignore+ data ?? {}+ ).map(([index, element]: any) =><Fragment key={index}><Label /><Button@@ -640,7 +643,10 @@ test("avoid generating collection parameter variable as state", () => {const Page = () => {let [data, set$data] = useVariableState<any>(["apple","orange","mango"])return <Body>- {data?.map?.((element: any, index: number) =>+ {Object.entries(+ // @ts-ignore+ data ?? {}+ ).map(([index, element]: any) =><Fragment key={index}></Fragment>)}@@ -839,21 +845,24 @@ test("generate conditional collection", () => {),})).toMatchInlineSnapshot(`-"const Page = () => {-let [condition, set$condition] = useVariableState<any>(false)-return <Body>-{(condition) &&-<>-{[]?.map?.((collectionItem: any, index: number) =>-<Fragment key={index}>-</Fragment>-)}-</>-}-</Body>-}-"-`);+ "const Page = () => {+ let [condition, set$condition] = useVariableState<any>(false)+ return <Body>+ {(condition) &&+ <>+ {Object.entries(+ // @ts-ignore+ [] ?? {}+ ).map(([index, collectionItem]: any) =>+ <Fragment key={index}>+ </Fragment>+ )}+ </>+ }+ </Body>+ }+ "+ `);});test("generate conditional body", () => {diff --git a/packages/react-sdk/src/component-generator.ts b/packages/react-sdk/src/component-generator.tsindex aa62450d6e..d3bd9ad1bc 100644--- a/packages/react-sdk/src/component-generator.ts+++ b/packages/react-sdk/src/component-generator.ts@@ -24,6 +24,7 @@ import {import { indexProperty, tagProperty } from "@webstudio-is/sdk/runtime";import { isAttributeNameSafe, showAttribute } from "./props";import { standardAttributesToReactProps } from "./__generated__/standard-attributes";+import { generateCollectionIterationCode } from "./collection-utils";/*** (arg1) => {@@ -278,7 +279,12 @@ export const generateJsxElement = ({const indexVariable = scope.getName(`${instance.id}-index`, "index");// collection can be nullable or invalid type// fix implicitly on published sites- generatedElement += `{${collectionDataValue}?.map?.((${collectionItemValue}: any, ${indexVariable}: number) =>\n`;+ // support both arrays and objects with Object.entries+ generatedElement += `{${generateCollectionIterationCode({+ dataExpression: collectionDataValue,+ keyVariable: indexVariable,+ itemVariable: collectionItemValue,+ })} =>\n`;generatedElement += `<Fragment key={${indexVariable}}>\n`;generatedElement += children;generatedElement += `</Fragment>\n`;diff --git a/packages/react-sdk/src/index.ts b/packages/react-sdk/src/index.tsindex 3479812fba..37033d1feb 100644--- a/packages/react-sdk/src/index.ts+++ b/packages/react-sdk/src/index.ts@@ -1,6 +1,7 @@export * from "./remix";export * from "./components/components-utils";export * from "./props";+export * from "./collection-utils";export type * from "./context";export type * from "./hook";export {