@elysiumjs/styx 0.3.0 → 0.5.0

package/src/commands/make_repository.ts

@@ -0,0 +1,225 @@
+// 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 type { PromptObject } from 'prompts';
+
+import { join } from 'node:path';
+
+import { Command, CommandArgumentType } from '@elysiumjs/core';
+import prompts from 'prompts';
+import { snake } from 'radash';
+import formatter from 'string-template';
+
+import { getModulePath, parseProjectConfig } from '../config';
+import { getRootPath } from '../utils';
+
+/**
+ * Maker command for creating Elysium repositories.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export class MakeRepositoryCommand extends Command {
+	public static readonly command: string = 'make:repository';
+	public static readonly description: string = 'Creates a new repository.';
+
+	@Command.arg({
+		description: 'The name of the repository to create',
+		type: CommandArgumentType.STRING
+	})
+	private name?: string;
+
+	@Command.arg({
+		description: 'The module where the repository will be created',
+		type: CommandArgumentType.STRING
+	})
+	private module?: string;
+
+	@Command.arg({
+		description: 'The alias of the repository to create',
+		type: CommandArgumentType.STRING
+	})
+	private alias?: string;
+
+	@Command.arg({
+		description: 'The model used by the repository',
+		type: CommandArgumentType.STRING
+	})
+	private model?: string;
+
+	@Command.arg({
+		description: 'Create a factory repository',
+		type: CommandArgumentType.BOOLEAN,
+		default: false
+	})
+	private factory: boolean = false;
+
+	@Command.arg({
+		description: 'Create a singleton repository',
+		type: CommandArgumentType.BOOLEAN,
+		default: false
+	})
+	private singleton: boolean = false;
+
+	public async run(): Promise<void> {
+		if (!this.name) {
+			return this.setup();
+		}
+
+		const config = await parseProjectConfig();
+
+		const answers: Record<string, any> = {
+			module: this.module,
+			name: this.name,
+			alias: this.alias,
+			scope: this.factory ? 'FACTORY' : this.singleton ? 'SINGLETON' : 'SINGLETON',
+			model: this.model
+		};
+
+		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
+				}))
+			});
+
+			answers.module = module.module;
+		}
+
+		return this.build(answers);
+	}
+
+	private async setup(): Promise<void> {
+		const config = await parseProjectConfig();
+
+		const items: PromptObject[] = [
+			{
+				type() {
+					return config.mono ? null : 'select';
+				},
+				name: 'module',
+				message: 'Module:',
+				choices() {
+					return Object.keys(config.modules ?? {}).map((moduleName) => ({
+						title: moduleName,
+						value: moduleName
+					}));
+				}
+			},
+			{
+				type: 'text',
+				name: 'name',
+				message: 'Repository Name:',
+				initial: 'UserRepository',
+				validate(value: string) {
+					if (value.length < 1) {
+						return 'Repository name cannot be empty';
+					}
+
+					return true;
+				}
+			},
+			{
+				type: 'text',
+				name: 'model',
+				message: 'Model Name:',
+				initial: 'UserModel',
+				validate(value: string) {
+					if (value.length < 1) {
+						return 'Model name cannot be empty';
+					}
+
+					return true;
+				}
+			},
+			{
+				type: 'text',
+				name: 'alias',
+				message: 'Repository Alias:',
+				initial(_, values) {
+					return values.name;
+				},
+				validate(value: string) {
+					if (value.length < 1) {
+						return 'Repository alias cannot be empty';
+					}
+
+					return true;
+				}
+			},
+			{
+				type: 'select',
+				name: 'scope',
+				message: 'Repository Scope:',
+				choices: [
+					{
+						title: 'SINGLETON',
+						value: 'SINGLETON',
+						description: 'A single instance of the repository is created.'
+					},
+					{
+						title: 'FACTORY',
+						value: 'FACTORY',
+						description: 'A new instance of the repository is created each time it is injected.'
+					}
+				]
+			}
+		];
+
+		const answers = await prompts(items, {
+			onCancel: () => {
+				this.error('Operation cancelled.');
+				process.exit(0);
+			}
+		});
+
+		return this.build(answers);
+	}
+
+	private async build(answers: Record<string, any>): Promise<void> {
+		if (!answers.name) {
+			this.error('Operation cancelled.');
+			return;
+		}
+
+		if (!answers.name.endsWith('Repository')) {
+			answers.name += 'Repository';
+		}
+
+		if (!answers.alias) {
+			answers.alias = answers.name;
+		}
+
+		// Get stub file
+		const stubFile = Bun.file(join(getRootPath(), 'stubs/repository.stub'));
+
+		// Format the stub content
+		const stub = formatter(await stubFile.text(), {
+			...answers,
+			module: answers.module ?? 'root',
+			model_name: snake(answers.model.replace('Model', ''))
+		});
+
+		const path = answers.module ? await getModulePath(answers.module) : './src';
+
+		// Write to file
+		const name = snake(answers.name.replace('Repository', ''));
+		const file = Bun.file(`${path}/repositories/${name}.repository.ts`);
+		await file.write(stub);
+
+		this.success(`Repository ${this.bold(file.name!)} created successfully.`);
+	}
+}

package/src/commands/make_service.ts

@@ -0,0 +1,201 @@
+// 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 type { PromptObject } from 'prompts';
+
+import { join } from 'node:path';
+
+import { Command, CommandArgumentType } from '@elysiumjs/core';
+import prompts from 'prompts';
+import { snake } from 'radash';
+import formatter from 'string-template';
+
+import { getModulePath, parseProjectConfig } from '../config';
+import { getRootPath } from '../utils';
+
+/**
+ * Maker command for creating Elysium services.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export class MakeServiceCommand extends Command {
+	public static readonly command: string = 'make:service';
+	public static readonly description: string = 'Creates a new service.';
+
+	@Command.arg({
+		description: 'The name of the service to create',
+		type: CommandArgumentType.STRING
+	})
+	private name?: string;
+
+	@Command.arg({
+		description: 'The module where the service will be created',
+		type: CommandArgumentType.STRING
+	})
+	private module?: string;
+
+	@Command.arg({
+		description: 'The alias of the service to create',
+		type: CommandArgumentType.STRING
+	})
+	private alias?: string;
+
+	@Command.arg({
+		description: 'Create a factory service',
+		type: CommandArgumentType.BOOLEAN,
+		default: false
+	})
+	private factory: boolean = false;
+
+	@Command.arg({
+		description: 'Create a singleton service',
+		type: CommandArgumentType.BOOLEAN,
+		default: false
+	})
+	private singleton: boolean = false;
+
+	public async run(): Promise<void> {
+		if (!this.name) {
+			return this.setup();
+		}
+
+		const config = await parseProjectConfig();
+
+		const answers: Record<string, any> = {
+			module: this.module,
+			name: this.name,
+			alias: this.alias,
+			scope: this.factory ? 'FACTORY' : this.singleton ? 'SINGLETON' : 'SINGLETON'
+		};
+
+		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
+				}))
+			});
+
+			answers.module = module.module;
+		}
+
+		return this.build(answers);
+	}
+
+	private async setup(): Promise<void> {
+		const config = await parseProjectConfig();
+
+		const items: PromptObject[] = [
+			{
+				type() {
+					return config.mono ? null : 'select';
+				},
+				name: 'module',
+				message: 'Module:',
+				choices() {
+					return Object.keys(config.modules ?? {}).map((moduleName) => ({
+						title: moduleName,
+						value: moduleName
+					}));
+				}
+			},
+			{
+				type: 'text',
+				name: 'name',
+				message: 'Service Name:',
+				initial: 'UserService',
+				validate(value: string) {
+					if (value.length < 1) {
+						return 'Service name cannot be empty';
+					}
+
+					return true;
+				}
+			},
+			{
+				type: 'text',
+				name: 'alias',
+				message: 'Service Alias:',
+				initial(_, values) {
+					return values.name;
+				},
+				validate(value: string) {
+					if (value.length < 1) {
+						return 'Service alias cannot be empty';
+					}
+
+					return true;
+				}
+			},
+			{
+				type: 'select',
+				name: 'scope',
+				message: 'Service Scope:',
+				choices: [
+					{
+						title: 'SINGLETON',
+						value: 'SINGLETON',
+						description: 'A single instance of the service is created.'
+					},
+					{
+						title: 'FACTORY',
+						value: 'FACTORY',
+						description: 'A new instance of the service is created each time it is injected.'
+					}
+				]
+			}
+		];
+
+		const answers = await prompts(items, {
+			onCancel: () => {
+				this.error('Operation cancelled.');
+				process.exit(0);
+			}
+		});
+
+		return this.build(answers);
+	}
+
+	private async build(answers: Record<string, any>): Promise<void> {
+		if (!answers.name) {
+			this.error('Operation cancelled.');
+			return;
+		}
+
+		if (!answers.name.endsWith('Service')) {
+			answers.name += 'Service';
+		}
+
+		if (!answers.alias) {
+			answers.alias = answers.name;
+		}
+
+		// Get stub file
+		const stubFile = Bun.file(join(getRootPath(), 'stubs/service.stub'));
+
+		// Format the stub content
+		const stub = formatter(await stubFile.text(), answers);
+
+		const path = answers.module ? await getModulePath(answers.module) : './src';
+
+		// Write to file
+		const name = snake(answers.name.replace('Service', ''));
+		const file = Bun.file(`${path}/services/${name}.service.ts`);
+		await file.write(stub);
+
+		this.success(`Service ${this.bold(file.name!)} created successfully.`);
+	}
+}

package/src/commands/make_validator.ts

@@ -0,0 +1,147 @@
+// 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 type { PromptObject } from 'prompts';
+
+import { join } from 'node:path';
+
+import { Command, CommandArgumentType } from '@elysiumjs/core';
+import prompts from 'prompts';
+import { snake } from 'radash';
+import formatter from 'string-template';
+
+import { getModulePath, parseProjectConfig } from '../config';
+import { getRootPath } from '../utils';
+
+/**
+ * Maker command for creating Elysium validators.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export class MakeValidatorCommand extends Command {
+	public static readonly command: string = 'make:validator';
+	public static readonly description: string = 'Creates a new validator.';
+
+	@Command.arg({
+		description: 'The name of the validator to create',
+		type: CommandArgumentType.STRING
+	})
+	private name?: string;
+
+	@Command.arg({
+		description: 'The module where the validator will be created',
+		type: CommandArgumentType.STRING
+	})
+	private module?: string;
+
+	public async run(): Promise<void> {
+		if (!this.name) {
+			return this.setup();
+		}
+
+		const config = await parseProjectConfig();
+
+		const answers: Record<string, any> = {
+			module: this.module,
+			name: this.name
+		};
+
+		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
+				}))
+			});
+
+			answers.module = module.module;
+		}
+
+		return this.build(answers);
+	}
+
+	private async setup(): Promise<void> {
+		const config = await parseProjectConfig();
+
+		const items: PromptObject[] = [
+			{
+				type() {
+					return config.mono ? null : 'select';
+				},
+				name: 'module',
+				message: 'Module:',
+				choices() {
+					return Object.keys(config.modules ?? {}).map((moduleName) => ({
+						title: moduleName,
+						value: moduleName
+					}));
+				}
+			},
+			{
+				type: 'text',
+				name: 'name',
+				message: 'Validator Name:',
+				initial: 'LoginValidator',
+				validate(value: string) {
+					if (value.length < 1) {
+						return 'Validator name cannot be empty';
+					}
+
+					return true;
+				}
+			}
+		];
+
+		const answers = await prompts(items, {
+			onCancel: () => {
+				this.error('Operation cancelled.');
+				process.exit(0);
+			}
+		});
+
+		return this.build(answers);
+	}
+
+	private async build(answers: Record<string, any>): Promise<void> {
+		if (!answers.name) {
+			this.error('Operation cancelled.');
+			return;
+		}
+
+		if (!answers.name.endsWith('Validator')) {
+			answers.name += 'Validator';
+		}
+
+		if (!answers.request_name) {
+			answers.request_name = answers.name.replace('Validator', 'Request');
+		}
+
+		// Get stub file
+		const stubFile = Bun.file(join(getRootPath(), 'stubs/validator.stub'));
+
+		// Format the stub content
+		const stub = formatter(await stubFile.text(), answers);
+
+		const path = answers.module ? await getModulePath(answers.module) : './src';
+
+		// Write to file
+		const name = snake(answers.name.replace('Validator', ''));
+		const file = Bun.file(`${path}/validators/${name}.validator.ts`);
+		await file.write(stub);
+
+		this.success(`Validator ${this.bold(file.name!)} created successfully.`);
+	}
+}

package/src/commands/migration_generate.ts

@@ -0,0 +1,80 @@
+// 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 } 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>
+ */
+export class MigrationGenerateCommand extends Command {
+	public static readonly command: string = 'migration:generate';
+	public static readonly description: string = 'Generates migration files.';
+
+	@Command.arg({
+		description: 'The name of the migration to create',
+		type: CommandArgumentType.STRING
+	})
+	private name?: string;
+
+	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';
+							}
+
+							return true;
+						}
+					}
+				],
+				{
+					onCancel: () => {
+						this.error('Operation cancelled.');
+						process.exit(0);
+					}
+				}
+			);
+
+			this.name = answers.name;
+		}
+
+		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 ${projectRoot}/src/database/migrations --prefix timestamp --name ${this.name}`;
+
+		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, ''));
+		}
+	}
+}