@voidhash/mimic-effect 0.0.9 → 1.0.0-beta.2

package/dist/testing/index.mjs

@@ -0,0 +1,7 @@
+import { TestError } from "./types.mjs";
+import { Categories, ColdStorageTestSuite } from "./ColdStorageTestSuite.mjs";
+import { Categories as Categories$1, HotStorageTestSuite } from "./HotStorageTestSuite.mjs";
+import { Categories as Categories$2, StorageIntegrationTestSuite } from "./StorageIntegrationTestSuite.mjs";
+import { FailingStorage } from "./FailingStorage.mjs";
+
+export { Categories as ColdStorageCategories, ColdStorageTestSuite, FailingStorage, Categories$1 as HotStorageCategories, HotStorageTestSuite, Categories$2 as IntegrationCategories, StorageIntegrationTestSuite, TestError };

package/dist/testing/types.cjs

@@ -0,0 +1,15 @@
+let effect = require("effect");
+
+//#region src/testing/types.ts
+/**
+* @voidhash/mimic-effect/testing - Core Types
+*
+* Types used by the storage adapter test utilities.
+*/
+/**
+* Error thrown when a test assertion fails.
+*/
+var TestError = class extends effect.Data.TaggedError("TestError") {};
+
+//#endregion
+exports.TestError = TestError;

package/dist/testing/types.d.cts

@@ -0,0 +1,90 @@
+import { Effect } from "effect";
+import * as effect_Types7 from "effect/Types";
+import * as effect_Cause7 from "effect/Cause";
+
+//#region src/testing/types.d.ts
+
+declare const TestError_base: new <A extends Record<string, any> = {}>(args: effect_Types7.Equals<A, {}> extends true ? void : { readonly [P in keyof A as P extends "_tag" ? never : P]: A[P] }) => effect_Cause7.YieldableError & {
+  readonly _tag: "TestError";
+} & Readonly<A>;
+/**
+ * Error thrown when a test assertion fails.
+ */
+declare class TestError extends TestError_base<{
+  /** Description of what failed */
+  readonly message: string;
+  /** Expected value (if applicable) */
+  readonly expected?: unknown;
+  /** Actual value received (if applicable) */
+  readonly actual?: unknown;
+}> {}
+/**
+ * A single storage adapter test case.
+ *
+ * Test cases are framework-agnostic Effects that can be run with any test runner.
+ *
+ * @template E - The error type for this test case
+ * @template R - The Effect requirements (e.g., ColdStorageTag or HotStorageTag)
+ *
+ * @example
+ * ```typescript
+ * // Using with vitest
+ * const tests = ColdStorageTestSuite.makeTests();
+ *
+ * describe("MyAdapter", () => {
+ *   for (const test of tests) {
+ *     it(test.name, () =>
+ *       Effect.runPromise(test.run.pipe(Effect.provide(myAdapterLayer)))
+ *     );
+ *   }
+ * });
+ * ```
+ */
+interface StorageTestCase<E, R> {
+  /** Human-readable test name */
+  readonly name: string;
+  /** Category for grouping (e.g., "Basic Operations", "Data Integrity") */
+  readonly category: string;
+  /** The test as an Effect - succeeds if test passes, fails with error if not */
+  readonly run: Effect.Effect<void, E, R>;
+}
+/**
+ * Result of a failed test.
+ */
+interface FailedTest<E, R> {
+  /** The test case that failed */
+  readonly test: StorageTestCase<E, R>;
+  /** The error that caused the failure */
+  readonly error: E;
+}
+/**
+ * Results from running all tests in a suite.
+ *
+ * @example
+ * ```typescript
+ * const results = await Effect.runPromise(
+ *   ColdStorageTestSuite.runAll().pipe(Effect.provide(myAdapterLayer))
+ * );
+ *
+ * console.log(`Passed: ${results.passCount}/${results.total}`);
+ *
+ * for (const { test, error } of results.failed) {
+ *   console.error(`FAIL: ${test.name} - ${error._tag}`);
+ * }
+ * ```
+ */
+interface TestResults<E, R> {
+  /** Tests that passed */
+  readonly passed: StorageTestCase<E, R>[];
+  /** Tests that failed with their errors */
+  readonly failed: FailedTest<E, R>[];
+  /** Total number of tests run */
+  readonly total: number;
+  /** Number of tests that passed */
+  readonly passCount: number;
+  /** Number of tests that failed */
+  readonly failCount: number;
+}
+//#endregion
+export { FailedTest, StorageTestCase, TestError, TestResults };
+//# sourceMappingURL=types.d.cts.map

package/dist/testing/types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.cts","names":[],"sources":["../../src/testing/types.ts"],"sourcesContent":[],"mappings":";;;;;;cAKsC;;;;;;cASzB,SAAA,SAAkB;;;;;;EAAlB,SAAA,MAAU,CAAA,EAAA,OAAQ;AAmC/B,CAAA,CAAA,CAAA;;;;AAgBA;;;;;;AAuBA;;;;;;;;;;;;;UAvCiB;;;;;;gBAMD,MAAA,CAAO,aAAa,GAAG;;;;;UAUtB;;iBAEA,gBAAgB,GAAG;;kBAElB;;;;;;;;;;;;;;;;;;UAmBD;;mBAEE,gBAAgB,GAAG;;mBAEnB,WAAW,GAAG"}

package/dist/testing/types.d.mts

@@ -0,0 +1,90 @@
+import { Effect } from "effect";
+import * as effect_Types0 from "effect/Types";
+import * as effect_Cause0 from "effect/Cause";
+
+//#region src/testing/types.d.ts
+
+declare const TestError_base: new <A extends Record<string, any> = {}>(args: effect_Types0.Equals<A, {}> extends true ? void : { readonly [P in keyof A as P extends "_tag" ? never : P]: A[P] }) => effect_Cause0.YieldableError & {
+  readonly _tag: "TestError";
+} & Readonly<A>;
+/**
+ * Error thrown when a test assertion fails.
+ */
+declare class TestError extends TestError_base<{
+  /** Description of what failed */
+  readonly message: string;
+  /** Expected value (if applicable) */
+  readonly expected?: unknown;
+  /** Actual value received (if applicable) */
+  readonly actual?: unknown;
+}> {}
+/**
+ * A single storage adapter test case.
+ *
+ * Test cases are framework-agnostic Effects that can be run with any test runner.
+ *
+ * @template E - The error type for this test case
+ * @template R - The Effect requirements (e.g., ColdStorageTag or HotStorageTag)
+ *
+ * @example
+ * ```typescript
+ * // Using with vitest
+ * const tests = ColdStorageTestSuite.makeTests();
+ *
+ * describe("MyAdapter", () => {
+ *   for (const test of tests) {
+ *     it(test.name, () =>
+ *       Effect.runPromise(test.run.pipe(Effect.provide(myAdapterLayer)))
+ *     );
+ *   }
+ * });
+ * ```
+ */
+interface StorageTestCase<E, R> {
+  /** Human-readable test name */
+  readonly name: string;
+  /** Category for grouping (e.g., "Basic Operations", "Data Integrity") */
+  readonly category: string;
+  /** The test as an Effect - succeeds if test passes, fails with error if not */
+  readonly run: Effect.Effect<void, E, R>;
+}
+/**
+ * Result of a failed test.
+ */
+interface FailedTest<E, R> {
+  /** The test case that failed */
+  readonly test: StorageTestCase<E, R>;
+  /** The error that caused the failure */
+  readonly error: E;
+}
+/**
+ * Results from running all tests in a suite.
+ *
+ * @example
+ * ```typescript
+ * const results = await Effect.runPromise(
+ *   ColdStorageTestSuite.runAll().pipe(Effect.provide(myAdapterLayer))
+ * );
+ *
+ * console.log(`Passed: ${results.passCount}/${results.total}`);
+ *
+ * for (const { test, error } of results.failed) {
+ *   console.error(`FAIL: ${test.name} - ${error._tag}`);
+ * }
+ * ```
+ */
+interface TestResults<E, R> {
+  /** Tests that passed */
+  readonly passed: StorageTestCase<E, R>[];
+  /** Tests that failed with their errors */
+  readonly failed: FailedTest<E, R>[];
+  /** Total number of tests run */
+  readonly total: number;
+  /** Number of tests that passed */
+  readonly passCount: number;
+  /** Number of tests that failed */
+  readonly failCount: number;
+}
+//#endregion
+export { FailedTest, StorageTestCase, TestError, TestResults };
+//# sourceMappingURL=types.d.mts.map

package/dist/testing/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","names":[],"sources":["../../src/testing/types.ts"],"sourcesContent":[],"mappings":";;;;;;cAKsC;;;;;;cASzB,SAAA,SAAkB;;;;;;EAAlB,SAAA,MAAU,CAAA,EAAA,OAAQ;AAmC/B,CAAA,CAAA,CAAA;;;;AAgBA;;;;;;AAuBA;;;;;;;;;;;;;UAvCiB;;;;;;gBAMD,MAAA,CAAO,aAAa,GAAG;;;;;UAUtB;;iBAEA,gBAAgB,GAAG;;kBAElB;;;;;;;;;;;;;;;;;;UAmBD;;mBAEE,gBAAgB,GAAG;;mBAEnB,WAAW,GAAG"}

package/dist/testing/types.mjs

@@ -0,0 +1,16 @@
+import { Data } from "effect";
+
+//#region src/testing/types.ts
+/**
+* @voidhash/mimic-effect/testing - Core Types
+*
+* Types used by the storage adapter test utilities.
+*/
+/**
+* Error thrown when a test assertion fails.
+*/
+var TestError = class extends Data.TaggedError("TestError") {};
+
+//#endregion
+export { TestError };
+//# sourceMappingURL=types.mjs.map

package/dist/testing/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","names":[],"sources":["../../src/testing/types.ts"],"sourcesContent":["/**\n * @voidhash/mimic-effect/testing - Core Types\n *\n * Types used by the storage adapter test utilities.\n */\nimport { Data, Effect } from \"effect\";\n\n// =============================================================================\n// Error Types\n// =============================================================================\n\n/**\n * Error thrown when a test assertion fails.\n */\nexport class TestError extends Data.TaggedError(\"TestError\")<{\n  /** Description of what failed */\n  readonly message: string;\n  /** Expected value (if applicable) */\n  readonly expected?: unknown;\n  /** Actual value received (if applicable) */\n  readonly actual?: unknown;\n}> {}\n\n// =============================================================================\n// Test Case Types\n// =============================================================================\n\n/**\n * A single storage adapter test case.\n *\n * Test cases are framework-agnostic Effects that can be run with any test runner.\n *\n * @template E - The error type for this test case\n * @template R - The Effect requirements (e.g., ColdStorageTag or HotStorageTag)\n *\n * @example\n * ```typescript\n * // Using with vitest\n * const tests = ColdStorageTestSuite.makeTests();\n *\n * describe(\"MyAdapter\", () => {\n *   for (const test of tests) {\n *     it(test.name, () =>\n *       Effect.runPromise(test.run.pipe(Effect.provide(myAdapterLayer)))\n *     );\n *   }\n * });\n * ```\n */\nexport interface StorageTestCase<E, R> {\n  /** Human-readable test name */\n  readonly name: string;\n  /** Category for grouping (e.g., \"Basic Operations\", \"Data Integrity\") */\n  readonly category: string;\n  /** The test as an Effect - succeeds if test passes, fails with error if not */\n  readonly run: Effect.Effect<void, E, R>;\n}\n\n// =============================================================================\n// Test Results Types\n// =============================================================================\n\n/**\n * Result of a failed test.\n */\nexport interface FailedTest<E, R> {\n  /** The test case that failed */\n  readonly test: StorageTestCase<E, R>;\n  /** The error that caused the failure */\n  readonly error: E;\n}\n\n/**\n * Results from running all tests in a suite.\n *\n * @example\n * ```typescript\n * const results = await Effect.runPromise(\n *   ColdStorageTestSuite.runAll().pipe(Effect.provide(myAdapterLayer))\n * );\n *\n * console.log(`Passed: ${results.passCount}/${results.total}`);\n *\n * for (const { test, error } of results.failed) {\n *   console.error(`FAIL: ${test.name} - ${error._tag}`);\n * }\n * ```\n */\nexport interface TestResults<E, R> {\n  /** Tests that passed */\n  readonly passed: StorageTestCase<E, R>[];\n  /** Tests that failed with their errors */\n  readonly failed: FailedTest<E, R>[];\n  /** Total number of tests run */\n  readonly total: number;\n  /** Number of tests that passed */\n  readonly passCount: number;\n  /** Number of tests that failed */\n  readonly failCount: number;\n}\n"],"mappings":";;;;;;;;;;;AAcA,IAAa,YAAb,cAA+B,KAAK,YAAY,YAAY,CAOzD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voidhash/mimic-effect",
-  "version": "0.0.9",
+  "version": "1.0.0-beta.2",
   "type": "module",
   "repository": {
     "type": "git",
@@ -13,6 +13,11 @@
       "types": "./dist/index.d.mts",
       "import": "./dist/index.mjs",
       "require": "./dist/index.cjs"
+    },
+    "./testing": {
+      "types": "./dist/testing/index.d.mts",
+      "import": "./dist/testing/index.mjs",
+      "require": "./dist/testing/index.cjs"
     }
   },
   "devDependencies": {
@@ -21,12 +26,22 @@
     "typescript": "5.8.3",
     "vite-tsconfig-paths": "^5.1.4",
     "vitest": "^3.2.4",
-    "@voidhash/tsconfig": "0.0.9"
+    "@voidhash/tsconfig": "1.0.0-beta.2"
   },
   "peerDependencies": {
     "@effect/platform": "^0.93.8",
+    "@effect/cluster": "^0.55.0",
+    "@effect/rpc": "^0.72.2",
     "effect": "^3.19.12",
-    "@voidhash/mimic": "0.0.9"
+    "@voidhash/mimic": "1.0.0-beta.2"
+  },
+  "peerDependenciesMeta": {
+    "@effect/cluster": {
+      "optional": true
+    },
+    "@effect/rpc": {
+      "optional": true
+    }
   },
   "scripts": {
     "build": "tsdown",

package/src/ColdStorage.ts

@@ -0,0 +1,136 @@
+/**
+ * @voidhash/mimic-effect - ColdStorage
+ *
+ * Interface and implementations for document snapshot storage.
+ */
+import { Context, Effect, HashMap, Layer, Ref } from "effect";
+import type { StoredDocument } from "./Types";
+import { ColdStorageError } from "./Errors";
+
+// =============================================================================
+// ColdStorage Interface
+// =============================================================================
+
+/**
+ * ColdStorage interface for storing document snapshots.
+ *
+ * This is the "cold" tier of the two-tier storage system.
+ * It stores complete document snapshots less frequently (on periodic intervals
+ * or after a threshold of transactions).
+ */
+export interface ColdStorage {
+  /**
+   * Load a document snapshot.
+   * Returns undefined if the document doesn't exist.
+   */
+  readonly load: (
+    documentId: string
+  ) => Effect.Effect<StoredDocument | undefined, ColdStorageError>;
+
+  /**
+   * Save a document snapshot.
+   */
+  readonly save: (
+    documentId: string,
+    document: StoredDocument
+  ) => Effect.Effect<void, ColdStorageError>;
+
+  /**
+   * Delete a document snapshot.
+   */
+  readonly delete: (
+    documentId: string
+  ) => Effect.Effect<void, ColdStorageError>;
+}
+
+// =============================================================================
+// Context Tag
+// =============================================================================
+
+/**
+ * Context tag for ColdStorage service
+ */
+export class ColdStorageTag extends Context.Tag("@voidhash/mimic-effect/ColdStorage")<
+  ColdStorageTag,
+  ColdStorage
+>() {}
+
+// =============================================================================
+// Factory
+// =============================================================================
+
+/**
+ * Create a ColdStorage layer from an Effect that produces a ColdStorage service.
+ *
+ * This allows you to access other Effect services when implementing custom storage.
+ *
+ * @example
+ * ```typescript
+ * const Cold = ColdStorage.make(
+ *   Effect.gen(function*() {
+ *     const redis = yield* RedisService
+ *
+ *     return {
+ *       load: (documentId) => redis.get(`doc:${documentId}`).pipe(
+ *         Effect.map(data => data ? JSON.parse(data) : undefined)
+ *       ),
+ *       save: (documentId, document) =>
+ *         redis.set(`doc:${documentId}`, JSON.stringify(document)),
+ *       delete: (documentId) => redis.del(`doc:${documentId}`),
+ *     }
+ *   })
+ * )
+ * ```
+ */
+export const make = <E, R>(
+  effect: Effect.Effect<ColdStorage, E, R>
+): Layer.Layer<ColdStorageTag, E, R> =>
+  Layer.effect(ColdStorageTag, effect);
+
+// =============================================================================
+// InMemory Implementation
+// =============================================================================
+
+/**
+ * In-memory ColdStorage implementation.
+ *
+ * Useful for testing and development. Not suitable for production
+ * as data is lost when the process restarts.
+ */
+export namespace InMemory {
+  /**
+   * Create an in-memory ColdStorage layer.
+   */
+  export const make = (): Layer.Layer<ColdStorageTag> =>
+    Layer.effect(
+      ColdStorageTag,
+      Effect.gen(function* () {
+        const store = yield* Ref.make(HashMap.empty<string, StoredDocument>());
+
+        return {
+          load: (documentId) =>
+            Effect.gen(function* () {
+              const current = yield* Ref.get(store);
+              const result = HashMap.get(current, documentId);
+              return result._tag === "Some" ? result.value : undefined;
+            }),
+
+          save: (documentId, document) =>
+            Ref.update(store, (map) => HashMap.set(map, documentId, document)),
+
+          delete: (documentId) =>
+            Ref.update(store, (map) => HashMap.remove(map, documentId)),
+        };
+      })
+    );
+}
+
+// =============================================================================
+// Re-export namespace
+// =============================================================================
+
+export const ColdStorage = {
+  Tag: ColdStorageTag,
+  make,
+  InMemory,
+};