keyv 6.0.0-alpha.2 → 6.0.0-beta.1

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "keyv",
-  "version": "6.0.0-alpha.2",
+  "version": "6.0.0-beta.1",
   "description": "Simple key-value storage with support for multiple backends",
   "type": "module",
-  "main": "dist/index.js",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
   "exports": {
     ".": {
       "require": {
@@ -13,8 +13,8 @@
         "default": "./dist/index.cjs"
       },
       "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
       }
     }
   },
@@ -50,12 +50,15 @@
   },
   "homepage": "https://github.com/jaredwray/keyv",
   "dependencies": {
-    "@keyv/serialize": "^6.0.0-alpha.2"
+    "hookified": "^2.0.1"
   },
   "devDependencies": {
     "@biomejs/biome": "^2.3.13",
     "@faker-js/faker": "^10.2.0",
     "@vitest/coverage-v8": "^4.0.18",
+    "happy-dom": "^20.8.7",
+    "keyv-anyredis": "^3.3.0",
+    "keyv-file": "^5.3.3",
     "lru.min": "^1.1.1",
     "quick-lru": "^7.0.0",
     "rimraf": "^6.1.2",
@@ -68,10 +71,10 @@
   },
   "files": [
     "dist",
-    "LISCENCE"
+    "LICENSE"
   ],
   "scripts": {
-    "build": "rimraf ./dist && tsup src/index.ts --format cjs,esm --dts --clean",
+    "build": "tsdown",
     "lint": "biome check --write --error-on-warnings",
     "lint:ci": "biome check --error-on-warnings",
     "test": "pnpm lint && vitest run --coverage",

package/dist/index.d.ts

@@ -1,386 +0,0 @@
-type EventListener = (...arguments_: any[]) => void;
-declare class EventManager {
-    _eventListeners: Map<string, EventListener[]>;
-    _maxListeners: number;
-    constructor();
-    maxListeners(): number;
-    addListener(event: string, listener: EventListener): void;
-    on(event: string, listener: EventListener): this;
-    removeListener(event: string, listener: EventListener): void;
-    off(event: string, listener: EventListener): void;
-    once(event: string, listener: EventListener): void;
-    emit(event: string, ...arguments_: any[]): void;
-    listeners(event: string): EventListener[];
-    removeAllListeners(event?: string): void;
-    setMaxListeners(n: number): void;
-}
-
-type HookHandler = (...arguments_: any[]) => void;
-declare class HooksManager extends EventManager {
-    _hookHandlers: Map<string, HookHandler[]>;
-    constructor();
-    addHandler(event: string, handler: HookHandler): void;
-    removeHandler(event: string, handler: HookHandler): void;
-    trigger(event: string, data: any): void;
-    get handlers(): Map<string, HookHandler[]>;
-}
-
-declare class StatsManager extends EventManager {
-    enabled: boolean;
-    hits: number;
-    misses: number;
-    sets: number;
-    deletes: number;
-    errors: number;
-    constructor(enabled?: boolean);
-    hit(): void;
-    miss(): void;
-    set(): void;
-    delete(): void;
-    hitsOrMisses<T>(array: Array<T | undefined>): void;
-    reset(): void;
-}
-
-type DeserializedData<Value> = {
-    value?: Value;
-    expires?: number | undefined;
-};
-type CompressionAdapter = {
-    compress(value: any, options?: any): Promise<any>;
-    decompress(value: any, options?: any): Promise<any>;
-    serialize<Value>(data: DeserializedData<Value>): Promise<string> | string;
-    deserialize<Value>(data: string): Promise<DeserializedData<Value> | undefined> | DeserializedData<Value> | undefined;
-};
-type Serialize = <Value>(data: DeserializedData<Value>) => Promise<string> | string;
-type Deserialize = <Value>(data: string) => Promise<DeserializedData<Value> | undefined> | DeserializedData<Value> | undefined;
-declare enum KeyvHooks {
-    PRE_SET = "preSet",
-    POST_SET = "postSet",
-    PRE_GET = "preGet",
-    POST_GET = "postGet",
-    PRE_GET_MANY = "preGetMany",
-    POST_GET_MANY = "postGetMany",
-    PRE_GET_RAW = "preGetRaw",
-    POST_GET_RAW = "postGetRaw",
-    PRE_GET_MANY_RAW = "preGetManyRaw",
-    POST_GET_MANY_RAW = "postGetManyRaw",
-    PRE_DELETE = "preDelete",
-    POST_DELETE = "postDelete"
-}
-type KeyvEntry = {
-    /**
-     * Key to set.
-     */
-    key: string;
-    /**
-     * Value to set.
-     */
-    value: any;
-    /**
-     * Time to live in milliseconds.
-     */
-    ttl?: number;
-};
-type StoredDataNoRaw<Value> = Value | undefined;
-type StoredDataRaw<Value> = DeserializedData<Value> | undefined;
-type StoredData<Value> = StoredDataNoRaw<Value> | StoredDataRaw<Value>;
-type IEventEmitter = {
-    on(event: string, listener: (...arguments_: any[]) => void): IEventEmitter;
-};
-type KeyvStoreAdapter = {
-    opts: any;
-    namespace?: string | undefined;
-    get<Value>(key: string): Promise<StoredData<Value> | undefined>;
-    set(key: string, value: any, ttl?: number): any;
-    setMany?(values: Array<{
-        key: string;
-        value: any;
-        ttl?: number;
-    }>): Promise<void>;
-    delete(key: string): Promise<boolean>;
-    clear(): Promise<void>;
-    has?(key: string): Promise<boolean>;
-    hasMany?(keys: string[]): Promise<boolean[]>;
-    getMany?<Value>(keys: string[]): Promise<Array<StoredData<Value | undefined>>>;
-    disconnect?(): Promise<void>;
-    deleteMany?(key: string[]): Promise<boolean>;
-    iterator?<Value>(namespace?: string): AsyncGenerator<Array<string | Awaited<Value> | undefined>, void>;
-} & IEventEmitter;
-type KeyvOptions = {
-    /**
-     * Emit errors
-     * @default true
-     */
-    emitErrors?: boolean;
-    /**
-     * Namespace for the current instance.
-     * @default 'keyv'
-     */
-    namespace?: string;
-    /**
-     * A custom serialization function.
-     * @default defaultSerialize using JSON.stringify
-     */
-    serialize?: Serialize;
-    /**
-     * A custom deserialization function.
-     * @default defaultDeserialize using JSON.parse
-     */
-    deserialize?: Deserialize;
-    /**
-     * The storage adapter instance to be used by Keyv.
-     * @default new Map() - in-memory store
-     */
-    store?: KeyvStoreAdapter | Map<any, any> | any;
-    /**
-     * Default TTL in milliseconds. Can be overridden by specifying a TTL on `.set()`.
-     * @default undefined
-     */
-    ttl?: number;
-    /**
-     * Enable compression option
-     * @default false
-     */
-    compression?: CompressionAdapter | any;
-    /**
-     * Enable or disable statistics (default is false)
-     * @default false
-     */
-    stats?: boolean;
-    /**
-     * Enable or disable key prefixing (default is true)
-     * @default true
-     */
-    useKeyPrefix?: boolean;
-    /**
-     * Will enable throwing errors on methods in addition to emitting them.
-     * @default false
-     */
-    throwOnErrors?: boolean;
-};
-type IteratorFunction = (argument: any) => AsyncGenerator<any, void>;
-declare class Keyv<GenericValue = any> extends EventManager {
-    iterator?: IteratorFunction;
-    hooks: HooksManager;
-    stats: StatsManager;
-    /**
-     * Time to live in milliseconds
-     */
-    private _ttl?;
-    /**
-     * Namespace
-     */
-    private _namespace?;
-    /**
-     * Store
-     */
-    private _store;
-    private _serialize;
-    private _deserialize;
-    private _compression;
-    private _useKeyPrefix;
-    private _throwOnErrors;
-    private _emitErrors;
-    /**
-     * Keyv Constructor
-     * @param {KeyvStoreAdapter | KeyvOptions | Map<any, any>} store  to be provided or just the options
-     * @param {Omit<KeyvOptions, 'store'>} [options] if you provide the store you can then provide the Keyv Options
-     */
-    constructor(store?: KeyvStoreAdapter | KeyvOptions | Map<any, any>, options?: Omit<KeyvOptions, "store">);
-    /**
-     * Keyv Constructor
-     * @param {KeyvOptions} options to be provided
-     */
-    constructor(options?: KeyvOptions);
-    /**
-     * Get the current store
-     */
-    get store(): KeyvStoreAdapter | Map<any, any> | any;
-    /**
-     * Set the current store. This will also set the namespace, event error handler, and generate the iterator. If the store is not valid it will throw an error.
-     * @param {KeyvStoreAdapter | Map<any, any> | any} store the store to set
-     */
-    set store(store: KeyvStoreAdapter | Map<any, any> | any);
-    /**
-     * Get the current compression function
-     * @returns {CompressionAdapter} The current compression function
-     */
-    get compression(): CompressionAdapter | undefined;
-    /**
-     * Set the current compression function
-     * @param {CompressionAdapter} compress The compression function to set
-     */
-    set compression(compress: CompressionAdapter | undefined);
-    /**
-     * Get the current namespace.
-     * @returns {string | undefined} The current namespace.
-     */
-    get namespace(): string | undefined;
-    /**
-     * Set the current namespace.
-     * @param {string | undefined} namespace The namespace to set.
-     */
-    set namespace(namespace: string | undefined);
-    /**
-     * Get the current TTL.
-     * @returns {number} The current TTL in milliseconds.
-     */
-    get ttl(): number | undefined;
-    /**
-     * Set the current TTL.
-     * @param {number} ttl The TTL to set in milliseconds.
-     */
-    set ttl(ttl: number | undefined);
-    /**
-     * Get the current serialize function.
-     * @returns {Serialize} The current serialize function.
-     */
-    get serialize(): Serialize | undefined;
-    /**
-     * Set the current serialize function.
-     * @param {Serialize} serialize The serialize function to set.
-     */
-    set serialize(serialize: Serialize | undefined);
-    /**
-     * Get the current deserialize function.
-     * @returns {Deserialize} The current deserialize function.
-     */
-    get deserialize(): Deserialize | undefined;
-    /**
-     * Set the current deserialize function.
-     * @param {Deserialize} deserialize The deserialize function to set.
-     */
-    set deserialize(deserialize: Deserialize | undefined);
-    /**
-     * Get the current useKeyPrefix value. This will enable or disable key prefixing.
-     * @returns {boolean} The current useKeyPrefix value.
-     * @default true
-     */
-    get useKeyPrefix(): boolean;
-    /**
-     * Set the current useKeyPrefix value. This will enable or disable key prefixing.
-     * @param {boolean} value The useKeyPrefix value to set.
-     */
-    set useKeyPrefix(value: boolean);
-    /**
-     * Get the current throwErrors value. This will enable or disable throwing errors on methods in addition to emitting them.
-     * @return {boolean} The current throwOnErrors value.
-     */
-    get throwOnErrors(): boolean;
-    /**
-     * Set the current throwOnErrors value. This will enable or disable throwing errors on methods in addition to emitting them.
-     * @param {boolean} value The throwOnErrors value to set.
-     */
-    set throwOnErrors(value: boolean);
-    /**
-     * Get the current emitErrors value. This will enable or disable emitting errors on methods.
-     * @return {boolean} The current emitErrors value.
-     * @default true
-     */
-    get emitErrors(): boolean;
-    /**
-     * Set the current emitErrors value. This will enable or disable emitting errors on methods.
-     * @param {boolean} value The emitErrors value to set.
-     */
-    set emitErrors(value: boolean);
-    generateIterator(iterator: IteratorFunction): IteratorFunction;
-    _checkIterableAdapter(): boolean;
-    _getKeyPrefix(key: string): string;
-    _getKeyPrefixArray(keys: string[]): string[];
-    _getKeyUnprefix(key: string): string;
-    _isValidStorageAdapter(store: KeyvStoreAdapter | any): boolean;
-    /**
-     * Get the Value of a Key
-     * @param {string | string[]} key passing in a single key or multiple as an array
-     * @param {{raw: boolean} | undefined} options can pass in to return the raw value by setting { raw: true }
-     */
-    get<Value = GenericValue>(key: string, options?: {
-        raw: false;
-    }): Promise<StoredDataNoRaw<Value>>;
-    get<Value = GenericValue>(key: string, options?: {
-        raw: true;
-    }): Promise<StoredDataRaw<Value>>;
-    get<Value = GenericValue>(key: string[], options?: {
-        raw: false;
-    }): Promise<Array<StoredDataNoRaw<Value>>>;
-    get<Value = GenericValue>(key: string[], options?: {
-        raw: true;
-    }): Promise<Array<StoredDataRaw<Value>>>;
-    /**
-     * Get many values of keys
-     * @param {string[]} keys passing in a single key or multiple as an array
-     * @param {{raw: boolean} | undefined} options can pass in to return the raw value by setting { raw: true }
-     */
-    getMany<Value = GenericValue>(keys: string[], options?: {
-        raw: false;
-    }): Promise<Array<StoredDataNoRaw<Value>>>;
-    getMany<Value = GenericValue>(keys: string[], options?: {
-        raw: true;
-    }): Promise<Array<StoredDataRaw<Value>>>;
-    /**
-     * Get the raw value of a key. This is the replacement for setting raw to true in the get() method.
-     * @param {string} key the key to get
-     * @returns {Promise<StoredDataRaw<Value> | undefined>} will return a StoredDataRaw<Value> or undefined if the key does not exist or is expired.
-     */
-    getRaw<Value = GenericValue>(key: string): Promise<StoredDataRaw<Value> | undefined>;
-    /**
-     * Get the raw values of many keys. This is the replacement for setting raw to true in the getMany() method.
-     * @param {string[]} keys the keys to get
-     * @returns {Promise<Array<StoredDataRaw<Value>>>} will return an array of StoredDataRaw<Value> or undefined if the key does not exist or is expired.
-     */
-    getManyRaw<Value = GenericValue>(keys: string[]): Promise<Array<StoredDataRaw<Value>>>;
-    /**
-     * Set an item to the store
-     * @param {string | Array<KeyvEntry>} key the key to use. If you pass in an array of KeyvEntry it will set many items
-     * @param {Value} value the value of the key
-     * @param {number} [ttl] time to live in milliseconds
-     * @returns {boolean} if it sets then it will return a true. On failure will return false.
-     */
-    set<Value = GenericValue>(key: string, value: Value, ttl?: number): Promise<boolean>;
-    /**
-     * Set many items to the store
-     * @param {Array<KeyvEntry>} entries the entries to set
-     * @returns {boolean[]} will return an array of booleans if it sets then it will return a true. On failure will return false.
-     */
-    setMany<Value = GenericValue>(entries: KeyvEntry[]): Promise<boolean[]>;
-    /**
-     * Delete an Entry
-     * @param {string | string[]} key the key to be deleted. if an array it will delete many items
-     * @returns {boolean} will return true if item or items are deleted. false if there is an error
-     */
-    delete(key: string | string[]): Promise<boolean>;
-    /**
-     * Delete many items from the store
-     * @param {string[]} keys the keys to be deleted
-     * @returns {boolean} will return true if item or items are deleted. false if there is an error
-     */
-    deleteMany(keys: string[]): Promise<boolean>;
-    /**
-     * Clear the store
-     * @returns {void}
-     */
-    clear(): Promise<void>;
-    /**
-     * Has a key
-     * @param {string} key the key to check
-     * @returns {boolean} will return true if the key exists
-     */
-    has(key: string[]): Promise<boolean[]>;
-    has(key: string): Promise<boolean>;
-    /**
-     * Check if many keys exist
-     * @param {string[]} keys the keys to check
-     * @returns {boolean[]} will return an array of booleans if the keys exist
-     */
-    hasMany(keys: string[]): Promise<boolean[]>;
-    /**
-     * Will disconnect the store. This is only available if the store has a disconnect method
-     * @returns {Promise<void>}
-     */
-    disconnect(): Promise<void>;
-    emit(event: string, ...arguments_: any[]): void;
-    serializeData<T>(data: DeserializedData<T>): Promise<string | DeserializedData<T>>;
-    deserializeData<T>(data: string | DeserializedData<T>): Promise<DeserializedData<T> | undefined>;
-}
-
-export { type CompressionAdapter, type Deserialize, type DeserializedData, type IEventEmitter, Keyv, type KeyvEntry, KeyvHooks, type KeyvOptions, type KeyvStoreAdapter, type Serialize, type StoredData, type StoredDataNoRaw, type StoredDataRaw, Keyv as default };