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
refactor: move filter parsers to generic value parser (#3729)
Bogdan Chadkin6b52b5ad4e55
diff --git a/packages/css-data/src/parse-css-value.test.ts b/packages/css-data/src/parse-css-value.test.tsindex 2359e8fc21..8beac987c6 100644--- a/packages/css-data/src/parse-css-value.test.ts+++ b/packages/css-data/src/parse-css-value.test.ts@@ -736,3 +736,137 @@ describe("parse shadows", () => {});});});++describe("parse filters", () => {+ test("parse values and returns the valid style property values", () => {+ expect(parseCssValue("filter", "blur(4px)")).toEqual({+ type: "tuple",+ value: [+ {+ type: "function",+ name: "blur",+ args: {+ type: "tuple",+ value: [{ type: "unit", unit: "px", value: 4 }],+ },+ },+ ],+ });+ expect(+ parseCssValue("filter", "drop-shadow(10px 10px 25px rgba(0, 0, 255, 1))")+ ).toEqual({+ type: "tuple",+ value: [+ {+ type: "function",+ name: "drop-shadow",+ args: {+ type: "tuple",+ value: [+ { type: "unit", unit: "px", value: 10 },+ { type: "unit", unit: "px", value: 10 },+ { type: "unit", unit: "px", value: 25 },+ { alpha: 1, b: 255, g: 0, r: 0, type: "rgb" },+ ],+ },+ },+ ],+ });+ expect(+ parseCssValue("filter", "drop-shadow(10px 10px 25px #0000FF)")+ ).toEqual({+ type: "tuple",+ value: [+ {+ type: "function",+ name: "drop-shadow",+ args: {+ type: "tuple",+ value: [+ { type: "unit", unit: "px", value: 10 },+ { type: "unit", unit: "px", value: 10 },+ { type: "unit", unit: "px", value: 25 },+ { alpha: 1, b: 255, g: 0, r: 0, type: "rgb" },+ ],+ },+ },+ ],+ });+ });++ test("parse backdrop-filter", () => {+ expect(parseCssValue("backdropFilter", "blur(4px)")).toEqual({+ type: "tuple",+ value: [+ {+ type: "function",+ name: "blur",+ args: {+ type: "tuple",+ value: [{ type: "unit", unit: "px", value: 4 }],+ },+ },+ ],+ });+ });++ test("Multiple valid function values", () => {+ expect(+ parseCssValue(+ "filter",+ "blur(4px) drop-shadow(16px 16px 20px blue) opacity(25%)"+ )+ ).toEqual({+ type: "tuple",+ value: [+ {+ type: "function",+ name: "blur",+ args: {+ type: "tuple",+ value: [{ type: "unit", unit: "px", value: 4 }],+ },+ },+ {+ type: "function",+ name: "drop-shadow",+ args: {+ type: "tuple",+ value: [+ { type: "unit", unit: "px", value: 16 },+ { type: "unit", unit: "px", value: 16 },+ { type: "unit", unit: "px", value: 20 },+ { type: "keyword", value: "blue" },+ ],+ },+ },+ {+ type: "function",+ name: "opacity",+ args: {+ type: "tuple",+ value: [{ type: "unit", unit: "%", value: 25 }],+ },+ },+ ],+ });+ });++ // parsers are used to use copied value. At the moment, we don't have support+ // for complex functions in the UI like the one below like calc(4px + 16em)+ test("Using complex functions inside filter function", () => {+ expect(parseCssValue("filter", "blur(calc(4px + 16em))")).toEqual({+ type: "tuple",+ value: [+ {+ type: "function",+ name: "blur",+ args: {+ type: "tuple",+ value: [],+ },+ },+ ],+ });+ });+});diff --git a/packages/css-data/src/parse-css-value.ts b/packages/css-data/src/parse-css-value.tsindex 175f948076..a137aeb7e6 100644--- a/packages/css-data/src/parse-css-value.ts+++ b/packages/css-data/src/parse-css-value.ts@@ -17,10 +17,10 @@ import {type Unit,type VarValue,type FunctionValue,+ type TupleValueItem,} from "@webstudio-is/css-engine";import { keywordValues } from "./__generated__/keyword-values";import { units } from "./__generated__/units";-import { parseFilter } from "./property-parsers/filter";export const cssTryParseValue = (input: string) => {try {@@ -141,6 +141,8 @@ const tupleProps = new Set<StyleProperty>(["translate","rotate","transform",+ "filter",+ "backdropFilter",]);const availableUnits = new Set<string>(Object.values(units).flat());@@ -245,6 +247,8 @@ const parseLiteral = (};}}++ // functions with comma-separated argumentsif (// <transform-function>// 2d@@ -287,6 +291,33 @@ const parseLiteral = (}return { type: "function", args, name: node.name };}++ // functions with space separated arguments+ if (+ // <filter-function>+ node.name === "blur" ||+ node.name === "brightness" ||+ node.name === "contrast" ||+ node.name === "drop-shadow" ||+ node.name === "grayscale" ||+ node.name === "hue-rotate" ||+ node.name === "invert" ||+ node.name === "opacity" ||+ node.name === "sepia" ||+ node.name === "saturate"+ ) {+ const args: TupleValue = { type: "tuple", value: [] };+ for (const arg of node.children) {+ const matchedValue = parseLiteral(arg);+ if (matchedValue) {+ args.value.push(matchedValue as TupleValueItem);+ }+ if (arg.type === "Identifier") {+ args.value.push({ type: "keyword", value: arg.name });+ }+ }+ return { type: "function", args, name: node.name };+ }}};@@ -332,10 +363,6 @@ export const parseCssValue = (return invalidValue;}- if (property === "filter" || property === "backdropFilter") {- return parseFilter(property, input);- }-// prevent infinite splitting into layers for itemsif (repeatedProps.has(property) && topLevel) {const nodes = "children" in ast ? ast.children?.toArray() ?? [] : [ast];diff --git a/packages/css-data/src/property-parsers/README.md b/packages/css-data/src/property-parsers/README.mddeleted file mode 100644index b4da473a39..0000000000--- a/packages/css-data/src/property-parsers/README.md+++ /dev/null@@ -1,11 +0,0 @@-## Properties Parsers--This folder contains:--- `parsers.ts` individual properties parses-- `to-longhand.ts` shorthand forms unwrappers--The idea is that these two modules export a number of utilities whose name match the property that they parse or unwrap e.g.:--- `backgroundImage` is a property parser-- `background` is a "to-longhand" unwrapperdiff --git a/packages/css-data/src/property-parsers/filter.test.ts b/packages/css-data/src/property-parsers/filter.test.tsdeleted file mode 100644index 0dc33d9eaf..0000000000--- a/packages/css-data/src/property-parsers/filter.test.ts+++ /dev/null@@ -1,201 +0,0 @@-import { describe, expect, test } from "@jest/globals";-import { parseFilter } from "./filter";--describe("parse filter", () => {- test("parse values and returns the valid style property values", () => {- expect(parseFilter("filter", "blur(4px)")).toMatchInlineSnapshot(`-{- "type": "tuple",- "value": [- {- "args": {- "type": "tuple",- "value": [- {- "type": "unit",- "unit": "px",- "value": 4,- },- ],- },- "name": "blur",- "type": "function",- },- ],-}-`);-- expect(- parseFilter("filter", "drop-shadow(10px 10px 25px rgba(0, 0, 255, 1))")- ).toMatchInlineSnapshot(`-{- "type": "tuple",- "value": [- {- "args": {- "type": "tuple",- "value": [- {- "type": "unit",- "unit": "px",- "value": 10,- },- {- "type": "unit",- "unit": "px",- "value": 10,- },- {- "type": "unit",- "unit": "px",- "value": 25,- },- {- "alpha": 1,- "b": 255,- "g": 0,- "r": 0,- "type": "rgb",- },- ],- },- "name": "drop-shadow",- "type": "function",- },- ],-}-`);-- expect(parseFilter("filter", "drop-shadow(10px 10px 25px #0000FF)"))- .toMatchInlineSnapshot(`-{- "type": "tuple",- "value": [- {- "args": {- "type": "tuple",- "value": [- {- "type": "unit",- "unit": "px",- "value": 10,- },- {- "type": "unit",- "unit": "px",- "value": 10,- },- {- "type": "unit",- "unit": "px",- "value": 25,- },- {- "alpha": 1,- "b": 255,- "g": 0,- "r": 0,- "type": "rgb",- },- ],- },- "name": "drop-shadow",- "type": "function",- },- ],-}-`);- });-- test("Multiple valid function values", () => {- expect(- parseFilter(- "filter",- "blur(4px) drop-shadow(16px 16px 20px blue) opacity(25%)"- )- ).toMatchInlineSnapshot(`-{- "type": "tuple",- "value": [- {- "args": {- "type": "tuple",- "value": [- {- "type": "unit",- "unit": "px",- "value": 4,- },- ],- },- "name": "blur",- "type": "function",- },- {- "args": {- "type": "tuple",- "value": [- {- "type": "unit",- "unit": "px",- "value": 16,- },- {- "type": "unit",- "unit": "px",- "value": 16,- },- {- "type": "unit",- "unit": "px",- "value": 20,- },- {- "type": "keyword",- "value": "blue",- },- ],- },- "name": "drop-shadow",- "type": "function",- },- {- "args": {- "type": "tuple",- "value": [- {- "type": "unit",- "unit": "%",- "value": 25,- },- ],- },- "name": "opacity",- "type": "function",- },- ],-}-`);- });-- // parsers are used to use copied value. At the moment, we don't have support- // for complex functions in the UI like the one below like calc(4px + 16em)- test("Using complex functions inside filter function", () => {- expect(parseFilter("filter", "blur(calc(4px + 16em))"))- .toMatchInlineSnapshot(`-{- "type": "tuple",- "value": [- {- "args": {- "type": "tuple",- "value": [],- },- "name": "blur",- "type": "function",- },- ],-}-`);- });-});diff --git a/packages/css-data/src/property-parsers/filter.ts b/packages/css-data/src/property-parsers/filter.tsdeleted file mode 100644index f080a3ac2e..0000000000--- a/packages/css-data/src/property-parsers/filter.ts+++ /dev/null@@ -1,129 +0,0 @@-import * as csstree from "css-tree";-import type {- InvalidValue,- TupleValue,- TupleValueItem,- Unit,-} from "@webstudio-is/css-engine";-import { cssTryParseValue, isValidDeclaration } from "../parse-css-value";-import { colord } from "colord";--/*- https://github.com/webstudio-is/webstudio/issues/1016- https://github.com/csstree/csstree/issues/246-- css-tree can't validate filter values.- So, we are relying on the isValidDeclaration function to validate the filter value.- Which uses browser CSSStyleValue.parse to validate.-*/--const FilterProperties = {- filter: { cleanupKeywords: ["filter:"], propertyName: "filter" },- backdropFilter: {- cleanupKeywords: ["backdrop-filter:"],- propertyName: "backdrop-filter",- },-};--export const parseFilter = (- property: keyof typeof FilterProperties,- input: string-): TupleValue | InvalidValue => {- let tokenStream = input.trim();- tokenStream = tokenStream.endsWith(";")- ? tokenStream.slice(0, -1)- : tokenStream;- const { cleanupKeywords, propertyName } = FilterProperties[property];-- for (const cleanupKeyword of cleanupKeywords) {- tokenStream = tokenStream.startsWith(cleanupKeyword)- ? tokenStream.slice(cleanupKeyword.length).trim()- : tokenStream.trim();- }-- const cssAst = cssTryParseValue(tokenStream);- if (cssAst === undefined) {- return {- type: "invalid",- value: input,- };- }-- const isValidFilterDecleration = isValidDeclaration(- propertyName,- tokenStream- );- if (isValidFilterDecleration === false) {- return {- type: "invalid",- value: input,- };- }-- const layers: TupleValueItem[] = [];- csstree.walk(cssAst, (node) => {- if (node.type === "Value") {- for (const child of node.children) {- if (child.type === "Function") {- const tuple: TupleValueItem[] = [];- for (const arg of child.children) {- if (arg.type === "Dimension") {- tuple.push({- type: "unit",- value: Number(arg.value),- unit: arg.unit as Unit,- });- }-- if (arg.type === "Percentage") {- tuple.push({- type: "unit",- value: Number(arg.value),- unit: "%",- });- }-- if (arg.type === "Identifier") {- tuple.push({- type: "keyword",- value: arg.name,- });- }-- if (arg.type === "Number") {- tuple.push({- type: "keyword",- value: arg.value,- });- }-- if (arg.type === "Function" || arg.type === "Hash") {- const colorValue = colord(csstree.generate(arg));- if (colorValue.isValid() === true) {- const rgb = colorValue.toRgb();- tuple.push({- type: "rgb",- alpha: rgb.a,- r: rgb.r,- g: rgb.g,- b: rgb.b,- });- }- }- }-- layers.push({- type: "function",- name: child.name,- args: { type: "tuple", value: tuple },- });- }- }- }- });-- return {- type: "tuple",- value: [...layers],- };-};