make-service 2.0.0 → 2.1.1

package/README.md

@@ -1,3 +1,7 @@
+[![NPM](https://img.shields.io/npm/v/make-service)](https://www.npmjs.org/package/make-service)
+![Library size](https://img.shields.io/bundlephobia/minzip/make-service)
+[![All Contributors](https://img.shields.io/github/all-contributors/gustavoguichard/make-service?color=0375b6&style=flat-square)](#contributors)
+
 # make-service
 
 A type-safe thin wrapper around the `fetch` API to better interact with external APIs.
@@ -580,9 +584,31 @@ const url = replaceURLParams(
 
 The params will be **strongly-typed** which means they will be validated against the URL structure and will not type-check if the given object does not match that structure.
 
+# Contributors
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/gustavoguichard"><img src="https://avatars.githubusercontent.com/u/566971?v=4?s=100" width="100px;" alt="Guga Guichard"/><br /><sub><b>Guga Guichard</b></sub></a><br /><a href="#code-gustavoguichard" title="Code">💻</a> <a href="#projectManagement-gustavoguichard" title="Project Management">📆</a> <a href="#promotion-gustavoguichard" title="Promotion">📣</a> <a href="#maintenance-gustavoguichard" title="Maintenance">🚧</a> <a href="#doc-gustavoguichard" title="Documentation">📖</a> <a href="#bug-gustavoguichard" title="Bug reports">🐛</a> <a href="#infra-gustavoguichard" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#question-gustavoguichard" title="Answering Questions">💬</a> <a href="#research-gustavoguichard" title="Research">🔬</a> <a href="#review-gustavoguichard" title="Reviewed Pull Requests">👀</a> <a href="#ideas-gustavoguichard" title="Ideas, Planning, & Feedback">🤔</a> <a href="#example-gustavoguichard" title="Examples">💡</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/danielweinmann"><img src="https://avatars.githubusercontent.com/u/204765?v=4?s=100" width="100px;" alt="Daniel Weinmann"/><br /><sub><b>Daniel Weinmann</b></sub></a><br /><a href="#code-danielweinmann" title="Code">💻</a> <a href="#promotion-danielweinmann" title="Promotion">📣</a> <a href="#ideas-danielweinmann" title="Ideas, Planning, & Feedback">🤔</a> <a href="#doc-danielweinmann" title="Documentation">📖</a> <a href="#bug-danielweinmann" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/diogob"><img src="https://avatars.githubusercontent.com/u/20662?v=4?s=100" width="100px;" alt="Diogo Biazus"/><br /><sub><b>Diogo Biazus</b></sub></a><br /><a href="#code-diogob" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/garusis"><img src="https://avatars.githubusercontent.com/u/15615652?v=4?s=100" width="100px;" alt="Marcos Javier Alvarez Maestre"/><br /><sub><b>Marcos Javier Alvarez Maestre</b></sub></a><br /><a href="#code-garusis" title="Code">💻</a> <a href="#bug-garusis" title="Bug reports">🐛</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
 # Acknowledgements
 This library is part of a code I've been carrying around for a while through many projects.
 
+- [Seasoned](https://github.com/seasonedcc) - for backing my work and allowing me testing it on big codebases when I started sketching this API.
 - [croods](https://github.com/seasonedcc/croods) by [@danielweinmann](https://github.com/danielweinmann) - a react data-layer library from pre-ReactQuery/pre-SWR era - gave me ideas and experience dealing with APIs after spending a lot of time in that codebase.
 - [zod](https://zod.dev/) by [@colinhacks](https://github.com/colinhacks) changed my mindset about how to deal with external data.
 - [zod-fetch](https://github.com/mattpocock/zod-fetch) by [@mattpocock](https://github.com/mattpocock) for the inspiration, when I realized I had a similar solution that could be extracted and be available for everyone to use.

package/dist/index.d.ts

@@ -3,9 +3,9 @@ declare const HTTP_METHODS: readonly ["GET", "POST", "PUT", "DELETE", "PATCH", "
 type Schema<T> = {
     parse: (d: unknown) => T;
 };
-type JSONValue = string | number | boolean | {
-    [x: string]: JSONValue;
-} | Array<JSONValue>;
+type JSONValue = string | number | boolean | Date | {
+    [x: string]: JSONValue | undefined | null;
+} | Array<JSONValue | undefined | null>;
 type SearchParams = ConstructorParameters<typeof URLSearchParams>[0];
 type TypedResponse = Omit<Response, 'json' | 'text'> & {
     json: TypedResponseJson;
@@ -110,7 +110,7 @@ declare function makeService(baseURL: string | URL, baseOptions?: BaseOptions):
  * @param searchParams the query parameters
  * @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;
+declare function addQueryToURL<T extends string | URL>(url: T, searchParams?: SearchParams): T;
 /**
  * @param body the JSON-like body of the request
  * @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.
@@ -134,5 +134,11 @@ declare function mergeHeaders(...entries: (HeadersInit | [string, undefined][] |
  * @returns the url with the params replaced and with the same type as the given url
  */
 declare function replaceURLParams<T extends string | URL>(url: T, params: PathParams<T>): T;
+/**
+ * This is an enhanced version of the typeof operator to check the type of more complex values.
+ * @param t the value to be checked
+ * @returns the type of the value
+ */
+declare function typeOf(t: unknown): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "url" | "blob" | "array" | "arraybuffer" | "formdata" | "null" | "readablestream" | "urlsearchparams";
 
-export { BaseOptions, EnhancedRequestInit, GetJson, GetText, HTTPMethod, JSONValue, PathParams, RequestTransformer, ResponseTransformer, Schema, SearchParams, ServiceRequestInit, TypedResponse, TypedResponseJson, TypedResponseText, addQueryToURL, enhancedFetch, ensureStringBody, makeFetcher, makeGetApiURL, makeService, mergeHeaders, replaceURLParams, typedResponse };
+export { BaseOptions, EnhancedRequestInit, GetJson, GetText, HTTPMethod, JSONValue, PathParams, RequestTransformer, ResponseTransformer, Schema, SearchParams, ServiceRequestInit, TypedResponse, TypedResponseJson, TypedResponseText, addQueryToURL, enhancedFetch, ensureStringBody, makeFetcher, makeGetApiURL, makeService, mergeHeaders, replaceURLParams, typeOf, typedResponse };

package/dist/index.js

@@ -28,6 +28,7 @@ __export(src_exports, {
   makeService: () => makeService,
   mergeHeaders: () => mergeHeaders,
   replaceURLParams: () => replaceURLParams,
+  typeOf: () => typeOf,
   typedResponse: () => typedResponse
 });
 module.exports = __toCommonJS(src_exports);
@@ -54,9 +55,6 @@ var getText = (response) => async (schema) => {
   const text = await response.text();
   return schema ? schema.parse(text) : text;
 };
-function typeOf(t) {
-  return Object.prototype.toString.call(t).replace(/^\[object (.+)\]$/, "$1").toLowerCase();
-}
 
 // src/primitives.ts
 function addQueryToURL(url, searchParams) {
@@ -67,9 +65,7 @@ function addQueryToURL(url, searchParams) {
     return `${url}${separator}${new URLSearchParams(searchParams)}`;
   }
   if (searchParams && url instanceof URL) {
-    for (const [key, value] of Object.entries(
-      new URLSearchParams(searchParams)
-    )) {
+    for (const [key, value] of new URLSearchParams(searchParams).entries()) {
       url.searchParams.set(key, value);
     }
   }
@@ -112,6 +108,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/api.ts
 var identity = (value) => value;
@@ -192,5 +191,6 @@ function makeService(baseURL, baseOptions) {
   makeService,
   mergeHeaders,
   replaceURLParams,
+  typeOf,
   typedResponse
 });

package/dist/index.mjs

@@ -20,9 +20,6 @@ var getText = (response) => async (schema) => {
   const text = await response.text();
   return schema ? schema.parse(text) : text;
 };
-function typeOf(t) {
-  return Object.prototype.toString.call(t).replace(/^\[object (.+)\]$/, "$1").toLowerCase();
-}
 
 // src/primitives.ts
 function addQueryToURL(url, searchParams) {
@@ -33,9 +30,7 @@ function addQueryToURL(url, searchParams) {
     return `${url}${separator}${new URLSearchParams(searchParams)}`;
   }
   if (searchParams && url instanceof URL) {
-    for (const [key, value] of Object.entries(
-      new URLSearchParams(searchParams)
-    )) {
+    for (const [key, value] of new URLSearchParams(searchParams).entries()) {
       url.searchParams.set(key, value);
     }
   }
@@ -78,6 +73,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/api.ts
 var identity = (value) => value;
@@ -157,5 +155,6 @@ export {
   makeService,
   mergeHeaders,
   replaceURLParams,
+  typeOf,
   typedResponse
 };

package/package.json

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