Skip to content

README.md

Latest commit

 

History

History
85 lines (64 loc) · 3.91 KB

README.md

File metadata and controls

85 lines (64 loc) · 3.91 KB

Frontend API Contract

@cortexpilot/frontend-api-contract is the repo-owned contract package for frontend-safe CortexPilot route names, query shapes, and generated types.

Current package boundary: this package is still a private workspace package. The truthful adoption path today is repo-local consumption, clone-and-reuse, or vendored internal reuse, not registry install from npm.

What lives here

  • index.d.ts: stable root entrypoint that re-exports the generated contract surface for the main API layer
  • ui-flow.d.ts: stable root entrypoint that re-exports generated UI-flow types for frontend consumers
  • generated/index.d.ts: current generated contract-facing exports for the main API surface
  • generated/ui-flow.d.ts: current generated UI-flow-facing exports
  • stable import boundaries for frontend packages that should not import backend modules directly

What this package is for

Use this package when you want:

  • route and query names that stay aligned with the generated frontend contract
  • typed control-plane read surfaces without importing backend modules
  • a stable contract layer below @cortexpilot/frontend-api-client

What this package is not

  • not a hosted SDK
  • not a public marketplace artifact
  • not a published Codex / Claude Code / OpenClaw listing
  • not a replacement for the read-only MCP server

Shortest truthful onboarding order

  1. Start with the public compatibility matrix when your team still needs the shortest “which adoption ladder fits us?” answer.
  2. Continue to the public agent starter kits when your next move is wiring a real Codex / Claude Code / OpenClaw config instead of only reading the route map.
  3. Continue to the public API quickstart when you want the human-readable HTTP boundary.
  4. Continue to the public builder quickstart when you want the package map.
  5. Import @cortexpilot/frontend-api-contract when you are working inside the same repo or a vendored workspace copy and need generated route/query/type truth without backend imports.

Ecosystem reality anchors

If you are integrating this package into a broader coding-agent workflow, confirm the host tool's native surface first:

Then keep the CortexPilot package story honest:

  • this contract package is for frontend-safe route/query/type truth
  • it sits below the thin client and beside the shared presentation substrate
  • it does not turn CortexPilot into an official plugin, marketplace artifact, or hosted SDK

Key entrypoints

  • ../index.d.ts: current generated contract exports
  • ../ui-flow.d.ts: generated UI-flow exports
  • ../../frontend-api-client/README.md: thin client layer that sits above this contract package
  • ../../frontend-shared/README.md: shared presentation substrate that sits beside this package

Vendored workspace reminder

If you are reusing this contract package outside the repo today, keep the boundary honest:

  • copy it as part of a vendored workspace or clone, not as an implied registry install
  • pair it with @cortexpilot/frontend-api-client when you want a runnable bootstrap path instead of raw route/type truth only
  • keep the public explanation anchored on compatibility / integrations / read-only MCP / skills, not on a fake marketplace or official plugin story