Schema: next minor (#2440)

.changeset/old-rats-remember.md

@@ -0,0 +1,34 @@
+---
+"@effect/schema": minor
+---
+
+AST
+
+- rename `isTransform` to `isTransformation`
+
+Schema
+
+- consolidate `transform` and `transformOrFail` parameters into an `options` object, #2434
+- consolidate `Class.transformOrFail` and `Class.transformOrFailFrom` parameters into an `options` object
+- consolidate `declare` parameters into an `options` object
+- consolidate `optionalToRequired` parameters into an `options` object
+- consolidate `optionalToOptional` parameters into an `options` object
+- Removed `negateBigDecimal` function (This cleanup was prompted by the realization that numerous functions can be derived from transformations such as negation, Math.abs, increment, etc. However, including all of them in the library is not feasible. Therefore, `negateBigDecimal` was removed)
+
+ParseResult
+
+- rename `Tuple` to `TupleType`
+
+TreeFormatter
+
+- rename `formatIssue` to `formatIssueSync` (This change was made to maintain consistency in API naming across all decoding and encoding APIs.)
+- rename `formatIssueEffect` to `formatIssue`
+- rename `formatError` to `formatErrorSync`
+- rename `formatErrorEffect` to `formatError`
+
+ArrayFormatter
+
+- rename `formatIssue` to `formatIssueSync`
+- rename `formatIssueEffect` to `formatIssue`
+- rename `formatError` to `formatErrorSync`
+- rename `formatErrorEffect` to `formatError`

packages/cli/src/internal/args.ts

@@ -434,7 +434,7 @@ export const withSchema = dual<
   return mapEffect(self, (_) =>
     Effect.mapError(
       decode(_ as any),
-      (error) => InternalHelpDoc.p(TreeFormatter.formatIssue(error.error))
+      (error) => InternalHelpDoc.p(TreeFormatter.formatIssueSync(error.error))
     ))
 })
 

packages/cli/src/internal/options.ts

@@ -650,7 +650,7 @@ export const withSchema = dual<
   return mapEffect(self, (_) =>
     Effect.mapError(
       decode(_ as any),
-      (error) => InternalValidationError.invalidValue(InternalHelpDoc.p(TreeFormatter.formatIssue(error.error)))
+      (error) => InternalValidationError.invalidValue(InternalHelpDoc.p(TreeFormatter.formatIssueSync(error.error)))
     ))
 })
 

packages/experimental/src/DevTools/Domain.ts

@@ -247,8 +247,7 @@ export const Gauge = metric(
 const numberOrInfinity = Schema.transform(
   Schema.union(Schema.number, Schema.null),
   Schema.number,
-  (i) => i === null ? Number.POSITIVE_INFINITY : i,
-  (i) => Number.isFinite(i) ? i : null
+  { decode: (i) => i === null ? Number.POSITIVE_INFINITY : i, encode: (i) => Number.isFinite(i) ? i : null }
 )
 
 /**

packages/experimental/src/Persistence.ts

@@ -52,7 +52,7 @@ export class PersistenceParseError extends TypeIdError(ErrorTypeId, "Persistence
   }
 
   get message() {
-    return TreeFormatter.formatIssue(this.error)
+    return TreeFormatter.formatIssueSync(this.error)
   }
 }
 

packages/platform/src/Http/Headers.ts

@@ -54,8 +54,7 @@ export const schema: Schema.Schema<Headers, ReadonlyRecord.ReadonlyRecord<string
   Schema.transform(
     Schema.record(Schema.string, Schema.union(Schema.string, Schema.array(Schema.string))),
     schemaFromSelf,
-    (record) => fromInput(record),
-    identity
+    { decode: (record) => fromInput(record), encode: identity }
   )
 
 /**

packages/platform/src/Transferable.ts

@@ -93,8 +93,7 @@ export const schema: {
   Schema.transformOrFail(
     Schema.encodedSchema(self),
     self,
-    ParseResult.succeed,
-    (i) => Effect.as(addAll(f(i)), i)
+    { decode: ParseResult.succeed, encode: (i) => Effect.as(addAll(f(i)), i) }
   ))
 
 /**

packages/platform/src/WorkerError.ts

@@ -28,12 +28,14 @@ export const isWorkerError = (u: unknown): u is WorkerError => Predicate.hasProp
 const causeDefectPretty: Schema.Schema<unknown> = Schema.transform(
   Schema.unknown,
   Schema.unknown,
-  identity,
-  (defect) => {
-    if (Predicate.isObject(defect)) {
-      return Cause.pretty(Cause.die(defect))
+  {
+    decode: identity,
+    encode: (defect) => {
+      if (Predicate.isObject(defect)) {
+        return Cause.pretty(Cause.die(defect))
+      }
+      return String(defect)
     }
-    return String(defect)
   }
 )
 

packages/rpc/src/Router.ts

@@ -204,8 +204,7 @@ export const toHandler = <R extends Router<any, any>>(router: R, options?: {
         Schema.transform(
           rpc.schema,
           Schema.typeSchema(Schema.tuple(rpc.schema, Schema.any)),
-          (request) => [request, rpc] as const,
-          ([request]) => request
+          { decode: (request) => [request, rpc] as const, encode: ([request]) => request }
         )
       )
     )
@@ -302,8 +301,7 @@ export const toHandlerEffect = <R extends Router<any, any>>(router: R, options?:
         Schema.transform(
           rpc.schema,
           Schema.typeSchema(Schema.tuple(rpc.schema, Schema.any)),
-          (request) => [request, rpc] as const,
-          ([request]) => request
+          { decode: (request) => [request, rpc] as const, encode: ([request]) => request }
         )
       )
     )
@@ -370,8 +368,7 @@ export const toHandlerRaw = <R extends Router<any, any>>(router: R) => {
     Schema.transform(
       Schema.typeSchema(rpc.schema),
       Schema.typeSchema(Schema.tuple(rpc.schema, Schema.any)),
-      (request) => [request, rpc] as const,
-      ([request]) => request
+      { decode: (request) => [request, rpc] as const, encode: ([request]) => request }
     )
   ))
   const parse = Schema.decode(schema)