@tomflow/proflow-platform-cli 0.1.16 → 0.1.18

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @tomflow/proflow-platform-cli
+
+## 0.1.18
+
+### Patch Changes
+
+- Align all Modules to the seven-command setup contract with executable package-owned setup guidance and full Platform setup aggregation.

package/DOCS.md

@@ -0,0 +1,27 @@
+# @tomflow/proflow-platform-cli — Module Docs
+
+Module ref: `platform-cli`  
+Domain: `deployment-governance`  
+Kind: `cli`
+
+Thin Platform CLI for Module discovery, documentation, package synchronization and lifecycle orchestration.
+
+## Standard management surface
+
+`install / uninstall / status / setup / docs / start / stop`
+
+## Provides
+
+- None.
+
+## Requires
+
+- None.
+
+## Public setup inputs
+
+- None. Deterministic/private values and cross-Module shared facts are not public configuration.
+
+## Ownership boundary
+
+Module business APIs and any module-specific extra commands remain package-owned. Platform does not proxy or interpret them. Current human/external preparation is documented in `SETUP.md`.

package/SETUP.md

@@ -0,0 +1,27 @@
+# @tomflow/proflow-platform-cli — Module Setup
+
+The Platform CLI owns orchestration only. It never interprets another Module's setup details. Global `platform setup` traverses every discovered Module, skips `READY` Modules, lets each non-ready Module run its own package-owned setup workflow, and aggregates every remaining `ACTION_REQUIRED` or `FAILED` result in one response.
+
+## Step 1 — Verify the Platform CLI Module
+
+**Executable:**
+
+```bash
+platform setup --module platform-cli
+```
+
+**Success condition:**
+
+`platform status` reports `platform-cli setup=READY`. No user/private path, token, loopback endpoint, or cross-Module fact is requested.
+
+## Step 2 — Run the full workspace setup guide
+
+**Executable:**
+
+```bash
+platform setup
+```
+
+**Success condition:**
+
+All automatically solvable Module setup work is completed in the same run, and every remaining human/external action is listed together. Re-running the command re-observes reality and continues until all required Modules report `setupStatus=READY`.

package/dist/deployment/adapter.d.ts

@@ -1,57 +1,81 @@
+import type { ModuleCommandContext } from "@tomflow/proflow-module-contract";
 export declare const behaviorAdapter: {
-    describe: () => {
+    readonly install: (_context: ModuleCommandContext) => Promise<{
         result: {
-            contract: "deployment.result.v1";
-            ok: boolean;
-            status: "SUCCEEDED";
-            moduleRef: "platform-cli";
-            moduleVersion: "0.1.16";
-            data?: {} | null;
+            readonly contract: "deployment.result.v1";
+            readonly ok: true;
+            readonly status: "SUCCEEDED";
+            readonly moduleRef: "platform-cli";
+            readonly moduleVersion: "0.1.18";
         };
         observedEffects: never[];
-    };
-    preflight: () => {
+    }>;
+    readonly uninstall: (_context: ModuleCommandContext) => Promise<{
         result: {
-            contract: "deployment.result.v1";
-            ok: boolean;
-            status: "SUCCEEDED";
-            moduleRef: "platform-cli";
-            moduleVersion: "0.1.16";
-            data?: {} | null;
+            readonly contract: "deployment.result.v1";
+            readonly ok: true;
+            readonly status: "SUCCEEDED";
+            readonly moduleRef: "platform-cli";
+            readonly moduleVersion: "0.1.18";
         };
         observedEffects: never[];
-    };
-    status: () => {
+    }>;
+    readonly status: (_context: ModuleCommandContext) => Promise<{
         result: {
             contract: "deployment.result.v1";
-            ok: boolean;
+            ok: true;
             status: "SUCCEEDED";
             moduleRef: "platform-cli";
-            moduleVersion: "0.1.16";
-            data?: {} | null;
+            moduleVersion: "0.1.18";
+            data: {
+                readonly setupStatus: "READY";
+                readonly runtimeStatus: "NOT_APPLICABLE";
+            };
         };
         observedEffects: never[];
-    };
-    verify: () => {
+    }>;
+    readonly setup: (_context: ModuleCommandContext) => Promise<{
         result: {
-            contract: "deployment.result.v1";
-            ok: boolean;
-            status: "SUCCEEDED";
-            moduleRef: "platform-cli";
-            moduleVersion: "0.1.16";
-            data?: {} | null;
+            readonly contract: "deployment.result.v1";
+            readonly ok: true;
+            readonly status: "SUCCEEDED";
+            readonly moduleRef: "platform-cli";
+            readonly moduleVersion: "0.1.18";
         };
         observedEffects: never[];
-    };
-    doctor: () => {
+    }>;
+    readonly docs: (_context: ModuleCommandContext) => Promise<{
         result: {
             contract: "deployment.result.v1";
-            ok: boolean;
+            ok: true;
             status: "SUCCEEDED";
             moduleRef: "platform-cli";
-            moduleVersion: "0.1.16";
-            data?: {} | null;
+            moduleVersion: "0.1.18";
+            data: {
+                docs: string;
+                setup: string;
+            };
+        };
+        observedEffects: never[];
+    }>;
+    readonly start: (_context: ModuleCommandContext) => Promise<{
+        result: {
+            readonly contract: "deployment.result.v1";
+            readonly ok: true;
+            readonly status: "SUCCEEDED";
+            readonly moduleRef: "platform-cli";
+            readonly moduleVersion: "0.1.18";
+        };
+        observedEffects: never[];
+    }>;
+    readonly stop: (_context: ModuleCommandContext) => Promise<{
+        result: {
+            readonly contract: "deployment.result.v1";
+            readonly ok: true;
+            readonly status: "SUCCEEDED";
+            readonly moduleRef: "platform-cli";
+            readonly moduleVersion: "0.1.18";
         };
         observedEffects: never[];
-    };
+    }>;
 };

package/dist/deployment/adapter.js

@@ -1,26 +1,42 @@
-import { observeDeclaredModuleStatus } from "@tomflow/proflow-module-contract";
 import { descriptor } from "./descriptor.js";
-const success = (data) => ({
+const base = {
     contract: "deployment.result.v1",
     ok: true,
     status: "SUCCEEDED",
     moduleRef: descriptor.moduleRef,
     moduleVersion: descriptor.moduleVersion,
-    ...(data === undefined ? {} : { data }),
-});
+};
+const noRuntime = {
+    setupStatus: "READY",
+    runtimeStatus: "NOT_APPLICABLE",
+};
 export const behaviorAdapter = {
-    describe: () => ({
-        result: success({ role: "deployment-governance", kind: descriptor.kind }),
+    install: async (_context) => ({
+        result: base,
+        observedEffects: [],
+    }),
+    uninstall: async (_context) => ({
+        result: base,
+        observedEffects: [],
+    }),
+    status: async (_context) => ({
+        result: { ...base, data: noRuntime },
+        observedEffects: [],
+    }),
+    setup: async (_context) => ({
+        result: base,
+        observedEffects: [],
+    }),
+    docs: async (_context) => ({
+        result: { ...base, data: { docs: "DOCS.md", setup: "SETUP.md" } },
         observedEffects: [],
     }),
-    preflight: () => ({ result: success(), observedEffects: [] }),
-    status: () => ({
-        result: success(observeDeclaredModuleStatus(descriptor, undefined, "UNKNOWN")),
+    start: async (_context) => ({
+        result: base,
         observedEffects: [],
     }),
-    verify: () => ({
-        result: success(),
+    stop: async (_context) => ({
+        result: base,
         observedEffects: [],
     }),
-    doctor: () => ({ result: success(), observedEffects: [] }),
 };

package/dist/deployment/descriptor.d.ts

@@ -3,7 +3,7 @@ export declare const descriptor: {
     readonly contractVersion: "1.0.0";
     readonly moduleRef: "platform-cli";
     readonly packageName: "@tomflow/proflow-platform-cli";
-    readonly moduleVersion: "0.1.16";
+    readonly moduleVersion: "0.1.18";
     readonly kind: "cli";
     readonly templateVersion: "1.0.0";
     readonly platformCompatibility: ">=1.0.0 <2.0.0";
@@ -19,20 +19,9 @@ export declare const descriptor: {
         readonly versionRange: ">=24.19.0";
     }];
     readonly configSlots: readonly [];
-    readonly lifecycle: {
-        readonly supported: readonly ["describe", "preflight", "status", "verify", "doctor"];
-    };
-    readonly verification: {
-        readonly checks: readonly [{
-            readonly id: "cli-surface";
-            readonly description: "Deterministic command surface parses and dispatches";
-            readonly lifecycle: "verify";
-        }];
-    };
     readonly effects: readonly [];
-    readonly documentation: readonly [{
-        readonly id: "overview";
-        readonly path: "./README.md";
-        readonly description: "Platform CLI package overview and command surface";
-    }];
+    readonly documentation: {
+        readonly docs: "DOCS.md";
+        readonly setup: "SETUP.md";
+    };
 };

package/dist/deployment/descriptor.js

@@ -3,7 +3,7 @@ export const descriptor = {
     contractVersion: "1.0.0",
     moduleRef: "platform-cli",
     packageName: "@tomflow/proflow-platform-cli",
-    moduleVersion: "0.1.16",
+    moduleVersion: "0.1.18",
     kind: "cli",
     templateVersion: "1.0.0",
     platformCompatibility: ">=1.0.0 <2.0.0",
@@ -14,27 +14,16 @@ export const descriptor = {
     provides: [],
     requires: [],
     requirements: [
-        { kind: "runtime", runtime: "node", versionRange: ">=24.19.0" },
-    ],
-    configSlots: [],
-    lifecycle: {
-        supported: ["describe", "preflight", "status", "verify", "doctor"],
-    },
-    verification: {
-        checks: [
-            {
-                id: "cli-surface",
-                description: "Deterministic command surface parses and dispatches",
-                lifecycle: "verify",
-            },
-        ],
-    },
-    effects: [],
-    documentation: [
         {
-            id: "overview",
-            path: "./README.md",
-            description: "Platform CLI package overview and command surface",
+            kind: "runtime",
+            runtime: "node",
+            versionRange: ">=24.19.0",
         },
     ],
+    configSlots: [],
+    effects: [],
+    documentation: {
+        docs: "DOCS.md",
+        setup: "SETUP.md",
+    },
 };