fix: move response to extra (for now keep previous one for compatibility) AdminForth/1202

ivictbor · ivictbor · commit b3c462344cde · 2026-01-27T16:23:08.000Z
diff --git a/adminforth/index.ts b/adminforth/index.ts
@@ -17,12 +17,14 @@ import {
   AdminForthResource,
   IAdminForthDataSourceConnectorBase,
   IWebSocketBroker,
-  HttpExtra,
-  BeforeCreateSaveFunction,
   AdminForthInputConfig,
-  IAdminForthHttpResponse,
+  CreateResourceRecordParams,
+  UpdateResourceRecordParams,
+  DeleteResourceRecordParams,
+  CreateResourceRecordResult,
+  UpdateResourceRecordResult,
+  DeleteResourceRecordResult,
 } from './types/Back.js';
-
 import {
   AdminForthFilterOperators,
   AdminForthDataTypes,
@@ -538,10 +540,15 @@ class AdminForth implements IAdminForth {
     return users.data[0] || null;
   }
 
+  /**
+   * Create record and execute hooks
+   * @param params - Parameters for record creation. See CreateResourceRecordParams.
+   * @returns Result of record creation. See CreateResourceRecordResult.
+   */
   async createResourceRecord(
-    { resource, record, adminUser, extra, response }: 
-    { resource: AdminForthResource, record: any, adminUser: AdminUser, extra?: HttpExtra, response: IAdminForthHttpResponse }
-  ): Promise<{ error?: string, createdRecord?: any, newRecordId?: any }> {
+    params: CreateResourceRecordParams,
+  ): Promise<CreateResourceRecordResult> {
+    const { resource, record, adminUser, extra, response } = params;
 
     const err = this.validateRecordValues(resource, record, 'create');
     if (err) {
@@ -622,12 +629,15 @@ class AdminForth implements IAdminForth {
 
   /**
    * record is partial record with only changed fields
+   * 
+   * Update record by id and execute hooks
+    * @param params - Parameters for record update. See UpdateResourceRecordParams.
+    * @returns Result of record update. See UpdateResourceRecordResult.
    */
   async updateResourceRecord(
-    { 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 }> {
+    params: UpdateResourceRecordParams,
+  ): Promise<UpdateResourceRecordResult> {
+    const { resource, recordId, record, oldRecord, adminUser, response, extra, updates } = params;
     const dataToUse = updates || record;
     const err = this.validateRecordValues(resource, dataToUse, 'edit');
     if (err) {
@@ -713,10 +723,15 @@ class AdminForth implements IAdminForth {
     return { error: null };
   }
 
+  /**
+   * Delete record by id and execute hooks
+   * @param params - Parameters for record deletion. See DeleteResourceRecordParams.
+   * @returns Result of record deletion. See DeleteResourceRecordResult.
+   */
   async deleteResourceRecord(
-    { resource, recordId, adminUser, record, response, extra }:
-    { resource: AdminForthResource, recordId: any, adminUser: AdminUser, record: any, response: IAdminForthHttpResponse, extra?: HttpExtra }
-  ): Promise<{ error?: string }> {
+    params: DeleteResourceRecordParams,
+  ): Promise<DeleteResourceRecordResult> {
+    const { resource, recordId, adminUser, record, response, extra } = params;
     // execute hook if needed
     for (const hook of listify(resource.hooks?.delete?.beforeSave)) {
       const resp = await hook({ 
diff --git a/adminforth/modules/restApi.ts b/adminforth/modules/restApi.ts
@@ -1275,7 +1275,10 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
               }
             }
 
-            const createRecordResponse = await this.adminforth.createResourceRecord({ resource, record, adminUser, response, extra: { body, query, headers, cookies, requestUrl } });
+            const createRecordResponse = await this.adminforth.createResourceRecord({ 
+              resource, record, adminUser, response, 
+              extra: { body, query, headers, cookies, requestUrl, response } 
+            });
             if (createRecordResponse.error) {
               return { error: createRecordResponse.error, ok: false, newRecordId: createRecordResponse.newRecordId };
             }
@@ -1395,7 +1398,10 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
               }
             }
             
-            const { error } = await this.adminforth.updateResourceRecord({ resource, record, adminUser, oldRecord, recordId, response, extra: { body, query, headers, cookies, requestUrl} });
+            const { error } = await this.adminforth.updateResourceRecord({ 
+              resource, record, adminUser, oldRecord, recordId, response, 
+              extra: { body, query, headers, cookies, requestUrl, response } 
+            });
             if (error) {
               return { error };
             }
@@ -1434,7 +1440,10 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
               return { error };
             }
 
-            const { error: deleteError } = await this.adminforth.deleteResourceRecord({ resource, record, adminUser, recordId: body['primaryKey'], response, 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, response } 
+            });
             if (deleteError) {
               return { error: deleteError };
             }
diff --git a/adminforth/types/Back.ts b/adminforth/types/Back.ts
@@ -359,17 +359,16 @@ export interface IAdminForth {
   tr(msg: string, category: string, lang: string, params: any, pluralizationNumber?: number): Promise<string>;
 
   createResourceRecord(
-    params: { resource: AdminForthResource, record: any, response: IAdminForthHttpResponse, adminUser: AdminUser, extra?: HttpExtra }
-  ): Promise<{ error?: string, createdRecord?: any, newRecordId?: any }>;
+    params: CreateResourceRecordParams,
+  ): Promise<CreateResourceRecordResult>;
 
   updateResourceRecord(
-    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 }>;
+    params: UpdateResourceRecordParams,
+  ): Promise<UpdateResourceRecordResult>;
 
   deleteResourceRecord(
-    params: { resource: AdminForthResource, recordId: string, adminUser: AdminUser, record: any, response: IAdminForthHttpResponse, extra?: HttpExtra }
-  ): Promise<{ error?: string }>;
+    params: DeleteResourceRecordParams,
+  ): Promise<DeleteResourceRecordResult>;
 
   auth: IAdminForthAuth;
 
@@ -534,7 +533,205 @@ export interface HttpExtra {
   cookies: Record<string, string>,
   requestUrl: string,
   meta?: any,
+  response: IAdminForthHttpResponse
 }
+
+/**
+ * Result of {@link IAdminForth.createResourceRecord}.
+ */
+export type CreateResourceRecordResult = {
+  /** Optional error message if creation failed. */
+  error?: string;
+
+  /** Created record as returned from the connector. */
+  createdRecord?: any;
+
+  /**
+   * Optional id of an existing record to redirect to
+   * (used when a beforeSave hook aborts creation and supplies newRecordId).
+   */
+  newRecordId?: any;
+};
+
+/**
+ * Parameters for {@link IAdminForth.createResourceRecord}.
+ */
+export type CreateResourceRecordParams = {
+  /**
+   * Resource configuration used to create a record.
+   */
+  resource: AdminForthResource;
+
+  /**
+   * Record data to create.
+   */
+  record: any;
+
+  /**
+   * Admin user performing the action.
+   */
+  adminUser: AdminUser;
+
+  /**
+   * HTTP response object.
+   *
+   * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+   */
+  response: IAdminForthHttpResponse;
+
+  /**
+   * Extra HTTP information. Prefer using extra.response over the top-level response field.
+   */
+  extra?: HttpExtra;
+};
+
+/**
+ * Parameters for {@link IAdminForth.updateResourceRecord}.
+ */
+export type UpdateResourceRecordParams =
+  | {
+      /**
+       * Resource configuration used to update a record.
+       */
+      resource: AdminForthResource;
+
+      /**
+       * Primary key value of the record to update.
+       */
+      recordId: any;
+
+      /**
+       * Full record data with applied changes.
+       *
+       * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use updates instead.
+       */
+      record: any;
+
+      /**
+       * Record data before update.
+       */
+      oldRecord: any;
+
+      /**
+       * Admin user performing the action.
+       */
+      adminUser: AdminUser;
+
+      /**
+       * HTTP response object.
+       *
+       * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+       */
+      response: IAdminForthHttpResponse;
+
+      /**
+       * Extra HTTP information. Prefer using extra.response over the top-level response field.
+       */
+      extra?: HttpExtra;
+
+      /**
+       * Partial record data with only changed fields. Mutually exclusive with record.
+       */
+      updates?: never;
+    }
+  | {
+      /**
+       * Resource configuration used to update a record.
+       */
+      resource: AdminForthResource;
+
+      /**
+       * Primary key value of the record to update.
+       */
+      recordId: any;
+
+      /**
+       * Full record data with applied changes.
+       *
+       * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use updates instead.
+       */
+      record?: never;
+
+      /**
+       * Record data before update.
+       */
+      oldRecord: any;
+
+      /**
+       * Admin user performing the action.
+       */
+      adminUser: AdminUser;
+
+      /**
+       * HTTP response object.
+       *
+       * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+       */
+      response: IAdminForthHttpResponse;
+
+      /**
+       * Extra HTTP information. Prefer using extra.response over the top-level response field.
+       */
+      extra?: HttpExtra;
+
+      /**
+       * Partial record data with only changed fields. Mutually exclusive with record.
+       */
+      updates: any;
+    };
+
+/**
+ * Parameters for {@link IAdminForth.deleteResourceRecord}.
+ */
+export type DeleteResourceRecordParams = {
+  /**
+   * Resource configuration used to delete a record.
+   */
+  resource: AdminForthResource;
+
+  /**
+   * Primary key value of the record to delete.
+   */
+  recordId: string;
+
+  /**
+   * Admin user performing the action.
+   */
+  adminUser: AdminUser;
+
+  /**
+   * Record data before deletion.
+   */
+  record: any;
+
+  /**
+   * HTTP response object.
+   *
+   * @deprecated Since 1.2.9. Will be removed in 2.0.0. Use extra.response instead.
+   */
+  response: IAdminForthHttpResponse;
+
+  /**
+   * Extra HTTP information. Prefer using extra.response over the top-level response field.
+   */
+  extra?: HttpExtra;
+};
+
+/**
+ * Result of {@link IAdminForth.updateResourceRecord}.
+ */
+export type UpdateResourceRecordResult = {
+  /** Optional error message if update failed. */
+  error?: string;
+};
+
+/**
+ * Result of {@link IAdminForth.deleteResourceRecord}.
+ */
+export type DeleteResourceRecordResult = {
+  /** Optional error message if delete failed. */
+  error?: string;
+};
 /**
  * Modify record to change how data is saved to database.
  * Return ok: false and error: string to stop execution and show error message to user. Return ok: true to continue execution.

Original file line number	Diff line number	Diff line change
`@@ -1275,7 +1275,10 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {`
`1275`	`1275`	`}`
`1276`	`1276`	`}`
`1277`	`1277`
`1278`		`- const createRecordResponse = await this.adminforth.createResourceRecord({ resource, record, adminUser, response, extra: { body, query, headers, cookies, requestUrl } });`
	`1278`	`+ const createRecordResponse = await this.adminforth.createResourceRecord({`
	`1279`	`+ resource, record, adminUser, response,`
	`1280`	`+ extra: { body, query, headers, cookies, requestUrl, response }`
	`1281`	`+ });`
`1279`	`1282`	`if (createRecordResponse.error) {`
`1280`	`1283`	`return { error: createRecordResponse.error, ok: false, newRecordId: createRecordResponse.newRecordId };`
`1281`	`1284`	`}`
`@@ -1395,7 +1398,10 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {`
`1395`	`1398`	`}`
`1396`	`1399`	`}`
`1397`	`1400`
`1398`		`- const { error } = await this.adminforth.updateResourceRecord({ resource, record, adminUser, oldRecord, recordId, response, extra: { body, query, headers, cookies, requestUrl} });`
	`1401`	`+ const { error } = await this.adminforth.updateResourceRecord({`
	`1402`	`+ resource, record, adminUser, oldRecord, recordId, response,`
	`1403`	`+ extra: { body, query, headers, cookies, requestUrl, response }`
	`1404`	`+ });`
`1399`	`1405`	`if (error) {`
`1400`	`1406`	`return { error };`
`1401`	`1407`	`}`
`@@ -1434,7 +1440,10 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {`
`1434`	`1440`	`return { error };`
`1435`	`1441`	`}`
`1436`	`1442`
`1437`		`- const { error: deleteError } = await this.adminforth.deleteResourceRecord({ resource, record, adminUser, recordId: body['primaryKey'], response, extra: { body, query, headers, cookies, requestUrl } });`
	`1443`	`+ const { error: deleteError } = await this.adminforth.deleteResourceRecord({`
	`1444`	`+ resource, record, adminUser, recordId: body['primaryKey'], response,`
	`1445`	`+ extra: { body, query, headers, cookies, requestUrl, response }`
	`1446`	`+ });`
`1438`	`1447`	`if (deleteError) {`
`1439`	`1448`	`return { error: deleteError };`
`1440`	`1449`	`}`