@webstudio-is/react-sdk 0.0.0-017f1bd

package/lib/runtime.js

@@ -0,0 +1,221 @@
+// src/context.tsx
+import { createContext, useContext, useMemo } from "react";
+import {
+  createJsonStringifyProxy,
+  isPlainObject
+} from "@webstudio-is/sdk/runtime";
+var ReactSdkContext = createContext({
+  assetBaseUrl: "/",
+  imageLoader: ({ src }) => src,
+  videoLoader: ({ src }) => src,
+  resources: {},
+  breakpoints: [],
+  onError: (error) => {
+    console.error(error);
+  }
+});
+var useResource = (name) => {
+  const { resources } = useContext(ReactSdkContext);
+  const resource = resources[name];
+  const resourceMemozied = useMemo(
+    () => isPlainObject(resource) ? createJsonStringifyProxy(resource) : resource,
+    [resource]
+  );
+  return resourceMemozied;
+};
+
+// src/hook.ts
+var getClosestInstance = (instancePath, currentInstance, closestComponent) => {
+  let matched = false;
+  for (const instance of instancePath) {
+    if (currentInstance === instance) {
+      matched = true;
+    }
+    if (matched && instance.component === closestComponent) {
+      return instance;
+    }
+  }
+};
+
+// src/variable-state.tsx
+import { useState, useMemo as useMemo2 } from "react";
+import {
+  createJsonStringifyProxy as createJsonStringifyProxy2,
+  isPlainObject as isPlainObject2
+} from "@webstudio-is/sdk/runtime";
+var useVariableState = (initialState) => {
+  const [state, setState] = useState(initialState);
+  const value = useMemo2(
+    () => isPlainObject2(state) ? createJsonStringifyProxy2(state) : state,
+    [state]
+  );
+  return [value, setState];
+};
+
+// src/page-settings-meta.tsx
+import { useEffect, useState as useState2 } from "react";
+import { jsx } from "react/jsx-runtime";
+var isElementRenderedWithReact = (element) => {
+  return Object.keys(element).some((key) => key.startsWith("__react"));
+};
+var isServer = typeof window === "undefined";
+var Meta = (props) => {
+  const [localProps, setLocalProps] = useState2();
+  useEffect(() => {
+    const selector = `meta[${props.name ? `name="${props.name}"` : `property="${props.property}"`}]`;
+    let allMetas = document.querySelectorAll(selector);
+    for (const meta of allMetas) {
+      if (!isElementRenderedWithReact(meta)) {
+        meta.remove();
+      }
+    }
+    allMetas = document.querySelectorAll(selector);
+    if (allMetas.length === 0) {
+      setLocalProps(props);
+    }
+  }, [props]);
+  if (isServer) {
+    return /* @__PURE__ */ jsx("meta", { ...props });
+  }
+  if (localProps === void 0) {
+    return;
+  }
+  return /* @__PURE__ */ jsx("meta", { ...localProps });
+};
+var PageSettingsMeta = ({
+  url,
+  host,
+  siteName,
+  pageMeta,
+  imageLoader,
+  assetBaseUrl
+}) => {
+  const metas = [];
+  if (url !== void 0) {
+    metas.push({
+      property: "og:url",
+      content: url
+    });
+  }
+  if (pageMeta.title) {
+    metas.push({
+      property: "og:title",
+      content: pageMeta.title
+    });
+  }
+  metas.push({ property: "og:type", content: "website" });
+  if (siteName) {
+    metas.push({
+      property: "og:site_name",
+      content: siteName
+    });
+  }
+  if (pageMeta.excludePageFromSearch) {
+    metas.push({
+      name: "robots",
+      content: "noindex, nofollow"
+    });
+  }
+  if (pageMeta.description) {
+    metas.push({
+      name: "description",
+      content: pageMeta.description
+    });
+    metas.push({
+      property: "og:description",
+      content: pageMeta.description
+    });
+  }
+  if (pageMeta.socialImageAssetName) {
+    metas.push({
+      property: "og:image",
+      content: `https://${host}${imageLoader({
+        src: `${assetBaseUrl}${pageMeta.socialImageAssetName}`,
+        // Do not transform social image (not enough information do we need to do this)
+        format: "raw"
+      })}`
+    });
+  } else if (pageMeta.socialImageUrl) {
+    metas.push({
+      property: "og:image",
+      content: pageMeta.socialImageUrl
+    });
+  }
+  metas.push(...pageMeta.custom);
+  const isTwitterCardSizeDefined = pageMeta.custom.some(
+    (meta) => meta.property === "twitter:card"
+  );
+  if ((pageMeta.socialImageAssetName !== void 0 || pageMeta.socialImageUrl !== void 0) && isTwitterCardSizeDefined === false) {
+    metas.push({ property: "twitter:card", content: "summary_large_image" });
+  }
+  return metas.map((meta, index) => /* @__PURE__ */ jsx(Meta, { ...meta }, index));
+};
+
+// src/page-settings-title.tsx
+import { useEffect as useEffect2, useState as useState3 } from "react";
+import { jsx as jsx2 } from "react/jsx-runtime";
+var isServer2 = typeof window === "undefined";
+var PageSettingsTitle = (props) => {
+  const [localProps, setLocalProps] = useState3();
+  useEffect2(() => {
+    const selector = `head > title`;
+    let allTitles = document.querySelectorAll(selector);
+    for (const meta of allTitles) {
+      if (!isElementRenderedWithReact(meta)) {
+        meta.remove();
+      }
+    }
+    allTitles = document.querySelectorAll(selector);
+    if (allTitles.length === 0) {
+      setLocalProps(props);
+    }
+  }, [props]);
+  if (isServer2) {
+    return /* @__PURE__ */ jsx2("title", { ...props });
+  }
+  if (localProps === void 0) {
+    return;
+  }
+  return /* @__PURE__ */ jsx2("title", { ...localProps });
+};
+
+// src/page-settings-canonical-link.tsx
+import { useEffect as useEffect3, useState as useState4 } from "react";
+import { jsx as jsx3 } from "react/jsx-runtime";
+var isServer3 = typeof window === "undefined";
+var PageSettingsCanonicalLink = (props) => {
+  const [localProps, setLocalProps] = useState4();
+  useEffect3(() => {
+    const selector = `head > link[rel="canonical"]`;
+    let allLinks = document.querySelectorAll(selector);
+    for (const meta of allLinks) {
+      if (!isElementRenderedWithReact(meta)) {
+        meta.remove();
+      }
+    }
+    allLinks = document.querySelectorAll(selector);
+    if (allLinks.length === 0) {
+      setLocalProps(props);
+    }
+  }, [props]);
+  if (isServer3) {
+    return /* @__PURE__ */ jsx3("link", { rel: "canonical", ...props });
+  }
+  if (localProps === void 0) {
+    return;
+  }
+  return /* @__PURE__ */ jsx3("link", { rel: "canonical", ...localProps });
+};
+
+// src/runtime.ts
+var xmlNodeTagSuffix = "-ws-xml-node-fb77f896-8e96-40b9-b8f8-90a4e70d724a";
+export {
+  PageSettingsCanonicalLink,
+  PageSettingsMeta,
+  PageSettingsTitle,
+  ReactSdkContext,
+  getClosestInstance,
+  useResource,
+  useVariableState,
+  xmlNodeTagSuffix
+};

package/lib/types/__generated__/standard-attributes.d.ts

@@ -0,0 +1,2 @@
+export declare const standardAttributesToReactProps: Record<string, string>;
+export declare const reactPropsToStandardAttributes: Record<string, string>;

package/lib/types/component-generator.d.ts

@@ -0,0 +1,47 @@
+import type { Instances, Instance, Props, Scope, DataSources, Prop, WsComponentMeta, IndexesWithinAncestors } from "@webstudio-is/sdk";
+export declare const generateJsxElement: ({ context, scope, metas, tagsOverrides, instance, props, dataSources, usedDataSources, indexesWithinAncestors, children, classesMap, }: {
+    context?: "expression" | "jsx";
+    scope: Scope;
+    metas: Map<Instance["component"], WsComponentMeta>;
+    /**
+     * Record<tag, componentDescriptor>
+     */
+    tagsOverrides?: Record<string, string>;
+    instance: Instance;
+    props: Props;
+    dataSources: DataSources;
+    usedDataSources: DataSources;
+    indexesWithinAncestors: IndexesWithinAncestors;
+    children: string;
+    classesMap?: Map<string, Array<string>>;
+}) => string;
+export declare const generateJsxChildren: ({ scope, metas, tagsOverrides, children, instances, props, dataSources, usedDataSources, indexesWithinAncestors, classesMap, excludePlaceholders, }: {
+    scope: Scope;
+    metas: Map<Instance["component"], WsComponentMeta>;
+    tagsOverrides?: Record<string, string>;
+    children: Instance["children"];
+    instances: Instances;
+    props: Props;
+    dataSources: DataSources;
+    usedDataSources: DataSources;
+    indexesWithinAncestors: IndexesWithinAncestors;
+    classesMap?: Map<string, Array<string>>;
+    excludePlaceholders?: boolean;
+}) => string;
+export declare const generateWebstudioComponent: ({ scope, name, rootInstanceId, parameters, instances, props, dataSources, metas, tagsOverrides, classesMap, }: {
+    scope: Scope;
+    name: string;
+    rootInstanceId: Instance["id"];
+    parameters: Extract<Prop, {
+        type: "parameter";
+    }>[];
+    instances: Instances;
+    props: Props;
+    dataSources: DataSources;
+    classesMap: Map<string, Array<string>>;
+    metas: Map<Instance["component"], WsComponentMeta>;
+    /**
+     * Record<tag, componentDescriptor>
+     */
+    tagsOverrides?: Record<string, string>;
+}) => string;

package/lib/types/component-generator.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/types/components/components-utils.d.ts

@@ -0,0 +1,8 @@
+import { componentAttribute, idAttribute, selectorIdAttribute } from "../props";
+export type AnyComponent = React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & WebstudioComponentSystemProps & React.RefAttributes<HTMLElement>>;
+export type Components = Map<string, AnyComponent>;
+export type WebstudioComponentSystemProps = {
+    [componentAttribute]: string;
+    [idAttribute]: string;
+    [selectorIdAttribute]: string;
+};

package/lib/types/context.d.ts

@@ -0,0 +1,33 @@
+import type { ImageLoader, VideoLoader } from "@webstudio-is/image";
+export type Params = {
+    /**
+     * When rendering a published version, there is no renderer defined.
+     * - canvas is the builder canvas in dev mode
+     * - preview is the preview mode in builder
+     */
+    renderer?: "canvas" | "preview";
+    /**
+     * Base url or base path for any asset with ending slash.
+     * Used to load assets like fonts or images in styles
+     * Concatinated with "name".
+     *
+     * For example
+     * /s/uploads/
+     * /asset/file/
+     * https://assets-dev.webstudio.is/
+     * https://assets.webstudio.is/
+     */
+    assetBaseUrl: string;
+};
+export declare const ReactSdkContext: import("react").Context<Params & {
+    imageLoader: ImageLoader;
+    videoLoader?: VideoLoader;
+    resources: Record<string, any>;
+    breakpoints: {
+        id: string;
+        minWidth?: number;
+        maxWidth?: number;
+    }[];
+    onError: (error: unknown) => void;
+}>;
+export declare const useResource: (name: string) => any;

package/lib/types/hook.d.ts

@@ -0,0 +1,34 @@
+import type { IndexesWithinAncestors, Instance, Prop } from "@webstudio-is/sdk";
+export type InstanceData = {
+    id: Instance["id"];
+    instanceKey: string;
+    component: Instance["component"];
+    tag?: Instance["tag"];
+};
+/**
+ * Hooks are subscriptions to builder events
+ * with limited way to interact with it.
+ * Called independently from components.
+ */
+export type HookContext = {
+    indexesWithinAncestors: IndexesWithinAncestors;
+    getPropValue: (instanceData: InstanceData, propName: Prop["name"]) => unknown;
+    setMemoryProp: (instanceData: InstanceData, propName: Prop["name"], value: unknown) => void;
+};
+export type InstancePath = InstanceData[];
+type NavigatorEvent = {
+    /**
+     * List of instances from selected to the root
+     */
+    instancePath: InstancePath;
+};
+export type Hook = {
+    onNavigatorSelect?: (context: HookContext, event: NavigatorEvent) => void;
+    onNavigatorUnselect?: (context: HookContext, event: NavigatorEvent) => void;
+};
+/**
+ * Find closest matching instance by component name
+ * by lookup in instance path
+ */
+export declare const getClosestInstance: (instancePath: InstancePath, currentInstance: InstanceData, closestComponent: InstanceData["component"]) => InstanceData | undefined;
+export {};

package/lib/types/hook.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/types/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./remix";
+export * from "./components/components-utils";
+export * from "./props";
+export type * from "./context";
+export type * from "./hook";
+export { generateWebstudioComponent, generateJsxElement, generateJsxChildren, } from "./component-generator";
+export * from "./__generated__/standard-attributes";

package/lib/types/page-settings-canonical-link.d.ts

@@ -0,0 +1,17 @@
+type PageSettingsCanonicalLinkProps = {
+    href: string;
+};
+/**
+ * Link canonical tag are deduplicated on the server using the HTMLRewriter interface.
+ * This is not full deduplication. We simply skip rendering Page Setting link
+ * if it has already been rendered using HeadSlot/HeadLink.
+ * To prevent React on the client from re-adding the removed link tag, we skip rendering them client-side.
+ * This approach works because React retains server-rendered link tag as long as they are not re-rendered by the client.
+ *
+ * The following component behavior ensures this:
+ * 1. On the server: Render link tag as usual.
+ * 2. On the client: Before rendering, remove any link tag with the same `name` or `property` that were not rendered by Client React,
+ *    and then proceed with rendering as usual.
+ */
+export declare const PageSettingsCanonicalLink: (props: PageSettingsCanonicalLinkProps) => import("react/jsx-runtime").JSX.Element | undefined;
+export {};

package/lib/types/page-settings-meta.d.ts

@@ -0,0 +1,11 @@
+import type { ImageLoader } from "@webstudio-is/image";
+import type { PageMeta } from "@webstudio-is/sdk";
+export declare const isElementRenderedWithReact: (element: Element) => boolean;
+export declare const PageSettingsMeta: ({ url, host, siteName, pageMeta, imageLoader, assetBaseUrl, }: {
+    url?: string;
+    host: string;
+    siteName: string;
+    pageMeta: PageMeta;
+    imageLoader: ImageLoader;
+    assetBaseUrl: string;
+}) => import("react/jsx-runtime").JSX.Element[];

package/lib/types/page-settings-title.d.ts

@@ -0,0 +1,17 @@
+type PageSettingsTitleProps = {
+    children: string;
+};
+/**
+ * Title tags are deduplicated on the server using the HTMLRewriter interface.
+ * This is not full deduplication. We simply skip rendering Page Setting title
+ * if it has already been rendered using HeadSlot/HeadTitle.
+ * To prevent React on the client from re-adding the removed title tag, we skip rendering them client-side.
+ * This approach works because React retains server-rendered title tag as long as they are not re-rendered by the client.
+ *
+ * The following component behavior ensures this:
+ * 1. On the server: Render title tag as usual.
+ * 2. On the client: Before rendering, remove any title tag with the same `name` or `property` that were not rendered by Client React,
+ *    and then proceed with rendering as usual.
+ */
+export declare const PageSettingsTitle: (props: PageSettingsTitleProps) => import("react/jsx-runtime").JSX.Element | undefined;
+export {};