@dbos-inc/create 1.12.7-preview → 1.12.8-preview

package/package.json

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

package/templates/hello-prisma/.eslintignore

@@ -0,0 +1,5 @@
+dist
+*.test.ts
+jest.config.js
+generate_env.js
+start_postgres_docker.js

package/templates/hello-prisma/.eslintrc

@@ -0,0 +1,19 @@
+{
+  "root": true,
+  "extends": [
+    "plugin:@dbos-inc/dbosRecommendedConfig"
+  ],
+  "plugins": [
+    "@dbos-inc"
+  ],
+  "env": {
+    "node": true,
+    "es6": true
+  },
+  "rules": {
+  },
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  }
+}

package/templates/hello-prisma/.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-prisma/.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-prisma/.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-prisma/README.md

@@ -0,0 +1,51 @@
+# 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).
+
+## 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.
+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).
+
+```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
+
+- For more information on using Prisma with DBOS, check out [our docs](https://docs.dbos.dev/tutorials/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).

package/templates/hello-prisma/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
+
+database:
+  hostname: 'localhost'
+  port: 5432
+  username: 'postgres'
+  app_db_name: 'hello_prisma'
+  password: ${PGPASSWORD}
+  connectionTimeoutMillis: 3000
+  app_db_client: prisma
+  migrate:
+    - npx prisma migrate deploy
+runtimeConfig:
+  entrypoints:
+    - dist/operations.js

package/templates/hello-prisma/generate_env.js

@@ -0,0 +1,16 @@
+const { parseConfigFile } = require('@dbos-inc/dbos-sdk/dist/src/dbos-runtime/config');
+const fs = require('node:fs');
+const path = require('node:path');
+
+// Load the configuration file
+const [dbosConfig, ] = parseConfigFile();
+
+// Write out the .env file
+const databaseURL = `postgresql://${dbosConfig.poolConfig.user}:${dbosConfig.poolConfig.password}@${dbosConfig.poolConfig.host}:${dbosConfig.poolConfig.port}/${dbosConfig.poolConfig.database}`;
+
+try {
+  fs.writeFileSync(path.join(process.cwd(), 'prisma', '.env'), `DATABASE_URL="${databaseURL}"`);
+  console.log("Wrote database URL to the prisma/.env file.");
+} catch (error) {
+  console.error("Error writing prisma/.env file:", error.message);
+}

package/templates/hello-prisma/gitignore.template

@@ -0,0 +1,143 @@
+# DBOS-specific
+.dbos
+
+# Logs
+**/.DS_Store
+
+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-prisma/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-prisma/nodemon.json

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