effect 2.0.0-next.55 → 2.0.0-next.57

package/src/Cause.ts

@@ -21,17 +21,23 @@
  *
  * @since 2.0.0
  */
+import type * as Channel from "./Channel.js"
 import type * as Chunk from "./Chunk.js"
+import type * as Data from "./Data.js"
+import type * as Effect from "./Effect.js"
 import type * as Either from "./Either.js"
 import type * as Equal from "./Equal.js"
 import type * as FiberId from "./FiberId.js"
 import type * as HashSet from "./HashSet.js"
 import type { Inspectable } from "./Inspectable.js"
 import * as internal from "./internal/cause.js"
-import { originalInstance } from "./internal/core.js"
+import * as core from "./internal/core.js"
 import type * as Option from "./Option.js"
 import type { Pipeable } from "./Pipeable.js"
 import type { Predicate } from "./Predicate.js"
+import type * as Sink from "./Sink.js"
+import type * as Stream from "./Stream.js"
+import type * as Types from "./Types.js"
 
 /**
  * @since 2.0.0
@@ -49,7 +55,7 @@ export type CauseTypeId = typeof CauseTypeId
  * @since 2.0.0
  * @category symbols
  */
-export const RuntimeExceptionTypeId: unique symbol = internal.RuntimeExceptionTypeId
+export const RuntimeExceptionTypeId: unique symbol = core.RuntimeExceptionTypeId
 
 /**
  * @since 2.0.0
@@ -61,7 +67,7 @@ export type RuntimeExceptionTypeId = typeof RuntimeExceptionTypeId
  * @since 2.0.0
  * @category symbols
  */
-export const InterruptedExceptionTypeId: unique symbol = internal.InterruptedExceptionTypeId
+export const InterruptedExceptionTypeId: unique symbol = core.InterruptedExceptionTypeId
 
 /**
  * @since 2.0.0
@@ -73,7 +79,7 @@ export type InterruptedExceptionTypeId = typeof InterruptedExceptionTypeId
  * @since 2.0.0
  * @category symbols
  */
-export const IllegalArgumentExceptionTypeId: unique symbol = internal.IllegalArgumentExceptionTypeId
+export const IllegalArgumentExceptionTypeId: unique symbol = core.IllegalArgumentExceptionTypeId
 
 /**
  * @since 2.0.0
@@ -85,7 +91,7 @@ export type IllegalArgumentExceptionTypeId = typeof IllegalArgumentExceptionType
  * @since 2.0.0
  * @category symbols
  */
-export const NoSuchElementExceptionTypeId: unique symbol = internal.NoSuchElementExceptionTypeId
+export const NoSuchElementExceptionTypeId: unique symbol = core.NoSuchElementExceptionTypeId
 
 /**
  * @since 2.0.0
@@ -97,7 +103,7 @@ export type NoSuchElementExceptionTypeId = typeof NoSuchElementExceptionTypeId
  * @since 2.0.0
  * @category symbols
  */
-export const InvalidPubSubCapacityExceptionTypeId: unique symbol = internal.InvalidPubSubCapacityExceptionTypeId
+export const InvalidPubSubCapacityExceptionTypeId: unique symbol = core.InvalidPubSubCapacityExceptionTypeId
 
 /**
  * @since 2.0.0
@@ -105,6 +111,18 @@ export const InvalidPubSubCapacityExceptionTypeId: unique symbol = internal.Inva
  */
 export type InvalidPubSubCapacityExceptionTypeId = typeof InvalidPubSubCapacityExceptionTypeId
 
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export const UnknownExceptionTypeId: unique symbol = core.UnknownExceptionTypeId
+
+/**
+ * @since 2.0.0
+ * @category symbols
+ */
+export type UnknownExceptionTypeId = typeof UnknownExceptionTypeId
+
 /**
  * A `Cause` represents the full history of a failure resulting from running an
  * `Effect` workflow.
@@ -133,9 +151,9 @@ export declare namespace Cause {
    * @since 2.0.0
    * @category models
    */
-  export interface Variance<E> {
+  export interface Variance<out E> {
     readonly [CauseTypeId]: {
-      readonly _E: (_: never) => E
+      readonly _E: Types.Covariant<E>
     }
   }
 }
@@ -147,25 +165,51 @@ export declare namespace Cause {
  * @since 2.0.0
  * @category models
  */
-export interface CauseReducer<C, E, Z> {
-  readonly emptyCase: (context: C) => Z
-  readonly failCase: (context: C, error: E) => Z
-  readonly dieCase: (context: C, defect: unknown) => Z
-  readonly interruptCase: (context: C, fiberId: FiberId.FiberId) => Z
-  readonly sequentialCase: (context: C, left: Z, right: Z) => Z
-  readonly parallelCase: (context: C, left: Z, right: Z) => Z
+export interface CauseReducer<in C, in E, in out Z> {
+  emptyCase(context: C): Z
+  failCase(context: C, error: E): Z
+  dieCase(context: C, defect: unknown): Z
+  interruptCase(context: C, fiberId: FiberId.FiberId): Z
+  sequentialCase(context: C, left: Z, right: Z): Z
+  parallelCase(context: C, left: Z, right: Z): Z
+}
+
+/**
+ * @since 2.0.0
+ * @category models
+ */
+export interface YieldableError extends Data.Case, Pipeable, Inspectable, Readonly<Error> {
+  readonly [Effect.EffectTypeId]: Effect.Effect.VarianceStruct<never, this, never>
+  readonly [Stream.StreamTypeId]: Effect.Effect.VarianceStruct<never, this, never>
+  readonly [Sink.SinkTypeId]: Sink.Sink.VarianceStruct<never, this, unknown, never, never>
+  readonly [Channel.ChannelTypeId]: Channel.Channel.VarianceStruct<
+    never,
+    unknown,
+    unknown,
+    unknown,
+    this,
+    never,
+    never
+  >
 }
 
+/**
+ * Represents a generic checked exception which occurs at runtime.
+ *
+ * @since 2.0.0
+ * @category errors
+ */
+export const YieldableError: new(message?: string | undefined) => YieldableError = core.YieldableError
+
 /**
  * Represents a generic checked exception which occurs at runtime.
  *
  * @since 2.0.0
  * @category models
  */
-export interface RuntimeException {
+export interface RuntimeException extends YieldableError {
   readonly _tag: "RuntimeException"
   readonly [RuntimeExceptionTypeId]: RuntimeExceptionTypeId
-  readonly message?: string
 }
 
 /**
@@ -174,10 +218,9 @@ export interface RuntimeException {
  * @since 2.0.0
  * @category models
  */
-export interface InterruptedException {
+export interface InterruptedException extends YieldableError {
   readonly _tag: "InterruptedException"
   readonly [InterruptedExceptionTypeId]: InterruptedExceptionTypeId
-  readonly message?: string
 }
 
 /**
@@ -187,10 +230,9 @@ export interface InterruptedException {
  * @since 2.0.0
  * @category models
  */
-export interface IllegalArgumentException {
+export interface IllegalArgumentException extends YieldableError {
   readonly _tag: "IllegalArgumentException"
   readonly [IllegalArgumentExceptionTypeId]: IllegalArgumentExceptionTypeId
-  readonly message?: string
 }
 
 /**
@@ -200,10 +242,9 @@ export interface IllegalArgumentException {
  * @since 2.0.0
  * @category models
  */
-export interface NoSuchElementException {
+export interface NoSuchElementException extends YieldableError {
   readonly _tag: "NoSuchElementException"
   readonly [NoSuchElementExceptionTypeId]: NoSuchElementExceptionTypeId
-  readonly message?: string
 }
 
 /**
@@ -213,10 +254,22 @@ export interface NoSuchElementException {
  * @since 2.0.0
  * @category models
  */
-export interface InvalidPubSubCapacityException {
+export interface InvalidPubSubCapacityException extends YieldableError {
   readonly _tag: "InvalidPubSubCapacityException"
   readonly [InvalidPubSubCapacityExceptionTypeId]: InvalidPubSubCapacityExceptionTypeId
-  readonly message?: string
+}
+
+/**
+ * Represents a checked exception which occurs when an unknown error is thrown, such as
+ * from a rejected promise.
+ *
+ * @since 2.0.0
+ * @category models
+ */
+export interface UnknownException extends YieldableError {
+  readonly _tag: "UnknownException"
+  readonly [UnknownExceptionTypeId]: UnknownExceptionTypeId
+  readonly error: unknown
 }
 
 /**
@@ -236,7 +289,7 @@ export interface Empty extends Cause.Variance<never>, Equal.Equal, Pipeable, Ins
  * @since 2.0.0
  * @category models
  */
-export interface Fail<E> extends Cause.Variance<E>, Equal.Equal, Pipeable, Inspectable {
+export interface Fail<out E> extends Cause.Variance<E>, Equal.Equal, Pipeable, Inspectable {
   readonly _tag: "Fail"
   readonly error: E
 }
@@ -279,7 +332,7 @@ export interface Interrupt extends Cause.Variance<never>, Equal.Equal, Pipeable,
  * @since 2.0.0
  * @category models
  */
-export interface Parallel<E> extends Cause.Variance<E>, Equal.Equal, Pipeable, Inspectable {
+export interface Parallel<out E> extends Cause.Variance<E>, Equal.Equal, Pipeable, Inspectable {
   readonly _tag: "Parallel"
   readonly left: Cause<E>
   readonly right: Cause<E>
@@ -297,7 +350,7 @@ export interface Parallel<E> extends Cause.Variance<E>, Equal.Equal, Pipeable, I
  * @since 2.0.0
  * @category models
  */
-export interface Sequential<E> extends Cause.Variance<E>, Equal.Equal, Pipeable, Inspectable {
+export interface Sequential<out E> extends Cause.Variance<E>, Equal.Equal, Pipeable, Inspectable {
   readonly _tag: "Sequential"
   readonly left: Cause<E>
   readonly right: Cause<E>
@@ -605,6 +658,19 @@ export const flatMap: {
   <E, E2>(self: Cause<E>, f: (e: E) => Cause<E2>): Cause<E2>
 } = internal.flatMap
 
+/**
+ * Executes a sequence of two `Cause`s. The second `Cause` can be dependent on the result of the first `Cause`.
+ *
+ * @since 2.0.0
+ * @category sequencing
+ */
+export const andThen: {
+  <E, E2>(f: (e: E) => Cause<E2>): (self: Cause<E>) => Cause<E2>
+  <E2>(f: Cause<E2>): <E>(self: Cause<E>) => Cause<E2>
+  <E, E2>(self: Cause<E>, f: (e: E) => Cause<E2>): Cause<E2>
+  <E, E2>(self: Cause<E>, f: Cause<E2>): Cause<E2>
+} = internal.andThen
+
 /**
  * @since 2.0.0
  * @category sequencing
@@ -630,7 +696,7 @@ export const contains: {
  * @since 2.0.0
  * @category destructors
  */
-export const squash: <E>(self: Cause<E>) => unknown = internal.squash
+export const squash: <E>(self: Cause<E>) => unknown = core.causeSquash
 
 /**
  * Squashes a `Cause` down to a single defect, chosen to be the "most important"
@@ -643,7 +709,7 @@ export const squash: <E>(self: Cause<E>) => unknown = internal.squash
 export const squashWith: {
   <E>(f: (error: E) => unknown): (self: Cause<E>) => unknown
   <E>(self: Cause<E>, f: (error: E) => unknown): unknown
-} = internal.squashWith
+} = core.causeSquashWith
 
 /**
  * Uses the provided partial function to search the specified cause and attempt
@@ -728,7 +794,7 @@ export const reduceWithContext: {
  * @since 2.0.0
  * @category errors
  */
-export const InterruptedException: (message?: string) => InterruptedException = internal.InterruptedException
+export const InterruptedException: new(message?: string | undefined) => InterruptedException = core.InterruptedException
 
 /**
  * Returns `true` if the specified value is an `InterruptedException`, `false`
@@ -737,7 +803,7 @@ export const InterruptedException: (message?: string) => InterruptedException =
  * @since 2.0.0
  * @category refinements
  */
-export const isInterruptedException: (u: unknown) => u is InterruptedException = internal.isInterruptedException
+export const isInterruptedException: (u: unknown) => u is InterruptedException = core.isInterruptedException
 
 /**
  * Represents a checked exception which occurs when an invalid argument is
@@ -746,8 +812,8 @@ export const isInterruptedException: (u: unknown) => u is InterruptedException =
  * @since 2.0.0
  * @category errors
  */
-export const IllegalArgumentException: (message?: string) => IllegalArgumentException =
-  internal.IllegalArgumentException
+export const IllegalArgumentException: new(message?: string | undefined) => IllegalArgumentException =
+  core.IllegalArgumentException
 
 /**
  * Returns `true` if the specified value is an `IllegalArgumentException`, `false`
@@ -756,8 +822,7 @@ export const IllegalArgumentException: (message?: string) => IllegalArgumentExce
  * @since 2.0.0
  * @category refinements
  */
-export const isIllegalArgumentException: (u: unknown) => u is IllegalArgumentException =
-  internal.isIllegalArgumentException
+export const isIllegalArgumentException: (u: unknown) => u is IllegalArgumentException = core.isIllegalArgumentException
 
 /**
  * Represents a checked exception which occurs when an expected element was
@@ -766,7 +831,8 @@ export const isIllegalArgumentException: (u: unknown) => u is IllegalArgumentExc
  * @since 2.0.0
  * @category errors
  */
-export const NoSuchElementException: (message?: string) => NoSuchElementException = internal.NoSuchElementException
+export const NoSuchElementException: new(message?: string | undefined) => NoSuchElementException =
+  core.NoSuchElementException
 
 /**
  * Returns `true` if the specified value is an `NoSuchElementException`, `false`
@@ -775,7 +841,7 @@ export const NoSuchElementException: (message?: string) => NoSuchElementExceptio
  * @since 2.0.0
  * @category refinements
  */
-export const isNoSuchElementException: (u: unknown) => u is NoSuchElementException = internal.isNoSuchElementException
+export const isNoSuchElementException: (u: unknown) => u is NoSuchElementException = core.isNoSuchElementException
 
 /**
  * Represents a generic checked exception which occurs at runtime.
@@ -783,7 +849,7 @@ export const isNoSuchElementException: (u: unknown) => u is NoSuchElementExcepti
  * @since 2.0.0
  * @category errors
  */
-export const RuntimeException: (message?: string) => RuntimeException = internal.RuntimeException
+export const RuntimeException: new(message?: string | undefined) => RuntimeException = core.RuntimeException
 
 /**
  * Returns `true` if the specified value is an `RuntimeException`, `false`
@@ -792,7 +858,26 @@ export const RuntimeException: (message?: string) => RuntimeException = internal
  * @since 2.0.0
  * @category refinements
  */
-export const isRuntimeException: (u: unknown) => u is RuntimeException = internal.isRuntimeException
+export const isRuntimeException: (u: unknown) => u is RuntimeException = core.isRuntimeException
+
+/**
+ * Represents a checked exception which occurs when an unknown error is thrown, such as
+ * from a rejected promise.
+ *
+ * @since 2.0.0
+ * @category errors
+ */
+export const UnknownException: new(error: unknown, message?: string | undefined) => UnknownException =
+  core.UnknownException
+
+/**
+ * Returns `true` if the specified value is an `UnknownException`, `false`
+ * otherwise.
+ *
+ * @since 2.0.0
+ * @category refinements
+ */
+export const isUnknownException: (u: unknown) => u is UnknownException = core.isUnknownException
 
 /**
  * Returns the specified `Cause` as a pretty-printed string.
@@ -808,4 +893,4 @@ export const pretty: <E>(cause: Cause<E>) => string = internal.pretty
  * @since 2.0.0
  * @category errors
  */
-export const originalError: <E>(obj: E) => E = originalInstance
+export const originalError: <E>(obj: E) => E = core.originalInstance

package/src/Channel.ts

@@ -28,6 +28,7 @@ import type * as SingleProducerAsyncInput from "./SingleProducerAsyncInput.js"
 import type * as Sink from "./Sink.js"
 import type * as Stream from "./Stream.js"
 import type * as Tracer from "./Tracer.js"
+import type * as Types from "./Types.js"
 import type * as Unify from "./Unify.js"
 import type * as UpstreamPullRequest from "./UpstreamPullRequest.js"
 import type * as UpstreamPullStrategy from "./UpstreamPullStrategy.js"
@@ -70,7 +71,7 @@ export type ChannelTypeId = typeof ChannelTypeId
  * @since 2.0.0
  * @category models
  */
-export interface Channel<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>
+export interface Channel<out Env, in InErr, in InElem, in InDone, out OutErr, out OutElem, out OutDone>
   extends Channel.Variance<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>, Pipeable
 {
   [Unify.typeSymbol]?: unknown
@@ -124,21 +125,21 @@ export declare namespace Channel {
    * @since 2.0.0
    * @category models
    */
-  export interface Variance<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone> {
+  export interface Variance<out Env, in InErr, in InElem, in InDone, out OutErr, out OutElem, out OutDone> {
     readonly [ChannelTypeId]: VarianceStruct<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone>
   }
   /**
    * @since 2.0.0
    * @category models
    */
-  export interface VarianceStruct<Env, InErr, InElem, InDone, OutErr, OutElem, OutDone> {
-    _Env: (_: never) => Env
-    _InErr: (_: InErr) => void
-    _InElem: (_: InElem) => void
-    _InDone: (_: InDone) => void
-    _OutErr: (_: never) => OutErr
-    _OutElem: (_: never) => OutElem
-    _OutDone: (_: never) => OutDone
+  export interface VarianceStruct<out Env, in InErr, in InElem, in InDone, out OutErr, out OutElem, out OutDone> {
+    _Env: Types.Covariant<Env>
+    _InErr: Types.Contravariant<InErr>
+    _InElem: Types.Contravariant<InElem>
+    _InDone: Types.Contravariant<InDone>
+    _OutErr: Types.Covariant<OutErr>
+    _OutElem: Types.Covariant<OutElem>
+    _OutDone: Types.Covariant<OutDone>
   }
 }
 
@@ -161,7 +162,7 @@ export type ChannelExceptionTypeId = typeof ChannelExceptionTypeId
  * @since 2.0.0
  * @category models
  */
-export interface ChannelException<E> {
+export interface ChannelException<out E> {
   readonly _tag: "ChannelException"
   readonly [ChannelExceptionTypeId]: ChannelExceptionTypeId
   readonly error: E

package/src/ChildExecutorDecision.ts

@@ -129,10 +129,18 @@ export const isYield: (self: ChildExecutorDecision) => self is Yield = internal.
  */
 export const match: {
   <A>(
-    options: { readonly onContinue: () => A; readonly onClose: (value: unknown) => A; readonly onYield: () => A }
+    options: {
+      readonly onContinue: () => A
+      readonly onClose: (value: unknown) => A
+      readonly onYield: () => A
+    }
   ): (self: ChildExecutorDecision) => A
   <A>(
     self: ChildExecutorDecision,
-    options: { readonly onContinue: () => A; readonly onClose: (value: unknown) => A; readonly onYield: () => A }
+    options: {
+      readonly onContinue: () => A
+      readonly onClose: (value: unknown) => A
+      readonly onYield: () => A
+    }
   ): A
 } = internal.match