chore(release): 0.3.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

.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,20 @@
+# [0.3.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.2.0...v0.3.0) (2022-06-04)
+
+
+### Features
+
+* **typings:** add Navigate to router typings ([f124480](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/f124480af8082d24730ed03fdf88742f76abc026))
+
+# [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))

package.json

@@ -1,6 +1,6 @@
 {
   "name": "decky-frontend-lib",
-  "version": "0.0.4",
+  "version": "0.3.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/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/Router.tsx

@@ -0,0 +1,38 @@
+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;
+  Navigate(path: string): void;
+  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

@@ -2,15 +2,7 @@ import { FC } from 'react';
 
 import { IconsModule } from '../webpack';
 
-// interface ButtonProps {
-//   label?: string;
-//   description?: string;
-//   layout?: 'below';
-//   onClick?(e: MouseEvent): void;
-//   disabled?: boolean;
-//   bottomSeparator?: boolean;
-// }
-
+// 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

@@ -3,7 +3,9 @@ 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/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;
 
@@ -59,23 +59,17 @@ export const CommonUIModule = allModules.find((m: Module) => {
 });
 
 export const IconsModule = findModule((m: Module) => {
-  if (typeof m !== "object") return false;
+  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 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 ReactRouter = allModules.find((m: Module) => {
-  if (typeof m !== "object") return undefined;
+  if (typeof m !== 'object') return undefined;
   for (let prop in m) {
-    if (m[prop]?.computeRootMatch) return true
+    if (m[prop]?.computeRootMatch) return true;
   }
   return false;
-})
+});