@axonflow/sdk 1.2.0 → 1.3.0

package/dist/esm/client.d.ts

@@ -1,4 +1,4 @@
-import { AxonFlowConfig, ConnectorMetadata, ConnectorInstallRequest, ConnectorResponse, PlanResponse, PlanExecutionResponse, PreCheckRequest, PolicyApprovalResult, TokenUsage, AuditResult } from './types';
+import { AxonFlowConfig, ConnectorMetadata, ConnectorInstallRequest, ConnectorResponse, PlanResponse, PlanExecutionResponse, PolicyApprovalResult, PolicyApprovalOptions, AuditResult, AuditOptions, ExecuteQueryOptions, ExecuteQueryResponse, HealthStatus } from './types';
 /**
  * Main AxonFlow client for invisible AI governance
  */
@@ -32,6 +32,47 @@ export declare class AxonFlow {
      * Create a sandbox client for testing
      */
     static sandbox(apiKey?: string): AxonFlow;
+    /**
+     * Check if AxonFlow Agent is healthy and available.
+     *
+     * @returns HealthStatus object with agent health information
+     *
+     * @example
+     * ```typescript
+     * const health = await axonflow.healthCheck();
+     * if (health.status === 'healthy') {
+     *   console.log('Agent is healthy');
+     * }
+     * ```
+     */
+    healthCheck(): Promise<HealthStatus>;
+    /**
+     * Execute a query through AxonFlow with policy enforcement (Proxy Mode).
+     *
+     * This is the primary method for Proxy Mode, where AxonFlow handles policy
+     * checking and optionally routes requests to LLM providers.
+     *
+     * @param options - Query execution options
+     * @returns ExecuteQueryResponse with results or error information
+     * @throws PolicyViolationError if request is blocked by policy
+     * @throws AuthenticationError if credentials are invalid
+     * @throws APIError for other API errors
+     *
+     * @example
+     * ```typescript
+     * const response = await axonflow.executeQuery({
+     *   userToken: 'user-123',
+     *   query: 'Explain quantum computing',
+     *   requestType: 'chat',
+     *   context: { provider: 'openai', model: 'gpt-4' }
+     * });
+     *
+     * if (response.success) {
+     *   console.log('Response:', response.data);
+     * }
+     * ```
+     */
+    executeQuery(options: ExecuteQueryOptions): Promise<ExecuteQueryResponse>;
     /**
      * List all available MCP connectors from the marketplace
      */
@@ -46,66 +87,90 @@ export declare class AxonFlow {
     queryConnector(connectorName: string, query: string, params?: any): Promise<ConnectorResponse>;
     /**
      * Generate a multi-agent execution plan from a natural language query
+     * @param query - Natural language query describing the task
+     * @param domain - Optional domain hint (travel, healthcare, etc.)
+     * @param userToken - Optional user token for authentication (defaults to tenant/client_id)
      */
-    generatePlan(query: string, domain?: string): Promise<PlanResponse>;
+    generatePlan(query: string, domain?: string, userToken?: string): Promise<PlanResponse>;
     /**
      * Execute a previously generated multi-agent plan
+     * @param planId - ID of the plan to execute
+     * @param userToken - Optional user token for authentication (defaults to tenant/client_id)
      */
-    executePlan(planId: string): Promise<PlanExecutionResponse>;
+    executePlan(planId: string, userToken?: string): Promise<PlanExecutionResponse>;
     /**
      * Get the status of a running or completed plan
      */
     getPlanStatus(planId: string): Promise<PlanExecutionResponse>;
     /**
-     * Perform policy pre-check before making LLM call
-     *
-     * This is the first step in Gateway Mode. Call this before making your
-     * LLM call to ensure policy compliance.
+     * Gateway Mode: Pre-check policy approval before making a direct LLM call.
+     * Alias for getPolicyApprovedContext() for simpler API.
+     */
+    preCheck(options: PolicyApprovalOptions): Promise<PolicyApprovalResult>;
+    /**
+     * Gateway Mode: Get policy-approved context before making a direct LLM call.
      *
-     * @param request Pre-check request containing user token, query, and optional data sources
-     * @returns PolicyApprovalResult with context ID and approved data (if any)
+     * Use this when you want to:
+     * - Make direct LLM calls (not through AxonFlow proxy)
+     * - Have full control over your LLM provider/model selection
+     * - Minimize latency by calling LLM directly
      *
      * @example
-     * const result = await axonflow.getPolicyApprovedContext({
-     *   userToken: 'user-jwt-token',
-     *   dataSources: ['postgres', 'salesforce'],
-     *   query: 'Find all patients with recent lab results'
+     * ```typescript
+     * const ctx = await axonflow.getPolicyApprovedContext({
+     *   userToken: 'user-jwt',
+     *   query: 'Analyze this customer data',
+     *   dataSources: ['postgres']
      * });
      *
-     * if (!result.approved) {
-     *   throw new Error(`Request blocked: ${result.blockReason}`);
+     * if (!ctx.approved) {
+     *   throw new Error(`Blocked: ${ctx.blockReason}`);
      * }
      *
-     * // Use result.approvedData to build your LLM prompt
-     * const prompt = buildPrompt(result.approvedData);
+     * // Make direct LLM call with approved data
+     * const response = await openai.chat.completions.create({
+     *   model: 'gpt-4',
+     *   messages: [{ role: 'user', content: JSON.stringify(ctx.approvedData) }]
+     * });
+     *
+     * // Audit the call
+     * await axonflow.auditLLMCall({
+     *   contextId: ctx.contextId,
+     *   responseSummary: response.choices[0].message.content.substring(0, 100),
+     *   provider: 'openai',
+     *   model: 'gpt-4',
+     *   tokenUsage: {
+     *     promptTokens: response.usage.prompt_tokens,
+     *     completionTokens: response.usage.completion_tokens,
+     *     totalTokens: response.usage.total_tokens
+     *   },
+     *   latencyMs: 250
+     * });
+     * ```
      */
-    getPolicyApprovedContext(request: PreCheckRequest): Promise<PolicyApprovalResult>;
+    getPolicyApprovedContext(options: PolicyApprovalOptions): Promise<PolicyApprovalResult>;
     /**
-     * Report LLM call details for audit logging
+     * Gateway Mode: Audit an LLM call after completion.
      *
-     * This is the second step in Gateway Mode. Call this after making your
-     * LLM call to record it in the audit trail.
-     *
-     * @param contextId Context ID from getPolicyApprovedContext()
-     * @param responseSummary Brief summary of the LLM response (not full response)
-     * @param provider LLM provider name
-     * @param model Model name
-     * @param tokenUsage Token counts from LLM response
-     * @param latencyMs Time taken for LLM call in milliseconds
-     * @param metadata Optional additional metadata
-     * @returns AuditResult confirming the audit was recorded
+     * Call this after making a direct LLM call to log the audit trail.
+     * This is required for compliance and monitoring.
      *
      * @example
-     * const result = await axonflow.auditLLMCall(
-     *   ctx.contextId,
-     *   'Found 5 patients with recent lab results',
-     *   'openai',
-     *   'gpt-4',
-     *   { promptTokens: 100, completionTokens: 50, totalTokens: 150 },
-     *   250,
-     *   { sessionId: 'session-123' }
-     * );
-     */
-    auditLLMCall(contextId: string, responseSummary: string, provider: string, model: string, tokenUsage: TokenUsage, latencyMs: number, metadata?: Record<string, any>): Promise<AuditResult>;
+     * ```typescript
+     * await axonflow.auditLLMCall({
+     *   contextId: ctx.contextId,
+     *   responseSummary: 'Generated report with 5 items',
+     *   provider: 'openai',
+     *   model: 'gpt-4',
+     *   tokenUsage: {
+     *     promptTokens: 100,
+     *     completionTokens: 50,
+     *     totalTokens: 150
+     *   },
+     *   latencyMs: 250
+     * });
+     * ```
+     */
+    auditLLMCall(options: AuditOptions): Promise<AuditResult>;
 }
 //# sourceMappingURL=client.d.ts.map

package/dist/esm/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EAId,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,YAAY,EACZ,qBAAqB,EACrB,eAAe,EACf,oBAAoB,EACpB,UAAU,EACV,WAAW,EACZ,MAAM,SAAS,CAAC;AAMjB;;GAEG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,MAAM,CAA2B;IACzC,OAAO,CAAC,YAAY,CAAyB;gBAEjC,MAAM,EAAE,cAAc;IAwBlC;;;;OAIG;IACG,OAAO,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAqD5D;;OAEG;YACW,cAAc;IAiB5B;;OAEG;YACW,aAAa;IAuD3B;;OAEG;YACW,QAAQ;IAYtB;;OAEG;IACH,OAAO,CAAC,eAAe;IAMvB;;OAEG;IACH,MAAM,CAAC,OAAO,CAAC,MAAM,GAAE,MAAmB,GAAG,QAAQ;IASrD;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAqBpD;;OAEG;IACG,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBvE;;OAEG;IACG,cAAc,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA0CpG;;OAEG;IACG,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IA6CzE;;OAEG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAyCjE;;OAEG;IACG,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAuDnE;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,wBAAwB,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,oBAAoB,CAAC;IA8DvF;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,YAAY,CAChB,SAAS,EAAE,MAAM,EACjB,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,MAAM,EACjB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC7B,OAAO,CAAC,WAAW,CAAC;CA4DxB"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EAId,iBAAiB,EACjB,uBAAuB,EACvB,iBAAiB,EACjB,YAAY,EACZ,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,WAAW,EACX,YAAY,EACZ,mBAAmB,EACnB,oBAAoB,EACpB,YAAY,EACb,MAAM,SAAS,CAAC;AAOjB;;GAEG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,MAAM,CAUZ;IACF,OAAO,CAAC,YAAY,CAAyB;gBAEjC,MAAM,EAAE,cAAc;IAqDlC;;;;OAIG;IACG,OAAO,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAuD5D;;OAEG;YACW,cAAc;IAiB5B;;OAEG;YACW,aAAa;IAyE3B;;OAEG;YACW,QAAQ;IAYtB;;OAEG;IACH,OAAO,CAAC,eAAe;IAQvB;;OAEG;IACH,MAAM,CAAC,OAAO,CAAC,MAAM,GAAE,MAAmB,GAAG,QAAQ;IAarD;;;;;;;;;;;;OAYG;IACG,WAAW,IAAI,OAAO,CAAC,YAAY,CAAC;IA0C1C;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAwG/E;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAqBpD;;OAEG;IACG,gBAAgB,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAiCvE;;OAEG;IACG,cAAc,CAClB,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,MAAM,EACb,MAAM,CAAC,EAAE,GAAG,GACX,OAAO,CAAC,iBAAiB,CAAC;IAkD7B;;;;;OAKG;IACG,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAqD7F;;;;OAIG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAiDrF;;OAEG;IACG,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA+BnE;;;OAGG;IACG,QAAQ,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAI7E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACG,wBAAwB,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAkF7F;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,YAAY,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;CAqEhE"}