@dbos-inc/dbos-sdk 1.3.2-preview → 1.3.5-preview

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbos-inc/dbos-sdk",
-  "version": "1.3.2-preview",
+  "version": "1.3.5-preview",
   "description": "A Typescript framework built on the database",
   "license": "MIT",
   "repository": {
@@ -19,8 +19,8 @@
     "lint": "eslint --fix --ext .ts --ignore-pattern foundationdb/ --ignore-pattern templates/ .",
     "lint-fdb": "eslint --fix --ext .ts --ignore-pattern templates/ .",
     "setversion": "npm run --workspaces setversion && grunt setversion",
-    "test": "npm run --workspaces test && npx prisma generate --schema tests/prisma/schema.prisma && npm run build && jest --coverage --collectCoverageFrom='src/**/*' --collectCoverageFrom='!src/foundationdb/**/*' --detectOpenHandles --testPathIgnorePatterns=examples/* --testPathIgnorePatterns=packages/* --testPathIgnorePatterns=tests/foundationdb/*",
-    "test-fdb": "npm run --workspaces test && npx prisma generate --schema tests/prisma/schema.prisma && npm run build-fdb && jest --runInBand --coverage"
+    "test": "npm run build && npm run --workspaces test && npx prisma generate --schema tests/prisma/schema.prisma && jest --coverage --collectCoverageFrom='src/**/*' --collectCoverageFrom='!src/foundationdb/**/*' --detectOpenHandles --testPathIgnorePatterns=examples/* --testPathIgnorePatterns=packages/* --testPathIgnorePatterns=tests/foundationdb/*",
+    "test-fdb": "npm run build-fdb && npm run --workspaces test && npx prisma generate --schema tests/prisma/schema.prisma && jest --runInBand --coverage"
   },
   "bin": {
     "dbos": "./dist/src/dbos-runtime/cli.js",
@@ -65,6 +65,7 @@
     "axios": "1.6.7",
     "commander": "12.0.0",
     "fast-glob": "3.3.2",
+    "kafkajs": "^2.2.4",
     "knex": "3.1.0",
     "koa": "2.15.0",
     "lodash": "4.17.21",

package/dist/src/dbos-runtime/init.d.ts

@@ -1,7 +0,0 @@
-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): Promise<void>;
-export {};
-//# sourceMappingURL=init.d.ts.map

package/dist/src/dbos-runtime/init.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../src/dbos-runtime/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,oBA6BlC,CAAA;AASD,wBAAsB,IAAI,CAAC,OAAO,EAAE,MAAM,iBAuBzC"}

package/dist/src/dbos-runtime/init.js

@@ -1,87 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.init = exports.copy = void 0;
-const fast_glob_1 = require("fast-glob");
-const path_1 = __importDefault(require("path"));
-const fs_1 = __importDefault(require("fs"));
-const child_process_1 = require("child_process");
-const error_1 = require("../error");
-const validator = __importStar(require("validator"));
-const identity = (x) => x;
-const copy = async (src, targets, dest, { rename = identity } = {}) => {
-    if (targets.length === 0 || !dest) {
-        throw new TypeError('`src` and `dest` are required');
-    }
-    const sourceFiles = await (0, fast_glob_1.async)(targets, {
-        cwd: src,
-        dot: true,
-        absolute: false,
-        stats: false,
-        ignore: ['**/node_modules/**', '**/dist/**']
-    });
-    return Promise.all(sourceFiles.map(async (p) => {
-        const dirname = path_1.default.dirname(p);
-        const basename = rename(path_1.default.basename(p));
-        const from = path_1.default.resolve(src, p);
-        const to = path_1.default.join(dest, dirname, basename);
-        // Ensure the destination directory exists
-        await fs_1.default.promises.mkdir(path_1.default.dirname(to), { recursive: true });
-        return fs_1.default.promises.copyFile(from, to);
-    }));
-};
-exports.copy = copy;
-function isValidApplicationName(appName) {
-    if (appName.length < 3 || appName.length > 30) {
-        return false;
-    }
-    return validator.matches(appName, "^[a-z0-9-_]+$");
-}
-async function init(appName) {
-    console.log("NOTE: This command is deprecated in favor of `npm create @dbos-inc` or `npx @dbos-inc/create`");
-    if (!isValidApplicationName(appName)) {
-        throw new error_1.DBOSError(`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...`);
-    }
-    if (fs_1.default.existsSync(appName)) {
-        throw new error_1.DBOSError(`Directory ${appName} already exists, exiting...`);
-    }
-    const templatePath = path_1.default.resolve(__dirname, '..', '..', '..', 'examples', 'hello');
-    const targets = ["**"];
-    await (0, exports.copy)(templatePath, targets, appName);
-    const packageJsonName = path_1.default.resolve(appName, 'package.json');
-    const packageJson = JSON.parse(fs_1.default.readFileSync(packageJsonName, 'utf-8'));
-    packageJson.name = appName;
-    fs_1.default.writeFileSync(packageJsonName, JSON.stringify(packageJson, null, 2), 'utf-8');
-    (0, child_process_1.execSync)("npm ci --no-fund", { cwd: appName, stdio: 'inherit' });
-    (0, child_process_1.execSync)("npm uninstall --no-fund @dbos-inc/dbos-sdk", { cwd: appName, stdio: 'inherit' });
-    (0, child_process_1.execSync)("npm install --no-fund --save @dbos-inc/dbos-sdk@latest", { cwd: appName, stdio: 'inherit' });
-    (0, child_process_1.execSync)("npm install --no-fund --save-dev @dbos-inc/dbos-cloud@latest", { cwd: appName, stdio: 'inherit' });
-    console.log("Application initialized successfully!");
-}
-exports.init = init;
-//# sourceMappingURL=init.js.map

package/dist/src/dbos-runtime/init.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../src/dbos-runtime/init.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAAyC;AACzC,gDAAuB;AACvB,4CAAmB;AACnB,iDAAwC;AACxC,oCAAoC;AACpC,qDAAuC;AAMvC,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAA;AAE1B,MAAM,IAAI,GAAG,KAAK,EACvB,GAAW,EACX,OAAiB,EACjB,IAAY,EACZ,EAAE,MAAM,GAAG,QAAQ,KAAiB,EAAE,EACtC,EAAE;IAEF,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,IAAA,iBAAI,EAAC,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,cAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,cAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;QAEzC,MAAM,IAAI,GAAG,cAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAClC,MAAM,EAAE,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;QAE9C,0CAA0C;QAC1C,MAAM,YAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAI,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAE9D,OAAO,YAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;IACvC,CAAC,CAAC,CACH,CAAA;AACH,CAAC,CAAA;AAjCY,QAAA,IAAI,QAiChB;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;AAEM,KAAK,UAAU,IAAI,CAAC,OAAe;IACxC,OAAO,CAAC,GAAG,CAAC,+FAA+F,CAAC,CAAC;IAC7G,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,EAAE,CAAC;QACrC,MAAM,IAAI,iBAAS,CAAC,6BAA6B,OAAO,kJAAkJ,CAAC,CAAC;IAC9M,CAAC;IAED,IAAI,YAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,iBAAS,CAAC,aAAa,OAAO,6BAA6B,CAAC,CAAC;IACzE,CAAC;IAED,MAAM,YAAY,GAAG,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IACpF,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA;IACtB,MAAM,IAAA,YAAI,EAAC,YAAY,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAE3C,MAAM,eAAe,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IAC9D,MAAM,WAAW,GAAqB,IAAI,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAqB,CAAC;IAChH,WAAW,CAAC,IAAI,GAAG,OAAO,CAAC;IAC3B,YAAE,CAAC,aAAa,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IACjF,IAAA,wBAAQ,EAAC,kBAAkB,EAAE,EAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAC,CAAC,CAAA;IAC9D,IAAA,wBAAQ,EAAC,4CAA4C,EAAE,EAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAC,CAAC,CAAA;IACxF,IAAA,wBAAQ,EAAC,wDAAwD,EAAE,EAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAC,CAAC,CAAA;IACpG,IAAA,wBAAQ,EAAC,8DAA8D,EAAE,EAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAC,CAAC,CAAA;IAC1G,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAA;AACtD,CAAC;AAvBD,oBAuBC"}

package/examples/hello/.eslintignore

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

package/examples/hello/.eslintrc

@@ -1,19 +0,0 @@
-{
-  "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/examples/hello/.vscode/extensions.json

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

package/examples/hello/.vscode/launch.json

@@ -1,22 +0,0 @@
-{
-  // 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/examples/hello/.vscode/tasks.json

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

package/examples/hello/README.md

@@ -1,50 +0,0 @@
-# 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/examples/hello/dbos-config.yaml

@@ -1,15 +0,0 @@
-# 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-sdk/main/dbos-config.schema.json
-
-database:
-  hostname: 'localhost'
-  port: 5432
-  username: 'postgres'
-  password: ${PGPASSWORD}
-  app_db_name: 'hello'
-  connectionTimeoutMillis: 3000
-  app_db_client: 'knex'
-  migrate: ['npx knex migrate:latest']
-  rollback: ['npx knex migrate:rollback']

package/examples/hello/jest.config.js

@@ -1,8 +0,0 @@
-/** @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/examples/hello/knexfile.js

@@ -1,20 +0,0 @@
-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/examples/hello/migrations/20240212161006_create_dbos_hello_tables.js

@@ -1,18 +0,0 @@
-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');
-};