Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

refactor: generate metas.json (#3096)

Bogdan Chadkincf92442ce3db
diff --git a/apps/builder/.gitignore b/apps/builder/.gitignore
index f56a416128..efaef2e083 100644
--- a/apps/builder/.gitignore
+++ b/apps/builder/.gitignore
@@ -10,4 +10,4 @@
/api/index.js.map
/api/_assets
/public/s/uploads
-
+/public/metas.json
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index b0ae6cf013..f9f1a52aa3 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -1,23 +1,19 @@
import { useMemo, useEffect, useState } from "react";
import { ErrorBoundary, type FallbackProps } from "react-error-boundary";
import { useStore } from "@nanostores/react";
-import type { Instances } from "@webstudio-is/sdk";
+import type { Instance, Instances } from "@webstudio-is/sdk";
import {
type Params,
type Components,
createElementsTree,
coreMetas,
corePropsMetas,
+ WsComponentMeta,
+ type WsComponentPropsMeta,
} from "@webstudio-is/react-sdk";
import * as baseComponents from "@webstudio-is/sdk-components-react";
-import * as baseComponentMetas from "@webstudio-is/sdk-components-react/metas";
-import * as baseComponentPropsMetas from "@webstudio-is/sdk-components-react/props";
import * as remixComponents from "@webstudio-is/sdk-components-react-remix";
-import * as remixComponentMetas from "@webstudio-is/sdk-components-react-remix/metas";
-import * as remixComponentPropsMetas from "@webstudio-is/sdk-components-react-remix/props";
import * as radixComponents from "@webstudio-is/sdk-components-react-radix";
-import * as radixComponentMetas from "@webstudio-is/sdk-components-react-radix/metas";
-import * as radixComponentPropsMetas from "@webstudio-is/sdk-components-react-radix/props";
import { hooks as radixComponentHooks } from "@webstudio-is/sdk-components-react-radix/hooks";
import { ErrorMessage } from "~/shared/error";
import { $publisher, publish } from "~/shared/pubsub";
@@ -134,6 +130,42 @@ const DesignMode = ({ params }: { params: Params }) => {
return null;
};
+const fetchAndRegisterLibraries = async () => {
+ const response = await fetch("/metas.json");
+ type Library = {
+ metas: Record<Instance["component"], WsComponentMeta>;
+ propsMetas: Record<Instance["component"], WsComponentPropsMeta>;
+ };
+ const data: {
+ base: Library;
+ remix: Library;
+ radix: Library;
+ } = await response.json();
+
+ registerComponentLibrary({
+ components: {},
+ metas: coreMetas,
+ propsMetas: corePropsMetas,
+ });
+ registerComponentLibrary({
+ components: baseComponents,
+ metas: data.base.metas,
+ propsMetas: data.base.propsMetas,
+ });
+ registerComponentLibrary({
+ components: remixComponents,
+ metas: data.remix.metas,
+ propsMetas: data.remix.propsMetas,
+ });
+ registerComponentLibrary({
+ namespace: "@webstudio-is/sdk-components-react-radix",
+ components: radixComponents,
+ metas: data.radix.metas,
+ propsMetas: data.radix.propsMetas,
+ hooks: radixComponentHooks,
+ });
+};
+
type CanvasProps = {
params: Params;
imageLoader: ImageLoader;
@@ -144,28 +176,7 @@ export const Canvas = ({ params, imageLoader }: CanvasProps) => {
const isPreviewMode = useStore($isPreviewMode);
useMount(() => {
- registerComponentLibrary({
- components: {},
- metas: coreMetas,
- propsMetas: corePropsMetas,
- });
- registerComponentLibrary({
- components: baseComponents,
- metas: baseComponentMetas,
- propsMetas: baseComponentPropsMetas,
- });
- registerComponentLibrary({
- components: remixComponents,
- metas: remixComponentMetas,
- propsMetas: remixComponentPropsMetas,
- });
- registerComponentLibrary({
- namespace: "@webstudio-is/sdk-components-react-radix",
- components: radixComponents,
- metas: radixComponentMetas,
- propsMetas: radixComponentPropsMetas,
- hooks: radixComponentHooks,
- });
+ fetchAndRegisterLibraries();
});
useMount(() => {
diff --git a/apps/builder/package.json b/apps/builder/package.json
index fbe8b20226..938b37b0b9 100644
--- a/apps/builder/package.json
+++ b/apps/builder/package.json
@@ -4,11 +4,12 @@
"private": true,
"description": "Webstudio Builder UI as a service",
"scripts": {
+ "generate-metas": "pnpm tsx scripts/generate-metas.mts",
"prebuild": "which remix",
- "build": "remix build",
+ "build": "pnpm generate-metas && remix build",
"start": "remix-serve build",
"start-local": "NODE_OPTIONS='-r dotenv/config' remix-serve build",
- "dev": "remix dev",
+ "dev": "pnpm generate-metas && remix dev",
"typecheck": "tsc --noEmit --emitDeclarationOnly false",
"test": "NODE_OPTIONS=--experimental-vm-modules jest",
"checks": "pnpm typecheck && pnpm test",
diff --git a/apps/builder/scripts/generate-metas.mts b/apps/builder/scripts/generate-metas.mts
new file mode 100644
index 0000000000..52c87f019a
--- /dev/null
+++ b/apps/builder/scripts/generate-metas.mts
@@ -0,0 +1,26 @@
+import { join } from "node:path";
+import { writeFile } from "node:fs/promises";
+import * as baseComponentMetas from "@webstudio-is/sdk-components-react/metas";
+import * as baseComponentPropsMetas from "@webstudio-is/sdk-components-react/props";
+import * as remixComponentMetas from "@webstudio-is/sdk-components-react-remix/metas";
+import * as remixComponentPropsMetas from "@webstudio-is/sdk-components-react-remix/props";
+import * as radixComponentMetas from "@webstudio-is/sdk-components-react-radix/metas";
+import * as radixComponentPropsMetas from "@webstudio-is/sdk-components-react-radix/props";
+
+const data = {
+ base: {
+ metas: baseComponentMetas,
+ propsMetas: baseComponentPropsMetas,
+ },
+ remix: {
+ metas: remixComponentMetas,
+ propsMetas: remixComponentPropsMetas,
+ },
+ radix: {
+ metas: radixComponentMetas,
+ propsMetas: radixComponentPropsMetas,
+ },
+};
+
+await writeFile(join(process.cwd(), "public/metas.json"), JSON.stringify(data));
+console.info("public/metas.json is generated");