Add type definitions for node-ssdp

types/node-ssdp/index.d.ts

@@ -0,0 +1,140 @@
+// Type definitions for node-ssdp v3.3.0
+// Project: https://github.com/diversario/node-ssdp
+// Definitions by: Olivia Trewin <https://github.com/OrionNebula>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+/// <reference types="node" />
+
+import * as events from 'events';
+
+export interface SsdpHeaders {
+	[key: string]: string | number | boolean | null | undefined | symbol
+}
+
+export interface SsdpOptions {
+	/**
+	 * SSDP signature
+	 * @default 'node.js/NODE_VERSION UPnP/1.1 node-ssdp/PACKAGE_VERSION'
+	 */
+	ssdpSig?: string;
+	/**
+	 * SSDP multicast group
+	 * @default '239.255.255.250'
+	 */
+	ssdpIp?: string;
+	/**
+	 * Multicast TTL
+	 * @default 4
+	 */
+	ssdpTtl?: number;
+	/**
+	 * SSDP port
+	 * @default 1900
+	 */
+	ssdpPort?: number;
+	/** Path to SSDP description file */
+	description?: string;
+	/** Additional headers */
+	headers?: SsdpHeaders;
+}
+
+export interface ClientOptions extends SsdpOptions {
+	/** List of interfaces to explicitly bind. By default, bind to all available interfaces. */
+	interfaces?: string[];
+	/** Bind sockets to each discovered interface explicitly instead of relying on the system. Might help with issues with multiple NICs. */
+	explicitSocketBind?: boolean;
+	/** A logger function to use instead of the default. The first argument to the function can contain a format string. */
+	customLogger?: (format?: string) => void;
+	/**
+	 * When true socket.bind() will reuse the address, even if another process has already bound a socket on it.
+	 * @default true
+	 */
+	reuseAddr?: boolean;
+}
+
+export interface ServiceDescriptionLocation {
+	/**
+	 * Location protocol.
+	 * @default 'http://'
+	 */
+	protocol?: string;
+	/**
+	 * Location port.
+	 */
+	port: number;
+	/**
+	 * Location path.
+	 */
+	path: string;
+}
+
+export interface ServerOptions extends ClientOptions {
+	/**
+	 * URL pointing to description of your service, or a function that returns that URL.
+	 * For cases where there are multiple network interfaces or the IP of the host isn't known in advance, it's possible to specify location as an object. Host will be set to the IP of the responding interface.
+	 */
+	location?: string | ServiceDescriptionLocation;
+	/**
+	 * SSDP Unique Device Name
+	 * @default 'uuid:f40c2981-7329-40b7-8b04-27f187aecfb5'
+	 */
+	udn?: string;
+	/**
+	 * Allow wildcards in M-SEARCH packets (non-standard)
+	 * @default false
+	 */
+	allowWildcards?: boolean;
+	/**
+	 * When true the SSDP server will not advertise the root device (i.e. the bare UDN). In some scenarios, this advertisement is not needed.
+	 * @default false
+	 */
+	suppressRootDeviceAdvertisements?: boolean;
+	/**
+	 * Interval at which to send out advertisement (ms)
+	 * @default 10000
+	*/
+	adInterval?: number;
+	/**
+	 * Packet TTL
+	 * @default 1800
+	 */
+	ttl?: number;
+}
+
+export abstract class Base extends events.EventEmitter {
+	constructor (opts: SsdpOptions);
+
+	addUSN (device: string): void;
+}
+
+export class Client extends Base {
+	constructor (opts: ClientOptions);
+
+	/**
+	 * Start the listener for multicast notifications from SSDP devices
+	 * @param {(error: any) => void?} cb callback to socket.bind
+	 * @returns {Promise<void>} promise when socket.bind is ready
+	 */
+	start (cb?: (error: any) => void): Promise<void>;
+	/**
+	 * Close UDP socket.
+	 */
+	stop (): void;
+	search (serviceType: string): void | Promise<void>;
+}
+
+export class Server extends Base {
+	constructor (opts: ServerOptions);
+
+	/**
+	 * Binds UDP socket to an interface/port and starts advertising.
+	 * @param {(error: any) => void?} cb callback to socket.bind
+	 * @returns {void | Proimse<void>} promise when socket.bind is ready
+	 */
+	start (cb?: (error: any) => void): void | Promise<void>;
+	/**
+	 * Advertise shutdown and close UDP socket.
+	 */
+	stop (): void;
+	advertise (alive?: boolean): void;
+}

types/node-ssdp/node-ssdp-tests.ts

@@ -0,0 +1,73 @@
+import { Client, Server } from 'node-ssdp';
+
+// Taken from https://github.com/diversario/node-ssdp#usage---client
+
+const client = new Client({
+	interfaces: [],
+	customLogger: format => {},
+	explicitSocketBind: true,
+	reuseAddr: true,
+	ssdpPort: 0,
+	description: '',
+	headers: {
+		key: 'value'
+	},
+	ssdpIp: '',
+	ssdpSig: '',
+	ssdpTtl: 0
+});
+
+client.on('response', function (headers, statusCode, rinfo) {
+	console.log('Got a response to an m-search.');
+});
+
+// search for a service type
+client.search('urn:schemas-upnp-org:service:ContentDirectory:1');
+
+// Or get a list of all services on the network
+
+client.search('ssdp:all');
+
+const server = new Server({
+	interfaces: [],
+	customLogger: format => {},
+	explicitSocketBind: true,
+	reuseAddr:true,
+	ssdpPort: 0,
+	location: {
+		protocol: 'http://',
+		path: '',
+		port: 80
+	},
+	suppressRootDeviceAdvertisements: true,
+	adInterval: 0,
+	allowWildcards: false,
+	description: '',
+	headers: {
+		key: 'value'
+	},
+	ssdpIp: '',
+	ssdpSig: '',
+	ssdpTtl: 0,
+	ttl: 0,
+	udn: ''
+});
+
+// Taken from https://github.com/diversario/node-ssdp#usage---server
+
+server.addUSN('upnp:rootdevice');
+server.addUSN('urn:schemas-upnp-org:device:MediaServer:1');
+server.addUSN('urn:schemas-upnp-org:service:ContentDirectory:1');
+server.addUSN('urn:schemas-upnp-org:service:ConnectionManager:1');
+
+server.on('advertise-alive', function (headers) {
+	// Expire old devices from your cache.
+	// Register advertising device somewhere (as designated in http headers heads)
+});
+
+server.on('advertise-bye', function (headers) {
+	// Remove specified device from cache.
+});
+
+// start the server
+server.start();

types/node-ssdp/tsconfig.json

@@ -0,0 +1,24 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "target": "es6",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "node-ssdp-tests.ts"
+    ]
+}

types/node-ssdp/tslint.json

@@ -0,0 +1,3 @@
+{
+  "extends": "dtslint/dt.json"
+}