fix(tsconfig): type fixes and implement ci check (#337)

thompsonsj · web-flow · commit 6f4e06a3ff76 · 2026-04-17T15:42:17.000+01:00
* fix(tsconfig): type fixes and implement ci check

* fix(helpers): getCollectionConfig now throws instead of undefined

* fix(tsconfig): install @types/nodemailer to restore type safety
diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml
@@ -24,4 +24,8 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: "npm"
       - run: npm install
+      - name: Typecheck (plugin build)
+        run: npx nx run plugin:build
+      - name: Typecheck (plugin unit tests)
+        run: npx tsc -p plugin/tsconfig.spec.json --noEmit
       - run: npm run test
diff --git a/dev-alternative-config/tsconfig.json b/dev-alternative-config/tsconfig.json
@@ -1,6 +1,7 @@
 {
   "compilerOptions": {
     "baseUrl": ".",
+    "ignoreDeprecations": "6.0",
     "lib": ["DOM", "DOM.Iterable", "ES2022"],
     "allowJs": true,
     "skipLibCheck": true,
@@ -19,9 +20,9 @@
       }
     ],
     "paths": {
-      "@/*": ["./src/*"],
-      "@payload-config": ["./src/payload.config.ts"],
-      "payload-crowdin-sync": ["./../plugin/src/index.ts"]
+      "@/*": ["src/*"],
+      "@payload-config": ["src/payload.config.ts"],
+      "payload-crowdin-sync": ["../plugin/src/index.ts"]
     },
     "target": "ES2022"
   },
diff --git a/dev-alternative-config/tsconfig.lib.json b/dev-alternative-config/tsconfig.lib.json
@@ -0,0 +1,21 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../dist/out-tsc/dev-alternative-config",
+    "rootDir": ".",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "noEmit": false,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts", "src/**/*.tsx"],
+  "exclude": [
+    "node_modules",
+    "**/*.spec.ts",
+    "**/*.test.ts",
+    "**/*.spec.tsx",
+    "**/*.test.tsx",
+    "src/tests/**"
+  ]
+}
diff --git a/dev/src/payload.config.ts b/dev/src/payload.config.ts
@@ -62,7 +62,7 @@ export default buildConfig({
         'posts',
         {
           slug: 'localized-posts-with-condition',
-          condition: ({ doc }) => doc.translateWithCrowdin,
+          condition: ({ doc }: { doc: any }) => doc.translateWithCrowdin,
         },
         'tags',
         'users',
diff --git a/dev/src/payloadcms-next-css.d.ts b/dev/src/payloadcms-next-css.d.ts
@@ -0,0 +1,2 @@
+declare module '@payloadcms/next/css'
+
diff --git a/dev/src/type-checkers.ts b/dev/src/type-checkers.ts
@@ -1,4 +1,4 @@
-import { Field, RichTextField } from 'payload/types'
+import type { Field, RichTextField } from 'payload'
 
 export const isRichTextField = (val: Field | string | undefined | null): val is RichTextField => {
   return val !== undefined && val !== null && typeof val !== 'string'
diff --git a/dev/tsconfig.json b/dev/tsconfig.json
@@ -1,6 +1,7 @@
 {
   "compilerOptions": {
     "baseUrl": ".",
+    "ignoreDeprecations": "6.0",
     "lib": ["DOM", "DOM.Iterable", "ES2022"],
     "allowJs": true,
     "skipLibCheck": true,
@@ -19,9 +20,9 @@
       }
     ],
     "paths": {
-      "@/*": ["./src/*"],
-      "@payload-config": ["./src/payload.config.ts"],
-      "payload-crowdin-sync": ["./../plugin/src/index.ts"]
+      "@/*": ["src/*"],
+      "@payload-config": ["src/payload.config.ts"],
+      "payload-crowdin-sync": ["../plugin/src/index.ts"]
     },
     "target": "ES2022"
   },
diff --git a/dev/tsconfig.lib.json b/dev/tsconfig.lib.json
@@ -0,0 +1,21 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../dist/out-tsc/dev",
+    "rootDir": ".",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "noEmit": false,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts", "src/**/*.tsx"],
+  "exclude": [
+    "node_modules",
+    "**/*.spec.ts",
+    "**/*.test.ts",
+    "**/*.spec.tsx",
+    "**/*.test.tsx",
+    "src/tests/**"
+  ]
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -48,6 +48,7 @@
     "@types/deep-equal": "^1.0.4",
     "@types/express": "^5.0.6",
     "@types/node": "^25.6.0",
+    "@types/nodemailer": "^7.0.4",
     "@types/react": "19.2.14",
     "@types/react-dom": "19.2.3",
     "@typescript-eslint/eslint-plugin": "8.58.2",
diff --git a/plugin/project.json b/plugin/project.json
@@ -11,7 +11,7 @@
       "options": {
         "outputPath": "dist/plugin",
         "main": "plugin/src/index.ts",
-        "tsConfig": "plugin/tsconfig.json",
+        "tsConfig": "plugin/tsconfig.build.json",
         "assets": ["plugin/*.md"],
         "updateBuildableProjectDepsInPackageJson": true
       }
diff --git a/plugin/src/lib/api/files/by-document.ts b/plugin/src/lib/api/files/by-document.ts
@@ -141,18 +141,25 @@ export class filesApiByDocument {
           collectionSlug: this.global ? 'globals' : this.collectionSlug,
         });
 
-      const parent = isCrowdinArticleDirectory(this.parent)
-        ? this.parent
-        : this.parent &&
-          ((await this.req.payload.findByID({
-            collection: 'crowdin-article-directories',
-            id: this.parent,
-            req: this.req,
-          })) as CrowdinArticleDirectory);
+      const parent =
+        isCrowdinArticleDirectory(this.parent) ? this.parent : undefined;
+      const parentId =
+        typeof this.parent === 'string' && this.parent.length > 0
+          ? this.parent
+          : undefined;
+      const resolvedParent =
+        parent ??
+        (parentId
+          ? ((await this.req.payload.findByID({
+              collection: 'crowdin-article-directories',
+              id: parentId,
+              req: this.req,
+            })) as CrowdinArticleDirectory)
+          : undefined);
 
       // Create article directory on Crowdin
       const name = this.global ? this.collectionSlug : this.document.id;
-      let collectionConfig: CollectionConfig | GlobalConfig;
+      let collectionConfig: CollectionConfig | GlobalConfig | undefined;
       try {
         // Lexical block syncing uses an internal "mock" collection config to
         // avoid requiring a real collection definition for derived block fields.
@@ -170,11 +177,11 @@ export class filesApiByDocument {
           console.log(error);
         }
       }
-      const useAsTitle = (collectionConfig as CollectionConfig)?.admin
-        ?.useAsTitle;
+      const useAsTitle = (collectionConfig as CollectionConfig | undefined)
+        ?.admin?.useAsTitle;
 
       crowdinPayloadArticleDirectory = await this.crowdinFindOrCreateDirectory({
-        parent,
+        parent: resolvedParent,
         crowdinPayloadCollectionDirectory,
         name,
         useAsTitle,
@@ -282,7 +289,7 @@ export class filesApiByDocument {
       crowdinPayloadCollectionDirectory = query.docs[0];
     }
 
-    return crowdinPayloadCollectionDirectory;
+    return crowdinPayloadCollectionDirectory as CrowdinCollectionDirectory;
   }
 
   /**
diff --git a/plugin/src/lib/api/helpers.ts b/plugin/src/lib/api/helpers.ts
@@ -23,7 +23,7 @@ export const getCollectionConfig = (
   collection: string,
   global: boolean,
   payload: Payload,
-): CollectionConfig | GlobalConfig => {
+): CollectionConfig | GlobalConfig | undefined => {
   let collectionConfig:
     | SanitizedGlobalConfig
     | SanitizedCollectionConfig
@@ -116,7 +116,7 @@ export async function getLexicalFieldArticleDirectories({
 }) {
   const where =
     parent === undefined
-      ? {}
+      ? undefined
       : {
           parent: {
             equals: isCrowdinArticleDirectory(parent) ? parent?.id : parent,
diff --git a/plugin/src/lib/api/translations.ts b/plugin/src/lib/api/translations.ts
@@ -274,7 +274,7 @@ export class payloadCrowdinSyncTranslationsApi {
   getCollectionConfig(
     collection: string,
     global: boolean,
-  ): CollectionConfig | GlobalConfig {
+  ): CollectionConfig | GlobalConfig | undefined {
     return getCollectionConfig(collection, global, this.payload);
   }
 
@@ -401,6 +401,9 @@ export class payloadCrowdinSyncTranslationsApi {
     } catch (error) {
       console.log(error);
     }
+    if (!collectionConfig) {
+      return { message: 'no localized fields' };
+    }
 
     const localizedFields = collectionConfig
       ? getLocalizedFields({
diff --git a/plugin/src/lib/endpoints/globals/reviewFields.ts b/plugin/src/lib/endpoints/globals/reviewFields.ts
@@ -38,6 +38,9 @@ export const getReviewFieldsEndpoint = ({
               .collectionSlug,
         global,
       );
+      if (!collectionConfig) {
+        return Response.error();
+      }
       const response = {
         fields: collectionConfig.fields,
         localizedFields: getLocalizedFields({
diff --git a/plugin/src/lib/tasks/sync-translation.ts b/plugin/src/lib/tasks/sync-translation.ts
@@ -48,6 +48,9 @@ export const syncTranslations = ({
 
   // This is the function that is run when the task is invoked
   handler: async ({ input, req }) => {
+    if (!input) {
+      throw new Error('Task input is required');
+    }
     const result = await updatePayloadTranslation({
       articleDirectoryId: input.articleDirectoryId,
       pluginOptions,
diff --git a/plugin/src/lib/utilities/lexical/slateTableConverter.ts b/plugin/src/lib/utilities/lexical/slateTableConverter.ts
@@ -28,7 +28,7 @@ export const SlateTableConverter: SlateNodeConverter = {
         canContainParagraphs: false,
         converters,
         parentNodeType: 'table',
-        slateNodes: slateNode.children,
+        slateNodes: slateNode.children ?? [],
       }),
     } as const as SerializedTableNode;
   },
@@ -44,7 +44,7 @@ export const SlateTableRowConverter: SlateNodeConverter = {
         canContainParagraphs: false,
         converters,
         parentNodeType: 'tablerow',
-        slateNodes: slateNode.children,
+        slateNodes: slateNode.children ?? [],
       }),
     } as const as SerializedTableRowNode;
   },
@@ -61,7 +61,7 @@ export const SlateTableCellConverter: SlateNodeConverter = {
         canContainParagraphs: false,
         converters,
         parentNodeType: 'tablecell',
-        slateNodes: slateNode.children,
+        slateNodes: slateNode.children ?? [],
       }),
     } as const as SerializedTableCellNode;
   },
diff --git a/plugin/src/lib/utilities/locales.spec.ts b/plugin/src/lib/utilities/locales.spec.ts
@@ -11,17 +11,17 @@ const localeMap = {
   },
 };
 describe('fn: getOtherLocales', () => {
-  const fixtures = [
+  const fixtures: [string, string[]][] = [
     ['da_DK', ['de_DE', 'fr_FR']],
     ['de_DE', ['da_DK', 'fr_FR']],
     ['fr_FR', ['da_DK', 'de_DE']],
     ['', ['da_DK', 'de_DE', 'fr_FR']],
   ];
-  describe.each(fixtures)(`%s`, (string, result) => {
-    it(`${string} is excluded in returned locales`, () => {
+  describe.each(fixtures)(`%s`, (locale, result) => {
+    it(`${locale} is excluded in returned locales`, () => {
       expect(
         getOtherLocales({
-          locale: string as string,
+          locale: locale as string,
           localeMap,
         }),
       ).toEqual(result);
diff --git a/plugin/src/lib/utilities/richTextConversion.ts b/plugin/src/lib/utilities/richTextConversion.ts
@@ -55,15 +55,16 @@ export const convertLexicalToHtml = async (
   const blockSlugs = getLexicalBlockFields(editorConfig)?.blocks.map(
     (block) => block.slug,
   );
-  const blockConvertors =
-    blockSlugs?.reduce((acc, slug) => {
-      acc[slug] = ({ node }) => {
-        const blockId = node.fields.id;
-        const blockType = node.fields.blockType;
-        return `<span data-block-id=${blockId} data-block-type=${blockType}></span>`;
-      };
-      return acc;
-    }, {}) || {};
+  const blockConvertors = (blockSlugs ?? []).reduce<
+    Record<string, ({ node }: { node: any }) => string>
+  >((acc, slug) => {
+    acc[slug] = ({ node }) => {
+      const blockId = node.fields.id;
+      const blockType = node.fields.blockType;
+      return `<span data-block-id=${blockId} data-block-type=${blockType}></span>`;
+    };
+    return acc;
+  }, {});
 
   /**
    * This is a custom HTML converter for the Upload node type.
diff --git a/plugin/src/tests/vitest.setup.ts b/plugin/src/tests/vitest.setup.ts
@@ -5,7 +5,7 @@ import { vi } from 'vitest'
 // Align with existing Jest setup used in dev installs.
 global.console = console
 
-process.env.NODE_ENV = 'test'
+Object.assign(process.env, { NODE_ENV: 'test' })
 process.env.PAYLOAD_DISABLE_ADMIN = 'true'
 process.env.PAYLOAD_DROP_DATABASE = 'true'
 process.env.PAYLOAD_PUBLIC_CLOUD_STORAGE_ADAPTER = 's3'
diff --git a/plugin/tsconfig.base.json b/plugin/tsconfig.base.json
@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "jsx": "preserve",
+    "skipLibCheck": true
+  }
+}
diff --git a/plugin/tsconfig.build.json b/plugin/tsconfig.build.json
@@ -0,0 +1,17 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true
+  },
+  "include": ["src/**/*.ts", "src/**/*.tsx"],
+  "exclude": [
+    "node_modules",
+    "src/**/*.spec.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.tsx",
+    "src/**/*.test.tsx",
+    "src/tests/**",
+    "src/lib/**/tests/**"
+  ]
+}
diff --git a/plugin/tsconfig.json b/plugin/tsconfig.json
@@ -1,14 +1,3 @@
 {
-  "compilerOptions": {
-    "target": "ESNext",
-    "esModuleInterop": true,
-    "module": "esnext",
-    "moduleResolution": "bundler",
-    "jsx": "preserve",
-    "skipLibCheck": true,
-    "declaration": true,
-    "declarationMap": true
-  },
-  "include": ["src/**/*.ts", "src/**/*.tsx"],
-  "exclude": ["node_modules"]
+  "extends": "./tsconfig.build.json"
 }
diff --git a/plugin/tsconfig.lib.json b/plugin/tsconfig.lib.json
diff --git a/plugin/tsconfig.spec.json b/plugin/tsconfig.spec.json
diff --git a/tsconfig.base.json b/tsconfig.base.json

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ export default buildConfig({`
`62`	`62`	`'posts',`
`63`	`63`	`{`
`64`	`64`	`slug: 'localized-posts-with-condition',`
`65`		`- condition: ({ doc }) => doc.translateWithCrowdin,`
	`65`	`+ condition: ({ doc }: { doc: any }) => doc.translateWithCrowdin,`
`66`	`66`	`},`
`67`	`67`	`'tags',`
`68`	`68`	`'users',`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+declare module '@payloadcms/next/css'`
	`2`	`+`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { Field, RichTextField } from 'payload/types'`
	`1`	`+import type { Field, RichTextField } from 'payload'`
`2`	`2`
`3`	`3`	`export const isRichTextField = (val: Field \| string \| undefined \| null): val is RichTextField => {`
`4`	`4`	`return val !== undefined && val !== null && typeof val !== 'string'`