feat: debug mode & fixed tests

.gitignore

@@ -6,6 +6,7 @@ node_modules
 /cjs
 /esm
 /dist
+/types
 
 # Random
 /ignore

jest.config.js

@@ -10,5 +10,6 @@ module.exports = {
       isolatedModules: true,
       useESM: true
     }
-  }
+  },
+  setupFilesAfterEnv: ['<rootDir>/test/setup.ts'],
 };

src/cache/cache.ts

@@ -136,12 +136,32 @@ export interface CacheInstance {
   /**
    * The function to parse and interpret response headers. Only used if
    * cache.interpretHeader is true.
+   *
+   * @default defaultHeaderInterpreter()
    */
   headerInterpreter: HeadersInterpreter;
 
-  /** The request interceptor that will be used to handle the cache. */
+  /**
+   * The request interceptor that will be used to handle the cache.
+   *
+   * @default defaultRequestInterceptor()
+   */
   requestInterceptor: AxiosInterceptor<CacheRequestConfig>;
 
-  /** The response interceptor that will be used to handle the cache. */
+  /**
+   * The response interceptor that will be used to handle the cache.
+   *
+   * @default defaultResponseInterceptor()
+   */
   responseInterceptor: AxiosInterceptor<CacheAxiosResponse>;
+
+  /**
+   * Logs useful information in the console
+   *
+   * **Note**: This is only available with development mode enabled
+   *
+   * @default console.log
+   * @see https://axios-cache-interceptor.js.org/#/pages/development-mode
+   */
+  debug: Console['log'] | undefined;
 }

src/cache/create.ts

@@ -65,6 +65,7 @@ export function setupCache(
     options.requestInterceptor || defaultRequestInterceptor(axiosCache);
   axiosCache.responseInterceptor =
     options.responseInterceptor || defaultResponseInterceptor(axiosCache);
+  axiosCache.debug = options.debug;
 
   // CacheRequestConfig values
   axiosCache.defaults.cache = {

src/index.ts

@@ -16,3 +16,21 @@ export * from './util/cache-predicate';
 export * from './util/key-generator';
 export * from './util/types';
 export * from './util/update-cache';
+
+/** @internal */
+declare global {
+  /**
+   * Global variable defined at compile time. Use to write code that will only be executed
+   * at development time.
+   *
+   * @internal
+   */
+  const __DEV__: boolean;
+}
+
+if (__DEV__) {
+  console.error(
+    'You are using a development build. Make sure to use the correct build in production'
+  );
+  console.error('https://axios-cache-interceptor.js.org/#/pages/installing');
+}

test/dev.test.ts

@@ -0,0 +1,16 @@
+export {};
+
+describe('tests __DEV__ usage', () => {
+  it('expects importing with __DEV__ true prints a warning', async () => {
+    expect(__DEV__).toBeTruthy();
+
+    const oldLog = console.error;
+    console.error = jest.fn();
+
+    await import('../src');
+
+    expect(console.error).toBeCalled();
+
+    console.error = oldLog;
+  });
+});

test/mocks/axios.ts

@@ -1,13 +1,12 @@
 import Axios from 'axios';
 import type { AxiosCacheInstance } from '../../src/cache/axios';
-import type { CacheInstance, CacheProperties } from '../../src/cache/cache';
-import { setupCache } from '../../src/cache/create';
+import { CacheOptions, setupCache } from '../../src/cache/create';
 import { Header } from '../../src/header/headers';
 
 export const XMockRandom = 'x-mock-random';
 
 export function mockAxios(
-  options: Partial<CacheInstance> & Partial<CacheProperties> = {},
+  options: CacheOptions = {},
   responseHeaders: Record<string, string> = {}
 ): AxiosCacheInstance {
   const axios = setupCache(Axios.create(), options);

test/setup.ts

@@ -0,0 +1,2 @@
+// @ts-expect-error __DEV__ is declared as const
+global.__DEV__ = true;

test/storage/is-storage.test.ts

@@ -1,7 +1,7 @@
 import { Axios } from 'axios';
-import type { AxiosStorage } from '../../src';
 import { isStorage } from '../../src/storage/build';
 import { buildMemoryStorage } from '../../src/storage/memory';
+import type { AxiosStorage } from '../../src/storage/types';
 import { mockAxios } from '../mocks/axios';
 
 it('tests isStorage function', () => {

test/util/cache-predicate.test.ts

@@ -1,5 +1,5 @@
-import { testCachePredicate } from '../../src';
 import type { CachedStorageValue } from '../../src/storage/types';
+import { testCachePredicate } from '../../src/util/cache-predicate';
 import { mockAxios } from '../mocks/axios';
 import { createResponse } from '../utils';