@vercube/storage 0.0.22 → 0.0.24

package/README.md

@@ -3,10 +3,10 @@
   <br>
   <br>
 
-  # Vercube
-  
-  Next generation HTTP framework
-  
+# Vercube
+
+Next generation HTTP framework
+
   <a href="https://www.npmjs.com/package/@vercube/storage">
     <img src="https://img.shields.io/npm/v/%40vercube%2Fstorage?style=for-the-badge&logo=npm&color=%23767eff" alt="npm"/>
   </a>
@@ -16,6 +16,9 @@
   <a href="https://github.com/vercube/vercube/blob/main/LICENSE" target="_blank">
     <img src="https://img.shields.io/npm/l/%40vercube%2Fstorage?style=for-the-badge&color=%23767eff" alt="License"/>
   </a>
+  <a href="https://codecov.io/gh/vercube/vercube" target="_blank">
+    <img src="https://img.shields.io/codecov/c/github/vercube/vercube?style=for-the-badge&color=%23767eff" alt="Coverage"/>
+  </a>
   <br/>
   <br/>
 </div>
@@ -23,8 +26,9 @@
 An ultra-efficient JavaScript server framework that runs anywhere - Node.js, Bun, or Deno - with unmatched flexibility and complete configurability for developers who refuse to sacrifice speed or control.
 
 ## <a name="module">Storage Module</a>
-The Storage module provides a unified interface for managing file storage across different storage providers. It offers a flexible and provider-agnostic approach to handling file uploads, downloads, and management operations. The module supports various storage backends including local filesystem, Amazon S3, Google Cloud Storage, and Azure Blob Storage, all accessible through a consistent API. This abstraction allows developers to easily switch between storage providers without changing application code, while maintaining optimal performance and reliability.
 
+The Storage module provides a unified interface for managing file storage across different storage providers. It offers a flexible and provider-agnostic approach to handling file uploads, downloads, and management operations. The module supports various storage backends including local filesystem, Amazon S3, Google Cloud Storage, and Azure Blob Storage, all accessible through a consistent API. This abstraction allows developers to easily switch between storage providers without changing application code, while maintaining optimal performance and reliability.
 
 ## <a name="documentation">📖 Documentation</a>
-Comprehensive documentation is available at [vercube.dev](https://vercube.dev). There you'll find detailed module descriptions, project information, guides, and everything else you need to know about Vercube.
+
+Comprehensive documentation is available at [vercube.dev](https://vercube.dev). There you'll find detailed module descriptions, project information, guides, and everything else you need to know about Vercube.

package/dist/Drivers/MemoryStorage.d.mts

@@ -1,4 +1,4 @@
-import { Storage } from "../Storage-DZ-jzAK_.mjs";
+import { Storage } from "../Storage-D-QyQ5of.mjs";
 
 //#region src/Drivers/MemoryStorage.d.ts
 

package/dist/Drivers/MemoryStorage.mjs

@@ -1,9 +1,11 @@
+import "../Storage-Cr72sGff.mjs";
+
 //#region src/Drivers/MemoryStorage.ts
 /**
 * In-memory storage implementation of the Storage interface
 * Provides a simple key-value store that persists only for the duration of the application runtime
 * Useful for testing, caching, and scenarios where temporary storage is needed
-* 
+*
 * @implements {Storage}
 */
 var MemoryStorage = class {

package/dist/Drivers/S3Storage.d.mts

@@ -1,4 +1,4 @@
-import { Storage } from "../Storage-DZ-jzAK_.mjs";
+import { Storage } from "../Storage-D-QyQ5of.mjs";
 import { S3ClientConfig } from "@aws-sdk/client-s3";
 
 //#region src/Drivers/S3Storage.d.ts
@@ -6,81 +6,81 @@ interface S3BaseOptions extends S3ClientConfig {
   bucket: string;
 }
 /**
-* S3 storage implementation of the Storage interface.
-* Provides key-value operations backed by AWS S3.
-*
-* @implements {Storage}
-*/
+ * S3 storage implementation of the Storage interface.
+ * Provides key-value operations backed by AWS S3.
+ *
+ * @implements {Storage}
+ */
 declare class S3Storage implements Storage<S3BaseOptions> {
   private s3;
   private bucket;
   /**
-  * Initializes the S3 storage client.
-  *
-  * @param {S3BaseOptions} options - Configuration options for the S3 client.
-  * @returns {Promise<void>} A promise that resolves when initialization is complete.
-  */
+   * Initializes the S3 storage client.
+   *
+   * @param {S3BaseOptions} options - Configuration options for the S3 client.
+   * @returns {Promise<void>} A promise that resolves when initialization is complete.
+   */
   initialize(options: S3BaseOptions): Promise<void>;
   /**
-  * Retrieves and parses a value from S3 storage by its key.
-  *
-  * @template T
-  * @param {string} key - The key whose value should be retrieved.
-  * @returns {Promise<T | undefined>} The stored value parsed as type T, or undefined if the key does not exist.
-  * @throws Will rethrow any S3 error except for missing key (`NoSuchKey`).
-  */
+   * Retrieves and parses a value from S3 storage by its key.
+   *
+   * @template T
+   * @param {string} key - The key whose value should be retrieved.
+   * @returns {Promise<T | undefined>} The stored value parsed as type T, or undefined if the key does not exist.
+   * @throws Will rethrow any S3 error except for missing key (`NoSuchKey`).
+   */
   getItem<T = unknown>(key: string): Promise<T>;
   /**
-  * Stores a value in S3 storage under the specified key.
-  *
-  * @template T
-  * @template U
-  * @param {string} key - The key under which to store the value.
-  * @param {T} value - The value to store (will be JSON serialized).
-  * @param {U} [options] - Additional options (currently unused).
-  * @returns {Promise<void>} A promise that resolves when the value has been stored.
-  */
+   * Stores a value in S3 storage under the specified key.
+   *
+   * @template T
+   * @template U
+   * @param {string} key - The key under which to store the value.
+   * @param {T} value - The value to store (will be JSON serialized).
+   * @param {U} [options] - Additional options (currently unused).
+   * @returns {Promise<void>} A promise that resolves when the value has been stored.
+   */
   setItem<T = unknown, U = unknown>(key: string, value: T, options?: U): Promise<void>;
   /**
-  * Removes an item from S3 storage by its key.
-  *
-  * @param {string} key - The key of the item to delete.
-  * @returns {Promise<void>} A promise that resolves when the item has been deleted.
-  */
+   * Removes an item from S3 storage by its key.
+   *
+   * @param {string} key - The key of the item to delete.
+   * @returns {Promise<void>} A promise that resolves when the item has been deleted.
+   */
   deleteItem(key: string): Promise<void>;
   /**
-  * Checks if a key exists in S3 storage.
-  *
-  * @param {string} key - The key to check.
-  * @returns {Promise<boolean>} True if the key exists, false otherwise.
-  * @throws Will rethrow any S3 error except for missing key (`NoSuchKey`).
-  */
+   * Checks if a key exists in S3 storage.
+   *
+   * @param {string} key - The key to check.
+   * @returns {Promise<boolean>} True if the key exists, false otherwise.
+   * @throws Will rethrow any S3 error except for missing key (`NoSuchKey`).
+   */
   hasItem(key: string): Promise<boolean>;
   /**
-  * Retrieves a list of all keys stored in the S3 bucket.
-  *
-  * @returns {Promise<string[]>} An array of all stored keys.
-  */
+   * Retrieves a list of all keys stored in the S3 bucket.
+   *
+   * @returns {Promise<string[]>} An array of all stored keys.
+   */
   getKeys(): Promise<string[]>;
   /**
-  * Deletes all items from S3 storage.
-  *
-  * @returns {Promise<void>} A promise that resolves when all items have been deleted.
-  */
+   * Deletes all items from S3 storage.
+   *
+   * @returns {Promise<void>} A promise that resolves when all items have been deleted.
+   */
   clear(): Promise<void>;
   /**
-  * Gets the total number of stored items.
-  *
-  * @returns {Promise<number>} The count of stored items.
-  */
+   * Gets the total number of stored items.
+   *
+   * @returns {Promise<number>} The count of stored items.
+   */
   size(): Promise<number>;
   /**
-  * Converts a Node.js readable stream into a UTF-8 string.
-  *
-  * @private
-  * @param {Readable} stream - The readable stream to convert.
-  * @returns {Promise<string>} The stream contents as a string.
-  */
+   * Converts a Node.js readable stream into a UTF-8 string.
+   *
+   * @private
+   * @param {Readable} stream - The readable stream to convert.
+   * @returns {Promise<string>} The stream contents as a string.
+   */
   private streamToString;
 }
 //#endregion