← Browse

@zuplo/zuplo-2

B

Zuplo API Gateway Examples

rulescursor

Install

agr install @zuplo/zuplo-2 --target cursor

Writes 1 file into .cursor/rules/, pinned to git-655eabe2.

  • .cursorrules

Document

Zuplo API Gateway Examples

You are working in a Zuplo API Gateway examples repository.

Project Structure

  • config/routes.oas.json - OpenAPI routes with x-zuplo-route extensions
  • config/policies.json - Policy configurations
  • modules/*.ts - Custom handlers and policies
  • Tests: npm run test

Code Conventions

  • TypeScript with @zuplo/runtime imports
  • Handlers: export default async function(request: ZuploRequest, context: ZuploContext)
  • Policies: export default async function(request, context, options, policyName)
  • Return Response objects from handlers
  • Return request (continue) or Response (short-circuit) from policies

Common Patterns

  • context.log.info() for logging
  • context.custom for passing data between policies
  • ZoneCache for distributed caching
  • environment.VAR_NAME for env vars

When Modifying Routes

  • Edit config/routes.oas.json
  • Add handler reference in x-zuplo-route.handler
  • Add policies in x-zuplo-route.policies.inbound/outbound

Local Development

Trustgrade B

  • passBody integrity

    Whether the stored document is plausibly the kind of file the artifact declares, rather than something fetched by mistake.

  • passType matchnot applicable to this artifact type

    Whether the artifact is really the kind of thing its metadata claims it is.

  • passFreshness

    How long since the source repository was last pushed to.

  • passPrompt injection

    Scans the artifact's own text for instructions aimed at your agent rather than at you.

  • warnLicenseno SPDX license detected

    Whether the source repository declares an SPDX license permissive enough to redistribute.

How the grade is calculated

Each check contributes 0 points when it passes, 1 when it warns, and 2 when it fails. The total maps to a letter:

  • Aevery check passed
  • Bone warning
  • Ctwo warnings
  • Dprompt injection or body integrity failed, or three warnings
  • Fone of those failed, and something else is wrong

These are automated hygiene checks, not a security audit, and not a dependency or vulnerability scan. A grade of A means nothing was flagged — not that the artifact is safe.

Versions

  • git-655eabe2efa52026-08-06