glitch-javascript-sdk 0.0.1 → 0.0.2

package/dist/esm/util/Requests.d.ts

@@ -1,19 +1,41 @@
 import Config from '../config/Config';
 import Route from '../routes/interface';
 import Response from './Response';
+import { AxiosPromise } from 'axios';
 declare class Requests {
     config: Config;
     private static baseUrl;
     private static authToken;
     constructor(config: Config);
+    /**
+     * Sets the configuration of the system.
+     *
+     * @param config Config The config class.
+     */
     static setConfig(config: Config): void;
+    /**
+     * Sets the base url of the API.
+     *
+     * @param url The url to of the API.
+     */
     static setBaseUrl(url: string): void;
+    /**
+     * Sets the JSON Web token
+     *
+     * @param token
+     */
     static setAuthToken(token: string): void;
     private static request;
-    static get<T>(url: string): Promise<Response<T>>;
-    static post<T>(url: string, data: any): Promise<Response<T>>;
-    static put<T>(url: string, data: any): Promise<Response<T>>;
-    static delete<T>(url: string): Promise<Response<T>>;
+    /**
+     * Calls a GET request to the url endpoint.
+     *
+     * @param url
+     * @returns
+     */
+    static get<T>(url: string): AxiosPromise<Response<T>>;
+    static post<T>(url: string, data: any): AxiosPromise<Response<T>>;
+    static put<T>(url: string, data: any): AxiosPromise<Response<T>>;
+    static delete<T>(url: string): AxiosPromise<Response<T>>;
     /**
      *  The Route class contains the method and url, thereforce items can be
      *  automatically routed depending on the configuration.
@@ -22,6 +44,6 @@ declare class Requests {
      * @param data
      * @returns
      */
-    static processRoute(route: Route, data?: object, routeReplace?: object): Promise<Response<unknown> | undefined>;
+    static processRoute<T>(route: Route, data?: object, routeReplace?: object): AxiosPromise<Response<T>>;
 }
 export default Requests;

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { AxiosPromise } from 'axios';
+
 /**
  * Config
  *
@@ -19,16 +21,89 @@ interface Response<T> {
 }
 
 declare class Auth {
-    static login(login: string, password: string): Promise<Response<unknown>>;
-    static register(data: object): Promise<Response<unknown> | undefined>;
+    /**
+     * Attempts to authenticate a user using their email address.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/authLogin
+     *
+     * @param email The email address of the user
+     * @param password The password of the user
+     *
+     * @returns A promise
+     */
+    static loginWithEmail<T>(email: string, password: string): AxiosPromise<Response<T>>;
+    /**
+     * Attempts to authenticate a user using their username.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/authLogin
+     *
+     * @param username The username of the user
+     * @param password The password of the user
+     *
+     * @returns A promise
+     */
+    static loginWithUsername<T>(username: string, password: string): AxiosPromise<Response<T>>;
+    /**
+     * Attempts to register a user.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/authRegister
+     *
+     * @param data The data the user can register with.
+     *
+     * @returns A promise
+     */
+    static register<T>(data: object): AxiosPromise<Response<T>>;
 }
 
 declare class Competitions {
-    static list(): Promise<Response<unknown> | undefined>;
-    static create(data: object): Promise<Response<unknown> | undefined>;
-    static update(competition_id: string, data: object): Promise<Response<unknown> | undefined>;
-    static view(competition_id: string): Promise<Response<unknown> | undefined>;
-    static delete(competition_id: string): Promise<Response<unknown> | undefined>;
+    /**
+     * List all the competitions
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/resourceList
+     *
+     * @returns promise
+     */
+    static list<T>(): AxiosPromise<Response<T>>;
+    /**
+     * Create a new competition
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/newResourceStorage
+     *
+     * @param data The date to be passed when creating a competiton.
+     *
+     * @returns Promise
+     */
+    static create<T>(data: object): AxiosPromise<Response<T>>;
+    /**
+     * Update a competition
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/updateStorage
+     *
+     * @param competition_id The id of the competition to update.
+     * @param data The data to update.
+     *
+     * @returns promise
+     */
+    static update<T>(competition_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve the information for a single competition.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/showStorage
+     *
+     * @param competition_id The id fo the competition to retrieve.
+     *
+     * @returns promise
+     */
+    static view<T>(competition_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Deletes a competition.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/destoryStorage
+     *
+     * @param competition_id The id of the competition to delete.
+     * @returns promise
+     */
+    static delete<T>(competition_id: string): AxiosPromise<Response<T>>;
 }
 
 declare class Glitch {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glitch-javascript-sdk",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Javascrip SDK for GLitch",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/api/Auth.ts

@@ -1,13 +1,48 @@
 import AuthRoutes from "../routes/AuthRoute";
 import Requests from "../util/Requests";
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
 
 class Auth {
 
-    public static login(login: string, password: string) {
-        return Requests.post(AuthRoutes.routes.login.url, {email : login, password: password});
+    /**
+     * Attempts to authenticate a user using their email address.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/authLogin
+     * 
+     * @param email The email address of the user
+     * @param password The password of the user
+     * 
+     * @returns A promise
+     */
+    public static loginWithEmail<T>(email: string, password: string) :  AxiosPromise<Response<T>> {
+        return Requests.post(AuthRoutes.routes.login.url, {email : email, password: password});
     }
 
-    public static register(data : object) {
+    /**
+     * Attempts to authenticate a user using their username.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/authLogin
+     * 
+     * @param username The username of the user
+     * @param password The password of the user
+     * 
+     * @returns A promise
+     */
+    public static loginWithUsername<T>(username: string, password: string) :  AxiosPromise<Response<T>> {
+        return Requests.post(AuthRoutes.routes.login.url, {username : username, password: password});
+    }
+
+    /**
+     * Attempts to register a user.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/authRegister
+     * 
+     * @param data The data the user can register with.
+     * 
+     * @returns A promise
+     */
+    public static register<T>(data : object) : AxiosPromise<Response<T>> {
         return Requests.processRoute(AuthRoutes.routes.register, data);
     }
 }

package/src/api/Competitions.ts

@@ -1,28 +1,73 @@
 import CompetitionRoutes from "../routes/CompetitionRoute";
 import Requests from "../util/Requests";
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
 
 class Competitions {
 
-    public static list() {
+    /**
+     * List all the competitions
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/resourceList
+     * 
+     * @returns promise
+     */
+    public static list<T>() :  AxiosPromise<Response<T>> {
         return Requests.processRoute(CompetitionRoutes.routes.list);
     }
 
-    public static create(data : object) {
+    /**
+     * Create a new competition
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/newResourceStorage
+     * 
+     * @param data The date to be passed when creating a competiton.
+     * 
+     * @returns Promise
+     */
+    public static create<T>(data : object) :  AxiosPromise<Response<T>> {
 
         return Requests.processRoute(CompetitionRoutes.routes.create, data);
     }
 
-    public static update(competition_id : string, data : object) {
+    /**
+     * Update a competition
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/updateStorage
+     * 
+     * @param competition_id The id of the competition to update.
+     * @param data The data to update.
+     * 
+     * @returns promise
+     */
+    public static update<T>(competition_id : string, data : object)  :  AxiosPromise<Response<T>>{
 
         return Requests.processRoute(CompetitionRoutes.routes.create, data, {competition_id : competition_id});
     }
 
-    public static view(competition_id : string) {
+    /**
+     * Retrieve the information for a single competition.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/showStorage
+     * 
+     * @param competition_id The id fo the competition to retrieve.
+     * 
+     * @returns promise
+     */
+    public static view<T>(competition_id : string) :  AxiosPromise<Response<T>> {
 
         return Requests.processRoute(CompetitionRoutes.routes.view, {}, {competition_id : competition_id});
     }
 
-    public static delete(competition_id : string) {
+    /**
+     * Deletes a competition.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/destoryStorage
+     * 
+     * @param competition_id The id of the competition to delete.
+     * @returns promise
+     */
+    public static delete<T>(competition_id : string) :  AxiosPromise<Response<T>> {
 
         return Requests.processRoute(CompetitionRoutes.routes.delete, {}, {competition_id : competition_id});
     }

package/src/util/Requests.ts

@@ -3,19 +3,27 @@ import Config from '../config/Config';
 import HTTP_METHODS from '../constants/HttpMethods';
 import Route from '../routes/interface';
 import Response from './Response';
+import { AxiosPromise } from 'axios';
 
 class Requests {
 
   config: Config;
 
+  //The base url of the API.
   private static baseUrl = "";
 
+  //The Json Web Token to send in the header
   private static authToken = "";
 
   constructor(config: Config) {
     this.config = config;
   }
 
+  /**
+   * Sets the configuration of the system.
+   * 
+   * @param config Config The config class.
+   */
   public static setConfig(config: Config) {
 
     this.baseUrl = config.baseUrl;
@@ -23,57 +31,62 @@ class Requests {
     this.authToken = config.authToken;
   }
 
+  /**
+   * Sets the base url of the API.
+   * 
+   * @param url The url to of the API.
+   */
   public static setBaseUrl(url : string) {
     this.baseUrl = url;
   }
 
+  /**
+   * Sets the JSON Web token
+   * 
+   * @param token 
+   */
   public static setAuthToken(token : string) {
     this.authToken = token;
   }
 
-  private static async request<T>(
+  
+  private static request<T>(
     method: 'GET' | 'POST' | 'PUT' | 'DELETE',
     url: string,
     data?: any
-  ): Promise<Response<T>> {
-    try {
-      const response = await axios({
-        method,
-        url: `${this.baseUrl}${url}`,
-        data,
-        headers: {
-          Authorization: `Bearer ${this.authToken}`,
-          'Content-Type': 'application/json',
-        },
-      });
-      return {
-        data: response.data,
-        success: true,
-      };
-    } catch (error) {
-      
-      const message = error.response?.data?.message || 'An error occurred';
-      return {
-        data: null,
-        success: false,
-        message,
-      };
-    }
+  ): AxiosPromise<Response<T>> {
+    const axiosPromise = axios({
+      method,
+      url: `${this.baseUrl}${url}`,
+      data,
+      headers: {
+        Authorization: `Bearer ${this.authToken}`,
+        'Content-Type': 'application/json',
+      },
+    });
+
+    return axiosPromise;
   }
 
-  public static async get<T>(url: string): Promise<Response<T>> {
+  /**
+   * Calls a GET request to the url endpoint.
+   * 
+   * @param url 
+   * @returns 
+   */
+  public static get<T>(url: string): AxiosPromise<Response<T>> {
     return this.request<T>('GET', url);
   }
 
-  public static async post<T>(url: string, data: any): Promise<Response<T>> {
+  public static post<T>(url: string, data: any): AxiosPromise<Response<T>> {
     return this.request<T>('POST', url, data);
   }
 
-  public static async put<T>(url: string, data: any): Promise<Response<T>> {
+  public static put<T>(url: string, data: any): AxiosPromise<Response<T>> {
     return this.request<T>('PUT', url, data);
   }
 
-  public static async delete<T>(url: string): Promise<Response<T>> {
+  public static delete<T>(url: string): AxiosPromise<Response<T>> {
     return this.request<T>('DELETE', url);
   }
 
@@ -85,14 +98,14 @@ class Requests {
    * @param data 
    * @returns 
    */
-  public static async processRoute(route : Route, data? : object, routeReplace? : object) {
+  public static processRoute<T>(route : Route, data? : object, routeReplace? : object) : AxiosPromise<Response<T>> {
 
     let url = route.url;
 
     if(routeReplace) {
 
       for (let key in routeReplace) {
-        //url = url.replace("{" + key + "}", routeReplace[key]);
+        url = url.replace("{" + key + "}", routeReplace[key]);
       }
 
     }
@@ -107,6 +120,8 @@ class Requests {
       return this.delete(url);
     }
 
+    return this.get(url);
+
   }
 
 }