reorganize plugin management code

Author: pujitm

api/src/unraid-api/cli/plugins/dependency.service.ts renamed to api/src/unraid-api/app/dependency.service.ts

@@ -1,12 +1,10 @@
 import { Injectable } from '@nestjs/common';
-import * as fs from 'fs/promises';
 import * as path from 'path';
 
-import type { PackageJson } from 'type-fest';
 import { execa } from 'execa';
 
 import { fileExists } from '@app/core/utils/files/file-exists.js';
-import { getPackageJson, getPackageJsonPath } from '@app/environment.js';
+import { getPackageJsonPath } from '@app/environment.js';
 
 @Injectable()
 export class DependencyService {
@@ -25,26 +23,6 @@ export class DependencyService {
         });
     }
 
-    /**
-     * Installs plugins using npm.
-     *
-     * @param plugins - The plugins to install.
-     * @returns The execa result of the npm command.
-     */
-    installPlugins(...plugins: string[]) {
-        return this.npm('i', '--save-peer', '--save-exact', ...plugins);
-    }
-
-    /**
-     * Uninstalls plugins using npm.
-     *
-     * @param plugins - The plugins to uninstall.
-     * @returns The execa result of the npm command.
-     */
-    uninstallPlugins(...plugins: string[]) {
-        return this.npm('uninstall', ...plugins);
-    }
-
     /**
      * Installs dependencies for the api using npm.
      *

api/src/unraid-api/cli/cli.module.ts

@@ -1,5 +1,6 @@
 import { Module } from '@nestjs/common';
 
+import { DependencyService } from '@app/unraid-api/app/dependency.service.js';
 import { ApiKeyService } from '@app/unraid-api/auth/api-key.service.js';
 import { SsoUserService } from '@app/unraid-api/auth/sso-user.service.js';
 import { AddApiKeyQuestionSet } from '@app/unraid-api/cli/apikey/add-api-key.questions.js';
@@ -10,7 +11,12 @@ import { DeveloperCommand } from '@app/unraid-api/cli/developer/developer.comman
 import { DeveloperQuestions } from '@app/unraid-api/cli/developer/developer.questions.js';
 import { LogService } from '@app/unraid-api/cli/log.service.js';
 import { LogsCommand } from '@app/unraid-api/cli/logs.command.js';
-import { moduleResources, PluginCommandModule } from '@app/unraid-api/cli/plugins/plugin.cli.module.js';
+import {
+    InstallPluginCommand,
+    ListPluginCommand,
+    PluginCommand,
+    RemovePluginCommand,
+} from '@app/unraid-api/cli/plugins/plugin.command.js';
 import { PM2Service } from '@app/unraid-api/cli/pm2.service.js';
 import { ReportCommand } from '@app/unraid-api/cli/report.command.js';
 import { RestartCommand } from '@app/unraid-api/cli/restart.command.js';
@@ -30,26 +36,30 @@ import { ApiConfigModule } from '@app/unraid-api/config/api-config.module.js';
 import { LegacyConfigModule } from '@app/unraid-api/config/legacy-config.module.js';
 import { PluginCliModule } from '@app/unraid-api/plugin/plugin.module.js';
 
-// cli - plugin add/remove
-// plugin generator
-
 const DEFAULT_COMMANDS = [
     ApiKeyCommand,
     ConfigCommand,
     DeveloperCommand,
     LogsCommand,
     ReportCommand,
+    VersionCommand,
+    // Lifecycle commands
+    SwitchEnvCommand,
     RestartCommand,
     StartCommand,
     StatusCommand,
     StopCommand,
-    SwitchEnvCommand,
-    VersionCommand,
+    // SSO commands
     SSOCommand,
     ValidateTokenCommand,
     AddSSOUserCommand,
     RemoveSSOUserCommand,
     ListSSOUserCommand,
+    // Plugin commands
+    PluginCommand,
+    ListPluginCommand,
+    InstallPluginCommand,
+    RemovePluginCommand,
 ] as const;
 
 const DEFAULT_PROVIDERS = [
@@ -62,10 +72,11 @@ const DEFAULT_PROVIDERS = [
     PM2Service,
     ApiKeyService,
     SsoUserService,
+    DependencyService,
 ] as const;
 
 @Module({
     imports: [LegacyConfigModule, ApiConfigModule, PluginCliModule.register()],
-    providers: [...DEFAULT_COMMANDS, ...DEFAULT_PROVIDERS, ...moduleResources],
+    providers: [...DEFAULT_COMMANDS, ...DEFAULT_PROVIDERS],
 })
 export class CliModule {}

api/src/unraid-api/cli/plugins/plugin.cli.module.ts

@@ -3,7 +3,7 @@ import { ConfigService } from '@nestjs/config';
 
 import { ApiConfig } from '@unraid/shared/services/api-config.js';
 
-import { DependencyService } from '@app/unraid-api/cli/plugins/dependency.service.js';
+import { DependencyService } from '@app/unraid-api/app/dependency.service.js';
 import { persistApiConfig } from '@app/unraid-api/config/api-config.module.js';
 
 @Injectable()
@@ -20,14 +20,14 @@ export class PluginManagementService {
     async addPlugin(...plugins: string[]) {
         const added = this.addPluginToConfig(...plugins);
         await this.persistConfig();
-        await this.dependencyService.installPlugins(...added);
+        await this.installPlugins(...added);
         await this.dependencyService.rebuildVendorArchive();
     }
 
     async removePlugin(...plugins: string[]) {
         const removed = this.removePluginFromConfig(...plugins);
         await this.persistConfig();
-        await this.dependencyService.uninstallPlugins(...removed);
+        await this.uninstallPlugins(...removed);
         await this.dependencyService.rebuildVendorArchive();
     }
 
@@ -66,6 +66,26 @@ export class PluginManagementService {
         return removed;
     }
 
+    /**
+     * Installs plugins using npm.
+     *
+     * @param plugins - The plugins to install.
+     * @returns The execa result of the npm command.
+     */
+    private installPlugins(...plugins: string[]) {
+        return this.dependencyService.npm('i', '--save-peer', '--save-exact', ...plugins);
+    }
+
+    /**
+     * Uninstalls plugins using npm.
+     *
+     * @param plugins - The plugins to uninstall.
+     * @returns The execa result of the npm command.
+     */
+    private uninstallPlugins(...plugins: string[]) {
+        return this.dependencyService.npm('uninstall', ...plugins);
+    }
+
     /**------------------------------------------------------------------------
      *                           Bundled Plugins
      * Plugins that are not published to npm, but vendored as tarballs in the

api/src/unraid-api/plugin/plugin-management.service.ts

@@ -1,6 +1,6 @@
 import { DynamicModule, Logger, Module } from '@nestjs/common';
 
-import { DependencyService } from '@app/unraid-api/cli/plugins/dependency.service.js';
+import { DependencyService } from '@app/unraid-api/app/dependency.service.js';
 import { ResolversModule } from '@app/unraid-api/graph/resolvers/resolvers.module.js';
 import { GlobalDepsModule } from '@app/unraid-api/plugin/global-deps.module.js';
 import { PluginManagementService } from '@app/unraid-api/plugin/plugin-management.service.js';