@agent-os-sdk/client 0.1.1 → 0.1.2

package/src/index.ts

@@ -105,6 +105,17 @@ export { InfoModule, type ServerInfo } from "./modules/info.js";
 export { MetricsModule, type MetricsResponse } from "./modules/metrics.js";
 export { GraphsModule, type GraphValidationResult, type GraphIntrospectionResult } from "./modules/graphs.js";
 
+// MOCK - Future modules (marked for replacement when backend is ready)
+export { HandoffModule, type HandoffOptions, type HandoffResult, type ForkOptions, type ForkResult, type RunChain, type RunChainNode, type HandoffMode, type HandoffConstraints } from "./modules/handoff.js";
+export { FlowsModule, type Flow, type FlowStep, type FlowRun, type FlowVisualization, type FlowSimulationResult, type FlowStatus, type FlowListResponse } from "./modules/flows.js";
+export { CapabilitiesModule, type Capability, type CapabilityConfig, type CapabilitySet, type CapabilityOverride } from "./modules/capabilities.js";
+export { PoliciesModule, type Policy, type PolicyType, type PolicyScope, type PolicyCondition, type PolicyAction, type PolicyEvaluationInput, type PolicyEvaluationResult, type PolicyListResponse } from "./modules/policies.js";
+export { ApprovalsModule, type Approval, type ApprovalStatus, type ApprovalRequest, type ApprovalListResponse } from "./modules/approvals.js";
+export { BudgetsModule, type Budget, type BudgetPeriod, type BudgetScope, type BudgetUsage, type BudgetBreakdown, type CostEstimate, type BudgetListResponse } from "./modules/budgets.js";
+export { DeploymentsModule, type Environment, type EnvironmentType, type Deployment, type DeploymentStatus, type DeploymentDiff, type EnvironmentListResponse, type DeploymentListResponse } from "./modules/deployments.js";
+export { IncidentsModule, type Incident, type IncidentSeverity, type IncidentStatus, type SLO, type Postmortem, type PostmortemEvent, type ActionItem, type IncidentListResponse, type SLOListResponse } from "./modules/incidents.js";
+export { ArtifactsModule, type Artifact, type ArtifactType, type ArtifactLineage, type LineageSource, type LineageTransformation, type ArtifactListResponse } from "./modules/artifacts.js";
+
 // ============================================================================
 // SSE Streaming
 // ============================================================================

package/src/modules/approvals.ts

@@ -0,0 +1,210 @@
+/**
+ * Approvals Module - Human-in-the-Loop Native
+ * 
+ * // MOCK - This module contains mock implementations for future features
+ * 
+ * Provides native support for approval workflows.
+ * Critical for production deployments with dangerous actions.
+ */
+
+import type { RawClient, APIResponse } from "../client/raw.js";
+
+// ============================================================================
+// Types
+// ============================================================================
+
+export type ApprovalStatus = "pending" | "approved" | "rejected" | "expired" | "auto_approved";
+
+export interface Approval {
+    id: string;
+    run_id: string;
+    thread_id?: string;
+    action: string;
+    payload: Record<string, unknown>;
+    status: ApprovalStatus;
+    reason?: string;
+    requested_at: string;
+    responded_at?: string;
+    responded_by?: string;
+    expires_at?: string;
+    auto_approve_after?: number; // seconds
+}
+
+export interface ApprovalRequest {
+    run_id: string;
+    action: string;
+    payload: Record<string, unknown>;
+    expires_in_seconds?: number;
+    auto_approve_after_seconds?: number;
+    notify_channels?: string[];
+}
+
+export interface ApprovalListResponse {
+    items: Approval[];
+    total: number;
+    pending_count: number;
+}
+
+export interface ApprovalDecision {
+    approval_id: string;
+    decision: "approve" | "reject";
+    reason?: string;
+    modified_payload?: Record<string, unknown>;
+}
+
+// ============================================================================
+// Module
+// ============================================================================
+
+export class ApprovalsModule {
+    constructor(private client: RawClient, private headers: () => Record<string, string>) { }
+
+    // MOCK - Simulated list
+    /**
+     * List all approvals.
+     */
+    async list(params?: {
+        status?: ApprovalStatus;
+        run_id?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<APIResponse<ApprovalListResponse>> {
+        // MOCK - Returns simulated data
+        const mockApprovals: ApprovalListResponse = {
+            items: [
+                {
+                    id: "approval_1",
+                    run_id: "run_123",
+                    thread_id: "thread_456",
+                    action: "send_email",
+                    payload: {
+                        to: "external@gmail.com",
+                        subject: "Important Update",
+                        body: "Hello, this is an important message...",
+                    },
+                    status: "pending",
+                    requested_at: new Date(Date.now() - 300000).toISOString(),
+                    expires_at: new Date(Date.now() + 3600000).toISOString(),
+                },
+                {
+                    id: "approval_2",
+                    run_id: "run_124",
+                    action: "execute_payment",
+                    payload: {
+                        amount: 1500.00,
+                        currency: "USD",
+                        recipient: "vendor@company.com",
+                    },
+                    status: "pending",
+                    requested_at: new Date(Date.now() - 600000).toISOString(),
+                    expires_at: new Date(Date.now() + 7200000).toISOString(),
+                },
+            ],
+            total: 2,
+            pending_count: 2,
+        };
+        return { data: mockApprovals, error: undefined, response: new Response() };
+    }
+
+    // MOCK - Simulated get
+    /**
+     * Get an approval by ID.
+     */
+    async get(approvalId: string): Promise<APIResponse<Approval>> {
+        // MOCK - Returns simulated data
+        const mockApproval: Approval = {
+            id: approvalId,
+            run_id: "run_123",
+            action: "send_email",
+            payload: {
+                to: "external@gmail.com",
+                subject: "Important Update",
+            },
+            status: "pending",
+            requested_at: new Date(Date.now() - 300000).toISOString(),
+            expires_at: new Date(Date.now() + 3600000).toISOString(),
+        };
+        return { data: mockApproval, error: undefined, response: new Response() };
+    }
+
+    // MOCK - Simulated create
+    /**
+     * Create a new approval request.
+     */
+    async create(request: ApprovalRequest): Promise<APIResponse<Approval>> {
+        // MOCK - Returns simulated data
+        const mockApproval: Approval = {
+            id: `approval_${Date.now()}`,
+            run_id: request.run_id,
+            action: request.action,
+            payload: request.payload,
+            status: "pending",
+            requested_at: new Date().toISOString(),
+            expires_at: request.expires_in_seconds
+                ? new Date(Date.now() + request.expires_in_seconds * 1000).toISOString()
+                : undefined,
+            auto_approve_after: request.auto_approve_after_seconds,
+        };
+        return { data: mockApproval, error: undefined, response: new Response() };
+    }
+
+    // MOCK - Simulated approve
+    /**
+     * Approve an action.
+     */
+    async approve(approvalId: string, reason?: string): Promise<APIResponse<Approval>> {
+        // MOCK - Returns simulated data
+        const mockApproval: Approval = {
+            id: approvalId,
+            run_id: "run_123",
+            action: "send_email",
+            payload: {},
+            status: "approved",
+            reason,
+            requested_at: new Date(Date.now() - 300000).toISOString(),
+            responded_at: new Date().toISOString(),
+            responded_by: "user_admin",
+        };
+        return { data: mockApproval, error: undefined, response: new Response() };
+    }
+
+    // MOCK - Simulated reject
+    /**
+     * Reject an action.
+     */
+    async reject(approvalId: string, reason?: string): Promise<APIResponse<Approval>> {
+        // MOCK - Returns simulated data
+        const mockApproval: Approval = {
+            id: approvalId,
+            run_id: "run_123",
+            action: "send_email",
+            payload: {},
+            status: "rejected",
+            reason: reason || "Action not permitted",
+            requested_at: new Date(Date.now() - 300000).toISOString(),
+            responded_at: new Date().toISOString(),
+            responded_by: "user_admin",
+        };
+        return { data: mockApproval, error: undefined, response: new Response() };
+    }
+
+    // MOCK - Simulated await
+    /**
+     * Wait for approval on a run (blocks until resolved or timeout).
+     */
+    async awaitApproval(runId: string, timeoutSeconds?: number): Promise<APIResponse<Approval>> {
+        // MOCK - Returns simulated pending approval
+        const mockApproval: Approval = {
+            id: `approval_await_${runId}`,
+            run_id: runId,
+            action: "awaiting_action",
+            payload: {},
+            status: "pending",
+            requested_at: new Date().toISOString(),
+            expires_at: timeoutSeconds
+                ? new Date(Date.now() + timeoutSeconds * 1000).toISOString()
+                : undefined,
+        };
+        return { data: mockApproval, error: undefined, response: new Response() };
+    }
+}

package/src/modules/artifacts.ts

@@ -0,0 +1,287 @@
+/**
+ * Artifacts Module - Output Management
+ * 
+ * // MOCK - This module contains mock implementations for future features
+ * 
+ * Manages artifacts as first-class outputs with integrity,
+ * lineage tracking, and signatures.
+ */
+
+import type { RawClient, APIResponse } from "../client/raw.js";
+
+// ============================================================================
+// Types
+// ============================================================================
+
+export type ArtifactType = "file" | "image" | "document" | "code" | "data" | "other";
+
+export interface Artifact {
+    id: string;
+    name: string;
+    type: ArtifactType;
+    mime_type: string;
+    size_bytes: number;
+    sha256: string;
+    url?: string;
+    run_id?: string;
+    thread_id?: string;
+    metadata: Record<string, unknown>;
+    signed: boolean;
+    signature?: string;
+    created_at: string;
+    created_by: string;
+}
+
+export interface ArtifactLineage {
+    artifact_id: string;
+    source: LineageSource;
+    transformations: LineageTransformation[];
+    dependencies: string[];
+}
+
+export interface LineageSource {
+    type: "run" | "upload" | "tool" | "agent";
+    id: string;
+    name: string;
+    timestamp: string;
+}
+
+export interface LineageTransformation {
+    step: number;
+    operation: string;
+    run_id?: string;
+    tool_name?: string;
+    timestamp: string;
+}
+
+export interface ArtifactListResponse {
+    items: Artifact[];
+    total: number;
+}
+
+// ============================================================================
+// Module
+// ============================================================================
+
+export class ArtifactsModule {
+    constructor(private client: RawClient, private headers: () => Record<string, string>) { }
+
+    // MOCK - Simulated list
+    /**
+     * List all artifacts.
+     */
+    async list(params?: {
+        run_id?: string;
+        thread_id?: string;
+        type?: ArtifactType;
+    }): Promise<APIResponse<ArtifactListResponse>> {
+        // MOCK - Returns simulated data
+        const mockArtifacts: ArtifactListResponse = {
+            items: [
+                {
+                    id: "artifact_1",
+                    name: "report.pdf",
+                    type: "document",
+                    mime_type: "application/pdf",
+                    size_bytes: 245000,
+                    sha256: "abc123def456...",
+                    url: "https://storage.example.com/artifacts/report.pdf",
+                    run_id: "run_123",
+                    thread_id: "thread_456",
+                    metadata: { pages: 12, author: "Agent Support" },
+                    signed: true,
+                    signature: "sig_abc123",
+                    created_at: new Date(Date.now() - 3600000).toISOString(),
+                    created_by: "agent_support",
+                },
+                {
+                    id: "artifact_2",
+                    name: "analysis.json",
+                    type: "data",
+                    mime_type: "application/json",
+                    size_bytes: 15000,
+                    sha256: "xyz789ghi012...",
+                    url: "https://storage.example.com/artifacts/analysis.json",
+                    run_id: "run_124",
+                    metadata: { records: 500 },
+                    signed: false,
+                    created_at: new Date(Date.now() - 7200000).toISOString(),
+                    created_by: "agent_analyzer",
+                },
+            ],
+            total: 2,
+        };
+        return { data: mockArtifacts, error: undefined, response: new Response() };
+    }
+
+    // MOCK - Simulated get
+    /**
+     * Get an artifact by ID.
+     */
+    async get(artifactId: string): Promise<APIResponse<Artifact>> {
+        // MOCK - Returns simulated data
+        const mockArtifact: Artifact = {
+            id: artifactId,
+            name: "report.pdf",
+            type: "document",
+            mime_type: "application/pdf",
+            size_bytes: 245000,
+            sha256: "abc123def456...",
+            url: "https://storage.example.com/artifacts/report.pdf",
+            run_id: "run_123",
+            metadata: { pages: 12 },
+            signed: true,
+            signature: "sig_abc123",
+            created_at: new Date(Date.now() - 3600000).toISOString(),
+            created_by: "agent_support",
+        };
+        return { data: mockArtifact, error: undefined, response: new Response() };
+    }
+
+    // MOCK - Simulated create
+    /**
+     * Create a new artifact reference.
+     */
+    async create(body: {
+        name: string;
+        type: ArtifactType;
+        mime_type: string;
+        size_bytes: number;
+        sha256: string;
+        run_id?: string;
+        thread_id?: string;
+        metadata?: Record<string, unknown>;
+    }): Promise<APIResponse<Artifact>> {
+        // MOCK - Returns simulated data
+        const mockArtifact: Artifact = {
+            id: `artifact_${Date.now()}`,
+            name: body.name,
+            type: body.type,
+            mime_type: body.mime_type,
+            size_bytes: body.size_bytes,
+            sha256: body.sha256,
+            run_id: body.run_id,
+            thread_id: body.thread_id,
+            metadata: body.metadata || {},
+            signed: false,
+            created_at: new Date().toISOString(),
+            created_by: "user_current",
+        };
+        return { data: mockArtifact, error: undefined, response: new Response() };
+    }
+
+    // MOCK - Simulated delete
+    /**
+     * Delete an artifact.
+     */
+    async delete(artifactId: string): Promise<APIResponse<void>> {
+        // MOCK - Returns success
+        return { data: undefined, error: undefined, response: new Response() };
+    }
+
+    // MOCK - Simulated sign
+    /**
+     * Sign an artifact for integrity verification.
+     */
+    async sign(artifactId: string): Promise<APIResponse<Artifact>> {
+        // MOCK - Returns simulated signed artifact
+        const mockArtifact: Artifact = {
+            id: artifactId,
+            name: "report.pdf",
+            type: "document",
+            mime_type: "application/pdf",
+            size_bytes: 245000,
+            sha256: "abc123def456...",
+            metadata: {},
+            signed: true,
+            signature: `sig_${Date.now()}`,
+            created_at: new Date(Date.now() - 3600000).toISOString(),
+            created_by: "agent_support",
+        };
+        return { data: mockArtifact, error: undefined, response: new Response() };
+    }
+
+    // MOCK - Simulated lineage
+    /**
+     * Get artifact lineage (provenance tracking).
+     */
+    async lineage(artifactId: string): Promise<APIResponse<ArtifactLineage>> {
+        // MOCK - Returns simulated lineage
+        const mockLineage: ArtifactLineage = {
+            artifact_id: artifactId,
+            source: {
+                type: "run",
+                id: "run_123",
+                name: "Support Agent Run",
+                timestamp: new Date(Date.now() - 3600000).toISOString(),
+            },
+            transformations: [
+                {
+                    step: 1,
+                    operation: "generate",
+                    run_id: "run_123",
+                    tool_name: "document_generator",
+                    timestamp: new Date(Date.now() - 3500000).toISOString(),
+                },
+                {
+                    step: 2,
+                    operation: "format",
+                    run_id: "run_123",
+                    tool_name: "pdf_formatter",
+                    timestamp: new Date(Date.now() - 3400000).toISOString(),
+                },
+            ],
+            dependencies: ["artifact_raw_data", "artifact_template"],
+        };
+        return { data: mockLineage, error: undefined, response: new Response() };
+    }
+
+    // MOCK - Simulated getForRun
+    /**
+     * Get all artifacts produced by a run.
+     */
+    async getForRun(runId: string): Promise<APIResponse<ArtifactListResponse>> {
+        // MOCK - Returns simulated data
+        const mockArtifacts: ArtifactListResponse = {
+            items: [
+                {
+                    id: "artifact_run_1",
+                    name: "output.json",
+                    type: "data",
+                    mime_type: "application/json",
+                    size_bytes: 5000,
+                    sha256: "run_output_hash",
+                    run_id: runId,
+                    metadata: {},
+                    signed: false,
+                    created_at: new Date().toISOString(),
+                    created_by: "agent",
+                },
+            ],
+            total: 1,
+        };
+        return { data: mockArtifacts, error: undefined, response: new Response() };
+    }
+
+    // MOCK - Simulated attachToThread
+    /**
+     * Attach an artifact to a thread.
+     */
+    async attachToThread(threadId: string, artifactId: string): Promise<APIResponse<Artifact>> {
+        // MOCK - Returns simulated data
+        const mockArtifact: Artifact = {
+            id: artifactId,
+            name: "attached_file.pdf",
+            type: "document",
+            mime_type: "application/pdf",
+            size_bytes: 100000,
+            sha256: "attached_hash",
+            thread_id: threadId,
+            metadata: {},
+            signed: false,
+            created_at: new Date().toISOString(),
+            created_by: "user",
+        };
+        return { data: mockArtifact, error: undefined, response: new Response() };
+    }
+}