Compare commits

...

152 Commits

Author SHA1 Message Date
semantic-release-bot
6441bde835 chore(release): 3.1.1 [CI SKIP] 2022-09-18 19:02:37 +00:00
AAGaming
29201fadaf fix(Button): add types to DialogButton
also remove useless Button component.
2022-09-18 15:01:44 -04:00
semantic-release-bot
31b81f5edd chore(release): 3.1.0 [CI SKIP] 2022-09-18 18:52:48 +00:00
AAGaming
b05f84658a feat(components): add FocusRing 2022-09-18 14:51:50 -04:00
Lukas Senionis
218e007234 Fix Field and Item types (#23)
* fix(field): correct and extend FieldProps

* fix(item): correct bottomSeparator in ItemProps

* fix(field): correct field commentary

* feat(field): add comment about inlineWrap
2022-09-17 09:57:36 -04:00
TrainDoctor
aa35e8b64a Create LICENSE 2022-09-15 20:44:15 -07:00
semantic-release-bot
cd61f57a6f chore(release): 3.0.0 [CI SKIP] 2022-09-09 20:19:05 +00:00
AAGaming
8eb921e8b7 feat(serverAPI): add FilePicker 2022-09-09 16:18:06 -04:00
AAGaming
26017e7de4 feat(modal): add more props, refactor
BREAKING CHANGE: ModalRoot ->ConfirmModal
add the actual ModalRoot which does not contain buttons
2022-09-09 16:17:44 -04:00
AAGaming
71c7afa1a6 fix(textfield): extend HTMLAttributes 2022-09-09 16:16:15 -04:00
AAGaming
d6a08feca0 fix(button): add style prop 2022-09-09 16:15:51 -04:00
semantic-release-bot
160fbb493f chore(release): 2.0.0 [CI SKIP] 2022-09-04 17:30:36 +00:00
AAGaming
076d9eb5e8 feat(patcher): rewrite to support multiple patches
BREAKING CHANGE: All usage of *Patch functions must now store the result and call .unpatch()
unpatch() has been removed.
2022-09-04 13:29:36 -04:00
semantic-release-bot
f66f5dd794 chore(release): 1.8.3 [CI SKIP] 2022-09-03 04:36:42 +00:00
botato
d01c7b3904 fix(plugin): Export ServerResponse for use in plugin-loader.tsx (#20) 2022-09-02 21:35:59 -07:00
semantic-release-bot
34f6cf403b chore(release): 1.8.2 [CI SKIP] 2022-08-28 11:19:45 +00:00
Lukas Senionis
1dd48cd4c4 fix(utils): Mutable variable must be non-const (#19) 2022-08-28 07:19:06 -04:00
Lukas Senionis
6842f31190 Add necessary stuff to properly patch into play section (#18)
* feat(utils): Add singleShot option for patch functions

* chore(static-classes): add playSectionClasses

* feat(static-classes): Convert callbacks to one-liners
2022-08-28 07:14:19 -04:00
semantic-release-bot
27e1a9c8b0 chore(release): 1.8.1 [CI SKIP] 2022-08-26 17:35:29 +00:00
Lukas Senionis
55bd06a5ee fix(utils): update wrapReactClass impl. and defaults for prop argument (#17) 2022-08-26 13:34:56 -04:00
semantic-release-bot
58550b1f6e chore(release): 1.8.0 [CI SKIP] 2022-08-26 05:13:17 +00:00
AAGaming
c25fe58f08 feat(Focusable): add FooterLegend props to Focusable and Field 2022-08-26 01:12:21 -04:00
AAGaming
ef147c6715 chore(vscode): add tasks.json 2022-08-26 01:11:50 -04:00
AAGaming
43e9417303 chore(static-classes): add updaterFieldClasses 2022-08-26 01:11:32 -04:00
AAGaming
cf137c43b4 feat(components): add Carousel component 2022-08-26 01:11:04 -04:00
semantic-release-bot
8167be7642 chore(release): 1.7.8 [CI SKIP] 2022-08-20 15:09:34 +00:00
Lukas Senionis
a09af357c7 fix(Dropdown): correct Dropdown types (#15) 2022-08-20 11:08:50 -04:00
semantic-release-bot
e48180d7bb chore(release): 1.7.7 [CI SKIP] 2022-08-20 15:00:28 +00:00
Lukas Senionis
490a1f77fa fix(FieldProps): Add "bottomSeparator" option (#16) 2022-08-20 10:59:52 -04:00
semantic-release-bot
d1b47d21ed chore(release): 1.7.6 [CI SKIP] 2022-08-18 15:04:18 +00:00
Lukas Senionis
af98a76b86 fix(TextFieldProps): Add "disabled" option to TextFieldProps (#14) 2022-08-18 10:58:35 -04:00
semantic-release-bot
d18b1ba1ed chore(release): 1.7.5 [CI SKIP] 2022-08-18 00:26:12 +00:00
TrainDoctor
6be06446f2 fix(ButtonItem): update to account for both prop settings 2022-08-17 17:25:33 -07:00
semantic-release-bot
bb8a6df115 chore(release): 1.7.4 [CI SKIP] 2022-08-18 00:01:38 +00:00
AAGaming
a672230b00 fix(*): updates for webpack v5 2022-08-17 20:00:24 -04:00
semantic-release-bot
4644df8202 chore(release): 1.7.3 [CI SKIP] 2022-08-17 19:56:41 +00:00
Sefa Eyeoglu
7d3b5e8123 fix(Router): Add more members to Router interface (#12) 2022-08-17 15:55:50 -04:00
semantic-release-bot
0a4ef14239 chore(release): 1.7.2 [CI SKIP] 2022-08-17 19:19:46 +00:00
AAGaming
a592883a2e fix(utils): allow prop reassigns to fail 2022-08-17 15:18:45 -04:00
semantic-release-bot
3f126fe471 chore(release): 1.7.1 [CI SKIP] 2022-08-17 18:52:21 +00:00
AAGaming
e644de35d7 fix(utils): better method to wrap react classes 2022-08-17 14:51:24 -04:00
semantic-release-bot
9b79f70ac7 chore(release): 1.7.0 [CI SKIP] 2022-08-17 18:46:25 +00:00
AAGaming
d237bd48e4 feat(utils): add wrapReactClass 2022-08-17 14:45:34 -04:00
semantic-release-bot
f7d73b4dc3 chore(release): 1.6.2 [CI SKIP] 2022-08-15 17:13:15 +00:00
AAGaming
9edb1e6b97 chore(classes): add scrollClasses 2022-08-15 13:12:15 -04:00
AAGaming
605e4f5eae chore(semantic-release): tweak commit-analyzer 2022-08-15 13:11:38 -04:00
semantic-release-bot
e2f675835e chore(release): 1.6.1 [CI SKIP] 2022-08-13 01:36:15 +00:00
AAGaming
b7dc1d6275 fix(wrapReactType): try another method 2022-08-12 21:35:27 -04:00
semantic-release-bot
a1fdae9cd2 chore(release): 1.6.0 [CI SKIP] 2022-08-13 01:25:46 +00:00
AAGaming
7cf45cf371 feat(Utilities): add wrapReactType utility 2022-08-12 21:24:56 -04:00
semantic-release-bot
df1c8dbb8b chore(release): 1.5.1 [CI SKIP] 2022-08-10 22:46:24 +00:00
TrainDoctor
1de979f713 fix(security): update for minimist pollution exploit 2022-08-10 15:44:37 -07:00
TrainDoctor
f23070a82a Merge pull request #10 from SteamDeckHomebrew/dependabot/npm_and_yarn/semantic-release-19.0.3
chore(deps-dev): bump semantic-release from 19.0.2 to 19.0.3
2022-08-10 15:39:43 -07:00
dependabot[bot]
b87e7c2f40 chore(deps-dev): bump semantic-release from 19.0.2 to 19.0.3
Bumps [semantic-release](https://github.com/semantic-release/semantic-release) from 19.0.2 to 19.0.3.
- [Release notes](https://github.com/semantic-release/semantic-release/releases)
- [Commits](https://github.com/semantic-release/semantic-release/compare/v19.0.2...v19.0.3)

---
updated-dependencies:
- dependency-name: semantic-release
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-08-10 22:39:05 +00:00
semantic-release-bot
6db29a9a6e chore(release): 1.5.0 [CI SKIP] 2022-08-10 01:37:31 +00:00
AAGaming
e2126afd06 feat(ServerAPI): add Toaster to serverAPI 2022-08-09 21:36:32 -04:00
semantic-release-bot
cea587958e chore(release): 1.4.0 [CI SKIP] 2022-08-08 23:31:05 +00:00
AAGaming
b21dfcdb66 feat(utils): add findInTree and findInReactTree 2022-08-08 19:30:08 -04:00
semantic-release-bot
d46251bb91 chore(release): 1.3.0 [CI SKIP] 2022-08-02 22:55:55 +00:00
AAGaming
5b29447cfa feat(plugin): api for patching existing routes 2022-08-02 18:50:39 -04:00
TrainDoctor
e993d06963 Update README.md 2022-07-28 15:28:50 -07:00
semantic-release-bot
a3c136a07e chore(release): 1.2.4 [CI SKIP] 2022-07-25 19:44:53 +00:00
AAGaming
994b9e2cc6 fix(Modal): add closeModal 2022-07-25 15:44:06 -04:00
semantic-release-bot
801d70f300 chore(release): 1.2.3 [CI SKIP] 2022-07-25 19:34:45 +00:00
AAGaming
2fdfcdd478 fix(Modal): add another prop 2022-07-25 15:33:35 -04:00
semantic-release-bot
9a728611f4 chore(release): 1.2.2 [CI SKIP] 2022-07-25 19:30:30 +00:00
AAGaming
97997adfaf fix(Modal): add more props to typings 2022-07-25 15:29:38 -04:00
semantic-release-bot
279069ee34 chore(release): 1.2.1 [CI SKIP] 2022-07-13 01:07:46 +00:00
AAGaming
944a9024ff fix(ProgressBar): extend correct prop type 2022-07-12 21:06:46 -04:00
AAGaming
0a2220b4b4 chore(ProgressBar): formatting 2022-07-12 20:45:56 -04:00
semantic-release-bot
aa567e9dd0 chore(release): 1.2.0 [CI SKIP] 2022-07-13 00:34:28 +00:00
AAGaming
d9e4ff3ebd feat(ProgressBar): add new progress bars 2022-07-12 20:33:38 -04:00
semantic-release-bot
79d73dea2e chore(release): 1.1.0 [CI SKIP] 2022-07-09 14:34:48 +00:00
hulkrelax
602f93ae6a feat(Router.tsx): adds more methods to router (#9)
Adds the ability to get the main running app and to navigate to the running app
2022-07-09 10:34:09 -04:00
semantic-release-bot
d86c86cd80 chore(release): 1.0.2 [CI SKIP] 2022-07-07 04:03:42 +00:00
AAGaming
51c418d560 fix(Plugin): support non-ui plugins 2022-07-07 00:00:40 -04:00
semantic-release-bot
95de7346df chore(release): 1.0.1 [CI SKIP] 2022-06-29 15:53:25 +00:00
AAGaming
58933f827c fix(package): enable tree shaking 2022-06-29 11:50:20 -04:00
hulkrelax
0ff3476987 bugfix: Fix issue with incorrect typing on fetchNoCors (#7)
* make fetchNoCors have similar typing to fetch

* request param should be optional
2022-06-28 21:12:44 -04:00
semantic-release-bot
2c7d266c81 chore(release): 1.0.0 [CI SKIP] 2022-06-23 02:58:38 +00:00
AAGaming
9bd96227a0 refactor(components): rename Field components
BREAKING CHANGE: Toggle -> ToggleField Slider -> SliderField & add Toggle component
2022-06-22 22:57:51 -04:00
semantic-release-bot
ddafa5666d chore(release): 0.12.3 [CI SKIP] 2022-06-23 02:45:11 +00:00
AAGaming
46977496fd fix(Field): description is a string you idiot 2022-06-22 22:44:13 -04:00
semantic-release-bot
71a6c79384 chore(release): 0.12.2 [CI SKIP] 2022-06-23 01:53:07 +00:00
AAGaming
da4c79b5ae fix(Field): title -> label 2022-06-22 21:52:17 -04:00
semantic-release-bot
7b04bf5827 chore(release): 0.12.1 [CI SKIP] 2022-06-23 01:47:38 +00:00
AAGaming
a87e1bb46f fix(components): export FIeld 2022-06-22 21:46:50 -04:00
semantic-release-bot
b6e2e7e4dc chore(release): 0.12.0 [CI SKIP] 2022-06-23 01:45:47 +00:00
AAGaming
7d82a82e9c feat(components): add Field 2022-06-22 21:44:46 -04:00
semantic-release-bot
0cee60d122 chore(release): 0.11.1 [CI SKIP] 2022-06-23 00:42:16 +00:00
AAGaming
7efc0347f7 fix(Router): make specifying quick access tab not required 2022-06-22 20:41:22 -04:00
semantic-release-bot
d227858e62 chore(release): 0.11.0 [CI SKIP] 2022-06-20 21:37:03 +00:00
AAGaming
db64f34725 feat(utils): add sleep util 2022-06-20 17:35:56 -04:00
semantic-release-bot
b08aadb810 chore(release): 0.10.5 [CI SKIP] 2022-06-20 03:15:39 +00:00
AAGaming
2afb7f16bb fix(patcher): why the hell did i do it that way 2022-06-19 23:14:52 -04:00
semantic-release-bot
32d1303191 chore(release): 0.10.4 [CI SKIP] 2022-06-19 15:40:15 +00:00
AAGaming
1ce15d261f fix(plugin): correct return type on injectCssIntoTab 2022-06-19 11:39:35 -04:00
semantic-release-bot
bf52e0761c chore(release): 0.10.3 [CI SKIP] 2022-06-18 15:16:51 +00:00
AAGaming
823a2745f9 fix(ServerAPI): add injectCssIntoTab to serverAPI typings 2022-06-18 11:10:35 -04:00
semantic-release-bot
21f7874cab chore(release): 0.10.2 [CI SKIP] 2022-06-16 21:33:44 +00:00
AAGaming
077334e376 fix(Router): add NavigateBackOrOpenMenu() 2022-06-16 17:32:58 -04:00
semantic-release-bot
02f4c5c518 chore(release): 0.10.1 [CI SKIP] 2022-06-16 21:27:22 +00:00
AAGaming
f1e20cd0b5 fix(Focusable): add ref prop, fix event types 2022-06-16 17:26:31 -04:00
Jonas Dellinger
b5d9265705 chore(release): also include package-lock.json in release assets 2022-06-13 10:53:01 +02:00
semantic-release-bot
734ce33e1b chore(release): 0.10.0 [CI SKIP] 2022-06-10 20:57:30 +00:00
AAGaming
9beab5f7e9 feat(components): remove HorizontalFocus, add Focusable 2022-06-10 16:56:39 -04:00
semantic-release-bot
33aaf56f96 chore(release): 0.9.1 [CI SKIP] 2022-06-09 02:08:28 +00:00
AAGaming
dddb703a2e fix(SuspensefulImage): fix export 2022-06-08 22:07:51 -04:00
semantic-release-bot
ea2e072085 chore(release): 0.9.0 [CI SKIP] 2022-06-09 01:59:56 +00:00
AAGaming
6324282b48 feat(custom-components): add SuspensefulImage 2022-06-08 21:59:12 -04:00
semantic-release-bot
ace3f95a33 chore(release): 0.8.0 [CI SKIP] 2022-06-09 01:41:07 +00:00
AAGaming
4d30efc33b feat(components): add HorizontalFocus 2022-06-08 21:40:19 -04:00
semantic-release-bot
af2d3a29e2 chore(release): 0.7.2 [CI SKIP] 2022-06-08 22:30:10 +00:00
AAGaming
e5e561edd6 fix(package): fix pnpm peer dependencies errors 2022-06-08 18:29:27 -04:00
semantic-release-bot
7111d18667 chore(release): 0.7.1 [CI SKIP] 2022-06-08 21:55:07 +00:00
AAGaming
24244f6e91 fix(spinners): add SVG props 2022-06-08 17:54:20 -04:00
AAGaming
dd5c42c57d fix(Router): add NavigateToStore to interface 2022-06-08 17:53:49 -04:00
semantic-release-bot
09ab2fed4b chore(release): 0.7.0 [CI SKIP] 2022-06-08 17:25:30 +00:00
Jonas Dellinger
4328385391 feat(components): added shared item-props, progressbar, and more types for slider 2022-06-08 19:24:53 +02:00
semantic-release-bot
3fe986aaba chore(release): 0.6.0 [CI SKIP] 2022-06-08 08:00:06 +00:00
Jonas Dellinger
bc2bec4b83 fix(husky): wrong script for husky caused problems when installing 2022-06-08 09:59:20 +02:00
Jonas Dellinger
a99fb4a22d feat(dropdown): add dropdown 2022-06-08 09:59:20 +02:00
Jonas Dellinger
d8794ef4d3 feat(sidebar-navigation): add sidebar navigation component 2022-06-08 09:59:20 +02:00
Jonas Dellinger
23ed5dd157 chore(textfield): remove console.log 2022-06-08 09:59:20 +02:00
semantic-release-bot
210b0389f7 chore(release): 0.5.1 [CI SKIP] 2022-06-06 21:33:48 +00:00
AAGaming
198f96abb5 Merge branch 'main' of github.com:steamdeckhomebrew/decky-frontend-lib 2022-06-06 17:33:08 -04:00
AAGaming
244ae128da fix(classes): switch static-classes to findModule 2022-06-06 17:33:05 -04:00
semantic-release-bot
377d7adde8 chore(release): 0.5.0 [CI SKIP] 2022-06-06 21:28:39 +00:00
AAGaming
f34b9de97f feat(utils): add joinClassNames util 2022-06-06 17:27:56 -04:00
semantic-release-bot
b5192cf590 chore(release): 0.4.2 [CI SKIP] 2022-06-06 21:21:44 +00:00
AAGaming
2e7b4b664a fix(classes): add gamepadDialogClasses and quickAccessControlsClasses 2022-06-06 17:20:55 -04:00
semantic-release-bot
b92e6a5b9d chore(release): 0.4.1 [CI SKIP] 2022-06-05 13:11:12 +00:00
Jonas Dellinger
32c355f2a7 fix(textfield): correct type for onChange callback 2022-06-05 15:10:23 +02:00
semantic-release-bot
747d70dcca chore(release): 0.4.0 [CI SKIP] 2022-06-05 13:08:53 +00:00
Jonas Dellinger
7f9dfc5910 fix(typings): export all prop types 2022-06-05 15:07:47 +02:00
Jonas Dellinger
a3c1a7c7b7 feat(textfield): extract TextField component 2022-06-05 15:06:06 +02:00
semantic-release-bot
fccfdd6f11 chore(release): 0.3.0 [CI SKIP] 2022-06-04 17:43:17 +00:00
AAGaming
f124480af8 feat(typings): add Navigate to router typings 2022-06-04 13:42:23 -04:00
semantic-release-bot
15e672afef chore(release): 0.2.0 [CI SKIP] 2022-06-04 08:54:45 +00:00
Jonas Dellinger
bf0c2b17bf feat(router): expose GetQuickAccessTab and rename QuickAccessTabs to QuickAccessTab 2022-06-04 10:54:01 +02:00
Jonas Dellinger
0625dc385a chore(release): add NPM releaser 2022-06-04 10:49:30 +02:00
semantic-release-bot
b04992d29c chore(release): 0.1.0 [CI SKIP] 2022-06-04 08:44:52 +00:00
Jonas Dellinger
228fe1f22c chore(release): fix release script by installing commitlint cli 2022-06-04 10:44:01 +02:00
Jonas Dellinger
5d4214176e chore(release): try to fix commit message when releasing 2022-06-04 10:37:09 +02:00
Jonas Dellinger
62bf0eaffa feat(router): types for steam router 2022-06-04 10:33:59 +02:00
Jonas Dellinger
43b04b267e chore(release): disable jest for now 2022-06-04 10:19:04 +02:00
Jonas Dellinger
58595d54ea chore(release): fix branch selector 2022-06-04 10:17:17 +02:00
Jonas Dellinger
aec27a18a7 chore(release): introduce release pipeline 2022-06-04 10:14:59 +02:00
Jonas Dellinger
f101e23c1c 0.0.6 2022-06-02 17:58:18 +02:00
Jonas Dellinger
5b3ea8f63f 0.0.5 2022-06-02 17:57:48 +02:00
AAGaming
07ccceb990 add modal support, showModal->showContextMenu and new showModal 2022-06-01 17:51:17 -04:00
Jonas Dellinger
536269b1b7 Expose routerhook 2022-05-30 21:00:38 +02:00
43 changed files with 13904 additions and 549 deletions

3
.commitlintrc.json Normal file
View File

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

29
.github/workflows/release.yaml vendored Normal file
View File

@@ -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

4
.husky/commit-msg Executable file
View File

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

25
.releaserc.json Normal file
View File

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

15
.vscode/tasks.json vendored Normal file
View File

@@ -0,0 +1,15 @@
{
"version": "2.0.0",
"tasks": [
{
"type": "npm",
"script": "dev",
"problemMatcher": [
"$tsc-watch"
],
"label": "npm: dev",
"detail": "tsc -b -w",
"isBackground": true
}
]
}

451
CHANGELOG.md Normal file
View File

@@ -0,0 +1,451 @@
## [3.1.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v3.1.0...v3.1.1) (2022-09-18)
### Bug Fixes
* **Button:** add types to DialogButton ([29201fa](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/29201fadafff6bdaa0f8fe7d7806cfa88ec545ab))
# [3.1.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v3.0.0...v3.1.0) (2022-09-18)
### Features
* **components:** add FocusRing ([b05f846](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/b05f84658a1b91bd260f0acd7d0984c2ed714e06))
# [3.0.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v2.0.0...v3.0.0) (2022-09-09)
### Bug Fixes
* **button:** add style prop ([d6a08fe](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/d6a08feca0f7c42e88b4d227b2953a28ac6c424d))
* **textfield:** extend HTMLAttributes ([71c7afa](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/71c7afa1a641b6651e6e73ff5575b665e5e3c48e))
### Features
* **modal:** add more props, refactor ([26017e7](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/26017e7de4600cc677a8a1e0881f2e58b3d5fe65))
* **serverAPI:** add FilePicker ([8eb921e](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/8eb921e8b787a8e5045badff58cd9a1a54038692))
### BREAKING CHANGES
* **modal:** ModalRoot ->ConfirmModal
add the actual ModalRoot which does not contain buttons
# [2.0.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.8.3...v2.0.0) (2022-09-04)
### Features
* **patcher:** rewrite to support multiple patches ([076d9eb](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/076d9eb5e8f22bfa49afc242608698da2ded50e4))
### BREAKING CHANGES
* **patcher:** All usage of *Patch functions must now store the result and call .unpatch()
unpatch() has been removed.
## [1.8.3](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.8.2...v1.8.3) (2022-09-03)
### Bug Fixes
* **plugin:** Export ServerResponse for use in plugin-loader.tsx ([#20](https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues/20)) ([d01c7b3](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/d01c7b3904c12142a58f78cbb93a4c1ecb438280))
## [1.8.2](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.8.1...v1.8.2) (2022-08-28)
### Bug Fixes
* **utils:** Mutable variable must be non-const ([#19](https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues/19)) ([1dd48cd](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/1dd48cd4c42989c75ee6859ebf8b857c027ff0f5))
## [1.8.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.8.0...v1.8.1) (2022-08-26)
### Bug Fixes
* **utils:** update wrapReactClass impl. and defaults for prop argument ([#17](https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues/17)) ([55bd06a](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/55bd06a5ee9468f572aed8f78be4d0acaaffe45a))
# [1.8.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.7.8...v1.8.0) (2022-08-26)
### Features
* **components:** add Carousel component ([cf137c4](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/cf137c43b4962977650e6ce0fad554b6ae966e43))
* **Focusable:** add FooterLegend props to Focusable and Field ([c25fe58](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/c25fe58f082d70a34443ac3c8b32b4528a4b01fb))
## [1.7.8](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.7.7...v1.7.8) (2022-08-20)
### Bug Fixes
* **Dropdown:** correct Dropdown types ([#15](https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues/15)) ([a09af35](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/a09af357c7e750377feefad86ab417b19484cb60))
## [1.7.7](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.7.6...v1.7.7) (2022-08-20)
### Bug Fixes
* **FieldProps:** Add "bottomSeparator" option ([#16](https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues/16)) ([490a1f7](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/490a1f77fa98a988f0cae61d74370bf3fa96336c))
## [1.7.6](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.7.5...v1.7.6) (2022-08-18)
### Bug Fixes
* **TextFieldProps:** Add "disabled" option to TextFieldProps ([#14](https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues/14)) ([af98a76](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/af98a76b86fb05942b9554adb369adbeaf27e70f))
## [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)
### 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)
### Bug Fixes
* **Modal:** add another prop ([2fdfcdd](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/2fdfcdd4788ea0d6483e92729c3102212f3ec0fb))
## [1.2.2](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.2.1...v1.2.2) (2022-07-25)
### Bug Fixes
* **Modal:** add more props to typings ([97997ad](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/97997adfaf1a68ef436279e6e48f34f5eaa9531c))
## [1.2.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.2.0...v1.2.1) (2022-07-13)
### Bug Fixes
* **ProgressBar:** extend correct prop type ([944a902](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/944a9024ff20f0b596869564d014d7dd73e74254))
# [1.2.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.1.0...v1.2.0) (2022-07-13)
### Features
* **ProgressBar:** add new progress bars ([d9e4ff3](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/d9e4ff3ebd22a31306f564e7f8ad82879c8fb699))
# [1.1.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.0.2...v1.1.0) (2022-07-09)
### Features
* **Router.tsx:** adds more methods to router ([#9](https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues/9)) ([602f93a](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/602f93ae6a5ceca5383b888cd4803638799558c5))
## [1.0.2](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.0.1...v1.0.2) (2022-07-07)
### Bug Fixes
* **Plugin:** support non-ui plugins ([51c418d](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/51c418d560247c917125cd5534a978256724e5f3))
## [1.0.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v1.0.0...v1.0.1) (2022-06-29)
### Bug Fixes
* **package:** enable tree shaking ([58933f8](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/58933f827ce2e2ae9b162da4e0061a7591c5759d))
# [1.0.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.12.3...v1.0.0) (2022-06-23)
### Code Refactoring
* **components:** rename Field components ([9bd9622](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/9bd96227a0bb295dcc29abca71e37983307f0505))
### BREAKING CHANGES
* **components:** Toggle -> ToggleField Slider -> SliderField & add Toggle component
## [0.12.3](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.12.2...v0.12.3) (2022-06-23)
### Bug Fixes
* **Field:** description is a string you idiot ([4697749](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/46977496fd4cbe266c370fcffe59a9d9b7543a92))
## [0.12.2](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.12.1...v0.12.2) (2022-06-23)
### Bug Fixes
* **Field:** title -> label ([da4c79b](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/da4c79b5aeb3c589527e17ad29610a8e3f929b79))
## [0.12.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.12.0...v0.12.1) (2022-06-23)
### Bug Fixes
* **components:** export FIeld ([a87e1bb](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/a87e1bb46f749e10ea2b94a011df48f162834c25))
# [0.12.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.11.1...v0.12.0) (2022-06-23)
### Features
* **components:** add Field ([7d82a82](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/7d82a82e9c4db59832593cb6f0f78775b252dc69))
## [0.11.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.11.0...v0.11.1) (2022-06-23)
### Bug Fixes
* **Router:** make specifying quick access tab not required ([7efc034](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/7efc0347f7aa22773feccb0763280c4fd1c4a231))
# [0.11.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.10.5...v0.11.0) (2022-06-20)
### Features
* **utils:** add sleep util ([db64f34](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/db64f3472542b080b1d470c6b8d7aa441db0bfe6))
## [0.10.5](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.10.4...v0.10.5) (2022-06-20)
### Bug Fixes
* **patcher:** why the hell did i do it that way ([2afb7f1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/2afb7f16bb219013d338bc4e002605d32235385c))
## [0.10.4](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.10.3...v0.10.4) (2022-06-19)
### Bug Fixes
* **plugin:** correct return type on injectCssIntoTab ([1ce15d2](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/1ce15d261f4726a2f8bdaff7c8a98497f2622969))
## [0.10.3](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.10.2...v0.10.3) (2022-06-18)
### Bug Fixes
* **ServerAPI:** add injectCssIntoTab to serverAPI typings ([823a274](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/823a2745f9717ed2d2a5d95e2ef25739bffc18c9))
## [0.10.2](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.10.1...v0.10.2) (2022-06-16)
### Bug Fixes
* **Router:** add NavigateBackOrOpenMenu() ([077334e](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/077334e376fb42283e094f0b57c818c580c6f7ba))
## [0.10.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.10.0...v0.10.1) (2022-06-16)
### Bug Fixes
* **Focusable:** add ref prop, fix event types ([f1e20cd](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/f1e20cd0b54622d634202c85cca920323e4df336))
# [0.10.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.9.1...v0.10.0) (2022-06-10)
### Features
* **components:** remove HorizontalFocus, add Focusable ([9beab5f](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/9beab5f7e913f2ef2a8a3047046a524d3007c3b8))
## [0.9.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.9.0...v0.9.1) (2022-06-09)
### Bug Fixes
* **SuspensefulImage:** fix export ([dddb703](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/dddb703a2e712bf2e9d7e172a414c63ffd6a1cc9))
# [0.9.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.8.0...v0.9.0) (2022-06-09)
### Features
* **custom-components:** add SuspensefulImage ([6324282](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/6324282b480f358a3d5936ab6d08ab239d640997))
# [0.8.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.7.2...v0.8.0) (2022-06-09)
### Features
* **components:** add HorizontalFocus ([4d30efc](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/4d30efc33b5398b91e756695fefa91cc37f83ff1))
## [0.7.2](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.7.1...v0.7.2) (2022-06-08)
### Bug Fixes
* **package:** fix pnpm peer dependencies errors ([e5e561e](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/e5e561edd67994b8c55f99c1228e47d77b1c2ee2))
## [0.7.1](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.7.0...v0.7.1) (2022-06-08)
### Bug Fixes
* **Router:** add NavigateToStore to interface ([dd5c42c](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/dd5c42c57d9ce6266f56237607bf37d8b5bd3b4c))
* **spinners:** add SVG props ([24244f6](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/24244f6e91e39a11bb964ee2779662084dcd0fd0))
# [0.7.0](https://github.com/SteamDeckHomebrew/decky-frontend-lib/compare/v0.6.0...v0.7.0) (2022-06-08)
### Features
* **components:** added shared item-props, progressbar, and more types for slider ([4328385](https://github.com/SteamDeckHomebrew/decky-frontend-lib/commit/43283853916f3993d92f6841b12f7ee47667e75b))
# [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))

686
LICENSE
View File

@@ -1,223 +1,398 @@
GNU GENERAL PUBLIC LICENSE GNU LESSER GENERAL PUBLIC LICENSE
Version 2, June 1991 Version 2.1, February 1999
Copyright (C) 1989, 1991 Free Software Foundation, Inc., Copyright (C) 1991, 1999 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed. of this license document, but changing it is not allowed.
Preamble [This is the first released version of the Lesser GPL. It also counts
as the successor of the GNU Library Public License, version 2, hence
the version number 2.1.]
The licenses for most software are designed to take away your Preamble
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not The licenses for most software are designed to take away your
price. Our General Public Licenses are designed to make sure that you freedom to share and change it. By contrast, the GNU General Public
have the freedom to distribute copies of free software (and charge for Licenses are intended to guarantee your freedom to share and change
this service if you wish), that you receive source code or can get it free software--to make sure the software is free for all its users.
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid This license, the Lesser General Public License, applies to some
anyone to deny you these rights or to ask you to surrender the rights. specially designated software packages--typically libraries--of the
These restrictions translate to certain responsibilities for you if you Free Software Foundation and other authors who decide to use it. You
distribute copies of the software, or if you modify it. can use it too, but we suggest you first think carefully about whether
this license or the ordinary General Public License is the better
strategy to use in any particular case, based on the explanations below.
For example, if you distribute copies of such a program, whether When we speak of free software, we are referring to freedom of use,
gratis or for a fee, you must give the recipients all the rights that not price. Our General Public Licenses are designed to make sure that
you have. You must make sure that they, too, receive or can get the you have the freedom to distribute copies of free software (and charge
source code. And you must show them these terms so they know their for this service if you wish); that you receive source code or can get
rights. it if you want it; that you can change the software and use pieces of
it in new free programs; and that you are informed that you can do
these things.
We protect your rights with two steps: (1) copyright the software, and To protect your rights, we need to make restrictions that forbid
(2) offer you this license which gives you legal permission to copy, distributors to deny you these rights or to ask you to surrender these
distribute and/or modify the software. rights. These restrictions translate to certain responsibilities for
you if you distribute copies of the library or if you modify it.
Also, for each author's protection and ours, we want to make certain For example, if you distribute copies of the library, whether gratis
that everyone understands that there is no warranty for this free or for a fee, you must give the recipients all the rights that we gave
software. If the software is modified by someone else and passed on, we you. You must make sure that they, too, receive or can get the source
want its recipients to know that what they have is not the original, so code. If you link other code with the library, you must provide
that any problems introduced by others will not reflect on the original complete object files to the recipients, so that they can relink them
authors' reputations. with the library after making changes to the library and recompiling
it. And you must show them these terms so they know their rights.
Finally, any free program is threatened constantly by software We protect your rights with a two-step method: (1) we copyright the
patents. We wish to avoid the danger that redistributors of a free library, and (2) we offer you this license, which gives you legal
program will individually obtain patent licenses, in effect making the permission to copy, distribute and/or modify the library.
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and To protect each distributor, we want to make it very clear that
modification follow. there is no warranty for the free library. Also, if the library is
modified by someone else and passed on, the recipients should know
that what they have is not the original version, so that the original
author's reputation will not be affected by problems that might be
introduced by others.
GNU GENERAL PUBLIC LICENSE Finally, software patents pose a constant threat to the existence of
any free program. We wish to make sure that a company cannot
effectively restrict the users of a free program by obtaining a
restrictive license from a patent holder. Therefore, we insist that
any patent license obtained for a version of the library must be
consistent with the full freedom of use specified in this license.
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION Most GNU software, including some libraries, is covered by the
ordinary GNU General Public License. This license, the GNU Lesser
General Public License, applies to certain designated libraries, and
is quite different from the ordinary General Public License. We use
this license for certain libraries in order to permit linking those
libraries into non-free programs.
0. This License applies to any program or other work which contains When a program is linked with a library, whether statically or using
a notice placed by the copyright holder saying it may be distributed a shared library, the combination of the two is legally speaking a
under the terms of this General Public License. The "Program", below, combined work, a derivative of the original library. The ordinary
refers to any such program or work, and a "work based on the Program" General Public License therefore permits such linking only if the
means either the Program or any derivative work under copyright law: entire combination fits its criteria of freedom. The Lesser General
that is to say, a work containing the Program or a portion of it, Public License permits more lax criteria for linking other code with
either verbatim or with modifications and/or translated into another the library.
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not We call this license the "Lesser" General Public License because it
covered by this License; they are outside its scope. The act of does Less to protect the user's freedom than the ordinary General
running the Program is not restricted, and the output from the Program Public License. It also provides other free software developers Less
is covered only if its contents constitute a work based on the of an advantage over competing non-free programs. These disadvantages
Program (independent of having been made by running the Program). are the reason we use the ordinary General Public License for many
Whether that is true depends on what the Program does. libraries. However, the Lesser license provides advantages in certain
special circumstances.
1. You may copy and distribute verbatim copies of the Program's For example, on rare occasions, there may be a special need to
source code as you receive it, in any medium, provided that you encourage the widest possible use of a certain library, so that it becomes
conspicuously and appropriately publish on each copy an appropriate a de-facto standard. To achieve this, non-free programs must be
copyright notice and disclaimer of warranty; keep intact all the allowed to use the library. A more frequent case is that a free
notices that refer to this License and to the absence of any warranty; library does the same job as widely used non-free libraries. In this
and give any other recipients of the Program a copy of this License case, there is little to gain by limiting the free library to free
along with the Program. software only, so we use the Lesser General Public License.
You may charge a fee for the physical act of transferring a copy, and In other cases, permission to use a particular library in non-free
you may at your option offer warranty protection in exchange for a fee. programs enables a greater number of people to use a large body of
free software. For example, permission to use the GNU C Library in
non-free programs enables many more people to use the whole GNU
operating system, as well as its variant, the GNU/Linux operating
system.
2. You may modify your copy or copies of the Program or any portion Although the Lesser General Public License is Less protective of the
of it, thus forming a work based on the Program, and copy and users' freedom, it does ensure that the user of a program that is
distribute such modifications or work under the terms of Section 1 linked with the Library has the freedom and the wherewithal to run
above, provided that you also meet all of these conditions: that program using a modified version of the Library.
a) You must cause the modified files to carry prominent notices The precise terms and conditions for copying, distribution and
stating that you changed the files and the date of any change. modification follow. Pay close attention to the difference between a
"work based on the library" and a "work that uses the library". The
former contains code derived from the library, whereas the latter must
be combined with the library in order to run.
b) You must cause any work that you distribute or publish, that in GNU LESSER GENERAL PUBLIC LICENSE
whole or in part contains or is derived from the Program or any TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively 0. This License Agreement applies to any software library or other
when run, you must cause it, when started running for such program which contains a notice placed by the copyright holder or
interactive use in the most ordinary way, to print or display an other authorized party saying it may be distributed under the terms of
announcement including an appropriate copyright notice and a this Lesser General Public License (also called "this License").
notice that there is no warranty (or else, saying that you provide Each licensee is addressed as "you".
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If A "library" means a collection of software functions and/or data
identifiable sections of that work are not derived from the Program, prepared so as to be conveniently linked with application programs
(which use some of those functions and data) to form executables.
The "Library", below, refers to any such software library or work
which has been distributed under these terms. A "work based on the
Library" means either the Library or any derivative work under
copyright law: that is to say, a work containing the Library or a
portion of it, either verbatim or with modifications and/or translated
straightforwardly into another language. (Hereinafter, translation is
included without limitation in the term "modification".)
"Source code" for a work means the preferred form of the work for
making modifications to it. For a library, complete source code means
all the source code for all modules it contains, plus any associated
interface definition files, plus the scripts used to control compilation
and installation of the library.
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running a program using the Library is not restricted, and output from
such a program is covered only if its contents constitute a work based
on the Library (independent of the use of the Library in a tool for
writing it). Whether that is true depends on what the Library does
and what the program that uses the Library does.
1. You may copy and distribute verbatim copies of the Library's
complete source code as you receive it, in any medium, provided that
you conspicuously and appropriately publish on each copy an
appropriate copyright notice and disclaimer of warranty; keep intact
all the notices that refer to this License and to the absence of any
warranty; and distribute a copy of this License along with the
Library.
You may charge a fee for the physical act of transferring a copy,
and you may at your option offer warranty protection in exchange for a
fee.
2. You may modify your copy or copies of the Library or any portion
of it, thus forming a work based on the Library, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) The modified work must itself be a software library.
b) You must cause the files modified to carry prominent notices
stating that you changed the files and the date of any change.
c) You must cause the whole of the work to be licensed at no
charge to all third parties under the terms of this License.
d) If a facility in the modified Library refers to a function or a
table of data to be supplied by an application program that uses
the facility, other than as an argument passed when the facility
is invoked, then you must make a good faith effort to ensure that,
in the event an application does not supply such function or
table, the facility still operates, and performs whatever part of
its purpose remains meaningful.
(For example, a function in a library to compute square roots has
a purpose that is entirely well-defined independent of the
application. Therefore, Subsection 2d requires that any
application-supplied function or table used by this function must
be optional: if the application does not supply it, the square
root function must still compute square roots.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Library,
and can be reasonably considered independent and separate works in and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of on the Library, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it. entire whole, and thus to each and every part regardless of who wrote
it.
Thus, it is not the intent of this section to claim rights or contest Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or exercise the right to control the distribution of derivative or
collective works based on the Program. collective works based on the Library.
In addition, mere aggregation of another work not based on the Program In addition, mere aggregation of another work not based on the Library
with the Program (or with a work based on the Program) on a volume of with the Library (or with a work based on the Library) on a volume of
a storage or distribution medium does not bring the other work under a storage or distribution medium does not bring the other work under
the scope of this License. the scope of this License.
3. You may copy and distribute the Program (or a work based on it, 3. You may opt to apply the terms of the ordinary GNU General Public
under Section 2) in object code or executable form under the terms of License instead of this License to a given copy of the Library. To do
Sections 1 and 2 above provided that you also do one of the following: this, you must alter all the notices that refer to this License, so
that they refer to the ordinary GNU General Public License, version 2,
instead of to this License. (If a newer version than version 2 of the
ordinary GNU General Public License has appeared, then you can specify
that version instead if you wish.) Do not make any other change in
these notices.
a) Accompany it with the complete corresponding machine-readable Once this change is made in a given copy, it is irreversible for
source code, which must be distributed under the terms of Sections that copy, so the ordinary GNU General Public License applies to all
1 and 2 above on a medium customarily used for software interchange; or, subsequent copies and derivative works made from that copy.
b) Accompany it with a written offer, valid for at least three This option is useful when you wish to copy part of the code of
years, to give any third party, for a charge no more than your the Library into a program that is not a library.
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer 4. You may copy and distribute the Library (or a portion or
to distribute corresponding source code. (This alternative is derivative of it, under Section 2) in object code or executable form
allowed only for noncommercial distribution and only if you under the terms of Sections 1 and 2 above provided that you accompany
received the program in object code or executable form with such it with the complete corresponding machine-readable source code, which
an offer, in accord with Subsection b above.) must be distributed under the terms of Sections 1 and 2 above on a
medium customarily used for software interchange.
The source code for a work means the preferred form of the work for If distribution of object code is made by offering access to copy
making modifications to it. For an executable work, complete source from a designated place, then offering equivalent access to copy the
code means all the source code for all modules it contains, plus any source code from the same place satisfies the requirement to
associated interface definition files, plus the scripts used to distribute the source code, even though third parties are not
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code. compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program 5. A program that contains no derivative of any portion of the
except as expressly provided under this License. Any attempt Library, but is designed to work with the Library by being compiled or
otherwise to copy, modify, sublicense or distribute the Program is linked with it, is called a "work that uses the Library". Such a
void, and will automatically terminate your rights under this License. work, in isolation, is not a derivative work of the Library, and
However, parties who have received copies, or rights, from you under therefore falls outside the scope of this License.
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not However, linking a "work that uses the Library" with the Library
signed it. However, nothing else grants you permission to modify or creates an executable that is a derivative of the Library (because it
distribute the Program or its derivative works. These actions are contains portions of the Library), rather than a "work that uses the
prohibited by law if you do not accept this License. Therefore, by library". The executable is therefore covered by this License.
modifying or distributing the Program (or any work based on the Section 6 states terms for distribution of such executables.
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the When a "work that uses the Library" uses material from a header file
Program), the recipient automatically receives a license from the that is part of the Library, the object code for the work may be a
original licensor to copy, distribute or modify the Program subject to derivative work of the Library even though the source code is not.
these terms and conditions. You may not impose any further Whether this is true is especially significant if the work can be
restrictions on the recipients' exercise of the rights granted herein. linked without the Library, or if the work is itself a library. The
You are not responsible for enforcing compliance by third parties to threshold for this to be true is not precisely defined by law.
this License.
7. If, as a consequence of a court judgment or allegation of patent If such an object file uses only numerical parameters, data
infringement or for any other reason (not limited to patent issues), structure layouts and accessors, and small macros and small inline
conditions are imposed on you (whether by court order, agreement or functions (ten lines or less in length), then the use of the object
otherwise) that contradict the conditions of this License, they do not file is unrestricted, regardless of whether it is legally a derivative
excuse you from the conditions of this License. If you cannot work. (Executables containing this object code plus portions of the
distribute so as to satisfy simultaneously your obligations under this Library will still fall under Section 6.)
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under Otherwise, if the work is a derivative of the Library, you may
any particular circumstance, the balance of the section is intended to distribute the object code for the work under the terms of Section 6.
apply and the section as a whole is intended to apply in other Any executables containing that work also fall under Section 6,
circumstances. whether or not they are linked directly with the Library itself.
6. As an exception to the Sections above, you may also combine or
link a "work that uses the Library" with the Library to produce a
work containing portions of the Library, and distribute that work
under terms of your choice, provided that the terms permit
modification of the work for the customer's own use and reverse
engineering for debugging such modifications.
You must give prominent notice with each copy of the work that the
Library is used in it and that the Library and its use are covered by
this License. You must supply a copy of this License. If the work
during execution displays copyright notices, you must include the
copyright notice for the Library among them, as well as a reference
directing the user to the copy of this License. Also, you must do one
of these things:
a) Accompany the work with the complete corresponding
machine-readable source code for the Library including whatever
changes were used in the work (which must be distributed under
Sections 1 and 2 above); and, if the work is an executable linked
with the Library, with the complete machine-readable "work that
uses the Library", as object code and/or source code, so that the
user can modify the Library and then relink to produce a modified
executable containing the modified Library. (It is understood
that the user who changes the contents of definitions files in the
Library will not necessarily be able to recompile the application
to use the modified definitions.)
b) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (1) uses at run time a
copy of the library already present on the user's computer system,
rather than copying library functions into the executable, and (2)
will operate properly with a modified version of the library, if
the user installs one, as long as the modified version is
interface-compatible with the version that the work was made with.
c) Accompany the work with a written offer, valid for at
least three years, to give the same user the materials
specified in Subsection 6a, above, for a charge no more
than the cost of performing this distribution.
d) If distribution of the work is made by offering access to copy
from a designated place, offer equivalent access to copy the above
specified materials from the same place.
e) Verify that the user has already received a copy of these
materials or that you have already sent this user a copy.
For an executable, the required form of the "work that uses the
Library" must include any data and utility programs needed for
reproducing the executable from it. However, as a special exception,
the materials to be distributed need not include anything that is
normally distributed (in either source or binary form) with the major
components (compiler, kernel, and so on) of the operating system on
which the executable runs, unless that component itself accompanies
the executable.
It may happen that this requirement contradicts the license
restrictions of other proprietary libraries that do not normally
accompany the operating system. Such a contradiction means you cannot
use both them and the Library together in an executable that you
distribute.
7. You may place library facilities that are a work based on the
Library side-by-side in a single library together with other library
facilities not covered by this License, and distribute such a combined
library, provided that the separate distribution of the work based on
the Library and of the other library facilities is otherwise
permitted, and provided that you do these two things:
a) Accompany the combined library with a copy of the same work
based on the Library, uncombined with any other library
facilities. This must be distributed under the terms of the
Sections above.
b) Give prominent notice with the combined library of the fact
that part of it is a work based on the Library, and explaining
where to find the accompanying uncombined form of the same work.
8. You may not copy, modify, sublicense, link with, or distribute
the Library except as expressly provided under this License. Any
attempt otherwise to copy, modify, sublicense, link with, or
distribute the Library is void, and will automatically terminate your
rights under this License. However, parties who have received copies,
or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.
9. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Library or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Library (or any work based on the
Library), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Library or works based on it.
10. Each time you redistribute the Library (or any work based on the
Library), the recipient automatically receives a license from the
original licensor to copy, distribute, link with or modify the Library
subject to these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties with
this License.
11. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Library at all. For example, if a patent
license would not permit royalty-free redistribution of the Library by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Library.
If any portion of this section is held invalid or unenforceable under any
particular circumstance, the balance of the section is intended to apply,
and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is integrity of the free software distribution system which is
implemented by public license practices. Many people have made implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing system; it is up to the author/donor to decide if he or she is willing
@@ -227,114 +402,103 @@ impose that choice.
This section is intended to make thoroughly clear what is believed to This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License. be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in 12. If the distribution and/or use of the Library is restricted in
certain countries either by patents or by copyrighted interfaces, the certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License original copyright holder who places the Library under this License may add
may add an explicit geographical distribution limitation excluding an explicit geographical distribution limitation excluding those countries,
those countries, so that distribution is permitted only in or among so that distribution is permitted only in or among countries not thus
countries not thus excluded. In such case, this License incorporates excluded. In such case, this License incorporates the limitation as if
the limitation as if written in the body of this License. written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions 13. The Free Software Foundation may publish revised and/or new
of the General Public License from time to time. Such new versions will versions of the Lesser General Public License from time to time.
be similar in spirit to the present version, but may differ in detail to Such new versions will be similar in spirit to the present version,
address new problems or concerns. but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program Each version is given a distinguishing version number. If the Library
specifies a version number of this License which applies to it and "any specifies a version number of this License which applies to it and
later version", you have the option of following the terms and conditions "any later version", you have the option of following the terms and
either of that version or of any later version published by the Free conditions either of that version or of any later version published by
Software Foundation. If the Program does not specify a version number of the Free Software Foundation. If the Library does not specify a
this License, you may choose any version ever published by the Free Software license version number, you may choose any version ever published by
Foundation. the Free Software Foundation.
10. If you wish to incorporate parts of the Program into other free 14. If you wish to incorporate parts of the Library into other free
programs whose distribution conditions are different, write to the author programs whose distribution conditions are incompatible with these,
to ask for permission. For software which is copyrighted by the Free write to the author to ask for permission. For software which is
Software Foundation, write to the Free Software Foundation; we sometimes copyrighted by the Free Software Foundation, write to the Free
make exceptions for this. Our decision will be guided by the two goals Software Foundation; we sometimes make exceptions for this. Our
of preserving the free status of all derivatives of our free software and decision will be guided by the two goals of preserving the free status
of promoting the sharing and reuse of software generally. of all derivatives of our free software and of promoting the sharing
and reuse of software generally.
NO WARRANTY NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
REPAIR OR CORRECTION. THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
POSSIBILITY OF SUCH DAMAGES. SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
END OF TERMS AND CONDITIONS END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs How to Apply These Terms to Your New Libraries
If you develop a new program, and you want it to be of the greatest If you develop a new library, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it possible use to the public, we recommend making it free software that
free software which everyone can redistribute and change under these terms. everyone can redistribute and change. You can do so by permitting
redistribution under these terms (or, alternatively, under the terms of the
ordinary General Public License).
To do so, attach the following notices to the program. It is safest To apply these terms, attach the following notices to the library. It is
to attach them to the start of each source file to most effectively safest to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least convey the exclusion of warranty; and each file should have at least the
the "copyright" line and a pointer to where the full notice is found. "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.> <one line to give the library's name and a brief idea of what it does.>
Copyright (C) <year> <name of author> Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify This library is free software; you can redistribute it and/or
it under the terms of the GNU General Public License as published by modify it under the terms of the GNU Lesser General Public
the Free Software Foundation; either version 2 of the License, or License as published by the Free Software Foundation; either
(at your option) any later version. version 2.1 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
GNU General Public License for more details. Lesser General Public License for more details.
You should have received a copy of the GNU General Public License along You should have received a copy of the GNU Lesser General Public
with this program; if not, write to the Free Software Foundation, Inc., License along with this library; if not, write to the Free Software
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
USA
Also add information on how to contact you by electronic and paper mail. Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if school, if any, to sign a "copyright disclaimer" for the library, if
necessary. Here is a sample; alter the names: necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program Yoyodyne, Inc., hereby disclaims all copyright interest in the
`Gnomovision' (which makes passes at compilers) written by James Hacker. library `Frob' (a library for tweaking knobs) written by James Random
Hacker.
<signature of Ty Coon>, 1 April 1989 <signature of Ty Coon>, 1 April 1990
Ty Coon, President of Vice Ty Coon, President of Vice
This General Public License does not permit incorporating your program into That's all there is to it!
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.

View File

@@ -1 +1,27 @@
# Decky Frontend Library # 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.

11916
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,15 +1,18 @@
{ {
"name": "decky-frontend-lib", "name": "decky-frontend-lib",
"version": "0.0.4", "version": "3.1.1",
"description": "A library for building decky plugins", "description": "A library for building decky plugins",
"main": "dist/index.js", "main": "dist/index.js",
"types": "dist/index.d.ts", "types": "dist/index.d.ts",
"module": "dist/index.js", "module": "dist/index.js",
"sideEffects": false,
"scripts": { "scripts": {
"build": "shx rm -rf dist && tsc -b", "build": "shx rm -rf dist && tsc -b",
"dev": "tsc -b -w", "dev": "tsc -b -w",
"prepack": "npm run build", "prepack": "npm run build",
"test": "jest" "test": "echo 'No tests for now!'",
"prepare": "husky install",
"commit": "git-cz"
}, },
"files": [ "files": [
"/lib", "/lib",
@@ -32,20 +35,45 @@
"url": "https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues" "url": "https://github.com/SteamDeckHomebrew/decky-frontend-lib/issues"
}, },
"homepage": "https://github.com/SteamDeckHomebrew/decky-frontend-lib#readme", "homepage": "https://github.com/SteamDeckHomebrew/decky-frontend-lib#readme",
"config": {
"commitizen": {
"path": "@commitlint/cz-commitlint"
}
},
"devDependencies": { "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/jest": "^27.4.1",
"@types/react": "16.14.0", "@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", "import-sort-style-module": "^6.0.0",
"jest": "^27.5.1", "jest": "^27.5.1",
"prettier-plugin-import-sort": "^0.0.7", "prettier-plugin-import-sort": "^0.0.7",
"semantic-release": "^19.0.3",
"shx": "^0.3.4", "shx": "^0.3.4",
"ts-jest": "^27.1.4", "ts-jest": "^27.1.4",
"typescript": "^4.6.3" "typescript": "^4.6.3"
}, },
"pnpm": {
"peerDependencyRules": {
"ignoreMissing": [
"react",
"react-dom"
]
}
},
"importSort": { "importSort": {
".js, .jsx, .ts, .tsx": { ".js, .jsx, .ts, .tsx": {
"style": "module", "style": "module",
"parser": "typescript" "parser": "typescript"
} }
},
"dependencies": {
"minimist": "^1.2.6"
} }
} }

View File

@@ -0,0 +1,41 @@
import { Spinner } from '../deck-components';
import { useEffect } from 'react';
import { FC, ImgHTMLAttributes, useState } from 'react';
interface SuspensefulImageProps extends ImgHTMLAttributes<HTMLImageElement> {
suspenseWidth?: string | number;
suspenseHeight?: string | number;
}
export const SuspensefulImage: FC<SuspensefulImageProps> = (props) => {
const [loading, setLoading] = useState(true);
const [error, setError] = useState(false);
useEffect(() => {
const img = new Image();
img.src = props.src || '';
img.addEventListener('load', () => {
setLoading(false);
});
img.addEventListener('error', () => {
setError(true);
});
}, []);
return loading ? (
<div
style={{
width: props.suspenseWidth || props.style?.width,
height: props.suspenseHeight || props.style?.height,
background: 'rgba(255, 255, 255, 0.2)',
display: 'flex',
alignItems: 'center',
justifyContent: 'center',
}}
>
{error ? 'Missing image' : <Spinner style={{ height: '48px' }} />}
</div>
) : (
<img {...props} />
);
};

View File

@@ -0,0 +1 @@
export * from './SuspensefulImage';

View File

@@ -1,29 +1,21 @@
import { FC } from 'react'; import { CSSProperties, FC } from 'react';
import { CommonUIModule } from '../webpack'; import { CommonUIModule } from '../webpack';
interface ButtonProps { export interface DialogButtonProps {
label?: string;
style: CSSProperties;
className?: string; className?: string;
noFocusRing?: boolean; noFocusRing?: boolean;
disabled?: boolean; description?: string;
layout?: 'below';
onClick?(e: MouseEvent): void; onClick?(e: MouseEvent): void;
onPointerDown?(e: PointerEvent): void; disabled?: boolean;
onPointerUp?(e: PointerEvent): void; bottomSeparator?: boolean;
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 DialogButton = Object.values(CommonUIModule).find( export const DialogButton = Object.values(CommonUIModule).find(
(mod: any) => (mod: any) =>
mod?.render?.toString()?.includes('Object.assign({type:"button"') && mod?.render?.toString()?.includes('Object.assign({type:"button"') &&
mod?.render?.toString()?.includes('DialogButton'), mod?.render?.toString()?.includes('DialogButton'),
) as any; ) as FC<DialogButtonProps>;
// 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

View File

@@ -1,17 +1,13 @@
import { FC } from 'react'; import { FC } from 'react';
import { CommonUIModule } from '../webpack'; import { CommonUIModule } from '../webpack';
import { ItemProps } from './Item';
interface ButtonItemProps { export interface ButtonItemProps extends ItemProps {
label?: string;
description?: string;
layout?: 'below';
icon?: JSX.Element;
onClick?(e: MouseEvent): void; onClick?(e: MouseEvent): void;
disabled?: boolean; disabled?: boolean;
bottomSeparator?: boolean;
} }
export const ButtonItem = Object.values(CommonUIModule).find((mod: any) => 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>; ) as FC<ButtonItemProps>;

View File

@@ -0,0 +1,28 @@
import { HTMLAttributes, ReactNode, RefAttributes, VFC } from "react";
import { findModuleChild } from "../webpack";
export interface CarouselProps extends HTMLAttributes<HTMLDivElement> {
autoFocus?: boolean;
enableBumperPaging?: boolean;
fnDoesItemTakeFocus?: (...unknown: any[]) => boolean;
fnGetColumnWidth?: (...unknown: any[]) => number;
fnGetId?: (id: number) => number;
fnItemRenderer?: (id: number, ...unknown: any[]) => ReactNode;
fnUpdateArrows?: (...unknown: any[]) => any;
initialColumn?: number;
nHeight?: number;
nIndexLeftmost?: number;
nItemHeight?: number;
nItemMarginX?: number;
nNumItems?: number;
name?: string;
scrollToAlignment?: 'center';
}
export const Carousel = findModuleChild((m) => {
if (typeof m !== 'object') return undefined;
for (let prop in m) {
if (m[prop]?.render?.toString().includes("setFocusedColumn:"))
return m[prop];
}
}) as VFC<CarouselProps & RefAttributes<HTMLDivElement>>;

View File

@@ -0,0 +1,44 @@
import { ReactNode, VFC } from 'react';
import { CommonUIModule } from '../webpack';
import { ItemProps } from './Item';
export interface SingleDropdownOption {
data: any;
label: ReactNode;
options?: never;
}
export interface MultiDropdownOption {
label: ReactNode;
options: DropdownOption[];
data?: never;
}
export type DropdownOption = SingleDropdownOption | MultiDropdownOption;
export interface DropdownProps {
rgOptions: DropdownOption[];
selectedOption: any;
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, ItemProps {}
export const DropdownItem = Object.values(CommonUIModule).find((mod: any) =>
mod?.toString()?.includes('"dropDownControlRef","description"'),
) as VFC<DropdownItemProps>;

View File

@@ -0,0 +1,27 @@
import { FC, HTMLAttributes, ReactNode, RefAttributes } from 'react';
import { findModuleChild } from '../webpack';
import { FooterLegendProps } from './FooterLegend';
export interface FieldProps extends HTMLAttributes<HTMLDivElement>, FooterLegendProps {
label?: ReactNode;
bottomSeparator?: 'standard' | 'thick' | 'none';
description?: ReactNode;
disabled?: boolean;
icon?: ReactNode;
inlineWrap?: 'keep-inline' | 'shift-children-below'; // If label is too long it will move shildren below before starting to wrap label
childrenLayout?: 'below' | 'inline';
childrenContainerWidth?: 'min' | 'max' | 'fixed'; // Does not work with childrenLayout==='below'
spacingBetweenLabelAndChild?: 'none'; // This applies only when childrenLayout==='below'
padding?: 'none' | 'standard' | 'compact';
className?: string;
highlightOnFocus?: boolean;
indentLevel?: number;
verticalAlignment?: 'center' | 'none'; // Alligns inline label with children
}
export const Field = findModuleChild((m) => {
if (typeof m !== "object") return undefined;
for (let prop in m) {
if (m[prop]?.render?.toString().includes('"shift-children-below"')) return m[prop]
}
}) as FC<FieldProps & RefAttributes<HTMLDivElement>>;

View File

@@ -0,0 +1,18 @@
import { ElementType, FC, ReactNode } from "react";
import { findModuleChild } from "../webpack";
export interface FocusRingProps {
className?: string,
rootClassName?: string,
render?: ElementType,
children?: ReactNode,
NavigationManager?: any
}
export const FocusRing = findModuleChild((m: any) => {
if (typeof m !== 'object') return false;
for (let prop in m) {
if (m[prop]?.toString()?.includes('.GetShowDebugFocusRing())')) return m[prop];
}
return false;
}) as FC<FocusRingProps>;

View File

@@ -0,0 +1,20 @@
import { HTMLAttributes, ReactNode, RefAttributes, VFC } from "react";
import { findModuleChild } from "../webpack";
import { FooterLegendProps } from "./FooterLegend";
export interface FocusableProps extends HTMLAttributes<HTMLDivElement>, FooterLegendProps {
children: ReactNode;
"flow-children"?: string;
focusClassName?: string;
focusWithinClassName?: string;
onActivate?: (e: CustomEvent) => void;
onCancel?: (e: CustomEvent) => void;
}
export const Focusable = findModuleChild((m) => {
if (typeof m !== 'object') return undefined;
for (let prop in m) {
if (m[prop]?.render?.toString()?.includes('["flow-children","onActivate","onCancel","focusClassName",'))
return m[prop];
}
}) as VFC<FocusableProps & RefAttributes<HTMLDivElement>>;

View File

@@ -0,0 +1,18 @@
export interface FooterLegendProps {
actionDescriptionMap?: unknown;
onOKActionDescription?: string;
onCancelActionDescription?: string;
onSecondaryActionDescription?: string;
onOptionsActionDescription?: string;
onMenuActionDescription?: string;
onButtonDown?: () => void;
onButtonUp?: () => void;
onOKButton?: () => void;
onCancelButton?: () => void;
onSecondaryButton?: () => void;
onOptionsButton?: () => void;
onGamepadDirection?: () => void;
onGamepadFocus?: () => void;
onGamepadBlur?: () => void;
onMenuButton?: () => void;
}

View File

@@ -0,0 +1,11 @@
import { ReactNode } from 'react';
export interface ItemProps {
label?: string;
description?: string;
layout?: 'below' | 'inline';
icon?: ReactNode;
bottomSeparator?: 'standard' | 'thick' | 'none';
indentLevel?: number;
tooltip?: string;
}

15
src/deck-components/Menu.tsx Normal file → Executable file
View File

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

43
src/deck-components/Modal.tsx Normal file → Executable file
View File

@@ -1,12 +1,49 @@
import { ReactNode } from 'react'; import { FC, ReactNode } from 'react';
import { findModuleChild } from '../webpack'; 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; if (typeof m !== 'object') return undefined;
for (let prop in m) { 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]; return m[prop];
} }
} }
}); });
export interface ModalRootProps {
onCancel?(): void;
closeModal?(): void;
onOK?(): void;
onEscKeypress?(): void;
className?: string;
modalClassName?: string;
bAllowFullSize?: boolean;
bDestructiveWarning?: boolean;
bDisableBackgroundDismiss?: boolean;
bHideCloseIcon?: boolean;
bOKDisabled?: boolean;
}
export interface ConfirmModalProps extends ModalRootProps {
onMiddleButton?(): void;
}
export const ConfirmModal = 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<ConfirmModalProps>;
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>;

View File

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

View File

@@ -0,0 +1,44 @@
import { VFC, ReactNode } from 'react';
import { findModuleChild } from '../webpack';
import { ItemProps } from './Item';
export interface ProgressBarItemProps extends ItemProps {
indeterminate?: boolean;
nTransitionSec?: number;
nProgress?: number;
focusable?: boolean;
}
export interface ProgressBarProps {
indeterminate?: boolean;
nTransitionSec?: number;
nProgress?: number;
focusable?: boolean;
}
export interface ProgressBarWithInfoProps extends ProgressBarItemProps {
sTimeRemaining?: ReactNode;
sOperationText?: ReactNode;
}
export const ProgressBar = findModuleChild((m) => {
if (typeof m !== 'object') return undefined;
for (let prop in m) {
if (m[prop]?.toString()?.includes('.ProgressBar,"standard"==')) return m[prop];
}
}) as VFC<ProgressBarProps>;
export const ProgressBarWithInfo = findModuleChild((m) => {
if (typeof m !== 'object') return undefined;
for (let prop in m) {
if (m[prop]?.toString()?.includes('.ProgressBarFieldStatus},')) return m[prop];
}
}) as VFC<ProgressBarWithInfoProps>;
export const ProgressBarItem = findModuleChild((m) => {
if (typeof m !== 'object') return undefined;
for (let prop in m) {
if (m[prop]?.toString()?.includes('"indeterminate","nTransitionSec"')) return m[prop];
}
}) as VFC<ProgressBarItemProps>;

View File

@@ -0,0 +1,98 @@
import { Module, findModuleChild } from '../webpack';
export enum SideMenu {
None,
Main,
QuickAccess,
}
export enum QuickAccessTab {
Notifications,
RemotePlayTogetherControls,
VoiceChat,
Friends,
Settings,
Perf,
Help,
Decky,
}
export enum DisplayStatus {
Invalid = 0,
Launching = 1,
Uninstalling = 2,
Installing = 3,
Running = 4,
Validating = 5,
Updating = 6,
Downloading = 7,
Synchronizing = 8,
ReadyToInstall = 9,
ReadyToPreload = 10,
ReadyToLaunch = 11,
RegionRestricted = 12,
PresaleOnly = 13,
InvalidPlatform = 14,
PreloadComplete = 16,
BorrowerLocked = 17,
UpdatePaused = 18,
UpdateQueued = 19,
UpdateRequired = 20,
UpdateDisabled = 21,
DownloadPaused = 22,
DownloadQueued = 23,
DownloadRequired = 24,
DownloadDisabled = 25,
LicensePending = 26,
LicenseExpired = 27,
AvailForFree = 28,
AvailToBorrow = 29,
AvailGuestPass = 30,
Purchase = 31,
Unavailable = 32,
NotLaunchable = 33,
CloudError = 34,
CloudOutOfDate = 35,
Terminating = 36,
}
export type AppOverview = {
appid: string
display_name: string
display_status: DisplayStatus
sort_as: string
}
export interface Router {
CloseSideMenus(): void;
OpenQuickAccessMenu(quickAccessTab?: QuickAccessTab): void;
GetQuickAccessTab(): QuickAccessTab;
Navigate(path: string): void;
NavigateBackOrOpenMenu(): void;
NavigateToAppProperties(): void
NavigateToBugForum(): void
NavigateToExternalWeb(url: string): void;
NavigateToHelp(): void
NavigateToInvites(): void
NavigateToRunningApp(replace?: boolean): 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(): AppOverview[];
get MainRunningApp(): AppOverview | undefined;
}
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;

View File

@@ -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>;

View File

@@ -1,26 +0,0 @@
import { FC } from 'react';
import { CommonUIModule } from '../webpack';
interface NotchLabel {
notchIndex: number;
label: string;
value: number;
}
interface SliderProps {
label?: string;
value: number;
layout?: 'below';
icon?: JSX.Element;
min?: number;
max?: number;
step?: number;
notchCount?: number;
notchLabels?: NotchLabel[];
onChange?(value: number): void;
}
export const Slider = Object.values(CommonUIModule).find((mod: any) =>
mod?.render?.toString()?.includes('SliderField,fallback'),
) as FC<SliderProps>;

View File

@@ -0,0 +1,32 @@
import { FC } from 'react';
import { CommonUIModule } from '../webpack';
import { ItemProps } from './Item';
export interface NotchLabel {
notchIndex: number;
label: string;
value?: number;
}
export interface SliderFieldProps extends ItemProps {
value: number;
min?: number;
max?: number;
step?: number;
notchCount?: number;
notchLabels?: NotchLabel[];
notchTicksVisible?: boolean;
showValue?: boolean;
resetValue?: number;
disabled?: boolean;
editableValue?: boolean;
validValues?: 'steps' | 'range' | ((value: number) => boolean);
valueSuffix?: string;
minimumDpadGranularity?: number;
onChange?(value: number): void;
}
export const SliderField = Object.values(CommonUIModule).find((mod: any) =>
mod?.toString()?.includes('SliderField,fallback'),
) as FC<SliderFieldProps>;

14
src/deck-components/Spinner.tsx Normal file → Executable file
View File

@@ -1,16 +1,8 @@
import { FC } from 'react'; import { FC, SVGAttributes } from 'react';
import { IconsModule } from '../webpack'; import { IconsModule } from '../webpack';
// interface ButtonProps { // TODO type this and other icons?
// label?: string;
// description?: string;
// layout?: 'below';
// onClick?(e: MouseEvent): void;
// disabled?: boolean;
// bottomSeparator?: boolean;
// }
export const Spinner = Object.values(IconsModule).find((mod: any) => export const Spinner = Object.values(IconsModule).find((mod: any) =>
mod?.toString && /Spinner\)}\),.\.createElement\(\"path\",{d:\"M18 /.test(mod.toString()) mod?.toString && /Spinner\)}\),.\.createElement\(\"path\",{d:\"M18 /.test(mod.toString())
) as FC<{}>; ) as FC<SVGAttributes<SVGElement>>;

View File

@@ -0,0 +1,9 @@
import { FC, SVGAttributes } 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<SVGAttributes<SVGElement>>;

View File

@@ -0,0 +1,28 @@
import { ChangeEventHandler, HTMLAttributes, ReactNode, VFC } from 'react';
import { CommonUIModule, Module } from '../webpack';
export interface TextFieldProps extends HTMLAttributes<HTMLInputElement> {
label?: ReactNode;
requiredLabel?: ReactNode;
description?: ReactNode;
disabled?: boolean;
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>;

View File

@@ -2,15 +2,13 @@ import { FC } from 'react';
import { CommonUIModule } from '../webpack'; import { CommonUIModule } from '../webpack';
interface ToggleProps { export interface ToggleProps {
label?: string; value: boolean;
description?: string;
checked: boolean;
icon?: JSX.Element;
disabled?: boolean; disabled?: boolean;
onChange?(checked: boolean): void; onChange?(checked: boolean): void;
navRef?: any; // TODO figure out what this is
} }
export const Toggle = Object.values(CommonUIModule).find((mod: any) => export const Toggle = Object.values(CommonUIModule).find((mod: any) =>
mod?.render?.toString()?.includes('ToggleField,fallback'), mod?.render?.toString()?.includes('.ToggleOff)'),
) as FC<ToggleProps>; ) as FC<ToggleProps>;

View File

@@ -0,0 +1,14 @@
import { FC } from 'react';
import { CommonUIModule } from '../webpack';
import { ItemProps } from './Item';
export interface ToggleFieldProps extends ItemProps {
checked: boolean;
disabled?: boolean;
onChange?(checked: boolean): void;
}
export const ToggleField = Object.values(CommonUIModule).find((mod: any) =>
mod?.render?.toString()?.includes('ToggleField,fallback'),
) as FC<ToggleFieldProps>;

14
src/deck-components/index.ts Normal file → Executable file
View File

@@ -1,9 +1,21 @@
export * from './Button'; export * from './Button';
export * from './ButtonItem'; export * from './ButtonItem';
export * from './Carousel';
export * from './Dropdown';
export * from './Field';
export * from './Focusable';
export * from './FocusRing';
export * from './FooterLegend';
export * from './Menu'; export * from './Menu';
export * from './Modal'; export * from './Modal';
export * from './Panel'; export * from './Panel';
export * from './Slider'; export * from './ProgressBar';
export * from './Router';
export * from './SidebarNavigation';
export * from './SliderField';
export * from './Spinner'; export * from './Spinner';
export * from './static-classes'; export * from './static-classes';
export * from './SteamSpinner';
export * from './TextField';
export * from './Toggle'; export * from './Toggle';
export * from './ToggleField';

View File

@@ -1,4 +1,4 @@
import { findModuleChild } from '../webpack'; import { findModule } from '../webpack';
type StaticClasses = Record< type StaticClasses = Record<
| 'ActiveTab' | 'ActiveTab'
@@ -63,10 +63,253 @@ type StaticClasses = Record<
string string
>; >;
export const staticClasses: StaticClasses = findModuleChild((mod) => { type ScrollClasses = Record<
if (typeof mod !== 'object') return false; | 'ScrollBoth'
| 'ScrollPanel'
| 'ScrollX'
| 'ScrollY',
string
>;
if (mod.TransitionMenuDelay) { type GamepadDialogClasses = Record<
return mod; | '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
>;
type UpdaterFieldClasses = Record<
| "duration-app-launch"
| "OOBEUpdateStatusContainer"
| "UpdateScreen"
| "UpdatePanel"
| "CurrentStatus"
| "TotalUpdateSize"
| "ProgressInfoContainer"
| "TimeRemaining"
| "BatteryLowWarning"
| "fadeInAnimation"
| "ProgressStatus"
| "UpdateStatusContainer"
| "UpdaterFieldStatusSuccess"
| "UpdaterFieldStatusApplying"
| "TextContainer"
| "ApplyingText"
| "UpdateBytesRemaining"
| "Label"
| "Numerator"
| "Separator"
| "Denominator"
| "PatchNotes"
| "PostedTime"
| "EventDetailTitle"
| "EventDetailsSubTitle"
| "EventDetailsBody"
| "InsufficientBatteryText"
| "UnsupportedHardwareWarning"
| "Title"
| "Text"
| "Body"
| "ItemFocusAnim-darkerGrey-nocolor"
| "ItemFocusAnim-darkerGrey"
| "ItemFocusAnim-darkGrey"
| "ItemFocusAnim-grey"
| "ItemFocusAnimBorder-darkGrey"
| "ItemFocusAnim-green"
| "focusAnimation"
| "hoverAnimation",
string
>;
type PlaySectionClasses = Record<
| "AchievementCountLabel"
| "AchievementProgressRow"
| "ActionSection"
| "AppButtonsContainer"
| "Arrow"
| "AvatarAndPersona"
| "BreakNarrow"
| "BreakShort"
| "BreakTall"
| "BreakUltraWide"
| "BreakWide"
| "ClickablePlayBarItem"
| "CloudStatusIcon"
| "CloudStatusLabel"
| "CloudStatusRow"
| "CloudSyncProblem"
| "CloudSynching"
| "ComingSoon"
| "Container"
| "DetailsProgressBar"
| "DetailsProgressContainer"
| "DetailsSection"
| "DetailsSectionExtra"
| "DetailsSectionStatus"
| "DotDotDot"
| "DownloadPaused"
| "DownloadProgressBar"
| "Downloading"
| "FavoriteButton"
| "Favorited"
| "GameInfoButton"
| "GameStat"
| "GameStatIcon"
| "GameStatIconForced"
| "GameStatRight"
| "GameStatsSection"
| "GamepadUIBreakNarrow"
| "GamepadUIBreakShort"
| "GamepadUIBreakWide"
| "Glassy"
| "HideWhenNarrow"
| "Icon"
| "Icons"
| "InPage"
| "InnerContainer"
| "InvalidPlatform"
| "ItemFocusAnim-darkGrey"
| "ItemFocusAnim-darkerGrey"
| "ItemFocusAnim-darkerGrey-nocolor"
| "ItemFocusAnim-green"
| "ItemFocusAnim-grey"
| "ItemFocusAnimBorder-darkGrey"
| "Label"
| "LastPlayed"
| "LastPlayedInfo"
| "MenuActive"
| "MenuButton"
| "MiniAchievements"
| "OfflineMode"
| "OnlyDownloadBar"
| "PermanentlyUnavailable"
| "PlayBar"
| "PlayBarCloudStatusContainer"
| "PlayBarDetailLabel"
| "PlayBarGameIcon"
| "PlayBarGameName"
| "PlayBarIconAndGame"
| "PlayBarLabel"
| "Playtime"
| "PlaytimeIcon"
| "PlaytimeIconForced"
| "PortraitBar"
| "Presale"
| "RecentlyUpdated"
| "RecentlyUpdatedIcon"
| "RecentlyUpdatedLink"
| "RecentlyUpdatedText"
| "RightBreakNarrow"
| "RightBreakUltraNarrow"
| "RightBreakUltraWide"
| "RightBreakWide"
| "RightControls"
| "Row"
| "SharedLibrary"
| "StatusAndStats"
| "StatusNameContainer"
| "StickyHeader"
| "StickyHeaderShadow"
| "SuperimposedGridItems"
| "SyncAnim"
| "Visible"
| "duration-app-launch"
| "favorited"
| "focusAnimation"
| "hoverAnimation",
string
>;
export const staticClasses: StaticClasses = findModule((mod) => typeof mod === 'object' && mod.TransitionMenuDelay);
export const scrollClasses: ScrollClasses = findModule((mod) => typeof mod === 'object' && mod.ScrollPanel && mod.ScrollY);
export const gamepadDialogClasses: GamepadDialogClasses = findModule((mod) => typeof mod === 'object' && mod.WithFirstRow);
export const quickAccessControlsClasses: QuickAccessControlsClasses = findModule((mod) => typeof mod === 'object' && mod.PanelSectionRow);
export const updaterFieldClasses: UpdaterFieldClasses = findModule((mod) => typeof mod === 'object' && mod.PatchNotes && mod.PostedTime);
export const playSectionClasses: PlaySectionClasses = findModule((mod) => typeof mod === 'object' && mod.MenuButton && mod.MenuActive);

View File

@@ -1,4 +1,5 @@
// export * from './deck-libs'; // export * from './deck-libs';
export * from './custom-components';
export * from './deck-components'; export * from './deck-components';
export * from './plugin'; export * from './plugin';
export * from './webpack'; export * from './webpack';

View File

@@ -1,7 +1,10 @@
import type { ComponentType, ReactNode } from 'react';
import { RouteProps } from 'react-router';
export interface Plugin { export interface Plugin {
title: JSX.Element; title: JSX.Element;
icon: JSX.Element; icon: JSX.Element;
content: JSX.Element; content?: JSX.Element;
onDismount?(): void; onDismount?(): void;
} }
@@ -15,13 +18,47 @@ interface ServerResponseError {
result: string; result: string;
} }
type ServerResponse<TRes> = ServerResponseSuccess<TRes> | ServerResponseError; export type ServerResponse<TRes> = ServerResponseSuccess<TRes> | ServerResponseError;
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 FilePickerRes {
path: string;
realpath: string;
}
export interface ServerAPI { export interface ServerAPI {
routerHook: RouterHook;
toaster: Toaster;
openFilePicker(startPath: string, includeFiles?: boolean, regex?: RegExp): Promise<FilePickerRes>
callPluginMethod<TArgs = {}, TRes = {}>(methodName: string, args: TArgs): Promise<ServerResponse<TRes>>; callPluginMethod<TArgs = {}, TRes = {}>(methodName: string, args: TArgs): Promise<ServerResponse<TRes>>;
callServerMethod<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>>; fetchNoCors<TRes = {}>(url: RequestInfo, request?: RequestInit): Promise<ServerResponse<TRes>>;
executeInTab(tab: string, runAsync: boolean, code: string): Promise<unknown>; executeInTab(tab: string, runAsync: boolean, code: string): Promise<unknown>;
injectCssIntoTab<TRes = string>(tab: string, style: string): Promise<ServerResponse<TRes>>;
removeCssFromTab(tab: string, cssId: string): Promise<unknown>; removeCssFromTab(tab: string, cssId: string): Promise<unknown>;
} }

View File

@@ -1,87 +0,0 @@
import * as React from "react";
// this shouldn't need to be redeclared but it does for some reason
declare global {
interface Window {
SP_REACT: typeof React;
}
}
export function fakeRenderComponent(fun: Function): any {
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: 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(hooks);
Object.assign(hooks, oldHooks);
return res;
}
export function beforePatch(obj: any, name: string, fnc: Function): void {
const orig = obj[name];
obj[name] = function (...args: any[]) {
fnc.call(this, args);
return orig.call(this, ...args);
}
Object.assign(obj[name], orig);
obj[name].toString = () => orig.toString();
obj[name].__deckyOrig = orig;
}
export function afterPatch(obj: any, name: string, fnc: Function): void {
const orig = obj[name];
obj[name] = function (...args: any[]) {
let ret = orig.call(this, ...args);
ret = fnc.call(this, args, ret);
return ret;
}
Object.assign(obj[name], orig);
obj[name].toString = () => orig.toString();
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]
}

10
src/utils/index.ts Normal file
View File

@@ -0,0 +1,10 @@
export * from "./patcher";
export * from "./react";
export function joinClassNames(...classes: string[]): string {
return classes.join(" ");
}
export function sleep(ms: number) {
return new Promise(res => setTimeout(res, ms));
}

112
src/utils/patcher.ts Normal file
View File

@@ -0,0 +1,112 @@
// TODO: implement storing patches as an option so we can offer unpatchAll selectively
// Return this in a replacePatch to call the original method (can still modify args).
export let callOriginal = Symbol("DECKY_CALL_ORIGINAL");
export interface PatchOptions {
singleShot?: boolean
}
type GenericPatchHandler = (args: any[], ret?: any) => any;
export interface Patch {
original: Function;
property: string;
object: any;
patchedFunction: any;
hasUnpatched: boolean;
handler: GenericPatchHandler;
unpatch: () => void
};
// let patches = new Set<Patch>();
export function beforePatch(object: any, property: string, handler: (args: any[]) => any, options: PatchOptions = {}): Patch {
const orig = object[property];
object[property] = function (...args: any[]) {
handler.call(this, args);
const ret = patch.original.call(this, ...args);
if (options.singleShot) {
patch.unpatch();
}
return ret;
}
const patch = processPatch(object, property, handler, object[property], orig);
return patch;
}
export function afterPatch(object: any, property: string, handler: (args: any[], ret: any) => any, options: PatchOptions = {}): Patch {
const orig = object[property];
object[property] = function (...args: any[]) {
let ret = patch.original.call(this, ...args);
ret = handler.call(this, args, ret);
if (options.singleShot) {
patch.unpatch();
}
return ret;
}
const patch = processPatch(object, property, handler, object[property], orig);
return patch;
}
export function replacePatch(object: any, property: string, handler: (args: any[]) => any, options: PatchOptions = {}): Patch {
const orig = object[property];
object[property] = function (...args: any[]) {
const ret = handler.call(this, args);
if (ret == callOriginal) return patch.original.call(this, ...args);
if (options.singleShot) {
patch.unpatch();
}
return ret;
};
const patch = processPatch(object, property, handler, object[property], orig);
return patch;
}
function processPatch(object: any, property: any, handler: GenericPatchHandler, patchedFunction: any, original: any): Patch {
// Assign all props of original function to new one
Object.assign(object[property], original);
// Allow toString webpack filters to continue to work
object[property].toString = () => original.toString();
// HACK: for compatibility, remove when all plugins are using new patcher
Object.defineProperty(object[property], "__deckyOrig", {
get: () => patch.original,
set: (val: any) => patch.original = val
})
// Build a Patch object of this patch
const patch: Patch = {
object,
property,
handler,
patchedFunction,
original,
hasUnpatched: false,
unpatch: () => unpatch(patch)
};
object[property].__deckyPatch = patch;
return patch;
}
function unpatch(patch: Patch): void {
const { object, property, handler, patchedFunction, original } = patch;
if (patch.hasUnpatched) throw new Error("Function is already unpatched.")
let realProp = property;
let realObject = object;
console.debug("[Patcher] unpatching", {realObject, realProp, object, property, handler, patchedFunction, original, isEqual: realObject[realProp] === patchedFunction})
// If another patch has been applied to this function after this one, move down until we find the correct patch
while (realObject[realProp] && realObject[realProp] !== patchedFunction) {
realObject = realObject[realProp].__deckyPatch;
realProp = "original";
console.debug("[Patcher] moved to next", {realObject, realProp, object, property, handler, patchedFunction, original, isEqual: realObject[realProp] === patchedFunction})
}
realObject[realProp] = realObject[realProp].__deckyPatch.original
patch.hasUnpatched = true;
console.debug("[Patcher] unpatched", {realObject, realProp, object, property, handler, patchedFunction, original, isEqual: realObject[realProp] === patchedFunction})
}

86
src/utils/react.ts Normal file
View File

@@ -0,0 +1,86 @@
import * as React from "react";
// this shouldn't need to be redeclared but it does for some reason
declare global {
interface Window {
SP_REACT: typeof React;
}
}
export function fakeRenderComponent(fun: Function): any {
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: 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(hooks);
Object.assign(hooks, oldHooks);
return res;
}
export function wrapReactType(node: any, prop: any = 'type') {
return node[prop] = {...node[prop]};
}
export function wrapReactClass(node: any, prop: any = 'type') {
const cls = node[prop];
const wrappedCls = class extends cls {};
return node[prop] = wrappedCls;
}
export function getReactInstance(o: HTMLElement | Element | Node) {
return o[Object.keys(o).find(k => k.startsWith('__reactInternalInstance')) as string]
}
// 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' ]
});

View File

@@ -1,22 +1,42 @@
declare global { declare global {
interface Window { interface Window {
webpackJsonp: any; webpackJsonp: any;
webpackChunksteamui: any;
} }
} }
// TODO // TODO
type Module = any; export type Module = any;
type FilterFn = (module: any) => boolean; type FilterFn = (module: any) => boolean;
type FindFn = (module: any) => any; type FindFn = (module: any) => any;
const wpRequire = window.webpackJsonp.push([ export let webpackCache: any = {};
[], let hasWebpack5 = false;
{ get_require: (mod: any, _exports: any, wpRequire: any) => (mod.exports = wpRequire) },
[['get_require']],
]);
export const allModules: Module[] = Object.keys(wpRequire.c) if (window.webpackJsonp && !window.webpackJsonp.deckyShimmed) {
.map((x) => wpRequire.c[x].exports) // 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); .filter((x) => x);
export const findModule = (filter: FilterFn) => { export const findModule = (filter: FilterFn) => {
@@ -59,23 +79,17 @@ export const CommonUIModule = allModules.find((m: Module) => {
}); });
export const IconsModule = findModule((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) { for (let prop in m) {
if (m[prop]?.toString && /Spinner\)}\),.\.createElement\(\"path\",{d:\"M18 /.test(m[prop].toString())) return true; if (m[prop]?.toString && /Spinner\)}\),.\.createElement\(\"path\",{d:\"M18 /.test(m[prop].toString())) return true;
} }
return false; 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) => { export const ReactRouter = allModules.find((m: Module) => {
if (typeof m !== "object") return undefined; if (typeof m !== 'object') return undefined;
for (let prop in m) { for (let prop in m) {
if (m[prop]?.computeRootMatch) return true if (m[prop]?.computeRootMatch) return true;
} }
return false; return false;
}) });