@steambrew/ttc 2.4.3 → 2.6.3

package/package.json

@@ -1,53 +1,53 @@
-{
-	"name": "@steambrew/ttc",
-	"version": "2.4.3",
-	"type": "module",
-	"main": "dist/index.js",
-	"module": "dist/index.js",
-	"bin": {
-		"millennium-ttc": "dist/index.js"
-	},
-	"scripts": {
-		"build": "rollup -c",
-		"prepare": "npm run build"
-	},
-	"publishConfig": {
-		"access": "public"
-	},
-	"keywords": [],
-	"author": "",
-	"license": "ISC",
-	"description": "A tiny typescript compiler for Millennium plugins.",
-	"dependencies": {
-		"@babel/parser": "^7.27.0",
-		"@babel/preset-env": "^7.26.0",
-		"@babel/preset-react": "^7.25.9",
-		"@babel/preset-typescript": "^7.27.0",
-		"@babel/traverse": "^7.27.0",
-		"@rollup/plugin-babel": "^6.0.4",
-		"@rollup/plugin-commonjs": "^28.0.1",
-		"@rollup/plugin-json": "^6.1.0",
-		"@rollup/plugin-node-resolve": "^15.3.0",
-		"@rollup/plugin-replace": "^6.0.1",
-		"@rollup/plugin-terser": "^0.4.4",
-		"@rollup/plugin-typescript": "^12.1.1",
-		"@rollup/plugin-url": "^8.0.2",
-		"@rollup/pluginutils": "^5.1.4",
-		"chalk": "^5.3.0",
-		"dotenv": "^16.4.7",
-		"fs": "^0.0.1-security",
-		"glob": "^11.0.2",
-		"magic-string": "^0.30.17",
-		"rollup": "^4.40.0",
-		"rollup-plugin-inject-process-env": "^1.3.1",
-		"rollup-plugin-polyfill-node": "^0.13.0",
-		"rollup-plugin-scss": "^4.0.1",
-		"sass": "^1.87.0",
-		"tslib": "^2.8.1"
-	},
-	"devDependencies": {
-		"@types/babel__traverse": "^7.20.7",
-		"@types/glob": "^8.1.0",
-		"@types/node": "^22.15.2"
-	}
-}
+{
+	"name": "@steambrew/ttc",
+	"version": "2.6.3",
+	"type": "module",
+	"main": "dist/index.js",
+	"module": "dist/index.js",
+	"bin": {
+		"millennium-ttc": "dist/index.js"
+	},
+	"scripts": {
+		"build": "rollup -c",
+		"prepare": "npm run build"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"keywords": [],
+	"author": "SteamClientHomebrew",
+	"license": "MIT",
+	"description": "A tiny typescript compiler for Millennium plugins.",
+	"dependencies": {
+		"@babel/parser": "^7.27.5",
+		"@babel/preset-env": "^7.27.2",
+		"@babel/preset-react": "^7.27.1",
+		"@babel/preset-typescript": "^7.27.1",
+		"@babel/traverse": "^7.27.4",
+		"@rollup/plugin-babel": "^6.0.4",
+		"@rollup/plugin-commonjs": "^28.0.3",
+		"@rollup/plugin-json": "^6.1.0",
+		"@rollup/plugin-node-resolve": "^15.3.1",
+		"@rollup/plugin-replace": "^6.0.2",
+		"@rollup/plugin-terser": "^0.4.4",
+		"@rollup/plugin-typescript": "^12.1.2",
+		"@rollup/plugin-url": "^8.0.2",
+		"@rollup/pluginutils": "^5.1.4",
+		"chalk": "^5.4.1",
+		"dotenv": "^16.5.0",
+		"fs": "0.0.1-security",
+		"glob": "^11.0.2",
+		"magic-string": "^0.30.17",
+		"rollup": "^4.42.0",
+		"rollup-plugin-inject-process-env": "^1.3.1",
+		"rollup-plugin-polyfill-node": "^0.13.0",
+		"rollup-plugin-scss": "^4.0.1",
+		"sass": "^1.89.1",
+		"tslib": "^2.8.1"
+	},
+	"devDependencies": {
+		"@types/babel__traverse": "^7.20.7",
+		"@types/glob": "^8.1.0",
+		"@types/node": "^22.15.30"
+	}
+}

package/rollup.config.js

@@ -2,35 +2,21 @@ import commonjs from '@rollup/plugin-commonjs';
 import typescript from '@rollup/plugin-typescript';
 import json from '@rollup/plugin-json';
 import nodeResolve from '@rollup/plugin-node-resolve';
+import { readFileSync } from 'fs';
+
+const pkg = JSON.parse(readFileSync(new URL('./package.json', import.meta.url), 'utf8'));
 
 export default {
-	input: 'index.ts',
+	input: 'src/index.ts',
 	context: 'window',
 	output: {
 		file: 'dist/index.js',
 	},
 	plugins: [commonjs(), typescript(), json(), nodeResolve()],
 	external: [
-		'chalk',
-		'path',
-		'url',
-		'fs/promises',
-		'fs',
-		'rollup',
-		'@rollup/plugin-json',
-		'@rollup/plugin-commonjs',
-		'@rollup/plugin-replace',
-		'@rollup/plugin-typescript',
-		'@rollup/plugin-node-resolve',
-		'rollup-plugin-import-css',
-		'@rollup/plugin-terser',
-		'@rollup/plugin-babel',
-		'rollup-plugin-inject-process-env',
-		'dotenv',
-		'perf_hooks',
-		'@rollup/pluginutils',
-		'magic-string',
-		'rollup-plugin-scss',
-		'sass',
+		...Object.keys(pkg.dependencies || {}),
+		...Object.keys(pkg.peerDependencies || {}),
+		...Object.keys(pkg.optionalDependencies || {}),
+		...Object.keys(pkg.devDependencies || {}),
 	],
 };

package/src/check-health.ts

@@ -0,0 +1,41 @@
+import chalk from 'chalk';
+import path from 'path';
+import { existsSync, readFile } from 'fs';
+
+export const ValidatePlugin = (target: string): Promise<any> => {
+	return new Promise<any>((resolve, reject) => {
+		if (!existsSync(target)) {
+			console.error(chalk.red.bold(`\n[-] --target [${target}] `) + chalk.red('is not a valid system path'));
+			reject();
+			return;
+		}
+
+		const pluginModule = path.join(target, 'plugin.json');
+
+		if (!existsSync(pluginModule)) {
+			console.error(chalk.red.bold(`\n[-] --target [${target}] `) + chalk.red('is not a valid plugin (missing plugin.json)'));
+			reject();
+			return;
+		}
+
+		readFile(pluginModule, 'utf8', (err, data) => {
+			if (err) {
+				console.error(chalk.red.bold(`\n[-] couldn't read plugin.json from [${pluginModule}]`));
+				reject();
+				return;
+			}
+
+			try {
+				if (!('name' in JSON.parse(data))) {
+					console.error(chalk.red.bold(`\n[-] target plugin doesn't contain "name" in plugin.json [${pluginModule}]`));
+					reject();
+				} else {
+					resolve(JSON.parse(data));
+				}
+			} catch (parseError) {
+				console.error(chalk.red.bold(`\n[-] couldn't parse JSON in plugin.json from [${pluginModule}]`));
+				reject();
+			}
+		});
+	});
+};

package/{index.ts → src/index.ts}

@@ -5,10 +5,10 @@
  * - typescript transpiler
  * - rollup configurator
  */
-import { BuildType, ValidateParameters } from './Parameters';
-import { CheckForUpdates } from './VersionMon';
-import { ValidatePlugin } from './Linter';
-import { TranspilerPluginComponent, TranspilerProps } from './Compiler';
+import { BuildType, ValidateParameters } from './query-parser';
+import { CheckForUpdates } from './version-control';
+import { ValidatePlugin } from './check-health';
+import { TranspilerPluginComponent, TranspilerProps } from './transpiler';
 import { performance } from 'perf_hooks';
 import chalk from 'chalk';
 // import { Logger } from './Logger'

package/{PluginSetup.ts → src/plugin-api.ts}

@@ -10,6 +10,11 @@ declare global {
 		 * It is used to store the plugin settings and the plugin settings parser.
 		 */
 		MILLENNIUM_PLUGIN_SETTINGS_STORE: any;
+		/**
+		 * @description Used to store the settings for the plugin.
+		 * Millennium then renders these in the settings panel.
+		 */
+		MILLENNIUM_SIDEBAR_NAVIGATION_PANELS: any;
 	}
 }
 
@@ -96,7 +101,20 @@ function ExecutePluginModule() {
 		});
 
 		/** Run the rolled up plugins default exported function */
-		PluginModule.default();
+		let pluginProps = PluginModule.default();
+
+		function isValidSidebarNavComponent(obj: any) {
+			return obj && obj.title !== undefined && obj.icon !== undefined && obj.content !== undefined;
+		}
+
+		if (pluginProps && isValidSidebarNavComponent(pluginProps)) {
+			window.MILLENNIUM_SIDEBAR_NAVIGATION_PANELS[pluginName] = pluginProps;
+		} else {
+			console.warn(
+				`Plugin ${pluginName} does not contain proper SidebarNavigation props and therefor can't be mounted by Millennium. Please ensure it has a title, icon, and content.`,
+			);
+			return;
+		}
 
 		/** If the current module is a client module, post message id=1 which calls the front_end_loaded method on the backend. */
 		if (MILLENNIUM_IS_CLIENT_MODULE) {
@@ -116,6 +134,7 @@ function InitializePlugins() {
 	 */
 	(window.PLUGIN_LIST ||= {})[pluginName] ||= {};
 	(window.MILLENNIUM_PLUGIN_SETTINGS_STORE ||= {})[pluginName] ||= {};
+	window.MILLENNIUM_SIDEBAR_NAVIGATION_PANELS ||= {};
 
 	/**
 	 * Accepted IPC message types from Millennium backend.
@@ -154,7 +173,7 @@ function InitializePlugins() {
 			await new Promise((resolve) => setTimeout(resolve, 0));
 		}
 
-		MainWindowBrowserManager.m_browser.on('message', (messageId: string, data: string) => {
+		MainWindowBrowserManager?.m_browser?.on('message', (messageId: string, data: string) => {
 			if (messageId !== IPCMessageId) {
 				return;
 			}
@@ -170,7 +189,7 @@ function InitializePlugins() {
 	}
 
 	function WebkitInitializeIPC() {
-		SteamClient.BrowserView.RegisterForMessageFromParent((messageId: string, data: string) => {
+		SteamClient?.BrowserView?.RegisterForMessageFromParent((messageId: string, data: string) => {
 			if (messageId !== IPCMessageId) {
 				return;
 			}

package/src/query-parser.ts

@@ -0,0 +1,82 @@
+import chalk from 'chalk';
+import { Logger } from './logger';
+
+/***
+ * @brief print the parameter list to the stdout
+ */
+export const PrintParamHelp = () => {
+	console.log(
+		'millennium-ttc parameter list:' +
+			'\n\t' +
+			chalk.magenta('--help') +
+			': display parameter list' +
+			'\n\t' +
+			chalk.bold.red('--build') +
+			': ' +
+			chalk.bold.red('(required)') +
+			': build type [dev, prod] (prod minifies code)' +
+			'\n\t' +
+			chalk.magenta('--target') +
+			': path to plugin, default to cwd',
+	);
+};
+
+export enum BuildType {
+	DevBuild,
+	ProdBuild,
+}
+
+export interface ParameterProps {
+	type: BuildType;
+	targetPlugin: string; // path
+}
+
+export const ValidateParameters = (args: Array<string>): ParameterProps => {
+	let typeProp: BuildType = BuildType.DevBuild,
+		targetProp: string = process.cwd();
+
+	if (args.includes('--help')) {
+		PrintParamHelp();
+		process.exit();
+	}
+
+	// startup args are invalid
+	if (!args.includes('--build')) {
+		Logger.Error('Received invalid arguments...');
+		PrintParamHelp();
+		process.exit();
+	}
+
+	for (let i = 0; i < args.length; i++) {
+		if (args[i] === '--build') {
+			const BuildMode: string = args[i + 1];
+
+			switch (BuildMode) {
+				case 'dev':
+					typeProp = BuildType.DevBuild;
+					break;
+				case 'prod':
+					typeProp = BuildType.ProdBuild;
+					break;
+				default: {
+					Logger.Error('--build parameter must be preceded by build type [dev, prod]');
+					process.exit();
+				}
+			}
+		}
+
+		if (args[i] == '--target') {
+			if (args[i + 1] === undefined) {
+				Logger.Error('--target parameter must be preceded by system path');
+				process.exit();
+			}
+
+			targetProp = args[i + 1];
+		}
+	}
+
+	return {
+		type: typeProp,
+		targetPlugin: targetProp,
+	};
+};

package/{Compiler.ts → src/transpiler.ts}

@@ -13,13 +13,13 @@ import scss from 'rollup-plugin-scss';
 import * as sass from 'sass';
 
 import chalk from 'chalk';
-import { Logger } from './Logger';
+import { Logger } from './logger';
 import fs from 'fs';
 
 import injectProcessEnv from 'rollup-plugin-inject-process-env';
 import dotenv from 'dotenv';
-import { ExecutePluginModule, InitializePlugins } from './PluginSetup';
-import constSysfsExpr from './StaticEmbed';
+import { ExecutePluginModule, InitializePlugins } from './plugin-api';
+import constSysfsExpr from './static-embed';
 
 const envConfig = dotenv.config().parsed || {};
 

package/{VersionMon.ts → src/version-control.ts}

@@ -2,7 +2,7 @@ import path from 'path';
 import { fileURLToPath } from 'url';
 import { readFile } from 'fs/promises';
 import { dirname } from 'path';
-import { Logger } from './Logger';
+import { Logger } from './logger';
 
 export const CheckForUpdates = async (): Promise<boolean> => {
 	return new Promise<boolean>(async (resolve) => {

package/tsconfig.json

@@ -1,24 +1,23 @@
 {
-    "compilerOptions": {
-      "outDir": "dist",
-      "module": "ESNext",
-      "target": "ES2020",
-      "jsx": "react",
-      "jsxFactory": "window.SP_REACT.createElement",
-      "declaration": false,
-      "moduleResolution": "node",
-      "noUnusedLocals": true,
-      "noUnusedParameters": true,
-      "esModuleInterop": true,
-      "noImplicitReturns": true,
-      "noImplicitThis": true,
-      "noImplicitAny": true,
-      "strict": true,
-      "ignoreDeprecations": "5.0",
-      "allowSyntheticDefaultImports": true,
-      "skipLibCheck": true
-    },
-    "include": ["./"],
-    "exclude": ["node_modules"]
+	"compilerOptions": {
+		"outDir": "dist",
+		"module": "ESNext",
+		"target": "ES2020",
+		"jsx": "react",
+		"jsxFactory": "window.SP_REACT.createElement",
+		"declaration": false,
+		"moduleResolution": "node",
+		"noUnusedLocals": true,
+		"noUnusedParameters": true,
+		"esModuleInterop": true,
+		"noImplicitReturns": true,
+		"noImplicitThis": true,
+		"noImplicitAny": true,
+		"strict": true,
+		"ignoreDeprecations": "5.0",
+		"allowSyntheticDefaultImports": true,
+		"skipLibCheck": true
+	},
+	"include": ["./src/**/*"],
+	"exclude": ["node_modules"]
 }
-  

package/Linter.ts

@@ -1,44 +0,0 @@
-import chalk from 'chalk'
-import path from 'path'
-import { existsSync, readFile } from 'fs'
-
-export const ValidatePlugin = (target: string): Promise<any> => {
-
-    return new Promise<any>((resolve, reject) => {
-        if (!existsSync(target)) {
-            console.error(chalk.red.bold(`\n[-] --target [${target}] `) + chalk.red("is not a valid system path"))
-            reject() 
-            return
-        }
-        
-        const pluginModule = path.join(target, "plugin.json")
-        
-        if (!existsSync(pluginModule)) {
-            console.error(chalk.red.bold(`\n[-] --target [${target}] `) + chalk.red("is not a valid plugin (missing plugin.json)"))
-            reject()
-            return
-        }
-        
-        readFile(pluginModule, 'utf8', (err, data) => {
-            if (err) {
-                console.error(chalk.red.bold(`\n[-] couldn't read plugin.json from [${pluginModule}]`))
-                reject()
-                return
-            }
-        
-            try {
-                if (!("name" in JSON.parse(data))) {
-                    console.error(chalk.red.bold(`\n[-] target plugin doesn't contain "name" in plugin.json [${pluginModule}]`))
-                    reject()
-                }
-                else {
-                    resolve(JSON.parse(data)) 
-                }
-            } 
-            catch (parseError) {
-                console.error(chalk.red.bold(`\n[-] couldn't parse JSON in plugin.json from [${pluginModule}]`))
-                reject()
-            }
-        });
-    })
-}

package/Parameters.ts

@@ -1,72 +0,0 @@
-import chalk from 'chalk'
-import { Logger } from "./Logger"
-
-/***
- * @brief print the parameter list to the stdout
- */
-export const PrintParamHelp = () => {
-
-    console.log(
-        "millennium-ttc parameter list:" +
-        "\n\t" + chalk.magenta("--help") + ": display parameter list" +
-        "\n\t" + chalk.bold.red("--build") + ": " + chalk.bold.red("(required)") + ": build type [dev, prod] (prod minifies code)" +
-        "\n\t" + chalk.magenta("--target") + ": path to plugin, default to cwd"
-    );
-}
-
-export enum BuildType {
-    DevBuild, ProdBuild
-}
-
-export interface ParameterProps {
-    type: BuildType, 
-    targetPlugin: string // path
-}
-
-export const ValidateParameters = (args: Array<string>): ParameterProps => {
-
-    let typeProp: BuildType = BuildType.DevBuild, targetProp: string = process.cwd()
-
-    if (args.includes("--help")) {
-        PrintParamHelp()
-        process.exit();
-    }
-    
-    // startup args are invalid
-    if (!args.includes("--build")) {
-        Logger.Error("Received invalid arguments...");
-        PrintParamHelp();
-        process.exit();
-    }
-    
-    for (let i = 0; i < args.length; i++) 
-    {
-        if (args[i] === "--build") 
-        {
-            const BuildMode: string = args[i + 1]
-
-            switch (BuildMode) {
-                case "dev": typeProp = BuildType.DevBuild; break
-                case "prod": typeProp = BuildType.ProdBuild; break
-                default: {
-                    Logger.Error('--build parameter must be preceded by build type [dev, prod]');
-                    process.exit();
-                }
-            }
-        }
-    
-        if (args[i] == "--target") {
-            if (args[i + 1] === undefined) {
-                Logger.Error('--target parameter must be preceded by system path');
-                process.exit();
-            }
-
-            targetProp = args[i + 1]
-        }
-    }
-
-    return {
-        type: typeProp,
-        targetPlugin: targetProp
-    }
-}