refactor: Restructuring the utils functions

Author: CrawlerCode

packages/payload-authjs/src/authjs/PayloadAdapter.ts

@@ -6,8 +6,8 @@ import type {
   VerificationToken as AdapterVerificationToken,
 } from "next-auth/adapters";
 import { type CollectionSlug, getPayload, type Payload, type SanitizedConfig } from "payload";
-import type { Account, Session, User, VerificationToken } from "../payload/types";
-import { isDate } from "../utils/authjs";
+import type { Account, Session, User, VerificationToken } from "./types";
+import { transformObject } from "./utils/transformObject";
 
 export interface PayloadAdapterOptions {
   /**
@@ -453,30 +453,3 @@ function toAdapterVerificationToken(
     ...transformObject<VerificationToken, Omit<AdapterVerificationToken, "identifier">>(token),
   };
 }
-
-/**
- * Transform an object to an object that can be used by the adapter
- *
- * @param object Object to transform
- * @param exclude List of keys to remove from the object
- * @returns The transformed object
- *
- * @see https://authjs.dev/guides/creating-a-database-adapter#official-adapter-guidelines
- */
-function transformObject<T extends Record<string, unknown>, AdapterObject extends object>(
-  object: T,
-  exclude?: (keyof T)[],
-): AdapterObject {
-  const adapterObject: Record<string, unknown> = {};
-  for (const [key, value] of Object.entries(object)) {
-    if (exclude?.includes(key)) {
-      continue;
-    }
-    if (isDate(value)) {
-      adapterObject[key] = new Date(value);
-    } else {
-      adapterObject[key] = value;
-    }
-  }
-  return adapterObject as AdapterObject;
-}

packages/payload-authjs/src/authjs/types.ts

@@ -1,3 +1,41 @@
+export interface User {
+  id: string;
+  email: string;
+  name?: string | null;
+  image?: string | null;
+  emailVerified?: string | null;
+  accounts?: Account[] | null;
+  sessions?: Session[] | null;
+  verificationTokens?: VerificationToken[] | null;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [key: string]: any;
+}
+
+export interface Account {
+  id?: string | null;
+  provider: string;
+  providerAccountId: string;
+  type: string;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [key: string]: any;
+}
+
+export interface Session {
+  id?: string | null;
+  sessionToken: string;
+  expires: string;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [key: string]: any;
+}
+
+export interface VerificationToken {
+  id?: string | null;
+  token: string;
+  expires: string;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [key: string]: any;
+}
+
 /**
  * Helper type to extract the user type from the collection user type.
  *

packages/payload-authjs/src/authjs/utils/config.ts

@@ -0,0 +1,17 @@
+import type { NextAuthConfig } from "next-auth";
+
+/**
+ * Check if an email provider is available in the authjs config
+ */
+export const isEmailProviderAvailable = (authjsConfig: NextAuthConfig) => {
+  return authjsConfig.providers?.some(
+    provider => (typeof provider === "function" ? provider().type : provider.type) === "email",
+  );
+};
+
+/**
+ * Check if the authjs session strategy is database
+ */
+export const isSessionStrategyDatabase = (authjsConfig: NextAuthConfig) => {
+  return authjsConfig.session?.strategy === "database";
+};

packages/payload-authjs/src/authjs/utils/transformObject.ts

@@ -0,0 +1,35 @@
+// https://github.com/honeinc/is-iso-date/blob/8831e79b5b5ee615920dcb350a355ffc5cbf7aed/index.js#L5
+const isoDateRE =
+  // eslint-disable-next-line regexp/no-unused-capturing-group
+  /(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+([+-][0-2]\d:[0-5]\d|Z))|(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z))|(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z))/;
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const isDate = (val: any): val is ConstructorParameters<typeof Date>[0] =>
+  !!(val && isoDateRE.test(val) && !isNaN(Date.parse(val)));
+
+/**
+ * Transform an object to an object that can be used by the adapter
+ *
+ * @param object Object to transform
+ * @param exclude List of keys to remove from the object
+ * @returns The transformed object
+ *
+ * @see https://authjs.dev/guides/creating-a-database-adapter#official-adapter-guidelines
+ */
+export const transformObject = <T extends Record<string, unknown>, AdapterObject extends object>(
+  object: T,
+  exclude?: (keyof T)[],
+): AdapterObject => {
+  const adapterObject: Record<string, unknown> = {};
+  for (const [key, value] of Object.entries(object)) {
+    if (exclude?.includes(key)) {
+      continue;
+    }
+    if (isDate(value)) {
+      adapterObject[key] = new Date(value);
+    } else {
+      adapterObject[key] = value;
+    }
+  }
+  return adapterObject as AdapterObject;
+};

packages/payload-authjs/src/payload/AuthjsAuthStrategy.ts

@@ -1,9 +1,9 @@
 import NextAuth from "next-auth";
 import type { AuthStrategy, CollectionConfig, User as PayloadUser } from "payload";
 import { withPayload } from "../authjs/withPayload";
-import { getUserAttributes } from "../utils/authjs";
-import { getAllVirtualFields } from "../utils/payload";
 import type { AuthjsPluginConfig } from "./plugin";
+import { getAllVirtualFields } from "./utils/getAllVirtualFields";
+import { getUserAttributes } from "./utils/getUserAttributes";
 
 /**
  * Auth.js Authentication Strategy for Payload CMS

packages/payload-authjs/src/payload/collection/hooks/me.ts

@@ -1,9 +1,9 @@
 import NextAuth from "next-auth";
 import type { CollectionConfig, CollectionMeHook } from "payload";
 import { withPayload } from "../../../authjs/withPayload";
-import { getUserAttributes } from "../../../utils/authjs";
-import { getAllVirtualFields } from "../../../utils/payload";
 import type { AuthjsPluginConfig } from "../../plugin";
+import { getAllVirtualFields } from "../../utils/getAllVirtualFields";
+import { getUserAttributes } from "../../utils/getUserAttributes";
 
 /**
  * Add me hook to override the me endpoint to include virtual fields

packages/payload-authjs/src/payload/collection/index.ts

@@ -1,8 +1,8 @@
 import type { CollectionConfig, TabsField } from "payload";
-import { isEmailProviderAvailable, isSessionStrategyDatabase } from "../../utils/authjs";
-import { mergeFields } from "../../utils/payload";
+import { isEmailProviderAvailable, isSessionStrategyDatabase } from "../../authjs/utils/config";
 import { AuthjsAuthStrategy } from "../AuthjsAuthStrategy";
 import type { AuthjsPluginConfig } from "../plugin";
+import { mergeFields } from "../utils/mergeFields";
 import { defaultAccess } from "./access";
 import { logoutEndpoint } from "./endpoints/logout";
 import { accountsField } from "./fields/accounts";

packages/payload-authjs/src/payload/types.ts

@@ -0,0 +1,26 @@
+import { type Field } from "payload";
+import { fieldAffectsData, fieldIsVirtual } from "payload/shared";
+
+/**
+ * Get all virtual fields from a list of fields (including subfields and tabs)
+ *
+ * @param fields The fields list
+ * @returns The virtual fields
+ */
+export const getAllVirtualFields = (fields: Field[]): Field[] => {
+  return fields.reduce((acc, field) => {
+    if ("fields" in field && !fieldAffectsData(field)) {
+      // Get virtual fields from subfields if field not affecting data (e.g. row)
+      acc.push(...getAllVirtualFields(field.fields));
+    } else if (field.type === "tabs") {
+      // For each tab, get the virtual fields
+      for (const tab of field.tabs) {
+        acc.push(...getAllVirtualFields(tab.fields));
+      }
+    } else if (fieldIsVirtual(field)) {
+      // Add virtual field
+      acc.push(field);
+    }
+    return acc;
+  }, [] as Field[]);
+};

packages/payload-authjs/src/payload/utils/getAllVirtualFields.ts

@@ -0,0 +1,20 @@
+import type { User as AuthjsUser } from "next-auth";
+import type { Field } from "payload";
+
+/**
+ * Get user attributes from a user object based on the fields
+ *
+ * @param user User object
+ * @param fields Fields to get from the user object
+ * @returns Object with specified fields from the user object
+ */
+export const getUserAttributes = (user: AuthjsUser, fields: Field[]) => {
+  return fields.reduce((acc: Partial<AuthjsUser>, field) => {
+    if ("name" in field) {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      const val = user[field.name as keyof AuthjsUser] as any;
+      acc[field.name as keyof AuthjsUser] = val;
+    }
+    return acc;
+  }, {});
+};