@imagekit/javascript 5.1.0-beta.1 → 5.2.0

package/dist/responsive.d.ts

@@ -1,56 +1,4 @@
-import type { SrcOptions } from './interfaces';
-export interface GetImageAttributesOptions extends SrcOptions {
-    /**
-      * The intended display width of the image in pixels,
-      * used **only when the `sizes` attribute is not provided**.
-      *
-      * Triggers a DPR-based strategy (1x and 2x variants) and generates `x` descriptors in `srcSet`.
-      *
-      * Ignored if `sizes` is present.
-      */
-    width?: number;
-    /**
-     * The value for the HTML `sizes` attribute
-     * (e.g., `"100vw"` or `"(min-width:768px) 50vw, 100vw"`).
-     *
-     * - If it includes one or more `vw` units, breakpoints smaller than the corresponding percentage of the smallest device width are excluded.
-     * - If it contains no `vw` units, the full breakpoint list is used.
-     *
-     * Enables a width-based strategy and generates `w` descriptors in `srcSet`.
-     */
-    sizes?: string;
-    /**
-     * Custom list of **device-width breakpoints** in pixels.
-     * These define common screen widths for responsive image generation.
-     *
-     * Defaults to `[640, 750, 828, 1080, 1200, 1920, 2048, 3840]`.
-     * Sorted automatically.
-     */
-    deviceBreakpoints?: number[];
-    /**
-     * Custom list of **image-specific breakpoints** in pixels.
-     * Useful for generating small variants (e.g., placeholders or thumbnails).
-     *
-     * Merged with `deviceBreakpoints` before calculating `srcSet`.
-     * Defaults to `[16, 32, 48, 64, 96, 128, 256, 384]`.
-     * Sorted automatically.
-     */
-    imageBreakpoints?: number[];
-}
-/**
- * Resulting set of attributes suitable for an HTML `<img>` element.
- * Useful for enabling responsive image loading.
- */
-export interface ResponsiveImageAttributes {
-    /** URL for the *largest* candidate (assigned to plain `src`). */
-    src: string;
-    /** Candidate set with `w` or `x` descriptors. */
-    srcSet?: string;
-    /** `sizes` returned (or synthesised as `100vw`). */
-    sizes?: string;
-    /** Width as a number (if `width` was provided). */
-    width?: number;
-}
+import type { ResponsiveImageAttributes, GetImageAttributesOptions } from './interfaces';
 /**
  * Generates a responsive image URL, `srcSet`, and `sizes` attributes
  * based on the input options such as `width`, `sizes`, and breakpoints.

package/dist/url.d.ts

@@ -1,5 +1,4 @@
-import type { SrcOptions } from "./interfaces";
-import type { Transformation } from "./interfaces/Transformation";
+import type { SrcOptions, Transformation } from "./interfaces";
 /**
  * Builds a source URL with the given options.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@imagekit/javascript",
-    "version": "5.1.0-beta.1",
+    "version": "5.2.0",
     "description": "ImageKit Javascript SDK",
     "main": "dist/imagekit.cjs.js",
     "module": "dist/imagekit.esm.js",

package/dist/interfaces/SrcOptions.d.ts

@@ -1,32 +0,0 @@
-import { Transformation } from "./Transformation";
-import { TransformationPosition } from ".";
-export interface SrcOptions {
-    /**
-     * Accepts a relative or absolute path of the resource. If a relative path is provided, it is appended to the `urlEndpoint`.
-     * If an absolute path is provided, `urlEndpoint` is ignored.
-     */
-    src: string;
-    /**
-     * Get your urlEndpoint from the [ImageKit dashboard](https://imagekit.io/dashboard/url-endpoints).
-     */
-    urlEndpoint: string;
-    /**
-     * An array of objects specifying the transformations to be applied in the URL. If more than one transformation is specified, they are applied in the order they are specified as chained transformations.
-     *
-     * {@link https://imagekit.io/docs/transformations#chained-transformations}
-     */
-    transformation?: Array<Transformation>;
-    /**
-     * These are additional query parameters that you want to add to the final URL.
-     * They can be any query parameters and not necessarily related to ImageKit.
-     * This is especially useful if you want to add a versioning parameter to your URLs.
-     */
-    queryParameters?: {
-        [key: string]: string | number;
-    };
-    /**
-     * By default, the transformation string is added as a query parameter in the URL, e.g., `?tr=w-100,h-100`.
-     * If you want to add the transformation string in the path of the URL, set this to `path`.
-     */
-    transformationPosition?: TransformationPosition;
-}