Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.
TypeScript accessibilityalternativecloudflarecloudflare-workersdesignfreefrontendopen-sourceradix-uireactremixweb-developmentwebflowwebsite-builderwebsite-developmentwebsiteswebstudio
refactor: simplify placeholders in CLI templates (#3663)
Bogdan Chadkin3ba82579bc12
diff --git a/fixtures/webstudio-cloudflare-template/tsconfig.json b/fixtures/webstudio-cloudflare-template/tsconfig.jsonindex 3ec9051136..a87a7c9a55 100644--- a/fixtures/webstudio-cloudflare-template/tsconfig.json+++ b/fixtures/webstudio-cloudflare-template/tsconfig.json@@ -12,7 +12,8 @@"types": ["@remix-run/cloudflare","vite/client",- "@cloudflare/workers-types/2023-07-01"+ "@cloudflare/workers-types/2023-07-01",+ "@webstudio-is/react-sdk/placeholder"],"isolatedModules": true,"esModuleInterop": true,diff --git a/fixtures/webstudio-custom-template/app/routes/[sitemap.xml]._index.tsx b/fixtures/webstudio-custom-template/app/routes/[sitemap.xml]._index.tsxindex 6a0ca519fa..007a29b4c3 100644--- a/fixtures/webstudio-custom-template/app/routes/[sitemap.xml]._index.tsx+++ b/fixtures/webstudio-custom-template/app/routes/[sitemap.xml]._index.tsx@@ -7,7 +7,6 @@ import {getPageMeta,getRemixParams,} from "../__generated__/[sitemap.xml]._index.server";-import { assetBaseUrl, imageBaseUrl, imageLoader } from "../constants.mjs";import { renderToString } from "react-dom/server";diff --git a/fixtures/webstudio-custom-template/tsconfig.json b/fixtures/webstudio-custom-template/tsconfig.jsonindex f99a0e1462..cf25de4181 100644--- a/fixtures/webstudio-custom-template/tsconfig.json+++ b/fixtures/webstudio-custom-template/tsconfig.json@@ -2,7 +2,11 @@"include": ["**/*.ts", "**/*.tsx", "**/*.mjs"],"compilerOptions": {"lib": ["DOM", "DOM.Iterable", "ES2023"],- "types": ["@remix-run/node", "vite/client"],+ "types": [+ "@remix-run/node",+ "vite/client",+ "@webstudio-is/react-sdk/placeholder"+ ],"isolatedModules": true,"esModuleInterop": true,"jsx": "react-jsx",diff --git a/fixtures/webstudio-remix-netlify-edge-functions/tsconfig.json b/fixtures/webstudio-remix-netlify-edge-functions/tsconfig.jsonindex f99a0e1462..cf25de4181 100644--- a/fixtures/webstudio-remix-netlify-edge-functions/tsconfig.json+++ b/fixtures/webstudio-remix-netlify-edge-functions/tsconfig.json@@ -2,7 +2,11 @@"include": ["**/*.ts", "**/*.tsx", "**/*.mjs"],"compilerOptions": {"lib": ["DOM", "DOM.Iterable", "ES2023"],- "types": ["@remix-run/node", "vite/client"],+ "types": [+ "@remix-run/node",+ "vite/client",+ "@webstudio-is/react-sdk/placeholder"+ ],"isolatedModules": true,"esModuleInterop": true,"jsx": "react-jsx",diff --git a/fixtures/webstudio-remix-netlify-functions/tsconfig.json b/fixtures/webstudio-remix-netlify-functions/tsconfig.jsonindex f99a0e1462..cf25de4181 100644--- a/fixtures/webstudio-remix-netlify-functions/tsconfig.json+++ b/fixtures/webstudio-remix-netlify-functions/tsconfig.json@@ -2,7 +2,11 @@"include": ["**/*.ts", "**/*.tsx", "**/*.mjs"],"compilerOptions": {"lib": ["DOM", "DOM.Iterable", "ES2023"],- "types": ["@remix-run/node", "vite/client"],+ "types": [+ "@remix-run/node",+ "vite/client",+ "@webstudio-is/react-sdk/placeholder"+ ],"isolatedModules": true,"esModuleInterop": true,"jsx": "react-jsx",diff --git a/fixtures/webstudio-remix-vercel/tsconfig.json b/fixtures/webstudio-remix-vercel/tsconfig.jsonindex f99a0e1462..cf25de4181 100644--- a/fixtures/webstudio-remix-vercel/tsconfig.json+++ b/fixtures/webstudio-remix-vercel/tsconfig.json@@ -2,7 +2,11 @@"include": ["**/*.ts", "**/*.tsx", "**/*.mjs"],"compilerOptions": {"lib": ["DOM", "DOM.Iterable", "ES2023"],- "types": ["@remix-run/node", "vite/client"],+ "types": [+ "@remix-run/node",+ "vite/client",+ "@webstudio-is/react-sdk/placeholder"+ ],"isolatedModules": true,"esModuleInterop": true,"jsx": "react-jsx",diff --git a/packages/cli/__generated__/$resources.sitemap.xml.ts b/packages/cli/__generated__/$resources.sitemap.xml.tsdeleted file mode 100644index 065429c573..0000000000--- a/packages/cli/__generated__/$resources.sitemap.xml.ts+++ /dev/null@@ -1,9 +0,0 @@-/**- * The only intent of this file is to support typings inside ../routes/[sitemap.xml].tsx for easier development.- **/-export const sitemap = [- {- path: "",- lastModified: "2021-10-13T12:00:00.000Z",- },-];diff --git a/packages/cli/__generated__/_index.server.tsx b/packages/cli/__generated__/_index.server.tsxdeleted file mode 100644index e936eb850e..0000000000--- a/packages/cli/__generated__/_index.server.tsx+++ /dev/null@@ -1,33 +0,0 @@-/**- * The only intent of this file is to support typings inside ../templates/route-template for easier development.- **/-import type { PageMeta, System } from "@webstudio-is/sdk";--export const loadResources = async (_props: { system: System }) => {- const [] = await Promise.all([]);- return {} as Record<string, unknown>;-};--export const getPageMeta = ({}: {- system: System;- resources: Record<string, any>;-}): PageMeta => {- return {- title: "Page title",- custom: [],- };-};--export const formsProperties = new Map<- string,- { method?: string; action?: string }->([]);--type Params = Record<string, string | undefined>;-export const getRemixParams = ({ ...params }: Params): Params => {- return params;-};--export const projectId = "project-id";--export const contactEmail: undefined | string = undefined;diff --git a/packages/cli/__generated__/_index.tsx b/packages/cli/__generated__/_index.tsxdeleted file mode 100644index 89b0db3083..0000000000--- a/packages/cli/__generated__/_index.tsx+++ /dev/null@@ -1,24 +0,0 @@-/**- * The only intent of this file is to support typings inside ../templates/route-template for easier development.- **/--import type { FontAsset, ImageAsset } from "@webstudio-is/sdk";--export const siteName = "";--export const favIconAsset: ImageAsset | undefined = undefined;--export const socialImageAsset: ImageAsset | undefined = undefined;--// Font assets on current page (can be preloaded)-export const pageFontAssets: FontAsset[] = [];--export const pageBackgroundImageAssets: ImageAsset[] = [];--export const CustomCode = () => null;--const Page = (_props: { system: any }) => {- return <></>;-};--export { Page };diff --git a/packages/cli/src/prebuild.ts b/packages/cli/src/prebuild.tsindex 4f6fd4c00c..f44bd3eee7 100644--- a/packages/cli/src/prebuild.ts+++ b/packages/cli/src/prebuild.ts@@ -635,8 +635,6 @@ export const prebuild = async (options: {const socialImageAsset = assets.get(pageMeta.socialImageAssetId ?? "");const pagePath = getPagePath(pageData.page.id, siteData.build.pages);- const remixRoute = generateRemixRoute(pagePath);- const fileName = `${remixRoute}.tsx`;// MARK: - TODO: XML GENERATIONconst pageExports = `/* eslint-disable */@@ -663,7 +661,7 @@ export const prebuild = async (options: {${JSON.stringify(pageBackgroundImageAssets)}${- remixRoute === "_index"+ pagePath === "/"? `${projectMeta?.code@@ -726,32 +724,38 @@ export const prebuild = async (options: {export const contactEmail = ${JSON.stringify(contactEmail)};`;+ const generatedBasename = generateRemixRoute(pagePath);+const routeFileContent = (documentType === "html" ? routeFileTemplate : routeXmlFileTemplate)- .replace(- /".*\/__generated__\/_index"/,- `"../__generated__/${remixRoute}"`- )- .replace(- /".*\/__generated__\/_index.server"/,- `"../__generated__/${remixRoute}.server"`- );+ .replaceAll("__CLIENT__", `../__generated__/${generatedBasename}`)+ .replaceAll("__SERVER__", `../__generated__/${generatedBasename}.server`)+ .replaceAll("__CSS__", `../__generated__/index.css`);- await createFileIfNotExists(join(routesDir, fileName), routeFileContent);+ await createFileIfNotExists(+ join(routesDir, `${generateRemixRoute(pagePath)}.tsx`),+ routeFileContent+ );- await createFileIfNotExists(join(generatedDir, fileName), pageExports);+ await createFileIfNotExists(+ join(generatedDir, `${generatedBasename}.tsx`),+ pageExports+ );await createFileIfNotExists(- join(generatedDir, `${remixRoute}.server.tsx`),+ join(generatedDir, `${generatedBasename}.server.tsx`),serverExports);}// MARK: - Default sitemap.xmlawait createFileIfNotExists(- join(routesDir, "[sitemap.xml]._index.tsx"),- defaultSiteMapTemplate.replace(/".*\/__generated__\//, `"../__generated__/`)+ join(routesDir, `${generateRemixRoute("/sitemap.xml")}.tsx`),+ defaultSiteMapTemplate.replaceAll(+ "__SITEMAP__",+ `../__generated__/$resources.sitemap.xml`+ ));await createFileIfNotExists(diff --git a/packages/cli/templates/cloudflare/tsconfig.json b/packages/cli/templates/cloudflare/tsconfig.jsonindex 32a71c1efa..c9f03092bb 100644--- a/packages/cli/templates/cloudflare/tsconfig.json+++ b/packages/cli/templates/cloudflare/tsconfig.json@@ -12,7 +12,8 @@"types": ["@remix-run/cloudflare","vite/client",- "@cloudflare/workers-types/2023-07-01"+ "@cloudflare/workers-types/2023-07-01",+ "@webstudio-is/react-sdk/placeholder"],"isolatedModules": true,"esModuleInterop": true,diff --git a/packages/cli/templates/defaults/app/route-templates/default-sitemap.tsx b/packages/cli/templates/defaults/app/route-templates/default-sitemap.tsxindex b3e25011ab..1e828b47ba 100644--- a/packages/cli/templates/defaults/app/route-templates/default-sitemap.tsx+++ b/packages/cli/templates/defaults/app/route-templates/default-sitemap.tsx@@ -1,5 +1,5 @@import type { LoaderFunctionArgs } from "@remix-run/server-runtime";-import { sitemap } from "../../../../__generated__/$resources.sitemap.xml";+import { sitemap } from "__SITEMAP__";export const loader = (arg: LoaderFunctionArgs) => {const host =diff --git a/packages/cli/templates/defaults/app/route-templates/html.tsx b/packages/cli/templates/defaults/app/route-templates/html.tsxindex a57261ff91..777c98316b 100644--- a/packages/cli/templates/defaults/app/route-templates/html.tsx+++ b/packages/cli/templates/defaults/app/route-templates/html.tsx@@ -23,7 +23,7 @@ import {socialImageAsset,pageFontAssets,pageBackgroundImageAssets,-} from "../../../../__generated__/_index";+} from "__CLIENT__";import {formsProperties,loadResources,@@ -31,9 +31,9 @@ import {getRemixParams,projectId,contactEmail,-} from "../../../../__generated__/_index.server";+} from "__SERVER__";-import css from "../__generated__/index.css?url";+import css from "__CSS__?url";import { assetBaseUrl, imageBaseUrl, imageLoader } from "../constants.mjs";export const loader = async (arg: LoaderFunctionArgs) => {diff --git a/packages/cli/templates/defaults/app/route-templates/xml.tsx b/packages/cli/templates/defaults/app/route-templates/xml.tsxindex 1454fcac28..9be86c2dd6 100644--- a/packages/cli/templates/defaults/app/route-templates/xml.tsx+++ b/packages/cli/templates/defaults/app/route-templates/xml.tsx@@ -1,13 +1,8 @@/* eslint-disable camelcase */import { type LoaderFunctionArgs, redirect } from "@remix-run/server-runtime";import { ReactSdkContext } from "@webstudio-is/react-sdk";-import { Page } from "../../../../__generated__/_index";-import {- loadResources,- getPageMeta,- getRemixParams,-} from "../../../../__generated__/_index.server";-+import { Page } from "__CLIENT__";+import { loadResources, getPageMeta, getRemixParams } from "__SERVER__";import { assetBaseUrl, imageBaseUrl, imageLoader } from "../constants.mjs";import { renderToString } from "react-dom/server";diff --git a/packages/cli/templates/defaults/tsconfig.json b/packages/cli/templates/defaults/tsconfig.jsonindex c15d3bfc17..484c8fe946 100644--- a/packages/cli/templates/defaults/tsconfig.json+++ b/packages/cli/templates/defaults/tsconfig.json@@ -2,7 +2,11 @@"include": ["**/*.ts", "**/*.tsx", "**/*.mjs"],"compilerOptions": {"lib": ["DOM", "DOM.Iterable", "ESNext"],- "types": ["@remix-run/node", "vite/client"],+ "types": [+ "@remix-run/node",+ "vite/client",+ "@webstudio-is/react-sdk/placeholder"+ ],"isolatedModules": true,"esModuleInterop": true,"jsx": "react-jsx",diff --git a/packages/cli/templates/internal/tsconfig.json b/packages/cli/templates/internal/tsconfig.jsonindex f99a0e1462..cf25de4181 100644--- a/packages/cli/templates/internal/tsconfig.json+++ b/packages/cli/templates/internal/tsconfig.json@@ -2,7 +2,11 @@"include": ["**/*.ts", "**/*.tsx", "**/*.mjs"],"compilerOptions": {"lib": ["DOM", "DOM.Iterable", "ES2023"],- "types": ["@remix-run/node", "vite/client"],+ "types": [+ "@remix-run/node",+ "vite/client",+ "@webstudio-is/react-sdk/placeholder"+ ],"isolatedModules": true,"esModuleInterop": true,"jsx": "react-jsx",diff --git a/packages/cli/templates/saas-helpers/tsconfig.json b/packages/cli/templates/saas-helpers/tsconfig.jsonindex 3ec9051136..a87a7c9a55 100644--- a/packages/cli/templates/saas-helpers/tsconfig.json+++ b/packages/cli/templates/saas-helpers/tsconfig.json@@ -12,7 +12,8 @@"types": ["@remix-run/cloudflare","vite/client",- "@cloudflare/workers-types/2023-07-01"+ "@cloudflare/workers-types/2023-07-01",+ "@webstudio-is/react-sdk/placeholder"],"isolatedModules": true,"esModuleInterop": true,diff --git a/packages/cli/tsconfig.json b/packages/cli/tsconfig.jsonindex 1c1b7838e1..91594499a3 100644--- a/packages/cli/tsconfig.json+++ b/packages/cli/tsconfig.json@@ -3,7 +3,7 @@"include": ["**/*.ts", "**/*.tsx", "**/*.mjs"],"compilerOptions": {"lib": ["DOM", "DOM.Iterable", "ESNext"],- "types": ["vite/client"],+ "types": ["vite/client", "@webstudio-is/react-sdk/placeholder"],"module": "esnext","allowJs": true,"checkJs": truediff --git a/packages/react-sdk/package.json b/packages/react-sdk/package.jsonindex de5e83ef2f..af1bfebcad 100644--- a/packages/react-sdk/package.json+++ b/packages/react-sdk/package.json@@ -50,10 +50,14 @@"webstudio": "./src/css/normalize.ts","types": "./lib/types/css/normalize.d.ts","import": "./lib/css/normalize.js"+ },+ "./placeholder": {+ "types": "./placeholder.d.ts"}},"files": ["lib/*",+ "./placeholder.d.ts","!*.{test,stories}.*"],"license": "AGPL-3.0-or-later",diff --git a/packages/react-sdk/placeholder.d.ts b/packages/react-sdk/placeholder.d.tsnew file mode 100644index 0000000000..e1a331c100--- /dev/null+++ b/packages/react-sdk/placeholder.d.ts@@ -0,0 +1,50 @@+declare module "__CLIENT__" {+ import type { FontAsset, ImageAsset, System } from "@webstudio-is/sdk";++ export const siteName: string;++ export const favIconAsset: ImageAsset | undefined;++ export const socialImageAsset: ImageAsset | undefined;++ // Font assets on current page (can be preloaded)+ export const pageFontAssets: FontAsset[];++ export const pageBackgroundImageAssets: ImageAsset[];++ export const CustomCode: () => ReactNode;++ export const Page: (props: { system: System }) => ReactNode;+}++declare module "__SERVER__" {+ import type { PageMeta, System } from "@webstudio-is/sdk";++ export const loadResources: (props: {+ system: System;+ }) => Promise<Record<string, unknown>>;++ export const getPageMeta: (props: {+ system: System;+ resources: Record<string, any>;+ }) => PageMeta;++ export const formsProperties: Map<+ string,+ { method?: string; action?: string }+ >;++ type Params = Record<string, string | undefined>;+ export const getRemixParams: ({ ...params }: Params) => Params;++ export const projectId: string;++ export const contactEmail: undefined | string;+}++declare module "__SITEMAP__" {+ export const sitemap: Array<{+ path: string;+ lastModified: string;+ }>;+}