Skip to main content

ReviewMergeSocket

@codebolt/plugin-sdk


Class: ReviewMergeSocket

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:10

Review/Merge Request WebSocket - Manage merge requests, reviews, pheromones, locks, and proposed jobs. Action-based protocol with ~25 actions.

Extends​

Constructors​

Constructor​

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

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:13

Parameters​

ParameterTypeDefault value
connectionManagerSocketConnectionManagerundefined
socketNamestring'reviewMergeRequest'

Returns​

ReviewMergeSocket

Overrides​

TypedEventEmitter.constructor

Properties​

PropertyModifierTypeInherited fromDefined in
listenersprotectedMap<string | symbol, Set<(...args: any[]) => void>>TypedEventEmitter.listenersCodeBolt/packages/pluginSdk/src/core/event-emitter.ts:24

Methods​

addLinkedJob()​

addLinkedJob(mergeRequestId: string, jobId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:82

Parameters​

ParameterType
mergeRequestIdstring
jobIdstring

Returns​

void


addReview()​

addReview(mergeRequestId: string, review: AddReviewFeedbackRequest): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:71

Parameters​

ParameterType
mergeRequestIdstring
reviewAddReviewFeedbackRequest

Returns​

void


addUnlockRequest()​

addUnlockRequest(request: CreateUnlockRequest): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:130

Parameters​

ParameterType
requestCreateUnlockRequest

Returns​

void


approveProposedJob()​

approveProposedJob(proposalId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:144

Parameters​

ParameterType
proposalIdstring

Returns​

void


approveUnlockRequest()​

approveUnlockRequest(requestId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:133

Parameters​

ParameterType
requestIdstring

Returns​

void


byAgent()​

byAgent(agentId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:96

Parameters​

ParameterType
agentIdstring

Returns​

void


bySwarm()​

bySwarm(swarmId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:99

Parameters​

ParameterType
swarmIdstring

Returns​

void


convertProposedJob()​

convertProposedJob(proposalId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:150

Parameters​

ParameterType
proposalIdstring

Returns​

void


create()​

create(data: CreateReviewMergeRequest): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:60

Parameters​

ParameterType
dataCreateReviewMergeRequest

Returns​

void


delete()​

delete(id: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:66

Parameters​

ParameterType
idstring

Returns​

void


depositPheromone()​

depositPheromone(pheromone: AddPheromoneRequest): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:113

Parameters​

ParameterType
pheromoneAddPheromoneRequest

Returns​

void


emit()​

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

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

Type Parameters​

Type Parameter
K extends string

Parameters​

ParameterType
eventK
...argsParameters<ReviewMergeSocketEvents[K]>

Returns​

boolean

Inherited from​

TypedEventEmitter.emit


get()​

get(id: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:57

Parameters​

ParameterType
idstring

Returns​

void


getPheromonesAggregated()​

getPheromonesAggregated(filter?: unknown): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:110

Parameters​

ParameterType
filter?unknown

Returns​

void


getPheromoneTypes()​

getPheromoneTypes(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:107

Returns​

void


isLocked()​

isLocked(resourceId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:127

Parameters​

ParameterType
resourceIdstring

Returns​

void


list()​

list(filter?: unknown): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:54

Parameters​

ParameterType
filter?unknown

Returns​

void


listenerCount()​

listenerCount(event: string): number;

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

Parameters​

ParameterType
eventstring

Returns​

number

Inherited from​

TypedEventEmitter.listenerCount


lock()​

lock(resourceId: string, lockData?: LockReviewRequest): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:121

Parameters​

ParameterType
resourceIdstring
lockData?LockReviewRequest

Returns​

void


merge()​

merge(id: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:77

Parameters​

ParameterType
idstring

Returns​

void


off()​

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

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

Type Parameters​

Type Parameter
K extends string

Parameters​

ParameterType
eventK
listenerReviewMergeSocketEvents[K]

Returns​

this

Inherited from​

TypedEventEmitter.off


on()​

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

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

Type Parameters​

Type Parameter
K extends string

Parameters​

ParameterType
eventK
listenerReviewMergeSocketEvents[K]

Returns​

this

Inherited from​

TypedEventEmitter.on


once()​

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

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

Type Parameters​

Type Parameter
K extends string

Parameters​

ParameterType
eventK
listenerReviewMergeSocketEvents[K]

Returns​

this

Inherited from​

TypedEventEmitter.once


pending()​

pending(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:90

Returns​

void


proposeJob()​

proposeJob(proposal: AddProposedJobRequest): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:141

Parameters​

ParameterType
proposalAddProposedJobRequest

Returns​

void


readyToMerge()​

readyToMerge(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:93

Returns​

void


rejectProposedJob()​

rejectProposedJob(proposalId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:147

Parameters​

ParameterType
proposalIdstring

Returns​

void


rejectUnlockRequest()​

rejectUnlockRequest(requestId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:136

Parameters​

ParameterType
requestIdstring

Returns​

void


removeAllListeners()​

removeAllListeners(event?: string): this;

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

Parameters​

ParameterType
event?string

Returns​

this

Inherited from​

TypedEventEmitter.removeAllListeners


removeLinkedJob()​

removeLinkedJob(mergeRequestId: string, jobId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:85

Parameters​

ParameterType
mergeRequestIdstring
jobIdstring

Returns​

void


removePheromone()​

removePheromone(pheromoneId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:116

Parameters​

ParameterType
pheromoneIdstring

Returns​

void


statistics()​

statistics(): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:102

Returns​

void


unlock()​

unlock(resourceId: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:124

Parameters​

ParameterType
resourceIdstring

Returns​

void


update()​

update(id: string, data: UpdateReviewMergeRequest): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:63

Parameters​

ParameterType
idstring
dataUpdateReviewMergeRequest

Returns​

void


updateStatus()​

updateStatus(id: string, status: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/review-merge.socket.ts:74

Parameters​

ParameterType
idstring
statusstring

Returns​

void