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.

refactor: rename page.pathVariableId to pathParamsDataSourceId (#2915)

Bogdan Chadkinbe2b5ce31a0a
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx
index bf7bba629d..211e685710 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx
@@ -1174,10 +1174,13 @@ const updatePage = (
// create "Path Params" variable when pattern is specified in path
const paramNames = parsePathnamePattern(page.path);
- if (paramNames.length > 0 && page.pathVariableId === undefined) {
- page.pathVariableId = nanoid();
- dataSources.set(page.pathVariableId, {
- id: page.pathVariableId,
+ if (
+ paramNames.length > 0 &&
+ page.pathParamsDataSourceId === undefined
+ ) {
+ page.pathParamsDataSourceId = nanoid();
+ dataSources.set(page.pathParamsDataSourceId, {
+ id: page.pathParamsDataSourceId,
// scope new variable to page root
scopeInstanceId: page.rootInstanceId,
type: "parameter",
@@ -1231,7 +1234,7 @@ export const PageSettings = ({
.filter(Boolean)
.join("/")
.replace(/\/+/g, "/"),
- dataSourceId: page?.pathVariableId,
+ dataSourceId: page?.pathParamsDataSourceId,
});
const debouncedFn = useEffectEvent(() => {
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.test.ts b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.test.ts
index 1c45685b78..5a56e2d9db 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.test.ts
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.test.ts
@@ -673,7 +673,7 @@ describe("duplicate page", () => {
title: `"My Title"`,
meta: {},
rootInstanceId: "body",
- pathVariableId: "pathParamsId",
+ pathParamsDataSourceId: "pathParamsId",
},
pages: [],
folders: [],
@@ -688,7 +688,7 @@ describe("duplicate page", () => {
title: `"My Title"`,
meta: {},
rootInstanceId: expect.not.stringMatching("body"),
- pathVariableId: newDataSource.id,
+ pathParamsDataSourceId: newDataSource.id,
});
});
});
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.ts b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.ts
index 195cc6bdcd..331673c2b5 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.ts
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.ts
@@ -385,10 +385,10 @@ export const duplicatePage = (pageId: Page["id"]) => {
availableDataSources: new Set(),
});
const newRootInstanceId = newInstanceIds.get(page.rootInstanceId);
- const newPathVariableId =
- page.pathVariableId === undefined
+ const newPathParamsDataSourceId =
+ page.pathParamsDataSourceId === undefined
? undefined
- : newDataSourceIds.get(page.pathVariableId);
+ : newDataSourceIds.get(page.pathParamsDataSourceId);
if (newRootInstanceId === undefined) {
return;
}
@@ -396,7 +396,7 @@ export const duplicatePage = (pageId: Page["id"]) => {
...page,
id: newPageId,
rootInstanceId: newRootInstanceId,
- pathVariableId: newPathVariableId,
+ pathParamsDataSourceId: newPathParamsDataSourceId,
name: newName,
path: deduplicatePath(pages, page.path),
title: replaceDataSources(page.title, newDataSourceIds),
diff --git a/packages/cli/src/prebuild.ts b/packages/cli/src/prebuild.ts
index 1dc372d446..1dc33e37c1 100644
--- a/packages/cli/src/prebuild.ts
+++ b/packages/cli/src/prebuild.ts
@@ -516,11 +516,12 @@ export const prebuild = async (options: {
});
// generate new Page Params variable if does not exist
// to allow always passing it from route template
- const pathVariableId = pageData.page.pathVariableId ?? "pathVariableId";
- if (pageData.page.pathVariableId === undefined) {
- dataSources.set(pathVariableId, {
- id: pathVariableId,
- name: "Page Params",
+ const pathParamsDataSourceId =
+ pageData.page.pathParamsDataSourceId ?? "pathParamsDataSourceId";
+ if (pageData.page.pathParamsDataSourceId === undefined) {
+ dataSources.set(pathParamsDataSourceId, {
+ id: pathParamsDataSourceId,
+ name: "Path Params",
type: "parameter",
});
}
@@ -534,7 +535,7 @@ export const prebuild = async (options: {
instanceId: "",
name: "params",
type: "parameter",
- value: pathVariableId,
+ value: pathParamsDataSourceId,
},
],
instances,
diff --git a/packages/react-sdk/src/page-meta-generator.test.ts b/packages/react-sdk/src/page-meta-generator.test.ts
index 6b2931e971..dccf204bc0 100644
--- a/packages/react-sdk/src/page-meta-generator.test.ts
+++ b/packages/react-sdk/src/page-meta-generator.test.ts
@@ -244,7 +244,7 @@ test("generate page meta factory with path params", () => {
rootInstanceId: "",
title: `$ws$dataSource$pathParamsId.slug`,
meta: {},
- pathVariableId: "pathParamsId",
+ pathParamsDataSourceId: "pathParamsId",
},
dataSources: toMap([
{
@@ -336,7 +336,7 @@ test("generate page meta factory without unused variables", () => {
name: "",
path: "",
rootInstanceId: "",
- pathVariableId: "unusedPathParamsId",
+ pathParamsDataSourceId: "unusedPathParamsId",
title: `$ws$dataSource$usedVariableId`,
meta: {},
},
diff --git a/packages/react-sdk/src/page-meta-generator.ts b/packages/react-sdk/src/page-meta-generator.ts
index 3efdeb5215..bd290b33db 100644
--- a/packages/react-sdk/src/page-meta-generator.ts
+++ b/packages/react-sdk/src/page-meta-generator.ts
@@ -104,7 +104,7 @@ export const generatePageMeta = ({
continue;
}
if (dataSource.type === "parameter") {
- if (dataSource.id === page.pathVariableId) {
+ if (dataSource.id === page.pathParamsDataSourceId) {
const valueName = localScope.getName(dataSource.id, dataSource.name);
generated += ` let ${valueName} = params\n`;
}
diff --git a/packages/react-sdk/src/resources-generator.test.ts b/packages/react-sdk/src/resources-generator.test.ts
index bddbe4dba3..d7b99b1f28 100644
--- a/packages/react-sdk/src/resources-generator.test.ts
+++ b/packages/react-sdk/src/resources-generator.test.ts
@@ -67,7 +67,7 @@ test("generate variable and use in resources loader", () => {
scope: createScope(),
page: {
rootInstanceId: "body",
- pathVariableId: "variableParamsId",
+ pathParamsDataSourceId: "variableParamsId",
} as Page,
dataSources: toMap([
{
@@ -135,7 +135,7 @@ test("generate page params variable and use in resources loader", () => {
scope: createScope(),
page: {
rootInstanceId: "body",
- pathVariableId: "variableParamsId",
+ pathParamsDataSourceId: "variableParamsId",
} as Page,
dataSources: toMap([
{
diff --git a/packages/react-sdk/src/resources-generator.ts b/packages/react-sdk/src/resources-generator.ts
index 4eac6746a4..0db25d6a15 100644
--- a/packages/react-sdk/src/resources-generator.ts
+++ b/packages/react-sdk/src/resources-generator.ts
@@ -26,7 +26,7 @@ export const generateResourcesLoader = ({
if (dataSource.type === "parameter") {
// support only page path params parameter
- if (dataSource.id !== page.pathVariableId) {
+ if (dataSource.id !== page.pathParamsDataSourceId) {
continue;
}
const name = scope.getName(dataSource.id, dataSource.name);
diff --git a/packages/sdk/src/schema/pages.ts b/packages/sdk/src/schema/pages.ts
index 4a459b65bf..7fc0f42992 100644
--- a/packages/sdk/src/schema/pages.ts
+++ b/packages/sdk/src/schema/pages.ts
@@ -58,7 +58,7 @@ const commonPageFields = {
.optional(),
}),
rootInstanceId: z.string(),
- pathVariableId: z.optional(z.string()),
+ pathParamsDataSourceId: z.optional(z.string()),
} as const;
export const HomePagePath = z