fix: first release

Author: harshtalks

.changeset/pre.json

@@ -4,5 +4,7 @@
   "initialVersions": {
     "aspi": "0.0.1"
   },
-  "changesets": ["twenty-wasps-grow"]
+  "changesets": [
+    "twenty-wasps-grow"
+  ]
 }

.changeset/twenty-wasps-grow.md

@@ -1,5 +1,5 @@
 ---
-"aspi": minor
+'aspi': minor
 ---
 
 first release

.prettierignore

@@ -0,0 +1 @@
+.changeset

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 80,
+  "tabWidth": 2
+}

README.md

@@ -16,20 +16,20 @@ I made this project because I am not happy with any of the Rest API clients avai
 ## Example
 
 ```typescript
-import { aspi, Result } from "aspi";
+import { aspi, Result } from 'aspi';
 
 const apiClient = new Aspi({
-  baseUrl: "https://api.example.com",
+  baseUrl: 'https://api.example.com',
   headers: {
-    "Content-Type": "application/json",
+    'Content-Type': 'application/json',
   },
 });
 
 const getTodos = async (id: number) => {
   const response = await apiClient
     .get(`/todos/${id}`)
     .notFound(() => ({
-      message: "Todo not found",
+      message: 'Todo not found',
     }))
     .json<{
       id: number;
@@ -42,9 +42,9 @@ const getTodos = async (id: number) => {
       console.log(data);
     },
     onErr: (error) => {
-      if (error.tag === "ASPI_ERROR") {
+      if (error.tag === 'ASPI_ERROR') {
         console.error(error.response.status);
-      } else if (error.tag === "NOT_FOUND") {
+      } else if (error.tag === 'NOT_FOUND') {
         console.log(error.data.message);
       }
     },

src/aspi.ts

@@ -1,6 +1,6 @@
-import type { HttpMethods } from "./http";
-import { Request } from "./request";
-import type { AspiConfig, AspiRequestConfig, Middleware } from "./types";
+import type { HttpMethods } from './http';
+import { Request } from './request';
+import type { AspiConfig, AspiRequestConfig, Middleware } from './types';
 
 /**
  * A class for making API requests with a base URL and configurable options
@@ -66,7 +66,7 @@ export class Aspi<TRequest extends RequestInit = RequestInit> {
    * const response = await api.get('/users').json();
    */
   get(path: string) {
-    return this.#createRequest("GET", path);
+    return this.#createRequest('GET', path);
   }
 
   /**
@@ -79,7 +79,7 @@ export class Aspi<TRequest extends RequestInit = RequestInit> {
    * const response = await api.post('/users', { name: 'John' }).json();
    */
   post(path: string, body?: BodyInit) {
-    return this.#createRequest("POST", path, body);
+    return this.#createRequest('POST', path, body);
   }
 
   /**
@@ -92,7 +92,7 @@ export class Aspi<TRequest extends RequestInit = RequestInit> {
    * const response = await api.put('/users/1', { name: 'John' }).json();
    */
   put(path: string, body?: BodyInit) {
-    return this.#createRequest("PUT", path, body);
+    return this.#createRequest('PUT', path, body);
   }
 
   /**
@@ -105,7 +105,7 @@ export class Aspi<TRequest extends RequestInit = RequestInit> {
    * const response = await api.patch('/users/1', { name: 'John' }).json();
    */
   patch(path: string, body?: BodyInit) {
-    return this.#createRequest("PATCH", path, body);
+    return this.#createRequest('PATCH', path, body);
   }
 
   /**
@@ -117,7 +117,7 @@ export class Aspi<TRequest extends RequestInit = RequestInit> {
    * const response = await api.delete('/users/1').json();
    */
   delete(path: string) {
-    return this.#createRequest("DELETE", path);
+    return this.#createRequest('DELETE', path);
   }
 
   /**
@@ -129,7 +129,7 @@ export class Aspi<TRequest extends RequestInit = RequestInit> {
    * const response = await api.head('/users').json();
    */
   head(path: string) {
-    return this.#createRequest("HEAD", path);
+    return this.#createRequest('HEAD', path);
   }
 
   /**
@@ -141,7 +141,7 @@ export class Aspi<TRequest extends RequestInit = RequestInit> {
    * const response = await api.options('/users').json();
    */
   options(path: string) {
-    return this.#createRequest("OPTIONS", path);
+    return this.#createRequest('OPTIONS', path);
   }
 
   /**
@@ -186,7 +186,7 @@ export class Aspi<TRequest extends RequestInit = RequestInit> {
    * api.setBearer('myAuthToken123');
    */
   setBearer(token: string) {
-    return this.setHeader("Authorization", `Bearer ${token}`);
+    return this.setHeader('Authorization', `Bearer ${token}`);
   }
 
   /**

src/error.ts

@@ -1,4 +1,4 @@
-import type { HttpErrorCodes, HttpErrorStatus } from "./http";
+import type { HttpErrorCodes, HttpErrorStatus } from './http';
 
 /**
  * Error response interface for HTTP requests
@@ -36,7 +36,7 @@ export interface ErrorRequest extends RequestInit {
  * @property {ErrorResponse} response - The error response details
  */
 export class AspiError extends Error {
-  tag = "ASPI_ERROR" as const;
+  tag = 'ASPI_ERROR' as const;
   request: ErrorRequest;
   response: ErrorResponse;
 

src/http.ts

@@ -74,12 +74,12 @@ export const getHttpErrorStatus = (status: HttpErrorCodes) => {
  * Valid HTTP methods as defined in the HTTP/1.1 specification.
  */
 export type HttpMethods =
-  | "GET"
-  | "POST"
-  | "PUT"
-  | "DELETE"
-  | "HEAD"
-  | "OPTIONS"
-  | "PATCH"
-  | "TRACE"
-  | "CONNECT";
+  | 'GET'
+  | 'POST'
+  | 'PUT'
+  | 'DELETE'
+  | 'HEAD'
+  | 'OPTIONS'
+  | 'PATCH'
+  | 'TRACE'
+  | 'CONNECT';

src/index.ts

@@ -1,6 +1,6 @@
-export * from "./aspi";
-export * from "./error";
-export * from "./http";
-export * from "./types";
-export * from "./result";
-export * from "./request";
+export * from './aspi';
+export * from './error';
+export * from './http';
+export * from './types';
+export * from './result';
+export * from './request';

src/request.ts

@@ -3,16 +3,16 @@ import {
   type CustomError,
   type ErrorRequest,
   type ErrorResponse,
-} from "./error";
+} from './error';
 import {
   getHttpErrorStatus,
   httpErrors,
   type HttpErrorCodes,
   type HttpErrorStatus,
   type HttpMethods,
-} from "./http";
-import type { AspiConfig, CustomErrorCb, Middleware } from "./types";
-import * as Result from "./result";
+} from './http';
+import type { AspiConfig, CustomErrorCb, Middleware } from './types';
+import * as Result from './result';
 
 /**
  * A class for building and executing HTTP requests with customizable options and error handling.
@@ -117,7 +117,7 @@ export class Request<
    * request.setBearer('my-auth-token');
    */
   setBearer(token: string) {
-    return this.setHeader("Authorization", `Bearer ${token}`);
+    return this.setHeader('Authorization', `Bearer ${token}`);
   }
 
   body<Body extends {}>(body: Body) {
@@ -149,8 +149,8 @@ export class Request<
     return this as Request<
       Method,
       TRequest,
-      Omit<Opts, "notFound"> & {
-        notFound: CustomError<"NOT_FOUND", A>;
+      Omit<Opts, 'notFound'> & {
+        notFound: CustomError<'NOT_FOUND', A>;
       }
     >;
   }
@@ -172,8 +172,8 @@ export class Request<
     return this as Request<
       Method,
       TRequest,
-      Omit<Opts, "unauthorised"> & {
-        unauthorised: CustomError<"UNAUTHORIZED", A>;
+      Omit<Opts, 'unauthorised'> & {
+        unauthorised: CustomError<'UNAUTHORIZED', A>;
       }
     >;
   }
@@ -195,8 +195,8 @@ export class Request<
     return this as Request<
       Method,
       TRequest,
-      Omit<Opts, "forbidden"> & {
-        forbidden: CustomError<"FORBIDDEN", A>;
+      Omit<Opts, 'forbidden'> & {
+        forbidden: CustomError<'FORBIDDEN', A>;
       }
     >;
   }
@@ -268,10 +268,10 @@ export class Request<
     Result.Result<
       T,
       | AspiError
-      | (Opts extends { notFound: any } ? Opts["notFound"] : never)
-      | (Opts extends { unauthorised: any } ? Opts["unauthorised"] : never)
-      | (Opts extends { forbidden: any } ? Opts["forbidden"] : never)
-      | (Opts extends { httpError: any } ? Opts["httpError"] : never)
+      | (Opts extends { notFound: any } ? Opts['notFound'] : never)
+      | (Opts extends { unauthorised: any } ? Opts['unauthorised'] : never)
+      | (Opts extends { forbidden: any } ? Opts['forbidden'] : never)
+      | (Opts extends { httpError: any } ? Opts['httpError'] : never)
     >
   > {
     try {
@@ -283,8 +283,8 @@ export class Request<
       const response = await fetch(
         [
           new URL(this.#path, this.#baseUrl).toString(),
-          this.#queryParams ? `?${this.#queryParams.toString()}` : "",
-        ].join(""),
+          this.#queryParams ? `?${this.#queryParams.toString()}` : '',
+        ].join(''),
         requestInit,
       );
 
@@ -324,11 +324,11 @@ export class Request<
     } catch (error) {
       return Result.err(
         new AspiError(
-          error instanceof Error ? error.message : "Something went wrong",
+          error instanceof Error ? error.message : 'Something went wrong',
           this.#request(),
           {
             status: 500,
-            statusText: "INTERNAL_SERVER_ERROR",
+            statusText: 'INTERNAL_SERVER_ERROR',
           },
         ),
       );

src/result.ts

@@ -1,5 +1,5 @@
-export type Ok<T> = { __tag: "ok"; value: T };
-export type Err<E> = { __tag: "err"; error: E };
+export type Ok<T> = { __tag: 'ok'; value: T };
+export type Err<E> = { __tag: 'err'; error: E };
 
 /**
  * Represents either a successful value of type T or an error of type E
@@ -15,15 +15,15 @@ export type Result<T, E> = Ok<T> | Err<E>;
  * const result = ok(42);
  * // { __tag: "ok", value: 42 }
  */
-export const ok = <T>(value: T): Ok<T> => ({ __tag: "ok", value });
+export const ok = <T>(value: T): Ok<T> => ({ __tag: 'ok', value });
 
 /**
  * Creates a failed Result
  * @example
  * const result = err("not found");
  * // { __tag: "err", error: "not found" }
  */
-export const err = <E>(error: E): Err<E> => ({ __tag: "err", error });
+export const err = <E>(error: E): Err<E> => ({ __tag: 'err', error });
 
 /**
  * Returns true if the result is a success
@@ -35,7 +35,7 @@ export const err = <E>(error: E): Err<E> => ({ __tag: "err", error });
  * isOk(error) // false
  */
 export const isOk = <T, E>(result: Result<T, E>): result is Ok<T> =>
-  result.__tag === "ok";
+  result.__tag === 'ok';
 
 /**
  * Returns true if the result is a failure

src/types.ts

@@ -1,6 +1,6 @@
-import type { ErrorRequest, ErrorResponse } from "./error";
+import type { ErrorRequest, ErrorResponse } from './error';
 
-export type AspiRequestConfig = Pick<RequestInit, "headers" | "mode">;
+export type AspiRequestConfig = Pick<RequestInit, 'headers' | 'mode'>;
 export type CustomErrorCb<T, A extends {}> = (input: {
   request: ErrorRequest;
   response: ErrorResponse;

tsup.config.ts

@@ -1,9 +1,9 @@
-import { defineConfig } from "tsup";
+import { defineConfig } from 'tsup';
 
 export default defineConfig({
-  entryPoints: ["src/index.ts"],
-  format: ["cjs", "esm"],
+  entryPoints: ['src/index.ts'],
+  format: ['cjs', 'esm'],
   dts: true,
-  outDir: "dist",
+  outDir: 'dist',
   clean: true,
 });