chore(release): 0.6.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,73 @@
+# [0.6.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.5.1...v0.6.0) (2022-06-08)
+
+
+### Bug Fixes
+
+* **husky:** wrong script for husky caused problems when installing ([bc2bec4](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/bc2bec4b839d691e20beb090327a359c9e93f1cc))
+
+
+### Features
+
+* **dropdown:** add dropdown ([a99fb4a](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/a99fb4a22dcea3b6cd2a52f0dbd274d9a10f2e35))
+* **sidebar-navigation:** add sidebar navigation component ([d8794ef](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/d8794ef4d36b25e600123d41696b0d5cc10dc2af))
+
+## [0.5.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.5.0...v0.5.1) (2022-06-06)
+
+
+### Bug Fixes
+
+* **classes:** switch static-classes to findModule ([244ae12](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/244ae128da03e0687f1ba0b0e5b5b548b581277a))
+
+# [0.5.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.4.2...v0.5.0) (2022-06-06)
+
+
+### Features
+
+* **utils:** add joinClassNames util ([f34b9de](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/f34b9de97f61eb5b075d6adedfcacfa5e097943b))
+
+## [0.4.2](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.4.1...v0.4.2) (2022-06-06)
+
+
+### Bug Fixes
+
+* **classes:** add gamepadDialogClasses and quickAccessControlsClasses ([2e7b4b6](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/2e7b4b664a673b46b402b995fb58f0ce8ffbafac))
+
+## [0.4.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.4.0...v0.4.1) (2022-06-05)
+
+
+### Bug Fixes
+
+* **textfield:** correct type for onChange callback ([32c355f](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/32c355f2a7e0b6ca6592b956e8174d217766bc5c))
+
+# [0.4.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.3.0...v0.4.0) (2022-06-05)
+
+
+### Bug Fixes
+
+* **typings:** export all prop types ([7f9dfc5](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/7f9dfc5910dfc172ba161d9b63763e85eb289a43))
+
+
+### Features
+
+* **textfield:** extract TextField component ([a3c1a7c](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/a3c1a7c7b73eae475574a13b6ff9c75ff78cbcb6))
+
+# [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.5",
+  "version": "0.6.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!'",
+    "prepare": "husky install",
+    "commit": "git-cz"
   },
   "files": [
     "/lib",
@@ -32,13 +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

@@ -2,7 +2,7 @@ import { FC } from 'react';
 
 import { CommonUIModule } from '../webpack';
 
-interface ButtonProps {
+export interface ButtonProps {
   className?: string;
   noFocusRing?: boolean;
   disabled?: boolean;

src/deck-components/ButtonItem.tsx

@@ -2,7 +2,7 @@ import { FC } from 'react';
 
 import { CommonUIModule } from '../webpack';
 
-interface ButtonItemProps {
+export interface ButtonItemProps {
   label?: string;
   description?: string;
   layout?: 'below';

src/deck-components/Dropdown.tsx

@@ -0,0 +1,50 @@
+import { ReactNode, VFC } from 'react';
+
+import { CommonUIModule } from '../webpack';
+
+export interface SingleDropdownOption {
+  data: number;
+  label: string;
+
+  options?: never;
+}
+
+export interface MultiDropdownOption {
+  label: string;
+  options: DropdownOption[];
+
+  data?: never;
+}
+
+export type DropdownOption = SingleDropdownOption | MultiDropdownOption;
+
+export interface DropdownProps {
+  rgOptions: DropdownOption[];
+  selectedOption: number | null;
+  disabled?: boolean;
+  onMenuWillOpen?(showMenu: () => void): void;
+  onMenuOpened?(): void;
+  onChange?(data: SingleDropdownOption): void;
+  contextMenuPositionOptions?: any;
+  menuLabel?: string;
+  strDefaultLabel?: string;
+  renderButtonValue?(element: ReactNode): ReactNode;
+  focusable?: boolean;
+}
+
+export const Dropdown = Object.values(CommonUIModule).find(
+  (mod: any) => mod?.prototype?.SetSelectedOption && mod?.prototype?.BuildMenu,
+) as VFC<DropdownProps>;
+
+export interface DropdownItemProps extends DropdownProps {
+  label?: string;
+  tooltip?: string;
+  description?: string;
+  layout?: 'below';
+  bottomSeparator?: boolean;
+  indentLevel?: number;
+}
+
+export const DropdownItem = Object.values(CommonUIModule).find((mod: any) =>
+  mod?.toString()?.includes('"dropDownControlRef","description"'),
+) as VFC<DropdownItemProps>;

src/deck-components/Menu.tsx

@@ -1,8 +1,17 @@
-import { FC } from 'react';
+import { FC, ReactNode } from 'react';
 
 import { findModuleChild } from '../webpack';
 
-interface MenuProps {
+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];
+    }
+  }
+});
+
+export interface MenuProps {
   label: string;
   onCancel?(): void;
   cancelText?: string;
@@ -18,7 +27,7 @@ export const Menu: FC<MenuProps> = findModuleChild((m) => {
   }
 });
 
-interface MenuItemProps {
+export interface MenuItemProps {
   onSelected?(): void;
 }
 

src/deck-components/Modal.tsx

@@ -1,12 +1,29 @@
-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];
     }
   }
 });
+
+export 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

@@ -2,7 +2,7 @@ import { FC } from 'react';
 
 import { findModuleChild } from '../webpack';
 
-interface PanelSectionProps {
+export interface PanelSectionProps {
   title?: string;
   spinner?: boolean;
 }

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,
+}
+
+export 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/SidebarNavigation.tsx

@@ -0,0 +1,25 @@
+import { ReactNode, VFC } from 'react';
+
+import { Module, findModuleChild } from '../webpack';
+
+export interface SidebarNavigationPages {
+  title: string;
+  route: string;
+  content: ReactNode;
+}
+
+export interface SidebarNavigationProps {
+  title?: string;
+  pages: SidebarNavigationPages[];
+  showTitle?: boolean;
+  disableRouteReporting?: boolean;
+}
+
+export const SidebarNavigation = findModuleChild((mod: Module) => {
+  for (let prop in mod) {
+    if (mod[prop]?.toString()?.includes('"disableRouteReporting"')) {
+      return mod[prop];
+    }
+  }
+  return null;
+}) as VFC<SidebarNavigationProps>;

src/deck-components/Slider.tsx

@@ -2,13 +2,13 @@ import { FC } from 'react';
 
 import { CommonUIModule } from '../webpack';
 
-interface NotchLabel {
+export interface NotchLabel {
   notchIndex: number;
   label: string;
   value: number;
 }
 
-interface SliderProps {
+export interface SliderProps {
   label?: string;
   value: number;
   layout?: 'below';

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/TextField.tsx

@@ -0,0 +1,27 @@
+import { ChangeEventHandler, ReactNode, VFC } from 'react';
+
+import { CommonUIModule, Module } from '../webpack';
+
+export interface TextFieldProps {
+  label?: ReactNode;
+  requiredLabel?: ReactNode;
+  description?: ReactNode;
+  bShowCopyAction?: boolean;
+  bShowClearAction?: boolean;
+  bAlwaysShowClearAction?: boolean;
+  bIsPassword?: boolean;
+  rangeMin?: number;
+  rangeMax?: number;
+  mustBeNumeric?: boolean;
+  mustBeURL?: boolean;
+  mustBeEmail?: boolean;
+  focusOnMount?: boolean;
+  tooltip?: string;
+  inlineControls?: ReactNode;
+  onChange?: ChangeEventHandler<HTMLInputElement>;
+  value?: string;
+}
+
+export const TextField = Object.values(CommonUIModule).find(
+  (mod: Module) => mod?.validateUrl && mod?.validateEmail,
+) as VFC<TextFieldProps>;

src/deck-components/Toggle.tsx

@@ -2,7 +2,7 @@ import { FC } from 'react';
 
 import { CommonUIModule } from '../webpack';
 
-interface ToggleProps {
+export interface ToggleProps {
   label?: string;
   description?: string;
   checked: boolean;

src/deck-components/index.ts

@@ -1,9 +1,14 @@
 export * from './Button';
 export * from './ButtonItem';
+export * from './Dropdown';
 export * from './Menu';
 export * from './Modal';
 export * from './Panel';
+export * from './Router';
+export * from './SidebarNavigation';
 export * from './Slider';
 export * from './Spinner';
 export * from './static-classes';
+export * from './SteamSpinner';
+export * from './TextField';
 export * from './Toggle';

src/deck-components/static-classes.ts

@@ -1,4 +1,4 @@
-import { findModuleChild } from '../webpack';
+import { findModule } from '../webpack';
 
 type StaticClasses = Record<
   | 'ActiveTab'
@@ -63,10 +63,126 @@ type StaticClasses = Record<
   string
 >;
 
-export const staticClasses: StaticClasses = findModuleChild((mod) => {
+type GamepadDialogClasses = Record<
+  | 'duration-app-launch'
+  | 'GamepadDialogContent'
+  | 'GamepadDialogContent_InnerWidth'
+  | 'Field'
+  | 'Button'
+  | 'NoMinWidth'
+  | 'ActiveAndUnfocused'
+  | 'StandaloneFieldSeparator'
+  | 'StandardPadding'
+  | 'CompactPadding'
+  | 'WithDescription'
+  | 'WithBottomSeparatorStandard'
+  | 'WithBottomSeparatorThick'
+  | 'HighlightOnFocus'
+  | 'ItemFocusAnim-darkerGrey'
+  | 'ItemFocusAnim-darkGrey'
+  | 'WithBottomSeparator'
+  | 'Disabled'
+  | 'Clickable'
+  | 'FieldClickTarget'
+  | 'FieldChildren'
+  | 'FieldLeadIcon'
+  | 'FieldLabelRow'
+  | 'VerticalAlignCenter'
+  | 'InlineWrapShiftsChildrenBelow'
+  | 'ExtraPaddingOnChildrenBelow'
+  | 'ChildrenWidthFixed'
+  | 'ChildrenWidthGrow'
+  | 'WithFirstRow'
+  | 'WithChildrenBelow'
+  | 'FieldLabel'
+  | 'FieldLabelValue'
+  | 'FieldDescription'
+  | 'ModalPosition'
+  | 'WithStandardPadding'
+  | 'slideInAnimation'
+  | 'BasicTextInput'
+  | 'Toggle'
+  | 'ToggleRail'
+  | 'On'
+  | 'ToggleSwitch'
+  | 'LabelFieldValue'
+  | 'DropDownControlButtonContents'
+  | 'Spacer'
+  | 'ControlsListOuterPanel'
+  | 'StandardSpacing'
+  | 'ExtraSpacing'
+  | 'AlignRight'
+  | 'AlignLeft'
+  | 'AlignCenter'
+  | 'ControlsListChild'
+  | 'QuickAccess-Menu'
+  | 'BigButtons'
+  | 'BottomButtons'
+  | 'ItemFocusAnim-darkerGrey-nocolor'
+  | 'ItemFocusAnim-grey'
+  | 'ItemFocusAnimBorder-darkGrey'
+  | 'ItemFocusAnim-green'
+  | 'focusAnimation'
+  | 'hoverAnimation',
+  string
+>;
+
+type QuickAccessControlsClasses = Record<
+  | 'duration-app-launch'
+  | 'PanelSection'
+  | 'PanelSectionTitle'
+  | 'Text'
+  | 'PanelSectionRow'
+  | 'Label'
+  | 'ComingSoon'
+  | 'LowBattery'
+  | 'ReallyLow'
+  | 'LowBatteryGauge'
+  | 'Remaining'
+  | 'EmptyNotifications'
+  | 'BatterySectionContainer'
+  | 'BatteryIcon'
+  | 'BatteryPercentageLabel'
+  | 'BatteryDetailsLabels'
+  | 'BatteryProjectedValue'
+  | 'BatteryProjectedLabel'
+  | 'ItemFocusAnim-darkerGrey-nocolor'
+  | 'ItemFocusAnim-darkerGrey'
+  | 'ItemFocusAnim-darkGrey'
+  | 'ItemFocusAnim-grey'
+  | 'ItemFocusAnimBorder-darkGrey'
+  | 'ItemFocusAnim-green'
+  | 'focusAnimation'
+  | 'hoverAnimation',
+  string
+>;
+
+export const staticClasses: StaticClasses = findModule((mod) => {
   if (typeof mod !== 'object') return false;
 
   if (mod.TransitionMenuDelay) {
-    return mod;
+    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;
 });

src/utils.ts

@@ -85,3 +85,7 @@ export function unpatch(obj: any, name: any): void {
 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(" ");
+}

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;
-})
+});