remove default json schema annotations from string, number and boolean (

#3667)

.changeset/pink-files-dance.md

@@ -0,0 +1,47 @@
+---
+"@effect/schema": patch
+---
+
+Remove default json schema annotations from string, number and boolean.
+
+Before
+
+```ts
+import { JSONSchema, Schema } from "@effect/schema"
+
+const schema = Schema.String.annotations({ examples: ["a", "b"] })
+
+console.log(JSON.stringify(JSONSchema.make(schema), null, 2))
+/*
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "description": "a string",
+  "title": "string",
+  "examples": [
+    "a",
+    "b"
+  ]
+}
+*/
+```
+
+After
+
+```ts
+import { JSONSchema, Schema } from "@effect/schema"
+
+const schema = Schema.String.annotations({ examples: ["a", "b"] })
+
+console.log(JSON.stringify(JSONSchema.make(schema), null, 2))
+/*
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "examples": [
+    "a",
+    "b"
+  ]
+}
+*/
+```

packages/schema/src/JSONSchema.ts

@@ -306,6 +306,20 @@ const isOverrideAnnotation = (jsonSchema: JsonSchema7): boolean => {
     ("enum" in jsonSchema) || ("$ref" in jsonSchema)
 }
 
+const removeDefaultJsonSchemaAnnotations = (out: JsonSchema7, def: AST.AST, ast: AST.AST): JsonSchema7 => {
+  if (def === ast) {
+    return out
+  }
+  const jsonSchemaAnnotations = getJsonSchemaAnnotations(ast)
+  if (jsonSchemaAnnotations["title"] === def.annotations[AST.TitleAnnotationId]) {
+    delete jsonSchemaAnnotations["title"]
+  }
+  if (jsonSchemaAnnotations["description"] === def.annotations[AST.DescriptionAnnotationId]) {
+    delete jsonSchemaAnnotations["description"]
+  }
+  return merge(out, jsonSchemaAnnotations)
+}
+
 const go = (
   ast: AST.AST,
   $defs: Record<string, JsonSchema7>,
@@ -371,18 +385,12 @@ const go = (
       return merge(anyJsonSchema, getJsonSchemaAnnotations(ast))
     case "ObjectKeyword":
       return merge(objectJsonSchema, getJsonSchemaAnnotations(ast))
-    case "StringKeyword": {
-      const out: JsonSchema7 = { type: "string" }
-      return ast === AST.stringKeyword ? out : merge(out, getJsonSchemaAnnotations(ast))
-    }
-    case "NumberKeyword": {
-      const out: JsonSchema7 = { type: "number" }
-      return ast === AST.numberKeyword ? out : merge(out, getJsonSchemaAnnotations(ast))
-    }
-    case "BooleanKeyword": {
-      const out: JsonSchema7 = { type: "boolean" }
-      return ast === AST.booleanKeyword ? out : merge(out, getJsonSchemaAnnotations(ast))
-    }
+    case "StringKeyword":
+      return removeDefaultJsonSchemaAnnotations({ type: "string" }, AST.stringKeyword, ast)
+    case "NumberKeyword":
+      return removeDefaultJsonSchemaAnnotations({ type: "number" }, AST.numberKeyword, ast)
+    case "BooleanKeyword":
+      return removeDefaultJsonSchemaAnnotations({ type: "boolean" }, AST.booleanKeyword, ast)
     case "BigIntKeyword":
       throw new Error(errors_.getJSONSchemaMissingAnnotationErrorMessage(path, ast))
     case "SymbolKeyword":

packages/schema/test/JSONSchema.test.ts

@@ -181,6 +181,11 @@ schema (Declaration): DateFromSelf`
       "$schema": "http://json-schema.org/draft-07/schema#",
       "title": "void"
     })
+    expectJSONSchema(Schema.Void.annotations({}), {
+      "$id": "/schemas/void",
+      "$schema": "http://json-schema.org/draft-07/schema#",
+      "title": "void"
+    })
   })
 
   it("Object", () => {
@@ -215,9 +220,7 @@ schema (Declaration): DateFromSelf`
     })
     expectJSONSchema(Schema.String.annotations({}), {
       "$schema": "http://json-schema.org/draft-07/schema#",
-      type: "string",
-      description: "a string",
-      title: "string"
+      type: "string"
     })
   })
 
@@ -228,9 +231,7 @@ schema (Declaration): DateFromSelf`
     }, false)
     expectJSONSchema(Schema.Number.annotations({}), {
       "$schema": "http://json-schema.org/draft-07/schema#",
-      type: "number",
-      description: "a number",
-      title: "number"
+      type: "number"
     }, false)
   })
 
@@ -241,9 +242,7 @@ schema (Declaration): DateFromSelf`
     })
     expectJSONSchema(Schema.Boolean.annotations({}), {
       "$schema": "http://json-schema.org/draft-07/schema#",
-      type: "boolean",
-      description: "a boolean",
-      title: "boolean"
+      type: "boolean"
     })
   })
 
@@ -544,7 +543,6 @@ schema (Declaration): DateFromSelf`
         "items": [
           {
             "type": "string",
-            "title": "string",
             "description": "e"
           },
           {
@@ -1442,8 +1440,6 @@ schema (Suspend): <suspended schema>`
       expectJSONSchema(Schema.String.annotations({ examples: ["a", "b"] }), {
         "$schema": "http://json-schema.org/draft-07/schema#",
         "type": "string",
-        "title": "string",
-        "description": "a string",
         "examples": ["a", "b"]
       })
     })
@@ -1452,8 +1448,6 @@ schema (Suspend): <suspended schema>`
       expectJSONSchema(Schema.String.annotations({ default: "" }), {
         "$schema": "http://json-schema.org/draft-07/schema#",
         "type": "string",
-        "title": "string",
-        "description": "a string",
         "default": ""
       })
     })
@@ -1572,9 +1566,7 @@ schema (Suspend): <suspended schema>`
         "$ref": "#/$defs/Name",
         "$defs": {
           "Name": {
-            "type": "string",
-            "description": "a string",
-            "title": "string"
+            "type": "string"
           }
         }
       })