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: generate variables for page meta website (#2898)
Bogdan Chadkin4a6c91bf318c
diff --git a/fixtures/webstudio-custom-template/app/__generated__/[script-test]._index.tsx b/fixtures/webstudio-custom-template/app/__generated__/[script-test]._index.tsxindex 902c7dbd50..fea5380967 100644--- a/fixtures/webstudio-custom-template/app/__generated__/[script-test]._index.tsx+++ b/fixtures/webstudio-custom-template/app/__generated__/[script-test]._index.tsx@@ -38,7 +38,10 @@ export const user: { email: string | null } | undefined = {};export const projectId = "0d856812-61d8-4014-a20a-82e01c0eb8ee";-export const getPageMeta = ({}: {+export const getPageMeta = ({+ params,+ resources,+}: {params: Record<string, undefined | string>;resources: Record<string, any>;}): PageMeta => {diff --git a/fixtures/webstudio-custom-template/app/__generated__/_index.tsx b/fixtures/webstudio-custom-template/app/__generated__/_index.tsxindex 31f2aede66..f9f6fe7486 100644--- a/fixtures/webstudio-custom-template/app/__generated__/_index.tsx+++ b/fixtures/webstudio-custom-template/app/__generated__/_index.tsx@@ -38,7 +38,10 @@ export const user: { email: string | null } | undefined = {};export const projectId = "0d856812-61d8-4014-a20a-82e01c0eb8ee";-export const getPageMeta = ({}: {+export const getPageMeta = ({+ params,+ resources,+}: {params: Record<string, undefined | string>;resources: Record<string, any>;}): PageMeta => {diff --git a/fixtures/webstudio-remix-netlify-edge-functions/app/__generated__/_index.tsx b/fixtures/webstudio-remix-netlify-edge-functions/app/__generated__/_index.tsxindex 74da5fb503..992520794a 100644--- a/fixtures/webstudio-remix-netlify-edge-functions/app/__generated__/_index.tsx+++ b/fixtures/webstudio-remix-netlify-edge-functions/app/__generated__/_index.tsx@@ -22,7 +22,10 @@ export const user: { email: string | null } | undefined = {};export const projectId = "d845c167-ea07-4875-b08d-83e97c09dcce";-export const getPageMeta = ({}: {+export const getPageMeta = ({+ params,+ resources,+}: {params: Record<string, undefined | string>;resources: Record<string, any>;}): PageMeta => {diff --git a/fixtures/webstudio-remix-netlify-functions/app/__generated__/_index.tsx b/fixtures/webstudio-remix-netlify-functions/app/__generated__/_index.tsxindex 74da5fb503..992520794a 100644--- a/fixtures/webstudio-remix-netlify-functions/app/__generated__/_index.tsx+++ b/fixtures/webstudio-remix-netlify-functions/app/__generated__/_index.tsx@@ -22,7 +22,10 @@ export const user: { email: string | null } | undefined = {};export const projectId = "d845c167-ea07-4875-b08d-83e97c09dcce";-export const getPageMeta = ({}: {+export const getPageMeta = ({+ params,+ resources,+}: {params: Record<string, undefined | string>;resources: Record<string, any>;}): PageMeta => {diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/[_route_with_symbols_]._index.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/[_route_with_symbols_]._index.tsxindex f59466d3e7..1e14ba3812 100644--- a/fixtures/webstudio-remix-vercel/app/__generated__/[_route_with_symbols_]._index.tsx+++ b/fixtures/webstudio-remix-vercel/app/__generated__/[_route_with_symbols_]._index.tsx@@ -57,7 +57,10 @@ export const user: { email: string | null } | undefined = {};export const projectId = "cddc1d44-af37-4cb6-a430-d300cf6f932d";-export const getPageMeta = ({}: {+export const getPageMeta = ({+ params,+ resources,+}: {params: Record<string, undefined | string>;resources: Record<string, any>;}): PageMeta => {diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/[form]._index.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/[form]._index.tsxindex 41f54bf5bc..b3cf9cd97b 100644--- a/fixtures/webstudio-remix-vercel/app/__generated__/[form]._index.tsx+++ b/fixtures/webstudio-remix-vercel/app/__generated__/[form]._index.tsx@@ -66,7 +66,10 @@ export const user: { email: string | null } | undefined = {};export const projectId = "cddc1d44-af37-4cb6-a430-d300cf6f932d";-export const getPageMeta = ({}: {+export const getPageMeta = ({+ params,+ resources,+}: {params: Record<string, undefined | string>;resources: Record<string, any>;}): PageMeta => {diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/[heading-with-id]._index.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/[heading-with-id]._index.tsxindex 1a03b8328d..1324b27d49 100644--- a/fixtures/webstudio-remix-vercel/app/__generated__/[heading-with-id]._index.tsx+++ b/fixtures/webstudio-remix-vercel/app/__generated__/[heading-with-id]._index.tsx@@ -57,7 +57,10 @@ export const user: { email: string | null } | undefined = {};export const projectId = "cddc1d44-af37-4cb6-a430-d300cf6f932d";-export const getPageMeta = ({}: {+export const getPageMeta = ({+ params,+ resources,+}: {params: Record<string, undefined | string>;resources: Record<string, any>;}): PageMeta => {diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/[nested].[nested-page]._index.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/[nested].[nested-page]._index.tsxindex 68e543946f..1a12ce3cbe 100644--- a/fixtures/webstudio-remix-vercel/app/__generated__/[nested].[nested-page]._index.tsx+++ b/fixtures/webstudio-remix-vercel/app/__generated__/[nested].[nested-page]._index.tsx@@ -57,7 +57,10 @@ export const user: { email: string | null } | undefined = {};export const projectId = "cddc1d44-af37-4cb6-a430-d300cf6f932d";-export const getPageMeta = ({}: {+export const getPageMeta = ({+ params,+ resources,+}: {params: Record<string, undefined | string>;resources: Record<string, any>;}): PageMeta => {diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/[radix]._index.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/[radix]._index.tsxindex f055161ddb..fe871f6f47 100644--- a/fixtures/webstudio-remix-vercel/app/__generated__/[radix]._index.tsx+++ b/fixtures/webstudio-remix-vercel/app/__generated__/[radix]._index.tsx@@ -68,7 +68,10 @@ export const user: { email: string | null } | undefined = {};export const projectId = "cddc1d44-af37-4cb6-a430-d300cf6f932d";-export const getPageMeta = ({}: {+export const getPageMeta = ({+ params,+ resources,+}: {params: Record<string, undefined | string>;resources: Record<string, any>;}): PageMeta => {diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/[resources]._index.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/[resources]._index.tsxindex dcbbe453ba..83945e3d46 100644--- a/fixtures/webstudio-remix-vercel/app/__generated__/[resources]._index.tsx+++ b/fixtures/webstudio-remix-vercel/app/__generated__/[resources]._index.tsx@@ -60,7 +60,10 @@ export const user: { email: string | null } | undefined = {};export const projectId = "cddc1d44-af37-4cb6-a430-d300cf6f932d";-export const getPageMeta = ({}: {+export const getPageMeta = ({+ params,+ resources,+}: {params: Record<string, undefined | string>;resources: Record<string, any>;}): PageMeta => {diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsxindex f7eb7bdc32..0e4c10b980 100644--- a/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsx+++ b/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsx@@ -66,7 +66,10 @@ export const user: { email: string | null } | undefined = {};export const projectId = "cddc1d44-af37-4cb6-a430-d300cf6f932d";-export const getPageMeta = ({}: {+export const getPageMeta = ({+ params,+ resources,+}: {params: Record<string, undefined | string>;resources: Record<string, any>;}): PageMeta => {diff --git a/packages/cli/src/prebuild.ts b/packages/cli/src/prebuild.tsindex 645bc0ccf5..1f1c290484 100644--- a/packages/cli/src/prebuild.ts+++ b/packages/cli/src/prebuild.ts@@ -564,7 +564,7 @@ export const user: { email: string | null } | undefined = ${JSON.stringify()};export const projectId = "${siteData.build.projectId}";-${generatePageMeta({ scope, page: pageData.page, dataSources })}+${generatePageMeta({ globalScope: scope, page: pageData.page, dataSources })}${pageComponent}diff --git a/packages/react-sdk/src/expression.ts b/packages/react-sdk/src/expression.tsindex cf94b2a523..816151553b 100644--- a/packages/react-sdk/src/expression.ts+++ b/packages/react-sdk/src/expression.ts@@ -188,10 +188,12 @@ export const decodeDataSourceVariable = (name: string) => {export const generateExpression = ({expression,dataSources,+ usedDataSources,scope,}: {expression: string;dataSources: DataSources;+ usedDataSources?: DataSources;scope: Scope;}) => {return validateExpression(expression, {@@ -203,6 +205,7 @@ export const generateExpression = ({const depId = decodeDataSourceVariable(identifier);const dep = depId ? dataSources.get(depId) : undefined;if (dep) {+ usedDataSources?.set(dep.id, dep);return scope.getName(dep.id, dep.name);}return identifier;diff --git a/packages/react-sdk/src/page-meta-generator.test.ts b/packages/react-sdk/src/page-meta-generator.test.tsindex 59759c4bec..b217cba385 100644--- a/packages/react-sdk/src/page-meta-generator.test.ts+++ b/packages/react-sdk/src/page-meta-generator.test.ts@@ -1,11 +1,14 @@import { expect, test } from "@jest/globals";-import { generatePageMeta } from "./page-meta-generator";import { createScope } from "@webstudio-is/sdk";+import { generatePageMeta } from "./page-meta-generator";++const toMap = <T extends { id: string }>(list: T[]) =>+ new Map(list.map((item) => [item.id, item] as const));test("generate minimal static page meta factory", () => {expect(generatePageMeta({- scope: createScope(),+ globalScope: createScope(),page: {id: "",name: "",@@ -17,7 +20,10 @@ test("generate minimal static page meta factory", () => {dataSources: new Map(),})).toMatchInlineSnapshot(`-"export const getPageMeta = ({}: {+"export const getPageMeta = ({+ params,+ resources,+}: {params: Record<string, undefined | string>;resources: Record<string, any>;}): PageMeta => {@@ -38,7 +44,7 @@ test("generate minimal static page meta factory", () => {test("generate complete static page meta factory", () => {expect(generatePageMeta({- scope: createScope(),+ globalScope: createScope(),page: {id: "",name: "",@@ -58,7 +64,10 @@ test("generate complete static page meta factory", () => {dataSources: new Map(),})).toMatchInlineSnapshot(`-"export const getPageMeta = ({}: {+"export const getPageMeta = ({+ params,+ resources,+}: {params: Record<string, undefined | string>;resources: Record<string, any>;}): PageMeta => {@@ -87,7 +96,7 @@ test("generate complete static page meta factory", () => {test("generate asset url instead of id", () => {expect(generatePageMeta({- scope: createScope(),+ globalScope: createScope(),page: {id: "",name: "",@@ -101,7 +110,10 @@ test("generate asset url instead of id", () => {dataSources: new Map(),})).toMatchInlineSnapshot(`-"export const getPageMeta = ({}: {+"export const getPageMeta = ({+ params,+ resources,+}: {params: Record<string, undefined | string>;resources: Record<string, any>;}): PageMeta => {@@ -122,7 +134,7 @@ test("generate asset url instead of id", () => {test("generate custom meta ignoring empty property name", () => {expect(generatePageMeta({- scope: createScope(),+ globalScope: createScope(),page: {id: "",name: "",@@ -139,7 +151,10 @@ test("generate custom meta ignoring empty property name", () => {dataSources: new Map(),})).toMatchInlineSnapshot(`-"export const getPageMeta = ({}: {+"export const getPageMeta = ({+ params,+ resources,+}: {params: Record<string, undefined | string>;resources: Record<string, any>;}): PageMeta => {@@ -160,3 +175,204 @@ test("generate custom meta ignoring empty property name", () => {"`);});++test("generate page meta factory with variables", () => {+ expect(+ generatePageMeta({+ globalScope: createScope(),+ page: {+ id: "",+ name: "",+ path: "",+ rootInstanceId: "",+ title: `$ws$dataSource$variableId`,+ meta: {},+ },+ dataSources: toMap([+ {+ id: "variableId",+ scopeInstanceId: "body",+ name: "Variable Name",+ type: "variable",+ value: { type: "string", value: "" },+ },+ ]),+ })+ ).toMatchInlineSnapshot(`+"export const getPageMeta = ({+ params,+ resources,+}: {+ params: Record<string, undefined | string>;+ resources: Record<string, any>;+}): PageMeta => {+ let VariableName = ""+ return {+ title: VariableName,+ description: undefined,+ excludePageFromSearch: undefined,+ socialImageAssetId: undefined,+ socialImageUrl: undefined,+ custom: [+ ],+ };+};+"+`);+});++test("generate page meta factory with path params", () => {+ expect(+ generatePageMeta({+ globalScope: createScope(),+ page: {+ id: "",+ name: "",+ path: "",+ rootInstanceId: "",+ title: `$ws$dataSource$pathParamsId.slug`,+ meta: {},+ pathVariableId: "pathParamsId",+ },+ dataSources: toMap([+ {+ id: "pathParamsId",+ scopeInstanceId: "body",+ name: "Path Params",+ type: "parameter",+ },+ ]),+ })+ ).toMatchInlineSnapshot(`+"export const getPageMeta = ({+ params,+ resources,+}: {+ params: Record<string, undefined | string>;+ resources: Record<string, any>;+}): PageMeta => {+ let PathParams = params+ return {+ title: PathParams?.slug,+ description: undefined,+ excludePageFromSearch: undefined,+ socialImageAssetId: undefined,+ socialImageUrl: undefined,+ custom: [+ ],+ };+};+"+`);+});++test("generate page meta factory with resources", () => {+ expect(+ generatePageMeta({+ globalScope: createScope(),+ page: {+ id: "",+ name: "",+ path: "",+ rootInstanceId: "",+ title: `$ws$dataSource$resourceVariableId.data.title`,+ meta: {},+ },+ dataSources: toMap([+ {+ id: "resourceVariableId",+ scopeInstanceId: "body",+ name: "Cms Page",+ type: "resource",+ resourceId: "resourceId",+ },+ ]),+ })+ ).toMatchInlineSnapshot(`+"export const getPageMeta = ({+ params,+ resources,+}: {+ params: Record<string, undefined | string>;+ resources: Record<string, any>;+}): PageMeta => {+ let CmsPage = resources.CmsPage+ return {+ title: CmsPage?.data?.title,+ description: undefined,+ excludePageFromSearch: undefined,+ socialImageAssetId: undefined,+ socialImageUrl: undefined,+ custom: [+ ],+ };+};+"+`);+});++test("generate page meta factory without unused variables", () => {+ expect(+ generatePageMeta({+ globalScope: createScope(),+ page: {+ id: "",+ name: "",+ path: "",+ rootInstanceId: "",+ pathVariableId: "unusedPathParamsId",+ title: `$ws$dataSource$usedVariableId`,+ meta: {},+ },+ dataSources: toMap([+ {+ id: "usedVariableId",+ scopeInstanceId: "body",+ name: "Used Name",+ type: "variable",+ value: { type: "string", value: "" },+ },+ {+ id: "unusedVariableId",+ scopeInstanceId: "body",+ name: "Unused Name",+ type: "variable",+ value: { type: "string", value: "" },+ },+ {+ id: "unusedPathParamsId",+ scopeInstanceId: "body",+ name: "Unused Path Params",+ type: "parameter",+ },+ {+ id: "unusedResourceVariableId",+ scopeInstanceId: "body",+ name: "Unused Cms Page",+ type: "resource",+ resourceId: "resourceId",+ },+ ]),+ })+ ).toMatchInlineSnapshot(`+"export const getPageMeta = ({+ params,+ resources,+}: {+ params: Record<string, undefined | string>;+ resources: Record<string, any>;+}): PageMeta => {+ let UsedName = ""+ return {+ title: UsedName,+ description: undefined,+ excludePageFromSearch: undefined,+ socialImageAssetId: undefined,+ socialImageUrl: undefined,+ custom: [+ ],+ };+};+"+`);+});diff --git a/packages/react-sdk/src/page-meta-generator.ts b/packages/react-sdk/src/page-meta-generator.tsindex bcd3d7f045..1a418d9434 100644--- a/packages/react-sdk/src/page-meta-generator.ts+++ b/packages/react-sdk/src/page-meta-generator.ts@@ -1,4 +1,10 @@-import type { Asset, DataSources, Page, Scope } from "@webstudio-is/sdk";+import {+ createScope,+ type Asset,+ type DataSources,+ type Page,+ type Scope,+} from "@webstudio-is/sdk";import { generateExpression } from "./expression";export type PageMeta = {@@ -11,28 +17,34 @@ export type PageMeta = {};export const generatePageMeta = ({- scope,+ globalScope,page,dataSources,}: {- scope: Scope;+ globalScope: Scope;page: Page;dataSources: DataSources;}) => {+ // reserve parameter names passed to generated function+ const localScope = createScope(["params", "resources"]);+ const usedDataSources: DataSources = new Map();const titleExpression = generateExpression({expression: page.title,dataSources,- scope,+ usedDataSources,+ scope: localScope,});const descriptionExpression = generateExpression({expression: page.meta.description ?? "undefined",dataSources,- scope,+ usedDataSources,+ scope: localScope,});const excludePageFromSearchExpression = generateExpression({expression: page.meta.excludePageFromSearch ?? "undefined",dataSources,- scope,+ usedDataSources,+ scope: localScope,});const socialImageAssetIdExpression = JSON.stringify(page.meta.socialImageAssetId@@ -40,38 +52,68 @@ export const generatePageMeta = ({const socialImageUrlExpression = generateExpression({expression: page.meta.socialImageUrl ?? "undefined",dataSources,- scope,+ usedDataSources,+ scope: localScope,});+ let customExpression = "";+ customExpression += `[\n`;+ for (const customMeta of page.meta.custom ?? []) {+ if (customMeta.property.trim().length === 0) {+ continue;+ }+ const propertyExpression = JSON.stringify(customMeta.property);+ const contentExpression = generateExpression({+ expression: customMeta.content,+ dataSources,+ usedDataSources,+ scope: localScope,+ });+ customExpression += ` {\n`;+ customExpression += ` property: ${propertyExpression},\n`;+ customExpression += ` content: ${contentExpression},\n`;+ customExpression += ` },\n`;+ }+ customExpression += ` ]`;let generated = "";- generated += `export const getPageMeta = ({}: {\n`;+ generated += `export const getPageMeta = ({\n`;+ generated += ` params,\n`;+ generated += ` resources,\n`;+ generated += `}: {\n`;generated += ` params: Record<string, undefined | string>;\n`;generated += ` resources: Record<string, any>;\n`;generated += `}): PageMeta => {\n`;+ for (const dataSource of usedDataSources.values()) {+ if (dataSource.type === "variable") {+ const valueName = localScope.getName(dataSource.id, dataSource.name);+ const initialValueString = JSON.stringify(dataSource.value.value);+ generated += ` let ${valueName} = ${initialValueString}\n`;+ continue;+ }+ if (dataSource.type === "parameter") {+ if (dataSource.id === page.pathVariableId) {+ const valueName = localScope.getName(dataSource.id, dataSource.name);+ generated += ` let ${valueName} = params\n`;+ }+ continue;+ }+ if (dataSource.type === "resource") {+ const valueName = localScope.getName(dataSource.id, dataSource.name);+ // use global scope only to retrieve resource names+ const resourceName = globalScope.getName(+ dataSource.resourceId,+ dataSource.name+ );+ generated += ` let ${valueName} = resources.${resourceName}\n`;+ continue;+ }+ }generated += ` return {\n`;generated += ` title: ${titleExpression},\n`;generated += ` description: ${descriptionExpression},\n`;generated += ` excludePageFromSearch: ${excludePageFromSearchExpression},\n`;generated += ` socialImageAssetId: ${socialImageAssetIdExpression},\n`;generated += ` socialImageUrl: ${socialImageUrlExpression},\n`;- generated += ` custom: [\n`;- if (page.meta.custom) {- for (const customMeta of page.meta.custom) {- if (customMeta.property.trim().length === 0) {- continue;- }- const propertyExpression = JSON.stringify(customMeta.property);- const contentExpression = generateExpression({- scope,- dataSources,- expression: customMeta.content,- });- generated += ` {\n`;- generated += ` property: ${propertyExpression},\n`;- generated += ` content: ${contentExpression},\n`;- generated += ` },\n`;- }- }- generated += ` ],\n`;+ generated += ` custom: ${customExpression},\n`;generated += ` };\n`;generated += `};\n`;return generated;