byterover-cli 2.5.2 → 3.0.0

package/dist/server/core/domain/entities/playbook.js

@@ -1,214 +0,0 @@
-import { Bullet } from './bullet.js';
-/**
- * The central knowledge repository that stores and manages bullets.
- * Playbooks are organized into sections.
- * Playbooks are used as temporary notes then will be pushed to byterover for usage.
- */
-export class Playbook {
-    bullets;
-    nextId;
-    sections;
-    constructor(bullets = new Map(), sections = new Map(), nextId = 1) {
-        this.bullets = new Map(bullets);
-        this.sections = new Map(sections);
-        this.nextId = nextId;
-    }
-    // ===== CRUD Operations =====
-    /**
-     * Adds a new bullet to the playbook
-     */
-    addBullet(section, content, bulletId, metadata) {
-        const id = bulletId ?? this._generateId(section);
-        const now = new Date().toISOString();
-        // Create metadata with defaults if not provided
-        const bulletMetadata = metadata ?? {
-            relatedFiles: [],
-            tags: [],
-            timestamp: now,
-        };
-        const bullet = new Bullet(id, section, content, bulletMetadata, undefined);
-        // Add to bullets map
-        this.bullets.set(id, bullet);
-        // Add to sections map
-        if (!this.sections.has(section)) {
-            this.sections.set(section, []);
-        }
-        this.sections.get(section).push(id);
-        return bullet;
-    }
-    /**
-     * Adds a tag to a bullet
-     */
-    addTagToBullet(bulletId, tag) {
-        const bullet = this.bullets.get(bulletId);
-        if (!bullet)
-            return undefined;
-        // Check if tag already exists
-        if (bullet.metadata.tags.includes(tag)) {
-            return bullet;
-        }
-        const updatedMetadata = {
-            ...bullet.metadata,
-            tags: [...bullet.metadata.tags, tag],
-            timestamp: new Date().toISOString(),
-        };
-        const updatedBullet = new Bullet(bullet.id, bullet.section, bullet.content, updatedMetadata, bullet.memoryId);
-        this.bullets.set(bulletId, updatedBullet);
-        return updatedBullet;
-    }
-    /**
-     * Converts playbook to markdown format for LLM prompts
-     */
-    asPrompt() {
-        const sections = this.getSections();
-        if (sections.length === 0) {
-            return '(Empty playbook)';
-        }
-        const lines = [];
-        for (const section of sections) {
-            lines.push(`## ${section}`);
-            const bullets = this.getBulletsInSection(section);
-            for (const bullet of bullets) {
-                lines.push(bullet.toDisplayString());
-            }
-            lines.push(''); // Empty line between sections
-        }
-        return lines.join('\n').trim();
-    }
-    /**
-     * Serializes to JSON string (pretty-printed)
-     * @param includeContent If false, content field is omitted from bullets (for file-based storage)
-     */
-    dumps(includeContent = true) {
-        return JSON.stringify(this.toJson(includeContent), null, 2);
-    }
-    /**
-     * Retrieves a single bullet by ID
-     */
-    getBullet(bulletId) {
-        return this.bullets.get(bulletId);
-    }
-    /**
-     * Returns all bullets as an array
-     */
-    getBullets() {
-        return [...this.bullets.values()];
-    }
-    /**
-     * Returns bullets in a specific section
-     */
-    getBulletsInSection(section) {
-        const bulletIds = this.sections.get(section) ?? [];
-        return bulletIds.map((id) => this.bullets.get(id)).filter((b) => b !== undefined);
-    }
-    /**
-     * Returns the next bullet ID that will be generated
-     */
-    getNextId() {
-        // Use "temp" as prefix since we don't know the section yet
-        return String(this.nextId).padStart(5, '0');
-    }
-    /**
-     * Returns all section names
-     */
-    getSections() {
-        return [...this.sections.keys()].sort();
-    }
-    /**
-     * Removes a bullet from the playbook
-     */
-    removeBullet(bulletId) {
-        const bullet = this.bullets.get(bulletId);
-        if (!bullet)
-            return;
-        // Remove from bullets map
-        this.bullets.delete(bulletId);
-        // Remove from sections map
-        const sectionBullets = this.sections.get(bullet.section);
-        if (sectionBullets) {
-            const index = sectionBullets.indexOf(bulletId);
-            if (index !== -1) {
-                sectionBullets.splice(index, 1);
-            }
-            // Clean up empty sections
-            if (sectionBullets.length === 0) {
-                this.sections.delete(bullet.section);
-            }
-        }
-    }
-    /**
-     * Removes a tag from a bullet
-     */
-    removeTagFromBullet(bulletId, tag) {
-        const bullet = this.bullets.get(bulletId);
-        if (!bullet)
-            return undefined;
-        const updatedMetadata = {
-            ...bullet.metadata,
-            tags: bullet.metadata.tags.filter((t) => t !== tag),
-            timestamp: new Date().toISOString(),
-        };
-        const updatedBullet = new Bullet(bullet.id, bullet.section, bullet.content, updatedMetadata, bullet.memoryId);
-        this.bullets.set(bulletId, updatedBullet);
-        return updatedBullet;
-    }
-    // ===== Presentation =====
-    /**
-     * Returns playbook statistics
-     */
-    stats() {
-        const tagsSet = new Set();
-        for (const bullet of this.bullets.values()) {
-            for (const tag of bullet.metadata.tags) {
-                tagsSet.add(tag);
-            }
-        }
-        return {
-            bullets: this.bullets.size,
-            sections: this.sections.size,
-            tags: [...tagsSet].sort(),
-        };
-    }
-    toJson(includeContent = true) {
-        const bulletsObj = {};
-        for (const [id, bullet] of this.bullets) {
-            bulletsObj[id] = bullet.toJson(includeContent);
-        }
-        const sectionsObj = {};
-        for (const [section, bulletIds] of this.sections) {
-            sectionsObj[section] = [...bulletIds];
-        }
-        return {
-            bullets: bulletsObj,
-            nextId: this.nextId,
-            sections: sectionsObj,
-        };
-    }
-    // ===== Serialization =====
-    /**
-     * Updates an existing bullet's content and/or metadata
-     */
-    updateBullet(bulletId, options) {
-        const bullet = this.bullets.get(bulletId);
-        if (!bullet)
-            return undefined;
-        const updatedMetadata = options.metadata ?? {
-            ...bullet.metadata,
-            timestamp: new Date().toISOString(),
-        };
-        const updatedBullet = new Bullet(bullet.id, bullet.section, options.content ?? bullet.content, updatedMetadata, bullet.memoryId);
-        this.bullets.set(bulletId, updatedBullet);
-        return updatedBullet;
-    }
-    // ===== Private Helpers =====
-    _generateId(section) {
-        // Convert section to prefix: "Common Errors" -> "common"
-        const prefix = section
-            .toLowerCase()
-            .split(' ')[0]
-            .replaceAll(/[^a-z0-9]/g, '');
-        const id = `${prefix}-${String(this.nextId).padStart(5, '0')}`;
-        this.nextId++;
-        return id;
-    }
-}

package/dist/server/core/domain/entities/presigned-url.d.ts

@@ -1,9 +0,0 @@
-/**
- * Represents a presigned URL for uploading files to cloud storage.
- * Contains the file name and the temporary upload URL with embedded credentials.
- */
-export declare class PresignedUrl {
-    readonly fileName: string;
-    readonly uploadUrl: string;
-    constructor(fileName: string, uploadUrl: string);
-}

package/dist/server/core/domain/entities/presigned-url.js

@@ -1,18 +0,0 @@
-/**
- * Represents a presigned URL for uploading files to cloud storage.
- * Contains the file name and the temporary upload URL with embedded credentials.
- */
-export class PresignedUrl {
-    fileName;
-    uploadUrl;
-    constructor(fileName, uploadUrl) {
-        if (fileName.trim().length === 0) {
-            throw new Error('File name cannot be empty');
-        }
-        if (uploadUrl.trim().length === 0) {
-            throw new Error('Upload URL cannot be empty');
-        }
-        this.fileName = fileName;
-        this.uploadUrl = uploadUrl;
-    }
-}

package/dist/server/core/domain/entities/presigned-urls-response.d.ts

@@ -1,10 +0,0 @@
-import type { PresignedUrl } from './presigned-url.js';
-/**
- * Represents the response from requesting presigned URLs.
- * Contains both the presigned URLs for file upload and the request ID for confirmation.
- */
-export declare class PresignedUrlsResponse {
-    readonly presignedUrls: ReadonlyArray<PresignedUrl>;
-    readonly requestId: string;
-    constructor(presignedUrls: PresignedUrl[], requestId: string);
-}

package/dist/server/core/domain/entities/presigned-urls-response.js

@@ -1,18 +0,0 @@
-/**
- * Represents the response from requesting presigned URLs.
- * Contains both the presigned URLs for file upload and the request ID for confirmation.
- */
-export class PresignedUrlsResponse {
-    presignedUrls;
-    requestId;
-    constructor(presignedUrls, requestId) {
-        if (presignedUrls.length === 0) {
-            throw new Error('Presigned URLs array cannot be empty');
-        }
-        if (requestId.trim().length === 0) {
-            throw new Error('Request ID cannot be empty');
-        }
-        this.presignedUrls = Object.freeze([...presignedUrls]);
-        this.requestId = requestId;
-    }
-}

package/dist/server/core/domain/entities/retrieve-result.d.ts

@@ -1,35 +0,0 @@
-import { Memory, MemoryParams } from './memory.js';
-/**
- * Parameters for creating a RetrieveResult instance.
- */
-export type RetrieveResultParams = {
-    memories: Memory[];
-    relatedMemories: Memory[];
-};
-/**
- * JSON representation of a RetrieveResult.
- */
-export type RetrieveResultJson = {
-    memories: MemoryParams[];
-    relatedMemories: MemoryParams[];
-};
-/**
- * Represents the result of a memory retrieval operation from the ByteRover Memora service.
- * Contains both directly matching memories and related memories.
- */
-export declare class RetrieveResult {
-    readonly memories: readonly Memory[];
-    readonly relatedMemories: readonly Memory[];
-    constructor(params: RetrieveResultParams);
-    /**
-     * Creates a RetrieveResult instance from a JSON object.
-     * @param json JSON object representing the RetrieveResult
-     * @returns An instance of RetrieveResult
-     */
-    static fromJson(json: RetrieveResultJson): RetrieveResult;
-    /**
-     * Converts the RetrieveResult instance to a JSON object.
-     * @returns A JSON object representing the RetrieveResult
-     */
-    toJson(): RetrieveResultJson;
-}

package/dist/server/core/domain/entities/retrieve-result.js

@@ -1,35 +0,0 @@
-import { Memory } from './memory.js';
-/**
- * Represents the result of a memory retrieval operation from the ByteRover Memora service.
- * Contains both directly matching memories and related memories.
- */
-export class RetrieveResult {
-    memories;
-    relatedMemories;
-    constructor(params) {
-        // Defensive copy to prevent external mutation
-        this.memories = [...params.memories];
-        this.relatedMemories = [...params.relatedMemories];
-    }
-    /**
-     * Creates a RetrieveResult instance from a JSON object.
-     * @param json JSON object representing the RetrieveResult
-     * @returns An instance of RetrieveResult
-     */
-    static fromJson(json) {
-        return new RetrieveResult({
-            memories: json.memories.map((m) => Memory.fromJson(m)),
-            relatedMemories: json.relatedMemories.map((m) => Memory.fromJson(m)),
-        });
-    }
-    /**
-     * Converts the RetrieveResult instance to a JSON object.
-     * @returns A JSON object representing the RetrieveResult
-     */
-    toJson() {
-        return {
-            memories: this.memories.map((m) => m.toJson()),
-            relatedMemories: this.relatedMemories.map((m) => m.toJson()),
-        };
-    }
-}

package/dist/server/core/domain/errors/headless-prompt-error.d.ts

@@ -1,11 +0,0 @@
-/**
- * Error thrown when headless mode encounters a prompt that cannot be handled.
- * Provides detailed information about what prompt was required and available choices.
- */
-export declare class HeadlessPromptError extends Error {
-    readonly availableChoices?: string[];
-    readonly code = "HEADLESS_PROMPT_REQUIRED";
-    readonly promptMessage: string;
-    readonly promptType: string;
-    constructor(promptType: string, promptMessage: string, availableChoices?: string[]);
-}

package/dist/server/core/domain/errors/headless-prompt-error.js

@@ -1,18 +0,0 @@
-/**
- * Error thrown when headless mode encounters a prompt that cannot be handled.
- * Provides detailed information about what prompt was required and available choices.
- */
-export class HeadlessPromptError extends Error {
-    availableChoices;
-    code = 'HEADLESS_PROMPT_REQUIRED';
-    promptMessage;
-    promptType;
-    constructor(promptType, promptMessage, availableChoices) {
-        const choicesInfo = availableChoices?.length ? ` Available choices: ${availableChoices.join(', ')}` : '';
-        super(`Headless mode cannot handle ${promptType} prompt: "${promptMessage}".${choicesInfo}`);
-        this.name = 'HeadlessPromptError';
-        this.promptType = promptType;
-        this.promptMessage = promptMessage;
-        this.availableChoices = availableChoices;
-    }
-}

package/dist/server/core/interfaces/services/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/server/core/interfaces/services/i-memory-retrieval-service.d.ts

@@ -1,39 +0,0 @@
-import type { RetrieveResult } from '../../domain/entities/retrieve-result.js';
-export type RetrieveParams = {
-    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/server/core/interfaces/services/i-memory-storage-service.d.ts

@@ -1,53 +0,0 @@
-import type { PresignedUrlsResponse } from '../../domain/entities/presigned-urls-response.js';
-/**
- * Parameters for requesting presigned URLs.
- */
-export type GetPresignedUrlsParams = {
-    branch: string;
-    fileNames: string[];
-    sessionKey: string;
-    spaceId: string;
-    teamId: string;
-};
-/**
- * Parameters for confirming upload completion.
- */
-export type ConfirmUploadParams = {
-    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/server/core/interfaces/services/i-terminal.d.ts

@@ -1,146 +0,0 @@
-/**
- * Choice option for select prompts.
- */
-export interface SelectChoice<T> {
-    description?: string;
-    name: string;
-    value: T;
-}
-/**
- * Search source function type.
- */
-export type SearchSource<T> = (input: string | undefined) => Promise<SelectChoice<T>[]> | SelectChoice<T>[];
-/**
- * Options for confirm prompt.
- */
-export interface ConfirmOptions {
-    /** The default value (default: true) */
-    default?: boolean;
-    /** The confirmation message */
-    message: string;
-}
-/**
- * Options for search prompt.
- */
-export interface SearchOptions<T> {
-    /** The prompt message */
-    message: string;
-    /** Function that returns choices based on input */
-    source: SearchSource<T>;
-}
-/**
- * Options for select prompt.
- */
-export interface SelectOptions<T> {
-    /** The available choices */
-    choices: SelectChoice<T>[];
-    /** The prompt message */
-    message: string;
-}
-/**
- * Options for input prompt.
- */
-export interface InputOptions {
-    /** The prompt message */
-    message: string;
-    /** Validation function (return true if valid, or error message string) */
-    validate?: (value: string) => boolean | string;
-}
-/**
- * File selector item representation.
- */
-export interface FileSelectorItem {
-    /** Whether the item is a directory */
-    isDirectory: boolean;
-    /** The file/directory name */
-    name: string;
-    /** The full path to the item */
-    path: string;
-}
-/**
- * Options for file selector prompt.
- */
-export interface FileSelectorOptions {
-    /** Allow user to cancel selection */
-    allowCancel?: boolean;
-    /** Base path to start selection from */
-    basePath: string;
-    /** Filter function to show/hide items */
-    filter?: (item: Readonly<FileSelectorItem>) => boolean;
-    /** The prompt message */
-    message: string;
-    /** Number of items to show per page */
-    pageSize?: number;
-    /** Custom theme labels */
-    theme?: {
-        labels?: {
-            messages?: {
-                cancel?: string;
-                empty?: string;
-            };
-        };
-    };
-    /** Type of items to select: 'directory' or 'file' */
-    type?: 'directory' | 'file';
-}
-/**
- * Interface for terminal interactions.
- * Provides output and user input operations.
- */
-export interface ITerminal {
-    /**
-     * Start a spinner/action indicator with a message.
-     * @param message The message to display while action is in progress
-     */
-    actionStart(message: string): void;
-    /**
-     * Stop the current spinner/action indicator.
-     * @param message Optional message to display when stopped
-     */
-    actionStop(message?: string): void;
-    /**
-     * Display a error message.
-     * @param message The message to display
-     */
-    error(message: string): void;
-    /**
-     * Display a message to the terminal.
-     * @param message The message to display (optional, empty line if omitted)
-     */
-    log(message?: string): void;
-    /**
-     * Display a warning message.
-     * @param message The message to display
-     */
-    warn(message: string): void;
-    /**
-     * Prompt the user for confirmation.
-     * @param options Confirmation options
-     * @returns Promise resolving to user's choice
-     */
-    confirm(options: ConfirmOptions): Promise<boolean>;
-    /**
-     * Prompt the user to select a file or directory.
-     * @param options File selector options
-     * @returns Promise resolving to selected item, or null if cancelled
-     */
-    fileSelector(options: FileSelectorOptions): Promise<FileSelectorItem | null>;
-    /**
-     * Prompt the user for text input.
-     * @param options Input options
-     * @returns Promise resolving to user's input string
-     */
-    input(options: InputOptions): Promise<string>;
-    /**
-     * Prompt the user to search and select from options.
-     * @param options Search options
-     * @returns Promise resolving to selected value
-     */
-    search<T>(options: SearchOptions<T>): Promise<T>;
-    /**
-     * Prompt the user to select from a list of choices.
-     * @param options Select options
-     * @returns Promise resolving to selected value
-     */
-    select<T>(options: SelectOptions<T>): Promise<T>;
-}

package/dist/server/core/interfaces/services/i-terminal.js

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

package/dist/server/core/interfaces/services/i-workspace-detector-service.d.ts

@@ -1,8 +0,0 @@
-import type { Agent } from '../../domain/entities/agent.js';
-export interface WorkspaceInfo {
-    chatLogPath: string;
-    cwd: string;
-}
-export interface IWorkspaceDetectorService {
-    detectWorkspaces(agent: Agent): WorkspaceInfo;
-}

package/dist/server/core/interfaces/services/i-workspace-detector-service.js

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