The best way to control Claude Code, Codex and more from any computer or phone
| 1 | import * as Repos from "@distilled.cloud/github/repos"; |
| 2 | import { isResolved } from "alchemy/Diff"; |
| 3 | import * as Provider from "alchemy/Provider"; |
| 4 | import { Resource } from "alchemy/Resource"; |
| 5 | import * as Effect from "effect/Effect"; |
| 6 | import * as Stream from "effect/Stream"; |
| 7 | import { withBaseUrl, gitHubBaseUrlChanged } from "./BaseUrl.ts"; |
| 8 | import type * as GitHub from "./Providers.ts"; |
| 9 | |
| 10 | export interface CollaboratorProps { |
| 11 | /** |
| 12 | * Repository owner — a user or organization login. |
| 13 | */ |
| 14 | owner: string; |
| 15 | |
| 16 | /** |
| 17 | * Repository name. |
| 18 | */ |
| 19 | repository: string; |
| 20 | |
| 21 | /** |
| 22 | * GitHub username to grant access. |
| 23 | */ |
| 24 | username: string; |
| 25 | |
| 26 | /** |
| 27 | * Permission level to grant. |
| 28 | * - `pull` — read-only access |
| 29 | * - `push` — read and write access |
| 30 | * - `maintain` — read, write, and manage issues/PRs |
| 31 | * - `triage` — read and manage issues/PRs without write access |
| 32 | * - `admin` — full admin access |
| 33 | * |
| 34 | * @default "push" |
| 35 | */ |
| 36 | permission?: "pull" | "push" | "maintain" | "triage" | "admin"; |
| 37 | |
| 38 | /** |
| 39 | * Override the GitHub host or API base URL for this resource only (e.g. |
| 40 | * `github.example.com` for GitHub Enterprise). Falls back to |
| 41 | * `GitHub.providers({ baseUrl })`, then to the host resolved by the auth |
| 42 | * provider. Changing it replaces the resource — the same name on a |
| 43 | * different GitHub instance is a different physical resource. |
| 44 | */ |
| 45 | baseUrl?: string; |
| 46 | } |
| 47 | |
| 48 | export interface Collaborator extends Resource< |
| 49 | "GitHub.Collaborator", |
| 50 | CollaboratorProps, |
| 51 | { |
| 52 | /** |
| 53 | * GitHub username. |
| 54 | */ |
| 55 | username: string; |
| 56 | |
| 57 | /** |
| 58 | * Permission level granted. |
| 59 | */ |
| 60 | permission: string; |
| 61 | }, |
| 62 | never, |
| 63 | GitHub.Providers |
| 64 | > {} |
| 65 | |
| 66 | /** |
| 67 | * A GitHub repository collaborator. |
| 68 | * |
| 69 | * `Collaborator` grants a user direct access to a repository. For |
| 70 | * organization-owned repositories, prefer `GitHub.TeamAccess` to grant |
| 71 | * access through teams instead of individual users. |
| 72 | * |
| 73 | * Collaborators default to **retain** on removal — destroying the stack does |
| 74 | * NOT remove the collaborator, preventing accidental lockout. Opt in to |
| 75 | * actual removal by wrapping the resource in {@link destroy}() from |
| 76 | * `alchemy/RemovalPolicy`. |
| 77 | * |
| 78 | * Authentication is resolved via the GitHub `Credentials` service supplied by |
| 79 | * `GitHub.providers()` (env, stored PAT, `gh` CLI, or OAuth). The token needs |
| 80 | * `repo` scope (and `admin:repo` for removal when opted in via `destroy()`). |
| 81 | * |
| 82 | * ### Adding a Collaborator |
| 83 | * **Example:** Grant Push Access |
| 84 | * ```typescript |
| 85 | * yield* GitHub.Collaborator("collaborator", { |
| 86 | * owner: "my-org", |
| 87 | * repository: "my-repo", |
| 88 | * username: "contributor", |
| 89 | * permission: "push", |
| 90 | * }) |
| 91 | * ``` |
| 92 | * |
| 93 | * **Example:** Grant Admin Access |
| 94 | * ```typescript |
| 95 | * yield* GitHub.Collaborator("admin", { |
| 96 | * owner: "my-org", |
| 97 | * repository: "my-repo", |
| 98 | * username: "team-lead", |
| 99 | * permission: "admin", |
| 100 | * }) |
| 101 | * ``` |
| 102 | * |
| 103 | * **Example:** Grant Read-Only Access |
| 104 | * ```typescript |
| 105 | * yield* GitHub.Collaborator("readonly", { |
| 106 | * owner: "my-org", |
| 107 | * repository: "my-repo", |
| 108 | * username: "auditor", |
| 109 | * permission: "pull", |
| 110 | * }) |
| 111 | * ``` |
| 112 | * |
| 113 | * ### Removing a Collaborator |
| 114 | * **Example:** Allow Removal on Destroy |
| 115 | * ```typescript |
| 116 | * import { destroy } from "alchemy/RemovalPolicy" |
| 117 | * |
| 118 | * yield* GitHub.Collaborator("temp", { |
| 119 | * owner: "my-org", |
| 120 | * repository: "my-repo", |
| 121 | * username: "contractor", |
| 122 | * permission: "push", |
| 123 | * }).pipe(destroy()) |
| 124 | * ``` |
| 125 | * |
| 126 | * @resource |
| 127 | * @product Repository |
| 128 | */ |
| 129 | export const Collaborator = Resource<Collaborator>("GitHub.Collaborator", { |
| 130 | defaultRemovalPolicy: "retain", |
| 131 | }); |
| 132 | |
| 133 | export const CollaboratorProvider = () => |
| 134 | Provider.succeed(Collaborator, { |
| 135 | diff: Effect.fn(function* ({ news, olds }) { |
| 136 | if (!isResolved(news)) return; |
| 137 | if (olds === undefined) return; |
| 138 | if ( |
| 139 | news.owner !== olds.owner || |
| 140 | news.repository !== olds.repository || |
| 141 | news.username !== olds.username || |
| 142 | (yield* gitHubBaseUrlChanged(olds, news)) |
| 143 | ) { |
| 144 | return { action: "replace" }; |
| 145 | } |
| 146 | }), |
| 147 | |
| 148 | reconcile: Effect.fn( |
| 149 | function* ({ news }) { |
| 150 | // Ensure & Sync — PUT is idempotent; creates or updates permission |
| 151 | yield* Repos.addCollaborator({ |
| 152 | owner: news.owner, |
| 153 | repo: news.repository, |
| 154 | username: news.username, |
| 155 | permission: news.permission ?? "push", |
| 156 | }); |
| 157 | |
| 158 | return { |
| 159 | username: news.username, |
| 160 | permission: news.permission ?? "push", |
| 161 | }; |
| 162 | }, |
| 163 | (effect, { news }) => effect.pipe(withBaseUrl(news.baseUrl)), |
| 164 | ), |
| 165 | |
| 166 | list: Effect.fn(function* () { |
| 167 | const repos = yield* Stream.runCollect( |
| 168 | Repos.listForAuthenticatedUser.items({ per_page: 100 }), |
| 169 | ); |
| 170 | const perRepo = yield* Effect.forEach( |
| 171 | repos, |
| 172 | (repo) => |
| 173 | Stream.runCollect( |
| 174 | Repos.listCollaborators.items({ |
| 175 | owner: repo.owner.login, |
| 176 | repo: repo.name, |
| 177 | per_page: 100, |
| 178 | }), |
| 179 | ).pipe( |
| 180 | Effect.map((collaborators) => |
| 181 | collaborators.map((collab) => ({ |
| 182 | username: collab.login, |
| 183 | permission: collab.permissions?.admin |
| 184 | ? ("admin" as const) |
| 185 | : collab.permissions?.maintain |
| 186 | ? ("maintain" as const) |
| 187 | : collab.permissions?.push |
| 188 | ? ("push" as const) |
| 189 | : collab.permissions?.triage |
| 190 | ? ("triage" as const) |
| 191 | : ("pull" as const), |
| 192 | })), |
| 193 | ), |
| 194 | Effect.catchTag(["Forbidden", "NotFound"], () => Effect.succeed([])), |
| 195 | ), |
| 196 | { concurrency: 10 }, |
| 197 | ); |
| 198 | return perRepo.flat(); |
| 199 | }), |
| 200 | |
| 201 | delete: Effect.fn( |
| 202 | function* ({ olds }) { |
| 203 | yield* Repos.removeCollaborator({ |
| 204 | owner: olds.owner, |
| 205 | repo: olds.repository, |
| 206 | username: olds.username, |
| 207 | }).pipe(Effect.catchTag("NotFound", () => Effect.void)); |
| 208 | }, |
| 209 | (effect, { olds }) => effect.pipe(withBaseUrl(olds.baseUrl)), |
| 210 | ), |
| 211 | }); |