@daiso-tech/core 0.49.0 → 0.50.0

package/dist/lock/implementations/test-utilities/{lock-provider.test-suite.d.ts → lock-factory.test-suite.d.ts}

@@ -2,20 +2,21 @@
  * @module Lock
  */
 import { type TestAPI, type SuiteAPI, type ExpectStatic, type beforeEach } from "vitest";
-import { type ILockProvider } from "../../../lock/contracts/_module.js";
+import { type ILockFactory } from "../../../lock/contracts/_module.js";
 import { type ISerde } from "../../../serde/contracts/_module.js";
+import { type ITimeSpan } from "../../../time-span/contracts/_module.js";
 import { type Promisable } from "../../../utilities/_module.js";
 /**
  * IMPORT_PATH: `"@daiso-tech/core/lock/test-utilities"`
  * @group Utilities
  */
-export type LockProviderTestSuiteSettings = {
+export type LockFactoryTestSuiteSettings = {
     expect: ExpectStatic;
     test: TestAPI;
     describe: SuiteAPI;
     beforeEach: typeof beforeEach;
-    createLockProvider: () => Promisable<{
-        lockProvider: ILockProvider;
+    createLockFactory: () => Promisable<{
+        lockFactory: ILockFactory;
         serde: ISerde;
     }>;
     /**
@@ -26,9 +27,32 @@ export type LockProviderTestSuiteSettings = {
      * @default true
      */
     excludeEventTests?: boolean;
+    /**
+     * Enable retry for flaky tests.
+     * @default 0
+     */
+    retry?: number;
+    /**
+     * @default
+     * ```ts
+     * import { TimeSpan } from "@daiso-tech/core/time-span";
+     *
+     * TimeSpan.fromMilliseconds(10)
+     * ```
+     */
+    delayBuffer?: ITimeSpan;
+    /**
+     * @default
+     * ```ts
+     * import { TimeSpan } from "@daiso-tech/core/time-span";
+     *
+     * TimeSpan.fromMilliseconds(10)
+     * ```
+     */
+    timeSpanEqualityBuffer?: ITimeSpan;
 };
 /**
- * The `lockProviderTestSuite` function simplifies the process of testing your custom implementation of {@link ILock | `ILock`} with `vitest`.
+ * The `lockFactoryTestSuite` function simplifies the process of testing your custom implementation of {@link ILock | `ILock`} with `vitest`.
  *
  * IMPORT_PATH: `"@daiso-tech/core/lock/test-utilities"`
  * @group Utilities
@@ -36,23 +60,23 @@ export type LockProviderTestSuiteSettings = {
  * ```ts
  * import { describe, expect, test, beforeEach } from "vitest";
  * import { MemoryLockAdapter } from "@daiso-tech/core/lock/memory-lock-adapter";
- * import { LockProvider } from "@daiso-tech/core/lock";
+ * import { LockFactory } from "@daiso-tech/core/lock";
  * import { EventBus } from "@daiso-tech/core/event-bus";
  * import { MemoryEventBusAdapter } from "@daiso-tech/core/event-bus/memory-event-bus-adapter";
- * import { lockProviderTestSuite } from "@daiso-tech/core/lock/test-utilities";
+ * import { lockFactoryTestSuite } from "@daiso-tech/core/lock/test-utilities";
  * import { Serde } from "@daiso-tech/core/serde";
  * import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter";
  * import type { ILockData } from "@daiso-tech/core/lock/contracts";
  *
- * describe("class: LockProvider", () => {
- *     lockProviderTestSuite({
- *         createLockProvider: () => {
+ * describe("class: LockFactory", () => {
+ *     lockFactoryTestSuite({
+ *         createLockFactory: () => {
  *             const serde = new Serde(new SuperJsonSerdeAdapter());
- *             const lockProvider = new LockProvider({
+ *             const lockFactory = new LockFactory({
  *                 serde,
  *                 adapter: new MemoryLockAdapter(),
  *             });
- *             return { lockProvider, serde };
+ *             return { lockFactory, serde };
  *         },
  *         beforeEach,
  *         describe,
@@ -63,4 +87,4 @@ export type LockProviderTestSuiteSettings = {
  * });
  * ```
  */
-export declare function lockProviderTestSuite(settings: LockProviderTestSuiteSettings): void;
+export declare function lockFactoryTestSuite(settings: LockFactoryTestSuiteSettings): void;