Skip to content

fix: replace record with updates in updateResourceRecord method #408

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 2 commits into from
Oct 24, 2025
Merged

fix: replace record with updates in updateResourceRecord method #408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
172fc0e
fix: replace record with updates in updateResourceRecord method
yaroslav8765 Oct 23, 2025
102bd40
fix: warn about deprecated 'record' parameter in updateResourceRecord…
yaroslav8765 Oct 24, 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
30 changes: 18 additions & 12 deletions adminforth/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -593,27 +593,33 @@ class AdminForth implements IAdminForth {
* record is partial record with only changed fields
*/
async updateResourceRecord(
{ resource, recordId, record, oldRecord, adminUser, extra }:
{ resource: AdminForthResource, recordId: any, record: any, oldRecord: any, adminUser: AdminUser, extra?: HttpExtra }
{ resource, recordId, record, oldRecord, adminUser, extra, updates }:
| { resource: AdminForthResource, recordId: any, record: any, oldRecord: any, adminUser: AdminUser, extra?: HttpExtra, updates?: never }
| { resource: AdminForthResource, recordId: any, record?: never, oldRecord: any, adminUser: AdminUser, extra?: HttpExtra, updates: any }
): Promise<{ error?: string }> {
const err = this.validateRecordValues(resource, record, 'edit');
const dataToUse = updates || record;
Copy link
Contributor

@ivictbor ivictbor Oct 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lets add

if (record) {
   console.warn('updateResourceRecord function received 'record' param which is deprecated and will be removed in future version, please use 'updates' instead.'
}

const err = this.validateRecordValues(resource, dataToUse, 'edit');
if (err) {
return { error: err };
}

if (record) {
console.warn(`updateResourceRecord function received 'record' param which is deprecated and will be removed in future version, please use 'updates' instead.`);
}

// remove editReadonly columns from record
for (const column of resource.columns.filter((col) => col.editReadonly)) {
if (column.name in record)
delete record[column.name];
if (column.name in dataToUse)
delete dataToUse[column.name];
}

// execute hook if needed
for (const hook of listify(resource.hooks?.edit?.beforeSave)) {
const resp = await hook({
recordId,
resource,
record,
updates: record,
record: dataToUse,
updates: dataToUse,
oldRecord,
adminUser,
adminforth: this,
Expand All @@ -633,13 +639,13 @@ class AdminForth implements IAdminForth {
const newValues = {};
const connector = this.connectors[resource.dataSource];

for (const recordField in record) {
if (record[recordField] !== oldRecord[recordField]) {
for (const recordField in dataToUse) {
if (dataToUse[recordField] !== oldRecord[recordField]) {
// leave only changed fields to reduce data transfer/modifications in db
const column = resource.columns.find((col) => col.name === recordField);
if (!column || !column.virtual) {
// exclude virtual columns
newValues[recordField] = record[recordField];
newValues[recordField] = dataToUse[recordField];
}
}
}
Expand All @@ -652,8 +658,8 @@ class AdminForth implements IAdminForth {
for (const hook of listify(resource.hooks?.edit?.afterSave)) {
const resp = await hook({
resource,
record,
updates: record,
record: dataToUse,
updates: dataToUse,
adminUser,
oldRecord,
recordId,
Expand Down
3 changes: 2 additions & 1 deletion adminforth/types/Back.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,8 @@ export interface IAdminForth {
): Promise<{ error?: string, createdRecord?: any, newRecordId?: any }>;

updateResourceRecord(
params: { resource: AdminForthResource, recordId: any, record: any, oldRecord: any, adminUser: AdminUser, extra?: HttpExtra }
params: { resource: AdminForthResource, recordId: any, record: any, oldRecord: any, adminUser: AdminUser, extra?: HttpExtra, updates?: never }
| { resource: AdminForthResource, recordId: any, record?: never, oldRecord: any, adminUser: AdminUser, extra?: HttpExtra, updates: any }
): Promise<{ error?: string }>;

deleteResourceRecord(
Expand Down