Compare commits
391
Commits
379a957a40
...
v4.11.223
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7f5dd660c7 | ||
|
|
7c33ae587d | ||
|
|
2444654a58 | ||
|
|
e021368628 | ||
|
|
238b969d38 | ||
|
|
5026f0efc2 | ||
|
|
1cbf407f9e | ||
|
|
ec4976293f | ||
|
|
16f4127ed3 | ||
|
|
ce4d13740c | ||
|
|
95ef4261ed | ||
|
|
9143ef18e1 | ||
|
|
60b3706b22 | ||
|
|
8d2de8ee44 | ||
|
|
ae77701424 | ||
|
|
3546e166b0 | ||
|
|
42be279a31 | ||
|
|
f8b4f8cd5a | ||
|
|
f01be83a71 | ||
|
|
86dc5ec9e3 | ||
|
|
06be5c9aaf | ||
|
|
1fc1e5e830 | ||
|
|
609a822777 | ||
|
|
d017cf1959 | ||
|
|
cfc7e5fca3 | ||
|
|
979f7a6ddb | ||
|
|
d402f4dcfd | ||
|
|
b477977a7b | ||
|
|
96f011defc | ||
|
|
1b414d23de | ||
|
|
527cc8fdf4 | ||
|
|
85766610d9 | ||
|
|
cf9899391c | ||
|
|
e7e2a43037 | ||
|
|
4dc6c8c427 | ||
|
|
121244e97b | ||
|
|
54c4cf4386 | ||
|
|
9cc406b770 | ||
|
|
9595b9922d | ||
|
|
33af5c9abf | ||
|
|
999d5da26c | ||
|
|
0ed6df6e97 | ||
|
|
b78e8187ca | ||
|
|
0bbca0d94d | ||
|
|
8afd17e176 | ||
|
|
7adc4cdec0 | ||
|
|
dd2916c30e | ||
|
|
4c6b71fc3b | ||
|
|
5970c5fb7a | ||
|
|
84296e7f87 | ||
|
|
da763937de | ||
|
|
4bbffdb840 | ||
|
|
230171e16c | ||
|
|
e23c40585f | ||
|
|
b2f6c732e4 | ||
|
|
a2b0a3f930 | ||
|
|
adf6329149 | ||
|
|
3382db4603 | ||
|
|
bbaf526e5f | ||
|
|
667aed487a | ||
|
|
0cbee9a436 | ||
|
|
ba6832371a | ||
|
|
402eb29f06 | ||
|
|
64863057be | ||
|
|
6966e44830 | ||
|
|
78850488c7 | ||
|
|
480771b4ab | ||
|
|
d6d6b99e38 | ||
|
|
abbd1c953b | ||
|
|
72b749e933 | ||
|
|
a2a2fe39e0 | ||
|
|
cb4b447de7 | ||
|
|
c01aba04f8 | ||
|
|
284c88b775 | ||
|
|
12532f7d8b | ||
|
|
eaa90d83df | ||
|
|
5b3b71c278 | ||
|
|
f403515f29 | ||
|
|
4f02e12231 | ||
|
|
09813a4dc0 | ||
|
|
532455309c | ||
|
|
615356ca1f | ||
|
|
cee7bb5a20 | ||
|
|
4efc74eea3 | ||
|
|
f444e7e8a7 | ||
|
|
6488d31e77 | ||
|
|
f69c481a35 | ||
|
|
9458ede739 | ||
|
|
5832e3e2ec | ||
|
|
9bbe8d6814 | ||
|
|
d4ccf479a9 | ||
|
|
cee44b3dbd | ||
|
|
805c32cf75 | ||
|
|
4c1c76096b | ||
|
|
15a2b4add2 | ||
|
|
427e148a15 | ||
|
|
440f0d7ae4 | ||
|
|
9bc270ad49 | ||
|
|
1cbd0c59bb | ||
|
|
e67e15ad37 | ||
|
|
e8745d4fb9 | ||
|
|
a48a96fb84 | ||
|
|
5f78ef721f | ||
|
|
fc9679b4de | ||
|
|
e5a6a16463 | ||
|
|
7821c23878 | ||
|
|
cb4445f812 | ||
|
|
cc45650d8c | ||
|
|
af674be546 | ||
|
|
63ce548072 | ||
|
|
863352fc7c | ||
|
|
ec23124722 | ||
|
|
afc4ba1087 | ||
|
|
f022155aa1 | ||
|
|
f4ec39f229 | ||
|
|
848283da42 | ||
|
|
2cd9409e3d | ||
|
|
b85774e911 | ||
|
|
73d31a2cb4 | ||
|
|
f9bc1c7c2f | ||
|
|
85995d0744 | ||
|
|
9d7ae1d63b | ||
|
|
ce7b2104ad | ||
|
|
60d65a29ff | ||
|
|
ce29b24c28 | ||
|
|
608cbaf682 | ||
|
|
8ca7be8b42 | ||
|
|
3c55fe65a3 | ||
|
|
f99b3c85d4 | ||
|
|
fc4f087c68 | ||
|
|
6d347a6f6b | ||
|
|
316a5514e6 | ||
|
|
8392e3f7f5 | ||
|
|
61b3cbc6d8 | ||
|
|
9befaa14a5 | ||
|
|
ea45c4551b | ||
|
|
146927fc10 | ||
|
|
8edbc1b19a | ||
|
|
9700c645a3 | ||
|
|
2828ae425c | ||
|
|
5e06256973 | ||
|
|
28c7dedf65 | ||
|
|
ca10121796 | ||
|
|
1ad1fc7b70 | ||
|
|
f16b84a9f1 | ||
|
|
e917193b0d | ||
|
|
fc5d498673 | ||
|
|
c01bd9a43e | ||
|
|
3f4b1b3fc4 | ||
|
|
24b59a454a | ||
|
|
fac9a49d56 | ||
|
|
83993efc83 | ||
|
|
44a9230df3 | ||
|
|
658ff1215c | ||
|
|
829e9b06cb | ||
|
|
e64279db74 | ||
|
|
85d95faf11 | ||
|
|
61de658029 | ||
|
|
c8b57ba217 | ||
|
|
8d8809d0c7 | ||
|
|
55a0f4f566 | ||
|
|
f488f32d88 | ||
|
|
9154929de9 | ||
|
|
c2cc0d5ed5 | ||
|
|
aa38348fdd | ||
|
|
02ab544a37 | ||
|
|
3707a6d38a | ||
|
|
fe1f4abf2d | ||
|
|
147389724e | ||
|
|
d4d4c73c2b | ||
|
|
73fbc1c77a | ||
|
|
3dc732521f | ||
|
|
b76aa3fe4a | ||
|
|
c0d1e87b8d | ||
|
|
04d4026e78 | ||
|
|
cfbc59d6a9 | ||
|
|
dfe42fa942 | ||
|
|
6a8397425e | ||
|
|
641ec26142 | ||
|
|
1eaf246806 | ||
|
|
0e97e4d3b6 | ||
|
|
1636a8d0c6 | ||
|
|
ac236750aa | ||
|
|
7e747e6c36 | ||
|
|
1b2cae5b12 | ||
|
|
76921c4e79 | ||
|
|
688efff7c9 | ||
|
|
9bc377b62a | ||
|
|
836ccce7a3 | ||
|
|
34c8e6e38c | ||
|
|
e69bda3aa6 | ||
|
|
5d55e5d826 | ||
|
|
b5902b9fc3 | ||
|
|
f60cf0bd3c | ||
|
|
83dec0ef54 | ||
|
|
40a76f02cd | ||
|
|
3def3cc456 | ||
|
|
30bd67d43a | ||
|
|
ffeccee680 | ||
|
|
facbeee024 | ||
|
|
09102c7903 | ||
|
|
fa33ec7ac8 | ||
|
|
c44f5cf14a | ||
|
|
27793d7c4f | ||
|
|
32b2902ef7 | ||
|
|
5cdb318854 | ||
|
|
a28f05bb88 | ||
|
|
cecfe73b2e | ||
|
|
b458c7918c | ||
|
|
d8660f4822 | ||
|
|
dad83773a6 | ||
|
|
d2d35de46b | ||
|
|
c752ec0b38 | ||
|
|
28752eb56e | ||
|
|
4f243a0fcf | ||
|
|
9bce616f26 | ||
|
|
f16ab73c9a | ||
|
|
c29a15e073 | ||
|
|
f5fe61e3eb | ||
|
|
a1a752b0fb | ||
|
|
7769250875 | ||
|
|
b3af9f3185 | ||
|
|
7906326790 | ||
|
|
3b4babb9d7 | ||
|
|
4b284ec747 | ||
|
|
e1b4cfb9c8 | ||
|
|
c0266903ec | ||
|
|
81964d6f14 | ||
|
|
47e025cf55 | ||
|
|
b400070ad0 | ||
|
|
529694ce66 | ||
|
|
791c3ab4df | ||
|
|
de8d9db795 | ||
|
|
ffaf9ff66a | ||
|
|
f0891ba4cc | ||
|
|
627b117119 | ||
|
|
b6c6659a5a | ||
|
|
d7a73afebc | ||
|
|
e469d51ba4 | ||
|
|
6ba03277e5 | ||
|
|
fdb2dca794 | ||
|
|
8797bb5a22 | ||
|
|
4d154fd4f3 | ||
|
|
42e8fb71ef | ||
|
|
ff2c284984 | ||
|
|
75be84e472 | ||
|
|
a3c91b306a | ||
|
|
20edc293bb | ||
|
|
6803eac8fb | ||
|
|
fa5592f1e4 | ||
|
|
78601be6f4 | ||
|
|
c940bdc78c | ||
|
|
9471fe2f5d | ||
|
|
57f7fe7086 | ||
|
|
a2364f2622 | ||
|
|
df2220581d | ||
|
|
198eb0fe04 | ||
|
|
fff114abef | ||
|
|
7013f1c22d | ||
|
|
1dbc7d6cc4 | ||
|
|
f93f109d4a | ||
|
|
f707aa98f5 | ||
|
|
8a0be09d5d | ||
|
|
a1b86f00ba | ||
|
|
c9f569a2b2 | ||
|
|
7a736b3adf | ||
|
|
b6ecd16148 | ||
|
|
30d6b8dc74 | ||
|
|
b6bcd8d05b | ||
|
|
0b5fe5f04c | ||
|
|
c629c07bf9 | ||
|
|
fcd7d3e7ea | ||
|
|
db994a5d43 | ||
|
|
fea9ebd501 | ||
|
|
9238d80adb | ||
|
|
a28d3c26b5 | ||
|
|
161030927f | ||
|
|
c431c1d547 | ||
|
|
739c863601 | ||
|
|
5b6c213101 | ||
|
|
5acf981bd4 | ||
|
|
14b27717a6 | ||
|
|
bd3e1d5b9c | ||
|
|
a668544c6e | ||
|
|
dd8f4eb47d | ||
|
|
54cb11e55b | ||
|
|
dec48f6c1d | ||
|
|
8f776f4f7c | ||
|
|
c6aff43467 | ||
|
|
9f95ef1ecd | ||
|
|
aafda0d437 | ||
|
|
f97a8d4929 | ||
|
|
a8c742376f | ||
|
|
938ab53d4b | ||
|
|
62352412d3 | ||
|
|
fd33b3f6b7 | ||
|
|
3c0b4cf108 | ||
|
|
4eb48726ae | ||
|
|
ba17993001 | ||
|
|
cf39f0acd9 | ||
|
|
bce2cbec94 | ||
|
|
f401b5ea3d | ||
|
|
4a5e3a1691 | ||
|
|
dc50f74971 | ||
|
|
a198eb6896 | ||
|
|
dc9b12dd26 | ||
|
|
6ea0e7a4fd | ||
|
|
51b13e0fcd | ||
|
|
1d7a48c57e | ||
|
|
0e34ca2063 | ||
|
|
6248d5843a | ||
|
|
5af79606c2 | ||
|
|
3cc31d8e05 | ||
|
|
0f7dd5f55c | ||
|
|
de4f6ebbc9 | ||
|
|
fd25143489 | ||
|
|
5265674a58 | ||
|
|
39376e0003 | ||
|
|
cf1f7fcec8 | ||
|
|
153e55705a | ||
|
|
77cdd66027 | ||
|
|
80580391cb | ||
|
|
6f0988f873 | ||
|
|
99358803d2 | ||
|
|
6a347d977f | ||
|
|
c03a4d3f41 | ||
|
|
50818f1d76 | ||
|
|
0f8c9b83f4 | ||
|
|
76cae46005 | ||
|
|
ca22449d54 | ||
|
|
dda1041268 | ||
|
|
b4f8f13213 | ||
|
|
9ad9971a03 | ||
|
|
c38dc7bbf6 | ||
|
|
aaed71e37b | ||
|
|
ed85051480 | ||
|
|
d0524c2bc7 | ||
|
|
8a0f8f5422 | ||
|
|
8a95d9e67d | ||
|
|
b8a126fd69 | ||
|
|
6b18e5c8ee | ||
|
|
27c2ce021d | ||
|
|
de6620245c | ||
|
|
21e895efff | ||
|
|
e9487c3043 | ||
|
|
686749ac55 | ||
|
|
dd790d3336 | ||
|
|
c8ceeccc8c | ||
|
|
a592766e0a | ||
|
|
7acf8ea877 | ||
|
|
2a87133d14 | ||
|
|
c960bc5410 | ||
|
|
fde412fafa | ||
|
|
476d0c71fc | ||
|
|
df6fa0fa42 | ||
|
|
246521b7b3 | ||
|
|
8ccc3ecb78 | ||
|
|
19ce4b43ca | ||
|
|
8ea4c58a5b | ||
|
|
465fa6b57b | ||
|
|
12f0d7f8d3 | ||
|
|
f11078bb5c | ||
|
|
4e6835c741 | ||
|
|
4584367041 | ||
|
|
bf71bd9726 | ||
|
|
8cfc96688e | ||
|
|
eedd040203 | ||
|
|
8396834b08 | ||
|
|
cb136002b9 | ||
|
|
9a6dc126db | ||
|
|
c9352327eb | ||
|
|
9985b0931c | ||
|
|
5faf0056d7 | ||
|
|
cf6bedf58a | ||
|
|
03ecdbb54f | ||
|
|
1222651d17 | ||
|
|
1f34f726bf | ||
|
|
5b1bd1cffa | ||
|
|
050352fd2b | ||
|
|
422b680b18 | ||
|
|
6510522b6b | ||
|
|
48a189ed6a | ||
|
|
a72758d9ef | ||
|
|
7ee178f6e9 | ||
|
|
50885a9da4 | ||
|
|
5d39692e41 | ||
|
|
de87a55582 | ||
|
|
a3c2510830 | ||
|
|
6b9a57e243 | ||
|
|
4fa0ce0d4a | ||
|
|
e90b8d43cb |
+460
-234
@@ -8,28 +8,68 @@ on:
|
||||
tags:
|
||||
- 'v*'
|
||||
|
||||
# Large AppImage/exe uploads time out on Gitea's actions artifact pipeline.
|
||||
# Build jobs publish assets straight to Gitea/GitHub releases via the REST API.
|
||||
|
||||
# actions/cache works on the self-hosted runner (pizzabox): act_runner runs its own
|
||||
# cache server, so its port must be reachable from the job container. Fixed ports
|
||||
# (34085 docker runner, 34086 host runner) plus a ufw rule for the docker range.
|
||||
# Saves are confirmed working, so runs after the first should hit.
|
||||
|
||||
jobs:
|
||||
increment-version:
|
||||
prepare:
|
||||
runs-on: ubuntu-latest
|
||||
if: github.ref == 'refs/heads/main' && !contains(github.event.head_commit.message, '[skip ci]')
|
||||
outputs:
|
||||
version: ${{ steps.bump.outputs.VERSION }}
|
||||
should_build: ${{ steps.bump.outputs.SHOULD_BUILD }}
|
||||
|
||||
version: ${{ steps.finalize.outputs.VERSION }}
|
||||
tag: ${{ steps.finalize.outputs.TAG_NAME }}
|
||||
commit_sha: ${{ steps.finalize.outputs.COMMIT_SHA }}
|
||||
should_build: ${{ steps.decide.outputs.SHOULD_BUILD }}
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
|
||||
- name: Decide version behavior
|
||||
id: decide
|
||||
run: |
|
||||
CURRENT=$(grep -Po '"version":\s*"\K[^"]+' package.json | head -1)
|
||||
COMMIT_MSG="${{ github.event.head_commit.message || '' }}"
|
||||
|
||||
SHOULD_BUMP=false
|
||||
SHOULD_BUILD=true
|
||||
|
||||
if [ "${{ github.ref }}" = "refs/heads/main" ] && ! echo "$COMMIT_MSG" | grep -qi '\[skip ci\]'; then
|
||||
SHOULD_BUMP=true
|
||||
fi
|
||||
|
||||
if echo "$COMMIT_MSG" | grep -qi '\[skip ci\]'; then
|
||||
SHOULD_BUILD=false
|
||||
fi
|
||||
|
||||
# [skip build] runs the checks workflow but skips the Electron build.
|
||||
if echo "$COMMIT_MSG" | grep -qi '\[skip build\]'; then
|
||||
SHOULD_BUILD=false
|
||||
fi
|
||||
|
||||
echo "CURRENT_VERSION=$CURRENT" >> $GITHUB_OUTPUT
|
||||
echo "SHOULD_BUMP=$SHOULD_BUMP" >> $GITHUB_OUTPUT
|
||||
echo "SHOULD_BUILD=$SHOULD_BUILD" >> $GITHUB_OUTPUT
|
||||
|
||||
echo "Current version: $CURRENT"
|
||||
echo "Should bump: $SHOULD_BUMP"
|
||||
echo "Should build: $SHOULD_BUILD"
|
||||
|
||||
- name: Bump patch version
|
||||
id: bump
|
||||
if: steps.decide.outputs.SHOULD_BUILD == 'true' && steps.decide.outputs.SHOULD_BUMP == 'true'
|
||||
run: |
|
||||
# Get current version from package.json
|
||||
CURRENT=$(grep -Po '"version":\s*"\K[^"]+' package.json | head -1)
|
||||
echo "Current version: $CURRENT"
|
||||
|
||||
|
||||
# Split and increment patch
|
||||
MAJOR=$(echo $CURRENT | cut -d. -f1)
|
||||
MINOR=$(echo $CURRENT | cut -d. -f2)
|
||||
@@ -37,291 +77,477 @@ jobs:
|
||||
NEW_PATCH=$((PATCH + 1))
|
||||
NEW_VERSION="${MAJOR}.${MINOR}.${NEW_PATCH}"
|
||||
echo "New version: $NEW_VERSION"
|
||||
|
||||
|
||||
# Update package.json
|
||||
sed -i "s/\"version\": \"${CURRENT}\"/\"version\": \"${NEW_VERSION}\"/" package.json
|
||||
|
||||
|
||||
# Verify the change
|
||||
grep '"version"' package.json | head -1
|
||||
|
||||
|
||||
echo "VERSION=$NEW_VERSION" >> $GITHUB_OUTPUT
|
||||
echo "SHOULD_BUILD=true" >> $GITHUB_OUTPUT
|
||||
|
||||
|
||||
- name: Commit and push version bump
|
||||
if: steps.decide.outputs.SHOULD_BUILD == 'true' && steps.decide.outputs.SHOULD_BUMP == 'true'
|
||||
run: |
|
||||
git config user.name "GitHub Actions"
|
||||
git config user.email "actions@github.com"
|
||||
git add package.json
|
||||
git commit -m "chore: bump version to ${{ steps.bump.outputs.VERSION }} [skip ci]"
|
||||
git push
|
||||
for attempt in 1 2 3; do
|
||||
git fetch origin main
|
||||
git rebase origin/main || {
|
||||
git rebase --abort || true
|
||||
echo "Failed to rebase version bump onto latest main"
|
||||
exit 1
|
||||
}
|
||||
|
||||
if git push origin HEAD:main; then
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "Push rejected on attempt ${attempt}, retrying against latest main"
|
||||
done
|
||||
|
||||
echo "Failed to push version bump after 3 attempts"
|
||||
exit 1
|
||||
|
||||
- name: Resolve version and commit
|
||||
id: finalize
|
||||
if: steps.decide.outputs.SHOULD_BUILD == 'true'
|
||||
run: |
|
||||
if [ -n "${{ steps.bump.outputs.VERSION }}" ]; then
|
||||
VERSION="${{ steps.bump.outputs.VERSION }}"
|
||||
else
|
||||
VERSION=$(grep -Po '"version":\s*"\K[^"]+' package.json | head -1)
|
||||
fi
|
||||
echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
|
||||
echo "TAG_NAME=v$VERSION" >> $GITHUB_OUTPUT
|
||||
echo "COMMIT_SHA=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
|
||||
echo "Version: $VERSION"
|
||||
|
||||
- name: Create and push tag
|
||||
if: steps.decide.outputs.SHOULD_BUILD == 'true'
|
||||
run: |
|
||||
TAG_NAME="${{ steps.finalize.outputs.TAG_NAME }}"
|
||||
if git rev-parse "$TAG_NAME" >/dev/null 2>&1; then
|
||||
echo "Tag $TAG_NAME already exists"
|
||||
else
|
||||
git config user.name "GitHub Actions"
|
||||
git config user.email "actions@github.com"
|
||||
git tag -a "$TAG_NAME" -m "Release $TAG_NAME"
|
||||
git push origin "$TAG_NAME"
|
||||
fi
|
||||
|
||||
- name: Ensure Gitea release
|
||||
if: steps.decide.outputs.SHOULD_BUILD == 'true'
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
VERSION="${{ steps.finalize.outputs.VERSION }}"
|
||||
TAG_NAME="${{ steps.finalize.outputs.TAG_NAME }}"
|
||||
API_BASE="${{ github.server_url }}/api/v1"
|
||||
REPO="${{ github.repository }}"
|
||||
|
||||
RELEASE_ID=$(curl -fsS -H "Authorization: token ${GITEA_TOKEN}" \
|
||||
"${API_BASE}/repos/${REPO}/releases/tags/${TAG_NAME}" | jq -r '.id // empty' || true)
|
||||
|
||||
if [ -z "$RELEASE_ID" ]; then
|
||||
echo "Creating Gitea release ${TAG_NAME}..."
|
||||
RELEASE_ID=$(curl -fsS -X POST \
|
||||
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "{\"tag_name\": \"${TAG_NAME}\", \"name\": \"Release ${TAG_NAME}\", \"body\": \"Release ${VERSION}\", \"draft\": false, \"prerelease\": false}" \
|
||||
"${API_BASE}/repos/${REPO}/releases" | jq -r '.id')
|
||||
fi
|
||||
|
||||
echo "Gitea release id: ${RELEASE_ID}"
|
||||
|
||||
- name: Ensure GitHub release
|
||||
if: steps.decide.outputs.SHOULD_BUILD == 'true'
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GHTOKEN }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
VERSION="${{ steps.finalize.outputs.VERSION }}"
|
||||
TAG_NAME="${{ steps.finalize.outputs.TAG_NAME }}"
|
||||
GITHUB_REPO="Paarrot/Paarrot-Desktop"
|
||||
|
||||
RELEASE_ID=$(curl -fsS -H "Authorization: token ${GH_TOKEN}" \
|
||||
"https://api.github.com/repos/${GITHUB_REPO}/releases/tags/${TAG_NAME}" | jq -r '.id // empty' || true)
|
||||
|
||||
if [ -z "$RELEASE_ID" ]; then
|
||||
echo "Creating GitHub release ${TAG_NAME}..."
|
||||
RELEASE_ID=$(curl -fsS -X POST \
|
||||
-H "Authorization: token ${GH_TOKEN}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "{\"tag_name\": \"${TAG_NAME}\", \"name\": \"Release ${TAG_NAME}\", \"body\": \"Release ${VERSION}\", \"draft\": false, \"prerelease\": false}" \
|
||||
"https://api.github.com/repos/${GITHUB_REPO}/releases" | jq -r '.id')
|
||||
fi
|
||||
|
||||
echo "GitHub release id: ${RELEASE_ID}"
|
||||
|
||||
build-windows:
|
||||
runs-on: windows
|
||||
needs: increment-version
|
||||
if: always() && (needs.increment-version.outputs.should_build == 'true' || needs.increment-version.result == 'skipped')
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
needs: prepare
|
||||
if: always() && needs.prepare.result == 'success' && needs.prepare.outputs.should_build == 'true'
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: false
|
||||
ref: ${{ github.ref_name }}
|
||||
|
||||
fetch-depth: 1
|
||||
ref: ${{ needs.prepare.outputs.commit_sha }}
|
||||
|
||||
- name: Checkout submodules manually
|
||||
shell: powershell
|
||||
run: |
|
||||
git submodule update --init --recursive
|
||||
|
||||
- name: Pull latest (after version bump)
|
||||
if: github.ref == 'refs/heads/main'
|
||||
shell: powershell
|
||||
run: git pull origin main
|
||||
|
||||
set -euo pipefail
|
||||
# Use the same host/scheme the runner already used for origin (not public HTTPS).
|
||||
ORIGIN_URL=$(git remote get-url origin)
|
||||
ORIGIN_URL=${ORIGIN_URL%/}
|
||||
ORIGIN_URL=${ORIGIN_URL%.git}
|
||||
BASE_URL=${ORIGIN_URL%/*}
|
||||
CINNY_URL="${BASE_URL}/cinny.git"
|
||||
echo "Rewriting submodule URL to ${CINNY_URL}"
|
||||
git config submodule.cinny.url "${CINNY_URL}"
|
||||
git submodule sync --recursive
|
||||
|
||||
if git submodule update --init --recursive; then
|
||||
echo "Submodules checked out at pinned commits."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "Pinned submodule commit is unavailable on remote. Falling back to remote submodule HEAD."
|
||||
git submodule deinit -f --all || true
|
||||
rm -rf cinny .git/modules/cinny
|
||||
git config submodule.cinny.url "${CINNY_URL}"
|
||||
git submodule sync --recursive
|
||||
git submodule update --init --recursive --remote
|
||||
|
||||
echo "Resolved submodule commit:"
|
||||
git -C cinny rev-parse HEAD
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '20'
|
||||
|
||||
node-version: '22'
|
||||
cache: 'npm'
|
||||
cache-dependency-path: |
|
||||
package-lock.json
|
||||
cinny/package-lock.json
|
||||
|
||||
- name: Cache Electron downloads
|
||||
uses: actions/cache@v4
|
||||
continue-on-error: true
|
||||
with:
|
||||
path: |
|
||||
~/.cache/electron
|
||||
~/.cache/electron-builder
|
||||
key: electron-${{ hashFiles('package-lock.json') }}
|
||||
restore-keys: electron-
|
||||
|
||||
- name: Install Wine (NSIS cross-build)
|
||||
run: |
|
||||
set -euo pipefail
|
||||
# wine + wine32 + wine64 are prebaked in the runner image used on pizzabox,
|
||||
# so this is normally a no-op. Fallback below covers runners without it.
|
||||
# (act_runner takes the image from the label stored in Gitea, so the baked
|
||||
# image is tagged as gitea/runner-images:ubuntu-latest on that host.)
|
||||
# force_pull must stay false on that runner, otherwise the shadowed tag is
|
||||
# replaced by the upstream image and this step installs wine again.
|
||||
# NSIS's makensis.exe is 32-bit, so wine32 is required; the wine64 package
|
||||
# alone ships only /usr/lib/wine/wine64 (no `wine` on PATH).
|
||||
if command -v wine >/dev/null 2>&1; then
|
||||
echo "wine already present: $(wine --version)"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
sudo dpkg --add-architecture i386
|
||||
sudo apt-get update
|
||||
sudo DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends wine wine32 wine64
|
||||
|
||||
if ! command -v wine >/dev/null 2>&1; then
|
||||
WINE64_BIN=$(command -v wine64 || echo /usr/lib/wine/wine64)
|
||||
echo "No wine binary; linking wine64 -> /usr/local/bin/wine (${WINE64_BIN})"
|
||||
sudo ln -sf "${WINE64_BIN}" /usr/local/bin/wine
|
||||
fi
|
||||
|
||||
command -v wine
|
||||
wine --version
|
||||
|
||||
- name: Install dependencies (root)
|
||||
run: npm install --prefer-offline
|
||||
|
||||
run: npm ci --prefer-offline
|
||||
|
||||
- name: Install dependencies (cinny)
|
||||
working-directory: ./cinny
|
||||
run: npm install --prefer-offline
|
||||
|
||||
- name: Clean previous builds
|
||||
shell: powershell
|
||||
run: |
|
||||
if (Test-Path cinny/dist) { Remove-Item -Recurse -Force cinny/dist }
|
||||
if (Test-Path dist-electron) { Remove-Item -Recurse -Force dist-electron }
|
||||
|
||||
run: npm ci --prefer-offline
|
||||
|
||||
- name: Build Electron app
|
||||
run: npm run build:win
|
||||
run: npm run build:local -- --win
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GHTOKEN }}
|
||||
|
||||
- name: Upload Squirrel Setup (x64)
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: Paarrot-Setup-x64.exe
|
||||
path: dist-electron/squirrel-windows/Paarrot-*-win-x64.exe
|
||||
|
||||
- name: List build output
|
||||
shell: powershell
|
||||
CSC_IDENTITY_AUTO_DISCOVERY: 'false'
|
||||
|
||||
- name: Upload Windows assets to releases
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
GH_TOKEN: ${{ secrets.GHTOKEN }}
|
||||
run: |
|
||||
Get-ChildItem -Path dist-electron -Recurse | Select-Object FullName
|
||||
|
||||
- name: Copy RELEASES file for upload
|
||||
shell: powershell
|
||||
run: |
|
||||
if (Test-Path "dist-electron/squirrel-windows/RELEASES") {
|
||||
Copy-Item "dist-electron/squirrel-windows/RELEASES" -Destination "dist-electron/RELEASES"
|
||||
} else {
|
||||
Write-Error "RELEASES file not found for x64"
|
||||
exit 1
|
||||
set -euo pipefail
|
||||
TAG_NAME="${{ needs.prepare.outputs.tag }}"
|
||||
API_BASE="${{ github.server_url }}/api/v1"
|
||||
REPO="${{ github.repository }}"
|
||||
GITHUB_REPO="Paarrot/Paarrot-Desktop"
|
||||
|
||||
GITEA_RELEASE_ID=$(curl -fsS -H "Authorization: token ${GITEA_TOKEN}" \
|
||||
"${API_BASE}/repos/${REPO}/releases/tags/${TAG_NAME}" | jq -r '.id')
|
||||
GH_RELEASE_ID=$(curl -fsS -H "Authorization: token ${GH_TOKEN}" \
|
||||
"https://api.github.com/repos/${GITHUB_REPO}/releases/tags/${TAG_NAME}" | jq -r '.id')
|
||||
GH_UPLOAD_URL=$(curl -fsS -H "Authorization: token ${GH_TOKEN}" \
|
||||
"https://api.github.com/repos/${GITHUB_REPO}/releases/${GH_RELEASE_ID}" | jq -r '.upload_url' | sed 's/{?name,label}//')
|
||||
|
||||
upload_one() {
|
||||
local FILE="$1"
|
||||
local FILENAME
|
||||
FILENAME=$(basename "$FILE")
|
||||
echo "Uploading ${FILENAME} ($(du -h "$FILE" | cut -f1))..."
|
||||
|
||||
OLD_ID=$(curl -fsS -H "Authorization: token ${GITEA_TOKEN}" \
|
||||
"${API_BASE}/repos/${REPO}/releases/${GITEA_RELEASE_ID}/assets" \
|
||||
| jq -r --arg n "$FILENAME" '.[] | select(.name == $n) | .id' || true)
|
||||
if [ -n "${OLD_ID:-}" ]; then
|
||||
curl -fsS -X DELETE -H "Authorization: token ${GITEA_TOKEN}" \
|
||||
"${API_BASE}/repos/${REPO}/releases/${GITEA_RELEASE_ID}/assets/${OLD_ID}" >/dev/null
|
||||
fi
|
||||
|
||||
curl -fsS --max-time 0 --retry 5 --retry-delay 10 \
|
||||
-X POST \
|
||||
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||
-H "Content-Type: application/octet-stream" \
|
||||
--data-binary @"${FILE}" \
|
||||
"${API_BASE}/repos/${REPO}/releases/${GITEA_RELEASE_ID}/assets?name=${FILENAME}" \
|
||||
>/dev/null
|
||||
echo " Gitea: ok"
|
||||
|
||||
OLD_GH=$(curl -fsS -H "Authorization: token ${GH_TOKEN}" \
|
||||
"https://api.github.com/repos/${GITHUB_REPO}/releases/${GH_RELEASE_ID}/assets" \
|
||||
| jq -r --arg n "$FILENAME" '.[] | select(.name == $n) | .id' || true)
|
||||
if [ -n "${OLD_GH:-}" ]; then
|
||||
curl -fsS -X DELETE -H "Authorization: token ${GH_TOKEN}" \
|
||||
"https://api.github.com/repos/${GITHUB_REPO}/releases/assets/${OLD_GH}" >/dev/null
|
||||
fi
|
||||
|
||||
curl -fsS --max-time 0 --retry 5 --retry-delay 10 \
|
||||
-X POST \
|
||||
-H "Authorization: token ${GH_TOKEN}" \
|
||||
-H "Content-Type: application/octet-stream" \
|
||||
--data-binary @"${FILE}" \
|
||||
"${GH_UPLOAD_URL}?name=${FILENAME}" \
|
||||
>/dev/null
|
||||
echo " GitHub: ok"
|
||||
}
|
||||
|
||||
- name: Upload Squirrel RELEASES
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: RELEASES
|
||||
path: dist-electron/RELEASES
|
||||
|
||||
- name: Upload Squirrel nupkg (x64)
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: Paarrot-x64.nupkg
|
||||
path: dist-electron/squirrel-windows/*.nupkg
|
||||
|
||||
shopt -s nullglob
|
||||
for FILE in dist-electron/Paarrot-*-win-x64.exe dist-electron/latest.yml; do
|
||||
upload_one "$FILE"
|
||||
done
|
||||
|
||||
- name: List build output
|
||||
run: |
|
||||
find dist-electron -type f -printf '%p\n' | sort
|
||||
|
||||
build-linux:
|
||||
runs-on: ubuntu-latest
|
||||
needs: increment-version
|
||||
if: always() && (needs.increment-version.outputs.should_build == 'true' || needs.increment-version.result == 'skipped')
|
||||
|
||||
needs: prepare
|
||||
if: always() && needs.prepare.result == 'success' && needs.prepare.outputs.should_build == 'true'
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: recursive
|
||||
ref: ${{ github.ref_name }}
|
||||
|
||||
- name: Pull latest (after version bump)
|
||||
if: github.ref == 'refs/heads/main'
|
||||
run: git pull origin main
|
||||
|
||||
submodules: false
|
||||
fetch-depth: 1
|
||||
ref: ${{ needs.prepare.outputs.commit_sha }}
|
||||
|
||||
- name: Checkout submodules manually
|
||||
run: |
|
||||
set -euo pipefail
|
||||
# Use the same host/scheme the runner already used for origin (not public HTTPS).
|
||||
ORIGIN_URL=$(git remote get-url origin)
|
||||
ORIGIN_URL=${ORIGIN_URL%/}
|
||||
ORIGIN_URL=${ORIGIN_URL%.git}
|
||||
BASE_URL=${ORIGIN_URL%/*}
|
||||
CINNY_URL="${BASE_URL}/cinny.git"
|
||||
echo "Rewriting submodule URL to ${CINNY_URL}"
|
||||
git config submodule.cinny.url "${CINNY_URL}"
|
||||
git submodule sync --recursive
|
||||
|
||||
if git submodule update --init --recursive; then
|
||||
echo "Submodules checked out at pinned commits."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "Pinned submodule commit is unavailable on remote. Falling back to remote submodule HEAD."
|
||||
git submodule deinit -f --all || true
|
||||
rm -rf cinny .git/modules/cinny
|
||||
git config submodule.cinny.url "${CINNY_URL}"
|
||||
git submodule sync --recursive
|
||||
git submodule update --init --recursive --remote
|
||||
|
||||
echo "Resolved submodule commit:"
|
||||
git -C cinny rev-parse HEAD
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '20'
|
||||
|
||||
node-version: '22'
|
||||
cache: 'npm'
|
||||
cache-dependency-path: |
|
||||
package-lock.json
|
||||
cinny/package-lock.json
|
||||
|
||||
- name: Cache Electron downloads
|
||||
uses: actions/cache@v4
|
||||
continue-on-error: true
|
||||
with:
|
||||
path: |
|
||||
~/.cache/electron
|
||||
~/.cache/electron-builder
|
||||
key: electron-${{ hashFiles('package-lock.json') }}
|
||||
restore-keys: electron-
|
||||
|
||||
- name: Install dependencies (root)
|
||||
run: npm ci --prefer-offline
|
||||
|
||||
|
||||
- name: Install dependencies (cinny)
|
||||
working-directory: ./cinny
|
||||
run: npm ci --prefer-offline
|
||||
|
||||
- name: Clean previous builds
|
||||
run: |
|
||||
rm -rf cinny/dist dist-electron
|
||||
|
||||
|
||||
- name: Build Electron app
|
||||
run: npm run build:linux
|
||||
run: npm run build:local -- --linux
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GHTOKEN }}
|
||||
|
||||
- name: Upload AppImage
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: Paarrot-Linux-x64.AppImage
|
||||
path: dist-electron/Paarrot-*.AppImage
|
||||
|
||||
create-release:
|
||||
- name: Upload Linux assets to releases
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
GH_TOKEN: ${{ secrets.GHTOKEN }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
TAG_NAME="${{ needs.prepare.outputs.tag }}"
|
||||
API_BASE="${{ github.server_url }}/api/v1"
|
||||
REPO="${{ github.repository }}"
|
||||
GITHUB_REPO="Paarrot/Paarrot-Desktop"
|
||||
|
||||
GITEA_RELEASE_ID=$(curl -fsS -H "Authorization: token ${GITEA_TOKEN}" \
|
||||
"${API_BASE}/repos/${REPO}/releases/tags/${TAG_NAME}" | jq -r '.id')
|
||||
GH_RELEASE_ID=$(curl -fsS -H "Authorization: token ${GH_TOKEN}" \
|
||||
"https://api.github.com/repos/${GITHUB_REPO}/releases/tags/${TAG_NAME}" | jq -r '.id')
|
||||
GH_UPLOAD_URL=$(curl -fsS -H "Authorization: token ${GH_TOKEN}" \
|
||||
"https://api.github.com/repos/${GITHUB_REPO}/releases/${GH_RELEASE_ID}" | jq -r '.upload_url' | sed 's/{?name,label}//')
|
||||
|
||||
upload_one() {
|
||||
local FILE="$1"
|
||||
local FILENAME
|
||||
FILENAME=$(basename "$FILE")
|
||||
echo "Uploading ${FILENAME} ($(du -h "$FILE" | cut -f1))..."
|
||||
|
||||
OLD_ID=$(curl -fsS -H "Authorization: token ${GITEA_TOKEN}" \
|
||||
"${API_BASE}/repos/${REPO}/releases/${GITEA_RELEASE_ID}/assets" \
|
||||
| jq -r --arg n "$FILENAME" '.[] | select(.name == $n) | .id' || true)
|
||||
if [ -n "${OLD_ID:-}" ]; then
|
||||
curl -fsS -X DELETE -H "Authorization: token ${GITEA_TOKEN}" \
|
||||
"${API_BASE}/repos/${REPO}/releases/${GITEA_RELEASE_ID}/assets/${OLD_ID}" >/dev/null
|
||||
fi
|
||||
|
||||
curl -fsS --max-time 0 --retry 5 --retry-delay 10 \
|
||||
-X POST \
|
||||
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||
-H "Content-Type: application/octet-stream" \
|
||||
--data-binary @"${FILE}" \
|
||||
"${API_BASE}/repos/${REPO}/releases/${GITEA_RELEASE_ID}/assets?name=${FILENAME}" \
|
||||
>/dev/null
|
||||
echo " Gitea: ok"
|
||||
|
||||
OLD_GH=$(curl -fsS -H "Authorization: token ${GH_TOKEN}" \
|
||||
"https://api.github.com/repos/${GITHUB_REPO}/releases/${GH_RELEASE_ID}/assets" \
|
||||
| jq -r --arg n "$FILENAME" '.[] | select(.name == $n) | .id' || true)
|
||||
if [ -n "${OLD_GH:-}" ]; then
|
||||
curl -fsS -X DELETE -H "Authorization: token ${GH_TOKEN}" \
|
||||
"https://api.github.com/repos/${GITHUB_REPO}/releases/assets/${OLD_GH}" >/dev/null
|
||||
fi
|
||||
|
||||
curl -fsS --max-time 0 --retry 5 --retry-delay 10 \
|
||||
-X POST \
|
||||
-H "Authorization: token ${GH_TOKEN}" \
|
||||
-H "Content-Type: application/octet-stream" \
|
||||
--data-binary @"${FILE}" \
|
||||
"${GH_UPLOAD_URL}?name=${FILENAME}" \
|
||||
>/dev/null
|
||||
echo " GitHub: ok"
|
||||
}
|
||||
|
||||
shopt -s nullglob
|
||||
for FILE in dist-electron/Paarrot-*.AppImage dist-electron/latest-linux.yml; do
|
||||
upload_one "$FILE"
|
||||
done
|
||||
|
||||
finalize-release:
|
||||
runs-on: ubuntu-latest
|
||||
needs: [increment-version, build-windows, build-linux]
|
||||
if: always() && (needs.build-windows.result == 'success' || needs.build-linux.result == 'success')
|
||||
|
||||
needs: [prepare, build-windows, build-linux]
|
||||
if: always() && needs.prepare.result == 'success' && needs.prepare.outputs.should_build == 'true' && (needs.build-windows.result == 'success' || needs.build-linux.result == 'success')
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
ref: ${{ github.ref_name }}
|
||||
|
||||
- name: Pull latest (after version bump)
|
||||
if: github.ref == 'refs/heads/main'
|
||||
run: git pull origin main
|
||||
|
||||
- name: Get version
|
||||
id: version
|
||||
run: |
|
||||
# Use version from increment-version job if available, otherwise read from file
|
||||
if [ -n "${{ needs.increment-version.outputs.version }}" ]; then
|
||||
VERSION="${{ needs.increment-version.outputs.version }}"
|
||||
else
|
||||
VERSION=$(grep -Po '"version":\s*"\K[^"]+' package.json | head -1)
|
||||
fi
|
||||
echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
|
||||
echo "Version: $VERSION"
|
||||
|
||||
- name: Check if tag exists
|
||||
id: tag_check
|
||||
run: |
|
||||
VERSION="${{ steps.version.outputs.VERSION }}"
|
||||
if git rev-parse "v$VERSION" >/dev/null 2>&1; then
|
||||
echo "Tag v$VERSION already exists"
|
||||
echo "exists=true" >> $GITHUB_OUTPUT
|
||||
else
|
||||
echo "Tag v$VERSION does not exist"
|
||||
echo "exists=false" >> $GITHUB_OUTPUT
|
||||
fi
|
||||
|
||||
- name: Create and push tag
|
||||
if: steps.tag_check.outputs.exists == 'false'
|
||||
run: |
|
||||
git config user.name "GitHub Actions"
|
||||
git config user.email "actions@github.com"
|
||||
git tag -a "v${{ steps.version.outputs.VERSION }}" -m "Release v${{ steps.version.outputs.VERSION }}"
|
||||
git push origin "v${{ steps.version.outputs.VERSION }}"
|
||||
|
||||
- name: Download all artifacts
|
||||
uses: actions/download-artifact@v3
|
||||
with:
|
||||
path: artifacts
|
||||
|
||||
- name: Prepare release files
|
||||
run: |
|
||||
mkdir -p release-files
|
||||
find artifacts -type f \( -name "*.exe" -o -name "*.AppImage" -o -name "*.nupkg" -o -name "RELEASES*" \) -exec cp {} release-files/ \;
|
||||
ls -la release-files/
|
||||
|
||||
- name: Create or Update Release
|
||||
- name: Cleanup old Gitea releases
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
VERSION="${{ steps.version.outputs.VERSION }}"
|
||||
TAG_NAME="v${VERSION}"
|
||||
API_BASE="http://synbox.ruv.wtf:8418/api/v1"
|
||||
REPO="litruv/cinny-desktop"
|
||||
|
||||
# Check if release exists
|
||||
RELEASE_ID=$(curl -s -H "Authorization: token ${GITEA_TOKEN}" \
|
||||
"${API_BASE}/repos/${REPO}/releases/tags/${TAG_NAME}" | jq -r '.id // empty')
|
||||
|
||||
if [ -z "$RELEASE_ID" ]; then
|
||||
echo "Creating new release for ${TAG_NAME}..."
|
||||
RELEASE_ID=$(curl -s -X POST \
|
||||
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "{\"tag_name\": \"${TAG_NAME}\", \"name\": \"Release ${TAG_NAME}\", \"body\": \"Release ${VERSION}\", \"draft\": false, \"prerelease\": false}" \
|
||||
"${API_BASE}/repos/${REPO}/releases" | jq -r '.id')
|
||||
echo "Created release with ID: ${RELEASE_ID}"
|
||||
else
|
||||
echo "Release exists with ID: ${RELEASE_ID}"
|
||||
# Delete existing assets
|
||||
echo "Deleting existing assets..."
|
||||
ASSETS=$(curl -s -H "Authorization: token ${GITEA_TOKEN}" \
|
||||
"${API_BASE}/repos/${REPO}/releases/${RELEASE_ID}/assets" | jq -r '.[].id')
|
||||
for ASSET_ID in $ASSETS; do
|
||||
echo "Deleting asset ${ASSET_ID}..."
|
||||
curl -s -X DELETE -H "Authorization: token ${GITEA_TOKEN}" \
|
||||
"${API_BASE}/repos/${REPO}/releases/${RELEASE_ID}/assets/${ASSET_ID}"
|
||||
done
|
||||
fi
|
||||
|
||||
# Upload new assets
|
||||
echo "Uploading assets..."
|
||||
for FILE in release-files/*; do
|
||||
FILENAME=$(basename "$FILE")
|
||||
echo "Uploading ${FILENAME}..."
|
||||
curl -s -X POST \
|
||||
-H "Authorization: token ${GITEA_TOKEN}" \
|
||||
-H "Content-Type: application/octet-stream" \
|
||||
--data-binary "@${FILE}" \
|
||||
"${API_BASE}/repos/${REPO}/releases/${RELEASE_ID}/assets?name=${FILENAME}"
|
||||
echo ""
|
||||
set -euo pipefail
|
||||
TAG_NAME="${{ needs.prepare.outputs.tag }}"
|
||||
API_BASE="${{ github.server_url }}/api/v1"
|
||||
REPO="${{ github.repository }}"
|
||||
|
||||
echo "Cleaning up old Gitea releases (keeping ${TAG_NAME})..."
|
||||
OLD_RELEASES=$(curl -fsS -H "Authorization: token ${GITEA_TOKEN}" \
|
||||
"${API_BASE}/repos/${REPO}/releases" | jq -r --arg t "$TAG_NAME" '.[] | select(.tag_name != $t) | .id')
|
||||
|
||||
for OLD_ID in $OLD_RELEASES; do
|
||||
[ -n "$OLD_ID" ] || continue
|
||||
OLD_TAG=$(curl -fsS -H "Authorization: token ${GITEA_TOKEN}" \
|
||||
"${API_BASE}/repos/${REPO}/releases/${OLD_ID}" | jq -r '.tag_name')
|
||||
echo "Deleting Gitea release ${OLD_ID} (${OLD_TAG})..."
|
||||
curl -fsS -X DELETE -H "Authorization: token ${GITEA_TOKEN}" \
|
||||
"${API_BASE}/repos/${REPO}/releases/${OLD_ID}" >/dev/null || true
|
||||
if [ -n "$OLD_TAG" ] && [ "$OLD_TAG" != "null" ]; then
|
||||
curl -fsS -X DELETE -H "Authorization: token ${GITEA_TOKEN}" \
|
||||
"${API_BASE}/repos/${REPO}/tags/${OLD_TAG}" >/dev/null || true
|
||||
fi
|
||||
done
|
||||
|
||||
echo "Release complete!"
|
||||
|
||||
- name: Create GitHub Release
|
||||
|
||||
- name: Cleanup old GitHub releases
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GHTOKEN }}
|
||||
run: |
|
||||
VERSION="${{ steps.version.outputs.VERSION }}"
|
||||
TAG_NAME="v${VERSION}"
|
||||
set -euo pipefail
|
||||
TAG_NAME="${{ needs.prepare.outputs.tag }}"
|
||||
GITHUB_REPO="Paarrot/Paarrot-Desktop"
|
||||
|
||||
# Check if release exists on GitHub
|
||||
RELEASE_ID=$(curl -s -H "Authorization: token ${GH_TOKEN}" \
|
||||
"https://api.github.com/repos/${GITHUB_REPO}/releases/tags/${TAG_NAME}" | jq -r '.id // empty')
|
||||
|
||||
if [ -z "$RELEASE_ID" ]; then
|
||||
echo "Creating new GitHub release for ${TAG_NAME}..."
|
||||
RELEASE_ID=$(curl -s -X POST \
|
||||
-H "Authorization: token ${GH_TOKEN}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "{\"tag_name\": \"${TAG_NAME}\", \"name\": \"Release ${TAG_NAME}\", \"body\": \"Release ${VERSION}\", \"draft\": false, \"prerelease\": false}" \
|
||||
"https://api.github.com/repos/${GITHUB_REPO}/releases" | jq -r '.id')
|
||||
echo "Created GitHub release with ID: ${RELEASE_ID}"
|
||||
else
|
||||
echo "GitHub release exists with ID: ${RELEASE_ID}"
|
||||
fi
|
||||
|
||||
# Upload assets to GitHub
|
||||
echo "Uploading assets to GitHub..."
|
||||
UPLOAD_URL=$(curl -s -H "Authorization: token ${GH_TOKEN}" \
|
||||
"https://api.github.com/repos/${GITHUB_REPO}/releases/${RELEASE_ID}" | jq -r '.upload_url' | sed 's/{?name,label}//')
|
||||
|
||||
for FILE in release-files/*; do
|
||||
FILENAME=$(basename "$FILE")
|
||||
echo "Uploading ${FILENAME} to GitHub..."
|
||||
curl -s -X POST \
|
||||
-H "Authorization: token ${GH_TOKEN}" \
|
||||
-H "Content-Type: application/octet-stream" \
|
||||
--data-binary "@${FILE}" \
|
||||
"${UPLOAD_URL}?name=${FILENAME}"
|
||||
echo ""
|
||||
|
||||
echo "Cleaning up old GitHub releases (keeping ${TAG_NAME})..."
|
||||
OLD_RELEASES=$(curl -fsS -H "Authorization: token ${GH_TOKEN}" \
|
||||
"https://api.github.com/repos/${GITHUB_REPO}/releases" | jq -r --arg t "$TAG_NAME" '.[] | select(.tag_name != $t) | .id')
|
||||
|
||||
for OLD_ID in $OLD_RELEASES; do
|
||||
[ -n "$OLD_ID" ] || continue
|
||||
OLD_TAG=$(curl -fsS -H "Authorization: token ${GH_TOKEN}" \
|
||||
"https://api.github.com/repos/${GITHUB_REPO}/releases/${OLD_ID}" | jq -r '.tag_name')
|
||||
echo "Deleting GitHub release ${OLD_ID} (${OLD_TAG})..."
|
||||
curl -fsS -X DELETE -H "Authorization: token ${GH_TOKEN}" \
|
||||
"https://api.github.com/repos/${GITHUB_REPO}/releases/${OLD_ID}" >/dev/null || true
|
||||
if [ -n "$OLD_TAG" ] && [ "$OLD_TAG" != "null" ]; then
|
||||
curl -fsS -X DELETE -H "Authorization: token ${GH_TOKEN}" \
|
||||
"https://api.github.com/repos/${GITHUB_REPO}/git/refs/tags/${OLD_TAG}" >/dev/null || true
|
||||
fi
|
||||
done
|
||||
|
||||
echo "GitHub release complete!"
|
||||
|
||||
echo "Release finalize complete for ${TAG_NAME}"
|
||||
|
||||
@@ -0,0 +1,76 @@
|
||||
name: Checks
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
checks:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: false
|
||||
fetch-depth: 1
|
||||
|
||||
- name: Checkout submodules manually
|
||||
run: |
|
||||
set -euo pipefail
|
||||
# Use the same host/scheme the runner already used for origin (not public HTTPS).
|
||||
ORIGIN_URL=$(git remote get-url origin)
|
||||
ORIGIN_URL=${ORIGIN_URL%/}
|
||||
ORIGIN_URL=${ORIGIN_URL%.git}
|
||||
BASE_URL=${ORIGIN_URL%/*}
|
||||
CINNY_URL="${BASE_URL}/cinny.git"
|
||||
echo "Rewriting submodule URL to ${CINNY_URL}"
|
||||
git config submodule.cinny.url "${CINNY_URL}"
|
||||
git submodule sync --recursive
|
||||
|
||||
if git submodule update --init --recursive; then
|
||||
echo "Submodules checked out at pinned commits."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "Pinned submodule commit is unavailable on remote. Falling back to remote submodule HEAD."
|
||||
git submodule deinit -f --all || true
|
||||
rm -rf cinny .git/modules/cinny
|
||||
git config submodule.cinny.url "${CINNY_URL}"
|
||||
git submodule sync --recursive
|
||||
git submodule update --init --recursive --remote
|
||||
|
||||
echo "Resolved submodule commit:"
|
||||
git -C cinny rev-parse HEAD
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '22'
|
||||
cache: 'npm'
|
||||
cache-dependency-path: cinny/package-lock.json
|
||||
|
||||
- name: Install dependencies (cinny)
|
||||
working-directory: ./cinny
|
||||
run: npm ci --prefer-offline
|
||||
|
||||
# ci-checks.sh always exits 0: findings become issues, not failed builds.
|
||||
- name: Run checks
|
||||
env:
|
||||
API_BASE: ${{ github.server_url }}/api/v1
|
||||
# github.server_url is the internal runner host, so the commit link needs the public one.
|
||||
WEB_BASE: https://git.ruv.wtf
|
||||
REPO: ${{ github.repository }}
|
||||
SHA: ${{ github.sha }}
|
||||
# Prefer a PAT with issue write scope (secret: GITEA_TOKEN).
|
||||
# Default GITHUB_TOKEN is usually scoped to this repo only.
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
TOKEN="${GITEA_TOKEN:-${GITHUB_TOKEN:-}}"
|
||||
if [ -z "$TOKEN" ]; then
|
||||
echo "No GITEA_TOKEN/GITHUB_TOKEN available to file issues"
|
||||
exit 0
|
||||
fi
|
||||
export TOKEN
|
||||
bash cinny/scripts/ci-checks.sh
|
||||
@@ -0,0 +1,94 @@
|
||||
name: Tests
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
unit:
|
||||
# act_runner mounts /var/run/docker.sock into every container job, so a fork PR reaches
|
||||
# the Docker daemon on the runner host. Both jobs need the same guard.
|
||||
if: github.event.pull_request.head.repo.full_name == github.repository
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '22'
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Run unit tests
|
||||
run: npm run test:unit
|
||||
|
||||
e2e:
|
||||
# A fork PR controls both the test files and these steps, so only same-repository
|
||||
# PRs can be trusted with the E2E_PASSWORD secret.
|
||||
if: github.event.pull_request.head.repo.full_name == github.repository
|
||||
runs-on: ubuntu-latest
|
||||
# Needs the DOCKER-USER exception on the runner host: ruv.wtf is a macvlan interface on a
|
||||
# container there, so the reply to a bridge-networked job arrives on that container's bridge
|
||||
# and Docker's inter-bridge isolation drops it. The exception is host-wide, so it also covers
|
||||
# fork PR jobs, and the bridge name is Docker-generated: recreating the caddy container
|
||||
# renames it and the test fails closed.
|
||||
env:
|
||||
# Dedicated test account on the homeserver, not a personal one.
|
||||
E2E_HOMESERVER: ruv.wtf
|
||||
E2E_USER: giteaci
|
||||
# Repo secret: E2E_PASSWORD. The test fails with a clear message when it is missing.
|
||||
E2E_PASSWORD: ${{ secrets.E2E_PASSWORD }}
|
||||
steps:
|
||||
# .gitmodules uses a relative URL, so the runner resolves it against origin.
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
submodules: true
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '22'
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
# The E2E run drives the vite dev server, so cinny's dependencies are needed too.
|
||||
- name: Install dependencies (cinny)
|
||||
working-directory: ./cinny
|
||||
run: npm ci
|
||||
|
||||
# Electron needs system libraries the runner image does not ship. Do not narrow this to
|
||||
# chromium: Playwright's chromium dep set covers its own bundled browser, not Electron,
|
||||
# and drops libgtk-3-0t64, libegl1, libegl-mesa0, libgles2, libsecret-1-0, libxtst6 and
|
||||
# libxss1, which Electron needs to launch. Narrowing it fails with "Process failed to
|
||||
# launch!".
|
||||
- name: Install system libraries for Electron
|
||||
run: npx playwright install-deps
|
||||
|
||||
# The container runner image has no xvfb and no fresh apt lists. The host runner already
|
||||
# has xvfb, so the guard skips the install there; both share the ubuntu-latest label, so
|
||||
# which one runs is not fixed.
|
||||
- name: Ensure a display for Electron
|
||||
run: command -v xvfb-run >/dev/null || (sudo apt-get update && sudo apt-get install -y xvfb)
|
||||
|
||||
# The login form only renders after the auth-flows request succeeds, so an
|
||||
# unreachable homeserver shows up as a 30s locator timeout. Fail fast instead, on
|
||||
# connect failure or a non-2xx status.
|
||||
- name: Homeserver reachable from the runner
|
||||
run: curl -sSf --max-time 20 -o /dev/null -w '%{http_code}\n' "https://$E2E_HOMESERVER/.well-known/matrix/client"
|
||||
|
||||
- name: Run login E2E
|
||||
run: xvfb-run -a npm run test:e2e
|
||||
|
||||
# Gitea implements the v3 artifact protocol; v4 rejects it as GHES.
|
||||
- name: Upload test artifacts
|
||||
if: failure()
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: e2e-artifacts
|
||||
path: |
|
||||
test-results
|
||||
playwright-report
|
||||
@@ -0,0 +1,35 @@
|
||||
name: Update release notes manifest
|
||||
|
||||
on:
|
||||
push:
|
||||
paths:
|
||||
- 'cinny/public/update/*.md'
|
||||
- 'cinny/scripts/generate-update-manifest.mjs'
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
manifest:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '20'
|
||||
|
||||
- name: Generate manifest.json
|
||||
run: node cinny/scripts/generate-update-manifest.mjs
|
||||
|
||||
- name: Commit manifest if changed
|
||||
run: |
|
||||
if git diff --quiet -- cinny/public/update/manifest.json; then
|
||||
echo "manifest.json unchanged"
|
||||
exit 0
|
||||
fi
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
||||
git add cinny/public/update/manifest.json
|
||||
git commit -m "chore: regenerate update manifest.json"
|
||||
git push
|
||||
@@ -4,3 +4,6 @@ node_modules
|
||||
devAssets
|
||||
|
||||
.DS_Store
|
||||
dist-electron/
|
||||
playwright-report/
|
||||
test-results/
|
||||
|
||||
+1
-1
@@ -1,3 +1,3 @@
|
||||
[submodule "cinny"]
|
||||
path = cinny
|
||||
url = http://synbox.ruv.wtf:8418/litruv/cinny.git
|
||||
url = ../cinny.git
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
# Checks backlog
|
||||
|
||||
Lint and typecheck fix commits carry `[skip build]` in the commit message while
|
||||
the `ci-checks` issues are being worked down across the cinny repos. The checks
|
||||
workflow still runs; the Electron and mobile builds do not.
|
||||
|
||||
Honored in `cinny-desktop/.gitea/workflows/build.yml` and
|
||||
`cinny-mobile/.gitea/workflows/build.yml`.
|
||||
|
||||
Do not use `[skip ci]` for these commits. It also suppresses the version bump.
|
||||
@@ -1,172 +0,0 @@
|
||||
# Paarrot API Quick Start
|
||||
|
||||
A local HTTP API server for controlling Paarrot from external devices like Stream Deck, scripts, and automation tools.
|
||||
|
||||
## 🚀 Getting Started
|
||||
|
||||
The API server starts automatically when you run Paarrot. It listens on `http://127.0.0.1:33384`.
|
||||
|
||||
### Test the API
|
||||
|
||||
**Option 1: Using Postman**
|
||||
|
||||
Import the Postman collection for easy testing:
|
||||
1. Open Postman
|
||||
2. Click **Import** → **File**
|
||||
3. Select `paarrot-api.postman_collection.json`
|
||||
4. All endpoints will be ready to use!
|
||||
|
||||
The collection is automatically updated on git push.
|
||||
|
||||
**Option 2: Using the test script**
|
||||
```bash
|
||||
node test-api.js
|
||||
```
|
||||
|
||||
**Option 3: Using curl**
|
||||
```bash
|
||||
./test-api.sh
|
||||
```
|
||||
|
||||
**Option 4: Manual curl commands**
|
||||
```bash
|
||||
# Health check
|
||||
curl http://127.0.0.1:33384/health
|
||||
|
||||
# Toggle mute
|
||||
curl -X POST http://127.0.0.1:33384/mute/toggle
|
||||
|
||||
# Send message
|
||||
curl -X POST http://127.0.0.1:33384/message/current \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"message": "Hello from API!"}'
|
||||
```
|
||||
|
||||
## 📝 Quick Reference
|
||||
|
||||
### Common Endpoints
|
||||
|
||||
| Endpoint | Method | Description |
|
||||
|----------|--------|-------------|
|
||||
| `/health` | GET | Check if API is running |
|
||||
| `/status` | GET | Get app status (mute, deafen, etc.) |
|
||||
| `/mute/toggle` | POST | Toggle microphone mute |
|
||||
| `/deafen/toggle` | POST | Toggle deafen |
|
||||
| `/channels` | GET | Get list of rooms |
|
||||
| `/channel` | POST | Switch to a room |
|
||||
| `/message/current` | POST | Send message to current room |
|
||||
|
||||
## 🎮 Stream Deck Integration
|
||||
|
||||
1. Install the "API Ninja" or "HTTP Request" plugin
|
||||
2. Create buttons with these settings:
|
||||
|
||||
**Mute Toggle Button:**
|
||||
- URL: `http://127.0.0.1:33384/mute/toggle`
|
||||
- Method: POST
|
||||
|
||||
**Quick Message Button:**
|
||||
- URL: `http://127.0.0.1:33384/message/current`
|
||||
- Method: POST
|
||||
- Body: `{"message": "BRB!"}`
|
||||
|
||||
## 🔧 Integration with Paarrot
|
||||
|
||||
To enable full functionality, you need to implement the action handlers in the Cinny frontend:
|
||||
|
||||
1. Import the API handler in your app initialization:
|
||||
```typescript
|
||||
import { initPaarrotAPI } from './app/paarrot-api';
|
||||
|
||||
// After Matrix client is initialized
|
||||
initPaarrotAPI(matrixClient);
|
||||
```
|
||||
|
||||
2. Implement the TODO items in `cinny/src/app/paarrot-api.ts`:
|
||||
- Mute/unmute logic (WebRTC audio)
|
||||
- Deafen logic (WebRTC audio output)
|
||||
- Navigation to rooms (router integration)
|
||||
- Get current room from URL/state
|
||||
|
||||
## 📖 Full Documentation
|
||||
|
||||
See [API.md](API.md) for complete API documentation including:
|
||||
- All available endpoints
|
||||
- Request/response formats
|
||||
- Error handling
|
||||
- Code examples in multiple languages
|
||||
- Detailed integration guide
|
||||
|
||||
## 🛠️ Configuration
|
||||
|
||||
Edit `electron/api-server.js` to customize:
|
||||
- Port number (default: 33384)
|
||||
- Timeout duration (default: 10s)
|
||||
- CORS settings
|
||||
|
||||
## 🐛 Troubleshooting
|
||||
|
||||
**API not responding:**
|
||||
1. Check if Paarrot is running
|
||||
2. Look for "Paarrot API server listening" in console logs
|
||||
3. Verify port 33384 is not in use: `lsof -i :33384`
|
||||
|
||||
**Actions not working:**
|
||||
1. Check browser console for errors
|
||||
2. Ensure `initPaarrotAPI()` is called in your app
|
||||
3. Implement the TODO items in `paarrot-api.ts`
|
||||
|
||||
**Port in use:**
|
||||
Edit `electron/api-server.js` and change the port number in the constructor.
|
||||
|
||||
## 📦 Files
|
||||
|
||||
- `electron/api-server.js` - API server implementation
|
||||
- `cinny/src/app/paarrot-api.ts` - Client-side handler (needs implementation)
|
||||
- `test-api.js` - Node.js test script
|
||||
- `test-api.sh` - Bash test script
|
||||
- `API.md` - Full documentation
|
||||
|
||||
## 🔐 Security
|
||||
|
||||
- API only listens on localhost (127.0.0.1)
|
||||
- Not accessible from network
|
||||
- No authentication required (local only)
|
||||
- CORS enabled for all origins (safe since localhost only)
|
||||
|
||||
## 💡 Examples
|
||||
|
||||
**Python Script:**
|
||||
```python
|
||||
import requests
|
||||
|
||||
def toggle_mute():
|
||||
r = requests.post('http://127.0.0.1:33384/mute/toggle')
|
||||
print(r.json())
|
||||
|
||||
toggle_mute()
|
||||
```
|
||||
|
||||
**JavaScript:**
|
||||
```javascript
|
||||
async function sendQuickMessage(msg) {
|
||||
const res = await fetch('http://127.0.0.1:33384/message/current', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ message: msg })
|
||||
});
|
||||
return res.json();
|
||||
}
|
||||
```
|
||||
|
||||
## 🎯 Next Steps
|
||||
|
||||
1. Run Paarrot: `npm run dev`
|
||||
2. Test the API: `node test-api.js`
|
||||
3. Integrate the handler: Import and call `initPaarrotAPI()`
|
||||
4. Implement the TODO items in `paarrot-api.ts`
|
||||
5. Create Stream Deck buttons or automation scripts!
|
||||
|
||||
---
|
||||
|
||||
For more details, see [API.md](API.md)
|
||||
@@ -1,537 +0,0 @@
|
||||
# Paarrot API Server Documentation
|
||||
|
||||
The Paarrot API server provides a local HTTP API for controlling the Paarrot desktop app from external applications like Stream Deck, keyboard macros, scripts, and other automation tools.
|
||||
|
||||
## Server Details
|
||||
|
||||
- **Base URL**: `http://127.0.0.1:33384`
|
||||
- **Protocol**: HTTP
|
||||
- **Content-Type**: `application/json`
|
||||
- **CORS**: Enabled for all origins
|
||||
|
||||
## Authentication
|
||||
|
||||
Currently, no authentication is required. The API server only listens on localhost (127.0.0.1) for security.
|
||||
|
||||
## API Endpoints
|
||||
|
||||
### Health Check
|
||||
|
||||
Check if the API server is running.
|
||||
|
||||
**Endpoint**: `GET /health`
|
||||
|
||||
**Response**:
|
||||
```json
|
||||
{
|
||||
"status": "ok",
|
||||
"app": "Paarrot API",
|
||||
"version": "1.0.0"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Get Status
|
||||
|
||||
Get the current status of the app (mute, deafen, current room, etc.).
|
||||
|
||||
**Endpoint**: `GET /status`
|
||||
|
||||
**Response**:
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"data": {
|
||||
"muted": false,
|
||||
"deafened": false,
|
||||
"currentRoom": "!abc123:matrix.org",
|
||||
"connected": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Mute/Unmute
|
||||
|
||||
Set the mute status.
|
||||
|
||||
**Endpoint**: `POST /mute`
|
||||
|
||||
**Request Body**:
|
||||
```json
|
||||
{
|
||||
"muted": true
|
||||
}
|
||||
```
|
||||
|
||||
**Response**:
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"data": {
|
||||
"muted": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Toggle Mute
|
||||
|
||||
Toggle the current mute status.
|
||||
|
||||
**Endpoint**: `POST /mute/toggle`
|
||||
|
||||
**Response**:
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"data": {
|
||||
"muted": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Deafen/Undeafen
|
||||
|
||||
Set the deafen status (deafening also mutes).
|
||||
|
||||
**Endpoint**: `POST /deafen`
|
||||
|
||||
**Request Body**:
|
||||
```json
|
||||
{
|
||||
"deafened": true
|
||||
}
|
||||
```
|
||||
|
||||
**Response**:
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"data": {
|
||||
"deafened": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Toggle Deafen
|
||||
|
||||
Toggle the current deafen status.
|
||||
|
||||
**Endpoint**: `POST /deafen/toggle`
|
||||
|
||||
**Response**:
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"data": {
|
||||
"deafened": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Change Channel/Room
|
||||
|
||||
Switch to a different Matrix room.
|
||||
|
||||
**Endpoint**: `POST /channel`
|
||||
|
||||
**Request Body**:
|
||||
```json
|
||||
{
|
||||
"roomId": "!abc123:matrix.org"
|
||||
}
|
||||
```
|
||||
|
||||
**Response**:
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"data": {
|
||||
"roomId": "!abc123:matrix.org",
|
||||
"roomName": "General"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Get Channels/Rooms
|
||||
|
||||
Get a list of available rooms/channels.
|
||||
|
||||
**Endpoint**: `GET /channels`
|
||||
|
||||
**Response**:
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"data": [
|
||||
{
|
||||
"roomId": "!abc123:matrix.org",
|
||||
"name": "General",
|
||||
"server": "matrix.org",
|
||||
"isDirect": false,
|
||||
"avatar": null
|
||||
},
|
||||
{
|
||||
"roomId": "!def456:matrix.org",
|
||||
"name": "Random",
|
||||
"server": "matrix.org",
|
||||
"isDirect": false,
|
||||
"avatar": null
|
||||
},
|
||||
{
|
||||
"roomId": "!xyz789:example.com",
|
||||
"name": "General",
|
||||
"server": "example.com",
|
||||
"isDirect": false,
|
||||
"avatar": null
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
**Note**: The `server` field helps distinguish between rooms with the same name on different servers.
|
||||
|
||||
---
|
||||
|
||||
### Send Message
|
||||
|
||||
Send a message to a specific room.
|
||||
|
||||
**Endpoint**: `POST /message`
|
||||
|
||||
**Request Body**:
|
||||
```json
|
||||
{
|
||||
"roomId": "!abc123:matrix.org",
|
||||
"message": "Hello from the API!"
|
||||
}
|
||||
```
|
||||
|
||||
**Response**:
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"data": {
|
||||
"eventId": "$abc123",
|
||||
"roomId": "!abc123:matrix.org"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Send Message to Current Room
|
||||
|
||||
Send a message to the currently active room.
|
||||
|
||||
**Endpoint**: `POST /message/current`
|
||||
|
||||
**Request Body**:
|
||||
```json
|
||||
{
|
||||
"message": "Hello from the API!"
|
||||
}
|
||||
```
|
||||
|
||||
**Response**:
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"data": {
|
||||
"eventId": "$abc123",
|
||||
"roomId": "!abc123:matrix.org"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Get Current Room
|
||||
|
||||
Get information about the currently active room.
|
||||
|
||||
**Endpoint**: `GET /room/current`
|
||||
|
||||
**Response**:
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"data": {
|
||||
"roomId": "!abc123:matrix.org",
|
||||
"name": "General",
|
||||
"server": "matrix.org",
|
||||
"avatar": "mxc://matrix.org/abc123",
|
||||
"isDirect": false
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Error Responses
|
||||
|
||||
All endpoints return error responses in the following format:
|
||||
|
||||
```json
|
||||
{
|
||||
"success": false,
|
||||
"error": "Error message here"
|
||||
}
|
||||
```
|
||||
|
||||
Common HTTP status codes:
|
||||
- `200 OK` - Request successful
|
||||
- `400 Bad Request` - Missing or invalid parameters
|
||||
- `404 Not Found` - Endpoint not found
|
||||
- `500 Internal Server Error` - Server error
|
||||
|
||||
---
|
||||
|
||||
## Example Usage
|
||||
|
||||
### cURL
|
||||
|
||||
```bash
|
||||
# Toggle mute
|
||||
curl -X POST http://127.0.0.1:33384/mute/toggle
|
||||
|
||||
# Send message to current room
|
||||
curl -X POST http://127.0.0.1:33384/message/current \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"message": "Hello!"}'
|
||||
|
||||
# Change channel
|
||||
curl -X POST http://127.0.0.1:33384/channel \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"roomId": "!abc123:matrix.org"}'
|
||||
```
|
||||
|
||||
### JavaScript/Node.js
|
||||
|
||||
```javascript
|
||||
const fetch = require('node-fetch');
|
||||
|
||||
// Toggle mute
|
||||
async function toggleMute() {
|
||||
const response = await fetch('http://127.0.0.1:33384/mute/toggle', {
|
||||
method: 'POST'
|
||||
});
|
||||
const data = await response.json();
|
||||
console.log('Muted:', data.data.muted);
|
||||
}
|
||||
|
||||
// Send message
|
||||
async function sendMessage(roomId, message) {
|
||||
const response = await fetch('http://127.0.0.1:33384/message', {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Content-Type': 'application/json'
|
||||
},
|
||||
body: JSON.stringify({ roomId, message })
|
||||
});
|
||||
const data = await response.json();
|
||||
console.log('Message sent:', data.data.eventId);
|
||||
}
|
||||
```
|
||||
|
||||
### Python
|
||||
|
||||
```python
|
||||
import requests
|
||||
|
||||
# Toggle mute
|
||||
def toggle_mute():
|
||||
response = requests.post('http://127.0.0.1:33384/mute/toggle')
|
||||
data = response.json()
|
||||
print('Muted:', data['data']['muted'])
|
||||
|
||||
# Send message
|
||||
def send_message(room_id, message):
|
||||
response = requests.post('http://127.0.0.1:33384/message', json={
|
||||
'roomId': room_id,
|
||||
'message': message
|
||||
})
|
||||
data = response.json()
|
||||
print('Message sent:', data['data']['eventId'])
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Stream Deck Integration
|
||||
|
||||
To integrate with Stream Deck:
|
||||
|
||||
1. Install the "API Ninja" or "HTTP Request" plugin for Stream Deck
|
||||
2. Create a button with the following configuration:
|
||||
- **URL**: `http://127.0.0.1:33384/mute/toggle`
|
||||
- **Method**: POST
|
||||
- **Headers**: `Content-Type: application/json`
|
||||
|
||||
Example configurations:
|
||||
|
||||
**Mute Toggle Button**:
|
||||
- URL: `http://127.0.0.1:33384/mute/toggle`
|
||||
- Method: POST
|
||||
|
||||
**Deafen Toggle Button**:
|
||||
- URL: `http://127.0.0.1:33384/deafen/toggle`
|
||||
- Method: POST
|
||||
|
||||
**Send Quick Message**:
|
||||
- URL: `http://127.0.0.1:33384/message/current`
|
||||
- Method: POST
|
||||
- Body: `{"message": "BRB!"}`
|
||||
|
||||
---
|
||||
|
||||
## Client-Side Implementation
|
||||
|
||||
To enable the API functionality in the Paarrot app, you need to implement the action handlers in your Matrix client code. The API server sends actions via IPC to the renderer process, which should handle them and respond.
|
||||
|
||||
### Example Handler (TypeScript/React)
|
||||
|
||||
Add this to your app initialization:
|
||||
|
||||
```typescript
|
||||
// Listen for API actions from the Electron API server
|
||||
if (window.electron?.api?.onAction) {
|
||||
window.electron.api.onAction(async (action: {
|
||||
action: string;
|
||||
params: any;
|
||||
responseChannel: string;
|
||||
}) => {
|
||||
try {
|
||||
let result;
|
||||
|
||||
switch (action.action) {
|
||||
case 'toggle-mute':
|
||||
// Toggle microphone mute
|
||||
result = await toggleMicrophone();
|
||||
break;
|
||||
|
||||
case 'set-mute':
|
||||
// Set microphone mute state
|
||||
result = await setMicrophone(action.params.muted);
|
||||
break;
|
||||
|
||||
case 'toggle-deafen':
|
||||
// Toggle deafen (mute speakers)
|
||||
result = await toggleDeafen();
|
||||
break;
|
||||
|
||||
case 'set-deafen':
|
||||
// Set deafen state
|
||||
result = await setDeafen(action.params.deafened);
|
||||
break;
|
||||
|
||||
case 'change-channel':
|
||||
// Navigate to a different room
|
||||
result = await changeRoom(action.params.roomId);
|
||||
break;
|
||||
|
||||
case 'get-channels':
|
||||
// Get list of rooms
|
||||
result = await getRoomList();
|
||||
break;
|
||||
|
||||
case 'send-message':
|
||||
// Send message to specific room
|
||||
result = await sendMessage(action.params.roomId, action.params.message);
|
||||
break;
|
||||
|
||||
case 'send-message-current':
|
||||
// Send message to current room
|
||||
result = await sendMessageToCurrent(action.params.message);
|
||||
break;
|
||||
|
||||
case 'get-current-room':
|
||||
// Get current room info
|
||||
result = await getCurrentRoomInfo();
|
||||
break;
|
||||
|
||||
case 'get-status':
|
||||
// Get current app status
|
||||
result = await getAppStatus();
|
||||
break;
|
||||
|
||||
default:
|
||||
throw new Error(`Unknown action: ${action.action}`);
|
||||
}
|
||||
|
||||
// Send success response back
|
||||
window.electron.api.sendResponse(action.responseChannel, {
|
||||
success: true,
|
||||
data: result
|
||||
});
|
||||
} catch (error) {
|
||||
// Send error response back
|
||||
window.electron.api.sendResponse(action.responseChannel, {
|
||||
success: false,
|
||||
error: error.message
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
|
||||
The API server can be configured by modifying `electron/api-server.js`:
|
||||
|
||||
- **Default Port**: 33384 (can be changed in the constructor)
|
||||
- **Bind Address**: 127.0.0.1 (localhost only for security)
|
||||
- **Timeout**: 10 seconds for actions
|
||||
|
||||
---
|
||||
|
||||
## Security Notes
|
||||
|
||||
1. The API server only listens on localhost (127.0.0.1) and is not accessible from the network
|
||||
2. No authentication is implemented - anyone with local access can control the app
|
||||
3. Consider adding API key authentication if needed for your use case
|
||||
4. CORS is enabled for all origins since it's localhost only
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**API server not starting**:
|
||||
- Check if port 33384 is already in use
|
||||
- Check console logs for errors
|
||||
- Verify Express is installed: `npm install express cors body-parser`
|
||||
|
||||
**Actions not working**:
|
||||
- Ensure the client-side handler is implemented
|
||||
- Check browser console for errors
|
||||
- Verify the action names match between API server and client
|
||||
|
||||
**Timeout errors**:
|
||||
- Actions must respond within 10 seconds
|
||||
- Check if the Matrix client is initialized
|
||||
- Verify the action handler is registered
|
||||
|
||||
---
|
||||
|
||||
## Future Enhancements
|
||||
|
||||
Potential features to add:
|
||||
- WebSocket support for real-time events
|
||||
- Authentication with API keys
|
||||
- Voice channel controls (join/leave)
|
||||
- User status updates
|
||||
- Notification controls
|
||||
- Screen sharing controls
|
||||
-156
@@ -1,156 +0,0 @@
|
||||
# Paarrot Plugin System
|
||||
|
||||
The Paarrot desktop client includes a powerful plugin system that allows you to extend and customize your Matrix experience.
|
||||
|
||||
## What are Plugins?
|
||||
|
||||
Plugins are small JavaScript modules that run inside Paarrot and can:
|
||||
- Add custom commands
|
||||
- Modify the UI
|
||||
- React to Matrix events
|
||||
- Add new settings sections
|
||||
- Enhance functionality
|
||||
|
||||
## Installing Plugins
|
||||
|
||||
### From the Plugin Marketplace
|
||||
|
||||
1. Open **Settings** → **Plugins**
|
||||
2. Browse the **Marketplace** tab
|
||||
3. Click **Install** on any plugin you want to add
|
||||
4. The plugin will be downloaded and enabled automatically
|
||||
|
||||
### Manual Installation
|
||||
|
||||
1. Download a plugin ZIP file
|
||||
2. Extract it to your plugins directory:
|
||||
- **Windows**: `%APPDATA%\paarrot\plugins\`
|
||||
- **Linux**: `~/.config/Paarrot/plugins/`
|
||||
- **macOS**: `~/Library/Application Support/Paarrot/plugins/`
|
||||
3. Restart Paarrot
|
||||
4. Enable the plugin in **Settings** → **Plugins** → **Installed**
|
||||
|
||||
## Managing Plugins
|
||||
|
||||
### Viewing Installed Plugins
|
||||
|
||||
Go to **Settings** → **Plugins** → **Installed** to see all installed plugins.
|
||||
|
||||
### Enabling/Disabling Plugins
|
||||
|
||||
Click the toggle switch next to any plugin to enable or disable it. Disabled plugins won't run or use resources.
|
||||
|
||||
### Uninstalling Plugins
|
||||
|
||||
Click the **Uninstall** button next to any plugin to remove it completely.
|
||||
|
||||
### Searching Plugins
|
||||
|
||||
Use the search bar to filter plugins by name, description, author, or tags.
|
||||
|
||||
## Plugin Security
|
||||
|
||||
⚠️ **Important Security Information**
|
||||
|
||||
Plugins run with access to your Matrix client and can:
|
||||
- Read your messages
|
||||
- Send messages on your behalf
|
||||
- Access your room list
|
||||
- Modify app behavior
|
||||
|
||||
**Only install plugins from trusted sources!**
|
||||
|
||||
### Safety Tips
|
||||
|
||||
1. **Check the author**: Install plugins from known developers
|
||||
2. **Read reviews**: Look for community feedback
|
||||
3. **Review permissions**: Understand what the plugin can do
|
||||
4. **Keep updated**: Update plugins regularly for security fixes
|
||||
5. **Report issues**: If a plugin behaves suspiciously, report it immediately
|
||||
|
||||
## Developing Plugins
|
||||
|
||||
Want to create your own plugin? Check out the [Plugin Development Guide](./cinny/src/app/features/settings/plugins/PLUGIN_DEVELOPMENT.md).
|
||||
|
||||
### Quick Start
|
||||
|
||||
1. Create a plugin directory with:
|
||||
- `index.js` - Your plugin code
|
||||
- `plugin-metadata.json` - Plugin information
|
||||
|
||||
2. Implement the plugin interface:
|
||||
```javascript
|
||||
module.exports = {
|
||||
onLoad: async (context) => {
|
||||
// Your plugin initialization
|
||||
console.log('Plugin loaded!');
|
||||
},
|
||||
onUnload: async () => {
|
||||
// Cleanup when disabled
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
3. Test locally by copying to your plugins directory
|
||||
|
||||
4. Publish to the [Plugin Directory](https://github.com/Paarrot/Plugin-Directory)
|
||||
|
||||
## Plugin API
|
||||
|
||||
Plugins have access to:
|
||||
- **Matrix Client**: Full matrix-js-sdk client instance
|
||||
- **React**: For building UI components
|
||||
- **Commands**: Register custom slash commands
|
||||
- **UI Hooks**: Inject UI elements
|
||||
- **Settings**: Add custom settings sections
|
||||
- **Utilities**: Notifications and helpers
|
||||
|
||||
See the [Plugin Development Guide](./cinny/src/app/features/settings/plugins/PLUGIN_DEVELOPMENT.md) for complete API documentation.
|
||||
|
||||
## Example Plugins
|
||||
|
||||
Check out the `example-plugin/` directory for a simple example demonstrating:
|
||||
- Matrix client access
|
||||
- Event listeners
|
||||
- Custom commands
|
||||
- Notifications
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Plugin Won't Load
|
||||
|
||||
1. Check the browser console for errors (F12 → Console)
|
||||
2. Look for `[PluginLoader]` messages
|
||||
3. Verify `index.js` exists in the plugin directory
|
||||
4. Ensure `plugin-metadata.json` is valid JSON
|
||||
|
||||
### Plugin Crashes
|
||||
|
||||
1. Disable the plugin in Settings → Plugins
|
||||
2. Check console for error stack traces
|
||||
3. Report the issue to the plugin author
|
||||
4. Try reinstalling the plugin
|
||||
|
||||
### Performance Issues
|
||||
|
||||
If Paarrot becomes slow:
|
||||
1. Disable plugins one by one to identify the culprit
|
||||
2. Check for memory leaks in the console
|
||||
3. Contact the plugin author with details
|
||||
|
||||
## Plugin Directory
|
||||
|
||||
The official Paarrot Plugin Directory is maintained at:
|
||||
https://github.com/Paarrot/Plugin-Directory
|
||||
|
||||
Submit your plugins there to make them available in the marketplace!
|
||||
|
||||
## Support
|
||||
|
||||
- **Documentation**: [Plugin Development Guide](./cinny/src/app/features/settings/plugins/PLUGIN_DEVELOPMENT.md)
|
||||
- **Issues**: https://github.com/Paarrot/cinny-desktop/issues
|
||||
- **Community**: Join our Matrix room for plugin development help
|
||||
|
||||
## License
|
||||
|
||||
Plugins are independent works and have their own licenses. Check each plugin's metadata for license information.
|
||||
-1188
File diff suppressed because it is too large
Load Diff
@@ -1,199 +0,0 @@
|
||||
# Plugin System Wishlist - Implementation Summary
|
||||
|
||||
All requested features have been implemented! 🎉
|
||||
|
||||
## ✅ Implemented Features
|
||||
|
||||
### 1. ✅ Enhanced Slash Commands
|
||||
- **Simple commands**: `ctx.commands.register({ name: "shrug", run: () => "¯\\_(ツ)_/¯" })`
|
||||
- **Commands with args**: `ctx.commands.register({ name: "echo", args: ["text"], run: ({ text }) => text })`
|
||||
- Automatic argument parsing
|
||||
- Execution API: `ctx.commands.execute(name, args)`
|
||||
|
||||
### 2. ✅ Message Interceptors
|
||||
- **Before send**: `ctx.messages.onBeforeSend((msg) => { msg.content = "modified" })`
|
||||
- **On receive**: `ctx.messages.onReceive((msg) => { /* process */ })`
|
||||
- Full MessageContext with content, roomId, metadata
|
||||
- Async support for interceptors
|
||||
|
||||
### 3. ✅ Custom Renderers
|
||||
- **Register**: `ctx.ui.registerRenderer("message", (msg, defaultRenderer) => { /* render */ })`
|
||||
- **Unregister**: `ctx.ui.unregisterRenderer("message")`
|
||||
- Fallback to default renderer support
|
||||
- Discord-mod-tier customization enabled
|
||||
|
||||
### 4. ✅ Settings UI Per Plugin
|
||||
- **Define schema**: `ctx.settings.define({ theme: { type: "select", options: [...] } })`
|
||||
- **Supported types**: string, number, boolean, select, color
|
||||
- **Get/Set**: `ctx.settings.get(key)` / `ctx.settings.set(key, value)`
|
||||
- Auto-persisted to localStorage
|
||||
- No JSON editing needed!
|
||||
|
||||
### 5. ✅ Hot Reload
|
||||
- **API**: `pluginRegistry.reloadPlugin(pluginId, newPlugin, newContext)`
|
||||
- Auto-cleanup of old plugin resources
|
||||
- Maintains enabled/disabled state
|
||||
- Dev-friendly workflow
|
||||
|
||||
### 6. ✅ Dependency System
|
||||
- **Declare**: `dependencies: { "paarrot.core-utils": "^1.0.0" }`
|
||||
- **Require**: `const utils = ctx.require("paarrot.utils")`
|
||||
- Error handling for missing dependencies
|
||||
- Plugin exports system
|
||||
|
||||
### 7. ✅ Raw Matrix Events Hook
|
||||
- **Full SDK access**: `ctx.matrix.on("m.room.message", (ev) => { })`
|
||||
- **Any event type**: Room.timeline, sync, RoomState.events, etc.
|
||||
- Direct Matrix.js SDK integration
|
||||
- Power users will go nuts!
|
||||
|
||||
### 8. ✅ Background Tasks / Intervals
|
||||
- **Interval**: `ctx.timers.setInterval(() => { /* cursed shit */ }, 10000)`
|
||||
- **Timeout**: `ctx.timers.setTimeout(() => { }, 5000)`
|
||||
- **Clear**: `ctx.timers.clearInterval(id)` / `ctx.timers.clearTimeout(id)`
|
||||
- Auto-cleanup on plugin unload
|
||||
- Perfect for bots, reminders, auto-cleanup
|
||||
|
||||
### 9. ✅ Notifications API
|
||||
- **Simple**: `ctx.notify("Oi")`
|
||||
- **Advanced**: `ctx.notify({ title: "Oi", body: "New message from Steve", type: "info" })`
|
||||
- Action buttons support
|
||||
- Custom duration
|
||||
|
||||
### 10. ✅ Plugin Logs Panel
|
||||
- **Logging**: `ctx.log()`, `ctx.warn()`, `ctx.error()`
|
||||
- Per-plugin log storage
|
||||
- Visible in `pluginRegistry.getLogs(pluginId)`
|
||||
- Cleared on plugin unload
|
||||
- Max 1000 logs retained
|
||||
|
||||
## 🎯 Bonus Features
|
||||
|
||||
- **Plugin exports**: Share functionality between plugins
|
||||
- **Automatic cleanup**: Timers, handlers, resources auto-cleaned on unload
|
||||
- **Error isolation**: Plugin errors don't crash the app
|
||||
- **Type safety**: Full TypeScript definitions
|
||||
- **Sandboxed execution**: Plugins run in controlled environment
|
||||
- **Rich context**: Full Matrix client, React, all APIs
|
||||
|
||||
## 📁 Files Changed
|
||||
|
||||
### Core System
|
||||
- [`PluginAPI.ts`](cinny/src/app/features/settings/plugins/PluginAPI.ts) - Enhanced with all APIs
|
||||
- [`PluginLoader.tsx`](cinny/src/app/features/settings/plugins/PluginLoader.tsx) - Complete rewrite with context creation
|
||||
- [`index.ts`](cinny/src/app/features/settings/plugins/index.ts) - Exports updated
|
||||
|
||||
### Documentation
|
||||
- [`PLUGIN_DEVELOPMENT.md`](cinny/src/app/features/settings/plugins/PLUGIN_DEVELOPMENT.md) - Comprehensive guide
|
||||
- [`PLUGINS.md`](PLUGINS.md) - User guide
|
||||
- [`example-plugin/index.js`](example-plugin/index.js) - Full-featured example
|
||||
|
||||
### Integration
|
||||
- [`ClientRoot.tsx`](cinny/src/app/pages/client/ClientRoot.tsx) - PluginLoader integrated
|
||||
- [`main.js`](electron/main.js) - IPC handler for reading plugin code
|
||||
- [`preload.js`](electron/preload.js) - readPluginCode API exposed
|
||||
- [`ext.d.ts`](cinny/src/ext.d.ts) - TypeScript definitions
|
||||
|
||||
## 🚀 Usage Examples
|
||||
|
||||
### Command with Args
|
||||
```javascript
|
||||
ctx.commands.register({
|
||||
name: "echo",
|
||||
args: ["text"],
|
||||
run: ({ text }) => text
|
||||
});
|
||||
```
|
||||
|
||||
### Message Interceptor
|
||||
```javascript
|
||||
ctx.messages.onBeforeSend((msg) => {
|
||||
if (msg.content === "brb") {
|
||||
msg.content = "be right back ya legend";
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Custom Settings
|
||||
```javascript
|
||||
ctx.settings.define({
|
||||
theme: { type: "select", options: ["dark", "light"] },
|
||||
spamFilter: { type: "boolean", default: true }
|
||||
});
|
||||
```
|
||||
|
||||
### Background Tasks
|
||||
```javascript
|
||||
ctx.timers.setInterval(() => {
|
||||
// do cursed shit every 10s
|
||||
}, 10000);
|
||||
```
|
||||
|
||||
### Raw Matrix Events
|
||||
```javascript
|
||||
ctx.matrix.on("m.room.message", (ev) => {
|
||||
ctx.log('Message:', ev.getContent().body);
|
||||
});
|
||||
```
|
||||
|
||||
### Plugin Dependencies
|
||||
```javascript
|
||||
const utils = ctx.require("paarrot.utils");
|
||||
utils.doSomething();
|
||||
```
|
||||
|
||||
## 🎨 Plugin API Summary
|
||||
|
||||
```typescript
|
||||
interface PluginContext {
|
||||
pluginId: string;
|
||||
matrixClient: MatrixClient;
|
||||
React: typeof import('react');
|
||||
|
||||
commands: {
|
||||
register: (command: PluginCommand) => void;
|
||||
unregister: (name: string) => void;
|
||||
execute: (name: string, args: Record<string, any>) => Promise<string | void>;
|
||||
};
|
||||
|
||||
messages: {
|
||||
onBeforeSend: (interceptor: MessageInterceptor) => void;
|
||||
onReceive: (interceptor: MessageInterceptor) => void;
|
||||
};
|
||||
|
||||
ui: {
|
||||
registerRenderer: (type: string, renderer: CustomRenderer) => void;
|
||||
unregisterRenderer: (type: string) => void;
|
||||
};
|
||||
|
||||
settings: {
|
||||
define: (schema: SettingsSchema) => void;
|
||||
get: <T = any>(key: string) => T | undefined;
|
||||
set: (key: string, value: any) => void;
|
||||
};
|
||||
|
||||
matrix: {
|
||||
on: (eventType: string, handler: (event: MatrixEvent) => void) => void;
|
||||
off: (eventType: string, handler: (event: MatrixEvent) => void) => void;
|
||||
};
|
||||
|
||||
timers: {
|
||||
setInterval: (callback: () => void, ms: number) => number;
|
||||
setTimeout: (callback: () => void, ms: number) => number;
|
||||
clearInterval: (id: number) => void;
|
||||
clearTimeout: (id: number) => void;
|
||||
};
|
||||
|
||||
notify: (options: NotificationOptions | string) => void;
|
||||
log: (...args: any[]) => void;
|
||||
warn: (...args: any[]) => void;
|
||||
error: (...args: any[]) => void;
|
||||
require: (pluginId: string) => any;
|
||||
}
|
||||
```
|
||||
|
||||
## 🔥 The Result
|
||||
|
||||
A **production-ready plugin system** that rivals Discord, VSCode, and other extensible apps. Plugin developers will have everything they need to build powerful extensions without fighting the framework.
|
||||
|
||||
**No compromises. All features implemented. Ready to ship.**
|
||||
@@ -1,4 +1,4 @@
|
||||
# Paarrot
|
||||
# Paarrot
|
||||
|
||||
Paarrot is a Matrix client focusing primarily on simple, elegant and secure interface. The desktop app is built with Electron and based on Cinny.
|
||||
|
||||
@@ -22,10 +22,79 @@ To setup development locally run the following commands:
|
||||
* `cd cinny-desktop/cinny`
|
||||
* `npm ci`
|
||||
* `cd ..`
|
||||
* `npm ci`
|
||||
* `npm ci`
|
||||
|
||||
To build the app locally, run:
|
||||
* `npm run build`
|
||||
|
||||
To start local dev server, run:
|
||||
* `npm run dev`
|
||||
|
||||
## Testing
|
||||
|
||||
* `npm run test` - unit and E2E
|
||||
* `npm run test:unit` - Vitest
|
||||
* `npm run test:e2e` - Playwright driving Electron
|
||||
|
||||
The E2E test drives the real Electron app against the vite dev server, so it needs the
|
||||
cinny dependencies installed and an X display. On a headless machine run it under xvfb:
|
||||
`xvfb-run -a npm run test:e2e`.
|
||||
|
||||
The E2E test logs in to a live homeserver over the network, so it needs network access and a
|
||||
working test account. It uses a dedicated account, never a personal one:
|
||||
|
||||
Variable | Default
|
||||
---|---
|
||||
`E2E_HOMESERVER` | `ruv.wtf`
|
||||
`E2E_USER` | `giteaci`
|
||||
`E2E_PASSWORD` | required, read from the environment, never committed
|
||||
|
||||
A failed E2E run attaches a screenshot and the main and renderer console logs to the
|
||||
report. CI uploads `test-results/` and `playwright-report/` as artifacts.
|
||||
|
||||
## Plugin System
|
||||
|
||||
Paarrot includes a plugin system for extending and customising the app with JavaScript modules.
|
||||
|
||||
### Installing Plugins
|
||||
|
||||
1. Drop a plugin folder into your plugins directory:
|
||||
- **Windows**: `%APPDATA%\paarrot\plugins\<plugin-name>\`
|
||||
- **Linux**: `~/.config/Paarrot/plugins/<plugin-name>/` for the packaged app, `~/.config/paarrot/plugins/<plugin-name>/` when running from source
|
||||
- **macOS**: `~/Library/Application Support/Paarrot/plugins/<plugin-name>/`
|
||||
2. Enable it in **Settings → Plugins → Installed**
|
||||
|
||||
### What Plugins Can Do
|
||||
|
||||
- Register custom slash commands
|
||||
- Intercept and modify messages
|
||||
- Inject buttons into 11 UI locations (nav lists, toolbars, headers, sidebar, menus)
|
||||
- Register custom themes
|
||||
- Hook into raw Matrix events
|
||||
- Run background tasks
|
||||
- Show system notifications
|
||||
|
||||
### Plugin Locations (UI Buttons)
|
||||
|
||||
Plugins can inject buttons as **nav list rows** or **icon buttons** across the app:
|
||||
|
||||
| Location | Style | Where |
|
||||
|---|---|---|
|
||||
| `channel-list` | Nav row | Space channel list |
|
||||
| `home-section` | Nav row | Home panel, above room list |
|
||||
| `direct-messages` | Nav row | DMs panel, below "Create Chat" |
|
||||
| `sidebar-actions` | Icon | Left sidebar — above Explore and above Search |
|
||||
| `text-composer-toolbar` | Icon | Message composer toolbar |
|
||||
| `composer-actions` | Icon | Beside the `+` attach button |
|
||||
| `room-header` | Icon | Room header bar |
|
||||
| `room-menu` | Icon | Room ⋮ dropdown |
|
||||
| `message-actions` | Icon | Message hover bar |
|
||||
| `user-menu` | Icon | Right-click on user avatar |
|
||||
| `search-notification-section` | Icon | Notifications page header |
|
||||
|
||||
### Documentation
|
||||
|
||||
- [Plugin System Overview](PLUGINS.md)
|
||||
- [Full Plugin API Reference](docs/PLUGIN_API.md)
|
||||
- [Button Registration API](docs/PLUGIN_BUTTON_API.md)
|
||||
- [Example Plugins](plugins/)
|
||||
|
||||
+1
-1
Submodule cinny updated: d1d3033c15...9b3956d85f
+1
-18
@@ -9,30 +9,13 @@
|
||||
"xmr.se"
|
||||
],
|
||||
"allowCustomHomeservers": true,
|
||||
|
||||
"calling": {
|
||||
"livekitServiceUrl": "https://b.ruv.wtf/matrix-rtc/livekit/jwt"
|
||||
},
|
||||
|
||||
"featuredCommunities": {
|
||||
"openAsDefault": false,
|
||||
"spaces": [
|
||||
"#cinny-space:matrix.org",
|
||||
"#community:matrix.org",
|
||||
"#space:envs.net",
|
||||
"#science-space:matrix.org",
|
||||
"#libregaming-games:tchncs.de",
|
||||
"#mathematics-on:matrix.org"
|
||||
],
|
||||
"rooms": [
|
||||
"#cinny:matrix.org",
|
||||
"#freesoftware:matrix.org",
|
||||
"#pcapdroid:matrix.org",
|
||||
"#gentoo:matrix.org",
|
||||
"#PrivSec.dev:arcticfoxes.net",
|
||||
"#disroot:aria-net.org"
|
||||
],
|
||||
"servers": ["envs.net", "matrix.org", "monero.social", "mozilla.org"]
|
||||
"servers": []
|
||||
},
|
||||
|
||||
"hashRouter": {
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
provider: github
|
||||
owner: Paarrot
|
||||
repo: Paarrot-Desktop
|
||||
updaterCacheDirName: paarrot-updater
|
||||
Binary file not shown.
+19
-12
@@ -10,6 +10,7 @@
|
||||
"files": [
|
||||
"electron/**/*",
|
||||
"cinny/dist/**/*",
|
||||
"dev-app-update.yml",
|
||||
"!**/*.map",
|
||||
"!**/node_modules/*/{CHANGELOG.md,README.md,README,readme.md,readme}",
|
||||
"!**/node_modules/*/{test,__tests__,tests,powered-test,example,examples}",
|
||||
@@ -35,6 +36,12 @@
|
||||
"filter": ["**/*"]
|
||||
}
|
||||
],
|
||||
"protocols": [
|
||||
{
|
||||
"name": "Paarrot URL",
|
||||
"schemes": ["paarrot"]
|
||||
}
|
||||
],
|
||||
"linux": {
|
||||
"target": [
|
||||
{
|
||||
@@ -50,6 +57,7 @@
|
||||
"Name": "Paarrot",
|
||||
"GenericName": "Matrix Client",
|
||||
"Comment": "A Matrix client built with Cinny",
|
||||
"MimeType": "x-scheme-handler/paarrot;",
|
||||
"Categories": "Network;InstantMessaging;",
|
||||
"Keywords": "matrix;chat;messaging;",
|
||||
"StartupWMClass": "paarrot"
|
||||
@@ -77,30 +85,29 @@
|
||||
"win": {
|
||||
"target": [
|
||||
{
|
||||
"target": "squirrel",
|
||||
"target": "nsis",
|
||||
"arch": ["x64"]
|
||||
}
|
||||
],
|
||||
"icon": "icons/icon.ico",
|
||||
"artifactName": "${productName}-${version}-${os}-${arch}.${ext}"
|
||||
},
|
||||
"squirrelWindows": {
|
||||
"name": "Paarrot",
|
||||
"loadingGif": "icons/icon.png",
|
||||
"iconUrl": "http://synbox.ruv.wtf:8418/litruv/cinny-desktop/raw/branch/main/icons/icon.ico",
|
||||
"remoteReleases": false
|
||||
"nsis": {
|
||||
"oneClick": true,
|
||||
"perMachine": false,
|
||||
"allowToChangeInstallationDirectory": false,
|
||||
"deleteAppDataOnUninstall": false,
|
||||
"createDesktopShortcut": true,
|
||||
"createStartMenuShortcut": true,
|
||||
"shortcutName": "Paarrot",
|
||||
"differentialPackage": false
|
||||
},
|
||||
"compression": "normal",
|
||||
"publish": [
|
||||
{
|
||||
"provider": "generic",
|
||||
"url": "http://synbox.ruv.wtf:8418/litruv/cinny-desktop/releases/download/v${version}",
|
||||
"channel": "latest"
|
||||
},
|
||||
{
|
||||
"provider": "github",
|
||||
"owner": "Paarrot",
|
||||
"repo": "Paarrot-Desktop",
|
||||
"token": "${env.GH_TOKEN}",
|
||||
"releaseType": "release"
|
||||
}
|
||||
]
|
||||
|
||||
+79
-1
@@ -153,6 +153,72 @@ class PaarrotAPIServer {
|
||||
}
|
||||
});
|
||||
|
||||
// Recent messages across group channels (non-DMs)
|
||||
this.app.get('/messages/groups', async (req, res) => {
|
||||
try {
|
||||
const result = await this.executeAction('get-messages-groups', {
|
||||
limit: req.query.limit,
|
||||
});
|
||||
res.json({ success: true, data: result });
|
||||
} catch (error) {
|
||||
res.status(500).json({ success: false, error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// Recent messages across DMs
|
||||
this.app.get('/messages/dms', async (req, res) => {
|
||||
try {
|
||||
const result = await this.executeAction('get-messages-dms', {
|
||||
limit: req.query.limit,
|
||||
});
|
||||
res.json({ success: true, data: result });
|
||||
} catch (error) {
|
||||
res.status(500).json({ success: false, error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// Recent messages across groups + DMs
|
||||
this.app.get('/messages/combined', async (req, res) => {
|
||||
try {
|
||||
const result = await this.executeAction('get-messages-combined', {
|
||||
limit: req.query.limit,
|
||||
});
|
||||
res.json({ success: true, data: result });
|
||||
} catch (error) {
|
||||
res.status(500).json({ success: false, error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// Unread conversations across group channels (non-DMs)
|
||||
this.app.get('/unreads/groups', async (req, res) => {
|
||||
try {
|
||||
const result = await this.executeAction('get-unreads-groups');
|
||||
res.json({ success: true, data: result });
|
||||
} catch (error) {
|
||||
res.status(500).json({ success: false, error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// Unread conversations across DMs
|
||||
this.app.get('/unreads/dms', async (req, res) => {
|
||||
try {
|
||||
const result = await this.executeAction('get-unreads-dms');
|
||||
res.json({ success: true, data: result });
|
||||
} catch (error) {
|
||||
res.status(500).json({ success: false, error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// Unread conversations across groups + DMs
|
||||
this.app.get('/unreads/combined', async (req, res) => {
|
||||
try {
|
||||
const result = await this.executeAction('get-unreads-combined');
|
||||
res.json({ success: true, data: result });
|
||||
} catch (error) {
|
||||
res.status(500).json({ success: false, error: error.message });
|
||||
}
|
||||
});
|
||||
|
||||
// 404 handler
|
||||
this.app.use((req, res) => {
|
||||
res.status(404).json({
|
||||
@@ -169,7 +235,13 @@ class PaarrotAPIServer {
|
||||
'GET /channels',
|
||||
'POST /message',
|
||||
'POST /message/current',
|
||||
'GET /room/current'
|
||||
'GET /room/current',
|
||||
'GET /messages/groups',
|
||||
'GET /messages/dms',
|
||||
'GET /messages/combined',
|
||||
'GET /unreads/groups',
|
||||
'GET /unreads/dms',
|
||||
'GET /unreads/combined'
|
||||
]
|
||||
});
|
||||
});
|
||||
@@ -237,6 +309,12 @@ class PaarrotAPIServer {
|
||||
console.log(' POST /message');
|
||||
console.log(' POST /message/current');
|
||||
console.log(' GET /room/current');
|
||||
console.log(' GET /messages/groups');
|
||||
console.log(' GET /messages/dms');
|
||||
console.log(' GET /messages/combined');
|
||||
console.log(' GET /unreads/groups');
|
||||
console.log(' GET /unreads/dms');
|
||||
console.log(' GET /unreads/combined');
|
||||
resolve(port);
|
||||
}).on('error', (err) => {
|
||||
if (err.code === 'EADDRINUSE') {
|
||||
|
||||
@@ -0,0 +1,122 @@
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Debug Packets</title>
|
||||
<style>
|
||||
:root { color-scheme: dark; }
|
||||
body { margin: 0; background: #14161a; color: #d9dce1; font: 13px/1.45 ui-monospace, SFMono-Regular, Menlo, monospace; }
|
||||
main { display: flex; flex-direction: column; height: 100vh; }
|
||||
header { display: flex; gap: 8px; align-items: center; padding: 8px; border-bottom: 1px solid #262a31; flex-wrap: wrap; }
|
||||
input[type="search"] { flex: 1 1 160px; min-width: 120px; background: #1b1f25; color: inherit; border: 1px solid #2b3038; border-radius: 4px; padding: 6px 8px; font: inherit; }
|
||||
button { background: #1b1f25; color: inherit; border: 1px solid #2b3038; border-radius: 4px; padding: 6px 10px; font: inherit; cursor: pointer; }
|
||||
button:hover { border-color: #3b424d; }
|
||||
label { display: flex; gap: 6px; align-items: center; }
|
||||
#count { color: #8b93a1; }
|
||||
#list { flex: 1; overflow: auto; }
|
||||
table { width: 100%; border-collapse: collapse; }
|
||||
th, td { text-align: left; padding: 4px 8px; border-bottom: 1px solid #21252b; white-space: nowrap; }
|
||||
th { position: sticky; top: 0; background: #171a1f; color: #8b93a1; }
|
||||
tbody tr { cursor: pointer; }
|
||||
tbody tr:hover, tbody tr.sel { background: #1b1f25; }
|
||||
#detail { max-height: 40vh; overflow: auto; margin: 0; padding: 10px; border-top: 1px solid #262a31; white-space: pre-wrap; word-break: break-word; }
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<main>
|
||||
<header>
|
||||
<input id="filter" type="search" placeholder="Filter (method, path, status, txnId, eventId, body)" aria-label="Filter packets">
|
||||
<label><input id="autoscroll" type="checkbox" checked> Autoscroll</label>
|
||||
<button id="clear">Clear</button>
|
||||
<button id="copy">Copy all</button>
|
||||
<button id="download">Download JSON lines</button>
|
||||
<span id="count">0</span>
|
||||
</header>
|
||||
<div id="list">
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Time</th><th>Phase</th><th>Method</th><th>Path</th><th>Status</th><th>ms</th><th>txnId / eventId</th></tr>
|
||||
</thead>
|
||||
<tbody id="rows"></tbody>
|
||||
</table>
|
||||
</div>
|
||||
<pre id="detail"></pre>
|
||||
</main>
|
||||
<script>
|
||||
const MAX = 2000;
|
||||
const packets = [];
|
||||
const rows = document.getElementById('rows');
|
||||
const list = document.getElementById('list');
|
||||
const detail = document.getElementById('detail');
|
||||
const filter = document.getElementById('filter');
|
||||
const autoscroll = document.getElementById('autoscroll');
|
||||
const count = document.getElementById('count');
|
||||
|
||||
const text = (v) => (v === undefined || v === null ? '' : String(v));
|
||||
|
||||
function matches(p) {
|
||||
const q = filter.value.trim().toLowerCase();
|
||||
if (!q) return true;
|
||||
return [p.method, p.path, p.status, p.txnId, p.eventId, p.error, p.req, p.res]
|
||||
.some((f) => text(f).toLowerCase().includes(q));
|
||||
}
|
||||
|
||||
function addRow(p) {
|
||||
const tr = document.createElement('tr');
|
||||
[new Date(p.ts).toLocaleTimeString(), p.phase, p.method, p.path, p.status, p.ms, p.txnId || p.eventId]
|
||||
.forEach((v) => {
|
||||
const td = document.createElement('td');
|
||||
td.textContent = text(v);
|
||||
tr.appendChild(td);
|
||||
});
|
||||
tr.addEventListener('click', () => {
|
||||
document.querySelectorAll('tr.sel').forEach((r) => r.classList.remove('sel'));
|
||||
tr.classList.add('sel');
|
||||
detail.textContent = JSON.stringify(p, null, 2);
|
||||
});
|
||||
rows.appendChild(tr);
|
||||
}
|
||||
|
||||
function render() {
|
||||
rows.textContent = '';
|
||||
packets.filter(matches).forEach(addRow);
|
||||
count.textContent = packets.length;
|
||||
if (autoscroll.checked) list.scrollTop = list.scrollHeight;
|
||||
}
|
||||
|
||||
function add(p) {
|
||||
packets.push(p);
|
||||
if (packets.length > MAX) packets.shift();
|
||||
count.textContent = packets.length;
|
||||
if (!matches(p)) return;
|
||||
addRow(p);
|
||||
if (autoscroll.checked) list.scrollTop = list.scrollHeight;
|
||||
}
|
||||
|
||||
filter.addEventListener('input', render);
|
||||
document.getElementById('clear').addEventListener('click', () => {
|
||||
packets.length = 0;
|
||||
detail.textContent = '';
|
||||
render();
|
||||
});
|
||||
const lines = () => packets.map((p) => JSON.stringify(p)).join('\n');
|
||||
|
||||
document.getElementById('copy').addEventListener('click', () => {
|
||||
window.electron?.clipboard?.writeText(lines());
|
||||
});
|
||||
document.getElementById('download').addEventListener('click', () => {
|
||||
window.electron?.media?.saveFile({
|
||||
filename: 'packets.jsonl',
|
||||
mimeType: 'application/x-jsonlines',
|
||||
data: lines(),
|
||||
});
|
||||
});
|
||||
|
||||
// Main sends the backlog as one batch (array), later packets one at a time
|
||||
const unsubscribe = window.electron?.debug?.onPacket((data) => {
|
||||
(Array.isArray(data) ? data : [data]).forEach(add);
|
||||
});
|
||||
window.addEventListener('beforeunload', () => unsubscribe?.());
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,381 @@
|
||||
/**
|
||||
* Discord shop collectibles: fetch a published catalog and download selected assets from Discord CDN.
|
||||
*/
|
||||
|
||||
const ITEM_TYPE_FOLDER = {
|
||||
0: 'avatar-decorations',
|
||||
1: 'profile-effects',
|
||||
2: 'nameplates',
|
||||
};
|
||||
|
||||
const ITEM_TYPE_KEY = {
|
||||
0: 'avatar_decoration',
|
||||
1: 'profile_effect',
|
||||
2: 'nameplate',
|
||||
};
|
||||
|
||||
const CDN_BASE = 'https://cdn.discordapp.com';
|
||||
const CDN_HOST_RE = /(^|\.)(discordapp\.com|discordapp\.net|discord\.com)$/i;
|
||||
const DEFAULT_USER_AGENT =
|
||||
'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) discord/1.0 Chrome/120 Electron/28 Safari/537.36';
|
||||
const PUBLISHED_CATALOG_URLS = [
|
||||
'https://github.com/litruv/discord-collectibles/releases/download/latest/profileeffects.json',
|
||||
'https://github.com/litruv/discord-collectibles/releases/download/latest/nameplate.json',
|
||||
'https://github.com/litruv/discord-collectibles/releases/download/latest/avatardecorations.json',
|
||||
];
|
||||
|
||||
const sleep = (ms) => new Promise((r) => setTimeout(r, ms));
|
||||
|
||||
function isCdnUrl(value) {
|
||||
if (typeof value !== 'string' || !value.startsWith('http')) return false;
|
||||
try {
|
||||
return CDN_HOST_RE.test(new URL(value).hostname);
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
function basenameFromUrl(url) {
|
||||
try {
|
||||
const { pathname } = new URL(url);
|
||||
const last = decodeURIComponent(pathname.split('/').filter(Boolean).pop() || '');
|
||||
return last || 'asset';
|
||||
} catch {
|
||||
return 'asset';
|
||||
}
|
||||
}
|
||||
|
||||
function guessMimeType(filename) {
|
||||
const lower = String(filename).toLowerCase();
|
||||
if (lower.endsWith('.png')) return 'image/png';
|
||||
if (lower.endsWith('.webp')) return 'image/webp';
|
||||
if (lower.endsWith('.webm')) return 'video/webm';
|
||||
if (lower.endsWith('.gif')) return 'image/gif';
|
||||
if (lower.endsWith('.jpg') || lower.endsWith('.jpeg')) return 'image/jpeg';
|
||||
return 'application/octet-stream';
|
||||
}
|
||||
|
||||
function deepCollectUrls(node, acc = new Set()) {
|
||||
if (node == null) return acc;
|
||||
if (typeof node === 'string') {
|
||||
if (isCdnUrl(node)) acc.add(node);
|
||||
return acc;
|
||||
}
|
||||
if (Array.isArray(node)) {
|
||||
for (const v of node) deepCollectUrls(v, acc);
|
||||
return acc;
|
||||
}
|
||||
if (typeof node === 'object') {
|
||||
for (const v of Object.values(node)) deepCollectUrls(v, acc);
|
||||
}
|
||||
return acc;
|
||||
}
|
||||
|
||||
function urlsForItem(item) {
|
||||
const out = [];
|
||||
const seen = new Set();
|
||||
|
||||
function push(url, filename, role) {
|
||||
if (!url || seen.has(url)) return;
|
||||
seen.add(url);
|
||||
out.push({ url, filename, role: role || filename });
|
||||
}
|
||||
|
||||
for (const url of deepCollectUrls(item)) {
|
||||
let role = basenameFromUrl(url);
|
||||
if (item.thumbnailPreviewSrc === url) role = 'thumbnail';
|
||||
else if (item.reducedMotionSrc === url) role = 'reduced_motion';
|
||||
else if (Array.isArray(item.effects)) {
|
||||
const effectIndex = item.effects.findIndex((effect) => effect?.src === url);
|
||||
if (effectIndex >= 0) role = `effect_${effectIndex}`;
|
||||
}
|
||||
push(url, basenameFromUrl(url), role);
|
||||
}
|
||||
|
||||
if (item.type === 0 && item.asset) {
|
||||
const base = `${CDN_BASE}/avatar-decoration-presets/${item.asset}.png`;
|
||||
push(`${base}?passthrough=true`, 'animated.png', 'animated');
|
||||
push(`${base}?passthrough=false`, 'static.png', 'static');
|
||||
}
|
||||
|
||||
if (item.type === 2 && item.asset) {
|
||||
const assetPath = String(item.asset).replace(/^\/+/, '');
|
||||
push(`${CDN_BASE}/assets/collectibles/${assetPath}static.png`, 'static.png', 'static');
|
||||
push(`${CDN_BASE}/assets/collectibles/${assetPath}asset.webm`, 'asset.webm', 'animated');
|
||||
}
|
||||
|
||||
return out;
|
||||
}
|
||||
|
||||
function decimalRgbToCss(color) {
|
||||
const value = Number(color) >>> 0;
|
||||
const r = (value >> 16) & 0xff;
|
||||
const g = (value >> 8) & 0xff;
|
||||
const b = value & 0xff;
|
||||
return `rgb(${r}, ${g}, ${b})`;
|
||||
}
|
||||
|
||||
function gradientFromColors(colors) {
|
||||
if (!Array.isArray(colors) || colors.length === 0) return undefined;
|
||||
if (colors.length === 1) return decimalRgbToCss(colors[0]);
|
||||
return `linear-gradient(135deg, ${decimalRgbToCss(colors[0])}, ${decimalRgbToCss(colors[1])})`;
|
||||
}
|
||||
|
||||
function previewAspectRatioForItem(item) {
|
||||
if (item.type === 0) return 1;
|
||||
if (item.type === 2) return 448 / 84;
|
||||
const firstEffect = item.effects?.[0];
|
||||
if (firstEffect?.width && firstEffect?.height) {
|
||||
return firstEffect.width / firstEffect.height;
|
||||
}
|
||||
return 450 / 880;
|
||||
}
|
||||
|
||||
function formatPaletteName(palette) {
|
||||
if (!palette) return undefined;
|
||||
return String(palette)
|
||||
.split('_')
|
||||
.map((part) => part.charAt(0).toUpperCase() + part.slice(1))
|
||||
.join(' ');
|
||||
}
|
||||
|
||||
const NAMEPLATE_PALETTE_GRADIENTS = {
|
||||
crimson: 'linear-gradient(135deg, #5c0a1c, #dc143c)',
|
||||
berry: 'linear-gradient(135deg, #4a1030, #c42d78)',
|
||||
sky: 'linear-gradient(135deg, #0a2a5c, #3b8eed)',
|
||||
teal: 'linear-gradient(135deg, #0a3d3d, #2dd4bf)',
|
||||
forest: 'linear-gradient(135deg, #0a2e1a, #22c55e)',
|
||||
bubble_gum: 'linear-gradient(135deg, #4a1038, #f472b6)',
|
||||
violet: 'linear-gradient(135deg, #2d1050, #8b5cf6)',
|
||||
cobalt: 'linear-gradient(135deg, #0a1448, #3b5bdb)',
|
||||
clover: 'linear-gradient(135deg, #0a3d20, #4ade80)',
|
||||
lemon: 'linear-gradient(135deg, #4a3d0a, #fbbf24)',
|
||||
white: 'linear-gradient(135deg, #888888, #f0f0f0)',
|
||||
black: 'linear-gradient(135deg, #1a1a1a, #404040)',
|
||||
};
|
||||
|
||||
function nameplatePaletteGradient(palette) {
|
||||
if (!palette) return undefined;
|
||||
return NAMEPLATE_PALETTE_GRADIENTS[palette];
|
||||
}
|
||||
|
||||
function thumbnailForItem(item) {
|
||||
if (item.thumbnailPreviewSrc && isCdnUrl(item.thumbnailPreviewSrc)) {
|
||||
return item.thumbnailPreviewSrc;
|
||||
}
|
||||
if (item.type === 0 && item.asset) {
|
||||
return `${CDN_BASE}/avatar-decoration-presets/${item.asset}.png?passthrough=false`;
|
||||
}
|
||||
if (item.type === 2 && item.asset) {
|
||||
const assetPath = String(item.asset).replace(/^\/+/, '');
|
||||
return `${CDN_BASE}/assets/collectibles/${assetPath}static.png`;
|
||||
}
|
||||
const assets = urlsForItem(item);
|
||||
return assets[0]?.url;
|
||||
}
|
||||
|
||||
function* walkProduct(product, category) {
|
||||
yield { product, category };
|
||||
for (const bundled of product.bundled_products ?? []) {
|
||||
yield* walkProduct(bundled, category);
|
||||
}
|
||||
for (const variant of product.variants ?? []) {
|
||||
yield* walkProduct(variant, category);
|
||||
}
|
||||
}
|
||||
|
||||
function* walkProducts(categories) {
|
||||
for (const category of categories ?? []) {
|
||||
for (const product of category.products ?? []) {
|
||||
yield* walkProduct(product, category);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function extractCollectibleItems(categories) {
|
||||
const items = [];
|
||||
const seenItems = new Set();
|
||||
|
||||
for (const { product, category } of walkProducts(categories)) {
|
||||
const categoryName = category?.name || 'Unknown';
|
||||
for (const item of product.items ?? []) {
|
||||
if (![0, 1, 2].includes(item.type)) continue;
|
||||
|
||||
const skuId = String(item.sku_id ?? item.id ?? product.sku_id ?? 'unknown');
|
||||
const itemKey = `${item.type}:${skuId}:${item.id ?? ''}`;
|
||||
if (seenItems.has(itemKey)) continue;
|
||||
seenItems.add(itemKey);
|
||||
|
||||
const assets = urlsForItem(item);
|
||||
if (assets.length === 0) continue;
|
||||
|
||||
const productName = product.name || item.title || item.label || skuId;
|
||||
const typeKey = ITEM_TYPE_KEY[item.type];
|
||||
|
||||
const entry = {
|
||||
id: `${typeKey}:${skuId}`,
|
||||
skuId,
|
||||
name: productName,
|
||||
type: typeKey,
|
||||
category: categoryName,
|
||||
label: item.label ?? item.title ?? productName,
|
||||
thumbnailUrl: thumbnailForItem(item),
|
||||
previewAspectRatio: previewAspectRatioForItem(item),
|
||||
previewColors: product.styles?.background_colors,
|
||||
palette: item.type === 2 ? item.palette : undefined,
|
||||
paletteLabel: item.type === 2 ? formatPaletteName(item.palette) : undefined,
|
||||
previewGradient: item.type === 2 ? nameplatePaletteGradient(item.palette) : undefined,
|
||||
assets: assets.map((a) => ({
|
||||
role: a.role,
|
||||
url: a.url,
|
||||
filename: a.filename,
|
||||
mimeType: guessMimeType(a.filename),
|
||||
})),
|
||||
};
|
||||
|
||||
if (item.type === 1) {
|
||||
entry.effect = {
|
||||
animationType: item.animationType,
|
||||
thumbnailPreviewSrc: item.thumbnailPreviewSrc,
|
||||
reducedMotionSrc: item.reducedMotionSrc,
|
||||
effects: item.effects,
|
||||
};
|
||||
}
|
||||
|
||||
items.push(entry);
|
||||
}
|
||||
}
|
||||
|
||||
return items;
|
||||
}
|
||||
|
||||
function isPublishedCatalog(document) {
|
||||
return (
|
||||
document &&
|
||||
document.schema_version === 1 &&
|
||||
typeof document.type === 'string' &&
|
||||
Array.isArray(document.items) &&
|
||||
document.items.every(
|
||||
(item) =>
|
||||
item &&
|
||||
typeof item.id === 'string' &&
|
||||
typeof item.skuId === 'string' &&
|
||||
typeof item.type === 'string' &&
|
||||
Array.isArray(item.assets)
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
async function fetchPublishedCatalog() {
|
||||
const documents = await Promise.all(
|
||||
PUBLISHED_CATALOG_URLS.map(async (url) => {
|
||||
const response = await fetch(url, { headers: { Accept: 'application/json' } });
|
||||
if (!response.ok) {
|
||||
throw new Error(`Published collectibles catalog request failed with HTTP ${response.status}.`);
|
||||
}
|
||||
const document = await response.json();
|
||||
if (!isPublishedCatalog(document)) {
|
||||
throw new Error('Published collectibles catalog has an unsupported schema.');
|
||||
}
|
||||
return document;
|
||||
})
|
||||
);
|
||||
|
||||
const items = documents.flatMap((document) => document.items);
|
||||
if (items.length === 0) {
|
||||
throw new Error('Published collectibles catalog is empty.');
|
||||
}
|
||||
return items;
|
||||
}
|
||||
|
||||
async function downloadAsset(url, { retries = 4 } = {}) {
|
||||
for (let attempt = 0; ; attempt++) {
|
||||
let res;
|
||||
try {
|
||||
res = await fetch(url, {
|
||||
headers: { 'User-Agent': DEFAULT_USER_AGENT, Accept: '*/*' },
|
||||
});
|
||||
} catch (err) {
|
||||
if (attempt >= retries) throw err;
|
||||
await sleep(500 * 2 ** attempt);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (res.status === 429) {
|
||||
const retryAfter = Number(res.headers.get('retry-after')) || 1;
|
||||
await sleep((retryAfter + 0.5) * 1000);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (!res.ok) {
|
||||
if (attempt >= retries) {
|
||||
throw new Error(`Failed to download asset: ${res.status} ${res.statusText}`);
|
||||
}
|
||||
await sleep(500 * 2 ** attempt);
|
||||
continue;
|
||||
}
|
||||
|
||||
const buf = Buffer.from(await res.arrayBuffer());
|
||||
return buf;
|
||||
}
|
||||
}
|
||||
|
||||
function createDiscordCollectiblesService(store) {
|
||||
let catalogCache = store.get('discordCollectiblesCatalog') || null;
|
||||
if (
|
||||
!catalogCache ||
|
||||
!Array.isArray(catalogCache.items) ||
|
||||
typeof catalogCache.fetchedAt !== 'string'
|
||||
) {
|
||||
catalogCache = null;
|
||||
}
|
||||
let catalogCacheAt = catalogCache?.fetchedAt ? Date.parse(catalogCache.fetchedAt) : 0;
|
||||
const CATALOG_TTL_MS = 6 * 60 * 60 * 1000;
|
||||
store.delete('discordCollectiblesToken');
|
||||
|
||||
async function getCatalog({ force = false } = {}) {
|
||||
const now = Date.now();
|
||||
if (!force && catalogCache && now - catalogCacheAt < CATALOG_TTL_MS) {
|
||||
return { success: true, data: catalogCache };
|
||||
}
|
||||
|
||||
try {
|
||||
const items = await fetchPublishedCatalog();
|
||||
catalogCache = { items, fetchedAt: new Date().toISOString() };
|
||||
catalogCacheAt = now;
|
||||
store.set('discordCollectiblesCatalog', catalogCache);
|
||||
return { success: true, data: catalogCache };
|
||||
} catch (err) {
|
||||
if (catalogCache) {
|
||||
return {
|
||||
success: true,
|
||||
data: { ...catalogCache, stale: true },
|
||||
};
|
||||
}
|
||||
return { success: false, error: err instanceof Error ? err.message : String(err) };
|
||||
}
|
||||
}
|
||||
|
||||
async function downloadAssets(assetUrls) {
|
||||
const results = [];
|
||||
for (const asset of assetUrls) {
|
||||
const buffer = await downloadAsset(asset.url);
|
||||
results.push({
|
||||
role: asset.role,
|
||||
url: asset.url,
|
||||
filename: asset.filename,
|
||||
mimeType: asset.mimeType || guessMimeType(asset.filename),
|
||||
data: buffer,
|
||||
});
|
||||
}
|
||||
return results;
|
||||
}
|
||||
|
||||
return {
|
||||
getCatalog,
|
||||
downloadAssets,
|
||||
ITEM_TYPE_FOLDER,
|
||||
};
|
||||
}
|
||||
|
||||
module.exports = { createDiscordCollectiblesService, extractCollectibleItems, urlsForItem };
|
||||
+1146
-351
File diff suppressed because it is too large
Load Diff
+41
-2
@@ -18,7 +18,8 @@ const commandMap = {
|
||||
'check_for_updates': 'check-for-updates',
|
||||
'download_update': 'download-update',
|
||||
'install_update': 'install-update',
|
||||
'get_desktop_sources': 'get-desktop-sources'
|
||||
'get_desktop_sources': 'get-desktop-sources',
|
||||
'get_protocol_status': 'protocol:get-status'
|
||||
};
|
||||
|
||||
// Shared invoke function for legacy API compatibility
|
||||
@@ -103,6 +104,12 @@ contextBridge.exposeInMainWorld('electron', {
|
||||
readImage: () => ipcRenderer.invoke('read-clipboard-image'),
|
||||
writeText: (text) => ipcRenderer.invoke('write-clipboard-text', text)
|
||||
},
|
||||
|
||||
// Media save (native Save dialog for images / videos / files)
|
||||
media: {
|
||||
saveFile: ({ filename, mimeType, data }) =>
|
||||
ipcRenderer.invoke('media:save-file', { filename, mimeType, data }),
|
||||
},
|
||||
// Audio
|
||||
audio: {
|
||||
playNotificationSound: (soundType = 'message') => ipcRenderer.invoke('play-notification-sound', soundType),
|
||||
@@ -117,6 +124,11 @@ contextBridge.exposeInMainWorld('electron', {
|
||||
youtube: {
|
||||
getStream: (url) => ipcRenderer.invoke('get-youtube-stream', url)
|
||||
},
|
||||
|
||||
// TikTok oEmbed (fetched in the main process)
|
||||
tiktok: {
|
||||
getOEmbed: (url) => ipcRenderer.invoke('tiktok:oembed', url)
|
||||
},
|
||||
|
||||
// Background sync (stubs for desktop)
|
||||
sync: {
|
||||
@@ -129,6 +141,7 @@ contextBridge.exposeInMainWorld('electron', {
|
||||
updater: {
|
||||
checkForUpdates: () => ipcRenderer.invoke('check-for-updates'),
|
||||
downloadAndInstallUpdate: () => ipcRenderer.invoke('download-and-install-update'),
|
||||
isMock: () => ipcRenderer.invoke('updater-is-mock'),
|
||||
onUpdateAvailable: (callback) => {
|
||||
ipcRenderer.on('update-available', (_, info) => callback(info));
|
||||
},
|
||||
@@ -138,6 +151,9 @@ contextBridge.exposeInMainWorld('electron', {
|
||||
onUpdateDownloaded: (callback) => {
|
||||
ipcRenderer.on('update-downloaded', (_, info) => callback(info));
|
||||
},
|
||||
onUpdateNotAvailable: (callback) => {
|
||||
ipcRenderer.on('update-not-available', (_, info) => callback(info));
|
||||
},
|
||||
downloadUpdate: () => ipcRenderer.invoke('download-update'),
|
||||
installUpdate: () => ipcRenderer.invoke('install-update'),
|
||||
},
|
||||
@@ -169,6 +185,17 @@ contextBridge.exposeInMainWorld('electron', {
|
||||
}
|
||||
},
|
||||
|
||||
// Debug packet recorder
|
||||
debug: {
|
||||
openWindow: () => ipcRenderer.invoke('debug:open-window'),
|
||||
send: (packet) => ipcRenderer.send('debug:packet', packet),
|
||||
onPacket: (callback) => {
|
||||
const handler = (_, data) => callback(data);
|
||||
ipcRenderer.on('debug:packet', handler);
|
||||
return () => ipcRenderer.removeListener('debug:packet', handler);
|
||||
}
|
||||
},
|
||||
|
||||
// Plugin management
|
||||
plugins: {
|
||||
getPath: () => ipcRenderer.invoke('plugin:get-path'),
|
||||
@@ -176,7 +203,19 @@ contextBridge.exposeInMainWorld('electron', {
|
||||
list: () => ipcRenderer.invoke('plugin:list'),
|
||||
uninstall: (pluginId) => ipcRenderer.invoke('plugin:uninstall', pluginId),
|
||||
readPluginCode: (pluginId) => ipcRenderer.invoke('plugin:read-code', pluginId)
|
||||
}
|
||||
},
|
||||
|
||||
// Desktop protocol diagnostics
|
||||
protocol: {
|
||||
getStatus: () => ipcRenderer.invoke('protocol:get-status'),
|
||||
repair: () => ipcRenderer.invoke('protocol:repair')
|
||||
},
|
||||
|
||||
// Discord shop collectibles (published catalog + on-demand CDN download)
|
||||
discordCollectibles: {
|
||||
fetchCatalog: (force = false) => ipcRenderer.invoke('discord-collectibles:fetch-catalog', { force }),
|
||||
downloadAssets: (assets) => ipcRenderer.invoke('discord-collectibles:download-assets', { assets }),
|
||||
},
|
||||
});
|
||||
|
||||
// Preload script ready
|
||||
|
||||
@@ -208,6 +208,81 @@
|
||||
{
|
||||
"name": "Messaging",
|
||||
"item": [
|
||||
{
|
||||
"name": "Get Group Messages",
|
||||
"request": {
|
||||
"method": "GET",
|
||||
"header": [],
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/messages/groups?limit=10",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"messages",
|
||||
"groups"
|
||||
],
|
||||
"query": [
|
||||
{
|
||||
"key": "limit",
|
||||
"value": "10",
|
||||
"description": "Number of recent messages (1-100, default 10)"
|
||||
}
|
||||
]
|
||||
},
|
||||
"description": "Get the most recent messages across joined group channels (non-DMs)."
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "Get DM Messages",
|
||||
"request": {
|
||||
"method": "GET",
|
||||
"header": [],
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/messages/dms?limit=10",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"messages",
|
||||
"dms"
|
||||
],
|
||||
"query": [
|
||||
{
|
||||
"key": "limit",
|
||||
"value": "10",
|
||||
"description": "Number of recent messages (1-100, default 10)"
|
||||
}
|
||||
]
|
||||
},
|
||||
"description": "Get the most recent messages across joined direct messages."
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "Get Combined Messages",
|
||||
"request": {
|
||||
"method": "GET",
|
||||
"header": [],
|
||||
"url": {
|
||||
"raw": "{{baseUrl}}/messages/combined?limit=10",
|
||||
"host": [
|
||||
"{{baseUrl}}"
|
||||
],
|
||||
"path": [
|
||||
"messages",
|
||||
"combined"
|
||||
],
|
||||
"query": [
|
||||
{
|
||||
"key": "limit",
|
||||
"value": "10",
|
||||
"description": "Number of recent messages (1-100, default 10)"
|
||||
}
|
||||
]
|
||||
},
|
||||
"description": "Get the most recent messages across groups and DMs together."
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "Send Message to Room",
|
||||
"request": {
|
||||
|
||||
Generated
+2483
-2500
File diff suppressed because it is too large
Load Diff
+31
-17
@@ -1,20 +1,29 @@
|
||||
{
|
||||
"name": "paarrot",
|
||||
"version": "4.11.74",
|
||||
"version": "4.11.223",
|
||||
"description": "Paarrot - A Matrix client based on Cinny",
|
||||
"homepage": "http://synbox.ruv.wtf:8418/litruv/cinny-desktop",
|
||||
"homepage": "https://github.com/Paarrot/Paarrot-Desktop",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/Paarrot/Paarrot-Desktop.git"
|
||||
},
|
||||
"main": "electron/main.js",
|
||||
"engines": {
|
||||
"node": ">=18.0.0"
|
||||
},
|
||||
"scripts": {
|
||||
"dev": "concurrently \"npm run dev:vite\" \"npm run dev:electron\"",
|
||||
"dev:vite": "cd cinny && npm start",
|
||||
"dev:vite": "cross-env BROWSER=none sh -c 'cd cinny && npm start'",
|
||||
"dev:electron": "wait-on http://localhost:38347 && cross-env NODE_ENV=development electron .",
|
||||
"build": "node -e \"require('fs').copyFileSync('config.json', 'cinny/config.json')\" && cd cinny && npm run build && cd .. && electron-builder --publish always",
|
||||
"build": "node scripts/generate-update-manifest.mjs && node -e \"require('fs').copyFileSync('config.json', 'cinny/config.json')\" && cd cinny && npm run build && cd .. && electron-builder --publish always",
|
||||
"build:local": "node scripts/generate-update-manifest.mjs && node -e \"require('fs').copyFileSync('config.json', 'cinny/config.json')\" && cd cinny && npm run build && cd .. && electron-builder",
|
||||
"build:linux": "npm run build -- --linux",
|
||||
"build:win": "npm run build -- --win",
|
||||
"postman:generate": "node scripts/generate-postman-collection.js"
|
||||
"postman:generate": "node scripts/generate-postman-collection.js",
|
||||
"generate:update-manifest": "node scripts/generate-update-manifest.mjs",
|
||||
"test": "npm run test:unit && npm run test:e2e",
|
||||
"test:unit": "vitest run",
|
||||
"test:e2e": "playwright test"
|
||||
},
|
||||
"keywords": [],
|
||||
"author": {
|
||||
@@ -23,25 +32,30 @@
|
||||
},
|
||||
"license": "AGPL-3.0-only",
|
||||
"dependencies": {
|
||||
"adm-zip": "^0.5.16",
|
||||
"body-parser": "2.2.2",
|
||||
"adm-zip": "^0.5.18",
|
||||
"body-parser": "2.3.0",
|
||||
"cors": "2.8.6",
|
||||
"electron-squirrel-startup": "^1.0.1",
|
||||
"electron-store": "^8.2.0",
|
||||
"electron-updater": "^6.3.9",
|
||||
"electron-store": "^11.0.2",
|
||||
"electron-updater": "^6.8.9",
|
||||
"express": "5.2.1",
|
||||
"open": "11.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@actions/github": "6.0.0",
|
||||
"@electron/rebuild": "4.0.3",
|
||||
"concurrently": "9.2.1",
|
||||
"@actions/github": "9.1.1",
|
||||
"@electron/rebuild": "4.2.0",
|
||||
"@playwright/test": "1.64.1",
|
||||
"concurrently": "10.0.3",
|
||||
"cross-env": "10.1.0",
|
||||
"electron": "40.6.0",
|
||||
"electron-builder": "26.8.1",
|
||||
"electron": "43.1.0",
|
||||
"electron-builder": "26.15.3",
|
||||
"node-fetch": "3.3.2",
|
||||
"png2icons": "2.0.1",
|
||||
"sharp": "0.34.5",
|
||||
"wait-on": "9.0.4"
|
||||
"sharp": "0.35.3",
|
||||
"vitest": "5.1.0",
|
||||
"wait-on": "9.0.10"
|
||||
},
|
||||
"allowScripts": {
|
||||
"electron-winstaller@5.4.0": true,
|
||||
"electron@43.1.0": true
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
import { defineConfig } from '@playwright/test';
|
||||
|
||||
export default defineConfig({
|
||||
testDir: './tests/e2e',
|
||||
// Electron launch plus first paint is far slower than a page load.
|
||||
timeout: 120_000,
|
||||
expect: { timeout: 30_000 },
|
||||
// One Electron process at a time: the app takes a single-instance lock and
|
||||
// every test shares the same vite dev server.
|
||||
workers: 1,
|
||||
// The suite logs in to a live homeserver, where Synapse login rate limiting is a real flake.
|
||||
retries: process.env.CI ? 1 : 0,
|
||||
// An explicit reporter replaces the default, so list stays for the CI log.
|
||||
reporter: [['list'], ['html']],
|
||||
// A trace captures the login POST body, which contains the password. Pin it off rather than
|
||||
// relying on the version default.
|
||||
trace: 'off',
|
||||
// cinny/vite.config.js binds 0.0.0.0 with fs.allow: ['..'], which is exposed on a shared
|
||||
// CI runner, so pin the dev server to loopback. The flag has to reach vite itself:
|
||||
// `npm run dev:vite -- --host` lands on sh's positional params, not on vite.
|
||||
// localhost is also the URL electron/main.js loads, so the page keeps that origin.
|
||||
webServer: {
|
||||
command: 'sh -c "cd cinny && npm start -- --host localhost"',
|
||||
url: 'http://localhost:38347',
|
||||
},
|
||||
});
|
||||
@@ -164,6 +164,87 @@ const collection = {
|
||||
{
|
||||
name: 'Messaging',
|
||||
item: [
|
||||
{
|
||||
name: 'Get Group Messages',
|
||||
request: {
|
||||
method: 'GET',
|
||||
header: [],
|
||||
url: {
|
||||
raw: '{{baseUrl}}/messages/groups?limit=10',
|
||||
host: ['{{baseUrl}}'],
|
||||
path: ['messages', 'groups'],
|
||||
query: [{ key: 'limit', value: '10', description: 'Number of recent messages (1-100, default 10)' }],
|
||||
},
|
||||
description: 'Get the most recent messages across joined group channels (non-DMs).',
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'Get DM Messages',
|
||||
request: {
|
||||
method: 'GET',
|
||||
header: [],
|
||||
url: {
|
||||
raw: '{{baseUrl}}/messages/dms?limit=10',
|
||||
host: ['{{baseUrl}}'],
|
||||
path: ['messages', 'dms'],
|
||||
query: [{ key: 'limit', value: '10', description: 'Number of recent messages (1-100, default 10)' }],
|
||||
},
|
||||
description: 'Get the most recent messages across joined direct messages.',
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'Get Combined Messages',
|
||||
request: {
|
||||
method: 'GET',
|
||||
header: [],
|
||||
url: {
|
||||
raw: '{{baseUrl}}/messages/combined?limit=10',
|
||||
host: ['{{baseUrl}}'],
|
||||
path: ['messages', 'combined'],
|
||||
query: [{ key: 'limit', value: '10', description: 'Number of recent messages (1-100, default 10)' }],
|
||||
},
|
||||
description: 'Get the most recent messages across groups and DMs together.',
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'Get Group Unreads',
|
||||
request: {
|
||||
method: 'GET',
|
||||
header: [],
|
||||
url: {
|
||||
raw: '{{baseUrl}}/unreads/groups',
|
||||
host: ['{{baseUrl}}'],
|
||||
path: ['unreads', 'groups'],
|
||||
},
|
||||
description: 'List unread group conversations (non-DMs), including counts and latest message preview.',
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'Get DM Unreads',
|
||||
request: {
|
||||
method: 'GET',
|
||||
header: [],
|
||||
url: {
|
||||
raw: '{{baseUrl}}/unreads/dms',
|
||||
host: ['{{baseUrl}}'],
|
||||
path: ['unreads', 'dms'],
|
||||
},
|
||||
description: 'List unread DM conversations, including counts and latest message preview.',
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'Get Combined Unreads',
|
||||
request: {
|
||||
method: 'GET',
|
||||
header: [],
|
||||
url: {
|
||||
raw: '{{baseUrl}}/unreads/combined',
|
||||
host: ['{{baseUrl}}'],
|
||||
path: ['unreads', 'combined'],
|
||||
},
|
||||
description: 'List unread conversations across groups and DMs.',
|
||||
},
|
||||
},
|
||||
{
|
||||
name: 'Send Message to Room',
|
||||
request: {
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
#!/usr/bin/env node
|
||||
/**
|
||||
* Desktop repo wrapper — manifest generator lives in cinny/scripts/.
|
||||
*/
|
||||
import { spawnSync } from 'child_process';
|
||||
import path from 'path';
|
||||
import { fileURLToPath } from 'url';
|
||||
|
||||
const script = path.join(
|
||||
path.dirname(fileURLToPath(import.meta.url)),
|
||||
'..',
|
||||
'cinny',
|
||||
'scripts',
|
||||
'generate-update-manifest.mjs'
|
||||
);
|
||||
|
||||
const result = spawnSync(process.execPath, [script], { stdio: 'inherit' });
|
||||
process.exit(result.status ?? 1);
|
||||
@@ -0,0 +1,104 @@
|
||||
import fs from 'node:fs';
|
||||
import path from 'node:path';
|
||||
import { fileURLToPath } from 'node:url';
|
||||
|
||||
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
||||
const srcRoot = path.resolve(__dirname, '../cinny/src');
|
||||
const iconsModule = path.resolve(srcRoot, 'app/components/icons');
|
||||
|
||||
const ICON_SYMBOLS = new Set(['Icon', 'Icons', 'IconName', 'IconSrc']);
|
||||
|
||||
function walk(dir, files = []) {
|
||||
for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
|
||||
const fullPath = path.join(dir, entry.name);
|
||||
if (entry.isDirectory()) {
|
||||
walk(fullPath, files);
|
||||
} else if (/\.(tsx?)$/.test(entry.name)) {
|
||||
files.push(fullPath);
|
||||
}
|
||||
}
|
||||
return files;
|
||||
}
|
||||
|
||||
function getIconsImportPath(filePath) {
|
||||
const rel = path.relative(path.dirname(filePath), iconsModule).replace(/\\/g, '/');
|
||||
return rel.startsWith('.') ? rel : `./${rel}`;
|
||||
}
|
||||
|
||||
function splitFoldsImport(importClause) {
|
||||
const match = importClause.match(/^\{([^}]+)\}(?:\s+as\s+\w+)?$/);
|
||||
if (!match) return null;
|
||||
|
||||
const specifiers = match[1]
|
||||
.split(',')
|
||||
.map((part) => part.trim())
|
||||
.filter(Boolean)
|
||||
.map((part) => {
|
||||
const [local, imported] = part.split(/\s+as\s+/).map((s) => s.trim());
|
||||
return { local: local ?? imported, imported: imported ?? local };
|
||||
});
|
||||
|
||||
const iconSpecs = specifiers.filter((s) => ICON_SYMBOLS.has(s.imported));
|
||||
const foldsSpecs = specifiers.filter((s) => !ICON_SYMBOLS.has(s.imported));
|
||||
|
||||
if (iconSpecs.length === 0) return null;
|
||||
|
||||
return { iconSpecs, foldsSpecs };
|
||||
}
|
||||
|
||||
function migrateFile(filePath) {
|
||||
let content = fs.readFileSync(filePath, 'utf8');
|
||||
const importRegex = /import\s+(\{[^}]+\})\s+from\s+['"]folds['"];?/g;
|
||||
let changed = false;
|
||||
const iconImports = new Map();
|
||||
|
||||
content = content.replace(importRegex, (fullMatch, importClause) => {
|
||||
const split = splitFoldsImport(importClause);
|
||||
if (!split) return fullMatch;
|
||||
|
||||
changed = true;
|
||||
for (const spec of split.iconSpecs) {
|
||||
iconImports.set(spec.local, spec.imported);
|
||||
}
|
||||
|
||||
if (split.foldsSpecs.length === 0) {
|
||||
return '';
|
||||
}
|
||||
|
||||
const foldsImport = split.foldsSpecs.map((s) => (s.local === s.imported ? s.local : `${s.imported} as ${s.local}`)).join(', ');
|
||||
return `import { ${foldsImport} } from 'folds';`;
|
||||
});
|
||||
|
||||
if (!changed) return false;
|
||||
|
||||
const iconsPath = getIconsImportPath(filePath);
|
||||
const iconExportList = [...iconImports.entries()]
|
||||
.map(([local, imported]) => (local === imported ? imported : `${imported} as ${local}`))
|
||||
.join(', ');
|
||||
|
||||
const iconsImportLine = `import { ${iconExportList} } from '${iconsPath}';`;
|
||||
|
||||
const foldsImportMatch = content.match(/^import\s+\{[^}]+\}\s+from\s+['"]folds['"];?\s*$/m);
|
||||
if (foldsImportMatch) {
|
||||
const insertAt = content.indexOf(foldsImportMatch[0]) + foldsImportMatch[0].length;
|
||||
content = `${content.slice(0, insertAt)}\n${iconsImportLine}${content.slice(insertAt)}`;
|
||||
} else {
|
||||
content = `${iconsImportLine}\n${content}`;
|
||||
}
|
||||
|
||||
content = content.replace(/\n{3,}/g, '\n\n');
|
||||
fs.writeFileSync(filePath, content);
|
||||
return true;
|
||||
}
|
||||
|
||||
const files = walk(srcRoot);
|
||||
let migrated = 0;
|
||||
|
||||
for (const file of files) {
|
||||
if (file.includes(`${path.sep}components${path.sep}icons${path.sep}`)) continue;
|
||||
if (migrateFile(file)) {
|
||||
migrated += 1;
|
||||
}
|
||||
}
|
||||
|
||||
console.log(`Migrated ${migrated} files.`);
|
||||
@@ -18,6 +18,17 @@
|
||||
"updater:allow-download",
|
||||
"updater:allow-download-and-install",
|
||||
"dialog:default",
|
||||
"fs:default",
|
||||
"fs:allow-write-file",
|
||||
{
|
||||
"identifier": "fs:scope",
|
||||
"allow": [
|
||||
{ "path": "$HOME/**" },
|
||||
{ "path": "$DOWNLOAD/**" },
|
||||
{ "path": "$DESKTOP/**" },
|
||||
{ "path": "$DOCUMENT/**" }
|
||||
]
|
||||
},
|
||||
"process:allow-restart",
|
||||
{
|
||||
"identifier": "http:default",
|
||||
|
||||
+10
@@ -60,6 +60,16 @@ async function runTests() {
|
||||
|
||||
// Get current room
|
||||
await testEndpoint('Get Current Room', 'GET', '/room/current');
|
||||
|
||||
// Recent messages by scope
|
||||
await testEndpoint('Get Group Messages', 'GET', '/messages/groups');
|
||||
await testEndpoint('Get DM Messages', 'GET', '/messages/dms');
|
||||
await testEndpoint('Get Combined Messages', 'GET', '/messages/combined?limit=10');
|
||||
|
||||
// Unread conversations by scope
|
||||
await testEndpoint('Get Group Unreads', 'GET', '/unreads/groups');
|
||||
await testEndpoint('Get DM Unreads', 'GET', '/unreads/dms');
|
||||
await testEndpoint('Get Combined Unreads', 'GET', '/unreads/combined');
|
||||
|
||||
// Toggle mute
|
||||
await testEndpoint('Toggle Mute', 'POST', '/mute/toggle');
|
||||
|
||||
@@ -0,0 +1,147 @@
|
||||
import { test, expect, _electron } from '@playwright/test';
|
||||
import fs from 'node:fs';
|
||||
import os from 'node:os';
|
||||
import path from 'node:path';
|
||||
|
||||
const HOMESERVER = process.env.E2E_HOMESERVER ?? 'ruv.wtf';
|
||||
const USER = process.env.E2E_USER ?? 'giteaci';
|
||||
const PASSWORD = process.env.E2E_PASSWORD;
|
||||
|
||||
let app;
|
||||
let page;
|
||||
let logs = [];
|
||||
let profile;
|
||||
let crashed = false;
|
||||
|
||||
// ServerPicker gives its input no name or test id, so position is the only handle on it;
|
||||
// this breaks if the form ever gains a field before the ones below.
|
||||
const serverInput = () => page.locator('input').first();
|
||||
const usernameInput = () => page.locator('input[name="usernameInput"]');
|
||||
const passwordInput = () => page.locator('input[name="passwordInput"]');
|
||||
const submitButton = () => page.locator('button[type="submit"]');
|
||||
|
||||
async function expectLoginForm() {
|
||||
await expect(serverInput()).toBeVisible();
|
||||
await expect(usernameInput()).toBeVisible();
|
||||
await expect(passwordInput()).toBeVisible();
|
||||
await expect(submitButton()).toBeVisible();
|
||||
}
|
||||
|
||||
async function chooseServer(server) {
|
||||
await serverInput().fill(server);
|
||||
// The server field commits on Enter, which re-runs discovery and reloads the auth flows.
|
||||
await serverInput().press('Enter');
|
||||
// fill() does not prove the value stuck; a cancelled debounce would keep matrix.org.
|
||||
await expect(serverInput()).toHaveValue(server);
|
||||
await expectLoginForm();
|
||||
}
|
||||
|
||||
async function submitLogin(username, password) {
|
||||
await usernameInput().fill(username);
|
||||
await passwordInput().fill(password);
|
||||
await submitButton().click();
|
||||
}
|
||||
|
||||
test.beforeEach(async () => {
|
||||
logs = [];
|
||||
crashed = false;
|
||||
|
||||
if (!PASSWORD) {
|
||||
throw new Error('E2E_PASSWORD is not set. Export it, or add it as the CI secret.');
|
||||
}
|
||||
|
||||
// Fresh profile per run. electron/main.js takes a single-instance lock keyed to
|
||||
// the user data dir, so a shared profile collides with a running Paarrot.
|
||||
profile = fs.mkdtempSync(path.join(os.tmpdir(), 'paarrot-e2e-'));
|
||||
app = await _electron.launch({ args: ['.', `--user-data-dir=${profile}`] });
|
||||
|
||||
app.on('console', (msg) => logs.push(`[main] ${msg.type()}: ${msg.text()}`));
|
||||
|
||||
page = await app.firstWindow();
|
||||
// main.js opens DevTools in dev mode, and that window can be the first one registered.
|
||||
while (page.url().startsWith('devtools://')) {
|
||||
// Recorded so a hang here names which windows existed instead of reporting a bare timeout.
|
||||
logs.push(`[window] ${page.url()}`);
|
||||
page = app.windows().find((w) => !w.url().startsWith('devtools://'))
|
||||
?? await new Promise((resolve) => app.once('window', resolve));
|
||||
}
|
||||
page.on('console', (msg) => logs.push(`[renderer] ${msg.type()}: ${msg.text()}`));
|
||||
page.on('pageerror', (err) => logs.push(`[renderer] pageerror: ${err}`));
|
||||
// crash is render-process-gone, so it does not fire on the MatrixError or the ServiceWorker error.
|
||||
page.on('crash', () => {
|
||||
crashed = true;
|
||||
logs.push('[renderer] page crashed');
|
||||
});
|
||||
|
||||
await chooseServer(HOMESERVER);
|
||||
});
|
||||
|
||||
// Config-based screenshots do not fire for a page taken from app.firstWindow(), and console
|
||||
// capture is not covered by config at all, so this hook stays manual.
|
||||
test.afterEach(async ({}, testInfo) => {
|
||||
if (testInfo.status !== testInfo.expectedStatus) {
|
||||
// Console first: a failed launch has no app and no page, so this is the only artifact that
|
||||
// path can produce, and it is empty by construction because no handler is attached before
|
||||
// launch — the failure message in the report is the diagnosis there. A crashed page produces
|
||||
// no screenshot; the crash line in the console names it.
|
||||
await testInfo.attach('console.log', { body: logs.join('\n'), contentType: 'text/plain' });
|
||||
if (page && !page.isClosed()) {
|
||||
// screenshot() throws on a crashed page, which would mask the original failure.
|
||||
const shot = await page.screenshot().catch(() => null);
|
||||
if (shot) await testInfo.attach('failure.png', { body: shot, contentType: 'image/png' });
|
||||
}
|
||||
}
|
||||
|
||||
if (app) {
|
||||
await app
|
||||
.close()
|
||||
// main.js preventDefault()s window close to minimise to tray, so close can hang.
|
||||
.catch(() => app.process().kill('SIGTERM'));
|
||||
}
|
||||
|
||||
// Reachable on launch failure, so the temp profile does not leak.
|
||||
if (profile) fs.rmSync(profile, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
async function expectAuthenticated() {
|
||||
// Login complete reloads into the client shell, which lands on the last active path
|
||||
// (state/lastActivePath.ts) or the inbox, so assert a shell route rather than any URL.
|
||||
await expect(page).toHaveURL(/#\/(inbox|home|room|space)/);
|
||||
|
||||
await expect
|
||||
.poll(() => page.evaluate(() => JSON.parse(localStorage.getItem('currentSessionUserId') ?? 'null')))
|
||||
.toBe(`@${USER}:${HOMESERVER}`);
|
||||
|
||||
// A truthy accessToken only proves a string exists, so prove it authenticates. Only the
|
||||
// status is asserted, so a failure cannot put a live token into the CI log or the report.
|
||||
await expect
|
||||
.poll(async () => {
|
||||
const token = await page.evaluate(() => JSON.parse(localStorage.getItem('matrixSessions') ?? '[]')[0]?.accessToken);
|
||||
if (!token) return 0;
|
||||
// /versions and /account 404 on ruv.wtf; /capabilities exists and requires a valid token.
|
||||
const res = await fetch(`https://${HOMESERVER}/_matrix/client/v3/capabilities`, { headers: { Authorization: `Bearer ${token}` } });
|
||||
return res.status;
|
||||
})
|
||||
.toBe(200);
|
||||
}
|
||||
|
||||
test('test account can log in and reaches the authenticated app', async () => {
|
||||
await submitLogin(USER, PASSWORD);
|
||||
await expectAuthenticated();
|
||||
});
|
||||
|
||||
test('failed login reports an error and keeps the renderer alive', async () => {
|
||||
await submitLogin(USER, 'not-the-password');
|
||||
|
||||
// A rate-limited run renders LoginError.RateLimited instead of the wrong-password message,
|
||||
// so accept both branches rather than asserting one exact string.
|
||||
await expect(page.getByText(/Invalid Username or Password\.|rate-limited by server/)).toBeVisible();
|
||||
|
||||
// Asserted before the form check: on a crashed page the locator throws TargetClosedError,
|
||||
// which names the wrong thing. Pageerrors go into the artifact but are not asserted — the
|
||||
// failed login itself produces MatrixError, and dev mode produces a ServiceWorker registration
|
||||
// error. No second login here: every run costs Synapse rc_login budget, and the re-login was
|
||||
// the main flake source.
|
||||
await expect(crashed).toBe(false);
|
||||
await expect(usernameInput()).toBeVisible();
|
||||
});
|
||||
@@ -0,0 +1,33 @@
|
||||
import { afterAll, beforeAll, expect, test } from 'vitest';
|
||||
|
||||
import PaarrotAPIServer from '../../electron/api-server.js';
|
||||
|
||||
const api = new PaarrotAPIServer(null);
|
||||
let base;
|
||||
|
||||
beforeAll(async () => {
|
||||
// Port 0 lets the OS pick a free port, so the test never collides with a running Paarrot.
|
||||
await api.start(0);
|
||||
base = `http://127.0.0.1:${api.server.address().port}`;
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await api.stop();
|
||||
});
|
||||
|
||||
test('GET /health reports the API server is up', async () => {
|
||||
const res = await fetch(`${base}/health`);
|
||||
|
||||
expect(res.status).toBe(200);
|
||||
expect(await res.json()).toEqual({ status: 'ok', app: 'Paarrot API', version: '1.0.0' });
|
||||
});
|
||||
|
||||
test('unknown endpoint answers 404 with the endpoint list', async () => {
|
||||
const res = await fetch(`${base}/not-an-endpoint`);
|
||||
|
||||
expect(res.status).toBe(404);
|
||||
|
||||
const body = await res.json();
|
||||
expect(body.error).toBe('Endpoint not found');
|
||||
expect(body.availableEndpoints).toContain('GET /health');
|
||||
});
|
||||
@@ -0,0 +1,8 @@
|
||||
import { defineConfig } from 'vitest/config';
|
||||
|
||||
export default defineConfig({
|
||||
test: {
|
||||
// The default pattern would also pick up the Electron spec in tests/e2e.
|
||||
include: ['tests/unit/**/*.test.js'],
|
||||
},
|
||||
});
|
||||
Reference in New Issue
Block a user