@elysiumjs/styx 0.4.0 → 0.5.0

package/README.md

@@ -1,6 +1,6 @@
 # @elysiumjs/styx
 
-CLI tool for Elysium.
+CLI tool for Elysium.js framework.
 
 ## Installation
 
@@ -10,34 +10,45 @@ bun install @elysiumjs/styx
 
 ## Usage
 
-The `styx` command needs to be run from the root of your Elysium project.
+The `styx` command needs to be run inside an Elysium.js project.
 
 To create new items:
 
 ```bash
-bun styx exec make:controller [options]
-bun styx exec make:job [options]
-bun styx exec make:middleware [options]
-bun styx exec make:service [options]
-bun styx exec make:command [options]
+bun styx make:command [options]
+bun styx make:controller [options]
+bun styx make:job [options]
+bun styx make:middleware [options]
+bun styx make:model [options]
+bun styx make:repository [options]
+bun styx make:service [options]
+bun styx make:validator [options]
 ```
 
-To start the Elysium project:
+To manage migrations:
 
 ```bash
-bun styx serve
+bun styx migration:generate [options]
+bun styx migration:run [options]
 ```
 
-To execute a custom command:
+To manage modules:
+
+```bash
+bun styx module:new [options]
+bun styx module:rename [options]
+```
+
+To start the Elysium.js project:
 
 ```bash
-bun styx exec <command>
+bun styx serve
 ```
 
-To run a worker:
+To execute a custom command:
 
 ```bash
-bun styx work --queue queue1 --queue queue2
+bun styx <command>
 ```
 
 To show all available commands:
@@ -60,4 +71,4 @@ Feel free to open issues for any bugs or questions you may have. Pull requests a
 
 ## License
 
-This project is licensed under the Apache License, Version 2.0. See the [LICENSE](../../LICENSE) file for more information.
+This project is licensed under the Apache License, Version 2.0. See the [LICENSE](https://github.com/workbud/elysium/blob/main/LICENSE) file for more information.

package/package.json

@@ -1,39 +1,38 @@
 {
 	"name": "@elysiumjs/styx",
-	"version": "0.4.0",
+	"version": "0.5.0",
 	"license": "Apache-2.0",
-	"description": "The CLI tool for the Elysium framework.",
+	"description": "The CLI tool for the Elysium.js framework.",
 	"private": false,
-	"author": {
-		"name": "Axel Nana",
-		"email": "axel.nana@workbud.com"
-	},
+	"author": "Workbud Technologies Inc.",
 	"repository": {
 		"type": "git",
-		"url": "https://github.com/Workerly/elysium"
+		"url": "https://github.com/workbud/elysium"
 	},
-	"homepage": "https://github.com/Workerly/elysium",
+	"homepage": "https://github.com/workbud/elysium",
 	"scripts": {
 		"format": "prettier --write \"./src/**/*.ts\"",
-		"build": "bun build index.ts --outfile=styx.js --target bun --minify -e @elysiumjs/core"
+		"build": "bun build ./src/styx.ts --outdir=./ --root ./src --target bun --minify -e @elysiumjs/core -e reflect-metadata",
+		"prepublishOnly": "bun run build"
 	},
 	"keywords": [
 		"elysium",
 		"framework",
 		"web",
 		"api",
-		"typescript"
+		"typescript",
+		"cli"
 	],
 	"type": "module",
 	"bin": {
 		"styx": "./styx.js"
 	},
 	"devDependencies": {
-		"@ianvs/prettier-plugin-sort-imports": "^4.4.1",
+		"@ianvs/prettier-plugin-sort-imports": "^4.4.2",
 		"@types/bun": "latest",
 		"@types/prompts": "^2.4.9",
 		"@types/string-template": "^1.0.6",
-		"type-fest": "^4.40.1",
+		"type-fest": "^4.41.0",
 		"prompts": "^2.4.2",
 		"radash": "^12.1.0",
 		"string-template": "^1.0.0"

package/src/commands/make_command.ts

@@ -25,7 +25,7 @@ import { getModulePath, parseProjectConfig } from '../config';
 import { getRootPath } from '../utils';
 
 /**
- * Maker class for creating Elysium commands.
+ * Maker class for creating Elysium.js commands.
  * @author Axel Nana <axel.nana@workbud.com>
  */
 export class MakeCommandCommand extends Command {
@@ -132,7 +132,12 @@ export class MakeCommandCommand extends Command {
 			}
 		];
 
-		const answers = await prompts(items);
+		const answers = await prompts(items, {
+			onCancel: () => {
+				this.error('Operation cancelled.');
+				process.exit(0);
+			}
+		});
 
 		answers.name = pascal(answers.command.replaceAll(':', '_'));
 

package/src/commands/make_controller.ts

@@ -25,7 +25,7 @@ import { getModulePath, parseProjectConfig } from '../config';
 import { getRootPath } from '../utils';
 
 /**
- * Maker class for creating Elysium controllers.
+ * Maker class for creating Elysium.js controllers.
  * @author Axel Nana <axel.nana@workbud.com>
  */
 export class MakeControllerCommand extends Command {
@@ -239,7 +239,12 @@ export class MakeControllerCommand extends Command {
 			}
 		];
 
-		const answers = await prompts(items);
+		const answers = await prompts(items, {
+			onCancel: () => {
+				this.error('Operation cancelled.');
+				process.exit(0);
+			}
+		});
 
 		return this.build(answers);
 	}

package/src/commands/make_job.ts

@@ -25,7 +25,7 @@ import { getModulePath, parseProjectConfig } from '../config';
 import { getRootPath } from '../utils';
 
 /**
- * Maker class for creating Elysium jobs.
+ * Maker class for creating Elysium.js jobs.
  * @author Axel Nana <axel.nana@workbud.com>
  */
 export class MakeJobCommand extends Command {
@@ -141,7 +141,12 @@ export class MakeJobCommand extends Command {
 			}
 		];
 
-		const answers = await prompts(items);
+		const answers = await prompts(items, {
+			onCancel: () => {
+				this.error('Operation cancelled.');
+				process.exit(0);
+			}
+		});
 
 		return this.build(answers);
 	}

package/src/commands/make_middleware.ts

@@ -25,7 +25,7 @@ import { getModulePath, parseProjectConfig } from '../config';
 import { getRootPath } from '../utils';
 
 /**
- * Maker class for creating Elysium middlewares.
+ * Maker class for creating Elysium.js middlewares.
  * @author Axel Nana <axel.nana@workbud.com>
  */
 export class MakeMiddlewareCommand extends Command {
@@ -105,7 +105,12 @@ export class MakeMiddlewareCommand extends Command {
 			}
 		];
 
-		const answers = await prompts(items);
+		const answers = await prompts(items, {
+			onCancel: () => {
+				this.error('Operation cancelled.');
+				process.exit(0);
+			}
+		});
 
 		return this.build(answers);
 	}

package/src/commands/make_model.ts

@@ -25,7 +25,7 @@ import { getModulePath, parseProjectConfig } from '../config';
 import { getRootPath } from '../utils';
 
 /**
- * Maker command for creating Elysium models.
+ * Maker command for creating Elysium.js models.
  * @author Axel Nana <axel.nana@workbud.com>
  */
 export class MakeModelCommand extends Command {
@@ -74,15 +74,20 @@ export class MakeModelCommand extends Command {
 		};
 
 		if (!answers.module && !config.mono) {
-			const module = await prompts({
-				type: 'select',
-				name: 'module',
-				message: 'Module:',
-				choices: Object.keys(config.modules ?? {}).map((moduleName) => ({
-					title: moduleName,
-					value: moduleName
-				}))
-			});
+			const module = await prompts(
+				{
+					type: 'select',
+					name: 'module',
+					message: 'Module:',
+					choices: Object.keys(config.modules ?? {}).map((moduleName) => ({
+						title: moduleName,
+						value: moduleName
+					}))
+				},
+				{
+					onCancel: () => process.exit(1)
+				}
+			);
 
 			answers.module = module.module;
 		}
@@ -160,7 +165,12 @@ export class MakeModelCommand extends Command {
 			}
 		];
 
-		const answers = await prompts(items);
+		const answers = await prompts(items, {
+			onCancel: () => {
+				this.error('Operation cancelled.');
+				process.exit(0);
+			}
+		});
 
 		return this.build(answers);
 	}

package/src/commands/make_repository.ts

@@ -179,7 +179,12 @@ export class MakeRepositoryCommand extends Command {
 			}
 		];
 
-		const answers = await prompts(items);
+		const answers = await prompts(items, {
+			onCancel: () => {
+				this.error('Operation cancelled.');
+				process.exit(0);
+			}
+		});
 
 		return this.build(answers);
 	}

package/src/commands/make_service.ts

@@ -159,7 +159,12 @@ export class MakeServiceCommand extends Command {
 			}
 		];
 
-		const answers = await prompts(items);
+		const answers = await prompts(items, {
+			onCancel: () => {
+				this.error('Operation cancelled.');
+				process.exit(0);
+			}
+		});
 
 		return this.build(answers);
 	}

package/src/commands/make_validator.ts

@@ -105,7 +105,12 @@ export class MakeValidatorCommand extends Command {
 			}
 		];
 
-		const answers = await prompts(items);
+		const answers = await prompts(items, {
+			onCancel: () => {
+				this.error('Operation cancelled.');
+				process.exit(0);
+			}
+		});
 
 		return this.build(answers);
 	}

package/src/commands/migration_generate.ts

@@ -17,6 +17,8 @@ import { exists } from 'node:fs/promises';
 import { Command, CommandArgumentType } from '@elysiumjs/core';
 import prompts from 'prompts';
 
+import { getProjectPath } from '../utils';
+
 /**
  * Generates migration files.
  * @author Axel Nana <axel.nana@workbud.com>
@@ -33,37 +35,46 @@ export class MigrationGenerateCommand extends Command {
 
 	public async run(): Promise<void> {
 		if (!this.name) {
-			const answers = await prompts([
-				{
-					type: 'text',
-					name: 'name',
-					message: 'Migration Name:',
-					initial: 'create_users_table',
-					validate(value: string) {
-						if (value.length < 1) {
-							return 'Migration name cannot be empty';
-						}
+			const answers = await prompts(
+				[
+					{
+						type: 'text',
+						name: 'name',
+						message: 'Migration Name:',
+						initial: 'create_users_table',
+						validate(value: string) {
+							if (value.length < 1) {
+								return 'Migration name cannot be empty';
+							}
 
-						return true;
+							return true;
+						}
+					}
+				],
+				{
+					onCancel: () => {
+						this.error('Operation cancelled.');
+						process.exit(0);
 					}
 				}
-			]);
+			);
 
 			this.name = answers.name;
 		}
 
-		let schemaPath = `./src/database/schemas`;
-		if (await exists(`${process.cwd()}/src/database/schema.ts`)) {
-			schemaPath = `./src/database/schema.ts`;
+		const projectRoot = getProjectPath();
+		let schemaPath = `${projectRoot}/src/database/schemas`;
+		if (await exists(`${projectRoot}/src/database/schema.ts`)) {
+			schemaPath = `${projectRoot}/src/database/schema.ts`;
 		}
 
-		await Bun.$`bunx --bun drizzle-kit generate --dialect postgresql --schema ${schemaPath} --out ./src/database/migrations --prefix timestamp --name ${this.name}`;
+		await Bun.$`bunx --bun drizzle-kit generate --dialect postgresql --schema ${schemaPath} --out ${projectRoot}/src/database/migrations --prefix timestamp --name ${this.name}`;
 
-		const sqlFiles = new Bun.Glob(`${process.cwd()}/src/database/migrations/**/*.sql`).scan();
+		const sqlFiles = new Bun.Glob(`${projectRoot}/src/database/migrations/**/*.sql`).scan();
 		for await (const path of sqlFiles) {
 			const file = Bun.file(path);
 			const content = await file.text();
-			await file.write(content.replace(/"public"./gm, ''));
+			await file.write(content.replace(/"public"\./gm, ''));
 		}
 	}
 }

package/src/commands/migration_run.ts

@@ -69,14 +69,22 @@ export class MigrationRunCommand extends Command {
 		) AS schema_exists;`;
 
 			if (!schema_exists) {
-				const answers = await prompts([
+				const answers = await prompts(
+					[
+						{
+							type: 'confirm',
+							name: 'create',
+							message: `Schema ${this.tenant} does not exist. Do you want to create it?`,
+							initial: true
+						}
+					],
 					{
-						type: 'confirm',
-						name: 'create',
-						message: `Schema ${this.tenant} does not exist. Do you want to create it?`,
-						initial: true
+						onCancel: () => {
+							this.error('Operation cancelled.');
+							process.exit(0);
+						}
 					}
-				]);
+				);
 
 				if (answers.create) {
 					await sql`CREATE SCHEMA ${sql(this.tenant)};`;
@@ -91,7 +99,7 @@ export class MigrationRunCommand extends Command {
 			const [{ table_exists }] = await sql`SELECT EXISTS (
 			SELECT *
 			  FROM information_schema.tables
-			 WHERE table_name = 'elysium_migrations' 
+			 WHERE table_name = 'elysium_migrations'
 			   AND table_schema = ${this.tenant}
 		) AS table_exists;`;
 

package/src/commands/module_new.ts

@@ -0,0 +1,112 @@
+// Copyright (c) 2025-present Workbud Technologies Inc. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import { exists, rmdir } from 'node:fs/promises';
+import { join } from 'node:path';
+
+import { Command, CommandArgumentType } from '@elysiumjs/core';
+import prompts from 'prompts';
+import { snake } from 'radash';
+
+import { parseProjectConfig } from '../config';
+import { createModule, getProjectPath } from '../utils';
+
+/**
+ * Command for creating Elysium.js modules.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export class ModuleNewCommand extends Command {
+	public static readonly command: string = 'module:new';
+	public static readonly description: string = 'Creates a new module.';
+
+	@Command.arg({
+		description: 'The name of the module to create',
+		type: CommandArgumentType.STRING
+	})
+	private name?: string;
+
+	private module?: string;
+	private convert: boolean = false;
+
+	public override async run(): Promise<void> {
+		const config = await parseProjectConfig();
+
+		// 1. Prompt for new module name if not provided
+		if (!this.name) {
+			const name = await prompts(
+				{
+					type: 'text',
+					name: 'name',
+					message: 'New module name:',
+					initial: 'module',
+					validate(value) {
+						return value.length > 0 ? true : 'Module name cannot be empty';
+					}
+				},
+				{
+					onCancel: () => process.exit(0)
+				}
+			);
+
+			this.name = snake(name.name);
+		}
+
+		// 2. If mono-module, prompt for conversion and current module name
+		if (config.mono) {
+			const { module, convert } = await prompts(
+				[
+					{
+						type: 'confirm',
+						name: 'convert',
+						message:
+							'This project is a mono-module project. Do you want to convert it to a multi-module project?',
+						initial: false
+					},
+					{
+						type: (convert) => (convert ? 'text' : null),
+						name: 'module',
+						message: 'Current module name:',
+						initial: 'main',
+						validate(value) {
+							return value.length > 0 ? true : 'Module name cannot be empty';
+						}
+					}
+				],
+				{
+					onCancel: () => process.exit(0)
+				}
+			);
+
+			if (!convert) return this.error('Operation cancelled. The project is left unchanged.');
+
+			this.module = snake(module as string);
+			this.convert = convert;
+		}
+
+		// 3. If multi-module conversion is enabled, convert the project to a multi-module project
+		if (this.convert) {
+			const modulesDir = join(getProjectPath(), 'src', 'modules');
+			if (await exists(modulesDir)) await rmdir(modulesDir, { recursive: true });
+
+			await createModule(this.module!, 'root');
+
+			this.success(`Project converted to multi-module.`);
+			this.success(`Module '${this.module}' created.`);
+		}
+
+		// 4. Create the new module
+		await createModule(this.name);
+		this.success(`Module '${this.name}' created.`);
+	}
+}

package/src/commands/module_rename.ts

@@ -0,0 +1,78 @@
+// Copyright (c) 2025-present Workbud Technologies Inc. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import { Command, CommandArgumentType } from '@elysiumjs/core';
+import prompts from 'prompts';
+
+import { parseProjectConfig } from '../config';
+import { createModule } from '../utils';
+
+/**
+ * Command for renaming Elysium.js modules.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export class ModuleRenameCommand extends Command {
+	public static readonly command: string = 'module:rename';
+	public static readonly description: string = 'Renames a module.';
+
+	@Command.arg({
+		description: 'The module to rename',
+		type: CommandArgumentType.STRING
+	})
+	private module?: string;
+
+	@Command.arg({
+		description: 'The new name of the module',
+		type: CommandArgumentType.STRING
+	})
+	private name?: string;
+
+	public override async run(): Promise<void> {
+		const config = await parseProjectConfig();
+
+		if (config.mono) {
+			return this.error('This operation is not supported for mono-module projects.');
+		}
+
+		if (!this.module) {
+			const { module } = await prompts({
+				type: 'text',
+				name: 'module',
+				message: 'Module to rename:',
+				validate: (value) => value.length > 0
+			});
+
+			this.module = module as string;
+		}
+
+		if (!this.name) {
+			const { name } = await prompts({
+				type: 'text',
+				name: 'name',
+				message: 'New module name:',
+				initial: this.module,
+				validate: (value) => value.length > 0
+			});
+
+			this.name = name as string;
+		}
+
+		if (this.module === this.name) {
+			return this.info('Module name is the same as the current name.');
+		}
+
+		await createModule(this.name!, this.module!);
+		this.success(`Module '${this.module}' renamed to '${this.name}'.`);
+	}
+}

package/src/config.ts

@@ -12,7 +12,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import { resolve } from 'node:path';
+import { join } from 'node:path';
+
+import { getProjectPath } from './utils';
 
 /**
  * Describes the Elysium project's configuration.
@@ -44,12 +46,12 @@ export interface ProjectConfig {
  * @returns The Elysium project's configuration.
  */
 export const parseProjectConfig = async (): Promise<ProjectConfig> => {
-	const config = Bun.file(resolve('.elysiumrc'));
-	if (!config.exists()) {
+	const file = Bun.file(join(getProjectPath(), '.elysiumrc'));
+	if (!file.exists()) {
 		throw new Error('Elysium config file not found.');
 	}
 
-	return JSON.parse(await config.text());
+	return file.json();
 };
 
 /**
@@ -58,7 +60,7 @@ export const parseProjectConfig = async (): Promise<ProjectConfig> => {
  * @param config The Elysium project's configuration.
  */
 export const writeProjectConfig = async (config: ProjectConfig) => {
-	const file = Bun.file(resolve('.elysiumrc'));
+	const file = Bun.file(join(getProjectPath(), '.elysiumrc'));
 	await file.write(JSON.stringify(config, null, 2));
 };