Add S.uint8Array

Author: DZakh

IDEAS.md

@@ -8,6 +8,7 @@
 - Update Standard Schema error message to only include reason part
 - Fix refinement on union schema which also uses `S.to`
 - TS API: Removed `S.transform` in favor of `S.to`
+- Add `S.uint8Array` and `S.enableUint8Array`
 
 ### TS
 

docs/js-usage.md

@@ -374,6 +374,7 @@ Enable the schemas you need at the project root:
 ```ts
 S.enableJson();
 S.enableJsonString();
+S.enableUint8Array();
 ```
 
 And use them as usual:
@@ -386,18 +387,21 @@ And use them as usual:
 S.json;
 
 // JSON string
-
 // Asserts that the input is a valid JSON string
 S.jsonString;
 S.jsonStringWithSpace(2);
-
 // Parses JSON string and validates that it's a number
 // JSON string -> number
 S.jsonString.with(S.to, S.number);
-
 // Serializes number to JSON string
-// number -> JSON string
 S.number.with(S.to, S.jsonString);
+
+// Asserts that the input is an instance of Uint8Array
+S.uint8Array;
+// Decodes Uint8Array to utf-8 string
+S.uint8Array.with(S.to, S.string);
+// Encodes utf-8 string to Uint8Array
+S.string.with(S.to, S.uint8Array);
 ```
 
 ## Strings

packages/sury/scripts/pack/Pack.res

@@ -119,7 +119,6 @@ let filesMapping = [
   ("number", "S.float"),
   ("bigint", "S.bigint"),
   ("symbol", "S.symbol"),
-  ("json", "S.json"),
   ("never", "S.never"),
   ("unknown", "S.unknown"),
   ("any", "S.unknown"),
@@ -130,8 +129,13 @@ let filesMapping = [
   ("instance", "S.instance"),
   ("unnest", "S.unnest"),
   ("record", "S.dict"),
+  ("json", "S.json"),
+  ("enableJson", "S.enableJson"),
   ("jsonString", "S.jsonString"),
+  ("enableJsonString", "S.enableJsonString"),
   ("jsonStringWithSpace", "S.jsonStringWithSpace"),
+  ("uint8Array", "S.uint8Array"),
+  ("enableUint8Array", "S.enableUint8Array"),
   ("union", "S.js_union"),
   ("object", "S.object"),
   ("schema", "S.js_schema"),
@@ -174,8 +178,6 @@ let filesMapping = [
   ("pattern", "S.pattern"),
   ("datetime", "S.datetime"),
   ("trim", "S.trim"),
-  ("enableJson", "S.enableJson"),
-  ("enableJsonString", "S.enableJsonString"),
   ("global", "S.global"),
   ("brand", "S.brand"),
 ]

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

@@ -81,10 +81,6 @@ let filesMapping = [
     "symbol",
     "S.symbol"
   ],
-  [
-    "json",
-    "S.json"
-  ],
   [
     "never",
     "S.never"
@@ -125,14 +121,34 @@ let filesMapping = [
     "record",
     "S.dict"
   ],
+  [
+    "json",
+    "S.json"
+  ],
+  [
+    "enableJson",
+    "S.enableJson"
+  ],
   [
     "jsonString",
     "S.jsonString"
   ],
+  [
+    "enableJsonString",
+    "S.enableJsonString"
+  ],
   [
     "jsonStringWithSpace",
     "S.jsonStringWithSpace"
   ],
+  [
+    "uint8Array",
+    "S.uint8Array"
+  ],
+  [
+    "enableUint8Array",
+    "S.enableUint8Array"
+  ],
   [
     "union",
     "S.js_union"
@@ -301,14 +317,6 @@ let filesMapping = [
     "trim",
     "S.trim"
   ],
-  [
-    "enableJson",
-    "S.enableJson"
-  ],
-  [
-    "enableJsonString",
-    "S.enableJsonString"
-  ],
   [
     "global",
     "S.global"

packages/sury/src/S.d.ts

@@ -449,6 +449,9 @@ export const jsonString: Schema<string, string>;
 export const jsonStringWithSpace: (space: number) => Schema<string, string>;
 export function enableJsonString(): void;
 
+export const uint8Array: Schema<Uint8Array, Uint8Array>;
+export function enableUint8Array(): void;
+
 export function safe<Value>(scope: () => Value): Result<Value>;
 export function safeAsync<Value>(
   scope: () => Promise<Value>

packages/sury/src/S.js

@@ -8,7 +8,6 @@ export var int32 = S.int
 export var number = S.float
 export var bigint = S.bigint
 export var symbol = S.symbol
-export var json = S.json
 export var never = S.never
 export var unknown = S.unknown
 export var any = S.unknown
@@ -19,8 +18,13 @@ 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
@@ -63,7 +67,5 @@ export var url = S.url
 export var pattern = S.pattern
 export var datetime = S.datetime
 export var trim = S.trim
-export var enableJson = S.enableJson
-export var enableJsonString = S.enableJsonString
 export var global = S.global
 export var brand = S.brand

packages/sury/src/S.res.mjs

@@ -38,6 +38,10 @@ let jsonStringWithSpace = Sury.jsonStringWithSpace;
 
 let enableJsonString = Sury.enableJsonString;
 
+let uint8Array = Sury.uint8Array;
+
+let enableUint8Array = Sury.enableUint8Array;
+
 let literal = Sury.literal;
 
 let array = Sury.array;
@@ -201,6 +205,8 @@ export {
   jsonString,
   jsonStringWithSpace,
   enableJsonString,
+  uint8Array,
+  enableUint8Array,
   literal,
   array,
   unnest,

packages/sury/src/S.resi

@@ -301,6 +301,9 @@ let jsonString: t<string>
 let jsonStringWithSpace: int => t<string>
 let enableJsonString: unit => unit
 
+let uint8Array: t<Uint8Array.t>
+let enableUint8Array: unit => unit
+
 let literal: 'value => t<'value>
 let array: t<'value> => t<array<'value>>
 let unnest: t<'value> => t<array<'value>>

packages/sury/src/Sury.res

@@ -1891,13 +1891,12 @@ let rec parse = (prevB: b, ~schema, ~input as inputArg: val, ~path) => {
     }
   }
 
-  if isUnsupported.contents {
-    b->B.unsupportedTransform(~from=input.contents->Obj.magic, ~target=schema, ~path)
-  }
-
   switch schema.compiler {
   | Some(compiler) => input := compiler(b, ~input=input.contents, ~selfSchema=schema, ~path)
-  | None => ()
+  | None =>
+    if isUnsupported.contents {
+      b->B.unsupportedTransform(~from=input.contents->Obj.magic, ~target=schema, ~path)
+    }
   }
 
   if input.contents.skipTo !== Some(true) {
@@ -3720,6 +3719,45 @@ let jsonStringWithSpace = (space: int) => {
   mut->castToPublic
 }
 
+let uint8Array = shaken("uint8Array")
+
+let enableUint8Array = () => {
+  if uint8Array->Obj.magic->Js.Dict.unsafeGet(shakenRef)->Obj.magic {
+    let _ = %raw(`delete uint8Array.as`)
+    uint8Array.tag = Instance
+    uint8Array.class = %raw(`Uint8Array`)
+    uint8Array.compiler = Some(
+      Builder.make((b, ~input as inputArg, ~selfSchema, ~path as _) => {
+        let inputTagFlag = inputArg.tag->TagFlag.get
+        let input = ref(inputArg)
+
+        if inputTagFlag->Flag.unsafeHas(TagFlag.string) {
+          input :=
+            b->B.val(
+              `${b->B.embed(%raw(`new TextEncoder()`))}.encode(${input.contents.inline})`,
+              ~schema=uint8Array,
+            )
+        }
+
+        switch selfSchema {
+        | {to, parser: ?None} => {
+            let toTagFlag = to.tag->TagFlag.get
+            if toTagFlag->Flag.unsafeHas(TagFlag.string) {
+              input :=
+                b->B.val(
+                  `${b->B.embed(%raw(`new TextDecoder()`))}.decode(${input.contents.inline})`,
+                  ~schema=string,
+                )
+            }
+            input.contents
+          }
+        | _ => input.contents
+        }
+      }),
+    )
+  }
+}
+
 module Int = {
   module Refinement = {
     type kind =
@@ -6297,6 +6335,7 @@ let length = (schema, length, ~message as maybeMessage=?) => {
 let unknown: t<unknown> = unknown->castToPublic
 let json: t<Js.Json.t> = json->castToPublic
 let jsonString: t<string> = jsonString->castToPublic
+let uint8Array: t<Uint8Array.t> = uint8Array->castToPublic
 let bool: t<bool> = bool->castToPublic
 let symbol: t<Js.Types.symbol> = symbol->castToPublic
 let string: t<string> = string->castToPublic

packages/sury/src/Sury.res.mjs

@@ -1103,12 +1103,11 @@ function parse(prevB, schema, inputArg, path) {
     }
 
   }
-  if (isUnsupported) {
-    unsupportedTransform(b, input, schema, path);
-  }
   let compiler = schema.compiler;
   if (compiler !== undefined) {
     input = compiler(b, input, schema, path);
+  } else if (isUnsupported) {
+    unsupportedTransform(b, input, schema, path);
   }
   if (input.t !== true) {
     let refiner = schema.refiner;
@@ -2491,6 +2490,38 @@ function jsonStringWithSpace(space) {
   return mut;
 }
 
+let uint8Array = shaken("uint8Array");
+
+function enableUint8Array() {
+  if (uint8Array[shakenRef]) {
+    ((delete uint8Array.as));
+    uint8Array.type = "instance";
+    uint8Array.class = (Uint8Array);
+    uint8Array.compiler = (b, inputArg, selfSchema, param) => {
+      let inputTagFlag = flags[inputArg.type];
+      let input = inputArg;
+      if (inputTagFlag & 2) {
+        input = val(b, embed(b, (new TextEncoder())) + ".encode(" + input.i + ")", uint8Array);
+      }
+      let match = selfSchema.parser;
+      if (match !== undefined) {
+        return input;
+      }
+      let to = selfSchema.to;
+      if (to === undefined) {
+        return input;
+      }
+      let toTagFlag = flags[to.type];
+      if (toTagFlag & 2) {
+        input = val(b, embed(b, (new TextDecoder())) + ".decode(" + input.i + ")", string);
+      }
+      return input;
+    };
+    return;
+  }
+  
+}
+
 let metadataId$2 = "m:Int.refinements";
 
 function refinements$2(schema) {
@@ -4514,6 +4545,8 @@ export {
   jsonString,
   jsonStringWithSpace,
   enableJsonString,
+  uint8Array,
+  enableUint8Array,
   literal,
   array,
   unnest,