@netkitty/codec 1.0.0

package/dist/lib/ProcessPacketPostHandlers.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProcessPacketEncodePostHandlers = ProcessPacketEncodePostHandlers;
+exports.ProcessPacketDecodePostHandlers = ProcessPacketDecodePostHandlers;
+const SortPostHandlers_1 = require("./SortPostHandlers");
+/**
+ * Process packet post handlers
+ * @param handlerItemsArray
+ * @param asc
+ */
+function processPacketPostHandlers(handlerItemsArray, asc) {
+    let indexFactor = 10;
+    return handlerItemsArray
+        .map((handlerItems) => {
+        return (0, SortPostHandlers_1.SortPostHandlers)(handlerItems).map((handlerItem, index) => {
+            handlerItem.priority = index + 1;
+            let factor = 10;
+            let priority = handlerItem.priority;
+            while (priority > 1) {
+                priority /= 10;
+                factor *= 10;
+            }
+            indexFactor = indexFactor < factor ? factor : indexFactor;
+            return handlerItem;
+        });
+    })
+        .map((handlerItems, headerIndex) => {
+        const basePriority = (headerIndex + 1) * indexFactor;
+        const unsortedItems = handlerItems.map((handlerItem) => {
+            handlerItem.priority = basePriority + handlerItem.priority;
+            return handlerItem;
+        });
+        return asc ?
+            unsortedItems.sort((a, b) => a.priority - b.priority) :
+            unsortedItems.sort((a, b) => b.priority - a.priority);
+    });
+}
+/**
+ * Process packet post encode handlers
+ * @param handlerItemsArray
+ * @constructor
+ */
+function ProcessPacketEncodePostHandlers(handlerItemsArray) {
+    return processPacketPostHandlers(handlerItemsArray, true).reverse().flat();
+}
+/**
+ * Process packet post decode handlers
+ * @param handlerItemsArray
+ * @constructor
+ */
+function ProcessPacketDecodePostHandlers(handlerItemsArray) {
+    return processPacketPostHandlers(handlerItemsArray, true).flat();
+}

package/dist/lib/SortPostHandlers.d.ts

@@ -0,0 +1,7 @@
+import { PostHandlerItem } from '../types/PostHandlerItem';
+/**
+ * Sort post handlers
+ * @param handlers
+ * @constructor
+ */
+export declare function SortPostHandlers(handlers: PostHandlerItem[]): PostHandlerItem[];

package/dist/lib/SortPostHandlers.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortPostHandlers = SortPostHandlers;
+/**
+ * Sort post handlers
+ * @param handlers
+ * @constructor
+ */
+function SortPostHandlers(handlers) {
+    return handlers.sort((a, b) => a.priority - b.priority);
+}

package/dist/lib/StringContentEncodingEnum.d.ts

@@ -0,0 +1,10 @@
+export declare enum StringContentEncodingEnum {
+    BINARY = "binary",
+    HEX = "hex",
+    IPv4 = "ipv4",
+    IPv6 = "ipv6",
+    MAC = "mac",
+    ASCII = "ascii",
+    UTF8 = "utf8",
+    BIGINT = "bigint"
+}

package/dist/lib/StringContentEncodingEnum.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringContentEncodingEnum = void 0;
+var StringContentEncodingEnum;
+(function (StringContentEncodingEnum) {
+    StringContentEncodingEnum["BINARY"] = "binary";
+    StringContentEncodingEnum["HEX"] = "hex";
+    StringContentEncodingEnum["IPv4"] = "ipv4";
+    StringContentEncodingEnum["IPv6"] = "ipv6";
+    StringContentEncodingEnum["MAC"] = "mac";
+    StringContentEncodingEnum["ASCII"] = "ascii";
+    StringContentEncodingEnum["UTF8"] = "utf8";
+    StringContentEncodingEnum["BIGINT"] = "bigint";
+})(StringContentEncodingEnum || (exports.StringContentEncodingEnum = StringContentEncodingEnum = {}));

package/dist/schema/ProtocolFieldJSONSchema.d.ts

@@ -0,0 +1,35 @@
+import { JSONSchema7 } from 'json-schema';
+import { ProtocolFieldJSONSchemaDefinition } from './ProtocolFieldJSONSchemaDefinition';
+export interface ProtocolFieldJSONSchema extends JSONSchema7 {
+    encode?: () => void | Promise<void>;
+    decode?: () => void | Promise<void>;
+    label?: string;
+    hidden?: boolean;
+    $defs?: {
+        [key: string]: ProtocolFieldJSONSchemaDefinition;
+    } | undefined;
+    items?: ProtocolFieldJSONSchemaDefinition | ProtocolFieldJSONSchemaDefinition[] | undefined;
+    additionalItems?: ProtocolFieldJSONSchemaDefinition | undefined;
+    contains?: ProtocolFieldJSONSchemaDefinition | undefined;
+    properties?: {
+        [key: string]: ProtocolFieldJSONSchemaDefinition;
+    } | undefined;
+    patternProperties?: {
+        [key: string]: ProtocolFieldJSONSchemaDefinition;
+    } | undefined;
+    additionalProperties?: ProtocolFieldJSONSchemaDefinition | undefined;
+    dependencies?: {
+        [key: string]: ProtocolFieldJSONSchemaDefinition | string[];
+    } | undefined;
+    propertyNames?: ProtocolFieldJSONSchemaDefinition | undefined;
+    if?: ProtocolFieldJSONSchemaDefinition | undefined;
+    then?: ProtocolFieldJSONSchemaDefinition | undefined;
+    else?: ProtocolFieldJSONSchemaDefinition | undefined;
+    allOf?: ProtocolFieldJSONSchemaDefinition[] | undefined;
+    anyOf?: ProtocolFieldJSONSchemaDefinition[] | undefined;
+    oneOf?: ProtocolFieldJSONSchemaDefinition[] | undefined;
+    not?: ProtocolFieldJSONSchemaDefinition | undefined;
+    definitions?: {
+        [key: string]: ProtocolFieldJSONSchemaDefinition;
+    } | undefined;
+}

package/dist/schema/ProtocolFieldJSONSchema.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/schema/ProtocolFieldJSONSchemaDefinition.d.ts

@@ -0,0 +1,2 @@
+import { ProtocolFieldJSONSchema } from './ProtocolFieldJSONSchema';
+export type ProtocolFieldJSONSchemaDefinition = ProtocolFieldJSONSchema;

package/dist/schema/ProtocolFieldJSONSchemaDefinition.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/schema/ProtocolJSONSchema.d.ts

@@ -0,0 +1,32 @@
+import { JSONSchema7, JSONSchema7Definition } from 'json-schema';
+import { ProtocolFieldJSONSchemaDefinition } from './ProtocolFieldJSONSchemaDefinition';
+export interface ProtocolJSONSchema extends JSONSchema7 {
+    summary?: string;
+    $defs?: {
+        [key: string]: JSONSchema7Definition;
+    } | undefined;
+    items?: ProtocolFieldJSONSchemaDefinition | ProtocolFieldJSONSchemaDefinition[] | undefined;
+    additionalItems?: JSONSchema7Definition | undefined;
+    contains?: ProtocolFieldJSONSchemaDefinition | undefined;
+    properties?: {
+        [key: string]: ProtocolFieldJSONSchemaDefinition;
+    } | undefined;
+    patternProperties?: {
+        [key: string]: ProtocolFieldJSONSchemaDefinition;
+    } | undefined;
+    additionalProperties?: ProtocolFieldJSONSchemaDefinition | undefined;
+    dependencies?: {
+        [key: string]: ProtocolFieldJSONSchemaDefinition | string[];
+    } | undefined;
+    propertyNames?: ProtocolFieldJSONSchemaDefinition | undefined;
+    if?: ProtocolFieldJSONSchemaDefinition | undefined;
+    then?: ProtocolFieldJSONSchemaDefinition | undefined;
+    else?: ProtocolFieldJSONSchemaDefinition | undefined;
+    allOf?: ProtocolFieldJSONSchemaDefinition[] | undefined;
+    anyOf?: ProtocolFieldJSONSchemaDefinition[] | undefined;
+    oneOf?: ProtocolFieldJSONSchemaDefinition[] | undefined;
+    not?: ProtocolFieldJSONSchemaDefinition | undefined;
+    definitions?: {
+        [key: string]: ProtocolFieldJSONSchemaDefinition;
+    } | undefined;
+}

package/dist/schema/ProtocolJSONSchema.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/CodecData.d.ts

@@ -0,0 +1,7 @@
+import { PostHandlerItem } from './PostHandlerItem';
+export type CodecData = {
+    packet: Buffer;
+    packetLength?: number;
+    startPos: number;
+    postHandlers: PostHandlerItem[][];
+};

package/dist/types/CodecData.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/CodecDecodeResult.d.ts

@@ -0,0 +1,10 @@
+import { HeaderTreeNode } from './HeaderTreeNode';
+import { CodecErrorInfo } from './CodecErrorInfo';
+export type CodecDecodeResult = {
+    id: string;
+    name: string;
+    nickname: string;
+    protocol: boolean;
+    errors: CodecErrorInfo[];
+    data: HeaderTreeNode;
+};

package/dist/types/CodecDecodeResult.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/CodecEncodeInput.d.ts

@@ -0,0 +1,2 @@
+import { CodecDecodeResult } from './CodecDecodeResult';
+export type CodecEncodeInput = Pick<CodecDecodeResult, 'id' | 'data'> & Partial<Omit<CodecDecodeResult, 'id' | 'data'>>;

package/dist/types/CodecEncodeInput.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/CodecEncodeResult.d.ts

@@ -0,0 +1,5 @@
+import { CodecErrorInfo } from './CodecErrorInfo';
+export type CodecEncodeResult = {
+    packet: Buffer;
+    errors: CodecErrorInfo[];
+};

package/dist/types/CodecEncodeResult.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/CodecErrorInfo.d.ts

@@ -0,0 +1,5 @@
+export type CodecErrorInfo = {
+    id: string;
+    path: string;
+    message: string;
+};

package/dist/types/CodecErrorInfo.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/CodecModule.d.ts

@@ -0,0 +1,2 @@
+import { BaseHeader } from '../abstracts/BaseHeader';
+export type CodecModule<T extends BaseHeader = BaseHeader> = T;

package/dist/types/CodecModule.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/CodecModuleConstructor.d.ts

@@ -0,0 +1,2 @@
+import { BaseHeader } from '../abstracts/BaseHeader';
+export type CodecModuleConstructor<T extends typeof BaseHeader = typeof BaseHeader> = T;

package/dist/types/CodecModuleConstructor.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/CodecSchema.d.ts

@@ -0,0 +1,6 @@
+import { ProtocolJSONSchema } from '../schema/ProtocolJSONSchema';
+export type CodecSchema = {
+    readonly id: string;
+    readonly name: string;
+    readonly schema: ProtocolJSONSchema;
+};

package/dist/types/CodecSchema.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/DemuxProducer.d.ts

@@ -0,0 +1,23 @@
+/**
+ * The kind of a demux value, deciding how it is normalized into a dispatch key. Normalization is
+ * defined by the field's STORAGE representation, not by an output radix:
+ * - `uint`   : the field stores a number (e.g. IPv4 `protocol`, IPv6 `nxt`, TCP/UDP ports) → decimal.
+ * - `string` : the field already stores a normalized string (e.g. Ethernet `etherType`, a lower-case
+ *              fixed-width hex string) → identity. Case-sensitive string keys (media_type, ALPN) are
+ *              preserved verbatim per their standard.
+ * - `guid`   : a UUID string → lower-cased.
+ * - `bytes`  : a byte/hex string → lower-cased.
+ */
+export type DemuxProducerKind = 'uint' | 'string' | 'guid' | 'bytes';
+/**
+ * A demux key a layer produces for its child: the value of `field` on this layer, placed into the
+ * `namespace` (e.g. `ethertype`, `ipproto`, `tcpport`). The codec reverses these declarations to route
+ * the next layer, so ordering is decided entirely at runtime by the field values a packet carries.
+ * Declared per-schema (replacing the old central hard-coded producer list), so adding a new demux
+ * dimension is a per-protocol declaration, not a core change.
+ */
+export type DemuxProducer = {
+    field: string;
+    namespace: string;
+    kind: DemuxProducerKind;
+};

package/dist/types/DemuxProducer.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/Dissection.d.ts

@@ -0,0 +1,23 @@
+import { CodecErrorInfo } from './CodecErrorInfo';
+/**
+ * A node in the Wireshark-style dissection tree: a field (or a container of fields) with the value,
+ * its human label, the exact bytes it occupies in the packet, and a severity for expert-info
+ * highlighting. This is a read-only projection over the same decode — no second parser.
+ */
+export type DissectionField = {
+    name: string;
+    label?: string;
+    value?: unknown;
+    offset?: number;
+    length?: number;
+    rawBytes?: string;
+    severity: 'ok' | 'error';
+    children?: DissectionField[];
+};
+/** One decoded layer's dissection: its id/name, the field tree, and any accumulated errors. */
+export type DissectionLayer = {
+    id: string;
+    name: string;
+    fields: DissectionField[];
+    errors: CodecErrorInfo[];
+};

package/dist/types/Dissection.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/HeaderTreeNode.d.ts

@@ -0,0 +1,4 @@
+export type HeaderTreeNodeField = string | number | boolean | HeaderTreeNode;
+export type HeaderTreeNode = {
+    [field: string]: HeaderTreeNodeField | HeaderTreeNodeField[];
+};

package/dist/types/HeaderTreeNode.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/LayerGraph.d.ts

@@ -0,0 +1,32 @@
+/**
+ * A layer that may follow a given parent layer in the editor's "add next layer" menu. `discriminator`
+ * tells the caller which parent field to set (and to what) so decode would route to this layer;
+ * it is null for RawData, which may always follow any layer.
+ */
+export type NextLayer = {
+    id: string;
+    name: string;
+    discriminator: {
+        field: string;
+        value: string | number;
+    } | null;
+};
+/**
+ * A parent layer whose discriminator field does not point at the child that actually follows it
+ * (e.g. eth.etherType=0x86dd "IPv6" but the next layer is IPv4). Surfaced by the editor as a warning;
+ * `suggestion` is the {field,value} that would align the parent with the actual child, or null when
+ * the child is not reachable from that parent at all. Never blocks encoding — a lying packet is a
+ * valid crafted packet.
+ */
+export type ConsistencyIssue = {
+    index: number;
+    parentId: string;
+    childId: string;
+    field: string;
+    actual: string | number;
+    suggestion: {
+        field: string;
+        value: string | number;
+    } | null;
+    message: string;
+};

package/dist/types/LayerGraph.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/PostHandlerItem.d.ts

@@ -0,0 +1,4 @@
+export type PostHandlerItem = {
+    priority: number;
+    handler: () => void | Promise<void>;
+};

package/dist/types/PostHandlerItem.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,141 @@
+{
+  "name": "@netkitty/codec",
+  "version": "1.0.0",
+  "description": "Schema-driven packet codec: encode/decode 180+ network and industrial (OT/ICS/SCADA) protocol headers — TCP/IP, TLS, HTTP/2, DNS, MQTT, plus Modbus, DNP3, IEC 61850 (GOOSE/SV/MMS), IEC 104, S7comm, OPC UA, PROFINET, EtherCAT, BACnet and more.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "README.zh-CN.md",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "clean": "shx rm -rf ./dist ./dist-test",
+    "build": "npm run clean && tsc -p tsconfig.json",
+    "build:test": "tsc -p tsconfig.test.json",
+    "test": "npm run build:test && node --test \"dist-test/**/*.spec.js\"",
+    "test:only": "node --test \"dist-test/**/*.spec.js\""
+  },
+  "keywords": [
+    "netkitty",
+    "codec",
+    "packet",
+    "packet-decoder",
+    "packet-encoder",
+    "packet-parser",
+    "protocol-decoder",
+    "protocol-parser",
+    "protocol-dissector",
+    "dissector",
+    "encode",
+    "decode",
+    "network-protocol",
+    "deep-packet-inspection",
+    "dpi",
+    "wireshark",
+    "pcap",
+    "tlv",
+    "ber",
+    "asn1",
+    "industrial-protocol",
+    "ot",
+    "scada",
+    "ics",
+    "iiot",
+    "iec61850",
+    "iec-61850",
+    "goose",
+    "sampled-values",
+    "sv",
+    "mms",
+    "iec104",
+    "iec-104",
+    "modbus",
+    "modbus-tcp",
+    "dnp3",
+    "s7comm",
+    "opcua",
+    "opc-ua",
+    "profinet",
+    "ethercat",
+    "ethernet-ip",
+    "enip",
+    "cip",
+    "bacnet",
+    "powerlink",
+    "omron-fins",
+    "slmp",
+    "melsec",
+    "codesys",
+    "beckhoff-ads",
+    "c37118",
+    "ethernet",
+    "arp",
+    "ipv4",
+    "ipv6",
+    "icmp",
+    "tcp",
+    "udp",
+    "sctp",
+    "quic",
+    "tls",
+    "dtls",
+    "dns",
+    "dhcp",
+    "http",
+    "http2",
+    "mqtt",
+    "coap",
+    "amqp",
+    "kafka",
+    "snmp",
+    "ntp",
+    "sip",
+    "rtp",
+    "bgp",
+    "ospf",
+    "ssh",
+    "ldap",
+    "kerberos",
+    "wireguard",
+    "gtp",
+    "smb",
+    "slp",
+    "srvloc",
+    "service-location"
+  ],
+  "author": "alex.ma",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "ajv": "^8.20.0",
+    "ip-address": "^10.0.1",
+    "json-schema": "^0.4.0",
+    "node-tlv": "^1.5.14"
+  },
+  "devDependencies": {
+    "@types/json-schema": "^7.0.15",
+    "@types/node": "^22.13.10",
+    "@types/node-tlv": "^1.5.4",
+    "shx": "^0.3.4",
+    "typescript": "^5.8.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/myq1991/netkitty.git",
+    "directory": "packages/codec"
+  },
+  "homepage": "https://github.com/myq1991/netkitty/tree/main/packages/codec#readme",
+  "bugs": "https://github.com/myq1991/netkitty/issues",
+  "gitHead": "d71e793d2017c0f207f7b829adfcce11b56fe7ee"
+}