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

package/dist/tables.js

@@ -0,0 +1,95 @@
+import { bigint, boolean, index, integer, jsonb, pgTable, primaryKey, text } from "drizzle-orm/pg-core";
+
+//#region src/tables.ts
+const workflowSchemaMigrations = pgTable("workflow_schema_migrations", {
+	migrationId: text("migration_id").primaryKey(),
+	packageName: text("package_name").notNull(),
+	packageVersion: text("package_version"),
+	appliedAt: bigint("applied_at", { mode: "number" }).notNull()
+});
+const workflowRuns = pgTable("workflow_runs", {
+	runId: text("run_id").primaryKey(),
+	workflowId: text("workflow_id").notNull(),
+	workflowVersion: text("workflow_version"),
+	status: text("status").notNull(),
+	input: jsonb("input").notNull(),
+	output: jsonb("output"),
+	error: jsonb("error"),
+	awaiting: jsonb("awaiting"),
+	waitingFor: jsonb("waiting_for"),
+	pendingApproval: jsonb("pending_approval"),
+	wakeAt: bigint("wake_at", { mode: "number" }),
+	leaseOwner: text("lease_owner"),
+	leaseExpiresAt: bigint("lease_expires_at", { mode: "number" }),
+	createdAt: bigint("created_at", { mode: "number" }).notNull(),
+	updatedAt: bigint("updated_at", { mode: "number" }).notNull()
+}, (table) => [index("workflow_runs_status_idx").on(table.status, table.updatedAt), index("workflow_runs_lease_idx").on(table.status, table.leaseExpiresAt)]);
+const workflowRunStates = pgTable("workflow_run_states", {
+	runId: text("run_id").primaryKey(),
+	workflowId: text("workflow_id").notNull(),
+	workflowVersion: text("workflow_version"),
+	status: text("status").notNull(),
+	input: jsonb("input").notNull(),
+	output: jsonb("output"),
+	error: jsonb("error"),
+	awaiting: jsonb("awaiting"),
+	waitingFor: jsonb("waiting_for"),
+	pendingApproval: jsonb("pending_approval"),
+	createdAt: bigint("created_at", { mode: "number" }).notNull(),
+	updatedAt: bigint("updated_at", { mode: "number" }).notNull()
+});
+const workflowEventLocks = pgTable("workflow_event_locks", {
+	runId: text("run_id").primaryKey(),
+	createdAt: bigint("created_at", { mode: "number" }).notNull()
+});
+const workflowEvents = pgTable("workflow_events", {
+	runId: text("run_id").notNull(),
+	eventIndex: integer("event_index").notNull(),
+	eventType: text("event_type").notNull(),
+	stepId: text("step_id"),
+	event: jsonb("event").notNull(),
+	createdAt: bigint("created_at", { mode: "number" }).notNull()
+}, (table) => [primaryKey({ columns: [table.runId, table.eventIndex] }), index("workflow_events_type_idx").on(table.runId, table.eventType)]);
+const workflowTimers = pgTable("workflow_timers", {
+	runId: text("run_id").notNull(),
+	signalId: text("signal_id").notNull(),
+	workflowId: text("workflow_id").notNull(),
+	workflowVersion: text("workflow_version"),
+	wakeAt: bigint("wake_at", { mode: "number" }).notNull(),
+	leaseOwner: text("lease_owner"),
+	leaseExpiresAt: bigint("lease_expires_at", { mode: "number" })
+}, (table) => [primaryKey({ columns: [table.runId, table.signalId] }), index("workflow_timers_due_idx").on(table.wakeAt, table.leaseExpiresAt)]);
+const workflowSignalDeliveries = pgTable("workflow_signal_deliveries", {
+	runId: text("run_id").notNull(),
+	signalId: text("signal_id").notNull(),
+	createdAt: bigint("created_at", { mode: "number" }).notNull()
+}, (table) => [primaryKey({ columns: [table.runId, table.signalId] })]);
+const workflowSchedules = pgTable("workflow_schedules", {
+	scheduleId: text("schedule_id").primaryKey(),
+	workflowId: text("workflow_id").notNull(),
+	workflowVersion: text("workflow_version"),
+	schedule: jsonb("schedule").notNull(),
+	overlapPolicy: text("overlap_policy").notNull(),
+	input: jsonb("input"),
+	nextFireAt: bigint("next_fire_at", { mode: "number" }),
+	enabled: boolean("enabled").notNull(),
+	updatedAt: bigint("updated_at", { mode: "number" }).notNull()
+}, (table) => [index("workflow_schedules_due_idx").on(table.enabled, table.nextFireAt)]);
+const workflowScheduleBuckets = pgTable("workflow_schedule_buckets", {
+	scheduleId: text("schedule_id").notNull(),
+	bucketId: text("bucket_id").notNull(),
+	workflowId: text("workflow_id").notNull(),
+	workflowVersion: text("workflow_version"),
+	runId: text("run_id").notNull(),
+	fireAt: bigint("fire_at", { mode: "number" }).notNull(),
+	input: jsonb("input"),
+	overlapPolicy: text("overlap_policy").notNull(),
+	status: text("status").notNull(),
+	leaseOwner: text("lease_owner"),
+	leaseExpiresAt: bigint("lease_expires_at", { mode: "number" }),
+	startedAt: bigint("started_at", { mode: "number" })
+}, (table) => [primaryKey({ columns: [table.scheduleId, table.bucketId] }), index("workflow_schedule_buckets_lease_idx").on(table.status, table.fireAt, table.leaseExpiresAt)]);
+
+//#endregion
+export { workflowEventLocks, workflowEvents, workflowRunStates, workflowRuns, workflowScheduleBuckets, workflowSchedules, workflowSchemaMigrations, workflowSignalDeliveries, workflowTimers };
+//# sourceMappingURL=tables.js.map

package/dist/tables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tables.js","names":[],"sources":["../src/tables.ts"],"sourcesContent":["import {\n  bigint,\n  boolean,\n  index,\n  integer,\n  jsonb,\n  pgTable,\n  primaryKey,\n  text,\n} from 'drizzle-orm/pg-core'\n\nexport const workflowSchemaMigrations = pgTable('workflow_schema_migrations', {\n  migrationId: text('migration_id').primaryKey(),\n  packageName: text('package_name').notNull(),\n  packageVersion: text('package_version'),\n  appliedAt: bigint('applied_at', { mode: 'number' }).notNull(),\n})\n\nexport const workflowRuns = pgTable(\n  'workflow_runs',\n  {\n    runId: text('run_id').primaryKey(),\n    workflowId: text('workflow_id').notNull(),\n    workflowVersion: text('workflow_version'),\n    status: text('status').notNull(),\n    input: jsonb('input').notNull(),\n    output: jsonb('output'),\n    error: jsonb('error'),\n    awaiting: jsonb('awaiting'),\n    waitingFor: jsonb('waiting_for'),\n    pendingApproval: jsonb('pending_approval'),\n    wakeAt: bigint('wake_at', { mode: 'number' }),\n    leaseOwner: text('lease_owner'),\n    leaseExpiresAt: bigint('lease_expires_at', { mode: 'number' }),\n    createdAt: bigint('created_at', { mode: 'number' }).notNull(),\n    updatedAt: bigint('updated_at', { mode: 'number' }).notNull(),\n  },\n  (table) => [\n    index('workflow_runs_status_idx').on(table.status, table.updatedAt),\n    index('workflow_runs_lease_idx').on(table.status, table.leaseExpiresAt),\n  ],\n)\n\nexport const workflowRunStates = pgTable('workflow_run_states', {\n  runId: text('run_id').primaryKey(),\n  workflowId: text('workflow_id').notNull(),\n  workflowVersion: text('workflow_version'),\n  status: text('status').notNull(),\n  input: jsonb('input').notNull(),\n  output: jsonb('output'),\n  error: jsonb('error'),\n  awaiting: jsonb('awaiting'),\n  waitingFor: jsonb('waiting_for'),\n  pendingApproval: jsonb('pending_approval'),\n  createdAt: bigint('created_at', { mode: 'number' }).notNull(),\n  updatedAt: bigint('updated_at', { mode: 'number' }).notNull(),\n})\n\nexport const workflowEventLocks = pgTable('workflow_event_locks', {\n  runId: text('run_id').primaryKey(),\n  createdAt: bigint('created_at', { mode: 'number' }).notNull(),\n})\n\nexport const workflowEvents = pgTable(\n  'workflow_events',\n  {\n    runId: text('run_id').notNull(),\n    eventIndex: integer('event_index').notNull(),\n    eventType: text('event_type').notNull(),\n    stepId: text('step_id'),\n    event: jsonb('event').notNull(),\n    createdAt: bigint('created_at', { mode: 'number' }).notNull(),\n  },\n  (table) => [\n    primaryKey({ columns: [table.runId, table.eventIndex] }),\n    index('workflow_events_type_idx').on(table.runId, table.eventType),\n  ],\n)\n\nexport const workflowTimers = pgTable(\n  'workflow_timers',\n  {\n    runId: text('run_id').notNull(),\n    signalId: text('signal_id').notNull(),\n    workflowId: text('workflow_id').notNull(),\n    workflowVersion: text('workflow_version'),\n    wakeAt: bigint('wake_at', { mode: 'number' }).notNull(),\n    leaseOwner: text('lease_owner'),\n    leaseExpiresAt: bigint('lease_expires_at', { mode: 'number' }),\n  },\n  (table) => [\n    primaryKey({ columns: [table.runId, table.signalId] }),\n    index('workflow_timers_due_idx').on(table.wakeAt, table.leaseExpiresAt),\n  ],\n)\n\nexport const workflowSignalDeliveries = pgTable(\n  'workflow_signal_deliveries',\n  {\n    runId: text('run_id').notNull(),\n    signalId: text('signal_id').notNull(),\n    createdAt: bigint('created_at', { mode: 'number' }).notNull(),\n  },\n  (table) => [primaryKey({ columns: [table.runId, table.signalId] })],\n)\n\nexport const workflowSchedules = pgTable(\n  'workflow_schedules',\n  {\n    scheduleId: text('schedule_id').primaryKey(),\n    workflowId: text('workflow_id').notNull(),\n    workflowVersion: text('workflow_version'),\n    schedule: jsonb('schedule').notNull(),\n    overlapPolicy: text('overlap_policy').notNull(),\n    input: jsonb('input'),\n    nextFireAt: bigint('next_fire_at', { mode: 'number' }),\n    enabled: boolean('enabled').notNull(),\n    updatedAt: bigint('updated_at', { mode: 'number' }).notNull(),\n  },\n  (table) => [\n    index('workflow_schedules_due_idx').on(table.enabled, table.nextFireAt),\n  ],\n)\n\nexport const workflowScheduleBuckets = pgTable(\n  'workflow_schedule_buckets',\n  {\n    scheduleId: text('schedule_id').notNull(),\n    bucketId: text('bucket_id').notNull(),\n    workflowId: text('workflow_id').notNull(),\n    workflowVersion: text('workflow_version'),\n    runId: text('run_id').notNull(),\n    fireAt: bigint('fire_at', { mode: 'number' }).notNull(),\n    input: jsonb('input'),\n    overlapPolicy: text('overlap_policy').notNull(),\n    status: text('status').notNull(),\n    leaseOwner: text('lease_owner'),\n    leaseExpiresAt: bigint('lease_expires_at', { mode: 'number' }),\n    startedAt: bigint('started_at', { mode: 'number' }),\n  },\n  (table) => [\n    primaryKey({ columns: [table.scheduleId, table.bucketId] }),\n    index('workflow_schedule_buckets_lease_idx').on(\n      table.status,\n      table.fireAt,\n      table.leaseExpiresAt,\n    ),\n  ],\n)\n"],"mappings":";;;AAWA,MAAa,2BAA2B,QAAQ,8BAA8B;CAC5E,aAAa,KAAK,eAAe,CAAC,YAAY;CAC9C,aAAa,KAAK,eAAe,CAAC,SAAS;CAC3C,gBAAgB,KAAK,kBAAkB;CACvC,WAAW,OAAO,cAAc,EAAE,MAAM,UAAU,CAAC,CAAC,SAAS;CAC9D,CAAC;AAEF,MAAa,eAAe,QAC1B,iBACA;CACE,OAAO,KAAK,SAAS,CAAC,YAAY;CAClC,YAAY,KAAK,cAAc,CAAC,SAAS;CACzC,iBAAiB,KAAK,mBAAmB;CACzC,QAAQ,KAAK,SAAS,CAAC,SAAS;CAChC,OAAO,MAAM,QAAQ,CAAC,SAAS;CAC/B,QAAQ,MAAM,SAAS;CACvB,OAAO,MAAM,QAAQ;CACrB,UAAU,MAAM,WAAW;CAC3B,YAAY,MAAM,cAAc;CAChC,iBAAiB,MAAM,mBAAmB;CAC1C,QAAQ,OAAO,WAAW,EAAE,MAAM,UAAU,CAAC;CAC7C,YAAY,KAAK,cAAc;CAC/B,gBAAgB,OAAO,oBAAoB,EAAE,MAAM,UAAU,CAAC;CAC9D,WAAW,OAAO,cAAc,EAAE,MAAM,UAAU,CAAC,CAAC,SAAS;CAC7D,WAAW,OAAO,cAAc,EAAE,MAAM,UAAU,CAAC,CAAC,SAAS;CAC9D,GACA,UAAU,CACT,MAAM,2BAA2B,CAAC,GAAG,MAAM,QAAQ,MAAM,UAAU,EACnE,MAAM,0BAA0B,CAAC,GAAG,MAAM,QAAQ,MAAM,eAAe,CACxE,CACF;AAED,MAAa,oBAAoB,QAAQ,uBAAuB;CAC9D,OAAO,KAAK,SAAS,CAAC,YAAY;CAClC,YAAY,KAAK,cAAc,CAAC,SAAS;CACzC,iBAAiB,KAAK,mBAAmB;CACzC,QAAQ,KAAK,SAAS,CAAC,SAAS;CAChC,OAAO,MAAM,QAAQ,CAAC,SAAS;CAC/B,QAAQ,MAAM,SAAS;CACvB,OAAO,MAAM,QAAQ;CACrB,UAAU,MAAM,WAAW;CAC3B,YAAY,MAAM,cAAc;CAChC,iBAAiB,MAAM,mBAAmB;CAC1C,WAAW,OAAO,cAAc,EAAE,MAAM,UAAU,CAAC,CAAC,SAAS;CAC7D,WAAW,OAAO,cAAc,EAAE,MAAM,UAAU,CAAC,CAAC,SAAS;CAC9D,CAAC;AAEF,MAAa,qBAAqB,QAAQ,wBAAwB;CAChE,OAAO,KAAK,SAAS,CAAC,YAAY;CAClC,WAAW,OAAO,cAAc,EAAE,MAAM,UAAU,CAAC,CAAC,SAAS;CAC9D,CAAC;AAEF,MAAa,iBAAiB,QAC5B,mBACA;CACE,OAAO,KAAK,SAAS,CAAC,SAAS;CAC/B,YAAY,QAAQ,cAAc,CAAC,SAAS;CAC5C,WAAW,KAAK,aAAa,CAAC,SAAS;CACvC,QAAQ,KAAK,UAAU;CACvB,OAAO,MAAM,QAAQ,CAAC,SAAS;CAC/B,WAAW,OAAO,cAAc,EAAE,MAAM,UAAU,CAAC,CAAC,SAAS;CAC9D,GACA,UAAU,CACT,WAAW,EAAE,SAAS,CAAC,MAAM,OAAO,MAAM,WAAW,EAAE,CAAC,EACxD,MAAM,2BAA2B,CAAC,GAAG,MAAM,OAAO,MAAM,UAAU,CACnE,CACF;AAED,MAAa,iBAAiB,QAC5B,mBACA;CACE,OAAO,KAAK,SAAS,CAAC,SAAS;CAC/B,UAAU,KAAK,YAAY,CAAC,SAAS;CACrC,YAAY,KAAK,cAAc,CAAC,SAAS;CACzC,iBAAiB,KAAK,mBAAmB;CACzC,QAAQ,OAAO,WAAW,EAAE,MAAM,UAAU,CAAC,CAAC,SAAS;CACvD,YAAY,KAAK,cAAc;CAC/B,gBAAgB,OAAO,oBAAoB,EAAE,MAAM,UAAU,CAAC;CAC/D,GACA,UAAU,CACT,WAAW,EAAE,SAAS,CAAC,MAAM,OAAO,MAAM,SAAS,EAAE,CAAC,EACtD,MAAM,0BAA0B,CAAC,GAAG,MAAM,QAAQ,MAAM,eAAe,CACxE,CACF;AAED,MAAa,2BAA2B,QACtC,8BACA;CACE,OAAO,KAAK,SAAS,CAAC,SAAS;CAC/B,UAAU,KAAK,YAAY,CAAC,SAAS;CACrC,WAAW,OAAO,cAAc,EAAE,MAAM,UAAU,CAAC,CAAC,SAAS;CAC9D,GACA,UAAU,CAAC,WAAW,EAAE,SAAS,CAAC,MAAM,OAAO,MAAM,SAAS,EAAE,CAAC,CAAC,CACpE;AAED,MAAa,oBAAoB,QAC/B,sBACA;CACE,YAAY,KAAK,cAAc,CAAC,YAAY;CAC5C,YAAY,KAAK,cAAc,CAAC,SAAS;CACzC,iBAAiB,KAAK,mBAAmB;CACzC,UAAU,MAAM,WAAW,CAAC,SAAS;CACrC,eAAe,KAAK,iBAAiB,CAAC,SAAS;CAC/C,OAAO,MAAM,QAAQ;CACrB,YAAY,OAAO,gBAAgB,EAAE,MAAM,UAAU,CAAC;CACtD,SAAS,QAAQ,UAAU,CAAC,SAAS;CACrC,WAAW,OAAO,cAAc,EAAE,MAAM,UAAU,CAAC,CAAC,SAAS;CAC9D,GACA,UAAU,CACT,MAAM,6BAA6B,CAAC,GAAG,MAAM,SAAS,MAAM,WAAW,CACxE,CACF;AAED,MAAa,0BAA0B,QACrC,6BACA;CACE,YAAY,KAAK,cAAc,CAAC,SAAS;CACzC,UAAU,KAAK,YAAY,CAAC,SAAS;CACrC,YAAY,KAAK,cAAc,CAAC,SAAS;CACzC,iBAAiB,KAAK,mBAAmB;CACzC,OAAO,KAAK,SAAS,CAAC,SAAS;CAC/B,QAAQ,OAAO,WAAW,EAAE,MAAM,UAAU,CAAC,CAAC,SAAS;CACvD,OAAO,MAAM,QAAQ;CACrB,eAAe,KAAK,iBAAiB,CAAC,SAAS;CAC/C,QAAQ,KAAK,SAAS,CAAC,SAAS;CAChC,YAAY,KAAK,cAAc;CAC/B,gBAAgB,OAAO,oBAAoB,EAAE,MAAM,UAAU,CAAC;CAC9D,WAAW,OAAO,cAAc,EAAE,MAAM,UAAU,CAAC;CACpD,GACA,UAAU,CACT,WAAW,EAAE,SAAS,CAAC,MAAM,YAAY,MAAM,SAAS,EAAE,CAAC,EAC3D,MAAM,sCAAsC,CAAC,GAC3C,MAAM,QACN,MAAM,QACN,MAAM,eACP,CACF,CACF"}

package/migrations/0000_workflow_store.sql

@@ -0,0 +1,136 @@
+create table if not exists "workflow_schema_migrations" (
+  migration_id text primary key,
+  package_name text not null,
+  package_version text,
+  applied_at bigint not null
+);
+
+create table if not exists "workflow_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 "workflow_runs" add column if not exists awaiting jsonb;
+
+create index if not exists "workflow_runs_status_idx"
+  on "workflow_runs" (status, updated_at);
+
+create index if not exists "workflow_runs_lease_idx"
+  on "workflow_runs" (status, lease_expires_at);
+
+create table if not exists "workflow_run_states" (
+  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 "workflow_run_states" add column if not exists awaiting jsonb;
+
+create table if not exists "workflow_event_locks" (
+  run_id text primary key,
+  created_at bigint not null
+);
+
+create table if not exists "workflow_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 "workflow_events_type_idx"
+  on "workflow_events" (run_id, event_type);
+
+create table if not exists "workflow_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 "workflow_timers_due_idx"
+  on "workflow_timers" (wake_at, lease_expires_at);
+
+create table if not exists "workflow_signal_deliveries" (
+  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 "workflow_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 "workflow_schedules_due_idx"
+  on "workflow_schedules" (enabled, next_fire_at);
+
+create table if not exists "workflow_schedule_buckets" (
+  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 "workflow_schedule_buckets_lease_idx"
+  on "workflow_schedule_buckets" (status, fire_at, lease_expires_at);
+
+insert into "workflow_schema_migrations" (
+  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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/workflow-store-drizzle-postgres",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Drizzle/Postgres durable execution store for TanStack Workflow.",
   "author": "Tanner Linsley",
   "license": "MIT",
@@ -48,7 +48,9 @@
   },
   "files": [
     "dist/",
-    "src"
+    "migrations/",
+    "src",
+    "SCHEMA_MIGRATIONS.md"
   ],
   "dependencies": {
     "@tanstack/workflow-core": "workspace:*",

package/src/index.ts

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

package/src/migrations.ts

@@ -0,0 +1,34 @@
+import { getDrizzlePostgresWorkflowStoreSchemaStatements } from './schema-contract'
+import type { DrizzlePostgresWorkflowStoreSchemaOptions } from './schema-contract'
+
+export interface DrizzlePostgresWorkflowStoreMigration {
+  id: string
+  name: string
+  order: number
+  statements: Array<string>
+  sql: string
+}
+
+export const drizzlePostgresWorkflowStoreSchemaVersion = '0000_workflow_store'
+
+export function getDrizzlePostgresWorkflowStoreMigrations(
+  options?: DrizzlePostgresWorkflowStoreSchemaOptions,
+): Array<DrizzlePostgresWorkflowStoreMigration> {
+  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`,
+    },
+  ]
+}
+
+export function getDrizzlePostgresWorkflowStoreMigrationSql(
+  options?: DrizzlePostgresWorkflowStoreSchemaOptions,
+): string {
+  return getDrizzlePostgresWorkflowStoreMigrations(options)[0]!.sql
+}

package/src/schema-contract.ts

@@ -0,0 +1,208 @@
+export interface DrizzlePostgresWorkflowStoreTables {
+  schemaMigrations: string
+  runs: string
+  runStates: string
+  eventLocks: string
+  events: string
+  timers: string
+  signalDeliveries: string
+  schedules: string
+  scheduleBuckets: string
+}
+
+export interface DrizzlePostgresWorkflowStoreSchemaOptions {
+  schema?: string
+  tables?: Partial<DrizzlePostgresWorkflowStoreTables>
+}
+
+export const defaultDrizzlePostgresWorkflowStoreTables: DrizzlePostgresWorkflowStoreTables =
+  {
+    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',
+  }
+
+export function resolveDrizzlePostgresWorkflowStoreTables(
+  tables?: Partial<DrizzlePostgresWorkflowStoreTables>,
+): DrizzlePostgresWorkflowStoreTables {
+  return {
+    ...defaultDrizzlePostgresWorkflowStoreTables,
+    ...tables,
+  }
+}
+
+export function getDrizzlePostgresWorkflowStoreSchemaStatements(
+  options: DrizzlePostgresWorkflowStoreSchemaOptions = {},
+): Array<string> {
+  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)
+}
+
+export function qualifiedTableName(schema: string | undefined, table: string) {
+  return schema
+    ? `${quoteIdent(schema)}.${quoteIdent(table)}`
+    : quoteIdent(table)
+}
+
+function quoteIdent(identifier: string) {
+  return `"${identifier.replaceAll('"', '""')}"`
+}
+
+function normalizeSqlStatement(statement: string) {
+  return statement
+    .split('\n')
+    .map((line, index) =>
+      index === 0 ? line.trimEnd() : line.replace(/^ {4}/, '').trimEnd(),
+    )
+    .join('\n')
+}