@clinebot/core 0.0.0

package/src/default-tools/schemas.ts

@@ -0,0 +1,228 @@
+/**
+ * Zod Schemas for Default Tool Inputs
+ *
+ * These schemas define the input structure for each default tool
+ * and are used for both validation and JSON Schema generation.
+ */
+
+import { z } from "zod";
+
+/**
+ * Schema for read tool input
+ */
+const AbsolutePath = z
+	.string()
+	.describe("The absolute file path of a text file to read content from");
+
+/**
+ * Schema for read_files tool input
+ */
+export const ReadFilesInputSchema = z.object({
+	file_paths: z.array(AbsolutePath).describe("Array of absolute file paths"),
+});
+export const ReadFilesInputUnionSchema = z.union([
+	ReadFilesInputSchema,
+	z.array(z.string()),
+	z.string(),
+]);
+
+/**
+ * Schema for search_codebase tool input
+ */
+export const SearchCodebaseInputSchema = z.object({
+	queries: z
+		.array(z.string())
+		.describe("Array of regex search queries to execute"),
+});
+
+const CommandInputSchema = z.string();
+/**
+ * Schema for run_commands tool input
+ */
+export const RunCommandsInputSchema = z.object({
+	commands: z
+		.array(CommandInputSchema)
+		.describe("Array of shell commands to execute"),
+});
+export const RunCommandsInputUnionSchema = z.union([
+	RunCommandsInputSchema,
+	z.array(CommandInputSchema),
+	CommandInputSchema,
+]);
+
+/**
+ * Schema for a single web fetch request
+ */
+export const WebFetchRequestSchema = z.object({
+	url: z.url().describe("The URL to fetch"),
+	prompt: z.string().min(2).describe("Analysis prompt for the fetched content"),
+});
+
+/**
+ * Schema for fetch_web_content tool input
+ */
+export const FetchWebContentInputSchema = z.object({
+	requests: z
+		.array(WebFetchRequestSchema)
+		.describe("Array of web fetch requests"),
+});
+
+/**
+ * Schema for editor tool input
+ */
+export const EditFileInputSchema = z
+	.object({
+		command: z
+			.enum(["create", "str_replace", "insert"])
+			.describe(
+				"Editor command to execute: create, str_replace, insert, or undo_edit",
+			),
+		path: z.string().min(1).describe("Absolute file path"),
+		file_text: z
+			.string()
+			.optional()
+			.describe("Full file content used with create"),
+		old_str: z
+			.string()
+			.optional()
+			.describe("Exact text to replace (must match exactly once)"),
+		new_str: z.string().optional().describe("Replacement or inserted text"),
+		insert_line: z
+			.number()
+			.int()
+			.optional()
+			.describe("Zero-based line index for insert"),
+	})
+	.superRefine((value, ctx) => {
+		switch (value.command) {
+			case "create":
+				if (value.file_text === undefined) {
+					ctx.addIssue({
+						code: z.ZodIssueCode.custom,
+						path: ["file_text"],
+						message: "file_text is required for command=create",
+					});
+				}
+				break;
+			case "str_replace":
+				if (value.old_str === undefined) {
+					ctx.addIssue({
+						code: z.ZodIssueCode.custom,
+						path: ["old_str"],
+						message: "old_str is required for command=str_replace",
+					});
+				}
+				break;
+			case "insert":
+				if (value.insert_line === undefined) {
+					ctx.addIssue({
+						code: z.ZodIssueCode.custom,
+						path: ["insert_line"],
+						message: "insert_line is required for command=insert",
+					});
+				}
+				if (value.new_str === undefined) {
+					ctx.addIssue({
+						code: z.ZodIssueCode.custom,
+						path: ["new_str"],
+						message: "new_str is required for command=insert",
+					});
+				}
+				break;
+		}
+	});
+
+/**
+ * Schema for apply_patch tool input
+ */
+export const ApplyPatchInputSchema = z.object({
+	input: z
+		.string()
+		.min(1)
+		.describe("The apply_patch text payload, including patch instructions"),
+});
+export const ApplyPatchInputUnionSchema = z.union([
+	ApplyPatchInputSchema,
+	z.string(),
+]);
+
+/**
+ * Schema for skills tool input
+ */
+export const SkillsInputSchema = z.object({
+	skill: z
+		.string()
+		.min(1)
+		.describe(
+			'The skill name. E.g., "commit", "review-pr", "pdf", or "ms-office-suite:pdf"',
+		),
+	args: z.string().optional().describe("Optional arguments for the skill"),
+});
+
+/**
+ * Schema for ask_followup_question tool input
+ */
+export const AskQuestionInputSchema = z.object({
+	question: z
+		.string()
+		.min(1)
+		.describe(
+			'The single question to ask the user. E.g. "How can I help you?"',
+		),
+	options: z
+		.array(z.string().min(1))
+		.min(2)
+		.max(5)
+		.describe(
+			"Array of 2-5 user-selectable answer options for the single question",
+		),
+});
+
+// =============================================================================
+// Type Definitions (derived from Zod schemas)
+// =============================================================================
+
+/**
+ * Input for the read_files tool
+ */
+export type ReadFilesInput = z.infer<typeof ReadFilesInputSchema>;
+
+/**
+ * Input for the search_codebase tool
+ */
+export type SearchCodebaseInput = z.infer<typeof SearchCodebaseInputSchema>;
+
+/**
+ * Input for the run_commands tool
+ */
+export type RunCommandsInput = z.infer<typeof RunCommandsInputSchema>;
+
+/**
+ * Web fetch request parameters
+ */
+export type WebFetchRequest = z.infer<typeof WebFetchRequestSchema>;
+
+/**
+ * Input for the fetch_web_content tool
+ */
+export type FetchWebContentInput = z.infer<typeof FetchWebContentInputSchema>;
+
+/**
+ * Input for the editor tool
+ */
+export type EditFileInput = z.infer<typeof EditFileInputSchema>;
+
+/**
+ * Input for the apply_patch tool
+ */
+export type ApplyPatchInput = z.infer<typeof ApplyPatchInputSchema>;
+
+/**
+ * Input for the skills tool
+ */
+export type SkillsInput = z.infer<typeof SkillsInputSchema>;
+
+/**
+ * Input for the ask_followup_question tool
+ */
+export type AskQuestionInput = z.infer<typeof AskQuestionInputSchema>;

package/src/default-tools/types.ts

@@ -0,0 +1,324 @@
+/**
+ * Types for Default Tools
+ *
+ * Type definitions for executors, configuration, and results.
+ */
+
+import type { ToolContext } from "@clinebot/agents";
+import type { ApplyPatchInput, EditFileInput } from "./schemas";
+
+// =============================================================================
+// Tool Result Types
+// =============================================================================
+
+/**
+ * Result from a single tool operation
+ */
+export interface ToolOperationResult {
+	/** The query/input that was executed */
+	query: string;
+	/** The result content (if successful) */
+	result: string;
+	/** Error message (if failed) */
+	error?: string;
+	/** Whether the operation succeeded */
+	success: boolean;
+	/** Duration in MS */
+	duration?: number;
+}
+
+// =============================================================================
+// Executor Interfaces
+// =============================================================================
+
+/**
+ * Executor for reading files
+ *
+ * @param filePath - Absolute path to the file to read
+ * @param context - Tool execution context
+ * @returns The file content as a string
+ */
+export type FileReadExecutor = (
+	filePath: string,
+	context: ToolContext,
+) => Promise<string>;
+
+/**
+ * Executor for searching the codebase
+ *
+ * @param query - Regex pattern to search for
+ * @param cwd - Current working directory for the search
+ * @param context - Tool execution context
+ * @returns Search results as a formatted string
+ */
+export type SearchExecutor = (
+	query: string,
+	cwd: string,
+	context: ToolContext,
+) => Promise<string>;
+
+/**
+ * Executor for running shell commands
+ *
+ * @param command - Shell command to execute
+ * @param cwd - Current working directory for execution
+ * @param context - Tool execution context
+ * @returns Command output (stdout)
+ */
+export type BashExecutor = (
+	command: string,
+	cwd: string,
+	context: ToolContext,
+) => Promise<string>;
+
+/**
+ * Executor for fetching web content
+ *
+ * @param url - URL to fetch
+ * @param prompt - Analysis prompt for the content
+ * @param context - Tool execution context
+ * @returns Analyzed/extracted content
+ */
+export type WebFetchExecutor = (
+	url: string,
+	prompt: string,
+	context: ToolContext,
+) => Promise<string>;
+
+/**
+ * Executor for editing files
+ *
+ * @param input - Editor command input
+ * @param cwd - Current working directory for filesystem operations
+ * @param context - Tool execution context
+ * @returns A formatted operation result string
+ */
+export type EditorExecutor = (
+	input: EditFileInput,
+	cwd: string,
+	context: ToolContext,
+) => Promise<string>;
+
+/**
+ * Executor for apply_patch operations
+ *
+ * @param input - apply_patch command payload
+ * @param cwd - Current working directory for filesystem operations
+ * @param context - Tool execution context
+ * @returns A formatted operation result string
+ */
+export type ApplyPatchExecutor = (
+	input: ApplyPatchInput,
+	cwd: string,
+	context: ToolContext,
+) => Promise<string>;
+
+/**
+ * Executor for invoking configured skills
+ *
+ * @param skill - Skill name to invoke
+ * @param args - Optional arguments for the skill
+ * @param context - Tool execution context
+ * @returns Skill loading/invocation result
+ */
+export type SkillsExecutor = (
+	skill: string,
+	args: string | undefined,
+	context: ToolContext,
+) => Promise<string>;
+
+/**
+ * Executor for asking a single follow-up question with selectable options
+ *
+ * @param question - Single clarifying question for the user
+ * @param options - 2-5 selectable answer options
+ * @param context - Tool execution context
+ * @returns Executor-specific result payload
+ */
+export type AskQuestionExecutor = (
+	question: string,
+	options: string[],
+	context: ToolContext,
+) => Promise<string>;
+
+/**
+ * Skill metadata exposed by SkillsExecutor for clients/UI
+ */
+export interface SkillsExecutorSkillMetadata {
+	/** Normalized skill id (usually lowercased name) */
+	id: string;
+	/** Display name for the skill */
+	name: string;
+	/** Optional short description */
+	description?: string;
+	/** True when configured but intentionally disabled */
+	disabled: boolean;
+}
+
+/**
+ * A callable executor that can also expose configured skill metadata.
+ */
+export interface SkillsExecutorWithMetadata {
+	(
+		skill: string,
+		args: string | undefined,
+		context: ToolContext,
+	): Promise<string>;
+	configuredSkills?: SkillsExecutorSkillMetadata[];
+}
+
+/**
+ * Collection of all tool executors
+ */
+export interface ToolExecutors {
+	/** File reading implementation */
+	readFile?: FileReadExecutor;
+	/** Codebase search implementation */
+	search?: SearchExecutor;
+	/** Shell command execution implementation */
+	bash?: BashExecutor;
+	/** Web content fetching implementation */
+	webFetch?: WebFetchExecutor;
+	/** Filesystem editor implementation */
+	editor?: EditorExecutor;
+	/** Apply patch implementation */
+	applyPatch?: ApplyPatchExecutor;
+	/** Skill invocation implementation */
+	skills?: SkillsExecutorWithMetadata;
+	/** Follow-up question implementation */
+	askQuestion?: AskQuestionExecutor;
+}
+
+// =============================================================================
+// Tool Configuration
+// =============================================================================
+
+/**
+ * Names of available default tools
+ */
+export type DefaultToolName =
+	| "read_files"
+	| "search_codebase"
+	| "run_commands"
+	| "fetch_web_content"
+	| "apply_patch"
+	| "editor"
+	| "skills"
+	| "ask_question";
+
+/**
+ * Configuration for enabling/disabling default tools
+ */
+export interface DefaultToolsConfig {
+	/**
+	 * Enable the read_files tool
+	 * @default true
+	 */
+	enableReadFiles?: boolean;
+
+	/**
+	 * Enable the search_codebase tool
+	 * @default true
+	 */
+	enableSearch?: boolean;
+
+	/**
+	 * Enable the run_commands tool
+	 * @default true
+	 */
+	enableBash?: boolean;
+
+	/**
+	 * Enable the fetch_web_content tool
+	 * @default true
+	 */
+	enableWebFetch?: boolean;
+
+	/**
+	 * Enable the apply_patch tool
+	 * @default true
+	 */
+	enableApplyPatch?: boolean;
+
+	/**
+	 * Enable the editor tool
+	 * @default true
+	 */
+	enableEditor?: boolean;
+
+	/**
+	 * Enable the skills tool
+	 * @default true
+	 */
+	enableSkills?: boolean;
+
+	/**
+	 * Enable the ask_followup_question tool
+	 * @default true
+	 */
+	enableAskQuestion?: boolean;
+
+	/**
+	 * Current working directory for tools that need it
+	 */
+	cwd?: string;
+
+	/**
+	 * Timeout for file read operations in milliseconds
+	 * @default 10000
+	 */
+	fileReadTimeoutMs?: number;
+
+	/**
+	 * Timeout for bash command execution in milliseconds
+	 * @default 30000
+	 */
+	bashTimeoutMs?: number;
+
+	/**
+	 * Timeout for web fetch operations in milliseconds
+	 * @default 30000
+	 */
+	webFetchTimeoutMs?: number;
+
+	/**
+	 * Timeout for search operations in milliseconds
+	 * @default 30000
+	 */
+	searchTimeoutMs?: number;
+
+	/**
+	 * Timeout for apply_patch operations in milliseconds
+	 * @default 30000
+	 */
+	applyPatchTimeoutMs?: number;
+
+	/**
+	 * Timeout for editor operations in milliseconds
+	 * @default 30000
+	 */
+	editorTimeoutMs?: number;
+
+	/**
+	 * Timeout for skills operations in milliseconds
+	 * @default 15000
+	 */
+	skillsTimeoutMs?: number;
+
+	/**
+	 * Timeout for ask_followup_question operations in milliseconds
+	 * @default 15000
+	 */
+	askQuestionTimeoutMs?: number;
+}
+
+/**
+ * Options for creating default tools
+ */
+export interface CreateDefaultToolsOptions extends DefaultToolsConfig {
+	/**
+	 * Executor implementations for the tools
+	 * Only tools with provided executors will be available
+	 */
+	executors: ToolExecutors;
+}

package/src/index.ts

@@ -0,0 +1,119 @@
+/**
+ * @clinebot/core
+ *
+ * Runtime-agnostic core contracts and shared state utilities.
+ */
+
+export {
+	type ClineAccountBalance,
+	type ClineAccountOperations,
+	type ClineAccountOrganization,
+	type ClineAccountOrganizationBalance,
+	type ClineAccountOrganizationUsageTransaction,
+	type ClineAccountPaymentTransaction,
+	ClineAccountService,
+	type ClineAccountServiceOptions,
+	type ClineAccountUsageTransaction,
+	type ClineAccountUser,
+	executeRpcClineAccountAction,
+	isRpcClineAccountActionRequest,
+	RpcClineAccountService,
+	type RpcProviderActionExecutor,
+} from "./account";
+export type {
+	ChatMessage,
+	ChatSessionConfig,
+	ChatSessionStatus,
+	ChatSummary,
+	ChatViewState,
+} from "./chat/chat-schema";
+export {
+	ChatMessageRoleSchema,
+	ChatMessageSchema,
+	ChatSessionConfigSchema,
+	ChatSessionStatusSchema,
+	ChatSummarySchema,
+	ChatViewStateSchema,
+} from "./chat/chat-schema";
+export {
+	ALL_DEFAULT_TOOL_NAMES,
+	type AskQuestionExecutor,
+	type CreateBuiltinToolsOptions,
+	type CreateDefaultToolsOptions,
+	createBuiltinTools,
+	createDefaultExecutors,
+	createDefaultTools,
+	createDefaultToolsWithPreset,
+	createToolPoliciesWithPreset,
+	type DefaultExecutorsOptions,
+	type DefaultToolName,
+	DefaultToolNames,
+	type DefaultToolsConfig,
+	type ToolExecutors,
+	type ToolPolicyPresetName,
+	type ToolPresetName,
+	ToolPresets,
+} from "./default-tools";
+export {
+	hasMcpSettingsFile,
+	InMemoryMcpManager,
+	type LoadMcpSettingsOptions,
+	loadMcpSettingsFile,
+	type McpConnectionStatus,
+	type McpManager,
+	type McpManagerOptions,
+	type McpServerClient,
+	type McpServerClientFactory,
+	type McpServerRegistration,
+	type McpServerSnapshot,
+	type McpServerTransportConfig,
+	type McpSettingsFile,
+	type McpSseTransportConfig,
+	type McpStdioTransportConfig,
+	type McpStreamableHttpTransportConfig,
+	type RegisterMcpServersFromSettingsOptions,
+	registerMcpServersFromSettingsFile,
+	resolveDefaultMcpSettingsPath,
+	resolveMcpServerRegistrations,
+} from "./mcp";
+
+export { ProviderSettingsManager } from "./storage/provider-settings-manager";
+export {
+	SqliteTeamStore,
+	type SqliteTeamStoreOptions,
+} from "./storage/team-store";
+export {
+	buildTeamProgressSummary,
+	toTeamProgressLifecycleEvent,
+} from "./team";
+
+// Compatibility barrel (legacy imports).
+export type { RuntimeEnvironment, SessionEvent, StoredMessages } from "./types";
+export type { SessionStatus } from "./types/common";
+export { SESSION_STATUSES, SessionSource } from "./types/common";
+export type {
+	CoreAgentMode,
+	CoreModelConfig,
+	CoreRuntimeFeatures,
+	CoreSessionConfig,
+} from "./types/config";
+export type {
+	CoreSessionEvent,
+	SessionChunkEvent,
+	SessionEndedEvent,
+	SessionTeamProgressEvent,
+	SessionToolEvent,
+} from "./types/events";
+export type {
+	ProviderTokenSource,
+	StoredProviderSettings,
+	StoredProviderSettingsEntry,
+} from "./types/provider-settings";
+export {
+	emptyStoredProviderSettings,
+	StoredProviderSettingsEntrySchema,
+	StoredProviderSettingsSchema,
+} from "./types/provider-settings";
+export type { SessionRecord, SessionRef } from "./types/sessions";
+export type { ArtifactStore, SessionStore, TeamStore } from "./types/storage";
+export type { WorkspaceInfo } from "./types/workspace";

package/src/input/file-indexer.d.ts

@@ -0,0 +1,11 @@
+export interface FastFileIndexOptions {
+	ttlMs?: number;
+}
+export declare function getFileIndex(
+	cwd: string,
+	options?: FastFileIndexOptions,
+): Promise<Set<string>>;
+export declare function prewarmFileIndex(
+	cwd: string,
+	options?: FastFileIndexOptions,
+): Promise<void>;