@daiso-tech/core 0.22.2 → 0.24.0

package/dist/event-bus/implementations/test-utilities/event-bus.test-suite.js

@@ -0,0 +1,407 @@
+/**
+ * @module EventBus
+ */
+import {} from "vitest";
+import { BaseEvent, } from "../../../event-bus/contracts/_module-exports.js";
+import {} from "../../../utilities/_module-exports.js";
+import { TimeSpan } from "../../../utilities/_module-exports.js";
+import { delay } from "../../../async/_module-exports.js";
+import { Serde } from "../../../serde/implementations/derivables/_module-exports.js";
+import { NoOpSerdeAdapter } from "../../../serde/implementations/adapters/_module-exports.js";
+/**
+ * The <i>eventBusTestSuite</i> function simplifies the process of testing your custom implementation of <i>{@link IEventBus}</i> with vitest.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/event-bus/implementations/test-utilities"```
+ * @group Test utilities
+ * @example
+ * ```ts
+ * import { describe, test, beforeEach, expect, afterEach } from "vitest";
+ * import type { StartedRedisContainer } from "@testcontainers/redis";
+ * import { RedisContainer } from "@testcontainers/redis";
+ * import Redis from "ioredis";
+ * import { RedisPubSubEventBusAdapter } from "@daiso-tech/core/event-bus/adapters";
+ * import { Serde } from "@daiso-tech/core/serde/implementations/derivables";
+ * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/implementations/adapters";
+ * import { eventBusTestSuite } from "@daiso-tech/core/event-bus/implementations/test-utilities";
+ *
+ * const TIMEOUT = TimeSpan.fromMinutes(2);
+ * describe("class: EventBus", () => {
+ *   let dispatcherClient: Redis;
+ *   let listenerClient: Redis;
+ *   let startedContainer: StartedRedisContainer;
+ *   const serde = new Serde(new SuperJsonSerdeAdapter());
+ *
+ *   beforeEach(async () => {
+ *     startedContainer = await new RedisContainer().start();
+ *     dispatcherClient = new Redis(startedContainer.getConnectionUrl());
+ *     listenerClient = new Redis(startedContainer.getConnectionUrl());
+ *   }, TIMEOUT.toMilliseconds());
+ *
+ *   afterEach(async () => {
+ *     await dispatcherClient.quit();
+ *     await listenerClient.quit();
+ *     await startedContainer.stop();
+ *   }, TIMEOUT.toMilliseconds());
+ *
+ *   eventBusTestSuite({
+ *     createEventBus: () =>
+ *       new EventBus(
+ *         new RedisPubSubEventBusAdapter({
+ *           dispatcherClient,
+ *           listenerClient,
+ *           serde,
+ *           rootGroup: "@global"
+ *         })
+ *       ),
+ *     serde,
+ *     test,
+ *     beforeEach,
+ *     expect,
+ *     describe,
+ *   });
+ * });
+ * ```
+ */
+export function eventBusTestSuite(settings) {
+    const { expect, serde = new Serde(new NoOpSerdeAdapter()), test, describe, createEventBus, beforeEach, } = settings;
+    let eventBusA;
+    let eventBusB;
+    beforeEach(async () => {
+        const eventBus = await createEventBus();
+        eventBusA = eventBus;
+        eventBusB = eventBus.withGroup("b");
+    });
+    const TTL = TimeSpan.fromMilliseconds(50);
+    class TestEventA extends BaseEvent {
+    }
+    class TestEventB extends BaseEvent {
+    }
+    serde.registerEvent(TestEventA);
+    serde.registerEvent(TestEventB);
+    describe("Api tests:", () => {
+        describe("method: addListener, removeListener, dispatch", () => {
+            test("Should be null when listener added and event is not triggered", async () => {
+                let result = null;
+                await eventBusA.addListener(TestEventA, (event) => {
+                    result = event;
+                });
+                expect(result).toBeNull();
+            });
+            test("Should be TestEventA when listener added and event is triggered", async () => {
+                let result = null;
+                await eventBusA.addListener(TestEventA, (event) => {
+                    result = event;
+                });
+                const event = new TestEventA({
+                    type: TestEventA.name,
+                });
+                await eventBusA.dispatch(event);
+                await delay(TTL);
+                expect(result).toEqual(event);
+                expect(result).toBeInstanceOf(TestEventA);
+            });
+            test("Should be null when listener removed and event is triggered", async () => {
+                const event = new TestEventA({
+                    type: TestEventA.name,
+                });
+                let result = null;
+                const listener = (event) => {
+                    result = event;
+                };
+                await eventBusA.addListener(TestEventA, listener);
+                await eventBusA.removeListener(TestEventA, listener);
+                await eventBusA.dispatch(event);
+                await delay(TTL);
+                expect(result).toBeNull();
+            });
+        });
+        describe("method: addListenerMany, removeListenerMany, dispatch", () => {
+            test("Should be null when listener added and event is not triggered", async () => {
+                let result = null;
+                await eventBusA.addListenerMany([TestEventA, TestEventB], (event) => {
+                    result = event;
+                });
+                expect(result).toBeNull();
+            });
+            test("Should be BaseEvent when listener added and event is triggered", async () => {
+                const event_1 = new TestEventA({
+                    type: TestEventA.name,
+                });
+                const event_2 = new TestEventB({
+                    type: TestEventB.name,
+                });
+                let result_1 = null;
+                let result_2 = null;
+                await eventBusA.addListenerMany([TestEventA, TestEventB], (eventObj) => {
+                    if (eventObj instanceof TestEventA) {
+                        result_1 = eventObj;
+                    }
+                    if (eventObj instanceof TestEventB) {
+                        result_2 = eventObj;
+                    }
+                });
+                await eventBusA.dispatchMany([event_1, event_2]);
+                await delay(TTL);
+                expect(result_1).toEqual(event_1);
+                expect(result_1).toBeInstanceOf(TestEventA);
+                expect(result_2).toEqual(event_2);
+                expect(result_2).toBeInstanceOf(TestEventB);
+            });
+            test("Should be null when listener removed and event is triggered", async () => {
+                const event_A = new TestEventA({
+                    type: TestEventA.name,
+                });
+                const event_B = new TestEventB({
+                    type: TestEventB.name,
+                });
+                let result = null;
+                const listener = (event) => {
+                    result = event;
+                };
+                await eventBusA.addListenerMany([TestEventA, TestEventB], listener);
+                await eventBusA.removeListenerMany([TestEventA, TestEventB], listener);
+                await eventBusA.dispatchMany([event_A, event_B]);
+                await delay(TTL);
+                expect(result).toBeNull();
+            });
+        });
+        describe("method: subscribe", () => {
+            test("Should be null when listener added and event is not triggered", async () => {
+                let result = null;
+                await eventBusA.subscribe(TestEventA, (event) => {
+                    result = event;
+                });
+                expect(result).toBeNull();
+            });
+            test("Should be TestEventA when listener added and event is triggered", async () => {
+                const event = new TestEventA({
+                    type: TestEventA.name,
+                });
+                let result = null;
+                await eventBusA.subscribe(TestEventA, (event) => {
+                    result = event;
+                });
+                await delay(TTL);
+                await eventBusA.dispatch(event);
+                expect(result).toEqual(event);
+                expect(result).toBeInstanceOf(TestEventA);
+            });
+            test("Should be null when listener removed and event is triggered", async () => {
+                const event = new TestEventA({
+                    type: TestEventA.name,
+                });
+                let result = null;
+                const listener = (event) => {
+                    result = event;
+                };
+                const unsubscribe = await eventBusA.subscribe(TestEventA, listener);
+                await unsubscribe();
+                await eventBusA.dispatch(event);
+                await delay(TTL);
+                expect(result).toBeNull();
+            });
+        });
+        describe("method: subscribeMany", () => {
+            test("Should be null when listener added and event is not triggered", async () => {
+                let result = null;
+                await eventBusA.subscribeMany([TestEventA, TestEventB], (event) => {
+                    result = event;
+                });
+                expect(result).toBeNull();
+            });
+            test("Should be BaseEvent when listener added and event is triggered", async () => {
+                const event_1 = new TestEventA({
+                    type: TestEventA.name,
+                });
+                const event_2 = new TestEventB({
+                    type: TestEventB.name,
+                });
+                let result_1 = null;
+                let result_2 = null;
+                await eventBusA.subscribeMany([TestEventA, TestEventB], (eventObj) => {
+                    if (eventObj instanceof TestEventA) {
+                        result_1 = eventObj;
+                    }
+                    if (eventObj instanceof TestEventB) {
+                        result_2 = eventObj;
+                    }
+                });
+                await delay(TTL);
+                await eventBusA.dispatchMany([event_1, event_2]);
+                expect(result_1).toEqual(event_1);
+                expect(result_1).toBeInstanceOf(TestEventA);
+                expect(result_2).toEqual(event_2);
+                expect(result_2).toBeInstanceOf(TestEventB);
+            });
+            test("Should be null when listener removed and event is triggered", async () => {
+                const event_A = new TestEventA({
+                    type: TestEventA.name,
+                });
+                const event_B = new TestEventB({
+                    type: TestEventB.name,
+                });
+                let result = null;
+                const listener = (event) => {
+                    result = event;
+                };
+                const unsubscribe = await eventBusA.subscribeMany([TestEventA, TestEventB], listener);
+                await unsubscribe();
+                await eventBusA.dispatchMany([event_A, event_B]);
+                await delay(TTL);
+                expect(result).toBeNull();
+            });
+        });
+        describe("method: listenOnce", () => {
+            test("Should be null when listener added and event is not triggered", async () => {
+                let result = null;
+                await eventBusA.listenOnce(TestEventA, (event) => {
+                    result = event;
+                });
+                expect(result).toBeNull();
+            });
+            test("Should be TestEventA when listener added and event is triggered", async () => {
+                const event = new TestEventA({
+                    type: TestEventA.name,
+                });
+                let result = null;
+                await eventBusA.listenOnce(TestEventA, (event) => {
+                    result = event;
+                });
+                await eventBusA.dispatch(event);
+                await delay(TTL);
+                expect(result).toEqual(event);
+                expect(result).toBeInstanceOf(TestEventA);
+            });
+            test("Should only listen for event once", async () => {
+                const event = new TestEventA({
+                    type: TestEventA.name,
+                });
+                let i = 0;
+                await eventBusA.listenOnce(TestEventA, () => {
+                    i++;
+                });
+                await eventBusA.dispatch(event);
+                await eventBusA.dispatch(event);
+                await delay(TTL);
+                expect(i).toBe(1);
+            });
+        });
+    });
+    describe("Group tests:", () => {
+        test("method: addListener / dispatch", async () => {
+            const event = new TestEventA({
+                type: TestEventA.name,
+            });
+            let result_a = null;
+            await eventBusA.addListener(TestEventA, (event) => {
+                result_a = event;
+            });
+            let result_b = null;
+            await eventBusB.addListener(TestEventA, (event) => {
+                result_b = event;
+            });
+            await eventBusA.dispatch(event);
+            expect(result_a).toEqual(event);
+            expect(result_a).toBeInstanceOf(TestEventA);
+            expect(result_b).toBeNull();
+        });
+        test("method: addListenerMany / dispatch", async () => {
+            const event = new TestEventA({
+                type: "type",
+            });
+            let result_a = null;
+            await eventBusA.addListenerMany([TestEventA], (event) => {
+                result_a = event;
+            });
+            let result_b = null;
+            await eventBusB.addListenerMany([TestEventA], (event) => {
+                result_b = event;
+            });
+            await eventBusA.dispatch(event);
+            expect(result_a).toEqual(event);
+            expect(result_a).toBeInstanceOf(TestEventA);
+            expect(result_b).toBeNull();
+        });
+        test("method: removeListener / addListener / dispatch", async () => {
+            const event = new TestEventA({
+                type: TestEventA.name,
+            });
+            let result_a = null;
+            await eventBusA.addListener(TestEventA, (event) => {
+                result_a = event;
+            });
+            let result_b = null;
+            const listenerB = (event) => {
+                result_b = event;
+            };
+            await eventBusB.addListener(TestEventA, listenerB);
+            await eventBusB.removeListener(TestEventA, listenerB);
+            await eventBusA.dispatch(event);
+            await eventBusB.dispatch(event);
+            expect(result_a).toEqual(event);
+            expect(result_a).toBeInstanceOf(TestEventA);
+            expect(result_b).toBeNull();
+        });
+        test("method: removeListenerMany / addListener / dispatch", async () => {
+            const event = new TestEventA({
+                type: TestEventA.name,
+            });
+            let result_a = null;
+            await eventBusA.addListener(TestEventA, (event) => {
+                result_a = event;
+            });
+            let result_b = null;
+            const listenerB = (event) => {
+                result_b = event;
+            };
+            await eventBusB.addListener(TestEventA, listenerB);
+            await eventBusB.removeListenerMany([TestEventA], listenerB);
+            await eventBusA.dispatch(event);
+            await eventBusB.dispatch(event);
+            expect(result_a).toEqual(event);
+            expect(result_a).toBeInstanceOf(TestEventA);
+            expect(result_b).toBeNull();
+        });
+        test("method: subscribe / dispatch", async () => {
+            const event = new TestEventA({
+                type: TestEventA.name,
+            });
+            let result_a = null;
+            await eventBusA.subscribe(TestEventA, (event) => {
+                result_a = event;
+            });
+            let result_b = null;
+            const listenerB = (event) => {
+                result_b = event;
+            };
+            const unsubscribe = await eventBusB.subscribe(TestEventA, listenerB);
+            await unsubscribe();
+            await eventBusA.dispatch(event);
+            await eventBusB.dispatch(event);
+            expect(result_a).toEqual(event);
+            expect(result_a).toBeInstanceOf(TestEventA);
+            expect(result_b).toBeNull();
+        });
+        test("method: subscribeMany / dispatch", async () => {
+            const event = new TestEventA({
+                type: TestEventA.name,
+            });
+            let result_a = null;
+            await eventBusA.subscribeMany([TestEventA], (event) => {
+                result_a = event;
+            });
+            let result_b = null;
+            const listenerB = (event) => {
+                result_b = event;
+            };
+            const unsubscribe = await eventBusB.subscribeMany([TestEventA], listenerB);
+            await unsubscribe();
+            await eventBusA.dispatch(event);
+            await eventBusB.dispatch(event);
+            expect(result_a).toEqual(event);
+            expect(result_a).toBeInstanceOf(TestEventA);
+            expect(result_b).toBeNull();
+        });
+    });
+}
+//# sourceMappingURL=event-bus.test-suite.js.map

package/dist/event-bus/implementations/test-utilities/event-bus.test-suite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-bus.test-suite.js","sourceRoot":"","sources":["../../../../src/event-bus/implementations/test-utilities/event-bus.test-suite.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAKN,MAAM,QAAQ,CAAC;AAChB,OAAO,EACH,SAAS,GAGZ,MAAM,0CAA0C,CAAC;AAClD,OAAO,EAAmB,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAC1D,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AAEnD,OAAO,EAAE,KAAK,EAAE,MAAM,uDAAuD,CAAC;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,qDAAqD,CAAC;AAgBvF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,MAAM,UAAU,iBAAiB,CAAC,QAAmC;IACjE,MAAM,EACF,MAAM,EACN,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,gBAAgB,EAAE,CAAC,EACzC,IAAI,EACJ,QAAQ,EACR,cAAc,EACd,UAAU,GACb,GAAG,QAAQ,CAAC;IACb,IAAI,SAAoB,CAAC;IACzB,IAAI,SAAoB,CAAC;IACzB,UAAU,CAAC,KAAK,IAAI,EAAE;QAClB,MAAM,QAAQ,GAAG,MAAM,cAAc,EAAE,CAAC;QACxC,SAAS,GAAG,QAAQ,CAAC;QACrB,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;IAC1C,MAAM,UAAW,SAAQ,SAAS;KAAG;IACrC,MAAM,UAAW,SAAQ,SAAS;KAAG;IACrC,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAChC,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAEhC,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QACxB,QAAQ,CAAC,+CAA+C,EAAE,GAAG,EAAE;YAC3D,IAAI,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;gBAC7E,IAAI,MAAM,GAAsB,IAAI,CAAC;gBACrC,MAAM,SAAS,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;oBAC9C,MAAM,GAAG,KAAK,CAAC;gBACnB,CAAC,CAAC,CAAC;gBACH,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC9B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;gBAC/E,IAAI,MAAM,GAAsB,IAAI,CAAC;gBACrC,MAAM,SAAS,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;oBAC9C,MAAM,GAAG,KAAK,CAAC;gBACnB,CAAC,CAAC,CAAC;gBACH,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC;oBACzB,IAAI,EAAE,UAAU,CAAC,IAAI;iBACxB,CAAC,CAAC;gBACH,MAAM,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAChC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC9B,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;gBAC3E,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC;oBACzB,IAAI,EAAE,UAAU,CAAC,IAAI;iBACxB,CAAC,CAAC;gBACH,IAAI,MAAM,GAAsB,IAAI,CAAC;gBACrC,MAAM,QAAQ,GAAG,CAAC,KAAiB,EAAE,EAAE;oBACnC,MAAM,GAAG,KAAK,CAAC;gBACnB,CAAC,CAAC;gBACF,MAAM,SAAS,CAAC,WAAW,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;gBAClD,MAAM,SAAS,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;gBACrD,MAAM,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAChC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC9B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,uDAAuD,EAAE,GAAG,EAAE;YACnE,IAAI,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;gBAC7E,IAAI,MAAM,GAAmC,IAAI,CAAC;gBAClD,MAAM,SAAS,CAAC,eAAe,CAC3B,CAAC,UAAU,EAAE,UAAU,CAAC,EACxB,CAAC,KAAK,EAAE,EAAE;oBACN,MAAM,GAAG,KAAK,CAAC;gBACnB,CAAC,CACJ,CAAC;gBACF,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC9B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;gBAC9E,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC;oBAC3B,IAAI,EAAE,UAAU,CAAC,IAAI;iBACxB,CAAC,CAAC;gBACH,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC;oBAC3B,IAAI,EAAE,UAAU,CAAC,IAAI;iBACxB,CAAC,CAAC;gBACH,IAAI,QAAQ,GAAsB,IAAI,CAAC;gBACvC,IAAI,QAAQ,GAAsB,IAAI,CAAC;gBACvC,MAAM,SAAS,CAAC,eAAe,CAC3B,CAAC,UAAU,EAAE,UAAU,CAAC,EACxB,CAAC,QAAQ,EAAE,EAAE;oBACT,IAAI,QAAQ,YAAY,UAAU,EAAE,CAAC;wBACjC,QAAQ,GAAG,QAAQ,CAAC;oBACxB,CAAC;oBACD,IAAI,QAAQ,YAAY,UAAU,EAAE,CAAC;wBACjC,QAAQ,GAAG,QAAQ,CAAC;oBACxB,CAAC;gBACL,CAAC,CACJ,CAAC;gBACF,MAAM,SAAS,CAAC,YAAY,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;gBACjD,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAClC,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;gBAC5C,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAClC,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YAChD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;gBAC3E,MAAM,OAAO,GAAe,IAAI,UAAU,CAAC;oBACvC,IAAI,EAAE,UAAU,CAAC,IAAI;iBACxB,CAAC,CAAC;gBACH,MAAM,OAAO,GAAe,IAAI,UAAU,CAAC;oBACvC,IAAI,EAAE,UAAU,CAAC,IAAI;iBACxB,CAAC,CAAC;gBACH,IAAI,MAAM,GAAmC,IAAI,CAAC;gBAClD,MAAM,QAAQ,GAAG,CAAC,KAA8B,EAAE,EAAE;oBAChD,MAAM,GAAG,KAAK,CAAC;gBACnB,CAAC,CAAC;gBACF,MAAM,SAAS,CAAC,eAAe,CAC3B,CAAC,UAAU,EAAE,UAAU,CAAC,EACxB,QAAQ,CACX,CAAC;gBACF,MAAM,SAAS,CAAC,kBAAkB,CAC9B,CAAC,UAAU,EAAE,UAAU,CAAC,EACxB,QAAQ,CACX,CAAC;gBACF,MAAM,SAAS,CAAC,YAAY,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;gBACjD,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC9B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;YAC/B,IAAI,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;gBAC7E,IAAI,MAAM,GAAsB,IAAI,CAAC;gBACrC,MAAM,SAAS,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;oBAC5C,MAAM,GAAG,KAAK,CAAC;gBACnB,CAAC,CAAC,CAAC;gBACH,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC9B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;gBAC/E,MAAM,KAAK,GAAe,IAAI,UAAU,CAAC;oBACrC,IAAI,EAAE,UAAU,CAAC,IAAI;iBACxB,CAAC,CAAC;gBACH,IAAI,MAAM,GAAsB,IAAI,CAAC;gBACrC,MAAM,SAAS,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;oBAC5C,MAAM,GAAG,KAAK,CAAC;gBACnB,CAAC,CAAC,CAAC;gBACH,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAChC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC9B,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;gBAC3E,MAAM,KAAK,GAAe,IAAI,UAAU,CAAC;oBACrC,IAAI,EAAE,UAAU,CAAC,IAAI;iBACxB,CAAC,CAAC;gBACH,IAAI,MAAM,GAAsB,IAAI,CAAC;gBACrC,MAAM,QAAQ,GAAG,CAAC,KAAiB,EAAE,EAAE;oBACnC,MAAM,GAAG,KAAK,CAAC;gBACnB,CAAC,CAAC;gBACF,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,SAAS,CACzC,UAAU,EACV,QAAQ,CACX,CAAC;gBACF,MAAM,WAAW,EAAE,CAAC;gBACpB,MAAM,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAChC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC9B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;YACnC,IAAI,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;gBAC7E,IAAI,MAAM,GAAmC,IAAI,CAAC;gBAClD,MAAM,SAAS,CAAC,aAAa,CACzB,CAAC,UAAU,EAAE,UAAU,CAAC,EACxB,CAAC,KAAK,EAAE,EAAE;oBACN,MAAM,GAAG,KAAK,CAAC;gBACnB,CAAC,CACJ,CAAC;gBACF,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC9B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;gBAC9E,MAAM,OAAO,GAAe,IAAI,UAAU,CAAC;oBACvC,IAAI,EAAE,UAAU,CAAC,IAAI;iBACxB,CAAC,CAAC;gBACH,MAAM,OAAO,GAAe,IAAI,UAAU,CAAC;oBACvC,IAAI,EAAE,UAAU,CAAC,IAAI;iBACxB,CAAC,CAAC;gBACH,IAAI,QAAQ,GAAqB,IAAI,CAAC;gBACtC,IAAI,QAAQ,GAAqB,IAAI,CAAC;gBACtC,MAAM,SAAS,CAAC,aAAa,CACzB,CAAC,UAAU,EAAE,UAAU,CAAC,EACxB,CAAC,QAAmB,EAAE,EAAE;oBACpB,IAAI,QAAQ,YAAY,UAAU,EAAE,CAAC;wBACjC,QAAQ,GAAG,QAAQ,CAAC;oBACxB,CAAC;oBACD,IAAI,QAAQ,YAAY,UAAU,EAAE,CAAC;wBACjC,QAAQ,GAAG,QAAQ,CAAC;oBACxB,CAAC;gBACL,CAAC,CACJ,CAAC;gBACF,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,SAAS,CAAC,YAAY,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;gBACjD,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAClC,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;gBAC5C,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAClC,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YAChD,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;gBAC3E,MAAM,OAAO,GAAe,IAAI,UAAU,CAAC;oBACvC,IAAI,EAAE,UAAU,CAAC,IAAI;iBACxB,CAAC,CAAC;gBACH,MAAM,OAAO,GAAe,IAAI,UAAU,CAAC;oBACvC,IAAI,EAAE,UAAU,CAAC,IAAI;iBACxB,CAAC,CAAC;gBACH,IAAI,MAAM,GAAqB,IAAI,CAAC;gBACpC,MAAM,QAAQ,GAAG,CAAC,KAAgB,EAAE,EAAE;oBAClC,MAAM,GAAG,KAAK,CAAC;gBACnB,CAAC,CAAC;gBACF,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,aAAa,CAC7C,CAAC,UAAU,EAAE,UAAU,CAAC,EACxB,QAAQ,CACX,CAAC;gBACF,MAAM,WAAW,EAAE,CAAC;gBACpB,MAAM,SAAS,CAAC,YAAY,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;gBACjD,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC9B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;YAChC,IAAI,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;gBAC7E,IAAI,MAAM,GAAsB,IAAI,CAAC;gBACrC,MAAM,SAAS,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;oBAC7C,MAAM,GAAG,KAAK,CAAC;gBACnB,CAAC,CAAC,CAAC;gBACH,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC9B,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;gBAC/E,MAAM,KAAK,GAAe,IAAI,UAAU,CAAC;oBACrC,IAAI,EAAE,UAAU,CAAC,IAAI;iBACxB,CAAC,CAAC;gBACH,IAAI,MAAM,GAAsB,IAAI,CAAC;gBACrC,MAAM,SAAS,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;oBAC7C,MAAM,GAAG,KAAK,CAAC;gBACnB,CAAC,CAAC,CAAC;gBACH,MAAM,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAChC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC9B,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;gBACjD,MAAM,KAAK,GAAe,IAAI,UAAU,CAAC;oBACrC,IAAI,EAAE,UAAU,CAAC,IAAI;iBACxB,CAAC,CAAC;gBACH,IAAI,CAAC,GAAG,CAAC,CAAC;gBACV,MAAM,SAAS,CAAC,UAAU,CAAC,UAAU,EAAE,GAAG,EAAE;oBACxC,CAAC,EAAE,CAAC;gBACR,CAAC,CAAC,CAAC;gBACH,MAAM,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAChC,MAAM,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAChC,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;gBACjB,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACtB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC1B,IAAI,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;YAC9C,MAAM,KAAK,GAAe,IAAI,UAAU,CAAC;gBACrC,IAAI,EAAE,UAAU,CAAC,IAAI;aACxB,CAAC,CAAC;YAEH,IAAI,QAAQ,GAAsB,IAAI,CAAC;YACvC,MAAM,SAAS,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC9C,QAAQ,GAAG,KAAK,CAAC;YACrB,CAAC,CAAC,CAAC;YAEH,IAAI,QAAQ,GAAsB,IAAI,CAAC;YACvC,MAAM,SAAS,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC9C,QAAQ,GAAG,KAAK,CAAC;YACrB,CAAC,CAAC,CAAC;YAEH,MAAM,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAEhC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAChC,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YAC5C,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;YAClD,MAAM,KAAK,GAAe,IAAI,UAAU,CAAC;gBACrC,IAAI,EAAE,MAAM;aACf,CAAC,CAAC;YAEH,IAAI,QAAQ,GAAsB,IAAI,CAAC;YACvC,MAAM,SAAS,CAAC,eAAe,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE;gBACpD,QAAQ,GAAG,KAAK,CAAC;YACrB,CAAC,CAAC,CAAC;YAEH,IAAI,QAAQ,GAAsB,IAAI,CAAC;YACvC,MAAM,SAAS,CAAC,eAAe,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE;gBACpD,QAAQ,GAAG,KAAK,CAAC;YACrB,CAAC,CAAC,CAAC;YAEH,MAAM,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAEhC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAChC,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YAC5C,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;YAC/D,MAAM,KAAK,GAAe,IAAI,UAAU,CAAC;gBACrC,IAAI,EAAE,UAAU,CAAC,IAAI;aACxB,CAAC,CAAC;YAEH,IAAI,QAAQ,GAAsB,IAAI,CAAC;YACvC,MAAM,SAAS,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC9C,QAAQ,GAAG,KAAK,CAAC;YACrB,CAAC,CAAC,CAAC;YAEH,IAAI,QAAQ,GAAsB,IAAI,CAAC;YACvC,MAAM,SAAS,GAAG,CAAC,KAAiB,EAAE,EAAE;gBACpC,QAAQ,GAAG,KAAK,CAAC;YACrB,CAAC,CAAC;YACF,MAAM,SAAS,CAAC,WAAW,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;YACnD,MAAM,SAAS,CAAC,cAAc,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;YAEtD,MAAM,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChC,MAAM,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAEhC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAChC,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YAC5C,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,KAAK,GAAe,IAAI,UAAU,CAAC;gBACrC,IAAI,EAAE,UAAU,CAAC,IAAI;aACxB,CAAC,CAAC;YAEH,IAAI,QAAQ,GAAsB,IAAI,CAAC;YACvC,MAAM,SAAS,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC9C,QAAQ,GAAG,KAAK,CAAC;YACrB,CAAC,CAAC,CAAC;YAEH,IAAI,QAAQ,GAAsB,IAAI,CAAC;YACvC,MAAM,SAAS,GAAG,CAAC,KAAiB,EAAE,EAAE;gBACpC,QAAQ,GAAG,KAAK,CAAC;YACrB,CAAC,CAAC;YACF,MAAM,SAAS,CAAC,WAAW,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;YACnD,MAAM,SAAS,CAAC,kBAAkB,CAAC,CAAC,UAAU,CAAC,EAAE,SAAS,CAAC,CAAC;YAE5D,MAAM,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChC,MAAM,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAEhC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAChC,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YAC5C,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;YAC5C,MAAM,KAAK,GAAe,IAAI,UAAU,CAAC;gBACrC,IAAI,EAAE,UAAU,CAAC,IAAI;aACxB,CAAC,CAAC;YAEH,IAAI,QAAQ,GAAqB,IAAI,CAAC;YACtC,MAAM,SAAS,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC5C,QAAQ,GAAG,KAAK,CAAC;YACrB,CAAC,CAAC,CAAC;YAEH,IAAI,QAAQ,GAAqB,IAAI,CAAC;YACtC,MAAM,SAAS,GAAG,CAAC,KAAgB,EAAE,EAAE;gBACnC,QAAQ,GAAG,KAAK,CAAC;YACrB,CAAC,CAAC;YACF,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,SAAS,CACzC,UAAU,EACV,SAAS,CACZ,CAAC;YACF,MAAM,WAAW,EAAE,CAAC;YAEpB,MAAM,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChC,MAAM,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAEhC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAChC,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YAC5C,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,kCAAkC,EAAE,KAAK,IAAI,EAAE;YAChD,MAAM,KAAK,GAAe,IAAI,UAAU,CAAC;gBACrC,IAAI,EAAE,UAAU,CAAC,IAAI;aACxB,CAAC,CAAC;YAEH,IAAI,QAAQ,GAAsB,IAAI,CAAC;YACvC,MAAM,SAAS,CAAC,aAAa,CAAC,CAAC,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE;gBAClD,QAAQ,GAAG,KAAK,CAAC;YACrB,CAAC,CAAC,CAAC;YAEH,IAAI,QAAQ,GAAsB,IAAI,CAAC;YACvC,MAAM,SAAS,GAAG,CAAC,KAAiB,EAAE,EAAE;gBACpC,QAAQ,GAAG,KAAK,CAAC;YACrB,CAAC,CAAC;YACF,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,aAAa,CAC7C,CAAC,UAAU,CAAC,EACZ,SAAS,CACZ,CAAC;YACF,MAAM,WAAW,EAAE,CAAC;YAEpB,MAAM,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChC,MAAM,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAEhC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAChC,MAAM,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YAC5C,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;QAChC,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC"}

package/dist/lock/contracts/_module-exports.d.ts

@@ -0,0 +1,7 @@
+export * from "../../lock/contracts/lock-adapter.contract.js";
+export * from "../../lock/contracts/database-lock-adapter.contract.js";
+export * from "../../lock/contracts/lock-provider.contract.js";
+export * from "../../lock/contracts/lock-provider-factory.contract.js";
+export * from "../../lock/contracts/lock.contract.js";
+export * from "../../lock/contracts/lock.errors.js";
+export * from "../../lock/contracts/lock.events.js";

package/dist/lock/contracts/_module-exports.js

@@ -0,0 +1,8 @@
+export * from "../../lock/contracts/lock-adapter.contract.js";
+export * from "../../lock/contracts/database-lock-adapter.contract.js";
+export * from "../../lock/contracts/lock-provider.contract.js";
+export * from "../../lock/contracts/lock-provider-factory.contract.js";
+export * from "../../lock/contracts/lock.contract.js";
+export * from "../../lock/contracts/lock.errors.js";
+export * from "../../lock/contracts/lock.events.js";
+//# sourceMappingURL=_module-exports.js.map

package/dist/lock/contracts/_module-exports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_module-exports.js","sourceRoot":"","sources":["../../../src/lock/contracts/_module-exports.ts"],"names":[],"mappings":"AAAA,cAAc,2CAA2C,CAAC;AAC1D,cAAc,oDAAoD,CAAC;AACnE,cAAc,4CAA4C,CAAC;AAC3D,cAAc,oDAAoD,CAAC;AACnE,cAAc,mCAAmC,CAAC;AAClD,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC"}

package/dist/lock/contracts/database-lock-adapter.contract.d.ts

@@ -0,0 +1,52 @@
+/**
+ * @module Lock
+ */
+/**
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/lock/contracts"```
+ * @group Contracts
+ */
+export type ILockData = {
+    owner: string;
+    expiration: Date | null;
+};
+/**
+ * The <i>ILockAdapter</i> contract defines a way for managing locks independent of data storage.
+ * This contract is not meant to be used directly, instead you should use <i>{@link ILockProvider}</i> contract.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/lock/contracts"```
+ * @group Contracts
+ */
+export type IDatabaseLockAdapter = {
+    /**
+     * The <i>insert</i> method will create a lock if one does not already exist.
+     */
+    insert(key: string, owner: string, expiration: Date | null): PromiseLike<void>;
+    /**
+     * The <i>update</i> method will update a lock if it has expired, matches the given <i>key</i> and  matches the given <i>owner</i>.
+     * Returns number of updated rows or documents.
+     */
+    update(key: string, owner: string, expiration: Date | null): PromiseLike<number>;
+    /**
+     * The <i>remove</i> method will remove a lock if it matches the given <i>key</i> and matches the given <i>owner</i>.
+     */
+    remove(key: string, owner: string | null): PromiseLike<void>;
+    /**
+     * The <i>refresh</i> method will upadte expiration of lock if it matches the given <i>key</i> and matches the given <i>owner</i>.
+     * Returns number of updated rows or documents.
+     */
+    refresh(key: string, owner: string, expiration: Date): PromiseLike<number>;
+    /**
+     * The <i>find</i> method will return a lock by the given <i>key</i>.
+     */
+    find(key: string): PromiseLike<ILockData | null>;
+    /**
+     * The <i>getGroup</i> method returns the group name.
+     */
+    getGroup(): string;
+    /**
+     * The <i>withGroup</i> method returns a new <i>{@link IDatabaseLockAdapter}</i> instance that groups locks together.
+     * Only locks in the same group will be acquired and released, leaving locks outside the group unaffected.
+     */
+    withGroup(group: string): IDatabaseLockAdapter;
+};

package/dist/lock/contracts/database-lock-adapter.contract.js

@@ -0,0 +1,5 @@
+/**
+ * @module Lock
+ */
+export {};
+//# sourceMappingURL=database-lock-adapter.contract.js.map

package/dist/lock/contracts/database-lock-adapter.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"database-lock-adapter.contract.js","sourceRoot":"","sources":["../../../src/lock/contracts/database-lock-adapter.contract.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/dist/lock/contracts/lock-adapter.contract.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @module Lock
+ */
+import type { TimeSpan } from "../../utilities/_module-exports.js";
+/**
+ * The <i>ILockAdapter</i> contract defines a way for managing locks independent of the underlying technology.
+ * This contract is not meant to be used directly, instead you should use <i>{@link ILockProvider}</i> contract.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/lock/contracts"```
+ * @group Contracts
+ */
+export type ILockAdapter = {
+    /**
+     * The <i>acquire</i> method acquires a lock only if the lock is not already acquired.
+     * Returns true if not already acquired othewise false is returned.
+     */
+    acquire(key: string, owner: string, ttl: TimeSpan | null): PromiseLike<boolean>;
+    /**
+     * The <i>release</i> method releases a lock if the owner matches.
+     * Returns true if released otherwise false is returned.
+     */
+    release(key: string, owner: string): PromiseLike<boolean>;
+    /**
+     * The <i>forceRelease</i> method releases a lock regardless of the owner.
+     */
+    forceRelease(key: string): PromiseLike<void>;
+    /**
+     * The <i>refresh</i> method will upadte ttl of lock if it matches the given <i>key</i> and matches the given <i>owner</i>.
+     * Returns true if the update occured otherwise false is returned.
+     */
+    refresh(key: string, owner: string, ttl: TimeSpan): PromiseLike<boolean>;
+    /**
+     * The <i>getGroup</i> method returns the group name.
+     */
+    getGroup(): string;
+    /**
+     * The <i>withGroup</i> method returns a new <i>{@link IDatabaseLockAdapter}</i> instance that groups locks together.
+     * Only locks in the same group will be acquired and released, leaving locks outside the group unaffected.
+     */
+    withGroup(group: string): ILockAdapter;
+};

package/dist/lock/contracts/lock-adapter.contract.js

@@ -0,0 +1,5 @@
+/**
+ * @module Lock
+ */
+export {};
+//# sourceMappingURL=lock-adapter.contract.js.map

package/dist/lock/contracts/lock-adapter.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lock-adapter.contract.js","sourceRoot":"","sources":["../../../src/lock/contracts/lock-adapter.contract.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/dist/lock/contracts/lock-provider-factory.contract.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @module Lock
+ */
+import type { IGroupableLockProvider } from "../../lock/contracts/lock-provider.contract.js";
+/**
+ * The <i>ILockProviderFactory</i> contract makes it easy to configure and switch between different <i>{@link IGroupableLockProvider}</i> dynamically.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/lock/contracts"```
+ * @group Contracts
+ */
+export type ILockProviderFactory<TAdapters extends string = string> = {
+    /**
+     * The <i>use</i> method will throw an error if you provide it unregisted adapter.
+     * If no default adapter is defined an error will be thrown by <i>use</i> method.
+     * @throws {UnregisteredAdapterError} {@link UnregisteredAdapterError}
+     * @throws {DefaultAdapterNotDefinedError} {@link DefaultAdapterNotDefinedError}
+     */
+    use(adapterName?: TAdapters): IGroupableLockProvider;
+};

package/dist/lock/contracts/lock-provider-factory.contract.js

@@ -0,0 +1,9 @@
+/**
+ * @module Lock
+ */
+import { 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+UnregisteredAdapterError, 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+DefaultAdapterNotDefinedError, } from "../../utilities/errors.js";
+//# sourceMappingURL=lock-provider-factory.contract.js.map

package/dist/lock/contracts/lock-provider-factory.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lock-provider-factory.contract.js","sourceRoot":"","sources":["../../../src/lock/contracts/lock-provider-factory.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO;AACH,6DAA6D;AAC7D,wBAAwB;AACxB,6DAA6D;AAC7D,6BAA6B,GAChC,MAAM,uBAAuB,CAAC"}

package/dist/lock/contracts/lock-provider.contract.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @module Lock
+ */
+import type { OneOrMore, TimeSpan } from "../../utilities/_module-exports.js";
+import type { ILock, ILockListener } from "../../lock/contracts/lock.contract.js";
+/**
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/lock/contracts"```
+ * @group Contracts
+ */
+export type LockProviderCreateSettings = {
+    ttl?: TimeSpan | null;
+    owner?: OneOrMore<string>;
+};
+/**
+ * The <i>ILockProvider</i> contract defines a way for managing locks independent of the underlying technology.
+ * It commes with more convient methods compared to <i>ILockAdapter</i>.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/lock/contracts"```
+ * @group Contracts
+ */
+export type ILockProvider = ILockListener & {
+    /**
+     * The <i>create</i> method is used to create an instance of <i>{@link ILock}</i>.
+     * You can provide a custom owner using the <i>settings.owner</i> field. If not specified a unique owner will be generated by default.
+     * You can also provide a TTL value using the <i>settings.ttl</i> field. If not specified it defaults to null, meaning no TTL is applied.
+     */
+    create(key: OneOrMore<string>, settings?: LockProviderCreateSettings): ILock;
+    /**
+     * The <i>getGroup</i> method returns the group name.
+     */
+    getGroup(): string;
+};
+/**
+ * The <i>IGroupableLockProvider</i> contract defines a way for managing locks independent of the underlying technology.
+ * It commes with one extra method which is useful for multitennat applications compared to <i>{@link ILockProvider}</i>.
+ *
+ * IMPORT_PATH: ```"@daiso-tech/core/lock/contracts"```
+ * @group Contracts
+ */
+export type IGroupableLockProvider = ILockProvider & {
+    /**
+     * The <i>withGroup</i> method returns a new <i>{@link ILockProvider}</i> instance that groups locks together.
+     * Only locks in the same group will be acquired and released, leaving locks outside the group unaffected.
+     * This useful for multitennat applications.
+     */
+    withGroup(group: OneOrMore<string>): ILockProvider;
+};

package/dist/lock/contracts/lock-provider.contract.js

@@ -0,0 +1,5 @@
+/**
+ * @module Lock
+ */
+export {};
+//# sourceMappingURL=lock-provider.contract.js.map