@sensu-ai/sdk 0.1.6 → 0.5.2

package/dist/types.d.ts

@@ -0,0 +1,224 @@
+export interface SensuClientOptions {
+    apiKey?: string;
+    baseUrl?: string;
+    agentId?: string;
+    orgId?: string;
+    /** Read config from environment variables */
+    fromEnv?: boolean;
+    /** Flush buffer when this many events accumulate */
+    batchSize?: number;
+    /** Flush buffer every N milliseconds */
+    flushIntervalMs?: number;
+    /** Disable all telemetry (useful for tests) */
+    disabled?: boolean;
+    /**
+     * Called when the SDK detects a tool being called repeatedly within a single run.
+     * @param toolName - the tool that is looping
+     * @param callCount - how many times it has been called in this run
+     */
+    onLoopDetected?: (toolName: string, callCount: number) => void;
+    /**
+     * Number of repeated calls to the same tool within one run before onLoopDetected fires.
+     * Default: 5
+     */
+    loopThreshold?: number;
+    /**
+     * When true, the SDK will not attempt to fetch live pricing from the API.
+     * Cost estimates will use the bundled MODEL_PRICING table only.
+     * Default: false
+     */
+    disableLivePricing?: boolean;
+}
+export interface StartRunOptions {
+    sessionId?: string;
+    runType?: string;
+    endUserId?: string;
+    runId?: string;
+}
+export interface StartStepOptions {
+    name?: string;
+    stepType?: string;
+    sequence?: number;
+    stepId?: string;
+}
+export interface ContextBreakdown {
+    system_tokens?: number;
+    user_tokens?: number;
+    assistant_tokens?: number;
+    tool_tokens?: number;
+    retrieval_tokens?: number;
+}
+export interface MessageSnapshotItem {
+    role: 'system' | 'user' | 'assistant' | 'tool';
+    tool_name?: string;
+    token_count: number;
+    content_hash: string;
+}
+export interface TrackLlmOptions {
+    provider: string;
+    model: string;
+    /** Wraps the LLM call and measures latency automatically */
+    fn: () => Promise<unknown>;
+    maxContextTokens?: number;
+    /**
+     * Optional callback to extract a context breakdown from the LLM response.
+     * Called with the raw response after fn() resolves.
+     */
+    extractContextBreakdown?: (result: unknown) => ContextBreakdown | undefined;
+    /** Stable ID for this LLM call — used to link eval scores. Generated if omitted. */
+    llmCallId?: string;
+    /** Snapshot of every message in the context window sent to this LLM call. */
+    messagesSnapshot?: MessageSnapshotItem[];
+    /** IDs of retrieval chunks whose content the model actually referenced in its output. */
+    referencedChunkIds?: string[];
+}
+export interface LlmResult {
+    inputTokens?: number;
+    outputTokens?: number;
+    cachedInputTokens?: number;
+    totalTokens?: number;
+    costUsdEstimate?: number;
+    result: unknown;
+}
+export interface TrackStreamingLlmOptions {
+    provider: string;
+    model: string;
+    /** Async generator that yields token chunks (e.g. an Anthropic or OpenAI stream) */
+    stream: AsyncIterable<unknown>;
+    maxContextTokens?: number;
+    llmCallId?: string;
+    /** How often to emit stream.token.received (every N tokens). Default: 10 */
+    emitEveryNTokens?: number;
+    /** Called with the full accumulated text once streaming completes */
+    onComplete?: (text: string, ttftMs: number | undefined) => void;
+}
+export interface TrackToolOptions {
+    toolName: string;
+    fn: () => Promise<unknown>;
+    /** ID of the original failed tool call this is retrying, for chain visualization */
+    retryOf?: string;
+}
+export interface RawLlmCallOptions {
+    provider: string;
+    model: string;
+    inputTokens?: number;
+    outputTokens?: number;
+    cachedInputTokens?: number;
+    totalTokens?: number;
+    maxContextTokens?: number;
+    contextUsedTokens?: number;
+    latencyMs?: number;
+    ttftMs?: number;
+    costUsdEstimate?: number;
+    status?: 'success' | 'error' | 'timeout';
+    contextBreakdown?: ContextBreakdown;
+}
+export interface TrackRetrievalOptions {
+    /** Wraps the retrieval call and measures latency automatically */
+    fn: () => Promise<unknown>;
+    vectorStoreId?: string;
+    topK?: number;
+}
+export interface RetrievalChunkInput {
+    chunk_id: string;
+    source?: string;
+    token_count: number;
+    similarity_score?: number;
+    content_preview?: string;
+}
+export interface RawRetrievalOptions {
+    vectorStoreId?: string;
+    topK?: number;
+    latencyMs?: number;
+    chunksReturned?: number;
+    tokensInjected?: number;
+    similarityScoreAvg?: number;
+    status?: 'success' | 'error';
+    /** Per-chunk detail for retrieval noise analysis. */
+    chunks?: RetrievalChunkInput[];
+}
+export interface TrackEmbeddingOptions {
+    model: string;
+    /** Wraps the embedding call and measures latency automatically */
+    fn: () => Promise<unknown>;
+    inputTextLength?: number;
+    batchSize?: number;
+}
+export interface RawEmbeddingOptions {
+    model: string;
+    inputTextLength?: number;
+    tokenCount?: number;
+    latencyMs?: number;
+    costUsdEstimate?: number;
+    batchSize?: number;
+}
+export interface RecordFeedbackOptions {
+    type: 'thumbs_up' | 'thumbs_down' | 'score' | 'correction';
+    score?: number;
+    comment?: string;
+    endUserId?: string;
+}
+export interface RecordEvalScoreOptions {
+    metric: string;
+    score: number;
+    evaluatorId?: string;
+    modelUsedForEval?: string;
+    /** Step ID this eval score is linked to — enables quality correlation view. */
+    stepId?: string;
+    /** LLM call ID this eval score is linked to — must match the llmCallId used in trackLlm(). */
+    llmCallId?: string;
+}
+export interface SpawnRunOptions {
+    childAgentId: string;
+    childRunId?: string;
+    spawnReason?: string;
+    /** Options forwarded to the child RunHandle */
+    runType?: string;
+    sessionId?: string;
+}
+export interface HandoffOptions {
+    toAgentId: string;
+    reason?: string;
+    contextTokensTransferred?: number;
+}
+export interface TrackGuardrailOptions {
+    guardrailId: string;
+    guardrailType?: 'content' | 'pii' | 'jailbreak' | 'custom';
+    inputHash?: string;
+    /** Wraps the guardrail check and measures latency automatically */
+    fn: () => Promise<'pass' | 'fail' | 'modified'>;
+}
+export interface RawGuardrailOptions {
+    guardrailId: string;
+    guardrailType?: 'content' | 'pii' | 'jailbreak' | 'custom';
+    inputHash?: string;
+    result?: 'pass' | 'fail' | 'modified';
+    blockReason?: string;
+    severity?: 'low' | 'medium' | 'high';
+    latencyMs?: number;
+    blocked?: boolean;
+}
+export interface RecordPromptRenderOptions {
+    templateId: string;
+    templateVersion?: string;
+    renderedTokenCount?: number;
+    variableCount?: number;
+    latencyMs?: number;
+}
+export interface DeployPromptVersionOptions {
+    templateId: string;
+    newVersion: string;
+    oldVersion?: string;
+    deployedBy?: string;
+}
+export interface StartSessionOptions {
+    sessionId?: string;
+    channel?: 'web' | 'api' | 'mobile';
+    endUserId?: string;
+}
+export interface ResumeSessionOptions {
+    sessionId?: string;
+    resumedFromSessionId: string;
+    channel?: 'web' | 'api' | 'mobile';
+    endUserId?: string;
+}

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6CAA6C;IAC7C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oDAAoD;IACpD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wCAAwC;IACxC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,GAAG,MAAM,CAAC;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,4DAA4D;IAC5D,EAAE,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,uBAAuB,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,gBAAgB,GAAG,SAAS,CAAC;IAC5E,oFAAoF;IACpF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,6EAA6E;IAC7E,gBAAgB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACzC,yFAAyF;IACzF,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,SAAS;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,oFAAoF;IACpF,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;IAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4EAA4E;IAC5E,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,qEAAqE;IACrE,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS,KAAK,IAAI,CAAC;CACjE;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,MAAM,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;IACzC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC;AAMD,MAAM,WAAW,qBAAqB;IACpC,kEAAkE;IAClE,EAAE,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,MAAM,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC;IAC7B,qDAAqD;IACrD,MAAM,CAAC,EAAE,mBAAmB,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,kEAAkE;IAClE,EAAE,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAMD,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,WAAW,GAAG,aAAa,GAAG,OAAO,GAAG,YAAY,CAAC;IAC3D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,+EAA+E;IAC/E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8FAA8F;IAC9F,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAMD,MAAM,WAAW,eAAe;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+CAA+C;IAC/C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAMD,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,SAAS,GAAG,KAAK,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC3D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mEAAmE;IACnE,EAAE,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,SAAS,GAAG,KAAK,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC3D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC;IACtC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAMD,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAMD,MAAM,WAAW,mBAAmB;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,QAAQ,CAAC;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,OAAO,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,QAAQ,CAAC;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,20 +1,29 @@
 {
   "name": "@sensu-ai/sdk",
-  "version": "0.1.6",
+  "version": "0.5.2",
   "type": "module",
-  "main": "./src/index.ts",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
-    ".": "./src/index.ts",
-    "./integrations/langchain": "./src/integrations/langchain.ts",
-    "./integrations/openai": "./src/integrations/openai.ts"
-  },
-  "scripts": {
-    "build": "tsc",
-    "dev": "tsc --watch"
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./integrations/langchain": {
+      "import": "./dist/integrations/langchain.js",
+      "types": "./dist/integrations/langchain.d.ts"
+    },
+    "./integrations/openai": {
+      "import": "./dist/integrations/openai.js",
+      "types": "./dist/integrations/openai.d.ts"
+    }
   },
+  "files": [
+    "dist"
+  ],
   "dependencies": {
-    "@sensu-ai/shared": "workspace:*",
-    "zod": "^3.23.8"
+    "zod": "^3.23.8",
+    "@sensu-ai/shared": "0.5.2"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",
@@ -31,5 +40,9 @@
     "openai": {
       "optional": true
     }
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch"
   }
-}
+}