Rewrite to Typescript

Author: fdebijl

Makefile

@@ -3,7 +3,7 @@
 [![codecov](https://codecov.io/gh/feedbackfruits/passport-brightspace/branch/master/graph/badge.svg)](https://codecov.io/gh/feedbackfruits/passport-brightspace)
 
 > [!IMPORTANT]
-> Media now require yarn v4+, make sure to upgrade your local yarn by running `corepack enable`
+> This repo now requires yarn v4+, make sure to upgrade your local yarn by running `corepack enable`. You may also need to run `yarn install` to install the correct dependencies.
 
 [Passport](http://passportjs.org/) strategy for authenticating with [Brightspace](http://docs.valence.desire2learn.com/reference.html)
 using the OAuth 2.0 API.
@@ -16,9 +16,9 @@ unobtrusively integrated into any application or framework that supports
 
 ## Install
 ```sh
-npm install passport-brightspace
+npm install https://github.com/feedbackfruits/passport-brightspace
 # or
-yarn add passport-brightspace
+yarn add https://github.com/feedbackfruits/passport-brightspace
 ```
 
 ## Usage
@@ -54,21 +54,21 @@ For example, as route middleware in an [Express](http://expressjs.com/)
 application:
 
 ```js
-    app.get('/auth/brightspace',
-      passport.authenticate('brightspace', { }));
-
-    app.get('/auth/brightspace/callback',
-      passport.authenticate('brightspace', { failureRedirect: '/login' }),
-      function(req, res) {
-        // Successful authentication, redirect home.
-        res.redirect('/');
-      });
+app.get('/auth/brightspace',
+  passport.authenticate('brightspace', { }));
+
+app.get('/auth/brightspace/callback',
+  passport.authenticate('brightspace', { failureRedirect: '/login' }),
+  function(req, res) {
+    // Successful authentication, redirect home.
+    res.redirect('/');
+  });
 ```
 
 ## Tests
 
 ```sh
-yarn
+yarn install
 yarn test
 ```
 

README.md

@@ -0,0 +1,16 @@
+import fbfConfig from '@feedbackfruits/eslint-config';
+
+export default [
+  ...fbfConfig,
+  {
+    rules: {
+      'no-shadow': 0,
+      'import/named': 0,
+      'import/no-named-as-default': 0,
+      'import/no-named-as-default-member': 0,
+      '@typescript-eslint/no-empty-object-type': 0,
+      '@typescript-eslint/no-unused-vars': 0,
+      '@typescript-eslint/no-require-imports': 0
+    }
+  }
+];

eslint.config.mjs

@@ -1,10 +1,12 @@
 {
   "name": "passport-brightspace",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Brightspace authentication strategy for Passport.",
   "scripts": {
+    "build": "tsc",
     "test": "mocha 'test/*.test.js'",
-    "test:cov": "nyc mocha 'test/*.test.js'"
+    "test:cov": "nyc mocha 'test/*.test.js'",
+    "prepublish": "yarn build"
   },
   "keywords": [
     "passport",
@@ -26,15 +28,24 @@
     "url": "http://github.com/feedbackfruits/passport-brightspace/issues"
   },
   "license": "MIT",
-  "main": "./lib",
+  "main": "./dist",
   "dependencies": {
-    "passport-oauth2": "1.8.0",
-    "querystring": "0.2.1"
+    "passport-oauth2": "1.8.0"
   },
   "devDependencies": {
-    "chai": "4.5.0",
-    "mocha": "10.8.2",
-    "nyc": "17.1.0"
+    "@feedbackfruits/eslint-config": "2.0.1",
+    "@feedbackfruits/tsconfig": "1.0.2",
+    "@types/passport-oauth2": "1.4.17",
+    "@typescript-eslint/eslint-plugin": "8.34.1",
+    "@typescript-eslint/parser": "8.34.1",
+    "chai": "5.2.0",
+    "eslint": "9.29.0",
+    "eslint-plugin-import": "2.31.0",
+    "mocha": "11.7.0",
+    "nyc": "17.1.0",
+    "passport": "^0.7.0",
+    "sinon": "^21.0.0",
+    "typescript": "5.8.3"
   },
   "engines": {
     "node": "20.*"

lib/index.js

@@ -0,0 +1,3 @@
+import Strategy from './strategy';
+
+export default Strategy;