Merge pull request #2 from WJSoftware:JP/DrFetch

chore!: Rename WjFetch to DrFetch

Author: webJose

README.md

@@ -55,28 +55,28 @@ Think of this custom function as the place where you do interceptions (if you ar
 ### Create Fetcher Object
 
 ```typescript
-import { WjFetch } from "dr-fetch";
+import { DrFetch } from "dr-fetch";
 import { myFetch } from "./myFetch.js";
 
-const fetcher = new WjFetch(myFetch);
+const fetcher = new DrFetch(myFetch);
 // If you don't need a custom fetch function, just do:
-const fetcher = new WjFetch();
+const fetcher = new DrFetch();
 ```
 
 ### Adding a Custom Body Parser
 
-One can say that the `WjFetch` class comes with 2 basic body parsers:
+One can say that the `DrFetch` class comes with 2 basic body parsers:
 
 1. JSON parser when the the value of the `coontent-type` response header is `application/json` or similar 
 (`application/problem+json`, for instance).
 2. Text parser when the vlaue of the `content-type` response header is `text/<something>`, such as `text/plain` or 
 `text/csv`.
 
-If your API sends a content type not included in any of the above two cases, use `WjFetch.withParser()` to add a custom 
+If your API sends a content type not included in any of the above two cases, use `DrFetch.withParser()` to add a custom 
 parser for the content type you are expecting.  The class allows for fluent syntax, so you can chain calls:
 
 ```typescript
-const fetcher = new WjFetch(myFetch)
+const fetcher = new DrFetch(myFetch)
     .withParser('custom/contentType', async (response) => {
         // Do what you must with the provided response object.  In the end, you must return the parsed body.
         return finalBody;
@@ -131,11 +131,11 @@ what if your API is standardized so all status `400` bodies look the same?  Then
 
 ```typescript
 // root-fetcher.ts
-import { WjFetch } from "dr-fetch";
+import { DrFetch } from "dr-fetch";
 import { myFetch } from "./my-fetch.js";
 import type { BadRequestBody } from "my-datatypes.js";
 
-export default new WjFetch(myFetch)
+export default new DrFetch(myFetch)
     .withParser(...) // Optional parsers
     .withParser(...)
     .for<400, BadRequestBody>()

package.json

@@ -7,7 +7,10 @@
   "type": "module",
   "scripts": {
     "test": "ts-mocha -n loader=ts-node/esm -p ./tsconfig.json ./src/tests/**/*.test.ts",
-    "build": "npx tsc && npx publint"
+    "build": "npx tsc && npx publint",
+    "prebuild": "npm run test",
+    "publish": "npm publish",
+    "prepublishonly": "npm run build"
   },
   "keywords": [
     "fetch"

src/WjFetch.ts renamed to src/DrFetch.ts

@@ -17,7 +17,7 @@ const textTypes: (string | RegExp)[] = [
 ];
 
 /**
- * # WjFetch
+ * # DrFetch
  * 
  * Class that wraps around the provided data-fetching function (or the standard `fetch` function) in order to provide 
  * full body typing.
@@ -32,7 +32,7 @@ const textTypes: (string | RegExp)[] = [
  * type ToDo = { id: number; text: string; }
  * type NotAuthBody = { loginUrl: string; }
  * 
- * const fetcher = new WjFetch()
+ * const fetcher = new DrFetch()
  *     .for<200, ToDo[]>()
  *     .for<401, NotAuthBody>()
  *     ;
@@ -55,7 +55,7 @@ const textTypes: (string | RegExp)[] = [
  * 
  * @example
  * ```typescript
- * const fetcher = new WjFetch()
+ * const fetcher = new DrFetch()
  *     .for<200 | 201, { data: ToDo }>()
  *     ;
  * ```
@@ -66,7 +66,7 @@ const textTypes: (string | RegExp)[] = [
  * 
  * @example
  * ```typescript
- * const fetcher = new WjFetch()
+ * const fetcher = new DrFetch()
  *     .for<OkStatusCode, { data: ToDo }>()
  *     ;
  * ```
@@ -80,7 +80,7 @@ const textTypes: (string | RegExp)[] = [
  * existing one using the parent's `clone` function.  When cloning, pass a new data-fetching function (if required) so 
  * the clone uses this one instead of the one of the parent fetcher.
  */
-export class WjFetch<T = unknown> {
+export class DrFetch<T = unknown> {
     #fetchFn: typeof fetch;
     #customParsers: [string | RegExp, (response: Response) => Promise<any>][] = [];
 
@@ -107,7 +107,7 @@ export class WjFetch<T = unknown> {
      * }
      * 
      * // Create the class now.
-     * const fetcher = new WjFetch(myCustomFetch);
+     * const fetcher = new DrFetch(myCustomFetch);
      * ```
      * 
      * If you need to do special parsing of the body, don't do post-interception and instead use the `withParser` 
@@ -134,12 +134,12 @@ export class WjFetch<T = unknown> {
          * Determines if parsers are included in the clone.  The default is `true`.
          */
         includeParsers?: boolean;
-    }): TInherit extends true ? WjFetch<T> : WjFetch {
-        const newClone = new WjFetch(options?.fetchFn ?? this.#fetchFn);
+    }): TInherit extends true ? DrFetch<T> : DrFetch {
+        const newClone = new DrFetch(options?.fetchFn ?? this.#fetchFn);
         if (options?.includeParsers ?? true) {
             newClone.#customParsers = [...this.#customParsers];
         }
-        return newClone as WjFetch<T>;
+        return newClone as DrFetch<T>;
     }
 
     /**
@@ -163,8 +163,8 @@ export class WjFetch<T = unknown> {
      * be a single status code, or multiple status codes.
      * @returns This parser object with its response type modified to include the body specification provided.
      */
-    for<TStatus extends StatusCode, TBody = {}>(): WjFetch<FetchResult<T, TStatus, TBody>> {
-        return this as WjFetch<FetchResult<T, TStatus, TBody>>;
+    for<TStatus extends StatusCode, TBody = {}>(): DrFetch<FetchResult<T, TStatus, TBody>> {
+        return this as DrFetch<FetchResult<T, TStatus, TBody>>;
     }
 
     // notFor<TStatus extends StatusCode>(status: TStatus)

src/index.ts

@@ -1,3 +1,3 @@
+export * from './DrFetch.js';
 export type * from './types.js';
-export * from './WjFetch.js';
 

src/tests/WjFetch.test.ts renamed to src/tests/DrFetch.test.ts

@@ -1,9 +1,9 @@
 import { expect } from "chai";
 import { describe, test } from "mocha";
 import { fake } from 'sinon';
-import { WjFetch } from "../WjFetch.js";
+import { DrFetch } from "../DrFetch.js";
 
-describe('WjFetch', () => {
+describe('DrFetch', () => {
     describe('clone()', () => {
         [
             {
@@ -32,7 +32,7 @@ describe('WjFetch', () => {
                 const contentType = 'text/plain';
                 const origFetchFn = fake.resolves(new Response('Hi!', { headers: { 'content-type': contentType } }));
                 const customParserFn = fake();
-                const origFetcher = new WjFetch(origFetchFn);
+                const origFetcher = new DrFetch(origFetchFn);
                 origFetcher.withParser(contentType, customParserFn);
                 const newFetchFn = fake.resolves(new Response('Hi!', { headers: { 'content-type': contentType } }));
 
@@ -52,7 +52,7 @@ describe('WjFetch', () => {
             const origFetch = globalThis.fetch;
             const fakeFetch = fake.resolves(new Response(null));
             globalThis.fetch = fakeFetch;
-            const fetcher = new WjFetch();
+            const fetcher = new DrFetch();
 
             // Act.
             try {
@@ -68,7 +68,7 @@ describe('WjFetch', () => {
         test("Should call the provided data-fetching function.", async () => {
             // Arrange.
             const fakeFetch = fake.resolves(new Response(null));
-            const fetcher = new WjFetch(fakeFetch);
+            const fetcher = new DrFetch(fakeFetch);
 
             // Act.
             await fetcher.fetch('x');
@@ -116,7 +116,7 @@ describe('WjFetch', () => {
             test(`Should parse the body using the stock body parsers when content type is "${tc.contentType}".`, async () => {
                 // Arrange.
                 const fetchFn = fake.resolves(new Response(tc.body, { headers: { 'content-type': tc.contentType } }));
-                const fetcher = new WjFetch(fetchFn);
+                const fetcher = new DrFetch(fetchFn);
 
                 // Act.
                 const result = await fetcher.for<200, string | object>().fetch('x');
@@ -133,7 +133,7 @@ describe('WjFetch', () => {
         test("Should return 'null' as body whenever the response carries no body.", async () => {
             // Arrange.
             const fetchFn = fake.resolves(new Response());
-            const fetcher = new WjFetch(fetchFn);
+            const fetcher = new DrFetch(fetchFn);
 
             // Act.
             const response = await fetcher.for<200, string>().fetch('x');
@@ -146,7 +146,7 @@ describe('WjFetch', () => {
             const response = new Response('x');
             response.headers.delete('content-type');
             const fetchFn = fake.resolves(response);
-            const fetcher = new WjFetch(fetchFn);
+            const fetcher = new DrFetch(fetchFn);
             let didThrow = false;
 
             // Act.
@@ -163,7 +163,7 @@ describe('WjFetch', () => {
         test("Should throw an error if the content type is unknown by the built-in parsers and custom parsers.", async () => {
             // Arrange.
             const fetchFn = fake.resolves(new Response('x', { headers: { 'content-type': 'application/xml' }}));
-            const fetcher = new WjFetch(fetchFn);
+            const fetcher = new DrFetch(fetchFn);
             let didThrow = false;
 
             // Act.
@@ -200,7 +200,7 @@ describe('WjFetch', () => {
                 ],
             },
         ].flatMap(x => {
-            const expanded = [];
+            const expanded: (Omit<(typeof x), 'contentTypes'> & { contentType: string; })[] = [];
             for (let ct of x.contentTypes) {
                 expanded.push({
                     pattern: x.pattern,
@@ -214,7 +214,7 @@ describe('WjFetch', () => {
                 // Arrange.
                 const parserFn = fake();
                 const fetchFn = fake.resolves(new Response('x', { headers: { 'content-type': tc.contentType }}));
-                const fetcher = new WjFetch(fetchFn);
+                const fetcher = new DrFetch(fetchFn);
                 fetcher.withParser(tc.pattern, parserFn);
 
                 // Act.

src/types.ts

@@ -36,7 +36,7 @@ type CoreFetchResult<TStatus extends StatusCode, TBody> = {
 });
 
 /**
- * Type that builds WjFetch's final result object's type.
+ * Type that builds DrFetch's final result object's type.
  */
 export type FetchResult<T, TStatus extends StatusCode, TBody = undefined> =
     (unknown extends T ? CoreFetchResult<TStatus, TBody> : T | CoreFetchResult<TStatus, TBody>) extends infer R ? R : never;