glitch-javascript-sdk 1.4.0 → 1.4.2

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

@@ -1,4 +1,4 @@
-import { AxiosPromise } from 'axios';
+import { AxiosPromise, AxiosProgressEvent } from 'axios';
 import Config from '../config/Config';
 import Route from '../routes/interface';
 import Response from './Response';
@@ -16,8 +16,8 @@ declare class Requests {
     static post<T>(url: string, data: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
     static put<T>(url: string, data: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
     static delete<T>(url: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
-    static uploadFile<T>(url: string, filename: string, file: File | Blob, data?: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
-    static uploadBlob<T>(url: string, filename: string, blob: Blob, data?: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static uploadFile<T>(url: string, filename: string, file: File | Blob, data?: any, params?: Record<string, any>, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void): AxiosPromise<Response<T>>;
+    static uploadBlob<T>(url: string, filename: string, blob: Blob, data?: any, params?: Record<string, any>, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void): AxiosPromise<Response<T>>;
     static uploadFileInChunks<T>(file: File, uploadUrl: string, onProgress?: (totalSize: number, amountUploaded: number) => void, data?: any, chunkSize?: number): Promise<void>;
     static processRoute<T>(route: Route, data?: object, routeReplace?: {
         [key: string]: any;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { AxiosPromise } from 'axios';
+import { AxiosPromise, AxiosProgressEvent } from 'axios';
 
 /**
  * Config
@@ -2792,6 +2792,14 @@ declare class Titles {
      * @returns promise
      */
     static uploadBannerImageBlob<T>(title_id: string, blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+    * Add media to a title.
+    */
+    static addMedia<T>(title_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Remove media from a title.
+     */
+    static removeMedia<T>(title_id: string, media_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
 declare class Campaigns {
@@ -3901,7 +3909,7 @@ declare class Media {
      *
      * @returns promise
      */
-    static uploadFile<T>(file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static uploadFile<T>(file: File, data?: object, params?: Record<string, any>, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void): AxiosPromise<Response<T>>;
     /**
      * Upload media content using a Blob.
      *
@@ -3912,7 +3920,7 @@ declare class Media {
      *
      * @returns promise
      */
-    static uploadBlob<T>(blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static uploadBlob<T>(blob: Blob, data?: object, params?: Record<string, any>, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void): AxiosPromise<Response<T>>;
     /**
      * Get media details.
      *
@@ -3975,6 +3983,17 @@ declare class Scheduler {
      * @returns promise
      */
     static deleteSchedule<T>(scheduler_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Test the tone of the scheduler.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Scheduler/updateTitlePromotionSchedule
+     *
+     * @param scheduler_id The ID of the promotion schedule.
+     * @param data The data to update.
+     *
+     * @returns promise
+     */
+    static testTone<T>(scheduler_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
     /**
      * Get social media posts related to a promotion schedule.
      *
@@ -4259,8 +4278,8 @@ declare class Requests {
     static post<T>(url: string, data: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
     static put<T>(url: string, data: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
     static delete<T>(url: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
-    static uploadFile<T>(url: string, filename: string, file: File | Blob, data?: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
-    static uploadBlob<T>(url: string, filename: string, blob: Blob, data?: any, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static uploadFile<T>(url: string, filename: string, file: File | Blob, data?: any, params?: Record<string, any>, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void): AxiosPromise<Response<T>>;
+    static uploadBlob<T>(url: string, filename: string, blob: Blob, data?: any, params?: Record<string, any>, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void): AxiosPromise<Response<T>>;
     static uploadFileInChunks<T>(file: File, uploadUrl: string, onProgress?: (totalSize: number, amountUploaded: number) => void, data?: any, chunkSize?: number): Promise<void>;
     static processRoute<T>(route: Route, data?: object, routeReplace?: {
         [key: string]: any;

package/package.json

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

package/src/api/Media.ts

@@ -1,7 +1,7 @@
 import MediaRoute from "../routes/MediaRoute";
 import Requests from "../util/Requests";
 import Response from "../util/Response";
-import { AxiosPromise } from "axios";
+import { AxiosProgressEvent, AxiosPromise } from "axios";
 
 class Media {
     /**
@@ -14,8 +14,8 @@ class Media {
      * 
      * @returns promise
      */
-    public static uploadFile<T>(file: File, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
-        return Requests.uploadFile(MediaRoute.routes.upload.url, 'media', file, data, params);
+    public static uploadFile<T>(file: File, data?: object, params?: Record<string, any>, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void): AxiosPromise<Response<T>> {
+        return Requests.uploadFile(MediaRoute.routes.upload.url, 'media', file, data, params, onUploadProgress);
     }
 
     /**
@@ -28,8 +28,8 @@ class Media {
      * 
      * @returns promise
      */
-    public static uploadBlob<T>(blob: Blob, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
-        return Requests.uploadBlob(MediaRoute.routes.upload.url, 'media', blob, data, params);
+    public static uploadBlob<T>(blob: Blob, data?: object, params?: Record<string, any>, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void): AxiosPromise<Response<T>> {
+        return Requests.uploadBlob(MediaRoute.routes.upload.url, 'media', blob, data, params, onUploadProgress);
     }
 
     /**

package/src/api/Scheduler.ts

@@ -68,6 +68,20 @@ class Scheduler {
         return Requests.processRoute(SchedulerRoute.routes.deleteSchedule, {}, { scheduler_id }, params);
     }
 
+    /**
+     * Test the tone of the scheduler.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Scheduler/updateTitlePromotionSchedule
+     * 
+     * @param scheduler_id The ID of the promotion schedule.
+     * @param data The data to update.
+     * 
+     * @returns promise
+     */
+    public static testTone<T>(scheduler_id: string, data: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(SchedulerRoute.routes.testTone, data, { scheduler_id }, params);
+    }
+
     /**
      * Get social media posts related to a promotion schedule.
      * 

package/src/api/Titles.ts

@@ -196,6 +196,20 @@ class Titles {
         return Requests.uploadBlob(url, 'image', blob, data);
     }
 
+     /**
+     * Add media to a title.
+     */
+     public static addMedia<T>(title_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TitlesRoute.routes.addMedia, data, { title_id: title_id }, params);
+    }
+
+    /**
+     * Remove media from a title.
+     */
+    public static removeMedia<T>(title_id: string, media_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(TitlesRoute.routes.removeMedia, {}, { title_id: title_id, media_id: media_id }, params);
+    }
+
 }
 
 export default Titles;

package/src/routes/SchedulerRoute.ts

@@ -18,6 +18,8 @@ class SchedulerRoute {
         updateUpdate: { url: '/schedulers/{scheduler_id}/updates/{update_id}', method: HTTP_METHODS.PUT },
         deleteUpdate: { url: '/schedulers/{scheduler_id}/updates/{update_id}', method: HTTP_METHODS.DELETE },
 
+        testTone: { url: '/schedulers/{scheduler_id}/tone', method: HTTP_METHODS.POST },
+
         // Clear OAuth Routes
         clearTwitterAuth: { url: '/schedulers/{scheduler_id}/clearTwitterAuth', method: HTTP_METHODS.DELETE },
         clearFacebookAuth: { url: '/schedulers/{scheduler_id}/clearFacebookAuth', method: HTTP_METHODS.DELETE },

package/src/routes/TitlesRoute.ts

@@ -15,6 +15,8 @@ class TitlesRoute {
       uploadBannerImage : {url : '/titles/{title_id}/uploadBannerImage', method: HTTP_METHODS.POST},
       addAdministrator : { url: '/titles/{title_id}/addAdministrator', method: HTTP_METHODS.POST },
       removeAdministrator : { url: '/titles/{title_id}/removeAdministrator/{user_id}', method: HTTP_METHODS.DELETE },
+      addMedia: { url: '/titles/{title_id}/addMedia', method: HTTP_METHODS.POST },
+      removeMedia: { url: '/titles/{title_id}/removeMedia/{media_id}', method: HTTP_METHODS.DELETE },
     };
 
   }

package/src/util/Requests.ts

@@ -1,4 +1,4 @@
-import axios, { AxiosPromise } from 'axios';
+import axios, { AxiosPromise, AxiosRequestConfig, AxiosProgressEvent } from 'axios';
 import Config from '../config/Config';
 import HTTP_METHODS from '../constants/HttpMethods';
 import Route from '../routes/interface';
@@ -140,8 +140,10 @@ class Requests {
     filename: string,
     file: File | Blob,
     data?: any,
-    params?: Record<string, any>
+    params?: Record<string, any>,
+    onUploadProgress?: (progressEvent: AxiosProgressEvent) => void
   ): AxiosPromise<Response<T>> {
+    // Process URL and params
     if (params && Object.keys(params).length > 0) {
       const queryString = Object.entries(params)
         .map(([key, value]) => `${key}=${encodeURIComponent(value)}`)
@@ -149,8 +151,8 @@ class Requests {
       url = `${url}?${queryString}`;
     }
 
+    // Prepare FormData
     const formData = new FormData();
-
     formData.append(filename, file);
 
     if (Requests.community_id) {
@@ -164,7 +166,27 @@ class Requests {
       formData.append(key, data[key]);
     }
 
-    return Requests.request<T>('POST', url, data, formData);
+    // Prepare headers
+    let headers: { [key: string]: string } = {
+      'Content-Type': 'multipart/form-data',
+    };
+
+    if (Requests.authToken) {
+      headers['Authorization'] = `Bearer ${Requests.authToken}`;
+    }
+
+    // Format URL
+    url = url.replace(/\/\//g, '/');
+    const uri = `${Requests.baseUrl}${url}`.replace(/\/\//g, '/');
+
+    // Make the request
+    return axios({
+      method: 'POST',
+      url: uri,
+      data: formData,
+      headers,
+      onUploadProgress,
+    });
   }
 
   public static uploadBlob<T>(
@@ -172,8 +194,10 @@ class Requests {
     filename: string,
     blob: Blob,
     data?: any,
-    params?: Record<string, any>
+    params?: Record<string, any>,
+    onUploadProgress?: (progressEvent: AxiosProgressEvent) => void
   ): AxiosPromise<Response<T>> {
+    // Process URL and params
     if (params && Object.keys(params).length > 0) {
       const queryString = Object.entries(params)
         .map(([key, value]) => `${key}=${encodeURIComponent(value)}`)
@@ -181,8 +205,8 @@ class Requests {
       url = `${url}?${queryString}`;
     }
 
+    // Prepare FormData
     const formData = new FormData();
-
     formData.append(filename, blob);
 
     if (Requests.community_id) {
@@ -196,9 +220,30 @@ class Requests {
       formData.append(key, data[key]);
     }
 
-    return Requests.request<T>('POST', url, data, formData);
+    // Prepare headers
+    let headers: { [key: string]: string } = {
+      'Content-Type': 'multipart/form-data',
+    };
+
+    if (Requests.authToken) {
+      headers['Authorization'] = `Bearer ${Requests.authToken}`;
+    }
+
+    // Format URL
+    url = url.replace(/\/\//g, '/');
+    const uri = `${Requests.baseUrl}${url}`.replace(/\/\//g, '/');
+
+    // Make the request
+    return axios({
+      method: 'POST',
+      url: uri,
+      data: formData,
+      headers,
+      onUploadProgress,
+    });
   }
 
+
   // Method adapted for browser environments
 
   public static async uploadFileInChunks<T>(
@@ -206,27 +251,27 @@ class Requests {
     uploadUrl: string,
     onProgress?: (totalSize: number, amountUploaded: number) => void,
     data?: any,
-    chunkSize ?: number, // Default chunk size of 1MB
+    chunkSize?: number, // Default chunk size of 1MB
   ): Promise<void> {
 
-    if(!chunkSize) {
+    if (!chunkSize) {
       chunkSize = 1024 * 1024
     }
     const fileSize = file.size;
     const totalChunks = Math.ceil(fileSize / chunkSize);
     let currentChunkIndex = 0;
     let totalUploaded = 0; // Keep track of the total uploaded bytes
-  
+
     // Generate a unique identifier for this upload session using the Web Cryptography API
     const array = new Uint32Array(4);
     window.crypto.getRandomValues(array);
     const identifier = Array.from(array, dec => ('0' + dec.toString(16)).substr(-2)).join('');
-  
+
     while (currentChunkIndex <= totalChunks) {
       const start = currentChunkIndex * chunkSize;
       const end = Math.min(start + chunkSize, fileSize);
       const chunk = file.slice(start, end);
-  
+
       const formData = new FormData();
       formData.append('video', chunk, file.name);
       formData.append('chunkIndex', currentChunkIndex.toString());
@@ -239,30 +284,30 @@ class Requests {
           formData.append(key, data[key]);
         }
       }
-  
+
       // Construct the full URL if necessary or use a method to determine the base URL
       const fullUploadUrl = `${Requests.baseUrl}${uploadUrl}`;
-  
+
       // Make sure the authorization token is included if required
       const headers: { [key: string]: string } = {};
       if (Requests.authToken) {
         headers['Authorization'] = `Bearer ${Requests.authToken}`;
       }
-  
+
       // Perform the upload
-      await axios.post(fullUploadUrl, formData, { 
+      await axios.post(fullUploadUrl, formData, {
         headers,
         onUploadProgress: (progressEvent) => {
           const currentChunkProgress = progressEvent.loaded; // Bytes uploaded of the current chunk
           // Calculate the total uploaded size including previous chunks and the current chunk's progress
           const totalProgress = totalUploaded + currentChunkProgress;
 
-          if(onProgress){
+          if (onProgress) {
             onProgress(fileSize, end);
           }
-        } 
+        }
       });
-  
+
       currentChunkIndex++;
     }
   }