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
experimental: Add ssg-netlify and ssg-vercel to the cli (#3835)
Ivan Starkov54e686a4e304
diff --git a/fixtures/webstudio-cloudflare-template/package.json b/fixtures/webstudio-cloudflare-template/package.jsonindex 154ee324ea..8fe04ef5da 100644--- a/fixtures/webstudio-cloudflare-template/package.json+++ b/fixtures/webstudio-cloudflare-template/package.json@@ -4,7 +4,7 @@"cli": "NODE_OPTIONS='--conditions=webstudio --import=tsx' webstudio","fixtures:link": "pnpm cli link --link \"https://main.development.webstudio.is/builder/d845c167-ea07-4875-b08d-83e97c09dcce?authToken=e9d1343f-9298-4fd3-a66e-f89a5af2dd93&\"","fixtures:sync": "pnpm cli sync && pnpm prettier --write ./.webstudio/",- "fixtures:build": "pnpm cli build --template internal --template cloudflare --template saas-helpers --preview && pnpm prettier --write ./app/ ./package.json ./tsconfig.json",+ "fixtures:build": "pnpm cli build --template cloudflare --template saas-helpers --template internal --preview && pnpm prettier --write ./app/ ./package.json ./tsconfig.json","build": "remix vite:build","dev": "remix vite:dev","typecheck": "tsc",diff --git a/fixtures/webstudio-custom-template/package.json b/fixtures/webstudio-custom-template/package.jsonindex 7551cb076b..e699810ec5 100644--- a/fixtures/webstudio-custom-template/package.json+++ b/fixtures/webstudio-custom-template/package.json@@ -7,7 +7,7 @@"cli": "NODE_OPTIONS='--conditions=webstudio --import=tsx' webstudio","fixtures:link": "pnpm cli link --link \"https://main.development.webstudio.is/builder/0d856812-61d8-4014-a20a-82e01c0eb8ee?authToken=d225fafb-4f20-4340-9359-c21df7c49a3f\"","fixtures:sync": "pnpm cli sync && pnpm prettier --write ./.webstudio/",- "fixtures:build": "pnpm cli build --template internal --template ./custom-template --template ./custom-template-stage --preview && pnpm prettier --write ./app/ ./package.json ./tsconfig.json"+ "fixtures:build": "pnpm cli build --template defaults --template ./custom-template --template ./custom-template-stage --template internal --preview --assets false && pnpm prettier --write ./app/ ./package.json ./tsconfig.json"},"private": true,"sideEffects": false,diff --git a/fixtures/webstudio-remix-netlify-edge-functions/package.json b/fixtures/webstudio-remix-netlify-edge-functions/package.jsonindex d85badfc9e..abee3da3c8 100644--- a/fixtures/webstudio-remix-netlify-edge-functions/package.json+++ b/fixtures/webstudio-remix-netlify-edge-functions/package.json@@ -8,7 +8,7 @@"cli": "NODE_OPTIONS='--conditions=webstudio --import=tsx' webstudio","fixtures:link": "pnpm cli link --link \"https://main.development.webstudio.is/builder/d845c167-ea07-4875-b08d-83e97c09dcce?authToken=e9d1343f-9298-4fd3-a66e-f89a5af2dd93&\"","fixtures:sync": "pnpm cli sync && pnpm prettier --write ./.webstudio/",- "fixtures:build": "pnpm cli build --template internal --template netlify-edge-functions --preview && pnpm prettier --write ./app/ ./package.json ./tsconfig.json"+ "fixtures:build": "pnpm cli build --template netlify-edge-functions --template internal --preview && pnpm prettier --write ./app/ ./package.json ./tsconfig.json"},"dependencies": {"@netlify/edge-functions": "^2.10.0",diff --git a/fixtures/webstudio-remix-netlify-functions/package.json b/fixtures/webstudio-remix-netlify-functions/package.jsonindex 8e8f002dfa..dd52da03ff 100644--- a/fixtures/webstudio-remix-netlify-functions/package.json+++ b/fixtures/webstudio-remix-netlify-functions/package.json@@ -7,7 +7,7 @@"cli": "NODE_OPTIONS='--conditions=webstudio --import=tsx' webstudio","fixtures:link": "pnpm cli link --link \"https://main.development.webstudio.is/builder/d845c167-ea07-4875-b08d-83e97c09dcce?authToken=e9d1343f-9298-4fd3-a66e-f89a5af2dd93\"","fixtures:sync": "pnpm cli sync && pnpm prettier --write ./.webstudio/",- "fixtures:build": "pnpm cli build --template internal --template netlify-functions --preview && pnpm prettier --write ./app/ ./package.json ./tsconfig.json"+ "fixtures:build": "pnpm cli build --template netlify-functions --template internal --preview && pnpm prettier --write ./app/ ./package.json ./tsconfig.json"},"dependencies": {"@netlify/functions": "^2.8.1",diff --git a/fixtures/webstudio-remix-vercel/package.json b/fixtures/webstudio-remix-vercel/package.jsonindex 65d77f7269..8d24b7c066 100644--- a/fixtures/webstudio-remix-vercel/package.json+++ b/fixtures/webstudio-remix-vercel/package.json@@ -7,7 +7,7 @@"cli": "NODE_OPTIONS='--conditions=webstudio --import=tsx' webstudio","fixtures:link": "pnpm cli link --link \"https://main.development.webstudio.is/builder/cddc1d44-af37-4cb6-a430-d300cf6f932d?authToken=1cdc6026-dd5b-4624-b89b-9bd45e9bcc3d&mode=preview\"","fixtures:sync": "pnpm cli sync && pnpm prettier --write ./.webstudio/",- "fixtures:build": "pnpm cli build --template internal --template vercel --preview && pnpm prettier --write ./app/ ./package.json ./tsconfig.json"+ "fixtures:build": "pnpm cli build --template vercel --template internal --preview && pnpm prettier --write ./app/ ./package.json ./tsconfig.json"},"private": true,"sideEffects": false,diff --git a/packages/cli/src/commands/build.ts b/packages/cli/src/commands/build.tsindex f927cd6b96..55999b081c 100644--- a/packages/cli/src/commands/build.ts+++ b/packages/cli/src/commands/build.ts@@ -2,7 +2,11 @@ import { access } from "node:fs/promises";import { exit } from "node:process";import { log } from "@clack/prompts";import { prebuild } from "../prebuild";-import { LOCAL_DATA_FILE, PROJECT_TEMPALTES } from "../config";+import {+ INTERNAL_TEMPLATES,+ LOCAL_DATA_FILE,+ PROJECT_TEMPLATES,+} from "../config";import type {CommonYargsArgv,StrictYargsOptionsToInterface,@@ -24,7 +28,31 @@ export const buildOptions = (yargs: CommonYargsArgv) =>type: "array",string: true,default: [] as string[],- describe: `Template to use for the build [choices: ${PROJECT_TEMPALTES.map(++ coerce: (values: string[]) => {+ const templates = [];+ for (const value of values) {+ const template =+ PROJECT_TEMPLATES.find((item) => item.value === value) ??+ INTERNAL_TEMPLATES.find((item) => item.value === value);++ if (template == null) {+ templates.push(value);+ continue;+ }++ if ("expand" in template && template.expand != null) {+ templates.push(...template.expand);+ continue;+ }++ templates.push(value);+ }++ return templates;+ },++ describe: `Template to use for the build [choices: ${PROJECT_TEMPLATES.map((item) => item.value).join(", ")}]`,});diff --git a/packages/cli/src/commands/init-flow.ts b/packages/cli/src/commands/init-flow.tsindex d4a2a01574..30767ffd28 100644--- a/packages/cli/src/commands/init-flow.ts+++ b/packages/cli/src/commands/init-flow.ts@@ -12,13 +12,13 @@ import {} from "@clack/prompts";import { $ } from "execa";import { createFolderIfNotExists, isFileExists } from "../fs-utils";-import { PROJECT_TEMPALTES } from "../config";+import { PROJECT_TEMPLATES } from "../config";import { link, validateShareLink } from "./link";import { sync } from "./sync";import { build, buildOptions } from "./build";import type { StrictYargsOptionsToInterface } from "./yargs-types";-type ProjectTemplates = (typeof PROJECT_TEMPALTES)[number]["value"];+type ProjectTemplates = (typeof PROJECT_TEMPLATES)[number]["value"];const exitIfCancelled = <Value>(value: Value | symbol): Value => {if (isCancel(value)) {@@ -73,7 +73,7 @@ export const initFlow = async (projectTemplate = exitIfCancelled(await select({message: "Where would you like to deploy your project?",- options: PROJECT_TEMPALTES,+ options: PROJECT_TEMPLATES,}));@@ -94,7 +94,7 @@ export const initFlow = async (projectTemplate = exitIfCancelled(await select({message: "Where would you like to deploy your project?",- options: PROJECT_TEMPALTES,+ options: PROJECT_TEMPLATES,}));}diff --git a/packages/cli/src/config.ts b/packages/cli/src/config.tsindex c9ac7dd938..ba44878279 100644--- a/packages/cli/src/config.ts+++ b/packages/cli/src/config.ts@@ -52,10 +52,41 @@ export const jsonToGlobalConfig = (json: unknown) => {export type GlobalConfig = z.infer<typeof zGlobalConfig>;-export const PROJECT_TEMPALTES = [- { value: "vanilla" as const, label: "Vanilla" },- { value: "vercel" as const, label: "Vercel" },- { value: "netlify-functions" as const, label: "Netlify Functions" },- { value: "netlify-edge-functions" as const, label: "Netlify Edge Functions" },+export const PROJECT_TEMPLATES = [+ {+ value: "vanilla" as const,+ label: "Vanilla",+ expand: ["defaults"],+ },+ { value: "vercel" as const, label: "Vercel", expand: ["defaults", "vercel"] },+ {+ value: "netlify-functions" as const,+ label: "Netlify Functions",+ expand: ["defaults", "netlify-functions"],+ },+ {+ value: "netlify-edge-functions" as const,+ label: "Netlify Edge Functions",+ expand: ["defaults", "netlify-edge-functions"],+ },{ value: "ssg" as const, label: "Static Site Generation (SSG)" },+ {+ value: "ssg-netlify" as const,+ label: "Static Site Generation (SSG) Netlify",+ expand: ["ssg", "ssg-netlify"],+ },+ {+ value: "ssg-vercel" as const,+ label: "Static Site Generation (SSG) Vercel",+ expand: ["ssg", "ssg-vercel"],+ },+];++// This feature will be made public eventually; currently, it’s only used for internal tasks.+export const INTERNAL_TEMPLATES = [+ {+ value: "cloudflare",+ label: "Cloudflare",+ expand: ["defaults", "cloudflare"],+ },];diff --git a/packages/cli/src/config.ts-expect.ts b/packages/cli/src/config.ts-expect.tsindex a50023917d..604a0f10e5 100644--- a/packages/cli/src/config.ts-expect.ts+++ b/packages/cli/src/config.ts-expect.ts@@ -1,10 +1,10 @@import { expectType, type TypeEqual } from "ts-expect";import { Templates } from "@webstudio-is/sdk";-import { PROJECT_TEMPALTES } from "./config";+import { PROJECT_TEMPLATES } from "./config";// We must ensure the validated template type always matches the CLI-supported templates.// This is crucial for security, as template names can be used in CLI/bash environments.// A TypeScript failure here means the Templates type is not consistent with the CLI templates.-expectType<TypeEqual<(typeof PROJECT_TEMPALTES)[number]["value"], Templates>>(+expectType<TypeEqual<(typeof PROJECT_TEMPLATES)[number]["value"], Templates>>(true);diff --git a/packages/cli/src/prebuild.ts b/packages/cli/src/prebuild.tsindex db2f801438..4113ce08a8 100644--- a/packages/cli/src/prebuild.ts+++ b/packages/cli/src/prebuild.ts@@ -231,11 +231,6 @@ export const prebuild = async (options: {}for (const template of options.template) {- // default template is always applied no need to check- if (template === "vanilla" || template === "ssg") {- continue;- }-// Template is local user templateif (template.startsWith(".") || template.startsWith("/")) {continue;@@ -259,17 +254,10 @@ export const prebuild = async (options: {const routesDir = join(appRoot, "routes");await rm(routesDir, { recursive: true, force: true });- await copyTemplates(options.template.includes("ssg") ? "ssg" : "defaults");-// force npm to install with not matching peer dependenciesawait writeFile(join(cwd(), ".npmrc"), "force=true");for (const template of options.template) {- // default template is already applied no need to copy twice- if (template === "vanilla" || template === "ssg") {- continue;- }-await copyTemplates(template);}diff --git a/packages/cli/templates/ssg-netlify/app/constants.mjs b/packages/cli/templates/ssg-netlify/app/constants.mjsnew file mode 100644index 0000000000..a3e96aa259--- /dev/null+++ b/packages/cli/templates/ssg-netlify/app/constants.mjs@@ -0,0 +1,33 @@+/**+ * We use mjs extension as constants in this file is shared with the build script+ * and we use `node --eval` to extract the constants.+ */+export const assetBaseUrl = "/assets/";+export const imageBaseUrl = "/assets/";++/**+ * @type {import("@webstudio-is/image").ImageLoader}+ */+export const imageLoader = (props) => {+ if (URL.canParse(props.src)) {+ return props.src;+ }++ if (process.env.NODE_ENV !== "production") {+ return imageBaseUrl + props.src;+ }++ if (props.format === "raw") {+ return imageBaseUrl + props.src;+ }++ // https://docs.netlify.com/image-cdn/overview/+ return (+ "/.netlify/images?url=" ++ encodeURIComponent(imageBaseUrl + props.src) ++ "&w=" ++ props.width ++ "&q=" ++ props.quality+ );+};diff --git a/packages/cli/templates/ssg-vercel/app/constants.mjs b/packages/cli/templates/ssg-vercel/app/constants.mjsnew file mode 100644index 0000000000..567eb673e1--- /dev/null+++ b/packages/cli/templates/ssg-vercel/app/constants.mjs@@ -0,0 +1,33 @@+/**+ * We use mjs extension as constants in this file is shared with the build script+ * and we use `node --eval` to extract the constants.+ */+export const assetBaseUrl = "/assets/";+export const imageBaseUrl = "/assets/";++/**+ * @type {import("@webstudio-is/image").ImageLoader}+ */+export const imageLoader = (props) => {+ if (URL.canParse(props.src)) {+ return props.src;+ }++ if (process.env.NODE_ENV !== "production") {+ return imageBaseUrl + props.src;+ }++ if (props.format === "raw") {+ return imageBaseUrl + props.src;+ }++ // https://vercel.com/blog/build-your-own-web-framework#automatic-image-optimization+ return (+ "/_vercel/image?url=" ++ encodeURIComponent(imageBaseUrl + props.src) ++ "&w=" ++ props.width ++ "&q=" ++ props.quality+ );+};diff --git a/packages/cli/templates/ssg-vercel/public/vercel.json b/packages/cli/templates/ssg-vercel/public/vercel.jsonnew file mode 100644index 0000000000..18097e0c38--- /dev/null+++ b/packages/cli/templates/ssg-vercel/public/vercel.json@@ -0,0 +1,11 @@+{+ "images": {+ "domains": [],+ "sizes": [+ 16, 32, 48, 64, 96, 128, 256, 384, 640, 750, 828, 1080, 1200, 1920, 2048,+ 3840+ ],+ "minimumCacheTTL": 60,+ "formats": ["image/webp", "image/avif"]+ }+}diff --git a/packages/sdk/src/schema/deployment.ts b/packages/sdk/src/schema/deployment.tsindex c8fe2d1e89..a41b1e0bcc 100644--- a/packages/sdk/src/schema/deployment.ts+++ b/packages/sdk/src/schema/deployment.ts@@ -6,6 +6,8 @@ export const Templates = z.enum(["netlify-functions","netlify-edge-functions","ssg",+ "ssg-netlify",+ "ssg-vercel",]);export type Templates = z.infer<typeof Templates>;