Offer an option to specify a cache for conditionally fetching public keys

index.d.ts

@@ -3,7 +3,7 @@ import { request } from "@octokit/request";
 // verification types
 
 type RequestInterface = typeof request;
-type VerificationKeysCache = {
+export type VerificationKeysCache = {
   id: string;
   keys: VerificationPublicKey[];
 };
@@ -25,7 +25,7 @@ interface VerifyRequestInterface {
 interface FetchVerificationKeysInterface {
   (
     requestOptions?: RequestOptions,
-  ): Promise<{ cacheId: string; keys: VerificationPublicKey[] }>;
+  ): Promise<VerificationKeysCache>;
 }
 
 interface VerifyRequest {

index.test-d.ts

@@ -22,6 +22,7 @@ import {
   prompt,
   PromptResult,
   getFunctionCalls,
+  VerificationKeysCache,
 } from "./index.js";
 
 const token = "";
@@ -76,7 +77,7 @@ export async function verifyRequestTest(
 
 export async function fetchVerificationKeysTest() {
   const result = await fetchVerificationKeys();
-  expectType<{ cacheId: string; keys: VerificationPublicKey[] }>(result);
+  expectType<VerificationKeysCache>(result);
 
   // accepts a token argument
   await fetchVerificationKeys({ token });

lib/verification.js

@@ -38,11 +38,11 @@ export async function fetchVerificationKeys(
   });
 
   if (response.status === 304) {
-    return { cacheId: cache.id, keys: cache.keys };
+    return cache;
   }
 
   const cacheId = response.headers.etag || "";
-  return { cacheId, keys: response.data.public_keys };
+  return { id: cacheId, keys: response.data.public_keys };
 }
 
 /** @type {import('..').VerifyRequestByKeyIdInterface} */
@@ -58,7 +58,7 @@ export async function verifyRequestByKeyId(
   assertValidString(keyId, "Invalid keyId");
 
   // receive valid public keys from GitHub
-  const { cacheId, keys } = await fetchVerificationKeys(requestOptions);
+  const { id, keys } = await fetchVerificationKeys(requestOptions);
 
   // verify provided key Id
   const publicKey = keys.find((key) => key.key_identifier === keyId);
@@ -77,7 +77,7 @@ export async function verifyRequestByKeyId(
   }
 
   const isValid = await verifyRequest(rawBody, signature, publicKey.key);
-  return { isValid, cache: { id: cacheId, keys } };
+  return { isValid, cache: { id: id, keys } };
 }
 
 function assertValidString(value, message) {

test/verification.test.js

@@ -183,7 +183,7 @@ test("fetchVerificationKeys() - without cache", async (t) => {
     request: testRequest,
   });
 
-  t.deepEqual(result, { cacheId: "", keys: publicKeys });
+  t.deepEqual(result, { id: "", keys: publicKeys });
 });
 
 // Up next: test the cache