@kraken-ai/platform 0.0.1 → 0.0.2

package/dist/types-CkknNKNr.d.cts

@@ -0,0 +1,451 @@
+import * as z from 'zod';
+import { ModelString } from 'kraken-ai';
+
+/** MCP tool annotations per the MCP spec (v1.27.1) */
+interface ToolAnnotations {
+    readonly readOnlyHint?: boolean;
+    readonly destructiveHint?: boolean;
+    readonly idempotentHint?: boolean;
+    readonly openWorldHint?: boolean;
+}
+/** Explicit MCP content pass-through (returned by mcpResult() helper) */
+interface McpContent {
+    readonly __mcpPassThrough: true;
+    readonly content: ReadonlyArray<{
+        readonly type: string;
+        [key: string]: unknown;
+    }>;
+    readonly isError?: boolean;
+}
+/**
+ * Union of valid handler return types.
+ * Prevents returning unsupported types at compile time.
+ */
+type ConnectorHandlerResult = string | number | boolean | Record<string, unknown> | ReadonlyArray<unknown> | McpContent | null | undefined;
+/** Minimal context passed to resource/prompt handlers — business logic only */
+interface ConnectorHandlerContext {
+    readonly signal: AbortSignal;
+}
+/** MCP-native resource content (text or binary) */
+type ResourceContent = {
+    readonly uri: string;
+    readonly mimeType?: string;
+    readonly text: string;
+} | {
+    readonly uri: string;
+    readonly mimeType?: string;
+    readonly blob: string;
+};
+/** MCP-native ReadResourceResult — returned by resource read handlers */
+interface ReadResourceResult {
+    readonly contents: ReadonlyArray<ResourceContent>;
+}
+/** MCP-native prompt message content */
+type PromptMessageContent = {
+    readonly type: "text";
+    readonly text: string;
+} | {
+    readonly type: "image";
+    readonly data: string;
+    readonly mimeType: string;
+};
+/** MCP-native GetPromptResult — returned by prompt get handlers */
+interface GetPromptResult {
+    readonly description?: string;
+    readonly messages: ReadonlyArray<{
+        readonly role: "user" | "assistant";
+        readonly content: PromptMessageContent;
+    }>;
+}
+/** A tool definition within a connector */
+interface ConnectorToolDef<TInput extends z.ZodType = z.ZodType> {
+    readonly description: string;
+    readonly input: TInput;
+    readonly annotations?: ToolAnnotations;
+    handler(args: z.infer<TInput>): Promise<ConnectorHandlerResult> | ConnectorHandlerResult;
+}
+/** A resource definition within a connector */
+interface ConnectorResourceDef {
+    readonly description: string;
+    readonly uri: string;
+    readonly mimeType?: string;
+    read(ctx: ConnectorHandlerContext): Promise<ReadResourceResult> | ReadResourceResult;
+}
+/** A prompt definition within a connector */
+interface ConnectorPromptDef {
+    readonly description: string;
+    readonly arguments?: ReadonlyArray<{
+        readonly name: string;
+        readonly description?: string;
+        readonly required?: boolean;
+    }>;
+    get(args: Record<string, string>, ctx: ConnectorHandlerContext): Promise<GetPromptResult> | GetPromptResult;
+}
+/** Input to defineConnector() */
+interface ConnectorDefinition {
+    readonly name: string;
+    readonly description?: string;
+    readonly instructions?: string;
+    readonly tools?: Record<string, ConnectorToolDef>;
+    readonly resources?: Record<string, ConnectorResourceDef>;
+    readonly prompts?: Record<string, ConnectorPromptDef>;
+}
+/** Output of defineConnector() — frozen, carries handlers for server builder */
+interface PlatformConnector {
+    readonly __type: "PlatformConnector";
+    readonly name: string;
+    readonly description?: string;
+    readonly instructions?: string;
+    readonly tools?: Readonly<Record<string, ConnectorToolDef>>;
+    readonly resources?: Readonly<Record<string, ConnectorResourceDef>>;
+    readonly prompts?: Readonly<Record<string, ConnectorPromptDef>>;
+}
+
+/** Action names follow entity naming convention: lowercase alphanumeric with hyphens, 1-64 chars. */
+declare const ACTION_NAME_REGEX: RegExp;
+/** Validates an action name (allows single-char names like "a"). */
+declare const isValidActionName: (name: string) => boolean;
+/** Input for a single action variant in defineActions(). */
+interface ActionVariantInput<S extends z.ZodObject<z.ZodRawShape> = z.ZodObject<z.ZodRawShape>> {
+    schema: S;
+    webhook?: string;
+    handler?(payload: z.infer<S>): Promise<void>;
+}
+/** Serializable config for a single action variant (stored in manifest/DB). */
+interface ActionVariantConfig {
+    schema: Record<string, unknown>;
+    webhook?: string;
+    hasHandler: boolean;
+}
+/** Serializable portion of action definitions (stored in agent config). */
+interface PlatformActionsConfig {
+    variants: Record<string, ActionVariantConfig>;
+}
+/** Full action definitions including in-memory schemas and handlers for runtime use. */
+interface PlatformActions {
+    readonly __type: "PlatformActions";
+    readonly config: PlatformActionsConfig;
+    readonly zodSchemas: Record<string, z.ZodObject<z.ZodRawShape>>;
+    readonly handlers: Readonly<Record<string, (payload: unknown) => Promise<void>>>;
+}
+declare const actionVariantConfigSchema: z.ZodObject<{
+    schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    webhook: z.ZodOptional<z.ZodString>;
+    hasHandler: z.ZodBoolean;
+}, z.core.$strip>;
+declare const actionsConfigSchema: z.ZodObject<{
+    variants: z.ZodRecord<z.ZodString, z.ZodObject<{
+        schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        webhook: z.ZodOptional<z.ZodString>;
+        hasHandler: z.ZodBoolean;
+    }, z.core.$strip>>;
+}, z.core.$strict>;
+
+/**
+ * Type registry populated by `kraken generate` via module augmentation.
+ *
+ * Before generating, all ID types resolve to an error-message string —
+ * only local typed refs (PlatformAgent, PlatformSkill, PlatformConnector) compile.
+ *
+ * After `kraken generate`, the generated `.kraken-ai/platform-types.d.ts` augments
+ * this interface with `agentId`, `connectorId`, and `skillId` string unions,
+ * enabling autocomplete on remote IDs.
+ *
+ * @example
+ * ```ts
+ * // .kraken-ai/platform-types.d.ts (generated)
+ * declare module "@kraken-ai/platform" {
+ *   interface KrakenTypeRegistry {
+ *     agentId: "analyst" | "writer";
+ *     connectorId: "slack" | "jira";
+ *     skillId: "competitor-deep-dive";
+ *   }
+ * }
+ * ```
+ */
+interface KrakenTypeRegistry {
+}
+/** Remote agent IDs. Resolves to an error hint before `kraken generate`. */
+type AgentId = KrakenTypeRegistry extends {
+    agentId: infer T extends string;
+} ? T : "ERROR: Run 'kraken generate' to unlock agent IDs";
+/** Remote connector IDs. Resolves to an error hint before `kraken generate`. */
+type ConnectorId = KrakenTypeRegistry extends {
+    connectorId: infer T extends string;
+} ? T : "ERROR: Run 'kraken generate' to unlock connector IDs";
+/** Remote skill IDs. Resolves to an error hint before `kraken generate`. */
+type SkillId = KrakenTypeRegistry extends {
+    skillId: infer T extends string;
+} ? T : "ERROR: Run 'kraken generate' to unlock skill IDs";
+
+declare const agentDefinitionSchema: z.ZodObject<{
+    name: z.ZodString;
+    model: z.ZodString;
+    instructions: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    skills: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    temperature: z.ZodOptional<z.ZodNumber>;
+    allowTemperatureOverride: z.ZodOptional<z.ZodBoolean>;
+    maxOutputTokens: z.ZodOptional<z.ZodNumber>;
+    thinkingLevel: z.ZodOptional<z.ZodEnum<{
+        low: "low";
+        medium: "medium";
+        high: "high";
+    }>>;
+    logLevel: z.ZodOptional<z.ZodEnum<{
+        error: "error";
+        silent: "silent";
+        debug: "debug";
+        info: "info";
+        warn: "warn";
+    }>>;
+}, z.core.$strict>;
+type AgentDefinition = Omit<z.infer<typeof agentDefinitionSchema>, "model"> & {
+    model: ModelString;
+};
+declare const platformAgentConfigSchema: z.ZodObject<{
+    agent: z.ZodObject<{
+        name: z.ZodString;
+        model: z.ZodString;
+        instructions: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        skills: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        temperature: z.ZodOptional<z.ZodNumber>;
+        allowTemperatureOverride: z.ZodOptional<z.ZodBoolean>;
+        maxOutputTokens: z.ZodOptional<z.ZodNumber>;
+        thinkingLevel: z.ZodOptional<z.ZodEnum<{
+            low: "low";
+            medium: "medium";
+            high: "high";
+        }>>;
+        logLevel: z.ZodOptional<z.ZodEnum<{
+            error: "error";
+            silent: "silent";
+            debug: "debug";
+            info: "info";
+            warn: "warn";
+        }>>;
+    }, z.core.$strict>;
+    connectors: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    trigger: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"cron">;
+        expression: z.ZodString;
+        timezone: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"webhook">;
+        path: z.ZodString;
+        method: z.ZodOptional<z.ZodEnum<{
+            GET: "GET";
+            POST: "POST";
+        }>>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"event">;
+        source: z.ZodString;
+        event: z.ZodString;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"api">;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"manual">;
+    }, z.core.$strip>], "type">;
+    identity: z.ZodOptional<z.ZodObject<{
+        basePermissions: z.ZodArray<z.ZodString>;
+        requestablePermissions: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        jitPolicy: z.ZodOptional<z.ZodEnum<{
+            "auto-approve": "auto-approve";
+            "policy-based": "policy-based";
+            "require-approval": "require-approval";
+        }>>;
+        maxJitDurationMinutes: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    resources: z.ZodOptional<z.ZodObject<{
+        maxTokens: z.ZodOptional<z.ZodNumber>;
+        maxCostUsd: z.ZodOptional<z.ZodNumber>;
+        timeoutSeconds: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    retries: z.ZodOptional<z.ZodObject<{
+        maxAttempts: z.ZodOptional<z.ZodNumber>;
+        backoffSeconds: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    concurrency: z.ZodOptional<z.ZodObject<{
+        maxParallelRuns: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    team: z.ZodOptional<z.ZodObject<{
+        members: z.ZodArray<z.ZodString>;
+        maxConcurrentWorkers: z.ZodOptional<z.ZodNumber>;
+        maxTokenBudgetPerWorker: z.ZodOptional<z.ZodNumber>;
+        maxDurationPerWorker: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    notifications: z.ZodOptional<z.ZodObject<{
+        slack: z.ZodOptional<z.ZodString>;
+        onSuccess: z.ZodOptional<z.ZodBoolean>;
+        onFailure: z.ZodOptional<z.ZodBoolean>;
+        onTimeout: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    environment: z.ZodOptional<z.ZodEnum<{
+        dev: "dev";
+        staging: "staging";
+        prod: "prod";
+    }>>;
+    actions: z.ZodOptional<z.ZodObject<{
+        variants: z.ZodRecord<z.ZodString, z.ZodObject<{
+            schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+            webhook: z.ZodOptional<z.ZodString>;
+            hasHandler: z.ZodBoolean;
+        }, z.core.$strip>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+type PlatformAgentConfig = Omit<z.infer<typeof platformAgentConfigSchema>, "agent" | "actions"> & {
+    agent: AgentDefinition;
+    actions?: PlatformActionsConfig;
+};
+interface PlatformAgent {
+    readonly __type: "PlatformAgent";
+    readonly config: PlatformAgentConfig;
+    readonly runtime?: unknown;
+    /** In-memory schemas for action variants. Not serialized — runtime use only. */
+    readonly actionZodSchemas?: Record<string, z.ZodObject<z.ZodRawShape>>;
+    /** Action handler functions. Not serialized — runtime use only. */
+    readonly actionHandlers?: Readonly<Record<string, (payload: unknown) => Promise<void>>>;
+    /** Team member PlatformAgent objects. Not serialized — runtime use only (dev mode delegation). */
+    readonly teamAgents?: readonly PlatformAgent[];
+}
+/** Team member reference: local PlatformAgent or remote AgentId string. */
+type TeamMember = PlatformAgent | AgentId;
+
+interface PlatformClientConfig {
+    baseUrl: string;
+    apiKey: string;
+}
+interface PaginationParams {
+    cursor?: string;
+    limit?: number;
+}
+interface PaginatedResponse<T> {
+    data: T[];
+    cursor: string | null;
+    hasMore: boolean;
+}
+type AgentEvent = {
+    type: "text";
+    content: string;
+} | {
+    type: "tool_call";
+    name: string;
+    args: Record<string, unknown>;
+} | {
+    type: "tool_result";
+    name: string;
+    result: unknown;
+} | {
+    type: "thinking";
+    content: string;
+} | {
+    type: "action";
+    name: string;
+    payload: Record<string, unknown>;
+    actionExecutionId: string;
+} | {
+    type: "done";
+    output: string;
+    usage?: {
+        tokens: number;
+    };
+} | {
+    type: "error";
+    message: string;
+    code: string;
+};
+interface AgentInfo {
+    id: string;
+    name: string;
+    description?: string;
+}
+interface ThreadInfo {
+    id: string;
+    agentId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+interface ThreadMessage {
+    id: string;
+    threadId: string;
+    role: "user" | "assistant";
+    content: string;
+    toolCalls?: Array<{
+        name: string;
+        args: Record<string, unknown>;
+        result: unknown;
+    }>;
+    createdAt: string;
+    usage?: {
+        tokens: number;
+    };
+}
+interface QueryInfo {
+    name: string;
+    description?: string;
+    params: Record<string, unknown>;
+    columns: QueryColumn[];
+}
+interface QueryColumn {
+    name: string;
+    type: string;
+    description?: string;
+}
+interface QueryResult<TRow = Record<string, unknown>> {
+    rows: TRow[];
+    cursor: string | null;
+    hasMore: boolean;
+}
+type RunState = "QUEUED" | "PROVISIONING" | "RUNNING" | "DRAINING" | "COMPLETED" | "FAILED" | "AWAITING_APPROVAL" | "RETRYING";
+interface RunRecord {
+    runId: string;
+    agentId: string;
+    input: string;
+    state: RunState;
+    exitCode?: number;
+    createdAt: string;
+    updatedAt: string;
+    retryCount: number;
+    error?: string;
+}
+interface StartRunParams {
+    agentId: string;
+    tag?: string;
+    environment?: "dev" | "staging" | "prod";
+    input: string;
+    connectors?: string[];
+    envVars?: Record<string, string>;
+}
+interface RunEvent {
+    eventId: string;
+    eventType: string;
+    payload: Record<string, unknown>;
+}
+interface AgentSchema {
+    id: string;
+    name: string;
+    input: Record<string, unknown>;
+    output: Record<string, unknown>;
+    actions?: Record<string, Record<string, unknown>>;
+}
+interface QuerySchema {
+    name: string;
+    params: Record<string, unknown>;
+    columns: QueryColumn[];
+}
+interface ConnectorSchema {
+    id: string;
+    tools: Array<{
+        name: string;
+        description: string;
+        parameters: Record<string, unknown>;
+    }>;
+}
+interface SkillSchema {
+    id: string;
+    name: string;
+    description?: string;
+}
+
+export { type ActionVariantInput as A, type PromptMessageContent as B, type ConnectorId as C, type QueryColumn as D, type QuerySchema as E, type ReadResourceResult as F, type GetPromptResult as G, type ResourceContent as H, type RunState as I, type SkillSchema as J, type KrakenTypeRegistry as K, type ToolAnnotations as L, type McpContent as M, actionVariantConfigSchema as N, actionsConfigSchema as O, type PlatformConnector as P, type QueryInfo as Q, type RunRecord as R, type SkillId as S, type TeamMember as T, agentDefinitionSchema as U, isValidActionName as V, platformAgentConfigSchema as W, type PlatformAgentConfig as a, type PlatformActions as b, type PlatformAgent as c, type ConnectorDefinition as d, type ConnectorToolDef as e, type PlatformClientConfig as f, type AgentEvent as g, type PaginationParams as h, type PaginatedResponse as i, type ThreadMessage as j, type AgentInfo as k, type ThreadInfo as l, type QueryResult as m, type StartRunParams as n, type RunEvent as o, ACTION_NAME_REGEX as p, type ActionVariantConfig as q, type AgentDefinition as r, type AgentId as s, type AgentSchema as t, type ConnectorHandlerContext as u, type ConnectorHandlerResult as v, type ConnectorPromptDef as w, type ConnectorResourceDef as x, type ConnectorSchema as y, type PlatformActionsConfig as z };