@kaiko.io/rescript-deser 3.0.0 → 3.1.0

package/README.md

@@ -60,6 +60,8 @@ module type Serializable = {
 
 - `String`, parses a JSON string into a ReScript `string`.
 
+- `Literal(expected)`, parses a JSON string that must match the expected value.
+
 - `Int`, parses a JSON number into a ReScript `int`
 
 - `Float`, parses a JSON number into a ReScript `float`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaiko.io/rescript-deser",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "keywords": [
     "json",
     "deserializer",

package/src/JSON.res

@@ -34,6 +34,7 @@ module Field = {
   type rec t =
     | Any
     | String
+    | Literal(string)
     | Int
     | Float
     | Boolean
@@ -102,6 +103,7 @@ module Field = {
     switch type_ {
     | Any => "Any"
     | String => "String"
+    | Literal(lit) => `Literal: ${lit}`
     | Int => "Integer"
     | Float => "Float"
     | Boolean => "Boolean"
@@ -165,6 +167,12 @@ module Field = {
   and fromUntagged = (untagged: Js.Json.t, shape: t, self: t): FieldValue.t => {
     switch (shape, untagged->Js.Json.classify) {
     | (Any, _) => untagged->FieldValue.any
+    | (Literal(expected), Js.Json.JSONString(text)) =>
+      if text == expected {
+        FieldValue.string(text)
+      } else {
+        raise(TypeError(`Expecting literal ${expected}, got ${text}`))
+      }
     | (String, Js.Json.JSONString(text)) => FieldValue.string(text)
     | (Int, Js.Json.JSONNumber(number)) => FieldValue.int(number->Float.toInt)
     | (Float, Js.Json.JSONNumber(number)) => FieldValue.float(number)
@@ -262,7 +270,7 @@ module Field = {
     | (Self, true) => Ok()
 
     | (Any, _) => Ok()
-    | (String, _) | (Float, _) | (Int, _) => Ok()
+    | (String, _) | (Float, _) | (Int, _) | (Literal(_), _) => Ok()
     | (Boolean, _) | (Date, _) | (Datetime, _) => Ok()
     | (Morphism(_, _), _) => Ok()