gantri-components 1.144.7 → 1.144.8

package/dist/components/image/components/index.d.ts

@@ -0,0 +1 @@
+export { ProgressiveImage } from './progressive-image';

package/dist/components/image/components/progressive-image/index.d.ts

@@ -0,0 +1 @@
+export { ProgressiveImage } from './progressive-image';

package/dist/components/image/components/progressive-image/progressive-image.d.ts

@@ -0,0 +1,3 @@
+import { FC } from 'react';
+import { ProgressiveImageProps } from './progressive-image.types';
+export declare const ProgressiveImage: FC<ProgressiveImageProps>;

package/dist/components/image/components/progressive-image/progressive-image.types.d.ts

@@ -0,0 +1,7 @@
+import { ResolutionAwarePropBase } from '../../../../types/resolution-aware-prop.type';
+import { ImageProps } from '../../image.types';
+export interface ProgressiveImageProps extends Pick<ImageProps, 'onClick' | 'objectFit' | 'objectPosition' | 'className' | 'style'> {
+    alt: NonNullable<string>;
+    onLoad?: () => void;
+    src: NonNullable<ResolutionAwarePropBase<string>>;
+}

package/dist/components/image/image.helpers.d.ts

@@ -1,5 +1,7 @@
-import { ImageProps, ImageSource, TransformationMode, TransformationQuality, TransformationType } from './image.types';
+import { IGravity } from '@cloudinary/url-gen/qualifiers/gravity/GravityQualifier';
+import { AspectRatio, Dpr, ImageDimension, ImageProps, ImageSource, TransformationMode, TransformationQuality, TransformationType } from './image.types';
+import { ResolutionAwarePropBase } from '../../types/resolution-aware-prop.type';
 import { Optional } from '../../types/common';
 export declare const extractSizePropertyValue: (prop: Optional<string | number>) => number | undefined;
-export declare const generateCloudinaryUrl: (source: ImageSource, imageName?: string | undefined, aspectRatio?: string | undefined, width?: Optional<number | string>, height?: Optional<number | string>, mode?: Optional<TransformationMode>, quality?: Optional<TransformationQuality>, dpr?: Optional<number>, type?: Optional<TransformationType>) => string;
-export declare const generateImages: (params: Partial<ImageProps>, type?: TransformationType) => string | [Optional<string>, Optional<string>, Optional<string>];
+export declare const generateCloudinaryUrl: (source: ImageSource, imageName?: string | undefined, aspectRatio?: AspectRatio | undefined, width?: Optional<ImageDimension>, height?: Optional<ImageDimension>, mode?: Optional<TransformationMode>, quality?: Optional<TransformationQuality>, dpr?: Optional<Dpr>, type?: Optional<TransformationType>, gravity?: Optional<IGravity>) => string;
+export declare const generateImages: (params: Partial<ImageProps>, type?: TransformationType) => string | ResolutionAwarePropBase<string>;

package/dist/components/image/image.presets.d.ts

@@ -1,3 +1,2 @@
-import { ImageProps, Transformations } from './image.types';
+import { ImageProps } from './image.types';
 export declare const ImagePresets: Partial<ImageProps>;
-export declare const TransformationPresets: Partial<Transformations>;

package/dist/components/image/image.types.d.ts

@@ -1,29 +1,34 @@
 import { Property } from 'csstype';
 import { CSSProperties } from 'react';
+import { IGravity } from '@cloudinary/url-gen/qualifiers/gravity/GravityQualifier';
 import { ResolutionAwareProp } from '../../types/resolution-aware-prop.type';
 import { Color } from '../../styles';
 import { Optional } from '../../types/common';
+export declare type AspectRatio = `${number}:${number}` | number;
+export declare type ImageDimension = `${string}px` | `${string}rem` | number;
+export declare type Dpr = number | 'auto';
 export declare type ImageTransformationsVariant = 'f' | 'h' | 'q' | 'ffh' | 'hff' | 'hhf';
 export interface ImageProps {
     alt: string;
-    aspectRatio?: Optional<ResolutionAwareProp<string>>;
     className?: string;
-    commonTransformations?: Optional<Transformations>;
-    dpr?: Optional<number>;
+    /**
+     * Defines the aspect ratio of the image container, if a transformation is not provided,
+     * the aspectRatio transformation will inherit from this value.
+     * */
+    containerAspectRatio?: Optional<ResolutionAwareProp<AspectRatio>>;
+    dpr?: Optional<Dpr>;
     fallbackColor?: Optional<Color>;
     fetchImmediately?: boolean;
-    height?: Optional<ResolutionAwareProp<string | number>>;
+    height?: Optional<ResolutionAwareProp<ImageDimension>>;
     immediateAvailable?: Optional<boolean>;
     maxHeight?: Optional<ResolutionAwareProp<Property.MaxHeight>>;
     maxWidth?: Optional<ResolutionAwareProp<Property.MinWidth>>;
     minHeight?: Optional<ResolutionAwareProp<Property.MinHeight>>;
     minWidth?: Optional<ResolutionAwareProp<Property.MinWidth>>;
-    mode?: Optional<ResolutionAwareProp<TransformationMode>>;
     objectFit?: Optional<ResolutionAwareProp<Property.ObjectFit>>;
     objectPosition?: Optional<ResolutionAwareProp<Property.ObjectPosition>>;
     observerMargin?: string;
     onClick?: () => void;
-    quality?: Optional<TransformationQuality>;
     showLoadingIndicator?: Optional<boolean>;
     source?: Optional<ImageSource>;
     src: ResolutionAwareProp<string>;
@@ -39,18 +44,20 @@ export interface ImageProps {
      * hhf => desktop half width, tablet half width, mobile full width
      */
     transformationsVariant?: Optional<ImageTransformationsVariant>;
-    width?: Optional<ResolutionAwareProp<string | number>>;
+    width?: Optional<ResolutionAwareProp<ImageDimension>>;
 }
 export interface Transformations {
-    aspectRatio?: Optional<string>;
-    height?: Optional<number>;
-    mode?: Optional<TransformationMode>;
-    width?: Optional<number>;
+    aspectRatio?: AspectRatio;
+    gravity?: IGravity;
+    height?: ImageDimension;
+    mode?: TransformationMode;
+    quality?: TransformationQuality;
+    width?: ImageDimension;
 }
 export declare type ImageSource = 'static' | 'dynamic' | 'absolute';
 export declare type TransformationMode = 'scale' | 'limitFit' | 'limitFill' | 'limitPad' | 'fill' | 'fit' | 'crop' | 'pad' | 'imaggaCrop' | 'imaggaScale' | 'minimumFit' | 'minimumPad' | 'fillPad';
 export declare type TransformationQuality = 'auto' | 'autoBest' | 'autoEco' | 'autoGood' | 'autoLow' | 'jpegmini' | 'jpegminiBest' | 'jpegminiHigh' | 'jpegminiMedium';
-export interface StyledImageContainerProps extends Pick<ImageProps, 'aspectRatio' | 'width' | 'height' | 'fallbackColor' | 'maxWidth' | 'maxHeight' | 'minWidth' | 'minHeight'> {
+export interface StyledImageContainerProps extends Pick<ImageProps, 'containerAspectRatio' | 'width' | 'height' | 'fallbackColor' | 'maxWidth' | 'maxHeight' | 'minWidth' | 'minHeight'> {
 }
 export interface StyledImageProps extends Pick<ImageProps, 'objectFit' | 'objectPosition'> {
 }

package/dist/components/index.d.ts

@@ -30,4 +30,3 @@ export * from './text-field';
 export * from './toggle';
 export * from './tooltip';
 export * from './typography';
-export * from './video';

package/dist/helpers/layout.helpers.d.ts

@@ -1,9 +1,8 @@
 import { AppSize, ResolutionAwareProp, ResolutionAwarePropBase } from '../types/resolution-aware-prop.type';
 import { ExtractStyleFromResolutionAwarePropEntry } from '../types/layout';
-export declare function extractValuesFromResolutionAwareProp<T = unknown>(prop: unknown): ResolutionAwarePropBase<T>;
-export declare const isResolutionAwareProperty: (prop: unknown) => prop is any;
-export declare const getResolutionPrefix: () => AppSize;
-export declare const extractValueFromResolutionAwareProp: (prop: any, size: AppSize) => any;
+export declare const isResolutionAwarePropBase: (prop: unknown) => prop is any;
+export declare function extractValuesFromResolutionAwareProp<T = unknown>(prop: unknown): Required<ResolutionAwarePropBase<T>>;
+export declare const extractValueFromResolutionAwareProp: (prop: unknown, size: AppSize) => any;
 export declare const calculateDimensionsFromAspectRatio: (aspectRatio: string) => {
     height: string;
     width: string;