glitch-javascript-sdk 0.3.8 → 0.4.0

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

@@ -1,11 +1,20 @@
 declare class Storage {
+    private static rootDomain;
     private static data;
+    /**
+     * Sets a root level domain so the data can persist across
+     * subdomains
+     *
+     * @param rootDomain
+     */
+    static setRootDomain(rootDomain: string): void;
+    private static getStorageKey;
     static set(key: string, value: any): void;
     static get(key: string): any;
     static setAuthToken(token: string | null): void;
     static getAuthToken(): string | null;
+    static eraseCookie(name: string): void;
     private static setCookie;
     private static getCookie;
-    static eraseCookie(name: string): void;
 }
 export default Storage;

package/dist/index.d.ts

@@ -10,6 +10,7 @@ declare class Config {
     private static _baseUrl;
     private static _authToken;
     private static _community;
+    private static _rootDomain;
     private static _baseUrlLocked;
     /**
      * Set the configuration
@@ -37,6 +38,14 @@ declare class Config {
      * @param community The object of the community
      */
     static setCommunity(community: Record<string, any>): void;
+    /**
+     * Sets the root level domain so data can accessed across
+     * multiple subdomains
+     *
+     * @param domain The domain ie: example.com
+     */
+    static setRootDomain(domain: string): void;
+    static getRootDomain(): string;
     /**
      * Gets base url
      */
@@ -577,6 +586,51 @@ declare class Competitions {
      * @returns promise
      */
     static uploadVenueMainImageBlob<T>(competition_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get a leaderboard by a users points.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static userPointsLeaderboard<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get a leaderboard by a users wins.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static userWinsLeaderboard<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get a leaderboard by a teams points.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static teamPointsLeaderboard<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get a leaderboard by a teams wins.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static teamWinsLeaderboard<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get all leaderboards.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     *
+     * @param competition_id
+     * @returns promise
+     */
+    static allLeaderboards<T>(competition_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
 declare class Communities {
@@ -1697,14 +1751,23 @@ declare class Session {
 }
 
 declare class Storage {
+    private static rootDomain;
     private static data;
+    /**
+     * Sets a root level domain so the data can persist across
+     * subdomains
+     *
+     * @param rootDomain
+     */
+    static setRootDomain(rootDomain: string): void;
+    private static getStorageKey;
     static set(key: string, value: any): void;
     static get(key: string): any;
     static setAuthToken(token: string | null): void;
     static getAuthToken(): string | null;
+    static eraseCookie(name: string): void;
     private static setCookie;
     private static getCookie;
-    static eraseCookie(name: string): void;
 }
 
 declare class Data {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glitch-javascript-sdk",
-  "version": "0.3.8",
+  "version": "0.4.0",
   "description": "Javascript SDK for Glitch",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/api/Competitions.ts

@@ -620,6 +620,66 @@ class Competitions {
 
         return Requests.uploadBlob(url, 'image', blob, data);
     }
+
+    /**
+     * Get a leaderboard by a users points.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     * 
+     * @param competition_id 
+     * @returns promise
+     */
+    public static userPointsLeaderboard<T>(competition_id : string, params?: Record<string, any>): AxiosPromise<Response<T>>{
+        return Requests.processRoute(CompetitionRoutes.routes.userPointsLeaderboard, {}, {competition_id : competition_id}, params);
+    }
+
+    /**
+     * Get a leaderboard by a users wins.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     * 
+     * @param competition_id 
+     * @returns promise
+     */
+    public static userWinsLeaderboard<T>(competition_id : string, params?: Record<string, any>): AxiosPromise<Response<T>>{
+        return Requests.processRoute(CompetitionRoutes.routes.userWinsLeaderboard, {}, {competition_id : competition_id}, params);
+    }
+
+    /**
+     * Get a leaderboard by a teams points.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     * 
+     * @param competition_id 
+     * @returns promise
+     */
+    public static teamPointsLeaderboard<T>(competition_id : string, params?: Record<string, any>): AxiosPromise<Response<T>>{
+        return Requests.processRoute(CompetitionRoutes.routes.teamPointsLeaderboard, {}, {competition_id : competition_id}, params);
+    }
+
+    /**
+     * Get a leaderboard by a teams wins.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     * 
+     * @param competition_id 
+     * @returns promise
+     */
+    public static teamWinsLeaderboard<T>(competition_id : string, params?: Record<string, any>): AxiosPromise<Response<T>>{
+        return Requests.processRoute(CompetitionRoutes.routes.teamWinsLeaderboard, {}, {competition_id : competition_id}, params);
+    }
+
+    /**
+     * Get all leaderboards.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Competitions%20Route/competitionUserList
+     * 
+     * @param competition_id 
+     * @returns promise
+     */
+    public static allLeaderboards<T>(competition_id : string, params?: Record<string, any>): AxiosPromise<Response<T>>{
+        return Requests.processRoute(CompetitionRoutes.routes.allLeaderboards, {}, {competition_id : competition_id}, params);
+    }
 }
 
 export default Competitions;

package/src/config/Config.ts

@@ -1,6 +1,7 @@
 import Community from "../models/community";
 import LabelManager from "../util/LabelManager";
 import Requests from "../util/Requests";
+import Storage from "../util/Storage";
 
 /**
  * Config
@@ -13,6 +14,7 @@ class Config {
   private static _baseUrl: string;
   private static _authToken: string;
   private static _community: object;
+  private static _rootDomain: string;
 
   private static _baseUrlLocked: boolean = false;
 
@@ -22,7 +24,7 @@ class Config {
    * @param baseUrl The url base endpoint of the api
    * @param authToken The JSON Web Token
    */
-  public static setConfig(baseUrl: string, authToken: string, lock? : boolean) {
+  public static setConfig(baseUrl: string, authToken: string, lock?: boolean) {
 
     this.setBaseUrl(baseUrl, lock);
 
@@ -38,15 +40,15 @@ class Config {
    * @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
    */
-  public static setBaseUrl(baseUrl: string, lock? : boolean) {
+  public static setBaseUrl(baseUrl: string, lock?: boolean) {
 
-    if(!this._baseUrlLocked) {
+    if (!this._baseUrlLocked) {
       Config._baseUrl = baseUrl;
 
       Requests.setBaseUrl(baseUrl);
     }
 
-    if(lock) {
+    if (lock) {
       this._baseUrlLocked = true;
     }
   }
@@ -71,10 +73,37 @@ class Config {
     Config._community = community;
 
     Requests.setCommunityID(community.id);
-    
+
     LabelManager.initialize(community);
   }
 
+  /**
+   * Sets the root level domain so data can accessed across
+   * multiple subdomains
+   * 
+   * @param domain The domain ie: example.com
+   */
+  public static setRootDomain(domain: string) {
+
+    const parts = domain.split('.');
+
+    if (parts.length > 2) {
+      parts.shift();
+    }
+
+    let formattedDomain = parts.join('.');
+
+    formattedDomain = formattedDomain.replace(/^\./, '');
+
+    this._rootDomain = formattedDomain;
+
+    Storage.setRootDomain(formattedDomain);
+  }
+
+  public static getRootDomain() {
+    return this._rootDomain;
+  }
+
   /**
    * Gets base url
    */

package/src/routes/CompetitionRoute.ts

@@ -47,6 +47,11 @@ class CompetitionRoutes {
       updateVenue : { url: '/competitions/{competition_id}/venues/{venue_id}', method: HTTP_METHODS.PUT },
       destroyVenue : { url: '/competitions/{competition_id}/venues/{venue_id}', method: HTTP_METHODS.DELETE },
       uploadVenueMainImage : { url: '/competitions/{competition_id}/venues/{venue_id}/uploadMainImage', method: HTTP_METHODS.POST },
+      userPointsLeaderboard : { url: '/competitions/{competition_id}/userPointsLeaderboard', method: HTTP_METHODS.GET },
+      teamPointsLeaderboard : { url: '/competitions/{competition_id}/teamPointsLeaderboard', method: HTTP_METHODS.GET },
+      userWinsLeaderboard : { url: '/competitions/{competition_id}/userWinsLeaderboard', method: HTTP_METHODS.GET },
+      teamWinsLeaderboard : { url: '/competitions/{competition_id}/teamWinsLeaderboard', method: HTTP_METHODS.GET },
+      allLeaderboards : { url: '/competitions/{competition_id}/allLeaderboards', method: HTTP_METHODS.GET },
     };
 
 

package/src/util/Storage.ts

@@ -1,106 +1,100 @@
 class Storage {
+  private static rootDomain: string = '';
+  private static data: { [key: string]: any } = {};
 
-    //Back up data type if no storage is working.
-
-    private static data: { [key: string]: any } = {};
+  /**
+   * Sets a root level domain so the data can persist across
+   * subdomains
+   * 
+   * @param rootDomain
+   */
+  public static setRootDomain(rootDomain: string) {
+    Storage.rootDomain = rootDomain;
+  }
 
-  
-    public static set(key: string, value: any) {
+  private static getStorageKey(key: string): string {
+    return Storage.rootDomain ? `${Storage.rootDomain}:${key}` : key;
+  }
 
+  public static set(key: string, value: any) {
+    try {
+      const serializedValue = JSON.stringify(value);
+      window.localStorage.setItem(Storage.getStorageKey(key), serializedValue);
+    } catch (e) {
       try {
         const serializedValue = JSON.stringify(value);
-        window.localStorage.setItem(key, serializedValue);
+        window.sessionStorage.setItem(Storage.getStorageKey(key), serializedValue);
       } catch (e) {
-
-        try {
-
-          const serializedValue = JSON.stringify(value);
-          window.sessionStorage.setItem(key, serializedValue);
-
-        } catch (e) {
-          //fallback
-          this.setCookie(key, value, 31);
-          Storage.data[key] = value;
-        }
+        this.setCookie(key, value, 31);
+        Storage.data[key] = value;
       }
     }
-  
-    public static get(key: string): any {
-      try {
+  }
 
-        const serializedValue = window.localStorage.getItem(key);
-        
+  public static get(key: string): any {
+    try {
+      const serializedValue = window.localStorage.getItem(Storage.getStorageKey(key));
+      if (serializedValue !== null) {
+        return JSON.parse(serializedValue);
+      }
+    } catch (e) {
+      try {
+        const serializedValue = window.sessionStorage.getItem(Storage.getStorageKey(key));
         if (serializedValue !== null) {
           return JSON.parse(serializedValue);
         }
-
       } catch (e) {
+        let value = Storage.getCookie(key);
+        if (!value) {
+          value = Storage.data[key];
+        }
+        return value;
+      }
+    }
+  }
 
-        try {
+  public static setAuthToken(token: string | null) {
+    Storage.set('glitch_auth_token', token);
+  }
 
-          const serializedValue = window.sessionStorage.getItem(key);
-          
-          if (serializedValue !== null) {
-            return JSON.parse(serializedValue);
-          }
+  public static getAuthToken(): string | null {
+    return Storage.get('glitch_auth_token');
+  }
 
-        } catch (e) {
+  public static eraseCookie(name: string) {
+    document.cookie =
+      name +
+      '=; Secure; HttpOnly=false; SameSite=none; Path=/; Expires=Thu, 01 Jan 1970 00:00:01 GMT;';
+  }
 
-          let value = Storage.getCookie(key);
-  
-          if (!value) {
-            value = Storage.data[key];
-          }
-  
-          return value;
-        }
-      }
-    }
-  
-  
-    public static setAuthToken(token: string | null) {
-      Storage.set('glitch_auth_token', token);
+  private static setCookie(name: string, value: string, days: number) {
+    let expires = '';
+    if (days) {
+      const date = new Date();
+      date.setTime(date.getTime() + days * 24 * 60 * 60 * 1000);
+      expires = '; expires=' + date.toUTCString();
     }
-  
-    public static getAuthToken(): string | null {
-      return Storage.get('glitch_auth_token');
-    }
-  
-    private static setCookie(name: string, value: string, days: number) {
-      let expires = '';
-      if (days) {
-        const date = new Date();
-        date.setTime(date.getTime() + days * 24 * 60 * 60 * 1000);
-        expires = '; expires=' + date.toUTCString();
-      }
-  
-      //IFrames require HttpyOnly to be false, Chrome require SameSite to be none, and must be secure
-      document.cookie =
-        name +
-        '=' +
-        (value || '') +
-        expires +
-        '; path=/; HttpOnly=false; SameSite=none; Secure';
-    }
-  
-    private static getCookie(name: string): string | null {
-      const nameEQ = name + '=';
-      const ca = document.cookie.split(';');
-      for (let i = 0; i < ca.length; i++) {
-        let c = ca[i];
-        while (c.charAt(0) == ' ') c = c.substring(1, c.length);
-        if (c.indexOf(nameEQ) == 0)
-          return c.substring(nameEQ.length, c.length);
-      }
-      return null;
-    }
-  
-    public static eraseCookie(name: string) {
-      document.cookie =
-        name +
-        '=; Secure; HttpOnly=false; SameSite=none; Path=/; Expires=Thu, 01 Jan 1970 00:00:01 GMT;';
+
+    document.cookie =
+      name +
+      '=' +
+      (value || '') +
+      expires +
+      '; path=/; domain=' +
+      Storage.rootDomain +
+      '; HttpOnly=false; SameSite=none; Secure';
+  }
+
+  private static getCookie(name: string): string | null {
+    const nameEQ = name + '=';
+    const ca = document.cookie.split(';');
+    for (let i = 0; i < ca.length; i++) {
+      let c = ca[i];
+      while (c.charAt(0) == ' ') c = c.substring(1, c.length);
+      if (c.indexOf(nameEQ) == 0) return c.substring(nameEQ.length, c.length);
     }
+    return null;
   }
-  
-  export default Storage;
-  
+}
+
+export default Storage;