diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000000000000000000000000000000000000..d600b6c76dd93f7b2472160d42b2797cae50c8e5 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,25 @@ +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* +pnpm-debug.log* +lerna-debug.log* + +node_modules +dist +dist-ssr +*.local + +# Editor directories and files +.vscode/* +!.vscode/extensions.json +.idea +.DS_Store +*.suo +*.ntvs* +*.njsproj +*.sln +*.sw? + diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000000000000000000000000000000000000..a78447ebf932f1bb3a5b124b472bea8b3a86f80f --- /dev/null +++ b/.editorconfig @@ -0,0 +1,7 @@ +[*] +charset = utf-8 +insert_final_newline = true +end_of_line = lf +indent_style = space +indent_size = 2 +max_line_length = 80 \ No newline at end of file diff --git a/.env.example b/.env.example new file mode 100644 index 0000000000000000000000000000000000000000..41d8a7ebb4319bbd89c16be09fb5936359e14ef4 --- /dev/null +++ b/.env.example @@ -0,0 +1,33 @@ +# A comma-separated list of access keys. Example: `ACCESS_KEYS="ABC123,JUD71F,HUWE3"`. Leave blank for unrestricted access. +ACCESS_KEYS="" + +# The timeout in hours for access key validation. Set to 0 to require validation on every page load. +ACCESS_KEY_TIMEOUT_HOURS="24" + +# The default model ID for WebLLM with F16 shaders. +WEBLLM_DEFAULT_F16_MODEL_ID="Qwen3-0.6B-q4f16_1-MLC" + +# The default model ID for WebLLM with F32 shaders. +WEBLLM_DEFAULT_F32_MODEL_ID="Qwen3-0.6B-q4f32_1-MLC" + +# The default model ID for Wllama. +WLLAMA_DEFAULT_MODEL_ID="qwen-3-0.6b" + +# The base URL for the internal OpenAI compatible API. Example: `INTERNAL_OPENAI_COMPATIBLE_API_BASE_URL="https://api.openai.com/v1"`. Leave blank to disable internal OpenAI compatible API. +INTERNAL_OPENAI_COMPATIBLE_API_BASE_URL="" + +# The access key for the internal OpenAI compatible API. +INTERNAL_OPENAI_COMPATIBLE_API_KEY="" + +# The model for the internal OpenAI compatible API. +INTERNAL_OPENAI_COMPATIBLE_API_MODEL="" + +# The name of the internal OpenAI compatible API, displayed in the UI. +INTERNAL_OPENAI_COMPATIBLE_API_NAME="Internal API" + +# The type of inference to use by default. The possible values are: +# "browser" -> In the browser (Private) +# "openai" -> Remote Server (API) +# "horde" -> AI Horde (Pre-configured) +# "internal" -> $INTERNAL_OPENAI_COMPATIBLE_API_NAME +DEFAULT_INFERENCE_TYPE="browser" diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000000000000000000000000000000000..d8b74ecb7d9fc0bb8f7e0d0b1da260ff2938a903 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,84 @@ +# Contributor Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at: + +- GitHub: [@felladrin](https://github.com/felladrin) +- Email: (private contact can be provided upon request) + +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of actions. + +**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000000000000000000000000000000000000..109ab1a04357c17ad77a4e723e81eaf42b56c8e0 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,130 @@ +# Contributing to MiniSearch + +First off, thank you for considering contributing to MiniSearch! It's people like you that make MiniSearch such a great tool. + +## How to Contribute + +### Reporting Bugs + +- Use the [GitHub issue tracker](https://github.com/felladrin/MiniSearch/issues) to report bugs +- Check if the issue has already been reported before creating a new one +- Provide clear steps to reproduce the issue +- Include your environment details (OS, browser, Docker version if applicable) +- Add screenshots if the issue is UI-related + +### Suggesting Features + +- Use the [GitHub issue tracker](https://github.com/felladrin/MiniSearch/issues) for feature suggestions +- Clearly describe the feature and why it would be useful +- Consider if it fits with the project's minimalist philosophy +- Provide examples of how you envision the feature working + +### Development Setup + +1. Fork the repository and clone it locally +2. Make sure you have [Docker](https://docs.docker.com/get-docker/) installed +3. Start the development server: + ```bash + docker compose up + ``` +4. The application will be available at http://localhost:7860 +5. Make your changes +6. Test your changes thoroughly +7. Push to your fork and create a pull request + +### Running Tests + +```bash +docker compose exec development-server npm run test +``` + +For coverage: +```bash +docker compose exec development-server npm run test:coverage +``` + +### Code Quality + +Before submitting a pull request, please run: +```bash +docker compose exec development-server npm run lint +``` + +This runs: +- Biome (formatting/linting) +- TypeScript (type checking) +- ts-prune (dead code detection) +- jscpd (copy-paste detection) +- dpdm (circular dependency detection) +- Custom architectural linter + +## Contribution Guidelines + +### Types of Contributions We're Looking For + +- **Bug fixes**: Always welcome! +- **Documentation improvements**: Better docs help everyone +- **Performance optimizations**: Especially for search and AI features +- **UI/UX improvements**: Keeping the minimalist yet intuitive design +- **New AI model integrations**: Following existing patterns +- **Security enhancements**: Following security best practices + +### Project Vision + +MiniSearch aims to be a minimalist, privacy-focused web search application with AI assistance. We prioritize: +- Privacy and security +- Simplicity and ease of use +- Cross-platform compatibility +- Efficient resource usage + +### Getting in Touch + +- For questions about contributions: Use GitHub discussions +- For security issues: See [SECURITY.md](SECURITY.md) +- For general questions: Use GitHub issues + +## Pull Request Process + +1. Fork the repository +2. Create a feature branch (`git checkout -b feature/amazing-feature`) +3. Make your changes +4. Add tests if applicable +5. Ensure all tests pass and linting succeeds +6. Commit your changes (`git commit -m 'Add some amazing feature'`) +7. Push to the branch (`git push origin feature/amazing-feature`) +8. Open a Pull Request + +### Pull Request Guidelines + +- Keep PRs focused on a single feature or fix +- Write clear commit messages +- Update documentation if needed +- Ensure your code follows the existing style +- Be responsive to feedback and reviews + +## Development Commands + +```bash +# Start development server +docker compose up + +# Run tests +docker compose exec development-server npm run test + +# Run linting +docker compose exec development-server npm run lint + +# Build for production +docker compose -f docker-compose.production.yml build + +# View test coverage +docker compose exec development-server npm run test:coverage +``` + +## Questions? + +Don't hesitate to ask questions! We're here to help you contribute successfully. + +--- + +Thanks again for your interest in contributing to MiniSearch! 🎉 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000000000000000000000000000000000..a537f6c1f52ff96ab8c44717fa72bcaa1fd05ddc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,123 @@ +--- +name: Bug report +description: Create a report to help us improve +title: "[BUG] " +labels: ["bug"] +assignees: [] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! Please provide as much detail as possible. + + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is + placeholder: What happened? What did you expect to happen? + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce + description: Please provide detailed steps to reproduce the issue + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen + validations: + required: true + + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem + placeholder: Drag and drop images here or paste them + + - type: dropdown + id: os + attributes: + label: Operating System + description: What operating system are you using? + options: + - Windows 11 + - Windows 10 + - macOS 15.x + - macOS 14.x + - macOS 13.x + - Ubuntu 22.04 + - Ubuntu 20.04 + - Other Linux + - Other + validations: + required: true + + - type: dropdown + id: browser + attributes: + label: Browser + description: What browser are you using? + options: + - Chrome + - Firefox + - Safari + - Edge + - Other + validations: + required: true + + - type: input + id: version + attributes: + label: MiniSearch version + description: What version of MiniSearch are you using? + placeholder: latest, v1.0.0, etc. + validations: + required: true + + - type: input + id: docker-version + attributes: + label: Docker version (if applicable) + description: What Docker version are you using? + placeholder: e.g., 24.0.7 + + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context about the problem here + + - type: dropdown + id: deployment-type + attributes: + label: Deployment type + description: How are you running MiniSearch? + options: + - Docker image + - Building from source + - Development server + - Other + validations: + required: true + + - type: textarea + id: custom-config + attributes: + label: Custom configuration (if applicable) + description: Any custom configuration you're using + placeholder: Environment variables, custom settings, etc. +--- diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000000000000000000000000000000000..3c7173ac945df19485fd6743ecc1d20c76e64627 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,73 @@ +--- +name: Feature request +description: Suggest an idea for this project +title: "[FEATURE] " +labels: ["enhancement"] +assignees: [] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting a new feature! Please provide as much detail as possible to help us understand your vision. + + - type: textarea + id: problem-description + attributes: + label: Is your feature request related to a problem? + description: A clear and concise description of what the problem is + placeholder: I'm always frustrated when [...] + validations: + required: true + + - type: textarea + id: solution-description + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered + + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here + + - type: dropdown + id: alignment + attributes: + label: Alignment with MiniSearch's goals + description: How does this feature align with MiniSearch's minimalist, privacy-focused philosophy? + options: + - "Strongly aligns - enhances privacy/minimalism" + - "Moderately aligns - useful but adds complexity" + - "Needs consideration - potential trade-offs" + - "Not sure - need discussion" + validations: + required: true + + - type: textarea + id: implementation-ideas + attributes: + label: Implementation ideas (optional) + description: Do you have any ideas about how this could be implemented? + placeholder: Technical thoughts, potential approaches, etc. + + - type: dropdown + id: priority + attributes: + label: Priority (your assessment) + description: How important is this feature to you? + options: + - "High - would significantly improve my experience" + - "Medium - nice to have" + - "Low - minor improvement" + validations: + required: true +--- diff --git a/.github/ISSUE_TEMPLATE/security_vulnerability.md b/.github/ISSUE_TEMPLATE/security_vulnerability.md new file mode 100644 index 0000000000000000000000000000000000000000..e464b0b43e7e8b09b78344df959e01ad3b49fa00 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/security_vulnerability.md @@ -0,0 +1,98 @@ +--- +name: Security Vulnerability +description: Report a security vulnerability (PRIVATE - will be converted to private report) +title: "[SECURITY] " +labels: ["security"] +assignees: [] +body: + - type: markdown + attributes: + value: | + # ⚠️ IMPORTANT: SECURITY VULNERABILITIES SHOULD NOT BE REPORTED PUBLICLY ⚠️ + + This template will create a public issue, but for security vulnerabilities, please use one of these private reporting methods: + + 1. **Preferred**: Use GitHub's [Private Vulnerability Reporting](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability) + 2. **Alternative**: Email the maintainer privately + + If you accidentally created a public issue, please close it and report privately instead. + + - type: checkboxes + id: confirmation + attributes: + label: Confirmation + description: Please confirm you understand the security reporting process + options: + - label: I understand this should be reported privately and will use the methods above + required: true + + - type: dropdown + id: vulnerability-type + attributes: + label: Vulnerability Type + description: What type of security vulnerability is this? + options: + - Cross-site Scripting (XSS) + - Authentication/Authorization Bypass + - Information Disclosure + - Remote Code Execution + - Denial of Service + - Configuration Issue + - Other + validations: + required: true + + - type: dropdown + id: severity + attributes: + label: Severity + description: How severe is this vulnerability? + options: + - Critical + - High + - Medium + - Low + validations: + required: true + + - type: textarea + id: description + attributes: + label: Description + description: A clear description of the security vulnerability + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: Detailed steps to reproduce the vulnerability + validations: + required: true + + - type: textarea + id: impact + attributes: + label: Impact + description: Describe the potential impact of this vulnerability + validations: + required: true + + - type: textarea + id: mitigation + attributes: + label: Mitigation (if known) + description: Any known workarounds or mitigations + + - type: textarea + id: additional-information + attributes: + label: Additional Information + description: Any additional context or information about the vulnerability + + - type: markdown + attributes: + value: | + ## 🚨 PLEASE DO NOT SUBMIT THIS PUBLICLY - USE PRIVATE REPORTING METHODS ABOVE 🚨 +--- diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000000000000000000000000000000000..ee5c4672847a3085276032800064fce726cb31b9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,44 @@ +## Description +Brief description of what this PR changes. + +## Type of Change +- [ ] Bug fix (non-breaking change that fixes an issue) +- [ ] New feature (non-breaking change that adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update +- [ ] Security fix +- [ ] Performance improvement +- [ ] Code quality improvement + +## Testing +- [ ] I have tested this change locally +- [ ] I have added tests for this change +- [ ] All existing tests pass +- [ ] I have run the linter and it passes (`npm run lint`) + +## Checklist +- [ ] My code follows the project's coding conventions +- [ ] I have reviewed my own code +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes +- [ ] Any dependent changes have been merged and published in downstream modules + +## Screenshots (if applicable) +Add screenshots to help explain your changes, especially for UI modifications. + +## Additional Context +Add any other context about the problem here. + +## Security Considerations +- [ ] This change does not introduce any security vulnerabilities +- [ ] I have considered the security implications of this change +- [ ] If this change handles user input, it has been properly sanitized/validated + +## Performance Impact +- [ ] This change does not negatively impact performance +- [ ] I have tested the performance impact of this change + +## Breaking Changes +If this PR introduces breaking changes, please describe them here and how users should migrate. diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000000000000000000000000000000000000..92f5a23f42e2f6912e119552ab3b12d2ade34103 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,135 @@ +# Security Policy + +## Supported Versions + +Only the latest version of MiniSearch receives security updates. + +| Version | Supported | +|---------|------------| +| Latest | ✅ | +| Older | ❌ | + +## Reporting a Vulnerability + +### Private Vulnerability Reporting + +We strongly encourage using GitHub's [Private Vulnerability Reporting](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability) feature to report security vulnerabilities. + +**Do not report security vulnerabilities through public issues.** + +### How to Report + +1. **Preferred**: Use GitHub's Private Vulnerability Reporting +2. **Alternative**: Email the maintainer privately at: (contact can be provided upon request) + +When reporting a vulnerability, please include: +- A clear description of the vulnerability +- Steps to reproduce the issue +- Potential impact of the vulnerability +- Any suggested mitigations (if known) + +### What to Expect + +- We will acknowledge receipt of your report within 48 hours +- We will provide a detailed response within 7 days +- We will work with you to understand and validate the report +- We will coordinate disclosure timing to minimize user risk + +## Security Scope + +### In Scope + +- Vulnerabilities in the MiniSearch web application +- Security issues in the Docker container configuration +- Authentication and authorization bypasses +- Cross-site scripting (XSS) vulnerabilities +- Information disclosure issues +- Remote code execution vulnerabilities +- Privilege escalation in the application context + +### Out of Scope + +- Issues in third-party dependencies (report to respective projects) +- Vulnerabilities in the underlying browser or Node.js runtime +- Physical attacks on infrastructure +- Social engineering attacks +- Denial of service attacks that don't indicate a vulnerability +- Issues requiring physical access to user devices + +## Threat Model + +### MiniSearch's Security Boundaries + +MiniSearch is designed as a privacy-focused search application with the following security assumptions: + +**Trust Boundaries:** +- **Browser Environment**: The application runs entirely in the user's browser +- **Server Component**: Optional backend for search and AI processing +- **AI Models**: Local or remote AI processing with configurable endpoints + +**Data Flow:** +- User queries are sent to SearXNG instances (configurable) +- AI processing can be local (WebLLM/Wllama) or remote (API endpoints) +- Search history is stored locally in the browser +- No tracking or analytics by default + +**Security Controls:** +- Optional access key protection for deployment +- Configurable AI endpoints for privacy +- Local-first data storage +- No third-party tracking or analytics + +**Potential Risks:** +- Malicious SearXNG instances could log queries +- Remote AI endpoints could access user queries +- Browser extensions could interfere with the application +- Man-in-the-middle attacks without HTTPS + +## Security Best Practices + +### For Users + +- Always use HTTPS when accessing MiniSearch instances +- Configure trusted SearXNG instances +- Use local AI models for maximum privacy +- Set access keys for deployed instances +- Keep browsers updated + +### For Deployers + +- Use the official Docker image +- Configure environment variables securely +- Set up proper access controls +- Use HTTPS in production +- Regularly update dependencies +- Monitor for security advisories + +## Security Features + +- **Access Key Protection**: Optional password-based access control +- **Configurable Endpoints**: Users control search and AI providers +- **Local Processing**: AI models can run entirely in the browser +- **No Tracking**: Built without analytics or tracking +- **HTTPS Ready**: Designed for secure deployment + +## Security Updates + +Security updates will be: +- Released as new versions +- Announced in release notes +- Coordinated with dependency updates when applicable + +## Security Team + +The MiniSearch security team is currently the project maintainer: +- [@felladrin](https://github.com/felladrin) - Project Maintainer + +## Acknowledgments + +We thank security researchers who help us keep MiniSearch secure. All valid security reports will be acknowledged in our release notes (with reporter permission). + +## Related Resources + +- [GitHub Security Advisories](https://docs.github.com/en/code-security/security-advisories) +- [OWASP Web Security Testing Guide](https://owasp.org/www-project-web-security-testing-guide/) +- [Mozilla Security Guidelines](https://infosec.mozilla.org/guidelines) diff --git a/.github/hf-space-config.yml b/.github/hf-space-config.yml new file mode 100644 index 0000000000000000000000000000000000000000..6d9d5b00160bb6ad09b8a92ab74ab6cd0a360b3b --- /dev/null +++ b/.github/hf-space-config.yml @@ -0,0 +1,11 @@ +title: MiniSearch +emoji: 👌🔍 +colorFrom: yellow +colorTo: yellow +sdk: docker +short_description: Minimalist web-searching app with browser-based AI assistant +pinned: true +custom_headers: + cross-origin-embedder-policy: require-corp + cross-origin-opener-policy: same-origin + cross-origin-resource-policy: cross-origin diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000000000000000000000000000000000000..53e17edab1e210515659c02d92d4d1d768b9740f --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,33 @@ +name: CI + +on: + push: + branches: [main, master] + pull_request: + branches: [main, master] + +jobs: + build-test: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v6 + + - name: Set up Node.js + uses: actions/setup-node@v6 + with: + node-version: lts/* + cache: npm + + - name: Install dependencies + run: npm ci + + - name: Run lint + run: npm run lint + + - name: Check formatting + run: npm run format + + - name: Run tests + run: npm test diff --git a/.github/workflows/deploy-to-hugging-face.yml b/.github/workflows/deploy-to-hugging-face.yml new file mode 100644 index 0000000000000000000000000000000000000000..7a5988fc6cc78c2f3b50489d0481ffc754202600 --- /dev/null +++ b/.github/workflows/deploy-to-hugging-face.yml @@ -0,0 +1,18 @@ +name: Deploy to Hugging Face + +on: + workflow_dispatch: + +jobs: + sync-to-hf: + name: Sync to Hugging Face Spaces + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + - uses: JacobLinCool/huggingface-sync@v1 + with: + github: ${{ secrets.GITHUB_TOKEN }} + user: ${{ vars.HF_SPACE_OWNER }} + space: ${{ vars.HF_SPACE_NAME }} + token: ${{ secrets.HF_TOKEN }} + configuration: ".github/hf-space-config.yml" diff --git a/.github/workflows/on-pull-request-to-main.yml b/.github/workflows/on-pull-request-to-main.yml new file mode 100644 index 0000000000000000000000000000000000000000..6eae98e615c1c1f2c899a9a5f1d785dd3883ff62 --- /dev/null +++ b/.github/workflows/on-pull-request-to-main.yml @@ -0,0 +1,9 @@ +name: On Pull Request To Main +on: + pull_request: + types: [opened, synchronize, reopened] + branches: ["main"] +jobs: + test-lint-ping: + if: ${{ !contains(github.event.pull_request.labels.*.name, 'skip-test-lint-ping') }} + uses: ./.github/workflows/reusable-test-lint-ping.yml diff --git a/.github/workflows/on-push-to-main.yml b/.github/workflows/on-push-to-main.yml new file mode 100644 index 0000000000000000000000000000000000000000..8ce693215c4351bab8b54ccac302345e1202ba03 --- /dev/null +++ b/.github/workflows/on-push-to-main.yml @@ -0,0 +1,7 @@ +name: On Push To Main +on: + push: + branches: ["main"] +jobs: + test-lint-ping: + uses: ./.github/workflows/reusable-test-lint-ping.yml diff --git a/.github/workflows/publish-docker-image.yml b/.github/workflows/publish-docker-image.yml new file mode 100644 index 0000000000000000000000000000000000000000..4b9e34829cd96dd1f29d6e82ffe2b3b456771792 --- /dev/null +++ b/.github/workflows/publish-docker-image.yml @@ -0,0 +1,39 @@ +name: Publish Docker Image + +on: + workflow_dispatch: + +jobs: + build-and-push-image: + name: Publish Docker Image to GitHub Packages + runs-on: ubuntu-latest + env: + REGISTRY: ghcr.io + IMAGE_NAME: ${{ github.repository }} + permissions: + contents: read + packages: write + steps: + - name: Checkout repository + uses: actions/checkout@v6 + - name: Log in to the Container registry + uses: docker/login-action@v4 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - name: Extract metadata (tags, labels) for Docker + id: meta + uses: docker/metadata-action@v6 + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v4 + - name: Build and push Docker Image + uses: docker/build-push-action@v7 + with: + context: . + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} + platforms: linux/amd64,linux/arm64 diff --git a/.github/workflows/reusable-test-lint-ping.yml b/.github/workflows/reusable-test-lint-ping.yml new file mode 100644 index 0000000000000000000000000000000000000000..56cb03bfd06cd195c45dc1e5c276125b2bb5e861 --- /dev/null +++ b/.github/workflows/reusable-test-lint-ping.yml @@ -0,0 +1,25 @@ +on: + workflow_call: +jobs: + check-code-quality: + name: Check Code Quality + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + - uses: actions/setup-node@v6 + with: + node-version: "lts/*" + cache: "npm" + - run: npm ci --ignore-scripts + - run: npm run lint + check-docker-container: + needs: [check-code-quality] + name: Check Docker Container + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + - run: docker compose -f docker-compose.production.yml up -d + - name: Check if main page is available + run: until curl -s -o /dev/null -w "%{http_code}" localhost:7860 | grep 200; do sleep 1; done + timeout-minutes: 1 + - run: docker compose -f docker-compose.production.yml down diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..b3f08f9a965c93dd56cd3f7608b1a31595000fa1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +node_modules +.DS_Store +/client/dist +/server/models +.vscode +/vite-build-stats.html +.env +/coverage +.playwright-cli diff --git a/.husky/pre-commit b/.husky/pre-commit new file mode 100644 index 0000000000000000000000000000000000000000..440d481080cb92c40bf4bb436e3c4b3064065026 --- /dev/null +++ b/.husky/pre-commit @@ -0,0 +1,2 @@ +#!/usr/bin/env sh +npm install --no-save @biomejs/biome && npx @biomejs/biome check --write --staged --no-errors-on-unmatched && git diff --name-only --cached | while read -r file; do git add "$file"; done diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000000000000000000000000000000000000..80bcbed90c4f2b3d895d5086dc775e1bd8b32b43 --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +legacy-peer-deps = true diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000000000000000000000000000000000000..9cede968af905f548a6faee9fc175750fe371a10 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,96 @@ +FROM node:lts AS llama-builder + +ARG LLAMA_CPP_RELEASE_TAG="b6604" + +RUN apt-get update && apt-get install -y \ + build-essential \ + cmake \ + ccache \ + git \ + curl + +RUN cd /tmp && \ + git clone https://github.com/ggerganov/llama.cpp.git && \ + cd llama.cpp && \ + git checkout $LLAMA_CPP_RELEASE_TAG && \ + cmake -B build -DGGML_NATIVE=OFF -DLLAMA_CURL=OFF && \ + cmake --build build --config Release -j --target llama-server && \ + mkdir -p /usr/local/lib/llama && \ + find build -type f \( -name "libllama.so" -o -name "libmtmd.so" -o -name "libggml.so" -o -name "libggml-base.so" -o -name "libggml-cpu.so" \) -exec cp {} /usr/local/lib/llama/ \; + +FROM node:lts + +ENV PORT=7860 +EXPOSE $PORT + +ARG USERNAME=node +ARG HOME_DIR=/home/${USERNAME} +ARG APP_DIR=${HOME_DIR}/app + +RUN apt-get update && \ + apt-get install -y --no-install-recommends \ + python3 \ + python3-venv && \ + apt-get clean && \ + rm -rf /var/lib/apt/lists/* + +RUN mkdir -p /usr/local/searxng /etc/searxng && \ + chown -R ${USERNAME}:${USERNAME} /usr/local/searxng /etc/searxng && \ + chmod 755 /etc/searxng + +WORKDIR /usr/local/searxng +RUN python3 -m venv searxng-venv && \ + chown -R ${USERNAME}:${USERNAME} /usr/local/searxng/searxng-venv && \ + /usr/local/searxng/searxng-venv/bin/pip install --upgrade pip && \ + /usr/local/searxng/searxng-venv/bin/pip install wheel setuptools pyyaml lxml + +RUN git clone https://github.com/searxng/searxng.git /usr/local/searxng/searxng-src && \ + chown -R ${USERNAME}:${USERNAME} /usr/local/searxng/searxng-src + +ARG SEARXNG_SETTINGS_PATH="/etc/searxng/settings.yml" + +WORKDIR /usr/local/searxng/searxng-src +RUN cp searx/settings.yml $SEARXNG_SETTINGS_PATH && \ + chown ${USERNAME}:${USERNAME} $SEARXNG_SETTINGS_PATH && \ + chmod 644 $SEARXNG_SETTINGS_PATH && \ + sed -i 's/ultrasecretkey/'$(openssl rand -hex 32)'/g' $SEARXNG_SETTINGS_PATH && \ + sed -i 's/- html/- json/' $SEARXNG_SETTINGS_PATH && \ + /usr/local/searxng/searxng-venv/bin/pip install -r requirements.txt && \ + /usr/local/searxng/searxng-venv/bin/pip install --no-build-isolation -e . + +COPY --from=llama-builder /tmp/llama.cpp/build/bin/llama-server /usr/local/bin/ +COPY --from=llama-builder /usr/local/lib/llama/* /usr/local/lib/ +RUN ldconfig /usr/local/lib + +USER ${USERNAME} + +WORKDIR ${APP_DIR} + +ARG ACCESS_KEYS +ARG ACCESS_KEY_TIMEOUT_HOURS +ARG WEBLLM_DEFAULT_F16_MODEL_ID +ARG WEBLLM_DEFAULT_F32_MODEL_ID +ARG WLLAMA_DEFAULT_MODEL_ID +ARG INTERNAL_OPENAI_COMPATIBLE_API_BASE_URL +ARG INTERNAL_OPENAI_COMPATIBLE_API_KEY +ARG INTERNAL_OPENAI_COMPATIBLE_API_MODEL +ARG INTERNAL_OPENAI_COMPATIBLE_API_NAME +ARG DEFAULT_INFERENCE_TYPE +ARG HOST +ARG HMR_PORT +ARG ALLOWED_HOSTS + +COPY --chown=${USERNAME}:${USERNAME} ./package.json ./package-lock.json ./.npmrc ./ + +RUN npm ci + +COPY --chown=${USERNAME}:${USERNAME} . . + +RUN git config --global --add safe.directory ${APP_DIR} && \ + npm run build + +HEALTHCHECK --interval=5m CMD curl -f http://localhost:7860/status || exit 1 + +ENTRYPOINT [ "/bin/sh", "-c" ] + +CMD ["(cd /usr/local/searxng/searxng-src && /usr/local/searxng/searxng-venv/bin/python -m searx.webapp > /dev/null 2>&1) & npm start -- --host"] diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..4baa14c0e12c3ea44be05fc58d7ef8a9729e4ff4 --- /dev/null +++ b/README.md @@ -0,0 +1,143 @@ +--- +title: MiniSearch +emoji: 👌🔍 +colorFrom: yellow +colorTo: yellow +sdk: docker +short_description: Minimalist web-searching app with browser-based AI assistant +pinned: true +custom_headers: + cross-origin-embedder-policy: require-corp + cross-origin-opener-policy: same-origin + cross-origin-resource-policy: cross-origin +--- + +# MiniSearch + +A minimalist web-searching app with an AI assistant that runs directly from your browser. + +Live demo: https://felladrin-minisearch.hf.space + +## Screenshot + +![MiniSearch Screenshot](https://github.com/user-attachments/assets/f8d72a8e-a725-42e9-9358-e6ebade2acb2) + +## Features + +- **Privacy-focused**: [No tracking, no ads, no data collection](https://docs.searxng.org/own-instance.html#how-does-searxng-protect-privacy) +- **Easy to use**: Minimalist yet intuitive interface for all users +- **Cross-platform**: Models run inside the browser, both on desktop and mobile +- **Integrated**: Search from the browser address bar by setting it as the default search engine +- **Efficient**: Models are loaded and cached only when needed +- **Customizable**: Tweakable settings for search results and text generation +- **Open-source**: [The code is available for inspection and contribution at GitHub](https://github.com/felladrin/MiniSearch) + +## Prerequisites + +- [Docker](https://docs.docker.com/get-docker/) + +## Getting started + +Here are the easiest ways to get started with MiniSearch. Pick the one that suits you best. + +**Option 1** - Use [MiniSearch's Docker Image](https://github.com/felladrin/MiniSearch/pkgs/container/minisearch) by running in your terminal: + +```bash +docker run -p 7860:7860 ghcr.io/felladrin/minisearch:main +``` + +**Option 2** - Add MiniSearch's Docker Image to your existing Docker Compose file: + +```yaml +services: + minisearch: + image: ghcr.io/felladrin/minisearch:main + ports: + - "7860:7860" +``` + +**Option 3** - Build from source by [downloading the repository files](https://github.com/felladrin/MiniSearch/archive/refs/heads/main.zip) and running: + +```bash +docker compose -f docker-compose.production.yml up --build +``` + +Once the container is running, open http://localhost:7860 in your browser and start searching! + +## Frequently asked questions [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/felladrin/MiniSearch) + +
+ How do I search via the browser's address bar? +

+ You can set MiniSearch as your browser's address-bar search engine using the pattern http://localhost:7860/?q=%s, in which your search term replaces %s. +

+
+ +
+ How do I search via Raycast? +

+ You can add this Quicklink to Raycast, so typing your query will open MiniSearch with the search results. You can also edit it to point to your own domain. +

+ image +
+ +
+ Can I use custom models via OpenAI-Compatible API? +

+ Yes! For this, open the Menu and change the "AI Processing Location" to Remote server (API). Then configure the Base URL, and optionally set an API Key and a Model to use. +

+
+ +
+ How do I restrict the access to my MiniSearch instance via password? +

+ Create a .env file and set a value for ACCESS_KEYS. Then reset the MiniSearch docker container. +

+

+ For example, if you to set the password to PepperoniPizza, then this is what you should add to your .env:
+ ACCESS_KEYS="PepperoniPizza" +

+

+ You can find more examples in the .env.example file. +

+
+ +
+ I want to serve MiniSearch to other users, allowing them to use my own OpenAI-Compatible API key, but without revealing it to them. Is it possible? +

Yes! In MiniSearch, we call this text-generation feature "Internal OpenAI-Compatible API". To use this it:

+
    +
  1. Set up your OpenAI-Compatible API endpoint by configuring the following environment variables in your .env file: +
      +
    • INTERNAL_OPENAI_COMPATIBLE_API_BASE_URL: The base URL for your API
      • +
    • INTERNAL_OPENAI_COMPATIBLE_API_KEY: Your API access key
      • +
    • INTERNAL_OPENAI_COMPATIBLE_API_MODEL: The model to use
      • +
    • INTERNAL_OPENAI_COMPATIBLE_API_NAME: The name to display in the UI
      • +
    +
    2. +
  2. Restart MiniSearch server.
    3. +
  3. In the MiniSearch menu, select the new option (named as per your INTERNAL_OPENAI_COMPATIBLE_API_NAME setting) from the "AI Processing Location" dropdown.
    4. +
+
+ +
+ How can I contribute to the development of this tool? +

We welcome contributions! Please read our Contributing Guidelines for detailed information on how to get started.

+

Quick start:

+
    +
  1. Fork this repository and clone it
    2. +
  2. Start the development server: docker compose up
    3. +
  3. Make your changes and test them
    4. +
  4. Push to your fork and open a pull request
    5. +
+

All contributions are welcome! 🎉

+
+ +
+ Where can I find more information? + +
diff --git a/agents.md b/agents.md new file mode 100644 index 0000000000000000000000000000000000000000..04503fbb31dbbeca08ef2dd385f436b44b1cdb4a --- /dev/null +++ b/agents.md @@ -0,0 +1,176 @@ +# MiniSearch Agent Guidelines + +This is your navigation hub. Start here, follow the links, and return when you need orientation. + +## Before You Start + +**New to this codebase?** Read in this order: +1. `docs/quick-start.md` - Get it running +2. `docs/overview.md` - Understand the system +3. `docs/project-structure.md` - Navigate the code + +**Making changes?** Check: +- `docs/coding-conventions.md` - Code style +- `docs/development-commands.md` - Available commands +- `docs/pull-requests.md` - How to submit + +## Repository Map + +### Getting Started +- **`docs/quick-start.md`** - Installation, first run, verification +- **`docs/overview.md`** - System architecture and data flow +- **`docs/project-structure.md`** - Directory layout and component organization + +### Configuration & Setup +- **`docs/configuration.md`** - Environment variables and settings reference +- **`docs/security.md`** - Access control, privacy, and security model + +### Core Functionality +- **`docs/ai-integration.md`** - AI inference types (WebLLM, Wllama, OpenAI, AI Horde, Internal) +- **`docs/ui-components.md`** - Component architecture and PubSub patterns +- **`docs/search-history.md`** - History database schema and management +- **`docs/conversation-memory.md`** - Token budgeting and rolling summaries + +### Development +- **`docs/development-commands.md`** - Docker, npm, and testing commands +- **`docs/coding-conventions.md`** - Style guide and patterns +- **`docs/pull-requests.md`** - PR process and merge philosophy +- **`docs/core-technologies.md`** - Technology stack and dependencies +- **`docs/design.md`** - UI/UX design principles + +## Agent Decision Tree + +``` +Need to: +├── Add a feature? +│ ├── UI component → docs/ui-components.md +│ ├── AI integration → docs/ai-integration.md +│ ├── Search functionality → client/modules/search.ts +│ └── Settings option → docs/configuration.md +├── Fix a bug? +│ ├── UI issue → Check component + PubSub channels +│ ├── AI not working → docs/ai-integration.md + browser console +│ ├── Search failing → Check SearXNG + server hooks +│ └── Build error → docs/development-commands.md +├── Configure deployment? +│ ├── Environment variables → docs/configuration.md +│ ├── Access control → docs/security.md +│ └── Docker setup → docs/overview.md +└── Understand data flow? + ├── Search flow → client/modules/search.ts + ├── AI generation → client/modules/textGeneration.ts + ├── State management → docs/ui-components.md + └── History/Chat → docs/search-history.md + docs/conversation-memory.md +``` + +## Key Files Reference + +### Entry Points +- `client/index.tsx` - React app initialization +- `vite.config.ts` - Vite dev server with hooks +- `Dockerfile` - Multi-stage container build + +### Business Logic Modules +- `client/modules/search.ts` - Search orchestration and caching +- `client/modules/textGeneration.ts` - AI response flow +- `client/modules/pubSub.ts` - All PubSub channels +- `client/modules/settings.ts` - Settings management +- `client/modules/history.ts` - Search history database + +### Server-Side Modules +- `server/searchEndpointServerHook.ts` - `/search` endpoints +- `server/internalApiEndpointServerHook.ts` - `/inference` proxy +- `server/webSearchService.ts` - SearXNG integration +- `server/rerankerService.ts` - Local result reranking + +### Key Components +- `client/components/App/` - Application shell +- `client/components/Search/Form/` - Search input +- `client/components/Search/Results/` - Results display +- `client/components/AiResponse/` - AI response + chat +- `client/components/Pages/Main/Menu/` - Settings drawers +- `client/modules/webGpu.ts` - Detects WebGPU availability and F16 shader support for WebLLM +- `client/modules/querySuggestions.ts` - Provides search suggestion UI, stored in IndexedDB +- `client/modules/relatedSearchQuery.ts` - Generates related search queries +- `client/modules/followUpQuestions.ts` - Generates suggested follow-up questions, uses `followUpQuestionPubSub` +- `client/modules/accessKey.ts` - Validates and stores access keys, uses `accessKeyValidatedPubSub` +- `client/modules/parentWindow.ts` - PostMessage API for embedding in parent windows +- `client/hooks/` - Reusable React hooks +- `server/searchToken.ts` - Generates CSRF protection tokens for search requests +- `server/downloadFileFromHuggingFaceRepository.ts` - Downloads GGUF models from HuggingFace using `@huggingface/hub` package + +## Common Tasks Quick Reference + +### Add a new AI model +1. Add to `client/modules/wllama.ts` or WebLLM registry +2. Update `docs/ai-integration.md` +3. Update `docs/configuration.md` defaults + +### Add a new setting +1. Add to `client/modules/settings.ts` default object +2. Add UI in `client/components/Pages/Main/Menu/` +3. Update `docs/configuration.md` settings table + +### Modify search behavior +1. Edit `client/modules/search.ts` +2. Update `server/webSearchService.ts` if server-side changes needed +3. Check `server/rerankerService.ts` if reranking affected + +### Fix UI state issues +1. Check PubSub channels in `client/modules/pubSub.ts` +2. Verify component subscriptions in `docs/ui-components.md` +3. Ensure proper state updates in business logic modules + +### Analyze test coverage +1. Run `npm run test:coverage` to generate reports +2. Check `coverage/coverage-summary.json` for quick metrics +3. See `docs/development-commands.md` for full coverage analysis guide + +## Quality Gates + +Before any change: +```bash +docker compose exec development-server npm run lint +``` + +This runs: +- Biome (formatting/linting) +- TypeScript (type checking) +- ts-prune (dead code detection) +- jscpd (copy-paste detection) +- dpdm (circular dependency detection) +- Custom architectural linter + +## Agent-First Principles + +**Repository as System of Record:** +- All knowledge lives in versioned docs/ structure +- This file is your entry point - start here +- Follow links, don't assume - verify in code + +**Context Efficiency:** +- Use this map to navigate quickly +- Return to this file when context drifts +- Follow the decision tree for common tasks + +**Architecture & Boundaries:** +- Respect PubSub boundaries - don't cross concerns +- Client vs server - keep them separate +- Feature-based organization - one folder per feature + +**Documentation Maintenance:** +- Update these docs when you learn something new +- Add cross-references when linking concepts +- Keep examples current with actual code + +## Technology Stack + +React + TypeScript + Mantine UI v8, with privacy-first architecture. +See `docs/core-technologies.md` for complete dependency list and selection criteria. + +## Need Help? + +1. Check relevant doc in `docs/` +2. Read the module code in `client/modules/` or `server/` +3. Look at similar existing implementations +4. Run `npm run lint` to validate changes diff --git a/biome.json b/biome.json new file mode 100644 index 0000000000000000000000000000000000000000..dbdd0b33769e0e57f2164a86835a24b19f7bd505 --- /dev/null +++ b/biome.json @@ -0,0 +1,34 @@ +{ + "$schema": "https://biomejs.dev/schemas/latest/schema.json", + "vcs": { + "enabled": true, + "clientKind": "git", + "useIgnoreFile": true + }, + "files": { + "ignoreUnknown": false + }, + "formatter": { + "enabled": true, + "indentStyle": "space" + }, + "linter": { + "enabled": true, + "rules": { + "recommended": true + } + }, + "javascript": { + "formatter": { + "quoteStyle": "double" + } + }, + "assist": { + "enabled": true, + "actions": { + "source": { + "organizeImports": "on" + } + } + } +} diff --git a/client/components/AiResponse/AiModelDownloadAllowanceContent.tsx b/client/components/AiResponse/AiModelDownloadAllowanceContent.tsx new file mode 100644 index 0000000000000000000000000000000000000000..48fbb9ce81045bc0cd3ba2e5f99b66cfb7e30c5c --- /dev/null +++ b/client/components/AiResponse/AiModelDownloadAllowanceContent.tsx @@ -0,0 +1,62 @@ +import { Alert, Button, Group, Text } from "@mantine/core"; +import { IconCheck, IconInfoCircle, IconX } from "@tabler/icons-react"; +import { usePubSub } from "create-pubsub/react"; +import { useState } from "react"; +import { addLogEntry } from "@/modules/logEntries"; +import { settingsPubSub } from "@/modules/pubSub"; + +export default function AiModelDownloadAllowanceContent() { + const [settings, setSettings] = usePubSub(settingsPubSub); + const [hasDeniedDownload, setDeniedDownload] = useState(false); + + const handleAccept = () => { + setSettings({ + ...settings, + allowAiModelDownload: true, + }); + addLogEntry("User allowed the AI model download"); + }; + + const handleDecline = () => { + setDeniedDownload(true); + addLogEntry("User denied the AI model download"); + }; + + return hasDeniedDownload ? null : ( + } + > + + To obtain AI responses, a language model needs to be downloaded to your + browser. Enabling this option lets the app store it and load it + instantly on subsequent uses. + + + Please note that the download size ranges from 100 MB to 4 GB, depending + on the model you select in the Menu, so it's best to avoid using mobile + data for this. + + + + + + + ); +} diff --git a/client/components/AiResponse/AiResponseContent.tsx b/client/components/AiResponse/AiResponseContent.tsx new file mode 100644 index 0000000000000000000000000000000000000000..e0805a44314e74b1665d93f6249baaa10a27644a --- /dev/null +++ b/client/components/AiResponse/AiResponseContent.tsx @@ -0,0 +1,219 @@ +import { + ActionIcon, + Alert, + Badge, + Box, + Card, + Group, + ScrollArea, + Text, + Tooltip, +} from "@mantine/core"; +import { + IconArrowsMaximize, + IconArrowsMinimize, + IconHandStop, + IconInfoCircle, + IconRefresh, + IconVolume2, +} from "@tabler/icons-react"; +import type { PublishFunction } from "create-pubsub"; +import { usePubSub } from "create-pubsub/react"; +import { type ReactNode, useMemo, useState } from "react"; +import { addLogEntry } from "@/modules/logEntries"; +import { settingsPubSub } from "@/modules/pubSub"; +import { searchAndRespond } from "@/modules/textGeneration"; +import CopyIconButton from "./CopyIconButton"; +import FormattedMarkdown from "./FormattedMarkdown"; + +export default function AiResponseContent({ + textGenerationState, + response, + setTextGenerationState, +}: { + textGenerationState: string; + response: string; + setTextGenerationState: PublishFunction< + | "failed" + | "awaitingSearchResults" + | "preparingToGenerate" + | "idle" + | "loadingModel" + | "generating" + | "interrupted" + | "completed" + >; +}) { + const [settings, setSettings] = usePubSub(settingsPubSub); + const [isSpeaking, setIsSpeaking] = useState(false); + + const ConditionalScrollArea = useMemo( + () => + ({ children }: { children: ReactNode }) => { + return settings.enableAiResponseScrolling ? ( + + {children} + + ) : ( + {children} + ); + }, + [settings.enableAiResponseScrolling], + ); + + function speakResponse(text: string) { + if (isSpeaking) { + self.speechSynthesis.cancel(); + setIsSpeaking(false); + return; + } + + const prepareTextForSpeech = (textToClean: string) => { + const withoutReasoning = textToClean.replace( + new RegExp( + `${settings.reasoningStartMarker}[\\s\\S]*?${settings.reasoningEndMarker}`, + "g", + ), + "", + ); + const withoutLinks = withoutReasoning.replace( + /\[([^\]]+)\]\([^)]+\)/g, + "($1)", + ); + const withoutMarkdown = withoutLinks.replace(/[#*`_~[\]]/g, ""); + return withoutMarkdown.trim(); + }; + + const utterance = new SpeechSynthesisUtterance(prepareTextForSpeech(text)); + + const voices = self.speechSynthesis.getVoices(); + + if (voices.length > 0 && settings.selectedVoiceId) { + const voice = voices.find( + (voice) => voice.voiceURI === settings.selectedVoiceId, + ); + + if (voice) { + utterance.voice = voice; + utterance.lang = voice.lang; + } + } + + utterance.onerror = () => { + addLogEntry("Failed to speak response"); + setIsSpeaking(false); + }; + + utterance.onend = () => setIsSpeaking(false); + + setIsSpeaking(true); + self.speechSynthesis.speak(utterance); + } + + return ( + + + + + + {textGenerationState === "generating" + ? "Generating AI Response..." + : "AI Response"} + + {textGenerationState === "interrupted" && ( + + Interrupted + + )} + + + {textGenerationState === "generating" ? ( + + setTextGenerationState("interrupted")} + variant="subtle" + color="gray" + > + + + + ) : ( + + searchAndRespond()} + variant="subtle" + color="gray" + > + + + + )} + + speakResponse(response)} + variant="subtle" + color={isSpeaking ? "blue" : "gray"} + > + + + + {settings.enableAiResponseScrolling ? ( + + { + setSettings({ + ...settings, + enableAiResponseScrolling: false, + }); + }} + variant="subtle" + color="gray" + > + + + + ) : ( + + { + setSettings({ + ...settings, + enableAiResponseScrolling: true, + }); + }} + variant="subtle" + color="gray" + > + + + + )} + + + + + + + {response} + + {textGenerationState === "failed" && ( + } + > + Could not generate response. Please try refreshing the page. + + )} + + + ); +} diff --git a/client/components/AiResponse/AiResponseSection.tsx b/client/components/AiResponse/AiResponseSection.tsx new file mode 100644 index 0000000000000000000000000000000000000000..3b4dc3db5bc63b63729d801dbb33826c790c34ae --- /dev/null +++ b/client/components/AiResponse/AiResponseSection.tsx @@ -0,0 +1,101 @@ +import { CodeHighlightAdapterProvider } from "@mantine/code-highlight"; +import { usePubSub } from "create-pubsub/react"; +import { useMemo } from "react"; +import { + chatMessagesPubSub, + isRestoringFromHistoryPubSub, + modelLoadingProgressPubSub, + modelSizeInMegabytesPubSub, + queryPubSub, + responsePubSub, + settingsPubSub, + textGenerationStatePubSub, +} from "@/modules/pubSub"; +import { shikiAdapter } from "@/modules/shiki"; +import "@mantine/code-highlight/styles.css"; +import AiModelDownloadAllowanceContent from "./AiModelDownloadAllowanceContent"; +import AiResponseContent from "./AiResponseContent"; +import ChatInterface from "./ChatInterface"; +import LoadingModelContent from "./LoadingModelContent"; +import PreparingContent from "./PreparingContent"; + +export default function AiResponseSection() { + const [query] = usePubSub(queryPubSub); + const [response] = usePubSub(responsePubSub); + const [textGenerationState, setTextGenerationState] = usePubSub( + textGenerationStatePubSub, + ); + const [modelLoadingProgress] = usePubSub(modelLoadingProgressPubSub); + const [settings] = usePubSub(settingsPubSub); + const [modelSizeInMegabytes] = usePubSub(modelSizeInMegabytesPubSub); + const [chatMessages] = usePubSub(chatMessagesPubSub); + const [isRestoringFromHistory] = usePubSub(isRestoringFromHistoryPubSub); + + return useMemo(() => { + if (!settings.enableAiResponse || textGenerationState === "idle") { + return null; + } + + const generatingStates = [ + "generating", + "interrupted", + "completed", + "failed", + ]; + if (generatingStates.includes(textGenerationState)) { + return ( + + + + {textGenerationState === "completed" && ( + 0 ? chatMessages : undefined + } + suppressInitialFollowUp={isRestoringFromHistory} + /> + )} + + ); + } + + if (textGenerationState === "loadingModel") { + return ( + + ); + } + + if (textGenerationState === "preparingToGenerate") { + return ; + } + + if (textGenerationState === "awaitingSearchResults") { + return ; + } + + if (textGenerationState === "awaitingModelDownloadAllowance") { + return ; + } + + return null; + }, [ + settings.enableAiResponse, + textGenerationState, + response, + query, + chatMessages, + modelLoadingProgress, + modelSizeInMegabytes, + setTextGenerationState, + isRestoringFromHistory, + ]); +} diff --git a/client/components/AiResponse/ChatHeader.tsx b/client/components/AiResponse/ChatHeader.tsx new file mode 100644 index 0000000000000000000000000000000000000000..f62bc98185cb401cd8db79b7f2368ad9c1ef42a5 --- /dev/null +++ b/client/components/AiResponse/ChatHeader.tsx @@ -0,0 +1,33 @@ +import { Group, Text } from "@mantine/core"; +import type { ChatMessage } from "@/modules/types"; +import CopyIconButton from "./CopyIconButton"; + +interface ChatHeaderProps { + messages: ChatMessage[]; +} + +function ChatHeader({ messages }: ChatHeaderProps) { + const getChatContent = () => { + return messages + .slice(2) + .map( + (msg, index) => + `${index + 1}. ${msg.role?.toUpperCase()}\n\n${msg.content}`, + ) + .join("\n\n"); + }; + + return ( + + Follow-up questions + {messages.length > 2 && ( + + )} + + ); +} + +export default ChatHeader; diff --git a/client/components/AiResponse/ChatInputArea.tsx b/client/components/AiResponse/ChatInputArea.tsx new file mode 100644 index 0000000000000000000000000000000000000000..25ff4e20ce45e529ceb708d9e56dbc70e1b81d1b --- /dev/null +++ b/client/components/AiResponse/ChatInputArea.tsx @@ -0,0 +1,106 @@ +import { Button, Group, Textarea } from "@mantine/core"; +import { IconSend } from "@tabler/icons-react"; +import { usePubSub } from "create-pubsub/react"; +import { + chatGenerationStatePubSub, + chatInputPubSub, + followUpQuestionPubSub, + isRestoringFromHistoryPubSub, + suppressNextFollowUpPubSub, +} from "@/modules/pubSub"; + +interface ChatInputAreaProps { + onKeyDown: (event: React.KeyboardEvent) => void; + handleSend: (textToSend?: string) => void; +} + +function ChatInputArea({ onKeyDown, handleSend }: ChatInputAreaProps) { + const [input, setInput] = usePubSub(chatInputPubSub); + const [generationState] = usePubSub(chatGenerationStatePubSub); + const [followUpQuestion] = usePubSub(followUpQuestionPubSub); + const [isRestoringFromHistory] = usePubSub(isRestoringFromHistoryPubSub); + const [suppressNextFollowUp] = usePubSub(suppressNextFollowUpPubSub); + + const isGenerating = + generationState.isGeneratingResponse && + !generationState.isGeneratingFollowUpQuestion; + + const defaultPlaceholder = "Anything else you would like to know?"; + const placeholder = + isRestoringFromHistory || suppressNextFollowUp + ? defaultPlaceholder + : followUpQuestion || defaultPlaceholder; + + const onChange = (event: React.ChangeEvent) => { + setInput(event.target.value); + }; + const handleKeyDownWithPlaceholder = ( + event: React.KeyboardEvent, + ) => { + if ( + input.trim() === "" && + followUpQuestion && + !isRestoringFromHistory && + !suppressNextFollowUp + ) { + if (event.key === "Enter" && !event.shiftKey) { + event.preventDefault(); + handleSend(followUpQuestion); + return; + } + } + + onKeyDown(event); + }; + + const handleSendWithPlaceholder = () => { + if ( + input.trim() === "" && + followUpQuestion && + !isRestoringFromHistory && + !suppressNextFollowUp + ) { + handleSend(followUpQuestion); + } else { + handleSend(); + } + }; + + return ( + +