Minor cleanups (#1)

Author: nikrooz

.gitignore

@@ -6,4 +6,5 @@ dist
 .next
 .swc
 .well-known
-.restate
+.restate
+restatedev-vercel-world*

package.json

@@ -30,7 +30,9 @@
     "generate:configs": "node scripts/generate-example-configs.mjs",
     "deps:check": "pnpm outdated",
     "deps:update": "pnpm update --latest --recursive",
-    "inspect": "pnpm --filter \"./packages/examples/*\" inspect"
+    "inspect": "pnpm --filter \"./packages/examples/*\" inspect",
+    "prepackage": "pnpm install && pnpm clean && pnpm build",
+    "package": "pnpm --filter \"./packages/libs/world\" pack"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.2",

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

@@ -1,6 +1,6 @@
 /// <reference types="next" />
 /// <reference types="next/image-types/global" />
-import "./.next/dev/types/routes.d.ts";
+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/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@restatedev/workflow",
   "version": "0.0.0",
-  "description": "TODO: Add description",
-  "author": "TODO: Add author",
-  "email": "TODO: Add email",
+  "description": "Example Next.js application demonstrating Vercel Workflow with Restate",
+  "author": "Restate Developers",
+  "email": "[email protected]",
   "license": "MIT",
-  "homepage": "TODO: Add homepage URL",
+  "homepage": "https://github.com/restatedev/vercel-workflow#readme",
   "repository": {
     "type": "git",
-    "url": "TODO: Add repository URL"
+    "url": "git+https://github.com/restatedev/vercel-workflow.git"
   },
   "bugs": {
-    "url": "TODO: Add bugs URL"
+    "url": "https://github.com/restatedev/vercel-workflow/issues"
   },
   "private": true,
   "type": "module",
@@ -23,14 +23,14 @@
     "dev": "next dev",
     "start": "turbo run _start --filter={.}...",
     "_start": "next start --port 3000",
-    "clean": "rm -rf dist *.tsbuildinfo .turbo",
+    "clean": "rm -rf dist *.tsbuildinfo .turbo .next .swc src/app/.well-known",
     "check:types": "turbo run _check:types --filter={.}...",
     "_check:types": "tsc --noEmit --project tsconfig.build.json",
     "lint": "eslint .",
     "inspect": "workflow inspect runs"
   },
   "dependencies": {
-    "@restatedev/world": "workspace:*",
+    "@restatedev/vercel-world": "workspace:*",
     "workflow": "catalog:",
     "next": "16.0.0"
   },

packages/examples/workflow/src/app/api/signup/[runId]/route.ts

@@ -9,22 +9,22 @@
  * TODO: Add repository URL
  */
 
-import { NextResponse } from "next/server.js";
+import { NextResponse, NextRequest } from "next/server.js";
 import { getRun } from "workflow/api";
 
 interface RouteParams {
-  params: {
+  params: Promise<{
     runId: string;
-  };
+  }>;
 }
 
-export async function GET(request: Request, { params }: RouteParams) {
+export async function GET(_request: NextRequest, { params }: RouteParams) {
   const { runId } = await params;
 
   const run = getRun(runId);
   const status = await run.status;
 
-  let res: unknown | undefined = undefined;
+  let res: unknown = undefined;
   if (status === "completed") {
     res = await run.returnValue;
   }

packages/examples/workflow/src/app/api/signup/[runId]/status/route.ts

@@ -9,24 +9,24 @@
  * TODO: Add repository URL
  */
 
-import { NextResponse } from "next/server.js";
+import { NextResponse, NextRequest } from "next/server.js";
 import { getRun } from "workflow/api";
 
-interface RouteParams {
-  params: {
+type RouteParams = {
+  params: Promise<{
     runId: string;
-  };
-}
+  }>;
+};
 
-export async function GET(request: Request, { params }: RouteParams) {
+export async function GET(_request: NextRequest, { params }: RouteParams) {
   const { runId } = await params;
   const run = getRun(runId);
-  return new NextResponse(run.getReadable({startIndex: 0}), {
+  return new NextResponse(run.getReadable({ startIndex: 0 }), {
     status: 200,
     headers: {
-      'Content-Type': 'text/event-stream',
-      'Cache-Control': 'no-cache',
-      'Connection': 'keep-alive',
-    }
-  })
+      "Content-Type": "text/event-stream",
+      "Cache-Control": "no-cache",
+      Connection: "keep-alive",
+    },
+  });
 }

packages/libs/backend/api-extractor.types.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../../api-extractor.base.json",
+  "mainEntryPointFilePath": "<projectFolder>/dist/types.d.ts",
+  "messages": {
+    "extractorMessageReporting": {
+      "ae-forgotten-export": {
+        "logLevel": "none"
+      }
+    }
+  }
+}

packages/libs/backend/package.json

@@ -1,17 +1,17 @@
 {
-  "name": "@restatedev/backend",
+  "name": "@restatedev/vercel-backend",
   "version": "0.0.0",
-  "description": "TODO: Add description",
-  "author": "TODO: Add author",
-  "email": "TODO: Add email",
+  "description": "Restate backend services and virtual objects for Vercel Workflow integration",
+  "author": "Restate Developers",
+  "email": "[email protected]",
   "license": "MIT",
-  "homepage": "TODO: Add homepage URL",
+  "homepage": "https://github.com/restatedev/vercel-workflow#readme",
   "repository": {
     "type": "git",
-    "url": "TODO: Add repository URL"
+    "url": "git+https://github.com/restatedev/vercel-workflow.git"
   },
   "bugs": {
-    "url": "TODO: Add bugs URL"
+    "url": "https://github.com/restatedev/vercel-workflow/issues"
   },
   "type": "module",
   "main": "./dist/index.cjs",
@@ -22,6 +22,14 @@
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },
+    "./serve": {
+      "import": "./dist/serve.js",
+      "require": "./dist/serve.cjs"
+    },
+    "./types": {
+      "import": "./dist/types.js",
+      "require": "./dist/types.cjs"
+    },
     "./package.json": "./package.json"
   },
   "files": [
@@ -37,15 +45,15 @@
     "build": "turbo run _build --filter={.}...",
     "_build": "tsc --noEmit && tsdown",
     "dev": "tsc --noEmit --watch",
-    "start": "node ./dist/index.js",
+    "start": "node ./dist/serve.js",
     "clean": "rm -rf dist *.tsbuildinfo .turbo",
     "check:types": "turbo run _check:types --filter={.}...",
     "_check:types": "tsc --noEmit --project tsconfig.build.json",
     "lint": "eslint .",
     "check:exports": "turbo run _check:exports --filter={.}...",
     "_check:exports": "attw --pack .",
     "check:api": "turbo run _check:api --filter={.}...",
-    "_check:api": "api-extractor run --local",
+    "_check:api": "api-extractor run --local && api-extractor run --local --config api-extractor.types.json",
     "prepublishOnly": "pnpm -w verify"
   },
   "dependencies": {
@@ -55,5 +63,15 @@
     "@restatedev/pubsub": "catalog:",
     "@vercel/queue": "catalog:",
     "@workflow/world": "catalog:"
+  },
+  "typesVersions": {
+    "*": {
+      "types": [
+        "./dist/types.d.ts"
+      ],
+      "serve": [
+        "./dist/serve.d.ts"
+      ]
+    }
   }
 }

packages/libs/backend/src/index.ts

@@ -1,12 +1,3 @@
-import { serve } from "@restatedev/restate-sdk";
-import { createPubsubObject } from "@restatedev/pubsub";
-import { index, keyValue, workflow } from "./services.js";
-import { queue } from "./queue.js";
-
-export type { WorkflowApi } from "./services.js";
-export type { IndexApi } from "./services.js";
-export type { QueueService } from "./queue.js";
-
-serve({
-  services: [workflow, index, queue, keyValue, createPubsubObject("streams")],
-});
+export { createPubsubObject } from "@restatedev/pubsub";
+export { index, keyValue, workflow, type State } from "./services.js";
+export { queue } from "./queue.js";

packages/libs/backend/src/serve.ts

@@ -0,0 +1,12 @@
+import { serve } from "@restatedev/restate-sdk";
+import {
+  workflow,
+  index,
+  queue,
+  keyValue,
+  createPubsubObject,
+} from "./index.js";
+
+void serve({
+  services: [workflow, index, queue, keyValue, createPubsubObject("streams")],
+});