Skip to content

fix: Turn into payload plugin #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ConnysCode merged 4 commits into from
Sep 30, 2025
Merged

fix: Turn into payload plugin #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
25f2aad
fix: Turn into payload plugin
Sep 29, 2025
51ad3b7
fix: remove unnecessary import
Sep 29, 2025
f34e4c6
ci: remove tests
ConnysCode Sep 30, 2025
dedfa73
readme: update readme
ConnysCode Sep 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .github/workflows/pr-to-development.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
30 changes: 16 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,23 @@
</picture>

<div align="center" style="display: flex; flex-direction: row; justify-content: center; align-items: center; gap: 12px;">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2F@byte5digital%2Fpayload-assist&query=%24%5B%22dist-tags%22%5D.latest&prefix=v&label=NPM&style=for-the-badge&labelColor=ffffff&color=373E45">
<source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2F@byte5digital%2Fpayload-assist&query=%24%5B%22dist-tags%22%5D.latest&prefix=v&label=NPM&style=for-the-badge&labelColor=002634&color=E5E9EB">
<img alt="Assist for Payload" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2F@byte5digital%2Fpayload-assist&query=%24%5B%22dist-tags%22%5D.latest&prefix=v&label=NPM&style=for-the-badge&labelColor=002634&color=E5E9EB">
</picture>
<a href="https://www.npmjs.com/@byte5digital/payload-assist">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2F@byte5digital%2Fpayload-assist&query=%24%5B%22dist-tags%22%5D.latest&prefix=v&label=NPM&style=for-the-badge&labelColor=ffffff&color=373E45">
<source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2F@byte5digital%2Fpayload-assist&query=%24%5B%22dist-tags%22%5D.latest&prefix=v&label=NPM&style=for-the-badge&labelColor=002634&color=E5E9EB">
<img alt="Assist for Payload" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2F@byte5digital%2Fpayload-assist&query=%24%5B%22dist-tags%22%5D.latest&prefix=v&label=NPM&style=for-the-badge&labelColor=002634&color=E5E9EB">
</picture>
</a>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/badge/TESTS-PASSING-empty?style=for-the-badge&labelColor=ffffff&color=373E45">
<source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/badge/TESTS-PASSING-empty?style=for-the-badge&labelColor=002634&color=E5E9EB">
<img alt="Tests passing" src="https://img.shields.io/badge/TESTS-PASSING-empty?style=for-the-badge&labelColor=002634&color=E5E9EB">
</picture>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/badge/LICENSE-MIT-empty?style=for-the-badge&labelColor=ffffff&color=373E45">
<source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/badge/LICENSE-MIT-empty?style=for-the-badge&labelColor=002634&color=E5E9EB">
<img alt="License MIT" src="https://img.shields.io/badge/LICENSE-MIT-empty?style=for-the-badge&labelColor=002634&color=E5E9EB">
</picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/badge/TESTS-PASSING-empty?style=for-the-badge&labelColor=ffffff&color=373E45">
<source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/badge/TESTS-PASSING-empty?style=for-the-badge&labelColor=002634&color=E5E9EB">
<img alt="Tests passing" src="https://img.shields.io/badge/TESTS-PASSING-empty?style=for-the-badge&labelColor=002634&color=E5E9EB">
</picture>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/badge/LICENSE-MIT-empty?style=for-the-badge&labelColor=ffffff&color=373E45">
<source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/badge/LICENSE-MIT-empty?style=for-the-badge&labelColor=002634&color=E5E9EB">
<img alt="License MIT" src="https://img.shields.io/badge/LICENSE-MIT-empty?style=for-the-badge&labelColor=002634&color=E5E9EB">
</picture>
</div>

# Assist for Payload
Expand Down
49 changes: 24 additions & 25 deletions src/utils/payload-assist.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { PayloadAssistConfig, PayloadAssistOptions } from "../types/config";
import payloadAssistDefaultConfig from "../default.config";
import { buildConfig, Config as PayloadConfig } from "payload";
import { Config as PayloadConfig, Plugin } from "payload";

export { payloadAssistDefaultConfig as defaultConfig };

Expand All @@ -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.
Expand Down