feat: template overriding

Author: MikeRomaa

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@synaptic-simulations/mach",
-    "version": "1.3.0-rc1",
+    "version": "1.3.0-rc2",
     "description": "The last MSFS instrument bundler you'll ever need.",
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",

package.json

@@ -157,13 +157,23 @@ export const writePackageSources = (args: MachArgs, instrument: Instrument): Plu
                 if (instrument.simulatorPackage.type === "react") {
                     await fs.writeFile(
                         instrumentPath,
-                        await renderFile(path.join(__dirname, "./templates/instrument.cjs"), templateParams),
+                        await renderFile(
+                            instrument.simulatorPackage.jsTemplate
+                                ? path.resolve(instrument.simulatorPackage.jsTemplate)
+                                : path.join(__dirname, "./templates/instrument.cjs"),
+                            templateParams,
+                        ),
                     );
                 }
 
                 await fs.writeFile(
                     path.join(packageTarget, `${fileName}.html`),
-                    await renderFile(path.join(__dirname, "./templates/index.html"), templateParams),
+                    await renderFile(
+                        instrument.simulatorPackage.htmlTemplate
+                            ? path.resolve(instrument.simulatorPackage.htmlTemplate)
+                            : path.join(__dirname, "./templates/index.html"),
+                        templateParams,
+                    ),
                 );
             }
         });

src/plugins.ts

@@ -3,17 +3,6 @@
 /* global registerInstrument */
 
 class _MachInstrument_{{ templateId }} extends BaseInstrument {
-    constructor() {
-        super();
-        let lastTime = this._lastTime;
-        this.getDeltaTime = () => {
-            const nowTime = Date.now();
-            const deltaTime = nowTime - lastTime;
-            lastTime = nowTime;
-            return deltaTime;
-        };
-    }
-
     get templateID() {
         return '{{ templateId }}';
     }
@@ -33,13 +22,11 @@ class _MachInstrument_{{ templateId }} extends BaseInstrument {
 
     Update() {
         super.Update();
-        this.dispatchEvent(new CustomEvent("update", { detail: this.getDeltaTime() }));
+        document.dispatchEvent(new CustomEvent("update"));
     }
 
     onInteractionEvent(event) {
-        const eventName = String(event);
-        this.dispatchEvent(new CustomEvent(eventName));
-        this.dispatchEvent(new CustomEvent("*", { detail: eventName }));
+        document.dispatchEvent(new CustomEvent(event));
     }
 }
 

src/templates/instrument.cjs

@@ -19,6 +19,8 @@ interface PackageSettings {
     fileName?: string;
     /** Simulator packages to import in the HTML template. */
     imports?: string[];
+    /** Paths to custom HTML template files */
+    htmlTemplate?: string;
 }
 
 interface ReactInstrumentPackageSettings extends PackageSettings {
@@ -27,6 +29,8 @@ interface ReactInstrumentPackageSettings extends PackageSettings {
     templateId?: string;
     /** Whether the instrument is interactive or not. Defaults to `true`. */
     isInteractive?: boolean;
+    /** Paths to custom JavaScript template files */
+    jsTemplate?: string;
 }
 
 interface BaseInstrumentPackageSettings extends PackageSettings {
@@ -115,6 +119,7 @@ export const InstrumentSchema: z.ZodType<Instrument> = z.lazy(() =>
                     imports: z.array(z.string()).optional(),
                     templateId: z.string().optional(),
                     isInteractive: z.boolean().optional(),
+                    htmlTemplate: z.string().optional(),
                 }),
                 z.object({
                     type: z.literal("baseInstrument"),
@@ -123,6 +128,8 @@ export const InstrumentSchema: z.ZodType<Instrument> = z.lazy(() =>
                     imports: z.array(z.string()).optional(),
                     templateId: z.string(),
                     mountElementId: z.string(),
+                    htmlTemplate: z.string().optional(),
+                    jsTemplate: z.string().optional(),
                 }),
             ])
             .optional(),