@inneranimalmedia/agentsam-sdk 2.6.10 → 2.6.11

package/packages/agentsam-contracts/dist/run.js

@@ -0,0 +1,132 @@
+// src/run.ts
+var WAIT_CODES = /* @__PURE__ */ new Set([
+  "approval_required",
+  "input_required",
+  "external_pending",
+  "dependency_pending"
+]);
+var REPLAN_CODES = /* @__PURE__ */ new Set([
+  "precondition_failed",
+  "repository_changed",
+  "capability_unavailable"
+]);
+var TRANSIENT_CODES = /* @__PURE__ */ new Set([
+  "timeout",
+  "request_timeout",
+  "rate_limited",
+  "provider_unavailable",
+  "runtime_unavailable",
+  "econnreset",
+  "econnrefused",
+  "etimedout",
+  "eai_again"
+]);
+function classifyAgentRunRetry(input = {}) {
+  const code = String(input.code || "").trim().toLowerCase();
+  const statusCode = Number(input.statusCode);
+  if (input.retryable === true) {
+    return { class: "transient", automaticRetry: true, reason: code || "explicit_retryable" };
+  }
+  if (input.retryable === false) {
+    return { class: "terminal", automaticRetry: false, reason: code || "explicit_non_retryable" };
+  }
+  if (WAIT_CODES.has(code)) {
+    return { class: "wait", automaticRetry: false, reason: code };
+  }
+  if (REPLAN_CODES.has(code)) {
+    return { class: "replan", automaticRetry: false, reason: code };
+  }
+  if (TRANSIENT_CODES.has(code) || [408, 425, 429, 500, 502, 503, 504].includes(statusCode)) {
+    return { class: "transient", automaticRetry: true, reason: code || `http_${statusCode}` };
+  }
+  return { class: "terminal", automaticRetry: false, reason: code || "unclassified_failure" };
+}
+function evaluateAgentRunWake(suspension, wake, options = {}) {
+  const consumed = new Set(options.consumedDedupeKeys || []);
+  if (consumed.has(wake.dedupeKey)) return { accepted: false, reason: "duplicate" };
+  if (suspension.runId !== wake.runId) return { accepted: false, reason: "run_mismatch" };
+  const now = options.now ?? wake.occurredAt;
+  if (suspension.expiresAt != null && now > suspension.expiresAt) {
+    return { accepted: false, reason: "expired" };
+  }
+  const matched = wake.kind === "manual" || Boolean(suspension.wakeEvent && wake.eventKey === suspension.wakeEvent) || Boolean(
+    wake.kind === "dependency" && wake.dependencyRunId && (suspension.dependencyRunIds || []).includes(wake.dependencyRunId)
+  ) || Boolean(wake.kind === "scheduled" && suspension.wakeAt != null && now >= suspension.wakeAt);
+  return matched ? { accepted: true, reason: "accepted", nextStatus: "queued" } : { accepted: false, reason: "condition_not_met" };
+}
+function wakeMatchesSuspension(suspension, wake, now = wake.occurredAt) {
+  return evaluateAgentRunWake(suspension, wake, { now }).accepted;
+}
+function transitionAgentRunStatus(status, action) {
+  if (status === "completed" || status === "failed" || status === "cancelled" || status === "timed_out") {
+    return status;
+  }
+  if (action.type === "cancel") return "cancelled";
+  if (action.type === "timeout") return "timed_out";
+  if (action.type === "complete") return "completed";
+  if (action.type === "fail") return "failed";
+  if (action.type === "suspend") return action.status;
+  if (action.type === "wake") return "queued";
+  if (action.type === "start") return "running";
+  return status;
+}
+function phaseForRunEvent(event) {
+  if (event.phase) return event.phase;
+  if (event.eventType === "run.created" || event.eventType === "run.queued" || event.eventType === "run.started") return "boot";
+  if (event.eventType === "run.suspended") return "waiting";
+  if (event.eventType === "run.woken" || event.eventType === "run.cancel_requested") return "recover";
+  if (event.eventType === "verification.completed") return "verify";
+  if (event.eventType === "run.completed" || event.eventType === "run.cancelled" || event.eventType === "run.timed_out") return "complete";
+  if (event.eventType === "run.failed") return "complete";
+  return "execute";
+}
+function activityTypeForRunEvent(event) {
+  if (event.eventType === "run.started") return "run.started";
+  if (event.eventType === "run.completed") return "run.completed";
+  if (event.eventType === "run.failed" || event.eventType === "run.timed_out") return "run.failed";
+  if (event.eventType === "run.cancelled" || event.eventType === "run.suspended" || event.eventType === "run.woken" || event.eventType === "run.status" || event.eventType === "run.cancel_requested" || event.eventType === "run.created" || event.eventType === "run.queued") return "phase.changed";
+  if (event.eventType === "step.started") return "step.started";
+  if (event.eventType === "step.completed") return "step.completed";
+  if (event.eventType === "decision.made") return "decision.made";
+  if (event.eventType === "tool.started") return "tool.started";
+  if (event.eventType === "tool.completed") return "tool.completed";
+  if (event.eventType === "artifact.created") return "artifact.created";
+  if (event.eventType === "file.changed") return "file.changed";
+  if (event.eventType === "approval.required") return "approval.required";
+  if (event.eventType === "input.required") return "input.required";
+  if (event.eventType === "verification.completed") return "verification.completed";
+  return "step.progress";
+}
+function projectRunEventToActivity(event) {
+  const evidence = {
+    ...event.evidence || {},
+    run_event_id: event.id,
+    run_event_type: event.eventType,
+    ...event.status ? { run_status: event.status } : {}
+  };
+  return {
+    schema: "agentsam.activity.v1",
+    run_id: event.runId,
+    seq: event.seq,
+    timestamp: new Date(event.createdAt).toISOString(),
+    phase: phaseForRunEvent(event),
+    event: activityTypeForRunEvent(event),
+    step_id: event.stepId ?? null,
+    parent_id: event.parentRunId ?? null,
+    label: event.label || "",
+    detail: event.detail ?? null,
+    progress: event.progress ?? null,
+    source: {
+      kind: event.source?.kind || "sam",
+      name: event.source?.name ?? null
+    },
+    evidence
+  };
+}
+export {
+  classifyAgentRunRetry,
+  evaluateAgentRunWake,
+  projectRunEventToActivity,
+  transitionAgentRunStatus,
+  wakeMatchesSuspension
+};

package/packages/agentsam-contracts/dist/tools.d.ts

@@ -0,0 +1,82 @@
+import type { AgentAuthorityRequirement } from './authority';
+export interface AgentCapability {
+    id: string;
+    label?: string;
+    description?: string;
+    enabled?: boolean;
+    metadata?: Record<string, unknown>;
+}
+export type AgentJsonSchema = Record<string, unknown>;
+export type AgentToolSideEffectLevel = 'none' | 'local_write' | 'external_write' | 'billable_external_write' | 'destructive_possible';
+export type AgentToolRiskLevel = 'low' | 'moderate' | 'high' | 'critical';
+export type AgentToolReceiptMode = 'full' | 'redacted' | 'metadata_only';
+export type AgentToolIdempotencyMode = 'not_applicable' | 'intrinsic' | 'supported' | 'required';
+export type AgentToolHandlerType = 'local' | 'http' | 'worker_rpc' | 'execos' | 'mcp' | 'custom';
+export interface AgentToolHandlerReference {
+    type: AgentToolHandlerType;
+    ref: string;
+    metadata?: Record<string, unknown>;
+}
+export interface AgentToolRetryPolicy {
+    maxAttempts: number;
+    backoff?: 'none' | 'fixed' | 'exponential';
+    baseDelayMs?: number;
+    maxDelayMs?: number;
+    retryableReasons?: string[];
+}
+export interface AgentToolDefinition {
+    toolKey: string;
+    displayName: string;
+    description?: string;
+    provider?: string;
+    pluginId?: string;
+    capabilityKey: string;
+    handler?: AgentToolHandlerReference;
+    inputSchema: AgentJsonSchema;
+    outputSchema: AgentJsonSchema;
+    authority?: AgentAuthorityRequirement[];
+    riskLevel: AgentToolRiskLevel;
+    sideEffectLevel: AgentToolSideEffectLevel;
+    idempotencyMode: AgentToolIdempotencyMode;
+    timeoutMs?: number;
+    retryPolicy?: AgentToolRetryPolicy;
+    receiptMode?: AgentToolReceiptMode;
+    sensitiveInputPaths?: string[];
+    sensitiveOutputPaths?: string[];
+    emitsEvents?: string[];
+    active?: boolean;
+    metadata?: Record<string, unknown>;
+}
+export type AgentToolCallStatus = 'queued' | 'running' | 'retrying' | 'awaiting_input' | 'completed' | 'failed' | 'cancelled' | 'timed_out';
+export interface AgentToolCall {
+    id: string;
+    runId?: string;
+    name: string;
+    toolKey?: string;
+    status: AgentToolCallStatus;
+    startedAt?: number;
+    completedAt?: number;
+    input?: unknown;
+    output?: unknown;
+    error?: string;
+    metadata?: Record<string, unknown>;
+}
+export type AgentToolPermissionDecision = 'allow_once' | 'allow_session' | 'deny';
+export interface AgentToolPermissionDatum {
+    label: string;
+    value: string;
+}
+export interface AgentToolPermissionRequest {
+    id: string;
+    toolKey: string;
+    displayName: string;
+    provider?: string;
+    summary?: string;
+    scope?: string;
+    sharedData?: AgentToolPermissionDatum[];
+    riskLevel?: AgentToolRiskLevel;
+    sideEffectLevel?: AgentToolSideEffectLevel;
+    destructive?: boolean;
+    openWorld?: boolean;
+    metadata?: Record<string, unknown>;
+}

package/packages/agentsam-contracts/dist/widgets.d.ts

@@ -0,0 +1,38 @@
+import type { AgentSamErrorEnvelope } from './errors';
+export type AgentSamWidgetSize = 'small' | 'medium' | 'large';
+export type AgentSamWidgetKind = 'countdown' | 'clock' | 'metric' | 'list' | 'launcher' | 'brand' | (string & {});
+export interface AgentSamWidgetDataSource {
+    /** Existing route key, tool operation id, or host-owned projection id. */
+    source: string;
+    /** Host-defined refresh class, such as realtime, short, medium, or manual. */
+    refresh?: string;
+}
+export interface AgentSamWidgetDefinition {
+    id: string;
+    kind: AgentSamWidgetKind;
+    title: string;
+    description?: string;
+    icon?: string;
+    sizes: readonly AgentSamWidgetSize[];
+    data?: AgentSamWidgetDataSource;
+    /** Route key or host-resolved deep link. Do not put credentials or raw provider secrets here. */
+    deeplink?: string;
+}
+export interface AgentSamWidgetReadyState {
+    status: 'ready';
+    updated_at?: string;
+}
+export interface AgentSamWidgetStaleState {
+    status: 'stale';
+    updated_at: string;
+    error: AgentSamErrorEnvelope;
+}
+export interface AgentSamWidgetEmptyState {
+    status: 'empty';
+    updated_at?: string;
+}
+export interface AgentSamWidgetErrorState {
+    status: 'error';
+    error: AgentSamErrorEnvelope;
+}
+export type AgentSamWidgetState = AgentSamWidgetReadyState | AgentSamWidgetStaleState | AgentSamWidgetEmptyState | AgentSamWidgetErrorState;

package/packages/agentsam-contracts/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inneranimalmedia/agentsam-contracts",
-  "version": "2.6.10",
+  "version": "2.6.11",
   "description": "Framework-neutral AgentSam contracts for workbench, tools, providers, events, hooks, execution, identity and repository context.",
   "type": "module",
   "main": "./dist/index.js",
@@ -17,6 +17,10 @@
       "types": "./dist/events.d.ts",
       "import": "./dist/events.js"
     },
+    "./run": {
+      "types": "./dist/run.d.ts",
+      "import": "./dist/run.js"
+    },
     "./tools": {
       "types": "./dist/tools.d.ts",
       "import": "./dist/tools.js"
@@ -64,6 +68,10 @@
     "./errors": {
       "types": "./dist/errors.d.ts",
       "import": "./dist/errors.js"
+    },
+    "./widgets": {
+      "types": "./dist/widgets.d.ts",
+      "import": "./dist/widgets.js"
     }
   },
   "scripts": {

package/packages/agentsam-contracts/scripts/build.mjs

@@ -4,7 +4,7 @@ import { fileURLToPath } from 'node:url';
 import { build } from 'esbuild';
 
 const cwd = fileURLToPath(new URL('../', import.meta.url));
-const modules = ['index','agent','events','tools','authority','execution','providers','hooks','artifacts','context','adapter','models','identity','repository','errors'];
+const modules = ['index','agent','events','run','tools','authority','execution','providers','hooks','artifacts','context','adapter','models','identity','repository','errors','widgets'];
 rmSync(`${cwd}/dist`, { recursive: true, force: true });
 await build({
   absWorkingDir: cwd,

package/packages/agentsam-contracts/src/agent.ts

@@ -22,14 +22,89 @@ export interface AgentInput {
   capabilityIds?: string[];
 }
 
-export type AgentRunStatus = 'queued' | 'running' | 'completed' | 'cancelled' | 'failed';
+export type AgentRunMode = 'ask' | 'plan' | 'agent' | 'debug' | 'multitask';
+
+export type AgentRunSelectedBy = 'manual' | 'automatic' | 'fallback';
+
+export type AgentRunStatus =
+  | 'queued'
+  | 'running'
+  | 'paused'
+  | 'waiting_external'
+  | 'waiting_child'
+  | 'awaiting_input'
+  | 'awaiting_approval'
+  | 'sleeping'
+  | 'retry_scheduled'
+  | 'partial'
+  | 'completed'
+  | 'cancelled'
+  | 'failed'
+  | 'timed_out';
+
+export type AgentRunTerminalStatus = 'completed' | 'cancelled' | 'failed' | 'timed_out';
+
+export type AgentRunWaitingStatus =
+  | 'waiting_external'
+  | 'waiting_child'
+  | 'awaiting_input'
+  | 'awaiting_approval'
+  | 'sleeping'
+  | 'retry_scheduled';
 
 export interface AgentRun {
   id: string;
-  conversationId: string;
+  conversationId?: string;
   status: AgentRunStatus;
-  startedAt: number;
+  startedAt?: number;
   completedAt?: number;
+
+  accountId?: string;
+  kind?: string;
+  externalAgentId?: string;
+  externalRunId?: string;
+  parentRunId?: string;
+  sourceClient?: string;
+  surface?: string;
+  mode?: AgentRunMode;
   modelId?: string;
+  modelKey?: string;
+  reasoningEffort?: string;
+  requestedServiceTier?: string;
+  actualServiceTier?: string;
+  selectedBy?: AgentRunSelectedBy;
+  cancelRequested?: boolean;
+  errorCode?: string;
+  errorMessage?: string;
   error?: string;
+  modelCallCount?: number;
+  toolCallCount?: number;
+  inputTokens?: number;
+  cachedInputTokens?: number;
+  outputTokens?: number;
+  reasoningTokens?: number;
+  costUsd?: number;
+  createdAt?: number;
+  updatedAt?: number;
+  latencyMs?: number;
+  planId?: string;
+  todoId?: string;
+  metadata?: Record<string, unknown>;
+}
+
+export function isAgentRunTerminalStatus(status: AgentRunStatus): status is AgentRunTerminalStatus {
+  return status === 'completed' || status === 'cancelled' || status === 'failed' || status === 'timed_out';
+}
+
+export function isAgentRunWaitingStatus(status: AgentRunStatus): status is AgentRunWaitingStatus {
+  return status === 'waiting_external'
+    || status === 'waiting_child'
+    || status === 'awaiting_input'
+    || status === 'awaiting_approval'
+    || status === 'sleeping'
+    || status === 'retry_scheduled';
+}
+
+export function isAgentRunModelActiveStatus(status: AgentRunStatus): boolean {
+  return status === 'queued' || status === 'running';
 }

package/packages/agentsam-contracts/src/index.ts

@@ -1,5 +1,6 @@
 export * from './agent';
 export * from './events';
+export * from './run';
 export * from './tools';
 export * from './authority';
 export * from './execution';
@@ -12,3 +13,4 @@ export * from './models';
 export * from './identity';
 export * from './repository';
 export * from './errors';
+export * from './widgets';