@steambrew/ttc 2.5.3 → 2.7.3

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@steambrew/ttc",
-	"version": "2.5.3",
+	"version": "2.7.3",
 	"type": "module",
 	"main": "dist/index.js",
 	"module": "dist/index.js",
@@ -15,39 +15,40 @@
 		"access": "public"
 	},
 	"keywords": [],
-	"author": "",
-	"license": "ISC",
+	"author": "SteamClientHomebrew",
+	"license": "MIT",
 	"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",
+		"@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.1",
+		"@rollup/plugin-commonjs": "^28.0.3",
 		"@rollup/plugin-json": "^6.1.0",
-		"@rollup/plugin-node-resolve": "^15.3.0",
-		"@rollup/plugin-replace": "^6.0.1",
+		"@rollup/plugin-node-resolve": "^15.3.1",
+		"@rollup/plugin-replace": "^6.0.2",
 		"@rollup/plugin-terser": "^0.4.4",
-		"@rollup/plugin-typescript": "^12.1.1",
+		"@rollup/plugin-typescript": "^12.1.2",
 		"@rollup/plugin-url": "^8.0.2",
 		"@rollup/pluginutils": "^5.1.4",
-		"chalk": "^5.3.0",
-		"dotenv": "^16.4.7",
-		"fs": "^0.0.1-security",
+		"chalk": "^5.4.1",
+		"dotenv": "^16.5.0",
+		"fs": "0.0.1-security",
 		"glob": "^11.0.2",
 		"magic-string": "^0.30.17",
-		"rollup": "^4.40.0",
+		"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.87.0",
+		"sass": "^1.89.1",
+		"terser": "^5.43.1",
 		"tslib": "^2.8.1"
 	},
 	"devDependencies": {
 		"@types/babel__traverse": "^7.20.7",
 		"@types/glob": "^8.1.0",
-		"@types/node": "^22.15.2"
+		"@types/node": "^22.15.30"
 	}
 }

package/rollup.config.js

@@ -2,6 +2,9 @@ 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: 'src/index.ts',
@@ -11,26 +14,9 @@ export default {
 	},
 	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/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;
 	}
 }
 
@@ -69,7 +74,7 @@ function ExecutePluginModule() {
 	/** Expose the OnPluginConfigChange so it can be called externally */
 	MillenniumStore.OnPluginConfigChange = OnPluginConfigChange;
 
-	MILLENNIUM_BACKEND_IPC.postMessage(0, { pluginName: pluginName, methodName: '__builtins__.__millennium_plugin_settings_parser__' }).then((response: any) => {
+	MILLENNIUM_BACKEND_IPC.postMessage(0, { pluginName: pluginName, methodName: '__builtins__.__millennium_plugin_settings_parser__' }).then(async (response: any) => {
 		/**
 		 * __millennium_plugin_settings_parser__ will return false if the plugin has no settings.
 		 * If the plugin has settings, it will return a base64 encoded string.
@@ -96,7 +101,20 @@ function ExecutePluginModule() {
 		});
 
 		/** Run the rolled up plugins default exported function */
-		PluginModule.default();
+		let pluginProps = await 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;
 			}
@@ -169,17 +188,38 @@ function InitializePlugins() {
 		});
 	}
 
-	function WebkitInitializeIPC() {
-		SteamClient.BrowserView.RegisterForMessageFromParent((messageId: string, data: string) => {
-			if (messageId !== IPCMessageId) {
+	async function WebkitInitializeIPC() {
+		let intervalId: NodeJS.Timeout | null = null;
+		const maxWaitTime = 10000; // 10 seconds
+
+		intervalId = setInterval(() => {
+			if (typeof SteamClient === 'undefined') {
 				return;
 			}
 
-			const payload = JSON.parse(data);
-			MillenniumStore.ignoreProxyFlag = true;
-			MillenniumStore.settingsStore[payload.name] = payload.value;
-			MillenniumStore.ignoreProxyFlag = false;
-		});
+			if (intervalId) {
+				clearInterval(intervalId);
+				intervalId = null;
+			}
+
+			SteamClient.BrowserView?.RegisterForMessageFromParent((messageId: string, data: string) => {
+				if (messageId !== IPCMessageId) {
+					return;
+				}
+
+				const payload = JSON.parse(data);
+				MillenniumStore.ignoreProxyFlag = true;
+				MillenniumStore.settingsStore[payload.name] = payload.value;
+				MillenniumStore.ignoreProxyFlag = false;
+			});
+		}, 100);
+
+		setTimeout(() => {
+			if (intervalId) {
+				clearInterval(intervalId);
+				console.warn('%c Millennium %c Failed to find SteamClient after 10000ms', 'background:rgb(37, 105, 184); color: white;', 'background: transparent;');
+			}
+		}, maxWaitTime);
 	}
 
 	isClientModule ? ClientInitializeIPC() : WebkitInitializeIPC();
@@ -252,3 +292,4 @@ function InitializePlugins() {
 }
 
 export { ExecutePluginModule, InitializePlugins };
+

package/src/static-embed.ts

@@ -1,12 +1,15 @@
-import { Plugin, SourceDescription, TransformPluginContext } from 'rollup';
-import fs from 'fs';
-import path from 'path';
-import { createFilter } from '@rollup/pluginutils';
-import MagicString from 'magic-string';
 import * as parser from '@babel/parser';
-import traverse from '@babel/traverse';
-import * as glob from 'glob';
+import { createFilter } from '@rollup/pluginutils';
 import chalk from 'chalk';
+import fs from 'fs';
+import * as glob from 'glob';
+import MagicString from 'magic-string';
+import path from 'path';
+import { Plugin, SourceDescription, TransformPluginContext } from 'rollup';
+
+// Stupid fix because @babel/traverse exports a CommonJS module
+import _traverse from '@babel/traverse';
+const traverse = (_traverse as any).default as typeof _traverse;
 
 interface EmbedPluginOptions {
 	include?: string | RegExp | (string | RegExp)[];

package/src/transpiler.ts

@@ -1,23 +1,24 @@
-import { OutputOptions, RollupOptions, rollup } from 'rollup';
-import json from '@rollup/plugin-json';
+import babel from '@rollup/plugin-babel';
 import commonjs from '@rollup/plugin-commonjs';
-import replace from '@rollup/plugin-replace';
-import typescript from '@rollup/plugin-typescript';
+import json from '@rollup/plugin-json';
 import resolve, { nodeResolve } from '@rollup/plugin-node-resolve';
+import replace from '@rollup/plugin-replace';
 import terser from '@rollup/plugin-terser';
-import babel from '@rollup/plugin-babel';
-import nodePolyfills from 'rollup-plugin-polyfill-node';
+import typescript from '@rollup/plugin-typescript';
 import url from '@rollup/plugin-url';
+import { InputPluginOption, OutputBundle, OutputOptions, RollupOptions, rollup } from 'rollup';
+import nodePolyfills from 'rollup-plugin-polyfill-node';
+import { minify_sync } from 'terser';
 
 import scss from 'rollup-plugin-scss';
 import * as sass from 'sass';
 
 import chalk from 'chalk';
-import { Logger } from './logger';
 import fs from 'fs';
+import { Logger } from './logger';
 
-import injectProcessEnv from 'rollup-plugin-inject-process-env';
 import dotenv from 'dotenv';
+import injectProcessEnv from 'rollup-plugin-inject-process-env';
 import { ExecutePluginModule, InitializePlugins } from './plugin-api';
 import constSysfsExpr from './static-embed';
 
@@ -54,7 +55,7 @@ export interface TranspilerProps {
 const WrappedCallServerMethod = 'const __call_server_method__ = (methodName, kwargs) => Millennium.callServerMethod(pluginName, methodName, kwargs)';
 const WrappedCallable = 'const __wrapped_callable__ = (route) => MILLENNIUM_API.callable(__call_server_method__, route)';
 
-const ConstructFunctions = (parts: any) => {
+const ConstructFunctions = (parts: string[]): string => {
 	return parts.join('\n');
 };
 
@@ -63,8 +64,8 @@ function generate(code: string) {
 	return `let PluginEntryPointMain = function() { ${code} return millennium_main; };`;
 }
 
-function InsertMillennium(type: ComponentType, props: TranspilerProps) {
-	const generateBundle = (_: unknown, bundle: any) => {
+function InsertMillennium(type: ComponentType, props: TranspilerProps): InputPluginOption {
+	const generateBundle = (_: unknown, bundle: OutputBundle) => {
 		for (const fileName in bundle) {
 			if (bundle[fileName].type != 'chunk') {
 				continue;
@@ -72,7 +73,7 @@ function InsertMillennium(type: ComponentType, props: TranspilerProps) {
 
 			Logger.Info('millenniumAPI', 'Bundling into ' + ComponentType[type] + ' module... ' + chalk.green.bold('okay'));
 
-			bundle[fileName].code = ConstructFunctions([
+			let code = ConstructFunctions([
 				`const MILLENNIUM_IS_CLIENT_MODULE = ${type === ComponentType.Plugin ? 'true' : 'false'};`,
 				`const pluginName = "${props.strPluginInternalName}";`,
 				InitializePlugins.toString(),
@@ -83,6 +84,12 @@ function InsertMillennium(type: ComponentType, props: TranspilerProps) {
 				ExecutePluginModule.toString(),
 				ExecutePluginModule.name + '()',
 			]);
+
+			if (props.bTersePlugin) {
+				code = minify_sync(code).code ?? code;
+			}
+
+			bundle[fileName].code = code;
 		}
 	};
 
@@ -112,7 +119,7 @@ async function MergePluginList(plugins: any[]) {
 	return [...plugins, ...filteredCustomPlugins];
 }
 
-async function GetPluginComponents(props: TranspilerProps) {
+async function GetPluginComponents(props: TranspilerProps): Promise<InputPluginOption[]> {
 	let tsConfigPath = '';
 	const frontendDir = GetFrontEndDirectory();
 
@@ -154,7 +161,6 @@ async function GetPluginComponents(props: TranspilerProps) {
 		resolve(),
 		json(),
 		constSysfsExpr(),
-		injectProcessEnv(envVars),
 		replace({
 			delimiters: ['', ''],
 			preventAssignment: true,
@@ -167,9 +173,14 @@ async function GetPluginComponents(props: TranspilerProps) {
 		}),
 	];
 
+	if (envVars.length > 0) {
+		pluginList.push(injectProcessEnv(envVars));
+	}
+
 	if (props.bTersePlugin) {
 		pluginList.push(terser());
 	}
+
 	return pluginList;
 }
 
@@ -189,7 +200,6 @@ async function GetWebkitPluginComponents(props: TranspilerProps) {
 		commonjs(),
 		json(),
 		constSysfsExpr(),
-		injectProcessEnv(envVars),
 		replace({
 			delimiters: ['', ''],
 			preventAssignment: true,
@@ -203,6 +213,10 @@ async function GetWebkitPluginComponents(props: TranspilerProps) {
 		}),
 	];
 
+	if (envVars.length > 0) {
+		pluginList.push(injectProcessEnv(envVars));
+	}
+
 	pluginList = await MergePluginList(pluginList);
 
 	props.bTersePlugin && pluginList.push(terser());