@duraflows/kysely 6.0.0 → 7.0.0

package/README.md

@@ -40,6 +40,7 @@ const runtime = new WorkflowRuntime({
   ...persistence,
   clock: { now: () => new Date() },
 });
+await runtime.initialize(); // surfaces definition/version errors at boot
 ```
 
 ## Sharing a Transaction
@@ -108,7 +109,7 @@ A database type declared as `interface AppDb extends WorkflowDatabase` picks up
 
 ## Database Setup
 
-This package uses the same database schema as `@duraflows/pg`. Use the migration generator from `@duraflows/pg` or copy the reference migration:
+This package uses the same database schema as `@duraflows/pg`, including migration `006_definition_version_index.sql` (recommended, not required -- it keeps the 7.0.0 startup executability check and `listDefinitionVersions()` cheap on large tables). Use the migration generator from `@duraflows/pg` or copy the reference migration:
 
 ```ts
 import { generateMigrationSql } from "@duraflows/pg";
@@ -118,6 +119,8 @@ const { up, down } = generateMigrationSql();
 
 See the [`@duraflows/pg` README](https://github.com/camcima/duraflows/tree/main/packages/duraflows-pg#database-setup) for full details.
 
+`KyselyWorkflowInstanceStore` and `KyselyWorkflowDefinitionStore` implement the two store methods (`countInstances()`, `listVersions()`) that back 7.0.0's definition-version pinning and startup executability check. See [Definition versions](https://github.com/camcima/duraflows/blob/main/docs/workflow-definitions.md#definition-versions), and [Upgrading to 7.0.0](https://github.com/camcima/duraflows/blob/main/docs/workflow-definitions.md#upgrading-to-700) before deploying.
+
 ## API
 
 ### `kyselyWorkflowProviders(db, options?): WorkflowPersistenceProvider`

package/dist/cjs/kysely-definition-store.d.ts

@@ -12,6 +12,7 @@ export declare class KyselyWorkflowDefinitionStore implements WorkflowDefinition
         definitionJson: WorkflowDefinition;
     }): Promise<StoredWorkflowDefinition>;
     findByNameAndVersion(workflowName: string, version: number): Promise<StoredWorkflowDefinition | null>;
+    listVersions(workflowName: string): Promise<StoredWorkflowDefinition[]>;
     private mapRow;
 }
 //# sourceMappingURL=kysely-definition-store.d.ts.map

package/dist/cjs/kysely-definition-store.js

@@ -43,6 +43,15 @@ class KyselyWorkflowDefinitionStore {
             return null;
         return this.mapRow(row);
     }
+    async listVersions(workflowName) {
+        const rows = await this.getExecutor()
+            .selectFrom("workflow_definitions")
+            .selectAll()
+            .where("workflow_name", "=", workflowName)
+            .orderBy("version")
+            .execute();
+        return rows.map((row) => this.mapRow(row));
+    }
     mapRow(row) {
         return {
             workflowName: row.workflow_name,

package/dist/cjs/kysely-instance-store.d.ts

@@ -14,6 +14,11 @@ export declare class KyselyWorkflowInstanceStore implements WorkflowInstanceStor
         limit: number;
         workflowName?: string;
     }): Promise<WorkflowInstance[]>;
+    countInstances(options: {
+        workflowName: string;
+        definitionVersion: number;
+        excludeStates: readonly string[];
+    }): Promise<number>;
     private mapRow;
 }
 //# sourceMappingURL=kysely-instance-store.d.ts.map

package/dist/cjs/kysely-instance-store.js

@@ -119,6 +119,19 @@ class KyselyWorkflowInstanceStore {
         const rows = await query.orderBy("timeout_parked_at").orderBy("uuid").limit(options.limit).execute();
         return rows.map((row) => this.mapRow(row));
     }
+    async countInstances(options) {
+        let query = this.getExecutor()
+            .selectFrom("workflow_instances")
+            .select((eb) => eb.fn.countAll().as("count"))
+            .where("workflow_name", "=", options.workflowName)
+            .where("definition_version", "=", options.definitionVersion);
+        // Kysely rejects `not in ()`; an empty list excludes nothing anyway.
+        if (options.excludeStates.length > 0) {
+            query = query.where("current_state", "not in", [...options.excludeStates]);
+        }
+        const row = await query.executeTakeFirst();
+        return Number(row?.count ?? 0);
+    }
     mapRow(row) {
         return {
             uuid: row.uuid,

package/dist/kysely-definition-store.d.ts

@@ -12,6 +12,7 @@ export declare class KyselyWorkflowDefinitionStore implements WorkflowDefinition
         definitionJson: WorkflowDefinition;
     }): Promise<StoredWorkflowDefinition>;
     findByNameAndVersion(workflowName: string, version: number): Promise<StoredWorkflowDefinition | null>;
+    listVersions(workflowName: string): Promise<StoredWorkflowDefinition[]>;
     private mapRow;
 }
 //# sourceMappingURL=kysely-definition-store.d.ts.map

package/dist/kysely-definition-store.js

@@ -40,6 +40,15 @@ export class KyselyWorkflowDefinitionStore {
             return null;
         return this.mapRow(row);
     }
+    async listVersions(workflowName) {
+        const rows = await this.getExecutor()
+            .selectFrom("workflow_definitions")
+            .selectAll()
+            .where("workflow_name", "=", workflowName)
+            .orderBy("version")
+            .execute();
+        return rows.map((row) => this.mapRow(row));
+    }
     mapRow(row) {
         return {
             workflowName: row.workflow_name,

package/dist/kysely-instance-store.d.ts

@@ -14,6 +14,11 @@ export declare class KyselyWorkflowInstanceStore implements WorkflowInstanceStor
         limit: number;
         workflowName?: string;
     }): Promise<WorkflowInstance[]>;
+    countInstances(options: {
+        workflowName: string;
+        definitionVersion: number;
+        excludeStates: readonly string[];
+    }): Promise<number>;
     private mapRow;
 }
 //# sourceMappingURL=kysely-instance-store.d.ts.map

package/dist/kysely-instance-store.js

@@ -116,6 +116,19 @@ export class KyselyWorkflowInstanceStore {
         const rows = await query.orderBy("timeout_parked_at").orderBy("uuid").limit(options.limit).execute();
         return rows.map((row) => this.mapRow(row));
     }
+    async countInstances(options) {
+        let query = this.getExecutor()
+            .selectFrom("workflow_instances")
+            .select((eb) => eb.fn.countAll().as("count"))
+            .where("workflow_name", "=", options.workflowName)
+            .where("definition_version", "=", options.definitionVersion);
+        // Kysely rejects `not in ()`; an empty list excludes nothing anyway.
+        if (options.excludeStates.length > 0) {
+            query = query.where("current_state", "not in", [...options.excludeStates]);
+        }
+        const row = await query.executeTakeFirst();
+        return Number(row?.count ?? 0);
+    }
     mapRow(row) {
         return {
             uuid: row.uuid,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@duraflows/kysely",
-  "version": "6.0.0",
+  "version": "7.0.0",
   "description": "PostgreSQL persistence adapter for duraflows using `kysely`. Integrates with kysely's type-safe query builder and AsyncLocalStorage-based transaction context.",
   "keywords": [
     "duraflows",
@@ -51,15 +51,15 @@
     "access": "public"
   },
   "peerDependencies": {
-    "@duraflows/core": "^6.0.0",
+    "@duraflows/core": "^7.0.0",
     "kysely": "^0.29.6"
   },
   "devDependencies": {
     "@types/pg": "^8.23.1",
     "kysely": "^0.29.6",
     "pg": "^8.23.0",
-    "@duraflows/core": "6.0.0",
-    "@duraflows/pg": "6.0.0"
+    "@duraflows/core": "7.0.0",
+    "@duraflows/pg": "7.0.0"
   },
   "scripts": {
     "build": "tsc --build"