@keyv/compress-brotli 1.0.0

package/README.md

@@ -0,0 +1,40 @@
+# @keyv/tiered [<img width="100" align="right" src="https://rawgit.com/lukechilds/keyv/master/media/logo.svg" alt="keyv">](https://github.com/lukechilds/keyv)
+
+> Brotli compression for Keyv
+
+[![build](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml/badge.svg)](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml)
+[![codecov](https://codecov.io/gh/jaredwray/keyv/branch/main/graph/badge.svg?token=bRzR3RyOXZ)](https://codecov.io/gh/jaredwray/keyv)
+[![npm](https://img.shields.io/npm/v/@keyv/compress-brotli.svg)](https://www.npmjs.com/package/@keyv/compress-brotli)
+[![npm](https://img.shields.io/npm/dm/@keyv/compress-brotli)](https://npmjs.com/package/@keyv/compress-brotli)
+
+Brotli compression for [Keyv](https://github.com/jaredwray/keyv).
+
+Brotli is a data compression algorithm that is designed to be fast and efficient.
+
+## Install
+
+```shell
+npm install --save keyv @keyv/compress-brotli
+```
+
+## Usage
+
+```javascript
+const KeyvBrotli = require('@keyv/compress-brotli');
+const Keyv = require('keyv');
+
+const keyv = new Keyv({store: new Map(), compression: new KeyvBrotli()});
+
+```
+
+## API
+
+### @keyv/compress-brotli(\[options])
+
+#### options
+
+All options for @keyv/compress-brotli are based on the package [compress-brotli](https://github.com/Kikobeats/compress-brotli)
+
+## License
+
+MIT © Jared Wray

package/package.json

@@ -0,0 +1,84 @@
+{
+	"name": "@keyv/compress-brotli",
+	"version": "1.0.0",
+	"description": "brotli compression for keyv",
+	"main": "src/index.js",
+	"scripts": {
+		"test": "xo && nyc ava --serial",
+		"coverage": "nyc report --reporter=text-lcov > coverage.lcov",
+		"clean": "rm -rf node_modules && rm -rf .nyc_output && rm -rf coverage.lcov && rm -rf ./test/testdb.sqlite"
+	},
+	"xo": {
+		"rules": {
+			"unicorn/prefer-module": 0,
+			"@typescript-eslint/no-unsafe-call": 0,
+			"ava/no-ignored-test-files": [
+				"error",
+				{
+					"extensions": [
+						"js",
+						"ts"
+					]
+				}
+			]
+		}
+	},
+	"ava": {
+		"require": [
+			"requirable",
+			"ts-node/register"
+		],
+		"extensions": [
+			"js",
+			"ts"
+		]
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/jaredwray/keyv.git"
+	},
+	"keywords": [
+		"compress",
+		"brotli",
+		"keyv",
+		"storage",
+		"adapter",
+		"key",
+		"value",
+		"store",
+		"cache",
+		"ttl"
+	],
+	"author": "Jared Wray <me@jaredwray.com> (http://jaredwray.com)",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/jaredwray/keyv/issues"
+	},
+	"homepage": "https://github.com/jaredwray/keyv",
+	"dependencies": {
+		"compress-brotli": "^1.3.8"
+	},
+	"devDependencies": {
+		"@types/keyv": "^3.1.4",
+		"ava": "^4.2.0",
+		"keyv": "*",
+		"nyc": "^15.1.0",
+		"requirable": "^1.0.5",
+		"this": "^1.1.0",
+		"ts-node": "^10.8.2",
+		"tsd": "^0.20.0",
+		"typescript": "^4.6.4",
+		"webpack": "^5.74.0",
+		"xo": "^0.48.0"
+	},
+	"tsd": {
+		"directory": "test"
+	},
+	"types": "./src/index.d.ts",
+	"engines": {
+		"node": ">= 12"
+	},
+	"files": [
+		"src"
+	]
+}

package/src/index.d.ts

@@ -0,0 +1,19 @@
+import {EventEmitter} from 'node:events';
+import {Store, StoredData} from 'keyv';
+
+declare class KeyvBrotli extends EventEmitter implements Store<Value> {
+	ttlSupport: any;
+	opts: any;
+	constructor(options?: string | KeyvBrotli.Options);
+	compress(value: Value);
+	decompress(value: Value);
+}
+
+declare namespace KeyvBrotli {
+	interface Options {
+		compress: (...args: any[]) => void;
+		decompress: (...args: any[]) => void;
+	}
+}
+
+export = KeyvBrotli;

package/src/index.js

@@ -0,0 +1,31 @@
+'use strict';
+const compressBrotli = require('compress-brotli');
+
+class KeyvBrotli {
+	constructor(options) {
+		this.opts = {
+			...options,
+		};
+
+		const {compress, decompress, serialize, deserialize} = compressBrotli(this.opts);
+
+		this.opts.compress = compress;
+		this.opts.serialize = async ({value, expires}) => serialize({value: await compress(value), expires});
+
+		this.opts.decompress = decompress;
+		this.opts.deserialize = async data => {
+			const {value, expires} = deserialize(data);
+			return {value: await decompress(value), expires};
+		};
+	}
+
+	compress(value, options) {
+		return this.opts.compress(value, options);
+	}
+
+	decompress(value, options) {
+		return this.opts.decompress(value, options);
+	}
+}
+
+module.exports = KeyvBrotli;