@arkstack/filesystem 0.5.2 → 0.5.3

package/README.md

@@ -1,3 +1,71 @@
 # @arkstack/filesystem
 
+[![@arkstack/filesystem](https://img.shields.io/npm/dt/@arkstack/filesystem?style=flat-square&label=@arkstack/filesystem&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F@arkstack/filesystem)](https://www.npmjs.com/package/@arkstack/filesystem)
+
 Filesystem module for Arkstack, providing shared file storage and filesystem utitlities for the framework.
+
+## Custom Drivers
+
+@arkstack/filesystem allows you to configure and use custom storage drivers.
+
+**CloudinaryFileDriver.ts**
+
+```ts
+import type { DriverContract, ObjectVisibility } from 'flydrive/types';
+import type { CustomDiskConfig } from '@arkstack/filesystem';
+
+export class CloudinaryFileDriver implements DriverContract {
+  constructor(private config?: CustomDiskConfig) {}
+  async exists(key: string) {}
+  async get(key: string) {}
+  async getStream(key: string) {}
+  async getBytes(key: string) {}
+  async getMetaData(key: string) {}
+  async getVisibility(): Promise<ObjectVisibility> {}
+  async getUrl(key: string) {}
+  async getSignedUrl(key: string) {}
+  async getSignedUploadUrl(key: string) {}
+  async setVisibility() {}
+  async put() {}
+  async putStream() {}
+  async copy() {}
+  async move() {}
+  async delete() {}
+  async deleteAll() {}
+  async listAll() {}
+  async bucket() {}
+}
+```
+
+**src/config/filesystem.ts**
+
+```ts
+import { CloudinaryFileDriver } from '../CloudinaryFileDriver';
+export default () => {
+  return {
+    default: 'images',
+    disks: {
+      images: {
+        //...Other Disks Here
+        driver: 'cloudinary',
+      },
+    },
+    links: {},
+    custom_drivers: {
+      cloudinary: CloudinaryFileDriver,
+    },
+  };
+};
+```
+
+To improve type safety and auto complete, you may augment the `CustomDiskDriverRegistry`
+
+**env.d.ts**
+
+```ts
+declare module '@arkstack/filesystem' {
+  interface CustomDiskDriverRegistry {
+    cloudinary: { cloud_name: string; api_key: string; api_secret: string };
+  }
+}
+```

package/dist/commands/StorageLinkCommand.d.ts

@@ -7,5 +7,4 @@ declare class StorageLinkCommand extends Command {
   handle(): Promise<void>;
 }
 //#endregion
-export { StorageLinkCommand };
-//# sourceMappingURL=StorageLinkCommand.d.ts.map
+export { StorageLinkCommand };

package/dist/commands/StorageLinkCommand.js

@@ -1,4 +1,4 @@
-import { t as Storage } from "../src-wGEPrkk5.js";
+import { t as Storage } from "../src-DNh_3BpA.js";
 import { Command } from "@h3ravel/musket";
 //#region src/commands/StorageLinkCommand.ts
 var StorageLinkCommand = class extends Command {
@@ -12,5 +12,3 @@ var StorageLinkCommand = class extends Command {
 };
 //#endregion
 export { StorageLinkCommand };
-
-//# sourceMappingURL=StorageLinkCommand.js.map

package/dist/index.d.ts

@@ -1,41 +1,291 @@
 import { DriveDirectory, DriveFile, DriveManager } from "flydrive";
 import { Readable } from "node:stream";
 import { DriverContract, ObjectMetaData, ObjectVisibility, SignedURLOptions, WriteOptions } from "flydrive/types";
+import { GCSDriverOptions } from "flydrive/drivers/gcs/types";
 
-//#region src/index.d.ts
+//#region src/types.d.ts
 interface FileLike {
   originalname: string;
   buffer: Buffer;
   mimetype: string;
 }
-declare class Storage implements DriverContract {
+interface CustomDiskDriverRegistry {}
+type GcsDiskDriverConfig = GCSDriverOptions;
+interface FtpDriverConfig {
+  host: string;
+  username: string;
+  password: string;
+  port?: number;
+  verbose?: boolean | undefined;
+  privateKey?: string | undefined;
+}
+interface S3DriverConfig {
+  credentials?: {
+    accessKeyId: string;
+    secretAccessKey: string;
+    sessionToken?: string | undefined;
+    credentialScope?: string | undefined;
+    accountId?: string | undefined;
+  };
+  url?: string;
+  key?: string;
+  secret?: string;
+  endpoint?: string;
+  region?: string;
+  bucket: string;
+  visibility: ObjectVisibility;
+  cdnUrl?: string;
+}
+interface LocalDriverConfig {
+  root?: string;
+  location?: string | URL;
+  visibility: ObjectVisibility;
+  url?: string;
+}
+type CustomDiskConfig = keyof CustomDiskDriverRegistry extends never ? {
+  driver: string;
+  [key: string]: any;
+} : { [K in keyof CustomDiskDriverRegistry]: CustomDiskDriverRegistry[K] & {
+  driver: K;
+} }[keyof CustomDiskDriverRegistry];
+type DiskConfig = LocalDriverConfig & {
+  driver: 'local' | 'public';
+} | FtpDriverConfig & {
+  driver: 'ftp';
+} | S3DriverConfig & {
+  driver: 's3';
+} | CustomDiskConfig;
+type DriverConfig<K extends 'ftp' | 'local' | 'gcs' | 's3' | (string & {}) = string & {}> = K extends 'ftp' ? FtpDriverConfig : K extends 's3' ? S3DriverConfig : K extends 'gcs' ? GcsDiskDriverConfig : K extends 'local' ? LocalDriverConfig : K extends keyof CustomDiskDriverRegistry ? CustomDiskDriverRegistry[K] : DiskConfig;
+type KnownDisks = {
+  local: LocalDriverConfig & {
+    driver: 'local';
+  };
+  public: LocalDriverConfig & {
+    driver: 'local';
+  };
+  ftp: FtpDriverConfig & {
+    driver: 'ftp';
+  };
+  gcs: GcsDiskDriverConfig & {
+    driver: 'gcs';
+  };
+  s3: S3DriverConfig & {
+    driver: 's3';
+  };
+};
+interface FilesystemConfig {
+  default: 'local' | 'ftp' | 'gcs' | 's3' | keyof CustomDiskDriverRegistry | (string & {});
+  disks: KnownDisks & CustomDiskDriverRegistry;
+  links: Record<string, string>;
+  custom_drivers?: Record<keyof CustomDiskDriverRegistry | (string & {}), DriverContract | (new (config?: CustomDiskConfig) => DriverContract)>;
+  fileNameGenerator?: (originalName: string) => string;
+}
+//#endregion
+//#region src/Storage.d.ts
+declare class Storage<D extends keyof KnownDisks | keyof CustomDiskDriverRegistry = keyof KnownDisks | keyof CustomDiskDriverRegistry> implements DriverContract {
   driver: DriveManager<any>;
   services: Record<string, () => DriverContract>;
-  diskName: string;
+  diskName: D;
+  driverName: FilesystemConfig['disks'][D]['driver'];
   constructor();
-  static disk<K extends string>(diskName?: K): Storage;
+  /**
+   * Static method to get a disk instance directly from the Storage class without needing to instantiate it first.
+   *
+   * @param diskName The name of the disk to use. If not provided, the default disk will be used.
+   * @returns A Storage instance
+   */
+  static disk<K extends keyof KnownDisks | keyof CustomDiskDriverRegistry>(diskName?: K): Storage<K>;
+  /**
+   * Generate a unique name for the file based on random numbers and original extension
+   *
+   * @param file  The file object containing the original name
+   * @returns     A unique file name
+   */
   static generateName: (file: {
     name?: string;
     originalname?: string;
   }) => string;
+  /**
+   * Save the file to the storage and return the public URL and the file path
+   *
+   * @param file      The file object containing the file data
+   * @param filePath  The path where the file should be saved
+   * @param fileName  The name to save the file as (optional)
+   * @returns         A tuple containing the public URL and the file path
+   */
   static saveFile: (file: FileLike, filePath?: string, fileName?: string) => Promise<[string, string]>;
+  /**
+   * Save the file to the storage and return the public URL and the file path
+   *
+   * @param file      The file object containing the file data
+   * @param filePath  The path where the file should be saved
+   * @param fileName  The name to save the file as (optional)
+   * @returns         A tuple containing the public URL and the file path
+   */
   saveFile: (file: FileLike, filePath?: string, fileName?: string) => Promise<[string, string]>;
+  /**
+   * Return a boolean indicating if the file exists
+   *
+   * @param key
+   * @returns
+   */
   exists(key: string): Promise<boolean>;
+  /**
+   * Return contents of a object for the given key as a UTF-8 string.
+   * Should throw "E_CANNOT_READ_FILE" error when the file
+   * does not exists.
+   *
+   * @param key
+   * @returns
+   */
   get(key: string): Promise<string>;
+  /**
+   * Get the name of the disk currently in use.
+   *
+   * @returns
+   */
+  getDiskName(): D;
+  /**
+   * Get the name of the driver currently in use.
+   *
+   * @returns
+   */
+  getDriverName(): (KnownDisks & CustomDiskDriverRegistry)[D]["driver"];
+  /**
+   * Get the driver currently in use.
+   *
+   * @returns
+   */
+  getDriver(): DriveManager<any>;
+  /**
+   * Return contents of a object for the given key as a Readable stream.
+   * Should throw "E_CANNOT_READ_FILE" error when the file
+   * does not exists.
+   *
+   * @param key
+   * @returns
+   */
   getStream(key: string): Promise<Readable>;
+  /**
+   * Return contents of an object for the given key as an Uint8Array.
+   * Should throw "E_CANNOT_READ_FILE" error when the file
+   * does not exists.
+   *
+   * @param key
+   * @returns
+   */
   getBytes(key: string): Promise<Uint8Array>;
+  /**
+   * Return metadata of an object for the given key.
+   *
+   * @param key
+   * @returns
+   */
   getMetaData(key: string): Promise<ObjectMetaData>;
+  /**
+   * Return the visibility of the file
+   *
+   * @param key
+   * @returns
+   */
   getVisibility(key: string): Promise<ObjectVisibility>;
+  /**
+   * Return the public URL to access the file
+   *
+   * @param key
+   * @returns
+   */
   getUrl(key: string): Promise<string>;
+  /**
+   * Return the signed/temporary URL to access the file
+   *
+   * @param key
+   * @param options
+   * @returns
+   */
   getSignedUrl(key: string, options?: SignedURLOptions): Promise<string>;
+  /**
+   * Return the signed/temporary URL that can be used to directly upload
+   * the file contents to the storage.
+   *
+   * @param key
+   * @param options
+   * @returns
+   */
   getSignedUploadUrl(key: string, options?: SignedURLOptions): Promise<string>;
+  /**
+   * Update the visibility of the file
+   *
+   * @param key
+   * @param visibility
+   * @returns
+   */
   setVisibility(key: string, visibility: ObjectVisibility): Promise<void>;
+  /**
+   * Write object to the destination with the provided
+   * contents.
+   *
+   * @param key
+   * @param contents
+   * @param options
+   * @returns
+   */
   put(key: string, contents: string | Uint8Array | FileLike, options?: WriteOptions): Promise<void>;
+  /**
+   * Write object to the destination with the provided
+   * contents as a readable stream
+   *
+   * @param key
+   * @param contents
+   * @param options
+   * @returns
+   */
   putStream(key: string, contents: Readable, options?: WriteOptions): Promise<void>;
+  /**
+   * Copy the file from within the disk root location. Both
+   * the "source" and "destination" will be the key names
+   * and not absolute paths.
+   *
+   * @param source
+   * @param destination
+   * @param options
+   * @returns
+   */
   copy(source: string, destination: string, options?: WriteOptions): Promise<void>;
+  /**
+   * Move the file from within the disk root location. Both
+   * the "source" and "destination" will be the key names
+   * and not absolute paths.
+   *
+   * @param source
+   * @param destination
+   * @param options
+   * @returns
+   */
   move(source: string, destination: string, options?: WriteOptions): Promise<void>;
+  /**
+   * Delete the file for the given key. Should not throw
+   * error when file does not exist in first place
+   *
+   * @param key
+   * @returns
+   */
   delete(key: string): Promise<void>;
+  /**
+   * Delete the files and directories matching the provided prefix.
+   *
+   * @param prefix
+   * @returns
+   */
   deleteAll(prefix: string): Promise<void>;
+  /**
+   * The list all method must return an array of objects with
+   * the ability to paginate results (if supported).
+   *
+   * @param prefix
+   * @param options
+   * @returns
+   */
   listAll(prefix: string, options?: {
     recursive?: boolean;
     paginationToken?: string;
@@ -43,14 +293,151 @@ declare class Storage implements DriverContract {
     paginationToken?: string;
     objects: Iterable<DriveFile | DriveDirectory>;
   }>;
+  /**
+   * Switch bucket at runtime if supported.
+   *
+   * @param bucket
+   * @returns
+   */
   bucket(bucket: string): DriverContract;
+  /**
+   * Create symbolic links for all configured links in the application configuration.
+   *
+   * @param param0
+   */
   static link({
     force
   }?: {
     force?: boolean;
   }): void;
-  private driversMap;
 }
 //#endregion
-export { Storage };
-//# sourceMappingURL=index.d.ts.map
+//#region src/FtpDriver.d.ts
+declare class FtpDriver implements DriverContract {
+  private config;
+  constructor(config: string | {
+    host: string;
+    username: string;
+    password: string;
+    port?: number;
+    verbose?: boolean;
+    privateKey?: string;
+  });
+  getConfig(): {
+    host: string;
+    username: string;
+    password: string;
+    port?: number;
+    verbose?: boolean;
+    privateKey?: string;
+  };
+  private init;
+  private load;
+  /**
+   * Return a boolean value indicating if the file exists
+   * or not.
+   */
+  exists(key: string): Promise<boolean>;
+  /**
+   * Return the file contents as a UTF-8 string. Throw an exception
+   * if the file is missing.
+   */
+  get(key: string): Promise<string>;
+  /**
+   * Return the file contents as a Readable stream. Throw an exception
+   * if the file is missing.
+   */
+  getStream(key: string): Promise<Readable>;
+  /**
+   * Return the file contents as a Uint8Array. Throw an exception
+   * if the file is missing.
+   */
+  getBytes(key: string): Promise<Uint8Array>;
+  /**
+   * Return metadata of the file. Throw an exception
+   * if the file is missing.
+   */
+  getMetaData(key: string): Promise<ObjectMetaData>;
+  /**
+   * Return visibility of the file. Infer visibility from the initial
+   * config, when the driver does not support the concept of visibility.
+   */
+  getVisibility(key: string): Promise<ObjectVisibility>;
+  /**
+   * Return the public URL of the file. Throw an exception when the driver
+   * does not support generating URLs.
+   */
+  getUrl(key: string): Promise<string>;
+  /**
+   * Return the signed URL to serve a private file. Throw exception
+   * when the driver does not support generating URLs.
+   */
+  getSignedUrl(key: string, options?: SignedURLOptions): Promise<string>;
+  /**
+   * Return the signed/temporary URL that can be used to directly upload
+   * the file contents to the storage.
+   */
+  getSignedUploadUrl(key: string, options?: SignedURLOptions): Promise<string>;
+  /**
+   * Update the visibility of the file. Result in a NOOP
+   * when the driver does not support the concept of
+   * visibility.
+   */
+  setVisibility(key: string, visibility: ObjectVisibility): Promise<void>;
+  /**
+   * Create a new file or update an existing file. The contents
+   * will be a UTF-8 string or "Uint8Array".
+   */
+  put(key: string, contents: string | Uint8Array, options?: WriteOptions): Promise<void>;
+  /**
+   * Create a new file or update an existing file. The contents
+   * will be a Readable stream.
+   */
+  putStream(key: string, contents: Readable, options?: WriteOptions): Promise<void>;
+  /**
+   * Copy the existing file to the destination. Make sure the new file
+   * has the same visibility as the existing file. It might require
+   * manually fetching the visibility of the "source" file.
+   */
+  copy(source: string, destination: string, options?: WriteOptions): Promise<void>;
+  /**
+   * Move the existing file to the destination. Make sure the new file
+   * has the same visibility as the existing file. It might require
+   * manually fetching the visibility of the "source" file.
+   */
+  move(source: string, destination: string, options?: WriteOptions): Promise<void>;
+  /**
+   * Delete an existing file. Do not throw an error if the
+   * file is already missing
+   */
+  delete(key: string): Promise<void>;
+  /**
+   * Delete all files inside a folder. Do not throw an error
+   * if the folder does not exist or is empty.
+   */
+  deleteAll(prefix: string): Promise<void>;
+  /**
+   * Switch bucket at runtime if supported.
+   */
+  bucket(config: string | {
+    host: string;
+    username: string;
+    password: string;
+    port?: number;
+    verbose?: boolean;
+    privateKey?: string;
+  }): DriverContract;
+  /**
+   * List all files from a given folder or the root of the storage.
+   * Do not throw an error if the request folder does not exist.
+   */
+  listAll(prefix: string, options?: {
+    recursive?: boolean;
+    paginationToken?: string;
+  }): Promise<{
+    paginationToken?: string;
+    objects: Iterable<DriveFile | DriveDirectory>;
+  }>;
+}
+//#endregion
+export { CustomDiskConfig, CustomDiskDriverRegistry, DiskConfig, DriverConfig, FileLike, FilesystemConfig, FtpDriver, FtpDriverConfig, GcsDiskDriverConfig, KnownDisks, LocalDriverConfig, S3DriverConfig, Storage };

package/dist/index.js

@@ -1,2 +1,2 @@
-import { t as Storage } from "./src-wGEPrkk5.js";
-export { Storage };
+import { n as FtpDriver, t as Storage } from "./src-DNh_3BpA.js";
+export { FtpDriver, Storage };

package/dist/{src-wGEPrkk5.js → src-DNh_3BpA.js}

@@ -1,12 +1,14 @@
 import { DriveDirectory, DriveFile, DriveManager } from "flydrive";
-import { appUrl, config } from "@arkstack/common";
 import { createReadStream, createWriteStream, rmSync, symlinkSync } from "node:fs";
+import { Arkstack } from "@arkstack/contract";
 import { FSDriver } from "flydrive/drivers/fs";
 import Client from "ssh2-sftp-client";
 import { Readable } from "node:stream";
 import path from "node:path";
-import { Logger } from "@h3ravel/shared";
+import { GCSDriver } from "flydrive/drivers/gcs";
 import { S3Driver } from "flydrive/drivers/s3";
+import { appUrl, config } from "@arkstack/common";
+import { Logger } from "@h3ravel/shared";
 //#region src/FtpDriver.ts
 var FtpDriver = class FtpDriver {
 	config;
@@ -235,19 +237,112 @@ var FtpDriver = class FtpDriver {
 	}
 };
 //#endregion
-//#region src/index.ts
+//#region src/Driver.ts
+var Driver = class Driver {
+	config;
+	static customDrivers = /* @__PURE__ */ new Map();
+	constructor(config) {
+		this.config = config;
+	}
+	static make(config) {
+		const name = config.driver;
+		if (![
+			"local",
+			"ftp",
+			"s3",
+			"gcs"
+		].includes(name) && !this.customDrivers.has(name)) throw new Error(`Unsupported driver: ${name}`);
+		const driver = new Driver(config);
+		if (this.customDrivers.has(name)) return driver.custom(name);
+		return driver[name].call(driver);
+	}
+	local() {
+		const config = this.config;
+		return new FSDriver({
+			location: config.location ?? new URL(config.root, import.meta.url),
+			visibility: config.visibility ?? "public",
+			urlBuilder: {
+				async generateURL(key, _path) {
+					if (config.url) return `${config.url}/key`.replace(/^(https?:\/)\/+/, "$1/").replace(/([^:]\/)\/+/g, "$1");
+					return appUrl(key);
+				},
+				async generateSignedURL(key, _path, _opts) {
+					if (config.url) return `${config.url}/key`.replace(/^(https?:\/)\/+/, "$1/").replace(/([^:]\/)\/+/g, "$1");
+					return appUrl(key);
+				}
+			}
+		});
+	}
+	s3() {
+		const config = this.config;
+		return new S3Driver({
+			credentials: config.credentials ?? {
+				accessKeyId: config.key,
+				secretAccessKey: config.secret
+			},
+			endpoint: config.endpoint,
+			region: config.region,
+			bucket: config.bucket,
+			visibility: "private",
+			cdnUrl: config.cdnUrl ?? config.url
+		});
+	}
+	gcs() {
+		const { driver: _driver, ...options } = this.config;
+		return new GCSDriver(options);
+	}
+	ftp() {
+		const config = this.config;
+		return new FtpDriver({
+			host: config.host,
+			username: config.username,
+			password: config.password,
+			port: config.port,
+			verbose: config.verbose,
+			privateKey: config.privateKey
+		});
+	}
+	custom(name) {
+		if (!Driver.customDrivers.has(name)) throw new Error(`Unsupported driver: ${name} has not been registered`);
+		const DriverInstance = Driver.customDrivers.get(name);
+		if (typeof DriverInstance === "function") {
+			const config = this.config;
+			return new DriverInstance(config);
+		}
+		return DriverInstance;
+	}
+	/**
+	* Register a new custom driver
+	* 
+	* @param name 
+	* @param driver 
+	*/
+	static registerDriver(name, driver) {
+		Driver.customDrivers.set(name, driver);
+	}
+	/**
+	* Unregister a new custom driver
+	* 
+	* @param name 
+	*/
+	static removeDriver(name) {
+		Driver.customDrivers.delete(name);
+	}
+};
+//#endregion
+//#region src/Storage.ts
 var Storage = class Storage {
 	driver;
 	services = {};
 	diskName;
+	driverName;
 	constructor() {
-		for (const diskName in config("filesystem.disks")) {
-			const diskConfig = config("filesystem.disks")[diskName];
-			const driverFactory = this.driversMap[diskConfig.driver];
-			if (!driverFactory) throw new Error(`Unsupported driver: ${diskConfig.driver}`);
-			this.services[diskName] = () => driverFactory(diskConfig);
-		}
+		const disks = Object.entries(config("filesystem.disks", {}));
+		const customDrivers = config("filesystem.custom_drivers", {});
+		for (const [name, driver] of Object.entries(customDrivers)) Driver.registerDriver(name, driver);
+		for (const [disk, config] of disks) this.services[disk] = () => Driver.make(config);
 		this.diskName = config("filesystem.default");
+		this.driverName = config(`filesystem.disks.${this.diskName}.driver`);
 		this.driver = new DriveManager({
 			default: config("filesystem.default"),
 			services: this.services
@@ -263,6 +358,7 @@ var Storage = class Storage {
 		const storage = new Storage();
 		if (diskName) {
 			storage.diskName = diskName;
+			storage.driverName = config(`filesystem.disks.${diskName}.driver`);
 			storage.driver = new DriveManager({
 				default: diskName,
 				services: storage.services
@@ -306,10 +402,13 @@ var Storage = class Storage {
 		if (file instanceof File && !file.buffer) file.buffer = Buffer.from(await file.arrayBuffer());
 		await drive.put(path.join(filePath, name), file.buffer);
 		const url = await drive.getUrl(path.join(filePath, name));
-		return [url, this.diskName === "local" ? path.join(filePath, name) : url];
+		return [url, this.driverName === "local" ? path.join(filePath, name) : url];
 	};
 	/**
 	* Return a boolean indicating if the file exists
+	* 
+	* @param key 
+	* @returns 
 	*/
 	exists(key) {
 		return this.driver.use().exists(key);
@@ -318,14 +417,44 @@ var Storage = class Storage {
 	* Return contents of a object for the given key as a UTF-8 string.
 	* Should throw "E_CANNOT_READ_FILE" error when the file
 	* does not exists.
+	* 
+	* @param key 
+	* @returns 
 	*/
 	get(key) {
 		return this.driver.use().get(key);
 	}
 	/**
+	* Get the name of the disk currently in use.
+	* 
+	* @returns 
+	*/
+	getDiskName() {
+		return this.diskName;
+	}
+	/**
+	* Get the name of the driver currently in use.
+	* 
+	* @returns 
+	*/
+	getDriverName() {
+		return this.driverName;
+	}
+	/**
+	* Get the driver currently in use.
+	* 
+	* @returns 
+	*/
+	getDriver() {
+		return this.driver;
+	}
+	/**
 	* Return contents of a object for the given key as a Readable stream.
 	* Should throw "E_CANNOT_READ_FILE" error when the file
 	* does not exists.
+	* 
+	* @param key 
+	* @returns 
 	*/
 	getStream(key) {
 		return this.driver.use().getStream(key);
@@ -334,30 +463,46 @@ var Storage = class Storage {
 	* Return contents of an object for the given key as an Uint8Array.
 	* Should throw "E_CANNOT_READ_FILE" error when the file
 	* does not exists.
+	* 
+	* @param key 
+	* @returns 
 	*/
 	getBytes(key) {
 		return this.driver.use().getBytes(key);
 	}
 	/**
 	* Return metadata of an object for the given key.
+	* 
+	* @param key 
+	* @returns 
 	*/
 	getMetaData(key) {
 		return this.driver.use().getMetaData(key);
 	}
 	/**
 	* Return the visibility of the file
+	* 
+	* @param key 
+	* @returns 
 	*/
 	getVisibility(key) {
 		return this.driver.use().getVisibility(key);
 	}
 	/**
 	* Return the public URL to access the file
+	* 
+	* @param key 
+	* @returns 
 	*/
 	getUrl(key) {
 		return this.driver.use().getUrl(key);
 	}
 	/**
 	* Return the signed/temporary URL to access the file
+	* 
+	* @param key 
+	* @param options 
+	* @returns 
 	*/
 	getSignedUrl(key, options) {
 		return this.driver.use().getSignedUrl(key, options);
@@ -365,12 +510,20 @@ var Storage = class Storage {
 	/**
 	* Return the signed/temporary URL that can be used to directly upload
 	* the file contents to the storage.
+	* 
+	* @param key 
+	* @param options 
+	* @returns 
 	*/
 	getSignedUploadUrl(key, options) {
 		return this.driver.use().getSignedUploadUrl(key, options);
 	}
 	/**
 	* Update the visibility of the file
+	* 
+	* @param key 
+	* @param visibility 
+	* @returns 
 	*/
 	setVisibility(key, visibility) {
 		return this.driver.use().setVisibility(key, visibility);
@@ -378,6 +531,11 @@ var Storage = class Storage {
 	/**
 	* Write object to the destination with the provided
 	* contents.
+	* 
+	* @param key 
+	* @param contents 
+	* @param options 
+	* @returns 
 	*/
 	put(key, contents, options) {
 		if (!(contents instanceof Uint8Array) && typeof contents !== "string") contents = contents.buffer;
@@ -386,6 +544,11 @@ var Storage = class Storage {
 	/**
 	* Write object to the destination with the provided
 	* contents as a readable stream
+	* 
+	* @param key 
+	* @param contents 
+	* @param options 
+	* @returns 
 	*/
 	putStream(key, contents, options) {
 		return this.driver.use().putStream(key, contents, options);
@@ -394,6 +557,11 @@ var Storage = class Storage {
 	* Copy the file from within the disk root location. Both
 	* the "source" and "destination" will be the key names
 	* and not absolute paths.
+	* 
+	* @param source 
+	* @param destination 
+	* @param options 
+	* @returns 
 	*/
 	copy(source, destination, options) {
 		return this.driver.use().copy(source, destination, options);
@@ -402,6 +570,11 @@ var Storage = class Storage {
 	* Move the file from within the disk root location. Both
 	* the "source" and "destination" will be the key names
 	* and not absolute paths.
+	* 
+	* @param source 
+	* @param destination 
+	* @param options 
+	* @returns 
 	*/
 	move(source, destination, options) {
 		return this.driver.use().move(source, destination, options);
@@ -409,12 +582,18 @@ var Storage = class Storage {
 	/**
 	* Delete the file for the given key. Should not throw
 	* error when file does not exist in first place
+	* 
+	* @param key 
+	* @returns 
 	*/
 	delete(key) {
 		return this.driver.use().delete(key);
 	}
 	/**
 	* Delete the files and directories matching the provided prefix.
+	* 
+	* @param prefix 
+	* @returns 
 	*/
 	deleteAll(prefix) {
 		return this.driver.use().deleteAll(prefix);
@@ -422,24 +601,33 @@ var Storage = class Storage {
 	/**
 	* The list all method must return an array of objects with
 	* the ability to paginate results (if supported).
+	* 
+	* @param prefix 
+	* @param options 
+	* @returns 
 	*/
 	listAll(prefix, options) {
 		return this.driver.use().listAll(prefix, options);
 	}
 	/**
 	* Switch bucket at runtime if supported.
+	* 
+	* @param bucket 
+	* @returns 
 	*/
 	bucket(bucket) {
 		return this.driver.use().bucket(bucket);
 	}
 	/**
 	* Create symbolic links for all configured links in the application configuration.
+	* 
+	* @param param0 
 	*/
 	static link({ force = false } = {}) {
 		for (const link in config("filesystem.links")) {
 			const target = config("filesystem.links")[link];
-			const unlink = link.replace(process.cwd(), "");
-			const untarget = target.replace(process.cwd(), "");
+			const unlink = link.replace(Arkstack.rootDir(), "");
+			const untarget = target.replace(Arkstack.rootDir(), "");
 			try {
 				if (force) rmSync(link, {
 					recursive: true,
@@ -470,41 +658,6 @@ var Storage = class Storage {
 			}
 		}
 	}
-	driversMap = {
-		local: (conf) => new FSDriver({
-			location: new URL(conf.root, import.meta.url),
-			visibility: "public",
-			urlBuilder: {
-				async generateURL(key, _path) {
-					return appUrl(key);
-				},
-				async generateSignedURL(key, _path, _opts) {
-					return appUrl(key);
-				}
-			}
-		}),
-		s3: (conf) => new S3Driver({
-			credentials: {
-				accessKeyId: conf.key,
-				secretAccessKey: conf.secret
-			},
-			endpoint: conf.endpoint,
-			region: conf.region,
-			bucket: conf.bucket,
-			visibility: "private",
-			cdnUrl: conf.url
-		}),
-		ftp: (conf) => new FtpDriver({
-			host: conf.host,
-			username: conf.username,
-			password: conf.password,
-			port: conf.port,
-			verbose: conf.verbose,
-			privateKey: conf.privateKey
-		})
-	};
 };
 //#endregion
-export { Storage as t };
-
-//# sourceMappingURL=src-wGEPrkk5.js.map
+export { FtpDriver as n, Storage as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/filesystem",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "type": "module",
   "description": "Filesystem module for Arkstack, providing shared file storage and filesystem utitlities for the framework.",
   "homepage": "https://arkstack.toneflix.net",
@@ -31,16 +31,17 @@
     "./package.json": "./package.json"
   },
   "peerDependencies": {
-    "@h3ravel/musket": "^0.10.1"
+    "@h3ravel/musket": "^2.2.1"
   },
   "dependencies": {
-    "@h3ravel/shared": "^0.27.13",
+    "@h3ravel/shared": "^2.1.3",
+    "@google-cloud/storage": "^7.21.0",
     "@aws-sdk/client-s3": "^3.1011.0",
     "@aws-sdk/s3-request-presigner": "^3.1011.0",
     "flydrive": "^2.0.0",
     "ssh2-sftp-client": "^12.1.0",
-    "@arkstack/common": "^0.5.2",
-    "@arkstack/contract": "^0.5.2"
+    "@arkstack/common": "^0.5.3",
+    "@arkstack/contract": "^0.5.3"
   },
   "devDependencies": {
     "@types/ssh2-sftp-client": "^9.0.6"

package/dist/commands/StorageLinkCommand.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"StorageLinkCommand.js","names":[],"sources":["../../src/commands/StorageLinkCommand.ts"],"sourcesContent":["import { Command } from '@h3ravel/musket'\nimport { Storage } from '../'\n\nexport class StorageLinkCommand extends Command {\n    protected signature = `storage:link\n        {--force : Remove existing links before creating new ones.}\n    `\n    protected description = 'Create symbolic links for filesystem.links configuration.'\n\n    async handle () {\n        Storage.link(this.options())\n    }\n}"],"mappings":";;;AAGA,IAAa,qBAAb,cAAwC,QAAQ;CAC5C,YAAsB;;;CAGtB,cAAwB;CAExB,MAAM,SAAU;EACZ,QAAQ,KAAK,KAAK,SAAS,CAAC"}

package/dist/src-wGEPrkk5.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"src-wGEPrkk5.js","names":[],"sources":["../src/FtpDriver.ts","../src/index.ts"],"sourcesContent":["import { DriveDirectory, DriveFile } from 'flydrive'\nimport type {\n    DriverContract,\n    ObjectMetaData,\n    ObjectVisibility,\n    SignedURLOptions,\n    WriteOptions,\n} from 'flydrive/types'\nimport { createReadStream, createWriteStream } from 'node:fs'\n\nimport Client from 'ssh2-sftp-client'\nimport { Readable } from 'node:stream'\nimport path from 'node:path'\n\nexport class FtpDriver implements DriverContract {\n    private config: {\n        host: string\n        username: string\n        password: string\n        port?: number\n        verbose?: boolean\n        privateKey?: string\n    }\n\n    constructor(config: string | {\n        host: string\n        username: string\n        password: string\n        port?: number\n        verbose?: boolean\n        privateKey?: string\n    }) {\n        if (typeof config === 'string') {\n            const url = new URL(config)\n\n            this.config = {\n                host: url.hostname,\n                username: url.username,\n                password: url.password,\n                port: url.port ? parseInt(url.port, 10) : 22,\n                verbose: url.searchParams.get('verbose') === 'true',\n            }\n        } else {\n            this.config = config\n        }\n    }\n\n    getConfig () {\n        return this.config\n    }\n\n    private async init () {\n        const client = new Client()\n\n        await client.connect({\n            host: this.config.host,\n            username: this.config.username,\n            password: this.config.password,\n            port: this.config.port || 22,\n        })\n\n        return client\n    }\n\n    private async load<T> (handle: (client: Client) => Promise<T>): Promise<T> {\n        const client = await this.init()\n\n        try {\n            return await handle(client)\n        } catch (e) {\n            if (this.config.verbose) {\n                throw e\n            }\n        } finally {\n            await client.end()\n        }\n\n        return null as any\n    }\n\n    /**\n     * Return a boolean value indicating if the file exists\n     * or not.\n     */\n    async exists (key: string): Promise<boolean> {\n        const client = await this.load((client) => {\n            return client.stat(key)\n        }).catch(() => {\n            return null\n        })\n\n        return !!client\n    }\n\n    /**\n     * Return the file contents as a UTF-8 string. Throw an exception\n     * if the file is missing.\n     */\n    async get (key: string): Promise<string> {\n        const stream = await this.getStream(key)\n\n        const chunks: Uint8Array[] = []\n        for await (const chunk of stream) {\n            chunks.push(chunk)\n        }\n\n        return Buffer.concat(chunks).toString('utf-8')\n    }\n\n    /**\n     * Return the file contents as a Readable stream. Throw an exception\n     * if the file is missing.\n     */\n    async getStream (key: string): Promise<Readable> {\n        const dst = createWriteStream('/tmp/' + path.basename(key))\n        await this.load((client) => {\n            return client.get(key, dst)\n        }).catch(() => {\n            return null\n        })\n\n        return createReadStream('/tmp/' + path.basename(key))\n    }\n\n    /**\n     * Return the file contents as a Uint8Array. Throw an exception\n     * if the file is missing.\n     */\n    async getBytes (key: string): Promise<Uint8Array> {\n        const content = await this.get(key)\n\n        return new Uint8Array(Buffer.from(content, 'utf-8'))\n    }\n\n    /**\n     * Return metadata of the file. Throw an exception\n     * if the file is missing.\n     */\n    async getMetaData (key: string): Promise<ObjectMetaData> {\n        const stat = await this.load((client) => {\n            return client.stat(key)\n        }).catch(() => {\n            return null\n        })\n\n        if (!stat) {\n            throw new Error('E_CANNOT_READ_FILE')\n        }\n\n        return {\n            contentType: undefined,\n            contentLength: stat.size,\n            etag: key,\n            lastModified: new Date(stat.modifyTime),\n        }\n    }\n\n    /**\n     * Return visibility of the file. Infer visibility from the initial\n     * config, when the driver does not support the concept of visibility.\n     */\n    async getVisibility (key: string): Promise<ObjectVisibility> {\n        void key\n\n        return 'private'\n    }\n\n    /**\n     * Return the public URL of the file. Throw an exception when the driver\n     * does not support generating URLs.\n     */\n    async getUrl (key: string): Promise<string> {\n        void key\n        throw new Error('E_URL_GENERATION_UNSUPPORTED')\n    }\n\n    /**\n     * Return the signed URL to serve a private file. Throw exception\n     * when the driver does not support generating URLs.\n     */\n    async getSignedUrl (key: string, options?: SignedURLOptions): Promise<string> {\n        void key\n        void options\n        throw new Error('E_URL_GENERATION_UNSUPPORTED')\n    }\n    /**\n     * Return the signed/temporary URL that can be used to directly upload\n     * the file contents to the storage.\n     */\n    async getSignedUploadUrl (key: string, options?: SignedURLOptions): Promise<string> {\n        void key\n        void options\n        throw new Error('E_URL_GENERATION_UNSUPPORTED')\n    }\n\n    /**\n     * Update the visibility of the file. Result in a NOOP\n     * when the driver does not support the concept of\n     * visibility.\n     */\n    async setVisibility (key: string, visibility: ObjectVisibility): Promise<void> {\n        void key\n        void visibility\n    }\n\n    /**\n     * Create a new file or update an existing file. The contents\n     * will be a UTF-8 string or \"Uint8Array\".\n     */\n    async put (key: string, contents: string | Uint8Array, options?: WriteOptions): Promise<void> {\n        if (contents instanceof Uint8Array) {\n            contents = Buffer.from(contents)\n        }\n\n        const stream = Readable.from(contents)\n\n        await this.putStream(key, stream, options)\n    }\n\n    /**\n     * Create a new file or update an existing file. The contents\n     * will be a Readable stream.\n     */\n    async putStream (key: string, contents: Readable, options?: WriteOptions): Promise<void> {\n        const dst = createWriteStream('/tmp/' + path.basename(key), {\n            encoding: options?.contentEncoding as never || 'utf-8',\n        })\n\n        await new Promise((resolve, reject) => {\n            contents.pipe(dst)\n            contents.on('error', reject)\n            dst.on('finish', resolve)\n            dst.on('error', reject)\n        })\n\n        await this.load((client) => {\n            return client.put('/tmp/' + path.basename(key), key)\n        })\n    }\n\n    /**\n     * Copy the existing file to the destination. Make sure the new file\n     * has the same visibility as the existing file. It might require\n     * manually fetching the visibility of the \"source\" file.\n     */\n    async copy (source: string, destination: string, options?: WriteOptions): Promise<void> {\n        void options\n        await this.load((client) => {\n            return client.rcopy(source, destination)\n        })\n    }\n\n    /**\n     * Move the existing file to the destination. Make sure the new file\n     * has the same visibility as the existing file. It might require\n     * manually fetching the visibility of the \"source\" file.\n     */\n    async move (source: string, destination: string, options?: WriteOptions): Promise<void> {\n        void options\n        await this.load((client) => {\n            return client.rename(source, destination)\n        })\n    }\n\n    /**\n     * Delete an existing file. Do not throw an error if the\n     * file is already missing\n     */\n    async delete (key: string): Promise<void> {\n        await this.load((client) => {\n            return client.delete(key)\n        }).catch(() => {\n            return null\n        })\n    }\n\n    /**\n     * Delete all files inside a folder. Do not throw an error\n     * if the folder does not exist or is empty.\n     */\n    async deleteAll (prefix: string): Promise<void> {\n        await this.load((client) => {\n            return client.rmdir(prefix, true)\n        }).catch(() => {\n            return null\n        })\n    }\n\n\n    /**\n     * Switch bucket at runtime if supported.\n     */\n    bucket (config: string | {\n        host: string\n        username: string\n        password: string\n        port?: number\n        verbose?: boolean\n        privateKey?: string\n    }): DriverContract {\n        return new FtpDriver(config)\n    }\n\n    /**\n     * List all files from a given folder or the root of the storage.\n     * Do not throw an error if the request folder does not exist.\n     */\n    async listAll (\n        prefix: string,\n        options?: {\n            recursive?: boolean\n            paginationToken?: string\n        }\n    ): Promise<{\n        paginationToken?: string\n        objects: Iterable<DriveFile | DriveDirectory>\n    }> {\n        void options\n\n        const data = await this.load((client) => {\n            return client.list(prefix)\n        }).catch(() => {\n            return null\n        })\n\n        return data ? {\n            objects: data.map((file) => {\n                if (file.type === 'd') {\n                    return new DriveDirectory(file.name)\n                } else {\n                    return new DriveFile(file.name, this, {\n                        contentType: undefined,\n                        contentLength: file.size,\n                        etag: file.name,\n                        lastModified: new Date(file.modifyTime),\n                    })\n                }\n            })\n        } : { objects: [] }\n    }\n\n}\n","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":";;;;;;;;;;AAcA,IAAa,YAAb,MAAa,UAAoC;CAC7C;CASA,YAAY,QAOT;EACC,IAAI,OAAO,WAAW,UAAU;GAC5B,MAAM,MAAM,IAAI,IAAI,OAAO;GAE3B,KAAK,SAAS;IACV,MAAM,IAAI;IACV,UAAU,IAAI;IACd,UAAU,IAAI;IACd,MAAM,IAAI,OAAO,SAAS,IAAI,MAAM,GAAG,GAAG;IAC1C,SAAS,IAAI,aAAa,IAAI,UAAU,KAAK;IAChD;SAED,KAAK,SAAS;;CAItB,YAAa;EACT,OAAO,KAAK;;CAGhB,MAAc,OAAQ;EAClB,MAAM,SAAS,IAAI,QAAQ;EAE3B,MAAM,OAAO,QAAQ;GACjB,MAAM,KAAK,OAAO;GAClB,UAAU,KAAK,OAAO;GACtB,UAAU,KAAK,OAAO;GACtB,MAAM,KAAK,OAAO,QAAQ;GAC7B,CAAC;EAEF,OAAO;;CAGX,MAAc,KAAS,QAAoD;EACvE,MAAM,SAAS,MAAM,KAAK,MAAM;EAEhC,IAAI;GACA,OAAO,MAAM,OAAO,OAAO;WACtB,GAAG;GACR,IAAI,KAAK,OAAO,SACZ,MAAM;YAEJ;GACN,MAAM,OAAO,KAAK;;EAGtB,OAAO;;;;;;CAOX,MAAM,OAAQ,KAA+B;EAOzC,OAAO,CAAC,CAAC,MANY,KAAK,MAAM,WAAW;GACvC,OAAO,OAAO,KAAK,IAAI;IACzB,CAAC,YAAY;GACX,OAAO;IACT;;;;;;CASN,MAAM,IAAK,KAA8B;EACrC,MAAM,SAAS,MAAM,KAAK,UAAU,IAAI;EAExC,MAAM,SAAuB,EAAE;EAC/B,WAAW,MAAM,SAAS,QACtB,OAAO,KAAK,MAAM;EAGtB,OAAO,OAAO,OAAO,OAAO,CAAC,SAAS,QAAQ;;;;;;CAOlD,MAAM,UAAW,KAAgC;EAC7C,MAAM,MAAM,kBAAkB,UAAU,KAAK,SAAS,IAAI,CAAC;EAC3D,MAAM,KAAK,MAAM,WAAW;GACxB,OAAO,OAAO,IAAI,KAAK,IAAI;IAC7B,CAAC,YAAY;GACX,OAAO;IACT;EAEF,OAAO,iBAAiB,UAAU,KAAK,SAAS,IAAI,CAAC;;;;;;CAOzD,MAAM,SAAU,KAAkC;EAC9C,MAAM,UAAU,MAAM,KAAK,IAAI,IAAI;EAEnC,OAAO,IAAI,WAAW,OAAO,KAAK,SAAS,QAAQ,CAAC;;;;;;CAOxD,MAAM,YAAa,KAAsC;EACrD,MAAM,OAAO,MAAM,KAAK,MAAM,WAAW;GACrC,OAAO,OAAO,KAAK,IAAI;IACzB,CAAC,YAAY;GACX,OAAO;IACT;EAEF,IAAI,CAAC,MACD,MAAM,IAAI,MAAM,qBAAqB;EAGzC,OAAO;GACH,aAAa,KAAA;GACb,eAAe,KAAK;GACpB,MAAM;GACN,cAAc,IAAI,KAAK,KAAK,WAAW;GAC1C;;;;;;CAOL,MAAM,cAAe,KAAwC;EAGzD,OAAO;;;;;;CAOX,MAAM,OAAQ,KAA8B;EAExC,MAAM,IAAI,MAAM,+BAA+B;;;;;;CAOnD,MAAM,aAAc,KAAa,SAA6C;EAG1E,MAAM,IAAI,MAAM,+BAA+B;;;;;;CAMnD,MAAM,mBAAoB,KAAa,SAA6C;EAGhF,MAAM,IAAI,MAAM,+BAA+B;;;;;;;CAQnD,MAAM,cAAe,KAAa,YAA6C;;;;;CAS/E,MAAM,IAAK,KAAa,UAA+B,SAAuC;EAC1F,IAAI,oBAAoB,YACpB,WAAW,OAAO,KAAK,SAAS;EAGpC,MAAM,SAAS,SAAS,KAAK,SAAS;EAEtC,MAAM,KAAK,UAAU,KAAK,QAAQ,QAAQ;;;;;;CAO9C,MAAM,UAAW,KAAa,UAAoB,SAAuC;EACrF,MAAM,MAAM,kBAAkB,UAAU,KAAK,SAAS,IAAI,EAAE,EACxD,UAAU,SAAS,mBAA4B,SAClD,CAAC;EAEF,MAAM,IAAI,SAAS,SAAS,WAAW;GACnC,SAAS,KAAK,IAAI;GAClB,SAAS,GAAG,SAAS,OAAO;GAC5B,IAAI,GAAG,UAAU,QAAQ;GACzB,IAAI,GAAG,SAAS,OAAO;IACzB;EAEF,MAAM,KAAK,MAAM,WAAW;GACxB,OAAO,OAAO,IAAI,UAAU,KAAK,SAAS,IAAI,EAAE,IAAI;IACtD;;;;;;;CAQN,MAAM,KAAM,QAAgB,aAAqB,SAAuC;EAEpF,MAAM,KAAK,MAAM,WAAW;GACxB,OAAO,OAAO,MAAM,QAAQ,YAAY;IAC1C;;;;;;;CAQN,MAAM,KAAM,QAAgB,aAAqB,SAAuC;EAEpF,MAAM,KAAK,MAAM,WAAW;GACxB,OAAO,OAAO,OAAO,QAAQ,YAAY;IAC3C;;;;;;CAON,MAAM,OAAQ,KAA4B;EACtC,MAAM,KAAK,MAAM,WAAW;GACxB,OAAO,OAAO,OAAO,IAAI;IAC3B,CAAC,YAAY;GACX,OAAO;IACT;;;;;;CAON,MAAM,UAAW,QAA+B;EAC5C,MAAM,KAAK,MAAM,WAAW;GACxB,OAAO,OAAO,MAAM,QAAQ,KAAK;IACnC,CAAC,YAAY;GACX,OAAO;IACT;;;;;CAON,OAAQ,QAOW;EACf,OAAO,IAAI,UAAU,OAAO;;;;;;CAOhC,MAAM,QACF,QACA,SAOD;EAGC,MAAM,OAAO,MAAM,KAAK,MAAM,WAAW;GACrC,OAAO,OAAO,KAAK,OAAO;IAC5B,CAAC,YAAY;GACX,OAAO;IACT;EAEF,OAAO,OAAO,EACV,SAAS,KAAK,KAAK,SAAS;GACxB,IAAI,KAAK,SAAS,KACd,OAAO,IAAI,eAAe,KAAK,KAAK;QAEpC,OAAO,IAAI,UAAU,KAAK,MAAM,MAAM;IAClC,aAAa,KAAA;IACb,eAAe,KAAK;IACpB,MAAM,KAAK;IACX,cAAc,IAAI,KAAK,KAAK,WAAW;IAC1C,CAAC;IAER,EACL,GAAG,EAAE,SAAS,EAAE,EAAE;;;;;AChU3B,IAAa,UAAb,MAAa,QAAkC;CAC3C;CACA,WAAiD,EAAE;CACnD;CAEA,cAAc;EACV,KAAK,MAAM,YAAY,OAAO,mBAAmB,EAAE;GAC/C,MAAM,aAAa,OAAO,mBAAmB,CAAC;GAC9C,MAAM,gBAAgB,KAAK,WAAW,WAAW;GAEjD,IAAI,CAAC,eACD,MAAM,IAAI,MAAM,uBAAuB,WAAW,SAAS;GAG/D,KAAK,SAAS,kBAAkB,cAAc,WAAW;;EAG7D,KAAK,WAAW,OAAO,qBAAqB;EAC5C,KAAK,SAAS,IAAI,aAAa;GAC3B,SAAS,OAAO,qBAAqB;GACrC,UAAU,KAAK;GAClB,CAAC;;;;;;;;CASN,OAAO,KAAwB,UAAuB;EAClD,MAAM,UAAU,IAAI,SAAS;EAE7B,IAAI,UAAU;GACV,QAAQ,WAAW;GACnB,QAAQ,SAAS,IAAI,aAAa;IAC9B,SAAS;IACT,UAAU,QAAQ;IACrB,CAAC;;EAGN,OAAO;;;;;;;;CASX,OAAO,gBAAgB,SAA2D;EAC9E,MAAM,OAAO,KAAK,gBAAgB,KAAK,QAAQ;EAE/C,IAAI,OAAO,OAAO,+BAA+B,KAAK,YAClD,OAAO,OAAO,+BAA+B,CAAC,KAAK;EAGvD,OAAO,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;EAC5B,OAAO,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;EAE/B,IAAI,gBAAgB,QAAQ,CAAC,KAAK,QAC9B,KAAK,SAAS,OAAO,KAAK,MAAM,KAAK,aAAa,CAAC;EAGvD,MAAM,MAAM,IAAI,KAAK,KAAK,UAAU,KAAK,EAAE,KAAK,OAAO;EAEvD,MAAM,MAAM,MAAM,MAAM,OAAO,KAAK,KAAK,UAAU,KAAK,CAAC;EAGzD,OAAO,CAAC,KAFI,KAAK,aAAa,UAAU,KAAK,KAAK,UAAU,KAAK,GAAG,IAEnD;;;;;CAMrB,OAAQ,KAA+B;EACnC,OAAO,KAAK,OAAO,KAAK,CAAC,OAAO,IAAI;;;;;;;CAOxC,IAAK,KAA8B;EAC/B,OAAO,KAAK,OAAO,KAAK,CAAC,IAAI,IAAI;;;;;;;CAOrC,UAAW,KAAgC;EACvC,OAAO,KAAK,OAAO,KAAK,CAAC,UAAU,IAAI;;;;;;;CAO3C,SAAU,KAAkC;EACxC,OAAO,KAAK,OAAO,KAAK,CAAC,SAAS,IAAI;;;;;CAK1C,YAAa,KAAsC;EAC/C,OAAO,KAAK,OAAO,KAAK,CAAC,YAAY,IAAI;;;;;CAK7C,cAAe,KAAwC;EACnD,OAAO,KAAK,OAAO,KAAK,CAAC,cAAc,IAAI;;;;;CAK/C,OAAQ,KAA8B;EAClC,OAAO,KAAK,OAAO,KAAK,CAAC,OAAO,IAAI;;;;;CAKxC,aAAc,KAAa,SAA6C;EACpE,OAAO,KAAK,OAAO,KAAK,CAAC,aAAa,KAAK,QAAQ;;;;;;CAMvD,mBAAoB,KAAa,SAA6C;EAC1E,OAAO,KAAK,OAAO,KAAK,CAAC,mBAAmB,KAAK,QAAQ;;;;;CAK7D,cAAe,KAAa,YAA6C;EACrE,OAAO,KAAK,OAAO,KAAK,CAAC,cAAc,KAAK,WAAW;;;;;;CAM3D,IAAK,KAAa,UAA0C,SAAuC;EAC/F,IAAI,EAAE,oBAAoB,eAAe,OAAO,aAAa,UACzD,WAAW,SAAS;EAGxB,OAAO,KAAK,OAAO,KAAK,CAAC,IAAI,KAAK,UAAU,QAAQ;;;;;;CAMxD,UAAW,KAAa,UAAoB,SAAuC;EAC/E,OAAO,KAAK,OAAO,KAAK,CAAC,UAAU,KAAK,UAAU,QAAQ;;;;;;;CAO9D,KAAM,QAAgB,aAAqB,SAAuC;EAC9E,OAAO,KAAK,OAAO,KAAK,CAAC,KAAK,QAAQ,aAAa,QAAQ;;;;;;;CAO/D,KAAM,QAAgB,aAAqB,SAAuC;EAC9E,OAAO,KAAK,OAAO,KAAK,CAAC,KAAK,QAAQ,aAAa,QAAQ;;;;;;CAM/D,OAAQ,KAA4B;EAChC,OAAO,KAAK,OAAO,KAAK,CAAC,OAAO,IAAI;;;;;CAKxC,UAAW,QAA+B;EACtC,OAAO,KAAK,OAAO,KAAK,CAAC,UAAU,OAAO;;;;;;CAM9C,QAAS,QAAgB,SAMtB;EACC,OAAO,KAAK,OAAO,KAAK,CAAC,QAAQ,QAAQ,QAAQ;;;;;CAKrD,OAAQ,QAAgC;EACpC,OAAQ,KAAK,OAAO,KAAK,CAAS,OAAO,OAAO;;;;;CAMpD,OAAO,KAAM,EAAE,QAAQ,UAA+B,EAAE,EAAQ;EAC5D,KAAK,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;GAElD,IAAI;IACA,IAAI,OAAO,OAAO,MAAM;KAAE,WAAW;KAAM,OAAO;KAAM,CAAC;IACzD,YAAY,QAAQ,KAAK;IAEzB,OAAO,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;IACjB,IAAI,MAAM,SAAS,UACf,OAAO,IAAI;KACP,CAAC,UAAU,SAAS;KACpB,CAAC,IAAI,OAAO,IAAI,QAAQ;KACxB,CAAC,wBAAwB,QAAQ;KACjC,CAAC,IAAI,SAAS,KAAK,QAAQ;KAC9B,EAAE,IAAI;SAEP,OAAO,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,aAAoF;EAChF,QAAQ,SAA8B,IAAI,SAAS;GAC/C,UAAU,IAAI,IAAI,KAAK,MAAM,OAAO,KAAK,IAAI;GAC7C,YAAY;GACZ,YAAY;IACR,MAAM,YAAa,KAAa,OAAe;KAC3C,OAAO,OAAO,IAAI;;IAGtB,MAAM,kBAAmB,KAAa,OAAe,OAAyB;KAC1E,OAAO,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"}