@elysiumjs/mnemosyne 0.1.0 → 0.2.0

package/.turbo/turbo-build.log

@@ -1,8 +1,8 @@
 $ bun run clean && bun run build:js && bun run build:ts
 $ rimraf dist
-$ bun build ./src/index.ts --outdir ./dist --target bun --packages external --root ./src --minify
-Bundled 7 modules in 23ms
+$ bun build ./src/index.ts --outdir ./dist --target bun --packages external --root ./src --minify-syntax --minify-whitespace
+Bundled 8 modules in 21ms
 
-  index.js  7.47 KB  (entry point)
+  index.js  11.16 KB  (entry point)
 
 $ tsc

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @elysiumjs/mnemosyne
 
+## 0.2.0
+
+### Minor Changes
+
+- [`3625883`](https://github.com/na2axl/elysiumjs/commit/3625883dba92f1596e7444ee52f9399d8e9b049f) Thanks [@na2axl](https://github.com/na2axl)! - Drop the `reflect-metadata` dependency. Decorator metadata now lives in a small store in `@elysiumjs/core`, exported as `Metadata` (`define`, `get`, `getOwn`, `has`). Use it instead of `Reflect.defineMetadata` and `Reflect.getMetadata` to read or write Elysium metadata.
+
+  Apps no longer need `import 'reflect-metadata'` in their entrypoint, and generated projects leave it out. Keep `emitDecoratorMetadata` enabled: `@Service.inject()` and `@Command.arg()` still infer types from it. An app that loads `reflect-metadata` for another library keeps working; Elysium also reads the types stored there.
+
+- [`07236b3`](https://github.com/na2axl/elysiumjs/commit/07236b386c2506590d74e8753ce847c1e184b3ee) Thanks [@na2axl](https://github.com/na2axl)! - Introduce the module system. Modules are now the only way to register anything in an Elysium.js app. This is a breaking change with no compatibility layer.
+
+  Breaking changes:
+
+  - `@Module.register()` takes `imports`, `services`, `exports`, `controllers`, `commands`, `jobs`, `prefix` and `env`. Services are private to their module unless exported (or global). The `beforeRegister` and `afterRegister` hooks are replaced by `onInit`, `onServe` and `onDestroy`.
+  - Configurable modules are bound with `with()`, for example `HermesModule.with({ level: 'debug' })`. `with()` accepts an object or a function.
+  - Decorators only record metadata. Importing a file no longer registers commands, services or event wiring, and the side-effect imports of the packages are removed. List commands, jobs and services in the module that owns them.
+  - `@Application.register()` no longer takes `database`, `redis`, `wamp` or `'elysium:hermes'`/`'elysium:cerberus'` keys. Use `DrizzleModule`, `RedisModule`, `WampModule`, `HermesModule` and `CerberusModule`. Package plugins are replaced by modules: add `SentryModule` instead of the `plugin()` function. `plugins` still accepts plain Elysia plugin factories.
+  - Constructing an `Application` no longer runs it. Use `await App.start()`; `Application.testing()` boots a module graph for tests. The `styx` binary loads `src/app.ts` (or `index.ts`) and starts the exported application, so a project entry no longer needs to import commands.
+  - The job system of core (`Job`, `Worker`, `WorkerPool`, `commandWork`) is removed. `@elysiumjs/heracles` is the only job system: extend its `Job`, list jobs in a module's `jobs`, declare queues with `HeraclesModule.with({ queues })`, and dispatch with `Heracles.dispatch()`.
+  - `@elysiumjs/styx` ships `StyxModule`, active in development only. The `migration:generate` and `migration:run` commands move to `DrizzleModule` and are available in production.
+  - `@elysiumjs/mnemosyne` ships `MnemosyneModule` for its caches (`redis: false` or `memory: false` opts out). `DrizzleModule` imports it.
+  - New modules: `HephaestusModule`, `ArgusModule` (`serviceName` is required), `SentryModule` (needs a `dsn` or `SENTRY_DSN`) and `CerberusModule` (`getSubject` is required).
+  - Module and service code throws typed errors (for example `InvalidModuleConfigError`) instead of exiting the process. `Application.run()` prints them and exits; command `run()` methods may still exit, and package plugin factories are unchanged.
+  - `Application.register` merges subclass props over the parent's (own props, then own metadata, then parent, then defaults), and concatenates `modules` parent first. Previously defaults and parent values won, so `openapi` could not be enabled.
+  - `Heracles.dispatch` starts a stopped queue on first use, so producers no longer start queues. `Queue.start()` is idempotent.
+  - `create-elysium` generates apps that use modules, and adds Sentry and Hephaestus to the `modules` list.
+  - `@Event.on`/`@Event.once` method listeners on classes in a loaded module's `services` or `controllers` are wired by the kernel and run in their module's context. Jobs, commands and middlewares are not wired, and an instance listener on a class that is not a service throws `EventListenerNotSupportedError`. Listeners on classes not listed in a loaded module no longer fire.
+  - New typed errors: `CircularDependencyError` (services that depend on each other, in sync and async resolution), `DuplicateModuleNameError` (two different module classes sharing a name; module scopes and config tokens are name based) and `EventListenerNotSupportedError`.
+  - Lazy boot contract: a CLI command initialises only its own module and that module's imports. Sync helpers such as `Database.getConnection()` work when the owning module's `onInit` is synchronous; otherwise they throw `ServiceNotReadyError` naming the module. Use `await Service.resolve()` or set `static boot = true` on the command.
+
+### Patch Changes
+
+- Updated dependencies [[`8ac91ab`](https://github.com/na2axl/elysiumjs/commit/8ac91ab676b1119b4eecf0ddb3fd0a3e84017cac), [`3625883`](https://github.com/na2axl/elysiumjs/commit/3625883dba92f1596e7444ee52f9399d8e9b049f), [`07236b3`](https://github.com/na2axl/elysiumjs/commit/07236b386c2506590d74e8753ce847c1e184b3ee)]:
+  - @elysiumjs/core@0.8.0
+
 ## 0.1.0
 
 ### Minor Changes

package/README.md

@@ -1,6 +1,6 @@
 # @elysiumjs/mnemosyne
 
-Database and caching for Elysium.js applications.
+Database abstractions and caching for Elysium.js applications.
 
 ## Installation
 
@@ -10,24 +10,27 @@ bun add @elysiumjs/mnemosyne
 
 ## Usage
 
+`MnemosyneModule` provides the caches (`Cache.redis` and `Cache.memory`). Database driver modules such as `DrizzleModule` from `@elysiumjs/mnemosyne-drizzle` import it for you, so you only add it yourself when you want to configure the caches or use them without a database:
+
 ```ts
-import { Database, Model, Repository } from '@elysiumjs/mnemosyne';
-import { Service, ServiceScope } from '@elysiumjs/core';
-import { uuid, varchar } from 'drizzle-orm/pg-core';
-
-// Define a model
-class UserModel extends Model('users', {
-	id: uuid().primaryKey().defaultRandom(),
-	name: varchar({ length: 255 }).notNull(),
-}) {
-	public static readonly supportTenancy = true;
-}
-
-// Create a repository
-@Service.register({ name: 'UserRepository', scope: ServiceScope.SINGLETON })
-class UserRepository extends Repository(UserModel) {}
+import { Application, RedisModule } from '@elysiumjs/core';
+import { MnemosyneModule } from '@elysiumjs/mnemosyne';
+
+@Application.register({
+	modules: [
+		RedisModule.with({
+			default: 'cache',
+			connections: { cache: { url: process.env.REDIS_URL! } }
+		}),
+		// Opt out of a cache with `redis: false` or `memory: false`.
+		MnemosyneModule.with({ cache: { memory: { ttl: 60_000, lruSize: 5000 } } })
+	]
+})
+export class App extends Application {}
 ```
 
+Models and repositories are built with a driver package. See [`@elysiumjs/mnemosyne-drizzle`](../mnemosyne-drizzle/README.md).
+
 ## License
 
 This project is licensed under the Apache License, Version 2.0. See the [LICENSE](../../LICENSE) file for more info.

package/dist/cache.d.ts

@@ -1,3 +1,8 @@
+import type { KeyvStoreAdapter } from 'keyv';
+/** Name of the global service backing `Cache.redis`. */
+export declare const REDIS_CACHE_SERVICE = "mnemosyne.cache.redis";
+/** Name of the global service backing `Cache.memory`. */
+export declare const MEMORY_CACHE_SERVICE = "mnemosyne.cache.memory";
 /**
  * Interface for a cache storage.
  * @author Axel Nana <axel.nana@workbud.com>
@@ -76,8 +81,18 @@ export interface CacheInterface {
      */
     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 declare const makeCacheInterface: (store: KeyvStoreAdapter) => CacheInterface;
+/**
+ * Static access to the caches provided by the `MnemosyneModule`.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
 export declare abstract class Cache {
-    #private;
     /**
      * A weak cache storage for simple non-intrusive caching of data.
      * @author Axel Nana <axel.nana@workbud.com>
@@ -103,11 +118,13 @@ export declare abstract class Cache {
     /**
      * Redis-based cache storage.
      * @author Axel Nana <axel.nana@workbud.com>
+     * @throws {ServiceNotFoundError} If the `MnemosyneModule` is not loaded or has no redis cache.
      */
     static get redis(): CacheInterface;
     /**
      * Memory-based cache storage.
      * @author Axel Nana <axel.nana@workbud.com>
+     * @throws {ServiceNotFoundError} If the `MnemosyneModule` is not loaded or has no memory cache.
      */
     static get memory(): CacheInterface;
 }

package/dist/database.d.ts

@@ -7,12 +7,12 @@ import type { DatabaseCacheConfig, DatabaseDriver } from './interfaces';
  * @param config The database cache configuration.
  * @returns A cache interface tagged with 'database'.
  */
-export declare const createDatabaseCacheStorage: (config: DatabaseCacheConfig) => Omit<CacheInterface, "tags">;
+export declare const createDatabaseCacheStorage: (config: DatabaseCacheConfig) => Omit<CacheInterface, 'tags'>;
 /**
  * Abstract database manager.
  *
- * Manages named database connections using a driver. Connections are
- * registered in the service container and can be retrieved by name.
+ * 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.
@@ -24,34 +24,25 @@ export declare abstract class AbstractDatabase<TConnection, TConnectionConfig> {
      */
     protected abstract driver: DatabaseDriver<TConnection, TConnectionConfig>;
     /**
-     * Creates a service name for a database connection.
+     * 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.
      */
-    private getConnectionName;
+    static getConnectionName(name: string): string;
     /**
      * 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.
      */
     getConnection(name?: string): TConnection;
-    /**
-     * Creates and registers a new connection.
-     *
-     * This will make the registered connection available for dependency injection with
-     * the key `db.connection.{name}`, where `{name}` is replaced with the given name.
-     *
-     * @author Axel Nana <axel.nana@workbud.com>
-     * @param name The connection name.
-     * @param config The connection configuration.
-     * @returns The newly created and registered connection.
-     */
-    registerConnection(name: string, config: TConnectionConfig): TConnection;
     /**
      * Checks if a connection with the given name exists.
      * @author Axel Nana <axel.nana@workbud.com>
@@ -65,13 +56,6 @@ export declare abstract class AbstractDatabase<TConnection, TConnectionConfig> {
      * @returns The default connection.
      */
     getDefaultConnection(): TConnection;
-    /**
-     * Sets the default connection.
-     * @author Axel Nana <axel.nana@workbud.com>
-     * @param name The name of the connection to set as default.
-     * @returns The default connection.
-     */
-    setDefaultConnection(name: string): TConnection;
     /**
      * Returns the raw underlying client for the given connection.
      * @author Axel Nana <axel.nana@workbud.com>

package/dist/index.d.ts

@@ -1,17 +1,9 @@
-import type { TenancyConfig } from './tenancy';
 export type { ColumnMetadata, DatabaseCacheConfig, DatabaseCacheStrategy, DatabaseDriver, IdType, ModelAdapter, ModelClass, RepositoryClass, RepositoryInterface, TenancyStrategy } from './interfaces';
-export { AbstractDatabase, createDatabaseCacheStorage } from './database';
-export { createSchemaFromModel, AbstractModel } from './model';
-export { AbstractRepository } from './repository';
-export { getConfig as getTenancyConfig, getCurrentTenant, withTenant, registerTenancyStrategy, getTenancyStrategy, TenantMiddleware, SimpleTenantMiddleware, StrictTenantMiddleware } from './tenancy';
+export * from './database';
+export * from './model';
+export * from './repository';
+export * from './tenancy';
 export type { TenancyConfig, TenancyMode, ModelTenancyConfig } from './tenancy';
-export { Cache } from './cache';
-export type { CacheInterface } from './cache';
-export { KeyvRedis } from './keyv-redis';
-export interface MnemosyneConfig<TConnectionConfig = unknown> {
-    database?: {
-        default: string;
-        connections: Record<string, TConnectionConfig>;
-    };
-    tenancy?: TenancyConfig;
-}
+export { Cache, type CacheInterface, MEMORY_CACHE_SERVICE, REDIS_CACHE_SERVICE } from './cache';
+export * from './mnemosyne.module';
+export * from './keyv-redis';

package/dist/index.js

@@ -1,2 +1,2 @@
 // @bun
-import{Application as P,Service as G}from"@elysiumjs/core";import{createCache as E}from"cache-manager";import{KeyvCacheableMemory as N}from"cacheable";import{Keyv as F}from"keyv";import{alphabetical as A}from"radash";import{EventEmitter as K}from"events";import{Event as C,Redis as w}from"@elysiumjs/core";class J extends K{#D;#g;#L="::";#I=1000;#R=!0;#O=!1;#W;constructor(g){super();C.once("elysium:app:launched",()=>{this.#D=w.getConnection(g.connection)}),this.#W=g.connection,this.#g=g.namespace,this.#L=g.keyPrefixSeparator??"::",this.#I=g.clearBatchSize??1000,this.#R=g.useUnlink??!0,this.#O=g.noNamespaceAffectsAll??!1,this.on("error",(L)=>{C.emit("elysium:error",L)})}get client(){return this.#D}get opts(){return{namespace:this.#g,keyPrefixSeparator:this.#L,clearBatchSize:this.#I,noNamespaceAffectsAll:this.#O,dialect:"redis",url:this.#W}}get namespace(){return this.#g}set namespace(g){this.#g=g}async get(g){g=this.createKeyPrefix(g,this.#g);let L=await this.client.get(g);return L===null?void 0:L}async set(g,L,D){if(g=this.createKeyPrefix(g,this.#g),D)await this.client.set(g,L,"PX",D);else await this.client.set(g,L)}async setMany(g){let L=[];for(let{key:D,value:O,ttl:R}of g){let I=this.createKeyPrefix(D,this.#g);if(R)L.push(this.client.set(I,O,"PX",R));else L.push(this.client.set(I,O))}await Promise.all(L)}async delete(g){return g=this.createKeyPrefix(g,this.#g),await(this.#R?this.client.send("UNLINK",[g]):this.client.del(g))>0}async clear(){try{if(!this.#g&&this.#O){await this.client.send("FLUSHDB",[]);return}let g="0",L=this.#I,D=this.#g?`${this.#g}${this.#L}*`:"*",O=[];do{let R=await this.client.send("SCAN",[g,"MATCH",D,"COUNT",L.toString(),"TYPE","string"]),[I,Y]=R;if(g=I.toString(),Y.length===0)continue;if(!this.#g)Y=Y.filter((q)=>!q.includes(this.#L));O.push(Y.map((q)=>this.client.del(q)))}while(g!=="0");await Promise.all(O)}catch(g){this.emit("error",g)}}async has(g){return g=this.createKeyPrefix(g,this.#g),this.client.exists(g)}async hasMany(g){let L=[];for(let D of g){let O=this.createKeyPrefix(D,this.#g);L.push(this.client.exists(O))}return Promise.all(L)}async getMany(g){if(g.length===0)return[];return g=g.map((D)=>this.createKeyPrefix(D,this.#g)),await this.client.mget(...g)}async disconnect(){this.client.close()}async deleteMany(g){let L=!1,D=[];for(let R of g){let I=this.createKeyPrefix(R,this.#g);if(this.#R)D.push(this.client.send("UNLINK",[I]));else D.push(this.client.del(I))}let O=await Promise.all(D);for(let R of O)if(typeof R==="number"&&R>0)L=!0;return L}async*iterator(g){let L=g?`${g}${this.#L}*`:"*",D="0";do{let O=await this.client.send("SCAN",[D,"MATCH",L,"TYPE","string"]),[R,I]=O;if(D=R.toString(),!g&&!this.#O)I=I.filter((Y)=>!Y.includes(this.#L));if(I.length>0){let Y=await this.client.mget(...I);for(let q of I.keys()){let j=this.getKeyWithoutPrefix(I[q],g),f=Y[q];yield[j,f]}}}while(D!=="0")}createKeyPrefix(g,L){return L?`${L}${this.#L}${g}`:g}getKeyWithoutPrefix(g,L){return L?g.replace(`${L}${this.#L}`,""):g}}var U=(g)=>{let L=E({stores:[new F({store:g,namespace:"cache"})]}),D=new Map;return{...L,tags(...O){let R=`cache__${A(O,(Y)=>Y).join("__")}`,I=D.get(R);if(!I)I=E({stores:[new F({store:g,namespace:R})]}),D.set(R,I);return I}}};class V{static#D;static#g;static weak=Object.seal({map:new WeakMap,get(g){if(!this.map.has(g))this.map.set(g,{});return this.map.get(g)},del(g){this.map.delete(g)}});static get redis(){if(!V.#D)V.#D=U(new J({connection:"cache"}));return V.#D}static get memory(){if(!V.#g)V.#g=U(new N({ttl:60000,lruSize:5000}));return V.#g}}var S=(g)=>{return V[g.storage??"redis"].tags("database")};class B{getConnectionName(g){return`db.connection.${g}`}getConnection(g="default"){if(g==="default"){let D=P.context.getStore()?.get("db:tx");if(D)return D}let L=this.getConnectionName(g);if(!G.exists(L))console.error(`No connection with name ${g} found. Please make sure to register the connection before using it.`),process.exit(1);return G.get(L)}registerConnection(g,L){let D=this.getConnectionName(g);if(G.exists(D))console.error(`A connection with the name ${g} has already been registered.`),process.exit(1);let O=this.driver.createConnection(L);return G.instance(D,O)}connectionExists(g){return G.exists(this.getConnectionName(g))}getDefaultConnection(){return this.getConnection("default")}setDefaultConnection(g){let L=this.getConnectionName("default");return G.remove(L),G.instance(L,this.getConnection(g))}getRawClient(g="default"){return this.driver.getRawClient(this.getConnection(g))}}import{Application as M}from"@elysiumjs/core";import{t as W}from"elysia";import{Application as H,Middleware as b}from"@elysiumjs/core";var _=null,x=()=>{let g=H.instance;if(!g)return{mode:"schema"};return g.getConfig("elysium:mnemosyne")?.tenancy??{mode:"schema"}},v=(g)=>{_=g},Z=()=>{return _},$=()=>{if(!H.instance||!H.context.getStore)return null;return H.context.getStore()?.get("tenant")??null},d=(g,L)=>{let D=H.context.getStore(),O=new Map(D);return O.set("tenant",g),H.context.run(O,L)};class Q extends b{header="x-tenant-id";allowPublic=!0;connectionName="default";async validateTenant(g){return!0}async onTenantResolved(g,L){}onTenantError(g,L){if(g==="missing")throw Error("Tenant ID required");else throw Error("Invalid tenant")}async onRequest(g){let L=g.request.headers.get(this.header);if(!L||L==="public"){if(this.allowPublic){g.tenant="public";return}return this.onTenantError("missing",g)}if(!await this.validateTenant(L))return this.onTenantError("invalid",g);g.tenant=L,await this.onTenantResolved(L,g)}}class T extends Q{}class z extends Q{allowPublic=!1}var X=(g,{mode:L="select"}={})=>{if(g===void 0||g.length===0)return W.Object({});let D={};for(let O of g){if(["create","update"].includes(L)&&O.isPrimaryKey)continue;if(D[O.name]=h(O),O.nullable)D[O.name]=W.Nullable(D[O.name]);if(L==="update"||O.hasDefault||O.nullable)D[O.name]=W.Optional(D[O.name])}return W.Object(D)},h=(g)=>{switch(g.dataType){case"string":return W.String();case"uuid":return W.String({format:"uuid"});case"number":return W.Number();case"boolean":return W.Boolean();case"array":return W.Array(W.Any());case"json":return W.Object({});case"date":return W.Transform(W.String({format:"date"})).Decode((L)=>new Date(L)).Encode((L)=>L.toISOString());case"datetime":return W.Transform(W.String({format:"date-time"})).Decode((L)=>new Date(L)).Encode((L)=>L.toISOString());case"bigint":return W.BigInt();case"buffer":return W.File();default:return W.Never()}},i=(g,L,D,O)=>{let R=D.getColumns(O);class I{static $inferSelect=void 0;static $inferInsert=void 0;static $inferUpdate=void 0;static get table(){if(!M.instance||!M.context.getStore)return O;if(this.supportTenancy){let Y=$()??"public";if(Y!=="public"){let q=Z();if(q)return q.resolveTable(O,Y);return D.createTenantTable(O,Y)}}return O}static tableName=g;static columns=L;static insertSchema=X(R,{mode:"create"});static updateSchema=X(R,{mode:"update"});static selectSchema=X(R,{mode:"select"});static supportTenancy=!1}return I};var u=(g,L)=>{class D{static Model=g;static connection="default";get db(){return L.getConnection(this.constructor.connection)}}return D};export{d as withTenant,v as registerTenancyStrategy,Z as getTenancyStrategy,x as getTenancyConfig,$ as getCurrentTenant,X as createSchemaFromModel,S as createDatabaseCacheStorage,Q as TenantMiddleware,z as StrictTenantMiddleware,T as SimpleTenantMiddleware,J as KeyvRedis,V as Cache,u as AbstractRepository,i as AbstractModel,B as AbstractDatabase};
+var __legacyDecorateClassTS=function(decorators,target,key,desc){var c=arguments.length,r=c<3?target:desc===null?desc=Object.getOwnPropertyDescriptor(target,key):desc,d;if(typeof Reflect==="object"&&typeof Reflect.decorate==="function")r=Reflect.decorate(decorators,target,key,desc);else for(var i=decorators.length-1;i>=0;i--)if(d=decorators[i])r=(c<3?d(r):c>3?d(target,key,r):d(target,key))||r;return c>3&&r&&Object.defineProperty(target,key,r),r};import{Application,Service as Service2,ServiceNotFoundError as ServiceNotFoundError2}from"@elysiumjs/core";import{Service,ServiceNotFoundError}from"@elysiumjs/core";import{createCache}from"cache-manager";import{Keyv}from"keyv";import{alphabetical}from"radash";var REDIS_CACHE_SERVICE="mnemosyne.cache.redis",MEMORY_CACHE_SERVICE="mnemosyne.cache.memory",makeCacheInterface=(store)=>{let base=createCache({stores:[new Keyv({store,namespace:"cache"})]}),tagsCache=new Map;return{...base,tags(...tags){let namespace=`cache__${alphabetical(tags,(item)=>item).join("__")}`,cache=tagsCache.get(namespace);if(!cache)cache=createCache({stores:[new Keyv({store,namespace})]}),tagsCache.set(namespace,cache);return cache}}},getCache=(name)=>{let cache=Service.get(name);if(!cache)throw new ServiceNotFoundError(name);return cache};class Cache{static weak=Object.seal({map:new WeakMap,get(ctx){if(!this.map.has(ctx))this.map.set(ctx,{});return this.map.get(ctx)},del(ctx){this.map.delete(ctx)}});static get redis(){return getCache(REDIS_CACHE_SERVICE)}static get memory(){return getCache(MEMORY_CACHE_SERVICE)}}var createDatabaseCacheStorage=(config)=>Cache[config.storage??"redis"].tags("database");class AbstractDatabase{static getConnectionName(name){return`db.connection.${name}`}getConnection(name="default"){if(name==="default"){let tx=Application.context.getStore()?.get("db:tx");if(tx)return tx}let serviceName=AbstractDatabase.getConnectionName(name),connection=Service2.get(serviceName);if(connection===null)throw new ServiceNotFoundError2(serviceName);return connection}connectionExists(name){return Service2.exists(AbstractDatabase.getConnectionName(name))}getDefaultConnection(){return this.getConnection("default")}getRawClient(name="default"){return this.driver.getRawClient(this.getConnection(name))}}import{Application as Application3}from"@elysiumjs/core";import{t}from"elysia";import{Application as Application2,Middleware,Service as Service3}from"@elysiumjs/core";var TENANCY_CONFIG_SERVICE="mnemosyne.tenancy.config",TENANCY_STRATEGY_SERVICE="mnemosyne.tenancy.strategy",getTenancyConfig=()=>Service3.get(TENANCY_CONFIG_SERVICE)??{mode:"schema"},getTenancyStrategy=()=>Service3.get(TENANCY_STRATEGY_SERVICE),getCurrentTenant=()=>{if(!Application2.instance||!Application2.context.getStore)return null;return Application2.context.getStore()?.get("tenant")??null},withTenant=(tenant,callback)=>{let currentStore=Application2.context.getStore(),newStore=new Map(currentStore);return newStore.set("tenant",tenant),Application2.context.run(newStore,callback)};class TenantMiddleware extends Middleware{header="x-tenant-id";allowPublic=!0;connectionName="default";async validateTenant(_tenant){return!0}async onTenantResolved(_tenant,_ctx){}onTenantError(reason,_ctx){if(reason==="missing")throw Error("Tenant ID required");else throw Error("Invalid tenant")}async onRequest(ctx){let tenantId=ctx.request.headers.get(this.header);if(!tenantId||tenantId==="public"){if(this.allowPublic){ctx.tenant="public";return}return this.onTenantError("missing",ctx)}if(!await this.validateTenant(tenantId))return this.onTenantError("invalid",ctx);ctx.tenant=tenantId,await this.onTenantResolved(tenantId,ctx)}}class SimpleTenantMiddleware extends TenantMiddleware{}class StrictTenantMiddleware extends TenantMiddleware{allowPublic=!1}var createSchemaFromModel=(columns,{mode="select"}={})=>{if(columns===void 0||columns.length===0)return t.Object({});let properties={};for(let column of columns){if(["create","update"].includes(mode)&&column.isPrimaryKey)continue;if(properties[column.name]=parseColumnType(column),column.nullable)properties[column.name]=t.Nullable(properties[column.name]);if(mode==="update"||column.hasDefault||column.nullable)properties[column.name]=t.Optional(properties[column.name])}return t.Object(properties)},parseColumnType=(column)=>{switch(column.dataType){case"string":return t.String();case"uuid":return t.String({format:"uuid"});case"number":return t.Number();case"boolean":return t.Boolean();case"array":return t.Array(t.Any());case"json":return t.Object({});case"date":return t.Transform(t.String({format:"date"})).Decode((date)=>new Date(date)).Encode((date)=>date.toISOString());case"datetime":return t.Transform(t.String({format:"date-time"})).Decode((date)=>new Date(date)).Encode((date)=>date.toISOString());case"bigint":return t.BigInt();case"buffer":return t.File();default:return t.Never()}},AbstractModel=(tableName,columns,adapter,baseTable)=>{let columnMetadata=adapter.getColumns(baseTable);class M{static $inferSelect=void 0;static $inferInsert=void 0;static $inferUpdate=void 0;static get table(){if(!Application3.instance||!Application3.context.getStore)return baseTable;if(this.supportTenancy){let tenant=getCurrentTenant()??"public";if(tenant!=="public"){let strategy=getTenancyStrategy();if(strategy)return strategy.resolveTable(baseTable,tenant);return adapter.createTenantTable(baseTable,tenant)}}return baseTable}static tableName=tableName;static columns=columns;static insertSchema=createSchemaFromModel(columnMetadata,{mode:"create"});static updateSchema=createSchemaFromModel(columnMetadata,{mode:"update"});static selectSchema=createSchemaFromModel(columnMetadata,{mode:"select"});static supportTenancy=!1}return M};var AbstractRepository=(model,database)=>{class R{static Model=model;static connection="default";get db(){return database.getConnection(this.constructor.connection)}}return R};import{Module}from"@elysiumjs/core";import{KeyvCacheableMemory}from"cacheable";import{EventEmitter}from"events";import{Event,Redis,Service as Service4}from"@elysiumjs/core";class KeyvRedis extends EventEmitter{#client;#namespace;#keyPrefixSeparator="::";#clearBatchSize=1000;#useUnlink=!0;#noNamespaceAffectsAll=!1;#connection;constructor(props){super();this.#connection=props.connection,this.#namespace=props.namespace,this.#keyPrefixSeparator=props.keyPrefixSeparator??"::",this.#clearBatchSize=props.clearBatchSize??1000,this.#useUnlink=props.useUnlink??!0,this.#noNamespaceAffectsAll=props.noNamespaceAffectsAll??!1,this.on("error",(error)=>{Event.emit("elysium:error",error)})}async getClient(){return this.#client??=await Service4.resolve(Redis.getConnectionName(this.#connection)),this.#client}get opts(){return{namespace:this.#namespace,keyPrefixSeparator:this.#keyPrefixSeparator,clearBatchSize:this.#clearBatchSize,noNamespaceAffectsAll:this.#noNamespaceAffectsAll,dialect:"redis",url:this.#connection}}get namespace(){return this.#namespace}set namespace(value){this.#namespace=value}async get(key){let client=await this.getClient();key=this.createKeyPrefix(key,this.#namespace);let value=await client.get(key);return value===null?void 0:value}async set(key,value,ttl){let client=await this.getClient();if(key=this.createKeyPrefix(key,this.#namespace),ttl)await client.set(key,value,"PX",ttl);else await client.set(key,value)}async setMany(values){let client=await this.getClient(),multi=[];for(let{key,value,ttl}of values){let prefixedKey=this.createKeyPrefix(key,this.#namespace);if(ttl)multi.push(client.set(prefixedKey,value,"PX",ttl));else multi.push(client.set(prefixedKey,value))}await Promise.all(multi)}async delete(key){let client=await this.getClient();return key=this.createKeyPrefix(key,this.#namespace),await(this.#useUnlink?client.send("UNLINK",[key]):client.del(key))>0}async clear(){try{let client=await this.getClient();if(!this.#namespace&&this.#noNamespaceAffectsAll){await client.send("FLUSHDB",[]);return}let cursor="0",batchSize=this.#clearBatchSize,match=this.#namespace?`${this.#namespace}${this.#keyPrefixSeparator}*`:"*",deletePromises=[];do{let result=await client.send("SCAN",[cursor,"MATCH",match,"COUNT",batchSize.toString(),"TYPE","string"]),[newCursor,keys]=result;if(cursor=newCursor.toString(),keys.length===0)continue;if(!this.#namespace)keys=keys.filter((key)=>!key.includes(this.#keyPrefixSeparator));deletePromises.push(keys.map((key)=>client.del(key)))}while(cursor!=="0");await Promise.all(deletePromises)}catch(error){this.emit("error",error)}}async has(key){let client=await this.getClient();return key=this.createKeyPrefix(key,this.#namespace),client.exists(key)}async hasMany(keys){let client=await this.getClient(),multi=[];for(let key of keys){let prefixedKey=this.createKeyPrefix(key,this.#namespace);multi.push(client.exists(prefixedKey))}return Promise.all(multi)}async getMany(keys){let client=await this.getClient();if(keys.length===0)return[];return keys=keys.map((key)=>this.createKeyPrefix(key,this.#namespace)),await client.mget(...keys)}async disconnect(){this.#client=void 0}async deleteMany(keys){let client=await this.getClient(),result=!1,multi=[];for(let key of keys){let prefixedKey=this.createKeyPrefix(key,this.#namespace);if(this.#useUnlink)multi.push(client.send("UNLINK",[prefixedKey]));else multi.push(client.del(prefixedKey))}let results=await Promise.all(multi);for(let deleted of results)if(typeof deleted==="number"&&deleted>0)result=!0;return result}async*iterator(namespace){let client=await this.getClient(),match=namespace?`${namespace}${this.#keyPrefixSeparator}*`:"*",cursor="0";do{let result=await client.send("SCAN",[cursor,"MATCH",match,"TYPE","string"]),[newCursor,keys]=result;if(cursor=newCursor.toString(),!namespace&&!this.#noNamespaceAffectsAll)keys=keys.filter((key)=>!key.includes(this.#keyPrefixSeparator));if(keys.length>0){let values=await client.mget(...keys);for(let i of keys.keys()){let key=this.getKeyWithoutPrefix(keys[i],namespace),value=values[i];yield[key,value]}}}while(cursor!=="0")}createKeyPrefix(key,namespace){return namespace?`${namespace}${this.#keyPrefixSeparator}${key}`:key}getKeyWithoutPrefix(key,namespace){return namespace?key.replace(`${namespace}${this.#keyPrefixSeparator}`,""):key}}class MnemosyneModule extends Module.configurable({defaults:{cache:{redis:{connection:"cache"},memory:{ttl:60000,lruSize:5000}}}}){}MnemosyneModule=__legacyDecorateClassTS([Module.register({services:(config)=>{let services=[],{redis,memory}=config.cache;if(redis)services.push({name:REDIS_CACHE_SERVICE,global:!0,factory:()=>makeCacheInterface(new KeyvRedis({connection:redis.connection}))});if(memory)services.push({name:MEMORY_CACHE_SERVICE,global:!0,factory:()=>makeCacheInterface(new KeyvCacheableMemory({ttl:memory.ttl,lruSize:memory.lruSize}))});return services}})],MnemosyneModule);export{AbstractDatabase,AbstractModel,AbstractRepository,Cache,KeyvRedis,MEMORY_CACHE_SERVICE,MnemosyneModule,REDIS_CACHE_SERVICE,SimpleTenantMiddleware,StrictTenantMiddleware,TENANCY_CONFIG_SERVICE,TENANCY_STRATEGY_SERVICE,TenantMiddleware,createDatabaseCacheStorage,createSchemaFromModel,getCurrentTenant,getTenancyConfig,getTenancyStrategy,withTenant};

package/dist/keyv-redis.d.ts

@@ -35,7 +35,11 @@ export declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter
          */
         noNamespaceAffectsAll?: boolean;
     });
-    get client(): Bun.RedisClient;
+    /**
+     * Resolves the Redis client on first use. The async path is always safe, even when the
+     * Redis module has not been initialised yet (lazy boot).
+     */
+    protected getClient(): Promise<Bun.RedisClient>;
     /**
      * Get the options for the adapter.
      */

package/dist/mnemosyne.module.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Configuration of the {@link MnemosyneModule}.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type MnemosyneModuleConfig = {
+    cache: {
+        /** The Redis-backed cache. Set to `false` to not provide `Cache.redis`. */
+        redis?: {
+            /** The name of the Redis connection to use. */
+            connection: string;
+        } | false;
+        /** The memory cache. Set to `false` to not provide `Cache.memory`. */
+        memory?: {
+            /** The default TTL of entries, in milliseconds. */
+            ttl: number;
+            /** The maximum number of entries kept. */
+            lruSize: number;
+        } | false;
+    };
+};
+declare const MnemosyneModule_base: (abstract new () => {
+    readonly config: MnemosyneModuleConfig;
+    onInit(): Promise<void> | void;
+    onDestroy(): Promise<void> | void;
+    onServe(_app: import("elysia").default<any>): Promise<void> | void;
+}) & {
+    readonly config: string;
+    with(config: Partial<MnemosyneModuleConfig> | (() => Partial<MnemosyneModuleConfig> | Promise<Partial<MnemosyneModuleConfig>>)): import("@elysiumjs/core").ConfiguredModule<MnemosyneModuleConfig>;
+    resolveConfig(input?: Partial<MnemosyneModuleConfig> | undefined): MnemosyneModuleConfig;
+    register<TConfig_1 = any>(props?: import("@elysiumjs/core").ModuleProps<TConfig_1>): (target: import("@elysiumjs/core").ModuleClass) => void;
+    configurable<TConfig extends object>(options?: {
+        defaults?: Partial<TConfig>;
+        required?: (keyof TConfig)[];
+    }): any;
+};
+/**
+ * Provides the caches as the global services `mnemosyne.cache.redis` and
+ * `mnemosyne.cache.memory`. Tenancy config and strategy, and database connections, are
+ * registered by the database driver modules.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare class MnemosyneModule extends MnemosyneModule_base {
+}
+export {};

package/dist/model.d.ts

@@ -7,7 +7,7 @@ import type { ColumnMetadata, ModelAdapter } from './interfaces';
  * @returns A validation schema based on the given columns.
  */
 export declare const createSchemaFromModel: (columns: ColumnMetadata[], { mode }?: {
-    mode?: "create" | "update" | "select";
+    mode?: 'create' | 'update' | 'select';
 }) => import("@sinclair/typebox").TObject<{}>;
 /**
  * Mixin used to create a new abstract model class.

package/dist/tenancy.d.ts

@@ -65,24 +65,23 @@ export interface ModelTenancyConfig {
      */
     policyName?: string;
 }
+/** Name of the global service holding the {@link TenancyConfig}, registered by driver modules. */
+export declare const TENANCY_CONFIG_SERVICE = "mnemosyne.tenancy.config";
+/** Name of the global service holding the {@link TenancyStrategy}, registered by driver modules. */
+export declare const TENANCY_STRATEGY_SERVICE = "mnemosyne.tenancy.strategy";
 /**
  * Gets the current global tenancy configuration.
  *
- * Reads from the 'elysium:mnemosyne' app config key. Returns a default
- * configuration if the app is not yet initialized or no tenancy config is set.
+ * Reads the global service `mnemosyne.tenancy.config`. Returns a default
+ * configuration if none is registered.
  *
  * @author Axel Nana <axel.nana@workbud.com>
  * @returns The current tenancy configuration.
  */
-export declare const getConfig: () => TenancyConfig;
+export declare const getTenancyConfig: () => TenancyConfig;
 /**
- * Registers the tenancy strategy to use for table resolution and isolation.
- * @author Axel Nana <axel.nana@workbud.com>
- * @param strategy The tenancy strategy to register.
- */
-export declare const registerTenancyStrategy: (strategy: TenancyStrategy<unknown, unknown>) => void;
-/**
- * Gets the currently registered tenancy strategy.
+ * Gets the tenancy strategy registered by the driver module as the global service
+ * `mnemosyne.tenancy.strategy`.
  * @author Axel Nana <axel.nana@workbud.com>
  * @returns The current tenancy strategy, or `null` if none is registered.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@elysiumjs/mnemosyne",
-	"version": "0.1.0",
+	"version": "0.2.0",
 	"license": "Apache-2.0",
 	"description": "Database and caching for Elysium.js applications",
 	"private": false,
@@ -13,7 +13,7 @@
 	"scripts": {
 		"format": "prettier --write \"./src/**/*.ts\"",
 		"clean": "rimraf dist",
-		"build:js": "bun build ./src/index.ts --outdir ./dist --target bun --packages external --root ./src --minify",
+		"build:js": "bun build ./src/index.ts --outdir ./dist --target bun --packages external --root ./src --minify-syntax --minify-whitespace",
 		"build:ts": "tsc",
 		"build": "bun run clean && bun run build:js && bun run build:ts",
 		"typecheck": "tsc --noEmit",
@@ -30,16 +30,15 @@
 	"types": "dist/index.d.ts",
 	"sideEffects": false,
 	"peerDependencies": {
-		"@elysiumjs/core": "^0.7.0"
+		"@elysiumjs/core": "^0.8.0"
 	},
 	"devDependencies": {
-		"@elysiumjs/core": "0.7.0"
+		"@elysiumjs/core": "0.8.0"
 	},
 	"dependencies": {
-		"cache-manager": "^7.2.3",
-		"cacheable": "^2.0.3",
-		"keyv": "^5.0.0",
-		"radash": "^12.1.1",
-		"reflect-metadata": "^0.2.2"
+		"cache-manager": "^7.2.9",
+		"cacheable": "^2.5.0",
+		"keyv": "^5.6.0",
+		"radash": "^12.1.1"
 	}
 }

package/src/cache.ts

@@ -14,12 +14,16 @@
 
 import type { KeyvStoreAdapter } from 'keyv';
 
+import { Service, ServiceNotFoundError } from '@elysiumjs/core';
 import { createCache } from 'cache-manager';
-import { KeyvCacheableMemory } from 'cacheable';
 import { Keyv } from 'keyv';
 import { alphabetical } from 'radash';
 
-import { KeyvRedis } from './keyv-redis';
+/** 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.
@@ -118,7 +122,7 @@ export interface CacheInterface {
  * @param store The cache storage to use in the interface.
  * @returns A new `CacheInterface`.
  */
-const makeCacheInterface = (store: KeyvStoreAdapter): CacheInterface => {
+export const makeCacheInterface = (store: KeyvStoreAdapter): CacheInterface => {
 	const base = createCache({
 		stores: [
 			new Keyv({
@@ -154,10 +158,17 @@ const makeCacheInterface = (store: KeyvStoreAdapter): CacheInterface => {
 	};
 };
 
-export abstract class Cache {
-	static #redis: CacheInterface | undefined;
-	static #memory: CacheInterface | undefined;
+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>
@@ -191,28 +202,18 @@ export abstract class Cache {
 	/**
 	 * 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 {
-		if (!Cache.#redis) {
-			Cache.#redis = makeCacheInterface(
-				new KeyvRedis({
-					connection: 'cache'
-				})
-			);
-		}
-
-		return Cache.#redis;
+		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 {
-		if (!Cache.#memory) {
-			Cache.#memory = makeCacheInterface(new KeyvCacheableMemory({ ttl: 60000, lruSize: 5000 }));
-		}
-
-		return Cache.#memory;
+		return getCache(MEMORY_CACHE_SERVICE);
 	}
 }

package/src/database.ts

@@ -15,7 +15,7 @@
 import type { CacheInterface } from './cache';
 import type { DatabaseCacheConfig, DatabaseDriver } from './interfaces';
 
-import { Application, Service } from '@elysiumjs/core';
+import { Application, Service, ServiceNotFoundError } from '@elysiumjs/core';
 
 import { Cache } from './cache';
 
@@ -35,8 +35,8 @@ export const createDatabaseCacheStorage = (
 /**
  * Abstract database manager.
  *
- * Manages named database connections using a driver. Connections are
- * registered in the service container and can be retrieved by name.
+ * 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.
@@ -49,11 +49,13 @@ export abstract class AbstractDatabase<TConnection, TConnectionConfig> {
 	protected abstract driver: DatabaseDriver<TConnection, TConnectionConfig>;
 
 	/**
-	 * Creates a service name for a database connection.
+	 * 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.
 	 */
-	private getConnectionName(name: string): string {
+	public static getConnectionName(name: string): string {
 		return `db.connection.${name}`;
 	}
 
@@ -62,6 +64,7 @@ export abstract class AbstractDatabase<TConnection, TConnectionConfig> {
 	 *
 	 * 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.
@@ -73,39 +76,11 @@ export abstract class AbstractDatabase<TConnection, TConnectionConfig> {
 			if (tx) return tx;
 		}
 
-		const serviceName = this.getConnectionName(name);
-		if (!Service.exists(serviceName)) {
-			// TODO: Use logger service here
-			console.error(
-				`No connection with name ${name} found. Please make sure to register the connection before using it.`
-			);
-			process.exit(1);
-		}
-
-		return Service.get<TConnection>(serviceName)!;
-	}
-
-	/**
-	 * Creates and registers a new connection.
-	 *
-	 * This will make the registered connection available for dependency injection with
-	 * the key `db.connection.{name}`, where `{name}` is replaced with the given name.
-	 *
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 * @param name The connection name.
-	 * @param config The connection configuration.
-	 * @returns The newly created and registered connection.
-	 */
-	public registerConnection(name: string, config: TConnectionConfig): TConnection {
-		const serviceName = this.getConnectionName(name);
-		if (Service.exists(serviceName)) {
-			// TODO: Use logger service here
-			console.error(`A connection with the name ${name} has already been registered.`);
-			process.exit(1);
-		}
+		const serviceName = AbstractDatabase.getConnectionName(name);
+		const connection = Service.get<TConnection>(serviceName);
+		if (connection === null) throw new ServiceNotFoundError(serviceName);
 
-		const connection = this.driver.createConnection(config);
-		return Service.instance(serviceName, connection);
+		return connection;
 	}
 
 	/**
@@ -115,7 +90,7 @@ export abstract class AbstractDatabase<TConnection, TConnectionConfig> {
 	 * @returns `true` if the connection exists, `false` otherwise.
 	 */
 	public connectionExists(name: string): boolean {
-		return Service.exists(this.getConnectionName(name));
+		return Service.exists(AbstractDatabase.getConnectionName(name));
 	}
 
 	/**
@@ -127,18 +102,6 @@ export abstract class AbstractDatabase<TConnection, TConnectionConfig> {
 		return this.getConnection('default');
 	}
 
-	/**
-	 * Sets the default connection.
-	 * @author Axel Nana <axel.nana@workbud.com>
-	 * @param name The name of the connection to set as default.
-	 * @returns The default connection.
-	 */
-	public setDefaultConnection(name: string): TConnection {
-		const serviceName = this.getConnectionName('default');
-		Service.remove(serviceName);
-		return Service.instance(serviceName, this.getConnection(name));
-	}
-
 	/**
 	 * Returns the raw underlying client for the given connection.
 	 * @author Axel Nana <axel.nana@workbud.com>