@elysiumjs/styx 0.2.0 → 0.4.0

package/src/commands/make_service.ts

@@ -0,0 +1,196 @@
+// 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);
+
+		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,142 @@
+// 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);
+
+		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,69 @@
+// 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';
+
+/**
+ * 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;
+					}
+				}
+			]);
+
+			this.name = answers.name;
+		}
+
+		let schemaPath = `./src/database/schemas`;
+		if (await exists(`${process.cwd()}/src/database/schema.ts`)) {
+			schemaPath = `./src/database/schema.ts`;
+		}
+
+		await Bun.$`bunx --bun drizzle-kit generate --dialect postgresql --schema ${schemaPath} --out ./src/database/migrations --prefix timestamp --name ${this.name}`;
+
+		const sqlFiles = new Bun.Glob(`${process.cwd()}/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, ''));
+		}
+	}
+}

package/src/commands/migration_run.ts

@@ -0,0 +1,145 @@
+// 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 { basename } from 'node:path';
+
+import { Command, CommandArgumentType, Database } from '@elysiumjs/core';
+import prompts from 'prompts';
+import { alphabetical } from 'radash';
+
+/**
+ * Execute migration files.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export class MigrationRunCommand extends Command {
+	public static readonly command: string = 'migration:run';
+	public static readonly description: string = 'Generates migration files.';
+
+	@Command.arg({
+		description: 'The name of the tenant in which the migrations will be executed.',
+		type: CommandArgumentType.STRING,
+		required: true
+	})
+	private tenant: string = '';
+
+	@Command.arg({
+		description: 'The name of the connection to use.',
+		type: CommandArgumentType.STRING,
+		default: 'default'
+	})
+	private connection: string = 'default';
+
+	@Command.arg({
+		description: 'Drop the entire schema before running the migrations.',
+		type: CommandArgumentType.BOOLEAN,
+		default: false
+	})
+	private fresh: boolean = false;
+
+	public async run(): Promise<void> {
+		if (!Database.connectionExists(this.connection)) {
+			this.error(`Connection ${this.bold(this.connection)} does not exist.`);
+			return process.exit(1);
+		}
+
+		const sql = Database.getConnection(this.connection).$client;
+		await sql.connect();
+
+		await sql.begin(async (sql) => {
+			if (this.fresh) {
+				await sql`DROP SCHEMA IF EXISTS ${sql(this.tenant)} CASCADE;`;
+				await sql`CREATE SCHEMA ${sql(this.tenant)};`;
+			}
+
+			const [{ schema_exists }] = await sql`SELECT EXISTS (
+			SELECT schema_name
+			  FROM information_schema.schemata
+			 WHERE schema_name = ${this.tenant}
+		) AS schema_exists;`;
+
+			if (!schema_exists) {
+				const answers = await prompts([
+					{
+						type: 'confirm',
+						name: 'create',
+						message: `Schema ${this.tenant} does not exist. Do you want to create it?`,
+						initial: true
+					}
+				]);
+
+				if (answers.create) {
+					await sql`CREATE SCHEMA ${sql(this.tenant)};`;
+				} else {
+					this.error(`Schema ${this.bold(this.tenant)} creation cancelled.`);
+					return process.exit(1);
+				}
+			}
+
+			await sql`SET search_path TO ${sql(this.tenant)};`;
+
+			const [{ table_exists }] = await sql`SELECT EXISTS (
+			SELECT *
+			  FROM information_schema.tables
+			 WHERE table_name = 'elysium_migrations' 
+			   AND table_schema = ${this.tenant}
+		) AS table_exists;`;
+
+			if (!table_exists) {
+				await sql`CREATE TABLE elysium_migrations (
+				id SERIAL PRIMARY KEY,
+				name TEXT NOT NULL,
+				batch INTEGER NOT NULL,
+				applied_at TIMESTAMP NOT NULL
+			);`;
+			}
+
+			const migrations: { name: string }[] = await sql`SELECT name FROM elysium_migrations;`;
+			const completedMigrations = migrations.map((row) => row.name);
+
+			const filesIt = new Bun.Glob(`./src/database/migrations/**/*.sql`).scan({
+				absolute: true,
+				onlyFiles: true
+			});
+
+			const files = await Array.fromAsync(filesIt);
+			const sqlFiles = alphabetical(
+				files.filter((file) => !completedMigrations.includes(basename(file))),
+				(file) => file
+			);
+
+			if (sqlFiles.length === 0) {
+				this.success('No new migrations to apply.');
+				return;
+			}
+
+			const s = this.spinner(`Running migrations for tenant ${this.bold(this.tenant)}...`);
+
+			const [{ max }]: [{ max?: number }] =
+				await sql`SELECT MAX(batch) + 1 AS max FROM elysium_migrations;`;
+
+			const batch = max ?? 0;
+
+			for (const path of sqlFiles) {
+				await sql.file(path);
+				const [{ name }] =
+					await sql`INSERT INTO elysium_migrations (name, batch, applied_at) VALUES (${basename(path)}, ${batch}, ${new Date()}) RETURNING name;`;
+				s.pause(`Migration ${this.bold(name)} applied successfully.`);
+			}
+
+			s.complete(`Migrations for tenant ${this.bold(this.tenant)} applied successfully.`);
+		});
+
+		await sql.close();
+	}
+}

package/src/config.ts

@@ -0,0 +1,99 @@
+// 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 { resolve } from 'node:path';
+
+/**
+ * Describes the Elysium project's configuration.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export interface ProjectConfig {
+	/**
+	 * The name of the Elysium project.
+	 */
+	projectName: string;
+
+	/**
+	 * Whether the Elysium project is a mono module.
+	 */
+	mono: boolean;
+
+	/**
+	 * A map of module names to their paths.
+	 *
+	 * Only used if the Elysium project is not a mono module.
+	 */
+	modules?: Record<string, string>;
+}
+
+/**
+ * Parses the Elysium project's configuration file.
+ * @author Axel Nana <axel.nana@workbud.com>
+ * @throws If the Elysium config file is not found.
+ * @returns The Elysium project's configuration.
+ */
+export const parseProjectConfig = async (): Promise<ProjectConfig> => {
+	const config = Bun.file(resolve('.elysiumrc'));
+	if (!config.exists()) {
+		throw new Error('Elysium config file not found.');
+	}
+
+	return JSON.parse(await config.text());
+};
+
+/**
+ * Writes the Elysium project's configuration file.
+ * @author Axel Nana <axel.nana@workbud.com>
+ * @param config The Elysium project's configuration.
+ */
+export const writeProjectConfig = async (config: ProjectConfig) => {
+	const file = Bun.file(resolve('.elysiumrc'));
+	await file.write(JSON.stringify(config, null, 2));
+};
+
+/**
+ * Checks if the Elysium project is a mono-module project.
+ * @author Axel Nana <axel.nana@workbud.com>
+ * @returns Whether the Elysium project is a mono module.
+ */
+export const isMonoModule = async () => {
+	const config = await parseProjectConfig();
+	return config.mono;
+};
+
+/**
+ * Gets the path of a module.
+ * @author Axel Nana <axel.nana@workbud.com>
+ * @param moduleName The name of the module.
+ * @returns The path of the module.
+ */
+export const getModulePath = async (moduleName: string) => {
+	const config = await parseProjectConfig();
+	if (config.mono) {
+		return './src';
+	}
+
+	return config.modules![moduleName];
+};
+
+/**
+ * Checks if a module exists.
+ * @author Axel Nana <axel.nana@workbud.com>
+ * @param moduleName The name of the module.
+ * @returns Whether the module exists.
+ */
+export const moduleExists = async (moduleName: string) => {
+	const path = await getModulePath(moduleName);
+	return Bun.file(path).exists();
+};

package/src/utils.ts

@@ -0,0 +1,23 @@
+// 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 { dirname } from 'node:path';
+
+/**
+ * Gets the root path of the styx package.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export const getRootPath = () => {
+	return dirname(Bun.fileURLToPath(import.meta.url));
+};