@arkstack/filesystem 0.3.8 → 0.3.9

package/dist/index.js

@@ -1,7 +1,7 @@
 import { t as FtpDriver } from "./FtpDriver-CfUSZ1xr.js";
 import { DriveManager } from "flydrive";
 import { appUrl, config } from "@arkstack/common";
-import { existsSync, rmSync, symlinkSync } from "node:fs";
+import { rmSync, symlinkSync } from "node:fs";
 import { FSDriver } from "flydrive/drivers/fs";
 import path from "node:path";
 import { Logger } from "@h3ravel/shared";
@@ -213,7 +213,10 @@ var Storage = class Storage {
 			const unlink = link.replace(process.cwd(), "");
 			const untarget = target.replace(process.cwd(), "");
 			try {
-				if (force && existsSync(link)) rmSync(link, { recursive: true });
+				if (force) rmSync(link, {
+					recursive: true,
+					force: true
+				});
 				symlinkSync(target, link);
 				Logger.log([
 					[" SUCCESS ", "bgGreen"],

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { DriveDirectory, DriveFile, DriveManager } from 'flydrive'\nimport { DriverContract, ObjectMetaData, ObjectVisibility, SignedURLOptions, WriteOptions } from 'flydrive/types'\nimport { appUrl, config } from '@arkstack/common'\nimport { existsSync, rmSync, symlinkSync } from 'node:fs'\n\nimport { FSDriver } from 'flydrive/drivers/fs'\nimport { FtpDriver } from './FtpDriver'\nimport { Logger } from '@h3ravel/shared'\nimport { Readable } from 'node:stream'\nimport { S3Driver } from 'flydrive/drivers/s3'\nimport path from 'node:path'\n\ninterface FileLike {\n    originalname: string\n    buffer: Buffer\n    mimetype: string\n}\n\nexport class Storage implements DriverContract {\n    driver: DriveManager<any>\n    services: Record<string, () => DriverContract> = {}\n    diskName: string\n\n    constructor() {\n        for (const diskName in config('filesystem.disks')) {\n            const diskConfig = config('filesystem.disks')[diskName]\n            const driverFactory = this.driversMap[diskConfig.driver]\n\n            if (!driverFactory) {\n                throw new Error(`Unsupported driver: ${diskConfig.driver}`)\n            }\n\n            this.services[diskName] = () => driverFactory(diskConfig)\n        }\n\n        this.diskName = config('filesystem.default')\n        this.driver = new DriveManager({\n            default: config('filesystem.default'),\n            services: this.services\n        })\n    }\n\n    /**\n     * Static method to get a disk instance directly from the Storage class without needing to instantiate it first.\n     * \n     * @param diskName The name of the disk to use. If not provided, the default disk will be used.\n     * @returns A Storage instance\n     */\n    static disk<K extends string> (diskName?: K): Storage {\n        const storage = new Storage()\n\n        if (diskName) {\n            storage.diskName = diskName\n            storage.driver = new DriveManager({\n                default: diskName,\n                services: storage.services\n            })\n        }\n\n        return storage\n    }\n\n    /**\n     * Generate a unique name for the file based on random numbers and original extension\n     * \n     * @param file  The file object containing the original name\n     * @returns     A unique file name\n     */\n    static generateName = (file: { name?: string; originalname?: string }): string => {\n        const name = file.originalname || file.name || 'file'\n\n        if (typeof config('filesystem.fileNameGenerator') === 'function') {\n            return config('filesystem.fileNameGenerator')(name)\n        }\n\n        return Math.floor(Math.random() * 999999999999).toString() +\n            '_' + Math.floor(Math.random() * 999999999999) +\n            '.' + (name).split('.').pop()\n    }\n\n    /**\n     * Save the file to the storage and return the public URL and the file path\n     * \n     * @param file      The file object containing the file data\n     * @param filePath  The path where the file should be saved\n     * @param fileName  The name to save the file as (optional)\n     * @returns         A tuple containing the public URL and the file path\n     */\n    static saveFile = async (\n        file: FileLike,\n        filePath: string = '',\n        fileName?: string\n    ): Promise<[string, string]> => {\n        return new Storage().saveFile(file, filePath, fileName)\n    }\n\n    /**\n     * Save the file to the storage and return the public URL and the file path\n     * \n     * @param file      The file object containing the file data\n     * @param filePath  The path where the file should be saved\n     * @param fileName  The name to save the file as (optional)\n     * @returns         A tuple containing the public URL and the file path\n     */\n    saveFile = async (\n        file: FileLike,\n        filePath: string = '',\n        fileName?: string\n    ): Promise<[string, string]> => {\n        const name = fileName || Storage.generateName(file)\n        const drive = this.driver.use()\n\n        if (file instanceof File && !file.buffer) {\n            file.buffer = Buffer.from(await file.arrayBuffer())\n        }\n\n        await drive.put(path.join(filePath, name), file.buffer)\n\n        const url = await drive.getUrl(path.join(filePath, name))\n        const pth = this.diskName === 'local' ? path.join(filePath, name) : url\n\n        return [url, pth]\n    }\n\n    /**\n     * Return a boolean indicating if the file exists\n     */\n    exists (key: string): Promise<boolean> {\n        return this.driver.use().exists(key)\n    }\n    /**\n     * Return contents of a object for the given key as a UTF-8 string.\n     * Should throw \"E_CANNOT_READ_FILE\" error when the file\n     * does not exists.\n     */\n    get (key: string): Promise<string> {\n        return this.driver.use().get(key)\n    }\n    /**\n     * Return contents of a object for the given key as a Readable stream.\n     * Should throw \"E_CANNOT_READ_FILE\" error when the file\n     * does not exists.\n     */\n    getStream (key: string): Promise<Readable> {\n        return this.driver.use().getStream(key)\n    }\n    /**\n     * Return contents of an object for the given key as an Uint8Array.\n     * Should throw \"E_CANNOT_READ_FILE\" error when the file\n     * does not exists.\n     */\n    getBytes (key: string): Promise<Uint8Array> {\n        return this.driver.use().getBytes(key)\n    }\n    /**\n     * Return metadata of an object for the given key.\n     */\n    getMetaData (key: string): Promise<ObjectMetaData> {\n        return this.driver.use().getMetaData(key)\n    }\n    /**\n     * Return the visibility of the file\n     */\n    getVisibility (key: string): Promise<ObjectVisibility> {\n        return this.driver.use().getVisibility(key)\n    }\n    /**\n     * Return the public URL to access the file\n     */\n    getUrl (key: string): Promise<string> {\n        return this.driver.use().getUrl(key)\n    }\n    /**\n     * Return the signed/temporary URL to access the file\n     */\n    getSignedUrl (key: string, options?: SignedURLOptions): Promise<string> {\n        return this.driver.use().getSignedUrl(key, options)\n    }\n    /**\n     * Return the signed/temporary URL that can be used to directly upload\n     * the file contents to the storage.\n     */\n    getSignedUploadUrl (key: string, options?: SignedURLOptions): Promise<string> {\n        return this.driver.use().getSignedUploadUrl(key, options)\n    }\n    /**\n     * Update the visibility of the file\n     */\n    setVisibility (key: string, visibility: ObjectVisibility): Promise<void> {\n        return this.driver.use().setVisibility(key, visibility)\n    }\n    /**\n     * Write object to the destination with the provided\n     * contents.\n     */\n    put (key: string, contents: string | Uint8Array | FileLike, options?: WriteOptions): Promise<void> {\n        if (!(contents instanceof Uint8Array) && typeof contents !== 'string') {\n            contents = contents.buffer\n        }\n\n        return this.driver.use().put(key, contents, options)\n    }\n    /**\n     * Write object to the destination with the provided\n     * contents as a readable stream\n     */\n    putStream (key: string, contents: Readable, options?: WriteOptions): Promise<void> {\n        return this.driver.use().putStream(key, contents, options)\n    }\n    /**\n     * Copy the file from within the disk root location. Both\n     * the \"source\" and \"destination\" will be the key names\n     * and not absolute paths.\n     */\n    copy (source: string, destination: string, options?: WriteOptions): Promise<void> {\n        return this.driver.use().copy(source, destination, options)\n    }\n    /**\n     * Move the file from within the disk root location. Both\n     * the \"source\" and \"destination\" will be the key names\n     * and not absolute paths.\n     */\n    move (source: string, destination: string, options?: WriteOptions): Promise<void> {\n        return this.driver.use().move(source, destination, options)\n    }\n    /**\n     * Delete the file for the given key. Should not throw\n     * error when file does not exist in first place\n     */\n    delete (key: string): Promise<void> {\n        return this.driver.use().delete(key)\n    }\n    /**\n     * Delete the files and directories matching the provided prefix.\n     */\n    deleteAll (prefix: string): Promise<void> {\n        return this.driver.use().deleteAll(prefix)\n    }\n    /**\n     * The list all method must return an array of objects with\n     * the ability to paginate results (if supported).\n     */\n    listAll (prefix: string, options?: {\n        recursive?: boolean;\n        paginationToken?: string;\n    }): Promise<{\n        paginationToken?: string;\n        objects: Iterable<DriveFile | DriveDirectory>;\n    }> {\n        return this.driver.use().listAll(prefix, options)\n    }\n    /**\n     * Switch bucket at runtime if supported.\n     */\n    bucket (bucket: string): DriverContract {\n        return (this.driver.use() as any).bucket(bucket)\n    }\n\n    /**\n     * Create symbolic links for all configured links in the application configuration.\n     */\n    static link ({ force = false }: { force?: boolean } = {}): void {\n        for (const link in config('filesystem.links')) {\n            const target = config('filesystem.links')[link]\n\n            const unlink = link.replace(process.cwd(), '')\n            const untarget = target.replace(process.cwd(), '')\n\n            try {\n                if (force && existsSync(link)) rmSync(link, { recursive: true })\n                symlinkSync(target, link)\n\n                Logger.log([\n                    [' SUCCESS ', 'bgGreen'],\n                    [`[${unlink}]`, 'green'],\n                    ['is now linked to', 'white'],\n                    [`[${untarget}].`, 'green']\n                ], ' ')\n            } catch (error: any) {\n                if (error.code === 'EEXIST') {\n                    Logger.log([\n                        [' INFO ', 'bgBlue'],\n                        [`[${unlink}]`, 'green'],\n                        ['is already linked to', 'white'],\n                        [`[${untarget}].`, 'green']\n                    ], ' ')\n                } else {\n                    Logger.log([\n                        [' ERROR ', 'bgRed'],\n                        ['Failed to create symbolic link from', 'white'],\n                        [`[${unlink}]`, 'green'],\n                        ['to', 'white'],\n                        [`[${untarget}]`, 'green'],\n                        [error.message, 'red']\n                    ], ' ')\n                }\n            }\n        }\n    }\n\n    private driversMap: Record<string, (conf: Record<string, any>) => DriverContract> = {\n        local: (conf: Record<string, any>) => new FSDriver({\n            location: new URL(conf.root, import.meta.url),\n            visibility: 'public',\n            urlBuilder: {\n                async generateURL (key: string, _path: string) {\n                    return appUrl(key)\n                },\n\n                async generateSignedURL (key: string, _path: string, _opts: SignedURLOptions) {\n                    return appUrl(key)\n                },\n            },\n        }),\n        s3: (conf: Record<string, any>) => new S3Driver({\n            credentials: {\n                accessKeyId: conf.key,\n                secretAccessKey: conf.secret,\n            },\n            endpoint: conf.endpoint,\n            region: conf.region,\n            bucket: conf.bucket,\n            visibility: 'private',\n            cdnUrl: conf.url,\n        }),\n        ftp: (conf: Record<string, any>) => new FtpDriver({\n            host: conf.host,\n            username: conf.username,\n            password: conf.password,\n            port: conf.port,\n            verbose: conf.verbose,\n            privateKey: conf.privateKey,\n        }),\n    }\n}"],"mappings":";;;;;;;;;;AAkBA,IAAa,UAAb,MAAa,QAAkC;CAC3C;CACA,WAAiD,EAAE;CACnD;CAEA,cAAc;AACV,OAAK,MAAM,YAAY,OAAO,mBAAmB,EAAE;GAC/C,MAAM,aAAa,OAAO,mBAAmB,CAAC;GAC9C,MAAM,gBAAgB,KAAK,WAAW,WAAW;AAEjD,OAAI,CAAC,cACD,OAAM,IAAI,MAAM,uBAAuB,WAAW,SAAS;AAG/D,QAAK,SAAS,kBAAkB,cAAc,WAAW;;AAG7D,OAAK,WAAW,OAAO,qBAAqB;AAC5C,OAAK,SAAS,IAAI,aAAa;GAC3B,SAAS,OAAO,qBAAqB;GACrC,UAAU,KAAK;GAClB,CAAC;;;;;;;;CASN,OAAO,KAAwB,UAAuB;EAClD,MAAM,UAAU,IAAI,SAAS;AAE7B,MAAI,UAAU;AACV,WAAQ,WAAW;AACnB,WAAQ,SAAS,IAAI,aAAa;IAC9B,SAAS;IACT,UAAU,QAAQ;IACrB,CAAC;;AAGN,SAAO;;;;;;;;CASX,OAAO,gBAAgB,SAA2D;EAC9E,MAAM,OAAO,KAAK,gBAAgB,KAAK,QAAQ;AAE/C,MAAI,OAAO,OAAO,+BAA+B,KAAK,WAClD,QAAO,OAAO,+BAA+B,CAAC,KAAK;AAGvD,SAAO,KAAK,MAAM,KAAK,QAAQ,GAAG,aAAa,CAAC,UAAU,GACtD,MAAM,KAAK,MAAM,KAAK,QAAQ,GAAG,aAAa,GAC9C,MAAO,KAAM,MAAM,IAAI,CAAC,KAAK;;;;;;;;;;CAWrC,OAAO,WAAW,OACd,MACA,WAAmB,IACnB,aAC4B;AAC5B,SAAO,IAAI,SAAS,CAAC,SAAS,MAAM,UAAU,SAAS;;;;;;;;;;CAW3D,WAAW,OACP,MACA,WAAmB,IACnB,aAC4B;EAC5B,MAAM,OAAO,YAAY,QAAQ,aAAa,KAAK;EACnD,MAAM,QAAQ,KAAK,OAAO,KAAK;AAE/B,MAAI,gBAAgB,QAAQ,CAAC,KAAK,OAC9B,MAAK,SAAS,OAAO,KAAK,MAAM,KAAK,aAAa,CAAC;AAGvD,QAAM,MAAM,IAAI,KAAK,KAAK,UAAU,KAAK,EAAE,KAAK,OAAO;EAEvD,MAAM,MAAM,MAAM,MAAM,OAAO,KAAK,KAAK,UAAU,KAAK,CAAC;AAGzD,SAAO,CAAC,KAFI,KAAK,aAAa,UAAU,KAAK,KAAK,UAAU,KAAK,GAAG,IAEnD;;;;;CAMrB,OAAQ,KAA+B;AACnC,SAAO,KAAK,OAAO,KAAK,CAAC,OAAO,IAAI;;;;;;;CAOxC,IAAK,KAA8B;AAC/B,SAAO,KAAK,OAAO,KAAK,CAAC,IAAI,IAAI;;;;;;;CAOrC,UAAW,KAAgC;AACvC,SAAO,KAAK,OAAO,KAAK,CAAC,UAAU,IAAI;;;;;;;CAO3C,SAAU,KAAkC;AACxC,SAAO,KAAK,OAAO,KAAK,CAAC,SAAS,IAAI;;;;;CAK1C,YAAa,KAAsC;AAC/C,SAAO,KAAK,OAAO,KAAK,CAAC,YAAY,IAAI;;;;;CAK7C,cAAe,KAAwC;AACnD,SAAO,KAAK,OAAO,KAAK,CAAC,cAAc,IAAI;;;;;CAK/C,OAAQ,KAA8B;AAClC,SAAO,KAAK,OAAO,KAAK,CAAC,OAAO,IAAI;;;;;CAKxC,aAAc,KAAa,SAA6C;AACpE,SAAO,KAAK,OAAO,KAAK,CAAC,aAAa,KAAK,QAAQ;;;;;;CAMvD,mBAAoB,KAAa,SAA6C;AAC1E,SAAO,KAAK,OAAO,KAAK,CAAC,mBAAmB,KAAK,QAAQ;;;;;CAK7D,cAAe,KAAa,YAA6C;AACrE,SAAO,KAAK,OAAO,KAAK,CAAC,cAAc,KAAK,WAAW;;;;;;CAM3D,IAAK,KAAa,UAA0C,SAAuC;AAC/F,MAAI,EAAE,oBAAoB,eAAe,OAAO,aAAa,SACzD,YAAW,SAAS;AAGxB,SAAO,KAAK,OAAO,KAAK,CAAC,IAAI,KAAK,UAAU,QAAQ;;;;;;CAMxD,UAAW,KAAa,UAAoB,SAAuC;AAC/E,SAAO,KAAK,OAAO,KAAK,CAAC,UAAU,KAAK,UAAU,QAAQ;;;;;;;CAO9D,KAAM,QAAgB,aAAqB,SAAuC;AAC9E,SAAO,KAAK,OAAO,KAAK,CAAC,KAAK,QAAQ,aAAa,QAAQ;;;;;;;CAO/D,KAAM,QAAgB,aAAqB,SAAuC;AAC9E,SAAO,KAAK,OAAO,KAAK,CAAC,KAAK,QAAQ,aAAa,QAAQ;;;;;;CAM/D,OAAQ,KAA4B;AAChC,SAAO,KAAK,OAAO,KAAK,CAAC,OAAO,IAAI;;;;;CAKxC,UAAW,QAA+B;AACtC,SAAO,KAAK,OAAO,KAAK,CAAC,UAAU,OAAO;;;;;;CAM9C,QAAS,QAAgB,SAMtB;AACC,SAAO,KAAK,OAAO,KAAK,CAAC,QAAQ,QAAQ,QAAQ;;;;;CAKrD,OAAQ,QAAgC;AACpC,SAAQ,KAAK,OAAO,KAAK,CAAS,OAAO,OAAO;;;;;CAMpD,OAAO,KAAM,EAAE,QAAQ,UAA+B,EAAE,EAAQ;AAC5D,OAAK,MAAM,QAAQ,OAAO,mBAAmB,EAAE;GAC3C,MAAM,SAAS,OAAO,mBAAmB,CAAC;GAE1C,MAAM,SAAS,KAAK,QAAQ,QAAQ,KAAK,EAAE,GAAG;GAC9C,MAAM,WAAW,OAAO,QAAQ,QAAQ,KAAK,EAAE,GAAG;AAElD,OAAI;AACA,QAAI,SAAS,WAAW,KAAK,CAAE,QAAO,MAAM,EAAE,WAAW,MAAM,CAAC;AAChE,gBAAY,QAAQ,KAAK;AAEzB,WAAO,IAAI;KACP,CAAC,aAAa,UAAU;KACxB,CAAC,IAAI,OAAO,IAAI,QAAQ;KACxB,CAAC,oBAAoB,QAAQ;KAC7B,CAAC,IAAI,SAAS,KAAK,QAAQ;KAC9B,EAAE,IAAI;YACF,OAAY;AACjB,QAAI,MAAM,SAAS,SACf,QAAO,IAAI;KACP,CAAC,UAAU,SAAS;KACpB,CAAC,IAAI,OAAO,IAAI,QAAQ;KACxB,CAAC,wBAAwB,QAAQ;KACjC,CAAC,IAAI,SAAS,KAAK,QAAQ;KAC9B,EAAE,IAAI;QAEP,QAAO,IAAI;KACP,CAAC,WAAW,QAAQ;KACpB,CAAC,uCAAuC,QAAQ;KAChD,CAAC,IAAI,OAAO,IAAI,QAAQ;KACxB,CAAC,MAAM,QAAQ;KACf,CAAC,IAAI,SAAS,IAAI,QAAQ;KAC1B,CAAC,MAAM,SAAS,MAAM;KACzB,EAAE,IAAI;;;;CAMvB,AAAQ,aAA4E;EAChF,QAAQ,SAA8B,IAAI,SAAS;GAC/C,UAAU,IAAI,IAAI,KAAK,MAAM,OAAO,KAAK,IAAI;GAC7C,YAAY;GACZ,YAAY;IACR,MAAM,YAAa,KAAa,OAAe;AAC3C,YAAO,OAAO,IAAI;;IAGtB,MAAM,kBAAmB,KAAa,OAAe,OAAyB;AAC1E,YAAO,OAAO,IAAI;;IAEzB;GACJ,CAAC;EACF,KAAK,SAA8B,IAAI,SAAS;GAC5C,aAAa;IACT,aAAa,KAAK;IAClB,iBAAiB,KAAK;IACzB;GACD,UAAU,KAAK;GACf,QAAQ,KAAK;GACb,QAAQ,KAAK;GACb,YAAY;GACZ,QAAQ,KAAK;GAChB,CAAC;EACF,MAAM,SAA8B,IAAI,UAAU;GAC9C,MAAM,KAAK;GACX,UAAU,KAAK;GACf,UAAU,KAAK;GACf,MAAM,KAAK;GACX,SAAS,KAAK;GACd,YAAY,KAAK;GACpB,CAAC;EACL"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { DriveDirectory, DriveFile, DriveManager } from 'flydrive'\nimport { DriverContract, ObjectMetaData, ObjectVisibility, SignedURLOptions, WriteOptions } from 'flydrive/types'\nimport { appUrl, config } from '@arkstack/common'\nimport { rmSync, symlinkSync } from 'node:fs'\n\nimport { FSDriver } from 'flydrive/drivers/fs'\nimport { FtpDriver } from './FtpDriver'\nimport { Logger } from '@h3ravel/shared'\nimport { Readable } from 'node:stream'\nimport { S3Driver } from 'flydrive/drivers/s3'\nimport path from 'node:path'\n\ninterface FileLike {\n    originalname: string\n    buffer: Buffer\n    mimetype: string\n}\n\nexport class Storage implements DriverContract {\n    driver: DriveManager<any>\n    services: Record<string, () => DriverContract> = {}\n    diskName: string\n\n    constructor() {\n        for (const diskName in config('filesystem.disks')) {\n            const diskConfig = config('filesystem.disks')[diskName]\n            const driverFactory = this.driversMap[diskConfig.driver]\n\n            if (!driverFactory) {\n                throw new Error(`Unsupported driver: ${diskConfig.driver}`)\n            }\n\n            this.services[diskName] = () => driverFactory(diskConfig)\n        }\n\n        this.diskName = config('filesystem.default')\n        this.driver = new DriveManager({\n            default: config('filesystem.default'),\n            services: this.services\n        })\n    }\n\n    /**\n     * Static method to get a disk instance directly from the Storage class without needing to instantiate it first.\n     * \n     * @param diskName The name of the disk to use. If not provided, the default disk will be used.\n     * @returns A Storage instance\n     */\n    static disk<K extends string> (diskName?: K): Storage {\n        const storage = new Storage()\n\n        if (diskName) {\n            storage.diskName = diskName\n            storage.driver = new DriveManager({\n                default: diskName,\n                services: storage.services\n            })\n        }\n\n        return storage\n    }\n\n    /**\n     * Generate a unique name for the file based on random numbers and original extension\n     * \n     * @param file  The file object containing the original name\n     * @returns     A unique file name\n     */\n    static generateName = (file: { name?: string; originalname?: string }): string => {\n        const name = file.originalname || file.name || 'file'\n\n        if (typeof config('filesystem.fileNameGenerator') === 'function') {\n            return config('filesystem.fileNameGenerator')(name)\n        }\n\n        return Math.floor(Math.random() * 999999999999).toString() +\n            '_' + Math.floor(Math.random() * 999999999999) +\n            '.' + (name).split('.').pop()\n    }\n\n    /**\n     * Save the file to the storage and return the public URL and the file path\n     * \n     * @param file      The file object containing the file data\n     * @param filePath  The path where the file should be saved\n     * @param fileName  The name to save the file as (optional)\n     * @returns         A tuple containing the public URL and the file path\n     */\n    static saveFile = async (\n        file: FileLike,\n        filePath: string = '',\n        fileName?: string\n    ): Promise<[string, string]> => {\n        return new Storage().saveFile(file, filePath, fileName)\n    }\n\n    /**\n     * Save the file to the storage and return the public URL and the file path\n     * \n     * @param file      The file object containing the file data\n     * @param filePath  The path where the file should be saved\n     * @param fileName  The name to save the file as (optional)\n     * @returns         A tuple containing the public URL and the file path\n     */\n    saveFile = async (\n        file: FileLike,\n        filePath: string = '',\n        fileName?: string\n    ): Promise<[string, string]> => {\n        const name = fileName || Storage.generateName(file)\n        const drive = this.driver.use()\n\n        if (file instanceof File && !file.buffer) {\n            file.buffer = Buffer.from(await file.arrayBuffer())\n        }\n\n        await drive.put(path.join(filePath, name), file.buffer)\n\n        const url = await drive.getUrl(path.join(filePath, name))\n        const pth = this.diskName === 'local' ? path.join(filePath, name) : url\n\n        return [url, pth]\n    }\n\n    /**\n     * Return a boolean indicating if the file exists\n     */\n    exists (key: string): Promise<boolean> {\n        return this.driver.use().exists(key)\n    }\n    /**\n     * Return contents of a object for the given key as a UTF-8 string.\n     * Should throw \"E_CANNOT_READ_FILE\" error when the file\n     * does not exists.\n     */\n    get (key: string): Promise<string> {\n        return this.driver.use().get(key)\n    }\n    /**\n     * Return contents of a object for the given key as a Readable stream.\n     * Should throw \"E_CANNOT_READ_FILE\" error when the file\n     * does not exists.\n     */\n    getStream (key: string): Promise<Readable> {\n        return this.driver.use().getStream(key)\n    }\n    /**\n     * Return contents of an object for the given key as an Uint8Array.\n     * Should throw \"E_CANNOT_READ_FILE\" error when the file\n     * does not exists.\n     */\n    getBytes (key: string): Promise<Uint8Array> {\n        return this.driver.use().getBytes(key)\n    }\n    /**\n     * Return metadata of an object for the given key.\n     */\n    getMetaData (key: string): Promise<ObjectMetaData> {\n        return this.driver.use().getMetaData(key)\n    }\n    /**\n     * Return the visibility of the file\n     */\n    getVisibility (key: string): Promise<ObjectVisibility> {\n        return this.driver.use().getVisibility(key)\n    }\n    /**\n     * Return the public URL to access the file\n     */\n    getUrl (key: string): Promise<string> {\n        return this.driver.use().getUrl(key)\n    }\n    /**\n     * Return the signed/temporary URL to access the file\n     */\n    getSignedUrl (key: string, options?: SignedURLOptions): Promise<string> {\n        return this.driver.use().getSignedUrl(key, options)\n    }\n    /**\n     * Return the signed/temporary URL that can be used to directly upload\n     * the file contents to the storage.\n     */\n    getSignedUploadUrl (key: string, options?: SignedURLOptions): Promise<string> {\n        return this.driver.use().getSignedUploadUrl(key, options)\n    }\n    /**\n     * Update the visibility of the file\n     */\n    setVisibility (key: string, visibility: ObjectVisibility): Promise<void> {\n        return this.driver.use().setVisibility(key, visibility)\n    }\n    /**\n     * Write object to the destination with the provided\n     * contents.\n     */\n    put (key: string, contents: string | Uint8Array | FileLike, options?: WriteOptions): Promise<void> {\n        if (!(contents instanceof Uint8Array) && typeof contents !== 'string') {\n            contents = contents.buffer\n        }\n\n        return this.driver.use().put(key, contents, options)\n    }\n    /**\n     * Write object to the destination with the provided\n     * contents as a readable stream\n     */\n    putStream (key: string, contents: Readable, options?: WriteOptions): Promise<void> {\n        return this.driver.use().putStream(key, contents, options)\n    }\n    /**\n     * Copy the file from within the disk root location. Both\n     * the \"source\" and \"destination\" will be the key names\n     * and not absolute paths.\n     */\n    copy (source: string, destination: string, options?: WriteOptions): Promise<void> {\n        return this.driver.use().copy(source, destination, options)\n    }\n    /**\n     * Move the file from within the disk root location. Both\n     * the \"source\" and \"destination\" will be the key names\n     * and not absolute paths.\n     */\n    move (source: string, destination: string, options?: WriteOptions): Promise<void> {\n        return this.driver.use().move(source, destination, options)\n    }\n    /**\n     * Delete the file for the given key. Should not throw\n     * error when file does not exist in first place\n     */\n    delete (key: string): Promise<void> {\n        return this.driver.use().delete(key)\n    }\n    /**\n     * Delete the files and directories matching the provided prefix.\n     */\n    deleteAll (prefix: string): Promise<void> {\n        return this.driver.use().deleteAll(prefix)\n    }\n    /**\n     * The list all method must return an array of objects with\n     * the ability to paginate results (if supported).\n     */\n    listAll (prefix: string, options?: {\n        recursive?: boolean;\n        paginationToken?: string;\n    }): Promise<{\n        paginationToken?: string;\n        objects: Iterable<DriveFile | DriveDirectory>;\n    }> {\n        return this.driver.use().listAll(prefix, options)\n    }\n    /**\n     * Switch bucket at runtime if supported.\n     */\n    bucket (bucket: string): DriverContract {\n        return (this.driver.use() as any).bucket(bucket)\n    }\n\n    /**\n     * Create symbolic links for all configured links in the application configuration.\n     */\n    static link ({ force = false }: { force?: boolean } = {}): void {\n        for (const link in config('filesystem.links')) {\n            const target = config('filesystem.links')[link]\n\n            const unlink = link.replace(process.cwd(), '')\n            const untarget = target.replace(process.cwd(), '')\n\n            try {\n                if (force) rmSync(link, { recursive: true, force: true })\n                symlinkSync(target, link)\n\n                Logger.log([\n                    [' SUCCESS ', 'bgGreen'],\n                    [`[${unlink}]`, 'green'],\n                    ['is now linked to', 'white'],\n                    [`[${untarget}].`, 'green']\n                ], ' ')\n            } catch (error: any) {\n                if (error.code === 'EEXIST') {\n                    Logger.log([\n                        [' INFO ', 'bgBlue'],\n                        [`[${unlink}]`, 'green'],\n                        ['is already linked to', 'white'],\n                        [`[${untarget}].`, 'green']\n                    ], ' ')\n                } else {\n                    Logger.log([\n                        [' ERROR ', 'bgRed'],\n                        ['Failed to create symbolic link from', 'white'],\n                        [`[${unlink}]`, 'green'],\n                        ['to', 'white'],\n                        [`[${untarget}]`, 'green'],\n                        [error.message, 'red']\n                    ], ' ')\n                }\n            }\n        }\n    }\n\n    private driversMap: Record<string, (conf: Record<string, any>) => DriverContract> = {\n        local: (conf: Record<string, any>) => new FSDriver({\n            location: new URL(conf.root, import.meta.url),\n            visibility: 'public',\n            urlBuilder: {\n                async generateURL (key: string, _path: string) {\n                    return appUrl(key)\n                },\n\n                async generateSignedURL (key: string, _path: string, _opts: SignedURLOptions) {\n                    return appUrl(key)\n                },\n            },\n        }),\n        s3: (conf: Record<string, any>) => new S3Driver({\n            credentials: {\n                accessKeyId: conf.key,\n                secretAccessKey: conf.secret,\n            },\n            endpoint: conf.endpoint,\n            region: conf.region,\n            bucket: conf.bucket,\n            visibility: 'private',\n            cdnUrl: conf.url,\n        }),\n        ftp: (conf: Record<string, any>) => new FtpDriver({\n            host: conf.host,\n            username: conf.username,\n            password: conf.password,\n            port: conf.port,\n            verbose: conf.verbose,\n            privateKey: conf.privateKey,\n        }),\n    }\n}"],"mappings":";;;;;;;;;;AAkBA,IAAa,UAAb,MAAa,QAAkC;CAC3C;CACA,WAAiD,EAAE;CACnD;CAEA,cAAc;AACV,OAAK,MAAM,YAAY,OAAO,mBAAmB,EAAE;GAC/C,MAAM,aAAa,OAAO,mBAAmB,CAAC;GAC9C,MAAM,gBAAgB,KAAK,WAAW,WAAW;AAEjD,OAAI,CAAC,cACD,OAAM,IAAI,MAAM,uBAAuB,WAAW,SAAS;AAG/D,QAAK,SAAS,kBAAkB,cAAc,WAAW;;AAG7D,OAAK,WAAW,OAAO,qBAAqB;AAC5C,OAAK,SAAS,IAAI,aAAa;GAC3B,SAAS,OAAO,qBAAqB;GACrC,UAAU,KAAK;GAClB,CAAC;;;;;;;;CASN,OAAO,KAAwB,UAAuB;EAClD,MAAM,UAAU,IAAI,SAAS;AAE7B,MAAI,UAAU;AACV,WAAQ,WAAW;AACnB,WAAQ,SAAS,IAAI,aAAa;IAC9B,SAAS;IACT,UAAU,QAAQ;IACrB,CAAC;;AAGN,SAAO;;;;;;;;CASX,OAAO,gBAAgB,SAA2D;EAC9E,MAAM,OAAO,KAAK,gBAAgB,KAAK,QAAQ;AAE/C,MAAI,OAAO,OAAO,+BAA+B,KAAK,WAClD,QAAO,OAAO,+BAA+B,CAAC,KAAK;AAGvD,SAAO,KAAK,MAAM,KAAK,QAAQ,GAAG,aAAa,CAAC,UAAU,GACtD,MAAM,KAAK,MAAM,KAAK,QAAQ,GAAG,aAAa,GAC9C,MAAO,KAAM,MAAM,IAAI,CAAC,KAAK;;;;;;;;;;CAWrC,OAAO,WAAW,OACd,MACA,WAAmB,IACnB,aAC4B;AAC5B,SAAO,IAAI,SAAS,CAAC,SAAS,MAAM,UAAU,SAAS;;;;;;;;;;CAW3D,WAAW,OACP,MACA,WAAmB,IACnB,aAC4B;EAC5B,MAAM,OAAO,YAAY,QAAQ,aAAa,KAAK;EACnD,MAAM,QAAQ,KAAK,OAAO,KAAK;AAE/B,MAAI,gBAAgB,QAAQ,CAAC,KAAK,OAC9B,MAAK,SAAS,OAAO,KAAK,MAAM,KAAK,aAAa,CAAC;AAGvD,QAAM,MAAM,IAAI,KAAK,KAAK,UAAU,KAAK,EAAE,KAAK,OAAO;EAEvD,MAAM,MAAM,MAAM,MAAM,OAAO,KAAK,KAAK,UAAU,KAAK,CAAC;AAGzD,SAAO,CAAC,KAFI,KAAK,aAAa,UAAU,KAAK,KAAK,UAAU,KAAK,GAAG,IAEnD;;;;;CAMrB,OAAQ,KAA+B;AACnC,SAAO,KAAK,OAAO,KAAK,CAAC,OAAO,IAAI;;;;;;;CAOxC,IAAK,KAA8B;AAC/B,SAAO,KAAK,OAAO,KAAK,CAAC,IAAI,IAAI;;;;;;;CAOrC,UAAW,KAAgC;AACvC,SAAO,KAAK,OAAO,KAAK,CAAC,UAAU,IAAI;;;;;;;CAO3C,SAAU,KAAkC;AACxC,SAAO,KAAK,OAAO,KAAK,CAAC,SAAS,IAAI;;;;;CAK1C,YAAa,KAAsC;AAC/C,SAAO,KAAK,OAAO,KAAK,CAAC,YAAY,IAAI;;;;;CAK7C,cAAe,KAAwC;AACnD,SAAO,KAAK,OAAO,KAAK,CAAC,cAAc,IAAI;;;;;CAK/C,OAAQ,KAA8B;AAClC,SAAO,KAAK,OAAO,KAAK,CAAC,OAAO,IAAI;;;;;CAKxC,aAAc,KAAa,SAA6C;AACpE,SAAO,KAAK,OAAO,KAAK,CAAC,aAAa,KAAK,QAAQ;;;;;;CAMvD,mBAAoB,KAAa,SAA6C;AAC1E,SAAO,KAAK,OAAO,KAAK,CAAC,mBAAmB,KAAK,QAAQ;;;;;CAK7D,cAAe,KAAa,YAA6C;AACrE,SAAO,KAAK,OAAO,KAAK,CAAC,cAAc,KAAK,WAAW;;;;;;CAM3D,IAAK,KAAa,UAA0C,SAAuC;AAC/F,MAAI,EAAE,oBAAoB,eAAe,OAAO,aAAa,SACzD,YAAW,SAAS;AAGxB,SAAO,KAAK,OAAO,KAAK,CAAC,IAAI,KAAK,UAAU,QAAQ;;;;;;CAMxD,UAAW,KAAa,UAAoB,SAAuC;AAC/E,SAAO,KAAK,OAAO,KAAK,CAAC,UAAU,KAAK,UAAU,QAAQ;;;;;;;CAO9D,KAAM,QAAgB,aAAqB,SAAuC;AAC9E,SAAO,KAAK,OAAO,KAAK,CAAC,KAAK,QAAQ,aAAa,QAAQ;;;;;;;CAO/D,KAAM,QAAgB,aAAqB,SAAuC;AAC9E,SAAO,KAAK,OAAO,KAAK,CAAC,KAAK,QAAQ,aAAa,QAAQ;;;;;;CAM/D,OAAQ,KAA4B;AAChC,SAAO,KAAK,OAAO,KAAK,CAAC,OAAO,IAAI;;;;;CAKxC,UAAW,QAA+B;AACtC,SAAO,KAAK,OAAO,KAAK,CAAC,UAAU,OAAO;;;;;;CAM9C,QAAS,QAAgB,SAMtB;AACC,SAAO,KAAK,OAAO,KAAK,CAAC,QAAQ,QAAQ,QAAQ;;;;;CAKrD,OAAQ,QAAgC;AACpC,SAAQ,KAAK,OAAO,KAAK,CAAS,OAAO,OAAO;;;;;CAMpD,OAAO,KAAM,EAAE,QAAQ,UAA+B,EAAE,EAAQ;AAC5D,OAAK,MAAM,QAAQ,OAAO,mBAAmB,EAAE;GAC3C,MAAM,SAAS,OAAO,mBAAmB,CAAC;GAE1C,MAAM,SAAS,KAAK,QAAQ,QAAQ,KAAK,EAAE,GAAG;GAC9C,MAAM,WAAW,OAAO,QAAQ,QAAQ,KAAK,EAAE,GAAG;AAElD,OAAI;AACA,QAAI,MAAO,QAAO,MAAM;KAAE,WAAW;KAAM,OAAO;KAAM,CAAC;AACzD,gBAAY,QAAQ,KAAK;AAEzB,WAAO,IAAI;KACP,CAAC,aAAa,UAAU;KACxB,CAAC,IAAI,OAAO,IAAI,QAAQ;KACxB,CAAC,oBAAoB,QAAQ;KAC7B,CAAC,IAAI,SAAS,KAAK,QAAQ;KAC9B,EAAE,IAAI;YACF,OAAY;AACjB,QAAI,MAAM,SAAS,SACf,QAAO,IAAI;KACP,CAAC,UAAU,SAAS;KACpB,CAAC,IAAI,OAAO,IAAI,QAAQ;KACxB,CAAC,wBAAwB,QAAQ;KACjC,CAAC,IAAI,SAAS,KAAK,QAAQ;KAC9B,EAAE,IAAI;QAEP,QAAO,IAAI;KACP,CAAC,WAAW,QAAQ;KACpB,CAAC,uCAAuC,QAAQ;KAChD,CAAC,IAAI,OAAO,IAAI,QAAQ;KACxB,CAAC,MAAM,QAAQ;KACf,CAAC,IAAI,SAAS,IAAI,QAAQ;KAC1B,CAAC,MAAM,SAAS,MAAM;KACzB,EAAE,IAAI;;;;CAMvB,AAAQ,aAA4E;EAChF,QAAQ,SAA8B,IAAI,SAAS;GAC/C,UAAU,IAAI,IAAI,KAAK,MAAM,OAAO,KAAK,IAAI;GAC7C,YAAY;GACZ,YAAY;IACR,MAAM,YAAa,KAAa,OAAe;AAC3C,YAAO,OAAO,IAAI;;IAGtB,MAAM,kBAAmB,KAAa,OAAe,OAAyB;AAC1E,YAAO,OAAO,IAAI;;IAEzB;GACJ,CAAC;EACF,KAAK,SAA8B,IAAI,SAAS;GAC5C,aAAa;IACT,aAAa,KAAK;IAClB,iBAAiB,KAAK;IACzB;GACD,UAAU,KAAK;GACf,QAAQ,KAAK;GACb,QAAQ,KAAK;GACb,YAAY;GACZ,QAAQ,KAAK;GAChB,CAAC;EACF,MAAM,SAA8B,IAAI,UAAU;GAC9C,MAAM,KAAK;GACX,UAAU,KAAK;GACf,UAAU,KAAK;GACf,MAAM,KAAK;GACX,SAAS,KAAK;GACd,YAAY,KAAK;GACpB,CAAC;EACL"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/filesystem",
-  "version": "0.3.8",
+  "version": "0.3.9",
   "type": "module",
   "description": "Shared Filesystem utilities for ArkStack.",
   "homepage": "https://arkstack.toneflix.net",
@@ -39,8 +39,8 @@
     "@aws-sdk/s3-request-presigner": "^3.1011.0",
     "flydrive": "^2.0.0",
     "ssh2-sftp-client": "^12.1.0",
-    "@arkstack/common": "^0.3.8",
-    "@arkstack/contract": "^0.3.8"
+    "@arkstack/contract": "^0.3.9",
+    "@arkstack/common": "^0.3.9"
   },
   "devDependencies": {
     "@types/ssh2-sftp-client": "^9.0.6"