mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-21 16:27:18 +02:00
## Thinking Path > - Paperclip manages AI agents and their work. > - Agent creation, approval, pause, and termination change whether an agent can work. > - These changes currently use separate service and database paths. > - Some agents need setup after their record exists and before their harness can run. > - This PR adds one module that owns those state changes and their transactions. > - The module records progress and retries incomplete work after a server restart. ## Linked Issues or Issue Description **Problem or motivation** A hire can become active before its execution environment is ready. Direct agent state writes also bypass one common lifecycle boundary. Termination does not have a durable step for resource cleanup. **Proposed solution** Use agent lifecycle commands for hiring, approval, pause, resume, and termination. Keep proposed hires pending until approval. Prepare each approved hire, test its saved harness configuration, and then permit work. Wait for required plugin work before completing a step. **Alternatives considered** A general database commit hook would expose transaction details to callers. A timer alone would delay each new hire. This module owns each command transaction and starts its worker after commit. A periodic scan recovers work after a process stops. **Roadmap alignment** This change adds the lifecycle boundary for the existing agent and plugin systems. It does not add a user interface or a provider implementation. It replaces the lifecycle delivery approach in #15391. Related proposals include #11475 and #13099; this change does not add their external executor protocols. ## What Changed - Add durable approval, preparation, verification, pause, resume, stop, and cleanup states. - Keep agent creation, lifecycle state, configuration writes, and agent record deletion behind `modules/agent-lifecycle`. Keep validation, credential rules, reads, onboarding, invitations, general approvals, and company data deletion in their services. - Commit a hire before the remaining onboarding or invitation work. Serialize requests with the existing dedicated database connection helper. Reuse the hire after a failed attempt. - Keep accepted work in the run queue during setup. Require execution and cleanup evidence before completing pause or termination. - Retain the original credential owner when approving migrated hires. - Start lifecycle work after each command commits. Use database leases and revision checks for retries and late results. - Add a generic required plugin method and capability. Store the required plugin IDs for each agent. Track host and plugin completion separately. - Keep harness verification and credential rules in services. Supply their results to lifecycle through explicit ports. Reject failed logins and incomplete probes. - Remove reverse imports from lifecycle adapters into services. Share record queries and validation below both layers. - Use one hire decision path for agent IDs and approval IDs. Resolve the approval and agent change in one transaction. Expose policy reconciliation on the command object. - Save configuration and verification invalidation through one module operation. Ordinary commands own their transaction. Restrict the shared transaction integration to its listed callers. Reject identity, company, accounting, timestamp, and unknown fields. - Require completed termination before deleting agent records. The company deletion service calls the module through a separate deletion interface. - Save an approved secret before applying its agent binding. A failed binding leaves the secret approved. A retry reuses it. - Remove old permission and metadata export files. Move hire configuration rules out of lifecycle persistence. - Report failed worker steps and scans with operation context and known error codes. Omit provider messages, stacks, and configuration values. Document ordinary application use and extension rules. - Recover expired native owners only after execution stops. Retry cleanup of failed retained leases. Wait for setup in the live smoke script. - Keep manual, budget, and company pause reasons separate. Guard execution status writes with the ready state. - Add a migration, boundary checks, regression tests, and a lifecycle guide. Keep the current UI. - Limit periodic policy checks to 100 eligible agents per minute. Continue from the last agent ID. Exclude pending hires and agents in termination or a final state. Keep explicit company and budget updates immediate. ## Verification - Latest head `ccc3c86b0` aligns the shared status update schema with the PATCH route. All 15 shared tests, 104 server route/OpenAPI tests, 2 CLI tests, and shared/server/CLI TypeScript checks pass. The Greptile comment is fixed. CI is running; no new Apex review was requested for this small fix. - Rebase `75708ac94` rebases onto master at `2eb5187e4`. The backup test uses the shared 90-second timeout from master; the older timeout commit was removed. The affected backup test passes. - Agent budget edits now pass the target agent ID through enforcement. All 50 affected tests, server TypeScript, and 11 boundary tests pass. Both configuration update paths have regression coverage. CI is running on the latest head. No new Apex review was requested for these small fixes. - Rebase `9b568666a` preserves the run-control extraction and delivery-work startup changes from master. All 559 affected tests, server TypeScript, and 11 boundary tests pass. CI and Apex review are running on the final head. - The policy scan fix passes 56 lifecycle and diagnostic tests, 24 policy and caller tests, and 11 boundary tests. A regression test checks the page limit, interval, excluded states, and cursor wraparound. - Rebase `fd4698750` passes all 611 tests in eight affected lifecycle, route, and heartbeat suites. Server TypeScript and all 11 module boundary tests pass. The company deletion rollback and concurrent hire tests are included. - Follow-up `00aac7646` fixes the failed decision deletion test and the public update schema. All 126 affected server tests, 8 shared tests, 2 CLI tests, and 11 boundary tests pass. Shared, server, CLI, and UI TypeScript checks pass. - Server TypeScript passes: `pnpm --filter @paperclipai/server exec tsc --noEmit`. - All 11 boundary tests pass: `node --test scripts/check-module-boundaries.test.mjs`. The repository boundary scan also passes. - All 68 lifecycle, failure diagnostic, and harness verification tests pass. Tests reject forbidden fields through the root command, combined transition command, and restricted transaction integration. They also check invalid fields returned by configuration preparation. - Failure tests cover host work, plugin work, claims, renewals, deferrals, and scans. Log tests check known error codes and exclusion of private error contents. - All 355 tests in 10 existing caller suites pass. These tests cover secret approval, pairing, pending hires, credentials, company import, built-in agents, managed agents, instructions, and skills. - The branch is rebased onto `origin/master` at `2eb5187e4`. The queue guards and cancellation lock fix use the extracted heartbeat queue. Agent cancellation uses the extracted run-control file. The source diff scan found no secrets or private URLs. - Earlier checks cover approval retries, rollback, late verification results, policy holds, deletion rollback, concurrent company deletion, and queue admission during setup. - Before the rebase, CI passed on `00aac7646` and Greptile Apex rated it 5/5 with no open comments. CI and a new Apex review are pending for the rebased commit. The branch has no merge conflicts. - The full local build and native Dot suite were not run. The host has no Cargo. No live provider test was run. ## Risks - Background policy recovery takes more than one minute when more than 100 agents are eligible. Explicit company and budget updates still reconcile immediately. - The restricted configuration integration keeps an agent reference and its dependent records in one transaction. It cannot change a budget or invoke a lifecycle transition. A periodic scan starts pending setup after that transaction commits. - Secret approval and binding use separate transactions. A failed binding can leave an approved secret with no agent binding. - New approved hires remain unavailable until setup and verification complete. Existing clients see `paused` during these steps. This PR does not change the UI. - Migration `0320_daily_onslaught.sql` maps existing statuses and pause reasons. It does not create external resources or claim that an existing harness passed verification. - Use a coordinated server update for this migration. Older server versions can write legacy status without the new lifecycle checks. - A failed onboarding or invitation request can leave a committed hire. A retry reuses that hire and completes the remaining records. - Deletion requires completed termination. Company deletion can require another request while cleanup is pending. - Required plugins must make repeated calls safe and reject older revisions. A disabled or removed required plugin blocks completion until it is restored. - A new hire can run a second harness test after the existing UI test. Some adapters can charge for this test. - No live provider test was run. Provider implementation and resource backfill remain separate work. ## Model Used OpenAI GPT-6 through Codex, with reasoning, code tools, and local test execution. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have described the issue in this PR with the feature request field labels - [x] I have not referenced internal or instance-local issues or links - [x] My branch name describes the change - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation - [x] I have considered and documented risks - [x] Targeted local tests pass - [x] All Paperclip CI gates are green on the new commit - [x] Greptile Apex is 5/5 with no open comments on the new commit - [x] I will address review comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
1305 lines
52 KiB
TypeScript
1305 lines
52 KiB
TypeScript
import { z } from "zod";
|
||
import {
|
||
PLUGIN_STATUSES,
|
||
PLUGIN_CATEGORIES,
|
||
PLUGIN_CAPABILITIES,
|
||
PLUGIN_UI_SLOT_TYPES,
|
||
PLUGIN_UI_SLOT_ENTITY_TYPES,
|
||
PLUGIN_RESERVED_COMPANY_ROUTE_SEGMENTS,
|
||
PLUGIN_RESERVED_COMPANY_SETTINGS_ROUTE_SEGMENTS,
|
||
PLUGIN_LAUNCHER_PLACEMENT_ZONES,
|
||
PLUGIN_LAUNCHER_ACTIONS,
|
||
PLUGIN_LAUNCHER_BOUNDS,
|
||
PLUGIN_LAUNCHER_RENDER_ENVIRONMENTS,
|
||
PLUGIN_STATE_SCOPE_KINDS,
|
||
PLUGIN_DATABASE_CORE_READ_TABLES,
|
||
PLUGIN_API_ROUTE_AUTH_MODES,
|
||
PLUGIN_API_ROUTE_CHECKOUT_POLICIES,
|
||
PLUGIN_API_ROUTE_METHODS,
|
||
ISSUE_PRIORITIES,
|
||
ROUTINE_CATCH_UP_POLICIES,
|
||
ROUTINE_ACTIVITY_GATE_POLICIES,
|
||
ROUTINE_ACTIVITY_GATE_SCOPES,
|
||
ROUTINE_CONCURRENCY_POLICIES,
|
||
ROUTINE_STATUSES,
|
||
ROUTINE_TRIGGER_KINDS,
|
||
ROUTINE_TRIGGER_SIGNING_MODES,
|
||
ISSUE_SURFACE_VISIBILITIES,
|
||
} from "../constants.js";
|
||
import { routineVariableSchema } from "./routine.js";
|
||
import { externalObjectProviderKeySchema, externalObjectTypeSchema } from "./external-object.js";
|
||
|
||
// ---------------------------------------------------------------------------
|
||
// JSON Schema placeholder – a permissive validator for JSON Schema objects
|
||
// ---------------------------------------------------------------------------
|
||
|
||
/**
|
||
* Permissive validator for JSON Schema objects. Accepts any `Record<string, unknown>`
|
||
* that contains at least a `type`, `$ref`, or composition keyword (`oneOf`/`anyOf`/`allOf`).
|
||
* Empty objects are also accepted.
|
||
*
|
||
* Used to validate `instanceConfigSchema` and `parametersSchema` fields in the
|
||
* plugin manifest without fully parsing JSON Schema.
|
||
*
|
||
* @see PLUGIN_SPEC.md §10.1 — Manifest shape
|
||
*/
|
||
export const jsonSchemaSchema = z.record(z.string(), z.unknown()).refine(
|
||
(val) => {
|
||
// Must have a "type" field if non-empty, or be a valid JSON Schema object
|
||
if (Object.keys(val).length === 0) return true;
|
||
return typeof val.type === "string" || val.$ref !== undefined || val.oneOf !== undefined || val.anyOf !== undefined || val.allOf !== undefined;
|
||
},
|
||
{ message: "Must be a valid JSON Schema object (requires at least a 'type', '$ref', or composition keyword)" },
|
||
);
|
||
|
||
// ---------------------------------------------------------------------------
|
||
// Manifest sub-type schemas
|
||
// ---------------------------------------------------------------------------
|
||
|
||
/**
|
||
* Validates a {@link PluginJobDeclaration} — a scheduled job declared in the
|
||
* plugin manifest. Requires `jobKey` and `displayName`; `description` and
|
||
* `schedule` (cron expression) are optional.
|
||
*
|
||
* @see PLUGIN_SPEC.md §17 — Scheduled Jobs
|
||
*/
|
||
/**
|
||
* Validates a cron expression has exactly 5 whitespace-separated fields,
|
||
* each containing only valid cron characters (digits, *, /, -, ,).
|
||
*
|
||
* Valid tokens per field: *, N, N-M, N/S, * /S, N-M/S, and comma-separated lists.
|
||
*/
|
||
const CRON_FIELD_PATTERN = /^(\*(?:\/[0-9]+)?|[0-9]+(?:-[0-9]+)?(?:\/[0-9]+)?)(?:,(\*(?:\/[0-9]+)?|[0-9]+(?:-[0-9]+)?(?:\/[0-9]+)?))*$/;
|
||
|
||
function isValidCronExpression(expression: string): boolean {
|
||
const trimmed = expression.trim();
|
||
if (!trimmed) return false;
|
||
const fields = trimmed.split(/\s+/);
|
||
if (fields.length !== 5) return false;
|
||
return fields.every((f) => CRON_FIELD_PATTERN.test(f));
|
||
}
|
||
|
||
export const pluginJobDeclarationSchema = z.object({
|
||
jobKey: z.string().min(1),
|
||
displayName: z.string().min(1),
|
||
description: z.string().optional(),
|
||
schedule: z.string().refine(
|
||
(val) => isValidCronExpression(val),
|
||
{ message: "schedule must be a valid 5-field cron expression (e.g. '*/15 * * * *')" },
|
||
).optional(),
|
||
});
|
||
|
||
export type PluginJobDeclarationInput = z.infer<typeof pluginJobDeclarationSchema>;
|
||
|
||
/**
|
||
* Validates a {@link PluginWebhookDeclaration} — a webhook endpoint declared
|
||
* in the plugin manifest. Requires `endpointKey` and `displayName`.
|
||
*
|
||
* @see PLUGIN_SPEC.md §18 — Webhooks
|
||
*/
|
||
export const pluginWebhookDeclarationSchema = z.object({
|
||
endpointKey: z.string().min(1),
|
||
displayName: z.string().min(1),
|
||
description: z.string().optional(),
|
||
});
|
||
|
||
export type PluginWebhookDeclarationInput = z.infer<typeof pluginWebhookDeclarationSchema>;
|
||
|
||
/**
|
||
* Validates a {@link PluginToolDeclaration} — an agent tool contributed by the
|
||
* plugin. Requires `name`, `displayName`, `description`, and a valid
|
||
* `parametersSchema`. Requires the `agent.tools.register` capability.
|
||
*
|
||
* @see PLUGIN_SPEC.md §11 — Agent Tools
|
||
*/
|
||
export const pluginToolDeclarationSchema = z.object({
|
||
name: z.string().min(1),
|
||
displayName: z.string().min(1),
|
||
description: z.string().min(1),
|
||
parametersSchema: jsonSchemaSchema,
|
||
});
|
||
|
||
const pluginEnvironmentTemplateConfigFieldSchema = z.string()
|
||
.min(1)
|
||
.max(100)
|
||
.regex(
|
||
/^[A-Za-z_][A-Za-z0-9_-]*$/,
|
||
"Template config binding fields must be top-level config keys using letters, digits, underscores, or hyphens",
|
||
)
|
||
.refine((value) => value !== "provider", {
|
||
message: "Template config binding must not replace the sandbox provider key",
|
||
});
|
||
|
||
export const pluginEnvironmentTemplateConfigBindingSchema = z.object({
|
||
field: pluginEnvironmentTemplateConfigFieldSchema,
|
||
unsetFields: z.array(pluginEnvironmentTemplateConfigFieldSchema).max(20).optional(),
|
||
}).strict().superRefine((value, ctx) => {
|
||
const unsetFields = value.unsetFields ?? [];
|
||
const seen = new Set<string>();
|
||
for (const [index, field] of unsetFields.entries()) {
|
||
if (field === value.field) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "Template config binding cannot unset the same field it sets",
|
||
path: ["unsetFields", index],
|
||
});
|
||
}
|
||
if (seen.has(field)) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "Template config binding unsetFields must be unique",
|
||
path: ["unsetFields", index],
|
||
});
|
||
}
|
||
seen.add(field);
|
||
}
|
||
});
|
||
|
||
// The nested sandbox capability declaration is `.strict()` so an unknown
|
||
// capability key is a validation error, not a silently dropped field. The outer
|
||
// driver schema below is also `.strict()`, so a typo in a top-level capability
|
||
// name cannot pass either.
|
||
export const sandboxProviderCapabilitiesSchema = z.object({
|
||
reusableLeases: z.boolean().optional(),
|
||
nativeSyncIn: z.boolean().optional(),
|
||
nativeSyncOut: z.boolean().optional(),
|
||
persistentProcessSessions: z.boolean().optional(),
|
||
independentControlCommands: z.boolean().optional(),
|
||
incrementalSessionOutput: z.boolean().optional(),
|
||
concurrentSyncOperations: z.boolean().optional(),
|
||
duplexCommandStream: z.boolean().optional(),
|
||
runnerWebSocketIngress: z.boolean().optional(),
|
||
}).strict();
|
||
|
||
export type SandboxProviderCapabilitiesInput = z.infer<typeof sandboxProviderCapabilitiesSchema>;
|
||
|
||
// The driver declaration schema is `.strict()` so an unknown top-level key is a
|
||
// validation error, not a silently dropped field. A misspelled capability name
|
||
// (for example `supportsLoginPTY`) fails validation instead of dropping.
|
||
export const pluginEnvironmentDriverDeclarationSchema = z.object({
|
||
driverKey: z.string().min(1).regex(
|
||
/^[a-z0-9][a-z0-9._-]*$/,
|
||
"Environment driver key must start with a lowercase alphanumeric and contain only lowercase letters, digits, dots, hyphens, or underscores",
|
||
),
|
||
kind: z.enum(["environment_driver", "sandbox_provider"]).optional(),
|
||
displayName: z.string().min(1).max(100),
|
||
description: z.string().max(500).optional(),
|
||
defaultAcquireTimeoutMs: z.number().int().positive().max(86_400_000).optional(),
|
||
supportsReusableLeases: z.boolean().optional(),
|
||
sandboxCapabilities: sandboxProviderCapabilitiesSchema.optional(),
|
||
supportsInteractiveSetup: z.boolean().optional(),
|
||
interactiveSetupConnectionTypes: z.array(z.string().min(1).max(100)).max(10).optional(),
|
||
supportsTemplateCapture: z.boolean().optional(),
|
||
templateRefKind: z.string().min(1).max(100).optional(),
|
||
templateConfigBinding: pluginEnvironmentTemplateConfigBindingSchema.optional(),
|
||
templateIdentityPaths: z.array(z.string().min(1).max(200)).max(20).optional(),
|
||
supportsTemplateDelete: z.boolean().optional(),
|
||
// The neutral transport capability: does the provider host an interactive
|
||
// login on a real pseudo-terminal? Validate a literal boolean only.
|
||
supportsLoginPty: z.boolean().optional(),
|
||
// Deprecated alias for `supportsLoginPty`. It exists only so an external
|
||
// plugin manifest that declares the old name still loads. Validate a literal
|
||
// boolean only. The transform below canonicalizes it onto `supportsLoginPty`
|
||
// and drops it, so every downstream reader reads only the canonical field.
|
||
supportsSetupTokenLogin: z.boolean().optional(),
|
||
configSchema: jsonSchemaSchema,
|
||
}).strict().superRefine((driver, ctx) => {
|
||
// Reject a manifest that carries both the alias and the canonical field with
|
||
// different values. Matching values pass. A single field passes.
|
||
if (
|
||
driver.supportsLoginPty !== undefined
|
||
&& driver.supportsSetupTokenLogin !== undefined
|
||
&& driver.supportsLoginPty !== driver.supportsSetupTokenLogin
|
||
) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message:
|
||
"supportsSetupTokenLogin is a deprecated alias for supportsLoginPty; the two flags must not carry different values",
|
||
path: ["supportsLoginPty"],
|
||
});
|
||
}
|
||
}).transform((driver) => {
|
||
// Canonicalize before any authorization or projection reads the value. The
|
||
// canonical field wins; the alias fills it in when only the alias is present.
|
||
// Drop the alias so every downstream reader reads only `supportsLoginPty`. An
|
||
// undefined value is omitted on JSON serialization, so a driver that declares
|
||
// neither field carries no login flag.
|
||
const { supportsSetupTokenLogin, ...rest } = driver;
|
||
return { ...rest, supportsLoginPty: rest.supportsLoginPty ?? supportsSetupTokenLogin };
|
||
});
|
||
|
||
export type PluginEnvironmentDriverDeclarationInput = z.infer<
|
||
typeof pluginEnvironmentDriverDeclarationSchema
|
||
>;
|
||
|
||
export type PluginToolDeclarationInput = z.infer<typeof pluginToolDeclarationSchema>;
|
||
|
||
export const pluginManagedAgentDeclarationSchema = z.object({
|
||
agentKey: z.string().min(1).max(100).regex(/^[a-z0-9][a-z0-9._:-]*$/, {
|
||
message: "agentKey must start with a lowercase alphanumeric and contain only lowercase letters, digits, dots, colons, underscores, or hyphens",
|
||
}),
|
||
displayName: z.string().min(1).max(100),
|
||
role: z.string().min(1).max(100).optional(),
|
||
title: z.string().max(200).nullable().optional(),
|
||
icon: z.string().max(100).nullable().optional(),
|
||
capabilities: z.string().max(2000).nullable().optional(),
|
||
adapterType: z.string().min(1).max(100).optional(),
|
||
adapterPreference: z.array(z.string().min(1).max(100)).max(10).optional(),
|
||
adapterConfig: z.record(z.string(), z.unknown()).optional(),
|
||
runtimeConfig: z.record(z.string(), z.unknown()).optional(),
|
||
permissions: z.record(z.string(), z.unknown()).optional(),
|
||
status: z.enum(["idle", "paused"]).optional(),
|
||
budgetMonthlyCents: z.number().int().min(0).optional(),
|
||
instructions: z.object({
|
||
entryFile: z.string().min(1).max(200).optional(),
|
||
content: z.string().max(200_000).optional(),
|
||
files: z.record(z.string(), z.string().max(200_000)).optional(),
|
||
assetPath: z.string().min(1).max(500).optional(),
|
||
}).optional(),
|
||
});
|
||
|
||
export type PluginManagedAgentDeclarationInput = z.infer<typeof pluginManagedAgentDeclarationSchema>;
|
||
|
||
export const pluginManagedProjectDeclarationSchema = z.object({
|
||
projectKey: z.string().min(1).max(100).regex(/^[a-z0-9][a-z0-9._:-]*$/, {
|
||
message: "projectKey must start with a lowercase alphanumeric and contain only lowercase letters, digits, dots, colons, underscores, or hyphens",
|
||
}),
|
||
displayName: z.string().min(1).max(120),
|
||
description: z.string().max(2000).nullable().optional(),
|
||
status: z.enum(["backlog", "planned", "in_progress", "completed", "cancelled"]).optional(),
|
||
color: z.string().max(32).nullable().optional(),
|
||
settings: z.record(z.string(), z.unknown()).optional(),
|
||
});
|
||
|
||
export type PluginManagedProjectDeclarationInput = z.infer<typeof pluginManagedProjectDeclarationSchema>;
|
||
|
||
const pluginManagedResourceRefSchema = z.object({
|
||
pluginKey: z.string().min(1).max(100).optional(),
|
||
resourceKind: z.enum(["agent", "project", "routine", "skill"]),
|
||
resourceKey: z.string().min(1).max(100).regex(/^[a-z0-9][a-z0-9._:-]*$/, {
|
||
message: "resourceKey must start with a lowercase alphanumeric and contain only lowercase letters, digits, dots, colons, underscores, or hyphens",
|
||
}),
|
||
});
|
||
|
||
export const pluginManagedRoutineDeclarationSchema = z.object({
|
||
routineKey: z.string().min(1).max(100).regex(/^[a-z0-9][a-z0-9._:-]*$/, {
|
||
message: "routineKey must start with a lowercase alphanumeric and contain only lowercase letters, digits, dots, colons, underscores, or hyphens",
|
||
}),
|
||
title: z.string().trim().min(1).max(200),
|
||
description: z.string().max(10_000).nullable().optional(),
|
||
assigneeRef: pluginManagedResourceRefSchema.extend({ resourceKind: z.literal("agent") }).nullable().optional(),
|
||
projectRef: pluginManagedResourceRefSchema.extend({ resourceKind: z.literal("project") }).nullable().optional(),
|
||
goalId: z.string().guid().nullable().optional(),
|
||
status: z.enum(ROUTINE_STATUSES).optional(),
|
||
priority: z.enum(ISSUE_PRIORITIES).optional(),
|
||
concurrencyPolicy: z.enum(ROUTINE_CONCURRENCY_POLICIES).optional(),
|
||
catchUpPolicy: z.enum(ROUTINE_CATCH_UP_POLICIES).optional(),
|
||
activityGatePolicy: z.enum(ROUTINE_ACTIVITY_GATE_POLICIES).optional(),
|
||
activityGateScope: z.enum(ROUTINE_ACTIVITY_GATE_SCOPES).optional(),
|
||
variables: z.array(routineVariableSchema).optional(),
|
||
triggers: z.array(z.object({
|
||
kind: z.enum(ROUTINE_TRIGGER_KINDS),
|
||
label: z.string().trim().max(120).nullable().optional(),
|
||
enabled: z.boolean().optional(),
|
||
cronExpression: z.string().trim().min(1).optional().nullable(),
|
||
timezone: z.string().trim().min(1).optional().nullable(),
|
||
signingMode: z.enum(ROUTINE_TRIGGER_SIGNING_MODES).optional().nullable(),
|
||
replayWindowSec: z.number().int().min(30).max(86_400).optional().nullable(),
|
||
})).max(20).optional(),
|
||
issueTemplate: z.object({
|
||
surfaceVisibility: z.enum(ISSUE_SURFACE_VISIBILITIES).optional(),
|
||
originId: z.string().trim().max(255).nullable().optional(),
|
||
billingCode: z.string().trim().max(200).nullable().optional(),
|
||
}).optional(),
|
||
});
|
||
|
||
export type PluginManagedRoutineDeclarationInput = z.infer<typeof pluginManagedRoutineDeclarationSchema>;
|
||
|
||
const pluginLocalFolderRelativePathSchema = z.string().min(1).max(500).refine(
|
||
(value) =>
|
||
!value.startsWith("/") &&
|
||
!value.includes("..") &&
|
||
!value.includes("\\") &&
|
||
!value.split("/").some((segment) => segment === "" || segment === "."),
|
||
{ message: "local folder paths must be relative paths without traversal, empty segments, or backslashes" },
|
||
);
|
||
|
||
export const pluginLocalFolderDeclarationSchema = z.object({
|
||
folderKey: z.string().min(1).max(100).regex(/^[a-z0-9][a-z0-9._:-]*$/, {
|
||
message: "folderKey must start with a lowercase alphanumeric and contain only lowercase letters, digits, dots, colons, underscores, or hyphens",
|
||
}),
|
||
displayName: z.string().min(1).max(100),
|
||
description: z.string().max(500).optional(),
|
||
access: z.enum(["read", "readWrite"]).optional(),
|
||
requiredDirectories: z.array(pluginLocalFolderRelativePathSchema).optional(),
|
||
requiredFiles: z.array(pluginLocalFolderRelativePathSchema).optional(),
|
||
});
|
||
|
||
export type PluginLocalFolderDeclarationInput = z.infer<typeof pluginLocalFolderDeclarationSchema>;
|
||
|
||
export const pluginManagedSkillFileDeclarationSchema = z.object({
|
||
path: pluginLocalFolderRelativePathSchema.refine(
|
||
(value) => value.toLowerCase() !== "skill.md",
|
||
{ message: "managed skill files cannot replace SKILL.md; use markdown for the main skill file" },
|
||
),
|
||
content: z.string().max(200_000),
|
||
});
|
||
|
||
export type PluginManagedSkillFileDeclarationInput = z.infer<typeof pluginManagedSkillFileDeclarationSchema>;
|
||
|
||
export const pluginManagedSkillDeclarationSchema = z.object({
|
||
skillKey: z.string().min(1).max(100).regex(/^[a-z0-9][a-z0-9._:-]*$/, {
|
||
message: "skillKey must start with a lowercase alphanumeric and contain only lowercase letters, digits, dots, colons, underscores, or hyphens",
|
||
}),
|
||
displayName: z.string().min(1).max(100),
|
||
slug: z.string().min(1).max(100).regex(/^[a-z0-9][a-z0-9._:-]*$/, {
|
||
message: "slug must start with a lowercase alphanumeric and contain only lowercase letters, digits, dots, colons, underscores, or hyphens",
|
||
}).optional(),
|
||
description: z.string().max(2000).nullable().optional(),
|
||
markdown: z.string().max(200_000).optional(),
|
||
files: z.array(pluginManagedSkillFileDeclarationSchema).max(50).optional(),
|
||
}).superRefine((value, ctx) => {
|
||
const paths = (value.files ?? []).map((file) => file.path);
|
||
const duplicates = paths.filter((path, index) => paths.indexOf(path) !== index);
|
||
if (duplicates.length > 0) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Duplicate managed skill file paths: ${[...new Set(duplicates)].join(", ")}`,
|
||
path: ["files"],
|
||
});
|
||
}
|
||
});
|
||
|
||
export type PluginManagedSkillDeclarationInput = z.infer<typeof pluginManagedSkillDeclarationSchema>;
|
||
|
||
/**
|
||
* Validates a {@link PluginUiSlotDeclaration} — a UI extension slot the plugin
|
||
* fills with a React component. Includes `superRefine` checks for slot-specific
|
||
* requirements such as `entityTypes` for context-sensitive slots.
|
||
*
|
||
* @see PLUGIN_SPEC.md §19 — UI Extension Model
|
||
*/
|
||
export const pluginUiSlotDeclarationSchema = z.object({
|
||
type: z.enum(PLUGIN_UI_SLOT_TYPES),
|
||
id: z.string().min(1),
|
||
displayName: z.string().min(1),
|
||
exportName: z.string().min(1),
|
||
entityTypes: z.array(z.enum(PLUGIN_UI_SLOT_ENTITY_TYPES)).optional(),
|
||
routePath: z.string().regex(/^[a-z0-9][a-z0-9-]*$/, {
|
||
message: "routePath must be a lowercase single-segment slug (letters, numbers, hyphens)",
|
||
}).optional(),
|
||
order: z.number().int().optional(),
|
||
}).superRefine((value, ctx) => {
|
||
// context-sensitive slots require explicit entity targeting.
|
||
const entityScopedTypes = ["detailTab", "taskDetailView", "contextMenuItem", "commentAnnotation", "commentContextMenuItem", "projectSidebarItem"];
|
||
if (
|
||
entityScopedTypes.includes(value.type)
|
||
&& (!value.entityTypes || value.entityTypes.length === 0)
|
||
) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `${value.type} slots require at least one entityType`,
|
||
path: ["entityTypes"],
|
||
});
|
||
}
|
||
// projectSidebarItem only makes sense for entityType "project".
|
||
if (value.type === "projectSidebarItem" && value.entityTypes && !value.entityTypes.includes("project")) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "projectSidebarItem slots require entityTypes to include \"project\"",
|
||
path: ["entityTypes"],
|
||
});
|
||
}
|
||
// commentAnnotation only makes sense for entityType "comment".
|
||
if (value.type === "commentAnnotation" && value.entityTypes && !value.entityTypes.includes("comment")) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "commentAnnotation slots require entityTypes to include \"comment\"",
|
||
path: ["entityTypes"],
|
||
});
|
||
}
|
||
// commentContextMenuItem only makes sense for entityType "comment".
|
||
if (value.type === "commentContextMenuItem" && value.entityTypes && !value.entityTypes.includes("comment")) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "commentContextMenuItem slots require entityTypes to include \"comment\"",
|
||
path: ["entityTypes"],
|
||
});
|
||
}
|
||
if (value.routePath && value.type !== "page" && value.type !== "routeSidebar" && value.type !== "companySettingsPage") {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "routePath is only supported for page, routeSidebar, and companySettingsPage slots",
|
||
path: ["routePath"],
|
||
});
|
||
}
|
||
if (value.type === "routeSidebar" && !value.routePath) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "routeSidebar slots require routePath",
|
||
path: ["routePath"],
|
||
});
|
||
}
|
||
if (value.type === "companySettingsPage" && !value.routePath) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "companySettingsPage slots require routePath",
|
||
path: ["routePath"],
|
||
});
|
||
}
|
||
if (value.routePath && PLUGIN_RESERVED_COMPANY_ROUTE_SEGMENTS.includes(value.routePath as (typeof PLUGIN_RESERVED_COMPANY_ROUTE_SEGMENTS)[number])) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `routePath "${value.routePath}" is reserved by the host`,
|
||
path: ["routePath"],
|
||
});
|
||
}
|
||
if (
|
||
value.type === "companySettingsPage"
|
||
&& value.routePath
|
||
&& PLUGIN_RESERVED_COMPANY_SETTINGS_ROUTE_SEGMENTS.includes(value.routePath as (typeof PLUGIN_RESERVED_COMPANY_SETTINGS_ROUTE_SEGMENTS)[number])
|
||
) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `company settings routePath "${value.routePath}" is reserved by the host`,
|
||
path: ["routePath"],
|
||
});
|
||
}
|
||
});
|
||
|
||
export type PluginUiSlotDeclarationInput = z.infer<typeof pluginUiSlotDeclarationSchema>;
|
||
|
||
const entityScopedLauncherPlacementZones = [
|
||
"detailTab",
|
||
"taskDetailView",
|
||
"contextMenuItem",
|
||
"commentAnnotation",
|
||
"commentContextMenuItem",
|
||
"projectSidebarItem",
|
||
] as const;
|
||
|
||
const launcherBoundsByEnvironment: Record<
|
||
(typeof PLUGIN_LAUNCHER_RENDER_ENVIRONMENTS)[number],
|
||
readonly (typeof PLUGIN_LAUNCHER_BOUNDS)[number][]
|
||
> = {
|
||
hostInline: ["inline", "compact", "default"],
|
||
hostOverlay: ["compact", "default", "wide", "full"],
|
||
hostRoute: ["default", "wide", "full"],
|
||
external: [],
|
||
iframe: ["compact", "default", "wide", "full"],
|
||
};
|
||
|
||
/**
|
||
* Validates the action payload for a declarative plugin launcher.
|
||
*/
|
||
export const pluginLauncherActionDeclarationSchema = z.object({
|
||
type: z.enum(PLUGIN_LAUNCHER_ACTIONS),
|
||
target: z.string().min(1),
|
||
params: z.record(z.string(), z.unknown()).optional(),
|
||
}).superRefine((value, ctx) => {
|
||
if (value.type === "performAction" && value.target.includes("/")) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "performAction launchers must target an action key, not a route or URL",
|
||
path: ["target"],
|
||
});
|
||
}
|
||
|
||
if (value.type === "navigate" && /^https?:\/\//.test(value.target)) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "navigate launchers must target a host route, not an absolute URL",
|
||
path: ["target"],
|
||
});
|
||
}
|
||
});
|
||
|
||
export type PluginLauncherActionDeclarationInput =
|
||
z.infer<typeof pluginLauncherActionDeclarationSchema>;
|
||
|
||
/**
|
||
* Validates optional render hints for a plugin launcher destination.
|
||
*/
|
||
export const pluginLauncherRenderDeclarationSchema = z.object({
|
||
environment: z.enum(PLUGIN_LAUNCHER_RENDER_ENVIRONMENTS),
|
||
bounds: z.enum(PLUGIN_LAUNCHER_BOUNDS).optional(),
|
||
}).superRefine((value, ctx) => {
|
||
if (!value.bounds) {
|
||
return;
|
||
}
|
||
|
||
const supportedBounds = launcherBoundsByEnvironment[value.environment];
|
||
if (!supportedBounds.includes(value.bounds)) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `bounds "${value.bounds}" is not supported for render environment "${value.environment}"`,
|
||
path: ["bounds"],
|
||
});
|
||
}
|
||
});
|
||
|
||
export type PluginLauncherRenderDeclarationInput =
|
||
z.infer<typeof pluginLauncherRenderDeclarationSchema>;
|
||
|
||
/**
|
||
* Validates declarative launcher metadata in a plugin manifest.
|
||
*/
|
||
export const pluginLauncherDeclarationSchema = z.object({
|
||
id: z.string().min(1),
|
||
displayName: z.string().min(1),
|
||
description: z.string().optional(),
|
||
placementZone: z.enum(PLUGIN_LAUNCHER_PLACEMENT_ZONES),
|
||
exportName: z.string().min(1).optional(),
|
||
entityTypes: z.array(z.enum(PLUGIN_UI_SLOT_ENTITY_TYPES)).optional(),
|
||
order: z.number().int().optional(),
|
||
action: pluginLauncherActionDeclarationSchema,
|
||
render: pluginLauncherRenderDeclarationSchema.optional(),
|
||
}).superRefine((value, ctx) => {
|
||
if (
|
||
entityScopedLauncherPlacementZones.some((zone) => zone === value.placementZone)
|
||
&& (!value.entityTypes || value.entityTypes.length === 0)
|
||
) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `${value.placementZone} launchers require at least one entityType`,
|
||
path: ["entityTypes"],
|
||
});
|
||
}
|
||
|
||
if (
|
||
value.placementZone === "projectSidebarItem"
|
||
&& value.entityTypes
|
||
&& !value.entityTypes.includes("project")
|
||
) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "projectSidebarItem launchers require entityTypes to include \"project\"",
|
||
path: ["entityTypes"],
|
||
});
|
||
}
|
||
|
||
if (value.action.type === "performAction" && value.render) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "performAction launchers cannot declare render hints",
|
||
path: ["render"],
|
||
});
|
||
}
|
||
|
||
if (
|
||
["openModal", "openDrawer", "openPopover"].includes(value.action.type)
|
||
&& !value.render
|
||
) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `${value.action.type} launchers require render metadata`,
|
||
path: ["render"],
|
||
});
|
||
}
|
||
|
||
if (value.action.type === "openModal" && value.render?.environment === "hostInline") {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "openModal launchers cannot use the hostInline render environment",
|
||
path: ["render", "environment"],
|
||
});
|
||
}
|
||
|
||
if (
|
||
value.action.type === "openDrawer"
|
||
&& value.render
|
||
&& !["hostOverlay", "iframe"].includes(value.render.environment)
|
||
) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "openDrawer launchers must use hostOverlay or iframe render environments",
|
||
path: ["render", "environment"],
|
||
});
|
||
}
|
||
|
||
if (value.action.type === "openPopover" && value.render?.environment === "hostRoute") {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "openPopover launchers cannot use the hostRoute render environment",
|
||
path: ["render", "environment"],
|
||
});
|
||
}
|
||
});
|
||
|
||
export type PluginLauncherDeclarationInput = z.infer<typeof pluginLauncherDeclarationSchema>;
|
||
|
||
export const pluginDatabaseDeclarationSchema = z.object({
|
||
namespaceSlug: z.string().regex(/^[a-z0-9][a-z0-9_]*$/, {
|
||
message: "namespaceSlug must be lowercase letters, digits, or underscores and start with a letter or digit",
|
||
}).max(40).optional(),
|
||
migrationsDir: z.string().min(1).refine(
|
||
(value) => !value.startsWith("/") && !value.includes("..") && !/[\\]/.test(value),
|
||
{ message: "migrationsDir must be a relative package path without '..' or backslashes" },
|
||
),
|
||
coreReadTables: z.array(z.enum(PLUGIN_DATABASE_CORE_READ_TABLES)).optional(),
|
||
});
|
||
|
||
export type PluginDatabaseDeclarationInput = z.infer<typeof pluginDatabaseDeclarationSchema>;
|
||
|
||
export const pluginApiRouteDeclarationSchema = z.object({
|
||
routeKey: z.string().min(1).max(100).regex(/^[a-z0-9][a-z0-9._:-]*$/, {
|
||
message: "routeKey must be lowercase letters, digits, dots, colons, underscores, or hyphens",
|
||
}),
|
||
method: z.enum(PLUGIN_API_ROUTE_METHODS),
|
||
path: z.string().min(1).regex(/^\/[a-zA-Z0-9:_./-]*$/, {
|
||
message: "path must start with / and contain only path-safe literal or :param segments",
|
||
}).refine(
|
||
(value) =>
|
||
!value.includes("..") &&
|
||
!value.includes("//") &&
|
||
value !== "/api" &&
|
||
!value.startsWith("/api/") &&
|
||
value !== "/plugins" &&
|
||
!value.startsWith("/plugins/"),
|
||
{ message: "path must stay inside the plugin api namespace" },
|
||
),
|
||
auth: z.enum(PLUGIN_API_ROUTE_AUTH_MODES),
|
||
capability: z.literal("api.routes.register"),
|
||
checkoutPolicy: z.enum(PLUGIN_API_ROUTE_CHECKOUT_POLICIES).optional(),
|
||
companyResolution: z.discriminatedUnion("from", [
|
||
z.object({ from: z.literal("body"), key: z.string().min(1) }),
|
||
z.object({ from: z.literal("query"), key: z.string().min(1) }),
|
||
z.object({ from: z.literal("issue"), param: z.string().min(1) }),
|
||
]).optional(),
|
||
});
|
||
|
||
export type PluginApiRouteDeclarationInput = z.infer<typeof pluginApiRouteDeclarationSchema>;
|
||
|
||
export const pluginObjectReferenceRefreshPolicySchema = z.object({
|
||
defaultTtlSeconds: z.number().int().positive().max(86_400).optional(),
|
||
staleAfterSeconds: z.number().int().positive().max(604_800).optional(),
|
||
}).superRefine((value, ctx) => {
|
||
if (
|
||
value.defaultTtlSeconds != null &&
|
||
value.staleAfterSeconds != null &&
|
||
value.staleAfterSeconds < value.defaultTtlSeconds
|
||
) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "staleAfterSeconds must be greater than or equal to defaultTtlSeconds",
|
||
path: ["staleAfterSeconds"],
|
||
});
|
||
}
|
||
});
|
||
|
||
export const pluginObjectReferenceProviderDeclarationSchema = z.object({
|
||
providerKey: externalObjectProviderKeySchema,
|
||
displayName: z.string().min(1).max(100),
|
||
objectTypes: z.array(externalObjectTypeSchema).min(1),
|
||
urlPatterns: z.array(z.string().trim().min(1).max(500)).optional(),
|
||
refreshPolicy: pluginObjectReferenceRefreshPolicySchema.optional(),
|
||
webhookEndpointKeys: z.array(z.string().min(1)).optional(),
|
||
}).superRefine((value, ctx) => {
|
||
const duplicateObjectTypes = value.objectTypes.filter((type, i) => value.objectTypes.indexOf(type) !== i);
|
||
if (duplicateObjectTypes.length > 0) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Duplicate objectTypes: ${[...new Set(duplicateObjectTypes)].join(", ")}`,
|
||
path: ["objectTypes"],
|
||
});
|
||
}
|
||
|
||
const webhookKeys = value.webhookEndpointKeys ?? [];
|
||
const duplicateWebhookKeys = webhookKeys.filter((key, i) => webhookKeys.indexOf(key) !== i);
|
||
if (duplicateWebhookKeys.length > 0) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Duplicate webhookEndpointKeys: ${[...new Set(duplicateWebhookKeys)].join(", ")}`,
|
||
path: ["webhookEndpointKeys"],
|
||
});
|
||
}
|
||
});
|
||
|
||
export type PluginObjectReferenceProviderDeclarationInput = z.infer<
|
||
typeof pluginObjectReferenceProviderDeclarationSchema
|
||
>;
|
||
|
||
// ---------------------------------------------------------------------------
|
||
// Plugin Manifest V1 schema
|
||
// ---------------------------------------------------------------------------
|
||
|
||
/**
|
||
* Zod schema for {@link PaperclipPluginManifestV1} — the complete runtime
|
||
* validator for plugin manifests read at install time.
|
||
*
|
||
* Field-level constraints (see PLUGIN_SPEC.md §10.1 for the normative rules):
|
||
*
|
||
* | Field | Type | Constraints |
|
||
* |--------------------------|------------|----------------------------------------------|
|
||
* | `id` | string | `^[a-z0-9][a-z0-9._-]*$` |
|
||
* | `apiVersion` | literal 1 | must equal `PLUGIN_API_VERSION` |
|
||
* | `version` | string | semver (`\d+\.\d+\.\d+`) |
|
||
* | `displayName` | string | 1–100 chars |
|
||
* | `description` | string | 1–500 chars |
|
||
* | `author` | string | 1–200 chars |
|
||
* | `categories` | enum[] | at least one; values from PLUGIN_CATEGORIES |
|
||
* | `minimumHostVersion` | string? | semver lower bound if present, no leading `v`|
|
||
* | `minimumPaperclipVersion`| string? | legacy alias of `minimumHostVersion` |
|
||
* | `capabilities` | enum[] | at least one; values from PLUGIN_CAPABILITIES|
|
||
* | `entrypoints.worker` | string | min 1 char |
|
||
* | `entrypoints.ui` | string? | required when `ui.slots` is declared |
|
||
*
|
||
* Cross-field rules enforced via `superRefine`:
|
||
* - `entrypoints.ui` required when `ui.slots` declared
|
||
* - `agent.tools.register` capability required when `tools` declared
|
||
* - `environment.drivers.register` capability required when `environmentDrivers` declared
|
||
* - `jobs.schedule` capability required when `jobs` declared
|
||
* - `webhooks.receive` capability required when `webhooks` declared
|
||
* - duplicate `jobs[].jobKey` values are rejected
|
||
* - duplicate `webhooks[].endpointKey` values are rejected
|
||
* - duplicate `tools[].name` values are rejected
|
||
* - duplicate `environmentDrivers[].driverKey` values are rejected
|
||
* - duplicate `ui.slots[].id` values are rejected
|
||
*
|
||
* @see PLUGIN_SPEC.md §10.1 — Manifest shape
|
||
* @see {@link PaperclipPluginManifestV1} — the inferred TypeScript type
|
||
*/
|
||
export const pluginManifestV1Schema = z.object({
|
||
id: z.string().min(1).regex(
|
||
/^[a-z0-9][a-z0-9._-]*$/,
|
||
"Plugin id must start with a lowercase alphanumeric and contain only lowercase letters, digits, dots, hyphens, or underscores",
|
||
),
|
||
apiVersion: z.literal(1),
|
||
version: z.string().min(1).regex(
|
||
/^\d+\.\d+\.\d+(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$/,
|
||
"Version must follow semver (e.g. 1.0.0 or 1.0.0-beta.1)",
|
||
),
|
||
displayName: z.string().min(1).max(100),
|
||
description: z.string().min(1).max(500),
|
||
author: z.string().min(1).max(200),
|
||
categories: z.array(z.enum(PLUGIN_CATEGORIES)).min(1),
|
||
minimumHostVersion: z.string().regex(
|
||
/^\d+\.\d+\.\d+(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$/,
|
||
"minimumHostVersion must follow semver (e.g. 1.0.0)",
|
||
).optional(),
|
||
minimumPaperclipVersion: z.string().regex(
|
||
/^\d+\.\d+\.\d+(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$/,
|
||
"minimumPaperclipVersion must follow semver (e.g. 1.0.0)",
|
||
).optional(),
|
||
capabilities: z.array(z.enum(PLUGIN_CAPABILITIES)).min(1),
|
||
agentLifecycle: z.literal(true).optional(),
|
||
aiConnectionRouter: z.object({ name: z.string().trim().min(1).max(100), description: z.string().trim().min(1).max(500) }).strict().optional(),
|
||
entrypoints: z.object({
|
||
worker: z.string().min(1),
|
||
ui: z.string().min(1).optional(),
|
||
}),
|
||
instanceConfigSchema: jsonSchemaSchema.optional(),
|
||
jobs: z.array(pluginJobDeclarationSchema).optional(),
|
||
webhooks: z.array(pluginWebhookDeclarationSchema).optional(),
|
||
tools: z.array(pluginToolDeclarationSchema).optional(),
|
||
database: pluginDatabaseDeclarationSchema.optional(),
|
||
apiRoutes: z.array(pluginApiRouteDeclarationSchema).optional(),
|
||
environmentDrivers: z.array(pluginEnvironmentDriverDeclarationSchema).optional(),
|
||
agents: z.array(pluginManagedAgentDeclarationSchema).optional(),
|
||
projects: z.array(pluginManagedProjectDeclarationSchema).optional(),
|
||
routines: z.array(pluginManagedRoutineDeclarationSchema).optional(),
|
||
skills: z.array(pluginManagedSkillDeclarationSchema).optional(),
|
||
localFolders: z.array(pluginLocalFolderDeclarationSchema).optional(),
|
||
objectReferences: z.array(pluginObjectReferenceProviderDeclarationSchema).optional(),
|
||
launchers: z.array(pluginLauncherDeclarationSchema).optional(),
|
||
ui: z.object({
|
||
slots: z.array(pluginUiSlotDeclarationSchema).min(1).optional(),
|
||
launchers: z.array(pluginLauncherDeclarationSchema).optional(),
|
||
}).optional(),
|
||
}).superRefine((manifest, ctx) => {
|
||
if (manifest.agentLifecycle && !manifest.capabilities.includes("agents.lifecycle.manage")) {
|
||
ctx.addIssue({ code: z.ZodIssueCode.custom, message: "Agent lifecycle participation requires agents.lifecycle.manage", path: ["capabilities"] });
|
||
}
|
||
|
||
// ── Entrypoint ↔ UI slot consistency ──────────────────────────────────
|
||
// Plugins that declare UI slots must also declare a UI entrypoint so the
|
||
// host knows where to load the bundle from (PLUGIN_SPEC.md §10.1).
|
||
const hasUiSlots = (manifest.ui?.slots?.length ?? 0) > 0;
|
||
const hasUiLaunchers = (manifest.ui?.launchers?.length ?? 0) > 0;
|
||
if ((hasUiSlots || hasUiLaunchers) && !manifest.entrypoints.ui) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "entrypoints.ui is required when ui.slots or ui.launchers are declared",
|
||
path: ["entrypoints", "ui"],
|
||
});
|
||
}
|
||
|
||
if (
|
||
manifest.minimumHostVersion
|
||
&& manifest.minimumPaperclipVersion
|
||
&& manifest.minimumHostVersion !== manifest.minimumPaperclipVersion
|
||
) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "minimumHostVersion and minimumPaperclipVersion must match when both are declared",
|
||
path: ["minimumHostVersion"],
|
||
});
|
||
}
|
||
|
||
// ── Capability ↔ feature declaration consistency ───────────────────────
|
||
// The host enforces capabilities at install and runtime. A plugin must
|
||
// declare every capability it needs up-front; silently having more features
|
||
// than capabilities would cause runtime rejections.
|
||
|
||
if (manifest.aiConnectionRouter && !manifest.capabilities.includes("ai.connections.route")) {
|
||
ctx.addIssue({ code: z.ZodIssueCode.custom, message: "ai.connections.route is required for aiConnectionRouter", path: ["capabilities"] });
|
||
}
|
||
|
||
// tools require agent.tools.register (PLUGIN_SPEC.md §11)
|
||
if (manifest.tools && manifest.tools.length > 0) {
|
||
if (!manifest.capabilities.includes("agent.tools.register")) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "Capability 'agent.tools.register' is required when tools are declared",
|
||
path: ["capabilities"],
|
||
});
|
||
}
|
||
}
|
||
|
||
// environment drivers require environment.drivers.register
|
||
if (manifest.environmentDrivers && manifest.environmentDrivers.length > 0) {
|
||
if (!manifest.capabilities.includes("environment.drivers.register")) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "Capability 'environment.drivers.register' is required when environmentDrivers are declared",
|
||
path: ["capabilities"],
|
||
});
|
||
}
|
||
}
|
||
|
||
if (manifest.agents && manifest.agents.length > 0) {
|
||
if (!manifest.capabilities.includes("agents.managed")) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "Capability 'agents.managed' is required when managed agents are declared",
|
||
path: ["capabilities"],
|
||
});
|
||
}
|
||
}
|
||
|
||
if (manifest.projects && manifest.projects.length > 0) {
|
||
if (!manifest.capabilities.includes("projects.managed")) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "Capability 'projects.managed' is required when managed projects are declared",
|
||
path: ["capabilities"],
|
||
});
|
||
}
|
||
}
|
||
|
||
if (manifest.routines && manifest.routines.length > 0) {
|
||
if (!manifest.capabilities.includes("routines.managed")) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "Capability 'routines.managed' is required when managed routines are declared",
|
||
path: ["capabilities"],
|
||
});
|
||
}
|
||
}
|
||
|
||
if (manifest.skills && manifest.skills.length > 0) {
|
||
if (!manifest.capabilities.includes("skills.managed")) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "Capability 'skills.managed' is required when managed skills are declared",
|
||
path: ["capabilities"],
|
||
});
|
||
}
|
||
}
|
||
|
||
if (manifest.localFolders && manifest.localFolders.length > 0) {
|
||
if (!manifest.capabilities.includes("local.folders")) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "Capability 'local.folders' is required when local folders are declared",
|
||
path: ["capabilities"],
|
||
});
|
||
}
|
||
}
|
||
|
||
// jobs require jobs.schedule (PLUGIN_SPEC.md §17)
|
||
if (manifest.jobs && manifest.jobs.length > 0) {
|
||
if (!manifest.capabilities.includes("jobs.schedule")) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "Capability 'jobs.schedule' is required when jobs are declared",
|
||
path: ["capabilities"],
|
||
});
|
||
}
|
||
}
|
||
|
||
// webhooks require webhooks.receive (PLUGIN_SPEC.md §18)
|
||
if (manifest.webhooks && manifest.webhooks.length > 0) {
|
||
if (!manifest.capabilities.includes("webhooks.receive")) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "Capability 'webhooks.receive' is required when webhooks are declared",
|
||
path: ["capabilities"],
|
||
});
|
||
}
|
||
}
|
||
|
||
if (manifest.apiRoutes && manifest.apiRoutes.length > 0) {
|
||
if (!manifest.capabilities.includes("api.routes.register")) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: "Capability 'api.routes.register' is required when apiRoutes are declared",
|
||
path: ["capabilities"],
|
||
});
|
||
}
|
||
}
|
||
|
||
if (manifest.objectReferences && manifest.objectReferences.length > 0) {
|
||
for (const capability of ["external.objects.detect", "external.objects.read"] as const) {
|
||
if (!manifest.capabilities.includes(capability)) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Capability '${capability}' is required when objectReferences are declared`,
|
||
path: ["capabilities"],
|
||
});
|
||
}
|
||
}
|
||
|
||
const declaredWebhookKeys = new Set((manifest.webhooks ?? []).map((webhook) => webhook.endpointKey));
|
||
for (const [providerIndex, provider] of manifest.objectReferences.entries()) {
|
||
for (const endpointKey of provider.webhookEndpointKeys ?? []) {
|
||
if (!declaredWebhookKeys.has(endpointKey)) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `objectReferences webhookEndpointKey "${endpointKey}" must match a declared webhook endpoint`,
|
||
path: ["objectReferences", providerIndex, "webhookEndpointKeys"],
|
||
});
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
if (manifest.database) {
|
||
const requiredCapabilities = [
|
||
"database.namespace.migrate",
|
||
"database.namespace.read",
|
||
] as const;
|
||
for (const capability of requiredCapabilities) {
|
||
if (!manifest.capabilities.includes(capability)) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Capability '${capability}' is required when database migrations are declared`,
|
||
path: ["capabilities"],
|
||
});
|
||
}
|
||
}
|
||
|
||
const coreReadTables = manifest.database.coreReadTables ?? [];
|
||
const duplicates = coreReadTables.filter((table, i) => coreReadTables.indexOf(table) !== i);
|
||
if (duplicates.length > 0) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Duplicate database coreReadTables: ${[...new Set(duplicates)].join(", ")}`,
|
||
path: ["database", "coreReadTables"],
|
||
});
|
||
}
|
||
}
|
||
|
||
// ── Uniqueness checks ──────────────────────────────────────────────────
|
||
// Duplicate keys within a plugin's own manifest are always a bug. The host
|
||
// would not know which declaration takes precedence, so we reject early.
|
||
|
||
// job keys must be unique within the plugin (used as identifiers in the DB)
|
||
if (manifest.jobs) {
|
||
const jobKeys = manifest.jobs.map((j) => j.jobKey);
|
||
const duplicates = jobKeys.filter((key, i) => jobKeys.indexOf(key) !== i);
|
||
if (duplicates.length > 0) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Duplicate job keys: ${[...new Set(duplicates)].join(", ")}`,
|
||
path: ["jobs"],
|
||
});
|
||
}
|
||
}
|
||
|
||
// webhook endpoint keys must be unique within the plugin (used in routes)
|
||
if (manifest.webhooks) {
|
||
const endpointKeys = manifest.webhooks.map((w) => w.endpointKey);
|
||
const duplicates = endpointKeys.filter((key, i) => endpointKeys.indexOf(key) !== i);
|
||
if (duplicates.length > 0) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Duplicate webhook endpoint keys: ${[...new Set(duplicates)].join(", ")}`,
|
||
path: ["webhooks"],
|
||
});
|
||
}
|
||
}
|
||
|
||
if (manifest.apiRoutes) {
|
||
const routeKeys = manifest.apiRoutes.map((route) => route.routeKey);
|
||
const duplicateKeys = routeKeys.filter((key, i) => routeKeys.indexOf(key) !== i);
|
||
if (duplicateKeys.length > 0) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Duplicate api route keys: ${[...new Set(duplicateKeys)].join(", ")}`,
|
||
path: ["apiRoutes"],
|
||
});
|
||
}
|
||
const routeSignatures = manifest.apiRoutes.map((route) => `${route.method} ${route.path}`);
|
||
const duplicateRoutes = routeSignatures.filter((sig, i) => routeSignatures.indexOf(sig) !== i);
|
||
if (duplicateRoutes.length > 0) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Duplicate api routes: ${[...new Set(duplicateRoutes)].join(", ")}`,
|
||
path: ["apiRoutes"],
|
||
});
|
||
}
|
||
}
|
||
|
||
// tool names must be unique within the plugin (namespaced at runtime)
|
||
if (manifest.tools) {
|
||
const toolNames = manifest.tools.map((t) => t.name);
|
||
const duplicates = toolNames.filter((name, i) => toolNames.indexOf(name) !== i);
|
||
if (duplicates.length > 0) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Duplicate tool names: ${[...new Set(duplicates)].join(", ")}`,
|
||
path: ["tools"],
|
||
});
|
||
}
|
||
}
|
||
|
||
// environment driver keys must be unique within the plugin
|
||
if (manifest.environmentDrivers) {
|
||
const driverKeys = manifest.environmentDrivers.map((d) => d.driverKey);
|
||
const duplicates = driverKeys.filter((key, i) => driverKeys.indexOf(key) !== i);
|
||
if (duplicates.length > 0) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Duplicate environment driver keys: ${[...new Set(duplicates)].join(", ")}`,
|
||
path: ["environmentDrivers"],
|
||
});
|
||
}
|
||
}
|
||
|
||
if (manifest.localFolders) {
|
||
const folderKeys = manifest.localFolders.map((folder) => folder.folderKey);
|
||
const duplicates = folderKeys.filter((key, i) => folderKeys.indexOf(key) !== i);
|
||
if (duplicates.length > 0) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Duplicate local folder keys: ${[...new Set(duplicates)].join(", ")}`,
|
||
path: ["localFolders"],
|
||
});
|
||
}
|
||
}
|
||
|
||
if (manifest.agents) {
|
||
const agentKeys = manifest.agents.map((agent) => agent.agentKey);
|
||
const duplicates = agentKeys.filter((key, i) => agentKeys.indexOf(key) !== i);
|
||
if (duplicates.length > 0) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Duplicate managed agent keys: ${[...new Set(duplicates)].join(", ")}`,
|
||
path: ["agents"],
|
||
});
|
||
}
|
||
}
|
||
|
||
if (manifest.projects) {
|
||
const projectKeys = manifest.projects.map((project) => project.projectKey);
|
||
const duplicates = projectKeys.filter((key, i) => projectKeys.indexOf(key) !== i);
|
||
if (duplicates.length > 0) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Duplicate managed project keys: ${[...new Set(duplicates)].join(", ")}`,
|
||
path: ["projects"],
|
||
});
|
||
}
|
||
}
|
||
|
||
if (manifest.routines) {
|
||
const routineKeys = manifest.routines.map((routine) => routine.routineKey);
|
||
const duplicates = routineKeys.filter((key, i) => routineKeys.indexOf(key) !== i);
|
||
if (duplicates.length > 0) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Duplicate managed routine keys: ${[...new Set(duplicates)].join(", ")}`,
|
||
path: ["routines"],
|
||
});
|
||
}
|
||
}
|
||
|
||
if (manifest.skills) {
|
||
const skillKeys = manifest.skills.map((skill) => skill.skillKey);
|
||
const duplicates = skillKeys.filter((key, i) => skillKeys.indexOf(key) !== i);
|
||
if (duplicates.length > 0) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Duplicate managed skill keys: ${[...new Set(duplicates)].join(", ")}`,
|
||
path: ["skills"],
|
||
});
|
||
}
|
||
}
|
||
|
||
if (manifest.objectReferences) {
|
||
const providerKeys = manifest.objectReferences.map((provider) => provider.providerKey);
|
||
const duplicateProviders = providerKeys.filter((key, i) => providerKeys.indexOf(key) !== i);
|
||
if (duplicateProviders.length > 0) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Duplicate object reference provider keys: ${[...new Set(duplicateProviders)].join(", ")}`,
|
||
path: ["objectReferences"],
|
||
});
|
||
}
|
||
}
|
||
|
||
// UI slot ids must be unique within the plugin (namespaced at runtime)
|
||
if (manifest.ui) {
|
||
if (manifest.ui.slots) {
|
||
const slotIds = manifest.ui.slots.map((s) => s.id);
|
||
const duplicates = slotIds.filter((id, i) => slotIds.indexOf(id) !== i);
|
||
if (duplicates.length > 0) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Duplicate UI slot ids: ${[...new Set(duplicates)].join(", ")}`,
|
||
path: ["ui", "slots"],
|
||
});
|
||
}
|
||
}
|
||
}
|
||
|
||
// launcher ids must be unique within the plugin
|
||
const allLaunchers = [
|
||
...(manifest.launchers ?? []),
|
||
...(manifest.ui?.launchers ?? []),
|
||
];
|
||
if (allLaunchers.length > 0) {
|
||
const launcherIds = allLaunchers.map((launcher) => launcher.id);
|
||
const duplicates = launcherIds.filter((id, i) => launcherIds.indexOf(id) !== i);
|
||
if (duplicates.length > 0) {
|
||
ctx.addIssue({
|
||
code: z.ZodIssueCode.custom,
|
||
message: `Duplicate launcher ids: ${[...new Set(duplicates)].join(", ")}`,
|
||
path: manifest.ui?.launchers ? ["ui", "launchers"] : ["launchers"],
|
||
});
|
||
}
|
||
}
|
||
});
|
||
|
||
export type PluginManifestV1Input = z.infer<typeof pluginManifestV1Schema>;
|
||
|
||
// ---------------------------------------------------------------------------
|
||
// Plugin installation / registration request
|
||
// ---------------------------------------------------------------------------
|
||
|
||
/**
|
||
* Schema for installing (registering) a plugin.
|
||
* The server receives the packageName and resolves the manifest from the
|
||
* installed package.
|
||
*/
|
||
export const installPluginSchema = z.object({
|
||
packageName: z.string().min(1),
|
||
version: z.string().min(1).optional(),
|
||
/** Set by loader for local-path installs so the worker can be resolved. */
|
||
packagePath: z.string().min(1).optional(),
|
||
});
|
||
|
||
export type InstallPlugin = z.infer<typeof installPluginSchema>;
|
||
|
||
// ---------------------------------------------------------------------------
|
||
// Plugin config (company-scoped configuration) schemas
|
||
// ---------------------------------------------------------------------------
|
||
|
||
/**
|
||
* Schema for creating or updating a plugin's company-scoped configuration.
|
||
* configJson is validated permissively here; runtime validation against
|
||
* the plugin's instanceConfigSchema is done at the service layer.
|
||
*/
|
||
export const upsertPluginConfigSchema = z.object({
|
||
companyId: z.string().guid(),
|
||
configJson: z.record(z.string(), z.unknown()),
|
||
});
|
||
|
||
export type UpsertPluginConfig = z.infer<typeof upsertPluginConfigSchema>;
|
||
|
||
/**
|
||
* Schema for partially updating a plugin's company-scoped configuration.
|
||
* Allows a partial merge of config values.
|
||
*/
|
||
export const patchPluginConfigSchema = z.object({
|
||
companyId: z.string().guid(),
|
||
configJson: z.record(z.string(), z.unknown()),
|
||
});
|
||
|
||
export type PatchPluginConfig = z.infer<typeof patchPluginConfigSchema>;
|
||
|
||
// ---------------------------------------------------------------------------
|
||
// Plugin status update
|
||
// ---------------------------------------------------------------------------
|
||
|
||
/**
|
||
* Schema for updating a plugin's lifecycle status. Used by the lifecycle
|
||
* manager to persist state transitions.
|
||
*
|
||
* @see {@link PLUGIN_STATUSES} for the valid status values
|
||
*/
|
||
export const updatePluginStatusSchema = z.object({
|
||
status: z.enum(PLUGIN_STATUSES),
|
||
lastError: z.string().nullable().optional(),
|
||
});
|
||
|
||
export type UpdatePluginStatus = z.infer<typeof updatePluginStatusSchema>;
|
||
|
||
// ---------------------------------------------------------------------------
|
||
// Plugin uninstall
|
||
// ---------------------------------------------------------------------------
|
||
|
||
/** Schema for the uninstall request. `removeData` controls hard vs soft delete. */
|
||
export const uninstallPluginSchema = z.object({
|
||
removeData: z.boolean().optional().default(false),
|
||
});
|
||
|
||
export type UninstallPlugin = z.infer<typeof uninstallPluginSchema>;
|
||
|
||
// ---------------------------------------------------------------------------
|
||
// Plugin state (key-value storage) schemas
|
||
// ---------------------------------------------------------------------------
|
||
|
||
/**
|
||
* Schema for a plugin state scope key — identifies the exact location where
|
||
* state is stored. Used by the `ctx.state.get()`, `ctx.state.set()`, and
|
||
* `ctx.state.delete()` SDK methods.
|
||
*
|
||
* @see PLUGIN_SPEC.md §21.3 `plugin_state`
|
||
*/
|
||
export const pluginStateScopeKeySchema = z.object({
|
||
scopeKind: z.enum(PLUGIN_STATE_SCOPE_KINDS),
|
||
scopeId: z.string().min(1).optional(),
|
||
namespace: z.string().min(1).optional(),
|
||
stateKey: z.string().min(1),
|
||
});
|
||
|
||
export type PluginStateScopeKey = z.infer<typeof pluginStateScopeKeySchema>;
|
||
|
||
/**
|
||
* Schema for setting a plugin state value.
|
||
*/
|
||
export const setPluginStateSchema = z.object({
|
||
scopeKind: z.enum(PLUGIN_STATE_SCOPE_KINDS),
|
||
scopeId: z.string().min(1).optional(),
|
||
namespace: z.string().min(1).optional(),
|
||
stateKey: z.string().min(1),
|
||
/** JSON-serializable value to store. */
|
||
value: z.unknown(),
|
||
});
|
||
|
||
export type SetPluginState = z.infer<typeof setPluginStateSchema>;
|
||
|
||
/**
|
||
* Schema for querying plugin state entries. All fields are optional to allow
|
||
* flexible list queries (e.g. all state for a plugin within a scope).
|
||
*/
|
||
export const listPluginStateSchema = z.object({
|
||
scopeKind: z.enum(PLUGIN_STATE_SCOPE_KINDS).optional(),
|
||
scopeId: z.string().min(1).optional(),
|
||
namespace: z.string().min(1).optional(),
|
||
});
|
||
|
||
export type ListPluginState = z.infer<typeof listPluginStateSchema>;
|