chore: example for setters argument for @rest directive

Signed-off-by: asararatnakar <[email protected]>

Author: asararatnakar

transforms/README.md

@@ -10,3 +10,4 @@ For more on what `transforms` is and how it operates within the custom `@rest` d
 - [combineintostring](combineintostring) shows how a new field in the return type can be created by concatenating some other fields (like address parts into one address)
 - [jsonarrayToJsonobject](jsonarrayToJsonobject) shows how an array of data (say coords) can be converted into an object, `{"lat":, "lon",..}` so that it can be fed into some other system that requires data to be expressed that way
 - [jsonobjectToJsonarray](jsonobjectToJsonarray) shows how an object (typically where each key is an id of a record) can be converted into an array (e.g., `{"1":{"name": "john"}, "2": "jane"}` can be converted to `[{"id":"1", "name": "john"}, {"id":"2", name: "jane"}]`), so that it can then behave well for GraphQL processing.
+- [setters](setters) shows how to map a JSON response values to the fields of the GraphQL type.

transforms/jsonobjectToJsonarray/api.graphql

@@ -58,20 +58,10 @@ type Query {
       # StepZen takes care of calling jq for each element.
       transforms: [
         { pathpattern: ["<>*"], editor: "objectToArray" }
-        # you could comment this out if you want to try setters instead
         {
           pathpattern: ["[]*"]
           editor: "jq:.[]|{id:.name,fullName:.value.fullName,age:.value.age}"
         }
       ]
-
-      # for the second transformation, you can use setters. Uncomment the next line and comment the second pathpattern line above to see how it operates.
-      # In order to make this to work, change the return type from JSON to [Customer].
-
-      # setters: [
-      #   { field: "id", path: "name" }
-      #   { field: "fullName", path: "value.fullName" }
-      #   { field: "age", path: "value.age" }
-      # ]
     )
 }

transforms/setters/api.graphql

@@ -0,0 +1,34 @@
+# We first transform the JSON result object from REST API the Graphql structure 
+# and then map the JSON response to the fields corresponding to the GraphQL type.
+
+type Customer {
+  cId: ID
+  cName: String
+  cAddress: Address
+}
+type Address {
+  city: String
+  countryRegion: String
+  stateProvince: String
+  street: String
+  postalCode: String
+}
+
+type Query {
+  customer(id: ID): [Customer]
+    @rest(
+      endpoint: "https://json2api-customers-zlwadjbovq-uc.a.run.app/customers?q=id+eq+$id;"
+      # The jq expression  transform each element of the array.
+      # StepZen takes care of calling jq for each element.
+      transforms: [
+        {
+          pathpattern: []
+          editor: """
+          jq:.[]|{id,name,cAddress:{street, city, stateProvince, countryRegion}}
+          """
+        }
+      ]
+      # mapping from JSON response values to the fields of the GraphQL result.
+      setters: [{ field: "cId", path: "id" }, { field: "cName", path: "name" }]
+    )
+}

transforms/setters/index.graphql

@@ -0,0 +1,3 @@
+schema @sdl(files: ["api.graphql"]) {
+  query: Query
+}

transforms/setters/stepzen.config.json

@@ -0,0 +1,3 @@
+{
+  "endpoint": "api/miscellaneous"
+}

transforms/setters/tests/Test.js

@@ -0,0 +1,12 @@
+const {
+  deployAndRun,
+  getTestDescription,
+} = require("../../../tests/gqltest.js");
+
+testDescription = getTestDescription("snippets", __dirname);
+
+describe(testDescription, function () {
+  const tests = [
+  ]
+  return deployAndRun(__dirname, tests);
+});