Clean up after release

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "ocaml.sandbox": {
+    "kind": "opam",
+    "switch": "struct"
+  }
+}

CHANGELOG_NEXT.md

@@ -1,16 +1,4 @@
-## v5.1
-
-- Fixed ts type for S.literal to work with litterally any value
-- Added S.undefined to js api
-- Added advanced object struct to js api
-- Added advanced tuple struct to js api
-- Added a proper documentation for JS/TS users
-- Added table of contents and splitted documentation into multiple documents
-- Improved tree-shaking. For the JS/TS api example bundle-size reduced by 13% - 2 kB (0.55 kB minified + gzipped)
-- Added `S.Error.reason`
-- Added alpha version of `S.merge` helper (JS/TS api only)
-- Added `S.name`/`S.setName` for JS/TS api
-- Documented `S.classify`/`S.name`/`S.setName`
+## v5.2
 
 ## Opt-in ppx support
 

IDEAS.md

@@ -30,7 +30,7 @@ let trimContract: S.contract<string => string> = S.contract(s => {
 
 - Move S.inline to a separate codegen module
 
-## v5.1
+## v5.2
 
 - ppx
 - stop reallocate objects without transformations

docs/js-usage.md

@@ -370,7 +370,7 @@ type Athlete = S.Output<typeof athleteStruct>;
 // }
 ```
 
-That looks much better than before. And the same as for advanced objects, you can use the same struct for transforming the parsed data back to the initial format. Also, it has 0 performance overhead and as fast as parsing tuples without the transformation.
+That looks much better than before. And the same as for advanced objects, you can use the same struct for transforming the parsed data back to the initial format. Also, it has 0 performance overhead and is as fast as parsing tuples without the transformation.
 
 ## Unions
 

packages/ppx/src/ppx/records.ml

@@ -3,47 +3,42 @@ open Parsetree
 open Ast_helper
 open Utils
 
-(* TODO: Support recursive types *)
-(* TODO: Move default from here *)
-(* TODO: check optional *)
-
-type parsed_decl = {
+type field = {
   name : string;
-  (* "NAME" *)
-  key : expression;
-  (* v.NAME *)
-  field : expression;
+  maybe_alias : expression option;
   struct_expr : expression;
-  default : expression option;
-  is_optional : bool;
 }
 
-let generate_decoder decls =
+let generate_decoder fields =
   (* Use Obj.magic to cast to uncurried function in case of uncurried mode *)
   [%expr
     S.Object.factory
       (Obj.magic (fun (s : S.Object.ctx) ->
            [%e
              Exp.record
-               (decls
-               |> List.map (fun decl ->
-                      ( lid decl.name,
-                        [%expr s.field [%e decl.key] [%e decl.struct_expr]] )))
+               (fields
+               |> List.map (fun field ->
+                      let original_field_name_expr =
+                        match field.maybe_alias with
+                        | Some alias -> alias
+                        | None ->
+                            Exp.constant
+                              (Pconst_string (field.name, Location.none, None))
+                      in
+
+                      ( lid field.name,
+                        [%expr
+                          s.field [%e original_field_name_expr]
+                            [%e field.struct_expr]] )))
                None]))]
 
 let parse_decl { pld_name = { txt }; pld_loc; pld_type; pld_attributes } =
-  let default =
-    match get_attribute_by_name pld_attributes "struct.default" with
+  let maybe_alias =
+    match get_attribute_by_name pld_attributes "as" with
     | Ok (Some attribute) -> Some (get_expr_from_payload attribute)
     | Ok None -> None
     | Error s -> fail pld_loc s
   in
-  let key =
-    match get_attribute_by_name pld_attributes "struct.field" with
-    | Ok (Some attribute) -> get_expr_from_payload attribute
-    | Ok None -> Exp.constant (Pconst_string (txt, Location.none, None))
-    | Error s -> fail pld_loc s
-  in
   let optional_attrs = [ "ns.optional"; "res.optional" ] in
   let is_optional =
     optional_attrs
@@ -56,15 +51,8 @@ let parse_decl { pld_name = { txt }; pld_loc; pld_type; pld_attributes } =
     else struct_expr
   in
 
-  {
-    name = txt;
-    key;
-    field = Exp.field [%expr v] (lid txt);
-    struct_expr;
-    default;
-    is_optional;
-  }
+  { name = txt; maybe_alias; struct_expr }
 
 let generate_struct_expr decls =
-  let parsed_decls = List.map parse_decl decls in
-  generate_decoder parsed_decls
+  let fields = List.map parse_decl decls in
+  generate_decoder fields

packages/tests/src/ppx/Ppx_Example_test.bs.mjs

@@ -0,0 +1,45 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as U from "../utils/U.bs.mjs";
+import Ava from "ava";
+import * as S$RescriptStruct from "rescript-struct/src/S.bs.mjs";
+
+var ratingStruct = S$RescriptStruct.union([
+      S$RescriptStruct.literal("G"),
+      S$RescriptStruct.literal("PG"),
+      S$RescriptStruct.literal("PG13"),
+      S$RescriptStruct.literal("R")
+    ]);
+
+var filmStruct = S$RescriptStruct.$$Object.factory(function (s) {
+      return {
+              Id: s.f("Id", S$RescriptStruct.$$float),
+              Title: s.f("Title", S$RescriptStruct.string),
+              Tags: s.f("Tags", S$RescriptStruct.$$Option.getOr(S$RescriptStruct.option(S$RescriptStruct.array(S$RescriptStruct.string)), [])),
+              Rating: s.f("Rating", ratingStruct),
+              Age: s.f("Age", S$RescriptStruct.deprecate(S$RescriptStruct.option(S$RescriptStruct.$$int), "Use rating instead"))
+            };
+    });
+
+Ava("Example", (function (t) {
+        U.assertEqualStructs(t, filmStruct, S$RescriptStruct.object(function (s) {
+                  return {
+                          Id: s.f("Id", S$RescriptStruct.$$float),
+                          Title: s.f("Title", S$RescriptStruct.string),
+                          Tags: s.o("Tags", S$RescriptStruct.array(S$RescriptStruct.string), []),
+                          Rating: s.f("Rating", S$RescriptStruct.union([
+                                    S$RescriptStruct.literal("G"),
+                                    S$RescriptStruct.literal("PG"),
+                                    S$RescriptStruct.literal("PG13"),
+                                    S$RescriptStruct.literal("R")
+                                  ])),
+                          Age: s.f("Age", S$RescriptStruct.deprecate(S$RescriptStruct.option(S$RescriptStruct.$$int), "Use rating instead"))
+                        };
+                }), undefined);
+      }));
+
+export {
+  ratingStruct ,
+  filmStruct ,
+}
+/* ratingStruct Not a pure module */

packages/tests/src/ppx/Ppx_Example_test.res

@@ -0,0 +1,43 @@
+open Ava
+open U
+
+@struct
+type rating =
+  | @as("G") GeneralAudiences
+  | @as("PG") ParentalGuidanceSuggested
+  | @as("PG13") ParentalStronglyCautioned
+  | @as("R") Restricted
+@struct
+type film = {
+  @as("Id")
+  id: float,
+  @as("Title")
+  title: string,
+  @as("Tags")
+  tags: @struct(S.array(S.string)->S.option->S.Option.getOr([])) array<string>,
+  @as("Rating")
+  rating: rating,
+  @as("Age")
+  deprecatedAgeRestriction: @struct(S.int->S.option->S.deprecate("Use rating instead")) option<int>,
+}
+
+test("Example", t => {
+  t->assertEqualStructs(
+    filmStruct,
+    S.object(s => {
+      id: s.field("Id", S.float),
+      title: s.field("Title", S.string),
+      tags: s.fieldOr("Tags", S.array(S.string), []),
+      rating: s.field(
+        "Rating",
+        S.union([
+          S.literal(GeneralAudiences),
+          S.literal(ParentalGuidanceSuggested),
+          S.literal(ParentalStronglyCautioned),
+          S.literal(Restricted),
+        ]),
+      ),
+      deprecatedAgeRestriction: s.field("Age", S.option(S.int)->S.deprecate("Use rating instead")),
+    }),
+  )
+})

packages/tests/src/ppx/Ppx_Records_test.bs.mjs

@@ -29,22 +29,22 @@ Ava("Simple record struct", (function (t) {
 
 var recordWithAliasStruct = S$RescriptStruct.$$Object.factory(function (s) {
       return {
-              label: s.f("aliased-label", S$RescriptStruct.string),
+              "aliased-label": s.f("aliased-label", S$RescriptStruct.string),
               value: s.f("value", S$RescriptStruct.$$int)
             };
     });
 
 Ava("Record struct with alias for field name", (function (t) {
         U.assertEqualStructs(t, recordWithAliasStruct, S$RescriptStruct.object(function (s) {
                   return {
-                          label: s.f("aliased-label", S$RescriptStruct.string),
+                          "aliased-label": s.f("aliased-label", S$RescriptStruct.string),
                           value: s.f("value", S$RescriptStruct.$$int)
                         };
                 }), undefined);
         t.deepEqual(S$RescriptStruct.parseWith({"aliased-label":"foo",value:1}, recordWithAliasStruct), {
               TAG: "Ok",
               _0: {
-                label: "foo",
+                "aliased-label": "foo",
                 value: 1
               }
             }, undefined);

packages/tests/src/ppx/Ppx_Records_test.res

@@ -23,7 +23,7 @@ test("Simple record struct", t => {
 
 @struct
 type recordWithAlias = {
-  @struct.field("aliased-label") label: string,
+  @as("aliased-label") label: string,
   value: int,
 }
 test("Record struct with alias for field name", t => {