@elysiumjs/mnemosyne 0.2.0 → 0.3.1

package/src/cache.ts

@@ -1,219 +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 'keyv';
-
-import { Service, ServiceNotFoundError } from '@elysiumjs/core';
-import { createCache } from 'cache-manager';
-import { Keyv } from 'keyv';
-import { alphabetical } from 'radash';
-
-/** Name of the global service backing `Cache.redis`. */
-export const REDIS_CACHE_SERVICE = 'mnemosyne.cache.redis';
-
-/** Name of the global service backing `Cache.memory`. */
-export const MEMORY_CACHE_SERVICE = 'mnemosyne.cache.memory';
-
-/**
- * Interface for a cache storage.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export interface CacheInterface {
-	/**
-	 * Retrieves the cached data for a given key.
-	 * @typeParam T The type of the cached data.
-	 *
-	 * @param key The key of the cached data.
-	 */
-	get<T>(key: string): Promise<T | undefined>;
-
-	/**
-	 * Retrieves the cached data for a given list of keys.
-	 * @typeParam T The type of the cached data.
-	 *
-	 * @param keys The list of cached data keys.
-	 */
-	mget<T>(keys: string[]): Promise<Array<T | undefined>>;
-
-	/**
-	 * Gets the TTL of the cached data with the given key.
-	 * @param key The key of the cached data.
-	 * @returns The TTL of the cached data, or `undefined` if the data does not exist.
-	 */
-	ttl(key: string): Promise<number | undefined>;
-
-	/**
-	 * Caches data under the given key and an optional TTL.
-	 * @typeParam T The type of the data to cache.
-	 *
-	 * @param key The key of the cached data.
-	 * @param data The data to cache.
-	 * @param ttl The optional TTL of the cached data. If not defined, the data is cached forever.
-	 * @returns The cached data.
-	 */
-	set<T>(key: string, data: T, ttl?: number): Promise<T>;
-
-	/**
-	 * Caches data under the given list of keys and an optional TTL.
-	 * @typeParam T The type of the data to cache.
-	 *
-	 * @param data The list of data to cache.
-	 * @returns The list of cached data.
-	 */
-	mset<T>(
-		data: Array<{
-			key: string;
-			value: T;
-			ttl?: number;
-		}>
-	): Promise<
-		Array<{
-			key: string;
-			value: T;
-			ttl?: number;
-		}>
-	>;
-
-	/**
-	 * Deletes the cached data with the given key.
-	 * @typeParam T The type of the data to cache.
-	 *
-	 * @param key The key of the cached data.
-	 * @returns `true` if the data was deleted, `false` otherwise.
-	 */
-	del(key: string): Promise<boolean>;
-
-	/**
-	 * Deletes the cached data with the given list of keys.
-	 * @typeParam T The type of the data to cache.
-	 *
-	 * @param keys The list of cached data keys.
-	 * @returns `true` if the data was deleted, `false` otherwise.
-	 */
-	mdel(keys: string[]): Promise<boolean>;
-
-	/**
-	 * Deletes all cached data.
-	 * @returns `true` if the data was deleted, `false` otherwise.
-	 */
-	clear(): Promise<boolean>;
-
-	/**
-	 * Creates a sub-cache with the given tags.
-	 * @param tags The list of tags for the sub-cache.
-	 */
-	tags(...tags: string[]): Omit<CacheInterface, 'tags'>;
-}
-
-/**
- * Makes a cache interface wrapping the given store.
- * @author Axel Nana <axel.nana@workburd.com>
- * @param store The cache storage to use in the interface.
- * @returns A new `CacheInterface`.
- */
-export const makeCacheInterface = (store: KeyvStoreAdapter): CacheInterface => {
-	const base = createCache({
-		stores: [
-			new Keyv({
-				store,
-				namespace: 'cache'
-			})
-		]
-	}) as Omit<CacheInterface, 'tags'>;
-
-	const tagsCache = new Map<string, Omit<CacheInterface, 'tags'>>();
-
-	return {
-		...base,
-		tags(...tags) {
-			const namespace = `cache__${alphabetical(tags, (item) => item).join('__')}`;
-			let cache = tagsCache.get(namespace);
-
-			if (!cache) {
-				cache = createCache({
-					stores: [
-						new Keyv({
-							store,
-							namespace
-						})
-					]
-				}) as Omit<CacheInterface, 'tags'>;
-
-				tagsCache.set(namespace, cache);
-			}
-
-			return cache;
-		}
-	};
-};
-
-const getCache = (name: string): CacheInterface => {
-	const cache = Service.get<CacheInterface>(name);
-	if (!cache) throw new ServiceNotFoundError(name);
-	return cache;
-};
-
-/**
- * Static access to the caches provided by the `MnemosyneModule`.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export abstract class Cache {
-	/**
-	 * A weak cache storage for simple non-intrusive caching of data.
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 */
-	public static readonly weak = Object.seal({
-		/**
-		 * INTERNAL USAGE ONLY.
-		 * @private
-		 */
-		map: new WeakMap<object, unknown>(),
-
-		/**
-		 * Gets the cached data for a given context.
-		 * @param ctx The cache context.
-		 * @returns The cached data.
-		 */
-		get<T extends object>(ctx: object): T {
-			if (!this.map.has(ctx)) this.map.set(ctx, {});
-			return this.map.get(ctx) as T;
-		},
-
-		/**
-		 * Deletes the cached data for a given context.
-		 * @param ctx The cache context.
-		 */
-		del(ctx: object): void {
-			this.map.delete(ctx);
-		}
-	});
-
-	/**
-	 * Redis-based cache storage.
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 * @throws {ServiceNotFoundError} If the `MnemosyneModule` is not loaded or has no redis cache.
-	 */
-	public static get redis(): CacheInterface {
-		return getCache(REDIS_CACHE_SERVICE);
-	}
-
-	/**
-	 * Memory-based cache storage.
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 * @throws {ServiceNotFoundError} If the `MnemosyneModule` is not loaded or has no memory cache.
-	 */
-	public static get memory(): CacheInterface {
-		return getCache(MEMORY_CACHE_SERVICE);
-	}
-}

package/src/database.ts

@@ -1,114 +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 { CacheInterface } from './cache';
-import type { DatabaseCacheConfig, DatabaseDriver } from './interfaces';
-
-import { Application, Service, ServiceNotFoundError } from '@elysiumjs/core';
-
-import { Cache } from './cache';
-
-/**
- * Creates a cache storage instance tagged for database use.
- * Drivers can use this to build their cache backends.
- * @author Axel Nana <axel.nana@workbud.com>
- * @param config The database cache configuration.
- * @returns A cache interface tagged with 'database'.
- */
-export const createDatabaseCacheStorage = (
-	config: DatabaseCacheConfig
-): Omit<CacheInterface, 'tags'> => {
-	return Cache[config.storage ?? 'redis'].tags('database');
-};
-
-/**
- * Abstract database manager.
- *
- * Retrieves named database connections using a driver. Connections are registered as
- * global services `db.connection.{name}` by the driver modules.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- * @template TConnection The connection type managed by the driver.
- * @template TConnectionConfig The configuration used to create a connection.
- */
-export abstract class AbstractDatabase<TConnection, TConnectionConfig> {
-	/**
-	 * The database driver used to create and manage connections.
-	 */
-	protected abstract driver: DatabaseDriver<TConnection, TConnectionConfig>;
-
-	/**
-	 * Creates a service name for a database connection. Driver modules register their
-	 * connections (and the `default` alias) under this name.
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 * @param name The name of the connection.
-	 * @returns A service name for the connection.
-	 */
-	public static getConnectionName(name: string): string {
-		return `db.connection.${name}`;
-	}
-
-	/**
-	 * Retrieves the connection with the given name.
-	 *
-	 * For the default connection, checks the async context for a
-	 * transaction handle (`db:tx`) before falling back to the service container.
-	 * @throws {ServiceNotFoundError} If no connection with that name is registered.
-	 *
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 * @param name The connection name.
-	 * @returns The connection with the given name.
-	 */
-	public getConnection(name: string = 'default'): TConnection {
-		if (name === 'default') {
-			const tx = Application.context.getStore()?.get('db:tx') as TConnection | undefined;
-			if (tx) return tx;
-		}
-
-		const serviceName = AbstractDatabase.getConnectionName(name);
-		const connection = Service.get<TConnection>(serviceName);
-		if (connection === null) throw new ServiceNotFoundError(serviceName);
-
-		return connection;
-	}
-
-	/**
-	 * Checks if a 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.
-	 */
-	public connectionExists(name: string): boolean {
-		return Service.exists(AbstractDatabase.getConnectionName(name));
-	}
-
-	/**
-	 * Retrieves the default connection.
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 * @returns The default connection.
-	 */
-	public getDefaultConnection(): TConnection {
-		return this.getConnection('default');
-	}
-
-	/**
-	 * Returns the raw underlying client for the given connection.
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 * @param name The connection name.
-	 * @returns The raw client instance.
-	 */
-	public getRawClient(name: string = 'default'): unknown {
-		return this.driver.getRawClient(this.getConnection(name));
-	}
-}

package/src/index.ts

@@ -1,37 +0,0 @@
-// Copyright (c) 2026-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.
-
-export type {
-	ColumnMetadata,
-	DatabaseCacheConfig,
-	DatabaseCacheStrategy,
-	DatabaseDriver,
-	IdType,
-	ModelAdapter,
-	ModelClass,
-	RepositoryClass,
-	RepositoryInterface,
-	TenancyStrategy
-} from './interfaces';
-
-export * from './database';
-export * from './model';
-export * from './repository';
-
-export * from './tenancy';
-export type { TenancyConfig, TenancyMode, ModelTenancyConfig } from './tenancy';
-
-export { Cache, type CacheInterface, MEMORY_CACHE_SERVICE, REDIS_CACHE_SERVICE } from './cache';
-export * from './mnemosyne.module';
-export * from './keyv-redis';