fix: update types, tests, examples and harmonize repository structure (#132)

* types: use `FastifyPluginCallback` instead of the deprecated `FastifyPlugin`

* refactor: remove unused imports

* fix (tests): use tap `teardown()` instead of the deprecated `tearDown()`

* chore: upgrade package dependencies

* chore: harmonize repository structure

* fix (examples): make use of the current plugin

* chore: add `.taprc` configuration file

* fix: update test script

Co-authored-by: KaKa <[email protected]>

Co-authored-by: KaKa <[email protected]>

Author: darkgl0w

.taprc

@@ -0,0 +1,6 @@
+100: true
+ts: false
+jsx: false
+flow: false
+coverage: true
+check-coverage: true

examples/apple.js

@@ -10,6 +10,7 @@
 const fastify = require('fastify')({ logger: { level: 'trace' } })
 const appleSignin = require('apple-signin')
 
+// const oauthPlugin = require('fastify-oauth2')
 const oauthPlugin = require('..')
 
 const CLIENT_ID = '<CLIENT_ID>'

examples/facebook.js

@@ -3,7 +3,8 @@
 const fastify = require('fastify')({ logger: { level: 'trace' } })
 const sget = require('simple-get')
 
-const oauthPlugin = require('../')
+// const oauthPlugin = require('fastify-oauth2')
+const oauthPlugin = require('..')
 
 fastify.register(oauthPlugin, {
   name: 'facebookOAuth2',

examples/google.js

@@ -3,6 +3,7 @@
 const fastify = require('fastify')({ logger: { level: 'trace' } })
 const sget = require('simple-get')
 
+// const oauthPlugin = require('fastify-oauth2')
 const oauthPlugin = require('..')
 
 fastify.register(oauthPlugin, {

examples/spotify.js

@@ -1,5 +1,7 @@
 const fastify = require('fastify')({ logger: true })
-const oauthPlugin = require('fastify-oauth2')
+
+// const oauthPlugin = require('fastify-oauth2')
+const oauthPlugin = require('..')
 
 fastify.register(oauthPlugin, {
   name: 'Spotify',

examples/vkontakte.js

@@ -1,5 +1,7 @@
 const fastify = require('fastify')({ logger: { level: 'trace' } })
-const oauthPlugin = require('fastify-oauth2')
+
+// const oauthPlugin = require('fastify-oauth2')
+const oauthPlugin = require('..')
 
 fastify.register(oauthPlugin, {
   name: 'vkOAuth2',

index.d.ts

@@ -1,4 +1,4 @@
-import { FastifyPlugin, FastifyRequest } from 'fastify';
+import { FastifyPluginCallback, FastifyRequest } from 'fastify';
 
 interface FastifyOAuth2 {
   APPLE_CONFIGURATION: ProviderConfiguration;
@@ -13,7 +13,7 @@ interface FastifyOAuth2 {
   TWITCH_CONFIGURATION: ProviderConfiguration;
 }
 
-export const fastifyOauth2: FastifyPlugin<FastifyOAuth2Options> & FastifyOAuth2
+export const fastifyOauth2: FastifyPluginCallback<FastifyOAuth2Options> & FastifyOAuth2
 
 export interface FastifyOAuth2Options {
   name: string;

package.json

@@ -3,12 +3,13 @@
   "version": "4.4.0",
   "description": "Perform login using oauth2 protocol",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "coverage": "npm run unit -- --cov --coverage-report=html",
     "lint": "standard | snazzy",
     "test": "npm run lint && npm run unit && npm run test:typescript",
     "test:typescript": "tsd",
-    "unit": "tap test.js"
+    "unit": "tap -J \"test/*.test.js\""
   },
   "repository": {
     "type": "git",
@@ -25,18 +26,21 @@
   ],
   "homepage": "https://github.com/fastify/fastify-oauth2#readme",
   "devDependencies": {
-    "@types/node": "^17.0.0",
-    "fastify": "^3.0.3",
-    "nock": "^13.0.0",
+    "@types/node": "^17.0.8",
+    "fastify": "^3.25.3",
+    "nock": "^13.2.1",
     "pre-commit": "^1.2.2",
     "simple-get": "^4.0.0",
     "snazzy": "^9.0.0",
-    "standard": "^16.0.0",
-    "tap": "^15.0.0",
-    "tsd": "^0.19.0"
+    "standard": "^16.0.4",
+    "tap": "^15.1.6",
+    "tsd": "^0.19.1"
   },
   "dependencies": {
     "fastify-plugin": "^3.0.0",
     "simple-oauth2": "^3.4.0"
+  },
+  "tsd": {
+    "directory": "test/types"
   }
 }

test.js renamed to test/plugin.test.js

@@ -4,7 +4,7 @@ const t = require('tap')
 const nock = require('nock')
 const createFastify = require('fastify')
 
-const oauthPlugin = require('./index')
+const oauthPlugin = require('..')
 
 nock.disableNetConnect()
 
@@ -107,7 +107,7 @@ t.test('fastify-oauth2', t => {
       })
     })
 
-    t.tearDown(fastify.close.bind(fastify))
+    t.teardown(fastify.close.bind(fastify))
 
     makeRequests(t, fastify)
   })
@@ -145,7 +145,7 @@ t.test('fastify-oauth2', t => {
         })
     })
 
-    t.tearDown(fastify.close.bind(fastify))
+    t.teardown(fastify.close.bind(fastify))
 
     makeRequests(t, fastify)
   })
@@ -174,7 +174,7 @@ t.test('fastify-oauth2', t => {
         })
     })
 
-    t.tearDown(fastify.close.bind(fastify))
+    t.teardown(fastify.close.bind(fastify))
 
     fastify.inject({
       method: 'GET',
@@ -278,7 +278,7 @@ t.test('options.callbackUriParams', t => {
     scope: ['notifications']
   })
 
-  t.tearDown(fastify.close.bind(fastify))
+  t.teardown(fastify.close.bind(fastify))
 
   fastify.listen(0, function (err) {
     t.error(err)
@@ -320,7 +320,7 @@ t.test('options.generateStateFunction with request', t => {
     scope: ['notifications']
   })
 
-  t.tearDown(fastify.close.bind(fastify))
+  t.teardown(fastify.close.bind(fastify))
 
   fastify.listen(0, function (err) {
     t.error(err)
@@ -365,7 +365,7 @@ t.test('generateAuthorizationUri redirect with request object', t => {
     return reply.redirect(redirectUrl)
   })
 
-  t.tearDown(fastify.close.bind(fastify))
+  t.teardown(fastify.close.bind(fastify))
 
   fastify.inject({
     method: 'GET',
@@ -586,7 +586,7 @@ t.test('preset configuration generate-callback-uri-params', t => {
       scope: ['email']
     })
 
-    t.tearDown(fastify.close.bind(fastify))
+    t.teardown(fastify.close.bind(fastify))
 
     fastify.listen(0, function (err) {
       t.error(err)
@@ -622,7 +622,7 @@ t.test('preset configuration generate-callback-uri-params', t => {
       scope: 'name'
     })
 
-    t.tearDown(fastify.close.bind(fastify))
+    t.teardown(fastify.close.bind(fastify))
 
     fastify.listen(0, function (err) {
       t.error(err)
@@ -658,7 +658,7 @@ t.test('preset configuration generate-callback-uri-params', t => {
       scope: ''
     })
 
-    t.tearDown(fastify.close.bind(fastify))
+    t.teardown(fastify.close.bind(fastify))
 
     fastify.listen(0, function (err) {
       t.error(err)

index.test-d.ts renamed to test/types/index.test-d.ts

@@ -1,7 +1,6 @@
-import fastify, { FastifyInstance } from 'fastify';
-import fastifyOauth2, { OAuth2Namespace, ProviderConfiguration, Credentials, OAuth2Token } from '.';
-import { expectType, expectError, expectAssignable } from 'tsd';
-import { Server, IncomingMessage, ServerResponse } from 'http';
+import fastify from 'fastify';
+import { expectAssignable, expectError, expectType } from 'tsd';
+import fastifyOauth2, { Credentials, OAuth2Namespace, OAuth2Token, ProviderConfiguration } from '../..';
 
 /**
  * Preparing some data for testing.