@lonik/oh-image 2.1.1 → 2.1.3

package/dist/react.d.ts

@@ -1,504 +1,2 @@
-import { ImgHTMLAttributes } from "react";
-import * as react_jsx_runtime0 from "react/jsx-runtime";
-
-//#region src/react/types.d.ts
-interface ImageLoaderOptions {
-  src: string;
-  width?: number | null | undefined;
-  height?: number | null | undefined;
-}
-type ImageLoader = (options: ImageLoaderOptions) => string;
-type ImageSrcType = string | ImageSrc;
-interface ImageProps extends Partial<Pick<ImgHTMLAttributes<HTMLImageElement>, "fetchPriority" | "decoding" | "loading" | "srcSet" | "className" | "sizes" | "style">> {
-  /** Alternative text for the image, required for accessibility. Use an empty string for decorative images. */
-  alt: string;
-  /** @deprecated Use `priority` instead. */
-  asap?: boolean;
-  /** Configures the Image component to load the image immediately. */
-  priority?: boolean;
-  /** */
-  src: ImageSrcType;
-  /** The URL of the placeholder image to display while loading. */
-  placeholder?: string | undefined | ImageLoader | null;
-  /**
-   * Sets the image to "fill mode", which eliminates the height/width requirement and adds
-   * styles such that the image fills its containing element.
-   */
-  fill?: boolean;
-  loader?: ImageLoader | null;
-  width?: number | undefined;
-  height?: number | undefined;
-  breakpoints?: number[];
-}
-//#endregion
-//#region src/react/image.d.ts
-declare function Image(props: ImageProps): react_jsx_runtime0.JSX.Element;
-//#endregion
-//#region src/react/use-img-loaded.d.ts
-/**
- * A hook that tracks whether an image element has finished loading.
- *
- * Handles all edge cases:
- * - Image already cached/complete on mount
- * - Normal load via event listener
- * - Errors (resets to `false`)
- * - `src` changes (resets to `false` until the new source loads)
- * - Element unmount / ref set to `null`
- *
- * @returns `[ref, isLoaded]` — attach the ref callback to an `<img>` element.
- *
- * @example
- * ```tsx
- * function Avatar({ src }: { src: string }) {
- *   const [imgRef, isLoaded] = useImgLoaded(src);
- *   return (
- *     <img
- *       ref={imgRef}
- *       src={src}
- *       style={{ opacity: isLoaded ? 1 : 0 }}
- *     />
- *   );
- * }
- * ```
- */
-declare function useImgLoaded(src: string | undefined): [(img: HTMLImageElement | null) => void, boolean];
-//#endregion
-//#region src/react/image-context.d.ts
-interface ImageContextValue extends Pick<ImageProps, "loading"> {
-  breakpoints: number[];
-  loader: ImageLoader | null;
-}
-declare function useImageContext(): ImageContextValue;
-declare function ImageProvider({
-  children,
-  ...props
-}: {
-  children: React.ReactNode;
-} & Partial<ImageContextValue>): react_jsx_runtime0.JSX.Element;
-//#endregion
-//#region src/react/loaders/base-loader-options.d.ts
-interface BaseLoaderOptions<T> {
-  path?: string;
-  transforms?: T;
-  /** @deprecated Use `transforms` instead. */
-  params?: any;
-}
-interface BaseGlobalLoaderOptions<T> extends BaseLoaderOptions<T> {
-  placeholderTransforms?: T;
-}
-//#endregion
-//#region src/react/loaders/imgproxy/imgproxy-options.d.ts
-type ResizeType = "fit" | "fill" | "fill-down" | "force" | "auto";
-type ResizeAlgorithm = "nearest" | "linear" | "cubic" | "lanczos2" | "lanczos3";
-type GravityType = "no" | "so" | "ea" | "we" | "noea" | "nowe" | "soea" | "sowe" | "ce";
-interface ResizeOptions {
-  resizing_type?: ResizeType;
-  width?: number;
-  height?: number;
-  enlarge?: boolean;
-  extend?: boolean;
-}
-interface SizeOptions {
-  width?: number;
-  height?: number;
-  enlarge?: boolean;
-  extend?: boolean;
-}
-interface ExtendOptions {
-  extend?: boolean;
-  gravity?: GravityType;
-}
-interface GravityOptions {
-  type: GravityType;
-  x_offset?: number;
-  y_offset?: number;
-}
-interface CropOptions {
-  width: number;
-  height: number;
-  gravity?: GravityType;
-}
-interface TrimOptions {
-  threshold: number;
-  color?: string;
-  equal_hor?: boolean;
-  equal_ver?: boolean;
-}
-interface PaddingOptions {
-  top?: number;
-  right?: number;
-  bottom?: number;
-  left?: number;
-}
-interface BackgroundOptions {
-  r: number;
-  g: number;
-  b: number;
-}
-interface AdjustOptions {
-  brightness?: number;
-  contrast?: number;
-  saturation?: number;
-}
-interface BlurDetectionsOptions {
-  sigma: number;
-  class_names: string[];
-}
-interface DrawDetectionsOptions {
-  draw: boolean;
-  class_names: string[];
-}
-interface WatermarkOptions {
-  opacity: number;
-  position?: GravityType | "re";
-  x_offset?: number;
-  y_offset?: number;
-  scale?: number;
-}
-interface WatermarkSizeOptions {
-  width: number;
-  height: number;
-}
-interface UnsharpeningOptions {
-  mode?: string;
-  weight?: number;
-  dividor?: number;
-}
-interface AutoqualityOptions {
-  method?: string;
-  target?: number;
-  min_quality?: number;
-  max_quality?: number;
-  allowed_error?: number;
-}
-interface JpegOptions {
-  progressive?: boolean;
-  no_subsample?: boolean;
-  trellis_quant?: boolean;
-  overshoot_deringing?: boolean;
-  optimize_scans?: boolean;
-  quant_table?: number;
-}
-interface PngOptions {
-  interlaced?: boolean;
-  quantize?: boolean;
-  quantization_colors?: number;
-}
-interface ImgproxyTransforms {
-  /**
-   * Defines the resizing type, width, height, enlarge, and extend.
-   * All arguments are optional and can be omitted to use their default values.
-   */
-  resize?: ResizeOptions;
-  /**
-   * Defines the width, height, enlarge, and extend.
-   * All arguments are optional and can be omitted to use their default values.
-   */
-  size?: SizeOptions;
-  /**
-   * Defines how imgproxy will resize the source image.
-   * Default: fit
-   */
-  resizing_type?: ResizeType;
-  /**
-   * Defines the algorithm that imgproxy will use for resizing.
-   * Default: lanczos3
-   */
-  resizing_algorithm?: ResizeAlgorithm;
-  /**
-   * Defines the width of the resulting image.
-   * Default: 0
-   */
-  width?: number;
-  /**
-   * Defines the height of the resulting image.
-   * Default: 0
-   */
-  height?: number;
-  /**
-   * Defines the minimum width of the resulting image.
-   * Default: 0
-   */
-  "min-width"?: number;
-  /**
-   * Defines the minimum height of the resulting image.
-   * Default: 0
-   */
-  "min-height"?: number;
-  /**
-   * When set, imgproxy will multiply the image dimensions according to these factors.
-   * Default: 1
-   */
-  zoom?: number | {
-    x: number;
-    y: number;
-  };
-  /**
-   * When set, imgproxy will multiply the image dimensions according to this factor for HiDPI (Retina) devices.
-   * Default: 1
-   */
-  dpr?: number;
-  /**
-   * When set to true, imgproxy will enlarge the image if it is smaller than the given size.
-   * Default: false
-   */
-  enlarge?: boolean;
-  /**
-   * When set to true, imgproxy will extend the image if it is smaller than the given size.
-   * Can also specify gravity.
-   * Default: false:ce:0:0
-   */
-  extend?: boolean | ExtendOptions;
-  /**
-   * When imgproxy needs to cut some parts of the image, it is guided by the gravity option.
-   * Default: ce:0:0
-   */
-  gravity?: GravityOptions;
-  /**
-   * Defines an area of the image to be processed (crop before resize).
-   */
-  crop?: CropOptions;
-  /**
-   * Removes surrounding background.
-   */
-  trim?: TrimOptions;
-  /**
-   * Defines padding size.
-   */
-  padding?: PaddingOptions;
-  /**
-   * When set to true, imgproxy will automatically rotate images based on the EXIF Orientation parameter.
-   */
-  auto_rotate?: boolean;
-  /**
-   * Rotates the image on the specified angle.
-   * Default: 0
-   */
-  rotate?: number;
-  /**
-   * When set, imgproxy will fill the resulting image background with the specified color.
-   * Default: disabled
-   */
-  background?: string | BackgroundOptions;
-  /**
-   * Adds an alpha channel to background.
-   * Default: 1
-   */
-  background_alpha?: number;
-  /**
-   * Defines the brightness, contrast, and saturation.
-   */
-  adjust?: AdjustOptions;
-  /**
-   * When set, imgproxy will adjust brightness of the resulting image.
-   * Default: 0
-   */
-  brightness?: number;
-  /**
-   * When set, imgproxy will adjust the contrast of the resulting image.
-   * Default: 1
-   */
-  contrast?: number;
-  /**
-   * When set, imgproxy will adjust saturation of the resulting image.
-   * Default: 1
-   */
-  saturation?: number;
-  /**
-   * When set, imgproxy will apply a gaussian blur filter to the resulting image.
-   * Default: disabled
-   */
-  blur?: number;
-  /**
-   * When set, imgproxy will apply the sharpen filter to the resulting image.
-   * Default: disabled
-   */
-  sharpen?: number;
-  /**
-   * When set, imgproxy will apply the pixelate filter to the resulting image.
-   * Default: disabled
-   */
-  pixelate?: number;
-  /**
-   * Allows redefining unsharpening options.
-   */
-  unsharpening?: UnsharpeningOptions;
-  /**
-   * imgproxy detects objects of the provided classes and blurs them.
-   */
-  blur_detections?: BlurDetectionsOptions;
-  /**
-   * When draw is set to true, imgproxy detects objects of the provided classes and draws their bounding boxes.
-   */
-  draw_detections?: DrawDetectionsOptions;
-  /**
-   * Places a watermark on the processed image.
-   * Default: disabled
-   */
-  watermark?: WatermarkOptions;
-  /**
-   * When set, imgproxy will use the image from the specified URL as a watermark.
-   * Default: blank
-   */
-  watermark_url?: string;
-  /**
-   * When set, imgproxy will generate an image from the provided text and use it as a watermark.
-   * Default: blank
-   */
-  watermark_text?: string;
-  /**
-   * Defines the desired width and height of the watermark.
-   * Default: 0:0
-   */
-  watermark_size?: WatermarkSizeOptions;
-  /**
-   * When set, imgproxy will prepend a <style> node with the provided content to the <svg> node.
-   * Default: blank
-   */
-  style?: string;
-  /**
-   * When set to true, imgproxy will strip the metadata (EXIF, IPTC, etc.) on JPEG and WebP output images.
-   */
-  strip_metadata?: boolean;
-  /**
-   * When set to true, imgproxy will not remove copyright info while stripping metadata.
-   */
-  keep_copyright?: boolean;
-  /**
-   * When set to true, imgproxy will transform the embedded color profile (ICC) to sRGB and remove it from the image.
-   */
-  strip_color_profile?: boolean;
-  /**
-   * When set to true and the source image has an embedded thumbnail, imgproxy will always use the embedded thumbnail.
-   */
-  enforce_thumbnail?: boolean;
-  /**
-   * When set to true, imgproxy will return attachment in the Content-Disposition header.
-   */
-  return_attachment?: boolean;
-  /**
-   * Redefines quality of the resulting image, as a percentage.
-   * Default: 0
-   */
-  quality?: number;
-  /**
-   * Adds or redefines IMGPROXY_FORMAT_QUALITY values.
-   */
-  format_quality?: Record<string, number>;
-  /**
-   * Redefines autoquality settings.
-   */
-  autoquality?: AutoqualityOptions;
-  /**
-   * When set, imgproxy automatically degrades the quality of the image until the image size is under the specified amount of bytes.
-   * Default: 0
-   */
-  max_bytes?: number;
-  /**
-   * Allows redefining JPEG saving options.
-   */
-  jpeg_options?: JpegOptions;
-  /**
-   * Allows redefining PNG saving options.
-   */
-  png_options?: PngOptions;
-  /**
-   * Specifies the resulting image format.
-   * Default: jpg
-   */
-  format?: string;
-  /**
-   * When a source image supports pagination or animation, this option allows specifying the page to use it on.
-   * Default: 0
-   */
-  page?: number;
-  /**
-   * Allows redefining IMGPROXY_VIDEO_THUMBNAIL_SECOND config.
-   */
-  video_thumbnail_second?: number;
-  /**
-   * You can use a custom fallback image by specifying its URL.
-   * Default: blank
-   */
-  fallback_image_url?: string;
-  /**
-   * When set, imgproxy will skip the processing of the listed formats.
-   * Default: empty
-   */
-  skip_processing?: string[];
-  /**
-   * Cache buster doesn't affect image processing but its changing allows for bypassing the CDN, proxy server and browser cache.
-   * Default: empty
-   */
-  cachebuster?: string;
-  /**
-   * When set, imgproxy will check the provided unix timestamp and return 404 when expired.
-   * Default: empty
-   */
-  expires?: number;
-  /**
-   * Defines a filename for the Content-Disposition header.
-   * Default: empty
-   */
-  filename?: string;
-  /**
-   * Defines a list of presets to be used by imgproxy.
-   * Default: empty
-   */
-  preset?: string[];
-}
-type ImgproxyOptions = BaseLoaderOptions<ImgproxyTransforms>;
-type ImgproxyGlobalOptions = BaseGlobalLoaderOptions<ImgproxyTransforms>;
-//#endregion
-//#region src/react/loaders/imgproxy/use-imgproxy-loader.d.ts
-declare function useImgproxyLoader(options?: ImgproxyOptions): (imageOptions: ImageLoaderOptions) => string;
-//#endregion
-//#region src/react/loaders/imgproxy/imgproxy-context.d.ts
-declare function useImgproxyContext(): ImgproxyGlobalOptions;
-declare function ImgproxyLoaderProvider({
-  children,
-  ...props
-}: {
-  children: React.ReactNode;
-} & Partial<ImgproxyOptions>): react_jsx_runtime0.JSX.Element;
-//#endregion
-//#region src/react/loaders/imgproxy/use-imgproxy-placeholder.d.ts
-declare function useImgproxyPlaceholder(options?: ImgproxyOptions): (imageOptions: ImageLoaderOptions) => string;
-//#endregion
-//#region src/react/loaders/cloudflare-loader.d.ts
-interface CloudflareLoaderOptions {
-  path: string;
-  placeholder: boolean;
-  format: string;
-  params?: Record<string, string>;
-  placeholderParams?: Record<string, string>;
-  breakpoints?: number[];
-}
-declare function useCloudflareContext(): CloudflareLoaderOptions;
-declare function CloudflareLoaderProvider({
-  children,
-  ...props
-}: {
-  children: React.ReactNode;
-} & Partial<CloudflareLoaderOptions>): react_jsx_runtime0.JSX.Element;
-declare function useCloudflareLoader(options?: Partial<CloudflareLoaderOptions>): ImageLoader;
-//#endregion
-//#region src/react/loaders/cloudinary-loader.d.ts
-interface CloudinaryLoaderOptions {
-  path: string;
-  placeholder: boolean;
-  format: string;
-  params?: Record<string, string>;
-  placeholderParams?: Record<string, string>;
-  breakpoints?: number[];
-}
-declare function useCloudinaryContext(): CloudinaryLoaderOptions;
-declare function CloudinaryLoaderProvider({
-  children,
-  ...props
-}: {
-  children: React.ReactNode;
-} & Partial<CloudinaryLoaderOptions>): react_jsx_runtime0.JSX.Element;
-declare function useCloudinaryLoader(options?: Partial<CloudinaryLoaderOptions>): ImageLoader;
-//#endregion
-export { type CloudflareLoaderOptions, CloudflareLoaderProvider, type CloudinaryLoaderOptions, CloudinaryLoaderProvider, Image, type ImageLoader, type ImageLoaderOptions, type ImageProps, ImageProvider, type ImageSrcType, type ImgproxyGlobalOptions, ImgproxyLoaderProvider, type ImgproxyOptions, type ImgproxyTransforms, useCloudflareContext, useCloudflareLoader, useCloudinaryContext, useCloudinaryLoader, useImageContext, useImgLoaded, useImgproxyContext, useImgproxyLoader, useImgproxyPlaceholder };
+import { a as ImageLoader, c as ImageSrcType, i as Image, n as useImageContext, o as ImageLoaderOptions, r as useImgLoaded, s as ImageProps, t as ImageProvider } from "./index-BLvefiKI.js";
+export { Image, ImageLoader, ImageLoaderOptions, ImageProps, ImageProvider, ImageSrcType, useImageContext, useImgLoaded };