Update CHANGELOG.md, README.md and THEME.md

Author: Exidex

CHANGELOG.md

@@ -8,6 +8,99 @@ and this project doesn't adhere to Semantic Versioning, see [Versioning](./READM
 For changes in `@project-gauntlet/tools` see [separate CHANGELOG.md](https://github.com/project-gauntlet/tools/blob/main/CHANGELOG.md)
 
 ## [Unreleased]
+### General
+- Main view now has action bar and action panel 
+  - Action bar displays current primary action depending on focused result item
+  - <kbd>ALT</kbd> + <kbd>K</kbd> (<kbd>OPT</kbd> + <kbd>K</kbd> on macOS) is available to open action panel
+  - Content of action panel can be defined by plugins
+    - `"inline-view"` and `"command-generator"` entrypoint types can now specify custom actions on main view
+    - Plugin can also provide shortcut that will be available depending on focused result item without opening the action panel 
+- Primary and secondary actions
+  - First action in action panel is now considered primary and can be run using <kbd>ENTER</kbd> without opening action panel
+  - Second action in action panel is now considered secondary and can be run using <kbd>SHIFT</kbd> + <kbd>ENTER</kbd> without opening action panel
+  - Works for all places that can define actions: `"inline-view"`, `"command-generator"` and `"view"` entrypoint types
+- Action panel now supports keyboard navigation
+- All bundled plugins are merged into one
+- It is now possible to update plugin using "Check for updates" button in settings
+
+### Bundled plugin
+#### `Applications`
+- Add Flatpak application support on Linux
+- Fixed no applications being shown on macOS Sequoia (15)
+- Fixed crash on macOS if macOS version only contains two segments, e.g. `15.0` vs `15.0.1`
+- Fixed some applications not having icons on macOS
+
+#### `Calculator`
+- It is now possible to copy result of calculation using primary action and its shortcut
+  - After copying, popup is shown to indicate that the result was copied
+- Updated `numbat` dependency to [1.14.0](https://github.com/sharkdp/numbat/releases/tag/v1.14.0)
+  - Notable change: "Add lowercase aliases for currency units"
+
+### Plugin API
+- Plugin permissions reworked
+  - **BREAKING CHANGE**: Plugin manifest property `permissions.ffi` removed
+    - FFI in Deno is an unstable feature
+    - May be brought back in future
+  - **BREAKING CHANGE**: Plugin manifest property `permissions.high_resolution_time` removed
+    - This is done in preparation for Deno update, newer versions of which removed this permission
+  - **BREAKING CHANGE**: Plugin manifest property `permissions.fs_read_access` renamed to `permissions.filesystem.read`
+  - **BREAKING CHANGE**: Plugin manifest property `permissions.fs_write_access` renamed to `permissions.filesystem.write`
+  - **BREAKING CHANGE**: Plugin manifest property `permissions.run_subprocess` has been split into 2 properties: `permissions.exec.command` and `permissions.exec.executable`
+    - `command` is for commands on `PATH`, e.g. `"ls"`
+    - `executable` is for absolute paths to binary, e.g. `"/usr/bin/ls"`
+  - **BREAKING CHANGE**: Windows-style paths are not allowed in plugins that do not support Windows
+  - **BREAKING CHANGE**: Unix-style paths are not allowed in plugins that do not support Linux or macOS
+  - **BREAKING CHANGE**: Plugin manifest property `permissions.network` now can only contain domain and optionally port of URL
+  - **BREAKING CHANGE**: Path permissions (`permissions.filesystem.read`, `permissions.filesystem.write` and `permissions.exec.executable`) now can only contain absolute paths
+  - Path permissions (`permissions.filesystem.read`, `permissions.filesystem.write` and `permissions.exec.executable`) can now contain variables which will be replaced at plugin load time
+    - Examples: `{linux:user-home}/.local/share`, `{common:plugin-cache}/my-plugin-cache`
+    - Variables can only be used at the beginning of the path
+    - List of currently available variables
+      - `{macos:user-home}`
+        - Resolves to `$HOME`, i.e. `/Users/<username>`
+        - Only available if plugin supports macOS
+      - `{linux:user-home}`
+        - Resolves to `$HOME`, i.e. `/home/<username>`
+        - Only available if plugin supports Linux
+      - `{windows:user-home}`
+        - Resolves to `{FOLDERID_Profile}`, i.e. `C:\Users\<username>`
+        - Only available if plugin supports Windows
+      - `{common:plugin-data}`
+        - On Windows: `{FOLDERID_RoamingAppData}\Gauntlet\data\plugins\<plugin-uuid>`
+        - On Linux: `$XDG_DATA_HOME/gauntlet/plugins/<plugin-uuid>`
+        - On macOS: `$HOME/Library/Application Support/dev.project-gauntlet.gauntlet/plugins/<plugin-uuid>`
+      - `{common:plugin-cache}`
+        - On Windows:  `{FOLDERID_LocalAppData}\Gauntlet\cache\plugins\<plugin-uuid>`
+        - On Linux:  `$XDG_CACHE_HOME/gauntlet/plugins/<plugin-uuid>`
+        - On macOS:  `$HOME/Library/Application Support/dev.project-gauntlet.gauntlet/plugins/<plugin-uuid>`
+- `<Grid.Item/>`'s `title` property is now optional
+- `<Grid.Item/>` have a new `accessory` property, which provides an ability to specify text and/or icon under the grid cell
+- `<List.Item/>` have a new `accessories` property, which provides an ability to specify one or multiple text and/or icon items on the right side of list item
+- **BREAKING CHANGE**: `<Action>`'s `title` property renamed to `label`
+- Added `entrypoint.icon` plugin manifest property that accepts path to image inside plugin's `assets` directory
+- Added `showHud` function that will create a simple popup window with text provided to that function 
+
+### Theming API
+- **BREAKING CHANGE**: Current color theme version increased to `3`
+- **BREAKING CHANGE**: Current everything theme version increased to `3`
+
+### UI/UX Improvements
+- Grid styling refined
+- Inline view styling refined
+- Plugin and entrypoint names of rendered inline view are now shown above that inline view
+- Made color of text slightly more bright 
+- Focused (by keyboard navigation) and hovered (by hovering with mouse) search items now have distinct styling
+- Slightly increased size of icons in main search view
+- Plugin ID is now shown in sidebar in settings when plugin is selected
+- "Remove plugin" button has been moved to the bottom of the sidebar in settings
+- In settings required preferences that do not have value provided or do not have default value are now highlighted  
+- Names of keys of shortcuts were changed from all upper-case to first letter only upper-case 
+
+### Fixes
+- Fixed panic when trying to stop already stopped plugin
+- Fixed crash on macOS if `openssl@v3` library is not installed
+- Fixed inline view still being shown after main view was closed and reopened
+- Fixed download info panel in settings sometimes going outside of window size and being cut off
 
 ## [9] - 2024-09-15
 
@@ -49,7 +142,7 @@ For changes in `@project-gauntlet/tools` see [separate CHANGELOG.md](https://git
   - Refined styling to accommodate this change
   - **BREAKING CHANGE**: Current color theme version increased to `2` 
   - **BREAKING CHANGE**: Current everything theme version increased to `2` 
-  
+
 ### `Applications` plugin
 - Add macOS System settings items like Sound, Network, etc
   - Both pre- and post-Ventura macOS settings are supported

README.md

@@ -23,14 +23,16 @@ https://github.com/user-attachments/assets/19964ed6-9cd9-48d4-9835-6be04de14b66
         - Dynamically provide list of one-shot commands
         - Render quick "inline" content directly under main search bar based on value in it
         - Get content from and add to Clipboard
-    - Currently, 3 bundled plugins are provided
-        - Applications: provides list of applications
-        - Calculator: shows result of mathematical operations directly under main search bar
-          - Powered by [Numbat](https://github.com/sharkdp/numbat)
-        - Settings: open Gauntlet Settings from Gauntlet itself
     - Plugins are distributed as separate branch in Git repository, meaning plugin distribution doesn't need any central
       server
     - Plugins IDs are just Git Repository URLs
+- Built-in functionality is provided by bundled plugin
+  - Applications: shows applications installed on the system in search results
+  - Calculator: shows result of mathematical operations directly under main search bar
+    - Includes converting currency using exchange rates
+    - Powered by [Numbat](https://github.com/sharkdp/numbat)
+  - Settings: open Gauntlet Settings
+  - More to come, see [#15](https://github.com/project-gauntlet/gauntlet/issues/15)
 - [React](https://github.com/facebook/react)-based UI for plugins
     - Implemented using custom React Reconciler (no Electron)
     - [iced-rs](https://github.com/iced-rs/iced) is used for UI
@@ -41,12 +43,13 @@ https://github.com/user-attachments/assets/19964ed6-9cd9-48d4-9835-6be04de14b66
 - Frecency-based search result ordering
    - Frecency is a combination of frequency and recency
    - More often the item is used the higher in the result list it will be, but items used a lot in the past will be ranked lower than items used the same amount of times recently
+   - Currently, there is no fuzzy matching. Results are matched per word by substring  
 - Designed with cross-platform in mind
     - Permissions
         - By default, plugins do not have access to host system
-        - If plugin asked for access to filesystem, env variables, FFI or running commands, it is required to specify
+        - If plugin asked for access to filesystem, env variables or running commands, it is required to specify
           which operating systems it supports.
-        - If plugin doesn't use filesystem, env variables, ffi or running commands and just uses network and/or UI, it
+        - If plugin doesn't use filesystem, env variables or running commands and just uses network and/or UI, it
           is cross-platform
     - Shortcuts
         - Plugins are allowed to use only limited set of keys for shortcuts to support widest possible range of keyboards 
@@ -67,30 +70,25 @@ https://github.com/user-attachments/assets/19964ed6-9cd9-48d4-9835-6be04de14b66
    - Both X11 and Wayland (via LayerShell protocol) are supported
 - <img src="https://cdn.jsdelivr.net/gh/simple-icons/simple-icons@develop/icons/apple.svg" width="18" height="18" /> macOS
 - <img src="https://img.icons8.com/windows/32/windows-11.png" width="18" height="18" /> Windows
-    - built-in "Applications" plugin is not yet implemented. See [#9](https://github.com/project-gauntlet/gauntlet/issues/9)
+    - Bundled "Applications" plugin is not yet implemented. See [#9](https://github.com/project-gauntlet/gauntlet/issues/9)
 
-##### UI
+##### Planned features
 
-###### Implemented
+- See [#13](https://github.com/project-gauntlet/gauntlet/issues/13)
+- See [#15](https://github.com/project-gauntlet/gauntlet/issues/15)
+- See [#16](https://github.com/project-gauntlet/gauntlet/issues/16)
 
-- Detail
-- Form
-- Action Panel
-- List
-- Grid
-- Inline
-  - View directly under main search bar
-  - Requires separate permission to be explicitly specified in manifest because it reads everything user enters in main search bar
-- Settings window
-- Action Shortcuts
-- Theming
-
-###### Planned
-
-See [#13](https://github.com/project-gauntlet/gauntlet/issues/13)
-
-##### APIs
+##### Plugin APIs
 
+- UI
+  - Detail
+  - Form
+  - Action Panel
+  - List
+  - Grid
+  - Inline
+      - View directly under main search bar
+      - Requires separate permission to be explicitly specified in manifest because it reads everything user enters in main search bar
 - Stack-based Navigation
 - Assets
   - Files placed into `assets` directory in root of plugin repository are accessible at plugin runtime using `assetData` function 
@@ -99,6 +97,9 @@ See [#13](https://github.com/project-gauntlet/gauntlet/issues/13)
 - Clipboard
   - Accessible via `Clipboard` api
   - Requires separate permission to be explicitly specified in manifest
+- HUD
+  - Shows small popup window with feedback information
+  - Accessible via `showHud` function
 - React Helper Hooks
     - `usePromise`
         - Helper to run promises in a context of React view
@@ -120,10 +121,6 @@ See [#13](https://github.com/project-gauntlet/gauntlet/issues/13)
         - Follows `stale-while-revalidate` caching strategy
         - Uses `useCachedPromise` Hook internally
 
-###### Planned
-
-See [#13](https://github.com/project-gauntlet/gauntlet/issues/13)
-
 ## Getting Started
 
 ### Create your own plugin
@@ -260,15 +257,33 @@ path = 'src/inline-view.tsx'
 type = 'inline-view'
 description = 'Some entrypoint description' # required
 
-[permissions] # For allowed values see: https://docs.deno.com/runtime/manual/basics/permissions
-environment = ["ENV_VAR_NAME"] # array of strings, if specified requires supported_system to be specified as well
-high_resolution_time = false # boolean
-network = ["github.com"] # array of strings
-ffi = ["path/to/dynamic/lib"] # array of strings, if specified requires supported_system to be specified as well
-fs_read_access = ["path/to/something"] # array of strings, if specified requires supported_system to be specified as well
-fs_write_access = ["path/to/something"] # array of strings, if specified requires supported_system to be specified as well
-run_subprocess = ["program"] # array of strings, if specified requires supported_system to be specified as well
-system = ["apiName"] # array of strings, if specified requires supported_system to be specified as well
+[permissions]
+network = ["github.com", "example.com:8833"]
+clipboard = ["read", "write", "clear"]
+main_search_bar = ["read"]
+
+# if specified requires supported_system to be specified as well
+environment = ["ENV_VAR_NAME"] 
+
+# if specified requires supported_system to be specified as well
+system = ["apiName"]
+
+# if specified requires supported_system to be specified as well
+[permissions.filesystem]
+read = [
+    "C:\\ProgramFiles\\test",
+    "C:/ProgramFiles/test",
+    "{windows:user-home}\\test",
+    "{windows:user-home}/test",
+    "{linux:user-home}/test",
+    "/etc/test"
+]
+write = ["/home/exidex/.test"]
+
+# if specified requires supported_system to be specified as well
+[permissions.exec]
+command = ["ls"]
+executable = ["/usr/bin/ls"]
 
 [[supported_system]]
 os = 'linux' # 'linux', 'windows' or 'macos'
@@ -319,7 +334,7 @@ Server is an application that exposes gRPC server.
 All plugins run on server.
 Each plugin in its own sandboxed Deno Worker.
 In plugin manifest it is possible to configure permissions which will allow plugin to have access to filesystem,
-network, environment variables, ffi or subprocess execution.
+network, environment variables or subprocess execution.
 Server saves plugins themselves and state of plugins into SQLite database.
 
 Frontend is GUI module that uses [iced-rs](https://github.com/iced-rs/iced) as a GUI framework. It is run in the same process as a server.
@@ -346,13 +361,6 @@ Plugins (or rather its compiled state: manifest, js code and assets) are distrib
 Which means there is no one central place required for plugin distribution.
 And to install plugin all you need is Git repository url.
 
-Application defines set of React components to use for plugins.
-Creating and validating components involves some boilerplate.
-Component model was created for help manage is.
-It is essentially a json file which defines what components exist, what properties and event handler they have.
-This file is then used
-to generate TypeScript typings for `@project-gauntlet/api` and Rust validation code for server and frontend.
-
 ## Application packaging for Linux
 
 This section contains a list of things

docs/THEME.md

@@ -13,8 +13,8 @@ theme will stop working until it is updated.
 This may change in the future
 
 Current theme version:
-- Color: `2`
-- Everything: `2`
+- Color: `3`
+- Everything: `3`
 
 Theming is only applied to main window and doesn't affect settings