release 5.7.0

don't throw NotModifiedException on etag/lm changes

.dockerignore

@@ -1,6 +1 @@
-# ignore everything
+commafeed-client
-*
-
-# allow only what we need
-!commafeed-server/target/commafeed.jar
-!commafeed-server/config.yml.example

.gitattributes

@@ -0,0 +1,3 @@
+*       text eol=lf
+*.cmd   text eol=crlf
+*.png   binary

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+github: [ athou ]
+custom: [
+  'https://github.com/sponsors/Athou',
+  'https://www.paypal.com/donate/?business=9CNQHMJG2ZJVY&no_recurring=0&item_name=CommaFeed&currency_code=EUR'
+]

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ""
+labels: ""
+assignees: ""
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+
+- commafeed.com or self-hosted:
+- If self-hosted, CommaFeed version [e.g. 5.1.0 (a3dcb2c)]:
+- Browser [e.g. chrome, firefox]:
+- Device [e.g. desktop, mobile]:
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/stale.yml

@@ -1,18 +1,19 @@
-# Number of days of inactivity before an issue becomes stale
+# Number of days of inactivity before an issue becomes stale
-daysUntilStale: 60
+daysUntilStale: 60
-# Number of days of inactivity before a stale issue is closed
+# Number of days of inactivity before a stale issue is closed
-daysUntilClose: 7
+daysUntilClose: 7
-# Issues with these labels will never be considered stale
+# Issues with these labels will never be considered stale
-exemptLabels:
+exemptLabels:
-  - pinned
+  - pinned
-  - security
+  - security
-  - enhancement
+  - enhancement
-# Label to use when marking an issue as stale
+  - bug
-staleLabel: wontfix
+# Label to use when marking an issue as stale
-# Comment to post when marking an issue as stale. Set to `false` to disable
+staleLabel: wontfix
-markComment: >
+# Comment to post when marking an issue as stale. Set to `false` to disable
-  This issue has been automatically marked as stale because it has not had
+markComment: >
-  recent activity. It will be closed if no further activity occurs. Thank you
+  This issue has been automatically marked as stale because it has not had
-  for your contributions.
+  recent activity. It will be closed if no further activity occurs. Thank you
-# Comment to post when closing a stale issue. Set to `false` to disable
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
 closeComment: false

.github/workflows/build.yml

@@ -1,89 +0,0 @@
-name: Java CI
-
-on: [ push ]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        java: [ "8", "11", "17" ]
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-
-      # Setup
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-
-      - name: Set up Java
-        uses: actions/setup-java@v3
-        with:
-          java-version: ${{ matrix.java }}
-          distribution: "temurin"
-          cache: "maven"
-
-      # Build
-      - name: Build with Maven
-        run: mvn --batch-mode --update-snapshots verify
-
-      - name: Upload JAR
-        uses: actions/upload-artifact@v3
-        if: ${{ matrix.java == '8' }}
-        with:
-          name: commafeed.jar
-          path: commafeed-server/target/commafeed.jar
-
-      # Docker
-      - name: Login to Container Registry
-        uses: docker/login-action@v2
-        if: ${{ matrix.java == '8' }}
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-
-      - name: Docker build and push tag
-        uses: docker/build-push-action@v4
-        if: ${{ matrix.java == '8' && github.ref_type == 'tag' }}
-        with:
-          context: .
-          push: true
-          platforms: linux/amd64,linux/arm/v7
-          tags: |
-            athou/commafeed:latest
-            athou/commafeed:${{ github.ref_name }}
-
-      - name: Docker build and push master
-        uses: docker/build-push-action@v4
-        if: ${{ matrix.java == '8' && github.ref_name == 'master' }}
-        with:
-          context: .
-          push: true
-          platforms: linux/amd64,linux/arm/v7
-          tags: athou/commafeed:master
-
-      # Create GitHub release after Docker image has been published
-      - name: Extract Changelog Entry
-        uses: mindsers/changelog-reader-action@v2
-        if: ${{ matrix.java == '8' && github.ref_type == 'tag' }}
-        id: changelog_reader
-        with:
-          version: ${{ github.ref_name }}
-
-      - name: Create GitHub release
-        uses: softprops/action-gh-release@v1
-        if: ${{ matrix.java == '8' && github.ref_type == 'tag' }}
-        with:
-          name: CommaFeed ${{ github.ref_name }}
-          body: ${{ steps.changelog_reader.outputs.changes }}
-          draft: false
-          prerelease: false
-          files: |
-            commafeed-server/target/commafeed.jar
-            commafeed-server/config.yml.example

.github/workflows/ci.yml

@@ -0,0 +1,269 @@
+name: ci
+permissions:
+  contents: read
+
+on:
+  push:
+  pull_request:
+
+env:
+  JAVA_VERSION: 21
+  DOCKER_BUILD_SUMMARY: false
+
+jobs:
+  build:
+    if: github.event_name != 'pull_request' || github.actor != 'renovate[bot]' # renovate already triggers the build on pushes
+
+    strategy:
+      matrix:
+        os: [ "ubuntu-latest", "ubuntu-22.04-arm", "windows-latest" ]
+        database: [ "h2", "postgresql", "mysql", "mariadb" ]
+
+    runs-on: ${{ matrix.os }}
+    steps:
+      # Checkout
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          fetch-depth: 0
+
+      # Setup
+      - name: Set up GraalVM
+        uses: graalvm/setup-graalvm@01ed653ac833fe80569f1ef9f25585ba2811baab # v1
+        with:
+          java-version: ${{ env.JAVA_VERSION }}
+          distribution: "graalvm"
+          cache: "maven"
+
+      - name: Install Playwright dependencies
+        run: sudo apt-get install -y libgbm1
+        if: matrix.os != 'windows-latest'
+
+      # Build & Test
+      - name: Build with Maven
+        run: mvn --batch-mode --no-transfer-progress install -Pnative -P${{ matrix.database }} -DskipTests=${{ matrix.os == 'windows-latest' && matrix.database != 'h2' }}
+
+      # Build pages
+      - name: Copy generated markdown documentation to /documentation
+        run: mkdir documentation && cp ./commafeed-server/target/quarkus-generated-doc/config/commafeed-server.md ./documentation/README.md
+
+      - name: Generate pages
+        uses: wranders/markdown-to-pages-action@8d8a750832932ac785f5424c8c5543aa0b26bb9a # v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          out_path: target/pages
+          files: |-
+            README.md
+            documentation/README.md
+      
+      # Upload artifacts
+      - name: Upload cross-platform app
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+        if: matrix.os == 'ubuntu-latest' # we only need to upload the cross-platform artifact once per database
+        with:
+          name: commafeed-${{ matrix.database }}-jvm
+          path: commafeed-server/target/commafeed-*.zip
+
+      - name: Upload native executable
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+        with:
+          name: commafeed-${{ matrix.database }}-${{ runner.os }}-${{ runner.arch }}
+          path: commafeed-server/target/commafeed-*-runner*
+
+      - name: Upload pages
+        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
+        if: matrix.os == 'ubuntu-latest' && matrix.database == 'h2' # we only need to upload the pages once
+        with:
+          path: target/pages
+
+  docker:
+    runs-on: ubuntu-latest
+    needs: build
+    env:
+      DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
+
+    strategy:
+      matrix:
+        database: [ "h2", "postgresql", "mysql", "mariadb" ]
+
+    steps:
+      # Checkout
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          fetch-depth: 0
+
+      # Setup
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@29109295f81e9208d7d86ff1c6c12d2833863392 # v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@b5ca514318bd6ebac0fb2aedd5d36ec1b5c232a2 # v3
+
+      - name: Install required packages
+        run: sudo apt-get install -y rename unzip
+
+      # Prepare artifacts
+      - name: Download artifacts
+        uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4
+        with:
+          pattern: commafeed-${{ matrix.database }}-*
+          path: ./artifacts
+          merge-multiple: true
+
+      - name: Set the exec flag on the native executables
+        run: chmod +x artifacts/*-runner
+
+      - name: Rename native executables to match buildx TARGETARCH
+        run: |
+          rename 's/x86_64/amd64/g' artifacts/*
+          rename 's/aarch_64/arm64/g' artifacts/*
+
+      - name: Unzip jvm package
+        run: |
+          unzip artifacts/*-jvm.zip -d artifacts/extracted-jvm-package
+          rename 's/commafeed-.*/quarkus-app/g' artifacts/extracted-jvm-package/*
+
+      # Docker
+      - name: Login to Container Registry
+        uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772 # v3
+        if: ${{ env.DOCKERHUB_USERNAME != '' }}
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      ## build but don't push for PRs and renovate
+      - name: Docker build - native
+        uses: docker/build-push-action@471d1dc4e07e5cdedd4c2171150001c434f0b7a4 # v6
+        with:
+          context: .
+          file: commafeed-server/src/main/docker/Dockerfile.native
+          push: false
+          platforms: linux/amd64,linux/arm64/v8
+
+      - name: Docker build - jvm
+        uses: docker/build-push-action@471d1dc4e07e5cdedd4c2171150001c434f0b7a4 # v6
+        with:
+          context: .
+          file: commafeed-server/src/main/docker/Dockerfile.jvm
+          push: false
+          platforms: linux/amd64,linux/arm64/v8
+
+      ## build and push tag
+      - name: Docker build and push tag - native
+        uses: docker/build-push-action@471d1dc4e07e5cdedd4c2171150001c434f0b7a4 # v6
+        if: ${{ github.ref_type == 'tag' }}
+        with:
+          context: .
+          file: commafeed-server/src/main/docker/Dockerfile.native
+          push: ${{ env.DOCKERHUB_USERNAME != '' }}
+          platforms: linux/amd64,linux/arm64/v8
+          tags: |
+            athou/commafeed:latest-${{ matrix.database }}
+            athou/commafeed:${{ github.ref_name }}-${{ matrix.database }}
+
+      - name: Docker build and push tag - jvm
+        uses: docker/build-push-action@471d1dc4e07e5cdedd4c2171150001c434f0b7a4 # v6
+        if: ${{ github.ref_type == 'tag' }}
+        with:
+          context: .
+          file: commafeed-server/src/main/docker/Dockerfile.jvm
+          push: ${{ env.DOCKERHUB_USERNAME != '' }}
+          platforms: linux/amd64,linux/arm64/v8
+          tags: |
+            athou/commafeed:latest-${{ matrix.database }}-jvm
+            athou/commafeed:${{ github.ref_name }}-${{ matrix.database }}-jvm
+
+      ## build and push master
+      - name: Docker build and push master - native
+        uses: docker/build-push-action@471d1dc4e07e5cdedd4c2171150001c434f0b7a4 # v6
+        if: ${{ github.ref_name == 'master' }}
+        with:
+          context: .
+          file: commafeed-server/src/main/docker/Dockerfile.native
+          push: ${{ env.DOCKERHUB_USERNAME != '' }}
+          platforms: linux/amd64,linux/arm64/v8
+          tags: athou/commafeed:master-${{ matrix.database }}
+
+      - name: Docker build and push master - jvm
+        uses: docker/build-push-action@471d1dc4e07e5cdedd4c2171150001c434f0b7a4 # v6
+        if: ${{ github.ref_name == 'master' }}
+        with:
+          context: .
+          file: commafeed-server/src/main/docker/Dockerfile.jvm
+          push: ${{ env.DOCKERHUB_USERNAME != '' }}
+          platforms: linux/amd64,linux/arm64/v8
+          tags: athou/commafeed:master-${{ matrix.database }}-jvm
+
+  release:
+    runs-on: ubuntu-latest
+    needs:
+      - build
+      - docker
+    permissions:
+      contents: write
+    if: github.ref_type == 'tag'
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          fetch-depth: 0
+
+      - name: Download artifacts
+        uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4
+        with:
+          pattern: commafeed-*
+          path: ./artifacts
+          merge-multiple: true
+
+      - name: Set the exec flag on the native executables
+        run: chmod +x artifacts/*-runner
+
+      - name: Extract Changelog Entry
+        uses: mindsers/changelog-reader-action@32aa5b4c155d76c94e4ec883a223c947b2f02656 # v2
+        id: changelog_reader
+        with:
+          version: ${{ github.ref_name }}
+
+      - name: Create GitHub release
+        uses: ncipollo/release-action@440c8c1cb0ed28b9f43e4d1d670870f059653174 # v1
+        with:
+          name: CommaFeed ${{ github.ref_name }}
+          body: ${{ steps.changelog_reader.outputs.changes }}
+          artifacts: ./artifacts/*
+
+
+  update-dockerhub-description:
+    runs-on: ubuntu-latest
+    needs: release
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          fetch-depth: 0
+
+      - name: Update Docker Hub Description
+        uses: peter-evans/dockerhub-description@432a30c9e07499fd01da9f8a49f0faf9e0ca5b77 # v4
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+          repository: athou/commafeed
+          short-description: ${{ github.event.repository.description }}
+          readme-filepath: commafeed-server/src/main/docker/README.md
+
+
+  deploy-pages:
+    runs-on: ubuntu-latest
+    needs: release
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4
+        id: deployment

.gitignore

@@ -35,5 +35,8 @@ src/main/app/lib
 # Sublime
 *.sublime*
 
+# VSCode
+.vscode
+
 # Macs
 *.DS_Store

.mvn/wrapper/maven-wrapper.properties

@@ -1,18 +1,18 @@
-# Licensed to the Apache Software Foundation (ASF) under one
+# Licensed to the Apache Software Foundation (ASF) under one
-# or more contributor license agreements.  See the NOTICE file
+# or more contributor license agreements.  See the NOTICE file
-# distributed with this work for additional information
+# distributed with this work for additional information
-# regarding copyright ownership.  The ASF licenses this file
+# regarding copyright ownership.  The ASF licenses this file
-# to you under the Apache License, Version 2.0 (the
+# to you under the Apache License, Version 2.0 (the
-# "License"); you may not use this file except in compliance
+# "License"); you may not use this file except in compliance
-# with the License.  You may obtain a copy of the License at
+# with the License.  You may obtain a copy of the License at
-#
+#
-#   https://www.apache.org/licenses/LICENSE-2.0
+#   http://www.apache.org/licenses/LICENSE-2.0
-#
+#
-# Unless required by applicable law or agreed to in writing,
+# Unless required by applicable law or agreed to in writing,
-# software distributed under the License is distributed on an
+# software distributed under the License is distributed on an
-# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-# KIND, either express or implied.  See the License for the
+# KIND, either express or implied.  See the License for the
-# specific language governing permissions and limitations
+# specific language governing permissions and limitations
-# under the License.
+# under the License.
-distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.3/apache-maven-3.8.3-bin.zip
+distributionType=only-script
-wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip

CHANGELOG.md

@@ -1,134 +1,476 @@
-# Changelog
+# Changelog
-
+
-## [3.2.0]
+## [5.7.0]
-
+
-- restore the welcome page
+- Add Shift+J/Shift+K keyboard shortcuts to navigate to the next/previous feed or category with unread entries (#1746)
-- only apply hover effect for unread entries (same as commafeed v2)
+- Add the referrer "no-referrer" meta to index.html (#1724)
-- move notifications at the bottom of the screen
+- Load custom JS code when the app is done loading (#1724)
-- always use https for sharing urls
+- Correctly handle feeds that return an unmodified Last-Modified header but a different ETag header (#1730)
-- add support for redis ACLs
+- Restore gzip compression of responses that was accidentaly disabled since 5.0.0
-- transition to google analytics v4
+- Fix tooltips not showing up in mobile view
-
+- Fix the bookmarklet generator on the About page
-## [3.1.0]
+
-
+## [5.6.1]
-- add an even more compact layout
+
-- restore hover effect from commafeed 2.x
+- Restore support for iframes in feed entries (#1688)
-- view mode (compact, expanded, ...) is now stored on the device so you can have a different view mode on desktop and
+- There is now a package available for Arch Linux thanks to @dcelasun (#1691)
-  mobile
+
-- fix for the "Illegal attempt to associate a collection with two open sessions." error
+## [5.6.0]
-- feed fetching workflow is now orchestrated with rxjava, removing a lot of code
+
-
+- To better respect the bandwidth of feed owners, the default value of `commafeed.feed-refresh.interval-empirical` is now true. This means feeds no longer refresh exactly every 5 minutes (the default value of `commafeed.feed-refresh.interval`) but between 5 minutes and 4 hours (the default value of the new `commafeed.feed-refresh.max-interval` setting). The interval is calculated based on feed activity, so highly active feeds refresh more often (#1677)
-## [3.0.1]
+- Many previously hardcoded values used in feed refresh interval calculation are now exposed as settings (#1677)
-
+- Access to local addresses is now blocked to mitigate server-side request forgery (SSRF) attacks, which could potentially expose internal resources. You might want to disable the new `commafeed.http-client.block-local-addresses` setting if you subscribe to feeds only available on your local network and you trust all your users
-- allow env variable substitution in config.yml
+- If a feed responds with a "429 - Too many requests" response, a backoff mechanism is triggered when the response does not contain a "Retry-After" header
-    - e.g. having a custom config.yml file with `app.session.path=${SOME_ENV_VAR}` will substitute `SOME_ENV_VAR` with
+
-      its value
+## [5.5.0]
-- allow env variable prefixed with `CF_` to override config.yml properties
+
-    - e.g. setting `CF_APP_ALLOWREGISTRATIONS=true` will set `app.allowRegistrations` to `true`
+- CommaFeed now honors the Retry-After response header and will not try to refresh a feed sooner than the value of this header
-
+- Audio enclosures (e.g. podcasts) now fill available entry width
-## [3.0.0]
+- Fix an issue with some labels not correctly internationalized
-
+
-- complete overhaul of the UI
+## [5.4.0]
-- backend and frontend are now in separate maven modules
+
-- no changes to the api or the database
+- An arm64 native executable is now available for download on the releases page
-- Docker images are now automatically built and available at https://hub.docker.com/r/athou/commafeed
+- The native executable Docker image now supports arm64
-
+- Fixed an issue with feeds that declared an invalid DOCTYPE (#1260)
-## [2.6.0]
+
-
+## [5.3.6]
-- add support for media content as a backup for missing content (useful for youtube feeds)
+
-- correctly follow http error code 308 redirects
+- Ignore invalid Cache-Control header values (#1619)
-- fixed a bug that prevented users from deleting their account
+
-- fixed a bug that made commafeed store entry contents multiple times
+## [5.3.5]
-- fixed a bug that prevented the app to be used as an installed app on mobile devices if the context path of commafeed
+
-  was not "/"
+- Fixed an issue with the aspect ratio of images of some feeds (#1595)
-- fixed a bug that prevented entries from being "marked as read older than xxx" for a feed that was just added
+- CommaFeed now honors the Cache-Control response header and will not try to refresh a feed sooner than its max-age property (#1615)
-- removed support for google+ and readability as those services no longer exist
+- Added support for compilation with JDK 23+. If you're building CommaFeed from sources with a JDK 17 or 21, you may need to update it to the most recent patch version to support `-proc:full` (#1618)
-- removed support for deploying on openshift
+
-- removed alphabetical sorting of entries because of really poor performance (title cannot be indexed)
+## [5.3.4]
-- improve performance for instances with the heavy load setting enabled by preventing CommaFeed from fetching feeds from
+
-  users that did not log in for a long time
+- Added support for Internationalized Domain Names (#1588)
-- various dependencies upgrades (notably dropwizard from 1.3 to 2.1)
+
-- add support for mariadb
+## [5.3.3]
-- add support for java17+ runtime
+
-- various security improvements
+- Removed image bottom margins (#1587)
-
+
-## [2.5.0]
+## [5.3.2]
-
+
-- unread count is now displayed in a favicon badge when supported
+- Fixed an issue that could cause some images from not being rendered correctly (#1587)
-- the user agent string for the bot fetching feeds is now configurable
+
-- feed parsing performance improvements
+## [5.3.1]
-- support for java9+ runtime
+
-- can now properly start from an empty postgresql database
+- Fixed an issue that could cause some HTTP feeds to return a 400 error (#1572)
-
+
-## [2.4.0]
+## [5.3.0]
-
+
-- users were not able to change password or delete account
+- Added a setting to set a cooldown on the "fetch all my feeds" action, disabled by default (#1556)
-- fix api key generation
+- Fixed an issue that could cause entries to not correctly load when using the "next" header button (#1557)
-- feed entries can now be sorted alphabetically
+
-- fix facebook sharing
+## [5.2.0]
-- fix layout on iOS
+
-- postgresql driver update (fix for postgres 9.6)
+- Added an option to keep a number of entries above the selected entry when scrolling
-- various internationalization fixes
+- Added a cache to the HTTP client to reduce the number of requests made to feeds when subscribing (#1431)
-- security fixes
+- Feeds are no longer refreshed between the moment its last user unsubscribes and the moment the feed is cleaned up (every hour)
-
+- Fixed an issue that could cause entries to not correctly load when using keyboard navigation (#1557)
-## [2.3.0]
+
-
+## [5.1.1]
-- dropwizard upgrade 0.9.1
+
-- feed enclosures are hidden if they already displayed in the content
+- Fixed database migration issue when upgrading from 5.0.0 to 5.1.0 on MariaDB (#1544)
-- fix youtube favicons
+- When feeds without unread entries are hidden from the tree, the feed is displayed in the tree until another one is selected (#1543)
-- various internationalization fixes
+
-
+## [5.1.0]
-## [2.2.0]
+
-
+- Added a setting for showing/hiding unread count in the browser's tab title/favicon (#1518)
-- fix youtube and instagram favicon fetching
+- Fixed an issue that could prevent the app from starting on some systems (#1532)
-- mark as read filter was lost when a feed was rearranged with drag&drop
+- Added a cache busting filter for the webapp index.html and openapi documentation to make sure they are always up to date
-- feed entry categories are now displayed if available
+- Reduced database cleanup log verbosity
-- various performance and dependencies upgrades
+
-- java8 is now required
+## [5.0.2]
-
+
-## [2.1.0]
+- Fix favicon fetching for Youtube channels in native mode when Google auth key is set
-
+- Fix an error that appears in the logs when fetching some favicons
-- dropwizard upgrade to 0.8.0
+
-- you have to remove the "app.contextPath" setting from your yml file, you can optionally use
+## [5.0.1]
-  server.applicationContextPath instead
+
-- new setting app.maxFeedCapacity for deleting old entries
+- Configure native compilation to support older CPU architectures (#1524)
-- ability to set filtering expressions for subscriptions to automatically mark new entries as read based on title,
+
-  content, author or url.
+## [5.0.0]
-- ability to use !keyword or -keyword to exclude a keyword from a search query
+
-- facebook feeds now show user favicon instead of facebook favicon
+CommaFeed is now powered by Quarkus instead of Dropwizard. Read the rationale behind this change in
-- new dark theme 'nightsky'
+the [announcement](https://github.com/Athou/commafeed/discussions/1517).
-
+The gist of it is that CommaFeed can now be compiled to a native binary, resulting in blazing fast startup times (around
-## [2.0.3]
+0.3s) and very low memory footprint (< 50M).
-
+
-- internet explorer ajax cache workaround
+- CommaFeed now has a different package for each supported database.
-- categories are now deletable again
+    - If you are deploying CommaFeed with a precompiled package, please
-- openshift support is back
+      read [this section of the README](https://github.com/Athou/commafeed/tree/master?tab=readme-ov-file#download-a-precompiled-package).
-- youtube feeds now show user favicon instead of youtube favicon
+    - If you are building CommaFeed from sources, please
-
+      read [this section of the README](https://github.com/Athou/commafeed/tree/master?tab=readme-ov-file#build-from-sources).
-## [2.0.2]
+    - If you are using the Docker image, please read the instructions on
-
+      the [Docker Hub page](https://hub.docker.com/r/athou/commafeed).
-- api using the api key is now working again
+- Due to the switch to Quarkus, the way CommaFeed is configured is very different (the `config.yml` file is gone).
-- context path is now configurable in config.yml (see app.contextPath in config.yml.example)
+  Please
-- fix login on firefox when fields are autofilled by the browser
+  read [this section of the README](https://github.com/Athou/commafeed/tree/master?tab=readme-ov-file#configuration).
-- fix scrolling of subscriptions list on mobile
+  Note that a lot of configuration elements have been removed or renamed and are now nested/grouped by feature.
-- user is now logged in after registration
+- Added a setting to prevent parsing large feeds to avoid out of memory errors. The default is 5MB.
-- fix link to documentation on home page and about page
+- Use a different icon for filtering unread entries and marking an entry as read (#1506)
-- fields autocomplete is disabled on the profile page
+- Added various HTML attributes to ease custom JS/CSS customization (#1507)
-- users are able to delete their account again
+- The Redis cache has been removed. There have been multiple enhancements to the feed refresh engine and it is no longer
-- chinese and malaysian translation files are now correctly loaded
+  needed, even for instances with a large number of feeds.
-- software version in user-agent when fetching feeds is no longer hardcoded
+- The H2 migration tool that automatically upgrades H2 databases from format 2 to 3 has been removed. If you're using
-- admin settings page is now read only, settings are configured in config.yml
+  the H2 embedded database, please upgrade to at least version 4.3.0 before upgrading to CommaFeed 5.0.0.
-- added link to metrics on the admin settings page
+
-- Rome (rss library) upgrade to 1.5.0
+## [4.6.0]
-
+
-## [2.0.1]
+- switched from Temurin to OpenJ9 as the JVM used in the Docker image, resulting in memory usage reduction by up to 50%
-
+- fix an issue that could cause old entries to reappear if they were updated by their author (#1486)
-- the redis pool no longer throws an exception when it is unable to aquire a new connection
+- show all entries regardless of their read status when searching with keywords, even if the ui is configured to show
-
+  unread entries only
-## [2.0.0]
+
-
+## [4.5.0]
-- The backend has been completely rewritten using Dropwizard instead of TomEE, resulting in a lot less memory
+
-  consumption and better overall performances.
+- significantly reduce the time needed to retrieve entries or mark them as read, especially when there are a lot of
-  See the README on how to build CommaFeed from now on.
+  entries (#1452)
-- CommaFeed should no longer fetch the same feed multiple times in a row
+- fix a race condition where a feed could be refreshed before it was created in the database
-- Users can use their username or email to log in  
+- fix an issue that could cause the websocket notification to contain the wrong number of unread entries when using
+  mysql/mariadb
+- fix an error when trying to mark all starred entries as read
+- remove the `onlyIds` parameter from REST endpoints since retrieving all the entries is now just as fast
+- remove support for microsoft sqlserver because it's not covered with integration tests (please open an issue if you'd
+  like it back)
+
+## [4.4.1]
+
+- fix vertical scrolling issues with Safari (#1168)
+- the default value for new users for the "star entry" button and the "open in new tab" button in the entry headers is
+  now "on desktop" instead of "always"
+- the "keyboard shortcuts" help page now shows "Cmd" instead of "Ctrl" on macOS (#1389)
+- remove a superfluous feed fetch when subscribing to a feed (#1431)
+- the Docker image now uses Java 21
+
+## [4.4.0]
+
+- add support for sharing using the browser native capabilities if available (#1255)
+- add a button in the entry headers to star an entry (#1025)
+- add a button in the entry headers to open links in a new tab (#1333)
+- add two options in the settings to toggle those buttons
+- accept .opml file extension when importing and export with the .opml extension
+- the "mark as read" option is no longer shown in the context menu for entries that are too old to be marked as read (
+  older than `keepStatusDays`) (#1303)
+
+## [4.3.3]
+
+- fix OPML import (#1279)
+
+## [4.3.2]
+
+- added support for unix sockets (#1278)
+
+## [4.3.1]
+
+- fix an issue that prevents new feeds from being added when mysql/mariadb is used as the database and the database
+  timezone is not UTC (#1239)
+- videos in enclosures can no longer have a width larger than the page (#1240)
+
+## [4.3.0]
+
+- h2 (the embedded database) has been upgraded to 2.2.224
+    - this version uses a different file format than 2.1.x, the first time you start CommaFeed with this version, the
+      database will be automatically converted to the new format
+- add a setting to completely disable scrolling to selected entry (#1157)
+- add a css class reflecting the current view mode to ease custom css rules (#1232)
+- fix an issue that prevents new feeds from being added when mysql/mariadb is used as the database (#1239)
+
+## [4.2.1]
+
+- fix an issue that caused the tree to show an incorrect unread count after a websocket notification because entries
+  that were already marked as read by a filtering expression were not ignored (#1191)
+
+## [4.2.0]
+
+- add a setting to display the action buttons in the footer instead of in the header on mobile (#1121)
+- the websocket notification now contains everything needed to update the UI, the client no longer needs to make an API
+  call to get the latest data when receiving the notification
+- add a workaround to the Fever API for the Unread iOS app (#1188)
+- fix an issue that caused dates to be saved incorrectly if the database server and the application server were in
+  different timezones (#1187)
+
+## [4.1.0]
+
+- it is now possible to open the sidebar on mobile by swiping to the right (#1098)
+- swiping to mark entries as read/unread changed from swiping right to left because swiping right now opens the sidebar
+- the full hierarchy of categories are now displayed in the category dropdown (#1045)
+- added a setting `maxEntriesAgeDays` to delete old entries based on their age during database cleanup.
+  The setting is disabled by default for existing installations, except for the docker image where it is enabled and set
+  to 365 days
+- if user registrations are disabled on your instance which is the default behavior, users are redirected on the login
+  page instead of the welcome page when not logged in (#1185)
+- the sidebar resizer is no longer shown in the middle of the screen on mobile
+- when using the system color scheme and the system is using a dark theme, feed entries no longer flicker on load
+- the demo account (if enabled) cannot register custom javascript code anymore
+- removed the usage of `toSorted` in the client because older browsers do not support it (#1183)
+- the openapi documentation is no longer cached by the browser so you always have access to the latest version
+- added a memory management section to the readme, reading it is recommended if you are running CommaFeed on a server
+  with limited memory
+- fixed an issue that caused users without an email address set to be unable to edit their profile (#1184)
+
+## [4.0.0]
+
+- migrated from dropwizard 2 to dropwizard 4, Java 17+ is now required
+- entries that were fetched and inserted in the database but not yet shown in the UI are no longer marked as read when
+  marking all entries as read
+- your custom sidebar width is now persisted in the local storage of your browser
+- there is now a third color scheme option in addition to light and dark: system (follows the system color scheme)
+- added support for youtube playlist favicons
+- custom JS code is now executed when the app is done loading instead of when the page is loaded
+- the favicon is now correctly returned for feeds that return an invalid content type
+- the feed refresh engine now uses httpclient5 with connection pooling and no longer creates a new client for each
+  request, reducing CPU usage
+- updated UI library Mantine to 7.0, improving performance
+- the h2 embedded database is now compacted on shutdown to reclaim unused space
+- the admin connector on port 8084 is now disabled in config.yml.example. Disabling it in your config.yml is
+  recommended (see https://github.com/Athou/commafeed/commit/929df60f09cce56020b0962ab111cd8349b271b0)
+- migrated documentation from swagger 2 to openapi 3
+- added a GET method to the fever api to indicate that the endpoint is working correctly when accessed from a browser
+- the websocket connection can now be disabled, the websocket ping interval and the tree reload interval can now be
+  configured (see config.yml.example)
+- the websocket connection now works correctly when the context root of the application is not "/"
+- unstable pubsubhubbub support was removed
+
+## [3.10.1]
+
+- swap next and previous buttons (#1159)
+- unread count for subscriptions will now be shortened starting at 10k instead of 1k
+- increased websocket ping interval to just under a minute to reduce data and battery usage on mobile
+- only refresh subscription tree on a timer if websocket connection is unavailable
+- the Docker image now uses less memory by returning unused memory to the OS
+- add support for Java 21
+
+## [3.10.0]
+
+- added a Fever-compatible API that is usable with mobile clients that support the Fever API (see instructions in
+  Settings -> Profile)
+- long entry titles are no longer shortened in the detailed view
+- added the "s" keyboard shortcut to star/unstar entries
+- http sessions are now stored in the database (they were stored on disk before)
+- fixed an issue that made it impossible to override the database url in a config.yml mounted in the Docker image
+
+## [3.9.0]
+
+- improve performance by disabling the loader when nothing is loading (most noticeable on mobile)
+- added a setting to disable the 'mark all as read' confirmation
+- added a setting to disable the custom context menu
+- if the custom context is enabled, it can still be disabled by pressing the shift key
+- the announcement feature is now working again and supports html ('announcement' configuration element in config.yml)
+- add support for MariaDB 11+
+- fix entry header shortly rendered as mobile on desktop, causing a small visual glitch
+- fix an issue that could cause a feed to not refresh correctly if the url was very long
+- database cleanup batch size is now configurable
+- css parsing errors are no longer logged to the standard output
+- fix small errors in the api documentation
+
+## [3.8.1]
+
+- in expanded mode, don't scroll when clicking on the body of the current entry
+- improve content cleanup task performance for instances with a very large number of feeds
+
+## [3.8.0]
+
+- add previous and next buttons in the toolbar
+- add a setting to always scroll selected entry to the top of the page, even if it fits entirely on screen
+- clicking on the body of an entry in expanded mode selects it and marks it as read
+- add rich text editor with autocomplete for custom css and js code in settings (desktop only)
+- dramatically improve performance while scrolling
+- fix broken welcome page mobile layout
+- format dates in user locale instead of GMT in relative date popups
+
+## [3.7.0]
+
+- the sidebar is now resizable
+- added the "f" keyboard shortcut to hide the sidebar
+- added tooltips to relative dates with the exact date
+- add a setting to hide commafeed from search engines (exposes a robots.txt file, enabled by default)
+- the browser extension unread count now updates when articles are marked as read/unread in the app
+- The "b" keyboard shortcut now works as expected on Chrome but requires the browser extension to be installed
+- dark mode has been disabled on the api documentation page as it was unreadable
+- improvement to the feed refresh queuing logic when "heavy load" mode is enabled
+- fix a bug that could prevent feeds and categories from being edited
+
+## [3.6.0]
+
+- add a button to open CommaFeed in a new tab and a button to open options when using the browser extension
+- clicking on the entry title in expanded mode now opens the link instead of doing nothing
+- add tooltips to buttons when the mobile layout is used on desktop
+- redirect the user to the welcome page if the user was deleted from the database
+- add link to api documentation on welcome page
+- the unread count is now correctly updated when using the "/next" bookmarklet while redis cache is enabled
+
+## [3.5.0]
+
+- add compatibility with the new version of the CommaFeed browser extension
+- disable pull-to-refresh on mobile as it messes with vertical scrolling
+- add css classes to feed entries to help with custom css rules
+- api documentation page no longer requires users to be authenticated
+- add a setting to limit the number of feeds a user can subscribe to
+- add a setting to disable strict password policy
+- add feed refresh engine metrics
+- fix redis timeouts
+
+## [3.4.0]
+
+- add support for arm64 docker images
+- add divider to visually separate read-only information from form on the profile settings page
+- reduce javascript bundle size by 30% by loading only the necessary translations
+- add a standalone donate page with all ways to support CommaFeed
+- fix an issue introduced in 3.1.0 that could make CommaFeed not refresh feeds as fast as before on instances with lots
+  of feeds
+- fix alignment of icon with text for category tree nodes
+- fix alignment of burger button with the rest of the header on mobile
+
+## [3.3.2]
+
+- restore entry selection indicator (left orange border) that was lost with the mantine 6.x upgrade (3.3.0)
+- add dividers to visually separate read-only information from forms on feed and category details pages
+- reduced javascript bundle size by 10%
+
+## [3.3.1]
+
+- fix long feed names not being shortened to respect tree max width
+
+## [3.3.0]
+
+- there are now database changes, rolling back to 2.x will no longer be possible
+- restore support for user custom CSS rules
+- add support for user custom JS code that will be executed on page load
+
+## [3.2.0]
+
+- restore the welcome page
+- only apply hover effect for unread entries (same as commafeed v2)
+- move notifications at the bottom of the screen
+- always use https for sharing urls
+- add support for redis ACLs
+- transition to google analytics v4
+
+## [3.1.0]
+
+- add an even more compact layout
+- restore hover effect from commafeed 2.x
+- view mode (compact, expanded, ...) is now stored on the device so you can have a different view mode on desktop and
+  mobile
+- fix for the "Illegal attempt to associate a collection with two open sessions." error
+- feed fetching workflow is now orchestrated with rxjava, removing a lot of code
+
+## [3.0.1]
+
+- allow env variable substitution in config.yml
+- e.g. having a custom config.yml file with `app.session.path=${SOME_ENV_VAR}` will substitute `SOME_ENV_VAR` with its
+  value
+- allow env variable prefixed with `CF_` to override config.yml properties
+- e.g. setting `CF_APP_ALLOWREGISTRATIONS=true` will set `app.allowRegistrations` to `true`
+
+## [3.0.0]
+
+- complete overhaul of the UI
+- backend and frontend are now in separate maven modules
+- no changes to the api or the database
+- Docker images are now automatically built and available at https://hub.docker.com/r/athou/commafeed
+
+## [2.6.0]
+
+- add support for media content as a backup for missing content (useful for youtube feeds)
+- correctly follow http error code 308 redirects
+- fixed a bug that prevented users from deleting their account
+- fixed a bug that made commafeed store entry contents multiple times
+- fixed a bug that prevented the app to be used as an installed app on mobile devices if the context path of commafeed
+  was not "/"
+- fixed a bug that prevented entries from being "marked as read older than xxx" for a feed that was just added
+- removed support for google+ and readability as those services no longer exist
+- removed support for deploying on openshift
+- removed alphabetical sorting of entries because of really poor performance (title cannot be indexed)
+- improve performance for instances with the heavy load setting enabled by preventing CommaFeed from fetching feeds from
+  users that did not log in for a long time
+- various dependencies upgrades (notably dropwizard from 1.3 to 2.1)
+- add support for mariadb
+- add support for java17+ runtime
+- various security improvements
+
+## [2.5.0]
+
+- unread count is now displayed in a favicon badge when supported
+- the user agent string for the bot fetching feeds is now configurable
+- feed parsing performance improvements
+- support for java9+ runtime
+- can now properly start from an empty postgresql database
+
+## [2.4.0]
+
+- users were not able to change password or delete account
+- fix api key generation
+- feed entries can now be sorted alphabetically
+- fix facebook sharing
+- fix layout on iOS
+- postgresql driver update (fix for postgres 9.6)
+- various internationalization fixes
+- security fixes
+
+## [2.3.0]
+
+- dropwizard upgrade 0.9.1
+- feed enclosures are hidden if they already displayed in the content
+- fix youtube favicons
+- various internationalization fixes
+
+## [2.2.0]
+
+- fix youtube and instagram favicon fetching
+- mark as read filter was lost when a feed was rearranged with drag&drop
+- feed entry categories are now displayed if available
+- various performance and dependencies upgrades
+- java8 is now required
+
+## [2.1.0]
+
+- dropwizard upgrade to 0.8.0
+- you have to remove the "app.contextPath" setting from your yml file, you can optionally use
+  server.applicationContextPath instead
+- new setting app.maxFeedCapacity for deleting old entries
+- ability to set filtering expressions for subscriptions to automatically mark new entries as read based on title,
+  content, author or url.
+- ability to use !keyword or -keyword to exclude a keyword from a search query
+- facebook feeds now show user favicon instead of facebook favicon
+- new dark theme 'nightsky'
+
+## [2.0.3]
+
+- internet explorer ajax cache workaround
+- categories are now deletable again
+- openshift support is back
+- youtube feeds now show user favicon instead of youtube favicon
+
+## [2.0.2]
+
+- api using the api key is now working again
+- context path is now configurable in config.yml (see app.contextPath in config.yml.example)
+- fix login on firefox when fields are autofilled by the browser
+- fix scrolling of subscriptions list on mobile
+- user is now logged in after registration
+- fix link to documentation on home page and about page
+- fields autocomplete is disabled on the profile page
+- users are able to delete their account again
+- chinese and malaysian translation files are now correctly loaded
+- software version in user-agent when fetching feeds is no longer hardcoded
+- admin settings page is now read only, settings are configured in config.yml
+- added link to metrics on the admin settings page
+- Rome (rss library) upgrade to 1.5.0
+
+## [2.0.1]
+
+- the redis pool no longer throws an exception when it is unable to aquire a new connection
+
+## [2.0.0]
+
+- The backend has been completely rewritten using Dropwizard instead of TomEE, resulting in a lot less memory
+  consumption and better overall performances.
+  See the README on how to build CommaFeed from now on.
+- CommaFeed should no longer fetch the same feed multiple times in a row
+- Users can use their username or email to log in

Dockerfile

@@ -1,12 +0,0 @@
-FROM eclipse-temurin:17-jre
-
-EXPOSE 8082
-
-RUN mkdir -p /commafeed/data
-VOLUME /commafeed/data
-ENV CF_SESSION_PATH=/commafeed/data/sessions
-
-COPY commafeed-server/config.yml.example config.yml
-COPY commafeed-server/target/commafeed.jar .
-
-CMD ["java", "-Djava.net.preferIPv4Stack=true", "-jar", "commafeed.jar", "server", "config.yml"]

LICENSE

@@ -1,31 +1,31 @@
-Apache License, Version 2.0 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/
+Apache License, Version 2.0 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-1. Definitions.
+1. Definitions.
-"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
-"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
-"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
-"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
-"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
-"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
-"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
-"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
-"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
-"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
-2. Grant of Copyright License.
+2. Grant of Copyright License.
-Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
-3. Grant of Patent License.
+3. Grant of Patent License.
-Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
-4. Redistribution.
+4. Redistribution.
-You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
-You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
-5. Submission of Contributions.
+5. Submission of Contributions.
-Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
-6. Trademarks.
+6. Trademarks.
-This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
-7. Disclaimer of Warranty.
+7. Disclaimer of Warranty.
-Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
-8. Limitation of Liability.
+8. Limitation of Liability.
-In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
-9. Accepting Warranty or Additional Liability.
+9. Accepting Warranty or Additional Liability.
-While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
 END OF TERMS AND CONDITIONS

README.md

@@ -1,56 +1,155 @@
 # CommaFeed
 
-Google Reader inspired self-hosted RSS reader, based on Dropwizard and React/TypeScript.
+Google Reader inspired self-hosted RSS reader, based on Quarkus and React/TypeScript.
 
 ![preview](https://user-images.githubusercontent.com/1256795/184886828-1973f148-58a9-4c6d-9587-ee5e5d3cc2cb.png)
 
 ## Features
 
 - 4 different layouts
-- Dark theme
+- Light/Dark theme
-- Fully responsive
+- Fully responsive, works great on both mobile and desktop
 - Keyboard shortcuts for almost everything
 - Support for right-to-left feeds
 - Translated in 25+ languages
 - Supports thousands of users and millions of feeds
 - OPML import/export
 - REST API
+- Fever-compatible API for native mobile apps
+- Can automatically mark articles as read based on user-defined rules
+- [Browser extension](https://github.com/Athou/commafeed-browser-extension)
+- Compiles to native code for blazing fast startup and low memory usage
+- Supports 4 databases
+    - H2 (embedded database)
+    - PostgreSQL
+    - MySQL
+    - MariaDB
 
-## Related open-source projects
+## Deployment
-
-Browser extensions:
-
-- [Chrome](https://github.com/Athou/commafeed-chrome)
-- [Firefox](https://github.com/Athou/commafeed-firefox)
-- [Opera](https://github.com/Athou/commafeed-opera)
-- [Safari](https://github.com/Athou/commafeed-safari)
-
-## Deployment on your own server
 
 ### Docker
 
+Docker is the easiest way to get started with CommaFeed.
+
 Docker images are built automatically and are available at https://hub.docker.com/r/athou/commafeed
 
-### Download precompiled package
+### Cloud hosting
 
-    mkdir commafeed && cd commafeed
+[PikaPods](https://www.pikapods.com) offers 1-click cloud hosting solutions starting at $1/month with a free $5
-    wget https://github.com/Athou/commafeed/releases/latest/download/commafeed.jar
+welcome credit and officially supports CommaFeed.
-    wget https://github.com/Athou/commafeed/releases/latest/download/config.yml.example -O config.yml
+PikaPods shares 20% of the revenue back to CommaFeed.
-    java -Djava.net.preferIPv4Stack=true -jar commafeed.jar server config.yml
 
-The server will listen on http://localhost:8082. The default
+[![PikaPods](https://www.pikapods.com/static/run-button.svg)](https://www.pikapods.com/pods?run=commafeed)
-user is `admin` and the default password is `admin`.
+
+### Download a precompiled package
+
+Go to the [release page](https://github.com/Athou/commafeed/releases) and download the latest version for your operating
+system and database of choice.
+
+There are two types of packages:
+
+- The `linux-x86_64`, `linux-aarch_64` and `windows-x86_64` packages are compiled natively and contain an executable that can be run
+  directly.
+- The `jvm` package is a zip file containing all `.jar` files required to run the application. This package works on all
+  platforms but requires a JRE and is started with `java -jar quarkus-run.jar`.
+
+If available for your operating system, the native package is recommended because it has a faster startup time and lower
+memory usage.
 
 ### Build from sources
 
-    git clone https://github.com/Athou/commafeed.git
+    ./mvnw clean package [-P<database> [-Pnative]] [-DskipTests]
-    cd commafeed
-    ./mvnw clean package
-    cp commafeed-server/config.yml.example config.yml
-    java -Djava.net.preferIPv4Stack=true -jar commafeed-server/target/commafeed.jar server config.yml
 
-The server will listen on http://localhost:8082. The default
+- `<database>` can be one of `h2`, `postgresql`, `mysql` or `mariadb`. The default is `h2`.
-user is `admin` and the default password is `admin`.
+- `-Pnative` compiles the application to native code. This requires GraalVM to be installed (`GRAALVM_HOME` environment
+  variable pointing to a GraalVM installation).
+- `-DskipTests` to speed up the build process by skipping tests.
+
+When the build is complete:
+
+- a zip containing all jars required to run the application is located at
+  `commafeed-server/target/commafeed-<version>-<database>-jvm.zip`. Extract it and run the application with
+  `java -jar quarkus-run.jar`
+- if you used the native profile, the executable is located at
+  `commafeed-server/target/commafeed-<version>-<database>-<platform>-<arch>-runner[.exe]`
+
+### Distribution packages
+
+- Arch Linux users can use [the CommaFeed package on AUR](https://aur.archlinux.org/pkgbase/commafeed), which builds native binaries with GraalVM for all supported databases.
+
+## Configuration
+
+CommaFeed doesn't require any configuration to run with its embedded database (H2). The database file will be stored in
+the `data` directory of the current directory.
+
+To use a different database, you will need to configure the following properties:
+
+- `quarkus.datasource.jdbc.url`
+    - e.g. for H2: `jdbc:h2:./data/db;DEFRAG_ALWAYS=TRUE`
+    - e.g. for PostgreSQL: `jdbc:postgresql://localhost:5432/commafeed`
+    - e.g. for MySQL:
+      `jdbc:mysql://localhost/commafeed?autoReconnect=true&failOverReadOnly=false&maxReconnects=20&rewriteBatchedStatements=true&timezone=UTC`
+    - e.g. for MariaDB:
+      `jdbc:mariadb://localhost/commafeed?autoReconnect=true&failOverReadOnly=false&maxReconnects=20&rewriteBatchedStatements=true&timezone=UTC`
+- `quarkus.datasource.username`
+- `quarkus.datasource.password`
+
+There are multiple ways to configure CommaFeed:
+
+- a `config/application.properties` [properties](https://en.wikipedia.org/wiki/.properties) file relative to the working
+  directory (keys in kebab-case)
+- Command line arguments each prefixed with `-D` (keys in kebab-case)
+- Environment variables (keys in UPPER_CASE)
+- a `.env` file in the working directory (keys in UPPER_CASE)
+
+The properties file is recommended because CommaFeed will be able to warn about invalid properties and typos.
+
+All [CommaFeed settings](https://athou.github.io/commafeed/documentation) are optional and have sensible default values.
+
+When logging in, credentials are stored in an encrypted cookie. The encryption key is randomly generated at startup,
+meaning that you will have to log back in after each restart of the application. To prevent this, you can set the
+`quarkus.http.auth.session.encryption-key` property to a fixed value (min. 16 characters).
+All other Quarkus settings can be found [here](https://quarkus.io/guides/all-config).
+
+When started, the server will listen on http://localhost:8082.
+The default user is `admin` and the default password is `admin`.
+
+### Updates
+
+When CommaFeed is up and running, you can subscribe to [this feed](https://github.com/Athou/commafeed/releases.atom) to be notified of new releases.
+
+### Memory management
+
+The Java Virtual Machine (JVM) is rather greedy by default and will not release unused memory to the
+operating system. This is because acquiring memory from the operating system is a relatively expensive operation.
+This can be problematic on systems with limited memory.
+
+#### Hard limit (`native` and `jvm` packages)
+
+The JVM can be configured to use a maximum amount of memory with the `-Xmx` parameter.
+For example, to limit the JVM to 256MB of memory, use `-Xmx256m`.
+
+#### Dynamic sizing (`jvm` package)
+
+In addition to the previous setting, the JVM can be configured to release unused memory to the operating system with the
+following parameters:
+
+    -Xms20m -XX:+UseG1GC -XX:+UseStringDeduplication -XX:-ShrinkHeapInSteps -XX:G1PeriodicGCInterval=10000 -XX:-G1PeriodicGCInvokesConcurrent -XX:MinHeapFreeRatio=5 -XX:MaxHeapFreeRatio=10
+
+See [here](https://docs.oracle.com/en/java/javase/17/gctuning/garbage-first-g1-garbage-collector1.html)
+and [here](https://docs.oracle.com/en/java/javase/17/gctuning/factors-affecting-garbage-collection-performance.html) for
+more
+information.
+
+#### OpenJ9 (`jvm` package)
+
+The [OpenJ9](https://eclipse.dev/openj9/) JVM is a more memory-efficient alternative to the HotSpot JVM, at the cost of
+slightly slower throughput.
+
+IBM provides precompiled binaries for OpenJ9
+named [Semeru](https://developer.ibm.com/languages/java/semeru-runtimes/downloads/).
+This is the JVM used in
+the [Docker image](https://github.com/Athou/commafeed/blob/master/commafeed-server/src/main/docker/Dockerfile.jvm).
 
 ## Translation
 
@@ -59,11 +158,11 @@ located [here](https://github.com/Athou/commafeed/tree/master/commafeed-client/s
 
 To add a new language:
 
-- edit `commafeed-client/src/i18n.ts`
+- add the new locale to the `locales` array in:
-    - add the new locale to the `locales` array.
+    - `commafeed-client/.linguirc`
-    - import the dayjs locale
+    - `commafeed-client/src/i18n.ts`
-- edit `commafeed-client/.linguirc` and add the new locale to the `locales` array.
+- run `npm run i18n:extract`
-- run `npm run i18n` and add translations to the newly created `commafeed-client/src/locales/[locale]/messages.po` file
+- add translations to the newly created `commafeed-client/src/locales/[locale]/messages.po` file
 
 The name of the locale should be the
 two-letters [ISO-639-1 language code](http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
@@ -74,7 +173,7 @@ two-letters [ISO-639-1 language code](http://en.wikipedia.org/wiki/List_of_ISO_6
 
 - Open `commafeed-server` in your preferred Java IDE.
     - CommaFeed uses Lombok, you need the Lombok plugin for your IDE.
-- Start `CommaFeedApplication.java` in debug mode with `server config.dev.yml` as arguments
+- run `./mvnw quarkus:dev`
 
 ### Frontend
 
@@ -84,19 +183,3 @@ two-letters [ISO-639-1 language code](http://en.wikipedia.org/wiki/List_of_ISO_6
 
 The frontend server is now running at http://localhost:8082 and is proxying REST requests to the backend running on
 port 8083
-
-## Copyright and license
-
-Copyright 2013-2023 CommaFeed.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this work except in compliance with the License.
-You may obtain a copy of the License in the LICENSE file, or at:
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

commafeed-client/.eslintignore

@@ -1,6 +0,0 @@
-dist
-node_modules
-
-vite.config.ts
-
-src/locales/**/*.ts

commafeed-client/.eslintrc

@@ -1,85 +0,0 @@
-{
-    "extends": [
-        "eslint:recommended",
-        "plugin:@typescript-eslint/recommended",
-        "plugin:react/recommended",
-        "react-app",
-        "airbnb",
-        "airbnb-typescript",
-        "prettier"
-    ],
-    "plugins": ["@typescript-eslint", "prettier", "hooks"],
-    "parserOptions": {
-        "project": "./tsconfig.json"
-    },
-    "rules": {
-        // make eslint check prettier rules
-        "prettier/prettier": "error",
-
-        // enforce consistent curly braces usage
-        "curly": ["error", "multi-line", "consistent"],
-
-        // set "props" to false because it cases false positives with immer
-        "no-param-reassign": ["error", { "props": false }],
-
-        "prefer-destructuring": [
-            "error",
-            {
-                "array": false,
-                "object": true
-            },
-            {
-                "enforceForRenamedProperties": false
-            }
-        ],
-
-        // causes issues in thunks when we want to dispatch an action that is defined in the reducer
-        "@typescript-eslint/no-use-before-define": "off",
-
-        // make sure the key prop is filled when required
-        "react/jsx-key": ["error", { "checkFragmentShorthand": true }],
-
-        // configure additional hooks
-        "react-hooks/exhaustive-deps": [
-            "warn",
-            {
-                "additionalHooks": "(^useAsync$|useDidUpdate)"
-            }
-        ],
-
-        // trigger even if props is used only in createStyles()
-        "react/no-unused-prop-types": "off",
-
-        // no longer required with modern react versions
-        "react/react-in-jsx-scope": "off",
-
-        // not required with typescript
-        "react/prop-types": "off",
-        "react/require-default-props": "off",
-
-        // matter of taste
-        "react/destructuring-assignment": "off",
-        "react/jsx-props-no-spreading": "off",
-        "react/no-unescaped-entities": "off",
-        "import/prefer-default-export": "off",
-
-        // enforce hook call order
-        "hooks/sort": [
-            2,
-            {
-                "groups": [
-                    "useLocation",
-                    "useParams",
-                    "useState",
-                    "useAppSelector",
-                    "useAppDispatch",
-                    "useAsync",
-                    "useForm",
-                    "useAsyncCallback",
-                    "useCallback",
-                    "useEffect"
-                ]
-            }
-        ]
-    }
-}

commafeed-client/.gitignore

@@ -29,5 +29,6 @@ dist-ssr
 # vite
 vite.config.ts.timestamp-*.mjs
 
-# compiled locales
+# compiled linguijs locales
+# they no longer exist but we keep this to avoid issues with people still having those files on disk
 src/locales/**/*.ts

commafeed-client/.linguirc

@@ -1,57 +0,0 @@
-{
-    "locales": [
-        "ar",
-        "ca",
-        "cs",
-        "cy",
-        "da",
-        "de",
-        "en",
-        "es",
-        "fa",
-        "fi",
-        "fr",
-        "gl",
-        "hu",
-        "id",
-        "it",
-        "ja",
-        "ko",
-        "ms",
-        "nb",
-        "nl",
-        "nn",
-        "pl",
-        "pt",
-        "ru",
-        "sk",
-        "sv",
-        "tr",
-        "zh"
-    ],
-    "catalogs": [
-        {
-            "path": "src/locales/{locale}/messages",
-            "include": [
-                "src"
-            ],
-            "exclude": [
-                "src/locales/**"
-            ]
-        }
-    ],
-    "format": "po",
-    "formatOptions": {
-        "origins": true,
-        "lineNumbers": false
-    },
-    "sourceLocale": "en",
-    "fallbackLocales": {
-        "default": "en"
-    },
-    "extractBabelOptions": {
-        "presets": [
-            "@babel/preset-typescript"
-        ]
-    }
-}

commafeed-client/.prettierrc

@@ -1,7 +0,0 @@
-{
-    "printWidth": 140,
-    "semi": false,
-    "tabWidth": 4,
-    "arrowParens": "avoid",
-    "endOfLine": "auto"
-}

commafeed-client/biome.json

@@ -0,0 +1,19 @@
+{
+    "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
+    "formatter": {
+        "indentStyle": "space",
+        "indentWidth": 4,
+        "lineEnding": "lf",
+        "lineWidth": 140
+    },
+    "javascript": {
+        "formatter": {
+            "trailingCommas": "es5",
+            "semicolons": "asNeeded",
+            "arrowParentheses": "asNeeded"
+        }
+    },
+    "files": {
+        "ignore": ["dist", "node_modules", "target", "target-ide"]
+    }
+}

commafeed-client/index.html

@@ -1,14 +1,16 @@
 <!DOCTYPE html>
 <html lang="en">
-    <head>
+<head>
-        <meta charset="UTF-8" />
+    <meta charset="UTF-8" />
-        <link rel="icon" type="image/x-icon" href="favicon.ico" />
+    <link rel="icon" type="image/x-icon" href="favicon.ico" />
-        <link rel="manifest" href="manifest.json" />
+    <link rel="manifest" href="manifest.json" />
-        <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />
-        <title>CommaFeed</title>
+    <meta name="referrer" content="no-referrer" />
-    </head>
+
-    <body>
+    <title>CommaFeed</title>
-        <div id="root"></div>
+</head>
-        <script type="module" src="/src/main.tsx"></script>
+<body>
-    </body>
+<div id="root"></div>
+<script type="module" src="/src/main.tsx"></script>
+</body>
 </html>

commafeed-client/lingui.config.ts

@@ -0,0 +1,52 @@
+import type { LinguiConfig } from "@lingui/conf"
+
+const config: LinguiConfig = {
+    locales: [
+        "ar",
+        "ca",
+        "cs",
+        "cy",
+        "da",
+        "de",
+        "en",
+        "es",
+        "fa",
+        "fi",
+        "fr",
+        "gl",
+        "hu",
+        "id",
+        "it",
+        "ja",
+        "ko",
+        "ms",
+        "nb",
+        "nl",
+        "nn",
+        "pl",
+        "pt",
+        "ru",
+        "sk",
+        "sv",
+        "tr",
+        "zh",
+    ],
+    catalogs: [
+        {
+            path: "src/locales/{locale}/messages",
+            include: ["src"],
+            exclude: ["src/locales/**"],
+        },
+    ],
+    format: "po",
+    formatOptions: {
+        origins: true,
+        lineNumbers: false,
+    },
+    sourceLocale: "en",
+    fallbackLocales: {
+        default: "en",
+    },
+}
+
+export default config

commafeed-client/package.json

@@ -1,83 +1,84 @@
 {
-  "name": "commafeed-client",
+    "name": "commafeed-client",
-  "private": true,
+    "private": true,
-  "version": "0.0.0",
+    "version": "0.0.0",
-  "type": "module",
+    "type": "module",
-  "scripts": {
+    "scripts": {
-    "dev": "vite --host",
+        "dev": "vite",
-    "dev:typescript": "tsc --watch",
+        "dev:host": "vite --host",
-    "build": "npm run i18n:compile && tsc && vite build",
+        "build": "tsc && vite build",
-    "preview": "vite preview",
+        "preview": "vite preview",
-    "test": "vitest",
+        "test": "vitest",
-    "test:ci": "vitest run",
+        "test:ci": "vitest run",
-    "eslint": "eslint --ext=.js,.jsx,.ts,.tsx src",
+        "lint": "biome check",
-    "i18n": "npm run i18n:extract && npm run i18n:compile",
+        "lint:fix": "biome check --write",
-    "i18n:extract": "lingui extract --clean",
+        "i18n:extract": "lingui extract --clean"
-    "i18n:compile": "lingui compile --typescript",
+    },
-    "postinstall": "npm run i18n:compile"
+    "dependencies": {
-  },
+        "@emotion/react": "^11.14.0",
-  "dependencies": {
+        "@fontsource/open-sans": "^5.2.5",
-    "@emotion/react": "^11.10.5",
+        "@lingui/core": "^5.3.0",
-    "@fontsource/open-sans": "^4.5.14",
+        "@lingui/react": "^5.3.0",
-    "@lingui/core": "^3.17.0",
+        "@mantine/core": "^7.17.3",
-    "@lingui/macro": "^3.17.0",
+        "@mantine/form": "^7.17.3",
-    "@lingui/react": "^3.17.0",
+        "@mantine/hooks": "^7.17.3",
-    "@mantine/core": "^5.10.3",
+        "@mantine/modals": "^7.17.3",
-    "@mantine/form": "^5.10.3",
+        "@mantine/notifications": "^7.17.3",
-    "@mantine/hooks": "^5.10.3",
+        "@mantine/spotlight": "^7.17.3",
-    "@mantine/modals": "^5.10.3",
+        "@monaco-editor/react": "^4.7.0",
-    "@mantine/notifications": "^5.10.3",
+        "@reduxjs/toolkit": "^2.6.1",
-    "@mantine/spotlight": "^5.10.3",
+        "axios": "^1.8.4",
-    "@mantine/styles": "^5.10.3",
+        "dayjs": "^1.11.13",
-    "@reduxjs/toolkit": "^1.9.2",
+        "escape-string-regexp": "^5.0.0",
-    "axios": "^1.3.2",
+        "interweave": "^13.1.1",
-    "dayjs": "^1.11.7",
+        "monaco-editor": "^0.52.2",
-    "interweave": "^13.0.0",
+        "mousetrap": "^1.6.5",
-    "lodash": "^4.17.21",
+        "react": "^19.1.0",
-    "make-plural": "^7.2.0",
+        "react-async-hook": "^4.0.0",
-    "mousetrap": "^1.6.5",
+        "react-contexify": "^6.0.0",
-    "react": "^18.2.0",
+        "react-device-detect": "^2.2.3",
-    "react-async-hook": "^4.0.0",
+        "react-dom": "^19.1.0",
-    "react-contexify": "^6.0.0",
+        "react-draggable": "^4.4.6",
-    "react-dom": "^18.2.0",
+        "react-ga4": "^2.1.0",
-    "react-ga4": "^2.1.0",
+        "react-icons": "^5.5.0",
-    "react-icons": "^4.7.1",
+        "react-infinite-scroller": "^1.2.6",
-    "react-infinite-scroller": "^1.2.6",
+        "react-redux": "^9.2.0",
-    "react-redux": "^8.0.5",
+        "react-router-dom": "^7.4.1",
-    "react-router-dom": "^6.8.0",
+        "react-swipeable": "^7.0.2",
-    "react-swipeable": "^7.0.0",
+        "redoc": "^2.4.0",
-    "swagger-ui-react": "^4.15.5",
+        "style-to-object": "^1.0.8",
-    "tinycon": "^0.6.8",
+        "throttle-debounce": "^5.0.2",
-    "use-local-storage": "^3.0.0",
+        "tinycon": "^0.6.8",
-    "websocket-heartbeat-js": "^1.1.1"
+        "tss-react": "^4.9.16",
-  },
+        "websocket-heartbeat-js": "^1.1.3"
-  "devDependencies": {
+    },
-    "@lingui/cli": "^3.17.0",
+    "devDependencies": {
-    "@types/eslint": "^8.21.0",
+        "@biomejs/biome": "^1.9.4",
-    "@types/lodash": "^4.14.191",
+        "@lingui/babel-plugin-lingui-macro": "^5.3.0",
-    "@types/mousetrap": "^1.6.11",
+        "@lingui/cli": "^5.3.0",
-    "@types/react": "^18.0.27",
+        "@lingui/vite-plugin": "^5.3.0",
-    "@types/react-dom": "^18.0.10",
+        "@testing-library/jest-dom": "^6.6.3",
-    "@types/react-infinite-scroller": "^1.2.3",
+        "@testing-library/react": "^16.3.0",
-    "@types/swagger-ui-react": "^4.11.0",
+        "@testing-library/user-event": "^14.6.1",
-    "@types/tinycon": "^0.6.3",
+        "@types/mousetrap": "^1.6.15",
-    "@typescript-eslint/eslint-plugin": "^5.50.0",
+        "@types/react": "^19.1.0",
-    "@typescript-eslint/parser": "^5.50.0",
+        "@types/react-dom": "^19.1.1",
-    "@vitejs/plugin-react": "^3.1.0",
+        "@types/react-infinite-scroller": "^1.2.5",
-    "eslint": "^8.33.0",
+        "@types/throttle-debounce": "^5.0.2",
-    "eslint-config-airbnb": "^19.0.4",
+        "@types/tinycon": "^0.6.7",
-    "eslint-config-airbnb-typescript": "^17.0.0",
+        "@vitejs/plugin-react": "^4.3.4",
-    "eslint-config-prettier": "^8.6.0",
+        "babel-plugin-macros": "^3.1.0",
-    "eslint-config-react-app": "^7.0.1",
+        "jsdom": "^26.0.0",
-    "eslint-plugin-hooks": "^0.4.3",
+        "rollup-plugin-visualizer": "^5.14.0",
-    "eslint-plugin-prettier": "^4.2.1",
+        "typescript": "^5.8.2",
-    "prettier": "^2.8.3",
+        "vite": "^6.2.5",
-    "rollup-plugin-visualizer": "^5.9.0",
+        "vite-plugin-checker": "^0.9.1",
-    "typescript": "^4.9.5",
+        "vite-tsconfig-paths": "^5.1.4",
-    "vite": "^4.1.1",
+        "vitest": "^3.1.1"
-    "vite-plugin-eslint": "^1.8.1",
+    },
-    "vite-tsconfig-paths": "^4.0.5",
+    "overrides": {
-    "vitest": "^0.28.4",
+        "react-infinite-scroller": {
-    "vitest-mock-extended": "^1.0.9"
+            "react": "^19.1.0"
-  }
+        }
+    }
 }

commafeed-client/pom.xml

@@ -1,98 +1,97 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-
+		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-	<modelVersion>4.0.0</modelVersion>
+
-
+	<modelVersion>4.0.0</modelVersion>
-	<parent>
+
-		<groupId>com.commafeed</groupId>
+	<parent>
-		<artifactId>commafeed</artifactId>
+		<groupId>com.commafeed</groupId>
-		<version>3.2.0</version>
+		<artifactId>commafeed</artifactId>
-	</parent>
+		<version>5.7.0</version>
-	<artifactId>commafeed-client</artifactId>
+	</parent>
-	<name>CommaFeed Client</name>
+	<artifactId>commafeed-client</artifactId>
-
+	<name>CommaFeed Client</name>
-	<build>
+
-		<plugins>
+	<properties>
-			<plugin>
+		<!-- renovate: datasource=node-version depName=node -->
-				<groupId>com.github.eirslett</groupId>
+		<node.version>v22.14.0</node.version>
-				<artifactId>frontend-maven-plugin</artifactId>
+		<!-- renovate: datasource=npm depName=npm -->
-				<version>1.12.1</version>
+		<npm.version>11.2.0</npm.version>
-				<?m2e ignore?>
+	</properties>
-				<executions>
+
-					<execution>
+	<build>
-						<id>install node and npm</id>
+		<plugins>
-						<goals>
+			<plugin>
-							<goal>install-node-and-npm</goal>
+				<groupId>com.github.eirslett</groupId>
-						</goals>
+				<artifactId>frontend-maven-plugin</artifactId>
-						<phase>compile</phase>
+				<version>1.15.1</version>
-						<configuration>
+				<?m2e ignore?>
-							<nodeVersion>v16.16.0</nodeVersion>
+				<executions>
-							<npmVersion>8.15.0</npmVersion>
+					<execution>
-						</configuration>
+						<id>install node and npm</id>
-					</execution>
+						<goals>
-					<execution>
+							<goal>install-node-and-npm</goal>
-						<id>npm install</id>
+						</goals>
-						<goals>
+						<phase>compile</phase>
-							<goal>npm</goal>
+						<configuration>
-						</goals>
+							<nodeVersion>${node.version}</nodeVersion>
-						<phase>compile</phase>
+							<npmVersion>${npm.version}</npmVersion>
-						<configuration>
+						</configuration>
-							<arguments>ci</arguments>
+					</execution>
-						</configuration>
+					<execution>
-					</execution>
+						<id>npm install</id>
-					<execution>
+						<goals>
-						<id>npm run eslint</id>
+							<goal>npm</goal>
-						<goals>
+						</goals>
-							<goal>npm</goal>
+						<phase>compile</phase>
-						</goals>
+						<configuration>
-						<phase>compile</phase>
+							<arguments>ci</arguments>
-						<configuration>
+						</configuration>
-							<arguments>run eslint</arguments>
+					</execution>
-						</configuration>
+					<execution>
-					</execution>
+						<id>npm run test</id>
-					<execution>
+						<goals>
-						<id>npm run test</id>
+							<goal>npm</goal>
-						<goals>
+						</goals>
-							<goal>npm</goal>
+						<phase>compile</phase>
-						</goals>
+						<configuration>
-						<phase>compile</phase>
+							<arguments>run test:ci</arguments>
-						<configuration>
+							<skip>${skipTests}</skip>
-							<arguments>run test:ci</arguments>
+						</configuration>
-						</configuration>
+					</execution>
-					</execution>
+					<execution>
-					<execution>
+						<id>npm run build</id>
-						<id>npm run build</id>
+						<goals>
-						<goals>
+							<goal>npm</goal>
-							<goal>npm</goal>
+						</goals>
-						</goals>
+						<phase>compile</phase>
-						<phase>compile</phase>
+						<configuration>
-						<configuration>
+							<arguments>run build</arguments>
-							<arguments>run build</arguments>
+						</configuration>
-						</configuration>
+					</execution>
-					</execution>
+				</executions>
-				</executions>
+			</plugin>
-			</plugin>
+			<plugin>
-			<plugin>
+				<artifactId>maven-resources-plugin</artifactId>
-				<artifactId>maven-resources-plugin</artifactId>
+				<version>3.3.1</version>
-				<version>3.3.0</version>
+				<executions>
-				<executions>
+					<execution>
-					<execution>
+						<id>copy web interface to resources</id>
-						<id>copy web interface to resources</id>
+						<phase>prepare-package</phase>
-						<phase>prepare-package</phase>
+						<goals>
-						<goals>
+							<goal>copy-resources</goal>
-							<goal>copy-resources</goal>
+						</goals>
-						</goals>
+						<configuration>
-						<configuration>
+							<outputDirectory>${project.build.directory}/classes/META-INF/resources</outputDirectory>
-							<outputDirectory>${project.build.directory}/classes/assets</outputDirectory>
+							<resources>
-							<resources>
+								<resource>
-								<resource>
+									<directory>dist</directory>
-									<directory>dist</directory>
+									<filtering>false</filtering>
-									<filtering>false</filtering>
+								</resource>
-								</resource>
+							</resources>
-							</resources>
+						</configuration>
-						</configuration>
+					</execution>
-					</execution>
+				</executions>
-				</executions>
+			</plugin>
-			</plugin>
+		</plugins>
-		</plugins>
+	</build>
-	</build>
 </project>

commafeed-client/src/App.tsx

@@ -1,23 +1,27 @@
 import { i18n } from "@lingui/core"
 import { I18nProvider } from "@lingui/react"
-import { ColorScheme, ColorSchemeProvider, MantineProvider } from "@mantine/core"
+import { MantineProvider } from "@mantine/core"
-import { useColorScheme } from "@mantine/hooks"
 import { ModalsProvider } from "@mantine/modals"
-import { NotificationsProvider } from "@mantine/notifications"
+import { Notifications } from "@mantine/notifications"
 import { Constants } from "app/constants"
-import { redirectTo } from "app/slices/redirect"
+import { redirectTo } from "app/redirect/slice"
-import { reloadServerInfos } from "app/slices/server"
+import { reloadServerInfos } from "app/server/thunks"
 import { useAppDispatch, useAppSelector } from "app/store"
 import { categoryUnreadCount } from "app/utils"
+import { DisablePullToRefresh } from "components/DisablePullToRefresh"
 import { ErrorBoundary } from "components/ErrorBoundary"
 import { Header } from "components/header/Header"
 import { Tree } from "components/sidebar/Tree"
+import { useAppLoading } from "hooks/useAppLoading"
+import { useBrowserExtension } from "hooks/useBrowserExtension"
 import { useI18n } from "i18n"
+import { WelcomePage } from "pages/WelcomePage"
 import { AdminUsersPage } from "pages/admin/AdminUsersPage"
 import { MetricsPage } from "pages/admin/MetricsPage"
 import { AboutPage } from "pages/app/AboutPage"
 import { AddPage } from "pages/app/AddPage"
 import { CategoryDetailsPage } from "pages/app/CategoryDetailsPage"
+import { DonatePage } from "pages/app/DonatePage"
 import { FeedDetailsPage } from "pages/app/FeedDetailsPage"
 import { FeedEntriesPage } from "pages/app/FeedEntriesPage"
 import Layout from "pages/app/Layout"
@@ -26,45 +30,53 @@ import { TagDetailsPage } from "pages/app/TagDetailsPage"
 import { LoginPage } from "pages/auth/LoginPage"
 import { PasswordRecoveryPage } from "pages/auth/PasswordRecoveryPage"
 import { RegistrationPage } from "pages/auth/RegistrationPage"
-import React, { useEffect } from "react"
+import React, { useEffect, useState } from "react"
+import { isSafari } from "react-device-detect"
 import ReactGA from "react-ga4"
 import { HashRouter, Navigate, Route, Routes, useLocation, useNavigate } from "react-router-dom"
 import Tinycon from "tinycon"
-import useLocalStorage from "use-local-storage"
-import { WelcomePage } from "./pages/WelcomePage"
 
 function Providers(props: { children: React.ReactNode }) {
-    const preferredColorScheme = useColorScheme()
-    const [colorScheme, setColorScheme] = useLocalStorage<ColorScheme>("color-scheme", preferredColorScheme)
-    const toggleColorScheme = (value?: ColorScheme) => setColorScheme(value || (colorScheme === "dark" ? "light" : "dark"))
-
     return (
         <I18nProvider i18n={i18n}>
-            <ColorSchemeProvider colorScheme={colorScheme} toggleColorScheme={toggleColorScheme}>
+            <MantineProvider
-                <MantineProvider
+                defaultColorScheme="auto"
-                    withGlobalStyles
+                theme={{
-                    withNormalizeCSS
+                    primaryColor: "orange",
-                    theme={{
+                    fontFamily: "Open Sans",
-                        primaryColor: "orange",
+                    colors: {
-                        colorScheme,
+                        // keep using dark colors from mantine v6
-                        fontFamily: "Open Sans",
+                        // https://v6.mantine.dev/theming/colors/#default-colors
-                    }}
+                        dark: [
-                >
+                            "#C1C2C5",
-                    <ModalsProvider>
+                            "#A6A7AB",
-                        <NotificationsProvider position="bottom-right" zIndex={9999}>
+                            "#909296",
-                            <ErrorBoundary>{props.children}</ErrorBoundary>
+                            "#5c5f66",
-                        </NotificationsProvider>
+                            "#373A40",
-                    </ModalsProvider>
+                            "#2C2E33",
-                </MantineProvider>
+                            "#25262b",
-            </ColorSchemeProvider>
+                            "#1A1B1E",
+                            "#141517",
+                            "#101113",
+                        ],
+                    },
+                }}
+            >
+                <ModalsProvider>
+                    <Notifications position="bottom-right" zIndex={9999} />
+                    <ErrorBoundary>{props.children}</ErrorBoundary>
+                </ModalsProvider>
+            </MantineProvider>
         </I18nProvider>
     )
 }
 
-// swagger-ui is very large, load only on-demand
+// api documentation page is very large, load only on-demand
-const ApiDocumentationPage = React.lazy(() => import("pages/app/ApiDocumentationPage"))
+const ApiDocumentationPage = React.lazy(async () => await import("pages/app/ApiDocumentationPage"))
 
 function AppRoutes() {
+    const sidebarVisible = useAppSelector(state => state.tree.sidebarVisible)
+
     return (
         <Routes>
             <Route path="/" element={<Navigate to={`/app/category/${Constants.categories.all.id}`} replace />} />
@@ -72,7 +84,8 @@ function AppRoutes() {
             <Route path="login" element={<LoginPage />} />
             <Route path="register" element={<RegistrationPage />} />
             <Route path="passwordRecovery" element={<PasswordRecoveryPage />} />
-            <Route path="app" element={<Layout header={<Header />} sidebar={<Tree />} />}>
+            <Route path="api" element={<ApiDocumentationPage />} />
+            <Route path="app" element={<Layout header={<Header />} sidebar={<Tree />} sidebarVisible={sidebarVisible} />}>
                 <Route path="category">
                     <Route path=":id" element={<FeedEntriesPage sourceType="category" />} />
                     <Route path=":id/details" element={<CategoryDetailsPage />} />
@@ -92,7 +105,7 @@ function AppRoutes() {
                     <Route path="metrics" element={<MetricsPage />} />
                 </Route>
                 <Route path="about" element={<AboutPage />} />
-                <Route path="api" element={<ApiDocumentationPage />} />
+                <Route path="donate" element={<DonatePage />} />
             </Route>
             <Route path="*" element={<Navigate to="/" replace />} />
         </Routes>
@@ -123,27 +136,81 @@ function GoogleAnalyticsHandler() {
     }, [googleAnalyticsCode])
 
     useEffect(() => {
-        ReactGA.send({ hitType: "pageview", page: location.pathname })
+        if (ReactGA.isInitialized) ReactGA.send({ hitType: "pageview", page: location.pathname })
     }, [location])
 
     return null
 }
 
-function FaviconHandler() {
+function UnreadCountTitleHandler({ unreadCount, enabled }: { unreadCount: number; enabled?: boolean }) {
-    const root = useAppSelector(state => state.tree.rootCategory)
+    return <title>{enabled && unreadCount > 0 ? `(${unreadCount}) CommaFeed` : "CommaFeed"}</title>
+}
+
+function UnreadCountFaviconHandler({ unreadCount, enabled }: { unreadCount: number; enabled?: boolean }) {
     useEffect(() => {
+        if (enabled && unreadCount > 0) {
+            Tinycon.setBubble(unreadCount)
+        } else {
+            Tinycon.reset()
+        }
+    }, [unreadCount, enabled])
+
+    return null
+}
+
+function BrowserExtensionBadgeUnreadCountHandler() {
+    const root = useAppSelector(state => state.tree.rootCategory)
+    const { setBadgeUnreadCount } = useBrowserExtension()
+    useEffect(() => {
+        if (!root) return
         const unreadCount = categoryUnreadCount(root)
-        if (unreadCount === 0) Tinycon.reset()
+        setBadgeUnreadCount(unreadCount)
-        else Tinycon.setBubble(unreadCount)
+    }, [root, setBadgeUnreadCount])
-    }, [root])
+
+    return null
+}
+
+function CustomJsHandler() {
+    const [scriptLoaded, setScriptLoaded] = useState(false)
+    const { loading } = useAppLoading()
+
+    useEffect(() => {
+        if (scriptLoaded || loading) {
+            return
+        }
+
+        const script = document.createElement("script")
+        script.src = "custom_js.js"
+        script.async = true
+        document.body.appendChild(script)
+
+        setScriptLoaded(true)
+    }, [scriptLoaded, loading])
+
+    return null
+}
+
+function CustomCssHandler() {
+    useEffect(() => {
+        const link = document.createElement("link")
+        link.rel = "stylesheet"
+        link.type = "text/css"
+        link.href = "custom_css.css"
+        document.head.appendChild(link)
+    }, [])
 
     return null
 }
 
 export function App() {
     useI18n()
+    const root = useAppSelector(state => state.tree.rootCategory)
+    const unreadCountTitle = useAppSelector(state => state.user.settings?.unreadCountTitle)
+    const unreadCountFavicon = useAppSelector(state => state.user.settings?.unreadCountFavicon)
     const dispatch = useAppDispatch()
 
+    const unreadCount = categoryUnreadCount(root)
+
     useEffect(() => {
         dispatch(reloadServerInfos())
     }, [dispatch])
@@ -151,7 +218,18 @@ export function App() {
     return (
         <Providers>
             <>
-                <FaviconHandler />
+                <UnreadCountTitleHandler unreadCount={unreadCount} enabled={unreadCountTitle} />
+                <UnreadCountFaviconHandler unreadCount={unreadCount} enabled={unreadCountFavicon} />
+                <BrowserExtensionBadgeUnreadCountHandler />
+                <CustomJsHandler />
+                <CustomCssHandler />
+
+                {/* disable pull-to-refresh as it messes with vertical scrolling
+                        safari behaves weirdly when overscroll-behavior is set to none so we disable it only for other browsers
+                        https://github.com/Athou/commafeed/issues/1168
+                    */}
+                {!isSafari && <DisablePullToRefresh />}
+
                 <HashRouter>
                     <GoogleAnalyticsHandler />
                     <RedirectHandler />

commafeed-client/src/app/async-thunk.ts

@@ -0,0 +1,7 @@
+import { createAsyncThunk } from "@reduxjs/toolkit"
+import type { AppDispatch, RootState } from "app/store"
+
+export const createAppAsyncThunk = createAsyncThunk.withTypes<{
+    state: RootState
+    dispatch: AppDispatch
+}>()

commafeed-client/src/app/client.ts

@@ -1,115 +1,137 @@
-import axios from "axios"
+import axios, { type AxiosError } from "axios"
-import {
+import type {
-    AddCategoryRequest,
+    AddCategoryRequest,
-    Category,
+    AdminSaveUserRequest,
-    CategoryModificationRequest,
+    AuthenticationError,
-    CollapseRequest,
+    Category,
-    Entries,
+    CategoryModificationRequest,
-    FeedInfo,
+    CollapseRequest,
-    FeedInfoRequest,
+    Entries,
-    FeedModificationRequest,
+    FeedInfo,
-    GetEntriesPaginatedRequest,
+    FeedInfoRequest,
-    IDRequest,
+    FeedModificationRequest,
-    LoginRequest,
+    GetEntriesPaginatedRequest,
-    MarkRequest,
+    IDRequest,
-    Metrics,
+    LoginRequest,
-    MultipleMarkRequest,
+    MarkRequest,
-    PasswordResetRequest,
+    Metrics,
-    ProfileModificationRequest,
+    MultipleMarkRequest,
-    RegistrationRequest,
+    PasswordResetRequest,
-    ServerInfo,
+    ProfileModificationRequest,
-    Settings,
+    RegistrationRequest,
-    StarRequest,
+    ServerInfo,
-    SubscribeRequest,
+    Settings,
-    Subscription,
+    StarRequest,
-    TagRequest,
+    SubscribeRequest,
-    UserModel,
+    Subscription,
-} from "./types"
+    TagRequest,
-
+    UserModel,
-const axiosInstance = axios.create({ baseURL: "./rest", withCredentials: true })
+} from "./types"
-axiosInstance.interceptors.response.use(
+
-    response => response,
+const axiosInstance = axios.create({ baseURL: "./rest", withCredentials: true })
-    error => {
+axiosInstance.interceptors.response.use(
-        if (error.response.status === 401 && error.response.data === "Credentials are required to access this resource.") {
+    response => response,
-            window.location.hash = "/welcome"
+    error => {
-        }
+        if (isAuthenticationError(error)) {
-        throw error
+            const data = error.response?.data
-    }
+            window.location.hash = data?.allowRegistrations ? "/welcome" : "/login"
-)
+        }
-
+        throw error
-export const client = {
+    }
-    category: {
+)
-        getRoot: () => axiosInstance.get<Category>("category/get"),
+
-        modify: (req: CategoryModificationRequest) => axiosInstance.post("category/modify", req),
+function isAuthenticationError(error: unknown): error is AxiosError<AuthenticationError> {
-        collapse: (req: CollapseRequest) => axiosInstance.post("category/collapse", req),
+    return axios.isAxiosError(error) && !!error.response && [401, 403].includes(error.response.status)
-        getEntries: (req: GetEntriesPaginatedRequest) => axiosInstance.get<Entries>("category/entries", { params: req }),
+}
-        markEntries: (req: MarkRequest) => axiosInstance.post("category/mark", req),
+
-        add: (req: AddCategoryRequest) => axiosInstance.post("category/add", req),
+export const client = {
-        delete: (req: IDRequest) => axiosInstance.post("category/delete", req),
+    category: {
-    },
+        getRoot: async () => await axiosInstance.get<Category>("category/get"),
-    entry: {
+        modify: async (req: CategoryModificationRequest) => await axiosInstance.post("category/modify", req),
-        mark: (req: MarkRequest) => axiosInstance.post("entry/mark", req),
+        collapse: async (req: CollapseRequest) => await axiosInstance.post("category/collapse", req),
-        markMultiple: (req: MultipleMarkRequest) => axiosInstance.post("entry/markMultiple", req),
+        getEntries: async (req: GetEntriesPaginatedRequest) => await axiosInstance.get<Entries>("category/entries", { params: req }),
-        star: (req: StarRequest) => axiosInstance.post("entry/star", req),
+        markEntries: async (req: MarkRequest) => await axiosInstance.post("category/mark", req),
-        getTags: () => axiosInstance.get<string[]>("entry/tags"),
+        add: async (req: AddCategoryRequest) => await axiosInstance.post("category/add", req),
-        tag: (req: TagRequest) => axiosInstance.post("entry/tag", req),
+        delete: async (req: IDRequest) => await axiosInstance.post("category/delete", req),
-    },
+    },
-    feed: {
+    entry: {
-        get: (id: string) => axiosInstance.get<Subscription>(`feed/get/${id}`),
+        mark: async (req: MarkRequest) => await axiosInstance.post("entry/mark", req),
-        modify: (req: FeedModificationRequest) => axiosInstance.post("feed/modify", req),
+        markMultiple: async (req: MultipleMarkRequest) => await axiosInstance.post("entry/markMultiple", req),
-        getEntries: (req: GetEntriesPaginatedRequest) => axiosInstance.get<Entries>("feed/entries", { params: req }),
+        star: async (req: StarRequest) => await axiosInstance.post("entry/star", req),
-        markEntries: (req: MarkRequest) => axiosInstance.post("feed/mark", req),
+        getTags: async () => await axiosInstance.get<string[]>("entry/tags"),
-        fetchFeed: (req: FeedInfoRequest) => axiosInstance.post<FeedInfo>("feed/fetch", req),
+        tag: async (req: TagRequest) => await axiosInstance.post("entry/tag", req),
-        refreshAll: () => axiosInstance.get("feed/refreshAll"),
+    },
-        subscribe: (req: SubscribeRequest) => axiosInstance.post<number>("feed/subscribe", req),
+    feed: {
-        unsubscribe: (req: IDRequest) => axiosInstance.post("feed/unsubscribe", req),
+        get: async (id: string) => await axiosInstance.get<Subscription>(`feed/get/${id}`),
-        importOpml: (req: File) => {
+        modify: async (req: FeedModificationRequest) => await axiosInstance.post("feed/modify", req),
-            const formData = new FormData()
+        getEntries: async (req: GetEntriesPaginatedRequest) => await axiosInstance.get<Entries>("feed/entries", { params: req }),
-            formData.append("file", req)
+        markEntries: async (req: MarkRequest) => await axiosInstance.post("feed/mark", req),
-            return axiosInstance.post("feed/import", formData, {
+        fetchFeed: async (req: FeedInfoRequest) => await axiosInstance.post<FeedInfo>("feed/fetch", req),
-                headers: {
+        refreshAll: async () => await axiosInstance.get("feed/refreshAll"),
-                    "Content-Type": "multipart/form-data",
+        subscribe: async (req: SubscribeRequest) => await axiosInstance.post<number>("feed/subscribe", req),
-                },
+        unsubscribe: async (req: IDRequest) => await axiosInstance.post("feed/unsubscribe", req),
-            })
+        importOpml: async (req: File) => {
-        },
+            const formData = new FormData()
-    },
+            formData.append("file", req)
-    user: {
+            return await axiosInstance.post("feed/import", formData, {
-        login: (req: LoginRequest) => axiosInstance.post("user/login", req),
+                headers: {
-        register: (req: RegistrationRequest) => axiosInstance.post("user/register", req),
+                    "Content-Type": "multipart/form-data",
-        passwordReset: (req: PasswordResetRequest) => axiosInstance.post("user/passwordReset", req),
+                },
-        getSettings: () => axiosInstance.get<Settings>("user/settings"),
+            })
-        saveSettings: (settings: Settings) => axiosInstance.post("user/settings", settings),
+        },
-        getProfile: () => axiosInstance.get<UserModel>("user/profile"),
+    },
-        saveProfile: (req: ProfileModificationRequest) => axiosInstance.post("user/profile", req),
+    user: {
-        deleteProfile: () => axiosInstance.post("user/profile/deleteAccount"),
+        login: async (req: LoginRequest) => {
-    },
+            const formData = new URLSearchParams()
-    server: {
+            formData.append("j_username", req.name)
-        getServerInfos: () => axiosInstance.get<ServerInfo>("server/get"),
+            formData.append("j_password", req.password)
-    },
+            return await axiosInstance.post("j_security_check", formData, {
-    admin: {
+                baseURL: ".",
-        getAllUsers: () => axiosInstance.get<UserModel[]>("admin/user/getAll"),
+                headers: {
-        saveUser: (req: UserModel) => axiosInstance.post("admin/user/save", req),
+                    "Content-Type": "application/x-www-form-urlencoded",
-        deleteUser: (req: IDRequest) => axiosInstance.post("admin/user/delete", req),
+                },
-        getMetrics: () => axiosInstance.get<Metrics>("admin/metrics"),
+            })
-    },
+        },
-}
+        register: async (req: RegistrationRequest) => await axiosInstance.post("user/register", req),
-
+        passwordReset: async (req: PasswordResetRequest) => await axiosInstance.post("user/passwordReset", req),
-/**
+        getSettings: async () => await axiosInstance.get<Settings>("user/settings"),
- * transform an error object to an array of strings that can be displayed to the user
+        saveSettings: async (settings: Settings) => await axiosInstance.post("user/settings", settings),
- * @param err an error object (e.g. from axios)
+        getProfile: async () => await axiosInstance.get<UserModel>("user/profile"),
- * @returns an array of messages to show the user
+        saveProfile: async (req: ProfileModificationRequest) => await axiosInstance.post("user/profile", req),
- */
+        deleteProfile: async () => await axiosInstance.post("user/profile/deleteAccount"),
-export const errorToStrings = (err: unknown) => {
+    },
-    let strings: string[] = []
+    server: {
-
+        getServerInfos: async () => await axiosInstance.get<ServerInfo>("server/get"),
-    if (axios.isAxiosError(err)) {
+    },
-        if (err.response) {
+    admin: {
-            const { data } = err.response
+        getAllUsers: async () => await axiosInstance.get<UserModel[]>("admin/user/getAll"),
-            if (typeof data === "string") strings.push(data)
+        saveUser: async (req: AdminSaveUserRequest) => await axiosInstance.post("admin/user/save", req),
-            if (typeof data === "object" && data.message) strings.push(data.message)
+        deleteUser: async (req: IDRequest) => await axiosInstance.post("admin/user/delete", req),
-            if (typeof data === "object" && data.errors) strings = [...strings, ...data.errors]
+        getMetrics: async () => await axiosInstance.get<Metrics>("admin/metrics"),
-        }
+    },
-    }
+}
-
+
-    return strings
+/**
-}
+ * transform an error object to an array of strings that can be displayed to the user
+ * @param err an error object (e.g. from axios)
+ * @returns an array of messages to show the user
+ */
+export const errorToStrings = (err: unknown) => {
+    let strings: string[] = []
+
+    if (axios.isAxiosError(err) && err.response) {
+        if (typeof err.response.data === "string") strings.push(err.response.data)
+        if (isMessageError(err)) strings.push(err.response.data.message)
+        if (isMessageArrayError(err)) strings = [...strings, ...err.response.data.errors]
+    }
+
+    return strings
+}
+
+function isMessageError(err: AxiosError): err is AxiosError<{ message: string }> {
+    return !!err.response && !!err.response.data && typeof err.response.data === "object" && "message" in err.response.data
+}
+
+function isMessageArrayError(err: AxiosError): err is AxiosError<{ errors: string[] }> {
+    return !!err.response && !!err.response.data && typeof err.response.data === "object" && "errors" in err.response.data
+}

commafeed-client/src/app/constants.ts

@@ -1,101 +1,109 @@
-import { t } from "@lingui/macro"
+import type { IconType } from "react-icons"
-import { DEFAULT_THEME } from "@mantine/core"
+import { FaAt } from "react-icons/fa"
-import { IconType } from "react-icons"
+import { SiBuffer, SiFacebook, SiGmail, SiInstapaper, SiPocket, SiTumblr, SiX } from "react-icons/si"
-import { FaAt } from "react-icons/fa"
+import type { Category, Entry, SharingSettings } from "./types"
-import { SiBuffer, SiFacebook, SiGmail, SiInstapaper, SiPocket, SiTumblr, SiTwitter } from "react-icons/si"
+
-import { Category, Entry, SharingSettings } from "./types"
+const categories: Record<string, Omit<Category, "name">> = {
-
+    all: {
-const categories: { [key: string]: Category } = {
+        id: "all",
-    all: {
+        expanded: false,
-        id: "all",
+        children: [],
-        name: t`All`,
+        feeds: [],
-        expanded: false,
+        position: 0,
-        children: [],
+    },
-        feeds: [],
+    starred: {
-        position: 0,
+        id: "starred",
-    },
+        expanded: false,
-    starred: {
+        children: [],
-        id: "starred",
+        feeds: [],
-        name: t`Starred`,
+        position: 1,
-        expanded: false,
+    },
-        children: [],
+}
-        feeds: [],
+
-        position: 1,
+const sharing: {
-    },
+    [key in keyof SharingSettings]: {
-}
+        label: string
-
+        icon: IconType
-const sharing: {
+        color: `#${string}`
-    [key in keyof SharingSettings]: {
+        url: (url: string, description: string) => string
-        label: string
+    }
-        icon: IconType
+} = {
-        color: `#${string}`
+    email: {
-        url: (url: string, description: string) => string
+        label: "Email",
-    }
+        icon: FaAt,
-} = {
+        color: "#000000",
-    email: {
+        url: (url, desc) => `mailto:?subject=${desc}&body=${url}`,
-        label: "Email",
+    },
-        icon: FaAt,
+    gmail: {
-        color: "#000000",
+        label: "Gmail",
-        url: (url, desc) => `mailto:?subject=${desc}&body=${url}`,
+        icon: SiGmail,
-    },
+        color: "#EA4335",
-    gmail: {
+        url: (url, desc) => `https://mail.google.com/mail/?view=cm&fs=1&tf=1&source=mailto&su=${desc}&body=${url}`,
-        label: "Gmail",
+    },
-        icon: SiGmail,
+    facebook: {
-        color: "#EA4335",
+        label: "Facebook",
-        url: (url, desc) => `https://mail.google.com/mail/?view=cm&fs=1&tf=1&source=mailto&su=${desc}&body=${url}`,
+        icon: SiFacebook,
-    },
+        color: "#1B74E4",
-    facebook: {
+        url: url => `https://www.facebook.com/sharer/sharer.php?u=${url}`,
-        label: "Facebook",
+    },
-        icon: SiFacebook,
+    twitter: {
-        color: "#1B74E4",
+        label: "X",
-        url: url => `https://www.facebook.com/sharer/sharer.php?u=${url}`,
+        icon: SiX,
-    },
+        color: "#000000",
-    twitter: {
+        url: (url, desc) => `https://x.com/share?text=${desc}&url=${url}`,
-        label: "Twitter",
+    },
-        icon: SiTwitter,
+    tumblr: {
-        color: "#1D9BF0",
+        label: "Tumblr",
-        url: (url, desc) => `https://twitter.com/share?text=${desc}&url=${url}`,
+        icon: SiTumblr,
-    },
+        color: "#375672",
-    tumblr: {
+        url: (url, desc) => `https://www.tumblr.com/share/link?url=${url}&name=${desc}`,
-        label: "Tumblr",
+    },
-        icon: SiTumblr,
+    pocket: {
-        color: "#375672",
+        label: "Pocket",
-        url: (url, desc) => `https://www.tumblr.com/share/link?url=${url}&name=${desc}`,
+        icon: SiPocket,
-    },
+        color: "#EF4154",
-    pocket: {
+        url: (url, desc) => `https://getpocket.com/save?url=${url}&title=${desc}`,
-        label: "Pocket",
+    },
-        icon: SiPocket,
+    instapaper: {
-        color: "#EF4154",
+        label: "Instapaper",
-        url: (url, desc) => `https://getpocket.com/save?url=${url}&title=${desc}`,
+        icon: SiInstapaper,
-    },
+        color: "#010101",
-    instapaper: {
+        url: (url, desc) => `https://www.instapaper.com/hello2?url=${url}&title=${desc}`,
-        label: "Instapaper",
+    },
-        icon: SiInstapaper,
+    buffer: {
-        color: "#010101",
+        label: "Buffer",
-        url: (url, desc) => `https://www.instapaper.com/hello2?url=${url}&title=${desc}`,
+        icon: SiBuffer,
-    },
+        color: "#000000",
-    buffer: {
+        url: (url, desc) => `https://bufferapp.com/add?url=${url}&text=${desc}`,
-        label: "Buffer",
+    },
-        icon: SiBuffer,
+}
-        color: "#000000",
+
-        url: (url, desc) => `https://bufferapp.com/add?url=${url}&text=${desc}`,
+export const Constants = {
-    },
+    categories,
-}
+    sharing,
-
+    layout: {
-export const Constants = {
+        mobileBreakpoint: 992,
-    categories,
+        mobileBreakpointName: "md",
-    sharing,
+        headerHeight: 60,
-    layout: {
+        entryMaxWidth: 650,
-        mobileBreakpoint: DEFAULT_THEME.breakpoints.md,
+        isTopVisible: (div: HTMLElement) => {
-        headerHeight: 60,
+            const header = document.getElementById(Constants.dom.headerId)?.getBoundingClientRect()
-        sidebarWidth: 350,
+            return div.getBoundingClientRect().top >= (header?.bottom ?? 0)
-        entryMaxWidth: 650,
+        },
-        isTopVisible: (div: HTMLElement) => div.getBoundingClientRect().top >= Constants.layout.headerHeight,
+        isBottomVisible: (div: HTMLElement) => {
-        isBottomVisible: (div: HTMLElement) => div.getBoundingClientRect().bottom <= window.innerHeight,
+            const footer = document.getElementById(Constants.dom.footerId)?.getBoundingClientRect()
-    },
+            return div.getBoundingClientRect().bottom <= (footer?.top ?? window.innerHeight)
-    dom: {
+        },
-        mainScrollAreaId: "main-scroll-area-id",
+    },
-        entryId: (entry: Entry) => `entry-id-${entry.id}`,
+    dom: {
-    },
+        headerId: "header",
-    bitcoinWalletAddress: "1dymfUxqCWpyD7a6rQSqNy4rLVDBsAr5e",
+        footerId: "footer",
-}
+        entryId: (entry: Entry) => `entry-id-${entry.id}`,
+        entryContextMenuId: (entry: Entry) => entry.id,
+    },
+    tooltip: {
+        delay: 500,
+    },
+    browserExtensionUrl: "https://github.com/Athou/commafeed-browser-extension",
+    bitcoinWalletAddress: "1dymfUxqCWpyD7a6rQSqNy4rLVDBsAr5e",
+}

commafeed-client/src/app/entries/entries.test.ts

@@ -1,142 +1,140 @@
-/* eslint-disable import/first */
+import { configureStore } from "@reduxjs/toolkit"
-import { beforeEach, describe, expect, it, vi } from "vitest"
+import { client } from "app/client"
-import { DeepMockProxy, mockDeep, mockReset } from "vitest-mock-extended"
+import { loadEntries, loadMoreEntries, markAllEntries, markEntry } from "app/entries/thunks"
-
+import { type RootState, reducers } from "app/store"
-vi.doMock("app/client", () => ({ client: mockDeep() }))
+import type { Entries, Entry } from "app/types"
-
+import type { AxiosResponse } from "axios"
-import { configureStore } from "@reduxjs/toolkit"
+import { beforeEach, describe, expect, it, vi } from "vitest"
-import { client } from "app/client"
+
-import { reducers } from "app/store"
+vi.mock(import("app/client"))
-import { Entries, Entry } from "app/types"
+
-import { AxiosResponse } from "axios"
+describe("entries", () => {
-import { loadEntries, loadMoreEntries, markAllEntries, markEntry } from "./entries"
+    beforeEach(() => {
-
+        vi.resetAllMocks()
-describe("entries", () => {
+    })
-    const mockClient = client as DeepMockProxy<typeof client>
+
-
+    it("loads entries", async () => {
-    beforeEach(() => {
+        vi.mocked(client.feed.getEntries).mockResolvedValue({
-        mockReset(mockClient)
+            data: {
-    })
+                entries: [{ id: "3" } as Entry],
-
+                hasMore: false,
-    it("loads entries", async () => {
+                name: "my-feed",
-        mockClient.feed.getEntries.mockResolvedValue({
+                errorCount: 3,
-            data: {
+                feedLink: "https://mysite.com/feed",
-                entries: [{ id: "3" } as Entry],
+                timestamp: 123,
-                hasMore: false,
+                ignoredReadStatus: false,
-                name: "my-feed",
+            },
-                errorCount: 3,
+        } as AxiosResponse<Entries>)
-                feedLink: "https://mysite.com/feed",
+
-                timestamp: 123,
+        const store = configureStore({ reducer: reducers })
-                ignoredReadStatus: false,
+        const promise = store.dispatch(loadEntries({ source: { type: "feed", id: "feed-id" }, clearSearch: true }))
-            },
+
-        } as AxiosResponse<Entries>)
+        expect(store.getState().entries.source.type).toBe("feed")
-
+        expect(store.getState().entries.source.id).toBe("feed-id")
-        const store = configureStore({ reducer: reducers })
+        expect(store.getState().entries.entries).toStrictEqual([])
-        const promise = store.dispatch(loadEntries({ source: { type: "feed", id: "feed-id" }, clearSearch: true }))
+        expect(store.getState().entries.hasMore).toBe(true)
-
+        expect(store.getState().entries.sourceLabel).toBe("")
-        expect(store.getState().entries.source.type).toBe("feed")
+        expect(store.getState().entries.sourceWebsiteUrl).toBe("")
-        expect(store.getState().entries.source.id).toBe("feed-id")
+        expect(store.getState().entries.timestamp).toBeUndefined()
-        expect(store.getState().entries.entries).toStrictEqual([])
+
-        expect(store.getState().entries.hasMore).toBe(true)
+        await promise
-        expect(store.getState().entries.sourceLabel).toBe("")
+        expect(store.getState().entries.source.type).toBe("feed")
-        expect(store.getState().entries.sourceWebsiteUrl).toBe("")
+        expect(store.getState().entries.source.id).toBe("feed-id")
-        expect(store.getState().entries.timestamp).toBeUndefined()
+        expect(store.getState().entries.entries).toStrictEqual([{ id: "3" }])
-
+        expect(store.getState().entries.hasMore).toBe(false)
-        await promise
+        expect(store.getState().entries.sourceLabel).toBe("my-feed")
-        expect(store.getState().entries.source.type).toBe("feed")
+        expect(store.getState().entries.sourceWebsiteUrl).toBe("https://mysite.com/feed")
-        expect(store.getState().entries.source.id).toBe("feed-id")
+        expect(store.getState().entries.timestamp).toBe(123)
-        expect(store.getState().entries.entries).toStrictEqual([{ id: "3" }])
+    })
-        expect(store.getState().entries.hasMore).toBe(false)
+
-        expect(store.getState().entries.sourceLabel).toBe("my-feed")
+    it("loads more entries", async () => {
-        expect(store.getState().entries.sourceWebsiteUrl).toBe("https://mysite.com/feed")
+        vi.mocked(client.category.getEntries).mockResolvedValue({
-        expect(store.getState().entries.timestamp).toBe(123)
+            data: {
-    })
+                entries: [{ id: "4" } as Entry],
-
+                hasMore: false,
-    it("loads more entries", async () => {
+                name: "my-feed",
-        mockClient.category.getEntries.mockResolvedValue({
+                errorCount: 3,
-            data: {
+                feedLink: "https://mysite.com/feed",
-                entries: [{ id: "4" } as Entry],
+                timestamp: 123,
-                hasMore: false,
+                ignoredReadStatus: false,
-                name: "my-feed",
+            },
-                errorCount: 3,
+        } as AxiosResponse<Entries>)
-                feedLink: "https://mysite.com/feed",
+
-                timestamp: 123,
+        const store = configureStore({
-                ignoredReadStatus: false,
+            reducer: reducers,
-            },
+            preloadedState: {
-        } as AxiosResponse<Entries>)
+                entries: {
-
+                    source: {
-        const store = configureStore({
+                        type: "category",
-            reducer: reducers,
+                        id: "category-id",
-            preloadedState: {
+                    },
-                entries: {
+                    sourceLabel: "",
-                    source: {
+                    sourceWebsiteUrl: "",
-                        type: "category",
+                    entries: [{ id: "3" } as Entry],
-                        id: "category-id",
+                    hasMore: true,
-                    },
+                    loading: false,
-                    sourceLabel: "",
+                    scrollingToEntry: false,
-                    sourceWebsiteUrl: "",
+                },
-                    entries: [{ id: "3" } as Entry],
+            } as RootState,
-                    hasMore: true,
+        })
-                    scrollingToEntry: false,
+        const promise = store.dispatch(loadMoreEntries())
-                },
+
-            },
+        await promise
-        })
+        expect(store.getState().entries.entries).toStrictEqual([{ id: "3" }, { id: "4" }])
-        const promise = store.dispatch(loadMoreEntries())
+        expect(store.getState().entries.hasMore).toBe(false)
-
+    })
-        await promise
+
-        expect(store.getState().entries.entries).toStrictEqual([{ id: "3" }, { id: "4" }])
+    it("marks an entry as read", () => {
-        expect(store.getState().entries.hasMore).toBe(false)
+        const store = configureStore({
-    })
+            reducer: reducers,
-
+            preloadedState: {
-    it("marks an entry as read", async () => {
+                entries: {
-        const store = configureStore({
+                    source: {
-            reducer: reducers,
+                        type: "category",
-            preloadedState: {
+                        id: "category-id",
-                entries: {
+                    },
-                    source: {
+                    sourceLabel: "",
-                        type: "category",
+                    sourceWebsiteUrl: "",
-                        id: "category-id",
+                    entries: [{ id: "3", read: false } as Entry, { id: "4", read: false } as Entry],
-                    },
+                    hasMore: true,
-                    sourceLabel: "",
+                    loading: false,
-                    sourceWebsiteUrl: "",
+                    scrollingToEntry: false,
-                    entries: [{ id: "3", read: false } as Entry, { id: "4", read: false } as Entry],
+                },
-                    hasMore: true,
+            } as RootState,
-                    scrollingToEntry: false,
+        })
-                },
+
-            },
+        store.dispatch(markEntry({ entry: { id: "3" } as Entry, read: true }))
-        })
+        expect(store.getState().entries.entries).toStrictEqual([
-
+            { id: "3", read: true },
-        store.dispatch(markEntry({ entry: { id: "3" } as Entry, read: true }))
+            { id: "4", read: false },
-        expect(store.getState().entries.entries).toStrictEqual([
+        ])
-            { id: "3", read: true },
+        expect(client.entry.mark).toHaveBeenCalledWith({ id: "3", read: true })
-            { id: "4", read: false },
+    })
-        ])
+
-        expect(mockClient.entry.mark).toHaveBeenCalledWith({ id: "3", read: true })
+    it("marks all entries as read", () => {
-    })
+        const store = configureStore({
-
+            reducer: reducers,
-    it("marks all entries as read", async () => {
+            preloadedState: {
-        const store = configureStore({
+                entries: {
-            reducer: reducers,
+                    source: {
-            preloadedState: {
+                        type: "category",
-                entries: {
+                        id: "category-id",
-                    source: {
+                    },
-                        type: "category",
+                    sourceLabel: "",
-                        id: "category-id",
+                    sourceWebsiteUrl: "",
-                    },
+                    entries: [{ id: "3", read: false } as Entry, { id: "4", read: false } as Entry],
-                    sourceLabel: "",
+                    hasMore: true,
-                    sourceWebsiteUrl: "",
+                    loading: false,
-                    entries: [{ id: "3", read: false } as Entry, { id: "4", read: false } as Entry],
+                    scrollingToEntry: false,
-                    hasMore: true,
+                },
-                    scrollingToEntry: false,
+            } as RootState,
-                },
+        })
-            },
+
-        })
+        store.dispatch(markAllEntries({ sourceType: "category", req: { id: "all", read: true } }))
-
+        expect(store.getState().entries.entries).toStrictEqual([
-        store.dispatch(markAllEntries({ sourceType: "category", req: { id: "all", read: true } }))
+            { id: "3", read: true },
-        expect(store.getState().entries.entries).toStrictEqual([
+            { id: "4", read: true },
-            { id: "3", read: true },
+        ])
-            { id: "4", read: true },
+        expect(client.category.markEntries).toHaveBeenCalledWith({ id: "all", read: true })
-        ])
+    })
-        expect(mockClient.category.markEntries).toHaveBeenCalledWith({ id: "all", read: true })
+})
-    })
-})

commafeed-client/src/app/entries/slice.ts

@@ -0,0 +1,122 @@
+import { type PayloadAction, createSlice } from "@reduxjs/toolkit"
+import { Constants } from "app/constants"
+import { loadEntries, loadMoreEntries, markAllEntries, markEntry, markMultipleEntries, starEntry, tagEntry } from "app/entries/thunks"
+import type { Entry } from "app/types"
+
+export type EntrySourceType = "category" | "feed" | "tag"
+
+export interface EntrySource {
+    type: EntrySourceType
+    id: string
+}
+
+export type ExpendableEntry = Entry & { expanded?: boolean }
+
+interface EntriesState {
+    /** selected source */
+    source: EntrySource
+    sourceLabel: string
+    sourceWebsiteUrl: string
+    entries: ExpendableEntry[]
+    /** stores when the first batch of entries were retrieved
+     *
+     * this is used when marking all entries of a feed/category to only mark entries up to that timestamp as newer entries were potentially never shown
+     */
+    timestamp?: number
+    selectedEntryId?: string
+    hasMore: boolean
+    loading: boolean
+    search?: string
+    scrollingToEntry: boolean
+}
+
+const initialState: EntriesState = {
+    source: {
+        type: "category",
+        id: Constants.categories.all.id,
+    },
+    sourceLabel: "",
+    sourceWebsiteUrl: "",
+    entries: [],
+    hasMore: true,
+    loading: false,
+    scrollingToEntry: false,
+}
+
+export const entriesSlice = createSlice({
+    name: "entries",
+    initialState,
+    reducers: {
+        setSelectedEntry: (state, action: PayloadAction<Entry>) => {
+            state.selectedEntryId = action.payload.id
+        },
+        setEntryExpanded: (state, action: PayloadAction<{ entry: Entry; expanded: boolean }>) => {
+            for (const e of state.entries.filter(e => e.id === action.payload.entry.id)) {
+                e.expanded = action.payload.expanded
+            }
+        },
+        setScrollingToEntry: (state, action: PayloadAction<boolean>) => {
+            state.scrollingToEntry = action.payload
+        },
+        setSearch: (state, action: PayloadAction<string>) => {
+            state.search = action.payload
+        },
+    },
+    extraReducers: builder => {
+        builder.addCase(markEntry.pending, (state, action) => {
+            for (const e of state.entries.filter(e => e.id === action.meta.arg.entry.id)) {
+                e.read = action.meta.arg.read
+            }
+        })
+        builder.addCase(markMultipleEntries.pending, (state, action) => {
+            for (const e of state.entries.filter(e => action.meta.arg.entries.some(e2 => e2.id === e.id))) {
+                e.read = action.meta.arg.read
+            }
+        })
+        builder.addCase(markAllEntries.pending, (state, action) => {
+            for (const e of state.entries.filter(e => (action.meta.arg.req.olderThan ? e.date < action.meta.arg.req.olderThan : true))) {
+                e.read = true
+            }
+        })
+        builder.addCase(starEntry.pending, (state, action) => {
+            for (const e of state.entries.filter(e => action.meta.arg.entry.id === e.id && action.meta.arg.entry.feedId === e.feedId)) {
+                e.starred = action.meta.arg.starred
+            }
+        })
+        builder.addCase(loadEntries.pending, (state, action) => {
+            state.source = action.meta.arg.source
+            state.entries = []
+            state.timestamp = undefined
+            state.sourceLabel = ""
+            state.sourceWebsiteUrl = ""
+            state.hasMore = true
+            state.selectedEntryId = undefined
+            state.loading = true
+        })
+        builder.addCase(loadMoreEntries.pending, state => {
+            state.loading = true
+        })
+        builder.addCase(loadEntries.fulfilled, (state, action) => {
+            state.entries = action.payload.entries
+            state.timestamp = action.payload.timestamp
+            state.sourceLabel = action.payload.name
+            state.sourceWebsiteUrl = action.payload.feedLink
+            state.hasMore = action.payload.hasMore
+            state.loading = false
+        })
+        builder.addCase(loadMoreEntries.fulfilled, (state, action) => {
+            // remove already existing entries
+            const entriesToAdd = action.payload.entries.filter(e => !state.entries.some(e2 => e.id === e2.id))
+            state.entries = [...state.entries, ...entriesToAdd]
+            state.hasMore = action.payload.hasMore
+            state.loading = false
+        })
+        builder.addCase(tagEntry.pending, (state, action) => {
+            for (const e of state.entries.filter(e => +e.id === action.meta.arg.entryId)) {
+                e.tags = action.meta.arg.tags
+            }
+        })
+    },
+})
+
+export const { setSearch } = entriesSlice.actions

commafeed-client/src/app/entries/thunks.ts

@@ -0,0 +1,281 @@
+import { createAppAsyncThunk } from "app/async-thunk"
+import { client } from "app/client"
+import { Constants } from "app/constants"
+import { type EntrySource, type EntrySourceType, entriesSlice, setSearch } from "app/entries/slice"
+import type { RootState } from "app/store"
+import { reloadTree } from "app/tree/thunks"
+import type { Entry, MarkRequest, TagRequest } from "app/types"
+import { reloadTags } from "app/user/thunks"
+import { scrollToWithCallback } from "app/utils"
+import { flushSync } from "react-dom"
+
+const getEndpoint = (sourceType: EntrySourceType) =>
+    sourceType === "category" || sourceType === "tag" ? client.category.getEntries : client.feed.getEntries
+
+export const loadEntries = createAppAsyncThunk(
+    "entries/load",
+    async (
+        arg: {
+            source: EntrySource
+            clearSearch: boolean
+        },
+        thunkApi
+    ) => {
+        if (arg.clearSearch) thunkApi.dispatch(setSearch(""))
+
+        const state = thunkApi.getState()
+        const endpoint = getEndpoint(arg.source.type)
+        const result = await endpoint(buildGetEntriesPaginatedRequest(state, arg.source, 0))
+        return result.data
+    }
+)
+
+export const loadMoreEntries = createAppAsyncThunk("entries/loadMore", async (_, thunkApi) => {
+    const state = thunkApi.getState()
+    const { source } = state.entries
+    const offset =
+        state.user.settings?.readingMode === "all" ? state.entries.entries.length : state.entries.entries.filter(e => !e.read).length
+    const endpoint = getEndpoint(state.entries.source.type)
+    const result = await endpoint(buildGetEntriesPaginatedRequest(state, source, offset))
+    return result.data
+})
+
+const buildGetEntriesPaginatedRequest = (state: RootState, source: EntrySource, offset: number) => ({
+    id: source.type === "tag" ? Constants.categories.all.id : source.id,
+    order: state.user.settings?.readingOrder,
+    readType: state.entries.search ? "all" : state.user.settings?.readingMode,
+    offset,
+    limit: 50,
+    tag: source.type === "tag" ? source.id : undefined,
+    keywords: state.entries.search,
+})
+
+export const reloadEntries = createAppAsyncThunk("entries/reload", (arg, thunkApi) => {
+    const state = thunkApi.getState()
+    thunkApi.dispatch(loadEntries({ source: state.entries.source, clearSearch: false }))
+})
+
+export const search = createAppAsyncThunk("entries/search", (arg: string, thunkApi) => {
+    const state = thunkApi.getState()
+    thunkApi.dispatch(setSearch(arg))
+    thunkApi.dispatch(loadEntries({ source: state.entries.source, clearSearch: false }))
+})
+
+export const markEntry = createAppAsyncThunk(
+    "entries/entry/mark",
+    (arg: { entry: Entry; read: boolean }) => {
+        client.entry.mark({
+            id: arg.entry.id,
+            read: arg.read,
+        })
+    },
+    {
+        condition: arg => arg.entry.markable && arg.entry.read !== arg.read,
+    }
+)
+
+export const markMultipleEntries = createAppAsyncThunk(
+    "entries/entry/markMultiple",
+    async (
+        arg: {
+            entries: Entry[]
+            read: boolean
+        },
+        thunkApi
+    ) => {
+        const requests: MarkRequest[] = arg.entries.map(e => ({
+            id: e.id,
+            read: arg.read,
+        }))
+        await client.entry.markMultiple({ requests })
+        thunkApi.dispatch(reloadTree())
+    }
+)
+
+export const markEntriesUpToEntry = createAppAsyncThunk("entries/entry/upToEntry", (arg: Entry, thunkApi) => {
+    const state = thunkApi.getState()
+    const { entries } = state.entries
+
+    const index = entries.findIndex(e => e.id === arg.id)
+    if (index === -1) return
+
+    thunkApi.dispatch(
+        markMultipleEntries({
+            entries: entries.slice(0, index + 1),
+            read: true,
+        })
+    )
+})
+
+export const markAllEntries = createAppAsyncThunk(
+    "entries/entry/markAll",
+    async (
+        arg: {
+            sourceType: EntrySourceType
+            req: MarkRequest
+        },
+        thunkApi
+    ) => {
+        const endpoint = arg.sourceType === "category" ? client.category.markEntries : client.feed.markEntries
+        await endpoint(arg.req)
+        thunkApi.dispatch(reloadEntries())
+        thunkApi.dispatch(reloadTree())
+    }
+)
+
+export const starEntry = createAppAsyncThunk(
+    "entries/entry/star",
+    (arg: { entry: Entry; starred: boolean }) => {
+        client.entry.star({
+            id: arg.entry.id,
+            feedId: +arg.entry.feedId,
+            starred: arg.starred,
+        })
+    },
+    {
+        condition: arg => arg.entry.markable && arg.entry.starred !== arg.starred,
+    }
+)
+
+export const selectEntry = createAppAsyncThunk(
+    "entries/entry/select",
+    (
+        arg: {
+            entry: Entry
+            expand: boolean
+            markAsRead: boolean
+            scrollToEntry: boolean
+        },
+        thunkApi
+    ) => {
+        const state = thunkApi.getState()
+        const entry = state.entries.entries.find(e => e.id === arg.entry.id)
+        if (!entry) return
+
+        // flushSync is required because we need the newly selected entry to be expanded
+        // and the previously selected entry to be collapsed to be able to scroll to the right position
+        flushSync(() => {
+            // mark as read if requested
+            if (arg.markAsRead) {
+                thunkApi.dispatch(markEntry({ entry, read: true }))
+            }
+
+            // set entry as selected
+            thunkApi.dispatch(entriesSlice.actions.setSelectedEntry(entry))
+
+            // expand if requested
+            const previouslySelectedEntry = state.entries.entries.find(e => e.id === state.entries.selectedEntryId)
+            if (previouslySelectedEntry) {
+                thunkApi.dispatch(
+                    entriesSlice.actions.setEntryExpanded({
+                        entry: previouslySelectedEntry,
+                        expanded: false,
+                    })
+                )
+            }
+            thunkApi.dispatch(entriesSlice.actions.setEntryExpanded({ entry, expanded: arg.expand }))
+        })
+
+        if (arg.scrollToEntry) {
+            const viewMode = state.user.localSettings.viewMode
+
+            const entryIndex = state.entries.entries.indexOf(entry)
+            const entriesToKeepOnTopWhenScrolling =
+                viewMode === "expanded" ? 0 : Math.min(state.user.settings?.entriesToKeepOnTopWhenScrolling ?? 0, entryIndex)
+            const entryToScrollTo = state.entries.entries[entryIndex - entriesToKeepOnTopWhenScrolling]
+
+            const entryElement = document.getElementById(Constants.dom.entryId(entry))
+            const entryElementToScrollTo = document.getElementById(Constants.dom.entryId(entryToScrollTo))
+            if (entryElement && entryElementToScrollTo) {
+                const scrollMode = state.user.settings?.scrollMode
+                const entryEntirelyVisible =
+                    Constants.layout.isTopVisible(entryElementToScrollTo) && Constants.layout.isBottomVisible(entryElement)
+                if (scrollMode === "always" || (scrollMode === "if_needed" && !entryEntirelyVisible)) {
+                    const scrollSpeed = state.user.settings?.scrollSpeed
+                    const margin = viewMode === "detailed" ? 8 : 3
+                    thunkApi.dispatch(entriesSlice.actions.setScrollingToEntry(true))
+                    scrollToEntry(entryElementToScrollTo, margin, scrollSpeed, () =>
+                        thunkApi.dispatch(entriesSlice.actions.setScrollingToEntry(false))
+                    )
+                }
+            }
+        }
+    }
+)
+
+const scrollToEntry = (entryElement: HTMLElement, margin: number, scrollSpeed: number | undefined, onScrollEnded: () => void) => {
+    const header = document.getElementById(Constants.dom.headerId)?.getBoundingClientRect()
+    const offset = (header?.bottom ?? 0) + margin
+    scrollToWithCallback({
+        options: {
+            top: entryElement.offsetTop - offset,
+            behavior: scrollSpeed && scrollSpeed > 0 ? "smooth" : "auto",
+        },
+        onScrollEnded,
+    })
+}
+
+export const selectPreviousEntry = createAppAsyncThunk(
+    "entries/entry/selectPrevious",
+    (
+        arg: {
+            expand: boolean
+            markAsRead: boolean
+            scrollToEntry: boolean
+        },
+        thunkApi
+    ) => {
+        const state = thunkApi.getState()
+        const { entries } = state.entries
+        const previousIndex = entries.findIndex(e => e.id === state.entries.selectedEntryId) - 1
+        if (previousIndex >= 0) {
+            thunkApi.dispatch(
+                selectEntry({
+                    entry: entries[previousIndex],
+                    expand: arg.expand,
+                    markAsRead: arg.markAsRead,
+                    scrollToEntry: arg.scrollToEntry,
+                })
+            )
+        }
+    }
+)
+
+export const selectNextEntry = createAppAsyncThunk(
+    "entries/entry/selectNext",
+    async (
+        arg: {
+            expand: boolean
+            markAsRead: boolean
+            scrollToEntry: boolean
+        },
+        thunkApi
+    ) => {
+        const state = thunkApi.getState()
+        const { entries, hasMore, loading } = state.entries
+        const nextIndex = entries.findIndex(e => e.id === state.entries.selectedEntryId) + 1
+
+        // load more entries if needed
+        // this can happen if the last entry is too large to fit on the screen and the infinite loader doesn't trigger
+        if (nextIndex >= entries.length && hasMore && !loading) {
+            await thunkApi.dispatch(loadMoreEntries())
+        }
+
+        const entriesAfterLoading = thunkApi.getState().entries.entries
+        if (nextIndex < entriesAfterLoading.length) {
+            thunkApi.dispatch(
+                selectEntry({
+                    entry: entriesAfterLoading[nextIndex],
+                    expand: arg.expand,
+                    markAsRead: arg.markAsRead,
+                    scrollToEntry: arg.scrollToEntry,
+                })
+            )
+        }
+    }
+)
+
+export const tagEntry = createAppAsyncThunk("entries/entry/tag", async (arg: TagRequest, thunkApi) => {
+    await client.entry.tag(arg)
+    thunkApi.dispatch(reloadTags())
+})

commafeed-client/src/app/redirect/redirect.test.ts

@@ -1,10 +1,10 @@
-import { store } from "app/store"
+import { redirectToCategory } from "app/redirect/thunks"
-import { describe, expect, it } from "vitest"
+import { store } from "app/store"
-import { redirectToCategory } from "./redirect"
+import { describe, expect, it } from "vitest"
-
+
-describe("redirects", () => {
+describe("redirects", () => {
-    it("redirects to category", async () => {
+    it("redirects to category", async () => {
-        await store.dispatch(redirectToCategory("1"))
+        await store.dispatch(redirectToCategory("1"))
-        expect(store.getState().redirect.to).toBe("/app/category/1")
+        expect(store.getState().redirect.to).toBe("/app/category/1")
-    })
+    })
-})
+})

commafeed-client/src/app/redirect/slice.ts

@@ -0,0 +1,19 @@
+import { type PayloadAction, createSlice } from "@reduxjs/toolkit"
+
+interface RedirectState {
+    to?: string
+}
+
+const initialState: RedirectState = {}
+
+export const redirectSlice = createSlice({
+    name: "redirect",
+    initialState,
+    reducers: {
+        redirectTo: (state, action: PayloadAction<string | undefined>) => {
+            state.to = action.payload
+        },
+    },
+})
+
+export const { redirectTo } = redirectSlice.actions

commafeed-client/src/app/redirect/thunks.ts

@@ -0,0 +1,57 @@
+import { createAppAsyncThunk } from "app/async-thunk"
+import { Constants } from "app/constants"
+import { redirectTo } from "app/redirect/slice"
+
+export const redirectToLogin = createAppAsyncThunk("redirect/login", (_, thunkApi) => thunkApi.dispatch(redirectTo("/login")))
+
+export const redirectToRegistration = createAppAsyncThunk("redirect/register", (_, thunkApi) => thunkApi.dispatch(redirectTo("/register")))
+
+export const redirectToApiDocumentation = createAppAsyncThunk("redirect/api", (_, thunkApi) => thunkApi.dispatch(redirectTo("/api")))
+
+export const redirectToSelectedSource = createAppAsyncThunk("redirect/selectedSource", (_, thunkApi) => {
+    const { source } = thunkApi.getState().entries
+    thunkApi.dispatch(redirectTo(`/app/${source.type}/${source.id}`))
+})
+
+export const redirectToCategory = createAppAsyncThunk("redirect/category", (id: string, thunkApi) =>
+    thunkApi.dispatch(redirectTo(`/app/category/${id}`))
+)
+
+export const redirectToRootCategory = createAppAsyncThunk(
+    "redirect/category/root",
+    async (_, thunkApi) => await thunkApi.dispatch(redirectToCategory(Constants.categories.all.id))
+)
+
+export const redirectToCategoryDetails = createAppAsyncThunk("redirect/category/details", (id: string, thunkApi) =>
+    thunkApi.dispatch(redirectTo(`/app/category/${id}/details`))
+)
+
+export const redirectToFeed = createAppAsyncThunk("redirect/feed", (id: string | number, thunkApi) =>
+    thunkApi.dispatch(redirectTo(`/app/feed/${id}`))
+)
+
+export const redirectToFeedDetails = createAppAsyncThunk("redirect/feed/details", (id: string, thunkApi) =>
+    thunkApi.dispatch(redirectTo(`/app/feed/${id}/details`))
+)
+
+export const redirectToTag = createAppAsyncThunk("redirect/tag", (id: string, thunkApi) => thunkApi.dispatch(redirectTo(`/app/tag/${id}`)))
+
+export const redirectToTagDetails = createAppAsyncThunk("redirect/tag/details", (id: string, thunkApi) =>
+    thunkApi.dispatch(redirectTo(`/app/tag/${id}/details`))
+)
+
+export const redirectToAdd = createAppAsyncThunk("redirect/add", (_, thunkApi) => thunkApi.dispatch(redirectTo("/app/add")))
+
+export const redirectToSettings = createAppAsyncThunk("redirect/settings", (_, thunkApi) => thunkApi.dispatch(redirectTo("/app/settings")))
+
+export const redirectToAdminUsers = createAppAsyncThunk("redirect/admin/users", (_, thunkApi) =>
+    thunkApi.dispatch(redirectTo("/app/admin/users"))
+)
+
+export const redirectToMetrics = createAppAsyncThunk("redirect/admin/metrics", (_, thunkApi) =>
+    thunkApi.dispatch(redirectTo("/app/admin/metrics"))
+)
+
+export const redirectToDonate = createAppAsyncThunk("redirect/donate", (_, thunkApi) => thunkApi.dispatch(redirectTo("/app/donate")))
+
+export const redirectToAbout = createAppAsyncThunk("redirect/about", (_, thunkApi) => thunkApi.dispatch(redirectTo("/app/about")))

commafeed-client/src/app/server/slice.ts

@@ -0,0 +1,29 @@
+import { type PayloadAction, createSlice } from "@reduxjs/toolkit"
+import { reloadServerInfos } from "app/server/thunks"
+import type { ServerInfo } from "app/types"
+
+interface ServerState {
+    serverInfos?: ServerInfo
+    webSocketConnected: boolean
+}
+
+const initialState: ServerState = {
+    webSocketConnected: false,
+}
+
+export const serverSlice = createSlice({
+    name: "server",
+    initialState,
+    reducers: {
+        setWebSocketConnected: (state, action: PayloadAction<boolean>) => {
+            state.webSocketConnected = action.payload
+        },
+    },
+    extraReducers: builder => {
+        builder.addCase(reloadServerInfos.fulfilled, (state, action) => {
+            state.serverInfos = action.payload
+        })
+    },
+})
+
+export const { setWebSocketConnected } = serverSlice.actions

commafeed-client/src/app/server/thunks.ts

@@ -0,0 +1,4 @@
+import { createAppAsyncThunk } from "app/async-thunk"
+import { client } from "app/client"
+
+export const reloadServerInfos = createAppAsyncThunk("server/infos", async () => await client.server.getServerInfos().then(r => r.data))

commafeed-client/src/app/slices/entries.ts

@@ -1,339 +0,0 @@
-import { createAsyncThunk, createSlice, PayloadAction } from "@reduxjs/toolkit"
-import { client } from "app/client"
-import { Constants } from "app/constants"
-import { RootState } from "app/store"
-import { Entries, Entry, MarkRequest, TagRequest } from "app/types"
-import { scrollToWithCallback } from "app/utils"
-import { flushSync } from "react-dom"
-// eslint-disable-next-line import/no-cycle
-import { reloadTree } from "./tree"
-// eslint-disable-next-line import/no-cycle
-import { reloadTags } from "./user"
-
-export type EntrySourceType = "category" | "feed" | "tag"
-export type EntrySource = { type: EntrySourceType; id: string }
-export type ExpendableEntry = Entry & { expanded?: boolean }
-
-interface EntriesState {
-    /** selected source */
-    source: EntrySource
-    sourceLabel: string
-    sourceWebsiteUrl: string
-    entries: ExpendableEntry[]
-    /** stores when the first batch of entries were retrieved
-     *
-     * this is used when marking all entries of a feed/category to only mark entries up to that timestamp as newer entries were potentially never shown
-     */
-    timestamp?: number
-    selectedEntryId?: string
-    hasMore: boolean
-    search?: string
-    scrollingToEntry: boolean
-}
-
-const initialState: EntriesState = {
-    source: {
-        type: "category",
-        id: Constants.categories.all.id,
-    },
-    sourceLabel: "",
-    sourceWebsiteUrl: "",
-    entries: [],
-    hasMore: true,
-    scrollingToEntry: false,
-}
-
-const getEndpoint = (sourceType: EntrySourceType) =>
-    sourceType === "category" || sourceType === "tag" ? client.category.getEntries : client.feed.getEntries
-export const loadEntries = createAsyncThunk<Entries, { source: EntrySource; clearSearch: boolean }, { state: RootState }>(
-    "entries/load",
-    async (arg, thunkApi) => {
-        if (arg.clearSearch) thunkApi.dispatch(setSearch(""))
-
-        const state = thunkApi.getState()
-        const endpoint = getEndpoint(arg.source.type)
-        const result = await endpoint(buildGetEntriesPaginatedRequest(state, arg.source, 0))
-        return result.data
-    }
-)
-export const loadMoreEntries = createAsyncThunk<Entries, void, { state: RootState }>("entries/loadMore", async (_, thunkApi) => {
-    const state = thunkApi.getState()
-    const { source } = state.entries
-    const offset =
-        state.user.settings?.readingMode === "all" ? state.entries.entries.length : state.entries.entries.filter(e => !e.read).length
-    const endpoint = getEndpoint(state.entries.source.type)
-    const result = await endpoint(buildGetEntriesPaginatedRequest(state, source, offset))
-    return result.data
-})
-const buildGetEntriesPaginatedRequest = (state: RootState, source: EntrySource, offset: number) => ({
-    id: source.type === "tag" ? Constants.categories.all.id : source.id,
-    order: state.user.settings?.readingOrder,
-    readType: state.user.settings?.readingMode,
-    offset,
-    limit: 50,
-    tag: source.type === "tag" ? source.id : undefined,
-    keywords: state.entries.search,
-})
-export const reloadEntries = createAsyncThunk<void, void, { state: RootState }>("entries/reload", async (arg, thunkApi) => {
-    const state = thunkApi.getState()
-    thunkApi.dispatch(loadEntries({ source: state.entries.source, clearSearch: false }))
-})
-export const search = createAsyncThunk<void, string, { state: RootState }>("entries/search", async (arg, thunkApi) => {
-    const state = thunkApi.getState()
-    thunkApi.dispatch(setSearch(arg))
-    thunkApi.dispatch(loadEntries({ source: state.entries.source, clearSearch: false }))
-})
-export const markEntry = createAsyncThunk(
-    "entries/entry/mark",
-    (arg: { entry: Entry; read: boolean }) => {
-        client.entry.mark({
-            id: arg.entry.id,
-            read: arg.read,
-        })
-    },
-    {
-        condition: arg => arg.entry.read !== arg.read,
-    }
-)
-export const markMultipleEntries = createAsyncThunk(
-    "entries/entry/markMultiple",
-    async (arg: { entries: Entry[]; read: boolean }, thunkApi) => {
-        const requests: MarkRequest[] = arg.entries.map(e => ({
-            id: e.id,
-            read: arg.read,
-        }))
-        await client.entry.markMultiple({ requests })
-        thunkApi.dispatch(reloadTree())
-    }
-)
-export const markEntriesUpToEntry = createAsyncThunk<void, Entry, { state: RootState }>(
-    "entries/entry/upToEntry",
-    async (arg, thunkApi) => {
-        const state = thunkApi.getState()
-        const { entries } = state.entries
-
-        const index = entries.findIndex(e => e.id === arg.id)
-        if (index === -1) return
-
-        thunkApi.dispatch(
-            markMultipleEntries({
-                entries: entries.slice(0, index + 1),
-                read: true,
-            })
-        )
-    }
-)
-export const markAllEntries = createAsyncThunk<void, { sourceType: EntrySourceType; req: MarkRequest }, { state: RootState }>(
-    "entries/entry/markAll",
-    async (arg, thunkApi) => {
-        const endpoint = arg.sourceType === "category" ? client.category.markEntries : client.feed.markEntries
-        await endpoint(arg.req)
-        thunkApi.dispatch(reloadEntries())
-        thunkApi.dispatch(reloadTree())
-    }
-)
-export const starEntry = createAsyncThunk("entries/entry/star", (arg: { entry: Entry; starred: boolean }) => {
-    client.entry.star({
-        id: arg.entry.id,
-        feedId: +arg.entry.feedId,
-        starred: arg.starred,
-    })
-})
-export const selectEntry = createAsyncThunk<
-    void,
-    {
-        entry: Entry
-        expand: boolean
-        markAsRead: boolean
-        scrollToEntry: boolean
-    },
-    { state: RootState }
->("entries/entry/select", (arg, thunkApi) => {
-    const state = thunkApi.getState()
-    const entry = state.entries.entries.find(e => e.id === arg.entry.id)
-    if (!entry) return
-
-    // flushSync is required because we need the newly selected entry to be expanded
-    // and the previously selected entry to be collapsed to be able to scroll to the right position
-    flushSync(() => {
-        // mark as read if requested
-        if (arg.markAsRead) {
-            thunkApi.dispatch(markEntry({ entry, read: true }))
-        }
-
-        // set entry as selected
-        thunkApi.dispatch(entriesSlice.actions.setSelectedEntry(entry))
-
-        // expand if requested
-        const previouslySelectedEntry = state.entries.entries.find(e => e.id === state.entries.selectedEntryId)
-        if (previouslySelectedEntry) {
-            thunkApi.dispatch(entriesSlice.actions.setEntryExpanded({ entry: previouslySelectedEntry, expanded: false }))
-        }
-        thunkApi.dispatch(entriesSlice.actions.setEntryExpanded({ entry, expanded: arg.expand }))
-    })
-
-    if (arg.scrollToEntry) {
-        const entryElement = document.getElementById(Constants.dom.entryId(entry))
-        if (entryElement) {
-            const scrollSpeed = state.user.settings?.scrollSpeed
-            thunkApi.dispatch(entriesSlice.actions.setScrollingToEntry(true))
-            scrollToEntry(entryElement, scrollSpeed, () => thunkApi.dispatch(entriesSlice.actions.setScrollingToEntry(false)))
-        }
-    }
-})
-const scrollToEntry = (entryElement: HTMLElement, scrollSpeed: number | undefined, onScrollEnded: () => void) => {
-    // the entry is entirely visible, no need to scroll
-    if (Constants.layout.isTopVisible(entryElement) && Constants.layout.isBottomVisible(entryElement)) {
-        onScrollEnded()
-        return
-    }
-
-    const scrollArea = document.getElementById(Constants.dom.mainScrollAreaId)
-    if (scrollArea) {
-        scrollToWithCallback({
-            element: scrollArea,
-            options: {
-                // add a small gap between the top of the content and the top of the page
-                top: entryElement.offsetTop - 3,
-                behavior: scrollSpeed && scrollSpeed > 0 ? "smooth" : "auto",
-            },
-            onScrollEnded,
-        })
-    }
-}
-
-export const selectPreviousEntry = createAsyncThunk<
-    void,
-    {
-        expand: boolean
-        markAsRead: boolean
-        scrollToEntry: boolean
-    },
-    { state: RootState }
->("entries/entry/selectPrevious", (arg, thunkApi) => {
-    const state = thunkApi.getState()
-    const { entries } = state.entries
-    const previousIndex = entries.findIndex(e => e.id === state.entries.selectedEntryId) - 1
-    if (previousIndex >= 0) {
-        thunkApi.dispatch(
-            selectEntry({
-                entry: entries[previousIndex],
-                expand: arg.expand,
-                markAsRead: arg.markAsRead,
-                scrollToEntry: arg.scrollToEntry,
-            })
-        )
-    }
-})
-export const selectNextEntry = createAsyncThunk<
-    void,
-    {
-        expand: boolean
-        markAsRead: boolean
-        scrollToEntry: boolean
-    },
-    { state: RootState }
->("entries/entry/selectNext", (arg, thunkApi) => {
-    const state = thunkApi.getState()
-    const { entries } = state.entries
-    const nextIndex = entries.findIndex(e => e.id === state.entries.selectedEntryId) + 1
-    if (nextIndex < entries.length) {
-        thunkApi.dispatch(
-            selectEntry({
-                entry: entries[nextIndex],
-                expand: arg.expand,
-                markAsRead: arg.markAsRead,
-                scrollToEntry: arg.scrollToEntry,
-            })
-        )
-    }
-})
-export const tagEntry = createAsyncThunk<void, TagRequest, { state: RootState }>("entries/entry/tag", async (arg, thunkApi) => {
-    await client.entry.tag(arg)
-    thunkApi.dispatch(reloadTags())
-})
-
-export const entriesSlice = createSlice({
-    name: "entries",
-    initialState,
-    reducers: {
-        setSelectedEntry: (state, action: PayloadAction<Entry>) => {
-            state.selectedEntryId = action.payload.id
-        },
-        setEntryExpanded: (state, action: PayloadAction<{ entry: Entry; expanded: boolean }>) => {
-            state.entries
-                .filter(e => e.id === action.payload.entry.id)
-                .forEach(e => {
-                    e.expanded = action.payload.expanded
-                })
-        },
-        setScrollingToEntry: (state, action: PayloadAction<boolean>) => {
-            state.scrollingToEntry = action.payload
-        },
-        setSearch: (state, action: PayloadAction<string>) => {
-            state.search = action.payload
-        },
-    },
-    extraReducers: builder => {
-        builder.addCase(markEntry.pending, (state, action) => {
-            state.entries
-                .filter(e => e.id === action.meta.arg.entry.id)
-                .forEach(e => {
-                    e.read = action.meta.arg.read
-                })
-        })
-        builder.addCase(markMultipleEntries.pending, (state, action) => {
-            state.entries
-                .filter(e => action.meta.arg.entries.some(e2 => e2.id === e.id))
-                .forEach(e => {
-                    e.read = action.meta.arg.read
-                })
-        })
-        builder.addCase(markAllEntries.pending, (state, action) => {
-            state.entries
-                .filter(e => (action.meta.arg.req.olderThan ? e.date < action.meta.arg.req.olderThan : true))
-                .forEach(e => {
-                    e.read = true
-                })
-        })
-        builder.addCase(starEntry.pending, (state, action) => {
-            state.entries
-                .filter(e => action.meta.arg.entry.id === e.id && action.meta.arg.entry.feedId === e.feedId)
-                .forEach(e => {
-                    e.starred = action.meta.arg.starred
-                })
-        })
-        builder.addCase(loadEntries.pending, (state, action) => {
-            state.source = action.meta.arg.source
-            state.entries = []
-            state.timestamp = undefined
-            state.sourceLabel = ""
-            state.sourceWebsiteUrl = ""
-            state.hasMore = true
-            state.selectedEntryId = undefined
-        })
-        builder.addCase(loadEntries.fulfilled, (state, action) => {
-            state.entries = action.payload.entries
-            state.timestamp = action.payload.timestamp
-            state.sourceLabel = action.payload.name
-            state.sourceWebsiteUrl = action.payload.feedLink
-            state.hasMore = action.payload.hasMore
-        })
-        builder.addCase(loadMoreEntries.fulfilled, (state, action) => {
-            // remove already existing entries
-            const entriesToAdd = action.payload.entries.filter(e => !state.entries.some(e2 => e.id === e2.id))
-            state.entries = [...state.entries, ...entriesToAdd]
-            state.hasMore = action.payload.hasMore
-        })
-        builder.addCase(tagEntry.pending, (state, action) => {
-            state.entries
-                .filter(e => +e.id === action.meta.arg.entryId)
-                .forEach(e => {
-                    e.tags = action.meta.arg.tags
-                })
-        })
-    },
-})
-
-export const { setSearch } = entriesSlice.actions
-export default entriesSlice.reducer

commafeed-client/src/app/slices/redirect.ts

@@ -1,61 +0,0 @@
-import { createAsyncThunk, createSlice, PayloadAction } from "@reduxjs/toolkit"
-import { Constants } from "app/constants"
-import { RootState } from "app/store"
-
-interface RedirectState {
-    to?: string
-}
-
-const initialState: RedirectState = {}
-
-export const redirectToLogin = createAsyncThunk("redirect/login", (_, thunkApi) => thunkApi.dispatch(redirectTo("/login")))
-export const redirectToRegistration = createAsyncThunk("redirect/register", (_, thunkApi) => thunkApi.dispatch(redirectTo("/register")))
-export const redirectToPasswordRecovery = createAsyncThunk("redirect/passwordRecovery", (_, thunkApi) =>
-    thunkApi.dispatch(redirectTo("/passwordRecovery"))
-)
-export const redirectToSelectedSource = createAsyncThunk<void, void, { state: RootState }>("redirect/selectedSource", (_, thunkApi) => {
-    const { source } = thunkApi.getState().entries
-    thunkApi.dispatch(redirectTo(`/app/${source.type}/${source.id}`))
-})
-export const redirectToCategory = createAsyncThunk("redirect/category", (id: string, thunkApi) =>
-    thunkApi.dispatch(redirectTo(`/app/category/${id}`))
-)
-export const redirectToRootCategory = createAsyncThunk("redirect/category/root", (_, thunkApi) =>
-    thunkApi.dispatch(redirectToCategory(Constants.categories.all.id))
-)
-export const redirectToCategoryDetails = createAsyncThunk("redirect/category/details", (id: string, thunkApi) =>
-    thunkApi.dispatch(redirectTo(`/app/category/${id}/details`))
-)
-export const redirectToFeed = createAsyncThunk("redirect/feed", (id: string | number, thunkApi) =>
-    thunkApi.dispatch(redirectTo(`/app/feed/${id}`))
-)
-export const redirectToFeedDetails = createAsyncThunk("redirect/feed/details", (id: string, thunkApi) =>
-    thunkApi.dispatch(redirectTo(`/app/feed/${id}/details`))
-)
-export const redirectToTag = createAsyncThunk("redirect/tag", (id: string, thunkApi) => thunkApi.dispatch(redirectTo(`/app/tag/${id}`)))
-export const redirectToTagDetails = createAsyncThunk("redirect/tag/details", (id: string, thunkApi) =>
-    thunkApi.dispatch(redirectTo(`/app/tag/${id}/details`))
-)
-export const redirectToAdd = createAsyncThunk("redirect/add", (_, thunkApi) => thunkApi.dispatch(redirectTo("/app/add")))
-export const redirectToSettings = createAsyncThunk("redirect/settings", (_, thunkApi) => thunkApi.dispatch(redirectTo("/app/settings")))
-export const redirectToAdminUsers = createAsyncThunk("redirect/admin/users", (_, thunkApi) =>
-    thunkApi.dispatch(redirectTo("/app/admin/users"))
-)
-export const redirectToMetrics = createAsyncThunk("redirect/admin/metrics", (_, thunkApi) =>
-    thunkApi.dispatch(redirectTo("/app/admin/metrics"))
-)
-export const redirectToAbout = createAsyncThunk("redirect/about", (_, thunkApi) => thunkApi.dispatch(redirectTo("/app/about")))
-export const redirectToApiDocumentation = createAsyncThunk("redirect/api", (_, thunkApi) => thunkApi.dispatch(redirectTo("/app/api")))
-
-export const redirectSlice = createSlice({
-    name: "redirect",
-    initialState,
-    reducers: {
-        redirectTo: (state, action: PayloadAction<string | undefined>) => {
-            state.to = action.payload
-        },
-    },
-})
-
-export const { redirectTo } = redirectSlice.actions
-export default redirectSlice.reducer

commafeed-client/src/app/slices/server.ts

@@ -1,23 +0,0 @@
-import { createAsyncThunk, createSlice } from "@reduxjs/toolkit"
-import { client } from "app/client"
-import { ServerInfo } from "app/types"
-
-interface ServerState {
-    serverInfos?: ServerInfo
-}
-
-const initialState: ServerState = {}
-
-export const reloadServerInfos = createAsyncThunk("server/infos", () => client.server.getServerInfos().then(r => r.data))
-export const serverSlice = createSlice({
-    name: "server",
-    initialState,
-    reducers: {},
-    extraReducers: builder => {
-        builder.addCase(reloadServerInfos.fulfilled, (state, action) => {
-            state.serverInfos = action.payload
-        })
-    },
-})
-
-export default serverSlice.reducer

commafeed-client/src/app/slices/tree.ts

@@ -1,58 +0,0 @@
-import { createAsyncThunk, createSlice, PayloadAction } from "@reduxjs/toolkit"
-import { client } from "app/client"
-import { Category, CollapseRequest } from "app/types"
-import { visitCategoryTree } from "app/utils"
-// eslint-disable-next-line import/no-cycle
-import { markEntry } from "./entries"
-import { redirectTo } from "./redirect"
-
-interface TreeState {
-    rootCategory?: Category
-    mobileMenuOpen: boolean
-}
-
-const initialState: TreeState = {
-    mobileMenuOpen: false,
-}
-
-export const reloadTree = createAsyncThunk("tree/reload", () => client.category.getRoot().then(r => r.data))
-export const collapseTreeCategory = createAsyncThunk("tree/category/collapse", async (req: CollapseRequest) =>
-    client.category.collapse(req)
-)
-
-export const treeSlice = createSlice({
-    name: "tree",
-    initialState,
-    reducers: {
-        setMobileMenuOpen: (state, action: PayloadAction<boolean>) => {
-            state.mobileMenuOpen = action.payload
-        },
-    },
-    extraReducers: builder => {
-        builder.addCase(reloadTree.fulfilled, (state, action) => {
-            state.rootCategory = action.payload
-        })
-        builder.addCase(collapseTreeCategory.pending, (state, action) => {
-            if (!state.rootCategory) return
-            visitCategoryTree(state.rootCategory, c => {
-                if (+c.id === action.meta.arg.id) c.expanded = !action.meta.arg.collapse
-            })
-        })
-        builder.addCase(markEntry.pending, (state, action) => {
-            if (!state.rootCategory) return
-            visitCategoryTree(state.rootCategory, c =>
-                c.feeds
-                    .filter(f => f.id === +action.meta.arg.entry.feedId)
-                    .forEach(f => {
-                        f.unread = action.meta.arg.read ? f.unread - 1 : f.unread + 1
-                    })
-            )
-        })
-        builder.addCase(redirectTo, state => {
-            state.mobileMenuOpen = false
-        })
-    },
-})
-
-export const { setMobileMenuOpen } = treeSlice.actions
-export default treeSlice.reducer

commafeed-client/src/app/slices/user.ts

@@ -1,161 +0,0 @@
-import { t } from "@lingui/macro"
-import { showNotification } from "@mantine/notifications"
-import { createAsyncThunk, createSlice, isAnyOf } from "@reduxjs/toolkit"
-import { client } from "app/client"
-import { RootState } from "app/store"
-import { ReadingMode, ReadingOrder, Settings, SharingSettings, UserModel } from "app/types"
-// eslint-disable-next-line import/no-cycle
-import { reloadEntries } from "./entries"
-
-interface UserState {
-    settings?: Settings
-    profile?: UserModel
-    tags?: string[]
-}
-
-const initialState: UserState = {}
-
-export const reloadSettings = createAsyncThunk("settings/reload", () => client.user.getSettings().then(r => r.data))
-export const reloadProfile = createAsyncThunk("profile/reload", () => client.user.getProfile().then(r => r.data))
-export const reloadTags = createAsyncThunk("entries/tags", () => client.entry.getTags().then(r => r.data))
-export const changeReadingMode = createAsyncThunk<void, ReadingMode, { state: RootState }>(
-    "settings/readingMode",
-    (readingMode, thunkApi) => {
-        const { settings } = thunkApi.getState().user
-        if (!settings) return
-        client.user.saveSettings({ ...settings, readingMode })
-        thunkApi.dispatch(reloadEntries())
-    }
-)
-export const changeReadingOrder = createAsyncThunk<void, ReadingOrder, { state: RootState }>(
-    "settings/readingOrder",
-    (readingOrder, thunkApi) => {
-        const { settings } = thunkApi.getState().user
-        if (!settings) return
-        client.user.saveSettings({ ...settings, readingOrder })
-        thunkApi.dispatch(reloadEntries())
-    }
-)
-export const changeLanguage = createAsyncThunk<
-    void,
-    string,
-    {
-        state: RootState
-    }
->("settings/language", (language, thunkApi) => {
-    const { settings } = thunkApi.getState().user
-    if (!settings) return
-    client.user.saveSettings({ ...settings, language })
-})
-export const changeScrollSpeed = createAsyncThunk<
-    void,
-    boolean,
-    {
-        state: RootState
-    }
->("settings/scrollSpeed", (speed, thunkApi) => {
-    const { settings } = thunkApi.getState().user
-    if (!settings) return
-    client.user.saveSettings({ ...settings, scrollSpeed: speed ? 400 : 0 })
-})
-export const changeShowRead = createAsyncThunk<
-    void,
-    boolean,
-    {
-        state: RootState
-    }
->("settings/showRead", (showRead, thunkApi) => {
-    const { settings } = thunkApi.getState().user
-    if (!settings) return
-    client.user.saveSettings({ ...settings, showRead })
-})
-export const changeScrollMarks = createAsyncThunk<
-    void,
-    boolean,
-    {
-        state: RootState
-    }
->("settings/scrollMarks", (scrollMarks, thunkApi) => {
-    const { settings } = thunkApi.getState().user
-    if (!settings) return
-    client.user.saveSettings({ ...settings, scrollMarks })
-})
-export const changeSharingSetting = createAsyncThunk<
-    void,
-    { site: keyof SharingSettings; value: boolean },
-    {
-        state: RootState
-    }
->("settings/sharingSetting", (sharingSetting, thunkApi) => {
-    const { settings } = thunkApi.getState().user
-    if (!settings) return
-    client.user.saveSettings({
-        ...settings,
-        sharingSettings: {
-            ...settings.sharingSettings,
-            [sharingSetting.site]: sharingSetting.value,
-        },
-    })
-})
-
-export const userSlice = createSlice({
-    name: "user",
-    initialState,
-    reducers: {},
-    extraReducers: builder => {
-        builder.addCase(reloadSettings.fulfilled, (state, action) => {
-            state.settings = action.payload
-        })
-        builder.addCase(reloadProfile.fulfilled, (state, action) => {
-            state.profile = action.payload
-        })
-        builder.addCase(reloadTags.fulfilled, (state, action) => {
-            state.tags = action.payload
-        })
-        builder.addCase(changeReadingMode.pending, (state, action) => {
-            if (!state.settings) return
-            state.settings.readingMode = action.meta.arg
-        })
-        builder.addCase(changeReadingOrder.pending, (state, action) => {
-            if (!state.settings) return
-            state.settings.readingOrder = action.meta.arg
-        })
-        builder.addCase(changeLanguage.pending, (state, action) => {
-            if (!state.settings) return
-            state.settings.language = action.meta.arg
-        })
-        builder.addCase(changeScrollSpeed.pending, (state, action) => {
-            if (!state.settings) return
-            state.settings.scrollSpeed = action.meta.arg ? 400 : 0
-        })
-        builder.addCase(changeShowRead.pending, (state, action) => {
-            if (!state.settings) return
-            state.settings.showRead = action.meta.arg
-        })
-        builder.addCase(changeScrollMarks.pending, (state, action) => {
-            if (!state.settings) return
-            state.settings.scrollMarks = action.meta.arg
-        })
-        builder.addCase(changeSharingSetting.pending, (state, action) => {
-            if (!state.settings) return
-            state.settings.sharingSettings[action.meta.arg.site] = action.meta.arg.value
-        })
-        builder.addMatcher(
-            isAnyOf(
-                changeLanguage.fulfilled,
-                changeScrollSpeed.fulfilled,
-                changeShowRead.fulfilled,
-                changeScrollMarks.fulfilled,
-                changeSharingSetting.fulfilled
-            ),
-            () => {
-                showNotification({
-                    message: t`Settings saved.`,
-                    color: "green",
-                })
-            }
-        )
-    },
-})
-
-export default userSlice.reducer

commafeed-client/src/app/store.ts

@@ -1,26 +1,53 @@
-import { configureStore } from "@reduxjs/toolkit"
+import { configureStore } from "@reduxjs/toolkit"
-import { setupListeners } from "@reduxjs/toolkit/query"
+import { entriesSlice } from "app/entries/slice"
-import { TypedUseSelectorHook, useDispatch, useSelector } from "react-redux"
+import { redirectSlice } from "app/redirect/slice"
-import entriesReducer from "./slices/entries"
+import { serverSlice } from "app/server/slice"
-import redirectReducer from "./slices/redirect"
+import { treeSlice } from "app/tree/slice"
-import serverReducer from "./slices/server"
+import type { LocalSettings } from "app/types"
-import treeReducer from "./slices/tree"
+import { initialLocalSettings, userSlice } from "app/user/slice"
-import userReducer from "./slices/user"
+import { type TypedUseSelectorHook, useDispatch, useSelector } from "react-redux"
-
+
-export const reducers = {
+export const reducers = {
-    entries: entriesReducer,
+    entries: entriesSlice.reducer,
-    redirect: redirectReducer,
+    redirect: redirectSlice.reducer,
-    tree: treeReducer,
+    tree: treeSlice.reducer,
-    server: serverReducer,
+    server: serverSlice.reducer,
-    user: userReducer,
+    user: userSlice.reducer,
-}
+}
-
+
-export const store = configureStore({ reducer: reducers })
+const loadLocalSettings = (): LocalSettings => {
-
+    const json = localStorage.getItem("commafeed-local-settings")
-setupListeners(store.dispatch)
+    if (json) {
-
+        return JSON.parse(json)
-export type RootState = ReturnType<typeof store.getState>
+    }
-export type AppDispatch = typeof store.dispatch
+
-
+    // load old settings
-export const useAppDispatch: () => AppDispatch = useDispatch
+    const viewMode = localStorage.getItem("view-mode")
-export const useAppSelector: TypedUseSelectorHook<RootState> = useSelector
+    const sidebarWidth = localStorage.getItem("sidebar-width")
+    const announcementHash = localStorage.getItem("announcement-hash")
+    return {
+        ...initialLocalSettings,
+        viewMode: viewMode ? JSON.parse(viewMode) : initialLocalSettings.viewMode,
+        sidebarWidth: sidebarWidth ? JSON.parse(sidebarWidth) : initialLocalSettings.sidebarWidth,
+        announcementHash: announcementHash ? JSON.parse(announcementHash) : initialLocalSettings.announcementHash,
+    }
+}
+
+export const store = configureStore({
+    reducer: reducers,
+    preloadedState: {
+        user: {
+            localSettings: loadLocalSettings(),
+        },
+    },
+})
+store.subscribe(() => {
+    const localSettings = store.getState().user.localSettings
+    localStorage.setItem("commafeed-local-settings", JSON.stringify(localSettings))
+})
+
+export type RootState = ReturnType<typeof store.getState>
+export type AppDispatch = typeof store.dispatch
+
+export const useAppDispatch: () => AppDispatch = useDispatch
+export const useAppSelector: TypedUseSelectorHook<RootState> = useSelector

commafeed-client/src/app/tree/slice.ts

@@ -0,0 +1,68 @@
+import { type PayloadAction, createSlice } from "@reduxjs/toolkit"
+import { markEntry } from "app/entries/thunks"
+import { redirectTo } from "app/redirect/slice"
+import { collapseTreeCategory, reloadTree } from "app/tree/thunks"
+import type { Category } from "app/types"
+import { visitCategoryTree } from "app/utils"
+
+interface TreeState {
+    rootCategory?: Category
+    mobileMenuOpen: boolean
+    sidebarVisible: boolean
+}
+
+const initialState: TreeState = {
+    mobileMenuOpen: false,
+    sidebarVisible: true,
+}
+
+export const treeSlice = createSlice({
+    name: "tree",
+    initialState,
+    reducers: {
+        setMobileMenuOpen: (state, action: PayloadAction<boolean>) => {
+            state.mobileMenuOpen = action.payload
+        },
+        toggleSidebar: state => {
+            state.sidebarVisible = !state.sidebarVisible
+        },
+        incrementUnreadCount: (
+            state,
+            action: PayloadAction<{
+                feedId: number
+                amount: number
+            }>
+        ) => {
+            if (!state.rootCategory) return
+            visitCategoryTree(state.rootCategory, c => {
+                for (const f of c.feeds.filter(f => f.id === action.payload.feedId)) {
+                    f.unread += action.payload.amount
+                }
+            })
+        },
+    },
+    extraReducers: builder => {
+        builder.addCase(reloadTree.fulfilled, (state, action) => {
+            state.rootCategory = action.payload
+        })
+        builder.addCase(collapseTreeCategory.pending, (state, action) => {
+            if (!state.rootCategory) return
+            visitCategoryTree(state.rootCategory, c => {
+                if (+c.id === action.meta.arg.id) c.expanded = !action.meta.arg.collapse
+            })
+        })
+        builder.addCase(markEntry.pending, (state, action) => {
+            if (!state.rootCategory) return
+            visitCategoryTree(state.rootCategory, c => {
+                for (const f of c.feeds.filter(f => f.id === +action.meta.arg.entry.feedId)) {
+                    f.unread = action.meta.arg.read ? f.unread - 1 : f.unread + 1
+                }
+            })
+        })
+        builder.addCase(redirectTo, state => {
+            state.mobileMenuOpen = false
+        })
+    },
+})
+
+export const { setMobileMenuOpen, toggleSidebar, incrementUnreadCount } = treeSlice.actions

commafeed-client/src/app/tree/thunks.ts

@@ -0,0 +1,80 @@
+import { createAppAsyncThunk } from "app/async-thunk"
+import { client } from "app/client"
+import { redirectToCategory, redirectToFeed } from "app/redirect/thunks"
+import { incrementUnreadCount } from "app/tree/slice"
+import type { CollapseRequest, Subscription } from "app/types"
+import { flattenCategoryTree, visitCategoryTree } from "app/utils"
+
+export const reloadTree = createAppAsyncThunk("tree/reload", async () => await client.category.getRoot().then(r => r.data))
+
+export const collapseTreeCategory = createAppAsyncThunk(
+    "tree/category/collapse",
+    async (req: CollapseRequest) => await client.category.collapse(req)
+)
+
+export const selectNextUnreadTreeItem = createAppAsyncThunk(
+    "tree/selectNextUnreadItem",
+    (
+        arg: {
+            direction: "forward" | "backward"
+        },
+        thunkApi
+    ) => {
+        const state = thunkApi.getState()
+        const root = state.tree.rootCategory
+        if (!root) return
+
+        const { source } = state.entries
+        if (source.type === "category") {
+            const categories = flattenCategoryTree(root)
+            if (arg.direction === "backward") categories.reverse()
+
+            const index = categories.findIndex(c => c.id === source.id)
+            if (index === -1) return
+
+            for (let i = index + 1; i < categories.length; i++) {
+                const c = categories[i]
+                if (c.feeds.some(f => f.unread > 0)) {
+                    return thunkApi.dispatch(redirectToCategory(String(c.id)))
+                }
+            }
+        } else if (source.type === "feed") {
+            const feeds: Subscription[] = []
+            visitCategoryTree(root, c => feeds.push(...c.feeds), { childrenFirst: true })
+            if (arg.direction === "backward") feeds.reverse()
+
+            const index = feeds.findIndex(f => f.id === +source.id)
+            if (index === -1) return
+
+            for (let i = index + 1; i < feeds.length; i++) {
+                const f = feeds[i]
+                if (f.unread > 0) {
+                    return thunkApi.dispatch(redirectToFeed(String(f.id)))
+                }
+            }
+        }
+    }
+)
+
+export const newFeedEntriesDiscovered = createAppAsyncThunk(
+    "tree/new-feed-entries-discovered",
+    async ({ feedId, amount }: { feedId: number; amount: number }, thunkApi) => {
+        const root = thunkApi.getState().tree.rootCategory
+        if (!root) return
+
+        const feed = flattenCategoryTree(root)
+            .flatMap(c => c.feeds)
+            .some(f => f.id === feedId)
+        if (!feed) {
+            // feed not found in the tree, reload the tree completely
+            thunkApi.dispatch(reloadTree())
+        } else {
+            thunkApi.dispatch(
+                incrementUnreadCount({
+                    feedId,
+                    amount,
+                })
+            )
+        }
+    }
+)

commafeed-client/src/app/tree/tree.test.ts

@@ -0,0 +1,119 @@
+import { configureStore } from "@reduxjs/toolkit"
+import { type RootState, reducers } from "app/store"
+import { selectNextUnreadTreeItem } from "app/tree/thunks"
+import type { Category, Subscription } from "app/types"
+import { describe, expect, it } from "vitest"
+
+const createCategory = (id: string): Category => ({
+    id,
+    name: id,
+    children: [],
+    feeds: [],
+    expanded: true,
+    position: 0,
+})
+
+const createFeed = (id: number, unread: number): Subscription => ({
+    id,
+    name: String(id),
+    unread,
+    errorCount: 0,
+    position: 0,
+    feedUrl: "",
+    feedLink: "",
+    iconUrl: "",
+})
+
+const root = createCategory("root")
+
+const catA = createCategory("catA")
+catA.feeds.push(createFeed(1, 0), createFeed(2, 0), createFeed(3, 1))
+
+const catB = createCategory("catB")
+
+const catC = createCategory("catC")
+catC.feeds.push(createFeed(4, 1))
+
+root.children.push(catA, catB, catC)
+
+describe("selectNextUnreadTreeItem", () => {
+    it("selects the next unread category", async () => {
+        const store = configureStore({
+            reducer: reducers,
+            preloadedState: {
+                tree: {
+                    rootCategory: root,
+                },
+                entries: {
+                    source: {
+                        type: "category",
+                        id: "catA",
+                    },
+                },
+            } as RootState,
+        })
+
+        await store.dispatch(selectNextUnreadTreeItem({ direction: "forward" }))
+        expect(store.getState().redirect.to).toBe("/app/category/catC")
+    })
+
+    it("selects the previous unread category", async () => {
+        const store = configureStore({
+            reducer: reducers,
+            preloadedState: {
+                tree: {
+                    rootCategory: root,
+                },
+                entries: {
+                    source: {
+                        type: "category",
+                        id: "catC",
+                    },
+                },
+            } as RootState,
+        })
+
+        await store.dispatch(selectNextUnreadTreeItem({ direction: "backward" }))
+        expect(store.getState().redirect.to).toBe("/app/category/catA")
+    })
+
+    it("selects the next unread feed", async () => {
+        const store = configureStore({
+            reducer: reducers,
+            preloadedState: {
+                tree: {
+                    rootCategory: root,
+                },
+                entries: {
+                    source: {
+                        type: "feed",
+                        id: "1",
+                    },
+                },
+            } as RootState,
+        })
+
+        await store.dispatch(selectNextUnreadTreeItem({ direction: "forward" }))
+        expect(store.getState().redirect.to).toBe("/app/feed/3")
+    })
+
+    it("selects the previous unread feed", async () => {
+        const store = configureStore({
+            reducer: reducers,
+            preloadedState: {
+                tree: {
+                    rootCategory: root,
+                },
+                entries: {
+                    source: {
+                        type: "feed",
+                        id: "4",
+                    },
+                },
+            } as RootState,
+        })
+
+        await store.dispatch(selectNextUnreadTreeItem({ direction: "backward" }))
+        expect(store.getState().redirect.to).toBe("/app/feed/3")
+    })
+})

commafeed-client/src/app/types.ts

@@ -1,308 +1,306 @@
-export interface AddCategoryRequest {
+export type ReadingMode = "all" | "unread"
-    name: string
+
-    parentId?: string
+export type ReadingOrder = "asc" | "desc"
-}
+
-
+export type ViewMode = "title" | "cozy" | "detailed" | "expanded"
-export interface ApplicationSettings {
+
-    publicUrl: string
+export type ScrollMode = "always" | "never" | "if_needed"
-    allowRegistrations: boolean
+
-    createDemoAccount: boolean
+export type IconDisplayMode = "always" | "never" | "on_desktop" | "on_mobile"
-    googleAnalyticsTrackingCode?: string
+
-    googleAuthKey?: string
+export interface AddCategoryRequest {
-    backgroundThreads: number
+    name: string
-    databaseUpdateThreads: number
+    parentId?: string
-    smtpHost?: string
+}
-    smtpPort?: number
+
-    smtpTls?: boolean
+export interface Subscription {
-    smtpUserName?: string
+    id: number
-    smtpPassword?: string
+    name: string
-    smtpFromAddress?: string
+    message?: string
-    graphiteEnabled?: boolean
+    errorCount: number
-    graphitePrefix?: string
+    lastRefresh?: number
-    graphiteHost?: string
+    nextRefresh?: number
-    graphitePort?: number
+    feedUrl: string
-    graphiteInterval?: number
+    feedLink: string
-    heavyLoad: boolean
+    iconUrl: string
-    pubsubhubbub: boolean
+    unread: number
-    imageProxyEnabled: boolean
+    categoryId?: string
-    queryTimeout: number
+    position: number
-    keepStatusDays: number
+    newestItemTime?: number
-    maxFeedCapacity: number
+    filter?: string
-    refreshIntervalMinutes: number
+}
-    cache: ApplicationSettingsCache
+
-    announcement?: string
+export interface Category {
-    userAgent?: string
+    id: string
-    unreadThreshold?: Date
+    parentId?: string
-}
+    parentName?: string
-
+    name: string
-export interface Category {
+    children: Category[]
-    id: string
+    feeds: Subscription[]
-    parentId?: string
+    expanded: boolean
-    parentName?: string
+    position: number
-    name: string
+}
-    children: Category[]
+
-    feeds: Subscription[]
+export interface CategoryModificationRequest {
-    expanded: boolean
+    id: number
-    position: number
+    name?: string
-}
+    parentId?: string
-
+    position?: number
-export interface CategoryModificationRequest {
+}
-    id: number
+
-    name?: string
+export interface CollapseRequest {
-    parentId?: string
+    id: number
-    position?: number
+    collapse: boolean
-}
+}
-
+
-export interface CollapseRequest {
+export interface Entry {
-    id: number
+    id: string
-    collapse: boolean
+    guid: string
-}
+    title: string
-
+    content: string
-export interface Entries {
+    categories?: string
-    name: string
+    rtl: boolean
-    message?: string
+    author?: string
-    errorCount: number
+    enclosureUrl?: string
-    feedLink: string
+    enclosureType?: string
-    timestamp: number
+    mediaDescription?: string
-    hasMore: boolean
+    mediaThumbnailUrl?: string
-    offset?: number
+    mediaThumbnailWidth?: number
-    limit?: number
+    mediaThumbnailHeight?: number
-    entries: Entry[]
+    date: number
-    ignoredReadStatus: boolean
+    insertedDate: number
-}
+    feedId: string
-
+    feedName: string
-export interface Entry {
+    feedUrl: string
-    id: string
+    feedLink: string
-    guid: string
+    iconUrl: string
-    title: string
+    url: string
-    content: string
+    read: boolean
-    categories?: string
+    starred: boolean
-    rtl: boolean
+    markable: boolean
-    author?: string
+    tags: string[]
-    enclosureUrl?: string
+}
-    enclosureType?: string
+
-    mediaDescription?: string
+export interface Entries {
-    mediaThumbnailUrl?: string
+    name: string
-    mediaThumbnailWidth?: number
+    message?: string
-    mediaThumbnailHeight?: number
+    errorCount: number
-    date: number
+    feedLink: string
-    insertedDate: number
+    timestamp: number
-    feedId: string
+    hasMore: boolean
-    feedName: string
+    offset?: number
-    feedUrl: string
+    limit?: number
-    feedLink: string
+    entries: Entry[]
-    iconUrl: string
+    ignoredReadStatus: boolean
-    url: string
+}
-    read: boolean
+
-    starred: boolean
+export interface FeedInfo {
-    markable: boolean
+    url: string
-    tags: string[]
+    title: string
-}
+}
-
+
-export interface FeedInfo {
+export interface FeedInfoRequest {
-    url: string
+    url: string
-    title: string
+}
-}
+
-
+export interface FeedModificationRequest {
-export interface FeedInfoRequest {
+    id: number
-    url: string
+    name?: string
-}
+    categoryId?: string
-
+    position?: number
-export interface FeedModificationRequest {
+    filter?: string
-    id: number
+}
-    name?: string
+
-    categoryId?: string
+export interface GetEntriesRequest {
-    position?: number
+    id: string
-    filter?: string
+    readType?: ReadingMode
-}
+    newerThan?: number
-
+    order?: ReadingOrder
-export interface GetEntriesRequest {
+    keywords?: string
-    id: string
+    excludedSubscriptionIds?: string
-    readType?: ReadingMode
+    tag?: string
-    newerThan?: number
+}
-    order?: ReadingOrder
+
-    keywords?: string
+export interface GetEntriesPaginatedRequest extends GetEntriesRequest {
-    onlyIds?: boolean
+    offset: number
-    excludedSubscriptionIds?: string
+    limit: number
-    tag?: string
+}
-}
+
-
+export interface IDRequest {
-export interface GetEntriesPaginatedRequest extends GetEntriesRequest {
+    id: number
-    offset: number
+}
-    limit: number
+
-}
+export interface LoginRequest {
-
+    name: string
-export interface IDRequest {
+    password: string
-    id: number
+}
-}
+
-
+export interface MarkRequest {
-export interface LoginRequest {
+    id: string
-    name: string
+    read: boolean
-    password: string
+    olderThan?: number
-}
+    insertedBefore?: number
-
+    keywords?: string
-export interface MarkRequest {
+    excludedSubscriptions?: number[]
-    id: string
+}
-    read: boolean
+
-    olderThan?: number
+export interface MetricCounter {
-    keywords?: string
+    count: number
-    excludedSubscriptions?: number[]
+}
-}
+
-
+export interface MetricGauge {
-export interface MetricCounter {
+    value: number
-    count: number
+}
-}
+
-
+export interface MetricMeter {
-export interface MetricGauge {
+    count: number
-    value: number
+    m15_rate: number
-}
+    m1_rate: number
-
+    m5_rate: number
-export interface MetricMeter {
+    mean_rate: number
-    count: number
+    units: string
-    m15_rate: number
+}
-    m1_rate: number
+
-    m5_rate: number
+export interface MetricTimer {
-    mean_rate: number
+    count: number
-    units: string
+    max: number
-}
+    mean: number
-
+    min: number
-export type MetricTimer = {
+    p50: number
-    count: number
+    p75: number
-    max: number
+    p95: number
-    mean: number
+    p98: number
-    min: number
+    p99: number
-    p50: number
+    p999: number
-    p75: number
+    stddev: number
-    p95: number
+    m15_rate: number
-    p98: number
+    m1_rate: number
-    p99: number
+    m5_rate: number
-    p999: number
+    mean_rate: number
-    stddev: number
+    duration_units: string
-    m15_rate: number
+    rate_units: string
-    m1_rate: number
+}
-    m5_rate: number
+
-    mean_rate: number
+export interface Metrics {
-    duration_units: string
+    counters: Record<string, MetricCounter>
-    rate_units: string
+    gauges: Record<string, MetricGauge>
-}
+    meters: Record<string, MetricMeter>
-
+    timers: Record<string, MetricTimer>
-export interface Metrics {
+}
-    counters: { [key: string]: MetricCounter }
+
-    gauges: { [key: string]: MetricGauge }
+export interface MultipleMarkRequest {
-    meters: { [key: string]: MetricMeter }
+    requests: MarkRequest[]
-    timers: { [key: string]: MetricTimer }
+}
-}
+
-
+export interface PasswordResetRequest {
-export interface MultipleMarkRequest {
+    email: string
-    requests: MarkRequest[]
+}
-}
+
-
+export interface ProfileModificationRequest {
-export interface PasswordResetRequest {
+    currentPassword: string
-    email: string
+    email: string
-}
+    newPassword?: string
-
+    newApiKey?: boolean
-export interface ProfileModificationRequest {
+}
-    currentPassword: string
+
-    email: string
+export interface RegistrationRequest {
-    newPassword?: string
+    name: string
-    newApiKey?: boolean
+    password: string
-}
+    email: string
-
+}
-export interface RegistrationRequest {
+
-    name: string
+export interface ServerInfo {
-    password: string
+    announcement?: string
-    email: string
+    version: string
-}
+    gitCommit: string
-
+    allowRegistrations: boolean
-export interface ServerInfo {
+    googleAnalyticsCode?: string
-    announcement?: string
+    smtpEnabled: boolean
-    version: string
+    demoAccountEnabled: boolean
-    gitCommit: string
+    websocketEnabled: boolean
-    allowRegistrations: boolean
+    websocketPingInterval: number
-    googleAnalyticsCode?: string
+    treeReloadInterval: number
-    smtpEnabled: boolean
+    forceRefreshCooldownDuration: number
-    demoAccountEnabled: boolean
+}
-}
+
-
+export interface SharingSettings {
-export interface Settings {
+    email: boolean
-    language: string
+    gmail: boolean
-    readingMode: ReadingMode
+    facebook: boolean
-    readingOrder: ReadingOrder
+    twitter: boolean
-    showRead: boolean
+    tumblr: boolean
-    scrollMarks: boolean
+    pocket: boolean
-    theme?: string
+    instapaper: boolean
-    customCss?: string
+    buffer: boolean
-    scrollSpeed: number
+}
-    sharingSettings: SharingSettings
+
-}
+export interface Settings {
-
+    language: string
-export interface SharingSettings {
+    readingMode: ReadingMode
-    email: boolean
+    readingOrder: ReadingOrder
-    gmail: boolean
+    showRead: boolean
-    facebook: boolean
+    scrollMarks: boolean
-    twitter: boolean
+    customCss?: string
-    tumblr: boolean
+    customJs?: string
-    pocket: boolean
+    scrollSpeed: number
-    instapaper: boolean
+    scrollMode: ScrollMode
-    buffer: boolean
+    entriesToKeepOnTopWhenScrolling: number
-}
+    starIconDisplayMode: IconDisplayMode
-
+    externalLinkIconDisplayMode: IconDisplayMode
-export interface StarRequest {
+    markAllAsReadConfirmation: boolean
-    id: string
+    customContextMenu: boolean
-    feedId: number
+    mobileFooter: boolean
-    starred: boolean
+    unreadCountTitle: boolean
-}
+    unreadCountFavicon: boolean
-
+    sharingSettings: SharingSettings
-export interface SubscribeRequest {
+}
-    url: string
+
-    title: string
+export interface LocalSettings {
-    categoryId?: string
+    viewMode: ViewMode
-}
+    sidebarWidth: number
-
+    announcementHash: string
-export interface Subscription {
+}
-    id: number
+
-    name: string
+export interface StarRequest {
-    message?: string
+    id: string
-    errorCount: number
+    feedId: number
-    lastRefresh?: number
+    starred: boolean
-    nextRefresh?: number
+}
-    feedUrl: string
+
-    feedLink: string
+export interface SubscribeRequest {
-    iconUrl: string
+    url: string
-    unread: number
+    title: string
-    categoryId?: string
+    categoryId?: string
-    position?: number
+}
-    newestItemTime?: number
+
-    filter?: string
+export interface TagRequest {
-}
+    entryId: number
-
+    tags: string[]
-export interface TagRequest {
+}
-    entryId: number
+
-    tags: string[]
+export interface UserModel {
-}
+    id: number
-
+    name: string
-export interface UnreadCount {
+    email?: string
-    feedId?: number
+    apiKey?: string
-    unreadCount?: number
+    password?: string
-    newestItemTime?: number
+    enabled: boolean
-}
+    created: number
-
+    lastLogin?: number
-export interface UserModel {
+    admin: boolean
-    id: number
+    lastForceRefresh?: number
-    name: string
+}
-    email?: string
+
-    apiKey?: string
+export interface AdminSaveUserRequest {
-    password?: string
+    id?: number
-    enabled: boolean
+    name: string
-    created: number
+    email?: string
-    lastLogin?: number
+    password?: string
-    admin: boolean
+    enabled: boolean
-}
+    admin: boolean
-
+}
-export type ApplicationSettingsCache = "NOOP" | "REDIS"
+
-
+export interface AuthenticationError {
-export type ReadingMode = "all" | "unread"
+    message: string
-
+    allowRegistrations: boolean
-export type ReadingOrder = "asc" | "desc"
+}
-
-export type ViewMode = "title" | "cozy" | "detailed" | "expanded"

commafeed-client/src/app/user/slice.ts

@@ -0,0 +1,159 @@
+import { t } from "@lingui/core/macro"
+import { showNotification } from "@mantine/notifications"
+import { type PayloadAction, createSlice, isAnyOf } from "@reduxjs/toolkit"
+import type { LocalSettings, Settings, UserModel, ViewMode } from "app/types"
+import {
+    changeCustomContextMenu,
+    changeEntriesToKeepOnTopWhenScrolling,
+    changeExternalLinkIconDisplayMode,
+    changeLanguage,
+    changeMarkAllAsReadConfirmation,
+    changeMobileFooter,
+    changeReadingMode,
+    changeReadingOrder,
+    changeScrollMarks,
+    changeScrollMode,
+    changeScrollSpeed,
+    changeSharingSetting,
+    changeShowRead,
+    changeStarIconDisplayMode,
+    changeUnreadCountFavicon,
+    changeUnreadCountTitle,
+    reloadProfile,
+    reloadSettings,
+    reloadTags,
+} from "./thunks"
+
+interface UserState {
+    settings?: Settings
+    localSettings: LocalSettings
+    profile?: UserModel
+    tags?: string[]
+}
+
+export const initialLocalSettings: LocalSettings = {
+    viewMode: "detailed",
+    sidebarWidth: 360,
+    announcementHash: "no-hash",
+}
+
+const initialState: UserState = {
+    localSettings: initialLocalSettings,
+}
+
+export const userSlice = createSlice({
+    name: "user",
+    initialState,
+    reducers: {
+        setViewMode: (state, action: PayloadAction<ViewMode>) => {
+            state.localSettings.viewMode = action.payload
+        },
+        setSidebarWidth: (state, action: PayloadAction<number>) => {
+            state.localSettings.sidebarWidth = action.payload
+        },
+        setAnnouncementHash: (state, action: PayloadAction<string>) => {
+            state.localSettings.announcementHash = action.payload
+        },
+    },
+    extraReducers: builder => {
+        builder.addCase(reloadSettings.fulfilled, (state, action) => {
+            state.settings = action.payload
+        })
+        builder.addCase(reloadProfile.fulfilled, (state, action) => {
+            state.profile = action.payload
+        })
+        builder.addCase(reloadTags.fulfilled, (state, action) => {
+            state.tags = action.payload
+        })
+        builder.addCase(changeReadingMode.pending, (state, action) => {
+            if (!state.settings) return
+            state.settings.readingMode = action.meta.arg
+        })
+        builder.addCase(changeReadingOrder.pending, (state, action) => {
+            if (!state.settings) return
+            state.settings.readingOrder = action.meta.arg
+        })
+        builder.addCase(changeLanguage.pending, (state, action) => {
+            if (!state.settings) return
+            state.settings.language = action.meta.arg
+        })
+        builder.addCase(changeScrollSpeed.pending, (state, action) => {
+            if (!state.settings) return
+            state.settings.scrollSpeed = action.meta.arg ? 400 : 0
+        })
+        builder.addCase(changeShowRead.pending, (state, action) => {
+            if (!state.settings) return
+            state.settings.showRead = action.meta.arg
+        })
+        builder.addCase(changeScrollMarks.pending, (state, action) => {
+            if (!state.settings) return
+            state.settings.scrollMarks = action.meta.arg
+        })
+        builder.addCase(changeScrollMode.pending, (state, action) => {
+            if (!state.settings) return
+            state.settings.scrollMode = action.meta.arg
+        })
+        builder.addCase(changeEntriesToKeepOnTopWhenScrolling.pending, (state, action) => {
+            if (!state.settings) return
+            state.settings.entriesToKeepOnTopWhenScrolling = action.meta.arg
+        })
+        builder.addCase(changeStarIconDisplayMode.pending, (state, action) => {
+            if (!state.settings) return
+            state.settings.starIconDisplayMode = action.meta.arg
+        })
+        builder.addCase(changeExternalLinkIconDisplayMode.pending, (state, action) => {
+            if (!state.settings) return
+            state.settings.externalLinkIconDisplayMode = action.meta.arg
+        })
+        builder.addCase(changeMarkAllAsReadConfirmation.pending, (state, action) => {
+            if (!state.settings) return
+            state.settings.markAllAsReadConfirmation = action.meta.arg
+        })
+        builder.addCase(changeCustomContextMenu.pending, (state, action) => {
+            if (!state.settings) return
+            state.settings.customContextMenu = action.meta.arg
+        })
+        builder.addCase(changeMobileFooter.pending, (state, action) => {
+            if (!state.settings) return
+            state.settings.mobileFooter = action.meta.arg
+        })
+        builder.addCase(changeUnreadCountTitle.pending, (state, action) => {
+            if (!state.settings) return
+            state.settings.unreadCountTitle = action.meta.arg
+        })
+        builder.addCase(changeUnreadCountFavicon.pending, (state, action) => {
+            if (!state.settings) return
+            state.settings.unreadCountFavicon = action.meta.arg
+        })
+        builder.addCase(changeSharingSetting.pending, (state, action) => {
+            if (!state.settings) return
+            state.settings.sharingSettings[action.meta.arg.site] = action.meta.arg.value
+        })
+        builder.addMatcher(
+            isAnyOf(
+                changeLanguage.fulfilled,
+                changeScrollSpeed.fulfilled,
+                changeShowRead.fulfilled,
+                changeScrollMarks.fulfilled,
+                changeScrollMode.fulfilled,
+                changeEntriesToKeepOnTopWhenScrolling.fulfilled,
+                changeStarIconDisplayMode.fulfilled,
+                changeExternalLinkIconDisplayMode.fulfilled,
+                changeMarkAllAsReadConfirmation.fulfilled,
+                changeCustomContextMenu.fulfilled,
+                changeMobileFooter.fulfilled,
+                changeUnreadCountTitle.fulfilled,
+                changeUnreadCountFavicon.fulfilled,
+                changeSharingSetting.fulfilled
+            ),
+            () => {
+                showNotification({
+                    message: t`Settings saved.`,
+                    color: "green",
+                })
+            }
+        )
+    },
+})
+
+export const { setViewMode, setSidebarWidth, setAnnouncementHash } = userSlice.actions

commafeed-client/src/app/user/thunks.ts

@@ -0,0 +1,135 @@
+import { createAppAsyncThunk } from "app/async-thunk"
+import { client } from "app/client"
+import { reloadEntries } from "app/entries/thunks"
+import type { IconDisplayMode, ReadingMode, ReadingOrder, ScrollMode, SharingSettings } from "app/types"
+
+export const reloadSettings = createAppAsyncThunk("settings/reload", async () => await client.user.getSettings().then(r => r.data))
+
+export const reloadProfile = createAppAsyncThunk("profile/reload", async () => await client.user.getProfile().then(r => r.data))
+
+export const reloadTags = createAppAsyncThunk("entries/tags", async () => await client.entry.getTags().then(r => r.data))
+
+export const changeReadingMode = createAppAsyncThunk("settings/readingMode", (readingMode: ReadingMode, thunkApi) => {
+    const { settings } = thunkApi.getState().user
+    if (!settings) return
+    client.user.saveSettings({ ...settings, readingMode })
+    thunkApi.dispatch(reloadEntries())
+})
+
+export const changeReadingOrder = createAppAsyncThunk("settings/readingOrder", (readingOrder: ReadingOrder, thunkApi) => {
+    const { settings } = thunkApi.getState().user
+    if (!settings) return
+    client.user.saveSettings({ ...settings, readingOrder })
+    thunkApi.dispatch(reloadEntries())
+})
+
+export const changeLanguage = createAppAsyncThunk("settings/language", (language: string, thunkApi) => {
+    const { settings } = thunkApi.getState().user
+    if (!settings) return
+    client.user.saveSettings({ ...settings, language })
+})
+
+export const changeScrollSpeed = createAppAsyncThunk("settings/scrollSpeed", (speed: boolean, thunkApi) => {
+    const { settings } = thunkApi.getState().user
+    if (!settings) return
+    client.user.saveSettings({ ...settings, scrollSpeed: speed ? 400 : 0 })
+})
+
+export const changeShowRead = createAppAsyncThunk("settings/showRead", (showRead: boolean, thunkApi) => {
+    const { settings } = thunkApi.getState().user
+    if (!settings) return
+    client.user.saveSettings({ ...settings, showRead })
+})
+
+export const changeScrollMarks = createAppAsyncThunk("settings/scrollMarks", (scrollMarks: boolean, thunkApi) => {
+    const { settings } = thunkApi.getState().user
+    if (!settings) return
+    client.user.saveSettings({ ...settings, scrollMarks })
+})
+
+export const changeScrollMode = createAppAsyncThunk("settings/scrollMode", (scrollMode: ScrollMode, thunkApi) => {
+    const { settings } = thunkApi.getState().user
+    if (!settings) return
+    client.user.saveSettings({ ...settings, scrollMode })
+})
+
+export const changeEntriesToKeepOnTopWhenScrolling = createAppAsyncThunk(
+    "settings/entriesToKeepOnTopWhenScrolling",
+    (entriesToKeepOnTopWhenScrolling: number, thunkApi) => {
+        const { settings } = thunkApi.getState().user
+        if (!settings) return
+        client.user.saveSettings({ ...settings, entriesToKeepOnTopWhenScrolling })
+    }
+)
+
+export const changeStarIconDisplayMode = createAppAsyncThunk(
+    "settings/starIconDisplayMode",
+    (starIconDisplayMode: IconDisplayMode, thunkApi) => {
+        const { settings } = thunkApi.getState().user
+        if (!settings) return
+        client.user.saveSettings({ ...settings, starIconDisplayMode })
+    }
+)
+
+export const changeExternalLinkIconDisplayMode = createAppAsyncThunk(
+    "settings/externalLinkIconDisplayMode",
+    (externalLinkIconDisplayMode: IconDisplayMode, thunkApi) => {
+        const { settings } = thunkApi.getState().user
+        if (!settings) return
+        client.user.saveSettings({ ...settings, externalLinkIconDisplayMode })
+    }
+)
+
+export const changeMarkAllAsReadConfirmation = createAppAsyncThunk(
+    "settings/markAllAsReadConfirmation",
+    (markAllAsReadConfirmation: boolean, thunkApi) => {
+        const { settings } = thunkApi.getState().user
+        if (!settings) return
+        client.user.saveSettings({ ...settings, markAllAsReadConfirmation })
+    }
+)
+
+export const changeCustomContextMenu = createAppAsyncThunk("settings/customContextMenu", (customContextMenu: boolean, thunkApi) => {
+    const { settings } = thunkApi.getState().user
+    if (!settings) return
+    client.user.saveSettings({ ...settings, customContextMenu })
+})
+
+export const changeMobileFooter = createAppAsyncThunk("settings/mobileFooter", (mobileFooter: boolean, thunkApi) => {
+    const { settings } = thunkApi.getState().user
+    if (!settings) return
+    client.user.saveSettings({ ...settings, mobileFooter })
+})
+
+export const changeUnreadCountTitle = createAppAsyncThunk("settings/unreadCountTitle", (unreadCountTitle: boolean, thunkApi) => {
+    const { settings } = thunkApi.getState().user
+    if (!settings) return
+    client.user.saveSettings({ ...settings, unreadCountTitle })
+})
+
+export const changeUnreadCountFavicon = createAppAsyncThunk("settings/unreadCountFavicon", (unreadCountFavicon: boolean, thunkApi) => {
+    const { settings } = thunkApi.getState().user
+    if (!settings) return
+    client.user.saveSettings({ ...settings, unreadCountFavicon })
+})
+
+export const changeSharingSetting = createAppAsyncThunk(
+    "settings/sharingSetting",
+    (
+        sharingSetting: {
+            site: keyof SharingSettings
+            value: boolean
+        },
+        thunkApi
+    ) => {
+        const { settings } = thunkApi.getState().user
+        if (!settings) return
+        client.user.saveSettings({
+            ...settings,
+            sharingSettings: {
+                ...settings.sharingSettings,
+                [sharingSetting.site]: sharingSetting.value,
+            },
+        })
+    }
+)

commafeed-client/src/app/utils.ts

@@ -1,66 +1,60 @@
-import { Category } from "./types"
+import { throttle } from "throttle-debounce"
-
+import type { Category } from "./types"
-export function visitCategoryTree(category: Category, visitor: (category: Category) => void): void {
+
-    visitor(category)
+export function visitCategoryTree(
-    category.children.forEach(child => visitCategoryTree(child, visitor))
+    category: Category,
-}
+    visitor: (category: Category) => void,
-
+    options?: {
-export function flattenCategoryTree(category: Category): Category[] {
+        childrenFirst?: boolean
-    const categories: Category[] = []
+    }
-    visitCategoryTree(category, c => categories.push(c))
+): void {
-    return categories
+    const childrenFirst = options?.childrenFirst
-}
+
-
+    if (!childrenFirst) visitor(category)
-export function categoryUnreadCount(category?: Category): number {
+
-    if (!category) return 0
+    for (const child of category.children) {
-
+        visitCategoryTree(child, visitor, options)
-    return flattenCategoryTree(category)
+    }
-        .flatMap(c => c.feeds)
+
-        .map(f => f.unread)
+    if (childrenFirst) visitor(category)
-        .reduce((total, current) => total + current, 0)
+}
-}
+
-
+export function flattenCategoryTree(category: Category): Category[] {
-export const calculatePlaceholderSize = ({ width, height, maxWidth }: { width?: number; height?: number; maxWidth: number }) => {
+    const categories: Category[] = []
-    const placeholderWidth = width && Math.min(width, maxWidth)
+    visitCategoryTree(category, c => categories.push(c))
-    const placeholderHeight = height && width && width > maxWidth ? height * (maxWidth / width) : height
+    return categories
-    return { width: placeholderWidth, height: placeholderHeight }
+}
-}
+
-
+export function categoryUnreadCount(category?: Category): number {
-export const scrollToWithCallback = ({
+    if (!category) return 0
-    element,
+
-    options,
+    return flattenCategoryTree(category)
-    onScrollEnded,
+        .flatMap(c => c.feeds)
-}: {
+        .map(f => f.unread)
-    element: HTMLElement
+        .reduce((total, current) => total + current, 0)
-    options: ScrollToOptions
+}
-    onScrollEnded: () => void
+
-}) => {
+export const calculatePlaceholderSize = ({ width, height, maxWidth }: { width?: number; height?: number; maxWidth: number }) => {
-    const offset = (options.top ?? 0).toFixed()
+    const placeholderWidth = width && Math.min(width, maxWidth)
-
+    const placeholderHeight = height && width && width > maxWidth ? height * (maxWidth / width) : height
-    const onScroll = () => {
+    return { width: placeholderWidth, height: placeholderHeight }
-        if (element.offsetTop.toFixed() === offset) {
+}
-            element.removeEventListener("scroll", onScroll)
+
-            onScrollEnded()
+export const scrollToWithCallback = ({ options, onScrollEnded }: { options: ScrollToOptions; onScrollEnded: () => void }) => {
-        }
+    const offset = (options.top ?? 0).toFixed()
-    }
+
-
+    const onScroll = throttle(100, () => {
-    element.addEventListener("scroll", onScroll)
+        if (window.scrollY.toFixed() === offset) {
-
+            window.removeEventListener("scroll", onScroll)
-    // scrollTo does not trigger if there's nothing to do, trigger it manually
+            onScrollEnded()
-    onScroll()
+        }
-
+    })
-    element.scrollTo(options)
+    window.addEventListener("scroll", onScroll)
-}
+
-
+    // scrollTo does not trigger if there's nothing to do, trigger it manually
-export const openLinkInBackgroundTab = (url: string) => {
+    onScroll()
-    // simulate ctrl+click to open tab in background
+
-    const a = document.createElement("a")
+    window.scrollTo(options)
-    a.href = url
+}
-    a.rel = "noreferrer"
+
-    a.dispatchEvent(
+export const truncate = (str: string, n: number) => (str.length > n ? `${str.slice(0, n - 1)}\u2026` : str)
-        new MouseEvent("click", {
-            ctrlKey: true,
-            metaKey: true,
-        })
-    )
-}

commafeed-client/src/assets/logo.svg

@@ -1,20 +1,10 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<svg height="512" width="512" viewBox="0 0 6.5625 6.5625" xmlns="http://www.w3.org/2000/svg" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd">
+<svg height="512" width="512" viewBox="0 0 6.5625 6.5625" xmlns="http://www.w3.org/2000/svg">
- <sodipodi:namedview guidetolerance="10">
+	<rect fill="#f88a14" rx="0.7" ry="0.7" height="6.5625" width="6.5625" />
-  <sodipodi:guide position="154.17325,117.15254" orientation="0,1"/>
+	<path d="m1.9761,1.5289c2.9002,0,2.9002,2.9101,2.9002,2.9101" fill="none" stroke="#FFF" stroke-linecap="round"
-  <sodipodi:guide position="154.17325,166.44575" orientation="0,1"/>
+		  stroke-width="0.78125" />
-  <sodipodi:guide position="154.17325,288.40369" orientation="0,1"/>
+	<path d="m1.9688,2.875c1.5705-0.00908,1.5705,1.5639,1.5705,1.5639" fill="none" stroke="#FFF" stroke-linecap="round"
-  <sodipodi:guide position="380.44742,392.71992" orientation="0,1"/>
+		  stroke-width="0.78125" />
-  <sodipodi:guide position="101.9661,166.44575" orientation="1,0"/>
+	<path d="m2.6503,4.4062c0,0.23366-0.10712,0.47418-0.24663,0.6537-0.1814,0.2333-0.5705,0.5618-0.6913,0.5653,0.0402-0.0662,0.263-0.5654,0.2563-0.5654-0.36423,0-0.6595-0.29265-0.6595-0.65365s0.29527-0.65365,0.6595-0.65365,0.68159,0.29265,0.68159,0.65365z"
-  <sodipodi:guide position="276.13119,288.40369" orientation="1,0"/>
+		  fill="#FFF" />
-  <sodipodi:guide position="380.44742,165.67871" orientation="1,0"/>
-  <sodipodi:guide position="154.17325,288.40369" orientation="1,0"/>
-  <sodipodi:guide position="154.17325,166.44575" orientation="-0.70710678,0.70710678"/>
-  <sodipodi:guide position="123.21968,135.49218" orientation="1,0"/>
-  <sodipodi:guide position="123.21968,135.49218" orientation="0,1"/>
- </sodipodi:namedview>
- <rect fill="#f88a14" rx="0.7" ry="0.7" height="6.5625" width="6.5625"/>
- <path d="m1.9761,1.5289c2.9002,0,2.9002,2.9101,2.9002,2.9101" fill="none" stroke="#FFF" stroke-linecap="round" stroke-width="0.78125"/>
- <path d="m1.9688,2.875c1.5705-0.00908,1.5705,1.5639,1.5705,1.5639" fill="none" stroke="#FFF" stroke-linecap="round" stroke-width="0.78125"/>
- <path d="m2.6503,4.4062c0,0.23366-0.10712,0.47418-0.24663,0.6537-0.1814,0.2333-0.5705,0.5618-0.6913,0.5653,0.0402-0.0662,0.263-0.5654,0.2563-0.5654-0.36423,0-0.6595-0.29265-0.6595-0.65365s0.29527-0.65365,0.6595-0.65365,0.68159,0.29265,0.68159,0.65365z" fill="#FFF"/>
 </svg>

commafeed-client/src/components/ActionButton.test.tsx

@@ -0,0 +1,47 @@
+import type { I18nContext } from "@lingui/react"
+import { MantineProvider } from "@mantine/core"
+import { fireEvent, render, screen, waitFor } from "@testing-library/react"
+import { useActionButton } from "hooks/useActionButton"
+import { describe, expect, it, vi } from "vitest"
+import { ActionButton } from "./ActionButton"
+
+vi.mock(import("@lingui/react"), () => ({
+    useLingui: vi.fn().mockReturnValue({
+        _: msg => msg,
+    } as I18nContext),
+}))
+vi.mock(import("hooks/useActionButton"))
+
+const label = "Test Label"
+const icon = "Test Icon"
+describe("ActionButton", () => {
+    it("renders Button with label on desktop", () => {
+        vi.mocked(useActionButton).mockReturnValue({ mobile: false, spacing: 0 })
+
+        render(<ActionButton label={label} icon={icon} />, { wrapper: MantineProvider })
+        expect(screen.getByText(label)).toBeInTheDocument()
+        expect(screen.getByText(icon)).toBeInTheDocument()
+    })
+
+    it("renders ActionIcon with tooltip on mobile", async () => {
+        vi.mocked(useActionButton).mockReturnValue({ mobile: true, spacing: 0 })
+
+        render(<ActionButton label={label} icon={icon} />, { wrapper: MantineProvider })
+        expect(screen.queryByText(label)).not.toBeInTheDocument()
+        expect(screen.getByText(icon)).toBeInTheDocument()
+
+        fireEvent.mouseEnter(screen.getByRole("button"))
+        const tooltip = await waitFor(() => screen.getByRole("tooltip"))
+        expect(tooltip).toContainHTML(label)
+    })
+
+    it("calls onClick handler when clicked", () => {
+        vi.mocked(useActionButton).mockReturnValue({ mobile: false, spacing: 0 })
+        const clickListener = vi.fn()
+
+        render(<ActionButton label={label} icon={icon} onClick={clickListener} />, { wrapper: MantineProvider })
+        fireEvent.click(screen.getByRole("button"))
+
+        expect(clickListener).toHaveBeenCalled()
+    })
+})

commafeed-client/src/components/ActionButton.tsx

@@ -0,0 +1,62 @@
+import type { MessageDescriptor } from "@lingui/core"
+import { useLingui } from "@lingui/react"
+import { ActionIcon, Box, Button, type ButtonVariant, Tooltip, useMantineTheme } from "@mantine/core"
+import type { ActionIconVariant } from "@mantine/core/lib/components/ActionIcon/ActionIcon"
+import { Constants } from "app/constants"
+import { useActionButton } from "hooks/useActionButton"
+import { type MouseEventHandler, type ReactNode, forwardRef } from "react"
+
+interface ActionButtonProps {
+    icon: ReactNode
+    className?: string
+    label?: string | MessageDescriptor
+    onClick?: MouseEventHandler
+    variant?: ActionIconVariant & ButtonVariant
+    hideLabelOnDesktop?: boolean
+    showLabelOnMobile?: boolean
+}
+
+/**
+ * Switches between Button with label (desktop) and ActionIcon (mobile)
+ */
+export const ActionButton = forwardRef<HTMLDivElement, ActionButtonProps>((props: ActionButtonProps, ref) => {
+    const { mobile } = useActionButton()
+    const theme = useMantineTheme()
+    const { _ } = useLingui()
+
+    const label = typeof props.label === "string" ? props.label : props.label && _(props.label)
+    const variant = props.variant ?? "subtle"
+    const iconOnly = (mobile && !props.showLabelOnMobile) || (!mobile && props.hideLabelOnDesktop)
+
+    return (
+        <Box ref={ref}>
+            {iconOnly && (
+                <Tooltip label={label} openDelay={Constants.tooltip.delay}>
+                    <ActionIcon
+                        color={theme.primaryColor}
+                        variant={variant}
+                        className={props.className}
+                        onClick={props.onClick}
+                        aria-label={label}
+                    >
+                        {props.icon}
+                    </ActionIcon>
+                </Tooltip>
+            )}
+            {!iconOnly && (
+                <Button
+                    variant={variant}
+                    size="xs"
+                    className={props.className}
+                    leftSection={props.icon}
+                    onClick={props.onClick}
+                    aria-label={label}
+                >
+                    {label}
+                </Button>
+            )}
+        </Box>
+    )
+})
+
+ActionButton.displayName = "HeaderButton"

commafeed-client/src/components/ActionButtton.tsx

@@ -1,33 +0,0 @@
-import { ActionIcon, Button, ButtonVariant, useMantineTheme } from "@mantine/core"
-import { ActionIconVariant } from "@mantine/core/lib/ActionIcon/ActionIcon.styles"
-import { useMediaQuery } from "@mantine/hooks"
-import { forwardRef, MouseEventHandler, ReactNode } from "react"
-
-interface ActionButtonProps {
-    className?: string
-    icon?: ReactNode
-    label?: string
-    onClick?: MouseEventHandler
-    variant?: ActionIconVariant & ButtonVariant
-    showLabelOnMobile?: boolean
-}
-
-/**
- * Switches between Button with label (desktop) and ActionIcon (mobile)
- */
-export const ActionButton = forwardRef<HTMLButtonElement, ActionButtonProps>((props: ActionButtonProps, ref) => {
-    const theme = useMantineTheme()
-    const variant = props.variant ?? "subtle"
-    const mobile = !useMediaQuery(`(min-width: ${theme.breakpoints.lg}px)`)
-    const iconOnly = !props.showLabelOnMobile && (mobile || !props.label)
-    return iconOnly ? (
-        <ActionIcon ref={ref} color={theme.primaryColor} variant={variant} className={props.className} onClick={props.onClick}>
-            {props.icon}
-        </ActionIcon>
-    ) : (
-        <Button ref={ref} variant={variant} size="xs" className={props.className} leftIcon={props.icon} onClick={props.onClick}>
-            {props.label}
-        </Button>
-    )
-})
-ActionButton.displayName = "HeaderButton"

commafeed-client/src/components/Alert.tsx

@@ -1,48 +1,47 @@
-import { t } from "@lingui/macro"
+import { Trans } from "@lingui/react/macro"
-import { Alert as MantineAlert, Box } from "@mantine/core"
+import { Box, Alert as MantineAlert } from "@mantine/core"
-import { Fragment } from "react"
+import { Fragment } from "react"
-import { TbAlertCircle, TbAlertTriangle, TbCircleCheck } from "react-icons/tb"
+import { TbAlertCircle, TbAlertTriangle, TbCircleCheck } from "react-icons/tb"
-
+
-type Level = "error" | "warning" | "success"
+type Level = "error" | "warning" | "success"
-export interface ErrorsAlertProps {
+
-    level?: Level
+export interface ErrorsAlertProps {
-    messages: string[]
+    level?: Level
-}
+    messages: string[]
-
+}
-export function Alert(props: ErrorsAlertProps) {
+
-    let title: string
+export function Alert(props: ErrorsAlertProps) {
-    let color: string
+    let title: React.ReactNode
-    let icon: React.ReactNode
+    let color: string
-
+    let icon: React.ReactNode
-    const level = props.level ?? "error"
+
-    switch (level) {
+    const level = props.level ?? "error"
-        case "error":
+    switch (level) {
-            title = t`Error`
+        case "error":
-            color = "red"
+            title = <Trans>Error</Trans>
-            icon = <TbAlertCircle />
+            color = "red"
-            break
+            icon = <TbAlertCircle />
-        case "warning":
+            break
-            title = t`Warning`
+        case "warning":
-            color = "orange"
+            title = <Trans>Warning</Trans>
-            icon = <TbAlertTriangle />
+            color = "orange"
-            break
+            icon = <TbAlertTriangle />
-        case "success":
+            break
-            title = t`Success`
+        case "success":
-            color = "green"
+            title = <Trans>Success</Trans>
-            icon = <TbCircleCheck />
+            color = "green"
-            break
+            icon = <TbCircleCheck />
-        default:
+            break
-            throw Error(`unsupported level: ${level}`)
+    }
-    }
+
-
+    return (
-    return (
+        <MantineAlert title={title} color={color} icon={icon}>
-        <MantineAlert title={title} color={color} icon={icon}>
+            {props.messages.map((m, i) => (
-            {props.messages.map((m, i) => (
+                <Fragment key={m}>
-                <Fragment key={m}>
+                    <Box>{m}</Box>
-                    <Box>{m}</Box>
+                    {i !== props.messages.length - 1 && <br />}
-                    {i !== props.messages.length - 1 && <br />}
+                </Fragment>
-                </Fragment>
+            ))}
-            ))}
+        </MantineAlert>
-        </MantineAlert>
+    )
-    )
+}
-}

commafeed-client/src/components/AnnouncementDialog.tsx

@@ -0,0 +1,37 @@
+import { Trans } from "@lingui/react/macro"
+import { Box, Dialog, Text } from "@mantine/core"
+import { useAppDispatch, useAppSelector } from "app/store"
+import { setAnnouncementHash } from "app/user/slice"
+import { Content } from "components/content/Content"
+import { useAsync } from "react-async-hook"
+
+const sha256Hex = async (input: string | undefined) => {
+    const data = new TextEncoder().encode(input)
+    const buffer = await crypto.subtle.digest("SHA-256", data)
+    const array = Array.from(new Uint8Array(buffer))
+    return array.map(b => b.toString(16).padStart(2, "0")).join("")
+}
+
+export function AnnouncementDialog() {
+    const announcement = useAppSelector(state => state.server.serverInfos?.announcement)
+    const announcementHash = useAsync(sha256Hex, [announcement]).result
+    const existingAnnouncementHash = useAppSelector(state => state.user.localSettings.announcementHash)
+    const dispatch = useAppDispatch()
+
+    const opened = !!announcementHash && announcementHash !== existingAnnouncementHash
+    const onClosed = () => announcementHash && dispatch(setAnnouncementHash(announcementHash))
+
+    if (!announcement) return null
+    return (
+        <Dialog opened={opened} withCloseButton onClose={onClosed} size="xl" radius="md">
+            <Box>
+                <Text fw="bold">
+                    <Trans>Announcement</Trans>
+                </Text>
+            </Box>
+            <Box>
+                <Content content={announcement} />
+            </Box>
+        </Dialog>
+    )
+}

commafeed-client/src/components/ButtonToolbar.tsx

@@ -1,5 +0,0 @@
-import { Group } from "@mantine/core"
-
-export function ButtonToolbar(props: { children: React.ReactNode }) {
-    return <Group spacing={14}>{props.children}</Group>
-}

commafeed-client/src/components/DisablePullToRefresh.css

@@ -0,0 +1,4 @@
+html,
+body {
+    overscroll-behavior: none;
+}

commafeed-client/src/components/DisablePullToRefresh.tsx

@@ -0,0 +1,4 @@
+export const DisablePullToRefresh = () => {
+    import("./DisablePullToRefresh.css")
+    return <></>
+}

commafeed-client/src/components/ErrorBoundary.tsx

@@ -1,26 +1,26 @@
-import { ErrorPage } from "pages/ErrorPage"
+import { ErrorPage } from "pages/ErrorPage"
-import React, { ReactNode } from "react"
+import React, { type ReactNode } from "react"
-
+
-interface ErrorBoundaryProps {
+interface ErrorBoundaryProps {
-    children?: ReactNode
+    children?: ReactNode
-}
+}
-
+
-interface ErrorBoundaryState {
+interface ErrorBoundaryState {
-    error?: Error
+    error?: Error
-}
+}
-
+
-export class ErrorBoundary extends React.Component<ErrorBoundaryProps, ErrorBoundaryState> {
+export class ErrorBoundary extends React.Component<ErrorBoundaryProps, ErrorBoundaryState> {
-    constructor(props: ErrorBoundaryProps) {
+    constructor(props: ErrorBoundaryProps) {
-        super(props)
+        super(props)
-        this.state = {}
+        this.state = {}
-    }
+    }
-
+
-    componentDidCatch(error: Error) {
+    componentDidCatch(error: Error) {
-        this.setState({ error })
+        this.setState({ error })
-    }
+    }
-
+
-    render() {
+    render() {
-        if (this.state.error) return <ErrorPage error={this.state.error} />
+        if (this.state.error) return <ErrorPage error={this.state.error} />
-        return this.props.children
+        return this.props.children
-    }
+    }
-}
+}

commafeed-client/src/components/ImageWithPlaceholderWhileLoading.tsx

@@ -1,54 +1,81 @@
-import { Box, Center, createStyles } from "@mantine/core"
+import { Box, Center } from "@mantine/core"
-import { useState } from "react"
+import { useState } from "react"
-import { TbPhoto } from "react-icons/tb"
+import { TbPhoto } from "react-icons/tb"
-
+import { tss } from "tss"
-interface ImageWithPlaceholderWhileLoadingProps {
+
-    src: string
+interface ImageWithPlaceholderWhileLoadingProps {
-    alt: string
+    src: string
-    title?: string
+    alt: string
-    width?: number
+    title?: string
-    height?: number | "auto"
+    width?: number
-    placeholderWidth?: number
+    height?: number | "auto"
-    placeholderHeight?: number
+    style?: React.CSSProperties
-    placeholderBackgroundColor?: string
+    placeholderWidth?: number
-    placeholderIconSize?: number
+    placeholderHeight?: number
-    placeholderIconColor?: string
+    placeholderBackgroundColor?: string
-}
+    placeholderIconSize?: number
-
+}
-const useStyles = createStyles((theme, props: ImageWithPlaceholderWhileLoadingProps) => ({
+
-    placeholder: {
+const useStyles = tss
-        width: props.placeholderWidth ?? 400,
+    .withParams<{
-        height: props.placeholderHeight ?? 600,
+        placeholderWidth?: number
-        maxWidth: "100%",
+        placeholderHeight?: number
-        color: props.placeholderIconColor ?? theme.fn.variant({ color: theme.primaryColor, variant: "subtle" }).color,
+        placeholderBackgroundColor?: string
-        backgroundColor: props.placeholderBackgroundColor ?? (theme.colorScheme === "dark" ? theme.colors.dark[5] : theme.colors.gray[1]),
+    }>()
-    },
+    .create(props => ({
-}))
+        placeholder: {
-
+            width: props.placeholderWidth ?? 400,
-export function ImageWithPlaceholderWhileLoading(props: ImageWithPlaceholderWhileLoadingProps) {
+            height: props.placeholderHeight ?? 600,
-    const { classes } = useStyles(props)
+            maxWidth: "100%",
-    const [loading, setLoading] = useState(true)
+            backgroundColor:
-
+                props.placeholderBackgroundColor ??
-    return (
+                (props.colorScheme === "dark" ? props.theme.colors.dark[5] : props.theme.colors.gray[1]),
-        <>
+        },
-            {loading && (
+    }))
-                <Box>
+
-                    <Center className={classes.placeholder}>
+export function ImageWithPlaceholderWhileLoading({
-                        <div>
+    alt,
-                            <TbPhoto size={props.placeholderIconSize ?? 48} />
+    height,
-                        </div>
+    placeholderBackgroundColor,
-                    </Center>
+    placeholderHeight,
-                </Box>
+    placeholderIconSize,
-            )}
+    placeholderWidth,
-            <img
+    src,
-                src={props.src}
+    title,
-                alt={props.alt}
+    width,
-                title={props.title}
+    style,
-                width={props.width}
+}: ImageWithPlaceholderWhileLoadingProps) {
-                height={props.height}
+    const { classes } = useStyles({
-                onLoad={() => setLoading(false)}
+        placeholderWidth,
-                style={{ display: loading ? "none" : "block" }}
+        placeholderHeight,
-            />
+        placeholderBackgroundColor,
-        </>
+    })
-    )
+    const [loading, setLoading] = useState(true)
-}
+
+    return (
+        <>
+            {loading && (
+                <Box>
+                    <Center className={classes.placeholder}>
+                        <div>
+                            <TbPhoto size={placeholderIconSize ?? 48} />
+                        </div>
+                    </Center>
+                </Box>
+            )}
+            <img
+                src={src}
+                alt={alt}
+                title={title}
+                width={width}
+                height={height}
+                onLoad={() => setLoading(false)}
+                style={{
+                    ...style,
+                    display: loading ? "none" : (style?.display ?? "initial"),
+                    height: style?.width ? "auto" : style?.height,
+                }}
+            />
+        </>
+    )
+}

commafeed-client/src/components/KeyboardShortcutsHelp.tsx

@@ -1,183 +1,242 @@
-import { Trans } from "@lingui/macro"
+import { Trans } from "@lingui/react/macro"
-import { Kbd, Table } from "@mantine/core"
+import { Anchor, Box, Kbd, Stack, Table } from "@mantine/core"
-
+import { useOs } from "@mantine/hooks"
-export function KeyboardShortcutsHelp() {
+import { Constants } from "app/constants"
-    return (
+
-        <Table striped highlightOnHover>
+export function KeyboardShortcutsHelp() {
-            <tbody>
+    const isMacOS = useOs() === "macos"
-                <tr>
+    return (
-                    <td>
+        <Stack gap="xs">
-                        <Trans>Refresh</Trans>
+            <Table striped highlightOnHover>
-                    </td>
+                <Table.Tbody>
-                    <td>
+                    <Table.Tr>
-                        <Kbd>R</Kbd>
+                        <Table.Td>
-                    </td>
+                            <Trans>Refresh</Trans>
-                </tr>
+                        </Table.Td>
-                <tr>
+                        <Table.Td>
-                    <td>
+                            <Kbd>R</Kbd>
-                        <Trans>Open next entry</Trans>
+                        </Table.Td>
-                    </td>
+                    </Table.Tr>
-                    <td>
+                    <Table.Tr>
-                        <Kbd>J</Kbd>
+                        <Table.Td>
-                    </td>
+                            <Trans>Open next entry</Trans>
-                </tr>
+                        </Table.Td>
-                <tr>
+                        <Table.Td>
-                    <td>
+                            <Kbd>J</Kbd>
-                        <Trans>Open previous entry</Trans>
+                        </Table.Td>
-                    </td>
+                    </Table.Tr>
-                    <td>
+                    <Table.Tr>
-                        <Kbd>K</Kbd>
+                        <Table.Td>
-                    </td>
+                            <Trans>Open previous entry</Trans>
-                </tr>
+                        </Table.Td>
-                <tr>
+                        <Table.Td>
-                    <td>
+                            <Kbd>K</Kbd>
-                        <Trans>Set focus on next entry without opening it</Trans>
+                        </Table.Td>
-                    </td>
+                    </Table.Tr>
-                    <td>
+                    <Table.Tr>
-                        <Kbd>N</Kbd>
+                        <Table.Td>
-                    </td>
+                            <Trans>Select next unread feed/category</Trans>
-                </tr>
+                        </Table.Td>
-                <tr>
+                        <Table.Td>
-                    <td>
+                            <Kbd>Shift</Kbd>
-                        <Trans>Set focus on previous entry without opening it</Trans>
+                            <span> + </span>
-                    </td>
+                            <Kbd>J</Kbd>
-                    <td>
+                        </Table.Td>
-                        <Kbd>P</Kbd>
+                    </Table.Tr>
-                    </td>
+                    <Table.Tr>
-                </tr>
+                        <Table.Td>
-                <tr>
+                            <Trans>Select previous unread feed/category</Trans>
-                    <td>
+                        </Table.Td>
-                        <Trans>Move the page down</Trans>
+                        <Table.Td>
-                    </td>
+                            <Kbd>Shift</Kbd>
-                    <td>
+                            <span> + </span>
-                        <Kbd>
+                            <Kbd>K</Kbd>
-                            <Trans>Space</Trans>
+                        </Table.Td>
-                        </Kbd>
+                    </Table.Tr>
-                    </td>
+                    <Table.Tr>
-                </tr>
+                        <Table.Td>
-                <tr>
+                            <Trans>Set focus on next entry without opening it</Trans>
-                    <td>
+                        </Table.Td>
-                        <Trans>Move the page up</Trans>
+                        <Table.Td>
-                    </td>
+                            <Kbd>N</Kbd>
-                    <td>
+                        </Table.Td>
-                        <Kbd>
+                    </Table.Tr>
-                            <Trans>Shift</Trans>
+                    <Table.Tr>
-                        </Kbd>
+                        <Table.Td>
-                        <span> + </span>
+                            <Trans>Set focus on previous entry without opening it</Trans>
-                        <Kbd>
+                        </Table.Td>
-                            <Trans>Space</Trans>
+                        <Table.Td>
-                        </Kbd>
+                            <Kbd>P</Kbd>
-                    </td>
+                        </Table.Td>
-                </tr>
+                    </Table.Tr>
-                <tr>
+                    <Table.Tr>
-                    <td>
+                        <Table.Td>
-                        <Trans>Open/close current entry</Trans>
+                            <Trans>Move the page down</Trans>
-                    </td>
+                        </Table.Td>
-                    <td>
+                        <Table.Td>
-                        <Kbd>O</Kbd>
+                            <Kbd>
-                        <span>, </span>
+                                <Trans>Space</Trans>
-                        <Kbd>
+                            </Kbd>
-                            <Trans>Enter</Trans>
+                        </Table.Td>
-                        </Kbd>
+                    </Table.Tr>
-                    </td>
+                    <Table.Tr>
-                </tr>
+                        <Table.Td>
-                <tr>
+                            <Trans>Move the page up</Trans>
-                    <td>
+                        </Table.Td>
-                        <Trans>Open current entry in a new tab</Trans>
+                        <Table.Td>
-                    </td>
+                            <Kbd>
-                    <td>
+                                <Trans>Shift</Trans>
-                        <Kbd>V</Kbd>
+                            </Kbd>
-                    </td>
+                            <span> + </span>
-                </tr>
+                            <Kbd>
-                <tr>
+                                <Trans>Space</Trans>
-                    <td>
+                            </Kbd>
-                        <Trans>Open current entry in a new tab in the background</Trans>
+                        </Table.Td>
-                    </td>
+                    </Table.Tr>
-                    <td>
+                    <Table.Tr>
-                        <Kbd>B</Kbd>
+                        <Table.Td>
-                        <span>, </span>
+                            <Trans>Open/close current entry</Trans>
-                        <Kbd>
+                        </Table.Td>
-                            <Trans>Middle click</Trans>
+                        <Table.Td>
-                        </Kbd>
+                            <Kbd>O</Kbd>
-                    </td>
+                            <span>, </span>
-                </tr>
+                            <Kbd>
-                <tr>
+                                <Trans>Enter</Trans>
-                    <td>
+                            </Kbd>
-                        <Trans>Toggle read status of current entry</Trans>
+                        </Table.Td>
-                    </td>
+                    </Table.Tr>
-                    <td>
+                    <Table.Tr>
-                        <Kbd>M</Kbd>
+                        <Table.Td>
-                        <span>, </span>
+                            <Trans>Open current entry in a new tab</Trans>
-                        <Trans>Swipe header to the right</Trans>
+                        </Table.Td>
-                    </td>
+                        <Table.Td>
-                </tr>
+                            <Kbd>V</Kbd>
-                <tr>
+                        </Table.Td>
-                    <td>
+                    </Table.Tr>
-                        <Trans>Mark all entries as read</Trans>
+                    <Table.Tr>
-                    </td>
+                        <Table.Td>
-                    <td>
+                            <Trans>Open current entry in a new tab in the background</Trans>
-                        <Kbd>
+                        </Table.Td>
-                            <Trans>Shift</Trans>
+                        <Table.Td>
-                        </Kbd>
+                            <Kbd>B</Kbd>
-                        <span> + </span>
+                            <span>*, </span>
-                        <Kbd>A</Kbd>
+                            <Kbd>
-                    </td>
+                                <Trans>Middle click</Trans>
-                </tr>
+                            </Kbd>
-                <tr>
+                        </Table.Td>
-                    <td>
+                    </Table.Tr>
-                        <Trans>Go to the All view</Trans>
+                    <Table.Tr>
-                    </td>
+                        <Table.Td>
-                    <td>
+                            <Trans>Toggle read status of current entry</Trans>
-                        <Kbd>G</Kbd>
+                        </Table.Td>
-                        <span> </span>
+                        <Table.Td>
-                        <Kbd>A</Kbd>
+                            <Kbd>M</Kbd>
-                    </td>
+                            <span>, </span>
-                </tr>
+                            <Trans>Swipe header to the left</Trans>
-                <tr>
+                        </Table.Td>
-                    <td>
+                    </Table.Tr>
-                        <Trans>Navigate to a subscription by entering its name</Trans>
+                    <Table.Tr>
-                    </td>
+                        <Table.Td>
-                    <td>
+                            <Trans>Toggle starred status of current entry</Trans>
-                        <Kbd>
+                        </Table.Td>
-                            <Trans>Ctrl</Trans>
+                        <Table.Td>
-                        </Kbd>
+                            <Kbd>S</Kbd>
-                        <span> + </span>
+                        </Table.Td>
-                        <Kbd>K</Kbd>
+                    </Table.Tr>
-                        <span>, </span>
+                    <Table.Tr>
-                        <Kbd>G</Kbd>
+                        <Table.Td>
-                        <span> </span>
+                            <Trans>Mark all entries as read</Trans>
-                        <Kbd>U</Kbd>
+                        </Table.Td>
-                    </td>
+                        <Table.Td>
-                </tr>
+                            <Kbd>
-                <tr>
+                                <Trans>Shift</Trans>
-                    <td>
+                            </Kbd>
-                        <Trans>Show entry menu (desktop)</Trans>
+                            <span> + </span>
-                    </td>
+                            <Kbd>A</Kbd>
-                    <td>
+                        </Table.Td>
-                        <Kbd>
+                    </Table.Tr>
-                            <Trans>Right click</Trans>
+                    <Table.Tr>
-                        </Kbd>
+                        <Table.Td>
-                    </td>
+                            <Trans>Go to the All view</Trans>
-                </tr>
+                        </Table.Td>
-                <tr>
+                        <Table.Td>
-                    <td>
+                            <Kbd>G</Kbd>
-                        <Trans>Show entry menu (mobile)</Trans>
+                            <span> </span>
-                    </td>
+                            <Kbd>A</Kbd>
-                    <td>
+                        </Table.Td>
-                        <Kbd>
+                    </Table.Tr>
-                            <Trans>Long press</Trans>
+                    <Table.Tr>
-                        </Kbd>
+                        <Table.Td>
-                    </td>
+                            <Trans>Navigate to a subscription by entering its name</Trans>
-                </tr>
+                        </Table.Td>
-                <tr>
+                        <Table.Td>
-                    <td>
+                            <Kbd>{isMacOS ? <Trans>Cmd</Trans> : <Trans>Ctrl</Trans>}</Kbd>
-                        <Trans>Show keyboard shortcut help</Trans>
+                            <span> + </span>
-                    </td>
+                            <Kbd>K</Kbd>
-                    <td>
+                            <span>, </span>
-                        <Kbd>?</Kbd>
+                            <Kbd>G</Kbd>
-                    </td>
+                            <span> </span>
-                </tr>
+                            <Kbd>U</Kbd>
-            </tbody>
+                        </Table.Td>
-        </Table>
+                    </Table.Tr>
-    )
+                    <Table.Tr>
-}
+                        <Table.Td>
+                            <Trans>Show entry menu (desktop)</Trans>
+                        </Table.Td>
+                        <Table.Td>
+                            <Kbd>
+                                <Trans>Right click</Trans>
+                            </Kbd>
+                        </Table.Td>
+                    </Table.Tr>
+                    <Table.Tr>
+                        <Table.Td>
+                            <Trans>Show native menu (desktop)</Trans>
+                        </Table.Td>
+                        <Table.Td>
+                            <Kbd>
+                                <Trans>Shift</Trans>
+                            </Kbd>
+                            <span> + </span>
+                            <Kbd>
+                                <Trans>Right click</Trans>
+                            </Kbd>
+                        </Table.Td>
+                    </Table.Tr>
+                    <Table.Tr>
+                        <Table.Td>
+                            <Trans>Show entry menu (mobile)</Trans>
+                        </Table.Td>
+                        <Table.Td>
+                            <Kbd>
+                                <Trans>Long press</Trans>
+                            </Kbd>
+                        </Table.Td>
+                    </Table.Tr>
+                    <Table.Tr>
+                        <Table.Td>
+                            <Trans>Toggle sidebar</Trans>
+                        </Table.Td>
+                        <Table.Td>
+                            <Kbd>F</Kbd>
+                        </Table.Td>
+                    </Table.Tr>
+                    <Table.Tr>
+                        <Table.Td>
+                            <Trans>Show keyboard shortcut help</Trans>
+                        </Table.Td>
+                        <Table.Td>
+                            <Kbd>?</Kbd>
+                        </Table.Td>
+                    </Table.Tr>
+                </Table.Tbody>
+            </Table>
+            <Box>
+                <span>* </span>
+                <Anchor href={Constants.browserExtensionUrl} target="_blank" rel="noreferrer">
+                    <Trans>Browser extension required for Chrome</Trans>
+                </Anchor>
+            </Box>
+        </Stack>
+    )
+}

commafeed-client/src/components/Loader.tsx

@@ -1,9 +1,9 @@
-import { Center, Loader as MantineLoader } from "@mantine/core"
+import { Center, Loader as MantineLoader } from "@mantine/core"
-
+
-export function Loader() {
+export function Loader() {
-    return (
+    return (
-        <Center>
+        <Center>
-            <MantineLoader size="xl" variant="bars" />
+            <MantineLoader size="lg" type="bars" />
-        </Center>
+        </Center>
-    )
+    )
-}
+}

commafeed-client/src/components/Logo.tsx

@@ -1,10 +1,10 @@
-import { Image } from "@mantine/core"
+import { Image } from "@mantine/core"
-import logo from "assets/logo.svg"
+import logo from "assets/logo.svg"
-
+
-export interface LogoProps {
+export interface LogoProps {
-    size: number
+    size: number
-}
+}
-
+
-export function Logo(props: LogoProps) {
+export function Logo(props: LogoProps) {
-    return <Image src={logo} width={props.size} />
+    return <Image src={logo} w={props.size} />
-}
+}

commafeed-client/src/components/RelativeDate.tsx

@@ -1,14 +1,17 @@
-import { Trans } from "@lingui/macro"
+import { Trans } from "@lingui/react/macro"
-import dayjs from "dayjs"
+import { Tooltip } from "@mantine/core"
-import { useEffect, useState } from "react"
+import { Constants } from "app/constants"
-
+import dayjs from "dayjs"
-export function RelativeDate(props: { date: Date | number | undefined }) {
+import { useNow } from "hooks/useNow"
-    const [now, setNow] = useState(new Date())
+
-    useEffect(() => {
+export function RelativeDate(props: { date: Date | number | undefined }) {
-        const interval = setInterval(() => setNow(new Date()), 60 * 1000)
+    const now = useNow(60 * 1000)
-        return () => clearInterval(interval)
+
-    }, [])
+    if (!props.date) return <Trans>N/A</Trans>
-
+    const date = dayjs(props.date)
-    if (!props.date) return <Trans>N/A</Trans>
+    return (
-    return <>{dayjs(props.date).from(dayjs(now))}</>
+        <Tooltip label={date.toDate().toLocaleString()} openDelay={Constants.tooltip.delay}>
-}
+            <span>{date.from(dayjs(now))}</span>
+        </Tooltip>
+    )
+}

commafeed-client/src/components/admin/UserEdit.tsx

@@ -1,50 +1,54 @@
-import { t, Trans } from "@lingui/macro"
+import { Trans } from "@lingui/react/macro"
-import { Box, Button, Checkbox, Group, PasswordInput, Stack, TextInput } from "@mantine/core"
+import { Box, Button, Checkbox, Group, PasswordInput, Stack, TextInput } from "@mantine/core"
-import { useForm } from "@mantine/form"
+import { useForm } from "@mantine/form"
-import { client, errorToStrings } from "app/client"
+import { client, errorToStrings } from "app/client"
-import { UserModel } from "app/types"
+import type { AdminSaveUserRequest, UserModel } from "app/types"
-import { Alert } from "components/Alert"
+import { Alert } from "components/Alert"
-import { useAsyncCallback } from "react-async-hook"
+import { useAsyncCallback } from "react-async-hook"
-import { TbDeviceFloppy } from "react-icons/tb"
+import { TbDeviceFloppy } from "react-icons/tb"
-
+
-interface UserEditProps {
+interface UserEditProps {
-    user?: UserModel
+    user?: UserModel
-    onCancel: () => void
+    onCancel: () => void
-    onSave: () => void
+    onSave: () => void
-}
+}
-
+
-export function UserEdit(props: UserEditProps) {
+export function UserEdit(props: UserEditProps) {
-    const form = useForm<UserModel>({
+    const form = useForm<AdminSaveUserRequest>({
-        initialValues: props.user ?? ({ enabled: true } as UserModel),
+        initialValues: props.user ?? {
-    })
+            name: "",
-    const saveUser = useAsyncCallback(client.admin.saveUser, { onSuccess: props.onSave })
+            enabled: true,
-
+            admin: false,
-    return (
+        },
-        <>
+    })
-            {saveUser.error && (
+    const saveUser = useAsyncCallback(client.admin.saveUser, { onSuccess: props.onSave })
-                <Box mb="md">
+
-                    <Alert messages={errorToStrings(saveUser.error)} />
+    return (
-                </Box>
+        <>
-            )}
+            {saveUser.error && (
-
+                <Box mb="md">
-            <form onSubmit={form.onSubmit(saveUser.execute)}>
+                    <Alert messages={errorToStrings(saveUser.error)} />
-                <Stack>
+                </Box>
-                    <TextInput label={t`Name`} {...form.getInputProps("name")} required />
+            )}
-                    <PasswordInput label={t`Password`} {...form.getInputProps("password")} required={!props.user} />
+
-                    <TextInput type="email" label={t`E-mail`} {...form.getInputProps("email")} />
+            <form onSubmit={form.onSubmit(saveUser.execute)}>
-                    <Checkbox label={t`Admin`} {...form.getInputProps("admin", { type: "checkbox" })} />
+                <Stack>
-                    <Checkbox label={t`Enabled`} {...form.getInputProps("enabled", { type: "checkbox" })} />
+                    <TextInput label={<Trans>Name</Trans>} {...form.getInputProps("name")} required />
-
+                    <PasswordInput label={<Trans>Password</Trans>} {...form.getInputProps("password")} required={!props.user} />
-                    <Group>
+                    <TextInput type="email" label={<Trans>E-mail</Trans>} {...form.getInputProps("email")} />
-                        <Button variant="default" onClick={props.onCancel}>
+                    <Checkbox label={<Trans>Admin</Trans>} {...form.getInputProps("admin", { type: "checkbox" })} />
-                            <Trans>Cancel</Trans>
+                    <Checkbox label={<Trans>Enabled</Trans>} {...form.getInputProps("enabled", { type: "checkbox" })} />
-                        </Button>
+
-                        <Button type="submit" leftIcon={<TbDeviceFloppy size={16} />} loading={saveUser.loading}>
+                    <Group justify="right">
-                            <Trans>Save</Trans>
+                        <Button variant="default" onClick={props.onCancel}>
-                        </Button>
+                            <Trans>Cancel</Trans>
-                    </Group>
+                        </Button>
-                </Stack>
+                        <Button type="submit" leftSection={<TbDeviceFloppy size={16} />} loading={saveUser.loading}>
-            </form>
+                            <Trans>Save</Trans>
-        </>
+                        </Button>
-    )
+                    </Group>
-}
+                </Stack>
+            </form>
+        </>
+    )
+}

commafeed-client/src/components/code/CodeEditor.tsx

@@ -0,0 +1,36 @@
+import { Input, Textarea } from "@mantine/core"
+import RichCodeEditor from "components/code/RichCodeEditor"
+import { useMobile } from "hooks/useMobile"
+import type { ReactNode } from "react"
+
+interface CodeEditorProps {
+    description?: ReactNode
+    language: "css" | "javascript"
+    value?: string
+    onChange: (value: string | undefined) => void
+}
+
+export function CodeEditor(props: CodeEditorProps) {
+    const mobile = useMobile()
+
+    return mobile ? (
+        // monaco mobile support is poor, fallback to textarea
+        <Textarea
+            autosize
+            minRows={4}
+            maxRows={15}
+            description={props.description}
+            styles={{
+                input: {
+                    fontFamily: "monospace",
+                },
+            }}
+            value={props.value}
+            onChange={e => props.onChange(e.currentTarget.value)}
+        />
+    ) : (
+        <Input.Wrapper description={props.description}>
+            <RichCodeEditor height="30vh" language={props.language} value={props.value} onChange={props.onChange} />
+        </Input.Wrapper>
+    )
+}

commafeed-client/src/components/code/RichCodeEditor.tsx

@@ -0,0 +1,51 @@
+import { Loader } from "components/Loader"
+import { useColorScheme } from "hooks/useColorScheme"
+import { useAsync } from "react-async-hook"
+
+const init = async () => {
+    window.MonacoEnvironment = {
+        async getWorker(_, label) {
+            let worker: typeof import("*?worker")
+            if (label === "css") {
+                worker = await import("monaco-editor/esm/vs/language/css/css.worker?worker")
+            } else if (label === "javascript") {
+                worker = await import("monaco-editor/esm/vs/language/typescript/ts.worker?worker")
+            } else {
+                worker = await import("monaco-editor/esm/vs/editor/editor.worker?worker")
+            }
+            return new worker.default()
+        },
+    }
+
+    const monacoReact = await import("@monaco-editor/react")
+    const monaco = await import("monaco-editor")
+    monacoReact.loader.config({ monaco })
+    return monacoReact.Editor
+}
+
+interface RichCodeEditorProps {
+    height: number | string
+    language: "css" | "javascript"
+    value?: string
+    onChange: (value: string | undefined) => void
+}
+
+function RichCodeEditor(props: RichCodeEditorProps) {
+    const colorScheme = useColorScheme()
+    const editorTheme = colorScheme === "dark" ? "vs-dark" : "light"
+
+    const { result: Editor } = useAsync(init, [])
+    if (!Editor) return <Loader />
+    return (
+        <Editor
+            height={props.height}
+            defaultLanguage={props.language}
+            theme={editorTheme}
+            options={{ minimap: { enabled: false } }}
+            value={props.value}
+            onChange={props.onChange}
+        />
+    )
+}
+
+export default RichCodeEditor

commafeed-client/src/components/content/BasicHtmlStyles.tsx

@@ -0,0 +1,24 @@
+import { TypographyStylesProvider } from "@mantine/core"
+import type { ReactNode } from "react"
+import { tss } from "tss"
+
+/**
+ * This component is used to provide basic styles to html typography elements.
+ *
+ * see https://mantine.dev/core/typography-styles-provider/
+ */
+
+const useStyles = tss.create(() => ({
+    // override mantine default typography styles
+    content: {
+        paddingLeft: 0,
+        "& img": {
+            marginBottom: 0,
+        },
+    },
+}))
+
+export const BasicHtmlStyles = (props: { children: ReactNode }) => {
+    const { classes } = useStyles()
+    return <TypographyStylesProvider className={classes.content}>{props.children}</TypographyStylesProvider>
+}

commafeed-client/src/components/content/Content.test.tsx

@@ -0,0 +1,27 @@
+import { MantineProvider } from "@mantine/core"
+import { render } from "@testing-library/react"
+import { Content } from "components/content/Content"
+import React from "react"
+import { describe, expect, it } from "vitest"
+
+describe("Content component", () => {
+    it("renders basic content", () => {
+        const { container } = render(<Content content="<p>Hello World</p>" />, { wrapper: MantineProvider })
+        expect(container.querySelector("p")).toHaveTextContent("Hello World")
+    })
+
+    it("renders highlighted text when highlight prop is provided", () => {
+        const { container } = render(<Content content="Hello World" highlight="World" />, { wrapper: MantineProvider })
+        expect(container.querySelector("mark")).toHaveTextContent("World")
+    })
+
+    it("renders iframe tag when included in content", () => {
+        const { container } = render(<Content content='<iframe src="https://example.com"></iframe>' />, { wrapper: MantineProvider })
+        expect(container.querySelector("iframe")).toHaveAttribute("src", "https://example.com")
+    })
+
+    it("does not render unsupported tags", () => {
+        const { container } = render(<Content content='<script>alert("test")</script>' />, { wrapper: MantineProvider })
+        expect(container.querySelector("script")).toBeNull()
+    })
+})

commafeed-client/src/components/content/Content.tsx

@@ -1,97 +1,108 @@
-import { Box, createStyles, Mark, TypographyStylesProvider } from "@mantine/core"
+import { Box, Mark } from "@mantine/core"
-import { Constants } from "app/constants"
+import { Constants } from "app/constants"
-import { useAppSelector } from "app/store"
+import { calculatePlaceholderSize } from "app/utils"
-import { calculatePlaceholderSize } from "app/utils"
+import { ImageWithPlaceholderWhileLoading } from "components/ImageWithPlaceholderWhileLoading"
-import { ImageWithPlaceholderWhileLoading } from "components/ImageWithPlaceholderWhileLoading"
+import { BasicHtmlStyles } from "components/content/BasicHtmlStyles"
-import { ChildrenNode, Interweave, Matcher, MatchResponse, Node, TransformCallback } from "interweave"
+import escapeStringRegexp from "escape-string-regexp"
-
+import { ALLOWED_TAG_LIST, type ChildrenNode, Interweave, type MatchResponse, Matcher, type Node, type TransformCallback } from "interweave"
-export interface ContentProps {
+import React from "react"
-    content: string
+import styleToObject from "style-to-object"
-}
+import { tss } from "tss"
-
+
-const useStyles = createStyles(theme => ({
+export interface ContentProps {
-    content: {
+    content: string
-        // break long links or long words
+    highlight?: string
-        overflowWrap: "anywhere",
+}
-        "& a": {
+
-            color: theme.fn.variant({ color: theme.primaryColor, variant: "subtle" }).color,
+const useStyles = tss.create(() => ({
-        },
+    content: {
-        "& iframe": {
+        // break long links or long words
-            maxWidth: "100%",
+        overflowWrap: "anywhere",
-        },
+        "& a": {
-        "& pre, & code": {
+            color: "inherit",
-            whiteSpace: "pre-wrap",
+            textDecoration: "underline",
-        },
+        },
-    },
+        "& iframe": {
-}))
+            maxWidth: "100%",
-
+        },
-const transform: TransformCallback = node => {
+        "& pre, & code": {
-    if (node.tagName === "IMG") {
+            whiteSpace: "pre-wrap",
-        // show placeholders for loading img tags, this allows the entry to have its final height immediately
+        },
-        const src = node.getAttribute("src") ?? undefined
+    },
-        if (!src) return undefined
+}))
-
+
-        const alt = node.getAttribute("alt") ?? "image"
+const transform: TransformCallback = node => {
-        const title = node.getAttribute("title") ?? undefined
+    if (node.tagName === "IMG") {
-        const nodeWidth = node.getAttribute("width")
+        // show placeholders for loading img tags, this allows the entry to have its final height immediately
-        const nodeHeight = node.getAttribute("height")
+        const src = node.getAttribute("src") ?? undefined
-        const width = nodeWidth ? parseInt(nodeWidth, 10) : undefined
+        if (!src) return undefined
-        const height = nodeHeight ? parseInt(nodeHeight, 10) : undefined
+
-        const placeholderSize = calculatePlaceholderSize({
+        const alt = node.getAttribute("alt") ?? "image"
-            width,
+        const title = node.getAttribute("title") ?? undefined
-            height,
+        const nodeWidth = node.getAttribute("width")
-            maxWidth: Constants.layout.entryMaxWidth,
+        const nodeHeight = node.getAttribute("height")
-        })
+        const width = nodeWidth ? Number.parseInt(nodeWidth, 10) : undefined
-
+        const height = nodeHeight ? Number.parseInt(nodeHeight, 10) : undefined
-        return (
+        const style = styleToObject(node.getAttribute("style") ?? "") ?? undefined
-            <ImageWithPlaceholderWhileLoading
+        const placeholderSize = calculatePlaceholderSize({
-                src={src}
+            width,
-                alt={alt}
+            height,
-                title={title}
+            maxWidth: Constants.layout.entryMaxWidth,
-                width={width}
+        })
-                height="auto"
+
-                placeholderWidth={placeholderSize.width}
+        return (
-                placeholderHeight={placeholderSize.height}
+            <ImageWithPlaceholderWhileLoading
-            />
+                src={src}
-        )
+                alt={alt}
-    }
+                title={title}
-    return undefined
+                width={width}
-}
+                height="auto"
-
+                style={style}
-class HighlightMatcher extends Matcher {
+                placeholderWidth={placeholderSize.width}
-    private search: string
+                placeholderHeight={placeholderSize.height}
-
+            />
-    constructor(search: string) {
+        )
-        super("highlight")
+    }
-        this.search = search
+    return undefined
-    }
+}
-
+
-    match(string: string): MatchResponse<unknown> | null {
+class HighlightMatcher extends Matcher {
-        const pattern = this.search.split(" ").join("|")
+    private readonly regexp: RegExp
-        return this.doMatch(string, new RegExp(pattern, "i"), () => ({}))
+
-    }
+    constructor(search: string) {
-
+        super("highlight")
-    // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
+        this.regexp = new RegExp(escapeStringRegexp(search).split(" ").join("|"), "i")
-    replaceWith(children: ChildrenNode, props: unknown): Node {
+    }
-        return <Mark>{children}</Mark>
+
-    }
+    match(string: string): MatchResponse<unknown> | null {
-
+        return this.doMatch(string, this.regexp, () => ({}))
-    // eslint-disable-next-line class-methods-use-this
+    }
-    asTag(): string {
+
-        return "span"
+    replaceWith(children: ChildrenNode): Node {
-    }
+        return <Mark key={0}>{children}</Mark>
-}
+    }
-
+
-export function Content(props: ContentProps) {
+    asTag(): string {
-    const { classes } = useStyles()
+        return "span"
-    const search = useAppSelector(state => state.entries.search)
+    }
-    const matchers = search ? [new HighlightMatcher(search)] : []
+}
-
+
-    return (
+// allow iframe tag
-        <TypographyStylesProvider>
+const allowList = [...ALLOWED_TAG_LIST, "iframe"]
-            <Box className={classes.content}>
+
-                <Interweave content={props.content} transform={transform} matchers={matchers} />
+// memoize component because Interweave is costly
-            </Box>
+const Content = React.memo((props: ContentProps) => {
-        </TypographyStylesProvider>
+    const { classes } = useStyles()
-    )
+    const matchers = props.highlight ? [new HighlightMatcher(props.highlight)] : []
-}
+
+    return (
+        <BasicHtmlStyles>
+            <Box className={classes.content}>
+                <Interweave content={props.content} transform={transform} matchers={matchers} allowList={allowList} />
+            </Box>
+        </BasicHtmlStyles>
+    )
+})
+Content.displayName = "Content"
+
+export { Content }

commafeed-client/src/components/content/Enclosure.tsx

@@ -1,26 +1,29 @@
-import { TypographyStylesProvider } from "@mantine/core"
+import { ImageWithPlaceholderWhileLoading } from "components/ImageWithPlaceholderWhileLoading"
-import { ImageWithPlaceholderWhileLoading } from "components/ImageWithPlaceholderWhileLoading"
+import { BasicHtmlStyles } from "components/content/BasicHtmlStyles"
-
+
-export function Enclosure(props: { enclosureType: string; enclosureUrl: string }) {
+export function Enclosure(props: {
-    const hasVideo = props.enclosureType && props.enclosureType.indexOf("video") === 0
+    enclosureType: string
-    const hasAudio = props.enclosureType && props.enclosureType.indexOf("audio") === 0
+    enclosureUrl: string
-    const hasImage = props.enclosureType && props.enclosureType.indexOf("image") === 0
+}) {
-
+    const hasVideo = props.enclosureType.startsWith("video")
-    return (
+    const hasAudio = props.enclosureType.startsWith("audio")
-        <TypographyStylesProvider>
+    const hasImage = props.enclosureType.startsWith("image")
-            {hasVideo && (
+
-                // eslint-disable-next-line jsx-a11y/media-has-caption
+    return (
-                <video controls>
+        <BasicHtmlStyles>
-                    <source src={props.enclosureUrl} type={props.enclosureType} />
+            {hasVideo && (
-                </video>
+                // biome-ignore lint/a11y/useMediaCaption: we don't have any captions for videos
-            )}
+                <video controls width="100%">
-            {hasAudio && (
+                    <source src={props.enclosureUrl} type={props.enclosureType} />
-                // eslint-disable-next-line jsx-a11y/media-has-caption
+                </video>
-                <audio controls>
+            )}
-                    <source src={props.enclosureUrl} type={props.enclosureType} />
+            {hasAudio && (
-                </audio>
+                // biome-ignore lint/a11y/useMediaCaption: we don't have any captions for audio
-            )}
+                <audio controls style={{ width: "100%" }}>
-            {hasImage && <ImageWithPlaceholderWhileLoading src={props.enclosureUrl} alt="enclosure" />}
+                    <source src={props.enclosureUrl} type={props.enclosureType} />
-        </TypographyStylesProvider>
+                </audio>
-    )
+            )}
-}
+            {hasImage && <ImageWithPlaceholderWhileLoading src={props.enclosureUrl} alt="enclosure" />}
+        </BasicHtmlStyles>
+    )
+}

commafeed-client/src/components/content/FeedEntries.tsx

@@ -1,266 +1,332 @@
-import { t } from "@lingui/macro"
+import { Trans } from "@lingui/react/macro"
-import { openModal } from "@mantine/modals"
+import { Box } from "@mantine/core"
-import { Constants } from "app/constants"
+import { openModal } from "@mantine/modals"
-import {
+import { Constants } from "app/constants"
-    ExpendableEntry,
+import type { ExpendableEntry } from "app/entries/slice"
-    loadMoreEntries,
+import {
-    markAllEntries,
+    loadMoreEntries,
-    markEntry,
+    markAllEntries,
-    reloadEntries,
+    markEntry,
-    selectEntry,
+    reloadEntries,
-    selectNextEntry,
+    selectEntry,
-    selectPreviousEntry,
+    selectNextEntry,
-} from "app/slices/entries"
+    selectPreviousEntry,
-import { redirectToRootCategory } from "app/slices/redirect"
+    starEntry,
-import { useAppDispatch, useAppSelector } from "app/store"
+} from "app/entries/thunks"
-import { openLinkInBackgroundTab } from "app/utils"
+import { redirectToRootCategory } from "app/redirect/thunks"
-import { KeyboardShortcutsHelp } from "components/KeyboardShortcutsHelp"
+import { useAppDispatch, useAppSelector } from "app/store"
-import { Loader } from "components/Loader"
+import { toggleSidebar } from "app/tree/slice"
-import { useMousetrap } from "hooks/useMousetrap"
+import { selectNextUnreadTreeItem } from "app/tree/thunks"
-import throttle from "lodash/throttle"
+import { KeyboardShortcutsHelp } from "components/KeyboardShortcutsHelp"
-import { useEffect } from "react"
+import { Loader } from "components/Loader"
-import InfiniteScroll from "react-infinite-scroller"
+import { useBrowserExtension } from "hooks/useBrowserExtension"
-import { FeedEntry } from "./FeedEntry"
+import { useMousetrap } from "hooks/useMousetrap"
-import { useViewMode } from "../../hooks/useViewMode"
+import { useEffect } from "react"
-
+import { useContextMenu } from "react-contexify"
-export function FeedEntries() {
+import InfiniteScroll from "react-infinite-scroller"
-    const source = useAppSelector(state => state.entries.source)
+import { throttle } from "throttle-debounce"
-    const entries = useAppSelector(state => state.entries.entries)
+import { FeedEntry } from "./FeedEntry"
-    const entriesTimestamp = useAppSelector(state => state.entries.timestamp)
+
-    const selectedEntryId = useAppSelector(state => state.entries.selectedEntryId)
+export function FeedEntries() {
-    const hasMore = useAppSelector(state => state.entries.hasMore)
+    const source = useAppSelector(state => state.entries.source)
-    const { viewMode } = useViewMode()
+    const entries = useAppSelector(state => state.entries.entries)
-    const scrollMarks = useAppSelector(state => state.user.settings?.scrollMarks)
+    const entriesTimestamp = useAppSelector(state => state.entries.timestamp)
-    const scrollingToEntry = useAppSelector(state => state.entries.scrollingToEntry)
+    const selectedEntryId = useAppSelector(state => state.entries.selectedEntryId)
-    const dispatch = useAppDispatch()
+    const hasMore = useAppSelector(state => state.entries.hasMore)
-
+    const loading = useAppSelector(state => state.entries.loading)
-    const selectedEntry = entries.find(e => e.id === selectedEntryId)
+    const scrollMarks = useAppSelector(state => state.user.settings?.scrollMarks)
-
+    const scrollingToEntry = useAppSelector(state => state.entries.scrollingToEntry)
-    const headerClicked = (entry: ExpendableEntry, event: React.MouseEvent) => {
+    const sidebarVisible = useAppSelector(state => state.tree.sidebarVisible)
-        if (event.button === 1 || event.ctrlKey || event.metaKey) {
+    const customContextMenu = useAppSelector(state => state.user.settings?.customContextMenu)
-            // middle click
+    const viewMode = useAppSelector(state => state.user.localSettings.viewMode)
-            dispatch(markEntry({ entry, read: true }))
+    const dispatch = useAppDispatch()
-        } else if (event.button === 0) {
+    const { openLinkInBackgroundTab } = useBrowserExtension()
-            // main click
+
-            // don't trigger the link
+    const selectedEntry = entries.find(e => e.id === selectedEntryId)
-            event.preventDefault()
+
-
+    const headerClicked = (entry: ExpendableEntry, event: React.MouseEvent) => {
-            dispatch(
+        const middleClick = event.button === 1 || event.ctrlKey || event.metaKey
-                selectEntry({
+        if (middleClick || viewMode === "expanded") {
-                    entry,
+            dispatch(markEntry({ entry, read: true }))
-                    expand: !entry.expanded,
+        } else if (event.button === 0) {
-                    markAsRead: !entry.expanded,
+            // main click
-                    scrollToEntry: true,
+            // don't trigger the link
-                })
+            event.preventDefault()
-            )
+
-        }
+            dispatch(
-    }
+                selectEntry({
-
+                    entry,
-    useEffect(() => {
+                    expand: !entry.expanded,
-        const scrollArea = document.getElementById(Constants.dom.mainScrollAreaId)
+                    markAsRead: !entry.expanded,
-
+                    scrollToEntry: true,
-        const listener = () => {
+                })
-            if (viewMode !== "expanded") return
+            )
-            if (scrollingToEntry) return
+        }
-
+    }
-            const currentEntry = entries
+
-                // use slice to get a copy of the array because reverse mutates the array in-place
+    const contextMenu = useContextMenu()
-                .slice()
+    const headerRightClicked = (entry: ExpendableEntry, event: React.MouseEvent) => {
-                .reverse()
+        if (event.shiftKey || !customContextMenu) return
-                .find(e => {
+
-                    const el = document.getElementById(Constants.dom.entryId(e))
+        event.preventDefault()
-                    return el && !Constants.layout.isTopVisible(el)
+        contextMenu.show({
-                })
+            id: Constants.dom.entryContextMenuId(entry),
-            if (currentEntry) {
+            event,
-                dispatch(
+        })
-                    selectEntry({
+    }
-                        entry: currentEntry,
+
-                        expand: false,
+    const bodyClicked = (entry: ExpendableEntry) => {
-                        markAsRead: !!scrollMarks,
+        if (viewMode !== "expanded") return
-                        scrollToEntry: false,
+
-                    })
+        // entry is already selected
-                )
+        if (entry.id === selectedEntryId) return
-            }
+
-        }
+        dispatch(
-        const throttledListener = throttle(listener, 100)
+            selectEntry({
-        scrollArea?.addEventListener("scroll", throttledListener)
+                entry,
-        return () => scrollArea?.removeEventListener("scroll", throttledListener)
+                expand: true,
-    }, [dispatch, entries, viewMode, scrollMarks, scrollingToEntry])
+                markAsRead: true,
-
+                scrollToEntry: true,
-    useMousetrap("r", () => dispatch(reloadEntries()))
+            })
-    useMousetrap("j", () =>
+        )
-        dispatch(
+    }
-            selectNextEntry({
+
-                expand: true,
+    const swipedLeft = async (entry: ExpendableEntry) => await dispatch(markEntry({ entry, read: !entry.read }))
-                markAsRead: true,
+
-                scrollToEntry: true,
+    // close context menu on scroll
-            })
+    useEffect(() => {
-        )
+        const listener = throttle(100, () => contextMenu.hideAll())
-    )
+        window.addEventListener("scroll", listener)
-    useMousetrap("n", () =>
+        return () => window.removeEventListener("scroll", listener)
-        dispatch(
+    }, [contextMenu])
-            selectNextEntry({
+
-                expand: false,
+    useEffect(() => {
-                markAsRead: false,
+        const listener = throttle(100, () => {
-                scrollToEntry: true,
+            if (viewMode !== "expanded") return
-            })
+            if (scrollingToEntry) return
-        )
+
-    )
+            const currentEntry = entries
-    useMousetrap("k", () =>
+                // use slice to get a copy of the array because reverse mutates the array in-place
-        dispatch(
+                .slice()
-            selectPreviousEntry({
+                .reverse()
-                expand: true,
+                .find(e => {
-                markAsRead: true,
+                    const el = document.getElementById(Constants.dom.entryId(e))
-                scrollToEntry: true,
+                    return el && !Constants.layout.isTopVisible(el)
-            })
+                })
-        )
+            if (currentEntry) {
-    )
+                dispatch(
-    useMousetrap("p", () =>
+                    selectEntry({
-        dispatch(
+                        entry: currentEntry,
-            selectPreviousEntry({
+                        expand: false,
-                expand: false,
+                        markAsRead: !!scrollMarks,
-                markAsRead: false,
+                        scrollToEntry: false,
-                scrollToEntry: true,
+                    })
-            })
+                )
-        )
+            }
-    )
+        })
-    useMousetrap("space", () => {
+        window.addEventListener("scroll", listener)
-        if (selectedEntry) {
+        return () => window.removeEventListener("scroll", listener)
-            if (selectedEntry.expanded) {
+    }, [dispatch, entries, viewMode, scrollMarks, scrollingToEntry])
-                const entryElement = document.getElementById(Constants.dom.entryId(selectedEntry))
+
-                if (entryElement && Constants.layout.isBottomVisible(entryElement)) {
+    useMousetrap("r", async () => await dispatch(reloadEntries()))
-                    dispatch(
+    useMousetrap(
-                        selectNextEntry({
+        "j",
-                            expand: true,
+        async () =>
-                            markAsRead: true,
+            await dispatch(
-                            scrollToEntry: true,
+                selectNextEntry({
-                        })
+                    expand: true,
-                    )
+                    markAsRead: true,
-                } else {
+                    scrollToEntry: true,
-                    const scrollArea = document.getElementById(Constants.dom.mainScrollAreaId)
+                })
-                    scrollArea?.scrollTo({
+            )
-                        top: scrollArea.scrollTop + scrollArea.clientHeight * 0.8,
+    )
-                        behavior: "smooth",
+    useMousetrap(
-                    })
+        "n",
-                }
+        async () =>
-            } else {
+            await dispatch(
-                dispatch(
+                selectNextEntry({
-                    selectEntry({
+                    expand: false,
-                        entry: selectedEntry,
+                    markAsRead: false,
-                        expand: true,
+                    scrollToEntry: true,
-                        markAsRead: true,
+                })
-                        scrollToEntry: true,
+            )
-                    })
+    )
-                )
+    useMousetrap(
-            }
+        "k",
-        } else {
+        async () =>
-            dispatch(
+            await dispatch(
-                selectNextEntry({
+                selectPreviousEntry({
-                    expand: true,
+                    expand: true,
-                    markAsRead: true,
+                    markAsRead: true,
-                    scrollToEntry: true,
+                    scrollToEntry: true,
-                })
+                })
-            )
+            )
-        }
+    )
-    })
+    useMousetrap(
-    useMousetrap("shift+space", () => {
+        "p",
-        if (selectedEntry) {
+        async () =>
-            if (selectedEntry.expanded) {
+            await dispatch(
-                const entryElement = document.getElementById(Constants.dom.entryId(selectedEntry))
+                selectPreviousEntry({
-                if (entryElement && Constants.layout.isTopVisible(entryElement)) {
+                    expand: false,
-                    dispatch(
+                    markAsRead: false,
-                        selectPreviousEntry({
+                    scrollToEntry: true,
-                            expand: true,
+                })
-                            markAsRead: true,
+            )
-                            scrollToEntry: true,
+    )
-                        })
+    useMousetrap("shift+j", async () => await dispatch(selectNextUnreadTreeItem({ direction: "forward" })))
-                    )
+    useMousetrap("shift+k", async () => await dispatch(selectNextUnreadTreeItem({ direction: "backward" })))
-                } else {
+    useMousetrap("space", () => {
-                    const scrollArea = document.getElementById(Constants.dom.mainScrollAreaId)
+        if (selectedEntry) {
-                    scrollArea?.scrollTo({
+            if (selectedEntry.expanded) {
-                        top: scrollArea.scrollTop - scrollArea.clientHeight * 0.8,
+                const entryElement = document.getElementById(Constants.dom.entryId(selectedEntry))
-                        behavior: "smooth",
+                if (entryElement && Constants.layout.isBottomVisible(entryElement)) {
-                    })
+                    dispatch(
-                }
+                        selectNextEntry({
-            } else {
+                            expand: true,
-                dispatch(
+                            markAsRead: true,
-                    selectPreviousEntry({
+                            scrollToEntry: true,
-                        expand: true,
+                        })
-                        markAsRead: true,
+                    )
-                        scrollToEntry: true,
+                } else {
-                    })
+                    window.scrollTo({
-                )
+                        top: window.scrollY + document.documentElement.clientHeight * 0.8,
-            }
+                        behavior: "smooth",
-        }
+                    })
-    })
+                }
-    useMousetrap(["o", "enter"], () => {
+            } else {
-        // toggle expanded status
+                dispatch(
-        if (!selectedEntry) return
+                    selectEntry({
-        dispatch(
+                        entry: selectedEntry,
-            selectEntry({
+                        expand: true,
-                entry: selectedEntry,
+                        markAsRead: true,
-                expand: !selectedEntry.expanded,
+                        scrollToEntry: true,
-                markAsRead: !selectedEntry.expanded,
+                    })
-                scrollToEntry: true,
+                )
-            })
+            }
-        )
+        } else {
-    })
+            dispatch(
-    useMousetrap("v", () => {
+                selectNextEntry({
-        // open tab in foreground
+                    expand: true,
-        if (!selectedEntry) return
+                    markAsRead: true,
-        window.open(selectedEntry.url, "_blank", "noreferrer")
+                    scrollToEntry: true,
-    })
+                })
-    useMousetrap("b", () => {
+            )
-        // simulate ctrl+click to open tab in background
+        }
-        if (!selectedEntry) return
+    })
-        openLinkInBackgroundTab(selectedEntry.url)
+    useMousetrap("shift+space", () => {
-    })
+        if (selectedEntry) {
-    useMousetrap("m", () => {
+            if (selectedEntry.expanded) {
-        // toggle read status
+                const entryElement = document.getElementById(Constants.dom.entryId(selectedEntry))
-        if (!selectedEntry) return
+                if (entryElement && Constants.layout.isTopVisible(entryElement)) {
-        dispatch(markEntry({ entry: selectedEntry, read: !selectedEntry.read }))
+                    dispatch(
-    })
+                        selectPreviousEntry({
-    useMousetrap("shift+a", () => {
+                            expand: true,
-        // mark all entries as read
+                            markAsRead: true,
-        dispatch(
+                            scrollToEntry: true,
-            markAllEntries({
+                        })
-                sourceType: source.type,
+                    )
-                req: {
+                } else {
-                    id: source.id,
+                    window.scrollTo({
-                    read: true,
+                        top: window.scrollY - document.documentElement.clientHeight * 0.8,
-                    olderThan: entriesTimestamp,
+                        behavior: "smooth",
-                },
+                    })
-            })
+                }
-        )
+            } else {
-    })
+                dispatch(
-    useMousetrap("g a", () => dispatch(redirectToRootCategory()))
+                    selectPreviousEntry({
-    useMousetrap("?", () => openModal({ title: t`Keyboard shortcuts`, size: "xl", children: <KeyboardShortcutsHelp /> }))
+                        expand: true,
-
+                        markAsRead: true,
-    if (!entries) return <Loader />
+                        scrollToEntry: true,
-    return (
+                    })
-        <InfiniteScroll
+                )
-            initialLoad={false}
+            }
-            loadMore={() => dispatch(loadMoreEntries())}
+        }
-            hasMore={hasMore}
+    })
-            loader={<Loader key={0} />}
+    useMousetrap(["o", "enter"], () => {
-            useWindow={false}
+        // toggle expanded status
-            getScrollParent={() => document.getElementById(Constants.dom.mainScrollAreaId)}
+        if (!selectedEntry) return
-        >
+        dispatch(
-            {entries.map(entry => (
+            selectEntry({
-                <div
+                entry: selectedEntry,
-                    key={entry.id}
+                expand: !selectedEntry.expanded,
-                    ref={el => {
+                markAsRead: !selectedEntry.expanded,
-                        if (el) el.id = Constants.dom.entryId(entry)
+                scrollToEntry: true,
-                    }}
+            })
-                >
+        )
-                    <FeedEntry
+    })
-                        entry={entry}
+    useMousetrap("v", () => {
-                        expanded={!!entry.expanded || viewMode === "expanded"}
+        // open tab in foreground
-                        showSelectionIndicator={entry.id === selectedEntryId && (!entry.expanded || viewMode === "expanded")}
+        if (!selectedEntry) return
-                        onHeaderClick={event => headerClicked(entry, event)}
+        window.open(selectedEntry.url, "_blank", "noreferrer")
-                    />
+    })
-                </div>
+    useMousetrap("b", () => {
-            ))}
+        if (!selectedEntry) return
-        </InfiniteScroll>
+        openLinkInBackgroundTab(selectedEntry.url)
-    )
+    })
-}
+    useMousetrap("m", () => {
+        // toggle read status
+        if (!selectedEntry) return
+        dispatch(markEntry({ entry: selectedEntry, read: !selectedEntry.read }))
+    })
+    useMousetrap("s", () => {
+        // toggle starred status
+        if (!selectedEntry) return
+        dispatch(starEntry({ entry: selectedEntry, starred: !selectedEntry.starred }))
+    })
+    useMousetrap("shift+a", () => {
+        // mark all entries as read
+        dispatch(
+            markAllEntries({
+                sourceType: source.type,
+                req: {
+                    id: source.id,
+                    read: true,
+                    olderThan: Date.now(),
+                    insertedBefore: entriesTimestamp,
+                },
+            })
+        )
+    })
+    useMousetrap("g a", async () => await dispatch(redirectToRootCategory()))
+    useMousetrap("f", () => dispatch(toggleSidebar()))
+    useMousetrap("?", () =>
+        openModal({
+            title: <Trans>Keyboard shortcuts</Trans>,
+            size: "xl",
+            children: <KeyboardShortcutsHelp />,
+        })
+    )
+
+    return (
+        <InfiniteScroll
+            id="entries"
+            className={`view-mode-${viewMode}`}
+            initialLoad={false}
+            loadMore={async () => await (!loading && dispatch(loadMoreEntries()))}
+            hasMore={hasMore}
+            loader={<Box key={0}>{loading && <Loader />}</Box>}
+        >
+            {entries.map(entry => (
+                <article
+                    key={entry.id}
+                    ref={el => {
+                        if (el) el.id = Constants.dom.entryId(entry)
+                    }}
+                    data-id={entry.id}
+                >
+                    <FeedEntry
+                        entry={entry}
+                        expanded={!!entry.expanded || viewMode === "expanded"}
+                        selected={entry.id === selectedEntryId}
+                        showSelectionIndicator={entry.id === selectedEntryId && (!entry.expanded || viewMode === "expanded")}
+                        maxWidth={sidebarVisible ? Constants.layout.entryMaxWidth : undefined}
+                        onHeaderClick={event => headerClicked(entry, event)}
+                        onHeaderRightClick={event => headerRightClicked(entry, event)}
+                        onBodyClick={() => bodyClicked(entry)}
+                        onSwipedLeft={async () => await swipedLeft(entry)}
+                    />
+                </article>
+            ))}
+        </InfiniteScroll>
+    )
+}

commafeed-client/src/components/content/FeedEntry.tsx

@@ -1,121 +1,190 @@
-import { Anchor, Box, createStyles, Divider, Paper } from "@mantine/core"
+import { Box, Divider, type MantineRadius, type MantineSpacing, Paper } from "@mantine/core"
-import { MantineNumberSize } from "@mantine/styles"
+import { Constants } from "app/constants"
-import { Constants } from "app/constants"
+import { useAppSelector } from "app/store"
-import { markEntry } from "app/slices/entries"
+import type { Entry, ViewMode } from "app/types"
-import { useAppDispatch } from "app/store"
+import { FeedEntryCompactHeader } from "components/content/header/FeedEntryCompactHeader"
-import { Entry, ViewMode } from "app/types"
+import { FeedEntryHeader } from "components/content/header/FeedEntryHeader"
-import React from "react"
+import { useMobile } from "hooks/useMobile"
-import { useSwipeable } from "react-swipeable"
+import type React from "react"
-import { useViewMode } from "../../hooks/useViewMode"
+import { useSwipeable } from "react-swipeable"
-import { FeedEntryBody } from "./FeedEntryBody"
+import { tss } from "tss"
-import { FeedEntryCompactHeader } from "./FeedEntryCompactHeader"
+import { FeedEntryBody } from "./FeedEntryBody"
-import { FeedEntryContextMenu, useFeedEntryContextMenu } from "./FeedEntryContextMenu"
+import { FeedEntryContextMenu } from "./FeedEntryContextMenu"
-import { FeedEntryFooter } from "./FeedEntryFooter"
+import { FeedEntryFooter } from "./FeedEntryFooter"
-import { FeedEntryHeader } from "./FeedEntryHeader"
+
-
+interface FeedEntryProps {
-interface FeedEntryProps {
+    entry: Entry
-    entry: Entry
+    expanded: boolean
-    expanded: boolean
+    selected: boolean
-    showSelectionIndicator: boolean
+    showSelectionIndicator: boolean
-    onHeaderClick: (e: React.MouseEvent) => void
+    maxWidth?: number
-}
+    onHeaderClick: (e: React.MouseEvent) => void
-
+    onHeaderRightClick: (e: React.MouseEvent) => void
-const useStyles = createStyles((theme, props: FeedEntryProps & { viewMode?: ViewMode }) => {
+    onBodyClick: (e: React.MouseEvent) => void
-    let backgroundColor
+    onSwipedLeft: () => void
-    if (theme.colorScheme === "dark") backgroundColor = props.entry.read ? "inherit" : theme.colors.dark[5]
+}
-    else backgroundColor = props.entry.read && !props.expanded ? theme.colors.gray[0] : "inherit"
+
-
+const useStyles = tss
-    let marginY = theme.spacing.xs
+    .withParams<{
-    if (props.viewMode === "title") marginY = 2
+        read: boolean
-    else if (props.viewMode === "cozy") marginY = 6
+        expanded: boolean
-
+        viewMode: ViewMode
-    let mobileMarginY = 6
+        rtl: boolean
-    if (props.viewMode === "title") mobileMarginY = 2
+        showSelectionIndicator: boolean
-    else if (props.viewMode === "cozy") mobileMarginY = 4
+        maxWidth?: number
-
+    }>()
-    let backgroundHoverColor = backgroundColor
+    .create(({ theme, colorScheme, read, expanded, viewMode, rtl, showSelectionIndicator, maxWidth }) => {
-    if (!props.expanded && !props.entry.read) {
+        let backgroundColor: string
-        backgroundHoverColor = theme.colorScheme === "dark" ? theme.colors.dark[6] : theme.colors.gray[1]
+        if (colorScheme === "dark") {
-    }
+            backgroundColor = read ? "inherit" : theme.colors.dark[5]
-
+        } else {
-    const styles = {
+            backgroundColor = read && !expanded ? theme.colors.gray[0] : "inherit"
-        paper: {
+        }
-            backgroundColor,
+
-            marginTop: marginY,
+        let marginY = 10
-            marginBottom: marginY,
+        if (viewMode === "title") {
-            [theme.fn.smallerThan(Constants.layout.mobileBreakpoint)]: {
+            marginY = 2
-                marginTop: mobileMarginY,
+        } else if (viewMode === "cozy") {
-                marginBottom: mobileMarginY,
+            marginY = 6
-            },
+        }
-            "@media (hover: hover)": {
+
-                "&:hover": {
+        let mobileMarginY = 6
-                    backgroundColor: backgroundHoverColor,
+        if (viewMode === "title") {
-                },
+            mobileMarginY = 2
-            },
+        } else if (viewMode === "cozy") {
-        },
+            mobileMarginY = 4
-        body: {
+        }
-            maxWidth: Constants.layout.entryMaxWidth,
+
-        },
+        let backgroundHoverColor = backgroundColor
-    }
+        if (!expanded && !read) {
-
+            backgroundHoverColor = colorScheme === "dark" ? theme.colors.dark[6] : theme.colors.gray[1]
-    if (props.showSelectionIndicator) {
+        }
-        styles.paper.borderLeftColor = theme.colorScheme === "dark" ? theme.colors.orange[4] : theme.colors.orange[6]
+
-    }
+        let paperBorderLeftColor = ""
-
+        if (showSelectionIndicator) {
-    return styles
+            const borderLeftColor = colorScheme === "dark" ? theme.colors[theme.primaryColor][4] : theme.colors[theme.primaryColor][6]
-})
+            paperBorderLeftColor = `${borderLeftColor} !important`
-
+        }
-export function FeedEntry(props: FeedEntryProps) {
+
-    const { viewMode } = useViewMode()
+        return {
-    const { classes } = useStyles({ ...props, viewMode })
+            paper: {
-
+                backgroundColor,
-    const dispatch = useAppDispatch()
+                borderLeftColor: paperBorderLeftColor,
-
+                marginTop: marginY,
-    const swipeHandlers = useSwipeable({
+                marginBottom: marginY,
-        onSwipedRight: () => dispatch(markEntry({ entry: props.entry, read: !props.entry.read })),
+                [`@media (max-width: ${Constants.layout.mobileBreakpoint}px)`]: {
-    })
+                    marginTop: mobileMarginY,
-
+                    marginBottom: mobileMarginY,
-    const { onContextMenu } = useFeedEntryContextMenu(props.entry)
+                },
-
+                "@media (hover: hover)": {
-    let paddingX: MantineNumberSize = "xs"
+                    "&:hover": {
-    if (viewMode === "title" || viewMode === "cozy") paddingX = 6
+                        backgroundColor: backgroundHoverColor,
-
+                    },
-    let paddingY: MantineNumberSize = "xs"
+                },
-    if (viewMode === "title") paddingY = 4
+            },
-    else if (viewMode === "cozy") paddingY = 8
+            headerLink: {
-
+                color: "inherit",
-    let borderRadius: MantineNumberSize = "sm"
+                textDecoration: "none",
-    if (viewMode === "title") borderRadius = 0
+            },
-    else if (viewMode === "cozy") borderRadius = "xs"
+            body: {
-
+                direction: rtl ? "rtl" : "ltr",
-    const compactHeader = !props.expanded && (viewMode === "title" || viewMode === "cozy")
+                maxWidth: maxWidth ?? "100%",
-    return (
+            },
-        <Paper withBorder radius={borderRadius} className={classes.paper}>
+        }
-            <Anchor
+    })
-                variant="text"
+
-                href={props.entry.url}
+export function FeedEntry(props: FeedEntryProps) {
-                target="_blank"
+    const viewMode = useAppSelector(state => state.user.localSettings.viewMode)
-                rel="noreferrer"
+    const { classes, cx } = useStyles({
-                onClick={props.onHeaderClick}
+        read: props.entry.read,
-                onAuxClick={props.onHeaderClick}
+        expanded: props.expanded,
-                onContextMenu={onContextMenu}
+        viewMode,
-            >
+        rtl: props.entry.rtl,
-                <Box px={paddingX} py={paddingY} {...swipeHandlers}>
+        showSelectionIndicator: props.showSelectionIndicator,
-                    {compactHeader && <FeedEntryCompactHeader entry={props.entry} />}
+        maxWidth: props.maxWidth,
-                    {!compactHeader && <FeedEntryHeader entry={props.entry} expanded={props.expanded} />}
+    })
-                </Box>
+
-            </Anchor>
+    const externalLinkDisplayMode = useAppSelector(state => state.user.settings?.externalLinkIconDisplayMode)
-            {props.expanded && (
+    const starIconDisplayMode = useAppSelector(state => state.user.settings?.starIconDisplayMode)
-                <Box px={paddingX} pb={paddingY}>
+    const mobile = useMobile()
-                    <Box className={classes.body} sx={{ direction: props.entry.rtl ? "rtl" : "ltr" }}>
+
-                        <FeedEntryBody entry={props.entry} />
+    const showExternalLinkIcon =
-                    </Box>
+        externalLinkDisplayMode && ["always", mobile ? "on_mobile" : "on_desktop"].includes(externalLinkDisplayMode)
-                    <Divider variant="dashed" my={paddingY} />
+    const showStarIcon =
-                    <FeedEntryFooter entry={props.entry} />
+        props.entry.markable && starIconDisplayMode && ["always", mobile ? "on_mobile" : "on_desktop"].includes(starIconDisplayMode)
-                </Box>
+
-            )}
+    const swipeHandlers = useSwipeable({
-
+        onSwipedLeft: props.onSwipedLeft,
-            <FeedEntryContextMenu entry={props.entry} />
+    })
-        </Paper>
+
-    )
+    let paddingX: MantineSpacing = "xs"
-}
+    if (viewMode === "title" || viewMode === "cozy") paddingX = 6
+
+    let paddingY: MantineSpacing = "xs"
+    if (viewMode === "title") {
+        paddingY = 4
+    } else if (viewMode === "cozy") {
+        paddingY = 8
+    }
+
+    let borderRadius: MantineRadius = "sm"
+    if (viewMode === "title") {
+        borderRadius = 0
+    } else if (viewMode === "cozy") {
+        borderRadius = "xs"
+    }
+
+    const compactHeader = !props.expanded && (viewMode === "title" || viewMode === "cozy")
+    return (
+        <Paper
+            withBorder
+            radius={borderRadius}
+            className={cx(classes.paper, {
+                read: props.entry.read,
+                unread: !props.entry.read,
+                expanded: props.expanded,
+                selected: props.selected,
+                "show-selection-indicator": props.showSelectionIndicator,
+            })}
+        >
+            <a
+                className={classes.headerLink}
+                href={props.entry.url}
+                target="_blank"
+                rel="noreferrer"
+                onClick={props.onHeaderClick}
+                onAuxClick={props.onHeaderClick}
+                onContextMenu={props.onHeaderRightClick}
+            >
+                <Box px={paddingX} py={paddingY} {...swipeHandlers}>
+                    {compactHeader && (
+                        <FeedEntryCompactHeader
+                            entry={props.entry}
+                            showStarIcon={showStarIcon}
+                            showExternalLinkIcon={showExternalLinkIcon}
+                        />
+                    )}
+                    {!compactHeader && (
+                        <FeedEntryHeader
+                            entry={props.entry}
+                            expanded={props.expanded}
+                            showStarIcon={showStarIcon}
+                            showExternalLinkIcon={showExternalLinkIcon}
+                        />
+                    )}
+                </Box>
+            </a>
+            {props.expanded && (
+                <Box px={paddingX} pb={paddingY} onClick={props.onBodyClick}>
+                    <Box className={classes.body}>
+                        <FeedEntryBody entry={props.entry} />
+                    </Box>
+                    <Divider variant="dashed" my={paddingY} />
+                    <FeedEntryFooter entry={props.entry} />
+                </Box>
+            )}
+
+            <FeedEntryContextMenu entry={props.entry} />
+        </Paper>
+    )
+}

commafeed-client/src/components/content/FeedEntryBody.tsx

@@ -1,35 +1,37 @@
-import { Box } from "@mantine/core"
+import { Box } from "@mantine/core"
-import { Entry } from "app/types"
+import { useAppSelector } from "app/store"
-import { Content } from "./Content"
+import type { Entry } from "app/types"
-import { Enclosure } from "./Enclosure"
+import { Content } from "./Content"
-import { Media } from "./Media"
+import { Enclosure } from "./Enclosure"
-
+import { Media } from "./Media"
-export interface FeedEntryBodyProps {
+
-    entry: Entry
+export interface FeedEntryBodyProps {
-}
+    entry: Entry
-
+}
-export function FeedEntryBody(props: FeedEntryBodyProps) {
+
-    return (
+export function FeedEntryBody(props: FeedEntryBodyProps) {
-        <Box>
+    const search = useAppSelector(state => state.entries.search)
-            <Box>
+    return (
-                <Content content={props.entry.content} />
+        <Box>
-            </Box>
+            <Box>
-            {props.entry.enclosureType && props.entry.enclosureUrl && (
+                <Content content={props.entry.content} highlight={search} />
-                <Box pt="md">
+            </Box>
-                    <Enclosure enclosureType={props.entry.enclosureType} enclosureUrl={props.entry.enclosureUrl} />
+            {props.entry.enclosureType && props.entry.enclosureUrl && (
-                </Box>
+                <Box pt="md">
-            )}
+                    <Enclosure enclosureType={props.entry.enclosureType} enclosureUrl={props.entry.enclosureUrl} />
-            {/* show media only if we don't have content to avoid duplicate content */}
+                </Box>
-            {!props.entry.content && props.entry.mediaThumbnailUrl && (
+            )}
-                <Box pt="md">
+            {/* show media only if we don't have content to avoid duplicate content */}
-                    <Media
+            {!props.entry.content && props.entry.mediaThumbnailUrl && (
-                        thumbnailUrl={props.entry.mediaThumbnailUrl}
+                <Box pt="md">
-                        thumbnailWidth={props.entry.mediaThumbnailWidth}
+                    <Media
-                        thumbnailHeight={props.entry.mediaThumbnailHeight}
+                        thumbnailUrl={props.entry.mediaThumbnailUrl}
-                        description={props.entry.mediaDescription}
+                        thumbnailWidth={props.entry.mediaThumbnailWidth}
-                    />
+                        thumbnailHeight={props.entry.mediaThumbnailHeight}
-                </Box>
+                        description={props.entry.mediaDescription}
-            )}
+                    />
-        </Box>
+                </Box>
-    )
+            )}
-}
+        </Box>
+    )
+}

commafeed-client/src/components/content/FeedEntryCompactHeader.tsx

@@ -1,58 +0,0 @@
-import { Box, createStyles, Text } from "@mantine/core"
-import { Entry } from "app/types"
-import { RelativeDate } from "components/RelativeDate"
-import { OnDesktop } from "components/responsive/OnDesktop"
-import { FeedEntryTitle } from "./FeedEntryTitle"
-import { FeedFavicon } from "./FeedFavicon"
-
-export interface FeedEntryHeaderProps {
-    entry: Entry
-}
-
-const useStyles = createStyles((theme, props: FeedEntryHeaderProps) => ({
-    wrapper: {
-        display: "flex",
-        alignItems: "center",
-        columnGap: "10px",
-    },
-    title: {
-        flexGrow: 1,
-        fontWeight: theme.colorScheme === "light" && !props.entry.read ? "bold" : "inherit",
-        whiteSpace: "nowrap",
-        overflow: "hidden",
-        textOverflow: "ellipsis",
-    },
-    feedName: {
-        width: "145px",
-        minWidth: "145px",
-        whiteSpace: "nowrap",
-        overflow: "hidden",
-        textOverflow: "ellipsis",
-    },
-    date: {
-        whiteSpace: "nowrap",
-    },
-}))
-export function FeedEntryCompactHeader(props: FeedEntryHeaderProps) {
-    const { classes } = useStyles(props)
-    return (
-        <Box className={classes.wrapper}>
-            <Box>
-                <FeedFavicon url={props.entry.iconUrl} />
-            </Box>
-            <OnDesktop>
-                <Text color="dimmed" className={classes.feedName}>
-                    {props.entry.feedName}
-                </Text>
-            </OnDesktop>
-            <Box className={classes.title}>
-                <FeedEntryTitle entry={props.entry} />
-            </Box>
-            <OnDesktop>
-                <Text color="dimmed" className={classes.date}>
-                    <RelativeDate date={props.entry.date} />
-                </Text>
-            </OnDesktop>
-        </Box>
-    )
-}

commafeed-client/src/components/content/FeedEntryContextMenu.tsx

@@ -1,127 +1,103 @@
-import { t, Trans } from "@lingui/macro"
+import { Trans } from "@lingui/react/macro"
-import { createStyles, Group } from "@mantine/core"
+import { Group } from "@mantine/core"
-import { Constants } from "app/constants"
+import { Constants } from "app/constants"
-import { markEntriesUpToEntry, markEntry, starEntry } from "app/slices/entries"
+import { markEntriesUpToEntry, markEntry, starEntry } from "app/entries/thunks"
-import { redirectToFeed } from "app/slices/redirect"
+import { redirectToFeed } from "app/redirect/thunks"
-import { useAppDispatch, useAppSelector } from "app/store"
+import { useAppDispatch, useAppSelector } from "app/store"
-import { Entry } from "app/types"
+import type { Entry } from "app/types"
-import { openLinkInBackgroundTab } from "app/utils"
+import { truncate } from "app/utils"
-import { throttle, truncate } from "lodash"
+import { useBrowserExtension } from "hooks/useBrowserExtension"
-import { useEffect } from "react"
+import { useColorScheme } from "hooks/useColorScheme"
-import { Item, Menu, Separator, useContextMenu } from "react-contexify"
+import { Item, Menu, Separator } from "react-contexify"
-import { TbArrowBarToDown, TbExternalLink, TbEyeCheck, TbEyeOff, TbRss, TbStar, TbStarOff } from "react-icons/tb"
+import { TbArrowBarToDown, TbExternalLink, TbMail, TbMailOpened, TbRss, TbStar, TbStarOff } from "react-icons/tb"
-
+import { tss } from "tss"
-interface FeedEntryContextMenuProps {
+
-    entry: Entry
+interface FeedEntryContextMenuProps {
-}
+    entry: Entry
-
+}
-const iconSize = 16
+
-const useStyles = createStyles(theme => ({
+const iconSize = 16
-    menu: {
+const useStyles = tss.create(({ theme, colorScheme }) => ({
-        // apply mantine theme from MenuItem.styles.ts
+    menu: {
-        fontSize: theme.fontSizes.sm,
+        // apply mantine theme from MenuItem.styles.ts
-        "--contexify-item-color": `${theme.colorScheme === "dark" ? theme.colors.dark[0] : theme.black} !important`,
+        fontSize: theme.fontSizes.sm,
-        "--contexify-activeItem-color": `${theme.colorScheme === "dark" ? theme.colors.dark[0] : theme.black} !important`,
+        "--contexify-item-color": `${colorScheme === "dark" ? theme.colors.dark[0] : theme.black} !important`,
-        "--contexify-activeItem-bgColor": `${
+        "--contexify-activeItem-color": `${colorScheme === "dark" ? theme.colors.dark[0] : theme.black} !important`,
-            theme.colorScheme === "dark" ? theme.fn.rgba(theme.colors.dark[3], 0.35) : theme.colors.gray[1]
+        "--contexify-activeItem-bgColor": `${colorScheme === "dark" ? theme.colors.dark[4] : theme.colors.gray[1]} !important`,
-        } !important`,
+    },
-    },
+}))
-}))
+
-
+export function FeedEntryContextMenu(props: FeedEntryContextMenuProps) {
-const menuId = (entry: Entry) => entry.id
+    const colorScheme = useColorScheme()
-export function FeedEntryContextMenu(props: FeedEntryContextMenuProps) {
+    const { classes } = useStyles()
-    const { classes, theme } = useStyles()
+    const sourceType = useAppSelector(state => state.entries.source.type)
-    const sourceType = useAppSelector(state => state.entries.source.type)
+    const dispatch = useAppDispatch()
-    const dispatch = useAppDispatch()
+    const { openLinkInBackgroundTab } = useBrowserExtension()
-
+
-    return (
+    return (
-        <Menu id={menuId(props.entry)} theme={theme.colorScheme} animation={false} className={classes.menu}>
+        <Menu id={Constants.dom.entryContextMenuId(props.entry)} theme={colorScheme} animation={false} className={classes.menu}>
-            <Item
+            <Item
-                onClick={() => {
+                onClick={() => {
-                    window.open(props.entry.url, "_blank", "noreferrer")
+                    window.open(props.entry.url, "_blank", "noreferrer")
-                    dispatch(markEntry({ entry: props.entry, read: true }))
+                    dispatch(markEntry({ entry: props.entry, read: true }))
-                }}
+                }}
-            >
+            >
-                <Group>
+                <Group>
-                    <TbExternalLink size={iconSize} />
+                    <TbExternalLink size={iconSize} />
-                    <Trans>Open link in new tab</Trans>
+                    <Trans>Open link in new tab</Trans>
-                </Group>
+                </Group>
-            </Item>
+            </Item>
-            <Item
+            <Item
-                onClick={() => {
+                onClick={() => {
-                    openLinkInBackgroundTab(props.entry.url)
+                    openLinkInBackgroundTab(props.entry.url)
-                    dispatch(markEntry({ entry: props.entry, read: true }))
+                    dispatch(markEntry({ entry: props.entry, read: true }))
-                }}
+                }}
-            >
+            >
-                <Group>
+                <Group>
-                    <TbExternalLink size={iconSize} />
+                    <TbExternalLink size={iconSize} />
-                    <Trans>Open link in new background tab</Trans>
+                    <Trans>Open link in new background tab</Trans>
-                </Group>
+                </Group>
-            </Item>
+            </Item>
-
+
-            <Separator />
+            <Separator />
-
+
-            <Item onClick={() => dispatch(starEntry({ entry: props.entry, starred: !props.entry.starred }))}>
+            <Item onClick={async () => await dispatch(starEntry({ entry: props.entry, starred: !props.entry.starred }))}>
-                <Group>
+                <Group>
-                    {props.entry.starred ? <TbStarOff size={iconSize} /> : <TbStar size={iconSize} />}
+                    {props.entry.starred ? <TbStarOff size={iconSize} /> : <TbStar size={iconSize} />}
-                    {props.entry.starred ? t`Unstar` : t`Star`}
+                    {props.entry.starred ? <Trans>Unstar</Trans> : <Trans>Star</Trans>}
-                </Group>
+                </Group>
-            </Item>
+            </Item>
-            <Item onClick={() => dispatch(markEntry({ entry: props.entry, read: !props.entry.read }))}>
+            {props.entry.markable && (
-                <Group>
+                <Item onClick={async () => await dispatch(markEntry({ entry: props.entry, read: !props.entry.read }))}>
-                    {props.entry.read ? <TbEyeOff size={iconSize} /> : <TbEyeCheck size={iconSize} />}
+                    <Group>
-                    {props.entry.read ? t`Keep unread` : t`Mark as read`}
+                        {props.entry.read ? <TbMail size={iconSize} /> : <TbMailOpened size={iconSize} />}
-                </Group>
+                        {props.entry.read ? <Trans>Keep unread</Trans> : <Trans>Mark as read</Trans>}
-            </Item>
+                    </Group>
-            <Item onClick={() => dispatch(markEntriesUpToEntry(props.entry))}>
+                </Item>
-                <Group>
+            )}
-                    <TbArrowBarToDown size={iconSize} />
+            <Item onClick={async () => await dispatch(markEntriesUpToEntry(props.entry))}>
-                    <Trans>Mark as read up to here</Trans>
+                <Group>
-                </Group>
+                    <TbArrowBarToDown size={iconSize} />
-            </Item>
+                    <Trans>Mark as read up to here</Trans>
-
+                </Group>
-            {sourceType === "category" && (
+            </Item>
-                <>
+
-                    <Separator />
+            {sourceType === "category" && (
-
+                <>
-                    <Item
+                    <Separator />
-                        onClick={() => {
+
-                            dispatch(redirectToFeed(props.entry.feedId))
+                    <Item
-                        }}
+                        onClick={() => {
-                    >
+                            dispatch(redirectToFeed(props.entry.feedId))
-                        <Group>
+                        }}
-                            <TbRss size={iconSize} />
+                    >
-                            <Trans>Go to {truncate(props.entry.feedName)}</Trans>
+                        <Group>
-                        </Group>
+                            <TbRss size={iconSize} />
-                    </Item>
+                            <Trans>Go to {truncate(props.entry.feedName, 30)}</Trans>
-                </>
+                        </Group>
-            )}
+                    </Item>
-        </Menu>
+                </>
-    )
+            )}
-}
+        </Menu>
-
+    )
-export function useFeedEntryContextMenu(entry: Entry) {
+}
-    const contextMenu = useContextMenu({
-        id: menuId(entry),
-    })
-
-    const onContextMenu = (event: React.MouseEvent) => {
-        event.preventDefault()
-        contextMenu.show({
-            event,
-        })
-    }
-
-    // close context menu on scroll
-    useEffect(() => {
-        const scrollArea = document.getElementById(Constants.dom.mainScrollAreaId)
-
-        const listener = () => contextMenu.hideAll()
-        const throttledListener = throttle(listener, 100)
-
-        scrollArea?.addEventListener("scroll", throttledListener)
-        return () => scrollArea?.removeEventListener("scroll", throttledListener)
-    }, [contextMenu])
-
-    return { onContextMenu }
-}

commafeed-client/src/components/content/FeedEntryFooter.tsx

@@ -1,108 +1,104 @@
-import { t } from "@lingui/macro"
+import { msg } from "@lingui/core/macro"
-import { Group, Indicator, MultiSelect, Popover } from "@mantine/core"
+import { useLingui } from "@lingui/react"
-import { useMediaQuery } from "@mantine/hooks"
+import { Group, Indicator, Popover, TagsInput } from "@mantine/core"
-import { Constants } from "app/constants"
+import { markEntriesUpToEntry, markEntry, starEntry, tagEntry } from "app/entries/thunks"
-import { markEntriesUpToEntry, markEntry, starEntry, tagEntry } from "app/slices/entries"
+import { useAppDispatch, useAppSelector } from "app/store"
-import { useAppDispatch, useAppSelector } from "app/store"
+import type { Entry } from "app/types"
-import { Entry } from "app/types"
+import { ActionButton } from "components/ActionButton"
-import { ActionButton } from "components/ActionButtton"
+import { useActionButton } from "hooks/useActionButton"
-import { ButtonToolbar } from "components/ButtonToolbar"
+import { useMobile } from "hooks/useMobile"
-import { throttle } from "lodash"
+import { TbArrowBarToDown, TbExternalLink, TbMail, TbMailOpened, TbShare, TbStar, TbStarOff, TbTag } from "react-icons/tb"
-import { useEffect, useState } from "react"
+import { ShareButtons } from "./ShareButtons"
-import { TbArrowBarToDown, TbExternalLink, TbEyeCheck, TbEyeOff, TbShare, TbStar, TbStarOff, TbTag } from "react-icons/tb"
+
-import { ShareButtons } from "./ShareButtons"
+interface FeedEntryFooterProps {
-
+    entry: Entry
-interface FeedEntryFooterProps {
+}
-    entry: Entry
+
-}
+export function FeedEntryFooter(props: FeedEntryFooterProps) {
-
+    const tags = useAppSelector(state => state.user.tags)
-export function FeedEntryFooter(props: FeedEntryFooterProps) {
+    const mobile = useMobile()
-    const [scrollPosition, setScrollPosition] = useState(0)
+    const { spacing } = useActionButton()
-    const sharingSettings = useAppSelector(state => state.user.settings?.sharingSettings)
+    const dispatch = useAppDispatch()
-    const tags = useAppSelector(state => state.user.tags)
+    const { _ } = useLingui()
-    const mobile = !useMediaQuery(`(min-width: ${Constants.layout.mobileBreakpoint}px)`)
+
-    const dispatch = useAppDispatch()
+    const readStatusButtonClicked = async () =>
-
+        await dispatch(
-    const showSharingButtons = sharingSettings && Object.values(sharingSettings).some(v => v)
+            markEntry({
-
+                entry: props.entry,
-    const readStatusButtonClicked = () => dispatch(markEntry({ entry: props.entry, read: !props.entry.read }))
+                read: !props.entry.read,
-    const onTagsChange = (values: string[]) =>
+            })
-        dispatch(
+        )
-            tagEntry({
+    const onTagsChange = async (values: string[]) =>
-                entryId: +props.entry.id,
+        await dispatch(
-                tags: values,
+            tagEntry({
-            })
+                entryId: +props.entry.id,
-        )
+                tags: values,
-
+            })
-    useEffect(() => {
+        )
-        const scrollArea = document.getElementById(Constants.dom.mainScrollAreaId)
+
-
+    return (
-        const listener = () => setScrollPosition(scrollArea ? scrollArea.scrollTop : 0)
+        <Group justify="space-between">
-        const throttledListener = throttle(listener, 100)
+            <Group gap={spacing}>
-
+                {props.entry.markable && (
-        scrollArea?.addEventListener("scroll", throttledListener)
+                    <ActionButton
-        return () => scrollArea?.removeEventListener("scroll", throttledListener)
+                        icon={props.entry.read ? <TbMail size={18} /> : <TbMailOpened size={18} />}
-    }, [])
+                        label={props.entry.read ? msg`Keep unread` : msg`Mark as read`}
-
+                        onClick={readStatusButtonClicked}
-    return (
+                    />
-        <Group position="apart">
+                )}
-            <ButtonToolbar>
+                <ActionButton
-                {props.entry.markable && (
+                    icon={props.entry.starred ? <TbStarOff size={18} /> : <TbStar size={18} />}
-                    <ActionButton
+                    label={props.entry.starred ? msg`Unstar` : msg`Star`}
-                        icon={props.entry.read ? <TbEyeOff size={18} /> : <TbEyeCheck size={18} />}
+                    onClick={async () =>
-                        label={props.entry.read ? t`Keep unread` : t`Mark as read`}
+                        await dispatch(
-                        onClick={readStatusButtonClicked}
+                            starEntry({
-                    />
+                                entry: props.entry,
-                )}
+                                starred: !props.entry.starred,
-                <ActionButton
+                            })
-                    icon={props.entry.starred ? <TbStarOff size={18} /> : <TbStar size={18} />}
+                        )
-                    label={props.entry.starred ? t`Unstar` : t`Star`}
+                    }
-                    onClick={() => dispatch(starEntry({ entry: props.entry, starred: !props.entry.starred }))}
+                />
-                />
+
-
+                <Popover withArrow withinPortal shadow="md" closeOnClickOutside={!mobile}>
-                {showSharingButtons && (
+                    <Popover.Target>
-                    <Popover withArrow withinPortal shadow="md" positionDependencies={[scrollPosition]} closeOnClickOutside={!mobile}>
+                        <ActionButton icon={<TbShare size={18} />} label={msg`Share`} />
-                        <Popover.Target>
+                    </Popover.Target>
-                            <ActionButton icon={<TbShare size={18} />} label={t`Share`} />
+                    <Popover.Dropdown>
-                        </Popover.Target>
+                        <ShareButtons url={props.entry.url} description={props.entry.title} />
-                        <Popover.Dropdown>
+                    </Popover.Dropdown>
-                            <ShareButtons url={props.entry.url} description={props.entry.title} />
+                </Popover>
-                        </Popover.Dropdown>
+
-                    </Popover>
+                {tags && (
-                )}
+                    <Popover withArrow shadow="md" closeOnClickOutside={!mobile}>
-
+                        <Popover.Target>
-                {tags && (
+                            <Indicator label={props.entry.tags.length} disabled={props.entry.tags.length === 0} inline size={16}>
-                    <Popover withArrow withinPortal shadow="md" positionDependencies={[scrollPosition]} closeOnClickOutside={!mobile}>
+                                <ActionButton icon={<TbTag size={18} />} label={msg`Tags`} />
-                        <Popover.Target>
+                            </Indicator>
-                            <Indicator label={props.entry.tags.length} showZero={false} dot={false} inline size={16}>
+                        </Popover.Target>
-                                <ActionButton icon={<TbTag size={18} />} label={t`Tags`} />
+                        <Popover.Dropdown>
-                            </Indicator>
+                            <TagsInput
-                        </Popover.Target>
+                                placeholder={_(msg`Tags`)}
-                        <Popover.Dropdown>
+                                data={tags}
-                            <MultiSelect
+                                value={props.entry.tags}
-                                data={tags}
+                                onChange={onTagsChange}
-                                placeholder="Tags"
+                                comboboxProps={{
-                                searchable
+                                    withinPortal: false,
-                                creatable
+                                }}
-                                autoFocus
+                            />
-                                getCreateLabel={query => t`Create tag: ${query}`}
+                        </Popover.Dropdown>
-                                value={props.entry.tags}
+                    </Popover>
-                                onChange={onTagsChange}
+                )}
-                            />
+
-                        </Popover.Dropdown>
+                <a href={props.entry.url} target="_blank" rel="noreferrer">
-                    </Popover>
+                    <ActionButton icon={<TbExternalLink size={18} />} label={msg`Open link`} />
-                )}
+                </a>
-
+            </Group>
-                <a href={props.entry.url} target="_blank" rel="noreferrer">
+
-                    <ActionButton icon={<TbExternalLink size={18} />} label={t`Open link`} />
+            <ActionButton
-                </a>
+                icon={<TbArrowBarToDown size={18} />}
-            </ButtonToolbar>
+                label={msg`Mark as read up to here`}
-
+                onClick={async () => await dispatch(markEntriesUpToEntry(props.entry))}
-            <ActionButton
+            />
-                icon={<TbArrowBarToDown size={18} />}
+        </Group>
-                label={t`Mark as read up to here`}
+    )
-                onClick={() => dispatch(markEntriesUpToEntry(props.entry))}
+}
-            />
-        </Group>
-    )
-}

commafeed-client/src/components/content/FeedEntryHeader.tsx

@@ -1,60 +0,0 @@
-import { Box, createStyles, Text } from "@mantine/core"
-import { Entry } from "app/types"
-import { RelativeDate } from "components/RelativeDate"
-import { FeedEntryTitle } from "./FeedEntryTitle"
-import { FeedFavicon } from "./FeedFavicon"
-
-export interface FeedEntryHeaderProps {
-    entry: Entry
-    expanded: boolean
-}
-
-const useStyles = createStyles((theme, props: FeedEntryHeaderProps) => ({
-    headerText: {
-        fontWeight: theme.colorScheme === "light" && !props.entry.read ? "bold" : "inherit",
-        whiteSpace: props.expanded ? "inherit" : "nowrap",
-        overflow: "hidden",
-        textOverflow: "ellipsis",
-    },
-    headerSubtext: {
-        display: "flex",
-        alignItems: "center",
-        fontSize: "90%",
-        whiteSpace: props.expanded ? "inherit" : "nowrap",
-        overflow: "hidden",
-        textOverflow: "ellipsis",
-    },
-}))
-export function FeedEntryHeader(props: FeedEntryHeaderProps) {
-    const { classes } = useStyles(props)
-    return (
-        <Box>
-            <Box className={classes.headerText}>
-                <FeedEntryTitle entry={props.entry} />
-            </Box>
-            <Box className={classes.headerSubtext}>
-                <Box mr={6}>
-                    <FeedFavicon url={props.entry.iconUrl} />
-                </Box>
-                <Box>
-                    <Text color="dimmed">{props.entry.feedName}</Text>
-                </Box>
-                <Box>
-                    <Text color="dimmed">
-                        <span>&nbsp;·&nbsp;</span>
-                        <RelativeDate date={props.entry.date} />
-                    </Text>
-                </Box>
-            </Box>
-            {props.expanded && (
-                <Box className={classes.headerSubtext}>
-                    <Text color="dimmed">
-                        {props.entry.author && <span>by {props.entry.author}</span>}
-                        {props.entry.author && props.entry.categories && <span>&nbsp;·&nbsp;</span>}
-                        {props.entry.categories && <span>{props.entry.categories}</span>}
-                    </Text>
-                </Box>
-            )}
-        </Box>
-    )
-}

commafeed-client/src/components/content/FeedFavicon.tsx

@@ -1,22 +1,21 @@
-import { ImageWithPlaceholderWhileLoading } from "components/ImageWithPlaceholderWhileLoading"
+import { ImageWithPlaceholderWhileLoading } from "components/ImageWithPlaceholderWhileLoading"
-
+
-export interface FeedFaviconProps {
+export interface FeedFaviconProps {
-    url: string
+    url: string
-    size?: number
+    size?: number
-}
+}
-
+
-export function FeedFavicon({ url, size = 18 }: FeedFaviconProps) {
+export function FeedFavicon({ url, size = 18 }: FeedFaviconProps) {
-    return (
+    return (
-        <ImageWithPlaceholderWhileLoading
+        <ImageWithPlaceholderWhileLoading
-            src={url}
+            src={url}
-            alt="feed favicon"
+            alt="feed favicon"
-            width={size}
+            width={size}
-            height={size}
+            height={size}
-            placeholderWidth={size}
+            placeholderWidth={size}
-            placeholderHeight={size}
+            placeholderHeight={size}
-            placeholderBackgroundColor="inherit"
+            placeholderBackgroundColor="inherit"
-            placeholderIconSize={size}
+            placeholderIconSize={size}
-            placeholderIconColor="inherit"
+        />
-        />
+    )
-    )
+}
-}

commafeed-client/src/components/content/Media.tsx

@@ -1,39 +1,40 @@
-import { Box, TypographyStylesProvider } from "@mantine/core"
+import { Box } from "@mantine/core"
-import { Constants } from "app/constants"
+import { Constants } from "app/constants"
-import { calculatePlaceholderSize } from "app/utils"
+import { calculatePlaceholderSize } from "app/utils"
-import { ImageWithPlaceholderWhileLoading } from "components/ImageWithPlaceholderWhileLoading"
+import { ImageWithPlaceholderWhileLoading } from "components/ImageWithPlaceholderWhileLoading"
-import { Content } from "./Content"
+import { BasicHtmlStyles } from "components/content/BasicHtmlStyles"
-
+import { Content } from "./Content"
-export interface MediaProps {
+
-    thumbnailUrl: string
+export interface MediaProps {
-    thumbnailWidth?: number
+    thumbnailUrl: string
-    thumbnailHeight?: number
+    thumbnailWidth?: number
-    description?: string
+    thumbnailHeight?: number
-}
+    description?: string
-
+}
-export function Media(props: MediaProps) {
+
-    const width = props.thumbnailWidth
+export function Media(props: MediaProps) {
-    const height = props.thumbnailHeight
+    const width = props.thumbnailWidth
-    const placeholderSize = calculatePlaceholderSize({
+    const height = props.thumbnailHeight
-        width,
+    const placeholderSize = calculatePlaceholderSize({
-        height,
+        width,
-        maxWidth: Constants.layout.entryMaxWidth,
+        height,
-    })
+        maxWidth: Constants.layout.entryMaxWidth,
-    return (
+    })
-        <TypographyStylesProvider>
+    return (
-            <ImageWithPlaceholderWhileLoading
+        <BasicHtmlStyles>
-                src={props.thumbnailUrl}
+            <ImageWithPlaceholderWhileLoading
-                alt="media thumbnail"
+                src={props.thumbnailUrl}
-                width={props.thumbnailWidth}
+                alt="media thumbnail"
-                height={props.thumbnailHeight}
+                width={props.thumbnailWidth}
-                placeholderWidth={placeholderSize.width}
+                height={props.thumbnailHeight}
-                placeholderHeight={placeholderSize.height}
+                placeholderWidth={placeholderSize.width}
-            />
+                placeholderHeight={placeholderSize.height}
-            {props.description && (
+            />
-                <Box pt="md">
+            {props.description && (
-                    <Content content={props.description} />
+                <Box pt="md">
-                </Box>
+                    <Content content={props.description} />
-            )}
+                </Box>
-        </TypographyStylesProvider>
+            )}
-    )
+        </BasicHtmlStyles>
-}
+    )
+}

commafeed-client/src/components/content/ShareButtons.tsx

@@ -1,55 +1,113 @@
-import { ActionIcon, Box, createStyles, SimpleGrid } from "@mantine/core"
+import { Trans } from "@lingui/react/macro"
-import { Constants } from "app/constants"
+import { ActionIcon, Box, CopyButton, Divider, SimpleGrid } from "@mantine/core"
-import { useAppSelector } from "app/store"
+import { Constants } from "app/constants"
-import { SharingSettings } from "app/types"
+import { useAppSelector } from "app/store"
-import { IconType } from "react-icons"
+import type { SharingSettings } from "app/types"
-
+import { useBrowserExtension } from "hooks/useBrowserExtension"
-type Color = `#${string}`
+import { useMobile } from "hooks/useMobile"
-
+import type { IconType } from "react-icons"
-const useStyles = createStyles((theme, props: { color: Color }) => ({
+import { TbCheck, TbCopy, TbDeviceDesktopShare, TbDeviceMobileShare } from "react-icons/tb"
-    socialIcon: {
+import { tss } from "tss"
-        color: props.color,
+
-        backgroundColor: theme.colorScheme === "dark" ? theme.colors.gray[2] : "white",
+type Color = `#${string}`
-        borderRadius: "50%",
+
-    },
+const useStyles = tss
-}))
+    .withParams<{
-
+        color: Color
-function ShareButton({ url, icon, color }: { url: string; icon: IconType; color: Color }) {
+    }>()
-    const { classes } = useStyles({ color })
+    .create(({ theme, colorScheme, color }) => ({
-
+        icon: {
-    const onClick = (e: React.MouseEvent) => {
+            color,
-        e.preventDefault()
+            backgroundColor: colorScheme === "dark" ? theme.colors.gray[2] : "white",
-        window.open(url, "", "menubar=no,toolbar=no,resizable=yes,scrollbars=yes,width=800,height=600")
+        },
-    }
+    }))
-
+
-    return (
+function ShareButton({ icon, color, onClick }: { icon: IconType; color: Color; onClick: () => void }) {
-        <ActionIcon>
+    const { classes } = useStyles({
-            <a href={url} target="_blank" rel="noreferrer" onClick={onClick}>
+        color,
-                <Box p={6} className={classes.socialIcon}>
+    })
-                    {icon({ size: 18 })}
+
-                </Box>
+    return (
-            </a>
+        <ActionIcon variant="transparent" radius="xl" size={32}>
-        </ActionIcon>
+            <Box p={6} className={classes.icon} onClick={onClick}>
-    )
+                {icon({ size: 18 })}
-}
+            </Box>
-
+        </ActionIcon>
-export function ShareButtons(props: { url: string; description: string }) {
+    )
-    const sharingSettings = useAppSelector(state => state.user.settings?.sharingSettings)
+}
-    const url = encodeURIComponent(props.url)
+
-    const desc = encodeURIComponent(props.description)
+function SiteShareButton({ url, icon, color }: { icon: IconType; color: Color; url: string }) {
-
+    const onClick = () => {
-    return (
+        window.open(url, "", "menubar=no,toolbar=no,resizable=yes,scrollbars=yes,width=800,height=600")
-        <SimpleGrid cols={4}>
+    }
-            {(Object.keys(Constants.sharing) as Array<keyof SharingSettings>)
+
-                .filter(site => sharingSettings && sharingSettings[site])
+    return <ShareButton icon={icon} color={color} onClick={onClick} />
-                .map(site => (
+}
-                    <ShareButton
+
-                        key={site}
+function CopyUrlButton({ url }: { url: string }) {
-                        icon={Constants.sharing[site].icon}
+    return (
-                        color={Constants.sharing[site].color}
+        <CopyButton value={url}>
-                        url={Constants.sharing[site].url(url, desc)}
+            {({ copied, copy }) => <ShareButton icon={copied ? TbCheck : TbCopy} color="#000" onClick={copy} />}
-                    />
+        </CopyButton>
-                ))}
+    )
-        </SimpleGrid>
+}
-    )
+
-}
+function BrowserNativeShareButton({ url, description }: { url: string; description: string }) {
+    const mobile = useMobile()
+    const { isBrowserExtensionPopup } = useBrowserExtension()
+    const onClick = () => {
+        navigator.share({
+            title: description,
+            url,
+        })
+    }
+
+    return (
+        <ShareButton
+            icon={mobile && !isBrowserExtensionPopup ? TbDeviceMobileShare : TbDeviceDesktopShare}
+            color="#000"
+            onClick={onClick}
+        />
+    )
+}
+
+export function ShareButtons(props: { url: string; description: string }) {
+    const sharingSettings = useAppSelector(state => state.user.settings?.sharingSettings)
+    const enabledSharingSites = (Object.keys(Constants.sharing) as Array<keyof SharingSettings>).filter(site => sharingSettings?.[site])
+    const url = encodeURIComponent(props.url)
+    const desc = encodeURIComponent(props.description)
+    const clipboardAvailable = typeof navigator.clipboard !== "undefined"
+    const nativeSharingAvailable = typeof navigator.share !== "undefined"
+    const showNativeSection = clipboardAvailable || nativeSharingAvailable
+    const showSharingSites = enabledSharingSites.length > 0
+    const showDivider = showNativeSection && showSharingSites
+    const showNoSharingOptionsAvailable = !showNativeSection && !showSharingSites
+
+    return (
+        <>
+            {showNativeSection && (
+                <SimpleGrid cols={4}>
+                    {clipboardAvailable && <CopyUrlButton url={props.url} />}
+                    {nativeSharingAvailable && <BrowserNativeShareButton url={props.url} description={props.description} />}
+                </SimpleGrid>
+            )}
+
+            {showDivider && <Divider my="xs" />}
+
+            {showSharingSites && (
+                <SimpleGrid cols={4}>
+                    {enabledSharingSites.map(site => (
+                        <SiteShareButton
+                            key={site}
+                            icon={Constants.sharing[site].icon}
+                            color={Constants.sharing[site].color}
+                            url={Constants.sharing[site].url(url, desc)}
+                        />
+                    ))}
+                </SimpleGrid>
+            )}
+
+            {showNoSharingOptionsAvailable && <Trans>No sharing options available.</Trans>}
+        </>
+    )
+}

commafeed-client/src/components/content/add/AddCategory.tsx

@@ -1,50 +1,53 @@
-import { t, Trans } from "@lingui/macro"
+import { msg } from "@lingui/core/macro"
-import { Box, Button, Group, Stack, TextInput } from "@mantine/core"
+import { useLingui } from "@lingui/react"
-import { useForm } from "@mantine/form"
+import { Trans } from "@lingui/react/macro"
-import { client, errorToStrings } from "app/client"
+import { Box, Button, Group, Stack, TextInput } from "@mantine/core"
-import { redirectToSelectedSource } from "app/slices/redirect"
+import { useForm } from "@mantine/form"
-import { reloadTree } from "app/slices/tree"
+import { client, errorToStrings } from "app/client"
-import { useAppDispatch } from "app/store"
+import { redirectToSelectedSource } from "app/redirect/thunks"
-import { AddCategoryRequest } from "app/types"
+import { useAppDispatch } from "app/store"
-import { Alert } from "components/Alert"
+import { reloadTree } from "app/tree/thunks"
-import { useAsyncCallback } from "react-async-hook"
+import type { AddCategoryRequest } from "app/types"
-import { TbFolderPlus } from "react-icons/tb"
+import { Alert } from "components/Alert"
-import { CategorySelect } from "./CategorySelect"
+import { useAsyncCallback } from "react-async-hook"
-
+import { TbFolderPlus } from "react-icons/tb"
-export function AddCategory() {
+import { CategorySelect } from "./CategorySelect"
-    const dispatch = useAppDispatch()
+
-
+export function AddCategory() {
-    const form = useForm<AddCategoryRequest>()
+    const dispatch = useAppDispatch()
-
+    const { _ } = useLingui()
-    const addCategory = useAsyncCallback(client.category.add, {
+
-        onSuccess: () => {
+    const form = useForm<AddCategoryRequest>()
-            dispatch(reloadTree())
+
-            dispatch(redirectToSelectedSource())
+    const addCategory = useAsyncCallback(client.category.add, {
-        },
+        onSuccess: () => {
-    })
+            dispatch(reloadTree())
-
+            dispatch(redirectToSelectedSource())
-    return (
+        },
-        <>
+    })
-            {addCategory.error && (
+
-                <Box mb="md">
+    return (
-                    <Alert messages={errorToStrings(addCategory.error)} />
+        <>
-                </Box>
+            {addCategory.error && (
-            )}
+                <Box mb="md">
-
+                    <Alert messages={errorToStrings(addCategory.error)} />
-            <form onSubmit={form.onSubmit(addCategory.execute)}>
+                </Box>
-                <Stack>
+            )}
-                    <TextInput label={t`Category`} placeholder={t`Category`} {...form.getInputProps("name")} required />
+
-                    <CategorySelect label={t`Parent`} {...form.getInputProps("parentId")} clearable />
+            <form onSubmit={form.onSubmit(addCategory.execute)}>
-                    <Group position="center">
+                <Stack>
-                        <Button variant="default" onClick={() => dispatch(redirectToSelectedSource())}>
+                    <TextInput label={<Trans>Category</Trans>} placeholder={_(msg`Category`)} {...form.getInputProps("name")} required />
-                            <Trans>Cancel</Trans>
+                    <CategorySelect label={<Trans>Parent</Trans>} {...form.getInputProps("parentId")} clearable />
-                        </Button>
+                    <Group justify="center">
-                        <Button type="submit" leftIcon={<TbFolderPlus size={16} />} loading={addCategory.loading}>
+                        <Button variant="default" onClick={async () => await dispatch(redirectToSelectedSource())}>
-                            <Trans>Add</Trans>
+                            <Trans>Cancel</Trans>
-                        </Button>
+                        </Button>
-                    </Group>
+                        <Button type="submit" leftSection={<TbFolderPlus size={16} />} loading={addCategory.loading}>
-                </Stack>
+                            <Trans>Add</Trans>
-            </form>
+                        </Button>
-        </>
+                    </Group>
-    )
+                </Stack>
-}
+            </form>
+        </>
+    )
+}

commafeed-client/src/components/content/add/CategorySelect.tsx

@@ -1,31 +1,55 @@
-import { t } from "@lingui/macro"
+import { msg } from "@lingui/core/macro"
-import { Select, SelectItem, SelectProps } from "@mantine/core"
+import { useLingui } from "@lingui/react"
-import { Constants } from "app/constants"
+import { Select, type SelectProps } from "@mantine/core"
-import { useAppSelector } from "app/store"
+import type { ComboboxItem } from "@mantine/core/lib/components/Combobox/Combobox.types"
-import { flattenCategoryTree } from "app/utils"
+import { Constants } from "app/constants"
-
+import { useAppSelector } from "app/store"
-type CategorySelectProps = Partial<SelectProps> & {
+import type { Category } from "app/types"
-    withAll?: boolean
+import { flattenCategoryTree } from "app/utils"
-    withoutCategoryIds?: string[]
+
-}
+type CategorySelectProps = Partial<SelectProps> & {
-
+    withAll?: boolean
-export function CategorySelect(props: CategorySelectProps) {
+    withoutCategoryIds?: string[]
-    const rootCategory = useAppSelector(state => state.tree.rootCategory)
+}
-    const categories = rootCategory && flattenCategoryTree(rootCategory)
+
-    const selectData: SelectItem[] | undefined = categories
+export function CategorySelect(props: CategorySelectProps) {
-        ?.filter(c => c.id !== Constants.categories.all.id)
+    const rootCategory = useAppSelector(state => state.tree.rootCategory)
-        .filter(c => !props.withoutCategoryIds || !props.withoutCategoryIds.includes(c.id))
+    const { _ } = useLingui()
-        .sort((c1, c2) => c1.name.localeCompare(c2.name))
+
-        .map(c => ({
+    const categories = rootCategory && flattenCategoryTree(rootCategory)
-            label: c.parentName ? t`${c.name} (in ${c.parentName})` : c.name,
+    const categoriesById = categories?.reduce((map, c) => {
-            value: c.id,
+        map.set(c.id, c)
-        }))
+        return map
-    if (props.withAll) {
+    }, new Map<string, Category>())
-        selectData?.unshift({
+    const categoryLabel = (category: Category) => {
-            label: t`All`,
+        let cat = category
-            value: Constants.categories.all.id,
+        let label = cat.name
-        })
+
-    }
+        while (cat.parentId) {
-
+            const parent = categoriesById?.get(cat.parentId)
-    return <Select {...props} data={selectData ?? []} disabled={!selectData} />
+            if (!parent) {
-}
+                break
+            }
+            label = `${parent.name} → ${label}`
+            cat = parent
+        }
+
+        return label
+    }
+    const selectData: ComboboxItem[] | undefined = categories
+        ?.filter(c => c.id !== Constants.categories.all.id)
+        .filter(c => !props.withoutCategoryIds?.includes(c.id))
+        .map(c => ({
+            label: categoryLabel(c),
+            value: c.id,
+        }))
+        .sort((c1, c2) => c1.label.localeCompare(c2.label))
+    if (props.withAll) {
+        selectData?.unshift({
+            label: _(msg`All`),
+            value: Constants.categories.all.id,
+        })
+    }
+
+    return <Select {...props} data={selectData ?? []} disabled={!selectData} />
+}

commafeed-client/src/components/content/add/ImportOpml.tsx

@@ -1,58 +1,67 @@
-import { t, Trans } from "@lingui/macro"
+import { msg } from "@lingui/core/macro"
-import { Box, Button, FileInput, Group, Stack } from "@mantine/core"
+import { useLingui } from "@lingui/react"
-import { useForm } from "@mantine/form"
+import { Trans } from "@lingui/react/macro"
-import { client, errorToStrings } from "app/client"
+import { Box, Button, FileInput, Group, Stack } from "@mantine/core"
-import { redirectToSelectedSource } from "app/slices/redirect"
+import { isNotEmpty, useForm } from "@mantine/form"
-import { reloadTree } from "app/slices/tree"
+import { client, errorToStrings } from "app/client"
-import { useAppDispatch } from "app/store"
+import { redirectToSelectedSource } from "app/redirect/thunks"
-import { Alert } from "components/Alert"
+import { useAppDispatch } from "app/store"
-import { useAsyncCallback } from "react-async-hook"
+import { reloadTree } from "app/tree/thunks"
-import { TbFileImport } from "react-icons/tb"
+import { Alert } from "components/Alert"
-
+import { useAsyncCallback } from "react-async-hook"
-export function ImportOpml() {
+import { TbFileImport } from "react-icons/tb"
-    const dispatch = useAppDispatch()
+
-
+export function ImportOpml() {
-    const form = useForm<{ file: File }>({
+    const dispatch = useAppDispatch()
-        validate: {
+    const { _ } = useLingui()
-            file: v => (v ? null : t`file is required`),
+
-        },
+    const form = useForm<{ file: File }>({
-    })
+        validate: {
-
+            file: isNotEmpty(_(msg`OPML file is required`)),
-    const importOpml = useAsyncCallback(client.feed.importOpml, {
+        },
-        onSuccess: () => {
+    })
-            dispatch(reloadTree())
+
-            dispatch(redirectToSelectedSource())
+    const importOpml = useAsyncCallback(client.feed.importOpml, {
-        },
+        onSuccess: () => {
-    })
+            dispatch(reloadTree())
-
+            dispatch(redirectToSelectedSource())
-    return (
+        },
-        <>
+    })
-            {importOpml.error && (
+
-                <Box mb="md">
+    return (
-                    <Alert messages={errorToStrings(importOpml.error)} />
+        <>
-                </Box>
+            {importOpml.error && (
-            )}
+                <Box mb="md">
-
+                    <Alert messages={errorToStrings(importOpml.error)} />
-            <form onSubmit={form.onSubmit(v => importOpml.execute(v.file))}>
+                </Box>
-                <Stack>
+            )}
-                    <FileInput
+
-                        label={t`OPML file`}
+            <form onSubmit={form.onSubmit(async v => await importOpml.execute(v.file))}>
-                        placeholder={t`OPML file`}
+                <Stack>
-                        description={t`An opml file is an XML file containing feed URLs and categories. You can get an OPML file by exporting your data from other feed reading services.`}
+                    <FileInput
-                        {...form.getInputProps("file")}
+                        label={<Trans>OPML file</Trans>}
-                        required
+                        leftSection={<TbFileImport />}
-                        accept="application/xml"
+                        placeholder={_(msg`OPML file`)}
-                    />
+                        description={
-                    <Group position="center">
+                            <Trans>
-                        <Button variant="default" onClick={() => dispatch(redirectToSelectedSource())}>
+                                An opml file is an XML file containing feed URLs and categories. You can get an OPML file by exporting your
-                            <Trans>Cancel</Trans>
+                                data from other feed reading services.
-                        </Button>
+                            </Trans>
-                        <Button type="submit" leftIcon={<TbFileImport size={16} />} loading={importOpml.loading}>
+                        }
-                            <Trans>Import</Trans>
+                        {...form.getInputProps("file")}
-                        </Button>
+                        required
-                    </Group>
+                        accept=".xml,.opml"
-                </Stack>
+                    />
-            </form>
+                    <Group justify="center">
-        </>
+                        <Button variant="default" onClick={async () => await dispatch(redirectToSelectedSource())}>
-    )
+                            <Trans>Cancel</Trans>
-}
+                        </Button>
+                        <Button type="submit" leftSection={<TbFileImport size={16} />} loading={importOpml.loading}>
+                            <Trans>Import</Trans>
+                        </Button>
+                    </Group>
+                </Stack>
+            </form>
+        </>
+    )
+}

commafeed-client/src/components/content/add/Subscribe.tsx

@@ -1,117 +1,129 @@
-import { t, Trans } from "@lingui/macro"
+import { Trans } from "@lingui/react/macro"
-import { Box, Button, Group, Stack, Stepper, TextInput } from "@mantine/core"
+import { Box, Button, Group, Stack, Stepper, TextInput } from "@mantine/core"
-import { useForm } from "@mantine/form"
+import { useForm } from "@mantine/form"
-import { client, errorToStrings } from "app/client"
+import { client, errorToStrings } from "app/client"
-import { Constants } from "app/constants"
+import { Constants } from "app/constants"
-import { redirectToFeed, redirectToSelectedSource } from "app/slices/redirect"
+import { redirectToFeed, redirectToSelectedSource } from "app/redirect/thunks"
-import { reloadTree } from "app/slices/tree"
+import { useAppDispatch } from "app/store"
-import { useAppDispatch } from "app/store"
+import { reloadTree } from "app/tree/thunks"
-import { FeedInfoRequest, SubscribeRequest } from "app/types"
+import type { FeedInfoRequest, SubscribeRequest } from "app/types"
-import { Alert } from "components/Alert"
+import { Alert } from "components/Alert"
-import { useState } from "react"
+import { useState } from "react"
-import { useAsyncCallback } from "react-async-hook"
+import { useAsyncCallback } from "react-async-hook"
-import { TbRss } from "react-icons/tb"
+import { TbRss } from "react-icons/tb"
-import { CategorySelect } from "./CategorySelect"
+import { CategorySelect } from "./CategorySelect"
-
+
-export function Subscribe() {
+export function Subscribe() {
-    const [activeStep, setActiveStep] = useState(0)
+    const [activeStep, setActiveStep] = useState(0)
-    const dispatch = useAppDispatch()
+    const dispatch = useAppDispatch()
-
+
-    const step0Form = useForm<FeedInfoRequest>({
+    const step0Form = useForm<FeedInfoRequest>({
-        initialValues: {
+        initialValues: {
-            url: "",
+            url: "",
-        },
+        },
-    })
+    })
-
+
-    const step1Form = useForm<SubscribeRequest>({
+    const step1Form = useForm<SubscribeRequest>({
-        initialValues: {
+        initialValues: {
-            url: "",
+            url: "",
-            title: "",
+            title: "",
-            categoryId: Constants.categories.all.id,
+            categoryId: Constants.categories.all.id,
-        },
+        },
-    })
+    })
-
+
-    const fetchFeed = useAsyncCallback(client.feed.fetchFeed, {
+    const fetchFeed = useAsyncCallback(client.feed.fetchFeed, {
-        onSuccess: ({ data }) => {
+        onSuccess: ({ data }) => {
-            step1Form.setFieldValue("url", data.url)
+            step1Form.setFieldValue("url", data.url)
-            step1Form.setFieldValue("title", data.title)
+            step1Form.setFieldValue("title", data.title)
-            setActiveStep(step => step + 1)
+            setActiveStep(step => step + 1)
-        },
+        },
-    })
+    })
-    const subscribe = useAsyncCallback(client.feed.subscribe, {
+    const subscribe = useAsyncCallback(client.feed.subscribe, {
-        onSuccess: sub => {
+        onSuccess: async sub => {
-            dispatch(reloadTree())
+            await dispatch(reloadTree())
-            dispatch(redirectToFeed(sub.data))
+            dispatch(redirectToFeed(sub.data))
-        },
+        },
-    })
+    })
-
+
-    const previousStep = () => {
+    const previousStep = () => {
-        if (activeStep === 0) dispatch(redirectToSelectedSource())
+        if (activeStep === 0) {
-        else setActiveStep(activeStep - 1)
+            dispatch(redirectToSelectedSource())
-    }
+        } else {
-    const nextStep = (e: React.FormEvent<HTMLFormElement>) => {
+            setActiveStep(activeStep - 1)
-        if (activeStep === 0) {
+        }
-            step0Form.onSubmit(fetchFeed.execute)(e)
+    }
-        } else if (activeStep === 1) {
+    const nextStep = (e: React.FormEvent<HTMLFormElement>) => {
-            step1Form.onSubmit(subscribe.execute)(e)
+        if (activeStep === 0) {
-        }
+            step0Form.onSubmit(fetchFeed.execute)(e)
-    }
+        } else if (activeStep === 1) {
-
+            step1Form.onSubmit(subscribe.execute)(e)
-    return (
+        }
-        <>
+    }
-            {fetchFeed.error && (
+
-                <Box mb="md">
+    return (
-                    <Alert messages={errorToStrings(fetchFeed.error)} />
+        <>
-                </Box>
+            {fetchFeed.error && (
-            )}
+                <Box mb="md">
-
+                    <Alert messages={errorToStrings(fetchFeed.error)} />
-            {subscribe.error && (
+                </Box>
-                <Box mb="md">
+            )}
-                    <Alert messages={errorToStrings(subscribe.error)} />
+
-                </Box>
+            {subscribe.error && (
-            )}
+                <Box mb="md">
-
+                    <Alert messages={errorToStrings(subscribe.error)} />
-            <form onSubmit={nextStep}>
+                </Box>
-                <Stepper active={activeStep} onStepClick={setActiveStep}>
+            )}
-                    <Stepper.Step
+
-                        label={t`Analyze feed`}
+            <form onSubmit={nextStep}>
-                        description={t`Check that the feed is working`}
+                <Stepper active={activeStep} onStepClick={setActiveStep}>
-                        allowStepSelect={activeStep === 1}
+                    <Stepper.Step
-                    >
+                        label={<Trans>Analyze feed</Trans>}
-                        <TextInput
+                        description={<Trans>Check that the feed is working</Trans>}
-                            label={t`Feed URL`}
+                        allowStepSelect={activeStep === 1}
-                            placeholder="http://www.mysite.com/rss"
+                    >
-                            description={t`The URL for the feed you want to subscribe to. You can also use the website's url directly and CommaFeed will try to find the feed in the page.`}
+                        <TextInput
-                            required
+                            label={<Trans>Feed URL</Trans>}
-                            autoFocus
+                            placeholder="https://www.mysite.com/rss"
-                            {...step0Form.getInputProps("url")}
+                            description={
-                        />
+                                <Trans>
-                    </Stepper.Step>
+                                    The URL for the feed you want to subscribe to. You can also use the website's url directly and CommaFeed
-                    <Stepper.Step label={t`Subscribe`} description={t`Subscribe to the feed`} allowStepSelect={false}>
+                                    will try to find the feed in the page.
-                        <Stack>
+                                </Trans>
-                            <TextInput label={t`Feed URL`} {...step1Form.getInputProps("url")} disabled />
+                            }
-                            <TextInput label={t`Feed name`} {...step1Form.getInputProps("title")} required autoFocus />
+                            required
-                            <CategorySelect label={t`Category`} {...step1Form.getInputProps("categoryId")} clearable />
+                            autoFocus
-                        </Stack>
+                            {...step0Form.getInputProps("url")}
-                    </Stepper.Step>
+                        />
-                </Stepper>
+                    </Stepper.Step>
-
+                    <Stepper.Step
-                <Group position="center" mt="xl">
+                        label={<Trans>Subscribe</Trans>}
-                    <Button variant="default" onClick={previousStep}>
+                        description={<Trans>Subscribe to the feed</Trans>}
-                        <Trans>Back</Trans>
+                        allowStepSelect={false}
-                    </Button>
+                    >
-                    {activeStep === 0 && (
+                        <Stack>
-                        <Button type="submit" loading={fetchFeed.loading}>
+                            <TextInput label={<Trans>Feed URL</Trans>} {...step1Form.getInputProps("url")} disabled />
-                            <Trans>Next</Trans>
+                            <TextInput label={<Trans>Feed name</Trans>} {...step1Form.getInputProps("title")} required autoFocus />
-                        </Button>
+                            <CategorySelect label={<Trans>Category</Trans>} {...step1Form.getInputProps("categoryId")} clearable />
-                    )}
+                        </Stack>
-                    {activeStep === 1 && (
+                    </Stepper.Step>
-                        <Button type="submit" leftIcon={<TbRss size={16} />} loading={fetchFeed.loading || subscribe.loading}>
+                </Stepper>
-                            <Trans>Subscribe</Trans>
+
-                        </Button>
+                <Group justify="center" mt="xl">
-                    )}
+                    <Button variant="default" onClick={previousStep}>
-                </Group>
+                        <Trans>Back</Trans>
-            </form>
+                    </Button>
-        </>
+                    {activeStep === 0 && (
-    )
+                        <Button type="submit" loading={fetchFeed.loading}>
-}
+                            <Trans>Next</Trans>
+                        </Button>
+                    )}
+                    {activeStep === 1 && (
+                        <Button type="submit" leftSection={<TbRss size={16} />} loading={fetchFeed.loading || subscribe.loading}>
+                            <Trans>Subscribe</Trans>
+                        </Button>
+                    )}
+                </Group>
+            </form>
+        </>
+    )
+}

commafeed-client/src/components/content/header/FeedEntryCompactHeader.tsx

@@ -0,0 +1,72 @@
+import { Box, Text } from "@mantine/core"
+import type { Entry } from "app/types"
+import { RelativeDate } from "components/RelativeDate"
+import { FeedFavicon } from "components/content/FeedFavicon"
+import { OpenExternalLink } from "components/content/header/OpenExternalLink"
+import { Star } from "components/content/header/Star"
+import { OnDesktop } from "components/responsive/OnDesktop"
+import { tss } from "tss"
+import { FeedEntryTitle } from "./FeedEntryTitle"
+
+export interface FeedEntryHeaderProps {
+    entry: Entry
+    showStarIcon?: boolean
+    showExternalLinkIcon?: boolean
+}
+
+const useStyles = tss
+    .withParams<{
+        read: boolean
+    }>()
+    .create(({ colorScheme, read }) => ({
+        wrapper: {
+            display: "flex",
+            alignItems: "center",
+            columnGap: "10px",
+        },
+        title: {
+            flexGrow: 1,
+            fontWeight: colorScheme === "light" && !read ? "bold" : "inherit",
+            whiteSpace: "nowrap",
+            overflow: "hidden",
+            textOverflow: "ellipsis",
+        },
+        feedName: {
+            width: "145px",
+            minWidth: "145px",
+            whiteSpace: "nowrap",
+            overflow: "hidden",
+            textOverflow: "ellipsis",
+        },
+        date: {
+            whiteSpace: "nowrap",
+        },
+    }))
+
+export function FeedEntryCompactHeader(props: FeedEntryHeaderProps) {
+    const { classes } = useStyles({
+        read: props.entry.read,
+    })
+    return (
+        <Box className={classes.wrapper}>
+            {props.showStarIcon && <Star entry={props.entry} />}
+            <Box>
+                <FeedFavicon url={props.entry.iconUrl} />
+            </Box>
+            <OnDesktop>
+                <Text c="dimmed" className={classes.feedName}>
+                    {props.entry.feedName}
+                </Text>
+            </OnDesktop>
+            <Box className={classes.title}>
+                <FeedEntryTitle entry={props.entry} />
+            </Box>
+            <OnDesktop>
+                <Text c="dimmed" className={classes.date}>
+                    <RelativeDate date={props.entry.date} />
+                </Text>
+            </OnDesktop>
+            {props.showExternalLinkIcon && <OpenExternalLink entry={props.entry} />}
+        </Box>
+    )
+}

commafeed-client/src/components/content/header/FeedEntryHeader.tsx

@@ -0,0 +1,67 @@
+import { Box, Flex, Space, Text } from "@mantine/core"
+import type { Entry } from "app/types"
+import { RelativeDate } from "components/RelativeDate"
+import { FeedFavicon } from "components/content/FeedFavicon"
+import { OpenExternalLink } from "components/content/header/OpenExternalLink"
+import { Star } from "components/content/header/Star"
+import { tss } from "tss"
+import { FeedEntryTitle } from "./FeedEntryTitle"
+
+export interface FeedEntryHeaderProps {
+    entry: Entry
+    expanded: boolean
+    showStarIcon?: boolean
+    showExternalLinkIcon?: boolean
+}
+
+const useStyles = tss
+    .withParams<{
+        read: boolean
+    }>()
+    .create(({ colorScheme, read }) => ({
+        main: {
+            fontWeight: colorScheme === "light" && !read ? "bold" : "inherit",
+        },
+        details: {
+            fontSize: "90%",
+        },
+    }))
+
+export function FeedEntryHeader(props: FeedEntryHeaderProps) {
+    const { classes } = useStyles({
+        read: props.entry.read,
+    })
+    return (
+        <Box>
+            <Flex align="flex-start" justify="space-between">
+                <Flex align="flex-start" className={classes.main}>
+                    {props.showStarIcon && (
+                        <Box ml={-5}>
+                            <Star entry={props.entry} />
+                        </Box>
+                    )}
+                    <FeedEntryTitle entry={props.entry} />
+                </Flex>
+                {props.showExternalLinkIcon && <OpenExternalLink entry={props.entry} />}
+            </Flex>
+            <Flex align="center" className={classes.details}>
+                <FeedFavicon url={props.entry.iconUrl} />
+                <Space w={6} />
+                <Text c="dimmed">
+                    {props.entry.feedName}
+                    <span> · </span>
+                    <RelativeDate date={props.entry.date} />
+                </Text>
+            </Flex>
+            {props.expanded && (
+                <Box className={classes.details}>
+                    <Text c="dimmed">
+                        {props.entry.author && <span>by {props.entry.author}</span>}
+                        {props.entry.author && props.entry.categories && <span>&nbsp;·&nbsp;</span>}
+                        {props.entry.categories && <span>{props.entry.categories}</span>}
+                    </Text>
+                </Box>
+            )}
+        </Box>
+    )
+}

commafeed-client/src/components/content/header/FeedEntryTitle.tsx

@@ -1,21 +1,22 @@
-import { Highlight } from "@mantine/core"
+import { Highlight } from "@mantine/core"
-import { useAppSelector } from "app/store"
+import { useAppSelector } from "app/store"
-import { Entry } from "app/types"
+import type { Entry } from "app/types"
-
+
-export interface FeedEntryTitleProps {
+export interface FeedEntryTitleProps {
-    entry: Entry
+    entry: Entry
-}
+}
-
+
-export function FeedEntryTitle(props: FeedEntryTitleProps) {
+export function FeedEntryTitle(props: FeedEntryTitleProps) {
-    const search = useAppSelector(state => state.entries.search)
+    const search = useAppSelector(state => state.entries.search)
-    const keywords = search?.split(" ")
+    const keywords = search?.split(" ")
-    return (
+    return (
-        <Highlight
+        <Highlight
-            highlight={keywords ?? ""}
+            inherit
-            // make sure ellipsis is shown when title is too long
+            highlight={keywords ?? ""}
-            span
+            // make sure ellipsis is shown when title is too long
-        >
+            span
-            {props.entry.title}
+        >
-        </Highlight>
+            {props.entry.title}
-    )
+        </Highlight>
-}
+    )
+}

commafeed-client/src/components/content/header/OpenExternalLink.tsx

@@ -0,0 +1,30 @@
+import { Trans } from "@lingui/react/macro"
+import { ActionIcon, Anchor, Tooltip } from "@mantine/core"
+import { Constants } from "app/constants"
+import { markEntry } from "app/entries/thunks"
+import { useAppDispatch } from "app/store"
+import type { Entry } from "app/types"
+import { TbExternalLink } from "react-icons/tb"
+
+export function OpenExternalLink(props: { entry: Entry }) {
+    const dispatch = useAppDispatch()
+    const onClick = (e: React.MouseEvent) => {
+        e.stopPropagation()
+        dispatch(
+            markEntry({
+                entry: props.entry,
+                read: true,
+            })
+        )
+    }
+
+    return (
+        <Anchor href={props.entry.url} target="_blank" rel="noreferrer" onClick={onClick}>
+            <Tooltip label={<Trans>Open link</Trans>} openDelay={Constants.tooltip.delay}>
+                <ActionIcon variant="transparent" c="dimmed">
+                    <TbExternalLink size={18} />
+                </ActionIcon>
+            </Tooltip>
+        </Anchor>
+    )
+}

commafeed-client/src/components/content/header/Star.tsx

@@ -0,0 +1,29 @@
+import { Trans } from "@lingui/react/macro"
+import { ActionIcon, Tooltip } from "@mantine/core"
+import { Constants } from "app/constants"
+import { starEntry } from "app/entries/thunks"
+import { useAppDispatch } from "app/store"
+import type { Entry } from "app/types"
+import { TbStar, TbStarFilled } from "react-icons/tb"
+
+export function Star(props: { entry: Entry }) {
+    const dispatch = useAppDispatch()
+    const onClick = (e: React.MouseEvent) => {
+        e.stopPropagation()
+        e.preventDefault()
+        dispatch(
+            starEntry({
+                entry: props.entry,
+                starred: !props.entry.starred,
+            })
+        )
+    }
+
+    return (
+        <Tooltip label={props.entry.starred ? <Trans>Unstar</Trans> : <Trans>Star</Trans>} openDelay={Constants.tooltip.delay}>
+            <ActionIcon variant="transparent" onClick={onClick}>
+                {props.entry.starred ? <TbStarFilled size={18} /> : <TbStar size={18} />}
+            </ActionIcon>
+        </Tooltip>
+    )
+}

commafeed-client/src/components/header/Header.tsx

@@ -1,88 +1,171 @@
-import { t } from "@lingui/macro"
+import { msg } from "@lingui/core/macro"
-import { ActionIcon, Center, Divider, Indicator, Popover, TextInput } from "@mantine/core"
+import { useLingui } from "@lingui/react"
-import { useForm } from "@mantine/form"
+import { Box, Center, CloseButton, Divider, Group, Indicator, Popover, TextInput } from "@mantine/core"
-import { reloadEntries, search } from "app/slices/entries"
+import { useForm } from "@mantine/form"
-import { changeReadingMode, changeReadingOrder } from "app/slices/user"
+import { reloadEntries, search, selectNextEntry, selectPreviousEntry } from "app/entries/thunks"
-import { useAppDispatch, useAppSelector } from "app/store"
+import { useAppDispatch, useAppSelector } from "app/store"
-import { ActionButton } from "components/ActionButtton"
+import { changeReadingMode, changeReadingOrder } from "app/user/thunks"
-import { ButtonToolbar } from "components/ButtonToolbar"
+import { ActionButton } from "components/ActionButton"
-import { Loader } from "components/Loader"
+import { Loader } from "components/Loader"
-import { useEffect } from "react"
+import { useActionButton } from "hooks/useActionButton"
-import { TbArrowDown, TbArrowUp, TbEye, TbEyeOff, TbRefresh, TbSearch, TbUser, TbX } from "react-icons/tb"
+import { useBrowserExtension } from "hooks/useBrowserExtension"
-import { MarkAllAsReadButton } from "./MarkAllAsReadButton"
+import { useMobile } from "hooks/useMobile"
-import { ProfileMenu } from "./ProfileMenu"
+import { useEffect } from "react"
-
+import {
-function HeaderDivider() {
+    TbArrowDown,
-    return <Divider orientation="vertical" />
+    TbArrowUp,
-}
+    TbExternalLink,
-
+    TbEye,
-const iconSize = 18
+    TbEyeOff,
-export function Header() {
+    TbRefresh,
-    const settings = useAppSelector(state => state.user.settings)
+    TbSearch,
-    const profile = useAppSelector(state => state.user.profile)
+    TbSettings,
-    const searchFromStore = useAppSelector(state => state.entries.search)
+    TbSortAscending,
-    const dispatch = useAppDispatch()
+    TbSortDescending,
-
+    TbUser,
-    const searchForm = useForm<{ search: string }>({
+} from "react-icons/tb"
-        validate: {
+import { MarkAllAsReadButton } from "./MarkAllAsReadButton"
-            search: value => (value.length > 0 && value.length < 3 ? t`Search requires at least 3 characters` : null),
+import { ProfileMenu } from "./ProfileMenu"
-        },
+
-    })
+function HeaderDivider() {
-    const { setValues } = searchForm
+    return <Divider orientation="vertical" />
-
+}
-    useEffect(() => {
+
-        setValues({
+function HeaderToolbar(props: { children: React.ReactNode }) {
-            search: searchFromStore,
+    const { spacing } = useActionButton()
-        })
+    const mobile = useMobile("480px")
-    }, [setValues, searchFromStore])
+    return mobile ? (
-
+        // on mobile use all available width
-    if (!settings) return <Loader />
+        <Box
-    return (
+            style={{
-        <Center>
+                width: "100%",
-            <ButtonToolbar>
+                display: "flex",
-                <ActionButton icon={<TbRefresh size={iconSize} />} label={t`Refresh`} onClick={() => dispatch(reloadEntries())} />
+                justifyContent: "space-between",
-                <MarkAllAsReadButton iconSize={iconSize} />
+            }}
-
+        >
-                <HeaderDivider />
+            {props.children}
-
+        </Box>
-                <ActionButton
+    ) : (
-                    icon={settings.readingMode === "all" ? <TbEye size={iconSize} /> : <TbEyeOff size={iconSize} />}
+        <Group gap={spacing}>{props.children}</Group>
-                    label={settings.readingMode === "all" ? t`All` : t`Unread`}
+    )
-                    onClick={() => dispatch(changeReadingMode(settings.readingMode === "all" ? "unread" : "all"))}
+}
-                />
+
-                <ActionButton
+const iconSize = 18
-                    icon={settings.readingOrder === "asc" ? <TbArrowUp size={iconSize} /> : <TbArrowDown size={iconSize} />}
+
-                    label={settings.readingOrder === "asc" ? t`Asc` : t`Desc`}
+export function Header() {
-                    onClick={() => dispatch(changeReadingOrder(settings.readingOrder === "asc" ? "desc" : "asc"))}
+    const settings = useAppSelector(state => state.user.settings)
-                />
+    const profile = useAppSelector(state => state.user.profile)
-
+    const searchFromStore = useAppSelector(state => state.entries.search)
-                <Popover>
+    const { isBrowserExtensionPopup, openSettingsPage, openAppInNewTab } = useBrowserExtension()
-                    <Popover.Target>
+    const dispatch = useAppDispatch()
-                        <Indicator disabled={!searchFromStore}>
+    const { _ } = useLingui()
-                            <ActionButton icon={<TbSearch size={iconSize} />} label={t`Search`} />
+
-                        </Indicator>
+    const searchForm = useForm<{ search: string }>({
-                    </Popover.Target>
+        validate: {
-                    <Popover.Dropdown>
+            search: value => (value.length > 0 && value.length < 3 ? _(msg`Search requires at least 3 characters`) : null),
-                        <form onSubmit={searchForm.onSubmit(values => dispatch(search(values.search)))}>
+        },
-                            <TextInput
+    })
-                                placeholder={t`Search`}
+    const { setValues } = searchForm
-                                {...searchForm.getInputProps("search")}
+
-                                icon={<TbSearch size={iconSize} />}
+    useEffect(() => {
-                                rightSection={
+        setValues({
-                                    <ActionIcon onClick={() => searchFromStore && dispatch(search(""))}>
+            search: searchFromStore,
-                                        <TbX />
+        })
-                                    </ActionIcon>
+    }, [setValues, searchFromStore])
-                                }
+
-                                autoFocus
+    if (!settings) return <Loader />
-                            />
+    return (
-                        </form>
+        <Center>
-                    </Popover.Dropdown>
+            <HeaderToolbar>
-                </Popover>
+                <ActionButton
-
+                    icon={<TbArrowUp size={iconSize} />}
-                <HeaderDivider />
+                    label={msg`Previous`}
-
+                    onClick={async () =>
-                <ProfileMenu control={<ActionButton icon={<TbUser size={iconSize} />} label={profile?.name} />} />
+                        await dispatch(
-            </ButtonToolbar>
+                            selectPreviousEntry({
-        </Center>
+                                expand: true,
-    )
+                                markAsRead: true,
-}
+                                scrollToEntry: true,
+                            })
+                        )
+                    }
+                />
+                <ActionButton
+                    icon={<TbArrowDown size={iconSize} />}
+                    label={msg`Next`}
+                    onClick={async () =>
+                        await dispatch(
+                            selectNextEntry({
+                                expand: true,
+                                markAsRead: true,
+                                scrollToEntry: true,
+                            })
+                        )
+                    }
+                />
+
+                <HeaderDivider />
+
+                <ActionButton
+                    icon={<TbRefresh size={iconSize} />}
+                    label={msg`Refresh`}
+                    onClick={async () => await dispatch(reloadEntries())}
+                />
+                <MarkAllAsReadButton iconSize={iconSize} />
+
+                <HeaderDivider />
+
+                <ActionButton
+                    icon={settings.readingMode === "all" ? <TbEye size={iconSize} /> : <TbEyeOff size={iconSize} />}
+                    label={settings.readingMode === "all" ? msg`All` : msg`Unread`}
+                    onClick={async () => await dispatch(changeReadingMode(settings.readingMode === "all" ? "unread" : "all"))}
+                />
+                <ActionButton
+                    icon={settings.readingOrder === "asc" ? <TbSortAscending size={iconSize} /> : <TbSortDescending size={iconSize} />}
+                    label={settings.readingOrder === "asc" ? msg`Asc` : msg`Desc`}
+                    onClick={async () => await dispatch(changeReadingOrder(settings.readingOrder === "asc" ? "desc" : "asc"))}
+                />
+
+                <Popover>
+                    <Popover.Target>
+                        <Indicator disabled={!searchFromStore}>
+                            <ActionButton icon={<TbSearch size={iconSize} />} label={msg`Search`} />
+                        </Indicator>
+                    </Popover.Target>
+                    <Popover.Dropdown>
+                        <form onSubmit={searchForm.onSubmit(async values => await dispatch(search(values.search)))}>
+                            <TextInput
+                                placeholder={_(msg`Search`)}
+                                {...searchForm.getInputProps("search")}
+                                leftSection={<TbSearch size={iconSize} />}
+                                rightSection={<CloseButton onClick={async () => await (searchFromStore && dispatch(search("")))} />}
+                                autoFocus
+                            />
+                        </form>
+                    </Popover.Dropdown>
+                </Popover>
+
+                <HeaderDivider />
+
+                <ProfileMenu control={<ActionButton icon={<TbUser size={iconSize} />} label={profile?.name} />} />
+
+                {isBrowserExtensionPopup && (
+                    <>
+                        <HeaderDivider />
+
+                        <ActionButton
+                            icon={<TbSettings size={iconSize} />}
+                            label={msg`Extension options`}
+                            onClick={() => openSettingsPage()}
+                        />
+                        <ActionButton
+                            icon={<TbExternalLink size={iconSize} />}
+                            label={msg`Open CommaFeed`}
+                            onClick={() => openAppInNewTab()}
+                        />
+                    </>
+                )}
+            </HeaderToolbar>
+        </Center>
+    )
+}

commafeed-client/src/components/header/MarkAllAsReadButton.tsx

@@ -1,83 +1,98 @@
-import { t, Trans } from "@lingui/macro"
+import { msg } from "@lingui/core/macro"
-
+import { Trans } from "@lingui/react/macro"
-import { Button, Code, Group, Modal, Slider, Stack, Text } from "@mantine/core"
+
-import { markAllEntries } from "app/slices/entries"
+import { Button, Code, Group, Modal, Slider, Stack, Text } from "@mantine/core"
-import { useAppDispatch, useAppSelector } from "app/store"
+import { markAllEntries } from "app/entries/thunks"
-import { ActionButton } from "components/ActionButtton"
+import { useAppDispatch, useAppSelector } from "app/store"
-import { useState } from "react"
+import { ActionButton } from "components/ActionButton"
-import { TbChecks } from "react-icons/tb"
+import { useState } from "react"
-
+import { TbChecks } from "react-icons/tb"
-export function MarkAllAsReadButton(props: { iconSize: number }) {
+
-    const [opened, setOpened] = useState(false)
+export function MarkAllAsReadButton(props: { iconSize: number }) {
-    const [threshold, setThreshold] = useState(0)
+    const [opened, setOpened] = useState(false)
-    const source = useAppSelector(state => state.entries.source)
+    const [threshold, setThreshold] = useState(0)
-    const sourceLabel = useAppSelector(state => state.entries.sourceLabel)
+    const source = useAppSelector(state => state.entries.source)
-    const entriesTimestamp = useAppSelector(state => state.entries.timestamp) ?? Date.now()
+    const sourceLabel = useAppSelector(state => state.entries.sourceLabel)
-    const dispatch = useAppDispatch()
+    const entriesTimestamp = useAppSelector(state => state.entries.timestamp) ?? Date.now()
-
+    const markAllAsReadConfirmation = useAppSelector(state => state.user.settings?.markAllAsReadConfirmation)
-    return (
+    const dispatch = useAppDispatch()
-        <>
+
-            <Modal opened={opened} onClose={() => setOpened(false)} title={t`Mark all entries as read`}>
+    const buttonClicked = () => {
-                <Stack>
+        if (markAllAsReadConfirmation) {
-                    <Text size="sm">
+            setThreshold(0)
-                        {threshold === 0 && (
+            setOpened(true)
-                            <Trans>
+        } else {
-                                Are you sure you want to mark all entries of <Code>{sourceLabel}</Code> as read?
+            dispatch(
-                            </Trans>
+                markAllEntries({
-                        )}
+                    sourceType: source.type,
-                        {threshold > 0 && (
+                    req: {
-                            <Trans>
+                        id: source.id,
-                                Are you sure you want to mark entries older than {threshold} days of <Code>{sourceLabel}</Code> as read?
+                        read: true,
-                            </Trans>
+                        olderThan: Date.now(),
-                        )}
+                        insertedBefore: entriesTimestamp,
-                    </Text>
+                    },
-                    <Slider
+                })
-                        py="xl"
+            )
-                        min={0}
+        }
-                        max={28}
+    }
-                        marks={[
+
-                            { value: 0, label: "0" },
+    return (
-                            { value: 7, label: "7" },
+        <>
-                            { value: 14, label: "14" },
+            <Modal opened={opened} onClose={() => setOpened(false)} title={<Trans>Mark all entries as read</Trans>}>
-                            { value: 21, label: "21" },
+                <Stack>
-                            { value: 28, label: "28" },
+                    <Text size="sm">
-                        ]}
+                        {threshold === 0 && (
-                        value={threshold}
+                            <Trans>
-                        onChange={setThreshold}
+                                Are you sure you want to mark all entries of <Code>{sourceLabel}</Code> as read?
-                    />
+                            </Trans>
-                    <Group position="right">
+                        )}
-                        <Button variant="default" onClick={() => setOpened(false)}>
+                        {threshold > 0 && (
-                            <Trans>Cancel</Trans>
+                            <Trans>
-                        </Button>
+                                Are you sure you want to mark entries older than {threshold} days of <Code>{sourceLabel}</Code> as read?
-                        <Button
+                            </Trans>
-                            color="red"
+                        )}
-                            onClick={() => {
+                    </Text>
-                                setOpened(false)
+                    <Slider
-                                dispatch(
+                        py="xl"
-                                    markAllEntries({
+                        min={0}
-                                        sourceType: source.type,
+                        max={28}
-                                        req: {
+                        marks={[
-                                            id: source.id,
+                            { value: 0, label: "0" },
-                                            read: true,
+                            { value: 7, label: "7" },
-                                            olderThan: entriesTimestamp - threshold * 24 * 60 * 60 * 1000,
+                            { value: 14, label: "14" },
-                                        },
+                            { value: 21, label: "21" },
-                                    })
+                            { value: 28, label: "28" },
-                                )
+                        ]}
-                            }}
+                        value={threshold}
-                        >
+                        onChange={setThreshold}
-                            <Trans>Confirm</Trans>
+                    />
-                        </Button>
+                    <Group justify="flex-end">
-                    </Group>
+                        <Button variant="default" onClick={() => setOpened(false)}>
-                </Stack>
+                            <Trans>Cancel</Trans>
-            </Modal>
+                        </Button>
-            <ActionButton
+                        <Button
-                icon={<TbChecks size={props.iconSize} />}
+                            color="red"
-                label={t`Mark all as read`}
+                            onClick={() => {
-                onClick={() => {
+                                setOpened(false)
-                    setThreshold(0)
+                                dispatch(
-                    setOpened(true)
+                                    markAllEntries({
-                }}
+                                        sourceType: source.type,
-            />
+                                        req: {
-        </>
+                                            id: source.id,
-    )
+                                            read: true,
-}
+                                            olderThan: Date.now() - threshold * 24 * 60 * 60 * 1000,
+                                            insertedBefore: entriesTimestamp,
+                                        },
+                                    })
+                                )
+                            }}
+                        >
+                            <Trans>Confirm</Trans>
+                        </Button>
+                    </Group>
+                </Stack>
+            </Modal>
+            <ActionButton icon={<TbChecks size={props.iconSize} />} label={msg`Mark all as read`} onClick={buttonClicked} />
+        </>
+    )
+}

commafeed-client/src/components/header/ProfileMenu.tsx

@@ -1,189 +1,241 @@
-import { t, Trans } from "@lingui/macro"
+import { Trans } from "@lingui/react/macro"
-import { Box, Divider, Group, Menu, SegmentedControl, SegmentedControlItem, useMantineColorScheme } from "@mantine/core"
+import {
-import { showNotification } from "@mantine/notifications"
+    Box,
-import { client } from "app/client"
+    Divider,
-import { redirectToAbout, redirectToAdminUsers, redirectToMetrics, redirectToSettings } from "app/slices/redirect"
+    Group,
-import { useAppDispatch, useAppSelector } from "app/store"
+    type MantineColorScheme,
-import { ViewMode } from "app/types"
+    Menu,
-import { useState } from "react"
+    SegmentedControl,
-import {
+    type SegmentedControlItem,
-    TbChartLine,
+    useMantineColorScheme,
-    TbHelp,
+} from "@mantine/core"
-    TbLayoutList,
+import { showNotification } from "@mantine/notifications"
-    TbList,
+import { client } from "app/client"
-    TbListDetails,
+import { redirectToAbout, redirectToAdminUsers, redirectToDonate, redirectToMetrics, redirectToSettings } from "app/redirect/thunks"
-    TbMoon,
+import { useAppDispatch, useAppSelector } from "app/store"
-    TbNotes,
+import type { ViewMode } from "app/types"
-    TbPower,
+import { setViewMode } from "app/user/slice"
-    TbSettings,
+import { reloadProfile } from "app/user/thunks"
-    TbSun,
+import dayjs from "dayjs"
-    TbUsers,
+import { useNow } from "hooks/useNow"
-    TbWorldDownload,
+import { type ReactNode, useState } from "react"
-} from "react-icons/tb"
+import {
-import { useViewMode } from "../../hooks/useViewMode"
+    TbChartLine,
-
+    TbHeartFilled,
-interface ProfileMenuProps {
+    TbHelp,
-    control: React.ReactElement
+    TbLayoutList,
-}
+    TbList,
-
+    TbListDetails,
-interface ViewModeControlItem extends SegmentedControlItem {
+    TbMoon,
-    value: ViewMode
+    TbNotes,
-}
+    TbPower,
-
+    TbSettings,
-const iconSize = 16
+    TbSun,
-
+    TbSunMoon,
-const viewModeData: ViewModeControlItem[] = [
+    TbUsers,
-    {
+    TbWorldDownload,
-        value: "title",
+} from "react-icons/tb"
-        label: (
+
-            <Group>
+interface ProfileMenuProps {
-                <TbList size={iconSize} />
+    control: React.ReactElement
-                <Box ml={6}>
+}
-                    <Trans>Compact</Trans>
+
-                </Box>
+const ProfileMenuControlItem = ({ icon, label }: { icon: ReactNode; label: ReactNode }) => {
-            </Group>
+    return (
-        ),
+        <Group>
-    },
+            {icon}
-    {
+            <Box ml={6}>{label}</Box>
-        value: "cozy",
+        </Group>
-        label: (
+    )
-            <Group>
+}
-                <TbLayoutList size={iconSize} />
+
-                <Box ml={6}>
+const iconSize = 16
-                    <Trans>Cozy</Trans>
+
-                </Box>
+interface ColorSchemeControlItem extends SegmentedControlItem {
-            </Group>
+    value: MantineColorScheme
-        ),
+}
-    },
+
-    {
+const colorSchemeData: ColorSchemeControlItem[] = [
-        value: "detailed",
+    {
-        label: (
+        value: "light",
-            <Group>
+        label: <ProfileMenuControlItem icon={<TbSun size={iconSize} />} label={<Trans>Light</Trans>} />,
-                <TbListDetails size={iconSize} />
+    },
-                <Box ml={6}>
+    {
-                    <Trans>Detailed</Trans>
+        value: "dark",
-                </Box>
+        label: <ProfileMenuControlItem icon={<TbMoon size={iconSize} />} label={<Trans>Dark</Trans>} />,
-            </Group>
+    },
-        ),
+    {
-    },
+        value: "auto",
-    {
+        label: <ProfileMenuControlItem icon={<TbSunMoon size={iconSize} />} label={<Trans>System</Trans>} />,
-        value: "expanded",
+    },
-        label: (
+]
-            <Group>
+
-                <TbNotes size={iconSize} />
+interface ViewModeControlItem extends SegmentedControlItem {
-                <Box ml={6}>
+    value: ViewMode
-                    <Trans>Expanded</Trans>
+}
-                </Box>
+
-            </Group>
+const viewModeData: ViewModeControlItem[] = [
-        ),
+    {
-    },
+        value: "title",
-]
+        label: <ProfileMenuControlItem icon={<TbList size={iconSize} />} label={<Trans>Compact</Trans>} />,
-
+    },
-export function ProfileMenu(props: ProfileMenuProps) {
+    {
-    const [opened, setOpened] = useState(false)
+        value: "cozy",
-    const { viewMode, setViewMode } = useViewMode()
+        label: <ProfileMenuControlItem icon={<TbLayoutList size={iconSize} />} label={<Trans>Cozy</Trans>} />,
-    const profile = useAppSelector(state => state.user.profile)
+    },
-    const admin = useAppSelector(state => state.user.profile?.admin)
+    {
-    const dispatch = useAppDispatch()
+        value: "detailed",
-    const { colorScheme, toggleColorScheme } = useMantineColorScheme()
+        label: <ProfileMenuControlItem icon={<TbListDetails size={iconSize} />} label={<Trans>Detailed</Trans>} />,
-    const dark = colorScheme === "dark"
+    },
-
+    {
-    const logout = () => {
+        value: "expanded",
-        window.location.href = "logout"
+        label: <ProfileMenuControlItem icon={<TbNotes size={iconSize} />} label={<Trans>Expanded</Trans>} />,
-    }
+    },
-
+]
-    return (
+
-        <Menu position="bottom-end" closeOnItemClick={false} opened={opened} onChange={setOpened}>
+export function ProfileMenu(props: ProfileMenuProps) {
-            <Menu.Target>{props.control}</Menu.Target>
+    const [opened, setOpened] = useState(false)
-            <Menu.Dropdown>
+    const now = useNow()
-                {profile && <Menu.Label>{profile.name}</Menu.Label>}
+    const profile = useAppSelector(state => state.user.profile)
-                <Menu.Item
+    const admin = useAppSelector(state => state.user.profile?.admin)
-                    icon={<TbSettings size={iconSize} />}
+    const viewMode = useAppSelector(state => state.user.localSettings.viewMode)
-                    onClick={() => {
+    const forceRefreshCooldownDuration = useAppSelector(state => state.server.serverInfos?.forceRefreshCooldownDuration)
-                        dispatch(redirectToSettings())
+    const dispatch = useAppDispatch()
-                        setOpened(false)
+    const { colorScheme, setColorScheme } = useMantineColorScheme()
-                    }}
+
-                >
+    const nextAvailableForceRefresh = profile?.lastForceRefresh
-                    <Trans>Settings</Trans>
+        ? profile.lastForceRefresh + (forceRefreshCooldownDuration ?? 0)
-                </Menu.Item>
+        : now.getTime()
-                <Menu.Item
+    const forceRefreshEnabled = nextAvailableForceRefresh <= now.getTime()
-                    icon={<TbWorldDownload size={iconSize} />}
+
-                    onClick={() =>
+    const logout = () => {
-                        client.feed.refreshAll().then(() => {
+        window.location.href = "logout"
-                            showNotification({
+    }
-                                message: t`Your feeds have been queued for refresh.`,
+
-                                color: "green",
+    return (
-                                autoClose: 1000,
+        <Menu position="bottom-end" closeOnItemClick={false} opened={opened} onChange={setOpened}>
-                            })
+            <Menu.Target>{props.control}</Menu.Target>
-                            setOpened(false)
+            <Menu.Dropdown>
-                        })
+                {profile && <Menu.Label>{profile.name}</Menu.Label>}
-                    }
+                <Menu.Item
-                >
+                    leftSection={<TbSettings size={iconSize} />}
-                    <Trans>Fetch all my feeds now</Trans>
+                    onClick={() => {
-                </Menu.Item>
+                        dispatch(redirectToSettings())
-
+                        setOpened(false)
-                <Divider />
+                    }}
-                <Menu.Label>
+                >
-                    <Trans>Theme</Trans>
+                    <Trans>Settings</Trans>
-                </Menu.Label>
+                </Menu.Item>
-                <Menu.Item icon={dark ? <TbSun size={iconSize} /> : <TbMoon size={iconSize} />} onClick={() => toggleColorScheme()}>
+                <Menu.Item
-                    {dark ? <Trans>Switch to light theme</Trans> : <Trans>Switch to dark theme</Trans>}
+                    leftSection={<TbWorldDownload size={iconSize} />}
-                </Menu.Item>
+                    disabled={!forceRefreshEnabled}
-
+                    onClick={async () => {
-                <Divider />
+                        setOpened(false)
-                <Menu.Label>
+
-                    <Trans>Display</Trans>
+                        try {
-                </Menu.Label>
+                            await client.feed.refreshAll()
-                <SegmentedControl
+
-                    fullWidth
+                            // reload profile to update last force refresh timestamp
-                    orientation="vertical"
+                            await dispatch(reloadProfile())
-                    data={viewModeData}
+
-                    value={viewMode}
+                            showNotification({
-                    onChange={e => setViewMode(e as ViewMode)}
+                                message: <Trans>Your feeds have been queued for refresh.</Trans>,
-                    mb="xs"
+                                color: "green",
-                />
+                                autoClose: 1000,
-
+                            })
-                {admin && (
+                        } catch (error) {
-                    <>
+                            showNotification({
-                        <Divider />
+                                message: <Trans>Force fetching feeds is not yet available.</Trans>,
-                        <Menu.Label>
+                                color: "red",
-                            <Trans>Admin</Trans>
+                                autoClose: 2000,
-                        </Menu.Label>
+                            })
-                        <Menu.Item
+                        }
-                            icon={<TbUsers size={iconSize} />}
+                    }}
-                            onClick={() => {
+                >
-                                dispatch(redirectToAdminUsers())
+                    <Trans>Fetch all my feeds now</Trans>
-                                setOpened(false)
+                    {!forceRefreshEnabled && <span> ({dayjs.duration(nextAvailableForceRefresh - now.getTime()).format("HH:mm:ss")})</span>}
-                            }}
+                </Menu.Item>
-                        >
+
-                            <Trans>Manage users</Trans>
+                <Divider />
-                        </Menu.Item>
+
-                        <Menu.Item
+                <Menu.Label>
-                            icon={<TbChartLine size={iconSize} />}
+                    <Trans>Theme</Trans>
-                            onClick={() => {
+                </Menu.Label>
-                                dispatch(redirectToMetrics())
+                <SegmentedControl
-                                setOpened(false)
+                    fullWidth
-                            }}
+                    orientation="vertical"
-                        >
+                    data={colorSchemeData}
-                            <Trans>Metrics</Trans>
+                    value={colorScheme}
-                        </Menu.Item>
+                    onChange={e => setColorScheme(e as MantineColorScheme)}
-                    </>
+                    mb="xs"
-                )}
+                />
-
+
-                <Divider />
+                <Divider />
-                <Menu.Item
+
-                    icon={<TbHelp size={iconSize} />}
+                <Menu.Label>
-                    onClick={() => {
+                    <Trans>Display</Trans>
-                        dispatch(redirectToAbout())
+                </Menu.Label>
-                        setOpened(false)
+                <SegmentedControl
-                    }}
+                    fullWidth
-                >
+                    orientation="vertical"
-                    <Trans>About</Trans>
+                    data={viewModeData}
-                </Menu.Item>
+                    value={viewMode}
-                <Menu.Item icon={<TbPower size={iconSize} />} onClick={logout}>
+                    onChange={e => dispatch(setViewMode(e as ViewMode))}
-                    <Trans>Logout</Trans>
+                    mb="xs"
-                </Menu.Item>
+                />
-            </Menu.Dropdown>
+
-        </Menu>
+                {admin && (
-    )
+                    <>
-}
+                        <Divider />
+                        <Menu.Label>
+                            <Trans>Admin</Trans>
+                        </Menu.Label>
+                        <Menu.Item
+                            leftSection={<TbUsers size={iconSize} />}
+                            onClick={() => {
+                                dispatch(redirectToAdminUsers())
+                                setOpened(false)
+                            }}
+                        >
+                            <Trans>Manage users</Trans>
+                        </Menu.Item>
+                        <Menu.Item
+                            leftSection={<TbChartLine size={iconSize} />}
+                            onClick={() => {
+                                dispatch(redirectToMetrics())
+                                setOpened(false)
+                            }}
+                        >
+                            <Trans>Metrics</Trans>
+                        </Menu.Item>
+                    </>
+                )}
+
+                <Divider />
+
+                <Menu.Item
+                    leftSection={<TbHeartFilled size={iconSize} color="red" />}
+                    onClick={() => {
+                        dispatch(redirectToDonate())
+                        setOpened(false)
+                    }}
+                >
+                    <Trans>Donate</Trans>
+                </Menu.Item>
+
+                <Menu.Item
+                    leftSection={<TbHelp size={iconSize} />}
+                    onClick={() => {
+                        dispatch(redirectToAbout())
+                        setOpened(false)
+                    }}
+                >
+                    <Trans>About</Trans>
+                </Menu.Item>
+                <Menu.Item leftSection={<TbPower size={iconSize} />} onClick={logout}>
+                    <Trans>Logout</Trans>
+                </Menu.Item>
+            </Menu.Dropdown>
+        </Menu>
+    )
+}

commafeed-client/src/components/metrics/Gauge.tsx

@@ -1,9 +1,10 @@
-import { MetricGauge } from "app/types"
+import { NumberFormatter } from "@mantine/core"
-
+import type { MetricGauge } from "app/types"
-interface MeterProps {
+
-    gauge: MetricGauge
+interface MeterProps {
-}
+    gauge: MetricGauge
-
+}
-export function Gauge(props: MeterProps) {
+
-    return <span>{props.gauge.value}</span>
+export function Gauge(props: MeterProps) {
-}
+    return <NumberFormatter value={props.gauge.value} thousandSeparator />
+}

commafeed-client/src/components/metrics/Meter.tsx

@@ -1,19 +1,19 @@
-import { Box } from "@mantine/core"
+import { Box } from "@mantine/core"
-import { MetricMeter } from "app/types"
+import type { MetricMeter } from "app/types"
-
+
-interface MeterProps {
+interface MeterProps {
-    meter: MetricMeter
+    meter: MetricMeter
-}
+}
-
+
-export function Meter(props: MeterProps) {
+export function Meter(props: MeterProps) {
-    return (
+    return (
-        <Box>
+        <Box>
-            <Box>Mean: {props.meter.mean_rate.toFixed(2)}</Box>
+            <Box>Mean: {props.meter.mean_rate.toFixed(2)}</Box>
-            <Box>Last minute: {props.meter.m1_rate.toFixed(2)}</Box>
+            <Box>Last minute: {props.meter.m1_rate.toFixed(2)}</Box>
-            <Box>Last 5 minutes: {props.meter.m5_rate.toFixed(2)}</Box>
+            <Box>Last 5 minutes: {props.meter.m5_rate.toFixed(2)}</Box>
-            <Box>Last 15 minutes: {props.meter.m15_rate.toFixed(2)}</Box>
+            <Box>Last 15 minutes: {props.meter.m15_rate.toFixed(2)}</Box>
-            <Box>Units: {props.meter.units}</Box>
+            <Box>Units: {props.meter.units}</Box>
-            <Box>Total: {props.meter.count}</Box>
+            <Box>Total: {props.meter.count}</Box>
-        </Box>
+        </Box>
-    )
+    )
-}
+}

commafeed-client/src/components/metrics/MetricAccordionItem.tsx

@@ -1,22 +1,22 @@
-import { Accordion, Box, Group } from "@mantine/core"
+import { Accordion, Box, Group } from "@mantine/core"
-
+
-interface MetricAccordionItemProps {
+interface MetricAccordionItemProps {
-    metricKey: string
+    metricKey: string
-    name: string
+    name: string
-    headerValue: number
+    headerValue: number
-    children: React.ReactNode
+    children: React.ReactNode
-}
+}
-
+
-export function MetricAccordionItem({ metricKey, name, headerValue, children }: MetricAccordionItemProps) {
+export function MetricAccordionItem({ metricKey, name, headerValue, children }: MetricAccordionItemProps) {
-    return (
+    return (
-        <Accordion.Item value={metricKey} key={metricKey}>
+        <Accordion.Item value={metricKey} key={metricKey}>
-            <Accordion.Control>
+            <Accordion.Control>
-                <Group position="apart">
+                <Group justify="space-between">
-                    <Box>{name}</Box>
+                    <Box>{name}</Box>
-                    <Box>{headerValue}</Box>
+                    <Box>{headerValue}</Box>
-                </Group>
+                </Group>
-            </Accordion.Control>
+            </Accordion.Control>
-            <Accordion.Panel>{children}</Accordion.Panel>
+            <Accordion.Panel>{children}</Accordion.Panel>
-        </Accordion.Item>
+        </Accordion.Item>
-    )
+    )
-}
+}