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
Support updating data source values (#1849)
Bogdan Chadkin07c6734f8c32
diff --git a/apps/builder/app/builder/builder.tsx b/apps/builder/app/builder/builder.tsxindex 9d0282628b..e26532f5a4 100644--- a/apps/builder/app/builder/builder.tsx+++ b/apps/builder/app/builder/builder.tsx@@ -31,6 +31,7 @@ import {useSetAuthPermit,useSetAuthToken,useSetBreakpoints,+ useSetDataSources,useSetInstances,useSetIsPreviewMode,useSetPages,@@ -245,6 +246,7 @@ export const Builder = ({useSetPages(build.pages);useSetBreakpoints(build.breakpoints);useSetProps(build.props);+ useSetDataSources(build.dataSources);useSetStyles(build.styles);useSetStyleSources(build.styleSources);useSetStyleSourceSelections(build.styleSourceSelections);diff --git a/apps/builder/app/builder/features/props-panel/props-panel.tsx b/apps/builder/app/builder/features/props-panel/props-panel.tsxindex d5422518fe..e21f6d8bd9 100644--- a/apps/builder/app/builder/features/props-panel/props-panel.tsx+++ b/apps/builder/app/builder/features/props-panel/props-panel.tsx@@ -1,6 +1,6 @@import { useStore } from "@nanostores/react";import store from "immerhin";-import type { Instance } from "@webstudio-is/project-build";+import type { Instance, Prop } from "@webstudio-is/project-build";import {theme,useCombobox,@@ -17,9 +17,11 @@ import {} from "@webstudio-is/design-system";import type { Publish } from "~/shared/pubsub";import {+ dataSourceValuesStore,+ dataSourcesStore,+ propsIndexStore,propsStore,registeredComponentPropsMetasStore,- useInstanceProps,} from "~/shared/nano-states";import { CollapsibleSectionWithAddButton } from "~/builder/shared/collapsible-section";import {@@ -216,6 +218,8 @@ export const PropsPanelContainer = ({const propsMeta = useStore(registeredComponentPropsMetasStore).get(instance.component);+ const dataSources = useStore(dataSourcesStore);+ const dataSourceValues = useStore(dataSourceValuesStore);if (propsMeta === undefined) {throw new Error(`Could not get meta for compoent "${instance.component}"`);}@@ -225,18 +229,57 @@ export const PropsPanelContainer = ({publish,});+ const { propsByInstanceId } = useStore(propsIndexStore);++ const instanceProps =+ propsByInstanceId.get(instance.id)?.flatMap((prop) => {+ if (prop.type !== "dataSource") {+ return [prop];+ }+ // convert data source prop to typed prop+ const dataSourceId = prop.value;+ const dataSource = dataSources.get(dataSourceId);+ const dataSourceValue = dataSourceValues.get(dataSourceId);+ if (dataSource === undefined) {+ return [];+ }+ return [+ {+ id: prop.id,+ instanceId: prop.instanceId,+ name: prop.name,+ required: prop.required,+ type: dataSource.type,+ // temporary suppression for simplification+ // will be refactored once data sources ui is ready+ // eslint-disable-next-line @typescript-eslint/no-explicit-any+ value: (dataSourceValue ?? dataSource?.value) as any,+ } satisfies Prop,+ ];+ }) ?? [];+const logic = usePropsLogic({- props: useInstanceProps(instance.id),+ props: instanceProps,meta: propsMeta,instanceId: instance.id,updateProp: (update) => {- store.createTransaction([propsStore], (props) => {- props.set(update.id, update);- });+ const props = propsStore.get();+ const prop = props.get(update.id);+ // update data source instead when real prop has data source type+ if (prop?.type === "dataSource") {+ const dataSourceId = prop.value;+ const dataSourceValues = new Map(dataSourceValuesStore.get());+ dataSourceValues.set(dataSourceId, update.value);+ dataSourceValuesStore.set(dataSourceValues);+ } else if (prop) {+ store.createTransaction([propsStore], (props) => {+ props.set(update.id, update);+ });+ }},- deleteProp: (id) => {+ deleteProp: (propId) => {store.createTransaction([propsStore], (props) => {- props.delete(id);+ props.delete(propId);});},});diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsxindex 8d9235c9ae..db86925e94 100644--- a/apps/builder/app/canvas/canvas.tsx+++ b/apps/builder/app/canvas/canvas.tsx@@ -1,7 +1,7 @@import { useMemo, useEffect } from "react";import { useStore } from "@nanostores/react";import { computed } from "nanostores";-import type { Instances, Page } from "@webstudio-is/project-build";+import type { DataSource, Instances, Page } from "@webstudio-is/project-build";import {type Params,type Components,@@ -32,6 +32,8 @@ import {selectedPageStore,registerComponentMetas,registerComponentPropsMetas,+ dataSourceValuesStore,+ dataSourcesStore,} from "~/shared/nano-states";import { useDragAndDrop } from "./shared/use-drag-drop";import { useCopyPaste } from "~/shared/copy-paste";@@ -102,6 +104,24 @@ const useElementsTree = (components: Components, params: Params) => {propsByInstanceIdStore,assetsStore,pagesStore: pagesMapStore,+ dataSourceValuesStore: computed(+ [dataSourcesStore, dataSourceValuesStore],+ (dataSources, dataSourceValues) => {+ const newValues = new Map<DataSource["id"], unknown>();+ for (const [dataSourceId, dataSource] of dataSources) {+ newValues.set(dataSourceId, dataSource.value);+ }+ for (const [dataSourceId, dataSourceValue] of dataSourceValues) {+ newValues.set(dataSourceId, dataSourceValue);+ }+ return newValues;+ }+ ),+ onDataSourceUpdate: (dataSourceId, value) => {+ const dataSourceValues = new Map(dataSourceValuesStore.get());+ dataSourceValues.set(dataSourceId, value);+ dataSourceValuesStore.set(dataSourceValues);+ },Component: WebstudioComponentDev,components,});diff --git a/apps/builder/app/canvas/features/webstudio-component/selected-instance-connector.ts b/apps/builder/app/canvas/features/webstudio-component/selected-instance-connector.tsindex 86156a3052..d4570e4024 100644--- a/apps/builder/app/canvas/features/webstudio-component/selected-instance-connector.ts+++ b/apps/builder/app/canvas/features/webstudio-component/selected-instance-connector.ts@@ -1,6 +1,6 @@import { useEffect } from "react";import { useStore } from "@nanostores/react";-import type { Instance, Prop, StyleDecl } from "@webstudio-is/project-build";+import type { Instance, StyleDecl } from "@webstudio-is/project-build";import { getBrowserStyle, idAttribute } from "@webstudio-is/react-sdk";import { subscribe } from "~/shared/pubsub";import { subscribeWindowResize } from "~/shared/dom-hooks";@@ -78,7 +78,7 @@ export const SelectedInstanceConnector = ({instanceElementRef: { current: null | HTMLElement };instance: Instance;instanceStyles: StyleDecl[];- instanceProps: undefined | Prop[];+ instanceProps: unknown;instanceSelector: InstanceSelector;}) => {const instances = useStore(instancesStore);diff --git a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsxindex f9c4fbce93..d8dace2bf6 100644--- a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx+++ b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx@@ -1,11 +1,10 @@import { type MouseEvent, type FormEvent, useEffect } from "react";-import { Suspense, lazy, useCallback, useMemo, useRef } from "react";+import { Suspense, lazy, useCallback, useRef } from "react";import { useStore } from "@nanostores/react";import { useLexicalComposerContext } from "@lexical/react/LexicalComposerContext";import store from "immerhin";import {type Instance,- type Prop,findTreeInstanceIds,Instances,} from "@webstudio-is/project-build";@@ -16,13 +15,13 @@ import {idAttribute,componentAttribute,showAttribute,+ useInstanceProps,} from "@webstudio-is/react-sdk";import {instancesStore,selectedInstanceRenderStateStore,selectedInstanceSelectorStore,selectedStyleSourceSelectorStore,- useInstanceProps,useInstanceStyles,} from "~/shared/nano-states";import { textEditingInstanceSelectorStore } from "~/shared/nano-states";@@ -70,8 +69,6 @@ const ContentEditable = ({return <Component ref={ref} {...props} />;};-type UserProps = Record<Prop["name"], Prop["value"]>;-// this utility is temporary solution to compute instance selectors// for rich text subtree which cannot have slots so its safe to traverse ancestors// until editor instance is reached@@ -128,18 +125,7 @@ export const WebstudioComponentDev = ({);const instanceProps = useInstanceProps(instance.id);- const { [showAttribute]: show = true, ...userProps } = useMemo(() => {- const result: UserProps = {};- if (instanceProps === undefined) {- return result;- }- for (const item of instanceProps) {- if (item.type !== "asset" && item.type !== "page") {- result[item.name] = item.value;- }- }- return result;- }, [instanceProps]);+ const { [showAttribute]: show = true, ...userProps } = instanceProps;const isSelected = areInstanceSelectorsEqual(selectedInstanceSelector,diff --git a/apps/builder/app/shared/nano-states/nano-states.ts b/apps/builder/app/shared/nano-states/nano-states.tsindex 01a8338da7..5dcb876892 100644--- a/apps/builder/app/shared/nano-states/nano-states.ts+++ b/apps/builder/app/shared/nano-states/nano-states.ts@@ -7,6 +7,7 @@ import type { Asset, Assets } from "@webstudio-is/asset-uploader";import type { ItemDropTarget, Placement } from "@webstudio-is/design-system";import type {Breakpoint,+ DataSource,DataSources,Instance,Prop,@@ -61,6 +62,16 @@ export const rootInstanceStore = computed();export const dataSourcesStore = atom<DataSources>(new Map());+export const dataSourceValuesStore = atom<Map<DataSource["id"], unknown>>(+ new Map()+);+export const useSetDataSources = (+ dataSources: [DataSource["id"], DataSource][]+) => {+ useSyncInitializeOnce(() => {+ dataSourcesStore.set(new Map(dataSources));+ });+};export const propsStore = atom<Props>(new Map());export const propsIndexStore = computed(propsStore, (props) => {@@ -83,18 +94,6 @@ export const useSetProps = (props: [Prop["id"], Prop][]) => {propsStore.set(new Map(props));});};-export const useInstanceProps = (instanceId: undefined | Instance["id"]) => {- const instancePropsStore = useMemo(() => {- return shallowComputed([propsIndexStore], (propsIndex) => {- if (instanceId === undefined) {- return [];- }- return propsIndex.propsByInstanceId.get(instanceId) ?? [];- });- }, [instanceId]);- const instanceProps = useStore(instancePropsStore);- return instanceProps;-};export const stylesStore = atom<Styles>(new Map());diff --git a/apps/builder/app/shared/sync/sync-stores.ts b/apps/builder/app/shared/sync/sync-stores.tsindex 89a644d283..668b022a7a 100644--- a/apps/builder/app/shared/sync/sync-stores.ts+++ b/apps/builder/app/shared/sync/sync-stores.ts@@ -27,6 +27,7 @@ import {synchronizedBreakpointsStores,selectedStyleSourceSelectorStore,synchronizedComponentsMetaStores,+ dataSourceValuesStore,} from "~/shared/nano-states";enableMapSet();@@ -71,6 +72,7 @@ export const registerContainers = () => {store.register("assets", assetsStore);// synchronize whole statesclientStores.set("project", projectStore);+ clientStores.set("dataSourceValues", dataSourceValuesStore);clientStores.set("selectedPageId", selectedPageIdStore);clientStores.set("selectedInstanceSelector", selectedInstanceSelectorStore);clientStores.set(diff --git a/packages/react-sdk/src/context.tsx b/packages/react-sdk/src/context.tsxindex 5bee7e9469..9a9b0930dd 100644--- a/packages/react-sdk/src/context.tsx+++ b/packages/react-sdk/src/context.tsx@@ -1,6 +1,7 @@import { type ReadableAtom, atom } from "nanostores";import { createContext } from "react";import type { Assets } from "@webstudio-is/asset-uploader";+import type { DataSource, Instance, Prop } from "@webstudio-is/project-build";import type { Pages, PropsByInstanceId } from "./props";export type Params = {@@ -35,6 +36,12 @@ export const ReactSdkContext = createContext<propsByInstanceIdStore: ReadableAtom<PropsByInstanceId>;assetsStore: ReadableAtom<Assets>;pagesStore: ReadableAtom<Pages>;+ dataSourceValuesStore: ReadableAtom<Map<DataSource["id"], unknown>>;+ setDataSourceValue: (+ instanceId: Instance["id"],+ prop: Prop["name"],+ value: unknown+ ) => void;}>({imageBaseUrl: "/",@@ -42,4 +49,8 @@ export const ReactSdkContext = createContext<propsByInstanceIdStore: atom(new Map()),assetsStore: atom(new Map()),pagesStore: atom(new Map()),+ dataSourceValuesStore: atom(new Map()),+ setDataSourceValue: () => {+ throw Error("React SDK setDataSourceValue is not implemented");+ },});diff --git a/packages/react-sdk/src/index.ts b/packages/react-sdk/src/index.tsindex 196ef06b26..a05dbf6940 100644--- a/packages/react-sdk/src/index.ts+++ b/packages/react-sdk/src/index.ts@@ -14,6 +14,7 @@ export {} from "./components/component-meta";export * from "./embed-template";export {+ useInstanceProps,usePropUrl,usePropAsset,getInstanceIdFromComponentProps,diff --git a/packages/react-sdk/src/props.ts b/packages/react-sdk/src/props.tsindex e37eaee190..867f691961 100644--- a/packages/react-sdk/src/props.ts+++ b/packages/react-sdk/src/props.ts@@ -26,17 +26,36 @@ export const getPropsByInstanceId = (props: Props) => {// this utility is be used only for preview with static props// so there is no need to use computed to optimize rerendersexport const useInstanceProps = (instanceId: Instance["id"]) => {- const { propsByInstanceIdStore } = useContext(ReactSdkContext);- const propsByInstanceId = useStore(propsByInstanceIdStore);- const instanceProps = propsByInstanceId.get(instanceId);- const instancePropsObject: Record<Prop["name"], Prop["value"]> = {};- if (instanceProps) {- for (const prop of instanceProps) {- if (prop.type !== "asset" && prop.type !== "page") {- instancePropsObject[prop.name] = prop.value;+ const { propsByInstanceIdStore, dataSourceValuesStore } =+ useContext(ReactSdkContext);+ const instancePropsObjectStore = useMemo(() => {+ return computed(+ [propsByInstanceIdStore, dataSourceValuesStore],+ (propsByInstanceId, dataSourceValues) => {+ const instancePropsObject: Record<Prop["name"], unknown> = {};+ const instanceProps = propsByInstanceId.get(instanceId);+ if (instanceProps === undefined) {+ return instancePropsObject;+ }+ for (const prop of instanceProps) {+ if (prop.type === "asset" || prop.type === "page") {+ continue;+ }+ if (prop.type === "dataSource") {+ const dataSourceId = prop.value;+ const value = dataSourceValues.get(dataSourceId);+ if (value !== undefined) {+ instancePropsObject[prop.name] = value;+ }+ continue;+ }+ instancePropsObject[prop.name] = prop.value;+ }+ return instancePropsObject;}- }- }+ );+ }, [propsByInstanceIdStore, dataSourceValuesStore, instanceId]);+ const instancePropsObject = useStore(instancePropsObjectStore);return instancePropsObject;};diff --git a/packages/react-sdk/src/tree/create-elements-tree.tsx b/packages/react-sdk/src/tree/create-elements-tree.tsxindex 228fe5d886..f45f8b42de 100644--- a/packages/react-sdk/src/tree/create-elements-tree.tsx+++ b/packages/react-sdk/src/tree/create-elements-tree.tsx@@ -2,7 +2,11 @@ import { type ComponentProps, Fragment } from "react";import type { ReadableAtom } from "nanostores";import { Scripts, ScrollRestoration } from "@remix-run/react";import type { Assets } from "@webstudio-is/asset-uploader";-import type { Instance, Instances } from "@webstudio-is/project-build";+import type {+ DataSource,+ Instance,+ Instances,+} from "@webstudio-is/project-build";import type { Components } from "../components/components-utils";import { ReactSdkContext, type Params } from "../context";import type { Pages, PropsByInstanceId } from "../props";@@ -19,6 +23,8 @@ export const createElementsTree = ({propsByInstanceIdStore,assetsStore,pagesStore,+ dataSourceValuesStore,+ onDataSourceUpdate,Component,components,}: Params & {@@ -27,6 +33,8 @@ export const createElementsTree = ({propsByInstanceIdStore: ReadableAtom<PropsByInstanceId>;assetsStore: ReadableAtom<Assets>;pagesStore: ReadableAtom<Pages>;+ dataSourceValuesStore: ReadableAtom<Map<DataSource["id"], unknown>>;+ onDataSourceUpdate: (dataSourceId: DataSource["id"], value: unknown) => void;Component: (props: ComponentProps<typeof WebstudioComponent>) => JSX.Element;components: Components;}) => {@@ -62,9 +70,20 @@ export const createElementsTree = ({propsByInstanceIdStore,assetsStore,pagesStore,+ dataSourceValuesStore,renderer,imageBaseUrl,assetBaseUrl,+ setDataSourceValue: (instanceId, propName, value) => {+ const propsByInstanceId = propsByInstanceIdStore.get();+ const props = propsByInstanceId.get(instanceId);+ const prop = props?.find((prop) => prop.name === propName);+ if (prop?.type !== "dataSource") {+ throw Error(`${propName} is not data source`);+ }+ const dataSourceId = prop.value;+ onDataSourceUpdate(dataSourceId, value);+ },}}>{root}diff --git a/packages/react-sdk/src/tree/root.ts b/packages/react-sdk/src/tree/root.tsindex 4c5a470c16..f333529b4e 100644--- a/packages/react-sdk/src/tree/root.ts+++ b/packages/react-sdk/src/tree/root.ts@@ -1,6 +1,6 @@-import type { ComponentProps } from "react";-import { atom } from "nanostores";-import type { Build, Page } from "@webstudio-is/project-build";+import { useRef, type ComponentProps } from "react";+import { atom, type WritableAtom } from "nanostores";+import type { Build, DataSource, Page } from "@webstudio-is/project-build";import type { Asset } from "@webstudio-is/asset-uploader";import { createElementsTree } from "./create-elements-tree";import { WebstudioComponent } from "./webstudio-component";@@ -17,7 +17,7 @@ export type Data = {};export type RootPropsData = Omit<Data, "build"> & {- build: Pick<Data["build"], "instances" | "props">;+ build: Pick<Data["build"], "instances" | "props" | "dataSources">;};type RootProps = {@@ -31,6 +31,21 @@ export const InstanceRoot = ({Component,components,}: RootProps): JSX.Element | null => {+ const dataSourceValuesStoreRef = useRef<+ undefined | WritableAtom<Map<DataSource["id"], unknown>>+ >(undefined);+ // initialize store with default data source values+ if (dataSourceValuesStoreRef.current === undefined) {+ dataSourceValuesStoreRef.current = atom(+ new Map(+ data.build.dataSources.map(([dataSourceId, dataSource]) => [+ dataSourceId,+ dataSource.value,+ ])+ )+ );+ }+ const dataSourceValuesStore = dataSourceValuesStoreRef.current;return createElementsTree({imageBaseUrl: data.params?.imageBaseUrl ?? "/",assetBaseUrl: data.params?.assetBaseUrl ?? "/",@@ -41,6 +56,12 @@ export const InstanceRoot = ({),assetsStore: atom(new Map(data.assets.map((asset) => [asset.id, asset]))),pagesStore: atom(new Map(data.pages.map((page) => [page.id, page]))),+ dataSourceValuesStore,+ onDataSourceUpdate: (dataSourceId, value) => {+ const dataSourceValues = new Map(dataSourceValuesStore.get());+ dataSourceValues.set(dataSourceId, value);+ dataSourceValuesStore.set(dataSourceValues);+ },Component: Component ?? WebstudioComponent,components,});diff --git a/packages/sdk-size-test/package.json b/packages/sdk-size-test/package.jsonindex 859c36a666..64ea68b00d 100644--- a/packages/sdk-size-test/package.json+++ b/packages/sdk-size-test/package.json@@ -15,7 +15,7 @@},{"path": "functions/*.js",- "limit": "215 kB",+ "limit": "217 kB","gzip": false}],