@workflow/world-postgres 4.0.1-beta.2 → 4.1.0-beta.4

package/README.md

@@ -76,6 +76,39 @@ This package uses PostgreSQL with the following components:
 - **Drizzle ORM**: For database operations and schema management
 - **postgres**: For PostgreSQL client connections
 
+### Quick Setup with CLI
+
+The easiest way to set up your database is using the included CLI tool:
+
+```bash
+pnpm exec workflow-postgres-setup
+# or
+npm exec workflow-postgres-setup
+```
+
+The CLI automatically loads `.env` files and will use the connection string from:
+1. `WORKFLOW_POSTGRES_URL` environment variable
+2. `DATABASE_URL` environment variable
+3. Default: `postgres://world:world@localhost:5432/world`
+
+### Database Schema
+
+The setup creates the following tables:
+
+- `workflow_runs` - Stores workflow execution runs
+- `workflow_events` - Stores workflow events
+- `workflow_steps` - Stores individual workflow steps
+- `workflow_hooks` - Stores webhook hooks
+- `workflow_stream_chunks` - Stores streaming data chunks
+
+You can also access the schema programmatically:
+
+```typescript
+import { runs, events, steps, hooks, streams } from '@workflow/world-postgres';
+// or
+import * as schema from '@workflow/world-postgres/schema';
+```
+
 Make sure your PostgreSQL database is accessible and the user has sufficient permissions to create tables and manage jobs.
 
 ## Features

package/bin/setup.js

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+
+// Simple wrapper to run the CLI from the bin directory
+import('../dist/cli.js')
+  .then((module) => {
+    // Call the setupDatabase function
+    return module.setupDatabase();
+  })
+  .catch((err) => {
+    console.error('Failed to load CLI:', err);
+    process.exit(1);
+  });

package/dist/boss.d.ts

@@ -0,0 +1,15 @@
+import * as z from 'zod';
+/**
+/* pgboss is using JSON under the hood, so we need to base64 encode
+/* the body to ensure binary safety
+/* maybe later we can have a `blobs` table for larger payloads
+ **/
+export declare const MessageData: z.ZodObject<{
+    attempt: z.ZodNumber;
+    messageId: z.core.$ZodBranded<z.ZodString, "MessageId">;
+    idempotencyKey: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    data: z.ZodCodec<z.ZodBase64, z.ZodCustom<Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>>>;
+}, z.core.$strip>;
+export type MessageData = z.infer<typeof MessageData>;
+//# sourceMappingURL=boss.d.ts.map

package/dist/boss.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"boss.d.ts","sourceRoot":"","sources":["../src/boss.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAGzB;;;;IAII;AACJ,eAAO,MAAM,WAAW;;;;;;iBAUtB,CAAC;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC"}

package/dist/boss.js

@@ -0,0 +1,18 @@
+import { MessageId } from '@workflow/world';
+import * as z from 'zod';
+import { Base64Buffer } from './zod.js';
+/**
+/* pgboss is using JSON under the hood, so we need to base64 encode
+/* the body to ensure binary safety
+/* maybe later we can have a `blobs` table for larger payloads
+ **/
+export const MessageData = z.object({
+    attempt: z.number().describe('The attempt number of the message'),
+    messageId: MessageId.describe('The unique ID of the message'),
+    idempotencyKey: z.string().optional(),
+    id: z
+        .string()
+        .describe("The ID of the sub-queue. For workflows, it's the workflow name. For steps, it's the step name."),
+    data: Base64Buffer.describe('The message that was sent'),
+});
+//# sourceMappingURL=boss.js.map

package/dist/boss.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"boss.js","sourceRoot":"","sources":["../src/boss.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAExC;;;;IAII;AACJ,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,mCAAmC,CAAC;IACjE,SAAS,EAAE,SAAS,CAAC,QAAQ,CAAC,8BAA8B,CAAC;IAC7D,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,EAAE,EAAE,CAAC;SACF,MAAM,EAAE;SACR,QAAQ,CACP,gGAAgG,CACjG;IACH,IAAI,EAAE,YAAY,CAAC,QAAQ,CAAC,2BAA2B,CAAC;CACzD,CAAC,CAAC"}

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+declare function setupDatabase(): Promise<void>;
+export { setupDatabase };
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAQA,iBAAe,aAAa,kBA+C3B;AAOD,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/dist/cli.js

@@ -0,0 +1,44 @@
+import { readFile } from 'node:fs/promises';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { config } from 'dotenv';
+import postgres from 'postgres';
+const __dirname = dirname(fileURLToPath(import.meta.url));
+async function setupDatabase() {
+    // Load .env file if it exists
+    config();
+    const connectionString = process.env.WORKFLOW_POSTGRES_URL ||
+        process.env.DATABASE_URL ||
+        'postgres://world:world@localhost:5432/world';
+    console.log('🔧 Setting up database schema...');
+    console.log(`📍 Connection: ${connectionString.replace(/^(\w+:\/\/)([^@]+)@/, '$1[redacted]@')}`);
+    try {
+        const sql = postgres(connectionString);
+        // Read the migration SQL file
+        // The migrations are in src/drizzle/migrations, and this CLI is in dist/
+        // So we need to go up one level from dist/ to reach src/
+        const migrationPath = join(__dirname, '..', 'src', 'drizzle', 'migrations', '0000_redundant_smasher.sql');
+        const migrationSQL = await readFile(migrationPath, 'utf-8');
+        // Execute the migration
+        await sql.unsafe(migrationSQL);
+        console.log('✅ Database schema created successfully!');
+        console.log('\nCreated tables:');
+        console.log('  - workflow_runs');
+        console.log('  - workflow_events');
+        console.log('  - workflow_steps');
+        console.log('  - workflow_hooks');
+        console.log('  - workflow_stream_chunks');
+        await sql.end();
+        process.exit(0);
+    }
+    catch (error) {
+        console.error('❌ Failed to setup database:', error);
+        process.exit(1);
+    }
+}
+// Check if running as main module
+if (import.meta.url === `file://${process.argv[1]}`) {
+    setupDatabase();
+}
+export { setupDatabase };
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,QAAQ,MAAM,UAAU,CAAC;AAEhC,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAE1D,KAAK,UAAU,aAAa;IAC1B,8BAA8B;IAC9B,MAAM,EAAE,CAAC;IAET,MAAM,gBAAgB,GACpB,OAAO,CAAC,GAAG,CAAC,qBAAqB;QACjC,OAAO,CAAC,GAAG,CAAC,YAAY;QACxB,6CAA6C,CAAC;IAEhD,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;IAChD,OAAO,CAAC,GAAG,CACT,kBAAkB,gBAAgB,CAAC,OAAO,CAAC,qBAAqB,EAAE,eAAe,CAAC,EAAE,CACrF,CAAC;IAEF,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QAEvC,8BAA8B;QAC9B,yEAAyE;QACzE,yDAAyD;QACzD,MAAM,aAAa,GAAG,IAAI,CACxB,SAAS,EACT,IAAI,EACJ,KAAK,EACL,SAAS,EACT,YAAY,EACZ,4BAA4B,CAC7B,CAAC;QACF,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAE5D,wBAAwB;QACxB,MAAM,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAE/B,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;QACvD,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QACjC,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;QACjC,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;QACnC,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;QAClC,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;QAClC,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;QAE1C,MAAM,GAAG,CAAC,GAAG,EAAE,CAAC;QAChB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,6BAA6B,EAAE,KAAK,CAAC,CAAC;QACpD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED,kCAAkC;AAClC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,UAAU,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IACpD,aAAa,EAAE,CAAC;AAClB,CAAC;AAED,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/dist/config.d.ts

@@ -0,0 +1,6 @@
+export interface PostgresWorldConfig {
+    connectionString: string;
+    jobPrefix?: string;
+    queueConcurrency?: number;
+}
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,mBAAmB;IAClC,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B"}

package/dist/config.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

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

package/dist/drizzle/index.d.ts

@@ -0,0 +1,6 @@
+import type Postgres from 'postgres';
+import * as Schema from './schema.js';
+export { Schema };
+export type Drizzle = ReturnType<typeof createClient>;
+export declare function createClient(postgres: Postgres.Sql): import("drizzle-orm/postgres-js").PostgresJsDatabase<typeof Schema>;
+//# sourceMappingURL=index.d.ts.map

package/dist/drizzle/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/drizzle/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,QAAQ,MAAM,UAAU,CAAC;AACrC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AAEtC,OAAO,EAAE,MAAM,EAAE,CAAC;AAElB,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC;AACtD,wBAAgB,YAAY,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,uEAElD"}

package/dist/drizzle/index.js

@@ -0,0 +1,7 @@
+import { drizzle } from 'drizzle-orm/postgres-js';
+import * as Schema from './schema.js';
+export { Schema };
+export function createClient(postgres) {
+    return drizzle(postgres, { schema: Schema });
+}
+//# sourceMappingURL=index.js.map

package/dist/drizzle/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/drizzle/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAElD,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AAEtC,OAAO,EAAE,MAAM,EAAE,CAAC;AAGlB,MAAM,UAAU,YAAY,CAAC,QAAsB;IACjD,OAAO,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;AAC/C,CAAC"}