byterover-cli 1.6.0 → 1.7.0

package/dist/server/core/domain/entities/brv-config.js

@@ -0,0 +1,182 @@
+import { BRV_CONFIG_VERSION } from '../../../constants.js';
+import { BrvConfigVersionError } from '../errors/brv-config-version-error.js';
+import { AGENT_VALUES } from './agent.js';
+/**
+ * Type guard for Agent validation
+ */
+const isCodingAgent = (value) => {
+    if (typeof value !== 'string')
+        return false;
+    for (const agent of AGENT_VALUES) {
+        if (agent === value)
+            return true;
+    }
+    return false;
+};
+/**
+ * Type guard for BrvConfigFromJson - validates JSON structure at runtime.
+ * Note: version is optional in this check (old configs may not have it).
+ * chatLogPath, cwd, and ide are optional to support partial configs.
+ */
+const isBrvConfigJson = (json) => {
+    if (typeof json !== 'object' || json === null)
+        return false;
+    const requiredInputJsonKeys = [
+        'createdAt',
+        'spaceId',
+        'spaceName',
+        'teamId',
+        'teamName',
+    ];
+    for (const key of requiredInputJsonKeys) {
+        if (!(key in json) || typeof json[key] !== 'string') {
+            return false;
+        }
+    }
+    // Check optional fields if present
+    const obj = json;
+    if (obj.chatLogPath !== undefined && typeof obj.chatLogPath !== 'string')
+        return false;
+    if (obj.cwd !== undefined && typeof obj.cwd !== 'string')
+        return false;
+    if (obj.ide !== undefined && !isCodingAgent(obj.ide))
+        return false;
+    if (obj.cipherAgentContext !== undefined && typeof obj.cipherAgentContext !== 'string')
+        return false;
+    if (obj.cipherAgentSystemPrompt !== undefined && typeof obj.cipherAgentSystemPrompt !== 'string')
+        return false;
+    if (obj.cipherAgentModes !== undefined && !Array.isArray(obj.cipherAgentModes))
+        return false;
+    if (obj.version !== undefined && typeof obj.version !== 'string')
+        return false;
+    return true;
+};
+/**
+ * Represents the configuration stored in .brv/config.json
+ * This config links a project directory to a ByteRover space.
+ */
+export class BrvConfig {
+    chatLogPath;
+    cipherAgentContext;
+    cipherAgentModes;
+    cipherAgentSystemPrompt;
+    createdAt;
+    cwd;
+    ide;
+    spaceId;
+    spaceName;
+    teamId;
+    teamName;
+    version;
+    constructor(params) {
+        if (params.createdAt.trim().length === 0) {
+            throw new Error('Created at cannot be empty');
+        }
+        if (params.spaceId.trim().length === 0) {
+            throw new Error('Space ID cannot be empty');
+        }
+        if (params.spaceName.trim().length === 0) {
+            throw new Error('Space name cannot be empty');
+        }
+        if (params.teamId.trim().length === 0) {
+            throw new Error('Team ID cannot be empty');
+        }
+        if (params.teamName.trim().length === 0) {
+            throw new Error('Team name cannot be empty');
+        }
+        this.chatLogPath = params.chatLogPath;
+        this.cipherAgentContext = params.cipherAgentContext;
+        this.cipherAgentModes = params.cipherAgentModes;
+        this.cipherAgentSystemPrompt = params.cipherAgentSystemPrompt;
+        this.createdAt = params.createdAt;
+        this.cwd = params.cwd;
+        this.ide = params.ide;
+        this.spaceId = params.spaceId;
+        this.spaceName = params.spaceName;
+        this.teamId = params.teamId;
+        this.teamName = params.teamName;
+        this.version = params.version;
+    }
+    /**
+     * Deserializes config from JSON format.
+     * @throws Error if the JSON structure is invalid.
+     * @throws BrvConfigVersionError if version is missing or mismatched.
+     */
+    static fromJson(json) {
+        // Minimal check if json is an object
+        if (typeof json !== 'object' || json === null || json === undefined) {
+            throw new Error('BrvConfig JSON must be an object');
+        }
+        // Check version FIRST (before full structure validation)
+        // This ensures outdated configs get a helpful version error
+        // instead of a generic structure error
+        const jsonObj = json;
+        const version = typeof jsonObj.version === 'string' ? jsonObj.version : undefined;
+        if (version === undefined) {
+            throw new BrvConfigVersionError({
+                currentVersion: undefined,
+                expectedVersion: BRV_CONFIG_VERSION,
+            });
+        }
+        if (version !== BRV_CONFIG_VERSION) {
+            throw new BrvConfigVersionError({
+                currentVersion: version,
+                expectedVersion: BRV_CONFIG_VERSION,
+            });
+        }
+        if (!isBrvConfigJson(json)) {
+            throw new Error('Invalid BrvConfig JSON structure');
+        }
+        return new BrvConfig({ ...json, version });
+    }
+    /**
+     * Creates a BrvConfig from a Space entity.
+     */
+    static fromSpace(params) {
+        return new BrvConfig({
+            chatLogPath: params.chatLogPath,
+            createdAt: new Date().toISOString(),
+            cwd: params.cwd,
+            ide: params.ide,
+            spaceId: params.space.id,
+            spaceName: params.space.name,
+            teamId: params.space.teamId,
+            teamName: params.space.teamName,
+            version: BRV_CONFIG_VERSION,
+        });
+    }
+    /**
+     * Creates a partial BrvConfig from a Space entity.
+     * Used for login pre-select when user has only one team and one space.
+     * Does not include chatLogPath, cwd, or ide (agent selection happens in /init).
+     */
+    static partialFromSpace(params) {
+        return new BrvConfig({
+            createdAt: new Date().toISOString(),
+            spaceId: params.space.id,
+            spaceName: params.space.name,
+            teamId: params.space.teamId,
+            teamName: params.space.teamName,
+            version: BRV_CONFIG_VERSION,
+        });
+    }
+    /**
+     * Serializes the config to JSON format
+     */
+    toJson() {
+        return {
+            chatLogPath: this.chatLogPath,
+            cipherAgentContext: this.cipherAgentContext,
+            cipherAgentModes: this.cipherAgentModes,
+            cipherAgentSystemPrompt: this.cipherAgentSystemPrompt,
+            createdAt: this.createdAt,
+            cwd: this.cwd,
+            ide: this.ide,
+            spaceId: this.spaceId,
+            spaceName: this.spaceName,
+            teamId: this.teamId,
+            teamName: this.teamName,
+            version: this.version,
+        };
+    }
+}

package/dist/server/core/domain/entities/space.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Parameters for creating a Space instance
+ */
+interface SpaceParams {
+    id: string;
+    isDefault: boolean;
+    name: string;
+    teamId: string;
+    teamName: string;
+}
+/**
+ * Represents a ByteRover space that belongs to a team.
+ * A space corresponds to a user's codebase and contains memories for that codebase.
+ */
+export declare class Space {
+    readonly id: string;
+    readonly isDefault: boolean;
+    readonly name: string;
+    readonly teamId: string;
+    readonly teamName: string;
+    constructor(params: SpaceParams);
+    /**
+     * Deserializes a space from JSON format
+     */
+    static fromJson(json: Record<string, unknown>): Space;
+    /**
+     * Returns the display name in the format: teamName/spaceName
+     * Example: "acme-corp/frontend-app"
+     */
+    getDisplayName(): string;
+    /**
+     * Serializes the space to JSON format
+     */
+    toJson(): Record<string, unknown>;
+}
+export {};

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

@@ -0,0 +1,76 @@
+/**
+ * Represents a ByteRover space that belongs to a team.
+ * A space corresponds to a user's codebase and contains memories for that codebase.
+ */
+export class Space {
+    id;
+    isDefault;
+    name;
+    teamId;
+    teamName;
+    constructor(params) {
+        if (params.id.trim().length === 0) {
+            throw new Error('Space ID cannot be empty');
+        }
+        if (params.name.trim().length === 0) {
+            throw new Error('Space name cannot be empty');
+        }
+        if (params.teamId.trim().length === 0) {
+            throw new Error('Team ID cannot be empty');
+        }
+        if (params.teamName.trim().length === 0) {
+            throw new Error('Team name cannot be empty');
+        }
+        this.id = params.id;
+        this.isDefault = params.isDefault;
+        this.name = params.name;
+        this.teamId = params.teamId;
+        this.teamName = params.teamName;
+    }
+    /**
+     * Deserializes a space from JSON format
+     */
+    static fromJson(json) {
+        if (typeof json.id !== 'string') {
+            throw new TypeError('Space JSON must have a string id field');
+        }
+        if (typeof json.is_default !== 'boolean') {
+            throw new TypeError('Space JSON must have a boolean is_default field');
+        }
+        if (typeof json.name !== 'string') {
+            throw new TypeError('Space JSON must have a string name field');
+        }
+        if (typeof json.team_id !== 'string') {
+            throw new TypeError('Space JSON must have a string team_id field');
+        }
+        if (typeof json.team_name !== 'string') {
+            throw new TypeError('Space JSON must have a string team_name field');
+        }
+        return new Space({
+            id: json.id,
+            isDefault: json.is_default,
+            name: json.name,
+            teamId: json.team_id,
+            teamName: json.team_name,
+        });
+    }
+    /**
+     * Returns the display name in the format: teamName/spaceName
+     * Example: "acme-corp/frontend-app"
+     */
+    getDisplayName() {
+        return `${this.teamName}/${this.name}`;
+    }
+    /**
+     * Serializes the space to JSON format
+     */
+    toJson() {
+        return {
+            id: this.id,
+            isDefault: this.isDefault,
+            name: this.name,
+            teamId: this.teamId,
+            teamName: this.teamName,
+        };
+    }
+}

package/dist/server/core/domain/entities/team.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Parameters for creating a Team instance
+ */
+interface TeamParams {
+    avatarUrl: string;
+    createdAt: Date;
+    description: string;
+    displayName: string;
+    id: string;
+    isActive: boolean;
+    isDefault: boolean;
+    name: string;
+    updatedAt: Date;
+}
+/**
+ * Represents a ByteRover team that contains spaces.
+ * A team is a group of users collaborating on one or more codebases.
+ */
+export declare class Team {
+    readonly avatarUrl: string;
+    readonly createdAt: Date;
+    readonly description: string;
+    readonly displayName: string;
+    readonly id: string;
+    readonly isActive: boolean;
+    readonly isDefault: boolean;
+    readonly name: string;
+    readonly updatedAt: Date;
+    constructor(params: TeamParams);
+    /**
+     * Deserializes a team from JSON format (API response with snake_case)
+     */
+    static fromJson(json: Record<string, unknown>): Team;
+    /**
+     * Returns the display name for UI purposes
+     * Example: "Acme Corporation"
+     */
+    getDisplayName(): string;
+    /**
+     * Serializes the team to JSON format (camelCase for storage)
+     */
+    toJson(): Record<string, unknown>;
+}
+export {};

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

@@ -0,0 +1,96 @@
+/**
+ * Represents a ByteRover team that contains spaces.
+ * A team is a group of users collaborating on one or more codebases.
+ */
+export class Team {
+    avatarUrl;
+    createdAt;
+    description;
+    displayName;
+    id;
+    isActive;
+    isDefault;
+    name;
+    updatedAt;
+    constructor(params) {
+        if (params.id.trim().length === 0) {
+            throw new Error('Team ID cannot be empty');
+        }
+        if (params.name.trim().length === 0) {
+            throw new Error('Team name cannot be empty');
+        }
+        if (params.displayName.trim().length === 0) {
+            throw new Error('Team display name cannot be empty');
+        }
+        this.avatarUrl = params.avatarUrl;
+        this.createdAt = params.createdAt;
+        this.description = params.description;
+        this.displayName = params.displayName;
+        this.id = params.id;
+        this.isActive = params.isActive;
+        this.isDefault = params.isDefault;
+        this.name = params.name;
+        this.updatedAt = params.updatedAt;
+    }
+    /**
+     * Deserializes a team from JSON format (API response with snake_case)
+     */
+    static fromJson(json) {
+        // Validate required fields
+        if (typeof json.id !== 'string') {
+            throw new TypeError('Team JSON must have a string id field');
+        }
+        if (typeof json.name !== 'string') {
+            throw new TypeError('Team JSON must have a string name field');
+        }
+        if (typeof json.display_name !== 'string') {
+            throw new TypeError('Team JSON must have a string display_name field');
+        }
+        if (typeof json.is_active !== 'boolean') {
+            throw new TypeError('Team JSON must have a boolean is_active field');
+        }
+        if (typeof json.created_at !== 'string') {
+            throw new TypeError('Team JSON must have a string created_at field');
+        }
+        if (typeof json.updated_at !== 'string') {
+            throw new TypeError('Team JSON must have a string updated_at field');
+        }
+        if (typeof json.is_default !== 'boolean') {
+            throw new TypeError('Team JSON must have a boolean is_default field');
+        }
+        return new Team({
+            avatarUrl: typeof json.avatar_url === 'string' ? json.avatar_url : '',
+            createdAt: new Date(json.created_at),
+            description: typeof json.description === 'string' ? json.description : '',
+            displayName: json.display_name,
+            id: json.id,
+            isActive: json.is_active,
+            isDefault: json.is_default,
+            name: json.name,
+            updatedAt: new Date(json.updated_at),
+        });
+    }
+    /**
+     * Returns the display name for UI purposes
+     * Example: "Acme Corporation"
+     */
+    getDisplayName() {
+        return this.displayName;
+    }
+    /**
+     * Serializes the team to JSON format (camelCase for storage)
+     */
+    toJson() {
+        return {
+            avatarUrl: this.avatarUrl,
+            createdAt: this.createdAt.toISOString(),
+            description: this.description,
+            displayName: this.displayName,
+            id: this.id,
+            isActive: this.isActive,
+            isDefault: this.isDefault,
+            name: this.name,
+            updatedAt: this.updatedAt.toISOString(),
+        };
+    }
+}

package/dist/server/core/domain/entities/user.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Parameters for creating a User instance
+ */
+interface UserParams {
+    email: string;
+    hasOnboardedCli: boolean;
+    id: string;
+    name: string;
+}
+/**
+ * Represents a user in the system.
+ */
+export declare class User {
+    readonly email: string;
+    readonly hasOnboardedCli: boolean;
+    readonly id: string;
+    readonly name: string;
+    constructor(params: UserParams);
+    /**
+     * Create a User instance from a JSON object.
+     * @param json JSON object representing the User
+     * @returns An instance of User
+     */
+    static fromJson(json: Record<string, unknown>): User;
+    /**
+     * Convert the User instance to a JSON object.
+     * @returns A JSON object representing the User
+     */
+    toJson(): Record<string, unknown>;
+}
+export {};

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

@@ -0,0 +1,52 @@
+/**
+ * Represents a user in the system.
+ */
+export class User {
+    email;
+    hasOnboardedCli;
+    id;
+    name;
+    constructor(params) {
+        this.email = params.email;
+        this.hasOnboardedCli = params.hasOnboardedCli;
+        this.id = params.id;
+        this.name = params.name;
+    }
+    /**
+     * Create a User instance from a JSON object.
+     * @param json JSON object representing the User
+     * @returns An instance of User
+     */
+    static fromJson(json) {
+        if (typeof json.email !== 'string') {
+            throw new TypeError('User JSON must have a string email field');
+        }
+        if (typeof json.id !== 'string') {
+            throw new TypeError('User JSON must have a string id field');
+        }
+        if (typeof json.name !== 'string') {
+            throw new TypeError('User JSON must have a string name field');
+        }
+        if (typeof json.has_onboarded_cli !== 'boolean') {
+            throw new TypeError('User JSON must have a boolean has_onboarded_cli field');
+        }
+        return new User({
+            email: json.email,
+            hasOnboardedCli: json.has_onboarded_cli,
+            id: json.id,
+            name: json.name,
+        });
+    }
+    /**
+     * Convert the User instance to a JSON object.
+     * @returns A JSON object representing the User
+     */
+    toJson() {
+        return {
+            email: this.email,
+            hasOnboardedCli: this.hasOnboardedCli,
+            id: this.id,
+            name: this.name,
+        };
+    }
+}

package/dist/server/core/domain/knowledge/relation-parser.d.ts

@@ -0,0 +1,94 @@
+/**
+ * Utilities for parsing and managing context relations.
+ * Relations are expressed using @ notation: @domain/topic/title.md or @domain/topic/subtopic/title.md
+ */
+/**
+ * Parse relations from title.md content.
+ * Extracts all @domain/topic/title.md or @domain/topic/subtopic/title.md references.
+ *
+ * @param content - Markdown content to parse
+ * @returns Array of unique relation paths (without @ prefix)
+ *
+ * @example
+ * ```ts
+ * const content = `
+ * ## Relations
+ * @code_style/error-handling/overview.md
+ * @structure/api/endpoints/rest.md
+ * `
+ * parseRelations(content) // ['code_style/error-handling/overview.md', 'structure/api/endpoints/rest.md']
+ * ```
+ */
+export declare function parseRelations(content: string): string[];
+/**
+ * Resolve a relation path to an absolute file system path.
+ *
+ * @param basePath - Base path to context tree (e.g., '.brv/context-tree')
+ * @param relation - Relation path (e.g., 'domain/topic/title.md' or 'domain/topic/subtopic/title.md')
+ * @returns Absolute path to the title.md file
+ *
+ * @example
+ * ```ts
+ * resolveRelationPath('.brv/context-tree', 'code_style/error-handling/overview.md')
+ * // => '.brv/context-tree/code_style/error-handling/overview.md'
+ *
+ * resolveRelationPath('.brv/context-tree', 'structure/api/endpoints/rest.md')
+ * // => '.brv/context-tree/structure/api/endpoints/rest.md'
+ * ```
+ */
+export declare function resolveRelationPath(basePath: string, relation: string): string;
+/**
+ * Format a relation path using @ notation.
+ *
+ * @param domain - Domain name
+ * @param topic - Topic name
+ * @param title - Title (with .md extension)
+ * @param subtopic - Optional subtopic name
+ * @returns Formatted relation string with @ prefix
+ *
+ * @example
+ * ```ts
+ * formatRelation('code_style', 'error-handling', 'overview.md')
+ * // => '@code_style/error-handling/overview.md'
+ *
+ * formatRelation('structure', 'api', 'endpoints', 'rest.md')
+ * // => '@structure/api/endpoints/rest.md'
+ * ```
+ */
+export declare function formatRelation(domain: string, topic: string, title: string, subtopic?: string): string;
+/**
+ * Normalize a relation path by removing the @ prefix.
+ * Preserves file extensions (e.g., .md).
+ *
+ * @param relation - Relation path to normalize
+ * @returns Normalized relation path without @ prefix (file extension preserved)
+ *
+ * @example
+ * ```ts
+ * normalizeRelation('code_style/error-handling.md') // 'code_style/error-handling.md'
+ * normalizeRelation('@code_style/error-handling.md') // 'code_style/error-handling.md'
+ * normalizeRelation('code_style/error-handling/title.md') // 'code_style/error-handling/title.md'
+ * normalizeRelation('code_style/error-handling/file.md') // 'code_style/error-handling/file.md'
+ * ```
+ */
+export declare function normalizeRelation(relation: string): string;
+/**
+ * Generate the Relations section for context.md.
+ * Returns empty string if no relations provided.
+ *
+ * @param relations - Array of relation paths (with or without @ prefix)
+ * @returns Markdown formatted Relations section or empty string
+ *
+ * @example
+ * ```ts
+ * generateRelationsSection(['code_style/error-handling/overview.md', 'structure/api/rest.md'])
+ * // => '\n## Relations\n@code_style/error-handling/overview.md\n@structure/api/rest.md\n'
+ *
+ * generateRelationsSection(['Architecture/Agents/Overview.md', 'Architecture/Agents/Sandbox and Security.md'])
+ * // => '\n## Relations\n@architecture/agents/overview.md\n@architecture/agents/sandbox_and_security.md\n'
+ *
+ * generateRelationsSection([])
+ * // => ''
+ * ```
+ */
+export declare function generateRelationsSection(relations: string[]): string;