@tomflow/proflow-task-store-sqlite 0.1.1 → 0.1.3

package/CONFIGURATION.md

@@ -0,0 +1,23 @@
+# task-store-sqlite configuration
+
+Canonical public config: `.proflow/config/task-store-sqlite.json`
+
+This file is Workspace-owned data. `platform uninstall` does not delete it. Values are JSON strings. Raw secrets must not be stored here; `secretRef` fields contain opaque references only.
+
+## Fields
+
+| Key | Type | Required | Sensitive | Source | Meaning |
+|---|---|---:|---:|---|---|
+| `databasePath` | `path` | yes | no | User or owning Module supplies an absolute/local path that exists on this Workspace. | Task SQLite database path |
+
+## Materialize
+
+Create or update the canonical JSON object at:
+
+`.proflow/config/task-store-sqlite.json`
+
+Use only declared keys and string values. Do not create a second Platform configuration database.
+
+## Base completion check
+
+Run `platform modules`. This Module should no longer report required keys in `missingConfig`. `platform start` performs the authoritative Module-owned validation before starting anything.

package/dist/deployment/adapter.d.ts

@@ -1,47 +1,297 @@
+export declare function createBehaviorAdapter(config?: Record<string, string>): {
+    describe: () => {
+        result: {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "SUCCEEDED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            checks?: unknown[];
+        };
+        observedEffects: never[];
+    };
+    preflight: () => {
+        result: {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "SUCCEEDED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            checks?: unknown[];
+        } | {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "ACTION_REQUIRED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            actionRequired: {
+                action: string;
+                description: string;
+            };
+            checks?: unknown[];
+        } | {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "BLOCKED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            error: {
+                code: "VERIFY_FAILED";
+                message: string;
+                retryable: boolean;
+            };
+            checks?: unknown[];
+        };
+        observedEffects: never[];
+    };
+    status: () => {
+        result: {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "SUCCEEDED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            checks?: unknown[];
+            data: {
+                configStatus: "INCOMPLETE";
+                missingConfig: string[];
+                runtimeStatus: "UNKNOWN";
+            };
+        };
+        observedEffects: never[];
+    } | {
+        result: {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "SUCCEEDED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            checks?: unknown[];
+            data: {
+                missingConfig?: never;
+                configStatus: "INVALID" | "READY";
+                runtimeStatus: "UNKNOWN";
+            };
+        };
+        observedEffects: never[];
+    };
+    verify: () => {
+        result: {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "SUCCEEDED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            checks?: unknown[];
+        } | {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "ACTION_REQUIRED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            actionRequired: {
+                action: string;
+                description: string;
+            };
+            checks?: unknown[];
+        } | {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "BLOCKED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            error: {
+                code: "VERIFY_FAILED";
+                message: string;
+                retryable: boolean;
+            };
+            checks?: unknown[];
+        };
+        observedEffects: never[];
+    };
+    doctor: () => {
+        result: {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "SUCCEEDED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            checks?: unknown[];
+        } | {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "ACTION_REQUIRED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            actionRequired: {
+                action: string;
+                description: string;
+            };
+            checks?: unknown[];
+        } | {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "BLOCKED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            error: {
+                code: "VERIFY_FAILED";
+                message: string;
+                retryable: boolean;
+            };
+            checks?: unknown[];
+        };
+        observedEffects: never[];
+    };
+};
 export declare const behaviorAdapter: {
-    readonly describe: () => {
+    describe: () => {
         result: {
-            readonly contract: "deployment.result.v1";
-            readonly ok: true;
-            readonly status: "SUCCEEDED";
-            readonly moduleRef: "task-store-sqlite";
-            readonly moduleVersion: "0.1.1";
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "SUCCEEDED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            checks?: unknown[];
         };
         observedEffects: never[];
     };
-    readonly preflight: () => {
+    preflight: () => {
         result: {
-            readonly contract: "deployment.result.v1";
-            readonly ok: true;
-            readonly status: "SUCCEEDED";
-            readonly moduleRef: "task-store-sqlite";
-            readonly moduleVersion: "0.1.1";
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "SUCCEEDED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            checks?: unknown[];
+        } | {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "ACTION_REQUIRED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            actionRequired: {
+                action: string;
+                description: string;
+            };
+            checks?: unknown[];
+        } | {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "BLOCKED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            error: {
+                code: "VERIFY_FAILED";
+                message: string;
+                retryable: boolean;
+            };
+            checks?: unknown[];
         };
         observedEffects: never[];
     };
-    readonly verify: () => {
+    status: () => {
         result: {
             contract: "deployment.result.v1";
-            ok: true;
+            ok: boolean;
             status: "SUCCEEDED";
             moduleRef: "task-store-sqlite";
-            moduleVersion: "0.1.1";
-            checks: {
-                id: string;
-                status: string;
+            moduleVersion: "0.1.3";
+            checks?: unknown[];
+            data: {
+                configStatus: "INCOMPLETE";
+                missingConfig: string[];
+                runtimeStatus: "UNKNOWN";
+            };
+        };
+        observedEffects: never[];
+    } | {
+        result: {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "SUCCEEDED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            checks?: unknown[];
+            data: {
+                missingConfig?: never;
+                configStatus: "INVALID" | "READY";
+                runtimeStatus: "UNKNOWN";
+            };
+        };
+        observedEffects: never[];
+    };
+    verify: () => {
+        result: {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "SUCCEEDED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            checks?: unknown[];
+        } | {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "ACTION_REQUIRED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            actionRequired: {
+                action: string;
+                description: string;
+            };
+            checks?: unknown[];
+        } | {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "BLOCKED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            error: {
+                code: "VERIFY_FAILED";
                 message: string;
-            }[];
+                retryable: boolean;
+            };
+            checks?: unknown[];
         };
         observedEffects: never[];
     };
-    readonly doctor: () => {
+    doctor: () => {
         result: {
-            readonly contract: "deployment.result.v1";
-            readonly ok: true;
-            readonly status: "SUCCEEDED";
-            readonly moduleRef: "task-store-sqlite";
-            readonly moduleVersion: "0.1.1";
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "SUCCEEDED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            checks?: unknown[];
+        } | {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "ACTION_REQUIRED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            actionRequired: {
+                action: string;
+                description: string;
+            };
+            checks?: unknown[];
+        } | {
+            contract: "deployment.result.v1";
+            ok: boolean;
+            status: "BLOCKED";
+            moduleRef: "task-store-sqlite";
+            moduleVersion: "0.1.3";
+            error: {
+                code: "VERIFY_FAILED";
+                message: string;
+                retryable: boolean;
+            };
+            checks?: unknown[];
         };
         observedEffects: never[];
     };
 };
+export declare function createProductionBinding(input: {
+    config: Record<string, string>;
+}): {
+    behaviorAdapter: Record<string, unknown>;
+};

package/dist/deployment/adapter.js

@@ -1,26 +1,149 @@
+import { existsSync } from "node:fs";
+import { DatabaseSync } from "node:sqlite";
 import { descriptor } from "./descriptor.js";
-const result = {
+const REQUIRED_TABLES = [
+    "schema_migrations",
+    "task_groups",
+    "tasks",
+    "nodes",
+    "task_role_bindings",
+    "node_execution_history",
+    "task_documents",
+    "task_messages",
+    "task_events",
+    "idempotency_records",
+];
+const success = (checks) => ({
     contract: "deployment.result.v1",
     ok: true,
     status: "SUCCEEDED",
     moduleRef: descriptor.moduleRef,
     moduleVersion: descriptor.moduleVersion,
-};
-export const behaviorAdapter = {
-    describe: () => ({ result, observedEffects: [] }),
-    preflight: () => ({ result, observedEffects: [] }),
-    verify: () => ({
-        result: {
-            ...result,
-            checks: [
-                {
-                    id: "sqlite-integrity-pass",
-                    status: "PASS",
-                    message: "SQLite integrity verification is available",
+    ...(checks === undefined ? {} : { checks }),
+});
+const actionRequired = (description, checks) => ({
+    contract: "deployment.result.v1",
+    ok: false,
+    status: "ACTION_REQUIRED",
+    moduleRef: descriptor.moduleRef,
+    moduleVersion: descriptor.moduleVersion,
+    actionRequired: { action: "configure-task-store", description },
+    ...(checks === undefined ? {} : { checks }),
+});
+const blocked = (message, checks) => ({
+    contract: "deployment.result.v1",
+    ok: false,
+    status: "BLOCKED",
+    moduleRef: descriptor.moduleRef,
+    moduleVersion: descriptor.moduleVersion,
+    error: { code: "VERIFY_FAILED", message, retryable: true },
+    ...(checks === undefined ? {} : { checks }),
+});
+function inspect(databasePath) {
+    if (!databasePath)
+        return { ok: false, message: "databasePath is required" };
+    if (!existsSync(databasePath)) {
+        return {
+            ok: false,
+            message: `Task SQLite database does not exist at ${databasePath}`,
+        };
+    }
+    let database;
+    try {
+        database = new DatabaseSync(databasePath, { readOnly: true });
+        const integrity = database.prepare("PRAGMA integrity_check").get();
+        const tables = new Set(database
+            .prepare("SELECT name FROM sqlite_master WHERE type='table'")
+            .all().map((row) => row.name));
+        const missing = REQUIRED_TABLES.filter((table) => !tables.has(table));
+        if (integrity?.integrity_check !== "ok") {
+            return {
+                ok: false,
+                message: `SQLite integrity_check returned ${integrity?.integrity_check ?? "unknown"}`,
+            };
+        }
+        if (missing.length > 0) {
+            return {
+                ok: false,
+                message: `Task SQLite schema is missing tables: ${missing.join(", ")}`,
+            };
+        }
+        return {
+            ok: true,
+            message: "Task SQLite schema is present and integrity_check is ok",
+        };
+    }
+    catch (error) {
+        return {
+            ok: false,
+            message: error instanceof Error
+                ? error.message
+                : "Task SQLite reality could not be read",
+        };
+    }
+    finally {
+        database?.close();
+    }
+}
+export function createBehaviorAdapter(config = {}) {
+    const resultForReality = (reality, checks) => reality.ok
+        ? success(checks)
+        : config.databasePath
+            ? blocked(reality.message, checks)
+            : actionRequired(reality.message, checks);
+    return {
+        describe: () => ({ result: success(), observedEffects: [] }),
+        preflight: () => {
+            const reality = inspect(config.databasePath);
+            return { result: resultForReality(reality), observedEffects: [] };
+        },
+        status: () => {
+            if (!config.databasePath) {
+                return {
+                    result: {
+                        ...success(),
+                        data: {
+                            configStatus: "INCOMPLETE",
+                            missingConfig: ["databasePath"],
+                            runtimeStatus: "UNKNOWN",
+                        },
+                    },
+                    observedEffects: [],
+                };
+            }
+            const reality = inspect(config.databasePath);
+            return {
+                result: {
+                    ...success(),
+                    data: {
+                        configStatus: reality.ok
+                            ? "READY"
+                            : "INVALID",
+                        runtimeStatus: "UNKNOWN",
+                    },
                 },
-            ],
+                observedEffects: [],
+            };
+        },
+        verify: () => {
+            const reality = inspect(config.databasePath);
+            const check = {
+                id: "sqlite-integrity-pass",
+                status: reality.ok ? "PASS" : "FAIL",
+                message: reality.message,
+            };
+            return {
+                result: resultForReality(reality, [check]),
+                observedEffects: [],
+            };
+        },
+        doctor: () => {
+            const reality = inspect(config.databasePath);
+            return { result: resultForReality(reality), observedEffects: [] };
         },
-        observedEffects: [],
-    }),
-    doctor: () => ({ result, observedEffects: [] }),
-};
+    };
+}
+export const behaviorAdapter = createBehaviorAdapter();
+export function createProductionBinding(input) {
+    return { behaviorAdapter: createBehaviorAdapter(input.config) };
+}

package/dist/deployment/descriptor.d.ts

@@ -3,11 +3,10 @@ export declare const descriptor: {
     readonly contractVersion: "1.0.0";
     readonly moduleRef: "task-store-sqlite";
     readonly packageName: "@tomflow/proflow-task-store-sqlite";
-    readonly moduleVersion: "0.1.1";
+    readonly moduleVersion: "0.1.3";
     readonly kind: "library";
     readonly templateVersion: "1.0.0";
     readonly platformCompatibility: ">=1.0.0 <2.0.0";
-    readonly installClass: "core";
     readonly identity: {
         readonly domain: "task-orchestration";
         readonly summary: "Provides the node:sqlite store and repository adapters for Task-owned structured facts.";
@@ -29,7 +28,7 @@ export declare const descriptor: {
         readonly description: "Task SQLite database path";
     }];
     readonly lifecycle: {
-        readonly supported: readonly ["describe", "preflight", "verify", "doctor"];
+        readonly supported: readonly ["describe", "preflight", "status", "verify", "doctor"];
     };
     readonly verification: {
         readonly checks: readonly [{
@@ -47,5 +46,9 @@ export declare const descriptor: {
         readonly id: "overview";
         readonly path: "./README.md";
         readonly description: "Package-owned module overview";
+    }, {
+        readonly id: "configuration";
+        readonly path: "./CONFIGURATION.md";
+        readonly description: "Module configuration fields, sources and materialization instructions";
     }];
 };

package/dist/deployment/descriptor.js

@@ -3,21 +3,27 @@ export const descriptor = {
     contractVersion: "1.0.0",
     moduleRef: "task-store-sqlite",
     packageName: "@tomflow/proflow-task-store-sqlite",
-    moduleVersion: "0.1.1",
+    moduleVersion: "0.1.3",
     kind: "library",
     templateVersion: "1.0.0",
     platformCompatibility: ">=1.0.0 <2.0.0",
-    installClass: "core",
     identity: {
         domain: "task-orchestration",
         summary: "Provides the node:sqlite store and repository adapters for Task-owned structured facts.",
     },
     provides: [],
     requires: [
-        { contractRef: "task-orchestration", versionRange: ">=1.0.0 <2.0.0" },
+        {
+            contractRef: "task-orchestration",
+            versionRange: ">=1.0.0 <2.0.0",
+        },
     ],
     requirements: [
-        { kind: "runtime", runtime: "node", versionRange: ">=24.19.0" },
+        {
+            kind: "runtime",
+            runtime: "node",
+            versionRange: ">=24.19.0",
+        },
     ],
     configSlots: [
         {
@@ -27,7 +33,9 @@ export const descriptor = {
             description: "Task SQLite database path",
         },
     ],
-    lifecycle: { supported: ["describe", "preflight", "verify", "doctor"] },
+    lifecycle: {
+        supported: ["describe", "preflight", "status", "verify", "doctor"],
+    },
     verification: {
         checks: [
             {
@@ -50,5 +58,10 @@ export const descriptor = {
             path: "./README.md",
             description: "Package-owned module overview",
         },
+        {
+            id: "configuration",
+            path: "./CONFIGURATION.md",
+            description: "Module configuration fields, sources and materialization instructions",
+        },
     ],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tomflow/proflow-task-store-sqlite",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "type": "module",
   "publishConfig": {
     "access": "public"
@@ -16,14 +16,14 @@
     "proflow.module.json",
     "conformance.json",
     "README.md",
-    "self-install.mjs"
+    "CONFIGURATION.md"
   ],
   "dependencies": {
-    "@tomflow/proflow-module-contract": "^0.1.1",
-    "@tomflow/proflow-task-orchestration": "^0.1.1"
+    "@tomflow/proflow-task-orchestration": "^0.1.2",
+    "@tomflow/proflow-module-contract": "^0.1.2"
   },
   "devDependencies": {
-    "@tomflow/proflow-task-migration-runner": "^0.1.1"
+    "@tomflow/proflow-task-migration-runner": "^0.1.3"
   },
   "description": "Provides the node:sqlite store and repository adapters for Task-owned structured facts.",
   "keywords": [
@@ -33,17 +33,9 @@
   ],
   "proflow": {
     "module": true,
-    "installClass": "core",
-    "installRequires": [
-      "@tomflow/proflow-module-contract",
-      "@tomflow/proflow-task-orchestration"
-    ],
     "descriptor": "./dist/deployment/descriptor.js",
     "manifest": "./proflow.module.json"
   },
-  "bin": {
-    "proflow-task-store-sqlite": "./self-install.mjs"
-  },
   "scripts": {
     "test": "node --test tests/**/*.test.ts",
     "typecheck": "tsc --noEmit"

package/proflow.module.json

@@ -3,11 +3,10 @@
 	"contractVersion": "1.0.0",
 	"moduleRef": "task-store-sqlite",
 	"packageName": "@tomflow/proflow-task-store-sqlite",
-	"moduleVersion": "0.1.1",
+	"moduleVersion": "0.1.3",
 	"kind": "library",
 	"templateVersion": "1.0.0",
 	"platformCompatibility": ">=1.0.0 <2.0.0",
-	"installClass": "core",
 	"identity": {
 		"domain": "task-orchestration",
 		"summary": "Provides the node:sqlite store and repository adapters for Task-owned structured facts."
@@ -35,7 +34,7 @@
 		}
 	],
 	"lifecycle": {
-		"supported": ["describe", "preflight", "verify", "doctor"]
+		"supported": ["describe", "preflight", "status", "verify", "doctor"]
 	},
 	"verification": {
 		"checks": [
@@ -58,6 +57,11 @@
 			"id": "overview",
 			"path": "./README.md",
 			"description": "Package-owned module overview"
+		},
+		{
+			"id": "configuration",
+			"path": "./CONFIGURATION.md",
+			"description": "Module configuration fields, sources and materialization instructions"
 		}
 	]
 }

package/CHANGELOG.md

@@ -1,7 +0,0 @@
-# @tomflow/proflow-task-store-sqlite
-
-## 0.1.1
-
-### Patch Changes
-
-- Close the Real-1 global Platform control-plane contract across every published ProFlow package. Platform CLI now owns one durable global Workspace binding with canonical identity, cross-process operation locking, cwd/`--workspace` install targeting, cross-directory instance commands, whole-instance uninstall/rebind, and deterministic npm/yarn/pnpm Workspace package-manager selection. Every package-owned install entry, including newly generated Module Template packages, delegates to the Shell-global `platform` command and fails closed when that global CLI is unavailable; Deployment Conformance and the formal test plans mechanically enforce the same rule across all 24 packages.

package/self-install.mjs

@@ -1,34 +0,0 @@
-#!/usr/bin/env node
-import { spawnSync } from "node:child_process";
-
-const [command, ...rest] = process.argv.slice(2);
-const usage = "Usage: npx @tomflow/proflow-task-store-sqlite install\n";
-if (command === "--help" || command === "-h") {
-	process.stdout.write(usage);
-	process.exit(0);
-}
-if (command !== "install" || rest.length > 0) {
-	process.stderr.write(usage);
-	process.exit(2);
-}
-const executable = process.platform === "win32" ? "platform.cmd" : "platform";
-const result = spawnSync(
-	executable,
-	[
-		"install",
-		"@tomflow/proflow-task-store-sqlite",
-		"--workspace",
-		process.cwd(),
-	],
-	{ cwd: process.cwd(), env: process.env, stdio: "inherit" },
-);
-if (result.error) {
-	if (result.error.code === "ENOENT") {
-		process.stderr.write(
-			"GLOBAL_PLATFORM_CLI_REQUIRED: install @tomflow/proflow-platform-cli globally before package-owned install\n",
-		);
-		process.exit(127);
-	}
-	throw result.error;
-}
-process.exit(result.status ?? 1);