Classes

FlowStateCLI

FlowState CLI class Manages CLI commands and server connections

Constructor

constructor(configDir?: string | undefined)

Parameters:

Methods

initialize

Initialize the CLI

initialize(): Promise<void>

Returns:

Promise<void> -

getConfigDir

Get config directory

getConfigDir(): string

Returns:

string -

getConfig

Get current configuration

getConfig(): FlowStateConfig

Returns:

FlowStateConfig -

executeCommand

Execute a command (for testing)

executeCommand(args: string[]): Promise<void>

Parameters:

Returns:

Promise<void> -

ensureContext

Ensure context (org/workspace) is set before operations If not set, prompts user to create or select

ensureContext(options?: { requireWorkspace?: boolean; }): Promise<boolean>

Parameters:

Returns:

Promise<boolean> -

close

Close the CLI and clean up resources

close(): Promise<void>

Returns:

Promise<void> -

AuthCommand

Export auth command for registration in FlowStateCLI

Constructor

constructor()

Methods

login

login(profileName?: string | undefined): Promise<void>

Parameters:

Returns:

Promise<void> -

logout

logout(profileName?: string | undefined, all?: boolean | undefined): Promise<void>

Parameters:

Returns:

Promise<void> -

status

status(profileName?: string | undefined): Promise<void>

Parameters:

Returns:

Promise<void> -

ContextCommand

Constructor

constructor(_client: IRxDBClient<any>, config: FlowStateConfig, logger: LoggingService, saveConfig: () => Promise<void>, registry?: CommandRegistry | undefined)

Parameters:

Methods

setOrg

Set current organization

setOrg(options: ContextCommandOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

setWorkspace

Set current workspace

setWorkspace(options: ContextCommandOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

showContext

Show current context

showContext(): Promise<void>

Returns:

Promise<void> -

listOrganizationsCommand

List organizations

listOrganizationsCommand(options?: OrgListOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

createOrganization

Create a new organization

createOrganization(options: OrgCreateOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

listWorkspacesCommand

List workspaces

listWorkspacesCommand(options?: WorkspaceListOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

createWorkspace

Create a new workspace

createWorkspace(options: WorkspaceCreateOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

ensureContext

Ensure context is set (org and optionally workspace) If not set, prompt user to create or select Returns true if context is valid, false if user cancelled

ensureContext(options?: { requireWorkspace?: boolean; }): Promise<boolean>

Parameters:

Returns:

Promise<boolean> -

CreateAppCommand

Create App Command

Constructor

constructor(monorepoRoot?: string | undefined)

Parameters:

Methods

execute

Execute the create-app command

execute(options: CreateAppOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

DiscoverCommand

Discover Command - analyzes codebase compliance with FlowState Standard

Constructor

constructor()

Methods

execute

execute(options?: DiscoverOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

DoctorCommand

Doctor Command - diagnoses FlowState environment

Constructor

constructor()

Methods

execute

Execute the doctor command

execute(options?: DoctorOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

checkFlowstateConfig

Check FlowState configuration in current directory

checkFlowstateConfig(result: DoctorResult): Promise<void>

Parameters:

Returns:

Promise<void> -

checkRepoRequirements

Check repository requirements (package.json, node version, etc.)

checkRepoRequirements(result: DoctorResult): Promise<void>

Parameters:

Returns:

Promise<void> -

checkLocalServices

Check local services health Health checks bypass Kong Gateway and go directly to services for accurate monitoring

checkLocalServices(result: DoctorResult, options: DoctorOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

promptDockerSetup

Prompt user to set up docker containers

promptDockerSetup(options: DoctorOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

InitCommand

FlowState init command implementation

Constructor

constructor(dependencyChecker: DependencyChecker, gitHelper: GitHelper, githubHelper: GitHubHelper, onePasswordHelper: OnePasswordHelper, fileTemplates: FileTemplates, codebaseManager?: CodebaseManager | undefined)

Parameters:

Methods

execute

Execute init command

execute(options: InitOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

InstallHookCommand

Methods

execute

execute(hookName: string): Promise<void>

Parameters:

Returns:

Promise<void> -

LinkCommand

Constructor

constructor(logger: LoggingService, registry: CommandRegistry)

Parameters:

Methods

execute

Execute the link command

execute(_options?: LinkCommandOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

ScanTodosCommand

Constructor

constructor(client: IRxDBClient<any>, config: FlowStateConfig)

Parameters:

Methods

execute

execute(options: ScanTodosOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

ServerProfileCommand

ServerCommand class for programmatic use

Constructor

constructor()

Methods

add

add(name: string, options: { url: string; domain: string; displayName?: string; }): Promise<void>

Parameters:

Returns:

Promise<void> -

list

list(): Promise<void>

Returns:

Promise<void> -

use

use(name: string): Promise<void>

Parameters:

Returns:

Promise<void> -

remove

remove(name: string): Promise<void>

Parameters:

Returns:

Promise<void> -

test

test(name?: string | undefined): Promise<void>

Parameters:

Returns:

Promise<void> -

getConfigManager

getConfigManager(): ConfigManager

Returns:

ConfigManager -

GenerateFiletreeCommand

Constructor

constructor(client: IRxDBClient<any>, config: FlowStateConfig)

Parameters:

Methods

execute

execute(options: GenerateFiletreeOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

MappingsCommand

Constructor

constructor(_config: FlowStateConfig)

Parameters:

Methods

execute

execute(options: MappingsOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

listByFile

listByFile(filePath: string): Promise<string>

Parameters:

Returns:

Promise<string> -

listByTask

listByTask(taskId: string): Promise<string>

Parameters:

Returns:

Promise<string> -

listByDocument

listByDocument(documentId: string): Promise<string>

Parameters:

Returns:

Promise<string> -

listBySpec

listBySpec(specId: string): Promise<string>

Parameters:

Returns:

Promise<string> -

listAll

listAll(type?: MappingType | undefined): Promise<string>

Parameters:

Returns:

Promise<string> -

MigrateMappingsCommand

Constructor

constructor(_config: FlowStateConfig, projectRoot?: string | undefined)

Parameters:

Methods

execute

execute(options?: MigrateOptions): Promise<MigrationResult>

Parameters:

Returns:

Promise<MigrationResult> -

SyncAgentsCommand

Constructor

constructor(client: IRxDBClient<any>, config: FlowStateConfig)

Parameters:

Methods

execute

execute(options: SyncAgentsOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

SyncAllCommand

Constructor

constructor(_client: IRxDBClient<any>, _config: FlowStateConfig)

Parameters:

Methods

execute

execute(options: SyncAllOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

SyncMarkdownFilesCommand

Constructor

constructor(client: IRxDBClient<any>, config: FlowStateConfig, authToken?: string | undefined)

Parameters:

Methods

execute

execute(options: SyncMarkdownOptions): Promise<void>

Parameters:

Returns:

Promise<void> -

CollectionManager

Generic CRUD manager for any collection

Constructor

constructor(client: IRxDBClient<any>, collectionName: string, schema: RxJsonSchema<any>)

Parameters:

Methods

create

Create a new document

create(data: Partial<TDocument>): Promise<TDocument>

Parameters:

Returns:

Promise<TDocument> -

get

Get a document by ID

get(id: string): Promise<TDocument | null>

Parameters:

Returns:

Promise<TDocument \| null> -

list

List documents with filters

list(filters?: QueryFilters | undefined): Promise<TDocument[]>

Parameters:

Returns:

Promise<TDocument[]> -

update

Update a document

update(id: string, updates: Partial<TDocument>): Promise<TDocument>

Parameters:

Returns:

Promise<TDocument> -

delete

Delete a document

delete(id: string): Promise<boolean>

Parameters:

Returns:

Promise<boolean> -

query

Query documents with RxDB selector

query(selector: any): Promise<TDocument[]>

Parameters:

Returns:

Promise<TDocument[]> -

bulkCreate

Bulk create documents

bulkCreate(items: Partial<TDocument>[]): Promise<TDocument[]>

Parameters:

Returns:

Promise<TDocument[]> -

CommandRegistry

Registry for auto-discovered collections

Methods

initialize

Initialize registry by discovering collections

initialize(client: IRxDBClient<any>, options?: { defaultOrgId?: string; defaultUserId?: string; } | undefined): Promise<void>

Parameters:

Returns:

Promise<void> -

getManager

Get manager for a collection

getManager(collectionName: string): CollectionManager<any>

Parameters:

Returns:

CollectionManager<any> -

getAllCollectionNames

Get all collection names

getAllCollectionNames(): string[]

Returns:

string[] -

getCollectionSchema

Get schema for a collection

getCollectionSchema(collectionName: string): RxJsonSchema<any>

Parameters:

Returns:

RxJsonSchema<any> -

getDefaultOrgId

Get default org ID

getDefaultOrgId(): string | undefined

Returns:

string \| undefined -

getDefaultUserId

Get default user ID

getDefaultUserId(): string | undefined

Returns:

string \| undefined -

InteractivePrompts

Interactive prompts for user-friendly document creation

Methods

promptForDocument

Prompt user for document fields based on schema

promptForDocument(schema: RxJsonSchema<any>, collectionName: string): Promise<any>

Parameters:

Returns:

Promise<any> -

confirmDelete

Confirm deletion

confirmDelete(collectionName: string, id: string): Promise<boolean>

Parameters:

Returns:

Promise<boolean> -

selectFromList

Select from list

selectFromList(message: string, choices: string[]): Promise<string>

Parameters:

Returns:

Promise<string> -

confirm

Confirm action

confirm(message: string, defaultValue?: boolean): Promise<boolean>

Parameters:

Returns:

Promise<boolean> -

LoggingService

Constructor

constructor(config?: Partial<LoggingConfig> | undefined)

Parameters:

Methods

configure

Update logging configuration

configure(config: Partial<LoggingConfig>): void

Parameters:

setVerbose

Enable verbose mode

setVerbose(verbose: boolean): void

Parameters:

setLevel

Set log level

setLevel(level: LogLevel): void

Parameters:

isVerbose

Check if verbose mode is enabled

isVerbose(): boolean

Returns:

boolean -

debug

Log debug message (only in verbose mode)

debug(message: string, args?: any[]): void

Parameters:

info

Log info message

info(message: string, args?: any[]): void

Parameters:

warn

Log warning message

warn(message: string, args?: any[]): void

Parameters:

error

Log error message

error(message: string, error?: any, args?: any[]): void

Parameters:

success

Log success message

success(message: string, args?: any[]): void

Parameters:

child

Create a child logger with a prefix

child(prefix: string): LoggingService

Parameters:

Returns:

LoggingService -

ObsSessionContext

ObsSessionContext - Singleton class for managing session context

Constructor

constructor()

Methods

getInstance

Get singleton instance

getInstance(): ObsSessionContext

Returns:

ObsSessionContext - The singleton instance of ObsSessionContext

setContext

Set session context and update environment variables This performs a shallow merge with existing context.

setContext(data: Partial<SessionContextData>): void

Parameters:

Examples:

const obsContext = ObsSessionContext.getInstance();
obsContext.setContext({
  projectId: 'proj-123',
  taskId: 'task-456'
});

getContext

Get current session context

getContext(): SessionContextData

Returns:

SessionContextData - Current session context data

Examples:

const obsContext = ObsSessionContext.getInstance();
const context = obsContext.getContext();
console.log(context.projectId);

clearContext

Clear all session context and environment variables

clearContext(): void

Examples:

const obsContext = ObsSessionContext.getInstance();
obsContext.clearContext();

resetInstance

Reset singleton instance (primarily for testing)

resetInstance(): void

Examples:

const obsContext = ObsSessionContext.getInstance();
obsContext.setContext({
  projectId: project.id,
  taskId: task.id,
  specName: spec.name,
  userId: config.userId,
  gitBranch: await getCurrentGitBranch(),
  workingDirectory: process.cwd()
});

// Later retrieve context
const context = obsContext.getContext();
console.log(context.projectId); // project.id

// Clear context when done
obsContext.clearContext();

OutputFormatter

Output formatter for consistent CLI display

Methods

format

Format data based on output type

format(data: any, format: "table" | "json" | "yaml" | "csv", schema?: RxJsonSchema<any> | undefined): string

Parameters:

Returns:

string -

QueryBuilder

Query builder for translating CLI options to RxDB queries

Methods

parseFilter

Parse filter string into RxDB selector Supports both JSON and simple key=value syntax

parseFilter(filterStr: string): any

Parameters:

Returns:

any -

buildQueryOptions

Build complete query options from CLI flags

buildQueryOptions(options: { filter?: string; sort?: string; limit?: string; skip?: string; }): QueryFilters

Parameters:

Returns:

QueryFilters -

DependencyChecker

Utility class for checking system dependencies

Methods

checkDependency

Check if a dependency is installed

checkDependency(dep: string): Promise<DependencyCheckResult>

Parameters:

Returns:

Promise<DependencyCheckResult> -

checkAll

Check all dependencies for a project type

checkAll(deps: Record<string, string | boolean>): Promise<Map<string, DependencyCheckResult>>

Parameters:

Returns:

Promise<Map<string, DependencyCheckResult>> -

displayResults

Display dependency check results

displayResults(results: Map<string, DependencyCheckResult>): void

Parameters:

hasMissingDependencies

Check if any required dependencies are missing

hasMissingDependencies(results: Map<string, DependencyCheckResult>): boolean

Parameters:

Returns:

boolean -

FileTemplates

Utility class for generating file templates

Methods

generateClaudeMd

Generate CLAUDE.md based on project type

generateClaudeMd(config: { projectName: string; projectType: string; description?: string; }): string

Parameters:

Returns:

string -

generateMcpJson

Generate .mcp.json based on project type

generateMcpJson(projectType: string, _customServers?: string[] | undefined): object

Parameters:

Returns:

object -

generateFlowstateReadme

Generate .flowstate/README.md

generateFlowstateReadme(): string

Returns:

string -

copyClaudeTemplate

Copy .claude template directory

copyClaudeTemplate(targetPath: string, commands: string[]): Promise<void>

Parameters:

Returns:

Promise<void> -

FlowStateEntityHelper

Helper class for managing FlowState entities during init

Constructor

constructor(client: RxDBClient)

Parameters:

Methods

selectOrCreateOrg

Select or create an organization

selectOrCreateOrg(options?: { yes?: boolean; orgId?: string; }): Promise<Org>

Parameters:

Returns:

Promise<Org> -

selectOrCreateWorkspace

Select or create a workspace

selectOrCreateWorkspace(orgId: string, userId: string, options?: { yes?: boolean; workspaceId?: string; projectName?: string; }): Promise<Workspace>

Parameters:

Returns:

Promise<Workspace> -

selectOrCreateUser

Select or create a user

selectOrCreateUser(orgId: string, options?: { yes?: boolean; userId?: string; }): Promise<User>

Parameters:

Returns:

Promise<User> -

createProject

Create a project linked to a codebase

createProject(orgId: string, userId: string, workspaceId: string, codebaseId: string, projectName: string, options?: { description?: string; }): Promise<Project>

Parameters:

Returns:

Promise<Project> -

validateEntities

Validate that all entities exist and are properly linked

validateEntities(orgId: string, workspaceId: string, userId: string, codebaseId?: string | undefined, projectId?: string | undefined): Promise<{ valid: boolean; issues: string[]; }>

Parameters:

Returns:

Promise<{ valid: boolean; issues: string[]; }> -

runEntitySelectionFlow

Run the full entity selection flow Returns orgId, workspaceId, and userId for use in init

runEntitySelectionFlow(options?: { yes?: boolean; orgId?: string; workspaceId?: string; userId?: string; projectName?: string; }): Promise<EntitySelectionResult>

Parameters:

Returns:

Promise<EntitySelectionResult> -

GitHelper

Utility class for Git operations

Methods

isGitInitialized

Check if git is initialized in directory

isGitInitialized(projectPath: string): Promise<boolean>

Parameters:

Returns:

Promise<boolean> -

initGit

Initialize git repository

initGit(projectPath: string): Promise<void>

Parameters:

Returns:

Promise<void> -

getRemoteUrl

Get current remote URL if exists

getRemoteUrl(projectPath: string): Promise<string | null>

Parameters:

Returns:

Promise<string \| null> -

createGitignore

Create .gitignore file

createGitignore(projectPath: string, entries: string[]): Promise<void>

Parameters:

Returns:

Promise<void> -

addRemote

Add git remote

addRemote(projectPath: string, url: string): Promise<void>

Parameters:

Returns:

Promise<void> -

createInitialCommit

Create initial commit

createInitialCommit(projectPath: string): Promise<void>

Parameters:

Returns:

Promise<void> -

push

Push to remote

push(projectPath: string): Promise<void>

Parameters:

Returns:

Promise<void> -

getCurrentBranch

Get current git branch name

getCurrentBranch(projectPath?: string | undefined): string | undefined

Parameters:

Returns:

string \| undefined -

GitHubHelper

Utility class for GitHub CLI operations

Methods

isAuthenticated

Check if GitHub CLI is authenticated

isAuthenticated(): Promise<boolean>

Returns:

Promise<boolean> -

createRepo

Create new GitHub repository

createRepo(options: { name: string; description: string; private: boolean; projectPath: string; }): Promise<{ url: string; success: boolean; }>

Parameters:

Returns:

Promise<{ url: string; success: boolean; }> -

linkRepo

Link to existing repository

linkRepo(repoUrl: string, projectPath: string): Promise<boolean>

Parameters:

Returns:

Promise<boolean> -

pushInitialCommit

Push initial commit

pushInitialCommit(projectPath: string): Promise<boolean>

Parameters:

Returns:

Promise<boolean> -

HttpRxDBClient

HTTP-based RxDB client for CLI operations Implements the RxDBClient interface for FlowStateEntityHelper

Constructor

constructor(options: HttpClientOptions)

Parameters:

Methods

query

Query documents in a collection

query(collection: string, selector: object, options?: { sort?: any[]; limit?: number; } | undefined): Promise<T[]>

Parameters:

Returns:

Promise<T[]> -

get

Get a single document by ID

get(collection: string, id: string): Promise<T | null>

Parameters:

Returns:

Promise<T \| null> -

create

Create a new document using the /set endpoint The RxDB server REST plugin uses /set for creating/updating documents

create(collection: string, data: Partial<T>): Promise<T>

Parameters:

Returns:

Promise<T> -

update

Update an existing document using the /set endpoint The RxDB server REST plugin uses /set for creating/updating documents

update(collection: string, id: string, data: Partial<T>): Promise<T>

Parameters:

Returns:

Promise<T> -

testConnection

Test connection to the RxDB server

testConnection(): Promise<boolean>

Returns:

Promise<boolean> -

DryRunRxDBClient

Dry-run RxDB client that wraps a real client

• Passes through query(), get(), testConnection() to the real client
• Intercepts create() calls to collect planned operations
• Returns mock entities with pre-generated IDs for creates

Constructor

constructor(realClient: HttpRxDBClient)

Parameters:

Methods

getPlannedOperations

Get all planned operations collected during dry-run

getPlannedOperations(): PlannedOperation[]

Returns:

PlannedOperation[] -

clearPlannedOperations

Clear planned operations

clearPlannedOperations(): void

query

Query documents - passes through to real client

query(collection: string, selector: object, options?: { sort?: any[]; limit?: number; } | undefined): Promise<T[]>

Parameters:

Returns:

Promise<T[]> -

get

Get a single document - passes through to real client

get(collection: string, id: string): Promise<T | null>

Parameters:

Returns:

Promise<T \| null> -

create

Create a new document - intercepted for dry-run Records the planned operation and returns a mock entity

create(collection: string, data: Partial<T>): Promise<T>

Parameters:

Returns:

Promise<T> -

update

Update a document - passes through to real client (In dry-run we don't update existing entities)

update(collection: string, id: string, data: Partial<T>): Promise<T>

Parameters:

Returns:

Promise<T> -

testConnection

Test connection - passes through to real client

testConnection(): Promise<boolean>

Returns:

Promise<boolean> -

recordExistingEntity

Record that an existing entity is being used

recordExistingEntity(collection: string, id: string, data?: Record<string, unknown>): void

Parameters:

OnePasswordHelper

Utility class for 1Password CLI operations

Methods

isInstalled

Check if 1Password CLI is installed

isInstalled(): Promise<boolean>

Returns:

Promise<boolean> -

isSignedIn

Check if user is signed in

isSignedIn(): Promise<boolean>

Returns:

Promise<boolean> -

listVaults

List available vaults

listVaults(): Promise<{ id: string; name: string; }[]>

Returns:

Promise<{ id: string; name: string; }[]> -

createVault

Create new vault

createVault(name: string, description: string): Promise<{ success: boolean; vaultId?: string; vaultName?: string; }>

Parameters:

Returns:

Promise<{ success: boolean; vaultId?: string; vaultName?: string; }> -

storeSecret

Store secret in vault

storeSecret(options: { vault: string; itemName: string; fields: Record<string, string>; tags?: string[]; }): Promise<boolean>

Parameters:

Returns:

Promise<boolean> -

getSecretReference

Get secret reference for use in config

getSecretReference(vault: string, itemName: string, field: string): Promise<string>

Parameters:

Returns:

Promise<string> -

getSecret

Retrieve secret value

getSecret(reference: string): Promise<string | null>

Parameters:

Returns:

Promise<string \| null> -

AgentScanner

Scans and parses agent JSON files from .flowstate/agents directory

Constructor

constructor(config?: Partial<AgentScannerConfig> | undefined)

Parameters:

Methods

scan

Scan for all agent JSON files

scan(): Promise<AgentFile[]>

Returns:

Promise<AgentFile[]> -

parseAgentFile

Parse a single agent JSON file

parseAgentFile(filePath: string): Promise<AgentFile | null>

Parameters:

Returns:

Promise<AgentFile \| null> -

getByName

Get a single agent by name

getByName(name: string): Promise<AgentFile | null>

Parameters:

Returns:

Promise<AgentFile \| null> -

getByTeamMemberId

Get a single agent by team member ID

getByTeamMemberId(teamMemberId: string): Promise<AgentFile | null>

Parameters:

Returns:

Promise<AgentFile \| null> -

writeAgentFile

Write an agent configuration to a JSON file

writeAgentFile(agent: AgentFile): Promise<void>

Parameters:

Returns:

Promise<void> -

updateAgentMetadata

Update agent file with new metadata

updateAgentMetadata(name: string, updates: Partial<import("/Users/sthornock/code/epic/epic-flowstate/packages/flowstate-cli/src/lib/agent-sync/types").AgentMetadata | undefined>): Promise<AgentFile | null>

Parameters:

Returns:

Promise<AgentFile \| null> -

getLinkedAgents

Get agents that have a teamMemberId configured

getLinkedAgents(): Promise<AgentFile[]>

Returns:

Promise<AgentFile[]> -

getUnlinkedAgents

Get agents that do NOT have a teamMemberId configured

getUnlinkedAgents(): Promise<AgentFile[]>

Returns:

Promise<AgentFile[]> -

AgentSyncManager

Manages two-way sync between local agent JSON files and TeamMember entities

Constructor

constructor(client: IRxDBClient<any>, scanner?: AgentScanner | undefined)

Parameters:

Methods

sync

Perform full bidirectional sync

sync(orgId: string, dryRun?: boolean, direction?: "bidirectional" | "local-to-remote" | "remote-to-local"): Promise<AgentSyncStats>

Parameters:

Returns:

Promise<AgentSyncStats> -

generateSummary

Generate a summary report

generateSummary(orgId: string, dryRun: boolean, direction?: "bidirectional" | "local-to-remote" | "remote-to-local"): Promise<string>

Parameters:

Returns:

Promise<string> -

generateJsonSummary

Generate JSON summary

generateJsonSummary(orgId: string, dryRun: boolean, direction?: "bidirectional" | "local-to-remote" | "remote-to-local"): Promise<AgentSyncSummaryJson>

Parameters:

Returns:

Promise<AgentSyncSummaryJson> -

DocumentStoreClient

Constructor

constructor(config: DocumentStoreClientConfig)

Parameters:

Methods

requestUpload

Request a presigned upload URL from the document-store service.

requestUpload(request: UploadRequest): Promise<UploadResponse>

Parameters:

Returns:

Promise<UploadResponse> - Promise resolving to upload response with presigned URL and document info

uploadContent

Upload content to a presigned S3 URL.

uploadContent(uploadUrl: string, content: string | Buffer<ArrayBufferLike>, contentType?: string): Promise<void>

Parameters:

Returns:

Promise<void> -

requestDownload

Request a presigned download URL for a document.

requestDownload(documentId: string): Promise<DownloadResponse>

Parameters:

Returns:

Promise<DownloadResponse> - Promise resolving to download response with presigned URL

healthCheck

Test connection to the document-store service. Uses the status endpoint which exists at /api/document-store/status. Includes auth token since endpoint is behind auth gateway.

healthCheck(): Promise<boolean>

Returns:

Promise<boolean> - Promise resolving to true if healthy, false otherwise

FileMetadataCollector

Methods

collect

Collect metadata for a single file or directory

collect(filePath: string, includeGitInfo?: boolean, includeContentHash?: boolean): Promise<FileMetadata>

Parameters:

Returns:

Promise<FileMetadata> -

FiletreeBuilder

Constructor

constructor(config: FiletreeGeneratorConfig)

Parameters:

Methods

build

Build filetree for a directory

build(rootPath: string): Promise<Filetree>

Parameters:

Returns:

Promise<Filetree> -

FiletreeGenerator

Constructor

constructor(db: RxDatabase, config: FiletreeGeneratorConfig)

Parameters:

Methods

generate

Generate and sync filetree

generate(rootPath: string, orgId: string, projectId?: string | undefined, workspaceId?: string | undefined, dryRun?: boolean): Promise<FiletreeSyncStats>

Parameters:

Returns:

Promise<FiletreeSyncStats> -

generateSummary

Generate markdown summary

generateSummary(rootPath: string, orgId: string, projectId?: string | undefined, workspaceId?: string | undefined, dryRun?: boolean): Promise<string>

Parameters:

Returns:

Promise<string> -

generateJsonSummary

Generate JSON summary

generateJsonSummary(rootPath: string, orgId: string, projectId?: string | undefined, workspaceId?: string | undefined, dryRun?: boolean): Promise<FiletreeSummaryJson>

Parameters:

Returns:

Promise<FiletreeSummaryJson> -

FiletreeSyncManager

Constructor

constructor(db: RxDatabase)

Parameters:

Methods

sync

Sync filetree to database as SteeringDocument

sync(filetree: Filetree, orgId: string, projectId?: string | undefined, workspaceId?: string | undefined, userId?: string | undefined, dryRun?: boolean): Promise<FiletreeSyncStats>

Parameters:

Returns:

Promise<FiletreeSyncStats> -

MappingManager

Constructor

constructor(config: MappingManagerConfig)

Parameters:

Methods

loadMappings

loadMappings(type: MappingType): Promise<MappingFile>

Parameters:

Returns:

Promise<MappingFile> -

saveMappings

saveMappings(type: MappingType, data: MappingFile): Promise<void>

Parameters:

Returns:

Promise<void> -

addMapping

addMapping(type: MappingType, key: string, value: any): Promise<void>

Parameters:

Returns:

Promise<void> -

getMapping

getMapping(type: MappingType, key: string): Promise<any>

Parameters:

Returns:

Promise<any> -

removeMapping

removeMapping(type: MappingType, key: string): Promise<void>

Parameters:

Returns:

Promise<void> -

findByFile

findByFile(filePath: string): Promise<any[]>

Parameters:

Returns:

Promise<any[]> -

findByTaskId

findByTaskId(taskId: string): Promise<KeyedMapping[]>

Parameters:

Returns:

Promise<KeyedMapping[]> -

findByDocumentId

findByDocumentId(documentId: string): Promise<KeyedMapping[]>