@daiso-tech/core 0.26.1 → 0.28.0

package/dist/cache/implementations/derivables/cache-factory/cache-factory.js

@@ -1,133 +1,163 @@
 /**
  * @module Cache
  */
-import { DefaultAdapterNotDefinedError, UnregisteredAdapterError, } from "../../../../utilities/_module-exports.js";
-import { registerCacheErrorsToSerde, registerCacheEventsToSerde, } from "../../../../cache/contracts/_module-exports.js";
-import { Cache } from "../../../../cache/implementations/derivables/cache/cache.js";
+import { DefaultAdapterNotDefinedError, resolveOneOrMore, UnregisteredAdapterError, } from "../../../../utilities/_module-exports.js";
+import { Cache, } from "../../../../cache/implementations/derivables/cache/_module.js";
+import { KeyPrefixer } from "../../../../utilities/_module-exports.js";
 /**
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/implementations/derivables"```
+ * IMPORT_PATH: ```"@daiso-tech/core/cache"```
  * @group Derivables
  */
 export class CacheFactory {
-    cacheRecord = {};
-    defaultAdapter;
-    eventBus;
-    defaultTtl;
-    retryAttempts;
-    backoffPolicy;
-    retryPolicy;
-    timeout;
-    serde;
-    shouldRegisterErrors;
-    shouldRegisterEvents;
+    settings;
     /**
      * @example
      * ```ts
-     * import { CacheFactory } from "@daiso-tech/core/cache/implementations/derivables";
-     * import { MemoryCacheAdapter, RedisCacheAdapter } from "@daiso-tech/core/cache/implementations/adapters";
-     * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
-     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
-     * import Redis from "ioredis"
-     *
-     * const serde = new Serde(new SuperJsonSerdeAdapter());
-     * const cacheFactory = new CacheFactory({
-     *   serde,
-     *   adapters: {
-     *     memory: new MemoryCacheAdapter({
-     *       rootGroup: "@global"
-     *     }),
-     *     redis: new RedisCacheAdapter({
-     *       client: new Redis("YOUR_REDIS_CONNECTION"),
-     *       serde,
-     *       rootGroup: "@global"
-     *     }),
-     *   },
-     *   defaultAdapter: "memory",
-     * });
      * ```
      */
     constructor(settings) {
-        const { shouldRegisterErrors = true, shouldRegisterEvents = true, serde, adapters, defaultAdapter, eventBus, defaultTtl = null, retryAttempts, backoffPolicy, retryPolicy, timeout, } = settings;
-        this.shouldRegisterErrors = shouldRegisterErrors;
-        this.shouldRegisterEvents = shouldRegisterEvents;
-        this.serde = serde;
-        this.defaultAdapter = defaultAdapter;
-        this.eventBus = eventBus;
-        this.defaultTtl = defaultTtl;
-        this.retryAttempts = retryAttempts;
-        this.backoffPolicy = backoffPolicy;
-        this.retryPolicy = retryPolicy;
-        this.timeout = timeout;
-        this.cacheRecord = this.init(adapters);
+        this.settings = settings;
     }
-    init(adapters) {
-        if (this.shouldRegisterErrors) {
-            registerCacheErrorsToSerde(this.serde);
-        }
-        if (this.shouldRegisterEvents) {
-            registerCacheEventsToSerde(this.serde);
-        }
-        const cacheRecord = {};
-        for (const key in adapters) {
-            const { [key]: adapter } = adapters;
-            if (adapter === undefined) {
-                continue;
-            }
-            cacheRecord[key] = new Cache({
-                adapter,
-                eventBus: this.eventBus,
-                defaultTtl: this.defaultTtl,
-                retryAttempts: this.retryAttempts,
-                backoffPolicy: this.backoffPolicy,
-                retryPolicy: this.retryPolicy,
-                timeout: this.timeout,
-            });
-        }
-        return cacheRecord;
+    setKeyPrefixer(keyPrefixer) {
+        return new CacheFactory({
+            ...this.settings,
+            keyPrefixer,
+        });
+    }
+    setDefaultTtl(ttl) {
+        return new CacheFactory({
+            ...this.settings,
+            defaultTtl: ttl,
+        });
+    }
+    setEventBus(eventBus) {
+        return new CacheFactory({
+            ...this.settings,
+            eventBus,
+        });
+    }
+    setRetryAttempts(attempts) {
+        return new CacheFactory({
+            ...this.settings,
+            retryAttempts: attempts,
+        });
+    }
+    setBackoffPolicy(policy) {
+        return new CacheFactory({
+            ...this.settings,
+            backoffPolicy: policy,
+        });
+    }
+    setRetryPolicy(policy) {
+        return new CacheFactory({
+            ...this.settings,
+            retryPolicy: policy,
+        });
+    }
+    setRetryTimeout(timeout) {
+        return new CacheFactory({
+            ...this.settings,
+            retryTimeout: timeout,
+        });
+    }
+    setTotalTimeout(timeout) {
+        return new CacheFactory({
+            ...this.settings,
+            totalTimeout: timeout,
+        });
     }
     /**
      * @example
      * ```ts
-     * import { CacheFactory } from "@daiso-tech/core/cache/implementations/derivables";
-     * import { MemoryCacheAdapter, RedisCacheAdapter } from "@daiso-tech/core/cache/implementations/adapters";
-     * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
-     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
+     * import { CacheFactory } from "@daiso-tech/core/cache";
+     * import type { ICacheAdapter } from "@daiso-tech/core/cache/contracts";
+     * import { MemoryCacheAdapter, RedisCacheAdapter, SqliteCacheAdapter } from "@daiso-tech/core/cache/adapters";
+     * import { Serde } from "@daiso-tech/core/serde";
+     * import type { ISerde } from "@daiso-tech/core/serde/contracts";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/adapters";
+     * import { KeyPrefixer, TimeSpan, type ISqliteDatabase, type FactoryFn } from "@daiso-tech/core/utilities";
      * import Redis from "ioredis"
+     * import Sqlite from "better-sqlite3";
      *
+     * function cahceAdapterFactory(database: ISqliteDatabase, serde: ISerde<string>): FactoryFn<string, ICacheAdapter> {
+     *   return async (prefix) => {
+     *     const cacheAdapter = new SqliteCacheAdapter({
+     *       database,
+     *       serde,
+     *       tableName: `cache_${prefix}`
+     *     });
+     *     await cacheAdapter.init();
+     *     return cacheAdapter;
+     *   }
+     * }
+     *
+     * const database = new Sqlite("local.db");
      * const serde = new Serde(new SuperJsonSerdeAdapter());
      * const cacheFactory = new CacheFactory({
      *   serde,
+     *   keyPrefixer: new KeyPrefixer("cache"),
      *   adapters: {
-     *     memory: new MemoryCacheAdapter({
-     *       rootGroup: "@global"
-     *     }),
+     *     sqlite: cahceAdapterFactory(database, serde),
+     *     memory: new MemoryCacheAdapter(),
      *     redis: new RedisCacheAdapter({
      *       client: new Redis("YOUR_REDIS_CONNECTION"),
      *       serde,
-     *       rootGroup: "@global"
      *     }),
      *   },
      *   defaultAdapter: "memory",
-     *   eventBus,
      * });
      *
      * // Will add key to cache using the default adapter which is MemoryCacheAdapter
-     * await cacheFactory.use().add("a", 1);
+     * await cacheFactory
+     *   .use()
+     *   .add("a", 1);
      *
      * // Will add key to cache using the redis adapter which is RedisCacheAdapter
-     * await cacheFactory.use("redis").add("a", 1);
+     * await cacheFactory
+     *   .use("redis")
+     *   .add("a", 1);
+     *
+     * // You can change the default settings of the returned Cache instance.
+     * await cacheFactory
+     *   .setDefaultTtl(TimeSpan.fromMinutes(2))
+     *   .use("sqlite")
+     *   .add("a", 1);
+     *
+     * // You can reuse the settings
+     * const longLivedCacheFactory = cacheFactory
+     *   .setDefaultTtl(TimeSpan.fromMinutes(2));
+     *
+     * await longLivedCacheFactory
+     *   .use()
+     *   .add("a", 1);
+     *
+     * // You can extend the settings
+     * const extendedCacheFactory = longLivedCacheFactory
+     *   .setRetryTimeout(TimeSpan.fromSeconds(1));
+     *
+     * await extendedCacheFactory
+     *   .use()
+     *   .add("a", 1);
      * ```
      */
-    use(adapterName = this.defaultAdapter) {
+    use(adapterName = this.settings.defaultAdapter) {
         if (adapterName === undefined) {
             throw new DefaultAdapterNotDefinedError(CacheFactory.name);
         }
-        const cache = this.cacheRecord[adapterName];
-        if (cache === undefined) {
+        const adapter = this.settings.adapters[adapterName];
+        if (adapter === undefined) {
             throw new UnregisteredAdapterError(adapterName);
         }
-        return cache;
+        const { keyPrefixer } = this.settings;
+        return new Cache({
+            ...this.settings,
+            adapter,
+            keyPrefixer: new KeyPrefixer([
+                ...resolveOneOrMore(keyPrefixer.originalRootPrefix),
+                adapterName,
+            ]),
+        });
     }
 }
 //# sourceMappingURL=cache-factory.js.map

package/dist/cache/implementations/derivables/cache-factory/cache-factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"cache-factory.js","sourceRoot":"","sources":["../../../../../src/cache/implementations/derivables/cache-factory/cache-factory.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACH,6BAA6B,EAC7B,wBAAwB,GAC3B,MAAM,gCAAgC,CAAC;AAGxC,OAAO,EACH,0BAA0B,EAC1B,0BAA0B,GAG7B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,mDAAmD,CAAC;AA6F1E;;;;GAIG;AACH,MAAM,OAAO,YAAY;IAGJ,WAAW,GAAG,EAA4B,CAAC;IAC3C,cAAc,CAAa;IAC3B,QAAQ,CAA2B;IACnC,UAAU,CAAkB;IAC5B,aAAa,CAAiB;IAC9B,aAAa,CAAwB;IACrC,WAAW,CAAsB;IACjC,OAAO,CAAmB;IAC1B,KAAK,CAA4B;IACjC,oBAAoB,CAAW;IAC/B,oBAAoB,CAAW;IAEhD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,YAAY,QAAyC;QACjD,MAAM,EACF,oBAAoB,GAAG,IAAI,EAC3B,oBAAoB,GAAG,IAAI,EAC3B,KAAK,EACL,QAAQ,EACR,cAAc,EACd,QAAQ,EACR,UAAU,GAAG,IAAI,EACjB,aAAa,EACb,aAAa,EACb,WAAW,EACX,OAAO,GACV,GAAG,QAAQ,CAAC;QAEb,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACjD,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACjD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAEO,IAAI,CAAC,QAAkC;QAC3C,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,0BAA0B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC;QACD,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,0BAA0B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3C,CAAC;QACD,MAAM,WAAW,GAA2B,EAAE,CAAC;QAC/C,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;YACzB,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC;YACpC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBACxB,SAAS;YACb,CAAC;YACD,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,KAAK,CAAM;gBAC9B,OAAO;gBACP,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,aAAa,EAAE,IAAI,CAAC,aAAa;gBACjC,aAAa,EAAE,IAAI,CAAC,aAAa;gBACjC,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,OAAO,EAAE,IAAI,CAAC,OAAO;aACxB,CAAC,CAAC;QACP,CAAC;QACD,OAAO,WAAW,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,GAAG,CACC,cAAqC,IAAI,CAAC,cAAc;QAExD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,6BAA6B,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC/D,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QAC5C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACtB,MAAM,IAAI,wBAAwB,CAAC,WAAW,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;CACJ"}
+{"version":3,"file":"cache-factory.js","sourceRoot":"","sources":["../../../../../src/cache/implementations/derivables/cache-factory/cache-factory.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACH,6BAA6B,EAC7B,gBAAgB,EAChB,wBAAwB,GAC3B,MAAM,gCAAgC,CAAC;AAMxC,OAAO,EACH,KAAK,GAGR,MAAM,qDAAqD,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAiB,MAAM,gCAAgC,CAAC;AAwB5E;;;;GAIG;AACH,MAAM,OAAO,YAAY;IAQQ;IAL7B;;;;OAIG;IACH,YAA6B,QAAyC;QAAzC,aAAQ,GAAR,QAAQ,CAAiC;IAAG,CAAC;IAE1E,cAAc,CAAC,WAAwB;QACnC,OAAO,IAAI,YAAY,CAAC;YACpB,GAAG,IAAI,CAAC,QAAQ;YAChB,WAAW;SACd,CAAC,CAAC;IACP,CAAC;IAED,aAAa,CAAC,GAAa;QACvB,OAAO,IAAI,YAAY,CAAC;YACpB,GAAG,IAAI,CAAC,QAAQ;YAChB,UAAU,EAAE,GAAG;SAClB,CAAC,CAAC;IACP,CAAC;IAED,WAAW,CAAC,QAAiC;QACzC,OAAO,IAAI,YAAY,CAAC;YACpB,GAAG,IAAI,CAAC,QAAQ;YAChB,QAAQ;SACX,CAAC,CAAC;IACP,CAAC;IAED,gBAAgB,CAAC,QAAgB;QAC7B,OAAO,IAAI,YAAY,CAAC;YACpB,GAAG,IAAI,CAAC,QAAQ;YAChB,aAAa,EAAE,QAAQ;SAC1B,CAAC,CAAC;IACP,CAAC;IAED,gBAAgB,CAAC,MAAqB;QAClC,OAAO,IAAI,YAAY,CAAC;YACpB,GAAG,IAAI,CAAC,QAAQ;YAChB,aAAa,EAAE,MAAM;SACxB,CAAC,CAAC;IACP,CAAC;IAED,cAAc,CAAC,MAAmB;QAC9B,OAAO,IAAI,YAAY,CAAC;YACpB,GAAG,IAAI,CAAC,QAAQ;YAChB,WAAW,EAAE,MAAM;SACtB,CAAC,CAAC;IACP,CAAC;IAED,eAAe,CAAC,OAAiB;QAC7B,OAAO,IAAI,YAAY,CAAC;YACpB,GAAG,IAAI,CAAC,QAAQ;YAChB,YAAY,EAAE,OAAO;SACxB,CAAC,CAAC;IACP,CAAC;IAED,eAAe,CAAC,OAAiB;QAC7B,OAAO,IAAI,YAAY,CAAC;YACpB,GAAG,IAAI,CAAC,QAAQ;YAChB,YAAY,EAAE,OAAO;SACxB,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyEG;IACH,GAAG,CACC,cAAqC,IAAI,CAAC,QAAQ,CAAC,cAAc;QAEjE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,6BAA6B,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC/D,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACpD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,wBAAwB,CAAC,WAAW,CAAC,CAAC;QACpD,CAAC;QACD,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;QACtC,OAAO,IAAI,KAAK,CAAC;YACb,GAAG,IAAI,CAAC,QAAQ;YAChB,OAAO;YACP,WAAW,EAAE,IAAI,WAAW,CAAC;gBACzB,GAAG,gBAAgB,CAAC,WAAW,CAAC,kBAAkB,CAAC;gBACnD,WAAW;aACd,CAAC;SACL,CAAC,CAAC;IACP,CAAC;CACJ"}

package/dist/cache/implementations/test-utilities/_module-exports.d.ts

@@ -1,2 +1,3 @@
 export * from "../../../cache/implementations/test-utilities/cache-adapter.test-suite.js";
 export * from "../../../cache/implementations/test-utilities/cache.test-suite.js";
+export * from "../../../cache/implementations/test-utilities/database-cache-dapter.test-suite.js";

package/dist/cache/implementations/test-utilities/_module-exports.js

@@ -1,3 +1,4 @@
 export * from "../../../cache/implementations/test-utilities/cache-adapter.test-suite.js";
 export * from "../../../cache/implementations/test-utilities/cache.test-suite.js";
+export * from "../../../cache/implementations/test-utilities/database-cache-dapter.test-suite.js";
 //# sourceMappingURL=_module-exports.js.map

package/dist/cache/implementations/test-utilities/_module-exports.js.map

@@ -1 +1 @@
-{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../../src/cache/implementations/test-utilities/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,oEAAoE,CAAC;AACnF,cAAc,4DAA4D,CAAC"}
+{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../../src/cache/implementations/test-utilities/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,oEAAoE,CAAC;AACnF,cAAc,4DAA4D,CAAC;AAC3E,cAAc,4EAA4E,CAAC"}

package/dist/cache/implementations/test-utilities/cache-adapter.test-suite.d.ts

@@ -6,7 +6,7 @@ import { type ICacheAdapter } from "../../../cache/contracts/_module-exports.js"
 import { type Promisable } from "../../../utilities/_module-exports.js";
 /**
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/implementations/test-utilities"```
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/test-utilities"```
  * @group Test utilities
  */
 export type CacheAdapterTestSuiteSettings = {
@@ -19,21 +19,21 @@ export type CacheAdapterTestSuiteSettings = {
 /**
  * The <i>cacheAdapterTestSuite</i> function simplifies the process of testing your custom implementation of <i>{@link ICacheAdapter}</i> with <i>vitest</i>.
  *
- * IMPORT_PATH: ```"@daiso-tech/core/cache/implementations/test-utilities"```
+ * IMPORT_PATH: ```"@daiso-tech/core/cache/test-utilities"```
  * @group Test utilities
  * @example
  * ```ts
  * import { afterEach, beforeEach, describe, expect, test } from "vitest";
- * import { cacheAdapterTestSuite } from "@daiso-tech/core/cache/implementations/test-utilities";
- * import { RedisCacheAdapter } from "@daiso-tech/core/cache/implementations/adapters";
  * import { Redis } from "ioredis";
  * import {
- *     RedisContainer,
- *     type StartedRedisContainer,
+ *   RedisContainer,
+ *   type StartedRedisContainer,
  * } from "@testcontainers/redis";
- * import { TimeSpan } from "@daiso-tech/core/utilities";
- * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
- * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
+ * import { cacheAdapterTestSuite } from "@daiso-tech/cache/implementations/test-utilities";
+ * import { RedisCacheAdapter } from "@daiso-tech/cache/implementations/adapters";
+ * import { TimeSpan } from "@daiso-tech/cache/utilities";
+ * import { SuperJsonSerdeAdapter } from "@daiso-tech/cache/serde/implementations/adapters";
+ * import { Serde } from "@daiso-tech/cache/serde/implementations/derivables";
  *
  * const timeout = TimeSpan.fromMinutes(2);
  * describe("class: RedisCacheAdapter", () => {
@@ -52,7 +52,6 @@ export type CacheAdapterTestSuiteSettings = {
  *             new RedisCacheAdapter({
  *                 database: client,
  *                 serde: new Serde(new SuperJsonSerdeAdapter()),
- *                 rootGroup: "@a",
  *             }),
  *         test,
  *         beforeEach,
@@ -60,7 +59,6 @@ export type CacheAdapterTestSuiteSettings = {
  *         describe,
  *     });
  * });
- *
  * ```
  */
 export declare function cacheAdapterTestSuite(settings: CacheAdapterTestSuiteSettings): void;