mirror of
https://github.com/SteamDeckHomebrew/decky-frontend-lib.git
synced 2026-05-20 10:00:08 +02:00
Compare commits
27 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d18b1ba1ed | ||
|
|
6be06446f2 | ||
|
|
bb8a6df115 | ||
|
|
a672230b00 | ||
|
|
4644df8202 | ||
|
|
7d3b5e8123 | ||
|
|
0a4ef14239 | ||
|
|
a592883a2e | ||
|
|
3f126fe471 | ||
|
|
e644de35d7 | ||
|
|
9b79f70ac7 | ||
|
|
d237bd48e4 | ||
|
|
f7d73b4dc3 | ||
|
|
9edb1e6b97 | ||
|
|
605e4f5eae | ||
|
|
e2f675835e | ||
|
|
b7dc1d6275 | ||
|
|
a1fdae9cd2 | ||
|
|
7cf45cf371 | ||
|
|
df1c8dbb8b | ||
|
|
1de979f713 | ||
|
|
f23070a82a | ||
|
|
b87e7c2f40 | ||
|
|
6db29a9a6e | ||
|
|
e2126afd06 | ||
|
|
cea587958e | ||
|
|
b21dfcdb66 |
@@ -1,7 +1,15 @@
|
||||
{
|
||||
"branches": ["main", "dev"],
|
||||
"plugins": [
|
||||
"@semantic-release/commit-analyzer",
|
||||
[
|
||||
"@semantic-release/commit-analyzer",
|
||||
{
|
||||
"preset": "angular",
|
||||
"releaseRules": [
|
||||
{"type": "chore", "scope": "classes", "release": "patch"}
|
||||
]
|
||||
}
|
||||
],
|
||||
"@semantic-release/release-notes-generator",
|
||||
"@semantic-release/changelog",
|
||||
"@semantic-release/npm",
|
||||
|
||||
79
CHANGELOG.md
79
CHANGELOG.md
@@ -1,3 +1,82 @@
|
||||
## [1.7.5](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.7.4...v1.7.5) (2022-08-18)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **ButtonItem:** update to account for both prop settings ([6be0644](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/6be06446f2a7e0357b830be116fd25810c427dd5))
|
||||
|
||||
## [1.7.4](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.7.3...v1.7.4) (2022-08-18)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* updates for webpack v5 ([a672230](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/a672230b0051dd942988554ec663ea7bfcd61cfe))
|
||||
|
||||
## [1.7.3](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.7.2...v1.7.3) (2022-08-17)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **Router:** Add more members to Router interface ([#12](https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues/12)) ([7d3b5e8](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/7d3b5e8123f6eeead1e2e227985069e54fe52572))
|
||||
|
||||
## [1.7.2](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.7.1...v1.7.2) (2022-08-17)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **utils:** allow prop reassigns to fail ([a592883](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/a592883a2eba52ba18876989acf939d12fa61fd3))
|
||||
|
||||
## [1.7.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.7.0...v1.7.1) (2022-08-17)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **utils:** better method to wrap react classes ([e644de3](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/e644de35d70680d17d70e89cc9b929a5aae08b48))
|
||||
|
||||
# [1.7.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.6.2...v1.7.0) (2022-08-17)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **utils:** add wrapReactClass ([d237bd4](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/d237bd48e4b9e6436d7daefdf70327875e9e940d))
|
||||
|
||||
## [1.6.2](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.6.1...v1.6.2) (2022-08-15)
|
||||
|
||||
## [1.6.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.6.0...v1.6.1) (2022-08-13)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **wrapReactType:** try another method ([b7dc1d6](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/b7dc1d6275ed28b1e37b6cb512b2c5d1600a8f63))
|
||||
|
||||
# [1.6.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.5.1...v1.6.0) (2022-08-13)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **Utilities:** add wrapReactType utility ([7cf45cf](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/7cf45cf3718d6e5295115f28a5f4dd24c6ff14e3))
|
||||
|
||||
## [1.5.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.5.0...v1.5.1) (2022-08-10)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **security:** update for minimist pollution exploit ([1de979f](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/1de979f7135c8d5eea1faca3d480d662c5e41d3d))
|
||||
|
||||
# [1.5.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.4.0...v1.5.0) (2022-08-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **ServerAPI:** add Toaster to serverAPI ([e2126af](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/e2126afd06f339a22dbbaea89b834157a5975b96))
|
||||
|
||||
# [1.4.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.3.0...v1.4.0) (2022-08-08)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **utils:** add findInTree and findInReactTree ([b21dfcd](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/b21dfcdb661fd7ad43213756dadb6cfdf0ac1e94))
|
||||
|
||||
# [1.3.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.2.4...v1.3.0) (2022-08-02)
|
||||
|
||||
|
||||
|
||||
946
package-lock.json
generated
946
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "decky-frontend-lib",
|
||||
"version": "1.3.0",
|
||||
"version": "1.7.5",
|
||||
"description": "A library for building decky plugins",
|
||||
"main": "dist/index.js",
|
||||
"types": "dist/index.d.ts",
|
||||
@@ -54,7 +54,7 @@
|
||||
"import-sort-style-module": "^6.0.0",
|
||||
"jest": "^27.5.1",
|
||||
"prettier-plugin-import-sort": "^0.0.7",
|
||||
"semantic-release": "^19.0.2",
|
||||
"semantic-release": "^19.0.3",
|
||||
"shx": "^0.3.4",
|
||||
"ts-jest": "^27.1.4",
|
||||
"typescript": "^4.6.3"
|
||||
@@ -72,5 +72,8 @@
|
||||
"style": "module",
|
||||
"parser": "typescript"
|
||||
}
|
||||
},
|
||||
"dependencies": {
|
||||
"minimist": "^1.2.6"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -9,5 +9,5 @@ export interface ButtonItemProps extends ItemProps {
|
||||
}
|
||||
|
||||
export const ButtonItem = Object.values(CommonUIModule).find((mod: any) =>
|
||||
mod?.render?.toString()?.includes('childrenContainerWidth:"min"'),
|
||||
mod?.render?.toString()?.includes('"highlightOnFocus","childrenContainerWidth"') || mod?.render?.toString()?.includes('childrenContainerWidth:"min"'),
|
||||
) as FC<ButtonItemProps>;
|
||||
|
||||
@@ -69,14 +69,24 @@ export interface Router {
|
||||
GetQuickAccessTab(): QuickAccessTab;
|
||||
Navigate(path: string): void;
|
||||
NavigateBackOrOpenMenu(): void;
|
||||
NavigateToAppProperties(): void
|
||||
NavigateToBugForum(): void
|
||||
NavigateToExternalWeb(url: string): void;
|
||||
NavigateToHelp(): void
|
||||
NavigateToInvites(): void
|
||||
NavigateToRunningApp(replace?: boolean): void;
|
||||
NavigateToStore(): void;
|
||||
NavigateToStorage(): void
|
||||
NavigateToStore(): void
|
||||
NavigateToStoreApp(appId: number | string): void
|
||||
NavigateToStoreFreeToPlay(): void
|
||||
NavigateToStoreManual(): void
|
||||
NavigateToStoreNewReleases(): void
|
||||
NavigateToStoreOnSale(): void
|
||||
ToggleSideMenu(sideMenu: SideMenu): void;
|
||||
CloseSideMenus(): void;
|
||||
OpenSideMenu(sideMenu: SideMenu): void;
|
||||
OpenPowerMenu(unknown?: any): void;
|
||||
get RunningApps(): any;
|
||||
get RunningApps(): AppOverview[];
|
||||
get MainRunningApp(): AppOverview | undefined;
|
||||
}
|
||||
|
||||
|
||||
@@ -63,6 +63,14 @@ type StaticClasses = Record<
|
||||
string
|
||||
>;
|
||||
|
||||
type ScrollClasses = Record<
|
||||
| 'ScrollBoth'
|
||||
| 'ScrollPanel'
|
||||
| 'ScrollX'
|
||||
| 'ScrollY',
|
||||
string
|
||||
>;
|
||||
|
||||
type GamepadDialogClasses = Record<
|
||||
| 'duration-app-launch'
|
||||
| 'GamepadDialogContent'
|
||||
@@ -167,6 +175,16 @@ export const staticClasses: StaticClasses = findModule((mod) => {
|
||||
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;
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import type { ComponentType } from 'react';
|
||||
import type { ComponentType, ReactNode } from 'react';
|
||||
import { RouteProps } from 'react-router';
|
||||
|
||||
export interface Plugin {
|
||||
@@ -22,15 +22,32 @@ type ServerResponse<TRes> = ServerResponseSuccess<TRes> | ServerResponseError;
|
||||
|
||||
type RoutePatch = (route: RouteProps) => RouteProps;
|
||||
|
||||
interface RouterHook {
|
||||
export interface RouterHook {
|
||||
addRoute(path: string, component: ComponentType, props?: Omit<RouteProps, 'path' | 'children'>): void;
|
||||
addPatch(path: string, patch: RoutePatch): RoutePatch;
|
||||
removePatch(path: string, patch: RoutePatch): void;
|
||||
removeRoute(path: string): void;
|
||||
}
|
||||
|
||||
export interface ToastData {
|
||||
title: ReactNode;
|
||||
body: ReactNode;
|
||||
onClick?: () => void;
|
||||
logo?: ReactNode;
|
||||
icon?: ReactNode;
|
||||
className?: string;
|
||||
contentClassName?: string;
|
||||
duration?: number
|
||||
critical?: boolean
|
||||
}
|
||||
|
||||
export interface Toaster {
|
||||
toast(toast: ToastData): void;
|
||||
}
|
||||
|
||||
export interface ServerAPI {
|
||||
routerHook: RouterHook;
|
||||
toaster: Toaster;
|
||||
callPluginMethod<TArgs = {}, TRes = {}>(methodName: string, args: TArgs): Promise<ServerResponse<TRes>>;
|
||||
callServerMethod<TArgs = {}, TRes = {}>(methodName: string, args: TArgs): Promise<ServerResponse<TRes>>;
|
||||
fetchNoCors<TRes = {}>(url: RequestInfo, request?: RequestInit): Promise<ServerResponse<TRes>>;
|
||||
|
||||
52
src/utils.ts
52
src/utils.ts
@@ -82,6 +82,27 @@ 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"];
|
||||
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;
|
||||
}
|
||||
|
||||
export function getReactInstance(o: HTMLElement | Element | Node) {
|
||||
return o[Object.keys(o).find(k => k.startsWith('__reactInternalInstance')) as string]
|
||||
}
|
||||
@@ -92,4 +113,33 @@ export function joinClassNames(...classes: string[]): string {
|
||||
|
||||
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[],
|
||||
ignore?: string[]
|
||||
}
|
||||
|
||||
export declare type findInTreeFilter = (element: any) => boolean
|
||||
|
||||
export const findInTree = (parent: any, filter: findInTreeFilter, opts: findInTreeOpts): any => {
|
||||
const { walkable = null, ignore = [] } = opts ?? {};
|
||||
|
||||
if (!parent || typeof parent !== 'object') { // Parent is invalid to search through
|
||||
return null;
|
||||
}
|
||||
|
||||
if (filter(parent)) return parent; // Parent matches, just return
|
||||
|
||||
if (Array.isArray(parent)) { // Parent is an array, go through values
|
||||
return parent.map((x) => findInTree(x, filter, opts)).find((x) => x);
|
||||
}
|
||||
|
||||
// Parent is an object, go through values (or option to only use certain keys)
|
||||
return (walkable || Object.keys(parent)).map((x) => !ignore.includes(x) && findInTree(parent[x], filter, opts)).find((x: any) => x);
|
||||
};
|
||||
|
||||
export const findInReactTree = (node: any, filter: findInTreeFilter) => findInTree(node, filter, { // Specialised findInTree for React nodes
|
||||
walkable: [ 'props', 'children', 'child', 'sibling' ]
|
||||
});
|
||||
@@ -1,6 +1,7 @@
|
||||
declare global {
|
||||
interface Window {
|
||||
webpackJsonp: any;
|
||||
webpackChunksteamui: any;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -9,14 +10,33 @@ export type Module = any;
|
||||
type FilterFn = (module: any) => boolean;
|
||||
type FindFn = (module: any) => any;
|
||||
|
||||
const wpRequire = window.webpackJsonp.push([
|
||||
[],
|
||||
{ get_require: (mod: any, _exports: any, wpRequire: any) => (mod.exports = wpRequire) },
|
||||
[['get_require']],
|
||||
]);
|
||||
export let webpackCache: any = {};
|
||||
let hasWebpack5 = false;
|
||||
|
||||
export const allModules: Module[] = Object.keys(wpRequire.c)
|
||||
.map((x) => wpRequire.c[x].exports)
|
||||
if (window.webpackJsonp && !window.webpackJsonp.deckyShimmed) {
|
||||
// Webpack 4, currently on stable
|
||||
const wpRequire = window.webpackJsonp.push([
|
||||
[],
|
||||
{ get_require: (mod: any, _exports: any, wpRequire: any) => (mod.exports = wpRequire) },
|
||||
[['get_require']],
|
||||
]);
|
||||
|
||||
delete wpRequire.m.get_require;
|
||||
delete wpRequire.c.get_require;
|
||||
webpackCache = wpRequire.c;
|
||||
} else {
|
||||
// Webpack 5, currently on beta
|
||||
hasWebpack5 = true;
|
||||
const id = Math.random();
|
||||
let initReq: any;
|
||||
window.webpackChunksteamui.push([[ id ], {}, (r: any) => { initReq = r }]);
|
||||
for (let i of Object.keys(initReq.m)) {
|
||||
webpackCache[i] = initReq(i)
|
||||
}
|
||||
}
|
||||
|
||||
export const allModules: Module[] = hasWebpack5 ? Object.values(webpackCache).filter((x) => x) : Object.keys(webpackCache)
|
||||
.map((x) => webpackCache[x].exports)
|
||||
.filter((x) => x);
|
||||
|
||||
export const findModule = (filter: FilterFn) => {
|
||||
|
||||
Reference in New Issue
Block a user