@webstudio-is/react-sdk 0.75.0 → 0.76.0

package/lib/embed-template.js

@@ -1,29 +1,45 @@
 import { z } from "zod";
 import { nanoid } from "nanoid";
 import { StyleValue } from "@webstudio-is/css-data";
+import { encodeDataSourceVariable, validateExpression } from "./expression";
 const EmbedTemplateText = z.object({
   type: z.literal("text"),
   value: z.string()
 });
+const DataSourceRef = z.union([
+  z.object({
+    type: z.literal("variable"),
+    name: z.string()
+  }),
+  z.object({
+    type: z.literal("expression"),
+    name: z.string(),
+    code: z.string()
+  })
+]);
 const EmbedTemplateProp = z.union([
   z.object({
     type: z.literal("number"),
     name: z.string(),
+    dataSourceRef: z.optional(DataSourceRef),
     value: z.number()
   }),
   z.object({
     type: z.literal("string"),
     name: z.string(),
+    dataSourceRef: z.optional(DataSourceRef),
     value: z.string()
   }),
   z.object({
     type: z.literal("boolean"),
     name: z.string(),
+    dataSourceRef: z.optional(DataSourceRef),
     value: z.boolean()
   }),
   z.object({
     type: z.literal("string[]"),
     name: z.string(),
+    dataSourceRef: z.optional(DataSourceRef),
     value: z.array(z.string())
   })
 ]);
@@ -47,17 +63,52 @@ const EmbedTemplateInstance = z.lazy(
 const WsEmbedTemplate = z.lazy(
   () => z.array(z.union([EmbedTemplateInstance, EmbedTemplateText]))
 );
-const createInstancesFromTemplate = (treeTemplate, instances, props, styleSourceSelections, styleSources, styles, defaultBreakpointId) => {
+const createInstancesFromTemplate = (treeTemplate, instances, props, dataSourceByRef, styleSourceSelections, styleSources, styles, defaultBreakpointId) => {
   const parentChildren = [];
   for (const item of treeTemplate) {
     if (item.type === "instance") {
       const instanceId = nanoid();
       if (item.props) {
         for (const prop of item.props) {
+          const propId = nanoid();
+          if (prop.dataSourceRef === void 0) {
+            props.push({ id: propId, instanceId, ...prop });
+            continue;
+          }
+          let dataSource = dataSourceByRef.get(prop.dataSourceRef.name);
+          if (dataSource === void 0) {
+            const id = nanoid();
+            const { name: propName, dataSourceRef, ...rest } = prop;
+            if (dataSourceRef.type === "variable") {
+              dataSource = {
+                type: "variable",
+                id,
+                // the first instance where data source is appeared in becomes its scope
+                scopeInstanceId: instanceId,
+                name: dataSourceRef.name,
+                value: rest
+              };
+              dataSourceByRef.set(dataSourceRef.name, dataSource);
+            } else if (dataSourceRef.type === "expression") {
+              dataSource = {
+                type: "expression",
+                id,
+                scopeInstanceId: instanceId,
+                name: dataSourceRef.name,
+                code: dataSourceRef.code
+              };
+              dataSourceByRef.set(dataSourceRef.name, dataSource);
+            } else {
+              dataSourceRef;
+              continue;
+            }
+          }
           props.push({
-            id: nanoid(),
+            id: propId,
             instanceId,
-            ...prop
+            type: "dataSource",
+            name: prop.name,
+            value: dataSource.id
           });
         }
       }
@@ -93,6 +144,7 @@ const createInstancesFromTemplate = (treeTemplate, instances, props, styleSource
         item.children,
         instances,
         props,
+        dataSourceByRef,
         styleSourceSelections,
         styleSources,
         styles,
@@ -115,6 +167,7 @@ const createInstancesFromTemplate = (treeTemplate, instances, props, styleSource
 const generateDataFromEmbedTemplate = (treeTemplate, defaultBreakpointId) => {
   const instances = [];
   const props = [];
+  const dataSourceByRef = /* @__PURE__ */ new Map();
   const styleSourceSelections = [];
   const styleSources = [];
   const styles = [];
@@ -122,15 +175,27 @@ const generateDataFromEmbedTemplate = (treeTemplate, defaultBreakpointId) => {
     treeTemplate,
     instances,
     props,
+    dataSourceByRef,
     styleSourceSelections,
     styleSources,
     styles,
     defaultBreakpointId
   );
+  const dataSources = [];
+  for (const dataSource of dataSourceByRef.values()) {
+    if (dataSource.type === "expression") {
+      dataSource.code = validateExpression(dataSource.code, (ref) => {
+        const id = dataSourceByRef.get(ref)?.id ?? ref;
+        return encodeDataSourceVariable(id);
+      });
+    }
+    dataSources.push(dataSource);
+  }
   return {
     children,
     instances,
     props,
+    dataSources,
     styleSourceSelections,
     styleSources,
     styles

package/lib/expression.js

@@ -0,0 +1,161 @@
+import jsep from "jsep";
+const generateCode = (node, failOnForbidden, transformIdentifier) => {
+  if (node.type === "Identifier") {
+    return transformIdentifier(node.name);
+  }
+  if (node.type === "MemberExpression") {
+    if (failOnForbidden) {
+      const object2 = generateCode(
+        node.object,
+        false,
+        transformIdentifier
+      );
+      const property2 = generateCode(
+        node.property,
+        false,
+        transformIdentifier
+      );
+      throw Error(`Cannot access "${property2}" of "${object2}"`);
+    }
+    const object = generateCode(
+      node.object,
+      failOnForbidden,
+      transformIdentifier
+    );
+    const property = generateCode(
+      node.property,
+      failOnForbidden,
+      transformIdentifier
+    );
+    return `${object}.${property}`;
+  }
+  if (node.type === "Literal") {
+    return node.raw;
+  }
+  if (node.type === "UnaryExpression") {
+    const arg = generateCode(
+      node.argument,
+      failOnForbidden,
+      transformIdentifier
+    );
+    return `${node.operator}${arg}`;
+  }
+  if (node.type === "BinaryExpression") {
+    const left = generateCode(
+      node.left,
+      failOnForbidden,
+      transformIdentifier
+    );
+    const right = generateCode(
+      node.right,
+      failOnForbidden,
+      transformIdentifier
+    );
+    return `${left} ${node.operator} ${right}`;
+  }
+  if (node.type === "ArrayExpression") {
+    const elements = node.elements.map(
+      (element) => generateCode(element, failOnForbidden, transformIdentifier)
+    );
+    return `[${elements.join(", ")}]`;
+  }
+  if (node.type === "CallExpression") {
+    if (failOnForbidden) {
+      const callee2 = generateCode(
+        node.callee,
+        false,
+        transformIdentifier
+      );
+      throw Error(`Cannot call "${callee2}"`);
+    }
+    const callee = generateCode(
+      node.callee,
+      failOnForbidden,
+      transformIdentifier
+    );
+    const args = node.arguments.map(
+      (arg) => generateCode(arg, failOnForbidden, transformIdentifier)
+    );
+    return `${callee}(${args.join(", ")})`;
+  }
+  if (node.type === "ThisExpression") {
+    if (failOnForbidden) {
+      throw Error(`"this" is not supported`);
+    }
+    return "this";
+  }
+  if (node.type === "ConditionalExpression") {
+    throw Error("Ternary operator is not supported");
+  }
+  if (node.type === "Compound") {
+    throw Error("Cannot use multiple expressions");
+  }
+  node;
+  return "";
+};
+const validateExpression = (code, transformIdentifier = (id) => id) => {
+  const expression = jsep(code);
+  return generateCode(expression, true, transformIdentifier);
+};
+const executeExpressions = (variables, expressions) => {
+  const depsById = /* @__PURE__ */ new Map();
+  for (const [id, code] of expressions) {
+    const deps = /* @__PURE__ */ new Set();
+    validateExpression(code, (identifier) => {
+      if (variables.has(identifier) || expressions.has(identifier)) {
+        deps.add(identifier);
+        return identifier;
+      }
+      throw Error(`Unknown dependency "${identifier}"`);
+    });
+    depsById.set(id, deps);
+  }
+  const sortedExpressions = Array.from(expressions.keys()).sort(
+    (left, right) => {
+      if (depsById.get(left)?.has(right)) {
+        return 1;
+      }
+      if (depsById.get(right)?.has(left)) {
+        return -1;
+      }
+      return 0;
+    }
+  );
+  let header = "";
+  for (const [id, value] of variables) {
+    header += `const ${id} = ${JSON.stringify(value)};
+`;
+  }
+  const values = /* @__PURE__ */ new Map();
+  for (const id of sortedExpressions) {
+    const code = expressions.get(id);
+    if (code === void 0) {
+      continue;
+    }
+    const executeFn = new Function(`${header}
+return (${code});`);
+    const value = executeFn();
+    header += `const ${id} = ${JSON.stringify(value)};
+`;
+    values.set(id, value);
+  }
+  return values;
+};
+const dataSourceVariablePrefix = "$ws$dataSource$";
+const encodeDataSourceVariable = (id) => {
+  const encoded = id.replaceAll("-", "__DASH__");
+  return `${dataSourceVariablePrefix}${encoded}`;
+};
+const decodeDataSourceVariable = (name) => {
+  if (name.startsWith(dataSourceVariablePrefix)) {
+    const encoded = name.slice(dataSourceVariablePrefix.length);
+    return encoded.replaceAll("__DASH__", "-");
+  }
+  return;
+};
+export {
+  decodeDataSourceVariable,
+  encodeDataSourceVariable,
+  executeExpressions,
+  validateExpression
+};

package/lib/index.js

@@ -10,17 +10,29 @@ import {
 } from "./components/component-meta";
 export * from "./embed-template";
 import {
+  useInstanceProps,
   usePropUrl,
   usePropAsset,
   getInstanceIdFromComponentProps
 } from "./props";
 import { ReactSdkContext } from "./context";
+import {
+  validateExpression,
+  executeExpressions,
+  encodeDataSourceVariable,
+  decodeDataSourceVariable
+} from "./expression";
 export {
   ReactSdkContext,
   componentCategories,
+  decodeDataSourceVariable,
   defaultStates,
+  encodeDataSourceVariable,
+  executeExpressions,
   getInstanceIdFromComponentProps,
   stateCategories,
+  useInstanceProps,
   usePropAsset,
-  usePropUrl
+  usePropUrl,
+  validateExpression
 };

package/lib/props.js

@@ -16,17 +16,35 @@ const getPropsByInstanceId = (props) => {
   return propsByInstanceId;
 };
 const useInstanceProps = (instanceId) => {
-  const { propsByInstanceIdStore } = useContext(ReactSdkContext);
-  const propsByInstanceId = useStore(propsByInstanceIdStore);
-  const instanceProps = propsByInstanceId.get(instanceId);
-  const instancePropsObject = {};
-  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 instancePropsObject2 = {};
+        const instanceProps = propsByInstanceId.get(instanceId);
+        if (instanceProps === void 0) {
+          return instancePropsObject2;
+        }
+        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 !== void 0) {
+              instancePropsObject2[prop.name] = value;
+            }
+            continue;
+          }
+          instancePropsObject2[prop.name] = prop.value;
+        }
+        return instancePropsObject2;
       }
-    }
-  }
+    );
+  }, [propsByInstanceIdStore, dataSourceValuesStore, instanceId]);
+  const instancePropsObject = useStore(instancePropsObjectStore);
   return instancePropsObject;
 };
 const usePropAsset = (instanceId, name) => {

package/lib/tree/create-elements-tree.js

@@ -11,6 +11,8 @@ const createElementsTree = ({
   propsByInstanceIdStore,
   assetsStore,
   pagesStore,
+  dataSourceValuesStore,
+  onDataSourceUpdate,
   Component,
   components
 }) => {
@@ -46,9 +48,20 @@ const createElementsTree = ({
         propsByInstanceIdStore,
         assetsStore,
         pagesStore,
+        dataSourceValuesStore,
         renderer,
         imageBaseUrl,
-        assetBaseUrl
+        assetBaseUrl,
+        setDataSourceValue: (instanceId, propName, value) => {
+          const propsByInstanceId = propsByInstanceIdStore.get();
+          const props = propsByInstanceId.get(instanceId);
+          const prop = props?.find((prop2) => prop2.name === propName);
+          if (prop?.type !== "dataSource") {
+            throw Error(`${propName} is not data source`);
+          }
+          const dataSourceId = prop.value;
+          onDataSourceUpdate(dataSourceId, value);
+        }
       },
       children: root
     }

package/lib/tree/root.js

@@ -1,12 +1,68 @@
-import { atom } from "nanostores";
+import { useRef } from "react";
+import {
+  atom,
+  computed
+} from "nanostores";
 import { createElementsTree } from "./create-elements-tree";
 import { WebstudioComponent } from "./webstudio-component";
 import { getPropsByInstanceId } from "../props";
+import {
+  executeExpressions,
+  encodeDataSourceVariable,
+  decodeDataSourceVariable
+} from "../expression";
+const computeExpressions = (dataSources, dataSourceValues) => {
+  const outputValues = /* @__PURE__ */ new Map();
+  const variables = /* @__PURE__ */ new Map();
+  const expressions = /* @__PURE__ */ new Map();
+  for (const [dataSourceId, dataSource] of dataSources) {
+    const name = encodeDataSourceVariable(dataSourceId);
+    if (dataSource.type === "variable") {
+      const value = dataSourceValues.get(dataSourceId) ?? dataSource.value.value;
+      variables.set(name, value);
+      outputValues.set(dataSourceId, value);
+    }
+    if (dataSource.type === "expression") {
+      expressions.set(name, dataSource.code);
+    }
+  }
+  try {
+    const outputVariables = executeExpressions(variables, expressions);
+    for (const [name, value] of outputVariables) {
+      const id = decodeDataSourceVariable(name);
+      if (id !== void 0) {
+        outputValues.set(id, value);
+      }
+    }
+  } catch (error) {
+    console.error(error);
+  }
+  return outputValues;
+};
 const InstanceRoot = ({
   data,
   Component,
   components
 }) => {
+  const dataSourceVariablesStoreRef = useRef(void 0);
+  if (dataSourceVariablesStoreRef.current === void 0) {
+    const dataSourceVariables = /* @__PURE__ */ new Map();
+    for (const [dataSourceId, dataSource] of data.build.dataSources) {
+      dataSourceVariables.set(dataSourceId, dataSource);
+    }
+    dataSourceVariablesStoreRef.current = atom(dataSourceVariables);
+  }
+  const dataSourceVariablesStore = dataSourceVariablesStoreRef.current;
+  const dataSourceValuesStoreRef = useRef(void 0);
+  if (dataSourceValuesStoreRef.current === void 0) {
+    dataSourceValuesStoreRef.current = computed(
+      dataSourceVariablesStore,
+      (dataSourceVariables) => {
+        return computeExpressions(data.build.dataSources, dataSourceVariables);
+      }
+    );
+  }
+  const dataSourceValuesStore = dataSourceValuesStoreRef.current;
   return createElementsTree({
     imageBaseUrl: data.params?.imageBaseUrl ?? "/",
     assetBaseUrl: data.params?.assetBaseUrl ?? "/",
@@ -17,6 +73,12 @@ 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 dataSourceVariables = new Map(dataSourceVariablesStore.get());
+      dataSourceVariables.set(dataSourceId, value);
+      dataSourceVariablesStore.set(dataSourceVariables);
+    },
     Component: Component ?? WebstudioComponent,
     components
   });

package/lib/tree/webstudio-component.js

@@ -23,13 +23,18 @@ const WebstudioComponent = ({
   components,
   ...rest
 }) => {
-  const instanceProps = useInstanceProps(instance.id);
+  const { [showAttribute]: show = true, ...instanceProps } = useInstanceProps(
+    instance.id
+  );
   const props = {
     ...instanceProps,
     ...rest,
     [idAttribute]: instance.id,
     [componentAttribute]: instance.component
   };
+  if (show === false) {
+    return /* @__PURE__ */ jsx(Fragment, {});
+  }
   const Component = components.get(instance.component);
   if (Component === void 0) {
     return /* @__PURE__ */ jsx(Fragment, {});
@@ -38,11 +43,13 @@ const WebstudioComponent = ({
 };
 const idAttribute = "data-ws-id";
 const componentAttribute = "data-ws-component";
+const showAttribute = "data-ws-show";
 const collapsedAttribute = "data-ws-collapsed";
 export {
   WebstudioComponent,
   collapsedAttribute,
   componentAttribute,
   idAttribute,
-  renderWebstudioComponentChildren
+  renderWebstudioComponentChildren,
+  showAttribute
 };