@tomflow/proflow-dev-tunnel 0.1.5 → 0.1.7

package/DOCS.md

@@ -0,0 +1,27 @@
+# @tomflow/proflow-dev-tunnel — Module Docs
+
+Module ref: `dev-tunnel`  
+Domain: `deployment-governance`  
+Kind: `external-resource`
+
+Governs the Microsoft Dev Tunnel public HTTPS ingress resource and its managed local host process.
+
+## 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,7 @@
+# @tomflow/proflow-dev-tunnel — Module Setup
+
+Authenticate with Microsoft Dev Tunnels when requested, create or select the required tunnel, and allow the Module to establish and verify the public HTTPS ingress. The resulting tunnel id/public URL/evidence are Module-owned state or shared facts, not values to copy into Platform config.
+
+## Completion
+
+Setup is complete only when the Module's own `status` reports `setupStatus=READY`. Re-running setup must re-observe reality; it must not resume from a blind historical step index.

package/dist/deployment/adapter.d.ts

@@ -1,141 +1,137 @@
-import type { ModuleOperationResult } from "@tomflow/proflow-module-contract";
-import type { DevTunnelRuntime, ErrorSemanticsProof, FileRelayProof } from "../src/resource-adapter.ts";
-type DevTunnelVerificationEvidence = {
-    contract: "proflow.dev-tunnel-verification.v1";
-    moduleVersion: string;
-    publicBaseUrl: string;
-    observedAt: string;
-    fileRelay: FileRelayProof;
-    errorSemantics: ErrorSemanticsProof;
-};
-export declare function readDevTunnelVerificationEvidence(file: string | undefined, publicBaseUrl: string): Promise<DevTunnelVerificationEvidence | undefined>;
-export declare function createBehaviorAdapter(input?: {
-    runtime: DevTunnelRuntime;
-    verifyErrorSemantics?: () => Promise<ErrorSemanticsProof>;
-    verifyFileRelay?: () => Promise<FileRelayProof>;
-}): {
-    describe: () => {
-        result: ModuleOperationResult;
-        observedEffects: never[];
-    };
-    preflight: () => {
-        result: ModuleOperationResult;
-        observedEffects: never[];
-    };
-    status: () => Promise<{
-        result: ModuleOperationResult;
+import { type ModuleCommandContext } from "@tomflow/proflow-module-contract";
+export declare const behaviorAdapter: {
+    readonly install: (context: ModuleCommandContext) => Promise<{
+        result: {
+            readonly contract: "deployment.result.v1";
+            readonly ok: true;
+            readonly status: "SUCCEEDED";
+            readonly moduleRef: "dev-tunnel";
+            readonly moduleVersion: "0.1.7";
+        };
         observedEffects: never[];
     }>;
-    verify: () => Promise<{
-        result: ModuleOperationResult;
-        observedEffects: never[];
+    readonly uninstall: (context: ModuleCommandContext) => Promise<{
+        result: {
+            readonly contract: "deployment.result.v1";
+            readonly ok: true;
+            readonly status: "SUCCEEDED";
+            readonly moduleRef: "dev-tunnel";
+            readonly moduleVersion: "0.1.7";
+        };
+        observedEffects: string[];
     } | {
         result: {
             contract: "deployment.result.v1";
-            ok: boolean;
-            status: "ACTION_REQUIRED" | "BLOCKED" | "FAILED" | "SUCCEEDED";
-            moduleRef: string;
-            moduleVersion: string;
-            actionRequired?: {
-                action: string;
-                description: string;
-            } | undefined;
-            error?: {
-                code: "APPLY_FAILED" | "COMMAND_FAILED" | "COMPATIBILITY_MISMATCH" | "CONFIG_REQUIRED" | "CONFORMANCE_FAILED" | "CONTRACT_INVALID" | "CORE_PACKAGE_REQUIRED" | "DEPENDENCY_UNRESOLVED" | "DOCTOR_FAILED" | "EXTERNAL_RESOURCE_UNAVAILABLE" | "INVALID_REQUEST" | "LIFECYCLE_UNSUPPORTED" | "MODULE_NOT_FOUND" | "PLAN_INVALID" | "PLAN_STALE" | "REQUIREMENT_UNMET" | "UNINSTALL_FAILED" | "UPGRADE_FAILED" | "VERIFY_FAILED";
+            moduleRef: "dev-tunnel";
+            moduleVersion: "0.1.7";
+            ok: false;
+            status: "FAILED";
+            error: {
+                code: "UNINSTALL_FAILED";
                 message: string;
                 retryable: boolean;
-            } | undefined;
-            resourceVersion?: string | undefined;
-            data?: unknown;
-            checks: import("../src/resource-adapter.ts").IngressCheck[];
+            };
         };
-        observedEffects: string[];
-    }>;
-    doctor: () => Promise<{
-        result: ModuleOperationResult;
         observedEffects: never[];
     }>;
-    start: () => Promise<{
-        result: ModuleOperationResult;
-        observedEffects: string[];
-    }>;
-    stop: () => Promise<{
-        result: ModuleOperationResult;
-        observedEffects: string[];
-    }>;
-    uninstall: () => Promise<{
-        result: ModuleOperationResult;
-        observedEffects: string[];
-    }>;
-    restart: () => Promise<{
-        result: ModuleOperationResult;
-        observedEffects: string[];
-    }>;
-};
-export declare const behaviorAdapter: {
-    describe: () => {
-        result: ModuleOperationResult;
+    readonly status: (context: ModuleCommandContext) => Promise<{
+        result: {
+            contract: "deployment.result.v1";
+            ok: true;
+            status: "SUCCEEDED";
+            moduleRef: "dev-tunnel";
+            moduleVersion: "0.1.7";
+            data: {
+                setupStatus: "ACTION_REQUIRED" | "READY";
+                runtimeStatus: "FAILED" | "RUNNING" | "STOPPED";
+            };
+        };
         observedEffects: never[];
-    };
-    preflight: () => {
-        result: ModuleOperationResult;
+    }>;
+    readonly setup: (context: ModuleCommandContext) => Promise<{
+        result: {
+            contract: "deployment.result.v1";
+            moduleRef: "dev-tunnel";
+            moduleVersion: "0.1.7";
+            ok: false;
+            status: "ACTION_REQUIRED";
+            actionRequired: {
+                action: string;
+                description: string;
+            };
+        };
         observedEffects: never[];
-    };
-    status: () => Promise<{
-        result: ModuleOperationResult;
+    } | {
+        result: {
+            readonly contract: "deployment.result.v1";
+            readonly ok: true;
+            readonly status: "SUCCEEDED";
+            readonly moduleRef: "dev-tunnel";
+            readonly moduleVersion: "0.1.7";
+        };
         observedEffects: never[];
     }>;
-    verify: () => Promise<{
-        result: ModuleOperationResult;
+    readonly docs: (_context: ModuleCommandContext) => Promise<{
+        result: {
+            contract: "deployment.result.v1";
+            ok: true;
+            status: "SUCCEEDED";
+            moduleRef: "dev-tunnel";
+            moduleVersion: "0.1.7";
+            data: {
+                docs: string;
+                setup: string;
+            };
+        };
         observedEffects: never[];
-    } | {
+    }>;
+    readonly start: (context: ModuleCommandContext) => Promise<{
         result: {
             contract: "deployment.result.v1";
-            ok: boolean;
-            status: "ACTION_REQUIRED" | "BLOCKED" | "FAILED" | "SUCCEEDED";
-            moduleRef: string;
-            moduleVersion: string;
-            actionRequired?: {
-                action: string;
-                description: string;
-            } | undefined;
-            error?: {
-                code: "APPLY_FAILED" | "COMMAND_FAILED" | "COMPATIBILITY_MISMATCH" | "CONFIG_REQUIRED" | "CONFORMANCE_FAILED" | "CONTRACT_INVALID" | "CORE_PACKAGE_REQUIRED" | "DEPENDENCY_UNRESOLVED" | "DOCTOR_FAILED" | "EXTERNAL_RESOURCE_UNAVAILABLE" | "INVALID_REQUEST" | "LIFECYCLE_UNSUPPORTED" | "MODULE_NOT_FOUND" | "PLAN_INVALID" | "PLAN_STALE" | "REQUIREMENT_UNMET" | "UNINSTALL_FAILED" | "UPGRADE_FAILED" | "VERIFY_FAILED";
+            moduleRef: "dev-tunnel";
+            moduleVersion: "0.1.7";
+            ok: false;
+            status: "FAILED";
+            error: {
+                code: "START_FAILED";
                 message: string;
                 retryable: boolean;
-            } | undefined;
-            resourceVersion?: string | undefined;
-            data?: unknown;
-            checks: import("../src/resource-adapter.ts").IngressCheck[];
+            };
         };
-        observedEffects: string[];
-    }>;
-    doctor: () => Promise<{
-        result: ModuleOperationResult;
         observedEffects: never[];
-    }>;
-    start: () => Promise<{
-        result: ModuleOperationResult;
-        observedEffects: string[];
-    }>;
-    stop: () => Promise<{
-        result: ModuleOperationResult;
-        observedEffects: string[];
-    }>;
-    uninstall: () => Promise<{
-        result: ModuleOperationResult;
+    } | {
+        result: {
+            contract: "deployment.result.v1";
+            ok: true;
+            status: "SUCCEEDED";
+            moduleRef: "dev-tunnel";
+            moduleVersion: "0.1.7";
+            data: import("../src/resource-adapter.ts").DevTunnelObservation;
+        };
         observedEffects: string[];
     }>;
-    restart: () => Promise<{
-        result: ModuleOperationResult;
+    readonly stop: (context: ModuleCommandContext) => Promise<{
+        result: {
+            readonly contract: "deployment.result.v1";
+            readonly ok: true;
+            readonly status: "SUCCEEDED";
+            readonly moduleRef: "dev-tunnel";
+            readonly moduleVersion: "0.1.7";
+        };
         observedEffects: string[];
+    } | {
+        result: {
+            contract: "deployment.result.v1";
+            moduleRef: "dev-tunnel";
+            moduleVersion: "0.1.7";
+            ok: false;
+            status: "FAILED";
+            error: {
+                code: "STOP_FAILED";
+                message: string;
+                retryable: boolean;
+            };
+        };
+        observedEffects: never[];
     }>;
 };
-export declare function createProductionBinding(input: {
-    moduleRef: string;
-    config: Record<string, string>;
-    workspaceRoot: string;
-}): Promise<{
-    behaviorAdapter: Record<string, unknown>;
-} | undefined>;
-export {};