@srvquery/protocol-valve 0.0.1-next.0

package/dist/packet/opcodes.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Valve protocol query opcodes.
+ * @link https://developer.valvesoftware.com/wiki/Server_queries#Requests
+ */
+export declare const requestOpcodes: {
+    readonly INFO: 84;
+    readonly PLAYERS: 85;
+    readonly RULES: 86;
+    readonly PING: 105;
+    readonly SERVERQUERY_GETCHALLENGE: 87;
+};
+/** Symbolic opcode accepted by a Valve server query. */
+export type ValveProtocolRequestOpcode = keyof typeof requestOpcodes;
+/** Numeric wire value for a Valve request opcode. */
+export type ValveProtocolRequestOpcodeValue = (typeof requestOpcodes)[keyof typeof requestOpcodes];
+/** Header values that identify simple and fragmented Valve responses. */
+export declare const responseTypeOpcodes: {
+    readonly SIMPLE: -1;
+    readonly MULTI: -2;
+};
+/** Symbolic name for a Valve response packet format. */
+export type ValveProtocolResponseTypeOpcode = keyof typeof responseTypeOpcodes;
+/** Numeric header value for a Valve response packet format. */
+export type ValveProtocolResponseTypeOpcodeValue = (typeof responseTypeOpcodes)[keyof typeof responseTypeOpcodes];
+/** Recognized Valve response payload opcodes. */
+export declare const responseOpcodes: {
+    readonly CHALLENGE: 65;
+    readonly INFO: 73;
+    readonly PLAYERS: 68;
+    readonly RULES: 69;
+    readonly PING: 106;
+};
+/** Symbolic opcode for a recognized Valve response payload. */
+export type ValveProtocolResponseOpcode = keyof typeof responseOpcodes;
+/** Numeric wire value for a recognized Valve response payload opcode. */
+export type ValveProtocolResponseOpcodeValue = (typeof responseOpcodes)[keyof typeof responseOpcodes];
+//# sourceMappingURL=opcodes.d.ts.map

package/dist/packet/opcodes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"opcodes.d.ts","sourceRoot":"","sources":["../../src/packet/opcodes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,cAAc;aACzB,IAAI,EAAE,EAAE;aACR,OAAO,EAAE,EAAE;aACX,KAAK,EAAE,EAAE;aACT,IAAI,EAAE,GAAG;aACT,wBAAwB,EAAE,EAAE;CACpB,CAAC;AAEX,wDAAwD;AACxD,MAAM,MAAM,0BAA0B,GAAG,MAAM,OAAO,cAAc,CAAC;AACrE,qDAAqD;AACrD,MAAM,MAAM,+BAA+B,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAEnG,yEAAyE;AACzE,eAAO,MAAM,mBAAmB;aAC9B,MAAM,EAAE,CAAC,CAAC;aACV,KAAK,EAAE,CAAC,CAAC;CACD,CAAC;AAEX,wDAAwD;AACxD,MAAM,MAAM,+BAA+B,GAAG,MAAM,OAAO,mBAAmB,CAAC;AAC/E,+DAA+D;AAC/D,MAAM,MAAM,oCAAoC,GAC9C,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,OAAO,mBAAmB,CAAC,CAAC;AAEjE,iDAAiD;AACjD,eAAO,MAAM,eAAe;aAC1B,SAAS,EAAE,EAAI;aACf,IAAI,EAAE,EAAI;aACV,OAAO,EAAE,EAAI;aACb,KAAK,EAAE,EAAI;aACX,IAAI,EAAE,GAAI;CACF,CAAC;AAEX,+DAA+D;AAC/D,MAAM,MAAM,2BAA2B,GAAG,MAAM,OAAO,eAAe,CAAC;AACvE,yEAAyE;AACzE,MAAM,MAAM,gCAAgC,GAC1C,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAC"}

package/dist/packet/reassembly.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Reassembles fragmented packets into a single contiguous buffer.
+ *
+ * @param packets The fragmented packet buffers.
+ * @returns The reassembled payload buffer.
+ */
+export declare const combineFragments: (packets: Buffer[]) => Buffer;
+//# sourceMappingURL=reassembly.d.ts.map

package/dist/packet/reassembly.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reassembly.d.ts","sourceRoot":"","sources":["../../src/packet/reassembly.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,YAAa,MAAM,EAAE,KAAG,MAUpD,CAAC"}

package/dist/packet/request.d.ts

@@ -0,0 +1,16 @@
+import { ValveProtocolRequestOpcode } from "./opcodes";
+/** Values encoded into a Valve server query request packet. */
+export type BuildRequestPacketParams = {
+    /** Query opcode to encode. */
+    opcode: ValveProtocolRequestOpcode;
+    /** Challenge token supplied for protected query types. */
+    challenge?: number;
+};
+/**
+ * Builds a Valve server query request packet.
+ * @param params Opcode and optional challenge token to encode.
+ * @returns Encoded request packet.
+ * @link https://developer.valvesoftware.com/wiki/Server_queries#Requests
+ */
+export declare const buildRequestPacket: ({ opcode, challenge }: BuildRequestPacketParams) => Buffer;
+//# sourceMappingURL=request.d.ts.map

package/dist/packet/request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../src/packet/request.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,0BAA0B,EAAE,MAAM,WAAW,CAAC;AAEvE,+DAA+D;AAC/D,MAAM,MAAM,wBAAwB,GAAG;IACrC,8BAA8B;IAC9B,MAAM,EAAE,0BAA0B,CAAC;IACnC,0DAA0D;IAC1D,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,0BAA2B,wBAAwB,KAAG,MA2BpF,CAAC"}

package/dist/packet/schema.d.ts

@@ -0,0 +1,77 @@
+import z from "zod";
+/**
+ * Validates a Valve `A2S_INFO` response, including fields selected by the extra data flag.
+ */
+export declare const ValveServerInfoSchema: z.ZodObject<{
+    protocol: z.ZodNumber;
+    name: z.ZodString;
+    map: z.ZodString;
+    folder: z.ZodString;
+    game: z.ZodString;
+    appId: z.ZodNumber;
+    players: z.ZodNumber;
+    maxPlayers: z.ZodNumber;
+    bots: z.ZodNumber;
+    serverType: z.ZodUnion<readonly [z.ZodEnum<{
+        d: "d";
+        l: "l";
+        p: "p";
+    }>, z.ZodLiteral<0>]>;
+    environment: z.ZodEnum<{
+        l: "l";
+        m: "m";
+        o: "o";
+        w: "w";
+    }>;
+    visibility: z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>]>;
+    vac: z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>]>;
+    shipMode: z.ZodOptional<z.ZodNumber>;
+    shipWitnesses: z.ZodOptional<z.ZodNumber>;
+    shipDuration: z.ZodOptional<z.ZodNumber>;
+    version: z.ZodString;
+    edf: z.ZodOptional<z.ZodNumber>;
+    port: z.ZodOptional<z.ZodNumber>;
+    steamId: z.ZodOptional<z.ZodBigInt>;
+    ValveTvPort: z.ZodOptional<z.ZodNumber>;
+    ValveTvName: z.ZodOptional<z.ZodString>;
+    keywords: z.ZodOptional<z.ZodString>;
+    gameId: z.ZodOptional<z.ZodBigInt>;
+}, z.core.$strip>;
+/** Server metadata returned by a Valve `A2S_INFO` query. */
+export type ValveServerInfo = z.infer<typeof ValveServerInfoSchema>;
+/** Validates a player entry returned by a Valve `A2S_PLAYER` query. */
+export declare const ValvePlayerSchema: z.ZodObject<{
+    index: z.ZodNumber;
+    name: z.ZodString;
+    score: z.ZodNumber;
+    duration: z.ZodNumber;
+}, z.core.$strip>;
+/** Validates the player list returned by a Valve `A2S_PLAYER` query. */
+export declare const ValvePlayersSchema: z.ZodArray<z.ZodObject<{
+    index: z.ZodNumber;
+    name: z.ZodString;
+    score: z.ZodNumber;
+    duration: z.ZodNumber;
+}, z.core.$strip>>;
+/** Validates a rule whose key and value could not be decoded as strings. */
+export declare const ValveBinaryRuleSchema: z.ZodObject<{
+    key: z.ZodCustom<Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>>;
+    value: z.ZodCustom<Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>>;
+}, z.core.$strip>;
+/** Validates the payload returned by a legacy Valve ping query. */
+export declare const ValvePingSchema: z.ZodObject<{
+    payload: z.ZodString;
+}, z.core.$strip>;
+/** Validates the signed 32-bit challenge token returned by a Valve server. */
+export declare const ValveChallengeSchema: z.ZodNumber;
+/** Player entry containing its response index, name, score, and connected duration. */
+export type ValvePlayer = z.infer<typeof ValvePlayerSchema>;
+/** Player entries returned by a Valve `A2S_PLAYER` query. */
+export type ValvePlayers = z.infer<typeof ValvePlayersSchema>;
+/** Rule preserved as raw bytes when it cannot be represented as a string pair. */
+export type ValveBinaryRule = z.infer<typeof ValveBinaryRuleSchema>;
+/** Payload returned by a legacy Valve ping query. */
+export type ValvePing = z.infer<typeof ValvePingSchema>;
+/** Signed 32-bit challenge token used by protected Valve queries. */
+export type ValveChallenge = z.infer<typeof ValveChallengeSchema>;
+//# sourceMappingURL=schema.d.ts.map

package/dist/packet/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/packet/schema.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAC;AAOpB;;GAEG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAiD9B,CAAC;AAEL,4DAA4D;AAC5D,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE,uEAAuE;AACvE,eAAO,MAAM,iBAAiB;;;;;iBAK5B,CAAC;AAEH,wEAAwE;AACxE,eAAO,MAAM,kBAAkB;;;;;kBAA6B,CAAC;AAC7D,4EAA4E;AAC5E,eAAO,MAAM,qBAAqB;;;iBAGhC,CAAC;AACH,mEAAmE;AACnE,eAAO,MAAM,eAAe;;iBAE1B,CAAC;AACH,8EAA8E;AAC9E,eAAO,MAAM,oBAAoB,aAAQ,CAAC;AAE1C,uFAAuF;AACvF,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAC5D,6DAA6D;AAC7D,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC9D,kFAAkF;AAClF,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AACpE,qDAAqD;AACrD,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC;AACxD,qEAAqE;AACrE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

package/dist/packet/serde.d.ts

@@ -0,0 +1,32 @@
+import { BufferCursor } from "@srvquery/core";
+import { ValvePing, ValvePlayers, ValveServerInfo } from "./schema";
+/** Deserializes a Valve response from a cursor positioned at its payload opcode. */
+export type ValvePacketDeserializeFn = (cursor: BufferCursor) => unknown;
+/**
+ * Deserializes a Valve server info packet from the given buffer cursor.
+ *
+ * @param cursor The buffer cursor pointing to the start of the server info packet.
+ * @returns The deserialized Valve server info object.
+ */
+export declare const deserializeInfoPacket: (cursor: BufferCursor) => ValveServerInfo;
+/**
+ * Deserializes a Valve players packet from the given buffer.
+ *
+ * @param body The buffer containing the players packet.
+ * @returns The deserialized Valve players object.
+ */
+export declare const deserializePlayersPacket: (cursor: BufferCursor) => ValvePlayers;
+/**
+ * Deserializes a Valve challenge packet from the given buffer cursor.
+ *
+ * @param cursor The buffer cursor pointing to the start of the challenge packet.
+ * @returns The deserialized challenge number.
+ */
+export declare const deserializeChallengePacket: (cursor: BufferCursor) => number;
+/**
+ * Deserializes a legacy Valve ping response.
+ * @param cursor Cursor positioned at the response payload opcode.
+ * @returns Validated ping payload.
+ */
+export declare const deserializePingPacket: (cursor: BufferCursor) => ValvePing;
+//# sourceMappingURL=serde.d.ts.map

package/dist/packet/serde.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serde.d.ts","sourceRoot":"","sources":["../../src/packet/serde.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAEL,SAAS,EAET,YAAY,EAEZ,eAAe,EAEhB,MAAM,UAAU,CAAC;AAElB,oFAAoF;AACpF,MAAM,MAAM,wBAAwB,GAAG,CAAC,MAAM,EAAE,YAAY,KAAK,OAAO,CAAC;AAEzE;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,WAAY,YAAY,KAAG,eA0C5D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,WAAY,YAAY,KAAG,YAS/D,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,WAAY,YAAY,KAAG,MAEjE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,WAAY,YAAY,KAAG,SAE5D,CAAC"}

package/dist/protocol.d.ts

@@ -0,0 +1,44 @@
+import { BufferCursor, CreateUdpSocketOptions, CreateUdpSocketParams } from "@srvquery/core";
+import { ValveProtocolRequestOpcode } from "./packet/opcodes";
+import { ValveChallenge, ValvePing, ValvePlayers, ValveServerInfo } from "./packet/schema";
+import { type ValveRules } from "./rules/valve-rule-parser";
+type ValveProtocolQueryResponseMap = {
+    INFO: ValveServerInfo;
+    SERVERQUERY_GETCHALLENGE: ValveChallenge;
+    PLAYERS: ValvePlayers;
+    PING: ValvePing;
+    RULES: ValveRules;
+};
+/** Parameters for querying Valve rules with a game-specific parser. */
+export type ValveRulesQueryParams<Result = ValveRules> = {
+    /** Valve rules request opcode. */
+    opcode: "RULES";
+    /**
+     * Parses the raw Valve rules response into a game-specific model.
+     * In most cases, use the {@link valveRulesParser | default Valve rules parser}.
+     *
+     * @param cursor Cursor positioned at the first byte after the response opcode.
+     * @returns The parsed game-specific rules model.
+     */
+    parser: (cursor: BufferCursor) => Result;
+};
+/** Parameters for querying a Valve opcode and optionally customizing RULES parsing. */
+export type ValveProtocolQueryParams<Opcode extends ValveProtocolRequestOpcode, Result = ValveProtocolQueryResponseMap[Opcode]> = Opcode extends "RULES" ? ValveRulesQueryParams<Result> : {
+    /** Valve request opcode to query. */
+    opcode: Opcode;
+};
+/** Client for querying servers that implement the Valve server query protocol. */
+export interface ValveProtocol {
+    /** Queries one Valve opcode and resolves with its parsed response model. */
+    query<Opcode extends ValveProtocolRequestOpcode, Result = ValveProtocolQueryResponseMap[Opcode]>(params: ValveProtocolQueryParams<Opcode, Result>): Promise<Result>;
+}
+/** Connection and retry settings used to create a Valve protocol client. */
+export type CreateValveProtocolParams = CreateUdpSocketParams & CreateUdpSocketOptions;
+/**
+ * Creates a client for querying servers that implement the Valve server query protocol.
+ * @param params Target server and UDP transport settings.
+ * @returns A client whose `query` method returns the response type for the requested opcode.
+ */
+export declare const createValveProtocol: ({ host, port, retry, timeout, ...socketOptions }: CreateValveProtocolParams) => ValveProtocol;
+export {};
+//# sourceMappingURL=protocol.d.ts.map

package/dist/protocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAEZ,sBAAsB,EACtB,qBAAqB,EAItB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAwC,0BAA0B,EAAE,MAAM,kBAAkB,CAAC;AAGpG,OAAO,EACL,cAAc,EAEd,SAAS,EACT,YAAY,EACZ,eAAe,EAChB,MAAM,iBAAiB,CAAC;AAQzB,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAE5D,KAAK,6BAA6B,GAAG;IACnC,IAAI,EAAE,eAAe,CAAC;IACtB,wBAAwB,EAAE,cAAc,CAAC;IACzC,OAAO,EAAE,YAAY,CAAC;IACtB,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF,uEAAuE;AACvE,MAAM,MAAM,qBAAqB,CAAC,MAAM,GAAG,UAAU,IAAI;IACvD,kCAAkC;IAClC,MAAM,EAAE,OAAO,CAAC;IAChB;;;;;;OAMG;IACH,MAAM,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,MAAM,CAAC;CAC1C,CAAC;AAEF,uFAAuF;AACvF,MAAM,MAAM,wBAAwB,CAClC,MAAM,SAAS,0BAA0B,EACzC,MAAM,GAAG,6BAA6B,CAAC,MAAM,CAAC,IAC5C,MAAM,SAAS,OAAO,GACtB,qBAAqB,CAAC,MAAM,CAAC,GAC7B;IACE,qCAAqC;IACrC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEN,kFAAkF;AAClF,MAAM,WAAW,aAAa;IAC5B,4EAA4E;IAC5E,KAAK,CAAC,MAAM,SAAS,0BAA0B,EAAE,MAAM,GAAG,6BAA6B,CAAC,MAAM,CAAC,EAC7F,MAAM,EAAE,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,GAC/C,OAAO,CAAC,MAAM,CAAC,CAAC;CACpB;AAiBD,4EAA4E;AAC5E,MAAM,MAAM,yBAAyB,GAAG,qBAAqB,GAAG,sBAAsB,CAAC;AAOvF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,qDAM7B,yBAAyB,KAAG,aAsE9B,CAAC"}

package/dist/rules/errors.d.ts

@@ -0,0 +1,42 @@
+type UnsupportedServerBrowserProtocolVersionErrorCtor = {
+    version: number;
+};
+/** Error thrown when a server browser protocol message reports a version this parser doesn't handle. */
+export declare class UnsupportedServerBrowserProtocolVersionError extends Error {
+    /** Version byte reported by the message. */
+    readonly version: number;
+    constructor({ version }: UnsupportedServerBrowserProtocolVersionErrorCtor);
+}
+/** Error thrown when a server browser protocol message's pages are missing or malformed. */
+export declare class IncompleteServerBrowserProtocolMessageError extends Error {
+    constructor();
+}
+type InvalidServerBrowserProtocolEscapeSequenceErrorCtor = {
+    marker?: number;
+};
+/** Error thrown when a page payload contains an unrecognized 0x01-prefixed escape sequence. */
+export declare class InvalidServerBrowserProtocolEscapeSequenceError extends Error {
+    /** Byte following the 0x01 escape marker. */
+    readonly marker?: number;
+    constructor({ marker }: InvalidServerBrowserProtocolEscapeSequenceErrorCtor);
+}
+type UnsupportedServerBrowserProtocolModIdLengthErrorCtor = {
+    idLength: number;
+};
+/** Error thrown when a mod entry declares an ID length this parser doesn't handle. */
+export declare class UnsupportedServerBrowserProtocolModIdLengthError extends Error {
+    /** Unsupported ID length declared by the mod entry. */
+    readonly idLength: number;
+    constructor({ idLength }: UnsupportedServerBrowserProtocolModIdLengthErrorCtor);
+}
+type TrailingServerBrowserProtocolDataErrorCtor = {
+    remaining: number;
+};
+/** Error thrown when bytes remain unconsumed after decoding a server browser protocol message. */
+export declare class TrailingServerBrowserProtocolDataError extends Error {
+    /** Number of unconsumed bytes remaining in the message. */
+    readonly remaining: number;
+    constructor({ remaining }: TrailingServerBrowserProtocolDataErrorCtor);
+}
+export {};
+//# sourceMappingURL=errors.d.ts.map

package/dist/rules/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/rules/errors.ts"],"names":[],"mappings":"AAAA,KAAK,gDAAgD,GAAG;IACtD,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,wGAAwG;AACxG,qBAAa,4CAA6C,SAAQ,KAAK;IACrE,4CAA4C;IAC5C,SAAgB,OAAO,EAAE,MAAM,CAAC;IAEhC,YAAY,EAAE,OAAO,EAAE,EAAE,gDAAgD,EAIxE;CACF;AAED,4FAA4F;AAC5F,qBAAa,2CAA4C,SAAQ,KAAK;IACpE,cAGC;CACF;AAED,KAAK,mDAAmD,GAAG;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,+FAA+F;AAC/F,qBAAa,+CAAgD,SAAQ,KAAK;IACxE,6CAA6C;IAC7C,SAAgB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhC,YAAY,EAAE,MAAM,EAAE,EAAE,mDAAmD,EAQ1E;CACF;AAED,KAAK,oDAAoD,GAAG;IAC1D,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,sFAAsF;AACtF,qBAAa,gDAAiD,SAAQ,KAAK;IACzE,uDAAuD;IACvD,SAAgB,QAAQ,EAAE,MAAM,CAAC;IAEjC,YAAY,EAAE,QAAQ,EAAE,EAAE,oDAAoD,EAI7E;CACF;AAED,KAAK,0CAA0C,GAAG;IAChD,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,kGAAkG;AAClG,qBAAa,sCAAuC,SAAQ,KAAK;IAC/D,2DAA2D;IAC3D,SAAgB,SAAS,EAAE,MAAM,CAAC;IAElC,YAAY,EAAE,SAAS,EAAE,EAAE,0CAA0C,EAIpE;CACF"}

package/dist/rules/server-browser-protocol-2-parser.d.ts

@@ -0,0 +1,30 @@
+import { BufferCursor } from "@srvquery/core";
+import z from "zod";
+/** Validates the decoded "Server Message" body of a server browser protocol 2 (DayZ) response. */
+export declare const ServerBrowserProtocol2MessageSchema: z.ZodObject<{
+    version: z.ZodLiteral<2>;
+    generalFlags: z.ZodNumber;
+    dlcs: z.ZodArray<z.ZodObject<{
+        mask: z.ZodNumber;
+        appId: z.ZodOptional<z.ZodNumber>;
+        name: z.ZodString;
+        hash: z.ZodNumber;
+    }, z.core.$strip>>;
+    mods: z.ZodArray<z.ZodObject<{
+        hash: z.ZodNumber;
+        id: z.ZodBigInt;
+        name: z.ZodString;
+    }, z.core.$strip>>;
+    signatures: z.ZodArray<z.ZodString>;
+    description: z.ZodString;
+    extraRules: z.ZodRecord<z.ZodString, z.ZodString>;
+}, z.core.$strip>;
+/** Decoded "Server Message" body of a server browser protocol 2 (DayZ) response. */
+export type ServerBrowserProtocol2Message = z.infer<typeof ServerBrowserProtocol2MessageSchema>;
+/**
+ * Parses a server browser protocol 2 (DayZ) `A2S_RULES` response: reassembles the paged, escaped
+ * message from the rule pairs, then decodes its "Server Message" body.
+ * @param cursor Cursor positioned at the first byte after the response opcode.
+ */
+export declare const serverBrowserProtocol2RulesParser: (cursor: BufferCursor) => ServerBrowserProtocol2Message;
+//# sourceMappingURL=server-browser-protocol-2-parser.d.ts.map

package/dist/rules/server-browser-protocol-2-parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server-browser-protocol-2-parser.d.ts","sourceRoot":"","sources":["../../src/rules/server-browser-protocol-2-parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,CAAC,MAAM,KAAK,CAAC;AAuBpB,kGAAkG;AAClG,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;iBAS9C,CAAC;AAEH,oFAAoF;AACpF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mCAAmC,CAAC,CAAC;AAEhG;;;;GAIG;AACH,eAAO,MAAM,iCAAiC,WACpC,YAAY,KACnB,6BA8BF,CAAC"}

package/dist/rules/server-browser-protocol-3-parser.d.ts

@@ -0,0 +1,48 @@
+import { BufferCursor } from "@srvquery/core";
+import z from "zod";
+/** Validates the difficulty settings carried by a server browser protocol 3 message. */
+export declare const ServerBrowserProtocol3DifficultySchema: z.ZodObject<{
+    level: z.ZodNumber;
+    aiLevel: z.ZodNumber;
+    advancedFlightModel: z.ZodBoolean;
+    thirdPersonCamera: z.ZodBoolean;
+    weaponCrosshair: z.ZodBoolean;
+}, z.core.$strip>;
+/** Validates the decoded "Server Message" body of a server browser protocol 3 (Arma 3) response. */
+export declare const ServerBrowserProtocol3MessageSchema: z.ZodObject<{
+    version: z.ZodLiteral<3>;
+    generalFlags: z.ZodNumber;
+    dlcs: z.ZodArray<z.ZodObject<{
+        mask: z.ZodNumber;
+        appId: z.ZodOptional<z.ZodNumber>;
+        name: z.ZodString;
+        hash: z.ZodNumber;
+    }, z.core.$strip>>;
+    difficulty: z.ZodObject<{
+        level: z.ZodNumber;
+        aiLevel: z.ZodNumber;
+        advancedFlightModel: z.ZodBoolean;
+        thirdPersonCamera: z.ZodBoolean;
+        weaponCrosshair: z.ZodBoolean;
+    }, z.core.$strip>;
+    mods: z.ZodArray<z.ZodObject<{
+        hash: z.ZodNumber;
+        id: z.ZodBigInt;
+        name: z.ZodString;
+    }, z.core.$strip>>;
+    creatorDlcs: z.ZodArray<z.ZodObject<{
+        appId: z.ZodNumber;
+        name: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    signatures: z.ZodArray<z.ZodString>;
+    extraRules: z.ZodRecord<z.ZodString, z.ZodString>;
+}, z.core.$strip>;
+/** Decoded "Server Message" body of a server browser protocol 3 (Arma 3) response. */
+export type ServerBrowserProtocol3Message = z.infer<typeof ServerBrowserProtocol3MessageSchema>;
+/**
+ * Parses a server browser protocol 3 (Arma 3) `A2S_RULES` response: reassembles the paged,
+ * escaped message from the rule pairs, then decodes its "Server Message" body.
+ * @param cursor Cursor positioned at the first byte after the response opcode.
+ */
+export declare const serverBrowserProtocol3RulesParser: (cursor: BufferCursor) => ServerBrowserProtocol3Message;
+//# sourceMappingURL=server-browser-protocol-3-parser.d.ts.map

package/dist/rules/server-browser-protocol-3-parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server-browser-protocol-3-parser.d.ts","sourceRoot":"","sources":["../../src/rules/server-browser-protocol-3-parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,CAAC,MAAM,KAAK,CAAC;AA4CpB,wFAAwF;AACxF,eAAO,MAAM,sCAAsC;;;;;;iBAMjD,CAAC;AAEH,oGAAoG;AACpG,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAU9C,CAAC;AAEH,sFAAsF;AACtF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mCAAmC,CAAC,CAAC;AAEhG;;;;GAIG;AACH,eAAO,MAAM,iCAAiC,WACpC,YAAY,KACnB,6BAsCF,CAAC"}

package/dist/rules/server-browser-protocol-reassembly.d.ts

@@ -0,0 +1,51 @@
+import { BufferCursor } from "@srvquery/core";
+import z from "zod";
+export declare const byte: z.ZodNumber;
+export declare const uint16: z.ZodNumber;
+export declare const uint32: z.ZodNumber;
+/** Validates a DLC entry, including its bit mask and content hash. */
+export declare const ServerBrowserProtocolDlcSchema: z.ZodObject<{
+    mask: z.ZodNumber;
+    appId: z.ZodOptional<z.ZodNumber>;
+    name: z.ZodString;
+    hash: z.ZodNumber;
+}, z.core.$strip>;
+/** Validates a mod required by the server, including its Workshop ID and content hash. */
+export declare const ServerBrowserProtocolModSchema: z.ZodObject<{
+    hash: z.ZodNumber;
+    id: z.ZodBigInt;
+    name: z.ZodString;
+}, z.core.$strip>;
+/** Validates a Creator DLC entry encoded in the mods section (Arma 3 only). */
+export declare const ServerBrowserProtocolCreatorDlcSchema: z.ZodObject<{
+    appId: z.ZodNumber;
+    name: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/** DLC required by a server, including its bit mask and content hash. */
+export type ServerBrowserProtocolDlc = z.infer<typeof ServerBrowserProtocolDlcSchema>;
+/** Mod required by a server, including its Workshop ID and content hash. */
+export type ServerBrowserProtocolMod = z.infer<typeof ServerBrowserProtocolModSchema>;
+/** Creator DLC entry encoded in a mods section (Arma 3 only). */
+export type ServerBrowserProtocolCreatorDlc = z.infer<typeof ServerBrowserProtocolCreatorDlcSchema>;
+/**
+ * Reads a raw `A2S_RULES` response, reassembling its server browser protocol pages into a single
+ * unescaped message buffer. Rule pairs that aren't pages are returned separately as extra rules.
+ * @param cursor Cursor positioned at the first byte after the response opcode.
+ */
+export declare const reassembleServerBrowserProtocolMessage: (cursor: BufferCursor) => {
+    message: BufferCursor;
+    extraRules: Record<string, string>;
+};
+/** Reads a 4-byte content hash for every set bit in `dlcMask`, naming known DLCs from `names`. */
+export declare const readServerBrowserProtocolDlcs: (message: BufferCursor, dlcMask: number, names: Record<number, {
+    appId: number;
+    name: string;
+}>) => ServerBrowserProtocolDlc[];
+/** Reads the mods section, splitting out Creator DLC entries (ID length 19) by `creatorDlcNames`. */
+export declare const readServerBrowserProtocolMods: (message: BufferCursor, creatorDlcNames?: Record<number, string>) => {
+    mods: ServerBrowserProtocolMod[];
+    creatorDlcs: ServerBrowserProtocolCreatorDlc[];
+};
+/** Reads the signature list, skipping zero-length entries. */
+export declare const readServerBrowserProtocolSignatures: (message: BufferCursor) => string[];
+//# sourceMappingURL=server-browser-protocol-reassembly.d.ts.map

package/dist/rules/server-browser-protocol-reassembly.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server-browser-protocol-reassembly.d.ts","sourceRoot":"","sources":["../../src/rules/server-browser-protocol-reassembly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,CAAC,MAAM,KAAK,CAAC;AAOpB,eAAO,MAAM,IAAI,aAAoC,CAAC;AACtD,eAAO,MAAM,MAAM,aAAsC,CAAC;AAC1D,eAAO,MAAM,MAAM,aAA0C,CAAC;AAE9D,sEAAsE;AACtE,eAAO,MAAM,8BAA8B;;;;;iBAKzC,CAAC;AAEH,0FAA0F;AAC1F,eAAO,MAAM,8BAA8B;;;;iBAIzC,CAAC;AAEH,+EAA+E;AAC/E,eAAO,MAAM,qCAAqC;;;iBAGhD,CAAC;AAEH,yEAAyE;AACzE,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AACtF,4EAA4E;AAC5E,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AACtF,iEAAiE;AACjE,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qCAAqC,CAAC,CAAC;AAiDpG;;;;GAIG;AACH,eAAO,MAAM,sCAAsC,WACzC,YAAY,KACnB;IAAE,OAAO,EAAE,YAAY,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAiB7D,CAAC;AAEF,kGAAkG;AAClG,eAAO,MAAM,6BAA6B,YAC/B,YAAY,WACZ,MAAM,SACR,MAAM,CAAC,MAAM,EAAE;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,KACrD,wBAAwB,EAa1B,CAAC;AAEF,qGAAqG;AACrG,eAAO,MAAM,6BAA6B,YAC/B,YAAY,oBACJ,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KACtC;IAAE,IAAI,EAAE,wBAAwB,EAAE,CAAC;IAAC,WAAW,EAAE,+BAA+B,EAAE,CAAA;CAgCpF,CAAC;AAEF,8DAA8D;AAC9D,eAAO,MAAM,mCAAmC,YAAa,YAAY,KAAG,MAAM,EASjF,CAAC"}

package/dist/rules/valve-rule-parser.d.ts

@@ -0,0 +1,16 @@
+import { BufferCursor } from "@srvquery/core";
+import z from "zod";
+/**
+ * Deserializes a Valve rules packet from the given buffer cursor.
+ * @param cursor The buffer cursor pointing to the start of the rules packet.
+ * @returns The deserialized Valve rules array.
+ */
+export declare const valveRulesParser: (cursor: BufferCursor) => ValveRules;
+/** Validates decoded string rules from an `A2S_RULES` response. */
+export declare const ValveRulesSchema: z.ZodArray<z.ZodObject<{
+    name: z.ZodString;
+    value: z.ZodString;
+}, z.core.$strip>>;
+/** String rules returned by a Valve `A2S_RULES` response. */
+export type ValveRules = z.infer<typeof ValveRulesSchema>;
+//# sourceMappingURL=valve-rule-parser.d.ts.map

package/dist/rules/valve-rule-parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"valve-rule-parser.d.ts","sourceRoot":"","sources":["../../src/rules/valve-rule-parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,CAAC,MAAM,KAAK,CAAC;AAEpB;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,WAAY,YAAY,KAAG,UAQvD,CAAC;AAEF,mEAAmE;AACnE,eAAO,MAAM,gBAAgB;;;kBAK5B,CAAC;AAEF,6DAA6D;AAC7D,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@srvquery/protocol-valve",
+  "version": "0.0.1-next.0",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "dependencies": {
+    "zod": "^4.5.4"
+  },
+  "devDependencies": {
+    "@internal/typescript-config": "0.0.0",
+    "@srvquery/core": "0.0.1-next.0",
+    "@types/node": "^26.4.1",
+    "rolldown": "^1.2.7",
+    "typescript": "^7.0.2",
+    "vitest": "^5.0.0"
+  },
+  "peerDependencies": {
+    "@srvquery/core": "0.0.1-next.0"
+  },
+  "scripts": {
+    "build": "rolldown -c rolldown.config.ts && tsc -p tsconfig.json",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}