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.

Add sdk-components-react-remix package (#1691)

Bogdan Chadkin0d35e3982220
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index 9b71edf266..dc96b9a810 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -8,12 +8,12 @@ import {
defaultMetas,
defaultPropsMetas,
createElementsTree,
- customComponentMetas,
- customComponentPropsMetas,
setParams,
- customComponents,
} from "@webstudio-is/react-sdk";
import * as defaultComponents from "@webstudio-is/react-sdk/components";
+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 { publish } from "~/shared/pubsub";
import {
handshakenStore,
@@ -132,13 +132,13 @@ export const Canvas = ({ params }: CanvasProps): JSX.Element | null => {
const [isPreviewMode] = useIsPreviewMode();
const components = new Map(
- Object.entries({ ...defaultComponents, ...customComponents })
+ Object.entries({ ...defaultComponents, ...remixComponents })
) as Components;
useSyncInitializeOnce(() => {
registerComponentMetas(defaultMetas);
registerComponentPropsMetas(defaultPropsMetas);
- registerComponentMetas(customComponentMetas);
- registerComponentPropsMetas(customComponentPropsMetas);
+ registerComponentMetas(remixComponentMetas);
+ registerComponentPropsMetas(remixComponentPropsMetas);
});
// e.g. toggling preview is still needed in both modes
diff --git a/apps/builder/package.json b/apps/builder/package.json
index 1c5ce63502..fe68ca7cfa 100644
--- a/apps/builder/package.json
+++ b/apps/builder/package.json
@@ -54,6 +54,7 @@
"@webstudio-is/project": "workspace:^",
"@webstudio-is/project-build": "workspace:^",
"@webstudio-is/react-sdk": "workspace:^",
+ "@webstudio-is/sdk-components-react-remix": "workspace:^",
"@webstudio-is/trpc-interface": "workspace:^",
"colord": "^2.9.3",
"debug": "^4.3.4",
diff --git a/packages/react-sdk/package.json b/packages/react-sdk/package.json
index f247fabe96..4f03db4bd0 100644
--- a/packages/react-sdk/package.json
+++ b/packages/react-sdk/package.json
@@ -71,6 +71,11 @@
"source": "./src/components/components.ts",
"import": "./lib/components/components.js",
"require": "./lib/cjs/components/components.js"
+ },
+ "./css-normalize": {
+ "source": "./src/css/normalize.ts",
+ "import": "./lib/css/normalize.js",
+ "require": "./lib/cjs/css/normalize.js"
}
},
"types": "lib/types/index.d.ts",
diff --git a/packages/react-sdk/src/app/custom-components/index.ts b/packages/react-sdk/src/app/custom-components/index.ts
deleted file mode 100644
index 3a9006085e..0000000000
--- a/packages/react-sdk/src/app/custom-components/index.ts
+++ /dev/null
@@ -1,24 +0,0 @@
-import type { WsComponentPropsMeta } from "../../components/component-meta";
-import { Link } from "./link";
-import { LinkBlock } from "./link-block";
-import { RichTextLink } from "./rich-text-link";
-import { Form } from "./form";
-import {
- meta as formMeta,
- propsMeta as formPropsMeta,
-} from "../../components/form.ws";
-
-export const customComponents = {
- Link,
- RichTextLink,
- LinkBlock,
- Form,
-};
-
-export const customComponentPropsMetas: Record<string, WsComponentPropsMeta> = {
- Form: formPropsMeta,
-};
-
-export const customComponentMetas = {
- Form: formMeta,
-};
diff --git a/packages/react-sdk/src/index.ts b/packages/react-sdk/src/index.ts
index 0e435e6ef4..d4bb9bdf94 100644
--- a/packages/react-sdk/src/index.ts
+++ b/packages/react-sdk/src/index.ts
@@ -5,16 +5,13 @@ export * from "./pubsub";
export * from "./app";
export * from "./components/components";
export * from "./components/components-utils";
-export {
- customComponents,
- customComponentMetas,
- customComponentPropsMetas,
-} from "./app/custom-components";
export {
type WsComponentPropsMeta,
type WsComponentMeta,
type ComponentState,
+ type PresetStyle,
componentCategories,
stateCategories,
} from "./components/component-meta";
export * from "./embed-template";
+export { usePropUrl, getInstanceIdFromComponentProps } from "./props";
diff --git a/packages/sdk-components-react-remix/LICENSE b/packages/sdk-components-react-remix/LICENSE
new file mode 100644
index 0000000000..1f6edad9a7
--- /dev/null
+++ b/packages/sdk-components-react-remix/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Webstudio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/packages/sdk-components-react-remix/README.md b/packages/sdk-components-react-remix/README.md
new file mode 100644
index 0000000000..601fd6cabe
--- /dev/null
+++ b/packages/sdk-components-react-remix/README.md
@@ -0,0 +1,4 @@
+# Webstudio SDK
+
+Webstudio SDK is a TypeScript API that lets you use your Webstudio site or some components in your custom codebase or just render a complete Remix Document.
+It is currently under development, but feel free to play with the the current [landing site](https://github.com/webstudio-is/webstudio-landing)
diff --git a/packages/sdk-components-react-remix/package.json b/packages/sdk-components-react-remix/package.json
new file mode 100644
index 0000000000..2f4a5eadc2
--- /dev/null
+++ b/packages/sdk-components-react-remix/package.json
@@ -0,0 +1,63 @@
+{
+ "name": "@webstudio-is/sdk-components-react-remix",
+ "version": "0.68.0",
+ "description": "Webstudio components for Remix",
+ "author": "Webstudio <[email protected]>",
+ "homepage": "https://webstudio.is",
+ "license": "MIT",
+ "private": false,
+ "type": "module",
+ "types": "lib/types/index.d.ts",
+ "files": [
+ "lib/*",
+ "src/*"
+ ],
+ "sideEffects": false,
+ "exports": {
+ ".": {
+ "source": "./src/components.ts",
+ "import": "./lib/components.js",
+ "require": "./lib/cjs/components.js"
+ },
+ "./metas": {
+ "source": "./src/metas.ts",
+ "import": "./lib/metas.js",
+ "require": "./lib/cjs/metas.js"
+ },
+ "./props": {
+ "source": "./src/props.ts",
+ "import": "./lib/props.js",
+ "require": "./lib/cjs/props.js"
+ }
+ },
+ "scripts": {
+ "dev": "build-package --watch",
+ "build": "build-package",
+ "build:args": "generate-arg-types './src/*.tsx !./src/**/*.stories.tsx !./src/**/*.ws.tsx' && prettier --write \"**/*.props.ts\"",
+ "dts": "tsc --declarationDir lib/types",
+ "typecheck": "tsc --noEmit --emitDeclarationOnly false",
+ "lint": "eslint ./src --ext .ts,.tsx --max-warnings 0",
+ "checks": "pnpm typecheck && pnpm lint"
+ },
+ "peerDependencies": {
+ "@remix-run/react": "^1.15.0",
+ "react": "^18.2.0",
+ "react-dom": "^18.2.0"
+ },
+ "dependencies": {
+ "@webstudio-is/form-handlers": "workspace:^",
+ "@webstudio-is/generate-arg-types": "workspace:^",
+ "@webstudio-is/icons": "workspace:^",
+ "@webstudio-is/react-sdk": "workspace:^"
+ },
+ "devDependencies": {
+ "@remix-run/react": "^1.15.0",
+ "@types/react": "^18.0.35",
+ "@types/react-dom": "^18.0.11",
+ "@webstudio-is/scripts": "workspace:^",
+ "@webstudio-is/tsconfig": "workspace:^",
+ "react": "^18.2.0",
+ "react-dom": "^18.2.0",
+ "typescript": "5.0.3"
+ }
+}
diff --git a/packages/react-sdk/src/app/custom-components/__generated__/form.props.ts b/packages/sdk-components-react-remix/src/__generated__/form.props.ts
similarity index 100%
rename from packages/react-sdk/src/app/custom-components/__generated__/form.props.ts
rename to packages/sdk-components-react-remix/src/__generated__/form.props.ts
diff --git a/packages/react-sdk/src/app/custom-components/__generated__/link-block.props.ts b/packages/sdk-components-react-remix/src/__generated__/link-block.props.ts
similarity index 100%
rename from packages/react-sdk/src/app/custom-components/__generated__/link-block.props.ts
rename to packages/sdk-components-react-remix/src/__generated__/link-block.props.ts
diff --git a/packages/react-sdk/src/app/custom-components/__generated__/link.props.ts b/packages/sdk-components-react-remix/src/__generated__/link.props.ts
similarity index 100%
rename from packages/react-sdk/src/app/custom-components/__generated__/link.props.ts
rename to packages/sdk-components-react-remix/src/__generated__/link.props.ts
diff --git a/packages/react-sdk/src/app/custom-components/__generated__/rich-text-link.props.ts b/packages/sdk-components-react-remix/src/__generated__/rich-text-link.props.ts
similarity index 100%
rename from packages/react-sdk/src/app/custom-components/__generated__/rich-text-link.props.ts
rename to packages/sdk-components-react-remix/src/__generated__/rich-text-link.props.ts
diff --git a/packages/sdk-components-react-remix/src/components.ts b/packages/sdk-components-react-remix/src/components.ts
new file mode 100644
index 0000000000..7645047777
--- /dev/null
+++ b/packages/sdk-components-react-remix/src/components.ts
@@ -0,0 +1,4 @@
+export { Link } from "./link";
+export { LinkBlock } from "./link-block";
+export { RichTextLink } from "./rich-text-link";
+export { Form } from "./form";
diff --git a/packages/react-sdk/src/app/custom-components/form.tsx b/packages/sdk-components-react-remix/src/form.tsx
similarity index 97%
rename from packages/react-sdk/src/app/custom-components/form.tsx
rename to packages/sdk-components-react-remix/src/form.tsx
index 5a9abed391..277611d1d5 100644
--- a/packages/react-sdk/src/app/custom-components/form.tsx
+++ b/packages/sdk-components-react-remix/src/form.tsx
@@ -1,14 +1,14 @@
-import { useFetcher } from "@remix-run/react";
-import { formIdFieldName } from "@webstudio-is/form-handlers";
import {
- Children,
- cloneElement,
- forwardRef,
type ReactNode,
type ElementRef,
type ComponentProps,
+ Children,
+ cloneElement,
+ forwardRef,
} from "react";
-import { getInstanceIdFromComponentProps } from "../../props";
+import { useFetcher } from "@remix-run/react";
+import { formIdFieldName } from "@webstudio-is/form-handlers";
+import { getInstanceIdFromComponentProps } from "@webstudio-is/react-sdk";
export const defaultTag = "form";
diff --git a/packages/react-sdk/src/app/custom-components/form.ws.tsx b/packages/sdk-components-react-remix/src/form.ws.tsx
similarity index 95%
rename from packages/react-sdk/src/app/custom-components/form.ws.tsx
rename to packages/sdk-components-react-remix/src/form.ws.tsx
index 2660f16352..cf189ea1cb 100644
--- a/packages/react-sdk/src/app/custom-components/form.ws.tsx
+++ b/packages/sdk-components-react-remix/src/form.ws.tsx
@@ -1,10 +1,10 @@
import { FormIcon } from "@webstudio-is/icons/svg";
-import { form } from "../../css/normalize";
+import { form } from "@webstudio-is/react-sdk/css-normalize";
import type {
PresetStyle,
WsComponentMeta,
WsComponentPropsMeta,
-} from "../../components/component-meta";
+} from "@webstudio-is/react-sdk";
import type { defaultTag } from "./form";
import { props } from "./__generated__/form.props";
diff --git a/packages/react-sdk/src/app/custom-components/link-block.tsx b/packages/sdk-components-react-remix/src/link-block.tsx
similarity index 61%
rename from packages/react-sdk/src/app/custom-components/link-block.tsx
rename to packages/sdk-components-react-remix/src/link-block.tsx
index 1f4c1c6ae7..08356e9ace 100644
--- a/packages/react-sdk/src/app/custom-components/link-block.tsx
+++ b/packages/sdk-components-react-remix/src/link-block.tsx
@@ -1,4 +1,4 @@
-import { LinkBlock as BaseLink } from "../../components/link-block";
+import { LinkBlock as BaseLink } from "@webstudio-is/react-sdk";
import { wrapLinkComponent } from "./shared/remix-link";
export const LinkBlock = wrapLinkComponent(BaseLink);
diff --git a/packages/react-sdk/src/app/custom-components/link.tsx b/packages/sdk-components-react-remix/src/link.tsx
similarity index 64%
rename from packages/react-sdk/src/app/custom-components/link.tsx
rename to packages/sdk-components-react-remix/src/link.tsx
index ca033384e4..385a1ec11b 100644
--- a/packages/react-sdk/src/app/custom-components/link.tsx
+++ b/packages/sdk-components-react-remix/src/link.tsx
@@ -1,4 +1,4 @@
-import { Link as BaseLink } from "../../components/link";
+import { Link as BaseLink } from "@webstudio-is/react-sdk";
import { wrapLinkComponent } from "./shared/remix-link";
export const Link = wrapLinkComponent(BaseLink);
diff --git a/packages/sdk-components-react-remix/src/metas.ts b/packages/sdk-components-react-remix/src/metas.ts
new file mode 100644
index 0000000000..2fdd9e10e9
--- /dev/null
+++ b/packages/sdk-components-react-remix/src/metas.ts
@@ -0,0 +1 @@
+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
new file mode 100644
index 0000000000..34fe4253cf
--- /dev/null
+++ b/packages/sdk-components-react-remix/src/props.ts
@@ -0,0 +1 @@
+export { propsMeta as Form } from "./form.ws";
diff --git a/packages/react-sdk/src/app/custom-components/rich-text-link.tsx b/packages/sdk-components-react-remix/src/rich-text-link.tsx
similarity index 60%
rename from packages/react-sdk/src/app/custom-components/rich-text-link.tsx
rename to packages/sdk-components-react-remix/src/rich-text-link.tsx
index 9902df3d03..dd063ec2ee 100644
--- a/packages/react-sdk/src/app/custom-components/rich-text-link.tsx
+++ b/packages/sdk-components-react-remix/src/rich-text-link.tsx
@@ -1,4 +1,4 @@
-import { RichTextLink as BaseLink } from "../../components/rich-text-link";
+import { RichTextLink as BaseLink } from "@webstudio-is/react-sdk";
import { wrapLinkComponent } from "./shared/remix-link";
export const RichTextLink = wrapLinkComponent(BaseLink);
diff --git a/packages/react-sdk/src/app/custom-components/shared/remix-link.tsx b/packages/sdk-components-react-remix/src/shared/remix-link.tsx
similarity index 76%
rename from packages/react-sdk/src/app/custom-components/shared/remix-link.tsx
rename to packages/sdk-components-react-remix/src/shared/remix-link.tsx
index 030515f578..db669187a1 100644
--- a/packages/react-sdk/src/app/custom-components/shared/remix-link.tsx
+++ b/packages/sdk-components-react-remix/src/shared/remix-link.tsx
@@ -1,8 +1,10 @@
+import { forwardRef, type ComponentPropsWithoutRef } from "react";
import { NavLink as RemixLink } from "@remix-run/react";
-import type { ComponentPropsWithoutRef } from "react";
-import { forwardRef } from "react";
-import type { Link } from "../../../components/link";
-import { usePropUrl, getInstanceIdFromComponentProps } from "../../../props";
+import {
+ type Link,
+ usePropUrl,
+ getInstanceIdFromComponentProps,
+} from "@webstudio-is/react-sdk";
type LinkComponent = typeof Link;
type LinkProps = ComponentPropsWithoutRef<LinkComponent>;
diff --git a/packages/sdk-components-react-remix/tsconfig.json b/packages/sdk-components-react-remix/tsconfig.json
new file mode 100644
index 0000000000..6f3664ccab
--- /dev/null
+++ b/packages/sdk-components-react-remix/tsconfig.json
@@ -0,0 +1,10 @@
+{
+ "extends": "@webstudio-is/tsconfig/base.json",
+ "include": ["./src", "../../@types/**/*.d.ts"],
+ "compilerOptions": {
+ "module": "ES2020",
+ "target": "ES2020",
+ "outDir": "./lib",
+ "rootDir": "./src"
+ }
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 37a26652a4..7e02108ee3 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -158,6 +158,9 @@ importers:
'@webstudio-is/react-sdk':
specifier: workspace:^
version: link:../../packages/react-sdk
+ '@webstudio-is/sdk-components-react-remix':
+ specifier: workspace:^
+ version: link:../../packages/sdk-components-react-remix
'@webstudio-is/trpc-interface':
specifier: workspace:^
version: link:../../packages/trpc-interface
@@ -1334,6 +1337,46 @@ importers:
specifier: 5.0.3
version: 5.0.3
+ packages/sdk-components-react-remix:
+ dependencies:
+ '@webstudio-is/form-handlers':
+ specifier: workspace:^
+ version: link:../form-handlers
+ '@webstudio-is/generate-arg-types':
+ specifier: workspace:^
+ version: link:../generate-arg-types
+ '@webstudio-is/icons':
+ specifier: workspace:^
+ version: link:../icons
+ '@webstudio-is/react-sdk':
+ specifier: workspace:^
+ version: link:../react-sdk
+ devDependencies:
+ '@remix-run/react':
+ specifier: ^1.15.0
+ '@types/react':
+ specifier: ^18.0.35
+ version: 18.0.35
+ '@types/react-dom':
+ specifier: ^18.0.11
+ version: 18.0.11
+ '@webstudio-is/scripts':
+ specifier: workspace:^
+ version: link:../scripts
+ '@webstudio-is/tsconfig':
+ specifier: workspace:^
+ version: link:../tsconfig
+ react:
+ specifier: 18.2.0
+ version: 18.2.0
+ react-dom:
+ specifier: 18.2.0
+ version: 18.2.0([email protected])
+ typescript:
+ specifier: 5.0.3
+ version: 5.0.3
+
packages/sdk-size-test:
dependencies:
'@remix-run/cloudflare':