@elysiumjs/core 0.4.2 → 0.5.0

package/src/redis.ts

@@ -1,408 +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 { KeyvStoreAdapter } from 'cacheable';
-import type { KeyvEntry, StoredData } from 'keyv';
-
-import { EventEmitter } from 'node:events';
-
-import { omit } from 'radash';
-
-import { Event } from './event';
-import { Service } from './service';
-
-/**
- * Properties used to create a new redis connection.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export type RedisConnectionProps = Bun.RedisOptions & { url: string };
-
-/**
- * Keyv adapter for redis. This adapter is based on the Bun's Redis client.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
-	#client?: Bun.RedisClient;
-	#namespace: string | undefined;
-	#keyPrefixSeparator = '::';
-	#clearBatchSize = 1000;
-	#useUnlink = true;
-	#noNamespaceAffectsAll = false;
-
-	#connection: string;
-
-	constructor(props: {
-		/**
-		 * The Redis connection to use.
-		 */
-		connection: string;
-
-		/**
-		 * Namespace for the connection.
-		 */
-		namespace?: string;
-
-		/**
-		 * Separator to use between namespace and key.
-		 */
-		keyPrefixSeparator?: string;
-
-		/**
-		 * Number of keys to delete in a single batch.
-		 */
-		clearBatchSize?: number;
-
-		/**
-		 * Enable Unlink instead of using Del for clearing keys. This is more performant but may not be supported by all Redis versions.
-		 */
-		useUnlink?: boolean;
-
-		/**
-		 * Whether to allow clearing all keys when no namespace is set.
-		 * If set to true and no namespace is set, iterate() will return all keys.
-		 * Defaults to `false`.
-		 */
-		noNamespaceAffectsAll?: boolean;
-	}) {
-		super();
-
-		Event.once('elysium:app:launched', () => {
-			this.#client = Redis.getConnection(props.connection);
-		});
-
-		this.#connection = props.connection;
-		this.#namespace = props.namespace;
-		this.#keyPrefixSeparator = props.keyPrefixSeparator ?? '::';
-		this.#clearBatchSize = props.clearBatchSize ?? 1000;
-		this.#useUnlink = props.useUnlink ?? true;
-		this.#noNamespaceAffectsAll = props.noNamespaceAffectsAll ?? false;
-
-		this.on('error', (error) => {
-			Event.emit('elysium:error', error);
-		});
-	}
-
-	public get client() {
-		return this.#client!;
-	}
-
-	/**
-	 * Get the options for the adapter.
-	 */
-	public get opts() {
-		return {
-			namespace: this.#namespace,
-			keyPrefixSeparator: this.#keyPrefixSeparator,
-			clearBatchSize: this.#clearBatchSize,
-			noNamespaceAffectsAll: this.#noNamespaceAffectsAll,
-			dialect: 'redis',
-			url: this.#connection
-		};
-	}
-
-	/**
-	 * Gets the namespace for the adapter. If undefined, it will not use a namespace including keyPrefixing.
-	 * @default undefined
-	 */
-	public get namespace(): string | undefined {
-		return this.#namespace;
-	}
-
-	/**
-	 * Sets the namespace for the adapter. If undefined, it will not use a namespace including keyPrefixing.
-	 */
-	public set namespace(value: string | undefined) {
-		this.#namespace = value;
-	}
-
-	public async get<Value>(key: string): Promise<StoredData<Value> | undefined> {
-		key = this.createKeyPrefix(key, this.#namespace);
-		const value = await this.client.get(key);
-
-		return value === null ? undefined : (value as Value);
-	}
-
-	public async set(key: string, value: any, ttl?: number) {
-		key = this.createKeyPrefix(key, this.#namespace);
-
-		if (ttl) {
-			await this.client.set(key, value, 'PX', ttl);
-		} else {
-			await this.client.set(key, value);
-		}
-	}
-
-	public async setMany(values: Array<KeyvEntry>): Promise<void> {
-		// TODO: Use MULTI when available in Bun
-		const multi = [];
-
-		for (const { key, value, ttl } of values) {
-			const prefixedKey = this.createKeyPrefix(key, this.#namespace);
-			if (ttl) {
-				// eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-unsafe-argument
-				multi.push(this.client.set(prefixedKey, value, 'PX', ttl));
-			} else {
-				// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-				multi.push(this.client.set(prefixedKey, value));
-			}
-		}
-
-		await Promise.all(multi);
-	}
-
-	public async delete(key: string): Promise<boolean> {
-		key = this.createKeyPrefix(key, this.#namespace);
-		// TODO: Use UNLINK when available in Bun
-		const deleted = await (this.#useUnlink
-			? this.client.send('UNLINK', [key])
-			: this.client.del(key));
-
-		return deleted > 0;
-	}
-
-	public async clear(): Promise<void> {
-		try {
-			if (!this.#namespace && this.#noNamespaceAffectsAll) {
-				await this.client.send('FLUSHDB', []);
-				return;
-			}
-
-			let cursor = '0';
-			const batchSize = this.#clearBatchSize;
-			const match = this.#namespace ? `${this.#namespace}${this.#keyPrefixSeparator}*` : '*';
-			const deletePromises = [];
-
-			do {
-				const result = await this.client.send('SCAN', [
-					cursor,
-					'MATCH',
-					match,
-					'COUNT',
-					batchSize.toString(),
-					'TYPE',
-					'string'
-				]);
-
-				// Parse the result
-				let [newCursor, keys] = result;
-				cursor = newCursor.toString();
-
-				if (keys.length === 0) {
-					continue;
-				}
-
-				if (!this.#namespace) {
-					keys = keys.filter((key: string) => !key.includes(this.#keyPrefixSeparator));
-				}
-
-				deletePromises.push(keys.map((key: string) => this.client.del(key)));
-			} while (cursor !== '0');
-
-			await Promise.all(deletePromises);
-		} catch (error) {
-			this.emit('error', error);
-		}
-	}
-
-	public async has(key: string): Promise<boolean> {
-		key = this.createKeyPrefix(key, this.#namespace);
-		return this.client.exists(key);
-	}
-
-	public async hasMany(keys: string[]): Promise<boolean[]> {
-		const multi = [];
-
-		for (const key of keys) {
-			const prefixedKey = this.createKeyPrefix(key, this.#namespace);
-			multi.push(this.client.exists(prefixedKey));
-		}
-
-		return Promise.all(multi);
-	}
-
-	public async getMany<Value>(keys: string[]): Promise<Array<StoredData<Value | undefined>>> {
-		if (keys.length === 0) {
-			return [];
-		}
-
-		keys = keys.map((key) => this.createKeyPrefix(key, this.#namespace));
-		const values = await this.client.mget(...keys);
-
-		return values as Value[];
-	}
-
-	public async disconnect(): Promise<void> {
-		this.client.close();
-	}
-
-	public async deleteMany(keys: string[]): Promise<boolean> {
-		let result = false;
-
-		// TODO: Use MULTI when available in Bun
-		const multi = [];
-
-		for (const key of keys) {
-			const prefixedKey = this.createKeyPrefix(key, this.#namespace);
-			if (this.#useUnlink) {
-				multi.push(this.client.send('UNLINK', [prefixedKey]));
-			} else {
-				multi.push(this.client.del(prefixedKey));
-			}
-		}
-
-		const results = await Promise.all(multi);
-
-		for (const deleted of results) {
-			if (typeof deleted === 'number' && deleted > 0) {
-				result = true;
-			}
-		}
-
-		return result;
-	}
-
-	public async *iterator<Value>(
-		namespace?: string
-	): AsyncGenerator<Array<string | Awaited<Value> | undefined>, void> {
-		const match = namespace ? `${namespace}${this.#keyPrefixSeparator}*` : '*';
-		let cursor = '0';
-
-		do {
-			const result = await this.client.send('SCAN', [cursor, 'MATCH', match, 'TYPE', 'string']);
-
-			// Parse the result
-			let [newCursor, keys] = result;
-			cursor = newCursor.toString();
-
-			if (!namespace && !this.#noNamespaceAffectsAll) {
-				keys = keys.filter((key: string) => !key.includes(this.#keyPrefixSeparator));
-			}
-
-			if (keys.length > 0) {
-				const values = await this.client.mget(...keys);
-				for (const i of keys.keys()) {
-					const key = this.getKeyWithoutPrefix(keys[i], namespace);
-					const value = values[i];
-					yield [key, value!];
-				}
-			}
-		} while (cursor !== '0');
-	}
-
-	/**
-	 * Helper function to create a key with a namespace.
-	 * @param key The key to prefix.
-	 * @param namespace The namespace to prefix the key with.
-	 * @returns The key with the namespace such as 'namespace::key'.
-	 */
-	public createKeyPrefix(key: string, namespace?: string): string {
-		return !!namespace ? `${namespace}${this.#keyPrefixSeparator}${key}` : key;
-	}
-
-	/**
-	 * Helper function to remove the namespace from a key.
-	 * @param key The key to remove the namespace from.
-	 * @param namespace The namespace to remove from the key.
-	 * @returns The key without the namespace.
-	 */
-	public getKeyWithoutPrefix(key: string, namespace?: string): string {
-		return !!namespace ? key.replace(`${namespace}${this.#keyPrefixSeparator}`, '') : key;
-	}
-}
-
-export namespace Redis {
-	/**
-	 * Creates a service name for a redis connection.
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 * @param name The name of the connection.
-	 * @returns A service name for the connection.
-	 */
-	const getConnectionName = (name: string) => {
-		return `redis.connection.${name}`;
-	};
-
-	/**
-	 * Retrieves the client for a redis connection.
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 * @param name The name of the connection.
-	 * @returns The Bun.RedisClient for the connection with the given name.
-	 */
-	export const getConnection = (name: string) => {
-		if (!Service.exists(getConnectionName(name))) {
-			// TODO: Use logger service here
-			console.error(
-				`No Redis connection with name ${name} found. Please make sure to register the connection before using it.`
-			);
-			process.exit(1);
-		}
-
-		return Service.get<Bun.RedisClient>(getConnectionName(name))!;
-	};
-
-	/**
-	 * Creates and registers a new redis connection.
-	 *
-	 * This will make the registered connection available for dependency injection with
-	 * the key `redis.connection.{name}`, where `{name}` is replaced with the given name.
-	 *
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 *
-	 * @param name The name of the connection.
-	 * @param config The configuration for the redis connection.
-	 * @returns The newly created and registered redis connection.
-	 */
-	export const registerConnection = (name: string, config: RedisConnectionProps) => {
-		if (Service.exists(getConnectionName(name))) {
-			// TODO: Use logger service here
-			console.error(`A Redis connection with the name ${name} has already been registered.`);
-			process.exit(1);
-		}
-
-		return Service.instance(
-			getConnectionName(name),
-			new Bun.RedisClient(config.url, omit(config, ['url']))
-		);
-	};
-
-	/**
-	 * Checks if a redis connection with the given name exists.
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 * @param name The name of the connection to check.
-	 * @returns `true` if the connection exists, `false` otherwise.
-	 */
-	export const connectionExists = (name: string) => {
-		return Service.exists(getConnectionName(name));
-	};
-
-	/**
-	 * Retrieves the default redis connection.
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 * @returns The default redis connection.
-	 */
-	export const getDefaultConnection = () => {
-		return getConnection('default');
-	};
-
-	/**
-	 * Sets the default redis connection.
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 * @param name The name of the connection to set as default.
-	 * @returns The default redis connection.
-	 */
-	export const setDefaultConnection = (name: string) => {
-		const serviceName = getConnectionName('default');
-		Service.remove(serviceName);
-		return Service.instance(serviceName, getConnection(name));
-	};
-}

package/src/repository.ts

@@ -1,295 +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.
-
-// @ts-nocheck
-
-import type { PgColumnBuilderBase } from 'drizzle-orm/pg-core';
-import type { Class } from 'type-fest';
-import type { DatabaseConnection } from './database';
-import type { ModelClass } from './model';
-
-import { eq } from 'drizzle-orm';
-
-import { Application } from './app';
-import { Database } from './database';
-
-/**
- * Database's primary column type.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export type IdType = number | string;
-
-/**
- * Interface of a repository.
- * @author Axel Nana <axel.nana@workbud.com>
- * @template TModel The type of the model class wrapped by the repository.
- * @template TId The primary column type.
- * @template TColumnsMap The table columns config.
- */
-export interface RepositoryInterface<
-	TModel extends ModelClass<TTableName, TColumnsMap>,
-	TId extends IdType = string,
-	TTableName extends string = TModel extends ModelClass<infer TTableName, infer _>
-		? TTableName
-		: string,
-	TColumnsMap extends Record<string, PgColumnBuilderBase> = TModel extends ModelClass<
-		TTableName,
-		infer TColumnsMap
-	>
-		? TColumnsMap
-		: Record<string, PgColumnBuilderBase>
-> {
-	/**
-	 * Retrieves all the records in the database.
-	 * @returns All the records in the database.
-	 */
-	all(): Promise<TModel['$inferSelect'][]>;
-
-	/**
-	 * Retrieves a record by its id.
-	 * @param id The id of the record to retrieve.
-	 * @returns The record with the given id.
-	 */
-	find(id: TId): Promise<TModel['$inferSelect'] | null>;
-
-	/**
-	 * Inserts a new record in the database.
-	 * @param data The data to insert.
-	 * @returns The inserted record.
-	 */
-	insert(data: TModel['$inferInsert']): Promise<TModel['$inferSelect']>;
-
-	/**
-	 * Updates a record in the database.
-	 * @param id The id of the record to update.
-	 * @param data The data to update.
-	 * @returns The updated record.
-	 */
-	update(id: TId, data: TModel['$inferUpdate']): Promise<TModel['$inferSelect']>;
-
-	/**
-	 * Updates all the records in the database.
-	 * @param data The data to update.
-	 * @returns The updated records.
-	 */
-	updateAll(data: TModel['$inferUpdate']): Promise<TModel['$inferSelect'][]>;
-
-	/**
-	 * Deletes a record from the database.
-	 * @param id The ID of the record to delete.
-	 * @returns The deleted record.
-	 */
-	delete(id: TId): Promise<TModel['$inferSelect']>;
-
-	/**
-	 * Deletes all the records from the database.
-	 * @returns All the records in the database.
-	 */
-	deleteAll(): Promise<TModel['$inferSelect'][]>;
-}
-
-/**
- * Type of a repository class.
- * @author Axel Nana <axel.nana@workbud.com>
- * @template TModel The type of the model class wrapped by the repository.
- * @template TId The primary column type.
- * @template TColumnsMap The table columns config.
- */
-export type RepositoryClass<
-	TModel extends ModelClass<TTableName, TColumnsMap>,
-	TId extends IdType = string,
-	TTableName extends string = TModel extends ModelClass<infer TTableName, infer _>
-		? TTableName
-		: string,
-	TColumnsMap extends Record<string, PgColumnBuilderBase> = TModel extends ModelClass<
-		TTableName,
-		infer TColumnsMap
-	>
-		? TColumnsMap
-		: Record<string, PgColumnBuilderBase>
-> = Class<RepositoryInterface<TModel, TId, TTableName, TColumnsMap>> & {
-	/**
-	 * The drizzle's table schema wrapped by the repository.
-	 */
-	readonly Model: TModel;
-
-	/**
-	 * The database connection name to use in the repository.
-	 *
-	 * Update this value to change the database connection used by this repository.
-	 */
-	readonly connection: string;
-};
-
-/**
- * Mixin used to create a new repository class over a model.
- * @author Axel Nana <axel.nana@workbud.com>
- * @template TModel The type of the model class wrapped by the repository.
- * @template TId The primary column type.
- * @template TColumnsMap The table columns config.
- * @template model The model class wrapped by the repository.
- */
-export const Repository = <
-	TModel extends ModelClass<TTableName, TColumnsMap>,
-	TId extends IdType = string,
-	TTableName extends string = TModel extends ModelClass<infer TTableName, infer _>
-		? TTableName
-		: string,
-	TColumnsMap extends Record<string, PgColumnBuilderBase> = TModel extends ModelClass<
-		TTableName,
-		infer TColumnsMap
-	>
-		? TColumnsMap
-		: Record<string, PgColumnBuilderBase>
->(
-	model: TModel
-) => {
-	type TSelect = TModel['$inferSelect'];
-	type TInsert = TModel['$inferInsert'];
-	type TUpdate = TModel['$inferUpdate'];
-
-	class R implements RepositoryInterface<TModel, TId, TTableName, TColumnsMap> {
-		/**
-		 * The drizzle's table schema wrapped by this repository.
-		 */
-		public static readonly Model: TModel = model;
-
-		/**
-		 * The database connection name to use.
-		 *
-		 * Update this value to change the database connection used by this repository.
-		 */
-		public static readonly connection: string = 'default';
-
-		/**
-		 * The database connection used by this repository.
-		 */
-		public get db(): DatabaseConnection {
-			const connection = (this.constructor as RepositoryClass<TModel, TId, TTableName, TColumnsMap>)
-				.connection;
-			let db: DatabaseConnection | null = null;
-
-			if (connection === 'default') {
-				db = (Application.context.getStore()?.get('db:tx') as DatabaseConnection) ?? null;
-			}
-
-			return db ?? Database.getConnection(connection);
-		}
-
-		/**
-		 * Retrieves all the records in the database.
-		 * @returns All the records in the database.
-		 */
-		public async all(): Promise<TSelect[]> {
-			return await this.db.select().from(model.table);
-		}
-
-		/**
-		 * Get a paginated subset of the records in the database.
-		 * @param page The page number to retrieve.
-		 * @param count The number of records to retrieve per page.
-		 * @returns A paginated response containing the records and the total number of records.
-		 */
-		public async paginate(
-			count: number,
-			page: number = 1
-		): Promise<{ page: number; data: TSelect[]; total: number }> {
-			const total = await this.db.$count(model.table);
-			const offset = Math.max(page - 1, 0) * count;
-			return {
-				page,
-				total,
-				data: await this.db.select().from(model.table).offset(offset).limit(count)
-			};
-		}
-
-		/**
-		 * Retrieves a record by its id.
-		 * @param id The id of the record to retrieve.
-		 * @returns The record with the given id.
-		 */
-		public async find(id: TId): Promise<TSelect | null> {
-			const [row] = await this.db.select().from(model.table).where(eq(model.table.id, id));
-			return (row ?? null) as TSelect | null;
-		}
-
-		/**
-		 * Finds the first record with a column matching the given value.
-		 * @param column The column to filter by.
-		 * @param value The value the column should match.
-		 * @returns The first record with a column matching the given value.
-		 */
-		public async findBy<TKey extends keyof TSelect>(
-			column: TKey,
-			value: TSelect[TKey]
-		): Promise<TSelect | null> {
-			const [row] = await this.db.select().from(model.table).where(eq(model.table[column], value));
-			return (row ?? null) as TSelect | null;
-		}
-
-		/**
-		 * Inserts a new record in the database.
-		 * @param data The data to insert.
-		 * @returns The inserted record.
-		 */
-		public async insert(data: TInsert): Promise<TSelect> {
-			const [row] = await this.db.insert(model.table).values(data).returning();
-			return row as TSelect;
-		}
-
-		/**
-		 * Updates a record in the database.
-		 * @param id The id of the record to update.
-		 * @param data The data to update.
-		 * @returns The updated record.
-		 */
-		public async update(id: TId, data: TUpdate): Promise<TSelect> {
-			const [row] = await this.db
-				.update(model.table)
-				.set(data)
-				.where(eq(model.table.id, id))
-				.returning();
-			return row as TSelect;
-		}
-
-		/**
-		 * Updates all the records in the database.
-		 * @param data The data to update.
-		 * @returns The updated records.
-		 */
-		public async updateAll(data: TUpdate): Promise<TSelect[]> {
-			return await this.db.update(model.table).set(data).returning();
-		}
-
-		/**
-		 * Deletes a record from the database.
-		 * @param id The ID of the record to delete.
-		 * @returns The deleted record.
-		 */
-		public async delete(id: TId): Promise<TSelect> {
-			const [row] = await this.db.delete(model.table).where(eq(model.table.id, id)).returning();
-			return row as TSelect;
-		}
-
-		/**
-		 * Deletes all the records from the database.
-		 * @returns All the records in the database.
-		 */
-		public async deleteAll(): Promise<TSelect[]> {
-			return await this.db.delete(model.table).returning();
-		}
-	}
-
-	return R;
-};