feat(docs): improve descriptions for private API key and password fields in client settings

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-3d7da4b8ef2ed30aa32c4fb3e98e498e67402e91aaa5fd4c628fc080bfe82ea1.yml
 openapi_spec_hash: aaa50fcbccec6f2cf1165f34bc6ac886
-config_hash: 4ef178e13ecfdb97211f284f13a21e83
+config_hash: 7218b2df6efd609f88bac0ac591a70e9

README.md

@@ -27,7 +27,7 @@ import ImageKit from '@imagekit/nodejs';
 
 const client = new ImageKit({
   privateAPIKey: process.env['IMAGEKIT_PRIVATE_API_KEY'], // This is the default and can be omitted
-  password: process.env['ORG_MY_PASSWORD_TOKEN'], // This is the default and can be omitted
+  password: process.env['OPTIONAL_IMAGEKIT_IGNORES_THIS'], // This is the default and can be omitted
 });
 
 const response = await client.files.upload({
@@ -48,7 +48,7 @@ import ImageKit from '@imagekit/nodejs';
 
 const client = new ImageKit({
   privateAPIKey: process.env['IMAGEKIT_PRIVATE_API_KEY'], // This is the default and can be omitted
-  password: process.env['ORG_MY_PASSWORD_TOKEN'], // This is the default and can be omitted
+  password: process.env['OPTIONAL_IMAGEKIT_IGNORES_THIS'], // This is the default and can be omitted
 });
 
 const params: ImageKit.FileUploadParams = {

src/client.ts

@@ -86,12 +86,16 @@ import { isEmptyObj } from './internal/utils/values';
 
 export interface ClientOptions {
   /**
-   * Your ImageKit private key starts with `private_`.
+   * Your ImageKit private API key (it starts with `private_`).
+   * You can view and manage API keys in the [dashboard](https://imagekit.io/dashboard/developer/api-keys).
+   *
    */
   privateAPIKey?: string | undefined;
 
   /**
-   * Do not set this, its value is ignored
+   * ImageKit Basic Auth only uses the username field and ignores the password.
+   * This field is unused.
+   *
    */
   password?: string | null | undefined;
 
@@ -187,7 +191,7 @@ export class ImageKit {
    * API Client for interfacing with the Image Kit API.
    *
    * @param {string | undefined} [opts.privateAPIKey=process.env['IMAGEKIT_PRIVATE_API_KEY'] ?? undefined]
-   * @param {string | null | undefined} [opts.password=process.env['ORG_MY_PASSWORD_TOKEN'] ?? does_not_matter]
+   * @param {string | null | undefined} [opts.password=process.env['OPTIONAL_IMAGEKIT_IGNORES_THIS'] ?? do_not_set]
    * @param {string} [opts.baseURL=process.env['IMAGE_KIT_BASE_URL'] ?? https://api.imagekit.io] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
@@ -199,7 +203,7 @@ export class ImageKit {
   constructor({
     baseURL = readEnv('IMAGE_KIT_BASE_URL'),
     privateAPIKey = readEnv('IMAGEKIT_PRIVATE_API_KEY'),
-    password = readEnv('ORG_MY_PASSWORD_TOKEN') ?? 'does_not_matter',
+    password = readEnv('OPTIONAL_IMAGEKIT_IGNORES_THIS') ?? 'do_not_set',
     ...opts
   }: ClientOptions = {}) {
     if (privateAPIKey === undefined) {

tests/index.test.ts

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