@elysiumjs/mnemosyne 0.1.0

package/coverage/lcov.info

@@ -0,0 +1,549 @@
+TN:
+SF:../core/dist/index.js
+FNF:226
+FNH:36
+DA:1,0
+DA:2,0
+DA:3,0
+DA:4,0
+DA:5,0
+DA:6,0
+DA:7,0
+DA:8,0
+DA:9,0
+DA:10,0
+DA:11,0
+DA:12,0
+DA:13,0
+DA:14,0
+DA:15,0
+DA:16,0
+DA:17,0
+DA:18,0
+DA:19,1221
+LF:19
+LH:1
+end_of_record
+TN:
+SF:src/cache.ts
+FNF:8
+FNH:7
+DA:17,73
+DA:18,96
+DA:19,56
+DA:20,76
+DA:22,82
+DA:121,79
+DA:122,60
+DA:123,30
+DA:124,36
+DA:125,28
+DA:126,48
+DA:127,12
+DA:128,6
+DA:129,10
+DA:131,56
+DA:133,30
+DA:134,17
+DA:135,38
+DA:136,162
+DA:137,86
+DA:139,41
+DA:140,62
+DA:141,42
+DA:142,48
+DA:143,40
+DA:144,42
+DA:145,24
+DA:146,18
+DA:147,22
+DA:149,76
+DA:150,13
+DA:152,34
+DA:154,8
+DA:157,56
+DA:158,32
+DA:159,34
+DA:165,48
+DA:170,41
+DA:177,29
+DA:178,116
+DA:179,63
+DA:186,29
+DA:187,55
+DA:189,27
+DA:195,21
+DA:196,51
+DA:197,68
+DA:198,46
+DA:199,50
+DA:200,4
+DA:201,12
+DA:202,9
+DA:204,63
+DA:211,22
+DA:212,53
+DA:213,190
+DA:214,9
+DA:216,46
+DA:218,1
+LF:59
+LH:59
+end_of_record
+TN:
+SF:src/database.ts
+FNF:9
+FNH:7
+DA:18,55
+DA:20,32
+DA:29,0
+DA:30,0
+DA:31,0
+DA:32,1
+DA:45,16
+DA:56,12
+DA:57,31
+DA:70,24
+DA:71,30
+DA:72,62
+DA:73,18
+DA:74,4
+DA:76,53
+DA:77,40
+DA:79,14
+DA:80,101
+DA:81,8
+DA:82,20
+DA:83,4
+DA:85,32
+DA:99,20
+DA:100,53
+DA:101,39
+DA:103,87
+DA:104,20
+DA:105,4
+DA:107,60
+DA:108,49
+DA:117,12
+DA:118,52
+DA:126,8
+DA:127,37
+DA:136,12
+DA:137,58
+DA:138,32
+DA:139,63
+DA:148,24
+DA:149,58
+DA:151,1
+LF:41
+LH:38
+end_of_record
+TN:
+SF:src/keyv-redis.ts
+FNF:29
+FNH:20
+DA:34,1
+DA:36,27
+DA:68,10
+DA:69,24
+DA:71,95
+DA:72,115
+DA:73,12
+DA:75,80
+DA:76,76
+DA:77,128
+DA:78,112
+DA:79,92
+DA:80,142
+DA:82,69
+DA:83,79
+DA:84,16
+DA:87,22
+DA:88,49
+DA:94,20
+DA:95,28
+DA:96,66
+DA:97,102
+DA:98,86
+DA:99,114
+DA:100,46
+DA:101,50
+DA:102,0
+DA:103,0
+DA:104,0
+DA:105,0
+DA:106,0
+DA:107,0
+DA:108,0
+DA:109,0
+DA:110,33
+DA:116,35
+DA:117,61
+DA:120,25
+DA:121,106
+DA:122,90
+DA:124,93
+DA:127,49
+DA:128,106
+DA:130,31
+DA:131,98
+DA:132,14
+DA:133,53
+DA:137,35
+DA:139,42
+DA:141,97
+DA:142,138
+DA:143,35
+DA:145,130
+DA:146,31
+DA:148,117
+DA:150,9
+DA:152,64
+DA:155,28
+DA:156,106
+DA:158,81
+DA:159,69
+DA:160,31
+DA:162,49
+DA:165,21
+DA:166,22
+DA:167,114
+DA:168,46
+DA:169,13
+DA:170,13
+DA:172,46
+DA:173,90
+DA:174,178
+DA:175,64
+DA:177,24
+DA:178,114
+DA:179,34
+DA:180,36
+DA:181,32
+DA:182,36
+DA:183,62
+DA:184,34
+DA:185,32
+DA:186,22
+DA:189,78
+DA:190,76
+DA:192,56
+DA:193,17
+DA:194,9
+DA:196,33
+DA:197,77
+DA:198,9
+DA:200,67
+DA:201,31
+DA:203,41
+DA:204,42
+DA:205,0
+DA:206,0
+DA:207,0
+DA:208,0
+DA:209,0
+DA:210,0
+DA:211,0
+DA:212,0
+DA:213,0
+DA:214,0
+DA:215,0
+DA:216,0
+DA:217,0
+DA:218,0
+DA:219,0
+DA:220,0
+DA:221,0
+DA:222,37
+DA:225,31
+DA:226,52
+DA:227,14
+DA:228,9
+DA:230,144
+DA:231,102
+DA:233,0
+DA:234,0
+DA:235,0
+DA:236,0
+DA:237,0
+DA:238,0
+DA:239,0
+DA:240,0
+DA:241,0
+DA:242,0
+DA:243,0
+DA:244,0
+DA:245,0
+DA:246,0
+DA:247,0
+DA:248,0
+DA:249,0
+DA:250,0
+DA:251,0
+DA:252,0
+DA:253,0
+DA:254,0
+DA:255,0
+DA:256,0
+DA:257,0
+DA:258,0
+DA:259,0
+DA:260,0
+DA:261,0
+DA:262,0
+DA:263,0
+DA:264,0
+DA:265,0
+DA:266,0
+DA:267,0
+DA:268,0
+DA:269,0
+DA:270,0
+DA:271,0
+DA:272,0
+DA:273,0
+DA:274,0
+DA:275,0
+DA:276,0
+DA:277,0
+DA:278,0
+DA:279,0
+DA:280,0
+DA:281,0
+DA:282,0
+DA:283,0
+DA:284,0
+DA:285,0
+DA:286,0
+DA:287,0
+DA:288,0
+DA:289,0
+DA:290,0
+DA:291,31
+DA:300,59
+DA:301,148
+DA:310,0
+DA:311,91
+DA:313,1
+LF:183
+LH:99
+end_of_record
+TN:
+SF:src/model.ts
+FNF:10
+FNH:5
+DA:18,46
+DA:19,27
+DA:21,65
+DA:30,36
+DA:31,11
+DA:32,27
+DA:33,3
+DA:34,74
+DA:36,24
+DA:38,34
+DA:39,70
+DA:40,13
+DA:41,4
+DA:43,54
+DA:45,27
+DA:46,66
+DA:47,4
+DA:49,69
+DA:50,66
+DA:51,2
+DA:52,2
+DA:54,29
+DA:63,37
+DA:64,34
+DA:65,15
+DA:66,22
+DA:67,13
+DA:68,40
+DA:69,15
+DA:70,22
+DA:71,16
+DA:72,23
+DA:73,14
+DA:74,28
+DA:75,13
+DA:76,24
+DA:77,13
+DA:78,9
+DA:79,40
+DA:80,8
+DA:81,12
+DA:82,17
+DA:83,9
+DA:84,45
+DA:85,8
+DA:86,12
+DA:87,15
+DA:88,22
+DA:89,15
+DA:90,15
+DA:92,2
+DA:106,29
+DA:107,22
+DA:108,18
+DA:109,18
+DA:110,28
+DA:111,6
+DA:112,110
+DA:114,40
+DA:118,72
+DA:123,72
+DA:128,75
+DA:134,25
+DA:136,137
+DA:137,39
+DA:138,7
+DA:140,34
+DA:141,54
+DA:142,36
+DA:143,48
+DA:144,27
+DA:145,58
+DA:146,11
+DA:147,60
+DA:148,7
+DA:149,7
+DA:151,44
+DA:157,66
+DA:162,58
+DA:167,168
+DA:172,168
+DA:177,168
+DA:185,50
+DA:186,6
+DA:188,19
+LF:85
+LH:85
+end_of_record
+TN:
+SF:src/repository.ts
+FNF:4
+FNH:3
+DA:30,34
+DA:31,14
+DA:32,26
+DA:33,6
+DA:38,40
+DA:42,50
+DA:49,57
+DA:54,22
+DA:55,126
+DA:134,6
+DA:136,19
+LF:11
+LH:11
+end_of_record
+TN:
+SF:src/tenancy.ts
+FNF:10
+FNH:0
+DA:18,78
+DA:101,42
+DA:116,0
+DA:117,0
+DA:118,0
+DA:119,0
+DA:120,0
+DA:121,0
+DA:122,50
+DA:134,0
+DA:135,26
+DA:143,0
+DA:144,22
+DA:156,0
+DA:157,0
+DA:158,0
+DA:159,0
+DA:160,0
+DA:161,41
+DA:171,0
+DA:172,0
+DA:173,0
+DA:174,0
+DA:175,56
+DA:203,102
+DA:207,50
+DA:212,42
+DA:217,0
+DA:218,0
+DA:219,0
+DA:220,0
+DA:221,0
+DA:222,0
+DA:223,0
+DA:224,0
+DA:225,0
+DA:226,0
+DA:227,0
+DA:228,0
+DA:229,0
+DA:230,0
+DA:231,0
+DA:232,0
+DA:233,0
+DA:234,0
+DA:235,0
+DA:236,38
+DA:245,0
+DA:246,0
+DA:247,0
+DA:248,0
+DA:249,0
+DA:250,0
+DA:251,0
+DA:252,0
+DA:253,0
+DA:254,0
+DA:255,0
+DA:256,0
+DA:257,0
+DA:258,0
+DA:259,0
+DA:260,0
+DA:261,0
+DA:262,0
+DA:263,0
+DA:264,0
+DA:265,0
+DA:266,0
+DA:267,0
+DA:268,0
+DA:269,0
+DA:270,0
+DA:271,0
+DA:272,0
+DA:273,0
+DA:274,0
+DA:275,48
+DA:277,2
+DA:283,126
+DA:289,126
+DA:290,42
+DA:291,1
+LF:83
+LH:17
+end_of_record
+TN:
+SF:tests/setup.ts
+FNF:3
+FNH:1
+DA:15,0
+DA:16,0
+DA:17,0
+DA:18,0
+DA:19,0
+DA:20,0
+DA:21,0
+DA:22,30
+DA:23,47
+DA:24,19
+DA:25,2
+DA:26,2
+LF:12
+LH:5
+end_of_record

package/dist/cache.d.ts

@@ -0,0 +1,113 @@
+/**
+ * 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'>;
+}
+export declare abstract class Cache {
+    #private;
+    /**
+     * A weak cache storage for simple non-intrusive caching of data.
+     * @author Axel Nana <axel.nana@workbud.com>
+     */
+    static readonly weak: {
+        /**
+         * INTERNAL USAGE ONLY.
+         * @private
+         */
+        map: 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;
+        /**
+         * Deletes the cached data for a given context.
+         * @param ctx The cache context.
+         */
+        del(ctx: object): void;
+    };
+    /**
+     * Redis-based cache storage.
+     * @author Axel Nana <axel.nana@workbud.com>
+     */
+    static get redis(): CacheInterface;
+    /**
+     * Memory-based cache storage.
+     * @author Axel Nana <axel.nana@workbud.com>
+     */
+    static get memory(): CacheInterface;
+}

package/dist/database.d.ts

@@ -0,0 +1,82 @@
+import type { CacheInterface } from './cache';
+import type { DatabaseCacheConfig, DatabaseDriver } from './interfaces';
+/**
+ * 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 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.
+ *
+ * @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 declare 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.
+     * @param name The name of the connection.
+     * @returns A service name for the connection.
+     */
+    private getConnectionName;
+    /**
+     * 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.
+     *
+     * @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>
+     * @param name The name of the connection to check.
+     * @returns `true` if the connection exists, `false` otherwise.
+     */
+    connectionExists(name: string): boolean;
+    /**
+     * Retrieves the default connection.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @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>
+     * @param name The connection name.
+     * @returns The raw client instance.
+     */
+    getRawClient(name?: string): unknown;
+}