feat(chore): implement yandex configuration in preset (#228)

Author: artem-malko

README.md

@@ -91,6 +91,7 @@ You can choose some default setup to assign to `auth` option.
 - `VATSIM_CONFIGURATION`
 - `VATSIM_DEV_CONFIGURATION`
 - `EPIC_GAMES_CONFIGURATION`
+- `YANDEX_CONFIGURATION`
 
 ### Custom configuration
 
@@ -303,7 +304,7 @@ declare module 'fastify' {
 
 ## Provider Quirks
 
-The following providers require additional work to be set up correctly.   
+The following providers require additional work to be set up correctly.
 
 ### Twitch
 

examples/yandex.js

@@ -0,0 +1,35 @@
+'use strict'
+
+const fastify = require('fastify')({ logger: { level: 'trace' } })
+
+// const oauthPlugin = require('fastify-oauth2')
+const oauthPlugin = require('..')
+
+fastify.register(oauthPlugin, {
+  name: 'yandexOAuth2',
+  scope: ['login:email'],
+  credentials: {
+    client: {
+      id: process.env.CLIENT_ID,
+      secret: process.env.CLIENT_SECRET
+    },
+    auth: oauthPlugin.YANDEX_CONFIGURATION
+  },
+  startRedirectPath: '/login/yandex',
+  callbackUri: `http://localhost:${process.env.PORT}/login/yandex/callback`
+})
+
+fastify.get('/login/yandex/callback', async (req, reply) => {
+  const token = await fastify.yandexOAuth2.getAccessTokenFromAuthorizationCodeFlow(req)
+
+  console.log(token)
+  reply.send({ access_token: token.access_token })
+})
+
+fastify.listen(process.env.PORT, (err, address) => {
+  if (err) {
+    fastify.log.error(err)
+    process.exit(1)
+  }
+  fastify.log.info(`server listening on ${address}`)
+})

index.js

@@ -325,6 +325,17 @@ fastifyOauth2.EPIC_GAMES_CONFIGURATION = {
   tokenPath: '/epic/oauth/v1/token'
 }
 
+/**
+ * Yandex ID docs https://yandex.ru/dev/id/doc/en/
+ */
+fastifyOauth2.YANDEX_CONFIGURATION = {
+  authorizeHost: 'https://oauth.yandex.com',
+  authorizePath: '/authorize',
+  tokenHost: 'https://oauth.yandex.com',
+  tokenPath: '/token',
+  revokePath: '/revoke_token'
+}
+
 module.exports = fp(fastifyOauth2, {
   fastify: '4.x',
   name: '@fastify/oauth2'

test/index.test.js

@@ -800,7 +800,7 @@ t.test('preset configuration generate-callback-uri-params', t => {
 })
 
 t.test('preset configuration generate-callback-uri-params', t => {
-  t.plan(52)
+  t.plan(56)
 
   const presetConfigs = [
     'FACEBOOK_CONFIGURATION',
@@ -815,7 +815,8 @@ t.test('preset configuration generate-callback-uri-params', t => {
     'TWITCH_CONFIGURATION',
     'VATSIM_CONFIGURATION',
     'VATSIM_DEV_CONFIGURATION',
-    'EPIC_GAMES_CONFIGURATION'
+    'EPIC_GAMES_CONFIGURATION',
+    'YANDEX_CONFIGURATION'
   ]
 
   for (const configName of presetConfigs) {

types/index.d.ts

@@ -16,6 +16,7 @@ interface FastifyOauth2 extends FastifyPluginCallback<fastifyOauth2.FastifyOAuth
     VATSIM_CONFIGURATION: fastifyOauth2.ProviderConfiguration;
     VATSIM_DEV_CONFIGURATION: fastifyOauth2.ProviderConfiguration;
     EPIC_GAMES_CONFIGURATION: fastifyOauth2.ProviderConfiguration;
+    YANDEX_CONFIGURATION: fastifyOauth2.ProviderConfiguration;
 }
 
 declare namespace fastifyOauth2 {

types/index.test-d.ts

@@ -101,6 +101,7 @@ expectAssignable<ProviderConfiguration>(fastifyOauth2.TWITCH_CONFIGURATION);
 expectAssignable<ProviderConfiguration>(fastifyOauth2.VATSIM_CONFIGURATION);
 expectAssignable<ProviderConfiguration>(fastifyOauth2.VATSIM_DEV_CONFIGURATION);
 expectAssignable<ProviderConfiguration>(fastifyOauth2.EPIC_GAMES_CONFIGURATION);
+expectAssignable<ProviderConfiguration>(fastifyOauth2.YANDEX_CONFIGURATION);
 
 server.get('/testOauth/callback', async (request, reply) => {
     expectType<OAuth2Namespace>(server.testOAuthName);