Merge pull request #16 from apivideo/add-api-token-auth-method

olivier-lando · web-flow · commit 7a8363b2861e · 2022-04-21T14:46:18.000+02:00
Add api token auth method
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,10 @@
 # Changelog
 All changes to this project will be documented in this file.
 
+## [1.0.5] - 2022-03-24
+- Fix date attributes types
+- Add authentication using an API key
+
 ## [1.0.4] - 2022-03-23
 - Export `VideoUploadResponse` type
 
diff --git a/README.md b/README.md
@@ -21,6 +21,7 @@
     - [Options](#options)
       - [Using a delegated upload token (recommended):](#using-a-delegated-upload-token-recommended)
       - [Using an access token (discouraged):](#using-an-access-token-discouraged)
+      - [Using an API key (**strongly** discouraged):](#using-an-api-key-strongly-discouraged)
       - [Common options](#common-options)
     - [Example](#example)
   - [Methods](#methods)
@@ -161,6 +162,18 @@ Using delegated upload tokens for authentication is best options when uploading
 | _common options (see bellow)_ |           |        |                         |
 
 
+#### Using an API key (**strongly** discouraged):
+
+**Warning**: be aware that exposing your API key client-side can lead to huge security issues. Use this method only if you know what you're doing :).
+
+
+|                   Option name | Mandatory | Type   | Description             |
+| ----------------------------: | --------- | ------ | ----------------------- |
+|                       API Key | **yes**   | string | your api.video API key  |
+|                       videoId | **yes**   | string | id of an existing video |
+| _common options (see bellow)_ |           |        |                         |
+
+
 #### Common options
 
 
@@ -262,10 +275,10 @@ Using delegated upload tokens for authentication is best options when uploading
 #### Common options
 
 
-| Option name | Mandatory | Type   | Description                                                                |
-| ----------: | --------- | ------ | -------------------------------------------------------------------------- |
-|     apiHost | no        | string | api.video host (default: ws.api.video)                                     |
-|     retries | no        | number | number of retries when an API call fails (default: 5)                      |
+| Option name | Mandatory | Type   | Description                                           |
+| ----------: | --------- | ------ | ----------------------------------------------------- |
+|     apiHost | no        | string | api.video host (default: ws.api.video)                |
+|     retries | no        | number | number of retries when an API call fails (default: 5) |
 
 
 ### Example
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/src/common.d.ts b/dist/src/common.d.ts
@@ -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: string;
-    readonly createdAt: string;
-    readonly uploadedAt: string;
-    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;
diff --git a/dist/src/progressive-video-uploader.d.ts b/dist/src/progressive-video-uploader.d.ts
@@ -7,6 +7,10 @@ export interface ProgressiveUploaderOptionsWithAccessToken extends Options {
     accessToken: string;
     videoId: string;
 }
+export interface ProgressiveUploaderOptionsWithApiKey extends Options {
+    apiKey: string;
+    videoId: string;
+}
 interface Options {
     apiHost?: string;
     retries?: number;
@@ -29,7 +33,7 @@ export declare class ProgressiveUploader {
     private currentPartBlobs;
     private currentPartBlobsSize;
     private queue;
-    constructor(options: ProgressiveUploaderOptionsWithAccessToken | ProgressiveUploaderOptionsWithUploadToken);
+    constructor(options: ProgressiveUploaderOptionsWithAccessToken | ProgressiveUploaderOptionsWithUploadToken | ProgressiveUploaderOptionsWithApiKey);
     onProgress(cb: (e: ProgressiveProgressEvent) => void): void;
     uploadPart(file: Blob): Promise<void>;
     uploadLastPart(file: Blob): Promise<VideoUploadResponse>;
diff --git a/dist/src/video-uploader.d.ts b/dist/src/video-uploader.d.ts
@@ -7,6 +7,10 @@ export interface VideoUploaderOptionsWithAccessToken extends Options {
     accessToken: string;
     videoId: string;
 }
+export interface VideoUploaderOptionsWithApiKey extends Options {
+    apiKey: string;
+    videoId: string;
+}
 interface Options {
     file: File;
     chunkSize?: number;
@@ -34,7 +38,7 @@ export declare class VideoUploader {
     private onProgressCallbacks;
     private headers;
     private queue;
-    constructor(options: VideoUploaderOptionsWithAccessToken | VideoUploaderOptionsWithUploadToken);
+    constructor(options: VideoUploaderOptionsWithAccessToken | VideoUploaderOptionsWithUploadToken | VideoUploaderOptionsWithApiKey);
     onProgress(cb: (e: UploadProgressEvent) => void): void;
     upload(): Promise<VideoUploadResponse>;
     private sleep;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@api.video/video-uploader",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "api.video video uploader",
   "repository": {
     "type": "git",
diff --git a/src/common.ts b/src/common.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: string;
-    readonly createdAt: string;
-    readonly uploadedAt: string;
-    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;
+}
diff --git a/src/index.ts b/src/index.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';
diff --git a/src/progressive-video-uploader.ts b/src/progressive-video-uploader.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 {
@@ -9,6 +9,10 @@ export interface ProgressiveUploaderOptionsWithAccessToken extends Options {
     accessToken: string;
     videoId: string;
 }
+export interface ProgressiveUploaderOptionsWithApiKey extends Options {
+    apiKey: string;
+    videoId: string;
+}
 interface Options {
     apiHost?: string;
     retries?: number;
@@ -37,7 +41,7 @@ export class ProgressiveUploader {
     private currentPartBlobsSize = 0;
     private queue = new PromiseQueue();
 
-    constructor(options: ProgressiveUploaderOptionsWithAccessToken | ProgressiveUploaderOptionsWithUploadToken) {
+    constructor(options: ProgressiveUploaderOptionsWithAccessToken | ProgressiveUploaderOptionsWithUploadToken | ProgressiveUploaderOptionsWithApiKey) {
         const apiHost = options.apiHost || DEFAULT_API_HOST;
 
         if (options.hasOwnProperty("uploadToken")) {
@@ -54,8 +58,15 @@ export class ProgressiveUploader {
             }
             this.uploadEndpoint = `https://${apiHost}/videos/${optionsWithAccessToken.videoId}/source`;
             this.headers.Authorization = `Bearer ${optionsWithAccessToken.accessToken}`;
-        } else {
-            throw new Error(`You must provide either an accessToken or an uploadToken`);
+        } else if (options.hasOwnProperty("apiKey")) {
+            const optionsWithApiKey = options as ProgressiveUploaderOptionsWithApiKey;
+            if (!optionsWithApiKey.videoId) {
+                throw new Error("'videoId' is missing");
+            }
+            this.uploadEndpoint = `https://${apiHost}/videos/${optionsWithApiKey.videoId}/source`;
+            this.headers.Authorization = `Basic ${btoa(optionsWithApiKey.apiKey + ":")}`;
+        }else {
+            throw new Error(`You must provide either an accessToken, an uploadToken or an API key`);
         }
 
         this.retries = options.retries || DEFAULT_RETRIES;
@@ -125,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,
diff --git a/src/video-uploader.ts b/src/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 {
@@ -9,6 +9,10 @@ export interface VideoUploaderOptionsWithAccessToken extends Options {
     accessToken: string;
     videoId: string;
 }
+export interface VideoUploaderOptionsWithApiKey extends Options {
+    apiKey: string;
+    videoId: string;
+}
 interface Options {
     file: File;
     chunkSize?: number;
@@ -39,7 +43,7 @@ export class VideoUploader {
     private headers: { [name: string]: string } = {};
     private queue = new PromiseQueue();
 
-    constructor(options: VideoUploaderOptionsWithAccessToken | VideoUploaderOptionsWithUploadToken) {
+    constructor(options: VideoUploaderOptionsWithAccessToken | VideoUploaderOptionsWithUploadToken | VideoUploaderOptionsWithApiKey) {
         const apiHost = options.apiHost || DEFAULT_API_HOST;
 
         if (!options.file) {
@@ -60,8 +64,15 @@ export class VideoUploader {
             }
             this.uploadEndpoint = `https://${apiHost}/videos/${optionsWithAccessToken.videoId}/source`;
             this.headers.Authorization = `Bearer ${optionsWithAccessToken.accessToken}`;
+        }  else if (options.hasOwnProperty("apiKey")) {
+            const optionsWithApiKey = options as VideoUploaderOptionsWithApiKey;
+            if (!optionsWithApiKey.videoId) {
+                throw new Error("'videoId' is missing");
+            }
+            this.uploadEndpoint = `https://${apiHost}/videos/${optionsWithApiKey.videoId}/source`;
+            this.headers.Authorization = `Basic ${btoa(optionsWithApiKey.apiKey + ":")}`;
         } else {
-            throw new Error(`You must provide either an accessToken or an uploadToken`);
+            throw new Error(`You must provide either an accessToken, an uploadToken or an API key`);
         }
 
         if(options.chunkSize && (options.chunkSize < MIN_CHUNK_SIZE || options.chunkSize > MAX_CHUNK_SIZE)) {
@@ -100,7 +111,8 @@ export class VideoUploader {
                     retriesCount++;
                 }
             }
-            resolve(response as VideoUploadResponse);
+
+            resolve(apiResponseToVideoUploadResponse(response));
         }));
     }
 
@@ -120,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;
diff --git a/test/progressive-video-uploader.test.ts b/test/progressive-video-uploader.test.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({

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@api.video/video-uploader",`
`3`		`- "version": "1.0.4",`
	`3`	`+ "version": "1.0.5",`
`4`	`4`	`"description": "api.video video uploader",`
`5`	`5`	`"repository": {`
`6`	`6`	`"type": "git",`