@dbos-inc/create 1.30.21-preview.g838bed7f8d → 1.31.5-preview

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbos-inc/create",
-  "version": "1.30.21-preview.g838bed7f8d",
+  "version": "1.31.5-preview",
   "description": "Tool for performing project initialization from template",
   "license": "MIT",
   "type": "module",

package/templates/hello/README.md

@@ -37,7 +37,7 @@ npm run build
 Then, run a schema migration to create some tables:
 
 ```bash
-npx dbos-sdk migrate
+npx dbos migrate
 ```
 
 If successful, the migration should print `Migration successful!`.
@@ -45,7 +45,7 @@ If successful, the migration should print `Migration successful!`.
 Finally, run the app:
 
 ```bash
-npx dbos-sdk start
+npx dbos start
 ```
 
 ## The application

package/templates/hello-drizzle/README.md

@@ -23,7 +23,7 @@ npm run build
 Then, run a schema migration to create some tables:
 
 ```bash
-npx dbos-sdk migrate
+npx dbos migrate
 ```
 
 If successful, the migration should print `Migration successful!`.
@@ -31,7 +31,7 @@ If successful, the migration should print `Migration successful!`.
 Finally, run the app:
 
 ```bash
-npx dbos-sdk start
+npx dbos start
 ```
 
 To see that it's working, visit this URL in your browser: [`http://localhost:3000/greeting/dbos`](http://localhost:3000/greeting/dbos).

package/templates/hello-express/README.md

@@ -37,7 +37,7 @@ npm run build
 Then, run a schema migration to create some tables:
 
 ```bash
-npx dbos-sdk migrate
+npx dbos migrate
 ```
 
 If successful, the migration should print `Migration successful!`.
@@ -45,15 +45,17 @@ If successful, the migration should print `Migration successful!`.
 Finally, run the app:
 
 ```bash
-npx dbos-sdk start
+npx dbos start
 ```
 
 ## The application
 
-- In `src/operations.ts`, the Express app object is created and configured to serve an "hello world" DBOS workflow on `/greetings/:user`. This file also hosts the code of said DBOS workflow: an `Hello` class with a single `helloTransaction` method.
-- `src/main.ts` declares the code to start a DBOS instance and an Express application. When you pass the Express app object as parameter to `DBOS.launch()`, DBOS will wrap all routes with an [OpenTelemetry](https://opentelemetry.io/) tracing middleware and tie HTTP traces to DBOS workflow traces.
+In `src/main.ts`, the Express app object is created and configured to serve an "hello world" DBOS workflow on `/greetings/:user`. This file also hosts the code of said DBOS workflow: an `Hello` class with a single `helloTransaction` method.
 
-To add more functionality to this application, modify `src/operations.ts`. If you used `npm run dev`, it will automatically rebuild and restart.
+
+Then the `main()` function declares the code to start a DBOS instance and an Express application. When you pass the Express app object as parameter to `DBOS.launch()`, DBOS will wrap all routes with an [OpenTelemetry](https://opentelemetry.io/) tracing middleware and tie HTTP traces to DBOS workflow traces.
+
+To add more functionality to this application, modify `src/main.ts`. If you used `npm run dev`, it will automatically rebuild and restart.
 
 ## Running in DBOS Cloud
 

package/templates/hello-express/dbos-config.yaml

@@ -17,4 +17,4 @@ database:
     - npx knex migrate:rollback
 runtimeConfig:
   start:
-    - dist/main.js
+    - node dist/main.js

package/templates/hello-express/src/main.test.ts

@@ -1,5 +1,5 @@
 import { DBOS } from "@dbos-inc/dbos-sdk";
-import { app, dbos_hello, Hello } from "./operations";
+import { app, dbos_hello, Hello } from "./main";
 import request from "supertest";
 
 describe("operations-test", () => {

package/templates/hello-express/src/main.ts

@@ -1,6 +1,86 @@
-import { app } from './operations';
-import { DBOS } from '@dbos-inc/dbos-sdk';
+// Welcome to DBOS!
 
+// This is a sample "Hello" app built with DBOS, Express.js, and Knex.
+// It greets visitors and keeps track of how many times each visitor has been greeted.
+
+// First let's import express and DBOS
+import express from "express";
+import { DBOS } from "@dbos-inc/dbos-sdk";
+
+// Then, let's declare a type representing the "dbos_hello" database table
+export interface dbos_hello {
+  name: string;
+  greet_count: number;
+}
+
+// Now let's define a class with some static functions.
+// DBOS uses TypeScript decorators to automatically make your functions reliable, so they need to be static.
+export class Hello {
+  // This function greets a user and increments the greet count in the database.
+  // The @DBOS.transaction() decorator ensures that this function runs as a database transaction.
+  @DBOS.transaction()
+  static async helloTransaction(user: string) {
+    const query = "INSERT INTO dbos_hello (name, greet_count) VALUES (?, 1) ON CONFLICT (name) DO UPDATE SET greet_count = dbos_hello.greet_count + 1 RETURNING greet_count;";
+    const { rows } = (await DBOS.knexClient.raw(query, [user])) as { rows: dbos_hello[] };
+    const greet_count = rows[0].greet_count;
+    const greeting = `Hello, ${user}! You have been greeted ${greet_count} times.`;
+    return Hello.makeHTML(greeting);
+  }
+
+  // Finally, we will declare helper functions to serve static HTML to user.s
+
+  static async readme() {
+    const message = Hello.makeHTML(
+      `Visit the route <code class="bg-gray-100 px-1 rounded">/greeting/{name}</code> to be greeted!<br>
+      For example, visit <code class="bg-gray-100 px-1 rounded"><a href="/greeting/Mike" class="text-blue-600 hover:underline">/greeting/Mike</a></code><br>
+      The counter increments with each page visit.`
+    );
+    return Promise.resolve(message);
+  }
+
+  // A helper function to create HTML pages with some styling
+  static makeHTML(message: string) {
+    const page = `
+      <!DOCTYPE html>
+      <html lang="en">
+      <head>
+          <title>DBOS Template App</title>
+          <script src="https://cdn.tailwindcss.com"></script>
+      </head>
+      <body class="font-sans text-gray-800 p-6 max-w-2xl mx-auto">
+          <h1 class="text-3xl font-semibold mb-4">Welcome to DBOS!</h1>
+          <p class="mt-8 mb-8">` + message + `</p>
+          <p class="mb-2">
+              To learn how to run this app yourself, visit our
+              <a href="https://docs.dbos.dev/quickstart?language=typescript" class="text-blue-600 hover:underline">Quickstart</a>.
+          </p><p class="mb-2">
+              Then, to learn how to build crashproof apps, continue to our
+              <a href="https://docs.dbos.dev/typescript/programming-guide" class="text-blue-600 hover:underline">Programming Guide</a>.<br>
+          </p>
+      </body>
+      </html>`;
+    return page;
+  }
+}
+
+// Now, let's create an Express app and define some routes.
+export const app = express();
+// Parse JSON payloads and make it available to req.body
+app.use(express.json());
+
+// We'll serve the README at the root of the app
+app.get("/", async (_, res) => {
+  res.send(await Hello.readme());
+});
+
+// Serve this function from HTTP GET requests at the /greeting endpoint with 'user' as a path parameter
+// The handler will in turn call a reliable DBOS operation (helloTransaction) to greet the user
+app.get("/greeting/:user", async (req, res) => {
+  const { user } = req.params;
+  res.send(await Hello.helloTransaction(user));
+});
+
+// Finally, let's start the server
 async function main() {
   await DBOS.launch({expressApp: app});
 
@@ -13,4 +93,7 @@ async function main() {
   });
 }
 
-main().catch(console.log);
+// Only start the server when this file is run directly from Node
+if (require.main === module) {
+  main().catch(console.log);
+}

package/templates/hello-nextjs/README.md

@@ -0,0 +1,91 @@
+# DBOS Hello
+
+This is a [DBOS app](https://docs.dbos.dev/) bootstrapped with `npx @dbos-inc/create`, using [Express.js](https://expressjs.com/) and [Knex](https://docs.dbos.dev/tutorials/using-knex) to interact with postgres.
+
+## Getting Started
+
+Before you can launch your app, you need a database.
+DBOS works with any Postgres database, but to make things easier, we've provided a script that starts a Docker Postgres container and creates a database.
+Run:
+
+```bash
+node start_postgres_docker.js
+```
+
+If successful, the script should print `Database started successfully!`.
+
+```
+
+## Production build
+
+In production, instead of using `nodemon`, the following separate steps should be used to build, run database setup, and start the app.
+
+```bash
+npm run build
+```
+
+Then, run a schema migration to create some tables:
+
+```bash
+npx dbos migrate
+```
+
+If successful, the migration should print `Migration successful!`.
+
+Finally, run the app:
+
+```bash
+npm run start
+```
+
+To see that it's working, visit this URL in your browser: [`http://localhost:3000/`](http://localhost:3000/).
+
+Click on the "Run DBOS Workflow" button.
+
+You should get this message: `Hello, dbos! You have been greeted 1 times.`
+Each time you refresh the page, the counter should go up by one!
+
+Congratulations! You just launched a DBOS application.
+
+## The application
+
+- In `src/action/dbosWorkflow.tsx`, the DBOS workflow is created. When called, it increments a counter in the database and returns a greeting.
+
+- The code below in the same file, launches the dbos runtime. This is required for DBOS runtime to start. Do not remove the code
+```
+if (process.env.NEXT_PHASE !== "phase-production-build") {
+    await DBOS.launch();
+}
+```
+- The workflow is called by the POST method in app/greetings/route.ts.
+
+- The POST is called by the component in src/components/callDBOSWorkflow.tsx. It calls the route /greetings.
+
+- The component is called from the main UI page.tsx.
+
+- This is how the DBOS workflow is wired to the NextJs application.
+
+
+ DBOS will wrap all routes with an [OpenTelemetry](https://opentelemetry.io/) tracing middleware and tie HTTP traces to DBOS workflow traces.
+
+To add more functionality to this application, modify `src/operations.ts`. If you used `npm run dev`, it will automatically rebuild and restart.
+
+## Running in DBOS Cloud
+
+To deploy this app to DBOS Cloud, first install the DBOS Cloud CLI (example with [npm](https://www.npmjs.com/)):
+
+```shell
+npm i -g @dbos-inc/dbos-cloud
+```
+
+Then, run this command to deploy your app:
+
+```shell
+dbos-cloud app deploy
+```
+
+## Next Steps
+
+- For a detailed tutorial, check out our [programming quickstart](https://docs.dbos.dev/getting-started/quickstart-programming).
+- To learn more about DBOS, take a look at [our documentation](https://docs.dbos.dev/) or our [source code](https://github.com/dbos-inc/dbos-transact).
+

package/templates/hello-nextjs/dbos-config.yaml

@@ -0,0 +1,18 @@
+# To enable auto-completion and validation for this file in VSCode, install the RedHat YAML extension
+# https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml
+
+# yaml-language-server: $schema=https://raw.githubusercontent.com/dbos-inc/dbos-transact/main/dbos-config.schema.json
+
+language: node
+database:
+  hostname: localhost
+  port: 5432
+  username: postgres
+  password: ${PGPASSWORD}
+  connectionTimeoutMillis: 3000
+  app_db_client: knex
+  migrate:
+    - npx knex migrate:latest
+runtimeConfig:
+  start: 
+    - "npm run start"

package/templates/hello-nextjs/eslint.config.mjs

@@ -0,0 +1,16 @@
+import { dirname } from "path";
+import { fileURLToPath } from "url";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+});
+
+const eslintConfig = [
+  ...compat.extends("next/core-web-vitals", "next/typescript"),
+];
+
+export default eslintConfig;

package/templates/hello-nextjs/gitignore.template

@@ -0,0 +1,41 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# env files (can opt-in for committing if needed)
+.env*
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

package/templates/hello-nextjs/knexfile.js

@@ -0,0 +1,20 @@
+const { parseConfigFile } = require('@dbos-inc/dbos-sdk');
+
+const [dbosConfig, ] = parseConfigFile();
+
+const config = {
+  client: 'pg',
+  connection: {
+    host: dbosConfig.poolConfig.host,
+    port: dbosConfig.poolConfig.port,
+    user: dbosConfig.poolConfig.user,
+    password: dbosConfig.poolConfig.password,
+    database: dbosConfig.poolConfig.database,
+    ssl: dbosConfig.poolConfig.ssl,
+  },
+  migrations: {
+    directory: './migrations'
+  }
+};
+
+module.exports = config;

package/templates/hello-nextjs/migrations/20240212161006_create_dbos_hello_tables.js

@@ -0,0 +1,18 @@
+const { Knex } = require("knex");
+
+exports.up = async function(knex) {
+  await knex.schema.createTable('dbos_hello', table => {
+    table.text('name').primary();
+    table.integer('greet_count').defaultTo(0);
+  });
+
+  return knex.schema.createTable('dbos_greetings', table => {
+    table.text('greeting_name');
+    table.text('greeting_note_content');
+  });
+};
+
+exports.down = async function(knex) {
+  await knex.schema.dropTable('dbos_greetings');
+  return knex.schema.dropTable('dbos_hello');
+};

package/templates/hello-nextjs/next.config.ts

@@ -0,0 +1,18 @@
+import type { NextConfig } from "next";
+
+const nextConfig: NextConfig = {
+  /* config options here */
+  webpack: (config) => {
+    // Treat @dbos-inc/dbos-sdk as an external package for client builds
+    config.externals = [
+      ...config.externals,
+      {
+        "@dbos-inc/dbos-sdk": "commonjs @dbos-inc/dbos-sdk",
+      },
+    ];
+
+    return config;
+  },
+};
+
+export default nextConfig;

package/templates/hello-nextjs/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "hello-nextjs",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint"
+  },
+  "dependencies": {
+    "@dbos-inc/dbos-sdk": "^1.29.15",
+    "next": "15.0.3",
+    "react": "19.0.0-rc-66855b96-20241106",
+    "react-dom": "19.0.0-rc-66855b96-20241106",
+    "typeorm": "^0.3.20",
+    "webpack": "^5.96.1"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.25.9",
+    "@babel/core": "^7.26.0",
+    "@babel/preset-env": "^7.26.0",
+    "@types/node": "^20",
+    "@types/react": "^18",
+    "@types/react-dom": "^18",
+    "eslint": "^8",
+    "eslint-config-next": "15.0.3",
+    "postcss": "^8",
+    "typescript": "^5",
+    "tailwindcss": "^3.4.1"
+  }
+}

package/templates/hello-nextjs/postcss.config.mjs

@@ -0,0 +1,8 @@
+/** @type {import('postcss-load-config').Config} */
+const config = {
+  plugins: {
+    tailwindcss: {},
+  },
+};
+
+export default config;

package/templates/hello-nextjs/public/file.svg

@@ -0,0 +1 @@
+<svg fill="none" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"><path d="M14.5 13.5V5.41a1 1 0 0 0-.3-.7L9.8.29A1 1 0 0 0 9.08 0H1.5v13.5A2.5 2.5 0 0 0 4 16h8a2.5 2.5 0 0 0 2.5-2.5m-1.5 0v-7H8v-5H3v12a1 1 0 0 0 1 1h8a1 1 0 0 0 1-1M9.5 5V2.12L12.38 5zM5.13 5h-.62v1.25h2.12V5zm-.62 3h7.12v1.25H4.5zm.62 3h-.62v1.25h7.12V11z" clip-rule="evenodd" fill="#666" fill-rule="evenodd"/></svg>

package/templates/hello-nextjs/public/globe.svg

@@ -0,0 +1 @@
+<svg fill="none" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><g clip-path="url(#a)"><path fill-rule="evenodd" clip-rule="evenodd" d="M10.27 14.1a6.5 6.5 0 0 0 3.67-3.45q-1.24.21-2.7.34-.31 1.83-.97 3.1M8 16A8 8 0 1 0 8 0a8 8 0 0 0 0 16m.48-1.52a7 7 0 0 1-.96 0H7.5a4 4 0 0 1-.84-1.32q-.38-.89-.63-2.08a40 40 0 0 0 3.92 0q-.25 1.2-.63 2.08a4 4 0 0 1-.84 1.31zm2.94-4.76q1.66-.15 2.95-.43a7 7 0 0 0 0-2.58q-1.3-.27-2.95-.43a18 18 0 0 1 0 3.44m-1.27-3.54a17 17 0 0 1 0 3.64 39 39 0 0 1-4.3 0 17 17 0 0 1 0-3.64 39 39 0 0 1 4.3 0m1.1-1.17q1.45.13 2.69.34a6.5 6.5 0 0 0-3.67-3.44q.65 1.26.98 3.1M8.48 1.5l.01.02q.41.37.84 1.31.38.89.63 2.08a40 40 0 0 0-3.92 0q.25-1.2.63-2.08a4 4 0 0 1 .85-1.32 7 7 0 0 1 .96 0m-2.75.4a6.5 6.5 0 0 0-3.67 3.44 29 29 0 0 1 2.7-.34q.31-1.83.97-3.1M4.58 6.28q-1.66.16-2.95.43a7 7 0 0 0 0 2.58q1.3.27 2.95.43a18 18 0 0 1 0-3.44m.17 4.71q-1.45-.12-2.69-.34a6.5 6.5 0 0 0 3.67 3.44q-.65-1.27-.98-3.1" fill="#666"/></g><defs><clipPath id="a"><path fill="#fff" d="M0 0h16v16H0z"/></clipPath></defs></svg>

package/templates/hello-nextjs/public/next.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 394 80"><path fill="#000" d="M262 0h68.5v12.7h-27.2v66.6h-13.6V12.7H262V0ZM149 0v12.7H94v20.4h44.3v12.6H94v21h55v12.6H80.5V0h68.7zm34.3 0h-17.8l63.8 79.4h17.9l-32-39.7 32-39.6h-17.9l-23 28.6-23-28.6zm18.3 56.7-9-11-27.1 33.7h17.8l18.3-22.7z"/><path fill="#000" d="M81 79.3 17 0H0v79.3h13.6V17l50.2 62.3H81Zm252.6-.4c-1 0-1.8-.4-2.5-1s-1.1-1.6-1.1-2.6.3-1.8 1-2.5 1.6-1 2.6-1 1.8.3 2.5 1a3.4 3.4 0 0 1 .6 4.3 3.7 3.7 0 0 1-3 1.8zm23.2-33.5h6v23.3c0 2.1-.4 4-1.3 5.5a9.1 9.1 0 0 1-3.8 3.5c-1.6.8-3.5 1.3-5.7 1.3-2 0-3.7-.4-5.3-1s-2.8-1.8-3.7-3.2c-.9-1.3-1.4-3-1.4-5h6c.1.8.3 1.6.7 2.2s1 1.2 1.6 1.5c.7.4 1.5.5 2.4.5 1 0 1.8-.2 2.4-.6a4 4 0 0 0 1.6-1.8c.3-.8.5-1.8.5-3V45.5zm30.9 9.1a4.4 4.4 0 0 0-2-3.3 7.5 7.5 0 0 0-4.3-1.1c-1.3 0-2.4.2-3.3.5-.9.4-1.6 1-2 1.6a3.5 3.5 0 0 0-.3 4c.3.5.7.9 1.3 1.2l1.8 1 2 .5 3.2.8c1.3.3 2.5.7 3.7 1.2a13 13 0 0 1 3.2 1.8 8.1 8.1 0 0 1 3 6.5c0 2-.5 3.7-1.5 5.1a10 10 0 0 1-4.4 3.5c-1.8.8-4.1 1.2-6.8 1.2-2.6 0-4.9-.4-6.8-1.2-2-.8-3.4-2-4.5-3.5a10 10 0 0 1-1.7-5.6h6a5 5 0 0 0 3.5 4.6c1 .4 2.2.6 3.4.6 1.3 0 2.5-.2 3.5-.6 1-.4 1.8-1 2.4-1.7a4 4 0 0 0 .8-2.4c0-.9-.2-1.6-.7-2.2a11 11 0 0 0-2.1-1.4l-3.2-1-3.8-1c-2.8-.7-5-1.7-6.6-3.2a7.2 7.2 0 0 1-2.4-5.7 8 8 0 0 1 1.7-5 10 10 0 0 1 4.3-3.5c2-.8 4-1.2 6.4-1.2 2.3 0 4.4.4 6.2 1.2 1.8.8 3.2 2 4.3 3.4 1 1.4 1.5 3 1.5 5h-5.8z"/></svg>

package/templates/hello-nextjs/public/vercel.svg

@@ -0,0 +1 @@
+<svg fill="none" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1155 1000"><path d="m577.3 0 577.4 1000H0z" fill="#fff"/></svg>

package/templates/hello-nextjs/public/window.svg

@@ -0,0 +1 @@
+<svg fill="none" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M1.5 2.5h13v10a1 1 0 0 1-1 1h-11a1 1 0 0 1-1-1zM0 1h16v11.5a2.5 2.5 0 0 1-2.5 2.5h-11A2.5 2.5 0 0 1 0 12.5zm3.75 4.5a.75.75 0 1 0 0-1.5.75.75 0 0 0 0 1.5M7 4.75a.75.75 0 1 1-1.5 0 .75.75 0 0 1 1.5 0m1.75.75a.75.75 0 1 0 0-1.5.75.75 0 0 0 0 1.5" fill="#666"/></svg>

package/templates/hello-nextjs/src/actions/dbosWorkflow.tsx

@@ -0,0 +1,37 @@
+"use server";
+
+import { DBOS } from "@dbos-inc/dbos-sdk";
+
+// The schema of the database table used in this example.
+export interface dbos_hello {
+    name: string;
+    greet_count: number;
+  }
+
+// Order matters: DBOS decorators must be declared before being used
+class dbosWorkflowClass {
+    @DBOS.transaction()
+    static async helloDBOS(userName: string) {
+        DBOS.logger.info("Hello from DBOS Transaction!");
+        // Retrieve and increment the number of times this user has been greeted.
+        const query = "INSERT INTO dbos_hello (name, greet_count) VALUES (?, 1) ON CONFLICT (name) DO UPDATE SET greet_count = dbos_hello.greet_count + 1 RETURNING greet_count;";
+        const { rows } = await DBOS.sqlClient.client.raw(query, [userName]) as { rows: dbos_hello[] };
+        const greet_count = rows[0].greet_count;
+        const greeting = `Hello! You have been greeted ${greet_count} times.`;
+        return greeting;
+    }
+}
+
+// Launch the DBOS runtime 
+// This code needs to execute at least once to launch the DBOS runtime
+// Do not delete this code
+if (process.env.NEXT_PHASE !== "phase-production-build") {
+    await DBOS.launch();
+}
+
+// The exported function is the entry point for the workflow
+// The function is exported and not the class because Next does not support exporting classes
+export async function dbosWorkflow(userName: string) {
+    DBOS.logger.info("Hello from DBOS!");
+    return await dbosWorkflowClass.helloDBOS(userName);
+}

package/templates/hello-nextjs/src/app/globals.css

@@ -0,0 +1,21 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+:root {
+  --background: #ffffff;
+  --foreground: #171717;
+}
+
+@media (prefers-color-scheme: dark) {
+  :root {
+    --background: #0a0a0a;
+    --foreground: #ededed;
+  }
+}
+
+body {
+  color: var(--foreground);
+  background: var(--background);
+  font-family: Arial, Helvetica, sans-serif;
+}

package/templates/hello-nextjs/src/app/greetings/route.ts

@@ -0,0 +1,11 @@
+import { NextResponse } from "next/server";
+import { dbosWorkflow } from "../../actions/dbosWorkflow";
+import { DBOS } from "@dbos-inc/dbos-sdk";
+
+export async function POST(request: Request) {
+  const body = await request.json();
+  const { userName } = body;
+  DBOS.logger.info(`Received request with name: ${userName}`);
+  const response = await dbosWorkflow(userName);
+  return NextResponse.json(response);
+}

package/templates/hello-nextjs/src/app/layout.tsx

@@ -0,0 +1,34 @@
+import type { Metadata } from "next";
+import { Geist, Geist_Mono } from "next/font/google";
+import "./globals.css";
+
+const geistSans = Geist({
+  variable: "--font-geist-sans",
+  subsets: ["latin"],
+});
+
+const geistMono = Geist_Mono({
+  variable: "--font-geist-mono",
+  subsets: ["latin"],
+});
+
+export const metadata: Metadata = {
+  title: "Create Next App with DBOS",
+  description: "Generated by DBOS",
+};
+
+export default function RootLayout({
+  children,
+}: Readonly<{
+  children: React.ReactNode;
+}>) {
+  return (
+    <html lang="en">
+      <body
+        className={`${geistSans.variable} ${geistMono.variable} antialiased`}
+      >
+        {children}
+      </body>
+    </html>
+  );
+}

package/templates/hello-nextjs/src/app/page.tsx

@@ -0,0 +1,61 @@
+import Image from "next/image";
+import CallDBOSWorkflow from "../components/client/callDBOSWorkflow";
+
+export default function Home() {
+  return (
+    <div className="grid grid-rows-[20px_1fr_20px] items-center justify-items-center min-h-screen p-8 pb-20 gap-16 sm:p-20 font-[family-name:var(--font-geist-sans)]">
+      <main className="flex flex-col gap-8 row-start-2 items-center sm:items-start">
+          <div>
+            <CallDBOSWorkflow wfResult=""/>
+          </div>
+        </main>
+      <footer className="row-start-3 flex gap-6 flex-wrap items-center justify-center">
+        <a
+          className="flex items-center gap-2 hover:underline hover:underline-offset-4"
+          href="https://docs.dbos.dev/"
+          target="_blank"
+          rel="noopener noreferrer"
+        >
+          <Image
+            aria-hidden
+            src="/file.svg"
+            alt="File icon"
+            width={16}
+            height={16}
+          />
+          Learn
+        </a>
+        <a
+          className="flex items-center gap-2 hover:underline hover:underline-offset-4"
+          href="https://docs.dbos.dev/#example-applications"
+          target="_blank"
+          rel="noopener noreferrer"
+        >
+          <Image
+            aria-hidden
+            src="/window.svg"
+            alt="Window icon"
+            width={16}
+            height={16}
+          />
+          Examples
+        </a>
+        <a
+          className="flex items-center gap-2 hover:underline hover:underline-offset-4"
+          href="https://www.dbos.dev/"
+          target="_blank"
+          rel="noopener noreferrer"
+        >
+          <Image
+            aria-hidden
+            src="/globe.svg"
+            alt="Globe icon"
+            width={16}
+            height={16}
+          />
+          Go to dbos.dev →
+        </a>
+      </footer>
+    </div>
+  );
+}

package/templates/hello-nextjs/src/components/client/callDBOSWorkflow.tsx

@@ -0,0 +1,31 @@
+"use client";
+
+import { useState } from "react";
+
+export default function CallDBOSWorkflow( { wfResult }: { wfResult: string }) {
+    const [greetingsWfResult, setGreetingsWfResult] = useState<string>(wfResult);
+    const [loading, setLoading] = useState<boolean>(false);
+
+    const greetUser = async () => {
+        setLoading(true);
+        try {
+            const response = await fetch("/greetings", { method: "POST", body: JSON.stringify({ userName: "dbosuser" }) });
+            const data = await response.json();
+            setGreetingsWfResult(data);
+        } catch (error) {
+            console.error("Error calling greetings workflow", error);
+            setGreetingsWfResult("Error calling greetings workflow: " + error);
+        } finally {
+            setLoading(false);
+        }
+    }
+
+    return(
+        <div>
+            <button onClick={greetUser} disabled={loading} className="px-4 py-2 bg-blue-500 text-white rounded hover:bg-blue-600">
+                {loading ? "" : "Run DBOS Workflow"}
+            </button>
+            <p>{greetingsWfResult}</p>
+        </div>
+  );
+}

package/templates/hello-nextjs/start_postgres_docker.js

@@ -0,0 +1,40 @@
+const { execSync } = require('child_process');
+
+// Default PostgreSQL port
+let port = '5432';
+
+// Set the host PostgreSQL port with the -p/--port flag.
+process.argv.forEach((val, index) => {
+  if (val === '-p' || val === '--port') {
+    if (process.argv[index + 1]) {
+      port = process.argv[index + 1];
+    }
+  }
+});
+
+if (!process.env.PGPASSWORD) {
+  console.error("Error: PGPASSWORD is not set.");
+  process.exit(1);
+}
+
+try {
+  execSync(`docker run --rm --name=dbos-db --env=POSTGRES_PASSWORD="${process.env.PGPASSWORD}" --env=PGDATA=/var/lib/postgresql/data --volume=/var/lib/postgresql/data -p ${port}:5432 -d sibedge/postgres-plv8`);
+  console.log("Waiting for PostgreSQL to start...");
+
+  let attempts = 30;
+  const checkDatabase = setInterval(() => {
+    try {
+      execSync('docker exec dbos-db psql -U postgres -c "SELECT 1;"', { stdio: 'ignore' });
+      console.log("PostgreSQL started!");
+      clearInterval(checkDatabase);
+      console.log("Database started successfully!");
+    } catch (error) {
+      if (--attempts === 0) {
+        clearInterval(checkDatabase);
+        console.error("Failed to start PostgreSQL.");
+      }
+    }
+  }, 1000);
+} catch (error) {
+  console.error("Error starting PostgreSQL in Docker:", error.message);
+}

package/templates/hello-nextjs/tailwind.config.ts

@@ -0,0 +1,18 @@
+import type { Config } from "tailwindcss";
+
+export default {
+  content: [
+    "./src/pages/**/*.{js,ts,jsx,tsx,mdx}",
+    "./src/components/**/*.{js,ts,jsx,tsx,mdx}",
+    "./src/app/**/*.{js,ts,jsx,tsx,mdx}",
+  ],
+  theme: {
+    extend: {
+      colors: {
+        background: "var(--background)",
+        foreground: "var(--foreground)",
+      },
+    },
+  },
+  plugins: [],
+} satisfies Config;

package/templates/hello-nextjs/tsconfig.json

@@ -0,0 +1,29 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "target": "ES2017",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true,
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ],
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "exclude": ["node_modules"]
+}

package/templates/hello-prisma/README.md

@@ -25,7 +25,7 @@ Prisma provides rich support for [schema migrations](https://www.prisma.io/docs/
 Fore more information, see [our docs](https://docs.dbos.dev/tutorials/using-prisma).
 
 ```bash
-npx dbos-sdk migrate
+npx dbos migrate
 ```
 
 If successful, the migration should print `Migration successful!`.
@@ -33,7 +33,7 @@ If successful, the migration should print `Migration successful!`.
 Finally, run the app:
 
 ```bash
-npx dbos-sdk start
+npx dbos start
 ```
 
 To see that it's working, visit this URL in your browser: [`http://localhost:3000/greeting/dbos`](http://localhost:3000/greeting/dbos).

package/templates/hello-typeorm/README.md

@@ -25,7 +25,7 @@ TypeORM provides rich support for [schema migrations](https://typeorm.io/migrati
 Fore more information, see [our docs](https://docs.dbos.dev/tutorials/using-typeorm).
 
 ```bash
-npx dbos-sdk migrate
+npx dbos migrate
 ```
 
 If successful, the migration should print `Migration successful!`.
@@ -33,7 +33,7 @@ If successful, the migration should print `Migration successful!`.
 Finally, run the app:
 
 ```bash
-npx dbos-sdk start
+npx dbos start
 ```
 
 To see that it's working, visit this URL in your browser: [`http://localhost:3000/greeting/dbos`](http://localhost:3000/greeting/dbos).

package/templates/hello-v2/README.md

@@ -36,7 +36,7 @@ npm run build
 Then, run a schema migration to create some tables:
 
 ```bash
-npx dbos-sdk migrate
+npx dbos migrate
 ```
 
 If successful, the migration should print `Migration successful!`.
@@ -44,7 +44,7 @@ If successful, the migration should print `Migration successful!`.
 Finally, run the app:
 
 ```bash
-npx dbos-sdk start
+npx dbos start
 ```
 
 ## Next Steps

package/templates/hello-express/src/operations.ts

@@ -1,81 +0,0 @@
-// Welcome to DBOS!
-
-// This is a sample "Hello" app built with DBOS, Express.js, and Knex.
-// It greets visitors and keeps track of how many times each visitor has been greeted.
-
-// First let's import express and DBOS
-import express from "express";
-import { DBOS } from "@dbos-inc/dbos-sdk";
-
-// Then, let's declare a type representing the "dbos_hello" database table
-export interface dbos_hello {
-  name: string;
-  greet_count: number;
-}
-
-// Now let's define a class with some static functions.
-// DBOS uses TypeScript decorators to automatically make your functions reliable, so they need to be static.
-export class Hello {
-  // This function greets a user and increments the greet count in the database.
-  // The @DBOS.transaction() decorator ensures that this function runs as a database transaction.
-  @DBOS.transaction()
-  static async helloTransaction(user: string) {
-    const query = "INSERT INTO dbos_hello (name, greet_count) VALUES (?, 1) ON CONFLICT (name) DO UPDATE SET greet_count = dbos_hello.greet_count + 1 RETURNING greet_count;";
-    const { rows } = (await DBOS.knexClient.raw(query, [user])) as { rows: dbos_hello[] };
-    const greet_count = rows[0].greet_count;
-    const greeting = `Hello, ${user}! You have been greeted ${greet_count} times.`;
-    return Hello.makeHTML(greeting);
-  }
-
-  // Finally, we will declare helper functions to serve static HTML to user.s
-
-  static async readme() {
-    const message = Hello.makeHTML(
-      `Visit the route <code class="bg-gray-100 px-1 rounded">/greeting/{name}</code> to be greeted!<br>
-      For example, visit <code class="bg-gray-100 px-1 rounded"><a href="/greeting/Mike" class="text-blue-600 hover:underline">/greeting/Mike</a></code><br>
-      The counter increments with each page visit.`
-    );
-    return Promise.resolve(message);
-  }
-
-  // A helper function to create HTML pages with some styling
-  static makeHTML(message: string) {
-    const page = `
-      <!DOCTYPE html>
-      <html lang="en">
-      <head>
-          <title>DBOS Template App</title>
-          <script src="https://cdn.tailwindcss.com"></script>
-      </head>
-      <body class="font-sans text-gray-800 p-6 max-w-2xl mx-auto">
-          <h1 class="text-3xl font-semibold mb-4">Welcome to DBOS!</h1>
-          <p class="mt-8 mb-8">` + message + `</p>
-          <p class="mb-2">
-              To learn how to run this app yourself, visit our
-              <a href="https://docs.dbos.dev/quickstart?language=typescript" class="text-blue-600 hover:underline">Quickstart</a>.
-          </p><p class="mb-2">
-              Then, to learn how to build crashproof apps, continue to our
-              <a href="https://docs.dbos.dev/typescript/programming-guide" class="text-blue-600 hover:underline">Programming Guide</a>.<br>
-          </p>
-      </body>
-      </html>`;
-    return page;
-  }
-}
-
-// Now, let's create an Express app and define some routes.
-export const app = express();
-// Parse JSON payloads and make it available to req.body
-app.use(express.json());
-
-// We'll serve the README at the root of the app
-app.get("/", async (_, res) => {
-  res.send(await Hello.readme());
-});
-
-// Serve this function from HTTP GET requests at the /greeting endpoint with 'user' as a path parameter
-// The handler will in turn call a reliable DBOS operation (helloTransaction) to greet the user
-app.get("/greeting/:user", async (req, res) => {
-  const { user } = req.params;
-  res.send(await Hello.helloTransaction(user));
-});