paseo-req-kit 1.8.0 → 1.9.0-beta.2

package/paseo-plugin/shared/contracts.ts

@@ -0,0 +1,165 @@
+// What the plugin's app side asks its daemon side. The daemon side answers by running
+// `req api …` (contracts/cli-json.md in req-kit); these types mirror that format.
+import { defineRpc, defineSettings } from "@getpaseo/plugin";
+import { z } from "zod";
+
+export type Attention = "approval" | "business" | "interrupted" | "not_completed" | null;
+
+export interface Usage {
+  steps: number;
+  agentMinutes: number;
+  inputTokens: number | null;
+  outputTokens: number | null;
+  costUsd: number | null;
+}
+
+export interface Requirement {
+  key: string;
+  project: string;
+  repo: string;
+  sourceRepo: string | null;
+  workspaceId: string | null;
+  featureDir: string;
+  name: string;
+  title: string;
+  type: string | null;
+  profile: string | null;
+  branch: string | null;
+  stage: string;
+  status: string | null;
+  running: boolean;
+  phase: string | null;
+  attention: Attention;
+  current: Array<{ key: string; title: string; agentId: string }>;
+  updatedAt: string;
+  usage: Usage | null;
+  present: boolean;
+}
+
+export interface Step {
+  key: string;
+  stepId: string;
+  title: string;
+  phase: string | null;
+  attempt: number;
+  round: number | null;
+  agentId: string;
+  startedAt: string;
+  endedAt: string | null;
+  minutes: number;
+  outcome: "running" | "completed" | "failed";
+  result: string | null;
+  error: string | null;
+}
+
+export interface GateRun {
+  key: string;
+  attempt: number;
+  at: string;
+  checks: Array<{ name: string; result: string; failedBefore: boolean }>;
+  newFailures: string[];
+  fixRounds: number;
+  passed: boolean;
+}
+
+export interface RequirementDetail extends Requirement {
+  files: string[];
+  run: {
+    attempt: number;
+    startedAt: string;
+    updatedAt: string;
+    phaseMode: string | null;
+    stopReason: string | null;
+    outcome: string | null;
+    queuedSince: string | null;
+    verifyAt: string | null;
+    approval: { attempt: number; status: string; at: string } | null;
+    originAgentId: string | null;
+  } | null;
+  steps: Step[];
+  gate: { runs: GateRun[] } | null;
+  joint: Array<{ name: string; repo: string; branch: string; workspaceId: string; gate: { runs: GateRun[] } | null }>;
+}
+
+export interface StatsSummary {
+  period: { label: string };
+  machines: string[];
+  active: number;
+  completed: { total: number; byOutcome: Record<string, number> };
+  byType: Record<string, number>;
+  cycleHours: { median: number | null; average: number | null };
+  steps: Array<{ stepId: string; title: string; count: number; averageMinutes: number; totalMinutes: number }>;
+  rework: { averageReviewRounds: number | null; withDefectRounds: number | null; gateRuns: number; gateFailed: number };
+  waits: Array<{ kind: string; label: string; requirements: number; averageMinutes: number }>;
+  usage: { agentMinutes: number; inputTokens: number | null; outputTokens: number | null; costUsd: number | null };
+}
+
+export interface KitInfo {
+  kitVersion: string;
+  kitRoot: string;
+  apiSchema: number;
+  paseo: string | null;
+  /** Where the daemon side found req-kit (the kit home it read active.json from). */
+  kitHome: string;
+}
+
+/** Where a requirement is: as `req api` names it. */
+const target = z.object({ repo: z.string().min(1), featureDir: z.string().min(1) });
+
+export const versionRpc = defineRpc({
+  name: "req.version",
+  input: z.object({}),
+  output: z.custom<KitInfo>(),
+});
+
+export const listRpc = defineRpc({
+  name: "req.list",
+  input: z.object({}),
+  output: z.custom<Requirement[]>(),
+});
+
+export const statusRpc = defineRpc({
+  name: "req.status",
+  input: target,
+  output: z.custom<RequirementDetail>(),
+});
+
+/** Documents the plugin shows; req api only allows its own list (READABLE_FILES). */
+export const fileRpc = defineRpc({
+  name: "req.file",
+  input: target.extend({ file: z.string().min(1) }),
+  output: z.custom<{ file: string; size: number; truncated: boolean; content: string }>(),
+});
+
+export const statsRpc = defineRpc({
+  name: "req.stats",
+  input: z.object({ since: z.string().optional(), month: z.string().optional() }),
+  output: z.custom<StatsSummary>(),
+});
+
+export const ACTIONS = ["approve", "stop", "resume", "verify"] as const;
+export type Action = (typeof ACTIONS)[number];
+
+export const runRpc = defineRpc({
+  name: "req.run",
+  input: target.extend({
+    action: z.enum(ACTIONS),
+    /** For verify: local | deployed. */
+    verifyEnv: z.enum(["local", "deployed"]).optional(),
+  }),
+  output: z.object({ ok: z.boolean(), message: z.string() }),
+});
+
+export const preferences = defineSettings({
+  id: "preferences",
+  scope: "host",
+  version: 1,
+  schema: z.object({
+    /** Show requirements and documents only; hide stop, resume, approve and verify. */
+    readOnly: z.boolean().default(false),
+    /** How often an open screen refreshes, in seconds. */
+    refreshSeconds: z.number().int().min(3).max(300).default(10),
+    /** req-kit's machine directory when it is not ~/.req-kit (REQ_KIT_HOME). */
+    kitHome: z.string().default(""),
+  }),
+});

package/paseo-plugin/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "lib": ["ES2023"],
+    "jsx": "react-jsx",
+    "strict": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "noEmit": true,
+    "types": ["node"]
+  },
+  "include": ["index.client.tsx", "index.server.ts", "client/**/*", "server/**/*", "shared/**/*"]
+}