split the basic example into basic and with-UDF

zvictor · Apr 15, 2020 · 947ff0a · 947ff0a
1 parent bbf2ce5
commit 947ff0a
Show file tree

Hide file tree

Showing 10 changed files with 46 additions and 7 deletions.
diff --git a/examples/basic/index.ts b/examples/basic/index.ts
@@ -5,8 +5,6 @@ const sdk = faugra()
 const random = () => Math.random().toString(36).substring(7)
 
 async function main() {
-  log(await sdk.sayHello({ name: 'dimension C-137' }))
-
   log(await sdk.createUser({ username: `rick-sanchez-${random()}` }))
   log(await sdk.createUser({ username: `morty-smith-${random()}` }))
 
@@ -21,7 +19,6 @@ main()
 
 // Expected output of this script:
 
-// { sayHello: 'Hello dimension C-137' }
 // { createUser: { _id: '262820989366174226' } }
 // { createUser: { _id: '262820990060331538' } }
 // { username: 'rick-sanchez' }

diff --git a/examples/basic/queries.gql b/examples/basic/queries.gql
@@ -11,7 +11,3 @@ query allUsers {
     }
   }
 }
-
-query sayHello($name: String!) {
-  sayHello(name: $name)
-}
diff --git a/examples/with-UDF/.gitignore b/examples/with-UDF/.gitignore
@@ -0,0 +1,3 @@
+*.d.ts
+faugra.sdk.ts
+package-lock.json
diff --git a/examples/with-UDF/README.md b/examples/with-UDF/README.md
@@ -0,0 +1,13 @@
+This example contains:
+
+- a User-Defined Function (UDF) [sayHello.fql]
+- a Graphql schema [Schema.graphql]
+- a Graphql operations document [queries.gql]
+
+By running `npx faugra --secret <MY_FAUNA_SECRET>` you should expect to see:
+
+- The UDF uploaded to the cloud
+- a TypeScript typings file generated per schema [Schema.d.ts]
+- a requests sdk containing all the operations, fully typed and with auto-complete support [faugra.sdk.ts]
+
+Once your `faugra.sdk.ts` has been generated, you can run `FAUGRA_SECRET=<MY_FAUNA_SECRET> npm start` to see the operations demo.
diff --git a/examples/with-UDF/Schema.graphql b/examples/with-UDF/Schema.graphql
@@ -0,0 +1,3 @@
+type Query {
+  sayHello(name: String!): String! @resolver(name: "sayHello")
+}
diff --git a/examples/with-UDF/index.ts b/examples/with-UDF/index.ts
@@ -0,0 +1,7 @@
+import faugra from './faugra.sdk'
+
+faugra().sayHello({ name: 'dimension C-137' }).then(console.log)
+
+// Expected output of this script:
+
+// { sayHello: 'Hello dimension C-137' }
diff --git a/examples/with-UDF/package.json b/examples/with-UDF/package.json
@@ -0,0 +1,16 @@
+{
+  "name": "faugra-example",
+  "version": "1.0.0",
+  "scripts": {
+    "start": "npx ts-node index.ts"
+  },
+  "dependencies": {
+    "faugra": "../..",
+    "graphql-request": "^1.8.2"
+  },
+  "devDependencies": {
+    "@types/node": "^12.12.2",
+    "ts-node": "^8.8.2",
+    "typescript": "^3.8.3"
+  }
+}
diff --git a/examples/with-UDF/queries.gql b/examples/with-UDF/queries.gql
@@ -0,0 +1,3 @@
+query sayHello($name: String!) {
+  sayHello(name: $name)
+}
diff --git a/examples/basic/sayHello.fql → examples/with-UDF/sayHello.fql b/examples/basic/sayHello.fql → examples/with-UDF/sayHello.fql
diff --git a/examples/with-user-defined-functions b/examples/with-user-defined-functions
@@ -0,0 +1 @@
+with-UDF
-Original file line number
+Diff line change
@@ Expand Up / @@ -11,7 +11,3 @@ query allUsers { @@
         }
       }
     }
-    query sayHello($name: String!) {
-      sayHello(name: $name)
-    }