@reventlessdev/reventless-core 3.0.0-alpha.238 → 3.0.0-alpha.240

package/tests/api/SuryToJsonSchemaTest.res

@@ -256,6 +256,49 @@ describe("SuryToJsonSchema:", () => {
       ))->toEqual((Some(true), None))
     })
 
+    // `@internal` drops the property rather than marking it. A marker is the
+    // right answer for a field that is on the surface and merely unwanted — that
+    // is `@hidden`, above. This one is not on the surface at all, so an entry
+    // here would describe a field the SDL does not declare, which is the
+    // mismatch that makes a generated list query name fields the server rejects.
+    testSync("drops a field listed in internal rather than annotating it", () => {
+      let schema = S.schema(s =>
+        {
+          "id": s.matches(S.string),
+          "eventCollector": s.matches(S.string),
+        }
+      )->S.castToUnknown
+      let schema' = schema->withSpec({...emptySpec, internal: ["eventCollector"]})
+      let json = SuryToJsonSchema.deriveObjectSchema(schema')
+      expect((
+        getPropertyOf(json, "eventCollector")->Option.isNone,
+        getPropertyOf(json, "id")->Option.isSome,
+      ))->toEqual((true, true))
+    })
+
+    // A dropped property must not be left behind in `required`, or a consumer
+    // building a form from the schema asks for a field it was never given.
+    testSync("keeps a dropped field out of required", () => {
+      let schema = S.schema(s =>
+        {
+          "id": s.matches(S.string),
+          "eventCollector": s.matches(S.string),
+        }
+      )->S.castToUnknown
+      let json =
+        schema
+        ->withSpec({...emptySpec, internal: ["eventCollector"]})
+        ->SuryToJsonSchema.deriveObjectSchema
+      expect(
+        json
+        ->JSON.Decode.object
+        ->Option.flatMap(o => o->Dict.get("required"))
+        ->Option.flatMap(JSON.Decode.array)
+        ->Option.getOr([])
+        ->Array.filterMap(JSON.Decode.string),
+      )->toEqual(["id"])
+    })
+
     testSync("emits x-reventless-summary on field listed in summary", () => {
       let schema = S.schema(s =>
         {
@@ -431,7 +474,7 @@ describe("SuryToJsonSchema:", () => {
       let schema' =
         schema->withSpec({
           ...emptySpec,
-          retired: Some({field: "archived", label: "Archived", showWhenFalse: true, values: None}),
+          retired: Some({field: "archived", label: "Archived", showWhenFalse: true, values: None, namedWhenRetired: false}),
         })
       let json = SuryToJsonSchema.deriveObjectSchema(schema')
       let retiredObj =
@@ -464,6 +507,7 @@ describe("SuryToJsonSchema:", () => {
           label: "",
           showWhenFalse: false,
           values: Some(values),
+          namedWhenRetired: false,
         }),
       })
       ->SuryToJsonSchema.deriveObjectSchema
@@ -522,7 +566,7 @@ describe("SuryToJsonSchema:", () => {
       let schema' =
         schema->withSpec({
           ...emptySpec,
-          retired: Some({field: "archived", label: "", showWhenFalse: false, values: None}),
+          retired: Some({field: "archived", label: "", showWhenFalse: false, values: None, namedWhenRetired: false}),
         })
       let json = SuryToJsonSchema.deriveObjectSchema(schema')
       let retiredObj = json->retiredOn("archived")
@@ -532,12 +576,38 @@ describe("SuryToJsonSchema:", () => {
       ))->toEqual((None, None))
     })
 
+    // The opt-in that lets a reference name a withheld row. Travels only when
+    // true, on the omit-the-default rule the keys around it follow: false is what
+    // every record said before it existed, and writing it would put a key on
+    // every retirement to report that nothing changed.
+    testSync("carries namedWhenRetired only when the record opted in", () => {
+      let build = (~named: bool) => {
+        let schema = S.schema(s => {"archived": s.matches(S.bool)})->S.castToUnknown
+        schema
+        ->withSpec({
+          ...emptySpec,
+          retired: Some({
+            field: "archived",
+            label: "",
+            showWhenFalse: false,
+            values: None,
+            namedWhenRetired: named,
+          }),
+        })
+        ->SuryToJsonSchema.deriveObjectSchema
+        ->retiredOn("archived")
+        ->Option.flatMap(r => getProperty(r, "namedWhenRetired"))
+        ->Option.flatMap(JSON.Decode.bool)
+      }
+      expect((build(~named=true), build(~named=false)))->toEqual((Some(true), None))
+    })
+
     testSync("omits the retired label when empty but always states showWhenFalse", () => {
       let schema = S.schema(s => {"deactivated": s.matches(S.bool)})->S.castToUnknown
       let schema' =
         schema->withSpec({
           ...emptySpec,
-          retired: Some({field: "deactivated", label: "", showWhenFalse: false, values: None}),
+          retired: Some({field: "deactivated", label: "", showWhenFalse: false, values: None, namedWhenRetired: false}),
         })
       let json = SuryToJsonSchema.deriveObjectSchema(schema')
       let retiredObj =