@dbos-inc/create 1.19.21 → 1.20.3-preview

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbos-inc/create",
-  "version": "1.19.21",
+  "version": "1.20.3-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/dbos-sdk init`.
+This is a [DBOS app](https://docs.dbos.dev/) bootstrapped with `npx @dbos-inc/create`.
 
 ## Getting Started
 

package/templates/hello-drizzle/.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+	// Automatically recommend the DBOS extension to VSCode users.
+	// Documentation on extensions.json: http://go.microsoft.com/fwlink/?LinkId=827846
+	"recommendations": [
+		"dbos-inc.dbos-ttdbg"
+	]
+}

package/templates/hello-drizzle/.vscode/launch.json

@@ -0,0 +1,21 @@
+{
+    // Automatically configure the VSCode debugger for DBOS projects.
+    // Documentation on launch.json: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+      {
+        "type": "node-terminal",
+        "request": "launch",
+        "name": "Local Debug",
+        "command": "npx dbos start",
+        "preLaunchTask": "npm: build",
+      },
+      {
+        "type": "node-terminal",
+        "request": "launch",
+        "name": "Time Travel Debug",
+        "command": "npx dbos debug -x ${command:dbos-ttdbg.get-proxy-url} -u ${command:dbos-ttdbg.pick-workflow-id}",
+        "preLaunchTask": "npm: build"
+      }
+    ]
+  }

package/templates/hello-drizzle/.vscode/tasks.json

@@ -0,0 +1,19 @@
+{
+    // Configure the build command for DBOS projects using VSCode.
+    // Documentation on tasks.json: https://code.visualstudio.com/docs/editor/tasks
+    "version": "2.0.0",
+    "tasks": [
+      {
+        "label": "npm: build",
+        "type": "npm",
+        "script": "build",
+        "group": {
+          "kind": "build",
+          "isDefault": true
+        },
+        "problemMatcher": [
+          "$tsc"
+        ]
+      }
+    ]
+  }

package/templates/hello-drizzle/README.md

@@ -0,0 +1,48 @@
+# DBOS Hello with Drizzle
+
+This is a [DBOS app](https://docs.dbos.dev/) bootstrapped with `npx @dbos-inc/create`.
+
+## 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!`.
+
+Next, build the app:
+
+```bash
+npm run build
+```
+
+Then, run a schema migration to create some tables:
+
+```bash
+npx dbos-sdk migrate
+```
+
+If successful, the migration should print `Migration successful!`.
+
+Finally, run the app:
+
+```bash
+npx dbos-sdk start
+```
+
+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.`
+Each time you refresh the page, the counter should go up by one!
+
+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).

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

@@ -0,0 +1,19 @@
+# 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}
+  app_db_name: hello_drizzle
+  connectionTimeoutMillis: 3000
+  app_db_client: drizzle
+  migrate:
+    - npx drizzle-kit migrate
+runtimeConfig:
+  entrypoints:
+    - dist/operations.js

package/templates/hello-drizzle/drizzle/0000_hello.sql

@@ -0,0 +1,4 @@
+CREATE TABLE IF NOT EXISTS "dbos_hello" (
+	"name" text PRIMARY KEY NOT NULL,
+	"greet_count" integer DEFAULT 0
+);

package/templates/hello-drizzle/drizzle/meta/0000_snapshot.json

@@ -0,0 +1,39 @@
+{
+  "id": "a4d3c46e-f0ff-439d-8265-f04a053fc603",
+  "prevId": "00000000-0000-0000-0000-000000000000",
+  "version": "7",
+  "dialect": "postgresql",
+  "tables": {
+    "public.dbos_hello": {
+      "name": "dbos_hello",
+      "schema": "",
+      "columns": {
+        "name": {
+          "name": "name",
+          "type": "text",
+          "primaryKey": true,
+          "notNull": true
+        },
+        "greet_count": {
+          "name": "greet_count",
+          "type": "integer",
+          "primaryKey": false,
+          "notNull": false,
+          "default": 0
+        }
+      },
+      "indexes": {},
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {}
+    }
+  },
+  "enums": {},
+  "schemas": {},
+  "sequences": {},
+  "_meta": {
+    "columns": {},
+    "schemas": {},
+    "tables": {}
+  }
+}

package/templates/hello-drizzle/drizzle/meta/_journal.json

@@ -0,0 +1,13 @@
+{
+  "version": "7",
+  "dialect": "postgresql",
+  "entries": [
+    {
+      "idx": 0,
+      "version": "7",
+      "when": 1722903584204,
+      "tag": "0000_hello",
+      "breakpoints": true
+    }
+  ]
+}

package/templates/hello-drizzle/drizzle.config.ts

@@ -0,0 +1,19 @@
+import { defineConfig } from 'drizzle-kit';
+
+const { parseConfigFile } = require('@dbos-inc/dbos-sdk');
+
+const [dbosConfig, ] = parseConfigFile();
+
+export default defineConfig({
+  schema: './src/schema.ts',
+  out: './drizzle',
+  dialect: 'postgresql',
+  dbCredentials: {
+    host: dbosConfig.poolConfig.host,
+    port: dbosConfig.poolConfig.port,
+    user: dbosConfig.poolConfig.user,
+    password: dbosConfig.poolConfig.password,
+    database: dbosConfig.poolConfig.database,
+    ssl: dbosConfig.poolConfig.ssl,
+  },
+});

package/templates/hello-drizzle/eslint.config.js

@@ -0,0 +1,26 @@
+const { FlatCompat } = require("@eslint/eslintrc");
+const dbosIncEslintPlugin = require("@dbos-inc/eslint-plugin");
+const typescriptEslint = require("typescript-eslint");
+const typescriptEslintParser = require("@typescript-eslint/parser");
+const globals = require("globals");
+const js = require("@eslint/js");
+
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended
+});
+
+module.exports = typescriptEslint.config({
+  extends: compat.extends("plugin:@dbos-inc/dbosRecommendedConfig"),
+  plugins: { "@dbos-inc": dbosIncEslintPlugin },
+
+  languageOptions: {
+    parser: typescriptEslintParser,
+    parserOptions: { project: "./tsconfig.json" },
+    globals: { ...globals.node, ...globals.es6 }
+  },
+
+  rules: {},
+
+  ignores: ["**/*.test.ts"]
+});

package/templates/hello-drizzle/gitignore.template

@@ -0,0 +1,144 @@
+# DBOS-specific
+.dbos
+
+# Logs
+**/.DS_Store
+**/prisma/migrations/*
+
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+dbos_deploy/
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# VSCode settings
+.vscode/settings.json
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# Editor temp/recovery files
+*.swp
+*.swo

package/templates/hello-drizzle/jest.config.js

@@ -0,0 +1,8 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  testRegex: '((\\.|/)(test|spec))\\.ts?$',
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+  modulePaths: ["./"],
+};

package/templates/hello-drizzle/nodemon.json

@@ -0,0 +1,7 @@
+{
+  "watch": ["src/","migrations/"],
+  "ext": "ts,json",
+  "ignore": ["src/**/*.test.ts"],
+  "exec": "npm run build && npx dbos migrate && npm run start"
+}
+

package/templates/hello-drizzle/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "dbos-hello-drizzle",
+  "version": "0.0.1",
+  "scripts": {
+    "build": "tsc",
+    "test": "npx dbos migrate && jest",
+    "lint": "eslint src",
+    "lint-fix": "eslint --fix src",
+    "dev": "nodemon",
+    "start": "npx dbos start"
+  },
+  "devDependencies": {
+    "@dbos-inc/eslint-plugin": "^3.1.0",
+    "@types/jest": "^29.5.12",
+    "@types/supertest": "^2.0.16",
+    "drizzle-kit": "^0.23.2",
+    "eslint": "^8.57.0",
+    "jest": "^29.7.0",
+    "nodemon": "^3.1.0",
+    "supertest": "^7.0.0",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.4.5"
+  },
+  "dependencies": {
+    "@dbos-inc/dbos-sdk": "file:../../../..",
+    "drizzle-orm": "^0.32.2"
+  }
+}

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

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

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

@@ -0,0 +1,33 @@
+import { HandlerContext, TransactionContext, Transaction, GetApi, ArgSource, ArgSources } from '@dbos-inc/dbos-sdk';
+import { DBOSHello } from './schema';
+import { sql } from 'drizzle-orm';
+import { NodePgDatabase } from 'drizzle-orm/node-postgres';
+
+export class Hello {
+
+  @GetApi('/') // Serve a quick readme for the app
+  static async readme(_ctxt: HandlerContext) {
+    const readme = '<html><body><p>' +
+           'Welcome to the DBOS Hello App!<br><br>' +
+           'Visit the route /greeting/:name to be greeted!<br>' +
+           'For example, visit <a href="/greeting/dbos">/greeting/dbos</a>.<br>' +
+           'The counter increments with each page visit.<br>' +
+           'If you visit a new name like <a href="/greeting/alice">/greeting/alice</a>, the counter starts at 1.' +
+           '</p></body></html>';
+    return Promise.resolve(readme);
+  }
+
+  @GetApi('/greeting/:user') // Serve this function from HTTP GET requests to the /greeting endpoint with 'user' as a path parameter
+  @Transaction()  // Run this function as a database transaction
+  static async helloTransaction(ctxt: TransactionContext<NodePgDatabase>, @ArgSource(ArgSources.URL) user: string) {
+    const output = await ctxt.client.execute(sql`
+      INSERT INTO ${DBOSHello} (name, greet_count)
+      VALUES (${user}, 1)
+      ON CONFLICT (name) DO UPDATE
+      SET greet_count = ${DBOSHello.greet_count} + 1
+      RETURNING greet_count
+    `);
+    const greet_count = output.rows[0].greet_count as number;
+    return `Hello, ${user}! You have been greeted ${greet_count} times.\n`;
+  }
+}

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

@@ -0,0 +1,7 @@
+import { integer } from "drizzle-orm/pg-core";
+import { pgTable, text } from "drizzle-orm/pg-core";
+
+export const DBOSHello = pgTable('dbos_hello', {
+  name: text('name').primaryKey(),
+  greet_count: integer('greet_count').default(0)
+});

package/templates/hello-drizzle/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-drizzle/tsconfig.json

@@ -0,0 +1,25 @@
+/* Visit https://aka.ms/tsconfig to read more about this file */
+{
+  "compilerOptions": {
+    "target": "esnext",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    "experimentalDecorators": true,                      /* Enable experimental support for legacy experimental decorators. */
+    "emitDecoratorMetadata": true,                       /* Emit design-type metadata for decorated declarations in source files. */
+    "module": "Node16",                                /* Specify what module code is generated. */
+    "declaration": true,                                 /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    "declarationMap": true,                              /* Create sourcemaps for d.ts files. */
+    "sourceMap": true,                                   /* Create source map files for emitted JavaScript files. */
+    "outDir": "./dist",                                  /* Specify an output folder for all emitted files. */
+    "newLine": "lf",                                     /* Set the newline character for emitting files. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  },
+  "include": [                                           /* Specifies an array of filenames or patterns to include in the program. */
+    "src"
+  ],
+  "exclude": [
+    "**/*.test.ts",
+    "dist"
+  ]
+}

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/dbos-sdk init` 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/tutorials/using-prisma).
 
 ## Getting Started
 

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/dbos-sdk init` 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/tutorials/using-typeorm).
 
 ## Getting Started