@hamradio/meshcore 1.1.1 → 1.1.3

package/README.md

@@ -2,18 +2,54 @@
 
 TypeScript library for MeshCore protocol utilities.
 
-Quick start
+## Packet parsing
 
-1. Install dev dependencies:
+Using the library to decode MeshCore packets:
 
-```bash
-npm install --save-dev typescript tsup
-```
+```ts
+import { Packet } from '@hamradio/meshcore';
 
-2. Build the library:
+const raw = new Uint8Array(Buffer.from("050AA50E2CB0336DB67BBF78928A3BB9BF7A8B677C83B6EC0716F9DD10002A06", "hex"));
+const packet = Packet.fromBytes(raw);
+console.log(packet);
 
-```bash
-npm run build
+/*
+_Packet {
+  header: 5,
+  transport: undefined,
+  pathLength: 10,
+  path: Uint8Array(10) [
+    165,  14,  44, 176,
+     51, 109, 182, 123,
+    191, 120
+  ],
+  payload: Uint8Array(20) [
+    146, 138,  59, 185, 191, 122,
+    139, 103, 124, 131, 182, 236,
+      7,  22, 249, 221,  16,   0,
+     42,   6
+  ],
+  routeType: 1,
+  payloadVersion: 0,
+  payloadType: 1,
+  pathHashCount: 10,
+  pathHashSize: 1,
+  pathHashBytes: 10,
+  pathHashes: [
+    'a5', '0e', '2c',
+    'b0', '33', '6d',
+    'b6', '7b', 'bf',
+    '78'
+  ]
+}
+*/
 ```
 
-3. Use the build output from the `dist/` folder or publish to npm.
+## Identities
+
+The package supports:
+- `Identity` for public key management.
+- `LocalIdentity` for private key management.
+- `Contact` for managing named identities.
+- `Group` for managing groups.
+- `KeyManager` for managing all of the above and handling decryption.

package/dist/index.js

@@ -626,12 +626,12 @@ var Packet = class _Packet {
     this.routeType = header & 3;
     this.payloadVersion = header >> 6 & 3;
     this.payloadType = header >> 2 & 15;
-    this.pathHashCount = (pathLength >> 6) + 1;
-    this.pathHashSize = pathLength & 63;
+    this.pathHashSize = (pathLength >> 6) + 1;
+    this.pathHashCount = pathLength & 63;
     this.pathHashBytes = this.pathHashCount * this.pathHashSize;
     this.pathHashes = [];
-    for (let i = 0; i < this.pathHashCount; i++) {
-      const hashBytes = this.path.slice(i * this.pathHashSize, (i + 1) * this.pathHashSize);
+    for (let i = 0; i < this.pathHashBytes; i += this.pathHashSize) {
+      const hashBytes = this.path.slice(i, i + this.pathHashSize);
       const hashHex = (0, import_utils2.bytesToHex)(hashBytes);
       this.pathHashes.push(hashHex);
     }

package/dist/index.mjs

@@ -590,12 +590,12 @@ var Packet = class _Packet {
     this.routeType = header & 3;
     this.payloadVersion = header >> 6 & 3;
     this.payloadType = header >> 2 & 15;
-    this.pathHashCount = (pathLength >> 6) + 1;
-    this.pathHashSize = pathLength & 63;
+    this.pathHashSize = (pathLength >> 6) + 1;
+    this.pathHashCount = pathLength & 63;
     this.pathHashBytes = this.pathHashCount * this.pathHashSize;
     this.pathHashes = [];
-    for (let i = 0; i < this.pathHashCount; i++) {
-      const hashBytes = this.path.slice(i * this.pathHashSize, (i + 1) * this.pathHashSize);
+    for (let i = 0; i < this.pathHashBytes; i += this.pathHashSize) {
+      const hashBytes = this.path.slice(i, i + this.pathHashSize);
       const hashHex = bytesToHex(hashBytes);
       this.pathHashes.push(hashHex);
     }

package/dist/packet.js

@@ -11,12 +11,12 @@ export class Packet {
         this.routeType = (header) & 0x03;
         this.payloadVersion = (header >> 6) & 0x03;
         this.payloadType = (header >> 2) & 0x0f;
-        this.pathHashCount = (pathLength >> 6) + 1;
-        this.pathHashSize = pathLength & 0x3f;
+        this.pathHashSize = (pathLength >> 6) + 1;
+        this.pathHashCount = pathLength & 0x3f;
         this.pathHashBytes = this.pathHashCount * this.pathHashSize;
         this.pathHashes = [];
-        for (let i = 0; i < this.pathHashCount; i++) {
-            const hashBytes = this.path.slice(i * this.pathHashSize, (i + 1) * this.pathHashSize);
+        for (let i = 0; i < this.pathHashBytes; i += this.pathHashSize) {
+            const hashBytes = this.path.slice(i, i + this.pathHashSize);
             const hashHex = bytesToHex(hashBytes);
             this.pathHashes.push(hashHex);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hamradio/meshcore",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "MeshCore protocol support for Typescript",
   "keywords": [
     "MeshCore",
@@ -9,7 +9,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://git.maze.io/ham/meshcore.js"
+    "url": "https://git.maze.io/ham/meshcore.js"
   },
   "license": "MIT",
   "author": "Wijnand Modderman-Lenstra",