@keyv/serialize 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,15 @@
+# @keyv/serialize [<img width="100" align="right" src="https://jaredwray.com/images/keyv-symbol.svg" alt="keyv">](https://github.com/jaredwra/keyv)
+
+> Serialization functionality for [Keyv](https://github.com/jaredwray/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)
+[![GitHub license](https://img.shields.io/github/license/jaredwray/keyv)](https://github.com/jaredwray/keyv/blob/main/LICENSE)
+[![npm](https://img.shields.io/npm/dm/@keyv/serialize)](https://npmjs.com/package/@keyv/serialize)
+
+This is the serialization functionality for [Keyv](https://github.com/jaredwray/keyv/tree/main/packages/keyv). It is used to serialize and deserialize data for storage and retrieval. You can also create your own [custom serialization functions](https://github.com/jaredwray/keyv/tree/main/packages/keyv#custom-serializers).
+
+## License
+
+[MIT © Jared Wray](LISCENCE)

package/dist/cjs/index.d.ts

@@ -0,0 +1,2 @@
+export declare const defaultSerialize: (data: any) => string;
+export declare const defaultDeserialize: <Value>(data: any) => Value;

package/dist/cjs/index.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultDeserialize = exports.defaultSerialize = void 0;
+const buffer_1 = require("buffer");
+// Improved version of the deprecated `json-buffer` (https://github.com/dominictarr/json-buffer) package.
+// These default functionalities can be improved separately from the dependant packages.
+const defaultSerialize = (data) => {
+    if (data === undefined || data === null) {
+        return 'null';
+    }
+    if (typeof data === 'string') {
+        return JSON.stringify(data.startsWith(':') ? ':' + data : data);
+    }
+    if (buffer_1.Buffer.isBuffer(data)) {
+        return JSON.stringify(':base64:' + data.toString('base64'));
+    }
+    if (data?.toJSON) {
+        data = data.toJSON();
+    }
+    if (typeof data === 'object') {
+        let s = '';
+        const array = Array.isArray(data);
+        s = array ? '[' : '{';
+        let first = true;
+        // eslint-disable-next-line guard-for-in
+        for (const k in data) {
+            const ignore = typeof data[k] === 'function' || (!array && data[k] === undefined);
+            // eslint-disable-next-line no-prototype-builtins
+            if (!data.hasOwnProperty(k) || ignore) {
+                continue;
+            }
+            if (!first) {
+                s += ',';
+            }
+            first = false;
+            if (array) {
+                s += (0, exports.defaultSerialize)(data[k]);
+            }
+            else if (data[k] !== undefined) {
+                s += (0, exports.defaultSerialize)(k) + ':' + (0, exports.defaultSerialize)(data[k]);
+            }
+        }
+        s += array ? ']' : '}';
+        return s;
+    }
+    return JSON.stringify(data);
+};
+exports.defaultSerialize = defaultSerialize;
+const defaultDeserialize = (data) => JSON.parse(data, (_, value) => {
+    if (typeof value === 'string') {
+        if (value.startsWith(':base64:')) {
+            return buffer_1.Buffer.from(value.slice(8), 'base64');
+        }
+        return value.startsWith(':') ? value.slice(1) : value;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+    return value;
+});
+exports.defaultDeserialize = defaultDeserialize;
+//# 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,mCAA8B;AAE9B,yGAAyG;AACzG,wFAAwF;AACjF,MAAM,gBAAgB,GAAG,CAAC,IAAS,EAAU,EAAE;IACrD,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QACzC,OAAO,MAAM,CAAC;IACf,CAAC;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACjE,CAAC;IAED,IAAI,eAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,IAAI,EAAE,MAAM,EAAE,CAAC;QAClB,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;IACtB,CAAC;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC9B,IAAI,CAAC,GAAG,EAAE,CAAC;QACX,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAClC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QACtB,IAAI,KAAK,GAAG,IAAI,CAAC;QAEjB,wCAAwC;QACxC,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACtB,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,IAAI,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;YAClF,iDAAiD;YACjD,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC;gBACvC,SAAS;YACV,CAAC;YAED,IAAI,CAAC,KAAK,EAAE,CAAC;gBACZ,CAAC,IAAI,GAAG,CAAC;YACV,CAAC;YAED,KAAK,GAAG,KAAK,CAAC;YACd,IAAI,KAAK,EAAE,CAAC;gBACX,CAAC,IAAI,IAAA,wBAAgB,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAChC,CAAC;iBAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;gBAClC,CAAC,IAAI,IAAA,wBAAgB,EAAC,CAAC,CAAC,GAAG,GAAG,GAAG,IAAA,wBAAgB,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5D,CAAC;QACF,CAAC;QAED,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QACvB,OAAO,CAAC,CAAC;IACV,CAAC;IAED,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AAC7B,CAAC,CAAC;AAhDW,QAAA,gBAAgB,oBAgD3B;AAEK,MAAM,kBAAkB,GAAG,CAAQ,IAAS,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAyB,EAAE,CAC7F,CAAC,EAAE,KAAK,EAAE,EAAE;IACZ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC/B,IAAI,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAClC,OAAO,eAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC9C,CAAC;QAED,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACvD,CAAC;IAED,+DAA+D;IAC/D,OAAO,KAAK,CAAC;AACd,CAAC,CAAU,CAAC;AAZC,QAAA,kBAAkB,sBAYnB"}

package/dist/esm/index.d.ts

@@ -0,0 +1,2 @@
+export declare const defaultSerialize: (data: any) => string;
+export declare const defaultDeserialize: <Value>(data: any) => Value;

package/dist/esm/index.js

@@ -0,0 +1,55 @@
+import { Buffer } from 'buffer';
+// Improved version of the deprecated `json-buffer` (https://github.com/dominictarr/json-buffer) package.
+// These default functionalities can be improved separately from the dependant packages.
+export const defaultSerialize = (data) => {
+    if (data === undefined || data === null) {
+        return 'null';
+    }
+    if (typeof data === 'string') {
+        return JSON.stringify(data.startsWith(':') ? ':' + data : data);
+    }
+    if (Buffer.isBuffer(data)) {
+        return JSON.stringify(':base64:' + data.toString('base64'));
+    }
+    if (data?.toJSON) {
+        data = data.toJSON();
+    }
+    if (typeof data === 'object') {
+        let s = '';
+        const array = Array.isArray(data);
+        s = array ? '[' : '{';
+        let first = true;
+        // eslint-disable-next-line guard-for-in
+        for (const k in data) {
+            const ignore = typeof data[k] === 'function' || (!array && data[k] === undefined);
+            // eslint-disable-next-line no-prototype-builtins
+            if (!data.hasOwnProperty(k) || ignore) {
+                continue;
+            }
+            if (!first) {
+                s += ',';
+            }
+            first = false;
+            if (array) {
+                s += defaultSerialize(data[k]);
+            }
+            else if (data[k] !== undefined) {
+                s += defaultSerialize(k) + ':' + defaultSerialize(data[k]);
+            }
+        }
+        s += array ? ']' : '}';
+        return s;
+    }
+    return JSON.stringify(data);
+};
+export const defaultDeserialize = (data) => JSON.parse(data, (_, value) => {
+    if (typeof value === 'string') {
+        if (value.startsWith(':base64:')) {
+            return Buffer.from(value.slice(8), 'base64');
+        }
+        return value.startsWith(':') ? value.slice(1) : value;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+    return value;
+});
+//# 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,EAAC,MAAM,EAAC,MAAM,QAAQ,CAAC;AAE9B,yGAAyG;AACzG,wFAAwF;AACxF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,IAAS,EAAU,EAAE;IACrD,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QACzC,OAAO,MAAM,CAAC;IACf,CAAC;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACjE,CAAC;IAED,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,IAAI,IAAI,EAAE,MAAM,EAAE,CAAC;QAClB,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;IACtB,CAAC;IAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC9B,IAAI,CAAC,GAAG,EAAE,CAAC;QACX,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAClC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QACtB,IAAI,KAAK,GAAG,IAAI,CAAC;QAEjB,wCAAwC;QACxC,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACtB,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,IAAI,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;YAClF,iDAAiD;YACjD,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC;gBACvC,SAAS;YACV,CAAC;YAED,IAAI,CAAC,KAAK,EAAE,CAAC;gBACZ,CAAC,IAAI,GAAG,CAAC;YACV,CAAC;YAED,KAAK,GAAG,KAAK,CAAC;YACd,IAAI,KAAK,EAAE,CAAC;gBACX,CAAC,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAChC,CAAC;iBAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;gBAClC,CAAC,IAAI,gBAAgB,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5D,CAAC;QACF,CAAC;QAED,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QACvB,OAAO,CAAC,CAAC;IACV,CAAC;IAED,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AAC7B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAQ,IAAS,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAyB,EAAE,CAC7F,CAAC,EAAE,KAAK,EAAE,EAAE;IACZ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC/B,IAAI,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YAClC,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC9C,CAAC;QAED,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACvD,CAAC;IAED,+DAA+D;IAC/D,OAAO,KAAK,CAAC;AACd,CAAC,CAAU,CAAC"}

package/package.json

@@ -0,0 +1,76 @@
+{
+  "name": "@keyv/serialize",
+  "version": "1.0.0",
+  "description": "Serialization for keyv",
+  "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": "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 ./coverage"
+  },
+  "xo": {
+    "rules": {
+      "unicorn/prefer-module": "off",
+      "unicorn/prefer-event-target": "off",
+      "unicorn/no-array-reduce": "off",
+      "n/prefer-global/process": "off",
+      "node/prefer-global/process": "off",
+      "unicorn/prefer-object-from-entries": "off",
+      "unicorn/prefer-node-protocol": "off",
+      "@typescript-eslint/consistent-type-imports": "off",
+      "@typescript-eslint/consistent-type-definitions": "off",
+      "@typescript-eslint/no-empty-function": "off",
+      "import/extensions": "off",
+      "no-promise-executor-return": "off",
+      "import/no-extraneous-dependencies": "off",
+      "@typescript-eslint/no-unsafe-call": "off",
+      "@typescript-eslint/no-unsafe-assignment": "off"
+
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jaredwray/keyv.git"
+  },
+  "keywords": [
+    "keyv",
+    "serialize",
+    "key",
+    "value",
+    "store"
+  ],
+  "author": "Jared Wray <me@jaredwray.com> (https://jaredwray.com)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/jaredwray/keyv/issues"
+  },
+  "homepage": "https://github.com/jaredwray/keyv",
+  "dependencies": {
+    "buffer": "^6.0.3"
+  },
+  "devDependencies": {
+    "@keyv/test-suite": "*",
+    "keyv": "^5.0.0",
+    "ts-node": "^10.9.2",
+    "tsd": "^0.31.1",
+    "typescript": "^5.5.4",
+    "xo": "^0.59.3"
+  },
+  "tsd": {
+    "directory": "test"
+  },
+  "files": [
+    "dist",
+    "LICENSE"
+  ]
+}