@ostro/filesystem 1.0.4 → 2.0.0-alpha.2

package/adapter/CoreAdapter.js

@@ -1,85 +1,192 @@
-const path = require('path')
-const url = require('url')
-const { ensureDir } = require('fs-extra')
-const kConfig = Symbol('config')
-const kRootPath = Symbol('rootPath')
-const kRootUrlPath = Symbol('rootUrlPath')
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const url_1 = __importDefault(require("url"));
+const fs_extra_1 = require("fs-extra");
+const kConfig = Symbol('config');
+const kRootPath = Symbol('rootPath');
+const kRootUrlPath = Symbol('rootUrlPath');
+/**
+ * Class CoreAdapter.
+ */
 class CoreAdapter {
+    [kConfig] = null;
+    [kRootPath] = '';
+    [kRootUrlPath] = '';
+    /**
+     * setConfig method.
+     *
+     * @param config - Configuration object.
+     */
     setConfig(config) {
-        this[kConfig] = config
+        this[kConfig] = config;
     }
-
+    /**
+     * getConfig method.
+     *
+     * @returns Configuration object or null.
+     */
     getConfig() {
-        return this[kConfig] || null
+        return this[kConfig] || null;
     }
-
+    /**
+     * setPathPrefix method.
+     *
+     * @param root - Root directory path prefix.
+     */
     setPathPrefix(root) {
-        this[kRootPath] = root
+        this[kRootPath] = root;
     }
-
+    /**
+     * setUrlPrefix method.
+     *
+     * @param root - Root URL prefix.
+     */
     setUrlPrefix(root) {
-        this[kRootUrlPath] = root
-    }
-
+        this[kRootUrlPath] = root;
+    }
+    /**
+     * applyPathPrefix method.
+     *
+     * @param dest - Target path.
+     * @returns Resolved absolute path.
+     */
     applyPathPrefix(dest) {
-        return path.resolve(path.join(this[kRootPath], path.join('/', path.normalize(dest))))
-    }
-
+        return path_1.default.resolve(path_1.default.join(this[kRootPath], path_1.default.join('/', path_1.default.normalize(dest))));
+    }
+    /**
+     * applyUrlPrefix method.
+     *
+     * @param dest - Target path or URL segment.
+     * @returns Resolved URL string.
+     */
     applyUrlPrefix(dest) {
-        return url.resolve(([this[kRootUrlPath], (dest || '')].join('/')), '')
-    }
-
+        return url_1.default.resolve(([this[kRootUrlPath], (dest || '')].join('/')), '');
+    }
+    /**
+     * ensureDirectory method.
+     *
+     * @param dir - Directory path to ensure exists.
+     * @param callback - Completion callback.
+     */
     ensureDirectory(dir, callback) {
-        ensureDir(dir, callback)
-    }
-
+        (0, fs_extra_1.ensureDir)(dir, callback);
+    }
+    /**
+     * parsePath method.
+     *
+     * @param dest - Path to parse.
+     * @returns Parsed path object.
+     */
     parsePath(dest) {
-        return path.parse(dest)
-    }
-
+        return path_1.default.parse(dest);
+    }
+    /**
+     * dirname method.
+     *
+     * @param dest - Path to get directory name of.
+     * @returns Directory path.
+     */
     dirname(dest) {
-        return this.parsePath(dest).dir
-    }
-
+        return this.parsePath(dest).dir;
+    }
+    /**
+     * getContent method.
+     *
+     * @param content - Content or array of contents.
+     * @returns Single content element.
+     */
     getContent(content) {
-        if (Array.isArray(content))
-            return content[0]
-        else
-            return content
+        if (Array.isArray(content)) {
+            return content[0];
+        }
+        else {
+            return content;
+        }
     }
-
+    /**
+     * getBufferData method.
+     *
+     * @param content - Content containing buffer.
+     * @returns Buffer instance.
+     */
     getBufferData(content) {
-        return this.getContent(content).buffer
-    }
+        return this.getContent(content).buffer;
+    }
+    /**
+     * move method.
+     *
+     * @param path - Source path.
+     * @param newpath - Destination path.
+     * @param callback - Result callback.
+     */
     move(path, newpath, callback) {
-        callback(this.formatError({ message: 'there was no such functionality available.' }), {})
-    }
-
+        callback(this.formatError({ message: 'there was no such functionality available.' }), {});
+    }
+    /**
+     * delete method.
+     *
+     * @param $path - Target path.
+     * @param options - Deletion options.
+     * @param callback - Result callback.
+     */
     delete($path, options = {}, callback) {
-        callback(this.formatError({ message: 'there was no such functionality available.' }), {})
-
-    }
-
+        callback(this.formatError({ message: 'there was no such functionality available.' }), {});
+    }
+    /**
+     * has method.
+     *
+     * @param $path - Target path.
+     * @param options - Check options.
+     * @param callback - Result callback.
+     */
     has($path, options = {}, callback) {
-        callback(this.formatError({ message: 'there was no such functionality available.' }), {})
-
-    }
-
+        callback(this.formatError({ message: 'there was no such functionality available.' }), {});
+    }
+    /**
+     * write method.
+     *
+     * @param $path - Target path.
+     * @param $contents - Contents to write.
+     * @param options - Write options.
+     * @param rest - Additional arguments including callback.
+     */
     write($path, $contents, options = {}, ...rest) {
-        callback(this.formatError({ message: 'there was no such functionality available.' }), {})
-
-    }
-
+        const callback = Array.from(rest).find(arg => typeof arg == 'function') || (typeof options == 'function' ? options : () => { });
+        callback(this.formatError({ message: 'there was no such functionality available.' }), {});
+    }
+    /**
+     * read method.
+     *
+     * @param $path - Target path.
+     * @param options - Read options.
+     * @param callback - Result callback.
+     */
     read($path, options = {}, callback) {
-        callback(this.formatError({ message: 'there was no such functionality available.' }), {})
-
-    }
+        callback(this.formatError({ message: 'there was no such functionality available.' }), {});
+    }
+    /**
+     * formatError method.
+     *
+     * @param err - Inner error.
+     * @returns Formatted error object.
+     */
     formatError(err) {
         return {
             'message': 'Storage Error',
             'errors': err,
             'status': 500
-        }
+        };
     }
 }
-module.exports = CoreAdapter
+exports.default = CoreAdapter;
+//# sourceMappingURL=CoreAdapter.js.map
+if (exports.default) {
+    const d = exports.default;
+    module.exports = d;
+    Object.assign(module.exports, exports);
+    module.exports.default = d;
+}

package/adapter/CoreAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CoreAdapter.js","sourceRoot":"","sources":["../../src/adapter/CoreAdapter.ts"],"names":[],"mappings":";;;;;AAAA,gDAAwB;AACxB,8CAAsB;AACtB,uCAAqC;AAErC,MAAM,OAAO,GAAkB,MAAM,CAAC,QAAQ,CAAC,CAAC;AAChD,MAAM,SAAS,GAAkB,MAAM,CAAC,UAAU,CAAC,CAAC;AACpD,MAAM,YAAY,GAAkB,MAAM,CAAC,aAAa,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW;IACb,CAAC,OAAO,CAAC,GAA+B,IAAI,CAAC;IAC7C,CAAC,SAAS,CAAC,GAAW,EAAE,CAAC;IACzB,CAAC,YAAY,CAAC,GAAW,EAAE,CAAC;IAE5B;;;;OAIG;IACI,SAAS,CAAC,MAA2B;QACxC,IAAI,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACI,SAAS;QACZ,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,IAAY;QAC7B,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,IAAY;QAC5B,IAAI,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACI,eAAe,CAAC,IAAY;QAC/B,OAAO,cAAI,CAAC,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,cAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,IAAa;QAC/B,OAAO,aAAG,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,GAAW,EAAE,QAA6B;QACtD,IAAA,oBAAS,EAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,SAAS,CAAC,IAAY;QACzB,OAAO,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,IAAY;QACvB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAc,OAAgB;QAC3C,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACzB,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;QACtB,CAAC;aAAM,CAAC;YACJ,OAAO,OAAO,CAAC;QACnB,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,OAAY;QAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;IAC3C,CAAC;IAED;;;;;;OAMG;IACI,IAAI,CAAC,IAAY,EAAE,OAAY,EAAE,QAAkB;QACtD,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,4CAA4C,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAa,EAAE,UAA+B,EAAE,EAAE,QAAkB;QAC9E,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,4CAA4C,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;OAMG;IACI,GAAG,CAAC,KAAa,EAAE,UAA+B,EAAE,EAAE,QAAkB;QAC3E,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,4CAA4C,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,KAAa,EAAE,SAAc,EAAE,UAA+B,EAAE,EAAE,GAAG,IAAW;QACzF,MAAM,QAAQ,GAAa,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,OAAO,OAAO,IAAI,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACzI,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,4CAA4C,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;OAMG;IACI,IAAI,CAAC,KAAa,EAAE,UAA+B,EAAE,EAAE,QAAkB;QAC5E,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,4CAA4C,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;OAKG;IACI,WAAW,CAAC,GAAY;QAC3B,OAAO;YACH,SAAS,EAAE,eAAe;YAC1B,QAAQ,EAAE,GAAG;YACb,QAAQ,EAAE,GAAG;SAChB,CAAC;IACN,CAAC;CACJ;AAED,kBAAe,WAAW,CAAC"}

package/adapter/azure.js

@@ -1,68 +1,105 @@
-const CoreAdapter = require('./CoreAdapter')
-const kClient = Symbol('client')
-const kHandler = Symbol('handler')
-class Azure extends CoreAdapter {
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const CoreAdapter_1 = __importDefault(require("./CoreAdapter"));
+const kClient = Symbol('client');
+const kHandler = Symbol('handler');
+/**
+ * Class Azure.
+ */
+class Azure extends CoreAdapter_1.default {
+    [kClient];
+    [kHandler];
+    /**
+     * Create a new instance.
+     *
+     * @param $client - Azure client instance.
+     * @param $config - Configuration options.
+     */
     constructor($client, $config) {
-        super()
+        super();
         this[kClient] = $client;
-        this[kHandler] = typeof $config.handler == 'function' ? new $config.handler : typeof $config.handler == 'object' ? $config.handler : {};
-        this.setUrlPrefix(this[kClient].url)
+        this[kHandler] = typeof $config.handler == 'function' ? new $config.handler() : typeof $config.handler == 'object' ? $config.handler : {};
+        this.setUrlPrefix(this[kClient].url);
     }
-
+    /**
+     * read method.
+     *
+     * @param $path - File path to read.
+     * @param options - Read options.
+     * @param callback - Completion callback.
+     */
     read($path, options = {}, callback) {
-        let basePath = this.applyUrlPrefix();
+        const basePath = this.applyUrlPrefix();
         this[kClient].getContainer(options.container).getBlockBlobClient($path).downloadToBuffer()
-            .then(data => ({ error: null, data: data }))
-            .catch(error => Promise.resolve({ error, data: null }))
+            .then((data) => ({ error: null, data: data }))
+            .catch((error) => Promise.resolve({ error, data: null }))
             .then(({ error, data }) => {
-                if (typeof this[kHandler].read == 'function') {
-                    this[kHandler].read({
-                        path: $path,
-                        options,
-                        callback,
-                        error,
-                        basePath,
-                        contents: data
-                    })
-                } else {
-                    callback(error, function() {
-                        return {
-                            'type': 'file',
-                            'path': $path,
-                            'contents': (options.dataType == 'base64') ? data.toString('base64') : data.toString(),
-                        }
-                    }, basePath)
-                }
-            });
+            if (typeof this[kHandler].read == 'function') {
+                this[kHandler].read({
+                    path: $path,
+                    options,
+                    callback,
+                    error,
+                    basePath,
+                    contents: data
+                });
+            }
+            else {
+                callback(error, function () {
+                    return {
+                        'type': 'file',
+                        'path': $path,
+                        'contents': (options.dataType == 'base64') ? data.toString('base64') : data.toString(),
+                    };
+                }, basePath);
+            }
+        });
     }
+    /**
+     * write method.
+     *
+     * @param $path - Destination file path.
+     * @param data - File content to upload.
+     * @param options - Upload options.
+     * @param callback - Completion callback.
+     */
     write($path, data, options = {}, callback) {
-        let basePath = this.applyUrlPrefix();
+        const basePath = this.applyUrlPrefix();
         this[kClient].getContainer(options.container).getBlockBlobClient($path).upload(data, data.length)
-            .then(response => ({ error: null, response }))
-            .catch(error => Promise.resolve({ error, response: null }))
+            .then((response) => ({ error: null, response }))
+            .catch((error) => Promise.resolve({ error, response: null }))
             .then(({ error, response }) => {
-                if (typeof this[kHandler].read == 'function') {
-                    this[kHandler].write({
-                        path: $path,
-                        options,
-                        callback,
-                        error,
-                        basePath,
-                        response,
-                        contents: data
-                    })
-                } else {
-                    callback(error, function() {
-                        return {
-                            'type': 'file',
-                            'path': $path,
-                            'message': 'File uploaded successfully'
-                        }
-                    }, basePath)
-                }
-            });
+            if (typeof this[kHandler].write == 'function') {
+                this[kHandler].write({
+                    path: $path,
+                    options,
+                    callback,
+                    error,
+                    basePath,
+                    response,
+                    contents: data
+                });
+            }
+            else {
+                callback(error, function () {
+                    return {
+                        'type': 'file',
+                        'path': $path,
+                        'message': 'File uploaded successfully'
+                    };
+                }, basePath);
+            }
+        });
     }
-
 }
-module.exports = Azure
+exports.default = Azure;
+//# sourceMappingURL=azure.js.map
+if (exports.default) {
+    const d = exports.default;
+    module.exports = d;
+    Object.assign(module.exports, exports);
+    module.exports.default = d;
+}

package/adapter/azure.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"azure.js","sourceRoot":"","sources":["../../src/adapter/azure.ts"],"names":[],"mappings":";;;;;AAAA,gEAAwC;AAExC,MAAM,OAAO,GAAkB,MAAM,CAAC,QAAQ,CAAC,CAAC;AAChD,MAAM,QAAQ,GAAkB,MAAM,CAAC,SAAS,CAAC,CAAC;AAElD;;GAEG;AACH,MAAM,KAAM,SAAQ,qBAAW;IAC3B,CAAC,OAAO,CAAC,CAAM;IACf,CAAC,QAAQ,CAAC,CAAM;IAEhB;;;;;OAKG;IACH,YAAY,OAAY,EAAE,OAA4B;QAClD,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,QAAQ,CAAC,GAAG,OAAO,OAAO,CAAC,OAAO,IAAI,UAAU,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,OAAO,CAAC,OAAO,IAAI,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1I,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;OAMG;IACI,IAAI,CAAC,KAAa,EAAE,UAA+B,EAAE,EAAE,QAAkB;QAC5E,MAAM,QAAQ,GAAW,IAAI,CAAC,cAAc,EAAE,CAAC;QAC/C,IAAI,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,gBAAgB,EAAE;aACrF,IAAI,CAAC,CAAC,IAAS,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;aAClD,KAAK,CAAC,CAAC,KAAU,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;aAC7D,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAA6B,EAAE,EAAE;YACjD,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,IAAI,UAAU,EAAE,CAAC;gBAC3C,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;oBAChB,IAAI,EAAE,KAAK;oBACX,OAAO;oBACP,QAAQ;oBACR,KAAK;oBACL,QAAQ;oBACR,QAAQ,EAAE,IAAI;iBACjB,CAAC,CAAC;YACP,CAAC;iBAAM,CAAC;gBACJ,QAAQ,CAAC,KAAK,EAAE;oBACZ,OAAO;wBACH,MAAM,EAAE,MAAM;wBACd,MAAM,EAAE,KAAK;wBACb,UAAU,EAAE,CAAC,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE;qBACzF,CAAC;gBACN,CAAC,EAAE,QAAQ,CAAC,CAAC;YACjB,CAAC;QACL,CAAC,CAAC,CAAC;IACX,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,KAAa,EAAE,IAAS,EAAE,UAA+B,EAAE,EAAE,QAAkB;QACxF,MAAM,QAAQ,GAAW,IAAI,CAAC,cAAc,EAAE,CAAC;QAC/C,IAAI,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;aAC5F,IAAI,CAAC,CAAC,QAAa,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;aACpD,KAAK,CAAC,CAAC,KAAU,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;aACjE,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAiC,EAAE,EAAE;YACzD,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,IAAI,UAAU,EAAE,CAAC;gBAC5C,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC;oBACjB,IAAI,EAAE,KAAK;oBACX,OAAO;oBACP,QAAQ;oBACR,KAAK;oBACL,QAAQ;oBACR,QAAQ;oBACR,QAAQ,EAAE,IAAI;iBACjB,CAAC,CAAC;YACP,CAAC;iBAAM,CAAC;gBACJ,QAAQ,CAAC,KAAK,EAAE;oBACZ,OAAO;wBACH,MAAM,EAAE,MAAM;wBACd,MAAM,EAAE,KAAK;wBACb,SAAS,EAAE,4BAA4B;qBAC1C,CAAC;gBACN,CAAC,EAAE,QAAQ,CAAC,CAAC;YACjB,CAAC;QACL,CAAC,CAAC,CAAC;IACX,CAAC;CACJ;AAED,kBAAe,KAAK,CAAC"}