chore(release): 1.5.0 [CI SKIP]

CHANGELOG.md

@@ -1,3 +1,31 @@
+# [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)
+
+
+### Features
+
+* **plugin:** api for patching existing routes ([5b29447](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/5b29447cfa597773a81aa233da9362346683505d))
+
+## [1.2.4](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.2.3...v1.2.4) (2022-07-25)
+
+
+### Bug Fixes
+
+* **Modal:** add closeModal ([994b9e2](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/994b9e2cc6f41da3d813e6f339bd2fd30e4fa3ad))
+
 ## [1.2.3](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.2.2...v1.2.3) (2022-07-25)
 
 

README.md

@@ -1 +1,27 @@
 # Decky Frontend Library
+
+Library used to develop plugins used for use with [decky-loader](https://github.com/SteamDeckHomebrew/decky-loader).
+
+## Decky Loader Discord [![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/ZU74G2NJzk)
+
+Please contact the developers here for questions and support that cannot be addressed via a Github issue.
+
+## Developers and Contributors
+
+This library is focused on usage by developers to provide custom React components based on those found in the Steam Deck's React UI.  
+This method allows developers to add UI elements and code without clobbering the existing UI of the deck in order to do so.  
+This library can also theoretically be used to extend existing UI elements of the Steam Deck UI but this has not been tested extensively.
+
+### Getting Started (Contributors)
+
+1. Clone the repository to your preferred location
+2. If you wish to add features such as new UI components, please create a feature branch to PR to the original repo.
+3. Bug/hotfixes are acceptable on the main branch,
+
+### Getting Started (Developers)
+
+If you would like a feature added to decky-frontend-lib, please request it via a Github issue.  
+
+If you want to start making a plugin with decky-frontend-lib, please direct your attention to the [decky-plugin-template](https://github.com/SteamDeckHomebrew/decky-plugin-template) repository.
+
+This library can be found on [npm](https://www.npmjs.com/package/decky-frontend-lib) and as such you can pull it without a local copy for your project as needed.

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "decky-frontend-lib",
-  "version": "1.2.3",
+  "version": "1.5.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "decky-frontend-lib",
-      "version": "1.2.3",
+      "version": "1.5.0",
       "hasInstallScript": true,
       "license": "GPL-2.0-or-later",
       "devDependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "decky-frontend-lib",
-  "version": "1.2.3",
+  "version": "1.5.0",
   "description": "A library for building decky plugins",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/deck-components/Modal.tsx

@@ -17,6 +17,7 @@ export interface ModalRootProps {
   onCancel?(): void;
   onOK?(): void;
   onEscKeypress?(): void;
+  closeModal?(): void;
   className?: string;
   modalClassName?: string;
   bAllowFullSize?: boolean;

src/plugin.tsx

@@ -1,4 +1,4 @@
-import type { ComponentType } from 'react';
+import type { ComponentType, ReactNode } from 'react';
 import { RouteProps } from 'react-router';
 
 export interface Plugin {
@@ -20,13 +20,34 @@ interface ServerResponseError {
 
 type ServerResponse<TRes> = ServerResponseSuccess<TRes> | ServerResponseError;
 
-interface RouterHook {
+type RoutePatch = (route: RouteProps) => RouteProps;
+
+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>>;

src/utils.ts

@@ -92,4 +92,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' ]
+});