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.
TypeScript accessibilityalternativecloudflarecloudflare-workersdesignfreefrontendopen-sourceradix-uireactremixweb-developmentwebflowwebsite-builderwebsite-developmentwebsiteswebstudio
Entri (#1738)
Ivan Starkovc534eb696572
diff --git a/apps/builder/app/builder/features/topbar/domains.tsx b/apps/builder/app/builder/features/topbar/domains.tsxindex c53dcadd4f..bc09274957 100644--- a/apps/builder/app/builder/features/topbar/domains.tsx+++ b/apps/builder/app/builder/features/topbar/domains.tsx@@ -9,6 +9,7 @@ import {styled,Flex,NestedInputButton,+ Separator,} from "@webstudio-is/design-system";import type { DomainRouter } from "@webstudio-is/domain/index.server";import type { Project } from "@webstudio-is/project";@@ -27,6 +28,7 @@ import { useCallback, useEffect, useState } from "react";import type { PublishStatus } from "@webstudio-is/prisma-client";// eslint-disable-next-line import/no-internal-modulesimport formatDistance from "date-fns/formatDistance";+import { Entri } from "./entri";const trpc = createTrpcFetchProxy<DomainRouter>(builderDomainsPath);@@ -355,6 +357,22 @@ const DomainItem = (props: {isLoading: false,});+ const cnameRecord = {+ type: "CNAME",+ host: cnameEntryName,+ value: cnameEntryValue,+ ttl: 300,+ } as const;++ const txtRecord = {+ type: "TXT",+ host: txtEntryName,+ value: props.projectDomain.txtRecord,+ ttl: 300,+ } as const;++ const dnsRecords = [cnameRecord, txtRecord];+return (<CollapsibleDomainSectioninitiallyOpen={props.initiallyOpen}@@ -488,7 +506,7 @@ const DomainItem = (props: {</Text><Grid- gap={1}+ gap={2}css={{gridTemplateColumns: `${theme.spacing[18]} ${theme.spacing[18]} 1fr`,}}@@ -506,27 +524,54 @@ const DomainItem = (props: {<InputEllipsis readOnly value="CNAME" /><InputEllipsisreadOnly- value={cnameEntryName}- suffix={<CopyToClipboard text={cnameEntryName} />}+ value={cnameRecord.host}+ suffix={<CopyToClipboard text={cnameRecord.host} />}/><InputEllipsisreadOnly- value={cnameEntryValue}- suffix={<CopyToClipboard text={cnameEntryValue} />}+ value={cnameRecord.value}+ suffix={<CopyToClipboard text={cnameRecord.value} />}/><InputEllipsis readOnly value="TXT" /><InputEllipsisreadOnly- value={txtEntryName}- suffix={<CopyToClipboard text={txtEntryName} />}+ value={txtRecord.host}+ suffix={<CopyToClipboard text={txtRecord.host} />}/><InputEllipsisreadOnly- value={props.projectDomain.txtRecord}- suffix={<CopyToClipboard text={props.projectDomain.txtRecord} />}+ value={txtRecord.value}+ suffix={<CopyToClipboard text={txtRecord.value} />}/></Grid>++ <Grid+ gap={2}+ align={"center"}+ css={{+ gridTemplateColumns: `1fr auto 1fr`,+ }}+ >+ <Separator css={{ alignSelf: "unset" }} />+ <Text color="main">OR</Text>+ <Separator css={{ alignSelf: "unset" }} />+ </Grid>++ <Entri+ dnsRecords={dnsRecords}+ domain={props.projectDomain.domain.domain}+ onClose={() => {+ // Sometimes Entri modal dialog hangs even if it's successful,+ // until they fix that, we'll just refresh the status here on every onClose event+ if (status === "UNVERIFIED") {+ handleVerify();+ return;+ }++ handleUpdateStatus();+ }}+ /></Grid></CollapsibleDomainSection>);diff --git a/apps/builder/app/builder/features/topbar/entri.tsx b/apps/builder/app/builder/features/topbar/entri.tsxnew file mode 100644index 0000000000..a6873be80c--- /dev/null+++ b/apps/builder/app/builder/features/topbar/entri.tsx@@ -0,0 +1,41 @@+import { Button, Text } from "@webstudio-is/design-system";+import {+ useEntri,+ entriGlobalStyles,+ type DnsRecord,+ type EntriCloseDetail,+} from "~/shared/entri/entri";++export const Entri = ({+ dnsRecords,+ domain,+ onClose,+}: {+ dnsRecords: DnsRecord[];+ domain: string;+ onClose: (detail: EntriCloseDetail) => void;+}) => {+ entriGlobalStyles();+ const { error, isOpen, showDialog } = useEntri({+ onClose,+ domain,+ dnsRecords,+ });++ return (+ <>+ {error !== undefined && <Text color="destructive">{error}</Text>}++ <Button+ disabled={isOpen}+ color="neutral"+ css={{ width: "100%", flexShrink: 0 }}+ onClick={() => {+ showDialog();+ }}+ >+ Configure automatically with entri+ </Button>+ </>+ );+};diff --git a/apps/builder/app/env/env.server.ts b/apps/builder/app/env/env.server.tsindex f708db0cfb..d536495cce 100644--- a/apps/builder/app/env/env.server.ts+++ b/apps/builder/app/env/env.server.ts@@ -71,6 +71,12 @@ const env = {* without ending slash*/RESIZE_ORIGIN: process.env.RESIZE_ORIGIN,++ /**+ * Entri API credentials+ */+ ENTRI_APPLICATION_ID: process.env.ENTRI_APPLICATION_ID ?? "webstudio",+ ENTRI_SECRET: process.env.ENTRI_SECRET,};export type ServerEnv = typeof env;diff --git a/apps/builder/app/shared/context.server.ts b/apps/builder/app/shared/context.server.tsindex 813e9721a5..9c4d15e548 100644--- a/apps/builder/app/shared/context.server.ts+++ b/apps/builder/app/shared/context.server.ts@@ -2,6 +2,7 @@ import type { AppContext } from "@webstudio-is/trpc-interface/index.server";import env from "~/env/env.server";import { authenticator } from "~/services/auth.server";import { trpcClient } from "~/services/trpc.server";+import { entryApi } from "./entri/entri-api.server";const createAuthorizationContext = async (request: Request@@ -48,6 +49,12 @@ const createDeploymentContext = (request: Request) => {return context;};+const createEntriContext = () => {+ return {+ entryApi,+ };+};+/*** argument buildEnv==="prod" only if we are loading project with production build*/@@ -55,10 +62,11 @@ export const createContext = async (request: Request): Promise<AppContext> => {const authorization = await createAuthorizationContext(request);const domain = createDomainContext(request);const deployment = createDeploymentContext(request);-+ const entri = createEntriContext();return {authorization,domain,deployment,+ entri,};};diff --git a/apps/builder/app/shared/entri/entri-api.server.ts b/apps/builder/app/shared/entri/entri-api.server.tsnew file mode 100644index 0000000000..044308f14a--- /dev/null+++ b/apps/builder/app/shared/entri/entri-api.server.ts@@ -0,0 +1,47 @@+import { z } from "zod";+import env from "~/env/env.server";++const EntryResponse = z.object({+ auth_token: z.string(),+});++/**+ * Short lived JWT token for Entri API+ * https://developers.entri.com/docs/install#3-fetch-the-json-web-token-jwt+ */+const getEntriToken = async () => {+ const { ENTRI_APPLICATION_ID, ENTRI_SECRET } = env;++ if (ENTRI_SECRET === undefined) {+ throw new Error(`ENTRI_SECRET is not defined`);+ }++ const entryResponse = await fetch("https://api.goentri.com/token", {+ method: "POST",+ body: JSON.stringify({+ // These values come from the Entri dashboard+ applicationId: ENTRI_APPLICATION_ID,+ secret: ENTRI_SECRET,+ }),+ headers: {+ "Content-Type": "application/json",+ Accept: "application/json",+ },+ });++ if (entryResponse.ok === false) {+ throw new Error(`Entri API error: ${await entryResponse.text()}`);+ }++ const entryJson = await entryResponse.json();+ const responseData = EntryResponse.parse(entryJson);++ return {+ token: responseData.auth_token,+ applicationId: ENTRI_APPLICATION_ID,+ } as const;+};++export const entryApi = {+ getEntriToken,+};diff --git a/apps/builder/app/shared/entri/entri.ts b/apps/builder/app/shared/entri/entri.tsnew file mode 100644index 0000000000..8a7c6e50f9--- /dev/null+++ b/apps/builder/app/shared/entri/entri.ts@@ -0,0 +1,162 @@+import useScript from "react-script-hook";+import type { DomainRouter } from "@webstudio-is/domain/index.server";+import { createTrpcFetchProxy } from "~/shared/remix/trpc-remix-proxy";+import { builderDomainsPath } from "~/shared/router-utils";+import { globalCss } from "@webstudio-is/design-system";+import { useCallback, useEffect, useRef, useState } from "react";++const trpc = createTrpcFetchProxy<DomainRouter>(builderDomainsPath);++const scriptAttributes = {+ async: true,+ defer: true,+ importance: "low",+ src: "https://cdn.goentri.com/entri.js",+};++// https://developers.entri.com/docs/install+export type DnsRecord = {+ type: "CNAME" | "TXT";+ host: string;+ value: string;+ ttl: number;+};++// https://developers.entri.com/docs/integrate-with-dns-providers+export type EntriCloseDetail = {+ domain: string;+ lastStatus:+ | "FINISHED_SUCCESSFULLY"+ | "IN_PROGRESS"+ | "EXISTING_RECORDS"+ | "LOGIN"+ | "MANUAL_CONFIGURATION"+ | "EXIT_WITH_ERROR"+ | "DKIM_SETUP";++ provider: string;+ setupType: "automatic" | "manual" | "sharedLogin" | null;+ success: boolean;+};++declare global {+ interface Window {+ // https://developers.entri.com/docs/api-reference+ entri?: {+ showEntri: (options: {+ applicationId: string;+ token: string;+ dnsRecords: DnsRecord[];+ prefilledDomain: string;+ }) => void;+ };+ }++ // https://developers.entri.com/docs/integrate-with-dns-providers+ interface WindowEventMap {+ onEntriClose: CustomEvent<EntriCloseDetail>;+ }+}++/**+ * Our FloatingPanelPopover adds pointerEvents: "none" to the body.+ * We open the entry dialog from the popover, so we need to allow pointer events on the entri dialog.+ */+export const entriGlobalStyles = globalCss({+ body: {+ "&>#entriApp": {+ pointerEvents: "all",+ },+ },+});++type UseEntriProps = {+ domain: string;+ onClose: (detail: EntriCloseDetail) => void;+ dnsRecords: DnsRecord[];+};++export const useEntri = ({ domain, dnsRecords, onClose }: UseEntriProps) => {+ const [isScriptLoading, scriptLoadingError] = useScript(scriptAttributes);+ const [error, setError] = useState<string | undefined>(undefined);+ const [isOpen, setIsOpen] = useState(false);+ const showDialogInternalRef = useRef<+ undefined | ((token: string, applicationId: string) => void)+ >(undefined);++ const {+ load: entriTokenLoad,+ data: entriTokenData,+ error: entriTokenSystemError,+ } = trpc.getEntriToken.useQuery();++ useEffect(() => {+ const handleOnEntriClose = (event: CustomEvent<EntriCloseDetail>) => {+ if (event.detail.domain !== domain) {+ return;+ }++ onClose(event.detail);+ setIsOpen(false);+ };++ window.addEventListener("onEntriClose", handleOnEntriClose, false);++ return () => {+ window.removeEventListener("onEntriClose", handleOnEntriClose);+ };+ }, [domain, onClose]);++ const showDialogInternal = useCallback(+ (token: string, applicationId: string) => {+ const entri = window.entri;++ if (entri === undefined) {+ if (isScriptLoading) {+ setError("Entri is not loaded, try again later");+ return;+ }++ setError("Entri is not loaded");+ return;+ }++ entri.showEntri({+ applicationId,+ token,+ dnsRecords,+ prefilledDomain: domain,+ });+ },+ [dnsRecords, domain, isScriptLoading]+ );++ showDialogInternalRef.current = showDialogInternal;++ const showDialog = useCallback(() => {+ setIsOpen(true);+ entriTokenLoad(undefined, (data) => {+ if (data.success === false) {+ return;+ }++ if (showDialogInternalRef.current === undefined) {+ return;+ }++ const { token, applicationId } = data;++ showDialogInternalRef.current(token, applicationId);+ });+ }, [entriTokenLoad]);++ return {+ isOpen,+ showDialog,+ error:+ error ??+ entriTokenSystemError ??+ scriptLoadingError?.message ??+ (entriTokenData?.success === false ? entriTokenData.error : undefined),+ };+};diff --git a/apps/builder/app/shared/remix/trpc-remix-proxy.ts b/apps/builder/app/shared/remix/trpc-remix-proxy.tsindex adf721cda2..d9e6eafb5b 100644--- a/apps/builder/app/shared/remix/trpc-remix-proxy.ts+++ b/apps/builder/app/shared/remix/trpc-remix-proxy.ts@@ -119,7 +119,7 @@ export const createTrpcFetchProxy = <Router extends AnyRouter>(headers: {"Content-Type": "application/json",},- body: JSON.stringify(input),+ body: JSON.stringify(input ?? null),});// Newer request has been made, ignore this onediff --git a/apps/builder/package.json b/apps/builder/package.jsonindex 99bb5828ed..9518098c0e 100644--- a/apps/builder/package.json+++ b/apps/builder/package.json@@ -80,6 +80,7 @@"react-color": "^2.19.3","react-dom": "^18.2.0","react-hotkeys-hook": "^4.3.5",+ "react-script-hook": "^1.7.2","react-use": "^17.3.2","remix-auth": "^3.2.2","remix-auth-form": "^1.1.2",diff --git a/packages/domain/src/trpc/domain.ts b/packages/domain/src/trpc/domain.tsindex beb8640c88..9befeef737 100644--- a/packages/domain/src/trpc/domain.ts+++ b/packages/domain/src/trpc/domain.ts@@ -8,6 +8,23 @@ import { createProductionBuild } from "@webstudio-is/project-build/index.server"const { router, procedure } = initTRPC.context<AppContext>().create();export const domainRouter = router({+ getEntriToken: procedure.query(async ({ ctx }) => {+ try {+ const result = await ctx.entri.entryApi.getEntriToken();++ return {+ success: true,+ token: result.token,+ applicationId: result.applicationId,+ } as const;+ } catch (error) {+ return {+ success: false,+ error: error instanceof Error ? error.message : "Unknown error",+ } as const;+ }+ }),+project: procedure.input(z.object({ projectId: z.string() })).query(async ({ input, ctx }) => {diff --git a/packages/trpc-interface/src/context/context.server.ts b/packages/trpc-interface/src/context/context.server.tsindex aa9f327397..02cc5d13fd 100644--- a/packages/trpc-interface/src/context/context.server.ts+++ b/packages/trpc-interface/src/context/context.server.ts@@ -27,6 +27,16 @@ type DomainContext = {domainTrpc: TrpcInterfaceClient["domain"];};+// https://developers.entri.com/docs/install+type EntriContext = {+ entryApi: {+ getEntriToken: () => Promise<{+ token: string;+ applicationId: string;+ }>;+ };+};+type DeploymentContext = {deploymentTrpc: TrpcInterfaceClient["deployment"];env: {@@ -44,4 +54,5 @@ export type AppContext = {authorization: AuthorizationContext;domain: DomainContext;deployment: DeploymentContext;+ entri: EntriContext;};diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex d9de77279c..7441a5eb25 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -236,6 +236,9 @@ importers:react-hotkeys-hook:specifier: ^4.3.5version: 4.3.5([email protected])([email protected])+ react-script-hook:+ specifier: ^1.7.2+ version: 1.7.2([email protected])([email protected])react-use:specifier: ^17.3.2version: 17.4.0([email protected])([email protected])@@ -17334,6 +17337,16 @@ packages:'@remix-run/router': 1.5.0react: 18.2.0+ resolution: {integrity: sha512-fhyCEfXb94fag34UPRF0zry1XGwmVY+79iibWwTqAoOiCzYJQOYTiWJ7CnqglA9tMSV8g45cQpHCMcBwr7dwhA==}+ peerDependencies:+ react: ^16.8.6 || 17 - 18+ react-dom: ^16.8.6 || 17 - 18+ dependencies:+ react: 18.2.0+ react-dom: 18.2.0([email protected])+ dev: false+resolution: {integrity: sha512-oScf2FqQ9LFVQgA73vr86xl2NaOIX73rh+YFqcOp68CWj56tSfgtGKrEbyhCj0rSijyG9M1CYprTh39fBi5hzA==}peerDependencies: