@keyv/compress-gzip 1.2.3 → 2.0.1

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/index.cjs

@@ -0,0 +1,68 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  KeyvGzip: () => KeyvGzip,
+  default: () => src_default
+});
+module.exports = __toCommonJS(src_exports);
+var import_pako = __toESM(require("pako"), 1);
+var import_serialize = require("@keyv/serialize");
+var KeyvGzip = class {
+  opts;
+  constructor(options) {
+    this.opts = {
+      to: "string",
+      ...options
+    };
+  }
+  async compress(value, options) {
+    return import_pako.default.deflate(value, options || this.opts);
+  }
+  async decompress(value, options) {
+    if (options) {
+      options.to = "string";
+    }
+    return import_pako.default.inflate(value, options || this.opts);
+  }
+  async serialize({ value, expires }) {
+    return (0, import_serialize.defaultSerialize)({ value: await this.compress(value), expires });
+  }
+  async deserialize(data) {
+    const { value, expires } = (0, import_serialize.defaultDeserialize)(data);
+    return { value: await this.decompress(value), expires };
+  }
+};
+var src_default = KeyvGzip;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  KeyvGzip
+});

package/dist/index.d.cts

@@ -0,0 +1,25 @@
+import pako, { Data, DeflateFunctionOptions, InflateOptions } from 'pako';
+
+type PakoDeflateOptions = DeflateFunctionOptions;
+type PakoInflateOptions = InflateOptions & {
+    to?: 'string';
+};
+type Options = PakoDeflateOptions & PakoInflateOptions;
+type Serialize = {
+    value: string | Data;
+    expires?: number;
+};
+
+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 { KeyvGzip, KeyvGzip as default };

package/dist/index.d.ts

@@ -1,13 +1,25 @@
-import pako from 'pako';
+import pako, { Data, DeflateFunctionOptions, InflateOptions } from 'pako';
+
+type PakoDeflateOptions = DeflateFunctionOptions;
+type PakoInflateOptions = InflateOptions & {
+    to?: 'string';
+};
+type Options = PakoDeflateOptions & PakoInflateOptions;
+type Serialize = {
+    value: string | Data;
+    expires?: number;
+};
+
 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;
+    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 = KeyvGzip;
+
+export { KeyvGzip, KeyvGzip as default };

package/dist/index.js

@@ -1,32 +1,33 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const pako_1 = __importDefault(require("pako"));
-const json_buffer_1 = __importDefault(require("json-buffer"));
-class KeyvGzip {
-    constructor(options) {
-        this.opts = {
-            to: 'string',
-            ...options,
-        };
-    }
-    async compress(value, options) {
-        return pako_1.default.deflate(value, options || this.opts);
-    }
-    async decompress(value, options) {
-        if (options) {
-            options.to = 'string';
-        }
-        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 });
+// src/index.ts
+import pako from "pako";
+import { defaultSerialize, defaultDeserialize } from "@keyv/serialize";
+var KeyvGzip = class {
+  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";
     }
-    async deserialize(data) {
-        const { value, expires } = json_buffer_1.default.parse(data);
-        return { value: await this.decompress(value), expires };
-    }
-}
-module.exports = KeyvGzip;
-//# sourceMappingURL=index.js.map
+    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 };
+  }
+};
+var src_default = KeyvGzip;
+export {
+  KeyvGzip,
+  src_default as default
+};

package/package.json

@@ -1,36 +1,33 @@
 {
   "name": "@keyv/compress-gzip",
-  "version": "1.2.3",
+  "version": "2.0.1",
   "description": "gzip compression for keyv",
-  "main": "dist/index.js",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/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 && tsup src/index.ts --format cjs,esm --dts --clean",
+    "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/no-named-as-default": "off",
+      "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 +51,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.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"}