Migrate typings from nodecg-types to official v2 NodeCG types

Author: hlxid

Diff for: .scripts/create-service.py

@@ -47,7 +47,7 @@
     os.mkdir(f'services/nodecg-io-{service_name}/extension')
     with open(f'services/nodecg-io-{service_name}/extension/index.ts', mode='w') as file:
         file.writelines([
-            'import { NodeCG } from "nodecg-types/types/server";\n',
+            'import NodeCG from "@nodecg/types";\n',
             'import { Result, emptySuccess, success, ServiceBundle } from "nodecg-io-core";\n',
             f'import {{ {service_name_c}Client }} from "./{service_name_cc}Client";\n',
             '\n',
@@ -57,7 +57,7 @@
             '\n',
             f'export {{ {service_name_c}Client }} from "./{service_name_cc}Client";\n',
             '\n',
-            'module.exports = (nodecg: NodeCG) => {\n',
+            'module.exports = (nodecg: NodeCG.ServerAPI) => {\n',
             f'    new {service_name_c}Service(nodecg, "{service_name}", __dirname, "../schema.json").register();\n',
             '};\n',
             '\n',
@@ -135,11 +135,11 @@
     os.mkdir(f'samples/{sample_name}/extension')
     with open(f'samples/{sample_name}/extension/index.ts', mode='w') as file:
         file.writelines([
-            'import { NodeCG } from "nodecg-types/types/server";\n',
+            'import NodeCG from "@nodecg/types";\n',
             f'import {{ {service_name_c}Client }} from "nodecg-io-{service_name}";\n',
             'import { requireService } from "nodecg-io-core";\n',
             '\n',
-            'module.exports = function (nodecg: NodeCG) {\n',
+            'module.exports = function (nodecg: NodeCG.ServerAPI) {\n',
             f'    nodecg.log.info("Sample bundle for {service_name_c} started.");\n',
             '\n',
             f'    const {service_name_cc} = requireService<{service_name_c}Client>(nodecg, "{service_name}");\n',

Diff for: nodecg-io-core/dashboard/authentication.ts

@@ -1,5 +1,3 @@
-/// <reference types="nodecg-types/types/browser" />
-
 import { updateMonacoLayout } from "./serviceInstance";
 import { setPassword, isPasswordSet } from "./crypto";
 
@@ -41,7 +39,7 @@ document.addEventListener("DOMContentLoaded", () => {
 
 export async function isLoaded(): Promise<boolean> {
     return new Promise((resolve, _reject) => {
-        nodecg.sendMessage("isLoaded", (_err, res) => resolve(res));
+        nodecg.sendMessage("isLoaded", (_err, res: boolean) => resolve(res));
         setTimeout(() => resolve(false), 5000); // Fallback in case connection gets lost.
     });
 }

Diff for: nodecg-io-core/dashboard/main.ts

@@ -1,3 +1,11 @@
+// Define NodeCG instance on global scope
+import type { NodeCGAPIClient } from "@nodecg/types/client/api/api.client";
+
+declare global {
+    const NodeCG: typeof NodeCGAPIClient;
+    const nodecg: NodeCGAPIClient;
+}
+
 // Re-export functions that are used in panel.html to the global scope
 import { loadFramework } from "./authentication";
 import {

Diff for: nodecg-io-core/dashboard/package.json

@@ -21,7 +21,7 @@
     "devDependencies": {
         "esbuild": "^0.16.12",
         "monaco-editor": "^0.36.1",
-        "nodecg-types": "^1.9.0",
+        "@nodecg/types": "^2.1.3",
         "typescript": "^5.0.3"
     },
     "dependencies": {

Diff for: nodecg-io-core/extension/bundleManager.ts

@@ -1,4 +1,4 @@
-import { NodeCG } from "nodecg-types/types/server";
+import NodeCG from "@nodecg/types";
 import { ObjectMap, Service, ServiceDependency, ServiceInstance } from "./service";
 import { emptySuccess, error, Result } from "./utils/result";
 import { EventEmitter } from "events";
@@ -11,7 +11,7 @@ export class BundleManager extends EventEmitter {
     // Object that maps a bundle name to the array that contains all services that this bundle depends upon
     private readonly bundles: ObjectMap<ServiceDependency<unknown>[]> = {};
 
-    constructor(private readonly nodecg: NodeCG) {
+    constructor(private readonly nodecg: NodeCG.ServerAPI) {
         super();
     }
 

Diff for: nodecg-io-core/extension/index.ts

@@ -1,4 +1,4 @@
-import { NodeCG } from "nodecg-types/types/server";
+import NodeCG from "@nodecg/types";
 import { ServiceManager } from "./serviceManager";
 import { BundleManager } from "./bundleManager";
 import { MessageManager } from "./messageManager";
@@ -7,16 +7,28 @@ import { Service } from "./service";
 import { PersistenceManager } from "./persistenceManager";
 import { ServiceProvider } from "./serviceProvider";
 import { Logger } from "./utils/logger";
+
+/**
+ * Config schema for the core bundle.
+ * This is also defined in the configschema.json file.
+ */
+export interface NodeCGBundleConfig {
+    automaticLogin?: {
+        enabled?: boolean;
+        password?: string;
+    };
+}
+
 /**
  * Main type of NodeCG extension that the core bundle exposes.
  * Contains references to all internal modules.
  */
 export interface NodeCGIOCore {
     registerService<R, C>(service: Service<R, C>): void;
-    requireService<C>(nodecg: NodeCG, serviceType: string): ServiceProvider<C> | undefined;
+    requireService<C>(nodecg: NodeCG.ServerAPI, serviceType: string): ServiceProvider<C> | undefined;
 }
 
-module.exports = (nodecg: NodeCG): NodeCGIOCore => {
+module.exports = (nodecg: NodeCG.ServerAPI): NodeCGIOCore => {
     nodecg.log.info("Minzig!");
 
     const serviceManager = new ServiceManager(nodecg);
@@ -40,7 +52,7 @@ module.exports = (nodecg: NodeCG): NodeCGIOCore => {
         registerService<R, C>(service: Service<R, C>): void {
             serviceManager.registerService(service);
         },
-        requireService<C>(nodecg: NodeCG, serviceType: string): ServiceProvider<C> | undefined {
+        requireService<C>(nodecg: NodeCG.ServerAPI, serviceType: string): ServiceProvider<C> | undefined {
             const bundleName = nodecg.bundleName;
             const svc = serviceManager.getService(serviceType);
 
@@ -58,7 +70,7 @@ module.exports = (nodecg: NodeCG): NodeCGIOCore => {
 };
 
 function onExit(
-    nodecg: NodeCG,
+    nodecg: NodeCG.ServerAPI,
     bundleManager: BundleManager,
     instanceManager: InstanceManager,
     serviceManager: ServiceManager,
@@ -100,7 +112,7 @@ function onExit(
 }
 
 function registerExitHandlers(
-    nodecg: NodeCG,
+    nodecg: NodeCG.ServerAPI,
     bundleManager: BundleManager,
     instanceManager: InstanceManager,
     serviceManager: ServiceManager,

Diff for: nodecg-io-core/extension/instanceManager.ts

@@ -1,4 +1,4 @@
-import { NodeCG } from "nodecg-types/types/server";
+import NodeCG from "@nodecg/types";
 import { ObjectMap, Service, ServiceInstance } from "./service";
 import { emptySuccess, error, Result } from "./utils/result";
 import { ServiceManager } from "./serviceManager";
@@ -14,7 +14,7 @@ export class InstanceManager extends EventEmitter {
     private ajv = new Ajv();
 
     constructor(
-        private readonly nodecg: NodeCG,
+        private readonly nodecg: NodeCG.ServerAPI,
         private readonly services: ServiceManager,
         private readonly bundles: BundleManager,
     ) {

Diff for: nodecg-io-core/extension/messageManager.ts

@@ -1,4 +1,4 @@
-import { NodeCG } from "nodecg-types/types/server";
+import NodeCG from "@nodecg/types";
 import { emptySuccess, error, Result, success } from "./utils/result";
 import { InstanceManager } from "./instanceManager";
 import { BundleManager } from "./bundleManager";
@@ -35,7 +35,7 @@ export interface SetServiceDependencyMessage extends PasswordMessage {
  */
 export class MessageManager {
     constructor(
-        private nodecg: NodeCG,
+        private nodecg: NodeCG.ServerAPI,
         private services: ServiceManager,
         private instances: InstanceManager,
         private bundles: BundleManager,

Diff for: nodecg-io-core/extension/persistenceManager.ts

@@ -1,10 +1,11 @@
-import { NodeCG, ReplicantServer } from "nodecg-types/types/server";
+import NodeCG from "@nodecg/types";
 import { InstanceManager } from "./instanceManager";
 import { BundleManager } from "./bundleManager";
 import * as crypto from "crypto-js";
 import { emptySuccess, error, Result, success } from "./utils/result";
 import { ObjectMap, ServiceDependency, ServiceInstance } from "./service";
 import { ServiceManager } from "./serviceManager";
+import { NodeCGBundleConfig } from ".";
 
 /**
  * Models all the data that needs to be persistent in a plain manner.
@@ -55,10 +56,10 @@ export class PersistenceManager {
     private password: string | undefined;
     // We store the encrypted data in a replicant, because writing files in a NodeCG bundle isn't very clean
     // and the bundle config is read-only. It is only in encrypted form, so it is OK to be accessible in the browser.
-    private encryptedData: ReplicantServer<EncryptedData>;
+    private encryptedData: NodeCG.ServerReplicant<EncryptedData>;
 
     constructor(
-        private readonly nodecg: NodeCG,
+        private readonly nodecg: NodeCG.ServerAPI<NodeCGBundleConfig>,
         private readonly services: ServiceManager,
         private readonly instances: InstanceManager,
         private readonly bundles: BundleManager,
@@ -94,7 +95,7 @@ export class PersistenceManager {
      * If this returns true {{@link load}} will accept any password and use it to encrypt the configuration.
      */
     isFirstStartup(): boolean {
-        return this.encryptedData.value.cipherText === undefined;
+        return this.encryptedData.value?.cipherText === undefined;
     }
 
     /**
@@ -107,7 +108,7 @@ export class PersistenceManager {
             return error("Config has already been decrypted and loaded.");
         }
 
-        if (this.encryptedData.value.cipherText === undefined) {
+        if (this.encryptedData.value?.cipherText === undefined) {
             // No encrypted data has been saved, probably because this is the first startup.
             // Therefore nothing needs to be decrypted, and we write an empty config to disk.
             this.nodecg.log.info("No saved configuration found, creating a empty one.");
@@ -216,6 +217,10 @@ export class PersistenceManager {
 
         // Encrypt and save data to persistent replicant.
         const cipherText = crypto.AES.encrypt(JSON.stringify(data), this.password);
+
+        if (this.encryptedData.value === undefined) {
+            this.encryptedData.value = {};
+        }
         this.encryptedData.value.cipherText = cipherText.toString();
     }
 
@@ -263,7 +268,7 @@ export class PersistenceManager {
 
         // If enabled isn't undefined the JSON schema guarantees that enabled is a boolean and password is a string
         const enabled: boolean = this.nodecg.bundleConfig.automaticLogin.enabled;
-        const password: string = this.nodecg.bundleConfig.automaticLogin.password;
+        const password: string | undefined = this.nodecg.bundleConfig.automaticLogin.password;
 
         if (enabled === false) {
             // We inform the user that automatic login is set up but not activated because having the ability
@@ -274,6 +279,11 @@ export class PersistenceManager {
             return;
         }
 
+        if (password === undefined) {
+            this.nodecg.log.error("Automatic login is setup but no password is provided.");
+            return;
+        }
+
         this.setupAutomaticLogin(password);
     }
 
@@ -289,7 +299,7 @@ export class PersistenceManager {
         // So if we want to wait for NodeCG to be loaded we can watch for changes on this replicant and
         // if we get a non-empty array it means that NodeCG has finished loading.
         this.nodecg.Replicant<unknown[]>("bundles", "nodecg").on("change", async (bundles) => {
-            if (bundles.length > 0) {
+            if (bundles && bundles.length > 0) {
                 try {
                     this.nodecg.log.info("Attempting to automatically login...");
                     const loadResult = await this.load(password);
@@ -300,15 +310,15 @@ export class PersistenceManager {
                         throw loadResult.errorMessage;
                     }
                 } catch (err) {
-                    const logMesssage = `Failed to automatically login: ${err}`;
+                    const logMessage = `Failed to automatically login: ${err}`;
                     if (this.isLoaded()) {
                         // load() threw an error but nodecg-io is currently loaded nonetheless.
                         // Anyway, nodecg-io is loaded which is what we wanted
-                        this.nodecg.log.warn(logMesssage);
+                        this.nodecg.log.warn(logMessage);
                     } else {
                         // Something went wrong and nodecg-io is not loaded.
                         // This is a real error, the password might be wrong or some other issue.
-                        this.nodecg.log.error(logMesssage);
+                        this.nodecg.log.error(logMessage);
                     }
                 }
             }

Diff for: nodecg-io-core/extension/serviceBundle.ts

@@ -1,5 +1,5 @@
 import { NodeCGIOCore } from ".";
-import { NodeCG } from "nodecg-types/types/server";
+import NodeCG from "@nodecg/types";
 import { ObjectMap, Service } from "./service";
 import { Result } from "./utils/result";
 
@@ -17,7 +17,7 @@ import { Logger } from "./utils/logger";
  */
 export abstract class ServiceBundle<R, C> implements Service<R, C> {
     public core: NodeCGIOCore | undefined;
-    public nodecg: NodeCG;
+    public nodecg: NodeCG.ServerAPI;
     public serviceType: string;
     public schema?: ObjectMap<unknown>;
 
@@ -39,7 +39,7 @@ export abstract class ServiceBundle<R, C> implements Service<R, C> {
      * @param serviceName the name of the service in all-lowercase-and-with-hyphen
      * @param pathSegments the path to the schema.json most likely __dirname, "../serviceName-schema.json"
      */
-    constructor(nodecg: NodeCG, serviceName: string, ...pathSegments: string[]) {
+    constructor(nodecg: NodeCG.ServerAPI, serviceName: string, ...pathSegments: string[]) {
         this.nodecg = nodecg;
         this.serviceType = serviceName;
         this.schema = this.readSchema(pathSegments);

Diff for: nodecg-io-core/extension/serviceManager.ts

@@ -1,5 +1,5 @@
 import { Service } from "./service";
-import { NodeCG } from "nodecg-types/types/server";
+import NodeCG from "@nodecg/types";
 import { error, Result, success } from "./utils/result";
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
@@ -10,7 +10,7 @@ import { error, Result, success } from "./utils/result";
 export class ServiceManager {
     private services: Service<unknown, any>[] = [];
 
-    constructor(private readonly nodecg: NodeCG) {}
+    constructor(private readonly nodecg: NodeCG.ServerAPI) {}
 
     /**
      * Registers the passed service which show it in the GUI and allows it to be instanced using {@link createServiceInstance}.

Diff for: nodecg-io-core/extension/serviceProvider.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from "events";
 import { NodeCGIOCore } from "./index";
-import { NodeCG } from "nodecg-types/types/server";
+import NodeCG from "@nodecg/types";
 
 /**
  * A wrapper around a ServiceClient that has helper functions for setting up callbacks and
@@ -60,12 +60,12 @@ export class ServiceProvider<C> {
 
 /**
  * Allows for bundles to require services.
- * @param {NodeCG} nodecg the NodeCG instance of your bundle. Is used to get the bundle name of the calling bundle.
+ * @param {NodeCG.ServerAPI} nodecg the NodeCG instance of your bundle. Is used to get the bundle name of the calling bundle.
  * @param {string} serviceType the type of service you want to require, e.g., "twitch" or "spotify".
  * @return {ServiceClientWrapper<C> | undefined} a service client wrapper for access to the service client
  *                                               or undefined if the core wasn't loaded or the service type doesn't exist.
  */
-export function requireService<C>(nodecg: NodeCG, serviceType: string): ServiceProvider<C> | undefined {
+export function requireService<C>(nodecg: NodeCG.ServerAPI, serviceType: string): ServiceProvider<C> | undefined {
     const core = nodecg.extensions["nodecg-io-core"] as unknown as NodeCGIOCore | undefined;
     if (core === undefined) {
         nodecg.log.error(

Diff for: nodecg-io-core/extension/utils/logger/index.ts

@@ -1,8 +1,8 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import { NodeCG } from "nodecg-types/types/server";
+import NodeCG from "@nodecg/types";
 
 export class Logger {
-    constructor(private name: string, private nodecg: NodeCG) {}
+    constructor(private name: string, private nodecg: NodeCG.ServerAPI) {}
     trace(...args: any[]): void {
         this.nodecg.log.trace(`[${this.name}] ${args[0]}`, ...args.slice(1));
     }

Diff for: nodecg-io-core/package.json

@@ -48,7 +48,7 @@
         "@types/jest": "^28.1.7",
         "@types/node": "^18.15.11",
         "jest": "^28.1.3",
-        "nodecg-types": "^1.9.0",
+        "@nodecg/types": "^2.1.3",
         "typescript": "^5.0.3",
         "ts-jest": "^28.0.8"
     },