Merge branch 'develop' into arthur/ui/dialog

.github/workflows/main.yml

@@ -85,6 +85,12 @@ jobs:
  - run: node --version && npm --version
  - run: npm --global install npm@^9
  - run: npm --version
+ - run: python --version || echo ok
+ - run: python3 --version || echo ok
+ - run: pip --version || echo ok
+ # PYTHON 3.12 distutils deprecation remediation:
+ #- run: python3 -m pip install packaging || python -m pip install packaging
+ - run: python3 -m pip install setuptools || python -m pip install setuptools
  # - run: npm --global install asar
  - name: package patch 1
  run: node scripts/package-ci-patch.js package.json ${{ github.run_id }} && cat package.json | grep -i VERSION && cat package.json
@@ -100,6 +106,8 @@ jobs:
  - run: npm cache verify
  - run: cat package-lock.json | grep -i divina-player-js
  - run: npm ci
+ - run: npm list -g node-gyp || echo ok
+ - run: npm list node-gyp || echo ok
  - name: PR action (just build)
  if: ${{ github.event_name == 'pull_request' }}
  run: npm run build:prod

README.md

@@ -93,3 +93,128 @@ Options:
  --version Show version number [boolean]
  --help Show help [boolean]
 ```
+
+## [DEV] Architecture
+
+Thorium-reader is composed of 3 parts:
+- One node.js main process (electron back-end)
+- One library window (chromium renderer)
+- One to N reader window(s) (chromium renderer)
+
+Each part runs a model-controller and a view for the renderer process.
+
+- the model is a state container with [Redux](https://redux.js.org/). It's based on [flux architecture](https://github.com/facebookarchive/flux)
+- the controller is a middleware from Redux named [Redux-saga](https://redux-saga.js.org/). It handles all side effects and application behaviour.
+- the view for the rendering is React with [class components](https://legacy.reactjs.org/docs/components-and-props.html)
+
+To link these 3 parts we use:
+- IPC/RPC: we use an implementation from [Electron](https://www.electronjs.org/docs/latest/api/ipc-main)
+- React/Redux: We use [connect](https://react-redux.js.org/api/connect) from [react-redux](https://react-redux.js.org/).
+
+### Diagram
+
+#### [Model View Controller Architecture](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller)
+![MVC](img/thorium-mvc.png)
+
+![architecture diagram](img/thorium-architecture.png)
+
+
+### API Concept
+
+To have a POST request from a renderer process to the main process, we use the notion of API.
+It's not an http API but an RPC encapsuled one, to redux/redux-saga logic with Action and Reducer.
+
+Here is a diagram of the communication:
+
+![api](img/thorium-api.png)
+
+Src:
+- src/main/redux/sagas/api/api.ts
+- src/common/redux/actions/api/index.ts
+- src/renderer/common/redux/reducers/api.ts
+
+At the moment there are 17 API endpoints from (src/main/redux/sagas/api):
+
+library:
+- apiapp:
+ - apiapp/search : search a library from apiapp protocol
+- browser:
+ - httpbrowser/browse : browse and parse an opds URL
+- opds:
+ - opds/getFeed : get an opdsFeed with its identifier
+ - opds/findAllFeed: get all opdsFeed saved
+ - opds/deleteFeed: delete an opdsFeed with its identifier
+ - opds/addFeed: add an opdsFeed
+ - opds/getUrlWithSearchLinks: get the search URL from an opdsFeed
+- publication: (src/common/api/interface/publicationApi.interface.ts)
+ - publication/get: get a publicationView from id
+ - publication/delete: delete a publicationView from id
+ - publication/findAll: get all publicationView
+ - publication/findByTag: get all publicationView from a specific tag string
+ - publication/updateTags: update tags list from a publication
+ - publication/importFromLink: import a publication from an URL
+ - publication/importFromFs: import a publication from a fileSystem path
+ - publication/search: search publication from a query text
+ - publication/searchEqTitrle: search publication by title matching
+ - publication/exportPublication: export publication to the fileSystem
+
+
+### ACTION-REDUCER
+
+From the main-process to the renderer-process, or from the renderer-process to the main-process.
+
+List of all Actions in place (src/common/redux/actions):
+
+- auth: opds authentication
+ - cancel
+ - done
+ - wipeData
+- catalog
+ - getCatalog: ask to rehydrate catalogView in the libraryState
+ - setCatalogView: response from getCatalog
+ - setTagView: rehydrate tagStringView in the libraryState
+- dialog: modal dialog view in library,reader
+ - closeRequest
+ - openRequest
+ - updateRequest
+- download: download queue in library
+ - abort
+ - done
+ - progress
+- history: history opds feed
+ - pushFeed
+ - refresh
+- i18n
+ - setLocale
+- import
+ - verify: import verification process
+- keyboard: keyboard shortcut
+ - reloadShortcut
+ - setShortcut
+ - showShortcut
+- lcp
+ - renewPublication
+ - returnPublication
+ - unlockPublicationWithPassphrase
+ - userKeyCheckRequest
+- load: main proceess busy or not
+ - busy
+ - iddle
+- net (not used)
+- reader
+ - attachMode
+ - clipboardCopy
+ - closeRequest
+ - closeRequestFromPublication
+ - configSetDefault
+ - detachModeRequest
+ - detachModeSuccess
+ - fullScreenRequest
+ - openRequest
+ - openError
+ - setReduxState: trigger app persistence
+- session: saved session
+ - enable
+- toast: toast notification library,reader
+ - close
+ - open