Skip to content

CHANGELOG.md

Latest commit

 

History

History
112 lines (71 loc) · 5.02 KB

CHANGELOG.md

File metadata and controls

112 lines (71 loc) · 5.02 KB

Changelog

Version 5.2.2

  1. Updated TypeScript types to allow string values for the dpr parameter in transformations, enabling support for arithmetic expressions and dynamic DPR values.

Version 5.2.1

  1. Bug fix:
    • Updated subtitle overlay transformation parameter from l-subtitle to l-subtitles to align with API specification

Version 5.2.0

  1. New transformation parameters added:

    • layerMode (lm): Control layer blending modes in overlay transformations
    • aiEdit (e-edit): AI-powered image editing transformation
    • colorReplace (cr): Replace specific colors in images
    • distort (e-distort): Apply distortion effects to images

  2. Type definitions updated:

    • Improved TypeScript types by synchronizing with the official Node.js SDK
    • Enhanced type safety for transformation options, upload options, and responses

  3. Documentation improvements:

    • Added TypeScript versioning policy section to README
    • Clarified how type definition improvements may be released in minor/patch versions

No runtime breaking changes from 5.1.x.

Version 5.1.0

  1. New helper getResponsiveImageAttributes()
    Generates ready‑to‑use src, srcSet, and sizes for responsive <img> tags (breakpoint pruning, DPR 1×/2×, custom breakpoints, no up‑scaling).
  2. Added exports:
    getResponsiveImageAttributes, GetImageAttributesOptions, ResponsiveImageAttributes.

No breaking changes from 5.0.x.

Version 5.0.0

This version introduces major breaking changes, for usage examples, refer to the official documentation.

  1. The package has been renamed from imagekit-javascript to @imagekit/javascript.
    Please update your dependency references and import statements accordingly.

  2. The default-exported ImageKit class has been removed and replaced with named exports:

    • buildSrc
    • buildTransformationString
    • upload
    • Error classes: ImageKitInvalidRequestError, ImageKitAbortError, ImageKitUploadNetworkError, ImageKitServerError

    Update your imports to use these named exports.

  3. The upload method supports AbortSignal for canceling uploads.
    Upload error handling has been revamped, and onProgress callbacks are now supported.
    Only the Promise-based syntax is supported. Callback style usage has been removed.

  4. Several internal interfaces (e.g., ImageKitOptions, IKResponse) have been updated or removed.
    The upload options now require a publicKey, and a new SrcOptions interface has been introduced.

Version 4.0.1

Bug Fixes

  1. Fixed overlay position x,y issue.

Version 4.0.0

Breaking Changes

  1. The default value for transformationPosition is now query instead of path. This change enables wildcard cache purging to remove CDN cache for all generated transformations.

    Action Required:
    If you're using the transformationPosition parameter in the url method and want to apply transformations in the path, you must now explicitly set the value to path. The default is query.

  2. Removed the following deprecated parameters:
    effectSharpen, effectUSM, effectContrast, effectGray, effectShadow, effectGradient, and rotate.

Other Changes

  1. Native support for overlays has been added. See the README for usage examples.
  2. New AI-powered transformations are now supported:
    aiRemoveBackground, aiUpscale, aiVariation, aiDropShadow, aiChangeBackground, and more.
    (Introduced in version 3.1.0)

SDK Version 3.0.0

Breaking Changes

  • Overlay Syntax Update
    In version 3.0.0, the old overlay syntax parameters for transformations (e.g., oi, ot, obg, and others as detailed here) have been removed. These parameters are deprecated and will now return errors when used in URLs.

    Action Required:
    Migrate to the new layers syntax which supports overlay nesting, offers improved positional control, and allows more transformations at the layer level. For a quick start, refer to the examples. Use the raw transformation parameter to implement this migration.

SDK Version 2.0.0

Breaking Changes

  • Authentication Process Update
    Previously, client-side file uploads required the SDK to be initialized with both the publicKey and authenticationEndpoint to fetch security parameters (signature, token, and expire).

    Action Required:
    With version 2.0.0, you must now generate the security parameters (signature, token, and expire) yourself, eliminating the need for the authenticationEndpoint. When invoking the SDK's upload method, be sure to include these parameters along with other upload options. For further details, consult the documentation here.