glitch-javascript-sdk 0.0.2 → 0.0.4

package/src/api/Users.ts

@@ -0,0 +1,166 @@
+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, {});
+    }
+
+    /**
+     * Updates the avatar image for the user using a File object.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userUploadAvatarImage
+     * 
+     * @param file The file object to upload.
+     * @param data Any additional data to pass along to the upload.
+     * 
+     * @returns promise
+     */
+    public static uploadAvatarImageFile<T>(file : File, data? : object): AxiosPromise<Response<T>> {
+
+        return Requests.uploadFile(UserRoutes.routes.uploadAvatar.url, 'image', file, data);
+    }
+
+    /**
+     * Updates the avatar image for the user using a Blob.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userUploadAvatarImage
+     * 
+     * @param blob The blob to upload.
+     * @param data Any additional data to pass along to the upload
+     * 
+     * @returns promise
+     */
+    public static uploadAvatarImageBlob<T>(blob : Blob, data? : object): AxiosPromise<Response<T>> {
+
+        return Requests.uploadBlob(UserRoutes.routes.uploadAvatar.url, 'image', blob, data);
+    }
+
+    /**
+     * Upload a banner image for the user, as a File object.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userUploadBannerImage
+     * 
+     * @param file The file object to upload.
+     * @param data Any additional data to pass along to the upload.
+     * 
+     * @returns promise
+     */
+    public static uploadBannerImageFile<T>(file : File, data? : object): AxiosPromise<Response<T>> {
+
+        return Requests.uploadFile(UserRoutes.routes.uploadBanner.url, 'image', file, data);
+    }
+
+    /**
+     * Upload a banner image for the user, as a Blob.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userUploadBannerImage
+     * 
+     * @param file The blob to upload.
+     * @param data Any additional data to pass along to the upload.
+     * 
+     * @returns promise
+     */
+    public static uploadBannerImageBlob<T>(blob : Blob, data? : object): AxiosPromise<Response<T>> {
+
+        return Requests.uploadBlob(UserRoutes.routes.uploadBanner.url, 'image', blob, data);
+    }
+
+    /**
+     * Creates a donation page for that user by syncing their information with various
+     * payment service.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Users%20Route/userCreateDonationPage
+     * 
+     * @returns promise
+     */
+    public static createDonationPage<T>(): AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(UserRoutes.routes.createDonationPage, {});
+    }
+
+
+
+
+}
+
+export default Users;

package/src/api/index.ts

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

package/src/index.ts

@@ -5,13 +5,21 @@ import Config from "./config/Config";
 //API
 import { Auth } from "./api";
 import { Competitions } from "./api";
+import { Users } from "./api";
+import {Events} from "./api";
+import {Teams} 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,
+        Teams : typeof Teams
+    }
 
 
   }

package/src/routes/EventsRoute.ts

@@ -0,0 +1,35 @@
+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/{event_id}/invirtu', method: HTTP_METHODS.PUT },
+      syncAsLive : {url : '/events/{event_id}/syncAsLive', method: HTTP_METHODS.POST },
+      addRTMPSource : {url : '/events/{event_id}/addRTMPSource', method: HTTP_METHODS.POST },
+      updateRTMPSource : {url : '/events/{event_id}/updateRTMPSource/{subid}', method: HTTP_METHODS.PUT },
+      removeRTMPSource : {url : '/events/{event_id}/removeRTMPSource/{subid}', method: HTTP_METHODS.DELETE},
+      uploadMainImage : {url : '/events/{event_id}/removeRTMPSource/{subid}', method: HTTP_METHODS.POST},
+      uploadBannerImage : {url : '/events/{event_id}/uploadBannerImage', method: HTTP_METHODS.POST},
+      enableBroadcastMode : {url : '/events/{event_id}/uploadBannerImage', method: HTTP_METHODS.POST},
+      enableLivestreamMode  : {url : '/events/{event_id}/enableLivestreamMode', method: HTTP_METHODS.POST},
+      sendOnScreenContent : {url : '/events/{event_id}/sendOnScreenContent', method: HTTP_METHODS.POST},
+      addOverlay : {url : '/events/{event_id}/addOverlay', method : HTTP_METHODS.POST},
+      removeOverlay : {url : '/events/{event_id}/removeOverlay/{subid}',  method : HTTP_METHODS.DELETE},
+      enableOverlay : {url : '/events/{event_id}/enableOverlay/{subid}', method : HTTP_METHODS.POST},
+      disableOverlay : {url : '/events/{event_id}/disableOverlay', method: HTTP_METHODS.POST},
+      enableDonations : {url : '/events/{event_id}/enableDonations', method: HTTP_METHODS.POST},
+      disableDonations : {url : '/events/{event_id}/disableDonations', method : HTTP_METHODS.POST},
+      sendInvite : {url : '/events/{event_id}/sendInvite', method : HTTP_METHODS.POST},
+      acceptInvite : {url : '/events/{event_id}/sendInvite', method : HTTP_METHODS.POST}
+
+    };
+
+  }
+
+  export default EventsRoutes;

package/src/routes/TeamsRoute.ts

@@ -0,0 +1,26 @@
+import Route from "./interface";
+import HTTP_METHODS from "../constants/HttpMethods";
+
+class TeamsRoute {
+    
+    public static routes: { [key: string]: Route } = {
+      list: { url: '/teams', method: HTTP_METHODS.GET },
+      create: { url: '/teams', method: HTTP_METHODS.POST  },
+      view : { url: '/teams/{team_id}', method: HTTP_METHODS.GET  },
+      update  :{ url: '/teams/{team_id}', method: HTTP_METHODS.PUT  },
+      delete : { url: '/teams/{team_id}', method: HTTP_METHODS.DELETE },
+      uploadMainImage : {url: '/teams/{team_id}/uploadMainImage', method : HTTP_METHODS.POST },
+      uploadBannerImage : {url : '/teams/{team_id}/uploadBannerImage', method : HTTP_METHODS.POST },
+      listInvites : {url : '/teams/{team_id}/invites', method : HTTP_METHODS.GET },
+      sendInvite : {url: '/teams/{team_id}/sendInvite', method : HTTP_METHODS.POST},
+      acceptInvite : {url : '/teams/{team_id}/acceptInvite', method: HTTP_METHODS.POST},
+      listTeamUsers : {url : '/teams/{team_id}/users', method : HTTP_METHODS.GET},
+      addTeamUser : {url : '/teams/{team_id}/users',  method : HTTP_METHODS.POST},
+      showTeamUser : {url : '/teams/{team_id}/users/{user_id}', method : HTTP_METHODS.GET},
+      updateTeamUser : {url : '/teams/{team_id}/users/{user_id}', method : HTTP_METHODS.PUT},
+      removeTeamUser : {url : '/teams/{team_id}/users/{user_id}', method : HTTP_METHODS.DELETE}
+    };
+
+  }
+
+  export default TeamsRoute;

package/src/routes/UserRoutes.ts

@@ -0,0 +1,20 @@
+import Route from "./interface";
+import HTTP_METHODS from "../constants/HttpMethods";
+
+class UserRoutes {
+    
+    public static routes: { [key: string]: Route } = {
+      list: { url: '/users', method: HTTP_METHODS.GET },
+      update: { url: '/users', method: HTTP_METHODS.PUT  },
+      follow : { url: '/users/{user_id}/follow', method: HTTP_METHODS.POST  },
+      profile  :{ url: '/users/{user_id}/profile', method: HTTP_METHODS.GET  },
+      me : { url: '/users/me', method: HTTP_METHODS.GET },
+      oneTimeToken : { url: '/users/oneTimeToken', method: HTTP_METHODS.GET },
+      uploadAvatar : { url: '/users/uploadAvatarImage', method: HTTP_METHODS.POST },
+      uploadBanner : { url: '/users/uploadBannerImage', method: HTTP_METHODS.POST },
+      createDonationPage : { url: '/users/createDonationPage', method: HTTP_METHODS.POST },
+    };
+
+  }
+
+  export default UserRoutes;

package/src/util/Requests.ts

@@ -53,16 +53,27 @@ class Requests {
   private static request<T>(
     method: 'GET' | 'POST' | 'PUT' | 'DELETE',
     url: string,
-    data?: any
+    data?: any,
+    fileData?: any
   ): AxiosPromise<Response<T>> {
+
+    let headers = {
+      'Content-Type': 'application/json',
+    };
+
+     if(this.authToken) {
+      headers['Authorization'] = `Bearer ${this.authToken}`;
+     }
+
+    if (fileData) {
+      headers['Content-Type'] = 'multipart/form-data';
+    }
+
     const axiosPromise = axios({
       method,
       url: `${this.baseUrl}${url}`,
-      data,
-      headers: {
-        Authorization: `Bearer ${this.authToken}`,
-        'Content-Type': 'application/json',
-      },
+      data: fileData || data,
+      headers,
     });
 
     return axiosPromise;
@@ -90,6 +101,42 @@ class Requests {
     return this.request<T>('DELETE', url);
   }
 
+  public static uploadFile<T>(
+    url: string,
+    filename : string,
+    file: File,
+    data?: any
+  ): AxiosPromise<Response<T>> {
+    
+    const formData = new FormData();
+
+    formData.append(filename, file);
+
+    for (let key in data) {
+      formData.append(key, data[key]);
+    }
+
+    return this.request<T>('POST', url, data, formData);
+  }
+
+  public static uploadBlob<T>(
+    url: string,
+    filename : string,
+    blob: Blob,
+    data?: any
+  ): AxiosPromise<Response<T>> {
+
+    const formData = new FormData();
+
+    formData.append(filename, blob);
+
+    for (let key in data) {
+      formData.append(key, data[key]);
+    }
+
+    return this.request<T>('POST', url, data, formData);
+  }
+
   /**
    *  The Route class contains the method and url, thereforce items can be
    *  automatically routed depending on the configuration.