Skip to content

Commit cd9bc30

Browse files
authored
Merge pull request #125 from imagekit-developer/release-please--branches--master--changes--next--components--nodejs
release: 7.1.1
2 parents 1a9e105 + f72d3fa commit cd9bc30

File tree

67 files changed

+321
-182
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+321
-182
lines changed

.eslintcache

Lines changed: 0 additions & 1 deletion
This file was deleted.

.release-please-manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
".": "7.1.0"
2+
".": "7.1.1"
33
}

.stats.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 42
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-01aef94bd928f40b7209dc21df71e2312d4bee430119b30ee05d75cf5e1b4801.yml
3-
openapi_spec_hash: 054c332db88b23d362f72583dd24b2aa
4-
config_hash: e42d7fc3a8c92c35099cc283f9a4467a
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-c7ad6f552b38f2145781847f8b390fa1ec43068d64e45a33012a97a9299edc10.yml
3+
openapi_spec_hash: 50f281e91210ad5018ac7e4eee216f56
4+
config_hash: 74a8263b80c732a2b016177e7d56bb9c

CHANGELOG.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,39 @@
11
# Changelog
22

3+
## 7.1.1 (2025-10-06)
4+
5+
Full Changelog: [v7.1.0...v7.1.1](https://github.com/imagekit-developer/imagekit-nodejs/compare/v7.1.0...v7.1.1)
6+
7+
### Features
8+
9+
* **api:** use scoped package for mcp server ([af9b0f4](https://github.com/imagekit-developer/imagekit-nodejs/commit/af9b0f4abeeef59418ae6fc2dabf65d6270c9bb1))
10+
11+
12+
### Bug Fixes
13+
14+
* add missing 'color' parameter mapping for subtitle overlays transformation. ([2c4a6d2](https://github.com/imagekit-developer/imagekit-nodejs/commit/2c4a6d20aec544c01fb29e7b2d64513527a11ccc))
15+
* lint error ([b320d6f](https://github.com/imagekit-developer/imagekit-nodejs/commit/b320d6f9a03f1aefd1d9edad23618953b29d100c))
16+
* linting issues ([3794fe5](https://github.com/imagekit-developer/imagekit-nodejs/commit/3794fe565330087cae39bb5e35c77b0ecc6c2a2a))
17+
* update raw parameter example in README for clarity ([e86beab](https://github.com/imagekit-developer/imagekit-nodejs/commit/e86beabfa77291baaf3cd3bf6be7f1336170e51d))
18+
* update serverConfig to include valid URLs and improve label descriptions ([49d048f](https://github.com/imagekit-developer/imagekit-nodejs/commit/49d048fba3d9ede0e3e92991e8829d51c04c1229))
19+
20+
21+
### Chores
22+
23+
* configure new SDK language ([33d1237](https://github.com/imagekit-developer/imagekit-nodejs/commit/33d12370088d062a282f81625c63522a5d961308))
24+
* **internal:** remove .eslintcache ([ec12af7](https://github.com/imagekit-developer/imagekit-nodejs/commit/ec12af7ecad37e8f7a227b356acd0d0cc1c52255))
25+
* **jsdoc:** fix [@link](https://github.com/link) annotations to refer only to parts of the package‘s public interface ([4332a7e](https://github.com/imagekit-developer/imagekit-nodejs/commit/4332a7e3680d596f508b6d2c83b1e9faab6af878))
26+
27+
28+
### Documentation
29+
30+
* update README to enhance Table of Contents and add raw transformations parameter ([892d31c](https://github.com/imagekit-developer/imagekit-nodejs/commit/892d31c9105c1c8c9bbd08983c2a0c9a62aee883))
31+
32+
33+
### Refactors
34+
35+
* streamline transformation string handling in URL construction ([6e99777](https://github.com/imagekit-developer/imagekit-nodejs/commit/6e99777260db5c7fe833d4e71abe5abafb95156d))
36+
337
## 7.1.0 (2025-09-30)
438

539
Full Changelog: [v7.0.1...v7.1.0](https://github.com/imagekit-developer/imagekit-nodejs/compare/v7.0.1...v7.1.0)

README.md

Lines changed: 54 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,36 @@ For additional details, refer to the [ImageKit REST API documentation](https://i
1010

1111
If you are looking to integrate file uploads in browsers, use one of our [frontend SDKs](https://imagekit.io/docs/quick-start-guides#front-end).
1212

13+
## Table of Contents
14+
15+
- [Installation](#installation)
16+
- [Usage](#usage)
17+
- [Request & Response types](#request--response-types)
18+
- [File uploads](#file-uploads)
19+
- [URL generation](#url-generation)
20+
- [Basic URL generation](#basic-url-generation)
21+
- [URL generation with transformations](#url-generation-with-transformations)
22+
- [URL generation with image overlay](#url-generation-with-image-overlay)
23+
- [URL generation with text overlay](#url-generation-with-text-overlay)
24+
- [URL generation with multiple overlays](#url-generation-with-multiple-overlays)
25+
- [Signed URLs for secure delivery](#signed-urls-for-secure-delivery)
26+
- [Using Raw parameter for custom transformations](#using-raw-parameter-for-custom-transformations)
27+
- [Authentication parameters for client-side uploads](#authentication-parameters-for-client-side-uploads)
28+
- [Webhook verification](#webhook-verification)
29+
- [Verifying webhook signatures](#verifying-webhook-signatures)
30+
- [Handling errors](#handling-errors)
31+
- [Retries](#retries)
32+
- [Timeouts](#timeouts)
33+
- [Advanced Usage](#advanced-usage)
34+
- [Accessing raw Response data (e.g., headers)](#accessing-raw-response-data-eg-headers)
35+
- [Logging](#logging)
36+
- [Making custom/undocumented requests](#making-customundocumented-requests)
37+
- [Customizing the fetch client](#customizing-the-fetch-client)
38+
- [Fetch options](#fetch-options)
39+
- [Semantic versioning](#semantic-versioning)
40+
- [Requirements](#requirements)
41+
- [Contributing](#contributing)
42+
1343
## Installation
1444

1545
```sh
@@ -98,7 +128,7 @@ Generate a simple URL without any transformations:
98128
import ImageKit from '@imagekit/nodejs';
99129

100130
const client = new ImageKit({
101-
privateKey: process.env['IMAGEKIT_PRIVATE_KEY']
131+
privateKey: process.env['IMAGEKIT_PRIVATE_KEY'],
102132
});
103133

104134
// Basic URL without transformations
@@ -264,6 +294,26 @@ const permanentSignedUrl = client.helper.buildSrc({
264294
// Result: URL with signature parameter (?ik-s=signature)
265295
```
266296

297+
### Using Raw parameter for custom transformations
298+
299+
ImageKit frequently adds new transformation parameters that might not yet be documented in the SDK. You can use the `raw` parameter to access these features or create custom transformation strings:
300+
301+
```ts
302+
// Using raw parameter for custom transformations
303+
const customTransformUrl = client.helper.buildSrc({
304+
urlEndpoint: 'https://ik.imagekit.io/your_imagekit_id',
305+
src: '/path/to/image.jpg',
306+
transformation: [
307+
{
308+
width: 400,
309+
height: 300,
310+
raw: 'something-new',
311+
},
312+
],
313+
});
314+
// Result: https://ik.imagekit.io/your_imagekit_id/path/to/image.jpg?tr=w-400,h-300,something-new
315+
```
316+
267317
## Authentication parameters for client-side uploads
268318

269319
Generate authentication parameters for secure client-side file uploads:
@@ -300,11 +350,11 @@ try {
300350
// Verify and unwrap webhook payload
301351
const event = client.webhooks.unwrap(
302352
webhookBody, // Raw webhook payload (string)
303-
{
353+
{
304354
headers: webhookHeaders, // Request headers containing signature
305-
}
355+
},
306356
);
307-
357+
308358
console.log('Webhook signature is valid');
309359
console.log('Event type:', event.type);
310360
console.log('Event data:', event.data);
@@ -595,8 +645,6 @@ const client = new ImageKit({
595645
});
596646
```
597647

598-
## Frequently Asked Questions
599-
600648
## Semantic versioning
601649

602650
This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@imagekit/nodejs",
3-
"version": "7.1.0",
3+
"version": "7.1.1",
44
"description": "Offical NodeJS SDK for ImageKit.io integration",
55
"author": "Image Kit <[email protected]>",
66
"types": "dist/index.d.ts",

packages/mcp-server/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You can run the MCP Server directly via `npx`:
1010
export IMAGEKIT_PRIVATE_KEY="My Private Key"
1111
export OPTIONAL_IMAGEKIT_IGNORES_THIS="My Password"
1212
export IMAGEKIT_WEBHOOK_SECRET="My Webhook Secret"
13-
npx -y imagekit-api-mcp@latest
13+
npx -y @imagekit/api-mcp@latest
1414
```
1515

1616
### Via MCP Client
@@ -25,7 +25,7 @@ For clients with a configuration JSON, it might look something like this:
2525
"mcpServers": {
2626
"imagekit_nodejs_api": {
2727
"command": "npx",
28-
"args": ["-y", "imagekit-api-mcp", "--client=claude", "--tools=dynamic"],
28+
"args": ["-y", "@imagekit/api-mcp", "--client=claude", "--tools=dynamic"],
2929
"env": {
3030
"IMAGEKIT_PRIVATE_KEY": "My Private Key",
3131
"OPTIONAL_IMAGEKIT_IGNORES_THIS": "My Password",
@@ -172,10 +172,10 @@ http://localhost:3000?client=cursor&capability=tool-name-length%3D40
172172

173173
```js
174174
// Import the server, generated endpoints, or the init function
175-
import { server, endpoints, init } from "imagekit-api-mcp/server";
175+
import { server, endpoints, init } from "@imagekit/api-mcp/server";
176176

177177
// import a specific tool
178-
import createCustomMetadataFields from "imagekit-api-mcp/tools/custom-metadata-fields/create-custom-metadata-fields";
178+
import createCustomMetadataFields from "@imagekit/api-mcp/tools/custom-metadata-fields/create-custom-metadata-fields";
179179

180180
// initialize the server and all endpoints
181181
init({ server, endpoints });

packages/mcp-server/build

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ cp tsconfig.dist-src.json dist/src/tsconfig.json
2929

3030
chmod +x dist/index.js
3131

32-
DIST_PATH=./dist PKG_IMPORT_PATH=imagekit-api-mcp/ node ../../scripts/utils/postprocess-files.cjs
32+
DIST_PATH=./dist PKG_IMPORT_PATH=@imagekit/api-mcp/ node ../../scripts/utils/postprocess-files.cjs
3333

3434
# mcp bundle
3535
rm -rf dist-bundle imagekit_nodejs_api.mcpb; mkdir dist-bundle

packages/mcp-server/cloudflare-worker/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"@modelcontextprotocol/sdk": "^1.11.4",
2222
"agents": "^0.0.88",
2323
"hono": "^4.7.9",
24-
"imagekit-api-mcp": "latest",
24+
"@imagekit/api-mcp": "latest",
2525
"zod": "^3.24.4"
2626
}
2727
}

packages/mcp-server/cloudflare-worker/src/app.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {
88
renderAuthorizationRejectedContent,
99
} from './utils';
1010
import type { OAuthHelpers } from '@cloudflare/workers-oauth-provider';
11-
import { McpOptions } from 'imagekit-api-mcp/server';
11+
import { McpOptions } from '@imagekit/api-mcp/server';
1212
import { ServerConfig } from '.';
1313

1414
export type Bindings = Env & {

0 commit comments

Comments
 (0)