🤖 Merge PR DefinitelyTyped#74419 Add types for k6/x/socketio by @XEmAX32

Co-authored-by: Emanuele Sacco <ema.sacco32@gmail.com>

Author: XEmAX32

types/k6__x__socketio/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/k6__x__socketio/index.d.ts

@@ -0,0 +1,114 @@
+
+declare module "k6/x/socketio" {
+  interface SocketIOOptions {
+    /**
+     * Socket.IO path (default: "/socket.io/")
+     */
+    path?: string;
+    /**
+     * Namespace to connect to (default: "/")
+     * Example: "/chat"
+     */
+    namespace?: string;
+    /**
+     * Auth payload sent in the connect packet
+     */
+    auth?: Record<string, any>;
+    /**
+     * Query parameters appended to the URL
+     */
+    query?: Record<string, any>;
+    /**
+     * Passed directly to k6/ws.connect
+     */
+    params?: {
+      /** Request headers. */
+      headers?: { [name: string]: string };
+
+      /**
+       * Compression algorithm. The only supported algorithm is `deflate`.
+       * If the option is left unset or empty, it defaults to no compression.
+       */
+      compression?: string;
+
+      /** Response time metric tags. */
+      tags?: { [name: string]: string };
+    };
+  }
+
+  /**
+   * Socket.IO socket wrapper
+   *
+   * Provides Socket.IO-like API on top of k6/ws WebSocket connection.
+   * Socket.IO-specific methods (on, emit, send) override the original k6/ws methods.
+   * All other k6/ws socket methods are available as-is via the wrapper.
+   */
+  interface Socket {
+    /**
+         * Register an event handler (Socket.IO version)
+         * Overrides the original k6/ws on() method
+         *
+         * @param event - Event name ("connect", "disconnect", or custom event)
+         * @param handler - Handler function that receives event data
+         */
+    on(event: string, handler: (data?: any) => void): void;
+
+    /**
+      * Emit an event to the server (Socket.IO specific)
+      *
+      * @param event - Event name
+      * @param data - Optional data to send with the event
+      */
+    emit(event: string, data?: any): void;
+
+    /**
+      * Send data (Socket.IO version - alias for emit("message", data))
+      * Overrides the original k6/ws send() method
+      *
+      * @param data - Data to send
+      */
+    send(data: any): void;
+
+    /**
+      * Close connection.
+      * https://grafana.com/docs/k6/latest/javascript-api/k6-ws/socket/socket-close/
+      *
+      * @param code - WebSocket status code.
+      * @example
+      * socket.close();
+      */
+    close(code?: number): void;
+  }
+
+  /**
+   * Connect to a Socket.IO server
+   *
+   * @param host - Base URL such as "http://localhost:4000" or "wss://example.com"
+   * @param options - Optional configuration
+   * @param handler - Optional callback function called with a Socket.IO-like socket wrapper
+   * @returns The underlying k6/ws.connect result
+   *
+   * @example
+   * ```typescript
+   * import { io } from "k6/x/socketio";
+   *
+   * io("http://localhost:4000", {}, (socket) => {
+   *   socket.on("connect", () => {
+   *     socket.emit("hello", { payload: "hi from k6" });
+   *   });
+   * });
+   * ```
+   */
+  function io(
+    host: string,
+    options?: SocketIOOptions,
+    handler?: (socket: Socket) => void
+  ): any;
+
+  export { io, Socket, SocketIOOptions };
+}
+
+declare module "xk6-socketio" {
+  import { io, Socket, SocketIOOptions } from "k6/x/socketio";
+  export { io, Socket, SocketIOOptions };
+}

types/k6__x__socketio/k6__x__socketio-tests.ts

@@ -0,0 +1,29 @@
+import { io, type Socket, type SocketIOOptions } from "k6/x/socketio";
+
+const opts: SocketIOOptions = {
+  path: "/socket.io/",
+  namespace: "/chat",
+  auth: { token: "abc" },
+  query: { a: 1 },
+  params: {
+    headers: { Authorization: "Bearer token" },
+    compression: "deflate",
+    tags: { name: "socketio" },
+  },
+};
+
+io("http://localhost:4000", opts, (socket: Socket) => {
+  socket.on("connect", () => {});
+  socket.on("hello", (data) => {
+    const _x: any = data;
+  });
+
+  socket.emit("hello", { payload: "hi from k6" });
+  socket.send({ msg: "message" });
+
+  socket.close();
+
+});
+
+// also works without options/handler
+io("wss://example.com");

types/k6__x__socketio/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@types/k6__x__socketio",
+  "version": "0.1.9999",
+  "private": true,
+  "nonNpm": true,
+  "nonNpmDescription": "Type definitions for xk6 extension providing Socket.IO support in k6, not distributed via npm",
+  "projects": ["https://github.com/XEmAX32/xk6-socket.io"],
+  "owners": [
+    {
+      "name": "Emanuele Sacco",
+      "url": "https://github.com/xemax32"
+    }
+  ],
+  "dependencies": {
+    "@types/k6": "*"
+  },
+  "devDependencies": {
+    "@types/k6__x__socketio": "workspace:."
+  }
+}

types/k6__x__socketio/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "module": "node16",
+    "lib": ["es2015"],
+    "noEmit": true,
+    "types": [],
+    "forceConsistentCasingInFileNames": true,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true
+  },
+  "files": [
+    "index.d.ts",
+    "k6__x__socketio-tests.ts"
+  ]
+}