From 25f2aad4760445de50ff3be5ea6aa93cb8bfdacc Mon Sep 17 00:00:00 2001 From: Moses Date: Mon, 29 Sep 2025 15:05:11 +0100 Subject: [PATCH 1/4] fix: Turn into payload plugin --- src/utils/payload-assist.ts | 49 ++++++++++++++++++------------------- 1 file changed, 24 insertions(+), 25 deletions(-) diff --git a/src/utils/payload-assist.ts b/src/utils/payload-assist.ts index 925fa49..ecc4cf0 100644 --- a/src/utils/payload-assist.ts +++ b/src/utils/payload-assist.ts @@ -1,6 +1,6 @@ import { PayloadAssistConfig, PayloadAssistOptions } from "../types/config"; import payloadAssistDefaultConfig from "../default.config"; -import { buildConfig, Config as PayloadConfig } from "payload"; +import { buildConfig, Config as PayloadConfig, Plugin } from "payload"; export { payloadAssistDefaultConfig as defaultConfig }; @@ -12,33 +12,32 @@ export let payloadAssistConfig: PayloadAssistConfig | undefined = undefined; * @param options - The options to cusotmize payloadAssist. * @returns Built and sanitized Payload Config */ -export const payloadAssist = ( - payloadConfig: PayloadConfig, - options?: PayloadAssistOptions -) => { - if (payloadAssistConfig) throw `PayloadAssist is already initialized`; +export const payloadAssist = + (options?: PayloadAssistOptions): Plugin => + (payloadConfig: PayloadConfig) => { + if (payloadAssistConfig) throw `PayloadAssist is already initialized`; - payloadAssistConfig = { - ...payloadAssistDefaultConfig, - ...(options ?? {}), - }; + payloadAssistConfig = { + ...payloadAssistDefaultConfig, + ...(options ?? {}), + }; - Object.entries(payloadAssistConfig.ruleSet).reduce( - (payloadConfig, [ruleName, rule]) => { - try { - if (rule === false) return payloadConfig; // rule is deactivated, so we skip it - if (!rule(payloadConfig)) - throw `The payload config does not satisfy "${ruleName}".`; - } catch (error) { - throw `[PayloadAssist Error]: ${ruleName}: ${error}`; - } - return payloadConfig; - }, - payloadConfig - ); + Object.entries(payloadAssistConfig.ruleSet).reduce( + (payloadConfig, [ruleName, rule]) => { + try { + if (rule === false) return payloadConfig; // rule is deactivated, so we skip it + if (!rule(payloadConfig)) + throw `The payload config does not satisfy "${ruleName}".`; + } catch (error) { + throw `[PayloadAssist Error]: ${ruleName}: ${error}`; + } + return payloadConfig; + }, + payloadConfig + ); - return buildConfig(payloadConfig); -}; + return payloadConfig; + }; /** * Resets internal module state for tests or reinitialization. From 51ad3b718e6d4027e6d6d4b11013f6631825398a Mon Sep 17 00:00:00 2001 From: Moses Date: Mon, 29 Sep 2025 15:08:11 +0100 Subject: [PATCH 2/4] fix: remove unnecessary import --- src/utils/payload-assist.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/utils/payload-assist.ts b/src/utils/payload-assist.ts index ecc4cf0..fde93e8 100644 --- a/src/utils/payload-assist.ts +++ b/src/utils/payload-assist.ts @@ -1,6 +1,6 @@ import { PayloadAssistConfig, PayloadAssistOptions } from "../types/config"; import payloadAssistDefaultConfig from "../default.config"; -import { buildConfig, Config as PayloadConfig, Plugin } from "payload"; +import { Config as PayloadConfig, Plugin } from "payload"; export { payloadAssistDefaultConfig as defaultConfig }; From f34e4c678cc6ce38778963e82eee7eda853a8a58 Mon Sep 17 00:00:00 2001 From: connyscode Date: Tue, 30 Sep 2025 10:44:56 +0200 Subject: [PATCH 3/4] ci: remove tests --- .github/workflows/pr-to-development.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/workflows/pr-to-development.yml b/.github/workflows/pr-to-development.yml index f8eba15..5c6414b 100644 --- a/.github/workflows/pr-to-development.yml +++ b/.github/workflows/pr-to-development.yml @@ -24,9 +24,6 @@ jobs: - name: Install dependencies run: yarn install --frozen-lockfile - - name: Run Tests - run: yarn test - - name: Run TypeScript compilation run: yarn build From dedfa73b79e57a5179de421e677d4dc467ce9ffd Mon Sep 17 00:00:00 2001 From: connyscode Date: Tue, 30 Sep 2025 10:47:42 +0200 Subject: [PATCH 4/4] readme: update readme --- README.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index c463f6c..f4787cb 100644 --- a/README.md +++ b/README.md @@ -5,21 +5,23 @@
- - - - Assist for Payload - + + + + + Assist for Payload + + - - - Tests passing - - - - - License MIT - + + + Tests passing + + + + + License MIT +
# Assist for Payload