@webstudio-is/react-sdk 0.83.0 → 0.84.0

package/lib/component-renderer.js

@@ -0,0 +1,111 @@
+import { Fragment, jsx, jsxs } from "react/jsx-runtime";
+import { getStyleDeclKey } from "@webstudio-is/project-build";
+import { generateDataFromEmbedTemplate } from "./embed-template";
+import { generateCssText } from "./css";
+import { InstanceRoot, WebstudioComponent } from "./tree";
+import {
+  decodeVariablesMap,
+  encodeDataSourceVariable,
+  encodeVariablesMap,
+  executeComputingExpressions,
+  executeEffectfulExpression
+} from "./expression";
+import { getIndexesWithinAncestors } from "./instance-utils";
+const renderComponentTemplate = ({
+  name,
+  metas: metasRecord,
+  components
+}) => {
+  const metas = new Map(Object.entries(metasRecord));
+  const data = generateDataFromEmbedTemplate(
+    metas.get(name)?.template ?? [
+      {
+        type: "instance",
+        component: name,
+        children: []
+      }
+    ],
+    "base"
+  );
+  const instances = [
+    [
+      "root",
+      {
+        type: "instance",
+        id: "root",
+        component: "Box",
+        children: data.children
+      }
+    ],
+    ...data.instances.map(
+      (instance) => [instance.id, instance]
+    )
+  ];
+  return /* @__PURE__ */ jsxs(Fragment, { children: [
+    /* @__PURE__ */ jsx("style", { children: generateCssText(
+      {
+        assets: [],
+        breakpoints: [["base", { id: "base", label: "base" }]],
+        styles: data.styles.map((item) => [getStyleDeclKey(item), item]),
+        styleSourceSelections: data.styleSourceSelections.map((item) => [
+          item.instanceId,
+          item
+        ]),
+        componentMetas: metas
+      },
+      { assetBaseUrl: "/" }
+    ) }),
+    /* @__PURE__ */ jsx(
+      InstanceRoot,
+      {
+        data: {
+          page: {
+            path: "",
+            id: "",
+            name: "",
+            title: "",
+            meta: {},
+            rootInstanceId: "root"
+          },
+          pages: [],
+          assets: [],
+          build: {
+            instances,
+            props: data.props.map((prop) => [prop.id, prop]),
+            dataSources: data.dataSources.map((dataSource) => [
+              dataSource.id,
+              dataSource
+            ])
+          }
+        },
+        executeComputingExpressions: (values) => {
+          const expressions = /* @__PURE__ */ new Map();
+          for (const dataSource of data.dataSources) {
+            const name2 = encodeDataSourceVariable(dataSource.id);
+            if (dataSource.type === "expression") {
+              expressions.set(name2, dataSource.code);
+            }
+          }
+          return decodeVariablesMap(
+            executeComputingExpressions(expressions, encodeVariablesMap(values))
+          );
+        },
+        executeEffectfulExpression: (code, args, values) => {
+          return decodeVariablesMap(
+            executeEffectfulExpression(code, args, encodeVariablesMap(values))
+          );
+        },
+        Component: WebstudioComponent,
+        components: new Map(Object.entries(components)),
+        indexesWithinAncestors: getIndexesWithinAncestors(
+          metas,
+          new Map(instances),
+          ["root"]
+        )
+      }
+    )
+  ] });
+};
+export {
+  renderComponentTemplate
+};

package/lib/components/component-meta.js

@@ -36,6 +36,11 @@ const WsComponentMeta = z.object({
   type: z.enum(["container", "control", "embed", "rich-text-child"]),
   requiredAncestors: z.optional(z.array(z.string())),
   invalidAncestors: z.optional(z.array(z.string())),
+  // when this field is specified component receives
+  // prop with index of same components withiin specified ancestor
+  // important to automatically enumerate collections without
+  // naming every item manually
+  indexWithinAncestor: z.optional(z.string()),
   stylable: z.optional(z.boolean()),
   // specifies whether the instance can be deleted,
   // copied or dragged out of its parent instance

package/lib/context.js

@@ -15,7 +15,8 @@ const ReactSdkContext = createContext({
   },
   setBoundDataSourceValue: () => {
     throw Error("React SDK setBoundDataSourceValue is not implemented");
-  }
+  },
+  indexesWithinAncestors: /* @__PURE__ */ new Map()
 });
 export {
   ReactSdkContext

package/lib/css/style-rules.js

@@ -49,7 +49,7 @@ const getPresetStyleRules = (component, presetStyle) => {
   const presetStyleRules = /* @__PURE__ */ new Map();
   for (const [tag, styles] of Object.entries(presetStyle)) {
     for (const styleDecl of styles) {
-      const selector = `${tag}:where([${componentAttribute}=${component}])${styleDecl.state ?? ""}`;
+      const selector = `${tag}:where([${componentAttribute}="${component}"])${styleDecl.state ?? ""}`;
       let rule = presetStyleRules.get(selector);
       if (rule === void 0) {
         rule = {};

package/lib/embed-template.js

@@ -15,41 +15,45 @@ const EmbedTemplateText = z.object({
   type: z.literal("text"),
   value: z.string()
 });
-const DataSourceVariableRef = z.object({
-  type: z.literal("variable"),
-  name: z.string()
-});
-const DataSourceRef = z.union([
-  DataSourceVariableRef,
+const EmbedTemplateDataSource = z.union([
+  z.object({
+    type: z.literal("variable"),
+    initialValue: z.union([
+      z.string(),
+      z.number(),
+      z.boolean(),
+      z.array(z.string())
+    ])
+  }),
   z.object({
     type: z.literal("expression"),
-    name: z.string(),
     code: z.string()
   })
 ]);
 const EmbedTemplateProp = z.union([
+  z.object({
+    type: z.literal("dataSource"),
+    name: z.string(),
+    dataSourceName: z.string()
+  }),
   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())
   }),
   z.object({
@@ -76,6 +80,7 @@ const EmbedTemplateInstance = z.lazy(
     type: z.literal("instance"),
     component: z.string(),
     label: z.optional(z.string()),
+    dataSources: z.optional(z.record(z.string(), EmbedTemplateDataSource)),
     props: z.optional(z.array(EmbedTemplateProp)),
     styles: z.optional(z.array(EmbedTemplateStyleDecl)),
     children: WsEmbedTemplate
@@ -84,11 +89,58 @@ const EmbedTemplateInstance = z.lazy(
 const WsEmbedTemplate = z.lazy(
   () => z.array(z.union([EmbedTemplateInstance, EmbedTemplateText]))
 );
+const getDataSourceValue = (value) => {
+  if (typeof value === "string") {
+    return { type: "string", value };
+  }
+  if (typeof value === "number") {
+    return { type: "number", value };
+  }
+  if (typeof value === "boolean") {
+    return { type: "boolean", value };
+  }
+  if (Array.isArray(value)) {
+    return { type: "string[]", value };
+  }
+  value;
+  throw Error("Impossible case");
+};
 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.dataSources) {
+        for (const [name, dataSource] of Object.entries(item.dataSources)) {
+          if (dataSourceByRef.has(name)) {
+            throw Error(`${name} data source already defined`);
+          }
+          if (dataSource.type === "variable") {
+            dataSourceByRef.set(name, {
+              type: "variable",
+              id: nanoid(),
+              scopeInstanceId: instanceId,
+              name,
+              value: getDataSourceValue(dataSource.initialValue)
+            });
+          }
+          if (dataSource.type === "expression") {
+            dataSourceByRef.set(name, {
+              type: "expression",
+              id: nanoid(),
+              scopeInstanceId: instanceId,
+              name,
+              // replace all references with variable names
+              code: validateExpression(dataSource.code, {
+                transformIdentifier: (ref) => {
+                  const id = dataSourceByRef.get(ref)?.id ?? ref;
+                  return encodeDataSourceVariable(id);
+                }
+              })
+            });
+          }
+        }
+      }
       if (item.props) {
         for (const prop of item.props) {
           const propId = nanoid();
@@ -119,51 +171,21 @@ const createInstancesFromTemplate = (treeTemplate, instances, props, dataSourceB
             });
             continue;
           }
-          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,
-                // replace all references with variable names
-                code: validateExpression(dataSourceRef.code, {
-                  transformIdentifier: (ref) => {
-                    const id2 = dataSourceByRef.get(ref)?.id ?? ref;
-                    return encodeDataSourceVariable(id2);
-                  }
-                })
-              };
-              dataSourceByRef.set(dataSourceRef.name, dataSource);
-            } else {
-              dataSourceRef;
-              continue;
+          if (prop.type === "dataSource") {
+            const dataSource = dataSourceByRef.get(prop.dataSourceName);
+            if (dataSource === void 0) {
+              throw Error(`${prop.dataSourceName} data source is not defined`);
             }
+            props.push({
+              id: propId,
+              instanceId,
+              type: "dataSource",
+              name: prop.name,
+              value: dataSource.id
+            });
+            continue;
           }
-          props.push({
-            id: propId,
-            instanceId,
-            type: "dataSource",
-            name: prop.name,
-            value: dataSource.id
-          });
+          props.push({ id: propId, instanceId, ...prop });
         }
       }
       if (item.styles) {
@@ -266,10 +288,34 @@ const namespaceEmbedTemplateComponents = (template, namespace, components) => {
     throw Error("Impossible case");
   });
 };
+const namespaceMeta = (meta, namespace, components) => {
+  const newMeta = { ...meta };
+  if (newMeta.requiredAncestors) {
+    newMeta.requiredAncestors = newMeta.requiredAncestors.map(
+      (component) => components.has(component) ? `${namespace}:${component}` : component
+    );
+  }
+  if (newMeta.invalidAncestors) {
+    newMeta.invalidAncestors = newMeta.invalidAncestors.map(
+      (component) => components.has(component) ? `${namespace}:${component}` : component
+    );
+  }
+  if (newMeta.indexWithinAncestor) {
+    newMeta.indexWithinAncestor = components.has(newMeta.indexWithinAncestor) ? `${namespace}:${newMeta.indexWithinAncestor}` : newMeta.indexWithinAncestor;
+  }
+  if (newMeta.template) {
+    newMeta.template = namespaceEmbedTemplateComponents(
+      newMeta.template,
+      namespace,
+      components
+    );
+  }
+  return newMeta;
+};
 export {
   EmbedTemplateInstance,
   EmbedTemplateStyleDecl,
   WsEmbedTemplate,
   generateDataFromEmbedTemplate,
-  namespaceEmbedTemplateComponents
+  namespaceMeta
 };

package/lib/hook.js

@@ -0,0 +1,14 @@
+const getClosestInstance = (instanceSelection, currentInstance, closestComponent) => {
+  let matched = false;
+  for (const instance of instanceSelection) {
+    if (currentInstance === instance) {
+      matched = true;
+    }
+    if (matched && instance.component === closestComponent) {
+      return instance;
+    }
+  }
+};
+export {
+  getClosestInstance
+};

package/lib/index.js

@@ -13,7 +13,8 @@ import {
   useInstanceProps,
   usePropUrl,
   usePropAsset,
-  getInstanceIdFromComponentProps
+  getInstanceIdFromComponentProps,
+  getIndexWithinAncestorFromComponentProps
 } from "./props";
 import { ReactSdkContext } from "./context";
 import {
@@ -28,6 +29,9 @@ import {
   decodeDataSourceVariable,
   decodeVariablesMap
 } from "./expression";
+import { renderComponentTemplate } from "./component-renderer";
+import { getIndexesWithinAncestors } from "./instance-utils";
+export * from "./hook";
 export {
   ReactSdkContext,
   componentCategories,
@@ -41,7 +45,10 @@ export {
   executeEffectfulExpression,
   generateComputingExpressions,
   generateEffectfulExpression,
+  getIndexWithinAncestorFromComponentProps,
+  getIndexesWithinAncestors,
   getInstanceIdFromComponentProps,
+  renderComponentTemplate,
   stateCategories,
   useInstanceProps,
   usePropAsset,

package/lib/instance-utils.js

@@ -0,0 +1,45 @@
+const getIndexesWithinAncestors = (metas, instances, rootIds) => {
+  const ancestors = /* @__PURE__ */ new Set();
+  for (const meta of metas.values()) {
+    if (meta.indexWithinAncestor !== void 0) {
+      ancestors.add(meta.indexWithinAncestor);
+    }
+  }
+  const indexes = /* @__PURE__ */ new Map();
+  const traverseInstances = (instances2, instanceId, latestIndexes2 = /* @__PURE__ */ new Map()) => {
+    const instance = instances2.get(instanceId);
+    if (instance === void 0) {
+      return;
+    }
+    const meta = metas.get(instance.component);
+    if (meta === void 0) {
+      return;
+    }
+    if (ancestors.has(instance.component)) {
+      latestIndexes2 = new Map(latestIndexes2);
+      latestIndexes2.set(instance.component, /* @__PURE__ */ new Map());
+    }
+    if (meta.indexWithinAncestor !== void 0) {
+      const ancestorIndexes = latestIndexes2.get(meta.indexWithinAncestor);
+      if (ancestorIndexes !== void 0) {
+        let index = ancestorIndexes.get(instance.component) ?? -1;
+        index += 1;
+        ancestorIndexes.set(instance.component, index);
+        indexes.set(instance.id, index);
+      }
+    }
+    for (const child of instance.children) {
+      if (child.type === "id") {
+        traverseInstances(instances2, child.value, latestIndexes2);
+      }
+    }
+  };
+  const latestIndexes = /* @__PURE__ */ new Map();
+  for (const instanceId of rootIds) {
+    traverseInstances(instances, instanceId, latestIndexes);
+  }
+  return indexes;
+};
+export {
+  getIndexesWithinAncestors
+};

package/lib/props.js

@@ -2,7 +2,7 @@ import { useContext, useMemo } from "react";
 import { computed } from "nanostores";
 import { useStore } from "@nanostores/react";
 import { ReactSdkContext } from "./context";
-import { idAttribute } from "./tree/webstudio-component";
+import { idAttribute, indexAttribute } from "./tree/webstudio-component";
 const getPropsByInstanceId = (props) => {
   const propsByInstanceId = /* @__PURE__ */ new Map();
   for (const prop of props.values()) {
@@ -21,13 +21,18 @@ const useInstanceProps = (instanceId) => {
     dataSourceValuesStore,
     executeEffectfulExpression,
     setDataSourceValues,
-    renderer
+    renderer,
+    indexesWithinAncestors
   } = useContext(ReactSdkContext);
+  const index = indexesWithinAncestors.get(instanceId);
   const instancePropsObjectStore = useMemo(() => {
     return computed(
       [propsByInstanceIdStore, dataSourceValuesStore],
       (propsByInstanceId, dataSourceValues) => {
         const instancePropsObject2 = {};
+        if (index !== void 0) {
+          instancePropsObject2[indexAttribute] = index.toString();
+        }
         const instanceProps = propsByInstanceId.get(instanceId);
         if (instanceProps === void 0) {
           return instancePropsObject2;
@@ -77,7 +82,8 @@ const useInstanceProps = (instanceId) => {
     instanceId,
     renderer,
     executeEffectfulExpression,
-    setDataSourceValues
+    setDataSourceValues,
+    index
   ]);
   const instancePropsObject = useStore(instancePropsObjectStore);
   return instancePropsObject;
@@ -164,7 +170,11 @@ const usePropUrl = (instanceId, name) => {
 const getInstanceIdFromComponentProps = (props) => {
   return props[idAttribute];
 };
+const getIndexWithinAncestorFromComponentProps = (props) => {
+  return props[indexAttribute];
+};
 export {
+  getIndexWithinAncestorFromComponentProps,
   getInstanceIdFromComponentProps,
   getPropsByInstanceId,
   resolveUrlProp,

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

@@ -2,7 +2,6 @@ import { jsx, jsxs } from "react/jsx-runtime";
 import {
   Fragment
 } from "react";
-import { Scripts, ScrollRestoration } from "@remix-run/react";
 import {
   ReactSdkContext
 } from "../context";
@@ -18,8 +17,10 @@ const createElementsTree = ({
   dataSourceValuesStore,
   executeEffectfulExpression,
   onDataSourceUpdate,
+  indexesWithinAncestors,
   Component,
-  components
+  components,
+  scripts
 }) => {
   const rootInstance = instances.get(rootInstanceId);
   if (rootInstance === void 0) {
@@ -40,8 +41,7 @@ const createElementsTree = ({
     children: [
       /* @__PURE__ */ jsxs(Fragment, { children: [
         children,
-        /* @__PURE__ */ jsx(ScrollRestoration, {}),
-        /* @__PURE__ */ jsx(Scripts, {})
+        scripts
       ] }, "children")
     ],
     components
@@ -57,6 +57,7 @@ const createElementsTree = ({
         renderer,
         imageBaseUrl,
         assetBaseUrl,
+        indexesWithinAncestors,
         executeEffectfulExpression,
         setDataSourceValues: onDataSourceUpdate,
         setBoundDataSourceValue: (instanceId, propName, value) => {

package/lib/tree/root.js

@@ -14,10 +14,12 @@ import {
 import { getPropsByInstanceId } from "../props";
 const InstanceRoot = ({
   data,
+  indexesWithinAncestors,
   executeComputingExpressions,
   executeEffectfulExpression,
   Component,
-  components
+  components,
+  scripts
 }) => {
   const dataSourceVariablesStoreRef = useRef(void 0);
   if (dataSourceVariablesStoreRef.current === void 0) {
@@ -69,11 +71,13 @@ const InstanceRoot = ({
     ),
     assetsStore: atom(new Map(data.assets.map((asset) => [asset.id, asset]))),
     pagesStore: atom(new Map(data.pages.map((page) => [page.id, page]))),
+    indexesWithinAncestors,
     executeEffectfulExpression,
     dataSourceValuesStore,
     onDataSourceUpdate,
     Component: Component ?? WebstudioComponent,
-    components
+    components,
+    scripts
   });
 };
 export {

package/lib/tree/webstudio-component.js

@@ -39,6 +39,7 @@ const idAttribute = "data-ws-id";
 const selectorIdAttribute = "data-ws-selector";
 const componentAttribute = "data-ws-component";
 const showAttribute = "data-ws-show";
+const indexAttribute = "data-ws-index";
 const collapsedAttribute = "data-ws-collapsed";
 const splitPropsWithWebstudioAttributes = ({
   [idAttribute]: idAttributeValue,
@@ -62,6 +63,7 @@ export {
   collapsedAttribute,
   componentAttribute,
   idAttribute,
+  indexAttribute,
   renderWebstudioComponentChildren,
   selectorIdAttribute,
   showAttribute,

package/lib/types/component-renderer.d.ts

@@ -0,0 +1,8 @@
+import type { ExoticComponent } from "react";
+import type { Instance } from "@webstudio-is/project-build";
+import type { WsComponentMeta } from "./components/component-meta";
+export declare const renderComponentTemplate: ({ name, metas: metasRecord, components, }: {
+    name: Instance["component"];
+    metas: Record<string, WsComponentMeta>;
+    components: Record<string, ExoticComponent<any>>;
+}) => import("react/jsx-runtime").JSX.Element;