@opensaas/keystone-nextjs-auth 19.1.0 → 20.0.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @opensaas-keystone/nextjs-auth
 
+## 20.0.0
+
+### Major Changes
+
+- b385ee4: Upgrade to next-authv4 see https://next-auth.js.org/getting-started/upgrade-v4 for more info.
+
+  BREAKING CHANGE:
+  `sessionSecret` now required in `createAuth`
+
+  `Providers` now under `@opensaas/keystone-nextjs-auth/providers/` ie `import Auth0 from '@opensaas/keystone-nextjs-auth/providers/auth0';` these can also be imported from next-auth by `import Auth0 from 'next-auth/providers/auth0';` if preferred.
+
+### Patch Changes
+
+- a6ad41a: fix redirect for custom path
+- 0043ca8: clean up some types
+
 ## 19.1.0
 
 ### Minor Changes

package/README.md

@@ -1,5 +1,5 @@
 # Keystone next auth
-This package that enables the adition of social auth to keystone-6.
+This package enables the addition of social auth to keystone-6.
 
 ## Contents
 
@@ -18,16 +18,27 @@ Add package by `yarn add @opensaas/keystone-nextjs-auth` then add the following
 Add import...
 
 ```javascript
-import {
-  createAuth,
-  nextAuthProviders as Providers,
-} from '@opensaas/keystone-nextjs-auth';
+import { createAuth } from '@opensaas/keystone-nextjs-auth';
+import Auth0 from '@opensaas/keystone-nextjs-auth/providers/auth0';
+
 ```
 
 Add you Auth configuration including providers
-for Provider configuration see https://next-auth.js.org/configuration/providers.
+for Provider configuration see https://next-auth.js.org/configuration/providers. For Provider configuration replace `next-auth/providers/` with `@opensaas/keystone-nextjs-auth/providers/`
 
 ```javascript
+let sessionSecret = process.env.SESSION_SECRET;
+
+if (!sessionSecret) {
+  if (process.env.NODE_ENV === 'production') {
+    throw new Error(
+      'The SESSION_SECRET environment variable must be set in production'
+    );
+  } else {
+    sessionSecret = '-- DEV COOKIE SECRET; CHANGE ME --';
+  }
+}
+
 const auth = createAuth({
   listKey: 'User',
   identityField: 'subjectId',
@@ -37,8 +48,9 @@ const auth = createAuth({
   accountMap: {},
   profileMap: { email: 'email' },
   keystonePath: '/admin',
+  sessionSecret,
   providers: [
-    Providers.Auth0({
+    Auth0({
       clientId: process.env.AUTH0_CLIENT_ID || 'Auth0ClientID',
       clientSecret: process.env.AUTH0_CLIENT_SECRET || 'Auth0ClientSecret',
       domain: process.env.AUTH0_DOMAIN || 'opensaas.au.auth0.com',

package/dist/declarations/src/index.d.ts

@@ -1,12 +1,11 @@
-import { BaseGeneratedListTypes, KeystoneConfig } from '@keystone-6/core/types';
+import { BaseListTypeInfo, KeystoneConfig } from '@keystone-6/core/types';
 import { AuthConfig, KeystoneAuthConfig } from './types';
-export declare const nextAuthProviders: import("next-auth/providers").BuiltInProviders;
 /**
  * createAuth function
  *
  * Generates config for Keystone to implement standard auth features.
  */
 export type { NextAuthProviders, KeystoneAuthConfig } from './types';
-export declare function createAuth<GeneratedListTypes extends BaseGeneratedListTypes>({ listKey, identityField, sessionData, autoCreate, userMap, accountMap, profileMap, keystonePath, providers, }: AuthConfig<GeneratedListTypes>): {
+export declare function createAuth<GeneratedListTypes extends BaseListTypeInfo>({ listKey, identityField, sessionData, autoCreate, userMap, accountMap, profileMap, keystonePath, providers, sessionSecret, }: AuthConfig<GeneratedListTypes>): {
     withAuth: (keystoneConfig: KeystoneConfig) => KeystoneAuthConfig;
 };

package/dist/declarations/src/pages/NextAuthPage.d.ts

@@ -1,5 +1,5 @@
-import { Provider } from 'next-auth/providers';
 import type { KeystoneListsAPI } from '@keystone-6/core/types';
+import { Provider } from 'next-auth/providers';
 declare type NextAuthPageProps = {
     identityField: string;
     mutationName: string;
@@ -11,7 +11,8 @@ declare type NextAuthPageProps = {
     userMap: any;
     accountMap: any;
     profileMap: any;
+    sessionSecret: string;
 };
-export default function NextAuthPage(props: NextAuthPageProps): void | Promise<void>;
-export declare const getNextAuthPage: (props: NextAuthPageProps) => () => void | Promise<void>;
+export default function NextAuthPage(props: NextAuthPageProps): any;
+export declare const getNextAuthPage: (props: NextAuthPageProps) => () => any;
 export {};

package/dist/declarations/src/providers/42-school.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/42-school';
+export { default } from 'next-auth/providers/42-school';

package/dist/declarations/src/providers/apple.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/apple';
+export { default } from 'next-auth/providers/apple';

package/dist/declarations/src/providers/atlassian.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/atlassian';
+export { default } from 'next-auth/providers/atlassian';

package/dist/declarations/src/providers/auth0.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/auth0';
+export { default } from 'next-auth/providers/auth0';

package/dist/declarations/src/providers/azure-ad-b2c.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/azure-ad-b2c';
+export { default } from 'next-auth/providers/azure-ad-b2c';

package/dist/declarations/src/providers/azure-ad.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/azure-ad';
+export { default } from 'next-auth/providers/azure-ad';

package/dist/declarations/src/providers/battlenet.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/battlenet';
+export { default } from 'next-auth/providers/battlenet';

package/dist/declarations/src/providers/box.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/box';
+export { default } from 'next-auth/providers/box';

package/dist/declarations/src/providers/bungie.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/bungie';
+export { default } from 'next-auth/providers/bungie';

package/dist/declarations/src/providers/cognito.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/cognito';
+export { default } from 'next-auth/providers/cognito';

package/dist/declarations/src/providers/coinbase.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/coinbase';
+export { default } from 'next-auth/providers/coinbase';

package/dist/declarations/src/providers/credentials.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/credentials';
+export { default } from 'next-auth/providers/credentials';

package/dist/declarations/src/providers/discord.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/discord';
+export { default } from 'next-auth/providers/discord';

package/dist/declarations/src/providers/dropbox.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/dropbox';
+export { default } from 'next-auth/providers/dropbox';

package/dist/declarations/src/providers/email.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/email';
+export { default } from 'next-auth/providers/email';

package/dist/declarations/src/providers/eveonline.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/eveonline';
+export { default } from 'next-auth/providers/eveonline';

package/dist/declarations/src/providers/facebook.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/facebook';
+export { default } from 'next-auth/providers/facebook';

package/dist/declarations/src/providers/faceit.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/faceit';
+export { default } from 'next-auth/providers/faceit';

package/dist/declarations/src/providers/foursquare.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/foursquare';
+export { default } from 'next-auth/providers/foursquare';

package/dist/declarations/src/providers/freshbooks.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/freshbooks';
+export { default } from 'next-auth/providers/freshbooks';

package/dist/declarations/src/providers/fusionauth.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/fusionauth';
+export { default } from 'next-auth/providers/fusionauth';

package/dist/declarations/src/providers/github.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/github';
+export { default } from 'next-auth/providers/github';

package/dist/declarations/src/providers/gitlab.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/gitlab';
+export { default } from 'next-auth/providers/gitlab';

package/dist/declarations/src/providers/google.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/google';
+export { default } from 'next-auth/providers/google';

package/dist/declarations/src/providers/identity-server4.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/identity-server4';
+export { default } from 'next-auth/providers/identity-server4';

package/dist/declarations/src/providers/index.d.ts

@@ -0,0 +1,2 @@
+import Providers from 'next-auth/providers';
+export default Providers;

package/dist/declarations/src/providers/instagram.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/instagram';
+export { default } from 'next-auth/providers/instagram';

package/dist/declarations/src/providers/kakao.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/kakao';
+export { default } from 'next-auth/providers/kakao';

package/dist/declarations/src/providers/keycloak.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/keycloak';
+export { default } from 'next-auth/providers/keycloak';

package/dist/declarations/src/providers/line.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/line';
+export { default } from 'next-auth/providers/line';

package/dist/declarations/src/providers/linkedin.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/linkedin';
+export { default } from 'next-auth/providers/linkedin';

package/dist/declarations/src/providers/mailchimp.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/mailchimp';
+export { default } from 'next-auth/providers/mailchimp';

package/dist/declarations/src/providers/mailru.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/mailru';
+export { default } from 'next-auth/providers/mailru';

package/dist/declarations/src/providers/medium.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/medium';
+export { default } from 'next-auth/providers/medium';

package/dist/declarations/src/providers/naver.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/naver';
+export { default } from 'next-auth/providers/naver';

package/dist/declarations/src/providers/netlify.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/netlify';
+export { default } from 'next-auth/providers/netlify';

package/dist/declarations/src/providers/oauth.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/oauth';
+export { default } from 'next-auth/providers/oauth';

package/dist/declarations/src/providers/okta.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/okta';
+export { default } from 'next-auth/providers/okta';

package/dist/declarations/src/providers/onelogin.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/onelogin';
+export { default } from 'next-auth/providers/onelogin';

package/dist/declarations/src/providers/osso.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/osso';
+export { default } from 'next-auth/providers/osso';

package/dist/declarations/src/providers/osu.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/osu';
+export { default } from 'next-auth/providers/osu';

package/dist/declarations/src/providers/pipedrive.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/pipedrive';
+export { default } from 'next-auth/providers/pipedrive';

package/dist/declarations/src/providers/reddit.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/reddit';
+export { default } from 'next-auth/providers/reddit';

package/dist/declarations/src/providers/salesforce.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/salesforce';
+export { default } from 'next-auth/providers/salesforce';

package/dist/declarations/src/providers/slack.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/slack';
+export { default } from 'next-auth/providers/slack';

package/dist/declarations/src/providers/spotify.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/spotify';
+export { default } from 'next-auth/providers/spotify';

package/dist/declarations/src/providers/strava.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/strava';
+export { default } from 'next-auth/providers/strava';

package/dist/declarations/src/providers/twitch.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/twitch';
+export { default } from 'next-auth/providers/twitch';

package/dist/declarations/src/providers/twitter.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/twitter';
+export { default } from 'next-auth/providers/twitter';

package/dist/declarations/src/providers/vk.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/vk';
+export { default } from 'next-auth/providers/vk';

package/dist/declarations/src/providers/wordpress.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/wordpress';
+export { default } from 'next-auth/providers/wordpress';

package/dist/declarations/src/providers/workos.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/workos';
+export { default } from 'next-auth/providers/workos';

package/dist/declarations/src/providers/yandex.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/yandex';
+export { default } from 'next-auth/providers/yandex';

package/dist/declarations/src/providers/zoho.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/zoho';
+export { default } from 'next-auth/providers/zoho';

package/dist/declarations/src/providers/zoom.d.ts

@@ -0,0 +1,2 @@
+export * from 'next-auth/providers/zoom';
+export { default } from 'next-auth/providers/zoom';

package/dist/declarations/src/templates/auth.d.ts

@@ -1,5 +1,5 @@
 import { AuthGqlNames } from '../types';
-export declare const authTemplate: ({ gqlNames, identityField, sessionData, listKey, autoCreate, userMap, accountMap, profileMap, }: {
+export declare const authTemplate: ({ gqlNames, identityField, sessionData, listKey, autoCreate, userMap, accountMap, profileMap, sessionSecret, }: {
     gqlNames: AuthGqlNames;
     identityField: string;
     sessionData: any;
@@ -8,4 +8,5 @@ export declare const authTemplate: ({ gqlNames, identityField, sessionData, list
     userMap: any;
     accountMap: any;
     profileMap: any;
+    sessionSecret: string;
 }) => string;

package/dist/declarations/src/types.d.ts

@@ -37,6 +37,8 @@ export declare type AuthConfig<GeneratedListTypes extends BaseListTypeInfo> = {
     keystonePath?: string;
     /** Providers for Next Auth */
     providers: NextAuthProviders;
+    /** Next-Auth Session Secret */
+    sessionSecret: string;
 };
 export declare type AuthTokenRequestErrorCode = 'IDENTITY_NOT_FOUND' | 'MULTIPLE_IDENTITY_MATCHES';
 export declare type PasswordAuthErrorCode = AuthTokenRequestErrorCode | 'FAILURE' | 'SECRET_NOT_SET' | 'SECRET_MISMATCH';

package/dist/opensaas-keystone-nextjs-auth.cjs.dev.js

@@ -9,8 +9,7 @@ var _mapInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instan
 var _JSON$stringify = require('@babel/runtime-corejs3/core-js-stable/json/stringify');
 var _URL = require('@babel/runtime-corejs3/core-js-stable/url');
 var url = require('url');
-var client = require('next-auth/client');
-var Providers = require('next-auth/providers');
+var react = require('next-auth/react');
 var cookie = require('cookie');
 var ejs = require('ejs');
 var _filterInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/filter');
@@ -42,7 +41,6 @@ var _mapInstanceProperty__default = /*#__PURE__*/_interopDefault(_mapInstancePro
 var _JSON$stringify__default = /*#__PURE__*/_interopDefault(_JSON$stringify);
 var _URL__default = /*#__PURE__*/_interopDefault(_URL);
 var url__default = /*#__PURE__*/_interopDefault(url);
-var Providers__default = /*#__PURE__*/_interopDefault(Providers);
 var cookie__namespace = /*#__PURE__*/_interopNamespace(cookie);
 var ejs__default = /*#__PURE__*/_interopDefault(ejs);
 var _filterInstanceProperty__default = /*#__PURE__*/_interopDefault(_filterInstanceProperty);
@@ -185,6 +183,7 @@ export default getNextAuthPage({
         accountMap: <%- JSON.stringify(accountMap) %>,
         profileMap: <%- JSON.stringify(profileMap) %>,
         autoCreate: <%= autoCreate %>,
+        sessionSecret: '<%= sessionSecret %>',
         providers: keystoneConfig.providers,
         query,
     });
@@ -197,7 +196,8 @@ const authTemplate = ({
   autoCreate,
   userMap,
   accountMap,
-  profileMap
+  profileMap,
+  sessionSecret
 }) => {
   const authOut = ejs__default["default"].render(template, {
     gqlNames,
@@ -207,13 +207,13 @@ const authTemplate = ({
     autoCreate,
     userMap,
     accountMap,
-    profileMap
+    profileMap,
+    sessionSecret
   });
   return authOut;
 };
 
 const _excluded = ["get"];
-const nextAuthProviders = Providers__default["default"];
 /**
  * createAuth function
  *
@@ -229,7 +229,8 @@ function createAuth({
   accountMap,
   profileMap,
   keystonePath,
-  providers
+  providers,
+  sessionSecret
 }) {
   // The protectIdentities flag is currently under review to see whether it should be
   // part of the createAuth API (in which case its use cases need to be documented and tested)
@@ -279,6 +280,13 @@ function createAuth({
         };
       }
 
+      if (customPath !== '' && pathname === '/') {
+        return {
+          kind: 'redirect',
+          to: `${customPath}`
+        };
+      }
+
       return;
     }
 
@@ -311,7 +319,8 @@ function createAuth({
         autoCreate,
         userMap,
         accountMap,
-        profileMap
+        profileMap,
+        sessionSecret
       })
     }, {
       mode: 'write',
@@ -400,7 +409,7 @@ function createAuth({
           return;
         }
 
-        const nextSession = await client.getSession({
+        const nextSession = await react.getSession({
           req
         });
 
@@ -498,4 +507,3 @@ function createAuth({
 }
 
 exports.createAuth = createAuth;
-exports.nextAuthProviders = nextAuthProviders;

package/dist/opensaas-keystone-nextjs-auth.cjs.prod.js

@@ -9,8 +9,7 @@ var _mapInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instan
 var _JSON$stringify = require('@babel/runtime-corejs3/core-js-stable/json/stringify');
 var _URL = require('@babel/runtime-corejs3/core-js-stable/url');
 var url = require('url');
-var client = require('next-auth/client');
-var Providers = require('next-auth/providers');
+var react = require('next-auth/react');
 var cookie = require('cookie');
 var ejs = require('ejs');
 var _filterInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/filter');
@@ -42,7 +41,6 @@ var _mapInstanceProperty__default = /*#__PURE__*/_interopDefault(_mapInstancePro
 var _JSON$stringify__default = /*#__PURE__*/_interopDefault(_JSON$stringify);
 var _URL__default = /*#__PURE__*/_interopDefault(_URL);
 var url__default = /*#__PURE__*/_interopDefault(url);
-var Providers__default = /*#__PURE__*/_interopDefault(Providers);
 var cookie__namespace = /*#__PURE__*/_interopNamespace(cookie);
 var ejs__default = /*#__PURE__*/_interopDefault(ejs);
 var _filterInstanceProperty__default = /*#__PURE__*/_interopDefault(_filterInstanceProperty);
@@ -185,6 +183,7 @@ export default getNextAuthPage({
         accountMap: <%- JSON.stringify(accountMap) %>,
         profileMap: <%- JSON.stringify(profileMap) %>,
         autoCreate: <%= autoCreate %>,
+        sessionSecret: '<%= sessionSecret %>',
         providers: keystoneConfig.providers,
         query,
     });
@@ -197,7 +196,8 @@ const authTemplate = ({
   autoCreate,
   userMap,
   accountMap,
-  profileMap
+  profileMap,
+  sessionSecret
 }) => {
   const authOut = ejs__default["default"].render(template, {
     gqlNames,
@@ -207,13 +207,13 @@ const authTemplate = ({
     autoCreate,
     userMap,
     accountMap,
-    profileMap
+    profileMap,
+    sessionSecret
   });
   return authOut;
 };
 
 const _excluded = ["get"];
-const nextAuthProviders = Providers__default["default"];
 /**
  * createAuth function
  *
@@ -229,7 +229,8 @@ function createAuth({
   accountMap,
   profileMap,
   keystonePath,
-  providers
+  providers,
+  sessionSecret
 }) {
   // The protectIdentities flag is currently under review to see whether it should be
   // part of the createAuth API (in which case its use cases need to be documented and tested)
@@ -279,6 +280,13 @@ function createAuth({
         };
       }
 
+      if (customPath !== '' && pathname === '/') {
+        return {
+          kind: 'redirect',
+          to: `${customPath}`
+        };
+      }
+
       return;
     }
 
@@ -311,7 +319,8 @@ function createAuth({
         autoCreate,
         userMap,
         accountMap,
-        profileMap
+        profileMap,
+        sessionSecret
       })
     }, {
       mode: 'write',
@@ -400,7 +409,7 @@ function createAuth({
           return;
         }
 
-        const nextSession = await client.getSession({
+        const nextSession = await react.getSession({
           req
         });
 
@@ -494,4 +503,3 @@ function createAuth({
 }
 
 exports.createAuth = createAuth;
-exports.nextAuthProviders = nextAuthProviders;