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

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @voidhash/mimic-effect@0.0.9 build /home/runner/work/mimic/mimic/packages/mimic-effect
+> @voidhash/mimic-effect@1.0.0-beta.1 build /home/runner/work/mimic/mimic/packages/mimic-effect
 > tsdown
 
 ℹ tsdown v0.18.2 powered by rolldown v1.0.0-beta.55
@@ -8,101 +8,105 @@
 ℹ target: es2017
 ℹ tsconfig: tsconfig.json
 ℹ Build start
-ℹ [CJS] dist/index.cjs                                                           2.79 kB │ gzip: 0.52 kB
-ℹ [CJS] dist/WebSocketHandler.cjs                                               13.83 kB │ gzip: 2.46 kB
-ℹ [CJS] dist/MimicServer.cjs                                                     6.03 kB │ gzip: 1.82 kB
-ℹ [CJS] dist/DocumentManager.cjs                                                 4.75 kB │ gzip: 1.40 kB
-ℹ [CJS] dist/PresenceManager.cjs                                                 4.25 kB │ gzip: 1.19 kB
-ℹ [CJS] dist/MimicDataStorage.cjs                                                3.13 kB │ gzip: 0.96 kB
-ℹ [CJS] dist/DocumentProtocol.cjs                                                2.85 kB │ gzip: 0.79 kB
-ℹ [CJS] dist/MimicConfig.cjs                                                     2.77 kB │ gzip: 0.93 kB
-ℹ [CJS] dist/errors.cjs                                                          2.33 kB │ gzip: 0.63 kB
-ℹ [CJS] dist/storage/InMemoryDataStorage.cjs                                     2.21 kB │ gzip: 0.80 kB
-ℹ [CJS] dist/MimicAuthService.cjs                                                2.12 kB │ gzip: 0.69 kB
-ℹ [CJS] dist/auth/NoAuth.cjs                                                     1.52 kB │ gzip: 0.63 kB
-ℹ [CJS] dist/_virtual/rolldown_runtime.cjs                                       1.31 kB │ gzip: 0.61 kB
+ℹ [CJS] dist/index.cjs                                                           2.37 kB │ gzip: 0.49 kB
+ℹ [CJS] dist/MimicClusterServerEngine.cjs                                       18.10 kB │ gzip: 4.15 kB
+ℹ [CJS] dist/MimicServer.cjs                                                    10.10 kB │ gzip: 2.74 kB
+ℹ [CJS] dist/DocumentManager.cjs                                                 9.09 kB │ gzip: 2.24 kB
+ℹ [CJS] dist/MimicServerEngine.cjs                                               4.23 kB │ gzip: 1.34 kB
+ℹ [CJS] dist/Protocol.cjs                                                        3.78 kB │ gzip: 1.14 kB
+ℹ [CJS] dist/PresenceManager.cjs                                                 3.72 kB │ gzip: 1.00 kB
+ℹ [CJS] dist/Metrics.cjs                                                         3.49 kB │ gzip: 0.88 kB
+ℹ [CJS] dist/HotStorage.cjs                                                      2.63 kB │ gzip: 0.94 kB
+ℹ [CJS] dist/MimicAuthService.cjs                                                2.27 kB │ gzip: 0.88 kB
+ℹ [CJS] dist/ColdStorage.cjs                                                     1.91 kB │ gzip: 0.77 kB
+ℹ [CJS] dist/Errors.cjs                                                          1.63 kB │ gzip: 0.49 kB
 ℹ [CJS] dist/_virtual/_@oxc-project_runtime@0.103.0/helpers/objectSpread2.cjs    0.95 kB │ gzip: 0.43 kB
 ℹ [CJS] dist/_virtual/_@oxc-project_runtime@0.103.0/helpers/typeof.cjs           0.53 kB │ gzip: 0.29 kB
 ℹ [CJS] dist/_virtual/_@oxc-project_runtime@0.103.0/helpers/toPrimitive.cjs      0.52 kB │ gzip: 0.32 kB
 ℹ [CJS] dist/_virtual/_@oxc-project_runtime@0.103.0/helpers/defineProperty.cjs   0.40 kB │ gzip: 0.24 kB
 ℹ [CJS] dist/_virtual/_@oxc-project_runtime@0.103.0/helpers/toPropertyKey.cjs    0.37 kB │ gzip: 0.23 kB
-ℹ [CJS] 18 files, total: 52.65 kB
-ℹ [CJS] dist/MimicDataStorage.d.cts.map             1.96 kB │ gzip: 0.73 kB
-ℹ [CJS] dist/DocumentProtocol.d.cts.map             1.35 kB │ gzip: 0.52 kB
-ℹ [CJS] dist/MimicConfig.d.cts.map                  1.03 kB │ gzip: 0.51 kB
-ℹ [CJS] dist/MimicAuthService.d.cts.map             0.97 kB │ gzip: 0.51 kB
-ℹ [CJS] dist/MimicServer.d.cts.map                  0.84 kB │ gzip: 0.44 kB
-ℹ [CJS] dist/errors.d.cts.map                       0.77 kB │ gzip: 0.36 kB
-ℹ [CJS] dist/WebSocketHandler.d.cts.map             0.74 kB │ gzip: 0.35 kB
-ℹ [CJS] dist/PresenceManager.d.cts.map              0.69 kB │ gzip: 0.36 kB
-ℹ [CJS] dist/DocumentManager.d.cts.map              0.52 kB │ gzip: 0.29 kB
-ℹ [CJS] dist/storage/InMemoryDataStorage.d.cts.map  0.26 kB │ gzip: 0.18 kB
-ℹ [CJS] dist/auth/NoAuth.d.cts.map                  0.22 kB │ gzip: 0.17 kB
-ℹ [CJS] dist/index.d.cts                            1.52 kB │ gzip: 0.37 kB
-ℹ [CJS] dist/MimicConfig.d.cts                      5.14 kB │ gzip: 1.43 kB
-ℹ [CJS] dist/MimicDataStorage.d.cts                 4.84 kB │ gzip: 1.19 kB
-ℹ [CJS] dist/MimicServer.d.cts                      4.62 kB │ gzip: 1.65 kB
-ℹ [CJS] dist/errors.d.cts                           4.08 kB │ gzip: 0.75 kB
-ℹ [CJS] dist/DocumentProtocol.d.cts                 3.78 kB │ gzip: 0.78 kB
-ℹ [CJS] dist/PresenceManager.d.cts                  3.00 kB │ gzip: 0.90 kB
-ℹ [CJS] dist/MimicAuthService.d.cts                 2.38 kB │ gzip: 0.77 kB
-ℹ [CJS] dist/DocumentManager.d.cts                  1.77 kB │ gzip: 0.63 kB
-ℹ [CJS] dist/WebSocketHandler.d.cts                 1.73 kB │ gzip: 0.63 kB
-ℹ [CJS] dist/auth/NoAuth.d.cts                      0.72 kB │ gzip: 0.40 kB
-ℹ [CJS] dist/storage/InMemoryDataStorage.d.cts      0.65 kB │ gzip: 0.33 kB
-ℹ [CJS] 23 files, total: 43.60 kB
-✔ Build complete in 5485ms
-ℹ [ESM] dist/index.mjs                                                           1.45 kB │ gzip: 0.36 kB
-ℹ [ESM] dist/WebSocketHandler.mjs.map                                           29.74 kB │ gzip: 5.00 kB
-ℹ [ESM] dist/WebSocketHandler.mjs                                               12.36 kB │ gzip: 2.34 kB
-ℹ [ESM] dist/MimicServer.mjs.map                                                10.71 kB │ gzip: 3.31 kB
-ℹ [ESM] dist/PresenceManager.mjs.map                                            10.45 kB │ gzip: 2.54 kB
-ℹ [ESM] dist/DocumentManager.mjs.map                                             9.97 kB │ gzip: 2.85 kB
-ℹ [ESM] dist/MimicConfig.mjs.map                                                 7.76 kB │ gzip: 2.11 kB
-ℹ [ESM] dist/MimicDataStorage.mjs.map                                            6.27 kB │ gzip: 1.55 kB
-ℹ [ESM] dist/MimicServer.mjs                                                     5.21 kB │ gzip: 1.72 kB
-ℹ [ESM] dist/MimicAuthService.mjs.map                                            4.09 kB │ gzip: 1.10 kB
-ℹ [ESM] dist/DocumentProtocol.mjs.map                                            4.07 kB │ gzip: 1.01 kB
-ℹ [ESM] dist/DocumentManager.mjs                                                 3.81 kB │ gzip: 1.26 kB
-ℹ [ESM] dist/errors.mjs.map                                                      3.53 kB │ gzip: 0.92 kB
-ℹ [ESM] dist/PresenceManager.mjs                                                 3.38 kB │ gzip: 1.06 kB
-ℹ [ESM] dist/storage/InMemoryDataStorage.mjs.map                                 2.84 kB │ gzip: 1.03 kB
-ℹ [ESM] dist/MimicDataStorage.mjs                                                2.66 kB │ gzip: 0.87 kB
-ℹ [ESM] dist/DocumentProtocol.mjs                                                2.44 kB │ gzip: 0.73 kB
-ℹ [ESM] dist/MimicConfig.mjs                                                     2.25 kB │ gzip: 0.84 kB
-ℹ [ESM] dist/MimicDataStorage.d.mts.map                                          1.96 kB │ gzip: 0.73 kB
-ℹ [ESM] dist/errors.mjs                                                          1.95 kB │ gzip: 0.57 kB
-ℹ [ESM] dist/auth/NoAuth.mjs.map                                                 1.82 kB │ gzip: 0.68 kB
-ℹ [ESM] dist/MimicAuthService.mjs                                                1.74 kB │ gzip: 0.61 kB
-ℹ [ESM] dist/storage/InMemoryDataStorage.mjs                                     1.68 kB │ gzip: 0.71 kB
-ℹ [ESM] dist/DocumentProtocol.d.mts.map                                          1.35 kB │ gzip: 0.52 kB
-ℹ [ESM] dist/auth/NoAuth.mjs                                                     1.21 kB │ gzip: 0.56 kB
-ℹ [ESM] dist/MimicConfig.d.mts.map                                               1.03 kB │ gzip: 0.51 kB
-ℹ [ESM] dist/MimicAuthService.d.mts.map                                          0.97 kB │ gzip: 0.51 kB
+ℹ [CJS] dist/_virtual/rolldown_runtime.cjs                                       0.36 kB │ gzip: 0.25 kB
+ℹ [CJS] 18 files, total: 66.45 kB
+ℹ [CJS] dist/Protocol.d.cts.map                  1.57 kB │ gzip: 0.70 kB
+ℹ [CJS] dist/Types.d.cts.map                     1.41 kB │ gzip: 0.65 kB
+ℹ [CJS] dist/MimicServerEngine.d.cts.map         1.05 kB │ gzip: 0.48 kB
+ℹ [CJS] dist/Errors.d.cts.map                    0.72 kB │ gzip: 0.34 kB
+ℹ [CJS] dist/ColdStorage.d.cts.map               0.70 kB │ gzip: 0.37 kB
+ℹ [CJS] dist/HotStorage.d.cts.map                0.64 kB │ gzip: 0.35 kB
+ℹ [CJS] dist/MimicAuthService.d.cts.map          0.61 kB │ gzip: 0.35 kB
+ℹ [CJS] dist/DocumentManager.d.cts.map           0.56 kB │ gzip: 0.33 kB
+ℹ [CJS] dist/PresenceManager.d.cts.map           0.45 kB │ gzip: 0.27 kB
+ℹ [CJS] dist/MimicClusterServerEngine.d.cts.map  0.25 kB │ gzip: 0.19 kB
+ℹ [CJS] dist/MimicServer.d.cts.map               0.22 kB │ gzip: 0.16 kB
+ℹ [CJS] dist/Metrics.d.cts.map                   0.12 kB │ gzip: 0.12 kB
+ℹ [CJS] dist/index.d.cts                         2.23 kB │ gzip: 0.56 kB
+ℹ [CJS] dist/Protocol.d.cts                      5.86 kB │ gzip: 1.34 kB
+ℹ [CJS] dist/Types.d.cts                         5.47 kB │ gzip: 1.54 kB
+ℹ [CJS] dist/Errors.d.cts                        4.10 kB │ gzip: 0.85 kB
+ℹ [CJS] dist/MimicServerEngine.d.cts             3.15 kB │ gzip: 1.00 kB
+ℹ [CJS] dist/MimicAuthService.d.cts              2.70 kB │ gzip: 1.04 kB
+ℹ [CJS] dist/DocumentManager.d.cts               2.23 kB │ gzip: 0.76 kB
+ℹ [CJS] dist/HotStorage.d.cts                    1.95 kB │ gzip: 0.83 kB
+ℹ [CJS] dist/ColdStorage.d.cts                   1.74 kB │ gzip: 0.70 kB
+ℹ [CJS] dist/PresenceManager.d.cts               1.60 kB │ gzip: 0.63 kB
+ℹ [CJS] dist/Metrics.d.cts                       1.37 kB │ gzip: 0.36 kB
+ℹ [CJS] dist/MimicClusterServerEngine.d.cts      0.82 kB │ gzip: 0.33 kB
+ℹ [CJS] dist/MimicServer.d.cts                   0.74 kB │ gzip: 0.31 kB
+ℹ [CJS] 25 files, total: 42.28 kB
+✔ Build complete in 6497ms
+ℹ [ESM] dist/index.mjs                                                           1.34 kB │ gzip: 0.34 kB
+ℹ [ESM] dist/MimicClusterServerEngine.mjs.map                                   35.37 kB │ gzip: 8.25 kB
+ℹ [ESM] dist/DocumentManager.mjs.map                                            21.77 kB │ gzip: 5.24 kB
+ℹ [ESM] dist/MimicServer.mjs.map                                                20.88 kB │ gzip: 5.46 kB
+ℹ [ESM] dist/MimicClusterServerEngine.mjs                                       16.72 kB │ gzip: 4.17 kB
+ℹ [ESM] dist/MimicServerEngine.mjs.map                                           9.73 kB │ gzip: 2.68 kB
+ℹ [ESM] dist/MimicServer.mjs                                                     9.63 kB │ gzip: 2.78 kB
+ℹ [ESM] dist/Protocol.mjs.map                                                    9.18 kB │ gzip: 2.15 kB
+ℹ [ESM] dist/PresenceManager.mjs.map                                             9.11 kB │ gzip: 2.27 kB
+ℹ [ESM] dist/DocumentManager.mjs                                                 8.49 kB │ gzip: 2.26 kB
+ℹ [ESM] dist/HotStorage.mjs.map                                                  6.48 kB │ gzip: 1.93 kB
+ℹ [ESM] dist/MimicAuthService.mjs.map                                            6.09 kB │ gzip: 1.85 kB
+ℹ [ESM] dist/Metrics.mjs.map                                                     5.25 kB │ gzip: 1.22 kB
+ℹ [ESM] dist/ColdStorage.mjs.map                                                 4.90 kB │ gzip: 1.52 kB
+ℹ [ESM] dist/MimicServerEngine.mjs                                               4.10 kB │ gzip: 1.35 kB
+ℹ [ESM] dist/Errors.mjs.map                                                      3.46 kB │ gzip: 0.88 kB
+ℹ [ESM] dist/PresenceManager.mjs                                                 3.39 kB │ gzip: 1.01 kB
+ℹ [ESM] dist/Protocol.mjs                                                        3.35 kB │ gzip: 1.06 kB
+ℹ [ESM] dist/Metrics.mjs                                                         2.95 kB │ gzip: 0.85 kB
+ℹ [ESM] dist/HotStorage.mjs                                                      2.56 kB │ gzip: 0.96 kB
+ℹ [ESM] dist/MimicAuthService.mjs                                                2.23 kB │ gzip: 0.88 kB
+ℹ [ESM] dist/ColdStorage.mjs                                                     1.85 kB │ gzip: 0.79 kB
+ℹ [ESM] dist/Protocol.d.mts.map                                                  1.57 kB │ gzip: 0.70 kB
+ℹ [ESM] dist/Errors.mjs                                                          1.42 kB │ gzip: 0.50 kB
+ℹ [ESM] dist/Types.d.mts.map                                                     1.41 kB │ gzip: 0.65 kB
+ℹ [ESM] dist/MimicServerEngine.d.mts.map                                         1.05 kB │ gzip: 0.48 kB
 ℹ [ESM] dist/_virtual/_@oxc-project_runtime@0.103.0/helpers/objectSpread2.mjs    0.90 kB │ gzip: 0.42 kB
-ℹ [ESM] dist/MimicServer.d.mts.map                                               0.84 kB │ gzip: 0.44 kB
-ℹ [ESM] dist/errors.d.mts.map                                                    0.77 kB │ gzip: 0.36 kB
-ℹ [ESM] dist/WebSocketHandler.d.mts.map                                          0.74 kB │ gzip: 0.35 kB
-ℹ [ESM] dist/PresenceManager.d.mts.map                                           0.69 kB │ gzip: 0.36 kB
-ℹ [ESM] dist/DocumentManager.d.mts.map                                           0.52 kB │ gzip: 0.29 kB
+ℹ [ESM] dist/Errors.d.mts.map                                                    0.72 kB │ gzip: 0.34 kB
+ℹ [ESM] dist/ColdStorage.d.mts.map                                               0.70 kB │ gzip: 0.37 kB
+ℹ [ESM] dist/HotStorage.d.mts.map                                                0.64 kB │ gzip: 0.35 kB
+ℹ [ESM] dist/MimicAuthService.d.mts.map                                          0.61 kB │ gzip: 0.35 kB
+ℹ [ESM] dist/DocumentManager.d.mts.map                                           0.56 kB │ gzip: 0.33 kB
+ℹ [ESM] dist/_virtual/rolldown_runtime.mjs                                       0.47 kB │ gzip: 0.30 kB
 ℹ [ESM] dist/_virtual/_@oxc-project_runtime@0.103.0/helpers/toPrimitive.mjs      0.47 kB │ gzip: 0.30 kB
+ℹ [ESM] dist/PresenceManager.d.mts.map                                           0.45 kB │ gzip: 0.27 kB
 ℹ [ESM] dist/_virtual/_@oxc-project_runtime@0.103.0/helpers/typeof.mjs           0.43 kB │ gzip: 0.24 kB
-ℹ [ESM] dist/_virtual/rolldown_runtime.mjs                                       0.35 kB │ gzip: 0.24 kB
 ℹ [ESM] dist/_virtual/_@oxc-project_runtime@0.103.0/helpers/defineProperty.mjs   0.35 kB │ gzip: 0.23 kB
 ℹ [ESM] dist/_virtual/_@oxc-project_runtime@0.103.0/helpers/toPropertyKey.mjs    0.30 kB │ gzip: 0.21 kB
-ℹ [ESM] dist/storage/InMemoryDataStorage.d.mts.map                               0.26 kB │ gzip: 0.18 kB
-ℹ [ESM] dist/auth/NoAuth.d.mts.map                                               0.22 kB │ gzip: 0.17 kB
-ℹ [ESM] dist/index.d.mts                                                         1.52 kB │ gzip: 0.37 kB
-ℹ [ESM] dist/MimicConfig.d.mts                                                   5.14 kB │ gzip: 1.42 kB
-ℹ [ESM] dist/MimicDataStorage.d.mts                                              4.84 kB │ gzip: 1.19 kB
-ℹ [ESM] dist/MimicServer.d.mts                                                   4.62 kB │ gzip: 1.65 kB
-ℹ [ESM] dist/errors.d.mts                                                        4.08 kB │ gzip: 0.75 kB
-ℹ [ESM] dist/DocumentProtocol.d.mts                                              3.78 kB │ gzip: 0.78 kB
-ℹ [ESM] dist/PresenceManager.d.mts                                               3.00 kB │ gzip: 0.90 kB
-ℹ [ESM] dist/MimicAuthService.d.mts                                              2.38 kB │ gzip: 0.77 kB
-ℹ [ESM] dist/DocumentManager.d.mts                                               1.77 kB │ gzip: 0.63 kB
-ℹ [ESM] dist/WebSocketHandler.d.mts                                              1.73 kB │ gzip: 0.63 kB
-ℹ [ESM] dist/auth/NoAuth.d.mts                                                   0.72 kB │ gzip: 0.40 kB
-ℹ [ESM] dist/storage/InMemoryDataStorage.d.mts                                   0.65 kB │ gzip: 0.33 kB
-ℹ [ESM] 52 files, total: 177.78 kB
-✔ Build complete in 5499ms
+ℹ [ESM] dist/MimicClusterServerEngine.d.mts.map                                  0.25 kB │ gzip: 0.19 kB
+ℹ [ESM] dist/MimicServer.d.mts.map                                               0.22 kB │ gzip: 0.16 kB
+ℹ [ESM] dist/Metrics.d.mts.map                                                   0.12 kB │ gzip: 0.12 kB
+ℹ [ESM] dist/index.d.mts                                                         2.23 kB │ gzip: 0.56 kB
+ℹ [ESM] dist/Protocol.d.mts                                                      5.86 kB │ gzip: 1.34 kB
+ℹ [ESM] dist/Types.d.mts                                                         5.47 kB │ gzip: 1.54 kB
+ℹ [ESM] dist/Errors.d.mts                                                        4.10 kB │ gzip: 0.85 kB
+ℹ [ESM] dist/MimicServerEngine.d.mts                                             3.15 kB │ gzip: 1.01 kB
+ℹ [ESM] dist/MimicAuthService.d.mts                                              2.70 kB │ gzip: 1.04 kB
+ℹ [ESM] dist/DocumentManager.d.mts                                               2.23 kB │ gzip: 0.76 kB
+ℹ [ESM] dist/HotStorage.d.mts                                                    1.95 kB │ gzip: 0.83 kB
+ℹ [ESM] dist/ColdStorage.d.mts                                                   1.74 kB │ gzip: 0.70 kB
+ℹ [ESM] dist/PresenceManager.d.mts                                               1.60 kB │ gzip: 0.63 kB
+ℹ [ESM] dist/Metrics.d.mts                                                       1.37 kB │ gzip: 0.36 kB
+ℹ [ESM] dist/MimicClusterServerEngine.d.mts                                      0.82 kB │ gzip: 0.33 kB
+ℹ [ESM] dist/MimicServer.d.mts                                                   0.74 kB │ gzip: 0.31 kB
+ℹ [ESM] 54 files, total: 235.47 kB
+✔ Build complete in 6508ms

package/README.md

@@ -0,0 +1,385 @@
+# @voidhash/mimic-effect
+
+Effect-based server engine for real-time document collaboration using the Mimic CRDT system.
+
+## Installation
+
+```bash
+pnpm add @voidhash/mimic-effect @voidhash/mimic effect @effect/platform
+```
+
+## Quick Start
+
+```typescript
+import { Effect, Layer } from "effect"
+import { Primitive } from "@voidhash/mimic"
+import {
+  MimicServerEngine,
+  ColdStorage,
+  HotStorage,
+  MimicAuthService,
+} from "@voidhash/mimic-effect"
+
+// Define your document schema
+const TodoSchema = Primitive.Struct({
+  title: Primitive.String().default(""),
+  items: Primitive.Array(
+    Primitive.Struct({
+      text: Primitive.String(),
+      completed: Primitive.Boolean().default(false),
+    })
+  ).default([]),
+})
+
+// Create the engine
+const Engine = MimicServerEngine.make({
+  schema: TodoSchema,
+  initial: { title: "My Todo List" },
+  basePath: "/mimic",
+})
+
+// Wire up with storage and auth
+const MimicLive = Engine.pipe(
+  Layer.provide(ColdStorage.InMemory.make()),
+  Layer.provide(HotStorage.InMemory.make()),
+  Layer.provide(MimicAuthService.NoAuth.make())
+)
+
+// Use in your HTTP server
+const program = Effect.gen(function* () {
+  const engine = yield* MimicServerEngine.Tag
+  // Mount engine.routes in your HTTP server
+  // e.g., with @effect/platform-bun or @effect/platform-node
+})
+
+program.pipe(Effect.provide(MimicLive), Effect.runPromise)
+```
+
+## Architecture
+
+```
+                        MimicServerEngine
+                              |
+          +-------------------+-------------------+
+          |                   |                   |
+    ColdStorage         HotStorage        MimicAuthService
+    (Snapshots)           (WAL)           (Auth/Permissions)
+          |                   |
+          +-------------------+
+                    |
+            Document Storage
+```
+
+### Components
+
+- **MimicServerEngine**: Main entry point that creates HTTP routes for WebSocket connections
+- **ColdStorage**: Snapshot storage interface (for persisting document state)
+- **HotStorage**: Write-ahead log storage (for transaction history)
+- **MimicAuthService**: Authentication and authorization service
+- **DocumentManager**: Internal service managing document lifecycle
+- **PresenceManager**: Internal service managing ephemeral presence state
+
+## Configuration
+
+```typescript
+const Engine = MimicServerEngine.make({
+  // Required: Document schema
+  schema: MySchema,
+
+  // Optional: Initial state for new documents
+  initial: { title: "Untitled" },
+  // Or a function for dynamic initial state:
+  // initial: ({ documentId }) => Effect.succeed({ title: documentId }),
+
+  // Optional: Presence schema for cursor tracking, etc.
+  presence: CursorPresence,
+
+  // Optional: WebSocket route base path (default: "/mimic")
+  basePath: "/mimic",
+
+  // Optional: Document idle timeout before GC (default: 5 minutes)
+  maxIdleTime: "10 minutes",
+
+  // Optional: Max transaction history for deduplication (default: 1000)
+  maxTransactionHistory: 500,
+
+  // Optional: Snapshot configuration
+  snapshot: {
+    interval: "5 minutes",           // Time-based snapshot interval
+    transactionThreshold: 100,       // Transaction count threshold
+  },
+
+  // Optional: Heartbeat configuration
+  heartbeatInterval: "30 seconds",   // How often to ping
+  heartbeatTimeout: "10 seconds",    // How long to wait for pong
+})
+```
+
+## Storage Implementations
+
+### In-Memory (Development/Testing)
+
+```typescript
+import { ColdStorage, HotStorage } from "@voidhash/mimic-effect"
+
+const StorageLive = Layer.mergeAll(
+  ColdStorage.InMemory.make(),
+  HotStorage.InMemory.make()
+)
+```
+
+### Custom Storage
+
+```typescript
+import { ColdStorage, HotStorage } from "@voidhash/mimic-effect"
+
+// Implement ColdStorage interface
+const PostgresColdStorage = Layer.effect(
+  ColdStorage.Tag,
+  Effect.gen(function* () {
+    const db = yield* DatabaseService
+    return {
+      load: (documentId) => /* load from DB */,
+      save: (documentId, doc) => /* save to DB */,
+      delete: (documentId) => /* delete from DB */,
+    }
+  })
+)
+
+// Implement HotStorage interface
+const RedisHotStorage = Layer.effect(
+  HotStorage.Tag,
+  Effect.gen(function* () {
+    const redis = yield* RedisService
+    return {
+      getEntries: (documentId, sinceVersion) => /* get from Redis */,
+      append: (documentId, entry) => /* append to Redis */,
+      truncate: (documentId, upToVersion) => /* truncate in Redis */,
+    }
+  })
+)
+```
+
+## Authentication
+
+### No Authentication (Development)
+
+```typescript
+import { MimicAuthService } from "@voidhash/mimic-effect"
+
+const AuthLive = MimicAuthService.NoAuth.make()
+// All users get "write" permission as "anonymous"
+```
+
+### Static Permissions
+
+```typescript
+import { MimicAuthService } from "@voidhash/mimic-effect"
+
+const AuthLive = MimicAuthService.Static.make({
+  permissions: {
+    "admin-token": "write",
+    "viewer-token": "read",
+  },
+  defaultPermission: "read", // Optional fallback
+})
+```
+
+### Custom Authentication
+
+```typescript
+import { MimicAuthService, AuthenticationError } from "@voidhash/mimic-effect"
+
+const CustomAuth = MimicAuthService.make(
+  Effect.gen(function* () {
+    const jwt = yield* JwtService
+    const db = yield* DatabaseService
+
+    return {
+      authenticate: (token, documentId) =>
+        Effect.gen(function* () {
+          // Verify JWT
+          const payload = yield* jwt.verify(token).pipe(
+            Effect.mapError(() => new AuthenticationError({ reason: "Invalid token" }))
+          )
+
+          // Check document permissions
+          const permission = yield* db.getDocumentPermission(
+            payload.userId,
+            documentId
+          )
+
+          return {
+            userId: payload.userId,
+            permission, // "read" or "write"
+          }
+        }),
+    }
+  })
+)
+```
+
+### Permissions
+
+- `"read"`: Can subscribe, receive transactions, get snapshots
+- `"write"`: All of the above, plus can submit transactions and set presence
+
+## Presence
+
+Enable presence tracking for features like cursor position, user status, etc.
+
+```typescript
+import { Schema } from "effect"
+import { Presence } from "@voidhash/mimic"
+
+// Define presence schema
+const CursorPresence = Presence.make({
+  schema: Schema.Struct({
+    x: Schema.Number,
+    y: Schema.Number,
+    color: Schema.String,
+    name: Schema.optional(Schema.String),
+  }),
+})
+
+// Enable in engine config
+const Engine = MimicServerEngine.make({
+  schema: DocSchema,
+  presence: CursorPresence,
+})
+```
+
+## WebSocket Protocol
+
+### Client -> Server Messages
+
+```typescript
+// Authentication
+{ type: "auth", token: "user-token" }
+
+// Heartbeat
+{ type: "ping" }
+
+// Submit transaction
+{ type: "submit", transaction: EncodedTransaction }
+
+// Request snapshot
+{ type: "request_snapshot" }
+
+// Set presence
+{ type: "presence_set", data: { x: 100, y: 200 } }
+
+// Clear presence
+{ type: "presence_clear" }
+```
+
+### Server -> Client Messages
+
+```typescript
+// Authentication result
+{ type: "auth_result", success: true, userId: "...", permission: "write" }
+{ type: "auth_result", success: false, error: "Invalid token" }
+
+// Heartbeat response
+{ type: "pong" }
+
+// Document snapshot
+{ type: "snapshot", state: {...}, version: 42 }
+
+// Transaction broadcast
+{ type: "transaction", transaction: EncodedTransaction, version: 43 }
+
+// Transaction error
+{ type: "error", transactionId: "tx-123", reason: "..." }
+
+// Presence snapshot (after auth)
+{ type: "presence_snapshot", selfId: "conn-123", presences: {...} }
+
+// Presence update
+{ type: "presence_update", entries: { "conn-456": { data: {...}, userId: "..." } } }
+
+// Presence removal
+{ type: "presence_remove", connectionId: "conn-456" }
+```
+
+## Metrics
+
+Built-in observability metrics using Effect's Metric API:
+
+```typescript
+import { MimicMetrics } from "@voidhash/mimic-effect"
+
+// Connection metrics
+MimicMetrics.connectionsActive    // Gauge: Current connections
+MimicMetrics.connectionsTotal     // Counter: Total connections
+MimicMetrics.connectionsDuration  // Histogram: Connection duration (ms)
+MimicMetrics.connectionsErrors    // Counter: Connection errors
+
+// Document metrics
+MimicMetrics.documentsActive      // Gauge: Documents in memory
+MimicMetrics.documentsCreated     // Counter: New documents
+MimicMetrics.documentsRestored    // Counter: Restored from storage
+MimicMetrics.documentsEvicted     // Counter: Evicted (idle GC)
+
+// Transaction metrics
+MimicMetrics.transactionsProcessed // Counter: Successful transactions
+MimicMetrics.transactionsRejected  // Counter: Rejected transactions
+MimicMetrics.transactionsLatency   // Histogram: Processing time (ms)
+
+// Storage metrics
+MimicMetrics.storageSnapshots      // Counter: Snapshots saved
+MimicMetrics.storageSnapshotLatency // Histogram: Snapshot save time (ms)
+MimicMetrics.storageWalAppends     // Counter: WAL entries written
+
+// Presence metrics
+MimicMetrics.presenceUpdates       // Counter: Presence updates
+MimicMetrics.presenceActive        // Gauge: Active presences
+```
+
+## Integration Examples
+
+### With @effect/platform-bun
+
+```typescript
+import { BunHttpServer, BunRuntime } from "@effect/platform-bun"
+import { HttpRouter, HttpServer } from "@effect/platform"
+
+const server = HttpServer.serve(engine.routes).pipe(
+  Layer.provide(MimicLive),
+  Layer.provide(BunHttpServer.layer({ port: 3000 }))
+)
+
+BunRuntime.runMain(Layer.launch(server))
+```
+
+### With @effect/platform-node
+
+```typescript
+import { NodeHttpServer, NodeRuntime } from "@effect/platform-node"
+import { HttpRouter, HttpServer } from "@effect/platform"
+
+const server = HttpServer.serve(engine.routes).pipe(
+  Layer.provide(MimicLive),
+  Layer.provide(NodeHttpServer.layer({ port: 3000 }))
+)
+
+NodeRuntime.runMain(Layer.launch(server))
+```
+
+## Error Types
+
+```typescript
+import {
+  ColdStorageError,
+  HotStorageError,
+  AuthenticationError,
+  AuthorizationError,
+  MissingDocumentIdError,
+  MessageParseError,
+  TransactionRejectedError,
+} from "@voidhash/mimic-effect"
+```
+
+## License
+
+MIT