make-service 0.1.0 → 1.0.0-next.0

package/README.md

@@ -8,6 +8,7 @@ It adds a set of little features and allows you to parse responses with [zod](ht
 - 🤩 Type-safe return of `response.json()` and `response.text()`. Defaults to `unknown` instead of `any`.
 - 🚦 Easily setup an API with a `baseURL` and common `headers` for every request.
 - 🏗️ Compose URL from the base by just calling the endpoints and an object-like `query`.
+- 🐾 Replaces URL wildcards with an object of `params`.
 - 🧙‍♀️ Automatically stringifies the `body` of a request so you can give it a JSON-like structure.
 - 🐛 Accepts a `trace` function for debugging.
 
@@ -76,7 +77,7 @@ Its [`typedResponse`](#typedresponse) can also be parsed with a zod schema. Here
 ```ts
 const response = await api.get("/users", {
   query: { search: "John" },
-  trace: (input, requestInit) => console.log(input, requestInit),
+  trace: (url, requestInit) => console.log(url, requestInit),
 })
 const json = await response.json(
   z.object({
@@ -104,6 +105,38 @@ await api.head("/users")
 await api.options("/users")
 ```
 
+This function can also correctly merge any sort of `URL`, `URLSearchParams`, and `Headers`.
+
+```ts
+import { makeService } from 'make-service'
+
+const api = makeService(new URL("https://example.com/api"), new Headers({
+  authorization: "Bearer 123"
+}))
+
+const response = await api.get("/users?admin=true", {
+  headers: [['accept', 'application/json']],
+  query: { page: "2" },
+})
+
+// It will call "https://example.com/api/users?admin=true&page=2"
+// with headers: { authorization: "Bearer 123", accept: "application/json" }
+```
+
+In case you want to delete a header previously set you can pass `undefined` or `'undefined'` as its value:
+```ts
+const api = makeService("https://example.com/api", { authorization: "Bearer 123" })
+const response = await api.get("/users", {
+  headers: new Headers({ authorization: 'undefined', "Content-Type": undefined }),
+})
+// headers will be empty.
+```
+Note: Don't forget headers are case insensitive.
+```ts
+const headers = new Headers({ 'Content-Type': 'application/json' })
+Object.fromEntries(headers) // equals to: { 'content-type': 'application/json' }
+```
+
 ## enhancedFetch
 
 A wrapper around the `fetch` API.
@@ -121,22 +154,23 @@ const json = await response.json()
 // You can pass it a generic or schema to type the result
 ```
 
-This function accepts the same arguments as the `fetch` API - with exception of [JSON-like body](/src/make-service.ts) -, and it also accepts an object-like [`query`](/src/make-service.ts) and a `trace` function that will be called with the `input` and `requestInit` arguments.
+This function accepts the same arguments as the `fetch` API - with exception of [JSON-like body](/src/make-service.ts) -, and it also accepts an object of `params` to replace URL wildcards, an object-like [`query`](/src/make-service.ts) and a `trace` function that will be called with the `url` and `requestInit` arguments.
 
 This slightly different `RequestInit` is typed as `EnhancedRequestInit`.
 
 ```ts
 import { enhancedFetch } from 'make-service'
 
-await enhancedFetch("https://example.com/api/users", {
+await enhancedFetch("https://example.com/api/users/:role", {
   method: 'POST',
   body: { some: { object: { as: { body } } } },
   query: { page: "1" },
-  trace: (input, requestInit) => console.log(input, requestInit)
+  params: { role: "admin" },
+  trace: (url, requestInit) => console.log(url, requestInit)
 })
 
 // The trace function will be called with the following arguments:
-// "https://example.com/api/users?page=1"
+// "https://example.com/api/users/admin?page=1"
 // {
 //   method: 'POST',
 //   body: '{"some":{"object":{"as":{"body":{}}}}}',

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-declare const HTTP_METHODS: readonly ["get", "post", "put", "delete", "patch", "options", "head"];
+declare const HTTP_METHODS: readonly ["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD"];
 
 /**
  * It returns the JSON object or throws an error if the response is not ok.
@@ -24,14 +24,24 @@ type TypedResponse = Omit<Response, 'json' | 'text'> & {
     text: TypedResponseText;
 };
 type EnhancedRequestInit = Omit<RequestInit, 'body'> & {
-    body?: JSONValue;
+    body?: JSONValue | BodyInit | null;
     query?: SearchParams;
+    params?: Record<string, string>;
     trace?: (...args: Parameters<typeof fetch>) => void;
 };
 type ServiceRequestInit = Omit<EnhancedRequestInit, 'method'>;
 type HTTPMethod = (typeof HTTP_METHODS)[number];
 type TypedResponseJson = ReturnType<typeof getJson>;
 type TypedResponseText = ReturnType<typeof getText>;
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type NoEmpty<T> = keyof T extends never ? never : T;
+type PathParams<T extends string> = NoEmpty<T extends `${infer _}:${infer Param}/${infer Rest}` ? Prettify<{
+    [K in Param]: string;
+} & PathParams<Rest>> : T extends `${infer _}:${infer Param}` ? {
+    [K in Param]: string;
+} : {}>;
 
 /**
  * It merges multiple HeadersInit objects into a single Headers object
@@ -40,11 +50,11 @@ type TypedResponseText = ReturnType<typeof getText>;
  */
 declare function mergeHeaders(...entries: (HeadersInit | [string, undefined][] | Record<string, undefined>)[]): Headers;
 /**
- * @param input a string or URL to which the query parameters will be added
+ * @param url a string or URL to which the query parameters will be added
  * @param searchParams the query parameters
- * @returns the input with the query parameters added with the same type as the input
+ * @returns the url with the query parameters added with the same type as the url
  */
-declare function addQueryToInput(input: string | URL, searchParams?: SearchParams): string | URL;
+declare function addQueryToUrl(url: string | URL, searchParams?: SearchParams): string | URL;
 /**
  * @param baseURL the base path to the API
  * @returns a function that receives a path and an object of query parameters and returns a URL
@@ -67,12 +77,12 @@ declare function makeGetApiUrl(baseURL: string | URL): (path: string, searchPara
 declare function typedResponse(response: Response): TypedResponse;
 /**
  * @param body the JSON-like body of the request
- * @returns the body stringified if it is not a string
+ * @returns the body is stringified if it is not a string and it is a JSON-like object. It also accepts other types of BodyInit such as Blob, ReadableStream, etc.
  */
-declare function ensureStringBody(body?: JSONValue): string | undefined;
+declare function ensureStringBody<B extends JSONValue | BodyInit | null>(body?: B): B extends JSONValue ? string : B;
 /**
  *
- * @param input a string or URL to be fetched
+ * @param url a string or URL to be fetched
  * @param requestInit the requestInit to be passed to the fetch request. It is the same as the `RequestInit` type, but it also accepts a JSON-like `body` and an object-like `query` parameter.
  * @param requestInit.body the body of the request. It will be automatically stringified so you can send a JSON-like object
  * @param requestInit.query the query parameters to be added to the URL
@@ -84,7 +94,7 @@ declare function ensureStringBody(body?: JSONValue): string | undefined;
  * const untyped = await response.json();
  * //    ^? unknown
  */
-declare function enhancedFetch(input: string | URL, requestInit?: EnhancedRequestInit): Promise<TypedResponse>;
+declare function enhancedFetch(url: string | URL, requestInit?: EnhancedRequestInit): Promise<TypedResponse>;
 /**
  *
  * @param baseURL the base URL to the API
@@ -96,14 +106,6 @@ declare function enhancedFetch(input: string | URL, requestInit?: EnhancedReques
  * const users = await response.json(userSchema);
  * //    ^? User[]
  */
-declare function makeService(baseURL: string | URL, baseHeaders?: HeadersInit): {
-    get: (path: string, requestInit?: ServiceRequestInit) => Promise<TypedResponse>;
-    post: (path: string, requestInit?: ServiceRequestInit) => Promise<TypedResponse>;
-    put: (path: string, requestInit?: ServiceRequestInit) => Promise<TypedResponse>;
-    delete: (path: string, requestInit?: ServiceRequestInit) => Promise<TypedResponse>;
-    patch: (path: string, requestInit?: ServiceRequestInit) => Promise<TypedResponse>;
-    options: (path: string, requestInit?: ServiceRequestInit) => Promise<TypedResponse>;
-    head: (path: string, requestInit?: ServiceRequestInit) => Promise<TypedResponse>;
-};
+declare function makeService(baseURL: string | URL, baseHeaders?: HeadersInit | (() => HeadersInit | Promise<HeadersInit>)): Record<"delete" | "get" | "post" | "put" | "patch" | "options" | "head", (path: string, requestInit?: ServiceRequestInit) => Promise<TypedResponse>>;
 
-export { EnhancedRequestInit, HTTPMethod, JSONValue, Schema, SearchParams, ServiceRequestInit, TypedResponse, TypedResponseJson, TypedResponseText, addQueryToInput, enhancedFetch, ensureStringBody, makeGetApiUrl, makeService, mergeHeaders, typedResponse };
+export { EnhancedRequestInit, HTTPMethod, JSONValue, PathParams, Schema, SearchParams, ServiceRequestInit, TypedResponse, TypedResponseJson, TypedResponseText, addQueryToUrl, enhancedFetch, ensureStringBody, makeGetApiUrl, makeService, mergeHeaders, typedResponse };

package/dist/index.js

@@ -20,7 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  addQueryToInput: () => addQueryToInput,
+  addQueryToUrl: () => addQueryToUrl,
   enhancedFetch: () => enhancedFetch,
   ensureStringBody: () => ensureStringBody,
   makeGetApiUrl: () => makeGetApiUrl,
@@ -32,21 +32,18 @@ module.exports = __toCommonJS(src_exports);
 
 // src/constants.ts
 var HTTP_METHODS = [
-  "get",
-  "post",
-  "put",
-  "delete",
-  "patch",
-  "options",
-  "head"
+  "GET",
+  "POST",
+  "PUT",
+  "DELETE",
+  "PATCH",
+  "OPTIONS",
+  "HEAD"
 ];
 
 // src/internals.ts
 function getJson(response) {
   return async (schema) => {
-    if (!response.ok) {
-      throw new Error(await response.text());
-    }
     const json = await response.json();
     return schema ? schema.parse(json) : json;
   };
@@ -57,8 +54,17 @@ function getText(response) {
     return schema ? schema.parse(text) : text;
   };
 }
-function isHTTPMethod(method) {
-  return HTTP_METHODS.includes(method);
+function replaceUrlParams(url, params) {
+  if (!params)
+    return url;
+  let urlString = String(url);
+  Object.entries(params).forEach(([key, value]) => {
+    urlString = urlString.replace(new RegExp(`:${key}($|/)`), `${value}$1`);
+  });
+  return url instanceof URL ? new URL(urlString) : urlString;
+}
+function typeOf(t) {
+  return Object.prototype.toString.call(t).replace(/^\[object (.+)\]$/, "$1").toLowerCase();
 }
 
 // src/make-service.ts
@@ -76,27 +82,27 @@ function mergeHeaders(...entries) {
   }
   return new Headers(Array.from(result.entries()));
 }
-function addQueryToInput(input, searchParams) {
+function addQueryToUrl(url, searchParams) {
   if (!searchParams)
-    return input;
-  if (typeof input === "string") {
-    const separator = input.includes("?") ? "&" : "?";
-    return `${input}${separator}${new URLSearchParams(searchParams)}`;
+    return url;
+  if (typeof url === "string") {
+    const separator = url.includes("?") ? "&" : "?";
+    return `${url}${separator}${new URLSearchParams(searchParams)}`;
   }
-  if (searchParams && input instanceof URL) {
+  if (searchParams && url instanceof URL) {
     for (const [key, value] of Object.entries(
       new URLSearchParams(searchParams)
     )) {
-      input.searchParams.set(key, value);
+      url.searchParams.set(key, value);
     }
   }
-  return input;
+  return url;
 }
 function makeGetApiUrl(baseURL) {
   const base = baseURL instanceof URL ? baseURL.toString() : baseURL;
   return (path, searchParams) => {
     const url = `${base}${path}`.replace(/([^https?:]\/)\/+/g, "$1");
-    return addQueryToInput(url, searchParams);
+    return addQueryToUrl(url, searchParams);
   };
 }
 function typedResponse(response) {
@@ -112,13 +118,13 @@ function typedResponse(response) {
 }
 function ensureStringBody(body) {
   if (typeof body === "undefined")
-    return;
+    return body;
   if (typeof body === "string")
     return body;
-  return JSON.stringify(body);
+  return ["number", "boolean", "array", "object"].includes(typeOf(body)) ? JSON.stringify(body) : body;
 }
-async function enhancedFetch(input, requestInit) {
-  var _a;
+async function enhancedFetch(url, requestInit) {
+  var _a, _b;
   const { query, trace, ...reqInit } = requestInit != null ? requestInit : {};
   const headers = mergeHeaders(
     {
@@ -126,11 +132,12 @@ async function enhancedFetch(input, requestInit) {
     },
     (_a = reqInit.headers) != null ? _a : {}
   );
-  const url = addQueryToInput(input, query);
+  const withParams = replaceUrlParams(url, (_b = reqInit.params) != null ? _b : {});
+  const fullUrl = addQueryToUrl(withParams, query);
   const body = ensureStringBody(reqInit.body);
   const enhancedReqInit = { ...reqInit, headers, body };
-  trace == null ? void 0 : trace(url, enhancedReqInit);
-  const response = await fetch(url, enhancedReqInit);
+  trace == null ? void 0 : trace(fullUrl, enhancedReqInit);
+  const response = await fetch(fullUrl, enhancedReqInit);
   return typedResponse(response);
 }
 function makeService(baseURL, baseHeaders) {
@@ -141,22 +148,24 @@ function makeService(baseURL, baseHeaders) {
       const response = await enhancedFetch(url, {
         ...requestInit,
         method,
-        headers: mergeHeaders(baseHeaders != null ? baseHeaders : {}, (_a = requestInit == null ? void 0 : requestInit.headers) != null ? _a : {})
+        headers: mergeHeaders(
+          typeof baseHeaders === "function" ? await baseHeaders() : baseHeaders != null ? baseHeaders : {},
+          (_a = requestInit == null ? void 0 : requestInit.headers) != null ? _a : {}
+        )
       });
       return response;
     };
   };
-  return new Proxy({}, {
-    get(_target, prop) {
-      if (isHTTPMethod(prop))
-        return service(prop.toUpperCase());
-      throw new Error(`Invalid HTTP method: ${prop.toString()}`);
-    }
-  });
+  let api = {};
+  for (const method of HTTP_METHODS) {
+    const lowerMethod = method.toLowerCase();
+    api[lowerMethod] = service(method);
+  }
+  return api;
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  addQueryToInput,
+  addQueryToUrl,
   enhancedFetch,
   ensureStringBody,
   makeGetApiUrl,

package/dist/index.mjs

@@ -1,20 +1,17 @@
 // src/constants.ts
 var HTTP_METHODS = [
-  "get",
-  "post",
-  "put",
-  "delete",
-  "patch",
-  "options",
-  "head"
+  "GET",
+  "POST",
+  "PUT",
+  "DELETE",
+  "PATCH",
+  "OPTIONS",
+  "HEAD"
 ];
 
 // src/internals.ts
 function getJson(response) {
   return async (schema) => {
-    if (!response.ok) {
-      throw new Error(await response.text());
-    }
     const json = await response.json();
     return schema ? schema.parse(json) : json;
   };
@@ -25,8 +22,17 @@ function getText(response) {
     return schema ? schema.parse(text) : text;
   };
 }
-function isHTTPMethod(method) {
-  return HTTP_METHODS.includes(method);
+function replaceUrlParams(url, params) {
+  if (!params)
+    return url;
+  let urlString = String(url);
+  Object.entries(params).forEach(([key, value]) => {
+    urlString = urlString.replace(new RegExp(`:${key}($|/)`), `${value}$1`);
+  });
+  return url instanceof URL ? new URL(urlString) : urlString;
+}
+function typeOf(t) {
+  return Object.prototype.toString.call(t).replace(/^\[object (.+)\]$/, "$1").toLowerCase();
 }
 
 // src/make-service.ts
@@ -44,27 +50,27 @@ function mergeHeaders(...entries) {
   }
   return new Headers(Array.from(result.entries()));
 }
-function addQueryToInput(input, searchParams) {
+function addQueryToUrl(url, searchParams) {
   if (!searchParams)
-    return input;
-  if (typeof input === "string") {
-    const separator = input.includes("?") ? "&" : "?";
-    return `${input}${separator}${new URLSearchParams(searchParams)}`;
+    return url;
+  if (typeof url === "string") {
+    const separator = url.includes("?") ? "&" : "?";
+    return `${url}${separator}${new URLSearchParams(searchParams)}`;
   }
-  if (searchParams && input instanceof URL) {
+  if (searchParams && url instanceof URL) {
     for (const [key, value] of Object.entries(
       new URLSearchParams(searchParams)
     )) {
-      input.searchParams.set(key, value);
+      url.searchParams.set(key, value);
     }
   }
-  return input;
+  return url;
 }
 function makeGetApiUrl(baseURL) {
   const base = baseURL instanceof URL ? baseURL.toString() : baseURL;
   return (path, searchParams) => {
     const url = `${base}${path}`.replace(/([^https?:]\/)\/+/g, "$1");
-    return addQueryToInput(url, searchParams);
+    return addQueryToUrl(url, searchParams);
   };
 }
 function typedResponse(response) {
@@ -80,13 +86,13 @@ function typedResponse(response) {
 }
 function ensureStringBody(body) {
   if (typeof body === "undefined")
-    return;
+    return body;
   if (typeof body === "string")
     return body;
-  return JSON.stringify(body);
+  return ["number", "boolean", "array", "object"].includes(typeOf(body)) ? JSON.stringify(body) : body;
 }
-async function enhancedFetch(input, requestInit) {
-  var _a;
+async function enhancedFetch(url, requestInit) {
+  var _a, _b;
   const { query, trace, ...reqInit } = requestInit != null ? requestInit : {};
   const headers = mergeHeaders(
     {
@@ -94,11 +100,12 @@ async function enhancedFetch(input, requestInit) {
     },
     (_a = reqInit.headers) != null ? _a : {}
   );
-  const url = addQueryToInput(input, query);
+  const withParams = replaceUrlParams(url, (_b = reqInit.params) != null ? _b : {});
+  const fullUrl = addQueryToUrl(withParams, query);
   const body = ensureStringBody(reqInit.body);
   const enhancedReqInit = { ...reqInit, headers, body };
-  trace == null ? void 0 : trace(url, enhancedReqInit);
-  const response = await fetch(url, enhancedReqInit);
+  trace == null ? void 0 : trace(fullUrl, enhancedReqInit);
+  const response = await fetch(fullUrl, enhancedReqInit);
   return typedResponse(response);
 }
 function makeService(baseURL, baseHeaders) {
@@ -109,21 +116,23 @@ function makeService(baseURL, baseHeaders) {
       const response = await enhancedFetch(url, {
         ...requestInit,
         method,
-        headers: mergeHeaders(baseHeaders != null ? baseHeaders : {}, (_a = requestInit == null ? void 0 : requestInit.headers) != null ? _a : {})
+        headers: mergeHeaders(
+          typeof baseHeaders === "function" ? await baseHeaders() : baseHeaders != null ? baseHeaders : {},
+          (_a = requestInit == null ? void 0 : requestInit.headers) != null ? _a : {}
+        )
       });
       return response;
     };
   };
-  return new Proxy({}, {
-    get(_target, prop) {
-      if (isHTTPMethod(prop))
-        return service(prop.toUpperCase());
-      throw new Error(`Invalid HTTP method: ${prop.toString()}`);
-    }
-  });
+  let api = {};
+  for (const method of HTTP_METHODS) {
+    const lowerMethod = method.toLowerCase();
+    api[lowerMethod] = service(method);
+  }
+  return api;
 }
 export {
-  addQueryToInput,
+  addQueryToUrl,
   enhancedFetch,
   ensureStringBody,
   makeGetApiUrl,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "make-service",
-  "version": "0.1.0",
+  "version": "1.0.0-next.0",
   "description": "Some utilities to extend the 'fetch' API to better interact with external APIs.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",