Chaim Marcus
587a2a76ca
16 agent tools, event handler for auto-linking, sync job every 15m. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
84 lines
5.8 KiB
TypeScript
84 lines
5.8 KiB
TypeScript
/**
|
|
* `@paperclipai/plugin-sdk` — Paperclip plugin worker-side SDK.
|
|
*
|
|
* This is the main entrypoint for plugin worker code. For plugin UI bundles,
|
|
* import from `@paperclipai/plugin-sdk/ui` instead.
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* // Plugin worker entrypoint (dist/worker.ts)
|
|
* import { definePlugin, runWorker, z } from "@paperclipai/plugin-sdk";
|
|
*
|
|
* const plugin = definePlugin({
|
|
* async setup(ctx) {
|
|
* ctx.logger.info("Plugin starting up");
|
|
*
|
|
* ctx.events.on("issue.created", async (event) => {
|
|
* ctx.logger.info("Issue created", { issueId: event.entityId });
|
|
* });
|
|
*
|
|
* ctx.jobs.register("full-sync", async (job) => {
|
|
* ctx.logger.info("Starting full sync", { runId: job.runId });
|
|
* // ... sync implementation
|
|
* });
|
|
*
|
|
* ctx.data.register("sync-health", async ({ companyId }) => {
|
|
* const state = await ctx.state.get({
|
|
* scopeKind: "company",
|
|
* scopeId: String(companyId),
|
|
* stateKey: "last-sync-at",
|
|
* });
|
|
* return { lastSync: state };
|
|
* });
|
|
* },
|
|
*
|
|
* async onHealth() {
|
|
* return { status: "ok" };
|
|
* },
|
|
* });
|
|
*
|
|
* export default plugin;
|
|
* runWorker(plugin, import.meta.url);
|
|
* ```
|
|
*
|
|
* @see PLUGIN_SPEC.md §14 — SDK Surface
|
|
* @see PLUGIN_SPEC.md §29.2 — SDK Versioning
|
|
*/
|
|
export { definePlugin } from "./define-plugin.js";
|
|
export { createTestHarness } from "./testing.js";
|
|
export { createPluginBundlerPresets } from "./bundlers.js";
|
|
export { startPluginDevServer, getUiBuildSnapshot } from "./dev-server.js";
|
|
export { startWorkerRpcHost, runWorker } from "./worker-rpc-host.js";
|
|
export { createHostClientHandlers, getRequiredCapability, CapabilityDeniedError, } from "./host-client-factory.js";
|
|
export { JSONRPC_VERSION, JSONRPC_ERROR_CODES, PLUGIN_RPC_ERROR_CODES, HOST_TO_WORKER_REQUIRED_METHODS, HOST_TO_WORKER_OPTIONAL_METHODS, MESSAGE_DELIMITER, createRequest, createSuccessResponse, createErrorResponse, createNotification, isJsonRpcRequest, isJsonRpcNotification, isJsonRpcResponse, isJsonRpcSuccessResponse, isJsonRpcErrorResponse, serializeMessage, parseMessage, JsonRpcParseError, JsonRpcCallError, _resetIdCounter, } from "./protocol.js";
|
|
export type { PluginDefinition, PaperclipPlugin, PluginHealthDiagnostics, PluginConfigValidationResult, PluginWebhookInput, } from "./define-plugin.js";
|
|
export type { TestHarness, TestHarnessOptions, TestHarnessLogEntry, } from "./testing.js";
|
|
export type { PluginBundlerPresetInput, PluginBundlerPresets, EsbuildLikeOptions, RollupLikeConfig, } from "./bundlers.js";
|
|
export type { PluginDevServer, PluginDevServerOptions } from "./dev-server.js";
|
|
export type { WorkerRpcHostOptions, WorkerRpcHost, RunWorkerOptions, } from "./worker-rpc-host.js";
|
|
export type { HostServices, HostClientFactoryOptions, HostClientHandlers, } from "./host-client-factory.js";
|
|
export type { JsonRpcId, JsonRpcRequest, JsonRpcSuccessResponse, JsonRpcError, JsonRpcErrorResponse, JsonRpcResponse, JsonRpcNotification, JsonRpcMessage, JsonRpcErrorCode, PluginRpcErrorCode, InitializeParams, InitializeResult, ConfigChangedParams, ValidateConfigParams, OnEventParams, RunJobParams, GetDataParams, PerformActionParams, ExecuteToolParams, PluginModalBoundsRequest, PluginRenderCloseEvent, PluginLauncherRenderContextSnapshot, HostToWorkerMethods, HostToWorkerMethodName, WorkerToHostMethods, WorkerToHostMethodName, HostToWorkerRequest, HostToWorkerResponse, WorkerToHostRequest, WorkerToHostResponse, WorkerToHostNotifications, WorkerToHostNotificationName, } from "./protocol.js";
|
|
export type { PluginContext, PluginConfigClient, PluginEventsClient, PluginJobsClient, PluginLaunchersClient, PluginHttpClient, PluginSecretsClient, PluginActivityClient, PluginActivityLogEntry, PluginStateClient, PluginEntitiesClient, PluginProjectsClient, PluginCompaniesClient, PluginIssuesClient, PluginAgentsClient, PluginAgentSessionsClient, AgentSession, AgentSessionEvent, AgentSessionSendResult, PluginGoalsClient, PluginDataClient, PluginActionsClient, PluginStreamsClient, PluginToolsClient, PluginMetricsClient, PluginLogger, } from "./types.js";
|
|
export type { ScopeKey, EventFilter, PluginEvent, PluginJobContext, PluginLauncherRegistration, ToolRunContext, ToolResult, PluginEntityUpsert, PluginEntityRecord, PluginEntityQuery, PluginWorkspace, Company, Project, Issue, IssueComment, Agent, Goal, } from "./types.js";
|
|
export type { PaperclipPluginManifestV1, PluginJobDeclaration, PluginWebhookDeclaration, PluginToolDeclaration, PluginUiSlotDeclaration, PluginUiDeclaration, PluginLauncherActionDeclaration, PluginLauncherRenderDeclaration, PluginLauncherDeclaration, PluginMinimumHostVersion, PluginRecord, PluginConfig, JsonSchema, PluginStatus, PluginCategory, PluginCapability, PluginUiSlotType, PluginUiSlotEntityType, PluginLauncherPlacementZone, PluginLauncherAction, PluginLauncherBounds, PluginLauncherRenderEnvironment, PluginStateScopeKind, PluginJobStatus, PluginJobRunStatus, PluginJobRunTrigger, PluginWebhookDeliveryStatus, PluginEventType, PluginBridgeErrorCode, } from "./types.js";
|
|
/**
|
|
* Zod is re-exported for plugin authors to use when defining their
|
|
* `instanceConfigSchema` and tool `parametersSchema`.
|
|
*
|
|
* Plugin authors do not need to add a separate `zod` dependency.
|
|
*
|
|
* @see PLUGIN_SPEC.md §14.1 — Example SDK Shape
|
|
*
|
|
* @example
|
|
* ```ts
|
|
* import { z } from "@paperclipai/plugin-sdk";
|
|
*
|
|
* const configSchema = z.object({
|
|
* apiKey: z.string().describe("Your API key"),
|
|
* workspace: z.string().optional(),
|
|
* });
|
|
* ```
|
|
*/
|
|
export { z } from "zod";
|
|
export { PLUGIN_API_VERSION, PLUGIN_STATUSES, PLUGIN_CATEGORIES, PLUGIN_CAPABILITIES, PLUGIN_UI_SLOT_TYPES, PLUGIN_UI_SLOT_ENTITY_TYPES, PLUGIN_STATE_SCOPE_KINDS, PLUGIN_JOB_STATUSES, PLUGIN_JOB_RUN_STATUSES, PLUGIN_JOB_RUN_TRIGGERS, PLUGIN_WEBHOOK_DELIVERY_STATUSES, PLUGIN_EVENT_TYPES, PLUGIN_BRIDGE_ERROR_CODES, } from "@paperclipai/shared";
|
|
//# sourceMappingURL=index.d.ts.map
|