fix: address PR #149 review feedback for warnings and server docs

Author: MrRefactoring

README.md

@@ -228,7 +228,7 @@ For Confluence Server instances, you can try this workaround:
 ```typescript
 const client = new ConfluenceClient({
   host: 'https://your-confluence-server.example.com',
-  apiPrefix: '/rest/api/',
+  apiPrefix: '/rest',
   suppressWarnings: true,
   authentication: {
     basic: {
@@ -239,7 +239,7 @@ const client = new ConfluenceClient({
 });
 ```
 
-Use your login in the `email` field and set `apiPrefix` to `/rest/api/`.
+Use your login in the `email` field and set `apiPrefix` to `/rest`.
 
 This approach is not officially supported and should only be used as a workaround.
 

src/clients/baseClient.ts

@@ -10,8 +10,11 @@ import { ZodError, z } from 'zod';
 
 const ATLASSIAN_TOKEN_CHECK_FLAG = 'X-Atlassian-Token';
 const ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE = 'no-check';
+const WARNING_PREFIX = '\x1b[33m[confluence.js warning]\x1b[0m';
+const NON_EMAIL_BASIC_AUTH_WARNING_TEXT =
+  'authentication.basic.email is not a valid email address; treating it as login workaround.';
 const NON_EMAIL_BASIC_AUTH_WARNING =
-  '[confluence.js] authentication.basic.email is not a valid email address; treating it as login workaround.';
+  `${WARNING_PREFIX} ${NON_EMAIL_BASIC_AUTH_WARNING_TEXT}`;
 const EMAIL_SCHEMA = z.email();
 
 export class BaseClient implements Client {

src/config.ts

@@ -63,7 +63,7 @@ export const ConfigSchema = z.object({
   middlewares: z.optional(MiddlewaresSchema),
   /** Adds `'X-Atlassian-Token': 'no-check'` to each request header */
   noCheckAtlassianToken: z.optional(z.boolean()),
-  suppressWarnings: z.boolean().optional().default(false),
+  suppressWarnings: z.boolean().default(false).optional(),
   /** Prefix for all API routes. */
   apiPrefix: z.optional(z.string()),
 });

tests/unit/clients/baseClient.test.ts

@@ -4,8 +4,10 @@ import { ConfigSchema, type Config } from '~/config';
 import { ZodError } from 'zod';
 
 describe('BaseClient', () => {
-  const nonEmailWarningMessage =
-    '[confluence.js] authentication.basic.email is not a valid email address; treating it as login workaround.';
+  const nonEmailWarningText =
+    'authentication.basic.email is not a valid email address; treating it as login workaround.';
+  const highlightedNonEmailWarningMessage =
+    `\x1b[33m[confluence.js warning]\x1b[0m ${nonEmailWarningText}`;
 
   describe('constructor', () => {
     it('should set default apiPrefix if not provided', () => {
@@ -81,7 +83,7 @@ describe('BaseClient', () => {
         },
       });
 
-      expect(warnSpy).toHaveBeenCalledWith(nonEmailWarningMessage);
+      expect(warnSpy).toHaveBeenCalledWith(highlightedNonEmailWarningMessage);
 
       warnSpy.mockRestore();
     });
@@ -100,7 +102,25 @@ describe('BaseClient', () => {
         },
       });
 
-      expect(warnSpy).not.toHaveBeenCalledWith(nonEmailWarningMessage);
+      expect(warnSpy).not.toHaveBeenCalled();
+
+      warnSpy.mockRestore();
+    });
+
+    it('should print highlighted warning prefix when non-email login is provided', () => {
+      const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => undefined);
+
+      new BaseClient({
+        host: 'https://example.com',
+        authentication: {
+          basic: {
+            email: 'server-login',
+            apiToken: 'token',
+          },
+        },
+      });
+
+      expect(warnSpy).toHaveBeenCalledWith(highlightedNonEmailWarningMessage);
 
       warnSpy.mockRestore();
     });