@treeseed/sdk 0.1.1 → 0.3.0

package/dist/workflow/operations.d.ts

@@ -0,0 +1,396 @@
+import { resolveTreeseedWorkflowState } from '../workflow-state.ts';
+import type { TreeseedCloseInput, TreeseedConfigInput, TreeseedDestroyInput, TreeseedReleaseInput, TreeseedSaveInput, TreeseedStageInput, TreeseedSwitchInput, TreeseedTaskBranchMetadata, TreeseedWorkflowContext, TreeseedWorkflowDevInput, TreeseedWorkflowNextStep, TreeseedWorkflowOperationId, TreeseedWorkflowResult } from '../workflow.ts';
+type WorkflowWrite = NonNullable<TreeseedWorkflowContext['write']>;
+export type TreeseedWorkflowErrorCode = 'validation_failed' | 'merge_conflict' | 'missing_runtime_auth' | 'deployment_timeout' | 'confirmation_required' | 'unsupported_transport' | 'unsupported_state';
+export declare class TreeseedWorkflowError extends Error {
+    code: TreeseedWorkflowErrorCode;
+    operation: TreeseedWorkflowOperationId;
+    details?: Record<string, unknown>;
+    exitCode?: number;
+    constructor(operation: TreeseedWorkflowOperationId, code: TreeseedWorkflowErrorCode, message: string, options?: {
+        details?: Record<string, unknown>;
+        exitCode?: number;
+    });
+}
+export type WorkflowOperationHelpers = {
+    context: TreeseedWorkflowContext;
+    cwd(): string;
+    write: WorkflowWrite;
+    runStatus(): Promise<TreeseedWorkflowResult<ReturnType<typeof resolveTreeseedWorkflowState>>>;
+    runTasks(): Promise<TreeseedWorkflowResult<{
+        tasks: TreeseedTaskBranchMetadata[];
+    }>>;
+};
+type TreeseedRepairAction = {
+    id: string;
+    detail: string;
+};
+export declare function workflowStatus(helpers: WorkflowOperationHelpers): Promise<TreeseedWorkflowResult<import("../workflow-state.ts").TreeseedWorkflowState>>;
+export declare function workflowTasks(helpers: WorkflowOperationHelpers): Promise<TreeseedWorkflowResult<{
+    tasks: TreeseedTaskBranchMetadata[];
+}>>;
+export declare function workflowConfig(helpers: WorkflowOperationHelpers, input?: TreeseedConfigInput): Promise<{
+    ok: true;
+    operation: "config";
+    payload: {
+        mode: string;
+        scopes: ("local" | "staging" | "prod")[];
+        sync: "all" | "cloudflare" | "railway" | "none" | "github";
+        secretsRevealed: boolean;
+        reports: {
+            scope: "local" | "staging" | "prod";
+            environmentReport: string;
+            providerReport: string;
+        }[];
+        repairs: TreeseedRepairAction[];
+        preflight: {
+            ok: boolean;
+            requireAuth: boolean;
+            missingCommands: string[];
+            failingAuth: string[];
+            checks: {
+                commands: {
+                    [k: string]: {
+                        installed: boolean;
+                        path: string | null;
+                    };
+                };
+                auth: {};
+            };
+        };
+        toolHealth: {
+            githubCli: {
+                name: any;
+                available: any;
+                detail: any;
+            };
+            ghActExtension: {
+                name: any;
+                available: any;
+                detail: any;
+            };
+            dockerDaemon: {
+                name: any;
+                available: any;
+                detail: any;
+            };
+            actVerificationReady: any;
+            remediation: string[];
+        };
+        keyPath?: undefined;
+        configPath?: undefined;
+        result?: undefined;
+        state?: undefined;
+    };
+    nextSteps: TreeseedWorkflowNextStep[];
+} | {
+    ok: true;
+    operation: "config";
+    payload: {
+        mode: string;
+        scopes: ("local" | "staging" | "prod")[];
+        sync: "all" | "cloudflare" | "railway" | "none" | "github";
+        keyPath: string;
+        repairs: TreeseedRepairAction[];
+        preflight: {
+            ok: boolean;
+            requireAuth: boolean;
+            missingCommands: string[];
+            failingAuth: string[];
+            checks: {
+                commands: {
+                    [k: string]: {
+                        installed: boolean;
+                        path: string | null;
+                    };
+                };
+                auth: {};
+            };
+        };
+        toolHealth: {
+            githubCli: {
+                name: any;
+                available: any;
+                detail: any;
+            };
+            ghActExtension: {
+                name: any;
+                available: any;
+                detail: any;
+            };
+            dockerDaemon: {
+                name: any;
+                available: any;
+                detail: any;
+            };
+            actVerificationReady: any;
+            remediation: string[];
+        };
+        secretsRevealed?: undefined;
+        reports?: undefined;
+        configPath?: undefined;
+        result?: undefined;
+        state?: undefined;
+    };
+    nextSteps: TreeseedWorkflowNextStep[];
+} | {
+    ok: true;
+    operation: "config";
+    payload: {
+        mode: string;
+        scopes: ("local" | "staging" | "prod")[];
+        sync: "all" | "cloudflare" | "railway" | "none" | "github";
+        configPath: string;
+        keyPath: string;
+        repairs: TreeseedRepairAction[];
+        preflight: {
+            ok: boolean;
+            requireAuth: boolean;
+            missingCommands: string[];
+            failingAuth: string[];
+            checks: {
+                commands: {
+                    [k: string]: {
+                        installed: boolean;
+                        path: string | null;
+                    };
+                };
+                auth: {};
+            };
+        };
+        toolHealth: {
+            githubCli: {
+                name: any;
+                available: any;
+                detail: any;
+            };
+            ghActExtension: {
+                name: any;
+                available: any;
+                detail: any;
+            };
+            dockerDaemon: {
+                name: any;
+                available: any;
+                detail: any;
+            };
+            actVerificationReady: any;
+            remediation: string[];
+        };
+        result: {
+            scopes: string[];
+            updated: never[];
+            synced: {};
+            initialized: never[];
+            connectionChecks: never[];
+        };
+        state: import("../workflow-state.ts").TreeseedWorkflowState;
+        secretsRevealed?: undefined;
+        reports?: undefined;
+    };
+    nextSteps: TreeseedWorkflowNextStep[];
+}>;
+export declare function workflowSwitch(helpers: WorkflowOperationHelpers, input: TreeseedSwitchInput): Promise<{
+    ok: boolean;
+    operation: string;
+    payload: {
+        branchName: string;
+        created: boolean;
+        resumed: boolean;
+        previewRequested: boolean;
+        preview: {
+            enabled: boolean;
+            url: string | null;
+            lastDeploymentTimestamp: string | null;
+        };
+        previewResult: Record<string, unknown> | null;
+        state: import("../workflow-state.ts").TreeseedWorkflowState;
+    };
+    nextSteps: TreeseedWorkflowNextStep[];
+}>;
+export declare function workflowDev(helpers: WorkflowOperationHelpers, input?: TreeseedWorkflowDevInput): Promise<{
+    ok: true;
+    operation: "dev";
+    payload: {
+        watch: boolean;
+        background: boolean;
+        command: string;
+        args: string[];
+        cwd: string;
+        pid: number | null;
+        exitCode: null;
+    };
+} | {
+    ok: boolean;
+    operation: "dev";
+    payload: {
+        watch: boolean;
+        background: boolean;
+        command: string;
+        args: string[];
+        cwd: string;
+        pid: null;
+        exitCode: number;
+    };
+}>;
+export declare function workflowSave(helpers: WorkflowOperationHelpers, input: TreeseedSaveInput): Promise<{
+    ok: boolean;
+    operation: string;
+    payload: {
+        branch: string;
+        scope: string;
+        hotfix: boolean;
+        message: string;
+        commitSha: string;
+        previewRefresh: Record<string, unknown> | null;
+    };
+    nextSteps: TreeseedWorkflowNextStep[];
+}>;
+export declare function workflowClose(helpers: WorkflowOperationHelpers, input: TreeseedCloseInput): Promise<{
+    ok: boolean;
+    operation: string;
+    payload: {
+        branchName: string;
+        message: string;
+        deprecatedTag: {
+            tagName: string;
+            head: string;
+        };
+        previewCleanup: {
+            performed: boolean;
+            state: any;
+        } | {
+            performed: boolean;
+        };
+        remoteDeleted: boolean;
+        localDeleted: boolean;
+    };
+    nextSteps: TreeseedWorkflowNextStep[];
+}>;
+export declare function workflowStage(helpers: WorkflowOperationHelpers, input: TreeseedStageInput): Promise<{
+    ok: boolean;
+    operation: string;
+    payload: {
+        branchName: string;
+        mergeTarget: string;
+        message: string;
+        deprecatedTag: {
+            tagName: string;
+            head: string;
+        };
+        stagingWait: {
+            status: string;
+            reason: string;
+            branch?: undefined;
+        } | {
+            status: string;
+            branch: string;
+            reason?: undefined;
+        };
+        previewCleanup: {
+            performed: boolean;
+            state: any;
+        } | {
+            performed: boolean;
+        };
+        remoteDeleted: boolean;
+        localDeleted: boolean;
+    };
+    nextSteps: TreeseedWorkflowNextStep[];
+}>;
+export declare function workflowRelease(helpers: WorkflowOperationHelpers, input: TreeseedReleaseInput): Promise<{
+    ok: boolean;
+    operation: string;
+    payload: {
+        level: "patch" | "major" | "minor";
+        rootVersion: string;
+        releaseTag: string;
+        stagingBranch: string;
+        productionBranch: string;
+        touchedPackages: unknown[];
+    };
+    nextSteps: TreeseedWorkflowNextStep[];
+}>;
+export declare function workflowDestroy(helpers: WorkflowOperationHelpers, input: TreeseedDestroyInput): Promise<{
+    ok: boolean;
+    operation: string;
+    payload: {
+        scope: string;
+        dryRun: boolean;
+        force: boolean;
+        destroyRemote: boolean;
+        destroyLocal: boolean;
+        removeBuildArtifacts: boolean;
+        expectedConfirmation: string;
+        stateSummary: {
+            workerName: any;
+            lastDeploymentTimestamp: any;
+        };
+        remoteResult: {
+            target: {
+                kind: string;
+                scope: string;
+            } | {
+                kind: string;
+                branchName: string;
+            };
+            summary: {
+                target: any;
+                workerName: any;
+                siteUrl: any;
+                accountId: any;
+                formGuardKv: any;
+                sessionKv: any;
+                siteDataDb: any;
+            };
+            operations: {
+                worker: {
+                    status: string;
+                    name: any;
+                };
+                formGuard: {
+                    status: string;
+                    id: any;
+                    preview?: undefined;
+                } | {
+                    status: string;
+                    id: any;
+                    preview: boolean;
+                };
+                formGuardPreview: {
+                    status: string;
+                    id: any;
+                    preview?: undefined;
+                } | {
+                    status: string;
+                    id: any;
+                    preview: boolean;
+                } | null;
+                session: {
+                    status: string;
+                    id: any;
+                    preview?: undefined;
+                } | {
+                    status: string;
+                    id: any;
+                    preview: boolean;
+                };
+                sessionPreview: {
+                    status: string;
+                    id: any;
+                    preview?: undefined;
+                } | {
+                    status: string;
+                    id: any;
+                    preview: boolean;
+                } | null;
+                database: {
+                    status: string;
+                    name: any;
+                };
+            };
+        } | null;
+    };
+    nextSteps: TreeseedWorkflowNextStep[];
+}>;
+export {};