glitch-javascript-sdk 0.3.1 → 0.3.3

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

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

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

@@ -1393,6 +1393,57 @@ declare class Waitlists {
     static delete<T>(waitlist_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
+declare class Posts {
+    /**
+     * List all the Posts.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Post%20Route/resourcePostList
+     *
+     * @returns promise
+     */
+    static list<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Create a new post.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Post%20Route/newPostResourceStorage
+     *
+     * @param data The data to be passed when creating a post.
+     *
+     * @returns Promise
+     */
+    static create<T>(data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Update a post.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Post%20Route/updatePostStorage
+     *
+     * @param post_id The id of the post to update.
+     * @param data The data to update.
+     *
+     * @returns promise
+     */
+    static update<T>(post_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve the information for a single post.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Post%20Route/showPostStorage
+     *
+     * @param post_id The id fo the post to retrieve.
+     *
+     * @returns promise
+     */
+    static view<T>(post_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Deletes a post.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Post%20Route/destoryPostStorage
+     *
+     * @param post_id The id of the post to delete.
+     * @returns promise
+     */
+    static delete<T>(post_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+}
+
 declare class Templates {
     /**
      * List all the templates.
@@ -1594,6 +1645,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,
@@ -1666,6 +1730,7 @@ declare class Glitch {
         Users: typeof Users;
         Events: typeof Events;
         Teams: typeof Teams;
+        Posts: typeof Posts;
         Templates: typeof Templates;
         Waitlists: typeof Waitlists;
     };
@@ -1675,6 +1740,7 @@ declare class Glitch {
         Session: typeof Session;
         Storage: typeof Storage;
         Data: typeof Data;
+        LabelManager: typeof LabelManager;
     };
     static constants: {
         AcceptanceStatus: Readonly<{
@@ -1703,7 +1769,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.1",
+  "version": "0.3.3",
   "description": "Javascript SDK for Glitch",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/api/Posts.ts

@@ -0,0 +1,77 @@
+import PostsRoute from "../routes/PostsRoute";
+import Requests from "../util/Requests";
+import Response from "../util/Response";
+import { AxiosPromise } from "axios";
+
+class Posts {
+
+    /**
+     * List all the Posts.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Post%20Route/resourcePostList
+     * 
+     * @returns promise
+     */
+    public static list<T>(params?: Record<string, any>) :  AxiosPromise<Response<T>> {
+        return Requests.processRoute(PostsRoute.routes.list, undefined, undefined, params);
+    }
+
+    /**
+     * Create a new post.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Post%20Route/newPostResourceStorage
+     * 
+     * @param data The data to be passed when creating a post.
+     * 
+     * @returns Promise
+     */
+    public static create<T>(data : object, params?: Record<string, any>) :  AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(PostsRoute.routes.create, data, undefined, params);
+    }
+
+    /**
+     * Update a post.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Post%20Route/updatePostStorage
+     * 
+     * @param post_id The id of the post to update.
+     * @param data The data to update.
+     * 
+     * @returns promise
+     */
+    public static update<T>(post_id : string, data : object, params?: Record<string, any>)  :  AxiosPromise<Response<T>>{
+
+        return Requests.processRoute(PostsRoute.routes.update, data, {post_id : post_id}, params);
+    }
+
+    /**
+     * Retrieve the information for a single post.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Post%20Route/showPostStorage
+     * 
+     * @param post_id The id fo the post to retrieve.
+     * 
+     * @returns promise
+     */
+    public static view<T>(post_id : string, params?: Record<string, any>) :  AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(PostsRoute.routes.view, {}, {post_id : post_id}, params);
+    }
+
+    /**
+     * Deletes a post.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Post%20Route/destoryPostStorage
+     * 
+     * @param post_id The id of the post to delete.
+     * @returns promise
+     */
+    public static delete<T>(post_id : string, params?: Record<string, any>) :  AxiosPromise<Response<T>> {
+
+        return Requests.processRoute(PostsRoute.routes.delete, {}, {post_id : post_id}, params);
+    }
+
+}
+
+export default Posts;

package/src/api/index.ts

@@ -5,6 +5,7 @@ import Users from "./Users";
 import Events from "./Events";
 import Teams from "./Teams";
 import Waitlists from "./Waitlist";
+import Posts from "./Posts";
 import Templates from "./Templates";
 
 
@@ -15,4 +16,5 @@ export {Users};
 export {Events};
 export {Teams};
 export {Waitlists};
+export {Posts};
 export {Templates};

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

@@ -9,6 +9,7 @@ import {Communities} from "./api";
 import { Users } from "./api";
 import { Events } from "./api";
 import { Teams } from "./api";
+import { Posts } from "./api";
 import {Templates} from "./api";
 import { Waitlists } from "./api";
 
@@ -17,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";
@@ -42,6 +46,7 @@ class Glitch {
         Users: Users,
         Events: Events,
         Teams: Teams,
+        Posts: Posts,
         Templates : Templates,
         Waitlists: Waitlists
     }
@@ -52,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/routes/PostsRoute.ts

@@ -0,0 +1,16 @@
+import Route from "./interface";
+import HTTP_METHODS from "../constants/HttpMethods";
+
+class PostsRoute {
+    
+    public static routes: { [key: string]: Route } = {
+      list: { url: '/posts', method: HTTP_METHODS.GET },
+      create: { url: '/posts', method: HTTP_METHODS.POST  },
+      view : { url: '/posts/{post_id}', method: HTTP_METHODS.GET  },
+      update  :{ url: '/posts/{post_id}', method: HTTP_METHODS.PUT  },
+      delete : { url: '/posts/{post_id}', method: HTTP_METHODS.DELETE },
+    };
+
+  }
+
+  export default PostsRoute;

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;