feat(api): Update env var name

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 42
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/imagekit-inc%2Fimagekit-d1a3e6dfc45ae832b6b14a0aef25878985c679fa9f48c1470df188b1578ba648.yml
 openapi_spec_hash: 1d382866fce3284f26d341f112988d9d
-config_hash: 51a9632be24fc533ad69a5bd56934651
+config_hash: f1fafe5e607e996b58b67fd1dd3e74fa

README.md

@@ -26,7 +26,7 @@ The full API of this library can be found in [api.md](api.md).
 import ImageKit from '@imagekit/nodejs';
 
 const client = new ImageKit({
-  privateKey: process.env['IMAGEKIT_PRIVATE_API_KEY'], // This is the default and can be omitted
+  privateKey: process.env['IMAGEKIT_PRIVATE_KEY'], // This is the default and can be omitted
   password: process.env['OPTIONAL_IMAGEKIT_IGNORES_THIS'], // This is the default and can be omitted
 });
 
@@ -47,7 +47,7 @@ This library includes TypeScript definitions for all request params and response
 import ImageKit from '@imagekit/nodejs';
 
 const client = new ImageKit({
-  privateKey: process.env['IMAGEKIT_PRIVATE_API_KEY'], // This is the default and can be omitted
+  privateKey: process.env['IMAGEKIT_PRIVATE_KEY'], // This is the default and can be omitted
   password: process.env['OPTIONAL_IMAGEKIT_IGNORES_THIS'], // This is the default and can be omitted
 });
 

packages/mcp-server/README.md

@@ -19,7 +19,7 @@ cd imagekit-nodejs
 
 ```sh
 # set env vars as needed
-export IMAGEKIT_PRIVATE_API_KEY="My Private Key"
+export IMAGEKIT_PRIVATE_KEY="My Private Key"
 export OPTIONAL_IMAGEKIT_IGNORES_THIS="My Password"
 export IMAGEKIT_WEBHOOK_SECRET="My Webhook Secret"
 node ./packages/mcp-server/dist/index.js
@@ -44,7 +44,7 @@ For clients with a configuration JSON, it might look something like this:
       "command": "node",
       "args": ["/path/to/local/imagekit-nodejs/packages/mcp-server", "--client=claude", "--tools=dynamic"],
       "env": {
-        "IMAGEKIT_PRIVATE_API_KEY": "My Private Key",
+        "IMAGEKIT_PRIVATE_KEY": "My Private Key",
         "OPTIONAL_IMAGEKIT_IGNORES_THIS": "My Password",
         "IMAGEKIT_WEBHOOK_SECRET": "My Webhook Secret"
       }
@@ -154,7 +154,7 @@ Authorization can be provided via the `Authorization` header using the Basic sch
 Additionally, authorization can be provided via the following headers:
 | Header | Equivalent client option | Security scheme |
 | ---------------------------------- | ------------------------ | --------------- |
-| `x-imagekit-private-api-key` | `privateKey` | basicAuth |
+| `x-imagekit-private-key` | `privateKey` | basicAuth |
 | `x-optional-imagekit-ignores-this` | `password` | basicAuth |
 
 A configuration JSON for this server might look like this, assuming the server is hosted at `http://localhost:3000`:

packages/mcp-server/manifest.json

@@ -20,14 +20,14 @@
       "command": "node",
       "args": ["${__dirname}/index.js"],
       "env": {
-        "IMAGEKIT_PRIVATE_API_KEY": "${user_config.IMAGEKIT_PRIVATE_API_KEY}",
+        "IMAGEKIT_PRIVATE_KEY": "${user_config.IMAGEKIT_PRIVATE_KEY}",
         "OPTIONAL_IMAGEKIT_IGNORES_THIS": "${user_config.OPTIONAL_IMAGEKIT_IGNORES_THIS}",
         "IMAGEKIT_WEBHOOK_SECRET": "${user_config.IMAGEKIT_WEBHOOK_SECRET}"
       }
     }
   },
   "user_config": {
-    "IMAGEKIT_PRIVATE_API_KEY": {
+    "IMAGEKIT_PRIVATE_KEY": {
       "title": "private_key",
       "description": "Your ImageKit private API key (starts with `private_`).\nYou can find this in the [ImageKit dashboard](https://imagekit.io/dashboard/developer/api-keys).\n",
       "required": true,

packages/mcp-server/src/headers.ts

@@ -20,9 +20,9 @@ export const parseAuthHeaders = (req: IncomingMessage): Partial<ClientOptions> =
   }
 
   const privateKey =
-    Array.isArray(req.headers['x-imagekit-private-api-key']) ?
-      req.headers['x-imagekit-private-api-key'][0]
-    : req.headers['x-imagekit-private-api-key'];
+    Array.isArray(req.headers['x-imagekit-private-key']) ?
+      req.headers['x-imagekit-private-key'][0]
+    : req.headers['x-imagekit-private-key'];
   const password =
     Array.isArray(req.headers['x-optional-imagekit-ignores-this']) ?
       req.headers['x-optional-imagekit-ignores-this'][0]

src/client.ts

@@ -201,7 +201,7 @@ export class ImageKit {
   /**
    * API Client for interfacing with the Image Kit API.
    *
-   * @param {string | undefined} [opts.privateKey=process.env['IMAGEKIT_PRIVATE_API_KEY'] ?? undefined]
+   * @param {string | undefined} [opts.privateKey=process.env['IMAGEKIT_PRIVATE_KEY'] ?? undefined]
    * @param {string | null | undefined} [opts.password=process.env['OPTIONAL_IMAGEKIT_IGNORES_THIS'] ?? do_not_set]
    * @param {string | null | undefined} [opts.webhookSecret=process.env['IMAGEKIT_WEBHOOK_SECRET'] ?? null]
    * @param {string} [opts.baseURL=process.env['IMAGE_KIT_BASE_URL'] ?? https://api.imagekit.io] - Override the default base URL for the API.
@@ -214,14 +214,14 @@ export class ImageKit {
    */
   constructor({
     baseURL = readEnv('IMAGE_KIT_BASE_URL'),
-    privateKey = readEnv('IMAGEKIT_PRIVATE_API_KEY'),
+    privateKey = readEnv('IMAGEKIT_PRIVATE_KEY'),
     password = readEnv('OPTIONAL_IMAGEKIT_IGNORES_THIS') ?? 'do_not_set',
     webhookSecret = readEnv('IMAGEKIT_WEBHOOK_SECRET') ?? null,
     ...opts
   }: ClientOptions = {}) {
     if (privateKey === undefined) {
       throw new Errors.ImageKitError(
-        "The IMAGEKIT_PRIVATE_API_KEY environment variable is missing or empty; either provide it, or instantiate the ImageKit client with an privateKey option, like new ImageKit({ privateKey: 'My Private Key' }).",
+        "The IMAGEKIT_PRIVATE_KEY environment variable is missing or empty; either provide it, or instantiate the ImageKit client with an privateKey option, like new ImageKit({ privateKey: 'My Private Key' }).",
       );
     }
 

tests/index.test.ts

@@ -472,7 +472,7 @@ describe('instantiate client', () => {
 
   test('with environment variable arguments', () => {
     // set options via env var
-    process.env['IMAGEKIT_PRIVATE_API_KEY'] = 'My Private Key';
+    process.env['IMAGEKIT_PRIVATE_KEY'] = 'My Private Key';
     process.env['OPTIONAL_IMAGEKIT_IGNORES_THIS'] = 'My Password';
     const client = new ImageKit();
     expect(client.privateKey).toBe('My Private Key');
@@ -481,7 +481,7 @@ describe('instantiate client', () => {
 
   test('with overridden environment variable arguments', () => {
     // set options via env var
-    process.env['IMAGEKIT_PRIVATE_API_KEY'] = 'another My Private Key';
+    process.env['IMAGEKIT_PRIVATE_KEY'] = 'another My Private Key';
     process.env['OPTIONAL_IMAGEKIT_IGNORES_THIS'] = 'another My Password';
     const client = new ImageKit({ privateKey: 'My Private Key', password: 'My Password' });
     expect(client.privateKey).toBe('My Private Key');