Make VideoUploadResponse consistent with nodejs client Video

Author: olivier-lando

dist/index.js

@@ -5,27 +5,28 @@ export declare const DEFAULT_RETRIES = 5;
 export declare const DEFAULT_API_HOST = "ws.api.video";
 export declare type VideoUploadResponse = {
     readonly videoId: string;
-    readonly title: string;
-    readonly description: string;
-    readonly public: boolean;
-    readonly panoramic: boolean;
-    readonly mp4Support: boolean;
-    readonly publishedAt: Date;
-    readonly createdAt: Date;
-    readonly uploadedAt: Date;
-    readonly tags: readonly string[];
-    readonly metadata: readonly {
-        readonly key: string;
-        readonly value: string;
+    readonly title?: string;
+    readonly description?: string;
+    readonly _public?: boolean;
+    readonly panoramic?: boolean;
+    readonly mp4Support?: boolean;
+    readonly publishedAt?: Date;
+    readonly createdAt?: Date;
+    readonly updatedAt?: Date;
+    readonly tags?: string[];
+    readonly metadata?: {
+        readonly key?: string;
+        readonly value?: string;
     }[];
-    readonly source: {
-        readonly type: string;
-        readonly uri: string;
+    readonly source?: {
+        readonly type?: string;
+        readonly uri?: string;
     };
-    readonly assets: {
-        readonly iframe: string;
-        readonly player: string;
-        readonly hls: string;
-        readonly thumbnail: string;
+    readonly assets?: {
+        readonly iframe?: string;
+        readonly player?: string;
+        readonly hls?: string;
+        readonly thumbnail?: string;
     };
 };
+export declare const apiResponseToVideoUploadResponse: (response: any) => VideoUploadResponse;

dist/src/common.d.ts

@@ -4,29 +4,41 @@ export const MAX_CHUNK_SIZE = 1024 * 1024 * 128; // 128mb
 export const DEFAULT_RETRIES = 5;
 export const DEFAULT_API_HOST = "ws.api.video";
 
-export type VideoUploadResponse = {
-    readonly videoId: string;
-    readonly title: string;
-    readonly description: string;
-    readonly public: boolean;
-    readonly panoramic: boolean;
-    readonly mp4Support: boolean;
-    readonly publishedAt: Date;
-    readonly createdAt: Date;
-    readonly uploadedAt: Date;
-    readonly tags: readonly string[];
-    readonly metadata: readonly {
-        readonly key: string;
-        readonly value: string;
-    }[];
-    readonly source: {
-      readonly type: string;
-      readonly uri: string;
-    };
-    readonly assets: {
-      readonly iframe: string;
-      readonly player: string;
-      readonly hls: string;
-      readonly thumbnail: string;
-    };
-  };
+export declare type VideoUploadResponse = {
+  readonly videoId: string;
+  readonly title?: string;
+  readonly description?: string;
+  readonly _public?: boolean;
+  readonly panoramic?: boolean;
+  readonly mp4Support?: boolean;
+  readonly publishedAt?: Date;
+  readonly createdAt?: Date;
+  readonly updatedAt?: Date;
+  readonly tags?: string[];
+  readonly metadata?: {
+    readonly key?: string;
+    readonly value?: string;
+  }[];
+  readonly source?: {
+    readonly type?: string;
+    readonly uri?: string;
+  };
+  readonly assets?: {
+    readonly iframe?: string;
+    readonly player?: string;
+    readonly hls?: string;
+    readonly thumbnail?: string;
+  };
+};
+
+export const apiResponseToVideoUploadResponse = (response: any): VideoUploadResponse => {
+  const res = {
+    ...response,
+    _public: response.public,
+    publishedAt: response.publishedAt ? new Date(response.publishedAt) : undefined,
+    createdAt: response.createdAt ? new Date(response.createdAt) : undefined,
+    updatedAt: response.updatedAt ? new Date(response.updatedAt) : undefined,
+  };
+  delete res.public;
+  return res;
+}

src/common.ts

@@ -1,3 +1,5 @@
+import { VideoUploader } from "./video-uploader";
+
 export { UploadProgressEvent, VideoUploader, VideoUploaderOptionsWithAccessToken, VideoUploaderOptionsWithUploadToken } from "./video-uploader";
 export { ProgressiveUploadProgressEvent, ProgressiveUploader, ProgressiveUploaderOptionsWithAccessToken, ProgressiveUploaderOptionsWithUploadToken } from './progressive-video-uploader';
 export { VideoUploadResponse, MIN_CHUNK_SIZE, MAX_CHUNK_SIZE } from './common';

src/index.ts

@@ -1,4 +1,4 @@
-import { DEFAULT_API_HOST, DEFAULT_RETRIES, MIN_CHUNK_SIZE, VideoUploadResponse } from "./common";
+import { apiResponseToVideoUploadResponse, DEFAULT_API_HOST, DEFAULT_RETRIES, MIN_CHUNK_SIZE, VideoUploadResponse } from "./common";
 import { PromiseQueue } from "./promise-queue";
 
 export interface ProgressiveUploaderOptionsWithUploadToken extends Options {
@@ -136,7 +136,7 @@ export class ProgressiveUploader {
                     }
                 }
             };
-            xhr.onload = (_) => resolve(JSON.parse(xhr.response));
+            xhr.onload = (_) => resolve(apiResponseToVideoUploadResponse(xhr.response))
             xhr.upload.onprogress = (e) => this.onProgressCallbacks.forEach(cb => cb({
                 uploadedBytes: e.loaded,
                 totalBytes: fileSize,

src/progressive-video-uploader.ts

@@ -1,4 +1,4 @@
-import { DEFAULT_API_HOST, DEFAULT_CHUNK_SIZE, DEFAULT_RETRIES, MAX_CHUNK_SIZE, MIN_CHUNK_SIZE, VideoUploadResponse } from "./common";
+import { apiResponseToVideoUploadResponse, DEFAULT_API_HOST, DEFAULT_CHUNK_SIZE, DEFAULT_RETRIES, MAX_CHUNK_SIZE, MIN_CHUNK_SIZE, VideoUploadResponse } from "./common";
 import { PromiseQueue } from "./promise-queue";
 
 export interface VideoUploaderOptionsWithUploadToken extends Options {
@@ -111,7 +111,8 @@ export class VideoUploader {
                     retriesCount++;
                 }
             }
-            resolve(response as VideoUploadResponse);
+
+            resolve(apiResponseToVideoUploadResponse(response));
         }));
     }
 
@@ -131,7 +132,7 @@ export class VideoUploader {
         return chunkForm;
     }
 
-    private uploadCurrentChunk(): Promise<VideoUploadResponse> {
+    private uploadCurrentChunk(): Promise<any> {
         return new Promise((resolve, reject) => {
             const firstByte = this.currentChunk * this.chunkSize;
             const computedLastByte = (this.currentChunk + 1) * this.chunkSize;

src/video-uploader.ts

@@ -7,7 +7,7 @@ describe('Instanciation', () => {
     it('throws if required param is missing', () => {
         // @ts-ignore
         expect(() => new ProgressiveUploader({
-        })).to.throw("You must provide either an accessToken or an uploadToken");
+        })).to.throw("You must provide either an accessToken, an uploadToken or an API key");
 
         // @ts-ignore
         expect(() => new ProgressiveUploader({