Merge pull request #19 from apivideo/abstract-uploader

Abstract uploader

Author: olivier-lando

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 All changes to this project will be documented in this file.
 
+## [1.0.8] - 2022-04-27
+- Create a AbstractUploader
+- Add origin header
+- Add the possibility to provide a refresh token
+
 ## [1.0.7] - 2022-04-26
 - Don't retry on 401 errors
 - Mutualize some code

README.md

@@ -155,11 +155,12 @@ Using delegated upload tokens for authentication is best options when uploading
 **Warning**: be aware that exposing your access token client-side can lead to huge security issues. Use this method only if you know what you're doing :).
 
 
-|                   Option name | Mandatory | Type   | Description             |
-| ----------------------------: | --------- | ------ | ----------------------- |
-|                   accessToken | **yes**   | string | your access token       |
-|                       videoId | **yes**   | string | id of an existing video |
-| _common options (see bellow)_ |           |        |                         |
+|                   Option name | Mandatory | Type   | Description                                                                                                                                     |
+| ----------------------------: | --------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+|                   accessToken | **yes**   | string | your access token                                                                                                                               |
+|                  refreshToken | **no**    | string | your refresh token (please not that if you don't provide a refresh token, your upload may fails due to the access token lifetime of 60 minutes) |
+|                       videoId | **yes**   | string | id of an existing video                                                                                                                         |
+| _common options (see bellow)_ |           |        |                                                                                                                                                 |
 
 
 #### Using an API key (**strongly** discouraged):

dist/index.js

@@ -0,0 +1,85 @@
+export declare const MIN_CHUNK_SIZE: number;
+export declare const DEFAULT_CHUNK_SIZE: number;
+export declare const MAX_CHUNK_SIZE: number;
+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 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 interface CommonOptions {
+    apiHost?: string;
+    retries?: number;
+}
+export interface WithUploadToken {
+    uploadToken: string;
+    videoId?: string;
+}
+export interface WithAccessToken {
+    accessToken: string;
+    refreshToken?: string;
+    videoId: string;
+}
+export interface WithApiKey {
+    apiKey: string;
+    videoId: string;
+}
+export declare type VideoUploadError = {
+    status: number;
+    type?: string;
+    title?: string;
+    reason?: string;
+    raw: string;
+};
+declare type HXRRequestParams = {
+    parts?: {
+        currentPart: number;
+        totalParts: number | "*";
+    };
+    onProgress?: (e: ProgressEvent) => void;
+    body: Document | XMLHttpRequestBodyInit | null;
+};
+export declare abstract class AbstractUploader<T> {
+    protected uploadEndpoint: string;
+    protected videoId?: string;
+    protected retries: number;
+    protected headers: {
+        [name: string]: string;
+    };
+    protected onProgressCallbacks: ((e: T) => void)[];
+    protected refreshToken?: string;
+    protected apiHost: string;
+    constructor(options: CommonOptions & (WithAccessToken | WithUploadToken | WithApiKey));
+    onProgress(cb: (e: T) => void): void;
+    protected parseErrorResponse(xhr: XMLHttpRequest): VideoUploadError;
+    protected apiResponseToVideoUploadResponse(response: any): VideoUploadResponse;
+    protected sleep(duration: number): Promise<void>;
+    protected xhrWithRetrier(params: HXRRequestParams): Promise<VideoUploadResponse>;
+    protected createFormData(file: Blob, fileName: string, startByte?: number, endByte?: number): FormData;
+    doRefreshToken(): Promise<void>;
+    private createXhrPromise;
+    private withRetrier;
+}
+export {};

dist/src/abstract-uploader.d.ts

@@ -1,3 +1,3 @@
 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';
+export { VideoUploadResponse, MIN_CHUNK_SIZE, MAX_CHUNK_SIZE } from './abstract-uploader';

dist/src/index.d.ts

@@ -1,19 +1,9 @@
-import { VideoUploadResponse } from "./common";
-export interface ProgressiveUploaderOptionsWithUploadToken extends Options {
-    uploadToken: string;
-    videoId?: string;
+import { AbstractUploader, CommonOptions, VideoUploadResponse, WithAccessToken, WithApiKey, WithUploadToken } from "./abstract-uploader";
+export interface ProgressiveUploaderOptionsWithUploadToken extends CommonOptions, WithUploadToken {
 }
-export interface ProgressiveUploaderOptionsWithAccessToken extends Options {
-    accessToken: string;
-    videoId: string;
+export interface ProgressiveUploaderOptionsWithAccessToken extends CommonOptions, WithAccessToken {
 }
-export interface ProgressiveUploaderOptionsWithApiKey extends Options {
-    apiKey: string;
-    videoId: string;
-}
-interface Options {
-    apiHost?: string;
-    retries?: number;
+export interface ProgressiveUploaderOptionsWithApiKey extends CommonOptions, WithApiKey {
 }
 export interface ProgressiveUploadProgressEvent {
     uploadedBytes: number;
@@ -23,22 +13,13 @@ export interface ProgressiveProgressEvent {
     uploadedBytes: number;
     totalBytes: number;
 }
-export declare class ProgressiveUploader {
-    private uploadEndpoint;
-    private videoId?;
-    private retries;
-    private onProgressCallbacks;
-    private headers;
+export declare class ProgressiveUploader extends AbstractUploader<ProgressiveProgressEvent> {
     private currentPartNum;
     private currentPartBlobs;
     private currentPartBlobsSize;
     private queue;
     constructor(options: ProgressiveUploaderOptionsWithAccessToken | ProgressiveUploaderOptionsWithUploadToken | ProgressiveUploaderOptionsWithApiKey);
-    onProgress(cb: (e: ProgressiveProgressEvent) => void): void;
     uploadPart(file: Blob): Promise<void>;
     uploadLastPart(file: Blob): Promise<VideoUploadResponse>;
-    private createFormData;
-    private sleep;
     private upload;
 }
-export {};

dist/src/progressive-video-uploader.d.ts

@@ -1,21 +1,13 @@
-import { VideoUploadResponse } from "./common";
-export interface VideoUploaderOptionsWithUploadToken extends Options {
-    uploadToken: string;
-    videoId?: string;
+import { AbstractUploader, CommonOptions, VideoUploadResponse, WithAccessToken, WithApiKey, WithUploadToken } from "./abstract-uploader";
+interface UploadOptions {
+    file: File;
+    chunkSize?: number;
 }
-export interface VideoUploaderOptionsWithAccessToken extends Options {
-    accessToken: string;
-    videoId: string;
+export interface VideoUploaderOptionsWithUploadToken extends CommonOptions, UploadOptions, WithUploadToken {
 }
-export interface VideoUploaderOptionsWithApiKey extends Options {
-    apiKey: string;
-    videoId: string;
+export interface VideoUploaderOptionsWithAccessToken extends CommonOptions, UploadOptions, WithAccessToken {
 }
-interface Options {
-    file: File;
-    chunkSize?: number;
-    apiHost?: string;
-    retries?: number;
+export interface VideoUploaderOptionsWithApiKey extends CommonOptions, UploadOptions, WithApiKey {
 }
 export interface UploadProgressEvent {
     uploadedBytes: number;
@@ -25,24 +17,14 @@ export interface UploadProgressEvent {
     currentChunk: number;
     currentChunkUploadedBytes: number;
 }
-export declare class VideoUploader {
+export declare class VideoUploader extends AbstractUploader<UploadProgressEvent> {
     private file;
     private chunkSize;
-    private uploadEndpoint;
-    private currentChunk;
     private chunksCount;
     private fileSize;
     private fileName;
-    private videoId?;
-    private retries;
-    private onProgressCallbacks;
-    private headers;
-    private queue;
     constructor(options: VideoUploaderOptionsWithAccessToken | VideoUploaderOptionsWithUploadToken | VideoUploaderOptionsWithApiKey);
-    onProgress(cb: (e: UploadProgressEvent) => void): void;
     upload(): Promise<VideoUploadResponse>;
-    private sleep;
-    private createFormData;
     private uploadCurrentChunk;
 }
 export {};

dist/src/video-uploader.d.ts

@@ -1,6 +1,6 @@
 {
   "name": "@api.video/video-uploader",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "api.video video uploader",
   "repository": {
     "type": "git",

package-lock.json

@@ -0,0 +1,23 @@
+<html>
+    <head>
+        <script src="../dist/index.js"></script>
+    </head>
+    <body>
+
+        <form>
+            <input type="file" id="input" onchange="uploadFile(this.files)">
+        </form>
+        <script type="text/javascript">
+            function uploadFile(files) {
+                const uploader = new VideoUploader({
+                    file: files[0],
+                    videoId: "vi7Wub9QiEDdkMd5CZmnrD1Y",
+                    accessToken: "1ZeyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2NTMzMTAwMzIuMzE4MzgyLCJuYmYiOjE2NTMzMTAwMzIuMzE4MzgyLCJleHAiOjE2NTMzMTM2MzIuMzE4MzgyLCJhcGlLZXlWYWx1ZSI6IjNYbUwxTXE0NkxQUmNnazVDTW1lMmZCc0liWU1LWGJRSVg1RHJUa0NPamcifQ.MCGVn1CrdEnKL_b-3MGuNTdb3y-IoUCwoikzIQEzWIyJgsz7338UJ_yYF0njGXJFjjhOWz3M_ywyVkr5E1Vx0K8RExq5gUEvehmBERkoOtPjYLxvIsKCms7mml_cPBWuh21-ofxNKH1W58AhP8uvvNTqSSKgeh01abOr8gpyaR8cgqAEcFjkcko0LULAEb44mCmiBMBwJAAfh4iuAyyqLQO1TC63ev92xAhWyKJY23npHfAkzpE_F8HpCp6VbAQwZdZ6Tmsg2lj4kMFgvZi2EiaUZuW5RS5rkq4uBTmuOBNNTqwtuSl0bYcp-NBQ4W2Ubc_Kw04_2KcIkn4O1NEwbw",
+                    refreshToken: "1eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE2NTMzMTE3MDMuMzE5NTcyLCJuYmYiOjE2NTMzMTE3MDMuMzE5NTcyLCJleHAiOjE2NTU5OTAxMDMuMzE5NTcyLCJyZWZyZXNoVG9rZW4iOnRydWUsImFwaUtleVZhbHVlIjoiM1htTDFNcTQ2TFBSY2drNUNNbWUyZkJzSWJZTUtYYlFJWDVEclRrQ09qZyJ9.soMScSuENRqqrIIOXdDnevDc1iNbl9Qcow71D6bOn4f9corRQhHgRwhOpKNoVAYX-SbbAgd1rbjiG95YgFLB9avDvCxqtW-7m_YVylywpGXOoaoz7wJSS2isB794_NYq6vAlivX22MB9aeA84JzwEZyajIOcwCJ-eOG-JbrW6kAtjW2Fl2I6rGIc6qQidYFSidZYI16p88aV-_-fHk8wV70B2Wb7CNOjrFeR51aIgtqeA-oheluRUwb0_3z5fgSTOy03CtOriloNSf9kGexvACnu1sIJ10D2cbHJshPv7djlQn8doGxhzoMpN7qy9MifO7KY5VFer_hQD0FuNFr5YQ"
+                });
+                
+                uploader.upload().catch(e => console.log(e));
+            }
+        </script>
+    </body>
+</html>