@steambrew/ttc 2.8.7 → 3.0.1

package/src/plugin-api.ts

@@ -1,263 +1,77 @@
-declare global {
-	interface Window {
-		/**
-		 * @description The plugin list is a global object that contains all the plugins loaded in the client.
-		 * It is used to store the pluginSelf object
-		 */
-		PLUGIN_LIST: any;
-		/**
-		 * @description The plugin settings store is a global object that contains all the plugins settings.
-		 * 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;
-	}
-}
-
-interface SettingsProps {
-	options?: any[];
-	range?: number[];
-	type: string;
-	value: any;
-}
-
-/**
- * the pluginName is the name of the plugin.
- * It is used to identify the plugin in the plugin list and settings store.
- */
-declare const pluginName: string;
-/**
- * PluginEntryPointMain is the default function returned by rolling up the plugin.
- * It is the main entry point for the plugin. It's IIFE has been removed, therefore it only runs once its manually called.
- * This is done to prevent the plugin from running before the settings have been parsed.
- */
-declare const PluginEntryPointMain: any;
-/**
- * The underlying IPC object used to communicate with the backend.
- * Its defined within the plugin utils package under the client module.
- */
-declare const MILLENNIUM_BACKEND_IPC: any;
-/**
- * Since ExecutePluginModule is called from both the webkit and the client module,
- * this flag is used to determine if the plugin is running in the client module or not.
- */
-declare const MILLENNIUM_IS_CLIENT_MODULE: boolean;
-/**
- * A reference to the main Web Browser within the client.
- * This is used to send messages to the main window browser manager.
- */
-declare const MainWindowBrowserManager: any;
-/**
- * Steam Client API object
- */
-declare const SteamClient: any;
-
-/**
- * @description Append the active plugin to the global plugin
- * list and notify that the frontend Loaded.
- */
-function ExecutePluginModule() {
-	let MillenniumStore = window.MILLENNIUM_PLUGIN_SETTINGS_STORE[pluginName];
-
-	function OnPluginConfigChange(key: any, __: string, value: any) {
-		if (key in MillenniumStore.settingsStore) {
-			MillenniumStore.ignoreProxyFlag = true;
-			MillenniumStore.settingsStore[key] = value;
-			MillenniumStore.ignoreProxyFlag = false;
-		}
-	}
-
-	/** 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(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.
-		 * The string is then decoded and parsed into an object.
-		 */
-		if (typeof response.returnValue === 'string') {
-			MillenniumStore.ignoreProxyFlag = true;
-
-			/** Initialize the settings store from the settings returned from the backend. */
-			MillenniumStore.settingsStore = MillenniumStore.DefinePluginSetting(
-				Object.fromEntries(JSON.parse(atob(response.returnValue)).map((item: any) => [item.functionName, item])),
-			);
-
-			MillenniumStore.ignoreProxyFlag = false;
-		}
-
-		/** @ts-ignore: call the plugin main after the settings have been parsed. This prevent plugin settings from being undefined at top level. */
-		let PluginModule = PluginEntryPointMain();
-
-		/** Assign the plugin on plugin list. */
-		Object.assign(window.PLUGIN_LIST[pluginName], {
-			...PluginModule,
-			__millennium_internal_plugin_name_do_not_use_or_change__: pluginName,
-		});
-
-		/** Run the rolled up plugins default exported function */
-		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) {
-			MILLENNIUM_BACKEND_IPC.postMessage(1, { pluginName: pluginName });
-		}
-	});
-}
-
-/**
- * @description Initialize the plugins settings store and the plugin list.
- * This function is called once per plugin and is used to store the plugin settings and the plugin list.
- */
-function InitializePlugins() {
-	/**
-	 * This function is called n times depending on n plugin count,
-	 * Create the plugin list if it wasn't already created
-	 */
-	(window.PLUGIN_LIST ||= {})[pluginName] ||= {};
-	(window.MILLENNIUM_PLUGIN_SETTINGS_STORE ||= {})[pluginName] ||= {};
-	window.MILLENNIUM_SIDEBAR_NAVIGATION_PANELS ||= {};
-
-	/**
-	 * Accepted IPC message types from Millennium backend.
-	 */
-	enum IPCType {
-		CallServerMethod,
-	}
-
-	let MillenniumStore = window.MILLENNIUM_PLUGIN_SETTINGS_STORE[pluginName];
-	let IPCMessageId = `Millennium.Internal.IPC.[${pluginName}]`;
-	let isClientModule = MILLENNIUM_IS_CLIENT_MODULE;
-
-	const ComponentTypeMap = {
-		DropDown: ['string', 'number', 'boolean'],
-		NumberTextInput: ['number'],
-		StringTextInput: ['string'],
-		FloatTextInput: ['number'],
-		CheckBox: ['boolean'],
-		NumberSlider: ['number'],
-		FloatSlider: ['number'],
-	};
-
-	MillenniumStore.ignoreProxyFlag = false;
-
-	function DelegateToBackend(pluginName: string, name: string, value: any) {
-		return MILLENNIUM_BACKEND_IPC.postMessage(IPCType.CallServerMethod, {
-			pluginName,
-			methodName: '__builtins__.__update_settings_value__',
-			argumentList: { name, value },
-		});
-	}
-
-	async function ClientInitializeIPC() {
-		/** Wait for the MainWindowBrowser to not be undefined */
-		while (typeof MainWindowBrowserManager === 'undefined') {
-			await new Promise((resolve) => setTimeout(resolve, 0));
-		}
-
-		MainWindowBrowserManager?.m_browser?.on('message', (messageId: string, data: string) => {
-			if (messageId !== IPCMessageId) {
-				return;
-			}
-
-			const { name, value } = JSON.parse(data);
-
-			MillenniumStore.ignoreProxyFlag = true;
-			MillenniumStore.settingsStore[name] = value;
-
-			DelegateToBackend(pluginName, name, value);
-			MillenniumStore.ignoreProxyFlag = false;
-		});
-	}
-
-	if (isClientModule) {
-		ClientInitializeIPC();
-	}
-
-	const StartSettingPropagation = (name: string, value: any) => {
-		if (MillenniumStore.ignoreProxyFlag) {
-			return;
-		}
-
-		if (isClientModule) {
-			DelegateToBackend(pluginName, name, value);
-
-			/** If the browser doesn't exist yet, no use sending anything to it. */
-			if (typeof MainWindowBrowserManager !== 'undefined') {
-				MainWindowBrowserManager?.m_browser?.PostMessage(IPCMessageId, JSON.stringify({ name, value }));
-			}
-		} else {
-			/** Send the message to the SharedJSContext */
-			SteamClient.BrowserView.PostMessageToParent(IPCMessageId, JSON.stringify({ name, value }));
-		}
-	};
-
-	function clamp(value: number, min: number, max: number) {
-		return Math.max(min, Math.min(max, value));
-	}
-
-	const DefinePluginSetting = <T extends Record<string, SettingsProps>>(obj: T) => {
-		return new Proxy(obj, {
-			set(target, property, value) {
-				if (!(property in target)) {
-					throw new TypeError(`Property ${String(property)} does not exist on plugin settings`);
-				}
-
-				const settingType = ComponentTypeMap[target[property as keyof T].type as keyof typeof ComponentTypeMap];
-				const range = target[property as keyof T]?.range;
-
-				/** Clamp the value between the given range */
-				if (settingType.includes('number') && typeof value === 'number') {
-					if (range) {
-						value = clamp(value, range[0], range[1]);
-					}
-
-					value ||= 0; // Fallback to 0 if the value is undefined or null
-				}
-
-				/** Check if the value is of the proper type */
-				if (!settingType.includes(typeof value)) {
-					throw new TypeError(`Expected ${settingType.join(' or ')}, got ${typeof value}`);
-				}
-
-				target[property as keyof T].value = value;
-				StartSettingPropagation(String(property), value);
-				return true;
-			},
-			get(target, property) {
-				if (property === '__raw_get_internals__') {
-					return target;
-				}
-
-				if (property in target) {
-					return target[property as keyof T].value;
-				}
-				return undefined;
-			},
-		});
-	};
-
-	MillenniumStore.DefinePluginSetting = DefinePluginSetting;
-	MillenniumStore.settingsStore = DefinePluginSetting({});
-}
-
-export { ExecutePluginModule, InitializePlugins };
-
+declare global {
+	interface Window {
+		/**
+		 * @description The plugin list is a global object that contains all the plugins loaded in the client.
+		 * It is used to store the pluginSelf object
+		 */
+		PLUGIN_LIST: any;
+		/**
+		 * @description Used to store the settings for the plugin.
+		 * Millennium then renders these in the settings panel.
+		 */
+		MILLENNIUM_SIDEBAR_NAVIGATION_PANELS: any;
+	}
+}
+
+/**
+ * the pluginName is the name of the plugin.
+ * It is used to identify the plugin in the plugin list and settings store.
+ */
+declare const pluginName: string;
+/**
+ * PluginEntryPointMain is the default function returned by rolling up the plugin.
+ * It is the main entry point for the plugin. It's IIFE has been removed, therefore it only runs once its manually called.
+ * This is done to prevent the plugin from running before the settings have been parsed.
+ */
+declare const PluginEntryPointMain: any;
+/**
+ * The underlying IPC object used to communicate with the backend.
+ * Its defined within the plugin utils package under the client module.
+ */
+declare const MILLENNIUM_BACKEND_IPC: any;
+/**
+ * Since ExecutePluginModule is called from both the webkit and the client module,
+ * this flag is used to determine if the plugin is running in the client module or not.
+ */
+declare const MILLENNIUM_IS_CLIENT_MODULE: boolean;
+
+/**
+ * @description Append the active plugin to the global plugin
+ * list and notify that the frontend Loaded.
+ */
+async function ExecutePluginModule() {
+	let PluginModule = PluginEntryPointMain();
+
+	/** Assign the plugin on plugin list. */
+	Object.assign(window.PLUGIN_LIST[pluginName], {
+		...PluginModule,
+		__millennium_internal_plugin_name_do_not_use_or_change__: pluginName,
+	});
+
+	/** Run the rolled up plugins default exported function */
+	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;
+	}
+
+	/** 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) {
+		MILLENNIUM_BACKEND_IPC.postMessage(1, { pluginName: pluginName });
+	}
+}
+
+/**
+ * @description Initialize the plugins settings store and the plugin list.
+ * This function is called once per plugin and is used to store the plugin settings and the plugin list.
+ */
+function InitializePlugins() {
+	(window.PLUGIN_LIST ||= {})[pluginName] ||= {};
+	window.MILLENNIUM_SIDEBAR_NAVIGATION_PANELS ||= {};
+}
+
+export { ExecutePluginModule, InitializePlugins };

package/src/query-parser.ts

@@ -1,89 +1,83 @@
-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
-	isMillennium?: boolean;
-}
-
-export const ValidateParameters = (args: Array<string>): ParameterProps => {
-	let typeProp: BuildType = BuildType.DevBuild,
-		targetProp: string = process.cwd(),
-		isMillennium: boolean = false;
-
-	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];
-		}
-
-		if (args[i] == '--millennium-internal') {
-			isMillennium = true;
-		}
-	}
-
-	return {
-		type: typeProp,
-		targetPlugin: targetProp,
-		isMillennium: isMillennium,
-	};
-};
+import { Logger } from './logger';
+
+export const PrintParamHelp = () => {
+	console.log(
+		[
+			'',
+			'usage: millennium-ttc --build <dev|prod> [options]',
+			'',
+			'options:',
+			'  --build <dev|prod>   build type (prod enables minification)',
+			'  --target <path>      plugin directory (default: current directory)',
+			'  --no-update          skip update check',
+			'  --help               show this message',
+			'',
+		].join('\n'),
+	);
+};
+
+export enum BuildType {
+	DevBuild,
+	ProdBuild,
+}
+
+export interface ParameterProps {
+	type: BuildType;
+	targetPlugin: string; // path
+	isMillennium?: boolean;
+}
+
+export const ValidateParameters = (args: Array<string>): ParameterProps => {
+	let typeProp: BuildType = BuildType.DevBuild,
+		targetProp: string = process.cwd(),
+		isMillennium: boolean = false;
+
+	if (args.includes('--help')) {
+		PrintParamHelp();
+		process.exit();
+	}
+
+	if (!args.includes('--build')) {
+		Logger.error('missing required argument: --build');
+		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 must be one of: dev, prod');
+					process.exit();
+				}
+			}
+		}
+
+		if (args[i] == '--target') {
+			if (args[i + 1] === undefined) {
+				Logger.error('--target requires a path argument');
+				process.exit();
+			}
+
+			targetProp = args[i + 1];
+		}
+
+		if (args[i] == '--millennium-internal') {
+			isMillennium = true;
+		}
+	}
+
+	return {
+		type: typeProp,
+		targetPlugin: targetProp,
+		isMillennium: isMillennium,
+	};
+};