@windwalker-io/unicorn-next 0.1.0 → 0.1.1

package/src/module/s3-uploader.ts

@@ -1,234 +1,234 @@
-import { useHttpClient } from '../composable';
-import { data } from '../data';
-import { EventAwareInterface, EventHandler, EventMixin } from '../events';
-import type { UnicornHttpClient } from './http-client';
-import { mergeDeep } from '../utilities';
-import { AxiosProgressEvent, AxiosResponse } from 'axios';
-import { Mixin } from 'ts-mixer';
-
-const instances: Record<string, S3Uploader> = {};
-export function get(name: string, options?: Partial<S3UploaderGlobalOptions>): S3Uploader;
-export function get(
-  name: string,
-  options: Partial<S3UploaderGlobalOptions> = {}
-): S3Uploader | void {
-  return instances[name] ??= create(name, options);
-}
-
-export function create(name: string, options: Partial<S3UploaderGlobalOptions> = {}): S3Uploader {
-  return new S3Uploader(name, options);
-}
-
-export function destroy(name: string) {
-  delete instances[name];
-}
-
-const defaultOptions: S3UploaderGlobalOptions = {
-  endpoint: '',
-  subfolder: '',
-  viewerHost: '',
-  starts_with: [],
-  formInputs: {
-    acl: '',
-    bucket: '',
-    key: '',
-    Policy: '',
-    'X-Amz-Algorithm': '',
-    'X-Amz-Credential': '',
-    'X-Amz-Date': '',
-    'X-Amz-Signature': '',
-  }
-};
-
-export class S3Uploader extends Mixin(EventMixin) implements EventAwareInterface {
-  options: S3UploaderGlobalOptions;
-  http?: UnicornHttpClient;
-
-  constructor(protected name: string, options: Partial<S3UploaderGlobalOptions> = {}) {
-    super();
-
-    const awsOptions = data('@s3.uploader.' + name) || {};
-
-    this.options = mergeDeep<S3UploaderGlobalOptions>({}, defaultOptions, awsOptions, options);
-  }
-
-  async getHttpClient() {
-    return this.http ??= await useHttpClient();
-  }
-
-  /**
-   * Do upload.
-   */
-  async upload(
-    file: string | File | Blob,
-    path: string,
-    options: Partial<S3UploaderRequestOptions> = {}
-  ): Promise<S3UploaderResponse> {
-    const httpClient = await this.getHttpClient();
-
-    const fileData = new FormData();
-    const inputs = mergeDeep({}, this.options.formInputs, options.formInputs || {});
-
-    if (typeof file === 'string') {
-      file = new Blob([file], { type: options['Content-Type'] || 'text/plain' });
-    }
-
-    if (file instanceof Blob && path.endsWith('.{ext}')) {
-      throw new Error('If using Blob or file data string, you must provide a valid file extension in the path.');
-    }
-
-    if ((file instanceof Blob) || (file as any) instanceof File) {
-      options['Content-Type'] = options['Content-Type'] || file.type;
-    }
-
-    if (options['filename']) {
-      const filename = this.replaceExt(options['filename'], file);
-      options['Content-Disposition'] = 'attachment; filename*=UTF-8\'\'' + encodeURIComponent(filename);
-    }
-
-    path = this.replaceExt(path, file);
-
-    options['key'] = trimSlashes(this.options.subfolder || '') + '/'
-      + trimSlashes(path);
-    options['key'] = trimSlashes(options['key']);
-    options['Content-Type'] = options['Content-Type'] || undefined;
-    options['Content-Disposition'] = options['Content-Disposition'] || undefined;
-
-    // Prepare pre-signed data
-    for (let key in inputs) {
-      fileData.set(key, inputs[key]);
-    }
-
-    // Prepare custom data
-    for (let key of Object.keys(this.options.starts_with)) {
-      if (options[key]) {
-        fileData.set(key, options[key]);
-      }
-    }
-
-    fileData.append('file', file);
-
-    this.trigger('start', fileData);
-
-    try {
-      let res = await httpClient.post(
-        this.options.endpoint || '',
-        fileData,
-        {
-          onUploadProgress: (e) => {
-            if (options.onUploadProgress) {
-              options.onUploadProgress(e);
-            }
-
-            this.trigger('upload-progress', e);
-
-            if (e.total != null) {
-              this.trigger('progress', e.loaded / e.total, e);
-            }
-          }
-        }
-      ) as S3UploaderResponse;
-
-      const url = this.options.viewerHost + '/'
-        + trimSlashes(path);
-
-      this.trigger('success', url, res);
-
-      res.url = url;
-
-      return res;
-    } finally {
-      this.trigger('end');
-    }
-  }
-
-  replaceExt(path: string, file: File | Blob): string {
-    if (file instanceof File) {
-      const fileExt = file.name.split('.').pop();
-
-      if (path.endsWith('.{ext}')) {
-        return path.replace(/\.{ext}$/, fileExt ? '.' + fileExt : '');
-      }
-    }
-
-    return path;
-  }
-
-  on(event: 'start', handler: StartEventHandler): this;
-  on(event: 'success', handler: SuccessEventHandler): this;
-  on(event: 'end', handler: EndEventHandler): this;
-  on(event: 'upload-progress', handler: UploadProgressEventHandler): this;
-  on(event: 'progress', handler: ProgressEventHandler): this;
-  on(event: string | string[], handler: EventHandler): this {
-    return super.on(event, handler);
-  }
-
-  onStart(handler: StartEventHandler): this {
-    return this.on('start', handler);
-  }
-
-  onSuccess(handler: SuccessEventHandler): this {
-    return this.on('success', handler);
-  }
-
-  onEnd(handler: EndEventHandler): this {
-    return this.on('end', handler);
-  }
-
-  onProgress(handler: UploadProgressEventHandler): this {
-    return this.on('upload-progress', handler);
-  }
-
-  onProgressWithTotal(handler: ProgressEventHandler): this {
-    return this.on('progress', handler);
-  }
-}
-
-type EndEventHandler = () => void;
-type SuccessEventHandler = (url: string, res: S3UploaderResponse) => void;
-type StartEventHandler = (fileData: FormData) => void;
-type UploadProgressEventHandler = (e: AxiosProgressEvent) => void;
-type ProgressEventHandler = (total: number, e: AxiosProgressEvent) => void;
-
-function trimSlashes(str: string) {
-  return str.replace(/^\/+|\/+$/g, '');
-}
-
-export interface S3UploaderResponse extends AxiosResponse {
-  url: string;
-}
-
-export interface S3UploaderGlobalOptions {
-  endpoint?: string;
-  subfolder?: string;
-  viewerHost?: string;
-  starts_with: any[];
-  formInputs?: {
-    acl: string;
-    bucket: string;
-    key: string;
-    Policy: string;
-    'X-Amz-Algorithm': string;
-    'X-Amz-Credential': string;
-    'X-Amz-Date': string;
-    'X-Amz-Signature': string;
-    [name: string]: any
-  },
-}
-
-export interface S3UploaderRequestOptions {
-  formInputs?: { [name: string]: any };
-  onUploadProgress?: (e: AxiosProgressEvent) => void;
-  'Content-Type'?: string;
-  'Content-Disposition'?: string;
-  key?: string;
-
-  [name: string]: any;
-}
-
-export interface S3UploaderModule {
-  get(name: string, options?: Partial<S3UploaderGlobalOptions>): S3Uploader;
-  create(name: string, options?: Partial<S3UploaderGlobalOptions>): S3Uploader;
-  destroy(name: string): void;
-  S3Uploader: typeof S3Uploader;
-}
+import { useHttpClient } from '../composable';
+import { data } from '../data';
+import { EventAwareInterface, EventHandler, EventMixin } from '../events';
+import type { UnicornHttpClient } from './http-client';
+import { mergeDeep } from '../utilities';
+import { AxiosProgressEvent, AxiosResponse } from 'axios';
+import { Mixin } from 'ts-mixer';
+
+const instances: Record<string, S3Uploader> = {};
+export function get(name: string, options?: Partial<S3UploaderGlobalOptions>): S3Uploader;
+export function get(
+  name: string,
+  options: Partial<S3UploaderGlobalOptions> = {}
+): S3Uploader | void {
+  return instances[name] ??= create(name, options);
+}
+
+export function create(name: string, options: Partial<S3UploaderGlobalOptions> = {}): S3Uploader {
+  return new S3Uploader(name, options);
+}
+
+export function destroy(name: string) {
+  delete instances[name];
+}
+
+const defaultOptions: S3UploaderGlobalOptions = {
+  endpoint: '',
+  subfolder: '',
+  viewerHost: '',
+  starts_with: [],
+  formInputs: {
+    acl: '',
+    bucket: '',
+    key: '',
+    Policy: '',
+    'X-Amz-Algorithm': '',
+    'X-Amz-Credential': '',
+    'X-Amz-Date': '',
+    'X-Amz-Signature': '',
+  }
+};
+
+export class S3Uploader extends Mixin(EventMixin) implements EventAwareInterface {
+  options: S3UploaderGlobalOptions;
+  http?: UnicornHttpClient;
+
+  constructor(protected name: string, options: Partial<S3UploaderGlobalOptions> = {}) {
+    super();
+
+    const awsOptions = data('@s3.uploader.' + name) || {};
+
+    this.options = mergeDeep<S3UploaderGlobalOptions>({}, defaultOptions, awsOptions, options);
+  }
+
+  async getHttpClient() {
+    return this.http ??= await useHttpClient();
+  }
+
+  /**
+   * Do upload.
+   */
+  async upload(
+    file: string | File | Blob,
+    path: string,
+    options: Partial<S3UploaderRequestOptions> = {}
+  ): Promise<S3UploaderResponse> {
+    const httpClient = await this.getHttpClient();
+
+    const fileData = new FormData();
+    const inputs = mergeDeep({}, this.options.formInputs, options.formInputs || {});
+
+    if (typeof file === 'string') {
+      file = new Blob([file], { type: options['Content-Type'] || 'text/plain' });
+    }
+
+    if (file instanceof Blob && path.endsWith('.{ext}')) {
+      throw new Error('If using Blob or file data string, you must provide a valid file extension in the path.');
+    }
+
+    if ((file instanceof Blob) || (file as any) instanceof File) {
+      options['Content-Type'] = options['Content-Type'] || file.type;
+    }
+
+    if (options['filename']) {
+      const filename = this.replaceExt(options['filename'], file);
+      options['Content-Disposition'] = 'attachment; filename*=UTF-8\'\'' + encodeURIComponent(filename);
+    }
+
+    path = this.replaceExt(path, file);
+
+    options['key'] = trimSlashes(this.options.subfolder || '') + '/'
+      + trimSlashes(path);
+    options['key'] = trimSlashes(options['key']);
+    options['Content-Type'] = options['Content-Type'] || undefined;
+    options['Content-Disposition'] = options['Content-Disposition'] || undefined;
+
+    // Prepare pre-signed data
+    for (let key in inputs) {
+      fileData.set(key, inputs[key]);
+    }
+
+    // Prepare custom data
+    for (let key of Object.keys(this.options.starts_with)) {
+      if (options[key]) {
+        fileData.set(key, options[key]);
+      }
+    }
+
+    fileData.append('file', file);
+
+    this.trigger('start', fileData);
+
+    try {
+      let res = await httpClient.post(
+        this.options.endpoint || '',
+        fileData,
+        {
+          onUploadProgress: (e) => {
+            if (options.onUploadProgress) {
+              options.onUploadProgress(e);
+            }
+
+            this.trigger('upload-progress', e);
+
+            if (e.total != null) {
+              this.trigger('progress', e.loaded / e.total, e);
+            }
+          }
+        }
+      ) as S3UploaderResponse;
+
+      const url = this.options.viewerHost + '/'
+        + trimSlashes(path);
+
+      this.trigger('success', url, res);
+
+      res.url = url;
+
+      return res;
+    } finally {
+      this.trigger('end');
+    }
+  }
+
+  replaceExt(path: string, file: File | Blob): string {
+    if (file instanceof File) {
+      const fileExt = file.name.split('.').pop();
+
+      if (path.endsWith('.{ext}')) {
+        return path.replace(/\.{ext}$/, fileExt ? '.' + fileExt : '');
+      }
+    }
+
+    return path;
+  }
+
+  on(event: 'start', handler: StartEventHandler): this;
+  on(event: 'success', handler: SuccessEventHandler): this;
+  on(event: 'end', handler: EndEventHandler): this;
+  on(event: 'upload-progress', handler: UploadProgressEventHandler): this;
+  on(event: 'progress', handler: ProgressEventHandler): this;
+  on(event: string | string[], handler: EventHandler): this {
+    return super.on(event, handler);
+  }
+
+  onStart(handler: StartEventHandler): this {
+    return this.on('start', handler);
+  }
+
+  onSuccess(handler: SuccessEventHandler): this {
+    return this.on('success', handler);
+  }
+
+  onEnd(handler: EndEventHandler): this {
+    return this.on('end', handler);
+  }
+
+  onProgress(handler: UploadProgressEventHandler): this {
+    return this.on('upload-progress', handler);
+  }
+
+  onProgressWithTotal(handler: ProgressEventHandler): this {
+    return this.on('progress', handler);
+  }
+}
+
+type EndEventHandler = () => void;
+type SuccessEventHandler = (url: string, res: S3UploaderResponse) => void;
+type StartEventHandler = (fileData: FormData) => void;
+type UploadProgressEventHandler = (e: AxiosProgressEvent) => void;
+type ProgressEventHandler = (total: number, e: AxiosProgressEvent) => void;
+
+function trimSlashes(str: string) {
+  return str.replace(/^\/+|\/+$/g, '');
+}
+
+export interface S3UploaderResponse extends AxiosResponse {
+  url: string;
+}
+
+export interface S3UploaderGlobalOptions {
+  endpoint?: string;
+  subfolder?: string;
+  viewerHost?: string;
+  starts_with: any[];
+  formInputs?: {
+    acl: string;
+    bucket: string;
+    key: string;
+    Policy: string;
+    'X-Amz-Algorithm': string;
+    'X-Amz-Credential': string;
+    'X-Amz-Date': string;
+    'X-Amz-Signature': string;
+    [name: string]: any
+  },
+}
+
+export interface S3UploaderRequestOptions {
+  formInputs?: { [name: string]: any };
+  onUploadProgress?: (e: AxiosProgressEvent) => void;
+  'Content-Type'?: string;
+  'Content-Disposition'?: string;
+  key?: string;
+
+  [name: string]: any;
+}
+
+export interface S3UploaderModule {
+  get(name: string, options?: Partial<S3UploaderGlobalOptions>): S3Uploader;
+  create(name: string, options?: Partial<S3UploaderGlobalOptions>): S3Uploader;
+  destroy(name: string): void;
+  S3Uploader: typeof S3Uploader;
+}