Skip to content

Add zod schemas #17

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
yaroslav8765 merged 4 commits into from
Jul 1, 2026
Merged

Add zod schemas #17

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
b1b97b7
feat: add zod request body validation to plugin API endpoints
yaroslav8765 Jun 30, 2026
c1ec39b
fix: return request body validation errors as JSON
yaroslav8765 Jun 30, 2026
3d17b47
fix: update adminforth version
yaroslav8765 Jun 30, 2026
535e14e
refactor: import parseBody from adminforth instead of redefining it
yaroslav8765 Jun 30, 2026
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
36 changes: 29 additions & 7 deletions index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
import { AdminForthPlugin, suggestIfTypo, AdminForthFilterOperators, Filters, AdminForthDataTypes, rejectApiRawFilters, interpretResource, ActionCheckSource, AllowedActionsEnum } from "adminforth";
import { AdminForthPlugin, parseBody, suggestIfTypo, AdminForthFilterOperators, Filters, AdminForthDataTypes, rejectApiRawFilters, interpretResource, ActionCheckSource, AllowedActionsEnum } from "adminforth";
import type { IAdminForth, IHttpServer, AdminForthResourceColumn, AdminForthComponentDeclaration, AdminForthResource, AdminUser } from "adminforth";
import type { PluginOptions } from './types.js';
import pLimit from 'p-limit';
import { z } from "zod";

const exportCsvBodySchema = z.object({
filters: z.any(),
sort: z.any(),
}).strict();

const importCsvBodySchema = z.object({
data: z.record(z.string(), z.array(z.unknown())),
}).strict();

export default class ImportExport extends AdminForthPlugin {
options: PluginOptions;
Expand Down Expand Up @@ -127,8 +137,11 @@ export default class ImportExport extends AdminForthPlugin {
server.endpoint({
method: 'POST',
path: `/plugin/${this.pluginInstanceId}/export-csv`,
handler: async ({ body, adminUser, headers }) => {
const { filters, sort } = body;
handler: async ({ body, adminUser, headers, response }) => {
const parsed = parseBody(exportCsvBodySchema, body, response);
if ('error' in parsed) return parsed.error;
const payload = parsed.data;
const { filters, sort } = payload;
if (!filters || !sort) {
return { ok: false, error: 'Missing filters or sort in request body' };
}
Expand Down Expand Up @@ -186,7 +199,10 @@ export default class ImportExport extends AdminForthPlugin {
method: 'POST',
path: `/plugin/${this.pluginInstanceId}/import-csv`,
handler: async ({ body, adminUser, query, headers, cookies, requestUrl, response }) => {
const { data } = body;
const parsed = parseBody(importCsvBodySchema, body, response);
if ('error' in parsed) return parsed.error;
const payload = parsed.data;
const { data } = payload;
if (!data || typeof data !== 'object') {
return { ok: false, error: 'Invalid data format. Expected an object with column names as keys and arrays of values as values.' };
}
Expand Down Expand Up @@ -268,7 +284,10 @@ export default class ImportExport extends AdminForthPlugin {
method: 'POST',
path: `/plugin/${this.pluginInstanceId}/import-csv-new-only`,
handler: async ({ body, adminUser, query, headers, cookies, requestUrl, response }) => {
const { data } = body;
const parsed = parseBody(importCsvBodySchema, body, response);
if ('error' in parsed) return parsed.error;
const payload = parsed.data;
const { data } = payload;
if (!data || typeof data !== 'object') {
return { ok: false, error: 'Invalid data format. Expected an object with column names as keys and arrays of values as values.' };
}
Expand Down Expand Up @@ -328,7 +347,10 @@ export default class ImportExport extends AdminForthPlugin {
server.endpoint({
method: 'POST',
path: `/plugin/${this.pluginInstanceId}/check-records`,
handler: async ({ body, adminUser }) => {
handler: async ({ body, adminUser, response }) => {
const parsed = parseBody(importCsvBodySchema, body, response);
if ('error' in parsed) return parsed.error;
const payload = parsed.data;
const access = await this.ensureAnyAllowed(
adminUser,
[
Expand All @@ -340,7 +362,7 @@ export default class ImportExport extends AdminForthPlugin {
if (!access.ok) {
return { ok: false, error: access.error };
}
const { data } = body as { data: Record<string, unknown[]> };
const { data } = payload;
const primaryKeyColumn = this.resourceConfig.columns.find(col => col.primaryKey);
const columns = this.getColumnNames(data);
const rows = this.buildRowsFromData(data, columns, undefined, { coerceTypes: false });
Expand Down
7 changes: 4 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@
"license": "MIT",
"description": "CSV import/export plugin for adminforth",
"peerDependencies": {
"adminforth": "^3.6.21"
"adminforth": "^3.7.1"
},
"devDependencies": {
"@types/node": "^22.10.7",
"adminforth": "^3.6.21",
"adminforth": "^3.7.1",
"semantic-release": "^24.2.1",
"semantic-release-slack-bot": "^4.0.2",
"typescript": "^5.7.3"
Expand Down Expand Up @@ -60,6 +60,7 @@
]
},
"dependencies": {
"p-limit": "^7.3.0"
"p-limit": "^7.3.0",
"zod": "^4.3.6"
}
}
19 changes: 11 additions & 8 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.