fix: export ResponseMap type to allow composition of ofetch

[codebender828]

This re-exports the ResponseMap type. The use case for this is to allow consumers to build a type-safe variant of ofetch such we can append methods to a given instance.

Consider this wrapper library below called api.ts. In the code below, the FetchOptions type from ofetch consumes the private type ResponseMap. Building declarations for api.ts types for this would fail because the ResponseMap type is private to ofetch. In this case, re-exporting the type fixes the error and declarations can be built in userland.

// api.ts lib
import { ofetch, FetchOptions } from "ofetch";

export const $fetch = ofetch.create({
  baseURL: SOME_API_BASE_URL,
  headers: {
    Accept: "application/json",
    "Content-Type": "application/json",
  },
  onRequest(context) {
    console.log("context", context.options);
  },
  credentials: "include",
});

/**
 * HTTP API Fetch instance
 * @param request
 * @param options
 * @returns
 */
export function api<T = any, R extends ResponseType = "json">(
  request: FetchRequest,
  options?: FetchOptions<R>
): Promise<MappedType<R, T>> {
  return $fetch<T, R>(request, options) as Promise<MappedType<R, T>>;
}

/* Appends `get` Method to `api` function object */
api.get = function get<T = any, R extends ResponseType = "json">(
  url: string,
  options: Omit<FetchOptions, "method"> = {}
): Promise<MappedType<R, T>> {
  return api(url, {
    ...options,
    method: "GET",
  });
};

[codecov]

Codecov Report

Merging #232 (182414b) into main (6e00405) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #232   +/-   ##
=======================================
  Coverage   86.26%   86.26%           
=======================================
  Files           5        5           
  Lines         415      415           
  Branches       68       68           
=======================================
  Hits          358      358           
  Misses         57       57           

Impacted Files	Coverage Δ
src/utils.ts	93.15% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[madskronborg]

When is this expected to release? :)

We are currently blocked in our migration to Nuxt 3, because our core nuxt module needs to expose a shared api client composable as discussed here: #219 (comment)