octokit-load-balancer 1.0.3 → 2.0.0

package/README.md

@@ -57,8 +57,6 @@ Every time you call `getApp(config)`:
 | `apps`    | `GitHubAppConfig[]` | Yes      | Array of app configurations |
 | `baseUrl` | `string`            | Yes      | GitHub API base URL         |
 
-App configs use `GitHubAppConfig` (re-exported from `@octokit/auth-app`'s `StrategyOptions`). All apps must have valid `appId` and `privateKey` — incomplete configs will throw an error.
-
 ## Scalability
 
 This library is designed for high-throughput scenarios where a single GitHub App's rate limit (5,000 requests/hour) isn't enough. By distributing requests across multiple apps, you get N × 5,000 requests/hour.

package/dist/index.d.mts

@@ -34,7 +34,6 @@ interface RateLimitInfo extends RateLimitData {
 
 /**
  * Get the Octokit instance with the most available rate limit.
- * Pass your app configurations directly - incomplete configs are filtered out.
  *
  * @example
  * ```typescript
@@ -59,7 +58,7 @@ interface RateLimitInfo extends RateLimitData {
  * await octokit.rest.repos.get({ owner: 'org', repo: 'repo' })
  * ```
  *
- * @throws {Error} When no valid app configurations are provided
+ * @throws {Error} When no apps are provided or all apps have exhausted their rate limits
  */
 declare function getApp(config: GitHubAppPoolConfig): Promise<Octokit>;
 

package/dist/index.d.ts

@@ -34,7 +34,6 @@ interface RateLimitInfo extends RateLimitData {
 
 /**
  * Get the Octokit instance with the most available rate limit.
- * Pass your app configurations directly - incomplete configs are filtered out.
  *
  * @example
  * ```typescript
@@ -59,7 +58,7 @@ interface RateLimitInfo extends RateLimitData {
  * await octokit.rest.repos.get({ owner: 'org', repo: 'repo' })
  * ```
  *
- * @throws {Error} When no valid app configurations are provided
+ * @throws {Error} When no apps are provided or all apps have exhausted their rate limits
  */
 declare function getApp(config: GitHubAppPoolConfig): Promise<Octokit>;
 

package/dist/index.js

@@ -29,20 +29,8 @@ var import_auth_app = require("@octokit/auth-app");
 var import_octokit = require("octokit");
 var DEBUG_KEY = "octokit-load-balancer";
 async function getApp(config) {
-  if (!Array.isArray(config?.apps)) {
-    throw new Error("Invalid config: apps must be an array");
-  }
-  if (typeof config?.baseUrl !== "string" || !config.baseUrl) {
-    throw new Error("Invalid config: baseUrl must be a non-empty string");
-  }
-  if (config.apps.length === 0) {
-    throw new Error("Invalid config: apps array is empty");
-  }
-  const invalidApps = config.apps.filter((app) => !isCompleteConfig(app));
-  if (invalidApps.length > 0) {
-    throw new Error(
-      `Invalid config: ${invalidApps.length} app(s) missing required appId or privateKey`
-    );
+  if (!config?.apps?.length) {
+    throw new Error("No apps provided");
   }
   log(`Using ${config.apps.length} app configs`);
   const octokits = config.apps.map((app) => createOctokit(app, config.baseUrl));
@@ -54,9 +42,9 @@ async function getApp(config) {
     rateLimits.map((r) => `app[${r.appIndex}]: ${r.remaining}/${r.limit}`).join(", ")
   );
   const { bestIndex, rateLimit } = rateLimits.reduce(
-    (acc, cur, i) => {
+    (acc, cur) => {
       if (cur.remaining > acc.rateLimit.remaining) {
-        return { bestIndex: i, rateLimit: cur };
+        return { bestIndex: cur.appIndex, rateLimit: cur };
       }
       return acc;
     },
@@ -70,9 +58,6 @@ async function getApp(config) {
   );
   return octokits[bestIndex];
 }
-function isCompleteConfig(config) {
-  return typeof config === "object" && config !== null && "appId" in config && "privateKey" in config && !!(config.appId && config.privateKey);
-}
 function decodePrivateKey(key) {
   if (key.startsWith("-----BEGIN ") && key.includes("-----END ")) {
     return key;
@@ -84,9 +69,9 @@ function createOctokit(appConfig, baseUrl) {
     authStrategy: import_auth_app.createAppAuth,
     baseUrl,
     auth: {
-      appId: appConfig.appId,
-      installationId: appConfig.installationId,
-      privateKey: decodePrivateKey(appConfig.privateKey)
+      ...appConfig,
+      // TODO: this type check can be removed once the issue will be fixed in @octokit/auth-app
+      privateKey: appConfig.privateKey && typeof appConfig.privateKey === "string" ? decodePrivateKey(appConfig.privateKey) : void 0
     }
   });
 }

package/dist/index.mjs

@@ -3,20 +3,8 @@ import { createAppAuth } from "@octokit/auth-app";
 import { Octokit } from "octokit";
 var DEBUG_KEY = "octokit-load-balancer";
 async function getApp(config) {
-  if (!Array.isArray(config?.apps)) {
-    throw new Error("Invalid config: apps must be an array");
-  }
-  if (typeof config?.baseUrl !== "string" || !config.baseUrl) {
-    throw new Error("Invalid config: baseUrl must be a non-empty string");
-  }
-  if (config.apps.length === 0) {
-    throw new Error("Invalid config: apps array is empty");
-  }
-  const invalidApps = config.apps.filter((app) => !isCompleteConfig(app));
-  if (invalidApps.length > 0) {
-    throw new Error(
-      `Invalid config: ${invalidApps.length} app(s) missing required appId or privateKey`
-    );
+  if (!config?.apps?.length) {
+    throw new Error("No apps provided");
   }
   log(`Using ${config.apps.length} app configs`);
   const octokits = config.apps.map((app) => createOctokit(app, config.baseUrl));
@@ -28,9 +16,9 @@ async function getApp(config) {
     rateLimits.map((r) => `app[${r.appIndex}]: ${r.remaining}/${r.limit}`).join(", ")
   );
   const { bestIndex, rateLimit } = rateLimits.reduce(
-    (acc, cur, i) => {
+    (acc, cur) => {
       if (cur.remaining > acc.rateLimit.remaining) {
-        return { bestIndex: i, rateLimit: cur };
+        return { bestIndex: cur.appIndex, rateLimit: cur };
       }
       return acc;
     },
@@ -44,9 +32,6 @@ async function getApp(config) {
   );
   return octokits[bestIndex];
 }
-function isCompleteConfig(config) {
-  return typeof config === "object" && config !== null && "appId" in config && "privateKey" in config && !!(config.appId && config.privateKey);
-}
 function decodePrivateKey(key) {
   if (key.startsWith("-----BEGIN ") && key.includes("-----END ")) {
     return key;
@@ -58,9 +43,9 @@ function createOctokit(appConfig, baseUrl) {
     authStrategy: createAppAuth,
     baseUrl,
     auth: {
-      appId: appConfig.appId,
-      installationId: appConfig.installationId,
-      privateKey: decodePrivateKey(appConfig.privateKey)
+      ...appConfig,
+      // TODO: this type check can be removed once the issue will be fixed in @octokit/auth-app
+      privateKey: appConfig.privateKey && typeof appConfig.privateKey === "string" ? decodePrivateKey(appConfig.privateKey) : void 0
     }
   });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "octokit-load-balancer",
-  "version": "1.0.3",
+  "version": "2.0.0",
   "description": "Load balance across multiple GitHub App instances, always picking the one with most available rate limit",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -44,11 +44,11 @@
     "url": "git+https://github.com/frankie303/octokit-load-balancer.git"
   },
   "peerDependencies": {
-    "@octokit/auth-app": "^7.0.0",
+    "@octokit/auth-app": "^8.0.0",
     "octokit": "^5.0.0"
   },
   "devDependencies": {
-    "@octokit/auth-app": "^7.2.2",
+    "@octokit/auth-app": "^8.1.2",
     "@types/node": "^20.19.28",
     "@vitest/coverage-v8": "^4.0.17",
     "octokit": "^5.0.5",