S.null -> S.nullAsOption

Author: DZakh

IDEAS.md

@@ -16,6 +16,7 @@
   - Reworked error code and added `S.Error.classify` to turn error into a variant of all possible error codes
 - All errors thrown in transform/refine are wrapped in `SuryError`
 - TS: Updated `S.Error` type to use variants instead of code property
+- ReScript: `S.null` -> `S.nullAsOption`
 
 ### TS
 
@@ -40,6 +41,8 @@
 
 TODO:
 
+Test null<> in ppx
+
 ```
 // Test that refinement works correctly with reverse
 

docs/rescript-usage.md

@@ -20,6 +20,7 @@
   - [`Option.getOr`](#optiongetor)
   - [`Option.getOrWith`](#optiongetorwith)
   - [`null`](#null)
+  - [`nullAsOption`](#nullasoption)
   - [`nullable`](#nullable)
   - [`nullableAsOption`](#nullableasoption)
   - [`unit`](#unit)
@@ -403,20 +404,35 @@ Also you can use `Option.getOrWith` for lazy evaluation of the default value.
 
 ### **`null`**
 
-`S.t<'value> => S.t<option<'value>>`
+`S.t<'value> => S.t<null<'value>>`
 
 ```rescript
 let schema = S.null(S.string)
 
+"Hello World!"->S.parseOrThrow(schema)
+// Value("Hello World!")
+%raw(`null`)->S.parseOrThrow(schema)
+// Null
+```
+
+The `S.null` schema represents a data of a specific type that might be null.
+
+### **`nullAsOption`**
+
+`S.t<'value> => S.t<option<'value>>`
+
+```rescript
+let schema = S.nullAsOption(S.string)
+
 "Hello World!"->S.parseOrThrow(schema)
 // Some("Hello World!")
 %raw(`null`)->S.parseOrThrow(schema)
 // None
 ```
 
-The `S.null` schema represents a data of a specific type that might be null.
+The `S.nullAsOption` schema represents a data of a specific type that might be null.
 
-> 🧠 Since `S.null` transforms value into `option` type, you can use `Option.getOr`/`Option.getOrWith` for it as well.
+> 🧠 Since `S.nullAsOption` transforms value into `option` type, you can use `Option.getOr`/`Option.getOrWith` for it as well.
 
 ### **`nullable`**
 
@@ -907,7 +923,7 @@ The `S.list` schema represents an array of data of a specific type which is tran
 ```rescript
 let schema = S.unnest(S.schema(s => {
   id: s.matches(S.string),
-  name: s.matches(S.null(S.string)),
+  name: s.matches(S.nullAsOption(S.string)),
   deleted: s.matches(S.bool),
 }))
 
@@ -1366,7 +1382,7 @@ And you can configure compiled function `typeValidation` with the following opti
 `(S.t<'value>) => S.t<'value>`
 
 ```rescript
-S.null(S.string)->S.reverse
+S.nullAsOption(S.string)->S.reverse
 // S.option(S.string)
 ```
 

packages/e2e/src/ppx/Ppx_Example_test.res

@@ -68,13 +68,13 @@ test("@s.defaultWith", t => {
 @schema
 type null = @s.null option<string>
 test("@s.null", t => {
-  t->assertEqualSchemas(nullSchema, S.null(S.string))
+  t->assertEqualSchemas(nullSchema, S.nullAsOption(S.string))
 })
 
 @schema
 type nullWithDefault = @s.null @s.default("Unknown") string
 test("@s.null with @s.default", t => {
-  t->assertEqualSchemas(nullWithDefaultSchema, S.null(S.string)->S.Option.getOr("Unknown"))
+  t->assertEqualSchemas(nullWithDefaultSchema, S.nullAsOption(S.string)->S.Option.getOr("Unknown"))
 })
 
 @schema

packages/e2e/src/ppx/Ppx_General_test.res

@@ -46,7 +46,7 @@ type stringWithDefaultNullAndMatches = @s.default("Foo") @s.null @s.matches(S.st
 test("Creates schema with default null using @s.matches", t => {
   t->assertEqualSchemas(
     stringWithDefaultNullAndMatchesSchema,
-    S.null(S.string->S.url)->S.Option.getOr("Foo"),
+    S.nullAsOption(S.string->S.url)->S.Option.getOr("Foo"),
   )
 })
 

packages/e2e/src/ppx/Ppx_Primitive_test.res

@@ -153,7 +153,7 @@ test("Custom optional string schema", t => {
 // The incompatible parts: option<string> vs myNullOfString (defined as null<string>)
 // So use the code below instead
 @schema
-type myNullOfString = @s.matches(S.null(S.string)) option<string>
+type myNullOfString = @s.matches(S.nullAsOption(S.string)) option<string>
 test("Null of string schema", t => {
-  t->assertEqualSchemas(myNullOfStringSchema, S.null(S.string))
+  t->assertEqualSchemas(myNullOfStringSchema, S.nullAsOption(S.string))
 })

packages/e2e/src/ppx/Ppx_Record_test.res

@@ -64,13 +64,13 @@ test("Record schema with optional fields", t => {
 
 @schema
 type recordWithNullableField = {
-  subscription: @s.matches(S.option(S.null(S.string))) option<option<string>>,
+  subscription: @s.matches(S.option(S.nullAsOption(S.string))) option<option<string>>,
 }
 test("Record schema with nullable field", t => {
   t->assertEqualSchemas(
     recordWithNullableFieldSchema,
     S.schema(s => {
-      subscription: s.matches(S.option(S.null(S.string))),
+      subscription: s.matches(S.option(S.nullAsOption(S.string))),
     }),
   )
   t->Assert.deepEqual(

packages/sury-ppx/README.md

@@ -133,14 +133,14 @@ let schema = S.string->S.url
 
 **Applies to**: option type expressions
 
-Tells to use `S.null` for the option schema constructor.
+Tells to use `S.nullAsOption` for the option schema constructor.
 
 ```rescript
 @schema
 type t = @s.null option<string>
 
 // Generated by PPX ⬇️
-let schema = S.null(S.string)
+let schema = S.nullAsOption(S.string)
 ```
 
 ### `@s.nullable`
@@ -178,7 +178,7 @@ It might also be used together with `@s.null`:
 type t = @s.null @s.default("Unknown") string
 
 // Generated by PPX ⬇️
-let schema = S.null(S.string)->S.Option.getOr("Unknown")
+let schema = S.nullAsOption(S.string)->S.Option.getOr("Unknown")
 ```
 
 ### `@s.defaultWith(unit => 'value)`

packages/sury-ppx/src/ppx/Structure.ml

@@ -148,7 +148,7 @@ and generateCoreTypeSchemaExpression core_type =
         getAttributeByName ptyp_attributes "s.nullable" )
     with
     | Ok None, Ok None -> [%expr S.option]
-    | Ok (Some _), Ok None -> [%expr S.null]
+    | Ok (Some _), Ok None -> [%expr S.nullAsOption]
     | Ok None, Ok (Some _) -> [%expr S.nullableAsOption]
     | Ok (Some _), Ok (Some _) ->
       fail ptyp_loc

packages/sury/src/S.res.mjs

@@ -56,6 +56,8 @@ let option = Sury.option;
 
 let $$null = Sury.$$null;
 
+let nullAsOption = Sury.nullAsOption;
+
 let nullable = Sury.nullable;
 
 let nullableAsOption = Sury.nullableAsOption;
@@ -214,6 +216,7 @@ export {
   dict,
   option,
   $$null,
+  nullAsOption,
   nullable,
   nullableAsOption,
   union,

packages/sury/src/S.resi

@@ -313,8 +313,9 @@ let list: t<'value> => t<list<'value>>
 let instance: unknown => t<unknown>
 let dict: t<'value> => t<dict<'value>>
 let option: t<'value> => t<option<'value>>
-let null: t<'value> => t<option<'value>>
-let nullable: t<'value> => t<Js.nullable<'value>>
+let null: t<'value> => t<null<'value>>
+let nullAsOption: t<'value> => t<option<'value>>
+let nullable: t<'value> => t<nullable<'value>>
 let nullableAsOption: t<'value> => t<option<'value>>
 let union: array<t<'value>> => t<'value>
 let enum: array<'value> => t<'value>