feat: allow hooks for global and bulk smart action (#622)

BREAKING CHANGE: record is no longer send to the hook middleware & values option on smart action is no longer supported

Author: arnaud-moncel

package.json

@@ -27,7 +27,7 @@
   "dependencies": {
     "@babel/runtime": "7.10.1",
     "bluebird": "2.9.25",
-    "forest-express": "9.0.0-beta.9",
+    "forest-express": "9.0.0-beta.11",
     "http-errors": "1.7.2",
     "lodash": "4.17.21",
     "moment": "2.24.0",

types/index.d.ts

@@ -32,9 +32,69 @@ export interface DatabaseConfiguration {
   }
 }
 
+export interface ForestRequest extends Request {
+  user: User,
+}
+
+// Base attributes for actions requests (content of request.data.body.attributes)
+interface ActionRequestAttributes {
+  collection_name: string,
+  ids: string[],
+  parent_collection_name: string,
+  parent_collection_id: string,
+  parent_association_name: string,
+  all_records: boolean,
+  all_records_subset_query: Query,
+  all_records_ids_excluded: string[],
+  smart_action_id: string,
+}
+
+// Base body from requests for action routes / hooks
+interface ActionRequestBody {
+  data: {
+    attributes: ActionRequestAttributes,
+    type: 'action-requests',
+  },
+}
+
+// Base body from requests for classic smart action routes
+interface SmartActionRequestBody {
+  data: {
+    attributes: ActionRequestAttributes & { values: Record<string, any> },
+    type: 'custom-action-requests',
+  },
+}
+
+// Base body from requests for smart action hooks
+interface SmartActionHookRequestBody {
+  data: {
+    attributes: ActionRequestAttributes & {
+      fields: SmartActionChangeHookField[],
+      changedField: string,
+    },
+    type: 'custom-action-hook-requests',
+  },
+}
+
+// Concrete smart action request for classic smart action routes
+export interface SmartActionRequest extends ForestRequest {
+  body: SmartActionRequestBody,
+}
+
+// Request passed to smart action load hooks
+export interface SmartActionLoadHookRequest extends ForestRequest {
+  body: ActionRequestBody,
+}
+
+// Request passed to smart action change hooks
+export interface SmartActionChangeHookRequest extends ForestRequest {
+  body: SmartActionHookRequestBody,
+}
+
 // Everything related to Forest Authentication
 
 export function ensureAuthenticated(request: Request, response: Response, next: NextFunction): void;
+
 export interface User {
   renderingId: number;
 }
@@ -63,7 +123,7 @@ export class RecordGetter<T> extends AbstractRecordTool<T> {
 
 export class RecordsGetter<T> extends AbstractRecordTool<T> {
   getAll(query: Query): Promise<(T & Document)[]>;
-  getIdsFromRequest(request: Request): Promise<string[]>;
+  getIdsFromRequest(request: SmartActionRequest | SmartActionLoadHookRequest | SmartActionChangeHookRequest): Promise<string[]>;
 }
 
 export class RecordsCounter<M extends Model<any>> extends AbstractRecordTool<M> {
@@ -222,16 +282,16 @@ export interface SmartActionLoadHookField extends SmartActionHookField {
   position: number,
 }
 
-export interface SmartActionLoadHook<T = any> {
-  (context: { fields: SmartActionLoadHookField[], record: T & Document }): SmartActionLoadHookField[]
+export interface SmartActionLoadHook {
+  (context: { fields: SmartActionLoadHookField[], request: SmartActionLoadHookRequest }): SmartActionLoadHookField[]
 }
 
 export interface SmartActionChangeHookField extends SmartActionHookField {
   previousValue: any,
 }
 
-export interface SmartActionChangeHook<T = any> {
-  (context: { fields: SmartActionChangeHookField[], record: T, changedField: SmartActionChangeHookField }): SmartActionChangeHookField[]
+export interface SmartActionChangeHook {
+  (context: { fields: SmartActionChangeHookField[], changedField: SmartActionChangeHookField, request: SmartActionChangeHookRequest }): SmartActionChangeHookField[]
 }
 
 export interface SmartActionHooks {

yarn.lock

@@ -4769,10 +4769,10 @@ for-in@^1.0.2:
   resolved "https://registry.yarnpkg.com/for-in/-/for-in-1.0.2.tgz#81068d295a8142ec0ac726c6e2200c30fb6d5e80"
   integrity sha1-gQaNKVqBQuwKxybG4iAMMPttXoA=
 
-[email protected].9:
-  version "9.0.0-beta.9"
-  resolved "https://registry.yarnpkg.com/forest-express/-/forest-express-9.0.0-beta.9.tgz#c92f7ea63ddb160667c419a60bfb35b8b97187fd"
-  integrity sha512-P6hSk0JZNee3e/eCTbVxzhQd5te+Q77xBuvv4jN5sg60S7ZbYLKNtgm9rpyLjs1iclLZMx/sHn/EbyHb48drwA==
+[email protected].11:
+  version "9.0.0-beta.11"
+  resolved "https://registry.yarnpkg.com/forest-express/-/forest-express-9.0.0-beta.11.tgz#99b553c60ac6da76567c13f38fb5a78ad17d0e55"
+  integrity sha512-ufU/dIe9WTlQGCR2KJIS/wAXvvEb300Xk2GL1iXHSr4uny8zFlnPXwZlZHdWSC8FQZlnclvUj1xfsanf/WWt1A==
   dependencies:
     "@babel/runtime" "7.10.1"
     base32-encode "1.1.1"