@srvquery/protocol-openmp 0.0.1-next.0

package/dist/packet/opcodes.d.ts

@@ -0,0 +1,16 @@
+/**
+ * OpenMP protocol request opcodes.
+ * @link https://open.mp/docs/tutorials/QueryMechanism#opcode
+ */
+export declare const requestOpcodes: {
+    readonly INFO: 105;
+    readonly RULES: 114;
+    readonly CLIENT_LIST: 99;
+    readonly PLAYERS: 100;
+    readonly PING: 112;
+};
+/** Symbolic opcode accepted by an open.mp query. */
+export type OpenMPProtocolRequestOpcode = keyof typeof requestOpcodes;
+/** Numeric wire value for an open.mp request opcode. */
+export type OpenMPProtocolRequestOpcodeValue = (typeof requestOpcodes)[keyof typeof requestOpcodes];
+//# 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,GAAG;aACT,KAAK,EAAE,GAAG;aACV,WAAW,EAAE,EAAE;aACf,OAAO,EAAE,GAAG;aACZ,IAAI,EAAE,GAAG;CACD,CAAC;AAEX,oDAAoD;AACpD,MAAM,MAAM,2BAA2B,GAAG,MAAM,OAAO,cAAc,CAAC;AACtE,wDAAwD;AACxD,MAAM,MAAM,gCAAgC,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC"}

package/dist/packet/request.d.ts

@@ -0,0 +1,21 @@
+import { OpenMPProtocolRequestOpcode } from "./opcodes";
+/** Values encoded into an open.mp query request packet. */
+export type BuildRequestPacketParams = {
+    /** Query opcode to encode. */
+    opcode: OpenMPProtocolRequestOpcode;
+    /** Target IPv4 address embedded in the packet header. */
+    ip: string;
+    /** Target port embedded in little-endian order. */
+    port: number;
+};
+/** Length in bytes of an open.mp query packet header. */
+export declare const packetHeaderLength = 11;
+/**
+ * Builds a request packet for the OpenMP protocol.
+ * @link https://open.mp/docs/tutorials/QueryMechanism#serialized-data
+ *
+ * @param param0 The parameters for building the packet header, including the opcode, IP address, and port number.
+ * @returns A Buffer containing the request packet.
+ */
+export declare const buildRequestPacket: ({ opcode, ip, port }: 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,EAAE,2BAA2B,EAAkB,MAAM,WAAW,CAAC;AAExE,2DAA2D;AAC3D,MAAM,MAAM,wBAAwB,GAAG;IACrC,8BAA8B;IAC9B,MAAM,EAAE,2BAA2B,CAAC;IACpC,yDAAyD;IACzD,EAAE,EAAE,MAAM,CAAC;IACX,mDAAmD;IACnD,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,yDAAyD;AACzD,eAAO,MAAM,kBAAkB,KAAK,CAAC;AAErC;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,yBAA0B,wBAAwB,KAAG,MAUnF,CAAC"}

package/dist/packet/schema.d.ts

@@ -0,0 +1,53 @@
+import z from "zod";
+/** Validates an open.mp `INFO` response. */
+export declare const OpenMPServerInfoSchema: z.ZodObject<{
+    password: z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>]>;
+    players: z.ZodNumber;
+    maxPlayers: z.ZodNumber;
+    hostname: z.ZodString;
+    gamemode: z.ZodString;
+    language: z.ZodString;
+}, z.core.$strip>;
+/** General server metadata returned by an open.mp `INFO` query. */
+export type OpenMPServerInfo = z.infer<typeof OpenMPServerInfoSchema>;
+/** Validates the string key-value map returned by an open.mp `RULES` query. */
+export declare const OpenMPRulesSchema: z.ZodRecord<z.ZodString, z.ZodString>;
+/** Server rule names and values returned by an open.mp `RULES` query. */
+export type OpenMPRules = z.infer<typeof OpenMPRulesSchema>;
+/** Validates a compact client entry containing a name and score. */
+export declare const OpenMPClientSchema: z.ZodObject<{
+    name: z.ZodString;
+    score: z.ZodNumber;
+}, z.core.$strip>;
+/** Validates the compact client list returned by a `CLIENT_LIST` query. */
+export declare const OpenMPClientListSchema: z.ZodArray<z.ZodObject<{
+    name: z.ZodString;
+    score: z.ZodNumber;
+}, z.core.$strip>>;
+/** Compact open.mp client entry containing a name and score. */
+export type OpenMPClient = z.infer<typeof OpenMPClientSchema>;
+/** Compact client entries returned by an open.mp `CLIENT_LIST` query. */
+export type OpenMPClientList = z.infer<typeof OpenMPClientListSchema>;
+/** Validates a detailed open.mp player entry. */
+export declare const OpenMPPlayerSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    name: z.ZodString;
+    score: z.ZodNumber;
+    ping: z.ZodNumber;
+}, z.core.$strip>;
+/** Validates the detailed player list returned by a `PLAYERS` query. */
+export declare const OpenMPPlayersSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    name: z.ZodString;
+    score: z.ZodNumber;
+    ping: z.ZodNumber;
+}, z.core.$strip>>;
+/** Detailed open.mp player entry containing an ID, name, score, and ping. */
+export type OpenMPPlayer = z.infer<typeof OpenMPPlayerSchema>;
+/** Detailed player entries returned by an open.mp `PLAYERS` query. */
+export type OpenMPPlayers = z.infer<typeof OpenMPPlayersSchema>;
+/** Validates the non-negative round-trip latency returned by an open.mp `PING` query. */
+export declare const OpenMPPingSchema: z.ZodNumber;
+/** Round-trip latency in milliseconds measured by an open.mp `PING` query. */
+export type OpenMPPing = z.infer<typeof OpenMPPingSchema>;
+//# 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;AAMpB,4CAA4C;AAC5C,eAAO,MAAM,sBAAsB;;;;;;;iBAOjC,CAAC;AAEH,mEAAmE;AACnE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,+EAA+E;AAC/E,eAAO,MAAM,iBAAiB,uCAAmC,CAAC;AAElE,yEAAyE;AACzE,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D,oEAAoE;AACpE,eAAO,MAAM,kBAAkB;;;iBAG7B,CAAC;AAEH,2EAA2E;AAC3E,eAAO,MAAM,sBAAsB;;;kBAA8B,CAAC;AAElE,gEAAgE;AAChE,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC9D,yEAAyE;AACzE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE,iDAAiD;AACjD,eAAO,MAAM,kBAAkB;;;;;iBAK7B,CAAC;AAEH,wEAAwE;AACxE,eAAO,MAAM,mBAAmB;;;;;kBAA8B,CAAC;AAE/D,6EAA6E;AAC7E,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAC9D,sEAAsE;AACtE,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE,yFAAyF;AACzF,eAAO,MAAM,gBAAgB,aAA2B,CAAC;AAEzD,8EAA8E;AAC9E,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC"}

package/dist/packet/serde.d.ts

@@ -0,0 +1,40 @@
+import { BufferCursor } from "@srvquery/core";
+/** Deserializes an open.mp response from a cursor positioned at its packet header. */
+export type OpenMPTextDecoder = (buffer: Buffer) => string;
+export type OpenMPPacketDeserializeFn = (cursor: BufferCursor, decodeText: OpenMPTextDecoder) => unknown;
+/**
+ * Parses the server info from the given buffer cursor.
+ *
+ * @param cursor The buffer cursor pointing to the server info data.
+ * @returns The parsed server info object.
+ */
+export declare const deserializeInfoPacket: OpenMPPacketDeserializeFn;
+/**
+ * Parses the ping value from the given buffer cursor.
+ *
+ * @param cursor The buffer cursor pointing to the ping data.
+ * @returns The parsed ping value as an OpenMPPing object.
+ */
+export declare const deserializePingPacket: OpenMPPacketDeserializeFn;
+/**
+ * Parses the server rules from the given buffer cursor.
+ *
+ * @param cursor The buffer cursor pointing to the rules data.
+ * @returns The parsed rules object as an OpenMPRules instance.
+ */
+export declare const deserializeRulesPacket: OpenMPPacketDeserializeFn;
+/**
+ * Parses the client list from the given buffer cursor.
+ *
+ * @param cursor The buffer cursor pointing to the client list data.
+ * @returns The parsed client list as an OpenMPClientList object.
+ */
+export declare const deserializeClientListPacket: OpenMPPacketDeserializeFn;
+/**
+ * Parses the list of players from the given buffer cursor.
+ *
+ * @param cursor The buffer cursor pointing to the players data.
+ * @returns The parsed players list as an OpenMPPlayers object.
+ */
+export declare const deserializePlayersPacket: OpenMPPacketDeserializeFn;
+//# 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,sFAAsF;AACtF,MAAM,MAAM,iBAAiB,GAAG,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;AAC3D,MAAM,MAAM,yBAAyB,GAAG,CACtC,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,iBAAiB,KAC1B,OAAO,CAAC;AASb;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,EAAE,yBAoBnC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,EAAE,yBAKnC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,EAAE,yBAepC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,2BAA2B,EAAE,yBAazC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,EAAE,yBAetC,CAAC"}

package/dist/protocol.d.ts

@@ -0,0 +1,31 @@
+import { CreateUdpSocketOptions, CreateUdpSocketParams } from "@srvquery/core";
+import { OpenMPProtocolRequestOpcode } from "./packet/opcodes";
+import { type OpenMPTextDecoder } from "./packet/serde";
+import { OpenMPClientList, OpenMPPlayers, OpenMPRules, type OpenMPPing, type OpenMPServerInfo } from "./packet/schema";
+/** Connection and retry settings used to create an open.mp protocol client. */
+export type CreateOpenMPProtocolParams = CreateUdpSocketParams & CreateUdpSocketOptions;
+type OpenMPProtocolQueryParams<Opcode extends OpenMPProtocolRequestOpcode> = {
+    opcode: Opcode;
+    /** Decodes text fields returned by the server. Defaults to UTF-8. */
+    decodeText?: OpenMPTextDecoder;
+};
+type OpenMPProtocolResponseMap = {
+    INFO: OpenMPServerInfo;
+    RULES: OpenMPRules;
+    CLIENT_LIST: OpenMPClientList;
+    PLAYERS: OpenMPPlayers;
+    PING: OpenMPPing;
+};
+/** Client for querying SA-MP and open.mp servers. */
+export interface OpenMPProtocol {
+    /** Queries one open.mp opcode and resolves with its corresponding response model. */
+    query<Opcode extends OpenMPProtocolRequestOpcode>(params: OpenMPProtocolQueryParams<Opcode>): Promise<OpenMPProtocolResponseMap[Opcode]>;
+}
+/**
+ * Creates a client for querying SA-MP and open.mp servers.
+ * @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 createOpenMPProtocol: ({ host, port, retry, timeout, ...socketOptions }: CreateOpenMPProtocolParams) => OpenMPProtocol;
+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,EAGL,sBAAsB,EACtB,qBAAqB,EAKtB,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAAE,2BAA2B,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EAOL,KAAK,iBAAiB,EACvB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,gBAAgB,EAChB,aAAa,EACb,WAAW,EACX,KAAK,UAAU,EACf,KAAK,gBAAgB,EACtB,MAAM,iBAAiB,CAAC;AAEzB,+EAA+E;AAC/E,MAAM,MAAM,0BAA0B,GAAG,qBAAqB,GAAG,sBAAsB,CAAC;AAWxF,KAAK,yBAAyB,CAAC,MAAM,SAAS,2BAA2B,IAAI;IAC3E,MAAM,EAAE,MAAM,CAAC;IACf,qEAAqE;IACrE,UAAU,CAAC,EAAE,iBAAiB,CAAC;CAChC,CAAC;AAEF,KAAK,yBAAyB,GAAG;IAC/B,IAAI,EAAE,gBAAgB,CAAC;IACvB,KAAK,EAAE,WAAW,CAAC;IACnB,WAAW,EAAE,gBAAgB,CAAC;IAC9B,OAAO,EAAE,aAAa,CAAC;IACvB,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC;AAEF,qDAAqD;AACrD,MAAM,WAAW,cAAc;IAC7B,qFAAqF;IACrF,KAAK,CAAC,MAAM,SAAS,2BAA2B,EAC9C,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC,GACxC,OAAO,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC,CAAC;CAC/C;AAUD;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,qDAM9B,0BAA0B,KAAG,cAgE/B,CAAC"}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@srvquery/protocol-openmp",
+  "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"
+  }
+}