keyv 4.4.1 → 4.5.1

package/README.md

@@ -187,6 +187,42 @@ const awesomeModule = new AwesomeModule({ cache: 'redis://localhost' });
 const awesomeModule = new AwesomeModule({ cache: some3rdPartyStore });
 ```
 
+## Compression
+
+Keyv supports `gzip` and `brotli` compression. To enable compression, pass the `compress` option to the constructor.
+
+```js
+const KeyvGzip = require('@keyv/compress-gzip');
+const Keyv = require('keyv');
+
+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])
@@ -224,6 +260,13 @@ Default: `undefined`
 
 Default TTL. Can be overridden by specififying a TTL on `.set()`.
 
+#### options.compression
+
+Type: `@keyv/compress-<compression_package_name>`<br>
+Default: `undefined`
+
+Compression package to use. See [Compression](#compression) for more details.
+
 #### options.serialize
 
 Type: `Function`<br>
@@ -315,7 +358,6 @@ In this section of the documentation we will cover:
 This package requires the following dependencies to run:
 
 1) [Yarn V1](https://yarnpkg.com/getting-started/install)
-2) [Lerna](https://lerna.js.org/)
 3) [Docker](https://docs.docker.com/get-docker/)
 
 ## Setting up your workspace
@@ -337,7 +379,7 @@ Once the project is installed locally, you are ready to start up its services:
 
 ## Available Commands
 
-Once the project is running, you can execute a variety of commands. The root workspace and each subpackage contain a `package.json` file with a  `scripts` field listing all the commands that can be executed from that directory. This project also supports native `yarn`, `lerna`, and `docker` commands.
+Once the project is running, you can execute a variety of commands. The root workspace and each subpackage contain a `package.json` file with a  `scripts` field listing all the commands that can be executed from that directory. This project also supports native `yarn`, and `docker` commands.
 
 Here, we'll cover the primary commands that can be executed from the root directory. Unless otherwise noted, these commands can also be executed from a subpackage. If executed from a subpackage, they will only affect that subpackage, rather than the entire workspace.
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "keyv",
-	"version": "4.4.1",
+	"version": "4.5.1",
 	"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": {
@@ -32,21 +33,20 @@
 	},
 	"homepage": "https://github.com/jaredwray/keyv",
 	"dependencies": {
-		"compress-brotli": "^1.3.8",
 		"json-buffer": "3.0.1"
 	},
 	"devDependencies": {
 		"@keyv/test-suite": "*",
-		"ava": "^4.3.1",
-		"eslint": "^8.22.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 {
+		async compress(value: any, options?: any);
+		async decompress(value: any, options?: any);
+		async serialize(value: any);
+		async deserialize(value: any);
 	}
 
 	interface DeserializedData<Value> {

package/src/index.js

@@ -2,7 +2,6 @@
 
 const EventEmitter = require('events');
 const JSONB = require('json-buffer');
-const compressBrotli = require('compress-brotli');
 
 const loadStore = options => {
 	const adapters = {
@@ -51,13 +50,10 @@ class Keyv extends EventEmitter {
 			this.opts.store = loadStore(adapterOptions);
 		}
 
-		if (this.opts.compress) {
-			const brotli = compressBrotli(this.opts.compress.opts);
-			this.opts.serialize = async ({value, expires}) => brotli.serialize({value: await brotli.compress(value), expires});
-			this.opts.deserialize = async data => {
-				const {value, expires} = brotli.deserialize(data);
-				return {value: await brotli.decompress(value), expires};
-			};
+		if (this.opts.compression) {
+			const compression = this.opts.compression;
+			this.opts.serialize = compression.serialize.bind(compression);
+			this.opts.deserialize = compression.deserialize.bind(compression);
 		}
 
 		if (typeof this.opts.store.on === 'function' && emitErrors) {
@@ -122,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;
@@ -150,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;