@keyv/compress-brotli 1.1.2 → 1.1.3

package/README.md

@@ -1,4 +1,4 @@
-# @keyv/compress-brotli [<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwray/keyv)
+# @keyv/compress-brotli [<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwra/keyv)
 
 > Brotli compression for Keyv
 

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+import type { BrotliOptions, InputType } from 'node:zlib';
+import type { CompressResult, Options, SerializeResult, Serialize } from './types';
+declare class KeyvBrotli {
+    private readonly brotli;
+    constructor(options?: Options);
+    compress(value: any, options?: BrotliOptions): CompressResult;
+    decompress<T>(data: InputType, options?: BrotliOptions): Promise<T>;
+    serialize({ value, expires }: Serialize): Promise<SerializeResult>;
+    deserialize(data: CompressResult): Promise<Serialize>;
+}
+export = KeyvBrotli;

package/dist/index.js

@@ -0,0 +1,48 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const compress_brotli_1 = __importDefault(require("compress-brotli"));
+class KeyvBrotli {
+    constructor(options) {
+        this.brotli = (0, compress_brotli_1.default)(options);
+    }
+    compress(value, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.brotli.compress(value, options);
+        });
+    }
+    decompress(data, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.brotli.decompress(data, options);
+        });
+    }
+    serialize({ value, expires }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const compressValue = yield this.compress(value);
+            // @ts-expect-error - `expires` is not part of the `SerializeResult` type
+            return this.brotli.serialize({ value: compressValue, expires });
+        });
+    }
+    deserialize(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // eslint-disable-next-line @typescript-eslint/no-misused-promises
+            if (!data) {
+                return data;
+            }
+            const { value, expires } = this.brotli.deserialize(data);
+            return { value: yield this.decompress(value), expires };
+        });
+    }
+}
+module.exports = KeyvBrotli;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AACA,sEAA6C;AAG7C,MAAM,UAAU;IAEf,YAAY,OAAiB;QAC5B,IAAI,CAAC,MAAM,GAAG,IAAA,yBAAc,EAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAEK,QAAQ,CAAC,KAAU,EAAE,OAAuB;;YACjD,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAC7C,CAAC;KAAA;IAEK,UAAU,CAAI,IAAe,EAAE,OAAuB;;YAC3D,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAM,CAAC;QACzD,CAAC;KAAA;IAEK,SAAS,CAAC,EAAC,KAAK,EAAE,OAAO,EAAY;;YAC1C,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACjD,yEAAyE;YACzE,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAC,KAAK,EAAE,aAAa,EAAE,OAAO,EAAC,CAAC,CAAC;QAC/D,CAAC;KAAA;IAEK,WAAW,CAAC,IAAoB;;YACrC,kEAAkE;YAClE,IAAI,CAAC,IAAI,EAAE;gBACV,OAAO,IAAI,CAAC;aACZ;YAED,MAAM,EAAC,KAAK,EAAE,OAAO,EAAC,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAc,CAAC;YACpE,OAAO,EAAC,KAAK,EAAE,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,OAAO,EAAC,CAAC;QACvD,CAAC;KAAA;CACD;AAED,iBAAS,UAAU,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,28 @@
+/// <reference types="node" />
+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;
+}
+export {};

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,12 +1,15 @@
 {
 	"name": "@keyv/compress-brotli",
-	"version": "1.1.2",
+	"version": "1.1.3",
 	"description": "brotli compression for keyv",
-	"main": "src/index.js",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
 	"scripts": {
-		"test": "xo && ava --serial",
+		"build": "tsc --project tsconfig.dist.json",
+		"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"
+		"clean": "rm -rf node_modules && rm -rf ./coverage && rm -rf ./test/testdb.sqlite && rm -rf ./dist && rm -rf ./.nyc_output"
 	},
 	"xo": {
 		"rules": {
@@ -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"
@@ -61,25 +55,32 @@
 	},
 	"devDependencies": {
 		"@keyv/test-suite": "*",
-		"ava": "^5.1.0",
-		"c8": "^7.12.0",
+		"ava": "^5.2.0",
+		"c8": "^7.13.0",
 		"json-buffer": "^3.0.1",
 		"keyv": "*",
 		"requirable": "^1.0.5",
 		"ts-node": "^10.9.1",
-		"tsd": "^0.25.0",
-		"typescript": "^4.9.3",
+		"tsd": "^0.26.0",
+		"typescript": "^4.9.5",
 		"webpack": "^5.75.0",
 		"xo": "^0.53.1"
 	},
 	"tsd": {
 		"directory": "test"
 	},
-	"types": "./src/index.d.ts",
 	"engines": {
 		"node": ">= 12"
 	},
 	"files": [
-		"src"
-	]
+		"dist"
+	],
+	"ava": {
+		"extensions": [
+			"ts"
+		],
+		"require": [
+			"ts-node/register"
+		]
+	}
 }

package/src/index.d.ts

@@ -1,24 +0,0 @@
-import type {InputType, BrotliOptions, CompressCallback} from 'node:zlib';
-import type Brotli, {CompressResult} from 'compress-brotli';
-
-declare class KeyvBrotli {
-	brotli: Brotli;
-	constructor(options?: KeyvBrotli.Options);
-	compress(value: InputType | number | boolean, options?: BrotliOptions): Promise<any>;
-	decompress(value: InputType | number | boolean, options?: BrotliOptions): Promise<any>;
-	serialize(value: any): Promise<any>;
-	deserialize(value: any): Promise<any>;
-}
-
-declare namespace KeyvBrotli {
-	interface Options {
-		compressOptions?: BrotliOptions;
-		decompressOptions?: BrotliOptions;
-		enable?: boolean;
-		serialize?: any;
-		deserialize?: any;
-		iltorb?: any;
-	}
-}
-
-export = KeyvBrotli;

package/src/index.js

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