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.

Simplify generated remix overrides (#2283)

Bogdan Chadkin9272b4eadfc3
diff --git a/fixtures/webstudio-remix-vercel/.webstudio/data.json b/fixtures/webstudio-remix-vercel/.webstudio/data.json
index 859e7d4425..e0e9cb7670 100644
--- a/fixtures/webstudio-remix-vercel/.webstudio/data.json
+++ b/fixtures/webstudio-remix-vercel/.webstudio/data.json
@@ -1,9 +1,9 @@
{
"build": {
- "id": "d8e941cb-835b-4f1f-bf8b-4d546a2a67d8",
+ "id": "c067c0f9-d5f2-47a4-9fac-fa4755e0175a",
"projectId": "cddc1d44-af37-4cb6-a430-d300cf6f932d",
- "version": 41,
- "createdAt": "2023-09-06T11:37:11.556Z",
+ "version": 58,
+ "createdAt": "2023-09-08T10:02:53.659Z",
"pages": {
"homePage": {
"id": "7Db64ZXgYiRqKSQNR-qTQ",
@@ -366,6 +366,16 @@
"type": "asset",
"value": "cd939c56-bcdd-4e64-bd9c-567a9bccd3da"
}
+ ],
+ [
+ "SYK4hpLQ9tHnESKDtPvI9",
+ {
+ "id": "SYK4hpLQ9tHnESKDtPvI9",
+ "instanceId": "l9AI_pShC-BH4ibxK6kNT",
+ "name": "href",
+ "type": "string",
+ "value": "https://github.com/"
+ }
]
],
"dataSources": [],
@@ -434,6 +444,10 @@
{
"type": "id",
"value": "p34JHWcU6UNrd9FVnY80Q"
+ },
+ {
+ "type": "id",
+ "value": "l9AI_pShC-BH4ibxK6kNT"
}
]
}
@@ -488,6 +502,20 @@
"component": "Image",
"children": []
}
+ ],
+ [
+ "l9AI_pShC-BH4ibxK6kNT",
+ {
+ "type": "instance",
+ "id": "l9AI_pShC-BH4ibxK6kNT",
+ "component": "Link",
+ "children": [
+ {
+ "type": "text",
+ "value": "Click here to adore more kittens"
+ }
+ ]
+ }
]
],
"deployment": {
diff --git a/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsx b/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsx
index 07fed86125..9109b08630 100644
--- a/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsx
+++ b/fixtures/webstudio-remix-vercel/app/__generated__/_index.tsx
@@ -12,21 +12,17 @@ import {
Paragraph as Paragraph,
Image as Image,
} from "@webstudio-is/sdk-components-react";
+import { Link as Link } from "@webstudio-is/sdk-components-react-remix";
-import * as remixComponents from "@webstudio-is/sdk-components-react-remix";
export const components = new Map(
- Object.entries(
- Object.assign(
- {
- Body: Body,
- Heading: Heading,
- Box: Box,
- Paragraph: Paragraph,
- Image: Image,
- },
- remixComponents
- )
- )
+ Object.entries({
+ Body: Body,
+ Heading: Heading,
+ Box: Box,
+ Paragraph: Paragraph,
+ Image: Image,
+ Link: Link,
+ })
) as Components;
export const fontAssets: Asset[] = [];
export const pageData: PageData = {
@@ -42,6 +38,16 @@ export const pageData: PageData = {
value: "cd939c56-bcdd-4e64-bd9c-567a9bccd3da",
},
],
+ [
+ "SYK4hpLQ9tHnESKDtPvI9",
+ {
+ id: "SYK4hpLQ9tHnESKDtPvI9",
+ instanceId: "l9AI_pShC-BH4ibxK6kNT",
+ name: "href",
+ type: "string",
+ value: "https://github.com/",
+ },
+ ],
],
instances: [
[
@@ -91,6 +97,7 @@ export const pageData: PageData = {
children: [
{ type: "id", value: "oLXYe1UQiVMhVnZGvJSMr" },
{ type: "id", value: "p34JHWcU6UNrd9FVnY80Q" },
+ { type: "id", value: "l9AI_pShC-BH4ibxK6kNT" },
],
},
],
@@ -136,6 +143,17 @@ export const pageData: PageData = {
children: [],
},
],
+ [
+ "l9AI_pShC-BH4ibxK6kNT",
+ {
+ type: "instance",
+ id: "l9AI_pShC-BH4ibxK6kNT",
+ component: "Link",
+ children: [
+ { type: "text", value: "Click here to adore more kittens" },
+ ],
+ },
+ ],
],
dataSources: [],
},
diff --git a/packages/cli/src/prebuild.ts b/packages/cli/src/prebuild.ts
index 9d53f393c1..8cd2467f5a 100644
--- a/packages/cli/src/prebuild.ts
+++ b/packages/cli/src/prebuild.ts
@@ -1,8 +1,11 @@
import { join } from "node:path";
import { createWriteStream } from "node:fs";
import { rm, mkdir, access, mkdtemp, rename } from "node:fs/promises";
+import { pipeline } from "node:stream/promises";
import { tmpdir } from "node:os";
import { cwd } from "node:process";
+import pLimit from "p-limit";
+import ora from "ora";
import {
generateCssText,
generateUtilsExport,
@@ -17,14 +20,16 @@ import type {
DataSource,
Deployment,
} from "@webstudio-is/sdk";
-import { createScope, findTreeInstanceIds } from "@webstudio-is/sdk";
+import {
+ createScope,
+ findTreeInstanceIds,
+ parseComponentName,
+} from "@webstudio-is/sdk";
import type { Asset, FontAsset } from "@webstudio-is/sdk";
import type { Data } from "@webstudio-is/http-client";
import * as baseComponentMetas from "@webstudio-is/sdk-components-react/metas";
import * as remixComponentMetas from "@webstudio-is/sdk-components-react-remix/metas";
import * as radixComponentMetas from "@webstudio-is/sdk-components-react-radix/metas";
-import pLimit from "p-limit";
-import ora from "ora";
import { templates } from "./__generated__/templates";
import { assets } from "./__generated__/assets";
@@ -38,7 +43,6 @@ import {
parseFolderAndWriteAssets,
} from "./fs-utils";
import { getImageAttributes, createImageLoader } from "@webstudio-is/image";
-import { pipeline } from "node:stream/promises";
const limit = pLimit(10);
@@ -290,7 +294,6 @@ export const prebuild = async (options: {
"PageData",
"Components",
"Asset",
- "remixComponents",
"components",
"fontAssets",
"pageData",
@@ -304,46 +307,54 @@ export const prebuild = async (options: {
"executeEffectfulExpression",
"utils",
]);
- const components = Array.from(pageComponents);
const namespaces = new Map<
string,
- Set<[importName: string, componentName: string]>
+ Set<[shortName: string, componentName: string]>
>();
- const DEFAULT_NAMESPACE = "@webstudio-is/sdk-components-react";
-
- for (const component of components) {
- const nameArr = component.split(":");
- const [namespace, name] =
- nameArr.length === 1 ? [undefined, nameArr[0]] : nameArr;
+ const BASE_NAMESPACE = "@webstudio-is/sdk-components-react";
+ const REMIX_NAMESPACE = "@webstudio-is/sdk-components-react-remix";
+
+ for (const component of pageComponents) {
+ const parsed = parseComponentName(component);
+ let [namespace] = parsed;
+ const [_namespace, shortName] = parsed;
+
+ if (namespace === undefined) {
+ // use base as fallback namespace and consider remix overrides
+ if (shortName in remixComponentMetas) {
+ namespace = REMIX_NAMESPACE;
+ } else {
+ namespace = BASE_NAMESPACE;
+ }
+ }
- if (namespaces.has(namespace ?? DEFAULT_NAMESPACE) === false) {
+ if (namespaces.has(namespace) === false) {
namespaces.set(
- namespace ?? DEFAULT_NAMESPACE,
- new Set<[importName: string, componentName: string]>()
+ namespace,
+ new Set<[shortName: string, componentName: string]>()
);
}
-
- namespaces.get(namespace ?? DEFAULT_NAMESPACE)?.add([name, component]);
+ namespaces.get(namespace)?.add([shortName, component]);
}
let componentImports = "";
- let assignComponent = "";
+ let componentEntries = "";
for (const [namespace, componentsSet] of namespaces.entries()) {
const specifiers = Array.from(componentsSet)
.map(
- ([importName, component]) =>
- `${component} as ${scope.getName(component, importName)}`
+ ([shortName, component]) =>
+ `${component} as ${scope.getName(component, shortName)}`
)
.join(", ");
componentImports += `import { ${specifiers} } from "${namespace}";\n`;
const fields = Array.from(componentsSet)
.map(
- ([importName, component]) =>
- `"${component}": ${scope.getName(component, importName)}`
+ ([shortName, component]) =>
+ `"${component}": ${scope.getName(component, shortName)}`
)
.join(",");
- assignComponent += `${fields},\n`;
+ componentEntries += `${fields},\n`;
}
const pageData = siteDataByPage[pathName];
@@ -363,8 +374,7 @@ import type { PageData } from "~/routes/_index";
import type { Components } from "@webstudio-is/react-sdk";
import type { Asset } from "@webstudio-is/sdk";
${componentImports}
-import * as remixComponents from "@webstudio-is/sdk-components-react-remix";
-export const components = new Map(Object.entries(Object.assign({ ${assignComponent} }, remixComponents ))) as Components;
+export const components = new Map(Object.entries({ ${componentEntries} })) as Components;
export const fontAssets: Asset[] = ${JSON.stringify(fontAssets)}
export const pageData: PageData = ${JSON.stringify(pageData)};
export const user: { email: string | null } | undefined = ${JSON.stringify(
diff --git a/packages/sdk-components-react-remix/src/metas.ts b/packages/sdk-components-react-remix/src/metas.ts
index 2fdd9e10e9..e72d4c4420 100644
--- a/packages/sdk-components-react-remix/src/metas.ts
+++ b/packages/sdk-components-react-remix/src/metas.ts
@@ -1 +1,3 @@
+export { meta as Link } from "./link.ws";
+export { meta as RichTextLink } from "./rich-text-link.ws";
export { meta as Form } from "./form.ws";
diff --git a/packages/sdk-components-react-remix/src/props.ts b/packages/sdk-components-react-remix/src/props.ts
index 2278fcbbf7..fbcb638adc 100644
--- a/packages/sdk-components-react-remix/src/props.ts
+++ b/packages/sdk-components-react-remix/src/props.ts
@@ -1,3 +1,3 @@
-export { propsMeta as Form } from "./form.ws";
export { propsMeta as Link } from "./link.ws";
export { propsMeta as RichTextLink } from "./rich-text-link.ws";
+export { propsMeta as Form } from "./form.ws";
diff --git a/packages/sdk/src/instances-utils.test.ts b/packages/sdk/src/instances-utils.test.ts
index 05967ada28..2d4b173974 100644
--- a/packages/sdk/src/instances-utils.test.ts
+++ b/packages/sdk/src/instances-utils.test.ts
@@ -3,6 +3,7 @@ import type { Instance, Instances } from "./schema/instances";
import {
findTreeInstanceIds,
findTreeInstanceIdsExcludingSlotDescendants,
+ parseComponentName,
} from "./instances-utils";
const createInstance = (
@@ -68,3 +69,8 @@ test("find all tree instances excluding slot descendants", () => {
findTreeInstanceIdsExcludingSlotDescendants(instances, "box1")
).toEqual(new Set(["box1", "box12", "slot11"]));
});
+
+test("extract short name and namespace from component name", () => {
+ expect(parseComponentName("Box")).toEqual([undefined, "Box"]);
+ expect(parseComponentName("radix:Box")).toEqual(["radix", "Box"]);
+});
diff --git a/packages/sdk/src/instances-utils.ts b/packages/sdk/src/instances-utils.ts
index f02b1aa2dd..3f1983791d 100644
--- a/packages/sdk/src/instances-utils.ts
+++ b/packages/sdk/src/instances-utils.ts
@@ -44,3 +44,15 @@ export const findTreeInstanceIdsExcludingSlotDescendants = (
});
return ids;
};
+
+export const parseComponentName = (componentName: string) => {
+ const parts = componentName.split(":");
+ let namespace: undefined | string;
+ let name: string;
+ if (parts.length === 1) {
+ [name] = parts;
+ } else {
+ [namespace, name] = parts;
+ }
+ return [namespace, name] as const;
+};