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

package/src/MimicConfig.ts

@@ -1,211 +0,0 @@
-/**
- * @since 0.0.1
- * Configuration types for the Mimic server.
- */
-import * as Context from "effect/Context";
-import * as Duration from "effect/Duration";
-import type { DurationInput } from "effect/Duration";
-import * as Effect from "effect/Effect";
-import * as Layer from "effect/Layer";
-import { Primitive, Presence } from "@voidhash/mimic";
-
-// =============================================================================
-// Initial State Types
-// =============================================================================
-
-/**
- * Context available when computing initial state for a document.
- */
-export interface InitialContext {
-  /**
-   * The document ID being initialized.
-   */
-  readonly documentId: string;
-}
-
-/**
- * Function that computes initial state for a document.
- * Receives context with the document ID and returns an Effect that produces the initial state.
- */
-export type InitialFn<TSchema extends Primitive.AnyPrimitive> = (
-  context: InitialContext
-) => Effect.Effect<Primitive.InferSetInput<TSchema>>;
-
-// =============================================================================
-// Mimic Server Configuration
-// =============================================================================
-
-/**
- * Configuration for the Mimic server.
- * 
- * Note: Authentication and persistence are now handled by injectable services
- * (MimicAuthService and MimicDataStorage) rather than config options.
- */
-export interface MimicServerConfig<
-  TSchema extends Primitive.AnyPrimitive = Primitive.AnyPrimitive,
-> {
-  /**
-   * The schema defining the document structure.
-   */
-  readonly schema: TSchema;
-
-  /**
-   * Maximum idle time for a document before it is cleaned up.
-   * @default "5 minutes"
-   */
-  readonly maxIdleTime: Duration.Duration;
-
-  /**
-   * Maximum number of processed transaction IDs to track for deduplication.
-   * @default 1000
-   */
-  readonly maxTransactionHistory: number;
-
-  /**
-   * Heartbeat interval for WebSocket connections.
-   * @default "30 seconds"
-   */
-  readonly heartbeatInterval: Duration.Duration;
-
-  /**
-   * Timeout for heartbeat responses before considering connection dead.
-   * @default "10 seconds"
-   */
-  readonly heartbeatTimeout: Duration.Duration;
-
-  /**
-   * Optional presence schema for ephemeral per-user data.
-   * When provided, enables presence features on WebSocket connections.
-   * @default undefined (presence disabled)
-   */
-  readonly presence: Presence.AnyPresence | undefined;
-
-  /**
-   * Initial state function for new documents.
-   * Called when a document is created and no existing state is found in storage.
-   * Receives the document ID and returns an Effect that produces the initial state.
-   * @default undefined (documents start empty or use schema defaults)
-   */
-  readonly initial: InitialFn<TSchema> | undefined;
-}
-
-/**
- * Options for creating a MimicServerConfig.
- */
-export interface MimicServerConfigOptions<
-  TSchema extends Primitive.AnyPrimitive = Primitive.AnyPrimitive,
-> {
-  /**
-   * The schema defining the document structure.
-   */
-  readonly schema: TSchema;
-
-  /**
-   * Maximum idle time for a document before it is cleaned up.
-   * @default "5 minutes"
-   */
-  readonly maxIdleTime?: DurationInput;
-
-  /**
-   * Maximum number of processed transaction IDs to track for deduplication.
-   * @default 1000
-   */
-  readonly maxTransactionHistory?: number;
-
-  /**
-   * Heartbeat interval for WebSocket connections.
-   * @default "30 seconds"
-   */
-  readonly heartbeatInterval?: DurationInput;
-
-  /**
-   * Timeout for heartbeat responses.
-   * @default "10 seconds"
-   */
-  readonly heartbeatTimeout?: DurationInput;
-
-  /**
-   * Optional presence schema for ephemeral per-user data.
-   * When provided, enables presence features on WebSocket connections.
-   * @default undefined (presence disabled)
-   */
-  readonly presence?: Presence.AnyPresence;
-
-  /**
-   * Initial state for new documents.
-   * Can be either:
-   * - A plain object with the initial state values
-   * - A function that receives context (with documentId) and returns an Effect producing the initial state
-   *
-   * Type-safe: required fields (without defaults) must be provided,
-   * while optional fields and fields with defaults can be omitted.
-   *
-   * @example
-   * // Plain object
-   * initial: { title: "New Document", count: 0 }
-   *
-   * @example
-   * // Function returning Effect
-   * initial: ({ documentId }) => Effect.succeed({ title: `Doc ${documentId}`, count: 0 })
-   *
-   * @default undefined (documents start empty or use schema defaults)
-   */
-  readonly initial?: Primitive.InferSetInput<TSchema> | InitialFn<TSchema>;
-}
-
-/**
- * Check if a value is an InitialFn (function) rather than a plain object.
- */
-const isInitialFn = <TSchema extends Primitive.AnyPrimitive>(
-  value: Primitive.InferSetInput<TSchema> | InitialFn<TSchema> | undefined
-): value is InitialFn<TSchema> => typeof value === "function";
-
-/**
- * Create a MimicServerConfig from options.
- */
-export const make = <TSchema extends Primitive.AnyPrimitive>(
-  options: MimicServerConfigOptions<TSchema>
-): MimicServerConfig<TSchema> => {
-  const { initial, schema } = options;
-
-  // Convert initial to a function that applies defaults
-  const initialFn: InitialFn<TSchema> | undefined = initial === undefined
-    ? undefined
-    : isInitialFn<TSchema>(initial)
-      ? (context) => Effect.map(
-          initial(context),
-          (state) => Primitive.applyDefaults(schema, state as Partial<Primitive.InferState<TSchema>>)
-        ) as Effect.Effect<Primitive.InferSetInput<TSchema>>
-      : () => Effect.succeed(
-          Primitive.applyDefaults(schema, initial as Partial<Primitive.InferState<TSchema>>)
-        ) as Effect.Effect<Primitive.InferSetInput<TSchema>>;
-
-  return {
-    schema,
-    maxIdleTime: Duration.decode(options.maxIdleTime ?? "5 minutes"),
-    maxTransactionHistory: options.maxTransactionHistory ?? 1000,
-    heartbeatInterval: Duration.decode(options.heartbeatInterval ?? "30 seconds"),
-    heartbeatTimeout: Duration.decode(options.heartbeatTimeout ?? "10 seconds"),
-    presence: options.presence,
-    initial: initialFn,
-  };
-};
-
-// =============================================================================
-// Context Tag
-// =============================================================================
-
-/**
- * Context tag for MimicServerConfig.
- */
-export class MimicServerConfigTag extends Context.Tag(
-  "@voidhash/mimic-server-effect/MimicServerConfig"
-)<MimicServerConfigTag, MimicServerConfig>() {}
-
-/**
- * Create a Layer that provides MimicServerConfig.
- */
-export const layer = <TSchema extends Primitive.AnyPrimitive>(
-  options: MimicServerConfigOptions<TSchema>
-): Layer.Layer<MimicServerConfigTag> =>
-  Layer.succeed(MimicServerConfigTag, make(options) as unknown as MimicServerConfig);

package/src/MimicDataStorage.ts

@@ -1,157 +0,0 @@
-/**
- * @since 0.0.1
- * Data storage service interface for Mimic documents.
- * Provides pluggable storage adapters with load/save hooks for data transformation.
- */
-import * as Effect from "effect/Effect";
-import * as Context from "effect/Context";
-import * as Layer from "effect/Layer";
-import * as Data from "effect/Data";
-
-// =============================================================================
-// Error Types
-// =============================================================================
-
-/**
- * Error when loading a document from storage fails.
- */
-export class StorageLoadError extends Data.TaggedError("StorageLoadError")<{
-  readonly documentId: string;
-  readonly cause: unknown;
-}> {
-  override get message(): string {
-    return `Failed to load document ${this.documentId}: ${String(this.cause)}`;
-  }
-}
-
-/**
- * Error when saving a document to storage fails.
- */
-export class StorageSaveError extends Data.TaggedError("StorageSaveError")<{
-  readonly documentId: string;
-  readonly cause: unknown;
-}> {
-  override get message(): string {
-    return `Failed to save document ${this.documentId}: ${String(this.cause)}`;
-  }
-}
-
-/**
- * Error when deleting a document from storage fails.
- */
-export class StorageDeleteError extends Data.TaggedError("StorageDeleteError")<{
-  readonly documentId: string;
-  readonly cause: unknown;
-}> {
-  override get message(): string {
-    return `Failed to delete document ${this.documentId}: ${String(this.cause)}`;
-  }
-}
-
-/**
- * Union of all storage errors.
- */
-export type StorageError = StorageLoadError | StorageSaveError | StorageDeleteError;
-
-// =============================================================================
-// Storage Service Interface
-// =============================================================================
-
-/**
- * Data storage service interface.
- * Implementations can persist documents to various backends (memory, S3, database, etc.)
- */
-export interface MimicDataStorage {
-  /**
-   * Load a document's state from storage.
-   * @param documentId - The unique identifier for the document
-   * @returns The document state, or undefined if not found
-   */
-  readonly load: (
-    documentId: string
-  ) => Effect.Effect<unknown | undefined, StorageLoadError>;
-
-  /**
-   * Save a document's state to storage.
-   * @param documentId - The unique identifier for the document
-   * @param state - The document state to persist
-   */
-  readonly save: (
-    documentId: string,
-    state: unknown
-  ) => Effect.Effect<void, StorageSaveError>;
-
-  /**
-   * Delete a document from storage.
-   * @param documentId - The unique identifier for the document
-   */
-  readonly delete: (
-    documentId: string
-  ) => Effect.Effect<void, StorageDeleteError>;
-
-  /**
-   * Transform data after loading from storage.
-   * Useful for migrations, decryption, decompression, etc.
-   * @param state - The raw state loaded from storage
-   * @returns The transformed state
-   */
-  readonly onLoad: (state: unknown) => Effect.Effect<unknown>;
-
-  /**
-   * Transform/validate data before saving to storage.
-   * Useful for encryption, compression, validation, etc.
-   * @param state - The state to be saved
-   * @returns The transformed state
-   */
-  readonly onSave: (state: unknown) => Effect.Effect<unknown>;
-}
-
-// =============================================================================
-// Context Tag
-// =============================================================================
-
-/**
- * Context tag for MimicDataStorage service.
- */
-export class MimicDataStorageTag extends Context.Tag(
-  "@voidhash/mimic-server-effect/MimicDataStorage"
-)<MimicDataStorageTag, MimicDataStorage>() {}
-
-// =============================================================================
-// Layer Constructors
-// =============================================================================
-
-/**
- * Create a MimicDataStorage layer from a storage implementation.
- */
-export const layer = (storage: MimicDataStorage): Layer.Layer<MimicDataStorageTag> =>
-  Layer.succeed(MimicDataStorageTag, storage);
-
-/**
- * Create a MimicDataStorage layer from an Effect that produces a storage implementation.
- */
-export const layerEffect = <E, R>(
-  effect: Effect.Effect<MimicDataStorage, E, R>
-): Layer.Layer<MimicDataStorageTag, E, R> =>
-  Layer.effect(MimicDataStorageTag, effect);
-
-// =============================================================================
-// Helper Functions
-// =============================================================================
-
-/**
- * Create a simple storage implementation with minimal configuration.
- */
-export const make = (options: {
-  readonly load: (documentId: string) => Effect.Effect<unknown | undefined, StorageLoadError>;
-  readonly save: (documentId: string, state: unknown) => Effect.Effect<void, StorageSaveError>;
-  readonly delete?: (documentId: string) => Effect.Effect<void, StorageDeleteError>;
-  readonly onLoad?: (state: unknown) => Effect.Effect<unknown>;
-  readonly onSave?: (state: unknown) => Effect.Effect<unknown>;
-}): MimicDataStorage => ({
-  load: options.load,
-  save: options.save,
-  delete: options.delete ?? (() => Effect.void),
-  onLoad: options.onLoad ?? ((state) => Effect.succeed(state)),
-  onSave: options.onSave ?? ((state) => Effect.succeed(state)),
-});