glitch-javascript-sdk 0.0.1 → 0.0.3

package/dist/esm/routes/EventsRoute.d.ts

@@ -0,0 +1,7 @@
+import Route from "./interface";
+declare class EventsRoutes {
+    static routes: {
+        [key: string]: Route;
+    };
+}
+export default EventsRoutes;

package/dist/esm/routes/UserRoutes.d.ts

@@ -0,0 +1,7 @@
+import Route from "./interface";
+declare class UserRoutes {
+    static routes: {
+        [key: string]: Route;
+    };
+}
+export default UserRoutes;

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,22 +21,210 @@ 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 Users {
+    /**
+     * List all the users.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userList
+     *
+     * @returns promise
+     */
+    static list<T>(): AxiosPromise<Response<T>>;
+    /**
+     * Updates a users information. Requires the users JSON Web Token (JWT) for them to update their profile.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/updateUser
+     *
+     * @param data The date to be passed when creating a competiton.
+     *
+     * @returns Promise
+     */
+    static update<T>(data: object): AxiosPromise<Response<T>>;
+    /**
+     * Gets the current users information based on the current Json Web Token (JWT).
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/showMe
+     *
+     * @param user_id The id of the user to update.
+     * @param data The data to update.
+     *
+     * @returns promise
+     */
+    static me<T>(): AxiosPromise<Response<T>>;
+    /**
+     * Will follow and unfollow a user. If the user is not being following, it will follow the user. If they are following, it will unfollow the user. The current JWT is used for the follower.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userToggleFollow
+     *
+     * @param user_id The id fo the user to retrieve.
+     *
+     * @returns promise
+     */
+    static followToggle<T>(user_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Show a users profile.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/showUser
+     *
+     * @param user_id The id of the user to delete.
+     * @returns promise
+     */
+    static profile<T>(user_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Retrieves a user's one time login token based on a users JWT.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userOneTimeLoginToken
+     *
+     *
+     * @returns promise
+     */
+    static oneTimeLoginToken<T>(): AxiosPromise<Response<T>>;
+}
+
+declare class Events {
+    /**
+     * List all the events
+     *
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/resourceEventList
+     *
+     * @returns promise
+     */
+    static list<T>(): AxiosPromise<Response<T>>;
+    /**
+     * Create a new event.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/newEventResourceStorage
+     *
+     * @param data The data to be passed when creating an event.
+     *
+     * @returns Promise
+     */
+    static create<T>(data: object): AxiosPromise<Response<T>>;
+    /**
+     * Update a event
+     *
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/updateEventStorage
+     *
+     * @param event_id The id of the event to update.
+     * @param data The data to update.
+     *
+     * @returns promise
+     */
+    static update<T>(event_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve the information for a single event.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/showEventStorage
+     *
+     * @param event_id The id fo the event to retrieve.
+     *
+     * @returns promise
+     */
+    static view<T>(event_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Deletes a event.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/destoryEventStorage
+     *
+     * @param event_id The id of the event to delete.
+     * @returns promise
+     */
+    static delete<T>(event_id: string): AxiosPromise<Response<T>>;
 }
 
 declare class Glitch {
     static config: typeof Config;
-    static auth: typeof Auth;
-    static competitions: typeof Competitions;
+    static api: {
+        Auth: typeof Auth;
+        Competitions: typeof Competitions;
+        Users: typeof Users;
+        Events: typeof Events;
+    };
 }
 
 export { Glitch };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glitch-javascript-sdk",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "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/api/Events.ts

@@ -0,0 +1,81 @@
+import EventsRoutes from "../routes/EventsRoute";
+import Requests from "../util/Requests";
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+
+class Events {
+
+    /**
+     * List all the events
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/resourceEventList
+     * 
+     * @returns promise
+     */
+    public static list<T>() :  AxiosPromise<Response<T>> {
+        return Requests.processRoute(EventsRoutes.routes.list);
+    }
+
+    /**
+     * Create a new event.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/newEventResourceStorage
+     * 
+     * @param data The data to be passed when creating an event.
+     * 
+     * @returns Promise
+     */
+    public static create<T>(data : object) :  AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.create, data);
+    }
+
+    /**
+     * Update a event
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/updateEventStorage
+     * 
+     * @param event_id The id of the event to update.
+     * @param data The data to update.
+     * 
+     * @returns promise
+     */
+    public static update<T>(event_id : string, data : object)  :  AxiosPromise<Response<T>>{
+
+        return Requests.processRoute(EventsRoutes.routes.create, data, {event_id : event_id});
+    }
+
+    /**
+     * Retrieve the information for a single event.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/showEventStorage
+     * 
+     * @param event_id The id fo the event to retrieve.
+     * 
+     * @returns promise
+     */
+    public static view<T>(event_id : string) :  AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.view, {}, {event_id : event_id});
+    }
+
+    /**
+     * Deletes a event.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Event%20Route/destoryEventStorage
+     * 
+     * @param event_id The id of the event to delete.
+     * @returns promise
+     */
+    public static delete<T>(event_id : string) :  AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(EventsRoutes.routes.delete, {}, {event_id : event_id});
+    }
+
+    
+
+    
+
+}
+
+export default Events;

package/src/api/Users.ts

@@ -0,0 +1,92 @@
+import UserRoutes from "../routes/UserRoutes";
+import Requests from "../util/Requests";
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+
+class Users {
+
+    /**
+     * List all the users.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userList
+     * 
+     * @returns promise
+     */
+    public static list<T>(): AxiosPromise<Response<T>> {
+        return Requests.processRoute(UserRoutes.routes.list);
+    }
+
+    /**
+     * Updates a users information. Requires the users JSON Web Token (JWT) for them to update their profile.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/updateUser
+     * 
+     * @param data The date to be passed when creating a competiton.
+     * 
+     * @returns Promise
+     */
+    public static update<T>(data: object): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(UserRoutes.routes.update, data);
+    }
+
+    /**
+     * Gets the current users information based on the current Json Web Token (JWT).
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/showMe
+     * 
+     * @param user_id The id of the user to update.
+     * @param data The data to update.
+     * 
+     * @returns promise
+     */
+    public static me<T>(): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(UserRoutes.routes.me, {});
+    }
+
+    /**
+     * Will follow and unfollow a user. If the user is not being following, it will follow the user. If they are following, it will unfollow the user. The current JWT is used for the follower.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userToggleFollow
+     * 
+     * @param user_id The id fo the user to retrieve.
+     * 
+     * @returns promise
+     */
+    public static followToggle<T>(user_id: string): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(UserRoutes.routes.follow, {}, { user_id: user_id });
+    }
+
+    /**
+     * Show a users profile.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/showUser
+     * 
+     * @param user_id The id of the user to delete.
+     * @returns promise
+     */
+    public static profile<T>(user_id: string): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(UserRoutes.routes.profile, {}, { user_id: user_id });
+    }
+
+    /**
+     * Retrieves a user's one time login token based on a users JWT.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userOneTimeLoginToken
+     * 
+     * 
+     * @returns promise
+     */
+    public static oneTimeLoginToken<T>(): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(UserRoutes.routes.oneTimeToken, {});
+    }
+
+
+
+}
+
+export default Users;

package/src/api/index.ts

@@ -1,5 +1,9 @@
 import Auth from "./Auth";
 import Competitions from "./Competitions";
+import Users from "./Users";
+import Events from "./Events";
 
 export {Auth};
-export {Competitions};
+export {Competitions};
+export {Users};
+export {Events};

package/src/index.ts

@@ -5,13 +5,19 @@ import Config from "./config/Config";
 //API
 import { Auth } from "./api";
 import { Competitions } from "./api";
+import { Users } from "./api";
+import {Events} from "./api";
 
 class Glitch {
 
     public static config: typeof Config = Config;
 
-    public static auth: typeof Auth = Auth;
-    public static competitions: typeof Competitions = Competitions;
+    public static api : {
+        Auth : typeof Auth,
+        Competitions: typeof Competitions,
+        Users: typeof Users
+        Events : typeof Events
+    }
 
 
   }

package/src/routes/EventsRoute.ts

@@ -0,0 +1,33 @@
+import Route from "./interface";
+import HTTP_METHODS from "../constants/HttpMethods";
+
+class EventsRoutes {
+    
+    public static routes: { [key: string]: Route } = {
+      list: { url: '/events', method: HTTP_METHODS.GET },
+      create: { url: '/events', method: HTTP_METHODS.POST  },
+      view : { url: '/events/{event_id}', method: HTTP_METHODS.GET  },
+      update  :{ url: '/events/{event_id}', method: HTTP_METHODS.PUT  },
+      delete : { url: '/events/{event_id}', method: HTTP_METHODS.DELETE },
+      updateInvirtu : {url : '/events/{uuid}/invirtu', method: HTTP_METHODS.PUT },
+      updateRTMPSource : {url : '/events/{uuid}/updateRTMPSource/{subid}', method: HTTP_METHODS.PUT },
+      removeRTMPSource : {url : '/events/{uuid}/removeRTMPSource/{subid}', method: HTTP_METHODS.DELETE},
+      uploadMainImage : {url : '/events/{uuid}/removeRTMPSource/{subid}', method: HTTP_METHODS.POST},
+      uploadBannerImage : {url : '/events/{uuid}/uploadBannerImage', method: HTTP_METHODS.POST},
+      enableBroadcastMode : {url : '/events/{uuid}/uploadBannerImage', method: HTTP_METHODS.POST},
+      enableLiestreamMode  : {url : '/events/{uuid}/enableLivestreamMode', method: HTTP_METHODS.POST},
+      sendOnScreenContent : {url : '/events/{uuid}/sendOnScreenContent', method: HTTP_METHODS.POST},
+      addOveleray : {url : '/events/{uuid}/addOverlay', method : HTTP_METHODS.POST},
+      removeOverlay : {url : '/events/{uuid}/removeOverlay/{subid}',  method : HTTP_METHODS.DELETE},
+      enableOverlay : {url : '/events/{uuid}/enableOverlay/{subid}', method : HTTP_METHODS.POST},
+      disableOverlay : {url : '/events/{uuid}/disableOverlay', method: HTTP_METHODS.POST},
+      enableDonations : {url : '/events/{uuid}/enableDonations', method: HTTP_METHODS.POST},
+      disableDonations : {url : '/events/{uuid}/disableDonations', method : HTTP_METHODS.POST},
+      sendInvite : {url : '/events/{uuid}/sendInvite', method : HTTP_METHODS.POST},
+      acceptInvite : {url : '/events/{uuid}/sendInvite', method : HTTP_METHODS.POST}
+
+    };
+
+  }
+
+  export default EventsRoutes;