milesj / optimal

Build, validate, and transform values with immutable typed schemas.

Optimal

Optimal is a system for building and validating any value with typed schemas, and first-class support for defined object structures, like options objects, configuration files, validation fields, and many more. Optimal aims to provide a powerful API, with high performance, the lowest possible filesize, and TypeScript-first support.

Requirements

• Node v12.17 (server)
• Edge, Chrome, Firefox, Safari (browser)

Documentation

https://optimallib.dev

optimal's Issues

Add __DEV__ checks everywhere

The only thing that should be excluded is return this.

Return type should be deep required

Since everything gets hydrated.

Use generics for method types

Do this:

oneOf<T: string>(list: T[]): this;

Instead of:

oneOf(list: string[]): this;

The latter breaks when a list is passed with aliases.

OR

Add generics to the top layer.

Flow def is named wrong

Should be optimal.js.flow.

Custom should be a builder method

As well as a builder.

Instance: allow no class refs

If no class ref is present, validate that the object is an instance of any class.

Custom callback invariant not prepending path

Union: show class name for instance of

When an error occurs with an instance, we should show the class name.

This:

Invalid option "data". Type must be one of: object, string, FormData.

Instead of:

Invalid option "data". Type must be one of: object, string, instance.

Pass full struct to custom callbacks

Right now its just the current value and parent value

Support custom in union

It isn't right now.

Support mapped types

Currently errors.

Type 'Required<{ colors: ObjectOf<string | ColorConfig>; palettes: { danger: ...; info: ...; muted: ...; neutral: ...; primary: ...; secondary: ...; success: ...; tertiary: ...; warning: ...; }; scheme: ColorScheme; }>' is not assignable to type 'ThemeConfig<ColorNames>'.
  Types of property 'colors' are incompatible.
    Type 'ObjectOf<string | ColorConfig>' is not assignable to type '{ [K in ColorNames]: string | ColorConfig; }'.ts(2322)