chore: migrate to TypeScript strict in Payload package - #4/4 (#12733)

Important: An intentional effort is being made during migration to not
modify runtime behavior. This implies that there will be several
assertions, non-null assertions, and @ts-expect-error. This philosophy
applies only to migrating old code to TypeScript strict, not to writing
new code. For a more detailed justification for this reasoning, see
#11840 (comment).

In this PR, instead of following the approach of migrating a subset of
files, I'm migrating all files by disabling specific rules. The first
commits are named after the rule being disabled.

With this PR, the migration of the payload package is complete 🚀

Author: GermanJablo

packages/payload/package.json

@@ -74,7 +74,7 @@
     "build": "rimraf .dist && rimraf tsconfig.tsbuildinfo && pnpm copyfiles && pnpm build:types && pnpm build:swc && pnpm build:esbuild",
     "build:esbuild": "echo skipping esbuild",
     "build:swc": "swc ./src -d ./dist --config-file .swcrc --strip-leading-paths",
-    "build:types": "concurrently --group \"tsc --emitDeclarationOnly --outDir dist\" \"tsc-strict\"",
+    "build:types": "tsc --emitDeclarationOnly --outDir dist",
     "clean": "rimraf -g {dist,*.tsbuildinfo}",
     "clean:cache": "rimraf node_modules/.cache",
     "copyfiles": "copyfiles -u 1 \"src/**/*.{html,ttf,woff,woff2,eot,svg,jpg,png,json}\" dist/",
@@ -124,15 +124,13 @@
     "@types/pluralize": "0.0.33",
     "@types/uuid": "10.0.0",
     "@types/ws": "^8.5.10",
-    "concurrently": "9.1.2",
     "copyfiles": "2.4.1",
     "cross-env": "7.0.3",
     "esbuild": "0.25.5",
     "graphql-http": "^1.22.0",
     "react-datepicker": "7.6.0",
     "rimraf": "6.0.1",
-    "sharp": "0.32.6",
-    "typescript-strict-plugin": "2.4.4"
+    "sharp": "0.32.6"
   },
   "peerDependencies": {
     "graphql": "^16.8.1"

packages/payload/src/auth/crypto.ts

@@ -1,11 +1,12 @@
-// @ts-strict-ignore
 import crypto from 'crypto'
 
 const algorithm = 'aes-256-ctr'
 
 export function encrypt(text: string): string {
   const iv = crypto.randomBytes(16)
-  const cipher = crypto.createCipheriv(algorithm, this.secret, iv)
+  // @ts-expect-error - vestiges of when tsconfig was not strict. Feel free to improve
+  const secret = this.secret
+  const cipher = crypto.createCipheriv(algorithm, secret, iv)
 
   const encrypted = Buffer.concat([cipher.update(text), cipher.final()])
 
@@ -19,7 +20,9 @@ export function decrypt(hash: string): string {
   const iv = hash.slice(0, 32)
   const content = hash.slice(32)
 
-  const decipher = crypto.createDecipheriv(algorithm, this.secret, Buffer.from(iv, 'hex'))
+  // @ts-expect-error - vestiges of when tsconfig was not strict. Feel free to improve
+  const secret = this.secret
+  const decipher = crypto.createDecipheriv(algorithm, secret, Buffer.from(iv, 'hex'))
 
   const decrypted = Buffer.concat([decipher.update(Buffer.from(content, 'hex')), decipher.final()])
 

packages/payload/src/auth/operations/unlock.ts

@@ -1,4 +1,3 @@
-// @ts-strict-ignore
 import { status as httpStatus } from 'http-status'
 
 import type {
@@ -94,7 +93,7 @@ export const unlockOperation = async <TSlug extends CollectionSlug>(
       where: whereConstraint,
     })
 
-    let result
+    let result: boolean | null = null
 
     if (user) {
       await resetLoginAttempts({
@@ -112,7 +111,7 @@ export const unlockOperation = async <TSlug extends CollectionSlug>(
       await commitTransaction(req)
     }
 
-    return result
+    return result!
   } catch (error: unknown) {
     await killTransaction(req)
     throw error

packages/payload/src/auth/strategies/local/authenticate.ts

@@ -1,5 +1,6 @@
 // @ts-strict-ignore
 import crypto from 'crypto'
+// @ts-expect-error - no types available
 import scmp from 'scmp'
 
 import type { TypeWithID } from '../../../collections/config/types.js'

packages/payload/src/bin/index.ts

@@ -69,7 +69,7 @@ export const bin = async () => {
   }
 
   const userBinScript = Array.isArray(config.bin)
-    ? config.bin.find(({ key }) => key === script)
+    ? config.bin.find(({ key }: { key: string }) => key === script)
     : false
 
   if (userBinScript) {

packages/payload/src/bin/migrate.ts

@@ -1,4 +1,3 @@
-// @ts-strict-ignore
 import type { ParsedArgs } from 'minimist'
 
 import type { SanitizedConfig } from '../config/types.js'
@@ -97,7 +96,8 @@ export const migrate = async ({ config, parsedArgs }: Args): Promise<void> => {
           skipEmpty,
         })
       } catch (err) {
-        throw new Error(`Error creating migration: ${err.message}`)
+        const error = err instanceof Error ? err.message : 'Unknown error'
+        throw new Error(`Error creating migration: ${error}`)
       }
       break
     case 'migrate:down':

packages/payload/src/collections/config/client.ts

@@ -1,5 +1,4 @@
-// @ts-strict-ignore
-import type { I18nClient } from '@payloadcms/translations'
+import type { I18nClient, TFunction } from '@payloadcms/translations'
 
 import type { StaticDescription } from '../../admin/types.js'
 import type { ImportMap } from '../../bin/generateImportMap/index.js'
@@ -139,7 +138,7 @@ export const createClientCollectionConfig = ({
                   clientCollection.admin.description = collection.admin.description
                 }
               } else if (typeof collection.admin.description === 'function') {
-                const description = collection.admin.description({ t: i18n.t })
+                const description = collection.admin.description({ t: i18n.t as TFunction })
                 if (description) {
                   clientCollection.admin.description = description
                 }
@@ -159,7 +158,8 @@ export const createClientCollectionConfig = ({
               }
               break
             default:
-              clientCollection.admin[adminKey] = collection.admin[adminKey]
+              ;(clientCollection as any).admin[adminKey] =
+                collection.admin[adminKey as keyof SanitizedCollectionConfig['admin']]
           }
         }
         break
@@ -215,11 +215,11 @@ export const createClientCollectionConfig = ({
         clientCollection.labels = {
           plural:
             typeof collection.labels.plural === 'function'
-              ? collection.labels.plural({ i18n, t: i18n.t })
+              ? collection.labels.plural({ i18n, t: i18n.t as TFunction })
               : collection.labels.plural,
           singular:
             typeof collection.labels.singular === 'function'
-              ? collection.labels.singular({ i18n, t: i18n.t })
+              ? collection.labels.singular({ i18n, t: i18n.t as TFunction })
               : collection.labels.singular,
         }
         break
@@ -241,13 +241,14 @@ export const createClientCollectionConfig = ({
               return sanitizedSize
             })
           } else {
-            clientCollection.upload[uploadKey] = collection.upload[uploadKey]
+            ;(clientCollection.upload as any)[uploadKey] =
+              collection.upload[uploadKey as keyof SanitizedUploadConfig]
           }
         }
         break
 
       default:
-        clientCollection[key] = collection[key]
+        ;(clientCollection as any)[key] = collection[key as keyof SanitizedCollectionConfig]
     }
   }
 

packages/payload/src/collections/dataloader.ts

@@ -1,4 +1,3 @@
-// @ts-strict-ignore
 import type { BatchLoadFn } from 'dataloader'
 
 import DataLoader from 'dataloader'
@@ -22,7 +21,7 @@ import { isValidID } from '../utilities/isValidID.js'
 
 const batchAndLoadDocs =
   (req: PayloadRequest): BatchLoadFn<string, TypeWithID> =>
-  async (keys: string[]): Promise<TypeWithID[]> => {
+  async (keys: readonly string[]): Promise<TypeWithID[]> => {
     const { payload } = req
 
     // Create docs array of same length as keys, using null as value
@@ -47,7 +46,7 @@ const batchAndLoadDocs =
     *
     **/
 
-    const batchByFindArgs = {}
+    const batchByFindArgs: Record<string, string[]> = {}
 
     for (const key of keys) {
       const [

packages/payload/src/collections/operations/delete.ts

@@ -1,4 +1,3 @@
-// @ts-strict-ignore
 import { status as httpStatus } from 'http-status'
 
 import type { AccessResult } from '../../config/types.js'
@@ -271,7 +270,7 @@ export const deleteOperation = async <
       } catch (error) {
         errors.push({
           id: doc.id,
-          message: error.message,
+          message: error instanceof Error ? error.message : 'Unknown error',
         })
       }
       return null

packages/payload/src/collections/operations/findVersions.ts

@@ -1,4 +1,4 @@
-// @ts-strict-ignore
+import type { AccessResult } from '../../config/types.js'
 import type { PaginatedDocs } from '../../database/types.js'
 import type { PayloadRequest, PopulateType, SelectType, Sort, Where } from '../../types/index.js'
 import type { TypeWithVersion } from '../../versions/types.js'
@@ -54,7 +54,7 @@ export const findVersionsOperation = async <TData extends TypeWithVersion<TData>
     // Access
     // /////////////////////////////////////
 
-    let accessResults
+    let accessResults!: AccessResult
 
     if (!overrideAccess) {
       accessResults = await executeAccess({ req }, collectionConfig.access.readVersions)