Detect: Middleware Detection

npm install @kya-os/checkpoint-nextjs

npm install @kya-os/checkpoint-express

// middleware.ts
import { withCheckpointApi } from '@kya-os/checkpoint-nextjs/api-middleware';

export default withCheckpointApi({
  apiKey: process.env.CHECKPOINT_API_KEY!, // optional — falls back to CHECKPOINT_API_KEY
});

export const config = {
  matcher: [
    // Match all paths except static assets
    '/((?!_next/static|_next/image|favicon.ico|.*\\.(?:svg|png|jpg|jpeg|gif|webp)$).*)',
  ],
};

// app.ts or server.ts
import express from 'express';
import { withCheckpoint } from '@kya-os/checkpoint-express';

const app = express();

app.use(
  withCheckpoint({
    tenantHost: 'acme.checkpoint.example', // your tenant hostname from the dashboard
    apiKey: process.env.CHECKPOINT_API_KEY!, // reports detections to the dashboard
    enforcementMode: 'observe', // detection-only — pass everything through
    onResult: (result, req) => {
      const d = result.detectionDetail;
      if (d.detectedAgent) {
        console.log(`Detected ${d.detectedAgent.name} (${d.confidence}%) on ${req.path}`);
      }
    },
  })
);

app.get('/', (req, res) => {
  res.json({ message: 'Hello!' });
});

app.listen(3000, () => {
  console.log('Server running on http://localhost:3000');
});

// middleware.ts
import { withCheckpointApi } from '@kya-os/checkpoint-nextjs/api-middleware';

export default withCheckpointApi({
  apiKey: process.env.CHECKPOINT_API_KEY!,
  onAgentDetected: async (request, decision) => {
    console.log(
      JSON.stringify({
        event: 'agent_detected',
        agent: decision.agentName, // e.g. 'ChatGPT' (may be undefined)
        agentType: decision.agentType,
        confidence: decision.confidence, // 0–100
        action: decision.action, // policy decision: 'allow' | 'block' | 'redirect' | …
        path: request.nextUrl.pathname,
        timestamp: new Date().toISOString(),
      })
    );

    // Send to your analytics/monitoring
    // await logToDatadog(decision);
    // await sendToSlack(decision);
  },
});

export const config = {
  matcher: ['/((?!_next/static|_next/image|favicon.ico|.*\\.(?:svg|png|jpg|jpeg|gif|webp)$).*)'],
};

// app.ts
import express from 'express';
import cookieParser from 'cookie-parser';
import { withCheckpoint, withSessionTracking } from '@kya-os/checkpoint-express';
import type { AgentShieldRequest } from '@kya-os/checkpoint-express';

const app = express();
app.use(cookieParser());

app.use(
  withSessionTracking(
    withCheckpoint({
      tenantHost: 'acme.checkpoint.example',
      apiKey: process.env.CHECKPOINT_API_KEY!,
      enforcementMode: 'observe',
    }),
    { enabled: true }
  )
);

app.get('/data', (req, res) => {
  const detection = (req as AgentShieldRequest).agentShield;

  // Populated for a tracked agent session (nested under `.result` / `.session`)
  if (detection?.result?.detectedAgent) {
    console.log(`Agent ${detection.result.detectedAgent.name} accessing /data`);
  }

  res.json({
    data: 'your data here',
    agent: detection?.session?.agent ?? null,
    confidence: detection?.session?.confidence ?? null,
  });
});

export default app;