@nuvix/storage 0.1.0 → 1.0.0

package/dist/index.d.ts

@@ -61,7 +61,7 @@ declare abstract class Device {
      * Upload file contents to desired destination in the selected disk.
      * return number of chunks uploaded or 0 if it fails.
      */
-    abstract uploadData(data: string, path: string, contentType: string, chunk?: number, chunks?: number, metadata?: DeviceMetadata): Promise<number>;
+    abstract uploadData(data: string | Buffer, path: string, contentType: string, chunk?: number, chunks?: number, metadata?: DeviceMetadata): Promise<number>;
     /**
      * Abort Chunked Upload
      */
@@ -69,7 +69,7 @@ declare abstract class Device {
     /**
      * Read file by given path.
      */
-    abstract read(path: string, offset?: number, length?: number): Promise<string>;
+    abstract read(path: string, offset?: number, length?: number): Promise<Buffer>;
     /**
      * Transfer
      * Transfer a file from current device to destination device.
@@ -78,7 +78,7 @@ declare abstract class Device {
     /**
      * Write file by given path.
      */
-    abstract write(path: string, data: string, contentType: string): Promise<boolean>;
+    abstract write(path: string, data: string | Buffer, contentType: string): Promise<boolean>;
     /**
      * Move file from given source to given path, return true on success and false on failure.
      */
@@ -151,6 +151,7 @@ declare class Storage {
     static readonly DEVICE_LOCAL = "local";
     static readonly DEVICE_S3 = "s3";
     static readonly DEVICE_WASABI = "wasabi";
+    static readonly DEVICE_MINIO = "minio";
     /**
      * Devices.
      *
@@ -196,7 +197,7 @@ declare class Storage {
      * @param system
      * @returns string
      */
-    static human(bytes: number, decimals?: number, system?: 'binary' | 'metric'): string;
+    static human(bytes: number, decimals?: number, system?: "binary" | "metric"): string;
 }
 
 declare abstract class Validator {
@@ -218,22 +219,6 @@ declare class File extends Validator {
      * @return boolean
      */
     isValid(name: any): boolean;
-    /**
-     * Is array
-     *
-     * Function will return true if object is array.
-     *
-     * @return boolean
-     */
-    isArray(): boolean;
-    /**
-     * Get Type
-     *
-     * Returns validator type.
-     *
-     * @return string
-     */
-    getType(): string;
 }
 
 declare class FileExt extends Validator {
@@ -247,8 +232,6 @@ declare class FileExt extends Validator {
     constructor(allowed: string[]);
     getDescription(): string;
     isValid(filename: string): boolean;
-    isArray(): boolean;
-    getType(): string;
     private getFileExtension;
 }
 
@@ -264,22 +247,6 @@ declare class FileName extends Validator {
      * @returns boolean indicating if the filename is valid
      */
     isValid(name: any): boolean;
-    /**
-     * Is array
-     *
-     * Function will return true if object is array.
-     *
-     * @returns boolean
-     */
-    isArray(): boolean;
-    /**
-     * Get Type
-     *
-     * Returns validator type.
-     *
-     * @returns string
-     */
-    getType(): string;
 }
 
 declare class FileSize extends Validator {
@@ -296,18 +263,6 @@ declare class FileSize extends Validator {
      * Finds whether a file size is smaller than required limit.
      */
     isValid(fileSize: any): boolean;
-    /**
-     * Is array
-     *
-     * Function will return true if object is array.
-     */
-    isArray(): boolean;
-    /**
-     * Get Type
-     *
-     * Returns validator type.
-     */
-    getType(): string;
 }
 
 declare class FileType extends Validator {
@@ -334,14 +289,6 @@ declare class FileType extends Validator {
      * Binary check to finds whether a file is of valid type
      */
     isValid(path: string): Promise<boolean>;
-    /**
-     * Is array
-     */
-    isArray(): boolean;
-    /**
-     * Get Type
-     */
-    getType(): string;
 }
 
 declare class Upload extends Validator {
@@ -356,22 +303,6 @@ declare class Upload extends Validator {
      * @returns Promise that resolves to true if valid upload file, false otherwise
      */
     isValid(path: unknown): Promise<boolean>;
-    /**
-     * Is array
-     *
-     * Function will return true if object is array.
-     *
-     * @returns false - this validator doesn't handle arrays
-     */
-    isArray(): boolean;
-    /**
-     * Get Type
-     *
-     * Returns validator type.
-     *
-     * @returns The validator type
-     */
-    getType(): string;
 }
 
 declare class Local extends Device {
@@ -384,12 +315,12 @@ declare class Local extends Device {
     getRoot(): string;
     getPath(filename: string, prefix?: string): string;
     upload(source: string, filePath: string, chunk?: number, chunks?: number, metadata?: Record<string, any>): Promise<number>;
-    uploadData(data: string, filePath: string, contentType: string, chunk?: number, chunks?: number, metadata?: Record<string, any>): Promise<number>;
+    uploadData(data: string | Buffer, filePath: string, contentType: string, chunk?: number, chunks?: number, metadata?: Record<string, any>): Promise<number>;
     private joinChunks;
     transfer(filePath: string, destination: string, device: Device): Promise<boolean>;
     abort(filePath: string, extra?: string): Promise<boolean>;
-    read(filePath: string, offset?: number, length?: number): Promise<string>;
-    write(filePath: string, data: string, contentType?: string): Promise<boolean>;
+    read(filePath: string, offset?: number, length?: number): Promise<Buffer>;
+    write(filePath: string, data: string | Buffer, contentType?: string): Promise<boolean>;
     move(source: string, target: string): Promise<boolean>;
     delete(filePath: string, recursive?: boolean): Promise<boolean>;
     deletePath(filePath: string): Promise<boolean>;
@@ -465,14 +396,14 @@ declare class S3 extends Device {
     static setRetryAttempts(attempts: number): void;
     static setRetryDelay(delay: number): void;
     upload(source: string | Buffer, path: string, chunk?: number, chunks?: number, metadata?: Record<string, any>): Promise<number>;
-    uploadData(data: string, path: string, contentType: string, chunk?: number, chunks?: number, metadata?: Record<string, any>): Promise<number>;
+    uploadData(data: Buffer, path: string, contentType: string, chunk?: number, chunks?: number, metadata?: Record<string, any>): Promise<number>;
     transfer(path: string, destination: string, device: Device): Promise<boolean>;
     protected createMultipartUpload(path: string, contentType: string): Promise<string>;
-    protected uploadPart(data: string, path: string, contentType: string, chunk: number, uploadId: string): Promise<string>;
+    protected uploadPart(data: Buffer, path: string, contentType: string, chunk: number, uploadId: string): Promise<string>;
     protected completeMultipartUpload(path: string, uploadId: string, parts: Record<number, string>): Promise<boolean>;
     abort(path: string, extra?: string): Promise<boolean>;
-    read(path: string, offset?: number, length?: number): Promise<string>;
-    write(path: string, data: string, contentType?: string): Promise<boolean>;
+    read(path: string, offset?: number, length?: number): Promise<Buffer>;
+    write(path: string, data: Buffer, contentType?: string): Promise<boolean>;
     delete(path: string, recursive?: boolean): Promise<boolean>;
     protected listObjects(prefix?: string, maxKeys?: number, continuationToken?: string): Promise<any>;
     deletePath(path: string): Promise<boolean>;
@@ -485,11 +416,16 @@ declare class S3 extends Device {
     getPartitionFreeSpace(): Promise<number>;
     getFiles(dir: string, max?: number, continuationToken?: string): Promise<any>;
     private getInfo;
-    private getSignatureV4;
-    protected call(method: string, uri: string, data?: string, parameters?: Record<string, string>, decode?: boolean): Promise<any>;
-    private md5;
-    private sha256;
-    private hmacSha256;
+    protected getSignatureV4(method: string, uri: string, parameters?: Record<string, string>): string;
+    protected call(method: string, uri: string, data?: string | Buffer, parameters?: Record<string, string>, decode?: boolean): Promise<{
+        body: any;
+        buffer: ArrayBuffer;
+        headers: Record<string, string>;
+        code: number;
+    }>;
+    protected md5(data: string | Buffer): Buffer;
+    protected sha256(data: string | Buffer): string;
+    protected hmacSha256(data: string | Buffer, key: string | Buffer, encoding?: "hex" | "binary"): string | Buffer;
 }
 
 declare class Wasabi extends S3 {
@@ -515,5 +451,20 @@ declare class Wasabi extends S3 {
     getType(): string;
 }
 
-export { Device, File, FileExt, FileName, FileSize, FileType, Local, S3, Storage, Upload, Wasabi };
+declare class MinIO extends S3 {
+    /**
+     * MinIO Constructor
+     */
+    constructor(root: string, accessKey: string, secretKey: string, bucket: string, endpoint?: string, acl?: string, useSSL?: boolean);
+    private endpointUrl;
+    getName(): string;
+    getDescription(): string;
+    getType(): string;
+    /**
+     * Override the call method to use the custom endpoint
+     */
+    protected call(method: string, uri: string, data?: string | Buffer, parameters?: Record<string, string>, decode?: boolean): Promise<any>;
+}
+
+export { Device, File, FileExt, FileName, FileSize, FileType, Local, MinIO, S3, Storage, Upload, Wasabi };
 export type { DeviceMetadata };

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC"}