@keyv/compress-brotli 1.1.5 → 2.0.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2017-2021 Luke Childs
+Copyright (c) 2021-2022 Jared Wray
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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/jaredwra/keyv)
+# @keyv/compress-brotli [<img width="100" align="right" src="https://jaredwray.com/images/keyv-symbol.svg" alt="keyv">](https://github.com/jaredwra/keyv)
 
 > Brotli compression for Keyv
 
@@ -20,8 +20,8 @@ npm install --save keyv @keyv/compress-brotli
 ## Usage
 
 ```javascript
-const KeyvBrotli = require('@keyv/compress-brotli');
-const Keyv = require('keyv');
+import Keyv from 'keyv';
+import KeyvBrotli from '@keyv/compress-brotli';
 
 const keyv = new Keyv({store: new Map(), compression: new KeyvBrotli()});
 
@@ -33,8 +33,8 @@ const keyv = new Keyv({store: new Map(), compression: new KeyvBrotli()});
 
 #### options
 
-All options for @keyv/compress-brotli are based on the package [compress-brotli](https://github.com/Kikobeats/compress-brotli)
+All options for `@keyv/compress-brotli` are based on the package [compress-brotli](https://github.com/Kikobeats/compress-brotli)
 
 ## License
 
-MIT © Jared Wray
+[MIT © Jared Wray](LICENSE)

package/dist/{index.d.ts → cjs/index.d.ts}

@@ -1,6 +1,5 @@
-/// <reference types="node" />
 import type { BrotliOptions, InputType } from 'node:zlib';
-import type { CompressResult, Options, SerializeResult, Serialize } from './types';
+import type { CompressResult, Options, SerializeResult, Serialize } from './types.js';
 declare class KeyvBrotli {
     private readonly brotli;
     constructor(options?: Options);
@@ -9,4 +8,4 @@ declare class KeyvBrotli {
     serialize({ value, expires }: Serialize): Promise<SerializeResult>;
     deserialize(data: CompressResult): Promise<Serialize>;
 }
-export = KeyvBrotli;
+export default KeyvBrotli;

package/dist/cjs/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const compress_brotli_1 = __importDefault(require("compress-brotli"));
+const serialize_1 = require("@keyv/serialize");
+class KeyvBrotli {
+    brotli;
+    constructor(options) {
+        this.brotli = (0, compress_brotli_1.default)(options);
+    }
+    async compress(value, options) {
+        return this.brotli.compress(value, options);
+    }
+    async decompress(data, options) {
+        return await this.brotli.decompress(data, options);
+    }
+    async serialize({ value, expires }) {
+        return (0, serialize_1.defaultSerialize)({ value: await this.compress(value), expires });
+    }
+    async deserialize(data) {
+        const { value, expires } = (0, serialize_1.defaultDeserialize)(data);
+        return { value: await this.decompress(value), expires };
+    }
+}
+exports.default = KeyvBrotli;
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;AACA,sEAA6C;AAC7C,+CAAqE;AAKrE,MAAM,UAAU;IACE,MAAM,CAAS;IAChC,YAAY,OAAiB;QAC5B,IAAI,CAAC,MAAM,GAAG,IAAA,yBAAc,EAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,KAAU,EAAE,OAAuB;QACjD,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,UAAU,CAAI,IAAe,EAAE,OAAuB;QAC3D,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAM,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,EAAC,KAAK,EAAE,OAAO,EAAY;QAC1C,OAAO,IAAA,4BAAgB,EAAC,EAAC,KAAK,EAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,EAAC,CAAC,CAAC;IACvE,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAoB;QACrC,MAAM,EAAC,KAAK,EAAE,OAAO,EAAC,GAAc,IAAA,8BAAkB,EAAC,IAAI,CAAC,CAAC;QAC7D,OAAO,EAAC,KAAK,EAAE,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,OAAO,EAAC,CAAC;IACvD,CAAC;CACD;AAED,kBAAe,UAAU,CAAC"}

package/dist/{types.d.ts → cjs/types.d.ts}

@@ -1,10 +1,8 @@
-/// <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>;
+export type DecompressResult = Promise<any>;
+export type SerializeResult = string;
+export type DeserializeResult = any;
 type BrotliSerialize<T> = (source: InputType) => T;
 type BrotliDeserialize<T> = (source: CompressResult) => T;
 export type Serialize = {

package/dist/cjs/types.js.map

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

package/dist/esm/index.d.ts

@@ -0,0 +1,11 @@
+import type { BrotliOptions, InputType } from 'node:zlib';
+import type { CompressResult, Options, SerializeResult, Serialize } from './types.js';
+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 default KeyvBrotli;

package/dist/esm/index.js

@@ -0,0 +1,23 @@
+import compressBrotli from 'compress-brotli';
+import { defaultDeserialize, defaultSerialize } from '@keyv/serialize';
+class KeyvBrotli {
+    brotli;
+    constructor(options) {
+        this.brotli = compressBrotli(options);
+    }
+    async compress(value, options) {
+        return this.brotli.compress(value, options);
+    }
+    async decompress(data, options) {
+        return await this.brotli.decompress(data, options);
+    }
+    async serialize({ value, expires }) {
+        return defaultSerialize({ value: await this.compress(value), expires });
+    }
+    async deserialize(data) {
+        const { value, expires } = defaultDeserialize(data);
+        return { value: await this.decompress(value), expires };
+    }
+}
+export default KeyvBrotli;
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,cAAc,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAC,kBAAkB,EAAE,gBAAgB,EAAC,MAAM,iBAAiB,CAAC;AAKrE,MAAM,UAAU;IACE,MAAM,CAAS;IAChC,YAAY,OAAiB;QAC5B,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,KAAU,EAAE,OAAuB;QACjD,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,UAAU,CAAI,IAAe,EAAE,OAAuB;QAC3D,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,CAAM,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,EAAC,KAAK,EAAE,OAAO,EAAY;QAC1C,OAAO,gBAAgB,CAAC,EAAC,KAAK,EAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,EAAC,CAAC,CAAC;IACvE,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAoB;QACrC,MAAM,EAAC,KAAK,EAAE,OAAO,EAAC,GAAc,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC7D,OAAO,EAAC,KAAK,EAAE,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,OAAO,EAAC,CAAC;IACvD,CAAC;CACD;AAED,eAAe,UAAU,CAAC"}

package/dist/esm/types.d.ts

@@ -0,0 +1,26 @@
+import type { BrotliOptions, CompressCallback, InputType } from 'node:zlib';
+export type CompressResult = Promise<Parameters<CompressCallback>[1]>;
+export type DecompressResult = Promise<any>;
+export type SerializeResult = string;
+export type DeserializeResult = any;
+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/esm/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/types.js.map

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

package/package.json

@@ -1,32 +1,31 @@
 {
 	"name": "@keyv/compress-brotli",
-	"version": "1.1.5",
+	"version": "2.0.0",
 	"description": "brotli compression for keyv",
-	"main": "dist/index.js",
-	"types": "dist/index.d.ts",
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"types": "dist/esm/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.js",
+			"import": "./dist/esm/index.js"
+		}
+	},
 	"scripts": {
-		"build": "tsc --project tsconfig.dist.json",
+		"build": "rm -rf dist && tsc --project tsconfig.cjs.json && tsc --project tsconfig.esm.json",
 		"prepare": "yarn build",
-		"test": "xo && c8 ava --serial",
-		"test:ci": "xo && ava --serial",
+		"test": "xo --fix && vitest run --coverage",
+		"test:ci": "xo && vitest --run --sequence.setupFiles=list",
 		"clean": "rm -rf node_modules && rm -rf ./coverage && rm -rf ./test/testdb.sqlite && rm -rf ./dist && rm -rf ./.nyc_output"
 	},
 	"xo": {
 		"rules": {
-			"unicorn/prefer-module": 0,
-			"@typescript-eslint/no-unsafe-call": 0,
-			"@typescript-eslint/consistent-type-definitions": 0,
-			"@typescript-eslint/no-unsafe-argument": 0,
-			"ava/no-ignored-test-files": [
-				"error",
-				{
-					"extensions": [
-						"js",
-						"ts"
-					]
-				}
-			],
-			"import/extensions": 0
+			"unicorn/prefer-module": "off",
+			"@typescript-eslint/no-unsafe-call": "off",
+			"@typescript-eslint/consistent-type-definitions": "off",
+			"@typescript-eslint/no-unsafe-argument": "off",
+			"import/extensions": "off",
+			"import/no-extraneous-dependencies": "off"
 		}
 	},
 	"repository": {
@@ -52,32 +51,23 @@
 	},
 	"homepage": "https://github.com/jaredwray/keyv",
 	"dependencies": {
-		"compress-brotli": "^1.3.11"
+		"compress-brotli": "^1.3.12",
+		"keyv": "^5.0.0",
+		"@keyv/serialize": "*"
 	},
 	"devDependencies": {
 		"@keyv/test-suite": "*",
-		"c8": "^8.0.1",
-		"json-buffer": "^3.0.1",
-		"keyv": "*",
-		"requirable": "^1.0.5",
-		"tsd": "^0.29.0",
-		"webpack": "^5.88.2"
+		"c8": "^10.1.2",
+		"xo": "^0.59.3"
 	},
 	"tsd": {
 		"directory": "test"
 	},
 	"engines": {
-		"node": ">= 12"
+		"node": ">= 18"
 	},
 	"files": [
-		"dist"
-	],
-	"ava": {
-		"extensions": [
-			"ts"
-		],
-		"require": [
-			"ts-node/register"
-		]
-	}
+		"dist",
+		"LICENSE"
+	]
 }

package/dist/index.js

@@ -1,48 +0,0 @@
-"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

@@ -1 +0,0 @@
-{"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.js.map

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