steam-theming-utils 3.0.0 → 3.1.0

package/cdp/db/client.js

@@ -120,11 +120,13 @@ exportedModules = [
 	["appdetailsheader", (e) => e.AppDetailsOverviewPanel],
 	["appdetailsheaderinfo", (e) => e.HeaderFriendsInGameBadge],
 	["appdetailshover", (e) => e.AppDetailsHover],
+	["appdetailsinfoicon", (e) => e.MoreInfoIcon],
 	["appdetailsinvalidostype", (e) => e.InvalidOSTypeBody],
 	["appdetailsmastersubincluded", (e) => e.IncludedBanner],
 	["appdetailsnotessection", (e) => e.NoteLink],
 	["appdetailsoverview", (e) => e.SeekTarget],
 	["appdetailsplaysection", (e) => e.PermanentlyUnavailable],
+	["appdetailsposttextentry", (e) => e.PostTextEntryArea],
 	["appdetailsprimarylinkssection", (e) => e.NavButton],
 	["appdetailsreviewsection", (e) => e.EditMyReview],
 	["appdetailsscreenshotssection", (e) => e.ScreenshotsSection],
@@ -215,7 +217,6 @@ exportedModules = [
 	["cliptimelinerecordingdecorator", (e) => e.LiveRecordingBuffer],
 	["cloudconflict", (e) => e.ConflictChoiceText],
 	["cloudfileuploadprogress", (e) => e.UploadPreviewContainer],
-	["collapseicon", (e) => e.CollapseIconParent],
 	["collectionbanner", (e) => e.CollectionShelfBanner],
 	["collectionview", (e) => e.DynamicCollectionLabelAndButton],
 	["colorsettings", (e) => e.FloatingControls],
@@ -305,6 +306,7 @@ exportedModules = [
 	["gamelaunchingdialog", (e) => e.GameLaunchingDialog],
 	["gamelist", (e) => e.NoSearchResultsContainer],
 	["gamelistbar", (e) => e.GameListHomeAndSearch],
+	["gamelistcollapseicon", (e) => e.CollapseIconParent],
 	["gamelistcollectionmenu", (e) => e.CollectionDeleteContainer],
 	["gamelistdropdown", (e) => e.ScrollToTop],
 	["gamelistentry", (e) => e.GameListEntryName],
@@ -352,7 +354,6 @@ exportedModules = [
 	["hoverposition", (e) => e.HoverPosition],
 	["htmlpopupdialog", (e) => e.HTMLPopupDialog],
 	["index", (e) => e.ThreeDots],
-	["infoicon", (e) => e.MoreInfoIcon],
 	["insetshadow", (e) => e.FriendsListInsetShadowCtn],
 	["installdialog", (e) => e.DownloadItem],
 	["installrequest", (e) => e.AppSizeRequired],
@@ -444,7 +445,6 @@ exportedModules = [
 	["personastatusicons", (e) => e.PersonaStatusIcon],
 	["pininput", (e) => e.DigitInputField],
 	["playersdialog", (e) => e.PlayersDialog],
-	["posttextentry", (e) => e.PostTextEntryArea],
 	["powermenu", (e) => e.SuspendDialog],
 	["presenterpopup", (e) => e.Speaker],
 	["progressbar", (e) => e.ProgressBarFieldStatus],

package/cdp/make_readable_classes.js

@@ -1,3 +1,7 @@
+/**
+ * @param {string} className
+ * @returns the readable class name.
+ */
 function getNormalClass(className) {
 	for (const key of Object.keys(classModules)) {
 		const mod = classModules[key];
@@ -13,6 +17,11 @@ function getNormalClass(className) {
 	notInDb.push(className);
 }
 
+/**
+ * Sets readable classes to a `data-readable-class` attribute.
+ *
+ * @param {HTMLElement} el
+ */
 function normalizeElement(el) {
 	const readableClasses = [...el.classList]
 		.map(getNormalClass)
@@ -26,6 +35,9 @@ function normalizeElement(el) {
 	el.dataset.readableClass = `\n${readableClasses}\n`;
 }
 
+/**
+ * @param {FocusEvent}
+ */
 function main({ target }) {
 	const elements = target.document.querySelectorAll("[class]");
 	for (const el of elements) {

package/lib/build_class_modules.js

@@ -36,6 +36,7 @@ async function sleepUntilResult(...args) {
 
 /**
  * Gets a CDP web connection, accounting for the needed React part to load.
+ *
  * @param {import("../src/api").Page | "client"} page
  */
 async function getWebConn(page) {
@@ -91,7 +92,7 @@ async function doTheThing(page, conn) {
 	}
 	await runCdpFile(path.join("db", `${page}.js`), conn);
 
-	const dirPath = path.join(process.cwd(), config.classMaps);
+	const dirPath = path.join(path.basename(process.cwd()), config.classMaps);
 	const filePath = path.join(dirPath, `${page}.json`);
 
 	const output = await runCdpFile("class_modules.js", conn);

package/lib/replace_old_classes.js

@@ -1,7 +1,8 @@
 import fs from "node:fs";
+import path from "node:path";
 import postcss from "postcss";
 import { config } from "../src/api.js";
-import { readFile, selectorReplacerPlugin } from "../src/shared.js";
+import { readFile } from "../src/shared.js";
 
 const CLASS_MAP_FILE = path.join(config.classMaps, "client.json");
 const OLD_CLASS_MAP_FILE = path.join(config.classMaps, "client_old.json");
@@ -18,6 +19,13 @@ if ([CLASS_MAP_FILE, OLD_CLASS_MAP_FILE].some((e) => !fs.existsSync(e))) {
 	process.exit(1);
 }
 
+const selectorReplacerPlugin = (opts) => (css) => {
+	css.walkRules((rule) => {
+		rule.selector = rule.selector.replace(opts.match, opts.replace);
+	});
+};
+selectorReplacerPlugin.postcss = true;
+
 const cwd = process.cwd();
 const oldClasses = JSON.parse(fs.readFileSync(OLD_CLASS_MAP_FILE));
 const newClasses = JSON.parse(fs.readFileSync(CLASS_MAP_FILE));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "steam-theming-utils",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "A collection of scripts for easier Steam theming",
   "repository": {
     "type": "git",

package/src/api.d.ts

@@ -39,6 +39,7 @@ export type Page =
 	| "profileedit"
 	| "shoppingcart";
 
+export declare const connection: CDP.Client;
 export declare const config: Config;
 
 /**

package/src/postcss_plugin.js

@@ -21,6 +21,7 @@ const classMap = {};
 
 /**
  * Gets a class map on demand rather than reading all files at once.
+ *
  * @param {string} page
  */
 function getClassMap(page) {

package/src/shared.js

@@ -13,13 +13,6 @@ export const packagePath = path
 
 export const readFile = (file) => fs.readFileSync(file).toString();
 
-export const selectorReplacerPlugin = (opts) => (css) => {
-	css.walkRules((rule) => {
-		rule.selector = rule.selector.replace(opts.match, opts.replace);
-	});
-};
-selectorReplacerPlugin.postcss = true;
-
 /**
  * @typedef {object} SteamPage
  *
@@ -31,6 +24,7 @@ selectorReplacerPlugin.postcss = true;
 
 /**
  * Gets a page URL for a given page name.
+ *
  * @param {import("./api").Page} page
  * @returns {Promise<SteamPage>}
  */
@@ -67,6 +61,7 @@ export async function getPageUrl(page) {
 
 /**
  * Creates a CDP connection for a given target.
+ *
  * @param {(targets: cdp.Target[]) => cdp.Target} target
  */
 export async function createConnection(target) {
@@ -90,6 +85,7 @@ export async function createConnection(target) {
 
 /**
  * Creates a CDP connection for a given page name.
+ *
  * @param {import("./api").Page} page
  */
 export async function createWebConnection(page) {