@agrentingai/paperclip-adapter 0.2.2 → 0.3.0

package/dist/server/index.d.cts

@@ -438,9 +438,70 @@ declare function forwardCommentToAgrenting$1(config: AgrentingAdapterConfig, tas
  * Called by the webhook handler when it receives task messages.
  */
 declare function processIncomingMessage$1(message: TaskMessage): string;
+/** Paperclip skill shape (subset of the canonical Paperclip Skill). */
+interface PaperclipSkill {
+    id: string;
+    name: string;
+    description?: string;
+}
+/**
+ * Detect a sensible default model/provider for the configured Agrenting agent.
+ * Paperclip calls this to pre-populate the adapter UI when an agent is
+ * created. Returns null if no info is available.
+ */
+declare function detectModel(config: Pick<AgrentingAdapterConfig, "agrentingUrl" | "apiKey" | "agentDid">): Promise<{
+    provider: string;
+    model: string;
+} | null>;
+/**
+ * Enumerate the configured Agrenting agent's capabilities and map them to
+ * Paperclip's Skill shape.
+ */
+declare function listSkills(config: AgrentingAdapterConfig): Promise<PaperclipSkill[]>;
+/**
+ * Reconcile the agent's current capabilities against Paperclip's local skill
+ * registry. Returns sets to add and remove.
+ */
+declare function syncSkills(config: AgrentingAdapterConfig, existing: PaperclipSkill[]): Promise<{
+    added: PaperclipSkill[];
+    removed: PaperclipSkill[];
+}>;
+/**
+ * Session codec — Paperclip uses this to serialise session state across
+ * heartbeats. Hirings carry no rich session state, so we pass JSON through.
+ */
+declare const sessionCodec: {
+    encode(state: unknown): string;
+    decode(blob: string | null | undefined): unknown;
+};
+/**
+ * Canonical `AgentAdapter.invoke`. Forwards to {@link execute}.
+ */
+declare function invoke(config: AgrentingAdapterConfig, params: {
+    input: string;
+    capability: string;
+    instructions?: string;
+    maxPrice?: string;
+    paymentType?: string;
+}): Promise<AgrentingExecutionResult>;
+/**
+ * Canonical `AgentAdapter.status`. Returns the current run status.
+ */
+declare function status(config: AgrentingAdapterConfig, taskId: string): Promise<{
+    status: AgrentingTaskStatus;
+    progressPercent: number;
+    progressMessage?: string;
+}>;
+/**
+ * Canonical `AgentAdapter.cancel`. Cancels a running task; throws on failure
+ * so Paperclip can treat the call as a void Promise.
+ */
+declare function cancel(config: AgrentingAdapterConfig, taskId: string): Promise<void>;
 /**
  * Create the server-side adapter module.
- * This is the entry point for Paperclip's server adapter registry.
+ * Backward-compat convenience for callers that prefer a single bundle. New
+ * Paperclip plugin loaders should use the named exports directly via
+ * `~/.paperclip/adapter-plugins.json`.
  */
 declare function createServerAdapter(): {
     name: "agrenting";
@@ -474,6 +535,16 @@ declare function createServerAdapter(): {
     getTransactions: typeof getTransactions;
     deposit: typeof deposit;
     withdraw: typeof withdraw;
+    invoke: typeof invoke;
+    status: typeof status;
+    cancel: typeof cancel;
+    detectModel: typeof detectModel;
+    listSkills: typeof listSkills;
+    syncSkills: typeof syncSkills;
+    sessionCodec: {
+        encode(state: unknown): string;
+        decode(blob: string | null | undefined): unknown;
+    };
 };
 
 /**
@@ -892,4 +963,4 @@ declare function formatInsufficientBalanceComment(balanceInfo: BalanceInfo): str
  */
 declare function verifyWebhookSignature(rawBody: string, signature: string, secret: string): Promise<boolean>;
 
-export { type AgentInfo, type AgentProfile, type AgrentingAdapterConfig, AgrentingClient, type AgrentingExecutionResult, type AgrentingTask, type AgrentingTaskStatus, type AgrentingWebhookPayload, type AutoSelectOptions, type BalanceCheckOptions, type BalanceInfo, type Capability, type CreateTaskPaymentOptions, type DiscoverAgentsOptions, type HireAgentResult, type Hiring, type HiringMessage, MAX_POLLS, POLL_INTERVALS_MS, type PaperclipApiClient, type PaymentInfo, type PollOptions, type PollResult, type ReassignTaskResult, type RetryHiringOptions, type SendMessageOptions, type SendMessageResult, type TaskMessage, type TransactionInfo, type WebhookHandlerOptions, autoSelectAgent, canSubmitTask, checkBalance, createServerAdapter, createWebhookHandler, deregisterWebhook, executeWithRetry, formatAgentResponse, formatInsufficientBalanceComment, formatLowBalanceComment, forwardCommentToAgrenting, getActiveTaskMappings, getAgentProfile, getBackoffMs, getHiring, getHiringMessages, getTaskMessages, getWebhookGracePeriodMs, hireAgent, listCapabilities, listHirings, pollTaskUntilDone, processIncomingMessage, reassignTask, registerTaskMapping, registerWebhook, retryHiring, sendMessageToHiring, sendMessageToTask, unregisterTaskMapping, verifyWebhookSignature };
+export { type AgentInfo, type AgentProfile, type AgrentingAdapterConfig, AgrentingClient, type AgrentingExecutionResult, type AgrentingTask, type AgrentingTaskStatus, type AgrentingWebhookPayload, type AutoSelectOptions, type BalanceCheckOptions, type BalanceInfo, type Capability, type CreateTaskPaymentOptions, type DiscoverAgentsOptions, type HireAgentResult, type Hiring, type HiringMessage, MAX_POLLS, POLL_INTERVALS_MS, type PaperclipApiClient, type PaperclipSkill, type PaymentInfo, type PollOptions, type PollResult, type ReassignTaskResult, type RetryHiringOptions, type SendMessageOptions, type SendMessageResult, type TaskMessage, type TransactionInfo, type WebhookHandlerOptions, autoSelectAgent, canSubmitTask, cancel, cancelTask, checkBalance, createServerAdapter, createWebhookHandler, deregisterWebhook, detectModel, execute, executeWithRetry, formatAgentResponse, formatInsufficientBalanceComment, formatLowBalanceComment, forwardCommentToAgrenting, getActiveTaskMappings, getAgentProfile, getBackoffMs, getConfigSchema, getHiring, getHiringMessages, getTaskMessages, getTaskProgress, getWebhookGracePeriodMs, hireAgent, invoke, listCapabilities, listHirings, listSkills, pollTaskUntilDone, processIncomingMessage, reassignTask, registerTaskMapping, registerWebhook, retryHiring, sendMessageToHiring, sendMessageToTask, sessionCodec, status, syncSkills, testEnvironment, unregisterTaskMapping, verifyWebhookSignature };

package/dist/server/index.d.ts

@@ -438,9 +438,70 @@ declare function forwardCommentToAgrenting$1(config: AgrentingAdapterConfig, tas
  * Called by the webhook handler when it receives task messages.
  */
 declare function processIncomingMessage$1(message: TaskMessage): string;
+/** Paperclip skill shape (subset of the canonical Paperclip Skill). */
+interface PaperclipSkill {
+    id: string;
+    name: string;
+    description?: string;
+}
+/**
+ * Detect a sensible default model/provider for the configured Agrenting agent.
+ * Paperclip calls this to pre-populate the adapter UI when an agent is
+ * created. Returns null if no info is available.
+ */
+declare function detectModel(config: Pick<AgrentingAdapterConfig, "agrentingUrl" | "apiKey" | "agentDid">): Promise<{
+    provider: string;
+    model: string;
+} | null>;
+/**
+ * Enumerate the configured Agrenting agent's capabilities and map them to
+ * Paperclip's Skill shape.
+ */
+declare function listSkills(config: AgrentingAdapterConfig): Promise<PaperclipSkill[]>;
+/**
+ * Reconcile the agent's current capabilities against Paperclip's local skill
+ * registry. Returns sets to add and remove.
+ */
+declare function syncSkills(config: AgrentingAdapterConfig, existing: PaperclipSkill[]): Promise<{
+    added: PaperclipSkill[];
+    removed: PaperclipSkill[];
+}>;
+/**
+ * Session codec — Paperclip uses this to serialise session state across
+ * heartbeats. Hirings carry no rich session state, so we pass JSON through.
+ */
+declare const sessionCodec: {
+    encode(state: unknown): string;
+    decode(blob: string | null | undefined): unknown;
+};
+/**
+ * Canonical `AgentAdapter.invoke`. Forwards to {@link execute}.
+ */
+declare function invoke(config: AgrentingAdapterConfig, params: {
+    input: string;
+    capability: string;
+    instructions?: string;
+    maxPrice?: string;
+    paymentType?: string;
+}): Promise<AgrentingExecutionResult>;
+/**
+ * Canonical `AgentAdapter.status`. Returns the current run status.
+ */
+declare function status(config: AgrentingAdapterConfig, taskId: string): Promise<{
+    status: AgrentingTaskStatus;
+    progressPercent: number;
+    progressMessage?: string;
+}>;
+/**
+ * Canonical `AgentAdapter.cancel`. Cancels a running task; throws on failure
+ * so Paperclip can treat the call as a void Promise.
+ */
+declare function cancel(config: AgrentingAdapterConfig, taskId: string): Promise<void>;
 /**
  * Create the server-side adapter module.
- * This is the entry point for Paperclip's server adapter registry.
+ * Backward-compat convenience for callers that prefer a single bundle. New
+ * Paperclip plugin loaders should use the named exports directly via
+ * `~/.paperclip/adapter-plugins.json`.
  */
 declare function createServerAdapter(): {
     name: "agrenting";
@@ -474,6 +535,16 @@ declare function createServerAdapter(): {
     getTransactions: typeof getTransactions;
     deposit: typeof deposit;
     withdraw: typeof withdraw;
+    invoke: typeof invoke;
+    status: typeof status;
+    cancel: typeof cancel;
+    detectModel: typeof detectModel;
+    listSkills: typeof listSkills;
+    syncSkills: typeof syncSkills;
+    sessionCodec: {
+        encode(state: unknown): string;
+        decode(blob: string | null | undefined): unknown;
+    };
 };
 
 /**
@@ -892,4 +963,4 @@ declare function formatInsufficientBalanceComment(balanceInfo: BalanceInfo): str
  */
 declare function verifyWebhookSignature(rawBody: string, signature: string, secret: string): Promise<boolean>;
 
-export { type AgentInfo, type AgentProfile, type AgrentingAdapterConfig, AgrentingClient, type AgrentingExecutionResult, type AgrentingTask, type AgrentingTaskStatus, type AgrentingWebhookPayload, type AutoSelectOptions, type BalanceCheckOptions, type BalanceInfo, type Capability, type CreateTaskPaymentOptions, type DiscoverAgentsOptions, type HireAgentResult, type Hiring, type HiringMessage, MAX_POLLS, POLL_INTERVALS_MS, type PaperclipApiClient, type PaymentInfo, type PollOptions, type PollResult, type ReassignTaskResult, type RetryHiringOptions, type SendMessageOptions, type SendMessageResult, type TaskMessage, type TransactionInfo, type WebhookHandlerOptions, autoSelectAgent, canSubmitTask, checkBalance, createServerAdapter, createWebhookHandler, deregisterWebhook, executeWithRetry, formatAgentResponse, formatInsufficientBalanceComment, formatLowBalanceComment, forwardCommentToAgrenting, getActiveTaskMappings, getAgentProfile, getBackoffMs, getHiring, getHiringMessages, getTaskMessages, getWebhookGracePeriodMs, hireAgent, listCapabilities, listHirings, pollTaskUntilDone, processIncomingMessage, reassignTask, registerTaskMapping, registerWebhook, retryHiring, sendMessageToHiring, sendMessageToTask, unregisterTaskMapping, verifyWebhookSignature };
+export { type AgentInfo, type AgentProfile, type AgrentingAdapterConfig, AgrentingClient, type AgrentingExecutionResult, type AgrentingTask, type AgrentingTaskStatus, type AgrentingWebhookPayload, type AutoSelectOptions, type BalanceCheckOptions, type BalanceInfo, type Capability, type CreateTaskPaymentOptions, type DiscoverAgentsOptions, type HireAgentResult, type Hiring, type HiringMessage, MAX_POLLS, POLL_INTERVALS_MS, type PaperclipApiClient, type PaperclipSkill, type PaymentInfo, type PollOptions, type PollResult, type ReassignTaskResult, type RetryHiringOptions, type SendMessageOptions, type SendMessageResult, type TaskMessage, type TransactionInfo, type WebhookHandlerOptions, autoSelectAgent, canSubmitTask, cancel, cancelTask, checkBalance, createServerAdapter, createWebhookHandler, deregisterWebhook, detectModel, execute, executeWithRetry, formatAgentResponse, formatInsufficientBalanceComment, formatLowBalanceComment, forwardCommentToAgrenting, getActiveTaskMappings, getAgentProfile, getBackoffMs, getConfigSchema, getHiring, getHiringMessages, getTaskMessages, getTaskProgress, getWebhookGracePeriodMs, hireAgent, invoke, listCapabilities, listHirings, listSkills, pollTaskUntilDone, processIncomingMessage, reassignTask, registerTaskMapping, registerWebhook, retryHiring, sendMessageToHiring, sendMessageToTask, sessionCodec, status, syncSkills, testEnvironment, unregisterTaskMapping, verifyWebhookSignature };

package/dist/server/index.js

@@ -841,11 +841,11 @@ async function startWebhookListener(config) {
         if (resolvedTaskId) {
           const pending = pendingTasks.get(resolvedTaskId);
           if (pending && !pending.settled) {
-            const status = payload.status ?? pending.status;
-            pending.status = status;
+            const status2 = payload.status ?? pending.status;
+            pending.status = status2;
             pending.progressPercent = payload.progress_percent ?? pending.progressPercent;
             pending.progressMessage = payload.progress_message ?? pending.progressMessage;
-            if (status === "completed") {
+            if (status2 === "completed") {
               pending.settled = true;
               pending.resolve({
                 success: true,
@@ -853,7 +853,7 @@ async function startWebhookListener(config) {
                 taskId: resolvedTaskId,
                 durationMs: Date.now() - pending.startedAt
               });
-            } else if (status === "failed") {
+            } else if (status2 === "failed") {
               pending.settled = true;
               pending.resolve({
                 success: false,
@@ -861,7 +861,7 @@ async function startWebhookListener(config) {
                 taskId: resolvedTaskId,
                 durationMs: Date.now() - pending.startedAt
               });
-            } else if (status === "cancelled") {
+            } else if (status2 === "cancelled") {
               pending.settled = true;
               pending.resolve({
                 success: false,
@@ -1262,6 +1262,65 @@ function processIncomingMessage2(message) {
   const senderName = message.sender_name ?? "Agent";
   return formatAgentResponse(senderName, message.content);
 }
+async function detectModel(config) {
+  if (!config.agentDid) return null;
+  try {
+    const profile = await getAgentProfile(config, config.agentDid);
+    const provider = profile.ai_provider ?? null;
+    const model = profile.ai_model ?? null;
+    if (provider && model) return { provider, model };
+  } catch {
+  }
+  return null;
+}
+async function listSkills(config) {
+  const profile = await getAgentProfile(config, config.agentDid);
+  const capabilities = profile.capabilities ?? [];
+  return capabilities.map((cap) => ({
+    id: `${config.agentDid}:${cap}`,
+    name: cap,
+    description: `Capability "${cap}" of agent ${config.agentDid}`
+  }));
+}
+async function syncSkills(config, existing) {
+  const remote = await listSkills(config);
+  const remoteIds = new Set(remote.map((s) => s.id));
+  const existingIds = new Set(existing.map((s) => s.id));
+  return {
+    added: remote.filter((s) => !existingIds.has(s.id)),
+    removed: existing.filter((s) => !remoteIds.has(s.id))
+  };
+}
+var sessionCodec = {
+  encode(state) {
+    return JSON.stringify(state ?? null);
+  },
+  decode(blob) {
+    if (!blob) return null;
+    try {
+      return JSON.parse(blob);
+    } catch {
+      return null;
+    }
+  }
+};
+async function invoke(config, params) {
+  return execute(config, params);
+}
+async function status(config, taskId) {
+  const progress = await getTaskProgress(config, taskId);
+  return {
+    status: progress.status,
+    progressPercent: progress.progressPercent,
+    progressMessage: progress.progressMessage
+  };
+}
+async function cancel(config, taskId) {
+  const result = await cancelTask(config, taskId);
+  if (!result.success) {
+    throw new Error(result.error ?? "Failed to cancel task");
+  }
+}
 function createServerAdapter() {
   return {
     name: "agrenting",
@@ -1294,7 +1353,15 @@ function createServerAdapter() {
     getBalance,
     getTransactions,
     deposit,
-    withdraw
+    withdraw,
+    // Canonical contract additions:
+    invoke,
+    status,
+    cancel,
+    detectModel,
+    listSkills,
+    syncSkills,
+    sessionCodec
   };
 }
 export {
@@ -1303,10 +1370,14 @@ export {
   POLL_INTERVALS_MS,
   autoSelectAgent,
   canSubmitTask,
+  cancel,
+  cancelTask,
   checkBalance,
   createServerAdapter,
   createWebhookHandler,
   deregisterWebhook,
+  detectModel,
+  execute,
   executeWithRetry,
   formatAgentResponse,
   formatInsufficientBalanceComment,
@@ -1315,13 +1386,17 @@ export {
   getActiveTaskMappings,
   getAgentProfile,
   getBackoffMs,
+  getConfigSchema,
   getHiring,
   getHiringMessages,
   getTaskMessages,
+  getTaskProgress,
   getWebhookGracePeriodMs,
   hireAgent,
+  invoke,
   listCapabilities,
   listHirings,
+  listSkills,
   pollTaskUntilDone,
   processIncomingMessage,
   reassignTask,
@@ -1330,6 +1405,10 @@ export {
   retryHiring,
   sendMessageToHiring,
   sendMessageToTask,
+  sessionCodec,
+  status,
+  syncSkills,
+  testEnvironment,
   unregisterTaskMapping,
   verifyWebhookSignature
 };