ProjectStructureSocket
Class: ProjectStructureSocket
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:10
Project Structure WebSocket - Manage project metadata, packages, routes, tables, dependencies, commands, UI routes, deployments, git, design guidelines, frontend framework. Type-based protocol with ~25 message types.
Extends
TypedEventEmitter<ProjectStructureSocketEvents>
Constructors
Constructor
new ProjectStructureSocket(connectionManager: SocketConnectionManager, socketName: string): ProjectStructureSocket;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:13
Parameters
| Parameter | Type | Default value |
|---|---|---|
connectionManager | SocketConnectionManager | undefined |
socketName | string | 'projectStructure' |
Returns
ProjectStructureSocket
Overrides
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
emit()
emit<K>(event: K, ...args: Parameters<ProjectStructureSocketEvents[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<ProjectStructureSocketEvents[K]> |
Returns
boolean
Inherited from
getCommands()
getCommands(projectPath: string, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:102
Parameters
| Parameter | Type |
|---|---|
projectPath | string |
requestId? | string |
Returns
void
getDependencies()
getDependencies(projectPath: string, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:90
Parameters
| Parameter | Type |
|---|---|
projectPath | string |
requestId? | string |
Returns
void
getDeployments()
getDeployments(projectPath: string, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:122
Parameters
| Parameter | Type |
|---|---|
projectPath | string |
requestId? | string |
Returns
void
getDesignGuidelines()
getDesignGuidelines(projectPath: string, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:146
Parameters
| Parameter | Type |
|---|---|
projectPath | string |
requestId? | string |
Returns
void
getFrontendFramework()
getFrontendFramework(projectPath: string, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:162
Parameters
| Parameter | Type |
|---|---|
projectPath | string |
requestId? | string |
Returns
void
getGit()
getGit(projectPath: string, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:138
Parameters
| Parameter | Type |
|---|---|
projectPath | string |
requestId? | string |
Returns
void
getMetadata()
getMetadata(projectPath: string, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:58
Parameters
| Parameter | Type |
|---|---|
projectPath | string |
requestId? | string |
Returns
void
getPackages()
getPackages(projectPath: string, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:66
Parameters
| Parameter | Type |
|---|---|
projectPath | string |
requestId? | string |
Returns
void
getRoutes()
getRoutes(projectPath: string, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:74
Parameters
| Parameter | Type |
|---|---|
projectPath | string |
requestId? | string |
Returns
void
getTables()
getTables(projectPath: string, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:82
Parameters
| Parameter | Type |
|---|---|
projectPath | string |
requestId? | string |
Returns
void
getUiRoutes()
getUiRoutes(projectPath: string, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:110
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
off()
off<K>(event: K, listener: ProjectStructureSocketEvents[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 | ProjectStructureSocketEvents[K] |
Returns
this
Inherited from
on()
on<K>(event: K, listener: ProjectStructureSocketEvents[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 | ProjectStructureSocketEvents[K] |
Returns
this
Inherited from
once()
once<K>(event: K, listener: ProjectStructureSocketEvents[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 | ProjectStructureSocketEvents[K] |
Returns
this
Inherited from
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
updateCommands()
updateCommands(commands: unknown, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:105
Parameters
| Parameter | Type |
|---|---|
commands | unknown |
requestId? | string |
Returns
void
updateDependencies()
updateDependencies(deps: unknown, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:97
Parameters
| Parameter | Type |
|---|---|
deps | unknown |
requestId? | string |
Returns
void
updateDeployments()
updateDeployments(deployments: unknown, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:129
Parameters
| Parameter | Type |
|---|---|
deployments | unknown |
requestId? | string |
Returns
void
updateDesignGuidelines()
updateDesignGuidelines(guidelines: unknown, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:153
Parameters
| Parameter | Type |
|---|---|
guidelines | unknown |
requestId? | string |
Returns
void
updateFrontendFramework()
updateFrontendFramework(framework: unknown, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:169
Parameters
| Parameter | Type |
|---|---|
framework | unknown |
requestId? | string |
Returns
void
updateGit()
updateGit(git: unknown, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:141
Parameters
| Parameter | Type |
|---|---|
git | unknown |
requestId? | string |
Returns
void
updateMetadata()
updateMetadata(metadata: unknown, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:61
Parameters
| Parameter | Type |
|---|---|
metadata | unknown |
requestId? | string |
Returns
void
updatePackages()
updatePackages(packages: unknown, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:69
Parameters
| Parameter | Type |
|---|---|
packages | unknown |
requestId? | string |
Returns
void
updateRoutes()
updateRoutes(routes: unknown, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:77
Parameters
| Parameter | Type |
|---|---|
routes | unknown |
requestId? | string |
Returns
void
updateSection()
updateSection(
section: string,
data: unknown,
requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:178
Parameters
| Parameter | Type |
|---|---|
section | string |
data | unknown |
requestId? | string |
Returns
void
updateTables()
updateTables(tables: unknown, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:85
Parameters
| Parameter | Type |
|---|---|
tables | unknown |
requestId? | string |
Returns
void
updateUiRoutes()
updateUiRoutes(uiRoutes: unknown, requestId?: string): void;
Defined in: CodeBolt/packages/pluginSdk/src/sockets/project-structure.socket.ts:117
Parameters
| Parameter | Type |
|---|---|
uiRoutes | unknown |
requestId? | string |
Returns
void