@redneckz/wildless-cms-uni-blocks 0.4.4 → 0.4.5

package/src/content-page-repository/transformImg.ts

@@ -0,0 +1,157 @@
+import fs from 'fs';
+import path from 'path';
+import util from 'util';
+import sharp from 'sharp';
+import type { ResizeOptions, Sharp } from 'sharp';
+import type { ImageSize } from '../model/ImageSize';
+import type { TransformationOptions } from './TransformationOptions';
+import type { ImgAlignment, ImgSource, Picture } from '../model/Picture';
+import { transformSrc } from './transformSrc';
+import { isPictureSizeEmpty } from '../utils/isPictureSizeEmpty';
+
+const mkdir = util.promisify(fs.mkdir);
+
+type TransformImgParams = {
+  pagePath: string;
+  src: string;
+  containerSize?: ImageSize;
+  transformationOptions: TransformationOptions & ImgSource;
+};
+
+export async function transformImg({
+  pagePath,
+  src,
+  containerSize,
+  transformationOptions,
+}: TransformImgParams): Promise<string> {
+  if (!src) {
+    return '';
+  }
+
+  const { contentDir, publicDir, format, options, size, alignment } = transformationOptions;
+
+  const pageDir = path.dirname(pagePath);
+  const imgPath = `${pageDir}/${src}`;
+  let chain = sharp(imgPath);
+
+  const targetSize = getPictureSize(size, containerSize);
+
+  if (targetSize) {
+    chain = resizeImg(chain, targetSize, getResizeFit(targetSize));
+  }
+
+  if (containerSize) {
+    chain = resizeImg(chain, containerSize);
+
+    // Save intermediate transform result to modify further
+    const { data } = await chain.toBuffer({ resolveWithObject: true });
+
+    chain = resizeImg(
+      sharp(data),
+      getCompositionResizeSize(containerSize, targetSize),
+      getResizeFit(targetSize),
+    );
+
+    chain = await compositeImg({ chain, containerSize, alignment });
+  }
+
+  if (format) {
+    chain = chain.toFormat(format, options);
+  }
+
+  const transformedSrc = transformSrc(src, transformationOptions);
+  const transformedImgPath = `${publicDir}/${path.relative(
+    contentDir,
+    `${path.dirname(pagePath)}/${transformedSrc}`,
+  )}`;
+
+  await mkdir(path.dirname(transformedImgPath), { recursive: true });
+
+  try {
+    await chain.toFile(transformedImgPath);
+  } catch (e) {
+    console.error(e);
+  }
+
+  return transformedSrc;
+}
+
+function createBackgroundImageChain({ width, height }: ImageSize) {
+  const channels = 4;
+  const rgbaColor = 0x00000000;
+
+  const canvas = Buffer.alloc(width * height * channels, rgbaColor);
+
+  return sharp(canvas, { raw: { width, height, channels } });
+}
+
+function resizeImg(chain: Sharp, size: Picture['size'], options?: ResizeOptions) {
+  return chain.resize(size?.width, size?.height, {
+    fit: sharp.fit.fill,
+    background: { r: 0, g: 0, b: 0, alpha: 0 },
+    ...options,
+  });
+}
+
+type CompositeImgParams = {
+  chain: Sharp;
+  containerSize: ImageSize;
+  alignment?: ImgAlignment;
+};
+
+async function compositeImg({
+  chain,
+  containerSize,
+  alignment,
+}: CompositeImgParams): Promise<Sharp> {
+  const { data } = await chain.toBuffer({ resolveWithObject: true });
+
+  return createBackgroundImageChain(containerSize).composite([
+    {
+      input: data,
+      gravity: alignment,
+    },
+  ]);
+}
+
+function getPictureSize(size: Picture['size'], containerSize?: ImageSize) {
+  // If containerSize is undefined intrinsic dimensions of image will be used then.
+  return isPictureSizeEmpty(size) ? containerSize : size;
+}
+
+function getCompositionResizeSize(
+  containerSize: ImageSize,
+  size: Picture['size'] = {},
+): Picture['size'] {
+  const { width, height } = size;
+  const { width: containerWidth, height: containerHeight } = containerSize;
+
+  let widthRatio = 0;
+  let heightRatio = 0;
+
+  if (!(width || height)) {
+    return undefined;
+  }
+
+  if (width) {
+    widthRatio = containerWidth / width;
+  }
+
+  if (height) {
+    heightRatio = containerHeight / height;
+  }
+
+  return widthRatio > heightRatio
+    ? { width: Math.min(Number(width), containerWidth) }
+    : { height: Math.min(Number(height), containerHeight) };
+}
+
+function getResizeFit(size: Picture['size']): ResizeOptions {
+  /*
+    Editor behaviour with one dimension present: resize by given dimension maintaining aspect ratio. (fit: contain)
+    With two dimensions present: resize trying to fill given dimensions (fit: fill)
+   */
+  return {
+    fit: size?.width && size?.height ? sharp.fit.fill : sharp.fit.contain,
+  };
+}

package/src/content-page-repository/transformPicture.ts

@@ -1,11 +1,8 @@
-import fs from 'fs';
 import path from 'path';
 import sharp from 'sharp';
-import util from 'util';
-import type { ImgSource, Picture } from '../model/Picture';
+import type { Picture } from '../model/Picture';
 import type { TransformationOptions } from './TransformationOptions';
-
-const mkdir = util.promisify(fs.mkdir);
+import { transformImg } from './transformImg';
 
 export async function transformPicture(
   pagePath: string,
@@ -14,8 +11,27 @@ export async function transformPicture(
 ): Promise<Picture> {
   const sources = picture.sources || [];
   const src = picture?.src || '';
-  const [transformedPicture, ...transformedSources] = await Promise.all(
-    [picture].concat(sources).map((_) => transformImg(pagePath, src, { ...options, ..._ })),
+
+  const transformedPicture = await transformImg({
+    pagePath,
+    src,
+    transformationOptions: { ...options, ...picture },
+  });
+
+  const { width, height } = await sharp(
+    path.resolve(options.publicDir, transformedPicture),
+  ).metadata();
+  const containerSize = width && height ? { width, height } : undefined;
+
+  const transformedSources = await Promise.all(
+    sources.map((_) =>
+      transformImg({
+        pagePath,
+        src,
+        containerSize,
+        transformationOptions: { ...options, ..._ },
+      }),
+    ),
   );
 
   return {
@@ -24,57 +40,7 @@ export async function transformPicture(
     sources: transformedSources.map((_, i) => ({
       ...sources[i],
       src: _,
+      size: { width, height },
     })),
   };
 }
-
-async function transformImg(
-  pagePath: string,
-  src: string,
-  transformationOptions: TransformationOptions & ImgSource,
-): Promise<string> {
-  const { contentDir, publicDir, format, options, size } = transformationOptions;
-
-  const pageDir = path.dirname(pagePath);
-  const imgPath = `${pageDir}/${src}`;
-  let chain = sharp(imgPath);
-  if (size) {
-    chain = chain.resize(size?.width, size?.height, {
-      fit: sharp.fit.contain,
-      background: [0, 0, 0, 0],
-    });
-  }
-  if (format) {
-    chain = chain.toFormat(format, options);
-  }
-
-  const transformedSrc = transformSrc(src, transformationOptions);
-  const transformedImgPath = `${publicDir}/${path.relative(
-    contentDir,
-    `${path.dirname(pagePath)}/${transformedSrc}`,
-  )}`;
-
-  await mkdir(path.dirname(transformedImgPath), { recursive: true });
-
-  try {
-    await chain.toFile(transformedImgPath);
-  } catch (e) {
-    console.error(e);
-  }
-
-  return transformedSrc;
-}
-
-function transformSrc(src: string, { format, size }: TransformationOptions & ImgSource): string {
-  const noTransform = !format && !size;
-  if (noTransform) {
-    return src;
-  }
-
-  const fileName = path.basename(src, path.extname(src));
-  const fileSizes = [size?.width, size?.height].filter(Boolean);
-  const suffix = fileSizes.length ? `-${fileSizes.join('-')}` : '';
-  const ext = String(format) || path.extname(src);
-
-  return `${fileName}${suffix}.${ext}`;
-}

package/src/content-page-repository/transformSrc.ts

@@ -0,0 +1,21 @@
+import path from 'path';
+import type { ImgSource } from '../model/Picture';
+import type { TransformationOptions } from './TransformationOptions';
+import { isPictureSizeEmpty } from '../utils/isPictureSizeEmpty';
+
+export function transformSrc(
+  src: string,
+  { format, size }: TransformationOptions & ImgSource,
+): string {
+  const noTransform = isPictureSizeEmpty(size) && !format;
+  if (noTransform) {
+    return src;
+  }
+
+  const fileName = path.basename(src, path.extname(src));
+  const fileSizes = [size?.width, size?.height].filter(Boolean);
+  const suffix = fileSizes.length ? `-${fileSizes.join('-')}` : '';
+  const ext = format ? String(format) : 'webp';
+
+  return `${fileName}${suffix}.${ext}`;
+}

package/src/model/ImageSize.ts

@@ -0,0 +1,6 @@
+export type ImageSize = {
+  /** @title Ширина */
+  width: number;
+  /** @title Высота */
+  height: number;
+};

package/src/model/Picture.ts

@@ -1,8 +1,35 @@
 import type { IconName } from '../icons/IconName';
 import type { IconVersion } from './IconVersion';
+import { ImageSize } from './ImageSize';
 
 export type ImgFormats = 'jpeg' | 'jpg' | 'png' | 'gif' | 'webp' | 'heif' | 'avif';
 
+/**
+ * @title Позиционирование
+ * @enumNames [
+ *    "Сверху слева",
+ *    "Сверху по центру",
+ *    "Сверху справа",
+ *    "Посередине слева",
+ *    "Посередине по центру",
+ *    "Посередине справа",
+ *    "Снизу слева",
+ *    "Снизу по центру",
+ *    "Снизу справа"
+ *  ]
+ * @default "center"
+ */
+export type ImgAlignment =
+  | 'northwest'
+  | 'north'
+  | 'northeast'
+  | 'west'
+  | 'center'
+  | 'east'
+  | 'southwest'
+  | 'south'
+  | 'southeast';
+
 export interface Img {
   /** @title Картинка */
   src?: string;
@@ -19,6 +46,7 @@ export interface Img {
 export type MediaQuery = 1919 | 1439 | 1279;
 
 export interface ImgSource {
+  alignment?: ImgAlignment;
   /** @title Иконка */
   icon?: IconName;
   iconVersion?: IconVersion;
@@ -30,12 +58,7 @@ export interface ImgSource {
   options?: Record<string, any>;
   media?: MediaQuery;
   /** @title Размер изображения */
-  size?: {
-    /** @title Ширина */
-    width?: number;
-    /** @title Высота */
-    height?: number;
-  };
+  size?: Partial<ImageSize>;
 }
 
 /** @title Изображение */

package/src/ui-kit/Img/ImgAsPicture.tsx

@@ -23,13 +23,13 @@ export const ImgAsPicture = JSX<ImageProps<Picture>>(
         {image?.sources?.length
           ? image.sources
               .sort(sourcesComparator)
-              .map(({ src, format, media, size }, index) => (
+              .map(({ src, format, media }, index) => (
                 <source
                   key={`${index}_${src}`}
                   srcSet={src}
                   type={formatToMimeType(format)}
                   media={media ? `(max-width: ${media}px)` : ''}
-                  {...size}
+                  {...image.size}
                 />
               ))
           : null}
@@ -40,6 +40,11 @@ export const ImgAsPicture = JSX<ImageProps<Picture>>(
 );
 
 const renderImg = (image: Picture, imageClassName = '', isMobile = false) => {
+  const style = {
+    width: image.size?.width ? `${image.size?.width}px` : '100%',
+    height: image.size?.height ? `${image.size?.height}px` : '100%',
+  };
+
   const title = image.title || '';
   const alt = image.alt || image.title;
   const imgStyle = isMobile ? 'm-auto' : 'm-0';
@@ -50,6 +55,7 @@ const renderImg = (image: Picture, imageClassName = '', isMobile = false) => {
       className={`${imgStyle} ${imageClassName}`}
       alt={alt}
       title={title}
+      style={style}
       {...image.size}
     />
   );

package/src/utils/isPictureSizeEmpty.ts

@@ -0,0 +1,5 @@
+import type { Picture } from '../model/Picture';
+
+export function isPictureSizeEmpty(size: Picture['size']): boolean {
+  return !(size?.width || size?.height);
+}