projectStructure
Variable: projectStructure
const projectStructure: {
addCommand: (packageId: string, command: Omit<RunCommand, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>;
addDependency: (packageId: string, dependency: Omit<Dependency, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>;
addDeployment: (packageId: string, config: Omit<DeploymentConfig, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>;
addRoute: (packageId: string, route: Omit<ApiRoute, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>;
addTable: (packageId: string, table: Omit<DatabaseTable, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>;
addUiRoute: (packageId: string, route: Omit<UiRoute, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>;
createPackage: (data: CreatePackageData, workspacePath?: string) => Promise<ProjectStructurePackageResponse>;
deleteCommand: (packageId: string, commandId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse>;
deleteDependency: (packageId: string, dependencyId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse>;
deleteDeployment: (packageId: string, configId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse>;
deletePackage: (packageId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse>;
deleteRoute: (packageId: string, routeId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse>;
deleteTable: (packageId: string, tableId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse>;
deleteUiRoute: (packageId: string, routeId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse>;
getMetadata: (workspacePath?: string) => Promise<ProjectStructureMetadataResponse>;
getPackage: (packageId: string, workspacePath?: string) => Promise<ProjectStructurePackageResponse>;
getPackages: (workspacePath?: string) => Promise<ProjectStructurePackagesResponse>;
updateCommand: (packageId: string, commandId: string, updates: Partial<RunCommand>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>;
updateDependency: (packageId: string, dependencyId: string, updates: Partial<Dependency>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>;
updateDeployment: (packageId: string, configId: string, updates: Partial<DeploymentConfig>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>;
updateDesignGuidelines: (packageId: string, guidelines: DesignGuidelines, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>;
updateFrontendFramework: (packageId: string, framework: FrameworkInfo, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>;
updateGit: (gitInfo: GitInfo, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>;
updateMetadata: (updates: Record<string, any>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>;
updatePackage: (packageId: string, updates: UpdatePackageData, workspacePath?: string) => Promise<ProjectStructurePackageResponse>;
updateRoute: (packageId: string, routeId: string, updates: Partial<ApiRoute>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>;
updateSection: (packageId: string, section: string, sectionData: any, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>;
updateTable: (packageId: string, tableId: string, updates: Partial<DatabaseTable>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>;
updateUiRoute: (packageId: string, routeId: string, updates: Partial<UiRoute>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse>;
};
Defined in: packages/codeboltjs/src/modules/projectStructure.ts:28
Project Structure Module for codeboltjs Provides functionality for managing project metadata, packages, routes, dependencies, etc. Mirrors the projectStructureService.cli.ts operations via WebSocket.
Type Declaration
| Name | Type | Description | Defined in |
|---|---|---|---|
addCommand() | (packageId: string, command: Omit<RunCommand, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | Add a run command to a package | packages/codeboltjs/src/modules/projectStructure.ts:312 |
addDependency() | (packageId: string, dependency: Omit<Dependency, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | Add a dependency to a package | packages/codeboltjs/src/modules/projectStructure.ts:260 |
addDeployment() | (packageId: string, config: Omit<DeploymentConfig, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | Add a deployment config to a package | packages/codeboltjs/src/modules/projectStructure.ts:416 |
addRoute() | (packageId: string, route: Omit<ApiRoute, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | Add an API route to a package | packages/codeboltjs/src/modules/projectStructure.ts:156 |
addTable() | (packageId: string, table: Omit<DatabaseTable, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | Add a database table to a package | packages/codeboltjs/src/modules/projectStructure.ts:208 |
addUiRoute() | (packageId: string, route: Omit<UiRoute, "id">, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | Add a UI route to a package | packages/codeboltjs/src/modules/projectStructure.ts:364 |
createPackage() | (data: CreatePackageData, workspacePath?: string) => Promise<ProjectStructurePackageResponse> | Create a new package | packages/codeboltjs/src/modules/projectStructure.ts:104 |
deleteCommand() | (packageId: string, commandId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | Delete a run command | packages/codeboltjs/src/modules/projectStructure.ts:344 |
deleteDependency() | (packageId: string, dependencyId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | Delete a dependency | packages/codeboltjs/src/modules/projectStructure.ts:292 |
deleteDeployment() | (packageId: string, configId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | Delete a deployment config | packages/codeboltjs/src/modules/projectStructure.ts:448 |
deletePackage() | (packageId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | Delete a package | packages/codeboltjs/src/modules/projectStructure.ts:136 |
deleteRoute() | (packageId: string, routeId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | Delete an API route | packages/codeboltjs/src/modules/projectStructure.ts:188 |
deleteTable() | (packageId: string, tableId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | Delete a database table | packages/codeboltjs/src/modules/projectStructure.ts:240 |
deleteUiRoute() | (packageId: string, routeId: string, workspacePath?: string) => Promise<ProjectStructureDeleteResponse> | Delete a UI route | packages/codeboltjs/src/modules/projectStructure.ts:396 |
getMetadata() | (workspacePath?: string) => Promise<ProjectStructureMetadataResponse> | Get complete project metadata | packages/codeboltjs/src/modules/projectStructure.ts:36 |
getPackage() | (packageId: string, workspacePath?: string) => Promise<ProjectStructurePackageResponse> | Get a specific package by ID | packages/codeboltjs/src/modules/projectStructure.ts:88 |
getPackages() | (workspacePath?: string) => Promise<ProjectStructurePackagesResponse> | Get all packages in the workspace | packages/codeboltjs/src/modules/projectStructure.ts:72 |
updateCommand() | (packageId: string, commandId: string, updates: Partial<RunCommand>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | Update a run command | packages/codeboltjs/src/modules/projectStructure.ts:328 |
updateDependency() | (packageId: string, dependencyId: string, updates: Partial<Dependency>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | Update a dependency | packages/codeboltjs/src/modules/projectStructure.ts:276 |
updateDeployment() | (packageId: string, configId: string, updates: Partial<DeploymentConfig>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | Update a deployment config | packages/codeboltjs/src/modules/projectStructure.ts:432 |
updateDesignGuidelines() | (packageId: string, guidelines: DesignGuidelines, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | Update design guidelines for a package | packages/codeboltjs/src/modules/projectStructure.ts:484 |
updateFrontendFramework() | (packageId: string, framework: FrameworkInfo, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | Update frontend framework for a package | packages/codeboltjs/src/modules/projectStructure.ts:500 |
updateGit() | (gitInfo: GitInfo, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | Update git information | packages/codeboltjs/src/modules/projectStructure.ts:468 |
updateMetadata() | (updates: Record<string, any>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | Update workspace metadata | packages/codeboltjs/src/modules/projectStructure.ts:52 |
updatePackage() | (packageId: string, updates: UpdatePackageData, workspacePath?: string) => Promise<ProjectStructurePackageResponse> | Update a package | packages/codeboltjs/src/modules/projectStructure.ts:120 |
updateRoute() | (packageId: string, routeId: string, updates: Partial<ApiRoute>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | Update an API route | packages/codeboltjs/src/modules/projectStructure.ts:172 |
updateSection() | (packageId: string, section: string, sectionData: any, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | Update a specific section of a package | packages/codeboltjs/src/modules/projectStructure.ts:516 |
updateTable() | (packageId: string, tableId: string, updates: Partial<DatabaseTable>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | Update a database table | packages/codeboltjs/src/modules/projectStructure.ts:224 |
updateUiRoute() | (packageId: string, routeId: string, updates: Partial<UiRoute>, workspacePath?: string) => Promise<ProjectStructureUpdateResponse> | Update a UI route | packages/codeboltjs/src/modules/projectStructure.ts:380 |