glitch-javascript-sdk 0.2.6 → 0.2.8

package/dist/index.d.ts

@@ -1,87 +1,5 @@
 import { AxiosPromise } from 'axios';
 
-interface Template {
-    id?: string;
-    name?: string;
-    description?: string;
-    version?: string;
-    directory?: string;
-    entry_point_file?: string;
-    author_name?: string;
-    author_website?: string;
-    author_email?: string;
-    main_image?: string;
-    logo?: string;
-    is_private?: boolean;
-}
-
-interface User {
-    id?: string;
-    first_name?: string;
-    last_name?: string;
-    username?: string;
-    display_name?: string;
-    bio?: string;
-    avatar?: string;
-    banner_image?: string;
-    twitter_page?: string;
-    facebook_page?: string;
-    instagram_page?: string;
-    snapchat_page?: string;
-    tiktok_page?: string;
-    twitch_page?: string;
-    youtube_page?: string;
-    paetron_page?: string;
-    twitter_handle?: string;
-    facebook_handle?: string;
-    instagram_handle?: string;
-    snapchat_handle?: string;
-    tiktok_handle?: string;
-    twitch_handle?: string;
-    youtube_handle?: string;
-    paetron_handle?: string;
-    created_at?: string;
-    updated_at?: string;
-}
-
-interface Community {
-    id?: string;
-    name?: string;
-    description?: string;
-    logo?: string;
-    banner_image?: string;
-    video_logo?: string;
-    subdomain?: string;
-    cname?: string;
-    bannner_image?: string;
-    cname_enabled?: boolean;
-    require_attendee_rsvp?: boolean;
-    is_private?: boolean;
-    disable_streams?: boolean;
-    disable_competitions?: boolean;
-    disable_forums?: boolean;
-    disable_teams?: boolean;
-    custom_css?: boolean;
-    twitter_page?: string;
-    facebook_page?: string;
-    instagram_page?: string;
-    snapchat_page?: string;
-    tiktok_page?: string;
-    twitch_page?: string;
-    youtube_page?: string;
-    paetron_page?: string;
-    twitter_handle?: string;
-    facebook_handle?: string;
-    instagram_handle?: string;
-    snapchat_handle?: string;
-    tiktok_handle?: string;
-    twitch_handle?: string;
-    youtube_handle?: string;
-    paetron_handle?: string;
-    template?: Template;
-    admins?: User[];
-}
-
 /**
  * Config
  *
@@ -116,9 +34,9 @@ declare class Config {
     /**
      * Set the community to be associated with this config through
      *
-     * @param authToken The JWT
+     * @param community The object of the community
      */
-    static setCommunity(community: Community): void;
+    static setCommunity(community: Record<string, any>): void;
     /**
      * Gets base url
      */
@@ -130,7 +48,7 @@ declare class Config {
     /**
      * Gets the community currently associated
      */
-    static get getCommunity(): Community;
+    static get getCommunity(): object;
 }
 
 interface Response<T> {
@@ -1074,7 +992,7 @@ declare class Events {
      *
      * @returns promise
      */
-    static removeRTMPSource<T>(event_id: string, stream_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static removeRTMPSource<T>(event_id: string, stream_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
     /**
      * A function that should be run on an interval to set the event as live when the live stream is active.
      *
@@ -1084,7 +1002,7 @@ declare class Events {
      *
      * @returns promise
      */
-    static syncAsLive<T>(event_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static syncAsLive<T>(event_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
     /**
          * Updates the main image for the event using a File object.
          *
@@ -1139,7 +1057,7 @@ declare class Events {
      *
      * @returns promise
      */
-    static enableBroadcastMode<T>(event_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static enableBroadcastMode<T>(event_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
     /**
      * Enable livestream mode, in which the stream will be delivered to the invirtu RTMP endpoint for
      * streaming.
@@ -1148,7 +1066,7 @@ declare class Events {
      *
      * @returns promise
      */
-    static enableLivestreamMode<T>(event_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static enableLivestreamMode<T>(event_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
     /**
      * Sends content that will appear on-screen to the user.
      *
@@ -1183,7 +1101,7 @@ declare class Events {
      *
      * @returns promise
      */
-    static addOverlayAsBlob<T>(event_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>>;
+    static addOverlayAsBlob<T>(event_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
     /**
      * Deletes an overlay image.
      *
@@ -1194,7 +1112,7 @@ declare class Events {
      *
      * @returns promise
      */
-    static removeOverlay<T>(event_id: string, overlay_id: string): AxiosPromise<Response<T>>;
+    static removeOverlay<T>(event_id: string, overlay_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
     /**
      * Enables an overlay so that it will appear on screen.
      *
@@ -1205,7 +1123,7 @@ declare class Events {
      *
      * @returns promise
      */
-    static enableOverlay<T>(event_id: string, overlay_id: string): AxiosPromise<Response<T>>;
+    static enableOverlay<T>(event_id: string, overlay_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
     /**
      * Disables the overlay so it no longer appears on-screen.
      *
@@ -1215,7 +1133,7 @@ declare class Events {
      *
      * @returns promise
      */
-    static disableOverlay<T>(event_id: string): AxiosPromise<Response<T>>;
+    static disableOverlay<T>(event_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
     /**
      * Enable the donations to appear on-screen
      *
@@ -1225,16 +1143,16 @@ declare class Events {
      *
      * @returns promise
      */
-    static enableDonations<T>(event_id: string): AxiosPromise<Response<T>>;
+    static enableDonations<T>(event_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
     /**
      * Disable the donations and remove from the screen.
      *
      * @param event_id
      * @returns
      */
-    static disableDonations<T>(event_id: string): AxiosPromise<Response<T>>;
-    static sendInvite<T>(event_id: string, data: object): AxiosPromise<Response<T>>;
-    static acceptInvite<T>(event_id: string, token: string): AxiosPromise<Response<T>>;
+    static disableDonations<T>(event_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static sendInvite<T>(event_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static acceptInvite<T>(event_id: string, token: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
 declare class Teams {

package/package.json

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

package/src/api/Events.ts

@@ -69,7 +69,7 @@ class Events {
      */
     public static delete<T>(event_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(EventsRoutes.routes.delete, {}, { event_id: event_id });
+        return Requests.processRoute(EventsRoutes.routes.delete, {}, { event_id: event_id }, params);
     }
 
     /**
@@ -85,7 +85,7 @@ class Events {
      */
     public static updateInvirtuEvent<T>(event_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(EventsRoutes.routes.updateInvirtu, data, { event_id: event_id });
+        return Requests.processRoute(EventsRoutes.routes.updateInvirtu, data, { event_id: event_id }, params);
     }
 
     /**
@@ -100,7 +100,7 @@ class Events {
      */
     public static addRTMPSource<T>(event_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(EventsRoutes.routes.addRTMPSource, data, { event_id: event_id });
+        return Requests.processRoute(EventsRoutes.routes.addRTMPSource, data, { event_id: event_id }, params);
     }
 
     /**
@@ -115,7 +115,7 @@ class Events {
      */
     public static updateRTMPSource<T>(event_id: string, stream_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(EventsRoutes.routes.updateRTMPSource, data, { event_id: event_id, subid: stream_id });
+        return Requests.processRoute(EventsRoutes.routes.updateRTMPSource, data, { event_id: event_id, subid: stream_id }, params);
     }
 
     /**
@@ -128,9 +128,9 @@ class Events {
      *  
      * @returns promise
      */
-    public static removeRTMPSource<T>(event_id: string, stream_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    public static removeRTMPSource<T>(event_id: string, stream_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(EventsRoutes.routes.removeRTMPSource, {}, { event_id: event_id, subid: stream_id });
+        return Requests.processRoute(EventsRoutes.routes.removeRTMPSource, data, { event_id: event_id, subid: stream_id }, params);
     }
 
     /**
@@ -142,9 +142,9 @@ class Events {
      *  
      * @returns promise
      */
-    public static syncAsLive<T>(event_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    public static syncAsLive<T>(event_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(EventsRoutes.routes.syncAsLive, {}, { event_id: event_id });
+        return Requests.processRoute(EventsRoutes.routes.syncAsLive, data, { event_id: event_id }, params);
     }
 
     /**
@@ -225,9 +225,9 @@ class Events {
      * 
      * @returns promise
      */
-    public static enableBroadcastMode<T>(event_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    public static enableBroadcastMode<T>(event_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(EventsRoutes.routes.enableBroadcastMode, {}, { event_id: event_id });
+        return Requests.processRoute(EventsRoutes.routes.enableBroadcastMode, data, { event_id: event_id }, params);
     }
 
     /**
@@ -238,9 +238,9 @@ class Events {
      *  
      * @returns promise
      */
-    public static enableLivestreamMode<T>(event_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    public static enableLivestreamMode<T>(event_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(EventsRoutes.routes.enableLivestreamMode, {}, { event_id: event_id });
+        return Requests.processRoute(EventsRoutes.routes.enableLivestreamMode, data, { event_id: event_id }, params);
     }
 
     /**
@@ -255,7 +255,7 @@ class Events {
      */
     public static sendOnScreenContent<T>(event_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(EventsRoutes.routes.enableLivestreamMode, data, { event_id: event_id });
+        return Requests.processRoute(EventsRoutes.routes.enableLivestreamMode, data, { event_id: event_id }, params);
     }
 
     /**
@@ -287,7 +287,7 @@ class Events {
      * 
      * @returns promise
      */
-    public static addOverlayAsBlob<T>(event_id: string, blob: Blob, data?: object): AxiosPromise<Response<T>> {
+    public static addOverlayAsBlob<T>(event_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
         let url = EventsRoutes.routes.addOverlay.url.replace('{event_id}', event_id);
 
@@ -304,9 +304,9 @@ class Events {
      * 
      * @returns promise
      */
-    public static removeOverlay<T>(event_id: string, overlay_id: string): AxiosPromise<Response<T>> {
+    public static removeOverlay<T>(event_id: string, overlay_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(EventsRoutes.routes.removeOverlay, {}, { event_id: event_id, subid: overlay_id });
+        return Requests.processRoute(EventsRoutes.routes.removeOverlay, {}, { event_id: event_id, subid: overlay_id }, params);
     }
 
     /**
@@ -319,9 +319,9 @@ class Events {
      * 
      * @returns promise
      */
-    public static enableOverlay<T>(event_id: string, overlay_id: string): AxiosPromise<Response<T>> {
+    public static enableOverlay<T>(event_id: string, overlay_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(EventsRoutes.routes.enableOverlay, {}, { event_id: event_id, subid: overlay_id });
+        return Requests.processRoute(EventsRoutes.routes.enableOverlay, data, { event_id: event_id, subid: overlay_id }, params);
     }
 
     /**
@@ -333,9 +333,9 @@ class Events {
      * 
      * @returns promise
      */
-    public static disableOverlay<T>(event_id: string): AxiosPromise<Response<T>> {
+    public static disableOverlay<T>(event_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(EventsRoutes.routes.disableOverlay, {}, { event_id: event_id });
+        return Requests.processRoute(EventsRoutes.routes.disableOverlay, data, { event_id: event_id }, params);
     }
 
     /**
@@ -347,30 +347,30 @@ class Events {
      * 
      * @returns promise
      */
-    public static enableDonations<T>(event_id: string): AxiosPromise<Response<T>> {
+    public static enableDonations<T>(event_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(EventsRoutes.routes.enableDonations, {}, { event_id: event_id });
+        return Requests.processRoute(EventsRoutes.routes.enableDonations, data, { event_id: event_id }, params);
     }
 
     /**
      * Disable the donations and remove from the screen.
      * 
      * @param event_id 
-     * @returns 
+     * @returns
      */
-    public static disableDonations<T>(event_id: string): AxiosPromise<Response<T>> {
+    public static disableDonations<T>(event_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(EventsRoutes.routes.disableDonations, {}, { event_id: event_id });
+        return Requests.processRoute(EventsRoutes.routes.disableDonations, data, { event_id: event_id }, params);
     }
 
-    public static sendInvite<T>(event_id: string, data: object): AxiosPromise<Response<T>> {
+    public static sendInvite<T>(event_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(EventsRoutes.routes.sendInvite, data, { event_id: event_id });
+        return Requests.processRoute(EventsRoutes.routes.sendInvite, data, { event_id: event_id }, params);
     }
 
-    public static acceptInvite<T>(event_id: string, token: string): AxiosPromise<Response<T>> {
+    public static acceptInvite<T>(event_id: string, token: string , params?: Record<string, any>): AxiosPromise<Response<T>> {
 
-        return Requests.processRoute(EventsRoutes.routes.acceptInvite, { token: token }, { event_id: event_id });
+        return Requests.processRoute(EventsRoutes.routes.acceptInvite, { token: token }, { event_id: event_id }, params);
     }
 
 

package/src/config/Config.ts

@@ -64,9 +64,9 @@ class Config {
   /**
    * Set the community to be associated with this config through
    * 
-   * @param authToken The JWT
+   * @param community The object of the community
    */
-  public static setCommunity(community: Community) {
+  public static setCommunity(community: Record<string, any>) {
     Config._community = community;
 
     Requests.setCommunityID(community.id);
@@ -89,7 +89,7 @@ class Config {
   /**
    * Gets the community currently associated
    */
-  public static get getCommunity(): Community {
+  public static get getCommunity(): object {
     return Config._community;
   }
 }

package/src/util/Requests.ts

@@ -102,7 +102,7 @@ class Requests {
         .join('&');
       url = `${url}?${queryString}`;
     }
-
+    
     if (this.community_id) {
       // Check if the URL already contains query parameters
       const separator = url.includes('?') ? '&' : '?';