Smaller improvements to ServiceBundle

Author: hlxid

nodecg-io-core/extension/index.ts

@@ -5,16 +5,13 @@ import { MessageManager } from "./messageManager";
 import { InstanceManager } from "./instanceManager";
 import { Service, ServiceProvider } from "./types";
 import { PersistenceManager } from "./persistenceManager";
-import * as fs from "fs";
-import * as path from "path";
 
 /**
  * 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>): ServiceProvider<C>;
-    readSchema(...path: string[]): Record<string, unknown> | undefined;
 }
 
 module.exports = (nodecg: NodeCG): NodeCGIOCore => {
@@ -34,15 +31,5 @@ module.exports = (nodecg: NodeCG): NodeCGIOCore => {
             serviceManager.registerService(service);
             return bundleManager.createServiceProvider(service);
         },
-        readSchema(...pathSegments: string[]) {
-            const joinedPath = path.resolve(...pathSegments);
-            try {
-                const fileContent = fs.readFileSync(joinedPath, "utf8");
-                return JSON.parse(fileContent);
-            } catch (err) {
-                nodecg.log.error("Couldn't read and parse service schema at " + joinedPath.toString());
-                return undefined;
-            }
-        },
     };
 };

nodecg-io-core/extension/serviceBundle.ts

@@ -18,7 +18,12 @@ export abstract class ServiceBundle<R, C> implements Service<R, C> {
     public core: NodeCGIOCore | undefined;
     public nodecg: NodeCG;
     public serviceType: string;
-    public schema: any;
+    public schema: unknown;
+
+    /**
+     * The default value for the config.
+     */
+    public defaultConfig?: R;
 
     /**
      * This constructor creates the service and gets the nodecg-io-core
@@ -31,7 +36,7 @@ export abstract class ServiceBundle<R, C> implements Service<R, C> {
         this.serviceType = serviceName;
         this.schema = this.readSchema(pathSegments);
 
-        this.nodecg.log.info(this.serviceType + " bundle started");
+        this.nodecg.log.info(this.serviceType + " bundle started.");
         this.core = (this.nodecg.extensions["nodecg-io-core"] as unknown) as NodeCGIOCore | undefined;
         if (this.core === undefined) {
             this.nodecg.log.error(
@@ -40,16 +45,16 @@ export abstract class ServiceBundle<R, C> implements Service<R, C> {
         }
     }
 
+    /**
+     * Registers this service bundle at the core bundle, makes it appear in the GUI and makes it usable.
+     * @return a service provider for this service, can be used by bundles to depend on this service.
+     */
     public register(): ServiceProvider<C> | undefined {
-        if (this.core === undefined) {
-            return undefined;
-        } else {
-            // Hide nodecg variable from serialization.
-            // The service is saved in a Replicant and nodecg tries to serialize everything in there, including
-            // nodecg instances, which throw errors when serialized.
-            Object.defineProperty(this, "nodecg", { enumerable: false });
-            return this.core.registerService(this);
-        }
+        // Hide nodecg variable from serialization.
+        // The service is saved in a Replicant and nodecg tries to serialize everything in there, including
+        // nodecg instances, which throw errors when serialized.
+        Object.defineProperty(this, "nodecg", { enumerable: false });
+        return this.core?.registerService(this);
     }
 
     /**
@@ -77,7 +82,7 @@ export abstract class ServiceBundle<R, C> implements Service<R, C> {
      */
     abstract stopClient(client: C): void;
 
-    private readSchema(pathSegments: string[]) {
+    private readSchema(pathSegments: string[]): unknown {
         const joinedPath = path.resolve(...pathSegments);
         try {
             const fileContent = fs.readFileSync(joinedPath, "utf8");