@opensaas/keystone-nextjs-auth 20.5.0 → 21.0.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @opensaas-keystone/nextjs-auth
 
+## 21.0.0
+
+### Major Changes
+
+- 4119c1c: Add ability to configure custom pages use `pages` configuration
+- 4119c1c: Move `userMap` `accountMap` and `userMap` into a resolver function - `resolver` function takes in `{user,account,profile}` and returns a object that is passed in to create the identity
+
 ## 20.5.0
 
 ### Minor Changes

package/README.md

@@ -44,9 +44,11 @@ const auth = createAuth({
   identityField: 'subjectId',
   sessionData: `id name email`,
   autoCreate: true,
-  userMap: { subjectId: 'id', name: 'name' },
-  accountMap: {},
-  profileMap: { email: 'email' },
+  resolver: async ({user, profile, account}) => {
+    const username = user.name as string;
+    const email = user.email as string;
+    return { email, username };
+  },
   keystonePath: '/admin',
   sessionSecret,
   providers: [

package/dist/declarations/src/gql/getBaseAuthSchema.d.ts

@@ -1,9 +1,7 @@
 import type { BaseItem } from '@keystone-6/core/types';
 import { graphql } from '@keystone-6/core';
-import { AuthGqlNames } from '../types';
-export declare function getBaseAuthSchema({ listKey, gqlNames, base, }: {
+export declare function getBaseAuthSchema({ listKey, base, }: {
     listKey: string;
-    gqlNames: AuthGqlNames;
     base: graphql.BaseSchemaMeta;
 }): {
     extension: {

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

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

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

@@ -1,18 +1,25 @@
+import { CookiesOptions, EventCallbacks, PagesOptions } from 'next-auth';
 import type { KeystoneListsAPI } from '@keystone-6/core/types';
 import { Provider } from 'next-auth/providers';
-declare type NextAuthPageProps = {
+import { JWTOptions } from 'next-auth/jwt';
+declare type CoreNextAuthPageProps = {
+    autoCreate: boolean;
+    cookies?: Partial<CookiesOptions>;
+    events?: Partial<EventCallbacks>;
     identityField: string;
-    mutationName: string;
-    providers: Provider[];
-    query: KeystoneListsAPI<any>;
-    sessionData: string;
+    jwt?: Partial<JWTOptions>;
     listKey: string;
-    autoCreate: boolean;
-    userMap: any;
-    accountMap: any;
-    profileMap: any;
+    pages?: Partial<PagesOptions>;
+    providers?: Provider[];
+    resolver?: Function | undefined;
+    sessionData: string | undefined;
     sessionSecret: string;
 };
+declare type NextAuthGglProps = {
+    mutationName?: string;
+    query?: KeystoneListsAPI<any>;
+};
+export declare type NextAuthPageProps = CoreNextAuthPageProps & NextAuthGglProps;
 export default function NextAuthPage(props: NextAuthPageProps): any;
 export declare const getNextAuthPage: (props: NextAuthPageProps) => () => any;
 export {};

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

@@ -1,7 +1,5 @@
 import { ExtendGraphqlSchema } from '@keystone-6/core/types';
-import { AuthGqlNames } from './types';
-export declare const getSchemaExtension: ({ identityField, listKey, gqlNames, }: {
+export declare const getSchemaExtension: ({ listKey, }: {
     identityField: string;
     listKey: string;
-    gqlNames: AuthGqlNames;
 }) => ExtendGraphqlSchema;

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

@@ -1,12 +1,4 @@
-import { AuthGqlNames } from '../types';
-export declare const authTemplate: ({ gqlNames, identityField, sessionData, listKey, autoCreate, userMap, accountMap, profileMap, sessionSecret, }: {
-    gqlNames: AuthGqlNames;
-    identityField: string;
-    sessionData: any;
-    listKey: string;
-    autoCreate: boolean;
-    userMap: any;
-    accountMap: any;
-    profileMap: any;
-    sessionSecret: string;
-}) => string;
+import { NextAuthPageProps } from '../pages/NextAuthPage';
+declare type AuthTemplateOptions = NextAuthPageProps;
+export declare const authTemplate: ({ autoCreate, identityField, listKey, sessionData, sessionSecret, }: AuthTemplateOptions) => string;
+export {};

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

@@ -1,42 +1,39 @@
 import { BaseListTypeInfo, KeystoneConfig } from '@keystone-6/core/types';
+import { CookiesOptions, PagesOptions } from 'next-auth';
 import { Provider } from 'next-auth/providers';
-export declare type AuthGqlNames = {
-    CreateInitialInput: string;
-    createInitialItem: string;
-    authenticateItemWithPassword: string;
-    ItemAuthenticationWithPasswordResult: string;
-    ItemAuthenticationWithPasswordSuccess: string;
-    ItemAuthenticationWithPasswordFailure: string;
-};
 export declare type NextAuthSession = {
     listKey: string;
     itemId: string;
     data: any;
 };
 export declare type NextAuthProviders = Provider[];
-declare type KeytoneAuthProviders = {
+declare type KeytoneOAuthOptions = {
     providers: NextAuthProviders;
+    pages?: Partial<PagesOptions>;
+};
+declare type NextAuthOptions = {
+    cookies?: Partial<CookiesOptions>;
+    resolver: any;
 };
-export declare type KeystoneAuthConfig = KeystoneConfig & KeytoneAuthProviders;
+export declare type KeystoneOAuthConfig = KeystoneConfig & KeytoneOAuthOptions & NextAuthOptions;
 export declare type AuthConfig<GeneratedListTypes extends BaseListTypeInfo> = {
+    /** Auth Create users in Keystone DB from Auth Provider */
+    autoCreate: boolean;
+    /** Adds ability to customize cookie options, for example, to facilitate cross-subdomain functionality */
+    cookies?: Partial<CookiesOptions>;
     /** The key of the list to authenticate users with */
     listKey: GeneratedListTypes['key'];
     /** The path of the field the identity is stored in; must be text-ish */
     identityField: GeneratedListTypes['fields'];
-    /** Session data population */
-    sessionData?: string;
-    /** Auth Create users in Keystone DB from Auth Provider */
-    autoCreate: boolean;
-    /** Map User in next-auth to item */
-    userMap: any;
-    /** Map Account in next-auth to item */
-    accountMap: any;
-    /** Map Profile in next-auth to item */
-    profileMap: any;
     /** Path for Keystone interface */
     keystonePath?: string;
+    pages?: any;
     /** Providers for Next Auth */
     providers: NextAuthProviders;
+    /** Resolver for user to define their profile */
+    resolver?: Function | undefined;
+    /** Session data population */
+    sessionData?: string | undefined;
     /** Next-Auth Session Secret */
     sessionSecret: string;
 };

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

@@ -5,6 +5,8 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var _objectSpread = require('@babel/runtime/helpers/objectSpread2');
 var _objectWithoutProperties = require('@babel/runtime/helpers/objectWithoutProperties');
 var _includesInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/includes');
+var _indexOfInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/index-of');
+var _Object$values = require('@babel/runtime-corejs3/core-js-stable/object/values');
 var _mapInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/map');
 var _JSON$stringify = require('@babel/runtime-corejs3/core-js-stable/json/stringify');
 var _URL = require('@babel/runtime-corejs3/core-js-stable/url');
@@ -14,7 +16,6 @@ var jwt = require('next-auth/jwt');
 var cookie = require('cookie');
 var ejs = require('ejs');
 var _filterInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/filter');
-var graphql = require('graphql');
 var core = require('@keystone-6/core');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
@@ -38,6 +39,8 @@ function _interopNamespace(e) {
 }
 
 var _includesInstanceProperty__default = /*#__PURE__*/_interopDefault(_includesInstanceProperty);
+var _indexOfInstanceProperty__default = /*#__PURE__*/_interopDefault(_indexOfInstanceProperty);
+var _Object$values__default = /*#__PURE__*/_interopDefault(_Object$values);
 var _mapInstanceProperty__default = /*#__PURE__*/_interopDefault(_mapInstanceProperty);
 var _JSON$stringify__default = /*#__PURE__*/_interopDefault(_JSON$stringify);
 var _URL__default = /*#__PURE__*/_interopDefault(_URL);
@@ -55,6 +58,9 @@ module.exports = withPreconstruct({
   typescript: {
     ignoreBuildErrors: true,
   },
+  env: {
+    NEXTAUTH_URL: process.env.NEXTAUTH_URL || 'http://localhost:<%= process.env.PORT || 3000 %><%= keystonePath || '' %>/api/auth',
+  },
   eslint: {
     ignoreDuringBuilds: true,
   },
@@ -110,7 +116,6 @@ const nextConfigTemplate = ({
 
 function getBaseAuthSchema({
   listKey,
-  gqlNames,
   base
 }) {
   const extension = {
@@ -150,22 +155,12 @@ function getBaseAuthSchema({
 }
 
 const getSchemaExtension = ({
-  identityField,
-  listKey,
-  gqlNames
+  listKey
 }) => core.graphql.extend(base => {
   var _context;
 
-  const uniqueWhereInputType = graphql.assertInputObjectType(base.schema.getType(`${listKey}WhereUniqueInput`));
-  const identityFieldOnUniqueWhere = uniqueWhereInputType.getFields()[identityField];
-
-  if ((identityFieldOnUniqueWhere === null || identityFieldOnUniqueWhere === void 0 ? void 0 : identityFieldOnUniqueWhere.type) !== graphql.GraphQLString && (identityFieldOnUniqueWhere === null || identityFieldOnUniqueWhere === void 0 ? void 0 : identityFieldOnUniqueWhere.type) !== graphql.GraphQLID) {
-    throw new Error(`createAuth was called with an identityField of ${identityField} on the list ${listKey} ` + `but that field doesn't allow being searched uniquely with a String or ID. ` + `You should likely add \`isIndexed: 'unique'\` ` + `to the field at ${listKey}.${identityField}`);
-  }
-
   const baseSchema = getBaseAuthSchema({
     listKey,
-    gqlNames,
     base
   });
   return _filterInstanceProperty__default["default"](_context = [baseSchema.extension]).call(_context, x => x !== undefined);
@@ -177,38 +172,29 @@ import { query } from '.keystone/api';
 import keystoneConfig from '../../../../../keystone';
 
 export default getNextAuthPage({
+        autoCreate: <%= autoCreate %>,
         identityField: '<%= identityField %>',
-        sessionData: '<%= sessionData %>',
         listKey: '<%= listKey %>',
-        userMap: <%- JSON.stringify(userMap) %>,
-        accountMap: <%- JSON.stringify(accountMap) %>,
-        profileMap: <%- JSON.stringify(profileMap) %>,
-        autoCreate: <%= autoCreate %>,
-        sessionSecret: '<%= sessionSecret %>',
+        pages: keystoneConfig.pages,
         providers: keystoneConfig.providers,
         query,
+        resolver: keystoneConfig.resolver,
+        sessionData: '<%= sessionData %>',
+        sessionSecret: '<%= sessionSecret %>',
     });
   `;
 const authTemplate = ({
-  gqlNames,
+  autoCreate,
   identityField,
-  sessionData,
   listKey,
-  autoCreate,
-  userMap,
-  accountMap,
-  profileMap,
+  sessionData,
   sessionSecret
 }) => {
   const authOut = ejs__default["default"].render(template, {
-    gqlNames,
     identityField,
     sessionData,
     listKey,
     autoCreate,
-    userMap,
-    accountMap,
-    profileMap,
     sessionSecret
   });
   return authOut;
@@ -222,31 +208,21 @@ const _excluded = ["get", "start"];
  */
 
 function createAuth({
-  listKey,
-  identityField,
-  sessionData,
   autoCreate,
-  userMap,
-  accountMap,
-  profileMap,
+  cookies,
+  identityField,
+  listKey,
   keystonePath,
+  pages,
+  resolver,
   providers,
+  sessionData,
   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)
   // or whether always being true is what we want, in which case we can refactor our code
   // to match this. -TL
-  const gqlNames = {
-    // Core
-    authenticateItemWithPassword: `authenticate${listKey}WithPassword`,
-    ItemAuthenticationWithPasswordResult: `${listKey}AuthenticationWithPasswordResult`,
-    ItemAuthenticationWithPasswordSuccess: `${listKey}AuthenticationWithPasswordSuccess`,
-    ItemAuthenticationWithPasswordFailure: `${listKey}AuthenticationWithPasswordFailure`,
-    // Initial data
-    CreateInitialInput: `CreateInitial${listKey}Input`,
-    createInitialItem: `createInitial${listKey}`
-  };
   const customPath = !keystonePath || keystonePath === '/' ? '' : keystonePath;
   /**
    * pageMiddleware
@@ -263,16 +239,14 @@ function createAuth({
     context,
     isValidSession
   }) => {
+    var _context;
+
     const {
       req,
       session
     } = context;
     const pathname = url__default["default"].parse(req === null || req === void 0 ? void 0 : req.url).pathname;
 
-    if (pathname === `${customPath}/api/__keystone_api_build`) {
-      return;
-    }
-
     if (isValidSession) {
       if (pathname === `${customPath}/api/auth/signin`) {
         return {
@@ -291,7 +265,11 @@ function createAuth({
       return;
     }
 
-    if (!session && !_includesInstanceProperty__default["default"](pathname).call(pathname, `${customPath}/api/auth/`)) {
+    if (_includesInstanceProperty__default["default"](pathname).call(pathname, '/_next/') || _includesInstanceProperty__default["default"](pathname).call(pathname, '/api/auth/')) {
+      return;
+    }
+
+    if (!session && !_includesInstanceProperty__default["default"](pathname).call(pathname, `${customPath}/api/auth/`) && !(_indexOfInstanceProperty__default["default"](_context = _Object$values__default["default"](pages)).call(_context, pathname) > -1)) {
       return {
         kind: 'redirect',
         to: `${customPath}/api/auth/signin`
@@ -313,14 +291,10 @@ function createAuth({
       mode: 'write',
       outputPath: 'pages/api/auth/[...nextauth].js',
       src: authTemplate({
-        gqlNames,
+        autoCreate,
         identityField,
-        sessionData,
         listKey,
-        autoCreate,
-        userMap,
-        accountMap,
-        profileMap,
+        sessionData,
         sessionSecret
       })
     }, {
@@ -339,7 +313,8 @@ function createAuth({
    */
 
 
-  const publicPages = [`${customPath}/api/auth/csrf`, `${customPath}/api/auth/signin`, `${customPath}/api/auth/callback`, `${customPath}/api/auth/session`, `${customPath}/api/auth/providers`, `${customPath}/api/auth/signout`];
+  const publicPages = [`${customPath}/api/__keystone_api_build`, `${customPath}/api/auth/csrf`, `${customPath}/api/auth/signin`, `${customPath}/api/auth/callback`, `${customPath}/api/auth/session`, `${customPath}/api/auth/providers`, `${customPath}/api/auth/signout`, `${customPath}/api/auth/error`]; // TODO: Add Provider Types
+  // @ts-ignore
 
   function addPages(provider) {
     const name = provider.id;
@@ -357,8 +332,7 @@ function createAuth({
 
   const extendGraphqlSchema = getSchemaExtension({
     identityField,
-    listKey,
-    gqlNames
+    listKey
   });
   /**
    * validateConfig
@@ -372,7 +346,9 @@ function createAuth({
     if (listConfig === undefined) {
       const msg = `A createAuth() invocation specifies the list "${listKey}" but no list with that key has been defined.`;
       throw new Error(msg);
-    } // TODO: Check for String-like typing for identityField? How?
+    } // TODO: Check if providers
+    // TODO: Check other required commands/data
+    // TODO: Check for String-like typing for identityField? How?
     // TODO: Validate that the identifyField is unique.
     // TODO: If this field isn't required, what happens if I try to log in as `null`?
 
@@ -380,9 +356,9 @@ function createAuth({
     const identityFieldConfig = listConfig.fields[identityField];
 
     if (identityFieldConfig === undefined) {
-      const i = _JSON$stringify__default["default"](identityField);
+      const identityFieldName = _JSON$stringify__default["default"](identityField);
 
-      const msg = `A createAuth() invocation for the "${listKey}" list specifies ${i} as its identityField but no field with that key exists on the list.`;
+      const msg = `A createAuth() invocation for the "${listKey}" list specifies ${identityFieldName} as its identityField but no field with that key exists on the list.`;
       throw new Error(msg);
     }
   };
@@ -405,7 +381,15 @@ function createAuth({
           sessionStrategy = _objectWithoutProperties(_sessionStrategy, _excluded);
 
     return _objectSpread(_objectSpread({}, sessionStrategy), {}, {
-      start,
+      start: async ({
+        res
+      }) => {
+        console.log('start');
+        const session = await start({
+          res
+        });
+        return session;
+      },
       get: async ({
         req
       }) => {
@@ -420,9 +404,8 @@ function createAuth({
         if (((_req$headers$authoriz = req.headers.authorization) === null || _req$headers$authoriz === void 0 ? void 0 : _req$headers$authoriz.split(' ')[0]) === 'Bearer') {
           var _token$data;
 
-          const request = req;
           const token = await jwt.getToken({
-            req: request,
+            req,
             secret: sessionSecret
           });
 
@@ -451,6 +434,7 @@ function createAuth({
           secure: process.env.NODE_ENV === 'production',
           path: '/',
           sameSite: 'lax',
+          // TODO: Update parse to URL
           domain: url__default["default"].parse(req.url).hostname
         }));
       }
@@ -487,19 +471,23 @@ function createAuth({
         },
         enableSessionItem: true,
         isAccessAllowed: async context => {
-          var _context$req, _context$req2, _keystoneConfig$ui3;
+          var _context$req, _keystoneConfig$ui3;
 
-          if (process.env.NODE_ENV !== 'production' && ((_context$req = context.req) === null || _context$req === void 0 ? void 0 : _context$req.url) !== undefined && new _URL__default["default"](context.req.url, 'http://example.com').pathname === `${customPath}/api/__keystone_api_build`) {
+          const {
+            req
+          } = context;
+          const pathname = url__default["default"].parse(req === null || req === void 0 ? void 0 : req.url).pathname; // Allow nextjs scripts and static files to be accessed without auth
+
+          if (_includesInstanceProperty__default["default"](pathname).call(pathname, '/_next/')) {
             return true;
-          } // Allow access to the adminMeta data from the /init path to correctly render that page
-          // even if the user isn't logged in (which should always be the case if they're seeing /init)
+          } // Allow keystone to access /api/__keystone_api_build for hot reloading
 
 
-          const headers = (_context$req2 = context.req) === null || _context$req2 === void 0 ? void 0 : _context$req2.headers;
-          const host = headers ? headers['x-forwarded-host'] || headers.host : null;
-          const thisUrl = headers !== null && headers !== void 0 && headers.referer ? new _URL__default["default"](headers.referer) : undefined;
-          const accessingInitPage = (thisUrl === null || thisUrl === void 0 ? void 0 : thisUrl.pathname) === '/init' && (thisUrl === null || thisUrl === void 0 ? void 0 : thisUrl.host) === host && (await context.sudo().query[listKey].count({})) === 0;
-          return accessingInitPage || ((_keystoneConfig$ui3 = keystoneConfig.ui) !== null && _keystoneConfig$ui3 !== void 0 && _keystoneConfig$ui3.isAccessAllowed ? keystoneConfig.ui.isAccessAllowed(context) : context.session !== undefined);
+          if (process.env.NODE_ENV !== 'production' && ((_context$req = context.req) === null || _context$req === void 0 ? void 0 : _context$req.url) !== undefined && new _URL__default["default"](context.req.url, 'http://example.com').pathname === `${customPath}/api/__keystone_api_build`) {
+            return true;
+          }
+
+          return (_keystoneConfig$ui3 = keystoneConfig.ui) !== null && _keystoneConfig$ui3 !== void 0 && _keystoneConfig$ui3.isAccessAllowed ? keystoneConfig.ui.isAccessAllowed(context) : context.session !== undefined;
         }
       });
     }
@@ -509,8 +497,11 @@ function createAuth({
     const existingExtendGraphQLSchema = keystoneConfig.extendGraphqlSchema;
     return _objectSpread(_objectSpread({}, keystoneConfig), {}, {
       ui,
-      session,
+      cookies,
       providers,
+      pages,
+      resolver,
+      session,
       lists: _objectSpread({}, keystoneConfig.lists),
       experimental: _objectSpread(_objectSpread({}, keystoneConfig.experimental), {}, {
         generateNodeAPI: true