openapi-typesafe-fetch 1.0.0-rc.5 → 1.0.0-rc.7

package/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 This package is a fork of `openapi-fetch`. The entries above `0.17.0` are releases of openapi-typesafe-fetch; `0.17.0` and the entries below it are the upstream history up to the fork point (upstream commit `d46a319a`), with `openapi-fetch` versions.
 
+## 1.0.0-rc.7
+
+### Patch Changes
+
+- [#96](https://github.com/openapi-typesafe/openapi-typesafe/pull/96) [`171fa71`](https://github.com/openapi-typesafe/openapi-typesafe/commit/171fa71311107e4e26a9ae7a62b431662fb13de5) Thanks [@fedorello](https://github.com/fedorello)! - `SuccessResponseJSON`, `ErrorResponseJSON` and the `data` and `error` of a client made with
+  ``createClient<paths, `${string}/json`>()`` leave out a response that has no JSON media type. It
+  added its whole `content` map, so a `text/html` 500 typed the error as `{ "text/html": string }`,
+  a value the client never returns.
+
+- [#96](https://github.com/openapi-typesafe/openapi-typesafe/pull/96) [`171fa71`](https://github.com/openapi-typesafe/openapi-typesafe/commit/171fa71311107e4e26a9ae7a62b431662fb13de5) Thanks [@fedorello](https://github.com/fedorello)! - A nested array or object in a path parameter (`{ id: [[1]] }`) now fails with an error that names
+  `pathSerializer()`, the option that sends such values. It told you to write a `querySerializer()`,
+  which does not apply to the path.
+
+- [#96](https://github.com/openapi-typesafe/openapi-typesafe/pull/96) [`171fa71`](https://github.com/openapi-typesafe/openapi-typesafe/commit/171fa71311107e4e26a9ae7a62b431662fb13de5) Thanks [@fedorello](https://github.com/fedorello)! - A request's `querySerializer` option set to `undefined` (`{ array: { explode: undefined } }`, as a
+  wrapper passes its own optional option on) now takes the client's value, as an option left out
+  does. It replaced the client's value, so the default style was sent.
+
+## 1.0.0-rc.6
+
+### Patch Changes
+
+- [#87](https://github.com/openapi-typesafe/openapi-typesafe/pull/87) [`dfb0fe3`](https://github.com/openapi-typesafe/openapi-typesafe/commit/dfb0fe3c61a75d2b8ca512577f4b699049171a64) Thanks [@fedorello](https://github.com/fedorello)! - Leave out `null` and `undefined` items and members of arrays and objects in every parameter style, also in the path and headers (`ids=1,null`, `filter=owner,undefined` and `x-p: a,,b,1` were sent before), and default `explode` to `true` for the `form` query style only, as OpenAPI does, so `{ array: { style: "pipeDelimited" } }` sends `id=3|4|5`. A nested value in a header parameter now fails with an error that names header parameters, not `querySerializer()`.
+
 ## 1.0.0-rc.5
 
 ### Minor Changes

package/README.md

@@ -1,6 +1,6 @@
 # openapi-typesafe-fetch
 
-A type-safe `fetch` client for types generated by [`openapi-typesafe`](../openapi-typesafe). About 10.7 kB minified
+A type-safe `fetch` client for types generated by [`openapi-typesafe`](../openapi-typesafe). About 11 kB minified
 (4 kB gzipped), no runtime dependencies, works in browsers, Node.js, Bun and Deno, and with React, Vue, Svelte or plain JavaScript.
 
 A maintained, drop-in successor to `openapi-fetch` (see the [repository README](../../README.md)).
@@ -26,7 +26,7 @@ const client = createClient<paths>({ baseUrl: "https://api.example.com/v1/" });
 
 const {
   data, // present on a 2xx response
-  error, // present on a 4xx or 5xx response
+  error, // present on a response that is not 2xx
 } = await client.GET("/posts/{post_id}", {
   params: { path: { post_id: "123" } },
 });

package/dist/helpers.d.cts

@@ -206,8 +206,14 @@ type SuccessStatus<T> = [SuccessStatusKey<T>] extends [never] ? Extract<keyof T,
  * share its statuses, and a `default`-only path typed the data `undefined` (upstream).
  */
 type SuccessResponse<T extends Record<string | number, any>, Media extends MediaType = MediaType> = T extends unknown ? GetResponseContent<T, Media, SuccessStatus<T>> : never;
+/**
+ * The bodies of the responses `ResponseCode` in the media types `Media`. A response with a
+ * `content` map but no media type in `Media` adds nothing: it gave its whole map, so the error of
+ * `ErrorResponseJSON` for a `text/html` 500 was `{ "text/html": string }`, a body no response has.
+ * A response without `content` keeps its `content` type (`undefined` for `content?: never`).
+ */
 type GetResponseContent<T extends Record<string | number, any>, Media extends MediaType = MediaType, ResponseCode extends keyof T = keyof T> = ResponseCode extends keyof T ? {
-    [K in ResponseCode]: T[K]["content"] extends Record<string, any> ? FilterKeys<T[K]["content"], Media> extends never ? T[K]["content"] : FilterKeys<T[K]["content"], Media> : K extends keyof T ? T[K]["content"] : never;
+    [K in ResponseCode]: T[K]["content"] extends Record<string, any> ? FilterKeys<T[K]["content"], Media> : K extends keyof T ? T[K]["content"] : never;
 }[ResponseCode] : never;
 /**
  * Return all 1XX, 3XX, 4XX, 5XX and `default` responses from a Response Object Map; for a union
@@ -216,7 +222,7 @@ type GetResponseContent<T extends Record<string | number, any>, Media extends Me
 type ErrorResponse<T extends Record<string | number, any>, Media extends MediaType = MediaType> = T extends unknown ? GetResponseContent<T, Media, ErrorStatusKey<T>> : never;
 /** Return first JSON-like 2XX response from a path + HTTP method */
 type SuccessResponseJSON<PathMethod extends Record<string | number, any>> = SuccessResponse<ResponseObjectMap<PathMethod>, `${string}/json`>;
-/** Return first JSON-like 5XX or 4XX response from a path + HTTP method */
+/** Return JSON-like 1XX, 3XX, 4XX, 5XX and `default` responses from a path + HTTP method */
 type ErrorResponseJSON<PathMethod extends Record<string | number, any>> = ErrorResponse<ResponseObjectMap<PathMethod>, `${string}/json`>;
 /** Return JSON-like request body from a path + HTTP method */
 type RequestBodyJSON<PathMethod> = JSONLike<FilterKeys<OperationRequestBody<PathMethod>, "content">>;

package/dist/helpers.d.mts

@@ -206,8 +206,14 @@ type SuccessStatus<T> = [SuccessStatusKey<T>] extends [never] ? Extract<keyof T,
  * share its statuses, and a `default`-only path typed the data `undefined` (upstream).
  */
 type SuccessResponse<T extends Record<string | number, any>, Media extends MediaType = MediaType> = T extends unknown ? GetResponseContent<T, Media, SuccessStatus<T>> : never;
+/**
+ * The bodies of the responses `ResponseCode` in the media types `Media`. A response with a
+ * `content` map but no media type in `Media` adds nothing: it gave its whole map, so the error of
+ * `ErrorResponseJSON` for a `text/html` 500 was `{ "text/html": string }`, a body no response has.
+ * A response without `content` keeps its `content` type (`undefined` for `content?: never`).
+ */
 type GetResponseContent<T extends Record<string | number, any>, Media extends MediaType = MediaType, ResponseCode extends keyof T = keyof T> = ResponseCode extends keyof T ? {
-    [K in ResponseCode]: T[K]["content"] extends Record<string, any> ? FilterKeys<T[K]["content"], Media> extends never ? T[K]["content"] : FilterKeys<T[K]["content"], Media> : K extends keyof T ? T[K]["content"] : never;
+    [K in ResponseCode]: T[K]["content"] extends Record<string, any> ? FilterKeys<T[K]["content"], Media> : K extends keyof T ? T[K]["content"] : never;
 }[ResponseCode] : never;
 /**
  * Return all 1XX, 3XX, 4XX, 5XX and `default` responses from a Response Object Map; for a union
@@ -216,7 +222,7 @@ type GetResponseContent<T extends Record<string | number, any>, Media extends Me
 type ErrorResponse<T extends Record<string | number, any>, Media extends MediaType = MediaType> = T extends unknown ? GetResponseContent<T, Media, ErrorStatusKey<T>> : never;
 /** Return first JSON-like 2XX response from a path + HTTP method */
 type SuccessResponseJSON<PathMethod extends Record<string | number, any>> = SuccessResponse<ResponseObjectMap<PathMethod>, `${string}/json`>;
-/** Return first JSON-like 5XX or 4XX response from a path + HTTP method */
+/** Return JSON-like 1XX, 3XX, 4XX, 5XX and `default` responses from a path + HTTP method */
 type ErrorResponseJSON<PathMethod extends Record<string | number, any>> = ErrorResponse<ResponseObjectMap<PathMethod>, `${string}/json`>;
 /** Return JSON-like request body from a path + HTTP method */
 type RequestBodyJSON<PathMethod> = JSONLike<FilterKeys<OperationRequestBody<PathMethod>, "content">>;

package/dist/helpers.d.ts

@@ -206,8 +206,14 @@ type SuccessStatus<T> = [SuccessStatusKey<T>] extends [never] ? Extract<keyof T,
  * share its statuses, and a `default`-only path typed the data `undefined` (upstream).
  */
 type SuccessResponse<T extends Record<string | number, any>, Media extends MediaType = MediaType> = T extends unknown ? GetResponseContent<T, Media, SuccessStatus<T>> : never;
+/**
+ * The bodies of the responses `ResponseCode` in the media types `Media`. A response with a
+ * `content` map but no media type in `Media` adds nothing: it gave its whole map, so the error of
+ * `ErrorResponseJSON` for a `text/html` 500 was `{ "text/html": string }`, a body no response has.
+ * A response without `content` keeps its `content` type (`undefined` for `content?: never`).
+ */
 type GetResponseContent<T extends Record<string | number, any>, Media extends MediaType = MediaType, ResponseCode extends keyof T = keyof T> = ResponseCode extends keyof T ? {
-    [K in ResponseCode]: T[K]["content"] extends Record<string, any> ? FilterKeys<T[K]["content"], Media> extends never ? T[K]["content"] : FilterKeys<T[K]["content"], Media> : K extends keyof T ? T[K]["content"] : never;
+    [K in ResponseCode]: T[K]["content"] extends Record<string, any> ? FilterKeys<T[K]["content"], Media> : K extends keyof T ? T[K]["content"] : never;
 }[ResponseCode] : never;
 /**
  * Return all 1XX, 3XX, 4XX, 5XX and `default` responses from a Response Object Map; for a union
@@ -216,7 +222,7 @@ type GetResponseContent<T extends Record<string | number, any>, Media extends Me
 type ErrorResponse<T extends Record<string | number, any>, Media extends MediaType = MediaType> = T extends unknown ? GetResponseContent<T, Media, ErrorStatusKey<T>> : never;
 /** Return first JSON-like 2XX response from a path + HTTP method */
 type SuccessResponseJSON<PathMethod extends Record<string | number, any>> = SuccessResponse<ResponseObjectMap<PathMethod>, `${string}/json`>;
-/** Return first JSON-like 5XX or 4XX response from a path + HTTP method */
+/** Return JSON-like 1XX, 3XX, 4XX, 5XX and `default` responses from a path + HTTP method */
 type ErrorResponseJSON<PathMethod extends Record<string | number, any>> = ErrorResponse<ResponseObjectMap<PathMethod>, `${string}/json`>;
 /** Return JSON-like request body from a path + HTTP method */
 type RequestBodyJSON<PathMethod> = JSONLike<FilterKeys<OperationRequestBody<PathMethod>, "content">>;

package/dist/index.cjs

@@ -415,6 +415,7 @@ function headerParamValue(value) {
   if (value === null || typeof value !== "object" || isDate(value)) {
     return valueText(value);
   }
+  checkFlatMembers(value, HEADER_NESTED_VALUE_ERROR);
   const serialize = Array.isArray(value) ? serializeArrayParam : serializeObjectParam;
   return serialize("", value, HEADER_PARAM_STYLE) || void 0;
 }
@@ -425,11 +426,23 @@ function serializeHeaderParams(header) {
   const entries = Object.entries(header).map(([name, value]) => [name, headerParamValue(value)]);
   return Object.fromEntries(entries);
 }
+const NESTED_VALUE_ERROR = "Deeply-nested arrays/objects aren\u2019t supported";
+const HEADER_NESTED_VALUE_ERROR = `${NESTED_VALUE_ERROR} in header parameters.`;
+const PATH_HOOK_HINT = "Provide your own `pathSerializer()` to handle these.";
+const PATH_NESTED_VALUE_ERROR = `${NESTED_VALUE_ERROR} in path parameters. ${PATH_HOOK_HINT}`;
+const QUERY_HOOK_HINT = "Provide your own `querySerializer()` to handle these.";
+const QUERY_NESTED_VALUE_ERROR = `${NESTED_VALUE_ERROR}. ${QUERY_HOOK_HINT}`;
+function isNestedValue(value) {
+  return Boolean(value) && typeof value === "object" && !isDate(value);
+}
+function checkFlatMembers(value, message) {
+  if (Object.values(value).some((member) => isNestedValue(member))) {
+    throw new Error(message);
+  }
+}
 function encodeValue(value, allowReserved) {
-  if (value && typeof value === "object" && !isDate(value)) {
-    throw new Error(
-      "Deeply-nested arrays/objects aren\u2019t supported. Provide your own `querySerializer()` to handle these."
-    );
+  if (isNestedValue(value)) {
+    throw new Error(QUERY_NESTED_VALUE_ERROR);
   }
   const text = valueText(value);
   return allowReserved === true ? text : encodeURIComponent(text);
@@ -448,10 +461,15 @@ function joinExploded(values, style) {
 function serializeUnexplodedObject(name, value, options) {
   const values = [];
   for (const k in value) {
-    values.push(
-      encodeValue(k, options.allowReserved),
-      encodeValue(value[k], options.allowReserved)
-    );
+    if (value[k] != null) {
+      values.push(
+        encodeValue(k, options.allowReserved),
+        encodeValue(value[k], options.allowReserved)
+      );
+    }
+  }
+  if (!values.length) {
+    return "";
   }
   const final = values.join(",");
   switch (options.style) {
@@ -488,7 +506,11 @@ function serializeObjectParam(name, value, options) {
 }
 function serializeUnexplodedArray(name, value, options) {
   const joiner = { form: ",", spaceDelimited: "%20", pipeDelimited: "|" }[options.style] || ",";
-  const final = value.map((v) => encodeValue(v, options.allowReserved)).join(joiner);
+  const items = value.filter((v) => v != null);
+  if (!items.length) {
+    return "";
+  }
+  const final = items.map((v) => encodeValue(v, options.allowReserved)).join(joiner);
   switch (options.style) {
     case "simple": {
       return final;
@@ -513,29 +535,29 @@ function serializeArrayParam(name, value, options) {
   }
   const values = [];
   for (const v of value) {
+    if (v == null) {
+      continue;
+    }
     if (options.style === "simple" || options.style === "label") {
       values.push(encodeValue(v, options.allowReserved));
-    } else if (v != null) {
+    } else {
       values.push(serializePrimitiveParam(name, v, options));
     }
   }
   return values.length ? joinExploded(values, options.style) : "";
 }
+function queryStyle(options, defaultStyle, allowReserved) {
+  const style = options?.style ?? defaultStyle;
+  return { style, explode: options?.explode ?? style === "form", allowReserved };
+}
 function serializeQueryParam(name, value, options) {
   const allowReserved = options?.allowReserved || false;
   if (Array.isArray(value)) {
-    return serializeArrayParam(name, value, {
-      style: options?.array?.style ?? "form",
-      explode: options?.array?.explode ?? true,
-      allowReserved
-    });
+    return serializeArrayParam(name, value, queryStyle(options?.array, "form", allowReserved));
   }
   if (value && typeof value === "object" && !isDate(value)) {
-    return serializeObjectParam(name, value, {
-      style: options?.object?.style ?? "deepObject",
-      explode: options?.object?.explode ?? true,
-      allowReserved
-    });
+    const style = queryStyle(options?.object, "deepObject", allowReserved);
+    return serializeObjectParam(name, value, style);
   }
   return serializePrimitiveParam(name, value, options);
 }
@@ -557,11 +579,15 @@ function mergeQueryOptions(clientOptions, requestOptions) {
   const base = typeof clientOptions === "function" ? {} : clientOptions ?? {};
   return {
     ...base,
-    ...requestOptions,
-    array: { ...base.array, ...requestOptions.array },
-    object: { ...base.object, ...requestOptions.object }
+    ...definedOptions(requestOptions),
+    array: { ...base.array, ...definedOptions(requestOptions.array) },
+    object: { ...base.object, ...definedOptions(requestOptions.object) }
   };
 }
+function definedOptions(options) {
+  const entries = Object.entries(options ?? {}).filter(([, value]) => value !== void 0);
+  return Object.fromEntries(entries);
+}
 function defaultPathSerializer(pathname, pathParams) {
   const matches = pathname.match(PATH_PARAM_RE);
   if (!matches) {
@@ -586,22 +612,26 @@ function defaultPathSerializer(pathname, pathParams) {
     if (!pathParams || pathParams[name] === void 0 || pathParams[name] === null) {
       continue;
     }
-    const value = pathParams[name];
-    let serialized;
-    if (Array.isArray(value)) {
-      serialized = serializeArrayParam(name, value, { style, explode });
-    } else if (typeof value === "object" && !isDate(value)) {
-      serialized = serializeObjectParam(name, value, { style, explode });
-    } else if (style === "matrix") {
-      serialized = `;${serializePrimitiveParam(name, value)}`;
-    } else {
-      serialized = style === "label" ? `.${encodeValue(value)}` : encodeValue(value);
-    }
+    const serialized = serializePathParam(name, pathParams[name], { style, explode });
     nextURL = nextURL.replace(match, () => serialized);
   }
   checkSerializedPath(pathname, nextURL);
   return nextURL;
 }
+function serializePathParam(name, value, options) {
+  if (Array.isArray(value)) {
+    checkFlatMembers(value, PATH_NESTED_VALUE_ERROR);
+    return serializeArrayParam(name, value, options);
+  }
+  if (typeof value === "object" && !isDate(value)) {
+    checkFlatMembers(value, PATH_NESTED_VALUE_ERROR);
+    return serializeObjectParam(name, value, options);
+  }
+  if (options.style === "matrix") {
+    return `;${serializePrimitiveParam(name, value)}`;
+  }
+  return options.style === "label" ? `.${encodeValue(value)}` : encodeValue(value);
+}
 function checkSerializedPath(template, url) {
   const fixed = template.slice(0, template.search(PATH_PARAM_RE));
   const path = url.split(QUERY_OR_FRAGMENT_RE, 1)[0];