chore(release): 0.2.0 [CI SKIP]

.commitlintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["@commitlint/config-conventional"]
+}

.github/workflows/release.yaml

@@ -0,0 +1,29 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Setup | Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Setup | Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - name: Setup | Dependencies
+        run: npm ci
+      - name: Test
+        run: npm test
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm exec semantic-release

.gitignore

@@ -35,3 +35,6 @@ Thumbs.db
 dist/
 
 research/
+
+# PNPM lockfile
+pnpm-lock.yaml

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit "${1}"

.releaserc.json

@@ -0,0 +1,17 @@
+{
+  "branches": ["main", "dev"],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    "@semantic-release/npm",
+    "@semantic-release/github",
+    [
+      "@semantic-release/git",
+      {
+        "assets": ["CHANGELOG.md", "package.json"],
+        "message": "chore(release): ${nextRelease.version} [CI SKIP]"
+      }
+    ]
+  ]
+}

CHANGELOG.md

@@ -0,0 +1,13 @@
+# [0.2.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.1.0...v0.2.0) (2022-06-04)
+
+
+### Features
+
+* **router:** expose GetQuickAccessTab and rename QuickAccessTabs to QuickAccessTab ([bf0c2b1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/bf0c2b17bfc4e67a8aa90cfee6a91bd1482720d4))
+
+# [0.1.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.0.6...v0.1.0) (2022-06-04)
+
+
+### Features
+
+* **router:** types for steam router ([62bf0ea](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/62bf0eaffa83d85245a038ffe3819315bd02f045))

globals.d.ts

@@ -0,0 +1,5 @@
+declare global {
+    interface Window {
+        SP_REACT: typeof React;
+    }
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "decky-frontend-lib",
-  "version": "0.0.2",
+  "version": "0.2.0",
   "description": "A library for building decky plugins",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,7 +9,9 @@
     "build": "shx rm -rf dist && tsc -b",
     "dev": "tsc -b -w",
     "prepack": "npm run build",
-    "test": "jest"
+    "test": "echo 'No tests for now!'",
+    "postinstall": "husky install",
+    "commit": "git-cz"
   },
   "files": [
     "/lib",
@@ -32,12 +34,26 @@
     "url": "https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues"
   },
   "homepage": "https://github.com/SteamDeckHomebrew/decky-frontend-lib#readme",
+  "config": {
+    "commitizen": {
+      "path": "@commitlint/cz-commitlint"
+    }
+  },
   "devDependencies": {
+    "@commitlint/cli": "^17.0.2",
+    "@commitlint/config-conventional": "^17.0.2",
+    "@commitlint/cz-commitlint": "^17.0.0",
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/git": "^10.0.1",
     "@types/jest": "^27.4.1",
     "@types/react": "16.14.0",
+    "@types/react-router": "5.1.18",
+    "commitizen": "^4.2.4",
+    "husky": "^8.0.1",
     "import-sort-style-module": "^6.0.0",
     "jest": "^27.5.1",
     "prettier-plugin-import-sort": "^0.0.7",
+    "semantic-release": "^19.0.2",
     "shx": "^0.3.4",
     "ts-jest": "^27.1.4",
     "typescript": "^4.6.3"

src/deck-components/Button.tsx

@@ -3,14 +3,27 @@ import { FC } from 'react';
 import { CommonUIModule } from '../webpack';
 
 interface ButtonProps {
-  label?: string;
-  description?: string;
-  layout?: 'below';
-  onClick?(e: MouseEvent): void;
+  className?: string;
+  noFocusRing?: boolean;
   disabled?: boolean;
-  bottomSeparator?: boolean;
+  onClick?(e: MouseEvent): void;
+  onPointerDown?(e: PointerEvent): void;
+  onPointerUp?(e: PointerEvent): void;
+  onPointerCancel?(e: PointerEvent): void;
+  onMouseDown?(e: PointerEvent): void;
+  onMouseUp?(e: MouseEvent): void;
+  onTouchStart?(e: TouchEvent): void;
+  onTouchEnd?(e: TouchEvent): void;
+  onTouchCancel?(e: TouchEvent): void;
+  onSubmit?(e: SubmitEvent): void;
 }
 
-export const Button = Object.values(CommonUIModule).find((mod: any) =>
-  mod?.render?.toString()?.includes('childrenContainerWidth:"min"'),
-) as FC<ButtonProps>;
+export const DialogButton = Object.values(CommonUIModule).find(
+  (mod: any) =>
+    mod?.render?.toString()?.includes('Object.assign({type:"button"') &&
+    mod?.render?.toString()?.includes('DialogButton'),
+) as any;
+
+// Button isn't exported, so call DialogButton to grab it
+
+export const Button = DialogButton!.render({}).type as FC<ButtonProps>; // its actually a forwarded ref but that doesn't really matter in usage

src/deck-components/ButtonItem.tsx

@@ -0,0 +1,17 @@
+import { FC } from 'react';
+
+import { CommonUIModule } from '../webpack';
+
+interface ButtonItemProps {
+  label?: string;
+  description?: string;
+  layout?: 'below';
+  icon?: JSX.Element;
+  onClick?(e: MouseEvent): void;
+  disabled?: boolean;
+  bottomSeparator?: boolean;
+}
+
+export const ButtonItem = Object.values(CommonUIModule).find((mod: any) =>
+  mod?.render?.toString()?.includes('childrenContainerWidth:"min"'),
+) as FC<ButtonItemProps>;

src/deck-components/Menu.tsx

@@ -1,7 +1,16 @@
-import { FC } from 'react';
+import { FC, ReactNode } from 'react';
 
 import { findModuleChild } from '../webpack';
 
+export const showContextMenu: (children: ReactNode, parent?: EventTarget) => void = findModuleChild((m) => {
+  if (typeof m !== 'object') return undefined;
+  for (let prop in m) {
+    if (typeof m[prop] === 'function' && m[prop].toString().includes('stopPropagation))')) {
+      return m[prop];
+    }
+  }
+});
+
 interface MenuProps {
   label: string;
   onCancel?(): void;

src/deck-components/Modal.tsx

@@ -1,12 +1,28 @@
-import { ReactNode } from 'react';
-
+import { FC, ReactNode } from 'react';
 import { findModuleChild } from '../webpack';
 
-export const showModal: (children: ReactNode, parent: EventTarget) => void = findModuleChild((m) => {
+// TODO: there is another argument, figure out what it does
+export const showModal: (children: ReactNode, parent?: EventTarget) => void = findModuleChild((m) => {
   if (typeof m !== 'object') return undefined;
   for (let prop in m) {
-    if (typeof m[prop] === 'function' && m[prop].toString().includes('stopPropagation))')) {
+    if (typeof m[prop] === 'function' && m[prop].toString().includes('bHideMainWindowForPopouts:!0')) {
       return m[prop];
     }
   }
 });
+
+interface ModalRootProps {
+  onMiddleButton?(): void,
+  onCancel?(): void;
+  onOK?(): void;
+  bAllowFullSize?: boolean;
+}
+
+export const ModalRoot = findModuleChild(m => {
+  if (typeof m !== "object") return undefined;
+  for (let prop in m) {
+    if (!m[prop]?.prototype?.OK && m[prop]?.prototype?.Cancel && m[prop]?.prototype?.render) {
+      return m[prop];
+    }
+  }
+}) as FC<ModalRootProps>;

src/deck-components/Panel.tsx

@@ -0,0 +1,23 @@
+import { FC } from 'react';
+
+import { findModuleChild } from '../webpack';
+
+interface PanelSectionProps {
+  title?: string;
+  spinner?: boolean;
+}
+
+const [panelSection, mod] = findModuleChild((mod: any) => {
+  for (let prop in mod) {
+    if (mod[prop]?.toString()?.includes('.PanelSection')) {
+      return [mod[prop], mod];
+    }
+  }
+  return null;
+});
+
+export const PanelSection = panelSection as FC<PanelSectionProps>;
+
+export const PanelSectionRow = Object.values(mod).filter(
+  (exp: any) => !exp?.toString()?.includes('.PanelSection'),
+)[0] as FC;

src/deck-components/Router.tsx

@@ -0,0 +1,37 @@
+import { Module, findModuleChild } from '../webpack';
+
+export enum SideMenu {
+  None,
+  Main,
+  QuickAccess,
+}
+
+export enum QuickAccessTab {
+  Notifications,
+  RemotePlayTogetherControls,
+  VoiceChat,
+  Friends,
+  Settings,
+  Perf,
+  Help,
+  Decky,
+}
+
+interface Router {
+  CloseSideMenus(): void;
+  OpenQuickAccessMenu(quickAccessTab: QuickAccessTab): void;
+  GetQuickAccessTab(): QuickAccessTab;
+  NavigateToExternalWeb(url: string): void;
+  ToggleSideMenu(sideMenu: SideMenu): void;
+  CloseSideMenus(): void;
+  OpenSideMenu(sideMenu: SideMenu): void;
+  OpenPowerMenu(unknown?: any): void;
+  get RunningApps(): any;
+}
+
+export const Router = findModuleChild((m: Module) => {
+  if (typeof m !== 'object') return undefined;
+  for (let prop in m) {
+    if (m[prop]?.Navigate && m[prop]?.NavigationManager) return m[prop];
+  }
+}) as Router;

src/deck-components/Spinner.tsx

@@ -0,0 +1,8 @@
+import { FC } from 'react';
+
+import { IconsModule } from '../webpack';
+
+// TODO type this and other icons?
+export const Spinner = Object.values(IconsModule).find((mod: any) =>
+    mod?.toString && /Spinner\)}\),.\.createElement\(\"path\",{d:\"M18 /.test(mod.toString())
+) as FC<{}>;

src/deck-components/SteamSpinner.tsx

@@ -0,0 +1,9 @@
+import { FC } from 'react';
+import { findModuleChild } from '../webpack';
+
+export const SteamSpinner = findModuleChild((m) => {
+    if (typeof m !== "object") return undefined;
+    for (let prop in m) {
+      if (m[prop]?.toString()?.includes("Steam Spinner") && m[prop].toString().includes("PreloadThrobber")) return m[prop]
+    }
+}) as FC<{}>;

src/deck-components/index.ts

@@ -1,6 +1,11 @@
 export * from './Button';
+export * from './ButtonItem';
 export * from './Menu';
 export * from './Modal';
+export * from './Panel';
+export * from './Router';
 export * from './Slider';
+export * from './Spinner';
 export * from './static-classes';
+export * from './SteamSpinner';
 export * from './Toggle';

src/plugin.tsx

@@ -1,3 +1,6 @@
+import type { ComponentType } from 'react';
+import { RouteProps } from 'react-router';
+
 export interface Plugin {
   title: JSX.Element;
   icon: JSX.Element;
@@ -17,7 +20,13 @@ interface ServerResponseError {
 
 type ServerResponse<TRes> = ServerResponseSuccess<TRes> | ServerResponseError;
 
+interface RouterHook {
+  addRoute(path: string, component: ComponentType, props?: Omit<RouteProps, 'path' | 'children'>): void;
+  removeRoute(path: string): void;
+}
+
 export interface ServerAPI {
+  routerHook: RouterHook;
   callPluginMethod<TArgs = {}, TRes = {}>(methodName: string, args: TArgs): Promise<ServerResponse<TRes>>;
   callServerMethod<TArgs = {}, TRes = {}>(methodName: string, args: TArgs): Promise<ServerResponse<TRes>>;
   fetchNoCors<TRes = {}>(url: string, request: RequestInfo): Promise<ServerResponse<TRes>>;

src/utils.ts

@@ -1,35 +1,41 @@
-export function sleep(ms: number): Promise<void> {
-    return new Promise(resolve => setTimeout(resolve, ms));
-}
+import * as React from "react";
+
+// this shouldn't need to be redeclared but it does for some reason
 
 declare global {
     interface Window {
-        SP_REACT: any;
+      SP_REACT: typeof React;
     }
 }
 
 export function fakeRenderComponent(fun: Function): any {
-    const hooks = window.SP_REACT.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentDispatcher.current;
+    const hooks = (window.SP_REACT as any).__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentDispatcher.current;
 
     // TODO: add more hooks
 
     let oldHooks = {
         useContext: hooks.useContext,
         useCallback: hooks.useCallback,
+        useLayoutEffect: hooks.useLayoutEffect,
         useEffect: hooks.useEffect,
+        useMemo: hooks.useMemo,
+        useRef: hooks.useRef,
         useState: hooks.useState,
     }
 
     hooks.useCallback = (cb: Function) => cb;
-    hooks.useContext = (cb: Function) => cb;
-    hooks.useEffect = (cb: Function) => cb();
+    hooks.useContext = (cb: any) => cb._currentValue;
+    hooks.useLayoutEffect = (_: Function) => {}//cb();
+    hooks.useMemo = (cb: Function, _: any[]) => cb;
+    hooks.useEffect = (_: Function) => {}//cb();
+    hooks.useRef = (val: any) => ({current: val || {}});
     hooks.useState = (v: any) => {
         let val = v;
 
         return [val, (n: any) => val = n];
     };
 
-    const res = fun();
+    const res = fun(hooks);
 
     Object.assign(hooks, oldHooks);
 
@@ -50,8 +56,8 @@ export function beforePatch(obj: any, name: string, fnc: Function): void {
 export function afterPatch(obj: any, name: string, fnc: Function): void {
     const orig = obj[name];
     obj[name] = function (...args: any[]) {
-        let ret = orig.apply(...args);
-        ret = fnc(ret);
+        let ret = orig.call(this, ...args);
+        ret = fnc.call(this, args, ret);
         return ret;
     }
     Object.assign(obj[name], orig);
@@ -59,7 +65,23 @@ export function afterPatch(obj: any, name: string, fnc: Function): void {
     obj[name].__deckyOrig = orig;
 }
 
+export function replacePatch(obj: any, name: string, fnc: Function): 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 getReactInstance(o: HTMLElement | Element | Node) {
+    return o[Object.keys(o).find(k => k.startsWith('__reactInternalInstance')) as string]
+}

src/webpack.ts

@@ -5,7 +5,7 @@ declare global {
 }
 
 // TODO
-type Module = any;
+export type Module = any;
 type FilterFn = (module: any) => boolean;
 type FindFn = (module: any) => any;
 
@@ -58,7 +58,18 @@ export const CommonUIModule = allModules.find((m: Module) => {
   return false;
 });
 
-export const Router = findModuleChild((m: Module) => {
-  if (typeof m !== "object") return undefined;
-  for (let prop in m) { if (m[prop]?.Navigate && m[prop]?.NavigationManager) return m[prop]}
-})
+export const IconsModule = findModule((m: Module) => {
+  if (typeof m !== 'object') return false;
+  for (let prop in m) {
+    if (m[prop]?.toString && /Spinner\)}\),.\.createElement\(\"path\",{d:\"M18 /.test(m[prop].toString())) return true;
+  }
+  return false;
+});
+
+export const ReactRouter = allModules.find((m: Module) => {
+  if (typeof m !== 'object') return undefined;
+  for (let prop in m) {
+    if (m[prop]?.computeRootMatch) return true;
+  }
+  return false;
+});

tsconfig.json

@@ -3,7 +3,8 @@
     "outDir": "dist",
     "module": "ESNext",
     "target": "ES2020",
-    "jsx": "react-jsx",
+    "jsx": "react",
+    "jsxFactory": "window.SP_REACT.createElement",
     "declaration": true,
     "moduleResolution": "node",
     "noUnusedLocals": true,
@@ -17,6 +18,6 @@
     "allowSyntheticDefaultImports": true,
     "skipLibCheck": true
   },
-  "include": ["src"],
+  "include": ["src", "globals.d.ts"],
   "exclude": ["node_modules"]
 }