make-service 0.2.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.
 
@@ -153,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 `url` 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" },
+  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

@@ -24,7 +24,7 @@ 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;
@@ -55,10 +55,6 @@ declare function mergeHeaders(...entries: (HeadersInit | [string, undefined][] |
  * @returns the url with the query parameters added with the same type as the url
  */
 declare function addQueryToUrl(url: string | URL, searchParams?: SearchParams): string | URL;
-/**
- * @deprecated method renamed to addQueryToUrl
- */
-declare const addQueryToInput: typeof addQueryToUrl;
 /**
  * @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
@@ -81,9 +77,9 @@ 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 url a string or URL to be fetched
@@ -110,6 +106,6 @@ declare function enhancedFetch(url: string | URL, requestInit?: EnhancedRequestI
  * const users = await response.json(userSchema);
  * //    ^? User[]
  */
-declare function makeService(baseURL: string | URL, baseHeaders?: HeadersInit): Record<"delete" | "get" | "post" | "put" | "patch" | "options" | "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, PathParams, Schema, SearchParams, ServiceRequestInit, TypedResponse, TypedResponseJson, TypedResponseText, addQueryToInput, addQueryToUrl, 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,6 @@ 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,
@@ -45,9 +44,6 @@ var HTTP_METHODS = [
 // 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;
   };
@@ -67,6 +63,9 @@ function replaceUrlParams(url, params) {
   });
   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
 function mergeHeaders(...entries) {
@@ -99,7 +98,6 @@ function addQueryToUrl(url, searchParams) {
   }
   return url;
 }
-var addQueryToInput = addQueryToUrl;
 function makeGetApiUrl(baseURL) {
   const base = baseURL instanceof URL ? baseURL.toString() : baseURL;
   return (path, searchParams) => {
@@ -120,10 +118,10 @@ 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(url, requestInit) {
   var _a, _b;
@@ -150,7 +148,10 @@ 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;
     };
@@ -164,7 +165,6 @@ function makeService(baseURL, baseHeaders) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  addQueryToInput,
   addQueryToUrl,
   enhancedFetch,
   ensureStringBody,

package/dist/index.mjs

@@ -12,9 +12,6 @@ var HTTP_METHODS = [
 // 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;
   };
@@ -34,6 +31,9 @@ function replaceUrlParams(url, params) {
   });
   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
 function mergeHeaders(...entries) {
@@ -66,7 +66,6 @@ function addQueryToUrl(url, searchParams) {
   }
   return url;
 }
-var addQueryToInput = addQueryToUrl;
 function makeGetApiUrl(baseURL) {
   const base = baseURL instanceof URL ? baseURL.toString() : baseURL;
   return (path, searchParams) => {
@@ -87,10 +86,10 @@ 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(url, requestInit) {
   var _a, _b;
@@ -117,7 +116,10 @@ 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;
     };
@@ -130,7 +132,6 @@ function makeService(baseURL, baseHeaders) {
   return api;
 }
 export {
-  addQueryToInput,
   addQueryToUrl,
   enhancedFetch,
   ensureStringBody,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "make-service",
-  "version": "0.2.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",