Skip to content

fix: allow virtual columns to be grouped #138

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
merged 1 commit into from
Mar 10, 2025
Merged

fix: allow virtual columns to be grouped #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 0 additions & 29 deletions adminforth/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,29 +207,6 @@ class AdminForth implements IAdminForth {
return plugins[0] as T;
}

validateFieldGroups(fieldGroups: {
groupName: string;
columns: string[];
}[], fieldTypes: {
[key: string]: AdminForthResourceColumn;
}): void {
if (!fieldGroups) return;
const allColumns = Object.keys(fieldTypes);

fieldGroups.forEach((group) => {
group.columns.forEach((col) => {
if (!allColumns.includes(col)) {
const similar = suggestIfTypo(allColumns, col);
throw new Error(
`Group '${group.groupName}' has an unknown column '${col}'. ${
similar ? `Did you mean '${similar}'?` : ''
}`
);
}
});
});
}

validateRecordValues(resource: AdminForthResource, record: any): any {
// check if record with validation is valid
for (const column of resource.columns.filter((col) => col.name in record && col.validation)) {
Expand Down Expand Up @@ -341,12 +318,6 @@ class AdminForth implements IAdminForth {
// first find discovered values, but allow override
res.columns[i] = { ...fieldTypes[col.name], ...col };
});

this.validateFieldGroups(res.options.fieldGroups, fieldTypes);
this.validateFieldGroups(res.options.showFieldGroups, fieldTypes);
this.validateFieldGroups(res.options.createFieldGroups, fieldTypes);
this.validateFieldGroups(res.options.editFieldGroups, fieldTypes);


// check if primaryKey column is present
if (!res.columns.some((col) => col.primaryKey)) {
Expand Down
25 changes: 25 additions & 0 deletions adminforth/modules/configValidator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,25 @@ export default class ConfigValidator implements IConfigValidator {
return showInTransformedToObject as ShowIn;
}

validateFieldGroups(fieldGroups: {
groupName: string;
columns: string[];
}[], resourceColumns: string[]): void {
if (!fieldGroups) return;

fieldGroups.forEach((group) => {
group.columns.forEach((col) => {
if (!resourceColumns.includes(col)) {
const similar = suggestIfTypo(resourceColumns, col);
throw new Error(
`Group '${group.groupName}' has an unknown column '${col}'. ${similar ? `Did you mean '${similar}'?` : ''
}`
);
}
});
});
}

validateAndNormalizeCustomActions(resInput: AdminForthResourceInput, res: Partial<AdminForthResource>, errors: string[]): any[] {
if (!resInput.options?.actions) {
return [];
Expand Down Expand Up @@ -671,6 +690,12 @@ export default class ConfigValidator implements IConfigValidator {
options.bulkActions = this.validateAndNormalizeBulkActions(resInput, res, errors);
options.actions = this.validateAndNormalizeCustomActions(resInput, res, errors);

const allColumnsList = res.columns.map((col) => col.name);
this.validateFieldGroups(options.fieldGroups, allColumnsList);
this.validateFieldGroups(options.showFieldGroups, allColumnsList);
this.validateFieldGroups(options.createFieldGroups, allColumnsList);
this.validateFieldGroups(options.editFieldGroups, allColumnsList);

// if pageInjection is a string, make array with one element. Also check file exists
const possibleInjections = ['beforeBreadcrumbs', 'afterBreadcrumbs', 'bottom', 'threeDotsDropdownItems', 'customActionIcons'];
const possiblePages = ['list', 'show', 'create', 'edit'];
Expand Down