@webstudio-is/image 0.191.0 → 0.191.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webstudio-is/image",
-  "version": "0.191.0",
+  "version": "0.191.4",
   "description": "Image optimization",
   "author": "Webstudio <github@webstudio.is>",
   "homepage": "https://webstudio.is",

package/lib/index.js

@@ -1,220 +0,0 @@
-// src/image.tsx
-import { forwardRef } from "react";
-
-// src/image-optimize.ts
-var imageSizes = [16, 32, 48, 64, 96, 128, 256, 384];
-var deviceSizes = [640, 750, 828, 1080, 1200, 1920, 2048, 3840];
-var allSizes = [...imageSizes, ...deviceSizes];
-var getWidths = (width, sizes) => {
-  if (sizes) {
-    const viewportWidthRe = /(^|\s)(1?\d?\d)vw/g;
-    const percentSizes = [];
-    for (let match; match = viewportWidthRe.exec(sizes); match) {
-      percentSizes.push(Number.parseInt(match[2], 10));
-    }
-    if (percentSizes.length) {
-      const smallestRatio = Math.min(...percentSizes) * 0.01;
-      return {
-        widths: allSizes.filter(
-          (size) => size >= deviceSizes[0] * smallestRatio
-        ),
-        kind: "w"
-      };
-    }
-    return { widths: allSizes, kind: "w" };
-  }
-  if (width == null) {
-    return { widths: deviceSizes, kind: "w" };
-  }
-  const MAX_DEVICE_PIXEL_RATIO = 2;
-  let index = allSizes.findIndex(
-    (size) => size >= MAX_DEVICE_PIXEL_RATIO * width
-  );
-  index = index < 0 ? allSizes.length : index;
-  return {
-    widths: allSizes.slice(0, index + 1),
-    kind: "w"
-  };
-};
-var generateImgAttrs = ({
-  src,
-  width,
-  quality,
-  sizes,
-  loader
-}) => {
-  const { widths, kind } = getWidths(width, sizes);
-  return {
-    sizes: !sizes && kind === "w" ? "100vw" : sizes,
-    srcSet: widths.map(
-      (w, i) => `${loader({ src, quality, width: w })} ${kind === "w" ? w : i + 1}${kind}`
-    ).join(", "),
-    // Must be last, to prevent Safari to load images twice
-    src: loader({
-      src,
-      quality,
-      width: widths[widths.length - 1]
-    })
-  };
-};
-var getInt = (value) => {
-  if (typeof value === "number") {
-    return Math.round(value);
-  }
-  if (typeof value === "string") {
-    const vNum = Number.parseFloat(value);
-    if (!Number.isNaN(vNum)) {
-      return Math.round(vNum);
-    }
-  }
-  return void 0;
-};
-var DEFAULT_SIZES = "(min-width: 1280px) 50vw, 100vw";
-var DEFAULT_QUALITY = 80;
-var UrlCanParse = (url) => {
-  try {
-    new URL(url);
-    return true;
-  } catch {
-    return false;
-  }
-};
-var getImageAttributes = (props) => {
-  const width = getInt(props.width);
-  const quality = Math.max(
-    Math.min(getInt(props.quality) ?? DEFAULT_QUALITY, 100),
-    0
-  );
-  if (props.src != null && props.src !== "") {
-    if (props.srcSet == null && props.optimize) {
-      const sizes = props.sizes ?? (props.width == null ? DEFAULT_SIZES : void 0);
-      return generateImgAttrs({
-        src: props.src,
-        width,
-        quality,
-        sizes,
-        loader: props.loader
-      });
-    }
-    const resAttrs = {
-      src: UrlCanParse(props.src) ? props.src : props.loader({ src: props.src, format: "raw" })
-    };
-    if (props.srcSet != null) {
-      resAttrs.srcSet = props.srcSet;
-    }
-    if (props.sizes != null) {
-      resAttrs.sizes = props.sizes;
-    }
-    return resAttrs;
-  }
-};
-
-// src/image.tsx
-import { jsx } from "react/jsx-runtime";
-var Image = forwardRef(
-  ({
-    quality,
-    loader,
-    optimize = true,
-    loading = "lazy",
-    decoding = "async",
-    ...imageProps
-  }, ref) => {
-    const imageAttributes = getImageAttributes({
-      src: imageProps.src,
-      srcSet: imageProps.srcSet,
-      sizes: imageProps.sizes,
-      width: imageProps.width,
-      quality,
-      loader,
-      optimize
-    }) ?? { src: imagePlaceholderDataUrl };
-    return /* @__PURE__ */ jsx(
-      "img",
-      {
-        alt: "",
-        ...imageProps,
-        ...imageAttributes,
-        decoding,
-        loading,
-        ref
-      }
-    );
-  }
-);
-Image.displayName = "Image";
-var imagePlaceholderDataUrl = `data:image/svg+xml;base64,${btoa(`<svg
-  width="140"
-  height="140"
-  viewBox="0 0 600 600"
-  fill="none"
-  xmlns="http://www.w3.org/2000/svg"
-  >
-  <rect width="600" height="600" fill="#DFE3E6" />
-  <path
-    fill-rule="evenodd"
-    clip-rule="evenodd"
-    d="M450 170H150C141.716 170 135 176.716 135 185V415C135 423.284 141.716 430 150 430H450C458.284 430 465 423.284 465 415V185C465 176.716 458.284 170 450 170ZM150 145C127.909 145 110 162.909 110 185V415C110 437.091 127.909 455 150 455H450C472.091 455 490 437.091 490 415V185C490 162.909 472.091 145 450 145H150Z"
-    fill="#C1C8CD"
-  />
-  <path
-    d="M237.135 235.012C237.135 255.723 220.345 272.512 199.635 272.512C178.924 272.512 162.135 255.723 162.135 235.012C162.135 214.301 178.924 197.512 199.635 197.512C220.345 197.512 237.135 214.301 237.135 235.012Z"
-    fill="#C1C8CD"
-  />
-  <path
-    d="M160 405V367.205L221.609 306.364L256.552 338.628L358.161 234L440 316.043V405H160Z"
-    fill="#C1C8CD"
-  />
-</svg>`)}`;
-
-// src/image-loaders.ts
-import warnOnce from "warn-once";
-var NON_EXISTING_DOMAIN = "https://a3cbcbec-cdb1-4ea4-ad60-43c795308ddc.ddc";
-var joinPath = (...segments) => {
-  return segments.filter((segment) => segment !== "").map((segment) => segment.replace(/(^\/+|\/+$)/g, "")).join("/");
-};
-var encodePathFragment = (fragment) => {
-  return encodeURIComponent(fragment).replace(/%2F/g, "/");
-};
-var createImageLoader = (loaderOptions) => (props) => {
-  const width = props.format === "raw" ? 16 : props.width;
-  const quality = props.format === "raw" ? 100 : props.quality;
-  const { format, src } = props;
-  if (true) {
-    warnOnce(
-      allSizes.includes(width) === false,
-      "Width must be only from allowed values"
-    );
-  }
-  const { imageBaseUrl } = loaderOptions;
-  let resultUrl;
-  try {
-    resultUrl = new URL(imageBaseUrl, NON_EXISTING_DOMAIN);
-  } catch {
-    return src;
-  }
-  if (format !== "raw") {
-    resultUrl.searchParams.set("width", width.toString());
-    resultUrl.searchParams.set("quality", quality.toString());
-    if (props.height != null) {
-      resultUrl.searchParams.set("height", props.height.toString());
-    }
-    if (props.fit != null) {
-      resultUrl.searchParams.set("fit", props.fit);
-    }
-  }
-  resultUrl.searchParams.set("format", format ?? "auto");
-  resultUrl.pathname = joinPath(resultUrl.pathname, encodePathFragment(src));
-  if (resultUrl.href.startsWith(NON_EXISTING_DOMAIN)) {
-    return `${resultUrl.pathname}?${resultUrl.searchParams.toString()}`;
-  }
-  return resultUrl.href;
-};
-export {
-  Image,
-  UrlCanParse,
-  allSizes,
-  createImageLoader,
-  getImageAttributes,
-  imagePlaceholderDataUrl
-};

package/lib/types/image-loader.test.d.ts

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

package/lib/types/image-loaders.d.ts

@@ -1,9 +0,0 @@
-import { type ImageLoader } from "./image-optimize";
-export type ImageLoaderOptions = {
-    imageBaseUrl: string;
-};
-/**
- * Default image loader in case of no loader provided
- * https://developers.cloudflare.com/images/image-resizing/url-format/
- **/
-export declare const createImageLoader: (loaderOptions: ImageLoaderOptions) => ImageLoader;

package/lib/types/image-optimize.d.ts

@@ -1,115 +0,0 @@
-/**
- * # Responsive Image component helpers.
- *
- * ## Quick summary about img srcset and sizes attributes:
- *
- * There are 2 ways to define what image will be loaded in the img property srcset.
- *
- * 1. via pixel density descriptor 'x', like `srcset="photo-small.jpg 1x, photo-medium.jpg 1.5x, photo-huge.jpg 2x"`
- *   src will be selected depending on `device-pixel-ratio`.
- *
- * 2. via viewport width descriptor 'w' and sizes property containing source size descriptors, like
- *   `srcset="photo-small.jpg 320w, photo-medium.jpg 640w, photo-huge.jpg 1280w"`
- *   `sizes="(max-width: 600px) 400px, (max-width: 1200px) 70vw, 50vw"`
- *
- *   The browser finds the first matching media query from source size descriptors,
- *   then use source size value to generate internally srcset
- *   with pixel density descriptors dividing width descriptor value by source size value.
- *
- *   Using the example above for viewport width 800px.
- *   The first matching media query is (max-width: 1200px)
- *   source size value is 70vw  equal to 800px * 0,7 = 560px
- *
- *   browser internal srcset will be (we divide `w` descriptor by source size value):
- *   photo-small.jpg 320w/560px, photo-medium.jpg 640w/560px, photo-huge.jpg 1280w/560px =>
- *   photo-small.jpg 0.57x, photo-medium.jpg 1.14x, photo-huge.jpg 2.28x
- *
- *   Finally same rules as for pixel density descriptor 'x' are applied.
- *
- * ## Algorithm (without optimizations):
- *
- * We have a predefined array of all supported image sizes allSizes, this is the real width of an image in pixels.
- * This is good for caching, as we can cache image with specific width and then use it for different devices.
- *
- * > allSizes array is a tradeoff between cache and the best possible image size you deliver to the user.
- * > If allSizes.length is too small, you will deliver too big images to the user,
- * > if allSizes.length is too big, you will have many caches misses.
- *
- * If img has a defined width property.
- *   1. filter allSizes to exclude loading images higher that maxDevicePixelRatio * img.width
- *
- *
- * If img has no defined width property.
- *   1. Generate srcset = allSizes.map((w) => `${getImageSrcAtWidth(w)} ${w}w`)
- *   2. Use sizes property, or if it is not defined use opinionated DEFAULT_SIZES = "(min-width: 1280px) 50vw, 100vw";
- *
- * Optimizations applied now:
- *
- * - If the sizes property is defined, we can exclude from `srcsets` all images
- *   which are smaller than the `smallestRatio * smallesDeviceSize`
- *
- * Future (not implemented) optimizations and improvements:
- *
- * - Knowing image size on different viewport widths we can provide nondefault sizes property
- * - Knowledge of Image aspect-ratio would allow cropping images serverside.
- * - Early hints for high priority images https://blog.cloudflare.com/early-hints/
- * - Slow networks optimizations
- * - 404 etc processing with CSS - https://bitsofco.de/styling-broken-images/ (has some opinionated issues) or js solution with custom user fallback.
- *
- * # Attributions
- *
- * The MIT License (MIT)
- *
- * applies to:
- *
- * - https://github.com/vercel/next.js, Copyright (c) 2022 Vercel, Inc.
- *
- * The MIT License (MIT)
- *
- * Copyright (c) 2022 Vercel, Inc.
- *
- * 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.
- **/
-export type ImageLoader = (props: {
-    width: number;
-    quality: number;
-    src: string;
-    format?: "auto";
-    height?: number;
-    fit?: "pad";
-} | {
-    src: string;
-    format: "raw";
-}) => string;
-export declare const allSizes: number[];
-/**
- * URL.canParse(props.src)
- */
-export declare const UrlCanParse: (url: string) => boolean;
-export declare const getImageAttributes: (props: {
-    src: string | undefined;
-    srcSet: string | undefined;
-    sizes: string | undefined;
-    width: string | number | undefined;
-    quality: string | number | undefined;
-    loader: ImageLoader;
-    optimize: boolean;
-}) => {
-    src: string;
-    srcSet?: string;
-    sizes?: string;
-} | undefined;

package/lib/types/image-optimize.test.d.ts

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

package/lib/types/image.d.ts

@@ -1,11 +0,0 @@
-import { type ComponentProps } from "react";
-import { type ImageLoader } from "./image-optimize";
-declare const defaultTag = "img";
-type ImageProps = ComponentProps<typeof defaultTag> & {
-    quality?: number;
-    optimize?: boolean;
-    loader: ImageLoader;
-};
-export declare const Image: import("react").ForwardRefExoticComponent<Omit<ImageProps, "ref"> & import("react").RefAttributes<HTMLImageElement>>;
-export declare const imagePlaceholderDataUrl: string;
-export {};

package/lib/types/index.d.ts

@@ -1,4 +0,0 @@
-export { Image, imagePlaceholderDataUrl } from "./image";
-export type { ImageLoader } from "./image-optimize";
-export * from "./image-loaders";
-export * from "./image-optimize";