compress-brotli package using typescript (#693)

* refactor for KeyvBrotli to use typescript

* add full testing and types

* fix common require for brotli module

* add build and prepare command for packages

* add sourcemap for emitted js files

Author: Christian Llontop

package.json

@@ -10,7 +10,7 @@
     "packages/*"
   ],
   "scripts": {
-    "build": "yarn workspace @keyv/test-suite run build",
+    "build": "yarn workspaces run build",
     "test": " yarn build && c8 --reporter=lcov yarn workspaces run test:ci",
     "test:services:start": "docker-compose -f ./docker-compose.yaml up -d",
     "test:services:stop": "docker-compose -f ./docker-compose.yaml down -v",

packages/compress-brotli/package.json

@@ -2,8 +2,11 @@
 	"name": "@keyv/compress-brotli",
 	"version": "1.1.2",
 	"description": "brotli compression for keyv",
-	"main": "src/index.js",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
 	"scripts": {
+		"build": "tsc",
+		"prepare": "yarn build",
 		"test": "xo && c8 ava --serial",
 		"test:ci": "xo && ava --serial",
 		"clean": "rm -rf node_modules && rm -rf ./coverage && rm -rf ./test/testdb.sqlite"
@@ -21,19 +24,10 @@
 						"ts"
 					]
 				}
-			]
+			],
+			"import/extensions": 0
 		}
 	},
-	"ava": {
-		"require": [
-			"requirable",
-			"ts-node/register"
-		],
-		"extensions": [
-			"js",
-			"ts"
-		]
-	},
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/jaredwray/keyv.git"
@@ -75,11 +69,18 @@
 	"tsd": {
 		"directory": "test"
 	},
-	"types": "./src/index.d.ts",
 	"engines": {
 		"node": ">= 12"
 	},
 	"files": [
 		"src"
-	]
+	],
+	"ava": {
+		"extensions": [
+			"ts"
+		],
+		"require": [
+			"ts-node/register"
+		]
+	}
 }

packages/compress-brotli/src/index.d.ts

@@ -0,0 +1,36 @@
+import type {BrotliOptions, InputType} from 'node:zlib';
+import compressBrotli from 'compress-brotli';
+import type {Brotli, CompressResult, Options, SerializeResult, Serialize} from './types';
+
+class KeyvBrotli {
+	private readonly brotli: Brotli;
+	constructor(options?: Options) {
+		this.brotli = compressBrotli(options);
+	}
+
+	async compress(value: any, options?: BrotliOptions): CompressResult {
+		return this.brotli.compress(value, options);
+	}
+
+	async decompress<T>(data: InputType, options?: BrotliOptions): Promise<T> {
+		return await this.brotli.decompress(data, options) as T;
+	}
+
+	async serialize({value, expires}: Serialize): Promise<SerializeResult> {
+		const compressValue = await this.compress(value);
+		// @ts-expect-error - `expires` is not part of the `SerializeResult` type
+		return this.brotli.serialize({value: compressValue, expires});
+	}
+
+	async deserialize(data: CompressResult): Promise<Serialize> {
+		// eslint-disable-next-line @typescript-eslint/no-misused-promises
+		if (!data) {
+			return data;
+		}
+
+		const {value, expires} = this.brotli.deserialize(data) as Serialize;
+		return {value: await this.decompress(value), expires};
+	}
+}
+
+export = KeyvBrotli;

packages/compress-brotli/src/index.js

@@ -0,0 +1,32 @@
+import type {BrotliOptions, CompressCallback, InputType} from 'node:zlib';
+import type {parse as JSONBparse, stringify as JSONBstringify} from 'json-buffer';
+
+export type CompressResult = Promise<Parameters<CompressCallback>[1]>;
+export type DecompressResult = Promise<ReturnType<typeof JSONBparse>>;
+
+export type SerializeResult = ReturnType<typeof JSONBstringify>;
+export type DeserializeResult = ReturnType<typeof JSONBparse>;
+
+type BrotliSerialize<T> = (source: InputType) => T;
+type BrotliDeserialize<T> = (source: CompressResult) => T;
+
+export type Serialize = {
+	value: InputType;
+	expires?: number;
+};
+
+export interface Options {
+	compressOptions?: BrotliOptions;
+	decompressOptions?: BrotliOptions;
+	enable?: boolean;
+	serialize?: any;
+	deserialize?: any;
+	iltorb?: any;
+}
+
+export interface Brotli {
+	serialize: BrotliSerialize<SerializeResult>;
+	deserialize: BrotliDeserialize<DeserializeResult>;
+	compress: (data: InputType, options?: BrotliOptions) => CompressResult;
+	decompress: (data: InputType, options?: BrotliOptions) => DecompressResult;
+}

packages/compress-brotli/src/index.ts

@@ -1,14 +1,13 @@
-const {
-	constants: {
-		BROTLI_PARAM_MODE,
-		BROTLI_PARAM_QUALITY,
-	},
-} = require('node:zlib');
-const v8 = require('node:v8');
-const test = require('ava');
-const json = require('json-buffer');
-const {keyvCompresstionTests} = require('@keyv/test-suite');
-const KeyvBrotli = require('../src/index.js');
+import {constants as zlibConstants} from 'node:zlib';
+import v8 from 'node:v8';
+import test from 'ava';
+import json from 'json-buffer';
+import {keyvCompresstionTests} from '@keyv/test-suite';
+import KeyvBrotli from '../src/index';
+import type {DeserializeResult} from '../src/types';
+
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const {BROTLI_PARAM_MODE, BROTLI_PARAM_QUALITY} = zlibConstants;
 
 keyvCompresstionTests(test, new KeyvBrotli());
 
@@ -20,7 +19,7 @@ test('object type compression/decompression', async t => {
 		c: true,
 	};
 	const compressed = await keyv.compress(object);
-	const decompressed = await keyv.decompress(compressed, {});
+	const decompressed = await keyv.decompress(compressed);
 	t.deepEqual(decompressed, object);
 });
 
@@ -30,8 +29,9 @@ test('disable brotli compression', async t => {
 	};
 	const keyv = new KeyvBrotli(options);
 	const compressed = await keyv.compress('whatever');
+	// @ts-expect-error Testing non-compressed value
 	t.is(compressed, 'whatever');
-	const decompressed = await keyv.decompress(compressed);
+	const decompressed: DeserializeResult = await keyv.decompress(compressed);
 	t.is(decompressed, 'whatever');
 });
 
@@ -117,7 +117,9 @@ test('decompression using number array with json-buffer', async t => {
 
 test('deserialize with an empty value', async t => {
 	const keyv = new KeyvBrotli();
+	// @ts-expect-error - Testing empty value
 	const deserialized = await keyv.deserialize('');
 
+	// @ts-expect-error - empty value
 	t.is(deserialized, '');
 });

packages/compress-brotli/src/types.ts

@@ -3,7 +3,7 @@ import v8 from 'node:v8';
 import test from 'ava';
 import Keyv from 'keyv';
 import json from 'json-buffer';
-import KeyvBrotli from '../src/index.js';
+import KeyvBrotli from '../src/index';
 
 type MyType = {
 	a?: string;

packages/compress-brotli/test/test.js renamed to packages/compress-brotli/test/test.ts

@@ -0,0 +1,32 @@
+{
+  "compilerOptions": {
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    "baseUrl": "./src",                                  /* Specify the base directory to resolve non-relative module names. */
+
+    /* Emit */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
+
+    /* Interop Constraints */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+
+    /* Completeness */
+    "skipLibCheck": true,                     /* Skip type checking all .d.ts files. */
+    "lib": [
+      "es2016"
+    ]
+  },
+  "include": [
+    "src/**/*"
+  ]
+}

packages/compress-brotli/test/types.ts

@@ -5,10 +5,10 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
+    "build": "tsc",
+    "prepare": "yarn build",
     "test": "xo && yarn run build && c8 ava --serial",
     "test:ci": "xo && yarn run build && ava --serial",
-    "prepare": "yarn run build",
-    "build": "tsc",
     "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"
   },

packages/compress-brotli/tsconfig.json

@@ -4,6 +4,8 @@
 	"description": "Etcd storage adapter for Keyv",
 	"main": "src/index.js",
 	"scripts": {
+		"build": "echo 'No build step required.'",
+		"prepare": "yarn build",
 		"test": "xo && c8 ava --serial",
 		"test:ci": "xo && ava --serial",
 		"clean": "rm -rf node_modules && rm -rf ./coverage"

packages/compress-gzip/package.json

@@ -4,6 +4,8 @@
 	"description": "Simple key-value storage with support for multiple backends",
 	"main": "src/index.js",
 	"scripts": {
+		"build": "echo 'No build step required.'",
+		"prepare": "yarn build",
 		"test": "xo && c8 ava --serial",
 		"test:ci": "xo && ava --serial",
 		"clean": "rm -rf node_modules && rm -rf ./coverage && rm -rf ./test/testdb.sqlite"

packages/etcd/package.json

@@ -4,6 +4,8 @@
 	"description": "Memcache storage adapter for Keyv",
 	"main": "src/index.js",
 	"scripts": {
+		"build": "echo 'No build step required.'",
+		"prepare": "yarn build",
 		"test": "xo && c8 ava --serial",
 		"test:ci": "xo && ava --serial",
 		"clean": "rm -rf node_modules && rm -rf ./coverage"

packages/keyv/package.json

@@ -4,6 +4,8 @@
 	"description": "MongoDB storage adapter for Keyv",
 	"main": "src/index.js",
 	"scripts": {
+		"build": "echo 'No build step required.'",
+		"prepare": "yarn build",
 		"test": "xo && c8 ava --serial",
 		"test:ci": "xo && ava --serial",
 		"clean": "rm -rf node_modules && rm -rf ./coverage"

packages/memcache/package.json

@@ -4,6 +4,8 @@
 	"description": "MySQL/MariaDB storage adapter for Keyv",
 	"main": "src/index.js",
 	"scripts": {
+		"build": "echo 'No build step required.'",
+		"prepare": "yarn build",
 		"test": "xo && c8 ava --serial",
 		"test:ci": "xo && ava --serial",
 		"clean": "rm -rf node_modules && rm -rf ./coverage"

packages/mongo/package.json

@@ -4,6 +4,8 @@
 	"description": "Offline storage adapter for Keyv",
 	"main": "src/index.js",
 	"scripts": {
+		"build": "echo 'No build step required.'",
+		"prepare": "yarn build",
 		"test": "xo && c8 ava --serial",
 		"test:ci": "xo && ava --serial",
 		"clean": "rm -rf node_modules && rm -rf ./coverage && rm -rf ./test/testdb.sqlite"

packages/mysql/package.json

@@ -4,6 +4,8 @@
 	"description": "PostgreSQL storage adapter for Keyv",
 	"main": "src/index.js",
 	"scripts": {
+		"build": "echo 'No build step required.'",
+		"prepare": "yarn build",
 		"test": "xo && c8 ava --serial",
 		"test:ci": "xo && ava --serial",
 		"clean": "rm -rf node_modules && rm -rf ./coverage"

packages/offline/package.json

@@ -4,6 +4,8 @@
 	"description": "Redis storage adapter for Keyv",
 	"main": "src/index.js",
 	"scripts": {
+		"build": "echo 'No build step required.'",
+		"prepare": "yarn build",
 		"test": "xo && c8 ava --serial",
 		"test:ci": "xo && ava --serial",
 		"clean": "rm -rf node_modules && rm -rf ./coverage"

packages/postgres/package.json

@@ -4,6 +4,8 @@
 	"description": "SQLite storage adapter for Keyv",
 	"main": "src/index.js",
 	"scripts": {
+		"build": "echo 'No build step required.'",
+		"prepare": "yarn build",
 		"test": "xo && c8 ava --serial",
 		"test:ci": "xo && ava --serial",
 		"clean": "rm -rf node_modules && rm -rf ./coverage && rm -rf ./test/testdb.sqlite"

packages/redis/package.json

@@ -8,8 +8,8 @@
 	"scripts": {
 		"build": "tsc",
 		"prepare": "yarn build",
-		"test": "yarn build && xo && c8 ava --serial",
-		"test:ci": "yarn build && xo && ava --serial",
+		"test": "xo && c8 ava --serial",
+		"test:ci": "xo && ava --serial",
 		"clean": "rm -rf node_modules && rm -rf ./coverage && rm -rf dist && rm -rf ./test/testdb.sqlite"
 	},
 	"xo": {