Skip to content

Allow actions set cookies #441

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

Open
yaroslav8765 wants to merge 2 commits into
base: next
Choose a base branch
from
Open

Allow actions set cookies #441

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
e1c11bd
feat: add possobolity to set cookies from the before/after save hooks
yaroslav8765 Jan 6, 2026
7cb340c
feat: allow to set cookie from the bulkActions
yaroslav8765 Jan 6, 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
21 changes: 14 additions & 7 deletions adminforth/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import {
HttpExtra,
BeforeCreateSaveFunction,
AdminForthInputConfig,
IAdminForthHttpResponse,
} from './types/Back.js';

import {
Expand Down Expand Up @@ -538,8 +539,8 @@ class AdminForth implements IAdminForth {
}

async createResourceRecord(
{ resource, record, adminUser, extra }:
{ resource: AdminForthResource, record: any, adminUser: AdminUser, extra?: HttpExtra }
{ resource, record, adminUser, extra, response }:
{ resource: AdminForthResource, record: any, adminUser: AdminUser, extra?: HttpExtra, response: IAdminForthHttpResponse }
): Promise<{ error?: string, createdRecord?: any, newRecordId?: any }> {

const err = this.validateRecordValues(resource, record, 'create');
Expand All @@ -557,6 +558,7 @@ class AdminForth implements IAdminForth {
record,
adminUser,
adminforth: this,
response,
extra,
});
if (!resp || (typeof resp.ok !== 'boolean' && (!resp.error && !resp.newRecordId))) {
Expand Down Expand Up @@ -602,6 +604,7 @@ class AdminForth implements IAdminForth {
adminUser,
adminforth: this,
recordWithVirtualColumns,
response,
extra,
});

Expand All @@ -621,9 +624,9 @@ class AdminForth implements IAdminForth {
* record is partial record with only changed fields
*/
async updateResourceRecord(
{ 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 }
{ resource, recordId, record, oldRecord, adminUser, response, extra, updates }:
| { resource: AdminForthResource, recordId: any, record: any, oldRecord: any, adminUser: AdminUser, response: IAdminForthHttpResponse, extra?: HttpExtra, updates?: never }
| { resource: AdminForthResource, recordId: any, record?: never, oldRecord: any, adminUser: AdminUser, response: IAdminForthHttpResponse, extra?: HttpExtra, updates: any }
): Promise<{ error?: string }> {
const dataToUse = updates || record;
const err = this.validateRecordValues(resource, dataToUse, 'edit');
Expand Down Expand Up @@ -651,6 +654,7 @@ class AdminForth implements IAdminForth {
oldRecord,
adminUser,
adminforth: this,
response,
extra,
});
if (!resp || typeof resp.ok !== 'boolean') {
Expand Down Expand Up @@ -695,6 +699,7 @@ class AdminForth implements IAdminForth {
oldRecord,
recordId,
adminforth: this,
response,
extra,
});
if (!resp || (!resp.ok && !resp.error)) {
Expand All @@ -709,8 +714,8 @@ class AdminForth implements IAdminForth {
}

async deleteResourceRecord(
{ resource, recordId, adminUser, record, extra }:
{ resource: AdminForthResource, recordId: any, adminUser: AdminUser, record: any, extra?: HttpExtra }
{ resource, recordId, adminUser, record, response, extra }:
{ resource: AdminForthResource, recordId: any, adminUser: AdminUser, record: any, response: IAdminForthHttpResponse, extra?: HttpExtra }
): Promise<{ error?: string }> {
// execute hook if needed
for (const hook of listify(resource.hooks?.delete?.beforeSave)) {
Expand All @@ -720,6 +725,7 @@ class AdminForth implements IAdminForth {
adminUser,
recordId,
adminforth: this,
response,
extra,
});
if (!resp || (!resp.ok && !resp.error)) {
Expand All @@ -742,6 +748,7 @@ class AdminForth implements IAdminForth {
adminUser,
recordId,
adminforth: this,
response,
extra,
});
if (!resp || (!resp.ok && !resp.error)) {
Expand Down
4 changes: 3 additions & 1 deletion adminforth/modules/configValidator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ export default class ConfigValidator implements IConfigValidator {
icon: 'flowbite:trash-bin-outline',
confirm: 'Are you sure you want to delete selected items?',
allowed: async ({ resource, adminUser, allowedActions }) => { return allowedActions.delete },
action: async ({ selectedIds, adminUser }) => {
action: async ({ selectedIds, adminUser, response }) => {
const connector = this.adminforth.connectors[res.dataSource];

// for now if at least one error, stop and return error
Expand All @@ -267,6 +267,7 @@ export default class ConfigValidator implements IConfigValidator {
resource: res as AdminForthResource,
record,
adminUser,
response,
adminforth: this.adminforth
});
if (!error && resp.error) {
Expand All @@ -290,6 +291,7 @@ export default class ConfigValidator implements IConfigValidator {
record,
adminUser,
recordId: recordId,
response,
adminforth: this.adminforth,
});
}
Expand Down
24 changes: 12 additions & 12 deletions adminforth/modules/restApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1162,7 +1162,7 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
server.endpoint({
method: 'POST',
path: '/create_record',
handler: async ({ body, adminUser, query, headers, cookies, requestUrl }) => {
handler: async ({ body, adminUser, query, headers, cookies, requestUrl, response }) => {
const resource = this.adminforth.config.resources.find((res) => res.resourceId == body['resourceId']);
if (!resource) {
return { error: `Resource '${body['resourceId']}' not found` };
Expand Down Expand Up @@ -1276,22 +1276,22 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
}
}

const response = await this.adminforth.createResourceRecord({ resource, record, adminUser, extra: { body, query, headers, cookies, requestUrl } });
if (response.error) {
return { error: response.error, ok: false, newRecordId: response.newRecordId };
const createRecordResponse = await this.adminforth.createResourceRecord({ resource, record, adminUser, response, extra: { body, query, headers, cookies, requestUrl } });
if (createRecordResponse.error) {
return { error: createRecordResponse.error, ok: false, newRecordId: createRecordResponse.newRecordId };
}
const connector = this.adminforth.connectors[resource.dataSource];

return {
newRecordId: response.createdRecord[connector.getPrimaryKey(resource)],
newRecordId: createRecordResponse.createdRecord[connector.getPrimaryKey(resource)],
ok: true
}
}
});
server.endpoint({
method: 'POST',
path: '/update_record',
handler: async ({ body, adminUser, query, headers, cookies, requestUrl }) => {
handler: async ({ body, adminUser, query, headers, cookies, requestUrl, response }) => {
const resource = this.adminforth.config.resources.find((res) => res.resourceId == body['resourceId']);
if (!resource) {
return { error: `Resource '${body['resourceId']}' not found` };
Expand Down Expand Up @@ -1396,7 +1396,7 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
}
}

const { error } = await this.adminforth.updateResourceRecord({ resource, record, adminUser, oldRecord, recordId, extra: { body, query, headers, cookies, requestUrl} });
const { error } = await this.adminforth.updateResourceRecord({ resource, record, adminUser, oldRecord, recordId, response, extra: { body, query, headers, cookies, requestUrl} });
if (error) {
return { error };
}
Expand All @@ -1409,7 +1409,7 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
server.endpoint({
method: 'POST',
path: '/delete_record',
handler: async ({ body, adminUser, query, headers, cookies, requestUrl }) => {
handler: async ({ body, adminUser, query, headers, cookies, requestUrl, response }) => {
const resource = this.adminforth.config.resources.find((res) => res.resourceId == body['resourceId']);
const record = await this.adminforth.connectors[resource.dataSource].getRecordByPrimaryKey(resource, body['primaryKey']);
if (!resource) {
Expand All @@ -1435,7 +1435,7 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
return { error };
}

const { error: deleteError } = await this.adminforth.deleteResourceRecord({ resource, record, adminUser, recordId: body['primaryKey'], extra: { body, query, headers, cookies, requestUrl } });
const { error: deleteError } = await this.adminforth.deleteResourceRecord({ resource, record, adminUser, recordId: body['primaryKey'], response, extra: { body, query, headers, cookies, requestUrl } });
if (deleteError) {
return { error: deleteError };
}
Expand All @@ -1448,7 +1448,7 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
server.endpoint({
method: 'POST',
path: '/start_bulk_action',
handler: async ({ body, adminUser, tr }) => {
handler: async ({ body, adminUser, tr, response }) => {
const { resourceId, actionId, recordIds } = body;
const resource = this.adminforth.config.resources.find((res) => res.resourceId == resourceId);
if (!resource) {
Expand All @@ -1473,13 +1473,13 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
return { error: await tr(`Action "{actionId}" not allowed`, 'errors', { actionId: action.label }) };
}
}
const response = await action.action({selectedIds: recordIds, adminUser, resource, tr});
const bulkActionResponse = await action.action({selectedIds: recordIds, adminUser, resource, response, tr});

return {
actionId,
recordIds,
resourceId,
...response
...bulkActionResponse
}
}
})
Expand Down
18 changes: 12 additions & 6 deletions adminforth/types/Back.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,16 +360,16 @@ export interface IAdminForth {
tr(msg: string, category: string, lang: string, params: any, pluralizationNumber?: number): Promise<string>;

createResourceRecord(
params: { resource: AdminForthResource, record: any, adminUser: AdminUser, extra?: HttpExtra }
params: { resource: AdminForthResource, record: any, response: IAdminForthHttpResponse, adminUser: AdminUser, extra?: HttpExtra }
): Promise<{ error?: string, createdRecord?: any, newRecordId?: any }>;

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

deleteResourceRecord(
params: { resource: AdminForthResource, recordId: string, adminUser: AdminUser, record: any, extra?: HttpExtra }
params: { resource: AdminForthResource, recordId: string, adminUser: AdminUser, record: any, response: IAdminForthHttpResponse, extra?: HttpExtra }
): Promise<{ error?: string }>;

auth: IAdminForthAuth;
Expand Down Expand Up @@ -539,6 +539,7 @@ export type BeforeDeleteSaveFunction = (params: {
adminUser: AdminUser,
record: any,
adminforth: IAdminForth,
response: IAdminForthHttpResponse,
extra?: HttpExtra,
}) => Promise<{ok: boolean, error?: string}>;

Expand All @@ -551,6 +552,7 @@ export type BeforeEditSaveFunction = (params: {
record: any, // legacy, 'updates' should be used instead
oldRecord: any,
adminforth: IAdminForth,
response: IAdminForthHttpResponse,
extra?: HttpExtra,
}) => Promise<{ok: boolean, error?: string | null}>;

Expand All @@ -561,6 +563,7 @@ export type BeforeCreateSaveFunction = (params: {
adminUser: AdminUser,
record: any,
adminforth: IAdminForth,
response: IAdminForthHttpResponse,
extra?: HttpExtra,
}) => Promise<{ok: boolean, error?: string | null, newRecordId?: string}>;

Expand All @@ -571,6 +574,7 @@ export type AfterCreateSaveFunction = (params: {
record: any,
adminforth: IAdminForth,
recordWithVirtualColumns?: any,
response: IAdminForthHttpResponse,
extra?: HttpExtra,
}) => Promise<{ok: boolean, error?: string}>;

Expand All @@ -584,6 +588,7 @@ export type AfterDeleteSaveFunction = (params: {
adminUser: AdminUser,
record: any,
adminforth: IAdminForth,
response: IAdminForthHttpResponse,
extra?: HttpExtra,
}) => Promise<{ok: boolean, error?: string}>;

Expand All @@ -596,6 +601,7 @@ export type AfterEditSaveFunction = (params: {
record: any, // legacy, 'updates' should be used instead
oldRecord: any,
adminforth: IAdminForth,
response: IAdminForthHttpResponse,
extra?: HttpExtra,
}) => Promise<{ok: boolean, error?: string}>;

Expand Down Expand Up @@ -1529,8 +1535,8 @@ export interface AdminForthBulkAction extends AdminForthBulkActionCommon {
* Callback which will be called on backend when user clicks on action button.
* It should return Promise which will be resolved when action is done.
*/
action: ({ resource, selectedIds, adminUser, tr }: {
resource: AdminForthResource, selectedIds: Array<any>, adminUser: AdminUser, tr: (key: string, category?: string, params?: any) => string
action: ({ resource, selectedIds, adminUser, response, tr }: {
resource: AdminForthResource, selectedIds: Array<any>, adminUser: AdminUser, response: IAdminForthHttpResponse, tr: (key: string, category?: string, params?: any) => string
}) => Promise<{ ok: boolean, error?: string, successMessage?: string }>,

/**
Expand Down