Improve auth types (#5008)

.changeset/fresh-worms-trade.md

@@ -0,0 +1,5 @@
+---
+'@keystone-next/auth': patch
+---
+
+Updated internal types to be more correct.

packages-next/auth/src/gql/getInitFirstItemSchema.ts

@@ -1,6 +1,6 @@
 import type { GraphQLSchemaExtension, BaseKeystone } from '@keystone-next/types';
 
-import { AuthGqlNames } from '../types';
+import { AuthGqlNames, InitFirstItemConfig } from '../types';
 
 export function getInitFirstItemSchema({
   listKey,
@@ -10,8 +10,8 @@ export function getInitFirstItemSchema({
   keystone,
 }: {
   listKey: string;
-  fields: string[];
-  itemData: Record<string, any> | undefined;
+  fields: InitFirstItemConfig<any>['fields'];
+  itemData: InitFirstItemConfig<any>['itemData'];
   gqlNames: AuthGqlNames;
   keystone: BaseKeystone;
 }): GraphQLSchemaExtension {

packages-next/auth/src/schema.ts

@@ -1,7 +1,7 @@
 import { mergeSchemas } from '@graphql-tools/merge';
 import { ExtendGraphqlSchema } from '@keystone-next/types';
 
-import { AuthGqlNames, AuthTokenTypeConfig } from './types';
+import { AuthGqlNames, AuthTokenTypeConfig, InitFirstItemConfig } from './types';
 import { getBaseAuthSchema } from './gql/getBaseAuthSchema';
 import { getInitFirstItemSchema } from './gql/getInitFirstItemSchema';
 import { getPasswordResetSchema } from './gql/getPasswordResetSchema';
@@ -22,8 +22,8 @@ export const getSchemaExtension = ({
   protectIdentities: boolean;
   secretField: string;
   gqlNames: AuthGqlNames;
-  initFirstItem?: any;
-  passwordResetLink?: any;
+  initFirstItem?: InitFirstItemConfig<any>;
+  passwordResetLink?: AuthTokenTypeConfig;
   magicAuthLink?: AuthTokenTypeConfig;
 }): ExtendGraphqlSchema => (schema, keystone) =>
   [

packages-next/auth/src/types.ts

@@ -47,14 +47,16 @@ export type AuthConfig<GeneratedListTypes extends BaseGeneratedListTypes> = {
   /** "Magic link" functionality */
   magicAuthLink?: AuthTokenTypeConfig;
   /** The initial user/db seeding functionality */
-  initFirstItem?: {
-    /** Array of fields to collect, e.g ['name', 'email', 'password'] */
-    fields: GeneratedListTypes['fields'][];
-    /** Suppresses the second screen where we ask people to subscribe and follow Keystone */
-    skipKeystoneWelcome?: boolean;
-    /** Extra input to add for the create mutation */
-    itemData?: Partial<GeneratedListTypes['inputs']['create']>;
-  };
+  initFirstItem?: InitFirstItemConfig<GeneratedListTypes>;
+};
+
+export type InitFirstItemConfig<GeneratedListTypes extends BaseGeneratedListTypes> = {
+  /** Array of fields to collect, e.g ['name', 'email', 'password'] */
+  fields: GeneratedListTypes['fields'][];
+  /** Suppresses the second screen where we ask people to subscribe and follow Keystone */
+  skipKeystoneWelcome?: boolean;
+  /** Extra input to add for the create mutation */
+  itemData?: Partial<GeneratedListTypes['inputs']['create']>;
 };
 
 export type AuthTokenRequestErrorCode = 'IDENTITY_NOT_FOUND' | 'MULTIPLE_IDENTITY_MATCHES';