paseo-prompt-kit 0.5.2

package/shared/rpc.ts

@@ -0,0 +1,187 @@
+import { defineRpc } from "@getpaseo/plugin";
+import { z } from "zod";
+import { ACTION_ID_PATTERN, actionPackSchema } from "./action-registry/schema.js";
+import { apiEndpointSchema } from "./api-protocol.js";
+import { promptKitSettingsSchema } from "./settings.js";
+
+export const rewriteErrorCodeSchema = z.enum([
+  "invalid_model",
+  "invalid_selection",
+  "unknown_action",
+  "timeout",
+  "empty_output",
+  "unsupported_provider",
+  "spawn_failed",
+  "missing_api_key",
+  "api_endpoint_unknown",
+  "api_http_error",
+  "api_bad_response",
+  "protected_literal_loss",
+  "generation_failed",
+]);
+
+export const rewriteErrorSchema = z.object({
+  code: rewriteErrorCodeSchema,
+  message: z.string().min(1),
+});
+
+export const rewriteModelSchema = z.object({
+  provider: z.string().min(1),
+  model: z.string().min(1).nullable(),
+  thinkingOptionId: z.string().min(1).nullable(),
+});
+
+/**
+ * Paseo 0.8.0's `registerSettings` returns void, so the daemon-side handler
+ * cannot read its own settings document; the caller's persisted settings
+ * snapshot travels with the request and the handler re-validates every field.
+ */
+export const rewriteRpc = defineRpc({
+  name: "prompt-kit.rewrite",
+  input: z.object({
+    actionId: z.string().regex(ACTION_ID_PATTERN),
+    /** Null for a draft Composer with no agent yet. */
+    agentId: z.string().min(1).nullable(),
+    workspaceId: z.string().min(1),
+    originalPrompt: z.string().min(1).max(50_000),
+    settings: promptKitSettingsSchema,
+  }),
+  output: z.discriminatedUnion("status", [
+    z.object({
+      status: z.literal("ok"),
+      rewrittenPrompt: z.string().min(1),
+      model: rewriteModelSchema,
+      durationMs: z.number().nonnegative(),
+    }),
+    z.object({
+      status: z.literal("error"),
+      error: rewriteErrorSchema,
+    }),
+  ]),
+});
+
+export const actionSummarySchema = z.object({
+  id: z.string().min(1),
+  version: z.number().int().positive(),
+  enabledByDefault: z.boolean(),
+  title: z.string().min(1),
+  description: z.string().min(1),
+  icon: z.string().min(1),
+  /** True for an action the user wrote in Settings, false for a bundled pack. */
+  custom: z.boolean(),
+});
+
+export const rejectedPackSchema = z.object({
+  source: z.string().min(1),
+  reason: z.string().min(1),
+});
+
+/**
+ * The registry for the caller's custom actions, with no switches applied. Which
+ * actions are enabled is a client-side decision; the RPC stays a pure function of
+ * the bundled packs plus the `customActions` it is given.
+ */
+export const actionsListRpc = defineRpc({
+  name: "prompt-kit.actions.list",
+  input: z.object({
+    customActions: z.array(actionPackSchema),
+  }),
+  output: z.object({
+    actions: z.array(actionSummarySchema),
+    rejected: z.array(rejectedPackSchema),
+  }),
+});
+
+export const thinkingOptionSchema = z.object({
+  id: z.string().min(1),
+  label: z.string().min(1),
+});
+
+export const providerModelSchema = z.object({
+  id: z.string().min(1),
+  label: z.string().min(1),
+  thinkingOptions: z.array(thinkingOptionSchema),
+  defaultThinkingOptionId: z.string().min(1).nullable(),
+});
+
+export const providerCatalogEntrySchema = z.object({
+  provider: z.string().min(1),
+  label: z.string().min(1),
+  available: z.boolean(),
+  models: z.array(providerModelSchema),
+});
+
+export const providerCatalogRpc = defineRpc({
+  name: "prompt-kit.providers",
+  input: z.object({ cwd: z.string().min(1).optional() }),
+  output: z.object({
+    providers: z.array(providerCatalogEntrySchema),
+  }),
+});
+
+/**
+ * Checks one API endpoint from the settings screen: resolves its key, asks the
+ * endpoint which models it offers, and reports the outcome.
+ *
+ * It exists so a wrong base URL, a missing key or an unreachable host is found on
+ * the settings screen rather than on the next rewrite. The answer never carries a
+ * key value: a failure names the variable, never the secret.
+ */
+export const apiTestRpc = defineRpc({
+  name: "prompt-kit.api.test",
+  input: z.object({
+    endpoint: apiEndpointSchema,
+    secretsDir: z.string().min(1).nullable(),
+  }),
+  output: z.discriminatedUnion("status", [
+    z.object({
+      status: z.literal("ok"),
+      models: z.array(z.string()),
+    }),
+    z.object({
+      status: z.literal("error"),
+      error: rewriteErrorSchema,
+    }),
+  ]),
+});
+
+const secretsResultSchema = z.discriminatedUnion("status", [
+  z.object({ status: z.literal("ok") }),
+  z.object({ status: z.literal("error"), message: z.string() }),
+]);
+
+/**
+ * Stores one secrets.json entry on the daemon (`value`), or removes it (`null`).
+ * Write-only: no RPC ever returns a key value.
+ */
+export const secretsWriteRpc = defineRpc({
+  name: "prompt-kit.secrets.write",
+  input: z.object({
+    secretsDir: z.string().min(1).nullable(),
+    name: z.string().min(1).max(120),
+    value: z.string().trim().min(1).max(4_096).nullable(),
+  }),
+  output: secretsResultSchema,
+});
+
+/** Whether secrets.json holds a value for `name`; the answer is a boolean, never the value. */
+export const secretsStatusRpc = defineRpc({
+  name: "prompt-kit.secrets.status",
+  input: z.object({
+    secretsDir: z.string().min(1).nullable(),
+    name: z.string().min(1).max(120),
+  }),
+  output: z.discriminatedUnion("status", [
+    z.object({ status: z.literal("ok"), stored: z.boolean() }),
+    z.object({ status: z.literal("error"), message: z.string() }),
+  ]),
+});
+
+export type RewriteInput = z.output<typeof rewriteRpc.input>;
+export type RewriteOutput = z.output<typeof rewriteRpc.output>;
+export type RewriteError = z.output<typeof rewriteErrorSchema>;
+export type ActionSummary = z.output<typeof actionSummarySchema>;
+export type ActionsListOutput = z.output<typeof actionsListRpc.output>;
+export type ProviderCatalogOutput = z.output<typeof providerCatalogRpc.output>;
+export type ApiTestInput = z.output<typeof apiTestRpc.input>;
+export type ApiTestOutput = z.output<typeof apiTestRpc.output>;

package/shared/settings.ts

@@ -0,0 +1,90 @@
+import { defineSettings } from "@getpaseo/plugin";
+import { z } from "zod";
+import { actionPackSchema } from "./action-registry/schema.js";
+import { apiEndpointSchema } from "./api-protocol.js";
+import { CLI_FAMILY_IDS } from "./cli-families.js";
+import { LANGUAGE_ID_PATTERN, SOURCE_LANGUAGE } from "./language-registry/schema.js";
+
+/** Which model the CLI transport runs. The API transport ignores it. */
+export const modelModeSchema = z.enum(["current", "dedicated"]);
+
+/**
+ * How the model is reached. `cli` spawns the provider's CLI and takes its model
+ * from `modelMode`; `api` posts to `apiEndpointId` with `apiModel`, or to a
+ * provider's mapped endpoint with that agent's own model.
+ */
+export const transportSchema = z.enum(["cli", "api"]);
+
+/** Rewrite budget bounds. `hostRpcCapMs` is the daemon's own 30 s plugin-RPC cap. */
+export const TIMEOUT_MS = {
+  min: 1_000,
+  max: 600_000,
+  default: 90_000,
+  hostRpcCapMs: 30_000,
+} as const;
+
+/**
+ * Host-scoped PromptKit settings. Every field has a default so `{}` parses and
+ * an incomplete dedicated selection can never silently select another model.
+ *
+ * A settings document travels to the client, so no API key is ever stored here:
+ * an endpoint carries the *name* of its key (`apiKeyEnv`) and the server resolves
+ * the value. See `README.md`, "API keys".
+ */
+export const promptKitSettingsSchema = z.object({
+  modelMode: modelModeSchema.default("current"),
+  transport: transportSchema.default("cli"),
+  dedicatedProvider: z.string().min(1).nullable().default(null),
+  dedicatedModel: z.string().min(1).nullable().default(null),
+  dedicatedThinkingOptionId: z.string().min(1).nullable().default(null),
+  /**
+   * Maps a Paseo provider id to the CLI family that runs it. Paseo names a
+   * built-in provider after its CLI (`pi`, `codex`) and a custom profile after
+   * the role it plays (`pi-peer`, `codex-lead`), so the leading segment resolves
+   * most ids without an entry here. An entry is needed only for a profile whose
+   * id does not mention its CLI, and an unknown id fails closed either way.
+   */
+  providerCli: z.record(z.string(), z.enum(CLI_FAMILY_IDS)).default({}),
+  /** The API endpoints this host can reach. Key values are never stored here. */
+  apiEndpoints: z.array(apiEndpointSchema).default([]),
+  /** The endpoint `transport: "api"` uses for an agent whose provider is not mapped. */
+  apiEndpointId: z.string().min(1).nullable().default(null),
+  /** The model id sent to that endpoint. */
+  apiModel: z.string().min(1).nullable().default(null),
+  /**
+   * Maps a Paseo provider id to an endpoint id, so an agent whose provider is
+   * served by a direct API can rewrite over HTTP instead of paying a CLI cold
+   * start. The counterpart of `providerCli`: that one says which CLI runs a
+   * provider, this one says which endpoint serves it.
+   */
+  apiEndpointByProvider: z.record(z.string(), z.string().min(1)).default({}),
+  /**
+   * Directory holding `secrets.json` for every endpoint whose key source is `secrets_file`,
+   * or null for `<PASEO_HOME>/plugin-settings/prompt-kit`. Absolute or `~/`-prefixed.
+   */
+  secretsDir: z.string().min(1).nullable().default(null),
+  timeoutMs: z.number().int().min(TIMEOUT_MS.min).max(TIMEOUT_MS.max).default(TIMEOUT_MS.default),
+  /**
+   * Per-action user toggle, keyed by action id. An id absent here falls back to
+   * the pack's `enabledByDefault`, so a newly added pack is usable without a
+   * settings migration and a removed pack leaves no stale state behind.
+   */
+  actionEnabled: z.record(z.string(), z.boolean()).default({}),
+  /** Actions the user wrote in Settings; same pack schema and rewrite path as the bundled ones. */
+  customActions: z.array(actionPackSchema).default([]),
+  /** `SOURCE_LANGUAGE` or a loaded id from `shared/languages/`. */
+  outputLanguage: z.string().regex(LANGUAGE_ID_PATTERN).default(SOURCE_LANGUAGE),
+});
+
+export type PromptKitSettings = z.output<typeof promptKitSettingsSchema>;
+
+export const promptKitSettings = defineSettings({
+  id: "prompt-kit",
+  scope: "host",
+  version: 1,
+  schema: promptKitSettingsSchema,
+});
+
+export function isDedicatedSelectionComplete(settings: PromptKitSettings): boolean {
+  return settings.dedicatedProvider !== null && settings.dedicatedModel !== null;
+}