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.

feat: Page folders (#2745)

Oleg Isonen5a5382c97597
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 5f7658c013..29207c1843 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
@@ -15,6 +15,7 @@ import {
import { setMockEnv } from "~/shared/env";
// eslint-disable-next-line import/no-internal-modules
import catPath from "./props-panel.stories.assets/cat.jpg";
+import { createDefaultPages } from "@webstudio-is/project-build";
setMockEnv({ ASSET_BASE_URL: catPath.replace("cat.jpg", "") });
@@ -34,7 +35,7 @@ const page = (name: string, path: string) => ({
});
$pages.set({
- meta: {},
+ ...createDefaultPages({ rootInstanceId: unique() }),
homePage: page("Home", "/"),
pages: [
page("About", "/about"),
diff --git a/apps/builder/app/builder/features/settings-panel/variables-section.stories.tsx b/apps/builder/app/builder/features/settings-panel/variables-section.stories.tsx
index 87994359f3..d9b5fd8b2e 100644
--- a/apps/builder/app/builder/features/settings-panel/variables-section.stories.tsx
+++ b/apps/builder/app/builder/features/settings-panel/variables-section.stories.tsx
@@ -1,5 +1,4 @@
import type { Meta, StoryObj } from "@storybook/react";
-import type { Page } from "@webstudio-is/sdk";
import { Box } from "@webstudio-is/design-system";
import { VariablesSection as VariablesSectionComponent } from "./variables-section";
import {
@@ -9,6 +8,7 @@ import {
$instances,
} from "~/shared/nano-states";
import { registerContainers } from "~/shared/sync";
+import { createDefaultPages } from "@webstudio-is/project-build";
export default {
title: "Builder/Variables Section",
@@ -23,10 +23,7 @@ $instances.set(
])
);
$selectedPageId.set("home");
-$pages.set({
- homePage: { id: "home", rootInstanceId: "root" } as Page,
- pages: [],
-});
+$pages.set(createDefaultPages({ rootInstanceId: "root" }));
export const VariablesSection: StoryObj = {
render: () => (
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/folder-settings.tsx b/apps/builder/app/builder/features/sidebar-left/panels/pages/folder-settings.tsx
new file mode 100644
index 0000000000..bce997df94
--- /dev/null
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/folder-settings.tsx
@@ -0,0 +1,525 @@
+import { z } from "zod";
+import { type FocusEventHandler, useState, useCallback } from "react";
+import { useStore } from "@nanostores/react";
+import { useDebouncedCallback } from "use-debounce";
+import { useUnmount } from "react-use";
+import slugify from "slugify";
+import { Folder, FolderName, FolderSlug, Pages } from "@webstudio-is/sdk";
+import {
+ theme,
+ Button,
+ Box,
+ Label,
+ InputErrorsTooltip,
+ Tooltip,
+ InputField,
+ Grid,
+ ScrollArea,
+ rawTheme,
+ Flex,
+ Select,
+} from "@webstudio-is/design-system";
+import {
+ ChevronDoubleLeftIcon,
+ TrashIcon,
+ HelpIcon,
+} from "@webstudio-is/icons";
+import { useIds } from "~/shared/form-utils";
+import { Header, HeaderSuffixSpacer } from "../../header";
+import { $pages } from "~/shared/nano-states";
+import { nanoid } from "nanoid";
+import { serverSyncStore } from "~/shared/sync";
+import { useEffectEvent } from "~/builder/features/ai/hooks/effect-event";
+import { removeByMutable } from "~/shared/array-utils";
+import {
+ findParentFolderByChildId,
+ cleanupChildRefsMutable,
+ isSlugUsed,
+} from "./page-utils";
+import { createRootFolder } from "@webstudio-is/project-build";
+
+const fieldDefaultValues = {
+ name: "Untitled",
+ slug: "untitled",
+ parentFolderId: createRootFolder().id,
+};
+
+const fieldNames = Object.keys(
+ fieldDefaultValues
+) as (keyof typeof fieldDefaultValues)[];
+
+type FieldName = (typeof fieldNames)[number];
+
+type Values = typeof fieldDefaultValues;
+
+type Errors = {
+ [fieldName in FieldName]?: string[];
+};
+
+const FolderValues = z.object({
+ name: FolderName,
+ slug: FolderSlug,
+});
+
+const validateValues = (
+ pages: undefined | Pages,
+ values: Values,
+ folderId?: Folder["id"]
+): Errors => {
+ const parsedResult = FolderValues.safeParse(values);
+ const errors: Errors = {};
+ if (parsedResult.success === false) {
+ return parsedResult.error.formErrors.fieldErrors;
+ }
+ if (pages !== undefined && values.slug !== undefined) {
+ if (
+ isSlugUsed(
+ values.slug,
+ pages.folders,
+ values.parentFolderId,
+ folderId
+ ) === false
+ ) {
+ errors.slug = errors.slug ?? [];
+ errors.slug.push(`Slug "${values.slug}" is already in use`);
+ }
+ }
+ return errors;
+};
+
+const toFormValues = (
+ folderId: Folder["id"],
+ folders: Array<Folder>
+): Values => {
+ const folder = folders.find(({ id }) => id === folderId);
+ const parentFolder = findParentFolderByChildId(folderId, folders);
+ return {
+ name: folder?.name ?? "",
+ slug: folder?.slug ?? "",
+ parentFolderId: parentFolder?.id ?? "root",
+ };
+};
+
+const autoSelectHandler: FocusEventHandler<HTMLInputElement> = (event) =>
+ event.target.select();
+
+const FormFields = ({
+ disabled,
+ autoSelect,
+ errors,
+ values,
+ folderId,
+ onChange,
+}: {
+ disabled?: boolean;
+ autoSelect?: boolean;
+ errors: Errors;
+ values: Values;
+ folderId: Folder["id"];
+ onChange: (
+ event: {
+ [K in keyof Values]: {
+ field: K;
+ value: Values[K];
+ };
+ }[keyof Values]
+ ) => void;
+}) => {
+ const fieldIds = useIds(fieldNames);
+ const pages = useStore($pages);
+
+ if (pages === undefined) {
+ return;
+ }
+
+ // @todo this is a hack to get the scroll area to work needs to be removed
+ const TOPBAR_HEIGHT = 40;
+ const HEADER_HEIGHT = 40;
+ const FOOTER_HEIGHT = 24;
+ const SCROLL_AREA_DELTA = TOPBAR_HEIGHT + HEADER_HEIGHT + FOOTER_HEIGHT;
+
+ return (
+ <Grid>
+ <ScrollArea css={{ maxHeight: `calc(100vh - ${SCROLL_AREA_DELTA}px)` }}>
+ <Grid gap={3} css={{ my: theme.spacing[5], mx: theme.spacing[8] }}>
+ <Grid gap={1}>
+ <Label htmlFor={fieldIds.name}>Folder Name</Label>
+ <InputErrorsTooltip errors={errors.name}>
+ <InputField
+ tabIndex={1}
+ color={errors.name && "error"}
+ id={fieldIds.name}
+ autoFocus
+ onFocus={autoSelect ? autoSelectHandler : undefined}
+ name="name"
+ placeholder="About"
+ disabled={disabled}
+ value={values.name}
+ onChange={(event) => {
+ onChange({ field: "name", value: event.target.value });
+ }}
+ />
+ </InputErrorsTooltip>
+ </Grid>
+
+ <Grid gap={1}>
+ <Label htmlFor={fieldIds.name}>Parent Folder</Label>
+ <InputErrorsTooltip errors={errors.name}>
+ <Select
+ tabIndex={1}
+ css={{ zIndex: theme.zIndices[1] }}
+ options={pages.folders.filter(
+ // Prevent selecting yourself as a parent
+ ({ id }) => folderId !== id
+ )}
+ getValue={(folder) => folder.id}
+ getLabel={(folder) => folder.name}
+ value={pages.folders.find(
+ ({ id }) => id === values.parentFolderId
+ )}
+ onChange={(folder) => {
+ onChange({
+ field: "parentFolderId",
+ value: folder.id,
+ });
+ }}
+ />
+ </InputErrorsTooltip>
+ </Grid>
+
+ <Grid gap={1}>
+ <Label htmlFor={fieldIds.slug}>
+ <Flex align="center" css={{ gap: theme.spacing[3] }}>
+ Slug
+ <Tooltip
+ content={"@todo tooltip content for slug"}
+ variant="wrapped"
+ >
+ <HelpIcon
+ color={rawTheme.colors.foregroundSubtle}
+ tabIndex={0}
+ />
+ </Tooltip>
+ </Flex>
+ </Label>
+ <InputErrorsTooltip errors={errors.slug}>
+ <InputField
+ tabIndex={1}
+ color={errors.slug && "error"}
+ id={fieldIds.slug}
+ name="slug"
+ placeholder="folder"
+ disabled={disabled}
+ value={values?.slug}
+ onChange={(event) => {
+ onChange({
+ field: "slug",
+ value: event.target.value,
+ });
+ }}
+ />
+ </InputErrorsTooltip>
+ </Grid>
+ </Grid>
+ </ScrollArea>
+ </Grid>
+ );
+};
+
+const nameToSlug = (name: string) => {
+ if (name === "") {
+ return "";
+ }
+
+ return slugify(name, { lower: true, strict: true });
+};
+
+export const newFolderId = "new-folder";
+
+export const NewFolderSettings = ({
+ onClose,
+ onSuccess,
+}: {
+ onClose: () => void;
+ onSuccess: (folderId: Folder["id"]) => void;
+}) => {
+ const pages = useStore($pages);
+
+ const [values, setValues] = useState<Values>({
+ ...fieldDefaultValues,
+ slug: nameToSlug(fieldDefaultValues.name),
+ });
+
+ const errors = validateValues(pages, values);
+ const handleSubmit = () => {
+ if (Object.keys(errors).length === 0) {
+ const folderId = nanoid();
+ // @todo move to a function
+ serverSyncStore.createTransaction([$pages], (pages) => {
+ if (pages === undefined) {
+ return;
+ }
+ pages.folders.push({
+ id: folderId,
+ name: values.name,
+ slug: values.slug,
+ children: [],
+ } satisfies Folder);
+ const parentFolder = pages.folders.find(
+ ({ id }) => id === values.parentFolderId
+ );
+ parentFolder?.children.push(folderId);
+ });
+
+ onSuccess(folderId);
+ }
+ };
+
+ return (
+ <NewFolderSettingsView
+ onSubmit={handleSubmit}
+ onClose={onClose}
+ isSubmitting={false}
+ >
+ <FormFields
+ autoSelect
+ errors={errors}
+ disabled={false}
+ values={values}
+ folderId={newFolderId}
+ onChange={(value) => {
+ setValues((values) => {
+ const changes = { [value.field]: value.value };
+
+ if (value.field === "name") {
+ if (values.slug === nameToSlug(values.name)) {
+ changes.slug = nameToSlug(value.value);
+ }
+ }
+ return { ...values, ...changes };
+ });
+ }}
+ />
+ </NewFolderSettingsView>
+ );
+};
+
+const NewFolderSettingsView = ({
+ onSubmit,
+ isSubmitting,
+ onClose,
+ children,
+}: {
+ onSubmit: () => void;
+ isSubmitting: boolean;
+ onClose: () => void;
+ children: JSX.Element;
+}) => {
+ return (
+ <>
+ <Header
+ title="New Folder Settings"
+ suffix={
+ <>
+ <Tooltip content="Cancel" side="bottom">
+ <Button
+ onClick={onClose}
+ aria-label="Cancel"
+ prefix={<ChevronDoubleLeftIcon />}
+ color="ghost"
+ // Tab should go:
+ // trought form fields -> create button -> cancel button
+ tabIndex={3}
+ />
+ </Tooltip>
+ <HeaderSuffixSpacer />
+ <Button
+ state={isSubmitting ? "pending" : "auto"}
+ onClick={onSubmit}
+ tabIndex={2}
+ >
+ {isSubmitting ? "Creating" : "Create folder"}
+ </Button>
+ </>
+ }
+ />
+ <Box css={{ overflow: "auto" }}>
+ <form
+ onSubmit={(event) => {
+ event.preventDefault();
+ onSubmit();
+ }}
+ >
+ {children}
+ <input type="submit" hidden />
+ </form>
+ </Box>
+ </>
+ );
+};
+
+const updateFolder = (folderId: Folder["id"], values: Partial<Values>) => {
+ serverSyncStore.createTransaction([$pages], (pages) => {
+ if (pages === undefined) {
+ return;
+ }
+ const folder = pages.folders.find((folder) => folder.id === folderId);
+ if (folder === undefined) {
+ return;
+ }
+ if (values.name !== undefined) {
+ folder.name = values.name;
+ }
+ if (values.slug !== undefined) {
+ folder.slug = values.slug;
+ }
+ if (values.parentFolderId !== undefined) {
+ const newParentFolder = pages.folders.find(
+ ({ id }) => id === values.parentFolderId
+ );
+ if (newParentFolder) {
+ cleanupChildRefsMutable(folderId, pages);
+ newParentFolder?.children.push(folderId);
+ }
+ }
+ });
+};
+
+const deleteFolder = (folderId: Folder["id"]) => {
+ // @todo ask them if they want to delete all pages as well.
+ serverSyncStore.createTransaction([$pages], (pages) => {
+ if (pages === undefined) {
+ return;
+ }
+ cleanupChildRefsMutable(folderId, pages);
+ removeByMutable(pages.folders, (folder) => folder.id === folderId);
+ });
+};
+
+export const FolderSettings = ({
+ onClose,
+ onDelete,
+ folderId,
+}: {
+ onClose: () => void;
+ onDelete: () => void;
+ folderId: string;
+}) => {
+ const pages = useStore($pages);
+ const folder = pages?.folders.find(({ id }) => id === folderId);
+ const [unsavedValues, setUnsavedValues] = useState<Partial<Values>>({});
+
+ const values: Values = {
+ ...(pages ? toFormValues(folderId, pages.folders) : fieldDefaultValues),
+ ...unsavedValues,
+ };
+
+ const errors = validateValues(pages, values, folderId);
+
+ const debouncedFn = useEffectEvent(() => {
+ if (
+ Object.keys(unsavedValues).length === 0 ||
+ Object.keys(errors).length !== 0
+ ) {
+ return;
+ }
+
+ updateFolder(folderId, unsavedValues);
+
+ setUnsavedValues({});
+ });
+
+ const handleSubmitDebounced = useDebouncedCallback(debouncedFn, 1000);
+
+ const handleChange = useCallback(
+ <Name extends FieldName>(event: { field: Name; value: Values[Name] }) => {
+ setUnsavedValues((values) => ({
+ ...values,
+ [event.field]: event.value,
+ }));
+ handleSubmitDebounced();
+ },
+ [handleSubmitDebounced]
+ );
+
+ useUnmount(() => {
+ if (
+ Object.keys(unsavedValues).length === 0 ||
+ Object.keys(errors).length !== 0
+ ) {
+ return;
+ }
+ updateFolder(folderId, unsavedValues);
+ });
+
+ const hanldeDelete = () => {
+ deleteFolder(folderId);
+ onDelete();
+ };
+
+ if (folder === undefined) {
+ return null;
+ }
+
+ return (
+ <FolderSettingsView onClose={onClose} onDelete={hanldeDelete}>
+ <FormFields
+ folderId={folderId}
+ errors={errors}
+ values={values}
+ onChange={handleChange}
+ />
+ </FolderSettingsView>
+ );
+};
+
+const FolderSettingsView = ({
+ onDelete,
+ onClose,
+ children,
+}: {
+ onDelete: () => void;
+ onClose: () => void;
+ children: JSX.Element;
+}) => {
+ return (
+ <>
+ <Header
+ title="Folder Settings"
+ suffix={
+ <>
+ <Tooltip content="Delete folder" side="bottom">
+ <Button
+ color="ghost"
+ prefix={<TrashIcon />}
+ onClick={onDelete}
+ aria-label="Delete folder"
+ tabIndex={2}
+ />
+ </Tooltip>
+ <Tooltip content="Close folder settings" side="bottom">
+ <Button
+ color="ghost"
+ prefix={<ChevronDoubleLeftIcon />}
+ onClick={onClose}
+ aria-label="Close folder settings"
+ tabIndex={2}
+ />
+ </Tooltip>
+ </>
+ }
+ />
+ <Box css={{ overflow: "auto" }}>
+ <form
+ onSubmit={(event) => {
+ event.preventDefault();
+ onClose?.();
+ }}
+ >
+ {children}
+ <input type="submit" hidden />
+ </form>
+ </Box>
+ </>
+ );
+};
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/settings.stories.tsx b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.stories.tsx
similarity index 71%
rename from apps/builder/app/builder/features/sidebar-left/panels/pages/settings.stories.tsx
rename to apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.stories.tsx
index 63c2b1280c..f465553191 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/settings.stories.tsx
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.stories.tsx
@@ -1,9 +1,11 @@
import { $pages } from "~/shared/nano-states/pages";
-import { PageSettings } from "./settings";
+import { PageSettings } from "./page-settings";
import { $isProjectSettingsOpen } from "~/shared/nano-states/seo";
import { Grid, theme } from "@webstudio-is/design-system";
import { $assets, $project } from "~/shared/nano-states";
+import { createDefaultPages } from "@webstudio-is/project-build";
+import { isRoot } from "./page-utils";
export default {
component: PageSettings,
@@ -33,31 +35,24 @@ $assets.set(
])
);
-$pages.set({
- meta: {
- siteName: "Project name",
- faviconAssetId: "imageId",
- code: "code",
- },
- homePage: {
- id: "homePageId",
- title: "Home page title",
- path: "/home-page-path",
- name: "home-page-name",
- meta: {},
- rootInstanceId: "root-instance-id",
- },
- pages: [
- {
- id: "pageId",
- title: "Page title",
- path: "/page-path",
- name: "page-name",
- meta: {},
- rootInstanceId: "root-instance-id",
- },
- ],
+const pages = createDefaultPages({ rootInstanceId: "root-instance-id" });
+pages.meta = {
+ siteName: "Project name",
+ faviconAssetId: "imageId",
+ code: "code",
+};
+pages.pages.push({
+ id: "pageId",
+ title: "Page title",
+ path: "/page-path",
+ name: "page-name",
+ meta: {},
+ rootInstanceId: "root-instance-id",
});
+const rootFolder = pages.folders.find(isRoot);
+rootFolder?.children.push("pageId");
+
+$pages.set(pages);
$project.set({
id: "projectId",
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/settings.tsx b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx
similarity index 92%
rename from apps/builder/app/builder/features/sidebar-left/panels/pages/settings.tsx
rename to apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx
index 6eddcd8456..6c5d0b0c44 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/settings.tsx
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx
@@ -1,11 +1,5 @@
import { z } from "zod";
-import {
- type ComponentProps,
- type FocusEventHandler,
- useState,
- useCallback,
- Fragment,
-} from "react";
+import { type FocusEventHandler, useState, useCallback, Fragment } from "react";
import { useStore } from "@nanostores/react";
import { useDebouncedCallback } from "use-debounce";
import { useUnmount } from "react-use";
@@ -80,6 +74,7 @@ import {
parsePathnamePattern,
validatePathnamePattern,
} from "./url-pattern";
+import { isRoot } from "./page-utils";
const fieldDefaultValues = {
name: "Untitled",
@@ -109,6 +104,7 @@ type Errors = {
[fieldName in FieldName]?: string[];
};
+// @todo needs to be removed
const LegacyPagePath = z
.string()
.refine((path) => path !== "", "Can't be empty")
@@ -313,6 +309,7 @@ const FormFields = ({
.replace(/\/+/g, "/");
const pageUrl = `https://${pageDomainAndPath}`;
+ // @todo this is a hack to get the scroll area to work needs to be removed
const TOPBAR_HEIGHT = 40;
const HEADER_HEIGHT = 40;
const FOOTER_HEIGHT = 24;
@@ -687,6 +684,10 @@ export const NewPageSettings = ({
component: "Body",
children: [],
});
+
+ // @todo add parent folder selection
+ pages.folders.find(isRoot)?.children.push(pageId);
+
$selectedInstanceSelector.set(undefined);
}
);
@@ -702,25 +703,29 @@ export const NewPageSettings = ({
onSubmit={handleSubmit}
onClose={onClose}
isSubmitting={false}
- errors={errors}
- disabled={false}
- values={values}
- onChange={(val) => {
- setValues((values) => {
- const changes = { [val.field]: val.value };
-
- if (val.field === "name") {
- if (values.path === nameToPath(pages, values.name)) {
- changes.path = nameToPath(pages, val.value);
- }
- if (values.title === values.name) {
- changes.title = val.value;
+ >
+ <FormFields
+ autoSelect
+ errors={errors}
+ disabled={false}
+ values={values}
+ onChange={(val) => {
+ setValues((values) => {
+ const changes = { [val.field]: val.value };
+
+ if (val.field === "name") {
+ if (values.path === nameToPath(pages, values.name)) {
+ changes.path = nameToPath(pages, val.value);
+ }
+ if (values.title === values.name) {
+ changes.title = val.value;
+ }
}
- }
- return { ...values, ...changes };
- });
- }}
- />
+ return { ...values, ...changes };
+ });
+ }}
+ />
+ </NewPageSettingsView>
);
};
@@ -728,31 +733,30 @@ const NewPageSettingsView = ({
onSubmit,
isSubmitting,
onClose,
- ...formFieldsProps
+ children,
}: {
onSubmit: () => void;
isSubmitting: boolean;
onClose: () => void;
-} & ComponentProps<typeof FormFields>) => {
+ children: JSX.Element;
+}) => {
return (
<>
<Header
title="New Page Settings"
suffix={
<>
- {onClose && (
- <Tooltip content="Cancel" side="bottom">
- <Button
- onClick={onClose}
- aria-label="Cancel"
- prefix={<ChevronDoubleLeftIcon />}
- color="ghost"
- // Tab should go:
- // trought form fields -> create button -> cancel button
- tabIndex={3}
- />
- </Tooltip>
- )}
+ <Tooltip content="Cancel" side="bottom">
+ <Button
+ onClick={onClose}
+ aria-label="Cancel"
+ prefix={<ChevronDoubleLeftIcon />}
+ color="ghost"
+ // Tab should go:
+ // trought form fields -> create button -> cancel button
+ tabIndex={3}
+ />
+ </Tooltip>
<HeaderSuffixSpacer />
<Button
state={isSubmitting ? "pending" : "auto"}
@@ -764,18 +768,14 @@ const NewPageSettingsView = ({
</>
}
/>
- <Box
- css={{
- overflow: "auto",
- }}
- >
+ <Box css={{ overflow: "auto" }}>
<form
onSubmit={(event) => {
event.preventDefault();
onSubmit();
}}
>
- <FormFields autoSelect {...formFieldsProps} />
+ {children}
<input type="submit" hidden />
</form>
</Box>
@@ -990,19 +990,22 @@ export const PageSettings = ({
return (
<PageSettingsView
- pathVariableId={page.pathVariableId}
onClose={onClose}
- onDelete={hanldeDelete}
+ onDelete={values.isHomePage === false ? hanldeDelete : undefined}
onDuplicate={() => {
const newPageId = duplicatePage(pageId);
if (newPageId !== undefined) {
onDuplicate(newPageId);
}
}}
- errors={errors}
- values={values}
- onChange={handleChange}
- />
+ >
+ <FormFields
+ pathVariableId={page.pathVariableId}
+ errors={errors}
+ values={values}
+ onChange={handleChange}
+ />
+ </PageSettingsView>
);
};
@@ -1010,19 +1013,20 @@ const PageSettingsView = ({
onDelete,
onDuplicate,
onClose,
- ...formFieldsProps
+ children,
}: {
- onDelete: () => void;
+ onDelete?: () => void;
onDuplicate: () => void;
onClose: () => void;
-} & ComponentProps<typeof FormFields>) => {
+ children: JSX.Element;
+}) => {
return (
<>
<Header
title="Page Settings"
suffix={
<>
- {formFieldsProps.values.isHomePage === false && (
+ {onDelete && (
<Tooltip content="Delete page" side="bottom">
<Button
color="ghost"
@@ -1042,32 +1046,26 @@ const PageSettingsView = ({
tabIndex={2}
/>
</Tooltip>
- {onClose && (
- <Tooltip content="Close page settings" side="bottom">
- <Button
- color="ghost"
- prefix={<ChevronDoubleLeftIcon />}
- onClick={onClose}
- aria-label="Close page settings"
- tabIndex={2}
- />
- </Tooltip>
- )}
+ <Tooltip content="Close page settings" side="bottom">
+ <Button
+ color="ghost"
+ prefix={<ChevronDoubleLeftIcon />}
+ onClick={onClose}
+ aria-label="Close page settings"
+ tabIndex={2}
+ />
+ </Tooltip>
</>
}
/>
- <Box
- css={{
- overflow: "auto",
- }}
- >
+ <Box css={{ overflow: "auto" }}>
<form
onSubmit={(event) => {
event.preventDefault();
onClose?.();
}}
>
- <FormFields {...formFieldsProps} />
+ {children}
<input type="submit" hidden />
</form>
</Box>
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.test.ts b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.test.ts
new file mode 100644
index 0000000000..b25c831e7f
--- /dev/null
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.test.ts
@@ -0,0 +1,339 @@
+import { describe, expect, test } from "@jest/globals";
+import {
+ cleanupChildRefsMutable,
+ findParentFolderByChildId,
+ isRoot,
+ isSlugUsed,
+ reparentOrphansMutable,
+ toTreeData,
+} from "./page-utils";
+import { createDefaultPages } from "@webstudio-is/project-build";
+
+describe("toTreeData", () => {
+ test("initial pages always has home pages and a root folder", () => {
+ const pages = createDefaultPages({
+ rootInstanceId: "id",
+ homePageId: "homePageId",
+ });
+ const tree = toTreeData(pages);
+ expect(tree.root).toEqual({
+ id: "root",
+ name: "Root",
+ slug: "",
+ type: "folder",
+ children: [
+ {
+ data: {
+ id: "homePageId",
+ meta: {},
+ name: "Home",
+ path: "",
+ rootInstanceId: "id",
+ title: "Home",
+ },
+ id: "homePageId",
+ type: "page",
+ },
+ ],
+ });
+ });
+
+ test("add empty folder", () => {
+ const pages = createDefaultPages({
+ rootInstanceId: "id",
+ homePageId: "homePageId",
+ });
+ pages.folders.push({
+ id: "folderId",
+ name: "Folder",
+ slug: "folder",
+ children: [],
+ });
+ const rootFolder = pages.folders.find(isRoot);
+ rootFolder?.children.push("folderId");
+ const tree = toTreeData(pages);
+ expect(tree.root).toEqual({
+ id: "root",
+ name: "Root",
+ slug: "",
+ type: "folder",
+ children: [
+ {
+ data: {
+ id: "homePageId",
+ meta: {},
+ name: "Home",
+ path: "",
+ rootInstanceId: "id",
+ title: "Home",
+ },
+ id: "homePageId",
+ type: "page",
+ },
+ {
+ type: "folder",
+ id: "folderId",
+ name: "Folder",
+ slug: "folder",
+ children: [],
+ },
+ ],
+ });
+ });
+
+ test("add a page inside a folder", () => {
+ const pages = createDefaultPages({
+ rootInstanceId: "id",
+ homePageId: "homePageId",
+ });
+ pages.pages.push({
+ id: "pageId",
+ meta: {},
+ name: "Page",
+ path: "/page",
+ rootInstanceId: "id",
+ title: "Page",
+ });
+ pages.folders.push({
+ id: "folderId",
+ name: "Folder",
+ slug: "folder",
+ children: ["pageId"],
+ });
+ const rootFolder = pages.folders.find(isRoot);
+ rootFolder?.children.push("folderId");
+ const tree = toTreeData(pages);
+
+ expect(tree.root).toEqual({
+ id: "root",
+ name: "Root",
+ slug: "",
+ type: "folder",
+ children: [
+ {
+ data: {
+ id: "homePageId",
+ meta: {},
+ name: "Home",
+ path: "",
+ rootInstanceId: "id",
+ title: "Home",
+ },
+ id: "homePageId",
+ type: "page",
+ },
+ {
+ type: "folder",
+ id: "folderId",
+ name: "Folder",
+ slug: "folder",
+ children: [
+ {
+ type: "page",
+ id: "pageId",
+ data: {
+ id: "pageId",
+ meta: {},
+ name: "Page",
+ path: "/page",
+ rootInstanceId: "id",
+ title: "Page",
+ },
+ },
+ ],
+ },
+ ],
+ });
+ });
+
+ test("nest a folder", () => {
+ const pages = createDefaultPages({
+ rootInstanceId: "id",
+ homePageId: "homePageId",
+ });
+ const rootFolder = pages.folders.find(isRoot);
+ rootFolder?.children.push("1");
+ pages.folders.push({
+ id: "1",
+ name: "Folder 1",
+ slug: "folder-1",
+ children: ["1-1"],
+ });
+ pages.folders.push({
+ id: "1-1",
+ name: "Folder 1-1",
+ slug: "folder-1-1",
+ children: [],
+ });
+ const tree = toTreeData(pages);
+ expect(tree.root).toEqual({
+ type: "folder",
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: [
+ {
+ type: "page",
+ id: "homePageId",
+ data: {
+ id: "homePageId",
+ name: "Home",
+ path: "",
+ title: "Home",
+ meta: {},
+ rootInstanceId: "id",
+ },
+ },
+ {
+ type: "folder",
+ id: "1",
+ name: "Folder 1",
+ slug: "folder-1",
+ children: [
+ {
+ type: "folder",
+ id: "1-1",
+ name: "Folder 1-1",
+ slug: "folder-1-1",
+ children: [],
+ },
+ ],
+ },
+ ],
+ });
+ });
+});
+
+describe("reparentOrphansMutable", () => {
+ // We must deal with the fact there can be an orphaned folder or page in a collaborative mode,
+ // 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 = createDefaultPages({
+ rootInstanceId: "rootInstanceId",
+ homePageId: "homePageId",
+ });
+ pages.pages.push({
+ id: "pageId",
+ meta: {},
+ name: "Page",
+ path: "/page",
+ rootInstanceId: "rootInstanceId",
+ title: "Page",
+ });
+ pages.folders.push({
+ id: "folderId",
+ name: "Folder",
+ slug: "folder",
+ children: [],
+ });
+ reparentOrphansMutable(pages);
+ const rootFolder = pages.folders.find(isRoot);
+ expect(rootFolder).toEqual({
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["homePageId", "folderId", "pageId"],
+ });
+ });
+});
+
+describe("cleanupChildRefsMutable", () => {
+ test("cleanup refs", () => {
+ const pages = createDefaultPages({
+ rootInstanceId: "rootInstanceId",
+ homePageId: "homePageId",
+ });
+ pages.folders.push({
+ id: "folderId",
+ name: "Folder",
+ slug: "folder",
+ children: [],
+ });
+ const rootFolder = pages.folders.find(isRoot);
+ rootFolder?.children.push("folderId");
+ cleanupChildRefsMutable("folderId", pages);
+ expect(rootFolder).toEqual({
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: ["homePageId"],
+ });
+ });
+});
+
+describe("findParentFolderByChildId", () => {
+ const pages = createDefaultPages({
+ rootInstanceId: "rootInstanceId",
+ homePageId: "homePageId",
+ });
+ pages.folders.push({
+ id: "folderId",
+ name: "Folder 1",
+ slug: "folder",
+ children: ["folderId1"],
+ });
+ const rootFolder = pages.folders.find(isRoot);
+ rootFolder?.children.push("folderId");
+ pages.folders.push({
+ id: "folderId1",
+ name: "Folder 2",
+ slug: "folder",
+ children: [],
+ });
+ pages.folders.push({
+ id: "folderId2",
+ name: "Folder 3",
+ slug: "folder",
+ children: [],
+ });
+
+ test("find in root folder", () => {
+ expect(findParentFolderByChildId("folderId", pages.folders)).toEqual(
+ rootFolder
+ );
+ });
+});
+
+describe("isSlugUsed", () => {
+ const { folders } = createDefaultPages({
+ rootInstanceId: "rootInstanceId",
+ homePageId: "homePageId",
+ });
+ folders.push({
+ id: "folderId1",
+ name: "Folder 1",
+ slug: "slug1",
+ children: ["folderId1-1"],
+ });
+ folders.push({
+ id: "folderId1-1",
+ name: "Folder 1-1",
+ slug: "slug1-1",
+ children: [],
+ });
+
+ const rootFolder = folders.find(isRoot)!;
+ rootFolder.children.push("folderId1");
+
+ test("available in the root", () => {
+ expect(isSlugUsed("slug", folders, rootFolder.id)).toBe(true);
+ });
+
+ test("not available in the root", () => {
+ expect(isSlugUsed("slug1", folders, rootFolder.id)).toBe(false);
+ });
+
+ test("available in Folder 1", () => {
+ expect(isSlugUsed("slug", folders, "folderId1")).toBe(true);
+ });
+
+ test("not available in Folder 1", () => {
+ expect(isSlugUsed("slug1-1", folders, "folderId1")).toBe(false);
+ });
+
+ test("existing folder can have a matching slug when its the same id/folder", () => {
+ expect(isSlugUsed("slug1-1", folders, "folderId1", "folderId1-1")).toBe(
+ true
+ );
+ });
+});
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.ts b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.ts
new file mode 100644
index 0000000000..cd64856d0a
--- /dev/null
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.ts
@@ -0,0 +1,173 @@
+import { ROOT_FOLDER_ID, createRootFolder } from "@webstudio-is/project-build";
+import { type Page, Pages, type Folder } from "@webstudio-is/sdk";
+
+type TreePage = {
+ type: "page";
+ id: string;
+ data: Page;
+};
+
+type TreeFolder = {
+ // currently used only for root node
+ type: "folder";
+ id: Folder["id"];
+ name: Folder["name"];
+ slug: Folder["slug"];
+ children: Array<TreeData>;
+};
+
+export type TreeData = TreeFolder | TreePage;
+
+type Index = Map<string, TreeData>;
+
+/**
+ * Return a nested tree structure from flat pages and folders.
+ * To be used for rendering.
+ */
+export const toTreeData = (
+ pages: Pages
+): { root: TreeFolder; index: Index } => {
+ const pagesMap = new Map(pages.pages.map((page) => [page.id, page]));
+ pagesMap.set(pages.homePage.id, pages.homePage);
+ const foldersMap = new Map(
+ pages.folders.map((folder) => [folder.id, folder])
+ );
+ const index: Index = new Map();
+
+ const folderToTree = (folder: Folder) => {
+ // Using map to ensure uniqueness of children.
+ const children = new Map<string, TreeData>();
+ for (const id of folder.children) {
+ const folder = foldersMap.get(id);
+ // It is a folder, not a page.
+ if (folder) {
+ const treeFolder = folderToTree(folder);
+ children.set(treeFolder.id, treeFolder);
+ index.set(folder.id, treeFolder);
+ continue;
+ }
+ const page = pagesMap.get(id);
+ if (page) {
+ const treePage = {
+ type: "page",
+ id: page.id,
+ data: page,
+ } satisfies TreePage;
+ children.set(treePage.id, treePage);
+ index.set(page.id, treePage);
+ continue;
+ }
+ }
+ return {
+ type: "folder",
+ id: folder.id,
+ name: folder.name,
+ slug: folder.slug,
+ children: Array.from(children.values()),
+ } satisfies TreeFolder;
+ };
+ const rootFolder = foldersMap.get("root");
+ if (rootFolder === undefined) {
+ throw new Error("Root folder not found");
+ }
+ return {
+ root: folderToTree(rootFolder),
+ index,
+ };
+};
+
+/**
+ * Find a folder that has has that id in the children.
+ */
+export const findParentFolderByChildId = (
+ id: Folder["id"] | Page["id"],
+ folders: Array<Folder>
+): Folder | undefined => {
+ for (const folder of folders) {
+ if (folder.children.includes(id)) {
+ return folder;
+ }
+ }
+};
+
+/**
+ * When page or folder needs to be deleted or moved to a different parent,
+ * we want to cleanup any existing reference to it in current folder.
+ * We could do this in just one folder, but I think its more robust to check all,
+ * just in case we got double referencing.
+ */
+export const cleanupChildRefsMutable = (
+ id: Folder["id"] | Page["id"],
+ pages: Pages
+) => {
+ for (const folder of pages.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);
+ }
+ }
+};
+
+/**
+ * When page or folder is found and its not referenced in any other folder children,
+ * 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) {
+ children.push(...folder.children);
+ }
+
+ let rootFolder = pages.folders.find(isRoot);
+ // Should never happen, but just in case.
+ if (rootFolder === undefined) {
+ rootFolder = createRootFolder();
+ pages.folders.push(rootFolder);
+ }
+
+ for (const folder of pages.folders) {
+ // It's an orphan
+ if (children.includes(folder.id) === false) {
+ rootFolder.children.push(folder.id);
+ }
+ }
+
+ for (const page of pages.pages) {
+ // It's an orphan
+ if (children.includes(page.id) === false) {
+ rootFolder.children.push(page.id);
+ }
+ }
+};
+
+/**
+ * Returns true if folder is the root folder.
+ */
+export const isRoot = (folder: Folder) => folder.id === ROOT_FOLDER_ID;
+
+/**
+ * Returns true if folder's slug is unique within it's future parent folder.
+ * Needed to verify if the folder can be nested under the parent folder without modifying slug.
+ */
+export const isSlugUsed = (
+ slug: string,
+ folders: Array<Folder>,
+ parentFolderId: Folder["id"],
+ // undefined folder id means new folder
+ folderId?: Folder["id"]
+) => {
+ const foldersMap = new Map(folders.map((folder) => [folder.id, folder]));
+ const parentFolder = foldersMap.get(parentFolderId);
+ // Should be impossible because at least root folder is always found.
+ if (parentFolder === undefined) {
+ return false;
+ }
+
+ return (
+ parentFolder.children.some(
+ (id) => foldersMap.get(id)?.slug === slug && id !== folderId
+ ) === false
+ );
+};
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/pages.tsx b/apps/builder/app/builder/features/sidebar-left/panels/pages/pages.tsx
index 2fddc5bf48..aa961fc24e 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/pages.tsx
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/pages.tsx
@@ -16,47 +16,36 @@ import {
} from "@webstudio-is/design-system";
import {
ChevronRightIcon,
+ FolderIcon,
MenuIcon,
+ NewFolderIcon,
+ NewPageIcon,
PageIcon,
- PlusIcon,
} from "@webstudio-is/icons";
-import type { Page, Pages } from "@webstudio-is/sdk";
import type { TabName } from "../../types";
import { CloseButton, Header } from "../../header";
import { SettingsPanel } from "./settings-panel";
-import { NewPageSettings, PageSettings } from "./settings";
+import { NewPageSettings, PageSettings } from "./page-settings";
import { $pages, $selectedPageId } from "~/shared/nano-states";
import { switchPage } from "~/shared/pages";
+import {
+ reparentOrphansMutable,
+ toTreeData,
+ type TreeData,
+} from "./page-utils";
+import {
+ FolderSettings,
+ NewFolderSettings,
+ newFolderId,
+} from "./folder-settings";
+import { isFeatureEnabled } from "@webstudio-is/feature-flags";
+import { serverSyncStore } from "~/shared/sync";
+import { useMount } from "~/shared/hook-utils/use-mount";
type TabContentProps = {
onSetActiveTab: (tabName: TabName) => void;
};
-type PagesTreeNode =
- | {
- // currently used only for root node
- type: "folder";
- id: string;
- children: PagesTreeNode[];
- }
- | {
- type: "page";
- id: string;
- data: Page;
- };
-
-const toTreeData = (pages: Pages): PagesTreeNode => {
- return {
- type: "folder",
- id: "root",
- children: [pages.homePage, ...pages.pages].map((data) => ({
- type: "page",
- id: data.id,
- data,
- })),
- };
-};
-
const MenuButton = styled(DeprecatedIconButton, {
color: theme.colors.hint,
"&:hover, &:focus-visible": { color: theme.colors.hiContrast },
@@ -114,55 +103,79 @@ const ItemSuffix = ({
);
};
+const useReparentOrphans = () => {
+ useMount(() => {
+ // Pages may not be loaded yet when switching betwen projects and the pages
+ // panel was already visible - it mounts faster than we load the pages.
+ if ($pages.get() === undefined) {
+ return;
+ }
+ serverSyncStore.createTransaction([$pages], (pages) => {
+ if (pages === undefined) {
+ return;
+ }
+ reparentOrphansMutable(pages);
+ });
+ });
+};
+
const PagesPanel = ({
onClose,
+ onCreateNewFolder,
onCreateNewPage,
onSelect,
selectedPageId,
onEdit,
- editingPageId,
+ editingItemId,
}: {
- onClose?: () => void;
- onCreateNewPage?: () => void;
+ onClose: () => void;
+ onCreateNewFolder: () => void;
+ onCreateNewPage: () => void;
onSelect: (pageId: string) => void;
selectedPageId: string;
- onEdit?: (pageId: string | undefined) => void;
- editingPageId?: string;
+ onEdit: (pageId: string | undefined) => void;
+ editingItemId?: string;
}) => {
const pages = useStore($pages);
- const pagesTree = useMemo(() => pages && toTreeData(pages), [pages]);
+ const treeData = useMemo(() => pages && toTreeData(pages), [pages]);
+ useReparentOrphans();
const renderItem = useCallback(
- (props: TreeItemRenderProps<PagesTreeNode>) => {
- if (props.itemData.type === "folder") {
+ (props: TreeItemRenderProps<TreeData>) => {
+ if (props.itemData.id === "root") {
return null;
}
- const isEditing = editingPageId === props.itemData.id;
+ const isEditing = editingItemId === props.itemData.id;
return (
<TreeItemBody
{...props}
suffix={
- onEdit && (
- <ItemSuffix
- isParentSelected={props.isSelected ?? false}
- itemId={props.itemData.id}
- editingItemId={editingPageId}
- onEdit={onEdit}
- />
- )
+ <ItemSuffix
+ isParentSelected={props.isSelected ?? false}
+ itemId={props.itemData.id}
+ editingItemId={editingItemId}
+ onEdit={onEdit}
+ />
}
alwaysShowSuffix={isEditing}
forceFocus={isEditing}
>
- <TreeItemLabel prefix={<PageIcon />}>
- {props.itemData.data.name}
- </TreeItemLabel>
+ {props.itemData.type === "folder" && (
+ <TreeItemLabel prefix={<FolderIcon />}>
+ {props.itemData.name}
+ </TreeItemLabel>
+ )}
+ {props.itemData.type === "page" && (
+ <TreeItemLabel prefix={<PageIcon />}>
+ {props.itemData.data.name}
+ </TreeItemLabel>
+ )}
</TreeItemBody>
);
},
- [editingPageId, onEdit]
+ [editingItemId, onEdit]
);
const selectTreeNode = useCallback(
@@ -170,7 +183,7 @@ const PagesPanel = ({
[onSelect]
);
- if (pagesTree === undefined) {
+ if (treeData === undefined || pages === undefined) {
return null;
}
@@ -190,33 +203,49 @@ const PagesPanel = ({
title="Pages"
suffix={
<>
- {onCreateNewPage && (
- <Tooltip content="New page" side="bottom">
+ {isFeatureEnabled("folders") && (
+ <Tooltip content="New folder" side="bottom">
<Button
- onClick={() => onCreateNewPage()}
- aria-label="New page"
- prefix={<PlusIcon />}
+ onClick={() => onCreateNewFolder()}
+ aria-label="New folder"
+ prefix={<NewFolderIcon />}
color="ghost"
/>
</Tooltip>
)}
- {onClose && <CloseButton onClick={onClose} />}
+ <Tooltip content="New page" side="bottom">
+ <Button
+ onClick={() => onCreateNewPage()}
+ aria-label="New page"
+ prefix={<NewPageIcon />}
+ color="ghost"
+ />
+ </Tooltip>
+ <CloseButton onClick={onClose} />
</>
}
/>
<Box css={{ overflowY: "auto", flexBasis: 0, flexGrow: 1 }}>
- <TreeNode<PagesTreeNode>
- selectedItemSelector={[selectedPageId, pagesTree.id]}
+ <TreeNode<TreeData>
+ selectedItemSelector={[selectedPageId, treeData.root.id]}
onSelect={selectTreeNode}
- itemData={pagesTree}
+ itemData={treeData.root}
renderItem={renderItem}
getItemChildren={([nodeId]) => {
- if (nodeId === pagesTree.id && pagesTree.type === "folder") {
- return pagesTree.children;
+ // It's the root.
+ if (
+ nodeId === treeData.root.id &&
+ treeData.root.type === "folder"
+ ) {
+ return treeData.root.children;
+ }
+ const item = treeData.index.get(nodeId);
+ if (item?.type === "folder") {
+ return item.children;
}
return [];
}}
- isItemHidden={([itemId]) => itemId === pagesTree.id}
+ isItemHidden={([itemId]) => itemId === treeData.root.id}
getIsExpanded={() => true}
/>
</Box>
@@ -224,60 +253,127 @@ const PagesPanel = ({
);
};
+const newPageId = "new-page";
+
+const PageEditor = ({
+ editingPageId,
+ setEditingPageId,
+}: {
+ editingPageId: string;
+ setEditingPageId: (pageId?: string) => void;
+}) => {
+ const currentPageId = useStore($selectedPageId);
+
+ if (editingPageId === newPageId) {
+ return (
+ <NewPageSettings
+ onClose={() => setEditingPageId(undefined)}
+ onSuccess={(pageId) => {
+ setEditingPageId(undefined);
+ switchPage(pageId);
+ }}
+ />
+ );
+ }
+
+ return (
+ <PageSettings
+ onClose={() => setEditingPageId(undefined)}
+ onDelete={() => {
+ setEditingPageId(undefined);
+ if (editingPageId === currentPageId) {
+ switchPage();
+ }
+ }}
+ onDuplicate={(newPageId) => {
+ setEditingPageId(undefined);
+ switchPage(newPageId);
+ }}
+ pageId={editingPageId}
+ key={editingPageId}
+ />
+ );
+};
+
+const FolderEditor = ({
+ editingFolderId,
+ setEditingFolderId,
+}: {
+ editingFolderId: string;
+ setEditingFolderId: (pageId?: string) => void;
+}) => {
+ if (editingFolderId === newFolderId) {
+ return (
+ <NewFolderSettings
+ onClose={() => setEditingFolderId(undefined)}
+ onSuccess={() => {
+ setEditingFolderId(undefined);
+ }}
+ key={newFolderId}
+ />
+ );
+ }
+
+ return (
+ <FolderSettings
+ onClose={() => setEditingFolderId(undefined)}
+ onDelete={() => {
+ setEditingFolderId(undefined);
+ }}
+ folderId={editingFolderId}
+ key={editingFolderId}
+ />
+ );
+};
+
export const TabContent = ({ onSetActiveTab }: TabContentProps) => {
const currentPageId = useStore($selectedPageId);
- const newPageId = "new-page";
- const [editingPageId, setEditingPageId] = useState<string>();
+ const [editingItemId, setEditingItemId] = useState<string>();
+ const pages = useStore($pages);
if (currentPageId === undefined) {
return null;
}
+ const isEditingFolder =
+ editingItemId === newFolderId ||
+ pages?.folders.some((folder) => folder.id === editingItemId);
return (
<>
<PagesPanel
onClose={() => onSetActiveTab("none")}
+ onCreateNewFolder={() => {
+ setEditingItemId(
+ editingItemId === newFolderId ? undefined : newFolderId
+ );
+ }}
onCreateNewPage={() =>
- setEditingPageId((current) =>
- current === newPageId ? undefined : newPageId
- )
+ setEditingItemId(editingItemId === newPageId ? undefined : newPageId)
}
onSelect={(pageId) => {
switchPage(pageId);
onSetActiveTab("none");
}}
selectedPageId={currentPageId}
- onEdit={setEditingPageId}
- editingPageId={editingPageId}
+ onEdit={setEditingItemId}
+ editingItemId={editingItemId}
/>
- <SettingsPanel isOpen={editingPageId !== undefined}>
- {editingPageId === newPageId && (
- <NewPageSettings
- onClose={() => setEditingPageId(undefined)}
- onSuccess={(pageId) => {
- setEditingPageId(undefined);
- switchPage(pageId);
- }}
- />
- )}
- {editingPageId !== newPageId && editingPageId !== undefined && (
- <PageSettings
- onClose={() => setEditingPageId(undefined)}
- onDelete={() => {
- setEditingPageId(undefined);
- if (editingPageId === currentPageId) {
- switchPage();
- }
- }}
- onDuplicate={(newPageId) => {
- setEditingPageId(undefined);
- switchPage(newPageId);
- }}
- pageId={editingPageId}
- key={editingPageId}
- />
- )}
- </SettingsPanel>
+
+ {editingItemId && (
+ <SettingsPanel isOpen>
+ {isEditingFolder ? (
+ <FolderEditor
+ editingFolderId={editingItemId}
+ setEditingFolderId={setEditingItemId}
+ />
+ ) : (
+ <PageEditor
+ editingPageId={editingItemId}
+ setEditingPageId={setEditingItemId}
+ />
+ )}
+ </SettingsPanel>
+ )}
</>
);
};
diff --git a/apps/builder/app/shared/copy-paste/plugin-instance.test.ts b/apps/builder/app/shared/copy-paste/plugin-instance.test.ts
index 56c53130da..fbfa57b213 100644
--- a/apps/builder/app/shared/copy-paste/plugin-instance.test.ts
+++ b/apps/builder/app/shared/copy-paste/plugin-instance.test.ts
@@ -7,7 +7,6 @@ import type {
Props,
DataSource,
DataSources,
- Page,
} from "@webstudio-is/sdk";
import type { Project } from "@webstudio-is/project";
import {
@@ -29,6 +28,7 @@ import {
$selectedPageId,
} from "../nano-states";
import { onCopy, onPaste } from "./plugin-instance";
+import { createDefaultPages } from "@webstudio-is/project-build";
const expectString = expect.any(String) as unknown as string;
@@ -39,11 +39,9 @@ $registeredComponentMetas.set(
new Map(Object.entries({ ...baseComponentMetas, ...coreMetas }))
);
$project.set({ id: "my-project" } as Project);
-$pages.set({
- meta: {},
- homePage: { id: "home-page", rootInstanceId: "body0" } as Page,
- pages: [],
-});
+$pages.set(
+ createDefaultPages({ homePageId: "home-page", rootInstanceId: "body0" })
+);
$selectedPageId.set("home-page");
const createInstance = (
diff --git a/apps/builder/app/shared/instance-utils.test.ts b/apps/builder/app/shared/instance-utils.test.ts
index dde7aef8e2..ea0ef22d51 100644
--- a/apps/builder/app/shared/instance-utils.test.ts
+++ b/apps/builder/app/shared/instance-utils.test.ts
@@ -11,7 +11,6 @@ import type {
Asset,
Instance,
Instances,
- Page,
Prop,
StyleDecl,
StyleDeclKey,
@@ -45,6 +44,7 @@ import {
} from "./nano-states";
import { registerContainers } from "./sync";
import type { Project } from "@webstudio-is/project";
+import { createDefaultPages } from "@webstudio-is/project-build";
enableMapSet();
registerContainers();
@@ -1071,7 +1071,7 @@ describe("insert instances slice copy", () => {
};
beforeEach(() => {
- $pages.set({ homePage: { id: "" } as Page, pages: [] });
+ $pages.set(createDefaultPages({ rootInstanceId: "" }));
$project.set({ id: "current_project" } as Project);
$assets.set(new Map());
$breakpoints.set(new Map());
diff --git a/apps/builder/app/shared/nano-states/props.test.ts b/apps/builder/app/shared/nano-states/props.test.ts
index 6c443c531a..e2f21df7a4 100644
--- a/apps/builder/app/shared/nano-states/props.test.ts
+++ b/apps/builder/app/shared/nano-states/props.test.ts
@@ -1,6 +1,6 @@
import { beforeEach, expect, test } from "@jest/globals";
import { cleanStores } from "nanostores";
-import type { Instance, Page } from "@webstudio-is/sdk";
+import type { Instance } from "@webstudio-is/sdk";
import {
collectionComponent,
textContentAttribute,
@@ -20,6 +20,7 @@ import {
$resources,
} from "./nano-states";
import { $params } from "~/canvas/stores";
+import { createDefaultPages } from "@webstudio-is/project-build";
const getIdValuePair = <T extends { id: string }>(item: T) =>
[item.id, item] as const;
@@ -34,11 +35,13 @@ const setBoxInstance = (id: Instance["id"]) => {
};
const selectPageRoot = (rootInstanceId: Instance["id"]) => {
- $pages.set({
- homePage: { id: "pageId", rootInstanceId, path: "/my-page" } as Page,
- pages: [],
+ const defaultPages = createDefaultPages({
+ homePageId: "pageId",
+ homePagePath: "/my-page",
+ rootInstanceId,
});
- $selectedPageId.set("pageId");
+ $pages.set(defaultPages);
+ $selectedPageId.set(defaultPages.homePage.id);
};
beforeEach(() => {
diff --git a/packages/feature-flags/src/flags.ts b/packages/feature-flags/src/flags.ts
index f091ee8889..44f23f671a 100644
--- a/packages/feature-flags/src/flags.ts
+++ b/packages/feature-flags/src/flags.ts
@@ -3,5 +3,5 @@ export const unsupportedBrowsers = false;
export const displayContents = false;
export const ai = true;
export const aiRadixComponents = false;
-export const transitions = false;
export const bindings = false;
+export const folders = false;
diff --git a/packages/icons/icons/folder.svg b/packages/icons/icons/folder.svg
new file mode 100644
index 0000000000..0f226a8c93
--- /dev/null
+++ b/packages/icons/icons/folder.svg
@@ -0,0 +1,14 @@
+<svg
+ width="16"
+ height="16"
+ viewBox="0 0 16 16"
+ fill="none"
+ xmlns="http://www.w3.org/2000/svg"
+>
+ <path
+ fill-rule="evenodd"
+ clip-rule="evenodd"
+ fill="currentColor"
+ d="M6.83774 2.68715C6.77517 2.66557 6.69128 2.65709 6.21341 2.65709H3.92004C3.57328 2.65709 3.35231 2.65759 3.18481 2.67128C3.02491 2.68434 2.97179 2.70611 2.95034 2.71703C2.84686 2.76976 2.76272 2.8539 2.70999 2.95739C2.69906 2.97883 2.6773 3.03195 2.66423 3.19186C2.65055 3.35935 2.65004 3.58033 2.65004 3.92709V4.026H7.6334C7.51738 3.7456 7.40506 3.47969 7.34124 3.34233C7.16025 2.9528 7.09224 2.86214 7.04324 2.81416C6.985 2.75711 6.9148 2.71373 6.83774 2.68715ZM9.03835 4.026C9.00603 3.94654 8.97066 3.85981 8.93384 3.76996C8.79056 3.42032 8.61715 3.00322 8.52019 2.79454C8.34379 2.4149 8.19128 2.11891 7.95288 1.88541C7.75697 1.69354 7.52086 1.54761 7.26163 1.4582C6.96533 1.356 6.64369 1.35648 6.29053 1.35701C6.26499 1.35705 6.23929 1.35709 6.21341 1.35709L3.8954 1.35709C3.58043 1.35707 3.30577 1.35706 3.07895 1.37559C2.83865 1.39523 2.59541 1.43886 2.36016 1.55872C2.01206 1.73609 1.72904 2.0191 1.55168 2.3672C1.43181 2.60245 1.38818 2.8457 1.36855 3.086C1.35002 3.31281 1.35003 3.58747 1.35004 3.90245L1.35004 10.4797C1.35003 10.9612 1.35002 11.3615 1.37672 11.6883C1.40453 12.0287 1.46451 12.346 1.61707 12.6454C1.85196 13.1064 2.22676 13.4812 2.68776 13.7161C2.98718 13.8687 3.30452 13.9287 3.64487 13.9565C3.97165 13.9832 4.37203 13.9832 4.85351 13.9831H11.1466C11.628 13.9832 12.0284 13.9832 12.3552 13.9565C12.6955 13.9287 13.0129 13.8687 13.3123 13.7161C13.7733 13.4812 14.1481 13.1064 14.383 12.6454C14.5356 12.346 14.5955 12.0287 14.6233 11.6883C14.65 11.3615 14.65 10.9612 14.65 10.4797L14.65 7.52948C14.65 7.048 14.6501 6.64762 14.6234 6.32084C14.5955 5.98049 14.5356 5.66315 14.383 5.36373C14.1481 4.90273 13.7733 4.52793 13.3123 4.29304C13.0129 4.14047 12.6956 4.08049 12.3552 4.05269C12.0284 4.02599 11.628 4.02599 11.1466 4.026L9.03835 4.026ZM8.5853 5.326C8.59524 5.32623 8.6052 5.32623 8.61518 5.326H11.12C11.6348 5.326 11.9818 5.32651 12.2493 5.34837C12.5093 5.36961 12.6365 5.40772 12.7221 5.45135C12.9385 5.5616 13.1144 5.73753 13.2247 5.95391C13.2683 6.03953 13.3064 6.16674 13.3277 6.4267C13.3495 6.69424 13.35 7.04123 13.35 7.556L13.35 10.4531C13.35 10.9679 13.3495 11.3149 13.3277 11.5825C13.3064 11.8424 13.2683 11.9696 13.2247 12.0552C13.1144 12.2716 12.9385 12.4476 12.7221 12.5578C12.6365 12.6014 12.5093 12.6395 12.2493 12.6608C11.9818 12.6826 11.6348 12.6831 11.12 12.6831H4.88004C4.36526 12.6831 4.01828 12.6826 3.75073 12.6608C3.49077 12.6395 3.36356 12.6014 3.27795 12.5578C3.06156 12.4476 2.88563 12.2716 2.77538 12.0552C2.73176 11.9696 2.69364 11.8424 2.6724 11.5825C2.65054 11.3149 2.65004 10.9679 2.65004 10.4532L2.65004 5.326H8.5853Z"
+ />
+</svg>
diff --git a/packages/icons/src/__generated__/folder.tsx b/packages/icons/src/__generated__/folder.tsx
new file mode 100644
index 0000000000..7bf82a2c44
--- /dev/null
+++ b/packages/icons/src/__generated__/folder.tsx
@@ -0,0 +1,15 @@
+// Generated from icons/folder.svg
+
+import { forwardRef } from "react";
+import type { IconProps } from "../types";
+
+// prettier-ignore
+export const FolderIcon = forwardRef<SVGSVGElement, IconProps>(
+ ({ color = "currentColor", size = 16, ...props }, forwardedRef) => {
+ return (
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width={size} height={size} fill={color} {...props} ref={forwardedRef}><path fill="currentColor" fillRule="evenodd" d="M6.838 2.687c-.063-.021-.147-.03-.625-.03H3.92c-.347 0-.568 0-.735.014a.643.643 0 0 0-.235.046.55.55 0 0 0-.24.24.643.643 0 0 0-.046.235c-.013.167-.014.388-.014.735v.099h4.983a21.92 21.92 0 0 0-.292-.684c-.18-.39-.249-.48-.298-.528a.55.55 0 0 0-.205-.127Zm2.2 1.339-.104-.256c-.143-.35-.317-.767-.414-.975-.176-.38-.329-.676-.567-.91a1.85 1.85 0 0 0-.691-.427c-.297-.102-.618-.102-.971-.101H3.895c-.315 0-.59 0-.816.019-.24.02-.484.063-.719.183a1.85 1.85 0 0 0-.808.808c-.12.235-.164.479-.183.719-.019.227-.019.501-.019.816v6.578c0 .481 0 .881.027 1.208.028.34.088.658.24.957.235.461.61.836 1.07 1.071.3.153.618.213.958.24.327.027.727.027 1.209.027h6.293c.481 0 .881 0 1.208-.027.34-.027.658-.087.957-.24a2.45 2.45 0 0 0 1.071-1.07c.153-.3.213-.617.24-.958.027-.327.027-.727.027-1.208V7.53c0-.482 0-.882-.027-1.21-.027-.34-.087-.657-.24-.956a2.45 2.45 0 0 0-1.07-1.071c-.3-.153-.617-.213-.958-.24a16.033 16.033 0 0 0-1.208-.027H9.038Zm-.453 1.3H11.12c.515 0 .862 0 1.13.022.26.022.386.06.472.103.216.11.392.287.503.503.043.086.081.213.103.473.022.267.022.614.022 1.129v2.897c0 .515 0 .862-.022 1.13-.022.26-.06.387-.103.472a1.15 1.15 0 0 1-.503.503c-.085.043-.213.082-.473.103-.267.022-.614.022-1.129.022H4.88c-.515 0-.862 0-1.13-.022-.26-.021-.386-.06-.472-.103a1.15 1.15 0 0 1-.503-.503c-.043-.085-.081-.213-.103-.473a15.479 15.479 0 0 1-.022-1.129V5.326h5.935Z" clipRule="evenodd" /></svg>
+ );
+ }
+);
+
+FolderIcon.displayName = "FolderIcon";
diff --git a/packages/icons/src/__generated__/index.ts b/packages/icons/src/__generated__/index.ts
index 719ed56e80..d9f2483cf0 100644
--- a/packages/icons/src/__generated__/index.ts
+++ b/packages/icons/src/__generated__/index.ts
@@ -85,6 +85,7 @@ export * from "./embed";
export * from "./external-link";
export * from "./eyecon-closed";
export * from "./eyecon-open";
+export * from "./folder";
export * from "./footer";
export * from "./form-text-area";
export * from "./form-text-field";
diff --git a/packages/icons/src/__generated__/svg/folder.ts b/packages/icons/src/__generated__/svg/folder.ts
new file mode 100644
index 0000000000..9611926094
--- /dev/null
+++ b/packages/icons/src/__generated__/svg/folder.ts
@@ -0,0 +1 @@
+export const FolderIcon = `<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 16 16" width="100%" height="100%" style="display: block;"><path fill="currentColor" fill-rule="evenodd" d="M6.838 2.687c-.063-.021-.147-.03-.625-.03H3.92c-.347 0-.568 0-.735.014a.643.643 0 0 0-.235.046.55.55 0 0 0-.24.24.643.643 0 0 0-.046.235c-.013.167-.014.388-.014.735v.099h4.983a21.92 21.92 0 0 0-.292-.684c-.18-.39-.249-.48-.298-.528a.55.55 0 0 0-.205-.127Zm2.2 1.339-.104-.256c-.143-.35-.317-.767-.414-.975-.176-.38-.329-.676-.567-.91a1.85 1.85 0 0 0-.691-.427c-.297-.102-.618-.102-.971-.101H3.895c-.315 0-.59 0-.816.019-.24.02-.484.063-.719.183a1.85 1.85 0 0 0-.808.808c-.12.235-.164.479-.183.719-.019.227-.019.501-.019.816v6.578c0 .481 0 .881.027 1.208.028.34.088.658.24.957.235.461.61.836 1.07 1.071.3.153.618.213.958.24.327.027.727.027 1.209.027h6.293c.481 0 .881 0 1.208-.027.34-.027.658-.087.957-.24a2.45 2.45 0 0 0 1.071-1.07c.153-.3.213-.617.24-.958.027-.327.027-.727.027-1.208V7.53c0-.482 0-.882-.027-1.21-.027-.34-.087-.657-.24-.956a2.45 2.45 0 0 0-1.07-1.071c-.3-.153-.617-.213-.958-.24a16.033 16.033 0 0 0-1.208-.027H9.038Zm-.453 1.3H11.12c.515 0 .862 0 1.13.022.26.022.386.06.472.103.216.11.392.287.503.503.043.086.081.213.103.473.022.267.022.614.022 1.129v2.897c0 .515 0 .862-.022 1.13-.022.26-.06.387-.103.472a1.15 1.15 0 0 1-.503.503c-.085.043-.213.082-.473.103-.267.022-.614.022-1.129.022H4.88c-.515 0-.862 0-1.13-.022-.26-.021-.386-.06-.472-.103a1.15 1.15 0 0 1-.503-.503c-.043-.085-.081-.213-.103-.473a15.479 15.479 0 0 1-.022-1.129V5.326h5.935Z" clip-rule="evenodd"/></svg>`;
diff --git a/packages/icons/src/__generated__/svg/index.ts b/packages/icons/src/__generated__/svg/index.ts
index 99489105bf..dc27f885a6 100644
--- a/packages/icons/src/__generated__/svg/index.ts
+++ b/packages/icons/src/__generated__/svg/index.ts
@@ -85,6 +85,7 @@ export { EmbedIcon } from "./embed";
export { ExternalLinkIcon } from "./external-link";
export { EyeconClosedIcon } from "./eyecon-closed";
export { EyeconOpenIcon } from "./eyecon-open";
+export { FolderIcon } from "./folder";
export { FooterIcon } from "./footer";
export { FormTextAreaIcon } from "./form-text-area";
export { FormTextFieldIcon } from "./form-text-field";
diff --git a/packages/prisma-client/prisma/migrations/20240112011509_folders/migration.ts b/packages/prisma-client/prisma/migrations/20240112011509_folders/migration.ts
new file mode 100644
index 0000000000..28ee1f8aaf
--- /dev/null
+++ b/packages/prisma-client/prisma/migrations/20240112011509_folders/migration.ts
@@ -0,0 +1,101 @@
+import { PrismaClient } from "./client";
+
+export default async () => {
+ const client = new PrismaClient({
+ // Uncomment to see the queries in console as the migration runs
+ // log: ["query", "info", "warn", "error"],
+ });
+
+ await client.$transaction(
+ async (prisma) => {
+ const chunkSize = 1000;
+ let cursor: undefined | string = undefined;
+ let hasNext = true;
+
+ while (hasNext) {
+ console.log("CHUNK", cursor);
+ console.time("read");
+
+ const cursorOptions: {} = cursor
+ ? {
+ skip: 1, // Skip the cursor
+ cursor: { id: cursor },
+ }
+ : {};
+
+ const builds = await prisma.build.findMany({
+ select: {
+ id: true,
+ pages: true,
+ },
+ take: chunkSize,
+ orderBy: {
+ id: "asc",
+ },
+ //where: { id: "d55ce7ea-6853-40af-8a65-b63b79dde0f9" },
+ ...cursorOptions,
+ });
+ console.timeEnd("read");
+
+ console.time("parse-change");
+ cursor = builds.at(-1)?.id;
+ hasNext = builds.length === chunkSize;
+ const changedBuilds: typeof builds = [];
+
+ for (const build of builds) {
+ const pages = JSON.parse(build.pages);
+ // Already migrated
+ if (pages.folders) {
+ continue;
+ }
+
+ try {
+ const pageIds = [pages.homePage, ...pages.pages].map(
+ (page) => page.id
+ );
+
+ pages.folders = [
+ {
+ id: "root",
+ name: "Root",
+ slug: "",
+ children: pageIds,
+ },
+ ];
+
+ build.pages = JSON.stringify(pages);
+ changedBuilds.push(build);
+ } catch {
+ console.info(`build ${build.id} cannot be converted`);
+ }
+ }
+
+ if (changedBuilds.length === 0) {
+ return;
+ }
+
+ console.timeEnd("parse-change");
+ console.log("changedBuilds.length", changedBuilds.length);
+ console.time("update");
+
+ const sql = `
+ UPDATE "Build"
+ SET
+ "pages" = data."pages"
+ FROM unnest(ARRAY[$1], ARRAY[$2]) as data(id, pages)
+ WHERE "Build"."id" = data."id"
+ `;
+
+ const res = await prisma.$executeRawUnsafe(
+ sql,
+ changedBuilds.map((changedBuild) => changedBuild.id),
+ changedBuilds.map((changedBuild) => changedBuild.pages)
+ );
+
+ console.timeEnd("update");
+ console.log("res", res);
+ }
+ },
+ { timeout: 3600000 }
+ );
+};
diff --git a/packages/prisma-client/prisma/migrations/20240112011509_folders/schema.prisma b/packages/prisma-client/prisma/migrations/20240112011509_folders/schema.prisma
new file mode 100644
index 0000000000..1d5e9057f0
--- /dev/null
+++ b/packages/prisma-client/prisma/migrations/20240112011509_folders/schema.prisma
@@ -0,0 +1,310 @@
+// DO NOT EDIT THIS FILE!
+// This is a copy of your schema.prisma that corresponds to the state of the database
+// when all migrations up until this one are applied.
+// It's used to generate a Prisma Client for the migration.
+
+// This is your Prisma schema file,
+// learn more about it in the docs: https://pris.ly/d/prisma-schema
+
+generator client {
+ provider = "prisma-client-js"
+ previewFeatures = ["views", "clientExtensions", "jsonProtocol"]
+ // see commands.ts
+ output = "client"
+}
+
+datasource db {
+ provider = "postgres"
+ url = env("DATABASE_URL")
+}
+
+model Team {
+ id String @id @default(uuid())
+ users User[]
+}
+
+enum UploadStatus {
+ UPLOADING
+ UPLOADED
+}
+
+model File {
+ name String @id
+ format String
+ size Int
+ description String?
+ createdAt DateTime @default(now())
+ updatedAt DateTime @default(now()) @updatedAt
+ meta String @default("{}")
+ status UploadStatus @default(UPLOADING)
+ isDeleted Boolean @default(false)
+ uploaderProject Project? @relation(fields: [uploaderProjectId], references: [id])
+ uploaderProjectId String?
+ assets Asset[]
+}
+
+model Asset {
+ id String @default(uuid()) // not unique!
+ projectId String
+ file File @relation(fields: [name], references: [name])
+ name String
+
+ @@id([id, projectId])
+}
+
+model User {
+ id String @id @default(uuid())
+ email String? @unique
+ provider String?
+ image String?
+ username String?
+ createdAt DateTime @default(now())
+ team Team? @relation(fields: [teamId], references: [id])
+ teamId String?
+ projects Project[]
+ clientReferences ClientReferences[]
+ checkout TransactionLog[]
+ products UserProduct[]
+}
+
+// User client references in external services like stripe etc
+model ClientReferences {
+ reference String @default(dbgenerated())
+ service String
+ createdAt DateTime @default(now())
+ user User @relation(fields: [userId], references: [id])
+ userId String
+
+ @@id([userId, service])
+ @@unique([reference, service])
+}
+
+model Product {
+ id String @id
+ name String
+ description String?
+ features String[]
+ images String[]
+ meta Json
+
+ createdAt DateTime @default(now())
+ checkout TransactionLog[]
+ userProducts UserProduct[]
+}
+
+model TransactionLog {
+ // Stripe event id (debug and idempotency purposes)
+ eventId String @id
+ userId String
+ user User @relation(fields: [userId], references: [id])
+
+ productId String?
+ product Product? @relation(fields: [productId], references: [id])
+
+ createdAt DateTime @default(now())
+
+ eventData Json? @default(dbgenerated())
+
+ eventType String? @default(dbgenerated())
+ eventCreated Int? @default(dbgenerated())
+
+ // paid
+ status String? @default(dbgenerated())
+
+ customerId String? @default(dbgenerated())
+ customerEmail String? @default(dbgenerated())
+
+ subscriptionId String? @default(dbgenerated())
+
+ // Used for Refund
+ paymentIntent String? @default(dbgenerated())
+
+ @@unique([eventId, productId])
+}
+
+view UserProduct {
+ userId String
+ user User @relation(fields: [userId], references: [id])
+ productId String
+ product Product @relation(fields: [productId], references: [id])
+ // subscriptionId and customerId not null for subscriptions
+ subscriptionId String?
+ customerId String?
+ // Easier to debug
+ customerEmail String?
+
+ @@unique([userId, productId])
+}
+
+model Project {
+ id String @id @default(uuid())
+ createdAt DateTime @default(now())
+ title String
+ domain String @unique
+ user User? @relation(fields: [userId], references: [id])
+ userId String?
+ build Build[]
+ isDeleted Boolean @default(false)
+ files File[]
+ projectDomain ProjectDomain[]
+ latestBuild LatestBuildPerProject?
+ authorizationToken AuthorizationToken[]
+
+ @@unique([id, isDeleted])
+ @@unique([domain, isDeleted])
+ @@unique([id, domain])
+}
+
+enum PublishStatus {
+ PENDING
+ PUBLISHED
+ FAILED
+}
+
+model Build {
+ id String @unique @default(uuid())
+ version Int @default(0)
+ lastTransactionId String?
+ createdAt DateTime @default(now())
+ updatedAt DateTime @default(now()) @updatedAt
+ pages String
+
+ project Project @relation(fields: [projectId], references: [id])
+ projectId String
+
+ breakpoints String @default("[]")
+ styles String @default("[]")
+ styleSources String @default("[]")
+ styleSourceSelections String @default("[]")
+ props String @default("[]")
+ dataSources String @default("[]")
+ resources String @default("[]")
+ instances String @default("[]")
+
+ deployment String?
+ publishStatus PublishStatus @default(PENDING)
+
+ @@id([id, projectId])
+}
+
+enum AuthorizationRelation {
+ viewers
+ editors
+ builders
+ administrators
+}
+
+model AuthorizationToken {
+ token String @default(uuid())
+ projectId String
+ project Project @relation(fields: [projectId], references: [id])
+ name String @default("")
+ relation AuthorizationRelation @default(viewers)
+ createdAt DateTime @default(now())
+
+ @@id([token, projectId])
+ @@unique([token])
+}
+
+enum DomainStatus {
+ INITIALIZING
+ ACTIVE
+ ERROR
+ PENDING
+}
+
+// Domains + last known status and last known txtRecord
+// In the future we can update this table using queue, n8n or temporal workflows.
+// As of now updates are done during UI interactions
+model Domain {
+ id String @id @default(uuid())
+ domain String @unique
+ createdAt DateTime @default(now())
+ updatedAt DateTime @default(now()) @updatedAt
+
+ ProjectDomain ProjectDomain[]
+ // Last known txtRecord of the domain (to check domain ownership)
+ txtRecord String?
+ // create, init, pending, active, error
+ status DomainStatus @default(INITIALIZING)
+ // In case of status="error", this will contain the error message
+ error String?
+
+ projectWithDomain ProjectWithDomain[]
+}
+
+model ProjectDomain {
+ projectId String
+ project Project @relation(fields: [projectId], references: [id])
+ domainId String
+ domain Domain @relation(fields: [domainId], references: [id])
+ createdAt DateTime @default(now())
+ // Generated txt record to check domain ownership
+ txtRecord String @unique @default(uuid())
+
+ // CNAME record to point to the domain
+ cname String
+
+ @@id([projectId, domainId])
+ @@index([domainId])
+}
+
+view ProjectWithDomain {
+ projectId String
+
+ domainId String
+ domain Domain @relation(fields: [domainId], references: [id])
+ txtRecord String
+
+ createdAt DateTime
+
+ // CNAME record to point to the domain
+ cname String
+
+ verified Boolean
+ // To count statistics per user
+ userId String?
+
+ // We can deploy on per domain basis, here for each project domain we have latest build
+ latestBuid LatestBuildPerProjectDomain?
+
+ @@id([projectId, domainId])
+}
+
+view LatestBuildPerProjectDomain {
+ domainId String
+ buildId String
+ projectId String
+ projectWithDomain ProjectWithDomain @relation(fields: [projectId, domainId], references: [projectId, domainId])
+
+ isLatestBuild Boolean
+ publishStatus PublishStatus
+ updatedAt DateTime
+
+ @@id([projectId, domainId])
+}
+
+view LatestBuildPerProject {
+ buildId String
+
+ projectId String
+ domain String
+ project Project @relation(fields: [projectId, domain], references: [id, domain])
+
+ isLatestBuild Boolean
+ publishStatus PublishStatus
+ updatedAt DateTime
+
+ @@id([projectId, domain])
+}
+
+// Dashboard
+view DashboardProject {
+ id String @id @default(uuid())
+ createdAt DateTime @default(now())
+ title String
+ domain String
+ userId String?
+ isDeleted Boolean @default(false)
+ isPublished Boolean
+}
diff --git a/packages/project-build/src/db/breakpoints.ts b/packages/project-build/src/db/__DEPRECATED__/breakpoints.ts
similarity index 92%
rename from packages/project-build/src/db/breakpoints.ts
rename to packages/project-build/src/db/__DEPRECATED__/breakpoints.ts
index 838f8aa13f..a30785a877 100644
--- a/packages/project-build/src/db/breakpoints.ts
+++ b/packages/project-build/src/db/__DEPRECATED__/breakpoints.ts
@@ -1,3 +1,4 @@
+// DEPRECATED: use parseData and serializeData from build.ts
import { nanoid } from "nanoid";
import {
type Breakpoint,
diff --git a/packages/project-build/src/db/data-sources.ts b/packages/project-build/src/db/__DEPRECATED__/data-sources.ts
similarity index 89%
rename from packages/project-build/src/db/data-sources.ts
rename to packages/project-build/src/db/__DEPRECATED__/data-sources.ts
index 844224f6c9..25aa483b26 100644
--- a/packages/project-build/src/db/data-sources.ts
+++ b/packages/project-build/src/db/__DEPRECATED__/data-sources.ts
@@ -1,3 +1,4 @@
+// DEPRECATED: use parseData and serializeData from build.ts
import type { DataSource, DataSources } from "@webstudio-is/sdk";
export const parseDataSources = (dataSourcesString: string): DataSources => {
diff --git a/packages/project-build/src/db/instances.ts b/packages/project-build/src/db/__DEPRECATED__/instances.ts
similarity index 87%
rename from packages/project-build/src/db/instances.ts
rename to packages/project-build/src/db/__DEPRECATED__/instances.ts
index b31aae4e33..b4ff0621c1 100644
--- a/packages/project-build/src/db/instances.ts
+++ b/packages/project-build/src/db/__DEPRECATED__/instances.ts
@@ -1,3 +1,4 @@
+// DEPRECATED: use parseData and serializeData from build.ts
import { Instances, Instance } from "@webstudio-is/sdk";
export const parseInstances = (instancesString: string): Instances => {
diff --git a/packages/project-build/src/db/pages.ts b/packages/project-build/src/db/__DEPRECATED__/pages.ts
similarity index 79%
rename from packages/project-build/src/db/pages.ts
rename to packages/project-build/src/db/__DEPRECATED__/pages.ts
index 40c0d02dfb..274def7104 100644
--- a/packages/project-build/src/db/pages.ts
+++ b/packages/project-build/src/db/__DEPRECATED__/pages.ts
@@ -1,3 +1,4 @@
+// DEPRECATED: use parseData and serializeData from build.ts
import type { Pages } from "@webstudio-is/sdk";
export const parsePages = (pagesString: string): Pages => {
diff --git a/packages/project-build/src/db/props.ts b/packages/project-build/src/db/__DEPRECATED__/props.ts
similarity index 85%
rename from packages/project-build/src/db/props.ts
rename to packages/project-build/src/db/__DEPRECATED__/props.ts
index 80e03209f3..a415c3ea05 100644
--- a/packages/project-build/src/db/props.ts
+++ b/packages/project-build/src/db/__DEPRECATED__/props.ts
@@ -1,3 +1,4 @@
+// DEPRECATED: use parseData and serializeData from build.ts
import { Props, Prop } from "@webstudio-is/sdk";
export const parseProps = (propsString: string): Props => {
diff --git a/packages/project-build/src/db/style-sources.ts b/packages/project-build/src/db/__DEPRECATED__/style-sources.ts
similarity index 89%
rename from packages/project-build/src/db/style-sources.ts
rename to packages/project-build/src/db/__DEPRECATED__/style-sources.ts
index 50558fa707..5c1eb46bfa 100644
--- a/packages/project-build/src/db/style-sources.ts
+++ b/packages/project-build/src/db/__DEPRECATED__/style-sources.ts
@@ -1,3 +1,4 @@
+// DEPRECATED: use parseData and serializeData from build.ts
import type { StyleSource, StyleSources } from "@webstudio-is/sdk";
export const parseStyleSources = (styleSourceString: string): StyleSources => {
diff --git a/packages/project-build/src/db/build.ts b/packages/project-build/src/db/build.ts
index c7bbcef4e2..acd10e0540 100644
--- a/packages/project-build/src/db/build.ts
+++ b/packages/project-build/src/db/build.ts
@@ -17,15 +17,17 @@ import {
createInitialBreakpoints,
parseBreakpoints,
serializeBreakpoints,
-} from "./breakpoints";
+} from "./__DEPRECATED__/breakpoints";
import { parseStyles } from "./styles";
-import { parseStyleSources } from "./style-sources";
+import { parseStyleSources } from "./__DEPRECATED__/style-sources";
import { parseStyleSourceSelections } from "./style-source-selections";
-import { parseProps } from "./props";
-import { parseDataSources } from "./data-sources";
-import { parseInstances, serializeInstances } from "./instances";
+import { parseProps } from "./__DEPRECATED__/props";
+import { parseDataSources } from "./__DEPRECATED__/data-sources";
+import { parseInstances, serializeInstances } from "./__DEPRECATED__/instances";
import { parseDeployment, serializeDeployment } from "./deployment";
import type { Data } from "@webstudio-is/http-client";
+import { parsePages, serializePages } from "./__DEPRECATED__/pages";
+import { createDefaultPages } from "../shared/pages-utils";
export const parseData = <Type extends { id: string }>(
string: string
@@ -45,7 +47,7 @@ const parseBuild = async (build: DbBuild): Promise<Build> => {
// eslint-disable-next-line no-console
console.time("parseBuild");
try {
- const pages = JSON.parse(build.pages) as Pages;
+ const pages = parsePages(build.pages);
const breakpoints = Array.from(parseBreakpoints(build.breakpoints));
const styles = Array.from(parseStyles(build.styles));
const styleSources = Array.from(parseStyleSources(build.styleSources));
@@ -150,23 +152,12 @@ export const createBuild = async (
const newInstances = createNewPageInstances();
const [rootInstanceId] = newInstances[0];
- const newPages = Pages.parse({
- meta: {},
- homePage: {
- id: nanoid(),
- name: "Home",
- path: "",
- title: "Home",
- meta: {},
- rootInstanceId,
- },
- pages: [],
- } satisfies Pages);
+ const defaultPages = Pages.parse(createDefaultPages({ rootInstanceId }));
await client.build.create({
data: {
projectId: props.projectId,
- pages: JSON.stringify(newPages),
+ pages: serializePages(defaultPages),
breakpoints: serializeBreakpoints(new Map(createInitialBreakpoints())),
instances: serializeInstances(new Map(newInstances)),
},
diff --git a/packages/project-build/src/db/style-source-selections.ts b/packages/project-build/src/db/style-source-selections.ts
index 7a25d5bdad..2867442662 100644
--- a/packages/project-build/src/db/style-source-selections.ts
+++ b/packages/project-build/src/db/style-source-selections.ts
@@ -1,3 +1,4 @@
+// DEPRECATED: use parseData and serializeData from build.ts
import type {
StyleSourceSelections,
StyleSourceSelection,
diff --git a/packages/project-build/src/index.server.ts b/packages/project-build/src/index.server.ts
index cfcdf5dfaf..f147a2cec6 100644
--- a/packages/project-build/src/index.server.ts
+++ b/packages/project-build/src/index.server.ts
@@ -1,9 +1,9 @@
export * from "./db/build";
-export * from "./db/pages";
-export * from "./db/breakpoints";
+export * from "./db/__DEPRECATED__/pages";
+export * from "./db/__DEPRECATED__/breakpoints";
export * from "./db/styles";
-export * from "./db/style-sources";
-export * from "./db/instances";
-export * from "./db/props";
+export * from "./db/__DEPRECATED__/style-sources";
+export * from "./db/__DEPRECATED__/instances";
+export * from "./db/__DEPRECATED__/props";
export * from "./db/style-source-selections";
-export * from "./db/data-sources";
+export * from "./db/__DEPRECATED__/data-sources";
diff --git a/packages/project-build/src/shared/pages-utils.test.ts b/packages/project-build/src/shared/pages-utils.test.ts
index 41a0c97abd..967885a7ec 100644
--- a/packages/project-build/src/shared/pages-utils.test.ts
+++ b/packages/project-build/src/shared/pages-utils.test.ts
@@ -22,6 +22,7 @@ const pages = {
meta: {},
} satisfies Page,
],
+ folders: [],
} satisfies Pages;
describe("Find by id or path", () => {
diff --git a/packages/project-build/src/shared/pages-utils.ts b/packages/project-build/src/shared/pages-utils.ts
index dc7aaac962..72c5cbfca4 100644
--- a/packages/project-build/src/shared/pages-utils.ts
+++ b/packages/project-build/src/shared/pages-utils.ts
@@ -1,4 +1,5 @@
-import type { Pages, Page } from "@webstudio-is/sdk";
+import type { Pages, Page, Folder } from "@webstudio-is/sdk";
+import { nanoid } from "nanoid";
export const findPageByIdOrPath = (
pages: Pages,
@@ -11,3 +12,40 @@ export const findPageByIdOrPath = (
(page) => page.path === idOrPath || page.id === idOrPath
);
};
+
+export const ROOT_FOLDER_ID = "root";
+
+export const createRootFolder = (
+ children: Folder["children"] = []
+): Folder => ({
+ id: ROOT_FOLDER_ID,
+ name: "Root",
+ slug: "",
+ children,
+});
+
+export const createDefaultPages = ({
+ rootInstanceId,
+ homePageId = nanoid(),
+ homePagePath = "",
+}: {
+ rootInstanceId: string;
+ homePageId?: string;
+ homePagePath?: string;
+}): Pages => {
+ // This is a root folder that nobody can delete or going to be able to see.
+ const rootFolder = createRootFolder([homePageId]);
+ return {
+ meta: {},
+ homePage: {
+ id: homePageId,
+ name: "Home",
+ path: homePagePath,
+ title: "Home",
+ meta: {},
+ rootInstanceId,
+ },
+ pages: [],
+ folders: [rootFolder],
+ };
+};
diff --git a/packages/react-sdk/src/generator.test.ts b/packages/react-sdk/src/generator.test.ts
index 034b5eb1cb..b9cb2a50c2 100644
--- a/packages/react-sdk/src/generator.test.ts
+++ b/packages/react-sdk/src/generator.test.ts
@@ -10,13 +10,25 @@ const createPage = (path: string) => ({
meta: {},
});
+const pages = {
+ meta: {},
+ pages: [],
+ folders: [
+ {
+ id: "root",
+ name: "",
+ slug: "",
+ children: [],
+ },
+ ],
+};
+
test("generates forms properties", () => {
expect(
generateUtilsExport({
pages: {
- meta: {},
+ ...pages,
homePage: createPage("1"),
- pages: [],
},
props: new Map([
[
@@ -66,7 +78,7 @@ test("generates list of pages paths", () => {
expect(
generateUtilsExport({
pages: {
- meta: {},
+ ...pages,
homePage: createPage("/path1"),
pages: [createPage("/path2"), createPage("/path3")],
},
diff --git a/packages/sdk/src/schema/pages.ts b/packages/sdk/src/schema/pages.ts
index b3f5b7188e..a115513c59 100644
--- a/packages/sdk/src/schema/pages.ts
+++ b/packages/sdk/src/schema/pages.ts
@@ -2,6 +2,31 @@ import { z } from "zod";
const MIN_TITLE_LENGTH = 2;
+const PageId = z.string();
+const FolderId = z.string();
+
+export const FolderName = z
+ .string()
+ .refine((value) => value.trim() !== "", "Can't be empty");
+
+export const FolderSlug = z
+ .string()
+ .refine((slug) => slug !== "", "Can't be empty")
+ .refine((slug) => slug.includes("/") === false, "Can't contain a /")
+ .refine(
+ (path) => /^[-a-z0-9]*$/.test(path),
+ "Only a-z, 0-9 and - are allowed"
+ );
+
+export const Folder = z.object({
+ id: FolderId,
+ name: FolderName,
+ slug: z.string(),
+ children: z.array(z.union([FolderId, PageId])),
+});
+
+export type Folder = z.infer<typeof Folder>;
+
export const PageName = z
.string()
.refine((value) => value.trim() !== "", "Can't be empty");
@@ -14,7 +39,7 @@ export const PageTitle = z
);
const commonPageFields = {
- id: z.string(),
+ id: PageId,
name: PageName,
title: PageTitle,
meta: z.object({
@@ -98,6 +123,9 @@ export const Pages = z.object({
(array) => new Set(array.map((page) => page.path)).size === array.length,
"All paths must be unique"
),
+ folders: z
+ .array(Folder)
+ .refine((folders) => folders.length > 0, "Folders can't be empty"),
});
export type Pages = z.infer<typeof Pages>;