Output both CJS & ESM

.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2.1
 orbs:
   ship: auth0/[email protected]
   codecov: codecov/codecov@3
-  
+
 jobs:
   build:
     parameters:
@@ -15,22 +15,30 @@ jobs:
       LANG: en_US.UTF-8
     steps:
       - checkout
-      
+
       - ship/node-install-packages
-      
+
       - run:
           name: Run Linter
           command: npm run lint
-          
+
       - run:
           name: Run Tests
           command: npm run test:ci
-
+
+      - run:
+          name: Check source typings
+          command: npm run types:check
+
+      - run:
+          name: Check built typings
+          command: npm run build:check
+
       - store_artifacts:
           path: ./coverage/<< parameters.node-version >>/lcov-report
-          
+
       - codecov/upload
-      
+
 workflows:
   build-and-test:
     jobs:

.eslintignore

@@ -0,0 +1,4 @@
+*.ts
+
+# Build output
+dist

.eslintrc

@@ -1,6 +1,7 @@
 {
   "parserOptions": {
-    "ecmaVersion": 2018
+    "ecmaVersion": 2018,
+    "sourceType": "module"
   },
   "rules": {
     "array-bracket-spacing": [2, "always"],

.github/workflows/test.yml

@@ -107,3 +107,26 @@ jobs:
           key: 18-${{ env.CACHE_KEY }}
 
       - run: npm run lint
+
+  types:
+    needs: build # Require build to complete before running tests
+
+    name: Check source and built types
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: npm
+
+      - uses: actions/cache/restore@v3
+        with:
+          path: .
+          key: 18-${{ env.CACHE_KEY }}
+
+      - run: npm run types:check
+
+      - run: npm run build:check

.gitignore

@@ -36,6 +36,7 @@ node_modules
 .node_repl_history
 
 # Build output
+dist
 lib
 !src/lib
 ts-output

README.md

@@ -19,35 +19,35 @@
 
 Using [npm](https://npmjs.org) in your project directory run the following command:
 
-````bash
+```bash
 npm install --save jwks-rsa
-````
+```
 
 Supports all currently registered JWK types and JWS Algorithms, see [panva/jose#262](https://github.com/panva/jose/issues/262) for more information.
 
 ### Configure the client
 
 Provide a JWKS endpoint which exposes your signing keys.
 
-````js
-const jwksClient = require('jwks-rsa');
+```js
+const { JwksClient } = require('jwks-rsa');
 
-const client = jwksClient({
+const client = new JwksClient({
   jwksUri: 'https://sandrino.auth0.com/.well-known/jwks.json',
   requestHeaders: {}, // Optional
   timeout: 30000 // Defaults to 30s
 });
-````
+```
 
 ### Retrieve a key
 
 Then use `getSigningKey` to retrieve a signing key that matches a specific `kid`.
 
-````js
+```js
 const kid = 'RkI5MjI5OUY5ODc1N0Q4QzM0OUYzNkVGMTJDOUEzQkFCOTU3NjE2Rg';
 const key = await client.getSigningKey(kid);
 const signingKey = key.getPublicKey();
-````
+```
 
 ## Feedback