Schema annotations interfaces have been refactored into a namespace Annotations

[gcanti]

No description provided.

[changeset-bot]

⚠️ No Changeset found

Latest commit: bbac33f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes changesets to release 10 packages

Name	Type
@effect/schema	Minor
@effect/cli	Major
@effect/experimental	Major
@effect/platform-browser	Major
@effect/platform-bun	Major
@effect/platform-node-shared	Major
@effect/platform-node	Major
@effect/platform	Major
@effect/rpc-http	Major
@effect/rpc	Major

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[patroza]

I suppose i'm early to the party but the problem I have with this is

    const Person = S.struct({
      name: S.string,
      age: S.optional(S.number.pipe(S.positive()), { default: () => 0 }).annotations({
        encodedAnnotations: { description: "An optional age." }
      })
    })

    console.log(JSONSchema.make(S.encodedSchema(Person)))
    console.log(JSONSchema.make(Person))

we're loosing the interesting information like exclusiveMinimum:

{
  '$schema': 'http://json-schema.org/draft-07/schema#',
  type: 'object',
  required: [ 'name' ],
  properties: {
    name: { type: 'string', description: 'a string', title: 'string' },
    age: {
      type: 'number',
      description: 'An optional age.',
      title: 'number'
    }
  },
  additionalProperties: false
}
{
  '$schema': 'http://json-schema.org/draft-07/schema#',
  type: 'object',
  required: [ 'name', 'age' ],
  properties: {
    name: { type: 'string', description: 'a string', title: 'string' },
    age: {
      type: 'number',
      description: 'a positive number',
      title: 'number',
      exclusiveMinimum: 0
    }
  },
  additionalProperties: false
}

I think JSONSchema has to be about how to get from the Encoded side to the Type side, they are maybe distinct but also related. The Type rules must match to successfully decode. So it's a combination of Encoded side property descriptors, and Type side schema rules.

The description "An optional age", makes for a distraction. It's a positive number, it's optionality is a property of the property and documented via the required field, which could be sourced from the Encoded part. The same go for the key, it should come from the Encoded part.

[gcanti]

yeah, this was more of an attempt focused solely on annotations, but in fact, I don't think it's worth it