keyv 5.2.0 → 5.2.2

package/README.md

@@ -1,8 +1,4 @@
-<h1 align="center">
-	<img width="250" src="https://jaredwray.com/images/keyv.svg" alt="keyv">
-	<br>
-	<br>
-</h1>
+<h1 align="center"><img width="250" src="https://jaredwray.com/images/keyv.svg" alt="keyv"></h1>
 
 > Simple key-value storage with support for multiple backends
 
@@ -281,41 +277,7 @@ The following are third-party storage adapters compatible with Keyv:
 - [keyv-azuretable](https://github.com/howlowck/keyv-azuretable) - Azure Table Storage/API adapter for Keyv
 - [keyv-arango](https://github.com/TimMikeladze/keyv-arango) - ArangoDB storage adapter for Keyv
 - [keyv-momento](https://github.com/momentohq/node-keyv-adaptor/) - Momento storage adapter for Keyv
-
-# Add Cache Support to your Module
-
-Keyv is designed to be easily embedded into other modules to add cache support. The recommended pattern is to expose a `cache` option in your modules options which is passed through to Keyv. Caching will work in memory by default and users have the option to also install a Keyv storage adapter and pass in a connection string, or any other storage that implements the `Map` API.
-
-You should also set a namespace for your module so you can safely call `.clear()` without clearing unrelated app data.
-
-Inside your module:
-
-```js
-class AwesomeModule {
-	constructor(opts) {
-		this.cache = new Keyv({
-			uri: typeof opts.cache === 'string' && opts.cache,
-			store: typeof opts.cache !== 'string' && opts.cache,
-			namespace: 'awesome-module'
-		});
-	}
-}
-```
-
-Now it can be consumed like this:
-
-```js
-import AwesomeModule from 'awesome-module';
-
-// Caches stuff in memory by default
-const awesomeModule = new AwesomeModule();
-
-// After npm install --save keyv-redis
-const awesomeModule = new AwesomeModule({ cache: 'redis://localhost' });
-
-// Some third-party module that implements the Map API
-const awesomeModule = new AwesomeModule({ cache: some3rdPartyStore });
-```
+- [@resolid/keyv-sqlite](https://github.com/huijiewei/keyv-sqlite) - A new SQLite storage adapter for Keyv
 
 # Compression
 

package/dist/index.cjs

@@ -62,7 +62,7 @@ var EventManager = class {
   off(event, listener) {
     const listeners = this._eventListeners.get(event) ?? [];
     const index = listeners.indexOf(listener);
-    if (index > -1) {
+    if (index !== -1) {
       listeners.splice(index, 1);
     }
     if (listeners.length === 0) {
@@ -231,7 +231,9 @@ var iterableAdapters = [
   "postgres",
   "mysql",
   "mongo",
-  "redis"
+  "redis",
+  "valkey",
+  "etcd"
 ];
 var Keyv = class extends event_manager_default {
   opts;
@@ -572,10 +574,16 @@ var Keyv = class extends event_manager_default {
     }
     const formattedValue = { value, expires };
     const serializedValue = await this.serializeData(formattedValue);
-    await store.set(keyPrefixed, serializedValue, ttl);
+    let result = true;
+    try {
+      await store.set(keyPrefixed, serializedValue, ttl);
+    } catch (error) {
+      result = false;
+      this.emit("error", error);
+    }
     this.hooks.trigger("postSet" /* POST_SET */, { key: keyPrefixed, value: serializedValue, ttl });
     this.stats.set();
-    return true;
+    return result;
   }
   /**
    * Delete an Entry

package/dist/index.d.cts

@@ -47,6 +47,8 @@ type DeserializedData<Value> = {
 interface 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;

package/dist/index.d.ts

@@ -47,6 +47,8 @@ type DeserializedData<Value> = {
 interface 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;

package/dist/index.js

@@ -36,7 +36,7 @@ var EventManager = class {
   off(event, listener) {
     const listeners = this._eventListeners.get(event) ?? [];
     const index = listeners.indexOf(listener);
-    if (index > -1) {
+    if (index !== -1) {
       listeners.splice(index, 1);
     }
     if (listeners.length === 0) {
@@ -205,7 +205,9 @@ var iterableAdapters = [
   "postgres",
   "mysql",
   "mongo",
-  "redis"
+  "redis",
+  "valkey",
+  "etcd"
 ];
 var Keyv = class extends event_manager_default {
   opts;
@@ -546,10 +548,16 @@ var Keyv = class extends event_manager_default {
     }
     const formattedValue = { value, expires };
     const serializedValue = await this.serializeData(formattedValue);
-    await store.set(keyPrefixed, serializedValue, ttl);
+    let result = true;
+    try {
+      await store.set(keyPrefixed, serializedValue, ttl);
+    } catch (error) {
+      result = false;
+      this.emit("error", error);
+    }
     this.hooks.trigger("postSet" /* POST_SET */, { key: keyPrefixed, value: serializedValue, ttl });
     this.stats.set();
-    return true;
+    return result;
   }
   /**
    * Delete an Entry

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keyv",
-  "version": "5.2.0",
+  "version": "5.2.2",
   "description": "Simple key-value storage with support for multiple backends",
   "type": "module",
   "main": "dist/index.cjs",
@@ -69,19 +69,19 @@
   },
   "homepage": "https://github.com/jaredwray/keyv",
   "dependencies": {
-    "@keyv/serialize": "*"
+    "@keyv/serialize": "^1.0.1"
   },
   "devDependencies": {
-    "@keyv/compress-brotli": "*",
-    "@keyv/compress-gzip": "*",
-    "@keyv/memcache": "*",
-    "@keyv/mongo": "*",
-    "@keyv/sqlite": "*",
-    "@keyv/test-suite": "*",
     "rimraf": "^6.0.1",
     "timekeeper": "^2.3.1",
     "tsd": "^0.31.2",
-    "xo": "^0.59.3"
+    "xo": "^0.60.0",
+    "@keyv/mongo": "^3.0.1",
+    "@keyv/compress-gzip": "^2.0.2",
+    "@keyv/test-suite": "^2.0.3",
+    "@keyv/sqlite": "^4.0.1",
+    "@keyv/memcache": "^2.0.1",
+    "@keyv/compress-brotli": "^2.0.2"
   },
   "tsd": {
     "directory": "test"