make-service 2.0.0-next.0 → 2.1.0

package/README.md

@@ -11,7 +11,7 @@ It adds a set of little features and allows you to parse responses with [zod](ht
 - 🐾 Replaces URL wildcards with a **strongly-typed** 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.
-- 🔥 Transforms responses and payloads back and forth to support interchangeability of casing styles (kebab-case -> camelCase -> snake_case -> kebab-case).
+- 🔥 It can transform responses and payloads back and forth to (e.g.) support interchangeability of casing styles (kebab-case -> camelCase -> snake_case -> kebab-case).
 
 ## Example
 
@@ -48,7 +48,7 @@ const users = await response.json(usersSchema);
   - [makeFetcher](#makefetcher)
   - [enhancedFetch](#enhancedfetch)
   - [typedResponse](#typedresponse)
-- [Payload transformers](#payload-transformers)
+- [Transform the Payload](#transform-the-payload)
 - [Other available primitives](#other-available-primitives)
   - [addQueryToURL](#addquerytourl)
   - [ensureStringBody](#ensurestringbody)
@@ -437,33 +437,27 @@ const text = await response.text(z.string().email())
 //    ^? string
 ```
 
-# Payload transformers
-The `make-service` library has a few payload transformers that you can use to transform the request body before sending it or the response body after returning from the server.
+# Transform the payload
+The combination of `make-service` and [`string-ts`](https://github.com/gustavoguichard/string-ts) libraries makes it easy to work with APIs that follow a different convention for object key's casing, so you can transform the request body before sending it or the response body after returning from the server.
 The resulting type will be **properly typed** 🤩.
 ```ts
-import { makeService, kebabToCamel, camelToKebab } from 'make-service'
+import { makeService } from 'make-service'
+import { deepCamelKeys, deepKebabKeys } from 'string-ts'
 
 const service = makeService("https://example.com/api")
 const response = service.get("/users")
 const users = await response.json(
   z
     .array(z.object({ "first-name": z.string(), contact: z.object({ "home-address": z.string() }) }))
-    .transform(kebabToCamel)
+    .transform(deepCamelKeys)
 )
 console.log(users)
 //          ^? { firstName: string, contact: { homeAddress: string } }[]
 
-const body = camelToKebab({ firstName: "John", contact: { homeAddress: "123 Main St" } })
+const body = deepKebabKeys({ firstName: "John", contact: { homeAddress: "123 Main St" } })
 //    ^? { "first-name": string, contact: { "home-address": string } }
 service.patch("/users/:id", { body, params: { id: "1" } })
 ```
-The available transformations are:
-- `camelToKebab`: `"someProp" -> "some-prop"`
-- `camelToSnake`: `"someProp" -> "some_prop"`
-- `kebabToCamel`: `"some-prop" -> "someProp"`
-- `kebabToSnake`: `"some-prop" -> "some_prop"`
-- `snakeToCamel`: `"some_prop" -> "someProp"`
-- `snakeToKebab`: `"some_prop" -> "some-prop"`
 
 # Other available primitives
 This little library has plenty of other useful functions that you can use to build your own services and interactions with external APIs.
@@ -589,6 +583,7 @@ The params will be **strongly-typed** which means they will be validated against
 # 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;
@@ -134,51 +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";
 
-type KebabToCamel<Str> = Str extends `${infer First}-${infer Rest}` ? `${First}${Capitalize<KebabToCamel<Rest>>}` : Str;
-type SnakeToCamel<Str> = Str extends `${infer First}_${infer Rest}` ? `${First}${Capitalize<SnakeToCamel<Rest>>}` : Str;
-type KebabToSnake<Str> = Str extends `${infer First}-${infer Rest}` ? `${First}_${KebabToSnake<Rest>}` : Str;
-type SnakeToKebab<Str> = Str extends `${infer First}_${infer Rest}` ? `${First}-${SnakeToKebab<Rest>}` : Str;
-type HandleFirstChar<Str> = Str extends `${infer First}${infer Rest}` ? `${Lowercase<First>}${Rest}` : Str;
-type CamelToSnakeFn<Str> = Str extends `${infer First}${infer Rest}` ? `${First extends Capitalize<First> ? '_' : ''}${Lowercase<First>}${CamelToSnakeFn<Rest>}` : Str;
-type CamelToSnake<Str> = CamelToSnakeFn<HandleFirstChar<Str>>;
-type CamelToKebabFn<Str> = Str extends `${infer First}${infer Rest}` ? `${First extends Capitalize<First> ? '-' : ''}${Lowercase<First>}${CamelToKebabFn<Rest>}` : Str;
-type CamelToKebab<Str> = CamelToKebabFn<HandleFirstChar<Str>>;
-type DeepKebabToCamel<T> = T extends [any, ...any] ? {
-    [I in keyof T]: DeepKebabToCamel<T[I]>;
-} : T extends (infer V)[] ? DeepKebabToCamel<V>[] : {
-    [K in keyof T as KebabToCamel<K>]: DeepKebabToCamel<T[K]>;
-};
-declare function kebabToCamel<T>(obj: T): DeepKebabToCamel<T>;
-type DeepSnakeToCamel<T> = T extends [any, ...any] ? {
-    [I in keyof T]: DeepSnakeToCamel<T[I]>;
-} : T extends (infer V)[] ? DeepSnakeToCamel<V>[] : {
-    [K in keyof T as SnakeToCamel<K>]: DeepSnakeToCamel<T[K]>;
-};
-declare function snakeToCamel<T>(obj: T): DeepSnakeToCamel<T>;
-type DeepCamelToSnake<T> = T extends [any, ...any] ? {
-    [I in keyof T]: DeepCamelToSnake<T[I]>;
-} : T extends (infer V)[] ? DeepCamelToSnake<V>[] : {
-    [K in keyof T as CamelToSnake<K>]: DeepCamelToSnake<T[K]>;
-};
-declare function camelToSnake<T>(obj: T): DeepCamelToSnake<T>;
-type DeepCamelToKebab<T> = T extends [any, ...any] ? {
-    [I in keyof T]: DeepCamelToKebab<T[I]>;
-} : T extends (infer V)[] ? DeepCamelToKebab<V>[] : {
-    [K in keyof T as CamelToKebab<K>]: DeepCamelToKebab<T[K]>;
-};
-declare function camelToKebab<T>(obj: T): DeepCamelToKebab<T>;
-type DeepSnakeToKebab<T> = T extends [any, ...any] ? {
-    [I in keyof T]: DeepSnakeToKebab<T[I]>;
-} : T extends (infer V)[] ? DeepSnakeToKebab<V>[] : {
-    [K in keyof T as SnakeToKebab<K>]: DeepSnakeToKebab<T[K]>;
-};
-declare function snakeToKebab<T>(obj: T): DeepSnakeToKebab<T>;
-type DeepKebabToSnake<T> = T extends [any, ...any] ? {
-    [I in keyof T]: DeepKebabToSnake<T[I]>;
-} : T extends (infer V)[] ? DeepKebabToSnake<V>[] : {
-    [K in keyof T as KebabToSnake<K>]: DeepKebabToSnake<T[K]>;
-};
-declare function kebabToSnake<T>(obj: T): DeepKebabToSnake<T>;
-
-export { BaseOptions, CamelToKebab, CamelToSnake, DeepCamelToKebab, DeepCamelToSnake, DeepKebabToCamel, DeepKebabToSnake, DeepSnakeToCamel, DeepSnakeToKebab, EnhancedRequestInit, GetJson, GetText, HTTPMethod, JSONValue, KebabToCamel, KebabToSnake, PathParams, RequestTransformer, ResponseTransformer, Schema, SearchParams, ServiceRequestInit, SnakeToCamel, SnakeToKebab, TypedResponse, TypedResponseJson, TypedResponseText, addQueryToURL, camelToKebab, camelToSnake, enhancedFetch, ensureStringBody, kebabToCamel, kebabToSnake, makeFetcher, makeGetApiURL, makeService, mergeHeaders, replaceURLParams, snakeToCamel, snakeToKebab, 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

@@ -21,19 +21,14 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   addQueryToURL: () => addQueryToURL,
-  camelToKebab: () => camelToKebab,
-  camelToSnake: () => camelToSnake,
   enhancedFetch: () => enhancedFetch,
   ensureStringBody: () => ensureStringBody,
-  kebabToCamel: () => kebabToCamel,
-  kebabToSnake: () => kebabToSnake,
   makeFetcher: () => makeFetcher,
   makeGetApiURL: () => makeGetApiURL,
   makeService: () => makeService,
   mergeHeaders: () => mergeHeaders,
   replaceURLParams: () => replaceURLParams,
-  snakeToCamel: () => snakeToCamel,
-  snakeToKebab: () => snakeToKebab,
+  typeOf: () => typeOf,
   typedResponse: () => typedResponse
 });
 module.exports = __toCommonJS(src_exports);
@@ -60,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) {
@@ -73,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);
     }
   }
@@ -118,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;
@@ -181,76 +174,23 @@ function makeService(baseURL, baseOptions) {
   function appliedService(method) {
     return async (path, requestInit = {}) => fetcher(path, { ...requestInit, method });
   }
-  let service = {};
+  const service = {};
   for (const method of HTTP_METHODS) {
     const lowerMethod = method.toLowerCase();
     service[lowerMethod] = appliedService(method);
   }
   return service;
 }
-
-// src/transforms.ts
-function words(str) {
-  const matches = str.match(
-    /[A-Z]{2,}(?=[A-Z][a-z]+[0-9]*|\b)|[A-Z]?[a-z]+[0-9]*|[A-Z]|[0-9]+/g
-  );
-  return matches ? Array.from(matches) : [str];
-}
-function toCamelCase(str) {
-  const result = words(str).map((x) => x.slice(0, 1).toUpperCase() + x.slice(1).toLowerCase()).join("");
-  return result.slice(0, 1).toLowerCase() + result.slice(1);
-}
-function toKebabCase(str) {
-  return words(str).map((x) => x.toLowerCase()).join("-");
-}
-function toSnakeCase(str) {
-  return words(str).map((x) => x.toLowerCase()).join("_");
-}
-function deepTransformKeys(obj, transform) {
-  if (!["object", "array"].includes(typeOf(obj)))
-    return obj;
-  if (Array.isArray(obj)) {
-    return obj.map((x) => deepTransformKeys(x, transform));
-  }
-  const res = {};
-  for (const key in obj) {
-    res[transform(key)] = deepTransformKeys(obj[key], transform);
-  }
-  return res;
-}
-function kebabToCamel(obj) {
-  return deepTransformKeys(obj, toCamelCase);
-}
-function snakeToCamel(obj) {
-  return deepTransformKeys(obj, toCamelCase);
-}
-function camelToSnake(obj) {
-  return deepTransformKeys(obj, toSnakeCase);
-}
-function camelToKebab(obj) {
-  return deepTransformKeys(obj, toKebabCase);
-}
-function snakeToKebab(obj) {
-  return deepTransformKeys(obj, toKebabCase);
-}
-function kebabToSnake(obj) {
-  return deepTransformKeys(obj, toSnakeCase);
-}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   addQueryToURL,
-  camelToKebab,
-  camelToSnake,
   enhancedFetch,
   ensureStringBody,
-  kebabToCamel,
-  kebabToSnake,
   makeFetcher,
   makeGetApiURL,
   makeService,
   mergeHeaders,
   replaceURLParams,
-  snakeToCamel,
-  snakeToKebab,
+  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;
@@ -141,75 +139,22 @@ function makeService(baseURL, baseOptions) {
   function appliedService(method) {
     return async (path, requestInit = {}) => fetcher(path, { ...requestInit, method });
   }
-  let service = {};
+  const service = {};
   for (const method of HTTP_METHODS) {
     const lowerMethod = method.toLowerCase();
     service[lowerMethod] = appliedService(method);
   }
   return service;
 }
-
-// src/transforms.ts
-function words(str) {
-  const matches = str.match(
-    /[A-Z]{2,}(?=[A-Z][a-z]+[0-9]*|\b)|[A-Z]?[a-z]+[0-9]*|[A-Z]|[0-9]+/g
-  );
-  return matches ? Array.from(matches) : [str];
-}
-function toCamelCase(str) {
-  const result = words(str).map((x) => x.slice(0, 1).toUpperCase() + x.slice(1).toLowerCase()).join("");
-  return result.slice(0, 1).toLowerCase() + result.slice(1);
-}
-function toKebabCase(str) {
-  return words(str).map((x) => x.toLowerCase()).join("-");
-}
-function toSnakeCase(str) {
-  return words(str).map((x) => x.toLowerCase()).join("_");
-}
-function deepTransformKeys(obj, transform) {
-  if (!["object", "array"].includes(typeOf(obj)))
-    return obj;
-  if (Array.isArray(obj)) {
-    return obj.map((x) => deepTransformKeys(x, transform));
-  }
-  const res = {};
-  for (const key in obj) {
-    res[transform(key)] = deepTransformKeys(obj[key], transform);
-  }
-  return res;
-}
-function kebabToCamel(obj) {
-  return deepTransformKeys(obj, toCamelCase);
-}
-function snakeToCamel(obj) {
-  return deepTransformKeys(obj, toCamelCase);
-}
-function camelToSnake(obj) {
-  return deepTransformKeys(obj, toSnakeCase);
-}
-function camelToKebab(obj) {
-  return deepTransformKeys(obj, toKebabCase);
-}
-function snakeToKebab(obj) {
-  return deepTransformKeys(obj, toKebabCase);
-}
-function kebabToSnake(obj) {
-  return deepTransformKeys(obj, toSnakeCase);
-}
 export {
   addQueryToURL,
-  camelToKebab,
-  camelToSnake,
   enhancedFetch,
   ensureStringBody,
-  kebabToCamel,
-  kebabToSnake,
   makeFetcher,
   makeGetApiURL,
   makeService,
   mergeHeaders,
   replaceURLParams,
-  snakeToCamel,
-  snakeToKebab,
+  typeOf,
   typedResponse
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "make-service",
-  "version": "2.0.0-next.0",
+  "version": "2.1.0",
   "description": "Some utilities to extend the 'fetch' API to better interact with external APIs.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -15,9 +15,11 @@
     "test": "vitest run"
   },
   "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^6.3.0",
     "eslint": "latest",
     "jsdom": "^22.1.0",
     "prettier": "latest",
+    "string-ts": "^0.4.1",
     "tsup": "^6.7.0",
     "typescript": "^5.1.3",
     "vitest": "latest",