feat: extended onComplete (#101)

kukhariev · Feb 6, 2020 · 719c642 · 719c642
1 parent da10a1d
commit 719c642
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 14 deletions.
diff --git a/examples/express-gcs.ts b/examples/express-gcs.ts
@@ -4,8 +4,13 @@ import { uploadx, GCStorage } from '../src';
 const app = express();
 
 const storage = new GCStorage();
-storage.onComplete = file => console.log('File upload complete: ', file);
-app.use('/upload/files', uploadx({ storage }));
+
+storage.onComplete = file => {
+  (file as any)['custom'] = 'Hi!';
+  console.log('File upload complete: ', file);
+};
+
+app.use('/files', uploadx({ storage }));
 
 app.listen(3003, error => {
   if (error) throw error;

diff --git a/src/storages/disk-storage.ts b/src/storages/disk-storage.ts
@@ -10,13 +10,13 @@ export interface DiskListObject {
   name: string;
   updated: Date;
 }
-export interface DiskStorageOptions extends BaseStorageOptions {
+export type DiskStorageOptions = BaseStorageOptions<DiskFile> & {
   /**
    * Uploads directory
    * @defaultValue './files'
    */
   directory?: string;
-}
+};
 
 /**
  * Local Disk Storage

diff --git a/src/storages/gcs-storage.ts b/src/storages/gcs-storage.ts
@@ -28,7 +28,7 @@ export function buildContentRange(part: FilePart & GCSFile): string {
 const validateStatus: (code: number) => boolean = (code: number) =>
   (code >= 200 && code < 300) || code === 308 || code === 499;
 
-export type GCStorageOptions = BaseStorageOptions &
+export type GCStorageOptions = BaseStorageOptions<GCSFile> &
   GoogleAuthOptions & {
     /**
      * Google Cloud Storage bucket

diff --git a/src/storages/s3-storage.ts b/src/storages/s3-storage.ts
@@ -12,7 +12,7 @@ export class S3File extends File {
   uri?: string;
 }
 
-export type S3StorageOptions = BaseStorageOptions &
+export type S3StorageOptions = BaseStorageOptions<S3File> &
   S3.ClientConfiguration & {
     /**
      * AWS S3 bucket

diff --git a/src/storages/storage.ts b/src/storages/storage.ts
@@ -5,7 +5,9 @@ import { File, FileInit, FilePart } from './file';
 
 export const METAFILE_EXTNAME = '.META';
 
-export interface BaseStorageOptions {
+export type OnComplete<T = File> = (file: Readonly<T>) => any;
+
+export interface BaseStorageOptions<T> {
   /** Allowed file types */
   allowMIME?: string[];
   /** File size limit */
@@ -14,12 +16,12 @@ export interface BaseStorageOptions {
   filename?: (file: Partial<File>) => string;
   useRelativeLocation?: boolean;
   /** Completed callback */
-  onComplete?: (file: File) => void;
+  onComplete?: OnComplete<T>;
   /** Node http base path */
   path?: string;
 }
 
-const defaultOptions: Required<BaseStorageOptions> = {
+const defaultOptions: Required<BaseStorageOptions<any>> = {
   allowMIME: ['*/*'],
   maxUploadSize: '50GB',
   filename: ({ userId, id }: Partial<File>): string => [userId, id].filter(Boolean).join('-'),
@@ -32,13 +34,13 @@ export type Validator = (file: File) => string | false;
 
 export abstract class BaseStorage<TFile, TList> {
   validators: Set<Validator> = new Set();
-  onComplete: (file: File) => void;
+  onComplete: (file: Readonly<TFile>) => void;
   path: string;
   isReady = false;
   protected log = Logger.get(`store:${this.constructor.name}`);
   protected namingFunction: (file: Partial<File>) => string;
-  constructor(public config: BaseStorageOptions) {
-    const opts: Required<BaseStorageOptions> = { ...defaultOptions, ...config };
+  constructor(public config: BaseStorageOptions<TFile>) {
+    const opts: Required<BaseStorageOptions<TFile>> = { ...defaultOptions, ...config };
     this.path = opts.path;
     this.onComplete = opts.onComplete;
     this.namingFunction = opts.filename;

diff --git a/test/fixtures/index.ts b/test/fixtures/index.ts
@@ -1,9 +1,9 @@
-import { BaseStorageOptions } from '../../src';
+import { BaseStorageOptions, File } from '../../src';
 export const userPrefix = 'userId';
 
 export const root = 'files';
 
-export const storageOptions: BaseStorageOptions = {
+export const storageOptions: BaseStorageOptions<File> = {
   filename: file => `${file.userId}/${file.originalName}`,
   maxUploadSize: '6GB',
   allowMIME: ['video/*', 'image/*', 'application/octet-stream'],