@andrew_l/tl-pack 0.0.5 → 0.0.6

package/README.md

@@ -0,0 +1,138 @@
+# TLPack for JavaScript/NodeJs
+
+![license](https://img.shields.io/npm/l/%40andrew_l%2Ftl-pack)![npm version](https://img.shields.io/npm/v/%40andrew_l%2Ftl-pack)![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Ftl-pack)
+
+This library is another implementation of binary serialization like **MessagePack** inspired by TL (Type Language) developed by old VK team.
+
+You don't needed in schema for data serialization/deserialization unlike official TL implementation at least in this version.
+
+## Benchmark
+
+A bit faster and a bit more compact than **@msgpack/msgpack**
+
+## Synopsis
+
+```javascript
+import { BinaryWriter, BinaryReader } from '@andrew_l/tl-pack';
+
+const writer = new BinaryWriter();
+
+// use to compress this part of data
+// writer.writeObjectGzip
+writer.writeObject({
+	null: null,
+	uint8: 255,
+	uint16: 256,
+	uint32: 65536,
+	int8: -128,
+	int16: -32768,
+	int32: -2147483648,
+	double: 3.14,
+	string: 'Hello world',
+	vector: [1, 2, 3, 4, 5, { text: 'hi' }],
+	map: { foo: 'bar' },
+	date: new Date(),
+});
+
+const reader = new BinaryReader(writer.getBuffer());
+
+console.log(reader.readObject());
+```
+
+## Supported Types
+
+| Constructor ID | Byte Size          |
+| -------------- | ------------------ |
+| Binary         | 5 + sizeof(object) |
+| BoolFalse      | 1                  |
+| BoolTrue       | 1                  |
+| Null           | 1                  |
+| Date           | 4                  |
+| Vector         | 5 + n \* sizeof(n) |
+| VectorDynamic  | 2 + n \* sizeof(n) |
+| Int8           | 1                  |
+| Int16          | 2                  |
+| Int32          | 4                  |
+| UInt8          | 1                  |
+| UInt16         | 2                  |
+| UInt32         | 4                  |
+| Float          | 4                  |
+| Double         | 8                  |
+| Map            | 2 + sizeof(object) |
+| String         | 5 + sizeof(object) |
+| GZIP           | 5 + sizeof(object) |
+
+## Stream Example (NodeJs Only)
+
+```javascript
+import { Readable } from 'node:stream';
+import { TLEncode, TLDecode } from '@andrew_l/tl-pack/stream';
+
+const values = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
+
+const dataStream = new Readable({ objectMode: true });
+
+dataStream._read = () => {
+	const chunk = values.shift();
+
+	dataStream.push(chunk || null);
+};
+
+const encode = new TLEncode();
+const decode = new TLDecode();
+
+dataStream.pipe(encode).pipe(decode);
+
+decode.on('data', (data) => console.log('stream', data));
+decode.on('error', console.error);
+```
+
+## Custom Types
+
+```javascript
+import mongoose from 'mongoose';
+import { BinaryWriter, BinaryReader, createExtension } from '@andrew_l/tl-pack';
+
+const ObjectId = mongoose.Types.ObjectId;
+
+const extensions = [
+	// Reserving token - 100 for ObjectId types
+	createExtension(100, {
+		encode(value) {
+			if (value?._bsontype === 'ObjectID') {
+				return value.toJSON(); // (string)
+			}
+		},
+		// on client side, you possibly need a decoding as a plain string.
+		decode(value) {
+			return new ObjectId(value);
+		},
+	}),
+];
+
+const writer = new BinaryWriter({ extensions });
+
+writer.writeObject({
+	_id: new Object(),
+	firstName: 'Andrew',
+	lastName: 'L.',
+});
+
+const reader = new BinaryReader(writer.getBuffer(), { extensions });
+
+console.log(reader.readObject());
+```
+
+## Dictionary
+
+A dictionary is used to replace strings with numeric indexes, which saves the resulting buffer size. In stream mode, the dictionary is grown while the stream is alive.
+
+**Static**
+Dictionary with you initialize a BinaryWriter/BinaryReader.
+
+**Dynamic**
+Dictionary which appends while encoding and decoding keys of an object (Map).
+
+## Production
+
+No way!

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@andrew_l/tl-pack",
-	"version": "0.0.5",
+	"version": "0.0.6",
 	"description": "",
 	"type": "module",
 	"scripts": {
@@ -10,10 +10,18 @@
 	"keywords": [],
 	"author": "Andrew L.",
 	"license": "ISC",
-	"types": "./dist",
 	"files": [
 		"dist/**"
 	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/men232/tl-pack.git"
+	},
+	"bugs": {
+		"url": "https://github.com/men232/tl-pack/issues"
+	},
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
 	"exports": {
 		".": {
 			"import": "./dist/index.js",