merge transformEither and transformEffect into transformResult (#178)

.changeset/funny-walls-fry.md

@@ -0,0 +1,5 @@
+---
+"@effect/schema": minor
+---
+
+merge transformEither and transformEffect into transformResult

packages/schema/src/Schema.ts

@@ -762,7 +762,7 @@ export function filter<A>(
   @category combinators
   @since 1.0.0
  */
-export const transformEffect: {
+export const transformResult: {
   <I2, A2, A1>(
     to: Schema<I2, A2>,
     decode: (a1: A1, options?: ParseOptions) => ParseResult<I2>,
@@ -781,47 +781,6 @@ export const transformEffect: {
   encode: (i2: I2, options?: ParseOptions) => ParseResult<A1>
 ): Schema<I1, A2> => make(AST.createTransform(from.ast, to.ast, decode, encode)))
 
-/**
-  Create a new `Schema` by transforming the input and output of an existing `Schema`
-  using the provided decoding functions.
-
-  @category combinators
-  @since 1.0.0
- */
-export const transformEither: {
-  <I2, A2, A1>(
-    to: Schema<I2, A2>,
-    decode: (
-      a1: A1,
-      options?: ParseOptions
-    ) => E.Either<PR.ParseError, I2>,
-    encode: (
-      i2: I2,
-      options?: ParseOptions
-    ) => E.Either<PR.ParseError, A1>
-  ): <I1>(self: Schema<I1, A1>) => Schema<I1, A2>
-  <I1, A1, I2, A2>(
-    from: Schema<I1, A1>,
-    to: Schema<I2, A2>,
-    decode: (
-      a1: A1,
-      options?: ParseOptions
-    ) => E.Either<PR.ParseError, I2>,
-    encode: (
-      i2: I2,
-      options?: ParseOptions
-    ) => E.Either<PR.ParseError, A1>
-  ): Schema<I1, A2>
-} = dual(4, <I1, A1, I2, A2>(
-  from: Schema<I1, A1>,
-  to: Schema<I2, A2>,
-  decode: (
-    a1: A1,
-    options?: ParseOptions
-  ) => E.Either<PR.ParseError, I2>,
-  encode: (i2: I2, options?: ParseOptions) => E.Either<PR.ParseError, A1>
-): Schema<I1, A2> => make(AST.createTransform(from.ast, to.ast, decode, encode)))
-
 /**
   Create a new `Schema` by transforming the input and output of an existing `Schema`
   using the provided mapping functions.
@@ -849,7 +808,7 @@ export const transform: {
     decode: (a1: A1) => I2,
     encode: (i2: I2) => A1
   ): Schema<I1, A2> =>
-    transformEither(from, to, (a) => E.right(decode(a)), (b) => E.right(encode(b)))
+    transformResult(from, to, (a) => E.right(decode(a)), (b) => E.right(encode(b)))
 )
 
 /**
@@ -1417,7 +1376,7 @@ export const date: Schema<Date> = declare(
   @category parsers
   @since 1.0.0
 */
-export const dateFromString: Schema<string, Date> = transformEffect(
+export const dateFromString: Schema<string, Date> = transformResult(
   string,
   date,
   (s) => {
@@ -1856,7 +1815,7 @@ export const clamp = <A extends number>(min: number, max: number) =>
   @since 1.0.0
 */
 export const numberFromString = <I>(self: Schema<I, string>): Schema<I, number> => {
-  const schema: Schema<I, number> = transformEffect(
+  const schema: Schema<I, number> = transformResult(
     self,
     number,
     (s) => {

packages/schema/test/Forbidden.ts

@@ -58,9 +58,9 @@ describe.concurrent("Forbidden", () => {
 
   it("transform", () => {
     const schema = pipe(
-      S.transformEither(
+      S.transformResult(
         S.string,
-        S.transformEffect(
+        S.transformResult(
           S.string,
           S.string,
           (s) => PR.flatMap(Util.sleep, () => PR.success(s)),

packages/schema/test/Schema.ts

@@ -591,7 +591,7 @@ describe.concurrent("Schema", () => {
     const To = S.struct({ radius: S.number, _isVisible: S.boolean })
 
     const Circle = pipe(
-      S.transformEither(From, To, S.parseEither(To), ({ _isVisible, ...rest }) => E.right(rest)),
+      S.transformResult(From, To, S.parseEither(To), ({ _isVisible, ...rest }) => E.right(rest)),
       S.attachPropertySignature("_tag", "Circle")
     )
     expect(S.decode(Circle)({ radius: 10, _isVisible: true })).toEqual({