@daiso-tech/core 0.39.0 → 0.41.0

package/dist/shared-lock/implementations/derivables/shared-lock-provider-factory/shared-lock-provider-factory.js

@@ -0,0 +1,128 @@
+import { DefaultAdapterNotDefinedError, UnregisteredAdapterError, } from "../../../../utilities/_module-exports.js";
+import { DEFAULT_SHARED_LOCK_NAMESPACE, SharedLockProvider, } from "../../../../shared-lock/implementations/derivables/shared-lock-provider/_module.js";
+/**
+ * The `SharedLockProviderFactory` class is immutable.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock"`
+ * @group Derivables
+ */
+export class SharedLockProviderFactory {
+    settings;
+    /**
+     * @example
+     * ```ts
+     * import { SharedLockProviderFactory } from "@daiso-tech/core/shared-lock";
+     * import type { IDatabaseLockAdapter } from "@daiso-tech/core/shared-lock/contracts";
+     * import { MemoryLockAdapter, RedisLockAdapter, SqliteLockAdapter } from "@daiso-tech/core/shared-lock/adapters";
+     * import { Serde } from "@daiso-tech/core/serde";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/adapters";
+     * import Redis from "ioredis"
+     *
+     * const serde = new Serde(new SuperJsonSerdeAdapter());
+     * const lockProviderFactory = new SharedLockProviderFactory({
+     *   serde,
+     *   adapters: {
+     *     memory: new MemoryLockAdapter(),
+     *     redis: new RedisLockAdapter(new Redis("YOUR_REDIS_CONNECTION")),
+     *   },
+     *   defaultAdapter: "memory",
+     * });
+     * ```
+     */
+    constructor(settings) {
+        this.settings = settings;
+    }
+    setNamespace(namespace) {
+        return new SharedLockProviderFactory({
+            ...this.settings,
+            namespace,
+        });
+    }
+    setCreateLockId(createId) {
+        return new SharedLockProviderFactory({
+            ...this.settings,
+            createLockId: createId,
+        });
+    }
+    setEventBus(eventBus) {
+        return new SharedLockProviderFactory({
+            ...this.settings,
+            eventBus,
+        });
+    }
+    setDefaultTtl(ttl) {
+        return new SharedLockProviderFactory({
+            ...this.settings,
+            defaultTtl: ttl,
+        });
+    }
+    setDefaultBlockingInterval(interval) {
+        return new SharedLockProviderFactory({
+            ...this.settings,
+            defaultBlockingInterval: interval,
+        });
+    }
+    setDefaultBlockingTime(time) {
+        return new SharedLockProviderFactory({
+            ...this.settings,
+            defaultBlockingTime: time,
+        });
+    }
+    setDefaultRefreshTime(time) {
+        return new SharedLockProviderFactory({
+            ...this.settings,
+            defaultRefreshTime: time,
+        });
+    }
+    /**
+     * @example
+     * ```ts
+     * import { SharedLockProviderFactory } from "@daiso-tech/core/shared-lock";
+     * import type { IDatabaseLockAdapter } from "@daiso-tech/core/shared-lock/contracts";
+     * import { MemoryLockAdapter, RedisLockAdapter, SqliteLockAdapter } from "@daiso-tech/core/shared-lock/adapters";
+     * import { Serde } from "@daiso-tech/core/serde";
+     * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/adapters";
+     * import { TimeSpan } from "@daiso-tech/core/time-span" from "@daiso-tech/core/time-span";
+     * import Redis from "ioredis";
+     *
+     * const serde = new Serde(new SuperJsonSerdeAdapter());
+     * const lockProviderFactory = new SharedLockProviderFactory({
+     *   serde,
+     *   adapters: {
+     *     memory: new MemoryLockAdapter(),
+     *     redis: new RedisLockAdapter(new Redis("YOUR_REDIS_CONNECTION")),
+     *   },
+     *   defaultAdapter: "memory",
+     * });
+     *
+     * // Will acquire key using the default adapter which is MemoryLockAdapter
+     * await lockProviderFactory
+     *   .use()
+     *   .create("a")
+     *   .acquire();
+     *
+     * // Will acquire key using the redis adapter which is RedisLockAdapter
+     * await lockProviderFactory
+     *   .use("redis")
+     *   .create("a")
+     *   .acquire();
+     * ```
+     */
+    use(adapterName = this.settings.defaultAdapter) {
+        if (adapterName === undefined) {
+            throw new DefaultAdapterNotDefinedError(SharedLockProviderFactory.name);
+        }
+        const adapter = this.settings.adapters[adapterName];
+        if (adapter === undefined) {
+            throw new UnregisteredAdapterError(adapterName);
+        }
+        const { namespace = DEFAULT_SHARED_LOCK_NAMESPACE } = this.settings;
+        return new SharedLockProvider({
+            ...this.settings,
+            adapter,
+            namespace: namespace.appendRoot(adapterName),
+            serdeTransformerName: adapterName,
+        });
+    }
+}
+//# sourceMappingURL=shared-lock-provider-factory.js.map

package/dist/shared-lock/implementations/derivables/shared-lock-provider-factory/shared-lock-provider-factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared-lock-provider-factory.js","sourceRoot":"","sources":["../../../../../src/shared-lock/implementations/derivables/shared-lock-provider-factory/shared-lock-provider-factory.ts"],"names":[],"mappings":"AASA,OAAO,EACH,6BAA6B,EAC7B,wBAAwB,GAC3B,MAAM,gCAAgC,CAAC;AAExC,OAAO,EACH,6BAA6B,EAC7B,kBAAkB,GAErB,MAAM,0EAA0E,CAAC;AAyBlF;;;;;GAKG;AACH,MAAM,OAAO,yBAAyB;IAyBb;IAtBrB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,YACqB,QAAsD;QAAtD,aAAQ,GAAR,QAAQ,CAA8C;IACxE,CAAC;IAEJ,YAAY,CAAC,SAAoB;QAC7B,OAAO,IAAI,yBAAyB,CAAC;YACjC,GAAG,IAAI,CAAC,QAAQ;YAChB,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;IAED,eAAe,CACX,QAA+B;QAE/B,OAAO,IAAI,yBAAyB,CAAC;YACjC,GAAG,IAAI,CAAC,QAAQ;YAChB,YAAY,EAAE,QAAQ;SACzB,CAAC,CAAC;IACP,CAAC;IAED,WAAW,CAAC,QAAmB;QAC3B,OAAO,IAAI,yBAAyB,CAAC;YACjC,GAAG,IAAI,CAAC,QAAQ;YAChB,QAAQ;SACX,CAAC,CAAC;IACP,CAAC;IAED,aAAa,CAAC,GAAc;QACxB,OAAO,IAAI,yBAAyB,CAAC;YACjC,GAAG,IAAI,CAAC,QAAQ;YAChB,UAAU,EAAE,GAAG;SAClB,CAAC,CAAC;IACP,CAAC;IAED,0BAA0B,CACtB,QAAmB;QAEnB,OAAO,IAAI,yBAAyB,CAAC;YACjC,GAAG,IAAI,CAAC,QAAQ;YAChB,uBAAuB,EAAE,QAAQ;SACpC,CAAC,CAAC;IACP,CAAC;IAED,sBAAsB,CAClB,IAAe;QAEf,OAAO,IAAI,yBAAyB,CAAC;YACjC,GAAG,IAAI,CAAC,QAAQ;YAChB,mBAAmB,EAAE,IAAI;SAC5B,CAAC,CAAC;IACP,CAAC;IAED,qBAAqB,CACjB,IAAe;QAEf,OAAO,IAAI,yBAAyB,CAAC;YACjC,GAAG,IAAI,CAAC,QAAQ;YAChB,kBAAkB,EAAE,IAAI;SAC3B,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,GAAG,CACC,cAAqC,IAAI,CAAC,QAAQ,CAAC,cAAc;QAEjE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,IAAI,6BAA6B,CACnC,yBAAyB,CAAC,IAAI,CACjC,CAAC;QACN,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,SAAS,GAAG,6BAA6B,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;QACpE,OAAO,IAAI,kBAAkB,CAAC;YAC1B,GAAG,IAAI,CAAC,QAAQ;YAChB,OAAO;YACP,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC,WAAW,CAAC;YAC5C,oBAAoB,EAAE,WAAW;SACpC,CAAC,CAAC;IACP,CAAC;CACJ"}

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

@@ -0,0 +1,3 @@
+export * from "../../../shared-lock/implementations/test-utilities/database-shared-lock-adapter.test-suite.js";
+export * from "../../../shared-lock/implementations/test-utilities/shared-lock-adapter.test-suite.js";
+export * from "../../../shared-lock/implementations/test-utilities/shared-lock-provider.test-suite.js";

package/dist/shared-lock/implementations/test-utilities/_module-exports.js

@@ -0,0 +1,4 @@
+export * from "../../../shared-lock/implementations/test-utilities/database-shared-lock-adapter.test-suite.js";
+export * from "../../../shared-lock/implementations/test-utilities/shared-lock-adapter.test-suite.js";
+export * from "../../../shared-lock/implementations/test-utilities/shared-lock-provider.test-suite.js";
+//# sourceMappingURL=_module-exports.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../../src/shared-lock/implementations/test-utilities/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,yFAAyF,CAAC;AACxG,cAAc,gFAAgF,CAAC;AAC/F,cAAc,iFAAiF,CAAC"}

package/dist/shared-lock/implementations/test-utilities/database-shared-lock-adapter.test-suite.d.ts

@@ -0,0 +1,59 @@
+/**
+ * @module SharedLock
+ */
+import type { TestAPI, SuiteAPI, ExpectStatic, beforeEach } from "vitest";
+import type { IDatabaseSharedLockAdapter } from "../../../shared-lock/contracts/_module-exports.js";
+import type { Promisable } from "../../../utilities/_module-exports.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/test-utilities"`
+ * @group Utilities
+ */
+export type DatabaseSharedLockAdapterTestSuiteSettings = {
+    expect: ExpectStatic;
+    test: TestAPI;
+    describe: SuiteAPI;
+    beforeEach: typeof beforeEach;
+    createAdapter: () => Promisable<IDatabaseSharedLockAdapter>;
+};
+/**
+ * The `databaseSharedLockAdapterTestSuite` function simplifies the process of testing your custom implementation of {@link IDatabaseSharedLockAdapter | `IDatabaseSharedLockAdapter`} with `vitest`.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/shared-lock/test-utilities"`
+ * @group Utilities
+ * @example
+ * ```ts
+ * import { afterEach, beforeEach, describe, expect, test } from "vitest";
+ * import { databaseSharedLockAdapterTestSuite } from "@daiso-tech/core/shared-lock/test-utilities";
+ * import { LibsqlSharedLockAdapter } from "@daiso-tech/core/shared-lock/adapters";
+ * import { type Client, createClient } from "@libsql/client";
+ *
+ * describe("class: LibsqlSharedLockAdapter", () => {
+ *     let client: Client;
+ *     beforeEach(() => {
+ *         client = createClient({
+ *             url: ":memory:",
+ *         });
+ *     });
+ *     afterEach(() => {
+ *         client.close();
+ *     });
+ *     databaseSharedLockAdapterTestSuite({
+ *         createAdapter: async () => {
+ *             const lockAdapter = new LibsqlSharedLockAdapter({
+ *                database: client,
+ *                 tableName: "custom_table",
+ *                 shouldRemoveExpiredKeys: false,
+ *             });
+ *             await lockAdapter.init();
+ *             return lockAdapter;
+ *         },
+ *         test,
+ *         beforeEach,
+ *         expect,
+ *         describe,
+ *     });
+ * });
+ * ```
+ */
+export declare function databaseSharedLockAdapterTestSuite(settings: DatabaseSharedLockAdapterTestSuiteSettings): void;