RoadmapSocket

@codebolt/plugin-sdk

---

Class: RoadmapSocket

Defined in: CodeBolt/packages/pluginSdk/src/sockets/roadmap.socket.ts:10

Roadmap WebSocket - Manage roadmap phases, features, and ideas. Type-based protocol: send { type, data, requestId }, receive { type:response, ... }.

Extends

• TypedEventEmitter<RoadmapSocketEvents>

Constructors

Constructor

new RoadmapSocket(connectionManager: SocketConnectionManager, socketName: string): RoadmapSocket;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/roadmap.socket.ts:13

Parameters

Parameter	Type	Default value
connectionManager	SocketConnectionManager	undefined
socketName	string	'roadmap'

Returns

RoadmapSocket

Overrides

TypedEventEmitter.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
listeners	protected	Map<string | symbol, Set<(...args: any[]) => void>>	TypedEventEmitter.listeners	CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:24

Methods

createFeature()

createFeature(feature: CreateFeatureRequest & {
  phaseId: string;
}, requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/roadmap.socket.ts:74

Parameters

Parameter	Type
feature	CreateFeatureRequest & { phaseId: string; }
requestId?	string

Returns

void

---

createIdea()

createIdea(idea: CreateIdeaRequest, requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/roadmap.socket.ts:99

Parameters

Parameter	Type
idea	CreateIdeaRequest
requestId?	string

Returns

void

---

createPhase()

createPhase(phase: CreatePhaseRequest, requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/roadmap.socket.ts:63

Parameters

Parameter	Type
phase	CreatePhaseRequest
requestId?	string

Returns

void

---

deleteFeature()

deleteFeature(featureId: string, requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/roadmap.socket.ts:80

Parameters

Parameter	Type
featureId	string
requestId?	string

Returns

void

---

deleteIdea()

deleteIdea(ideaId: string, requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/roadmap.socket.ts:105

Parameters

Parameter	Type
ideaId	string
requestId?	string

Returns

void

---

deletePhase()

deletePhase(phaseId: string, requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/roadmap.socket.ts:69

Parameters

Parameter	Type
phaseId	string
requestId?	string

Returns

void

---

emit()

emit<K>(event: K, ...args: Parameters<RoadmapSocketEvents[K]>): boolean;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:54

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
...args	Parameters<RoadmapSocketEvents[K]>

Returns

boolean

Inherited from

TypedEventEmitter.emit

---

getIdeas()

getIdeas(filter?: unknown, requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/roadmap.socket.ts:96

Parameters

Parameter	Type
filter?	unknown
requestId?	string

Returns

void

---

getRoadmap()

getRoadmap(projectPath: string, requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/roadmap.socket.ts:58

Parameters

Parameter	Type
projectPath	string
requestId?	string

Returns

void

---

listenerCount()

listenerCount(event: string): number;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:75

Parameters

Parameter	Type
event	string

Returns

number

Inherited from

TypedEventEmitter.listenerCount

---

moveFeature()

moveFeature(
   featureId: string, 
   targetPhaseId: string, 
   requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/roadmap.socket.ts:83

Parameters

Parameter	Type
featureId	string
targetPhaseId	string
requestId?	string

Returns

void

---

moveIdeaToRoadmap()

moveIdeaToRoadmap(
   ideaId: string, 
   phaseId: string, 
   requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/roadmap.socket.ts:111

Parameters

Parameter	Type
ideaId	string
phaseId	string
requestId?	string

Returns

void

---

off()

off<K>(event: K, listener: RoadmapSocketEvents[K]): this;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:35

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
listener	RoadmapSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.off

---

on()

on<K>(event: K, listener: RoadmapSocketEvents[K]): this;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:27

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
listener	RoadmapSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.on

---

once()

once<K>(event: K, listener: RoadmapSocketEvents[K]): this;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:46

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
listener	RoadmapSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.once

---

removeAllListeners()

removeAllListeners(event?: string): this;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:66

Parameters

Parameter	Type
event?	string

Returns

this

Inherited from

TypedEventEmitter.removeAllListeners

---

reviewIdea()

reviewIdea(
   ideaId: string, 
   review: ReviewIdeaRequest, 
   requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/roadmap.socket.ts:108

Parameters

Parameter	Type
ideaId	string
review	ReviewIdeaRequest
requestId?	string

Returns

void

---

updateFeature()

updateFeature(feature: UpdateFeatureRequest & {
  featureId: string;
}, requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/roadmap.socket.ts:77

Parameters

Parameter	Type
feature	UpdateFeatureRequest & { featureId: string; }
requestId?	string

Returns

void

---

updateIdea()

updateIdea(idea: UpdateIdeaRequest & {
  ideaId: string;
}, requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/roadmap.socket.ts:102

Parameters

Parameter	Type
idea	UpdateIdeaRequest & { ideaId: string; }
requestId?	string

Returns

void

---

updatePhase()

updatePhase(phase: UpdatePhaseRequest & {
  phaseId: string;
}, requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/roadmap.socket.ts:66

Parameters

Parameter	Type
phase	UpdatePhaseRequest & { phaseId: string; }
requestId?	string

Returns

void