Files
OmniRoute/docs/i18n/ms/CLAUDE.md
Diego Rodrigues de Sa e Souza f59f8daa94 Release v3.8.6 (#2804)
* fix(gemini): preserve structured tool calls for antigravity

* fix(gemini): parse prefixed textual tool calls

* fix(antigravity): preserve textual SSE tool calls

* fix(stream): normalize textual passthrough tool calls

* fix(stream): normalize split textual tool calls

* fix(stream): suppress malformed textual tool calls

* fix(stream): suppress compact malformed tool calls

* fix(stream): emit structured textual tool calls

* fix(stream): suppress unknown textual tool calls

* fix(stream): normalize responses textual tool calls

* chore: ignore .claude/settings.local.json (per-user Claude Code permissions)

* fix(opencode-go): route qwen3.x via claude messages + repair fixMissingToolResponses for Claude-shape upstreams (#2791)

Integrated into release/v3.8.6

* fix: resolve npm install warnings — remove dead deps, relax engine constraint (#2792)

Integrated into release/v3.8.6

* fix: register missing web-cookie validators (claude-web, gemini-web, copilot-web, t3-web) (#2793)

Integrated into release/v3.8.6

* fix: Error: Unable to inspect existing database #2771 (#2795)

Integrated into release/v3.8.6

* fix(oauth): repair Google loopback callback flow (#2796)

Integrated into release/v3.8.6

* feat(logs): add clean history button (#2799)

Integrated into release/v3.8.6

* [codex] home: restore settings-driven home layout and quota auto-refresh (#2800)

Integrated into release/v3.8.6

* fix(gemini): emit signaturelessToolCallMode:text for GEMINI format models (#2801)

Integrated into release/v3.8.6

* feat(modelSpecs): align opencode-go family with upstream provider limits (#2802)

Integrated into release/v3.8.6

* chore: apply unit test fixes, polyfills, and environment precedence fixes

* docs(agents): atualiza fluxos de release e triagem

Expande os workflows de release para incluir auditoria de segurança,
CHANGELOG completo por commits, quality gate obrigatório, homologação em
VPS local, publicação oficial, deploy em Akamai e validação de artefatos.

Reorganiza a triagem de features com arquivos permanentes por bucket,
suporte a itens em andamento, regra de reclaim após 15 dias e novo
tratamento para ideias viáveis catalogadas.

Corrige a orientação de revisão de discussões para usar a ordem
cronológica real dos comentários e respostas ao identificar a última
atividade.

* fix(lockout): classify Gemini Antigravity resource exhaustion as quota_exhausted

* fix(reasoning): gate replay by interleaved field

* docs(rule-16): permit human Co-authored-by, restrict only AI/bot trailers

Rule #16 previously banned all `Co-Authored-By` trailers absolutely.
That blocked the upstream-port workflows (`/port-upstream-features` and
`/port-upstream-issues`), which must credit human upstream PR authors
and issue reporters in OmniRoute commits.

Refine the rule to ban only AI/bot-attributed trailers (Claude, GPT,
Copilot, Bot; anthropic.com / openai.com / bot-owned noreply.github.com
emails) while allowing standard human `Co-authored-by: Name <email>`
attribution.

Sync the rule across the source CLAUDE.md, the E2E shakedown doc note,
and 41 i18n translations.

* fix(gitlawb): add specialty validators for connection test — bypass /models probe

GitLawB OpenGateway API (xiaomi-mimo compatible) does not expose a /models
endpoint, causing validateOpenAILikeProvider to 404 on the initial probe
and report 'Provider validation endpoint not supported'.

Add specialty validators for both gitlawb and gitlawb-gmi that follow the
same pattern as the existing xiaomi-mimo validator: skip GET /models,
validate directly via POST /chat/completions with a minimal test message.
Any 401/403 response means an invalid key; all other responses mean auth
is OK.

Fixes test-connection returning 404 for GitLawB providers.

* test(gitlawb): add 12 unit tests for gitlawb and gitlawb-gmi specialty validators

Covers success, auth failure (401/403), non-auth acceptance (400/422/429),
network errors, and custom baseUrl overrides for both providers.

* feat(gitlawb): serve models from static registry without API-unavailable warning

GitLawB's OpenGateway API does not expose a /models endpoint per
provider-path. Previously the models route fell through to the generic
fallback which returned static catalog models with the misleading
'API unavailable — using local catalog' warning.

Now gitlawb and gitlawb-gmi are handled as static model providers
(same pattern as reka and qwen OAuth) — models are served from the
provider registry without any warning, since all registered models
are functional via POST /chat/completions.

* refactor(gitlawb): extract shared opengateway validator factory, fix docs path in test

- Extract gitlawb/gitlawb-gmi validators into buildOpengatewayValidator factory
- Fix dockerignore-docs-coverage test: update stale docs/AUTO-COMBO.md -> docs/routing/AUTO-COMBO.md

* fix(reasoning): guard interleaved capability lookup

* feat(gitlawb): dynamic model fetch with gmi-cloud fallback

Hybrid approach:
- gitlawb (xiaomi-mimo): dynamic /models endpoint → 356 models
- gitlawb-gmi (gmi-cloud): 404 fallback → local catalog gracefully
Mimics Gitlawb/openclaude's model-routing pattern

* i18n(pt-BR): complete missing translations and sync with en.json

* feat(build): nix multi-OS package manager install (#2806)

Integrated into release/v3.8.6

* fix(i18n): translate 144 new __MISSING__ pt-BR strings (#2816)

Integrated into release/v3.8.6

* chore(docs): set coverage gate to 40/40/40/40 in CLAUDE.md

Aligns the documented coverage gate with the v3.8.6 release decision
(lowered from 75/75/75/70). Matches the threshold already set in
package.json by the large feature PRs (planos 11-22).

* fix(cli): respect PORT env var in serve command (#2845)

Integrated into release/v3.8.6.

* fix(deepseek-web): return 400 when client sends tools[] - chat.deepseek.com has no tool support (#2854)

Integrated into release/v3.8.6.

* fix(qoder): reject invalid/expired PATs returning Cosy 500 error (#2860)

Integrated into release/v3.8.6.

* fix(cli): register openclaw in tool-detector (#2833) (#2850)

Integrated into release/v3.8.6.

* fix(api): include noAuth providers in /v1/models catalog (#2798) (#2814)

Integrated into release/v3.8.6.

* fix(combo): resolve custom provider targets via combo name (#2778) (#2812)

Integrated into release/v3.8.6.

* fix(translator): strip safety_identifier in openai-responses cleanup (#2770) (#2809)

Integrated into release/v3.8.6.

* fix(quota): honor explicit per-connection preflight opt-out (#2831) (#2844)

Integrated into release/v3.8.6.

* fix(usage): un-invert GitHub Copilot Free/limited quota — limited_user_quotas is remaining (#2876) (#2881)

Integrated into release/v3.8.6.

* fix(nous-research): correct baseUrl to include /chat/completions (#2826) (#2835)

Integrated into release/v3.8.6.

* fix(opencode): qwen3.x max/plus models lack vision support (#2822) (#2836)

Integrated into release/v3.8.6.

* fix(translator): pass-through tool_search built-in tool type (#2766) (#2811)

Integrated into release/v3.8.6.

* fix(github): route claude-opus-4.6 via chat completions (#2821)

Integrated into release/v3.8.6.

* docs(oauth): add Windsurf login fix design (Phase 1 hotfix + Phase 2 Firebase OAuth)

Two-phase plan to fix the broken Windsurf OAuth flow:
- Phase 1: drop the dead app.devin.ai/editor/signin PKCE path, promote
  import-token from windsurf.com/show-auth-token as the primary path
- Phase 2: port Firebase OAuth + RegisterUser flow from
  fendoushaonian/WindSurf-gRPC-API for full browser-based automation

Spec only - no code changes yet.

* docs(plan): Phase 1 windsurf login hotfix implementation plan

10 tasks covering:
- TDD assertions for flowType + 410 Gone responses
- Provider switch to import_token
- Route handler retiring authorize/start-callback-server/poll-callback
- OAuthModal UI override
- i18n sync
- Verification + PR steps

* fix(cli): replace cli-table3 with hand-rolled formatter (#2752) (#2813)

Integrated into release/v3.8.6.

* fix(skills): skip interception for unregistered client-native tools (#2815) (#2817)

Integrated into release/v3.8.6.

* feat(sse): add RTK filters for kubectl, docker-build, composer, gh (#2824)

Integrated into release/v3.8.6.

* fix(geminiHelper): support rec.image content shape + warn on dropped remote URLs (refs #2807) (#2855)

Integrated into release/v3.8.6.

* fix(cli): allow nullable/optional apiKey in cliMitmStartSchema (#2857)

Integrated into release/v3.8.6.

* fix(combo): preserve system messages during context handoff summary generation (#2865)

Integrated into release/v3.8.6.

* fix: wire CLIProxyAPI fallback settings into chatCore routing engine (#2866)

Integrated into release/v3.8.6.

* fix(usage): add opencode quota fetcher (#2852) (#2867)

Integrated into release/v3.8.6.

* feat(claude): default xhigh support for newer Opus models (#2874)

Integrated into release/v3.8.6.

* fix(cli): restore omniroute logs command stream (#2756) (#2810)

Integrated into release/v3.8.6.

* fix(combo): normalize upstream Headers for Node 24 undici interop (#2751) (#2823)

Integrated into release/v3.8.6.

* Rename proxy log Public IP to Client IP (#2880)

Integrated into release/v3.8.6.

* fix(claude): preserve max effort for supported models (#2875)

Integrated into release/v3.8.6.

* fix(oauth): switch windsurf provider to import_token flow

The PKCE auth URL targeting app.devin.ai/editor/signin returns 404
post-rebrand. Until Phase 2 ports Firebase OAuth + RegisterUser, the
only supported path is import-token via windsurf.com/show-auth-token.

- windsurf.ts: drop buildAuthUrl, set flowType=import_token
- generateAuthData returns supported:false + helpful error for windsurf/devin-cli
- tests: assert flowType + disabled stub

* fix(oauth): return 410 Gone for retired windsurf/devin-cli PKCE actions

start-callback-server, authorize, and poll-callback (GET + POST) now
return 410 Gone with a pointer to /import-token. The 410 short-circuit
runs before auth so the response is honest about the action being
permanently gone, not gated. Codex PKCE flow unchanged.

Tests: 5 new assertions cover GET + POST 410 paths and a Codex
regression check.

* refactor(oauth): annotate retired PKCE fields in WINDSURF_CONFIG

No behaviour change - comment-only update documenting that authorizeUrl,
codeChallengeMethod, callbackPort, callbackPath, apiServerUrl, and
exchangePath are no longer consumed. Active fields (inferenceUrl,
showAuthTokenUrl, firebaseApiKey, ideName) called out separately.

* fix(cli,docs): use requireCliToolsAuth in logs route + document OPENCODE quota env

Post-merge contract fixes for v3.8.6:
- src/app/api/cli-tools/logs/route.ts (#2810) now uses the shared
  requireCliToolsAuth guard (param renamed req->request) to satisfy the
  cli-tools-auth-hardening contract test.
- Document OMNIROUTE_OPENCODE_QUOTA_URL (#2867) in docs/reference/ENVIRONMENT.md
  to satisfy the env/docs sync contract.

* fix(dashboard): force import-token panel for windsurf/devin-cli

Phase 1 hotfix: hide the 'Browser Login' tab and start in Paste API Key
mode. Removes windsurf/devin-cli from PKCE_CALLBACK_SERVER_PROVIDERS so
no callback server is started for them. Codex still uses the PKCE flow.

The 'Get token' link continues to point at windsurf.com/show-auth-token
via the existing supportsTokenPaste form copy.

* fix(oauth): windsurf import-token mapTokens signature mismatch

The route at `src/app/api/oauth/[provider]/[action]/route.ts` invokes
`providerData.mapTokens({ accessToken: token })` (object), matching the
cursor/kiro signature. The windsurf provider was declared with
`mapTokens(token: string)` instead, so the entire object was stored as
`accessToken`. When the connection record reached the SQLite layer it
crashed with:

  SQLite3 can only bind numbers, strings, bigints, buffers, and null

Fix by aligning windsurf's `mapTokens` signature with the route caller
and the cursor/kiro convention. Also dedupe a copy-pasted second
`if (action === "import-token")` block in the route handler — the
second block was unreachable but identical to the first.

Adds two regression tests asserting that
`provider.mapTokens({ accessToken })` returns a string `accessToken` for
both windsurf and devin-cli, so a future signature drift trips the gate
instead of the SQLite bind error in production.

* feat(compression): expand pt-BR pack with troglodita rules (15 → 49) (#2818)

Integrated into release/v3.8.6

* fix(sse): repair RTK engine defaults so dedup and direct calls work (#2825)

Integrated into release/v3.8.6

* fix(mcp): redirect console.log/warn to stderr in --mcp stdio mode (#2840)

Integrated into release/v3.8.6

* fix(gemini-cli): prefer real project IDs over default-project (#2841)

Integrated into release/v3.8.6

* fix(opencode-go): add provider limits quota fetcher (#2861)

Integrated into release/v3.8.6

* Audit & add web cookie providers: fix 4 missing registry entries + DuckDuckGo (#2862)

Integrated into release/v3.8.6

* fix(antigravity): harden signatureless tool history (#2878)

Integrated into release/v3.8.6

* fix: provider model sync pruning and dynamic antigravity MITM proxy mappings (#2886)

Integrated into release/v3.8.6

* feat(usage): per-API-key token limits scoped to model/provider/global (#2888)

Integrated into release/v3.8.6

* fix(audio): build multipart body manually to preserve Content-Type (#2842)

Integrated into release/v3.8.6

* refactor: remove agent skill documentation files and streamline maintenance workflows

* test(stabilization): resolve unit test failures in blackbox-web, schema-coercion, translator-helper-branches, usage-service-hardening, and audio-transcription

* fix(security): mitigate Socket.dev supply-chain findings + secrets opt-in + minimal build profile (#2863) (#2871)

Two real security gaps closed and four cosmetic Socket.dev fingerprints removed.
See docs/security/SOCKET_DEV_FINDINGS.md for the per-finding maintainer
attestation.

Real bugs fixed:
- cloudSync: HMAC verification of `X-Cloud-Sig` + opt-in
  `OMNIROUTE_CLOUD_SYNC_SECRETS=true` before overwriting `accessToken` /
  `refreshToken` / `providerSpecificData` from a remote response. Closes the
  silent-credential-swap surface (a misconfigured or hostile CLOUD_URL could
  previously replace local tokens unverified).
- Zed import: split into 2-step `/discover` + `/import` flow. `/import` now
  requires `confirmedAccounts: [{ service, account, fingerprint }]` and
  re-reads the keychain server-side to filter by fingerprint, so a tampered
  discover response cannot trick the endpoint into saving an unrelated token.

Cosmetic Socket.dev mitigations:
- runElevatedPowerShell writes the elevated payload to a per-call temp `.ps1`
  file (mode 0o600) and references it via `-File`. Removes the textbook
  `-EncodedCommand <base64utf16le>` pattern flagged as malware by Socket's AI
  classifier.
- Maintainer attestation `SECURITY-AUDITOR-NOTE:` blocks added at every
  flagged call site pointing to `docs/security/SOCKET_DEV_FINDINGS.md`.

Build-time hardening:
- `OMNIROUTE_BUILD_PROFILE=minimal` (`npm run build:secure`) physically
  removes the four sensitive modules from the standalone bundle via webpack
  `NormalModuleReplacementPlugin`. Stubs throw `FeatureDisabledError` at
  runtime. Intended for the `omniroute-secure` artifact.

Tests:
- 24 new unit tests in `tests/unit/security/` covering the wrapper builder,
  HMAC verification (4 cases), credential fingerprint determinism (5 cases),
  confirmedAccounts validation + fingerprint filtering (6 cases), and the
  minimal-build stubs (5 cases).

Docs:
- New `docs/security/SOCKET_DEV_FINDINGS.md` — per-finding attestation.
- New `socket.yml` — Socket.dev v2 config pointing at the attestation.
- Updated `SECURITY.md` — supply-chain scanner section.
- Updated `.env.example` — three new env vars documented.

Backwards compatibility:
- Cloud sync token overwrite is OFF by default. Users who relied on
  it must set `OMNIROUTE_CLOUD_SYNC_SECRETS=true`. Breaking change documented
  in CHANGELOG.
- Zed import 2-step is the new default; legacy 1-step preserved behind
  `OMNIROUTE_ZED_IMPORT_LEGACY_ONE_STEP=true` and will be removed in v3.9.

Closes #2863

* fix(security): redact public Firebase Web key from windsurf spec; doc SHA-256 cache-key rationale (#2894)

Two security-scanning findings on release/v3.8.6:

- Secret-scanning alert 7 (google_api_key): the windsurf login-fix design spec
  embedded the literal public Firebase Web API key on two lines. Firebase Web
  API keys are non-sensitive by design (they identify the project; access is
  gated by Firebase Security Rules + key restrictions), but the literal trips
  secret scanning. Redacted to a placeholder; the embedded default still goes
  through resolvePublicCred per rule #11.

- Code-scanning alert 261 (js/insufficient-password-hash): tokenCacheKey() uses
  SHA-256 to derive an in-memory cache key from the session token, not for
  password-at-rest storage. Added a comment documenting why CWE-916 KDFs do not
  apply (false positive).

* fix(ci): resolve release/v3.8.6 gate failures (docs-sync, any-budget, pack-artifact) (#2895)

* fix(ci): resolve release/v3.8.6 gate failures (docs-sync, any-budget, pack-artifact)

Three CI gates failed on release/v3.8.6 (run 26630300877):

- docs-sync: CHANGELOG had a spurious "## [3.8.6-patch]" section above
  "## [3.8.6]", so the latest release no longer matched package.json (3.8.6)
  and the 41 i18n CHANGELOG mirrors were flagged as missing that section.
  Fold the lone #2752 entry into [3.8.6] and drop the patch heading.
- any-budget:t11: open-sse/handlers/chatCore.ts regressed to 1 explicit `any`
  (budget 0). Type the persist callback arg as Record<string, unknown>, which
  matches runWithOnPersist's RefreshPersistFn contract exactly.
- pack-artifact: open-sse/utils/setupPolyfill.ts ships via package.json "files"
  (bin/omniroute.mjs imports it at startup) but was missing from the pack
  policy allowlist. Allow it and add a regression test.

* fix(security): redact public Firebase Web key from windsurf spec

Redact the literal public Firebase Web API key (secret-scanning #7) to a
placeholder, mirroring the redaction on release/v3.8.6 (PR #2894) and the
windsurf fix branch. Non-sensitive public Web key; trips secret scanning.

* feat(combo): Zero-Latency Combos (Hedging, Proactive Compression, Predictive TTFT) (#2868)

* feat(combo): implement zero-latency combo optimizations (hedging, proactive compression, predictive TTFT)

* fix(combo): fix predictive TTFT skip logic and unhandled promise rejections

---------

Co-authored-by: Automation <automation@omniroute>

* feat: implement automated skill workflows and update system configuration and validation schemas

* test: eliminate dynamic cast warnings in cloud-sync unit test

* test: isolate services-branch-hardening database directory to avoid concurrency issues

* feat(providers): add 7 new web-cookie providers + research catalog + discovery tool

New providers:
- huggingchat: free LLM chat via huggingface.co/chat (no subscription)
- phind: free dev-focused AI chat via phind.com/api/agent
- poe-web: multi-model chat via poe.com GraphQL (p-b cookie)
- venice-web: privacy-focused AI chat via venice.ai (session cookie)
- v0-vercel-web: Vercel v0 code gen via v0.dev (session cookie)
- kimi-web: Moonshot Kimi chat via kimi.moonshot.cn (session cookie)
- doubao-web: ByteDance Doubao chat via doubao.com (session cookie)

Additional:
- Research catalog: docs/research/UNLIMITED_LLM_ACCESS.md
- Discovery tool design + stub: src/lib/discovery/ + migration 073
- Unit tests: 33 tests for all 7 providers
- Shared helpers consolidated in error.ts (slop cleanup)
- All registered in WEB_COOKIE_PROVIDERS + providerRegistry + webSessionCredentials

Closes #2885

* fix(typecheck): resolve typecheck errors in combo spec and compression modules

* feat(api,oauth): add `agy` (Antigravity CLI) standalone provider with CLI token import (#2899)

Add a standalone OAuth provider `agy` (Antigravity CLI) next to gemini-cli/antigravity.
It reuses the antigravity inference backend (identical Google client_id +
daily-cloudcode-pa.googleapis.com endpoint, executor and token-refresh) but ships its own
model catalog — including the Claude models the backend exposes (claude-opus-4-6-thinking,
claude-sonnet-4-6) — its own account pool, and four ways to connect:

- token-file import (paste/upload the agy oauth token JSON)
- auto-detect a local CLI login (~/.gemini/antigravity-cli/antigravity-oauth-token)
- browser OAuth (via the shared OAuthModal Google loopback flow)
- bulk / ZIP import

New routes: POST /api/providers/agy-auth/{import,import-bulk,zip-extract,apply-local}.
Catalog pinned from the live :fetchAvailableModels endpoint. Docs (openapi.yaml,
ENVIRONMENT.md, .env.example, CHANGELOG) updated; new unit tests for registration,
the token parser, and route auth-hardening.

* fix(security): redact public Firebase Web key from windsurf spec (#2896)

Redact the literal public Firebase Web API key (secret-scanning #7) to a
placeholder. Firebase Web API keys are non-sensitive by design but the literal
trips GitHub secret scanning. Mirrors the redaction landed on release/v3.8.6
(PR #2894). Embedded default still flows through resolvePublicCred (rule #11).

* Pr 2871 (#2897)

* fix(security): mitigate Socket.dev supply-chain findings + secrets opt-in + minimal build profile (#2863)

Two real security gaps closed and four cosmetic Socket.dev fingerprints removed.
See docs/security/SOCKET_DEV_FINDINGS.md for the per-finding maintainer
attestation.

Real bugs fixed:
- cloudSync: HMAC verification of `X-Cloud-Sig` + opt-in
  `OMNIROUTE_CLOUD_SYNC_SECRETS=true` before overwriting `accessToken` /
  `refreshToken` / `providerSpecificData` from a remote response. Closes the
  silent-credential-swap surface (a misconfigured or hostile CLOUD_URL could
  previously replace local tokens unverified).
- Zed import: split into 2-step `/discover` + `/import` flow. `/import` now
  requires `confirmedAccounts: [{ service, account, fingerprint }]` and
  re-reads the keychain server-side to filter by fingerprint, so a tampered
  discover response cannot trick the endpoint into saving an unrelated token.

Cosmetic Socket.dev mitigations:
- runElevatedPowerShell writes the elevated payload to a per-call temp `.ps1`
  file (mode 0o600) and references it via `-File`. Removes the textbook
  `-EncodedCommand <base64utf16le>` pattern flagged as malware by Socket's AI
  classifier.
- Maintainer attestation `SECURITY-AUDITOR-NOTE:` blocks added at every
  flagged call site pointing to `docs/security/SOCKET_DEV_FINDINGS.md`.

Build-time hardening:
- `OMNIROUTE_BUILD_PROFILE=minimal` (`npm run build:secure`) physically
  removes the four sensitive modules from the standalone bundle via webpack
  `NormalModuleReplacementPlugin`. Stubs throw `FeatureDisabledError` at
  runtime. Intended for the `omniroute-secure` artifact.

Tests:
- 24 new unit tests in `tests/unit/security/` covering the wrapper builder,
  HMAC verification (4 cases), credential fingerprint determinism (5 cases),
  confirmedAccounts validation + fingerprint filtering (6 cases), and the
  minimal-build stubs (5 cases).

Docs:
- New `docs/security/SOCKET_DEV_FINDINGS.md` — per-finding attestation.
- New `socket.yml` — Socket.dev v2 config pointing at the attestation.
- Updated `SECURITY.md` — supply-chain scanner section.
- Updated `.env.example` — three new env vars documented.

Backwards compatibility:
- Cloud sync token overwrite is OFF by default. Users who relied on
  it must set `OMNIROUTE_CLOUD_SYNC_SECRETS=true`. Breaking change documented
  in CHANGELOG.
- Zed import 2-step is the new default; legacy 1-step preserved behind
  `OMNIROUTE_ZED_IMPORT_LEGACY_ONE_STEP=true` and will be removed in v3.9.

Closes #2863

* feat: implement automated skill workflows and update system configuration and validation schemas

* test: eliminate dynamic cast warnings in cloud-sync unit test

* test: isolate services-branch-hardening database directory to avoid concurrency issues

* chore(docs): refresh generated docs collection index

Update the generated Fumadocs browser collection mapping to keep
documentation imports in sync with the current docs structure.

* docs: update generated browser docs collection manifest

Refresh the generated Fumadocs browser collection mapping so the docs site can resolve the current documentation files correctly.

---------

Co-authored-by: OpenClaw <openclaw@kuzhomesrv.local>
Co-authored-by: Dmitry Kuznetsov <139351986+dmitry@users.noreply.local>
Co-authored-by: KuzyaBot <kuzya@local>
Co-authored-by: JeferssonLemes <jeferssondev@gmail.com>
Co-authored-by: Paijo <14921983+oyi77@users.noreply.github.com>
Co-authored-by: Markus Hartung <mail@hartmark.se>
Co-authored-by: akarray <akarray@users.noreply.github.com>
Co-authored-by: Apostol Apostolov <theapoapostolov@gmail.com>
Co-authored-by: Hernan Javier Ardila Sanchez <hjasgr@gmail.com>
Co-authored-by: Dmitry Kuznetsov <dmitry@kuznetsov.me>
Co-authored-by: Nikolay Alafuzov <alafuzov_nn@rusklimat.ru>
Co-authored-by: oyi77 <oyi77@users.noreply.github.com>
Co-authored-by: Ronaldo Davi <alltomatos@users.noreply.github.com>
Co-authored-by: levonk <277861+levonk@users.noreply.github.com>
Co-authored-by: Lenine Júnior <lenine@engrene.com.br>
Co-authored-by: Annas Alghoffar <aag.annas@gmail.com>
Co-authored-by: Tushar Agarwal <76201310+Tushar49@users.noreply.github.com>
Co-authored-by: GreatLiu <eurasiaxz@qq.com>
Co-authored-by: yuna amelia <230527278+yunaamelia@users.noreply.github.com>
Co-authored-by: Randi <55005611+rdself@users.noreply.github.com>
Co-authored-by: Container <78986709+disonjer@users.noreply.github.com>
Co-authored-by: nickwizard <35692452+nickwizard@users.noreply.github.com>
Co-authored-by: Rajvardhan Patil <rajvardhanpatil7890@gmail.com>
Co-authored-by: Raxxoor <manker_lol@hotmail.com>
Co-authored-by: Muhammad Mugni Hadi <mugnimaestra3@gmail.com>
Co-authored-by: mi <123757457+soyelmismo@users.noreply.github.com>
Co-authored-by: Automation <automation@omniroute>
2026-05-29 12:44:29 -03:00

411 lines
26 KiB
Markdown

# CLAUDE.md (Bahasa Melayu)
🌐 **Languages:** 🇺🇸 [English](../../../CLAUDE.md) · 🇸🇦 [ar](../ar/CLAUDE.md) · 🇦🇿 [az](../az/CLAUDE.md) · 🇧🇬 [bg](../bg/CLAUDE.md) · 🇧🇩 [bn](../bn/CLAUDE.md) · 🇨🇿 [cs](../cs/CLAUDE.md) · 🇩🇰 [da](../da/CLAUDE.md) · 🇩🇪 [de](../de/CLAUDE.md) · 🇪🇸 [es](../es/CLAUDE.md) · 🇮🇷 [fa](../fa/CLAUDE.md) · 🇫🇮 [fi](../fi/CLAUDE.md) · 🇫🇷 [fr](../fr/CLAUDE.md) · 🇮🇳 [gu](../gu/CLAUDE.md) · 🇮🇱 [he](../he/CLAUDE.md) · 🇮🇳 [hi](../hi/CLAUDE.md) · 🇭🇺 [hu](../hu/CLAUDE.md) · 🇮🇩 [id](../id/CLAUDE.md) · 🇮🇩 [in](../in/CLAUDE.md) · 🇮🇹 [it](../it/CLAUDE.md) · 🇯🇵 [ja](../ja/CLAUDE.md) · 🇰🇷 [ko](../ko/CLAUDE.md) · 🇮🇳 [mr](../mr/CLAUDE.md) · 🇳🇱 [nl](../nl/CLAUDE.md) · 🇳🇴 [no](../no/CLAUDE.md) · 🇵🇭 [phi](../phi/CLAUDE.md) · 🇵🇱 [pl](../pl/CLAUDE.md) · 🇵🇹 [pt](../pt/CLAUDE.md) · 🇧🇷 [pt-BR](../pt-BR/CLAUDE.md) · 🇷🇴 [ro](../ro/CLAUDE.md) · 🇷🇺 [ru](../ru/CLAUDE.md) · 🇸🇰 [sk](../sk/CLAUDE.md) · 🇸🇪 [sv](../sv/CLAUDE.md) · 🇰🇪 [sw](../sw/CLAUDE.md) · 🇮🇳 [ta](../ta/CLAUDE.md) · 🇮🇳 [te](../te/CLAUDE.md) · 🇹🇭 [th](../th/CLAUDE.md) · 🇹🇷 [tr](../tr/CLAUDE.md) · 🇺🇦 [uk-UA](../uk-UA/CLAUDE.md) · 🇵🇰 [ur](../ur/CLAUDE.md) · 🇻🇳 [vi](../vi/CLAUDE.md) · 🇨🇳 [zh-CN](../zh-CN/CLAUDE.md)
---
Fail ini memberikan panduan kepada Claude Code (claude.ai/code) apabila bekerja dengan kod dalam repositori ini.
## Permulaan Pantas
```bash
npm install # Pasang deps (auto-generate .env dari .env.example)
npm run dev # Pelayan dev di http://localhost:20128
npm run build # Pembinaan pengeluaran (Next.js 16 standalone)
npm run lint # ESLint (0 ralat dijangka; amaran adalah sedia ada)
npm run typecheck:core # Semakan TypeScript (seharusnya bersih)
npm run typecheck:noimplicit:core # Semakan ketat (tiada implicit any)
npm run test:coverage # Ujian unit + pintu liputan (75/75/75/70 — kenyataan/garis/fungsi/cabang)
npm run check # lint + ujian digabungkan
npm run check:cycles # Mengesan kebergantungan bulat
```
### Menjalankan Ujian
```bash
# Fail ujian tunggal (penjalur ujian asli Node.js — kebanyakan ujian)
node --import tsx/esm --test tests/unit/your-file.test.ts
# Vitest (pelayan MCP, autoCombo, cache)
npm run test:vitest
# Semua suite
npm run test:all
```
Untuk matriks ujian penuh, lihat `CONTRIBUTING.md` → "Menjalankan Ujian". Untuk seni bina mendalam, lihat `AGENTS.md`.
---
## Projek Secara Ringkas
**OmniRoute** — proksi/router AI yang bersatu. Satu titik akhir, 160+ penyedia LLM, auto-fallback.
| Lapisan | Lokasi | Tujuan |
| ------------- | ----------------------- | -------------------------------------------------------------------- |
| API Routes | `src/app/api/v1/` | Penghala Aplikasi Next.js — titik masuk |
| Handlers | `open-sse/handlers/` | Pemprosesan permintaan (chat, embeddings, dll) |
| Executors | `open-sse/executors/` | Penghantaran HTTP khusus penyedia |
| Translators | `open-sse/translator/` | Penukaran format (OpenAI↔Claude↔Gemini) |
| Transformer | `open-sse/transformer/` | API Respons ↔ Penyelesaian Chat |
| Services | `open-sse/services/` | Penghalaan combo, had kadar, caching, dll |
| Database | `src/lib/db/` | Modul domain SQLite (45+ fail, 55 migrasi) |
| Domain/Policy | `src/domain/` | Enjin dasar, peraturan kos, logik fallback |
| MCP Server | `open-sse/mcp-server/` | 37 alat (30 asas + 3 memori + 4 kemahiran), 3 pengangkutan, ~13 skop |
| A2A Server | `src/lib/a2a/` | Protokol agen JSON-RPC 2.0 |
| Skills | `src/lib/skills/` | Rangka kerja kemahiran yang boleh diperluas |
| Memory | `src/lib/memory/` | Memori perbualan yang berterusan |
Monorepo: `src/` (aplikasi Next.js 16), `open-sse/` (workspace enjin streaming), `electron/` (aplikasi desktop), `tests/`, `bin/` (titik masuk CLI).
---
## Saluran Permintaan
```
Klien → /v1/chat/completions (laluan Next.js)
→ CORS → pengesahan Zod → auth? → semakan polisi → pengawal suntikan prompt
→ handleChatCore() [open-sse/handlers/chatCore.ts]
→ semakan cache → had kadar → penghalaan combo?
→ resolveComboTargets() → handleSingleModel() bagi setiap sasaran
→ translateRequest() → getExecutor() → executor.execute()
→ fetch() upstream → retry w/ backoff
→ terjemahan respons → aliran SSE atau JSON
→ Jika API Respons: responsesTransformer.ts TransformStream
```
Laluan API mengikuti pola yang konsisten: `Laluan → CORS preflight → pengesahan badan Zod → Auth pilihan (extractApiKey/isValidApiKey) → penguatkuasaan polisi kunci API → Delegasi Pengendali (open-sse)`. Tiada middleware global Next.js — pemotongan adalah khusus untuk laluan.
**Penghalaan combo** (`open-sse/services/combo.ts`): 14 strategi (keutamaan, berat, isi dahulu, bulatan, P2C, rawak, paling kurang digunakan, dioptimumkan kos, sedar reset, rawak ketat, auto, lkgp, dioptimumkan konteks, relay konteks). Setiap sasaran memanggil `handleSingleModel()` yang membungkus `handleChatCore()` dengan pengendalian ralat per-sasaran dan semakan pemutus litar. Lihat `docs/routing/AUTO-COMBO.md` untuk penilaian Auto-Combo 9 faktor dan `docs/architecture/RESILIENCE_GUIDE.md` untuk 3 lapisan ketahanan.
---
## Keadaan Runtime Ketahanan
OmniRoute mempunyai tiga mekanisme kegagalan sementara yang berkaitan tetapi berbeza. Pastikan skop mereka terpisah semasa menyahpepijat tingkah laku penghalaan. Lihat
[rajah ketahanan 3-lapisan](./docs/diagrams/exported/resilience-3layers.svg)
(sumber: [docs/diagrams/resilience-3layers.mmd](./docs/diagrams/resilience-3layers.mmd))
untuk peta ringkas.
### Pemutus Litar Penyedia
**Skop**: keseluruhan penyedia, contohnya `glm`, `openai`, `anthropic`.
**Tujuan**: menghentikan penghantaran trafik kepada penyedia yang berulang kali gagal di
peringkat upstream/perkhidmatan, supaya satu penyedia yang tidak sihat tidak melambatkan setiap permintaan.
**Pelaksanaan**:
- Kelas teras: `src/shared/utils/circuitBreaker.ts`
- Penghantaran pintu/pendawaian pelaksanaan: `src/sse/handlers/chatHelpers.ts`, `src/sse/handlers/chat.ts`
- API status runtime: `src/app/api/monitoring/health/route.ts`
- Pembungkus bersama: `open-sse/services/accountFallback.ts`
- Jadual keadaan yang dipersisten: `domain_circuit_breakers`
**Keadaan**:
- `CLOSED`: trafik normal dibenarkan.
- `OPEN`: penyedia disekat sementara; pemanggil mendapat respons pemutus-litar-penyedia-terbuka
atau penghalaan combo melangkau ke sasaran lain.
- `HALF_OPEN`: masa tamat reset telah berlalu; benarkan permintaan probe. Kejayaan menutup
pemutus, kegagalan membukanya semula.
**Tetapan Lalai** (`open-sse/config/constants.ts`):
- Penyedia OAuth: ambang `3`, masa tamat reset `60s`.
- Penyedia kunci API: ambang `5`, masa tamat reset `30s`.
- Penyedia tempatan: ambang `2`, masa tamat reset `15s`.
Hanya status kegagalan peringkat penyedia yang seharusnya mencetuskan pemutus penyedia:
```ts
(408, 500, 502, 503, 504);
```
Jangan mencetuskan pemutus penyedia keseluruhan untuk kesalahan akaun/kunci/model normal seperti kebanyakan
kes `401`, `403`, atau `429`. Kes-kes tersebut biasanya berkaitan dengan cooldown sambungan atau penguncian model. Penyedia kunci API generik `403` seharusnya boleh dipulihkan kecuali ia diklasifikasikan
sebagai kesalahan penyedia/akaun terminal.
Pemutus menggunakan pemulihan malas, bukan pemasa latar belakang. Apabila `OPEN` tamat, bacaan seperti `getStatus()`, `canExecute()`, dan `getRetryAfterMs()` menyegarkan keadaan kepada
`HALF_OPEN`, supaya papan pemuka dan pembina calon combo tidak terus mengecualikan penyedia yang tamat selama-lamanya.
### Cooldown Sambungan
**Skop**: satu sambungan penyedia/akaun/kunci.
**Tujuan**: melangkau sementara satu kunci/akaun yang buruk sambil membenarkan sambungan lain untuk
penyedia yang sama terus memenuhi permintaan.
**Pelaksanaan**:
- Laluan tulis/kemas kini: `src/sse/services/auth.ts::markAccountUnavailable()`
- Pemilihan/pengasingan akaun: `src/sse/services/auth.ts::getProviderCredentials...`
- Pengiraan cooldown: `open-sse/services/accountFallback.ts::checkFallbackError()`
- Tetapan: `src/lib/resilience/settings.ts`
Medan penting pada sambungan penyedia:
```ts
rateLimitedUntil;
testStatus: "unavailable";
lastError;
lastErrorType;
errorCode;
backoffLevel;
```
Semasa pemilihan akaun, sambungan dilangkau sementara:
```ts
new Date(rateLimitedUntil).getTime() > Date.now();
```
Cooldown juga malas: apabila `rateLimitedUntil` berada di masa lalu, sambungan menjadi
layak semula. Pada penggunaan yang berjaya, `clearAccountError()` membersihkan `testStatus`,
`rateLimitedUntil`, medan ralat, dan `backoffLevel`.
Tingkah laku cooldown sambungan lalai:
- Cooldown asas OAuth: `5s`.
- Cooldown asas kunci API: `3s`.
- Kunci API `429` seharusnya lebih mengutamakan petunjuk retry upstream (`Retry-After`, header reset, atau
teks reset yang boleh dibaca) apabila tersedia.
- Kegagalan boleh dipulihkan yang berulang menggunakan backoff eksponen:
```ts
baseCooldownMs * 2 ** failureIndex;
```
Pengawal anti-thundering-herd menghalang kegagalan serentak pada sambungan yang sama daripada
berulang kali melanjutkan cooldown atau meningkatkan `backoffLevel` dua kali ganda.
Keadaan terminal bukan cooldown. `banned`, `expired`, dan `credits_exhausted` adalah
dimaksudkan untuk kekal tidak tersedia sehingga kelayakan/tetapan berubah atau seorang pengendali menetapkannya semula. Jangan menulis semula keadaan terminal dengan keadaan cooldown sementara.
### Penguncian Model
**Skop**: penyedia + sambungan + model.
**Tujuan**: mengelakkan melumpuhkan keseluruhan sambungan apabila hanya satu model tidak tersedia atau
had kuota untuk sambungan tersebut.
Contoh:
- Penyedia kuota per-model yang mengembalikan `429`.
- Penyedia tempatan yang mengembalikan `404` untuk satu model yang hilang.
- Kegagalan kebenaran mod/model khusus penyedia seperti mod Grok yang dipilih.
Penguncian model hidup dalam `open-sse/services/accountFallback.ts` dan membenarkan sambungan yang sama terus memenuhi model lain.
### Panduan Menyahpepijat
- Jika semua kunci untuk penyedia dilangkau, periksa kedua-dua keadaan pemutus penyedia dan setiap
`rateLimitedUntil`/`testStatus` sambungan.
- Jika penyedia kelihatan kekal dikecualikan selepas tetingkap reset, semak sama ada kod
membaca `state` mentah dan bukannya menggunakan `getStatus()`/`canExecute()`.
- Jika satu kunci penyedia gagal tetapi yang lain seharusnya berfungsi, lebih baik menggunakan cooldown sambungan daripada
pemutus penyedia.
- Jika hanya satu model gagal, lebih baik menggunakan penguncian model daripada cooldown sambungan.
- Jika satu keadaan seharusnya pulih sendiri, ia seharusnya mempunyai cap waktu/reset masa depan dan laluan bacaan yang menyegarkan keadaan yang tamat. Status kekal memerlukan perubahan kelayakan
atau konfigurasi secara manual.
## Konvensyen Utama
### Gaya Kod
- **2 ruang**, titik koma, petikan berganda, lebar 100 aksara, koma akhir es5 (dikuatkuasakan oleh lint-staged melalui Prettier)
- **Import**: luaran → dalaman (`@/`, `@omniroute/open-sse`) → relatif
- **Penamaan**: fail=camelCase/kebab, komponen=PascalCase, pemalar=UPPER_SNAKE
- **ESLint**: `no-eval`, `no-implied-eval`, `no-new-func` = ralat di mana-mana; `no-explicit-any` = amaran dalam `open-sse/` dan `tests/`
- **TypeScript**: `strict: false`, sasaran ES2022, modul esnext, resolusi bundler. Utamakan jenis eksplisit.
### Pangkalan Data
- **Sentiasa** melalui modul domain `src/lib/db/`**jangan sekali-kali** menulis SQL mentah dalam laluan atau pengendali
- **Jangan sekali-kali** menambah logik ke dalam `src/lib/localDb.ts` (lapisan re-export sahaja)
- **Jangan sekali-kali** mengimport dari `localDb.ts` — import modul `db/` tertentu sebaliknya
- DB singleton: `getDbInstance()` dari `src/lib/db/core.ts` (penulisan jurnal WAL)
- Migrasi: `src/lib/db/migrations/` — fail SQL versi, idempotent, dijalankan dalam transaksi
### Pengendalian Ralat
- try/catch dengan jenis ralat tertentu, log dengan konteks pino
- Jangan sekali-kali menelan ralat dalam aliran SSE — gunakan isyarat abort untuk pembersihan
- Kembalikan kod status HTTP yang betul (4xx/5xx)
### Keselamatan
- **Jangan sekali-kali** menggunakan `eval()`, `new Function()`, atau eval tersirat
- Sahkan semua input dengan skema Zod
- Enkripsi kredensial dalam keadaan rehat (AES-256-GCM)
- Senarai denylist header upstream: `src/shared/constants/upstreamHeaders.ts` — pastikan sanitasi, skema Zod, dan ujian unit selaras semasa mengedit
- **Kredensial upstream awam** (Gemini/Antigravity/Windsurf-style OAuth client_id/secret + kunci Web Firebase yang diekstrak dari CLI awam): **HARUS** disematkan melalui `resolvePublicCred()` dari `open-sse/utils/publicCreds.ts`**jangan sekali-kali** sebagai literal string. Lihat `docs/security/PUBLIC_CREDS.md` untuk pola yang wajib.
- **Respons ralat** (HTTP / SSE / pengendali executor / MCP): **HARUS** melalui `buildErrorBody()` atau `sanitizeErrorMessage()` dari `open-sse/utils/error.ts`**jangan sekali-kali** meletakkan `err.stack` atau `err.message` mentah dalam badan respons. Lihat `docs/security/ERROR_SANITIZATION.md`.
- **Perintah shell yang dibina dari pembolehubah**: apabila memanggil `exec()`/`spawn()` dengan skrip yang memerlukan nilai runtime, hantarkan melalui pilihan `env` (automatik di-escape shell) — **jangan sekali-kali** interpolasi string laluan tidak dipercayai/luaran ke dalam badan skrip. Rujukan: `src/mitm/cert/install.ts::updateNssDatabases`.
- **Perpustakaan yang selamat secara lalai** ([tldrsec/awesome-secure-defaults](https://github.com/tldrsec/awesome-secure-defaults)): utamakan Helmet.js, DOMPurify, ssrf-req-filter, safe-regex, Google Tink berbanding pelaksanaan khusus apabila menambah permukaan sensitif keselamatan yang baru.
---
## Senario Pengubahsuaian Biasa
### Menambah Penyedia Baru
1. Daftar dalam `src/shared/constants/providers.ts` (disahkan Zod semasa memuat)
2. Tambah executor dalam `open-sse/executors/` jika logik khusus diperlukan (lanjutan `BaseExecutor`)
3. Tambah penterjemah dalam `open-sse/translator/` jika format bukan OpenAI
4. Tambah konfigurasi OAuth dalam `src/lib/oauth/constants/oauth.ts` jika berasaskan OAuth — jika CLI upstream menghantar client_id/secret awam, sematkan melalui `resolvePublicCred()` (lihat `docs/security/PUBLIC_CREDS.md`), **jangan sekali-kali** sebagai literal
5. Daftar model dalam `open-sse/config/providerRegistry.ts`
6. Tulis ujian dalam `tests/unit/` (sertakan pengesahan bentuk publicCreds jika anda menambah default yang disematkan baru)
### Menambah Laluan API Baru
1. Buat direktori di bawah `src/app/api/v1/your-route/`
2. Buat `route.ts` dengan pengendali `GET`/`POST`
3. Ikuti pola: CORS → pengesahan badan Zod → pengesahan pilihan → delegasi pengendali
4. Pengendali pergi ke dalam `open-sse/handlers/` (import dari situ, bukan dalam talian)
5. Respons ralat menggunakan `buildErrorBody()` / `errorResponse()` dari `open-sse/utils/error.ts` (auto-sanitized — jangan sekali-kali meletakkan `err.stack` atau `err.message` mentah dalam badan). Lihat `docs/security/ERROR_SANITIZATION.md`.
6. Tambah ujian — termasuk sekurang-kurangnya satu pengesahan bahawa respons ralat tidak bocorkan jejak tumpukan (`!body.error.message.includes("at /")`)
### Menambah Modul DB Baru
1. Buat `src/lib/db/yourModule.ts` — import `getDbInstance` dari `./core.ts`
2. Eksport fungsi CRUD untuk jadual domain anda
3. Tambah migrasi dalam `src/lib/db/migrations/` jika jadual baru diperlukan
4. Re-export dari `src/lib/localDb.ts` (tambahkan ke senarai re-export sahaja)
5. Tulis ujian
### Menambah Alat MCP Baru
1. Tambah definisi alat dalam `open-sse/mcp-server/tools/` dengan skema input Zod + pengendali asinkron
2. Daftar dalam set alat (disambungkan oleh `createMcpServer()`)
3. Tugaskan kepada skop yang sesuai
4. Tulis ujian (panggilan alat dicatat ke dalam jadual `mcp_audit`)
### Menambah Kemahiran A2A Baru
1. Buat kemahiran dalam `src/lib/a2a/skills/` (5 sudah ada: smart-routing, quota-management, provider-discovery, cost-analysis, health-report)
2. Kemahiran menerima konteks tugas (mesej, metadata) → mengembalikan hasil terstruktur
3. Daftar dalam `A2A_SKILL_HANDLERS` dalam `src/lib/a2a/taskExecution.ts`
4. Dedahkan dalam `src/app/.well-known/agent.json/route.ts` (Kad Ejen)
5. Tulis ujian dalam `tests/unit/`
6. Dokumentasikan dalam jadual kemahiran `docs/frameworks/A2A-SERVER.md`
### Menambah Ejen Cloud Baru
1. Buat kelas ejen dalam `src/lib/cloudAgent/agents/` yang memperluas `CloudAgentBase` (3 sudah ada: codex-cloud, devin, jules)
2. Laksanakan `createTask`, `getStatus`, `approvePlan`, `sendMessage`, `listSources`
3. Daftar dalam `src/lib/cloudAgent/registry.ts`
4. Tambah pengendalian OAuth/kredensial jika perlu (`src/lib/oauth/providers/`)
5. Ujian + dokumentasikan dalam `docs/frameworks/CLOUD_AGENT.md`
### Menambah Garis Panduan / Eval / Kemahiran / Acara Webhook Baru
- Garis panduan: `src/lib/guardrails/` → dokumen: `docs/security/GUARDRAILS.md`
- Suite Eval: `src/lib/evals/` → dokumen: `docs/frameworks/EVALS.md`
- Kemahiran (sandbox): `src/lib/skills/` → dokumen: `docs/frameworks/SKILLS.md`
- Acara Webhook: `src/lib/webhookDispatcher.ts` → dokumen: `docs/frameworks/WEBHOOKS.md`
## Dokumentasi Rujukan
Untuk sebarang perubahan yang tidak remeh, baca analisis mendalam yang sepadan terlebih dahulu:
| Kawasan | Dokumen |
| ---------------------------------------------- | ----------------------------------------------------------------- |
| Navigasi repo | `docs/architecture/REPOSITORY_MAP.md` |
| Seni bina | `docs/architecture/ARCHITECTURE.md` |
| Rujukan kejuruteraan | `docs/architecture/CODEBASE_DOCUMENTATION.md` |
| Auto-Combo (penilaian 9 faktor, 14 strategi) | `docs/routing/AUTO-COMBO.md` |
| Ketahanan (3 mekanisme) | `docs/architecture/RESILIENCE_GUIDE.md` |
| Ulangan penaakulan | `docs/routing/REASONING_REPLAY.md` |
| Rangka kerja kemahiran | `docs/frameworks/SKILLS.md` |
| Sistem memori (FTS5 + Qdrant) | `docs/frameworks/MEMORY.md` |
| Ejen awan | `docs/frameworks/CLOUD_AGENT.md` |
| Garis panduan (PII / suntikan / visi) | `docs/security/GUARDRAILS.md` |
| Kelayakan awam hulu (Gemini/dll.) | `docs/security/PUBLIC_CREDS.md` |
| Pembersihan mesej ralat | `docs/security/ERROR_SANITIZATION.md` |
| Penilaian | `docs/frameworks/EVALS.md` |
| Pematuhan / audit | `docs/security/COMPLIANCE.md` |
| Webhook | `docs/frameworks/WEBHOOKS.md` |
| Saluran pengesahan | `docs/architecture/AUTHZ_GUIDE.md` |
| Stealth (TLS / cap jari) | `docs/security/STEALTH_GUIDE.md` |
| Protokol ejen (A2A / ACP / Awan) | `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md` |
| Pelayan MCP | `docs/frameworks/MCP-SERVER.md` |
| Pelayan A2A | `docs/frameworks/A2A-SERVER.md` |
| Rujukan API + OpenAPI | `docs/reference/API_REFERENCE.md` + `docs/reference/openapi.yaml` |
| Katalog penyedia (dihasilkan secara automatik) | `docs/reference/PROVIDER_REFERENCE.md` |
| Aliran pelepasan | `docs/ops/RELEASE_CHECKLIST.md` |
---
## Ujian
| Apa | Perintah |
| ----------------------- | ---------------------------------------------------------------------- |
| Ujian unit | `npm run test:unit` |
| Fail tunggal | `node --import tsx/esm --test tests/unit/file.test.ts` |
| Vitest (MCP, autoCombo) | `npm run test:vitest` |
| E2E (Playwright) | `npm run test:e2e` |
| Protokol E2E (MCP+A2A) | `npm run test:protocols:e2e` |
| Ekosistem | `npm run test:ecosystem` |
| Pintu liputan | `npm run test:coverage` (75/75/75/70 — pernyataan/garis/fungsi/cabang) |
| Laporan liputan | `npm run coverage:report` |
**Peraturan PR**: Jika anda mengubah kod pengeluaran dalam `src/`, `open-sse/`, `electron/`, atau `bin/`, anda mesti menyertakan atau mengemas kini ujian dalam PR yang sama.
**Keutamaan lapisan ujian**: unit pertama → integrasi (multi-modul atau keadaan DB) → e2e (UI/aliran sahaja). Kodkan pengulangan pepijat sebagai ujian automatik sebelum atau bersama dengan pembetulan.
**Dasar liputan Copilot**: Apabila PR mengubah kod pengeluaran dan liputan berada di bawah 75% (pernyataan/garis/fungsi) atau 70% (cabang), jangan hanya laporkan — tambah atau kemas kini ujian, jalankan semula pintu liputan, kemudian minta pengesahan. Sertakan perintah yang dijalankan, fail ujian yang diubah, dan hasil liputan akhir dalam laporan PR.
---
## Aliran Kerja Git
```bash
# Jangan pernah komit terus ke main
git checkout -b feat/your-feature
git commit -m "feat: terangkan perubahan anda"
git push -u origin feat/your-feature
```
**Awalan cawangan**: `feat/`, `fix/`, `refactor/`, `docs/`, `test/`, `chore/`
**Format komit** (Komit Konvensional): `feat(db): tambah pemutus litar` — skop: `db`, `sse`, `oauth`, `dashboard`, `api`, `cli`, `docker`, `ci`, `mcp`, `a2a`, `memory`, `skills`
**Pautan Husky**:
- **pre-commit**: lint-staged + `check-docs-sync` + `check:any-budget:t11`
- **pre-push**: `npm run test:unit`
---
## Persekitaran
- **Runtime**: Node.js ≥20.20.2 <21 || ≥22.22.2 <23 || ≥24 <25, Modul ES
- **TypeScript**: 5.9+, sasaran ES2022, modul esnext, resolusi bundler
- **Alias laluan**: `@/*``src/`, `@omniroute/open-sse``open-sse/`, `@omniroute/open-sse/*``open-sse/*`
- **Port lalai**: 20128 (API + papan pemuka pada port yang sama)
- **Direktori data**: `DATA_DIR` env var, lalai kepada `~/.omniroute/`
- **Variabel env utama**: `PORT`, `JWT_SECRET`, `API_KEY_SECRET`, `INITIAL_PASSWORD`, `REQUIRE_API_KEY`, `APP_LOG_LEVEL`
- Persediaan: `cp .env.example .env` kemudian hasilkan `JWT_SECRET` (`openssl rand -base64 48`) dan `API_KEY_SECRET` (`openssl rand -hex 32`)
---
## Peraturan Ketat
1. Jangan pernah komit rahsia atau kelayakan
2. Jangan pernah tambah logik ke `localDb.ts`
3. Jangan pernah gunakan `eval()` / `new Function()` / eval tersirat
4. Jangan pernah komit terus ke `main`
5. Jangan pernah menulis SQL mentah dalam laluan — gunakan modul `src/lib/db/`
6. Jangan pernah menelan ralat secara senyap dalam aliran SSE
7. Sentiasa sahkan input dengan skema Zod
8. Sentiasa sertakan ujian apabila mengubah kod pengeluaran
9. Liputan mesti kekal ≥75% (pernyataan, garis, fungsi) / ≥70% (cabang). Ukuran semasa: ~82%.
10. Jangan pernah mengabaikan pautan Husky (`--no-verify`, `--no-gpg-sign`) tanpa kelulusan pengendali yang jelas.
11. Jangan pernah menyematkan client_id/secret OAuth awam atau kunci Web Firebase sebagai literal rentetan — sentiasa melalui `resolvePublicCred()` (`open-sse/utils/publicCreds.ts`). Lihat `docs/security/PUBLIC_CREDS.md`.
12. Jangan pernah mengembalikan `err.stack` / `err.message` mentah dalam HTTP / SSE / respons pelaksana — sentiasa lalui `buildErrorBody()` atau `sanitizeErrorMessage()` (`open-sse/utils/error.ts`). Lihat `docs/security/ERROR_SANITIZATION.md`.
13. Jangan pernah interpolasi rentetan laluan luaran atau nilai runtime ke dalam skrip shell yang dihantar kepada `exec()`/`spawn()` — hantarkan melalui pilihan `env` sebaliknya. Rujukan: `src/mitm/cert/install.ts::updateNssDatabases`.
14. Jangan pernah menolak amaran CodeQL / Pengimbasan Rahsia tanpa (a) terlebih dahulu memeriksa dokumen pola di atas untuk melihat jika pembantu terpakai, dan (b) merekodkan justifikasi teknikal dalam komen penolakan. Preseden: `js/stack-trace-exposure` yang dibangkitkan pada callsites yang sudah lalui `sanitizeErrorMessage()` adalah batasan CodeQL yang diketahui (pembersih khusus tidak dikenali) — tolak sebagai `false positive` merujuk kepada `docs/security/ERROR_SANITIZATION.md`.
15. Jangan pernah mendedahkan laluan yang memulakan proses anak (`/api/mcp/`, `/api/cli-tools/runtime/`) tanpa klasifikasi `isLocalOnlyPath()` dalam `src/server/authz/routeGuard.ts`. Penguatkuasaan loopback berlaku tanpa syarat sebelum sebarang semakan pengesahan — JWT yang bocor melalui terowong tidak boleh mencetuskan pemulaan proses. Lihat `docs/security/ROUTE_GUARD_TIERS.md`.
16. Jangan sekali-kali sertakan trailer `Co-Authored-By` yang mengkreditkan pembantu AI, LLM, atau akaun automasi (cth. nama yang mengandungi "Claude", "GPT", "Copilot", "Bot"; emel di `anthropic.com` / `openai.com` / alamat `noreply.github.com` milik bot). Trailer sebegitu mengarahkan atribusi commit kepada akaun bot di GitHub, menyembunyikan penulis sebenar (`diegosouzapw`) dalam sejarah PR. Penyumbang manusia — termasuk penulis PR upstream dan pelapor issue yang diport ke OmniRoute — BOLEH dan SEPATUTNYA dikreditkan dengan trailer standard `Co-authored-by: Name <email>`; aliran kerja upstream-port (`/port-upstream-features`, `/port-upstream-issues`) bergantung pada ini.