git-workspace-service 0.2.0 → 0.3.0

package/dist/index.d.cts

@@ -182,6 +182,53 @@ type BranchStrategy = 'feature_branch' | 'fork' | 'direct';
  */
 type WorkspaceStrategy = 'clone' | 'worktree';
 type WorkspaceStatus = 'provisioning' | 'ready' | 'in_use' | 'finalizing' | 'cleaned_up' | 'error';
+/**
+ * Granular progress phases for workspace operations
+ */
+type WorkspacePhase = 'initializing' | 'cloning' | 'creating_branch' | 'configuring' | 'ready' | 'committing' | 'pushing' | 'creating_pr' | 'cleaning_up' | 'done' | 'error';
+/**
+ * Progress tracking for workspace operations
+ */
+interface WorkspaceProgress {
+    /**
+     * Current phase of the operation
+     */
+    phase: WorkspacePhase;
+    /**
+     * Human-readable message describing current activity
+     */
+    message?: string;
+    /**
+     * Progress percentage (0-100) if determinable
+     */
+    percent?: number;
+    /**
+     * When progress was last updated
+     */
+    updatedAt: Date;
+}
+/**
+ * Completion hook configuration
+ */
+interface CompletionHook {
+    /**
+     * Shell command to execute on completion
+     * Variables available: $WORKSPACE_ID, $REPO, $BRANCH, $STATUS
+     */
+    command?: string;
+    /**
+     * Webhook URL to POST to on completion
+     */
+    webhook?: string;
+    /**
+     * Custom headers for webhook request
+     */
+    webhookHeaders?: Record<string, string>;
+    /**
+     * Whether to run hook on error (default: true)
+     */
+    runOnError?: boolean;
+}
 /**
  * Configuration for provisioning a workspace
  */
@@ -239,6 +286,10 @@ interface WorkspaceConfig {
      * If provided, these are used instead of managed credentials
      */
     userCredentials?: UserProvidedCredentials;
+    /**
+     * Hook to run when workspace operations complete
+     */
+    onComplete?: CompletionHook;
 }
 /**
  * A provisioned git workspace
@@ -284,6 +335,14 @@ interface Workspace {
      * Child worktree IDs (for clone workspaces that have worktrees)
      */
     worktreeIds?: string[];
+    /**
+     * Current progress of workspace operations
+     */
+    progress?: WorkspaceProgress;
+    /**
+     * Completion hook configuration
+     */
+    onComplete?: CompletionHook;
 }
 /**
  * Options for finalizing a workspace (push, PR creation, cleanup)
@@ -1185,6 +1244,14 @@ declare class WorkspaceService {
     private execInDir;
     private log;
     private emitEvent;
+    /**
+     * Update workspace progress
+     */
+    private updateProgress;
+    /**
+     * Execute completion hook if configured
+     */
+    private executeCompletionHook;
 }
 
 /**
@@ -1567,4 +1634,4 @@ declare function getGitCredentialConfig(helperScriptPath: string): string[];
  */
 declare function outputCredentials(username: string, password: string): void;
 
-export { type AgentPermissions, type AuthPrompt, type AuthPromptEmitter, type AuthResult, type BranchConfig, type BranchInfo, type BranchNamingOptions, type BranchStrategy, type CreateIssueOptions, type CredentialContext, type CredentialGrant, type CredentialGrantStore, type CredentialHelperContext, CredentialService, type CredentialServiceConfig, type CredentialServiceLogger, type CredentialServiceOptions, type CredentialType, DEFAULT_AGENT_PERMISSIONS, DEFAULT_BRANCH_PREFIX, type DeviceCodeResponse, FileTokenStore, type GitCredential, type GitCredentialRequest, type GitHubAppConfig, type GitHubAppInstallation, GitHubPatClient, type GitHubPatClientLogger, type GitHubPatClientOptions, GitHubProvider, type GitHubProviderConfig, type GitHubProviderLogger, type GitProvider, type GitProviderAdapter, type IssueComment, type IssueCommentOptions, type IssueInfo, type IssueState, MemoryTokenStore, OAuthDeviceFlow, type OAuthDeviceFlowConfig, type OAuthDeviceFlowLogger, type OAuthToken, type PermissionLevel, type PullRequestInfo, READONLY_AGENT_PERMISSIONS, type RepositoryScope, type SshCredentials, type TokenCredentials, TokenStore, type TokenStoreOptions, type UserProvidedCredentials, type Workspace, type WorkspaceConfig, type WorkspaceEvent, type WorkspaceEventHandler, type WorkspaceEventType, type WorkspaceFinalization, WorkspaceService, type WorkspaceServiceConfig, type WorkspaceServiceLogger, type WorkspaceServiceOptions, type WorkspaceStatus, type WorkspaceStrategy, cleanupCredentialFiles, configureCredentialHelper, createBranchInfo, createNodeCredentialHelperScript, createShellCredentialHelperScript, filterBranchesByExecution, generateBranchName, generateSlug, getGitCredentialConfig, isManagedBranch, outputCredentials, parseBranchName, updateCredentials };
+export { type AgentPermissions, type AuthPrompt, type AuthPromptEmitter, type AuthResult, type BranchConfig, type BranchInfo, type BranchNamingOptions, type BranchStrategy, type CompletionHook, type CreateIssueOptions, type CredentialContext, type CredentialGrant, type CredentialGrantStore, type CredentialHelperContext, CredentialService, type CredentialServiceConfig, type CredentialServiceLogger, type CredentialServiceOptions, type CredentialType, DEFAULT_AGENT_PERMISSIONS, DEFAULT_BRANCH_PREFIX, type DeviceCodeResponse, FileTokenStore, type GitCredential, type GitCredentialRequest, type GitHubAppConfig, type GitHubAppInstallation, GitHubPatClient, type GitHubPatClientLogger, type GitHubPatClientOptions, GitHubProvider, type GitHubProviderConfig, type GitHubProviderLogger, type GitProvider, type GitProviderAdapter, type IssueComment, type IssueCommentOptions, type IssueInfo, type IssueState, MemoryTokenStore, OAuthDeviceFlow, type OAuthDeviceFlowConfig, type OAuthDeviceFlowLogger, type OAuthToken, type PermissionLevel, type PullRequestInfo, READONLY_AGENT_PERMISSIONS, type RepositoryScope, type SshCredentials, type TokenCredentials, TokenStore, type TokenStoreOptions, type UserProvidedCredentials, type Workspace, type WorkspaceConfig, type WorkspaceEvent, type WorkspaceEventHandler, type WorkspaceEventType, type WorkspaceFinalization, type WorkspacePhase, type WorkspaceProgress, WorkspaceService, type WorkspaceServiceConfig, type WorkspaceServiceLogger, type WorkspaceServiceOptions, type WorkspaceStatus, type WorkspaceStrategy, cleanupCredentialFiles, configureCredentialHelper, createBranchInfo, createNodeCredentialHelperScript, createShellCredentialHelperScript, filterBranchesByExecution, generateBranchName, generateSlug, getGitCredentialConfig, isManagedBranch, outputCredentials, parseBranchName, updateCredentials };

package/dist/index.d.ts

@@ -182,6 +182,53 @@ type BranchStrategy = 'feature_branch' | 'fork' | 'direct';
  */
 type WorkspaceStrategy = 'clone' | 'worktree';
 type WorkspaceStatus = 'provisioning' | 'ready' | 'in_use' | 'finalizing' | 'cleaned_up' | 'error';
+/**
+ * Granular progress phases for workspace operations
+ */
+type WorkspacePhase = 'initializing' | 'cloning' | 'creating_branch' | 'configuring' | 'ready' | 'committing' | 'pushing' | 'creating_pr' | 'cleaning_up' | 'done' | 'error';
+/**
+ * Progress tracking for workspace operations
+ */
+interface WorkspaceProgress {
+    /**
+     * Current phase of the operation
+     */
+    phase: WorkspacePhase;
+    /**
+     * Human-readable message describing current activity
+     */
+    message?: string;
+    /**
+     * Progress percentage (0-100) if determinable
+     */
+    percent?: number;
+    /**
+     * When progress was last updated
+     */
+    updatedAt: Date;
+}
+/**
+ * Completion hook configuration
+ */
+interface CompletionHook {
+    /**
+     * Shell command to execute on completion
+     * Variables available: $WORKSPACE_ID, $REPO, $BRANCH, $STATUS
+     */
+    command?: string;
+    /**
+     * Webhook URL to POST to on completion
+     */
+    webhook?: string;
+    /**
+     * Custom headers for webhook request
+     */
+    webhookHeaders?: Record<string, string>;
+    /**
+     * Whether to run hook on error (default: true)
+     */
+    runOnError?: boolean;
+}
 /**
  * Configuration for provisioning a workspace
  */
@@ -239,6 +286,10 @@ interface WorkspaceConfig {
      * If provided, these are used instead of managed credentials
      */
     userCredentials?: UserProvidedCredentials;
+    /**
+     * Hook to run when workspace operations complete
+     */
+    onComplete?: CompletionHook;
 }
 /**
  * A provisioned git workspace
@@ -284,6 +335,14 @@ interface Workspace {
      * Child worktree IDs (for clone workspaces that have worktrees)
      */
     worktreeIds?: string[];
+    /**
+     * Current progress of workspace operations
+     */
+    progress?: WorkspaceProgress;
+    /**
+     * Completion hook configuration
+     */
+    onComplete?: CompletionHook;
 }
 /**
  * Options for finalizing a workspace (push, PR creation, cleanup)
@@ -1185,6 +1244,14 @@ declare class WorkspaceService {
     private execInDir;
     private log;
     private emitEvent;
+    /**
+     * Update workspace progress
+     */
+    private updateProgress;
+    /**
+     * Execute completion hook if configured
+     */
+    private executeCompletionHook;
 }
 
 /**
@@ -1567,4 +1634,4 @@ declare function getGitCredentialConfig(helperScriptPath: string): string[];
  */
 declare function outputCredentials(username: string, password: string): void;
 
-export { type AgentPermissions, type AuthPrompt, type AuthPromptEmitter, type AuthResult, type BranchConfig, type BranchInfo, type BranchNamingOptions, type BranchStrategy, type CreateIssueOptions, type CredentialContext, type CredentialGrant, type CredentialGrantStore, type CredentialHelperContext, CredentialService, type CredentialServiceConfig, type CredentialServiceLogger, type CredentialServiceOptions, type CredentialType, DEFAULT_AGENT_PERMISSIONS, DEFAULT_BRANCH_PREFIX, type DeviceCodeResponse, FileTokenStore, type GitCredential, type GitCredentialRequest, type GitHubAppConfig, type GitHubAppInstallation, GitHubPatClient, type GitHubPatClientLogger, type GitHubPatClientOptions, GitHubProvider, type GitHubProviderConfig, type GitHubProviderLogger, type GitProvider, type GitProviderAdapter, type IssueComment, type IssueCommentOptions, type IssueInfo, type IssueState, MemoryTokenStore, OAuthDeviceFlow, type OAuthDeviceFlowConfig, type OAuthDeviceFlowLogger, type OAuthToken, type PermissionLevel, type PullRequestInfo, READONLY_AGENT_PERMISSIONS, type RepositoryScope, type SshCredentials, type TokenCredentials, TokenStore, type TokenStoreOptions, type UserProvidedCredentials, type Workspace, type WorkspaceConfig, type WorkspaceEvent, type WorkspaceEventHandler, type WorkspaceEventType, type WorkspaceFinalization, WorkspaceService, type WorkspaceServiceConfig, type WorkspaceServiceLogger, type WorkspaceServiceOptions, type WorkspaceStatus, type WorkspaceStrategy, cleanupCredentialFiles, configureCredentialHelper, createBranchInfo, createNodeCredentialHelperScript, createShellCredentialHelperScript, filterBranchesByExecution, generateBranchName, generateSlug, getGitCredentialConfig, isManagedBranch, outputCredentials, parseBranchName, updateCredentials };
+export { type AgentPermissions, type AuthPrompt, type AuthPromptEmitter, type AuthResult, type BranchConfig, type BranchInfo, type BranchNamingOptions, type BranchStrategy, type CompletionHook, type CreateIssueOptions, type CredentialContext, type CredentialGrant, type CredentialGrantStore, type CredentialHelperContext, CredentialService, type CredentialServiceConfig, type CredentialServiceLogger, type CredentialServiceOptions, type CredentialType, DEFAULT_AGENT_PERMISSIONS, DEFAULT_BRANCH_PREFIX, type DeviceCodeResponse, FileTokenStore, type GitCredential, type GitCredentialRequest, type GitHubAppConfig, type GitHubAppInstallation, GitHubPatClient, type GitHubPatClientLogger, type GitHubPatClientOptions, GitHubProvider, type GitHubProviderConfig, type GitHubProviderLogger, type GitProvider, type GitProviderAdapter, type IssueComment, type IssueCommentOptions, type IssueInfo, type IssueState, MemoryTokenStore, OAuthDeviceFlow, type OAuthDeviceFlowConfig, type OAuthDeviceFlowLogger, type OAuthToken, type PermissionLevel, type PullRequestInfo, READONLY_AGENT_PERMISSIONS, type RepositoryScope, type SshCredentials, type TokenCredentials, TokenStore, type TokenStoreOptions, type UserProvidedCredentials, type Workspace, type WorkspaceConfig, type WorkspaceEvent, type WorkspaceEventHandler, type WorkspaceEventType, type WorkspaceFinalization, type WorkspacePhase, type WorkspaceProgress, WorkspaceService, type WorkspaceServiceConfig, type WorkspaceServiceLogger, type WorkspaceServiceOptions, type WorkspaceStatus, type WorkspaceStrategy, cleanupCredentialFiles, configureCredentialHelper, createBranchInfo, createNodeCredentialHelperScript, createShellCredentialHelperScript, filterBranchesByExecution, generateBranchName, generateSlug, getGitCredentialConfig, isManagedBranch, outputCredentials, parseBranchName, updateCredentials };

package/dist/index.js

@@ -336,12 +336,20 @@ var WorkspaceService = class {
       provisionedAt: /* @__PURE__ */ new Date(),
       status: "provisioning",
       strategy,
-      parentWorkspaceId: config.parentWorkspace
+      parentWorkspaceId: config.parentWorkspace,
+      onComplete: config.onComplete,
+      progress: {
+        phase: "initializing",
+        message: "Initializing workspace",
+        updatedAt: /* @__PURE__ */ new Date()
+      }
     };
     this.workspaces.set(workspaceId, workspace);
     try {
       if (strategy === "clone") {
+        this.updateProgress(workspace, "cloning", "Cloning repository");
         await this.cloneRepo(workspace, credential.token);
+        this.updateProgress(workspace, "creating_branch", "Creating branch");
         await this.createBranch(workspace);
       } else {
         const parent = this.workspaces.get(config.parentWorkspace);
@@ -359,9 +367,12 @@ var WorkspaceService = class {
           data: { parentWorkspaceId: parent.id }
         });
       }
+      this.updateProgress(workspace, "configuring", "Configuring git");
       await this.configureGit(workspace);
       workspace.status = "ready";
+      this.updateProgress(workspace, "ready", "Workspace ready");
       this.workspaces.set(workspaceId, workspace);
+      await this.executeCompletionHook(workspace, "success");
       this.log(
         "info",
         {
@@ -381,8 +392,9 @@ var WorkspaceService = class {
       return workspace;
     } catch (error) {
       workspace.status = "error";
-      this.workspaces.set(workspaceId, workspace);
       const errorMessage = error instanceof Error ? error.message : String(error);
+      this.updateProgress(workspace, "error", errorMessage);
+      this.workspaces.set(workspaceId, workspace);
       this.log("error", { workspaceId, error: errorMessage }, "Failed to provision workspace");
       await this.emitEvent({
         type: "workspace:error",
@@ -391,6 +403,7 @@ var WorkspaceService = class {
         timestamp: /* @__PURE__ */ new Date(),
         error: errorMessage
       });
+      await this.executeCompletionHook(workspace, "error");
       throw error;
     }
   }
@@ -727,6 +740,72 @@ var WorkspaceService = class {
       }
     }
   }
+  /**
+   * Update workspace progress
+   */
+  updateProgress(workspace, phase, message) {
+    workspace.progress = {
+      phase,
+      message,
+      updatedAt: /* @__PURE__ */ new Date()
+    };
+    this.workspaces.set(workspace.id, workspace);
+    this.log(
+      "debug",
+      { workspaceId: workspace.id, phase, message },
+      "Progress updated"
+    );
+  }
+  /**
+   * Execute completion hook if configured
+   */
+  async executeCompletionHook(workspace, status) {
+    const hook = workspace.onComplete;
+    if (!hook) return;
+    if (status === "error" && hook.runOnError === false) {
+      return;
+    }
+    const env = {
+      ...process.env,
+      WORKSPACE_ID: workspace.id,
+      REPO: workspace.repo,
+      BRANCH: workspace.branch.name,
+      STATUS: status,
+      WORKSPACE_PATH: workspace.path
+    };
+    if (hook.command) {
+      try {
+        this.log("info", { workspaceId: workspace.id, command: hook.command }, "Executing completion hook command");
+        await execAsync(hook.command, { env });
+      } catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        this.log("warn", { workspaceId: workspace.id, error: errorMessage }, "Completion hook command failed");
+      }
+    }
+    if (hook.webhook) {
+      try {
+        this.log("info", { workspaceId: workspace.id, webhook: hook.webhook }, "Calling completion webhook");
+        const payload = {
+          workspaceId: workspace.id,
+          repo: workspace.repo,
+          branch: workspace.branch.name,
+          status,
+          timestamp: (/* @__PURE__ */ new Date()).toISOString()
+        };
+        await fetch(hook.webhook, {
+          method: "POST",
+          headers: {
+            "Content-Type": "application/json",
+            ...hook.webhookHeaders
+          },
+          body: JSON.stringify(payload)
+        });
+      } catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
+        this.log("warn", { workspaceId: workspace.id, error: errorMessage }, "Completion webhook failed");
+      }
+    }
+  }
 };
 
 // src/oauth/device-flow.ts