Add extracted typings from nodecg v1.8.1

These are the typings as of nodecg/nodecg@e3dbf8d which is the commit tagged as `v1.8.1`.

Author: hlxid

types/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alex Van Camp, Matthew McNamara, and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

types/browser.d.ts

@@ -0,0 +1,13 @@
+import {NodeCGStaticBrowser} from './lib/nodecg-static';
+import {NodeCGBrowser} from './lib/nodecg-instance';
+
+declare global {
+	export const nodecg: NodeCGBrowser;
+	export const NodeCG: NodeCGStaticBrowser;
+	export interface Window { nodecg: NodeCGBrowser, NodeCG: NodeCGStaticBrowser }
+}
+
+export {NodeCGStaticBrowser, NodeCGBrowser};
+export * from './lib/config';
+export * from './lib/logger';
+export * from './lib/replicant';

types/lib/config.d.ts

@@ -0,0 +1,33 @@
+import {LoggerOptions} from './logger';
+
+/**
+ * NodeCG config exposed in extensions and browser
+ */
+export interface NodeCGConfig {
+	host: string;
+	port: number;
+	developer: boolean;
+	baseURL: string;
+	logging: LoggerOptions;
+	sentry: {
+		enabled?: boolean;
+		publicDsn?: string;
+	};
+	login: {
+		enabled?: boolean;
+		local?: {
+			enabled: boolean;
+		};
+		steam?: {
+			enabled: boolean;
+		};
+		twitch?: {
+			enabled: boolean;
+			clientID: string;
+			scope: string;
+		};
+	};
+	ssl?: {
+		enabled: boolean;
+	};
+}

types/lib/logger.d.ts

@@ -0,0 +1,34 @@
+export class Logger {
+	constructor(name: string);
+	trace(...args: any[]): void;
+	debug(...args: any[]): void;
+	info(...args: any[]): void;
+	warn(...args: any[]): void;
+	error(...args: any[]): void;
+	replicants(...args: any[]): void;
+	static globalReconfigure(
+		opts: LoggerOptions & {file: {path: string}}
+	): void;
+}
+
+/**
+ * Options used for Logger constructor
+ */
+export interface LoggerOptions {
+	replicants?: boolean;
+	console?: {
+		enabled: boolean;
+		timestamps: boolean;
+		level: LoggerLevel;
+	};
+	file?: {
+		enabled: boolean;
+		timestamps: boolean;
+		level: LoggerLevel;
+	};
+}
+
+/**
+ * NodeCG logger level enum
+ */
+export type LoggerLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error';

types/lib/nodecg-instance.d.ts

@@ -0,0 +1,134 @@
+/// <reference lib="dom" />
+/// <reference types="node" />
+/// <reference types="socket.io" />
+/// <reference types="socket.io-client" />
+/// <reference types="soundjs" />
+
+import {RequestHandler, Router, RouterOptions} from 'express';
+
+import {Logger} from './logger';
+import {ReplicantOptions, Replicant} from './replicant';
+import {NodeCGConfig} from './config';
+import {SendMessageToBundle, SendMessageReturnType} from './nodecg-static';
+import {Platform} from './platform';
+
+interface NodeCGCommon<P extends Platform, M = SendMessageReturnType<P>> {
+	bundleName: string;
+	bundleConfig: any;
+	bundleVersion: string;
+	readonly bundleGit: {
+		branch: string;
+		hash: string;
+		shortHash: string;
+		date?: Date;
+		message?: string;
+	};
+	Logger: typeof Logger;
+	log: Logger;
+	readonly config: NodeCGConfig;
+	sendMessage(
+		messageName: string,
+		cb?: (error: any, ...args: any[]) => void
+	): M;
+	sendMessage(
+		messageName: string,
+		data: any,
+		cb?: (error: any, ...args: any[]) => void
+	): M;
+	sendMessageToBundle: SendMessageToBundle<P, M>;
+	listenFor(messageName: string, handlerFunc: (message: any) => void): void;
+	listenFor(
+		messageName: string,
+		bundleName: string,
+		handlerFunc: (message: any) => void
+	): void;
+	unlisten(messageName: string, handlerFunc: (message: any) => void): void;
+	unlisten(
+		messageName: string,
+		bundleName: string,
+		handlerFunc: (message: any) => void
+	): void;
+	Replicant<V>(name: string, opts?: ReplicantOptions<V>): Replicant<V, P>;
+	Replicant<V>(
+		name: string,
+		namespace: string,
+		opts?: ReplicantOptions<V>
+	): Replicant<V, P>;
+}
+
+/**
+ * NodeCG instance in extensions
+ */
+export interface NodeCGServer extends NodeCGCommon<'server'> {
+	getSocketIOServer(): SocketIO.Server;
+	Router(options?: RouterOptions): Router;
+	mount: Router['use'];
+	util: {
+		authCheck: RequestHandler;
+	};
+	extensions: {
+		[bundleName: string]: (nodecg: NodeCGServer) => void;
+	};
+	listenFor(
+		messageName: string,
+		handlerFunc: (message: any, cb?: ListenForCb) => void
+	): void;
+	listenFor(
+		messageName: string,
+		bundleName: string,
+		handlerFunc: (message: any, cb?: ListenForCb) => void
+	): void;
+}
+
+/**
+ * NodeCG instance in browser
+ */
+export interface NodeCGBrowser extends NodeCGCommon<'browser'> {
+	socket: SocketIOClient.Socket;
+	soundReady?: boolean;
+	getDialog(
+		name: string,
+		bundle?: string
+	): ReturnType<ParentNode['querySelector']>;
+	getDialogDocument(name: string, bundle?: string): Document;
+	findCue(cueName: string): Cue | undefined;
+	playSound(
+		cueName: string,
+		opts?: {updateVolume?: boolean}
+	): createjs.AbstractSoundInstance;
+	stopSound(cueName: string): void;
+	stopAllSounds(): void;
+	readReplicant<V>(name: string, cb: (value: V) => void): void;
+	readReplicant<V>(
+		name: string,
+		namespace: string,
+		cb: (value: V) => void
+	): void;
+}
+
+/**
+ * NodeCG instance combined
+ */
+export type NodeCG<P extends Platform> = P extends 'server'
+	? NodeCGServer
+	: NodeCGBrowser;
+
+/**
+ * Sound cue object
+ */
+interface Cue {
+	name: string;
+	assignable: boolean;
+	defaultFile: string;
+}
+
+export type ListenForCb = HandledListenForCb | UnhandledListenForCb;
+
+interface HandledListenForCb {
+	handled: true;
+}
+
+interface UnhandledListenForCb {
+	(...args: any[]): void;
+	handled: false;
+}

types/lib/nodecg-static.d.ts

@@ -0,0 +1,78 @@
+import {
+	Replicant,
+	ReplicantOptions,
+	DeclaredReplicants,
+	ReplicantBrowser,
+} from './replicant';
+import {NodeCG} from './nodecg-instance';
+import {Platform} from './platform';
+
+/**
+ * NodeCG constructor
+ */
+interface NodeCGStaticCommon<P extends Platform, R = Replicant<any, P>> {
+	new (bundle: any, socket: SocketIOClient.Socket): NodeCG<P>;
+	version: string;
+	sendMessageToBundle: SendMessageToBundle<P>;
+	declaredReplicants: DeclaredReplicants<P>;
+	Replicant<V>(name: string, opts?: ReplicantOptions<V>): Replicant<V, P>;
+	Replicant<V>(
+		name: string,
+		namespace?: string,
+		opts?: ReplicantOptions<V>
+	): Replicant<V, P>;
+}
+
+/**
+ * NodeCG constructor in extensions
+ */
+export interface NodeCGStaticServer extends NodeCGStaticCommon<'server'> {
+	readReplicant<V>(name: string, namespace?: string): void;
+}
+
+/**
+ * NodeCG constructor in browser
+ */
+export interface NodeCGStaticBrowser extends NodeCGStaticCommon<'browser'> {
+	readReplicant<V>(name: string, cb: (value: V) => void): void;
+	readReplicant<V>(
+		name: string,
+		namespace: string,
+		cb: (value: V) => void
+	): void;
+	waitForReplicants(...replicants: ReplicantBrowser<any>[]): Promise<void>;
+}
+
+/**
+ * NodeCG constructor combined
+ */
+export type NodeCGStatic<P extends Platform> = P extends 'server'
+	? NodeCGStaticServer
+	: NodeCGStaticBrowser;
+
+/**
+ * sendMessage returns Promise in browser, void in extensions
+ */
+type SendMessageReturnType<P extends Platform> = P extends 'server'
+	? void
+	: Promise<any>;
+
+/**
+ * Combined 'sendMessageToBundle' method for browser and extensions
+ */
+interface SendMessageToBundle<
+	P extends Platform,
+	M = SendMessageReturnType<P>
+> {
+	(
+		messageName: string,
+		bundleName: string,
+		cb?: (error: any, ...args: any[]) => void
+	): M;
+	(
+		messageName: string,
+		bundleName: string,
+		data: any,
+		cb?: (error: any, ...args: any[]) => void
+	): M;
+}

types/lib/platform.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Used to select types for browser API or extensions API
+ */
+export type Platform = 'server' | 'browser';