@aigentic/ruflo 3.7.0-alpha.69

package/src/ruvocal/.github/workflows/build-image.yml

@@ -0,0 +1,142 @@
+name: Build and Publish Image
+
+permissions:
+  packages: write
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+    branches:
+      - "*"
+    paths:
+      - "Dockerfile"
+      - "entrypoint.sh"
+  workflow_dispatch:
+  release:
+    types: [published, edited]
+
+jobs:
+  build-and-publish-image-with-db:
+    runs-on:
+      group: aws-general-8-plus
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Extract package version
+        id: package-version
+        run: |
+          VERSION=$(jq -r .version package.json)
+          echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
+          MAJOR=$(echo $VERSION | cut -d '.' -f1)
+          echo "MAJOR=$MAJOR" >> $GITHUB_OUTPUT
+          MINOR=$(echo $VERSION | cut -d '.' -f1).$(echo $VERSION | cut -d '.' -f2)
+          echo "MINOR=$MINOR" >> $GITHUB_OUTPUT
+
+      - name: Docker metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            ghcr.io/huggingface/chat-ui-db
+          tags: |
+            type=raw,value=${{ steps.package-version.outputs.VERSION }},enable=${{github.event_name == 'release'}}
+            type=raw,value=${{ steps.package-version.outputs.MAJOR }},enable=${{github.event_name == 'release'}}
+            type=raw,value=${{ steps.package-version.outputs.MINOR }},enable=${{github.event_name == 'release'}}
+            type=raw,value=latest,enable={{is_default_branch}}
+            type=sha,enable={{is_default_branch}}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to GitHub Container Registry
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Inject slug/short variables
+        uses: rlespinasse/github-slug-action@v4.5.0
+
+      - name: Build and Publish Docker Image with DB
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: Dockerfile
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          platforms: linux/amd64,linux/arm64
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+          build-args: |
+            INCLUDE_DB=true
+            PUBLIC_COMMIT_SHA=${{ env.GITHUB_SHA_SHORT }}
+  build-and-publish-image-nodb:
+    runs-on:
+      group: aws-general-8-plus
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Extract package version
+        id: package-version
+        run: |
+          VERSION=$(jq -r .version package.json)
+          echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
+          MAJOR=$(echo $VERSION | cut -d '.' -f1)
+          echo "MAJOR=$MAJOR" >> $GITHUB_OUTPUT
+          MINOR=$(echo $VERSION | cut -d '.' -f1).$(echo $VERSION | cut -d '.' -f2)
+          echo "MINOR=$MINOR" >> $GITHUB_OUTPUT
+
+      - name: Docker metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            ghcr.io/huggingface/chat-ui
+          tags: |
+            type=raw,value=${{ steps.package-version.outputs.VERSION }},enable=${{github.event_name == 'release'}}
+            type=raw,value=${{ steps.package-version.outputs.MAJOR }},enable=${{github.event_name == 'release'}}
+            type=raw,value=${{ steps.package-version.outputs.MINOR }},enable=${{github.event_name == 'release'}}
+            type=raw,value=latest,enable={{is_default_branch}}
+            type=sha,enable={{is_default_branch}}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to GitHub Container Registry
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Inject slug/short variables
+        uses: rlespinasse/github-slug-action@v4.5.0
+
+      - name: Build and Publish Docker Image without DB
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: Dockerfile
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          platforms: linux/amd64,linux/arm64
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+          build-args: |
+            INCLUDE_DB=false
+            PUBLIC_COMMIT_SHA=${{ env.GITHUB_SHA_SHORT }}

package/src/ruvocal/.github/workflows/build-pr-docs.yml

@@ -0,0 +1,20 @@
+name: Build PR Documentation
+
+on:
+  pull_request:
+    paths:
+      - "docs/source/**"
+      - ".github/workflows/build-pr-docs.yml"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    uses: huggingface/doc-builder/.github/workflows/build_pr_documentation.yml@main
+    with:
+      commit_sha: ${{ github.event.pull_request.head.sha }}
+      pr_number: ${{ github.event.number }}
+      package: chat-ui
+      additional_args: --not_python_module

package/src/ruvocal/.github/workflows/deploy-dev.yml

@@ -0,0 +1,63 @@
+name: Deploy to ephemeral
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, labeled, unlabeled]
+
+jobs:
+  branch-slug:
+    uses: ./.github/workflows/slugify.yaml
+    with:
+      value: ${{ github.head_ref }}
+
+  deploy-dev:
+    if: contains(github.event.pull_request.labels.*.name, 'preview')
+    runs-on: ubuntu-latest
+    needs: branch-slug
+    environment:
+      name: dev
+      url: https://${{ needs.branch-slug.outputs.slug }}.chat-dev.huggingface.tech/chat/
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Login to Registry
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+      - name: Inject slug/short variables
+        uses: rlespinasse/github-slug-action@v4.5.0
+
+      - name: Set GITHUB_SHA_SHORT from PR
+        if: env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT != null
+        run: echo "GITHUB_SHA_SHORT=${{ env.GITHUB_EVENT_PULL_REQUEST_HEAD_SHA_SHORT }}" >> $GITHUB_ENV
+
+      - name: Docker metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            huggingface/chat-ui
+          tags: |
+            type=raw,value=dev-${{ env.GITHUB_SHA_SHORT }}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build and Publish HuggingChat image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: Dockerfile
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          platforms: linux/amd64
+          cache-to: type=gha,mode=max,scope=amd64
+          cache-from: type=gha,scope=amd64
+          provenance: false
+          build-args: |
+            INCLUDE_DB=false
+            APP_BASE=/chat
+            PUBLIC_COMMIT_SHA=${{ env.GITHUB_SHA_SHORT }}

package/src/ruvocal/.github/workflows/deploy-prod.yml

@@ -0,0 +1,78 @@
+name: Deploy to k8s
+on:
+  # run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build-and-publish-huggingchat-image:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Login to Registry
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+      - name: Docker metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            huggingface/chat-ui
+          tags: |
+            type=raw,value=latest,enable={{is_default_branch}}
+            type=sha,enable=true,prefix=sha-,format=short,sha-len=8
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Inject slug/short variables
+        uses: rlespinasse/github-slug-action@v4.5.0
+
+      - name: Build and Publish HuggingChat image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: Dockerfile
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          platforms: linux/amd64
+          cache-to: type=gha,mode=max,scope=amd64
+          cache-from: type=gha,scope=amd64
+          provenance: false
+          build-args: |
+            INCLUDE_DB=false
+            APP_BASE=/chat
+            PUBLIC_COMMIT_SHA=${{ env.GITHUB_SHA_SHORT }}
+  deploy:
+    name: Deploy on prod
+    runs-on: ubuntu-latest
+    needs: ["build-and-publish-huggingchat-image"]
+    steps:
+      - name: Inject slug/short variables
+        uses: rlespinasse/github-slug-action@v4.5.0
+
+      - name: Gen values
+        run: |
+          VALUES=$(cat <<-END
+          image:
+            tag: "sha-${{ env.GITHUB_SHA_SHORT }}"
+          END
+          )
+          echo "VALUES=$(echo "$VALUES" | yq -o=json | jq tostring)" >> $GITHUB_ENV
+
+      - name: Deploy on infra-deployments
+        uses: aurelien-baudet/workflow-dispatch@v2
+        with:
+          workflow: Update application single value
+          repo: huggingface/infra-deployments
+          wait-for-completion: true
+          wait-for-completion-interval: 10s
+          display-workflow-run-url-interval: 10s
+          ref: refs/heads/main
+          token: ${{ secrets.GIT_TOKEN_INFRA_DEPLOYMENT }}
+          inputs: '{"path": "hub/chat-ui/chat-ui.yaml", "value": ${{ env.VALUES }}, "url": "${{ github.event.head_commit.url }}"}'

package/src/ruvocal/.github/workflows/lint-and-test.yml

@@ -0,0 +1,84 @@
+name: Lint and test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "20"
+          cache: "npm"
+      - run: |
+          npm install ci
+      - name: "Checking lint/format errors"
+        run: |
+          npm run lint
+      - name: "Checking type errors"
+        run: |
+          npm run check
+
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "20"
+          cache: "npm"
+      - run: |
+          npm ci
+          npx playwright install
+      - name: "Tests"
+        run: |
+          npm run test
+
+  build-check:
+    runs-on:
+      group: aws-general-8-plus
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v3
+      - name: Build Docker image
+        run: |
+          docker build \
+            --build-arg INCLUDE_DB=true \
+            -t chat-ui-test:latest .
+
+      - name: Run Docker container
+        run: |
+          export DOTENV_LOCAL=$(<.env.ci)
+          docker run -d --rm --network=host \
+            --name chat-ui-test \
+            -e DOTENV_LOCAL="$DOTENV_LOCAL" \
+            chat-ui-test:latest
+
+      - name: Wait for server to start
+        run: |
+          for i in {1..10}; do
+            if curl -s -o /dev/null -w "%{http_code}" http://localhost:3000/ | grep -q "200"; then
+              echo "Server is up"
+              exit 0
+            fi
+            echo "Waiting for server..."
+            sleep 2
+          done
+          echo "Server did not start in time"
+          docker logs chat-ui-test
+          exit 1
+
+      - name: Stop Docker container
+        if: always()
+        run: |
+          docker stop chat-ui-test || true

package/src/ruvocal/.github/workflows/slugify.yaml

@@ -0,0 +1,72 @@
+name: Generate Branch Slug
+
+on:
+  workflow_call:
+    inputs:
+      value:
+        description: "Value to slugify"
+        required: true
+        type: string
+    outputs:
+      slug:
+        description: "Slugified value"
+        value: ${{ jobs.generate-slug.outputs.slug }}
+
+jobs:
+  generate-slug:
+    runs-on: ubuntu-latest
+    outputs:
+      slug: ${{ steps.slugify.outputs.slug }}
+
+    steps:
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: "1.21"
+
+      - name: Generate slug
+        id: slugify
+        run: |
+          # Create working directory
+          mkdir -p $HOME/slugify
+          cd $HOME/slugify
+
+          # Create Go script
+          cat > main.go << 'EOF'
+          package main
+
+          import (
+              "fmt"
+              "os"
+              "github.com/gosimple/slug"
+          )
+
+          func main() {
+              if len(os.Args) < 2 {
+                  fmt.Println("Usage: slugify <text>")
+                  os.Exit(1)
+              }
+
+              text := os.Args[1]
+              slugged := slug.Make(text)
+              fmt.Println(slugged)
+          }
+          EOF
+
+          # Initialize module and install dependency
+          go mod init slugify
+          go mod tidy
+          go get github.com/gosimple/slug
+
+          # Build
+          go build -o slugify main.go
+
+          # Generate slug
+          VALUE="${{ inputs.value }}"
+          echo "Input value: $VALUE"
+
+          SLUG=$(./slugify "$VALUE")
+          echo "Generated slug: $SLUG"
+
+          # Export
+          echo "slug=$SLUG" >> $GITHUB_OUTPUT

package/src/ruvocal/.github/workflows/trufflehog.yml

@@ -0,0 +1,17 @@
+on:
+  push:
+
+name: Secret Leaks
+
+jobs:
+  trufflehog:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Secret Scanning
+        uses: trufflesecurity/trufflehog@main
+        with:
+          extra_args: --results=verified,unknown

package/src/ruvocal/.github/workflows/upload-pr-documentation.yml

@@ -0,0 +1,16 @@
+name: Upload PR Documentation
+
+on:
+  workflow_run:
+    workflows: ["Build PR Documentation"]
+    types:
+      - completed
+
+jobs:
+  build:
+    uses: huggingface/doc-builder/.github/workflows/upload_pr_documentation.yml@main
+    with:
+      package_name: chat-ui
+    secrets:
+      hf_token: ${{ secrets.HF_DOC_BUILD_PUSH }}
+      comment_bot_token: ${{ secrets.COMMENT_BOT_TOKEN }}

package/src/ruvocal/.husky/lint-stage-config.js

@@ -0,0 +1,4 @@
+export default {
+	"*.{js,jsx,ts,tsx}": ["prettier --write", "eslint --fix", "eslint"],
+	"*.json": ["prettier --write"],
+};

package/src/ruvocal/.husky/pre-commit

@@ -0,0 +1,2 @@
+set -e
+npx lint-staged --config ./.husky/lint-stage-config.js

package/src/ruvocal/.prettierignore

@@ -0,0 +1,14 @@
+.DS_Store
+node_modules
+/build
+/.svelte-kit
+/package
+/chart
+.env
+.env.*
+!.env.example
+
+# Ignore files for PNPM, NPM and YARN
+pnpm-lock.yaml
+package-lock.json
+yarn.lock

package/src/ruvocal/.prettierrc

@@ -0,0 +1,7 @@
+{
+	"useTabs": true,
+	"trailingComma": "es5",
+	"printWidth": 100,
+	"plugins": ["prettier-plugin-svelte", "prettier-plugin-tailwindcss"],
+	"overrides": [{ "files": "*.svelte", "options": { "parser": "svelte" } }]
+}

package/src/ruvocal/CLAUDE.md

@@ -0,0 +1,126 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Overview
+
+Chat UI is a SvelteKit application that provides a chat interface for LLMs. It powers HuggingChat (hf.co/chat). The app speaks exclusively to OpenAI-compatible APIs via `OPENAI_BASE_URL`.
+
+## Commands
+
+```bash
+npm run dev          # Start dev server on localhost:5173
+npm run build        # Production build
+npm run preview      # Preview production build
+npm run check        # TypeScript validation (svelte-kit sync + svelte-check)
+npm run lint         # Check formatting (Prettier) and linting (ESLint)
+npm run format       # Auto-format with Prettier
+npm run test         # Run all tests (Vitest)
+```
+
+### Running a Single Test
+
+```bash
+npx vitest run path/to/file.spec.ts        # Run specific test file
+npx vitest run -t "test name"              # Run test by name
+npx vitest --watch path/to/file.spec.ts    # Watch mode for single file
+```
+
+### Test Environments
+
+Tests are split into three workspaces (configured in vite.config.ts):
+
+- **Client tests** (`*.svelte.test.ts`): Browser environment with Playwright
+- **SSR tests** (`*.ssr.test.ts`): Node environment for server-side rendering
+- **Server tests** (`*.test.ts`, `*.spec.ts`): Node environment for utilities
+
+## Architecture
+
+### Stack
+
+- **SvelteKit 2** with Svelte 5 (uses runes: `$state`, `$effect`, `$bindable`)
+- **MongoDB** for persistence (auto-fallback to in-memory with MongoMemoryServer when `MONGODB_URL` not set)
+- **TailwindCSS** for styling
+
+### Key Directories
+
+```
+src/
+├── lib/
+│   ├── components/       # Svelte components (chat/, mcp/, voice/, icons/)
+│   ├── server/
+│   │   ├── api/utils/       # Shared API helpers (auth, superjson, model/conversation resolvers)
+│   │   ├── textGeneration/  # LLM streaming pipeline
+│   │   ├── mcp/          # Model Context Protocol integration
+│   │   ├── router/       # Smart model routing (Omni)
+│   │   ├── database.ts   # MongoDB collections
+│   │   ├── models.ts     # Model registry from OPENAI_BASE_URL/models
+│   │   └── auth.ts       # OpenID Connect authentication
+│   ├── types/            # TypeScript interfaces (Conversation, Message, User, Model, etc.)
+│   ├── stores/           # Svelte stores for reactive state
+│   └── utils/            # Helpers (tree/, marked.ts, auth.ts, etc.)
+├── routes/               # SvelteKit file-based routing
+│   ├── conversation/[id]/  # Chat page + streaming endpoint
+│   ├── settings/         # User settings pages
+│   ├── api/              # Legacy v1 API endpoints (mcp, transcribe, fetch-url)
+│   ├── api/v2/           # REST API endpoints (+server.ts)
+│   └── r/[id]/           # Shared conversation view
+```
+
+### Text Generation Flow
+
+1. User sends message via `POST /conversation/[id]`
+2. Server validates user, fetches conversation history
+3. Builds message tree structure (see `src/lib/utils/tree/`)
+4. Calls LLM endpoint via OpenAI client
+5. Streams response back, stores in MongoDB
+
+### Model Context Protocol (MCP)
+
+MCP servers are configured via `MCP_SERVERS` env var. When enabled, tools are exposed as OpenAI function calls. The router can auto-select tools-capable models when `LLM_ROUTER_ENABLE_TOOLS=true`.
+
+### LLM Router (Omni)
+
+Smart routing via Arch-Router model. Configured with:
+
+- `LLM_ROUTER_ROUTES_PATH`: JSON file defining routes
+- `LLM_ROUTER_ARCH_BASE_URL`: Router endpoint
+- Shortcuts: multimodal routes bypass router if `LLM_ROUTER_ENABLE_MULTIMODAL=true`
+
+### Database Collections
+
+- `conversations` - Chat sessions with nested messages
+- `users` - User accounts (OIDC-backed)
+- `sessions` - Session data
+- `sharedConversations` - Public share links
+- `settings` - User preferences
+
+## Environment Setup
+
+Copy `.env` to `.env.local` and configure:
+
+```env
+OPENAI_BASE_URL=https://router.huggingface.co/v1
+OPENAI_API_KEY=hf_***
+# MONGODB_URL is optional; omit for in-memory DB persisted to ./db
+```
+
+See `.env` for full list of variables including router config, MCP servers, auth, and feature flags.
+
+## Code Conventions
+
+- TypeScript strict mode enabled
+- ESLint: no `any`, no non-null assertions
+- Prettier: tabs, 100 char width, Tailwind class sorting
+- Server vs client separation via SvelteKit conventions (`+page.server.ts` vs `+page.ts`)
+
+## Feature Development Checklist
+
+When building new features, consider:
+
+1. **HuggingChat vs self-hosted**: Wrap HuggingChat-specific features with `publicConfig.isHuggingChat`
+2. **Settings persistence**: Add new fields to `src/lib/types/Settings.ts`, update API endpoint at `src/routes/api/v2/user/settings/+server.ts`
+3. **Rich dropdowns**: Use `bits-ui` (Select, DropdownMenu) instead of native elements when you need icons/images in options
+4. **Scrollbars**: Use `scrollbar-custom` class for styled scrollbars
+5. **Icons**: Custom icons in `$lib/components/icons/`, use Carbon (`~icons/carbon/*`) or Lucide (`~icons/lucide/*`) for standard icons
+6. **Provider avatars**: Use `PROVIDERS_HUB_ORGS` from `@huggingface/inference` for HF provider avatar URLs