@elysiumjs/styx 0.3.0 → 0.5.0

package/src/commands/make_job.ts

@@ -0,0 +1,183 @@
+// 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 class for creating Elysium.js jobs.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export class MakeJobCommand extends Command {
+	public static readonly command: string = 'make:job';
+	public static readonly description: string = 'Creates a new job.';
+
+	@Command.arg({
+		description: 'The name of the job to create',
+		type: CommandArgumentType.STRING
+	})
+	private name?: string;
+
+	@Command.arg({
+		description: 'The module where the job will be created',
+		type: CommandArgumentType.STRING
+	})
+	private module?: string;
+
+	@Command.arg({
+		description: 'The alias of the job to create',
+		type: CommandArgumentType.STRING
+	})
+	private alias?: string;
+
+	@Command.arg({
+		description: 'The name of the queue where the job will be dispatched',
+		type: CommandArgumentType.STRING,
+		default: 'default'
+	})
+	private queue: string = 'default';
+
+	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,
+			queue: this.queue ?? 'default'
+		};
+
+		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: 'Job Name:',
+				initial: 'SendEmailJob',
+				validate(value: string) {
+					if (value.length < 1) {
+						return 'Job name cannot be empty';
+					}
+
+					return true;
+				}
+			},
+			{
+				type: 'text',
+				name: 'alias',
+				message: 'Job Alias:',
+				initial(_, values) {
+					return values.name;
+				},
+				validate(value: string) {
+					if (value.length < 1) {
+						return 'Job alias cannot be empty';
+					}
+
+					return true;
+				}
+			},
+			{
+				type: 'text',
+				name: 'queue',
+				message: 'Job Queue:',
+				initial: 'default'
+			}
+		];
+
+		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('Job')) {
+			answers.name += 'Job';
+		}
+
+		if (!answers.alias) {
+			answers.alias = answers.name;
+		}
+
+		// Get stub file
+		const stubFile = Bun.file(join(getRootPath(), 'stubs/job.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('Job', ''));
+		const file = Bun.file(`${path}/jobs/${name}.job.ts`);
+		await file.write(stub);
+
+		this.success(`Job ${this.bold(file.name!)} created successfully.`);
+	}
+}

package/src/commands/make_middleware.ts

@@ -0,0 +1,143 @@
+// 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 class for creating Elysium.js middlewares.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export class MakeMiddlewareCommand extends Command {
+	public static readonly command: string = 'make:middleware';
+	public static readonly description: string = 'Creates a new middleware.';
+
+	@Command.arg({
+		description: 'The name of the middleware to create',
+		type: CommandArgumentType.STRING
+	})
+	private name?: string;
+
+	@Command.arg({
+		description: 'The module where the middleware 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: 'Middleware Name:',
+				initial: 'AuthMiddleware',
+				validate(value: string) {
+					if (value.length < 1) {
+						return 'Middleware 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('Middleware')) {
+			answers.name += 'Middleware';
+		}
+
+		// Get stub file
+		const stubFile = Bun.file(join(getRootPath(), 'stubs/middleware.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('Middleware', ''));
+		const file = Bun.file(`${path}/middlewares/${name}.middleware.ts`);
+		await file.write(stub);
+
+		this.success(`Middleware ${this.bold(file.name!)} created successfully.`);
+	}
+}

package/src/commands/make_model.ts

@@ -0,0 +1,205 @@
+// 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 { pascal, snake, trim } from 'radash';
+import formatter from 'string-template';
+
+import { getModulePath, parseProjectConfig } from '../config';
+import { getRootPath } from '../utils';
+
+/**
+ * Maker command for creating Elysium.js models.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export class MakeModelCommand extends Command {
+	public static readonly command: string = 'make:model';
+	public static readonly description: string = 'Creates a new model.';
+
+	@Command.arg({
+		description: 'The name of the model to create',
+		type: CommandArgumentType.STRING
+	})
+	private name?: string;
+
+	@Command.arg({
+		description: 'The module where the model will be created',
+		type: CommandArgumentType.STRING
+	})
+	private module?: string;
+
+	@Command.arg({
+		name: 'table',
+		description: 'The name of the table wrapped by the model',
+		type: CommandArgumentType.STRING
+	})
+	private tableName?: string;
+
+	@Command.arg({
+		name: 'support-tenancy',
+		description: 'Support tenancy',
+		type: CommandArgumentType.BOOLEAN,
+		default: false
+	})
+	private supportTenancy: boolean = false;
+
+	public async run(): Promise<void> {
+		if (!this.name || !this.tableName) {
+			return this.setup();
+		}
+
+		const config = await parseProjectConfig();
+
+		const answers: Record<string, any> = {
+			module: this.module,
+			table: this.tableName,
+			name: this.name,
+			supportTenancy: this.supportTenancy
+		};
+
+		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
+					}))
+				},
+				{
+					onCancel: () => process.exit(1)
+				}
+			);
+
+			answers.module = module.module;
+		}
+
+		if (!answers.name) {
+			answers.name = trim(pascal(answers.table), 's');
+		}
+
+		answers.canonicalName = answers.name;
+
+		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: 'table',
+				message: 'Table Name:',
+				initial: 'users',
+				validate(value: string) {
+					if (value.length < 1) {
+						return 'Table name cannot be empty';
+					}
+
+					return true;
+				}
+			},
+			{
+				type: 'text',
+				name: 'name',
+				message: 'Model Name:',
+				initial(_, values) {
+					return trim(pascal(values.table), 's');
+				},
+				validate(value: string) {
+					if (value.length < 1) {
+						return 'Model name cannot be empty';
+					}
+
+					return true;
+				}
+			},
+			{
+				type: 'select',
+				name: 'supportTenancy',
+				message: 'Support Tenancy:',
+				choices: [
+					{
+						title: 'Yes',
+						value: true,
+						description: 'The model supports multi-tenancy.'
+					},
+					{
+						title: 'No',
+						value: false,
+						description: 'The model does not support multi-tenancy.'
+					}
+				]
+			}
+		];
+
+		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('Model')) {
+			answers.name += 'Model';
+		}
+
+		answers.canonicalName = answers.name.replace('Model', '');
+
+		// Get stub file
+		const stubFile = Bun.file(join(getRootPath(), 'stubs/model.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('Model', ''));
+		const file = Bun.file(`${path}/models/${name}.model.ts`);
+		await file.write(stub);
+
+		this.success(`Model ${this.bold(file.name!)} created successfully.`);
+	}
+}