repo-sdk 0.1.2 → 0.1.3

package/README.md

@@ -74,7 +74,7 @@ npm install
 | `npm run test:live`  | Gated live provider tests (env vars documented in CONTRIBUTING) |
 | `npm run typecheck`  | Type-check without emitting                                     |
 | `npm run lint`       | Lint the codebase                                               |
-| `npm run format`     | Format with prettier                                            |
+| `npm run fmt`        | Format with prettier                                            |
 
 Docs site:
 

package/dist/azure-devops.js

@@ -1,6 +1,6 @@
 import { t as RepoError } from "./errors-Cxq_CqYv.js";
 import { n as decodeCursor, r as encodeCursor } from "./pagination-CWWHSu8I.js";
-import { a as isRecord, i as filenameFromContentDisposition, n as commitWebUrlBuilder, s as HttpClient } from "./shared-CuiOaaLD.js";
+import { a as filenameFromContentDisposition, o as isRecord, r as commitWebUrlBuilder, t as HttpClient } from "./http-C3hAQeY0.js";
 import { a as headShaOrUndefined, n as timingSafeEqual, r as toIncomingWebhook } from "./verify-BBMVxz8q.js";
 //#region src/providers/azure-devops/auth.ts
 /**

package/dist/bitbucket.js

@@ -1,6 +1,6 @@
 import { t as RepoError } from "./errors-Cxq_CqYv.js";
 import { n as decodeCursor, r as encodeCursor, t as assertSameOriginUrl } from "./pagination-CWWHSu8I.js";
-import { a as isRecord, i as filenameFromContentDisposition, n as commitWebUrlBuilder, s as HttpClient, t as clampPerPage } from "./shared-CuiOaaLD.js";
+import { a as filenameFromContentDisposition, n as clampPerPage, o as isRecord, r as commitWebUrlBuilder, t as HttpClient } from "./http-C3hAQeY0.js";
 import { a as headShaOrUndefined, i as verifyHmacSignature, r as toIncomingWebhook } from "./verify-BBMVxz8q.js";
 //#region src/providers/bitbucket/index.ts
 const BASE_URL = "https://api.bitbucket.org/2.0";

package/dist/git-http.js

@@ -1,6 +1,6 @@
 import { t as RepoError } from "./errors-Cxq_CqYv.js";
 import { a as stringToBase64, n as decodeCursor, r as encodeCursor } from "./pagination-CWWHSu8I.js";
-import { s as HttpClient, t as clampPerPage } from "./shared-CuiOaaLD.js";
+import { n as clampPerPage, t as HttpClient } from "./http-C3hAQeY0.js";
 //#region src/providers/git-http/index.ts
 const CAPABILITIES = {
 	userProfile: false,

package/dist/gitea.js

@@ -1,6 +1,6 @@
 import { t as RepoError } from "./errors-Cxq_CqYv.js";
 import { n as decodeCursor, r as encodeCursor, t as assertSameOriginUrl } from "./pagination-CWWHSu8I.js";
-import { a as isRecord, i as filenameFromContentDisposition, n as commitWebUrlBuilder, o as parseLinkNext, r as encodeRefPath, s as HttpClient, t as clampPerPage } from "./shared-CuiOaaLD.js";
+import { a as filenameFromContentDisposition, i as encodeRefPath, n as clampPerPage, o as isRecord, r as commitWebUrlBuilder, s as parseLinkNext, t as HttpClient } from "./http-C3hAQeY0.js";
 import { a as headShaOrUndefined, n as timingSafeEqual, r as toIncomingWebhook, t as hmacSha256Hex } from "./verify-BBMVxz8q.js";
 //#region src/providers/gitea/index.ts
 const DEFAULT_BASE_URL = "https://gitea.com/api/v1";

package/dist/github.d.ts

@@ -1,4 +1,4 @@
-import { B as TokenProvider, F as RepoProvider, O as ParsedWebhookEvent, v as IncomingWebhookRequest } from "./types-DfiRluvJ.js";
+import { B as TokenProvider, D as Page, F as RepoProvider, O as ParsedWebhookEvent, v as IncomingWebhookRequest } from "./types-DfiRluvJ.js";
 import { t as VerifyWebhookParams } from "./verify-p6JsExms.js";
 //#region src/providers/github/app-auth.d.ts
 interface InstallationToken {
@@ -43,8 +43,42 @@ interface GitHubRepoProvider extends RepoProvider {
 declare const commitWebUrl: (repoWebUrl: string, sha: string) => string;
 declare function github(options: GitHubProviderOptions): GitHubRepoProvider;
 //#endregion
+//#region src/providers/github/installations.d.ts
+interface ListUserInstallationsParams {
+  /**
+   * A user access token — e.g. the OAuth token minted by the GitHub App web
+   * login flow. Installation tokens cannot call this endpoint.
+   */
+  token: string;
+  /** GHES API root (`/api/v3`); defaults to `https://api.github.com`. */
+  baseUrl?: string;
+  fetch?: typeof fetch;
+  limit?: number;
+  cursor?: string;
+  signal?: AbortSignal;
+}
+interface GitHubInstallationAccount {
+  id: string;
+  login: string;
+  kind: 'user' | 'organization';
+  avatarUrl?: string;
+}
+interface GitHubUserInstallation {
+  id: string;
+  /** Account the app is installed on; absent for enterprise-level installations. */
+  account?: GitHubInstallationAccount;
+  raw: unknown;
+}
+/**
+ * Lists the GitHub App installations the given user can access
+ * (`GET /user/installations`). Standalone by design: the endpoint requires a
+ * user access token, a different credential from the installation token the
+ * `github` provider authenticates its requests with.
+ */
+declare function listUserInstallations(params: ListUserInstallationsParams): Promise<Page<GitHubUserInstallation>>;
+//#endregion
 //#region src/providers/github/webhooks.d.ts
 declare function verifyWebhook(params: VerifyWebhookParams): Promise<boolean>;
 declare function parseWebhookEvent(input: Request | IncomingWebhookRequest): Promise<ParsedWebhookEvent>;
 //#endregion
-export { type GitHubAppAuth, type GitHubAuth, type GitHubInstallationToken, type GitHubProviderOptions, type GitHubRepoProvider, type GitHubTokenAuth, type VerifyWebhookParams, commitWebUrl, github, parseWebhookEvent, verifyWebhook };
+export { type GitHubAppAuth, type GitHubAuth, type GitHubInstallationAccount, type GitHubInstallationToken, type GitHubProviderOptions, type GitHubRepoProvider, type GitHubTokenAuth, type GitHubUserInstallation, type ListUserInstallationsParams, type VerifyWebhookParams, commitWebUrl, github, listUserInstallations, parseWebhookEvent, verifyWebhook };

package/dist/github.js

@@ -1,6 +1,6 @@
 import { n as codeFromStatus, t as RepoError } from "./errors-Cxq_CqYv.js";
 import { i as bytesToBase64Url, n as decodeCursor, r as encodeCursor, t as assertSameOriginUrl } from "./pagination-CWWHSu8I.js";
-import { a as isRecord, i as filenameFromContentDisposition, n as commitWebUrlBuilder, o as parseLinkNext, r as encodeRefPath, s as HttpClient, t as clampPerPage } from "./shared-CuiOaaLD.js";
+import { a as filenameFromContentDisposition, i as encodeRefPath, n as clampPerPage, o as isRecord, r as commitWebUrlBuilder, s as parseLinkNext, t as HttpClient } from "./http-C3hAQeY0.js";
 import { a as headShaOrUndefined, i as verifyHmacSignature, r as toIncomingWebhook } from "./verify-BBMVxz8q.js";
 //#region src/providers/github/app-auth.ts
 const RSA_ALGORITHM_IDENTIFIER = [
@@ -205,9 +205,10 @@ var AppTokenSource = class {
 	}
 	async appRequest(path, method, jwt) {
 		const url = joinUrl(this.baseUrl, path);
+		const { fetchImpl } = this;
 		let response;
 		try {
-			response = await this.fetchImpl(url, {
+			response = await fetchImpl(url, {
 				method,
 				headers: {
 					Authorization: `Bearer ${jwt}`,
@@ -242,11 +243,23 @@ var AppTokenSource = class {
 		});
 	}
 };
-//#endregion
-//#region src/providers/github/index.ts
-const DEFAULT_BASE_URL = "https://api.github.com";
 const API_VERSION = "2022-11-28";
 const USER_AGENT = "repo-sdk";
+function mapError(status, body, response) {
+	const message = isRecord(body) && typeof body.message === "string" ? body.message : void 0;
+	let code;
+	if (status === 429 || status === 403 && response.headers.get("x-ratelimit-remaining") === "0") code = "rate_limited";
+	return {
+		code,
+		message
+	};
+}
+function nextCursor(response) {
+	const next = parseLinkNext(response.headers.get("link"));
+	return next === void 0 ? void 0 : encodeCursor("github", { url: next });
+}
+//#endregion
+//#region src/providers/github/index.ts
 const CAPABILITIES = {
 	tagDates: false,
 	repoSearch: true,
@@ -297,10 +310,6 @@ function createTokenSource(auth, baseUrl, fetchImpl) {
 		userAgent: USER_AGENT
 	});
 }
-function nextCursor(response) {
-	const next = parseLinkNext(response.headers.get("link"));
-	return next === void 0 ? void 0 : encodeCursor("github", { url: next });
-}
 function gitHostFromBaseUrl(baseUrl) {
 	const url = new URL(baseUrl);
 	return url.hostname === "api.github.com" ? "github.com" : url.host;
@@ -410,22 +419,13 @@ function toWebhook(hook) {
 		raw: hook
 	};
 }
-function mapError(status, body, response) {
-	const message = isRecord(body) && typeof body.message === "string" ? body.message : void 0;
-	let code;
-	if (status === 429 || status === 403 && response.headers.get("x-ratelimit-remaining") === "0") code = "rate_limited";
-	return {
-		code,
-		message
-	};
-}
 /**
 * Builds the human-facing web URL for a commit from the repository's web URL
 * (`Repository.urls.web`) and a commit SHA — no API request needed.
 */
 const commitWebUrl = commitWebUrlBuilder("commit");
 function github(options) {
-	const baseUrl = options.baseUrl ?? DEFAULT_BASE_URL;
+	const baseUrl = options.baseUrl ?? "https://api.github.com";
 	const fetchImpl = options.fetch ?? fetch;
 	const tokenSource = createTokenSource(options.auth, baseUrl, fetchImpl);
 	const webBase = `https://${gitHostFromBaseUrl(baseUrl)}`;
@@ -863,6 +863,58 @@ function github(options) {
 	};
 }
 //#endregion
+//#region src/providers/github/installations.ts
+function toInstallation(payload) {
+	const account = payload.account;
+	return {
+		id: String(payload.id),
+		account: account?.login === void 0 ? void 0 : {
+			id: String(account.id),
+			login: account.login,
+			kind: account.type === "Organization" ? "organization" : "user",
+			avatarUrl: account.avatar_url
+		},
+		raw: payload
+	};
+}
+/**
+* Lists the GitHub App installations the given user can access
+* (`GET /user/installations`). Standalone by design: the endpoint requires a
+* user access token, a different credential from the installation token the
+* `github` provider authenticates its requests with.
+*/
+async function listUserInstallations(params) {
+	const { token } = params;
+	const baseUrl = params.baseUrl ?? "https://api.github.com";
+	const http = new HttpClient({
+		provider: "github",
+		baseUrl,
+		fetchImpl: params.fetch,
+		authHeaders: () => ({
+			Authorization: `Bearer ${token}`,
+			Accept: "application/vnd.github+json",
+			"X-GitHub-Api-Version": API_VERSION,
+			"User-Agent": USER_AGENT
+		}),
+		mapError,
+		secrets: () => [token]
+	});
+	let path = "/user/installations";
+	let query;
+	if (params.cursor) {
+		const { url } = decodeCursor("github", params.cursor);
+		path = assertSameOriginUrl("github", baseUrl, url);
+	} else query = { per_page: clampPerPage(params.limit) };
+	const { data, response } = await http.json(path, {
+		query,
+		signal: params.signal
+	});
+	return {
+		data: (data.installations ?? []).map(toInstallation),
+		cursor: nextCursor(response)
+	};
+}
+//#endregion
 //#region src/providers/github/webhooks.ts
 function verifyWebhook(params) {
 	return verifyHmacSignature(params, { header: "x-hub-signature-256" });
@@ -897,4 +949,4 @@ async function parseWebhookEvent(input) {
 	};
 }
 //#endregion
-export { commitWebUrl, github, parseWebhookEvent, verifyWebhook };
+export { commitWebUrl, github, listUserInstallations, parseWebhookEvent, verifyWebhook };

package/dist/gitlab.js

@@ -1,6 +1,6 @@
 import { t as RepoError } from "./errors-Cxq_CqYv.js";
 import { n as decodeCursor, r as encodeCursor, t as assertSameOriginUrl } from "./pagination-CWWHSu8I.js";
-import { a as isRecord, i as filenameFromContentDisposition, n as commitWebUrlBuilder, o as parseLinkNext, s as HttpClient, t as clampPerPage } from "./shared-CuiOaaLD.js";
+import { a as filenameFromContentDisposition, n as clampPerPage, o as isRecord, r as commitWebUrlBuilder, s as parseLinkNext, t as HttpClient } from "./http-C3hAQeY0.js";
 import { a as headShaOrUndefined, n as timingSafeEqual, r as toIncomingWebhook } from "./verify-BBMVxz8q.js";
 //#region src/providers/gitlab/index.ts
 const DEFAULT_BASE_URL = "https://gitlab.com/api/v4";

package/dist/{shared-CuiOaaLD.js → http-C3hAQeY0.js}

@@ -1,5 +1,37 @@
 import { n as codeFromStatus, r as parseRetryAfter, t as RepoError } from "./errors-Cxq_CqYv.js";
+//#region src/providers/shared.ts
+function isRecord(value) {
+	return typeof value === "object" && value !== null;
+}
+function clampPerPage(limit, max = 100) {
+	if (limit === void 0) return void 0;
+	return Math.min(Math.max(1, Math.trunc(limit)), max);
+}
+function parseLinkNext(header) {
+	if (!header) return void 0;
+	for (const part of header.split(",")) {
+		const match = part.match(/<([^>]+)>\s*;\s*rel="([^"]+)"/);
+		if (match && match[2] === "next") return match[1];
+	}
+}
+/** Percent-encodes a ref path while keeping its `/` separators intact. */
+function encodeRefPath(ref) {
+	return ref.split("/").map(encodeURIComponent).join("/");
+}
+function commitWebUrlBuilder(pathSegment) {
+	return function commitWebUrl(repoWebUrl, sha) {
+		return `${repoWebUrl.replace(/\/+$/, "")}/${pathSegment}/${sha}`;
+	};
+}
+function filenameFromContentDisposition(header) {
+	if (!header) return void 0;
+	const extended = header.match(/filename\*=(?:UTF-8'')?([^;]+)/i);
+	if (extended?.[1]) return decodeURIComponent(extended[1].trim().replace(/^"|"$/g, ""));
+	return header.match(/filename="?([^";]+)"?/i)?.[1]?.trim();
+}
+//#endregion
 //#region src/http.ts
+const USER_AGENT = "repo-sdk";
 var HttpClient = class {
 	options;
 	constructor(options) {
@@ -23,6 +55,7 @@ var HttpClient = class {
 				...await this.options.authHeaders({ forceRefresh }),
 				...options.headers
 			};
+			headers["User-Agent"] ??= USER_AGENT;
 			if (body !== void 0) headers["Content-Type"] ??= "application/json";
 			try {
 				return await fetchImpl(url, {
@@ -71,35 +104,4 @@ var HttpClient = class {
 	}
 };
 //#endregion
-//#region src/providers/shared.ts
-function isRecord(value) {
-	return typeof value === "object" && value !== null;
-}
-function clampPerPage(limit, max = 100) {
-	if (limit === void 0) return void 0;
-	return Math.min(Math.max(1, Math.trunc(limit)), max);
-}
-function parseLinkNext(header) {
-	if (!header) return void 0;
-	for (const part of header.split(",")) {
-		const match = part.match(/<([^>]+)>\s*;\s*rel="([^"]+)"/);
-		if (match && match[2] === "next") return match[1];
-	}
-}
-/** Percent-encodes a ref path while keeping its `/` separators intact. */
-function encodeRefPath(ref) {
-	return ref.split("/").map(encodeURIComponent).join("/");
-}
-function commitWebUrlBuilder(pathSegment) {
-	return function commitWebUrl(repoWebUrl, sha) {
-		return `${repoWebUrl.replace(/\/+$/, "")}/${pathSegment}/${sha}`;
-	};
-}
-function filenameFromContentDisposition(header) {
-	if (!header) return void 0;
-	const extended = header.match(/filename\*=(?:UTF-8'')?([^;]+)/i);
-	if (extended?.[1]) return decodeURIComponent(extended[1].trim().replace(/^"|"$/g, ""));
-	return header.match(/filename="?([^";]+)"?/i)?.[1]?.trim();
-}
-//#endregion
-export { isRecord as a, filenameFromContentDisposition as i, commitWebUrlBuilder as n, parseLinkNext as o, encodeRefPath as r, HttpClient as s, clampPerPage as t };
+export { filenameFromContentDisposition as a, encodeRefPath as i, clampPerPage as n, isRecord as o, commitWebUrlBuilder as r, parseLinkNext as s, HttpClient as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "repo-sdk",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Unified TypeScript SDK for git providers — GitHub, GitLab, Bitbucket, Azure DevOps, Gitea",
   "license": "MIT",
   "author": "Robin Genz <mail@robingenz.dev>",
@@ -76,8 +76,8 @@
     "test:watch": "vitest",
     "typecheck": "tsc --noEmit",
     "lint": "eslint .",
-    "format": "prettier --write .",
-    "format:check": "prettier --check .",
+    "fmt": "prettier --write .",
+    "fmt:check": "prettier --check .",
     "docs:dev": "blume dev",
     "docs:build": "blume build && rm -rf .blume-dist && cp -R dist .blume-dist",
     "docs:preview": "blume preview",