Fix formatting for Class and brands AST (#2581)

.changeset/early-humans-argue.md

@@ -0,0 +1,5 @@
+---
+"@effect/schema": patch
+---
+
+Fix formatting for Class and brands AST.

packages/schema/src/Schema.ts

@@ -2275,15 +2275,12 @@ const makeBrandSchema = <S extends Schema.AnyNoContext, B extends string | symbo
     })
   )
   // make refined a BrandSchema...
-  refined[TypeId] = variance
   refined.ast = ast
-  refined.pipe = function() {
-    return pipeArguments(this, arguments)
-  }
+  refined[TypeId] = variance
+  Object.setPrototypeOf(refined, SchemaImpl.prototype)
   refined.annotations = (annotations: Annotations.Schema<Schema.Type<S> & brand_.Brand<B>>) => {
     return makeBrandSchema(ast, annotations, brand)
   }
-  refined.toString = () => `${ast} & Brand<${formatPropertyKey(brand)}>`
   return refined
 }
 
@@ -2340,6 +2337,8 @@ export const brand = <S extends Schema.AnyNoContext, B extends string | symbol>(
     onSome: (brands) => [...brands, brand]
   })
   return makeBrandSchema(self.ast, {
+    // add a default title annotation containing the brand
+    title: String(self.ast) + ` & Brand<${util_.formatUnknown(brand)}>`,
     ...annotations,
     [AST.BrandAnnotationId]: brandAnnotation
   }, brand)
@@ -6487,6 +6486,10 @@ const makeClass = ({ Base, annotations, fields, fromSchema, identifier, kind, ta
   const classSymbol = Symbol.for(`@effect/schema/${kind}/${identifier}`)
   const schema = fromSchema ?? Struct(fields)
   const validate = ParseResult.validateSync(schema)
+  const from = option_.match(AST.getTitleAnnotation(schema.ast), {
+    onNone: () => schema.annotations({ title: `${identifier} (Encoded side)` }),
+    onSome: () => schema
+  })
 
   return class extends Base {
     constructor(
@@ -6508,10 +6511,6 @@ const makeClass = ({ Base, annotations, fields, fromSchema, identifier, kind, ta
       return classSymbol
     }
 
-    toString() {
-      return toStringOverride !== undefined ? toStringOverride(this) : pretty_.make(this.constructor as any)(this)
-    }
-
     static pipe() {
       return pipeArguments(this, arguments)
     }
@@ -6520,6 +6519,14 @@ const makeClass = ({ Base, annotations, fields, fromSchema, identifier, kind, ta
       return make(this.ast).annotations(annotations)
     }
 
+    static toString() {
+      return `(${String(from)} <-> ${identifier})`
+    }
+
+    toString() {
+      return toStringOverride !== undefined ? toStringOverride(this) : pretty_.make(this.constructor as any)(this)
+    }
+
     static fields = { ...fields }
 
     static identifier = identifier
@@ -6558,10 +6565,6 @@ const makeClass = ({ Base, annotations, fields, fromSchema, identifier, kind, ta
           ...annotations
         }
       )
-      const from = option_.match(AST.getTitleAnnotation(schema.ast), {
-        onNone: () => schema.annotations({ title: `${identifier} (Encoded side)` }),
-        onSome: () => schema
-      })
       const transformation = transform(
         from,
         declaration,

packages/schema/test/Schema/Class/Class.test.ts

@@ -129,6 +129,8 @@ describe("Class APIs", () => {
     it("should be a Schema", () => {
       class A extends S.Class<A>("A")({ a: S.String }) {}
       expect(S.isSchema(A)).toEqual(true)
+      expect(String(A)).toBe("(A (Encoded side) <-> A)")
+      expect(S.format(A)).toBe("(A (Encoded side) <-> A)")
     })
 
     it("should expose the fields", () => {

packages/schema/test/Schema/brand.test.ts

@@ -13,6 +13,12 @@ const isBrandConstructor = (u: unknown): u is Brand.Brand.Constructor<any> =>
 
 describe("brand", () => {
   describe("annotations", () => {
+    it("toString / format", () => {
+      const schema = S.Number.pipe(S.brand("A"))
+      expect(String(schema)).toBe(`number & Brand<"A">`)
+      expect(S.format(schema)).toBe(`number & Brand<"A">`)
+    })
+
     it("using .annotations() twice", () => {
       const schema = S.Number.pipe(S.brand("A"))
       const annotatedSchema = schema.annotations({
@@ -48,7 +54,7 @@ describe("brand", () => {
       expect(schema.ast.annotations).toEqual({
         [AST.TypeAnnotationId]: S.IntTypeId,
         [AST.BrandAnnotationId]: ["A"],
-        [AST.TitleAnnotationId]: "integer",
+        [AST.TitleAnnotationId]: `integer & Brand<"A">`,
         [AST.DescriptionAnnotationId]: "an A brand",
         [AST.JSONSchemaAnnotationId]: { type: "integer" }
       })
@@ -67,7 +73,7 @@ describe("brand", () => {
       expect(schema.ast.annotations).toEqual({
         [AST.TypeAnnotationId]: S.IntTypeId,
         [AST.BrandAnnotationId]: ["A", "B"],
-        [AST.TitleAnnotationId]: "integer",
+        [AST.TitleAnnotationId]: `integer & Brand<"A"> & Brand<"B">`,
         [AST.DescriptionAnnotationId]: "a B brand",
         [AST.JSONSchemaAnnotationId]: { type: "integer" }
       })
@@ -87,7 +93,7 @@ describe("brand", () => {
       expect(schema.ast.annotations).toEqual({
         [AST.TypeAnnotationId]: S.IntTypeId,
         [AST.BrandAnnotationId]: [A, B],
-        [AST.TitleAnnotationId]: "integer",
+        [AST.TitleAnnotationId]: "integer & Brand<Symbol(A)> & Brand<Symbol(B)>",
         [AST.DescriptionAnnotationId]: "a B brand",
         [AST.JSONSchemaAnnotationId]: { type: "integer" }
       })
@@ -131,7 +137,7 @@ describe("brand", () => {
   it("either", () => {
     const Int = S.NumberFromString.pipe(S.int(), S.brand("Int"))
     expect(Int.either(1)).toEqual(Either.right(1))
-    expect(Either.mapLeft(Int.either(1.2), (errors) => errors[0].message)).toEqual(Either.left(`integer
+    expect(Either.mapLeft(Int.either(1.2), (errors) => errors[0].message)).toEqual(Either.left(`integer & Brand<"Int">
 └─ Predicate refinement failure
    └─ Expected an integer, actual 1.2`))
   })