Skip to content

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.

fix: MCP style mutation validation (#5855)

Oleg Isonenbdb3f3dfd345
diff --git a/apps/builder/app/services/api-router.server.ts b/apps/builder/app/services/api-router.server.ts
index ebe87f5faf..a6a5e92297 100644
--- a/apps/builder/app/services/api-router.server.ts
+++ b/apps/builder/app/services/api-router.server.ts
@@ -10,25 +10,46 @@ import {
import { loadById } from "@webstudio-is/project/index.server";
import { loadDevBuildByProjectId } from "@webstudio-is/project-build/index.server";
import {
- cssVariableValueInput,
- designTokenCreateInput,
- designTokenStyleInput,
- styleDeleteInput,
+ cssVariableDefineInput as cssVariableRuntimeDefineInput,
+ cssVariableDeleteInput as cssVariableRuntimeDeleteInput,
+ cssVariableRewriteRefsInput as cssVariableRuntimeRewriteRefsInput,
+ designTokenAttachInput,
+ designTokenCreateManyInput,
+ designTokenDetachInput,
+ designTokenExtractInput,
+ designTokenStyleDeletionsInput,
+ designTokenStyleUpdatesInput,
+ styleDeleteDeclarationsInput,
+ styleUpdateDeclarationsInput,
styleReplaceInput,
- styleUpdateInput,
} from "@webstudio-is/project-build/runtime/styles";
import {
- dataVariableValueInput,
- resourceFieldsInput,
- resourceFieldsUpdateInput,
+ dataVariableCreateInput,
+ dataVariableDeleteInput,
+ dataVariableUpdateInput,
+ resourceCreateInput,
+ resourceDeleteInput,
+ resourceUpdateInput,
} from "@webstudio-is/project-build/runtime/data";
import {
- pageFieldsInput,
- pageMetaInput,
+ folderCreateInput,
+ folderDeleteInput,
+ folderUpdateInput,
+ pageCreateInput,
+ pageDeleteInput,
+ pageUpdateInput,
} from "@webstudio-is/project-build/runtime/pages";
import {
- propBindingInput,
- propValueInput,
+ appendInstancesInput,
+ cloneInstanceInput,
+ deleteInstancesInput,
+ moveInstancesInput,
+ updateTextInstanceInput,
+} from "@webstudio-is/project-build/runtime/instances";
+import {
+ propBindingsInput,
+ propDeletionsInput,
+ propUpdatesInput,
} from "@webstudio-is/project-build/runtime/props";
import {
createProjectDomain,
@@ -44,12 +65,22 @@ import {
verifyProjectDomain,
} from "@webstudio-is/domain/index.server";
import {
- breakpointFieldsInput,
- breakpointUpdateFieldsInput,
+ breakpointCreateInput,
+ breakpointDeleteInput,
+ breakpointUpdateInput,
projectSettingsUpdateInput as projectSettingsRuntimeUpdateInput,
- redirectFieldsInput,
- redirectUpdateFieldsInput,
+ redirectCreateInput,
+ redirectDeleteInput,
+ redirectUpdateInput,
} from "@webstudio-is/project-build/runtime/project-settings";
+import {
+ pageDuplicateInput,
+ pageTemplateCreatePageInput,
+} from "@webstudio-is/project-build/runtime/page-copy";
+import {
+ assetDeleteInput as assetRuntimeDeleteInput,
+ assetReplaceInput as assetRuntimeReplaceInput,
+} from "@webstudio-is/project-build/runtime/assets";
import { loadAssetsByProject } from "@webstudio-is/asset-uploader/index.server";
import { buildPatchTransaction } from "@webstudio-is/protocol";
import {
@@ -324,21 +355,19 @@ const cssVariableListInput = projectIdInput.extend({
withUsage: z.boolean().optional(),
});
-const cssVariableDefineInput = projectIdInput.extend({
- vars: z.record(cssVariableValueInput),
- overwrite: z.boolean().optional(),
-});
+const cssVariableDefineInput = projectIdInput.merge(
+ cssVariableRuntimeDefineInput
+);
-const cssVariableDeleteInput = projectIdInput.extend({
- names: z.array(z.string()).min(1),
- force: z.boolean().optional(),
- confirm: z.literal(true),
-});
+const cssVariableDeleteInput = projectIdInput
+ .merge(cssVariableRuntimeDeleteInput)
+ .extend({
+ confirm: z.literal(true),
+ });
-const cssVariableRewriteRefsInput = projectIdInput.extend({
- map: z.record(z.string()),
- scopeRegex: z.string().optional(),
-});
+const cssVariableRewriteRefsInput = projectIdInput.merge(
+ cssVariableRuntimeRewriteRefsInput
+);
export const apiRouter = router({
auth: router({
@@ -476,14 +505,7 @@ export const apiRouter = router({
),
create: buildMutation(
- projectIdInput.extend({
- pageId: z.string().optional(),
- name: z.string().min(1),
- path: z.string(),
- title: z.string().optional(),
- parentFolderId: z.string().optional(),
- meta: pageMetaInput.optional(),
- }),
+ projectIdInput.merge(pageCreateInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ pageId: string }>({
id: "pages.create",
@@ -495,10 +517,7 @@ export const apiRouter = router({
),
update: buildMutation(
- projectIdInput.extend({
- pageId: z.string(),
- values: pageFieldsInput,
- }),
+ projectIdInput.merge(pageUpdateInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ pageId: string }>({
id: "pages.update",
@@ -510,7 +529,7 @@ export const apiRouter = router({
),
delete: buildMutation(
- projectIdInput.extend({ pageId: z.string() }),
+ projectIdInput.merge(pageDeleteInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ pageId: string }>({
id: "pages.delete",
@@ -522,12 +541,7 @@ export const apiRouter = router({
),
duplicate: buildMutation(
- projectIdInput.extend({
- pageId: z.string(),
- parentFolderId: z.string().optional(),
- name: z.string().min(1).optional(),
- path: z.string().optional(),
- }),
+ projectIdInput.merge(pageDuplicateInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ pageId: string }>({
id: "pages.duplicate",
@@ -549,12 +563,7 @@ export const apiRouter = router({
}),
createPage: buildMutation(
- projectIdInput.extend({
- templateId: z.string(),
- parentFolderId: z.string().optional(),
- name: z.string().min(1),
- path: z.string(),
- }),
+ projectIdInput.merge(pageTemplateCreatePageInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ pageId: string }>({
id: "pageTemplates.createPage",
@@ -598,7 +607,7 @@ export const apiRouter = router({
}),
create: buildMutation(
- projectIdInput.merge(redirectFieldsInput),
+ projectIdInput.merge(redirectCreateInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ old: string }>({
id: "redirects.create",
@@ -610,10 +619,7 @@ export const apiRouter = router({
),
update: buildMutation(
- projectIdInput.extend({
- old: z.string(),
- values: redirectUpdateFieldsInput,
- }),
+ projectIdInput.merge(redirectUpdateInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ old: string }>({
id: "redirects.update",
@@ -625,7 +631,7 @@ export const apiRouter = router({
),
delete: buildMutation(
- projectIdInput.extend({ old: z.string() }),
+ projectIdInput.merge(redirectDeleteInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ old: string }>({
id: "redirects.delete",
@@ -647,7 +653,7 @@ export const apiRouter = router({
}),
create: buildMutation(
- projectIdInput.merge(breakpointFieldsInput),
+ projectIdInput.merge(breakpointCreateInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ breakpointId: string }>({
id: "breakpoints.create",
@@ -659,10 +665,7 @@ export const apiRouter = router({
),
update: buildMutation(
- projectIdInput.extend({
- breakpointId: z.string(),
- values: breakpointUpdateFieldsInput,
- }),
+ projectIdInput.merge(breakpointUpdateInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ breakpointId: string }>({
id: "breakpoints.update",
@@ -674,7 +677,7 @@ export const apiRouter = router({
),
delete: buildMutation(
- projectIdInput.extend({ breakpointId: z.string() }),
+ projectIdInput.merge(breakpointDeleteInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ breakpointId: string }>({
id: "breakpoints.delete",
@@ -699,12 +702,7 @@ export const apiRouter = router({
),
create: buildMutation(
- projectIdInput.extend({
- folderId: z.string().optional(),
- name: z.string().min(1),
- slug: z.string(),
- parentFolderId: z.string().optional(),
- }),
+ projectIdInput.merge(folderCreateInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ folderId: string }>({
id: "folders.create",
@@ -716,14 +714,7 @@ export const apiRouter = router({
),
update: buildMutation(
- projectIdInput.extend({
- folderId: z.string(),
- values: z.object({
- name: z.string().min(1).optional(),
- slug: z.string().optional(),
- parentFolderId: z.string().optional(),
- }),
- }),
+ projectIdInput.merge(folderUpdateInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ folderId: string }>({
id: "folders.update",
@@ -735,7 +726,7 @@ export const apiRouter = router({
),
delete: buildMutation(
- projectIdInput.extend({ folderId: z.string() }),
+ projectIdInput.merge(folderDeleteInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{
folderId: string;
@@ -790,22 +781,7 @@ export const apiRouter = router({
),
append: buildMutation(
- projectIdInput.extend({
- parentInstanceId: z.string(),
- mode: z.enum(["append", "prepend", "replace"]).optional(),
- insertIndex: z.number().int().nonnegative().optional(),
- children: z
- .array(
- z.object({
- instanceId: z.string().optional(),
- component: z.string().optional(),
- tag: z.string(),
- label: z.string().optional(),
- text: z.string().optional(),
- })
- )
- .min(1),
- }),
+ projectIdInput.merge(appendInstancesInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{
instanceIds: string[];
@@ -820,17 +796,7 @@ export const apiRouter = router({
),
move: buildMutation(
- projectIdInput.extend({
- moves: z
- .array(
- z.object({
- instanceId: z.string(),
- parentInstanceId: z.string(),
- insertIndex: z.number().int().nonnegative().optional(),
- })
- )
- .min(1),
- }),
+ projectIdInput.merge(moveInstancesInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ instanceIds: string[] }>({
id: "instances.move",
@@ -842,11 +808,7 @@ export const apiRouter = router({
),
clone: buildMutation(
- projectIdInput.extend({
- sourceInstanceId: z.string(),
- targetParentInstanceId: z.string().optional(),
- insertIndex: z.number().int().nonnegative().optional(),
- }),
+ projectIdInput.merge(cloneInstanceInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{
instanceId: string;
@@ -861,9 +823,7 @@ export const apiRouter = router({
),
delete: buildMutation(
- projectIdInput.extend({
- instanceIds: z.array(z.string()).min(1),
- }),
+ projectIdInput.merge(deleteInstancesInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ instanceIds: string[] }>({
id: "instances.delete",
@@ -875,9 +835,7 @@ export const apiRouter = router({
),
updateProps: contentOrBuildMutation(
- projectIdInput.extend({
- updates: z.array(propValueInput).min(1),
- }),
+ projectIdInput.merge(propUpdatesInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ propIds: string[] }>({
id: "instances.updateProps",
@@ -889,11 +847,7 @@ export const apiRouter = router({
),
deleteProps: contentOrBuildMutation(
- projectIdInput.extend({
- deletions: z
- .array(z.object({ instanceId: z.string(), name: z.string() }))
- .min(1),
- }),
+ projectIdInput.merge(propDeletionsInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ propIds: string[] }>({
id: "instances.deleteProps",
@@ -905,9 +859,7 @@ export const apiRouter = router({
),
bindProps: buildMutation(
- projectIdInput.extend({
- bindings: z.array(propBindingInput).min(1),
- }),
+ projectIdInput.merge(propBindingsInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ propIds: string[] }>({
id: "instances.bindProps",
@@ -937,12 +889,7 @@ export const apiRouter = router({
),
updateText: contentOrBuildMutation(
- projectIdInput.extend({
- instanceId: z.string(),
- childIndex: z.number().int().nonnegative(),
- text: z.string(),
- mode: z.enum(["text", "expression"]).optional(),
- }),
+ projectIdInput.merge(updateTextInstanceInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{
instanceId: string;
@@ -980,9 +927,7 @@ export const apiRouter = router({
),
updateDeclarations: buildMutation(
- projectIdInput.extend({
- updates: z.array(styleUpdateInput).min(1),
- }),
+ projectIdInput.merge(styleUpdateDeclarationsInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ styleKeys: string[] }>({
id: "styles.updateDeclarations",
@@ -994,9 +939,7 @@ export const apiRouter = router({
),
deleteDeclarations: buildMutation(
- projectIdInput.extend({
- deletions: z.array(styleDeleteInput).min(1),
- }),
+ projectIdInput.merge(styleDeleteDeclarationsInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ styleKeys: string[] }>({
id: "styles.deleteDeclarations",
@@ -1037,9 +980,7 @@ export const apiRouter = router({
),
create: buildMutation(
- projectIdInput.extend({
- tokens: z.array(designTokenCreateInput).min(1),
- }),
+ projectIdInput.merge(designTokenCreateManyInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ tokenIds: string[] }>({
id: "designTokens.create",
@@ -1051,10 +992,7 @@ export const apiRouter = router({
),
updateStyles: buildMutation(
- projectIdInput.extend({
- designTokenId: z.string(),
- updates: z.array(designTokenStyleInput).min(1),
- }),
+ projectIdInput.merge(designTokenStyleUpdatesInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{
designTokenId: string;
@@ -1069,10 +1007,7 @@ export const apiRouter = router({
),
deleteStyles: buildMutation(
- projectIdInput.extend({
- designTokenId: z.string(),
- deletions: z.array(styleDeleteInput.omit({ instanceId: true })).min(1),
- }),
+ projectIdInput.merge(designTokenStyleDeletionsInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{
designTokenId: string;
@@ -1087,11 +1022,7 @@ export const apiRouter = router({
),
attach: buildMutation(
- projectIdInput.extend({
- designTokenId: z.string(),
- instanceIds: z.array(z.string()).min(1),
- position: z.enum(["before-local", "after-local"]).optional(),
- }),
+ projectIdInput.merge(designTokenAttachInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{
designTokenId: string;
@@ -1105,10 +1036,7 @@ export const apiRouter = router({
),
detach: buildMutation(
- projectIdInput.extend({
- designTokenId: z.string(),
- instanceIds: z.array(z.string()).min(1),
- }),
+ projectIdInput.merge(designTokenDetachInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{
designTokenId: string;
@@ -1122,11 +1050,7 @@ export const apiRouter = router({
),
extract: buildMutation(
- projectIdInput.extend({
- instanceIds: z.array(z.string()).min(1),
- name: z.string().min(1),
- removeLocalProps: z.array(z.string()).optional(),
- }),
+ projectIdInput.merge(designTokenExtractInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{
designTokenId: string;
@@ -1206,12 +1130,7 @@ export const apiRouter = router({
),
create: buildMutation(
- projectIdInput.extend({
- dataSourceId: z.string().optional(),
- scopeInstanceId: z.string(),
- name: z.string(),
- value: dataVariableValueInput,
- }),
+ projectIdInput.merge(dataVariableCreateInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ dataSourceId: string }>({
id: "variables.create",
@@ -1223,14 +1142,7 @@ export const apiRouter = router({
),
update: buildMutation(
- projectIdInput.extend({
- dataSourceId: z.string(),
- values: z.object({
- scopeInstanceId: z.string().optional(),
- name: z.string().optional(),
- value: dataVariableValueInput.optional(),
- }),
- }),
+ projectIdInput.merge(dataVariableUpdateInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ dataSourceId: string }>({
id: "variables.update",
@@ -1242,9 +1154,7 @@ export const apiRouter = router({
),
delete: buildMutation(
- projectIdInput.extend({
- dataSourceId: z.string(),
- }),
+ projectIdInput.merge(dataVariableDeleteInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ dataSourceId: string }>({
id: "variables.delete",
@@ -1269,13 +1179,7 @@ export const apiRouter = router({
),
create: buildMutation(
- projectIdInput.extend({
- resourceId: z.string().optional(),
- resource: resourceFieldsInput,
- dataSourceId: z.string().optional(),
- scopeInstanceId: z.string().optional(),
- dataSourceName: z.string().optional(),
- }),
+ projectIdInput.merge(resourceCreateInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{
resourceId: string;
@@ -1290,12 +1194,7 @@ export const apiRouter = router({
),
update: buildMutation(
- projectIdInput.extend({
- resourceId: z.string(),
- values: resourceFieldsUpdateInput,
- dataSourceName: z.string().optional(),
- scopeInstanceId: z.string().optional(),
- }),
+ projectIdInput.merge(resourceUpdateInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{ resourceId: string }>({
id: "resources.update",
@@ -1307,10 +1206,7 @@ export const apiRouter = router({
),
delete: buildMutation(
- projectIdInput.extend({
- resourceId: z.string(),
- force: z.boolean().optional(),
- }),
+ projectIdInput.merge(resourceDeleteInput),
async ({ input, build, commit }) => {
return await commitRuntimeMutation<{
resourceId: string;
@@ -1478,9 +1374,7 @@ export const apiRouter = router({
),
replace: buildMutation(
- projectIdInput.extend({
- fromAssetId: z.string(),
- toAssetId: z.string(),
+ projectIdInput.merge(assetRuntimeReplaceInput).extend({
confirm: z.literal(true),
}),
async ({ ctx, input, build, commit }) => {
@@ -1498,9 +1392,7 @@ export const apiRouter = router({
),
delete: buildMutation(
- projectIdInput.extend({
- assetIdsOrPrefixes: z.array(z.string()).min(1),
- force: z.boolean().optional(),
+ projectIdInput.merge(assetRuntimeDeleteInput).extend({
confirm: z.literal(true),
}),
async ({ ctx, input, build, commit }) => {
diff --git a/packages/cli/src/screenshot.test.ts b/packages/cli/src/screenshot.test.ts
index a1b7352c74..0bf9ec6921 100644
--- a/packages/cli/src/screenshot.test.ts
+++ b/packages/cli/src/screenshot.test.ts
@@ -1,5 +1,6 @@
import { describe, expect, test, vi } from "vitest";
import { constants } from "node:fs";
+import { tmpdir } from "node:os";
import {
BrowserNotFoundError,
BrowserInstallUnavailableError,
@@ -224,6 +225,7 @@ test("formats actionable browser installation guidance", () => {
describe("captureScreenshot", () => {
test("captures with browser readiness defaults", async () => {
const captureBrowserScreenshot = vi.fn(async () => undefined);
+ const output = `${tmpdir()}/webstudio-screenshot-123.png`;
const dependencies = createDependencies({
which: vi.fn(async (command) =>
command === "chromium" ? "/usr/bin/chromium" : undefined
@@ -250,7 +252,7 @@ describe("captureScreenshot", () => {
});
expect(captureBrowserScreenshot).toHaveBeenCalledWith({
browserPath: "/usr/bin/chromium",
- output: "/tmp/webstudio-screenshot-123.png",
+ output,
width: 1440,
height: 900,
url: "https://example.com",
@@ -260,7 +262,7 @@ describe("captureScreenshot", () => {
waitForTimeout: 250,
timeout: 30000,
});
- expect(dependencies.mkdir).toHaveBeenCalledWith("/tmp", {
+ expect(dependencies.mkdir).toHaveBeenCalledWith(tmpdir(), {
recursive: true,
});
});
diff --git a/packages/project-build/src/mcp.test.ts b/packages/project-build/src/mcp.test.ts
index 87d7593724..42029a9bcc 100644
--- a/packages/project-build/src/mcp.test.ts
+++ b/packages/project-build/src/mcp.test.ts
@@ -26,36 +26,61 @@ type ExecuteOperation = NonNullable<
type TestSession = ReturnType<CreateProjectSession>;
+type TestPublicMcpOperation = Pick<
+ PublicMcpOperation,
+ "command" | "id" | "description" | "inputFields"
+> &
+ Partial<PublicMcpOperation>;
+
+const publicOperation = (
+ operation: TestPublicMcpOperation
+): PublicMcpOperation => ({
+ method: "query",
+ permit: "view",
+ localCapable: true,
+ serverOnly: false,
+ readNamespaces: [],
+ writeNamespaces: [],
+ invalidatesNamespaces: [],
+ retryOnConflict: false,
+ ...operation,
+});
+
+const styleOperation = (
+ operation: TestPublicMcpOperation & {
+ readNamespaces: PublicMcpOperation["readNamespaces"];
+ }
+): PublicMcpOperation => {
+ const arrayField = operation.inputFields.at(-1);
+ return publicOperation({
+ method: "mutation",
+ permit: "edit",
+ inputFieldTypes:
+ arrayField === undefined ? undefined : { [arrayField]: "array" },
+ writeNamespaces: ["styles"],
+ invalidatesNamespaces: ["styles"],
+ retryOnConflict: true,
+ ...operation,
+ });
+};
+
const publicMcpOperations: readonly PublicMcpOperation[] = [
- {
+ publicOperation({
command: "list-pages",
id: "pages.list",
- method: "query",
- permit: "view",
description: "List pages",
inputFields: ["includeFolders"],
- localCapable: true,
- serverOnly: false,
readNamespaces: ["pages"],
- writeNamespaces: [],
- invalidatesNamespaces: [],
- retryOnConflict: false,
- },
- {
+ }),
+ publicOperation({
command: "whoami",
id: "auth.me",
- method: "query",
- permit: "view",
description: "Identify token",
inputFields: [],
localCapable: false,
serverOnly: true,
- readNamespaces: [],
- writeNamespaces: [],
- invalidatesNamespaces: [],
- retryOnConflict: false,
- },
- {
+ }),
+ publicOperation({
command: "publish",
id: "build.publish",
method: "mutation",
@@ -64,11 +89,46 @@ const publicMcpOperations: readonly PublicMcpOperation[] = [
inputFields: ["target", "domains"],
localCapable: false,
serverOnly: true,
- readNamespaces: [],
- writeNamespaces: [],
- invalidatesNamespaces: [],
- retryOnConflict: false,
- },
+ }),
+ publicOperation({
+ command: "delete-instance",
+ id: "instances.delete",
+ method: "mutation",
+ permit: "edit",
+ description: "Delete instances",
+ inputFields: ["instanceIds"],
+ inputFieldTypes: { instanceIds: "array" },
+ writeNamespaces: ["instances"],
+ invalidatesNamespaces: ["instances"],
+ }),
+ styleOperation({
+ command: "update-styles",
+ id: "styles.updateDeclarations",
+ description: "Update styles",
+ inputFields: ["updates"],
+ readNamespaces: ["styles"],
+ }),
+ styleOperation({
+ command: "delete-styles",
+ id: "styles.deleteDeclarations",
+ description: "Delete styles",
+ inputFields: ["deletions"],
+ readNamespaces: ["styles"],
+ }),
+ styleOperation({
+ command: "update-design-token-styles",
+ id: "designTokens.updateStyles",
+ description: "Update design token styles",
+ inputFields: ["designTokenId", "updates"],
+ readNamespaces: ["styleSources", "styles"],
+ }),
+ styleOperation({
+ command: "delete-design-token-styles",
+ id: "designTokens.deleteStyles",
+ description: "Delete design token styles",
+ inputFields: ["designTokenId", "deletions"],
+ readNamespaces: ["styleSources", "styles"],
+ }),
];
const testMcpGuidance: ProjectSessionMcpGuidance = {
@@ -234,6 +294,20 @@ describe("project session mcp adapter", () => {
}),
])
);
+
+ for (const [name, field] of [
+ ["delete-instance", "instanceIds"],
+ ["update-styles", "updates"],
+ ["delete-styles", "deletions"],
+ ["update-design-token-styles", "updates"],
+ ["delete-design-token-styles", "deletions"],
+ ]) {
+ expect(
+ tools.find((tool) => tool.name === name)?.inputSchema.properties?.[
+ field
+ ]
+ ).toMatchObject({ type: "array" });
+ }
});
test("lists OCR installer only when host provides installer", () => {
@@ -335,6 +409,64 @@ describe("project session mcp adapter", () => {
});
});
+ test("wraps bare array input for style operation tools", async () => {
+ const updates = [
+ {
+ instanceId: "instance-id",
+ property: "box-shadow",
+ value: { type: "keyword", value: "none" },
+ },
+ ];
+ const executeOperation: ExecuteOperation = vi.fn(async () =>
+ createEnvelope({
+ operationId: "styles.updateDeclarations",
+ result: { styleKeys: [] },
+ })
+ );
+ const adapter = createProjectSessionMcpCore({
+ operations: publicMcpOperations,
+ createProjectSession: createSessionFactory(),
+ executeOperation,
+ });
+
+ await adapter.callTool({
+ name: "update-styles",
+ input: updates,
+ });
+
+ expect(executeOperation).toHaveBeenCalledWith({
+ command: "update-styles",
+ input: { updates },
+ dryRun: false,
+ });
+ });
+
+ test("wraps bare array input for single-array operation tools", async () => {
+ const instanceIds = ["instance-id"];
+ const executeOperation: ExecuteOperation = vi.fn(async () =>
+ createEnvelope({
+ operationId: "instances.delete",
+ result: { instanceIds },
+ })
+ );
+ const adapter = createProjectSessionMcpCore({
+ operations: publicMcpOperations,
+ createProjectSession: createSessionFactory(),
+ executeOperation,
+ });
+
+ await adapter.callTool({
+ name: "delete-instance",
+ input: instanceIds,
+ });
+
+ expect(executeOperation).toHaveBeenCalledWith({
+ command: "delete-instance",
+ input: { instanceIds },
+ dryRun: false,
+ });
+ });
+
test("calls import through injected project importer", async () => {
const importProject = vi.fn(async () => ({ imported: true as const }));
const adapter = createProjectSessionMcpCore({
diff --git a/packages/project-build/src/mcp.ts b/packages/project-build/src/mcp.ts
index 1744437bf3..718235bf8e 100644
--- a/packages/project-build/src/mcp.ts
+++ b/packages/project-build/src/mcp.ts
@@ -36,6 +36,7 @@ export type PublicMcpOperation<Command extends string = string> = {
permit: PublicMcpOperationPermit;
description: string;
inputFields: readonly string[];
+ inputFieldTypes?: Partial<Record<string, "array">>;
requiredOptions?: readonly string[];
examples?: readonly string[];
localCapable: boolean;
@@ -209,7 +210,7 @@ const textInputSchema = (description: string) =>
}) as const satisfies ProjectSessionMcpInputSchema;
const getOperationInputSchema = (
- operation: Pick<PublicMcpOperation, "inputFields">
+ operation: Pick<PublicMcpOperation, "inputFields" | "inputFieldTypes">
): ProjectSessionMcpInputSchema => {
if (operation.inputFields.length === 0) {
return emptyInputSchema;
@@ -219,14 +220,41 @@ const getOperationInputSchema = (
properties: Object.fromEntries(
operation.inputFields.map((field) => [
field,
- {
- description: `Public API input field \`${field}\`.`,
- },
+ getOperationInputFieldSchema(operation, field),
])
),
};
};
+const getOperationInputFieldSchema = (
+ operation: Pick<PublicMcpOperation, "inputFieldTypes">,
+ field: string
+) => {
+ const description = `Public API input field \`${field}\`.`;
+ if (operation.inputFieldTypes?.[field] === "array") {
+ return {
+ type: "array",
+ description,
+ items: {},
+ };
+ }
+ return { description };
+};
+
+const wrapMcpRootArrayInput = (
+ operation: Pick<PublicMcpOperation, "inputFields" | "inputFieldTypes">,
+ input: unknown
+) => {
+ if (Array.isArray(input) === false || operation.inputFields.length !== 1) {
+ return input;
+ }
+ const [field] = operation.inputFields;
+ if (field !== undefined && operation.inputFieldTypes?.[field] === "array") {
+ return { [field]: input };
+ }
+ return input;
+};
+
const screenshotInputSchema = {
...emptyInputSchema,
description:
@@ -491,6 +519,11 @@ export const mcpArgumentExamples: Record<string, readonly unknown[]> = {
],
},
],
+ "delete-styles": [
+ {
+ deletions: [{ instanceId: "instance-id", property: "box-shadow" }],
+ },
+ ],
"apply-patch": [
{
baseVersion: 12,
@@ -1537,8 +1570,8 @@ export const createProjectSessionMcpCore = <Command extends string = string>({
guidance?: ProjectSessionMcpGuidance;
}) => {
let session: ReturnType<CreateProjectSession> | undefined;
- const operationCommands = new Set(
- operations.map((operation) => operation.command)
+ const operationByCommand = new Map(
+ operations.map((operation) => [operation.command, operation])
);
const listTools = () =>
listProjectSessionMcpTools(operations, {
@@ -1649,12 +1682,14 @@ export const createProjectSessionMcpCore = <Command extends string = string>({
if (name === "preview.status" && getPreviewStatus !== undefined) {
return toMetaResult(await getPreviewStatus());
}
- if (operationCommands.has(name as Command) === false) {
+ const operation = operationByCommand.get(name as Command);
+ if (operation === undefined) {
throw new Error(`Unknown MCP tool "${name}".`);
}
+ const operationInput = wrapMcpRootArrayInput(operation, input);
const envelope = await executeOperation({
command: name as Command,
- input,
+ input: operationInput,
dryRun,
});
return toCallResult(envelope);
diff --git a/packages/project-build/src/runtime/assets.ts b/packages/project-build/src/runtime/assets.ts
index 9db5e6dc87..3c2a7e313f 100644
--- a/packages/project-build/src/runtime/assets.ts
+++ b/packages/project-build/src/runtime/assets.ts
@@ -1,5 +1,6 @@
import type { StyleValue } from "@webstudio-is/css-engine";
import deepEqual from "fast-deep-equal";
+import { z } from "zod";
import {
getAllPages,
getStyleDeclKey,
@@ -32,6 +33,16 @@ type AssetStyleValueReplacement = {
toFontFamily?: string;
};
+export const assetReplaceInput = z.object({
+ fromAssetId: z.string(),
+ toAssetId: z.string(),
+});
+
+export const assetDeleteInput = z.object({
+ assetIdsOrPrefixes: z.array(z.string()).min(1),
+ force: z.boolean().optional(),
+});
+
const traverseAssetStyleValue = (
value: StyleValue,
callback: (value: StyleValue) => void
@@ -618,7 +629,7 @@ export const replaceAsset = (
BuilderState,
"assets" | "pages" | "props" | "styles" | "resources" | "dataSources"
>,
- input: { fromAssetId: string; toAssetId: string }
+ input: z.infer<typeof assetReplaceInput>
) => {
const assets = Array.from(getRequiredAssets(state).values());
const fromAsset = findAsset(assets, input.fromAssetId);
@@ -657,10 +668,7 @@ export const deleteAssets = (
BuilderState,
"assets" | "pages" | "props" | "styles" | "resources" | "dataSources"
>,
- input: {
- assetIdsOrPrefixes: string[];
- force?: boolean;
- }
+ input: z.infer<typeof assetDeleteInput>
) => {
const assets = Array.from(getRequiredAssets(state).values());
const selectedAssets = assets.filter((asset) =>
diff --git a/packages/project-build/src/runtime/data.ts b/packages/project-build/src/runtime/data.ts
index a92d961470..155872a11b 100644
--- a/packages/project-build/src/runtime/data.ts
+++ b/packages/project-build/src/runtime/data.ts
@@ -167,6 +167,26 @@ export const listDataVariables = (
export const dataVariableValueInput = dataSourceVariableValue;
+export const dataVariableCreateInput = z.object({
+ dataSourceId: z.string().optional(),
+ scopeInstanceId: z.string(),
+ name: z.string().min(1),
+ value: dataVariableValueInput,
+});
+
+export const dataVariableUpdateInput = z.object({
+ dataSourceId: z.string(),
+ values: z.object({
+ scopeInstanceId: z.string().optional(),
+ name: z.string().min(1).optional(),
+ value: dataVariableValueInput.optional(),
+ }),
+});
+
+export const dataVariableDeleteInput = z.object({
+ dataSourceId: z.string(),
+});
+
type DataVariable = Extract<DataSource, { type: "variable" }>;
export type DataVariableNameError = {
@@ -1042,12 +1062,7 @@ export const createDataVariableUpdatePayload = ({
export const createDataVariable = (
state: Pick<BuilderState, "dataSources">,
- input: {
- dataSourceId?: string;
- scopeInstanceId: string;
- name: string;
- value: z.infer<typeof dataVariableValueInput>;
- },
+ input: z.infer<typeof dataVariableCreateInput>,
context: BuilderRuntimeContext
) => {
const dataSources = getRequiredDataSources(state);
@@ -1078,14 +1093,7 @@ export const createDataVariable = (
export const updateDataVariable = (
state: Pick<BuilderState, "dataSources">,
- input: {
- dataSourceId: string;
- values: Partial<{
- scopeInstanceId: string;
- name: string;
- value: z.infer<typeof dataVariableValueInput>;
- }>;
- }
+ input: z.infer<typeof dataVariableUpdateInput>
) => {
const dataSources = getRequiredDataSources(state);
const variable = findDataVariable(dataSources.values(), input.dataSourceId);
@@ -1112,7 +1120,7 @@ export const deleteDataVariable = (
BuilderState,
"pages" | "instances" | "props" | "dataSources" | "resources"
>,
- input: { dataSourceId: string }
+ input: z.infer<typeof dataVariableDeleteInput>
) => {
const { payload, deletedVariable } = createDataVariableDeletePayload({
variableId: input.dataSourceId,
@@ -1177,6 +1185,26 @@ export const resourceFieldsUpdateInput = resourceFieldsInputBase
addExpressionIssues(context, getResourceExpressionErrors(fields));
});
+export const resourceCreateInput = z.object({
+ resourceId: z.string().optional(),
+ resource: resourceFieldsInput,
+ dataSourceId: z.string().optional(),
+ scopeInstanceId: z.string().optional(),
+ dataSourceName: z.string().optional(),
+});
+
+export const resourceUpdateInput = z.object({
+ resourceId: z.string(),
+ values: resourceFieldsUpdateInput,
+ dataSourceName: z.string().optional(),
+ scopeInstanceId: z.string().optional(),
+});
+
+export const resourceDeleteInput = z.object({
+ resourceId: z.string(),
+ force: z.boolean().optional(),
+});
+
export const createResourceValue = ({
id,
control,
@@ -1763,13 +1791,7 @@ export const createResource = (
| "styleSourceSelections"
| "styles"
>,
- input: {
- resourceId?: string;
- resource: z.infer<typeof resourceFieldsInput>;
- dataSourceId?: string;
- scopeInstanceId?: string;
- dataSourceName?: string;
- },
+ input: z.infer<typeof resourceCreateInput>,
context: BuilderRuntimeContext
) => {
const expressionErrors = getResourceExpressionErrors(input.resource);
@@ -1847,12 +1869,7 @@ export const updateResource = (
| "styleSourceSelections"
| "styles"
>,
- input: {
- resourceId: string;
- values: z.infer<typeof resourceFieldsUpdateInput>;
- dataSourceName?: string;
- scopeInstanceId?: string;
- }
+ input: z.infer<typeof resourceUpdateInput>
) => {
const expressionErrors = getResourceExpressionErrors(input.values);
if (expressionErrors.length > 0) {
@@ -1910,7 +1927,7 @@ export const updateResource = (
export const deleteResource = (
state: Pick<BuilderState, "dataSources" | "resources" | "props">,
- input: { resourceId: string; force?: boolean }
+ input: z.infer<typeof resourceDeleteInput>
) => {
const resource = findResource(
getRequiredResources(state).values(),
diff --git a/packages/project-build/src/runtime/instances.ts b/packages/project-build/src/runtime/instances.ts
index 62de17af25..0bc6ddd121 100644
--- a/packages/project-build/src/runtime/instances.ts
+++ b/packages/project-build/src/runtime/instances.ts
@@ -24,6 +24,55 @@ import {
createStyleClonePayload,
serializeStyleDeclarations,
} from "./style-utils";
+import { z } from "zod";
+
+const insertIndexInput = z.number().int().nonnegative();
+
+export const appendInstancesInput = z.object({
+ parentInstanceId: z.string(),
+ mode: z.enum(["append", "prepend", "replace"]).optional(),
+ insertIndex: insertIndexInput.optional(),
+ children: z
+ .array(
+ z.object({
+ instanceId: z.string().optional(),
+ component: z.string().optional(),
+ tag: z.string(),
+ label: z.string().optional(),
+ text: z.string().optional(),
+ })
+ )
+ .min(1),
+});
+
+export const moveInstancesInput = z.object({
+ moves: z
+ .array(
+ z.object({
+ instanceId: z.string(),
+ parentInstanceId: z.string(),
+ insertIndex: insertIndexInput.optional(),
+ })
+ )
+ .min(1),
+});
+
+export const cloneInstanceInput = z.object({
+ sourceInstanceId: z.string(),
+ targetParentInstanceId: z.string().optional(),
+ insertIndex: insertIndexInput.optional(),
+});
+
+export const deleteInstancesInput = z.object({
+ instanceIds: z.array(z.string()).min(1),
+});
+
+export const updateTextInstanceInput = z.object({
+ instanceId: z.string(),
+ childIndex: z.number().int().nonnegative(),
+ text: z.string(),
+ mode: z.enum(["text", "expression"]).optional(),
+});
export type TextContentChild = Extract<
Instance["children"][number],
@@ -768,18 +817,7 @@ const treeInvalidates = [
export const appendInstances = (
state: TreeMutationState,
- input: {
- parentInstanceId: string;
- mode?: "append" | "prepend" | "replace";
- insertIndex?: number;
- children: Array<{
- instanceId?: string;
- component?: string;
- tag: string;
- label?: string;
- text?: string;
- }>;
- },
+ input: z.infer<typeof appendInstancesInput>,
context: BuilderRuntimeContext
) => {
const mutationState = getRequiredTreeMutationState(state);
@@ -841,13 +879,7 @@ export const appendInstances = (
export const moveInstances = (
state: Pick<BuilderState, "instances">,
- input: {
- moves: Array<{
- instanceId: string;
- parentInstanceId: string;
- insertIndex?: number;
- }>;
- }
+ input: z.infer<typeof moveInstancesInput>
) => {
const { errors, payload } = createInstanceMovePayload({
instances: getRequiredInstances(state),
@@ -884,7 +916,7 @@ export const moveInstances = (
export const deleteInstances = (
state: TreeMutationState,
- input: { instanceIds: string[] }
+ input: z.infer<typeof deleteInstancesInput>
) => {
const mutationState = getRequiredTreeMutationState(state);
const pageRootIds = new Set(
@@ -924,11 +956,7 @@ export const deleteInstances = (
export const cloneInstance = (
state: TreeMutationState,
- input: {
- sourceInstanceId: string;
- targetParentInstanceId?: string;
- insertIndex?: number;
- },
+ input: z.infer<typeof cloneInstanceInput>,
context: BuilderRuntimeContext
) => {
const mutationState = getRequiredTreeMutationState(state);
@@ -1322,12 +1350,7 @@ export const inspectInstance = (
export const updateTextInstance = (
state: Pick<BuilderState, "instances">,
- input: {
- instanceId: string;
- childIndex: number;
- text: string;
- mode?: "text" | "expression";
- }
+ input: z.infer<typeof updateTextInstanceInput>
) => {
const result = findTextContentChild(
getRequiredInstances(state).values(),
diff --git a/packages/project-build/src/runtime/page-copy.ts b/packages/project-build/src/runtime/page-copy.ts
index 6241a7cc80..8bf8347ccf 100644
--- a/packages/project-build/src/runtime/page-copy.ts
+++ b/packages/project-build/src/runtime/page-copy.ts
@@ -4,6 +4,7 @@ import {
insertWebstudioFragmentCopy,
} from "./fragment";
import { nanoid } from "nanoid";
+import { z } from "zod";
import {
createWebstudioDataFromBuild,
createWebstudioDataPatchPayload,
@@ -37,6 +38,22 @@ import { unwrap } from "./unwrap";
type CreateId = () => string;
+export const pageDuplicateInput = z.object({
+ projectId: z.string(),
+ pageId: z.string(),
+ parentFolderId: z.string().optional(),
+ name: z.string().min(1).optional(),
+ path: z.string().optional(),
+});
+
+export const pageTemplateCreatePageInput = z.object({
+ projectId: z.string(),
+ templateId: z.string(),
+ parentFolderId: z.string().optional(),
+ name: z.string().min(1),
+ path: z.string(),
+});
+
const contentModePageMetaFields = new Set([
"description",
"title",
@@ -553,13 +570,7 @@ export const createPageDuplicatePayload = ({
export const duplicatePage = (
state: BuilderState,
- input: {
- projectId: string;
- pageId: Page["id"];
- parentFolderId?: Folder["id"];
- name?: Page["name"];
- path?: Page["path"];
- },
+ input: z.infer<typeof pageDuplicateInput>,
context: { createId: CreateId }
) => {
const data = getRequiredWebstudioData(state);
@@ -640,13 +651,7 @@ export const listPageTemplates = (state: Pick<BuilderState, "pages">) => {
export const createPageFromTemplate = (
state: BuilderState,
- input: {
- projectId: string;
- templateId: PageTemplate["id"];
- parentFolderId?: Folder["id"];
- name: Page["name"];
- path: Page["path"];
- },
+ input: z.infer<typeof pageTemplateCreatePageInput>,
context: { createId: CreateId }
) => {
const data = getRequiredWebstudioData(state);
diff --git a/packages/project-build/src/runtime/pages.ts b/packages/project-build/src/runtime/pages.ts
index 7f8c9e459f..63418c69d5 100644
--- a/packages/project-build/src/runtime/pages.ts
+++ b/packages/project-build/src/runtime/pages.ts
@@ -469,12 +469,7 @@ const getParentFolderIdOrThrow = (pages: Pages, childId: string) => {
export const createFolder = (
state: Pick<BuilderState, "pages">,
- input: {
- folderId?: string;
- name: string;
- slug: string;
- parentFolderId?: string;
- },
+ input: z.infer<typeof folderCreateInput>,
context: BuilderRuntimeContext
) => {
const pages = getRequiredPages(state);
@@ -657,6 +652,44 @@ export const pageFieldsInput = z
addExpressionIssues(context, getPageExpressionErrors(fields));
});
+export const pageCreateInput = z.object({
+ pageId: z.string().optional(),
+ name: z.string().min(1),
+ path: z.string(),
+ title: z.string().optional(),
+ parentFolderId: z.string().optional(),
+ meta: pageMetaInput.optional(),
+});
+
+export const pageUpdateInput = z.object({
+ pageId: z.string(),
+ values: pageFieldsInput,
+});
+
+export const pageDeleteInput = z.object({
+ pageId: z.string(),
+});
+
+export const folderCreateInput = z.object({
+ folderId: z.string().optional(),
+ name: z.string().min(1),
+ slug: z.string(),
+ parentFolderId: z.string().optional(),
+});
+
+export const folderUpdateInput = z.object({
+ folderId: z.string(),
+ values: z.object({
+ name: z.string().min(1).optional(),
+ slug: z.string().optional(),
+ parentFolderId: z.string().optional(),
+ }),
+});
+
+export const folderDeleteInput = z.object({
+ folderId: z.string(),
+});
+
export const pageMetaToPatchValue = (meta: PageMetaPatchInput) => {
const result: Record<string, unknown> = {};
for (const [name, value] of Object.entries(meta)) {
@@ -778,14 +811,7 @@ export const createPageUpdatePayload = (
export const createPage = (
state: Pick<BuilderState, "pages">,
- input: {
- pageId?: string;
- name: string;
- path: string;
- title?: string;
- parentFolderId?: string;
- meta?: z.infer<typeof pageMetaInput>;
- },
+ input: z.infer<typeof pageCreateInput>,
context: BuilderRuntimeContext
) => {
const pages = getRequiredPages(state);
@@ -839,7 +865,7 @@ export const createPage = (
export const updatePage = (
state: Pick<BuilderState, "pages">,
- input: { pageId: string; values: z.infer<typeof pageFieldsInput> }
+ input: z.infer<typeof pageUpdateInput>
) => {
const pages = getRequiredPages(state);
const page = findPage(pages, input.pageId);
@@ -968,7 +994,7 @@ export const createPageDeletePayload = ({
export const deletePage = (
state: DeletePayloadState,
- input: { pageId: string }
+ input: z.infer<typeof pageDeleteInput>
) => {
const deleteState = getRequiredDeleteState(state);
const page = findPage(deleteState.pages, input.pageId);
@@ -1055,7 +1081,7 @@ export const createFolderDeletePayload = ({
export const deleteFolder = (
state: DeletePayloadState,
- input: { folderId: string }
+ input: z.infer<typeof folderDeleteInput>
) => {
const deleteState = getRequiredDeleteState(state);
const folder = getFolderOrThrow(deleteState.pages, input.folderId);
@@ -1095,14 +1121,7 @@ export const deleteFolder = (
export const updateFolder = (
state: Pick<BuilderState, "pages">,
- input: {
- folderId: string;
- values: {
- name?: string;
- slug?: string;
- parentFolderId?: string;
- };
- }
+ input: z.infer<typeof folderUpdateInput>
) => {
const pages = getRequiredPages(state);
const folder = getFolderOrThrow(pages, input.folderId);
diff --git a/packages/project-build/src/runtime/project-settings.ts b/packages/project-build/src/runtime/project-settings.ts
index 1aa70c0976..54ac35f22e 100644
--- a/packages/project-build/src/runtime/project-settings.ts
+++ b/packages/project-build/src/runtime/project-settings.ts
@@ -35,14 +35,6 @@ type Settable<T> = {
[Property in keyof T]?: T[Property] | null;
};
-type ProjectMetaValues = Settable<
- NonNullable<ReturnType<typeof getRequiredPages>["meta"]>
->;
-
-type CompilerValues = Settable<
- NonNullable<ReturnType<typeof getRequiredPages>["compiler"]>
->;
-
export const projectSettingsUpdateInput = z.object({
meta: z.record(z.unknown()).optional(),
compiler: z.record(z.unknown()).optional(),
@@ -133,10 +125,7 @@ const pushObjectFieldPatches = ({
export const updateProjectSettings = (
state: Pick<BuilderState, "pages">,
- input: {
- meta?: ProjectMetaValues;
- compiler?: CompilerValues;
- }
+ input: z.infer<typeof projectSettingsUpdateInput>
) => {
const pages = getRequiredPages(state);
const patches: BuilderPatchChange["patches"] = [];
@@ -183,6 +172,17 @@ export const redirectUpdateFieldsInput = z.object({
status: redirectStatusInput.nullable().optional(),
});
+export const redirectCreateInput = redirectFieldsInput;
+
+export const redirectUpdateInput = z.object({
+ old: z.string(),
+ values: redirectUpdateFieldsInput,
+});
+
+export const redirectDeleteInput = z.object({
+ old: z.string(),
+});
+
const findRedirectIndex = (
redirects: NonNullable<ReturnType<typeof getRequiredPages>["redirects"]>,
oldPath: string
@@ -198,7 +198,7 @@ const parseRedirect = (input: PageRedirect) => {
export const createRedirect = (
state: Pick<BuilderState, "pages">,
- input: PageRedirect
+ input: z.infer<typeof redirectCreateInput>
) => {
const pages = getRequiredPages(state);
const value = parseRedirect(input);
@@ -224,10 +224,7 @@ export const createRedirect = (
export const updateRedirect = (
state: Pick<BuilderState, "pages">,
- input: {
- old: string;
- values: { old?: string; new?: string; status?: "301" | "302" | null };
- }
+ input: z.infer<typeof redirectUpdateInput>
) => {
const pages = getRequiredPages(state);
const redirects = pages.redirects ?? [];
@@ -276,7 +273,7 @@ export const updateRedirect = (
export const deleteRedirect = (
state: Pick<BuilderState, "pages">,
- input: { old: string }
+ input: z.infer<typeof redirectDeleteInput>
) => {
const redirects = getRequiredPages(state).redirects ?? [];
const index = findRedirectIndex(redirects, input.old);
@@ -314,6 +311,17 @@ export const breakpointUpdateFieldsInput = z.object({
condition: z.string().nullable().optional(),
});
+export const breakpointCreateInput = breakpointFieldsInput;
+
+export const breakpointUpdateInput = z.object({
+ breakpointId: z.string(),
+ values: breakpointUpdateFieldsInput,
+});
+
+export const breakpointDeleteInput = z.object({
+ breakpointId: z.string(),
+});
+
const parseBreakpoint = (input: Breakpoint) => {
const result = breakpoint.safeParse(input);
if (result.success === false) {
@@ -324,7 +332,7 @@ const parseBreakpoint = (input: Breakpoint) => {
export const createBreakpoint = (
state: Pick<BuilderState, "breakpoints">,
- input: Breakpoint
+ input: z.infer<typeof breakpointCreateInput>
) => {
const breakpoints = getRequiredBreakpoints(state);
if (breakpoints.has(input.id)) {
@@ -367,10 +375,7 @@ export const createBreakpoint = (
export const updateBreakpoint = (
state: Pick<BuilderState, "breakpoints">,
- input: {
- breakpointId: string;
- values: Settable<Omit<Breakpoint, "id">>;
- }
+ input: z.infer<typeof breakpointUpdateInput>
) => {
const breakpoints = getRequiredBreakpoints(state);
const current = breakpoints.get(input.breakpointId);
@@ -414,7 +419,7 @@ export const updateBreakpoint = (
export const deleteBreakpoint = (
state: Pick<BuilderState, "breakpoints" | "styles">,
- input: { breakpointId: string }
+ input: z.infer<typeof breakpointDeleteInput>
) => {
const breakpoints = getRequiredBreakpoints(state);
if (state.styles === undefined) {
diff --git a/packages/project-build/src/runtime/props.ts b/packages/project-build/src/runtime/props.ts
index 8dc022bda8..2219af933a 100644
--- a/packages/project-build/src/runtime/props.ts
+++ b/packages/project-build/src/runtime/props.ts
@@ -149,6 +149,20 @@ export const propBindingInput = z
);
});
+export const propUpdatesInput = z.object({
+ updates: z.array(propValueInput).min(1),
+});
+
+export const propBindingsInput = z.object({
+ bindings: z.array(propBindingInput).min(1),
+});
+
+export const propDeletionsInput = z.object({
+ deletions: z
+ .array(z.object({ instanceId: z.string(), name: z.string() }))
+ .min(1),
+});
+
type ValidatedPropInputResult =
| { success: true; prop: Prop }
| { success: false; errors: string[] };
@@ -472,7 +486,7 @@ const throwPropErrors = (errors: string[]) =>
export const updateProps = (
state: Pick<BuilderState, "instances" | "props">,
- input: { updates: Array<z.infer<typeof propValueInput>> },
+ input: z.infer<typeof propUpdatesInput>,
context: { createId: () => string }
) => {
const { instances, props } = getRequiredPropState(state);
@@ -501,7 +515,7 @@ export const updateProps = (
export const bindProps = (
state: Pick<BuilderState, "instances" | "props">,
- input: { bindings: Array<z.infer<typeof propBindingInput>> },
+ input: z.infer<typeof propBindingsInput>,
context: { createId: () => string }
) => {
const { instances, props } = getRequiredPropState(state);
@@ -530,7 +544,7 @@ export const bindProps = (
export const deleteProps = (
state: Pick<BuilderState, "instances" | "props">,
- input: { deletions: Array<{ instanceId: string; name: string }> }
+ input: z.infer<typeof propDeletionsInput>
) => {
const { instances, props } = getRequiredPropState(state);
const { missingInstanceId, payload, propIds } = createPropDeletePayload({
diff --git a/packages/project-build/src/runtime/registry.test.ts b/packages/project-build/src/runtime/registry.test.ts
index 1d028e4540..1ede3eca38 100644
--- a/packages/project-build/src/runtime/registry.test.ts
+++ b/packages/project-build/src/runtime/registry.test.ts
@@ -188,6 +188,25 @@ const state = {
breakpoints: new Map(),
} satisfies BuilderState;
+const expectRuntimeValidationError = (operationId: string, input: unknown) => {
+ try {
+ executeBuilderRuntimeOperation({
+ id: operationId,
+ state,
+ input,
+ context,
+ });
+ } catch (error) {
+ expect(error).toMatchObject({ name: "ZodError" });
+ return;
+ }
+ throw new Error(`Expected ${operationId} to reject invalid input`);
+};
+
+const mutationOperationIds = runtimeOperationContracts
+ .filter((contract) => contract.kind === "mutation")
+ .map((contract) => contract.id);
+
test("runtime operation registry implements every runtime contract", () => {
const contractIds = runtimeOperationContracts.map((contract) => contract.id);
const operationIds = builderRuntimeOperations.map(
@@ -381,6 +400,94 @@ describe("builder runtime read families", () => {
resources: [{ id: "resource", dataSourceId: "resourceDataSource" }],
});
});
+
+ test("validates style mutation inputs through shared runtime schemas", () => {
+ const updates = [
+ {
+ instanceId: "heading",
+ property: "box-shadow",
+ value: { type: "keyword", value: "none" },
+ },
+ ];
+ expect(
+ executeBuilderRuntimeOperation({
+ id: "styles.updateDeclarations",
+ state,
+ input: { updates: JSON.stringify(updates) },
+ context,
+ })
+ ).toMatchObject({
+ result: { styleKeys: expect.arrayContaining(["local:base:boxShadow:"]) },
+ });
+
+ const deletions = [{ instanceId: "heading", property: "color" }];
+ expect(
+ executeBuilderRuntimeOperation({
+ id: "styles.deleteDeclarations",
+ state,
+ input: { deletions: JSON.stringify(deletions) },
+ context,
+ })
+ ).toMatchObject({
+ result: { styleKeys: ["local:base:color:"] },
+ });
+
+ expect(() =>
+ executeBuilderRuntimeOperation({
+ id: "styles.updateDeclarations",
+ state,
+ input: { updates: { instanceId: "heading" } },
+ context,
+ })
+ ).toThrow();
+
+ const tokenUpdates = [
+ {
+ property: "font-size",
+ value: { type: "unit", value: 16, unit: "px" },
+ },
+ ];
+ expect(
+ executeBuilderRuntimeOperation({
+ id: "designTokens.updateStyles",
+ state,
+ input: {
+ designTokenId: "token",
+ updates: JSON.stringify(tokenUpdates),
+ },
+ context,
+ })
+ ).toMatchObject({
+ result: { designTokenId: "token", styleKeys: ["token:base:fontSize:"] },
+ });
+
+ const tokenDeletions = [{ property: "color" }];
+ expect(
+ executeBuilderRuntimeOperation({
+ id: "designTokens.deleteStyles",
+ state,
+ input: {
+ designTokenId: "token",
+ deletions: JSON.stringify(tokenDeletions),
+ },
+ context,
+ })
+ ).toMatchObject({
+ result: { designTokenId: "token", styleKeys: ["token:base:color:"] },
+ });
+
+ expect(() =>
+ executeBuilderRuntimeOperation({
+ id: "designTokens.updateStyles",
+ state,
+ input: {
+ designTokenId: "token",
+ updates: { property: "color" },
+ },
+ context,
+ })
+ ).toThrow();
+ });
});
describe("builder runtime registry", () => {
@@ -414,4 +521,60 @@ describe("builder runtime registry", () => {
duplicateWithDeterministicIds()
);
});
+
+ test("validates every mutation input at the runtime boundary", () => {
+ const invalidInputByOperation = new Map<string, unknown>([
+ ["pages.create", {}],
+ ["pages.update", {}],
+ ["projectSettings.update", { meta: "invalid" }],
+ ["redirects.create", {}],
+ ["redirects.update", {}],
+ ["redirects.delete", {}],
+ ["breakpoints.create", {}],
+ ["breakpoints.update", {}],
+ ["breakpoints.delete", {}],
+ ["pages.delete", {}],
+ ["pages.duplicate", {}],
+ ["pageTemplates.createPage", {}],
+ ["folders.create", {}],
+ ["folders.update", {}],
+ ["folders.delete", {}],
+ ["instances.append", { parentInstanceId: "body", children: {} }],
+ ["instances.move", { moves: {} }],
+ ["instances.clone", {}],
+ ["instances.delete", { instanceIds: "heading" }],
+ ["instances.updateProps", { updates: {} }],
+ ["instances.deleteProps", { deletions: {} }],
+ ["instances.bindProps", { bindings: {} }],
+ ["instances.updateText", {}],
+ ["styles.updateDeclarations", { updates: {} }],
+ ["styles.deleteDeclarations", { deletions: {} }],
+ ["styles.replaceValues", {}],
+ ["designTokens.create", { tokens: {} }],
+ ["designTokens.updateStyles", { designTokenId: "token", updates: {} }],
+ ["designTokens.deleteStyles", { designTokenId: "token", deletions: {} }],
+ ["designTokens.attach", { designTokenId: "token", instanceIds: {} }],
+ ["designTokens.detach", { designTokenId: "token", instanceIds: {} }],
+ ["designTokens.extract", { instanceIds: {}, name: "Token" }],
+ ["cssVariables.define", { vars: [] }],
+ ["cssVariables.delete", { names: "--color" }],
+ ["cssVariables.rewriteRefs", { map: [] }],
+ ["variables.create", {}],
+ ["variables.update", {}],
+ ["variables.delete", {}],
+ ["resources.create", {}],
+ ["resources.update", {}],
+ ["resources.delete", {}],
+ ["assets.replace", {}],
+ ["assets.delete", { assetIdsOrPrefixes: "asset" }],
+ ]);
+
+ expect(Array.from(invalidInputByOperation.keys())).toEqual(
+ mutationOperationIds
+ );
+
+ for (const [operationId, input] of invalidInputByOperation) {
+ expectRuntimeValidationError(operationId, input);
+ }
+ });
});
diff --git a/packages/project-build/src/runtime/registry.ts b/packages/project-build/src/runtime/registry.ts
index efb8e84dfa..6586824aee 100644
--- a/packages/project-build/src/runtime/registry.ts
+++ b/packages/project-build/src/runtime/registry.ts
@@ -38,14 +38,10 @@ export const builderRuntimeOperations = [
)
),
runtimeOperation("pages.create", ({ state, input, context }) =>
- pages.createPage(
- state,
- input as Parameters<typeof pages.createPage>[1],
- context
- )
+ pages.createPage(state, pages.pageCreateInput.parse(input), context)
),
runtimeOperation("pages.update", ({ state, input }) =>
- pages.updatePage(state, input as Parameters<typeof pages.updatePage>[1])
+ pages.updatePage(state, pages.pageUpdateInput.parse(input))
),
runtimeOperation("projectSettings.get", ({ state }) =>
projectSettings.getProjectSettings(state)
@@ -53,7 +49,7 @@ export const builderRuntimeOperations = [
runtimeOperation("projectSettings.update", ({ state, input }) =>
projectSettings.updateProjectSettings(
state,
- input as Parameters<typeof projectSettings.updateProjectSettings>[1]
+ projectSettings.projectSettingsUpdateInput.parse(input)
)
),
runtimeOperation("redirects.list", ({ state }) =>
@@ -62,19 +58,19 @@ export const builderRuntimeOperations = [
runtimeOperation("redirects.create", ({ state, input }) =>
projectSettings.createRedirect(
state,
- input as Parameters<typeof projectSettings.createRedirect>[1]
+ projectSettings.redirectCreateInput.parse(input)
)
),
runtimeOperation("redirects.update", ({ state, input }) =>
projectSettings.updateRedirect(
state,
- input as Parameters<typeof projectSettings.updateRedirect>[1]
+ projectSettings.redirectUpdateInput.parse(input)
)
),
runtimeOperation("redirects.delete", ({ state, input }) =>
projectSettings.deleteRedirect(
state,
- input as Parameters<typeof projectSettings.deleteRedirect>[1]
+ projectSettings.redirectDeleteInput.parse(input)
)
),
runtimeOperation("breakpoints.list", ({ state }) =>
@@ -83,28 +79,28 @@ export const builderRuntimeOperations = [
runtimeOperation("breakpoints.create", ({ state, input }) =>
projectSettings.createBreakpoint(
state,
- input as Parameters<typeof projectSettings.createBreakpoint>[1]
+ projectSettings.breakpointCreateInput.parse(input)
)
),
runtimeOperation("breakpoints.update", ({ state, input }) =>
projectSettings.updateBreakpoint(
state,
- input as Parameters<typeof projectSettings.updateBreakpoint>[1]
+ projectSettings.breakpointUpdateInput.parse(input)
)
),
runtimeOperation("breakpoints.delete", ({ state, input }) =>
projectSettings.deleteBreakpoint(
state,
- input as Parameters<typeof projectSettings.deleteBreakpoint>[1]
+ projectSettings.breakpointDeleteInput.parse(input)
)
),
runtimeOperation("pages.delete", ({ state, input }) =>
- pages.deletePage(state, input as Parameters<typeof pages.deletePage>[1])
+ pages.deletePage(state, pages.pageDeleteInput.parse(input))
),
runtimeOperation("pages.duplicate", ({ state, input, context }) =>
pageCopy.duplicatePage(
state,
- input as Parameters<typeof pageCopy.duplicatePage>[1],
+ pageCopy.pageDuplicateInput.parse(input),
context
)
),
@@ -114,7 +110,7 @@ export const builderRuntimeOperations = [
runtimeOperation("pageTemplates.createPage", ({ state, input, context }) =>
pageCopy.createPageFromTemplate(
state,
- input as Parameters<typeof pageCopy.createPageFromTemplate>[1],
+ pageCopy.pageTemplateCreatePageInput.parse(input),
context
)
),
@@ -122,17 +118,13 @@ export const builderRuntimeOperations = [
pages.listFolders(state, input as Parameters<typeof pages.listFolders>[1])
),
runtimeOperation("folders.create", ({ state, input, context }) =>
- pages.createFolder(
- state,
- input as Parameters<typeof pages.createFolder>[1],
- context
- )
+ pages.createFolder(state, pages.folderCreateInput.parse(input), context)
),
runtimeOperation("folders.update", ({ state, input }) =>
- pages.updateFolder(state, input as Parameters<typeof pages.updateFolder>[1])
+ pages.updateFolder(state, pages.folderUpdateInput.parse(input))
),
runtimeOperation("folders.delete", ({ state, input }) =>
- pages.deleteFolder(state, input as Parameters<typeof pages.deleteFolder>[1])
+ pages.deleteFolder(state, pages.folderDeleteInput.parse(input))
),
runtimeOperation("instances.list", ({ state, input }) =>
instances.listInstances(
@@ -149,45 +141,34 @@ export const builderRuntimeOperations = [
runtimeOperation("instances.append", ({ state, input, context }) =>
instances.appendInstances(
state,
- input as Parameters<typeof instances.appendInstances>[1],
+ instances.appendInstancesInput.parse(input),
context
)
),
runtimeOperation("instances.move", ({ state, input }) =>
- instances.moveInstances(
- state,
- input as Parameters<typeof instances.moveInstances>[1]
- )
+ instances.moveInstances(state, instances.moveInstancesInput.parse(input))
),
runtimeOperation("instances.clone", ({ state, input, context }) =>
instances.cloneInstance(
state,
- input as Parameters<typeof instances.cloneInstance>[1],
+ instances.cloneInstanceInput.parse(input),
context
)
),
runtimeOperation("instances.delete", ({ state, input }) =>
instances.deleteInstances(
state,
- input as Parameters<typeof instances.deleteInstances>[1]
+ instances.deleteInstancesInput.parse(input)
)
),
runtimeOperation("instances.updateProps", ({ state, input, context }) =>
- props.updateProps(
- state,
- input as Parameters<typeof props.updateProps>[1],
- context
- )
+ props.updateProps(state, props.propUpdatesInput.parse(input), context)
),
runtimeOperation("instances.deleteProps", ({ state, input }) =>
- props.deleteProps(state, input as Parameters<typeof props.deleteProps>[1])
+ props.deleteProps(state, props.propDeletionsInput.parse(input))
),
runtimeOperation("instances.bindProps", ({ state, input, context }) =>
- props.bindProps(
- state,
- input as Parameters<typeof props.bindProps>[1],
- context
- )
+ props.bindProps(state, props.propBindingsInput.parse(input), context)
),
runtimeOperation("instances.listTexts", ({ state, input }) =>
instances.listTextInstances(
@@ -198,7 +179,7 @@ export const builderRuntimeOperations = [
runtimeOperation("instances.updateText", ({ state, input }) =>
instances.updateTextInstance(
state,
- input as Parameters<typeof instances.updateTextInstance>[1]
+ instances.updateTextInstanceInput.parse(input)
)
),
runtimeOperation("styles.getDeclarations", ({ state, input }) =>
@@ -210,21 +191,18 @@ export const builderRuntimeOperations = [
runtimeOperation("styles.updateDeclarations", ({ state, input, context }) =>
styles.updateStyleDeclarations(
state,
- input as Parameters<typeof styles.updateStyleDeclarations>[1],
+ styles.styleUpdateDeclarationsInput.parse(input),
context
)
),
runtimeOperation("styles.deleteDeclarations", ({ state, input }) =>
styles.deleteStyleDeclarations(
state,
- input as Parameters<typeof styles.deleteStyleDeclarations>[1]
+ styles.styleDeleteDeclarationsInput.parse(input)
)
),
runtimeOperation("styles.replaceValues", ({ state, input }) =>
- styles.replaceStyleValues(
- state,
- input as Parameters<typeof styles.replaceStyleValues>[1]
- )
+ styles.replaceStyleValues(state, styles.styleReplaceInput.parse(input))
),
runtimeOperation("designTokens.list", ({ state, input }) =>
styles.listDesignTokens(
@@ -235,38 +213,32 @@ export const builderRuntimeOperations = [
runtimeOperation("designTokens.create", ({ state, input, context }) =>
styles.createDesignTokens(
state,
- input as Parameters<typeof styles.createDesignTokens>[1],
+ styles.designTokenCreateManyInput.parse(input),
context
)
),
runtimeOperation("designTokens.updateStyles", ({ state, input }) =>
styles.updateDesignTokenStyles(
state,
- input as Parameters<typeof styles.updateDesignTokenStyles>[1]
+ styles.designTokenStyleUpdatesInput.parse(input)
)
),
runtimeOperation("designTokens.deleteStyles", ({ state, input }) =>
styles.deleteDesignTokenStyles(
state,
- input as Parameters<typeof styles.deleteDesignTokenStyles>[1]
+ styles.designTokenStyleDeletionsInput.parse(input)
)
),
runtimeOperation("designTokens.attach", ({ state, input }) =>
- styles.attachDesignToken(
- state,
- input as Parameters<typeof styles.attachDesignToken>[1]
- )
+ styles.attachDesignToken(state, styles.designTokenAttachInput.parse(input))
),
runtimeOperation("designTokens.detach", ({ state, input }) =>
- styles.detachDesignToken(
- state,
- input as Parameters<typeof styles.detachDesignToken>[1]
- )
+ styles.detachDesignToken(state, styles.designTokenDetachInput.parse(input))
),
runtimeOperation("designTokens.extract", ({ state, input, context }) =>
styles.extractDesignToken(
state,
- input as Parameters<typeof styles.extractDesignToken>[1],
+ styles.designTokenExtractInput.parse(input),
context
)
),
@@ -279,20 +251,17 @@ export const builderRuntimeOperations = [
runtimeOperation("cssVariables.define", ({ state, input, context }) =>
styles.defineCssVariables(
state,
- input as Parameters<typeof styles.defineCssVariables>[1],
+ styles.cssVariableDefineInput.parse(input),
context
)
),
runtimeOperation("cssVariables.delete", ({ state, input }) =>
- styles.deleteCssVariables(
- state,
- input as Parameters<typeof styles.deleteCssVariables>[1]
- )
+ styles.deleteCssVariables(state, styles.cssVariableDeleteInput.parse(input))
),
runtimeOperation("cssVariables.rewriteRefs", ({ state, input }) =>
styles.rewriteCssVariableRefs(
state,
- input as Parameters<typeof styles.rewriteCssVariableRefs>[1]
+ styles.cssVariableRewriteRefsInput.parse(input)
)
),
runtimeOperation("variables.list", ({ state, input }) =>
@@ -304,43 +273,27 @@ export const builderRuntimeOperations = [
runtimeOperation("variables.create", ({ state, input, context }) =>
data.createDataVariable(
state,
- input as Parameters<typeof data.createDataVariable>[1],
+ data.dataVariableCreateInput.parse(input),
context
)
),
runtimeOperation("variables.update", ({ state, input }) =>
- data.updateDataVariable(
- state,
- input as Parameters<typeof data.updateDataVariable>[1]
- )
+ data.updateDataVariable(state, data.dataVariableUpdateInput.parse(input))
),
runtimeOperation("variables.delete", ({ state, input }) =>
- data.deleteDataVariable(
- state,
- input as Parameters<typeof data.deleteDataVariable>[1]
- )
+ data.deleteDataVariable(state, data.dataVariableDeleteInput.parse(input))
),
runtimeOperation("resources.list", ({ state, input }) =>
data.listResources(state, input as Parameters<typeof data.listResources>[1])
),
runtimeOperation("resources.create", ({ state, input, context }) =>
- data.createResource(
- state,
- input as Parameters<typeof data.createResource>[1],
- context
- )
+ data.createResource(state, data.resourceCreateInput.parse(input), context)
),
runtimeOperation("resources.update", ({ state, input }) =>
- data.updateResource(
- state,
- input as Parameters<typeof data.updateResource>[1]
- )
+ data.updateResource(state, data.resourceUpdateInput.parse(input))
),
runtimeOperation("resources.delete", ({ state, input }) =>
- data.deleteResource(
- state,
- input as Parameters<typeof data.deleteResource>[1]
- )
+ data.deleteResource(state, data.resourceDeleteInput.parse(input))
),
runtimeOperation("assets.list", ({ state, input }) =>
assets.listAssets(state, input as Parameters<typeof assets.listAssets>[1])
@@ -352,16 +305,10 @@ export const builderRuntimeOperations = [
)
),
runtimeOperation("assets.replace", ({ state, input }) =>
- assets.replaceAsset(
- state,
- input as Parameters<typeof assets.replaceAsset>[1]
- )
+ assets.replaceAsset(state, assets.assetReplaceInput.parse(input))
),
runtimeOperation("assets.delete", ({ state, input }) =>
- assets.deleteAssets(
- state,
- input as Parameters<typeof assets.deleteAssets>[1]
- )
+ assets.deleteAssets(state, assets.assetDeleteInput.parse(input))
),
] as const satisfies readonly BuilderRuntimeOperation[];
diff --git a/packages/project-build/src/runtime/styles.ts b/packages/project-build/src/runtime/styles.ts
index 137d762de0..b976a8d41b 100644
--- a/packages/project-build/src/runtime/styles.ts
+++ b/packages/project-build/src/runtime/styles.ts
@@ -226,6 +226,28 @@ export const styleDeleteInput = z.object({
state: z.string().optional(),
});
+const jsonArrayStringInput = (value: unknown) => {
+ if (typeof value !== "string") {
+ return value;
+ }
+ try {
+ return JSON.parse(value);
+ } catch {
+ return value;
+ }
+};
+
+const jsonArrayInput = <Item extends z.ZodTypeAny>(item: Item) =>
+ z.preprocess(jsonArrayStringInput, z.array(item).min(1));
+
+export const styleUpdateDeclarationsInput = z.object({
+ updates: jsonArrayInput(styleUpdateInput),
+});
+
+export const styleDeleteDeclarationsInput = z.object({
+ deletions: jsonArrayInput(styleDeleteInput),
+});
+
export const styleReplaceInput = z.object({
property: z.string(),
fromValue: z.unknown(),
@@ -311,6 +333,21 @@ export type CssVariableNameError =
export const cssVariableValueInput = z.union([z.string(), styleValue]);
+export const cssVariableDefineInput = z.object({
+ vars: z.record(cssVariableValueInput),
+ overwrite: z.boolean().optional(),
+});
+
+export const cssVariableDeleteInput = z.object({
+ names: z.array(z.string()).min(1),
+ force: z.boolean().optional(),
+});
+
+export const cssVariableRewriteRefsInput = z.object({
+ map: z.record(z.string()),
+ scopeRegex: z.string().optional(),
+});
+
export const validateCssVariableNameWithStyles = ({
name,
styles,
@@ -919,6 +956,37 @@ export const designTokenCreateInput = z.object({
declarations: z.array(designTokenStyleInput).optional(),
});
+export const designTokenCreateManyInput = z.object({
+ tokens: jsonArrayInput(designTokenCreateInput),
+});
+
+export const designTokenStyleUpdatesInput = z.object({
+ designTokenId: z.string(),
+ updates: jsonArrayInput(designTokenStyleInput),
+});
+
+export const designTokenStyleDeletionsInput = z.object({
+ designTokenId: z.string(),
+ deletions: jsonArrayInput(styleDeleteInput.omit({ instanceId: true })),
+});
+
+export const designTokenAttachInput = z.object({
+ designTokenId: z.string(),
+ instanceIds: z.array(z.string()).min(1),
+ position: z.enum(["before-local", "after-local"]).optional(),
+});
+
+export const designTokenDetachInput = z.object({
+ designTokenId: z.string(),
+ instanceIds: z.array(z.string()).min(1),
+});
+
+export const designTokenExtractInput = z.object({
+ instanceIds: z.array(z.string()).min(1),
+ name: z.string().min(1),
+ removeLocalProps: z.array(z.string()).optional(),
+});
+
export const createTokenStyleSource = ({
id,
name,
@@ -2421,7 +2489,7 @@ export const updateStyleDeclarations = (
| "styleSources"
| "styleSourceSelections"
>,
- input: { updates: Array<z.infer<typeof styleUpdateInput>> },
+ input: z.infer<typeof styleUpdateDeclarationsInput>,
context: { createId: () => string }
) => {
const styleState = getRequiredStyleMutationState(state);
@@ -2461,7 +2529,7 @@ export const deleteStyleDeclarations = (
| "styleSources"
| "styleSourceSelections"
>,
- input: { deletions: Array<z.infer<typeof styleDeleteInput>> }
+ input: z.infer<typeof styleDeleteDeclarationsInput>
) => {
const styleState = getRequiredStyleMutationState(state);
assertStyleInstances(
@@ -2574,10 +2642,7 @@ export const defineCssVariables = (
| "styleSources"
| "styleSourceSelections"
>,
- input: {
- vars: Record<string, string | StyleValue>;
- overwrite?: boolean;
- },
+ input: z.infer<typeof cssVariableDefineInput>,
context: { createId: () => string }
) => {
const rootInstanceId =
@@ -2626,7 +2691,7 @@ export const deleteCssVariables = (
BuilderState,
"styles" | "props" | "styleSources" | "styleSourceSelections"
>,
- input: { names: string[]; force?: boolean }
+ input: z.infer<typeof cssVariableDeleteInput>
) => {
for (const name of input.names) {
assertCssVariableName(name);
@@ -2662,7 +2727,7 @@ export const rewriteCssVariableRefs = (
BuilderState,
"styles" | "props" | "styleSources" | "styleSourceSelections"
>,
- input: { map: Record<string, string>; scopeRegex?: string }
+ input: z.infer<typeof cssVariableRewriteRefsInput>
) => {
for (const [fromName, toName] of Object.entries(input.map)) {
assertCssVariableName(fromName);
@@ -2706,7 +2771,7 @@ export const createDesignTokens = (
BuilderState,
"breakpoints" | "styles" | "styleSources" | "styleSourceSelections"
>,
- input: { tokens: Array<z.infer<typeof designTokenCreateInput>> },
+ input: z.infer<typeof designTokenCreateManyInput>,
context: { createId: () => string }
) => {
const styleState = getRequiredStyleState(state);
@@ -2751,10 +2816,7 @@ export const updateDesignTokenStyles = (
BuilderState,
"breakpoints" | "styles" | "styleSources" | "styleSourceSelections"
>,
- input: {
- designTokenId: string;
- updates: Array<z.infer<typeof designTokenStyleInput>>;
- }
+ input: z.infer<typeof designTokenStyleUpdatesInput>
) => {
const styleState = getRequiredStyleState(state);
getDesignTokenOrThrow(styleState.styleSources.values(), input.designTokenId);
@@ -2777,10 +2839,7 @@ export const deleteDesignTokenStyles = (
BuilderState,
"breakpoints" | "styles" | "styleSources" | "styleSourceSelections"
>,
- input: {
- designTokenId: string;
- deletions: Array<Omit<z.infer<typeof styleDeleteInput>, "instanceId">>;
- }
+ input: z.infer<typeof designTokenStyleDeletionsInput>
) => {
const styleState = getRequiredStyleState(state);
getDesignTokenOrThrow(styleState.styleSources.values(), input.designTokenId);
@@ -2803,11 +2862,7 @@ export const attachDesignToken = (
BuilderState,
"instances" | "styles" | "styleSources" | "styleSourceSelections"
>,
- input: {
- designTokenId: string;
- instanceIds: string[];
- position?: "before-local" | "after-local";
- }
+ input: z.infer<typeof designTokenAttachInput>
) => {
const styleState = getRequiredStyleMutationState(state);
getDesignTokenOrThrow(styleState.styleSources.values(), input.designTokenId);
@@ -2831,7 +2886,7 @@ export const detachDesignToken = (
BuilderState,
"instances" | "styles" | "styleSources" | "styleSourceSelections"
>,
- input: { designTokenId: string; instanceIds: string[] }
+ input: z.infer<typeof designTokenDetachInput>
) => {
const styleState = getRequiredStyleMutationState(state);
getDesignTokenOrThrow(styleState.styleSources.values(), input.designTokenId);
@@ -2853,11 +2908,7 @@ export const extractDesignToken = (
BuilderState,
"instances" | "styles" | "styleSources" | "styleSourceSelections"
>,
- input: {
- instanceIds: string[];
- name: string;
- removeLocalProps?: string[];
- },
+ input: z.infer<typeof designTokenExtractInput>,
context: { createId: () => string }
) => {
const styleState = getRequiredStyleMutationState(state);
diff --git a/packages/protocol/src/builder-api/operations.test.ts b/packages/protocol/src/builder-api/operations.test.ts
index 5a3baf381a..0a0b761395 100644
--- a/packages/protocol/src/builder-api/operations.test.ts
+++ b/packages/protocol/src/builder-api/operations.test.ts
@@ -46,6 +46,45 @@ describe("public api operation catalog", () => {
expect(getPublicApiOperation("whoami").inputFields).toEqual([]);
});
+ test("documents array input field types", () => {
+ const expectedArrayInputFieldTypes = {
+ "append-instance": { children: "array" },
+ "move-instance": { moves: "array" },
+ "delete-instance": { instanceIds: "array" },
+ "update-props": { updates: "array" },
+ "delete-props": { deletions: "array" },
+ "bind-props": { bindings: "array" },
+ "update-styles": { updates: "array" },
+ "delete-styles": { deletions: "array" },
+ "create-design-token": { tokens: "array" },
+ "update-design-token-styles": { updates: "array" },
+ "delete-design-token-styles": { deletions: "array" },
+ "attach-design-token": { instanceIds: "array" },
+ "detach-design-token": { instanceIds: "array" },
+ "extract-design-token": {
+ instanceIds: "array",
+ removeLocalProps: "array",
+ },
+ "delete-css-variable": { names: "array" },
+ "delete-asset": { assetIdsOrPrefixes: "array" },
+ } as const;
+
+ const expectedEntries = Object.entries(
+ expectedArrayInputFieldTypes
+ ) as Array<
+ [
+ keyof typeof expectedArrayInputFieldTypes,
+ (typeof expectedArrayInputFieldTypes)[keyof typeof expectedArrayInputFieldTypes],
+ ]
+ >;
+
+ for (const [command, inputFieldTypes] of expectedEntries) {
+ expect(getPublicApiOperation(command).inputFieldTypes).toEqual(
+ inputFieldTypes
+ );
+ }
+ });
+
test("derives local-capable namespace metadata from runtime contracts", () => {
const runtimeContractsById = new Map(
publicRuntimeOperationContracts.map((contract) => [contract.id, contract])
diff --git a/packages/protocol/src/builder-api/operations.ts b/packages/protocol/src/builder-api/operations.ts
index 98c13ba635..fdd3ecb682 100644
--- a/packages/protocol/src/builder-api/operations.ts
+++ b/packages/protocol/src/builder-api/operations.ts
@@ -23,6 +23,7 @@ type PublicApiOperationInput = {
client: string;
permit?: PublicApiOperationPermit;
invalidatesNamespaces?: readonly PublicApiOperationNamespace[];
+ inputFieldTypes?: Partial<Record<string, "array">>;
};
export type PublicApiOperation<Command extends string = string> = Omit<
@@ -33,6 +34,7 @@ export type PublicApiOperation<Command extends string = string> = Omit<
permit: PublicApiOperationPermit;
description: string;
inputFields: readonly string[];
+ inputFieldTypes: Partial<Record<string, "array">>;
requiredOptions?: readonly string[];
examples: readonly string[];
localCapable: boolean;
@@ -190,6 +192,7 @@ const withDefaultPermit = <Operation extends PublicApiOperationInput>(
operation.permit ?? (operation.method === "query" ? "view" : "build"),
description: documentation.description,
inputFields: inputFieldsLookup[operation.command] ?? [],
+ inputFieldTypes: operation.inputFieldTypes ?? {},
requiredOptions: documentation.requiredOptions,
examples: documentation.examples,
localCapable: runtimeOperation !== undefined,
@@ -424,6 +427,7 @@ const publicApiOperationInputs = [
method: "mutation",
path: "api.instances.append",
client: "appendInstance",
+ inputFieldTypes: { children: "array" },
},
{
command: "move-instance",
@@ -431,6 +435,7 @@ const publicApiOperationInputs = [
method: "mutation",
path: "api.instances.move",
client: "moveInstance",
+ inputFieldTypes: { moves: "array" },
},
{
command: "clone-instance",
@@ -445,6 +450,7 @@ const publicApiOperationInputs = [
method: "mutation",
path: "api.instances.delete",
client: "deleteInstance",
+ inputFieldTypes: { instanceIds: "array" },
},
{
command: "update-props",
@@ -453,6 +459,7 @@ const publicApiOperationInputs = [
path: "api.instances.updateProps",
client: "updateProps",
permit: "edit",
+ inputFieldTypes: { updates: "array" },
},
{
command: "delete-props",
@@ -461,6 +468,7 @@ const publicApiOperationInputs = [
path: "api.instances.deleteProps",
client: "deleteProps",
permit: "edit",
+ inputFieldTypes: { deletions: "array" },
},
{
command: "bind-props",
@@ -468,6 +476,7 @@ const publicApiOperationInputs = [
method: "mutation",
path: "api.instances.bindProps",
client: "bindProps",
+ inputFieldTypes: { bindings: "array" },
},
{
command: "list-texts",
@@ -497,6 +506,7 @@ const publicApiOperationInputs = [
method: "mutation",
path: "api.styles.updateDeclarations",
client: "updateStyleDeclarations",
+ inputFieldTypes: { updates: "array" },
},
{
command: "delete-styles",
@@ -504,6 +514,7 @@ const publicApiOperationInputs = [
method: "mutation",
path: "api.styles.deleteDeclarations",
client: "deleteStyleDeclarations",
+ inputFieldTypes: { deletions: "array" },
},
{
command: "replace-styles",
@@ -525,6 +536,7 @@ const publicApiOperationInputs = [
method: "mutation",
path: "api.designTokens.create",
client: "createDesignTokens",
+ inputFieldTypes: { tokens: "array" },
},
{
command: "update-design-token-styles",
@@ -532,6 +544,7 @@ const publicApiOperationInputs = [
method: "mutation",
path: "api.designTokens.updateStyles",
client: "updateDesignTokenStyles",
+ inputFieldTypes: { updates: "array" },
},
{
command: "delete-design-token-styles",
@@ -539,6 +552,7 @@ const publicApiOperationInputs = [
method: "mutation",
path: "api.designTokens.deleteStyles",
client: "deleteDesignTokenStyles",
+ inputFieldTypes: { deletions: "array" },
},
{
command: "attach-design-token",
@@ -546,6 +560,7 @@ const publicApiOperationInputs = [
method: "mutation",
path: "api.designTokens.attach",
client: "attachDesignToken",
+ inputFieldTypes: { instanceIds: "array" },
},
{
command: "detach-design-token",
@@ -553,6 +568,7 @@ const publicApiOperationInputs = [
method: "mutation",
path: "api.designTokens.detach",
client: "detachDesignToken",
+ inputFieldTypes: { instanceIds: "array" },
},
{
command: "extract-design-token",
@@ -560,6 +576,7 @@ const publicApiOperationInputs = [
method: "mutation",
path: "api.designTokens.extract",
client: "extractDesignToken",
+ inputFieldTypes: { instanceIds: "array", removeLocalProps: "array" },
},
{
command: "list-css-variables",
@@ -581,6 +598,7 @@ const publicApiOperationInputs = [
method: "mutation",
path: "api.cssVariables.delete",
client: "deleteCssVariables",
+ inputFieldTypes: { names: "array" },
},
{
command: "rewrite-css-variable-refs",
@@ -755,6 +773,7 @@ const publicApiOperationInputs = [
method: "mutation",
path: "api.assets.delete",
client: "deleteAssets",
+ inputFieldTypes: { assetIdsOrPrefixes: "array" },
},
] as const satisfies readonly PublicApiOperationInput[];