@andrew_l/tl-pack 0.2.14 → 0.2.16

package/README.md

@@ -15,8 +15,10 @@ Binary serialization library, inspired by the TL (Type Language) format, created
 
 - **No Schema Required**: Unlike traditional serialization formats, this version does not require a predefined schema for object serialization.
 - **Compact & Fast**: Designed to be lightweight and fast, with smaller binary output.
+- **Type-Safe Structures**: Define strongly typed binary structures with validation and versioning.
 - **Custom Extension Support**: Easily extend serialization to custom types.
 - **Stream Support**: Supports streaming serialization/deserialization in Node.js.
+- **Version Compatibility**: Built-in version checking for structure evolution.
 
 ## 🚀 Example Usage
 
@@ -64,6 +66,147 @@ console.log(reader.readObject());
  */
 ```
 
+### Type-Safe Structures with `defineStructure`
+
+Define reusable, type-safe binary structures with validation and versioning:
+
+```ts
+import { defineStructure, type Structure } from '@andrew_l/tl-pack';
+
+// Define a User structure
+const User = defineStructure({
+  name: 'User',
+  version: 1,
+  checksum: true,
+  properties: {
+    id: { type: Number, required: true },
+    name: { type: String, required: true },
+    email: { type: String, required: false },
+    isActive: { type: Boolean, required: true },
+    createdAt: { type: Date, required: true },
+    tags: { type: Array as Structure.PropType<string[]>, required: false },
+    metadata: { type: Object, required: false },
+  },
+});
+
+// Create and serialize a user
+const user = new User({
+  id: 123,
+  name: 'John Doe',
+  email: 'john@example.com',
+  isActive: true,
+  createdAt: new Date(),
+  tags: ['admin', 'verified'],
+  metadata: {
+    theme: 'dark',
+    lang: 'en',
+  },
+});
+
+// Serialize to binary
+const buffer = user.toBuffer();
+console.log(`Serialized size: ${buffer.length} bytes`);
+
+// Deserialize from binary
+const restored = User.fromBuffer(buffer);
+console.log(restored);
+/**
+{
+  id: 123,
+  name: 'John Doe',
+  email: 'john@example.com',
+  isActive: true,
+  createdAt: 2023-07-03T12:22:26.000Z,
+  tags: ['admin', 'verified'],
+  metadata: { theme: 'dark', lang: 'en' }
+}
+ */
+```
+
+### Nested Structures
+
+Create complex hierarchical data structures:
+
+```javascript
+// Define an Address structure
+const Address = defineStructure({
+  name: 'Address',
+  version: 1,
+  properties: {
+    street: { type: String, required: true },
+    city: { type: String, required: true },
+    zipCode: { type: String, required: true },
+    country: { type: String, required: false },
+  },
+});
+
+// Define a Person with nested Address
+const Person = defineStructure({
+  name: 'Person',
+  version: 2,
+  checksum: true,
+  properties: {
+    name: { type: String, required: true },
+    age: { type: Number, required: true },
+    address: { type: Address, required: false },
+    contacts: { type: Array, required: false }, // Array of other persons
+  },
+});
+
+const person = new Person({
+  name: 'Alice Smith',
+  age: 30,
+  address: {
+    street: '123 Main St',
+    city: 'New York',
+    zipCode: '10001',
+    country: 'USA',
+  },
+  contacts: [
+    { name: 'Bob', age: 25 },
+    { name: 'Carol', age: 35 },
+  ],
+});
+
+const buffer = person.toBuffer();
+const restored = Person.fromBuffer(buffer);
+```
+
+### API Response Caching
+
+Optimize API responses with binary serialization:
+
+```javascript
+const APIResponse = defineStructure({
+  name: 'APIResponse',
+  version: 1,
+  properties: {
+    status: { type: Number, required: true },
+    data: { type: Object, required: false },
+    headers: { type: Object, required: false },
+    timestamp: { type: Date, required: true },
+    cacheKey: { type: String, required: true },
+  },
+});
+
+// Cache API response
+const response = new APIResponse({
+  status: 200,
+  data: {
+    users: [
+      /*...*/
+    ],
+    total: 1250,
+  },
+  headers: { 'content-type': 'application/json' },
+  timestamp: new Date(),
+  cacheKey: 'users_page_1',
+});
+
+// 60% smaller than JSON in many cases
+const compressed = response.toBuffer();
+```
+
 ### Stream Example (Node.js Only)
 
 ```javascript
@@ -89,6 +232,58 @@ decode.on('data', data => console.log('stream', data));
 decode.on('error', console.error);
 ```
 
+## Structure Features
+
+### Version Management
+
+Structures support versioning for backward compatibility:
+
+```javascript
+// Version 1
+const UserV1 = defineStructure({
+  name: 'User',
+  version: 1,
+  properties: {
+    name: { type: String, required: true },
+    email: { type: String, required: true },
+  },
+});
+
+// Version 2 - Added optional fields
+const UserV2 = defineStructure({
+  name: 'User',
+  version: 2,
+  properties: {
+    name: { type: String, required: true },
+    email: { type: String, required: true },
+    createdAt: { type: Date, required: false },
+    isVerified: { type: Boolean, required: false },
+  },
+});
+
+// Reading V1 data with V2 structure will fail with version mismatch
+// This ensures data integrity across application updates
+```
+
+### Checksum Validation
+
+Enable checksum validation for data integrity:
+
+```javascript
+const SecureData = defineStructure({
+  name: 'SecureData',
+  version: 1,
+  checksum: true, // Enables automatic checksum validation
+  properties: {
+    sensitiveInfo: { type: String, required: true },
+    timestamp: { type: Date, required: true },
+  },
+});
+
+// Checksum is automatically calculated during serialization
+// and validated during deserialization
+```
+
 ## Supported Types
 
 | Constructor ID | Byte Size          |
@@ -112,6 +307,7 @@ decode.on('error', console.error);
 | String         | 5 + sizeof(object) |
 | Repeat         | 5                  |
 | GZIP           | 5 + sizeof(object) |
+| Structure      | 4 + sizeof(object) |
 
 ## Custom Types
 

package/dist/index.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-const BinaryWriter = require('./shared/tl-pack.DfL54MjP.cjs');
+const BinaryReader = require('./shared/tl-pack.CaWRi9zF.cjs');
 const toolkit = require('@andrew_l/toolkit');
 require('pako');
 
@@ -19,17 +19,19 @@ function createExtension(token, { encode, decode }) {
 }
 
 function tlEncode(value, opts) {
-  return new BinaryWriter.BinaryWriter(opts).writeObject(value).getBuffer();
+  return new BinaryReader.BinaryWriter(opts).writeObject(value).getBuffer();
 }
 function tlDecode(buffer, opts) {
-  return new BinaryWriter.BinaryReader(buffer, opts).readObject();
+  return new BinaryReader.BinaryReader(buffer, opts).readObject();
 }
 
-exports.BinaryReader = BinaryWriter.BinaryReader;
-exports.BinaryWriter = BinaryWriter.BinaryWriter;
-exports.CORE_TYPES = BinaryWriter.CORE_TYPES;
-exports.MAX_BUFFER_SIZE = BinaryWriter.MAX_BUFFER_SIZE;
-exports.createDictionary = BinaryWriter.createDictionary;
+exports.BinaryReader = BinaryReader.BinaryReader;
+exports.BinaryWriter = BinaryReader.BinaryWriter;
+exports.CORE_TYPES = BinaryReader.CORE_TYPES;
+exports.MAX_BUFFER_SIZE = BinaryReader.MAX_BUFFER_SIZE;
+exports.Structure = BinaryReader.Structure;
+exports.createDictionary = BinaryReader.createDictionary;
+exports.defineStructure = BinaryReader.defineStructure;
 exports.createExtension = createExtension;
 exports.tlDecode = tlDecode;
 exports.tlEncode = tlEncode;

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","sources":["../src/extension.ts","../src/index.ts"],"sourcesContent":["import { assert } from '@andrew_l/toolkit';\nimport type { BinaryReader } from './BinaryReader';\nimport type { BinaryWriter } from './BinaryWriter';\n\nexport type EncodeHandler = (this: BinaryWriter, value: any) => void;\n\nexport type DecodeHandler = (this: BinaryReader) => any;\n\nexport interface TLExtension {\n  token: number;\n  encode: EncodeHandler;\n  decode: DecodeHandler;\n}\n\nexport function createExtension(\n  token: number,\n  { encode, decode }: { encode: EncodeHandler; decode: DecodeHandler },\n): TLExtension {\n  assert.ok(Math.trunc(token) === token, ' Token must be integer value.');\n\n  assert.ok(\n    token === -1 || (token >= 0 && token <= 255),\n    'Token must be a 8 bit number. (0 - 255)',\n  );\n\n  assert.ok(token === -1 || token >= 35, 'Tokens from 0 to 34 reserved.');\n\n  return {\n    token,\n    encode,\n    decode,\n  };\n}\n","import { BinaryReader, type BinaryReaderOptions } from './BinaryReader';\nimport { BinaryWriter, type BinaryWriterOptions } from './BinaryWriter';\n\nexport { BinaryReader, type BinaryReaderOptions } from './BinaryReader';\nexport { BinaryWriter, type BinaryWriterOptions } from './BinaryWriter';\nexport * from './constants';\nexport { createDictionary } from './dictionary';\nexport {\n  createExtension,\n  type DecodeHandler,\n  type EncodeHandler,\n  type TLExtension,\n} from './extension';\n\n/**\n * Encode any value into `Uint8Array`\n *\n * @example\n * const buffer = tlEncode(new Date(0));\n *\n * console.log(buffer); // Uint8Array([5, 0, 0, 0, 0, 0, 0, 0, 0])\n *\n * @group Main\n */\nexport function tlEncode(\n  value: unknown,\n  opts?: BinaryWriterOptions,\n): Uint8Array {\n  return new BinaryWriter(opts).writeObject(value).getBuffer();\n}\n\n/**\n * Decode value from `Uint8Array`\n *\n * @example\n * const buffer = new Uint8Array([5, 0, 0, 0, 0, 0, 0, 0, 0]);\n * const value = tlDecode(buffer);\n *\n * console.log(value); // Thu Jan 01 1970 01:00:00 GMT+0100 (Central European Standard Time)\n *\n * @group Main\n */\nexport function tlDecode<T = any>(\n  buffer: Uint8Array,\n  opts?: BinaryReaderOptions,\n): T {\n  return new BinaryReader(buffer, opts).readObject();\n}\n"],"names":["assert","BinaryWriter","BinaryReader"],"mappings":";;;;;;AAcO,SAAS,eACd,CAAA,KAAA,EACA,EAAE,MAAA,EAAQ,QACG,EAAA;AACb,EAAAA,cAAA,CAAO,GAAG,IAAK,CAAA,KAAA,CAAM,KAAK,CAAA,KAAM,OAAO,+BAA+B,CAAA,CAAA;AAEtE,EAAOA,cAAA,CAAA,EAAA;AAAA,IACL,KAAU,KAAA,CAAA,CAAA,IAAO,KAAS,IAAA,CAAA,IAAK,KAAS,IAAA,GAAA;AAAA,IACxC,yCAAA;AAAA,GACF,CAAA;AAEA,EAAAA,cAAA,CAAO,EAAG,CAAA,KAAA,KAAU,CAAM,CAAA,IAAA,KAAA,IAAS,IAAI,+BAA+B,CAAA,CAAA;AAEtE,EAAO,OAAA;AAAA,IACL,KAAA;AAAA,IACA,MAAA;AAAA,IACA,MAAA;AAAA,GACF,CAAA;AACF;;ACRgB,SAAA,QAAA,CACd,OACA,IACY,EAAA;AACZ,EAAA,OAAO,IAAIC,yBAAa,CAAA,IAAI,EAAE,WAAY,CAAA,KAAK,EAAE,SAAU,EAAA,CAAA;AAC7D,CAAA;AAagB,SAAA,QAAA,CACd,QACA,IACG,EAAA;AACH,EAAA,OAAO,IAAIC,yBAAA,CAAa,MAAQ,EAAA,IAAI,EAAE,UAAW,EAAA,CAAA;AACnD;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs","sources":["../src/extension.ts","../src/index.ts"],"sourcesContent":["import { assert } from '@andrew_l/toolkit';\nimport type { BinaryReader } from './BinaryReader';\nimport type { BinaryWriter } from './BinaryWriter';\n\nexport type EncodeHandler<T = any> = (this: BinaryWriter, value: T) => void;\n\nexport type DecodeHandler<T = any> = (this: BinaryReader) => T;\n\nexport interface TLExtension<T = any> {\n  token: number;\n  encode: EncodeHandler<T>;\n  decode: DecodeHandler<T>;\n}\n\nexport function createExtension(\n  token: number,\n  { encode, decode }: { encode: EncodeHandler; decode: DecodeHandler },\n): TLExtension {\n  assert.ok(Math.trunc(token) === token, ' Token must be integer value.');\n\n  assert.ok(\n    token === -1 || (token >= 0 && token <= 255),\n    'Token must be a 8 bit number. (0 - 255)',\n  );\n\n  assert.ok(token === -1 || token >= 35, 'Tokens from 0 to 34 reserved.');\n\n  return {\n    token,\n    encode,\n    decode,\n  };\n}\n","import { BinaryReader, type BinaryReaderOptions } from './BinaryReader';\nimport { BinaryWriter, type BinaryWriterOptions } from './BinaryWriter';\n\nexport { BinaryReader, type BinaryReaderOptions } from './BinaryReader';\nexport { BinaryWriter, type BinaryWriterOptions } from './BinaryWriter';\nexport * from './constants';\nexport { createDictionary } from './dictionary';\nexport {\n  createExtension,\n  type DecodeHandler,\n  type EncodeHandler,\n  type TLExtension,\n} from './extension';\n\n/**\n * Encode any value into `Uint8Array`\n *\n * @example\n * const buffer = tlEncode(new Date(0));\n *\n * console.log(buffer); // Uint8Array([5, 0, 0, 0, 0, 0, 0, 0, 0])\n *\n * @group Main\n */\nexport function tlEncode(\n  value: unknown,\n  opts?: BinaryWriterOptions,\n): Uint8Array {\n  return new BinaryWriter(opts).writeObject(value).getBuffer();\n}\n\n/**\n * Decode value from `Uint8Array`\n *\n * @example\n * const buffer = new Uint8Array([5, 0, 0, 0, 0, 0, 0, 0, 0]);\n * const value = tlDecode(buffer);\n *\n * console.log(value); // Thu Jan 01 1970 01:00:00 GMT+0100 (Central European Standard Time)\n *\n * @group Main\n */\nexport function tlDecode<T = any>(\n  buffer: Uint8Array,\n  opts?: BinaryReaderOptions,\n): T {\n  return new BinaryReader(buffer, opts).readObject();\n}\n\nexport * from './Structure.js';\n"],"names":["assert","BinaryWriter","BinaryReader"],"mappings":";;;;;;AAcO,SAAS,eACd,CAAA,KAAA,EACA,EAAE,MAAA,EAAQ,QACG,EAAA;AACb,EAAAA,cAAA,CAAO,GAAG,IAAK,CAAA,KAAA,CAAM,KAAK,CAAA,KAAM,OAAO,+BAA+B,CAAA,CAAA;AAEtE,EAAOA,cAAA,CAAA,EAAA;AAAA,IACL,KAAU,KAAA,CAAA,CAAA,IAAO,KAAS,IAAA,CAAA,IAAK,KAAS,IAAA,GAAA;AAAA,IACxC,yCAAA;AAAA,GACF,CAAA;AAEA,EAAAA,cAAA,CAAO,EAAG,CAAA,KAAA,KAAU,CAAM,CAAA,IAAA,KAAA,IAAS,IAAI,+BAA+B,CAAA,CAAA;AAEtE,EAAO,OAAA;AAAA,IACL,KAAA;AAAA,IACA,MAAA;AAAA,IACA,MAAA;AAAA,GACF,CAAA;AACF;;ACRgB,SAAA,QAAA,CACd,OACA,IACY,EAAA;AACZ,EAAA,OAAO,IAAIC,yBAAa,CAAA,IAAI,EAAE,WAAY,CAAA,KAAK,EAAE,SAAU,EAAA,CAAA;AAC7D,CAAA;AAagB,SAAA,QAAA,CACd,QACA,IACG,EAAA;AACH,EAAA,OAAO,IAAIC,yBAAA,CAAa,MAAQ,EAAA,IAAI,EAAE,UAAW,EAAA,CAAA;AACnD;;;;;;;;;;;;;"}

package/dist/index.d.cts

@@ -1,5 +1,6 @@
-import { B as BinaryWriterOptions, a as BinaryReaderOptions } from './shared/tl-pack.C2PEqnNg.cjs';
-export { b as BinaryReader, c as BinaryWriter, C as CORE_TYPES, D as DecodeHandler, E as EncodeHandler, M as MAX_BUFFER_SIZE, T as TLExtension, d as createDictionary, e as createExtension } from './shared/tl-pack.C2PEqnNg.cjs';
+import { B as BinaryWriterOptions, a as BinaryReaderOptions } from './shared/tl-pack.BEGh3J6q.cjs';
+export { b as BinaryReader, c as BinaryWriter, C as CORE_TYPES, D as DecodeHandler, f as DefineStructureOptions, E as EncodeHandler, M as MAX_BUFFER_SIZE, S as Structure, T as TLExtension, d as createDictionary, e as createExtension, g as defineStructure } from './shared/tl-pack.BEGh3J6q.cjs';
+import '@andrew_l/toolkit';
 
 /**
  * Encode any value into `Uint8Array`

package/dist/index.d.mts

@@ -1,5 +1,6 @@
-import { B as BinaryWriterOptions, a as BinaryReaderOptions } from './shared/tl-pack.C2PEqnNg.mjs';
-export { b as BinaryReader, c as BinaryWriter, C as CORE_TYPES, D as DecodeHandler, E as EncodeHandler, M as MAX_BUFFER_SIZE, T as TLExtension, d as createDictionary, e as createExtension } from './shared/tl-pack.C2PEqnNg.mjs';
+import { B as BinaryWriterOptions, a as BinaryReaderOptions } from './shared/tl-pack.BEGh3J6q.mjs';
+export { b as BinaryReader, c as BinaryWriter, C as CORE_TYPES, D as DecodeHandler, f as DefineStructureOptions, E as EncodeHandler, M as MAX_BUFFER_SIZE, S as Structure, T as TLExtension, d as createDictionary, e as createExtension, g as defineStructure } from './shared/tl-pack.BEGh3J6q.mjs';
+import '@andrew_l/toolkit';
 
 /**
  * Encode any value into `Uint8Array`

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-import { B as BinaryWriterOptions, a as BinaryReaderOptions } from './shared/tl-pack.C2PEqnNg.js';
-export { b as BinaryReader, c as BinaryWriter, C as CORE_TYPES, D as DecodeHandler, E as EncodeHandler, M as MAX_BUFFER_SIZE, T as TLExtension, d as createDictionary, e as createExtension } from './shared/tl-pack.C2PEqnNg.js';
+import { B as BinaryWriterOptions, a as BinaryReaderOptions } from './shared/tl-pack.BEGh3J6q.js';
+export { b as BinaryReader, c as BinaryWriter, C as CORE_TYPES, D as DecodeHandler, f as DefineStructureOptions, E as EncodeHandler, M as MAX_BUFFER_SIZE, S as Structure, T as TLExtension, d as createDictionary, e as createExtension, g as defineStructure } from './shared/tl-pack.BEGh3J6q.js';
+import '@andrew_l/toolkit';
 
 /**
  * Encode any value into `Uint8Array`

package/dist/index.mjs

@@ -1,5 +1,5 @@
-import { B as BinaryWriter, a as BinaryReader } from './shared/tl-pack.CkwM-fIb.mjs';
-export { C as CORE_TYPES, M as MAX_BUFFER_SIZE, c as createDictionary } from './shared/tl-pack.CkwM-fIb.mjs';
+import { B as BinaryWriter, a as BinaryReader } from './shared/tl-pack.CxheH0R_.mjs';
+export { C as CORE_TYPES, M as MAX_BUFFER_SIZE, S as Structure, c as createDictionary, d as defineStructure } from './shared/tl-pack.CxheH0R_.mjs';
 import { assert } from '@andrew_l/toolkit';
 import 'pako';
 

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":["../src/extension.ts","../src/index.ts"],"sourcesContent":["import { assert } from '@andrew_l/toolkit';\nimport type { BinaryReader } from './BinaryReader';\nimport type { BinaryWriter } from './BinaryWriter';\n\nexport type EncodeHandler = (this: BinaryWriter, value: any) => void;\n\nexport type DecodeHandler = (this: BinaryReader) => any;\n\nexport interface TLExtension {\n  token: number;\n  encode: EncodeHandler;\n  decode: DecodeHandler;\n}\n\nexport function createExtension(\n  token: number,\n  { encode, decode }: { encode: EncodeHandler; decode: DecodeHandler },\n): TLExtension {\n  assert.ok(Math.trunc(token) === token, ' Token must be integer value.');\n\n  assert.ok(\n    token === -1 || (token >= 0 && token <= 255),\n    'Token must be a 8 bit number. (0 - 255)',\n  );\n\n  assert.ok(token === -1 || token >= 35, 'Tokens from 0 to 34 reserved.');\n\n  return {\n    token,\n    encode,\n    decode,\n  };\n}\n","import { BinaryReader, type BinaryReaderOptions } from './BinaryReader';\nimport { BinaryWriter, type BinaryWriterOptions } from './BinaryWriter';\n\nexport { BinaryReader, type BinaryReaderOptions } from './BinaryReader';\nexport { BinaryWriter, type BinaryWriterOptions } from './BinaryWriter';\nexport * from './constants';\nexport { createDictionary } from './dictionary';\nexport {\n  createExtension,\n  type DecodeHandler,\n  type EncodeHandler,\n  type TLExtension,\n} from './extension';\n\n/**\n * Encode any value into `Uint8Array`\n *\n * @example\n * const buffer = tlEncode(new Date(0));\n *\n * console.log(buffer); // Uint8Array([5, 0, 0, 0, 0, 0, 0, 0, 0])\n *\n * @group Main\n */\nexport function tlEncode(\n  value: unknown,\n  opts?: BinaryWriterOptions,\n): Uint8Array {\n  return new BinaryWriter(opts).writeObject(value).getBuffer();\n}\n\n/**\n * Decode value from `Uint8Array`\n *\n * @example\n * const buffer = new Uint8Array([5, 0, 0, 0, 0, 0, 0, 0, 0]);\n * const value = tlDecode(buffer);\n *\n * console.log(value); // Thu Jan 01 1970 01:00:00 GMT+0100 (Central European Standard Time)\n *\n * @group Main\n */\nexport function tlDecode<T = any>(\n  buffer: Uint8Array,\n  opts?: BinaryReaderOptions,\n): T {\n  return new BinaryReader(buffer, opts).readObject();\n}\n"],"names":[],"mappings":";;;;;AAcO,SAAS,eACd,CAAA,KAAA,EACA,EAAE,MAAA,EAAQ,QACG,EAAA;AACb,EAAA,MAAA,CAAO,GAAG,IAAK,CAAA,KAAA,CAAM,KAAK,CAAA,KAAM,OAAO,+BAA+B,CAAA,CAAA;AAEtE,EAAO,MAAA,CAAA,EAAA;AAAA,IACL,KAAU,KAAA,CAAA,CAAA,IAAO,KAAS,IAAA,CAAA,IAAK,KAAS,IAAA,GAAA;AAAA,IACxC,yCAAA;AAAA,GACF,CAAA;AAEA,EAAA,MAAA,CAAO,EAAG,CAAA,KAAA,KAAU,CAAM,CAAA,IAAA,KAAA,IAAS,IAAI,+BAA+B,CAAA,CAAA;AAEtE,EAAO,OAAA;AAAA,IACL,KAAA;AAAA,IACA,MAAA;AAAA,IACA,MAAA;AAAA,GACF,CAAA;AACF;;ACRgB,SAAA,QAAA,CACd,OACA,IACY,EAAA;AACZ,EAAA,OAAO,IAAI,YAAa,CAAA,IAAI,EAAE,WAAY,CAAA,KAAK,EAAE,SAAU,EAAA,CAAA;AAC7D,CAAA;AAagB,SAAA,QAAA,CACd,QACA,IACG,EAAA;AACH,EAAA,OAAO,IAAI,YAAA,CAAa,MAAQ,EAAA,IAAI,EAAE,UAAW,EAAA,CAAA;AACnD;;;;"}
+{"version":3,"file":"index.mjs","sources":["../src/extension.ts","../src/index.ts"],"sourcesContent":["import { assert } from '@andrew_l/toolkit';\nimport type { BinaryReader } from './BinaryReader';\nimport type { BinaryWriter } from './BinaryWriter';\n\nexport type EncodeHandler<T = any> = (this: BinaryWriter, value: T) => void;\n\nexport type DecodeHandler<T = any> = (this: BinaryReader) => T;\n\nexport interface TLExtension<T = any> {\n  token: number;\n  encode: EncodeHandler<T>;\n  decode: DecodeHandler<T>;\n}\n\nexport function createExtension(\n  token: number,\n  { encode, decode }: { encode: EncodeHandler; decode: DecodeHandler },\n): TLExtension {\n  assert.ok(Math.trunc(token) === token, ' Token must be integer value.');\n\n  assert.ok(\n    token === -1 || (token >= 0 && token <= 255),\n    'Token must be a 8 bit number. (0 - 255)',\n  );\n\n  assert.ok(token === -1 || token >= 35, 'Tokens from 0 to 34 reserved.');\n\n  return {\n    token,\n    encode,\n    decode,\n  };\n}\n","import { BinaryReader, type BinaryReaderOptions } from './BinaryReader';\nimport { BinaryWriter, type BinaryWriterOptions } from './BinaryWriter';\n\nexport { BinaryReader, type BinaryReaderOptions } from './BinaryReader';\nexport { BinaryWriter, type BinaryWriterOptions } from './BinaryWriter';\nexport * from './constants';\nexport { createDictionary } from './dictionary';\nexport {\n  createExtension,\n  type DecodeHandler,\n  type EncodeHandler,\n  type TLExtension,\n} from './extension';\n\n/**\n * Encode any value into `Uint8Array`\n *\n * @example\n * const buffer = tlEncode(new Date(0));\n *\n * console.log(buffer); // Uint8Array([5, 0, 0, 0, 0, 0, 0, 0, 0])\n *\n * @group Main\n */\nexport function tlEncode(\n  value: unknown,\n  opts?: BinaryWriterOptions,\n): Uint8Array {\n  return new BinaryWriter(opts).writeObject(value).getBuffer();\n}\n\n/**\n * Decode value from `Uint8Array`\n *\n * @example\n * const buffer = new Uint8Array([5, 0, 0, 0, 0, 0, 0, 0, 0]);\n * const value = tlDecode(buffer);\n *\n * console.log(value); // Thu Jan 01 1970 01:00:00 GMT+0100 (Central European Standard Time)\n *\n * @group Main\n */\nexport function tlDecode<T = any>(\n  buffer: Uint8Array,\n  opts?: BinaryReaderOptions,\n): T {\n  return new BinaryReader(buffer, opts).readObject();\n}\n\nexport * from './Structure.js';\n"],"names":[],"mappings":";;;;;AAcO,SAAS,eACd,CAAA,KAAA,EACA,EAAE,MAAA,EAAQ,QACG,EAAA;AACb,EAAA,MAAA,CAAO,GAAG,IAAK,CAAA,KAAA,CAAM,KAAK,CAAA,KAAM,OAAO,+BAA+B,CAAA,CAAA;AAEtE,EAAO,MAAA,CAAA,EAAA;AAAA,IACL,KAAU,KAAA,CAAA,CAAA,IAAO,KAAS,IAAA,CAAA,IAAK,KAAS,IAAA,GAAA;AAAA,IACxC,yCAAA;AAAA,GACF,CAAA;AAEA,EAAA,MAAA,CAAO,EAAG,CAAA,KAAA,KAAU,CAAM,CAAA,IAAA,KAAA,IAAS,IAAI,+BAA+B,CAAA,CAAA;AAEtE,EAAO,OAAA;AAAA,IACL,KAAA;AAAA,IACA,MAAA;AAAA,IACA,MAAA;AAAA,GACF,CAAA;AACF;;ACRgB,SAAA,QAAA,CACd,OACA,IACY,EAAA;AACZ,EAAA,OAAO,IAAI,YAAa,CAAA,IAAI,EAAE,WAAY,CAAA,KAAK,EAAE,SAAU,EAAA,CAAA;AAC7D,CAAA;AAagB,SAAA,QAAA,CACd,QACA,IACG,EAAA;AACH,EAAA,OAAO,IAAI,YAAA,CAAa,MAAQ,EAAA,IAAI,EAAE,UAAW,EAAA,CAAA;AACnD;;;;"}