Merge pull request #251 from auth0/typefix-getKeysInterceptor

[SDK-2626] getKeysInterceptor types
auth0 · Jul 15, 2021 · bd315cf · bd315cf
2 parents 034a5b5 + 45575a6
commit bd315cf
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 1 deletion.
diff --git a/index.d.ts b/index.d.ts
@@ -30,7 +30,13 @@ declare namespace JwksRsa {
     timeout?: number;
     requestAgent?: HttpAgent | HttpsAgent;
     fetcher?(jwksUri: string): Promise<{ keys: any }>;
-    getKeysInterceptor?(): Promise<SigningKey[]>;
+    getKeysInterceptor?(): Promise<JSONWebKey[]>;
+  }
+
+  interface JSONWebKey {
+    kid: string,
+    alg: string,
+    [key: string]: any
   }
 
   interface CertSigningKey {

diff --git a/tests/ts-definitions.tests.ts b/tests/ts-definitions.tests.ts
@@ -23,4 +23,25 @@ describe('typescript definition', () => {
       expect(key).to.contain('-----BEGIN PUBLIC KEY');
     });
   });
+
+  describe('getKeysInterceptor', async () => {
+    const keySetResponse = {
+      keys: [
+        {
+          alg: 'RS256',
+          kty: 'RSA',
+          use: 'sig',
+          kid: 'NkFCNEE1NDFDNTQ5RTQ5OTE1QzRBMjYyMzY0NEJCQTJBMjJBQkZCMA'
+        }
+      ]
+    };
+
+    const client = new jwksRsa.JwksClient({
+      jwksUri: `${jwksHost}/.well-known/jwks.json`,
+      getKeysInterceptor: () => Promise.resolve(keySetResponse.keys)
+    });
+
+    const key = await client.getSigningKey('NkFCNEE1NDFDNTQ5RTQ5OTE1QzRBMjYyMzY0NEJCQTJBMjJBQkZCMA');
+    expect(key.kid).to.equal('NkFCNEE1NDFDNTQ5RTQ5OTE1QzRBMjYyMzY0NEJCQTJBMjJBQkZCMA');
+  });
 });