- Add OpenAI library and related dependencies to package files
- Implement chat functionality with custom OpenAI API endpoint
- Update app.ts and create new chat.ts module for AI chat interface
- Modify results template to support AI chat container
- Add new font dependencies for Inter and Vazirmatn
- Update package-lock.json with new package versions
- Implement AI message container with loading and user interaction states
- Add new SVG icons for AI, send, and stop actions
- Update CSS styles for AI chat interface in LTR and RTL layouts
- Create responsive design for message boxes and loading indicators
- Add placeholder for AI-generated answers with reference link
- Create new theme.html template for theme selection
- Update preferences page to include theme settings
- Adjust CSS padding and add save button styling
- Modify preferences template to support theme selection
- Create new utils.ts module with clipboard-related functions
- Implement copyToClipboard and getFromClipboard methods
- Add clipboard functionality to preferences page for hash copying and pasting
- Update app.ts and images.ts to use new clipboard utility functions
- Modify preferences.html template with new element IDs for clipboard interactions
- Add result count display with number of results
- Adjust header padding for preferences and search pages
- Update LTR and RTL CSS files to support new styling
- Modify SCSS files to use consistent positioning and padding
- Implement close button in image details container
- Update CSS for LTR and RTL layouts to position close button
- Add click event listener to close image details view
- Refactor TypeScript code to separate image-related functionality
- Update HTML template to include close button with icon
- Create new preferences.html template with comprehensive settings layout
- Implement SCSS styling for preferences page with grid-based design
- Add data backup and restore section with preferences hash management
- Include new database icon for data section
- Update footer and icons templates to support new preferences page
- Add settings header template for consistent search bar across pages
- Add scroll-based dynamic resizing for image details container
- Implement smooth transitions for height and position changes
- Update CSS and TypeScript to support responsive image details view
- Add ID to image details container in HTML template
- Change instance name to "Gitee" in settings
- Enable image proxy by default
- Add dark mode favicon and update favicon SVG files
- Implement dark mode color fix mixin in SCSS
- Update base template to support dark mode favicon
- Add query title option in results template
- Create hotkeys.html template with SearXNG and Vim-like hotkey options
- Add title_query.html template for toggling query display in page title
- Implement url_formatting.html template with URL display format selection
- Include descriptive labels and help text for each setting
- Move sidebar settings templates from 'settings' to 'sidebar' directory
- Add new 'info' SVG icon for tooltips
- Update CSS styles for sidebar settings layout
- Improve tooltip positioning and styling
- Add info icons to each sidebar setting with descriptive tooltips
- Create new SCSS file for tooltip styles
- Add tooltip background color variables in color definitions
- Implement hover-based tooltip with CSS pseudo-elements
- Support both light and dark color schemes
- Add tooltip styling to LTR and RTL CSS files
- Update package.json to include Inter and Vazirmatn font packages
- Add comprehensive font-face definitions for Inter font with multiple language support
- Add Vazirmatn UI font-face definitions for RTL layouts
- Update SCSS files to import and set default font families
- Include various font weights and unicode ranges for better internationalization
- Convert pixel-based measurements to rem units for better responsiveness
- Add direction support for LTR and RTL layouts
- Update package.json dependencies
- Improve category and search header translations
- Remove unused TypeScript code
- Add `dir="auto"` to base template for better text direction handling
``str.format`` is the pythonic way of handling strings returned by
gettext.gettext that retain interpolation tokens.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
For CSV and JSON output, the LegacyResult and the Result objects needs to be
converted to a python dictionary.
Closes: https://github.com/searxng/searxng/issues/4244
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
In [1] and [2] we discussed the need of a Result.results property and how we can
avoid unclear code. This patch implements a class for the reslut-lists of
engines::
searx.result_types.EngineResults
A simple example for the usage in engine development::
from searx.result_types import EngineResults
...
def response(resp) -> EngineResults:
res = EngineResults()
...
res.add( res.types.Answer(answer="lorem ipsum ..", url="https://example.org") )
...
return res
[1] https://github.com/searxng/searxng/pull/4183#pullrequestreview-257400034
[2] https://github.com/searxng/searxng/pull/4183#issuecomment-2614301580
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Typification of SearXNG
=======================
This patch introduces the typing of the results. The why and how is described
in the documentation, please generate the documentation ..
$ make docs.clean docs.live
and read the following articles in the "Developer documentation":
- result types --> http://0.0.0.0:8000/dev/result_types/index.html
The result types are available from the `searx.result_types` module. The
following have been implemented so far:
- base result type: `searx.result_type.Result`
--> http://0.0.0.0:8000/dev/result_types/base_result.html
- answer results
--> http://0.0.0.0:8000/dev/result_types/answer.html
including the type for translations (inspired by #3925). For all other
types (which still need to be set up in subsequent PRs), template documentation
has been created for the transition period.
Doc of the fields used in Templates
===================================
The template documentation is the basis for the typing and is the first complete
documentation of the results (needed for engine development). It is the
"working paper" (the plan) with which further typifications can be implemented
in subsequent PRs.
- https://github.com/searxng/searxng/issues/357
Answer Templates
================
With the new (sub) types for `Answer`, the templates for the answers have also
been revised, `Translation` are now displayed with collapsible entries (inspired
by #3925).
!en-de dog
Plugins & Answerer
==================
The implementation for `Plugin` and `Answer` has been revised, see
documentation:
- Plugin: http://0.0.0.0:8000/dev/plugins/index.html
- Answerer: http://0.0.0.0:8000/dev/answerers/index.html
With `AnswerStorage` and `AnswerStorage` to manage those items (in follow up
PRs, `ArticleStorage`, `InfoStorage` and .. will be implemented)
Autocomplete
============
The autocompletion had a bug where the results from `Answer` had not been shown
in the past. To test activate autocompletion and try search terms for which we
have answerers
- statistics: type `min 1 2 3` .. in the completion list you should find an
entry like `[de] min(1, 2, 3) = 1`
- random: type `random uuid` .. in the completion list, the first item is a
random UUID
Extended Types
==============
SearXNG extends e.g. the request and response types of flask and httpx, a module
has been set up for type extensions:
- Extended Types
--> http://0.0.0.0:8000/dev/extended_types.html
Unit-Tests
==========
The unit tests have been completely revised. In the previous implementation,
the runtime (the global variables such as `searx.settings`) was not initialized
before each test, so the runtime environment with which a test ran was always
determined by the tests that ran before it. This was also the reason why we
sometimes had to observe non-deterministic errors in the tests in the past:
- https://github.com/searxng/searxng/issues/2988 is one example for the Runtime
issues, with non-deterministic behavior ..
- https://github.com/searxng/searxng/pull/3650
- https://github.com/searxng/searxng/pull/3654
- https://github.com/searxng/searxng/pull/3642#issuecomment-2226884469
- https://github.com/searxng/searxng/pull/3746#issuecomment-2300965005
Why msgspec.Struct
==================
We have already discussed typing based on e.g. `TypeDict` or `dataclass` in the past:
- https://github.com/searxng/searxng/pull/1562/files
- https://gist.github.com/dalf/972eb05e7a9bee161487132a7de244d2
- https://github.com/searxng/searxng/pull/1412/files
- https://github.com/searxng/searxng/pull/1356
In my opinion, TypeDict is unsuitable because the objects are still dictionaries
and not instances of classes / the `dataclass` are classes but ...
The `msgspec.Struct` combine the advantages of typing, runtime behaviour and
also offer the option of (fast) serializing (incl. type check) the objects.
Currently not possible but conceivable with `msgspec`: Outsourcing the engines
into separate processes, what possibilities this opens up in the future is left
to the imagination!
Internally, we have already defined that it is desirable to decouple the
development of the engines from the development of the SearXNG core / The
serialization of the `Result` objects is a prerequisite for this.
HINT: The threads listed above were the template for this PR, even though the
implementation here is based on msgspec. They should also be an inspiration for
the following PRs of typification, as the models and implementations can provide
a good direction.
Why just one commit?
====================
I tried to create several (thematically separated) commits, but gave up at some
point ... there are too many things to tackle at once / The comprehensibility of
the commits would not be improved by a thematic separation. On the contrary, we
would have to make multiple changes at the same places and the goal of a change
would be vaguely recognizable in the fog of the commits.
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
