@arkstack/filesystem 0.19.1 → 0.19.3

package/README.md

@@ -11,8 +11,8 @@ Filesystem module for Arkstack, providing shared file storage and filesystem uti
 **CloudinaryFileDriver.ts**
 
 ```ts
-import type { DriverContract, ObjectVisibility } from 'flydrive/types';
-import type { CustomDiskConfig } from '@arkstack/filesystem';
+import type { DriverContract, ObjectVisibility } from 'flydrive/types'
+import type { CustomDiskConfig } from '@arkstack/filesystem'
 
 export class CloudinaryFileDriver implements DriverContract {
   constructor(private config?: CustomDiskConfig) {}
@@ -40,7 +40,7 @@ export class CloudinaryFileDriver implements DriverContract {
 **src/config/filesystem.ts**
 
 ```ts
-import { CloudinaryFileDriver } from '../CloudinaryFileDriver';
+import { CloudinaryFileDriver } from '../CloudinaryFileDriver'
 export default () => {
   return {
     default: 'images',
@@ -54,8 +54,8 @@ export default () => {
     custom_drivers: {
       cloudinary: CloudinaryFileDriver,
     },
-  };
-};
+  }
+}
 ```
 
 To improve type safety and auto complete, you may augment the `CustomDiskDriverRegistry`
@@ -65,7 +65,7 @@ To improve type safety and auto complete, you may augment the `CustomDiskDriverR
 ```ts
 declare module '@arkstack/filesystem' {
   interface CustomDiskDriverRegistry {
-    cloudinary: { cloud_name: string; api_key: string; api_secret: string };
+    cloudinary: { cloud_name: string; api_key: string; api_secret: string }
   }
 }
 ```

package/dist/commands/StorageLinkCommand.js

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

package/dist/index.d.ts

@@ -47,13 +47,13 @@ type CustomDiskConfig = keyof CustomDiskDriverRegistry extends never ? {
 } : { [K in keyof CustomDiskDriverRegistry]: CustomDiskDriverRegistry[K] & {
   driver: K;
 }; }[keyof CustomDiskDriverRegistry];
-type DiskConfig = LocalDriverConfig & {
+type DiskConfig = (LocalDriverConfig & {
   driver: 'local' | 'public';
-} | FtpDriverConfig & {
+}) | (FtpDriverConfig & {
   driver: 'ftp';
-} | S3DriverConfig & {
+}) | (S3DriverConfig & {
   driver: 's3';
-} | CustomDiskConfig;
+}) | 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 & {

package/dist/index.js

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

package/dist/{src-T2_ZZzAi.js → src-Ctmf9SXu.js}

@@ -313,17 +313,17 @@ var Driver = class Driver {
 	}
 	/**
 	* Register a new custom driver
-	* 
-	* @param name 
-	* @param driver 
+	*
+	* @param name
+	* @param driver
 	*/
 	static registerDriver(name, driver) {
 		Driver.customDrivers.set(name, driver);
 	}
 	/**
 	* Unregister a new custom driver
-	* 
-	* @param name 
+	*
+	* @param name
 	*/
 	static removeDriver(name) {
 		Driver.customDrivers.delete(name);
@@ -350,7 +350,7 @@ var Storage = class 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
 	*/
@@ -368,7 +368,7 @@ var Storage = class Storage {
 	}
 	/**
 	* 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
 	*/
@@ -379,7 +379,7 @@ var Storage = class Storage {
 	};
 	/**
 	* 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)
@@ -390,7 +390,7 @@ var Storage = class Storage {
 	};
 	/**
 	* 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)
@@ -406,9 +406,9 @@ var Storage = class Storage {
 	};
 	/**
 	* Return a boolean indicating if the file exists
-	* 
-	* @param key 
-	* @returns 
+	*
+	* @param key
+	* @returns
 	*/
 	exists(key) {
 		return this.driver.use().exists(key);
@@ -417,33 +417,33 @@ 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 
+	*
+	* @param key
+	* @returns
 	*/
 	get(key) {
 		return this.driver.use().get(key);
 	}
 	/**
 	* Get the name of the disk currently in use.
-	* 
-	* @returns 
+	*
+	* @returns
 	*/
 	getDiskName() {
 		return this.diskName;
 	}
 	/**
 	* Get the name of the driver currently in use.
-	* 
-	* @returns 
+	*
+	* @returns
 	*/
 	getDriverName() {
 		return this.driverName;
 	}
 	/**
 	* Get the driver currently in use.
-	* 
-	* @returns 
+	*
+	* @returns
 	*/
 	getDriver() {
 		return this.driver;
@@ -452,9 +452,9 @@ var Storage = class Storage {
 	* 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 
+	*
+	* @param key
+	* @returns
 	*/
 	getStream(key) {
 		return this.driver.use().getStream(key);
@@ -463,46 +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 
+	*
+	* @param key
+	* @returns
 	*/
 	getBytes(key) {
 		return this.driver.use().getBytes(key);
 	}
 	/**
 	* Return metadata of an object for the given key.
-	* 
-	* @param key 
-	* @returns 
+	*
+	* @param key
+	* @returns
 	*/
 	getMetaData(key) {
 		return this.driver.use().getMetaData(key);
 	}
 	/**
 	* Return the visibility of the file
-	* 
-	* @param key 
-	* @returns 
+	*
+	* @param key
+	* @returns
 	*/
 	getVisibility(key) {
 		return this.driver.use().getVisibility(key);
 	}
 	/**
 	* Return the public URL to access the file
-	* 
-	* @param key 
-	* @returns 
+	*
+	* @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 
+	*
+	* @param key
+	* @param options
+	* @returns
 	*/
 	getSignedUrl(key, options) {
 		return this.driver.use().getSignedUrl(key, options);
@@ -510,20 +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 
+	*
+	* @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 
+	*
+	* @param key
+	* @param visibility
+	* @returns
 	*/
 	setVisibility(key, visibility) {
 		return this.driver.use().setVisibility(key, visibility);
@@ -531,11 +531,11 @@ var Storage = class Storage {
 	/**
 	* Write object to the destination with the provided
 	* contents.
-	* 
-	* @param key 
-	* @param contents 
-	* @param options 
-	* @returns 
+	*
+	* @param key
+	* @param contents
+	* @param options
+	* @returns
 	*/
 	put(key, contents, options) {
 		if (!(contents instanceof Uint8Array) && typeof contents !== "string") contents = contents.buffer;
@@ -544,11 +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 
+	*
+	* @param key
+	* @param contents
+	* @param options
+	* @returns
 	*/
 	putStream(key, contents, options) {
 		return this.driver.use().putStream(key, contents, options);
@@ -557,11 +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 
+	*
+	* @param source
+	* @param destination
+	* @param options
+	* @returns
 	*/
 	copy(source, destination, options) {
 		return this.driver.use().copy(source, destination, options);
@@ -570,11 +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 
+	*
+	* @param source
+	* @param destination
+	* @param options
+	* @returns
 	*/
 	move(source, destination, options) {
 		return this.driver.use().move(source, destination, options);
@@ -582,18 +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 
+	*
+	* @param key
+	* @returns
 	*/
 	delete(key) {
 		return this.driver.use().delete(key);
 	}
 	/**
 	* Delete the files and directories matching the provided prefix.
-	* 
-	* @param prefix 
-	* @returns 
+	*
+	* @param prefix
+	* @returns
 	*/
 	deleteAll(prefix) {
 		return this.driver.use().deleteAll(prefix);
@@ -601,27 +601,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 
+	*
+	* @param prefix
+	* @param options
+	* @returns
 	*/
 	listAll(prefix, options) {
 		return this.driver.use().listAll(prefix, options);
 	}
 	/**
 	* Switch bucket at runtime if supported.
-	* 
-	* @param bucket 
-	* @returns 
+	*
+	* @param bucket
+	* @returns
 	*/
 	bucket(bucket) {
 		return this.driver.use().bucket(bucket);
 	}
 	/**
 	* Create symbolic links for all configured links in the application configuration.
-	* 
-	* @param param0 
+	*
+	* @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.19.1",
+  "version": "0.19.3",
   "type": "module",
   "description": "Filesystem module for Arkstack, providing shared file storage and filesystem utitlities for the framework.",
   "homepage": "https://arkstack.toneflix.net",
@@ -41,8 +41,8 @@
     "@aws-sdk/s3-request-presigner": "^3.1011.0",
     "flydrive": "^2.0.0",
     "ssh2-sftp-client": "^12.1.0",
-    "@arkstack/common": "^0.19.1",
-    "@arkstack/contract": "^0.19.1"
+    "@arkstack/common": "^0.19.3",
+    "@arkstack/contract": "^0.19.3"
   },
   "devDependencies": {
     "@types/ssh2-sftp-client": "^9.0.6"