🤖 Merge PR DefinitelyTyped#74851 feat(node-osc): upgrade types for v10 by @panz3r

Author: panz3r

attw.json

@@ -189,7 +189,6 @@
         "next-nprogress",
         "ngreact",
         "node-fetch-cache",
-        "node-osc",
         "notie",
         "npm",
         "object.groupby",

types/node-osc/index.d.cts

@@ -0,0 +1,116 @@
+/// <reference types="node" />
+
+import type { EventEmitter } from "events";
+
+/** Represents the content of a message */
+export interface Argument {
+    type: string;
+
+    value: boolean | number | string;
+}
+
+export type ArgumentType = boolean | number | string | Argument;
+
+export interface RequestInfo {
+    address: string;
+    family: string;
+    port: number;
+    size: number;
+}
+
+/**
+ * A message that can be sent over OSC
+ */
+export class Message {
+    constructor(address: string, ...args: ArgumentType[]);
+
+    append(arg: ArgumentType | ArgumentType[]): void;
+}
+
+/** Something that is or can be converted to a Message */
+export type MessageLike =
+    | [string, ...ArgumentType[]]
+    | {
+        address: string;
+
+        args: ArgumentType[];
+    };
+
+/**
+ * An OSC Bundle message
+ *
+ * @warning Bundle support is Experimental and subject to change at any point.
+ *
+ * @see https://github.com/MylesBorins/node-osc#sending-osc-bundles
+ */
+export class Bundle {
+    constructor(...elements: MessageLike[]);
+    constructor(timetag: number, ...elements: MessageLike[]);
+
+    append(element: MessageLike | Bundle): void;
+
+    timetag: number;
+
+    elements: Message[];
+}
+
+export type ClientSendArgs = Array<ArgumentType | Message | MessageLike>;
+
+export type ClientSendCallback = (err: Error | null) => void;
+
+export type ClientCloseCallback = () => void;
+
+/**
+ * A client to send messages to an OSC server
+ */
+export class Client {
+    constructor(host: string, port: number);
+
+    /** Close the underlying socket */
+    close(cb?: ClientCloseCallback): void;
+
+    /** Send a message to the server */
+    send(addressOrMessage: string | Message | MessageLike): void;
+    send(address: string, ...args: ClientSendArgs): void;
+    send(address: string, ...args: [...ClientSendArgs, ClientSendCallback]): void;
+    send(...args: ClientSendArgs): void;
+    send(...args: [...ClientSendArgs, ClientSendCallback]): void;
+
+    /** Send a Bundle message to the server */
+    send(bundle: Bundle, callback?: ClientSendCallback): void;
+}
+
+export type ServerCallback = () => void;
+
+export type ServerBundleListener = (bundle: Bundle) => void;
+
+export type ServerErrorListner = (error: Error) => void;
+
+export type ServerMessageListener = (message: [string, ...ArgumentType[]], rinfo: RequestInfo) => void;
+
+/**
+ * A server to handle OSC messages
+ */
+export class Server extends EventEmitter {
+    constructor(port: number, host: string, cb?: ServerCallback);
+
+    close(cb?: ServerCallback): void;
+
+    /** Listen for the listening event emitted as soon as the server is ready to receive messages */
+    on(event: "listening", listener: () => void): this;
+
+    /**
+     * Listen for all the bundles received by the server.
+     *
+     * @warning Bundle support is Experimental and subject to change at any point.
+     *
+     * @see https://github.com/MylesBorins/node-osc#listening-for-osc-bundles
+     */
+    on(event: "bundle", listener: ServerBundleListener): this;
+
+    /** Listen for errors occurred during message decoding */
+    on(event: "error", listener: ServerErrorListner): this;
+
+    /** Listen for all the messages received by the server or for a specific address */
+    on(event: "message" | string, listener: ServerMessageListener): this;
+}

types/node-osc/package.json

@@ -1,7 +1,14 @@
 {
     "private": true,
     "name": "@types/node-osc",
-    "version": "9.1.9999",
+    "version": "10.0.9999",
+    "type": "module",
+    "exports": {
+        ".": {
+            "import": "./index.d.ts",
+            "require": "./index.d.cts"
+        }
+    },
     "projects": [
         "https://github.com/MylesBorins/node-osc#readme"
     ],

types/node-osc/tsconfig.json

@@ -14,6 +14,7 @@
     },
     "files": [
         "index.d.ts",
+        "index.d.cts",
         "node-osc-tests.ts"
     ]
 }