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

package/package.json

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

package/templates/hello/README.md

@@ -1,6 +1,6 @@
 # DBOS Hello
 
-This is a [DBOS app](https://docs.dbos.dev/) bootstrapped with `npx @dbos-inc/create` and using [Knex](https://docs.dbos.dev/tutorials/using-knex).
+This is a [DBOS app](https://docs.dbos.dev/) bootstrapped with `npx @dbos-inc/create` and using [Knex](https://docs.dbos.dev/typescript/tutorials/orms/using-knex).
 
 ## Getting Started
 
@@ -14,11 +14,11 @@ node start_postgres_docker.js
 
 If successful, the script should print `Database started successfully!`.
 
-Next, you can build and run the app in one step under `nodemon`:
-
+To build the app, set up the database, and run, in one step:
 ```bash
 npm run dev
 ```
+This uses `nodemon`, so if you change your app it will automatically restart with changes.
 
 To see that it's working, visit this URL in your browser: [`http://localhost:3000/greeting/dbos`](http://localhost:3000/greeting/dbos).
 You should get this message: `Hello, dbos! You have been greeted 1 times.`
@@ -26,10 +26,9 @@ Each time you refresh the page, the counter should go up by one!
 
 Congratulations! You just launched a DBOS application.
 
-## Production build
-
-In production, instead of using `nodemon`, the following separate steps should be used to build, run database setup, and start the app.
+### Separate Build and Run Steps
 
+To build the app:
 ```bash
 npm run build
 ```
@@ -48,27 +47,9 @@ Finally, run the app:
 npx dbos start
 ```
 
-## The application
-
-The core of the application resides in `src/operations.ts`. It declares an "hello world" DBOS workflow served at `/greetings/:user`. To add more functionality, 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
-```
-
-functionality to this application, modify `src/operations.ts`. If you used `npm run dev`, it will automatically rebuild and restart.
-
 ## 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).
+- To add more functionality to this application, modify `src/operations.ts`, and save it.  If you are using, `npm run dev`, `nodemon` will rebuild and restart the app automatically.
+- For a detailed tutorial, check out our [programming quickstart](https://docs.dbos.dev/typescript/programming-guide).
+- To learn how to deploy your application to DBOS Cloud, visit our [cloud quickstart](https://docs.dbos.dev/quickstart)
+- To learn more about DBOS, take a look at [our documentation](https://docs.dbos.dev/) or our [source code](https://github.com/dbos-inc).

package/templates/hello/package.json

@@ -1,19 +1,15 @@
 {
-  "name": "dbos-hello",
+  "name": "dbos-hello-v2",
   "version": "0.0.1",
   "scripts": {
     "build": "tsc",
     "test": "npx dbos rollback && npx dbos migrate && jest",
-    "lint": "eslint src",
-    "lint-fix": "eslint --fix src",
     "dev": "nodemon",
     "start": "npx dbos start"
   },
   "devDependencies": {
-    "@dbos-inc/eslint-plugin": "^3.3.4",
     "@types/jest": "^29.5.12",
     "@types/supertest": "^2.0.16",
-    "eslint": "^8.57.0",
     "jest": "^29.7.0",
     "nodemon": "^3.1.0",
     "supertest": "^7.0.0",

package/templates/hello/src/operations.test.ts

@@ -1,27 +1,26 @@
-import { TestingRuntime, createTestingRuntime } from "@dbos-inc/dbos-sdk";
+import { DBOS } from "@dbos-inc/dbos-sdk";
 import { Hello, dbos_hello } from "./operations";
 import request from "supertest";
 
 describe("operations-test", () => {
-  let testRuntime: TestingRuntime;
-
   beforeAll(async () => {
-    testRuntime = await createTestingRuntime();
+    await DBOS.launch();
+    await DBOS.launchAppHTTPServer();
   });
 
   afterAll(async () => {
-    await testRuntime.destroy();
+    await DBOS.shutdown();
   });
 
   /**
    * Test the transaction.
    */
   test("test-transaction", async () => {
-    const res = await testRuntime.invoke(Hello).helloTransaction("dbos");
+    const res = await Hello.helloTransaction("dbos");
     expect(res).toMatch("Hello, dbos! You have been greeted");
 
     // Check the greet count.
-    const rows = await testRuntime.queryUserDB<dbos_hello>("SELECT * FROM dbos_hello WHERE name=$1", "dbos");
+    const rows = await DBOS.executor.queryUserDB("SELECT * FROM dbos_hello WHERE name=$1", ["dbos"]) as dbos_hello[];
     expect(rows[0].greet_count).toBe(1);
   });
 
@@ -29,7 +28,7 @@ describe("operations-test", () => {
    * Test the HTTP endpoint.
    */
   test("test-endpoint", async () => {
-    const res = await request(testRuntime.getHandlersCallback()).get(
+    const res = await request(DBOS.getHTTPHandlersCallback()).get(
       "/greeting/dbos"
     );
     expect(res.statusCode).toBe(200);

package/templates/hello/src/operations.ts

@@ -2,36 +2,34 @@
 
 // This is a sample "Hello" app built with DBOS.
 // It greets visitors and keeps track of how many times each visitor has been greeted.
-// To run this app, visit our Quickstart: https://docs.dbos.dev/getting-started/quickstart
 
-import { HandlerContext, TransactionContext, Transaction, GetApi, ArgSource, ArgSources } from "@dbos-inc/dbos-sdk";
-import { Knex } from "knex";
+// First, let's import DBOS
+import { DBOS } from "@dbos-inc/dbos-sdk";
 
-// The schema of the database table used in this example.
+// 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 {
   // Serve this function from HTTP GET requests at the /greeting endpoint with 'user' as a path parameter
-  // The @Transaction() decorator ensures that this function runs as a database transaction.
-  @GetApi("/greeting/:user")
-  @Transaction() // Run this function as a database transaction
-  static async helloTransaction(ctxt: TransactionContext<Knex>, @ArgSource(ArgSources.URL) user: string) {
+  @DBOS.getApi("/greeting/:user")
+  @DBOS.transaction() // Run this function as a database transaction
+  static async helloTransaction(user: string) {
     // 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 ctxt.client.raw(query, [user]) as { rows: dbos_hello[] };
+    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);
   }
 
-  // Let's declare helper functions to serve static HTML
-
   // Serve a quick readme for the app at the / endpoint
-  @GetApi('/')
-  static async readme(_ctxt: HandlerContext) {
+  @DBOS.getApi("/")
+  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>

package/templates/{hello-v2 → hello-contexts}/README.md

@@ -1,6 +1,8 @@
 # DBOS Hello
 
-This is a [DBOS app](https://docs.dbos.dev/) bootstrapped with `npx @dbos-inc/create` and using [Knex](https://docs.dbos.dev/tutorials/using-knex).
+*NOTE:* This is an older version of the DBOS `hello` app that uses a previous API based on passing [DBOS contexts](https://docs.dbos.dev/typescript/reference/transactapi/oldapi/contexts) around as function arguments.
+
+This is a [DBOS app](https://docs.dbos.dev/) bootstrapped with `npx @dbos-inc/create` and using [Knex](https://docs.dbos.dev/typescript/tutorials/orms/using-knex).
 
 ## Getting Started
 
@@ -14,11 +16,11 @@ node start_postgres_docker.js
 
 If successful, the script should print `Database started successfully!`.
 
-To build the app, set up the database, and run, in one step:
+Next, you can build and run the app in one step under `nodemon`:
+
 ```bash
 npm run dev
 ```
-This uses `nodemon`, so if you change your app it will automatically restart with changes.
 
 To see that it's working, visit this URL in your browser: [`http://localhost:3000/greeting/dbos`](http://localhost:3000/greeting/dbos).
 You should get this message: `Hello, dbos! You have been greeted 1 times.`
@@ -26,9 +28,10 @@ Each time you refresh the page, the counter should go up by one!
 
 Congratulations! You just launched a DBOS application.
 
-### Separate Build and Run Steps
+## Production build
+
+In production, instead of using `nodemon`, the following separate steps should be used to build, run database setup, and start the app.
 
-To build the app:
 ```bash
 npm run build
 ```
@@ -47,9 +50,27 @@ Finally, run the app:
 npx dbos start
 ```
 
+## The application
+
+The core of the application resides in `src/operations.ts`. It declares an "hello world" DBOS workflow served at `/greetings/:user`. To add more functionality, 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
+```
+
+functionality to this application, modify `src/operations.ts`. If you used `npm run dev`, it will automatically rebuild and restart.
+
 ## Next Steps
 
-- To add more functionality to this application, modify `src/operations.ts`, and save it.  If you are using, `npm run dev`, `nodemon` will rebuild and restart the app automatically.
 - For a detailed tutorial, check out our [programming quickstart](https://docs.dbos.dev/getting-started/quickstart-programming).
-- To learn how to deploy your application to DBOS Cloud, visit our [cloud quickstart](https://docs.dbos.dev/getting-started/quickstart-cloud/)
 - 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-v2 → hello-contexts}/package.json

@@ -1,15 +1,19 @@
 {
-  "name": "dbos-hello-v2",
+  "name": "dbos-hello",
   "version": "0.0.1",
   "scripts": {
     "build": "tsc",
     "test": "npx dbos rollback && npx dbos migrate && jest",
+    "lint": "eslint src",
+    "lint-fix": "eslint --fix src",
     "dev": "nodemon",
     "start": "npx dbos start"
   },
   "devDependencies": {
+    "@dbos-inc/eslint-plugin": "^3.3.4",
     "@types/jest": "^29.5.12",
     "@types/supertest": "^2.0.16",
+    "eslint": "^8.57.0",
     "jest": "^29.7.0",
     "nodemon": "^3.1.0",
     "supertest": "^7.0.0",

package/templates/{hello-v2 → hello-contexts}/src/operations.test.ts

@@ -1,26 +1,27 @@
-import { DBOS } from "@dbos-inc/dbos-sdk";
+import { TestingRuntime, createTestingRuntime } from "@dbos-inc/dbos-sdk";
 import { Hello, dbos_hello } from "./operations";
 import request from "supertest";
 
 describe("operations-test", () => {
+  let testRuntime: TestingRuntime;
+
   beforeAll(async () => {
-    await DBOS.launch();
-    await DBOS.launchAppHTTPServer();
+    testRuntime = await createTestingRuntime();
   });
 
   afterAll(async () => {
-    await DBOS.shutdown();
+    await testRuntime.destroy();
   });
 
   /**
    * Test the transaction.
    */
   test("test-transaction", async () => {
-    const res = await Hello.helloTransaction("dbos");
+    const res = await testRuntime.invoke(Hello).helloTransaction("dbos");
     expect(res).toMatch("Hello, dbos! You have been greeted");
 
     // Check the greet count.
-    const rows = await DBOS.executor.queryUserDB("SELECT * FROM dbos_hello WHERE name=$1", ["dbos"]) as dbos_hello[];
+    const rows = await testRuntime.queryUserDB<dbos_hello>("SELECT * FROM dbos_hello WHERE name=$1", "dbos");
     expect(rows[0].greet_count).toBe(1);
   });
 
@@ -28,7 +29,7 @@ describe("operations-test", () => {
    * Test the HTTP endpoint.
    */
   test("test-endpoint", async () => {
-    const res = await request(DBOS.getHTTPHandlersCallback()).get(
+    const res = await request(testRuntime.getHandlersCallback()).get(
       "/greeting/dbos"
     );
     expect(res.statusCode).toBe(200);

package/templates/{hello-v2 → hello-contexts}/src/operations.ts

@@ -2,34 +2,36 @@
 
 // This is a sample "Hello" app built with DBOS.
 // It greets visitors and keeps track of how many times each visitor has been greeted.
+// To run this app, visit our Quickstart: https://docs.dbos.dev/getting-started/quickstart
 
-// First, let's import DBOS
-import { DBOS } from "@dbos-inc/dbos-sdk";
+import { HandlerContext, TransactionContext, Transaction, GetApi, ArgSource, ArgSources } from "@dbos-inc/dbos-sdk";
+import { Knex } from "knex";
 
-// Then, let's declare a type representing the "dbos_hello" database table
+// The schema of the database table used in this example.
 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 {
   // Serve this function from HTTP GET requests at the /greeting endpoint with 'user' as a path parameter
-  @DBOS.getApi("/greeting/:user")
-  @DBOS.transaction() // Run this function as a database transaction
-  static async helloTransaction(user: string) {
+  // The @Transaction() decorator ensures that this function runs as a database transaction.
+  @GetApi("/greeting/:user")
+  @Transaction() // Run this function as a database transaction
+  static async helloTransaction(ctxt: TransactionContext<Knex>, @ArgSource(ArgSources.URL) user: string) {
     // 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.knexClient.raw(query, [user])) as { rows: dbos_hello[] };
+    const { rows } = await ctxt.client.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);
   }
 
+  // Let's declare helper functions to serve static HTML
+
   // Serve a quick readme for the app at the / endpoint
-  @DBOS.getApi("/")
-  static async readme() {
+  @GetApi('/')
+  static async readme(_ctxt: HandlerContext) {
     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>

package/templates/hello-drizzle/README.md

@@ -1,6 +1,6 @@
 # DBOS Hello with Drizzle
 
-This is a [DBOS app](https://docs.dbos.dev/) bootstrapped with `npx @dbos-inc/create` and using [Drizzle](https://docs.dbos.dev/tutorials/using-drizzle).
+This is a [DBOS app](https://docs.dbos.dev/) bootstrapped with `npx @dbos-inc/create` and using [Drizzle](https://docs.dbos.dev/typescript/tutorials/orms/using-drizzle).
 
 ## Getting Started
 
@@ -43,6 +43,6 @@ Congratulations! You just launched a DBOS application.
 ## Next Steps
 
 - To add more functionality to this application, modify `src/operations.ts`, then rebuild and restart it.  Alternatively, `npm run dev` uses `nodemon` to automatically rebuild and restart the app when source files change, using instructions specified in `nodemon.json`.
-- For a detailed tutorial, check out our [programming quickstart](https://docs.dbos.dev/getting-started/quickstart-programming).
-- To learn how to deploy your application to DBOS Cloud, visit our [cloud quickstart](https://docs.dbos.dev/getting-started/quickstart-cloud/)
-- 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).
+- For a detailed tutorial, check out our [programming quickstart](https://docs.dbos.dev/typescript/programming-guide).
+- To learn how to deploy your application to DBOS Cloud, visit our [cloud quickstart](https://docs.dbos.dev/quickstart)
+- To learn more about DBOS, take a look at [our documentation](https://docs.dbos.dev/) or our [source code](https://github.com/dbos-inc).

package/templates/hello-drizzle/package.json

@@ -13,7 +13,7 @@
     "@dbos-inc/eslint-plugin": "^3.3.4",
     "@types/jest": "^29.5.12",
     "@types/supertest": "^2.0.16",
-    "drizzle-kit": "^0.23.2",
+    "drizzle-kit": "^0.30.1",
     "eslint": "^8.57.0",
     "jest": "^29.7.0",
     "nodemon": "^3.1.0",
@@ -23,6 +23,6 @@
   },
   "dependencies": {
     "@dbos-inc/dbos-sdk": "file:../../../..",
-    "drizzle-orm": "^0.32.2"
+    "drizzle-orm": "^0.38.3"
   }
 }

package/templates/hello-drizzle/src/operations.test.ts

@@ -1,27 +1,26 @@
-import { TestingRuntime, createTestingRuntime } from "@dbos-inc/dbos-sdk";
+import { DBOS } from "@dbos-inc/dbos-sdk";
 import { Hello } from "./operations";
 import request from "supertest";
 
 describe("operations-test", () => {
-  let testRuntime: TestingRuntime;
-
   beforeAll(async () => {
-    testRuntime = await createTestingRuntime();
+    await DBOS.launch();
+    await DBOS.launchAppHTTPServer();
   });
 
   afterAll(async () => {
-    await testRuntime.destroy();
+    await DBOS.shutdown();
   });
 
   /**
    * Test the transaction.
    */
   test("test-transaction", async () => {
-    const res = await testRuntime.invoke(Hello).helloTransaction("dbos");
+    const res = await Hello.helloTransaction("dbos");
     expect(res).toMatch("Hello, dbos! We have made");
 
     // Check the greet count.
-    const rows = await testRuntime.queryUserDB("SELECT * FROM dbos_hello WHERE greet_count=1");
+    const rows = await DBOS.executor.queryUserDB("SELECT * FROM dbos_hello WHERE greet_count=1");
     expect(rows.length).toEqual(1);
   });
 
@@ -29,7 +28,7 @@ describe("operations-test", () => {
    * Test the HTTP endpoint.
    */
   test("test-endpoint", async () => {
-    const res = await request(testRuntime.getHandlersCallback()).get(
+    const res = await request(DBOS.getHTTPHandlersCallback()).get(
       "/greeting/dbos"
     );
     expect(res.statusCode).toBe(200);

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

@@ -3,25 +3,25 @@
 // This is the Quickstart Drizzle template app. It greets visitors, counting how many total greetings were made.
 // To learn how to run this app, visit the Drizzle tutorial: https://docs.dbos.dev/tutorials/using-drizzle
 
-import { HandlerContext, TransactionContext, Transaction, GetApi } from '@dbos-inc/dbos-sdk';
+import { DBOS } from '@dbos-inc/dbos-sdk';
 import { dbosHello } from './schema';
 import { NodePgDatabase } from 'drizzle-orm/node-postgres';
 
 export class Hello {
 
   // Serve this function from HTTP GET requests at the /greeting endpoint with 'user' as a path parameter
-  @GetApi('/greeting/:user')
-  @Transaction()
-  static async helloTransaction(ctxt: TransactionContext<NodePgDatabase>, user: string) {
+  @DBOS.getApi('/greeting/:user')
+  @DBOS.transaction()
+  static async helloTransaction(user: string) {
     const greeting = `Hello, ${user}!`;
-    const greetings_output = await ctxt.client.insert(dbosHello).values({greeting}).returning({greet_count: dbosHello.greet_count});
+    const greetings_output = await (DBOS.drizzleClient as NodePgDatabase).insert(dbosHello).values({greeting}).returning({greet_count: dbosHello.greet_count});
     const greeting_message = `${greeting} We have made ${greetings_output[0].greet_count} greetings.`;
     return Hello.makeHTML(greeting_message);
   }
 
   // Serve a quick readme for the app at the / endpoint
-  @GetApi('/')
-  static async readme(_ctxt: HandlerContext) {
+  @DBOS.getApi('/')
+  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>

package/templates/hello-express/README.md

@@ -1,6 +1,6 @@
 # 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.
+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/typescript/tutorials/orms/using-knex) to interact with postgres.
 
 ## Getting Started
 
@@ -73,5 +73,5 @@ 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).
+- For a detailed tutorial, check out our [programming quickstart](https://docs.dbos.dev/typescript/programming-guide).
+- To learn more about DBOS, take a look at [our documentation](https://docs.dbos.dev/) or our [source code](https://github.com/dbos-inc).

package/templates/hello-nextjs/README.md

@@ -1,6 +1,6 @@
-# DBOS Hello
+# DBOS Background Job
 
-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.
+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/typescript/tutorials/orms/using-knex) to interact with postgres.
 
 ## Getting Started
 
@@ -40,12 +40,22 @@ 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.
+Click on the "Start Background Job" 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!
+You should this message: `Your background task has completed step 0 of 9.`
+As the background job completes steps, the step counter should go up by one!
 
-Congratulations! You just launched a DBOS application.
+Click on "Crash the application" button.
+
+The step counter stops increasing.
+On the command line, you will see that the application has stopped.
+Start the application again.
+```bash
+npm run start
+```
+In the browser, you will see that the execution of steps resumes where it left off and eventually completes.
+
+Congratulations! You just run a DBOS application.
 
 ## The application
 
@@ -57,9 +67,9 @@ 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 workflow for the background job is called by the called the GET method in app/tasks/route.ts.
 
-- The POST is called by the component in src/components/callDBOSWorkflow.tsx. It calls the route /greetings.
+- The GET is called by the component in src/components/BackGroundTask.tsx. It calls the route /tasks.
 
 - The component is called from the main UI page.tsx.
 
@@ -72,7 +82,7 @@ To add more functionality to this application, modify `src/operations.ts`. If yo
 
 ## Running in DBOS Cloud
 
-To deploy this app to DBOS Cloud, first install the DBOS Cloud CLI (example with [npm](https://www.npmjs.com/)):
+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
@@ -86,6 +96,5 @@ 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).
-
+- For a detailed tutorial, check out our [programming quickstart](https://docs.dbos.dev/typescript/programming-guide).
+- To learn more about DBOS, take a look at [our documentation](https://docs.dbos.dev/) or our [source code](https://github.com/dbos-inc).

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

@@ -20,6 +20,25 @@ class dbosWorkflowClass {
         const greeting = `Hello! You have been greeted ${greet_count} times.`;
         return greeting;
     }
+
+    @DBOS.transaction()
+    static async backgroundTaskStep(i : number) {
+        DBOS.logger.info(`Completed step ${i}`);
+    }
+
+    @DBOS.workflow()
+    static async backgroundTask(i: number) {
+        DBOS.logger.info("Hello from background task!");
+        for (let j = 1; j <= i; j++) {
+            await dbosWorkflowClass.backgroundTaskStep(j);
+            DBOS.logger.info("Sleeping for 2 seconds");
+            await DBOS.sleepSeconds(2);
+            await DBOS.setEvent("steps_event", j)
+        }
+        DBOS.logger.info("Background task complete!");
+    } 
+
+
 }
 
 // Launch the DBOS runtime 
@@ -34,4 +53,9 @@ if (process.env.NEXT_PHASE !== "phase-production-build") {
 export async function dbosWorkflow(userName: string) {
     DBOS.logger.info("Hello from DBOS!");
     return await dbosWorkflowClass.helloDBOS(userName);
+}
+
+export async function dbosBackgroundTask(workflowID: string) {
+    DBOS.logger.info("Hello from DBOS!");
+    return DBOS.startWorkflow(dbosWorkflowClass, {workflowID: workflowID}).backgroundTask(10);
 }

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

@@ -0,0 +1,8 @@
+
+export async function GET(request: Request) {
+
+    console.log("Received request Crashing the app");
+
+    process.exit(1);
+
+}

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

@@ -1,12 +1,20 @@
 import Image from "next/image";
-import CallDBOSWorkflow from "../components/client/callDBOSWorkflow";
+import BackGroundTask from "@/components/client/BackGroundTask";
 
 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">
+
+
+          <h1 className="text-xl font-semibold mb-4">Welcome to DBOS!</h1>
+          
+    
+          <p className="mb-4">
+             DBOS helps you build applications that are <strong>resilient to any failure</strong>&mdash;no matter how many times you crash this app, your background task will always recover from its last completed step in about ten seconds.
+         </p>
           <div>
-            <CallDBOSWorkflow wfResult=""/>
+            <BackGroundTask />
           </div>
         </main>
       <footer className="row-start-3 flex gap-6 flex-wrap items-center justify-center">

package/templates/hello-nextjs/src/app/step/[slug]/route.ts

@@ -0,0 +1,15 @@
+import { NextResponse } from "next/server";
+import { DBOS } from "@dbos-inc/dbos-sdk";
+
+export async function GET(request: Request, { params }: { params: Promise<{ slug: string }> }) {
+
+    const taskId = (await params).slug;
+    DBOS.logger.info(`Received request to check on taskId: ${taskId}`);
+
+    let step = await DBOS.getEvent(taskId, "steps_event");
+
+    DBOS.logger.info(`For taskId: ${taskId} we are done with ${step} steps`);  
+
+    return NextResponse.json({ "stepsCompleted": step});
+
+}

package/templates/hello-nextjs/src/app/tasks/[slug]/route.ts

@@ -0,0 +1,18 @@
+import { NextResponse } from "next/server";
+import { DBOS } from "@dbos-inc/dbos-sdk";
+import { dbosBackgroundTask } from "@/actions/dbosWorkflow";    
+
+export async function GET(request: Request, { params }: { params: Promise<{ slug: string }> }) {
+
+    const taskId = (await params).slug;
+
+    DBOS.logger.info(`Received request to start background task taskId: ${taskId}`);
+
+    DBOS.logger.info(`Started background task taskId: ${taskId}`);
+
+    await dbosBackgroundTask(taskId)
+
+    return NextResponse.json({ message: "Background task started" });
+
+}
+

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

@@ -0,0 +1,180 @@
+"use client";
+
+import { useState, useEffect } from "react";
+import { useRouter, useSearchParams } from "next/navigation";
+import { dbosBackgroundTask } from "@/actions/dbosWorkflow";
+import { Suspense } from 'react'
+
+let intervalInitialized = false;
+
+function generateRandomString(): string {
+    const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+    const array = new Uint8Array(6);
+    crypto.getRandomValues(array); // Fills the array with cryptographically random values
+
+    return Array.from(array)
+        .map(x => chars[x % chars.length])
+        .join('');
+}
+
+function BackGroundTask() {
+    const [isRunning, setIsRunning] = useState(false);
+    const [currentStep, setCurrentStep] = useState(0);
+    const [taskId, setTaskid] = useState("");
+    const [isReconnecting, setIsReconnecting] = useState(false);
+
+    const router = useRouter();
+    const searchParams = useSearchParams();
+
+    const startBackgroundJob = async () => {
+      setIsRunning(true);
+  
+      setCurrentStep(0);
+
+      let task = taskId
+      if (taskId === "") {
+        task = generateRandomString();
+        setTaskid(task);
+        updateQueryParam("id", task);
+      }
+
+      //  start the background job
+      try {
+        await fetch(`/tasks/${task}`, { method: "GET" });
+      } catch (error) {
+        console.error("Failed to start job", error);
+        setIsRunning(false);
+      }
+  };
+
+  const crashApp = async () => {
+
+    if(!isRunning) {
+        console.log("Not running, nothing to crash");
+        return;
+    }
+    
+    setIsRunning(false);
+    
+    console.log("Crashing the application");
+    
+    // stop the background job
+    try {
+      await fetch("/crash", { method: "GET" });
+    } catch (error) {
+      console.error("Failed to start job", error);
+      
+    }
+
+  };
+
+  // Update the URL query parameter
+  const updateQueryParam = (key: string, value: string) => {
+    const params = new URLSearchParams(searchParams.toString());
+    params.set(key, value);
+    const newUrl = `${window.location.pathname}?${params.toString()}`;
+    router.replace(newUrl);
+  };
+
+  // Remove the `id` query parameter from the URL
+  const clearQueryParam = (key: string) => {
+    const params = new URLSearchParams(searchParams.toString());
+    params.delete(key);
+    const newUrl = `${window.location.pathname}?${params.toString()}`;
+    router.replace(newUrl);
+  };
+
+  // fetch the current progress
+  const fetchProgress = async () => {
+    try {
+
+      if (taskId === "") {
+        console.log("No task to monitor");
+        return;
+      }
+
+      const response = await fetch(`/step/${taskId}`, { method: "GET" });
+      if (!response.ok) {
+        console.error("Failed to fetch job progress", response.statusText);
+        setIsReconnecting(true);
+        return;
+      }
+      setIsReconnecting(false);
+
+      const data = await response.json();
+
+      console.log("Step completed", data.stepsCompleted);
+
+      if (data.stepsCompleted) {
+        setIsRunning(true);
+        setCurrentStep(data.stepsCompleted);
+
+
+        if (data.stepsCompleted === 10) {
+          clearQueryParam("id");  
+          setIsRunning(false);
+          setTaskid("");
+          setCurrentStep(0);
+          
+        }
+      }
+    } catch (error) {
+      console.error("Failed to fetch job progress", error);
+      setIsRunning(false);
+      setTaskid("");
+      setIsReconnecting(true);
+    }
+  };
+
+   // Polling the progress every 2 seconds while the job is running
+  useEffect(() => {
+    const idFromUrl = searchParams.get("id");
+    if (idFromUrl) {
+      setTaskid(idFromUrl);
+      setIsRunning(true); // Assume the job is already running if there's an ID
+    }
+    
+    if (!intervalInitialized) {
+      const interval = setInterval(fetchProgress, 2000);
+      intervalInitialized = true;
+      return () => {
+        clearInterval(interval);
+        intervalInitialized = false;
+      };
+    }
+  }, [searchParams]);
+
+
+  return (
+    <div>
+      <div className="flex flex-row gap-2">  
+        <button onClick={startBackgroundJob} disabled={isRunning} className="px-4 py-2 bg-blue-500 text-white rounded hover:bg-blue-600">
+          {isRunning ? "Job in Progress..." : "Start Background Job"}
+        </button>
+        <button onClick={crashApp} disabled={!isRunning} className="px-4 py-2 bg-red-500 text-white rounded hover:bg-red-600">
+           { isRunning ? "Crash the application" : "Not Running"} 
+        </button>
+      </div>
+
+      <p>
+        {currentStep < 10
+          ? `Your background task has completed step ${currentStep} of 10.`
+          : "Background task completed successfully!"}
+      </p>
+      <p>
+        {isReconnecting ? "Reconnecting..." : ""}
+      </p>
+
+
+    </div>
+  );
+
+}
+
+const WrappedBackgroundJobComponent = () => (
+    <Suspense fallback={<p>Loading...</p>}>
+      <BackGroundTask />
+    </Suspense>
+  );
+  
+export default WrappedBackgroundJobComponent;

package/templates/hello-prisma/README.md

@@ -1,6 +1,6 @@
 # DBOS Hello with Prisma
 
-This is a [DBOS app](https://docs.dbos.dev/) bootstrapped with `npx @dbos-inc/create` and using [Prisma](https://docs.dbos.dev/tutorials/using-prisma).
+This is a [DBOS app](https://docs.dbos.dev/) bootstrapped with `npx @dbos-inc/create` and using [Prisma](https://docs.dbos.dev/typescript/tutorials/orms/using-prisma).
 
 ## Getting Started
 
@@ -22,7 +22,7 @@ npm run build
 
 Then, run a schema migration to create some tables.
 Prisma provides rich support for [schema migrations](https://www.prisma.io/docs/orm/prisma-migrate), including automatic generation of migration files from Prisma schema.
-Fore more information, see [our docs](https://docs.dbos.dev/tutorials/using-prisma).
+Fore more information, see [our docs](https://docs.dbos.dev/typescript/tutorials/orms/using-prisma).
 
 ```bash
 npx dbos migrate
@@ -44,8 +44,8 @@ Congratulations! You just launched a DBOS application.
 
 ## Next Steps
 
-- For more information on using Prisma with DBOS, check out [our docs](https://docs.dbos.dev/tutorials/using-prisma).
+- For more information on using Prisma with DBOS, check out [our docs](https://docs.dbos.dev/typescript/tutorials/orms/using-prisma).
 - To add more functionality to this application, modify `src/operations.ts`, then rebuild and restart it.  Alternatively, `npm run dev` uses `nodemon` to automatically rebuild and restart the app when source files change, using instructions specified in `nodemon.json`.
-- For a detailed tutorial, check out our [programming quickstart](https://docs.dbos.dev/getting-started/quickstart-programming).
-- To learn how to deploy your application to DBOS Cloud, visit our [cloud quickstart](https://docs.dbos.dev/getting-started/quickstart-cloud/)
-- 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).
+- For a detailed tutorial, check out our [programming quickstart](https://docs.dbos.dev/typescript/programming-guide).
+- To learn how to deploy your application to DBOS Cloud, visit our [cloud quickstart](https://docs.dbos.dev/quickstart/)
+- To learn more about DBOS, take a look at [our documentation](https://docs.dbos.dev/) or our [source code](https://github.com/dbos-inc).

package/templates/hello-prisma/src/operations.test.ts

@@ -1,26 +1,26 @@
-import { TestingRuntime, createTestingRuntime } from "@dbos-inc/dbos-sdk";
+import { DBOS } from "@dbos-inc/dbos-sdk";
 import { Hello } from "./operations";
 import request from "supertest";
 
 describe("operations-test", () => {
-  let testRuntime: TestingRuntime;
-
   beforeAll(async () => {
-    testRuntime = await createTestingRuntime([Hello]);
+    await DBOS.launch();
+    await DBOS.launchAppHTTPServer();
   });
 
   afterAll(async () => {
-    await testRuntime.destroy();
+    await DBOS.shutdown();
   });
 
   /**
    * Test the HTTP endpoint.
    */
   test("test-greet", async () => {
-    const res = await request(testRuntime.getHandlersCallback()).get(
+    const res = await request(DBOS.getHTTPHandlersCallback()!).get(
       "/greeting/dbos"
     );
     expect(res.statusCode).toBe(200);
     expect(res.text).toMatch("Greeting 1: Hello, dbos!");
+    expect (await Hello.helloTransaction('bob')).toMatch("Greeting 2: Hello, bob!");
   });
 });

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

@@ -3,18 +3,18 @@
 // This is the Quickstart Prisma template app. It greets visitors, counting how many total greetings were made.
 // To learn how to run this app, visit the Prisma tutorial: https://docs.dbos.dev/tutorials/using-prisma
 
-import { HandlerContext, TransactionContext, Transaction, GetApi } from '@dbos-inc/dbos-sdk';
+import { DBOS } from '@dbos-inc/dbos-sdk';
 
 import { PrismaClient } from "@prisma/client";
 
 export class Hello {
 
   // Serve this function from HTTP GET requests at the /greeting endpoint with 'name' as a path parameter
-  @GetApi('/greeting/:name')
-  @Transaction()
-  static async helloTransaction(txnCtxt: TransactionContext<PrismaClient>, name: string)  {
+  @DBOS.getApi('/greeting/:name')
+  @DBOS.transaction()
+  static async helloTransaction(name: string)  {
     const greeting = `Hello, ${name}!`;
-    const res = await txnCtxt.client.dbosHello.create({
+    const res = await (DBOS.prismaClient as PrismaClient).dbosHello.create({
       data: {
         greeting: greeting,
       },
@@ -24,8 +24,8 @@ export class Hello {
   }
 
   // Serve a quick readme for the app at the / endpoint
-  @GetApi('/')
-  static async readme(_ctxt: HandlerContext) {
+  @DBOS.getApi('/')
+  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>

package/templates/hello-typeorm/README.md

@@ -1,6 +1,6 @@
 # DBOS Hello with TypeORM
 
-This is a [DBOS app](https://docs.dbos.dev/) bootstrapped with `npx @dbos-inc/create` and using [TypeORM](https://docs.dbos.dev/tutorials/using-typeorm).
+This is a [DBOS app](https://docs.dbos.dev/) bootstrapped with `npx @dbos-inc/create` and using [TypeORM](https://docs.dbos.dev/typescript/tutorials/orms/using-typeorm).
 
 ## Getting Started
 
@@ -22,7 +22,7 @@ npm run build
 
 Then, run a schema migration to create some tables.
 TypeORM provides rich support for [schema migrations](https://typeorm.io/migrations), including automatic generation of migration files from entity files.
-Fore more information, see [our docs](https://docs.dbos.dev/tutorials/using-typeorm).
+Fore more information, see [our docs](https://docs.dbos.dev/typescript/tutorials/orms/using-typeorm).
 
 ```bash
 npx dbos migrate
@@ -44,8 +44,8 @@ Congratulations! You just launched a DBOS application.
 
 ## Next Steps
 
-- For more information on using TypeORM with DBOS, check out [our docs](https://docs.dbos.dev/tutorials/using-typeorm).
+- For more information on using TypeORM with DBOS, check out [our docs](https://docs.dbos.dev/typescript/tutorials/orms/using-typeorm).
 - To add more functionality to this application, modify `src/operations.ts`, then rebuild and restart it.  Alternatively, `npm run dev` uses `nodemon` to automatically rebuild and restart the app when source files change, using instructions specified in `nodemon.json`.
-- For a detailed tutorial, check out our [programming quickstart](https://docs.dbos.dev/getting-started/quickstart-programming).
-- To learn how to deploy your application to DBOS Cloud, visit our [cloud quickstart](https://docs.dbos.dev/getting-started/quickstart-cloud/)
-- 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).
+- For a detailed tutorial, check out our [programming quickstart](https://docs.dbos.dev/typescript/programming-guide).
+- To learn how to deploy your application to DBOS Cloud, visit our [cloud quickstart](https://docs.dbos.dev/quickstart)
+- To learn more about DBOS, take a look at [our documentation](https://docs.dbos.dev/) or our [source code](https://github.com/dbos-inc).

package/templates/hello-typeorm/src/operations.test.ts

@@ -1,26 +1,27 @@
-import { TestingRuntime, createTestingRuntime } from "@dbos-inc/dbos-sdk";
+import { DBOS } from "@dbos-inc/dbos-sdk";
 import { Hello } from "./operations";
 import request from "supertest";
 
 describe("operations-test", () => {
-  let testRuntime: TestingRuntime;
-
   beforeAll(async () => {
-    testRuntime = await createTestingRuntime([Hello]);
+    await DBOS.launch();
+    await DBOS.launchAppHTTPServer();
   });
 
   afterAll(async () => {
-    await testRuntime.destroy();
+    await DBOS.shutdown();
   });
 
   /**
    * Test the HTTP endpoint.
    */
   test("test-greet", async () => {
-    const res = await request(testRuntime.getHandlersCallback()).get(
+    const res = await request(DBOS.getHTTPHandlersCallback()!).get(
       "/greeting/dbos"
     );
     expect(res.statusCode).toBe(200);
     expect(res.text).toMatch("Greeting 1: Hello, dbos!");
+
+    expect(await Hello.helloTransaction('bob')).toMatch("Greeting 2: Hello, bob!");
   });
 });

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

@@ -3,27 +3,27 @@
 // This is the Quickstart TypeORM template app. It greets visitors, counting how many total greetings were made.
 // To learn how to run this app, visit the TypeORM tutorial: https://docs.dbos.dev/tutorials/using-typeorm
 
-import { HandlerContext, TransactionContext, Transaction, GetApi, OrmEntities } from '@dbos-inc/dbos-sdk';
+import { DBOS, OrmEntities } from '@dbos-inc/dbos-sdk';
 import { EntityManager } from "typeorm";
 import { DBOSHello } from '../entities/DBOSHello';
 
 @OrmEntities([DBOSHello])
 export class Hello {
 
-  @GetApi('/greeting/:name')
-  @Transaction()
-  static async helloTransaction(txnCtxt: TransactionContext<EntityManager>, name: string) {
+  @DBOS.getApi('/greeting/:name')
+  @DBOS.transaction()
+  static async helloTransaction(name: string) {
     const greeting = `Hello, ${name}!`;
     let entity = new DBOSHello();
     entity.greeting = greeting;
-    entity = await txnCtxt.client.save(entity);
+    entity = await (DBOS.typeORMClient as EntityManager).save(entity);
     const greeting_note =  `Greeting ${entity.greeting_id}: ${greeting}`;
     return Hello.makeHTML(greeting_note);
   }
 
   // Serve a quick readme for the app at the / endpoint
-  @GetApi('/')
-  static async readme(_ctxt: HandlerContext) {
+  @DBOS.getApi('/')
+  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>