@yorz/cli 0.11.3 → 0.13.0

package/dist/agent-sdk/index.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Public contract for YorZ Agent SDK adapters — the `@yorz/cli/agent-sdk`
+ * entry point.
+ *
+ * External agents are loaded by dynamic `import()` (declared globally in
+ * `~/.config/yorz/config.json`'s `customAgents`, independent of any project).
+ * Their module must default- or named-export a `createAgentAdapter` factory of
+ * type {@link CreateAgentAdapter}
+ * that returns an {@link AgentSdkAdapter}. The discovery helpers
+ * `getUsageStatus` and `listModels` are optional; core conversation methods
+ * remain mandatory.
+ *
+ * ```ts
+ * import type { CreateAgentAdapter } from '@yorz/cli/agent-sdk'
+ *
+ * export const createAgentAdapter: CreateAgentAdapter = (ctx) => ({
+ *   descriptor: {
+ *     id: ctx.descriptor.id,
+ *     displayName: 'My Agent',
+ *     source: 'external',
+ *     capabilities: { listSessions: false, getMessages: false, usageStatus: false },
+ *   },
+ *   capabilities() { return this.descriptor.capabilities },
+ *   async createSession() { ... },
+ *   async resumeSession(id) { ... },
+ *   async listSessions() { return [] },
+ *   async getMessages(id) { return [] },
+ *   async dispose() {},
+ * })
+ * export default createAgentAdapter
+ * ```
+ */
+export type { AgentId, BuiltinAgentId, AgentKind, AgentDescriptor, AgentRuntimeConfig, AgentOption, AgentModelOption, AgentModelCatalog, AgentAdapterContext, CreateAgentAdapter, AgentSdkAdapter, AgentSession, AgentEvent, MessagePart, NormalizedMessage, SessionInfo, Capabilities, SendOptions, AgentContextKind, AgentUsageStatus, AgentUsageStatusKind, AgentUsageWindow, } from '../service/agent-sdk/types.js';
+export { BUILTIN_AGENT_IDS, isBuiltinAgentId } from '../service/agent-sdk/types.js';
+export type { TurnMetrics, CompactMetrics, UsageSnapshot, PhaseUsageSnapshot, ModelUsageMap, } from '../service/telemetry/types.js';

package/dist/agent-sdk/index.js

@@ -0,0 +1,33 @@
+/**
+ * Public contract for YorZ Agent SDK adapters — the `@yorz/cli/agent-sdk`
+ * entry point.
+ *
+ * External agents are loaded by dynamic `import()` (declared globally in
+ * `~/.config/yorz/config.json`'s `customAgents`, independent of any project).
+ * Their module must default- or named-export a `createAgentAdapter` factory of
+ * type {@link CreateAgentAdapter}
+ * that returns an {@link AgentSdkAdapter}. The discovery helpers
+ * `getUsageStatus` and `listModels` are optional; core conversation methods
+ * remain mandatory.
+ *
+ * ```ts
+ * import type { CreateAgentAdapter } from '@yorz/cli/agent-sdk'
+ *
+ * export const createAgentAdapter: CreateAgentAdapter = (ctx) => ({
+ *   descriptor: {
+ *     id: ctx.descriptor.id,
+ *     displayName: 'My Agent',
+ *     source: 'external',
+ *     capabilities: { listSessions: false, getMessages: false, usageStatus: false },
+ *   },
+ *   capabilities() { return this.descriptor.capabilities },
+ *   async createSession() { ... },
+ *   async resumeSession(id) { ... },
+ *   async listSessions() { return [] },
+ *   async getMessages(id) { return [] },
+ *   async dispose() {},
+ * })
+ * export default createAgentAdapter
+ * ```
+ */
+export { BUILTIN_AGENT_IDS, isBuiltinAgentId } from '../service/agent-sdk/types.js';