@ostro/filesystem 1.0.3 → 2.0.0-alpha.1

package/fileUploadException.js

@@ -1,13 +1,36 @@
-const FileUploadExceptionContract = require('@ostro/contracts/filesystem/fileUploadException')
-class FileUploadException extends FileUploadExceptionContract {
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fileUploadException_1 = __importDefault(require("@ostro/contracts/filesystem/fileUploadException"));
+/**
+ * Class FileUploadException.
+ */
+class FileUploadException extends fileUploadException_1.default {
+    name;
+    message;
+    errors;
+    statusCode;
+    /**
+     * Create a new instance.
+     *
+     * @param errors - Error details or message.
+     */
     constructor(errors) {
         super();
         this.name = this.constructor.name;
         this.message = 'Error in upload file';
-        this.errors = errors
+        this.errors = errors;
         this.statusCode = 500;
         Error.captureStackTrace(this, this.constructor);
-
     }
 }
-module.exports = FileUploadException
+exports.default = FileUploadException;
+//# sourceMappingURL=fileUploadException.js.map
+if (exports.default) {
+    const d = exports.default;
+    module.exports = d;
+    Object.assign(module.exports, exports);
+    module.exports.default = d;
+}

package/fileUploadException.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileUploadException.js","sourceRoot":"","sources":["../src/fileUploadException.ts"],"names":[],"mappings":";;;;;AAAA,0GAA0F;AAE1F;;GAEG;AACH,MAAM,mBAAoB,SAAQ,6BAA2B;IAClD,IAAI,CAAS;IACb,OAAO,CAAS;IAChB,MAAM,CAAU;IAChB,UAAU,CAAS;IAE1B;;;;OAIG;IACH,YAAY,MAAe;QACvB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAClC,IAAI,CAAC,OAAO,GAAG,sBAAsB,CAAC;QACtC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QACtB,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACpD,CAAC;CACJ;AAED,kBAAe,mBAAmB,CAAC"}

package/filesystem.d.ts

@@ -0,0 +1,300 @@
+import type { IFilesystem } from '@ostro/contracts/filesystem/filesystem';
+import FilesystemContract from '@ostro/contracts/filesystem/filesystem';
+/**
+ * Class Filesystem.
+ */
+declare class Filesystem extends FilesystemContract implements IFilesystem {
+    /**
+     * exists method.
+     *
+     * @param $path - File path to check.
+     * @returns Promise resolving to boolean.
+     */
+    exists($path: string): Promise<boolean>;
+    /**
+     * missing method.
+     *
+     * @param $path - File path to check.
+     * @returns Promise resolving to boolean.
+     */
+    missing($path: string): Promise<boolean>;
+    /**
+     * get method.
+     *
+     * @param $path - File path to read.
+     * @returns Promise resolving to file content string.
+     */
+    get($path: string): Promise<string>;
+    /**
+     * put method.
+     *
+     * @param $path - File path to write.
+     * @param $contents - Contents to write.
+     * @returns Promise resolving on completion.
+     */
+    put($path: string, $contents: any): Promise<void>;
+    /**
+     * replaceInFile method.
+     *
+     * @param $search - Search string or RegExp.
+     * @param $replace - Replacement string.
+     * @param $path - File path.
+     * @returns Promise resolving on completion.
+     */
+    replaceInFile($search: any, $replace: any, $path: string): Promise<void>;
+    /**
+     * prepend method.
+     *
+     * @param $path - File path.
+     * @param $data - Data to prepend.
+     * @returns Promise resolving on completion.
+     */
+    prepend($path: string, $data: any): Promise<void>;
+    /**
+     * append method.
+     *
+     * @param $path - File path.
+     * @param $data - Data to append.
+     * @returns Promise resolving on completion.
+     */
+    append($path: string, $data: any): Promise<void>;
+    /**
+     * chmod method.
+     *
+     * @param $path - File path.
+     * @param $mode - Mode number.
+     * @returns Promise resolving to mode or void.
+     */
+    chmod($path: string, $mode?: any): Promise<any>;
+    /**
+     * delete method.
+     *
+     * @param $paths - Path or array of paths to delete.
+     * @returns Promise resolving to boolean success.
+     */
+    delete($paths: any): Promise<boolean>;
+    /**
+     * move method.
+     *
+     * @param $path - Source path.
+     * @param $target - Destination path.
+     * @returns Promise resolving on completion.
+     */
+    move($path: string, $target: any): Promise<void>;
+    /**
+     * copy method.
+     *
+     * @param $path - Source path.
+     * @param $target - Destination path.
+     * @returns Promise resolving on completion.
+     */
+    copy($path: string, $target: any): Promise<void>;
+    /**
+     * link method.
+     *
+     * @param $target - Target path.
+     * @param $link - Symlink path.
+     * @param $force - Force flag.
+     * @returns Promise resolving on completion.
+     */
+    link($target: any, $link: any, $force?: boolean): Promise<void>;
+    /**
+     * relativeLink method.
+     *
+     * @param $target - Target path.
+     * @param $link - Symlink path.
+     * @param $force - Force flag.
+     * @returns Promise resolving on completion.
+     */
+    relativeLink($target: any, $link: any, $force?: boolean): Promise<void>;
+    /**
+     * name method.
+     *
+     * @param $path - File path.
+     * @returns File name without extension.
+     */
+    name($path: string): string;
+    /**
+     * basename method.
+     *
+     * @param $path - File path.
+     * @returns Base filename with extension.
+     */
+    basename($path: string): string;
+    /**
+     * dirname method.
+     *
+     * @param $path - File path.
+     * @returns Directory path.
+     */
+    dirname($path: string): string;
+    /**
+     * extension method.
+     *
+     * @param $path - File path.
+     * @returns File extension without leading dot.
+     */
+    extension($path: string): string;
+    /**
+     * guessExtension method.
+     *
+     * @param $path - File path.
+     * @returns Extension with dot.
+     */
+    guessExtension($path: string): string;
+    /**
+     * type method.
+     *
+     * @param $path - Path to check.
+     * @returns 'dir' or 'file'.
+     */
+    type($path: string): Promise<string>;
+    /**
+     * mimeType method.
+     *
+     * @param $path - File path.
+     * @returns Extension as mime identifier.
+     */
+    mimeType($path: string): string;
+    /**
+     * size method.
+     *
+     * @param $path - File path.
+     * @returns Size in bytes.
+     */
+    size($path: string): Promise<number>;
+    /**
+     * lastModified method.
+     *
+     * @param $path - File path.
+     * @returns Last modified timestamp in seconds.
+     */
+    lastModified($path: string): Promise<number>;
+    /**
+     * isDirectory method.
+     *
+     * @param $directory - Directory path.
+     * @returns Boolean indicating if directory.
+     */
+    isDirectory($directory: any): Promise<boolean>;
+    /**
+     * isReadable method.
+     *
+     * @param $path - Path to check.
+     * @returns Boolean indicating if readable.
+     */
+    isReadable($path: string): Promise<boolean>;
+    /**
+     * isWritable method.
+     *
+     * @param $path - Path to check.
+     * @returns Boolean indicating if writable.
+     */
+    isWritable($path: string): Promise<boolean>;
+    /**
+     * isFile method.
+     *
+     * @param $file - Path to check.
+     * @returns Boolean indicating if regular file.
+     */
+    isFile($file: any): Promise<boolean>;
+    /**
+     * glob method.
+     *
+     * @param $pattern - Pattern to match.
+     * @returns Matching file paths.
+     */
+    glob($pattern: string): Promise<string[]>;
+    /**
+     * requireOnce method.
+     *
+     * @param $path - Module path to require.
+     * @param $data - Additional data.
+     * @returns Required module export.
+     */
+    requireOnce($path: string, $data?: any[]): Promise<any>;
+    /**
+     * files method.
+     *
+     * @param $directory - Directory path.
+     * @param $hidden - Whether to ignore hidden.
+     * @returns List of file paths.
+     */
+    files($directory: any, $hidden?: boolean): Promise<string[]>;
+    /**
+     * allFiles method.
+     *
+     * @param $directory - Directory path.
+     * @param $hidden - Whether to ignore hidden.
+     * @returns List of all recursive file paths.
+     */
+    allFiles($directory: any, $hidden?: boolean): Promise<string[]>;
+    /**
+     * directories method.
+     *
+     * @param $directory - Directory path.
+     * @returns List of directories.
+     */
+    directories($directory: any): Promise<string[]>;
+    /**
+     * ensureDirectoryExists method.
+     *
+     * @param $path - Directory path.
+     * @param $mode - Directory mode permissions.
+     * @param $recursive - Recursive creation flag.
+     * @returns Boolean success.
+     */
+    ensureDirectoryExists($path: string, $mode?: any, $recursive?: boolean): Promise<boolean>;
+    /**
+     * makeDirectory method.
+     *
+     * @param $path - Directory path.
+     * @param $mode - Permissions mode.
+     * @param $recursive - Recursive flag.
+     * @param $force - Force flag.
+     * @returns Result of mkdir.
+     */
+    makeDirectory($path: string, $mode?: any, $recursive?: boolean, $force?: boolean): Promise<any>;
+    /**
+     * moveDirectory method.
+     *
+     * @param $from - Source directory.
+     * @param $to - Destination directory.
+     * @param $overwrite - Overwrite flag.
+     * @returns Boolean success.
+     */
+    moveDirectory($from: any, $to: any, $overwrite?: boolean): Promise<boolean>;
+    /**
+     * copyDirectory method.
+     *
+     * @param $directory - Source directory.
+     * @param $destination - Destination directory.
+     * @param $options - Copy options.
+     * @returns Boolean success.
+     */
+    copyDirectory($directory: any, $destination: any, $options?: Record<string, any>): Promise<boolean>;
+    /**
+     * deleteDirectory method.
+     *
+     * @param $directory - Directory path.
+     * @param $preserve - Preserve directory flag.
+     * @returns Boolean success.
+     */
+    deleteDirectory($directory: any, $preserve?: boolean): Promise<boolean>;
+    /**
+     * deleteDirectories method.
+     *
+     * @param $directory - Directory path.
+     * @returns Boolean success.
+     */
+    deleteDirectories($directory: any): Promise<boolean>;
+    /**
+     * cleanDirectory method.
+     *
+     * @param $directory - Directory path.
+     * @returns Boolean success.
+     */
+    cleanDirectory($directory: any): Promise<boolean>;
+}
+export default Filesystem;
+//# sourceMappingURL=filesystem.d.ts.map

package/filesystem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filesystem.d.ts","sourceRoot":"","sources":["../src/filesystem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAC;AAC1E,OAAO,kBAAkB,MAAM,wCAAwC,CAAC;AASxE;;GAEG;AACH,cAAM,UAAW,SAAQ,kBAAmB,YAAW,WAAW;IAE9D;;;;;OAKG;IACI,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI9C;;;;;OAKG;IACU,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIrD;;;;;OAKG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAMnC;;;;;;OAMG;IACI,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxD;;;;;;;OAOG;IACI,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/E;;;;;;OAMG;IACU,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ9D;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvD;;;;;;OAMG;IACI,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,GAAU,GAAG,OAAO,CAAC,GAAG,CAAC;IAS5D;;;;;OAKG;IACU,MAAM,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAgBlD;;;;;;OAMG;IACI,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvD;;;;;;OAMG;IACI,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvD;;;;;;;OAOG;IACI,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7E;;;;;;;OAOG;IACI,YAAY,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAKrF;;;;;OAKG;IACI,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAIlC;;;;;OAKG;IACI,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAItC;;;;;OAKG;IACI,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAIrC;;;;;OAKG;IACI,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAIvC;;;;;OAKG;IACI,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAI5C;;;;;OAKG;IACI,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI3C;;;;;OAKG;IACI,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAItC;;;;;OAKG;IACI,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI3C;;;;;OAKG;IACI,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAInD;;;;;OAKG;IACI,WAAW,CAAC,UAAU,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAIrD;;;;;OAKG;IACI,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlD;;;;;OAKG;IACI,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIlD;;;;;OAKG;IACI,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAI3C;;;;;OAKG;IACU,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAatD;;;;;;OAMG;IACI,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,GAAG,EAAO,GAAG,OAAO,CAAC,GAAG,CAAC;IAUlE;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,EAAE,GAAG,EAAE,OAAO,GAAE,OAAe,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAQ1E;;;;;;OAMG;IACI,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE,OAAO,GAAE,OAAe,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAQ7E;;;;;OAKG;IACI,WAAW,CAAC,UAAU,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAItD;;;;;;;OAOG;IACI,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,GAAW,EAAE,UAAU,GAAE,OAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAI7G;;;;;;;;OAQG;IACI,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,GAAE,GAAW,EAAE,UAAU,GAAE,OAAe,EAAE,MAAM,GAAE,OAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IAO3H;;;;;;;OAOG;IACU,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,UAAU,GAAE,OAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAa/F;;;;;;;OAOG;IACU,aAAa,CAAC,UAAU,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,EAAE,QAAQ,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAepH;;;;;;OAMG;IACU,eAAe,CAAC,UAAU,EAAE,GAAG,EAAE,SAAS,GAAE,OAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAc3F;;;;;OAKG;IACU,iBAAiB,CAAC,UAAU,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAcjE;;;;;OAKG;IACI,cAAc,CAAC,UAAU,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;CAG3D;AAED,eAAe,UAAU,CAAC"}