@vercube/storage 0.0.14 → 0.0.16

package/dist/Drivers/MemoryStorage.d.mts

@@ -0,0 +1,62 @@
+import { Storage } from "../Storage-DZ-jzAK_.mjs";
+
+//#region src/Drivers/MemoryStorage.d.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}
+ */
+declare class MemoryStorage implements Storage {
+  /** Internal storage map to hold key-value pairs */
+  private storage;
+  /**
+   * Initializes the memory storage
+   * No initialization is needed for in-memory storage as the Map is created on instantiation
+   */
+  initialize(): void;
+  /**
+   * Retrieves a value from memory storage by its key
+   * @template T - Type of the stored value
+   * @param {string} key - The key to retrieve the value for
+   * @returns {T} The stored value cast to type T
+   */
+  getItem<T = unknown>(key: string): T;
+  /**
+   * Stores a value in memory storage with the specified key
+   * @template T - Type of the value to store
+   * @template U - Type of the options object
+   * @param {string} key - The key under which to store the value
+   * @param {T} value - The value to store
+   */
+  setItem<T = unknown, U = unknown>(key: string, value: T, options?: U): void;
+  /**
+   * Removes a value from memory storage by its key
+   * @param {string} key - The key of the value to delete
+   */
+  deleteItem(key: string): void;
+  /**
+   * Checks if a value exists in memory storage for the given key
+   * @param {string} key - The key to check
+   * @returns {boolean} True if the key exists, false otherwise
+   */
+  hasItem(key: string): boolean;
+  /**
+   * Retrieves all keys currently stored in memory storage
+   * @returns {string[]} Array of all stored keys
+   */
+  getKeys(): string[];
+  /**
+   * Removes all stored values from memory storage
+   */
+  clear(): void;
+  /**
+   * Gets the number of key-value pairs stored in memory storage
+   * @returns {number} The number of stored items
+   */
+  size(): number;
+}
+//#endregion
+export { MemoryStorage };

package/dist/Drivers/MemoryStorage.mjs

@@ -0,0 +1,74 @@
+//#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 {
+	/** Internal storage map to hold key-value pairs */
+	storage = /* @__PURE__ */ new Map();
+	/**
+	* Initializes the memory storage
+	* No initialization is needed for in-memory storage as the Map is created on instantiation
+	*/
+	initialize() {}
+	/**
+	* Retrieves a value from memory storage by its key
+	* @template T - Type of the stored value
+	* @param {string} key - The key to retrieve the value for
+	* @returns {T} The stored value cast to type T
+	*/
+	getItem(key) {
+		return this.storage.get(key);
+	}
+	/**
+	* Stores a value in memory storage with the specified key
+	* @template T - Type of the value to store
+	* @template U - Type of the options object
+	* @param {string} key - The key under which to store the value
+	* @param {T} value - The value to store
+	*/
+	setItem(key, value, options) {
+		this.storage.set(key, value);
+	}
+	/**
+	* Removes a value from memory storage by its key
+	* @param {string} key - The key of the value to delete
+	*/
+	deleteItem(key) {
+		this.storage.delete(key);
+	}
+	/**
+	* Checks if a value exists in memory storage for the given key
+	* @param {string} key - The key to check
+	* @returns {boolean} True if the key exists, false otherwise
+	*/
+	hasItem(key) {
+		return this.storage.has(key);
+	}
+	/**
+	* Retrieves all keys currently stored in memory storage
+	* @returns {string[]} Array of all stored keys
+	*/
+	getKeys() {
+		return [...this.storage.keys()];
+	}
+	/**
+	* Removes all stored values from memory storage
+	*/
+	clear() {
+		this.storage.clear();
+	}
+	/**
+	* Gets the number of key-value pairs stored in memory storage
+	* @returns {number} The number of stored items
+	*/
+	size() {
+		return this.storage.size;
+	}
+};
+
+//#endregion
+export { MemoryStorage };

package/dist/Drivers/S3Storage.d.mts

@@ -0,0 +1,87 @@
+import { Storage } from "../Storage-DZ-jzAK_.mjs";
+import { S3ClientConfig } from "@aws-sdk/client-s3";
+
+//#region src/Drivers/S3Storage.d.ts
+interface S3BaseOptions extends S3ClientConfig {
+  bucket: string;
+}
+/**
+* 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.
+  */
+  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`).
+  */
+  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.
+  */
+  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.
+  */
+  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`).
+  */
+  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.
+  */
+  getKeys(): Promise<string[]>;
+  /**
+  * 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.
+  */
+  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.
+  */
+  private streamToString;
+}
+//#endregion
+export { S3BaseOptions, S3Storage };