chore(release): 2.0.0 [CI SKIP]

BREAKING CHANGE: All usage of *Patch functions must now store the result and call .unpatch()
unpatch() has been removed.

.vscode/tasks.json

@@ -0,0 +1,15 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "npm",
+			"script": "dev",
+			"problemMatcher": [
+				"$tsc-watch"
+			],
+			"label": "npm: dev",
+			"detail": "tsc -b -w",
+			"isBackground": true
+		}
+	]
+}

CHANGELOG.md

@@ -1,3 +1,52 @@
+# [2.0.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.8.3...v2.0.0) (2022-09-04)
+
+
+### Features
+
+* **patcher:** rewrite to support multiple patches ([076d9eb](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/076d9eb5e8f22bfa49afc242608698da2ded50e4))
+
+
+### BREAKING CHANGES
+
+* **patcher:** All usage of *Patch functions must now store the result and call .unpatch()
+unpatch() has been removed.
+
+## [1.8.3](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.8.2...v1.8.3) (2022-09-03)
+
+
+### Bug Fixes
+
+* **plugin:** Export ServerResponse for use in plugin-loader.tsx ([#20](https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues/20)) ([d01c7b3](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/d01c7b3904c12142a58f78cbb93a4c1ecb438280))
+
+## [1.8.2](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.8.1...v1.8.2) (2022-08-28)
+
+
+### Bug Fixes
+
+* **utils:** Mutable variable must be non-const ([#19](https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues/19)) ([1dd48cd](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/1dd48cd4c42989c75ee6859ebf8b857c027ff0f5))
+
+## [1.8.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.8.0...v1.8.1) (2022-08-26)
+
+
+### Bug Fixes
+
+* **utils:** update wrapReactClass impl. and defaults for prop argument ([#17](https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues/17)) ([55bd06a](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/55bd06a5ee9468f572aed8f78be4d0acaaffe45a))
+
+# [1.8.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.7.8...v1.8.0) (2022-08-26)
+
+
+### Features
+
+* **components:** add Carousel component ([cf137c4](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/cf137c43b4962977650e6ce0fad554b6ae966e43))
+* **Focusable:** add FooterLegend props to Focusable and Field ([c25fe58](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/c25fe58f082d70a34443ac3c8b32b4528a4b01fb))
+
+## [1.7.8](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.7.7...v1.7.8) (2022-08-20)
+
+
+### Bug Fixes
+
+* **Dropdown:** correct Dropdown types ([#15](https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues/15)) ([a09af35](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/a09af357c7e750377feefad86ab417b19484cb60))
+
 ## [1.7.7](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.7.6...v1.7.7) (2022-08-20)
 
 

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "decky-frontend-lib",
-  "version": "1.7.7",
+  "version": "2.0.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "decky-frontend-lib",
-      "version": "1.7.7",
+      "version": "2.0.0",
       "license": "GPL-2.0-or-later",
       "dependencies": {
         "minimist": "^1.2.6"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "decky-frontend-lib",
-  "version": "1.7.7",
+  "version": "2.0.0",
   "description": "A library for building decky plugins",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/deck-components/Carousel.ts

@@ -0,0 +1,28 @@
+import { HTMLAttributes, ReactNode, RefAttributes, VFC } from "react";
+import { findModuleChild } from "../webpack";
+
+export interface CarouselProps extends HTMLAttributes<HTMLDivElement> {
+  autoFocus?: boolean;
+  enableBumperPaging?: boolean;
+  fnDoesItemTakeFocus?: (...unknown: any[]) => boolean;
+  fnGetColumnWidth?: (...unknown: any[]) => number;
+  fnGetId?: (id: number) => number;
+  fnItemRenderer?: (id: number, ...unknown: any[]) => ReactNode;
+  fnUpdateArrows?: (...unknown: any[]) => any;
+  initialColumn?: number;
+  nHeight?: number;
+  nIndexLeftmost?: number;
+  nItemHeight?: number;
+  nItemMarginX?: number;
+  nNumItems?: number;
+  name?: string;
+  scrollToAlignment?: 'center';
+}
+
+export const Carousel = findModuleChild((m) => {
+  if (typeof m !== 'object') return undefined;
+  for (let prop in m) {
+    if (m[prop]?.render?.toString().includes("setFocusedColumn:"))
+      return m[prop];
+  }
+}) as VFC<CarouselProps & RefAttributes<HTMLDivElement>>;

src/deck-components/Dropdown.tsx

@@ -4,14 +4,14 @@ import { CommonUIModule } from '../webpack';
 import { ItemProps } from './Item';
 
 export interface SingleDropdownOption {
-  data: number;
-  label: string;
+  data: any;
+  label: ReactNode;
 
   options?: never;
 }
 
 export interface MultiDropdownOption {
-  label: string;
+  label: ReactNode;
   options: DropdownOption[];
 
   data?: never;
@@ -21,7 +21,7 @@ export type DropdownOption = SingleDropdownOption | MultiDropdownOption;
 
 export interface DropdownProps {
   rgOptions: DropdownOption[];
-  selectedOption: number | null;
+  selectedOption: any;
   disabled?: boolean;
   onMenuWillOpen?(showMenu: () => void): void;
   onMenuOpened?(): void;

src/deck-components/Field.tsx

@@ -1,7 +1,8 @@
 import { FC, HTMLAttributes, ReactNode, RefAttributes } from 'react';
 import { findModuleChild } from '../webpack';
+import { FooterLegendProps } from './FooterLegend';
 
-export interface FieldProps extends HTMLAttributes<HTMLDivElement> {
+export interface FieldProps extends HTMLAttributes<HTMLDivElement>, FooterLegendProps {
   label?: string | ReactNode;
   bottomSeparator?: boolean;
   description?: string | ReactNode;

src/deck-components/Focusable.tsx

@@ -1,7 +1,8 @@
 import { HTMLAttributes, ReactNode, RefAttributes, VFC } from "react";
 import { findModuleChild } from "../webpack";
+import { FooterLegendProps } from "./FooterLegend";
 
-export interface FocusableProps extends HTMLAttributes<HTMLDivElement> {
+export interface FocusableProps extends HTMLAttributes<HTMLDivElement>, FooterLegendProps {
   children: ReactNode;
   "flow-children"?: string;
   focusClassName?: string;

src/deck-components/FooterLegend.ts

@@ -0,0 +1,18 @@
+export interface FooterLegendProps {
+    actionDescriptionMap?: unknown;
+    onOKActionDescription?: string;
+    onCancelActionDescription?: string;
+    onSecondaryActionDescription?: string;
+    onOptionsActionDescription?: string;
+    onMenuActionDescription?: string;
+    onButtonDown?: () => void;
+    onButtonUp?: () => void;
+    onOKButton?: () => void;
+    onCancelButton?: () => void;
+    onSecondaryButton?: () => void;
+    onOptionsButton?: () => void;
+    onGamepadDirection?: () => void;
+    onGamepadFocus?: () => void;
+    onGamepadBlur?: () => void;
+    onMenuButton?: () => void;
+}

src/deck-components/index.ts

@@ -1,8 +1,10 @@
 export * from './Button';
 export * from './ButtonItem';
+export * from './Carousel';
 export * from './Dropdown';
 export * from './Field';
 export * from './Focusable';
+export * from './FooterLegend';
 export * from './Menu';
 export * from './Modal';
 export * from './Panel';

src/deck-components/static-classes.ts

@@ -165,42 +165,151 @@ type QuickAccessControlsClasses = Record<
   string
 >;
 
-export const staticClasses: StaticClasses = findModule((mod) => {
-  if (typeof mod !== 'object') return false;
+type UpdaterFieldClasses = Record<
+  | "duration-app-launch"
+  | "OOBEUpdateStatusContainer"
+  | "UpdateScreen"
+  | "UpdatePanel"
+  | "CurrentStatus"
+  | "TotalUpdateSize"
+  | "ProgressInfoContainer"
+  | "TimeRemaining"
+  | "BatteryLowWarning"
+  | "fadeInAnimation"
+  | "ProgressStatus"
+  | "UpdateStatusContainer"
+  | "UpdaterFieldStatusSuccess"
+  | "UpdaterFieldStatusApplying"
+  | "TextContainer"
+  | "ApplyingText"
+  | "UpdateBytesRemaining"
+  | "Label"
+  | "Numerator"
+  | "Separator"
+  | "Denominator"
+  | "PatchNotes"
+  | "PostedTime"
+  | "EventDetailTitle"
+  | "EventDetailsSubTitle"
+  | "EventDetailsBody"
+  | "InsufficientBatteryText"
+  | "UnsupportedHardwareWarning"
+  | "Title"
+  | "Text"
+  | "Body"
+  | "ItemFocusAnim-darkerGrey-nocolor"
+  | "ItemFocusAnim-darkerGrey"
+  | "ItemFocusAnim-darkGrey"
+  | "ItemFocusAnim-grey"
+  | "ItemFocusAnimBorder-darkGrey"
+  | "ItemFocusAnim-green"
+  | "focusAnimation"
+  | "hoverAnimation",
+  string
+>;
 
-  if (mod.TransitionMenuDelay) {
-    return true;
-  }
+type PlaySectionClasses = Record<
+  | "AchievementCountLabel"
+  | "AchievementProgressRow"
+  | "ActionSection"
+  | "AppButtonsContainer"
+  | "Arrow"
+  | "AvatarAndPersona"
+  | "BreakNarrow"
+  | "BreakShort"
+  | "BreakTall"
+  | "BreakUltraWide"
+  | "BreakWide"
+  | "ClickablePlayBarItem"
+  | "CloudStatusIcon"
+  | "CloudStatusLabel"
+  | "CloudStatusRow"
+  | "CloudSyncProblem"
+  | "CloudSynching"
+  | "ComingSoon"
+  | "Container"
+  | "DetailsProgressBar"
+  | "DetailsProgressContainer"
+  | "DetailsSection"
+  | "DetailsSectionExtra"
+  | "DetailsSectionStatus"
+  | "DotDotDot"
+  | "DownloadPaused"
+  | "DownloadProgressBar"
+  | "Downloading"
+  | "FavoriteButton"
+  | "Favorited"
+  | "GameInfoButton"
+  | "GameStat"
+  | "GameStatIcon"
+  | "GameStatIconForced"
+  | "GameStatRight"
+  | "GameStatsSection"
+  | "GamepadUIBreakNarrow"
+  | "GamepadUIBreakShort"
+  | "GamepadUIBreakWide"
+  | "Glassy"
+  | "HideWhenNarrow"
+  | "Icon"
+  | "Icons"
+  | "InPage"
+  | "InnerContainer"
+  | "InvalidPlatform"
+  | "ItemFocusAnim-darkGrey"
+  | "ItemFocusAnim-darkerGrey"
+  | "ItemFocusAnim-darkerGrey-nocolor"
+  | "ItemFocusAnim-green"
+  | "ItemFocusAnim-grey"
+  | "ItemFocusAnimBorder-darkGrey"
+  | "Label"
+  | "LastPlayed"
+  | "LastPlayedInfo"
+  | "MenuActive"
+  | "MenuButton"
+  | "MiniAchievements"
+  | "OfflineMode"
+  | "OnlyDownloadBar"
+  | "PermanentlyUnavailable"
+  | "PlayBar"
+  | "PlayBarCloudStatusContainer"
+  | "PlayBarDetailLabel"
+  | "PlayBarGameIcon"
+  | "PlayBarGameName"
+  | "PlayBarIconAndGame"
+  | "PlayBarLabel"
+  | "Playtime"
+  | "PlaytimeIcon"
+  | "PlaytimeIconForced"
+  | "PortraitBar"
+  | "Presale"
+  | "RecentlyUpdated"
+  | "RecentlyUpdatedIcon"
+  | "RecentlyUpdatedLink"
+  | "RecentlyUpdatedText"
+  | "RightBreakNarrow"
+  | "RightBreakUltraNarrow"
+  | "RightBreakUltraWide"
+  | "RightBreakWide"
+  | "RightControls"
+  | "Row"
+  | "SharedLibrary"
+  | "StatusAndStats"
+  | "StatusNameContainer"
+  | "StickyHeader"
+  | "StickyHeaderShadow"
+  | "SuperimposedGridItems"
+  | "SyncAnim"
+  | "Visible"
+  | "duration-app-launch"
+  | "favorited"
+  | "focusAnimation"
+  | "hoverAnimation",
+  string
+>;
 
-  return false;
-});
-
-export const scrollClasses: ScrollClasses = findModule((mod) => {
-  if (typeof mod !== 'object') return false;
-
-  if (mod.ScrollPanel && mod.ScrollY) {
-    return true;
-  }
-
-  return false;
-});
-
-export const gamepadDialogClasses: GamepadDialogClasses = findModule((mod) => {
-  if (typeof mod !== 'object') return false;
-
-  if (mod.WithFirstRow) {
-    return true;
-  }
-
-  return false;
-});
-
-export const quickAccessControlsClasses: QuickAccessControlsClasses = findModule((mod) => {
-  if (typeof mod !== 'object') return false;
-
-  if (mod.PanelSectionRow) {
-    return true;
-  }
-
-  return false;
-});
+export const staticClasses: StaticClasses = findModule((mod) => typeof mod === 'object' && mod.TransitionMenuDelay);
+export const scrollClasses: ScrollClasses = findModule((mod) => typeof mod === 'object' && mod.ScrollPanel && mod.ScrollY);
+export const gamepadDialogClasses: GamepadDialogClasses = findModule((mod) => typeof mod === 'object' && mod.WithFirstRow);
+export const quickAccessControlsClasses: QuickAccessControlsClasses = findModule((mod) => typeof mod === 'object' && mod.PanelSectionRow);
+export const updaterFieldClasses: UpdaterFieldClasses = findModule((mod) => typeof mod === 'object' && mod.PatchNotes && mod.PostedTime);
+export const playSectionClasses: PlaySectionClasses = findModule((mod) => typeof mod === 'object' && mod.MenuButton && mod.MenuActive);

src/plugin.tsx

@@ -18,7 +18,7 @@ interface ServerResponseError {
   result: string;
 }
 
-type ServerResponse<TRes> = ServerResponseSuccess<TRes> | ServerResponseError;
+export type ServerResponse<TRes> = ServerResponseSuccess<TRes> | ServerResponseError;
 
 type RoutePatch = (route: RouteProps) => RouteProps;
 

src/utils/index.ts

@@ -0,0 +1,10 @@
+export * from "./patcher";
+export * from "./react";
+
+export function joinClassNames(...classes: string[]): string {
+    return classes.join(" ");
+}
+
+export function sleep(ms: number) {
+    return new Promise(res => setTimeout(res, ms));
+}

src/utils/patcher.ts

@@ -0,0 +1,112 @@
+// TODO: implement storing patches as an option so we can offer unpatchAll selectively
+// Return this in a replacePatch to call the original method (can still modify args).
+export let callOriginal = Symbol("DECKY_CALL_ORIGINAL");
+
+export interface PatchOptions {
+    singleShot?: boolean
+}
+
+type GenericPatchHandler = (args: any[], ret?: any) => any;
+
+export interface Patch {
+    original: Function;
+    property: string;
+    object: any;
+    patchedFunction: any;
+    hasUnpatched: boolean;
+    handler: GenericPatchHandler;
+
+    unpatch: () => void
+};
+
+// let patches = new Set<Patch>();
+
+export function beforePatch(object: any, property: string, handler: (args: any[]) => any, options: PatchOptions = {}): Patch {
+    const orig = object[property];
+    object[property] = function (...args: any[]) {
+        handler.call(this, args);
+        const ret = patch.original.call(this, ...args);
+        if (options.singleShot) {
+            patch.unpatch();
+        }
+        return ret;
+    }
+    const patch = processPatch(object, property, handler, object[property], orig);
+    return patch;
+}
+
+export function afterPatch(object: any, property: string, handler: (args: any[], ret: any) => any, options: PatchOptions = {}): Patch {
+    const orig = object[property];
+    object[property] = function (...args: any[]) {
+        let ret = patch.original.call(this, ...args);
+        ret = handler.call(this, args, ret);
+        if (options.singleShot) {
+            patch.unpatch();
+        }
+        return ret;
+    }
+    const patch = processPatch(object, property, handler, object[property], orig);
+    return patch;
+}
+
+export function replacePatch(object: any, property: string, handler: (args: any[]) => any, options: PatchOptions = {}): Patch {
+    const orig = object[property];
+    object[property] = function (...args: any[]) {
+        const ret = handler.call(this, args);
+        if (ret == callOriginal) return patch.original.call(this, ...args);
+        if (options.singleShot) {
+            patch.unpatch();
+        }
+        return ret;
+    };
+    const patch = processPatch(object, property, handler, object[property], orig);
+    return patch;
+}
+
+function processPatch(object: any, property: any, handler: GenericPatchHandler, patchedFunction: any, original: any): Patch {
+    // Assign all props of original function to new one
+    Object.assign(object[property], original);
+    // Allow toString webpack filters to continue to work
+    object[property].toString = () => original.toString();
+
+    // HACK: for compatibility, remove when all plugins are using new patcher
+    Object.defineProperty(object[property], "__deckyOrig", {
+        get: () => patch.original,
+        set: (val: any) => patch.original = val
+    })
+
+    // Build a Patch object of this patch
+    const patch: Patch = {
+        object,
+        property,
+        handler,
+        patchedFunction,
+        original,
+        hasUnpatched: false,
+        unpatch: () => unpatch(patch)
+    };
+
+    object[property].__deckyPatch = patch;
+
+    return patch;
+}
+
+function unpatch(patch: Patch): void {
+    const { object, property, handler, patchedFunction, original } = patch;
+    if (patch.hasUnpatched) throw new Error("Function is already unpatched.")
+    let realProp = property;
+    let realObject = object;
+    console.debug("[Patcher] unpatching", {realObject, realProp, object, property, handler, patchedFunction, original, isEqual: realObject[realProp] === patchedFunction})
+
+    // If another patch has been applied to this function after this one, move down until we find the correct patch
+    while (realObject[realProp] && realObject[realProp] !== patchedFunction) {
+        realObject = realObject[realProp].__deckyPatch;
+        realProp = "original";
+        console.debug("[Patcher] moved to next", {realObject, realProp, object, property, handler, patchedFunction, original, isEqual: realObject[realProp] === patchedFunction})
+    }
+
+    realObject[realProp] = realObject[realProp].__deckyPatch.original
+
+    patch.hasUnpatched = true;
+    console.debug("[Patcher] unpatched", {realObject, realProp, object, property, handler, patchedFunction, original, isEqual: realObject[realProp] === patchedFunction})
+}

src/utils/react.ts

@@ -42,79 +42,20 @@ export function fakeRenderComponent(fun: Function): any {
     return res;
 }
 
-export function beforePatch(obj: any, name: string, fnc: (args: any[]) => any): void {
-    const orig = obj[name];
-    obj[name] = function (...args: any[]) {
-        fnc.call(this, args);
-        return orig.call(this, ...args);
-    }
-    Object.assign(obj[name], orig);
-    obj[name].toString = () => orig.toString();
-    obj[name].__deckyOrig = orig;
+export function wrapReactType(node: any, prop: any = 'type') {
+    return node[prop] = {...node[prop]};
 }
 
-export function afterPatch(obj: any, name: string, fnc: (args: any[], ret: any) => any): void {
-    const orig = obj[name];
-    obj[name] = function (...args: any[]) {
-        let ret = orig.call(this, ...args);
-        ret = fnc.call(this, args, ret);
-        return ret;
-    }
-    Object.assign(obj[name], orig);
-    obj[name].toString = () => orig.toString();
-    obj[name].__deckyOrig = orig;
-}
-
-export function replacePatch(obj: any, name: string, fnc: (args: any[]) => any): void {
-    const orig = obj[name];
-    obj[name] = function (...args: any[]) {
-      const ret = fnc.call(this, args);
-      if (ret == 'CALL_ORIGINAL') return orig.call(this, ...args);
-      return ret;
-    };
-    Object.assign(obj[name], orig);
-    obj[name].toString = () => orig.toString();
-    obj[name].__deckyOrig = orig;
-}
-
-// TODO allow one method to be patched and unpatched multiple times independently using IDs in a Map or something
-export function unpatch(obj: any, name: any): void {
-    obj[name] = obj[name].__deckyOrig;
-}
-
-export function wrapReactType(node: any, prop?: any) {
-    return node[prop || "type"] = {...node[prop || "type"]};
-}
-
-export function wrapReactClass(node: any, prop?: any) {
-    const cls = node[prop || "type"];
+export function wrapReactClass(node: any, prop: any = 'type') {
+    const cls = node[prop];
     const wrappedCls = class extends cls {};
-    Object.getOwnPropertyNames(cls.prototype).forEach((prop: any) => {
-        try {
-            wrappedCls.prototype[prop] = cls.prototype[prop]
-        } catch (e) {}
-    });
-    Object.getOwnPropertyNames(cls).forEach((prop: any) => {
-        try {
-            if (prop != "prototype") wrappedCls[prop] = cls[prop]
-        } catch (e) {}
-    });
-    wrappedCls.prototype.__proto__ = cls.prototype.__proto__;
-    return node[prop || "type"] = wrappedCls;
+    return node[prop] = wrappedCls;
 }
 
 export function getReactInstance(o: HTMLElement | Element | Node) {
     return o[Object.keys(o).find(k => k.startsWith('__reactInternalInstance')) as string]
 }
 
-export function joinClassNames(...classes: string[]): string {
-    return classes.join(" ");
-}
-
-export function sleep(ms: number) {
-    return new Promise(res => setTimeout(res, ms));
-}
-
 // Based on https://github.com/GooseMod/GooseMod/blob/9ef146515a9e59ed4e25665ed365fd72fc0dcf23/src/util/react.js#L20
 export interface findInTreeOpts {
     walkable?: string[],