glitch-javascript-sdk 0.0.1

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

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

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

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

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

@@ -0,0 +1,5 @@
+interface Route {
+    url: string;
+    method: string;
+}
+export default Route;

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

@@ -0,0 +1,27 @@
+import Config from '../config/Config';
+import Route from '../routes/interface';
+import Response from './Response';
+declare class Requests {
+    config: Config;
+    private static baseUrl;
+    private static authToken;
+    constructor(config: Config);
+    static setConfig(config: Config): void;
+    static setBaseUrl(url: string): void;
+    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>>;
+    /**
+     *  The Route class contains the method and url, thereforce items can be
+     *  automatically routed depending on the configuration.
+     *
+     * @param route
+     * @param data
+     * @returns
+     */
+    static processRoute(route: Route, data?: object, routeReplace?: object): Promise<Response<unknown> | undefined>;
+}
+export default Requests;

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

@@ -0,0 +1,6 @@
+interface Response<T> {
+    data: T;
+    success: boolean;
+    message?: string;
+}
+export default Response;

package/dist/index.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Config
+ *
+ * The configuration class will hold the configuration information used when accessing the
+ * API.
+ */
+declare class Config {
+    baseUrl: string;
+    authToken: string;
+    constructor(baseUrl: string, authToken: string);
+    setBaseUrl(baseUrl: string): void;
+    setAuthToken(authToken: string): void;
+}
+
+interface Response<T> {
+    data: T;
+    success: boolean;
+    message?: string;
+}
+
+declare class Auth {
+    static login(login: string, password: string): Promise<Response<unknown>>;
+    static register(data: object): Promise<Response<unknown> | undefined>;
+}
+
+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>;
+}
+
+declare class Glitch {
+    static config: typeof Config;
+    static auth: typeof Auth;
+    static competitions: typeof Competitions;
+}
+
+export { Glitch };

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "glitch-javascript-sdk",
+  "version": "0.0.1",
+  "description": "Javascrip SDK for GLitch",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "files": [
+    "dist",
+    "src"
+  ],
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "rm -Rf dist && rollup -c --bundleConfigAsCjs",
+    "build-docs": "rm  -rf docs && typedoc  --tsconfig tsconfig.json src/"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^23.0.2",
+    "@rollup/plugin-json": "^5.0.1",
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "@rollup/plugin-typescript": "^9.0.2",
+    "@types/isomorphic-form-data": "^2.0.1",
+    "@types/node": "^18.11.6",
+    "get-file-object-from-local-path": "^1.0.2",
+    "rollup": "^3.2.5",
+    "rollup-plugin-dts": "^5.0.0",
+    "rollup-plugin-polyfill-node": "^0.11.0",
+    "typedoc": "^0.23.15",
+    "typescript": "^4.8.4"
+  },
+  "dependencies": {
+    "axios": "^0.27.2",
+    "buffer": "^6.0.3",
+    "fetch-blob": "^3.2.0",
+    "isomorphic-form-data": "^2.0.0",
+    "tslib": "^2.4.0"
+  }
+}

package/src/api/Auth.ts

@@ -0,0 +1,15 @@
+import AuthRoutes from "../routes/AuthRoute";
+import Requests from "../util/Requests";
+
+class Auth {
+
+    public static login(login: string, password: string) {
+        return Requests.post(AuthRoutes.routes.login.url, {email : login, password: password});
+    }
+
+    public static register(data : object) {
+        return Requests.processRoute(AuthRoutes.routes.register, data);
+    }
+}
+
+export default Auth;

package/src/api/Competitions.ts

@@ -0,0 +1,34 @@
+import CompetitionRoutes from "../routes/CompetitionRoute";
+import Requests from "../util/Requests";
+
+class Competitions {
+
+    public static list() {
+        return Requests.processRoute(CompetitionRoutes.routes.list);
+    }
+
+    public static create(data : object) {
+
+        return Requests.processRoute(CompetitionRoutes.routes.create, data);
+    }
+
+    public static update(competition_id : string, data : object) {
+
+        return Requests.processRoute(CompetitionRoutes.routes.create, data, {competition_id : competition_id});
+    }
+
+    public static view(competition_id : string) {
+
+        return Requests.processRoute(CompetitionRoutes.routes.view, {}, {competition_id : competition_id});
+    }
+
+    public static delete(competition_id : string) {
+
+        return Requests.processRoute(CompetitionRoutes.routes.delete, {}, {competition_id : competition_id});
+    }
+
+    
+
+}
+
+export default Competitions;

package/src/api/index.ts

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

package/src/config/Config.ts

@@ -0,0 +1,37 @@
+import Requests from "../util/Requests";
+
+/**
+ * Config
+ * 
+ * The configuration class will hold the configuration information used when accessing the
+ * API.
+ */
+class Config {
+    //The base url of the API, ie: http://api.example.com/v1/
+    baseUrl: string;
+
+    //The JWT token used to access the api.
+    authToken: string;
+  
+    constructor(baseUrl: string, authToken: string) {
+      this.baseUrl = baseUrl;
+      this.authToken = authToken;
+
+      Requests.setConfig(this);
+    }
+
+    setBaseUrl(baseUrl: string) {
+      this.baseUrl = baseUrl;
+
+      Requests.setBaseUrl(baseUrl);
+    }
+
+    setAuthToken(authToken: string) {
+      this.authToken = authToken;
+
+      Requests.setAuthToken(authToken);
+    }
+
+  }
+
+  export default Config;

package/src/constants/HttpMethods.ts

@@ -0,0 +1,8 @@
+const HTTP_METHODS = {
+    GET: 'GET',
+    POST: 'POST',
+    PUT: 'PUT',
+    DELETE: 'DELETE',
+  }  as const;
+
+  export default HTTP_METHODS;

package/src/constants/api_routes.js

@@ -0,0 +1,397 @@
+
+/**
+ * The routes to the endpoints.
+ */
+
+const api_routes = {
+    //Authentication Routes
+    auth_login : {
+        route : '/auth/login',
+        method : 'POST',
+    },
+    auth_register : { 
+        route :'/auth/register',
+        method : 'POST'
+    },
+    auth_one_time_login : { 
+        route :'/auth/oneTimeLoginWithToken',
+        method : 'POST'
+    },
+    auth_forgot_password : { 
+        route :'/auth/forgotpassword',
+        method : 'POST'
+    },
+    auth_reset_password : { 
+        route :'/auth/resetpassword',
+        method : 'POST'
+    },
+
+    //Competitions
+    competitions_list : {
+        route: '/competitions',
+        method : 'GET'
+    },
+    competitions_create : {
+        route : '/competitions',
+        method : 'POST'
+    },
+    competitions_view : {
+        route : '/competitions/{competition_id}',
+        method : 'GET'
+    },
+    competitions_update : {
+        route : '/competitions/{competition_id}',
+        method : 'PUT'
+    },
+    competitions_delete : {
+        route : '/competitions/{competition_id}',
+        method : 'DELETE'
+    },
+    competitions_upload_main_image : {
+        route : '/competitions/{competition_id}/uploadMainImage',
+        method : 'POST'
+    },
+    competitions_upload_main_banner : {
+        route : '/competitions/{competition_id}/uploadBannerImage',
+        method : 'POST'
+    },
+    competitions_register_team : {
+        route : '/competitions/{competition_id}/registerTeam',
+        method : 'POST'
+    },
+    competitions_register_individual : {
+        route : '/competitions/{competition_id}/registerUser',
+        method : 'POST'
+    },
+    competitions_rounds_list : {
+        route: '/competitions/{competition_id}/rounds',
+        method : 'GET'
+    },
+    competitions_rounds_create : {
+        route : '/competitions/{competition_id}/rounds',
+        method : 'POST'
+    },
+    competitions_rounds_view : {
+        route : '/competitions/{competition_id}/rounds/{round_id}',
+        method : 'GET'
+    },
+    competitions_rounds_update : {
+        route : '/competitions/{competition_id}/rounds/{round_id}',
+        method : 'PUT'
+    },
+    competitions_rounds_delete : {
+        route : '/competitions/{competition_id}/rounds/{round_id}',
+        method : 'DELETE'
+    },
+    competitions_teams_list : {
+        route: '/competitions/{competition_id}/teams',
+        method : 'GET'
+    },
+    competitions_teams_create : {
+        route : '/competitions/{competition_id}/teams',
+        method : 'POST'
+    },
+    competitions_teams_view : {
+        route : '/competitions/{competition_id}/teams/{team_id}',
+        method : 'GET'
+    },
+    competitions_teams_update : {
+        route : '/competitions/{competition_id}/teams/{team_id}',
+        method : 'PUT'
+    },
+    competitions_teams_delete : {
+        route : '/competitions/{competition_id}/teams/{team_id}',
+        method : 'DELETE'
+    },
+    competitions_teams_list : {
+        route: '/competitions/{competition_id}/teams',
+        method : 'GET'
+    },
+    competitions_users_create : {
+        route : '/competitions/{competition_id}/users',
+        method : 'POST'
+    },
+    competitions_users_view : {
+        route : '/competitions/{competition_id}/users/{user_id}',
+        method : 'GET'
+    },
+    competitions_users_update : {
+        route : '/competitions/{competition_id}/users/{user_id}',
+        method : 'PUT'
+    },
+    competitions_users_delete : {
+        route : '/competitions/{competition_id}/users/{user_id}',
+        method : 'DELETE'
+    },
+    competitions_venues_list : {
+        route: '/competitions/{competition_id}/venues',
+        method : 'GET'
+    },
+    competitions_venues_create : {
+        route : '/competitions/{competition_id}/venues',
+        method : 'POST'
+    },
+    competitions_venues_view : {
+        route : '/competitions/{competition_id}/venues/{venue_id}',
+        method : 'GET'
+    },
+    competitions_venues_update : {
+        route : '/competitions/{competition_id}/venues/{venue_id}',
+        method : 'PUT'
+    },
+    competitions_venues_delete : {
+        route : '/competitions/{competition_id}/venues/{venue_id}',
+        method : 'DELETE'
+    },
+    competitions_round_brackets_list : {
+        route: '/competitions/{competition_id}/rounds/{round_id}/brackets',
+        method : 'GET'
+    },
+    competitions_round_brackets_create : {
+        route : '/competitions/{competition_id}/rounds/{round_id}/brackets',
+        method : 'POST'
+    },
+    competitions_round_brackets_view : {
+        route : '/competitions/{competition_id}/rounds/{round_id}/brackets/{bracket_id}',
+        method : 'GET'
+    },
+    competitions_round_brackets_update : {
+        route : '/competitions/{competition_id}/rounds/{round_id}/brackets/{bracket_id}',
+        method : 'PUT'
+    },
+    competitions_round_brackets_delete : {
+        route : '/competitions/{competition_id}/rounds/{round_id}/brackets/{bracket_id}',
+        method : 'DELETE'
+    },
+
+
+
+
+
+
+    //Events
+    events_list : {
+        route: '/events',
+        method : 'GET'
+    },
+    events_create : {
+        route : '/events',
+        method : 'POST'
+    },
+    events_view : {
+        route : '/events/{event_id}',
+        method : 'GET'
+    },
+    events_update : {
+        route : '/events/{event_id}',
+        method : 'PUT'
+    },
+    events_delete : {
+        route : '/events/{event_id}',
+        method : 'DELETE'
+    },
+    events_add_rtmp_source : {
+        route : '/events/{event_id}/addRTMPSource',
+        method : 'POST'
+    },
+    events_update_rtmp_source : {
+        route : '/events/{event_id}/updateRTMPSource/{stream_id}',
+        method : 'PUT'
+    },
+    events_remove_rtmp_source : {
+        route : '/events/{event_id}/removeRTMPSource/{stream_id}',
+        method : 'DELETE'
+    },
+    events_upload_main_image : {
+        route : '/events/{event_id}/uploadMainImage',
+        method : 'POST'
+    },
+    events_upload_main_banner : {
+        route : '/events/{event_id}/uploadBannerImage',
+        method : 'POST'
+    },
+    events_set_broadcast_mode : {
+        route : '/events/{event_id}/enableBroadcastMode',
+        method : 'POST'
+    },
+    events_set_livestream_mode : {
+        route : '/events/{event_id}/enableLivestreamMode',
+        method : 'POST'
+    },
+    events_sync_as_live : {
+        route : '/events/{event_id}/syncAsLive',
+        method : 'POST'
+    },
+    events_send_invite : {
+        route : '/events/{event_id}/sendInvite',
+        method : 'POST'
+    },
+    events_accept_invite : {
+        route : '/events/{event_id}/acceptInvite',
+        method : 'POST'
+    },
+    events_send_onscreen_content : {
+        route : '/events/{event_id}/sendOnScreenContent',
+        method : 'POST'
+    },
+    events_update_invirtu_event : {
+        route : '/events/{event_id}/invirtu',
+        method : 'PUT'
+    },
+    events_add_overlay : {
+        route : '/events/{event_id}/addOverlay',
+        method : 'POST'
+    },
+    events_remove_overlay : {
+        route : '/events/{event_id}/removeOverlay/{overlay_id}',
+        method : 'DELETE'
+    },
+    events_enable_overlay : {
+        route : '/events/{event_id}/enableOverlay/{overlay_id}',
+        method : 'POST'
+    },
+    events_disable_overlay : {
+        route : '/events/{event_id}/disableOverlay',
+        method : 'POST'
+    },
+    events_enable_donations : {
+        route : '/events/{event_id}/enableDonations',
+        method : 'POST'
+    },
+    events_disable_donations : {
+        route : '/events/{event_id}/disableDonations',
+        method : 'POST'
+    },
+
+    //Messages
+    messages_list : {
+        route: '/messages',
+        method : 'GET'
+    },
+    messages_all_conversations : {
+        route: '/messages/threads',
+        method : 'GET'
+    },
+    messages_create_thread : {
+        route: '/messages/threads',
+        method : 'GET'
+    },
+    messages_send : {
+        route: '/messages',
+        method : 'POST'
+    },
+    messages_update : {
+        route: '/messages/{message_id}',
+        method : 'PUT'
+    },
+    messages_delete : {
+        route: '/messages/{message_id}',
+        method : 'DELETE'
+    },
+
+    //Teams
+    teams_list : {
+        route: '/teams',
+        method : 'GET'
+    },
+    teams_create : {
+        route : '/teams',
+        method : 'POST'
+    },
+    teams_view : {
+        route : '/teams/{team_id}',
+        method : 'GET'
+    },
+    teams_update : {
+        route : '/teams/{team_id}',
+        method : 'PUT'
+    },
+    teams_delete : {
+        route : '/teams/{team_id}',
+        method : 'DELETE'
+    },
+    teams_users_create : {
+        route : '/teams/{team_id}/users',
+        method : 'POST'
+    },
+    teams_users_view : {
+        route : '/teams/{team_id}/users/{user_id}',
+        method : 'GET'
+    },
+    teams_users_update : {
+        route : '/teams/{team_id}/users/{user_id}',
+        method : 'PUT'
+    },
+    teams_users_delete : {
+        route : '/teams/{team_id}/users/{user_id}',
+        method : 'DELETE'
+    },
+    teams_upload_main_image : {
+        route : '/teams/{team_id}/uploadMainImage',
+        method : 'POST'
+    },
+    teams_upload_main_banner : {
+        route : '/teams/{team_id}/uploadBannerImage',
+        method : 'POST'
+    },
+
+    //Recordings
+    recordings_update : {
+        route: '/events/{event_id}/recording/{recording_id}',
+        method : 'PUT'
+    },
+
+    //Users
+    users_list : {
+        route: '/users',
+        method : 'GET'
+    },
+    users_update : {
+        route: '/users',
+        method : 'PUT'
+    },
+    users_profile : {
+        route: '/users/{user_id}/profile',
+        method : 'GET'
+    },
+    users_me : {
+        route: '/users/me',
+        method : 'GET'
+    },
+    users_one_time_token : {
+        route: '/users/oneTimeToken',
+        method : 'GET'
+    },
+    users_profile : {
+        route: '/users/{user_id}/profile',
+        method : 'GET'
+    },
+    users_followers : {
+        route: '/users/{user_id}/followers',
+        method : 'GET'
+    },
+    users_following : {
+        route: '/users/{user_id}/following',
+        method : 'GET'
+    },
+    users_toggle_follow : {
+        route: '/users/{user_id}/follow',
+        method : 'POST'
+    },
+    users_upload_avatar : {
+        route: '/users/uploadAvatarImage',
+        method : 'POST'
+    },
+    users_upload_banner : {
+        route: '/users/uploadBannerImage',
+        method : 'POST'
+    },
+    users_create_donation_page : {
+        route: '/users/createDonationPage',
+        method : 'POST'
+    },
+
+
+}
+
+export default api_routes;

package/src/index.ts

@@ -0,0 +1,19 @@
+
+//Configuration
+import Config from "./config/Config";
+
+//API
+import { Auth } from "./api";
+import { Competitions } from "./api";
+
+class Glitch {
+
+    public static config: typeof Config = Config;
+
+    public static auth: typeof Auth = Auth;
+    public static competitions: typeof Competitions = Competitions;
+
+
+  }
+
+  export {Glitch};

package/src/routes/AuthRoute.ts

@@ -0,0 +1,16 @@
+import Route from "./interface";
+import HTTP_METHODS from "../constants/HttpMethods";
+
+class AuthRoutes {
+    
+    public static routes: { [key: string]: Route } = {
+      login: { url: '/auth/login', method: HTTP_METHODS.POST },
+      register: { url: '/auth/register', method: HTTP_METHODS.POST  },
+      one_time_login : { url: '/auth/oneTimeLoginWithToken', method: HTTP_METHODS.POST  },
+      forgot_password  :{ url: '/auth/forgotpassword', method: HTTP_METHODS.POST  },
+      reset_password : { url: '/auth/resetpassword', method: HTTP_METHODS.POST },
+    };
+
+  }
+
+  export default AuthRoutes;