@dbos-inc/create 1.8.12-preview → 1.8.13-preview

package/templates/hello-typeorm/README.md

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

package/templates/hello-typeorm/datasource.ts

@@ -0,0 +1,27 @@
+import { parseConfigFile } from '@dbos-inc/dbos-sdk/dist/src/dbos-runtime/config';
+import { TlsOptions } from 'tls';
+import { DataSource } from "typeorm";
+
+const [dbosConfig, ] = parseConfigFile();
+
+const AppDataSource = new DataSource({
+    type: 'postgres',
+    host: dbosConfig.poolConfig.host,
+    port: dbosConfig.poolConfig.port,
+    username: dbosConfig.poolConfig.user,
+    password: dbosConfig.poolConfig.password as string,
+    database: dbosConfig.poolConfig.database,
+    ssl: dbosConfig.poolConfig.ssl as TlsOptions,
+    entities: ['dist/entities/*.js'],
+    migrations: ['dist/migrations/*.js'],
+});
+
+AppDataSource.initialize()
+    .then(() => {
+        console.log("Data Source has been initialized!");
+    })
+    .catch((err) => {
+        console.error("Error during Data Source initialization", err);
+    });
+
+export default AppDataSource;

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

@@ -0,0 +1,20 @@
+# 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_typeorm'
+  password: ${PGPASSWORD}
+  connectionTimeoutMillis: 3000
+  app_db_client: typeorm
+  migrate:
+    - npx typeorm migration:run -d dist/datasource.js
+  rollback:
+    - npx typeorm migration:revert -d dist/datasource.js
+runtimeConfig:
+  entrypoints:
+    - dist/src/operations.js

package/templates/hello-typeorm/entities/DBOSHello.ts

@@ -0,0 +1,10 @@
+import { Entity, PrimaryGeneratedColumn, Column } from "typeorm";
+
+@Entity()
+export class DBOSHello {
+    @PrimaryGeneratedColumn()
+    greeting_id: number = 0;
+
+    @Column()
+    greeting: string = "greeting";
+}

package/templates/hello-typeorm/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-typeorm/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-typeorm/migrations/1714934318136-DBOSHello.ts

@@ -0,0 +1,19 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+// This migration file was automatically generated from the project entity files (entities/*.ts).
+// This was done by running on an empty database the command: `npx typeorm migration:generate -d dist/datasource.js migrations/DBOSHello`
+// This file creates the schema defined in the entity files.
+// For more information on schema management with TypeORM and DBOS, see our docs: https://docs.dbos.dev/tutorials/using-typeorm
+
+export class DBOSHello1714934318136 implements MigrationInterface {
+    name = 'DBOSHello1714934318136';
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`CREATE TABLE "dbos_hello" ("greeting_id" SERIAL NOT NULL, "greeting" character varying NOT NULL, CONSTRAINT "PK_12681863ff5f1fd5ea35f185b51" PRIMARY KEY ("greeting_id"))`);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`DROP TABLE "dbos_hello"`);
+    }
+
+}

package/templates/hello-typeorm/nodemon.json

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