Add API key auth method

Author: olivier-lando

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
 

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

dist/index.js

@@ -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>;

dist/src/progressive-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;

dist/src/video-uploader.d.ts

@@ -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",

package.json

@@ -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;

src/progressive-video-uploader.ts

@@ -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)) {