add examples

Signed-off-by: Nik Nasr <nik@restate.dev>

Author: nikrooz

.gitignore

@@ -3,3 +3,5 @@ dist
 *.tsbuildinfo
 .turbo
 .DS_Store
+.next
+.swc

packages/examples/workflow/next-env.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+import "./.next/types/routes.d.ts";
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.

packages/examples/workflow/next.config.ts

@@ -0,0 +1,8 @@
+import { withWorkflow } from "workflow/next";
+import type { NextConfig } from "next";
+
+const nextConfig: NextConfig = {
+  /* config options here */
+};
+
+export default withWorkflow(nextConfig);

packages/examples/workflow/package.json

@@ -19,20 +19,25 @@
     "test": "turbo run _test --filter={.}...",
     "_test": "vitest run",
     "build": "turbo run _build --filter={.}...",
-    "_build": "tsc --project tsconfig.build.json",
-    "dev": "tsx watch --tsconfig ./tsconfig.json ./src/index.ts",
+    "_build": "next build",
+    "dev": "next dev",
     "start": "turbo run _start --filter={.}...",
-    "_start": "node ./dist/index.js",
+    "_start": "next start --port 9080",
     "clean": "rm -rf dist *.tsbuildinfo .turbo",
     "check:types": "turbo run _check:types --filter={.}...",
     "_check:types": "tsc --noEmit --project tsconfig.build.json",
     "lint": "eslint ."
   },
   "dependencies": {
     "@restatedev/world": "workspace:*",
-    "workflow": "catalog:"
+    "workflow": "catalog:",
+    "next": "16.0.0"
+  },
+  "devDependencies": {
+    "typescript": "^5",
+    "@types/node": "^20",
+    "@types/react": "^19"
   },
-  "devDependencies": {},
   "peerDependencies": {
     "workflow": "catalog:"
   }

packages/examples/workflow/src/app/api/signup/route.ts

@@ -0,0 +1,14 @@
+import { start } from "workflow/api";
+import { handleUserSignup } from "../../../workflows/user-signup.js";
+import { NextResponse } from "next/server.js";
+
+export async function POST(request: Request) {
+  const { email } = (await request.json()) as { email: string };
+
+  // Executes asynchronously and doesn't block your app
+  await start(handleUserSignup, [email]);
+
+  return NextResponse.json({
+    message: "User signup workflow started",
+  });
+}

packages/examples/workflow/src/workflows/user-signup.ts

@@ -0,0 +1,48 @@
+/* eslint-disable @typescript-eslint/require-await */
+import { sleep } from "workflow";
+import { FatalError } from "workflow";
+
+export async function handleUserSignup(email: string) {
+  "use workflow";
+
+  const user = await createUser(email);
+  await sendWelcomeEmail(user);
+
+  await sleep("5s"); // Pause for 5s - doesn't consume any resources
+  await sendOnboardingEmail(user);
+
+  return { userId: user.id, status: "onboarded" };
+}
+
+// Our workflow function defined earlier
+
+async function createUser(email: string) {
+  "use step";
+
+  console.log(`Creating user with email: ${email}`);
+
+  // Full Node.js access - database calls, APIs, etc.
+  return { id: crypto.randomUUID(), email };
+}
+
+async function sendWelcomeEmail(user: { id: string; email: string }) {
+  "use step";
+
+  console.log(`Sending welcome email to user: ${user.id}`);
+
+  if (Math.random() < 0.3) {
+    // By default, steps will be retried for unhandled errors
+    throw new Error("Retryable!");
+  }
+}
+
+async function sendOnboardingEmail(user: { id: string; email: string }) {
+  "use step";
+
+  if (!user.email.includes("@")) {
+    // To skip retrying, throw a FatalError instead
+    throw new FatalError("Invalid Email");
+  }
+
+  console.log(`Sending onboarding email to user: ${user.id}`);
+}

packages/examples/workflow/tsconfig.json

@@ -1,7 +1,17 @@
 {
   "extends": "../../../tsconfig.json",
   "compilerOptions": {
-    "composite": false
+    "composite": false,
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ]
   },
-  "include": ["src/**/*"]
+  "include": [
+    "src/**/*",
+    ".next/types/**/*.ts",
+    "next-env.d.ts",
+    ".next/dev/types/**/*.ts"
+  ]
 }

packages/examples/workflow/vercel.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://openapi.vercel.sh/vercel.json",
+  "framework": "nextjs"
+}