Internal API Deprecations

[arthurfiorette]

Previously, this package was fully open and allowed extensive customization, including request interceptors, response interceptors, waiting maps, and similar internals. While modularity is generally desirable, exposing all of these components has resulted in significant maintenance overhead: because everything is public, even small internal changes can introduce breaking changes.

For this reason, I am deprecating several configuration options and plan to remove them in future versions.

No features will be removed. The package will remain fully functional, and everything documented on our documentation site will continue to be supported. This is an internal-only change.

Based on my experience, very few users modify these low-level internals. As such, I will not provide detailed explanations for each deprecated feature.

That said, if you rely on any of the configurations being deprecated and find them valuable, please explain your use case in the comments. Your feedback will help determine whether any of these features should be retained or replaced with a more stable alternative.

See #1159 for more details

[kevinoe]

I noticed defaultKeyGenerator has been deprecated. I'd like to keep it as I'd like to be able to clear a "class" of requests based on a prefix to a cache ID. Currently I use the defaultKey generator and add the prefix. This allows me, along with my own storage, to clear the cache for a class of requests.

IE if I want to clear all user requests, I can prefix them with user-- or some such, then remove all entries that start with that key.

[nicksanders]

I'm looking to migrate from cache-adapter and will need to implement something similar to @kevinoe

[arthurfiorette]

Hey @kevinoe, I'm still unsure on the final format, but I'll probably move keyGenerator to a base class that you can later extend, the defaultKeyGenerator function will be removed, but its main functionality will still be there.

[belozer]

We are using headerInterpreter: () => 'not enough headers', bacause backend returns no-cache for all responses.
If this setting is no longer public, then it would be good to have an alternative to it.

One of the workarounds that I see is adding an interceptor to delete this header at the project level before processing the axios-cache-interceptor.

[xAt0mZ]

I just upgraded to 1.x after a few years running the 0.x line and saw this deprecation notice for InternalCacheRequestConfig.
I use the following (shortened) code.

// token is a thread-safe singleton (=singleflight) to avoid requesting multiple tokens at once
import { token } from './auth';

// used to be in 0.x
async function injectAuthorizationHeader(config: CacheRequestConfig) {
  const t = await token.getToken();
  config.headers = {
    ...config.headers,
    Authorization: `Bearer ${t}`,
  };
  return config;
}

// now in 1.x
async function injectAuthorizationHeader(config: InternalCacheRequestConfig) {
  const t = await token.getToken();
  config.headers.set('Authorization', `Bearer ${t}`);
  return config;
}

export function newCachedProxy(
  baseURL: string,
  namespace: 'static' | 'dynamic' | 'profile',
    readHeaders = false;
) {
  const proxy = setupCache(
    axios.create({
      baseURL,
      headers: {
        'Battlenet-Namespace': `${namespace}-eu`,
      },
      params: {
        locale: Language.EN,
      },
    }),
    {
      interpretHeader: readHeaders,
    }
  );
  proxy.interceptors.request.use(injectAuthorizationHeader);
  return proxy;
}

// usage of the above func
export const characterAPI = newCachedProxy(
  'https://eu.api.blizzard.com/profile/wow/character',
  'profile'
);
export const staticAPI = newCachedProxy(
  'https://eu.api.blizzard.com/data/wow',
  'static',
  { readHeaders: true }
);
export const dynamicAPI = newCachedProxy(
  'https://eu.api.blizzard.com/data/wow',
  'dynamic'
);

I don't think I strictly need the type to be publicly exposed (in theory linters should be able to infer the type in proxy.interceptors.request.use((config) => { ... }); but hiding it means I will need to inline my interceptors.