feat: appId argument can be set to Client ID string

package.json

@@ -31,7 +31,7 @@
     "@octokit/request-error": "^6.1.1",
     "@octokit/types": "^13.4.1",
     "lru-cache": "^10.0.0",
-    "universal-github-app-jwt": "^2.0.6",
+    "universal-github-app-jwt": "^2.2.0",
     "universal-user-agent": "^7.0.0"
   },
   "devDependencies": {

src/get-app-authentication.ts

@@ -6,10 +6,12 @@ export async function getAppAuthentication({
   appId,
   privateKey,
   timeDifference,
-}: State & { timeDifference?: number }): Promise<AppAuthentication> {
+}: State & {
+  timeDifference?: number;
+}): Promise<AppAuthentication> {
   try {
     const appAuthentication = await githubAppJwt({
-      id: +appId,
+      id: appId,
       privateKey,
       now: timeDifference && Math.floor(Date.now() / 1000) + timeDifference,
     });

src/index.ts

@@ -31,11 +31,7 @@ export function createAppAuth(options: StrategyOptions): AuthInterface {
   if (!options.appId) {
     throw new Error("[@octokit/auth-app] appId option is required");
   }
-  if (!Number.isFinite(+options.appId)) {
-    throw new Error(
-      "[@octokit/auth-app] appId option must be a number or numeric string",
-    );
-  }
+
   if (!options.privateKey) {
     throw new Error("[@octokit/auth-app] privateKey option is required");
   }

src/types.ts

@@ -152,7 +152,7 @@ export type UTC_TIMESTAMP = string;
 export type AppAuthentication = {
   type: APP_TYPE;
   token: JWT;
-  appId: number;
+  appId: number | string;
   expiresAt: string;
 };
 

test/index.test.ts

@@ -2311,12 +2311,10 @@ it("throws helpful error if `appId` is not set (#184)", async () => {
 it("throws helpful error if `appId` is not set to a numeric value", async () => {
   expect(() => {
     createAppAuth({
-      appId: "not-a-number",
+      appId: "Iv1.0123456789abcdef",
       privateKey: PRIVATE_KEY,
     });
-  }).toThrowError(
-    "[@octokit/auth-app] appId option must be a number or numeric string",
-  );
+  }).not.toThrow();
 });
 
 it("throws helpful error if `privateKey` is not set properly (#184)", async () => {

test/typescript-validate.ts

@@ -2,7 +2,12 @@
 // THIS CODE IS NOT EXECUTED. IT IS JUST FOR TYPECHECKING
 // ************************************************************
 
+import { getAppAuthentication } from "../src/get-app-authentication.js";
+import { request } from "@octokit/request";
 import { createAppAuth } from "../src/index.js";
+import { State, StrategyOptions } from "../src/types.js";
+import { getCache } from "../src/cache.js";
+import { createOAuthAppAuth } from "@octokit/auth-oauth-app";
 function isString(what: string) {}
 
 export async function readmeExample() {
@@ -31,3 +36,40 @@ export async function issue282() {
 
   isString(authentication.token);
 }
+
+// https://github.com/octokit/auth-app.js/issues/603
+export async function issue603() {
+  createAppAuth({
+    appId: "Iv1.0123456789abcdef",
+    privateKey: "",
+  });
+
+  const options: StrategyOptions = {
+    appId: "Iv1.0123456789abcdef",
+    privateKey: "",
+  };
+
+  const state: State = Object.assign(
+    {
+      request,
+      cache: getCache(),
+    },
+    options,
+    options.installationId
+      ? { installationId: Number(options.installationId) }
+      : {},
+    {
+      log: {
+        warn: console.warn.bind(console),
+      },
+      oauthApp: createOAuthAppAuth({
+        clientType: "github-app",
+        clientId: options.clientId || "",
+        clientSecret: options.clientSecret || "",
+        request,
+      }),
+    },
+  );
+
+  getAppAuthentication(state);
+}