@keyv/compress-lz4 1.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

@@ -0,0 +1,40 @@
+# @keyv/compress-lz4 [<img width="100" align="right" src="https://jaredwray.com/images/keyv-symbol.svg" alt="keyv">](https://github.com/jaredwra/keyv)
+
+> lz4 compression for Keyv
+
+[![build](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml/badge.svg)](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml)
+[![codecov](https://codecov.io/gh/jaredwray/keyv/branch/main/graph/badge.svg?token=bRzR3RyOXZ)](https://codecov.io/gh/jaredwray/keyv)
+[![npm](https://img.shields.io/npm/v/@keyv/compress-lz4.svg)](https://www.npmjs.com/package/@keyv/compress-lz4)
+[![npm](https://img.shields.io/npm/dm/@keyv/compress-lz4)](https://npmjs.com/package/@keyv/compress-lz4)
+
+lz4 compression for [Keyv](https://github.com/jaredwray/keyv).
+
+`lz4` is a data compression algorithm that is designed to be fast and efficient and is provided by the package [lz4-napi](https://npmjs.com/package/lz4-napi).
+
+## Install
+
+```shell
+npm install --save keyv @keyv/compress-lz4
+```
+
+## Usage
+
+```javascript
+import Keyv from 'keyv';
+import KeyvLz4 from '@keyv/compress-lz4';
+
+const keyv = new Keyv({store: new Map(), compression: new KeyvLz4()});
+
+```
+
+## API
+
+### @keyv/compress-lz4(\[options])
+
+#### options
+
+All options for `@keyv/compress-lz4` are based on the package [lz4-napi](https://npmjs.com/package/lz4-napi).
+
+## License
+
+[MIT © Jared Wray](LICENSE)

package/dist/index.cjs

@@ -0,0 +1,60 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  KeyvLz4: () => KeyvLz4,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var import_lz4_napi = require("lz4-napi");
+var import_serialize = require("@keyv/serialize");
+var KeyvLz4 = class {
+  constructor(dictionary) {
+    this.dictionary = dictionary;
+  }
+  async compress(data) {
+    return (0, import_lz4_napi.compress)(Buffer.from(data), this.getDictionary());
+  }
+  async decompress(data) {
+    const value = await (0, import_lz4_napi.uncompress)(Buffer.from(data), this.getDictionary());
+    return value.toString("utf8");
+  }
+  async serialize({ value, expires }) {
+    const compressedUint8Array = await this.compress(value);
+    return (0, import_serialize.defaultSerialize)({ value: compressedUint8Array, expires });
+  }
+  async deserialize(data) {
+    const { value, expires } = (0, import_serialize.defaultDeserialize)(data);
+    const uncompressedUint8Array = await this.decompress(value);
+    return { value: uncompressedUint8Array, expires };
+  }
+  getDictionary() {
+    if (this.dictionary) {
+      return Buffer.from(this.dictionary);
+    }
+    return void 0;
+  }
+};
+var index_default = KeyvLz4;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  KeyvLz4
+});

package/dist/index.d.cts

@@ -0,0 +1,16 @@
+type Serialize = {
+    value: string;
+    expires?: number;
+};
+
+declare class KeyvLz4 {
+    private readonly dictionary?;
+    constructor(dictionary?: string | undefined);
+    compress(data: string): Promise<Uint8Array>;
+    decompress(data: Uint8Array): Promise<string>;
+    serialize({ value, expires }: Serialize): Promise<string>;
+    deserialize(data: string): Promise<Serialize>;
+    private getDictionary;
+}
+
+export { KeyvLz4, KeyvLz4 as default };

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+type Serialize = {
+    value: string;
+    expires?: number;
+};
+
+declare class KeyvLz4 {
+    private readonly dictionary?;
+    constructor(dictionary?: string | undefined);
+    compress(data: string): Promise<Uint8Array>;
+    decompress(data: Uint8Array): Promise<string>;
+    serialize({ value, expires }: Serialize): Promise<string>;
+    deserialize(data: string): Promise<Serialize>;
+    private getDictionary;
+}
+
+export { KeyvLz4, KeyvLz4 as default };

package/dist/index.js

@@ -0,0 +1,35 @@
+// src/index.ts
+import { compress, uncompress } from "lz4-napi";
+import { defaultDeserialize, defaultSerialize } from "@keyv/serialize";
+var KeyvLz4 = class {
+  constructor(dictionary) {
+    this.dictionary = dictionary;
+  }
+  async compress(data) {
+    return compress(Buffer.from(data), this.getDictionary());
+  }
+  async decompress(data) {
+    const value = await uncompress(Buffer.from(data), this.getDictionary());
+    return value.toString("utf8");
+  }
+  async serialize({ value, expires }) {
+    const compressedUint8Array = await this.compress(value);
+    return defaultSerialize({ value: compressedUint8Array, expires });
+  }
+  async deserialize(data) {
+    const { value, expires } = defaultDeserialize(data);
+    const uncompressedUint8Array = await this.decompress(value);
+    return { value: uncompressedUint8Array, expires };
+  }
+  getDictionary() {
+    if (this.dictionary) {
+      return Buffer.from(this.dictionary);
+    }
+    return void 0;
+  }
+};
+var index_default = KeyvLz4;
+export {
+  KeyvLz4,
+  index_default as default
+};

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@keyv/compress-lz4",
+  "version": "1.0.0",
+  "description": "lz4 compression for Keyv",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jaredwray/keyv.git"
+  },
+  "keywords": [
+    "compress",
+    "lz4-napi",
+    "lz4",
+    "snappy",
+    "keyv",
+    "storage",
+    "adapter",
+    "key",
+    "value",
+    "store",
+    "cache",
+    "ttl"
+  ],
+  "author": "Blockcoders Engineering <hello@blockcoders.io>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/jaredwray/keyv/issues"
+  },
+  "homepage": "https://github.com/jaredwray/keyv",
+  "dependencies": {
+    "lz4-napi": "^2.8.0",
+    "@keyv/serialize": "^1.0.2",
+    "keyv": "^5.2.3"
+  },
+  "devDependencies": {
+    "@vitest/coverage-v8": "^2.1.8",
+    "c8": "^10.1.3",
+    "rimraf": "^6.0.1",
+    "vitest": "^2.1.8",
+    "xo": "^0.60.0",
+    "@keyv/test-suite": "^2.0.3"
+  },
+  "tsd": {
+    "directory": "test"
+  },
+  "engines": {
+    "node": ">= 18"
+  },
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "rimraf ./dist && tsup src/index.ts --format cjs,esm --dts --clean",
+    "test": "xo --fix && vitest run --coverage",
+    "test:ci": "xo && vitest --run --sequence.setupFiles=list",
+    "clean": "rimraf ./node_modules ./coverage ./test/testdb.sqlite ./dist"
+  }
+}