Redesign operation cache

Author: DZakh

IDEAS.md

@@ -6,6 +6,8 @@
 - Add `S.uint8Array` and `S.enableUint8Array`
 - Updated `InvalidType` error code to include the received schema
 - Updated internal representation of object schema - removed `items` fields. Updated internalt representation of tuple schema - `items` field is now an array of schemas instead of array of items. The `item` type is removed.
+- Removed `Failed parsing/converting/asserting` when the error is at root
+- Renamed `Failed parsing/converting/asserting at path` to `Failed at path`
 
 ### TS
 

docs/js-usage.md

@@ -97,7 +97,7 @@ If the data is invalid, the function will throw an error.
 
 ```ts
 S.parser(Player)({ username: "billie", xp: "not a number" });
-// => throws S.Error: Failed parsing at ["xp"]: Expected number, got string
+// => throws S.Error: Failed at ["xp"]: Expected number, got string
 ```
 
 **Sury** API explicitly tells you that it might throw an error. If you need you can catch it and perform `err instanceof S.Error` check. But **Sury** provides a convenient API which does it for you:
@@ -290,7 +290,7 @@ S.assert(
   }),
   "example.com"
 );
-// Throws S.Error: Failed asserting: Invalid email address
+// Throws S.Error: Invalid email address
 ```
 
 ### Standard Schema
@@ -852,7 +852,7 @@ const TestSchema = S.instance(Test);
 
 const blob: any = "whatever";
 S.parser(TestSchema)(new Test()); // passes
-S.parser(TestSchema)(blob); // throws S.Error: Failed parsing: Expected Test, received "whatever"
+S.parser(TestSchema)(blob); // throws S.Error: Expected Test, received "whatever"
 ```
 
 ## Meta
@@ -945,8 +945,8 @@ const numberSetSchema = mySet(S.number);
 type NumberSet = S.Infer<typeof numberSetSchema>; // Set<number>
 
 S.parser(numberSetSchema)(new Set([1, 2, 3])); // passes
-S.parser(numberSetSchema)(new Set([1, 2, "3"])); // throws S.Error: Failed parsing: At item 3 - Expected number, received "3"
-S.parser(numberSetSchema)([1, 2, 3]); // throws S.Error: Failed parsing: Expected Set<number>, received [1, 2, 3]
+S.parser(numberSetSchema)(new Set([1, 2, "3"])); // throws S.Error: At item 3 - Expected number, received "3"
+S.parser(numberSetSchema)([1, 2, 3]); // throws S.Error: Expected Set<number>, received [1, 2, 3]
 ```
 
 ## Recursive schemas
@@ -1134,7 +1134,7 @@ S.parser(reversed)("bar");
 // {"foo": "bar"}
 
 S.parser(reversed)(123);
-// throws S.error with the message: `Failed parsing: Expected string, received 123`
+// throws S.error with the message: `Expected string, received 123`
 ```
 
 Reverses the schema. This gets especially magical for schemas with transformations 🪄
@@ -1147,7 +1147,7 @@ This very powerful API allows you to coerce another data type in a declarative w
 const schema = S.string.with(S.to, S.number);
 
 S.parser(schema)("123"); //? 123.
-S.parser(schema)("abc"); //? throws: Failed parsing: Expected number, received "abc"
+S.parser(schema)("abc"); //? throws: Expected number, received "abc"
 
 // Reverse works correctly as well 🔥
 S.encoder(schema)(123); //? "123"
@@ -1176,7 +1176,7 @@ const schema = S.string.with(
 );
 
 S.parser(schema)("123"); //? 123
-S.parser(schema)("abc"); //? throws: Failed parsing: Invalid number
+S.parser(schema)("abc"); //? throws: Invalid number
 
 S.encodeOrThrow(schema)(123); //? "123"
 ```
@@ -1213,7 +1213,7 @@ Used internally for readable error messages.
 
 ```ts
 S.parser(S.schema(false))(true);
-// => Throws S.Error with the following message: Failed parsing: Expected false, received true".
+// => Throws S.Error with the following message: Expected false, received true".
 ```
 
 You can catch the error using `S.safe` and `S.safeAsync` helpers:

docs/rescript-usage.md

@@ -676,7 +676,7 @@ let schema = S.object(_ => ())->S.strict
 {
   "someField": "value",
 }->S.parseOrThrow(schema)
-// throws S.error with the message: `Failed parsing: Unrecognized key  "unknownKey"`
+// throws S.error with the message: `Unrecognized key  "unknownKey"`
 ```
 
 By default **Sury** silently strips unrecognized keys when parsing objects. You can change the behaviour to disallow unrecognized keys with the `S.strict` function.
@@ -1037,7 +1037,7 @@ The `S.unknown` schema represents any data.
 let schema = S.never
 
 %raw(`undefined`)->S.parseOrThrow(schema)
-// throws S.error with the message: `Failed parsing: Expected never, received undefined`
+// throws S.error with the message: `Expected never, received undefined`
 ```
 
 The `never` schema will fail parsing for every value.
@@ -1192,8 +1192,8 @@ let mySet = itemSchema => {
 let intSetSchema = mySet(S.int)
 
 S.parseOrThrow(%raw(`new Set([1, 2, 3])`), intSetSchema) // passes
-S.parseOrThrow(%raw(`new Set([1, 2, "3"])`), intSetSchema) // throws S.Error: Failed parsing: Expected int32, received "3"
-S.parseOrThrow(%raw(`[1, 2, 3]`), intSetSchema) // throws S.Error: Failed parsing: Expected Set.t<int32>, received [1, 2, 3]
+S.parseOrThrow(%raw(`new Set([1, 2, "3"])`), intSetSchema) // throws S.Error: Expected int32, received "3"
+S.parseOrThrow(%raw(`[1, 2, 3]`), intSetSchema) // throws S.Error: Expected Set.t<int32>, received [1, 2, 3]
 ```
 
 ## Refinements
@@ -1382,7 +1382,7 @@ let reversed = schema->S.reverse
 // {"foo": "bar"}
 
 123->S.parseOrThrow(reversed)
-// throws S.error with the message: `Failed parsing: Expected string, received 123`
+// throws S.error with the message: `Expected string, received 123`
 ```
 
 Reverses the schema. This gets especially magical for schemas with transformations 🪄
@@ -1397,7 +1397,7 @@ This very powerful API allows you to coerce another data type in a declarative w
 let schema = S.string->S.to(S.float)
 
 "123"->S.parseOrThrow(schema) //? 123.
-"abc"->S.parseOrThrow(schema) //? throws: Failed parsing: Expected number, received "abc"
+"abc"->S.parseOrThrow(schema) //? throws: Expected number, received "abc"
 
 // Reverse works correctly as well 🔥
 123.->S.reverseConvertOrThrow(schema) //? "123"
@@ -1467,7 +1467,7 @@ This can be useful to optimise `S.object` parsing when you construct the input d
 let schema = S.literal(false)
 
 true->S.parseOrThrow(schema)
-// throws S.error with the message: `Failed parsing: Expected false, received true`
+// throws S.error with the message: `Expected false, received true`
 ```
 
 If you want to handle the error, the best way to use `try/catch` block:

packages/sury/scripts/pack/Pack.res

@@ -144,7 +144,7 @@ let filesMapping = [
   ("reverse", "S.reverse"),
   ("parser", "S.parser"),
   ("asyncParser", "S.asyncParser"),
-  ("decoder", "S.decoder"),
+  ("decoder", "S.getDecoder"),
   ("asyncDecoder", "S.asyncDecoder"),
   ("encoder", "S.encoder"),
   ("asyncEncoder", "S.asyncEncoder"),

packages/sury/scripts/pack/Pack.res.mjs

@@ -183,7 +183,7 @@ let filesMapping = [
   ],
   [
     "decoder",
-    "S.decoder"
+    "S.getDecoder"
   ],
   [
     "asyncDecoder",

packages/sury/src/S.js

@@ -1,71 +1,71 @@
 /* @ts-self-types="./S.d.ts" */
-import * as S from "./Sury.res.mjs"
-export { unit as void } from "./Sury.res.mjs"
-export var Error = S.ErrorClass.value
-export var string = S.string
-export var boolean = S.bool
-export var int32 = S.int
-export var number = S.float
-export var bigint = S.bigint
-export var symbol = S.symbol
-export var never = S.never
-export var unknown = S.unknown
-export var any = S.unknown
-export var optional = S.js_optional
-export var nullable = S.js_nullable
-export var nullish = S.nullable
-export var array = S.array
-export var instance = S.instance
-export var unnest = S.unnest
-export var record = S.dict
-export var json = S.json
-export var enableJson = S.enableJson
-export var jsonString = S.jsonString
-export var enableJsonString = S.enableJsonString
-export var jsonStringWithSpace = S.jsonStringWithSpace
-export var uint8Array = S.uint8Array
-export var enableUint8Array = S.enableUint8Array
-export var union = S.js_union
-export var object = S.object
-export var schema = S.js_schema
-export var safe = S.js_safe
-export var safeAsync = S.js_safeAsync
-export var reverse = S.reverse
-export var parser = S.parser
-export var asyncParser = S.asyncParser
-export var decoder = S.decoder
-export var asyncDecoder = S.asyncDecoder
-export var encoder = S.encoder
-export var asyncEncoder = S.asyncEncoder
-export var assert = S.js_assert
-export var recursive = S.recursive
-export var merge = S.js_merge
-export var strict = S.strict
-export var deepStrict = S.deepStrict
-export var strip = S.strip
-export var deepStrip = S.deepStrip
-export var to = S.js_to
-export var toJSONSchema = S.toJSONSchema
-export var fromJSONSchema = S.fromJSONSchema
-export var extendJSONSchema = S.extendJSONSchema
-export var shape = S.shape
-export var tuple = S.tuple
-export var asyncParserRefine = S.js_asyncParserRefine
-export var refine = S.js_refine
-export var meta = S.meta
-export var toExpression = S.toExpression
-export var noValidation = S.noValidation
-export var compile = S.compile
-export var port = S.port
-export var min = S.min
-export var max = S.max
-export var length = S.length
-export var email = S.email
-export var uuid = S.uuid
-export var cuid = S.cuid
-export var url = S.url
-export var pattern = S.pattern
-export var datetime = S.datetime
-export var trim = S.trim
-export var global = S.global
-export var brand = S.brand
+import * as S from "./Sury.res.mjs";
+export { unit as void } from "./Sury.res.mjs";
+export var Error = S.ErrorClass.value;
+export var string = S.string;
+export var boolean = S.bool;
+export var int32 = S.int;
+export var number = S.float;
+export var bigint = S.bigint;
+export var symbol = S.symbol;
+export var never = S.never;
+export var unknown = S.unknown;
+export var any = S.unknown;
+export var optional = S.js_optional;
+export var nullable = S.js_nullable;
+export var nullish = S.nullable;
+export var array = S.array;
+export var instance = S.instance;
+export var unnest = S.unnest;
+export var record = S.dict;
+export var json = S.json;
+export var enableJson = S.enableJson;
+export var jsonString = S.jsonString;
+export var enableJsonString = S.enableJsonString;
+export var jsonStringWithSpace = S.jsonStringWithSpace;
+export var uint8Array = S.uint8Array;
+export var enableUint8Array = S.enableUint8Array;
+export var union = S.js_union;
+export var object = S.object;
+export var schema = S.js_schema;
+export var safe = S.js_safe;
+export var safeAsync = S.js_safeAsync;
+export var reverse = S.reverse;
+export var parser = S.parser;
+export var asyncParser = S.asyncParser;
+export var decoder = S.getDecoder;
+export var asyncDecoder = S.asyncDecoder;
+export var encoder = S.encoder;
+export var asyncEncoder = S.asyncEncoder;
+export var assert = S.js_assert;
+export var recursive = S.recursive;
+export var merge = S.js_merge;
+export var strict = S.strict;
+export var deepStrict = S.deepStrict;
+export var strip = S.strip;
+export var deepStrip = S.deepStrip;
+export var to = S.js_to;
+export var toJSONSchema = S.toJSONSchema;
+export var fromJSONSchema = S.fromJSONSchema;
+export var extendJSONSchema = S.extendJSONSchema;
+export var shape = S.shape;
+export var tuple = S.tuple;
+export var asyncParserRefine = S.js_asyncParserRefine;
+export var refine = S.js_refine;
+export var meta = S.meta;
+export var toExpression = S.toExpression;
+export var noValidation = S.noValidation;
+export var compile = S.compile;
+export var port = S.port;
+export var min = S.min;
+export var max = S.max;
+export var length = S.length;
+export var email = S.email;
+export var uuid = S.uuid;
+export var cuid = S.cuid;
+export var url = S.url;
+export var pattern = S.pattern;
+export var datetime = S.datetime;
+export var trim = S.trim;
+export var global = S.global;
+export var brand = S.brand;

packages/sury/src/S.res.mjs

@@ -76,7 +76,9 @@ let shape = Sury.shape;
 
 let to = Sury.to;
 
-let compile = Sury.compile;
+let makeConvertOrThrow = Sury.makeConvertOrThrow;
+
+let makeAsyncConvertOrThrow = Sury.makeAsyncConvertOrThrow;
 
 let parseOrThrow = Sury.parseOrThrow;
 
@@ -224,7 +226,8 @@ export {
   refine,
   shape,
   to,
-  compile,
+  makeConvertOrThrow,
+  makeAsyncConvertOrThrow,
   parseOrThrow,
   parseJsonOrThrow,
   parseJsonStringOrThrow,

packages/sury/src/S.resi

@@ -273,11 +273,7 @@ type s<'value> = {
 
 module Flag: {
   @inline let none: flag
-  @inline let typeValidation: flag
   @inline let async: flag
-  @inline let assertOutput: flag
-  @inline let jsonableOutput: flag
-  @inline let jsonStringOutput: flag
 
   external with: (flag, flag) => flag = "%orint"
   let has: (flag, flag) => bool
@@ -335,29 +331,8 @@ let shape: (t<'value>, 'value => 'shape) => t<'shape>
 
 let to: (t<'from>, t<'to>) => t<'to>
 
-type rec input<'value, 'computed> =
-  | @as("Output") Value: input<'value, 'value>
-  | @as("Input") Unknown: input<'value, unknown>
-  | Any: input<'value, 'any>
-  | Json: input<'value, Js.Json.t>
-  | JsonString: input<'value, string>
-type rec output<'value, 'computed> =
-  | @as("Output") Value: output<'value, 'value>
-  | @as("Input") Unknown: output<'value, unknown>
-  | Assert: output<'value, unit>
-  | Json: output<'value, Js.Json.t>
-  | JsonString: output<'value, string>
-type rec mode<'output, 'computed> =
-  | Sync: mode<'output, 'output>
-  | Async: mode<'output, promise<'output>>
-
-let compile: (
-  t<'value>,
-  ~input: input<'value, 'input>,
-  ~output: output<'value, 'transformedOutput>,
-  ~mode: mode<'transformedOutput, 'output>,
-  ~typeValidation: bool=?,
-) => 'input => 'output
+let makeConvertOrThrow: (t<'from>, t<'to>, ~flag: flag=?) => 'from => 'to
+let makeAsyncConvertOrThrow: (t<'from>, t<'to>, ~flag: flag=?) => 'from => promise<'to>
 
 let parseOrThrow: ('any, t<'value>) => 'value
 let parseJsonOrThrow: (Js.Json.t, t<'value>) => 'value