@elysiumjs/core 0.4.3 → 0.5.0

package/src/job.ts

@@ -1,196 +0,0 @@
-// 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 'reflect-metadata';
-
-import type { Class } from 'type-fest';
-
-import { assign, uid } from 'radash';
-
-import { InteractsWithConsole } from './console';
-import { Service } from './service';
-import { Symbols } from './utils';
-
-/**
- * Properties required when declaring a job using the `@job()` decorator.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export type JobProps = {
-	/**
-	 * The name of the job.
-	 */
-	name?: string;
-
-	/**
-	 * The queue on which the job should be processed.
-	 */
-	queue?: string;
-};
-
-/**
- * Base class for background jobs.
- *
- * Jobs are classes that can be executed in the background. They provide
- * an abstract execute method that serves as the entry point for the job.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export abstract class Job extends InteractsWithConsole {
-	#startedAt?: Date;
-	#completedAt?: Date;
-	#status: JobStatus = JobStatus.PENDING;
-	#err?: Error;
-
-	/**
-	 * Marks a class as a job.
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 * @param options The decorator options.
-	 */
-	public static register(options: JobProps = {}) {
-		return function (target: Class<Job>) {
-			options = assign({ name: target.name, queue: 'default' }, options);
-
-			const name = `job.${options.name}`;
-
-			Service.instance(name, target);
-
-			Reflect.defineMetadata(Symbols.job, { name, queue: options.queue }, target);
-		};
-	}
-
-	/**
-	 * Unique identifier for the job.
-	 */
-	public readonly id: string;
-
-	/**
-	 * The timestamp when the job was created.
-	 */
-	public readonly createdAt: Date;
-
-	/**
-	 * The timestamp when the job started execution.
-	 */
-	public get startedAt(): Date | undefined {
-		return this.#startedAt;
-	}
-
-	/**
-	 * The timestamp when the job completed execution.
-	 */
-	public get completedAt(): Date | undefined {
-		return this.#completedAt;
-	}
-
-	/**
-	 * The current status of the job.
-	 */
-	public get status(): JobStatus {
-		return this.#status;
-	}
-
-	/**
-	 * Creates a new job instance.
-	 *
-	 * @param id Optional job ID. If not provided, a random ID will be generated.
-	 */
-	constructor(id?: string) {
-		super();
-		this.id = id || this.generateJobId();
-		this.createdAt = new Date();
-	}
-
-	/**
-	 * Run the job.
-	 * This method handles the job lifecycle and calls the execute method.
-	 */
-	public async run(): Promise<void> {
-		try {
-			this.#status = JobStatus.RUNNING;
-			this.#startedAt = new Date();
-
-			this.debug(`Job ${this.id} started at ${this.#startedAt.toISOString()}`);
-
-			// Execute the job implementation
-			await this.execute();
-
-			this.#status = JobStatus.COMPLETED;
-			this.#completedAt = new Date();
-
-			this.debug(`Job ${this.id} completed at ${this.#completedAt.toISOString()}`);
-		} catch (err) {
-			this.#err = err instanceof Error ? err : new Error(String(err));
-
-			if (this.#status !== JobStatus.CANCELLED) {
-				this.#status = JobStatus.FAILED;
-			}
-
-			this.#completedAt = new Date();
-
-			this.trace(this.#err);
-		}
-	}
-
-	/**
-	 * Cancels the job.
-	 */
-	public cancel(): void {
-		this.#status = JobStatus.CANCELLED;
-	}
-
-	/**
-	 * The main execution method for the job.
-	 * This must be implemented by all job classes.
-	 */
-	protected abstract execute(): Promise<void>;
-
-	/**
-	 * Generate a random job ID.
-	 * @returns A random job ID.
-	 */
-	private generateJobId(): string {
-		return `job_${Date.now()}_${uid(8)}`;
-	}
-}
-
-/**
- * Possible statuses for a job.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export enum JobStatus {
-	/**
-	 * The job is in pending state, meaning it has been added to the queue but has not yet been processed.
-	 */
-	PENDING = 'pending',
-
-	/**
-	 * The job is in running state, meaning it is currently being processed.
-	 */
-	RUNNING = 'running',
-
-	/**
-	 * The job has completed successfully.
-	 */
-	COMPLETED = 'completed',
-
-	/**
-	 * The job has failed to complete successfully. If there are enough retries left, the job will be restarted.
-	 */
-	FAILED = 'failed',
-
-	/**
-	 * The job has been cancelled by the user or another job.
-	 */
-	CANCELLED = 'cancelled'
-}

package/src/middleware.ts

@@ -1,164 +0,0 @@
-// 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 { AnyElysia } from 'elysia';
-import type { Class } from 'type-fest';
-import type { Context } from './http';
-
-import { Application } from './app';
-import { Service } from './service';
-import { Symbols } from './utils';
-
-/**
- * Execute a chain of middlewares, stopping on the first return or throw.
- * @author Axel Nana <axel.nana@workbud.com>
- * @param middlewares The list of middleware instances to execute.
- * @param context The context to pass to each middleware.
- * @param method The method to call on each middleware.
- */
-export const executeMiddlewareChain = (
-	middlewares: Middleware[],
-	context: any,
-	method: Exclude<keyof Middleware, 'guards'>
-): Promise<any> => {
-	return Application.context.run(
-		new Map([
-			['tenant', context.tenant],
-			['http:context', context]
-		]),
-		async () => {
-			for (const middleware of middlewares) {
-				try {
-					const result = await middleware[method](context);
-					if (result !== undefined) {
-						return result; // Stop the chain if middleware returns a value
-					}
-				} catch (error) {
-					throw error; // Stop the chain and propagate the error
-				}
-			}
-		}
-	);
-};
-
-/**
- * Apply a list of middlewares to an Elysia plugin.
- * @author Axel Nana <axel.nana@workbud.com>
- * @param middlewares The list of middlewares to apply.
- * @param plugin The Elysia plugin instance.
- */
-export const applyMiddlewares = (middlewares: Class<Middleware>[], plugin: AnyElysia) => {
-	const mi = middlewares.map((middleware) => Service.make<Middleware>(middleware));
-
-	plugin.onRequest((c) => {
-		return executeMiddlewareChain(mi, c, 'onRequest');
-	});
-
-	plugin.onTransform((c) => {
-		return executeMiddlewareChain(mi, c, 'onTransform');
-	});
-
-	plugin.onBeforeHandle((c) => {
-		return executeMiddlewareChain(mi, c, 'onBeforeHandle');
-	});
-
-	plugin.onAfterHandle((c) => {
-		return executeMiddlewareChain(mi, c, 'onAfterHandle');
-	});
-
-	plugin.onAfterResponse((c) => {
-		return executeMiddlewareChain(mi, c, 'onAfterResponse');
-	});
-};
-
-/**
- * Base class for middleware.
- * @author Axel Nana <axel.nana@workbud.com>
- * @template TGuards The list of guards for the middleware.
- */
-export abstract class Middleware<TGuards extends string[] = []> {
-	/**
-	 * Registers a list of middlewares to be applied on a controller or endpoint.
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 * @param middlewares The list of middlewares to apply.
-	 */
-	public static register(...middlewares: Class<Middleware>[]): ClassDecorator & MethodDecorator {
-		return function (
-			target: Object,
-			propertyKey?: string | symbol,
-			descriptor?: PropertyDescriptor
-		) {
-			if (propertyKey === undefined && descriptor === undefined) {
-				const m = Reflect.getMetadata(Symbols.middlewares, target) ?? [];
-				m.push(...middlewares);
-				Reflect.defineMetadata(Symbols.middlewares, m, target);
-			} else {
-				const m = Reflect.getMetadata(Symbols.middlewares, target, propertyKey!) ?? [];
-				m.push(...middlewares);
-				Reflect.defineMetadata(Symbols.middlewares, m, target, propertyKey!);
-			}
-		};
-	}
-
-	/**
-	 * Creates a guarded version of the middleware.
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 * @param guards The list of guards for the middleware.
-	 * @returns A middleware class decorated with guards.
-	 */
-	public static guards(guards: string[]): Class<Middleware> {
-		class GuardedMiddleware extends this {}
-		Reflect.defineMetadata(Symbols.middlewareGuards, guards, GuardedMiddleware);
-		return GuardedMiddleware;
-	}
-
-	/**
-	 * Gets the list of guards for the middleware.
-	 */
-	public get guards(): TGuards {
-		return Reflect.getMetadata(Symbols.middlewareGuards, this.constructor) ?? [];
-	}
-
-	/**
-	 * Called first before everything else. This middleware hook works only when used on
-	 * a controller, a module, or the application.
-	 * @param ctx The request context.
-	 */
-	public onRequest(ctx: Context): any {}
-
-	/**
-	 * Called before validation, but after the request has been parsed.
-	 * Use this method to modify the request inputs before validation.
-	 * @param ctx The request context.
-	 */
-	public onTransform(ctx: Context): any {}
-
-	/**
-	 * Called after the request has been handled, but before the response is sent.
-	 * @param ctx The request context.
-	 */
-	public onAfterHandle(ctx: Context): any {}
-
-	/**
-	 * Called before the request is handled.
-	 * @param ctx The request context.
-	 */
-	public onBeforeHandle(ctx: Context): any {}
-
-	/**
-	 * Called after the response has been sent.
-	 * @param ctx The request context.
-	 */
-	public onAfterResponse(ctx: Context): any {}
-}