@dbos-inc/create 1.31.4-preview → 1.31.6-preview

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbos-inc/create",
-  "version": "1.31.4-preview",
+  "version": "1.31.6-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-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));
-});