mirror of
https://github.com/SteamDeckHomebrew/decky-frontend-lib.git
synced 2026-05-23 11:28:48 +02:00
Compare commits
23 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
73b8d52c7f | ||
|
|
2b8d2ae4db | ||
|
|
48de8928e4 | ||
|
|
d60715b755 | ||
|
|
a370c1f7d3 | ||
|
|
d83bada4af | ||
|
|
1f7178f175 | ||
|
|
44fdf9ed3b | ||
|
|
1b5fd78bc2 | ||
|
|
d64c42ac31 | ||
|
|
0ec60edf4d | ||
|
|
2c3a9f81de | ||
|
|
00079a71cc | ||
|
|
c04f024b34 | ||
|
|
5dae77b003 | ||
|
|
6b8c28e69c | ||
|
|
3ef9648355 | ||
|
|
0da85355c2 | ||
|
|
dcdbb2d6c7 | ||
|
|
58e3d35e1e | ||
|
|
bd1dc85b92 | ||
|
|
aa78f4c0a2 | ||
|
|
b04044451a |
6
.github/workflows/docs.yaml
vendored
6
.github/workflows/docs.yaml
vendored
@@ -12,19 +12,19 @@ jobs:
|
|||||||
runs-on: ubuntu-22.04
|
runs-on: ubuntu-22.04
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
path: lib
|
path: lib
|
||||||
- name: Setup | Checkout wiki
|
- name: Setup | Checkout wiki
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
repository: SteamDeckHomebrew/wiki
|
repository: SteamDeckHomebrew/wiki
|
||||||
path: wiki
|
path: wiki
|
||||||
ssh-key: ${{ secrets.SSH_DEPLOY_KEY }}
|
ssh-key: ${{ secrets.SSH_DEPLOY_KEY }}
|
||||||
persist-credentials: true
|
persist-credentials: true
|
||||||
- name: Setup | Node.js
|
- name: Setup | Node.js
|
||||||
uses: actions/setup-node@v3
|
uses: actions/setup-node@v4
|
||||||
with:
|
with:
|
||||||
node-version: 18
|
node-version: 18
|
||||||
- name: Setup | Dependencies
|
- name: Setup | Dependencies
|
||||||
|
|||||||
4
.github/workflows/release.yaml
vendored
4
.github/workflows/release.yaml
vendored
@@ -12,11 +12,11 @@ jobs:
|
|||||||
runs-on: ubuntu-22.04
|
runs-on: ubuntu-22.04
|
||||||
steps:
|
steps:
|
||||||
- name: Setup | Checkout
|
- name: Setup | Checkout
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
- name: Setup | Node.js
|
- name: Setup | Node.js
|
||||||
uses: actions/setup-node@v3
|
uses: actions/setup-node@v4
|
||||||
with:
|
with:
|
||||||
node-version: 20
|
node-version: 20
|
||||||
- name: Setup | Dependencies
|
- name: Setup | Dependencies
|
||||||
|
|||||||
@@ -14,6 +14,7 @@
|
|||||||
],
|
],
|
||||||
"@semantic-release/release-notes-generator",
|
"@semantic-release/release-notes-generator",
|
||||||
"@semantic-release/changelog",
|
"@semantic-release/changelog",
|
||||||
|
"@semantic-release/npm",
|
||||||
"@semantic-release/github",
|
"@semantic-release/github",
|
||||||
[
|
[
|
||||||
"@semantic-release/git",
|
"@semantic-release/git",
|
||||||
|
|||||||
71
CHANGELOG.md
71
CHANGELOG.md
@@ -1,3 +1,74 @@
|
|||||||
|
# [4.6.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.5.0...v4.6.0) (2024-07-26)
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* **classMapper:** add findClassByName back ([2b8d2ae](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/2b8d2ae4dbd9a0c4a59a43be0101a0a8fe1c518f))
|
||||||
|
|
||||||
|
# [4.5.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.4.0...v4.5.0) (2024-07-24)
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* **classMapper:** add classModuleMap, make findClass require ID ([a370c1f](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/a370c1f7d3dca0db56a346c98c28ed9681a415e0))
|
||||||
|
* **webpack:** refactor to prepare for classMapper changes ([d83bada](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/d83bada4af2d16c750955de9a52f94a0080a2c14))
|
||||||
|
|
||||||
|
# [4.4.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.3.1...v4.4.0) (2024-07-18)
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* **utils/react:** add injectFCTrampoline ([44fdf9e](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/44fdf9ed3b9a676a88b0ddc6a1c2c89d46ff7651))
|
||||||
|
|
||||||
|
## [4.3.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.3.0...v4.3.1) (2024-07-17)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **Menu/MenuGroup:** rewrite filter to work on beta and prevent future errors ([d64c42a](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/d64c42ac310d3c3266c4ff610d9ec5ab6c7707b6))
|
||||||
|
|
||||||
|
# [4.3.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.2.2...v4.3.0) (2024-07-09)
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* **utils:** react tree patching api ([2c3a9f8](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/2c3a9f81de0b63364bb31f4a4dd8e559784ece16))
|
||||||
|
|
||||||
|
## [4.2.2](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.2.1...v4.2.2) (2024-07-04)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **SteamSpinner:** add background option ([c04f024](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/c04f024b34b1148c965850965127f9fd44204157))
|
||||||
|
|
||||||
|
## [4.2.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.2.0...v4.2.1) (2024-06-27)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **errorboundary:** work around broken react types ([3ef9648](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/3ef96483550020cecf656b94a73d2bb9313bda07))
|
||||||
|
|
||||||
|
# [4.2.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.1.1...v4.2.0) (2024-06-27)
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* **components:** add ErrorBoundary ([dcdbb2d](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/dcdbb2d6c7c0b72197f04153d7c3e73e9e71ea5c))
|
||||||
|
|
||||||
|
## [4.1.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.1.0...v4.1.1) (2024-06-27)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **ReorderableList:** avoid mutating props ([#109](https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues/109)) ([bd1dc85](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/bd1dc85b9202c8ec6ca994177417574fdd71cbd7))
|
||||||
|
|
||||||
|
# [4.1.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.0.1...v4.1.0) (2024-06-27)
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* **release:** release v4.1.0 ([b040444](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/b04044451a9dc3633fe624e47dd58c7ea206d0a3))
|
||||||
|
|
||||||
## [4.0.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.0.0...v4.0.1) (2024-06-27)
|
## [4.0.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v4.0.0...v4.0.1) (2024-06-27)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@decky/ui",
|
"name": "@decky/ui",
|
||||||
"version": "4.0.3",
|
"version": "4.6.0",
|
||||||
"description": "A library for interacting with the Steam frontend in Decky plugins and elsewhere.",
|
"description": "A library for interacting with the Steam frontend in Decky plugins and elsewhere.",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"types": "dist/index.d.ts",
|
"types": "dist/index.d.ts",
|
||||||
@@ -85,5 +85,9 @@
|
|||||||
"style": "module",
|
"style": "module",
|
||||||
"parser": "typescript"
|
"parser": "typescript"
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
"publishConfig": {
|
||||||
|
"registry": "https://registry.npmjs.org/",
|
||||||
|
"tag": "latest"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
7701
pnpm-lock.yaml
generated
7701
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -1,10 +1,10 @@
|
|||||||
import { Module, findAllModules } from './webpack';
|
import { Module, ModuleID, createModuleMapping } from './webpack';
|
||||||
|
|
||||||
export interface ClassModule {
|
export interface ClassModule {
|
||||||
[name: string]: string;
|
[name: string]: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export const classMap: ClassModule[] = findAllModules((m: Module) => {
|
export const classModuleMap: Map<ModuleID, ClassModule> = createModuleMapping((m: Module) => {
|
||||||
if (typeof m == 'object' && !m.__esModule) {
|
if (typeof m == 'object' && !m.__esModule) {
|
||||||
const keys = Object.keys(m);
|
const keys = Object.keys(m);
|
||||||
// special case some libraries
|
// special case some libraries
|
||||||
@@ -17,8 +17,14 @@ export const classMap: ClassModule[] = findAllModules((m: Module) => {
|
|||||||
return false;
|
return false;
|
||||||
});
|
});
|
||||||
|
|
||||||
export function findClass(name: string): string | void {
|
export const classMap = [...classModuleMap.values()];
|
||||||
return classMap.find((m) => m?.[name])?.[name];
|
|
||||||
|
export function findClass(id: string, name: string): string | void {
|
||||||
|
return classModuleMap.get(id)?.[name];
|
||||||
|
}
|
||||||
|
|
||||||
|
export function findClassByName(name: string): string | void {
|
||||||
|
return classMap.find((m) => m[name])?.[name];
|
||||||
}
|
}
|
||||||
|
|
||||||
export function findClassModule(filter: (module: any) => boolean): ClassModule | void {
|
export function findClassModule(filter: (module: any) => boolean): ClassModule | void {
|
||||||
@@ -26,7 +32,7 @@ export function findClassModule(filter: (module: any) => boolean): ClassModule |
|
|||||||
}
|
}
|
||||||
|
|
||||||
export function unminifyClass(minifiedClass: string): string | void {
|
export function unminifyClass(minifiedClass: string): string | void {
|
||||||
for (let m of classMap) {
|
for (let m of classModuleMap.values()) {
|
||||||
for (let className of Object.keys(m)) {
|
for (let className of Object.keys(m)) {
|
||||||
if (m[className] == minifiedClass) return className;
|
if (m[className] == minifiedClass) return className;
|
||||||
}
|
}
|
||||||
|
|||||||
6
src/components/ErrorBoundary.ts
Normal file
6
src/components/ErrorBoundary.ts
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
import { FC, PropsWithChildren } from "react";
|
||||||
|
import { findModuleExport } from "../webpack";
|
||||||
|
|
||||||
|
export const ErrorBoundary = findModuleExport(
|
||||||
|
(e) => e.InstallErrorReportingStore && e?.prototype?.Reset && e?.prototype?.componentDidCatch,
|
||||||
|
) as FC<PropsWithChildren>; // Actually a class but @types/react is broken lol
|
||||||
@@ -1,7 +1,6 @@
|
|||||||
import { FC, ReactNode } from 'react';
|
import { FC, ReactNode } from 'react';
|
||||||
|
|
||||||
import { fakeRenderComponent } from '../utils';
|
import { Export, findModuleByExport, findModuleExport } from '../webpack';
|
||||||
import { Export, findModuleExport } from '../webpack';
|
|
||||||
import { FooterLegendProps } from './FooterLegend';
|
import { FooterLegendProps } from './FooterLegend';
|
||||||
|
|
||||||
export const showContextMenu: (children: ReactNode, parent?: EventTarget) => void = findModuleExport(
|
export const showContextMenu: (children: ReactNode, parent?: EventTarget) => void = findModuleExport(
|
||||||
@@ -26,12 +25,8 @@ export interface MenuGroupProps {
|
|||||||
children?: ReactNode;
|
children?: ReactNode;
|
||||||
}
|
}
|
||||||
|
|
||||||
export const MenuGroup: FC<MenuGroupProps> = findModuleExport(
|
const MenuGoupModule = findModuleByExport(e => e?.prototype?.Focus && e?.prototype?.OnOKButton && e?.prototype?.render?.toString().includes?.(`"emphasis"==this.props.tone`));
|
||||||
(e: Export) =>
|
export const MenuGroup: FC<MenuGroupProps> = MenuGoupModule && Object.values(MenuGoupModule).find((e: Export) => typeof e == "function" && e?.toString()?.includes("bInGamepadUI:"));
|
||||||
(e?.toString()?.includes?.('bInGamepadUI:') &&
|
|
||||||
fakeRenderComponent(() => e({ overview: { appid: 7 } }), {useContext: () => ({IN_GAMEPADUI: true})})?.type?.prototype?.RenderSubMenu) ||
|
|
||||||
(e?.prototype?.RenderSubMenu && e?.prototype?.ShowSubMenu)
|
|
||||||
);
|
|
||||||
export interface MenuItemProps extends FooterLegendProps {
|
export interface MenuItemProps extends FooterLegendProps {
|
||||||
bInteractableItem?: boolean;
|
bInteractableItem?: boolean;
|
||||||
onClick?(evt: Event): void;
|
onClick?(evt: Event): void;
|
||||||
|
|||||||
@@ -1,7 +1,12 @@
|
|||||||
import { FC, SVGAttributes } from 'react';
|
import { FC, ReactNode, SVGAttributes } from 'react';
|
||||||
|
|
||||||
import { Export, findModuleExport } from '../webpack';
|
import { Export, findModuleExport } from '../webpack';
|
||||||
|
|
||||||
|
interface SteamSpinnerProps {
|
||||||
|
children?: ReactNode;
|
||||||
|
background?: "transparent"; // defaults to black seemingly, but only "transparent" is checked against
|
||||||
|
}
|
||||||
|
|
||||||
export const SteamSpinner = findModuleExport(
|
export const SteamSpinner = findModuleExport(
|
||||||
(e: Export) => e?.toString?.()?.includes('Steam Spinner') && e?.toString?.()?.includes('src'),
|
(e: Export) => e?.toString?.()?.includes('Steam Spinner') && e?.toString?.()?.includes('src'),
|
||||||
) as FC<SVGAttributes<SVGElement>>;
|
) as FC<SVGAttributes<SVGElement> & SteamSpinnerProps>;
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ export * from './ControlsList';
|
|||||||
export * from './Dialog';
|
export * from './Dialog';
|
||||||
export * from './DialogCheckbox';
|
export * from './DialogCheckbox';
|
||||||
export * from './Dropdown';
|
export * from './Dropdown';
|
||||||
|
export * from './ErrorBoundary';
|
||||||
export * from './Field';
|
export * from './Field';
|
||||||
export * from './Focusable';
|
export * from './Focusable';
|
||||||
export * from './FocusRing';
|
export * from './FocusRing';
|
||||||
|
|||||||
@@ -35,12 +35,12 @@ export type ReorderableListProps<T> = {
|
|||||||
export function ReorderableList<T>(props: ReorderableListProps<T>) {
|
export function ReorderableList<T>(props: ReorderableListProps<T>) {
|
||||||
if (props.animate === undefined) props.animate = true;
|
if (props.animate === undefined) props.animate = true;
|
||||||
const [entryList, setEntryList] = useState<ReorderableEntry<T>[]>(
|
const [entryList, setEntryList] = useState<ReorderableEntry<T>[]>(
|
||||||
props.entries.sort((a: ReorderableEntry<T>, b: ReorderableEntry<T>) => a.position - b.position),
|
[...props.entries].sort((a: ReorderableEntry<T>, b: ReorderableEntry<T>) => a.position - b.position),
|
||||||
);
|
);
|
||||||
const [reorderEnabled, setReorderEnabled] = useState<boolean>(false);
|
const [reorderEnabled, setReorderEnabled] = useState<boolean>(false);
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
setEntryList(props.entries.sort((a: ReorderableEntry<T>, b: ReorderableEntry<T>) => a.position - b.position));
|
setEntryList([...props.entries].sort((a: ReorderableEntry<T>, b: ReorderableEntry<T>) => a.position - b.position));
|
||||||
}, [props.entries]);
|
}, [props.entries]);
|
||||||
|
|
||||||
function toggleReorderEnabled(): void {
|
function toggleReorderEnabled(): void {
|
||||||
|
|||||||
@@ -11,12 +11,14 @@ function getQuickAccessWindow(): Window | null {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns state indicating the visibility of quick access menu.
|
* Returns state indicating the visibility of quick access menu.
|
||||||
|
*
|
||||||
|
* @deprecated moved to @decky/api
|
||||||
*
|
*
|
||||||
* @returns `true` if quick access menu is visible and `false` otherwise.
|
* @returns `true` if quick access menu is visible and `false` otherwise.
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* import { FC, useEffect } from "react";
|
* import { FC, useEffect } from "react";
|
||||||
* import { useQuickAccessVisible } from "decky-frontend-lib";
|
* import { useQuickAccessVisible } from "@decky/ui";
|
||||||
*
|
*
|
||||||
* export const PluginPanelView: FC<{}> = ({ }) => {
|
* export const PluginPanelView: FC<{}> = ({ }) => {
|
||||||
* const isVisible = useQuickAccessVisible();
|
* const isVisible = useQuickAccessVisible();
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
export * from './patcher';
|
export * from './patcher';
|
||||||
export * from './react';
|
|
||||||
export * from './static-classes';
|
export * from './static-classes';
|
||||||
|
export * from './react/react';
|
||||||
|
export * from './react/fc';
|
||||||
|
export * from './react/treepatcher';
|
||||||
|
|
||||||
declare global {
|
declare global {
|
||||||
var FocusNavController: any;
|
var FocusNavController: any;
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ export interface PatchOptions {
|
|||||||
singleShot?: boolean;
|
singleShot?: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
type GenericPatchHandler = (args: any[], ret?: any) => any;
|
export type GenericPatchHandler = (args: any[], ret?: any) => any;
|
||||||
|
|
||||||
export interface Patch {
|
export interface Patch {
|
||||||
original: Function;
|
original: Function;
|
||||||
|
|||||||
109
src/utils/react/fc.ts
Normal file
109
src/utils/react/fc.ts
Normal file
@@ -0,0 +1,109 @@
|
|||||||
|
// Utilities for patching function components
|
||||||
|
import { createElement, type FC } from 'react';
|
||||||
|
import { applyHookStubs, removeHookStubs } from './react';
|
||||||
|
import Logger from '../../logger';
|
||||||
|
|
||||||
|
export interface FCTrampoline {
|
||||||
|
component: FC
|
||||||
|
}
|
||||||
|
|
||||||
|
let loggingEnabled = false;
|
||||||
|
|
||||||
|
export function setFCTrampolineLoggingEnabled(value: boolean = true) { loggingEnabled = value };
|
||||||
|
|
||||||
|
let logger = new Logger('FCTrampoline');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Directly hooks a function component from its reference, redirecting it to a user-patchable wrapper in its returned object.
|
||||||
|
* This only works if the original component when called directly returns either nothing, null, or another child element.
|
||||||
|
*
|
||||||
|
* This works by tricking react into thinking it's a class component by cleverly working around its class component checks,
|
||||||
|
* keeping the unmodified function component intact as a mostly working constructor (as it is impossible to direcly modify a function),
|
||||||
|
* stubbing out hooks to prevent errors by detecting setter/getter triggers that occur direcly before/after the class component is instantiated by react,
|
||||||
|
* and creating a fake class component render method to trampoline out into your own handler.
|
||||||
|
*
|
||||||
|
* Due to the nature of this method of hooking a component, please only use this where it is *absolutely necessary.*
|
||||||
|
* Incorrect hook stubs can cause major instability, be careful when writing them. Refer to fakeRenderComponent for the hook stub implementation.
|
||||||
|
* Make sure your hook stubs can handle all the cases they could possibly need to within the component you are injecting into.
|
||||||
|
* You do not need to worry about its children, as they are never called due to the first instance never actually rendering.
|
||||||
|
*/
|
||||||
|
export function injectFCTrampoline(component: FC, customHooks?: any): FCTrampoline {
|
||||||
|
// It needs to be wrapped so React doesn't infinitely call the fake class render method.
|
||||||
|
const newComponent = function (this: any, ...args: any) {
|
||||||
|
loggingEnabled && logger.debug("new component rendering with props", args);
|
||||||
|
return component.apply(this, args);
|
||||||
|
}
|
||||||
|
const userComponent = { component: newComponent };
|
||||||
|
// Create a fake class component render method
|
||||||
|
component.prototype.render = function (...args: any[]) {
|
||||||
|
loggingEnabled && logger.debug("rendering trampoline", args, this);
|
||||||
|
// Pass through rendering via creating the component as a child so React can use function component logic instead of class component logic (setting up the hooks)
|
||||||
|
return createElement(userComponent.component, this.props, this.props.children);
|
||||||
|
};
|
||||||
|
component.prototype.isReactComponent = true;
|
||||||
|
let stubsApplied = false;
|
||||||
|
let oldCreateElement = window.SP_REACT.createElement;
|
||||||
|
|
||||||
|
const applyStubsIfNeeded = () => {
|
||||||
|
if (!stubsApplied) {
|
||||||
|
loggingEnabled && logger.debug("applied stubs");
|
||||||
|
stubsApplied = true;
|
||||||
|
applyHookStubs(customHooks)
|
||||||
|
// we have to redirect this to return an object with component's prototype as a constructor returning a value overrides its prototype
|
||||||
|
window.SP_REACT.createElement = () => {
|
||||||
|
loggingEnabled && logger.debug("createElement hook called");
|
||||||
|
return Object.create(component.prototype);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const removeStubsIfNeeded = () => {
|
||||||
|
if (stubsApplied) {
|
||||||
|
loggingEnabled && logger.debug("removed stubs");
|
||||||
|
stubsApplied = false;
|
||||||
|
removeHookStubs();
|
||||||
|
window.SP_REACT.createElement = oldCreateElement;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Accessed two times, once directly before class instantiation, and again in some extra logic we don't need to worry about that we hanlde below just in case.
|
||||||
|
Object.defineProperty(component, "contextType", {
|
||||||
|
configurable: true,
|
||||||
|
get: function () {
|
||||||
|
loggingEnabled && logger.debug("get contexttype", this, stubsApplied);
|
||||||
|
applyStubsIfNeeded();
|
||||||
|
return this._contextType;
|
||||||
|
},
|
||||||
|
set: function (value) {
|
||||||
|
this._contextType = value;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Undoes the second contextType access we can't detect shortly before render before it's able to cause any damage
|
||||||
|
Object.defineProperty(component, "getDerivedStateFromProps", {
|
||||||
|
configurable: true,
|
||||||
|
get: function () {
|
||||||
|
loggingEnabled && logger.debug("get getDerivedStateFromProps", this, stubsApplied);
|
||||||
|
removeStubsIfNeeded();
|
||||||
|
return this._getDerivedStateFromProps;
|
||||||
|
},
|
||||||
|
set: function (value) {
|
||||||
|
this._getDerivedStateFromProps = value;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Set directly after class is instantiated
|
||||||
|
Object.defineProperty(component.prototype, "updater", {
|
||||||
|
configurable: true,
|
||||||
|
get: function () {
|
||||||
|
return this._updater;
|
||||||
|
},
|
||||||
|
set: function (value) {
|
||||||
|
loggingEnabled && logger.debug("set updater", this, value, stubsApplied);
|
||||||
|
removeStubsIfNeeded();
|
||||||
|
return this._updater = value;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
return userComponent;
|
||||||
|
}
|
||||||
@@ -30,13 +30,15 @@ export function createPropListRegex(propList: string[], fromStart: boolean = tru
|
|||||||
return new RegExp(regexString);
|
return new RegExp(regexString);
|
||||||
}
|
}
|
||||||
|
|
||||||
export function fakeRenderComponent(fun: Function, customHooks: any = {}): any {
|
let oldHooks = {};
|
||||||
|
|
||||||
|
export function applyHookStubs(customHooks: any = {}): any {
|
||||||
const hooks = (window.SP_REACT as any).__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentDispatcher
|
const hooks = (window.SP_REACT as any).__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentDispatcher
|
||||||
.current;
|
.current;
|
||||||
|
|
||||||
// TODO: add more hooks
|
// TODO: add more hooks
|
||||||
|
|
||||||
let oldHooks = {
|
oldHooks = {
|
||||||
useContext: hooks.useContext,
|
useContext: hooks.useContext,
|
||||||
useCallback: hooks.useCallback,
|
useCallback: hooks.useCallback,
|
||||||
useLayoutEffect: hooks.useLayoutEffect,
|
useLayoutEffect: hooks.useLayoutEffect,
|
||||||
@@ -60,9 +62,22 @@ export function fakeRenderComponent(fun: Function, customHooks: any = {}): any {
|
|||||||
|
|
||||||
Object.assign(hooks, customHooks);
|
Object.assign(hooks, customHooks);
|
||||||
|
|
||||||
const res = fun(hooks);
|
return hooks;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function removeHookStubs() {
|
||||||
|
const hooks = (window.SP_REACT as any).__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentDispatcher
|
||||||
|
.current;
|
||||||
Object.assign(hooks, oldHooks);
|
Object.assign(hooks, oldHooks);
|
||||||
|
oldHooks = {};
|
||||||
|
}
|
||||||
|
|
||||||
|
export function fakeRenderComponent(fun: Function, customHooks?: any): any {
|
||||||
|
const hooks = applyHookStubs(customHooks);
|
||||||
|
|
||||||
|
const res = fun(hooks); // TODO why'd we do this?
|
||||||
|
|
||||||
|
removeHookStubs();
|
||||||
|
|
||||||
return res;
|
return res;
|
||||||
}
|
}
|
||||||
100
src/utils/react/treepatcher.ts
Normal file
100
src/utils/react/treepatcher.ts
Normal file
@@ -0,0 +1,100 @@
|
|||||||
|
import Logger from '../../logger';
|
||||||
|
import { GenericPatchHandler, afterPatch } from '../patcher';
|
||||||
|
import { wrapReactClass, wrapReactType } from './react';
|
||||||
|
|
||||||
|
// TODO max size limit? could implement as a class extending map perhaps
|
||||||
|
type PatchedComponentCache = Map<any, any>;
|
||||||
|
export type GenericNodeStep = (node: any) => any;
|
||||||
|
// to patch a specific method of a class component other than render. TODO implement
|
||||||
|
// export type ClassNodeStep = [finder: GenericNodeStep, method: string];
|
||||||
|
// export type NodeStep = GenericNodeStep | ClassNodeStep;
|
||||||
|
export type NodeStep = GenericNodeStep;
|
||||||
|
export type ReactPatchHandler = GenericPatchHandler;
|
||||||
|
|
||||||
|
// These will get *very* spammy.
|
||||||
|
let loggingEnabled = false;
|
||||||
|
let perfLoggingEnabled = false;
|
||||||
|
|
||||||
|
export function setReactPatcherLoggingEnabled(value: boolean = true) { loggingEnabled = value };
|
||||||
|
export function setReactPatcherPerformanceLoggingEnabled(value: boolean = true) { perfLoggingEnabled = value };
|
||||||
|
|
||||||
|
function patchComponent(node: any, handler: GenericPatchHandler, steps: NodeStep[], step: number, caches: PatchedComponentCache[], logger: Logger, prop: string = 'type') {
|
||||||
|
loggingEnabled && logger.group('Patching node:', node);
|
||||||
|
// We need to take extra care to not mutate the original node.type
|
||||||
|
switch (typeof node?.[prop]) {
|
||||||
|
case 'function':
|
||||||
|
// Function component
|
||||||
|
const patch = afterPatch(node, prop, steps[step + 1] ? createStepHandler(handler, steps, step + 1, caches, logger) : handler);
|
||||||
|
loggingEnabled && logger.debug('Patched a function component', patch);
|
||||||
|
break;
|
||||||
|
case 'object':
|
||||||
|
if (node[prop]?.prototype?.render) {
|
||||||
|
// Class component
|
||||||
|
// TODO handle patching custom methods
|
||||||
|
wrapReactClass(node);
|
||||||
|
const patch = afterPatch(node[prop].prototype, 'render', steps[step + 1] ? createStepHandler(handler, steps, step + 1, caches, logger) : handler);
|
||||||
|
loggingEnabled && logger.debug('Patched class component', patch);
|
||||||
|
} else {
|
||||||
|
loggingEnabled && logger.debug('Patching forwardref/memo');
|
||||||
|
wrapReactType(node, prop);
|
||||||
|
// Step down the object
|
||||||
|
patchComponent(node[prop], handler, steps, step, caches, logger, node[prop]?.render ? 'render' : 'type');
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
logger.error('Unhandled component type', node);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
loggingEnabled && logger.groupEnd();
|
||||||
|
}
|
||||||
|
|
||||||
|
function handleStep(tree: any, handler: GenericPatchHandler, steps: NodeStep[], step: number, caches: PatchedComponentCache[], logger: Logger): any {
|
||||||
|
const startTime = (loggingEnabled || perfLoggingEnabled) ? performance.now() : 0;
|
||||||
|
const stepHandler = steps[step];
|
||||||
|
const cache = caches[step] || (caches[step] = new Map());
|
||||||
|
loggingEnabled && logger.debug(`Patch step ${step} running`, { tree, stepHandler, step, caches });
|
||||||
|
|
||||||
|
const node = stepHandler(tree);
|
||||||
|
if (node && node.type) {
|
||||||
|
loggingEnabled && logger.debug('Found node', node);
|
||||||
|
} else if (node) {
|
||||||
|
loggingEnabled && logger.error('Found node without type. Something is probably wrong.', node);
|
||||||
|
return tree;
|
||||||
|
} else {
|
||||||
|
loggingEnabled && logger.warn('Found no node. Depending on your usecase, this might be fine.', node);
|
||||||
|
return tree;
|
||||||
|
}
|
||||||
|
|
||||||
|
let cachedType;
|
||||||
|
if (cachedType = cache.get(node.type)) {
|
||||||
|
loggingEnabled && logger.debug('Found cached patched component', node);
|
||||||
|
node.type = cachedType;
|
||||||
|
(loggingEnabled || perfLoggingEnabled) && logger.debug(`Patch step ${step} took ${performance.now() - startTime}ms with cache`);
|
||||||
|
return tree;
|
||||||
|
}
|
||||||
|
|
||||||
|
const originalType = node.type;
|
||||||
|
|
||||||
|
patchComponent(node, handler, steps, step, caches, logger);
|
||||||
|
|
||||||
|
cache.set(originalType, node.type);
|
||||||
|
|
||||||
|
(loggingEnabled || perfLoggingEnabled) && logger.debug(`Patch step ${step} took ${performance.now() - startTime}ms`);
|
||||||
|
return tree;
|
||||||
|
};
|
||||||
|
|
||||||
|
function createStepHandler(handler: GenericPatchHandler, steps: NodeStep[], step: number, caches: PatchedComponentCache[], logger: Logger) {
|
||||||
|
loggingEnabled && logger.debug(`Creating handler for step ${step}`);
|
||||||
|
return (_: any, tree: any) => handleStep(tree, handler, steps, step, caches, logger);
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO handle createReactTreePatcher inside handler and cache it (or warn)
|
||||||
|
export function createReactTreePatcher(steps: NodeStep[], handler: GenericPatchHandler, debugName: string = 'ReactPatch'): GenericPatchHandler {
|
||||||
|
const caches: PatchedComponentCache[] = [];
|
||||||
|
|
||||||
|
const logger = new Logger(`ReactTreePatcher -> ${debugName}`);
|
||||||
|
|
||||||
|
loggingEnabled && logger.debug('Init with options:', steps, debugName);
|
||||||
|
|
||||||
|
return createStepHandler(handler, steps, 0, caches, logger);
|
||||||
|
}
|
||||||
@@ -9,20 +9,21 @@ declare global {
|
|||||||
const logger = new Logger('Webpack');
|
const logger = new Logger('Webpack');
|
||||||
|
|
||||||
// In most case an object with getters for each property. Look for the first call to r.d in the module, usually near or at the top.
|
// In most case an object with getters for each property. Look for the first call to r.d in the module, usually near or at the top.
|
||||||
|
export type ModuleID = string; // number string
|
||||||
export type Module = any;
|
export type Module = any;
|
||||||
export type Export = any;
|
export type Export = any;
|
||||||
type FilterFn = (module: any) => boolean;
|
type FilterFn = (module: any) => boolean;
|
||||||
type ExportFilterFn = (moduleExport: any, exportName?: any) => boolean;
|
type ExportFilterFn = (moduleExport: any, exportName?: any) => boolean;
|
||||||
type FindFn = (module: any) => any;
|
type FindFn = (module: any) => any;
|
||||||
|
|
||||||
export let modules: any = [];
|
export let modules = new Map<ModuleID, Module>();
|
||||||
|
|
||||||
function initModuleCache() {
|
function initModuleCache() {
|
||||||
const startTime = performance.now();
|
const startTime = performance.now();
|
||||||
logger.group('Webpack Module Init');
|
logger.group('Webpack Module Init');
|
||||||
// Webpack 5, currently on beta
|
// Webpack 5, currently on beta
|
||||||
// Generate a fake module ID
|
// Generate a fake module ID
|
||||||
const id = Math.random(); // really should be an int and not a float but who cares
|
const id = Symbol("@decky/ui");
|
||||||
let webpackRequire!: ((id: any) => Module) & { m: object };
|
let webpackRequire!: ((id: any) => Module) & { m: object };
|
||||||
// Insert our module in a new chunk.
|
// Insert our module in a new chunk.
|
||||||
// The module will then be called with webpack's internal require function as its first argument
|
// The module will then be called with webpack's internal require function as its first argument
|
||||||
@@ -39,14 +40,14 @@ function initModuleCache() {
|
|||||||
);
|
);
|
||||||
|
|
||||||
// Loop over every module ID
|
// Loop over every module ID
|
||||||
for (let i of Object.keys(webpackRequire.m)) {
|
for (let id of Object.keys(webpackRequire.m)) {
|
||||||
try {
|
try {
|
||||||
const module = webpackRequire(i);
|
const module = webpackRequire(id);
|
||||||
if (module) {
|
if (module) {
|
||||||
modules.push(module);
|
modules.set(id, module);
|
||||||
}
|
}
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
logger.debug('Ignoring require error for module', i, e);
|
logger.debug('Ignoring require error for module', id, e);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -56,7 +57,7 @@ function initModuleCache() {
|
|||||||
initModuleCache();
|
initModuleCache();
|
||||||
|
|
||||||
export const findModule = (filter: FilterFn) => {
|
export const findModule = (filter: FilterFn) => {
|
||||||
for (const m of modules) {
|
for (const m of modules.values()) {
|
||||||
if (m.default && filter(m.default)) return m.default;
|
if (m.default && filter(m.default)) return m.default;
|
||||||
if (filter(m)) return m;
|
if (filter(m)) return m;
|
||||||
}
|
}
|
||||||
@@ -65,8 +66,8 @@ export const findModule = (filter: FilterFn) => {
|
|||||||
export const findModuleDetailsByExport = (
|
export const findModuleDetailsByExport = (
|
||||||
filter: ExportFilterFn,
|
filter: ExportFilterFn,
|
||||||
minExports?: number,
|
minExports?: number,
|
||||||
): [module: Module | undefined, moduleExport: any, exportName: any] => {
|
): [module: Module | undefined, moduleExport: any, exportName: any, moduleID: string | undefined] => {
|
||||||
for (const m of modules) {
|
for (const [id, m] of modules) {
|
||||||
if (!m) continue;
|
if (!m) continue;
|
||||||
for (const mod of [m.default, m]) {
|
for (const mod of [m.default, m]) {
|
||||||
if (typeof mod !== 'object') continue;
|
if (typeof mod !== 'object') continue;
|
||||||
@@ -75,7 +76,7 @@ export const findModuleDetailsByExport = (
|
|||||||
if (mod?.[exportName]) {
|
if (mod?.[exportName]) {
|
||||||
const filterRes = filter(mod[exportName], exportName);
|
const filterRes = filter(mod[exportName], exportName);
|
||||||
if (filterRes) {
|
if (filterRes) {
|
||||||
return [mod, mod[exportName], exportName];
|
return [mod, mod[exportName], exportName, id];
|
||||||
} else {
|
} else {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
@@ -83,7 +84,7 @@ export const findModuleDetailsByExport = (
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return [undefined, undefined, undefined];
|
return [undefined, undefined, undefined, undefined];
|
||||||
};
|
};
|
||||||
|
|
||||||
export const findModuleByExport = (filter: ExportFilterFn, minExports?: number) => {
|
export const findModuleByExport = (filter: ExportFilterFn, minExports?: number) => {
|
||||||
@@ -98,7 +99,7 @@ export const findModuleExport = (filter: ExportFilterFn, minExports?: number) =>
|
|||||||
* @deprecated use findModuleExport instead
|
* @deprecated use findModuleExport instead
|
||||||
*/
|
*/
|
||||||
export const findModuleChild = (filter: FindFn) => {
|
export const findModuleChild = (filter: FindFn) => {
|
||||||
for (const m of modules) {
|
for (const m of modules.values()) {
|
||||||
for (const mod of [m.default, m]) {
|
for (const mod of [m.default, m]) {
|
||||||
const filterRes = filter(mod);
|
const filterRes = filter(mod);
|
||||||
if (filterRes) {
|
if (filterRes) {
|
||||||
@@ -110,10 +111,13 @@ export const findModuleChild = (filter: FindFn) => {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated use createModuleMapping instead
|
||||||
|
*/
|
||||||
export const findAllModules = (filter: FilterFn) => {
|
export const findAllModules = (filter: FilterFn) => {
|
||||||
const out = [];
|
const out = [];
|
||||||
|
|
||||||
for (const m of modules) {
|
for (const m of modules.values()) {
|
||||||
if (m.default && filter(m.default)) out.push(m.default);
|
if (m.default && filter(m.default)) out.push(m.default);
|
||||||
if (filter(m)) out.push(m);
|
if (filter(m)) out.push(m);
|
||||||
}
|
}
|
||||||
@@ -121,7 +125,18 @@ export const findAllModules = (filter: FilterFn) => {
|
|||||||
return out;
|
return out;
|
||||||
};
|
};
|
||||||
|
|
||||||
export const CommonUIModule = modules.find((m: Module) => {
|
export const createModuleMapping = (filter: FilterFn) => {
|
||||||
|
const mapping = new Map<ModuleID, Module>();
|
||||||
|
|
||||||
|
for (const [id, m] of modules) {
|
||||||
|
if (m.default && filter(m.default)) mapping.set(id, m.default);
|
||||||
|
if (filter(m)) mapping.set(id, m);
|
||||||
|
}
|
||||||
|
|
||||||
|
return mapping;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const CommonUIModule = findModule((m: Module) => {
|
||||||
if (typeof m !== 'object') return false;
|
if (typeof m !== 'object') return false;
|
||||||
for (let prop in m) {
|
for (let prop in m) {
|
||||||
if (m[prop]?.contextType?._currentValue && Object.keys(m).length > 60) return true;
|
if (m[prop]?.contextType?._currentValue && Object.keys(m).length > 60) return true;
|
||||||
|
|||||||
Reference in New Issue
Block a user