@vercube/storage 0.0.15 → 0.0.17

package/dist/Storage-DZ-jzAK_.d.mts

@@ -0,0 +1,67 @@
+//#region src/Service/Storage.d.ts
+/**
+ * Abstract base class for storage implementations
+ * Provides a common interface for different storage providers
+ *
+ * @abstract
+ * @class Storage
+ * @description
+ * The Storage class defines a standard interface for storing and retrieving data.
+ * It supports basic operations like get, set, delete, and querying storage state.
+ * Concrete implementations must provide the actual storage mechanism.
+ */
+declare abstract class Storage<T = undefined> {
+  /**
+   * Initializes the storage implementation.
+   * Must be called before using any other storage operations.
+   *
+   * @param {T} options - Initialization parameters. May be omitted if not required by the storage implementation.
+   * @returns {Promise<void>} A promise that resolves when initialization is complete.
+   */
+  abstract initialize(options: T): void | Promise<void>;
+  /**
+   * Retrieves a value from storage by its key
+   * @template T - The type of the stored value
+   * @param {string} key - The key to retrieve the value for
+   * @returns {Promise<T>} A promise that resolves with the stored value
+   */
+  abstract getItem<T = unknown>(key: string): T | Promise<T>;
+  /**
+   * Stores a value in storage with the specified key
+   * @template T - The type of the value to store
+   * @template U - The type of the optional options object
+   * @param {string} key - The key under which to store the value
+   * @param {T} value - The value to store
+   * @returns {Promise<void>} A promise that resolves when the value is stored
+   */
+  abstract setItem<T = unknown, U = unknown>(key: string, value: T, options?: U): void | Promise<void>;
+  /**
+   * Removes a value from storage by its key
+   * @param {string} key - The key of the value to delete
+   * @returns {Promise<void>} A promise that resolves when the value is deleted
+   */
+  abstract deleteItem(key: string): void | Promise<void>;
+  /**
+   * Checks if a value exists in storage for the given key
+   * @param {string} key - The key to check
+   * @returns {Promise<boolean>} A promise that resolves to true if the key exists, false otherwise
+   */
+  abstract hasItem(key: string): boolean | Promise<boolean>;
+  /**
+   * Retrieves all keys currently stored in storage
+   * @returns {Promise<string[]>} A promise that resolves with an array of all stored keys
+   */
+  abstract getKeys(): string[] | Promise<string[]>;
+  /**
+   * Removes all stored values from storage
+   * @returns {Promise<void>} A promise that resolves when all values are cleared
+   */
+  abstract clear(): void | Promise<void>;
+  /**
+   * Gets the number of key-value pairs stored in storage
+   * @returns {Promise<number>} A promise that resolves with the number of stored items
+   */
+  abstract size(): number | Promise<number>;
+}
+//#endregion
+export { Storage };

package/dist/chunk-UoOzN6Vc.mjs

@@ -0,0 +1,40 @@
+import { createRequire } from "node:module";
+
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __esm = (fn, res) => function() {
+	return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;
+};
+var __commonJS = (cb, mod) => function() {
+	return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
+var __export = (target, all) => {
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+};
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __require = /* @__PURE__ */ createRequire(import.meta.url);
+
+//#endregion
+export { __commonJS, __esm, __export, __require, __toCommonJS, __toESM };

package/dist/index.d.mts

@@ -1,73 +1,6 @@
+import { Storage } from "./Storage-DZ-jzAK_.mjs";
 import { IOC } from "@vercube/di";
-import { S3ClientConfig } from "@aws-sdk/client-s3";
 
-//#region src/Service/Storage.d.ts
-
-/**
- * Abstract base class for storage implementations
- * Provides a common interface for different storage providers
- *
- * @abstract
- * @class Storage
- * @description
- * The Storage class defines a standard interface for storing and retrieving data.
- * It supports basic operations like get, set, delete, and querying storage state.
- * Concrete implementations must provide the actual storage mechanism.
- */
-declare abstract class Storage<T = undefined> {
-  /**
-   * Initializes the storage implementation.
-   * Must be called before using any other storage operations.
-   *
-   * @param {T} options - Initialization parameters. May be omitted if not required by the storage implementation.
-   * @returns {Promise<void>} A promise that resolves when initialization is complete.
-   */
-  abstract initialize(options: T): void | Promise<void>;
-  /**
-   * Retrieves a value from storage by its key
-   * @template T - The type of the stored value
-   * @param {string} key - The key to retrieve the value for
-   * @returns {Promise<T>} A promise that resolves with the stored value
-   */
-  abstract getItem<T = unknown>(key: string): T | Promise<T>;
-  /**
-   * Stores a value in storage with the specified key
-   * @template T - The type of the value to store
-   * @template U - The type of the optional options object
-   * @param {string} key - The key under which to store the value
-   * @param {T} value - The value to store
-   * @returns {Promise<void>} A promise that resolves when the value is stored
-   */
-  abstract setItem<T = unknown, U = unknown>(key: string, value: T, options?: U): void | Promise<void>;
-  /**
-   * Removes a value from storage by its key
-   * @param {string} key - The key of the value to delete
-   * @returns {Promise<void>} A promise that resolves when the value is deleted
-   */
-  abstract deleteItem(key: string): void | Promise<void>;
-  /**
-   * Checks if a value exists in storage for the given key
-   * @param {string} key - The key to check
-   * @returns {Promise<boolean>} A promise that resolves to true if the key exists, false otherwise
-   */
-  abstract hasItem(key: string): boolean | Promise<boolean>;
-  /**
-   * Retrieves all keys currently stored in storage
-   * @returns {Promise<string[]>} A promise that resolves with an array of all stored keys
-   */
-  abstract getKeys(): string[] | Promise<string[]>;
-  /**
-   * Removes all stored values from storage
-   * @returns {Promise<void>} A promise that resolves when all values are cleared
-   */
-  abstract clear(): void | Promise<void>;
-  /**
-   * Gets the number of key-value pairs stored in storage
-   * @returns {Promise<number>} A promise that resolves with the number of stored items
-   */
-  abstract size(): number | Promise<number>;
-}
-//#endregion
 //#region src/Types/StorageTypes.d.ts
 declare namespace StorageTypes {
   interface BaseOptions {
@@ -102,9 +35,6 @@ declare namespace StorageTypes {
   interface GetKeys extends BaseOptions {}
   interface Clear extends BaseOptions {}
   interface Size extends BaseOptions {}
-  interface S3BaseOptions extends S3ClientConfig {
-    bucket: string;
-  }
 }
 //#endregion
 //#region src/Service/StorageManager.d.ts
@@ -222,142 +152,4 @@ declare class StorageManager {
   private init;
 }
 //#endregion
-//#region src/Storages/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
-//#region src/Storages/S3Storage.d.ts
-/**
-* S3 storage implementation of the Storage interface.
-* Provides key-value operations backed by AWS S3.
-*
-* @implements {Storage}
-*/
-declare class S3Storage implements Storage<StorageTypes.S3BaseOptions> {
-  private s3;
-  private bucket;
-  /**
-  * Initializes the S3 storage client.
-  *
-  * @param {StorageTypes.S3BaseOptions} options - Configuration options for the S3 client.
-  * @returns {Promise<void>} A promise that resolves when initialization is complete.
-  */
-  initialize(options: StorageTypes.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 { MemoryStorage, S3Storage, Storage, StorageManager, StorageTypes };
+export { Storage, StorageManager, StorageTypes };