@wocker/mongodb-plugin 1.0.0 → 1.0.1

package/lib/controllers/MongodbController.d.ts

@@ -2,7 +2,7 @@ import { MongodbService } from "../services/MongodbService";
 export declare class MongodbController {
     protected readonly mongodbService: MongodbService;
     constructor(mongodbService: MongodbService);
-    create(name?: string): Promise<void>;
+    create(name?: string, image?: string, imageVersion?: string): Promise<void>;
     destroy(name: string, yes?: boolean, force?: boolean): Promise<void>;
     use(name: string): Promise<void>;
     start(name?: string, restart?: boolean): Promise<void>;

package/lib/controllers/MongodbController.js

@@ -28,9 +28,9 @@ let MongodbController = class MongodbController {
     constructor(mongodbService) {
         this.mongodbService = mongodbService;
     }
-    create(name) {
+    create(name, image, imageVersion) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.mongodbService.create(name);
+            yield this.mongodbService.create(name, image, imageVersion);
         });
     }
     destroy(name, yes, force) {
@@ -42,7 +42,7 @@ let MongodbController = class MongodbController {
     }
     use(name) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.mongodbService.use(name);
+            this.mongodbService.use(name);
         });
     }
     start(name, restart) {
@@ -64,29 +64,52 @@ let MongodbController = class MongodbController {
     }
     getNames() {
         return __awaiter(this, void 0, void 0, function* () {
-            return [];
+            return this.mongodbService.config.databases.items.map((database) => {
+                return database.name;
+            });
         });
     }
 };
 exports.MongodbController = MongodbController;
 __decorate([
     (0, core_1.Command)("mongodb:create [name]"),
+    (0, core_1.Description)("Creates a MongoDB service with configurable credentials, host, and storage options."),
     __param(0, (0, core_1.Param)("name")),
+    __param(1, (0, core_1.Option)("image", {
+        type: "string",
+        alias: "i",
+        description: "The image name to start the service with",
+    })),
+    __param(2, (0, core_1.Option)("image-version", {
+        type: "string",
+        alias: "I",
+        description: "The image version to start the service with"
+    })),
     __metadata("design:type", Function),
-    __metadata("design:paramtypes", [String]),
+    __metadata("design:paramtypes", [String, String, String]),
     __metadata("design:returntype", Promise)
 ], MongodbController.prototype, "create", null);
 __decorate([
     (0, core_1.Command)("mongodb:destroy <name>"),
+    (0, core_1.Description)("Destroys a specified MongodbDB service instance with an option to force deletion."),
     __param(0, (0, core_1.Param)("name")),
-    __param(1, (0, core_1.Option)("yes", { alias: "y" })),
-    __param(2, (0, core_1.Option)("force", { alias: "f" })),
+    __param(1, (0, core_1.Option)("yes", {
+        type: "boolean",
+        alias: "y",
+        description: "Skip confirmation"
+    })),
+    __param(2, (0, core_1.Option)("force", {
+        type: "boolean",
+        alias: "f",
+        description: "Force deletion"
+    })),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [String, Boolean, Boolean]),
     __metadata("design:returntype", Promise)
 ], MongodbController.prototype, "destroy", null);
 __decorate([
     (0, core_1.Command)("mongodb:use <name>"),
+    (0, core_1.Description)("Sets a specified MongoDB service as the default."),
     __param(0, (0, core_1.Param)("name")),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [String]),
@@ -94,14 +117,20 @@ __decorate([
 ], MongodbController.prototype, "use", null);
 __decorate([
     (0, core_1.Command)("mongodb:start [name]"),
+    (0, core_1.Description)("Starts a specified MongoDB service and optionally restarts it if already running."),
     __param(0, (0, core_1.Param)("name")),
-    __param(1, (0, core_1.Option)("restart", { alias: "r" })),
+    __param(1, (0, core_1.Option)("restart", {
+        type: "boolean",
+        alias: "r",
+        description: "Restart the service if already running"
+    })),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [String, Boolean]),
     __metadata("design:returntype", Promise)
 ], MongodbController.prototype, "start", null);
 __decorate([
     (0, core_1.Command)("mongodb:stop [name]"),
+    (0, core_1.Description)("Stops a specified MongoDB service instance."),
     __param(0, (0, core_1.Param)("name")),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [String]),
@@ -109,6 +138,7 @@ __decorate([
 ], MongodbController.prototype, "stop", null);
 __decorate([
     (0, core_1.Command)("mongodb:ls"),
+    (0, core_1.Description)("Lists all available MongoDB services."),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", []),
     __metadata("design:returntype", Promise)

package/lib/makes/Config.d.ts

@@ -8,8 +8,12 @@ export declare abstract class Config {
     default?: string;
     databases: ConfigCollection<Database, DatabaseProps>;
     constructor(props: ConfigProps);
-    getDatabase(name?: string): Database;
+    setDatabase(database: Database): void;
+    hasDatabase(name: string): boolean;
+    getDefault(): Database;
+    getDatabaseOrDefault(name?: string): Database;
+    getDatabase(name: string): Database;
     removeDatabase(name: string): void;
-    abstract save(): Promise<void>;
+    abstract save(): void;
     toJSON(): ConfigProps;
 }

package/lib/makes/Config.js

@@ -9,27 +9,39 @@ class Config {
         this.default = defaultDatabase;
         this.databases = new core_1.ConfigCollection(Database_1.Database, databases);
     }
-    getDatabase(name) {
+    setDatabase(database) {
+        this.databases.setConfig(database);
+    }
+    hasDatabase(name) {
+        return !!this.databases.getConfig(name);
+    }
+    getDefault() {
+        if (!this.default) {
+            throw new Error("Default database is not defined");
+        }
+        const database = this.databases.getConfig(this.default);
+        if (!database) {
+            throw new Error(`Default database "${this.default}" not found`);
+        }
+        return database;
+    }
+    getDatabaseOrDefault(name) {
         if (!name) {
-            if (!this.default) {
-                throw new Error("Default database is not defined");
-            }
-            const database = this.databases.getConfig(this.default);
-            if (!database) {
-                throw new Error(`Default database ${this.default} not found`);
-            }
-            return database;
+            return this.getDefault();
         }
+        return this.getDatabase(name);
+    }
+    getDatabase(name) {
         const database = this.databases.getConfig(name);
         if (!database) {
-            throw new Error(`Database ${name} not found`);
+            throw new Error(`Database "${name}" not found`);
         }
         return database;
     }
     removeDatabase(name) {
         const database = this.databases.getConfig(name);
         if (!database) {
-            throw new Error(`Storage ${name} not found`);
+            throw new Error(`Database "${name}" not found`);
         }
         this.databases.removeConfig(name);
     }

package/lib/makes/Database.d.ts

@@ -1,17 +1,22 @@
 import { Config, ConfigProperties } from "@wocker/core";
 export type DatabaseProps = ConfigProperties & {
+    imageName?: string;
+    imageVersion?: string;
     username: string;
     password: string;
     configStorage?: string;
     storage?: string;
 };
 export declare class Database extends Config<DatabaseProps> {
+    imageName?: string;
+    imageVersion?: string;
     username: string;
     password: string;
     configStorage: string;
     storage: string;
     constructor(props: DatabaseProps);
     get containerName(): string;
+    get image(): string;
     get defaultStorage(): string;
     get defaultConfigStorage(): string;
 }

package/lib/makes/Database.js

@@ -5,7 +5,9 @@ const core_1 = require("@wocker/core");
 class Database extends core_1.Config {
     constructor(props) {
         super(props);
-        const { username, password, configStorage, storage } = props;
+        const { imageName, imageVersion, username, password, configStorage, storage } = props;
+        this.imageName = imageName;
+        this.imageVersion = imageVersion;
         this.username = username;
         this.password = password;
         this.configStorage = configStorage || this.defaultConfigStorage;
@@ -14,6 +16,10 @@ class Database extends core_1.Config {
     get containerName() {
         return `mongodb-${this.name}.ws`;
     }
+    get image() {
+        const imageName = this.imageName || "mongo", imageVersion = this.imageVersion || "latest";
+        return `${imageName}:${imageVersion}`;
+    }
     get defaultStorage() {
         return `wocker-mongodb-${this.name}`;
     }

package/lib/services/MongodbService.d.ts

@@ -5,13 +5,14 @@ export declare class MongodbService {
     protected readonly pluginConfigService: PluginConfigService;
     protected readonly dockerService: DockerService;
     protected readonly proxyService: ProxyService;
+    protected _config?: Config;
     adminContainerName: string;
     constructor(appConfigService: AppConfigService, pluginConfigService: PluginConfigService, dockerService: DockerService, proxyService: ProxyService);
-    protected _config?: Config;
     get config(): Config;
-    create(name?: string, username?: string, password?: string): Promise<void>;
+    create(name?: string, imageName?: string, imageVersion?: string, username?: string, password?: string): Promise<void>;
+    upgrade(name?: string, imageName?: string, imageVersion?: string): Promise<void>;
     destroy(name: string, yes?: boolean, force?: boolean): Promise<void>;
-    use(name: string): Promise<void>;
+    use(name: string): void;
     start(name?: string, restart?: boolean): Promise<void>;
     admin(): Promise<void>;
     stop(name?: string): Promise<void>;

package/lib/services/MongodbService.js

@@ -37,40 +37,27 @@ let MongodbService = class MongodbService {
     }
     get config() {
         if (!this._config) {
-            const data = this.pluginConfigService.fs.exists("config.json")
-                ? this.pluginConfigService.fs.readJSON("config.json")
-                : {
-                    default: "default",
-                    databases: [
-                        {
-                            name: "default",
-                            username: "root",
-                            password: "toor",
-                            configStorage: "wocker-mongoconfig-default",
-                            storage: "wocker-mongodb-default"
-                        }
-                    ]
-                };
             const fs = this.pluginConfigService.fs;
+            const data = fs.exists("config.json")
+                ? fs.readJSON("config.json")
+                : {};
             this._config = new class extends Config_1.Config {
                 save() {
-                    return __awaiter(this, void 0, void 0, function* () {
-                        if (!fs.exists()) {
-                            fs.mkdir("", {
-                                recursive: true
-                            });
-                        }
-                        yield fs.writeJSON("config.json", this.toJSON());
-                    });
+                    if (!fs.exists()) {
+                        fs.mkdir("", {
+                            recursive: true
+                        });
+                    }
+                    fs.writeJSON("config.json", this.toJSON());
                 }
             }(data);
         }
         return this._config;
     }
-    create(name_1) {
-        return __awaiter(this, arguments, void 0, function* (name, username = "", password = "") {
-            if (name && this.config.databases.getConfig(name)) {
-                throw new Error(`${name}`);
+    create(name_1, imageName_1, imageVersion_1) {
+        return __awaiter(this, arguments, void 0, function* (name, imageName, imageVersion, username = "", password = "") {
+            if (name && this.config.hasDatabase(name)) {
+                throw new Error(`Database name "${name}" is already taken`);
             }
             if (!name) {
                 name = (yield (0, utils_1.promptText)({
@@ -80,7 +67,7 @@ let MongodbService = class MongodbService {
                         if (!name) {
                             return "Name is required";
                         }
-                        if (this.config.databases.getConfig(name)) {
+                        if (this.config.hasDatabase(name)) {
                             return `Database name "${name}" is already taken`;
                         }
                         return true;
@@ -111,16 +98,36 @@ let MongodbService = class MongodbService {
             }
             const database = new Database_1.Database({
                 name,
+                imageName,
+                imageVersion,
                 username,
                 password
             });
-            this.config.databases.setConfig(database);
-            yield this.config.save();
+            this.config.setDatabase(database);
+            this.config.save();
+        });
+    }
+    upgrade(name, imageName, imageVersion) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const service = this.config.getDatabaseOrDefault(name);
+            let changed = false;
+            if (imageName) {
+                service.imageName = imageName;
+                changed = true;
+            }
+            if (imageVersion) {
+                service.imageVersion = imageVersion;
+                changed = true;
+            }
+            if (changed) {
+                this.config.setDatabase(service);
+                this.config.save();
+            }
         });
     }
     destroy(name, yes, force) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!this.appConfigService.isVersionGTE || !this.appConfigService.isVersionGTE("1.0.19")) {
+            if (!this.pluginConfigService.isVersionGTE("1.0.19")) {
                 throw new Error("Please update @wocker/ws");
             }
             const database = this.config.getDatabase(name);
@@ -143,31 +150,33 @@ let MongodbService = class MongodbService {
                 yield this.dockerService.rmVolume(database.storage);
             }
             this.config.removeDatabase(database.name);
-            yield this.config.save();
+            this.config.save();
         });
     }
     use(name) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const database = this.config.getDatabase(name);
-            this.config.default = database.name;
-            yield this.config.save();
-        });
+        const database = this.config.getDatabase(name);
+        this.config.default = database.name;
+        this.config.save();
     }
     start(name, restart) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!this.appConfigService.isVersionGTE || !this.appConfigService.isVersionGTE("1.0.19")) {
+            if (!this.pluginConfigService.isVersionGTE("1.0.19")) {
                 throw new Error("Please update @wocker/ws");
             }
-            const database = this.config.getDatabase(name);
-            if (restart) {
-                yield this.dockerService.removeContainer(database.containerName);
+            if (!name || !this.config.default) {
+                yield this.create();
             }
+            const database = this.config.getDatabaseOrDefault(name);
             let container = yield this.dockerService.getContainer(database.containerName);
+            if (restart && container) {
+                yield this.dockerService.removeContainer(database.containerName);
+                container = null;
+            }
             if (!container) {
                 container = yield this.dockerService.createContainer({
                     name: database.containerName,
                     restart: "always",
-                    image: "mongo:latest",
+                    image: database.image,
                     env: {
                         MONGO_INITDB_ROOT_USERNAME: database.username,
                         MONGO_INITDB_ROOT_PASSWORD: database.password,
@@ -239,7 +248,7 @@ let MongodbService = class MongodbService {
     }
     stop(name) {
         return __awaiter(this, void 0, void 0, function* () {
-            const database = this.config.getDatabase(name);
+            const database = this.config.getDatabaseOrDefault(name);
             console.info(`Stopping ${database.name}...`);
             yield this.dockerService.removeContainer(database.containerName);
         });
@@ -251,6 +260,7 @@ let MongodbService = class MongodbService {
                     "Name",
                     "Username",
                     "Host",
+                    "Image",
                     "Storages"
                 ]
             });
@@ -259,6 +269,7 @@ let MongodbService = class MongodbService {
                     database.name + (database.name === this.config.default ? " (default)" : ""),
                     database.username,
                     database.containerName,
+                    database.image,
                     `${database.configStorage}\n${database.storage}`
                 ]);
             }

package/package.json

@@ -1,17 +1,17 @@
 {
     "name": "@wocker/mongodb-plugin",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "author": "Kris Papercut <krispcut@gmail.com>",
     "description": "Mongodb plugin for wocker",
     "license": "MIT",
-    "main": "lib/index.js",
-    "types": "lib/index.d.ts",
+    "main": "./lib/index.js",
+    "types": "./lib/index.d.ts",
     "keywords": [
         "wocker",
         "plugin",
         "mongodb"
     ],
-    "homepage": "https://kearisp.github.io/wocker/plugins/mongodb",
+    "homepage": "https://kearisp.github.io/wocker/docs/plugins/mongodb",
     "repository": {
         "type": "git",
         "url": "git+https://github.com/kearisp/wocker-mongodb-plugin.git"
@@ -26,12 +26,12 @@
         "test": "echo \"Error: no test specified\" && exit 1"
     },
     "dependencies": {
-        "@wocker/core": "^1.0.20",
-        "@wocker/utils": "^1.0.8",
+        "@wocker/core": "^1.0.21",
+        "@wocker/utils": "^1.0.9",
         "cli-table3": "^0.6.5"
     },
     "devDependencies": {
-        "@types/node": ">=20.17.6",
+        "@types/node": "^22.7.8",
         "typescript": "^5.6.3"
     }
 }