byterover-cli 1.5.0 → 1.7.0

package/dist/core/interfaces/executor/i-query-executor.d.ts

@@ -1,32 +0,0 @@
-import type { ICipherAgent } from '../cipher/i-cipher-agent.js';
-/**
- * Options for executing query with an injected agent.
- * Agent uses its default session (Single-Session pattern).
- */
-export interface QueryExecuteOptions {
-    /** Query content to search in context tree */
-    query: string;
-    /** Task ID for event routing (required for concurrent task isolation) */
-    taskId: string;
-}
-/**
- * IQueryExecutor - Executes query tasks with an injected CipherAgent.
- *
- * This is NOT a UseCase (which orchestrates business logic).
- * It's an Executor that wraps agent.execute() with query-specific options.
- *
- * Architecture:
- * - TaskProcessor injects the long-lived CipherAgent
- * - Event streaming is handled by agent-worker (subscribes to agentEventBus)
- * - Executor focuses solely on query execution
- */
-export interface IQueryExecutor {
-    /**
-     * Execute query with an injected agent.
-     *
-     * @param agent - Long-lived CipherAgent (managed by caller)
-     * @param options - Execution options (query)
-     * @returns Result string from agent execution
-     */
-    executeWithAgent(agent: ICipherAgent, options: QueryExecuteOptions): Promise<string>;
-}

package/dist/core/interfaces/executor/index.d.ts

@@ -1,2 +0,0 @@
-export * from './i-curate-executor.js';
-export * from './i-query-executor.js';

package/dist/core/interfaces/executor/index.js

@@ -1,2 +0,0 @@
-export * from './i-curate-executor.js';
-export * from './i-query-executor.js';

package/dist/core/interfaces/i-auth-service.d.ts

@@ -1,35 +0,0 @@
-import { OAuthTokenData } from '../domain/entities/oauth-token-data.js';
-/**
- * Authorization context containing the URL and state for OAuth flow.
- * The code_verifier is managed internally by the auth service.
- */
-export type AuthorizationContext = {
-    authUrl: string;
-    state: string;
-};
-/**
- * Interface for authentication services.
- */
-export interface IAuthService {
-    /**
-     * Exchanges an authorization code for OAuth token data.
-     * @param code The authorization code to exchange.
-     * @param context The authorization context from initiateAuthorization (contains state for verifier lookup).
-     * @param redirectUri The redirect URI used in the authorization request (must match for OAuth 2.0 compliance).
-     * @returns The OAuth token data (without user information).
-     */
-    exchangeCodeForToken: (code: string, context: AuthorizationContext, redirectUri: string) => Promise<OAuthTokenData>;
-    /**
-     * Initiates the authorization flow by generating PKCE parameters and building the authorization URL.
-     * The code_verifier is generated and stored internally by the service.
-     * @param redirectUri The redirect URI where authorization codes will be received.
-     * @returns Authorization context containing the URL and state for CSRF protection.
-     */
-    initiateAuthorization: (redirectUri: string) => AuthorizationContext;
-    /**
-     * Refreshes an access token using a refresh token.
-     * @param refreshToken The refresh token to use.
-     * @returns The new OAuth token data (without user information).
-     */
-    refreshToken: (refreshToken: string) => Promise<OAuthTokenData>;
-}

package/dist/core/interfaces/i-cogit-pull-service.d.ts

@@ -1,24 +0,0 @@
-import type { CogitSnapshot } from '../domain/entities/cogit-snapshot.js';
-/**
- * Parameters for pulling a snapshot from CoGit.
- */
-export type PullParams = {
-    accessToken: string;
-    branch: string;
-    sessionKey: string;
-    spaceId: string;
-    teamId: string;
-};
-/**
- * Interface for pulling context tree snapshots from the CoGit service.
- * Retrieves the complete state of context files from a CoGit repository.
- */
-export interface ICogitPullService {
-    /**
-     * Pulls the latest snapshot from the CoGit repository.
-     * @param params Pull parameters including auth and branch
-     * @returns CogitSnapshot containing files and metadata
-     * @throws Error if pull fails
-     */
-    pull: (params: PullParams) => Promise<CogitSnapshot>;
-}

package/dist/core/interfaces/i-cogit-push-service.d.ts

@@ -1,27 +0,0 @@
-import type { CogitPushContext } from '../domain/entities/cogit-push-context.js';
-import type { CogitPushResponse } from '../domain/entities/cogit-push-response.js';
-/**
- * Parameters for pushing context files to CoGit.
- */
-export type PushParams = {
-    accessToken: string;
-    branch: string;
-    contexts: CogitPushContext[];
-    sessionKey: string;
-    spaceId: string;
-    teamId: string;
-};
-/**
- * Interface for pushing context files to the CoGit service.
- * Handles the push operation to store context files in the CoGit repository.
- */
-export interface ICogitPushService {
-    /**
-     * Pushes context files to the CoGit repository.
-     * Implements a two-request SHA flow to handle concurrent updates.
-     * @param params Push parameters including auth, branch, and context files
-     * @returns CogitPushResponse containing commit SHA and status
-     * @throws Error if push fails
-     */
-    push: (params: PushParams) => Promise<CogitPushResponse>;
-}

package/dist/core/interfaces/i-context-file-reader.d.ts

@@ -1,35 +0,0 @@
-import type { Narrative, RawConcept } from '../domain/knowledge/markdown-writer.js';
-/**
- * Represents the content of a context file with extracted metadata.
- */
-export type ContextFileContent = {
-    /** The raw content of the file */
-    content: string;
-    narrative?: Narrative;
-    /** Relative path within the context tree (e.g., "structure/context.md") */
-    path: string;
-    rawConcept?: RawConcept;
-    /** Title extracted from the first heading, or the relative path if no heading found */
-    title: string;
-};
-/**
- * Interface for reading context files and extracting their metadata.
- * Used to prepare context files for the CoGit API.
- */
-export interface IContextFileReader {
-    /**
-     * Reads a single context file and extracts its metadata.
-     * @param relativePath - Relative path within the context tree (e.g., "structure/context.md")
-     * @param directory - Optional base directory (defaults to current working directory)
-     * @returns ContextFileContent if file exists and can be read, undefined otherwise
-     */
-    read(relativePath: string, directory?: string): Promise<ContextFileContent | undefined>;
-    /**
-     * Reads multiple context files and extracts their metadata.
-     * Files that cannot be read are silently skipped.
-     * @param relativePaths - Array of relative paths within the context tree
-     * @param directory - Optional base directory (defaults to current working directory)
-     * @returns Array of ContextFileContent for successfully read files
-     */
-    readMany(relativePaths: string[], directory?: string): Promise<ContextFileContent[]>;
-}

package/dist/core/interfaces/i-context-tree-snapshot-service.d.ts

@@ -1,36 +0,0 @@
-import type { ContextTreeChanges, FileState } from '../domain/entities/context-tree-snapshot.js';
-/**
- * Interface for context tree snapshot operations.
- * Provides change tracking by comparing current file states against saved snapshots.
- */
-export interface IContextTreeSnapshotService {
-    /**
-     * Compares current context tree state against the saved snapshot.
-     * @param directory - Optional base directory (defaults to current working directory)
-     * @returns Changes detected (added, modified, deleted files)
-     */
-    getChanges(directory?: string): Promise<ContextTreeChanges>;
-    /**
-     * Gets the current state of all files in the context tree.
-     * @param directory - Optional base directory (defaults to current working directory)
-     * @returns Map of relative file paths to their current state (hash and size)
-     */
-    getCurrentState(directory?: string): Promise<Map<string, FileState>>;
-    /**
-     * Checks if a snapshot file exists.
-     * @param directory - Optional base directory (defaults to current working directory)
-     * @returns True if snapshot exists
-     */
-    hasSnapshot(directory?: string): Promise<boolean>;
-    /**
-     * Creates an empty snapshot (no files tracked).
-     * Use this to establish a baseline where all current files will appear as "added".
-     * @param directory - Optional base directory (defaults to current working directory)
-     */
-    initEmptySnapshot(directory?: string): Promise<void>;
-    /**
-     * Creates or updates the snapshot from current context tree state.
-     * @param directory - Optional base directory (defaults to current working directory)
-     */
-    saveSnapshot(directory?: string): Promise<void>;
-}

package/dist/core/interfaces/i-context-tree-writer-service.d.ts

@@ -1,32 +0,0 @@
-import type { CogitSnapshotFile } from '../domain/entities/cogit-snapshot-file.js';
-/**
- * Result of a sync operation.
- */
-export type SyncResult = {
-    added: string[];
-    deleted: string[];
-    edited: string[];
-};
-/**
- * Parameters for the sync operation.
- */
-export type SyncParams = {
-    directory?: string;
-    files: readonly CogitSnapshotFile[];
-};
-/**
- * Interface for context tree writer operations.
- * This should be used to process pull response from Cogit.
- * Provides file synchronization capabilities for the context tree.
- */
-export interface IContextTreeWriterService {
-    /**
-     * Synchronizes the context tree with the provided files.
-     * - Files present in params but not locally are added
-     * - Files present in both are edited
-     * - Files present locally but not in params are deleted
-     * @param params - Sync parameters including files and optional directory
-     * @returns Result containing arrays of added, edited, and deleted file paths
-     */
-    sync: (params: SyncParams) => Promise<SyncResult>;
-}

package/dist/core/interfaces/i-global-config-store.d.ts

@@ -1,34 +0,0 @@
-import type { GlobalConfig } from '../domain/entities/global-config.js';
-/**
- * Interface for storing and retrieving global ByteRover CLI configuration.
- * Implementations handle persistence of user-level config (e.g., ~/.config/brv/config.json).
- */
-export interface IGlobalConfigStore {
-    /**
-     * Gets the existing device ID or creates a new one if not present.
-     * This is the primary method for obtaining the device ID for tracking.
-     *
-     * @returns The device ID (existing or newly generated)
-     */
-    getOrCreateDeviceId: () => Promise<string>;
-    /**
-     * Reads the global configuration from the user's config directory.
-     *
-     * @returns The configuration if found and valid, undefined otherwise
-     */
-    read: () => Promise<GlobalConfig | undefined>;
-    /**
-     * Regenerates the device ID by creating a new UUID v4 and persisting it.
-     * Called when leaving authenticated state to break tracking continuity.
-     *
-     * @returns The newly generated device ID
-     */
-    regenerateDeviceId: () => Promise<string>;
-    /**
-     * Writes the global configuration to the user's config directory.
-     * Creates the directory if it doesn't exist.
-     *
-     * @param config The configuration to write
-     */
-    write: (config: GlobalConfig) => Promise<void>;
-}

package/dist/core/interfaces/i-http-client.d.ts

@@ -1,33 +0,0 @@
-/**
- * Configuration options for HTTP requests.
- */
-export type HttpRequestConfig = {
-    headers?: Record<string, string>;
-    timeout?: number;
-};
-/**
- * Interface for HTTP client operations.
- * Provides abstraction over HTTP libraries (axios, fetch, etc.) following Clean Architecture principles.
- *
- * Implementations should handle:
- * - Request configuration (headers, timeout)
- * - Error handling and transformation
- * - Response parsing
- */
-export interface IHttpClient {
-    /**
-     * Performs an HTTP GET request.
-     * @param url The URL to request
-     * @param config Optional request configuration (headers, timeout)
-     * @returns A promise that resolves to the response data
-     */
-    get: <T>(url: string, config?: HttpRequestConfig) => Promise<T>;
-    /**
-     * Performs an HTTP POST request.
-     * @param url The URL to request
-     * @param data The data to send in the request body
-     * @param config Optional request configuration (headers, timeout)
-     * @returns A promise that resolves to the response data
-     */
-    post: <TResponse, TData = unknown>(url: string, data?: TData, config?: HttpRequestConfig) => Promise<TResponse>;
-}

package/dist/core/interfaces/i-legacy-rule-detector.d.ts

@@ -1,56 +0,0 @@
-import type { Agent } from '../domain/entities/agent.js';
-/**
- * Represents a reliably detected legacy ByteRover rule section.
- */
-export type LegacyRuleMatch = {
-    /**
-     * Content of the detected section.
-     */
-    content: string;
-    /**
-     * Ending line number (1-indexed)
-     */
-    endLine: number;
-    /**
-     * Starting line number (1-indexed)
-     */
-    startLine: number;
-};
-/**
- * Represents an uncertain detection where the footer was found but start couldn't be reliably determined.
- */
-export type UncertainMatch = {
-    /**
-     * Line number where the footer tag was found (1-indexed).
-     */
-    footerLine: number;
-    /**
-     * Reason why the start couldn't be determined.
-     */
-    reason: string;
-};
-/**
- * Result of detecting legacy ByteRover rules in a file.
- */
-export type LegacyRuleDetectionResult = {
-    /**
-     * Reliably detected rule sections with known start and end positions.
-     */
-    reliableMatches: LegacyRuleMatch[];
-    /**
-     * Uncertain matches where only the footer was found.
-     */
-    uncertainMatches: UncertainMatch[];
-};
-/**
- * Service for detecting legacy ByteRover rules (without boundary markers) in instruction files.
- */
-export interface ILegacyRuleDetector {
-    /**
-     * Detects legacy ByteRover rule sections in file content.
-     * @param content The file content to analyze.
-     * @param agentName The agent name to look for in the footer tag.
-     * @returns Detection result with reliable and uncertain matches.
-     */
-    detectLegacyRules: (content: string, agentName: Agent) => LegacyRuleDetectionResult;
-}

package/dist/core/interfaces/i-mcp-config-writer.d.ts

@@ -1,40 +0,0 @@
-import type { McpServerConfig } from '../../infra/connectors/mcp/mcp-connector-config.js';
-/**
- * Result of checking if MCP config exists.
- */
-export type McpConfigExistsResult = {
-    /** Whether the config file exists */
-    fileExists: boolean;
-    /** Whether the BRV MCP server entry exists in the config */
-    serverExists: boolean;
-};
-/**
- * Interface for writing MCP server configurations to agent config files.
- * Different implementations handle different file formats (JSON, TOML, etc.).
- */
-export interface IMcpConfigWriter {
-    /**
-     * Check if the config file and BRV server entry exist.
-     *
-     * @param filePath - Absolute path to the config file
-     * @returns Object indicating file and server existence
-     */
-    exists(filePath: string): Promise<McpConfigExistsResult>;
-    /**
-     * Remove the BRV MCP server entry from the config file.
-     * Does not delete the file, only removes the server entry.
-     *
-     * @param filePath - Absolute path to the config file
-     * @returns True if the server was removed, false if it didn't exist
-     */
-    remove(filePath: string): Promise<boolean>;
-    /**
-     * Write the MCP server configuration to the config file.
-     * Creates the file if it doesn't exist.
-     * Preserves existing configuration.
-     *
-     * @param filePath - Absolute path to the config file
-     * @param serverConfig - The MCP server configuration to write
-     */
-    write(filePath: string, serverConfig: McpServerConfig): Promise<void>;
-}

package/dist/core/interfaces/i-memory-retrieval-service.d.ts

@@ -1,40 +0,0 @@
-import type { RetrieveResult } from '../domain/entities/retrieve-result.js';
-export type RetrieveParams = {
-    accessToken: string;
-    nodeKeys?: string[];
-    query: string;
-    sessionKey: string;
-    spaceId: string;
-};
-/**
- * Interface for memory retrieval operations from ByteRover Memora service.
- * This service is responsible for fetching memories based on search queries.
- */
-export interface IMemoryRetrievalService {
-    /**
-     * Retrieves memories from the ByteRover Memora service based on a search query.
-     *
-     * @param params The retrieve operation parameters
-     * @returns A promise that resolves to the RetrieveResult containing memories and related memories
-     *
-     * @example
-     * // Broad search across entire space
-     * const result = await memoryService.retrieve({
-     *   query: "authentication best practices",
-     *   spaceId: "a0000000-b001-0000-0000-000000000000",
-     *   accessToken: token.accessToken,
-     *   sessionKey: token.sessionKey,
-     * });
-     *
-     * @example
-     * // Scoped search to specific files
-     * const result = await memoryService.retrieve({
-     *   query: "error handling",
-     *   spaceId: "a0000000-b001-0000-0000-000000000000",
-     *   accessToken: token.accessToken,
-     *   sessionKey: token.sessionKey,
-     *   nodeKeys: ["src/auth/login.ts", "src/auth/oauth.ts"],
-     * });
-     */
-    retrieve: (params: RetrieveParams) => Promise<RetrieveResult>;
-}

package/dist/core/interfaces/i-memory-storage-service.d.ts

@@ -1,55 +0,0 @@
-import type { PresignedUrlsResponse } from '../domain/entities/presigned-urls-response.js';
-/**
- * Parameters for requesting presigned URLs.
- */
-export type GetPresignedUrlsParams = {
-    accessToken: string;
-    branch: string;
-    fileNames: string[];
-    sessionKey: string;
-    spaceId: string;
-    teamId: string;
-};
-/**
- * Parameters for confirming upload completion.
- */
-export type ConfirmUploadParams = {
-    accessToken: string;
-    requestId: string;
-    sessionKey: string;
-    spaceId: string;
-    teamId: string;
-};
-/**
- * Interface for memory storage operations to ByteRover CoGit service.
- * This service is responsible for uploading playbooks to blob storage.
- */
-export interface IMemoryStorageService {
-    /**
-     * Confirms that file upload is complete.
-     * Notifies the server that all files have been successfully uploaded to blob storage.
-     *
-     * @param params Confirmation parameters including request ID from presigned URLs response
-     * @returns Promise that resolves when confirmation succeeds
-     * @throws Error if confirmation fails
-     */
-    confirmUpload: (params: ConfirmUploadParams) => Promise<void>;
-    /**
-     * Generates presigned URLs for uploading files to memory storage.
-     *
-     * @param params Request parameters including authentication, identifiers, and file list
-     * @returns Response object containing presigned URLs and request ID for confirmation
-     * @throws Error if the request fails
-     */
-    getPresignedUrls: (params: GetPresignedUrlsParams) => Promise<PresignedUrlsResponse>;
-    /**
-     * Uploads file content to a presigned URL.
-     * Uses HTTP PUT with the file content in the request body.
-     *
-     * @param uploadUrl The presigned URL from Google Cloud Storage
-     * @param content File content as string (typically JSON)
-     * @returns Promise that resolves when upload completes
-     * @throws Error if upload fails (network error, expired URL, etc.)
-     */
-    uploadFile: (uploadUrl: string, content: string) => Promise<void>;
-}

package/dist/core/interfaces/i-project-config-store.d.ts

@@ -1,26 +0,0 @@
-import type { BrvConfig } from '../domain/entities/brv-config.js';
-/**
- * Interface for storing and retrieving ByteRover CLI configuration.
- * Implementations handle persistence of .brv/config.json files.
- */
-export interface IProjectConfigStore {
-    /**
-     * Checks if a configuration file exists in the .brv directory.
-     * @param directory The project directory to check (defaults to current working directory).
-     * @returns True if .brv/config.json exists, false otherwise.
-     */
-    exists: (directory?: string) => Promise<boolean>;
-    /**
-     * Reads the configuration from the .brv directory.
-     * @param directory The project directory containing .brv folder (defaults to current working directory)
-     * @returns The configuration if found, undefined otherwise
-     */
-    read: (directory?: string) => Promise<BrvConfig | undefined>;
-    /**
-     * Writes the configuration to the .brv directory.
-     * @param config The configuration to write.
-     * @param directory The project directory to create .brv folder in (defaults to current working directory)
-     * @returns
-     */
-    write: (config: BrvConfig, directory?: string) => Promise<void>;
-}

package/dist/core/interfaces/i-rule-template-service.d.ts

@@ -1,15 +0,0 @@
-import { Agent } from '../domain/entities/agent.js';
-import { ConnectorType } from '../domain/entities/connector-type.js';
-/**
- * Interface for rule template service operations.
- */
-export interface IRuleTemplateService {
-    /**
-     * Generates rule content based on the provided agent and connector type.
-     *
-     * @param agent The agent for which to generate the rule content.
-     * @param type The connector type (rules or mcp). Defaults to 'rules'.
-     * @returns Promise resolving to the generated rule content.
-     */
-    generateRuleContent: (agent: Agent, type: ConnectorType) => Promise<string>;
-}

package/dist/core/interfaces/i-space-service.d.ts

@@ -1,28 +0,0 @@
-import type { Space } from '../domain/entities/space.js';
-/**
- * Interface for space-related operations.
- * Implementations can be HTTP-based (for production) or mock (for testing/development).
- */
-export interface ISpaceService {
-    /**
-     * Fetches spaces accessible to the authenticated user within a specific team.
-     * @param accessToken The OAuth access token for authentication
-     * @param sessionKey The session key for tracking the user session
-     * @param teamId The team ID to filter spaces by
-     * @param option Optional pagination options
-     * @param option.limit Maximum number of spaces to fetch in a single request
-     * @param option.offset Number of spaces to skip (for pagination)
-     * @param option.fetchAll If true, automatically paginate to fetch all spaces
-     * @returns A promise that resolves to an object containing:
-     *  - spaces: Array of Space entities
-     *  - total: Total number of spaces available (across all pages)
-     */
-    getSpaces: (accessToken: string, sessionKey: string, teamId: string, option?: {
-        fetchAll?: boolean;
-        limit?: number;
-        offset?: number;
-    }) => Promise<{
-        spaces: Space[];
-        total: number;
-    }>;
-}

package/dist/core/interfaces/i-team-service.d.ts

@@ -1,29 +0,0 @@
-import type { Team } from '../domain/entities/team.js';
-/**
- * Interface for team-related operations.
- * Implementations can be HTTP-based (for production) or mock (for testing/development).
- */
-export interface ITeamService {
-    /**
-     * Fetches teams where the authenticated user is a member.
-     * @param accessToken The OAuth access token for authentication
-     * @param sessionKey The session key for tracking the user session
-     * @param option Optional filtering and pagination options
-     * @param option.limit Maximum number of teams to fetch in a single request
-     * @param option.offset Number of teams to skip (for pagination)
-     * @param option.isActive Filter teams by active status
-     * @param option.fetchAll If true, automatically paginate to fetch all teams
-     * @returns A promise that resolves to an object containing:
-     *  - teams: Array of Team entities
-     *  - total: Total number of teams available (across all pages)
-     */
-    getTeams: (accessToken: string, sessionKey: string, option?: {
-        fetchAll?: boolean;
-        isActive?: boolean;
-        limit?: number;
-        offset?: number;
-    }) => Promise<{
-        teams: Team[];
-        total: number;
-    }>;
-}

package/dist/core/interfaces/i-token-store.d.ts

@@ -1,22 +0,0 @@
-import { AuthToken } from '../domain/entities/auth-token.js';
-/**
- * Interface for token storage mechanisms.
- */
-export interface ITokenStore {
-    /**
-     * Clears the stored token.
-     * @returns A promise that resolves when the token is cleared.
-     */
-    clear: () => Promise<void>;
-    /**
-     * Loads the stored token.
-     * @returns A promise that resolves with the loaded token or undefined if not found.
-     */
-    load: () => Promise<AuthToken | undefined>;
-    /**
-     * Saves the token to storage.
-     * @param token The token to save.
-     * @returns A promise that resolves when the token is saved.
-     */
-    save: (token: AuthToken) => Promise<void>;
-}

package/dist/core/interfaces/i-tracking-service.d.ts

@@ -1,21 +0,0 @@
-import { EventName, PropertyDict } from '../domain/entities/event.js';
-/**
- * Service interface for tracking user actions and system events.
- *
- * Provides a unified contract for event tracking and analytics throughout the application.
- * Implementations should be non-blocking and handle failures gracefully to avoid impacting
- * user operations.
- */
-export interface ITrackingService {
-    /**
-     * Tracks a named event with optional metadata.
-     *
-     * This method should be asynchronous and non-blocking. Implementations should log
-     * errors internally rather than throwing, to prevent tracking failures from disrupting
-     * user operations.
-     *
-     * @param eventName - The name of the event to track. Must be one of the predefined EventName values.
-     * @param properties - Optional metadata to attach to the event as key-value pairs. All values must be strings.
-     */
-    track(eventName: EventName, properties?: PropertyDict): Promise<void>;
-}

package/dist/core/interfaces/i-user-service.d.ts

@@ -1,14 +0,0 @@
-import type { User } from '../domain/entities/user.js';
-/**
- * Interface for user-related operations.
- * Implementations can be HTTP-based (for production) or mock (for testing/development).
- */
-export interface IUserService {
-    /**
-     * Fetches the current authenticated user's information.
-     * @param accessToken The OAuth access token for authentication
-     * @param sessionKey The session key for tracking the user session
-     * @returns A promise that resolves to the User entity
-     */
-    getCurrentUser: (accessToken: string, sessionKey: string) => Promise<User>;
-}