@mastra/pg 1.19.0-alpha.1 → 1.19.0-alpha.2

package/CHANGELOG.md

@@ -1,5 +1,49 @@
 # @mastra/pg
 
+## 1.19.0-alpha.2
+
+### Minor Changes
+
+- Stored workflow definitions now persist across restarts on every major database backend. ([#20471](https://github.com/mastra-ai/mastra/pull/20471))
+
+  Implement the `workflowDefinitions` storage domain for libsql, pg, mysql, mssql, mongodb, and spanner. Previously the stored-workflow persistence path (`POST /stored/workflows`, `Mastra.addStoredWorkflow`) only worked against `@mastra/core`'s in-memory store. Persistent adapters returned `undefined` from `storage.getStore('workflowDefinitions')` and threw when the HTTP handler tried to read/write a workflow.
+
+  ```ts
+  const workflowDefinitions = await storage.getStore('workflowDefinitions');
+  if (!workflowDefinitions) {
+    throw new Error('This storage adapter does not support the workflowDefinitions domain');
+  }
+
+  await workflowDefinitions.upsert({
+    id: 'greeting-workflow',
+    inputSchema: { type: 'object', properties: { name: { type: 'string' } }, required: ['name'] },
+    outputSchema: { type: 'object', properties: { text: { type: 'string' } }, required: ['text'] },
+    graph: [{ type: 'agent', id: 'greet', agentId: 'greeter-agent' }],
+  });
+
+  const { definitions, total } = await workflowDefinitions.list({ status: 'active' });
+  const definition = await workflowDefinitions.get('greeting-workflow');
+  await workflowDefinitions.delete('greeting-workflow');
+  ```
+
+  Each adapter now ships a `WorkflowDefinitions*` domain that:
+
+  - Creates the shared `mastra_workflow_definitions` table (or Mongo collection) from `WORKFLOW_DEFINITIONS_SCHEMA` during `init()`, plus a default index on `status`.
+  - Implements `upsert` / `get` / `list` / `delete` matching `WorkflowDefinitionsStorage` semantics (`list` supports `status` and `authorId` filters and orders by `updatedAt` desc). Partial upserts preserve unspecified fields, including `authorId` updates and `createdAt` / `updatedAt` semantics.
+  - Handles concurrent first-writes race-safely: if two callers upsert the same new id simultaneously, the losing insert detects the duplicate key, re-reads the row, and applies the partial-update path instead of failing.
+  - Round-trips the JSON columns (`inputSchema`, `outputSchema`, `stateSchema`, `requestContextSchema`, `metadata`, `graph`) through each adapter's JSON handling, so declarative workflow graphs rehydrate identically no matter which backend they were stored in. Malformed persisted JSON surfaces as an actionable error naming the row and column instead of hydrating raw strings.
+
+  Exported class names by adapter: `WorkflowDefinitionsLibSQL`, `WorkflowDefinitionsPG`, `WorkflowDefinitionsMySQL`, `WorkflowDefinitionsMSSQL`, `MongoDBWorkflowDefinitionsStore`, `WorkflowDefinitionsSpanner`. The composite stores (`LibSQLStore`, `PostgresStore`, `MySQLStore`, `MSSQLStore`, `MongoDBStore`, `SpannerStore`) auto-wire the new domain, so callers do not need to construct it manually — `storage.getStore('workflowDefinitions')` now returns a live handle.
+
+  The pg adapter reads `createdAt` / `updatedAt` from the auto-added `createdAtZ` / `updatedAtZ` `timestamptz` companion columns to avoid the naive-timestamp / local-TZ drift that a plain `TIMESTAMP` read exhibits under node-pg.
+
+  `@mastra/clickhouse` and `@mastra/cloudflare` register the new `mastra_workflow_definitions` table in their table/type maps so shared table constants stay exhaustive (no workflow-definitions domain implementation yet).
+
+### Patch Changes
+
+- Updated dependencies [[`4844167`](https://github.com/mastra-ai/mastra/commit/4844167cff2d5ec5004e94edd34970833040fa3f), [`5faf93f`](https://github.com/mastra-ai/mastra/commit/5faf93f03e19daea394b9e2a923f2e4f833407f2), [`80ad891`](https://github.com/mastra-ai/mastra/commit/80ad891f8cd10379aa5b5af7510c763783b2ab56), [`a1cb98d`](https://github.com/mastra-ai/mastra/commit/a1cb98d11990b560b98482292a1f34aa1a2d9092), [`598ad82`](https://github.com/mastra-ai/mastra/commit/598ad82d41c41389a686338a1d0e50b7400e1938), [`1fd6aad`](https://github.com/mastra-ai/mastra/commit/1fd6aad1ea4a9d32f65efa832307c35e981a4c0a)]:
+  - @mastra/core@1.56.0-alpha.4
+
 ## 1.19.0-alpha.1
 
 ### Patch Changes

package/dist/docs/SKILL.md

@@ -3,7 +3,7 @@ name: mastra-pg
 description: Documentation for @mastra/pg. Use when working with @mastra/pg APIs, configuration, or implementation.
 metadata:
   package: "@mastra/pg"
-  version: "1.19.0-alpha.1"
+  version: "1.19.0-alpha.2"
 ---
 
 ## When to use

package/dist/docs/assets/SOURCE_MAP.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.19.0-alpha.1",
+  "version": "1.19.0-alpha.2",
   "package": "@mastra/pg",
   "exports": {},
   "modules": {}

package/dist/docs/references/docs-deployment-workers.md

@@ -17,7 +17,7 @@ Workers matter when any of these apply:
 - Different parts of the system need to scale independently (e.g., more orchestration capacity without more API instances)
 - Background tool calls should run on dedicated compute
 
-If your application handles light traffic and workflows complete quickly, the default in-process setup works fine. Skip the worker infrastructure until you need it.
+If your application handles light traffic and workflows complete fast, the default in-process setup works fine. Skip the worker infrastructure until you need it.
 
 ## Worker types
 
@@ -33,11 +33,11 @@ The orchestration worker requires a PubSub backend that supports pull mode (e.g.
 
 ### Scheduler worker
 
-Polls storage for due cron schedules and publishes `workflow.start` events. It is a producer only, meaning it creates work for the orchestration worker to pick up.
+Polls storage for due cron schedules and publishes `workflow.start` events. It's a producer only, meaning it creates work for the orchestration worker to pick up.
 
 The scheduler reads declarative `schedule` fields from your workflow definitions automatically. See [Scheduled workflows](https://mastra.ai/docs/workflows/scheduled-workflows) for how to declare schedules.
 
-**Do not run more than one scheduler instance.** Multiple schedulers polling the same storage would fire duplicate events for the same schedule.
+**Don't run more than one scheduler instance.** Multiple schedulers polling the same storage would fire duplicate events for the same schedule.
 
 ### Background task worker
 
@@ -47,7 +47,7 @@ The background task worker manages concurrency limits, task lifecycle, and resul
 
 ## How workers run
 
-### In-process (default)
+### In-process mode (default)
 
 With no configuration, Mastra creates and starts workers inside the API process. Events flow through an in-memory PubSub, and everything shares a single Node.js runtime.
 
@@ -64,7 +64,7 @@ This setup needs no external infrastructure beyond your storage adapter. It does
 
 ### Split processes
 
-To run workers separately, configure a distributed [PubSub](https://mastra.ai/docs/server/pubsub) backend and use the `MASTRA_WORKERS` environment variable to control which workers start in each process.
+To run workers in their own processes, configure a distributed [PubSub](https://mastra.ai/docs/server/pubsub) backend and use the `MASTRA_WORKERS` environment variable to control which workers start in each process.
 
 **Redis Streams + PostgreSQL**:
 
@@ -100,38 +100,38 @@ export const mastra = new Mastra({
 })
 ```
 
-Any [supported storage backend](https://mastra.ai/reference/workers/overview) works — swap the storage adapter for your preferred database.
+Any [supported storage backend](https://mastra.ai/reference/workers/overview) works. Swap the storage adapter for your preferred database.
 
 Run the same build artifact in multiple containers, each with a different [`MASTRA_WORKERS`](https://mastra.ai/reference/workers/overview) value to control which worker starts in each process.
 
 Split deployments require a distributed PubSub backend ([`RedisStreamsPubSub`](https://mastra.ai/reference/pubsub/redis-streams) or [`GoogleCloudPubSub`](https://mastra.ai/reference/pubsub/google-cloud-pubsub)), a shared [storage backend](https://mastra.ai/reference/workers/overview), and network connectivity between the orchestration worker and the API.
 
-The [worker deployment guide](https://mastra.ai/guides/deployment/mastra-workers) walks through this setup with a Docker Compose example.
+The [worker deployment guide](https://mastra.ai/guides/deployment/mastra-workers) walks through this setup with Docker Compose and Kubernetes examples.
 
 ## Network architecture
 
-Workers are internal infrastructure. They are not exposed to end users and do not need their own subdomain, public URL, or inbound HTTP route.
+Workers are internal infrastructure. They're not exposed to end users and don't need their own subdomain, public URL, or inbound HTTP route.
 
 In a split deployment:
 
-- **The API server is the only public-facing process.** It serves all client HTTP requests — REST endpoints, agent interactions, workflow triggers, and any custom routes.
-- **Workers connect outbound only.** They pull events from the distributed PubSub backend and read/write to the shared storage database. They do not accept inbound traffic from clients.
-- **The orchestration worker calls the API internally.** It sends step execution requests to the API over the container network using `MASTRA_STEP_EXECUTION_URL`. This is internal service-to-service communication, not a public endpoint.
+- **The API server is the only public-facing process**: It serves all client HTTP requests, including REST endpoints, agent interactions, workflow triggers, and any custom routes.
+- **Workers connect outbound only**: They pull events from the distributed PubSub backend and read/write to the shared storage database. They don't accept inbound traffic from clients.
+- **The orchestration worker calls the API internally**: It sends step execution requests to the API over the container network using `MASTRA_STEP_EXECUTION_URL`. This is internal service-to-service communication, not a public endpoint.
 
 All three worker types (orchestration, scheduler, background task) sit behind the API on a private network. They share access to the PubSub backend and storage database but never receive traffic directly from clients. If a worker-related feature needs an HTTP route (for example, token minting for a voice integration), that route runs on the API server, not on the worker process.
 
 ## Known limitations
 
-- **No dead-letter queue**: Failed events are nacked and retried, but there is no DLQ for events that repeatedly fail.
+- **No dead-letter queue**: Failed events are nacked and retried, but there's no DLQ for events that fail after all retries.
 - **No built-in health endpoint**: Workers don't expose an HTTP health check. Use container-level liveness probes or process monitoring.
 - **Scheduler is single-instance**: Running multiple scheduler processes causes duplicate schedule fires.
 - **Runs stuck in "running" after API crash**: If the API process crashes while executing a workflow step, the run remains in `running` status with no automatic retry. For [durable agents](https://mastra.ai/docs/long-running-agents/durable-agents), set `recovery.durableAgents` to `'auto'` in the Mastra config to automatically re-drive orphaned runs on server restart. See [Crash recovery](https://mastra.ai/docs/long-running-agents/durable-agents) for details.
 
 ## Related
 
-- [Worker deployment guide](https://mastra.ai/guides/deployment/mastra-workers): Docker Compose example and topology options
+- [Worker deployment guide](https://mastra.ai/guides/deployment/mastra-workers): Docker Compose and Kubernetes examples
 - [Worker authentication](https://mastra.ai/docs/server/auth/workers): Secure worker-to-API communication
-- [Workers reference](https://mastra.ai/reference/workers/overview): Environment variables, worker types, and storage backends
+- [Workers reference](https://mastra.ai/reference/workers/overview): Details about worker environment variables and types, with a list of supported storage backends
 - [CLI reference](https://mastra.ai/reference/cli/mastra): `mastra worker build` and `mastra worker start`
 - [PubSub](https://mastra.ai/docs/server/pubsub): Event delivery backends
 - [Scheduled workflows](https://mastra.ai/docs/workflows/scheduled-workflows): Declare cron schedules on workflows

package/dist/index.cjs

@@ -18772,6 +18772,187 @@ var ToolProviderConnectionsPG = class ToolProviderConnectionsPG extends _mastra_
 	}
 };
 //#endregion
+//#region src/storage/domains/workflow-definitions/index.ts
+function rowToDefinition(row) {
+	const inputSchema = parseJsonResilient(row.inputSchema);
+	const outputSchema = parseJsonResilient(row.outputSchema);
+	const graph = parseJsonResilient(row.graph);
+	if (inputSchema === void 0 || outputSchema === void 0 || graph === void 0) throw new Error(`Workflow definition row "${String(row.id)}" is missing required JSON columns.`);
+	const def = {
+		id: String(row.id),
+		inputSchema,
+		outputSchema,
+		graph,
+		status: String(row.status),
+		source: String(row.source),
+		createdAt: new Date(row.createdAtZ ?? row.createdAt),
+		updatedAt: new Date(row.updatedAtZ ?? row.updatedAt)
+	};
+	if (row.description != null) def.description = String(row.description);
+	const metadata = parseJsonResilient(row.metadata);
+	if (metadata !== void 0 && metadata !== null) def.metadata = metadata;
+	const stateSchema = parseJsonResilient(row.stateSchema);
+	if (stateSchema !== void 0 && stateSchema !== null) def.stateSchema = stateSchema;
+	const requestContextSchema = parseJsonResilient(row.requestContextSchema);
+	if (requestContextSchema !== void 0 && requestContextSchema !== null) def.requestContextSchema = requestContextSchema;
+	if (row.authorId != null) def.authorId = String(row.authorId);
+	return def;
+}
+var WorkflowDefinitionsPG = class WorkflowDefinitionsPG extends _mastra_core_storage.WorkflowDefinitionsStorage {
+	#db;
+	#schema;
+	#skipDefaultIndexes;
+	#indexes;
+	static MANAGED_TABLES = [_mastra_core_storage.TABLE_WORKFLOW_DEFINITIONS];
+	constructor(config) {
+		super();
+		const { client, schemaName, skipDefaultIndexes, indexes } = resolvePgConfig(config);
+		this.#db = new PgDB({
+			client,
+			schemaName,
+			skipDefaultIndexes
+		});
+		this.#schema = schemaName || "public";
+		this.#skipDefaultIndexes = skipDefaultIndexes;
+		this.#indexes = indexes?.filter((idx) => WorkflowDefinitionsPG.MANAGED_TABLES.includes(idx.table));
+	}
+	static getExportDDL(schemaName) {
+		return [generateTableSQL({
+			tableName: _mastra_core_storage.TABLE_WORKFLOW_DEFINITIONS,
+			schema: _mastra_core_storage.TABLE_SCHEMAS[_mastra_core_storage.TABLE_WORKFLOW_DEFINITIONS],
+			schemaName,
+			includeAllConstraints: true
+		})];
+	}
+	getDefaultIndexDefinitions() {
+		return [{
+			name: `${this.#schema !== "public" ? `${this.#schema}_` : ""}idx_workflow_definitions_status`,
+			table: _mastra_core_storage.TABLE_WORKFLOW_DEFINITIONS,
+			columns: ["status"]
+		}];
+	}
+	async createDefaultIndexes() {
+		if (this.#skipDefaultIndexes) return;
+		for (const indexDef of this.getDefaultIndexDefinitions()) try {
+			await this.#db.createIndex(indexDef);
+		} catch (error) {
+			this.logger?.warn?.(`Failed to create index ${indexDef.name}:`, error);
+		}
+	}
+	async createCustomIndexes() {
+		if (!this.#indexes || this.#indexes.length === 0) return;
+		for (const indexDef of this.#indexes) try {
+			await this.#db.createIndex(indexDef);
+		} catch (error) {
+			this.logger?.warn?.(`Failed to create custom index ${indexDef.name}:`, error);
+		}
+	}
+	async init() {
+		await this.#db.createTable({
+			tableName: _mastra_core_storage.TABLE_WORKFLOW_DEFINITIONS,
+			schema: _mastra_core_storage.TABLE_SCHEMAS[_mastra_core_storage.TABLE_WORKFLOW_DEFINITIONS]
+		});
+		await this.createDefaultIndexes();
+		await this.createCustomIndexes();
+	}
+	async dangerouslyClearAll() {
+		await this.#db.clearTable({ tableName: _mastra_core_storage.TABLE_WORKFLOW_DEFINITIONS });
+	}
+	async upsert(input) {
+		const now = /* @__PURE__ */ new Date();
+		if (!await this.get(input.id)) {
+			if (!("inputSchema" in input) || !input.inputSchema) throw new Error(`Cannot create workflow definition "${input.id}": inputSchema is required.`);
+			if (!("outputSchema" in input) || !input.outputSchema) throw new Error(`Cannot create workflow definition "${input.id}": outputSchema is required.`);
+			if (!("graph" in input) || !input.graph) throw new Error(`Cannot create workflow definition "${input.id}": graph is required.`);
+			const record = {
+				id: input.id,
+				description: input.description ?? null,
+				metadata: input.metadata ?? null,
+				inputSchema: input.inputSchema,
+				outputSchema: input.outputSchema,
+				stateSchema: input.stateSchema ?? null,
+				requestContextSchema: input.requestContextSchema ?? null,
+				graph: input.graph,
+				status: "active",
+				source: "storage",
+				authorId: "authorId" in input ? input.authorId ?? null : null,
+				createdAt: now,
+				updatedAt: now
+			};
+			try {
+				await this.#db.insert({
+					tableName: _mastra_core_storage.TABLE_WORKFLOW_DEFINITIONS,
+					record
+				});
+			} catch (error) {
+				if (!await this.get(input.id)) throw error;
+				return this.applyUpdate(input, now);
+			}
+			const created = await this.get(input.id);
+			if (!created) throw new Error(`Failed to persist workflow definition "${input.id}".`);
+			return created;
+		}
+		return this.applyUpdate(input, now);
+	}
+	async applyUpdate(input, now) {
+		const data = { updatedAt: now };
+		if ("description" in input && input.description !== void 0) data.description = input.description;
+		if ("metadata" in input && input.metadata !== void 0) data.metadata = input.metadata;
+		if ("inputSchema" in input && input.inputSchema !== void 0) data.inputSchema = input.inputSchema;
+		if ("outputSchema" in input && input.outputSchema !== void 0) data.outputSchema = input.outputSchema;
+		if ("stateSchema" in input && input.stateSchema !== void 0) data.stateSchema = input.stateSchema;
+		if ("requestContextSchema" in input && input.requestContextSchema !== void 0) data.requestContextSchema = input.requestContextSchema;
+		if ("graph" in input && input.graph !== void 0) data.graph = input.graph;
+		if ("status" in input && input.status !== void 0) data.status = input.status;
+		if ("authorId" in input && input.authorId !== void 0) data.authorId = input.authorId;
+		await this.#db.update({
+			tableName: _mastra_core_storage.TABLE_WORKFLOW_DEFINITIONS,
+			keys: { id: input.id },
+			data
+		});
+		const updated = await this.get(input.id);
+		if (!updated) throw new Error(`Failed to update workflow definition "${input.id}".`);
+		return updated;
+	}
+	async get(id) {
+		const tableName = getTableName$5({
+			indexName: _mastra_core_storage.TABLE_WORKFLOW_DEFINITIONS,
+			schemaName: getSchemaName$5(this.#schema)
+		});
+		const row = await this.#db.client.oneOrNone(`SELECT * FROM ${tableName} WHERE "id" = $1`, [id]);
+		return row ? rowToDefinition(row) : null;
+	}
+	async list(args) {
+		const tableName = getTableName$5({
+			indexName: _mastra_core_storage.TABLE_WORKFLOW_DEFINITIONS,
+			schemaName: getSchemaName$5(this.#schema)
+		});
+		const conditions = [];
+		const params = [];
+		if (args?.status) {
+			params.push(args.status);
+			conditions.push(`"status" = $${params.length}`);
+		}
+		if (args?.authorId !== void 0) {
+			params.push(args.authorId);
+			conditions.push(`"authorId" = $${params.length}`);
+		}
+		const where = conditions.length > 0 ? `WHERE ${conditions.join(" AND ")}` : "";
+		const definitions = (await this.#db.client.manyOrNone(`SELECT * FROM ${tableName} ${where} ORDER BY "updatedAt" DESC`, params)).map((row) => rowToDefinition(row));
+		return {
+			definitions,
+			total: definitions.length
+		};
+	}
+	async delete(id) {
+		const tableName = getTableName$5({
+			indexName: _mastra_core_storage.TABLE_WORKFLOW_DEFINITIONS,
+			schemaName: getSchemaName$5(this.#schema)
+		});
+		await this.#db.client.none(`DELETE FROM ${tableName} WHERE "id" = $1`, [id]);
+	}
+};
+//#endregion
 //#region src/storage/domains/workflows/index.ts
 function getSchemaName(schema) {
 	return schema ? `"${schema}"` : "\"public\"";
@@ -20264,6 +20445,7 @@ const ALL_DOMAINS = [
 	BlobsPG,
 	ToolProviderConnectionsPG,
 	WorkflowsPG,
+	WorkflowDefinitionsPG,
 	DatasetsPG,
 	ExperimentsPG,
 	BackgroundTasksPG,
@@ -20345,6 +20527,7 @@ var PostgresStore = class extends _mastra_core_storage.MastraCompositeStore {
 			this.stores = {
 				scores: new ScoresPG(domainConfig),
 				workflows: new WorkflowsPG(domainConfig),
+				workflowDefinitions: new WorkflowDefinitionsPG(domainConfig),
 				memory: new MemoryPG(domainConfig),
 				notifications: new NotificationsPG(domainConfig),
 				observability: new ObservabilityPG(domainConfig),
@@ -20694,6 +20877,7 @@ exports.ScorerDefinitionsPG = ScorerDefinitionsPG;
 exports.ScoresPG = ScoresPG;
 exports.SkillsPG = SkillsPG;
 exports.ToolProviderConnectionsPG = ToolProviderConnectionsPG;
+exports.WorkflowDefinitionsPG = WorkflowDefinitionsPG;
 exports.WorkflowsPG = WorkflowsPG;
 exports.WorkspacesPG = WorkspacesPG;
 exports.exportSchemas = exportSchemas;