@arkstack/filesystem 0.12.21 → 0.12.23

package/dist/commands/StorageLinkCommand.js

@@ -1,4 +1,4 @@
-import { t as Storage } from "../src-Cj4wZApu.js";
+import { t as Storage } from "../src-DX_iPdpM.js";
 import { Command } from "@h3ravel/musket";
 //#region src/commands/StorageLinkCommand.ts
 var StorageLinkCommand = class extends Command {

package/dist/index.d.ts

@@ -46,7 +46,7 @@ type CustomDiskConfig = keyof CustomDiskDriverRegistry extends never ? {
   driver: K;
 } }[keyof CustomDiskDriverRegistry];
 type DiskConfig = LocalDriverConfig & {
-  driver: 'local';
+  driver: 'local' | 'public';
 } | FtpDriverConfig & {
   driver: 'ftp';
 } | S3DriverConfig & {
@@ -76,10 +76,11 @@ interface FilesystemConfig {
 }
 //#endregion
 //#region src/Storage.d.ts
-declare class Storage implements DriverContract {
+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 method to get a disk instance directly from the Storage class without needing to instantiate it first.
@@ -87,7 +88,7 @@ declare class Storage implements DriverContract {
    * @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 string>(diskName?: K): Storage;
+  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
    *
@@ -118,85 +119,166 @@ declare class Storage implements DriverContract {
   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;
@@ -207,10 +289,15 @@ declare class Storage implements DriverContract {
   }>;
   /**
    * 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

package/dist/index.js

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

package/dist/{src-Cj4wZApu.js → src-DX_iPdpM.js}

@@ -243,7 +243,8 @@ var Driver = class Driver {
 	constructor(config) {
 		this.config = config;
 	}
-	static make(name, config) {
+	static make(config) {
+		const name = config.driver;
 		if (![
 			"local",
 			"ftp",
@@ -326,12 +327,14 @@ var Storage = class Storage {
 	driver;
 	services = {};
 	diskName;
+	driverName;
 	constructor() {
 		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, conf] of disks) this.services[disk] = () => Driver.make(disk, conf);
+		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
@@ -347,6 +350,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
@@ -390,10 +394,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);
@@ -402,14 +409,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);
@@ -418,30 +455,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);
@@ -449,12 +502,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);
@@ -462,6 +523,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;
@@ -470,6 +536,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);
@@ -478,6 +549,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);
@@ -486,6 +562,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);
@@ -493,12 +574,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);
@@ -506,18 +593,27 @@ 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")) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/filesystem",
-  "version": "0.12.21",
+  "version": "0.12.23",
   "type": "module",
   "description": "Filesystem module for Arkstack, providing shared file storage and filesystem utitlities for the framework.",
   "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.12.21",
-    "@arkstack/contract": "^0.12.21"
+    "@arkstack/common": "^0.12.23",
+    "@arkstack/contract": "^0.12.23"
   },
   "devDependencies": {
     "@types/ssh2-sftp-client": "^9.0.6"