@graphcommerce/image 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,70 @@
 # Change Log
 
+## 3.1.0
+
+### Minor Changes
+
+- [#1284](https://github.com/ho-nl/m2-pwa/pull/1284)
+  [`5ffcb56bf`](https://github.com/ho-nl/m2-pwa/commit/5ffcb56bfcbe49ebeaf24f9341e819a145ab9a14)
+  Thanks [@paales](https://github.com/paales)! - SvgIcon is now more extenable and flexible:
+
+  - It will automatically calculate the stroke-width of the SVG based on the rendered size, allowing
+    for a more flexible use for icons.
+
+  - Make SvgIcon themable in your own Theme.
+
+  - Create overrides for components that will be used throughout the app.
+
+### Patch Changes
+
+- [`973ff8645`](https://github.com/ho-nl/m2-pwa/commit/973ff86452a70ade9f4db13fdda6e963d7220e96)
+  Thanks [@paales](https://github.com/paales)! - made packages public
+
+* [#1278](https://github.com/ho-nl/m2-pwa/pull/1278)
+  [`81ea406d5`](https://github.com/ho-nl/m2-pwa/commit/81ea406d54d6b5c662c030a7fea444abc4117a20)
+  Thanks [@ErwinOtten](https://github.com/ErwinOtten)! - Upgraded dependencies to the latest version
+
+* Updated dependencies
+  [[`973ff8645`](https://github.com/ho-nl/m2-pwa/commit/973ff86452a70ade9f4db13fdda6e963d7220e96)]:
+  - @graphcommerce/framer-utils@3.0.3
+
+## 3.0.2
+
+### Patch Changes
+
+- [#1276](https://github.com/ho-nl/m2-pwa/pull/1276)
+  [`ce09388e0`](https://github.com/ho-nl/m2-pwa/commit/ce09388e0d7ef33aee660612340f6fbae15ceec2)
+  Thanks [@paales](https://github.com/paales)! - We've moved lots of internal packages from
+  `dependencies` to `peerDependencies`. The result of this is that there will be significantly less
+  duplicate packages in the node_modules folders.
+
+* [#1276](https://github.com/ho-nl/m2-pwa/pull/1276)
+  [`52a45bba4`](https://github.com/ho-nl/m2-pwa/commit/52a45bba4dc6dd6df3c81f5023df7d23ed8a534d)
+  Thanks [@paales](https://github.com/paales)! - Upgraded to
+  [NextJS 12.1](https://nextjs.org/blog/next-12-1)! This is just for compatibility, but we'll be
+  implementing
+  [On-demand Incremental Static Regeneration](https://nextjs.org/blog/next-12-1#on-demand-incremental-static-regeneration-beta)
+  soon.
+
+  This will greatly reduce the requirement to rebuid stuff and we'll add a management UI on the
+  frontend to be able to revalidate pages manually.
+
+* Updated dependencies
+  [[`ce09388e0`](https://github.com/ho-nl/m2-pwa/commit/ce09388e0d7ef33aee660612340f6fbae15ceec2),
+  [`52a45bba4`](https://github.com/ho-nl/m2-pwa/commit/52a45bba4dc6dd6df3c81f5023df7d23ed8a534d)]:
+  - @graphcommerce/framer-utils@3.0.2
+
+## 3.0.1
+
+### Patch Changes
+
+- [`0cbaa878b`](https://github.com/ho-nl/m2-pwa/commit/0cbaa878b8a844d5abbeb1797b625a33130e6514)
+  Thanks [@paales](https://github.com/paales)! - Added homepage and repository package.json files,
+  so that the packages link to back to the website and repository
+- Updated dependencies
+  [[`0cbaa878b`](https://github.com/ho-nl/m2-pwa/commit/0cbaa878b8a844d5abbeb1797b625a33130e6514)]:
+  - @graphcommerce/framer-utils@3.0.1
+
 ## 3.0.0
 
 ### Major Changes

package/components/Image.tsx

@@ -3,15 +3,20 @@
 /* eslint-disable @next/next/no-img-element */
 /* eslint-disable jsx-a11y/alt-text */
 import { useForkRef, styled, SxProps, Theme } from '@mui/material'
-import { LoaderValue, VALID_LOADERS } from 'next/dist/server/image-config'
+import {
+  ImageConfigComplete,
+  LoaderValue,
+  VALID_LOADERS,
+  imageConfigDefault,
+} from 'next/dist/server/image-config'
+import { ImageConfigContext } from 'next/dist/shared/lib/image-config-context'
 import Head from 'next/head'
 import type { ImageLoaderProps, ImageLoader } from 'next/image'
-import React, { useEffect, useRef } from 'react'
+import React, { useContext, useEffect, useMemo, useRef } from 'react'
 import {
   akamaiLoader,
   cloudinaryLoader,
   configDeviceSizes,
-  configImageSizes,
   configLoader,
   configPath,
   DefaultImageLoaderProps,
@@ -54,7 +59,7 @@ interface StaticRequire {
   default: StaticImageData
 }
 
-type StaticImport = StaticRequire | StaticImageData
+export type StaticImport = StaticRequire | StaticImageData
 
 export function isStaticRequire(src: StaticRequire | StaticImageData): src is StaticRequire {
   return (src as StaticRequire).default !== undefined
@@ -72,12 +77,13 @@ export function srcToString(src: StaticImport | string) {
   return isStaticImport(src) ? (isStaticRequire(src) ? src.default : src).src : src
 }
 
-// sort smallest to largest
-const allSizes = [...configDeviceSizes, ...configImageSizes]
-configDeviceSizes.sort((a, b) => a - b)
-allSizes.sort((a, b) => a - b)
+// // sort smallest to largest
+// const allSizes = [...configDeviceSizes, ...configImageSizes]
+// configDeviceSizes.sort((a, b) => a - b)
+// allSizes.sort((a, b) => a - b)
 
 function getWidths(
+  config: ImageLoaderProps['config'],
   width: number | undefined,
   layout: LayoutValue,
   sizes = '',
@@ -94,12 +100,12 @@ function getWidths(
       const smallestRatio = Math.min(...percentSizes) * 0.01
 
       return {
-        widths: allSizes.filter((s) => s >= configDeviceSizes[0] * smallestRatio),
+        widths: config.allSizes.filter((s) => s >= configDeviceSizes[0] * smallestRatio),
         kind: 'w',
       }
     }
 
-    return { widths: allSizes, kind: 'w' }
+    return { widths: config.allSizes, kind: 'w' }
   }
   if (typeof width !== 'number' || layout === 'fill') {
     return { widths: configDeviceSizes, kind: 'w' }
@@ -116,7 +122,7 @@ function getWidths(
       // > something like a magnifying glass.
       // https://blog.twitter.com/engineering/en_us/topics/infrastructure/2019/capping-image-fidelity-on-ultra-high-resolution-devices.html
       [width, width * 2 /* , width * 3*/].map(
-        (w) => allSizes.find((p) => p >= w) || allSizes[allSizes.length - 1],
+        (w) => config.allSizes.find((p) => p >= w) || config.allSizes[config.allSizes.length - 1],
       ),
     ),
   ]
@@ -131,23 +137,17 @@ type GenImgAttrsData = {
   quality?: number
   sizes: string
   scale: number
+  config: ImageLoaderProps['config']
 }
 
-function generateSrcSet({
-  src,
-  layout,
-  width,
-  quality = 52,
-  sizes,
-  loader,
-  scale,
-}: GenImgAttrsData): string {
-  const { widths, kind } = getWidths(width, layout, sizes)
+function generateSrcSet(props: GenImgAttrsData): string {
+  const { src, layout, width, quality = 52, sizes, loader, scale, config } = props
+  const { widths, kind } = getWidths(config, width, layout, sizes)
 
   return widths
     .map(
       (w, i) =>
-        `${loader({ src, quality, width: w })} ${
+        `${loader({ src, quality, width: w, config })} ${
           kind === 'w' ? Math.round(w * scale) : i + 1
         }${kind}`,
     )
@@ -237,6 +237,9 @@ export type ImageProps = IntrisincImage & {
 const Img = styled('img')({})
 const Picture = styled('picture')({})
 
+// eslint-disable-next-line no-underscore-dangle
+const configEnv = process.env.__NEXT_IMAGE_OPTS as any as ImageConfigComplete
+
 const Image = React.forwardRef<HTMLImageElement, ImageProps>(
   (
     {
@@ -261,6 +264,14 @@ const Image = React.forwardRef<HTMLImageElement, ImageProps>(
     const ref = useRef<HTMLImageElement>(null)
     const combinedRef = useForkRef(ref, forwardedRef)
 
+    const configContext = useContext(ImageConfigContext)
+    const config: ImageLoaderProps['config'] = useMemo(() => {
+      const c = configEnv || configContext || imageConfigDefault
+      const allSizes = [...c.deviceSizes, ...c.imageSizes].sort((a, b) => a - b)
+      const deviceSizes = c.deviceSizes.sort((a, b) => a - b)
+      return { ...c, allSizes, deviceSizes }
+    }, [configContext])
+
     const sizesOrig =
       layout === 'fixed' && width && !sizesIncomming
         ? (`${width}px` as SizesString)
@@ -433,9 +444,36 @@ const Image = React.forwardRef<HTMLImageElement, ImageProps>(
     // https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs
     if (src?.startsWith('data:') || src?.startsWith('blob:')) unoptimized = true
 
-    const srcSet3x = generateSrcSet({ src, layout, loader, quality, sizes, width, scale: 1.5 })
-    const srcSet2x = generateSrcSet({ src, layout, loader, quality, sizes, width, scale: 1 })
-    const srcSet1x = generateSrcSet({ src, layout, loader, quality, sizes, width, scale: 0.5 })
+    const srcSet3x = generateSrcSet({
+      config,
+      src,
+      layout,
+      loader,
+      quality,
+      sizes,
+      width,
+      scale: 1.5,
+    })
+    const srcSet2x = generateSrcSet({
+      config,
+      src,
+      layout,
+      loader,
+      quality,
+      sizes,
+      width,
+      scale: 1,
+    })
+    const srcSet1x = generateSrcSet({
+      config,
+      src,
+      layout,
+      loader,
+      quality,
+      sizes,
+      width,
+      scale: 0.5,
+    })
 
     if (layout !== 'fixed' && !style) style = {}
     if (layout === 'responsive') style = { ...style, width: '100%', height: 'auto' }

package/package.json

@@ -1,6 +1,8 @@
 {
   "name": "@graphcommerce/image",
-  "version": "3.0.0",
+  "homepage": "https://www.graphcommerce.org/",
+  "repository": "github:graphcommerce-org/graphcommerce",
+  "version": "3.1.0",
   "sideEffects": false,
   "scripts": {
     "dev": "tsc -W"
@@ -13,18 +15,18 @@
     }
   },
   "dependencies": {
-    "@graphcommerce/framer-utils": "^3.0.0"
+    "@graphcommerce/framer-utils": "^3.0.3"
   },
   "devDependencies": {
-    "@graphcommerce/eslint-config-pwa": "^4.0.0",
-    "@graphcommerce/prettier-config-pwa": "^4.0.0",
-    "@graphcommerce/typescript-config-pwa": "^4.0.0",
-    "@playwright/test": "^1.18.1"
+    "@graphcommerce/eslint-config-pwa": "^4.0.3",
+    "@graphcommerce/prettier-config-pwa": "^4.0.2",
+    "@graphcommerce/typescript-config-pwa": "^4.0.2",
+    "@playwright/test": "^1.19.1"
   },
   "peerDependencies": {
-    "next": "^12.0.10",
+    "next": "^12.1.0",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
-    "type-fest": "^2.11.2"
+    "type-fest": "^2.12.0"
   }
 }