@its-c10/dis-codec 0.1.0 → 0.2.1

package/README.md

@@ -1,11 +1,13 @@
 # dis-codec
 
-Spec-accurate **Distributed Interactive Simulation (DIS)** encode/decode library in TypeScript. Wire format follows IEEE 1278.1 (DIS application protocols). PDUs are encoded with correct header length for UDP/DIS feeds.
+TypeScript encode/decode library for **Distributed Interactive Simulation (DIS)** with wire format aligned to IEEE 1278.1 (DIS application protocols).
+
+This project focuses on a **practical subset of DIS 7 PDUs** (see list below). It is **not** an implementation of the full DIS specification.
 
 ## Install
 
 ```bash
-npm install dis-codec
+npm install @its-c10/dis-codec
 ```
 
 ## Usage
@@ -13,7 +15,7 @@ npm install dis-codec
 **Encode a PDU and get bytes for UDP:**
 
 ```ts
-import { BinaryWriter, dis7 } from "dis-codec";
+import { BinaryWriter, dis7 } from "@its-c10/dis-codec";
 
 const writer = new BinaryWriter();
 dis7.encodeCreateEntityPdu(writer, {
@@ -39,7 +41,7 @@ const bytes = new Uint8Array(writer.toArrayBuffer());
 **Decode a PDU from received bytes:**
 
 ```ts
-import { BinaryReader, dis7 } from "dis-codec";
+import { BinaryReader, dis7 } from "@its-c10/dis-codec";
 
 const reader = new BinaryReader(udpPacketBuffer);
 const pdu = dis7.decodeEntityStatePdu(reader);
@@ -65,7 +67,7 @@ if (header.pduType === dis7.PDU_TYPE_ENTITY_STATE) {
 ## DIS 7 PDUs
 
 | PDU | Encode / Decode | Notes |
-|-----|-----------------|--------|
+|-----|-----------------|-------|
 | Entity State | `encodeEntityStatePdu` / `decodeEntityStatePdu` | Variable length |
 | Create Entity | `encodeCreateEntityPdu` / `decodeCreateEntityPdu` | 28 bytes |
 | Remove Entity | `encodeRemoveEntityPdu` / `decodeRemoveEntityPdu` | 28 bytes |
@@ -74,7 +76,7 @@ if (header.pduType === dis7.PDU_TYPE_ENTITY_STATE) {
 | Electromagnetic Emission | `encodeElectromagneticEmissionPdu` / `decodeElectromagneticEmissionPdu` | Variable length |
 | Transmitter | `encodeTransmitterPdu` / `decodeTransmitterPdu` | Variable length |
 
-Constants for PDU types, protocol families, and fixed lengths are on `dis7` (e.g. `dis7.PDU_TYPE_ENTITY_STATE`, `dis7.CREATE_ENTITY_PDU_LENGTH`).
+Constants for PDU types, protocol families, and fixed lengths are available on `dis7` (for example `dis7.PDU_TYPE_ENTITY_STATE` and `dis7.CREATE_ENTITY_PDU_LENGTH`).
 
 ## Requirements
 

package/dist/dis7/transmitterPdu.d.ts

@@ -38,6 +38,8 @@ export interface ModulationType {
     detail: number;
     radioSystem: number;
 }
+/** Antenna pattern length in octets for Beam Antenna Pattern. */
+export declare const BEAM_ANTENNA_PATTERN_LENGTH = 40;
 /**
  * Beam Antenna Pattern record (320 bits). Table 31.
  */
@@ -56,8 +58,6 @@ export interface BeamAntennaPattern {
     eX: number;
     phase: number;
 }
-/** Antenna pattern length in octets for Beam Antenna Pattern. */
-export declare const BEAM_ANTENNA_PATTERN_LENGTH = 40;
 /** Variable Transmitter Parameters record (variable length). */
 export interface VariableTransmitterParameter {
     /** 32-bit enumeration. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@its-c10/dis-codec",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Spec-accurate Distributed Interactive Simulation (DIS) encode/decode library in TypeScript",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -8,7 +8,8 @@
     "build": "tsc",
     "dev": "tsc -w",
     "test": "vitest",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "clean": "rimraf dist"
   },
   "keywords": [
     "dis",
@@ -26,6 +27,7 @@
     "README.md"
   ],
   "devDependencies": {
+    "rimraf": "^6.1.3",
     "typescript": "^5.9.3",
     "vitest": "^4.1.0"
   }

package/dist/binary.d.ts

@@ -1,36 +0,0 @@
-/** Big-endian binary I/O (DIS network byte order). */
-export declare class BinaryReader {
-    private readonly view;
-    private offset;
-    constructor(buffer: ArrayBuffer);
-    getOffset(): number;
-    setOffset(pos: number): void;
-    skip(bytes: number): void;
-    private ensureReadable;
-    readUint8(): number;
-    readUint16(): number;
-    readUint32(): number;
-    readInt8(): number;
-    readInt16(): number;
-    readInt32(): number;
-    readFloat32(): number;
-    readFloat64(): number;
-}
-export declare class BinaryWriter {
-    private buf;
-    private view;
-    private offset;
-    constructor(initialCapacity?: number);
-    getOffset(): number;
-    /** Returns a copy of written bytes as ArrayBuffer. */
-    toArrayBuffer(): ArrayBuffer;
-    private ensureWritable;
-    writeUint8(value: number): void;
-    writeUint16(value: number): void;
-    writeUint32(value: number): void;
-    writeInt8(value: number): void;
-    writeInt16(value: number): void;
-    writeInt32(value: number): void;
-    writeFloat32(value: number): void;
-    writeFloat64(value: number): void;
-}

package/dist/binary.js

@@ -1,144 +0,0 @@
-/** Big-endian binary I/O (DIS network byte order). */
-export class BinaryReader {
-    constructor(buffer) {
-        this.offset = 0;
-        this.view = new DataView(buffer);
-    }
-    getOffset() {
-        return this.offset;
-    }
-    setOffset(pos) {
-        if (pos < 0 || pos > this.view.byteLength) {
-            throw new RangeError(`BinaryReader.setOffset: offset ${pos} out of range [0, ${this.view.byteLength}]`);
-        }
-        this.offset = pos;
-    }
-    skip(bytes) {
-        if (bytes < 0) {
-            throw new RangeError(`BinaryReader.skip: negative bytes (${bytes})`);
-        }
-        this.ensureReadable(bytes);
-        this.offset += bytes;
-    }
-    ensureReadable(byteCount) {
-        if (this.offset + byteCount > this.view.byteLength) {
-            throw new RangeError(`BinaryReader: read past end (need ${byteCount} bytes at offset ${this.offset}, length ${this.view.byteLength})`);
-        }
-    }
-    readUint8() {
-        this.ensureReadable(1);
-        const v = this.view.getUint8(this.offset);
-        this.offset += 1;
-        return v;
-    }
-    readUint16() {
-        this.ensureReadable(2);
-        const v = this.view.getUint16(this.offset, false);
-        this.offset += 2;
-        return v;
-    }
-    readUint32() {
-        this.ensureReadable(4);
-        const v = this.view.getUint32(this.offset, false);
-        this.offset += 4;
-        return v;
-    }
-    readInt8() {
-        this.ensureReadable(1);
-        const v = this.view.getInt8(this.offset);
-        this.offset += 1;
-        return v;
-    }
-    readInt16() {
-        this.ensureReadable(2);
-        const v = this.view.getInt16(this.offset, false);
-        this.offset += 2;
-        return v;
-    }
-    readInt32() {
-        this.ensureReadable(4);
-        const v = this.view.getInt32(this.offset, false);
-        this.offset += 4;
-        return v;
-    }
-    readFloat32() {
-        this.ensureReadable(4);
-        const v = this.view.getFloat32(this.offset, false);
-        this.offset += 4;
-        return v;
-    }
-    readFloat64() {
-        this.ensureReadable(8);
-        const v = this.view.getFloat64(this.offset, false);
-        this.offset += 8;
-        return v;
-    }
-}
-export class BinaryWriter {
-    constructor(initialCapacity = 64) {
-        this.offset = 0;
-        this.buf = new Uint8Array(initialCapacity);
-        this.view = new DataView(this.buf.buffer, 0, this.buf.byteLength);
-    }
-    getOffset() {
-        return this.offset;
-    }
-    /** Returns a copy of written bytes as ArrayBuffer. */
-    toArrayBuffer() {
-        const out = new ArrayBuffer(this.offset);
-        new Uint8Array(out).set(this.buf.subarray(0, this.offset));
-        return out;
-    }
-    ensureWritable(byteCount) {
-        const need = this.offset + byteCount;
-        if (need <= this.buf.byteLength)
-            return;
-        let cap = this.buf.byteLength;
-        while (cap < need)
-            cap = Math.max(cap * 2, need);
-        const next = new Uint8Array(cap);
-        next.set(this.buf.subarray(0, this.offset));
-        this.buf = next;
-        this.view = new DataView(this.buf.buffer, 0, this.buf.byteLength);
-    }
-    writeUint8(value) {
-        this.ensureWritable(1);
-        this.view.setUint8(this.offset, value);
-        this.offset += 1;
-    }
-    writeUint16(value) {
-        this.ensureWritable(2);
-        this.view.setUint16(this.offset, value, false);
-        this.offset += 2;
-    }
-    writeUint32(value) {
-        this.ensureWritable(4);
-        this.view.setUint32(this.offset, value, false);
-        this.offset += 4;
-    }
-    writeInt8(value) {
-        this.ensureWritable(1);
-        this.view.setInt8(this.offset, value);
-        this.offset += 1;
-    }
-    writeInt16(value) {
-        this.ensureWritable(2);
-        this.view.setInt16(this.offset, value, false);
-        this.offset += 2;
-    }
-    writeInt32(value) {
-        this.ensureWritable(4);
-        this.view.setInt32(this.offset, value, false);
-        this.offset += 4;
-    }
-    writeFloat32(value) {
-        this.ensureWritable(4);
-        this.view.setFloat32(this.offset, value, false);
-        this.offset += 4;
-    }
-    writeFloat64(value) {
-        this.ensureWritable(8);
-        this.view.setFloat64(this.offset, value, false);
-        this.offset += 8;
-    }
-}

package/dist/codecs/common/decodeEntityId.d.ts

@@ -1,3 +0,0 @@
-import type { BinaryReader } from "../../binary/BinaryReader.js";
-import type { EntityId } from "../../types/EntityId.js";
-export declare function decodeEntityId(reader: BinaryReader): EntityId;

package/dist/codecs/common/decodeEntityId.js

@@ -1,7 +0,0 @@
-export function decodeEntityId(reader) {
-    return {
-        site: reader.readUint16(),
-        application: reader.readUint16(),
-        entity: reader.readUint16(),
-    };
-}

package/dist/codecs/common/encodeEntityId.d.ts

@@ -1,3 +0,0 @@
-import type { BinaryWriter } from "../../binary/BinaryWriter.js";
-import type { EntityId } from "../../types/EntityId.js";
-export declare function encodeEntityId(writer: BinaryWriter, value: EntityId): void;

package/dist/codecs/common/encodeEntityId.js

@@ -1,5 +0,0 @@
-export function encodeEntityId(writer, value) {
-    writer.writeUint16(value.site);
-    writer.writeUint16(value.application);
-    writer.writeUint16(value.entity);
-}

package/dist/codecs/entityId.d.ts

@@ -1,10 +0,0 @@
-import type { BinaryReader } from "../binary.js";
-import type { BinaryWriter } from "../binary.js";
-/** DIS Entity ID: site, application, entity — each uint16, 6 bytes on wire. */
-export interface EntityId {
-    site: number;
-    application: number;
-    entity: number;
-}
-export declare function decodeEntityId(reader: BinaryReader): EntityId;
-export declare function encodeEntityId(writer: BinaryWriter, value: EntityId): void;

package/dist/codecs/entityId.js

@@ -1,12 +0,0 @@
-export function decodeEntityId(reader) {
-    return {
-        site: reader.readUint16(),
-        application: reader.readUint16(),
-        entity: reader.readUint16(),
-    };
-}
-export function encodeEntityId(writer, value) {
-    writer.writeUint16(value.site);
-    writer.writeUint16(value.application);
-    writer.writeUint16(value.entity);
-}

package/dist/types/EntityId.d.ts

@@ -1,6 +0,0 @@
-/** DIS Entity ID: three unsigned 16-bit fields in order site, application, entity. */
-export interface EntityId {
-    site: number;
-    application: number;
-    entity: number;
-}

package/dist/types/EntityId.js

@@ -1 +0,0 @@
-export {};