@webstudio-is/react-sdk 0.7.0 → 0.7.2

package/lib/components/heading.stories.d.ts

@@ -1,10 +1,10 @@
-import React from "react";
+/// <reference types="react" />
 import type { ComponentStory, ComponentMeta } from "@storybook/react";
-declare const _default: ComponentMeta<React.ForwardRefExoticComponent<Pick<React.ClassAttributes<HTMLHeadingElement> & React.HTMLAttributes<HTMLHeadingElement> & {
+declare const _default: ComponentMeta<import("react").ForwardRefExoticComponent<Pick<import("react").ClassAttributes<HTMLHeadingElement> & import("react").HTMLAttributes<HTMLHeadingElement> & {
     tag?: "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | undefined;
-}, "key" | "tag" | keyof React.HTMLAttributes<HTMLHeadingElement>> & React.RefAttributes<HTMLHeadingElement>>>;
+}, "key" | "tag" | keyof import("react").HTMLAttributes<HTMLHeadingElement>> & import("react").RefAttributes<HTMLHeadingElement>>>;
 export default _default;
-export declare const Heading: ComponentStory<React.ForwardRefExoticComponent<Pick<React.ClassAttributes<HTMLHeadingElement> & React.HTMLAttributes<HTMLHeadingElement> & {
+export declare const Heading: ComponentStory<import("react").ForwardRefExoticComponent<Pick<import("react").ClassAttributes<HTMLHeadingElement> & import("react").HTMLAttributes<HTMLHeadingElement> & {
     tag?: "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | undefined;
-}, "key" | "tag" | keyof React.HTMLAttributes<HTMLHeadingElement>> & React.RefAttributes<HTMLHeadingElement>>>;
+}, "key" | "tag" | keyof import("react").HTMLAttributes<HTMLHeadingElement>> & import("react").RefAttributes<HTMLHeadingElement>>>;
 //# sourceMappingURL=heading.stories.d.ts.map

package/lib/components/heading.stories.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"heading.stories.d.ts","sourceRoot":"","sources":["../../src/components/heading.stories.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;;;;AAItE,wBAI4C;AAM5C,eAAO,MAAM,OAAO;;8GAAoB,CAAC"}
+{"version":3,"file":"heading.stories.d.ts","sourceRoot":"","sources":["../../src/components/heading.stories.tsx"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;;;;AAGtE,wBAG4C;AAM5C,eAAO,MAAM,OAAO;;kIAAoB,CAAC"}

package/lib/components/heading.stories.js

@@ -1,16 +1,11 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Heading = void 0;
 const jsx_runtime_1 = require("react/jsx-runtime");
 const heading_1 = require("./heading");
-const heading_props_json_1 = __importDefault(require("./heading.props.json"));
 exports.default = {
     title: "Components/Heading",
     component: heading_1.Heading,
-    argTypes: heading_props_json_1.default,
 };
 const Template = (args) => ((0, jsx_runtime_1.jsx)(heading_1.Heading, { ...args }));
 exports.Heading = Template.bind({});

package/lib/components/image-dev.stories.d.ts

@@ -0,0 +1,36 @@
+import React from "react";
+import type { ComponentMeta, ComponentStory } from "@storybook/react";
+import { type ImageLoader } from "../component-utils/image";
+declare const _default: ComponentMeta<React.ForwardRefExoticComponent<Pick<React.ClassAttributes<HTMLImageElement> & React.ImgHTMLAttributes<HTMLImageElement> & {
+    quality?: number | undefined;
+    loader?: ImageLoader | undefined;
+    optimize?: boolean | undefined;
+}, "key" | "quality" | "loader" | keyof React.ImgHTMLAttributes<HTMLImageElement> | "optimize"> & React.RefAttributes<HTMLImageElement>>>;
+export default _default;
+/**
+ * Load images depending on image width and device per pixel ratio.
+ **/
+export declare const FixedWidthImage: ComponentStory<React.FunctionComponent>;
+/**
+ * Preserve ratio using object-fit: cover. Load images depending on image width and device per pixel ratio.
+ **/
+export declare const FixedWidthImageCover: ComponentStory<React.FunctionComponent>;
+/**
+ * Load images depending on the viewport width.
+ **/
+export declare const UnknownWidthImage: ComponentStory<React.FunctionComponent>;
+/**
+ * Fit width of the parent container, has own aspect-ratio and object-fit=cover.
+ * Load images depending on the viewport width.
+ **/
+export declare const AspectRatioImage: ComponentStory<React.FunctionComponent>;
+/**
+ * Fill width and height of the relative parent container, object-fit=cover. Load images depending on the viewport width.
+ **/
+export declare const FillParentImage: ComponentStory<React.FunctionComponent>;
+/**
+ * "sizes" attribute explicitly equal to 100vw allowing to skip the default behavior.
+ * See DEFAULT_SIZES in the Image component. Load images depending on the viewport width.
+ **/
+export declare const HeroImage: ComponentStory<React.FunctionComponent>;
+//# sourceMappingURL=image-dev.stories.d.ts.map

package/lib/components/image-dev.stories.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-dev.stories.d.ts","sourceRoot":"","sources":["../../src/components/image-dev.stories.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAmD,MAAM,OAAO,CAAC;AACxE,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAItE,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,0BAA0B,CAAC;;;;;;AAO5D,wBAE0C;AAgF1C;;IAEI;AACJ,eAAO,MAAM,eAAe,EAAE,cAAc,CAAC,KAAK,CAAC,iBAAiB,CAEnE,CAAC;AAEF;;IAEI;AACJ,eAAO,MAAM,oBAAoB,EAAE,cAAc,CAC/C,KAAK,CAAC,iBAAiB,CAQxB,CAAC;AAEF;;IAEI;AACJ,eAAO,MAAM,iBAAiB,EAAE,cAAc,CAC5C,KAAK,CAAC,iBAAiB,CACa,CAAC;AAEvC;;;IAGI;AACJ,eAAO,MAAM,gBAAgB,EAAE,cAAc,CAAC,KAAK,CAAC,iBAAiB,CAOpE,CAAC;AAEF;;IAEI;AACJ,eAAO,MAAM,eAAe,EAAE,cAAc,CAAC,KAAK,CAAC,iBAAiB,CAYnE,CAAC;AAEF;;;IAGI;AACJ,eAAO,MAAM,SAAS,EAAE,cAAc,CAAC,KAAK,CAAC,iBAAiB,CAU7D,CAAC"}

package/lib/components/image-dev.stories.js

@@ -0,0 +1,102 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HeroImage = exports.FillParentImage = exports.AspectRatioImage = exports.UnknownWidthImage = exports.FixedWidthImageCover = exports.FixedWidthImage = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const warn_once_1 = __importDefault(require("warn-once"));
+const image_1 = require("./image");
+const image_ws_1 = __importDefault(require("./image.ws"));
+// to not allow include local assets everywhere, just enable it for this file
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+const logo_webp_1 = __importDefault(require("../../storybook-assets/logo.webp"));
+exports.default = {
+    title: "Components/ImageDev",
+};
+/**
+ * In case you need to test img with real cloudflare trasforms
+ * set  USE_CLOUDFLARE_IMAGE_TRANSFORM = true
+ **/
+const USE_CLOUDFLARE_IMAGE_TRANSFORM = false;
+// For cloudflare image transform testing, logo should be the most consistent image on the site
+const REMOTE_SELF_DOMAIN_IMAGE = "https://webstudio.is/logo.webp";
+const imageSrc = USE_CLOUDFLARE_IMAGE_TRANSFORM
+    ? REMOTE_SELF_DOMAIN_IMAGE
+    : logo_webp_1.default;
+// In case of REMOTE_DEBUG
+const cloudflareImageLoader = ({ width, src, quality }) => {
+    // No image transformation in development
+    const resizeOrigin = "https://webstudio.is";
+    const pathParams = [
+        `width=${width}`,
+        quality != null && `quality=${quality}`,
+        "format=auto",
+    ].filter(Boolean);
+    const pathname = `/cdn-cgi/image/${pathParams.join(",")}/${src}`;
+    const url = new URL(pathname, resizeOrigin);
+    return url.href;
+};
+const localImageLoader = ({ width, src, quality }) => {
+    // Just emulate like we really resize the image
+    const params = new URLSearchParams();
+    params.set("width", `${width}`);
+    params.set("quality", `${quality}`);
+    return `${src}?${params.toString()}`;
+};
+const imageLoader = USE_CLOUDFLARE_IMAGE_TRANSFORM
+    ? cloudflareImageLoader
+    : localImageLoader;
+const ImageBase = (args) => {
+    (0, warn_once_1.default)(!(image_ws_1.default.defaultStyle?.maxWidth?.value === 100 &&
+        image_ws_1.default.defaultStyle?.maxWidth?.unit === "%"), "We expect that the image default style has maxWidth: 100%");
+    (0, warn_once_1.default)(image_ws_1.default.defaultStyle?.display?.value !== "block", "We expect that the image default style has display: block");
+    const style = {
+        maxWidth: "100%",
+        display: "block",
+        ...args.style,
+    };
+    return ((0, jsx_runtime_1.jsx)(image_1.Image, { ...args, optimize: true, loader: imageLoader, style: style }));
+};
+/**
+ * Load images depending on image width and device per pixel ratio.
+ **/
+const FixedWidthImage = () => ((0, jsx_runtime_1.jsx)(ImageBase, { src: imageSrc, width: "300", height: "400" }));
+exports.FixedWidthImage = FixedWidthImage;
+/**
+ * Preserve ratio using object-fit: cover. Load images depending on image width and device per pixel ratio.
+ **/
+const FixedWidthImageCover = () => ((0, jsx_runtime_1.jsx)(ImageBase, { src: imageSrc, width: "300", height: "400", style: { objectFit: "cover" } }));
+exports.FixedWidthImageCover = FixedWidthImageCover;
+/**
+ * Load images depending on the viewport width.
+ **/
+const UnknownWidthImage = () => (0, jsx_runtime_1.jsx)(ImageBase, { src: imageSrc });
+exports.UnknownWidthImage = UnknownWidthImage;
+/**
+ * Fit width of the parent container, has own aspect-ratio and object-fit=cover.
+ * Load images depending on the viewport width.
+ **/
+const AspectRatioImage = () => ((0, jsx_runtime_1.jsx)("div", { style: { width: "50%" }, children: (0, jsx_runtime_1.jsx)(ImageBase, { src: imageSrc, style: { aspectRatio: "2/1", objectFit: "cover", width: "100%" } }) }));
+exports.AspectRatioImage = AspectRatioImage;
+/**
+ * Fill width and height of the relative parent container, object-fit=cover. Load images depending on the viewport width.
+ **/
+const FillParentImage = () => ((0, jsx_runtime_1.jsx)("div", { style: { width: "50%", aspectRatio: "2/1", position: "relative" }, children: (0, jsx_runtime_1.jsx)(ImageBase, { src: imageSrc, style: {
+            objectFit: "cover",
+            position: "absolute",
+            width: "100%",
+            height: "100%",
+        } }) }));
+exports.FillParentImage = FillParentImage;
+/**
+ * "sizes" attribute explicitly equal to 100vw allowing to skip the default behavior.
+ * See DEFAULT_SIZES in the Image component. Load images depending on the viewport width.
+ **/
+const HeroImage = () => ((0, jsx_runtime_1.jsx)(ImageBase, { src: imageSrc, sizes: "100vw", style: {
+        aspectRatio: "3/1",
+        objectFit: "cover",
+        width: "100%",
+    } }));
+exports.HeroImage = HeroImage;

package/lib/components/image.d.ts

@@ -1,3 +1,11 @@
-import React from "react";
-export declare const Image: React.ForwardRefExoticComponent<Pick<React.DetailedHTMLProps<React.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>, "key" | keyof React.ImgHTMLAttributes<HTMLImageElement>> & React.RefAttributes<HTMLImageElement>>;
+import { type ComponentProps } from "react";
+import { type ImageLoader } from "../component-utils/image";
+declare const defaultTag = "img";
+declare type ImageProps = ComponentProps<typeof defaultTag> & {
+    quality?: number;
+    loader?: ImageLoader;
+    optimize?: boolean;
+};
+export declare const Image: import("react").ForwardRefExoticComponent<Pick<ImageProps, "key" | "quality" | "loader" | keyof import("react").ImgHTMLAttributes<HTMLImageElement> | "optimize"> & import("react").RefAttributes<HTMLImageElement>>;
+export {};
 //# sourceMappingURL=image.d.ts.map

package/lib/components/image.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../src/components/image.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA2D,MAAM,OAAO,CAAC;AAMhF,eAAO,MAAM,KAAK,8NAEjB,CAAC"}
+{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../src/components/image.tsx"],"names":[],"mappings":"AAAA,OAAO,EAA+B,KAAK,cAAc,EAAE,MAAM,OAAO,CAAC;AACzE,OAAO,EAAsB,KAAK,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEhF,QAAA,MAAM,UAAU,QAAQ,CAAC;AAEzB,aAAK,UAAU,GAAG,cAAc,CAAC,OAAO,UAAU,CAAC,GAAG;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,eAAO,MAAM,KAAK,sNAmBjB,CAAC"}

package/lib/components/image.js

@@ -3,17 +3,31 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Image = void 0;
 const jsx_runtime_1 = require("react/jsx-runtime");
 const react_1 = require("react");
+const image_1 = require("../component-utils/image");
 const defaultTag = "img";
-exports.Image = (0, react_1.forwardRef)((props, ref) => (0, jsx_runtime_1.jsx)("img", { ...props, ref: ref }));
+exports.Image = (0, react_1.forwardRef)(({ quality, loader, optimize, ...imageProps }, ref) => {
+    // Temporary set to false, to support previous image behaviour
+    const DEFAULT_OPTIMIZE = false;
+    const imageAttributes = (0, image_1.getImageAttributes)({
+        src: imageProps.src,
+        srcSet: imageProps.srcSet,
+        sizes: imageProps.sizes,
+        width: imageProps.width,
+        quality,
+        loader,
+        optimize: optimize ?? DEFAULT_OPTIMIZE,
+    }) ?? { src: imagePlaceholderSvg };
+    return ((0, jsx_runtime_1.jsx)("img", { ...imageProps, ...imageAttributes, decoding: "async", ref: ref }));
+});
 exports.Image.defaultProps = {
     src: "",
+    width: "",
+    height: "",
     loading: "lazy",
-    width: "auto",
-    height: "auto",
     alt: "",
 };
 exports.Image.displayName = "Image";
-const imagePlaceholderSvg = `<svg
+const imagePlaceholderSvg = `data:image/svg+xml;base64,${btoa(`<svg
   width="140"
   height="140"
   viewBox="0 0 600 600"
@@ -35,8 +49,4 @@ const imagePlaceholderSvg = `<svg
     d="M160 405V367.205L221.609 306.364L256.552 338.628L358.161 234L440 316.043V405H160Z"
     fill="#A2A2A2"
   />
-</svg>`;
-// Defining src here prevents analyzer from putting the image into the UI.
-// @todo it would be better to have the image hosted like a normal image,
-// the problem is inside sdk bundler doesn't know how to do that.
-exports.Image.defaultProps.src = `data:image/svg+xml;base64,${btoa(imagePlaceholderSvg)}`;
+</svg>`)}`;