jacob-alford / schemata-ts

An all-inclusive schema engine featuring schemata inspired by io-ts and validators.js. Written for TypeScript with fp-ts

schemata-ts's Issues

Add PositiveFloatString string module

Add `Base64` string module

See: https://github.com/validatorjs/validator.js/blob/master/src/lib/isBase64.js

Required by JWT module, #9

Add Hash string module

See: https://github.com/validatorjs/validator.js/blob/master/src/lib/isHash.js

Add JWT string module

See: https://github.com/validatorjs/validator.js/blob/master/src/lib/isJWT.js

Add OptionalOption `generic` module

A schemable-combinator that has the parameter shape :: type SchemableParams<S> = <A>(sa: HKT<S, A>) => HKT<S, Option<A>>

Should live in:src/generic/OptionalOption

There are two ways to arrive at Option<A>: from nullable and from undefinable. Unfortunately these are not lawfully combinable, because the requirement of an isomorphism :: encoder <-> decoder for this construction is not bijective.

Add NegativeFloat number module

Negative floats are less than zero and greater than or equal to the smallest safe integer in javascript: -2 ** 53 + 1

Add JSON string module

Add PositiveFloat number module

Positive floats are greater than zero and less than or equal to the greatest safe integer in javascript: 2 ** 53 - 1

Add BtcAddress string module

See: https://github.com/validatorjs/validator.js/blob/master/src/lib/isBtcAddress.js

Add Arbitrary to the `schemableGen.ts` script

Depends on #54 and #55. We need to construct the full Arbitrary.ts module using combinator modules in string, number, and date.

Add `CreditCard` string module

Just backporting this issue since @skeate already has a PR up.

See: #69

Add LatLong string module

See: https://github.com/validatorjs/validator.js/blob/master/src/lib/isLatLong.js

Add EncoderBase base Schemable instance

Create src/internal/EncoderBase.ts for the Schemable2 instance for Encoder.

Depends on #52

Backfill Arbitrary instances to `number` and `date` modules

Depends on #49

Add EthereumAddress string module

See: https://github.com/validatorjs/validator.js/blob/master/src/lib/isEthereumAddress.js

Add HexColor string module

See: https://github.com/validatorjs/validator.js/blob/master/src/lib/isHexColor.js

Add `Encoder` field to `templateCombinator.ts`

Since we now generate the schemable instances for Encoder (#56), let's go ahead and add it to the template generator.

To test, running yarn generate:template string <Module> should generate an Encoder instance for that module. Presumably the default for all of these should be Enc.id().

Backfill Arbitrary instances to `string` modules

Depends on #49

Add Schemable2 typeclass

Add a Schemable2 typeclass in src/internal/Schemable2.ts for use with src/Encoder.ts

Add Husky for pre-commit hooks

Eslint, Typescript checks are in place but need to be adopted for pre-commit hooks.

Generate SchemableExt with combinator's JSDoc comment

Adding JSDocs to all of the generated properties of SchemableExt would display useful information when making a new schema and using intellisense.

This is quite tricky because for each module in string, number, date:

• Read the file contents
• Isolate the module's JSDoc comment (returning Left if jsdoc comment does not exist, or contains TODO)
• Remove comment's asterisks, and empty space
• Keep the raw comment around and inject it as a _.createJSDocComment immediately above the module property declaration in the SchemableExt interface

Generate test file alongside `yarn generate:template`

Making the test files are highly repetitive, and it'd be worthwhile if the template generator also generated its own test.

tests/string/CreditCard.test.ts is a perfect template for this

Correct Float modules upper / lower bounds

I incorrectly assumed the upper/lower bounds of floating point numbers in javascript was Number.MAX_SAFE_INTEGER, but it turns out there's a different property: Number.MAX_VALUE and Number.MIN_VALUE which ought to be used for all the float modules.

Additionally, the comments need to be updated to reflect the bigger range

Add Schemable2 to `schemableGen.ts` script

Depends on #52

Will also auto-generate the Encoder typeclass for free

Add Schemable2 typeclass to each of the module exports: Decoder, Encoder, Eq, Guard, and Type.

Add HSL string module

See: https://github.com/validatorjs/validator.js/blob/master/src/lib/isHSL.js

Add TCPPort number module

Add NonPositiveInt number module

Non-positive integers are zero or less than zero

Add Hexadecimal string module

See: https://github.com/validatorjs/validator.js/blob/master/src/lib/isHexadecimal.js

Add Repo CI / Coverage / Vulnerabilities badge

I've never done this, but here are a few resources:

• https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge
• https://github.com/dwyl/repo-badges

Add NonPositiveIntString string module

Non positive integers are zero, or less than zero

Add fast-check (peer-dep), and Arbitrary schemable instance

This should be a super easy by copying this module: https://github.com/gcanti/io-ts/blob/master/test/Arbitrary.ts into: lib/ArbitraryBase.ts expressing a SchemableInstance (not Ext). The Ext variation will be auto-generated along with the other modules

Add CreditCard string module

See: https://github.com/validatorjs/validator.js/blob/master/src/lib/isCreditCard.js

Add Ascii string module

See: https://github.com/validatorjs/validator.js/blob/master/src/lib/isAscii.js

Add `Base64Url` string module

This is almost the same as Base64, but + and / and represented as - and _.

Add `fast-check` and Arbitrary Schemable

One of the tricky parts to this will be to make sure fast-check doesn't make it into the library bundle. This might mean implementing our own definition of Arbitrary?

Add NonNegativeFloat number module

A non-negative float number can be zero, where a positivefloat is nonzero

Add HexColor module

See: https://github.com/validatorjs/validator.js/blob/master/src/lib/isHexColor.js

Add PostalCode string module

See: https://github.com/validatorjs/validator.js/blob/master/src/lib/isPostalCode.js

Backfill Encoder tests to existing modules

Add AlphaNumeric string module

Probably useful to build alongside Alpha module

Add Alpha string module

A Schemable branded string newtype which determines if the string is purely alphabetic. Should account for internationalization. See validators.js implementation for more details

[2.0] Add example input to README

Right now there's a table showing the primitive type and refined type, but it could be helpful to also provide an example valid input. These can be copied from the test data.

Improve the `Base64` module

Discovery work while adding the Base64 and Base64Url modules. See #40

Currently the isBase64 guard only does a few simple checks. I'm concerned that it might not be exhaustive, but I'm also pretty new to the topic.

Here are a list of learning resources to use when the time comes:

• https://datatracker.ietf.org/doc/html/rfc4648
• https://developer.mozilla.org/en-US/docs/Glossary/Base64
• https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs
• https://base64.guru
• https://rgxdb.com/r/1NUN74O6
• https://stackoverflow.com/questions/55389211/string-based-data-encoding-base64-vs-base64url
• https://stackoverflow.com/questions/475074/regex-to-parse-or-validate-base64-data/475217#475217
• https://en.wikipedia.org/wiki/Base64#Applications_not_compatible_with_RFC_4648_Base64

More resources related to Regex (because I have concerns about performance when using a regex to fully validate

• https://v8.dev/blog/non-backtracking-regexp
• https://medium.com/textmaster-engineering/performance-of-regular-expressions-81371f569698

Add NonNegativeFloatString string module

A non-negative float number can be zero, where a positivefloat is nonzero

Add NonPositiveFloatString string module

Non-positive floats are zero or negative, compared to NegativeFloat which is nonzero

Add NegativeFloatString string module

Positive floats are less than than zero and greater than or equal to the smallest safe integer in javascript: -2 ** 53 + 1

Add NonPositveFloat number module

Non-positive floats are zero or negative, compared to NegativeFloat which is nonzero

Add RGBColor string module

See: https://github.com/validatorjs/validator.js/blob/master/src/lib/isRgbColor.js

Add `IsoDate` string module

Should match ISO 8601 timestamp.

https://github.com/validatorjs/validator.js/blob/master/src/lib/isISO8601.js

Refactor existing tests

Many of the existing tests are written hastily, and need to be updated with test-strength parity to validator.js. There are some new test-utils available that makes bulk testing easy in #35