Skip to main content

roadmap

@codebolt/codeboltjs

Variable: roadmap

const roadmap: {
  createFeature: (phaseId: string, data: CreateFeatureData, projectPath?: string) => Promise<RoadmapFeatureResponse>;
  createIdea: (data: CreateIdeaData, projectPath?: string) => Promise<RoadmapIdeaResponse>;
  createPhase: (data: CreatePhaseData, projectPath?: string) => Promise<RoadmapPhaseResponse>;
  deleteFeature: (featureId: string, projectPath?: string) => Promise<RoadmapDeleteResponse>;
  deleteIdea: (ideaId: string, projectPath?: string) => Promise<RoadmapDeleteResponse>;
  deletePhase: (phaseId: string, projectPath?: string) => Promise<RoadmapDeleteResponse>;
  getAllFeatures: (projectPath?: string) => Promise<RoadmapFeaturesResponse>;
  getFeatures: (phaseId: string, projectPath?: string) => Promise<RoadmapFeaturesResponse>;
  getIdeas: (projectPath?: string) => Promise<RoadmapIdeasResponse>;
  getPhases: (projectPath?: string) => Promise<RoadmapPhasesResponse>;
  getRoadmap: (projectPath?: string) => Promise<RoadmapGetResponse>;
  moveFeature: (featureId: string, data: MoveFeatureData, projectPath?: string) => Promise<RoadmapFeatureResponse>;
  moveIdeaToRoadmap: (ideaId: string, data: MoveIdeaToRoadmapData, projectPath?: string) => Promise<RoadmapMoveToRoadmapResponse>;
  reviewIdea: (ideaId: string, data: ReviewIdeaData, projectPath?: string) => Promise<RoadmapIdeaResponse>;
  updateFeature: (featureId: string, data: UpdateFeatureData, projectPath?: string) => Promise<RoadmapFeatureResponse>;
  updateIdea: (ideaId: string, data: UpdateIdeaData, projectPath?: string) => Promise<RoadmapIdeaResponse>;
  updatePhase: (phaseId: string, data: UpdatePhaseData, projectPath?: string) => Promise<RoadmapPhaseResponse>;
};

Defined in: packages/codeboltjs/src/modules/roadmap.ts:29

Roadmap Module for codeboltjs Provides functionality for managing project roadmaps, phases, features, and ideas. Mirrors the roadmapService.cli.ts operations via WebSocket.

Type Declaration​

NameTypeDescriptionDefined in
createFeature()(phaseId: string, data: CreateFeatureData, projectPath?: string) => Promise<RoadmapFeatureResponse>Create a new feature in a phasepackages/codeboltjs/src/modules/roadmap.ts:158
createIdea()(data: CreateIdeaData, projectPath?: string) => Promise<RoadmapIdeaResponse>Create a new ideapackages/codeboltjs/src/modules/roadmap.ts:242
createPhase()(data: CreatePhaseData, projectPath?: string) => Promise<RoadmapPhaseResponse>Create a new phase in the roadmappackages/codeboltjs/src/modules/roadmap.ts:74
deleteFeature()(featureId: string, projectPath?: string) => Promise<RoadmapDeleteResponse>Delete a featurepackages/codeboltjs/src/modules/roadmap.ts:190
deleteIdea()(ideaId: string, projectPath?: string) => Promise<RoadmapDeleteResponse>Delete an ideapackages/codeboltjs/src/modules/roadmap.ts:274
deletePhase()(phaseId: string, projectPath?: string) => Promise<RoadmapDeleteResponse>Delete a phase from the roadmappackages/codeboltjs/src/modules/roadmap.ts:106
getAllFeatures()(projectPath?: string) => Promise<RoadmapFeaturesResponse>Get all features across all phasespackages/codeboltjs/src/modules/roadmap.ts:142
getFeatures()(phaseId: string, projectPath?: string) => Promise<RoadmapFeaturesResponse>Get features in a specific phasepackages/codeboltjs/src/modules/roadmap.ts:126
getIdeas()(projectPath?: string) => Promise<RoadmapIdeasResponse>Get all ideas (pre-roadmap suggestions)packages/codeboltjs/src/modules/roadmap.ts:226
getPhases()(projectPath?: string) => Promise<RoadmapPhasesResponse>Get all phases in the roadmappackages/codeboltjs/src/modules/roadmap.ts:58
getRoadmap()(projectPath?: string) => Promise<RoadmapGetResponse>Get the complete roadmap for a projectpackages/codeboltjs/src/modules/roadmap.ts:38
moveFeature()(featureId: string, data: MoveFeatureData, projectPath?: string) => Promise<RoadmapFeatureResponse>Move a feature to a different phasepackages/codeboltjs/src/modules/roadmap.ts:206
moveIdeaToRoadmap()(ideaId: string, data: MoveIdeaToRoadmapData, projectPath?: string) => Promise<RoadmapMoveToRoadmapResponse>Move an accepted idea to the roadmap as a featurepackages/codeboltjs/src/modules/roadmap.ts:306
reviewIdea()(ideaId: string, data: ReviewIdeaData, projectPath?: string) => Promise<RoadmapIdeaResponse>Review an idea (accept or reject)packages/codeboltjs/src/modules/roadmap.ts:290
updateFeature()(featureId: string, data: UpdateFeatureData, projectPath?: string) => Promise<RoadmapFeatureResponse>Update an existing featurepackages/codeboltjs/src/modules/roadmap.ts:174
updateIdea()(ideaId: string, data: UpdateIdeaData, projectPath?: string) => Promise<RoadmapIdeaResponse>Update an existing ideapackages/codeboltjs/src/modules/roadmap.ts:258
updatePhase()(phaseId: string, data: UpdatePhaseData, projectPath?: string) => Promise<RoadmapPhaseResponse>Update an existing phasepackages/codeboltjs/src/modules/roadmap.ts:90