ToolJet/server/src/modules/plugins/controller.ts
Ganesh Kumar 04bc740d95
Feat: Auto install plugin based on queries on app import (#12350)
* dependent plugins will be auto imported on App import

* added error handling

* added error handling for edge cases

* API permissions are updated
2025-04-03 12:02:39 +05:30

93 lines
3 KiB
TypeScript

import {
Controller,
Get,
Post,
Body,
Patch,
Param,
Delete,
UseInterceptors,
ClassSerializerInterceptor,
UseGuards,
} from '@nestjs/common';
import { decode } from 'js-base64';
import { JwtAuthGuard } from '@modules/session/guards/jwt-auth.guard';
import { User } from '@modules/app/decorators/user.decorator';
import { InitModule } from '@modules/app/decorators/init-module';
import { MODULES } from '@modules/app/constants/modules';
import { FeatureAbilityGuard } from './ability/guard';
import { PluginsService } from './service';
import { CreatePluginDto, UpdatePluginDto } from './dto';
import { InitFeature } from '@modules/app/decorators/init-feature.decorator';
import { FEATURE_KEY } from './constants';
import { IPluginsController } from './interfaces/IController';
@Controller('plugins')
@UseInterceptors(ClassSerializerInterceptor)
@InitModule(MODULES.PLUGINS)
@UseGuards(JwtAuthGuard, FeatureAbilityGuard)
export class PluginsController implements IPluginsController {
constructor(protected readonly pluginsService: PluginsService) {}
@Post('install')
@InitFeature(FEATURE_KEY.INSTALL)
async install(@Body() createPluginDto: CreatePluginDto) {
return this.pluginsService.install(createPluginDto);
}
@Get()
@InitFeature(FEATURE_KEY.GET)
async findAll() {
const plugins = await this.pluginsService.findAll();
return plugins.map((plugin) => {
plugin.iconFile.data = plugin.iconFile.data.toString('utf8');
plugin.manifestFile.data = JSON.parse(decode(plugin.manifestFile.data.toString('utf8')));
return plugin;
});
}
@Get(':id')
@InitFeature(FEATURE_KEY.GET_ONE)
findOne(@Param('id') id: string) {
return this.pluginsService.findOne(id);
}
@Patch(':id')
@InitFeature(FEATURE_KEY.UPDATE)
async update(@User() user, @Param('id') id: string, @Body() updatePluginDto: UpdatePluginDto) {
return this.pluginsService.update(id, updatePluginDto);
}
@Delete(':id')
@InitFeature(FEATURE_KEY.DELETE)
async remove(@User() user, @Param('id') id: string) {
return this.pluginsService.remove(id);
}
@Post(':id/reload')
@InitFeature(FEATURE_KEY.RELOAD)
async reload(@Param('id') id: string) {
return this.pluginsService.reload(id);
}
@Post('findDependentPlugins')
@InitFeature(FEATURE_KEY.DEPENDENT_PLUGINS)
async findDependentPluginsToBeInstalledFromDataSources(@Body() dataSources) {
return this.pluginsService.checkIfPluginsToBeInstalled(dataSources);
}
@Post('installDependentPlugins')
@InitFeature(FEATURE_KEY.INSTALL_DEPENDENT_PLUGINS)
async installDependentPlugins(
@Body('dependentPlugins') dependentPlugins,
@Body('shouldAutoImportPlugin') shouldAutoImportPlugin
) {
return this.pluginsService.autoInstallPluginsForTemplates(dependentPlugins, shouldAutoImportPlugin);
}
@Post('uninstallPlugins')
@InitFeature(FEATURE_KEY.UNINSTALL_PLUGINS)
async uninstallPlugins(@Body('pluginsId') pluginsId) {
return this.pluginsService.uninstallPlugins(pluginsId);
}
}