make-service 3.0.0 → 4.0.0

package/README.md

@@ -6,7 +6,7 @@
 
 A type-safe thin wrapper around the `fetch` API to better interact with external APIs.
 
-It adds a set of little features and allows you to parse responses with [zod](https://github.com/colinhacks/zod).
+It adds a set of little features and allows you to parse responses with [standard-schema libraries](https://standardschema.dev).
 
 ## Features
 - 🤩 Type-safe return of `response.json()` and `response.text()`. Defaults to `unknown` instead of `any`.
@@ -37,6 +37,7 @@ const users = await response.json(usersSchema);
   - [makeService](#makeservice)
     - [Type-checking the response body](#type-checking-the-response-body)
     - [Runtime type-checking and parsing the response body](#runtime-type-checking-and-parsing-the-response-body)
+      - [Dealing with parsing errors](#dealing-with-parsing-errors)
     - [Supported HTTP Verbs](#supported-http-verbs)
     - [Headers](#headers)
       - [Passing a function as `headers`](#passing-a-function-as-headers)
@@ -52,13 +53,14 @@ const users = await response.json(usersSchema);
   - [makeFetcher](#makefetcher)
   - [enhancedFetch](#enhancedfetch)
   - [typedResponse](#typedresponse)
-- [Transform the Payload](#transform-the-payload)
+- [Transform the payload](#transform-the-payload)
 - [Other available primitives](#other-available-primitives)
   - [addQueryToURL](#addquerytourl)
   - [ensureStringBody](#ensurestringbody)
   - [makeGetApiURL](#makegetapiurl)
   - [mergeHeaders](#mergeheaders)
   - [replaceURLParams](#replaceurlparams)
+- [Contributors](#contributors)
 - [Acknowledgements](#acknowledgements)
 
 # Installation
@@ -119,8 +121,8 @@ const content = await response.text<`${string}@${string}`>()
 ```
 
 ### Runtime type-checking and parsing the response body
-Its [`typedResponse`](#typedresponse) can also be parsed with a zod schema. Here follows a little more complex example:
 
+Its [`typedResponse`](#typedresponse) can also be parsed with a standard schema parser. Here follows a little more complex example with Zod:
 ```ts
 const response = await service.get("/users")
 const json = await response.json(
@@ -142,6 +144,20 @@ const content = await response.text(z.string().email())
 ```
 You can transform any `Response` in a `TypedResponse` like that by using the [`typedResponse`](#typedresponse) function.
 
+#### Dealing with parsing errors
+If the response body does not match the given schema, it will throw a **ParseResponseError** which will have a message carrying all the parsing issues and its messages. You can catch it to inspect the issues:
+
+```ts
+try {
+  const response = await service.get("/users")
+  return await response.json(userSchema)
+} catch(error) {
+  if (error instanceof ParseResponseError) {
+    console.log(error.issues)
+  }
+}
+```
+
 ### Supported HTTP Verbs
 Other than the `get` it also accepts more HTTP verbs:
 ```ts
@@ -210,8 +226,8 @@ Note: Don't forget headers are case insensitive.
 const headers = new Headers({ 'Content-Type': 'application/json' })
 Object.fromEntries(headers) // equals to: { 'content-type': 'application/json' }
 ```
-All the features above are done by using the [`mergeHeaders`](#mergeheaders) function internally.
 
+All the features above are done by using the [`mergeHeaders`](#mergeheaders) function internally.
 
 ### Base URL
 The service function can receive a `string` or `URL` as base `url` and it will be able to merge them correctly with the given path:
@@ -231,16 +247,28 @@ You can use the [`makeGetApiUrl`](#makegetapiurl) method to do that kind of URL
 `makeService` can also receive `requestTransformer` and `responseTransformer` as options that will be applied to all requests.
 
 #### Request transformers
-You can transform the request in any way you want, like:
+You can transform the request in any way you want passing a transformer function as a parameter. This will be applied to all requests for that service.
+A useful example is to implement a global request timeout for all endpoints of a service:
 
 ```ts
-const service = makeService('https://example.com/api', {
-  requestTransformer: (request) => ({ ...request, query: { admin: 'true' } }),
-})
+function timeoutRequestIn30Seconds(
+  request: EnhancedRequestInit<string>,
+): EnhancedRequestInit<string> {
+  const terminator = new AbortController()
+  terminator.signal.throwIfAborted()
+  setTimeout(() => terminator.abort(), 30000)
+
+  return {
+    ...request,
+    signal: terminator.signal,
+  }
+}
+
+const service = makeService('https://example.com/api', { requestTransformer: timeoutRequestIn30Seconds })
 
 const response = await service.get("/users")
 
-// It will call "https://example.com/api/users?admin=true"
+// It will call "https://example.com/api/users" aborting (and throwing an exception) if it takes more than 30 seconds.
 ```
 
 Please note that the `headers` option will be applied _after_ the request transformer runs. If you're using a request transformer, we recommend adding custom headers inside your transformer instead of using both options.
@@ -408,11 +436,14 @@ await enhancedFetch("https://example.com/api/users/:role", {
 //   method: 'POST',
 //   body: '{"some":{"object":{"as":{"body":{}}}}}',
 // }
+// Response {}
 ```
 
+The `trace` function can also return a `Promise<void>` in order to send traces to an external service or database.
+
 ## typedResponse
 
-A type-safe wrapper around the `Response` object. It adds a `json` and `text` method that will parse the response with a given zod schema. If you don't provide a schema, it will return `unknown` instead of `any`, then you can also give it a generic to type cast the result.
+A type-safe wrapper around the `Response` object. It adds a `json` and `text` method that will parse the response with a given standard schema library. If you don't provide a schema, it will return `unknown` instead of `any`, then you can also give it a generic to type cast the result.
 
 ```ts
 import { typedResponse } from 'make-service'
@@ -446,11 +477,11 @@ import { deepCamelKeys, deepKebabKeys } from 'string-ts'
 
 const service = makeService("https://example.com/api")
 const response = service.get("/users")
-const users = await response.json(
+const json = await response.json(
   z
     .array(z.object({ "first-name": z.string(), contact: z.object({ "home-address": z.string() }) }))
-    .transform(deepCamelKeys)
 )
+const users = deepCamelKeys(json)
 console.log(users)
 //          ^? { firstName: string, contact: { homeAddress: string } }[]
 
@@ -525,7 +556,7 @@ You create a `getApiURL` function by giving it a `baseURL` and then it accepts a
 import { makeGetApiURL } from 'make-service'
 
 const getApiURL = makeGetApiURL("https://example.com/api")
-const url = getApiURL("/users?admin=true", { query: { page: "2" } })
+const url = getApiURL("/users?admin=true", { page: "2" })
 
 // "https://example.com/api/users?admin=true&page=2"
 ```
@@ -589,10 +620,10 @@ The params will be **strongly-typed** which means they will be validated against
   <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://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> <a href="#review-danielweinmann" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://luca.md"><img src="https://avatars.githubusercontent.com/u/1881266?v=4?s=100" width="100px;" alt="Andrei Luca"/><br /><sub><b>Andrei Luca</b></sub></a><br /><a href="#doc-iamandrewluca" title="Documentation">📖</a> <a href="#code-iamandrewluca" title="Code">💻</a> <a href="#promotion-iamandrewluca" title="Promotion">📣</a> <a href="#maintenance-iamandrewluca" title="Maintenance">🚧</a> <a href="#bug-iamandrewluca" title="Bug reports">🐛</a> <a href="#ideas-iamandrewluca" title="Ideas, Planning, & Feedback">🤔</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> <a href="#doc-diogob" title="Documentation">📖</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>
-      <td align="center" valign="top" width="14.28%"><a href="https://luca.md"><img src="https://avatars.githubusercontent.com/u/1881266?v=4?s=100" width="100px;" alt="Andrei Luca"/><br /><sub><b>Andrei Luca</b></sub></a><br /><a href="#doc-iamandrewluca" title="Documentation">📖</a></td>
     </tr>
   </tbody>
 </table>

package/dist/index.d.mts

@@ -0,0 +1,151 @@
+import { StandardSchemaV1 } from 'zod/lib/standard-schema';
+import { StandardSchemaV1 as StandardSchemaV1$1 } from '@standard-schema/spec';
+
+declare const HTTP_METHODS: readonly ["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD", "CONNECT"];
+
+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;
+    text: TypedResponseText;
+};
+type PathParams<T> = T extends string ? ExtractPathParams<T> extends Record<string, unknown> ? ExtractPathParams<T> : Record<string, string | number> : Record<string, string | number>;
+type EnhancedRequestInit<T = string> = Omit<RequestInit, 'body' | 'method'> & {
+    method?: HTTPMethod | Lowercase<HTTPMethod>;
+    body?: JSONValue | BodyInit | null;
+    query?: SearchParams;
+    params?: PathParams<T>;
+    trace?: (fullUrl: string | URL, init: EnhancedRequestInit, response: TypedResponse) => void | Promise<void>;
+};
+type ServiceRequestInit<T = string> = Omit<EnhancedRequestInit<T>, 'method'>;
+type RequestTransformer = (request: EnhancedRequestInit) => EnhancedRequestInit | Promise<EnhancedRequestInit>;
+type ResponseTransformer = (response: TypedResponse) => TypedResponse | Promise<TypedResponse>;
+type BaseOptions = {
+    headers?: HeadersInit | (() => HeadersInit | Promise<HeadersInit>);
+    requestTransformer?: RequestTransformer;
+    responseTransformer?: ResponseTransformer;
+};
+type HTTPMethod = (typeof HTTP_METHODS)[number];
+type TypedResponseJson = <T = unknown>(schema?: StandardSchemaV1<T>) => Promise<T>;
+type TypedResponseText = <T extends string = string>(schema?: StandardSchemaV1<T>) => Promise<T>;
+type GetJson = (response: Response) => TypedResponseJson;
+type GetText = (response: Response) => TypedResponseText;
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type ExtractPathParams<T extends string> = T extends `${infer _}:${infer Param}/${infer Rest}` ? Prettify<Omit<{
+    [K in Param]: string | number;
+} & ExtractPathParams<Rest>, ''>> : T extends `${infer _}:${infer Param}` ? {
+    [K in Param]: string | number;
+} : {};
+
+/**
+ * It hacks the Response object to add typed json and text methods
+ * @param response the Response to be proxied
+ * @returns a Response with typed json and text methods
+ * @example const response = await fetch("https://example.com/api/users");
+ * const users = await response.json(userSchema);
+ * //    ^? User[]
+ * const untyped = await response.json();
+ * //    ^? unknown
+ * const text = await response.text();
+ * //    ^? string
+ * const typedJson = await response.json<User[]>();
+ * //    ^? User[]
+ */
+declare function typedResponse(response: Response, options?: {
+    getJson?: GetJson;
+    getText?: GetText;
+}): TypedResponse;
+/**
+ *
+ * @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
+ * @param requestInit.trace a function that receives the URL, the requestInit and a clone of the response in order to log or troubleshoot the request
+ * @returns a Response with typed json and text methods
+ * @example const response = await fetch("https://example.com/api/users");
+ * const users = await response.json(userSchema);
+ * //    ^? User[]
+ * const untyped = await response.json();
+ * //    ^? unknown
+ */
+declare function enhancedFetch<T extends string | URL>(url: T, requestInit?: EnhancedRequestInit<T>): Promise<TypedResponse>;
+/**
+ *
+ * @param baseURL the base URL to be fetched in every request
+ * @param baseOptions options that will be applied to all requests
+ * @param baseOptions.headers any headers that should be sent with every request
+ * @param baseOptions.requestTransformer a function that will transform the enhanced request init of every request
+ * @param baseOptions.responseTransformer a function that will transform the typed response of every request
+ * @returns a function that receive a path and requestInit and return a serialized json response that can be typed or not.
+ * @example const headers = { Authorization: "Bearer 123" }
+ * const fetcher = makeFetcher("https://example.com/api", headers);
+ * const response = await fetcher("/users", { method: "GET" })
+ * const users = await response.json(userSchema);
+ * //    ^? User[]
+ */
+declare function makeFetcher(baseURL: string | URL, baseOptions?: BaseOptions): <T extends string>(path: T, requestInit?: EnhancedRequestInit<T>) => Promise<TypedResponse>;
+/**
+ *
+ * @param baseURL the base URL to the API
+ * @param baseOptions options that will be applied to all requests
+ * @param baseOptions.headers any headers that should be sent with every request
+ * @param baseOptions.requestTransformer a function that will transform the enhanced request init of every request
+ * @param baseOptions.responseTransformer a function that will transform the typed response of every request
+ * @returns a service object with HTTP methods that are functions that receive a path and requestInit and return a serialized json response that can be typed or not.
+ * @example const headers = { Authorization: "Bearer 123" }
+ * const api = makeService("https://example.com/api", headers);
+ * const response = await api.get("/users")
+ * const users = await response.json(userSchema);
+ * //    ^? User[]
+ */
+declare function makeService(baseURL: string | URL, baseOptions?: BaseOptions): Record<"get" | "post" | "put" | "delete" | "patch" | "options" | "head" | "connect", <T extends string>(path: T, requestInit?: ServiceRequestInit<T>) => Promise<TypedResponse>>;
+
+/**
+ * @param url a string or URL to which the query parameters will be added
+ * @param searchParams the query parameters
+ * @returns the url with the query parameters added with the same type as the 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.
+ */
+declare function ensureStringBody<B extends JSONValue | BodyInit | null>(body?: B): B extends JSONValue ? string : B;
+/**
+ * @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
+ */
+declare function makeGetApiURL<T extends string | URL>(baseURL: T): (path: string, searchParams?: SearchParams) => T;
+/**
+ * It merges multiple HeadersInit objects into a single Headers object
+ * @param entries Any number of HeadersInit objects
+ * @returns a new Headers object with the merged headers
+ */
+declare function mergeHeaders(...entries: (HeadersInit | [string, undefined][] | Record<string, undefined>)[]): Headers;
+/**
+ *
+ * @param url the url string or URL object to replace the params
+ * @param params the params map to be replaced in the url
+ * @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): "array" | "arraybuffer" | "bigint" | "blob" | "boolean" | "formdata" | "function" | "null" | "number" | "object" | "readablestream" | "string" | "symbol" | "undefined" | "url" | "urlsearchparams";
+/**
+ * Error thrown when the response cannot be parsed.
+ */
+declare class ParseResponseError extends Error {
+    issues: readonly StandardSchemaV1$1.Issue[];
+    constructor(message: string, issues: readonly StandardSchemaV1$1.Issue[]);
+}
+
+export { type BaseOptions, type EnhancedRequestInit, type GetJson, type GetText, type HTTPMethod, type JSONValue, ParseResponseError, type PathParams, type RequestTransformer, type ResponseTransformer, type SearchParams, type ServiceRequestInit, type TypedResponse, type TypedResponseJson, type TypedResponseText, addQueryToURL, enhancedFetch, ensureStringBody, makeFetcher, makeGetApiURL, makeService, mergeHeaders, replaceURLParams, typeOf, typedResponse };

package/dist/index.d.ts

@@ -1,8 +1,8 @@
+import { StandardSchemaV1 } from 'zod/lib/standard-schema';
+import { StandardSchemaV1 as StandardSchemaV1$1 } from '@standard-schema/spec';
+
 declare const HTTP_METHODS: readonly ["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD", "CONNECT"];
 
-type Schema<T> = {
-    parse: (d: unknown) => T;
-};
 type JSONValue = string | number | boolean | Date | {
     [x: string]: JSONValue | undefined | null;
 } | Array<JSONValue | undefined | null>;
@@ -11,13 +11,13 @@ type TypedResponse = Omit<Response, 'json' | 'text'> & {
     json: TypedResponseJson;
     text: TypedResponseText;
 };
-type PathParams<T> = T extends string ? ExtractPathParams<T> extends Record<string, unknown> ? ExtractPathParams<T> : Record<string, string> : Record<string, string>;
+type PathParams<T> = T extends string ? ExtractPathParams<T> extends Record<string, unknown> ? ExtractPathParams<T> : Record<string, string | number> : Record<string, string | number>;
 type EnhancedRequestInit<T = string> = Omit<RequestInit, 'body' | 'method'> & {
     method?: HTTPMethod | Lowercase<HTTPMethod>;
     body?: JSONValue | BodyInit | null;
     query?: SearchParams;
     params?: PathParams<T>;
-    trace?: (...args: Parameters<typeof fetch>) => void;
+    trace?: (fullUrl: string | URL, init: EnhancedRequestInit, response: TypedResponse) => void | Promise<void>;
 };
 type ServiceRequestInit<T = string> = Omit<EnhancedRequestInit<T>, 'method'>;
 type RequestTransformer = (request: EnhancedRequestInit) => EnhancedRequestInit | Promise<EnhancedRequestInit>;
@@ -28,17 +28,17 @@ type BaseOptions = {
     responseTransformer?: ResponseTransformer;
 };
 type HTTPMethod = (typeof HTTP_METHODS)[number];
-type TypedResponseJson = <T = unknown>(schema?: Schema<T>) => Promise<T>;
-type TypedResponseText = <T extends string = string>(schema?: Schema<T>) => Promise<T>;
+type TypedResponseJson = <T = unknown>(schema?: StandardSchemaV1<T>) => Promise<T>;
+type TypedResponseText = <T extends string = string>(schema?: StandardSchemaV1<T>) => Promise<T>;
 type GetJson = (response: Response) => TypedResponseJson;
 type GetText = (response: Response) => TypedResponseText;
 type Prettify<T> = {
     [K in keyof T]: T[K];
 } & {};
 type ExtractPathParams<T extends string> = T extends `${infer _}:${infer Param}/${infer Rest}` ? Prettify<Omit<{
-    [K in Param]: string;
+    [K in Param]: string | number;
 } & ExtractPathParams<Rest>, ''>> : T extends `${infer _}:${infer Param}` ? {
-    [K in Param]: string;
+    [K in Param]: string | number;
 } : {};
 
 /**
@@ -65,7 +65,7 @@ declare function typedResponse(response: Response, options?: {
  * @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
- * @param requestInit.trace a function that receives the URL and the requestInit and can be used to log the request
+ * @param requestInit.trace a function that receives the URL, the requestInit and a clone of the response in order to log or troubleshoot the request
  * @returns a Response with typed json and text methods
  * @example const response = await fetch("https://example.com/api/users");
  * const users = await response.json(userSchema);
@@ -139,6 +139,13 @@ declare function replaceURLParams<T extends string | URL>(url: T, params: PathPa
  * @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";
+declare function typeOf(t: unknown): "array" | "arraybuffer" | "bigint" | "blob" | "boolean" | "formdata" | "function" | "null" | "number" | "object" | "readablestream" | "string" | "symbol" | "undefined" | "url" | "urlsearchparams";
+/**
+ * Error thrown when the response cannot be parsed.
+ */
+declare class ParseResponseError extends Error {
+    issues: readonly StandardSchemaV1$1.Issue[];
+    constructor(message: string, issues: readonly StandardSchemaV1$1.Issue[]);
+}
 
-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 };
+export { type BaseOptions, type EnhancedRequestInit, type GetJson, type GetText, type HTTPMethod, type JSONValue, ParseResponseError, type PathParams, type RequestTransformer, type ResponseTransformer, type SearchParams, type ServiceRequestInit, type TypedResponse, type TypedResponseJson, type TypedResponseText, addQueryToURL, enhancedFetch, ensureStringBody, makeFetcher, makeGetApiURL, makeService, mergeHeaders, replaceURLParams, typeOf, typedResponse };

package/dist/index.js

@@ -18,8 +18,9 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
+  ParseResponseError: () => ParseResponseError,
   addQueryToURL: () => addQueryToURL,
   enhancedFetch: () => enhancedFetch,
   ensureStringBody: () => ensureStringBody,
@@ -31,7 +32,7 @@ __export(src_exports, {
   typeOf: () => typeOf,
   typedResponse: () => typedResponse
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/constants.ts
 var HTTP_METHODS = [
@@ -46,20 +47,9 @@ var HTTP_METHODS = [
   // 'TRACE', it has no support in most browsers yet
 ];
 
-// src/internals.ts
-var getJson = (response) => async (schema) => {
-  const json = await response.json();
-  return schema ? schema.parse(json) : json;
-};
-var getText = (response) => async (schema) => {
-  const text = await response.text();
-  return schema ? schema.parse(text) : text;
-};
-
 // src/primitives.ts
 function addQueryToURL(url, searchParams) {
-  if (!searchParams)
-    return url;
+  if (!searchParams) return url;
   if (typeof url === "string") {
     const separator = url.includes("?") ? "&" : "?";
     return `${url}${separator}${new URLSearchParams(searchParams)}`;
@@ -72,10 +62,8 @@ function addQueryToURL(url, searchParams) {
   return url;
 }
 function ensureStringBody(body) {
-  if (typeof body === "undefined")
-    return body;
-  if (typeof body === "string")
-    return body;
+  if (typeof body === "undefined") return body;
+  if (typeof body === "string") return body;
   return ["number", "boolean", "array", "object"].includes(typeOf(body)) ? JSON.stringify(body) : body;
 }
 function makeGetApiURL(baseURL) {
@@ -86,7 +74,7 @@ function makeGetApiURL(baseURL) {
   };
 }
 function mergeHeaders(...entries) {
-  const result = /* @__PURE__ */ new Map();
+  const result = new Headers();
   for (const entry of entries) {
     const headers = new Headers(entry);
     for (const [key, value] of headers.entries()) {
@@ -97,11 +85,10 @@ function mergeHeaders(...entries) {
       }
     }
   }
-  return new Headers(Array.from(result.entries()));
+  return result;
 }
 function replaceURLParams(url, params) {
-  if (!params)
-    return url;
+  if (!params) return url;
   let urlString = String(url);
   Object.entries(params).forEach(([key, value]) => {
     urlString = urlString.replace(new RegExp(`:${key}($|/)`), `${value}$1`);
@@ -111,19 +98,44 @@ function replaceURLParams(url, params) {
 function typeOf(t) {
   return Object.prototype.toString.call(t).replace(/^\[object (.+)\]$/, "$1").toLowerCase();
 }
+var ParseResponseError = class extends Error {
+  constructor(message, issues) {
+    super(JSON.stringify({ message, issues }, null, 2));
+    this.issues = issues;
+    this.name = "ParseResponseError";
+    this.issues = issues;
+  }
+};
+
+// src/internals.ts
+var getJson = (response) => async (schema) => {
+  const json = await response.json();
+  if (!schema) return json;
+  const result = await schema["~standard"].validate(json);
+  if (result.issues) {
+    throw new ParseResponseError("Failed to parse response.json", result.issues);
+  }
+  return result.value;
+};
+var getText = (response) => async (schema) => {
+  const text = await response.text();
+  if (!schema) return text;
+  const result = await schema["~standard"].validate(text);
+  if (result.issues) {
+    throw new ParseResponseError("Failed to parse response.text", result.issues);
+  }
+  return result.value;
+};
 
 // src/api.ts
 var identity = (value) => value;
 function typedResponse(response, options) {
-  var _a, _b;
-  const getJsonFn = (_a = options == null ? void 0 : options.getJson) != null ? _a : getJson;
-  const getTextFn = (_b = options == null ? void 0 : options.getText) != null ? _b : getText;
+  const getJsonFn = options?.getJson ?? getJson;
+  const getTextFn = options?.getText ?? getText;
   return new Proxy(response, {
     get(target, prop) {
-      if (prop === "json")
-        return getJsonFn(target);
-      if (prop === "text")
-        return getTextFn(target);
+      if (prop === "json") return getJsonFn(target);
+      if (prop === "text") return getTextFn(target);
       const value = Reflect.get(target, prop);
       if (typeof value === "function") {
         return value.bind(target);
@@ -133,32 +145,28 @@ function typedResponse(response, options) {
   });
 }
 async function enhancedFetch(url, requestInit) {
-  var _a;
-  const { query, trace, ...reqInit } = requestInit != null ? requestInit : {};
+  const { query, trace, ...reqInit } = requestInit ?? {};
   const body = ensureStringBody(reqInit.body);
-  const withParams = replaceURLParams(url, (_a = reqInit.params) != null ? _a : {});
+  const withParams = replaceURLParams(url, reqInit.params ?? {});
   const fullURL = addQueryToURL(withParams, query);
   const enhancedReqInit = { ...reqInit, body };
-  trace == null ? void 0 : trace(fullURL, enhancedReqInit);
   const response = await fetch(fullURL, enhancedReqInit);
+  await trace?.(fullURL, enhancedReqInit, typedResponse(response.clone()));
   return typedResponse(response);
 }
 function makeFetcher(baseURL, baseOptions = {}) {
   return async (path, requestInit = {}) => {
-    var _a, _b;
     const { headers } = baseOptions;
-    const requestTransformer = (_a = baseOptions.requestTransformer) != null ? _a : identity;
-    const responseTransformer = (_b = baseOptions.responseTransformer) != null ? _b : identity;
-    const headerTransformer = async (ri) => {
-      var _a2;
-      return {
-        ...ri,
-        headers: mergeHeaders(
-          typeof headers === "function" ? await headers() : headers != null ? headers : {},
-          (_a2 = requestInit == null ? void 0 : requestInit.headers) != null ? _a2 : {}
-        )
-      };
-    };
+    const requestTransformer = baseOptions.requestTransformer ?? identity;
+    const responseTransformer = baseOptions.responseTransformer ?? identity;
+    const headerTransformer = async (ri) => ({
+      ...ri,
+      headers: mergeHeaders(
+        typeof headers === "function" ? await headers() : headers ?? {},
+        ri.headers ?? {},
+        requestInit?.headers ?? {}
+      )
+    });
     const url = makeGetApiURL(baseURL)(path);
     const response = await enhancedFetch(
       url,
@@ -181,6 +189,7 @@ function makeService(baseURL, baseOptions) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ParseResponseError,
   addQueryToURL,
   enhancedFetch,
   ensureStringBody,

package/dist/index.mjs

@@ -11,20 +11,9 @@ var HTTP_METHODS = [
   // 'TRACE', it has no support in most browsers yet
 ];
 
-// src/internals.ts
-var getJson = (response) => async (schema) => {
-  const json = await response.json();
-  return schema ? schema.parse(json) : json;
-};
-var getText = (response) => async (schema) => {
-  const text = await response.text();
-  return schema ? schema.parse(text) : text;
-};
-
 // src/primitives.ts
 function addQueryToURL(url, searchParams) {
-  if (!searchParams)
-    return url;
+  if (!searchParams) return url;
   if (typeof url === "string") {
     const separator = url.includes("?") ? "&" : "?";
     return `${url}${separator}${new URLSearchParams(searchParams)}`;
@@ -37,10 +26,8 @@ function addQueryToURL(url, searchParams) {
   return url;
 }
 function ensureStringBody(body) {
-  if (typeof body === "undefined")
-    return body;
-  if (typeof body === "string")
-    return body;
+  if (typeof body === "undefined") return body;
+  if (typeof body === "string") return body;
   return ["number", "boolean", "array", "object"].includes(typeOf(body)) ? JSON.stringify(body) : body;
 }
 function makeGetApiURL(baseURL) {
@@ -51,7 +38,7 @@ function makeGetApiURL(baseURL) {
   };
 }
 function mergeHeaders(...entries) {
-  const result = /* @__PURE__ */ new Map();
+  const result = new Headers();
   for (const entry of entries) {
     const headers = new Headers(entry);
     for (const [key, value] of headers.entries()) {
@@ -62,11 +49,10 @@ function mergeHeaders(...entries) {
       }
     }
   }
-  return new Headers(Array.from(result.entries()));
+  return result;
 }
 function replaceURLParams(url, params) {
-  if (!params)
-    return url;
+  if (!params) return url;
   let urlString = String(url);
   Object.entries(params).forEach(([key, value]) => {
     urlString = urlString.replace(new RegExp(`:${key}($|/)`), `${value}$1`);
@@ -76,19 +62,44 @@ function replaceURLParams(url, params) {
 function typeOf(t) {
   return Object.prototype.toString.call(t).replace(/^\[object (.+)\]$/, "$1").toLowerCase();
 }
+var ParseResponseError = class extends Error {
+  constructor(message, issues) {
+    super(JSON.stringify({ message, issues }, null, 2));
+    this.issues = issues;
+    this.name = "ParseResponseError";
+    this.issues = issues;
+  }
+};
+
+// src/internals.ts
+var getJson = (response) => async (schema) => {
+  const json = await response.json();
+  if (!schema) return json;
+  const result = await schema["~standard"].validate(json);
+  if (result.issues) {
+    throw new ParseResponseError("Failed to parse response.json", result.issues);
+  }
+  return result.value;
+};
+var getText = (response) => async (schema) => {
+  const text = await response.text();
+  if (!schema) return text;
+  const result = await schema["~standard"].validate(text);
+  if (result.issues) {
+    throw new ParseResponseError("Failed to parse response.text", result.issues);
+  }
+  return result.value;
+};
 
 // src/api.ts
 var identity = (value) => value;
 function typedResponse(response, options) {
-  var _a, _b;
-  const getJsonFn = (_a = options == null ? void 0 : options.getJson) != null ? _a : getJson;
-  const getTextFn = (_b = options == null ? void 0 : options.getText) != null ? _b : getText;
+  const getJsonFn = options?.getJson ?? getJson;
+  const getTextFn = options?.getText ?? getText;
   return new Proxy(response, {
     get(target, prop) {
-      if (prop === "json")
-        return getJsonFn(target);
-      if (prop === "text")
-        return getTextFn(target);
+      if (prop === "json") return getJsonFn(target);
+      if (prop === "text") return getTextFn(target);
       const value = Reflect.get(target, prop);
       if (typeof value === "function") {
         return value.bind(target);
@@ -98,32 +109,28 @@ function typedResponse(response, options) {
   });
 }
 async function enhancedFetch(url, requestInit) {
-  var _a;
-  const { query, trace, ...reqInit } = requestInit != null ? requestInit : {};
+  const { query, trace, ...reqInit } = requestInit ?? {};
   const body = ensureStringBody(reqInit.body);
-  const withParams = replaceURLParams(url, (_a = reqInit.params) != null ? _a : {});
+  const withParams = replaceURLParams(url, reqInit.params ?? {});
   const fullURL = addQueryToURL(withParams, query);
   const enhancedReqInit = { ...reqInit, body };
-  trace == null ? void 0 : trace(fullURL, enhancedReqInit);
   const response = await fetch(fullURL, enhancedReqInit);
+  await trace?.(fullURL, enhancedReqInit, typedResponse(response.clone()));
   return typedResponse(response);
 }
 function makeFetcher(baseURL, baseOptions = {}) {
   return async (path, requestInit = {}) => {
-    var _a, _b;
     const { headers } = baseOptions;
-    const requestTransformer = (_a = baseOptions.requestTransformer) != null ? _a : identity;
-    const responseTransformer = (_b = baseOptions.responseTransformer) != null ? _b : identity;
-    const headerTransformer = async (ri) => {
-      var _a2;
-      return {
-        ...ri,
-        headers: mergeHeaders(
-          typeof headers === "function" ? await headers() : headers != null ? headers : {},
-          (_a2 = requestInit == null ? void 0 : requestInit.headers) != null ? _a2 : {}
-        )
-      };
-    };
+    const requestTransformer = baseOptions.requestTransformer ?? identity;
+    const responseTransformer = baseOptions.responseTransformer ?? identity;
+    const headerTransformer = async (ri) => ({
+      ...ri,
+      headers: mergeHeaders(
+        typeof headers === "function" ? await headers() : headers ?? {},
+        ri.headers ?? {},
+        requestInit?.headers ?? {}
+      )
+    });
     const url = makeGetApiURL(baseURL)(path);
     const response = await enhancedFetch(
       url,
@@ -145,6 +152,7 @@ function makeService(baseURL, baseOptions) {
   return service;
 }
 export {
+  ParseResponseError,
   addQueryToURL,
   enhancedFetch,
   ensureStringBody,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "make-service",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "Some utilities to extend the 'fetch' API to better interact with external APIs.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -10,18 +10,22 @@
   "scripts": {
     "build": "tsup ./src/index.ts --format esm,cjs --dts",
     "dev": "tsup ./src/index.ts --format esm,cjs --watch --dts",
-    "lint": "eslint *.ts*",
-    "tsc": "tsc",
+    "lint": "eslint --config eslint.config.mjs .",
+    "tsc": "tsc --noEmit",
     "test": "vitest run"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^6.3.0",
-    "eslint": "latest",
-    "jsdom": "^22.1.0",
+    "@standard-schema/spec": "^1.0.0",
+    "@types/node": "^22.1.0",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "arktype": "^2.0.4",
+    "eslint": "^9.8.0",
+    "jsdom": "^24.1.1",
     "prettier": "latest",
-    "string-ts": "^0.4.1",
-    "tsup": "^6.7.0",
-    "typescript": "^5.1.3",
+    "string-ts": "^2.2.0",
+    "tsup": "^8.2.4",
+    "typescript": "^5.5.4",
     "vitest": "latest",
     "zod": "latest"
   },