session-sync-auth-site 3.0.5 → 4.0.1

package/README.md

@@ -9,11 +9,11 @@ You may add on more fields to the user and session tables, if you like.
 # Simple backend usage
 
 ```js
-const express = require('express')
-const app = express()
-const cors = require('cors')
-const bodyParser = require('body-parser')
+import express from 'express'
+import cors from 'cors'
+import bodyParser from 'body-parser'
 
+const app = express()
 const { authenticate, setUpSessionSyncAuthRoutes } = require('session-sync-auth-site')
 
 app.use(cors())
@@ -33,7 +33,8 @@ app.use(authenticate({
 setUpSessionSyncAuthRoutes({
   app,
   siteId,
-  authDomain,
+  authFrontendBaseUrl,
+  authBackendBaseUrl,
   jwtSecret,
 })
 ```
@@ -75,13 +76,15 @@ app.use(authenticate({
 setUpSessionSyncAuthRoutes({
   app,  // required
   siteId,  // required (unless getSetupInfo provided)
-  authDomain,  // required (unless getSetupInfo provided)
+  authFrontendBaseUrl,  // required (unless getSetupInfo provided)
+  authBackendBaseUrl,  // required (unless getSetupInfo provided)
   jwtSecret,  // required (unless getSetupInfo provided)
   getSetupInfo: req => {  // useful for multi-tenancy setups
     // fetch the needed values based upon req
     return {
       siteId,
-      authDomain,
+      authFrontendBaseUrl,
+      authBackendBaseUrl,
       jwtSecret,
       extraUserTableValues,  // optional
       // Note: In a multi-tenancy setup, `extraUserTableValues` should
@@ -94,7 +97,6 @@ setUpSessionSyncAuthRoutes({
   deleteUser: async ({ id, req }) => {  // optional (when absent, the appropriate rows from users and sessions are deleted)
     // delete all of user's data, including appropriate rows from users and sessions tables
   },
-  protocol: 'https',
   paths: {
     getUser: '/get-user',
     logIn: '/log-in',

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "session-sync-auth-site",
-  "version": "3.0.5",
+  "version": "4.0.1",
   "main": "src/index.js",
+  "module": "src/index.js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/educational-resources-and-services/session-sync-auth-site.git"
@@ -13,8 +14,9 @@
   },
   "homepage": "https://github.com/educational-resources-and-services/session-sync-auth-site#readme",
   "engines": {
-    "node": ">=10"
+    "node": ">=20"
   },
+  "type": "module",
   "scripts": {
     "dev": "npm run go-dev -s",
     "go-dev": "concurrently -k 'node ./test/dummySite.js 3001' 'node ./test/dummySite.js 3002 dummy1' 'node ./test/dummySite.js 3003 dummy2'",

package/src/authenticate.js

@@ -1,4 +1,4 @@
-const setUpConnection = require('./setUpConnection')
+import setUpConnection from './setUpConnection.js'
 
 const authenticate = ({
   userTableName='users',
@@ -80,7 +80,7 @@ const authenticate = ({
         ...extraUserTableSelectValues,
         accessToken,
       },
-    ))[0]
+    ))[0][0]
 
     // Convert DateTime columns into ms timestamp
     const dateTimeCols = [
@@ -98,4 +98,4 @@ const authenticate = ({
   }
 )
 
-module.exports = authenticate
+export default authenticate

package/src/createDBTables.js

@@ -1,4 +1,4 @@
-const setUpConnection = require('./setUpConnection')
+import setUpConnection from './setUpConnection.js'
 
 ;(async () => {
 

package/src/createUser.js

@@ -1,21 +1,19 @@
-const fetch = require('node-fetch')
-const jwt = require('jsonwebtoken')
+import jwt from 'jsonwebtoken'
 
 const createUser = async ({
   email,
   req,  // either this or `setup` is required
-  setup,  // keys: siteId, authDomain, and jwtSecret
+  setup,  // keys: siteId, authBackendBaseUrl, and jwtSecret
 }={}) => {
 
   const {
     siteId,
-    authDomain,
+    authBackendBaseUrl,
     jwtSecret,
-    protocol=(setup || req).sessionSyncAuthProtocol || `https`,
   } = setup || await req.getSessionSyncAuthSetupInfo()
 
   const createUserResult = await fetch(
-    `${protocol}://${authDomain}/api/create-user`,
+    `${authBackendBaseUrl}/createUser`,
     {
       method: 'post',
       body: JSON.stringify({
@@ -41,4 +39,4 @@ const createUser = async ({
 
 }
 
-module.exports = createUser
+export default createUser

package/src/deleteUser.js

@@ -1,22 +1,20 @@
-const fetch = require('node-fetch')
-const jwt = require('jsonwebtoken')
+import jwt from 'jsonwebtoken'
 
 const deleteUser = async ({
   id,
   mergeToUserId,
   req,  // either this or `setup` is required
-  setup,  // keys: siteId, authDomain, and jwtSecret
+  setup,  // keys: siteId, authBackendBaseUrl, and jwtSecret
 }={}) => {
 
   const {
     siteId,
-    authDomain,
+    authBackendBaseUrl,
     jwtSecret,
-    protocol=req.sessionSyncAuthProtocol || `https`,
   } = setup || await req.getSessionSyncAuthSetupInfo()
 
   const deleteUserResult = await fetch(
-    `${protocol}://${authDomain}/api/delete-user`,
+    `${authBackendBaseUrl}/deleteUser`,
     {
       method: 'post',
       body: JSON.stringify({
@@ -40,4 +38,4 @@ const deleteUser = async ({
 
 }
 
-module.exports = deleteUser
+export default deleteUser

package/src/getLoginLink.js

@@ -1,12 +1,11 @@
-const fetch = require('node-fetch')
-const jwt = require('jsonwebtoken')
+import jwt from 'jsonwebtoken'
 
 const getLoginLink = async ({
   email,
   redirectUrl,  // defaults to req.headers.origin
   origin,  // defaults to `${req.protocol}://${req.headers.host}`
   req,  // either this or `setup` is required
-  setup,  // keys: siteId, authDomain, and jwtSecret
+  setup,  // keys: siteId, authBackendBaseUrl, and jwtSecret
 }={}) => {
 
   redirectUrl = redirectUrl || req.headers.origin
@@ -14,15 +13,14 @@ const getLoginLink = async ({
 
   const {
     siteId,
-    authDomain,
+    authBackendBaseUrl,
     jwtSecret,
-    protocol=req.sessionSyncAuthProtocol || `https`,
   } = setup || await req.getSessionSyncAuthSetupInfo()
 
   const loggedInRedirectUrl = `${redirectUrl}${/\?/.test(redirectUrl) ? `&` : `?`}action=successfulLogin&origin=${encodeURIComponent(origin)}&accessToken=ACCESS_TOKEN`
 
   const getLoginLinkResult = await fetch(
-    `${protocol}://${authDomain}/api/get-login-link`,
+    `${authBackendBaseUrl}/getLoginLink`,
     {
       method: 'post',
       body: JSON.stringify({
@@ -47,4 +45,4 @@ const getLoginLink = async ({
 
 }
 
-module.exports = getLoginLink
+export default getLoginLink

package/src/index.js

@@ -1,15 +1,6 @@
-const authenticate = require('./authenticate')
-const setUpSessionSyncAuthRoutes = require('./setUpSessionSyncAuthRoutes')
-const createUser = require('./createUser')
-const updateUserAccount = require('./updateUserAccount')
-const deleteUser = require('./deleteUser')
-const getLoginLink = require('./getLoginLink')
-
-module.exports = {
-  authenticate,
-  setUpSessionSyncAuthRoutes,
-  createUser,
-  updateUserAccount,
-  deleteUser,
-  getLoginLink,
-}
+export { default as authenticate } from './authenticate.js'
+export { default as setUpSessionSyncAuthRoutes } from './setUpSessionSyncAuthRoutes.js'
+export { default as createUser } from './createUser.js'
+export { default as updateUserAccount } from './updateUserAccount.js'
+export { default as deleteUser } from './deleteUser.js'
+export { default as getLoginLink } from './getLoginLink.js'

package/src/iso639-3To1.js

@@ -187,4 +187,4 @@ const iso6393To1 = {
   zul: 'zu'
 }
 
-module.exports = iso6393To1
+export default iso6393To1

package/src/sessionSyncAuthFrontend.js

@@ -1,5 +1,7 @@
 ;(() => {
 
+  if(typeof window === 'undefined') return
+
   let enableSSR = false
   let defaultOrigin
   const setDefaultOrigin = origin => {
@@ -68,7 +70,7 @@
     const cancelRedirectUrl = `${addOnQueryStrConnectorChar(cancelRedirectHref)}action=canceledAccountUpdate&origin=${encodeURIComponent(origin)}${getQueryStringAddOn(extraQueryParamsForCallbacks)}`
     const updatedRedirectUrl = `${addOnQueryStrConnectorChar(updatedRedirectHref)}action=successfulAccountUpdate&origin=${encodeURIComponent(origin)}${getQueryStringAddOn(extraQueryParamsForCallbacks)}`
 
-    const queryString = `cancelRedirectUrl=${encodeURIComponent(cancelRedirectUrl)}&updatedRedirectUrl=${encodeURIComponent(updatedRedirectUrl)}`
+    const queryString = `cancelRedirectUrl=${encodeURIComponent(cancelRedirectUrl)}&updatedRedirectUrl=${encodeURIComponent(updatedRedirectUrl)}&accessToken=${encodeURIComponent(getAccessToken({ origin }))}`
 
     window.location = `${origin}/update-account?${queryString}`
   }
@@ -76,7 +78,7 @@
   const getUser = async ({ origin=defaultOrigin }={}) => {
     const response = await fetch(`${origin}/get-user`, {
       headers: {
-        'x-access-token': getAccessToken(origin),
+        'x-access-token': getAccessToken({ origin }),
       },
     })
 
@@ -86,7 +88,7 @@
   const logOut = async ({ origin=defaultOrigin, extraQueryParamsForCallbacks }={}) => {
     const redirectUrl = `${location.href.replace(/\?.*$/, '')}?action=successfulLogout&origin=${encodeURIComponent(origin)}${getQueryStringAddOn(extraQueryParamsForCallbacks)}`
     const noLoginRedirectUrl = `${location.href.replace(/\?.*$/, '')}?action=unnecessaryLogout&origin=${encodeURIComponent(origin)}${getQueryStringAddOn(extraQueryParamsForCallbacks)}`
-    const accessToken = getAccessToken(origin)
+    const accessToken = getAccessToken({ origin })
 
     const queryString = `redirectUrl=${encodeURIComponent(redirectUrl)}&noLoginRedirectUrl=${encodeURIComponent(noLoginRedirectUrl)}&accessToken=${encodeURIComponent(accessToken)}`
 

package/src/setUpConnection.js

@@ -1,5 +1,5 @@
-const mysql = require('mysql2/promise')
-const { ConnectionString } = require('connection-string')
+import mysql from 'mysql2/promise'
+import { ConnectionString } from 'connection-string'
 
 const setUpConnection = async ({
   connectionStr=`mysql://root@localhost/SessionSyncAuthSite`,
@@ -39,4 +39,4 @@ const setUpConnection = async ({
 
 }
 
-module.exports = setUpConnection
+export default setUpConnection

package/src/setUpSessionSyncAuthRoutes.js

@@ -1,16 +1,16 @@
-const jwt = require('jsonwebtoken')
+import jwt from 'jsonwebtoken'
 
-const iso6393To1 = require('./iso639-3To1')
+import iso6393To1 from './iso639-3To1.js'
 
 const setUpSessionSyncAuthRoutes = ({
   app,
   siteId,
-  authDomain,
+  authFrontendBaseUrl,
+  authBackendBaseUrl,
   jwtSecret,
-  getSetupInfo,  // for multi-tenancy setup; sent req and must return the siteId, authDomain, and jwtSecret
+  getSetupInfo,  // for multi-tenancy setup; sent req and must return the siteId, authFrontendBaseUrl, authBackendBaseUrl, and jwtSecret
   mergeUser,
   deleteUser,
-  protocol='https',
   paths: {
     getUser='/get-user',
     logIn='/log-in',
@@ -21,11 +21,10 @@ const setUpSessionSyncAuthRoutes = ({
   languageColType='639-3',  // OPTIONS: '639-1', '639-3', 'IETF'
 }) => {
 
-  getSetupInfo = getSetupInfo || (async () => ({ siteId, jwtSecret, authDomain }))
+  getSetupInfo = getSetupInfo || (async () => ({ siteId, jwtSecret, authFrontendBaseUrl, authBackendBaseUrl }))
 
   app.use((req, res, next) => {
     req.getSessionSyncAuthSetupInfo = () => getSetupInfo(req)
-    req.sessionSyncAuthProtocol = protocol
     next()
   })
 
@@ -38,7 +37,7 @@ const setUpSessionSyncAuthRoutes = ({
 
   app.get(logIn, async (req, res, next) => {
     const { loggedInRedirectUrl, cancelRedirectUrl } = req.query
-    const { siteId, jwtSecret, authDomain } = await getSetupInfo(req)
+    const { siteId, jwtSecret, authFrontendBaseUrl } = await getSetupInfo(req)
 
     const jwtData = jwt.sign(
       {
@@ -48,27 +47,37 @@ const setUpSessionSyncAuthRoutes = ({
       jwtSecret,
     )
 
-    res.redirect(`${protocol}://${authDomain}/login?siteId=${encodeURIComponent(siteId)}&jwtData=${encodeURIComponent(jwtData)}`)
+    res.redirect(`${authFrontendBaseUrl}/log-in?siteId=${encodeURIComponent(siteId)}&jwtData=${encodeURIComponent(jwtData)}`)
   })
 
   app.get(updateAccount, async (req, res, next) => {
     const { updatedRedirectUrl, cancelRedirectUrl } = req.query
-    const { siteId, jwtSecret, authDomain } = await getSetupInfo(req)
+    const { siteId, jwtSecret, authFrontendBaseUrl } = await getSetupInfo(req)
+
+    if(!req.user) {
+      console.warn(`updateAccount attemped with no login`)
+      return res.redirect(cancelRedirectUrl)
+    }
+
+    const {
+      userTableColNameMap,
+    } = req.sessionSyncAuthSiteOptions
 
     const jwtData = jwt.sign(
       {
+        groupUserId: req.user[userTableColNameMap.id || `id`],
         cancelRedirectUrl,
         updatedRedirectUrl,
       },
       jwtSecret,
     )
 
-    res.redirect(`${protocol}://${authDomain}/account?siteId=${encodeURIComponent(siteId)}&jwtData=${encodeURIComponent(jwtData)}`)
+    res.redirect(`${authFrontendBaseUrl}/user-account?siteId=${encodeURIComponent(siteId)}&jwtData=${encodeURIComponent(jwtData)}`)
   })
 
   app.get(logOut, async (req, res, next) => {
     const { redirectUrl, noLoginRedirectUrl } = req.query
-    const { siteId, jwtSecret, authDomain } = await getSetupInfo(req)
+    const { siteId, jwtSecret, authFrontendBaseUrl } = await getSetupInfo(req)
 
     if(!req.user) {
       console.warn(`logout attemped with no login`)
@@ -87,7 +96,7 @@ const setUpSessionSyncAuthRoutes = ({
       jwtSecret,
     )
 
-    res.redirect(`${protocol}://${authDomain}/logout?siteId=${encodeURIComponent(siteId)}&jwtData=${encodeURIComponent(jwtData)}`)
+    res.redirect(`${authFrontendBaseUrl}/log-out?siteId=${encodeURIComponent(siteId)}&jwtData=${encodeURIComponent(jwtData)}`)
   })
 
   app.post(authSync, async (req, res, next) => {
@@ -244,7 +253,7 @@ const setUpSessionSyncAuthRoutes = ({
           if(!id) throw "Invalid payload. Item in `payload.usersToDelete` missing `id` key."
           if(!email) throw "Invalid payload. Item in `payload.usersToDelete` missing `email` key."
 
-          const [ userRow ] = await global.sessionSyncAuthSiteConnection.query(
+          const [[ userRow ]] = await global.sessionSyncAuthSiteConnection.query(
             `
               SELECT \`${(userTableColNameMap.email || `email`).replace(/`/g, '')}\` AS email
               FROM \`${userTableName}\`
@@ -299,4 +308,4 @@ const setUpSessionSyncAuthRoutes = ({
 
 }
 
-module.exports = setUpSessionSyncAuthRoutes
+export default setUpSessionSyncAuthRoutes

package/src/updateUserAccount.js

@@ -1,22 +1,20 @@
-const fetch = require('node-fetch')
-const jwt = require('jsonwebtoken')
+import jwt from 'jsonwebtoken'
 
 const updateUserAccount = async ({
   userId,
   data,
   req,  // either this or `setup` is required
-  setup,  // keys: siteId, authDomain, and jwtSecret
+  setup,  // keys: siteId, authBackendBaseUrl, and jwtSecret
 }={}) => {
 
   const {
     siteId,
-    authDomain,
+    authBackendBaseUrl,
     jwtSecret,
-    protocol=req.sessionSyncAuthProtocol || `https`,
   } = setup || await req.getSessionSyncAuthSetupInfo()
 
   const updateUserAccountResult = await fetch(
-    `${protocol}://${authDomain}/api/update-user-account`,
+    `${authBackendBaseUrl}/updateUserAccount`,
     {
       method: 'post',
       body: JSON.stringify({
@@ -40,4 +38,4 @@ const updateUserAccount = async ({
 
 }
 
-module.exports = updateUserAccount
+export default updateUserAccount

package/test/dummySite.js

@@ -1,19 +1,21 @@
 'use strict'
 
-const express = require('express')
-const app = express()
-const cors = require('cors')
-const bodyParser = require('body-parser')
+import express from 'express'
+import cors from 'cors'
+import bodyParser from 'body-parser'
+
+import authenticate from '../src/authenticate'
+import setUpSessionSyncAuthRoutes from '../src/setUpSessionSyncAuthRoutes'
 
-const authenticate = require('../src/authenticate')
-const setUpSessionSyncAuthRoutes = require('../src/setUpSessionSyncAuthRoutes')
+const app = express()
 
 try {
 
   const [
     port,
     dbPrefix,
-    authDomain,
+    authFrontendBaseUrl,
+    authBackendBaseUrl,
     x,
   ] = process.argv.slice(2)
 
@@ -56,9 +58,9 @@ try {
     setUpSessionSyncAuthRoutes({
       app,
       siteId: port,
-      authDomain: authDomain || `localhost:3005`,
+      authFrontendBaseUrl: authFrontendBaseUrl || `localhost:3000`,
+      authBackendBaseUrl: authBackendBaseUrl || `localhost:8081`,
       jwtSecret: `secret:${port}`,
-      protocol: authDomain ? `https` : `http`,
       languageColType: '639-1',
     })
   }
@@ -78,9 +80,9 @@ try {
 } catch(err) {
 
   const logSyntax = () => {
-    console.log(`Syntax: \`npm run dev [port] [dbPrefix] [authDomain]\`\n`)
+    console.log(`Syntax: \`npm run dev [port] [dbPrefix] [authFrontendBaseUrl] [authBackendBaseUrl]\`\n`)
     console.log(`Example #1: \`npm run 3002 db1\``)
-    console.log(`Example #2: \`npm run 3003 db2 auth.staging.resourcingeducation.com\``)
+    console.log(`Example #2: \`npm run 3003 db2 https://staging.resourcingeducation.com https://auth.staging.resourcingeducation.com/apis/auth\``)
     console.log(``)
   }
 
@@ -112,4 +114,4 @@ try {
 
 }
 
-module.exports = app
+export default app