@flink-app/github-app-plugin 0.12.1-alpha.38

package/examples/repository-access.ts

@@ -0,0 +1,480 @@
+/**
+ * Repository Access Example
+ *
+ * This example demonstrates:
+ * - Accessing user's GitHub repositories via API client
+ * - Fetching repository contents
+ * - Checking repository permissions
+ * - Listing branches and commits
+ * - Verifying user has access to specific repositories
+ */
+
+import { FlinkApp, FlinkContext, GetHandler } from "@flink-app/flink";
+import { githubAppPlugin } from "@flink-app/github-app-plugin";
+
+interface AppContext extends FlinkContext {
+  plugins: {
+    githubApp: any;
+  };
+  session?: {
+    userId?: string;
+  };
+}
+
+async function start() {
+  const app = new FlinkApp<AppContext>({
+    name: "GitHub App Repository Access Example",
+    port: 3333,
+
+    db: {
+      uri: process.env.MONGODB_URI || "mongodb://localhost:27017/github-app-repo-example",
+    },
+
+    plugins: [
+      githubAppPlugin({
+        appId: process.env.GITHUB_APP_ID!,
+        privateKey: process.env.GITHUB_APP_PRIVATE_KEY!,
+        webhookSecret: process.env.GITHUB_WEBHOOK_SECRET!,
+        clientId: process.env.GITHUB_APP_CLIENT_ID!,
+        clientSecret: process.env.GITHUB_APP_CLIENT_SECRET!,
+
+        onInstallationSuccess: async ({ installationId, repositories, account }) => {
+          const userId = "demo-user-123";
+
+          console.log(`\nInstallation successful!`);
+          console.log(`Account: ${account.login}`);
+          console.log(`Repositories: ${repositories.length}`);
+
+          return { userId, redirectUrl: "/repos" };
+        },
+      }),
+    ],
+  });
+
+  await app.start();
+
+  console.log(`
+=================================
+Repository Access Example Started
+=================================
+
+Available endpoints:
+
+1. GET /repos/list
+   List all accessible repositories
+
+2. GET /repos/:owner/:repo
+   Get repository details
+
+3. GET /repos/:owner/:repo/contents?path=README.md
+   Get file contents
+
+4. GET /repos/:owner/:repo/check-access
+   Check if user has access to repository
+
+5. GET /repos/:owner/:repo/branches
+   List repository branches
+
+6. GET /repos/:owner/:repo/commits?branch=main
+   List recent commits
+
+Install the GitHub App first:
+http://localhost:3333/github-app/install?user_id=demo-user-123
+
+=================================
+  `);
+}
+
+// Handler: List all accessible repositories
+const ListRepositories: GetHandler = async ({ ctx }) => {
+  const userId = ctx.session?.userId || "demo-user-123";
+
+  try {
+    // Get user's installation
+    const installation = await ctx.plugins.githubApp.getInstallation(userId);
+
+    if (!installation) {
+      return {
+        status: 404,
+        data: {
+          error: "github-app-not-installed",
+          message: "Please install the GitHub App first",
+        },
+      };
+    }
+
+    // Get API client
+    const client = await ctx.plugins.githubApp.getClient(installation.installationId);
+
+    // Fetch repositories
+    const repos = await client.getRepositories();
+
+    return {
+      status: 200,
+      data: {
+        installation: {
+          account: installation.accountLogin,
+          type: installation.accountType,
+        },
+        repositories: repos.map((repo: any) => ({
+          id: repo.id,
+          name: repo.name,
+          fullName: repo.full_name,
+          private: repo.private,
+          url: repo.html_url,
+          description: repo.description,
+          language: repo.language,
+          stargazersCount: repo.stargazers_count,
+          forksCount: repo.forks_count,
+          defaultBranch: repo.default_branch,
+          updatedAt: repo.updated_at,
+        })),
+        total: repos.length,
+      },
+    };
+  } catch (error: any) {
+    console.error("Failed to list repositories:", error);
+    return {
+      status: 500,
+      data: {
+        error: "repository-access-failed",
+        message: error.message,
+      },
+    };
+  }
+};
+
+export { ListRepositories };
+
+// Handler: Get repository details
+const GetRepository: GetHandler<any, any, { owner: string; repo: string }> = async ({ ctx, params }) => {
+  const userId = ctx.session?.userId || "demo-user-123";
+  const { owner, repo } = params;
+
+  try {
+    // Check if user has access
+    const hasAccess = await ctx.plugins.githubApp.hasRepositoryAccess(userId, owner, repo);
+
+    if (!hasAccess) {
+      return {
+        status: 403,
+        data: {
+          error: "access-denied",
+          message: "You do not have access to this repository",
+        },
+      };
+    }
+
+    // Get installation
+    const installation = await ctx.plugins.githubApp.getInstallation(userId);
+    if (!installation) {
+      return {
+        status: 404,
+        data: { error: "installation-not-found" },
+      };
+    }
+
+    // Get API client
+    const client = await ctx.plugins.githubApp.getClient(installation.installationId);
+
+    // Fetch repository details
+    const repository = await client.getRepository(owner, repo);
+
+    return {
+      status: 200,
+      data: {
+        id: repository.id,
+        name: repository.name,
+        fullName: repository.full_name,
+        private: repository.private,
+        description: repository.description,
+        url: repository.html_url,
+        cloneUrl: repository.clone_url,
+        language: repository.language,
+        defaultBranch: repository.default_branch,
+        stargazersCount: repository.stargazers_count,
+        watchersCount: repository.watchers_count,
+        forksCount: repository.forks_count,
+        openIssuesCount: repository.open_issues_count,
+        license: repository.license?.name,
+        topics: repository.topics,
+        createdAt: repository.created_at,
+        updatedAt: repository.updated_at,
+        pushedAt: repository.pushed_at,
+      },
+    };
+  } catch (error: any) {
+    console.error("Failed to get repository:", error);
+    return {
+      status: 500,
+      data: {
+        error: "repository-access-failed",
+        message: error.message,
+      },
+    };
+  }
+};
+
+export { GetRepository };
+
+// Handler: Get file contents
+const GetContents: GetHandler<any, any, { owner: string; repo: string }, { path?: string }> = async ({
+  ctx,
+  params,
+  query,
+}) => {
+  const userId = ctx.session?.userId || "demo-user-123";
+  const { owner, repo } = params;
+  const { path = "" } = query;
+
+  try {
+    // Check access
+    const hasAccess = await ctx.plugins.githubApp.hasRepositoryAccess(userId, owner, repo);
+
+    if (!hasAccess) {
+      return {
+        status: 403,
+        data: {
+          error: "access-denied",
+          message: "You do not have access to this repository",
+        },
+      };
+    }
+
+    // Get installation
+    const installation = await ctx.plugins.githubApp.getInstallation(userId);
+    if (!installation) {
+      return {
+        status: 404,
+        data: { error: "installation-not-found" },
+      };
+    }
+
+    // Get API client
+    const client = await ctx.plugins.githubApp.getClient(installation.installationId);
+
+    // Fetch contents
+    const contents = await client.getContents(owner, repo, path);
+
+    // Handle directory vs file
+    if (Array.isArray(contents)) {
+      // Directory listing
+      return {
+        status: 200,
+        data: {
+          type: "directory",
+          path,
+          items: contents.map((item: any) => ({
+            name: item.name,
+            path: item.path,
+            type: item.type,
+            size: item.size,
+            sha: item.sha,
+            url: item.html_url,
+          })),
+        },
+      };
+    } else {
+      // Single file
+      const file = contents as any;
+      let content = file.content;
+
+      // Decode base64 content if present
+      if (file.encoding === "base64" && content) {
+        content = Buffer.from(content, "base64").toString("utf-8");
+      }
+
+      return {
+        status: 200,
+        data: {
+          type: "file",
+          name: file.name,
+          path: file.path,
+          sha: file.sha,
+          size: file.size,
+          encoding: file.encoding,
+          content,
+          url: file.html_url,
+        },
+      };
+    }
+  } catch (error: any) {
+    console.error("Failed to get contents:", error);
+    return {
+      status: 500,
+      data: {
+        error: "contents-access-failed",
+        message: error.message,
+      },
+    };
+  }
+};
+
+export { GetContents };
+
+// Handler: Check repository access
+const CheckAccess: GetHandler<any, any, { owner: string; repo: string }> = async ({ ctx, params }) => {
+  const userId = ctx.session?.userId || "demo-user-123";
+  const { owner, repo } = params;
+
+  try {
+    const hasAccess = await ctx.plugins.githubApp.hasRepositoryAccess(userId, owner, repo);
+
+    return {
+      status: 200,
+      data: {
+        owner,
+        repo,
+        hasAccess,
+      },
+    };
+  } catch (error: any) {
+    console.error("Failed to check access:", error);
+    return {
+      status: 500,
+      data: {
+        error: "access-check-failed",
+        message: error.message,
+      },
+    };
+  }
+};
+
+export { CheckAccess };
+
+// Handler: List branches
+const ListBranches: GetHandler<any, any, { owner: string; repo: string }> = async ({ ctx, params }) => {
+  const userId = ctx.session?.userId || "demo-user-123";
+  const { owner, repo } = params;
+
+  try {
+    // Check access
+    const hasAccess = await ctx.plugins.githubApp.hasRepositoryAccess(userId, owner, repo);
+
+    if (!hasAccess) {
+      return {
+        status: 403,
+        data: { error: "access-denied" },
+      };
+    }
+
+    // Get installation and client
+    const installation = await ctx.plugins.githubApp.getInstallation(userId);
+    if (!installation) {
+      return {
+        status: 404,
+        data: { error: "installation-not-found" },
+      };
+    }
+
+    const client = await ctx.plugins.githubApp.getClient(installation.installationId);
+
+    // Fetch branches
+    const branches = await client.request("GET", `/repos/${owner}/${repo}/branches`);
+
+    return {
+      status: 200,
+      data: {
+        branches: branches.map((branch: any) => ({
+          name: branch.name,
+          protected: branch.protected,
+          commit: {
+            sha: branch.commit.sha,
+            url: branch.commit.url,
+          },
+        })),
+        total: branches.length,
+      },
+    };
+  } catch (error: any) {
+    console.error("Failed to list branches:", error);
+    return {
+      status: 500,
+      data: {
+        error: "branches-access-failed",
+        message: error.message,
+      },
+    };
+  }
+};
+
+export { ListBranches };
+
+// Handler: List commits
+const ListCommits: GetHandler<any, any, { owner: string; repo: string }, { branch?: string; limit?: string }> = async ({
+  ctx,
+  params,
+  query,
+}) => {
+  const userId = ctx.session?.userId || "demo-user-123";
+  const { owner, repo } = params;
+  const { branch = "main", limit = "10" } = query;
+
+  try {
+    // Check access
+    const hasAccess = await ctx.plugins.githubApp.hasRepositoryAccess(userId, owner, repo);
+
+    if (!hasAccess) {
+      return {
+        status: 403,
+        data: { error: "access-denied" },
+      };
+    }
+
+    // Get installation and client
+    const installation = await ctx.plugins.githubApp.getInstallation(userId);
+    if (!installation) {
+      return {
+        status: 404,
+        data: { error: "installation-not-found" },
+      };
+    }
+
+    const client = await ctx.plugins.githubApp.getClient(installation.installationId);
+
+    // Fetch commits
+    const commits = await client.request("GET", `/repos/${owner}/${repo}/commits`, {
+      sha: branch,
+      per_page: parseInt(limit, 10),
+    });
+
+    return {
+      status: 200,
+      data: {
+        branch,
+        commits: commits.map((commit: any) => ({
+          sha: commit.sha,
+          message: commit.commit.message,
+          author: {
+            name: commit.commit.author.name,
+            email: commit.commit.author.email,
+            date: commit.commit.author.date,
+          },
+          committer: {
+            name: commit.commit.committer.name,
+            date: commit.commit.committer.date,
+          },
+          url: commit.html_url,
+        })),
+        total: commits.length,
+      },
+    };
+  } catch (error: any) {
+    console.error("Failed to list commits:", error);
+    return {
+      status: 500,
+      data: {
+        error: "commits-access-failed",
+        message: error.message,
+      },
+    };
+  }
+};
+
+export { ListCommits };
+
+// Start application
+start().catch((error) => {
+  console.error("Failed to start application:", error);
+  process.exit(1);
+});