@or-sdk/files 3.7.3 → 3.8.0

package/src/Files.ts

@@ -1,10 +1,10 @@
 import { Base } from '@or-sdk/base';
 import axios from 'axios';
-import type { AxiosProgressEvent } from 'axios';
-import { isNode } from 'browser-or-node';
+import type FormDataNode from 'form-data';
+import { Memoize } from 'typescript-memoize';
 
 import { SERVICE_KEY } from './constants';
-import {
+import type {
   FileItem,
   FileItemSelect,
   FilesConfig,
@@ -13,8 +13,11 @@ import {
   UploadFileProps,
   UploadSystemFileParams,
   UploadSystemUrlResponse,
+  UploadToSignedUrlParameters,
+  UploadUrlProps,
   UploadUrlResponse,
 } from './types';
+import { isNode } from './utils';
 
 export class Files extends Base {
   /**
@@ -72,7 +75,7 @@ export class Files extends Base {
    * @return total folder size in bytes
    */
   async getFolderSize(key: string): Promise<number> {
-    const { size } = await this.callApiV2<{size: number;}>({
+    const { size } = await this.callApiV2<{ size: number; }>({
       method: 'get',
       route: 'folders/find-one',
       params: { key },
@@ -104,34 +107,19 @@ export class Files extends Base {
       attributes,
     };
 
-    let res: [(FileItem[] | FileItemSelect[]), FileItem[]];
+    const [files, folders] = await Promise.all([
+      this.callApiV2<FileItem[] | FileItemSelect[]>({
+        method: 'GET',
+        route: 'files',
+        params: queryParams,
+      }),
+      isPublic ? [] as FileItem[] : this.callApiV2<FileItem[]>({
+        method: 'GET',
+        route: 'folders',
+        params: { prefix: treePrefix },
+      }),
+    ]);
 
-    if (isPublic) {
-      res = await Promise.all([
-        this.callApiV2<FileItem[] | FileItemSelect[]>({
-          method: 'GET',
-          route: 'files',
-          params: queryParams,
-        }),
-        [], // we prevent unnecessary request to get public folders, because they only private
-      ]);
-    } else {
-      res = await Promise.all([
-        this.callApiV2<FileItem[] | FileItemSelect[]>({
-          method: 'GET',
-          route: 'files',
-          params: queryParams,
-        }),
-        this.callApiV2<FileItem[]>({
-          method: 'GET',
-          route: 'folders',
-          params: { prefix: treePrefix },
-        }),
-      ]);
-    }
-
-
-    const [files, folders] = res;
     return [...folders, ...files];
   }
 
@@ -155,17 +143,21 @@ export class Files extends Base {
       prefix: term,
     };
 
-    const files: FileItem[] = await this.callApiV2({
-      method: 'GET',
-      route: 'files/search',
-      params: queryParams,
-    });
+    const [files, folders] = await Promise.all([
+      this.callApiV2<FileItem[]>({
+        method: 'GET',
+        route: 'files/search',
+        params: queryParams,
+      }),
 
-    const folders: FileItem[] = isPublic ? [] : await this.callApiV2({
-      method: 'GET',
-      route: 'folders/search',
-      params: queryParams,
-    });
+      isPublic
+        ? [] as FileItem[]
+        : this.callApiV2<FileItem[]>({
+          method: 'GET',
+          route: 'folders/search',
+          params: queryParams,
+        }),
+    ]);
 
     return [...files, ...folders];
   }
@@ -233,7 +225,7 @@ export class Files extends Base {
     const STEP = 2000; // 2 second in ms
     let passed = 0;
 
-    const promise = new Promise((res, rej) => {
+    await new Promise((res, rej) => {
       // it may take some time to copy file on S3, so we check it each "STEP" time
       const interval = setInterval(() => {
         this.getFile(newKey, isPublic)
@@ -245,8 +237,6 @@ export class Files extends Base {
           .catch(() => passed += STEP);
       }, STEP);
     });
-
-    await promise;
   }
 
   /**
@@ -325,9 +315,12 @@ export class Files extends Base {
    * @param ttl timestamp of file expiration
    * @return uploading Url with different header Fields
    */
-  getUploadUrl(data: { rewriteMode?: 'rewrite' | 'prevent-rewrite'; maxFileSize: number | undefined;
-    contentType: string; key: string; cacheControl: string; },
-  isPublic: boolean, ttl?: number, abortSignal?: AbortSignal): Promise<UploadUrlResponse> {
+  getUploadUrl(
+    data: UploadUrlProps,
+    isPublic: boolean,
+    ttl?: number,
+    abortSignal?: AbortSignal,
+  ): Promise<UploadUrlResponse> {
     const reqData: GetUploadUrlDataPayload = { ...data };
     if (ttl) reqData.ttl = new Date(ttl).toISOString();
 
@@ -358,7 +351,6 @@ export class Files extends Base {
    * @param waitTillFileAddedInDb true if you want to make sure file added to DB,
    * for example for instant removing it. Please, use it carefully.
    */
-  // eslint-disable-next-line max-len
   async uploadFile({
     type,
     name,
@@ -369,32 +361,35 @@ export class Files extends Base {
     rewriteMode,
     ttl,
     maxFileSize,
+    knownLength,
+    cacheControl = 'no-cache',
     waitTillFileAddedInDb,
   }: UploadFileProps, abortSignal?: AbortSignal): Promise<string> {
     const contentType = type || 'binary/octet-stream';
     const fileKey = prefix + name;
 
-    const { url, fields, downloadUrl } = await this.getUploadUrl({
+    const signedUrl = await this.getUploadUrl(
+      {
+        contentType,
+        key: fileKey,
+        cacheControl,
+        rewriteMode: rewriteMode,
+        maxFileSize: maxFileSize,
+      },
+      isPublic,
+      ttl,
+      abortSignal,
+    );
+
+    await this.uploadToSignedUrl({
+      signedUrl,
+      file: fileModel,
+      fileName: name,
+      cacheControl,
       contentType,
-      key: fileKey,
-      cacheControl: 'no-cache',
-      rewriteMode: rewriteMode,
-      maxFileSize: maxFileSize,
-    }, isPublic, ttl, abortSignal);
-
-    const FormDataLib = isNode ? require('form-data') : FormData; // eslint-disable-line no-undef
-    const formData = new FormDataLib();
-
-    Object.entries(fields).forEach(value => {
-      formData.append(value[0], value[1]);
-    });
-
-    formData.append('content-type', contentType);
-    formData.append('File', fileModel, name);
-
-    await axios.post(url, formData, {
+      knownLength,
       signal: abortSignal,
-      onUploadProgress: (event: AxiosProgressEvent) => progress?.(event),
+      onUploadProgress: progress,
     });
 
     if (waitTillFileAddedInDb) {
@@ -402,7 +397,7 @@ export class Files extends Base {
       const STEP = 2000; // 2 second in ms
       let passed = 0;
 
-      const promise = new Promise((res, rej) => {
+      await new Promise((res, rej) => {
         // it may take some time to copy file on S3, so we check it each "STEP" time
         const interval = setInterval(() => {
           this.getFile(fileKey, isPublic)
@@ -414,11 +409,9 @@ export class Files extends Base {
             .catch(() => passed += STEP);
         }, STEP);
       });
-
-      await promise;
     }
 
-    return downloadUrl;
+    return signedUrl.downloadUrl;
   }
 
   // ------------------------
@@ -431,14 +424,15 @@ export class Files extends Base {
    * @param file file for uploading
    * @param cacheControl cache settings
    * @param abortSignal signal to cancel uploading
+   * @deprecated use `uploadSystemFileV2` instead
    */
   async uploadSystemFile(
     prefix: string,
     file: File,
     cacheControl = 'max-age=3600',
-    abortSignal?: AbortSignal
+    abortSignal?: AbortSignal,
   ): Promise<string> {
-    const result: UploadSystemUrlResponse = await this.callApiV2({
+    const signedUrl: UploadSystemUrlResponse = await this.callApiV2({
       method: 'post',
       route: 'system-file',
       data: {
@@ -449,24 +443,16 @@ export class Files extends Base {
       signal: abortSignal,
     });
 
-    const { url, fields, downloadUrl } = result;
-
-    const FormDataLib = isNode ? require('form-data') : FormData; // eslint-disable-line no-undef
-    const formData = new FormDataLib();
-
-    Object.entries(fields).forEach(value => {
-      formData.append(value[0], value[1]);
-    });
-
-    formData.append('cache-control', cacheControl);
-    formData.append('content-type', file.type);
-    formData.append('File', file, file.name);
-
-    await axios.post(url, formData, {
+    await this.uploadToSignedUrl({
+      signedUrl,
+      file,
+      fileName: file.name,
+      cacheControl,
+      contentType: file.type,
       signal: abortSignal,
     });
 
-    return downloadUrl;
+    return signedUrl.downloadUrl;
   }
 
   /**
@@ -487,9 +473,10 @@ export class Files extends Base {
     ttl,
     fileName,
     contentType,
+    knownLength,
     abortSignal,
   }: UploadSystemFileParams): Promise<string> {
-    const result: UploadSystemUrlResponse = await this.callApiV2({
+    const signedUrl: UploadSystemUrlResponse = await this.callApiV2({
       method: 'post',
       route: 'system-file',
       data: {
@@ -501,24 +488,17 @@ export class Files extends Base {
       signal: abortSignal,
     });
 
-    const { url, fields, downloadUrl } = result;
-
-    const FormDataLib = isNode ? require('form-data') : FormData; // eslint-disable-line no-undef
-    const formData = new FormDataLib();
-
-    Object.entries(fields).forEach(value => {
-      formData.append(value[0], value[1]);
-    });
-
-    formData.append('cache-control', cacheControl);
-    formData.append('content-type', contentType);
-    formData.append('File', file, fileName);
-
-    await axios.post(url, formData, {
+    await this.uploadToSignedUrl({
+      signedUrl,
+      file,
+      fileName,
+      cacheControl,
+      contentType,
+      knownLength,
       signal: abortSignal,
     });
 
-    return downloadUrl;
+    return signedUrl.downloadUrl;
   }
 
   /**
@@ -584,4 +564,68 @@ export class Files extends Base {
       params: { key: path },
     });
   }
+
+  private async uploadToSignedUrl({
+    signedUrl,
+    file,
+    fileName,
+    cacheControl,
+    contentType,
+    knownLength,
+    signal,
+    onUploadProgress,
+  }: UploadToSignedUrlParameters) {
+    const { url, fields } = signedUrl;
+
+    const FormDataLib = await this.formDataFactory();
+    const formData = new FormDataLib();
+
+    Object.entries(fields).forEach(([key, value]) => {
+      formData.append(key, value);
+    });
+
+    if (cacheControl != undefined && cacheControl !== 'no-cache') {
+      formData.append('cache-control', cacheControl);
+    }
+    if (contentType) formData.append('content-type', contentType);
+
+    if (isNode) {
+      (formData as FormDataNode).append('File', file, {
+        filename: fileName,
+        contentType,
+        knownLength,
+      });
+    } else {
+      if (!(file instanceof File || file instanceof Blob)) {
+        throw new Error('In browser file can only be an instance of File or Blob');
+      }
+      (formData as FormData).append('File', file, fileName);
+    }
+
+    return await axios.post(url, formData, {
+      headers: {
+        ...this.getFormDataHeaders(formData),
+      },
+      onUploadProgress,
+      maxBodyLength: Infinity,
+      maxContentLength: Infinity,
+      signal,
+    });
+  }
+
+  @Memoize()
+  private async formDataFactory(): Promise<typeof FormDataNode | typeof FormData> {
+    if (isNode) {
+      const formDataModule = await import('form-data');
+      return formDataModule.default;
+    } else {
+      return FormData;
+    }
+  }
+
+  private getFormDataHeaders(formData: FormDataNode | FormData): Record<string, string> {
+    return ('getHeaders' in formData)
+      ? formData.getHeaders()
+      : {};
+  }
 }

package/src/types.ts

@@ -1,5 +1,6 @@
-import { Token } from '@or-sdk/base';
+import type { Token } from '@or-sdk/base';
 import type { AxiosProgressEvent } from 'axios';
+import type { ReadStream } from 'node:fs';
 
 export type FilesConfig = {
   /**
@@ -69,7 +70,7 @@ export type UploadUrlProps = {
   key: string;
   contentType: string;
   maxFileSize?: number;
-  cacheControl: string;
+  cacheControl?: string;
   rewriteMode?: 'rewrite' | 'prevent-rewrite';
 };
 
@@ -85,12 +86,7 @@ export type UploadFields = {
   'cache-control'?: string;
 };
 
-export type GetUploadUrlDataPayload = {
-  rewriteMode?: 'rewrite' | 'prevent-rewrite';
-  maxFileSize?: number;
-  contentType: string;
-  key: string;
-  cacheControl: string;
+export type GetUploadUrlDataPayload = UploadUrlProps & {
   ttl?: string;
 };
 
@@ -106,26 +102,45 @@ export type UploadSystemUrlResponse = {
   downloadUrl: string;
 };
 
+/** Buffer and ReadStream only supported in Node.js */
+export type FileModel = File | Blob | Buffer | ReadStream
+
 export type UploadFileProps = {
+  /** mime type of the file */
   type: string;
   name: string;
-  fileModel: File | Buffer;
+  fileModel: FileModel;
   prefix: string;
   isPublic: boolean;
   progress?: (event: ProgressEvent | AxiosProgressEvent) => void;
   rewriteMode?: 'rewrite' | 'prevent-rewrite';
   ttl?: number;
   maxFileSize?: number;
+  knownLength?: number;
+  cacheControl?: string;
   abortSignal?: AbortSignal;
   waitTillFileAddedInDb?: boolean;
 };
 
 export type UploadSystemFileParams = {
   prefix: string;
-  file: Buffer | Blob;
+  file: FileModel;
   cacheControl?: string;
   ttl: number;
   fileName: string;
   contentType?: string;
+  knownLength?: number;
   abortSignal?: AbortSignal;
 };
+
+export type UploadToSignedUrlParameters = {
+  signedUrl: UploadUrlResponse;
+  file: FileModel;
+  fileName: string;
+  cacheControl?: string;
+  /** Size of the file in bytes. Helpful when file is an instance of ReadStream in Node.js */
+  knownLength?: number;
+  contentType?: string;
+  signal?: AbortSignal;
+  onUploadProgress?: (event: ProgressEvent | AxiosProgressEvent) => void;
+}

package/src/utils.ts

@@ -0,0 +1,3 @@
+export const isNode = typeof process !== 'undefined'
+  && process.versions != undefined
+  && process.versions.node != undefined;

package/tsconfig.esm.json

@@ -3,7 +3,7 @@
   "compilerOptions": {
     "outDir": "./dist/esm",
     "declarationDir": "./dist/types",
-    "module": "ES6",
+    "module": "esnext",
     "target": "es6",
     "rootDir": "./src",
     "declaration": true,