feat(website): remove unnecessary awaits + fix random + add title to …

…importing-external-modules
metatypedev · Apr 25, 2024 · faab2e4 · faab2e4
1 parent f31b451
commit faab2e4
Show file tree

Hide file tree

Showing 22 changed files with 62 additions and 23 deletions.
diff --git a/examples/typegraphs/faas-runner.ts b/examples/typegraphs/faas-runner.ts
@@ -5,7 +5,7 @@ import { PythonRuntime } from "@typegraph/sdk/runtimes/python.js";
 
 // skip:end
 
-await typegraph({
+typegraph({
   name: "faas-runner",
   // skip:next-line
   cors: { allowOrigin: ["https://metatype.dev", "http://localhost:3000"] },
@@ -20,7 +20,7 @@ await typegraph({
 
   g.expose({
     pycumsum: python.fromLambda(inp, out, {
-      code: `lambda inp: sum(range(inp["n"])`,
+      code: `lambda inp: sum(range(inp["n"]))`,
     }),
     tscumsum: deno.func(
       inp,

diff --git a/examples/typegraphs/iam-provider.ts b/examples/typegraphs/iam-provider.ts
@@ -14,7 +14,7 @@ function getEnvOrDefault(key: string, defaultValue: string) {
 }
 // skip:end
 
-await typegraph({
+typegraph({
   name: "iam-provider",
   // skip:next-line
   cors: { allowOrigin: ["https://metatype.dev", "http://localhost:3000"] },

diff --git a/examples/typegraphs/index.ts b/examples/typegraphs/index.ts
@@ -7,7 +7,7 @@ import { HttpRuntime } from "@typegraph/sdk/runtimes/http.js";
 
 // skip:end
 
-await typegraph({
+typegraph({
   name: "homepage",
   // skip:start
   rate: { windowLimit: 2000, windowSec: 60, queryLimit: 200, localExcess: 0 },

diff --git a/examples/typegraphs/jwt.ts b/examples/typegraphs/jwt.ts
@@ -5,7 +5,7 @@ import { DenoRuntime } from "@typegraph/sdk/runtimes/deno.js";
 
 // skip:end
 
-await typegraph({
+typegraph({
   name: "jwt-authentication",
   // skip:next-line
   cors: { allowOrigin: ["https://metatype.dev", "http://localhost:3000"] },

diff --git a/examples/typegraphs/math.ts b/examples/typegraphs/math.ts
@@ -3,7 +3,7 @@ import { Policy, t, typegraph } from "@typegraph/sdk/index.js";
 // skip:end
 import { DenoRuntime } from "@typegraph/sdk/runtimes/deno.js";
 
-await typegraph({
+typegraph({
   name: "math",
   // skip:start
   rate: { windowLimit: 2000, windowSec: 60, queryLimit: 200, localExcess: 0 },

diff --git a/examples/typegraphs/microservice-orchestration.ts b/examples/typegraphs/microservice-orchestration.ts
@@ -15,7 +15,7 @@ function getEnvOrDefault(key: string, defaultValue: string) {
 }
 // skip:end
 
-await typegraph({
+typegraph({
   name: "team-a",
   // skip:next-line
   cors: { allowOrigin: ["https://metatype.dev", "http://localhost:3000"] },

diff --git a/examples/typegraphs/oauth2.ts b/examples/typegraphs/oauth2.ts
@@ -5,7 +5,7 @@ import { DenoRuntime } from "@typegraph/sdk/runtimes/deno.js";
 
 // skip:end
 
-await typegraph({
+typegraph({
   name: "oauth2-authentication",
   // skip:next-line
   cors: { allowOrigin: ["https://metatype.dev", "http://localhost:3000"] },

diff --git a/examples/typegraphs/policies.ts b/examples/typegraphs/policies.ts
@@ -4,7 +4,7 @@ import { Auth } from "@typegraph/sdk/params.js";
 import { DenoRuntime } from "@typegraph/sdk/runtimes/deno.js";
 import { RandomRuntime } from "@typegraph/sdk/runtimes/random.js";
 
-await typegraph({
+typegraph({
   name: "policies",
   cors: { allowOrigin: ["https://metatype.dev", "http://localhost:3000"] },
 }, (g) => {

diff --git a/examples/typegraphs/prisma-runtime.ts b/examples/typegraphs/prisma-runtime.ts
@@ -5,7 +5,7 @@ import { PrismaRuntime } from "@typegraph/sdk/providers/prisma.js";
 
 // skip:end
 
-await typegraph({
+typegraph({
   name: "prisma-runtime",
   cors: {
     // skip:start

diff --git a/examples/typegraphs/prisma.ts b/examples/typegraphs/prisma.ts
@@ -1,7 +1,7 @@
 import { Policy, t, typegraph } from "@typegraph/sdk/index.js";
 import { PrismaRuntime } from "@typegraph/sdk/providers/prisma.js";
 
-await typegraph({
+typegraph({
   name: "roadmap-prisma",
   // skip:next-line
   cors: { allowOrigin: ["https://metatype.dev", "http://localhost:3000"] },

diff --git a/examples/typegraphs/programmable-api-gateway.ts b/examples/typegraphs/programmable-api-gateway.ts
@@ -5,7 +5,7 @@ import { DenoRuntime } from "@typegraph/sdk/runtimes/deno.js";
 
 // skip:end
 
-await typegraph({
+typegraph({
   name: "programmable-api-gateway",
   // skip:next-line
   cors: { allowOrigin: ["https://metatype.dev", "http://localhost:3000"] },

diff --git a/examples/typegraphs/quick-start-project.ts b/examples/typegraphs/quick-start-project.ts
@@ -3,7 +3,7 @@ import { DenoRuntime } from "@typegraph/sdk/runtimes/deno.js";
 import { PythonRuntime } from "@typegraph/sdk/runtimes/python.js";
 import { PrismaRuntime } from "@typegraph/sdk/providers/prisma.js";
 
-await typegraph("example", (g) => {
+typegraph("example", (g) => {
   // access control
   const pub = Policy.public();
 

diff --git a/examples/typegraphs/random-field.py b/examples/typegraphs/random-field.py
@@ -14,7 +14,7 @@
     name="random-field",
     # skip:end
 )
-def roadmap(g: Graph):
+def random_field(g: Graph):
     deno = DenoRuntime()
     pub = Policy.public()
 

diff --git a/examples/typegraphs/random-field.ts b/examples/typegraphs/random-field.ts
@@ -0,0 +1,37 @@
+// skip:start
+import { Policy, t, typegraph } from "@typegraph/sdk/index.js";
+import { DenoRuntime } from "@typegraph/sdk/runtimes/deno.js";
+
+// skip:end
+
+typegraph({
+  name: "random-field",
+  // skip:next-line
+  cors: { allowOrigin: ["https://metatype.dev", "http://localhost:3000"] },
+}, (g) => {
+    const deno = new DenoRuntime();
+    const pub = Policy.public()
+
+    const bonus = t.list(t.enum_(["+1 gold", "+1 metal"]))
+    const dailyBonus = t.struct(
+        {
+            performance: t.integer(),
+            bonus: bonus.fromRandom(),  // this field is now generated randomly
+        }
+    )
+
+    const seed = Date.now() % 1000;
+    g.configureRandomInjection({ seed })
+
+    g.expose({
+        get_bonus: deno.func(
+            dailyBonus,
+            t.string(),
+            {
+                code: ({ performance, bonus }) => `Daily bonus: ${
+                    (performance > 100 ? bonus : ['none']).join(', ')
+                }`
+            }
+        )
+    }, pub);
+});
diff --git a/examples/typegraphs/rate.ts b/examples/typegraphs/rate.ts
@@ -4,7 +4,7 @@ import { RandomRuntime } from "@typegraph/sdk/runtimes/random.js";
 
 // skip:end
 
-await typegraph({
+typegraph({
   name: "rate",
   // highlight-next-line
   rate: {

diff --git a/examples/typegraphs/reduce.ts b/examples/typegraphs/reduce.ts
@@ -3,7 +3,7 @@ import { Auth } from "@typegraph/sdk/params.js";
 import { PrismaRuntime } from "@typegraph/sdk/providers/prisma.js";
 import { DenoRuntime } from "@typegraph/sdk/runtimes/deno.js";
 
-await typegraph({
+typegraph({
   name: "roadmap-reduce",
   // skip:next-line
   cors: { allowOrigin: ["https://metatype.dev", "http://localhost:3000"] },

diff --git a/examples/typegraphs/rest.ts b/examples/typegraphs/rest.ts
@@ -3,7 +3,7 @@ import { Auth } from "@typegraph/sdk/params.js";
 import { PrismaRuntime } from "@typegraph/sdk/providers/prisma.js";
 import { DenoRuntime } from "@typegraph/sdk/runtimes/deno.js";
 
-await typegraph({
+typegraph({
   name: "roadmap-rest",
   // skip:next-line
   cors: { allowOrigin: ["https://metatype.dev", "http://localhost:3000"] },

diff --git a/examples/typegraphs/roadmap-policies.ts b/examples/typegraphs/roadmap-policies.ts
@@ -3,7 +3,7 @@ import { Auth } from "@typegraph/sdk/params.js";
 import { DenoRuntime } from "@typegraph/sdk/runtimes/deno.js";
 import { PrismaRuntime } from "@typegraph/sdk/providers/prisma.js";
 
-await typegraph({
+typegraph({
   name: "roadmap-policies",
   // skip:next-line
   cors: { allowOrigin: ["https://metatype.dev", "http://localhost:3000"] },

diff --git a/examples/typegraphs/roadmap-random.ts b/examples/typegraphs/roadmap-random.ts
@@ -4,7 +4,7 @@ import { RandomRuntime } from "@typegraph/sdk/runtimes/random.js";
 // skip:next-line
 /* eslint-disable  @typescript-eslint/no-unused-vars */
 
-await typegraph({
+typegraph({
   name: "roadmap-random",
   // skip:next-line
   cors: { allowOrigin: ["https://metatype.dev", "http://localhost:3000"] },

diff --git a/examples/typegraphs/triggers.ts b/examples/typegraphs/triggers.ts
@@ -4,7 +4,7 @@ import { HttpRuntime } from "@typegraph/sdk/runtimes/http.js";
 
 // skip:end
 
-await typegraph({
+typegraph({
   name: "triggers",
 }, (g) => {
   // skip:start

diff --git a/website/docs/guides/import-external-modules/index.mdx b/website/docs/guides/import-external-modules/index.mdx
@@ -4,7 +4,7 @@ import TGExample from "@site/src/components/TGExample";
 import CodeBlock from "@theme-original/CodeBlock";
 
 
-### Importing External Modules
+# Importing External Modules
 
 So far, the materializers we've looked at have been generated by helpers like the CRUD helpers from the Prisma runtime or the the Random runtime's `generate` helper.
 The `deno.policy` function we used for authoring policies was also based on function objects. 

diff --git a/website/docs/reference/runtimes/random/index.mdx b/website/docs/reference/runtimes/random/index.mdx
@@ -13,17 +13,19 @@ One use case is to use this runtime as way of testing, for example you can rapid
 The `seed` parameter ensures repeatability if set.
 
 <TGExample
-    typegraph="random"
     python={require("../../../../../examples/typegraphs/roadmap-random.py")}
-    tyepescript={require("!!code-loader!../../../../../examples/typegraphs/roadmap-random.ts")}
+    typescript={require("!!code-loader!../../../../../examples/typegraphs/roadmap-random.ts")}
+    typegraph="roadmap-random"
     query={require("./random.graphql")}
 />
 
 
+
 Another use case is to inject random values to a materializer input
 <TGExample
     typegraph="random-field"
     python={require("../../../../../examples/typegraphs/random-field.py")}
+    typescript={require("!!code-loader!../../../../../examples/typegraphs/random-field.ts")}
     query={require("./random-field.graphql")}
 />