@tanstack/workflow-store-drizzle-postgres 0.0.1 → 0.0.3

package/README.md

@@ -4,6 +4,8 @@ Experimental Drizzle/Postgres durable execution store for TanStack Workflow.
 
 See the main [Persistence guide](../../docs/guide/persistence.md) and
 [Store adapters API](../../docs/api/store-adapters.md).
+Maintainers changing the durable schema should follow
+[SCHEMA_MIGRATIONS.md](./SCHEMA_MIGRATIONS.md).
 
 This adapter implements the `WorkflowExecutionStore` contract from
 `@tanstack/workflow-runtime`. Drizzle is only the database execution surface; the
@@ -21,6 +23,18 @@ import { createDrizzlePostgresWorkflowStore } from '@tanstack/workflow-store-dri
 
 const db = drizzle(pool)
 const store = createDrizzlePostgresWorkflowStore({ db })
+```
+
+Apply the package-owned migration during setup/deploy:
 
-await store.ensureSchema()
+```bash
+psql "$DATABASE_URL" -f node_modules/@tanstack/workflow-store-drizzle-postgres/migrations/0000_workflow_store.sql
 ```
+
+`store.ensureSchema()` remains available for tests, local demos, and explicit
+admin bootstrap scripts. Production deploys should prefer the published SQL
+migration artifact so schema changes are reviewed and repeatable.
+
+The migration creates `workflow_schema_migrations` and records the applied
+Workflow store migration ID. Future schema changes will ship as additional
+numbered SQL files in this package.

package/SCHEMA_MIGRATIONS.md

@@ -0,0 +1,85 @@
+# Drizzle/Postgres Store Schema Migrations
+
+`@tanstack/workflow-store-drizzle-postgres` owns the durable Workflow store
+schema. Applications should apply package-owned migrations instead of copying
+`workflow_*` tables into their own Drizzle schema.
+
+## When to Version
+
+Create a changeset for this package whenever a change affects:
+
+- SQL migration files in `migrations/`
+- generated migration helpers in `src/migrations.ts`
+- store schema statements in `src/schema-contract.ts`
+- exported Drizzle table definitions in `src/tables.ts`
+- runtime code that expects a different table, column, index, or lock shape
+
+Use a patch changeset for backward-compatible additive schema changes. Use a
+minor or major changeset when an upgrade requires coordinated application action
+or cannot be safely rolled out with the previous runtime/store version.
+
+## Adding a Migration
+
+1. Add the next numbered SQL file under `migrations/`, for example
+   `0001_add_retention_indexes.sql`.
+2. Make the SQL idempotent where possible:
+   - use `create table if not exists`
+   - use `create index if not exists`
+   - prefer additive columns/indexes before destructive changes
+3. Insert a row into `workflow_schema_migrations` from the migration:
+
+   ```sql
+   insert into "workflow_schema_migrations" (
+     migration_id,
+     package_name,
+     package_version,
+     applied_at
+   )
+   values (
+     '0001_add_retention_indexes',
+     '@tanstack/workflow-store-drizzle-postgres',
+     null,
+     (extract(epoch from now()) * 1000)::bigint
+   )
+   on conflict (migration_id) do nothing;
+   ```
+
+4. Update `src/schema-contract.ts` so fresh installs get the same final schema.
+5. Update `src/migrations.ts` so programmatic migration helpers expose the new
+   migration in order.
+6. Update optional typed table exports in `src/tables.ts` if table definitions
+   changed.
+7. Update docs that mention production setup or compatibility.
+8. Add or update tests that verify:
+   - generated SQL matches the checked-in SQL artifact
+   - `ensureSchema()` creates the same final schema for local/test bootstrap
+   - the migration is recorded in `workflow_schema_migrations`
+
+## Compatibility Rules
+
+- Runtime and host adapters assume the durable store schema already exists.
+- Production deploys should apply package-owned SQL migrations before rolling
+  out a store adapter version that expects them.
+- `ensureSchema()` is for tests, local demos, and explicit admin/bootstrap
+  scripts. Do not call it from request handlers, scheduled sweeps, or cron
+  ticks.
+- Apps may import the optional Drizzle table definitions for diagnostics/admin
+  reads, but normal runtime use should not require app-owned `workflow_*` table
+  declarations.
+
+## Verification
+
+Run these checks before handing off schema work:
+
+```bash
+pnpm --filter @tanstack/workflow-store-drizzle-postgres test:lib
+pnpm --filter @tanstack/workflow-store-drizzle-postgres test:types
+pnpm --filter @tanstack/workflow-store-drizzle-postgres test:eslint
+pnpm --filter @tanstack/workflow-store-drizzle-postgres build
+pnpm --filter @tanstack/workflow-store-drizzle-postgres pack --dry-run
+pnpm test:docs
+pnpm test:knip
+pnpm test:sherif
+```
+
+Confirm the dry-run tarball includes every SQL file under `migrations/`.

package/dist/index.cjs

@@ -1,5 +1,22 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_schema_contract = require('./schema-contract.cjs');
 const require_store = require('./store.cjs');
+const require_migrations = require('./migrations.cjs');
+const require_tables = require('./tables.cjs');
 
 exports.createDrizzlePostgresWorkflowStore = require_store.createDrizzlePostgresWorkflowStore;
-exports.defaultDrizzlePostgresWorkflowStoreTables = require_store.defaultDrizzlePostgresWorkflowStoreTables;
+exports.defaultDrizzlePostgresWorkflowStoreTables = require_schema_contract.defaultDrizzlePostgresWorkflowStoreTables;
+exports.drizzlePostgresWorkflowStoreSchemaVersion = require_migrations.drizzlePostgresWorkflowStoreSchemaVersion;
+exports.getDrizzlePostgresWorkflowStoreMigrationSql = require_migrations.getDrizzlePostgresWorkflowStoreMigrationSql;
+exports.getDrizzlePostgresWorkflowStoreMigrations = require_migrations.getDrizzlePostgresWorkflowStoreMigrations;
+exports.getDrizzlePostgresWorkflowStoreSchemaStatements = require_schema_contract.getDrizzlePostgresWorkflowStoreSchemaStatements;
+exports.resolveDrizzlePostgresWorkflowStoreTables = require_schema_contract.resolveDrizzlePostgresWorkflowStoreTables;
+exports.workflowEventLocks = require_tables.workflowEventLocks;
+exports.workflowEvents = require_tables.workflowEvents;
+exports.workflowRunStates = require_tables.workflowRunStates;
+exports.workflowRuns = require_tables.workflowRuns;
+exports.workflowScheduleBuckets = require_tables.workflowScheduleBuckets;
+exports.workflowSchedules = require_tables.workflowSchedules;
+exports.workflowSchemaMigrations = require_tables.workflowSchemaMigrations;
+exports.workflowSignalDeliveries = require_tables.workflowSignalDeliveries;
+exports.workflowTimers = require_tables.workflowTimers;

package/dist/index.d.cts

@@ -1,2 +1,5 @@
-import { DrizzlePostgresDatabase, DrizzlePostgresWorkflowStore, DrizzlePostgresWorkflowStoreOptions, DrizzlePostgresWorkflowStoreTables, createDrizzlePostgresWorkflowStore, defaultDrizzlePostgresWorkflowStoreTables } from "./store.cjs";
-export { type DrizzlePostgresDatabase, type DrizzlePostgresWorkflowStore, type DrizzlePostgresWorkflowStoreOptions, type DrizzlePostgresWorkflowStoreTables, createDrizzlePostgresWorkflowStore, defaultDrizzlePostgresWorkflowStoreTables };
+import { DrizzlePostgresWorkflowStoreSchemaOptions, DrizzlePostgresWorkflowStoreTables, defaultDrizzlePostgresWorkflowStoreTables, getDrizzlePostgresWorkflowStoreSchemaStatements, resolveDrizzlePostgresWorkflowStoreTables } from "./schema-contract.cjs";
+import { DrizzlePostgresDatabase, DrizzlePostgresWorkflowStore, DrizzlePostgresWorkflowStoreOptions, createDrizzlePostgresWorkflowStore } from "./store.cjs";
+import { DrizzlePostgresWorkflowStoreMigration, drizzlePostgresWorkflowStoreSchemaVersion, getDrizzlePostgresWorkflowStoreMigrationSql, getDrizzlePostgresWorkflowStoreMigrations } from "./migrations.cjs";
+import { workflowEventLocks, workflowEvents, workflowRunStates, workflowRuns, workflowScheduleBuckets, workflowSchedules, workflowSchemaMigrations, workflowSignalDeliveries, workflowTimers } from "./tables.cjs";
+export { type DrizzlePostgresDatabase, type DrizzlePostgresWorkflowStore, type DrizzlePostgresWorkflowStoreMigration, type DrizzlePostgresWorkflowStoreOptions, type DrizzlePostgresWorkflowStoreSchemaOptions, type DrizzlePostgresWorkflowStoreTables, createDrizzlePostgresWorkflowStore, defaultDrizzlePostgresWorkflowStoreTables, drizzlePostgresWorkflowStoreSchemaVersion, getDrizzlePostgresWorkflowStoreMigrationSql, getDrizzlePostgresWorkflowStoreMigrations, getDrizzlePostgresWorkflowStoreSchemaStatements, resolveDrizzlePostgresWorkflowStoreTables, workflowEventLocks, workflowEvents, workflowRunStates, workflowRuns, workflowScheduleBuckets, workflowSchedules, workflowSchemaMigrations, workflowSignalDeliveries, workflowTimers };

package/dist/index.d.ts

@@ -1,2 +1,5 @@
-import { DrizzlePostgresDatabase, DrizzlePostgresWorkflowStore, DrizzlePostgresWorkflowStoreOptions, DrizzlePostgresWorkflowStoreTables, createDrizzlePostgresWorkflowStore, defaultDrizzlePostgresWorkflowStoreTables } from "./store.js";
-export { type DrizzlePostgresDatabase, type DrizzlePostgresWorkflowStore, type DrizzlePostgresWorkflowStoreOptions, type DrizzlePostgresWorkflowStoreTables, createDrizzlePostgresWorkflowStore, defaultDrizzlePostgresWorkflowStoreTables };
+import { DrizzlePostgresWorkflowStoreSchemaOptions, DrizzlePostgresWorkflowStoreTables, defaultDrizzlePostgresWorkflowStoreTables, getDrizzlePostgresWorkflowStoreSchemaStatements, resolveDrizzlePostgresWorkflowStoreTables } from "./schema-contract.js";
+import { DrizzlePostgresDatabase, DrizzlePostgresWorkflowStore, DrizzlePostgresWorkflowStoreOptions, createDrizzlePostgresWorkflowStore } from "./store.js";
+import { DrizzlePostgresWorkflowStoreMigration, drizzlePostgresWorkflowStoreSchemaVersion, getDrizzlePostgresWorkflowStoreMigrationSql, getDrizzlePostgresWorkflowStoreMigrations } from "./migrations.js";
+import { workflowEventLocks, workflowEvents, workflowRunStates, workflowRuns, workflowScheduleBuckets, workflowSchedules, workflowSchemaMigrations, workflowSignalDeliveries, workflowTimers } from "./tables.js";
+export { type DrizzlePostgresDatabase, type DrizzlePostgresWorkflowStore, type DrizzlePostgresWorkflowStoreMigration, type DrizzlePostgresWorkflowStoreOptions, type DrizzlePostgresWorkflowStoreSchemaOptions, type DrizzlePostgresWorkflowStoreTables, createDrizzlePostgresWorkflowStore, defaultDrizzlePostgresWorkflowStoreTables, drizzlePostgresWorkflowStoreSchemaVersion, getDrizzlePostgresWorkflowStoreMigrationSql, getDrizzlePostgresWorkflowStoreMigrations, getDrizzlePostgresWorkflowStoreSchemaStatements, resolveDrizzlePostgresWorkflowStoreTables, workflowEventLocks, workflowEvents, workflowRunStates, workflowRuns, workflowScheduleBuckets, workflowSchedules, workflowSchemaMigrations, workflowSignalDeliveries, workflowTimers };

package/dist/index.js

@@ -1,3 +1,6 @@
-import { createDrizzlePostgresWorkflowStore, defaultDrizzlePostgresWorkflowStoreTables } from "./store.js";
+import { defaultDrizzlePostgresWorkflowStoreTables, getDrizzlePostgresWorkflowStoreSchemaStatements, resolveDrizzlePostgresWorkflowStoreTables } from "./schema-contract.js";
+import { createDrizzlePostgresWorkflowStore } from "./store.js";
+import { drizzlePostgresWorkflowStoreSchemaVersion, getDrizzlePostgresWorkflowStoreMigrationSql, getDrizzlePostgresWorkflowStoreMigrations } from "./migrations.js";
+import { workflowEventLocks, workflowEvents, workflowRunStates, workflowRuns, workflowScheduleBuckets, workflowSchedules, workflowSchemaMigrations, workflowSignalDeliveries, workflowTimers } from "./tables.js";
 
-export { createDrizzlePostgresWorkflowStore, defaultDrizzlePostgresWorkflowStoreTables };
+export { createDrizzlePostgresWorkflowStore, defaultDrizzlePostgresWorkflowStoreTables, drizzlePostgresWorkflowStoreSchemaVersion, getDrizzlePostgresWorkflowStoreMigrationSql, getDrizzlePostgresWorkflowStoreMigrations, getDrizzlePostgresWorkflowStoreSchemaStatements, resolveDrizzlePostgresWorkflowStoreTables, workflowEventLocks, workflowEvents, workflowRunStates, workflowRuns, workflowScheduleBuckets, workflowSchedules, workflowSchemaMigrations, workflowSignalDeliveries, workflowTimers };

package/dist/migrations.cjs

@@ -0,0 +1,23 @@
+const require_schema_contract = require('./schema-contract.cjs');
+
+//#region src/migrations.ts
+const drizzlePostgresWorkflowStoreSchemaVersion = "0000_workflow_store";
+function getDrizzlePostgresWorkflowStoreMigrations(options) {
+	const statements = require_schema_contract.getDrizzlePostgresWorkflowStoreSchemaStatements(options);
+	return [{
+		id: "0000_workflow_store",
+		name: "Create TanStack Workflow Drizzle/Postgres store tables",
+		order: 0,
+		statements,
+		sql: `${statements.join(";\n\n")};\n`
+	}];
+}
+function getDrizzlePostgresWorkflowStoreMigrationSql(options) {
+	return getDrizzlePostgresWorkflowStoreMigrations(options)[0].sql;
+}
+
+//#endregion
+exports.drizzlePostgresWorkflowStoreSchemaVersion = drizzlePostgresWorkflowStoreSchemaVersion;
+exports.getDrizzlePostgresWorkflowStoreMigrationSql = getDrizzlePostgresWorkflowStoreMigrationSql;
+exports.getDrizzlePostgresWorkflowStoreMigrations = getDrizzlePostgresWorkflowStoreMigrations;
+//# sourceMappingURL=migrations.cjs.map

package/dist/migrations.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrations.cjs","names":["getDrizzlePostgresWorkflowStoreSchemaStatements"],"sources":["../src/migrations.ts"],"sourcesContent":["import { getDrizzlePostgresWorkflowStoreSchemaStatements } from './schema-contract'\nimport type { DrizzlePostgresWorkflowStoreSchemaOptions } from './schema-contract'\n\nexport interface DrizzlePostgresWorkflowStoreMigration {\n  id: string\n  name: string\n  order: number\n  statements: Array<string>\n  sql: string\n}\n\nexport const drizzlePostgresWorkflowStoreSchemaVersion = '0000_workflow_store'\n\nexport function getDrizzlePostgresWorkflowStoreMigrations(\n  options?: DrizzlePostgresWorkflowStoreSchemaOptions,\n): Array<DrizzlePostgresWorkflowStoreMigration> {\n  const statements = getDrizzlePostgresWorkflowStoreSchemaStatements(options)\n\n  return [\n    {\n      id: '0000_workflow_store',\n      name: 'Create TanStack Workflow Drizzle/Postgres store tables',\n      order: 0,\n      statements,\n      sql: `${statements.join(';\\n\\n')};\\n`,\n    },\n  ]\n}\n\nexport function getDrizzlePostgresWorkflowStoreMigrationSql(\n  options?: DrizzlePostgresWorkflowStoreSchemaOptions,\n): string {\n  return getDrizzlePostgresWorkflowStoreMigrations(options)[0]!.sql\n}\n"],"mappings":";;;AAWA,MAAa,4CAA4C;AAEzD,SAAgB,0CACd,SAC8C;CAC9C,MAAM,aAAaA,wEAAgD,QAAQ;AAE3E,QAAO,CACL;EACE,IAAI;EACJ,MAAM;EACN,OAAO;EACP;EACA,KAAK,GAAG,WAAW,KAAK,QAAQ,CAAC;EAClC,CACF;;AAGH,SAAgB,4CACd,SACQ;AACR,QAAO,0CAA0C,QAAQ,CAAC,GAAI"}

package/dist/migrations.d.cts

@@ -0,0 +1,16 @@
+import { DrizzlePostgresWorkflowStoreSchemaOptions } from "./schema-contract.cjs";
+
+//#region src/migrations.d.ts
+interface DrizzlePostgresWorkflowStoreMigration {
+  id: string;
+  name: string;
+  order: number;
+  statements: Array<string>;
+  sql: string;
+}
+declare const drizzlePostgresWorkflowStoreSchemaVersion = "0000_workflow_store";
+declare function getDrizzlePostgresWorkflowStoreMigrations(options?: DrizzlePostgresWorkflowStoreSchemaOptions): Array<DrizzlePostgresWorkflowStoreMigration>;
+declare function getDrizzlePostgresWorkflowStoreMigrationSql(options?: DrizzlePostgresWorkflowStoreSchemaOptions): string;
+//#endregion
+export { DrizzlePostgresWorkflowStoreMigration, drizzlePostgresWorkflowStoreSchemaVersion, getDrizzlePostgresWorkflowStoreMigrationSql, getDrizzlePostgresWorkflowStoreMigrations };
+//# sourceMappingURL=migrations.d.cts.map

package/dist/migrations.d.ts

@@ -0,0 +1,16 @@
+import { DrizzlePostgresWorkflowStoreSchemaOptions } from "./schema-contract.js";
+
+//#region src/migrations.d.ts
+interface DrizzlePostgresWorkflowStoreMigration {
+  id: string;
+  name: string;
+  order: number;
+  statements: Array<string>;
+  sql: string;
+}
+declare const drizzlePostgresWorkflowStoreSchemaVersion = "0000_workflow_store";
+declare function getDrizzlePostgresWorkflowStoreMigrations(options?: DrizzlePostgresWorkflowStoreSchemaOptions): Array<DrizzlePostgresWorkflowStoreMigration>;
+declare function getDrizzlePostgresWorkflowStoreMigrationSql(options?: DrizzlePostgresWorkflowStoreSchemaOptions): string;
+//#endregion
+export { DrizzlePostgresWorkflowStoreMigration, drizzlePostgresWorkflowStoreSchemaVersion, getDrizzlePostgresWorkflowStoreMigrationSql, getDrizzlePostgresWorkflowStoreMigrations };
+//# sourceMappingURL=migrations.d.ts.map

package/dist/migrations.js

@@ -0,0 +1,21 @@
+import { getDrizzlePostgresWorkflowStoreSchemaStatements } from "./schema-contract.js";
+
+//#region src/migrations.ts
+const drizzlePostgresWorkflowStoreSchemaVersion = "0000_workflow_store";
+function getDrizzlePostgresWorkflowStoreMigrations(options) {
+	const statements = getDrizzlePostgresWorkflowStoreSchemaStatements(options);
+	return [{
+		id: "0000_workflow_store",
+		name: "Create TanStack Workflow Drizzle/Postgres store tables",
+		order: 0,
+		statements,
+		sql: `${statements.join(";\n\n")};\n`
+	}];
+}
+function getDrizzlePostgresWorkflowStoreMigrationSql(options) {
+	return getDrizzlePostgresWorkflowStoreMigrations(options)[0].sql;
+}
+
+//#endregion
+export { drizzlePostgresWorkflowStoreSchemaVersion, getDrizzlePostgresWorkflowStoreMigrationSql, getDrizzlePostgresWorkflowStoreMigrations };
+//# sourceMappingURL=migrations.js.map

package/dist/migrations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrations.js","names":[],"sources":["../src/migrations.ts"],"sourcesContent":["import { getDrizzlePostgresWorkflowStoreSchemaStatements } from './schema-contract'\nimport type { DrizzlePostgresWorkflowStoreSchemaOptions } from './schema-contract'\n\nexport interface DrizzlePostgresWorkflowStoreMigration {\n  id: string\n  name: string\n  order: number\n  statements: Array<string>\n  sql: string\n}\n\nexport const drizzlePostgresWorkflowStoreSchemaVersion = '0000_workflow_store'\n\nexport function getDrizzlePostgresWorkflowStoreMigrations(\n  options?: DrizzlePostgresWorkflowStoreSchemaOptions,\n): Array<DrizzlePostgresWorkflowStoreMigration> {\n  const statements = getDrizzlePostgresWorkflowStoreSchemaStatements(options)\n\n  return [\n    {\n      id: '0000_workflow_store',\n      name: 'Create TanStack Workflow Drizzle/Postgres store tables',\n      order: 0,\n      statements,\n      sql: `${statements.join(';\\n\\n')};\\n`,\n    },\n  ]\n}\n\nexport function getDrizzlePostgresWorkflowStoreMigrationSql(\n  options?: DrizzlePostgresWorkflowStoreSchemaOptions,\n): string {\n  return getDrizzlePostgresWorkflowStoreMigrations(options)[0]!.sql\n}\n"],"mappings":";;;AAWA,MAAa,4CAA4C;AAEzD,SAAgB,0CACd,SAC8C;CAC9C,MAAM,aAAa,gDAAgD,QAAQ;AAE3E,QAAO,CACL;EACE,IAAI;EACJ,MAAM;EACN,OAAO;EACP;EACA,KAAK,GAAG,WAAW,KAAK,QAAQ,CAAC;EAClC,CACF;;AAGH,SAAgB,4CACd,SACQ;AACR,QAAO,0CAA0C,QAAQ,CAAC,GAAI"}

package/dist/schema-contract.cjs

@@ -0,0 +1,169 @@
+
+//#region src/schema-contract.ts
+const defaultDrizzlePostgresWorkflowStoreTables = {
+	schemaMigrations: "workflow_schema_migrations",
+	runs: "workflow_runs",
+	runStates: "workflow_run_states",
+	eventLocks: "workflow_event_locks",
+	events: "workflow_events",
+	timers: "workflow_timers",
+	signalDeliveries: "workflow_signal_deliveries",
+	schedules: "workflow_schedules",
+	scheduleBuckets: "workflow_schedule_buckets"
+};
+function resolveDrizzlePostgresWorkflowStoreTables(tables) {
+	return {
+		...defaultDrizzlePostgresWorkflowStoreTables,
+		...tables
+	};
+}
+function getDrizzlePostgresWorkflowStoreSchemaStatements(options = {}) {
+	const tables = resolveDrizzlePostgresWorkflowStoreTables(options.tables);
+	const schemaMigrations = qualifiedTableName(options.schema, tables.schemaMigrations);
+	const runs = qualifiedTableName(options.schema, tables.runs);
+	const runStates = qualifiedTableName(options.schema, tables.runStates);
+	const eventLocks = qualifiedTableName(options.schema, tables.eventLocks);
+	const events = qualifiedTableName(options.schema, tables.events);
+	const timers = qualifiedTableName(options.schema, tables.timers);
+	const signalDeliveries = qualifiedTableName(options.schema, tables.signalDeliveries);
+	const schedules = qualifiedTableName(options.schema, tables.schedules);
+	const scheduleBuckets = qualifiedTableName(options.schema, tables.scheduleBuckets);
+	return [
+		...options.schema ? [`create schema if not exists ${quoteIdent(options.schema)}`] : [],
+		`create table if not exists ${schemaMigrations} (
+      migration_id text primary key,
+      package_name text not null,
+      package_version text,
+      applied_at bigint not null
+    )`,
+		`create table if not exists ${runs} (
+      run_id text primary key,
+      workflow_id text not null,
+      workflow_version text,
+      status text not null,
+      input jsonb not null,
+      output jsonb,
+      error jsonb,
+      awaiting jsonb,
+      waiting_for jsonb,
+      pending_approval jsonb,
+      wake_at bigint,
+      lease_owner text,
+      lease_expires_at bigint,
+      created_at bigint not null,
+      updated_at bigint not null
+    )`,
+		`alter table ${runs} add column if not exists awaiting jsonb`,
+		`create index if not exists ${quoteIdent(`${tables.runs}_status_idx`)}
+      on ${runs} (status, updated_at)`,
+		`create index if not exists ${quoteIdent(`${tables.runs}_lease_idx`)}
+      on ${runs} (status, lease_expires_at)`,
+		`create table if not exists ${runStates} (
+      run_id text primary key,
+      workflow_id text not null,
+      workflow_version text,
+      status text not null,
+      input jsonb not null,
+      output jsonb,
+      error jsonb,
+      awaiting jsonb,
+      waiting_for jsonb,
+      pending_approval jsonb,
+      created_at bigint not null,
+      updated_at bigint not null
+    )`,
+		`alter table ${runStates} add column if not exists awaiting jsonb`,
+		`create table if not exists ${eventLocks} (
+      run_id text primary key,
+      created_at bigint not null
+    )`,
+		`create table if not exists ${events} (
+      run_id text not null,
+      event_index integer not null,
+      event_type text not null,
+      step_id text,
+      event jsonb not null,
+      created_at bigint not null,
+      primary key (run_id, event_index)
+    )`,
+		`create index if not exists ${quoteIdent(`${tables.events}_type_idx`)}
+      on ${events} (run_id, event_type)`,
+		`create table if not exists ${timers} (
+      run_id text not null,
+      signal_id text not null,
+      workflow_id text not null,
+      workflow_version text,
+      wake_at bigint not null,
+      lease_owner text,
+      lease_expires_at bigint,
+      primary key (run_id, signal_id)
+    )`,
+		`create index if not exists ${quoteIdent(`${tables.timers}_due_idx`)}
+      on ${timers} (wake_at, lease_expires_at)`,
+		`create table if not exists ${signalDeliveries} (
+      run_id text not null,
+      signal_id text not null,
+      created_at bigint not null,
+      primary key (run_id, signal_id)
+    )`,
+		`create table if not exists ${schedules} (
+      schedule_id text primary key,
+      workflow_id text not null,
+      workflow_version text,
+      schedule jsonb not null,
+      overlap_policy text not null,
+      input jsonb,
+      next_fire_at bigint,
+      enabled boolean not null,
+      updated_at bigint not null
+    )`,
+		`create index if not exists ${quoteIdent(`${tables.schedules}_due_idx`)}
+      on ${schedules} (enabled, next_fire_at)`,
+		`create table if not exists ${scheduleBuckets} (
+      schedule_id text not null,
+      bucket_id text not null,
+      workflow_id text not null,
+      workflow_version text,
+      run_id text not null,
+      fire_at bigint not null,
+      input jsonb,
+      overlap_policy text not null,
+      status text not null,
+      lease_owner text,
+      lease_expires_at bigint,
+      started_at bigint,
+      primary key (schedule_id, bucket_id)
+    )`,
+		`create index if not exists ${quoteIdent(`${tables.scheduleBuckets}_lease_idx`)}
+      on ${scheduleBuckets} (status, fire_at, lease_expires_at)`,
+		`insert into ${schemaMigrations} (
+      migration_id,
+      package_name,
+      package_version,
+      applied_at
+    )
+    values (
+      '0000_workflow_store',
+      '@tanstack/workflow-store-drizzle-postgres',
+      null,
+      (extract(epoch from now()) * 1000)::bigint
+    )
+    on conflict (migration_id) do nothing`
+	].map(normalizeSqlStatement);
+}
+function qualifiedTableName(schema, table) {
+	return schema ? `${quoteIdent(schema)}.${quoteIdent(table)}` : quoteIdent(table);
+}
+function quoteIdent(identifier) {
+	return `"${identifier.replaceAll("\"", "\"\"")}"`;
+}
+function normalizeSqlStatement(statement) {
+	return statement.split("\n").map((line, index) => index === 0 ? line.trimEnd() : line.replace(/^ {4}/, "").trimEnd()).join("\n");
+}
+
+//#endregion
+exports.defaultDrizzlePostgresWorkflowStoreTables = defaultDrizzlePostgresWorkflowStoreTables;
+exports.getDrizzlePostgresWorkflowStoreSchemaStatements = getDrizzlePostgresWorkflowStoreSchemaStatements;
+exports.qualifiedTableName = qualifiedTableName;
+exports.resolveDrizzlePostgresWorkflowStoreTables = resolveDrizzlePostgresWorkflowStoreTables;
+//# sourceMappingURL=schema-contract.cjs.map

package/dist/schema-contract.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-contract.cjs","names":[],"sources":["../src/schema-contract.ts"],"sourcesContent":["export interface DrizzlePostgresWorkflowStoreTables {\n  schemaMigrations: string\n  runs: string\n  runStates: string\n  eventLocks: string\n  events: string\n  timers: string\n  signalDeliveries: string\n  schedules: string\n  scheduleBuckets: string\n}\n\nexport interface DrizzlePostgresWorkflowStoreSchemaOptions {\n  schema?: string\n  tables?: Partial<DrizzlePostgresWorkflowStoreTables>\n}\n\nexport const defaultDrizzlePostgresWorkflowStoreTables: DrizzlePostgresWorkflowStoreTables =\n  {\n    schemaMigrations: 'workflow_schema_migrations',\n    runs: 'workflow_runs',\n    runStates: 'workflow_run_states',\n    eventLocks: 'workflow_event_locks',\n    events: 'workflow_events',\n    timers: 'workflow_timers',\n    signalDeliveries: 'workflow_signal_deliveries',\n    schedules: 'workflow_schedules',\n    scheduleBuckets: 'workflow_schedule_buckets',\n  }\n\nexport function resolveDrizzlePostgresWorkflowStoreTables(\n  tables?: Partial<DrizzlePostgresWorkflowStoreTables>,\n): DrizzlePostgresWorkflowStoreTables {\n  return {\n    ...defaultDrizzlePostgresWorkflowStoreTables,\n    ...tables,\n  }\n}\n\nexport function getDrizzlePostgresWorkflowStoreSchemaStatements(\n  options: DrizzlePostgresWorkflowStoreSchemaOptions = {},\n): Array<string> {\n  const tables = resolveDrizzlePostgresWorkflowStoreTables(options.tables)\n  const schemaMigrations = qualifiedTableName(\n    options.schema,\n    tables.schemaMigrations,\n  )\n  const runs = qualifiedTableName(options.schema, tables.runs)\n  const runStates = qualifiedTableName(options.schema, tables.runStates)\n  const eventLocks = qualifiedTableName(options.schema, tables.eventLocks)\n  const events = qualifiedTableName(options.schema, tables.events)\n  const timers = qualifiedTableName(options.schema, tables.timers)\n  const signalDeliveries = qualifiedTableName(\n    options.schema,\n    tables.signalDeliveries,\n  )\n  const schedules = qualifiedTableName(options.schema, tables.schedules)\n  const scheduleBuckets = qualifiedTableName(\n    options.schema,\n    tables.scheduleBuckets,\n  )\n\n  return [\n    ...(options.schema\n      ? [`create schema if not exists ${quoteIdent(options.schema)}`]\n      : []),\n    `create table if not exists ${schemaMigrations} (\n      migration_id text primary key,\n      package_name text not null,\n      package_version text,\n      applied_at bigint not null\n    )`,\n    `create table if not exists ${runs} (\n      run_id text primary key,\n      workflow_id text not null,\n      workflow_version text,\n      status text not null,\n      input jsonb not null,\n      output jsonb,\n      error jsonb,\n      awaiting jsonb,\n      waiting_for jsonb,\n      pending_approval jsonb,\n      wake_at bigint,\n      lease_owner text,\n      lease_expires_at bigint,\n      created_at bigint not null,\n      updated_at bigint not null\n    )`,\n    `alter table ${runs} add column if not exists awaiting jsonb`,\n    `create index if not exists ${quoteIdent(`${tables.runs}_status_idx`)}\n      on ${runs} (status, updated_at)`,\n    `create index if not exists ${quoteIdent(`${tables.runs}_lease_idx`)}\n      on ${runs} (status, lease_expires_at)`,\n    `create table if not exists ${runStates} (\n      run_id text primary key,\n      workflow_id text not null,\n      workflow_version text,\n      status text not null,\n      input jsonb not null,\n      output jsonb,\n      error jsonb,\n      awaiting jsonb,\n      waiting_for jsonb,\n      pending_approval jsonb,\n      created_at bigint not null,\n      updated_at bigint not null\n    )`,\n    `alter table ${runStates} add column if not exists awaiting jsonb`,\n    `create table if not exists ${eventLocks} (\n      run_id text primary key,\n      created_at bigint not null\n    )`,\n    `create table if not exists ${events} (\n      run_id text not null,\n      event_index integer not null,\n      event_type text not null,\n      step_id text,\n      event jsonb not null,\n      created_at bigint not null,\n      primary key (run_id, event_index)\n    )`,\n    `create index if not exists ${quoteIdent(`${tables.events}_type_idx`)}\n      on ${events} (run_id, event_type)`,\n    `create table if not exists ${timers} (\n      run_id text not null,\n      signal_id text not null,\n      workflow_id text not null,\n      workflow_version text,\n      wake_at bigint not null,\n      lease_owner text,\n      lease_expires_at bigint,\n      primary key (run_id, signal_id)\n    )`,\n    `create index if not exists ${quoteIdent(`${tables.timers}_due_idx`)}\n      on ${timers} (wake_at, lease_expires_at)`,\n    `create table if not exists ${signalDeliveries} (\n      run_id text not null,\n      signal_id text not null,\n      created_at bigint not null,\n      primary key (run_id, signal_id)\n    )`,\n    `create table if not exists ${schedules} (\n      schedule_id text primary key,\n      workflow_id text not null,\n      workflow_version text,\n      schedule jsonb not null,\n      overlap_policy text not null,\n      input jsonb,\n      next_fire_at bigint,\n      enabled boolean not null,\n      updated_at bigint not null\n    )`,\n    `create index if not exists ${quoteIdent(`${tables.schedules}_due_idx`)}\n      on ${schedules} (enabled, next_fire_at)`,\n    `create table if not exists ${scheduleBuckets} (\n      schedule_id text not null,\n      bucket_id text not null,\n      workflow_id text not null,\n      workflow_version text,\n      run_id text not null,\n      fire_at bigint not null,\n      input jsonb,\n      overlap_policy text not null,\n      status text not null,\n      lease_owner text,\n      lease_expires_at bigint,\n      started_at bigint,\n      primary key (schedule_id, bucket_id)\n    )`,\n    `create index if not exists ${quoteIdent(\n      `${tables.scheduleBuckets}_lease_idx`,\n    )}\n      on ${scheduleBuckets} (status, fire_at, lease_expires_at)`,\n    `insert into ${schemaMigrations} (\n      migration_id,\n      package_name,\n      package_version,\n      applied_at\n    )\n    values (\n      '0000_workflow_store',\n      '@tanstack/workflow-store-drizzle-postgres',\n      null,\n      (extract(epoch from now()) * 1000)::bigint\n    )\n    on conflict (migration_id) do nothing`,\n  ].map(normalizeSqlStatement)\n}\n\nexport function qualifiedTableName(schema: string | undefined, table: string) {\n  return schema\n    ? `${quoteIdent(schema)}.${quoteIdent(table)}`\n    : quoteIdent(table)\n}\n\nfunction quoteIdent(identifier: string) {\n  return `\"${identifier.replaceAll('\"', '\"\"')}\"`\n}\n\nfunction normalizeSqlStatement(statement: string) {\n  return statement\n    .split('\\n')\n    .map((line, index) =>\n      index === 0 ? line.trimEnd() : line.replace(/^ {4}/, '').trimEnd(),\n    )\n    .join('\\n')\n}\n"],"mappings":";;AAiBA,MAAa,4CACX;CACE,kBAAkB;CAClB,MAAM;CACN,WAAW;CACX,YAAY;CACZ,QAAQ;CACR,QAAQ;CACR,kBAAkB;CAClB,WAAW;CACX,iBAAiB;CAClB;AAEH,SAAgB,0CACd,QACoC;AACpC,QAAO;EACL,GAAG;EACH,GAAG;EACJ;;AAGH,SAAgB,gDACd,UAAqD,EAAE,EACxC;CACf,MAAM,SAAS,0CAA0C,QAAQ,OAAO;CACxE,MAAM,mBAAmB,mBACvB,QAAQ,QACR,OAAO,iBACR;CACD,MAAM,OAAO,mBAAmB,QAAQ,QAAQ,OAAO,KAAK;CAC5D,MAAM,YAAY,mBAAmB,QAAQ,QAAQ,OAAO,UAAU;CACtE,MAAM,aAAa,mBAAmB,QAAQ,QAAQ,OAAO,WAAW;CACxE,MAAM,SAAS,mBAAmB,QAAQ,QAAQ,OAAO,OAAO;CAChE,MAAM,SAAS,mBAAmB,QAAQ,QAAQ,OAAO,OAAO;CAChE,MAAM,mBAAmB,mBACvB,QAAQ,QACR,OAAO,iBACR;CACD,MAAM,YAAY,mBAAmB,QAAQ,QAAQ,OAAO,UAAU;CACtE,MAAM,kBAAkB,mBACtB,QAAQ,QACR,OAAO,gBACR;AAED,QAAO;EACL,GAAI,QAAQ,SACR,CAAC,+BAA+B,WAAW,QAAQ,OAAO,GAAG,GAC7D,EAAE;EACN,8BAA8B,iBAAiB;;;;;;EAM/C,8BAA8B,KAAK;;;;;;;;;;;;;;;;;EAiBnC,eAAe,KAAK;EACpB,8BAA8B,WAAW,GAAG,OAAO,KAAK,aAAa,CAAC;WAC/D,KAAK;EACZ,8BAA8B,WAAW,GAAG,OAAO,KAAK,YAAY,CAAC;WAC9D,KAAK;EACZ,8BAA8B,UAAU;;;;;;;;;;;;;;EAcxC,eAAe,UAAU;EACzB,8BAA8B,WAAW;;;;EAIzC,8BAA8B,OAAO;;;;;;;;;EASrC,8BAA8B,WAAW,GAAG,OAAO,OAAO,WAAW,CAAC;WAC/D,OAAO;EACd,8BAA8B,OAAO;;;;;;;;;;EAUrC,8BAA8B,WAAW,GAAG,OAAO,OAAO,UAAU,CAAC;WAC9D,OAAO;EACd,8BAA8B,iBAAiB;;;;;;EAM/C,8BAA8B,UAAU;;;;;;;;;;;EAWxC,8BAA8B,WAAW,GAAG,OAAO,UAAU,UAAU,CAAC;WACjE,UAAU;EACjB,8BAA8B,gBAAgB;;;;;;;;;;;;;;;EAe9C,8BAA8B,WAC5B,GAAG,OAAO,gBAAgB,YAC3B,CAAC;WACK,gBAAgB;EACvB,eAAe,iBAAiB;;;;;;;;;;;;;EAajC,CAAC,IAAI,sBAAsB;;AAG9B,SAAgB,mBAAmB,QAA4B,OAAe;AAC5E,QAAO,SACH,GAAG,WAAW,OAAO,CAAC,GAAG,WAAW,MAAM,KAC1C,WAAW,MAAM;;AAGvB,SAAS,WAAW,YAAoB;AACtC,QAAO,IAAI,WAAW,WAAW,MAAK,OAAK,CAAC;;AAG9C,SAAS,sBAAsB,WAAmB;AAChD,QAAO,UACJ,MAAM,KAAK,CACX,KAAK,MAAM,UACV,UAAU,IAAI,KAAK,SAAS,GAAG,KAAK,QAAQ,SAAS,GAAG,CAAC,SAAS,CACnE,CACA,KAAK,KAAK"}

package/dist/schema-contract.d.cts

@@ -0,0 +1,22 @@
+//#region src/schema-contract.d.ts
+interface DrizzlePostgresWorkflowStoreTables {
+  schemaMigrations: string;
+  runs: string;
+  runStates: string;
+  eventLocks: string;
+  events: string;
+  timers: string;
+  signalDeliveries: string;
+  schedules: string;
+  scheduleBuckets: string;
+}
+interface DrizzlePostgresWorkflowStoreSchemaOptions {
+  schema?: string;
+  tables?: Partial<DrizzlePostgresWorkflowStoreTables>;
+}
+declare const defaultDrizzlePostgresWorkflowStoreTables: DrizzlePostgresWorkflowStoreTables;
+declare function resolveDrizzlePostgresWorkflowStoreTables(tables?: Partial<DrizzlePostgresWorkflowStoreTables>): DrizzlePostgresWorkflowStoreTables;
+declare function getDrizzlePostgresWorkflowStoreSchemaStatements(options?: DrizzlePostgresWorkflowStoreSchemaOptions): Array<string>;
+//#endregion
+export { DrizzlePostgresWorkflowStoreSchemaOptions, DrizzlePostgresWorkflowStoreTables, defaultDrizzlePostgresWorkflowStoreTables, getDrizzlePostgresWorkflowStoreSchemaStatements, resolveDrizzlePostgresWorkflowStoreTables };
+//# sourceMappingURL=schema-contract.d.cts.map

package/dist/schema-contract.d.ts

@@ -0,0 +1,22 @@
+//#region src/schema-contract.d.ts
+interface DrizzlePostgresWorkflowStoreTables {
+  schemaMigrations: string;
+  runs: string;
+  runStates: string;
+  eventLocks: string;
+  events: string;
+  timers: string;
+  signalDeliveries: string;
+  schedules: string;
+  scheduleBuckets: string;
+}
+interface DrizzlePostgresWorkflowStoreSchemaOptions {
+  schema?: string;
+  tables?: Partial<DrizzlePostgresWorkflowStoreTables>;
+}
+declare const defaultDrizzlePostgresWorkflowStoreTables: DrizzlePostgresWorkflowStoreTables;
+declare function resolveDrizzlePostgresWorkflowStoreTables(tables?: Partial<DrizzlePostgresWorkflowStoreTables>): DrizzlePostgresWorkflowStoreTables;
+declare function getDrizzlePostgresWorkflowStoreSchemaStatements(options?: DrizzlePostgresWorkflowStoreSchemaOptions): Array<string>;
+//#endregion
+export { DrizzlePostgresWorkflowStoreSchemaOptions, DrizzlePostgresWorkflowStoreTables, defaultDrizzlePostgresWorkflowStoreTables, getDrizzlePostgresWorkflowStoreSchemaStatements, resolveDrizzlePostgresWorkflowStoreTables };
+//# sourceMappingURL=schema-contract.d.ts.map