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.

chore: Pages.staging (#5736)

Oleg Isonen9ea5f70a732b
diff --git a/.github/actions/vercel/action.yaml b/.github/actions/vercel/action.yaml
index 9b0119f541..3e3c1be868 100644
--- a/.github/actions/vercel/action.yaml
+++ b/.github/actions/vercel/action.yaml
@@ -20,6 +20,10 @@ inputs:
environment:
description: "Sha"
required: true
+ PUBLIC_COLLAB_RELAY_URL:
+ description: "Public collaboration relay URL injected into the builder bundle"
+ required: false
+ default: ""
outputs:
domain:
@@ -75,6 +79,7 @@ runs:
run: |
export GITHUB_SHA=${{ inputs.sha }}
export GITHUB_REF_NAME=${{ inputs.ref-name }}
+ export PUBLIC_COLLAB_RELAY_URL=${{ inputs.PUBLIC_COLLAB_RELAY_URL }}
pnpx vercel build
shell: bash
diff --git a/.github/workflows/fixtures-test.yml b/.github/workflows/fixtures-test.yml
index 10ddf497b6..b156d4d1d0 100644
--- a/.github/workflows/fixtures-test.yml
+++ b/.github/workflows/fixtures-test.yml
@@ -3,9 +3,6 @@ name: Fixtures tests
on:
workflow_call:
inputs:
- builder-url:
- required: true
- type: string
builder-host:
required: true
type: string
@@ -35,7 +32,6 @@ jobs:
env:
DATABASE_URL: postgres://
AUTH_SECRET: test
- BUILDER_URL_DEPRECATED: ${{ inputs.builder-url }}
BUILDER_HOST: ${{ inputs.builder-host }}
steps:
diff --git a/.github/workflows/vercel-deploy-staging.yml b/.github/workflows/vercel-deploy-staging.yml
index a96527e72b..1f41d0238d 100644
--- a/.github/workflows/vercel-deploy-staging.yml
+++ b/.github/workflows/vercel-deploy-staging.yml
@@ -39,7 +39,7 @@ jobs:
if: |
github.event_name == 'push' ||
(github.event_name == 'pull_request_target' && github.event.action == 'labeled' && github.event.label.name == 'safe-to-deploy')
-
+
# Execute development and staging on staging branches
# Execute only development on all other branches
strategy:
@@ -86,6 +86,7 @@ jobs:
ref-name: ${{ github.event_name == 'pull_request_target' && format('pr-{0}', github.event.pull_request.number) || github.ref_name }}
sha: ${{ github.event_name == 'pull_request_target' && github.event.pull_request.head.sha || github.sha }}
environment: ${{ matrix.environment }}
+ PUBLIC_COLLAB_RELAY_URL: ${{ vars.PUBLIC_COLLAB_RELAY_URL }}
- name: Debug Vercel Outputs
run: |
@@ -119,14 +120,12 @@ jobs:
});
outputs:
- builder-url: "https://${{ steps.vercel.outputs.alias }}.${{ matrix.environment }}.webstudio.is"
builder-host: "${{ steps.vercel.outputs.alias }}.${{ matrix.environment }}.webstudio.is"
fixtures-test:
needs: deployment
uses: ./.github/workflows/fixtures-test.yml
with:
- builder-url: ${{ needs.deployment.outputs.builder-url }}
builder-host: ${{ needs.deployment.outputs.builder-host }}
environment: development
secrets:
diff --git a/apps/builder/app/builder/builder.tsx b/apps/builder/app/builder/builder.tsx
index 4466ae7e36..a6c7bd30c7 100644
--- a/apps/builder/app/builder/builder.tsx
+++ b/apps/builder/app/builder/builder.tsx
@@ -58,7 +58,7 @@ import type { TokenPermissions } from "@webstudio-is/authorization-token";
import { useToastErrors } from "~/shared/error/toast-error";
import { initBuilderApi } from "~/shared/builder-api";
import { updateWebstudioData } from "~/shared/instance-utils";
-import { migrateWebstudioDataMutable } from "~/shared/webstudio-data-migrator";
+import { migrateWebstudioDataMutable } from "@webstudio-is/sdk/migrations/webstudio-data";
import { Loading, LoadingBackground } from "./shared/loading";
import { mergeRefs } from "@react-aria/utils";
import { CommandPanel } from "./features/command-panel";
diff --git a/apps/builder/app/builder/features/address-bar.stories.tsx b/apps/builder/app/builder/features/address-bar.stories.tsx
index c652a8173b..a6f23802c0 100644
--- a/apps/builder/app/builder/features/address-bar.stories.tsx
+++ b/apps/builder/app/builder/features/address-bar.stories.tsx
@@ -16,32 +16,43 @@ registerContainers();
$dataSources.set(new Map());
$pages.set({
- folders: [
- {
- id: "rootId",
- name: "",
- slug: "",
- children: ["homeId", "dynamicId"],
- },
- ],
- homePage: {
- id: "homeId",
- path: "",
- name: "",
- title: "",
- meta: {},
- rootInstanceId: "",
- },
- pages: [
- {
- id: "dynamicId",
- path: "/blog/:date/post/:slug",
- name: "",
- title: "",
- meta: {},
- rootInstanceId: "rootInstanceId",
- },
- ],
+ homePageId: "homeId",
+ rootFolderId: "rootId",
+ folders: new Map([
+ [
+ "rootId",
+ {
+ id: "rootId",
+ name: "",
+ slug: "",
+ children: ["homeId", "dynamicId"],
+ },
+ ],
+ ]),
+ pages: new Map([
+ [
+ "homeId",
+ {
+ id: "homeId",
+ path: "",
+ name: "",
+ title: "",
+ meta: {},
+ rootInstanceId: "",
+ },
+ ],
+ [
+ "dynamicId",
+ {
+ id: "dynamicId",
+ path: "/blog/:date/post/:slug",
+ name: "",
+ title: "",
+ meta: {},
+ rootInstanceId: "rootInstanceId",
+ },
+ ],
+ ]),
});
const SystemInspect = () => {
diff --git a/apps/builder/app/builder/features/command-panel/command-panel.stories.tsx b/apps/builder/app/builder/features/command-panel/command-panel.stories.tsx
index e4659bdced..66f3e476b3 100644
--- a/apps/builder/app/builder/features/command-panel/command-panel.stories.tsx
+++ b/apps/builder/app/builder/features/command-panel/command-panel.stories.tsx
@@ -38,7 +38,7 @@ $breakpoints.set(
);
const pages = createDefaultPages({ rootInstanceId: "" });
-pages.pages.push({
+pages.pages.set("page2", {
id: "page2",
path: "",
name: "Second Page",
@@ -46,7 +46,7 @@ pages.pages.push({
title: "",
meta: {},
});
-pages.pages.push({
+pages.pages.set("page3", {
id: "page3",
path: "",
name: "Thrid Page",
@@ -55,7 +55,7 @@ pages.pages.push({
meta: {},
});
$pages.set(pages);
-$selectedPageId.set(pages.homePage.id);
+$selectedPageId.set(pages.homePageId);
export const CommandPanel: StoryFn = () => {
useEffect(() => {
diff --git a/apps/builder/app/builder/features/command-panel/groups/pages-group.tsx b/apps/builder/app/builder/features/command-panel/groups/pages-group.tsx
index c6e0d0a9d5..9fb06ad4df 100644
--- a/apps/builder/app/builder/features/command-panel/groups/pages-group.tsx
+++ b/apps/builder/app/builder/features/command-panel/groups/pages-group.tsx
@@ -6,7 +6,7 @@ import {
useSelectedAction,
} from "@webstudio-is/design-system";
import { computed } from "nanostores";
-import type { Page } from "@webstudio-is/sdk";
+import { getAllPages, type Page } from "@webstudio-is/sdk";
import { $pages } from "~/shared/sync/data-stores";
import { $editingPageId } from "~/shared/nano-states";
import { $selectedPage } from "~/shared/nano-states";
@@ -28,7 +28,7 @@ export const $pageOptions = computed(
}
const pageOptions: PageOption[] = [];
if (pages) {
- for (const page of [pages.homePage, ...pages.pages]) {
+ for (const page of getAllPages(pages)) {
if (page.id === selectedPage?.id) {
continue;
}
diff --git a/apps/builder/app/builder/features/command-panel/shared/instance-list.tsx b/apps/builder/app/builder/features/command-panel/shared/instance-list.tsx
index 61b826adfa..8a81d93f09 100644
--- a/apps/builder/app/builder/features/command-panel/shared/instance-list.tsx
+++ b/apps/builder/app/builder/features/command-panel/shared/instance-list.tsx
@@ -13,7 +13,7 @@ import {
useSelectedAction,
useCommandState,
} from "@webstudio-is/design-system";
-import type { Instance } from "@webstudio-is/sdk";
+import { getPageById, type Instance } from "@webstudio-is/sdk";
import { $instances, $pages } from "~/shared/sync/data-stores";
import { getInstanceLabel } from "~/builder/shared/instance-label";
import { buildInstancePath } from "~/shared/instance-utils";
@@ -61,7 +61,7 @@ export const InstanceList = ({
instances,
instanceId
);
- const page = pages.pages.find((p) => p.id === awareness.pageId);
+ const page = getPageById(pages, awareness.pageId);
usedInInstances.push({
label: getInstanceLabel(instance),
id: instance.id,
diff --git a/apps/builder/app/builder/features/marketplace/templates.tsx b/apps/builder/app/builder/features/marketplace/templates.tsx
index a128f66db6..e2f6489957 100644
--- a/apps/builder/app/builder/features/marketplace/templates.tsx
+++ b/apps/builder/app/builder/features/marketplace/templates.tsx
@@ -13,6 +13,7 @@ import {
import { ChevronLeftIcon, ExternalLinkIcon } from "@webstudio-is/icons";
import {
elementComponent,
+ getAllPages,
Instance,
ROOT_FOLDER_ID,
type Asset,
@@ -116,7 +117,7 @@ const getTemplatesDataByCategory = (
if (data === undefined) {
return new Map();
}
- const pages = [data.pages.homePage, ...data.pages.pages]
+ const pages = getAllPages(data.pages)
.filter((page) => page.marketplace?.include)
.map((page) => {
// category can be empty string
diff --git a/apps/builder/app/builder/features/marketplace/utils.ts b/apps/builder/app/builder/features/marketplace/utils.ts
index bf0664fe91..2b78823791 100644
--- a/apps/builder/app/builder/features/marketplace/utils.ts
+++ b/apps/builder/app/builder/features/marketplace/utils.ts
@@ -1,6 +1,8 @@
import {
getStyleDeclKey,
+ migratePages,
type Asset,
+ type SerializedPages,
type WebstudioData,
} from "@webstudio-is/sdk";
import type { CompactBuild } from "@webstudio-is/project-build";
@@ -9,14 +11,17 @@ const getPair = <Item extends { id: string }>(item: Item) =>
[item.id, item] as const;
export const toWebstudioData = (
- data: CompactBuild & { assets: Asset[] }
+ data: Omit<CompactBuild, "pages"> & {
+ assets: Asset[];
+ pages: SerializedPages;
+ }
): WebstudioData => ({
assets: new Map(data.assets.map(getPair)),
instances: new Map(data.instances.map(getPair)),
dataSources: new Map(data.dataSources.map(getPair)),
resources: new Map(data.resources.map(getPair)),
props: new Map(data.props.map(getPair)),
- pages: data.pages,
+ pages: migratePages(data.pages),
breakpoints: new Map(data.breakpoints.map(getPair)),
styleSources: new Map(data.styleSources.map(getPair)),
styleSourceSelections: new Map(
diff --git a/apps/builder/app/builder/features/pages/folder-settings.tsx b/apps/builder/app/builder/features/pages/folder-settings.tsx
index 3b7fbe960c..3c2424efb0 100644
--- a/apps/builder/app/builder/features/pages/folder-settings.tsx
+++ b/apps/builder/app/builder/features/pages/folder-settings.tsx
@@ -21,6 +21,7 @@ import {
Pages,
ROOT_FOLDER_ID,
findParentFolderByChildId,
+ getFolderById,
} from "@webstudio-is/sdk";
import { nanoid } from "nanoid";
import { useCallback, useState, type FocusEventHandler } from "react";
@@ -82,16 +83,14 @@ const validateValues = (
return errors;
};
-const toFormValues = (
- folderId: Folder["id"],
- folders: Array<Folder>
-): Values => {
- const folder = folders.find(({ id }) => id === folderId);
+const toFormValues = (folderId: Folder["id"], pages: Pages): Values => {
+ const { folders } = pages;
+ const folder = folders.get(folderId);
const parentFolder = findParentFolderByChildId(folderId, folders);
return {
name: folder?.name ?? "",
slug: folder?.slug ?? "",
- parentFolderId: parentFolder?.id ?? ROOT_FOLDER_ID,
+ parentFolderId: parentFolder?.id ?? pages.rootFolderId,
};
};
@@ -211,6 +210,7 @@ export const NewFolderSettings = ({
const [values, setValues] = useState<Values>({
...fieldDefaultValues,
+ parentFolderId: pages?.rootFolderId ?? fieldDefaultValues.parentFolderId,
slug: nameToSlug(fieldDefaultValues.name),
});
@@ -292,15 +292,15 @@ const createFolder = (folderId: Folder["id"], values: Values) => {
if (pages === undefined) {
return;
}
- pages.folders.push({
+ pages.folders.set(folderId, {
id: folderId,
name: values.name,
slug: values.slug,
children: [],
} satisfies Folder);
- const parentFolder = pages.folders.find(
- ({ id }) => id === values.parentFolderId
- );
+ const parentFolder =
+ getFolderById(pages, values.parentFolderId) ??
+ getFolderById(pages, pages.rootFolderId);
parentFolder?.children.push(folderId);
});
};
@@ -310,8 +310,8 @@ const updateFolder = (folderId: Folder["id"], values: Partial<Values>) => {
if (pages === undefined) {
return;
}
- const folder = pages.folders.find((folder) => folder.id === folderId);
- if (folder === undefined) {
+ const folder = getFolderById(pages, folderId);
+ if (folder === undefined || folderId === pages.rootFolderId) {
return;
}
if (values.name !== undefined) {
@@ -321,11 +321,7 @@ const updateFolder = (folderId: Folder["id"], values: Partial<Values>) => {
folder.slug = values.slug;
}
if (values.parentFolderId !== undefined) {
- registerFolderChildMutable(
- pages.folders,
- folderId,
- values.parentFolderId
- );
+ registerFolderChildMutable(pages, folderId, values.parentFolderId);
}
});
};
@@ -342,12 +338,13 @@ export const FolderSettings = ({
folderId: string;
}) => {
const pages = useStore($pages);
- const folder = pages?.folders.find(({ id }) => id === folderId);
+ const folder =
+ pages === undefined ? undefined : getFolderById(pages, folderId);
const [unsavedValues, setUnsavedValues] = useState<Partial<Values>>({});
const isDesignMode = useStore($isDesignMode);
const values: Values = {
- ...(pages ? toFormValues(folderId, pages.folders) : fieldDefaultValues),
+ ...(pages ? toFormValues(folderId, pages) : fieldDefaultValues),
...unsavedValues,
};
diff --git a/apps/builder/app/builder/features/pages/page-settings.stories.tsx b/apps/builder/app/builder/features/pages/page-settings.stories.tsx
index 9846d301a3..149d602fa1 100644
--- a/apps/builder/app/builder/features/pages/page-settings.stories.tsx
+++ b/apps/builder/app/builder/features/pages/page-settings.stories.tsx
@@ -9,7 +9,6 @@ import {
} from "@webstudio-is/design-system";
import { $assets, $project } from "~/shared/sync/data-stores";
import { createDefaultPages } from "@webstudio-is/project-build";
-import { isRootFolder } from "@webstudio-is/sdk";
export default {
title: "Pages/Page Settings",
@@ -50,7 +49,7 @@ pages.meta = {
faviconAssetId: "imageId",
code: "code",
};
-pages.pages.push({
+pages.pages.set("pageId", {
id: "pageId",
title: "Page title",
path: "/page-path",
@@ -58,7 +57,7 @@ pages.pages.push({
meta: {},
rootInstanceId: "root-instance-id",
});
-const rootFolder = pages.folders.find(isRootFolder);
+const rootFolder = pages.folders.get(pages.rootFolderId);
rootFolder?.children.push("pageId");
$pages.set(pages);
diff --git a/apps/builder/app/builder/features/pages/page-settings.tsx b/apps/builder/app/builder/features/pages/page-settings.tsx
index fd3c8d35e0..b7b4cfcea7 100644
--- a/apps/builder/app/builder/features/pages/page-settings.tsx
+++ b/apps/builder/app/builder/features/pages/page-settings.tsx
@@ -20,7 +20,6 @@ import {
HomePagePath,
PageTitle,
PagePath,
- Folder,
getPagePath,
findPageByIdOrPath,
ROOT_FOLDER_ID,
@@ -28,7 +27,7 @@ import {
ProjectNewRedirectPath,
isLiteralExpression,
documentTypes,
- isRootFolder,
+ getHomePage,
elementComponent,
} from "@webstudio-is/sdk";
import {
@@ -100,6 +99,7 @@ import { SearchPreview } from "./search-preview";
import { SocialPreview } from "./social-preview";
import {
registerFolderChildMutable,
+ cleanupChildRefsMutable,
$pageRootScope,
duplicatePage,
isPathAvailable,
@@ -284,7 +284,7 @@ const toFormValues = (
const parentFolder = findParentFolderByChildId(page.id, pages.folders);
return {
name: page.name,
- parentFolderId: parentFolder?.id ?? ROOT_FOLDER_ID,
+ parentFolderId: parentFolder?.id ?? pages.rootFolderId,
path: page.path,
title: page.title,
description: page.meta.description ?? fieldDefaultValues.description,
@@ -778,7 +778,7 @@ const FormFields = ({
“{values.name}” is the home page
</Text>
</>
- ) : isRootFolder({ id: values.parentFolderId }) === false ? (
+ ) : values.parentFolderId !== pages.rootFolderId ? (
<>
<HomeIcon color={rawTheme.colors.foregroundSubtle} />
<Text
@@ -1253,6 +1253,7 @@ export const NewPageSettings = ({
const [values, setValues] = useState<Values>({
...fieldDefaultValues,
+ parentFolderId: pages?.rootFolderId ?? fieldDefaultValues.parentFolderId,
path: nameToPath(pages, fieldDefaultValues.name),
});
const { variableValues } = useStore($pageRootScope);
@@ -1339,7 +1340,7 @@ const createPage = (pageId: Page["id"], values: Values) => {
return;
}
const rootInstanceId = nanoid();
- pages.pages.push({
+ pages.pages.set(pageId, {
id: pageId,
name: values.name,
path: values.path,
@@ -1354,7 +1355,7 @@ const createPage = (pageId: Page["id"], values: Values) => {
tag: "body",
children: [],
});
- registerFolderChildMutable(pages.folders, pageId, values.parentFolderId);
+ registerFolderChildMutable(pages, pageId, values.parentFolderId);
selectInstance(undefined);
}
);
@@ -1364,13 +1365,13 @@ const updatePage = (pageId: Page["id"], values: Partial<Values>) => {
const updatePageMutable = (
page: Page,
values: Partial<Values>,
- folders: Array<Folder>
+ pages: Pages
) => {
if (values.name !== undefined) {
page.name = values.name;
}
if (values.path !== undefined) {
- page.path = values.path;
+ page.path = page.id === pages.homePageId ? "" : values.path;
}
if (values.title !== undefined) {
page.title = values.title;
@@ -1418,7 +1419,7 @@ const updatePage = (pageId: Page["id"], values: Partial<Values>) => {
}
if (values.parentFolderId !== undefined) {
- registerFolderChildMutable(folders, page.id, values.parentFolderId);
+ registerFolderChildMutable(pages, page.id, values.parentFolderId);
}
if (values.marketplaceInclude !== undefined) {
@@ -1446,59 +1447,36 @@ const updatePage = (pageId: Page["id"], values: Partial<Values>) => {
return;
}
- if (pages.homePage.id === pageId) {
- updatePageMutable(pages.homePage, values, pages.folders);
- }
-
- const pageToUpdate = pages.pages.find((page) => page.id === pageId);
+ const pageToUpdate = pages.pages.get(pageId);
if (pageToUpdate !== undefined) {
- updatePageMutable(pageToUpdate, values, pages.folders);
+ updatePageMutable(pageToUpdate, values, pages);
}
// swap home page
- if (values.isHomePage && pages.homePage.id !== pageId) {
- const newHomePageIndex = pages.pages.findIndex(
- (page) => page.id === pageId
- );
-
- if (newHomePageIndex === -1) {
+ if (values.isHomePage && pages.homePageId !== pageId) {
+ const newHomePage = pages.pages.get(pageId);
+ const oldHomePage = getHomePage(pages);
+ if (newHomePage === undefined) {
throw new Error(`Page with id ${pageId} not found`);
}
- const oldHomePage = pages.homePage as (typeof pages.pages)[0];
-
- pages.homePage = pages.pages[newHomePageIndex] as typeof pages.homePage;
-
- pages.homePage.path = "";
-
- pages.homePage.name = "Home";
-
- pages.pages[newHomePageIndex] = oldHomePage;
+ pages.homePageId = newHomePage.id;
+ newHomePage.path = "";
+ newHomePage.name = "Home";
// For simplicity skip logic in case of names are same i.e. Old Home 1, Old Home 2
oldHomePage.name = "Old Home";
oldHomePage.path = nameToPath(pages, oldHomePage.name);
- const rootFolder = pages.folders.find((folder) => isRootFolder(folder));
+ const rootFolder = pages.folders.get(pages.rootFolderId);
if (rootFolder === undefined) {
throw new Error("Root folder not found");
}
- if (rootFolder.children === undefined) {
- throw new Error("Root folder must have children");
- }
-
- // Swap home to the first position in the root folder
- const childIndexOfHome = rootFolder?.children.indexOf(pages.homePage.id);
-
- if (childIndexOfHome === -1) {
- throw new Error("Both pages must be children of Root folder");
- }
-
- rootFolder.children[childIndexOfHome] = rootFolder.children[0];
- rootFolder.children[0] = pages.homePage.id;
+ cleanupChildRefsMutable(newHomePage.id, pages.folders);
+ rootFolder.children.unshift(newHomePage.id);
}
});
};
@@ -1517,7 +1495,7 @@ export const PageSettings = ({
const pages = useStore($pages);
const page = pages && findPageByIdOrPath(pageId, pages);
- const isHomePage = page?.id === pages?.homePage.id;
+ const isHomePage = page?.id === pages?.homePageId;
const [unsavedValues, setUnsavedValues] = useState<Partial<Values>>({});
diff --git a/apps/builder/app/builder/features/pages/page-utils.test.ts b/apps/builder/app/builder/features/pages/page-utils.test.ts
index 96628ed5fb..cafbd9534b 100644
--- a/apps/builder/app/builder/features/pages/page-utils.test.ts
+++ b/apps/builder/app/builder/features/pages/page-utils.test.ts
@@ -9,6 +9,7 @@ import {
type Page,
SYSTEM_VARIABLE_ID,
Resource,
+ type Pages,
type WebstudioData,
} from "@webstudio-is/sdk";
import {
@@ -85,15 +86,15 @@ const createPages = () => {
const register = (children: Array<Page | Folder>, root: boolean = true) => {
const childIds = [];
- const rootFolder = folders.find(isRootFolder);
+ const rootFolder = Array.from(folders.values()).find(isRootFolder);
for (const child of children) {
childIds.push(child.id);
if ("meta" in child) {
- pages.push(child);
+ pages.set(child.id, child);
continue;
}
- folders.push(child);
+ folders.set(child.id, child);
if (root) {
rootFolder?.children.push(child.id);
@@ -114,7 +115,7 @@ describe("reparentOrphansMutable", () => {
// because user A can add a page to a folder while user B deletes the folder without receiving the create page yet.
test("reparent orphans to the root", () => {
const { pages } = createPages();
- pages.pages.push({
+ pages.pages.set("pageId", {
id: "pageId",
meta: {},
name: "Page",
@@ -122,14 +123,14 @@ describe("reparentOrphansMutable", () => {
rootInstanceId: "rootInstanceId",
title: `"Page"`,
});
- pages.folders.push({
+ pages.folders.set("folderId", {
id: "folderId",
name: "Folder",
slug: "folder",
children: [],
});
reparentOrphansMutable(pages);
- const rootFolder = pages.folders.find(isRootFolder);
+ const rootFolder = Array.from(pages.folders.values()).find(isRootFolder);
expect(rootFolder).toEqual({
id: ROOT_FOLDER_ID,
name: "Root",
@@ -137,6 +138,48 @@ describe("reparentOrphansMutable", () => {
children: ["homePageId", "folderId", "pageId"],
});
});
+
+ test("recreates missing root folder with rootFolderId", () => {
+ const { pages } = createPages();
+ pages.rootFolderId = "customRoot";
+ pages.folders = new Map();
+ pages.pages.set("pageId", {
+ id: "pageId",
+ meta: {},
+ name: "Page",
+ path: "/page",
+ rootInstanceId: "rootInstanceId",
+ title: `"Page"`,
+ });
+
+ reparentOrphansMutable(pages);
+
+ expect(pages.folders.get("customRoot")).toEqual({
+ id: "customRoot",
+ name: "Root",
+ slug: "",
+ children: ["homePageId", "pageId"],
+ });
+ });
+
+ test("keeps home page first in root folder", () => {
+ const { pages } = createPages();
+ pages.folders.set("folderId", {
+ id: "folderId",
+ name: "Folder",
+ slug: "folder",
+ children: ["homePageId"],
+ });
+ pages.folders.get(pages.rootFolderId)!.children = ["folderId"];
+
+ reparentOrphansMutable(pages);
+
+ expect(pages.folders.get(pages.rootFolderId)?.children).toEqual([
+ "homePageId",
+ "folderId",
+ ]);
+ expect(pages.folders.get("folderId")?.children).toEqual([]);
+ });
});
describe("cleanupChildRefsMutable", () => {
@@ -144,13 +187,13 @@ describe("cleanupChildRefsMutable", () => {
const {
pages: { folders },
} = createPages();
- folders.push({
+ folders.set("folderId", {
id: "folderId",
name: "Folder",
slug: "folder",
children: [],
});
- const rootFolder = folders.find(isRootFolder);
+ const rootFolder = Array.from(folders.values()).find(isRootFolder);
rootFolder?.children.push("folderId");
cleanupChildRefsMutable("folderId", folders);
expect(rootFolder).toEqual({
@@ -160,6 +203,24 @@ describe("cleanupChildRefsMutable", () => {
children: ["homePageId"],
});
});
+
+ test("removes duplicate refs from every folder", () => {
+ const {
+ pages: { folders },
+ } = createPages();
+ folders.get(ROOT_FOLDER_ID)?.children.push("folderId", "folderId");
+ folders.set("folderId", {
+ id: "folderId",
+ name: "Folder",
+ slug: "folder",
+ children: ["folderId"],
+ });
+
+ cleanupChildRefsMutable("folderId", folders);
+
+ expect(folders.get(ROOT_FOLDER_ID)?.children).toEqual(["homePageId"]);
+ expect(folders.get("folderId")?.children).toEqual([]);
+ });
});
describe("isSlugAvailable", () => {
@@ -175,7 +236,7 @@ describe("isSlugAvailable", () => {
f("folder2-2", ""),
]);
- const rootFolder = folders.find(isRootFolder)!;
+ const rootFolder = Array.from(folders.values()).find(isRootFolder)!;
test("available in the root", () => {
expect(isSlugAvailable("folder", folders, rootFolder.id)).toBe(true);
@@ -245,43 +306,40 @@ describe("isPathAvailable", () => {
describe("registerFolderChildMutable", () => {
test("register a folder child in the root via fallback", () => {
- const {
- pages: { folders },
- } = createPages();
- registerFolderChildMutable(folders, "folderId");
- const rootFolder = folders.find(isRootFolder);
+ const { pages } = createPages();
+ const { folders } = pages;
+ registerFolderChildMutable(pages, "folderId");
+ const rootFolder = Array.from(folders.values()).find(isRootFolder);
expect(rootFolder?.children).toEqual(["homePageId", "folderId"]);
});
test("register a folder child in a provided folder", () => {
- const {
- pages: { folders },
- } = createPages();
+ const { pages } = createPages();
+ const { folders } = pages;
const folder = {
id: "folderId",
name: "Folder",
slug: "folder",
children: [],
};
- folders.push(folder);
- registerFolderChildMutable(folders, "folderId2", "folderId");
+ folders.set(folder.id, folder);
+ registerFolderChildMutable(pages, "folderId2", "folderId");
expect(folder.children).toEqual(["folderId2"]);
});
test("register in a provided folder & cleanup old refs", () => {
- const {
- pages: { folders },
- } = createPages();
+ const { pages } = createPages();
+ const { folders } = pages;
const folder = {
id: "folderId",
name: "Folder",
slug: "folder",
children: [],
};
- folders.push(folder);
- const rootFolder = folders.find(isRootFolder);
- registerFolderChildMutable(folders, "folderId", ROOT_FOLDER_ID);
- registerFolderChildMutable(folders, "folderId2", ROOT_FOLDER_ID);
+ folders.set(folder.id, folder);
+ const rootFolder = Array.from(folders.values()).find(isRootFolder);
+ registerFolderChildMutable(pages, "folderId", ROOT_FOLDER_ID);
+ registerFolderChildMutable(pages, "folderId2", ROOT_FOLDER_ID);
expect(rootFolder?.children).toEqual([
"homePageId",
@@ -290,11 +348,31 @@ describe("registerFolderChildMutable", () => {
]);
// Moving folderId from root to folderId
- registerFolderChildMutable(folders, "folderId2", "folderId");
+ registerFolderChildMutable(pages, "folderId2", "folderId");
expect(rootFolder?.children).toEqual(["homePageId", "folderId"]);
expect(folder.children).toEqual(["folderId2"]);
});
+
+ test("uses rootFolderId for fallback instead of hardcoded root id", () => {
+ const { pages } = createPages();
+ pages.rootFolderId = "customRoot";
+ pages.folders = new Map([
+ [
+ "customRoot",
+ {
+ id: "customRoot",
+ name: "Root",
+ slug: "",
+ children: [],
+ },
+ ],
+ ]);
+
+ registerFolderChildMutable(pages, "folderId");
+
+ expect(pages.folders.get("customRoot")?.children).toEqual(["folderId"]);
+ });
});
describe("reparent pages and folders", () => {
@@ -308,7 +386,7 @@ describe("reparent pages and folders", () => {
]),
]);
reparentPageOrFolderMutable(pages.folders, "page3", "folder", 1);
- const folder = pages.folders.find((folder) => folder.id === "folder");
+ const folder = pages.folders.get("folder");
expect(folder?.children).toEqual(["page1", "page3", "page2"]);
});
@@ -322,7 +400,7 @@ describe("reparent pages and folders", () => {
]),
]);
reparentPageOrFolderMutable(pages.folders, "page1", "folder", 2);
- const folder = pages.folders.find((folder) => folder.id === "folder");
+ const folder = pages.folders.get("folder");
expect(folder?.children).toEqual(["page2", "page1", "page3"]);
});
@@ -333,8 +411,8 @@ describe("reparent pages and folders", () => {
f("folder2", [p("page3", "/page3")]),
]);
reparentPageOrFolderMutable(pages.folders, "page1", "folder2", 1);
- const folder1 = pages.folders.find((folder) => folder.id === "folder1");
- const folder2 = pages.folders.find((folder) => folder.id === "folder2");
+ const folder1 = pages.folders.get("folder1");
+ const folder2 = pages.folders.get("folder2");
expect(folder1?.children).toEqual(["page2"]);
expect(folder2?.children).toEqual(["page3", "page1"]);
});
@@ -343,7 +421,7 @@ describe("reparent pages and folders", () => {
const { f, register, pages } = createPages();
register([f("folder1", []), f("folder2", [])]);
reparentPageOrFolderMutable(pages.folders, "folder1", "folder2", 1);
- expect(pages.folders).toEqual([
+ expect(Array.from(pages.folders.values())).toEqual([
expect.objectContaining({
id: "root",
children: ["homePageId", "folder2"],
@@ -357,7 +435,7 @@ describe("reparent pages and folders", () => {
const { f, register, pages } = createPages();
register([f("folder1", [])]);
reparentPageOrFolderMutable(pages.folders, "folder1", "folder1", 1);
- expect(pages.folders).toEqual([
+ expect(Array.from(pages.folders.values())).toEqual([
expect.objectContaining({
id: "root",
children: ["homePageId", "folder1"],
@@ -370,7 +448,7 @@ describe("reparent pages and folders", () => {
const { f, register, pages } = createPages();
register([f("folder1", [f("folder2", [])])]);
reparentPageOrFolderMutable(pages.folders, "folder1", "folder2", 1);
- expect(pages.folders).toEqual([
+ expect(Array.from(pages.folders.values())).toEqual([
expect.objectContaining({
id: "root",
children: ["homePageId", "folder1"],
@@ -379,29 +457,23 @@ describe("reparent pages and folders", () => {
expect.objectContaining({ id: "folder1", children: ["folder2"] }),
]);
});
+
+ test("does not remove unrelated child when item is missing from previous parent", () => {
+ const { f, p, register, pages } = createPages();
+ register([f("folder", [p("page1", "/page1"), p("page2", "/page2")])]);
+
+ reparentPageOrFolderMutable(pages.folders, "page3", "folder", 1);
+
+ expect(pages.folders.get("folder")?.children).toEqual(["page1", "page2"]);
+ });
});
describe("getAllChildrenAndSelf", () => {
- const folders: Array<Folder> = [
- {
- id: "1",
- name: "1",
- slug: "1",
- children: ["2"],
- },
- {
- id: "2",
- name: "2",
- slug: "2",
- children: ["3", "page1"],
- },
- {
- id: "3",
- name: "3",
- slug: "3",
- children: ["page2"],
- },
- ];
+ const folders = toMap<Folder>([
+ { id: "1", name: "1", slug: "1", children: ["2"] },
+ { id: "2", name: "2", slug: "2", children: ["3", "page1"] },
+ { id: "3", name: "3", slug: "3", children: ["page2"] },
+ ]);
test("get nested folders", () => {
const result = getAllChildrenAndSelf("1", folders, "folder");
@@ -415,39 +487,79 @@ describe("getAllChildrenAndSelf", () => {
});
describe("deleteFolderWithChildrenMutable", () => {
- const folders = (): Array<Folder> => [
- {
- id: "1",
- name: "1",
- slug: "1",
- children: ["2"],
- },
- {
- id: "2",
- name: "2",
- slug: "2",
- children: ["3", "page1"],
- },
- {
- id: "3",
- name: "3",
- slug: "3",
- children: [],
- },
- ];
+ const pages = (): Pages => ({
+ homePageId: "homePageId",
+ rootFolderId: ROOT_FOLDER_ID,
+ pages: new Map(),
+ folders: toMap<Folder>([
+ {
+ id: ROOT_FOLDER_ID,
+ name: "Root",
+ slug: "",
+ children: ["2"],
+ },
+ {
+ id: "2",
+ name: "2",
+ slug: "2",
+ children: ["3", "page1"],
+ },
+ {
+ id: "3",
+ name: "3",
+ slug: "3",
+ children: [],
+ },
+ ]),
+ });
test("delete empty folder", () => {
- const result = deleteFolderWithChildrenMutable("3", folders());
+ const result = deleteFolderWithChildrenMutable("3", pages());
expect(result).toEqual({ folderIds: ["3"], pageIds: [] });
});
test("delete folder with folders and pages", () => {
- const result = deleteFolderWithChildrenMutable("1", folders());
+ const result = deleteFolderWithChildrenMutable("2", pages());
expect(result).toEqual({
- folderIds: ["1", "2", "3"],
+ folderIds: ["2", "3"],
pageIds: ["page1"],
});
});
+
+ test("does not delete folder containing home page", () => {
+ const pagesData = pages();
+ pagesData.homePageId = "homePageId";
+ pagesData.pages.set("homePageId", {
+ id: "homePageId",
+ meta: {},
+ name: "Home",
+ path: "",
+ rootInstanceId: "rootInstanceId",
+ title: `"Home"`,
+ });
+ pagesData.folders.get("2")?.children.push("homePageId");
+
+ const result = deleteFolderWithChildrenMutable("2", pagesData);
+
+ expect(result).toEqual({ folderIds: [], pageIds: [] });
+ expect(pagesData.folders.get("2")).toBeDefined();
+ });
+
+ test("does not delete root folder", () => {
+ const pagesData = pages();
+ const result = deleteFolderWithChildrenMutable(ROOT_FOLDER_ID, pagesData);
+ expect(result).toEqual({ folderIds: [], pageIds: [] });
+ expect(pagesData.folders.get(ROOT_FOLDER_ID)).toBeDefined();
+ expect(pagesData.folders.get(ROOT_FOLDER_ID)?.children).toEqual(["2"]);
+ });
+
+ test("does not delete custom root folder", () => {
+ const pagesData = pages();
+ pagesData.rootFolderId = "2";
+ const result = deleteFolderWithChildrenMutable("2", pagesData);
+ expect(result).toEqual({ folderIds: [], pageIds: [] });
+ expect(pagesData.folders.get("2")).toBeDefined();
+ });
});
test("page root scope should rely on selected page", () => {
@@ -455,7 +567,7 @@ test("page root scope should rely on selected page", () => {
rootInstanceId: "homeRootId",
homePageId: "homePageId",
});
- pages.pages.push({
+ pages.pages.set("pageId", {
id: "pageId",
rootInstanceId: "pageRootId",
name: "My Name",
@@ -635,6 +747,24 @@ test("page root scope should provide page system variable value", () => {
});
describe("deletePageMutable", () => {
+ test("does not delete home page", async () => {
+ const { pages: pagesData } = createPages();
+ const homePage = pagesData.pages.get(pagesData.homePageId);
+ const data = {
+ pages: pagesData,
+ instances: new Map(),
+ } as unknown as WebstudioData;
+
+ deletePageMutable(pagesData.homePageId, data);
+
+ expect(pagesData.pages.get(pagesData.homePageId)).toEqual(homePage);
+ expect(
+ Array.from(pagesData.folders.values()).some((folder) =>
+ folder.children.includes(pagesData.homePageId)
+ )
+ ).toBe(true);
+ });
+
test("should delete a page from pages array", async () => {
const { pages: pagesData, register, p } = createPages();
register([p("page1", "/page1"), p("page2", "/page2")]);
@@ -647,15 +777,15 @@ describe("deletePageMutable", () => {
deletePageMutable("page1", data);
- expect(pagesData.pages.find((page) => page.id === "page1")).toBeUndefined();
- expect(pagesData.pages.find((page) => page.id === "page2")).toBeDefined();
+ expect(pagesData.pages.get("page1")).toBeUndefined();
+ expect(pagesData.pages.get("page2")).toBeDefined();
});
test("should delete page instance", async () => {
const { pages: pagesData, register, p } = createPages();
register([p("page1", "/page1")]);
- const page = pagesData.pages.find((page) => page.id === "page1");
+ const page = pagesData.pages.get("page1");
const rootInstanceId = page?.rootInstanceId;
// Create minimal WebstudioData with all required properties
@@ -690,7 +820,7 @@ describe("deletePageMutable", () => {
const { pages: pagesData, register, p, f } = createPages();
register([f("folder1", [p("page1", "/page1")])]);
- const folder = pagesData.folders.find((folder) => folder.id === "folder1");
+ const folder = pagesData.folders.get("folder1");
expect(folder?.children).toContain("page1");
// Create minimal WebstudioData
@@ -808,7 +938,7 @@ describe("canDrop", () => {
indexWithinChildren: 1,
};
- expect(canDrop(dropTarget, pagesData.folders)).toBe(true);
+ expect(canDrop(dropTarget, pagesData)).toBe(true);
});
test("should forbid dropping on non-folder", async () => {
@@ -821,7 +951,7 @@ describe("canDrop", () => {
indexWithinChildren: 0,
};
- expect(canDrop(dropTarget, pagesData.folders)).toBe(false);
+ expect(canDrop(dropTarget, pagesData)).toBe(false);
});
test("should forbid dropping at index 0 of root folder", async () => {
@@ -833,7 +963,7 @@ describe("canDrop", () => {
indexWithinChildren: 0,
};
- expect(canDrop(dropTarget, pagesData.folders)).toBe(false);
+ expect(canDrop(dropTarget, pagesData)).toBe(false);
});
test("should allow dropping at index > 0 of root folder", async () => {
@@ -845,7 +975,26 @@ describe("canDrop", () => {
indexWithinChildren: 1,
};
- expect(canDrop(dropTarget, pagesData.folders)).toBe(true);
+ expect(canDrop(dropTarget, pagesData)).toBe(true);
+ });
+
+ test("uses rootFolderId when forbidding drops before home page", async () => {
+ const { pages: pagesData } = createPages();
+ pagesData.rootFolderId = "customRoot";
+ pagesData.folders.set("customRoot", {
+ id: "customRoot",
+ name: "Root",
+ slug: "",
+ children: [],
+ });
+
+ const { canDrop } = await import("./page-utils");
+ const dropTarget = {
+ parentId: "customRoot",
+ indexWithinChildren: 0,
+ };
+
+ expect(canDrop(dropTarget, pagesData)).toBe(false);
});
});
@@ -864,9 +1013,10 @@ describe("duplicateFolder", () => {
expect(newFolderId).toBeDefined();
const updatedPages = $pages.get()!;
- const newFolder = updatedPages.folders.find(
- (folder) => folder.id === newFolderId
- );
+ const newFolder =
+ newFolderId === undefined
+ ? undefined
+ : updatedPages.folders.get(newFolderId);
expect(newFolder).toBeDefined();
expect(newFolder?.name).toBe("folder1 (1)");
expect(newFolder?.slug).toBe("folder1-1");
@@ -884,9 +1034,10 @@ describe("duplicateFolder", () => {
expect(newFolderId).toBeDefined();
const updatedPages = $pages.get()!;
- const newFolder = updatedPages.folders.find(
- (folder) => folder.id === newFolderId
- );
+ const newFolder =
+ newFolderId === undefined
+ ? undefined
+ : updatedPages.folders.get(newFolderId);
expect(newFolder).toBeDefined();
// Note: Page duplication is handled by insertPageCopyMutable from ~/shared/page-utils
// which requires full WebstudioData setup. Here we just verify the folder structure.
@@ -910,20 +1061,22 @@ describe("duplicateFolder", () => {
expect(newFolderId).toBeDefined();
const updatedPages = $pages.get()!;
- const newFolder = updatedPages.folders.find(
- (folder) => folder.id === newFolderId
- );
+ const newFolder =
+ newFolderId === undefined
+ ? undefined
+ : updatedPages.folders.get(newFolderId);
expect(newFolder).toBeDefined();
expect(newFolder?.children.length).toBeGreaterThan(0);
// Check that subfolder was duplicated
const subFolderChild = newFolder?.children.find((childId) =>
- updatedPages.folders.some((folder) => folder.id === childId)
+ updatedPages.folders.has(childId)
);
expect(subFolderChild).toBeDefined();
- const subFolder = updatedPages.folders.find(
- (folder) => folder.id === subFolderChild
- );
+ const subFolder =
+ subFolderChild === undefined
+ ? undefined
+ : updatedPages.folders.get(subFolderChild);
expect(subFolder).toBeDefined();
expect(subFolder?.name).toBe("subfolder1 (1)");
});
@@ -940,9 +1093,10 @@ describe("duplicateFolder", () => {
expect(newFolderId).toBeDefined();
const updatedPages = $pages.get()!;
- const newFolder = updatedPages.folders.find(
- (folder) => folder.id === newFolderId
- );
+ const newFolder =
+ newFolderId === undefined
+ ? undefined
+ : updatedPages.folders.get(newFolderId);
expect(newFolder?.name).toBe("folder1 (2)");
expect(newFolder?.slug).toBe("folder1-2");
});
@@ -958,7 +1112,9 @@ describe("duplicateFolder", () => {
const newFolderId = duplicateFolder("folder1");
const updatedPages = $pages.get()!;
- const rootFolder = updatedPages.folders.find(isRootFolder);
+ const rootFolder = Array.from(updatedPages.folders.values()).find(
+ isRootFolder
+ );
expect(rootFolder?.children).toContain(newFolderId);
});
});
diff --git a/apps/builder/app/builder/features/pages/page-utils.ts b/apps/builder/app/builder/features/pages/page-utils.ts
index 7fea31b8dc..8defce3851 100644
--- a/apps/builder/app/builder/features/pages/page-utils.ts
+++ b/apps/builder/app/builder/features/pages/page-utils.ts
@@ -1,6 +1,5 @@
import { computed } from "nanostores";
import { nanoid } from "nanoid";
-import { createRootFolder } from "@webstudio-is/project-build";
import {
type Page,
type Folder,
@@ -9,14 +8,14 @@ import {
findPageByIdOrPath,
getPagePath,
findParentFolderByChildId,
+ getAllFolders,
+ getAllPages,
+ getFolderById,
encodeDataSourceVariable,
- ROOT_FOLDER_ID,
- isRootFolder,
ROOT_INSTANCE_ID,
systemParameter,
SYSTEM_VARIABLE_ID,
} from "@webstudio-is/sdk";
-import { removeByMutable } from "~/shared/array-utils";
import {
deleteInstanceMutable,
updateWebstudioData,
@@ -40,15 +39,10 @@ import { selectPage } from "~/shared/nano-states";
*/
export const cleanupChildRefsMutable = (
id: Folder["id"] | Page["id"],
- folders: Array<Folder>
+ folders: Pages["folders"]
) => {
- for (const folder of folders) {
- const index = folder.children.indexOf(id);
- if (index !== -1) {
- // Not exiting here just to be safe and check all folders even though it should be impossible
- // to have the same id in multiple folders.
- folder.children.splice(index, 1);
- }
+ for (const folder of Array.from(folders.values())) {
+ folder.children = folder.children.filter((childId) => childId !== id);
}
};
@@ -57,26 +51,47 @@ export const cleanupChildRefsMutable = (
* we consider it orphaned due to collaborative changes and we put it into the root folder.
*/
export const reparentOrphansMutable = (pages: Pages) => {
- const children = [ROOT_FOLDER_ID];
- for (const folder of pages.folders) {
+ const children = [pages.rootFolderId];
+ for (const folder of getAllFolders(pages)) {
children.push(...folder.children);
}
- let rootFolder = pages.folders.find(isRootFolder);
+ let rootFolder = getFolderById(pages, pages.rootFolderId);
// Should never happen, but just in case.
if (rootFolder === undefined) {
- rootFolder = createRootFolder();
- pages.folders.push(rootFolder);
+ rootFolder = {
+ id: pages.rootFolderId,
+ name: "Root",
+ slug: "",
+ children: [],
+ };
+ pages.folders.set(rootFolder.id, rootFolder);
+ }
+
+ if (pages.pages.has(pages.homePageId)) {
+ let homePageRefCount = 0;
+ for (const folder of getAllFolders(pages)) {
+ for (const childId of folder.children) {
+ if (childId === pages.homePageId) {
+ homePageRefCount += 1;
+ }
+ }
+ }
+ if (rootFolder.children[0] !== pages.homePageId || homePageRefCount !== 1) {
+ cleanupChildRefsMutable(pages.homePageId, pages.folders);
+ rootFolder.children.unshift(pages.homePageId);
+ children.push(pages.homePageId);
+ }
}
- for (const folder of pages.folders) {
+ for (const folder of getAllFolders(pages)) {
// It's an orphan
if (children.includes(folder.id) === false) {
rootFolder.children.push(folder.id);
}
}
- for (const page of pages.pages) {
+ for (const page of getAllPages(pages)) {
// It's an orphan
if (children.includes(page.id) === false) {
rootFolder.children.push(page.id);
@@ -90,7 +105,7 @@ export const reparentOrphansMutable = (pages: Pages) => {
*/
export const isSlugAvailable = (
slug: string,
- folders: Array<Folder>,
+ folders: Pages["folders"],
parentFolderId: Folder["id"],
// undefined folder id means new folder
folderId?: Folder["id"]
@@ -99,8 +114,7 @@ export const isSlugAvailable = (
if (slug === "") {
return true;
}
- const foldersMap = new Map(folders.map((folder) => [folder.id, folder]));
- const parentFolder = foldersMap.get(parentFolderId);
+ const parentFolder = folders.get(parentFolderId);
// Should be impossible because at least root folder is always found.
if (parentFolder === undefined) {
return false;
@@ -108,7 +122,7 @@ export const isSlugAvailable = (
return (
parentFolder.children.some(
- (id) => foldersMap.get(id)?.slug === slug && id !== folderId
+ (id) => folders.get(id)?.slug === slug && id !== folderId
) === false
);
};
@@ -126,7 +140,7 @@ export const isPathAvailable = ({
pageId?: Page["id"];
}) => {
const map = new Map<Page["path"], Page>();
- const allPages = [pages.homePage, ...pages.pages];
+ const allPages = getAllPages(pages);
for (const page of allPages) {
map.set(getPagePath(page.id, pages), page);
}
@@ -147,21 +161,22 @@ export const isPathAvailable = ({
* - Cleanup any potential references in other folders.
*/
export const registerFolderChildMutable = (
- folders: Array<Folder>,
+ pages: Pick<Pages, "folders" | "rootFolderId">,
id: Page["id"] | Folder["id"],
// In case we couldn't find the current folder during update for any reason,
// we will always fall back to the root folder.
parentFolderId?: Folder["id"]
) => {
+ const { folders } = pages;
const parentFolder =
- folders.find((folder) => folder.id === parentFolderId) ??
- folders.find(isRootFolder);
+ (parentFolderId === undefined ? undefined : folders.get(parentFolderId)) ??
+ folders.get(pages.rootFolderId);
cleanupChildRefsMutable(id, folders);
parentFolder?.children.push(id);
};
export const reparentPageOrFolderMutable = (
- folders: Folder[],
+ folders: Pages["folders"],
pageOrFolderId: string,
newFolderId: string,
newPosition: number
@@ -176,13 +191,16 @@ export const reparentPageOrFolderMutable = (
return;
}
const prevParent = findParentFolderByChildId(pageOrFolderId, folders);
- const nextParent = folders.find((folder) => folder.id === newFolderId);
+ const nextParent = folders.get(newFolderId);
if (prevParent === undefined || nextParent === undefined) {
return;
}
// if parent is the same, we need to adjust the position
// to account for the removal of the instance.
const prevPosition = prevParent.children.indexOf(pageOrFolderId);
+ if (prevPosition === -1) {
+ return;
+ }
if (prevParent.id === nextParent.id && prevPosition < newPosition) {
newPosition -= 1;
}
@@ -195,10 +213,10 @@ export const reparentPageOrFolderMutable = (
*/
export const getAllChildrenAndSelf = (
id: Folder["id"] | Page["id"],
- folders: Array<Folder>,
+ folders: Pages["folders"],
filter: "folder" | "page"
) => {
- const child = folders.find((folder) => folder.id === id);
+ const child = folders.get(id);
const children: Array<Folder["id"]> = [];
const type = child === undefined ? "page" : "folder";
@@ -219,9 +237,12 @@ export const getAllChildrenAndSelf = (
*/
export const deletePageMutable = (pageId: Page["id"], data: WebstudioData) => {
const { pages } = data;
+ if (pageId === pages.homePageId) {
+ return;
+ }
// deselect page before deleting to avoid flash of content
if ($selectedPage.get()?.id === pageId) {
- selectPage(pages.homePage.id);
+ selectPage(pages.homePageId);
}
const rootInstanceId = findPageByIdOrPath(pageId, pages)?.rootInstanceId;
if (rootInstanceId !== undefined) {
@@ -230,7 +251,7 @@ export const deletePageMutable = (pageId: Page["id"], data: WebstudioData) => {
getInstancePath([rootInstanceId], data.instances)
);
}
- removeByMutable(pages.pages, (page) => page.id === pageId);
+ pages.pages.delete(pageId);
cleanupChildRefsMutable(pageId, pages.folders);
};
@@ -240,13 +261,27 @@ export const deletePageMutable = (pageId: Page["id"], data: WebstudioData) => {
*/
export const deleteFolderWithChildrenMutable = (
folderId: Folder["id"],
- folders: Array<Folder>
+ pages: Pages
) => {
+ const { folders } = pages;
+ const folder = folders.get(folderId);
+ if (folder === undefined || folderId === pages.rootFolderId) {
+ return {
+ folderIds: [],
+ pageIds: [],
+ };
+ }
const folderIds = getAllChildrenAndSelf(folderId, folders, "folder");
const pageIds = getAllChildrenAndSelf(folderId, folders, "page");
+ if (pageIds.includes(pages.homePageId)) {
+ return {
+ folderIds: [],
+ pageIds: [],
+ };
+ }
for (const folderId of folderIds) {
cleanupChildRefsMutable(folderId, folders);
- removeByMutable(folders, (folder) => folder.id === folderId);
+ folders.delete(folderId);
}
return {
@@ -286,7 +321,10 @@ export const $pageRootScope = computed(
export const duplicatePage = (pageId: Page["id"]) => {
const pages = $pages.get();
- const currentFolder = findParentFolderByChildId(pageId, pages?.folders ?? []);
+ const currentFolder =
+ pages === undefined
+ ? undefined
+ : findParentFolderByChildId(pageId, pages.folders);
if (currentFolder === undefined) {
return;
}
@@ -333,30 +371,22 @@ const insertFolderCopyMutable = ({
source: { data: WebstudioData; folderId: Folder["id"] };
target: { data: WebstudioData; parentFolderId: Folder["id"] };
}): Folder["id"] | undefined => {
- const sourceFolder = source.data.pages.folders.find(
- (folder) => folder.id === source.folderId
- );
+ const sourceFolder = source.data.pages.folders.get(source.folderId);
if (sourceFolder === undefined) {
return;
}
- const parentFolder = target.data.pages.folders.find(
- (folder) => folder.id === target.parentFolderId
- );
+ const parentFolder = target.data.pages.folders.get(target.parentFolderId);
const usedNames = new Set<string>();
const usedSlugs = new Set<string>();
for (const childId of parentFolder?.children ?? []) {
- const childFolder = target.data.pages.folders.find(
- (folder) => folder.id === childId
- );
+ const childFolder = target.data.pages.folders.get(childId);
if (childFolder) {
usedNames.add(childFolder.name);
usedSlugs.add(childFolder.slug);
continue;
}
- const childPage = target.data.pages.pages.find(
- (page) => page.id === childId
- );
+ const childPage = target.data.pages.pages.get(childId);
if (childPage) {
usedNames.add(childPage.name);
}
@@ -372,10 +402,10 @@ const insertFolderCopyMutable = ({
};
// Add new folder to the folders array
- target.data.pages.folders.push(newFolder);
+ target.data.pages.folders.set(newFolder.id, newFolder);
// Register new folder in parent
- for (const folder of target.data.pages.folders) {
+ for (const folder of getAllFolders(target.data.pages)) {
if (folder.id === target.parentFolderId) {
folder.children.push(newFolderId);
}
@@ -383,9 +413,7 @@ const insertFolderCopyMutable = ({
// Duplicate all children (pages and nested folders)
for (const childId of sourceFolder.children) {
- const childFolder = source.data.pages.folders.find(
- (folder) => folder.id === childId
- );
+ const childFolder = source.data.pages.folders.get(childId);
if (childFolder) {
// It's a nested folder - duplicate it recursively
@@ -407,10 +435,10 @@ const insertFolderCopyMutable = ({
export const duplicateFolder = (folderId: Folder["id"]) => {
const pages = $pages.get();
- const currentFolder = findParentFolderByChildId(
- folderId,
- pages?.folders ?? []
- );
+ const currentFolder =
+ pages === undefined
+ ? undefined
+ : findParentFolderByChildId(folderId, pages.folders);
if (currentFolder === undefined) {
return;
}
@@ -424,8 +452,8 @@ export const duplicateFolder = (folderId: Folder["id"]) => {
return newFolderId;
};
-export const isFolder = (id: string, folders: Array<Folder>) => {
- return folders.some((folder) => folder.id === id);
+export const isFolder = (id: string, folders: Pages["folders"]) => {
+ return folders.get(id) !== undefined;
};
type DropTarget = {
@@ -455,7 +483,8 @@ export const getStoredDropTarget = (
? undefined
: selector.at(-dropTarget.afterLevel - 1);
const pages = $pages.get();
- const parentFolder = pages?.folders.find((item) => item.id === parentId);
+ const parentFolder =
+ parentId === undefined ? undefined : pages?.folders.get(parentId);
let indexWithinChildren = 0;
if (parentFolder) {
const beforeIndex = parentFolder.children.indexOf(beforeId ?? "");
@@ -471,7 +500,8 @@ export const getStoredDropTarget = (
}
};
-export const canDrop = (dropTarget: DropTarget, folders: Folder[]) => {
+export const canDrop = (dropTarget: DropTarget, pages: Pages) => {
+ const { folders } = pages;
// allow dropping only inside folders
if (isFolder(dropTarget.parentId, folders) === false) {
return false;
@@ -479,8 +509,8 @@ export const canDrop = (dropTarget: DropTarget, folders: Folder[]) => {
// forbid dropping in the beginning of root folder
// which is always used by home page
if (
- isRootFolder({ id: dropTarget.parentId }) &&
- dropTarget.indexWithinChildren === 0
+ dropTarget.indexWithinChildren === 0 &&
+ dropTarget.parentId === pages.rootFolderId
) {
return false;
}
diff --git a/apps/builder/app/builder/features/pages/pages.tsx b/apps/builder/app/builder/features/pages/pages.tsx
index 9f69f98cd5..55f1e580de 100644
--- a/apps/builder/app/builder/features/pages/pages.tsx
+++ b/apps/builder/app/builder/features/pages/pages.tsx
@@ -57,11 +57,10 @@ import {
import { serverSyncStore } from "~/shared/sync/sync-stores";
import { useMount } from "~/shared/hook-utils/use-mount";
import {
- isRootFolder,
- ROOT_FOLDER_ID,
type Folder,
type Page,
findPageByIdOrPath,
+ getFolderById,
} from "@webstudio-is/sdk";
import { atom, computed } from "nanostores";
import { isPathnamePattern } from "~/builder/shared/url-pattern";
@@ -181,11 +180,8 @@ const $flatPagesTree = computed(
if (pagesData === undefined) {
return flatPagesTree;
}
- const folders = new Map(
- pagesData.folders.map((folder) => [folder.id, folder])
- );
- const pages = new Map(pagesData.pages.map((page) => [page.id, page]));
- pages.set(pagesData.homePage.id, pagesData.homePage);
+ const folders = pagesData.folders;
+ const pages = pagesData.pages;
const traverse = (selector: string[], level = 0, isLastChild = false) => {
const [itemId] = selector;
let treeItem: undefined | PagesTreeItem;
@@ -210,7 +206,7 @@ const $flatPagesTree = computed(
isExpanded = expandedItems.has(folder.id);
}
// hide root folder
- if (itemId !== ROOT_FOLDER_ID) {
+ if (itemId !== pagesData.rootFolderId) {
treeItem = {
id: itemId,
selector,
@@ -250,7 +246,7 @@ const $flatPagesTree = computed(
}
return lastTreeItem;
};
- traverse([ROOT_FOLDER_ID]);
+ traverse([pagesData.rootFolderId]);
return flatPagesTree;
}
);
@@ -315,7 +311,7 @@ const PagesTree = ({
}
// forbid dragging home page
- if (item.id === pages.homePage.id) {
+ if (item.id === pages.homePageId) {
toast.error("Home page cannot be moved");
return false;
}
@@ -329,10 +325,7 @@ const PagesTree = ({
item.selector,
dropTarget
);
- if (
- storedDropTarget &&
- canDrop(storedDropTarget, pages.folders)
- ) {
+ if (storedDropTarget && canDrop(storedDropTarget, pages)) {
$dropTarget.set(storedDropTarget);
}
} else {
@@ -371,11 +364,11 @@ const PagesTree = ({
}
},
...(item.type === "page" &&
- item.id !== pages?.homePage.id && {
+ item.id !== pages?.homePageId && {
"data-page-id": item.id,
}),
...(item.type === "folder" &&
- !isRootFolder({ id: item.id }) && {
+ item.id !== pages.rootFolderId && {
"data-folder-id": item.id,
}),
}}
@@ -397,7 +390,7 @@ const PagesTree = ({
{item.type === "page" && (
<TreeNodeLabel
prefix={
- item.id === pages?.homePage.id ? (
+ item.id === pages?.homePageId ? (
<HomeIcon />
) : isPathnamePattern(item.page.path) ? (
<DynamicPageIcon />
@@ -462,7 +455,7 @@ const PageEditor = ({
// switch to home page when deleted currently selected page
if (editingPageId === currentPage?.id) {
if (pages) {
- selectPage(pages.homePage.id);
+ selectPage(pages.homePageId);
}
}
};
@@ -531,7 +524,7 @@ const FolderEditor = ({
updateWebstudioData((data) => {
const { pageIds } = deleteFolderWithChildrenMutable(
folderIdToDelete,
- data.pages.folders
+ data.pages
);
pageIds.forEach((pageId) => {
deletePageMutable(pageId, data);
@@ -541,7 +534,8 @@ const FolderEditor = ({
onClose();
};
- const folder = pages?.folders.find(({ id }) => id === editingFolderId);
+ const folder =
+ pages === undefined ? undefined : getFolderById(pages, editingFolderId);
return (
<>
@@ -599,7 +593,7 @@ export const PagesPanel = ({ onClose }: { onClose: () => void }) => {
updateWebstudioData((data) => {
const { pageIds } = deleteFolderWithChildrenMutable(
folderIdToDelete,
- data.pages.folders
+ data.pages
);
pageIds.forEach((pageId) => {
deletePageMutable(pageId, data);
@@ -712,7 +706,7 @@ export const PagesPanel = ({ onClose }: { onClose: () => void }) => {
)}
{folderIdToDelete && (
<DeleteFolderConfirmationDialog
- folder={pages.folders.find(({ id }) => id === folderIdToDelete)!}
+ folder={getFolderById(pages, folderIdToDelete)!}
onClose={() => setFolderIdToDelete(undefined)}
onConfirm={handleDeleteFolderConfirm}
/>
diff --git a/apps/builder/app/builder/features/publish/publish.tsx b/apps/builder/app/builder/features/publish/publish.tsx
index c846cf6506..d278ebb4e9 100644
--- a/apps/builder/app/builder/features/publish/publish.tsx
+++ b/apps/builder/app/builder/features/publish/publish.tsx
@@ -76,7 +76,11 @@ import {
import { AddDomain } from "./add-domain";
import { humanizeString } from "~/shared/string-utils";
import { trpcClient, nativeClient } from "~/shared/trpc/trpc-client";
-import { isPathnamePattern, type Templates } from "@webstudio-is/sdk";
+import {
+ getAllPages,
+ isPathnamePattern,
+ type Templates,
+} from "@webstudio-is/sdk";
import { DomainCheckbox, domainToPublishName } from "./domain-checkbox";
import { CopyToClipboard } from "~/shared/copy-to-clipboard";
import { $openProjectSettings } from "~/shared/nano-states/project-settings";
@@ -343,7 +347,7 @@ const $restrictedFeatures = computed(
}
if (!permissions.allowDynamicData) {
// pages with dynamic paths
- for (const page of [pages.homePage, ...pages.pages]) {
+ for (const page of getAllPages(pages)) {
const navigate = {
pageId: page.id,
instanceSelector: [page.rootInstanceId],
diff --git a/apps/builder/app/builder/features/settings-panel/controls/url.tsx b/apps/builder/app/builder/features/settings-panel/controls/url.tsx
index 3337544f8b..dea9464cdf 100644
--- a/apps/builder/app/builder/features/settings-panel/controls/url.tsx
+++ b/apps/builder/app/builder/features/settings-panel/controls/url.tsx
@@ -20,10 +20,13 @@ import {
PageIcon,
PhoneIcon,
} from "@webstudio-is/icons";
-import type { Folder, Instance, Page } from "@webstudio-is/sdk";
import {
findParentFolderByChildId,
findTreeInstanceIds,
+ getAllPages,
+ type Folder,
+ type Instance,
+ type Page,
} from "@webstudio-is/sdk";
import { $instances, $pages, $props } from "~/shared/sync/data-stores";
import {
@@ -266,7 +269,7 @@ const BaseEmail = ({
const instancesPerPageStore = computed(
[$instances, $pages],
(instances, pages) =>
- (pages ? [pages.homePage, ...pages.pages] : []).map((page) => ({
+ (pages ? getAllPages(pages) : []).map((page) => ({
pageId: page.id,
instancesIds: findTreeInstanceIds(instances, page.rootInstanceId),
}))
@@ -310,7 +313,7 @@ const getInstanceId = (data: { instanceId: string }) => data.instanceId;
const BasePage = ({ prop, onChange }: BaseControlProps) => {
const pages = useStore($pages);
const { allPages, pageSelectOptions } = useMemo(() => {
- const allPages = pages ? [pages.homePage, ...pages.pages] : [];
+ const allPages = pages ? getAllPages(pages) : [];
const rootFolder = createRootFolder();
const pageSelectOptions = new Map<
Folder["id"],
diff --git a/apps/builder/app/builder/features/settings-panel/props-section/props-section.stories.tsx b/apps/builder/app/builder/features/settings-panel/props-section/props-section.stories.tsx
index 8f5e5b9edc..fa83fe6c34 100644
--- a/apps/builder/app/builder/features/settings-panel/props-section/props-section.stories.tsx
+++ b/apps/builder/app/builder/features/settings-panel/props-section/props-section.stories.tsx
@@ -1,5 +1,12 @@
import { useState } from "react";
-import type { PropMeta, Instance, Prop, Asset, Page } from "@webstudio-is/sdk";
+import {
+ getHomePage,
+ type PropMeta,
+ type Instance,
+ type Prop,
+ type Asset,
+ type Page,
+} from "@webstudio-is/sdk";
import {
Box,
Flex,
@@ -30,24 +37,34 @@ const page = (name: string, path: string): Page => ({
rootInstanceId: unique(),
});
-$pages.set({
- ...createDefaultPages({ rootInstanceId: unique() }),
- homePage: page("Home", "") as Page & { path: "" },
- pages: [
- page("About", "/about"),
- page("Pricing", "/pricing"),
- page("Contacts", "/contacts"),
- ],
-});
+const pages = createDefaultPages({ rootInstanceId: unique() });
+const homePage = page("Home", "") as Page & { path: "" };
+const aboutPage = page("About", "/about");
+const pricingPage = page("Pricing", "/pricing");
+const contactsPage = page("Contacts", "/contacts");
+pages.homePageId = homePage.id;
+pages.pages = new Map([
+ [homePage.id, homePage],
+ [aboutPage.id, aboutPage],
+ [pricingPage.id, pricingPage],
+ [contactsPage.id, contactsPage],
+]);
+pages.folders.get(pages.rootFolderId)!.children = [
+ homePage.id,
+ aboutPage.id,
+ pricingPage.id,
+ contactsPage.id,
+];
+$pages.set(pages);
const getSectionInstanceId = (
name: string,
- page: Page = $pages.get()?.homePage as Page
+ page: Page = getHomePage($pages.get() ?? pages)
) => (page === undefined ? "" : `${page.id}-${name}`);
const addLinkableSections = (
names: string[],
- page: Page = $pages.get()?.homePage as Page
+ page: Page = getHomePage($pages.get() ?? pages)
) => {
if (page === undefined) {
return;
@@ -89,9 +106,9 @@ const addLinkableSections = (
addLinkableSections(["contacts", "about"]);
const rootInstance = addLinkableSections(
["company", "employees"],
- $pages.get()?.pages[0]
+ Object.values($pages.get()?.pages ?? {})[1]
);
-$selectedPageId.set($pages.get()?.homePage.id ?? "");
+$selectedPageId.set($pages.get()?.homePageId ?? "");
const instance: Instance = {
id: instanceId,
@@ -325,7 +342,7 @@ const startingProps: Prop[] = [
instanceId,
name: "addedUrlPage",
type: "page",
- value: $pages.get()?.pages[0].id ?? "",
+ value: Object.values($pages.get()?.pages ?? {})[1]?.id ?? "",
},
{
id: unique(),
@@ -333,7 +350,7 @@ const startingProps: Prop[] = [
name: "addedUrlSection",
type: "page",
value: {
- pageId: $pages.get()?.homePage.id ?? "",
+ pageId: $pages.get()?.homePageId ?? "",
instanceId: getSectionInstanceId("about"),
},
},
diff --git a/apps/builder/app/builder/shared/asset-manager/asset-info.test.ts b/apps/builder/app/builder/shared/asset-manager/asset-info.test.ts
index 9e12b396a0..451f0a889e 100644
--- a/apps/builder/app/builder/shared/asset-manager/asset-info.test.ts
+++ b/apps/builder/app/builder/shared/asset-manager/asset-info.test.ts
@@ -1,5 +1,5 @@
import { describe, test, expect } from "vitest";
-import type { Pages, Props, Styles, Asset } from "@webstudio-is/sdk";
+import type { Pages, Props, Styles, Asset, Page } from "@webstudio-is/sdk";
import type {
ImageValue,
FontFamilyValue,
@@ -9,6 +9,45 @@ import { __testing__ } from "./asset-info";
const { traverseStyleValue, calculateUsagesByAssetId } = __testing__;
+const createPages = ({
+ meta = {},
+ homeMeta = {},
+ pages = new Map(),
+}: {
+ meta?: Pages["meta"];
+ homeMeta?: Page["meta"];
+ pages?: Map<Page["id"], Page>;
+} = {}): Pages => ({
+ meta,
+ homePageId: "home",
+ rootFolderId: "root",
+ pages: new Map([
+ [
+ "home",
+ {
+ id: "home",
+ name: "Home",
+ path: "",
+ title: "Home",
+ meta: homeMeta,
+ rootInstanceId: "root",
+ },
+ ],
+ ...pages,
+ ]),
+ folders: new Map([
+ [
+ "root",
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["home", ...pages.keys()],
+ },
+ ],
+ ]),
+});
+
describe("asset-info", () => {
describe("traverseStyleValue", () => {
test("calls callback for image values", () => {
@@ -98,19 +137,9 @@ describe("asset-info", () => {
describe("calculateUsagesByAssetId", () => {
test("tracks favicon asset usage", () => {
- const pages: Pages = {
+ const pages = createPages({
meta: { faviconAssetId: "favicon-asset" },
- homePage: {
- id: "home",
- name: "Home",
- path: "",
- title: "Home",
- meta: {},
- rootInstanceId: "root",
- },
- pages: [],
- folders: [],
- };
+ });
const props: Props = new Map();
const styles: Styles = new Map();
const assets = new Map<Asset["id"], Asset>();
@@ -121,19 +150,9 @@ describe("asset-info", () => {
});
test("tracks social image asset usage", () => {
- const pages: Pages = {
- meta: {},
- homePage: {
- id: "home",
- name: "Home",
- path: "",
- title: "Home",
- meta: { socialImageAssetId: "social-asset" },
- rootInstanceId: "root",
- },
- pages: [],
- folders: [],
- };
+ const pages = createPages({
+ homeMeta: { socialImageAssetId: "social-asset" },
+ });
const props: Props = new Map();
const styles: Styles = new Map();
const assets = new Map<Asset["id"], Asset>();
@@ -146,29 +165,22 @@ describe("asset-info", () => {
});
test("tracks marketplace thumbnail asset usage", () => {
- const pages: Pages = {
- meta: {},
- homePage: {
- id: "home",
- name: "Home",
- path: "",
- title: "Home",
- meta: {},
- rootInstanceId: "root",
- },
- pages: [
- {
- id: "page-1",
- name: "Page 1",
- path: "/page-1",
- title: "Page 1",
- meta: {},
- rootInstanceId: "root-1",
- marketplace: { thumbnailAssetId: "thumbnail-asset" },
- },
- ],
- folders: [],
- };
+ const pages = createPages({
+ pages: new Map([
+ [
+ "page-1",
+ {
+ id: "page-1",
+ name: "Page 1",
+ path: "/page-1",
+ title: "Page 1",
+ meta: {},
+ rootInstanceId: "root-1",
+ marketplace: { thumbnailAssetId: "thumbnail-asset" },
+ },
+ ],
+ ]),
+ });
const props: Props = new Map();
const styles: Styles = new Map();
const assets = new Map<Asset["id"], Asset>();
@@ -181,19 +193,7 @@ describe("asset-info", () => {
});
test("tracks prop asset usage", () => {
- const pages: Pages = {
- meta: {},
- homePage: {
- id: "home",
- name: "Home",
- path: "",
- title: "Home",
- meta: {},
- rootInstanceId: "root",
- },
- pages: [],
- folders: [],
- };
+ const pages = createPages();
const props: Props = new Map([
[
"prop-1",
@@ -217,19 +217,7 @@ describe("asset-info", () => {
});
test("ignores width and height props", () => {
- const pages: Pages = {
- meta: {},
- homePage: {
- id: "home",
- name: "Home",
- path: "",
- title: "Home",
- meta: {},
- rootInstanceId: "root",
- },
- pages: [],
- folders: [],
- };
+ const pages = createPages();
const props: Props = new Map([
[
"prop-width",
@@ -261,19 +249,7 @@ describe("asset-info", () => {
});
test("tracks image asset usage in styles", () => {
- const pages: Pages = {
- meta: {},
- homePage: {
- id: "home",
- name: "Home",
- path: "",
- title: "Home",
- meta: {},
- rootInstanceId: "root",
- },
- pages: [],
- folders: [],
- };
+ const pages = createPages();
const props: Props = new Map();
const styles: Styles = new Map([
[
@@ -299,19 +275,7 @@ describe("asset-info", () => {
});
test("returns empty map when no usages", () => {
- const pages: Pages = {
- meta: {},
- homePage: {
- id: "home",
- name: "Home",
- path: "",
- title: "Home",
- meta: {},
- rootInstanceId: "root",
- },
- pages: [],
- folders: [],
- };
+ const pages = createPages();
const props: Props = new Map();
const styles: Styles = new Map();
const assets = new Map<Asset["id"], Asset>();
@@ -322,19 +286,10 @@ describe("asset-info", () => {
});
test("aggregates multiple usages for same asset", () => {
- const pages: Pages = {
+ const pages = createPages({
meta: { faviconAssetId: "asset-1" },
- homePage: {
- id: "home",
- name: "Home",
- path: "",
- title: "Home",
- meta: { socialImageAssetId: "asset-1" },
- rootInstanceId: "root",
- },
- pages: [],
- folders: [],
- };
+ homeMeta: { socialImageAssetId: "asset-1" },
+ });
const props: Props = new Map([
[
"prop-1",
@@ -386,19 +341,7 @@ describe("asset-info", () => {
});
test("tracks multiple assets in tuple style value", () => {
- const pages: Pages = {
- meta: {},
- homePage: {
- id: "home",
- name: "Home",
- path: "",
- title: "Home",
- meta: {},
- rootInstanceId: "root",
- },
- pages: [],
- folders: [],
- };
+ const pages = createPages();
const props: Props = new Map();
const styles: Styles = new Map([
[
@@ -436,19 +379,7 @@ describe("asset-info", () => {
});
test("tracks font asset usage in fontFamily styles", () => {
- const pages: Pages = {
- meta: {},
- homePage: {
- id: "home",
- name: "Home",
- path: "",
- title: "Home",
- meta: {},
- rootInstanceId: "root",
- },
- pages: [],
- folders: [],
- };
+ const pages = createPages();
const props: Props = new Map();
const styles: Styles = new Map([
[
@@ -488,19 +419,7 @@ describe("asset-info", () => {
});
test("tracks multiple font assets in same fontFamily style", () => {
- const pages: Pages = {
- meta: {},
- homePage: {
- id: "home",
- name: "Home",
- path: "",
- title: "Home",
- meta: {},
- rootInstanceId: "root",
- },
- pages: [],
- folders: [],
- };
+ const pages = createPages();
const props: Props = new Map();
const styles: Styles = new Map([
[
@@ -556,19 +475,7 @@ describe("asset-info", () => {
});
test("ignores font families without matching assets", () => {
- const pages: Pages = {
- meta: {},
- homePage: {
- id: "home",
- name: "Home",
- path: "",
- title: "Home",
- meta: {},
- rootInstanceId: "root",
- },
- pages: [],
- folders: [],
- };
+ const pages = createPages();
const props: Props = new Map();
const styles: Styles = new Map([
[
@@ -592,19 +499,7 @@ describe("asset-info", () => {
});
test("tracks same font used in multiple styles", () => {
- const pages: Pages = {
- meta: {},
- homePage: {
- id: "home",
- name: "Home",
- path: "",
- title: "Home",
- meta: {},
- rootInstanceId: "root",
- },
- pages: [],
- folders: [],
- };
+ const pages = createPages();
const props: Props = new Map();
const styles: Styles = new Map([
[
diff --git a/apps/builder/app/builder/shared/asset-manager/asset-info.tsx b/apps/builder/app/builder/shared/asset-manager/asset-info.tsx
index 5fcfba9be9..ddad968432 100644
--- a/apps/builder/app/builder/shared/asset-manager/asset-info.tsx
+++ b/apps/builder/app/builder/shared/asset-manager/asset-info.tsx
@@ -4,7 +4,11 @@ import { useDebouncedCallback } from "use-debounce";
import prettyBytes from "pretty-bytes";
import { computed } from "nanostores";
import { useStore } from "@nanostores/react";
-import { getMimeTypeByExtension, IMAGE_MIME_TYPES } from "@webstudio-is/sdk";
+import {
+ getAllPages,
+ getMimeTypeByExtension,
+ IMAGE_MIME_TYPES,
+} from "@webstudio-is/sdk";
import type { Asset, Pages, Props, Styles, Instance } from "@webstudio-is/sdk";
import type {
ImageValue,
@@ -134,7 +138,7 @@ export const calculateUsagesByAssetId = ({
usages.push({ type: "favicon" });
}
if (pages) {
- for (const page of [pages.homePage, ...pages.pages]) {
+ for (const page of getAllPages(pages)) {
if (page.meta.socialImageAssetId) {
const usages = mapGetOrInsert(
usagesByAsset,
diff --git a/apps/builder/app/builder/shared/assets/replace-asset.ts b/apps/builder/app/builder/shared/assets/replace-asset.ts
index 1a371cf05e..8837195d0b 100644
--- a/apps/builder/app/builder/shared/assets/replace-asset.ts
+++ b/apps/builder/app/builder/shared/assets/replace-asset.ts
@@ -1,4 +1,4 @@
-import type { Asset } from "@webstudio-is/sdk";
+import { getAllPages, type Asset } from "@webstudio-is/sdk";
import { toast } from "@webstudio-is/design-system";
import { $assets, $pages, $props, $styles } from "~/shared/sync/data-stores";
import { serverSyncStore } from "~/shared/sync/sync-stores";
@@ -58,7 +58,7 @@ export const replaceAsset = async (
if (pages.meta?.faviconAssetId === oldAssetId) {
pages.meta.faviconAssetId = newAssetId;
}
- for (const page of [pages.homePage, ...pages.pages]) {
+ for (const page of getAllPages(pages)) {
if (page.meta.socialImageAssetId === oldAssetId) {
page.meta.socialImageAssetId = newAssetId;
}
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index 601b5ad4a4..932e4bd9d6 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -118,7 +118,7 @@ const useElementsTree = (components: Components, instances: Instances) => {
console.info({
$assets: $assets.get().size,
- $pages: $pages.get()?.pages.length ?? 0,
+ $pages: $pages.get()?.pages.size ?? 0,
$instances: $instances.get().size,
});
}
diff --git a/apps/builder/app/canvas/features/text-editor/text-editor.stories.tsx b/apps/builder/app/canvas/features/text-editor/text-editor.stories.tsx
index 92858674a2..f1b40b7364 100644
--- a/apps/builder/app/canvas/features/text-editor/text-editor.stories.tsx
+++ b/apps/builder/app/canvas/features/text-editor/text-editor.stories.tsx
@@ -221,25 +221,43 @@ export const CursorPositioning: StoryFn<typeof TextEditor> = () => {
export const CursorPositioningUpDown: StoryFn<typeof TextEditor> = () => {
const [{ instances }, setState] = useState(() => {
$pages.set({
- folders: [],
- homePage: {
- id: "homePageId",
- rootInstanceId: "bodyId",
- meta: {},
- path: "",
- title: "",
- name: "",
- },
- pages: [
- {
- id: "pageId",
- rootInstanceId: "bodyId",
- path: "",
- title: "",
- name: "",
- meta: {},
- },
- ],
+ homePageId: "homePageId",
+ rootFolderId: "root",
+ folders: new Map([
+ [
+ "root",
+ {
+ id: "root",
+ name: "",
+ slug: "",
+ children: ["homePageId", "pageId"],
+ },
+ ],
+ ]),
+ pages: new Map([
+ [
+ "homePageId",
+ {
+ id: "homePageId",
+ rootInstanceId: "bodyId",
+ meta: {},
+ path: "",
+ title: "",
+ name: "",
+ },
+ ],
+ [
+ "pageId",
+ {
+ id: "pageId",
+ rootInstanceId: "bodyId",
+ path: "",
+ title: "",
+ name: "",
+ meta: {},
+ },
+ ],
+ ]),
});
$selectedPageId.set("pageId");
diff --git a/apps/builder/app/canvas/interceptor.ts b/apps/builder/app/canvas/interceptor.ts
index 4aa5982966..da3df0a657 100644
--- a/apps/builder/app/canvas/interceptor.ts
+++ b/apps/builder/app/canvas/interceptor.ts
@@ -1,4 +1,4 @@
-import { getPagePath, isAbsoluteUrl } from "@webstudio-is/sdk";
+import { getAllPages, getPagePath, isAbsoluteUrl } from "@webstudio-is/sdk";
import {
compilePathnamePattern,
matchPathnamePattern,
@@ -46,8 +46,8 @@ const switchPageAndUpdateSystem = (href: string, formData?: FormData) => {
}
const pageHref = new URL(href, "https://any-valid.url");
// sort pages before matching to not depend on order of page creation
- const sortedPages = [pages.homePage, ...pages.pages].toSorted(
- (leftPage, rightPage) => comparePatterns(leftPage.path, rightPage.path)
+ const sortedPages = getAllPages(pages).toSorted((leftPage, rightPage) =>
+ comparePatterns(leftPage.path, rightPage.path)
);
for (const page of sortedPages) {
const pagePath = getPagePath(page.id, pages);
diff --git a/apps/builder/app/env/env.static.ts b/apps/builder/app/env/env.static.ts
index 3f5169a110..2bfb634998 100644
--- a/apps/builder/app/env/env.static.ts
+++ b/apps/builder/app/env/env.static.ts
@@ -3,6 +3,9 @@
*
* These variables are injected into your bundle at build time based on the environment settings.
* - Configuration: See envPrefix in [vite.config.ts](../../vite.config.ts) (GITHUB_)
+ * - CI: GitHub Actions runs `vercel build` locally, so each variable used here must be
+ * exported in .github/actions/vercel/action.yaml
+ * before the build step.
* - Documentation: Refer to the [Vite documentation](https://vitejs.dev/guide/env-and-mode)
* - Type Definitions: See [vite-env.d.ts](./vite-env.d.ts) in this directory
*/
diff --git a/apps/builder/app/routes/rest.build-version.ts b/apps/builder/app/routes/rest.build-version.ts
deleted file mode 100644
index a511cffd41..0000000000
--- a/apps/builder/app/routes/rest.build-version.ts
+++ /dev/null
@@ -1,21 +0,0 @@
-import type { LoaderFunctionArgs } from "@remix-run/server-runtime";
-import { json } from "@remix-run/server-runtime";
-import { loadRawBuildById } from "@webstudio-is/project-build/index.server";
-import { createContext } from "~/shared/context.server";
-import { preventCrossOriginCookie } from "~/services/no-cross-origin-cookie";
-
-export const loader = async ({ request }: LoaderFunctionArgs) => {
- preventCrossOriginCookie(request);
-
- const url = new URL(request.url);
- const buildId = url.searchParams.get("buildId");
-
- if (!buildId) {
- throw new Response("Missing buildId", { status: 400 });
- }
-
- const context = await createContext(request);
- const build = await loadRawBuildById(context, buildId);
-
- return json({ version: build.version });
-};
diff --git a/apps/builder/app/routes/rest.build.$buildId.tsx b/apps/builder/app/routes/rest.build.$buildId.tsx
deleted file mode 100644
index d419cec4e1..0000000000
--- a/apps/builder/app/routes/rest.build.$buildId.tsx
+++ /dev/null
@@ -1,79 +0,0 @@
-import {
- json,
- type LoaderFunctionArgs,
- type TypedResponse,
-} from "@remix-run/server-runtime";
-import type { Data } from "@webstudio-is/http-client";
-import * as projectApi from "@webstudio-is/project/index.server";
-import { loadProductionCanvasData } from "~/shared/db";
-import { createContext } from "~/shared/context.server";
-import { getUserById, type User } from "~/shared/db/user.server";
-import { preventCrossOriginCookie } from "~/services/no-cross-origin-cookie";
-import { allowedDestinations } from "~/services/destinations.server";
-import { isDashboard } from "~/shared/router-utils";
-import { parseError } from "~/shared/error/error-parse";
-
-export const loader = async ({
- params,
- request,
-}: LoaderFunctionArgs): Promise<
- | (Data & { user: { email: User["email"] } | undefined } & {
- projectDomain: string;
- projectTitle: string;
- })
- | TypedResponse<{ error: string; message: string }>
-> => {
- if (false === isDashboard(request)) {
- throw new Response("Not Found", {
- status: 404,
- });
- }
-
- preventCrossOriginCookie(request);
- allowedDestinations(request, ["document", "empty"]);
- // CSRF token checks are not necessary for dashboard-only pages.
- // All requests from the builder or canvas app are safeguarded either by preventCrossOriginCookie for fetch requests
- // or by allowedDestinations for iframe requests.
-
- try {
- const buildId = params.buildId;
-
- if (buildId === undefined) {
- throw json("Required build id", { status: 400 });
- }
-
- const context = await createContext(request);
-
- const pagesCanvasData = await loadProductionCanvasData(buildId, context);
-
- const project = await projectApi.loadById(
- pagesCanvasData.build.projectId,
- context
- );
-
- const user =
- project === null || project.userId === null
- ? undefined
- : await getUserById(context, project.userId);
-
- return {
- ...pagesCanvasData,
- user: user ? { email: user.email } : undefined,
- projectDomain: project.domain,
- projectTitle: project.title,
- };
- } catch (error) {
- // If a Response is thrown, we're rethrowing it for Remix to handle.
- // https://remix.run/docs/en/v1/api/conventions#throwing-responses-in-loaders
- if (error instanceof Response) {
- throw error;
- }
-
- console.error(error);
-
- // We have no idea what happened, so we'll return a 500 error.
- throw json(parseError(error), {
- status: 500,
- });
- }
-};
diff --git a/apps/builder/app/routes/rest.buildId.$projectId.tsx b/apps/builder/app/routes/rest.buildId.$projectId.tsx
deleted file mode 100644
index 30b012826e..0000000000
--- a/apps/builder/app/routes/rest.buildId.$projectId.tsx
+++ /dev/null
@@ -1,62 +0,0 @@
-import {
- json,
- type LoaderFunctionArgs,
- type TypedResponse,
-} from "@remix-run/server-runtime";
-import * as projectApi from "@webstudio-is/project/index.server";
-import { allowedDestinations } from "~/services/destinations.server";
-import { preventCrossOriginCookie } from "~/services/no-cross-origin-cookie";
-import { createContext } from "~/shared/context.server";
-import { parseError } from "~/shared/error/error-parse";
-import { isDashboard } from "~/shared/router-utils";
-
-// This loader is only accessible from the dashboard origin
-// and is used exclusively for the CLI.
-export const loader = async ({
- params,
- request,
-}: LoaderFunctionArgs): Promise<
- { buildId: string | null } | TypedResponse<{ error: string; message: string }>
-> => {
- if (false === isDashboard(request)) {
- throw new Response("Not Found", {
- status: 404,
- });
- }
-
- preventCrossOriginCookie(request);
- allowedDestinations(request, ["document", "empty"]);
- // CSRF token checks are not necessary for dashboard-only pages.
- // All requests from the builder or canvas app are safeguarded either by preventCrossOriginCookie for fetch requests
- // or by allowedDestinations for iframe requests.
-
- try {
- const projectId = params.projectId;
-
- if (projectId === undefined) {
- throw json("Required project id", { status: 400 });
- }
-
- // @todo Create a context without user authentication information.
- const context = await createContext(request);
-
- const project = await projectApi.loadById(projectId, context);
- const buildId = project.latestBuildVirtual?.buildId ?? null;
-
- return {
- buildId,
- };
- } catch (error) {
- // If a Response is thrown, we're rethrowing it for Remix to handle.
- // https://remix.run/docs/en/v1/api/conventions#throwing-responses-in-loaders
- if (error instanceof Response) {
- throw error;
- }
-
- console.error(error);
-
- throw json(parseError(error), {
- status: 500,
- });
- }
-};
diff --git a/apps/builder/app/routes/rest.data.$projectId.ts b/apps/builder/app/routes/rest.data.$projectId.ts
index 2e36c8a12f..7ee4c96c52 100644
--- a/apps/builder/app/routes/rest.data.$projectId.ts
+++ b/apps/builder/app/routes/rest.data.$projectId.ts
@@ -1,6 +1,7 @@
import type { LoaderFunctionArgs } from "@remix-run/server-runtime";
import * as projectApi from "@webstudio-is/project/index.server";
import { loadDevBuildByProjectId } from "@webstudio-is/project-build/index.server";
+import { serializePages } from "@webstudio-is/sdk";
import { loadAssetsByProject } from "@webstudio-is/asset-uploader/index.server";
import { createContext } from "~/shared/context.server";
import { preventCrossOriginCookie } from "~/services/no-cross-origin-cookie";
@@ -28,6 +29,7 @@ export const loader = async ({ params, request }: LoaderFunctionArgs) => {
const assets = await loadAssetsByProject(project.id, context);
return {
...build,
+ pages: serializePages(build.pages),
assets,
project,
publisherHost: env.PUBLISHER_HOST,
diff --git a/apps/builder/app/routes/trpc.$.ts b/apps/builder/app/routes/trpc.$.ts
index e9b4b5c9bf..78c9311413 100644
--- a/apps/builder/app/routes/trpc.$.ts
+++ b/apps/builder/app/routes/trpc.$.ts
@@ -9,10 +9,16 @@ const isServiceRequest = (request: Request) => {
return isServiceAuthorization(request.headers.get("Authorization"));
};
+const isAuthTokenRequest = (request: Request) => {
+ return request.headers.has("x-auth-token");
+};
+
export const action = async ({ request }: ActionFunctionArgs) => {
if (isServiceRequest(request) === false) {
preventCrossOriginCookie(request);
- await checkCsrf(request);
+ if (isAuthTokenRequest(request) === false) {
+ await checkCsrf(request);
+ }
}
// https://trpc.io/docs/server/adapters/fetch
diff --git a/apps/builder/app/services/build-router.server.ts b/apps/builder/app/services/build-router.server.ts
index 40d855af93..41c9815be0 100644
--- a/apps/builder/app/services/build-router.server.ts
+++ b/apps/builder/app/services/build-router.server.ts
@@ -18,6 +18,10 @@ import {
} from "~/shared/sync/patch/patch-service.server";
import { normalizePatchRequest } from "~/shared/sync/patch/patch-normalize.server";
import type { BuildPatchTransaction } from "@webstudio-is/project/index.server";
+import {
+ loadPublishedProjectDataByBuildId,
+ loadPublishedProjectDataByProjectId,
+} from "~/shared/db";
const patchEntryInput = z.object({
seq: z.number().optional(),
@@ -93,6 +97,18 @@ const assertRelayPatchContext = (
};
export const buildRouter = router({
+ loadProjectDataByBuildId: procedure
+ .input(z.object({ buildId: z.string() }))
+ .query(async ({ ctx, input }) => {
+ return await loadPublishedProjectDataByBuildId(input.buildId, ctx);
+ }),
+
+ loadProjectDataByProjectId: procedure
+ .input(z.object({ projectId: z.string() }))
+ .query(async ({ ctx, input }) => {
+ return await loadPublishedProjectDataByProjectId(input.projectId, ctx);
+ }),
+
createCollabToken: procedure
.input(
z.object({
diff --git a/apps/builder/app/shared/builder-data.ts b/apps/builder/app/shared/builder-data.ts
index 47d7673bb9..146f1e5a27 100644
--- a/apps/builder/app/shared/builder-data.ts
+++ b/apps/builder/app/shared/builder-data.ts
@@ -1,4 +1,8 @@
-import { getStyleDeclKey, type WebstudioData } from "@webstudio-is/sdk";
+import {
+ getStyleDeclKey,
+ migratePages,
+ type WebstudioData,
+} from "@webstudio-is/sdk";
import type { MarketplaceProduct } from "@webstudio-is/project-build";
import type { Project } from "@webstudio-is/project";
import type { loader } from "~/routes/rest.data.$projectId";
@@ -83,7 +87,7 @@ export const loadBuilderData = async ({
dataSources: new Map(data.dataSources.map(getPair)),
resources: new Map(data.resources.map(getPair)),
props: new Map(data.props.map(getPair)),
- pages: data.pages,
+ pages: migratePages(data.pages),
breakpoints: new Map(data.breakpoints.map(getPair)),
styleSources: new Map(data.styleSources.map(getPair)),
styleSourceSelections: new Map(
diff --git a/apps/builder/app/shared/data-variables.test.tsx b/apps/builder/app/shared/data-variables.test.tsx
index 5e764c8050..50d3e2cf6f 100644
--- a/apps/builder/app/shared/data-variables.test.tsx
+++ b/apps/builder/app/shared/data-variables.test.tsx
@@ -11,6 +11,8 @@ import {
} from "@webstudio-is/template";
import {
encodeDataVariableId,
+ getAllPages,
+ getHomePage,
ROOT_INSTANCE_ID,
SYSTEM_VARIABLE_ID,
} from "@webstudio-is/sdk";
@@ -770,7 +772,7 @@ test("prevent rebinding with variables outside of slot content scope", () => {
test("unset global variables on all pages when delete", () => {
const globalVariable = new Variable("globalVariable", "");
const pages = createDefaultPages({ rootInstanceId: "homeBodyId" });
- pages.pages.push({
+ pages.pages.set("aboutPage", {
id: "",
name: "",
path: "",
@@ -839,8 +841,9 @@ test("unset body variables in page meta when delete", () => {
expect(data.dataSources.size).toEqual(1);
const [bodyVariableId] = data.dataSources.keys();
const bodyIdentifier = encodeDataVariableId(bodyVariableId);
- data.pages.homePage.title = bodyIdentifier;
- data.pages.homePage.meta = {
+ const homePage = getHomePage(data.pages);
+ homePage.title = bodyIdentifier;
+ homePage.meta = {
description: bodyIdentifier,
excludePageFromSearch: bodyIdentifier,
socialImageUrl: bodyIdentifier,
@@ -850,16 +853,14 @@ test("unset body variables in page meta when delete", () => {
custom: [{ property: "auth", content: bodyIdentifier }],
};
deleteVariableMutable(data, bodyVariableId);
- expect(data.pages.homePage.title).toEqual(`bodyVariable`);
- expect(data.pages.homePage.meta.description).toEqual(`bodyVariable`);
- expect(data.pages.homePage.meta.excludePageFromSearch).toEqual(
- `bodyVariable`
- );
- expect(data.pages.homePage.meta.socialImageUrl).toEqual(`bodyVariable`);
- expect(data.pages.homePage.meta.language).toEqual(`bodyVariable`);
- expect(data.pages.homePage.meta.status).toEqual(`bodyVariable`);
- expect(data.pages.homePage.meta.redirect).toEqual(`bodyVariable`);
- expect(data.pages.homePage.meta.custom?.[0].content).toEqual(`bodyVariable`);
+ expect(homePage.title).toEqual(`bodyVariable`);
+ expect(homePage.meta.description).toEqual(`bodyVariable`);
+ expect(homePage.meta.excludePageFromSearch).toEqual(`bodyVariable`);
+ expect(homePage.meta.socialImageUrl).toEqual(`bodyVariable`);
+ expect(homePage.meta.language).toEqual(`bodyVariable`);
+ expect(homePage.meta.status).toEqual(`bodyVariable`);
+ expect(homePage.meta.redirect).toEqual(`bodyVariable`);
+ expect(homePage.meta.custom?.[0].content).toEqual(`bodyVariable`);
});
test("unset global variables in all pages meta when delete", () => {
@@ -874,7 +875,7 @@ test("unset global variables in all pages meta when delete", () => {
),
};
data.instances.delete(ROOT_INSTANCE_ID);
- data.pages.pages.push({
+ data.pages.pages.set("aboutPage", {
id: "",
name: "",
path: "",
@@ -885,7 +886,7 @@ test("unset global variables in all pages meta when delete", () => {
expect(data.dataSources.size).toEqual(1);
const [globalVariableId] = data.dataSources.keys();
const globalIdentifier = encodeDataVariableId(globalVariableId);
- for (const page of [data.pages.homePage, ...data.pages.pages]) {
+ for (const page of getAllPages(data.pages)) {
page.title = globalIdentifier;
page.meta = {
description: globalIdentifier,
@@ -898,7 +899,7 @@ test("unset global variables in all pages meta when delete", () => {
};
}
deleteVariableMutable(data, globalVariableId);
- for (const page of [data.pages.homePage, ...data.pages.pages]) {
+ for (const page of getAllPages(data.pages)) {
expect(page.title).toEqual(`globalVariable`);
expect(page.meta.description).toEqual(`globalVariable`);
expect(page.meta.excludePageFromSearch).toEqual(`globalVariable`);
@@ -965,7 +966,7 @@ test("find variable usages from root includes all pages", () => {
),
};
data.instances.delete(ROOT_INSTANCE_ID);
- data.pages.pages.push({
+ data.pages.pages.set("aboutPage", {
id: "aboutPage",
name: "About",
path: "/about",
@@ -998,8 +999,9 @@ test("find variable usages in page meta", () => {
const [bodyVariableId] = data.dataSources.keys();
const bodyIdentifier = encodeDataVariableId(bodyVariableId);
- data.pages.homePage.title = bodyIdentifier;
- data.pages.homePage.meta = {
+ const homePage = getHomePage(data.pages);
+ homePage.title = bodyIdentifier;
+ homePage.meta = {
description: bodyIdentifier,
excludePageFromSearch: bodyIdentifier,
socialImageUrl: bodyIdentifier,
diff --git a/apps/builder/app/shared/data-variables.ts b/apps/builder/app/shared/data-variables.ts
index ab0acc0e9f..c9e31dda38 100644
--- a/apps/builder/app/shared/data-variables.ts
+++ b/apps/builder/app/shared/data-variables.ts
@@ -15,6 +15,7 @@ import {
encodeDataVariableId,
findTreeInstanceIds,
findTreeInstanceIdsExcludingSlotDescendants,
+ getAllPages,
getExpressionIdentifiers,
systemParameter,
transpileExpression,
@@ -300,7 +301,7 @@ const traverseExpressions = ({
args?: string[]
) => void | string;
}) => {
- const pagesList = pages ? [pages.homePage, ...pages.pages] : [];
+ const pagesList = pages ? getAllPages(pages) : [];
let instanceIds = findTreeInstanceIdsExcludingSlotDescendants(
instances,
diff --git a/apps/builder/app/shared/db/canvas.server.ts b/apps/builder/app/shared/db/canvas.server.ts
index 4686e3a7fc..9ca3bbae19 100644
--- a/apps/builder/app/shared/db/canvas.server.ts
+++ b/apps/builder/app/shared/db/canvas.server.ts
@@ -2,18 +2,33 @@ import type { Data } from "@webstudio-is/http-client";
import { loadBuildById } from "@webstudio-is/project-build/index.server";
import { loadAssetsByProject } from "@webstudio-is/asset-uploader/index.server";
import type { AppContext } from "@webstudio-is/trpc-interface/index.server";
-import { findPageByIdOrPath, getStyleDeclKey } from "@webstudio-is/sdk";
+import {
+ findPageByIdOrPath,
+ getAllPages,
+ getStyleDeclKey,
+ serializePages,
+} from "@webstudio-is/sdk";
import * as projectApi from "@webstudio-is/project/index.server";
+import { getUserById, type User } from "./user.server";
+
+export type PublishedProjectData = Data & {
+ user: { email: User["email"] } | undefined;
+ projectDomain: string;
+ projectTitle: string;
+};
const getPair = <Item extends { id: string }>(item: Item): [string, Item] => [
item.id,
item,
];
-export const loadProductionCanvasData = async (
+type Project = NonNullable<Awaited<ReturnType<typeof projectApi.loadById>>>;
+
+const loadProductionCanvasDataAndProject = async (
buildId: string,
- context: AppContext
-): Promise<Data> => {
+ context: AppContext,
+ project?: Project
+): Promise<{ data: Data; project: Project }> => {
const build = await loadBuildById(context, buildId);
if (build === undefined) {
@@ -26,7 +41,10 @@ export const loadProductionCanvasData = async (
throw new Error("The project is not published");
}
- const project = await projectApi.loadById(build.projectId, context);
+ project = project ?? (await projectApi.loadById(build.projectId, context));
+ if (project === null) {
+ throw new Error(`Project "${build.projectId}" not found`);
+ }
const currentProjectDomains = project.domainsVirtual;
@@ -72,28 +90,90 @@ export const loadProductionCanvasData = async (
);
return {
- build: {
- id: build.id,
- projectId: build.projectId,
- version: build.version,
- createdAt: build.createdAt,
- updatedAt: build.updatedAt,
- pages: build.pages,
- breakpoints: build.breakpoints.map(getPair),
- styles: build.styles.map((item) => [getStyleDeclKey(item), item]),
- styleSources: build.styleSources.map(getPair),
- styleSourceSelections: build.styleSourceSelections.map((item) => [
- item.instanceId,
- item,
- ]),
- props: build.props.map(getPair),
- dataSources: build.dataSources.map(getPair),
- resources: build.resources.map(getPair),
- instances: build.instances.map(getPair),
- deployment,
+ data: {
+ build: {
+ id: build.id,
+ projectId: build.projectId,
+ version: build.version,
+ createdAt: build.createdAt,
+ updatedAt: build.updatedAt,
+ pages: serializePages(build.pages),
+ breakpoints: build.breakpoints.map(getPair),
+ styles: build.styles.map((item) => [getStyleDeclKey(item), item]),
+ styleSources: build.styleSources.map(getPair),
+ styleSourceSelections: build.styleSourceSelections.map((item) => [
+ item.instanceId,
+ item,
+ ]),
+ props: build.props.map(getPair),
+ dataSources: build.dataSources.map(getPair),
+ resources: build.resources.map(getPair),
+ instances: build.instances.map(getPair),
+ deployment,
+ },
+ page,
+ pages: getAllPages(build.pages),
+ assets,
},
- page,
- pages: [build.pages.homePage, ...build.pages.pages],
- assets,
+ project,
+ };
+};
+
+const addProjectMetadata = async (
+ data: Data,
+ project: Project,
+ context: AppContext
+): Promise<PublishedProjectData> => {
+ const user =
+ project.userId === null
+ ? undefined
+ : await getUserById(context, project.userId);
+
+ return {
+ ...data,
+ user: user ? { email: user.email } : undefined,
+ projectDomain: project.domain,
+ projectTitle: project.title,
};
};
+
+export const loadProductionCanvasData = async (
+ buildId: string,
+ context: AppContext
+): Promise<Data> => {
+ const { data } = await loadProductionCanvasDataAndProject(buildId, context);
+ return data;
+};
+
+export const loadPublishedProjectDataByBuildId = async (
+ buildId: string,
+ context: AppContext
+): Promise<PublishedProjectData> => {
+ const { data, project } = await loadProductionCanvasDataAndProject(
+ buildId,
+ context
+ );
+ return await addProjectMetadata(data, project, context);
+};
+
+export const loadPublishedProjectDataByProjectId = async (
+ projectId: string,
+ context: AppContext
+): Promise<PublishedProjectData> => {
+ const project = await projectApi.loadById(projectId, context);
+ if (project === null) {
+ throw new Error(`Project "${projectId}" not found`);
+ }
+
+ const buildId = project.latestBuildVirtual?.buildId;
+ if (buildId === undefined || buildId === null) {
+ throw new Error("The project is not published yet");
+ }
+
+ const { data } = await loadProductionCanvasDataAndProject(
+ buildId,
+ context,
+ project
+ );
+ return await addProjectMetadata(data, project, context);
+};
diff --git a/apps/builder/app/shared/instance-utils.test.tsx b/apps/builder/app/shared/instance-utils.test.tsx
index a2c7356123..7207bab592 100644
--- a/apps/builder/app/shared/instance-utils.test.tsx
+++ b/apps/builder/app/shared/instance-utils.test.tsx
@@ -3112,7 +3112,7 @@ describe("canUnwrapInstance", () => {
$props.set(props);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $selectedPageId.set(pages.homePage.id);
+ $selectedPageId.set(pages.homePageId);
const instancePath = [
{
@@ -3144,7 +3144,7 @@ describe("canUnwrapInstance", () => {
$registeredComponentMetas.set(defaultMetasMap);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $selectedPageId.set(pages.homePage.id);
+ $selectedPageId.set(pages.homePageId);
const instancePath = [
{
@@ -3174,7 +3174,7 @@ describe("canUnwrapInstance", () => {
$registeredComponentMetas.set(defaultMetasMap);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $selectedPageId.set(pages.homePage.id);
+ $selectedPageId.set(pages.homePageId);
const instancePath = [
{
@@ -3206,7 +3206,7 @@ describe("canUnwrapInstance", () => {
$registeredComponentMetas.set(defaultMetasMap);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $selectedPageId.set(pages.homePage.id);
+ $selectedPageId.set(pages.homePageId);
const instancePath = [
{
@@ -3509,7 +3509,7 @@ describe("convertInstance", () => {
test("prevents converting body instance", () => {
const pages = createDefaultPages({ rootInstanceId: "bodyId" });
$pages.set(pages);
- $selectedPageId.set(pages.homePage.id);
+ $selectedPageId.set(pages.homePageId);
const initialInstances = renderData(
<ws.element ws:tag="html" ws:id="rootId">
@@ -3540,7 +3540,7 @@ describe("deleteSelectedInstance", () => {
$instances.set(instances);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $selectedPageId.set(pages.homePage.id);
+ $selectedPageId.set(pages.homePageId);
selectInstance(["child2", "parent", "body"]);
deleteSelectedInstance();
expect($selectedInstanceSelector.get()).toEqual([
@@ -3563,7 +3563,7 @@ describe("deleteSelectedInstance", () => {
$instances.set(instances);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $selectedPageId.set(pages.homePage.id);
+ $selectedPageId.set(pages.homePageId);
selectInstance(["child3", "parent", "body"]);
deleteSelectedInstance();
expect($selectedInstanceSelector.get()).toEqual([
@@ -3584,7 +3584,7 @@ describe("deleteSelectedInstance", () => {
$instances.set(instances);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $selectedPageId.set(pages.homePage.id);
+ $selectedPageId.set(pages.homePageId);
selectInstance(["child1", "parent", "body"]);
deleteSelectedInstance();
expect($selectedInstanceSelector.get()).toEqual(["parent", "body"]);
@@ -3632,7 +3632,7 @@ describe("insertWebstudioFragmentAt with conflictResolution", () => {
setDataStores(data);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $selectedPageId.set(pages.homePage.id);
+ $selectedPageId.set(pages.homePageId);
selectInstance(["body"]);
// Insert without explicit conflictResolution (defaults to "theirs")
@@ -3707,7 +3707,7 @@ describe("insertWebstudioFragmentAt with conflictResolution", () => {
setDataStores(data);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $selectedPageId.set(pages.homePage.id);
+ $selectedPageId.set(pages.homePageId);
selectInstance(["body"]);
// Insert with conflictResolution="ours" to keep existing styles
@@ -3782,7 +3782,7 @@ describe("insertWebstudioFragmentAt with conflictResolution", () => {
setDataStores(data);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $selectedPageId.set(pages.homePage.id);
+ $selectedPageId.set(pages.homePageId);
selectInstance(["body"]);
// Insert with conflictResolution="merge"
@@ -3879,7 +3879,7 @@ describe("detectPageTokenConflicts", () => {
const conflicts = detectPageTokenConflicts({
sourceData: sourceWebstudioData,
- pageId: sourcePages.homePage.id,
+ pageId: sourcePages.homePageId,
});
// No conflicts
@@ -3931,7 +3931,7 @@ describe("detectPageTokenConflicts", () => {
const conflicts = detectPageTokenConflicts({
sourceData: sourceWebstudioData,
- pageId: sourcePages.homePage.id,
+ pageId: sourcePages.homePageId,
});
// Should return conflicts
@@ -4004,7 +4004,7 @@ describe("detectPageTokenConflicts", () => {
const conflicts = detectPageTokenConflicts({
sourceData: sourceWebstudioData,
- pageId: sourcePages.homePage.id,
+ pageId: sourcePages.homePageId,
});
// Should detect conflict from ROOT_INSTANCE token
diff --git a/apps/builder/app/shared/instance-utils.ts b/apps/builder/app/shared/instance-utils.ts
index 4319176cbb..85493241b2 100644
--- a/apps/builder/app/shared/instance-utils.ts
+++ b/apps/builder/app/shared/instance-utils.ts
@@ -23,6 +23,9 @@ import {
decodeDataSourceVariable,
encodeDataSourceVariable,
transpileExpression,
+ getAllPages,
+ getHomePage,
+ findPageByIdOrPath,
ROOT_INSTANCE_ID,
portalComponent,
collectionComponent,
@@ -1849,12 +1852,12 @@ export const findPageAndSelectorByInstanceId = (
currentInstanceId = parentInstanceById.get(currentInstanceId);
}
const rootInstanceId = instanceSelector.at(-1);
- for (const page of [pages.homePage, ...pages.pages]) {
+ for (const page of getAllPages(pages)) {
if (page.rootInstanceId === rootInstanceId) {
return { pageId: page.id, instanceSelector };
}
}
- return { pageId: pages.homePage.id, instanceSelector };
+ return { pageId: pages.homePageId, instanceSelector };
};
export const detectFragmentTokenConflicts = ({
@@ -1896,11 +1899,11 @@ export const detectPageTokenConflicts = ({
}) => {
const data = getWebstudioData();
- const page = sourceData.pages.pages.find((p) => p.id === pageId);
- if (page === undefined && sourceData.pages.homePage.id !== pageId) {
+ const page = findPageByIdOrPath(pageId, sourceData.pages);
+ if (page === undefined) {
throw new Error("Page not found");
}
- const targetPage = page ?? sourceData.pages.homePage;
+ const targetPage = page ?? getHomePage(sourceData.pages);
// Extract fragments for both ROOT_INSTANCE and page body
const rootFragment = extractWebstudioFragment(sourceData, ROOT_INSTANCE_ID);
diff --git a/apps/builder/app/shared/marketplace/db.server.ts b/apps/builder/app/shared/marketplace/db.server.ts
index d033a7b4a5..529bc35e59 100644
--- a/apps/builder/app/shared/marketplace/db.server.ts
+++ b/apps/builder/app/shared/marketplace/db.server.ts
@@ -7,6 +7,7 @@ import {
import type { AppContext } from "@webstudio-is/trpc-interface/index.server";
import type { Project } from "@webstudio-is/project";
import { loadAssetsByProject } from "@webstudio-is/asset-uploader/index.server";
+import { serializePages } from "@webstudio-is/sdk";
export const getBuildProdData = async (
{ projectId }: { projectId: Project["id"] },
@@ -20,6 +21,7 @@ export const getBuildProdData = async (
return {
...build,
+ pages: serializePages(build.pages),
assets,
};
};
diff --git a/apps/builder/app/shared/nano-states/pages.ts b/apps/builder/app/shared/nano-states/pages.ts
index 6f6c23c83c..abedcf5ec7 100644
--- a/apps/builder/app/shared/nano-states/pages.ts
+++ b/apps/builder/app/shared/nano-states/pages.ts
@@ -4,7 +4,6 @@ import {
findPageByIdOrPath,
findParentFolderByChildId,
getPagePath,
- ROOT_FOLDER_ID,
} from "@webstudio-is/sdk";
import { $pages } from "../sync/data-stores";
import { $selectedInstanceSelector } from "./instance-selection";
@@ -32,7 +31,7 @@ export const $selectedPagePath = computed(
return "/";
}
const parentFolder = findParentFolderByChildId(page.id, pages.folders);
- const parentFolderId = parentFolder?.id ?? ROOT_FOLDER_ID;
+ const parentFolderId = parentFolder?.id ?? pages.rootFolderId;
const foldersPath = getPagePath(parentFolderId, pages);
return [foldersPath, page?.path ?? ""]
.filter(Boolean)
diff --git a/apps/builder/app/shared/nano-states/props.test.tsx b/apps/builder/app/shared/nano-states/props.test.tsx
index f8d68ab977..d59b50bbff 100644
--- a/apps/builder/app/shared/nano-states/props.test.tsx
+++ b/apps/builder/app/shared/nano-states/props.test.tsx
@@ -71,7 +71,7 @@ const selectPageRoot = (
systemDataSourceId,
});
$pages.set(defaultPages);
- $selectedPageId.set(defaultPages.homePage.id);
+ $selectedPageId.set(defaultPages.homePageId);
};
beforeEach(() => {
diff --git a/apps/builder/app/shared/page-utils.test.tsx b/apps/builder/app/shared/page-utils.test.tsx
index c2c4c900d7..58a3c182f3 100644
--- a/apps/builder/app/shared/page-utils.test.tsx
+++ b/apps/builder/app/shared/page-utils.test.tsx
@@ -4,6 +4,8 @@ import {
ROOT_FOLDER_ID,
ROOT_INSTANCE_ID,
encodeDataVariableId,
+ getHomePage,
+ migratePages,
type Instance,
type WebstudioData,
} from "@webstudio-is/sdk";
@@ -26,6 +28,11 @@ import { nanoid } from "nanoid";
const toMap = <T extends { id: string }>(list: T[]) =>
new Map(list.map((item) => [item.id, item]));
+const getCopiedPages = (data: WebstudioData) =>
+ Array.from(data.pages.pages.values()).filter(
+ (page) => page.id !== data.pages.homePageId
+ );
+
const getWebstudioDataStub = (
data?: Partial<WebstudioData>
): WebstudioData => ({
@@ -50,7 +57,7 @@ describe("insert page copy", () => {
instances: toMap<Instance>([
{ type: "instance", id: "bodyId", component: "Body", children: [] },
]),
- pages: {
+ pages: migratePages({
meta: {},
homePage: {
id: "pageId",
@@ -62,14 +69,15 @@ describe("insert page copy", () => {
},
pages: [],
folders: [createRootFolder(["pageId"])],
- },
+ }),
});
insertPageCopyMutable({
source: { data, pageId: "pageId" },
target: { data, folderId: ROOT_FOLDER_ID },
});
- expect(data.pages.pages.length).toEqual(1);
- const newPage = data.pages.pages[0];
+ const copiedPages = getCopiedPages(data);
+ expect(copiedPages.length).toEqual(1);
+ const newPage = copiedPages[0];
expect(newPage).toEqual({
id: expect.not.stringMatching("pageId"),
name: "Name (1)",
@@ -92,7 +100,7 @@ describe("insert page copy", () => {
instances: toMap<Instance>([
{ type: "instance", id: "bodyId", component: "Body", children: [] },
]),
- pages: {
+ pages: migratePages({
meta: {},
homePage: {
id: "homePageId",
@@ -113,14 +121,15 @@ describe("insert page copy", () => {
},
],
folders: [createRootFolder(["homePageId", "pageId"])],
- },
+ }),
});
insertPageCopyMutable({
source: { data, pageId: "pageId" },
target: { data, folderId: ROOT_FOLDER_ID },
});
- expect(data.pages.pages.length).toEqual(2);
- const newPage = data.pages.pages[1];
+ const copiedPages = getCopiedPages(data);
+ expect(copiedPages.length).toEqual(2);
+ const newPage = copiedPages[1];
expect(newPage.path).toEqual("/copy-1/my-path");
});
@@ -129,7 +138,7 @@ describe("insert page copy", () => {
instances: toMap<Instance>([
{ type: "instance", id: "bodyId", component: "Body", children: [] },
]),
- pages: {
+ pages: migratePages({
meta: {},
homePage: {
id: "homePageId",
@@ -160,7 +169,7 @@ describe("insert page copy", () => {
},
],
folders: [createRootFolder(["homePageId", "page1Id", "page2Id"])],
- },
+ }),
});
insertPageCopyMutable({
source: { data, pageId: "page1Id" },
@@ -170,9 +179,10 @@ describe("insert page copy", () => {
source: { data, pageId: "page2Id" },
target: { data, folderId: ROOT_FOLDER_ID },
});
- expect(data.pages.pages.length).toEqual(4);
- const newPage1 = data.pages.pages[2];
- const newPage2 = data.pages.pages[3];
+ const copiedPages = getCopiedPages(data);
+ expect(copiedPages.length).toEqual(4);
+ const newPage1 = copiedPages[2];
+ const newPage2 = copiedPages[3];
expect(newPage1.path).toEqual("/copy-1/my-path/*");
expect(newPage2.path).toEqual("/copy-1/my-path/name*");
});
@@ -182,7 +192,7 @@ describe("insert page copy", () => {
instances: toMap<Instance>([
{ type: "instance", id: "bodyId", component: "Body", children: [] },
]),
- pages: {
+ pages: migratePages({
meta: {},
homePage: {
id: "homePageId",
@@ -211,7 +221,7 @@ describe("insert page copy", () => {
children: ["pageId"],
},
],
- },
+ }),
});
insertPageCopyMutable({
source: { data, pageId: "pageId" },
@@ -221,9 +231,10 @@ describe("insert page copy", () => {
source: { data, pageId: "pageId" },
target: { data, folderId: ROOT_FOLDER_ID },
});
- expect(data.pages.pages.length).toEqual(3);
- const nestedPage = data.pages.pages[1];
- const rootPage = data.pages.pages[2];
+ const copiedPages = getCopiedPages(data);
+ expect(copiedPages.length).toEqual(3);
+ const nestedPage = copiedPages[1];
+ const rootPage = copiedPages[2];
expect(nestedPage.path).toEqual("/copy-1/my-path");
expect(rootPage.path).toEqual("/my-path");
});
@@ -237,7 +248,7 @@ describe("insert page copy", () => {
const variableIdentifier = encodeDataVariableId(variableId);
const data = getWebstudioDataStub({
...dataWithoutPage,
- pages: {
+ pages: migratePages({
meta: {},
homePage: {
id: "pageId",
@@ -262,14 +273,15 @@ describe("insert page copy", () => {
},
pages: [],
folders: [createRootFolder(["pageId"])],
- },
+ }),
});
insertPageCopyMutable({
source: { data, pageId: "pageId" },
target: { data, folderId: ROOT_FOLDER_ID },
});
- expect(data.pages.pages.length).toEqual(1);
- const newPage = data.pages.pages[0];
+ const copiedPages = getCopiedPages(data);
+ expect(copiedPages.length).toEqual(1);
+ const newPage = copiedPages[0];
const [_oldVariableId, newVariableId] = data.dataSources.keys();
const newVariableIdentifier = encodeDataVariableId(newVariableId);
expect(newPage).toEqual({
@@ -300,7 +312,7 @@ describe("insert page copy", () => {
instances: toMap<Instance>([
{ type: "instance", id: "bodyId", component: "Body", children: [] },
]),
- pages: {
+ pages: migratePages({
meta: {},
homePage: {
id: "pageId",
@@ -320,7 +332,7 @@ describe("insert page copy", () => {
children: [],
},
],
- },
+ }),
});
insertPageCopyMutable({
source: { data, pageId: "pageId" },
@@ -338,13 +350,14 @@ describe("insert page copy", () => {
source: { data, pageId: "pageId" },
target: { data, folderId: "folderId" },
});
- expect(data.pages.pages.length).toEqual(4);
+ const copiedPages = getCopiedPages(data);
+ expect(copiedPages.length).toEqual(4);
// inside folder with conflict
- expect(data.pages.pages[0].name).toEqual(`Name (1)`);
- expect(data.pages.pages[1].name).toEqual(`Name (2)`);
+ expect(copiedPages[0].name).toEqual(`Name (1)`);
+ expect(copiedPages[1].name).toEqual(`Name (2)`);
// inside folder without conflict
- expect(data.pages.pages[2].name).toEqual(`Name`);
- expect(data.pages.pages[3].name).toEqual(`Name (1)`);
+ expect(copiedPages[2].name).toEqual(`Name`);
+ expect(copiedPages[3].name).toEqual(`Name (1)`);
});
test("preserve global variables when duplicate page", () => {
@@ -363,7 +376,7 @@ describe("insert page copy", () => {
};
data.instances.delete(ROOT_INSTANCE_ID);
insertPageCopyMutable({
- source: { data, pageId: data.pages.homePage.id },
+ source: { data, pageId: data.pages.homePageId },
target: { data, folderId: ROOT_FOLDER_ID },
});
expect(data.dataSources.size).toEqual(1);
@@ -411,7 +424,7 @@ describe("insert page copy", () => {
};
targetData.instances.delete(ROOT_INSTANCE_ID);
insertPageCopyMutable({
- source: { data: sourceData, pageId: sourceData.pages.homePage.id },
+ source: { data: sourceData, pageId: sourceData.pages.homePageId },
target: { data: targetData, folderId: ROOT_FOLDER_ID },
});
expect(targetData.dataSources.size).toEqual(1);
@@ -452,7 +465,7 @@ describe("insert page copy", () => {
...renderData(<$.Body ws:id="anotherBodyId"></$.Body>, nanoid),
};
insertPageCopyMutable({
- source: { data: sourceData, pageId: sourceData.pages.homePage.id },
+ source: { data: sourceData, pageId: sourceData.pages.homePageId },
target: { data: targetData, folderId: ROOT_FOLDER_ID },
});
expect(targetData.dataSources.size).toEqual(1);
@@ -483,10 +496,11 @@ describe("insert page copy", () => {
}),
...dataWithoutPages,
};
- data.pages.homePage.title = `${encodeDataVariableId(pageSystemVariableId)}`;
- data.pages.homePage.meta.description = `${encodeDataVariableId(pageSystemVariableId)}`;
+ const homePage = getHomePage(data.pages);
+ homePage.title = `${encodeDataVariableId(pageSystemVariableId)}`;
+ homePage.meta.description = `${encodeDataVariableId(pageSystemVariableId)}`;
insertPageCopyMutable({
- source: { data, pageId: data.pages.homePage.id },
+ source: { data, pageId: data.pages.homePageId },
target: { data, folderId: ROOT_FOLDER_ID },
});
expect(data.dataSources.size).toEqual(1);
@@ -500,7 +514,8 @@ describe("insert page copy", () => {
expect(newBox?.children).toEqual([
{ type: "expression", value: "$ws$system" },
]);
- expect(data.pages.pages[0].title).toEqual(`$ws$system`);
- expect(data.pages.pages[0].meta.description).toEqual(`$ws$system`);
+ const copiedPage = getCopiedPages(data)[0];
+ expect(copiedPage.title).toEqual(`$ws$system`);
+ expect(copiedPage.meta.description).toEqual(`$ws$system`);
});
});
diff --git a/apps/builder/app/shared/page-utils.ts b/apps/builder/app/shared/page-utils.ts
index dd8c24904e..3f5d2ebf87 100644
--- a/apps/builder/app/shared/page-utils.ts
+++ b/apps/builder/app/shared/page-utils.ts
@@ -3,6 +3,7 @@ import {
decodeDataSourceVariable,
encodeDataSourceVariable,
findPageByIdOrPath,
+ getFolderById,
getPagePath,
transpileExpression,
type Folder,
@@ -33,7 +34,7 @@ const deduplicateName = (
const { name = pageName, copyNumber } =
// extract a number from "name (copyNumber)"
pageName.match(/^(?<name>.+) \((?<copyNumber>\d+)\)$/)?.groups ?? {};
- const folder = pages.folders.find((folder) => folder.id === folderId);
+ const folder = getFolderById(pages, folderId);
const usedNames = new Set<string>();
for (const pageId of folder?.children ?? []) {
const page = findPageByIdOrPath(pageId, pages);
@@ -186,11 +187,7 @@ export const insertPageCopyMutable = ({
content: transformExpression(content),
}));
}
- target.data.pages.pages.push(newPage);
- for (const folder of target.data.pages.folders) {
- if (folder.id === target.folderId) {
- folder.children.push(newPage.id);
- }
- }
+ target.data.pages.pages.set(newPage.id, newPage);
+ target.data.pages.folders.get(target.folderId)?.children.push(newPage.id);
return newPage.id;
};
diff --git a/apps/builder/app/shared/pages/use-switch-page.ts b/apps/builder/app/shared/pages/use-switch-page.ts
index 276a3d65fd..6cd2e8b052 100644
--- a/apps/builder/app/shared/pages/use-switch-page.ts
+++ b/apps/builder/app/shared/pages/use-switch-page.ts
@@ -34,7 +34,7 @@ const setPageStateFromUrl = () => {
// to avoid confusing the user with broken state
const pageId =
findPageByIdOrPath(searchParams.get("pageId") ?? "", pages)?.id ??
- pages.homePage.id;
+ pages.homePageId;
$selectedPageHash.set({ hash: searchParams.get("pageHash") ?? "" });
selectPage(pageId);
@@ -84,7 +84,7 @@ export const useSyncPageUrl = () => {
const searchParams = new URLSearchParams(window.location.search);
- const searchParamsPageId = searchParams.get("pageId") ?? pages.homePage.id;
+ const searchParamsPageId = searchParams.get("pageId") ?? pages.homePageId;
const searchParamsPageHash = searchParams.get("pageHash") ?? "";
const searParamsModeRaw = searchParams.get("mode");
const searParamsMode = isBuilderMode(searParamsModeRaw)
@@ -103,7 +103,7 @@ export const useSyncPageUrl = () => {
navigate(
builderPath({
- pageId: page.id === pages.homePage.id ? undefined : page.id,
+ pageId: page.id === pages.homePageId ? undefined : page.id,
authToken: $authToken.get(),
pageHash: pageHash.hash === "" ? undefined : pageHash.hash,
mode: builderMode === "design" ? undefined : builderMode,
@@ -119,7 +119,7 @@ export const useSyncPageUrl = () => {
if (page === undefined) {
const pages = $pages.get();
if (pages) {
- selectPage(pages.homePage.id);
+ selectPage(pages.homePageId);
}
}
});
diff --git a/apps/builder/app/shared/project-settings/project-settings.stories.tsx b/apps/builder/app/shared/project-settings/project-settings.stories.tsx
index 220935a3b9..c4e23e40c4 100644
--- a/apps/builder/app/shared/project-settings/project-settings.stories.tsx
+++ b/apps/builder/app/shared/project-settings/project-settings.stories.tsx
@@ -34,16 +34,32 @@ export const General = () => {
export const Redirects = () => {
$pages.set({
- homePage: {
- id: "pageId",
- name: "My Name",
- path: "",
- title: `"My Title"`,
- meta: {},
- rootInstanceId: "body",
- },
- pages: [],
- folders: [],
+ homePageId: "pageId",
+ rootFolderId: "root",
+ pages: new Map([
+ [
+ "pageId",
+ {
+ id: "pageId",
+ name: "My Name",
+ path: "",
+ title: `"My Title"`,
+ meta: {},
+ rootInstanceId: "body",
+ },
+ ],
+ ]),
+ folders: new Map([
+ [
+ "root",
+ {
+ id: "root",
+ name: "",
+ slug: "",
+ children: ["pageId"],
+ },
+ ],
+ ]),
redirects: [
{ old: "/old", new: "/new" },
{ old: "/old", new: "https://google.com" },
diff --git a/apps/builder/app/shared/project-settings/utils.test.ts b/apps/builder/app/shared/project-settings/utils.test.ts
index 0951a9284a..d0bc83c397 100644
--- a/apps/builder/app/shared/project-settings/utils.test.ts
+++ b/apps/builder/app/shared/project-settings/utils.test.ts
@@ -10,7 +10,7 @@ describe("getExistingRoutePaths", () => {
homePageId: "homePageId",
});
- pages.pages.push({
+ pages.pages.set("pageId", {
id: "pageId",
meta: {},
name: "Page",
@@ -19,7 +19,7 @@ describe("getExistingRoutePaths", () => {
title: `"Page"`,
});
- pages.pages.push({
+ pages.pages.set("blogId", {
id: "blogId",
meta: {},
name: "Blog",
diff --git a/apps/builder/app/shared/project-settings/utils.ts b/apps/builder/app/shared/project-settings/utils.ts
index cfa15997ec..843aa29466 100644
--- a/apps/builder/app/shared/project-settings/utils.ts
+++ b/apps/builder/app/shared/project-settings/utils.ts
@@ -1,5 +1,10 @@
import { rawTheme, theme, type CSS } from "@webstudio-is/design-system";
-import { getPagePath, type Pages, type PageRedirect } from "@webstudio-is/sdk";
+import {
+ getAllPages,
+ getPagePath,
+ type Pages,
+ type PageRedirect,
+} from "@webstudio-is/sdk";
import { matchPathnamePattern } from "~/builder/shared/url-pattern";
export const leftPanelWidth = rawTheme.spacing[26];
@@ -14,7 +19,10 @@ export const getExistingRoutePaths = (pages?: Pages): Set<string> => {
return paths;
}
- for (const page of pages.pages) {
+ for (const page of getAllPages(pages)) {
+ if (page.id === pages.homePageId) {
+ continue;
+ }
const pagePath = getPagePath(page.id, pages);
if (pagePath === undefined) {
continue;
diff --git a/apps/builder/app/shared/router-utils/path-utils.ts b/apps/builder/app/shared/router-utils/path-utils.ts
index b5256b1297..314ac2a60e 100644
--- a/apps/builder/app/shared/router-utils/path-utils.ts
+++ b/apps/builder/app/shared/router-utils/path-utils.ts
@@ -157,9 +157,6 @@ export const restAssetsUploadPath = ({
return `/rest/assets/${name}`;
};
-export const restBuildVersionPath = (buildId: string) =>
- `/rest/build-version?buildId=${encodeURIComponent(buildId)}`;
-
export const getCanvasUrl = () => {
return `/canvas`;
};
diff --git a/apps/builder/app/shared/sync/pages-patch-normalizer.test.ts b/apps/builder/app/shared/sync/pages-patch-normalizer.test.ts
deleted file mode 100644
index 999316b8e3..0000000000
--- a/apps/builder/app/shared/sync/pages-patch-normalizer.test.ts
+++ /dev/null
@@ -1,242 +0,0 @@
-import { describe, expect, test } from "vitest";
-import { enableMapSet } from "immer";
-import type { Pages } from "@webstudio-is/sdk";
-import {
- normalizePagesPatch,
- denormalizePagesPatch,
-} from "./pages-patch-normalizer";
-import type { Change } from "immerhin";
-
-enableMapSet();
-
-const makePages = (
- pages: Array<{ id: string; name: string }> = [],
- folders: Array<{ id: string; name: string }> = []
-): Pages =>
- ({
- homePage: {
- id: "home",
- name: "Home",
- path: "",
- title: "Home",
- meta: {},
- } as Pages["homePage"],
- pages: pages.map((p) => ({
- ...p,
- path: `/${p.name.toLowerCase()}`,
- title: p.name,
- meta: {},
- })) as Pages["pages"],
- folders: folders.map((f) => ({
- ...f,
- slug: f.name.toLowerCase(),
- children: [],
- })) as Pages["folders"],
- }) satisfies Pages;
-
-const makeChange = (
- namespace: string,
- patches: Change["patches"],
- revisePatches: Change["revisePatches"] = []
-): Change => ({ namespace, patches, revisePatches });
-
-// normalizePagesPatch
-
-describe("normalizePagesPatch", () => {
- test("replaces numeric index with encoded page id for replace op", () => {
- const pages = makePages([
- { id: "p1", name: "About" },
- { id: "p2", name: "Contact" },
- ]);
- const changes = [
- makeChange("pages", [
- { op: "replace", path: ["pages", 1, "name"], value: "Updated" },
- ]),
- ];
- const result = normalizePagesPatch(changes, pages);
- expect(result[0].patches[0].path).toEqual(["pages", "@p2", "name"]);
- });
-
- test("replaces numeric index with encoded folder id for replace op", () => {
- const pages = makePages([], [{ id: "f1", name: "Blog" }]);
- const changes = [
- makeChange("pages", [
- { op: "replace", path: ["folders", 0, "slug"], value: "news" },
- ]),
- ];
- const result = normalizePagesPatch(changes, pages);
- expect(result[0].patches[0].path).toEqual(["folders", "@f1", "slug"]);
- });
-
- test("encodes id from value for add op", () => {
- const pages = makePages([{ id: "p1", name: "About" }]);
- const newPage = {
- id: "p2",
- name: "New",
- path: "/new",
- title: "New",
- meta: {},
- };
- const changes = [
- makeChange("pages", [{ op: "add", path: ["pages", 1], value: newPage }]),
- ];
- const result = normalizePagesPatch(changes, pages);
- expect(result[0].patches[0].path).toEqual(["pages", "@p2"]);
- expect(result[0].patches[0].value).toEqual(newPage);
- });
-
- test("encodes id from revise patch value for remove op", () => {
- const pages = makePages([
- { id: "p1", name: "About" },
- { id: "p2", name: "Contact" },
- ]);
- const removedPage = {
- id: "p2",
- name: "Contact",
- path: "/contact",
- title: "Contact",
- meta: {},
- };
- const changes = [
- makeChange(
- "pages",
- [{ op: "remove", path: ["pages", 1] }],
- [{ op: "add", path: ["pages", 1], value: removedPage }]
- ),
- ];
- const result = normalizePagesPatch(changes, pages);
- expect(result[0].patches[0].path).toEqual(["pages", "@p2"]);
- });
-
- test("leaves non-pages namespace unchanged", () => {
- const pages = makePages([{ id: "p1", name: "About" }]);
- const changes = [
- makeChange("instances", [
- { op: "replace", path: [0, "type"], value: "div" },
- ]),
- ];
- const result = normalizePagesPatch(changes, pages);
- expect(result[0].patches[0].path).toEqual([0, "type"]);
- });
-
- test("leaves already-string-indexed path unchanged", () => {
- const pages = makePages([{ id: "p1", name: "About" }]);
- const changes = [
- makeChange("pages", [
- { op: "replace", path: ["homePage", "name"], value: "Home" },
- ]),
- ];
- const result = normalizePagesPatch(changes, pages);
- expect(result[0].patches[0].path).toEqual(["homePage", "name"]);
- });
-
- test("normalizes revise patches symmetrically", () => {
- const pages = makePages([
- { id: "p1", name: "About" },
- { id: "p2", name: "Contact" },
- ]);
- const changes = [
- makeChange(
- "pages",
- [{ op: "replace", path: ["pages", 1, "name"], value: "Updated" }],
- [{ op: "replace", path: ["pages", 1, "name"], value: "Contact" }]
- ),
- ];
- const result = normalizePagesPatch(changes, pages);
- expect(result[0].revisePatches[0].path).toEqual(["pages", "@p2", "name"]);
- });
-});
-
-// denormalizePagesPatch
-
-describe("denormalizePagesPatch", () => {
- test("converts encoded page id back to current index", () => {
- const pages = makePages([
- { id: "p1", name: "About" },
- { id: "p2", name: "Contact" },
- ]);
- const changes = [
- makeChange("pages", [
- { op: "replace", path: ["pages", "@p2", "name"], value: "Updated" },
- ]),
- ];
- const result = denormalizePagesPatch(changes, pages);
- expect(result[0].patches[0].path).toEqual(["pages", 1, "name"]);
- });
-
- test("converts to current index even when order differs from sender", () => {
- // Receiver has reversed order vs sender
- const pages = makePages([
- { id: "p2", name: "Contact" },
- { id: "p1", name: "About" },
- ]);
- const changes = [
- makeChange("pages", [
- { op: "replace", path: ["pages", "@p1", "name"], value: "Updated" },
- ]),
- ];
- const result = denormalizePagesPatch(changes, pages);
- expect(result[0].patches[0].path).toEqual(["pages", 1, "name"]);
- });
-
- test("uses append-to-end index for add op", () => {
- const pages = makePages([{ id: "p1", name: "About" }]);
- const newPage = {
- id: "p2",
- name: "New",
- path: "/new",
- title: "New",
- meta: {},
- };
- const changes = [
- makeChange("pages", [
- { op: "add", path: ["pages", "@p2"], value: newPage },
- ]),
- ];
- const result = denormalizePagesPatch(changes, pages);
- expect(result[0].patches[0].path).toEqual(["pages", 1]);
- });
-
- test("leaves path unchanged when page id not found (stale patch)", () => {
- const pages = makePages([{ id: "p1", name: "About" }]);
- const changes = [
- makeChange("pages", [
- { op: "replace", path: ["pages", "@deleted", "name"], value: "X" },
- ]),
- ];
- const result = denormalizePagesPatch(changes, pages);
- // Unchanged - Immer applyPatches will fail gracefully and leader drops it
- expect(result[0].patches[0].path).toEqual(["pages", "@deleted", "name"]);
- });
-
- test("leaves non-pages namespace unchanged", () => {
- const pages = makePages([]);
- const changes = [
- makeChange("instances", [
- { op: "replace", path: ["@some-id", "type"], value: "div" },
- ]),
- ];
- const result = denormalizePagesPatch(changes, pages);
- expect(result[0].patches[0].path).toEqual(["@some-id", "type"]);
- });
-
- test("roundtrip: normalize then denormalize is identity for replace", () => {
- const pages = makePages([
- { id: "p1", name: "About" },
- { id: "p2", name: "Contact" },
- ]);
- const original: Change[] = [
- makeChange(
- "pages",
- [{ op: "replace", path: ["pages", 1, "name"], value: "Updated" }],
- [{ op: "replace", path: ["pages", 1, "name"], value: "Contact" }]
- ),
- ];
- const normalized = normalizePagesPatch(original, pages);
- const restored = denormalizePagesPatch(normalized, pages);
- expect(restored[0].patches[0].path).toEqual(original[0].patches[0].path);
- expect(restored[0].revisePatches[0].path).toEqual(
- original[0].revisePatches[0].path
- );
- });
-});
diff --git a/apps/builder/app/shared/sync/pages-patch-normalizer.ts b/apps/builder/app/shared/sync/pages-patch-normalizer.ts
deleted file mode 100644
index ccebb547fa..0000000000
--- a/apps/builder/app/shared/sync/pages-patch-normalizer.ts
+++ /dev/null
@@ -1,161 +0,0 @@
-import type { Patch } from "immer";
-import type { Change } from "immerhin";
-import type { Folder, Page, Pages } from "@webstudio-is/sdk";
-
-// Sentinel prefix used to distinguish ID-based path segments from numeric indices
-// on the wire. Kept as a plain string so patches stay JSON-serializable.
-const ID_PREFIX = "@";
-
-const encodeId = (id: string) => `${ID_PREFIX}${id}`;
-const decodeId = (seg: string): string | undefined =>
- seg.startsWith(ID_PREFIX) ? seg.slice(ID_PREFIX.length) : undefined;
-
-const isIdSegment = (seg: string | number): seg is string =>
- typeof seg === "string" && seg.startsWith(ID_PREFIX);
-
-const normalizeOnePatch = (
- patch: Patch,
- revisePatches: Patch[],
- pages: Pages
-): Patch => {
- const [key, indexOrId, ...rest] = patch.path;
- if (typeof indexOrId !== "number") {
- return patch;
- }
- if (key !== "pages" && key !== "folders") {
- return patch;
- }
-
- const items: Array<Page | Folder> =
- key === "pages" ? pages.pages : pages.folders;
-
- if (patch.op === "add") {
- const id = (patch.value as { id?: string } | undefined)?.id;
- if (!id) {
- return patch;
- }
- return { ...patch, path: [key, encodeId(id), ...rest] };
- }
-
- if (patch.op === "remove") {
- const rp = revisePatches.find(
- (r) => r.op === "add" && r.path[0] === key && r.path[1] === indexOrId
- );
- const id = (rp?.value as { id?: string } | undefined)?.id;
- if (!id) {
- return patch;
- }
- return { ...patch, path: [key, encodeId(id), ...rest] };
- }
-
- const id = (items[indexOrId] as { id?: string } | undefined)?.id;
- if (!id) {
- return patch;
- }
- return { ...patch, path: [key, encodeId(id), ...rest] };
-};
-
-const normalizeRevise = (
- rp: Patch,
- forwardPatches: Patch[],
- pages: Pages
-): Patch => {
- const [key, indexOrId, ...rest] = rp.path;
- if (typeof indexOrId !== "number") {
- return rp;
- }
- if (key !== "pages" && key !== "folders") {
- return rp;
- }
-
- const items: Array<Page | Folder> =
- key === "pages" ? pages.pages : pages.folders;
-
- if (rp.op === "add") {
- const id = (rp.value as { id?: string } | undefined)?.id;
- if (!id) {
- return rp;
- }
- return { ...rp, path: [key, encodeId(id), ...rest] };
- }
-
- if (rp.op === "remove") {
- const fp = forwardPatches.find(
- (f) => f.op === "add" && f.path[0] === key && f.path[1] === indexOrId
- );
- const id = (fp?.value as { id?: string } | undefined)?.id;
- if (!id) {
- return rp;
- }
- return { ...rp, path: [key, encodeId(id), ...rest] };
- }
-
- const id = (items[indexOrId] as { id?: string } | undefined)?.id;
- if (!id) {
- return rp;
- }
- return { ...rp, path: [key, encodeId(id), ...rest] };
-};
-
-export const normalizePagesPatch = (
- changes: Change[],
- pagesState: Pages
-): Change[] =>
- changes.map((change) => {
- if (change.namespace !== "pages") {
- return change;
- }
- return {
- ...change,
- patches: change.patches.map((p) =>
- normalizeOnePatch(p, change.revisePatches, pagesState)
- ),
- revisePatches: change.revisePatches.map((rp) =>
- normalizeRevise(rp, change.patches, pagesState)
- ),
- };
- });
-
-const denormalizeOnePatch = (patch: Patch, pages: Pages): Patch => {
- const [key, indexOrId, ...rest] = patch.path;
- if (!isIdSegment(indexOrId as string | number)) {
- return patch;
- }
- if (key !== "pages" && key !== "folders") {
- return patch;
- }
-
- const id = decodeId(indexOrId as string)!;
- const items: Array<Page | Folder> =
- key === "pages" ? pages.pages : pages.folders;
-
- if (patch.op === "add") {
- // Insert at end - exact position doesn't matter for concurrent adds
- return { ...patch, path: [key, items.length, ...rest] };
- }
-
- const idx = items.findIndex((item) => item.id === id);
- if (idx === -1) {
- // Item not found; return patch unchanged - the apply will fail gracefully
- // (leader drops stale patches, followers silently ignore missing paths)
- return patch;
- }
- return { ...patch, path: [key, idx, ...rest] };
-};
-
-export const denormalizePagesPatch = (
- changes: Change[],
- currentState: Pages
-): Change[] =>
- changes.map((change) => {
- if (change.namespace !== "pages") {
- return change;
- }
- return {
- ...change,
- patches: change.patches.map((p) => denormalizeOnePatch(p, currentState)),
- revisePatches: change.revisePatches.map((rp) =>
- denormalizeOnePatch(rp, currentState)
- ),
- };
- });
diff --git a/apps/builder/app/shared/sync/sync-client.ts b/apps/builder/app/shared/sync/sync-client.ts
index c738c85c42..01dc45ff63 100644
--- a/apps/builder/app/shared/sync/sync-client.ts
+++ b/apps/builder/app/shared/sync/sync-client.ts
@@ -100,6 +100,12 @@ export const initializeClientSync = ({
? undefined
: resolveMultiplayerRelayUrl(multiplayerRelayUrl);
const useMultiplayer = resolvedMultiplayerRelayUrl !== undefined;
+ if (useMultiplayer) {
+ console.info("[builder-sync] multiplayer mode enabled", {
+ projectId,
+ relayUrl: resolvedMultiplayerRelayUrl,
+ });
+ }
// Note: "view" permit will skip transaction synchronization
diff --git a/apps/builder/app/shared/sync/sync-stores.ts b/apps/builder/app/shared/sync/sync-stores.ts
index ebf887b9b8..a05528a820 100644
--- a/apps/builder/app/shared/sync/sync-stores.ts
+++ b/apps/builder/app/shared/sync/sync-stores.ts
@@ -4,10 +4,6 @@ import { useEffect } from "react";
import { batched } from "nanostores";
import { nanoid } from "nanoid";
import { $project } from "./data-stores";
-import {
- normalizePagesPatch,
- denormalizePagesPatch,
-} from "./pages-patch-normalizer";
import {
$selectedPageHash,
$selectedInstanceSizes,
@@ -188,16 +184,7 @@ export const __testing__ = {
export const createObjectPool = () => {
return new SyncObjectPool([
- new ImmerhinSyncObject("server", serverSyncStore, {
- onSend: (changes) => {
- const pages = $pages.get();
- return pages ? normalizePagesPatch(changes, pages) : changes;
- },
- onReceive: (changes) => {
- const pages = $pages.get();
- return pages ? denormalizePagesPatch(changes, pages) : changes;
- },
- }),
+ new ImmerhinSyncObject("server", serverSyncStore),
new ImmerhinSyncObject("client", clientSyncStore),
new SelectedPageAndInstanceSyncObject(),
new NanostoresSyncObject("pointerPosition", $pointerPosition),
diff --git a/apps/builder/app/shared/system.test.ts b/apps/builder/app/shared/system.test.ts
index 52da7bb8df..3ceeb4215f 100644
--- a/apps/builder/app/shared/system.test.ts
+++ b/apps/builder/app/shared/system.test.ts
@@ -8,23 +8,33 @@ import { selectPage } from "./nano-states";
registerContainers();
const getInitialPages = (page: Page): Pages => ({
- folders: [
- {
- id: "rootId",
- name: "",
- slug: "",
- children: ["homeId", "dynamicId"],
- },
- ],
- homePage: {
- id: "homeId",
- path: "",
- name: "",
- title: "",
- meta: {},
- rootInstanceId: "",
- },
- pages: [page],
+ homePageId: "homeId",
+ rootFolderId: "rootId",
+ folders: new Map([
+ [
+ "rootId",
+ {
+ id: "rootId",
+ name: "",
+ slug: "",
+ children: ["homeId", "dynamicId"],
+ },
+ ],
+ ]),
+ pages: new Map([
+ [
+ "homeId",
+ {
+ id: "homeId",
+ path: "",
+ name: "",
+ title: "",
+ meta: {},
+ rootInstanceId: "",
+ },
+ ],
+ [page.id, page],
+ ]),
});
describe("history", () => {
@@ -43,13 +53,13 @@ describe("history", () => {
updateCurrentSystem({
params: { date: "my-date", slug: "my-slug" },
});
- expect($pages.get()?.pages[0].history).toEqual([
+ expect($pages.get()?.pages.get("dynamicId")?.history).toEqual([
"/blog/my-date/post/my-slug",
]);
updateCurrentSystem({
params: { date: "another-date", slug: "another-slug" },
});
- expect($pages.get()?.pages[0].history).toEqual([
+ expect($pages.get()?.pages.get("dynamicId")?.history).toEqual([
"/blog/another-date/post/another-slug",
"/blog/my-date/post/my-slug",
]);
@@ -74,7 +84,7 @@ describe("history", () => {
updateCurrentSystem({
params: { date: "my-date", slug: "my-slug" },
});
- expect($pages.get()?.pages[0].history).toEqual([
+ expect($pages.get()?.pages.get("dynamicId")?.history).toEqual([
"/blog/my-date/post/my-slug",
"/blog/another-date/post/another-slug",
]);
diff --git a/apps/builder/app/shared/webstudio-data-migrator.test.ts b/apps/builder/app/shared/webstudio-data-migrator.test.ts
deleted file mode 100644
index b604efbc22..0000000000
--- a/apps/builder/app/shared/webstudio-data-migrator.test.ts
+++ /dev/null
@@ -1,54 +0,0 @@
-import { expect, test } from "vitest";
-import type { WebstudioData } from "@webstudio-is/sdk";
-import { createDefaultPages } from "@webstudio-is/project-build";
-import type { StyleProperty } from "@webstudio-is/css-engine";
-import { migrateWebstudioDataMutable } from "./webstudio-data-migrator";
-
-const emptyData: WebstudioData = {
- pages: createDefaultPages({
- rootInstanceId: "rootInstanceId",
- }),
- assets: new Map(),
- dataSources: new Map(),
- resources: new Map(),
- instances: new Map(),
- props: new Map(),
- breakpoints: new Map(),
- styleSources: new Map(),
- styleSourceSelections: new Map(),
- styles: new Map(),
-};
-
-test("expand overflow shorthand", () => {
- const data = structuredClone(emptyData);
- data.styles.set("base:local:overflow::hover", {
- breakpointId: "base",
- styleSourceId: "local",
- state: ":hover",
- property: "overflow" as StyleProperty,
- value: {
- type: "tuple",
- value: [
- { type: "keyword", value: "auto" },
- { type: "keyword", value: "hidden" },
- ],
- },
- });
- migrateWebstudioDataMutable(data);
- expect(Array.from(data.styles.values())).toEqual([
- {
- breakpointId: "base",
- property: "overflowX",
- state: ":hover",
- styleSourceId: "local",
- value: { type: "keyword", value: "auto" },
- },
- {
- breakpointId: "base",
- property: "overflowY",
- state: ":hover",
- styleSourceId: "local",
- value: { type: "keyword", value: "hidden" },
- },
- ]);
-});
diff --git a/apps/builder/app/shared/webstudio-data-migrator.ts b/apps/builder/app/shared/webstudio-data-migrator.ts
deleted file mode 100644
index 3fcc456de1..0000000000
--- a/apps/builder/app/shared/webstudio-data-migrator.ts
+++ /dev/null
@@ -1,52 +0,0 @@
-import {
- getStyleDeclKey,
- type StyleDecl,
- type WebstudioData,
-} from "@webstudio-is/sdk";
-import { hyphenateProperty, toValue } from "@webstudio-is/css-engine";
-import {
- camelCaseProperty,
- expandShorthands,
- parseCssValue,
-} from "@webstudio-is/css-data";
-
-/**
- *
- * Transform loaded data and sync into server
- * before passing into application
- * should be idempotent because can be executed multiple times
- *
- * Very basic version of client migrations
- * Should be versioned eventually to avoid running every time
- *
- * For now patch is prevented by excluding empty transactions from sync queue
- *
- */
-export const migrateWebstudioDataMutable = (data: WebstudioData) => {
- for (const [styleDeclKey, styleDecl] of data.styles) {
- const property = hyphenateProperty(styleDecl.property) as string;
-
- // expands overflow shorthand into overflow-x and overflow-y longhands
- // expands transition shorthand into transition-property, transition-duration, transition-timing-function, transition-delay longhands
- // expands white-space into white-space-collapse and text-wrap-mode
- if (
- property === "overflow" ||
- property === "transition" ||
- property === "white-space" ||
- property === "background-position"
- ) {
- data.styles.delete(styleDeclKey);
- const longhands = expandShorthands([
- [property, toValue(styleDecl.value)],
- ]);
- for (const [hyphenedProperty, value] of longhands) {
- const longhandStyleDecl: StyleDecl = {
- ...styleDecl,
- property: camelCaseProperty(hyphenedProperty),
- value: parseCssValue(hyphenedProperty, value),
- };
- data.styles.set(getStyleDeclKey(longhandStyleDecl), longhandStyleDecl);
- }
- }
- }
-};
diff --git a/fixtures/react-router-cloudflare/.webstudio/data.json b/fixtures/react-router-cloudflare/.webstudio/data.json
index fb7fe0fd17..79ffa059a7 100644
--- a/fixtures/react-router-cloudflare/.webstudio/data.json
+++ b/fixtures/react-router-cloudflare/.webstudio/data.json
@@ -11,16 +11,18 @@
"faviconAssetId": "d0974db9300c1a3b0fb8b291dd9fabd45ad136478908394280af2f7087e3aecd",
"code": ""
},
- "homePage": {
- "id": "9di_L14CzctvSruIoKVvE",
- "name": "Home",
- "title": "\"Home\"",
- "rootInstanceId": "MMimeobf_zi4ZkRGXapju",
- "systemDataSourceId": "2KT4-bRzToj9cAGAN_woK",
- "meta": {},
- "path": ""
- },
+ "homePageId": "9di_L14CzctvSruIoKVvE",
+ "rootFolderId": "root",
"pages": [
+ {
+ "id": "9di_L14CzctvSruIoKVvE",
+ "name": "Home",
+ "title": "\"Home\"",
+ "rootInstanceId": "MMimeobf_zi4ZkRGXapju",
+ "systemDataSourceId": "2KT4-bRzToj9cAGAN_woK",
+ "meta": {},
+ "path": ""
+ },
{
"id": "WPPAbLFyJD_02vhjRd8P4",
"name": "Another page",
diff --git a/fixtures/react-router-docker/.webstudio/data.json b/fixtures/react-router-docker/.webstudio/data.json
index fb7fe0fd17..79ffa059a7 100644
--- a/fixtures/react-router-docker/.webstudio/data.json
+++ b/fixtures/react-router-docker/.webstudio/data.json
@@ -11,16 +11,18 @@
"faviconAssetId": "d0974db9300c1a3b0fb8b291dd9fabd45ad136478908394280af2f7087e3aecd",
"code": ""
},
- "homePage": {
- "id": "9di_L14CzctvSruIoKVvE",
- "name": "Home",
- "title": "\"Home\"",
- "rootInstanceId": "MMimeobf_zi4ZkRGXapju",
- "systemDataSourceId": "2KT4-bRzToj9cAGAN_woK",
- "meta": {},
- "path": ""
- },
+ "homePageId": "9di_L14CzctvSruIoKVvE",
+ "rootFolderId": "root",
"pages": [
+ {
+ "id": "9di_L14CzctvSruIoKVvE",
+ "name": "Home",
+ "title": "\"Home\"",
+ "rootInstanceId": "MMimeobf_zi4ZkRGXapju",
+ "systemDataSourceId": "2KT4-bRzToj9cAGAN_woK",
+ "meta": {},
+ "path": ""
+ },
{
"id": "WPPAbLFyJD_02vhjRd8P4",
"name": "Another page",
diff --git a/fixtures/react-router-netlify/.webstudio/data.json b/fixtures/react-router-netlify/.webstudio/data.json
index fb7fe0fd17..79ffa059a7 100644
--- a/fixtures/react-router-netlify/.webstudio/data.json
+++ b/fixtures/react-router-netlify/.webstudio/data.json
@@ -11,16 +11,18 @@
"faviconAssetId": "d0974db9300c1a3b0fb8b291dd9fabd45ad136478908394280af2f7087e3aecd",
"code": ""
},
- "homePage": {
- "id": "9di_L14CzctvSruIoKVvE",
- "name": "Home",
- "title": "\"Home\"",
- "rootInstanceId": "MMimeobf_zi4ZkRGXapju",
- "systemDataSourceId": "2KT4-bRzToj9cAGAN_woK",
- "meta": {},
- "path": ""
- },
+ "homePageId": "9di_L14CzctvSruIoKVvE",
+ "rootFolderId": "root",
"pages": [
+ {
+ "id": "9di_L14CzctvSruIoKVvE",
+ "name": "Home",
+ "title": "\"Home\"",
+ "rootInstanceId": "MMimeobf_zi4ZkRGXapju",
+ "systemDataSourceId": "2KT4-bRzToj9cAGAN_woK",
+ "meta": {},
+ "path": ""
+ },
{
"id": "WPPAbLFyJD_02vhjRd8P4",
"name": "Another page",
diff --git a/fixtures/react-router-vercel/.webstudio/data.json b/fixtures/react-router-vercel/.webstudio/data.json
index fb7fe0fd17..79ffa059a7 100644
--- a/fixtures/react-router-vercel/.webstudio/data.json
+++ b/fixtures/react-router-vercel/.webstudio/data.json
@@ -11,16 +11,18 @@
"faviconAssetId": "d0974db9300c1a3b0fb8b291dd9fabd45ad136478908394280af2f7087e3aecd",
"code": ""
},
- "homePage": {
- "id": "9di_L14CzctvSruIoKVvE",
- "name": "Home",
- "title": "\"Home\"",
- "rootInstanceId": "MMimeobf_zi4ZkRGXapju",
- "systemDataSourceId": "2KT4-bRzToj9cAGAN_woK",
- "meta": {},
- "path": ""
- },
+ "homePageId": "9di_L14CzctvSruIoKVvE",
+ "rootFolderId": "root",
"pages": [
+ {
+ "id": "9di_L14CzctvSruIoKVvE",
+ "name": "Home",
+ "title": "\"Home\"",
+ "rootInstanceId": "MMimeobf_zi4ZkRGXapju",
+ "systemDataSourceId": "2KT4-bRzToj9cAGAN_woK",
+ "meta": {},
+ "path": ""
+ },
{
"id": "WPPAbLFyJD_02vhjRd8P4",
"name": "Another page",
diff --git a/fixtures/ssg-cloudflare-pages/.webstudio/data.json b/fixtures/ssg-cloudflare-pages/.webstudio/data.json
index 0a52c8dd9b..ca83d4c03e 100644
--- a/fixtures/ssg-cloudflare-pages/.webstudio/data.json
+++ b/fixtures/ssg-cloudflare-pages/.webstudio/data.json
@@ -11,16 +11,18 @@
"faviconAssetId": "",
"code": ""
},
- "homePage": {
- "id": "9di_L14CzctvSruIoKVvE",
- "name": "Home",
- "title": "\"Home\"",
- "rootInstanceId": "MMimeobf_zi4ZkRGXapju",
- "systemDataSourceId": "2KT4-bRzToj9cAGAN_woK",
- "meta": {},
- "path": ""
- },
+ "homePageId": "9di_L14CzctvSruIoKVvE",
+ "rootFolderId": "root",
"pages": [
+ {
+ "id": "9di_L14CzctvSruIoKVvE",
+ "name": "Home",
+ "title": "\"Home\"",
+ "rootInstanceId": "MMimeobf_zi4ZkRGXapju",
+ "systemDataSourceId": "2KT4-bRzToj9cAGAN_woK",
+ "meta": {},
+ "path": ""
+ },
{
"id": "WPPAbLFyJD_02vhjRd8P4",
"name": "Another page",
diff --git a/fixtures/ssg-cloudflare-pages/package.json b/fixtures/ssg-cloudflare-pages/package.json
index 59b0ff1d94..5ec3142340 100644
--- a/fixtures/ssg-cloudflare-pages/package.json
+++ b/fixtures/ssg-cloudflare-pages/package.json
@@ -8,7 +8,7 @@
"dev": "vite dev",
"typecheck": "tsgo --noEmit",
"cli": "NODE_OPTIONS='--conditions=webstudio --import=tsx' webstudio",
- "fixtures:link": "pnpm cli link --link ${BUILDER_URL_DEPRECATED:-https://main.development.webstudio.is}'/builder/d845c167-ea07-4875-b08d-83e97c09dcce?authToken=e9d1343f-9298-4fd3-a66e-f89a5af2dd93'",
+ "fixtures:link": "pnpm cli link --link https://p-d845c167-ea07-4875-b08d-83e97c09dcce-dot-${BUILDER_HOST:-main.development.webstudio.is}'?authToken=e9d1343f-9298-4fd3-a66e-f89a5af2dd93'",
"fixtures:sync": "pnpm cli sync --buildId a2e8de30-03d5-4514-a3a6-406b3266a3af && pnpm prettier --write ./.webstudio/",
"fixtures:build": "rm -rf pages && pnpm cli build --template ssg --template internal && prettier --write ."
},
diff --git a/fixtures/ssg-netlify-by-project-id/.webstudio/data.json b/fixtures/ssg-netlify-by-project-id/.webstudio/data.json
index 5ced8e1bff..3f856a44ca 100644
--- a/fixtures/ssg-netlify-by-project-id/.webstudio/data.json
+++ b/fixtures/ssg-netlify-by-project-id/.webstudio/data.json
@@ -7,16 +7,18 @@
"updatedAt": "2026-01-04T10:46:48.415+00:00",
"pages": {
"meta": {},
- "homePage": {
- "id": "Y60VJnVZMU_ifI0GnAR1N",
- "name": "Home",
- "title": "\"Home\"",
- "rootInstanceId": "iavYtlaxaMTf7HB5DBf8e",
- "systemDataSourceId": "XE93KQdVwfiA3TCf8hQAQ",
- "meta": {},
- "path": ""
- },
+ "homePageId": "Y60VJnVZMU_ifI0GnAR1N",
+ "rootFolderId": "root",
"pages": [
+ {
+ "id": "Y60VJnVZMU_ifI0GnAR1N",
+ "name": "Home",
+ "title": "\"Home\"",
+ "rootInstanceId": "iavYtlaxaMTf7HB5DBf8e",
+ "systemDataSourceId": "XE93KQdVwfiA3TCf8hQAQ",
+ "meta": {},
+ "path": ""
+ },
{
"id": "fOBamlMdmM461hLaITmV7",
"name": "Untitled",
diff --git a/fixtures/webstudio-cloudflare-template/.webstudio/data.json b/fixtures/webstudio-cloudflare-template/.webstudio/data.json
index 0a52c8dd9b..ca83d4c03e 100644
--- a/fixtures/webstudio-cloudflare-template/.webstudio/data.json
+++ b/fixtures/webstudio-cloudflare-template/.webstudio/data.json
@@ -11,16 +11,18 @@
"faviconAssetId": "",
"code": ""
},
- "homePage": {
- "id": "9di_L14CzctvSruIoKVvE",
- "name": "Home",
- "title": "\"Home\"",
- "rootInstanceId": "MMimeobf_zi4ZkRGXapju",
- "systemDataSourceId": "2KT4-bRzToj9cAGAN_woK",
- "meta": {},
- "path": ""
- },
+ "homePageId": "9di_L14CzctvSruIoKVvE",
+ "rootFolderId": "root",
"pages": [
+ {
+ "id": "9di_L14CzctvSruIoKVvE",
+ "name": "Home",
+ "title": "\"Home\"",
+ "rootInstanceId": "MMimeobf_zi4ZkRGXapju",
+ "systemDataSourceId": "2KT4-bRzToj9cAGAN_woK",
+ "meta": {},
+ "path": ""
+ },
{
"id": "WPPAbLFyJD_02vhjRd8P4",
"name": "Another page",
diff --git a/fixtures/webstudio-features/.webstudio/data.json b/fixtures/webstudio-features/.webstudio/data.json
index 4a48c417bf..edf7061a77 100644
--- a/fixtures/webstudio-features/.webstudio/data.json
+++ b/fixtures/webstudio-features/.webstudio/data.json
@@ -11,25 +11,27 @@
"faviconAssetId": "7cf5892080fa66b5e6175ffd2d27c304ee6b09ce1f21847a95000225ad1afa59",
"code": "<script>console.log('KittyGuardedZone')</script>\n"
},
- "homePage": {
- "id": "7Db64ZXgYiRqKSQNR-qTQ",
- "name": "Home",
- "title": "\"The Ultimate Cat Protection Zone\"",
- "rootInstanceId": "On9cvWCxr5rdZtY9O1Bv0",
- "systemDataSourceId": "u9wtUkt2-E0RDaljl_I6E",
- "meta": {
- "description": "\"Dive into the world of felines and discover why some whiskers are best left untouched. From intriguing cat behaviors to protective measures, \\nKittyGuardedZone is your go-to hub for all things 'hands-off' in the cat realm.\"",
- "socialImageAssetId": "cd939c56-bcdd-4e64-bd9c-567a9bccd3da",
- "custom": [
- {
- "property": "fb:app_id",
- "content": "\"app_id_app_id_app_id\""
- }
- ]
- },
- "path": ""
- },
+ "homePageId": "7Db64ZXgYiRqKSQNR-qTQ",
+ "rootFolderId": "root",
"pages": [
+ {
+ "id": "7Db64ZXgYiRqKSQNR-qTQ",
+ "name": "Home",
+ "title": "\"The Ultimate Cat Protection Zone\"",
+ "rootInstanceId": "On9cvWCxr5rdZtY9O1Bv0",
+ "systemDataSourceId": "u9wtUkt2-E0RDaljl_I6E",
+ "meta": {
+ "description": "\"Dive into the world of felines and discover why some whiskers are best left untouched. From intriguing cat behaviors to protective measures, \\nKittyGuardedZone is your go-to hub for all things 'hands-off' in the cat realm.\"",
+ "socialImageAssetId": "cd939c56-bcdd-4e64-bd9c-567a9bccd3da",
+ "custom": [
+ {
+ "property": "fb:app_id",
+ "content": "\"app_id_app_id_app_id\""
+ }
+ ]
+ },
+ "path": ""
+ },
{
"id": "xfvB4UThQXmQ_OubPYrkg",
"name": "radix excluded from the search",
diff --git a/packages/cli/package.json b/packages/cli/package.json
index 7a52ffb54d..f9a12d4d9d 100644
--- a/packages/cli/package.json
+++ b/packages/cli/package.json
@@ -33,6 +33,7 @@
"dependencies": {
"@clack/prompts": "^0.10.0",
"@emotion/hash": "^0.9.2",
+ "@trpc/client": "^10.45.2",
"acorn": "^8.14.1",
"acorn-walk": "^8.3.4",
"change-case": "^5.4.4",
diff --git a/packages/cli/src/commands/link.ts b/packages/cli/src/commands/link.ts
index a0580dcdfe..e6252f94fc 100644
--- a/packages/cli/src/commands/link.ts
+++ b/packages/cli/src/commands/link.ts
@@ -1,6 +1,6 @@
import { cwd, exit } from "node:process";
import { join } from "node:path";
-import { readFile, writeFile } from "node:fs/promises";
+import { mkdir, readFile, rename, rm, writeFile } from "node:fs/promises";
import { cancel, isCancel, log, text } from "@clack/prompts";
import { parseBuilderUrl } from "@webstudio-is/http-client";
import {
@@ -16,6 +16,42 @@ import type {
StrictYargsOptionsToInterface,
} from "./yargs-types";
+const wait = (duration: number) =>
+ new Promise((resolve) => setTimeout(resolve, duration));
+
+const withConfigLock = async <Result>(callback: () => Promise<Result>) => {
+ const lockPath = `${GLOBAL_CONFIG_FILE}.lock`;
+ const start = Date.now();
+
+ while (true) {
+ try {
+ await mkdir(lockPath);
+ break;
+ } catch (error) {
+ const code = (error as NodeJS.ErrnoException).code;
+ if (code !== "EEXIST") {
+ throw error;
+ }
+ if (Date.now() - start > 10_000) {
+ throw new Error(`Timed out waiting for config lock ${lockPath}`);
+ }
+ await wait(50);
+ }
+ }
+
+ try {
+ return await callback();
+ } finally {
+ await rm(lockPath, { recursive: true, force: true });
+ }
+};
+
+const writeConfigFile = async (content: string) => {
+ const temporaryFile = `${GLOBAL_CONFIG_FILE}.${process.pid}.tmp`;
+ await writeFile(temporaryFile, content, "utf8");
+ await rename(temporaryFile, GLOBAL_CONFIG_FILE);
+};
+
const parseShareLink = (value: string) => {
// value.replaceAll("'", "") is used to remove single quotes from the URL on Windows.
// This is necessary because the following pnpm script works on macOS and Linux but fails here on Windows:
@@ -88,18 +124,20 @@ export const link = async (
const { origin, projectId, token } = parseShareLink(shareLink);
- const currentConfig = await readFile(GLOBAL_CONFIG_FILE, "utf-8");
- const currentConfigJson = jsonToGlobalConfig(JSON.parse(currentConfig));
+ await withConfigLock(async () => {
+ const currentConfig = await readFile(GLOBAL_CONFIG_FILE, "utf-8");
+ const currentConfigJson = jsonToGlobalConfig(JSON.parse(currentConfig));
- const newConfig: GlobalConfig = {
- ...currentConfigJson,
- [projectId]: {
- origin,
- token,
- },
- };
+ const newConfig: GlobalConfig = {
+ ...currentConfigJson,
+ [projectId]: {
+ origin,
+ token,
+ },
+ };
- await writeFile(GLOBAL_CONFIG_FILE, JSON.stringify(newConfig, null, 2));
+ await writeConfigFile(JSON.stringify(newConfig, null, 2));
+ });
log.info(`Saved credentials for project ${projectId}.
You can find your config at ${GLOBAL_CONFIG_FILE}`);
diff --git a/packages/cli/src/prebuild.ts b/packages/cli/src/prebuild.ts
index 579a7331bd..1bd838c4da 100644
--- a/packages/cli/src/prebuild.ts
+++ b/packages/cli/src/prebuild.ts
@@ -36,6 +36,7 @@ import {
createScope,
findTreeInstanceIds,
getPagePath,
+ getAllPages,
generateResources,
generatePageMeta,
getStaticSiteMapXml,
@@ -47,6 +48,7 @@ import {
ROOT_INSTANCE_ID,
elementComponent,
getAssetUrl,
+ migratePages,
toRuntimeAsset,
} from "@webstudio-is/sdk";
import type { Data } from "@webstudio-is/http-client";
@@ -290,6 +292,8 @@ export const prebuild = async (options: {
const usedMetas = new Map<Instance["component"], WsComponentMeta>(
Object.entries(coreMetas)
);
+ const pages = migratePages(siteData.build.pages);
+ const allPages = getAllPages(pages);
const siteDataByPage: SiteDataByPage = {};
const fontAssetsByPage: Record<Page["id"], string[]> = {};
const backgroundImageAssetsByPage: Record<Page["id"], string[]> = {};
@@ -300,11 +304,11 @@ export const prebuild = async (options: {
assetBaseUrl,
assets: new Map(siteData.assets.map((asset) => [asset.id, asset])),
uploadingImageAssets: [],
- pages: siteData.build.pages,
+ pages,
source: "prebuild",
});
- for (const page of Object.values(siteData.pages)) {
+ for (const page of allPages) {
const instanceMap = new Map(siteData.build.instances);
const pageInstanceSet = findTreeInstanceIds(
instanceMap,
@@ -360,7 +364,7 @@ export const prebuild = async (options: {
dataSources,
resources,
},
- pages: siteData.pages,
+ pages: allPages,
page,
assets: siteData.assets,
};
@@ -459,12 +463,12 @@ export const prebuild = async (options: {
// pass only used metas to not generate unused preset styles
componentMetas: usedMetas,
assetBaseUrl,
- atomic: siteData.build.pages.compiler?.atomicStyles ?? true,
+ atomic: pages.compiler?.atomicStyles ?? true,
});
await createFileIfNotExists(join(generatedDir, "index.css"), cssText);
- for (const page of Object.values(siteData.pages)) {
+ for (const page of allPages) {
const scope = createScope([
// manually maintained list of occupied identifiers
"useState",
@@ -572,13 +576,13 @@ export const prebuild = async (options: {
tagsOverrides: framework.tags,
});
- const projectMeta = siteData.build.pages.meta;
+ const projectMeta = pages.meta;
const contactEmail: undefined | string =
// fallback to user email when contact email is empty string
projectMeta?.contactEmail || siteData.user?.email || undefined;
const favIconAsset = assets.get(projectMeta?.faviconAssetId ?? "")?.name;
- const pagePath = getPagePath(page.id, siteData.build.pages);
+ const pagePath = getPagePath(page.id, pages);
const breakpoints = siteData.build.breakpoints
.map(([_, value]) => ({
@@ -724,7 +728,7 @@ export const prebuild = async (options: {
join(generatedDir, "$resources.sitemap.xml.ts"),
`
export const sitemap = ${JSON.stringify(
- getStaticSiteMapXml(siteData.build.pages, siteData.build.updatedAt),
+ getStaticSiteMapXml(pages, siteData.build.updatedAt),
null,
2
)};
@@ -748,7 +752,7 @@ export const prebuild = async (options: {
`
);
- const redirects = siteData.build.pages?.redirects;
+ const redirects = pages.redirects;
if (redirects !== undefined && redirects.length > 0) {
for (const redirect of redirects) {
const generatedBasename = generateRemixRoute(redirect.old);
diff --git a/packages/domain/src/trpc/domain.ts b/packages/domain/src/trpc/domain.ts
index 97077514f3..85123e88ab 100644
--- a/packages/domain/src/trpc/domain.ts
+++ b/packages/domain/src/trpc/domain.ts
@@ -132,7 +132,7 @@ export const domainRouter = router({
}
const result = await deploymentTrpc.publish.mutate({
- // used to load build data from the builder see routes/rest.build.$buildId.ts
+ // used to load build data from the builder with build.loadProjectDataByBuildId
builderOrigin: env.BUILDER_ORIGIN,
githubSha: env.GITHUB_SHA,
buildId: build.id,
diff --git a/packages/http-client/package.json b/packages/http-client/package.json
index 14c9aed156..57d641c16c 100644
--- a/packages/http-client/package.json
+++ b/packages/http-client/package.json
@@ -12,6 +12,7 @@
"test": "vitest run"
},
"dependencies": {
+ "@trpc/client": "^10.45.2",
"@webstudio-is/sdk": "workspace:*"
},
"devDependencies": {
diff --git a/packages/http-client/src/index.ts b/packages/http-client/src/index.ts
index 7e097cf124..901bf9aa9a 100644
--- a/packages/http-client/src/index.ts
+++ b/packages/http-client/src/index.ts
@@ -5,7 +5,7 @@ import type {
Deployment,
Instance,
Page,
- Pages,
+ SerializedPages,
Prop,
Resource,
StyleDecl,
@@ -13,6 +13,7 @@ import type {
StyleSource,
StyleSourceSelection,
} from "@webstudio-is/sdk";
+import { createTRPCUntypedClient, httpBatchLink } from "@trpc/client";
export type Data = {
page: Page;
@@ -23,7 +24,7 @@ export type Data = {
version: number;
createdAt: string;
updatedAt: string;
- pages: Pages;
+ pages: SerializedPages;
breakpoints: [Breakpoint["id"], Breakpoint][];
styles: [StyleDeclKey, StyleDecl][];
styleSources: [StyleSource["id"], StyleSource][];
@@ -38,32 +39,6 @@ export type Data = {
origin?: string;
};
-// @todo: broken as expects non 200 code
-const getLatestBuildUsingProjectId = async (params: {
- projectId: string;
- origin: string;
- authToken: string;
-}): Promise<{ buildId: string | null }> => {
- const { origin, projectId, authToken } = params;
-
- const { sourceOrigin } = parseBuilderUrl(origin);
-
- const url = new URL(sourceOrigin);
- url.pathname = `/rest/buildId/${projectId}`;
-
- const headers = new Headers();
- headers.set("x-auth-token", authToken);
-
- const response = await fetch(url.href, { headers });
-
- if (response.ok) {
- return await response.json();
- }
-
- const message = await response.text();
- throw new Error(message.slice(0, 1000));
-};
-
export const loadProjectDataByBuildId = async (
params: {
buildId: string;
@@ -75,29 +50,29 @@ export const loadProjectDataByBuildId = async (
| { authToken: string }
)
): Promise<Data> => {
- const { sourceOrigin } = parseBuilderUrl(params.origin);
-
- const url = new URL(sourceOrigin);
-
- url.pathname = `/rest/build/${params.buildId}`;
-
- const headers = new Headers();
- if ("seviceToken" in params) {
- headers.set("Authorization", params.seviceToken);
- } else {
- headers.set("x-auth-token", params.authToken);
- }
+ const headers: Record<string, string> =
+ "seviceToken" in params
+ ? { Authorization: params.seviceToken }
+ : { "x-auth-token": params.authToken };
+
+ return (await createTrpcClient(params.origin, headers).query(
+ "build.loadProjectDataByBuildId",
+ { buildId: params.buildId }
+ )) as Data;
+};
- const response = await fetch(url.href, {
- headers,
+const createTrpcClient = (origin: string, headers: Record<string, string>) => {
+ const { sourceOrigin } = parseBuilderUrl(origin);
+ const url = new URL("/trpc", sourceOrigin);
+
+ return createTRPCUntypedClient({
+ links: [
+ httpBatchLink({
+ url: url.href,
+ headers,
+ }),
+ ],
});
-
- if (response.ok) {
- return await response.json();
- }
-
- const message = await response.text();
- throw new Error(message.slice(0, 1000));
};
export const loadProjectDataByProjectId = async (params: {
@@ -105,16 +80,11 @@ export const loadProjectDataByProjectId = async (params: {
origin: string;
authToken: string;
}): Promise<Data> => {
- const result = await getLatestBuildUsingProjectId(params);
- if (result.buildId === null) {
- throw new Error(`The project is not published yet`);
- }
-
- return await loadProjectDataByBuildId({
- buildId: result.buildId,
- origin: params.origin,
- authToken: params.authToken,
- });
+ return (await createTrpcClient(params.origin, {
+ "x-auth-token": params.authToken,
+ }).query("build.loadProjectDataByProjectId", {
+ projectId: params.projectId,
+ })) as Data;
};
// For easier detecting the builder URL
diff --git a/packages/project-build/src/db/build.ts b/packages/project-build/src/db/build.ts
index 360e5b7cde..91151c64e7 100644
--- a/packages/project-build/src/db/build.ts
+++ b/packages/project-build/src/db/build.ts
@@ -7,17 +7,18 @@ import {
type AppContext,
} from "@webstudio-is/trpc-interface/index.server";
import { db as authDb } from "@webstudio-is/authorization-token/index.server";
-import type {
- Deployment,
- Resource,
- StyleSource,
- Prop,
- DataSource,
- Instance,
- Breakpoint,
- StyleSourceSelection,
- StyleDecl,
- Pages,
+import {
+ migratePages,
+ type Deployment,
+ type Resource,
+ type StyleSource,
+ type Prop,
+ type DataSource,
+ type Instance,
+ type Breakpoint,
+ type StyleSourceSelection,
+ type StyleDecl,
+ serializePages,
} from "@webstudio-is/sdk";
import type { Build, CompactBuild } from "../types";
import { parseDeployment } from "./deployment";
@@ -26,7 +27,7 @@ import { breakCyclesMutable } from "../shared/graph-utils";
import { createPages } from "../template";
import { serializeStyles } from "./styles";
import { serializeStyleSourceSelections } from "./style-source-selections";
-import { parseConfig, serializeConfig, serializeData } from "./build-parser";
+import { parseConfig, serializeData } from "./build-parser";
export {
parseConfig,
@@ -60,7 +61,7 @@ const parseCompactBuild = async (
version: build.version,
createdAt: build.createdAt,
updatedAt: build.updatedAt,
- pages: parseConfig<Pages>(build.pages),
+ pages: migratePages(parseConfig<unknown>(build.pages)),
breakpoints: parseCompactData<Breakpoint>(build.breakpoints),
styles: parseCompactData<StyleDecl>(build.styles),
styleSources: parseCompactData<StyleSource>(build.styleSources),
@@ -192,7 +193,7 @@ export const createBuild = async (
const newBuild = await context.postgrest.client.from("Build").insert({
id: crypto.randomUUID(),
projectId: props.projectId,
- pages: serializeConfig<Pages>(data.pages),
+ pages: JSON.stringify(serializePages(data.pages)),
breakpoints: serializeData<Breakpoint>(data.breakpoints),
styles: serializeStyles(data.styles),
styleSources: serializeData<StyleSource>(data.styleSources),
diff --git a/packages/project-build/src/db/pages.ts b/packages/project-build/src/db/pages.ts
index 274def7104..6ea53a372b 100644
--- a/packages/project-build/src/db/pages.ts
+++ b/packages/project-build/src/db/pages.ts
@@ -1,10 +1,13 @@
-// DEPRECATED: use parseData and serializeData from build.ts
-import type { Pages } from "@webstudio-is/sdk";
+import {
+ migratePages,
+ serializePages as serializePagesData,
+ type Pages,
+} from "@webstudio-is/sdk";
export const parsePages = (pagesString: string): Pages => {
- return JSON.parse(pagesString) as Pages;
+ return migratePages(JSON.parse(pagesString));
};
export const serializePages = (pages: Pages) => {
- return JSON.stringify(pages);
+ return JSON.stringify(serializePagesData(pages));
};
diff --git a/packages/project-build/src/shared/pages-utils.test.ts b/packages/project-build/src/shared/pages-utils.test.ts
index 4e798f3dd1..87085763c5 100644
--- a/packages/project-build/src/shared/pages-utils.test.ts
+++ b/packages/project-build/src/shared/pages-utils.test.ts
@@ -10,23 +10,32 @@ test("createDefaultPages", () => {
})
).toEqual({
meta: {},
- homePage: {
- id: "homePageId",
- name: "Home",
- path: "",
- title: `"Home"`,
- meta: {},
- rootInstanceId: "rootInstanceId",
- systemDataSourceId: "systemDataSourceId",
- },
- pages: [],
- folders: [
- {
- id: "root",
- name: "Root",
- slug: "",
- children: ["homePageId"],
- },
- ],
+ homePageId: "homePageId",
+ rootFolderId: "root",
+ pages: new Map([
+ [
+ "homePageId",
+ {
+ id: "homePageId",
+ name: "Home",
+ path: "",
+ title: `"Home"`,
+ meta: {},
+ rootInstanceId: "rootInstanceId",
+ systemDataSourceId: "systemDataSourceId",
+ },
+ ],
+ ]),
+ folders: new Map([
+ [
+ "root",
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["homePageId"],
+ },
+ ],
+ ]),
});
});
diff --git a/packages/project-build/src/shared/pages-utils.ts b/packages/project-build/src/shared/pages-utils.ts
index 7b7f43f3bd..df7cfaa70a 100644
--- a/packages/project-build/src/shared/pages-utils.ts
+++ b/packages/project-build/src/shared/pages-utils.ts
@@ -27,18 +27,20 @@ export const createDefaultPages = ({
}): Pages => {
// This is a root folder that nobody can delete or going to be able to see.
const rootFolder = createRootFolder([homePageId]);
+ const homePage = {
+ id: homePageId,
+ name: "Home",
+ path: "",
+ title: `"Home"`,
+ meta: {},
+ rootInstanceId,
+ systemDataSourceId,
+ };
return {
meta: {},
- homePage: {
- id: homePageId,
- name: "Home",
- path: "",
- title: `"Home"`,
- meta: {},
- rootInstanceId,
- systemDataSourceId,
- },
- pages: [],
- folders: [rootFolder],
+ homePageId,
+ rootFolderId: ROOT_FOLDER_ID,
+ pages: new Map([[homePageId, homePage]]),
+ folders: new Map([[rootFolder.id, rootFolder]]),
};
};
diff --git a/packages/project-build/src/template.tsx b/packages/project-build/src/template.tsx
index d89fa514c4..16ce607753 100644
--- a/packages/project-build/src/template.tsx
+++ b/packages/project-build/src/template.tsx
@@ -99,28 +99,38 @@ export const createPages = (): WebstudioData => {
);
const pages: Pages = {
- homePage: {
- id: homePageId,
- name: "Home",
- path: "",
- title: `"Home"`,
- meta: {},
- rootInstanceId: homeBodyId,
- },
- pages: [
- {
- id: notFoundPageId,
- name: "404",
- path: "/*",
- title: `"Page not found"`,
- meta: {
- status: `404`,
- excludePageFromSearch: "false",
+ homePageId,
+ rootFolderId: "root",
+ pages: new Map([
+ [
+ homePageId,
+ {
+ id: homePageId,
+ name: "Home",
+ path: "",
+ title: `"Home"`,
+ meta: {},
+ rootInstanceId: homeBodyId,
},
- rootInstanceId: notFoundBodyId,
- },
- ],
- folders: [createRootFolder([homePageId, notFoundPageId])],
+ ],
+ [
+ notFoundPageId,
+ {
+ id: notFoundPageId,
+ name: "404",
+ path: "/*",
+ title: `"Page not found"`,
+ meta: {
+ status: `404`,
+ excludePageFromSearch: "false",
+ },
+ rootInstanceId: notFoundBodyId,
+ },
+ ],
+ ]),
+ folders: new Map([
+ ["root", createRootFolder([homePageId, notFoundPageId])],
+ ]),
};
return { ...data, pages };
diff --git a/packages/project/src/db/build-patch-core.ts b/packages/project/src/db/build-patch-core.ts
index e89ded7e96..7a5ad83e8f 100644
--- a/packages/project/src/db/build-patch-core.ts
+++ b/packages/project/src/db/build-patch-core.ts
@@ -15,6 +15,7 @@ import {
StyleSources,
type StyleSource,
Styles,
+ getHomePage,
} from "@webstudio-is/sdk";
import {
findCycles,
@@ -119,10 +120,10 @@ export const createBuildPatchUpdate = async ({
if (namespace === "pages") {
const pages = buildData.pages ?? parsePages(build.pages);
const currentSocialImageAssetId =
- pages.homePage.meta.socialImageAssetId;
+ getHomePage(pages).meta.socialImageAssetId;
buildData.pages = applyPatches(pages, patches);
- const newSocialImageAssetId =
- buildData.pages.homePage.meta.socialImageAssetId;
+ const newSocialImageAssetId = getHomePage(buildData.pages).meta
+ .socialImageAssetId;
if (currentSocialImageAssetId !== newSocialImageAssetId) {
previewImageAssetId = newSocialImageAssetId || null;
}
diff --git a/packages/project/src/db/build-patch.test.ts b/packages/project/src/db/build-patch.test.ts
index e4f3149f28..f6e26f2f8f 100644
--- a/packages/project/src/db/build-patch.test.ts
+++ b/packages/project/src/db/build-patch.test.ts
@@ -127,6 +127,86 @@ describe("patchBuild", () => {
]);
});
+ test("applies page path changes from normalized page id patches", async () => {
+ let updatedBuild: unknown;
+ server.use(
+ db.get("Build", () =>
+ json([
+ {
+ ...buildRow,
+ pages: JSON.stringify({
+ meta: {},
+ homePageId: "page-1",
+ rootFolderId: "root",
+ pages: [
+ {
+ id: "page-1",
+ name: "Home",
+ path: "",
+ title: "Home",
+ meta: {},
+ rootInstanceId: "body-1",
+ },
+ {
+ id: "page-2",
+ name: "About",
+ path: "/about",
+ title: "About",
+ meta: {},
+ rootInstanceId: "body-1",
+ },
+ ],
+ folders: [
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["page-1", "page-2"],
+ },
+ ],
+ }),
+ },
+ ])
+ ),
+ db.patch("Build", async ({ request }) => {
+ updatedBuild = await request.json();
+ return empty({ headers: { "Content-Range": "*/1" } });
+ })
+ );
+
+ const result = await patchBuild(
+ {
+ buildId: "build-1",
+ projectId: "project-1",
+ clientVersion: 3,
+ transactions: [
+ transaction({
+ payload: [
+ {
+ namespace: "pages",
+ patches: [
+ {
+ op: "replace",
+ path: ["pages", "page-2", "path"],
+ value: "/company",
+ },
+ ],
+ },
+ ],
+ }),
+ ],
+ },
+ createContext()
+ );
+
+ expect(result).toEqual({ status: "ok", version: 4 });
+ expect(
+ JSON.parse((updatedBuild as { pages: string }).pages).pages.find(
+ (page: { id: string }) => page.id === "page-2"
+ )?.path
+ ).toBe("/company");
+ });
+
test("returns ok when retrying a transaction already saved by the server", async () => {
let didPatch = false;
server.use(
diff --git a/packages/react-sdk/src/props.test.ts b/packages/react-sdk/src/props.test.ts
index 27bb83b54d..2b888dabf7 100644
--- a/packages/react-sdk/src/props.test.ts
+++ b/packages/react-sdk/src/props.test.ts
@@ -4,23 +4,56 @@ import { isAttributeNameSafe, normalizeProps } from "./props";
const pagesBase: Pages = {
meta: {},
- homePage: {
- id: "home",
- path: "",
- name: "Home",
- title: "Home",
- rootInstanceId: "instance-1",
- meta: {},
- },
- pages: [],
- folders: [
- {
- id: "root",
- name: "Root",
- slug: "",
- children: [],
- },
- ],
+ homePageId: "home",
+ rootFolderId: "root",
+ pages: new Map([
+ [
+ "home",
+ {
+ id: "home",
+ path: "",
+ name: "Home",
+ title: "Home",
+ rootInstanceId: "instance-1",
+ meta: {},
+ },
+ ],
+ ]),
+ folders: new Map([
+ [
+ "root",
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: [],
+ },
+ ],
+ ]),
+};
+
+const createPages = ({
+ pages,
+ folders,
+}: {
+ pages: Array<Pages["pages"] extends Map<string, infer Page> ? Page : never>;
+ folders: Array<
+ Pages["folders"] extends Map<string, infer Folder> ? Folder : never
+ >;
+}): Pages => ({
+ ...pagesBase,
+ pages: new Map([
+ ...pagesBase.pages,
+ ...pages.map((page) => [page.id, page] as const),
+ ]),
+ folders: new Map(folders.map((folder) => [folder.id, folder] as const)),
+});
+
+const rootFolder = {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: [],
};
test("normalize asset prop into string", () => {
@@ -194,8 +227,7 @@ test("normalize page prop with path into string", () => {
assetBaseUrl: "",
assets: new Map(),
uploadingImageAssets: [],
- pages: {
- ...pagesBase,
+ pages: createPages({
pages: [
{
id: "page1",
@@ -206,8 +238,8 @@ test("normalize page prop with path into string", () => {
meta: {},
},
],
- folders: [],
- },
+ folders: [rootFolder],
+ }),
source: "prebuild",
})
).toEqual([
@@ -246,8 +278,7 @@ test("normalize page prop with path and hash into string", () => {
assetBaseUrl: "",
assets: new Map(),
uploadingImageAssets: [],
- pages: {
- ...pagesBase,
+ pages: createPages({
pages: [
{
id: "page1",
@@ -272,7 +303,7 @@ test("normalize page prop with path and hash into string", () => {
children: ["page1"],
},
],
- },
+ }),
source: "prebuild",
});
expect(result).toEqual([
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
index 50933f7a03..bd193dab03 100644
--- a/packages/sdk/package.json
+++ b/packages/sdk/package.json
@@ -28,6 +28,11 @@
"types": "./lib/types/core-templates.d.ts",
"import": "./lib/core-templates.js"
},
+ "./migrations/webstudio-data": {
+ "webstudio": "./src/migrations/webstudio-data.ts",
+ "types": "./lib/types/migrations/webstudio-data.d.ts",
+ "import": "./lib/migrations/webstudio-data.js"
+ },
"./router-path-test-data": {
"webstudio": "./src/router-path-test-data.ts"
}
@@ -41,11 +46,12 @@
"typecheck": "tsgo --noEmit -p tsconfig.typecheck.json",
"test": "vitest run",
"build:normalize.css": "tsx --conditions=webstudio ./scripts/normalize.css.ts && prettier --write src/__generated__/normalize.css.ts",
- "build": "rm -rf lib && esbuild src/index.ts src/runtime.ts src/__generated__/normalize.css.ts src/core-templates.tsx --outdir=lib --bundle --format=esm --packages=external",
+ "build": "rm -rf lib && esbuild src/index.ts src/runtime.ts src/__generated__/normalize.css.ts src/core-templates.tsx src/migrations/webstudio-data.ts --outdir=lib --bundle --format=esm --packages=external",
"dts": "tsc --project tsconfig.dts.json"
},
"dependencies": {
"@emotion/hash": "^0.9.2",
+ "@webstudio-is/css-data": "workspace:*",
"@webstudio-is/css-engine": "workspace:*",
"@webstudio-is/fonts": "workspace:*",
"@webstudio-is/icons": "workspace:*",
@@ -58,7 +64,6 @@
"zod": "^3.24.2"
},
"devDependencies": {
- "@webstudio-is/css-data": "workspace:*",
"@webstudio-is/template": "workspace:*",
"@webstudio-is/tsconfig": "workspace:*",
"html-tags": "^4.0.0",
diff --git a/packages/sdk/src/index.ts b/packages/sdk/src/index.ts
index 35d0b1dde2..8d58126a1f 100644
--- a/packages/sdk/src/index.ts
+++ b/packages/sdk/src/index.ts
@@ -17,6 +17,7 @@ export * from "./assets";
export * from "./core-metas";
export * from "./instances-utils";
export * from "./page-utils";
+export * from "./migrations";
export * from "./scope";
export * from "./expression";
export * from "./resources-generator";
diff --git a/packages/sdk/src/migrations/index.ts b/packages/sdk/src/migrations/index.ts
new file mode 100644
index 0000000000..c4e34b2701
--- /dev/null
+++ b/packages/sdk/src/migrations/index.ts
@@ -0,0 +1 @@
+export * from "./pages";
diff --git a/packages/sdk/src/migrations/pages.test.ts b/packages/sdk/src/migrations/pages.test.ts
new file mode 100644
index 0000000000..eeccd2a530
--- /dev/null
+++ b/packages/sdk/src/migrations/pages.test.ts
@@ -0,0 +1,448 @@
+import { expect, test } from "vitest";
+import type { Pages } from "../schema/pages";
+import { migratePages, serializePages } from "./pages";
+
+test("keeps current pages shape unchanged", () => {
+ const pages: Pages = {
+ homePageId: "home",
+ rootFolderId: "root",
+ pages: new Map([
+ [
+ "home",
+ {
+ id: "home",
+ name: "Home",
+ path: "",
+ title: `"Home"`,
+ meta: {},
+ rootInstanceId: "homeRoot",
+ },
+ ],
+ ]),
+ folders: new Map([
+ [
+ "root",
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["home"],
+ },
+ ],
+ ]),
+ };
+
+ expect(migratePages(pages)).toBe(pages);
+});
+
+test("serializes map pages into arrays for JSON storage", () => {
+ expect(
+ serializePages({
+ homePageId: "home",
+ rootFolderId: "root",
+ pages: new Map([
+ [
+ "home",
+ {
+ id: "home",
+ name: "Home",
+ path: "",
+ title: `"Home"`,
+ meta: {},
+ rootInstanceId: "homeRoot",
+ },
+ ],
+ ]),
+ folders: new Map([
+ [
+ "root",
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["home"],
+ },
+ ],
+ ]),
+ })
+ ).toEqual({
+ meta: undefined,
+ compiler: undefined,
+ redirects: undefined,
+ homePageId: "home",
+ rootFolderId: "root",
+ pages: [expect.objectContaining({ id: "home" })],
+ folders: [expect.objectContaining({ id: "root", children: ["home"] })],
+ });
+});
+
+test("validates pages before serializing", () => {
+ expect(() =>
+ serializePages({
+ homePageId: "missing",
+ rootFolderId: "root",
+ pages: new Map(),
+ folders: new Map([
+ [
+ "root",
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: [],
+ },
+ ],
+ ]),
+ })
+ ).toThrow();
+});
+
+test("migrates serialized array pages into maps", () => {
+ expect(
+ migratePages({
+ homePageId: "home",
+ rootFolderId: "root",
+ pages: [
+ {
+ id: "home",
+ name: "Home",
+ path: "",
+ title: `"Home"`,
+ meta: {},
+ rootInstanceId: "homeRoot",
+ },
+ ],
+ folders: [
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["home"],
+ },
+ ],
+ }).pages
+ ).toEqual(new Map([["home", expect.objectContaining({ id: "home" })]]));
+});
+
+test("migrates serialized record pages into maps", () => {
+ expect(
+ migratePages({
+ homePageId: "home",
+ rootFolderId: "root",
+ pages: {
+ home: {
+ id: "home",
+ name: "Home",
+ path: "",
+ title: `"Home"`,
+ meta: {},
+ rootInstanceId: "homeRoot",
+ },
+ },
+ folders: {
+ root: {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["home"],
+ },
+ },
+ })
+ ).toEqual({
+ meta: undefined,
+ compiler: undefined,
+ redirects: undefined,
+ homePageId: "home",
+ rootFolderId: "root",
+ pages: new Map([["home", expect.objectContaining({ id: "home" })]]),
+ folders: new Map([
+ [
+ "root",
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["home"],
+ },
+ ],
+ ]),
+ });
+});
+
+test("migrates legacy array pages into id-keyed pages and folders", () => {
+ expect(
+ migratePages({
+ meta: { siteName: "Site" },
+ homePage: {
+ id: "home",
+ name: "Home",
+ path: "",
+ title: `"Home"`,
+ meta: {},
+ rootInstanceId: "homeRoot",
+ },
+ pages: [
+ {
+ id: "nested",
+ name: "Nested",
+ path: "/nested",
+ title: `"Nested"`,
+ meta: {},
+ rootInstanceId: "nestedRoot",
+ },
+ {
+ id: "orphan",
+ name: "Orphan",
+ path: "/orphan",
+ title: `"Orphan"`,
+ meta: {},
+ rootInstanceId: "orphanRoot",
+ },
+ ],
+ folders: [
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["folder"],
+ },
+ {
+ id: "folder",
+ name: "Folder",
+ slug: "folder",
+ children: ["nested"],
+ },
+ ],
+ })
+ ).toEqual({
+ meta: { siteName: "Site" },
+ compiler: undefined,
+ redirects: undefined,
+ homePageId: "home",
+ rootFolderId: "root",
+ pages: new Map([
+ ["home", expect.objectContaining({ id: "home" })],
+ ["nested", expect.objectContaining({ id: "nested" })],
+ ["orphan", expect.objectContaining({ id: "orphan" })],
+ ]),
+ folders: new Map([
+ [
+ "root",
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["home", "folder", "orphan"],
+ },
+ ],
+ [
+ "folder",
+ {
+ id: "folder",
+ name: "Folder",
+ slug: "folder",
+ children: ["nested"],
+ },
+ ],
+ ]),
+ });
+});
+
+test("moves legacy home page to first root child", () => {
+ expect(
+ migratePages({
+ homePage: {
+ id: "home",
+ name: "Home",
+ path: "",
+ title: `"Home"`,
+ meta: {},
+ rootInstanceId: "homeRoot",
+ },
+ pages: [],
+ folders: [
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["folder"],
+ },
+ {
+ id: "folder",
+ name: "Folder",
+ slug: "folder",
+ children: ["home"],
+ },
+ ],
+ }).folders
+ ).toEqual(
+ new Map([
+ [
+ "root",
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["home", "folder"],
+ },
+ ],
+ [
+ "folder",
+ {
+ id: "folder",
+ name: "Folder",
+ slug: "folder",
+ children: [],
+ },
+ ],
+ ])
+ );
+});
+
+test("removes all duplicate legacy home page refs from folders", () => {
+ expect(
+ migratePages({
+ homePage: {
+ id: "home",
+ name: "Home",
+ path: "",
+ title: `"Home"`,
+ meta: {},
+ rootInstanceId: "homeRoot",
+ },
+ pages: [],
+ folders: [
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["home", "home", "folder"],
+ },
+ {
+ id: "folder",
+ name: "Folder",
+ slug: "folder",
+ children: ["home", "home"],
+ },
+ ],
+ }).folders
+ ).toEqual(
+ new Map([
+ [
+ "root",
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["home", "folder"],
+ },
+ ],
+ [
+ "folder",
+ {
+ id: "folder",
+ name: "Folder",
+ slug: "folder",
+ children: [],
+ },
+ ],
+ ])
+ );
+});
+
+test("does not let a legacy page with home id overwrite home page", () => {
+ expect(
+ migratePages({
+ homePage: {
+ id: "home",
+ name: "Home",
+ path: "/",
+ title: `"Home"`,
+ meta: {},
+ rootInstanceId: "homeRoot",
+ },
+ pages: [
+ {
+ id: "home",
+ name: "Duplicate Home",
+ path: "/duplicate",
+ title: `"Duplicate Home"`,
+ meta: {},
+ rootInstanceId: "duplicateRoot",
+ },
+ ],
+ folders: [
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: [],
+ },
+ ],
+ }).pages.get("home")
+ ).toEqual(
+ expect.objectContaining({
+ name: "Home",
+ path: "",
+ rootInstanceId: "homeRoot",
+ })
+ );
+});
+
+test("migrates legacy pages without folders into root folder", () => {
+ expect(
+ migratePages({
+ homePage: {
+ id: "home",
+ name: "Home",
+ path: "/",
+ title: `"Home"`,
+ meta: {},
+ rootInstanceId: "homeRoot",
+ },
+ pages: [
+ {
+ id: "page",
+ name: "Page",
+ path: "/page",
+ title: `"Page"`,
+ meta: {},
+ rootInstanceId: "pageRoot",
+ },
+ ],
+ })
+ ).toEqual({
+ meta: undefined,
+ compiler: undefined,
+ redirects: undefined,
+ homePageId: "home",
+ rootFolderId: "root",
+ pages: new Map([
+ [
+ "home",
+ expect.objectContaining({
+ id: "home",
+ path: "",
+ }),
+ ],
+ ["page", expect.objectContaining({ id: "page" })],
+ ]),
+ folders: new Map([
+ [
+ "root",
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["home", "page"],
+ },
+ ],
+ ]),
+ });
+});
+
+test("throws on unsupported pages shape", () => {
+ expect(() => migratePages({ pages: [], folders: [] })).toThrow(
+ "Pages data has unsupported shape."
+ );
+});
diff --git a/packages/sdk/src/migrations/pages.ts b/packages/sdk/src/migrations/pages.ts
new file mode 100644
index 0000000000..53ec8d444a
--- /dev/null
+++ b/packages/sdk/src/migrations/pages.ts
@@ -0,0 +1,160 @@
+import {
+ Pages as PagesSchema,
+ type Folder,
+ type Page,
+ type Pages,
+} from "../schema/pages";
+import { isRootFolder, ROOT_FOLDER_ID } from "../page-utils";
+
+type LegacyPages = {
+ meta?: Pages["meta"];
+ compiler?: Pages["compiler"];
+ redirects?: Pages["redirects"];
+ homePage: Page;
+ pages: Page[];
+ folders?: Folder[];
+};
+
+export type SerializedPages = Omit<Pages, "pages" | "folders"> & {
+ pages: Page[];
+ folders: Folder[];
+};
+
+type MigratablePages = Omit<Pages, "pages" | "folders"> & {
+ pages: Page[] | Record<Page["id"], Page> | Map<Page["id"], Page>;
+ folders: Folder[] | Record<Folder["id"], Folder> | Map<Folder["id"], Folder>;
+};
+
+const toMap = <Item extends { id: string }>(
+ items: Item[] | Record<Item["id"], Item> | Map<Item["id"], Item>
+) => {
+ if (items instanceof Map) {
+ return items;
+ }
+ const list: Item[] = Array.isArray(items) ? items : Object.values(items);
+ return new Map(list.map((item) => [item.id, item]));
+};
+
+const isLegacyPages = (pages: unknown): pages is LegacyPages => {
+ if (typeof pages !== "object" || pages === null) {
+ return false;
+ }
+ return (
+ "homePage" in pages && Array.isArray((pages as { pages?: unknown }).pages)
+ );
+};
+
+const isSerializedPages = (pages: unknown): pages is MigratablePages => {
+ if (typeof pages !== "object" || pages === null) {
+ return false;
+ }
+ const candidate = pages as Partial<MigratablePages>;
+ return (
+ typeof candidate.homePageId === "string" &&
+ typeof candidate.rootFolderId === "string" &&
+ candidate.pages !== undefined &&
+ candidate.folders !== undefined
+ );
+};
+
+export const serializePages = (pages: Pages): SerializedPages => {
+ const parsedPages = PagesSchema.parse(pages);
+ return {
+ meta: parsedPages.meta,
+ compiler: parsedPages.compiler,
+ redirects: parsedPages.redirects,
+ homePageId: parsedPages.homePageId,
+ rootFolderId: parsedPages.rootFolderId,
+ pages: Array.from(parsedPages.pages.values()),
+ folders: Array.from(parsedPages.folders.values()),
+ };
+};
+
+export const migratePages = (pages: unknown): Pages => {
+ if (
+ isSerializedPages(pages) &&
+ pages.pages instanceof Map &&
+ pages.folders instanceof Map
+ ) {
+ return pages as Pages;
+ }
+
+ if (isSerializedPages(pages)) {
+ return {
+ meta: pages.meta,
+ compiler: pages.compiler,
+ redirects: pages.redirects,
+ homePageId: pages.homePageId,
+ rootFolderId: pages.rootFolderId,
+ pages: toMap<Page>(pages.pages),
+ folders: toMap<Folder>(pages.folders),
+ };
+ }
+
+ if (isLegacyPages(pages) === false) {
+ throw new Error("Pages data has unsupported shape.");
+ }
+
+ const homePage: Page = {
+ ...pages.homePage,
+ path: "",
+ };
+ const nextPages: Pages["pages"] = new Map([[homePage.id, homePage]]);
+ for (const page of pages.pages) {
+ if (page.id === homePage.id) {
+ continue;
+ }
+ nextPages.set(page.id, page);
+ }
+
+ const nextFolders: Pages["folders"] = new Map();
+ for (const folder of pages.folders ?? []) {
+ nextFolders.set(folder.id, { ...folder, children: [...folder.children] });
+ }
+
+ const rootFolder =
+ Array.from(nextFolders.values()).find(isRootFolder) ??
+ pages.folders?.[0] ??
+ ({
+ id: ROOT_FOLDER_ID,
+ name: "Root",
+ slug: "",
+ children: [],
+ } satisfies Folder);
+
+ if (nextFolders.has(rootFolder.id) === false) {
+ nextFolders.set(rootFolder.id, { ...rootFolder, children: [] });
+ }
+
+ const nextRootFolder = nextFolders.get(rootFolder.id);
+ if (nextRootFolder === undefined) {
+ throw new Error("Pages must include a root folder.");
+ }
+
+ for (const folder of nextFolders.values()) {
+ folder.children = folder.children.filter(
+ (childId) => childId !== homePage.id
+ );
+ }
+ nextRootFolder.children.unshift(homePage.id);
+
+ const referencedIds = new Set(
+ Array.from(nextFolders.values()).flatMap((folder) => folder.children)
+ );
+ for (const page of pages.pages) {
+ if (page.id !== homePage.id && referencedIds.has(page.id) === false) {
+ nextRootFolder.children.push(page.id);
+ referencedIds.add(page.id);
+ }
+ }
+
+ return {
+ meta: pages.meta,
+ compiler: pages.compiler,
+ redirects: pages.redirects,
+ homePageId: homePage.id,
+ rootFolderId: rootFolder.id,
+ pages: nextPages,
+ folders: nextFolders,
+ };
+};
diff --git a/packages/sdk/src/migrations/styles.test.ts b/packages/sdk/src/migrations/styles.test.ts
new file mode 100644
index 0000000000..d219658901
--- /dev/null
+++ b/packages/sdk/src/migrations/styles.test.ts
@@ -0,0 +1,44 @@
+import { expect, test } from "vitest";
+import type { StyleProperty } from "@webstudio-is/css-engine";
+import type { Styles } from "../schema/styles";
+import { migrateStylesMutable } from "./styles";
+
+test("expands overflow shorthand", () => {
+ const styles: Styles = new Map([
+ [
+ "base:local:overflow::hover",
+ {
+ breakpointId: "base",
+ styleSourceId: "local",
+ state: ":hover",
+ property: "overflow" as StyleProperty,
+ value: {
+ type: "tuple",
+ value: [
+ { type: "keyword", value: "auto" },
+ { type: "keyword", value: "hidden" },
+ ],
+ },
+ },
+ ],
+ ]);
+
+ migrateStylesMutable(styles);
+
+ expect(Array.from(styles.values())).toEqual([
+ {
+ breakpointId: "base",
+ property: "overflowX",
+ state: ":hover",
+ styleSourceId: "local",
+ value: { type: "keyword", value: "auto" },
+ },
+ {
+ breakpointId: "base",
+ property: "overflowY",
+ state: ":hover",
+ styleSourceId: "local",
+ value: { type: "keyword", value: "hidden" },
+ },
+ ]);
+});
diff --git a/packages/sdk/src/migrations/styles.ts b/packages/sdk/src/migrations/styles.ts
new file mode 100644
index 0000000000..fa1639f7c9
--- /dev/null
+++ b/packages/sdk/src/migrations/styles.ts
@@ -0,0 +1,36 @@
+import { hyphenateProperty, toValue } from "@webstudio-is/css-engine";
+import {
+ camelCaseProperty,
+ expandShorthands,
+ parseCssValue,
+} from "@webstudio-is/css-data";
+import { getStyleDeclKey } from "../schema/styles";
+import type { StyleDecl, Styles } from "../schema/styles";
+
+const migratedShorthands = new Set([
+ "overflow",
+ "transition",
+ "white-space",
+ "background-position",
+]);
+
+export const migrateStylesMutable = (styles: Styles) => {
+ for (const [styleDeclKey, styleDecl] of styles) {
+ const property = hyphenateProperty(styleDecl.property) as string;
+
+ if (migratedShorthands.has(property) === false) {
+ continue;
+ }
+
+ styles.delete(styleDeclKey);
+ const longhands = expandShorthands([[property, toValue(styleDecl.value)]]);
+ for (const [hyphenedProperty, value] of longhands) {
+ const longhandStyleDecl: StyleDecl = {
+ ...styleDecl,
+ property: camelCaseProperty(hyphenedProperty),
+ value: parseCssValue(hyphenedProperty, value),
+ };
+ styles.set(getStyleDeclKey(longhandStyleDecl), longhandStyleDecl);
+ }
+ }
+};
diff --git a/packages/sdk/src/migrations/webstudio-data.test.ts b/packages/sdk/src/migrations/webstudio-data.test.ts
new file mode 100644
index 0000000000..2361ca32ed
--- /dev/null
+++ b/packages/sdk/src/migrations/webstudio-data.test.ts
@@ -0,0 +1,135 @@
+import { expect, test } from "vitest";
+import type { StyleProperty } from "@webstudio-is/css-engine";
+import type { WebstudioData } from "../schema/webstudio";
+import type { Pages } from "../schema/pages";
+import { migrateWebstudioDataMutable } from "./webstudio-data";
+
+const emptyData: WebstudioData = {
+ pages: {
+ homePageId: "homePageId",
+ rootFolderId: "root",
+ pages: new Map([
+ [
+ "homePageId",
+ {
+ id: "homePageId",
+ name: "Home",
+ path: "",
+ title: `"Home"`,
+ meta: {},
+ rootInstanceId: "rootInstanceId",
+ },
+ ],
+ ]),
+ folders: new Map([
+ [
+ "root",
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["homePageId"],
+ },
+ ],
+ ]),
+ },
+ assets: new Map(),
+ dataSources: new Map(),
+ resources: new Map(),
+ instances: new Map(),
+ props: new Map(),
+ breakpoints: new Map(),
+ styleSources: new Map(),
+ styleSourceSelections: new Map(),
+ styles: new Map(),
+};
+
+test("migrates legacy pages inside webstudio data", () => {
+ const data = structuredClone(emptyData);
+ data.pages = {
+ homePage: {
+ id: "homePageId",
+ name: "Home",
+ path: "",
+ title: `"Home"`,
+ meta: {},
+ rootInstanceId: "rootInstanceId",
+ },
+ pages: [
+ {
+ id: "pageId",
+ name: "Page",
+ path: "/page",
+ title: `"Page"`,
+ meta: {},
+ rootInstanceId: "pageRootInstanceId",
+ },
+ ],
+ folders: [
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: [],
+ },
+ ],
+ } as unknown as Pages;
+
+ migrateWebstudioDataMutable(data);
+
+ expect(data.pages).toEqual({
+ homePageId: "homePageId",
+ rootFolderId: "root",
+ pages: new Map([
+ ["homePageId", expect.objectContaining({ id: "homePageId" })],
+ ["pageId", expect.objectContaining({ id: "pageId" })],
+ ]),
+ folders: new Map([
+ [
+ "root",
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["homePageId", "pageId"],
+ },
+ ],
+ ]),
+ });
+});
+
+test("migrates styles inside webstudio data", () => {
+ const data = structuredClone(emptyData);
+ data.styles.set("base:local:overflow::hover", {
+ breakpointId: "base",
+ styleSourceId: "local",
+ state: ":hover",
+ property: "overflow" as StyleProperty,
+ value: {
+ type: "tuple",
+ value: [
+ { type: "keyword", value: "auto" },
+ { type: "keyword", value: "hidden" },
+ ],
+ },
+ });
+
+ migrateWebstudioDataMutable(data);
+
+ expect(Array.from(data.styles.values())).toEqual([
+ {
+ breakpointId: "base",
+ property: "overflowX",
+ state: ":hover",
+ styleSourceId: "local",
+ value: { type: "keyword", value: "auto" },
+ },
+ {
+ breakpointId: "base",
+ property: "overflowY",
+ state: ":hover",
+ styleSourceId: "local",
+ value: { type: "keyword", value: "hidden" },
+ },
+ ]);
+});
diff --git a/packages/sdk/src/migrations/webstudio-data.ts b/packages/sdk/src/migrations/webstudio-data.ts
new file mode 100644
index 0000000000..519b33da93
--- /dev/null
+++ b/packages/sdk/src/migrations/webstudio-data.ts
@@ -0,0 +1,14 @@
+import type { WebstudioData } from "../schema/webstudio";
+import { migratePages } from "./pages";
+import { migrateStylesMutable } from "./styles";
+
+/**
+ * Normalizes persisted project data after loading.
+ *
+ * This is intentionally idempotent because data can pass through multiple
+ * load boundaries before all callers stop seeing older persisted shapes.
+ */
+export const migrateWebstudioDataMutable = (data: WebstudioData) => {
+ data.pages = migratePages(data.pages);
+ migrateStylesMutable(data.styles);
+};
diff --git a/packages/sdk/src/page-utils.test.ts b/packages/sdk/src/page-utils.test.ts
index 1ea2f38784..480a99c8ba 100644
--- a/packages/sdk/src/page-utils.test.ts
+++ b/packages/sdk/src/page-utils.test.ts
@@ -8,50 +8,70 @@ import {
const pages = {
meta: {},
- homePage: {
- id: "home",
- path: "",
- name: "Home",
- title: "Home",
- rootInstanceId: "rootInstanceId",
- meta: {},
- },
- pages: [
- {
- id: "page-1",
- path: "/page-1",
- name: "Page",
- title: "Page",
- rootInstanceId: "rootInstanceId",
- meta: {},
- },
- ],
- folders: [
- {
- id: "root",
- name: "Root",
- slug: "",
- children: ["folderId-1"],
- },
- {
- id: "folderId-1",
- name: "Folder 1",
- slug: "folder-1",
- children: ["folderId-1-1"],
- },
- {
- id: "folderId-1-1",
- name: "Folder 1-1",
- slug: "folder-1-1",
- children: ["folderId-1-1-1"],
- },
- {
- id: "folderId-1-1-1",
- name: "Folder 1-1-1",
- slug: "folder-1-1-1",
- children: ["page-1"],
- },
- ],
+ homePageId: "home",
+ rootFolderId: "root",
+ pages: new Map([
+ [
+ "home",
+ {
+ id: "home",
+ path: "",
+ name: "Home",
+ title: "Home",
+ rootInstanceId: "rootInstanceId",
+ meta: {},
+ },
+ ],
+ [
+ "page-1",
+ {
+ id: "page-1",
+ path: "/page-1",
+ name: "Page",
+ title: "Page",
+ rootInstanceId: "rootInstanceId",
+ meta: {},
+ },
+ ],
+ ]),
+ folders: new Map([
+ [
+ "root",
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["folderId-1"],
+ },
+ ],
+ [
+ "folderId-1",
+ {
+ id: "folderId-1",
+ name: "Folder 1",
+ slug: "folder-1",
+ children: ["folderId-1-1"],
+ },
+ ],
+ [
+ "folderId-1-1",
+ {
+ id: "folderId-1-1",
+ name: "Folder 1-1",
+ slug: "folder-1-1",
+ children: ["folderId-1-1-1"],
+ },
+ ],
+ [
+ "folderId-1-1-1",
+ {
+ id: "folderId-1-1-1",
+ name: "Folder 1-1-1",
+ slug: "folder-1-1-1",
+ children: ["page-1"],
+ },
+ ],
+ ]),
} satisfies Pages;
describe("getPagePath", () => {
@@ -87,26 +107,26 @@ describe("getPagePath", () => {
describe("findPageByIdOrPath", () => {
test("home page by id", () => {
const page = findPageByIdOrPath("home", pages);
- expect(page).toEqual(pages.homePage);
+ expect(page).toEqual(pages.pages.get("home"));
});
test("home page by path /", () => {
const page = findPageByIdOrPath("/", pages);
- expect(page).toEqual(pages.homePage);
+ expect(page).toEqual(pages.pages.get("home"));
});
test("home page by empty path", () => {
const page = findPageByIdOrPath("", pages);
- expect(page).toEqual(pages.homePage);
+ expect(page).toEqual(pages.pages.get("home"));
});
test("find page by id", () => {
const page = findPageByIdOrPath("page-1", pages);
- expect(page).toEqual(pages.pages[0]);
+ expect(page).toEqual(pages.pages.get("page-1"));
});
test("find page by nested path", () => {
const page = findPageByIdOrPath(
"/folder-1/folder-1-1/folder-1-1-1/page-1",
pages
);
- expect(page).toEqual(pages.pages[0]);
+ expect(page).toEqual(pages.pages.get("page-1"));
});
});
diff --git a/packages/sdk/src/page-utils.ts b/packages/sdk/src/page-utils.ts
index f68611936b..9bbd4ed85c 100644
--- a/packages/sdk/src/page-utils.ts
+++ b/packages/sdk/src/page-utils.ts
@@ -10,6 +10,36 @@ export const ROOT_FOLDER_ID = "root";
export const isRootFolder = ({ id }: { id: Folder["id"] }) =>
id === ROOT_FOLDER_ID;
+export const getPageById = (
+ pages: Pages,
+ pageId: Page["id"]
+): Page | undefined => {
+ return pages.pages.get(pageId);
+};
+
+export const getFolderById = (
+ pages: Pages,
+ folderId: Folder["id"]
+): Folder | undefined => {
+ return pages.folders.get(folderId);
+};
+
+export const getAllPages = (pages: Pages): Page[] => {
+ return Array.from(pages.pages.values());
+};
+
+export const getAllFolders = (pages: Pages): Folder[] => {
+ return Array.from(pages.folders.values());
+};
+
+export const getHomePage = (pages: Pages): Page => {
+ const homePage = getPageById(pages, pages.homePageId);
+ if (homePage === undefined) {
+ throw new Error(`Home page "${pages.homePageId}" was not found.`);
+ }
+ return homePage;
+};
+
/**
* Find a page by id or path.
*/
@@ -17,10 +47,10 @@ export const findPageByIdOrPath = (
idOrPath: string,
pages: Pages
): Page | undefined => {
- if (idOrPath === "" || idOrPath === "/" || idOrPath === pages.homePage.id) {
- return pages.homePage;
+ if (idOrPath === "" || idOrPath === "/" || idOrPath === pages.homePageId) {
+ return getHomePage(pages);
}
- return pages.pages.find(
+ return getAllPages(pages).find(
(page) => page.id === idOrPath || getPagePath(page.id, pages) === idOrPath
);
};
@@ -30,9 +60,10 @@ export const findPageByIdOrPath = (
*/
export const findParentFolderByChildId = (
id: Folder["id"] | Page["id"],
- folders: Array<Folder>
+ folders: Iterable<Folder> | Map<Folder["id"], Folder>
): Folder | undefined => {
- for (const folder of folders) {
+ const folderList = folders instanceof Map ? folders.values() : folders;
+ for (const folder of folderList) {
if (folder.children.includes(id)) {
return folder;
}
@@ -45,7 +76,7 @@ export const findParentFolderByChildId = (
export const getPagePath = (id: Folder["id"] | Page["id"], pages: Pages) => {
const foldersMap = new Map<Folder["id"], Folder>();
const childParentMap = new Map<Folder["id"] | Page["id"], Folder["id"]>();
- for (const folder of pages.folders) {
+ for (const folder of getAllFolders(pages)) {
foldersMap.set(folder.id, folder);
for (const childId of folder.children) {
childParentMap.set(childId, folder.id);
@@ -56,7 +87,7 @@ export const getPagePath = (id: Folder["id"] | Page["id"], pages: Pages) => {
let currentId: undefined | string = id;
// In case id is a page id
- const allPages = [pages.homePage, ...pages.pages];
+ const allPages = getAllPages(pages);
for (const page of allPages) {
if (page.id === id) {
paths.push(page.path);
@@ -78,7 +109,7 @@ export const getPagePath = (id: Folder["id"] | Page["id"], pages: Pages) => {
};
export const getStaticSiteMapXml = (pages: Pages, updatedAt: string) => {
- const allPages = [pages.homePage, ...pages.pages];
+ const allPages = getAllPages(pages);
return (
allPages
.filter((page) => (page.meta.documentType ?? "html") === "html")
diff --git a/packages/sdk/src/schema/pages.test.ts b/packages/sdk/src/schema/pages.test.ts
index a0ce119bc2..d0aebe08f3 100644
--- a/packages/sdk/src/schema/pages.test.ts
+++ b/packages/sdk/src/schema/pages.test.ts
@@ -1,5 +1,258 @@
-import { describe, test, expect } from "vitest";
-import { OldPagePath, PagePath, ProjectNewRedirectPath } from "./pages";
+import { describe, expect, test } from "vitest";
+import { OldPagePath, PagePath, Pages, ProjectNewRedirectPath } from "./pages";
+
+const validPages = {
+ homePageId: "home",
+ rootFolderId: "root",
+ pages: new Map([
+ [
+ "home",
+ {
+ id: "home",
+ name: "Home",
+ path: "",
+ title: `"Home"`,
+ meta: {},
+ rootInstanceId: "homeRoot",
+ },
+ ],
+ ]),
+ folders: new Map([
+ [
+ "root",
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["home"],
+ },
+ ],
+ ]),
+};
+
+test("validates home page id references an existing page", () => {
+ expect(
+ Pages.safeParse({
+ ...validPages,
+ homePageId: "missing",
+ }).error?.issues
+ ).toEqual(
+ expect.arrayContaining([
+ expect.objectContaining({
+ path: ["homePageId"],
+ message: "Home page must reference an existing page",
+ }),
+ ])
+ );
+});
+
+test("validates root folder id references an existing folder", () => {
+ expect(
+ Pages.safeParse({
+ ...validPages,
+ rootFolderId: "missing",
+ }).error?.issues
+ ).toEqual([
+ expect.objectContaining({
+ path: ["rootFolderId"],
+ message: "Root folder must reference an existing folder",
+ }),
+ ]);
+});
+
+test("validates home page path is empty", () => {
+ expect(
+ Pages.safeParse({
+ ...validPages,
+ pages: new Map(validPages.pages).set("home", {
+ ...validPages.pages.get("home")!,
+ path: "/home",
+ }),
+ }).error?.issues
+ ).toEqual([
+ expect.objectContaining({
+ path: ["pages", "home", "path"],
+ message: "Home page path must be empty",
+ }),
+ ]);
+});
+
+test("validates non-home page path is not empty", () => {
+ expect(
+ Pages.safeParse({
+ ...validPages,
+ pages: new Map(validPages.pages).set("other", {
+ id: "other",
+ name: "Other",
+ path: "",
+ title: `"Other"`,
+ meta: {},
+ rootInstanceId: "otherRoot",
+ }),
+ folders: new Map(validPages.folders).set("root", {
+ ...validPages.folders.get("root")!,
+ children: ["home", "other"],
+ }),
+ }).error?.issues
+ ).toEqual([
+ expect.objectContaining({
+ path: ["pages", "other", "path"],
+ message: "Page path can't be empty",
+ }),
+ ]);
+});
+
+test("validates page id matches its record key", () => {
+ expect(
+ Pages.safeParse({
+ ...validPages,
+ pages: new Map(validPages.pages).set("home", {
+ ...validPages.pages.get("home")!,
+ id: "other",
+ }),
+ }).error?.issues
+ ).toEqual(
+ expect.arrayContaining([
+ expect.objectContaining({
+ path: ["pages", "home", "id"],
+ message: "Page id must match its record key",
+ }),
+ ])
+ );
+});
+
+test("validates folder id matches its record key", () => {
+ expect(
+ Pages.safeParse({
+ ...validPages,
+ folders: new Map(validPages.folders).set("root", {
+ ...validPages.folders.get("root")!,
+ id: "other",
+ }),
+ }).error?.issues
+ ).toEqual([
+ expect.objectContaining({
+ path: ["folders", "root", "id"],
+ message: "Folder id must match its record key",
+ }),
+ ]);
+});
+
+test("validates folder children reference existing pages or folders", () => {
+ expect(
+ Pages.safeParse({
+ ...validPages,
+ folders: new Map(validPages.folders).set("root", {
+ ...validPages.folders.get("root")!,
+ children: ["home", "missing"],
+ }),
+ }).error?.issues
+ ).toEqual([
+ expect.objectContaining({
+ path: ["folders", "root", "children", 1],
+ message: "Folder child must reference an existing page or folder",
+ }),
+ ]);
+});
+
+test("validates root folder starts with home page", () => {
+ expect(
+ Pages.safeParse({
+ ...validPages,
+ pages: new Map(validPages.pages).set("other", {
+ id: "other",
+ name: "Other",
+ path: "/other",
+ title: `"Other"`,
+ meta: {},
+ rootInstanceId: "otherRoot",
+ }),
+ folders: new Map(validPages.folders).set("root", {
+ ...validPages.folders.get("root")!,
+ children: ["other", "home"],
+ }),
+ }).error?.issues
+ ).toEqual([
+ expect.objectContaining({
+ path: ["folders", "root", "children"],
+ message: "Root folder must start with the home page",
+ }),
+ ]);
+});
+
+test("validates root folder is not nested", () => {
+ expect(
+ Pages.safeParse({
+ ...validPages,
+ folders: new Map(validPages.folders).set("folder", {
+ id: "folder",
+ name: "Folder",
+ slug: "folder",
+ children: ["root"],
+ }),
+ }).error?.issues
+ ).toEqual([
+ expect.objectContaining({
+ path: ["folders", "folder", "children", 0],
+ message: "Root folder can't be nested",
+ }),
+ ]);
+});
+
+test("validates children are registered in only one folder", () => {
+ expect(
+ Pages.safeParse({
+ ...validPages,
+ folders: new Map(validPages.folders).set("folder", {
+ id: "folder",
+ name: "Folder",
+ slug: "folder",
+ children: ["home"],
+ }),
+ }).error?.issues
+ ).toEqual([
+ expect.objectContaining({
+ path: ["folders", "folder", "children", 0],
+ message: `Child is already registered in folder "root"`,
+ }),
+ ]);
+});
+
+test("validates folders do not contain cycles", () => {
+ expect(
+ Pages.safeParse({
+ ...validPages,
+ folders: new Map([
+ ...validPages.folders,
+ [
+ "folderA",
+ {
+ id: "folderA",
+ name: "Folder A",
+ slug: "folder-a",
+ children: ["folderB"],
+ },
+ ],
+ [
+ "folderB",
+ {
+ id: "folderB",
+ name: "Folder B",
+ slug: "folder-b",
+ children: ["folderA"],
+ },
+ ],
+ ]),
+ }).error?.issues
+ ).toEqual(
+ expect.arrayContaining([
+ expect.objectContaining({
+ path: ["folders", "folderA", "children"],
+ message: "Folders can't contain cycles",
+ }),
+ ])
+ );
+});
describe("OldPagePath", () => {
describe("basic validation", () => {
@@ -101,8 +354,6 @@ describe("OldPagePath", () => {
});
describe("non-Latin characters (Unicode/UTF-8)", () => {
- // Chinese characters - common in Chinese websites
- // Examples from https://aubreyyung.com/chinese-url-seo/
test("accepts Chinese characters (Simplified)", () => {
expect(OldPagePath.safeParse("/关于我们").success).toBe(true);
expect(OldPagePath.safeParse("/产品/手机").success).toBe(true);
@@ -115,7 +366,6 @@ describe("OldPagePath", () => {
expect(OldPagePath.safeParse("/繁體中文").success).toBe(true);
});
- // Japanese characters
test("accepts Japanese characters (Hiragana)", () => {
expect(OldPagePath.safeParse("/こんにちは").success).toBe(true);
expect(OldPagePath.safeParse("/ブログ/記事").success).toBe(true);
@@ -130,52 +380,44 @@ describe("OldPagePath", () => {
expect(OldPagePath.safeParse("/東京").success).toBe(true);
});
- // Korean characters
test("accepts Korean characters (Hangul)", () => {
expect(OldPagePath.safeParse("/한국어").success).toBe(true);
expect(OldPagePath.safeParse("/블로그/포스트").success).toBe(true);
expect(OldPagePath.safeParse("/서울").success).toBe(true);
});
- // Cyrillic characters (Russian, etc.)
test("accepts Cyrillic characters", () => {
expect(OldPagePath.safeParse("/привет").success).toBe(true);
expect(OldPagePath.safeParse("/о-нас").success).toBe(true);
expect(OldPagePath.safeParse("/блог/статья").success).toBe(true);
});
- // Arabic characters
test("accepts Arabic characters", () => {
expect(OldPagePath.safeParse("/مرحبا").success).toBe(true);
expect(OldPagePath.safeParse("/عن-الشركة").success).toBe(true);
});
- // Hebrew characters
test("accepts Hebrew characters", () => {
expect(OldPagePath.safeParse("/שלום").success).toBe(true);
expect(OldPagePath.safeParse("/אודות").success).toBe(true);
});
- // Thai characters
test("accepts Thai characters", () => {
expect(OldPagePath.safeParse("/สวัสดี").success).toBe(true);
expect(OldPagePath.safeParse("/เกี่ยวกับเรา").success).toBe(true);
});
- // Greek characters
test("accepts Greek characters", () => {
expect(OldPagePath.safeParse("/γεια").success).toBe(true);
expect(OldPagePath.safeParse("/σχετικά").success).toBe(true);
});
- // Mixed Latin and non-Latin
test("accepts mixed Latin and non-Latin characters", () => {
expect(OldPagePath.safeParse("/blog/关于").success).toBe(true);
expect(OldPagePath.safeParse("/news/港聞").success).toBe(true);
expect(OldPagePath.safeParse("/category/日本語").success).toBe(true);
});
- // European characters with diacritics
test("accepts European characters with diacritics", () => {
expect(OldPagePath.safeParse("/über-uns").success).toBe(true);
expect(OldPagePath.safeParse("/café").success).toBe(true);
@@ -184,7 +426,6 @@ describe("OldPagePath", () => {
expect(OldPagePath.safeParse("/résumé").success).toBe(true);
});
- // Emoji (while unusual, they are valid Unicode)
test("accepts emoji characters", () => {
expect(OldPagePath.safeParse("/🎉").success).toBe(true);
expect(OldPagePath.safeParse("/hello-🌍").success).toBe(true);
@@ -235,9 +476,6 @@ describe("ProjectNewRedirectPath", () => {
});
test("rejects truly invalid URLs", () => {
- // Note: ProjectNewRedirectPath uses new URL(data, baseURL) which is very permissive
- // It treats most strings as valid relative paths. The only truly invalid inputs
- // are those that cannot be parsed as URLs at all.
expect(ProjectNewRedirectPath.safeParse("http://[invalid").success).toBe(
false
);
diff --git a/packages/sdk/src/schema/pages.ts b/packages/sdk/src/schema/pages.ts
index 27b8fff5c9..fd7a0da730 100644
--- a/packages/sdk/src/schema/pages.ts
+++ b/packages/sdk/src/schema/pages.ts
@@ -9,8 +9,8 @@ export type System = {
const MIN_TITLE_LENGTH = 2;
-const PageId = z.string();
-const FolderId = z.string();
+export const PageId = z.string();
+export const FolderId = z.string();
export const FolderName = z
.string()
@@ -84,11 +84,6 @@ export const HomePagePath = z
.string()
.refine((path) => path === "", "Home page path must be empty");
-const HomePage = z.object({
- ...commonPageFields,
- path: HomePagePath,
-});
-
const DefaultPagePage = z
.string()
.refine((path) => path !== "", "Can't be empty")
@@ -150,7 +145,7 @@ export const PagePath = DefaultPagePage.refine(
const Page = z.object({
...commonPageFields,
- path: PagePath,
+ path: z.union([HomePagePath, PagePath]),
});
const ProjectMeta = z.object({
@@ -191,15 +186,143 @@ export type CompilerSettings = z.infer<typeof CompilerSettings>;
export type Page = z.infer<typeof Page>;
-export const Pages = z.object({
- meta: ProjectMeta.optional(),
- compiler: CompilerSettings.optional(),
- redirects: z.array(PageRedirect).optional(),
- homePage: HomePage,
- pages: z.array(Page),
- folders: z
- .array(Folder)
- .refine((folders) => folders.length > 0, "Folders can't be empty"),
-});
+export const Pages = z
+ .object({
+ meta: ProjectMeta.optional(),
+ compiler: CompilerSettings.optional(),
+ redirects: z.array(PageRedirect).optional(),
+ homePageId: PageId,
+ rootFolderId: FolderId,
+ pages: z.map(PageId, Page),
+ folders: z
+ .map(FolderId, Folder)
+ .refine((folders) => folders.size > 0, "Folders can't be empty"),
+ })
+ .superRefine((pages, context) => {
+ const homePage = pages.pages.get(pages.homePageId);
+ const rootFolder = pages.folders.get(pages.rootFolderId);
+ if (homePage === undefined) {
+ context.addIssue({
+ code: z.ZodIssueCode.custom,
+ path: ["homePageId"],
+ message: "Home page must reference an existing page",
+ });
+ }
+ if (rootFolder === undefined) {
+ context.addIssue({
+ code: z.ZodIssueCode.custom,
+ path: ["rootFolderId"],
+ message: "Root folder must reference an existing folder",
+ });
+ }
+ if (homePage !== undefined && homePage.path !== "") {
+ context.addIssue({
+ code: z.ZodIssueCode.custom,
+ path: ["pages", pages.homePageId, "path"],
+ message: "Home page path must be empty",
+ });
+ }
+ for (const [pageId, page] of pages.pages) {
+ if (page.id !== pageId) {
+ context.addIssue({
+ code: z.ZodIssueCode.custom,
+ path: ["pages", pageId, "id"],
+ message: "Page id must match its record key",
+ });
+ }
+ if (pageId !== pages.homePageId && page.path === "") {
+ context.addIssue({
+ code: z.ZodIssueCode.custom,
+ path: ["pages", pageId, "path"],
+ message: "Page path can't be empty",
+ });
+ }
+ }
+ for (const [folderId, folder] of pages.folders) {
+ if (folder.id !== folderId) {
+ context.addIssue({
+ code: z.ZodIssueCode.custom,
+ path: ["folders", folderId, "id"],
+ message: "Folder id must match its record key",
+ });
+ }
+ for (const [index, childId] of folder.children.entries()) {
+ if (
+ pages.pages.has(childId) === false &&
+ pages.folders.has(childId) === false
+ ) {
+ context.addIssue({
+ code: z.ZodIssueCode.custom,
+ path: ["folders", folderId, "children", index],
+ message: "Folder child must reference an existing page or folder",
+ });
+ }
+ if (childId === pages.rootFolderId) {
+ context.addIssue({
+ code: z.ZodIssueCode.custom,
+ path: ["folders", folderId, "children", index],
+ message: "Root folder can't be nested",
+ });
+ }
+ }
+ }
+ if (
+ rootFolder !== undefined &&
+ rootFolder.children[0] !== pages.homePageId
+ ) {
+ context.addIssue({
+ code: z.ZodIssueCode.custom,
+ path: ["folders", pages.rootFolderId, "children"],
+ message: "Root folder must start with the home page",
+ });
+ }
+
+ const childParents = new Map<Page["id"] | Folder["id"], Folder["id"]>();
+ for (const [folderId, folder] of pages.folders) {
+ for (const [index, childId] of folder.children.entries()) {
+ const parentId = childParents.get(childId);
+ if (parentId !== undefined) {
+ context.addIssue({
+ code: z.ZodIssueCode.custom,
+ path: ["folders", folderId, "children", index],
+ message: `Child is already registered in folder "${parentId}"`,
+ });
+ continue;
+ }
+ childParents.set(childId, folderId);
+ }
+ }
+
+ const hasFolderCycle = (
+ folderId: Folder["id"],
+ path = new Set<Folder["id"]>()
+ ): boolean => {
+ if (path.has(folderId)) {
+ return true;
+ }
+ const folder = pages.folders.get(folderId);
+ if (folder === undefined) {
+ return false;
+ }
+ path.add(folderId);
+ for (const childId of folder.children) {
+ if (pages.folders.has(childId) && hasFolderCycle(childId, path)) {
+ return true;
+ }
+ }
+ path.delete(folderId);
+ return false;
+ };
+
+ for (const folderId of pages.folders.keys()) {
+ if (hasFolderCycle(folderId)) {
+ context.addIssue({
+ code: z.ZodIssueCode.custom,
+ path: ["folders", folderId, "children"],
+ message: "Folders can't contain cycles",
+ });
+ }
+ }
+ });
export type Pages = z.infer<typeof Pages>;
diff --git a/packages/sdk/tsconfig.dts.json b/packages/sdk/tsconfig.dts.json
index 7fd574980a..0acd471d1c 100644
--- a/packages/sdk/tsconfig.dts.json
+++ b/packages/sdk/tsconfig.dts.json
@@ -3,7 +3,8 @@
"include": [
"src/index.ts",
"src/runtime.ts",
- "src/__generated__/normalize.css.ts"
+ "src/__generated__/normalize.css.ts",
+ "src/migrations/webstudio-data.ts"
],
"compilerOptions": {
"declarationDir": "lib/types"
diff --git a/packages/trpc-interface/src/shared/deployment.ts b/packages/trpc-interface/src/shared/deployment.ts
index 9aaa03caaa..fa81839eb6 100644
--- a/packages/trpc-interface/src/shared/deployment.ts
+++ b/packages/trpc-interface/src/shared/deployment.ts
@@ -3,7 +3,7 @@ import { router, procedure } from "./trpc";
// Has corresponding type in saas
export const PublishInput = z.object({
- // used to load build data from the builder see routes/rest.build.$buildId.ts
+ // used to load build data from the builder with build.loadProjectDataByBuildId
buildId: z.string(),
builderOrigin: z.string(),
githubSha: z.string().optional(),
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 6c9dfb550c..f273891e32 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -1086,6 +1086,9 @@ importers:
'@emotion/hash':
specifier: ^0.9.2
version: 0.9.2
+ '@trpc/client':
+ specifier: ^10.45.2
+ version: 10.45.2(@trpc/[email protected])
acorn:
specifier: ^8.14.1
version: 8.14.1
@@ -1627,6 +1630,9 @@ importers:
packages/http-client:
dependencies:
+ '@trpc/client':
+ specifier: ^10.45.2
+ version: 10.45.2(@trpc/[email protected])
'@webstudio-is/sdk':
specifier: workspace:*
version: link:../sdk
@@ -1914,6 +1920,9 @@ importers:
'@emotion/hash':
specifier: ^0.9.2
version: 0.9.2
+ '@webstudio-is/css-data':
+ specifier: workspace:*
+ version: link:../css-data
'@webstudio-is/css-engine':
specifier: workspace:*
version: link:../css-engine
@@ -1945,9 +1954,6 @@ importers:
specifier: ^3.24.2
version: 3.24.2
devDependencies:
- '@webstudio-is/css-data':
- specifier: workspace:*
- version: link:../css-data
'@webstudio-is/template':
specifier: workspace:*
version: link:../template