imagekit-javascript - npm Package Versions

Version 4.0.1

Bug Fixes

• Fixed overlay position x,y issue.

Version 4.0.0

Breaking Changes

• 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.

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

Other Changes

• Native support for overlays has been added. See the README for usage examples.
• 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.