effect 4.0.0-beta.30 → 4.0.0-beta.31

package/src/Layer.ts

@@ -3062,7 +3062,7 @@ export type PartialEffectful<A extends object> = Types.Simplify<
  * }>()("UserService") {}
  *
  * // Create a partial mock - only implement what you need for testing
- * const testUserLayer = Layer.mock(UserService)({
+ * const testUserLayer = Layer.mock(UserService, {
  *   config: { apiUrl: "https://test-api.com" }, // Required - non-Effect property
  *   getUser: (id: string) => Effect.succeed({ id, name: "Test User" }) // Mock implementation
  *   // deleteUser and updateUser are omitted - will throw UnimplementedError if called
@@ -3086,24 +3086,128 @@ export type PartialEffectful<A extends object> = Types.Simplify<
  * @since 4.0.0
  * @category Testing
  */
-export const mock =
-  <I, S extends object>(service: ServiceMap.Key<I, S>) => (implementation: PartialEffectful<S>): Layer<I> =>
-    succeed(service)(
-      new Proxy({ ...implementation as object } as S, {
-        get(target, prop, _receiver) {
-          if (prop in target) {
-            return target[prop as keyof S]
-          }
-          const prevLimit = (Error as ErrorWithStackTraceLimit).stackTraceLimit
-          ;(Error as ErrorWithStackTraceLimit).stackTraceLimit = 2
-          const error = new Error(`${service.key}: Unimplemented method "${prop.toString()}"`)
-          ;(Error as ErrorWithStackTraceLimit).stackTraceLimit = prevLimit
-          error.name = "UnimplementedError"
-          return makeUnimplemented(error)
-        },
-        has: constTrue
-      })
-    )
+export const mock: {
+  /**
+   * Creates a mock layer for testing purposes. You can provide a partial
+   * implementation of the service, and any methods not provided will
+   * throw an unimplemented defect when called.
+   *
+   * @example
+   * ```ts
+   * import { Effect, Layer, ServiceMap } from "effect"
+   *
+   * class UserService extends ServiceMap.Service<UserService, {
+   *   readonly config: { apiUrl: string }
+   *   readonly getUser: (
+   *     id: string
+   *   ) => Effect.Effect<{ id: string; name: string }, Error>
+   *   readonly deleteUser: (id: string) => Effect.Effect<void, Error>
+   *   readonly updateUser: (
+   *     id: string,
+   *     data: object
+   *   ) => Effect.Effect<{ id: string; name: string }, Error>
+   * }>()("UserService") {}
+   *
+   * // Create a partial mock - only implement what you need for testing
+   * const testUserLayer = Layer.mock(UserService, {
+   *   config: { apiUrl: "https://test-api.com" }, // Required - non-Effect property
+   *   getUser: (id: string) => Effect.succeed({ id, name: "Test User" }) // Mock implementation
+   *   // deleteUser and updateUser are omitted - will throw UnimplementedError if called
+   * })
+   *
+   * // Use in tests
+   * const testProgram = Effect.gen(function*() {
+   *   const userService = yield* UserService
+   *
+   *   // This works - we provided an implementation
+   *   const user = yield* userService.getUser("123")
+   *   console.log(user.name) // "Test User"
+   *
+   *   // This would throw - we didn't implement deleteUser
+   *   // yield* userService.deleteUser("123") // UnimplementedError
+   * }).pipe(
+   *   Effect.provide(testUserLayer)
+   * )
+   * ```
+   *
+   * @since 4.0.0
+   * @category Testing
+   */
+  <I, S extends object>(service: ServiceMap.Key<I, S>): (implementation: PartialEffectful<S>) => Layer<I>
+  /**
+   * Creates a mock layer for testing purposes. You can provide a partial
+   * implementation of the service, and any methods not provided will
+   * throw an unimplemented defect when called.
+   *
+   * @example
+   * ```ts
+   * import { Effect, Layer, ServiceMap } from "effect"
+   *
+   * class UserService extends ServiceMap.Service<UserService, {
+   *   readonly config: { apiUrl: string }
+   *   readonly getUser: (
+   *     id: string
+   *   ) => Effect.Effect<{ id: string; name: string }, Error>
+   *   readonly deleteUser: (id: string) => Effect.Effect<void, Error>
+   *   readonly updateUser: (
+   *     id: string,
+   *     data: object
+   *   ) => Effect.Effect<{ id: string; name: string }, Error>
+   * }>()("UserService") {}
+   *
+   * // Create a partial mock - only implement what you need for testing
+   * const testUserLayer = Layer.mock(UserService, {
+   *   config: { apiUrl: "https://test-api.com" }, // Required - non-Effect property
+   *   getUser: (id: string) => Effect.succeed({ id, name: "Test User" }) // Mock implementation
+   *   // deleteUser and updateUser are omitted - will throw UnimplementedError if called
+   * })
+   *
+   * // Use in tests
+   * const testProgram = Effect.gen(function*() {
+   *   const userService = yield* UserService
+   *
+   *   // This works - we provided an implementation
+   *   const user = yield* userService.getUser("123")
+   *   console.log(user.name) // "Test User"
+   *
+   *   // This would throw - we didn't implement deleteUser
+   *   // yield* userService.deleteUser("123") // UnimplementedError
+   * }).pipe(
+   *   Effect.provide(testUserLayer)
+   * )
+   * ```
+   *
+   * @since 4.0.0
+   * @category Testing
+   */
+  <I, S extends object>(
+    service: ServiceMap.Key<I, S>,
+    implementation: Types.NoInfer<PartialEffectful<S>>
+  ): Layer<I>
+} = function() {
+  if (arguments.length === 1) {
+    return (implementation: any) => mockImpl(arguments[0], implementation)
+  }
+  return mockImpl(arguments[0], arguments[1])
+} as any
+
+const mockImpl = <I, S extends object>(service: ServiceMap.Key<I, S>, implementation: PartialEffectful<S>): Layer<I> =>
+  succeed(service)(
+    new Proxy({ ...implementation as object } as S, {
+      get(target, prop, _receiver) {
+        if (prop in target) {
+          return target[prop as keyof S]
+        }
+        const prevLimit = (Error as ErrorWithStackTraceLimit).stackTraceLimit
+        ;(Error as ErrorWithStackTraceLimit).stackTraceLimit = 2
+        const error = new Error(`${service.key}: Unimplemented method "${prop.toString()}"`)
+        ;(Error as ErrorWithStackTraceLimit).stackTraceLimit = prevLimit
+        error.name = "UnimplementedError"
+        return makeUnimplemented(error)
+      },
+      has: constTrue
+    })
+  )
 
 const makeUnimplemented = (error: globalThis.Error) => {
   const dead = internalEffect.die(error)