feat(hooks): Change global hook signature

vincentdesmares · vincentdesmares · commit b15061bb5252 · 2025-03-24T09:56:31.000+01:00
BREAKING CHANGE: change global hook signature
diff --git a/lib/createListResolver.js b/lib/createListResolver.js
@@ -328,7 +328,7 @@ function createListResolver(graphqlTypeDeclaration, models, globalPreCallback, r
                         if (!!beforeList_1_1.done) return [3 /*break*/, 5];
                         before = beforeList_1_1.value;
                         handle = globalPreCallback('listGlobalBefore');
-                        return [4 /*yield*/, before(args, context, info)];
+                        return [4 /*yield*/, before({ args: args, context: context, info: info })];
                     case 3:
                         _b.sent();
                         if (handle) {
diff --git a/lib/mutationResolvers/create.js b/lib/mutationResolvers/create.js
@@ -106,7 +106,7 @@ function generateMutationCreate(modelName, inputType, outputType, model, graphql
                         if (!!beforeList_1_1.done) return [3 /*break*/, 5];
                         before = beforeList_1_1.value;
                         handle = globalPreCallback('createGlobalBefore');
-                        return [4 /*yield*/, before(args, context, info)];
+                        return [4 /*yield*/, before({ args: args, context: context, info: info })];
                     case 3:
                         _d.sent();
                         if (handle) {
diff --git a/lib/mutationResolvers/delete.js b/lib/mutationResolvers/delete.js
@@ -105,7 +105,7 @@ function generateMutationDelete(modelName, graphqlModelDeclaration, models, glob
                         if (!!beforeList_1_1.done) return [3 /*break*/, 5];
                         before = beforeList_1_1.value;
                         handle = globalPreCallback('deleteGlobalBefore');
-                        return [4 /*yield*/, before(args, context, info)];
+                        return [4 /*yield*/, before({ args: args, context: context, info: info })];
                     case 3:
                         _c.sent();
                         if (handle) {
diff --git a/lib/mutationResolvers/update.js b/lib/mutationResolvers/update.js
@@ -107,7 +107,7 @@ function generateMutationUpdate(modelName, inputType, outputType, graphqlModelDe
                         if (!!beforeList_1_1.done) return [3 /*break*/, 5];
                         before = beforeList_1_1.value;
                         handle = globalPreCallback('updateGlobalBefore');
-                        return [4 /*yield*/, before(args, context, info)];
+                        return [4 /*yield*/, before({ args: args, context: context, info: info })];
                     case 3:
                         _c.sent();
                         if (handle) {
diff --git a/lib/queryResolvers/count.js b/lib/queryResolvers/count.js
@@ -83,7 +83,7 @@ function countResolver(model, schemaDeclaration, globalPreCallback) {
                     if (!!beforeList_1_1.done) return [3 /*break*/, 5];
                     before = beforeList_1_1.value;
                     handle = globalPreCallback('listGlobalBefore');
-                    return [4 /*yield*/, before(args, context, info)];
+                    return [4 /*yield*/, before({ args: args, context: context, info: info })];
                 case 3:
                     _b.sent();
                     if (handle) {
diff --git a/src/createListResolver.ts b/src/createListResolver.ts
@@ -345,7 +345,7 @@ export default function createListResolver(
 
         for (const before of beforeList) {
           const handle = globalPreCallback('listGlobalBefore')
-          await before(args, context, info)
+          await before({ args, context, info })
           if (handle) {
             handle()
           }
diff --git a/src/mutationResolvers/create.ts b/src/mutationResolvers/create.ts
@@ -52,7 +52,7 @@ export default function generateMutationCreate(
 
         for (const before of beforeList) {
           const handle = globalPreCallback('createGlobalBefore')
-          await before(args, context, info)
+          await before({ args, context, info })
           if (handle) {
             handle()
           }
diff --git a/src/mutationResolvers/delete.ts b/src/mutationResolvers/delete.ts
@@ -51,7 +51,7 @@ export default function generateMutationDelete(
 
         for (const before of beforeList) {
           const handle = globalPreCallback('deleteGlobalBefore')
-          await before(args, context, info)
+          await before({ args, context, info })
           if (handle) {
             handle()
           }
diff --git a/src/mutationResolvers/update.ts b/src/mutationResolvers/update.ts
@@ -51,7 +51,7 @@ export default function generateMutationUpdate(
 
         for (const before of beforeList) {
           const handle = globalPreCallback('updateGlobalBefore')
-          await before(args, context, info)
+          await before({ args, context, info })
           if (handle) {
             handle()
           }
diff --git a/src/queryResolvers/count.ts b/src/queryResolvers/count.ts
@@ -41,7 +41,7 @@ export default function countResolver<M extends Model<any>>(
 
       for (const before of beforeList) {
         const handle = globalPreCallback('listGlobalBefore')
-        await before(args, context, info)
+        await before({ args, context, info })
         if (handle) {
           handle()
         }
diff --git a/src/tests/schema.ts b/src/tests/schema.ts
@@ -70,7 +70,7 @@ graphqlSchemaDeclaration.user = {
   subscriptions: ['create', 'update'],
   webhooks: ['create', 'update', 'delete'],
   before: [
-    (args, context, info) => {
+    ({ args, context, info }) => {
       // Global before hook only have args, context and info.
       // You can use many functions or just one.
 
diff --git a/src/tests/testSchema.js b/src/tests/testSchema.js
@@ -44,7 +44,7 @@ graphqlSchemaDeclaration.user = {
   subscriptions: ['create', 'update'],
   webhooks: ['create', 'update', 'delete'],
   before: [
-    (args, context, info) => {
+    ({ args, context, info }) => {
       // Global before hook only have args, context and info.
       // You can use many functions or just one.
 
diff --git a/src/types/types.d.ts b/src/types/types.d.ts
@@ -90,11 +90,12 @@ export type SubscriptionList = {
 
 export type setWebhookDataType = (defaultData: any) => (f: Function) => void
 
-export type GlobalBeforeHook = (
-  args: TArgs,
-  context: TContext,
+export type GlobalBeforeHook = (params: {
+  args: TArgs
+  context: TContext
   info: TInfo
-) => any | Promise<any>
+}) => any | Promise<any>
+
 export type QueryBeforeHook<M extends Model<any>> = (
   findOptions: FindOptions<M>,
   args: TArgs,

Original file line number	Diff line number	Diff line change
`@@ -345,7 +345,7 @@ export default function createListResolver(`
`345`	`345`
`346`	`346`	`for (const before of beforeList) {`
`347`	`347`	`const handle = globalPreCallback('listGlobalBefore')`
`348`		`- await before(args, context, info)`
	`348`	`+ await before({ args, context, info })`
`349`	`349`	`if (handle) {`
`350`	`350`	`handle()`
`351`	`351`	`}`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ export default function generateMutationCreate(`
`52`	`52`
`53`	`53`	`for (const before of beforeList) {`
`54`	`54`	`const handle = globalPreCallback('createGlobalBefore')`
`55`		`- await before(args, context, info)`
	`55`	`+ await before({ args, context, info })`
`56`	`56`	`if (handle) {`
`57`	`57`	`handle()`
`58`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ export default function generateMutationDelete(`
`51`	`51`
`52`	`52`	`for (const before of beforeList) {`
`53`	`53`	`const handle = globalPreCallback('deleteGlobalBefore')`
`54`		`- await before(args, context, info)`
	`54`	`+ await before({ args, context, info })`
`55`	`55`	`if (handle) {`
`56`	`56`	`handle()`
`57`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ export default function countResolver<M extends Model<any>>(`
`41`	`41`
`42`	`42`	`for (const before of beforeList) {`
`43`	`43`	`const handle = globalPreCallback('listGlobalBefore')`
`44`		`- await before(args, context, info)`
	`44`	`+ await before({ args, context, info })`
`45`	`45`	`if (handle) {`
`46`	`46`	`handle()`
`47`	`47`	`}`