Schema / Document how to introduce jsonSchema annotation type constraints in user-space.

[suddenlyGiovanni]

Type

• Refactor
• Feature
• Bug Fix
• Optimization
• Documentation Update

Description

This PR tries to address the points discussed in #2663;

Context

The outcome of the discussion and decision in n2663 is that @effect/schema will not extend nor maintain its internal typings for JSONSchema7. Instead, it will push such responsibility to the user space; the reasons are sound, and you can explore them by following the discussion.

However, it has also been decided to update the docs to showcase one possible technique and provide an example of how to achieve the same results that n2663 aimed to solve (better type safety and improved DX).

Changes

The README.md file in the schema package has been updated to provide detailed guidance on managing type constraints when dealing with non-standard extensions via the jsonSchema property. The update includes a code example demonstrating how to apply type constraints using the @types/json-schema package for TypeScript definitions.

Related

• Closes Schema / Improve DX for JSON Schema annotations by providing IDEs autocomplete #2663

[changeset-bot]

⚠️ No Changeset found

Latest commit: cdfa12a

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 no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

[gcanti]

@suddenlyGiovanni thanks! (no need for a changeset in this case, you can remove it)