@wocker/ws 1.0.21 → 1.0.23

package/README.md

@@ -2,6 +2,14 @@
 
 ###### Docker workspace for web projects
 
+[![npm version](https://img.shields.io/npm/v/@wocker/ws.svg)](https://www.npmjs.com/package/@wocker/ws)
+[![Publish](https://github.com/kearisp/wocker-ws/actions/workflows/publish-latest.yml/badge.svg?event=release)](https://github.com/kearisp/wocker-ws/actions/workflows/publish-latest.yml)
+[![License](https://img.shields.io/npm/l/@wocker/ws)](https://github.com/kearisp/wocker-ws/blob/main/LICENSE)
+
+[![npm total downloads](https://img.shields.io/npm/dt/@wocker/ws.svg)](https://www.npmjs.com/package/@wocker/ws)
+[![bundle size](https://img.shields.io/bundlephobia/minzip/@wocker/ws)](https://bundlephobia.com/package/@wocker/ws)
+![Coverage](https://gist.githubusercontent.com/kearisp/f17f46c6332ea3bb043f27b0bddefa9f/raw/coverage-wocker-ws-latest.svg)
+
 ## Installation
 
 **Note:** It is recommended to install Wocker globally to ensure accessibility from any directory in your terminal.

package/lib/AppModule.js

@@ -1,76 +1,46 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
 var AppModule_1;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AppModule = void 0;
 const core_1 = require("@wocker/core");
 const controllers_1 = require("./controllers");
-const services_1 = require("./services");
-const plugins_1 = require("./plugins");
+const repositories_1 = require("./repositories");
+const AppConfigService_1 = require("./services/AppConfigService");
+const AppEventsService_1 = require("./services/AppEventsService");
+const PluginService_1 = require("./services/PluginService");
+const PresetService_1 = require("./services/PresetService");
+const ProjectService_1 = require("./services/ProjectService");
+const NpmService_1 = require("./services/NpmService");
+const LogService_1 = require("./services/LogService");
+const modules_1 = require("./modules");
 let AppModule = AppModule_1 = class AppModule {
     async load(container) {
-        const appConfigService = container.getModule(AppModule_1).get(services_1.AppConfigService);
-        const logService = container.getModule(AppModule_1).get(services_1.LogService);
-        const config = appConfigService.getConfig();
+        const appConfigService = container.getModule(AppModule_1).get(AppConfigService_1.AppConfigService);
+        const logService = container.getModule(AppModule_1).get(LogService_1.LogService);
+        const pluginService = container.getModule(AppModule_1).get(PluginService_1.PluginService);
         const imports = [];
-        for (const plugin of config.plugins || []) {
+        for (const pluginData of appConfigService.config.plugins || []) {
             try {
-                const { default: Plugin } = await Promise.resolve(`${plugin}`).then(s => __importStar(require(s)));
-                if (!Plugin) {
-                    continue;
-                }
-                const name = Reflect.getMetadata(core_1.PLUGIN_NAME_METADATA, Plugin);
+                const plugin = await pluginService.import(pluginData.name);
                 Reflect.defineMetadata(core_1.MODULE_METADATA.PROVIDERS, [
-                    ...Reflect.getMetadata(core_1.MODULE_METADATA.PROVIDERS, Plugin) || [],
+                    ...Reflect.getMetadata(core_1.MODULE_METADATA.PROVIDERS, plugin.type) || [],
                     {
                         provide: core_1.PLUGIN_DIR_KEY,
-                        useValue: name ? appConfigService.dataPath("plugins", name) : undefined
+                        useValue: appConfigService.dataPath("plugins", plugin.name)
                     }
-                ], Plugin);
-                imports.push(Plugin);
+                ], plugin.type);
+                imports.push(plugin.type);
             }
             catch (err) {
                 logService.error(err.message);
-                config.removePlugin(plugin);
-                await config.save();
+                appConfigService.config.removePlugin(pluginData.name);
+                appConfigService.save();
                 throw err;
             }
         }
@@ -83,38 +53,39 @@ exports.AppModule = AppModule;
 exports.AppModule = AppModule = AppModule_1 = __decorate([
     (0, core_1.Global)(),
     (0, core_1.Module)({
+        imports: [
+            modules_1.DockerModule,
+            modules_1.KeystoreModule,
+            modules_1.ProxyModule
+        ],
         controllers: [
             controllers_1.CompletionController,
-            controllers_1.DebugController,
-            controllers_1.ImageController,
-            controllers_1.PluginController,
-            controllers_1.PresetController,
             controllers_1.ProjectController,
-            controllers_1.ProxyController,
-            controllers_1.CertController
+            controllers_1.PresetController,
+            controllers_1.PluginController,
+            controllers_1.ExperimentalController,
+            controllers_1.DebugController
         ],
         providers: [
-            services_1.AppConfigService,
-            services_1.AppEventsService,
-            services_1.DockerService,
-            services_1.LogService,
-            services_1.NpmService,
-            services_1.PluginService,
-            services_1.PresetService,
-            services_1.ProjectService,
-            services_1.ProxyService,
-            services_1.CertService
+            AppConfigService_1.AppConfigService,
+            AppEventsService_1.AppEventsService,
+            LogService_1.LogService,
+            NpmService_1.NpmService,
+            ProjectService_1.ProjectService,
+            PluginService_1.PluginService,
+            PresetService_1.PresetService,
+            repositories_1.PresetRepository
         ],
         exports: [
-            services_1.AppConfigService,
-            services_1.AppEventsService,
-            services_1.DockerService,
-            services_1.LogService,
-            services_1.ProjectService,
-            services_1.ProxyService
-        ],
-        imports: [
-            plugins_1.ElasticSearchPlugin,
+            AppConfigService_1.AppConfigService,
+            AppEventsService_1.AppEventsService,
+            LogService_1.LogService,
+            modules_1.DockerService,
+            modules_1.CertService,
+            modules_1.ContainerService,
+            ProjectService_1.ProjectService,
+            modules_1.ProxyService,
+            modules_1.KeystoreService
         ]
     })
 ], AppModule);

package/lib/controllers/DebugController.d.ts

@@ -1,9 +1,11 @@
-import { AppConfigService, LogService } from "../services";
+import { AppConfigService } from "../services/AppConfigService";
+import { LogService } from "../services/LogService";
 export declare class DebugController {
     protected readonly appConfigService: AppConfigService;
     protected readonly logService: LogService;
     constructor(appConfigService: AppConfigService, logService: LogService);
-    debug(status: string): Promise<void>;
+    debug(): Promise<string>;
+    setDebug(status: string): Promise<void>;
     setLog(level: string): Promise<void>;
     testLog(level: string, args: string[]): Promise<void>;
     debugCompletion(): Promise<string[]>;

package/lib/controllers/DebugController.js

@@ -14,25 +14,27 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DebugController = void 0;
 const core_1 = require("@wocker/core");
-const services_1 = require("../services");
+const AppConfigService_1 = require("../services/AppConfigService");
+const LogService_1 = require("../services/LogService");
 let DebugController = class DebugController {
     constructor(appConfigService, logService) {
         this.appConfigService = appConfigService;
         this.logService = logService;
     }
-    async debug(status) {
-        const config = this.appConfigService.getConfig();
-        config.debug = status === "on";
-        await config.save();
+    async debug() {
+        return this.appConfigService.config.debug ? "on" : "off";
+    }
+    async setDebug(status) {
+        this.appConfigService.config.debug = status === "on";
+        this.appConfigService.save();
     }
     async setLog(level) {
         const validLevels = this.getLevels();
         if (!validLevels.includes(level)) {
             throw new Error(`Invalid log level: ${level}. Valid options are ${validLevels.join(', ')}`);
         }
-        const config = this.appConfigService.getConfig();
-        config.logLevel = level;
-        await config.save();
+        this.appConfigService.config.logLevel = level;
+        this.appConfigService.save();
     }
     async testLog(level, args) {
         this.logService._log(level, ...args);
@@ -45,6 +47,12 @@ let DebugController = class DebugController {
     }
 };
 exports.DebugController = DebugController;
+__decorate([
+    (0, core_1.Command)("debug"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], DebugController.prototype, "debug", null);
 __decorate([
     (0, core_1.Command)("debug:<status>"),
     (0, core_1.Command)("debug <status>"),
@@ -52,7 +60,7 @@ __decorate([
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [String]),
     __metadata("design:returntype", Promise)
-], DebugController.prototype, "debug", null);
+], DebugController.prototype, "setDebug", null);
 __decorate([
     (0, core_1.Description)("Set the log level (options: debug, log, info, warn, error)"),
     (0, core_1.Command)("loglevel <level>"),
@@ -83,6 +91,6 @@ __decorate([
 ], DebugController.prototype, "getLevels", null);
 exports.DebugController = DebugController = __decorate([
     (0, core_1.Controller)(),
-    __metadata("design:paramtypes", [services_1.AppConfigService,
-        services_1.LogService])
+    __metadata("design:paramtypes", [AppConfigService_1.AppConfigService,
+        LogService_1.LogService])
 ], DebugController);

package/lib/controllers/ExperimentalController.d.ts

@@ -0,0 +1,8 @@
+import { AppConfigService } from "../services/AppConfigService";
+export declare class ExperimentalController {
+    protected readonly appService: AppConfigService;
+    constructor(appService: AppConfigService);
+    enable(feature?: string): void;
+    disable(feature?: string): void;
+    getFeatures(): string[];
+}

package/lib/controllers/ExperimentalController.js

@@ -0,0 +1,77 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExperimentalController = void 0;
+const core_1 = require("@wocker/core");
+const AppConfigService_1 = require("../services/AppConfigService");
+let ExperimentalController = class ExperimentalController {
+    constructor(appService) {
+        this.appService = appService;
+    }
+    enable(feature) {
+        if (!feature) {
+            throw new core_1.UsageException("Feature name is required. Usage: wocker experimental:enable <feature-name>\n");
+        }
+        if (!this.appService.experimentalFeatures.includes(feature)) {
+            const availableFeatures = this.appService.experimentalFeatures.join(", ");
+            throw new core_1.UsageException(`Unknown experimental feature: "${feature}"\nAvailable features: ${availableFeatures}`);
+        }
+        this.appService.setMeta(`experimental.${feature}`, "enabled");
+        this.appService.save();
+    }
+    disable(feature) {
+        if (!feature) {
+            throw new core_1.UsageException("Feature name is required. Usage: wocker experimental:disable <feature-name>\n");
+        }
+        if (!this.appService.experimentalFeatures.includes(feature)) {
+            const availableFeatures = this.appService.experimentalFeatures.join(", ");
+            throw new core_1.UsageException(`Unknown experimental feature: "${feature}"\nAvailable features: ${availableFeatures}`);
+        }
+        this.appService.unsetMeta(`experimental.${feature}`);
+        this.appService.save();
+    }
+    getFeatures() {
+        return this.appService.experimentalFeatures;
+    }
+};
+exports.ExperimentalController = ExperimentalController;
+__decorate([
+    (0, core_1.Command)("experimental:enable [feature]"),
+    (0, core_1.Description)("Enable experimental features"),
+    __param(0, (0, core_1.Param)("feature")),
+    __param(0, (0, core_1.Description)("Name of the feature to enable")),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", void 0)
+], ExperimentalController.prototype, "enable", null);
+__decorate([
+    (0, core_1.Command)("experimental:disable [feature]"),
+    (0, core_1.Description)("Disable experimental features"),
+    __param(0, (0, core_1.Param)("feature")),
+    __param(0, (0, core_1.Description)("Name of the feature to disable")),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", void 0)
+], ExperimentalController.prototype, "disable", null);
+__decorate([
+    (0, core_1.Completion)("feature"),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Array)
+], ExperimentalController.prototype, "getFeatures", null);
+exports.ExperimentalController = ExperimentalController = __decorate([
+    (0, core_1.Controller)(),
+    (0, core_1.Description)("Manage experimental features"),
+    __metadata("design:paramtypes", [AppConfigService_1.AppConfigService])
+], ExperimentalController);

package/lib/controllers/PluginController.d.ts

@@ -1,12 +1,11 @@
-import { AppConfigService, PluginService, LogService, NpmService } from "../services";
+import { AppConfigService } from "../services/AppConfigService";
+import { PluginService } from "../services/PluginService";
 export declare class PluginController {
     protected readonly appConfigService: AppConfigService;
     protected readonly pluginService: PluginService;
-    protected readonly npmService: NpmService;
-    protected readonly logService: LogService;
-    constructor(appConfigService: AppConfigService, pluginService: PluginService, npmService: NpmService, logService: LogService);
+    constructor(appConfigService: AppConfigService, pluginService: PluginService);
     list(): Promise<string>;
-    add(addName: string, dev?: boolean): Promise<void>;
+    add(addName: string, beta?: boolean): Promise<void>;
     remove(removeName: string): Promise<void>;
     update(): Promise<void>;
     getInstalledPlugins(): string[];

package/lib/controllers/PluginController.js

@@ -11,74 +11,30 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 var __param = (this && this.__param) || function (paramIndex, decorator) {
     return function (target, key) { decorator(target, key, paramIndex); }
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PluginController = void 0;
 const core_1 = require("@wocker/core");
-const chalk_1 = __importDefault(require("chalk"));
-const cli_table3_1 = __importDefault(require("cli-table3"));
-const services_1 = require("../services");
+const AppConfigService_1 = require("../services/AppConfigService");
+const PluginService_1 = require("../services/PluginService");
 let PluginController = class PluginController {
-    constructor(appConfigService, pluginService, npmService, logService) {
+    constructor(appConfigService, pluginService) {
         this.appConfigService = appConfigService;
         this.pluginService = pluginService;
-        this.npmService = npmService;
-        this.logService = logService;
     }
     async list() {
-        const config = this.appConfigService.getConfig();
-        const table = new cli_table3_1.default({
-            head: ["Name"],
-            colWidths: [30]
-        });
-        if (!config.plugins) {
-            return chalk_1.default.gray("No plugins installed");
-        }
-        for (const name of config.plugins) {
-            table.push([name]);
-        }
-        return table.toString() + "\n";
+        return this.pluginService.getPluginsTable();
     }
-    async add(addName, dev) {
-        const [, prefix = "@wocker/", name, suffix = "-plugin"] = /^(@wocker\/)?(\w+)(-plugin)?$/.exec(addName) || [];
-        const fullName = `${prefix}${name}${suffix}`;
-        const config = this.appConfigService.getConfig();
-        try {
-            if (await this.pluginService.checkPlugin(fullName)) {
-                config.addPlugin(fullName);
-                await config.save();
-                console.info(`Plugin ${fullName} activated`);
-                return;
-            }
-            const packageInfo = await this.npmService.getPackageInfo(fullName);
-            await this.npmService.install(fullName, packageInfo["dist-tags"].dev && dev ? "dev" : "latest");
-            if (await this.pluginService.checkPlugin(fullName)) {
-                config.addPlugin(fullName);
-                await config.save();
-                console.info(`Plugin ${fullName} activated`);
-                return;
-            }
-        }
-        catch (err) {
-            this.logService.error(err.message);
-        }
+    async add(addName, beta) {
+        await this.pluginService.install(addName, beta);
     }
     async remove(removeName) {
-        const [, prefix = "@wocker/", name, suffix = "-plugin"] = /^(@wocker\/)?(\w+)(-plugin)?$/.exec(removeName) || [];
-        const fullName = `${prefix}${name}${suffix}`;
-        const config = this.appConfigService.getConfig();
-        config.removePlugin(fullName);
-        await config.save();
-        console.info(`Plugin ${fullName} deactivated`);
+        await this.pluginService.uninstall(removeName);
     }
     async update() {
         await this.pluginService.update();
     }
     getInstalledPlugins() {
-        const config = this.appConfigService.getConfig();
-        return config.plugins || [];
+        return this.appConfigService.config.plugins.map(p => p.name);
     }
 };
 exports.PluginController = PluginController;
@@ -92,12 +48,12 @@ __decorate([
 __decorate([
     (0, core_1.Command)("plugin:add <name>"),
     (0, core_1.Command)("plugin:install <name>"),
-    (0, core_1.Description)("Install a plugin"),
+    (0, core_1.Description)("Install a plugin by specifying its name"),
     __param(0, (0, core_1.Param)("name")),
-    __param(1, (0, core_1.Option)("dev", {
+    __param(1, (0, core_1.Option)("beta", {
         type: "boolean",
         alias: "d",
-        description: "Use dev version of plugin"
+        description: "Use the beta version of the plugin (if a beta version exists). Defaults to the latest stable version."
     })),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [String, Boolean]),
@@ -125,8 +81,7 @@ __decorate([
 ], PluginController.prototype, "getInstalledPlugins", null);
 exports.PluginController = PluginController = __decorate([
     (0, core_1.Controller)(),
-    __metadata("design:paramtypes", [services_1.AppConfigService,
-        services_1.PluginService,
-        services_1.NpmService,
-        services_1.LogService])
+    (0, core_1.Description)("Plugin commands"),
+    __metadata("design:paramtypes", [AppConfigService_1.AppConfigService,
+        PluginService_1.PluginService])
 ], PluginController);

package/lib/controllers/PresetController.d.ts

@@ -1,18 +1,24 @@
 import { Project } from "@wocker/core";
-import { AppConfigService, AppEventsService, ProjectService, PresetService, DockerService } from "../services";
+import { PresetRepository } from "../repositories";
+import { AppConfigService } from "../services/AppConfigService";
+import { AppEventsService } from "../services/AppEventsService";
+import { ProjectService } from "../services/ProjectService";
+import { PresetService } from "../services/PresetService";
+import { DockerService } from "../modules";
 export declare class PresetController {
     protected readonly appConfigService: AppConfigService;
     protected readonly appEventsService: AppEventsService;
     protected readonly projectService: ProjectService;
     protected readonly presetService: PresetService;
+    protected readonly presetRepository: PresetRepository;
     protected readonly dockerService: DockerService;
-    constructor(appConfigService: AppConfigService, appEventsService: AppEventsService, projectService: ProjectService, presetService: PresetService, dockerService: DockerService);
+    constructor(appConfigService: AppConfigService, appEventsService: AppEventsService, projectService: ProjectService, presetService: PresetService, presetRepository: PresetRepository, dockerService: DockerService);
     presets(): Promise<string[]>;
     protected onInit(project: Project): Promise<void>;
     protected onRebuild(project: Project): Promise<void>;
     protected onBeforeStart(project: Project): Promise<void>;
     init(): Promise<void>;
-    deinit(): Promise<void>;
+    destroy(): Promise<void>;
     add(name: string, version?: string): Promise<void>;
     list(): Promise<string>;
     delete(name: string, confirm?: boolean): Promise<void>;