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
Store preset style separately from tree (#724)
Bogdan Chadkind79c96566be2
diff --git a/apps/designer/app/canvas/canvas.tsx b/apps/designer/app/canvas/canvas.tsxindex a1a9ee5453..0ff5de5389 100644--- a/apps/designer/app/canvas/canvas.tsx+++ b/apps/designer/app/canvas/canvas.tsx@@ -37,6 +37,7 @@ import {rootInstanceContainer,useBreakpoints,useRootInstance,+ useSetPresetStyles,useSubscribeScrollState,} from "~/shared/nano-states";import { registerContainers } from "./shared/immerhin";@@ -174,6 +175,7 @@ export const Canvas = ({ data }: CanvasProps): JSX.Element | null => {useInitializeDesignTokens(data.designTokens);const assets = useAssets(data.assets);useAllUserProps(data.props);+ useSetPresetStyles(data.tree?.presetStyles);usePopulateRootInstance(data.tree);setParams(data.params ?? null);diff --git a/apps/designer/app/canvas/shared/styles.ts b/apps/designer/app/canvas/shared/styles.tsindex 1d9fdda85b..bd9ebaba12 100644--- a/apps/designer/app/canvas/shared/styles.ts+++ b/apps/designer/app/canvas/shared/styles.ts@@ -6,8 +6,13 @@ import {designTokensContainer,rootInstanceContainer,useDesignTokens,+ usePresetStyles,} from "~/shared/nano-states";-import { idAttribute } from "@webstudio-is/react-sdk";+import {+ getComponentMeta,+ getComponentNames,+ idAttribute,+} from "@webstudio-is/react-sdk";import {validStaticValueTypes,type Breakpoint,@@ -71,23 +76,20 @@ const fontsAndDefaultsCssEngine = createCssEngine({name: "fonts-and-defaults",});const tokensCssEngine = createCssEngine({ name: "tokens" });+const presetStylesEngine = createCssEngine({ name: "presetStyles" });export const GlobalStyles = ({ assets }: { assets: Array<Asset> }) => {useIsomorphicLayoutEffect(() => {for (const style of helperStyles) {helpersCssEngine.addPlaintextRule(style);}- if (typeof document !== "undefined") {- helpersCssEngine.render();- }+ helpersCssEngine.render();}, []);useIsomorphicLayoutEffect(() => {fontsAndDefaultsCssEngine.clear();addGlobalRules(fontsAndDefaultsCssEngine, { assets });- if (typeof document !== "undefined") {- fontsAndDefaultsCssEngine.render();- }+ fontsAndDefaultsCssEngine.render();}, [assets]);const [tokens] = useDesignTokens();@@ -99,11 +101,28 @@ export const GlobalStyles = ({ assets }: { assets: Array<Asset> }) => {tokensCssEngine.addStyleRule(`:root`, { style });}- if (typeof document !== "undefined") {- tokensCssEngine.render();- }+ tokensCssEngine.render();}, [tokens]);+ const [presetStyles] = usePresetStyles();++ useIsomorphicLayoutEffect(() => {+ presetStylesEngine.clear();+ const presetStylesMap = utils.tree.getPresetStylesMap(presetStyles);+ for (const component of getComponentNames()) {+ const meta = getComponentMeta(component);+ // render preset style and fallback to hardcoded one+ // because could not be added yet to db+ const presetStyle = presetStylesMap.get(component) ?? meta.presetStyle;+ if (presetStyle !== undefined) {+ presetStylesEngine.addStyleRule(`[data-ws-component=${component}]`, {+ style: presetStyle,+ });+ }+ }+ presetStylesEngine.render();+ }, [presetStyles]);+return null;};diff --git a/apps/designer/app/canvas/shared/use-drag-drop.ts b/apps/designer/app/canvas/shared/use-drag-drop.tsindex d747092c74..4e0d976c0f 100644--- a/apps/designer/app/canvas/shared/use-drag-drop.ts+++ b/apps/designer/app/canvas/shared/use-drag-drop.ts@@ -1,6 +1,5 @@import { useLayoutEffect, useRef } from "react";import {- useBreakpoints,useRootInstance,useTextEditingInstanceId,} from "~/shared/nano-states";@@ -64,7 +63,6 @@ const initialState: {export const useDragAndDrop = () => {const [rootInstance] = useRootInstance();const [textEditingInstanceId] = useTextEditingInstanceId();- const [breakpoints] = useBreakpoints();const state = useRef({ ...initialState });@@ -288,12 +286,9 @@ export const useDragAndDrop = () => {const { dropTarget, dragItem } = state.current;if (dropTarget && dragItem && isCanceled === false) {- const instance = utils.tree.populateInstance(- utils.tree.createInstance({- component: dragItem.component,- }),- breakpoints[0].id- );+ const instance = utils.tree.createInstance({+ component: dragItem.component,+ });publish({type: "insertInstance",diff --git a/apps/designer/app/designer/features/sidebar-left/panels/components/components.tsx b/apps/designer/app/designer/features/sidebar-left/panels/components/components.tsxindex 9ebe854718..32fff82ed4 100644--- a/apps/designer/app/designer/features/sidebar-left/panels/components/components.tsx+++ b/apps/designer/app/designer/features/sidebar-left/panels/components/components.tsx@@ -14,7 +14,6 @@ import type { TabName } from "../../types";import { ComponentThumb } from "./component-thumb";import { useCanvasRect, useZoom } from "~/designer/shared/nano-states";import { Header, CloseButton } from "../../lib/header";-import { useBreakpoints } from "~/shared/nano-states";type DraggableThumbProps = {onClick: MouseEventHandler<HTMLDivElement>;@@ -85,7 +84,6 @@ const elementToComponentName = (export const TabContent = ({ publish, onSetActiveTab }: TabContentProps) => {const [dragComponent, setDragComponent] = useState<Instance["component"]>();const [point, setPoint] = useState<Point>({ x: 0, y: 0 });- const [breakpoints] = useBreakpoints();const [canvasRect] = useCanvasRect();const [zoom] = useZoom();@@ -167,12 +165,9 @@ export const TabContent = ({ publish, onSetActiveTab }: TabContentProps) => {component={component}onClick={() => {onSetActiveTab("none");- const instance = utils.tree.populateInstance(- utils.tree.createInstance({- component,- }),- breakpoints[0].id- );+ const instance = utils.tree.createInstance({+ component,+ });publish({type: "insertInstance",payload: { instance },diff --git a/apps/designer/app/shared/css-utils/generate-css-text.ts b/apps/designer/app/shared/css-utils/generate-css-text.tsindex 846e646157..1f306e178d 100644--- a/apps/designer/app/shared/css-utils/generate-css-text.ts+++ b/apps/designer/app/shared/css-utils/generate-css-text.ts@@ -31,6 +31,13 @@ export const generateCssText = async (buildParams: BuildParams) => {engine.addMediaRule(breakpoint.id, breakpoint);}+ const presetStylesMap = utils.tree.getPresetStylesMap(+ canvasData.tree?.presetStyles+ );+ for (const [component, style] of presetStylesMap) {+ engine.addStyleRule(`[data-ws-component="${component}"]`, { style });+ }+const cssRules = utils.tree.getCssRules(canvasData.tree?.root);for (const [instanceId, cssRule] of cssRules) {engine.addStyleRule(`[${idAttribute}="${instanceId}"]`, cssRule);diff --git a/apps/designer/app/shared/nano-states/nano-states.ts b/apps/designer/app/shared/nano-states/nano-states.tsindex 15bb9d797e..77fa8ea97a 100644--- a/apps/designer/app/shared/nano-states/nano-states.ts+++ b/apps/designer/app/shared/nano-states/nano-states.ts@@ -1,5 +1,6 @@+import { useState } from "react";import { createValueContainer, useValue } from "react-nano-state";-import type { Instance } from "@webstudio-is/react-sdk";+import type { Instance, PresetStyles } from "@webstudio-is/react-sdk";import type {DropTargetChangePayload,DragStartPayload,@@ -12,6 +13,16 @@ export const rootInstanceContainer = createValueContainer<>();export const useRootInstance = () => useValue(rootInstanceContainer);+export const presetStylesContainer = createValueContainer<PresetStyles>([]);+export const usePresetStyles = () => useValue(presetStylesContainer);+export const useSetPresetStyles = (presetStyles?: PresetStyles) => {+ useState(() => {+ if (presetStyles) {+ presetStylesContainer.value = presetStyles;+ }+ });+};+export const breakpointsContainer = createValueContainer<Array<Breakpoint>>([]);export const useBreakpoints = () => useValue(breakpointsContainer);diff --git a/packages/prisma-client/prisma/migrations/20221230120125_tree_preset_styles/migration.sql b/packages/prisma-client/prisma/migrations/20221230120125_tree_preset_styles/migration.sqlnew file mode 100644index 0000000000..1d80ddac92--- /dev/null+++ b/packages/prisma-client/prisma/migrations/20221230120125_tree_preset_styles/migration.sql@@ -0,0 +1,2 @@+-- AlterTable+ALTER TABLE "Tree" ADD COLUMN "presetStyles" TEXT NOT NULL DEFAULT '[]';diff --git a/packages/prisma-client/prisma/schema.prisma b/packages/prisma-client/prisma/schema.prismaindex 8e0c4463bb..b0f53c32f9 100644--- a/packages/prisma-client/prisma/schema.prisma+++ b/packages/prisma-client/prisma/schema.prisma@@ -77,8 +77,9 @@ model Build {}model Tree {- id String @id @default(uuid())- root String+ id String @id @default(uuid())+ root String+ presetStyles String @default("[]")}model InstanceProps {diff --git a/packages/project/src/db/build.ts b/packages/project/src/db/build.tsindex 6523503a0f..bc15445e67 100644--- a/packages/project/src/db/build.ts+++ b/packages/project/src/db/build.ts@@ -1,6 +1,5 @@import { v4 as uuid } from "uuid";import { prisma, Build as DbBuild, Prisma } from "@webstudio-is/prisma-client";-import { type Breakpoint } from "@webstudio-is/css-data";import { db as designTokensDb } from "@webstudio-is/design-tokens/server";import * as db from ".";import { Build, Page, Pages } from "./schema";@@ -82,10 +81,7 @@ export const addPage = async (Partial<Omit<Page, "id" | "treeId" | "name" | "path">>) => {return updatePages(buildId, async (currentPages) => {- const breakpoints = await db.breakpoints.load(buildId);- const tree = await db.tree.create(- db.tree.createRootInstance(breakpoints.values)- );+ const tree = await db.tree.create(db.tree.createTree());return {homePage: currentPages.homePage,@@ -157,14 +153,8 @@ export const deletePage = async (buildId: Build["id"], pageId: Page["id"]) => {});};-const createPages = async (- breakpoints: Array<Breakpoint>,- client: Prisma.TransactionClient = prisma-) => {- const tree = await db.tree.create(- db.tree.createRootInstance(breakpoints),- client- );+const createPages = async (client: Prisma.TransactionClient = prisma) => {+ const tree = await db.tree.create(db.tree.createTree(), client);return Pages.parse({homePage: {id: uuid(),@@ -245,7 +235,7 @@ export async function create(await prisma.$transaction(async (client) => {const pages =sourceBuild === undefined- ? await createPages(breakpointsValues, client)+ ? await createPages(client): await clonePages(sourceBuild.pages, client);if (env === "prod") {diff --git a/packages/project/src/db/tree.ts b/packages/project/src/db/tree.tsindex 3317b88619..65969e2986 100644--- a/packages/project/src/db/tree.ts+++ b/packages/project/src/db/tree.ts@@ -1,5 +1,12 @@import { formatAsset } from "@webstudio-is/asset-uploader/server";-import { type Tree, Instance, Text } from "@webstudio-is/react-sdk";+import {+ type Tree,+ type ComponentName,+ Instance,+ Text,+ PresetStyles,+ findMissingPresetStyles,+} from "@webstudio-is/react-sdk";import { applyPatches, type Patch } from "immer";import {Asset,@@ -8,11 +15,7 @@ import {type Tree as DbTree,} from "@webstudio-is/prisma-client";import { utils } from "../index";-import {- type Breakpoint,- SharedStyleValue,- ImageValue,-} from "@webstudio-is/css-data";+import { SharedStyleValue, ImageValue } from "@webstudio-is/css-data";import { z } from "zod";import DataLoader from "dataloader";import warnOnce from "warn-once";@@ -122,26 +125,30 @@ const InstanceDbIn = z.lazy(() =>})) as /* Instance is wrong type here, ImageValue is different after transform. We don't use it anyway */ z.ZodType<Instance>;-export const createRootInstance = (breakpoints: Array<Breakpoint>) => {- // Take the smallest breakpoint as default- const defaultBreakpoint = utils.breakpoints.sort(breakpoints)[0];- if (defaultBreakpoint === undefined) {- throw new Error("A breakpoint with minWidth 0 is required");- }- const instance = utils.tree.createInstance({ component: "Body" });- return utils.tree.populateInstance(instance, defaultBreakpoint.id);+type TreeData = Omit<Tree, "id">;++export const createTree = (): TreeData => {+ const root = utils.tree.createInstance({ component: "Body" });+ const presetStyles = findMissingPresetStyles([], [root.component]);++ return {+ root,+ presetStyles,+ };};export const create = async (- clientRoot: Instance,+ treeData: TreeData,client: Prisma.TransactionClient = prisma): Promise<DbTree> => {- const root = InstanceDbIn.parse(clientRoot);-- const rootString = JSON.stringify(root);+ treeData.root;+ const root = InstanceDbIn.parse(treeData.root);return await client.tree.create({- data: { root: rootString },+ data: {+ root: JSON.stringify(root),+ presetStyles: JSON.stringify(treeData.presetStyles),+ },});};@@ -167,9 +174,12 @@ export const loadById = async (Instance.parse(root);+ const presetStyles = PresetStyles.parse(JSON.parse(tree.presetStyles));+return {...tree,root,+ presetStyles,};};@@ -181,7 +191,16 @@ export const clone = async (if (tree === null) {throw new Error(`Tree ${treeId} not found`);}- return await create(tree.root, client);+ return await create(tree, client);+};++const collectUsedComponents = (instance: Instance, components: Set<string>) => {+ components.add(instance.component);+ for (const child of instance.children) {+ if (child.type === "instance") {+ collectUsedComponents(child, components);+ }+ }};export const patch = async (@@ -193,11 +212,21 @@ export const patch = async (throw new Error(`Tree ${treeId} not found`);}const clientRoot = applyPatches(tree.root, patches);+ const components = new Set<ComponentName>();+ collectUsedComponents(tree.root, components);+ const missingPresetStyles = findMissingPresetStyles(+ tree.presetStyles,+ Array.from(components)+ );+ const presetStyles = [...tree.presetStyles, ...missingPresetStyles];const root = InstanceDbIn.parse(clientRoot);await prisma.tree.update({- data: { root: JSON.stringify(root) },+ data: {+ root: JSON.stringify(root),+ presetStyles: JSON.stringify(presetStyles),+ },where: { id: treeId },});};diff --git a/packages/project/src/shared/tree-utils/get-css-rules.test.ts b/packages/project/src/shared/tree-utils/get-css-rules.test.tsindex fde45dbd5a..06847cbc9f 100644--- a/packages/project/src/shared/tree-utils/get-css-rules.test.ts+++ b/packages/project/src/shared/tree-utils/get-css-rules.test.ts@@ -1,6 +1,6 @@import { describe, test, expect } from "@jest/globals";import { type Instance } from "@webstudio-is/react-sdk";-import { getCssRules } from "./get-css-rules";+import { getCssRules, getPresetStylesMap } from "./get-css-rules";describe("Get all cssRules from an instance including children", () => {test("getCssRules", () => {@@ -86,3 +86,44 @@ describe("Get all cssRules from an instance including children", () => {`);});});++test("get a map of preset style objects per component", () => {+ expect(+ getPresetStylesMap([+ {+ component: "Box",+ property: "width",+ value: { type: "keyword", value: "auto" },+ },+ {+ component: "Box",+ property: "height",+ value: { type: "keyword", value: "auto" },+ },+ {+ component: "Paragraph",+ property: "width",+ value: { type: "keyword", value: "auto" },+ },+ ])+ ).toMatchInlineSnapshot(`+ Map {+ "Box" => {+ "height": {+ "type": "keyword",+ "value": "auto",+ },+ "width": {+ "type": "keyword",+ "value": "auto",+ },+ },+ "Paragraph" => {+ "width": {+ "type": "keyword",+ "value": "auto",+ },+ },+ }+ `);+});diff --git a/packages/project/src/shared/tree-utils/get-css-rules.ts b/packages/project/src/shared/tree-utils/get-css-rules.tsindex 1671ed2b3a..4638af04a6 100644--- a/packages/project/src/shared/tree-utils/get-css-rules.ts+++ b/packages/project/src/shared/tree-utils/get-css-rules.ts@@ -1,5 +1,5 @@-import type { CssRule } from "@webstudio-is/css-data";-import type { Instance } from "@webstudio-is/react-sdk";+import type { CssRule, Style } from "@webstudio-is/css-data";+import type { Instance, PresetStyles } from "@webstudio-is/react-sdk";const aggregateCssRules = (instance: Instance,@@ -23,3 +23,19 @@ export const getCssRules = (instance?: Instance) => {}return result;};++export const getPresetStylesMap = (presetStyles?: PresetStyles) => {+ const presetStylesMap = new Map<string, Style>();+ if (presetStyles === undefined) {+ return presetStylesMap;+ }+ for (const { component, property, value } of presetStyles) {+ let style = presetStylesMap.get(component);+ if (style === undefined) {+ style = {};+ presetStylesMap.set(component, style);+ }+ style[property] = value;+ }+ return presetStylesMap;+};diff --git a/packages/project/src/shared/tree-utils/index.ts b/packages/project/src/shared/tree-utils/index.tsindex f31902559a..59acb2ba39 100644--- a/packages/project/src/shared/tree-utils/index.ts+++ b/packages/project/src/shared/tree-utils/index.ts@@ -1,7 +1,6 @@export * from "./create-instance";export * from "./delete-instance";export * from "./insert-instance";-export * from "./populate";export * from "./find-instance";export * from "./set-instance-style";export * from "./get-instance-path";diff --git a/packages/project/src/shared/tree-utils/populate.ts b/packages/project/src/shared/tree-utils/populate.tsdeleted file mode 100644index 4578b108fd..0000000000--- a/packages/project/src/shared/tree-utils/populate.ts+++ /dev/null@@ -1,23 +0,0 @@-import { Breakpoint } from "@webstudio-is/css-data";-import { type Instance, getComponentMeta } from "@webstudio-is/react-sdk";--/**- * Populate instance with:- * - presetStyle- * @todo rewrite using immer- */-export const populateInstance = (- instance: Instance,- breakpoint: Breakpoint["id"] = ""-): Instance => {- const populatedInstance = { ...instance };- const componentMeta = getComponentMeta(instance.component);- if (componentMeta !== undefined && "presetStyle" in componentMeta) {- const cssRule = {- breakpoint,- style: componentMeta.presetStyle ?? {},- };- populatedInstance.cssRules.push(cssRule);- }- return populatedInstance;-};diff --git a/packages/project/src/shared/tree-utils/set-instance-children.ts b/packages/project/src/shared/tree-utils/set-instance-children.tsindex cb7a1fa34d..745f43929a 100644--- a/packages/project/src/shared/tree-utils/set-instance-children.ts+++ b/packages/project/src/shared/tree-utils/set-instance-children.ts@@ -2,7 +2,6 @@ import type { Breakpoint } from "@webstudio-is/css-data";import type { ChildrenUpdates, Instance, Text } from "@webstudio-is/react-sdk";import { createInstance, createInstanceId } from "./create-instance";import { findInstanceById } from "./find-instance";-import { populateInstance } from "./populate";type InstanceChild = Instance | Text;@@ -27,7 +26,6 @@ const hydrateTree = (component: update.component,children: [],});- populateInstance(child, breakpoint);}children.push(child);hydrateTree(child, update.children, breakpoint);diff --git a/packages/react-sdk/src/db/index.ts b/packages/react-sdk/src/db/index.tsindex d06accd8c1..481cfdd2eb 100644--- a/packages/react-sdk/src/db/index.ts+++ b/packages/react-sdk/src/db/index.ts@@ -1,2 +1,3 @@export * from "./types";export * from "./instance";+export * from "./style";diff --git a/packages/react-sdk/src/db/style.ts b/packages/react-sdk/src/db/style.tsnew file mode 100644index 0000000000..5e4e89c332--- /dev/null+++ b/packages/react-sdk/src/db/style.ts@@ -0,0 +1,53 @@+import { z } from "zod";+import type { StyleProperty, StyleValue } from "@webstudio-is/css-data";+import { SharedStyleValue } from "@webstudio-is/css-data";+import {+ type ComponentName,+ getComponentMeta,+ getComponentNames,+} from "../components";++export type PresetStylesItem = {+ component: ComponentName;+ property: StyleProperty;+ value: StyleValue;+};++// @todo can't figure out how to make property to be enum+export const PresetStylesItem = z.object({+ component: z.enum(getComponentNames() as [ComponentName]),+ property: z.string(),+ value: SharedStyleValue,+}) as z.ZodType<PresetStylesItem>;++export const PresetStyles = z.array(PresetStylesItem);++export type PresetStyles = z.infer<typeof PresetStyles>;++export const findMissingPresetStyles = (+ presetStyles: PresetStyles,+ components: ComponentName[]+) => {+ const populatedComponents = new Set();+ for (const style of presetStyles) {+ populatedComponents.add(style.component);+ }+ const missingPresetStyles: PresetStyles = [];+ for (const component of components) {+ if (populatedComponents.has(component)) {+ continue;+ }+ const meta = getComponentMeta(component);+ if (meta.presetStyle === undefined) {+ continue;+ }+ for (const [property, value] of Object.entries(meta.presetStyle)) {+ missingPresetStyles.push({+ component,+ property: property as StyleProperty,+ value,+ });+ }+ }+ return missingPresetStyles;+};diff --git a/packages/react-sdk/src/db/types.ts b/packages/react-sdk/src/db/types.tsindex 0610732588..2a526ac4c6 100644--- a/packages/react-sdk/src/db/types.ts+++ b/packages/react-sdk/src/db/types.ts@@ -1,10 +1,12 @@import type { InstanceProps as DbInstanceProps } from "@webstudio-is/prisma-client";import type { UserProp } from "../user-props";import type { Instance } from "./instance";+import type { PresetStyles } from "./style";export type Tree = {id: string;root: Instance;+ presetStyles: PresetStyles;};export type Props = {@@ -13,6 +15,7 @@ export type Props = {instanceId: string;treeId: string;};+export type InstanceProps = Omit<DbInstanceProps, "props"> & {props: Array<UserProp>;};