@elysiumjs/core 0.3.0 → 0.3.2

package/README.md

@@ -109,4 +109,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](../../LICENSE) file for more information.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@elysiumjs/core",
-	"version": "0.3.0",
+	"version": "0.3.2",
 	"license": "Apache-2.0",
 	"description": "A super-charged web framework for Bun, built on top of ElysiaJS.",
 	"private": false,
@@ -41,7 +41,7 @@
 		"@types/bun": "latest"
 	},
 	"peerDependencies": {
-		"typescript": "^5"
+		"typescript": "^5.8.3"
 	},
 	"trustedDependencies": [
 		"es5-ext"

package/src/env.ts

@@ -32,10 +32,14 @@ export namespace Env {
 	 * Gets the value of an environment variable.
 	 * @author Axel Nana <axel.nana@workbud.com>
 	 * @param name The name of the environment variable.
+	 * @param defaultValue The default value to return if the environment variable is not set.
 	 * @returns The value of the environment variable.
 	 */
-	export const get = <TKey extends keyof AppEnv>(name: TKey): AppEnv[TKey] => {
-		return env.get(name) as AppEnv[TKey];
+	export const get = <TKey extends keyof AppEnv>(
+		name: TKey,
+		defaultValue?: AppEnv[TKey]
+	): AppEnv[TKey] => {
+		return (env.get(name) ?? defaultValue) as AppEnv[TKey];
 	};
 
 	/**

package/src/middleware.ts

@@ -30,7 +30,7 @@ import { Symbols } from './utils';
 export const executeMiddlewareChain = (
 	middlewares: Middleware[],
 	context: any,
-	method: keyof Middleware
+	method: Exclude<keyof Middleware, 'guards'>
 ): Promise<any> => {
 	return Application.context.run(
 		new Map([
@@ -102,6 +102,25 @@ export abstract class Middleware {
 		};
 	}
 
+	/**
+	 * 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(): string[] {
+		return Reflect.getMetadata(Symbols.middlewareGuards, this.constructor) ?? [];
+	}
+
 	/**
 	 * Called after the request has been handled, but before the response is sent.
 	 * @param ctx The request context.

package/src/model.ts

@@ -101,6 +101,7 @@ const parseTypes = (element: PgColumn) => {
  * @template TTable The drizzle's table schema wrapped by the repository.
  */
 export type ModelClass<
+	TTableName extends string,
 	TColumnsMap extends Record<string, PgColumnBuilderBase>,
 	TTable extends PgTable = ReturnType<typeof pgTable<string, TColumnsMap>>
 > = {
@@ -128,7 +129,7 @@ export type ModelClass<
 	/**
 	 * The name of the table wrapped by the model.
 	 */
-	readonly tableName: string;
+	readonly tableName: TTableName;
 
 	/**
 	 * The table columns configuration.
@@ -173,8 +174,11 @@ export type ModelClass<
  * @param tableName The name of the table.
  * @param columns The table columns configuration.
  */
-export const Model = <TColumnsMap extends Record<string, PgColumnBuilderBase>>(
-	tableName: string,
+export const Model = <
+	TTableName extends string,
+	TColumnsMap extends Record<string, PgColumnBuilderBase>
+>(
+	tableName: TTableName,
 	columns: TColumnsMap
 ) => {
 	const table = pgTable(tableName, columns);
@@ -198,7 +202,7 @@ export const Model = <TColumnsMap extends Record<string, PgColumnBuilderBase>>(
 		/**
 		 * The drizzle's table schema wrapped by this model.
 		 */
-		public static get table(): ReturnType<typeof pgTable<string, TColumnsMap>> {
+		public static get table(): ReturnType<typeof pgTable<TTableName, TColumnsMap>> {
 			// If we are not inside an Application context, we can't use the tenancy system
 			if (!Application.instance || !Application.context.getStore) {
 				return table;
@@ -207,7 +211,7 @@ export const Model = <TColumnsMap extends Record<string, PgColumnBuilderBase>>(
 			if (this.supportTenancy) {
 				const tenant = Tenancy.getCurrentTenant() ?? 'public';
 				// @ts-expect-error typeof this strangely doesn't match the ModelClass type
-				return Tenancy.withTenant(tenant, this);
+				return Tenancy.wrapTenant(tenant, this);
 			}
 
 			return table;
@@ -292,9 +296,13 @@ export namespace Tenancy {
 	 * @param model The model class that wraps the `PgTable`.
 	 * @returns The drizzle's table schema wrapped by the tenant.
 	 */
-	export const withTenant = <
-		T extends ModelClass<TColumnsMap>,
+	export const wrapTenant = <
+		T extends ModelClass<TTableName, TColumnsMap>,
+		TTableName extends string = T extends ModelClass<infer TTableName, infer TColumnsMap>
+			? TTableName
+			: string,
 		TColumnsMap extends Record<string, PgColumnBuilderBase> = T extends ModelClass<
+			TTableName,
 			infer TColumnsMap
 		>
 			? TColumnsMap
@@ -302,21 +310,21 @@ export namespace Tenancy {
 	>(
 		tenant: string,
 		model: T
-	): ReturnType<typeof pgTable<string, TColumnsMap>> => {
+	): ReturnType<typeof pgTable<TTableName, TColumnsMap>> => {
 		if (tenant === 'public') {
 			return pgTable(model.tableName, model.columns);
 		}
 
 		const tableName = `${tenant}.${model.tableName}`;
 		if (tenantSchemas.has(tableName)) {
-			return tenantSchemas.get(tableName)! as ReturnType<typeof pgTable<string, TColumnsMap>>;
+			return tenantSchemas.get(tableName)! as ReturnType<typeof pgTable<TTableName, TColumnsMap>>;
 		}
 
 		const tenantSchema = getTenantSchema(tenant);
 		const schemaTable = tenantSchema.table(model.tableName, model.columns);
 		tenantSchemas.set(tableName, schemaTable);
 
-		return schemaTable as unknown as ReturnType<typeof pgTable<string, TColumnsMap>>;
+		return schemaTable as unknown as ReturnType<typeof pgTable<TTableName, TColumnsMap>>;
 	};
 
 	/**
@@ -333,4 +341,20 @@ export namespace Tenancy {
 
 		return tenantSchema;
 	};
+
+	/**
+	 * Runs the given callback in a context with the given tenant.
+	 * @author Axel Nana <axel.nana@workbud.com>
+	 * @param tenant The name of the tenant.
+	 * @param callback The callback to run.
+	 * @returns The result of the callback.
+	 */
+	export const withTenant = <TReturn>(tenant: string, callback: () => TReturn): TReturn => {
+		const currentStore = Application.context.getStore();
+
+		const newStore = new Map(currentStore);
+		newStore.set('tenant', tenant);
+
+		return Application.context.run(newStore, callback);
+	};
 }

package/src/redis.ts

@@ -26,7 +26,7 @@ import { Service } from './service';
  * Properties used to create a new redis connection.
  * @author Axel Nana <axel.nana@workbud.com>
  */
-export type RedisConnectionProps = Bun.RedisOptions;
+export type RedisConnectionProps = Bun.RedisOptions & { url: string };
 
 /**
  * Keyv adapter for redis. This adapter is based on the Bun's Redis client.
@@ -361,7 +361,7 @@ export namespace Redis {
 	 * @param config The configuration for the redis connection.
 	 * @returns The newly created and registered redis connection.
 	 */
-	export const registerConnection = (name: string, config: Bun.RedisOptions) => {
+	export const registerConnection = (name: string, config: RedisConnectionProps) => {
 		if (Service.exists(getConnectionName(name))) {
 			// TODO: Use logger service here
 			console.error(`A connection with the name ${name} has already been registered.`);

package/src/utils.ts

@@ -17,25 +17,27 @@ import type { Elysia } from 'elysia';
 import { isObject, isPrimitive } from 'radash';
 
 export namespace Symbols {
-	export const app = Symbol('app');
+	export const app = Symbol('elysium:Application');
 
-	export const controller = Symbol('controller');
+	export const controller = Symbol('elysium:Controller');
 
-	export const middlewares = Symbol('middlewares');
+	export const middlewares = Symbol('elysium:MiddlewaresList');
 
-	export const services = Symbol('services');
+	export const services = Symbol('elysium:ServicesList');
 
-	export const websocket = Symbol('websocket');
+	export const websocket = Symbol('elysium:WebSocket');
 
-	export const wamp = Symbol('wamp');
+	export const wamp = Symbol('elysium:Wamp');
 
-	export const http = Symbol('http');
+	export const http = Symbol('elysium:Http');
 
-	export const job = Symbol('job');
+	export const job = Symbol('elysium:Job');
 
-	export const arg = Symbol('command:arguments');
+	export const arg = Symbol('elysium:CommandArguments');
 
-	export const elysiaPlugin = Symbol('elysia:plugin');
+	export const elysiaPlugin = Symbol('elysium:ElysiaPlugin');
+
+	export const middlewareGuards = Symbol('elysium:MiddlewareGuards');
 }
 
 export const nextTick = () => new Promise((resolve) => process.nextTick(resolve));