feat: set UserAgent version to 0.0.0-dev when developing

Author: HungKNguyen

examples/.env.example

@@ -1,2 +1,3 @@
 # Nutrient DWS Processor API Key
-NUTRIENT_API_KEY=your_api_key_here
+NUTRIENT_API_KEY=your_api_key_here
+NODE_ENV=development

src/__tests__/integration.test.ts

@@ -11,7 +11,13 @@ import { NutrientClient } from '../client';
 import { BuildActions } from '../build';
 import type { NutrientClientOptions, OutputTypeMap } from '../types';
 import 'dotenv/config';
-import { ResultValidator, sampleDOCX, samplePDF, samplePNG, TestDocumentGenerator } from './helpers';
+import {
+  ResultValidator,
+  sampleDOCX,
+  samplePDF,
+  samplePNG,
+  TestDocumentGenerator,
+} from './helpers';
 import { getPdfPageCount, processFileInput } from '../inputs';
 
 // Skip integration tests in CI/automated environments unless explicitly enabled with valid API key
@@ -317,13 +323,15 @@ describeIntegration('Integration Tests with Live API - Direct Methods', () => {
     it('should handle network timeouts', async () => {
       const timeoutClient = new NutrientClient({
         apiKey: process.env['NUTRIENT_API_KEY'] ?? '',
-        timeout: 1
-      })
+        timeout: 1,
+      });
 
-      await expect(timeoutClient.convert(sampleDOCX, 'pdf')).rejects.toThrow('Network request failed');
+      await expect(timeoutClient.convert(sampleDOCX, 'pdf')).rejects.toThrow(
+        'Network request failed',
+      );
     }, 15000);
   });
-})
+});
 
 describeIntegration('Integration Tests with Live API- Workflow', () => {
   let client: NutrientClient;

src/__tests__/unit/http.test.ts

@@ -376,7 +376,7 @@ describe('HTTP Layer', () => {
       try {
         await errorPromise;
       } catch (error) {
-        console.error(error)
+        console.error(error);
         thrownError = error as NetworkError;
       }
 
@@ -596,10 +596,12 @@ describe('HTTP Layer', () => {
       );
 
       // Verify the User-Agent format is correct
-      const mockCalls = (mockedAxios as jest.Mock).mock.calls as unknown[][];
+      const mockCalls = (mockedAxios as unknown as jest.Mock).mock.calls as unknown[][];
       const firstCallArgs = mockCalls[0] as [{ headers?: { 'User-Agent'?: string } }];
       const userAgent = firstCallArgs[0]?.headers?.['User-Agent'];
-      expect(userAgent).toMatch(/^nutrient-dws-client-typescript\/\d+\.\d+\.\d+$/);
+      expect(userAgent).toMatch(
+        /^nutrient-dws-client-typescript\/\d+\.\d+\.\d+(?:-[a-zA-Z0-9.-]+)?$/,
+      );
     });
   });
 });

src/__tests__/unit/utils.test.ts

@@ -7,19 +7,19 @@ describe('Utility Functions', () => {
   describe('getLibraryVersion()', () => {
     it('should return a valid semver version string', () => {
       const version = getLibraryVersion();
-      
+
       expect(version).toBeDefined();
       expect(typeof version).toBe('string');
       expect(version.length).toBeGreaterThan(0);
-      
+
       // Check if it matches semver pattern (major.minor.patch)
       const semverPattern = /^\d+\.\d+\.\d+(?:-[a-zA-Z0-9.-]+)?$/;
       expect(version).toMatch(semverPattern);
     });
 
     it('should return the version from package.json', () => {
       const version = getLibraryVersion();
-      
+
       // The version should match whatever is in package.json
       // We don't hardcode the expected version to avoid breaking on version updates
       expect(version).toMatch(/^\d+\.\d+\.\d+(?:-[a-zA-Z0-9.-]+)?$/);
@@ -28,47 +28,67 @@ describe('Utility Functions', () => {
   });
 
   describe('getUserAgent()', () => {
+    const originalEnv = process.env;
+
+    beforeEach(() => {
+      jest.resetModules(); // Important to clear cached modules
+      process.env = { ...originalEnv };
+    });
+
+    afterEach(() => {
+      process.env = originalEnv; // Restore original environment
+    });
+
     it('should return a properly formatted User-Agent string', () => {
       const userAgent = getUserAgent();
-      
+
       expect(userAgent).toBeDefined();
       expect(typeof userAgent).toBe('string');
       expect(userAgent.length).toBeGreaterThan(0);
     });
 
     it('should follow the expected User-Agent format', () => {
       const userAgent = getUserAgent();
-      
+
       // Should match: nutrient-dws-client-typescript/VERSION
       const expectedPattern = /^nutrient-dws-client-typescript\/\d+\.\d+\.\d+(?:-[a-zA-Z0-9.-]+)?$/;
       expect(userAgent).toMatch(expectedPattern);
     });
 
+    it('should follow the expected User-Agent format when in development', () => {
+      process.env = { ...originalEnv, NODE_ENV: 'development' };
+      const userAgent = getUserAgent();
+
+      // Should match: nutrient-dws-client-typescript/VERSION-dev
+      const expectedPattern = /^nutrient-dws-client-typescript\/0\.0\.0-dev$/;
+      expect(userAgent).toMatch(expectedPattern);
+    });
+
     it('should include the correct library name', () => {
       const userAgent = getUserAgent();
-      
+
       expect(userAgent).toContain('nutrient-dws-client-typescript');
     });
 
     it('should include the current library version', () => {
       const userAgent = getUserAgent();
       const version = getLibraryVersion();
-      
+
       expect(userAgent).toContain(version);
     });
 
     it('should have consistent format across multiple calls', () => {
       const userAgent1 = getUserAgent();
       const userAgent2 = getUserAgent();
-      
+
       expect(userAgent1).toBe(userAgent2);
     });
 
     it('should return the expected User-Agent format with current version', () => {
       const userAgent = getUserAgent();
       const version = getLibraryVersion();
-      
+
       expect(userAgent).toBe(`nutrient-dws-client-typescript/${version}`);
     });
   });
-});
+});

src/http.ts

@@ -324,7 +324,7 @@ function convertError<Method extends Methods, Endpoint extends Endpoints<Method>
     if (request) {
       const sanitizedHeaders = config.headers;
       if (sanitizedHeaders) {
-        delete sanitizedHeaders['Authorization']
+        delete sanitizedHeaders['Authorization'];
       }
       // Network error (request made but no response)
       return new NetworkError('Network request failed', {
@@ -336,7 +336,8 @@ function convertError<Method extends Methods, Endpoint extends Endpoints<Method>
     }
 
     // Request setup error
-    return new ValidationError('Request configuration error', { message,
+    return new ValidationError('Request configuration error', {
+      message,
       endpoint: config.endpoint,
       method: config.method,
       data: config.data,
@@ -350,4 +351,4 @@ function convertError<Method extends Methods, Endpoint extends Endpoints<Method>
     method: config.method,
     data: config.data,
   });
-}
+}

src/utils/index.ts

@@ -1,4 +1,4 @@
 /**
  * Utility functions for the Nutrient DWS TypeScript Client
  */
-export { getLibraryVersion, getUserAgent } from './version';
+export { getLibraryVersion, getUserAgent } from './version';

src/utils/version.ts

@@ -8,6 +8,9 @@ import packageJson from '../../package.json';
  * @returns The version string from package.json
  */
 export function getLibraryVersion(): string {
+  if (process.env['NODE_ENV'] === 'development') {
+    return '0.0.0-dev';
+  }
   return packageJson.version;
 }