glitch-javascript-sdk 0.0.6 → 0.0.8

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../src/src/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAWA,IAAA,MAAA,kBAAA,YAAA;AAAA,IAAA,SAAA,MAAA,GAAA;KAaG;IAAD,OAAC,MAAA,CAAA;AAAD,CAAC,EAAA;;;;"}
+{"version":3,"file":"index.js","sources":["../../src/src/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAYA,IAAA,MAAA,kBAAA,YAAA;AAAA,IAAA,SAAA,MAAA,GAAA;KAgBC;IAAD,OAAC,MAAA,CAAA;AAAD,CAAC,EAAA;;;;"}

package/dist/esm/api/Auth.d.ts

@@ -26,12 +26,40 @@ declare class Auth {
     /**
      * Attempts to register a user.
      *
-     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/authRegister
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/oneTimeLoginToken
      *
      * @param data The data the user can register with.
      *
      * @returns A promise
      */
     static register<T>(data: object): AxiosPromise<Response<T>>;
+    /**
+     * Request an authentication token to faciliate a one time login of an user.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/oneTimeLoginToken
+     *
+     * @returns promise
+     */
+    static oneTimeLogin<T>(): AxiosPromise<Response<T>>;
+    /**
+     * Execute the password reset process using a user's email address.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/authForgotPassword
+     *
+     * @param email The email address
+     *
+     * @returns promise
+     */
+    static forgotPasswordWithEmail<T>(email: string): AxiosPromise<Response<T>>;
+    /**
+     * Resets the users password after the forgot password has been executed.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/authResetPassword
+     *
+     * @param data The parameters required to reset the password.
+     *
+     * @returns promise
+     */
+    static resetPassword<T>(data: object): AxiosPromise<Response<T>>;
 }
 export default Auth;

package/dist/esm/api/Waitlist.d.ts

@@ -1,6 +1,6 @@
 import Response from "../util/Response";
 import { AxiosPromise } from "axios";
-declare class Teams {
+declare class Waitlists {
     /**
      * List all the waitlist sign-ups.
      *
@@ -50,4 +50,4 @@ declare class Teams {
      */
     static delete<T>(waitlist_id: string): AxiosPromise<Response<T>>;
 }
-export default Teams;
+export default Waitlists;

package/dist/esm/api/index.d.ts

@@ -3,8 +3,10 @@ import Competitions from "./Competitions";
 import Users from "./Users";
 import Events from "./Events";
 import Teams from "./Teams";
+import Waitlists from "./Waitlist";
 export { Auth };
 export { Competitions };
 export { Users };
 export { Events };
 export { Teams };
+export { Waitlists };

package/dist/esm/config/Config.d.ts

@@ -5,10 +5,36 @@
  * API.
  */
 declare class Config {
-    baseUrl: string;
-    authToken: string;
-    constructor(baseUrl: string, authToken: string);
-    setBaseUrl(baseUrl: string): void;
-    setAuthToken(authToken: string): void;
+    private static _baseUrl;
+    private static _authToken;
+    private static _baseUrlLocked;
+    /**
+     * Set the configuration
+     *
+     * @param baseUrl The url base endpoint of the api
+     * @param authToken The JSON Web Token
+     */
+    static setConfig(baseUrl: string, authToken: string, lock?: boolean): void;
+    /**
+     * Sets the endpoint for the API
+     *
+     * @param baseUrl The url that connects to the APIs base
+     * @param lock If set to true, will lock the baseUrl so it cannot be changed
+     */
+    static setBaseUrl(baseUrl: string, lock?: boolean): void;
+    /**
+     * Set the JSON Web Token (JWT) that will be passed to the API
+     *
+     * @param authToken The JWT
+     */
+    static setAuthToken(authToken: string): void;
+    /**
+     * Gets base url
+     */
+    static get baseUrl(): string;
+    /**
+     * Gets auth token
+     */
+    static get authToken(): string;
 }
 export default Config;

package/dist/esm/index.d.ts

@@ -4,14 +4,18 @@ import { Competitions } from "./api";
 import { Users } from "./api";
 import { Events } from "./api";
 import { Teams } from "./api";
+import { Waitlists } from "./api";
 declare class Glitch {
-    static config: Config;
+    static config: {
+        Config: Config;
+    };
     static api: {
         Auth: Auth;
         Competitions: Competitions;
         Users: Users;
         Events: Events;
         Teams: Teams;
+        Waitlists: Waitlists;
     };
 }
 export { Glitch };

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../src/index.ts"],"sourcesContent":[null],"names":[],"mappings":"AAWA,IAAA,MAAA,kBAAA,YAAA;AAAA,IAAA,SAAA,MAAA,GAAA;KAaG;IAAD,OAAC,MAAA,CAAA;AAAD,CAAC,EAAA;;;;"}
+{"version":3,"file":"index.js","sources":["../../src/index.ts"],"sourcesContent":[null],"names":[],"mappings":"AAYA,IAAA,MAAA,kBAAA,YAAA;AAAA,IAAA,SAAA,MAAA,GAAA;KAgBC;IAAD,OAAC,MAAA,CAAA;AAAD,CAAC,EAAA;;;;"}

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

@@ -7,12 +7,6 @@ declare class Requests {
     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.
      *

package/dist/index.d.ts

@@ -7,11 +7,37 @@ import { AxiosPromise } from 'axios';
  * API.
  */
 declare class Config {
-    baseUrl: string;
-    authToken: string;
-    constructor(baseUrl: string, authToken: string);
-    setBaseUrl(baseUrl: string): void;
-    setAuthToken(authToken: string): void;
+    private static _baseUrl;
+    private static _authToken;
+    private static _baseUrlLocked;
+    /**
+     * Set the configuration
+     *
+     * @param baseUrl The url base endpoint of the api
+     * @param authToken The JSON Web Token
+     */
+    static setConfig(baseUrl: string, authToken: string, lock?: boolean): void;
+    /**
+     * Sets the endpoint for the API
+     *
+     * @param baseUrl The url that connects to the APIs base
+     * @param lock If set to true, will lock the baseUrl so it cannot be changed
+     */
+    static setBaseUrl(baseUrl: string, lock?: boolean): void;
+    /**
+     * Set the JSON Web Token (JWT) that will be passed to the API
+     *
+     * @param authToken The JWT
+     */
+    static setAuthToken(authToken: string): void;
+    /**
+     * Gets base url
+     */
+    static get baseUrl(): string;
+    /**
+     * Gets auth token
+     */
+    static get authToken(): string;
 }
 
 interface Response<T> {
@@ -46,13 +72,41 @@ declare class Auth {
     /**
      * Attempts to register a user.
      *
-     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/authRegister
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/oneTimeLoginToken
      *
      * @param data The data the user can register with.
      *
      * @returns A promise
      */
     static register<T>(data: object): AxiosPromise<Response<T>>;
+    /**
+     * Request an authentication token to faciliate a one time login of an user.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/oneTimeLoginToken
+     *
+     * @returns promise
+     */
+    static oneTimeLogin<T>(): AxiosPromise<Response<T>>;
+    /**
+     * Execute the password reset process using a user's email address.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/authForgotPassword
+     *
+     * @param email The email address
+     *
+     * @returns promise
+     */
+    static forgotPasswordWithEmail<T>(email: string): AxiosPromise<Response<T>>;
+    /**
+     * Resets the users password after the forgot password has been executed.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/authResetPassword
+     *
+     * @param data The parameters required to reset the password.
+     *
+     * @returns promise
+     */
+    static resetPassword<T>(data: object): AxiosPromise<Response<T>>;
 }
 
 declare class Competitions {
@@ -1024,14 +1078,68 @@ declare class Teams {
     static removetUser<T>(team_id: string, user_id: string): AxiosPromise<Response<T>>;
 }
 
+declare class Waitlists {
+    /**
+     * List all the waitlist sign-ups.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Waitlist%20Route/waitlistList
+     *
+     * @returns promise
+     */
+    static list<T>(): AxiosPromise<Response<T>>;
+    /**
+     * Sign-up to the waitlist.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Waitlist%20Route/waitlistCreate
+     *
+     * @param data The data to be passed when creating a team.
+     *
+     * @returns Promise
+     */
+    static create<T>(data: object): AxiosPromise<Response<T>>;
+    /**
+     * Update a waitlist.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Waitlist%20Route/waitlistUpdate
+     *
+     * @param waitlist_id The id of the team to update.
+     * @param data The data to update.
+     *
+     * @returns promise
+     */
+    static update<T>(waitlist_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve the information for a single user who signed-up to the waitlist.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Waitlist%20Route/waitlistUpdate
+     *
+     * @param waitlist_id The id fo the team to retrieve.
+     *
+     * @returns promise
+     */
+    static view<T>(waitlist_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Deletes an entry from the waitlist.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Waitlist%20Route/waitlistDelete
+     *
+     * @param waitlist_id The id of the team to delete.
+     * @returns promise
+     */
+    static delete<T>(waitlist_id: string): AxiosPromise<Response<T>>;
+}
+
 declare class Glitch {
-    static config: Config;
+    static config: {
+        Config: Config;
+    };
     static api: {
         Auth: Auth;
         Competitions: Competitions;
         Users: Users;
         Events: Events;
         Teams: Teams;
+        Waitlists: Waitlists;
     };
 }
 

package/package.json

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

package/src/api/Auth.ts

@@ -36,7 +36,7 @@ class Auth {
     /**
      * Attempts to register a user.
      * 
-     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/authRegister
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/oneTimeLoginToken
      * 
      * @param data The data the user can register with.
      * 
@@ -45,6 +45,44 @@ class Auth {
     public static register<T>(data : object) : AxiosPromise<Response<T>> {
         return Requests.processRoute(AuthRoutes.routes.register, data);
     }
+
+    /**
+     * Request an authentication token to faciliate a one time login of an user.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/oneTimeLoginToken
+     * 
+     * @returns promise
+     */
+    public static oneTimeLogin<T>() : AxiosPromise<Response<T>> {
+        return Requests.processRoute(AuthRoutes.routes.one_time_login, {});
+    }
+    
+    /**
+     * Execute the password reset process using a user's email address.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/authForgotPassword
+     * 
+     * @param email The email address
+     * 
+     * @returns promise
+     */
+    public static forgotPasswordWithEmail<T>(email: string) : AxiosPromise<Response<T>> {
+        return Requests.processRoute(AuthRoutes.routes.forgot_password, {email: email});
+    }
+
+    /**
+     * Resets the users password after the forgot password has been executed.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Authentication%20Route/authResetPassword
+     * 
+     * @param data The parameters required to reset the password.
+     * 
+     * @returns promise
+     */
+    public static resetPassword<T>(data : object) : AxiosPromise<Response<T>> {
+        return Requests.processRoute(AuthRoutes.routes.forgot_password, data);
+    }
+
 }
 
 export default Auth;

package/src/api/Waitlist.ts

@@ -1,9 +1,9 @@
-import WaitlistRoutes from "../routes/TeamsRoute";
+import WaitlistRoutes from "../routes/WaitlistRoutes";
 import Requests from "../util/Requests";
 import Response from "../util/Response";
 import { AxiosPromise } from "axios";
 
-class Teams {
+class Waitlists {
 
     /**
      * List all the waitlist sign-ups.
@@ -75,4 +75,4 @@ class Teams {
 
 }
 
-export default Teams;
+export default Waitlists;

package/src/api/index.ts

@@ -3,9 +3,12 @@ import Competitions from "./Competitions";
 import Users from "./Users";
 import Events from "./Events";
 import Teams from "./Teams";
+import Waitlists from "./Waitlist";
+
 
 export {Auth};
 export {Competitions};
 export {Users};
 export {Events};
-export {Teams};
+export {Teams};
+export {Waitlists}

package/src/config/Config.ts

@@ -7,31 +7,71 @@ import Requests from "../util/Requests";
  * 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;
+  private static _baseUrl: string;
+  private static _authToken: string;
 
-      Requests.setConfig(this);
-    }
+  private static _baseUrlLocked: boolean = false;
+
+  /**
+   * Set the configuration
+   * 
+   * @param baseUrl The url base endpoint of the api
+   * @param authToken The JSON Web Token
+   */
+  static setConfig(baseUrl: string, authToken: string, lock? : boolean) {
+
+    this.setBaseUrl(baseUrl, lock);
+
+    this.setAuthToken(authToken);
+
+    Requests.setBaseUrl(baseUrl);
+    Requests.setAuthToken(authToken);
+  }
+
+  /**
+   * Sets the endpoint for the API
+   * 
+   * @param baseUrl The url that connects to the APIs base
+   * @param lock If set to true, will lock the baseUrl so it cannot be changed
+   */
+  static setBaseUrl(baseUrl: string, lock? : boolean) {
 
-    setBaseUrl(baseUrl: string) {
-      this.baseUrl = baseUrl;
+    if(!this._baseUrlLocked) {
+      Config._baseUrl = baseUrl;
 
       Requests.setBaseUrl(baseUrl);
     }
 
-    setAuthToken(authToken: string) {
-      this.authToken = authToken;
-
-      Requests.setAuthToken(authToken);
+    if(lock) {
+      this._baseUrlLocked = true;
     }
+  }
+
+  /**
+   * Set the JSON Web Token (JWT) that will be passed to the API
+   * 
+   * @param authToken The JWT
+   */
+  static setAuthToken(authToken: string) {
+    Config._authToken = authToken;
+
+    Requests.setAuthToken(authToken);
+  }
+
+  /**
+   * Gets base url
+   */
+  static get baseUrl(): string {
+    return Config._baseUrl;
+  }
 
+  /**
+   * Gets auth token
+   */
+  static get authToken(): string {
+    return Config._authToken;
   }
+}
 
-  export default Config;
+export default Config;

package/src/index.ts

@@ -6,22 +6,26 @@ import Config from "./config/Config";
 import { Auth } from "./api";
 import { Competitions } from "./api";
 import { Users } from "./api";
-import {Events} from "./api";
-import {Teams} from "./api";
+import { Events } from "./api";
+import { Teams } from "./api";
+import { Waitlists } from "./api";
 
 class Glitch {
 
-    public static config: Config;
+    public static config: {
+        Config: Config
+    };
 
-    public static api : {
-        Auth : Auth,
+    public static api: {
+        Auth: Auth,
         Competitions: Competitions,
-        Users:  Users,
-        Events :  Events,
-        Teams :  Teams
+        Users: Users,
+        Events: Events,
+        Teams: Teams,
+        Waitlists: Waitlists
     }
 
 
-  }
+}
 
-  export {Glitch};
+export { Glitch };

package/src/util/Requests.ts

@@ -19,18 +19,6 @@ class Requests {
     this.config = config;
   }
 
-  /**
-   * Sets the configuration of the system.
-   * 
-   * @param config Config The config class.
-   */
-  public static setConfig(config: Config) {
-
-    this.baseUrl = config.baseUrl;
-
-    this.authToken = config.authToken;
-  }
-
   /**
    * Sets the base url of the API.
    *