@plico-ai/contracts 0.0.0-reserved.0 → 0.1.0

package/NOTICE

@@ -0,0 +1,4 @@
+Plico
+Copyright 2026 Plico contributors
+
+This product includes software developed by the Plico contributors.

package/README.md

@@ -1,6 +1,9 @@
 # @plico-ai/contracts
 
-Shared wire types for Plico.
+Types-only contracts shared by every Plico package and surface: project/validation results, native events, run results, artifacts, eval results, readiness reports and composed instructions.
 
-This is a pre-release placeholder. The first developer preview is in progress at
-https://github.com/ITZSHOAIB/plico. Docs: https://plico.sohab.dev
+Rules:
+
+- No runtime code and no dependencies. Everything is `export type`.
+- Packages import these types instead of redefining them (Studio, the server, the CLI and the future React kit all consume the same shapes).
+- Changing a shape here is a public contract change; add versions explicitly.

package/dist/artifacts.d.ts

@@ -0,0 +1,59 @@
+export type ArtifactContent = string | {
+    encoding: "base64";
+    data: string;
+};
+export interface ArtifactFileMetadata {
+    path: string;
+    sizeBytes: number;
+    mimeType: string;
+    version: number;
+    contentHash: string;
+}
+export interface ArtifactFile {
+    path: string;
+    content: ArtifactContent;
+    mimeType: string;
+    /** Starts at 1 and increments each time the path is rewritten. */
+    version: number;
+    contentHash: string;
+}
+export interface ArtifactVersion {
+    path: string;
+    mimeType: string;
+    version: number;
+    contentHash: string;
+    runId: string;
+    createdAt: string;
+}
+export interface ArtifactDiff {
+    path: string;
+    fromVersion: number;
+    toVersion: number;
+    diff: string;
+}
+export interface ArtifactSnapshot {
+    snapshotId: string;
+    runId: string;
+    fileCount: number;
+    createdAt: string;
+}
+export interface ArtifactSnapshotDetail extends ArtifactSnapshot {
+    files: ArtifactFile[];
+}
+export interface ArtifactWorkspace {
+    workspaceId: string;
+    runId: string;
+    threadId?: string;
+    files: ArtifactFile[];
+    versions: ArtifactVersion[];
+    snapshots: ArtifactSnapshot[];
+    createdAt: string;
+}
+export interface ThreadArtifactWorkspace {
+    workspaceId: string;
+    threadId: string;
+    files: ArtifactFile[];
+    versions: ArtifactVersion[];
+    snapshots: ArtifactSnapshot[];
+    createdAt: string;
+}

package/dist/artifacts.js

@@ -0,0 +1 @@
+export {};

package/dist/evals.d.ts

@@ -0,0 +1,22 @@
+import type { RunStatus } from "./runs.js";
+export interface EvalCaseResult {
+    name: string;
+    description?: string;
+    status: "pass" | "fail";
+    runId: string;
+    runStatus: RunStatus;
+    output?: string;
+    diagnostics?: string[];
+}
+export interface EvalSummary {
+    total: number;
+    passed: number;
+    failed: number;
+    results: EvalCaseResult[];
+}
+export interface EvalReport extends EvalSummary {
+    schemaVersion: 1;
+    evaluatedAt: string;
+    /** Identifies the fixtures this report ran, so readers can detect stale results. */
+    fixturesDigest: string;
+}

package/dist/evals.js

@@ -0,0 +1 @@
+export {};

package/dist/events.d.ts

@@ -0,0 +1,167 @@
+import type { ArtifactContent } from "./artifacts.js";
+import type { ValidationIssue } from "./project.js";
+export type JsonValue = null | boolean | number | string | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+export interface ModelToolCall {
+    id?: string;
+    name: string;
+    arguments: unknown;
+    providerMetadata?: JsonValue;
+}
+export interface PlicoEventPayloads {
+    "run.started": {
+        projectRoot: string;
+        projectName: string;
+        threadId?: string;
+        metadata?: Record<string, JsonValue>;
+        context?: Record<string, JsonValue>;
+    };
+    "instructions.composed": {
+        length: number;
+        sources: string[];
+        content: string;
+        /** The skills the run started with, so a resumed run keeps them. Absent on older runs. */
+        skills?: Array<{
+            name: string;
+            description: string;
+            source: string;
+            body: string;
+        }>;
+    };
+    "tools.discovered": {
+        tools: Array<{
+            source: string;
+            name: string;
+            description: string;
+            inputSchema: unknown;
+            capabilities: string[];
+            approval: {
+                required: boolean;
+                reason?: string;
+            };
+        }>;
+        /** Hash of the TypeScript files in `tools/`, so a resumed run can tell the tool code changed. */
+        fingerprint?: string;
+    };
+    "input.received": {
+        content: string;
+    };
+    "model.request": {
+        model?: {
+            provider: string;
+            name: string;
+        };
+        messages: Array<{
+            role: string;
+            content: string;
+            toolName?: string;
+            toolCallId?: string;
+            toolCalls?: ModelToolCall[];
+            providerMetadata?: JsonValue;
+        }>;
+        maxSteps: number;
+        tools: Array<{
+            name: string;
+            description: string;
+            inputSchema: unknown;
+        }>;
+    };
+    "model.attempt": {
+        turn: number;
+        attemptId: string;
+    };
+    "model.delta": {
+        turn: number;
+        attemptId: string;
+        text: string;
+    };
+    "model.response": {
+        attemptId?: string;
+        providerMetadata?: JsonValue;
+        content: string;
+        usage: {
+            inputTokens: number;
+            outputTokens: number;
+        };
+        toolCalls?: ModelToolCall[] | undefined;
+    };
+    "assistant.output": {
+        content: string;
+    };
+    "tool.call": {
+        toolName: string;
+        arguments: unknown;
+    };
+    "tool.result": {
+        toolName: string;
+        result: unknown;
+    };
+    "approval.requested": {
+        requestId: string;
+        toolName: string;
+        arguments: unknown;
+        approval: {
+            required: boolean;
+            reason?: string;
+        };
+    };
+    "approval.decided": {
+        requestId: string;
+        approved: boolean;
+        /** The context of whoever decided, as the host passed it. */
+        context?: Record<string, JsonValue>;
+    };
+    "artifact.workspace.created": {
+        workspaceId: string;
+    };
+    "artifact.file.written": {
+        path: string;
+        content: ArtifactContent;
+        mimeType: string;
+        contentHash?: string;
+        version?: number;
+    };
+    "artifact.snapshot.created": {
+        snapshotId: string;
+        fileCount: number;
+    };
+    "run.completed": {
+        output?: string;
+    };
+    "run.waiting": {
+        requestId: string;
+        toolName: string;
+        output?: string;
+    };
+    "run.failed": {
+        phase: string;
+    };
+    "run.cancelled": Record<string, never>;
+    "run.error": {
+        phase: string;
+        message?: string;
+        issues?: ValidationIssue[];
+        toolName?: string;
+    };
+}
+export type PlicoEventType = keyof PlicoEventPayloads;
+export type EventStreamType = "run" | "thread";
+interface EventEnvelope {
+    schemaVersion: 1;
+    streamType: "run";
+    /** Canonical location in the log. */
+    streamId: string;
+    /** Always equals `streamId` on run streams. */
+    runId: string;
+    id: string;
+    sequence: number;
+    timestamp: string;
+}
+export type PlicoEvent<T extends PlicoEventType = PlicoEventType> = {
+    [K in T]: EventEnvelope & {
+        type: K;
+        payload: PlicoEventPayloads[K];
+    };
+}[T];
+export {};

package/dist/events.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export type { ArtifactContent, ArtifactDiff, ArtifactFile, ArtifactFileMetadata, ArtifactSnapshot, ArtifactSnapshotDetail, ArtifactVersion, ArtifactWorkspace, ThreadArtifactWorkspace, } from "./artifacts.js";
+export type { EvalCaseResult, EvalReport, EvalSummary } from "./evals.js";
+export type { EventStreamType, JsonValue, ModelToolCall, PlicoEvent, PlicoEventPayloads, PlicoEventType, } from "./events.js";
+export type { ComposedInstructions } from "./instructions.js";
+export type { LoadedProject, ProjectConfig, ProviderInput, ValidationIssue, ValidationResult, ValidationSeverity, } from "./project.js";
+export type { DiagnosticSeverity, ReadinessDiagnostic, ReadinessReport, } from "./readiness.js";
+export type { RunResult, RunStatus, RunSummary } from "./runs.js";
+export type { Thread, ThreadEvent, ThreadMessage } from "./threads.js";
+export type { JsonSchema, JsonSchemaObject, ToolApprovalPolicy, ToolArtifactContext, ToolArtifactFile, ToolDefinition, ToolHandlerContext, ToolInputSchema, ZodInputParseResult, ZodInputSchema, } from "./tools.js";

package/dist/index.js

@@ -0,0 +1 @@
+export {};

package/dist/instructions.d.ts

@@ -0,0 +1,4 @@
+export interface ComposedInstructions {
+    sources: string[];
+    content: string;
+}

package/dist/instructions.js

@@ -0,0 +1 @@
+export {};

package/dist/project.d.ts

@@ -0,0 +1,57 @@
+export type ValidationSeverity = "error" | "warning";
+export interface ValidationIssue {
+    path: string;
+    message: string;
+    severity: ValidationSeverity;
+}
+export interface ProjectConfig {
+    schemaVersion: number;
+    name: string;
+    description?: string;
+    template?: string;
+    artifacts?: {
+        access: "read-write" | "read-only" | "off";
+    };
+    model?: {
+        provider: string;
+        name: string;
+        /** Endpoint for `openai-compatible` (and `openai`). */
+        baseURL?: string;
+        /** Environment variable holding the API key. Defaults to the provider's usual variable. */
+        apiKeyEnv?: string;
+        maxSteps?: number;
+        retries?: number;
+        retryDelayMs?: number;
+    };
+    execution?: {
+        leaseMs?: number;
+    };
+    /** Thread naming. `keywords` is the default; `model` asks the configured model to write titles. */
+    threads?: {
+        title?: "keywords" | "model";
+    };
+    approvals?: {
+        default?: "none" | "required";
+        timeoutMs?: number;
+        tools?: Record<string, "none" | "required">;
+    };
+}
+/** What the default export of `providers/<name>.ts` receives. It returns an AI SDK language model. */
+export interface ProviderInput {
+    model: string;
+    /** The value of the variable named by `model.apiKeyEnv`, when the config names one. */
+    apiKey?: string;
+    baseURL?: string;
+}
+export interface LoadedProject {
+    root: string;
+    configPath: string;
+    config: ProjectConfig;
+}
+export interface ValidationResult {
+    ok: boolean;
+    issues: ValidationIssue[];
+    errors: ValidationIssue[];
+    warnings: ValidationIssue[];
+    project?: LoadedProject;
+}

package/dist/project.js

@@ -0,0 +1 @@
+export {};

package/dist/readiness.d.ts

@@ -0,0 +1,17 @@
+export type DiagnosticSeverity = "ok" | "warning" | "error";
+export interface ReadinessDiagnostic {
+    severity: DiagnosticSeverity;
+    subsystem: string;
+    path?: string;
+    message: string;
+}
+export interface ReadinessReport {
+    projectRoot: string;
+    timestamp: string;
+    diagnostics: ReadinessDiagnostic[];
+    summary: {
+        ok: number;
+        warning: number;
+        error: number;
+    };
+}

package/dist/readiness.js

@@ -0,0 +1 @@
+export {};

package/dist/runs.d.ts

@@ -0,0 +1,21 @@
+import type { JsonValue, PlicoEvent } from "./events.js";
+import type { ValidationIssue } from "./project.js";
+export type RunStatus = "running" | "completed" | "failed" | "waiting" | "cancelled";
+export interface RunSummary {
+    runId: string;
+    projectRoot: string;
+    projectName: string;
+    status: RunStatus;
+    startedAt: string;
+    endedAt: string | null;
+    output?: string;
+    /** Host data set when the run started and never changed. */
+    metadata?: Record<string, JsonValue>;
+}
+export interface RunResult {
+    runId: string;
+    status: RunStatus;
+    output?: string;
+    events: PlicoEvent[];
+    errors?: ValidationIssue[];
+}

package/dist/runs.js

@@ -0,0 +1 @@
+export {};

package/dist/threads.d.ts

@@ -0,0 +1,43 @@
+import type { JsonValue } from "./events.js";
+export interface Thread {
+    id: string;
+    createdAt: string;
+    /** Absent until the conversation has a topic or the user names it. */
+    title?: string;
+    /** Host data set at creation and never changed. */
+    metadata?: Record<string, JsonValue>;
+}
+export interface ThreadMessage {
+    id: string;
+    threadId: string;
+    role: "user" | "assistant";
+    runId?: string;
+    content: string;
+    createdAt: string;
+}
+interface ThreadEventEnvelope {
+    schemaVersion: 1;
+    streamType: "thread";
+    streamId: string;
+    sequence: number;
+    id: string;
+    timestamp: string;
+}
+export type ThreadEvent = (ThreadEventEnvelope & {
+    type: "thread.created";
+    payload: {
+        thread: Thread;
+    };
+}) | (ThreadEventEnvelope & {
+    type: "message.created";
+    payload: {
+        message: ThreadMessage;
+    };
+}) | (ThreadEventEnvelope & {
+    type: "thread.titled";
+    payload: {
+        title: string;
+        source: "generated" | "user";
+    };
+});
+export {};

package/dist/threads.js

@@ -0,0 +1 @@
+export {};

package/dist/tools.d.ts

@@ -0,0 +1,66 @@
+import type { ArtifactFileMetadata } from "./artifacts.js";
+import type { JsonValue } from "./events.js";
+export interface ToolArtifactFile {
+    path: string;
+    content: string | Uint8Array;
+    mimeType: string;
+    version: number;
+    contentHash: string;
+}
+export interface ToolArtifactContext {
+    read(path: string): Promise<ToolArtifactFile | undefined>;
+    write(path: string, content: string | Uint8Array, options?: {
+        mimeType?: string;
+    }): Promise<{
+        path: string;
+        version: number;
+    }>;
+    list(): Promise<ArtifactFileMetadata[]>;
+}
+export interface JsonSchemaObject {
+    [keyword: string]: JsonValue | undefined;
+}
+export type JsonSchema = JsonSchemaObject | boolean;
+export interface ZodInputSchema {
+    safeParseAsync(input: unknown): Promise<ZodInputParseResult>;
+}
+export type ZodInputParseResult = {
+    success: true;
+    data: unknown;
+} | {
+    success: false;
+    error: {
+        issues: Array<{
+            path: Array<string | number | symbol>;
+            message: string;
+        }>;
+    };
+};
+export type ToolInputSchema = JsonSchema | ZodInputSchema;
+export interface ToolApprovalPolicy {
+    required: boolean;
+    reason?: string;
+}
+export interface ToolHandlerContext {
+    /** Aborts when the run is cancelled. Pass it to fetch or a child process to stop early. */
+    signal: AbortSignal;
+    /**
+     * Names this tool call and stays the same if the call runs again after a crash. Pass it to
+     * an API that accepts an idempotency key so a repeat does not act twice.
+     */
+    idempotencyKey: string;
+    artifacts: ToolArtifactContext;
+    /**
+     * Data the host passed when it started the run, such as the calling user. It is recorded in the
+     * run's event log, so it must not carry secrets.
+     */
+    context?: Record<string, JsonValue>;
+}
+export interface ToolDefinition {
+    name: string;
+    description: string;
+    inputSchema: ToolInputSchema;
+    capabilities: string[];
+    approval: ToolApprovalPolicy;
+    handler: (input: unknown, context: ToolHandlerContext) => unknown | Promise<unknown>;
+}

package/dist/tools.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,21 +1,40 @@
 {
   "name": "@plico-ai/contracts",
-  "version": "0.0.0-reserved.0",
-  "description": "Shared wire types for Plico. Not released yet.",
+  "version": "0.1.0",
+  "description": "Types-only shared contracts (events, runs, artifacts, evals, readiness) for Plico packages",
   "license": "Apache-2.0",
   "homepage": "https://plico.sohab.dev",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/ITZSHOAIB/plico.git"
+    "url": "git+https://github.com/ITZSHOAIB/plico.git",
+    "directory": "packages/contracts"
   },
   "keywords": [
     "plico",
-    "agent"
-  ],
-  "files": [
-    "README.md"
+    "agent",
+    "types"
   ],
   "publishConfig": {
     "access": "public"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "NOTICE",
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22.18.0"
+  },
+  "scripts": {
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "build": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.build.json"
   }
-}
+}