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: switch variable values to native validation (#3393)
Bogdan Chadkin99eae65e436c
diff --git a/apps/builder/app/builder/features/settings-panel/resource-panel.tsx b/apps/builder/app/builder/features/settings-panel/resource-panel.tsxindex d4009096aa..2b158ae242 100644--- a/apps/builder/app/builder/features/settings-panel/resource-panel.tsx+++ b/apps/builder/app/builder/features/settings-panel/resource-panel.tsx@@ -50,7 +50,6 @@ import {BindingPopover,evaluateExpressionWithinScope,} from "~/builder/shared/binding-popover";-import { type ComposedFields, composeFields } from "~/shared/form-utils";import { ExpressionEditor } from "~/builder/shared/expression-editor";import {EditorDialog,@@ -59,14 +58,19 @@ import {} from "~/builder/shared/code-editor-base";import { parseCurl, type CurlRequest } from "./curl";+export type ComposedFields = {+ isValid: () => boolean;+ areAllErrorsVisible: () => boolean;+ showAllErrors: () => void;+};+export const composeWithNativeForm = (- formAccessorRef: RefObject<HTMLInputElement>,- form: ComposedFields+ formAccessorRef: RefObject<HTMLInputElement>): ComposedFields => {return {isValid() {const formElement = formAccessorRef.current?.form;- return form.isValid() && formElement?.checkValidity() === true;+ return formElement?.checkValidity() === true;},areAllErrorsVisible() {const formElement = formAccessorRef.current?.form;@@ -88,12 +92,11 @@ export const composeWithNativeForm = (}}}- return form.areAllErrorsVisible();+ return true;},showAllErrors() {const formElement = formAccessorRef.current?.form;formElement?.checkValidity();- form.showAllErrors();},};};@@ -621,9 +624,8 @@ export const ResourceForm = forwardRef<: undefined;const formAccessorRef = useRef<HTMLInputElement>(null);- const form = composeWithNativeForm(formAccessorRef, composeFields());useImperativeHandle(ref, () => ({- ...form,+ ...composeWithNativeForm(formAccessorRef),save: () => {const instanceSelector = $selectedInstanceSelector.get();if (instanceSelector === undefined) {@@ -760,10 +762,9 @@ export const SystemResourceForm = forwardRef<});const formAccessorRef = useRef<HTMLInputElement>(null);- const form = composeWithNativeForm(formAccessorRef, composeFields());useImperativeHandle(ref, () => ({- ...form,+ ...composeWithNativeForm(formAccessorRef),save: () => {const instanceSelector = $selectedInstanceSelector.get();if (instanceSelector === undefined) {@@ -872,7 +873,7 @@ export const GraphqlResourceForm = forwardRef<}, [variables, scope]);const formAccessorRef = useRef<HTMLInputElement>(null);- const form = composeWithNativeForm(formAccessorRef, composeFields());+ const form = composeWithNativeForm(formAccessorRef);useImperativeHandle(ref, () => ({...form,save: () => {diff --git a/apps/builder/app/builder/features/settings-panel/variable-popover.tsx b/apps/builder/app/builder/features/settings-panel/variable-popover.tsxindex a1e7b94833..8f2d62db42 100644--- a/apps/builder/app/builder/features/settings-panel/variable-popover.tsx+++ b/apps/builder/app/builder/features/settings-panel/variable-popover.tsx@@ -36,7 +36,11 @@ import {Tooltip,theme,} from "@webstudio-is/design-system";-import { type DataSource, transpileExpression } from "@webstudio-is/sdk";+import {+ type DataSource,+ transpileExpression,+ lintExpression,+} from "@webstudio-is/sdk";import {ExpressionEditor,formatValue,@@ -50,11 +54,6 @@ import {getComputedResource,} from "~/shared/nano-states";import { serverSyncStore } from "~/shared/sync";-import {- useField,- composeFields,- type ComposedFields,-} from "~/shared/form-utils";import { $userPlanFeatures } from "~/builder/shared/nano-states";import { BindingPopoverProvider } from "~/builder/shared/binding-popover";import { useSideOffset } from "~/builder/shared/floating-panel";@@ -68,6 +67,7 @@ import {ResourceForm,SystemResourceForm,composeWithNativeForm,+ type ComposedFields,} from "./resource-panel";import { generateCurl } from "./curl";@@ -103,43 +103,6 @@ const NameField = ({ defaultValue }: { defaultValue: string }) => {);};-/**- * convert value expression to js value- * validating out accessing any identifier- */-const parseJsonValue = (code: string) => {- const result: { value?: unknown; error?: string } = {};- const ids = new Set<string>();- if (code.trim().length === 0) {- result.error = "Value is required";- return result;- }- try {- code = transpileExpression({- expression: code,- executable: true,- replaceVariable: (id) => {- ids.add(id);- },- });- } catch (error) {- result.error = (error as Error).message;- return result;- }- if (ids.size === 0) {- try {- // wrap with parentheses to treat {} as object instead of block- result.value = eval(`(${code})`);- } catch (error) {- result.error = `Parse Error: ${(error as Error).message}`;- }- } else {- const idsList = Array.from(ids).join(", ");- result.error = `Cannot use variables ${idsList} as variable value`;- }- return result;-};-type VariableType =| "parameter"| "string"@@ -252,9 +215,8 @@ const ParameterForm = forwardRef<{ variable?: DataSource }>(({ variable }, ref) => {const formAccessorRef = useRef<HTMLInputElement>(null);- const form = composeWithNativeForm(formAccessorRef, composeFields());useImperativeHandle(ref, () => ({- ...form,+ ...composeWithNativeForm(formAccessorRef),save: () => {// only existing parameter variables can be renamedif (variable === undefined) {@@ -333,11 +295,10 @@ const StringForm = forwardRef<: "");const formAccessorRef = useRef<HTMLInputElement>(null);- const form = composeWithNativeForm(formAccessorRef, composeFields());useValuePanelRef({ref,variable,- form,+ form: composeWithNativeForm(formAccessorRef),formAccessorRef,variableValue: { type: "string", value },});@@ -349,6 +310,7 @@ const StringForm = forwardRef<<Label htmlFor={valueId}>Value</Label><EditorDialogControl><TextArea+ name="value"rows={1}maxRows={10}autoGrow={true}@@ -376,36 +338,38 @@ const StringForm = forwardRef<});StringForm.displayName = "StringForm";+const validateNumberValue = (value: string | number) => {+ if (typeof value === "string" && value.length === 0) {+ return "Value expects a number";+ }+ const number = Number(value);+ return Number.isNaN(number) ? "Invalid number" : "";+};+const NumberForm = forwardRef<undefined | PanelApi,{variable?: DataSource;}>(({ variable }, ref) => {- const valueField = useField<number | string>({- initialValue:- variable?.type === "variable" && variable.value.type === "number"- ? variable.value.value- : "",- validate: (value) => {- if (typeof value === "string" && value.length === 0) {- return "Value expects a number";- }- const number = Number(value);- return Number.isNaN(number) ? "Invalid number" : undefined;- },- });- const formAccessorRef = useRef<HTMLInputElement>(null);- const form = composeWithNativeForm(- formAccessorRef,- composeFields(valueField)+ const [value, setValue] = useState(+ variable?.type === "variable" && variable.value.type === "number"+ ? variable.value.value+ : "");+ const [valueError, setValueError] = useState("");+ const valueRef = useRef<HTMLInputElement>(null);+ useEffect(() => {+ valueRef.current?.setCustomValidity(validateNumberValue(value));+ setValueError("");+ }, [value]);+ const formAccessorRef = useRef<HTMLInputElement>(null);useValuePanelRef({ref,variable,- form,+ form: composeWithNativeForm(formAccessorRef),formAccessorRef,- variableValue: { type: "number", value: Number(valueField.value) },+ variableValue: { type: "number", value: Number(value) },});const valueId = useId();return (@@ -413,22 +377,19 @@ const NumberForm = forwardRef<<input ref={formAccessorRef} type="hidden" name="form-accessor" /><Flex direction="column" css={{ gap: theme.spacing[3] }}><Label htmlFor={valueId}>Value</Label>- <InputErrorsTooltip- errors={valueField.error ? [valueField.error] : undefined}- >+ <InputErrorsTooltip errors={valueError ? [valueError] : undefined}><InputField+ inputRef={valueRef}+ name="value"id={valueId}- type="number"- color={valueField.error ? "error" : undefined}- value={valueField.value}- onChange={(event) => {- valueField.onChange(- Number.isNaN(event.target.valueAsNumber)- ? event.target.value- : event.target.valueAsNumber- );- }}- onBlur={valueField.onBlur}+ inputMode="numeric"+ color={valueError ? "error" : undefined}+ value={value}+ onChange={(event) => setValue(event.target.value)}+ onBlur={() => valueRef.current?.checkValidity()}+ onInvalid={(event) =>+ setValueError(event.currentTarget.validationMessage)+ }/></InputErrorsTooltip></Flex>@@ -449,11 +410,10 @@ const BooleanForm = forwardRef<: false);const formAccessorRef = useRef<HTMLInputElement>(null);- const form = composeWithNativeForm(formAccessorRef, composeFields());useValuePanelRef({ref,variable,- form,+ form: composeWithNativeForm(formAccessorRef),formAccessorRef,variableValue: { type: "boolean", value },});@@ -463,57 +423,86 @@ const BooleanForm = forwardRef<<input ref={formAccessorRef} type="hidden" name="form-accessor" /><Flex direction="column" css={{ gap: theme.spacing[3] }}><Label htmlFor={valueId}>Value</Label>- <Switch id={valueId} checked={value} onCheckedChange={setValue} />+ <Switch+ name="value"+ id={valueId}+ checked={value}+ onCheckedChange={setValue}+ /></Flex></>);});BooleanForm.displayName = "BooleanForm";+const validateJsonValue = (expression: string) => {+ const diagnostics = lintExpression({ expression });+ return diagnostics.map((diagnostic) => diagnostic.message).join("\n");+};++const parseJsonValue = (expression: string) => {+ try {+ expression = transpileExpression({ expression, executable: true });+ // wrap with parentheses to treat {} as object instead of block+ return eval(`(${expression})`);+ } catch {+ // empty block+ }+};+const JsonForm = forwardRef<undefined | PanelApi,{variable?: DataSource;}>(({ variable }, ref) => {- const valueField = useField<string>({- initialValue:- variable?.type === "variable" &&+ const [value, setValue] = useState<string>(+ variable?.type === "variable" &&(variable.value.type === "json" || variable.value.type === "string[]")- ? formatValue(variable.value.value)- : ``,- validate: (value) => parseJsonValue(value).error,- });- const formAccessorRef = useRef<HTMLInputElement>(null);- const form = composeWithNativeForm(- formAccessorRef,- composeFields(valueField)+ ? formatValue(variable.value.value)+ : ``);+ const [valueError, setValueError] = useState("");+ const valueRef = useRef<HTMLInputElement>(null);+ useEffect(() => {+ valueRef.current?.setCustomValidity(validateJsonValue(value));+ setValueError("");+ }, [value]);+ const formAccessorRef = useRef<HTMLInputElement>(null);useValuePanelRef({ref,variable,- form,+ form: composeWithNativeForm(formAccessorRef),formAccessorRef,variableValue: {type: "json",- value: parseJsonValue(valueField.value).value,+ value: parseJsonValue(value),},});return (<><input ref={formAccessorRef} type="hidden" name="form-accessor" />+ <input+ ref={valueRef}+ style={{ display: "none" }}+ name="value"+ data-color={valueError ? "error" : undefined}+ value={value}+ onChange={() => {}}+ onInvalid={(event) =>+ setValueError(event.currentTarget.validationMessage)+ }+ /><Flex direction="column" css={{ gap: theme.spacing[3] }}><Label>Value</Label>- <InputErrorsTooltip- errors={valueField.error ? [valueField.error] : undefined}- >+ <InputErrorsTooltip errors={valueError ? [valueError] : undefined}>{/* use div to position tooltip */}<div><ExpressionEditor- color={valueField.error ? "error" : undefined}- value={valueField.value}- onChange={valueField.onChange}- onBlur={valueField.onBlur}+ color={valueError ? "error" : undefined}+ value={value}+ onChange={setValue}+ onBlur={() => valueRef.current?.checkValidity()}/></div></InputErrorsTooltip>@@ -704,6 +693,7 @@ export const VariablePopoverTrigger = forwardRef<}}><form+ noValidate={true}// exclude from the flowstyle={{ display: "contents" }}onSubmit={(event) => {diff --git a/apps/builder/app/shared/form-utils/form-utils.ts b/apps/builder/app/shared/form-utils/form-utils.tsdeleted file mode 100644index 005f61b44f..0000000000--- a/apps/builder/app/shared/form-utils/form-utils.ts+++ /dev/null@@ -1,61 +0,0 @@-import { useState } from "react";--export type Field<Type> = {- value: Type;- error: undefined | string;- isErrorVisible: boolean;- valid: boolean;- onChange: (value: Type) => void;- onBlur: () => void;-};--export const useField = <Type>({- initialValue,- validate,-}: {- initialValue: Type;- validate: (value: Type) => undefined | string;-}): Field<Type> => {- const [value, setValue] = useState(initialValue);- const [touched, setTouched] = useState(false);- const error = validate?.(value);- return {- value,- // show error only when user stop interactinig with control- error: touched ? error : undefined,- // inform when user see the error and not need to trigger it- isErrorVisible: error === undefined || touched,- valid: error === undefined,- // hide error when user is typing- onChange: (value) => {- setValue(value);- setTouched(false);- },- // show error when user focus on another control- onBlur: () => {- setTouched(true);- },- };-};--export type ComposedFields = {- isValid: () => boolean;- areAllErrorsVisible: () => boolean;- showAllErrors: () => void;-};--export const composeFields = (- // allow passing fields with more tight types- // by ensuring their onChange will not refine- ...fields: Omit<Field<unknown>, "onChange">[]-): ComposedFields => {- return {- isValid: () => fields.every((field) => field.valid),- areAllErrorsVisible: () => fields.every((field) => field.isErrorVisible),- showAllErrors: () => {- for (const field of fields) {- field.onBlur();- }- },- };-};diff --git a/apps/builder/app/shared/form-utils/index.ts b/apps/builder/app/shared/form-utils/index.tsindex cd24cd8dd8..1851921d4f 100644--- a/apps/builder/app/shared/form-utils/index.ts+++ b/apps/builder/app/shared/form-utils/index.ts@@ -1,2 +1 @@export * from "./use-ids";-export * from "./form-utils";