@loopstack/github-module 0.2.2 → 0.2.4

package/README.md

@@ -139,7 +139,7 @@ See `@loopstack/oauth-module` and `@loopstack/github-oauth-example` for complete
 
 Author: [Jakob Klippel](https://www.linkedin.com/in/jakob-klippel/)
 
-License: Apache-2.0
+License: MIT
 
 ### Additional Resources
 

package/package.json

@@ -9,8 +9,8 @@
     "module",
     "oauth"
   ],
-  "version": "0.2.2",
-  "license": "Apache-2.0",
+  "version": "0.2.4",
+  "license": "MIT",
   "author": {
     "name": "Jakob Klippel",
     "url": "https://www.linkedin.com/in/jakob-klippel/"
@@ -18,8 +18,7 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
-    ".": "./dist/index.js",
-    "./src/*": "./src/*"
+    ".": "./dist/index.js"
   },
   "scripts": {
     "build": "nest build",
@@ -30,12 +29,12 @@
     "watch": "nest build --watch"
   },
   "dependencies": {
-    "@loopstack/oauth-module": "^0.2.2",
+    "@loopstack/common": "^0.28.0",
+    "@loopstack/oauth-module": "^0.2.6",
     "zod": "^4.3.6"
   },
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "jest": {
     "moduleFileExtensions": [
@@ -46,12 +45,7 @@
     "rootDir": "src",
     "testRegex": ".*\\.spec\\.ts$",
     "transform": {
-      "^.+\\.ts$": [
-        "ts-jest",
-        {
-          "tsconfig": "tsconfig.spec.json"
-        }
-      ]
+      "^.+\\.ts$": "ts-jest"
     },
     "collectCoverageFrom": [
       "**/*.(t|j)s"
@@ -79,7 +73,6 @@
       }
     ],
     "installModes": [
-      "add",
       "install"
     ]
   }

package/src/github-oauth.provider.ts

@@ -1,85 +0,0 @@
-import { Injectable, Logger, OnModuleInit } from '@nestjs/common';
-import { ConfigService } from '@nestjs/config';
-import { OAuthProviderInterface, OAuthProviderRegistry, OAuthTokenSet } from '@loopstack/oauth-module';
-
-@Injectable()
-export class GitHubOAuthProvider implements OAuthProviderInterface, OnModuleInit {
-  private readonly logger = new Logger(GitHubOAuthProvider.name);
-
-  readonly providerId = 'github';
-  readonly defaultScopes = ['repo', 'user', 'workflow', 'read:org'];
-
-  constructor(
-    private readonly configService: ConfigService,
-    private readonly providerRegistry: OAuthProviderRegistry,
-  ) {}
-
-  onModuleInit(): void {
-    this.providerRegistry.register(this);
-    this.logger.log('GitHub OAuth provider registered');
-  }
-
-  private get clientId(): string {
-    const id = this.configService.get<string>('GITHUB_CLIENT_ID');
-    if (!id) throw new Error('GITHUB_CLIENT_ID is not configured');
-    return id;
-  }
-
-  private get clientSecret(): string {
-    const secret = this.configService.get<string>('GITHUB_CLIENT_SECRET');
-    if (!secret) throw new Error('GITHUB_CLIENT_SECRET is not configured');
-    return secret;
-  }
-
-  private get redirectUri(): string {
-    return this.configService.get<string>('GITHUB_OAUTH_REDIRECT_URI', '/oauth/callback');
-  }
-
-  buildAuthUrl(scopes: string[], state: string): string {
-    const params = new URLSearchParams({
-      client_id: this.clientId,
-      redirect_uri: this.redirectUri,
-      scope: scopes.join(' '),
-      state,
-    });
-    return `https://github.com/login/oauth/authorize?${params.toString()}`;
-  }
-
-  async exchangeCode(code: string): Promise<OAuthTokenSet> {
-    const response = await fetch('https://github.com/login/oauth/access_token', {
-      method: 'POST',
-      headers: {
-        'Content-Type': 'application/x-www-form-urlencoded',
-        Accept: 'application/json',
-      },
-      body: new URLSearchParams({
-        code,
-        client_id: this.clientId,
-        client_secret: this.clientSecret,
-        redirect_uri: this.redirectUri,
-      }),
-    });
-
-    if (!response.ok) {
-      const errorBody = await response.text();
-      this.logger.error(`Token exchange failed: ${response.status} ${errorBody}`);
-      throw new Error(`GitHub token exchange failed: ${response.statusText}`);
-    }
-
-    const tokens = (await response.json()) as {
-      access_token: string;
-      token_type: string;
-      scope: string;
-    };
-
-    return {
-      accessToken: tokens.access_token,
-      expiresIn: 315360000,
-      scope: tokens.scope,
-    };
-  }
-
-  refreshToken(): Promise<OAuthTokenSet> {
-    throw new Error('GitHub tokens do not expire and cannot be refreshed.');
-  }
-}

package/src/github.module.ts

@@ -1,63 +0,0 @@
-import { Module } from '@nestjs/common';
-import { OAuthModule } from '@loopstack/oauth-module';
-import { GitHubOAuthProvider } from './github-oauth.provider';
-import { GitHubGetWorkflowRunTool } from './tools/actions/github-get-workflow-run.tool';
-import { GitHubListWorkflowRunsTool } from './tools/actions/github-list-workflow-runs.tool';
-import { GitHubTriggerWorkflowTool } from './tools/actions/github-trigger-workflow.tool';
-import { GitHubCreateOrUpdateFileTool } from './tools/content/github-create-or-update-file.tool';
-import { GitHubGetCommitTool } from './tools/content/github-get-commit.tool';
-import { GitHubGetFileContentTool } from './tools/content/github-get-file-content.tool';
-import { GitHubListDirectoryTool } from './tools/content/github-list-directory.tool';
-import { GitHubCreateIssueCommentTool } from './tools/issues/github-create-issue-comment.tool';
-import { GitHubCreateIssueTool } from './tools/issues/github-create-issue.tool';
-import { GitHubGetIssueTool } from './tools/issues/github-get-issue.tool';
-import { GitHubListIssuesTool } from './tools/issues/github-list-issues.tool';
-import { GitHubCreatePullRequestTool } from './tools/pull-requests/github-create-pull-request.tool';
-import { GitHubGetPullRequestTool } from './tools/pull-requests/github-get-pull-request.tool';
-import { GitHubListPrReviewsTool } from './tools/pull-requests/github-list-pr-reviews.tool';
-import { GitHubListPullRequestsTool } from './tools/pull-requests/github-list-pull-requests.tool';
-import { GitHubMergePullRequestTool } from './tools/pull-requests/github-merge-pull-request.tool';
-import { GitHubCreateRepoTool } from './tools/repos/github-create-repo.tool';
-import { GitHubGetRepoTool } from './tools/repos/github-get-repo.tool';
-import { GitHubListBranchesTool } from './tools/repos/github-list-branches.tool';
-import { GitHubListReposTool } from './tools/repos/github-list-repos.tool';
-import { GitHubSearchCodeTool } from './tools/search/github-search-code.tool';
-import { GitHubSearchIssuesTool } from './tools/search/github-search-issues.tool';
-import { GitHubSearchReposTool } from './tools/search/github-search-repos.tool';
-import { GitHubGetAuthenticatedUserTool } from './tools/users/github-get-authenticated-user.tool';
-import { GitHubListUserOrgsTool } from './tools/users/github-list-user-orgs.tool';
-
-const tools = [
-  GitHubListReposTool,
-  GitHubGetRepoTool,
-  GitHubCreateRepoTool,
-  GitHubListBranchesTool,
-  GitHubListIssuesTool,
-  GitHubGetIssueTool,
-  GitHubCreateIssueTool,
-  GitHubCreateIssueCommentTool,
-  GitHubListPullRequestsTool,
-  GitHubGetPullRequestTool,
-  GitHubCreatePullRequestTool,
-  GitHubMergePullRequestTool,
-  GitHubListPrReviewsTool,
-  GitHubGetFileContentTool,
-  GitHubCreateOrUpdateFileTool,
-  GitHubListDirectoryTool,
-  GitHubGetCommitTool,
-  GitHubListWorkflowRunsTool,
-  GitHubTriggerWorkflowTool,
-  GitHubGetWorkflowRunTool,
-  GitHubSearchCodeTool,
-  GitHubSearchReposTool,
-  GitHubSearchIssuesTool,
-  GitHubGetAuthenticatedUserTool,
-  GitHubListUserOrgsTool,
-];
-
-@Module({
-  imports: [OAuthModule],
-  providers: [GitHubOAuthProvider, ...tools],
-  exports: [GitHubOAuthProvider, ...tools],
-})
-export class GitHubModule {}

package/src/index.ts

@@ -1,27 +0,0 @@
-export * from './github.module';
-export * from './github-oauth.provider';
-export * from './tools/repos/github-list-repos.tool';
-export * from './tools/repos/github-get-repo.tool';
-export * from './tools/repos/github-create-repo.tool';
-export * from './tools/repos/github-list-branches.tool';
-export * from './tools/issues/github-list-issues.tool';
-export * from './tools/issues/github-get-issue.tool';
-export * from './tools/issues/github-create-issue.tool';
-export * from './tools/issues/github-create-issue-comment.tool';
-export * from './tools/pull-requests/github-list-pull-requests.tool';
-export * from './tools/pull-requests/github-get-pull-request.tool';
-export * from './tools/pull-requests/github-create-pull-request.tool';
-export * from './tools/pull-requests/github-merge-pull-request.tool';
-export * from './tools/pull-requests/github-list-pr-reviews.tool';
-export * from './tools/content/github-get-file-content.tool';
-export * from './tools/content/github-create-or-update-file.tool';
-export * from './tools/content/github-list-directory.tool';
-export * from './tools/content/github-get-commit.tool';
-export * from './tools/actions/github-list-workflow-runs.tool';
-export * from './tools/actions/github-trigger-workflow.tool';
-export * from './tools/actions/github-get-workflow-run.tool';
-export * from './tools/search/github-search-code.tool';
-export * from './tools/search/github-search-repos.tool';
-export * from './tools/search/github-search-issues.tool';
-export * from './tools/users/github-get-authenticated-user.tool';
-export * from './tools/users/github-list-user-orgs.tool';

package/src/tools/actions/github-get-workflow-run.tool.ts

@@ -1,109 +0,0 @@
-import { Inject, Logger } from '@nestjs/common';
-import { z } from 'zod';
-import { BaseTool, Tool, ToolResult } from '@loopstack/common';
-import { OAuthTokenStore } from '@loopstack/oauth-module';
-
-const inputSchema = z
-  .object({
-    owner: z.string(),
-    repo: z.string(),
-    runId: z.number(),
-  })
-  .strict();
-
-export type GitHubGetWorkflowRunArgs = z.infer<typeof inputSchema>;
-
-@Tool({
-  uiConfig: {
-    description:
-      'Gets detailed information about a specific GitHub Actions workflow run. Returns { error: "unauthorized" } if no valid token is available.',
-  },
-  schema: inputSchema,
-})
-export class GitHubGetWorkflowRunTool extends BaseTool {
-  private readonly logger = new Logger(GitHubGetWorkflowRunTool.name);
-
-  @Inject()
-  private tokenStore: OAuthTokenStore;
-
-  async call(args: GitHubGetWorkflowRunArgs): Promise<ToolResult> {
-    const accessToken = await this.tokenStore.getValidAccessToken(this.ctx.context.userId, 'github');
-
-    if (!accessToken) {
-      return {
-        data: {
-          error: 'unauthorized',
-          message: 'No valid GitHub token found. Please authenticate first.',
-        },
-      };
-    }
-
-    const url = `https://api.github.com/repos/${encodeURIComponent(args.owner)}/${encodeURIComponent(args.repo)}/actions/runs/${args.runId}`;
-    const response = await fetch(url, {
-      headers: {
-        Authorization: `Bearer ${accessToken}`,
-        Accept: 'application/vnd.github+json',
-        'X-GitHub-Api-Version': '2022-11-28',
-      },
-    });
-
-    if (response.status === 401 || response.status === 403) {
-      this.logger.warn(`GitHub API returned ${response.status} for user ${this.ctx.context.userId}`);
-      return {
-        data: {
-          error: '401',
-          message: 'GitHub token was rejected. Please re-authenticate.',
-        },
-      };
-    }
-
-    if (!response.ok) {
-      const body = await response.text();
-      this.logger.error(`GitHub API error: ${response.status} ${body}`);
-      return {
-        data: {
-          error: 'api_error',
-          message: `GitHub API error: ${response.statusText}`,
-        },
-      };
-    }
-
-    const run = (await response.json()) as {
-      id: number;
-      name: string;
-      status: string;
-      conclusion: string | null;
-      head_branch: string;
-      head_sha: string;
-      event: string;
-      workflow_id: number;
-      run_number: number;
-      run_attempt: number;
-      created_at: string;
-      updated_at: string;
-      run_started_at: string;
-      html_url: string;
-    };
-
-    return {
-      data: {
-        run: {
-          id: run.id,
-          name: run.name,
-          status: run.status,
-          conclusion: run.conclusion,
-          headBranch: run.head_branch,
-          headSha: run.head_sha,
-          event: run.event,
-          workflowId: run.workflow_id,
-          runNumber: run.run_number,
-          runAttempt: run.run_attempt,
-          createdAt: run.created_at,
-          updatedAt: run.updated_at,
-          runStartedAt: run.run_started_at,
-          htmlUrl: run.html_url,
-        },
-      },
-    };
-  }
-}

package/src/tools/actions/github-list-workflow-runs.tool.ts

@@ -1,132 +0,0 @@
-import { Inject, Logger } from '@nestjs/common';
-import { z } from 'zod';
-import { BaseTool, Tool, ToolResult } from '@loopstack/common';
-import { OAuthTokenStore } from '@loopstack/oauth-module';
-
-const inputSchema = z
-  .object({
-    owner: z.string(),
-    repo: z.string(),
-    branch: z.string().optional(),
-    status: z
-      .enum([
-        'completed',
-        'action_required',
-        'cancelled',
-        'failure',
-        'neutral',
-        'skipped',
-        'stale',
-        'success',
-        'timed_out',
-        'in_progress',
-        'queued',
-        'requested',
-        'waiting',
-        'pending',
-      ])
-      .optional(),
-    perPage: z.number().default(30),
-    page: z.number().default(1),
-  })
-  .strict();
-
-export type GitHubListWorkflowRunsArgs = z.input<typeof inputSchema>;
-
-@Tool({
-  uiConfig: {
-    description:
-      'Lists workflow runs for a GitHub repository. Returns { error: "unauthorized" } if no valid token is available.',
-  },
-  schema: inputSchema,
-})
-export class GitHubListWorkflowRunsTool extends BaseTool {
-  private readonly logger = new Logger(GitHubListWorkflowRunsTool.name);
-
-  @Inject()
-  private tokenStore: OAuthTokenStore;
-
-  async call(args: GitHubListWorkflowRunsArgs): Promise<ToolResult> {
-    const accessToken = await this.tokenStore.getValidAccessToken(this.ctx.context.userId, 'github');
-
-    if (!accessToken) {
-      return {
-        data: {
-          error: 'unauthorized',
-          message: 'No valid GitHub token found. Please authenticate first.',
-        },
-      };
-    }
-
-    const params = new URLSearchParams({
-      per_page: String(args.perPage ?? 30),
-      page: String(args.page ?? 1),
-    });
-
-    if (args.branch) params.set('branch', args.branch);
-    if (args.status) params.set('status', args.status);
-
-    const url = `https://api.github.com/repos/${encodeURIComponent(args.owner)}/${encodeURIComponent(args.repo)}/actions/runs?${params.toString()}`;
-    const response = await fetch(url, {
-      headers: {
-        Authorization: `Bearer ${accessToken}`,
-        Accept: 'application/vnd.github+json',
-        'X-GitHub-Api-Version': '2022-11-28',
-      },
-    });
-
-    if (response.status === 401 || response.status === 403) {
-      this.logger.warn(`GitHub API returned ${response.status} for user ${this.ctx.context.userId}`);
-      return {
-        data: {
-          error: '401',
-          message: 'GitHub token was rejected. Please re-authenticate.',
-        },
-      };
-    }
-
-    if (!response.ok) {
-      const body = await response.text();
-      this.logger.error(`GitHub API error: ${response.status} ${body}`);
-      return {
-        data: {
-          error: 'api_error',
-          message: `GitHub API error: ${response.statusText}`,
-        },
-      };
-    }
-
-    const data = (await response.json()) as {
-      total_count: number;
-      workflow_runs: Array<{
-        id: number;
-        name: string;
-        status: string;
-        conclusion: string | null;
-        head_branch: string;
-        head_sha: string;
-        event: string;
-        created_at: string;
-        updated_at: string;
-        html_url: string;
-      }>;
-    };
-
-    const runs = data.workflow_runs.map((run) => ({
-      id: run.id,
-      name: run.name,
-      status: run.status,
-      conclusion: run.conclusion,
-      headBranch: run.head_branch,
-      headSha: run.head_sha,
-      event: run.event,
-      createdAt: run.created_at,
-      updatedAt: run.updated_at,
-      htmlUrl: run.html_url,
-    }));
-
-    return {
-      data: { totalCount: data.total_count, runs },
-    };
-  }
-}

package/src/tools/actions/github-trigger-workflow.tool.ts

@@ -1,89 +0,0 @@
-import { Inject, Logger } from '@nestjs/common';
-import { z } from 'zod';
-import { BaseTool, Tool, ToolResult } from '@loopstack/common';
-import { OAuthTokenStore } from '@loopstack/oauth-module';
-
-const inputSchema = z
-  .object({
-    owner: z.string(),
-    repo: z.string(),
-    workflowId: z.string(),
-    ref: z.string(),
-    inputs: z.record(z.string(), z.string()).optional(),
-  })
-  .strict();
-
-export type GitHubTriggerWorkflowArgs = z.infer<typeof inputSchema>;
-
-@Tool({
-  uiConfig: {
-    description:
-      'Triggers a GitHub Actions workflow dispatch event. Returns 204 No Content on success. Returns { error: "unauthorized" } if no valid token is available.',
-  },
-  schema: inputSchema,
-})
-export class GitHubTriggerWorkflowTool extends BaseTool {
-  private readonly logger = new Logger(GitHubTriggerWorkflowTool.name);
-
-  @Inject()
-  private tokenStore: OAuthTokenStore;
-
-  async call(args: GitHubTriggerWorkflowArgs): Promise<ToolResult> {
-    const accessToken = await this.tokenStore.getValidAccessToken(this.ctx.context.userId, 'github');
-
-    if (!accessToken) {
-      return {
-        data: {
-          error: 'unauthorized',
-          message: 'No valid GitHub token found. Please authenticate first.',
-        },
-      };
-    }
-
-    const requestBody: Record<string, unknown> = {
-      ref: args.ref,
-    };
-
-    if (args.inputs) requestBody.inputs = args.inputs;
-
-    const url = `https://api.github.com/repos/${encodeURIComponent(args.owner)}/${encodeURIComponent(args.repo)}/actions/workflows/${encodeURIComponent(args.workflowId)}/dispatches`;
-    const response = await fetch(url, {
-      method: 'POST',
-      headers: {
-        Authorization: `Bearer ${accessToken}`,
-        Accept: 'application/vnd.github+json',
-        'X-GitHub-Api-Version': '2022-11-28',
-        'Content-Type': 'application/json',
-      },
-      body: JSON.stringify(requestBody),
-    });
-
-    if (response.status === 401 || response.status === 403) {
-      this.logger.warn(`GitHub API returned ${response.status} for user ${this.ctx.context.userId}`);
-      return {
-        data: {
-          error: '401',
-          message: 'GitHub token was rejected. Please re-authenticate.',
-        },
-      };
-    }
-
-    if (!response.ok && response.status !== 204) {
-      const body = await response.text();
-      this.logger.error(`GitHub API error: ${response.status} ${body}`);
-      return {
-        data: {
-          error: 'api_error',
-          message: `GitHub API error: ${response.statusText}`,
-        },
-      };
-    }
-
-    return {
-      data: {
-        triggered: true,
-        message: 'Workflow dispatch event triggered successfully.',
-      },
-    };
-  }
-}

package/src/tools/content/github-create-or-update-file.tool.ts

@@ -1,114 +0,0 @@
-import { Inject, Logger } from '@nestjs/common';
-import { z } from 'zod';
-import { BaseTool, Tool, ToolResult } from '@loopstack/common';
-import { OAuthTokenStore } from '@loopstack/oauth-module';
-
-const inputSchema = z
-  .object({
-    owner: z.string(),
-    repo: z.string(),
-    path: z.string(),
-    content: z.string(),
-    message: z.string(),
-    sha: z.string().optional(),
-    branch: z.string().optional(),
-  })
-  .strict();
-
-export type GitHubCreateOrUpdateFileArgs = z.infer<typeof inputSchema>;
-
-@Tool({
-  uiConfig: {
-    description:
-      'Creates or updates a file in a GitHub repository. Content is provided as plain text and encoded to base64 before sending. To update an existing file, provide the sha of the file being replaced. Returns { error: "unauthorized" } if no valid token is available.',
-  },
-  schema: inputSchema,
-})
-export class GitHubCreateOrUpdateFileTool extends BaseTool {
-  private readonly logger = new Logger(GitHubCreateOrUpdateFileTool.name);
-
-  @Inject()
-  private tokenStore: OAuthTokenStore;
-
-  async call(args: GitHubCreateOrUpdateFileArgs): Promise<ToolResult> {
-    const accessToken = await this.tokenStore.getValidAccessToken(this.ctx.context.userId, 'github');
-
-    if (!accessToken) {
-      return {
-        data: {
-          error: 'unauthorized',
-          message: 'No valid GitHub token found. Please authenticate first.',
-        },
-      };
-    }
-
-    const requestBody: Record<string, unknown> = {
-      message: args.message,
-      content: Buffer.from(args.content).toString('base64'),
-    };
-
-    if (args.sha) requestBody.sha = args.sha;
-    if (args.branch) requestBody.branch = args.branch;
-
-    const url = `https://api.github.com/repos/${encodeURIComponent(args.owner)}/${encodeURIComponent(args.repo)}/contents/${args.path}`;
-    const response = await fetch(url, {
-      method: 'PUT',
-      headers: {
-        Authorization: `Bearer ${accessToken}`,
-        Accept: 'application/vnd.github+json',
-        'X-GitHub-Api-Version': '2022-11-28',
-        'Content-Type': 'application/json',
-      },
-      body: JSON.stringify(requestBody),
-    });
-
-    if (response.status === 401 || response.status === 403) {
-      this.logger.warn(`GitHub API returned ${response.status} for user ${this.ctx.context.userId}`);
-      return {
-        data: {
-          error: '401',
-          message: 'GitHub token was rejected. Please re-authenticate.',
-        },
-      };
-    }
-
-    if (!response.ok) {
-      const errorBody = await response.text();
-      this.logger.error(`GitHub API error: ${response.status} ${errorBody}`);
-      return {
-        data: {
-          error: 'api_error',
-          message: `GitHub API error: ${response.statusText}`,
-        },
-      };
-    }
-
-    const data = (await response.json()) as {
-      content: {
-        name: string;
-        path: string;
-        sha: string;
-        html_url: string;
-      };
-      commit: {
-        sha: string;
-        message: string;
-      };
-    };
-
-    return {
-      data: {
-        file: {
-          name: data.content.name,
-          path: data.content.path,
-          sha: data.content.sha,
-          htmlUrl: data.content.html_url,
-        },
-        commit: {
-          sha: data.commit.sha,
-          message: data.commit.message,
-        },
-      },
-    };
-  }
-}