git-workspace-service 0.4.3 → 0.4.5

package/dist/index.d.cts

@@ -897,7 +897,7 @@ declare class OAuthDeviceFlow {
     private readonly permissions;
     private readonly promptEmitter?;
     private readonly timeout;
-    private readonly logger?;
+    private readonly logger;
     constructor(config: OAuthDeviceFlowConfig, logger?: OAuthDeviceFlowLogger);
     /**
      * Start the device code flow and wait for authorization
@@ -1158,118 +1158,111 @@ declare class CredentialService {
 }
 
 /**
- * Workspace Service
+ * GitHub PAT Client
  *
- * Provisions and manages git workspaces for agent tasks.
- * Handles cloning, branching, and PR creation.
+ * Simple GitHub API client using a Personal Access Token.
+ * Useful for testing and simple integrations without GitHub App setup.
  */
 
-interface WorkspaceServiceLogger {
-    info(data: Record<string, unknown>, message: string): void;
-    warn(data: Record<string, unknown>, message: string): void;
-    error(data: Record<string, unknown>, message: string): void;
-    debug(data: Record<string, unknown>, message: string): void;
-}
-interface WorkspaceServiceOptions {
-    /**
-     * Configuration
-     */
-    config: WorkspaceServiceConfig;
+interface GitHubPatClientOptions {
     /**
-     * Credential service for managing git credentials
+     * Personal Access Token
      */
-    credentialService: CredentialService;
+    token: string;
     /**
-     * Optional logger
+     * GitHub API base URL (for GitHub Enterprise)
      */
-    logger?: WorkspaceServiceLogger;
+    baseUrl?: string;
 }
-declare class WorkspaceService {
-    private workspaces;
-    private readonly baseDir;
-    private readonly branchPrefix;
-    private readonly credentialService;
+interface GitHubPatClientLogger {
+    info(data: Record<string, unknown>, message: string): void;
+    warn(data: Record<string, unknown>, message: string): void;
+    error(data: Record<string, unknown>, message: string): void;
+}
+/**
+ * Simple GitHub client using a Personal Access Token.
+ * Provides PR and Issue management without GitHub App complexity.
+ */
+declare class GitHubPatClient {
+    private octokit;
     private readonly logger?;
-    private readonly eventHandlers;
-    constructor(options: WorkspaceServiceOptions);
+    constructor(options: GitHubPatClientOptions, logger?: GitHubPatClientLogger);
     /**
-     * Initialize the workspace service
+     * Create a pull request
      */
-    initialize(): Promise<void>;
+    createPullRequest(owner: string, repo: string, options: {
+        title: string;
+        body: string;
+        head: string;
+        base: string;
+        draft?: boolean;
+        labels?: string[];
+        reviewers?: string[];
+    }): Promise<PullRequestInfo>;
     /**
-     * Register an event handler
+     * Get a pull request
      */
-    onEvent(handler: WorkspaceEventHandler): () => void;
+    getPullRequest(owner: string, repo: string, prNumber: number): Promise<PullRequestInfo>;
     /**
-     * Provision a new workspace for a task
+     * Create an issue
      */
-    provision(config: WorkspaceConfig): Promise<Workspace>;
+    createIssue(owner: string, repo: string, options: CreateIssueOptions): Promise<IssueInfo>;
     /**
-     * Add a worktree to an existing clone workspace (convenience method)
+     * Get an issue
      */
-    addWorktree(parentWorkspaceId: string, options: {
-        branch: string;
-        execution: {
-            id: string;
-            patternName: string;
-        };
-        task: {
-            id: string;
-            role: string;
-            slug?: string;
-        };
-    }): Promise<Workspace>;
+    getIssue(owner: string, repo: string, issueNumber: number): Promise<IssueInfo>;
     /**
-     * List all worktrees for a parent workspace
+     * List issues
      */
-    listWorktrees(parentWorkspaceId: string): Workspace[];
+    listIssues(owner: string, repo: string, options?: {
+        state?: IssueState | 'all';
+        labels?: string[];
+        assignee?: string;
+    }): Promise<IssueInfo[]>;
     /**
-     * Remove a worktree (alias for cleanup with worktree-specific handling)
+     * Update an issue
      */
-    removeWorktree(workspaceId: string): Promise<void>;
+    updateIssue(owner: string, repo: string, issueNumber: number, options: {
+        title?: string;
+        body?: string;
+        state?: IssueState;
+        labels?: string[];
+        assignees?: string[];
+    }): Promise<IssueInfo>;
     /**
-     * Finalize a workspace (push, create PR, cleanup)
+     * Add labels to an issue
      */
-    finalize(workspaceId: string, options: WorkspaceFinalization): Promise<PullRequestInfo | void>;
+    addLabels(owner: string, repo: string, issueNumber: number, labels: string[]): Promise<void>;
     /**
-     * Get a workspace by ID
+     * Remove a label from an issue
      */
-    get(workspaceId: string): Workspace | null;
+    removeLabel(owner: string, repo: string, issueNumber: number, label: string): Promise<void>;
     /**
-     * Get all workspaces for an execution
+     * Add a comment to an issue or PR
      */
-    getForExecution(executionId: string): Workspace[];
+    addComment(owner: string, repo: string, issueNumber: number, options: IssueCommentOptions): Promise<IssueComment>;
     /**
-     * Clean up a workspace
+     * List comments on an issue or PR
      */
-    cleanup(workspaceId: string): Promise<void>;
+    listComments(owner: string, repo: string, issueNumber: number): Promise<IssueComment[]>;
     /**
-     * Clean up all workspaces for an execution
+     * Close an issue
      */
-    cleanupForExecution(executionId: string): Promise<void>;
+    closeIssue(owner: string, repo: string, issueNumber: number): Promise<IssueInfo>;
     /**
-     * Try to clone a public repository without authentication
+     * Reopen an issue
      */
-    private tryUnauthenticatedClone;
-    private cloneRepo;
-    private createBranch;
-    private addWorktreeFromParent;
-    private configureGit;
-    private pushBranch;
-    private createPullRequest;
-    private parseRepo;
-    private buildAuthenticatedUrl;
-    private execInDir;
-    private log;
-    private emitEvent;
+    reopenIssue(owner: string, repo: string, issueNumber: number): Promise<IssueInfo>;
     /**
-     * Update workspace progress
+     * Delete a branch
      */
-    private updateProgress;
+    deleteBranch(owner: string, repo: string, branch: string): Promise<void>;
     /**
-     * Execute completion hook if configured
+     * Check if a branch exists
      */
-    private executeCompletionHook;
+    branchExists(owner: string, repo: string, branch: string): Promise<boolean>;
+    private mapIssue;
+    private log;
 }
 
 /**
@@ -1438,114 +1431,6 @@ declare class GitHubProvider implements GitProviderAdapter {
     private log;
 }
 
-/**
- * GitHub PAT Client
- *
- * Simple GitHub API client using a Personal Access Token.
- * Useful for testing and simple integrations without GitHub App setup.
- */
-
-interface GitHubPatClientOptions {
-    /**
-     * Personal Access Token
-     */
-    token: string;
-    /**
-     * GitHub API base URL (for GitHub Enterprise)
-     */
-    baseUrl?: string;
-}
-interface GitHubPatClientLogger {
-    info(data: Record<string, unknown>, message: string): void;
-    warn(data: Record<string, unknown>, message: string): void;
-    error(data: Record<string, unknown>, message: string): void;
-}
-/**
- * Simple GitHub client using a Personal Access Token.
- * Provides PR and Issue management without GitHub App complexity.
- */
-declare class GitHubPatClient {
-    private octokit;
-    private readonly logger?;
-    constructor(options: GitHubPatClientOptions, logger?: GitHubPatClientLogger);
-    /**
-     * Create a pull request
-     */
-    createPullRequest(owner: string, repo: string, options: {
-        title: string;
-        body: string;
-        head: string;
-        base: string;
-        draft?: boolean;
-        labels?: string[];
-        reviewers?: string[];
-    }): Promise<PullRequestInfo>;
-    /**
-     * Get a pull request
-     */
-    getPullRequest(owner: string, repo: string, prNumber: number): Promise<PullRequestInfo>;
-    /**
-     * Create an issue
-     */
-    createIssue(owner: string, repo: string, options: CreateIssueOptions): Promise<IssueInfo>;
-    /**
-     * Get an issue
-     */
-    getIssue(owner: string, repo: string, issueNumber: number): Promise<IssueInfo>;
-    /**
-     * List issues
-     */
-    listIssues(owner: string, repo: string, options?: {
-        state?: IssueState | 'all';
-        labels?: string[];
-        assignee?: string;
-    }): Promise<IssueInfo[]>;
-    /**
-     * Update an issue
-     */
-    updateIssue(owner: string, repo: string, issueNumber: number, options: {
-        title?: string;
-        body?: string;
-        state?: IssueState;
-        labels?: string[];
-        assignees?: string[];
-    }): Promise<IssueInfo>;
-    /**
-     * Add labels to an issue
-     */
-    addLabels(owner: string, repo: string, issueNumber: number, labels: string[]): Promise<void>;
-    /**
-     * Remove a label from an issue
-     */
-    removeLabel(owner: string, repo: string, issueNumber: number, label: string): Promise<void>;
-    /**
-     * Add a comment to an issue or PR
-     */
-    addComment(owner: string, repo: string, issueNumber: number, options: IssueCommentOptions): Promise<IssueComment>;
-    /**
-     * List comments on an issue or PR
-     */
-    listComments(owner: string, repo: string, issueNumber: number): Promise<IssueComment[]>;
-    /**
-     * Close an issue
-     */
-    closeIssue(owner: string, repo: string, issueNumber: number): Promise<IssueInfo>;
-    /**
-     * Reopen an issue
-     */
-    reopenIssue(owner: string, repo: string, issueNumber: number): Promise<IssueInfo>;
-    /**
-     * Delete a branch
-     */
-    deleteBranch(owner: string, repo: string, branch: string): Promise<void>;
-    /**
-     * Check if a branch exists
-     */
-    branchExists(owner: string, repo: string, branch: string): Promise<boolean>;
-    private mapIssue;
-    private log;
-}
-
 /**
  * Branch Naming Service
  *
@@ -1652,4 +1537,119 @@ declare function getGitCredentialConfig(helperScriptPath: string): string[];
  */
 declare function outputCredentials(username: string, password: string): void;
 
+/**
+ * Workspace Service
+ *
+ * Provisions and manages git workspaces for agent tasks.
+ * Handles cloning, branching, and PR creation.
+ */
+
+interface WorkspaceServiceLogger {
+    info(data: Record<string, unknown>, message: string): void;
+    warn(data: Record<string, unknown>, message: string): void;
+    error(data: Record<string, unknown>, message: string): void;
+    debug(data: Record<string, unknown>, message: string): void;
+}
+interface WorkspaceServiceOptions {
+    /**
+     * Configuration
+     */
+    config: WorkspaceServiceConfig;
+    /**
+     * Credential service for managing git credentials
+     */
+    credentialService?: CredentialService;
+    /**
+     * Optional logger
+     */
+    logger?: WorkspaceServiceLogger;
+}
+declare class WorkspaceService {
+    private workspaces;
+    private readonly baseDir;
+    private readonly branchPrefix;
+    private readonly credentialService;
+    private readonly logger?;
+    private readonly eventHandlers;
+    constructor(options: WorkspaceServiceOptions);
+    /**
+     * Initialize the workspace service
+     */
+    initialize(): Promise<void>;
+    /**
+     * Register an event handler
+     */
+    onEvent(handler: WorkspaceEventHandler): () => void;
+    /**
+     * Provision a new workspace for a task
+     */
+    provision(config: WorkspaceConfig): Promise<Workspace>;
+    /**
+     * Add a worktree to an existing clone workspace (convenience method)
+     */
+    addWorktree(parentWorkspaceId: string, options: {
+        branch: string;
+        execution: {
+            id: string;
+            patternName: string;
+        };
+        task: {
+            id: string;
+            role: string;
+            slug?: string;
+        };
+    }): Promise<Workspace>;
+    /**
+     * List all worktrees for a parent workspace
+     */
+    listWorktrees(parentWorkspaceId: string): Workspace[];
+    /**
+     * Remove a worktree (alias for cleanup with worktree-specific handling)
+     */
+    removeWorktree(workspaceId: string): Promise<void>;
+    /**
+     * Finalize a workspace (push, create PR, cleanup)
+     */
+    finalize(workspaceId: string, options: WorkspaceFinalization): Promise<PullRequestInfo | undefined>;
+    /**
+     * Get a workspace by ID
+     */
+    get(workspaceId: string): Workspace | null;
+    /**
+     * Get all workspaces for an execution
+     */
+    getForExecution(executionId: string): Workspace[];
+    /**
+     * Clean up a workspace
+     */
+    cleanup(workspaceId: string): Promise<void>;
+    /**
+     * Clean up all workspaces for an execution
+     */
+    cleanupForExecution(executionId: string): Promise<void>;
+    /**
+     * Try to clone a public repository without authentication
+     */
+    private tryUnauthenticatedClone;
+    private cloneRepo;
+    private createBranch;
+    private addWorktreeFromParent;
+    private configureGit;
+    private pushBranch;
+    private createPullRequest;
+    private parseRepo;
+    private buildAuthenticatedUrl;
+    private execInDir;
+    private log;
+    private emitEvent;
+    /**
+     * Update workspace progress
+     */
+    private updateProgress;
+    /**
+     * Execute completion hook if configured
+     */
+    private executeCompletionHook;
+}
+
 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 };