keyv 4.5.0 → 4.5.2

package/README.md

@@ -195,12 +195,34 @@ Keyv supports `gzip` and `brotli` compression. To enable compression, pass the `
 const KeyvGzip = require('@keyv/compress-gzip');
 const Keyv = require('keyv');
 
-const keyvGzip = new KeyvGzip();;
+const keyvGzip = new KeyvGzip();
 const keyv = new Keyv({ compression: KeyvGzip });
 ```
 
 You can also pass a custom compression function to the `compression` option. Following the pattern of the official compression adapters.
 
+### Want to build your own? 
+
+Great! Keyv is designed to be easily extended. You can build your own compression adapter by following the pattern of the official compression adapters based on this interface:
+
+```typescript
+interface CompressionAdapter {
+	async compress(value: any, options?: any);
+	async decompress(value: any, options?: any);
+	async serialize(value: any);
+	async deserialize(value: any);
+}
+```
+
+In addition to the interface, you can test it with our compression test suite using @keyv/test-suite:
+
+```js
+const {keyvCompresstionTests} = require('@keyv/test-suite');
+const KeyvGzip = require('@keyv/compress-gzip');
+
+keyvCompresstionTests(test, new KeyvGzip());
+```
+
 ## API
 
 ### new Keyv([uri], [options])

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "keyv",
-	"version": "4.5.0",
+	"version": "4.5.2",
 	"description": "Simple key-value storage with support for multiple backends",
 	"main": "src/index.js",
 	"scripts": {
@@ -11,7 +11,8 @@
 	"xo": {
 		"rules": {
 			"unicorn/prefer-module": 0,
-			"unicorn/prefer-node-protocol": 0
+			"unicorn/prefer-node-protocol": 0,
+			"@typescript-eslint/consistent-type-definitions": 0
 		}
 	},
 	"repository": {
@@ -36,16 +37,16 @@
 	},
 	"devDependencies": {
 		"@keyv/test-suite": "*",
-		"ava": "^4.3.0",
-		"eslint": "^8.19.0",
-		"eslint-plugin-promise": "^6.0.0",
+		"ava": "^5.0.1",
+		"eslint": "^8.26.0",
+		"eslint-plugin-promise": "^6.1.1",
 		"nyc": "^15.1.0",
 		"pify": "5.0.0",
 		"this": "^1.1.0",
 		"timekeeper": "^2.2.0",
-		"tsd": "^0.22.0",
-		"typescript": "^4.7.4",
-		"xo": "^0.51.0"
+		"tsd": "^0.24.1",
+		"typescript": "^4.8.4",
+		"xo": "^0.52.4"
 	},
 	"tsd": {
 		"directory": "test"

package/src/index.d.ts

@@ -85,7 +85,14 @@ declare namespace Keyv {
 		/** Specify an adapter to use. e.g `'redis'` or `'mongodb'`. */
 		adapter?: 'redis' | 'mongodb' | 'mongo' | 'sqlite' | 'postgresql' | 'postgres' | 'mysql' | undefined;
 		/** Enable compression option **/
-		compress?: Record<string, unknown> | undefined;
+		compression?: CompressionAdapter | undefined;
+	}
+
+	interface CompressionAdapter {
+		compress(value: any, options?: any): Promise<any>;
+		decompress(value: any, options?: any): Promise<any>;
+		serialize(value: any): Promise<any>;
+		deserialize(value: any): Promise<any>;
 	}
 
 	interface DeserializedData<Value> {

package/src/index.js

@@ -52,9 +52,8 @@ class Keyv extends EventEmitter {
 
 		if (this.opts.compression) {
 			const compression = this.opts.compression;
-			const {serialize, deserialize} = compression.opts;
-			this.opts.serialize = serialize;
-			this.opts.deserialize = deserialize;
+			this.opts.serialize = compression.serialize.bind(compression);
+			this.opts.deserialize = compression.deserialize.bind(compression);
 		}
 
 		if (typeof this.opts.store.on === 'function' && emitErrors) {
@@ -119,7 +118,7 @@ class Keyv extends EventEmitter {
 			for (const key of keyPrefixed) {
 				promises.push(Promise.resolve()
 					.then(() => store.get(key))
-					.then(data => (typeof data === 'string') ? this.opts.deserialize(data) : data)
+					.then(data => (typeof data === 'string') ? this.opts.deserialize(data) : (this.opts.compression ? this.opts.deserialize(data) : data))
 					.then(data => {
 						if (data === undefined || data === null) {
 							return undefined;
@@ -147,7 +146,7 @@ class Keyv extends EventEmitter {
 
 		return Promise.resolve()
 			.then(() => isArray ? store.getMany(keyPrefixed) : store.get(keyPrefixed))
-			.then(data => (typeof data === 'string') ? this.opts.deserialize(data) : data)
+			.then(data => (typeof data === 'string') ? this.opts.deserialize(data) : (this.opts.compression ? this.opts.deserialize(data) : data))
 			.then(data => {
 				if (data === undefined || data === null) {
 					return undefined;