steam-theming-utils 3.2.0 → 3.3.1

package/README.md

@@ -1,51 +1,52 @@
-# steam-theming-utils
-
-A collection of scripts for easier (and future-proof) Steam theming.
-
-## Usage
-
-```sh
-$ npm i steam-theming-utils
-$ npx steam-theming-utils <script> <page>
-```
-
-Note that running any script requires Steam running with `-cef-enable-debugging`.
-
-## Scripts
-
-| Name                  | Description                                                                               |
-| --------------------- | ----------------------------------------------------------------------------------------- |
-| build_class_modules   | Generates a class map file for usage with other scripts.                                  |
-| make_readable_classes | Adds readable versions of classes to the focused window/page. ![Preview][classes-preview] |
-| replace_old_classes   | Replaces old classes with new ones for themes not using the [template][template].         |
-
-## Pages
-
-| Name               | Description                                                                  |
-| ------------------ | ---------------------------------------------------------------------------- |
-| apppage            | Related items & controller info in https://store.steampowered.com/app/666220 |
-| accountpreferences | https://store.steampowered.com/account                                       |
-| client             | The Steam client. The default.                                               |
-| gameslist          | https://steamcommunity.com/my/games                                          |
-| notificationspage  | https://steamcommunity.com/my/notifications                                  |
-| profileedit        | https://steamcommunity.com/my/edit                                           |
-| shoppingcart       | https://store.steampowered.com/cart                                          |
-
-## Errors
-
-| Name                      | Description                                                                                       |
-| ------------------------- | ------------------------------------------------------------------------------------------------- |
-| #ClassName is undefined   | Typo or that class either got renamed or removed, and so you will have to update it yourself.     |
-| [mod_name] no such module | Typo or that module either got renamed or removed, see diffs [here][diffs] depending on the page. |
-| [map_name] no such map    | Use `npx steam-theming-utils build_class_modules map_name` to create it.                          |
-
-## Config
-
-Configured through a `steam-theming-utils.config.js` (or the one from [here][config-files]) file that must `export default` an [object][config-docs]. It's optional and has defaults listed [here][config-defaults].
-
-[classes-preview]: ./img/readable_classes.png
-[config-defaults]: https://github.com/ricewind012/steam-theming-utils/blob/master/src/constants.js#L7-L11
-[config-docs]: https://github.com/ricewind012/steam-theming-utils/blob/master/src/api.d.ts#L4-L16
-[config-files]: https://github.com/cosmiconfig/cosmiconfig#usage-for-end-users
-[diffs]: https://github.com/ricewind012/steam-theming-utils/tree/master/cdp/db
-[template]: https://github.com/ricewind012/more-advanced-theme-template
+# steam-theming-utils
+
+A collection of scripts for easier (and future-proof) Steam theming.
+
+## Usage
+
+```sh
+$ npm i steam-theming-utils
+$ npx steam-theming-utils <script> <page>
+```
+
+Note that running any script requires Steam running with `-cef-enable-debugging`.
+
+## Scripts
+
+| Name                  | Description                                                                                                                                |
+| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| build_class_modules   | Generates a class map file for usage with other scripts.                                                                                   |
+| make_readable_classes | Adds readable versions of classes to the focused window/page. ![Preview][classes-preview]                                                  |
+| migrate               | _Try to_ migrate to using readable class names. Other rules that can't be sorted/found go in `_UNSORTED.css`/`_NOTFOUND.css` respectively. |
+| replace_old_classes   | Replaces old classes with new ones for themes not using the [template][template].                                                          |
+
+## Pages
+
+| Name               | Description                                                                  |
+| ------------------ | ---------------------------------------------------------------------------- |
+| apppage            | Related items & controller info in https://store.steampowered.com/app/666220 |
+| accountpreferences | https://store.steampowered.com/account                                       |
+| client             | The Steam client. The default.                                               |
+| gameslist          | https://steamcommunity.com/my/games                                          |
+| notificationspage  | https://steamcommunity.com/my/notifications                                  |
+| profileedit        | https://steamcommunity.com/my/edit                                           |
+| shoppingcart       | https://store.steampowered.com/cart                                          |
+
+## Errors
+
+| Name                      | Description                                                                                       |
+| ------------------------- | ------------------------------------------------------------------------------------------------- |
+| #ClassName is undefined   | Typo or that class either got renamed or removed, and so you will have to update it yourself.     |
+| [mod_name] no such module | Typo or that module either got renamed or removed, see diffs [here][diffs] depending on the page. |
+| [map_name] no such map    | Use `npx steam-theming-utils build_class_modules map_name` to create it.                          |
+
+## Config
+
+Configured through a `steam-theming-utils.config.js` (or the one from [here][config-files]) file that must `export default` an [object][config-docs]. It's optional and has defaults listed [here][config-defaults].
+
+[classes-preview]: ./img/readable_classes.png
+[config-defaults]: https://github.com/ricewind012/steam-theming-utils/blob/master/src/constants.js#L7-L11
+[config-docs]: https://github.com/ricewind012/steam-theming-utils/blob/master/src/api.d.ts#L4-L16
+[config-files]: https://github.com/cosmiconfig/cosmiconfig#usage-for-end-users
+[diffs]: https://github.com/ricewind012/steam-theming-utils/tree/master/cdp/db
+[template]: https://github.com/ricewind012/more-advanced-theme-template

package/cdp/class_modules.js

@@ -1,25 +1,25 @@
-classModules = {
-	...(window.specialModules || {}),
-	...(window.parsedModules
-		?.map((e) => ({ [e[0]]: e[1] }))
-		.reduce((a, b) => Object.assign(a, b)) || {}),
-	...exportedModules
-		.flatMap((a) => {
-			const mod = findFirstModule(a[1], a[0]);
-			if (!mod) {
-				return {};
-			}
-
-			return {
-				[a[0]]: Object.keys(mod || {})
-					// Remove keys like "duration-app-launch"
-					.filter((e) => !mod[e].match(/^\d+(\.\d+)?(\w{2})?$/))
-					.map((e) => ({ [e]: mod[e] }))
-					.reduce((a, b) => Object.assign(a, b)),
-			};
-		})
-		.reduce((a, b) => Object.assign(a, b)),
-};
-
-// return
-classModules;
+classModules = {
+	...(window.specialModules || {}),
+	...(window.parsedModules
+		?.map((e) => ({ [e[0]]: e[1] }))
+		.reduce((a, b) => Object.assign(a, b)) || {}),
+	...exportedModules
+		.flatMap((a) => {
+			const mod = findFirstModule(a[1], a[0]);
+			if (!mod) {
+				return {};
+			}
+
+			return {
+				[a[0]]: Object.keys(mod || {})
+					// Remove keys like "duration-app-launch"
+					.filter((e) => !mod[e].match(/^\d+(\.\d+)?(\w{2})?$/))
+					.map((e) => ({ [e]: mod[e] }))
+					.reduce((a, b) => Object.assign(a, b)),
+			};
+		})
+		.reduce((a, b) => Object.assign(a, b)),
+};
+
+// return
+classModules;

package/cdp/class_modules_webpack.js

@@ -1,64 +1,64 @@
-let initReq;
-const webpackCache = {};
-const webpackGlobal = Object.keys(window).find((e) => e.startsWith("webpack"));
-window[webpackGlobal].push([
-	[Math.random()],
-	{},
-	(r) => {
-		initReq = r;
-	},
-]);
-for (const i of Object.keys(initReq.m)) {
-	webpackCache[i] = initReq(i);
-}
-
-// Leave only the relevant modules
-const allModules = Object.values(webpackCache).filter((e) => {
-	if (!e || typeof e !== "object" || e.__esModule) {
-		return false;
-	}
-
-	const keys = Object.keys(e);
-	const first = keys[0];
-	return (
-		first &&
-		first.length >= 2 &&
-		!(
-			keys.length === 1 &&
-			(first === "duration-app-launch" ||
-				first === "version" ||
-				first.match(/^str[A-Z]/))
-		) &&
-		keys.every((k) => typeof e[k] === "string")
-	);
-});
-
-const findModule = (filter) => allModules.find(filter);
-const findAllModules = (filter) => allModules.filter(filter);
-
-function findFirstModule(filter, component) {
-	const modules = findAllModules(filter);
-	const printError = (msg) => {
-		console.error("[%s] %s", component, msg);
-	};
-
-	if (modules.length === 0) {
-		printError("found no modules");
-	}
-	if (modules.length > 1) {
-		printError("found more than 1 module, returning first found");
-	}
-
-	return modules[0];
-}
-
-/**
- * Find a unique class name from multiple similiar class modules.
- *
- * @param key Class name.
- * @param index Array index.
- */
-const findUniqueKey = (key, index = 0) =>
-	Object.keys(findAllModules((mod) => mod[key])[index]).find(
-		(mod) => findAllModules((mod2) => mod2[mod]).length === 1,
-	);
+let initReq;
+const webpackCache = {};
+const webpackGlobal = Object.keys(window).find((e) => e.startsWith("webpack"));
+window[webpackGlobal].push([
+	[Math.random()],
+	{},
+	(r) => {
+		initReq = r;
+	},
+]);
+for (const i of Object.keys(initReq.m)) {
+	webpackCache[i] = initReq(i);
+}
+
+// Leave only the relevant modules
+const allModules = Object.values(webpackCache).filter((e) => {
+	if (!e || typeof e !== "object" || e.__esModule) {
+		return false;
+	}
+
+	const keys = Object.keys(e);
+	const first = keys[0];
+	return (
+		first &&
+		first.length >= 2 &&
+		!(
+			keys.length === 1 &&
+			(first === "duration-app-launch" ||
+				first === "version" ||
+				first.match(/^str[A-Z]/))
+		) &&
+		keys.every((k) => typeof e[k] === "string")
+	);
+});
+
+const findModule = (filter) => allModules.find(filter);
+const findAllModules = (filter) => allModules.filter(filter);
+
+function findFirstModule(filter, component) {
+	const modules = findAllModules(filter);
+	const printError = (msg) => {
+		console.error("[%s] %s", component, msg);
+	};
+
+	if (modules.length === 0) {
+		printError("found no modules");
+	}
+	if (modules.length > 1) {
+		printError("found more than 1 module, returning first found");
+	}
+
+	return modules[0];
+}
+
+/**
+ * Find a unique class name from multiple similiar class modules.
+ *
+ * @param key Class name.
+ * @param index Array index.
+ */
+const findUniqueKey = (key, index = 0) =>
+	Object.keys(findAllModules((mod) => mod[key])[index]).find(
+		(mod) => findAllModules((mod2) => mod2[mod]).length === 1,
+	);

package/cdp/db/accountpreferences.js

@@ -1,11 +1,11 @@
-// Note that every module is only available on the "family management" page.
-exportedModules = [
-	["authorizeddevices", (e) => e.AuthorizedDeviceGroup],
-	["cookies", (e) => e.CookieSection],
-	["familymanagement", (e) => e.FamilySettingsContainer],
-	["familymanagementtabs", (e) => e.GraphicalAssetsTabs],
-	// TODO: shared with steam settings notif page
-	["notifications", (e) => e.NotificationSection],
-	// TODO: gamepaddialog
-	["toggle", (e) => e.Field],
-];
+// Note that every module is only available on the "family management" page.
+exportedModules = [
+	["authorizeddevices", (e) => e.AuthorizedDeviceGroup],
+	["cookies", (e) => e.CookieSection],
+	["familymanagement", (e) => e.FamilySettingsContainer],
+	["familymanagementtabs", (e) => e.GraphicalAssetsTabs],
+	// TODO: shared with steam settings notif page
+	["notifications", (e) => e.NotificationSection],
+	// TODO: gamepaddialog
+	["toggle", (e) => e.Field],
+];

package/cdp/db/apppage.js

@@ -1,12 +1,12 @@
-exportedModules = [
-	["storeitemscarousel", (e) => e.StoreItemsCarousel],
-	["capsule", (e) => e.MainCapsuleImageContainer],
-	["capsulecontainer", (e) => e.ItemCount1],
-	["carousel", (e) => e.pipScrollerContainer],
-	["creatorhome", (e) => e.FollowBtnText],
-	["creatorhomecarousel", (e) => e.CreatorHomeWithItems],
-	["focusring", (e) => e.FocusRingRoot],
-	["gamehover", (e) => e.GameHoverCapsuleCtn],
-	["scrollsnapcarousel", (e) => e.ScrollSnapCarousel],
-	["sidebarcontrollerinfo", (e) => e.StoreSidebarContainer],
-];
+exportedModules = [
+	["storeitemscarousel", (e) => e.StoreItemsCarousel],
+	["capsule", (e) => e.MainCapsuleImageContainer],
+	["capsulecontainer", (e) => e.SeeAllLink],
+	["carousel", (e) => e.pipScrollerContainer],
+	["creatorhome", (e) => e.FollowBtnText],
+	["creatorhomecarousel", (e) => e.CreatorHomeWithItems],
+	["focusring", (e) => e.FocusRingRoot],
+	["gamehover", (e) => e.GameHoverCapsuleCtn],
+	["scrollsnapcarousel", (e) => e.ScrollSnapCarousel],
+	["sidebarcontrollerinfo", (e) => e.StoreSidebarContainer],
+];