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

package/dist/cjs/index.d.ts

@@ -0,0 +1,14 @@
+import pako from 'pako';
+import type { Options, Serialize } from './types.js';
+declare class KeyvGzip {
+    opts: Options;
+    constructor(options?: Options);
+    compress(value: pako.Data | string, options?: Options): Promise<Uint8Array>;
+    decompress(value: pako.Data, options?: Options): Promise<Uint8Array>;
+    serialize({ value, expires }: Serialize): Promise<string>;
+    deserialize(data: string): Promise<{
+        value: Uint8Array;
+        expires: number | undefined;
+    }>;
+}
+export default KeyvGzip;

package/dist/{index.js → cjs/index.js}

@@ -2,9 +2,11 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+Object.defineProperty(exports, "__esModule", { value: true });
 const pako_1 = __importDefault(require("pako"));
-const json_buffer_1 = __importDefault(require("json-buffer"));
+const serialize_1 = require("@keyv/serialize");
 class KeyvGzip {
+    opts;
     constructor(options) {
         this.opts = {
             to: 'string',
@@ -21,12 +23,12 @@ class KeyvGzip {
         return pako_1.default.inflate(value, options || this.opts);
     }
     async serialize({ value, expires }) {
-        return json_buffer_1.default.stringify({ value: await this.compress(value), expires });
+        return (0, serialize_1.defaultSerialize)({ value: await this.compress(value), expires });
     }
     async deserialize(data) {
-        const { value, expires } = json_buffer_1.default.parse(data);
+        const { value, expires } = (0, serialize_1.defaultDeserialize)(data);
         return { value: await this.decompress(value), expires };
     }
 }
-module.exports = KeyvGzip;
+exports.default = KeyvGzip;
 //# 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":";;;;;AAAA,gDAAwB;AACxB,+CAAqE;AAGrE,MAAM,QAAQ;IACb,IAAI,CAAU;IACd,YAAY,OAAiB;QAC5B,IAAI,CAAC,IAAI,GAAG;YACX,EAAE,EAAE,QAAQ;YACZ,GAAG,OAAO;SACV,CAAC;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,KAAyB,EAAE,OAAiB;QAC1D,OAAO,cAAI,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAAgB,EAAE,OAAiB;QACnD,IAAI,OAAO,EAAE,CAAC;YACb,OAAO,CAAC,EAAE,GAAG,QAAQ,CAAC;QACvB,CAAC;QAED,OAAO,cAAI,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IAClD,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,IAAY;QAC7B,MAAM,EAAC,KAAK,EAAE,OAAO,EAAC,GAAc,IAAA,8BAAkB,EAAC,IAAI,CAAC,CAAC;QAC7D,OAAO,EAAC,KAAK,EAAE,MAAM,IAAI,CAAC,UAAU,CAAC,KAAkB,CAAC,EAAE,OAAO,EAAC,CAAC;IACpE,CAAC;CACD;AAED,kBAAe,QAAQ,CAAC"}

package/dist/cjs/types.d.ts

@@ -0,0 +1,11 @@
+import type { Data, DeflateFunctionOptions, InflateOptions } from 'pako';
+type PakoDeflateOptions = DeflateFunctionOptions;
+type PakoInflateOptions = InflateOptions & {
+    to?: 'string';
+};
+export type Options = PakoDeflateOptions & PakoInflateOptions;
+export type Serialize = {
+    value: string | Data;
+    expires?: number;
+};
+export {};

package/dist/cjs/types.js

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

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,14 @@
+import pako from 'pako';
+import type { Options, Serialize } from './types.js';
+declare class KeyvGzip {
+    opts: Options;
+    constructor(options?: Options);
+    compress(value: pako.Data | string, options?: Options): Promise<Uint8Array>;
+    decompress(value: pako.Data, options?: Options): Promise<Uint8Array>;
+    serialize({ value, expires }: Serialize): Promise<string>;
+    deserialize(data: string): Promise<{
+        value: Uint8Array;
+        expires: number | undefined;
+    }>;
+}
+export default KeyvGzip;

package/dist/esm/index.js

@@ -0,0 +1,29 @@
+import pako from 'pako';
+import { defaultSerialize, defaultDeserialize } from '@keyv/serialize';
+class KeyvGzip {
+    opts;
+    constructor(options) {
+        this.opts = {
+            to: 'string',
+            ...options,
+        };
+    }
+    async compress(value, options) {
+        return pako.deflate(value, options || this.opts);
+    }
+    async decompress(value, options) {
+        if (options) {
+            options.to = 'string';
+        }
+        return pako.inflate(value, options || this.opts);
+    }
+    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 KeyvGzip;
+//# 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":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAC,gBAAgB,EAAE,kBAAkB,EAAC,MAAM,iBAAiB,CAAC;AAGrE,MAAM,QAAQ;IACb,IAAI,CAAU;IACd,YAAY,OAAiB;QAC5B,IAAI,CAAC,IAAI,GAAG;YACX,EAAE,EAAE,QAAQ;YACZ,GAAG,OAAO;SACV,CAAC;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,KAAyB,EAAE,OAAiB;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAAgB,EAAE,OAAiB;QACnD,IAAI,OAAO,EAAE,CAAC;YACb,OAAO,CAAC,EAAE,GAAG,QAAQ,CAAC;QACvB,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IAClD,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,IAAY;QAC7B,MAAM,EAAC,KAAK,EAAE,OAAO,EAAC,GAAc,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC7D,OAAO,EAAC,KAAK,EAAE,MAAM,IAAI,CAAC,UAAU,CAAC,KAAkB,CAAC,EAAE,OAAO,EAAC,CAAC;IACpE,CAAC;CACD;AAED,eAAe,QAAQ,CAAC"}

package/dist/esm/types.d.ts

@@ -0,0 +1,11 @@
+import type { Data, DeflateFunctionOptions, InflateOptions } from 'pako';
+type PakoDeflateOptions = DeflateFunctionOptions;
+type PakoInflateOptions = InflateOptions & {
+    to?: 'string';
+};
+export type Options = PakoDeflateOptions & PakoInflateOptions;
+export type Serialize = {
+    value: string | Data;
+    expires?: number;
+};
+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,36 +1,31 @@
 {
   "name": "@keyv/compress-gzip",
-  "version": "1.2.3",
+  "version": "2.0.0",
   "description": "gzip 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": {
-    "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"
+    "build": "rm -rf dist && tsc --project tsconfig.cjs.json && tsc --project tsconfig.esm.json",
+    "prepare": "yarn build",
+    "test": "xo --fix && vitest run --coverage",
+    "test:ci": "xo && vitest --run --sequence.setupFiles=list",
+    "clean": "rm -rf node_modules && rm -rf .nyc_output && rm -rf ./dist && rm -rf coverage.lcov && rm -rf ./test/testdb.sqlite"
   },
   "xo": {
     "rules": {
-      "unicorn/prefer-module": 0,
-      "unicorn/prefer-node-protocol": 0,
-      "@typescript-eslint/no-unsafe-assignment": 0,
-      "@typescript-eslint/no-var-requires": 0,
-      "@typescript-eslint/no-require-imports": 0,
-      "@typescript-eslint/naming-convention": 0,
-      "unicorn/prefer-logical-operator-over-ternary": 0
+      "import/extensions": "off",
+      "@typescript-eslint/prefer-nullish-coalescing": "off",
+      "@typescript-eslint/no-unsafe-argument": "off",
+      "import/no-extraneous-dependencies": "off"
     }
   },
-  "ava": {
-    "require": [
-      "ts-node/register"
-    ],
-    "extensions": [
-      "ts"
-    ]
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/jaredwray/keyv.git"
@@ -54,31 +49,23 @@
   },
   "homepage": "https://github.com/jaredwray/keyv",
   "dependencies": {
-    "@types/pako": "^2.0.0",
-    "json-buffer": "^3.0.1",
-    "pako": "^2.1.0"
+    "@types/pako": "^2.0.3",
+    "pako": "^2.1.0",
+    "@keyv/serialize": "*"
   },
   "devDependencies": {
-    "@ava/typescript": "^3.0.1",
     "@keyv/test-suite": "*",
-    "@types/keyv": "^3.1.4",
-    "@typescript-eslint/parser": "^5.48.0",
-    "ava": "^5.1.0",
-    "c8": "^7.12.0",
-    "keyv": "*",
-    "requirable": "^1.0.5",
-    "ts-node": "^10.9.1",
-    "tsd": "^0.25.0",
-    "typescript": "^4.9.4",
-    "xo": "^0.53.1"
+    "tsd": "^0.31.1",
+    "xo": "^0.59.3"
   },
   "tsd": {
     "directory": "test"
   },
   "engines": {
-    "node": ">= 12"
+    "node": ">= 18"
   },
   "files": [
-    "dist"
+    "dist",
+    "LICENSE"
   ]
 }

package/dist/index.d.ts

@@ -1,13 +0,0 @@
-import pako from 'pako';
-declare class KeyvGzip {
-    opts: any;
-    constructor(options?: any);
-    compress(value: pako.Data | string, options?: any): Promise<Uint8Array>;
-    decompress(value: pako.Data, options?: any): Promise<string>;
-    serialize({ value, expires }: any): Promise<string>;
-    deserialize(data: any): Promise<{
-        value: string;
-        expires: any;
-    }>;
-}
-export = KeyvGzip;

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,gDAAwB;AACxB,8DAAgC;AAEhC,MAAM,QAAQ;IAEb,YAAY,OAAa;QACxB,IAAI,CAAC,IAAI,GAAG;YACX,EAAE,EAAE,QAAQ;YACZ,GAAG,OAAO;SACV,CAAC;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,KAAyB,EAAE,OAAa;QACtD,OAAO,cAAI,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAAgB,EAAE,OAAa;QAC/C,IAAI,OAAO,EAAE;YACZ,OAAO,CAAC,EAAE,GAAG,QAAQ,CAAC;SACtB;QAED,OAAO,cAAI,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,EAAC,KAAK,EAAE,OAAO,EAAM;QACpC,OAAO,qBAAK,CAAC,SAAS,CAAC,EAAC,KAAK,EAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,EAAC,CAAC,CAAC;IACtE,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,IAAS;QAC1B,MAAM,EAAC,KAAK,EAAE,OAAO,EAAC,GAAG,qBAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3C,OAAO,EAAC,KAAK,EAAE,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,OAAO,EAAC,CAAC;IACvD,CAAC;CACD;AAED,iBAAS,QAAQ,CAAC"}