v0.10 released with Phoenix form support

Hi everyone! I finally released the 0.10 version of Zoi, now you can use your Zoi schemas directly in Phoenix forms.
This release implements the Phoenix.HTML.FormData protocol, which allows you to use Zoi.Context structs as form data sources.

Quick example:

# Define schema inline
@user_schema Zoi.object(%{
  name: Zoi.string() |> Zoi.min(3),
  email: Zoi.email()
}) |> Zoi.Form.prepare()

# Parse and render (just like changesets!)
ctx = Zoi.Form.parse(@user_schema, params)
form = to_form(ctx, as: :user)

socket |> assign(:form, form)

# Use in your forms
~H"""
<.form for={@form} phx-submit="save">
  <.input field={@form[:name]} label="Name" />
  <.input field={@form[:email]} label="Email" />
  <div>
    <.button>Save</.button>
  </div>
</.form>
"""

Guides

• Phoenix Forms Integration Guide - Detailed guide on integrating with phoenix
• Localizing Errors with Gettext Guide - For more information on how to localize error messages.

Release v0.10: zoi | Hex

Zoi is reaching 10k downloads on hex.pm

I would like to thank everyone who has used and supported this library. Every feedback has been taken seriously and helped to improve this project.

These are the main features that have been added based on feedback:

• Zoi.describe/2: function for generating documentation based on descriptions your schema.
• Zoi.Form: module that integrates with Phoenix forms.
• Zoi.JSONSchema: Converting Zoi schemas to JSON Schema (for API documentation, validation, etc.).
• Zoi.Struct: A helper module to define and validate structs using Zoi schemas
• Zoi.Schema: Utilities for traversing and transforming Zoi schemas.

And many more added into the project’s internals!

I created a blog post where I walk through some of the Zoi features and the reason behind creating this library.

Check it out here.

Don’t forget to check the git repo and if you have any feedback or suggestions, feel free to open an issue or a PR.

New 0.15.0 release

Hi everyone!

This new version brings more types and more flexibility with elixir typespecs.

New typespec keyword:

Zoi.integer(gte: 0, typespec: quote(do: non_neg_integer()))
Zoi.any(typespec: quote(do: pos_integer()))

If you have a more complex schema which cannot be fully expressed by the Zoi inferred typespec, you can use this approach to express your type the way you want.

New types

• Zoi.pid/1 type for validating pid values
• Zoi.module/1 type for validating module values
• Zoi.reference/1 type for validating reference values
• Zoi.port/1 type for validating port values
• Zoi.macro/1 type for validating quoted expressions (Macro.t())
• Zoi.function/1 type for validating function values with optional arity constraint
• Zoi.json/1 type for validating any JSON-compatible value (string, number, boolean, null, array, or object with string keys)

Zoi.map/2 is now preferred over Zoi.object/2

This was a feedback from @jam and I was slowly improving the map type to align more with the Elixir native map. Now you can express maps the same as we could express objects with some extras, examples:

# Map with string keys and values are integers
Zoi.map(Zoi.string(), Zoi.integer())

# Map with any key and values
Zoi.map()

# A map the follows a given structure (same as object):
Zoi.map(%{
  name: Zoi.string(),
  age: Zoi.integer() |> Zoi.optional()
})

no changes were made in Zoi.object/2, it uses a structured Zoi.map/2 under the hood and I don’t plan to deprecate this type.

Zoi is 43% faster when parsing

I decided to do some benchmarks and found some areas for improvements. Zoi is even faster when parsing deeply nested data structure. Now Zoi parses 43% faster compared to the previous implementation. You can run the benchmarks by following the documentation here.

Docs: hexdocs.pm/zoi
Hex: hex.pm/packages/zoi
Repo: github.com/phcurado/zoi