@dbos-inc/create 0.0.0-placeholder

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import { init } from './init.js';
+import fs from 'fs';
+import path from "path";
+const program = new Command();
+////////////////////////
+/* LOCAL DEVELOPMENT  */
+////////////////////////
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+import { fileURLToPath } from 'url';
+const __dirname = fileURLToPath(new URL('.', import.meta.url));
+const packageJson = JSON.parse(fs.readFileSync(path.join(__dirname, "..", "package.json")).toString());
+program.version(packageJson.version);
+program
+    .description('Init a DBOS application')
+    .option('-n, --appName <application-name>', 'Application name', 'dbos-hello-app')
+    .option('-t, --template <template name>', 'Name of template application to copy', 'hello')
+    .action(async (options) => {
+    await init(options.appName, options.template);
+});
+// If no arguments provided, display help by default
+if (!process.argv.slice(2).length) {
+    program.outputHelp();
+}
+else {
+    program.parse(process.argv);
+}
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,MAAM,IAAI,CAAA;AACnB,OAAO,IAAI,MAAM,MAAM,CAAC;AAGxB,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,wBAAwB;AACxB,wBAAwB;AACxB,wBAAwB;AAExB,8DAA8D;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AACpC,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC/D,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAY,CAAC;AAClH,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAErC,OAAO;KACJ,WAAW,CAAC,yBAAyB,CAAC;KACtC,MAAM,CAAC,kCAAkC,EAAE,kBAAkB,EAAE,gBAAgB,CAAC;KAChF,MAAM,CAAC,gCAAgC,EAAE,sCAAsC,EAAE,OAAO,CAAC;KACzF,MAAM,CAAC,KAAK,EAAE,OAA8C,EAAE,EAAE;IAC/D,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;AAChD,CAAC,CAAC,CAAC;AAEL,oDAAoD;AACpD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAClC,OAAO,CAAC,UAAU,EAAE,CAAC;AACvB,CAAC;KACI,CAAC;IACJ,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC"}

package/dist/init.d.ts

@@ -0,0 +1,7 @@
+interface CopyOption {
+    rename?: (basename: string) => string;
+}
+export declare const copy: (src: string, targets: string[], dest: string, { rename }?: CopyOption) => Promise<void[]>;
+export declare function init(appName: string, templateName: string): Promise<void>;
+export {};
+//# sourceMappingURL=init.d.ts.map

package/dist/init.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../init.ts"],"names":[],"mappings":"AAOA,UAAU,UAAU;IAClB,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAA;CACtC;AAID,eAAO,MAAM,IAAI,QACV,MAAM,WACF,MAAM,EAAE,QACX,MAAM,eACW,UAAU,oBA4BlC,CAAA;AASD,wBAAsB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,iBA2B/D"}

package/dist/init.js

@@ -0,0 +1,59 @@
+import glob from 'fast-glob';
+import path from 'path';
+import fs from 'fs';
+import { execSync } from 'child_process';
+import validator from 'validator';
+import { fileURLToPath } from 'url';
+const identity = (x) => x;
+export const copy = async (src, targets, dest, { rename = identity } = {}) => {
+    if (targets.length === 0 || !dest) {
+        throw new TypeError('`src` and `dest` are required');
+    }
+    const sourceFiles = await glob(targets, {
+        cwd: src,
+        dot: true,
+        absolute: false,
+        stats: false,
+        ignore: ['**/node_modules/**', '**/dist/**']
+    });
+    return Promise.all(sourceFiles.map(async (p) => {
+        const dirname = path.dirname(p);
+        const basename = rename(path.basename(p));
+        const from = path.resolve(src, p);
+        const to = path.join(dest, dirname, basename);
+        // Ensure the destination directory exists
+        await fs.promises.mkdir(path.dirname(to), { recursive: true });
+        return fs.promises.copyFile(from, to);
+    }));
+};
+function isValidApplicationName(appName) {
+    if (appName.length < 3 || appName.length > 30) {
+        return false;
+    }
+    return validator.matches(appName, "^[a-z0-9-_]+$");
+}
+export async function init(appName, templateName) {
+    if (!isValidApplicationName(appName)) {
+        throw new Error(`Invalid application name: ${appName}. Application name must be between 3 and 30 characters long and can only contain lowercase letters, numbers, hyphens and underscores. Exiting...`);
+    }
+    const __dirname = fileURLToPath(new URL('.', import.meta.url));
+    const templatePath = path.resolve(__dirname, '..', 'templates', templateName);
+    if (!fs.existsSync(templatePath)) {
+        throw new Error(`Template does not exist: ${templateName}. Exiting...`);
+    }
+    if (fs.existsSync(appName)) {
+        throw new Error(`Directory ${appName} already exists, exiting...`);
+    }
+    const targets = ["**"];
+    await copy(templatePath, targets, appName);
+    const packageJsonName = path.resolve(appName, 'package.json');
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonName, 'utf-8'));
+    packageJson.name = appName;
+    fs.writeFileSync(packageJsonName, JSON.stringify(packageJson, null, 2), 'utf-8');
+    execSync("npm ci --no-fund", { cwd: appName, stdio: 'inherit' });
+    execSync("npm uninstall --no-fund @dbos-inc/dbos-sdk", { cwd: appName, stdio: 'inherit' });
+    execSync("npm install --no-fund --save @dbos-inc/dbos-sdk@latest", { cwd: appName, stdio: 'inherit' });
+    execSync("npm install --no-fund --save-dev @dbos-inc/dbos-cloud@latest", { cwd: appName, stdio: 'inherit' });
+    console.log("Application initialized successfully!");
+}
+//# sourceMappingURL=init.js.map

package/dist/init.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../init.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAA;AAC5B,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAE,MAAM,IAAI,CAAA;AACnB,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,SAAS,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAMpC,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAA;AAEjC,MAAM,CAAC,MAAM,IAAI,GAAG,KAAK,EACvB,GAAW,EACX,OAAiB,EACjB,IAAY,EACZ,EAAE,MAAM,GAAG,QAAQ,KAAiB,EAAE,EACtC,EAAE;IACF,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAClC,MAAM,IAAI,SAAS,CAAC,+BAA+B,CAAC,CAAA;IACtD,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE;QACtC,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,IAAI;QACT,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,KAAK;QACZ,MAAM,EAAE,CAAC,oBAAoB,EAAE,YAAY,CAAC;KAC7C,CAAC,CAAA;IAEF,OAAO,OAAO,CAAC,GAAG,CAChB,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;QAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;QAEzC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAClC,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;QAE9C,0CAA0C;QAC1C,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAE9D,OAAO,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;IACvC,CAAC,CAAC,CACH,CAAA;AACH,CAAC,CAAA;AAED,SAAS,sBAAsB,CAAC,OAAe;IAC7C,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QAC9C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,OAAe,EAAE,YAAoB;IAC9D,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,KAAK,CAAC,6BAA6B,OAAO,kJAAkJ,CAAC,CAAC;IAC1M,CAAC;IAED,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/D,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;IAC9E,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,4BAA4B,YAAY,cAAc,CAAC,CAAC;IAC1E,CAAC;IAED,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,aAAa,OAAO,6BAA6B,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA;IACtB,MAAM,IAAI,CAAC,YAAY,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAE3C,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IAC9D,MAAM,WAAW,GAAqB,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAqB,CAAC;IAChH,WAAW,CAAC,IAAI,GAAG,OAAO,CAAC;IAC3B,EAAE,CAAC,aAAa,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACjF,QAAQ,CAAC,kBAAkB,EAAE,EAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAC,CAAC,CAAA;IAC9D,QAAQ,CAAC,4CAA4C,EAAE,EAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAC,CAAC,CAAA;IACxF,QAAQ,CAAC,wDAAwD,EAAE,EAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAC,CAAC,CAAA;IACpG,QAAQ,CAAC,8DAA8D,EAAE,EAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAC,CAAC,CAAA;IAC1G,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAA;AACtD,CAAC"}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@dbos-inc/create",
+  "version": "0.0.0-placeholder",
+  "description": "Tool for performing project initialization from template",
+  "license": "MIT",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dbos-inc/dbos-ts",
+    "directory": "packages/create"
+  },
+  "homepage": "https://docs.dbos.dev/",
+  "scripts": {
+    "build": "tsc --project tsconfig.json",
+    "test": "echo \"No tests\"",
+    "setversion": "grunt setversion"
+  },
+  "bin": {
+    "create": "./dist/cli.js"
+  },
+  "devDependencies": {
+    "@types/node": "^20.6.3",
+    "@types/prompt-sync": "^4.2.3",
+    "@types/update-notifier": "^6.0.8",
+    "@types/validator": "^13.11.9",
+    "grunt": "^1.6.1",
+    "nerdbank-gitversioning": "^3.6.133",
+    "typescript": "^5.3.3"
+  },
+  "dependencies": {
+    "axios": "^1.6.7",
+    "chalk": "4.1.2",
+    "commander": "^12.0.0",
+    "fast-glob": "^3.3.2",
+    "open": "^10.1.0",
+    "prompt-sync": "^4.2.0",
+    "update-notifier": "^7.0.0",
+    "validator": "^13.11.0",
+    "winston": "^3.12.0",
+    "winston-transport": "^4.7.0"
+  }
+}

package/templates/hello/.eslintignore

@@ -0,0 +1,4 @@
+dist
+*.test.ts
+jest.config.js
+

package/templates/hello/.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/.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+	// See http://go.microsoft.com/fwlink/?LinkId=827846
+	// for the documentation about the extensions.json format
+	"recommendations": [
+		"dbos-inc.dbos-ttdbg"
+	]
+}

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

@@ -0,0 +1,22 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node-terminal",
+      "request": "launch",
+      "name": "Local Debug",
+      "command": "npx dbos-sdk start",
+      "preLaunchTask": "npm: build",
+    },
+    {
+      "type": "node-terminal",
+      "request": "launch",
+      "name": "Time Travel Debug",
+      "command": "npx dbos-sdk debug -x ${command:dbos-ttdbg.get-proxy-url} -u ${command:dbos-ttdbg.pick-workflow-id}",
+      "preLaunchTask": "npm: build"
+    }
+  ]
+}

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

@@ -0,0 +1,17 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "npm: build",
+      "type": "npm",
+      "script": "build",
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "problemMatcher": [
+        "$tsc"
+      ]
+    }
+  ]
+}

package/templates/hello/README.md

@@ -0,0 +1,50 @@
+# DBOS Hello
+
+This is a [DBOS app](https://docs.dbos.dev/) bootstrapped with `npx @dbos-inc/dbos-sdk init`.
+
+## 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.
+On Linux or Mac, run:
+
+```bash
+export PGPASSWORD=dbos
+./start_postgres_docker.sh
+```
+
+On Windows (cmd), run:
+
+```cmd
+set PGPASSWORD=dbos
+start_postgres_docker.bat
+```
+
+If successful, the script should print `Database started successfully!`.
+
+Then, let's run a schema migration to create some tables:
+
+```bash
+npx dbos-sdk migrate
+```
+
+If successful, the migration should print `Migration successful!`.
+
+Next, build and run the app:
+
+```bash
+npm run build
+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 re-build and re-start it. 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-sdk).

package/templates/hello/knexfile.js

@@ -0,0 +1,20 @@
+const { parseConfigFile } = require('@dbos-inc/dbos-sdk/dist/src/dbos-runtime/config');
+const { DBOSConfig } = require('@dbos-inc/dbos-sdk/dist/src/dbos-executor');
+
+const [dbosConfig, ] = parseConfigFile();
+
+const config = {
+  client: 'pg',
+  connection: {
+    host: dbosConfig.poolConfig.host,
+    user: dbosConfig.poolConfig.user,
+    password: dbosConfig.poolConfig.password,
+    database: dbosConfig.poolConfig.database,
+    ssl: dbosConfig.poolConfig.ssl,
+  },
+  migrations: {
+    directory: './migrations'
+  }
+};
+
+module.exports = config;

package/templates/hello/migrations/20240212161006_create_dbos_hello_tables.js

@@ -0,0 +1,18 @@
+const { Knex } = require("knex");
+
+exports.up = async function(knex) {
+  await knex.schema.createTable('dbos_hello', table => {
+    table.text('name').primary();
+    table.integer('greet_count').defaultTo(0);
+  });
+
+  return knex.schema.createTable('dbos_greetings', table => {
+    table.text('greeting_name');
+    table.text('greeting_note_content');
+  });
+};
+
+exports.down = async function(knex) {
+  await knex.schema.dropTable('dbos_greetings');
+  return knex.schema.dropTable('dbos_hello');
+};