glitch-javascript-sdk 0.3.2 → 0.3.4

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

@@ -0,0 +1,13 @@
+interface CommunityLabels {
+    [key: string]: string;
+}
+declare class LabelManager {
+    private static community;
+    static initialize(community: CommunityLabels): void;
+    private static getLabel;
+    static getUserLabel(plural: boolean, capitalize: boolean): string;
+    static getCompetitionLabel(plural: boolean, capitalize: boolean): string;
+    static getStreamLabel(plural: boolean, capitalize: boolean): string;
+    static getPostLabel(plural: boolean, capitalize: boolean): string;
+}
+export default LabelManager;

package/dist/index.d.ts

@@ -1412,6 +1412,28 @@ declare class Posts {
      * @returns Promise
      */
     static create<T>(data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+    * Create a new post with a file. The file should either be an image or video.
+    *
+    * @see https://api.glitch.fun/api/documentation#/Post%20Route/newPostResourceStorage
+    *
+    * @param file The file object to upload.
+    * @param data Any additional data to pass along to the upload.
+    *
+    * @returns promise
+    */
+    static createWithFile<T>(file: File, data?: object): AxiosPromise<Response<T>>;
+    /**
+     * Create a new post with a blob. The blob should either be an image or video.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Post%20Route/newPostResourceStorage
+     *
+     * @param file The blob to upload.
+     * @param data Any additional data to pass along to the upload.
+     *
+     * @returns promise
+     */
+    static createWithBlob<T>(blob: Blob, data?: object): AxiosPromise<Response<T>>;
     /**
      * Update a post.
      *
@@ -1645,6 +1667,19 @@ declare class Data {
     static convertToHHMMSS(time: string | undefined): string | undefined;
 }
 
+interface CommunityLabels {
+    [key: string]: string;
+}
+declare class LabelManager {
+    private static community;
+    static initialize(community: CommunityLabels): void;
+    private static getLabel;
+    static getUserLabel(plural: boolean, capitalize: boolean): string;
+    static getCompetitionLabel(plural: boolean, capitalize: boolean): string;
+    static getStreamLabel(plural: boolean, capitalize: boolean): string;
+    static getPostLabel(plural: boolean, capitalize: boolean): string;
+}
+
 declare enum Modes {
     BROADCAST = 0,
     OBS = 1,
@@ -1727,6 +1762,7 @@ declare class Glitch {
         Session: typeof Session;
         Storage: typeof Storage;
         Data: typeof Data;
+        LabelManager: typeof LabelManager;
     };
     static constants: {
         AcceptanceStatus: Readonly<{
@@ -1755,7 +1791,23 @@ declare class Glitch {
             SEMI_ROUND_ROBINS: 8;
             EXTENDED: 9;
         }>;
+        ContentStatus: Readonly<{
+            UNAPPROVED: 0;
+            APPROVED: 1;
+            IN_REVIEW: 2;
+            PENDING: 3;
+            FLAGGED: 4;
+            REMOVED: 5;
+            DELETED: 6;
+        }>;
         Modes: typeof Modes;
+        PostTypes: Readonly<{
+            TEXT: "text";
+            LINK: "link";
+            POLL: "poll";
+            IMAGE: "image";
+            VIDEO: "video";
+        }>;
         Roles: typeof Roles;
         TeamJoinProcess: typeof TeamJoinProcess;
         TicketTypes: typeof TicketTypes;

package/package.json

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

package/src/api/Posts.ts

@@ -30,6 +30,37 @@ class Posts {
         return Requests.processRoute(PostsRoute.routes.create, data, undefined, params);
     }
 
+     /**
+     * Create a new post with a file. The file should either be an image or video.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Post%20Route/newPostResourceStorage
+     * 
+     * @param file The file object to upload.
+     * @param data Any additional data to pass along to the upload.
+     * 
+     * @returns promise
+     */
+     public static createWithFile<T>(file : File, data? : object): AxiosPromise<Response<T>> {
+
+        return Requests.uploadFile(PostsRoute.routes.create.url, 'file', file, data);
+    }
+
+    /**
+     * Create a new post with a blob. The blob should either be an image or video.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Post%20Route/newPostResourceStorage
+     * 
+     * @param file The blob to upload.
+     * @param data Any additional data to pass along to the upload.
+     * 
+     * @returns promise
+     */
+    public static createWithBlob<T>(blob : Blob, data? : object): AxiosPromise<Response<T>> {
+
+        return Requests.uploadBlob(PostsRoute.routes.create.url, 'file', blob, data);
+    }
+
+
     /**
      * Update a post.
      * 

package/src/config/Config.ts

@@ -1,4 +1,5 @@
 import Community from "../models/community";
+import LabelManager from "../util/LabelManager";
 import Requests from "../util/Requests";
 
 /**
@@ -70,6 +71,8 @@ class Config {
     Config._community = community;
 
     Requests.setCommunityID(community.id);
+    
+    LabelManager.initialize(community);
   }
 
   /**

package/src/constants/ContentStatus.ts

@@ -0,0 +1,9 @@
+export const ContentStatus = Object.freeze({
+    UNAPPROVED : 0,
+    APPROVED : 1,
+    IN_REVIEW : 2,
+    PENDING : 3,
+    FLAGGED : 4,
+    REMOVED : 5,
+    DELETED : 6,
+  });

package/src/constants/PostTypes.ts

@@ -0,0 +1,7 @@
+export const PostTypes = Object.freeze({
+    TEXT: 'text',
+    LINK : 'link',
+    POLL: 'poll',
+    IMAGE: 'image',
+    VIDEO: 'video',
+  });

package/src/index.ts

@@ -18,11 +18,14 @@ import Parser from "./util/Parser";
 import Session from "./util/Session";
 import Storage from "./util/Storage";
 import Data from './util/Data';
+import LabelManager from "./util/LabelManager";
 
 import { AcceptanceStatus } from "./constants/AcceptanceStatus";
 import AddressLocationType  from "./constants/AddressLocationType";
+import { ContentStatus } from "./constants/ContentStatus";
 import { CompetitionTypes } from "./constants/CompetitionTypes";
 import { Modes } from "./constants/Modes";
+import { PostTypes } from "./constants/PostTypes";
 import { Roles } from "./constants/Roles";
 import { TeamJoinProcess } from "./constants/TeamJoinProcess";
 import TicketTypes from "./constants/TicketTypes";
@@ -54,13 +57,16 @@ class Glitch {
         Session: Session,
         Storage : Storage,
         Data : Data,
+        LabelManager : LabelManager,
     }
 
     public static constants = {
        AcceptanceStatus : AcceptanceStatus,
        AddressLocationType : AddressLocationType,
        CompetitionTypes : CompetitionTypes,
+       ContentStatus : ContentStatus,
        Modes : Modes,
+       PostTypes : PostTypes,
        Roles: Roles,
        TeamJoinProcess : TeamJoinProcess,
        TicketTypes : TicketTypes,

package/src/util/LabelManager.ts

@@ -0,0 +1,39 @@
+interface CommunityLabels {
+    [key: string]: string;
+}
+  
+  class LabelManager {
+    private static community: CommunityLabels;
+  
+    static initialize(community: CommunityLabels) {
+      LabelManager.community = community;
+    }
+  
+    private static getLabel(labelName: string, plural: boolean, capitalize: boolean): string {
+      let label = LabelManager.community[labelName + (plural ? "_plural" : "_singular")];
+  
+      if (capitalize) {
+        label = label.charAt(0).toUpperCase() + label.slice(1);
+      }
+  
+      return label;
+    }
+  
+    static getUserLabel(plural: boolean, capitalize: boolean): string {
+      return LabelManager.getLabel("label_users", plural, capitalize);
+    }
+  
+    static getCompetitionLabel(plural: boolean, capitalize: boolean): string {
+      return LabelManager.getLabel("label_competitions", plural, capitalize);
+    }
+  
+    static getStreamLabel(plural: boolean, capitalize: boolean): string {
+      return LabelManager.getLabel("label_streams", plural, capitalize);
+    }
+
+    static getPostLabel(plural: boolean, capitalize: boolean): string {
+        return LabelManager.getLabel("label_posts", plural, capitalize);
+      }
+  }
+  
+  export default LabelManager;

package/src/constants/api_routes.js

@@ -1,397 +0,0 @@
-
-/**
- * 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;